1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "debug.h"

     6

#include "functions.h"

     7

#include "macros.h"

     8

#include "spritecache.h"

     9

#include "table/sprites.h"

    10

#include "fileio.h"

    11

    12

#ifndef SPRITE_CACHE_SIZE

    13

# define SPRITE_CACHE_SIZE 2*1024*1024

    14

#endif /* SPRITE_CACHE_SIZE */

    15

    16

#define WANT_NEW_LRU

    17

    18

    19

static void* _sprite_ptr[MAX_SPRITES];

    20

static uint32 _sprite_file_pos[MAX_SPRITES];

    21

    22

#if defined(WANT_NEW_LRU)

    23

static int16 _sprite_lru_new[MAX_SPRITES];

    24

#else

    25

static uint16 _sprite_lru[MAX_SPRITES];

    26

static uint16 _sprite_lru_cur[MAX_SPRITES];

    27

#endif

    28

    29

typedef struct MemBlock {

    30

	uint32 size;

    31

	byte data[VARARRAY_SIZE];

    32

} MemBlock;

    33

    34

static uint _sprite_lru_counter;

    35

static MemBlock *_spritecache_ptr;

    36

static int _compact_cache_counter;

    37

    38

static void CompactSpriteCache(void);

    39

    40

static bool ReadSpriteHeaderSkipData(void)

    41

{

    42

	uint16 num = FioReadWord();

    43

	byte type;

    44

    45

	if (num == 0) return false;

    46

    47

	type = FioReadByte();

    48

	if (type == 0xFF) {

    49

		FioSkipBytes(num);

    50

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

    51

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

    52

		return num != 1;

    53

	}

    54

    55

	FioSkipBytes(7);

    56

	num -= 8;

    57

	if (num == 0) return true;

    58

    59

	if (type & 2) {

    60

		FioSkipBytes(num);

    61

	} else {

    62

		while (num > 0) {

    63

			int8 i = FioReadByte();

    64

			if (i >= 0) {

    65

				num -= i;

    66

				FioSkipBytes(i);

    67

			} else {

    68

				i = -(i >> 3);

    69

				num -= i;

    70

				FioReadByte();

    71

			}

    72

		}

    73

	}

    74

    75

	return true;

    76

}

    77

    78

/* Check if the given Sprite ID exists */

    79

bool SpriteExists(SpriteID id)

    80

{

    81

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

    82

	return _sprite_file_pos[id] != 0 || id == 0;

    83

}

    84

    85

static void* AllocSprite(size_t);

    86

    87

static void* ReadSprite(SpriteID id)

    88

{

    89

	uint num;

    90

	byte type;

    91

    92

	DEBUG(spritecache, 9) ("load sprite %d", id);

    93

    94

	if (!SpriteExists(id)) {

    95

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

    96

    97

		/* SPR_IMG_QUERY is a BIG FAT RED ? */

    98

		id = SPR_IMG_QUERY;

    99

	}

   100

   101

	FioSeekToFile(_sprite_file_pos[id]);

   102

   103

	num  = FioReadWord();

   104

	type = FioReadByte();

   105

	if (type == 0xFF) {

   106

		byte* dest = AllocSprite(num);

   107

   108

		_sprite_ptr[id] = dest;

   109

		FioReadBlock(dest, num);

   110

   111

		return dest;

   112

	} else {

   113

		uint height = FioReadByte();

   114

		uint width  = FioReadWord();

   115

		Sprite* sprite;

   116

		byte* dest;

   117

   118

		num = (type & 0x02) ? width * height : num - 8;

   119

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

   120

		_sprite_ptr[id] = sprite;

   121

		sprite->info   = type;

   122

		sprite->height = (id != 142) ? height : 10; // Compensate for a TTD bug

   123

		sprite->width  = width;

   124

		sprite->x_offs = FioReadWord();

   125

		sprite->y_offs = FioReadWord();

   126

   127

		dest = sprite->data;

   128

		while (num > 0) {

   129

			int8 i = FioReadByte();

   130

   131

			if (i >= 0) {

   132

				num -= i;

   133

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

   134

			} else {

   135

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

   136

   137

				i = -(i >> 3);

   138

				num -= i;

   139

   140

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

   141

			}

   142

		}

   143

   144

		return sprite;

   145

	}

   146

}

   147

   148

   149

bool LoadNextSprite(int load_index, byte file_index)

   150

{

   151

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

   152

   153

	if (!ReadSpriteHeaderSkipData()) return false;

   154

   155

	if (load_index >= MAX_SPRITES) {

   156

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

   157

	}

   158

   159

	_sprite_file_pos[load_index] = file_pos;

   160

   161

	_sprite_ptr[load_index] = NULL;

   162

   163

#if defined(WANT_NEW_LRU)

   164

	_sprite_lru_new[load_index] = 0;

   165

#else

   166

	_sprite_lru[load_index] = 0xFFFF;

   167

	_sprite_lru_cur[load_index] = 0;

   168

#endif

   169

   170

	return true;

   171

}

   172

   173

   174

