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 "spritecache.h"

    12

#include "table/sprites.h"

    13

#include "fileio.h"

    14

#include "spriteloader/grf.hpp"

    16

#ifdef WITH_PNG

    17

#include "spriteloader/png.hpp"

    18

#endif /* WITH_PNG */

    19

#include "blitter/factory.hpp"

    20

    21

/* Default of 4MB spritecache */

    22

uint _sprite_cache_size = 4;

    23

    24

    25

struct SpriteCache {

    26

	void *ptr;

    27

	uint8 file_slot;

    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

		/* 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

	uint32 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

	uint32 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, sc->grf_name, 0, sc->id)) {

   147

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

   148

			free(sprite.data);

   149

   150

			return sc->ptr;

   151

		}

   152

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

   153

#else

   154

		static bool show_once = true;

   155

		if (show_once) {

   156

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

   157

			show_once = false;

   158

		}

   159

#endif /* WITH_PNG */

   160

	}

   161

   162

	FioSeekToFile(file_slot, file_pos);

   163

   164

	/* Read the size and type */

   165

	int num  = FioReadWord();

   166

	byte type = FioReadByte();

   167

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

   168

	if (type == 0xFF) {

   169

		if (real_sprite) {

   170

			static byte warning_level = 0;

   171

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

   172

			warning_level = 6;

   173

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

   174

			return (void*)GetSprite(SPR_IMG_QUERY);

   175

		}

   176

   177

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

   178

   179

		sc->ptr = dest;

   180

		FioReadBlock(dest, num);

   181

   182

		return sc->ptr;

   183

	}

   184

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

   185

	 *  generator assumes that those sprites are stored uncompressed in

   186

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

   187

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

   188

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

   189

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

   190

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

   191

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

   192

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

   193

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

   194

		uint height = FioReadByte();

   195

		uint width  = FioReadWord();

   196

		Sprite *sprite;

   197

		byte *dest;

   198

   199

		num = width * height;

   200

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

   201

		sc->ptr = sprite;

   202

		sprite->height = height;

   203

		sprite->width  = width;

   204

		sprite->x_offs = FioReadWord();

   205

		sprite->y_offs = FioReadWord();

   206

   207

		dest = sprite->data;

   208

		while (num > 0) {

   209

			int8 i = FioReadByte();

   210

			if (i >= 0) {

   211

				num -= i;

   212

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

   213

			} else {

   214

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

   215

				i = -(i >> 3);

   216

				num -= i;

   217

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

   218

			}

   219

		}

   220

   221

		return sc->ptr;

   222

	}

   223

   224

	if (!real_sprite) {

   225

		static byte warning_level = 0;

   226

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

   227

		warning_level = 6;

   228

	}

   229

   230

	SpriteLoaderGrf sprite_loader;

   231

	SpriteLoader::Sprite sprite;

   232

   233

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

   234

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

   235

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

   236

	free(sprite.data);

   237

   238

	return sc->ptr;

   239

}

   240

   241

   242

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

   243

{

   244

	SpriteCache *sc;

   245

	uint32 file_pos = FioGetPos();

   246

   247

	if (!ReadSpriteHeaderSkipData()) return false;

   248

   249

	if (load_index >= MAX_SPRITES) {

   250

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

   251

	}

   252

   253

	sc = AllocateSpriteCache(load_index);

   254

	sc->file_slot = file_slot;

   255

	sc->file_pos = file_pos;

   256

	sc->ptr = NULL;

   257

	sc->lru = 0;

   258

	sc->id = file_sprite_id;

   259

   260

	const char *fio_grf_name = FioGetFilename();

   261

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

   262

	char *grf_name;

   263

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

   264

	else           grf_name = strdup(t);

   265

	/* Make the string lowercase and strip extension */

   266

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

   267

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

   268

	strtolower(grf_name);

   269

   270

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

   271

	sc->grf_name = grf_name;

   272

   273

	return true;

   274

}

   275

   276

   277

void DupSprite(SpriteID old_spr, SpriteID new_spr)

   278

{

   279

	SpriteCache *scold = GetSpriteCache(old_spr);

   280

	SpriteCache *scnew = AllocateSpriteCache(new_spr);

   281

   282

	scnew->file_slot = scold->file_slot;

   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) 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) p = ReadSprite(sc, sprite, real_sprite);

   481

	return p;

   482

}

   483

   484

   485

void GfxInitSpriteMem()

   486

{

   487

	/* initialize sprite cache heap */