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

	uint32 file_pos;

    29

	int16 lru;

    30

	uint32 id;

    31

	const char *grf_name;

    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

		if (_spritecache == NULL) {

    56

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

    57

		}

    58

    59

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

    60

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

    61

		_spritecache_items = items;

    62

	}

    63

    64

	return GetSpriteCache(index);

    65

}

    66

    67

    68

struct MemBlock {

    69

	uint32 size;

    70

	byte data[VARARRAY_SIZE];

    71

};

    72

    73

static uint _sprite_lru_counter;

    74

static MemBlock *_spritecache_ptr;

    75

static int _compact_cache_counter;

    76

    77

static void CompactSpriteCache();

    78

    79

static bool ReadSpriteHeaderSkipData()

    80

{

    81

	uint16 num = FioReadWord();

    82

	byte type;

    83

    84

	if (num == 0) return false;

    85

    86

	type = FioReadByte();

    87

	if (type == 0xFF) {

    88

		FioSkipBytes(num);

    89

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

    90

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

    91

		return num != 1;

    92

	}

    93

    94

	FioSkipBytes(7);

    95

	num -= 8;

    96

	if (num == 0) return true;

    97

    98

	if (type & 2) {

    99

		FioSkipBytes(num);

   100

	} else {

   101

		while (num > 0) {

   102

			int8 i = FioReadByte();

   103

			if (i >= 0) {

   104

				num -= i;

   105

				FioSkipBytes(i);

   106

			} else {

   107

				i = -(i >> 3);

   108

				num -= i;

   109

				FioReadByte();

   110

			}

   111

		}

   112

	}

   113

   114

	return true;

   115

}

   116

   117

/* Check if the given Sprite ID exists */

   118

bool SpriteExists(SpriteID id)

   119

{

   120

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

   121

	if (id == 0) return true;

   122

	if (id >= _spritecache_items) return false;

   123

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

   124

}

   125

   126

void* AllocSprite(size_t);

   127

   128

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

   129

{

   130

	uint32 file_pos = sc->file_pos;

   131

   132

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

   133

   134

	if (!SpriteExists(id)) {

   135

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

   136

   137

		/* SPR_IMG_QUERY is a BIG FAT RED ? */

   138

		id = SPR_IMG_QUERY;

   139

		file_pos = GetSpriteCache(SPR_IMG_QUERY)->file_pos;

   140

	}

   141

   142

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

   143

#ifdef WITH_PNG

   144

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

   145

		SpriteLoaderPNG sprite_loader;

   146

		SpriteLoader::Sprite sprite;

   147

   148

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

   149

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

   150

			free(sprite.data);

   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_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) error("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

		FioReadBlock(dest, num);

   183

   184

		return sc->ptr;

   185

	}

   186

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

   187

	 *  generator assumes that those sprites are stored uncompressed in

   188

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

   189

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

   190

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

   191

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

   192

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

   193

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

   194

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

   195

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

   196

		uint height = FioReadByte();

   197

		uint width  = FioReadWord();

   198

		Sprite *sprite;

   199

		byte *dest;

   200

   201

		num = width * height;

   202

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

   203

		sc->ptr = sprite;

   204

		sprite->height = height;

   205

		sprite->width  = width;

   206

		sprite->x_offs = FioReadWord();

   207

		sprite->y_offs = FioReadWord();

   208

   209

		dest = sprite->data;

   210

		while (num > 0) {

   211

			int8 i = FioReadByte();

   212

			if (i >= 0) {

   213

				num -= i;

   214

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

   215

			} else {

   216

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

   217

				i = -(i >> 3);

   218

				num -= i;

   219

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

   220

			}

   221

		}

   222

   223

		return sc->ptr;

   224

	}

   225

   226

	if (!real_sprite) {

   227

		static byte warning_level = 0;

   228

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

   229

		warning_level = 6;

   230

	}

   231

   232

	SpriteLoaderGrf sprite_loader;

   233

	SpriteLoader::Sprite sprite;

   234

   235

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

   236

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

   237

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

   238

	free(sprite.data);

   239

   240

	return sc->ptr;

   241

}

   242

   243

   244

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

   245