void DupSprite(SpriteID old, SpriteID new)

   175

{

   176

	_sprite_file_pos[new] = _sprite_file_pos[old];

   177

	_sprite_ptr[new] = NULL;

   178

}

   179

   180

   181

void SkipSprites(uint count)

   182

{

   183

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

   184

		if (!ReadSpriteHeaderSkipData()) return;

   185

	}

   186

}

   187

   188

   189

#define S_FREE_MASK 1

   190

   191

static inline MemBlock* NextBlock(MemBlock* block)

   192

{

   193

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

   194

}

   195

   196

static uint32 GetSpriteCacheUsage(void)

   197

{

   198

	uint32 tot_size = 0;

   199

	MemBlock* s;

   200

   201

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

   202

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

   203

   204

	return tot_size;

   205

}

   206

   207

   208

void IncreaseSpriteLRU(void)

   209

{

   210

	int i;

   211

   212

	// Increase all LRU values

   213

#if defined(WANT_NEW_LRU)

   214

	if (_sprite_lru_counter > 16384) {

   215

		DEBUG(spritecache, 2) ("fixing lru %d, inuse=%d", _sprite_lru_counter, GetSpriteCacheUsage());

   216

   217

		for (i = 0; i != MAX_SPRITES; i++)

   218

			if (_sprite_ptr[i] != NULL) {

   219

				if (_sprite_lru_new[i] >= 0) {

   220

					_sprite_lru_new[i] = -1;

   221

				} else if (_sprite_lru_new[i] != -32768) {

   222

					_sprite_lru_new[i]--;

   223

				}

   224

			}

   225

		_sprite_lru_counter = 0;

   226

	}

   227

#else

   228

	for (i = 0; i != MAX_SPRITES; i++)

   229

		if (_sprite_ptr[i] != NULL && _sprite_lru[i] != 65535)

   230

			_sprite_lru[i]++;

   231

	// Reset the lru counter.

   232

	_sprite_lru_counter = 0;

   233

#endif

   234

   235

	// Compact sprite cache every now and then.

   236

	if (++_compact_cache_counter >= 740) {

   237

		CompactSpriteCache();

   238

		_compact_cache_counter = 0;

   239

	}

   240

}

   241

   242

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

   243

// That is accomplished by moving the cached data.

   244

static void CompactSpriteCache(void)

   245

{

   246

	MemBlock *s;

   247

   248

	DEBUG(spritecache, 2) (

   249

		"compacting sprite cache, inuse=%d", GetSpriteCacheUsage()

   250

	);

   251

   252

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

   253

		if (s->size & S_FREE_MASK) {

   254

			MemBlock* next = NextBlock(s);

   255

			MemBlock temp;

   256

			void** i;

   257

   258

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

   259

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

   260

   261

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

   262

			if (next->size == 0)

   263

				break;

   264

   265

			// Locate the sprite belonging to the next pointer.

   266

			for (i = _sprite_ptr; *i != next->data; ++i) {

   267

				assert(i != endof(_sprite_ptr));

   268

			}

   269

   270

			*i = s->data; // Adjust sprite array entry

   271

			// Swap this and the next block

   272

			temp = *s;

   273

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

   274

			s = NextBlock(s);

   275

			*s = temp;

   276

   277

			// Coalesce free blocks

   278

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

   279

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

   280

			}

   281

		} else {

   282

			s = NextBlock(s);

   283

		}

   284

	}

   285

}

   286

   287

static void DeleteEntryFromSpriteCache(void)

   288

{

   289

	int i;

   290

	int best = -1;

   291

	MemBlock* s;

   292

	int cur_lru;

   293

   294

	DEBUG(spritecache, 2) ("DeleteEntryFromSpriteCache, inuse=%d", GetSpriteCacheUsage());

   295

   296

#if defined(WANT_NEW_LRU)

   297

	cur_lru = 0xffff;

   298

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

   299

		if (_sprite_ptr[i] != NULL && _sprite_lru_new[i] < cur_lru) {

   300

			cur_lru = _sprite_lru_new[i];

   301

			best = i;

   302

		}

   303

	}

   304

#else

   305

	{

   306

	uint16 cur_lru = 0, cur_lru_cur = 0xffff;

   307

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

   308

		if (_sprite_ptr[i] == NULL || _sprite_lru[i] < cur_lru) continue;

   309

   310

		// Found a sprite with a higher LRU value, then remember it.

   311

		if (_sprite_lru[i] != cur_lru) {

   312

			cur_lru = _sprite_lru[i];

   313

			best = i;

   314

   315

		// Else if both sprites were very recently referenced, compare by the cur value instead.

   316

		} else if (cur_lru == 0 && _sprite_lru_cur[i] <= cur_lru_cur) {

   317

			cur_lru_cur = _sprite_lru_cur[i];

   318

			cur_lru = _sprite_lru[i];

   319

			best = i;

   320

		}

   321

	}

   322

	}

   323

