1

/* $Id$ */

     2

     3

/** @file grf.cpp Reading graphics data from (New)GRF files. */

     4

     5

#include "../stdafx.h"

     6

#include "../gfx_func.h"

     7

#include "../fileio_func.h"

     8

#include "../debug.h"

     9

#include "../core/alloc_func.hpp"

    10

#include "../strings_func.h"

    11

#include "table/strings.h"

    12

#include "../gui.h"

    13

#include "grf.hpp"

    14

    15

/**

    16

 * We found a corrupted sprite. This means that the sprite itself

    17

 * contains invalid data or is too small for the given dimensions.

    18

 * @param file_slot the file the errored sprite is in

    19

 * @param file_pos the location in the file of the errored sprite

    20

 * @param line the line where the error occurs.

    21

 * @return always false (to tell loading the sprite failed)

    22

 */

    23

static bool WarnCorruptSprite(uint8 file_slot, size_t file_pos, int line)

    24

{

    25

	static byte warning_level = 0;

    26

	if (warning_level == 0) {

    27

		SetDParamStr(0, FioGetFilename(file_slot));

    28

		ShowErrorMessage(INVALID_STRING_ID, STR_NEWGRF_ERROR_CORRUPT_SPRITE, 0, 0);

    29

	}

    30

	DEBUG(sprite, warning_level, "[%i] Loading corrupted sprite from %s at position %i", line, FioGetFilename(file_slot), (int)file_pos);

    31

	warning_level = 6;

    32

	return false;

    33

}

    34

    35

bool SpriteLoaderGrf::LoadSprite(SpriteLoader::Sprite *sprite, uint8 file_slot, size_t file_pos, SpriteType sprite_type)

    36

{

    37

	/* Open the right file and go to the correct position */

    38

	FioSeekToFile(file_slot, file_pos);

    39

    40

	/* Read the size and type */

    41

	int num = FioReadWord();

    42

	byte type = FioReadByte();

    43

    44

	/* Type 0xFF indicates either a colormap or some other non-sprite info; we do not handle them here */

    45

	if (type == 0xFF) return false;

    46

    47

	sprite->height = FioReadByte();

    48

	sprite->width  = FioReadWord();

    49

	sprite->x_offs = FioReadWord();

    50

	sprite->y_offs = FioReadWord();

    51

    52

	/* 0x02 indicates it is a compressed sprite, so we can't rely on 'num' to be valid.

    53

	 *  In case it is uncompressed, the size is 'num' - 8 (header-size). */

    54

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

    55

    56

	byte *dest_orig = AllocaM(byte, num);

    57

	byte *dest = dest_orig;

    58

	const int dest_size = num;

    59

    60

	/* Read the file, which has some kind of compression */

    61

	while (num > 0) {

    62

		int8 code = FioReadByte();

    63

    64

		if (code >= 0) {

    65

			/* Plain bytes to read */

    66

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

    67

			num -= size;

    68

			if (num < 0) return WarnCorruptSprite(file_slot, file_pos, __LINE__);

    69

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

    70

				*dest = FioReadByte();

    71

				dest++;

    72

			}

    73

		} else {

    74

			/* Copy bytes from earlier in the sprite */

    75

			const uint data_offset = ((code & 7) << 8) | FioReadByte();

    76

			if (dest - data_offset < dest_orig) return WarnCorruptSprite(file_slot, file_pos, __LINE__);

    77

			int size = -(code >> 3);

    78

			num -= size;

    79

			if (num < 0) return WarnCorruptSprite(file_slot, file_pos, __LINE__);

    80

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

    81

				*dest = *(dest - data_offset);

    82

				dest++;

    83

			}

    84

		}

    85

	}

    86

    87

	if (num != 0) return WarnCorruptSprite(file_slot, file_pos, __LINE__);

    88

    89

	sprite->data = CallocT<SpriteLoader::CommonPixel>(sprite->width * sprite->height);

    90

    91

	/* When there are transparency pixels, this format has an other trick.. decode it */

    92

	if (type & 0x08) {

    93

		for (int y = 0; y < sprite->height; y++) {

    94

			bool last_item = false;

    95

			/* Look up in the header-table where the real data is stored for this row */

    96

			int offset = (dest_orig[y * 2 + 1] << 8) | dest_orig[y * 2];

    97

    98

			/* Go to that row */

    99

			dest = dest_orig + offset;

   100

   101

			do {

   102

				if (dest + 2 > dest_orig + dest_size) {

   103

					free(sprite->data);

   104

					return WarnCorruptSprite(file_slot, file_pos, __LINE__);

   105

				}

   106

   107

				SpriteLoader::CommonPixel *data;

   108

				/* Read the header:

   109

				 *  0 .. 14  - length

   110

				 *  15       - last_item

   111

				 *  16 .. 31 - transparency bytes */

   112

				last_item  = ((*dest) & 0x80) != 0;

   113

				int length =  (*dest++) & 0x7F;

   114

				int skip   =   *dest++;

   115

   116

				data = &sprite->data[y * sprite->width + skip];

   117

   118

				if (skip + length > sprite->width || dest + length > dest_orig + dest_size) {

   119

					free(sprite->data);

   120

					return WarnCorruptSprite(file_slot, file_pos, __LINE__);

   121

				}

   122

   123

				for (int x = 0; x < length; x++) {

   124

					data->m = ((sprite_type == ST_NORMAL && _palette_remap_grf[file_slot]) ? _palette_remap[*dest] : *dest);

   125

					dest++;

   126

					data++;

   127

				}

   128

			} while (!last_item);

   129

		}

   130

	} else {

   131

		if (dest_size < sprite->width * sprite->height) {

   132

			free(sprite->data);

   133

			return WarnCorruptSprite(file_slot, file_pos, __LINE__);

   134

		}

   135

   136

		if (dest_size > sprite->width * sprite->height) {

   137

			static byte warning_level = 0;

   138

			DEBUG(sprite, warning_level, "Ignoring %i unused extra bytes from the sprite from %s at position %i", dest_size - sprite->width * sprite->height, FioGetFilename(file_slot), (int)file_pos);

   139

			warning_level = 6;

   140

		}

   141

   142

		dest = dest_orig;

   143

   144

		for (int i = 0; i < sprite->width * sprite->height; i++) {

   145

			sprite->data[i].m = ((sprite_type == ST_NORMAL && _palette_remap_grf[file_slot]) ? _palette_remap[dest[i]] : dest[i]);

   146

		}

   147

	}

   148

   149

	/* Make sure to mark all transparent pixels transparent on the alpha channel too */

   150

	for (int i = 0; i < sprite->width * sprite->height; i++)

   151

		if (sprite->data[i].m != 0) sprite->data[i].a = 0xFF;

   152

   153

	return true;

   154

}