{

   246

	SpriteCache *sc;

   247

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

   248

   249

	if (!ReadSpriteHeaderSkipData()) return false;

   250

   251

	if (load_index >= MAX_SPRITES) {

   252

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

   253

	}

   254

   255

	sc = AllocateSpriteCache(load_index);

   256

	sc->file_pos = file_pos;

   257

	sc->ptr = NULL;

   258

	sc->lru = 0;

   259

	sc->id = file_sprite_id;

   260

   261

	const char *fio_grf_name = FioGetFilename();

   262

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

   263

	char *grf_name;

   264

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

   265

	else           grf_name = strdup(t);

   266

	/* Make the string lowercase and strip extension */

   267

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

   268

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

   269

	strtolower(grf_name);

   270

   271

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

   272

	sc->grf_name = grf_name;

   273

   274

	return true;

   275

}

   276

   277

   278

void DupSprite(SpriteID old_spr, SpriteID new_spr)

   279

{

   280

	SpriteCache *scold = GetSpriteCache(old_spr);

   281

	SpriteCache *scnew = AllocateSpriteCache(new_spr);

   282

   283

	scnew->file_pos = scold->file_pos;

   284

	scnew->ptr = NULL;

   285

	scnew->id = scold->id;

   286

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

   287

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

   288

}

   289

   290

   291

void SkipSprites(uint count)

   292

{

   293

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

   294

		if (!ReadSpriteHeaderSkipData()) return;

   295

	}

   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 uint32 GetSpriteCacheUsage()

   307

{

   308

	uint32 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

	return tot_size;

   315

}

   316

   317

   318

void IncreaseSpriteLRU()

   319

{

   320

	/* Increase all LRU values */

   321

	if (_sprite_lru_counter > 16384) {

   322

		SpriteID i;

   323

   324

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

   325

   326

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

   327

			SpriteCache *sc = GetSpriteCache(i);

   328

			if (sc->ptr != NULL) {

   329

				if (sc->lru >= 0) {

   330

					sc->lru = -1;

   331

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

   332

					sc->lru--;

   333

				}

   334

			}

   335

		}

   336

		_sprite_lru_counter = 0;

   337

	}

   338

   339

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

   340

	if (++_compact_cache_counter >= 740) {

   341

		CompactSpriteCache();

   342

		_compact_cache_counter = 0;

   343

	}

   344

}

   345

   346

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

   347

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

   348

static void CompactSpriteCache()

   349

{

   350

	MemBlock *s;

   351

   352

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

   353

   354

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

   355

		if (s->size & S_FREE_MASK) {

   356

			MemBlock* next = NextBlock(s);

   357

			MemBlock temp;

   358

			SpriteID i;

   359

   360

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

   361

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

   362

   363

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

   364

			if (next->size == 0)

   365

				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)

   410

		error("Out of sprite memory");

   411

   412

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

   413

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

   414

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

   415

	s->size |= S_FREE_MASK;

   416

	GetSpriteCache(best)->ptr = NULL;

   417

   418

	/* And coalesce adjacent free blocks */

   419

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

   420

		if (s->size & S_FREE_MASK) {

   421

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

   422

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

   423

			}

   424

		}

   425

	}

   426

}

   427

   428

void* AllocSprite(size_t mem_req)

   429

{

   430

	mem_req += sizeof(MemBlock);

   431

   432

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

   433

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

   434

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

   435

   436

	for (;;) {

   437

		MemBlock* s;

   438

   439

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

   440

			if (s->size & S_FREE_MASK) {

   441

				size_t cur_size = s->size & ~S_FREE_MASK;

   442

   443

				/* Is the block exactly the size we need or

   444

				 * big enough for an additional free block? */

   445

				if (cur_size == mem_req ||

   446

						cur_size >= mem_req + sizeof(MemBlock)) {

   447

					/* Set size and in use */

   448

					s->size = mem_req;

   449

   450

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

   451

					if (cur_size != mem_req) {

   452

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

   453

					}

   454

   455

					return s->data;

   456

				}

   457

			}

   458

		}

   459

   460

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

   461

		DeleteEntryFromSpriteCache();

   462

	}

   463

}

   464

   465

   466

const void *GetRawSprite(SpriteID sprite, bool real_sprite)

   467

{

   468

	SpriteCache *sc;

   469

	void* p;

   470

   471

	assert(sprite < _spritecache_items);

   472

   473

	sc = GetSpriteCache(sprite);

   474

   475

	/* Update LRU */

   476

	sc->lru = ++_sprite_lru_counter;

   477

   478

	p = sc->ptr;

   479

   480

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

   481

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

   482

	return p;

   483

}

   484

   485

   486

void GfxInitSpriteMem()

   487

{

   488

	/* initialize sprite cache heap */

   489