#endif

   324

   325

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

   326

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

   327

	if (best == -1)

   328

		error("Out of sprite memory");

   329

   330

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

   331

	s = (MemBlock*)_sprite_ptr[best] - 1;

   332

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

   333

	s->size |= S_FREE_MASK;

   334

	_sprite_ptr[best] = NULL;

   335

   336

	// And coalesce adjacent free blocks

   337

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

   338

		if (s->size & S_FREE_MASK) {

   339

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

   340

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

   341

			}

   342

		}

   343

	}

   344

}

   345

   346

static void* AllocSprite(size_t mem_req)

   347

{

   348

	mem_req += sizeof(MemBlock);

   349

   350

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

   351

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

   352

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

   353

   354

	for (;;) {

   355

		MemBlock* s;

   356

   357

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

   358

			if (s->size & S_FREE_MASK) {

   359

				size_t cur_size = s->size & ~S_FREE_MASK;

   360

   361

				/* Is the block exactly the size we need or

   362

				 * big enough for an additional free block? */

   363

				if (cur_size == mem_req ||

   364

						cur_size >= mem_req + sizeof(MemBlock)) {

   365

					// Set size and in use

   366

					s->size = mem_req;

   367

   368

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

   369

					if (cur_size != mem_req) {

   370

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

   371

					}

   372

   373

					return s->data;

   374

				}

   375

			}

   376

		}

   377

   378

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

   379

		DeleteEntryFromSpriteCache();

   380

	}

   381

}

   382

   383

#if defined(NEW_ROTATION)

   384

#define X15(x) else if (s >= x && s < (x+15)) { s = _rotate_tile_sprite[s - x] + x; }

   385

#define X19(x) else if (s >= x && s < (x+19)) { s = _rotate_tile_sprite[s - x] + x; }

   386

#define MAP(from,to,map) else if (s >= from && s <= to) { s = map[s - from] + from; }

   387

   388

   389

static uint RotateSprite(uint s)

   390

{

   391

	static const byte _rotate_tile_sprite[19] = { 0, 2, 4, 6, 8, 10, 12, 14, 1, 3, 5, 7, 9, 11, 13, 17, 18, 16, 15 };

   392

	static const byte _coast_map[9] = {0, 4, 3, 1, 2, 6, 8, 5, 7};

   393

	static const byte _fence_map[6] = {1, 0, 5, 4, 3, 2};

   394

   395

	if (0);

   396

	X19(752)

   397

	X15(990-1)

   398

	X19(3924)

   399

	X19(3943)

   400

	X19(3962)

   401

	X19(3981)

   402

	X19(4000)

   403

	X19(4023)

   404

	X19(4042)

   405

	MAP(4061, 4069, _coast_map)

   406

	X19(4126)

   407

	X19(4145)

   408

	X19(4164)

   409

	X19(4183)

   410

	X19(4202)

   411

	X19(4221)

   412

	X19(4240)

   413

	X19(4259)

   414

	X19(4259)

   415

	X19(4278)

   416

	MAP(4090, 4095, _fence_map)

   417

	MAP(4096, 4101, _fence_map)

   418

	MAP(4102, 4107, _fence_map)

   419

	MAP(4108, 4113, _fence_map)

   420

	MAP(4114, 4119, _fence_map)

   421

	MAP(4120, 4125, _fence_map)

   422

	return s;

   423

}

   424

#endif

   425

   426

const void *GetRawSprite(SpriteID sprite)

   427

{

   428

	void* p;

   429

   430

	assert(sprite < MAX_SPRITES);

   431

   432

#if defined(NEW_ROTATION)

   433

	sprite = RotateSprite(sprite);

   434

#endif

   435

   436

	// Update LRU

   437

#if defined(WANT_NEW_LRU)

   438

	_sprite_lru_new[sprite] = ++_sprite_lru_counter;

   439

#else

   440

	_sprite_lru_cur[sprite] = ++_sprite_lru_counter;

   441

	_sprite_lru[sprite] = 0;

   442

#endif

   443

   444

	p = _sprite_ptr[sprite];

   445

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

   446

	if (p == NULL) p = ReadSprite(sprite);

   447

	return p;

   448

}

   449

   450

   451

void GfxInitSpriteMem(void)

   452

{

   453

	// initialize sprite cache heap

   454

	if (_spritecache_ptr == NULL) _spritecache_ptr = malloc(SPRITE_CACHE_SIZE);

   455

   456

	// A big free block

   457

	_spritecache_ptr->size = (SPRITE_CACHE_SIZE - sizeof(MemBlock)) | S_FREE_MASK;

   458

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

   459

	NextBlock(_spritecache_ptr)->size = 0;

   460

   461

	memset(_sprite_ptr, 0, sizeof(_sprite_ptr));

   462

   463

	_compact_cache_counter = 0;

   464

}