1 /***********************************************************
2 * Artsoft Retro-Game Library *
3 *----------------------------------------------------------*
4 * (c) 1994-2002 Artsoft Entertainment *
6 * Detmolder Strasse 189 *
9 * e-mail: info@artsoft.org *
10 *----------------------------------------------------------*
12 ***********************************************************/
22 #define PCX_DEBUG FALSE
24 #define PCX_MAGIC 0x0a /* first byte in a PCX image file */
25 #define PCX_SUPPORTED_VERSION 5 /* last acceptable version number */
26 #define PCX_ENCODING 1 /* PCX encoding method */
27 #define PCX_256COLORS_MAGIC 0x0c /* first byte of a PCX 256 color map */
28 #define PCX_MAXCOLORS 256 /* maximum number of colors */
30 #define PCX_HEADER_SIZE 128
31 #define PCX_COLORMAP_SIZE (3 * PCX_MAXCOLORS)
35 unsigned char signature; /* PCX file identifier */
36 unsigned char version; /* version compatibility level */
37 unsigned char encoding; /* encoding method */
38 unsigned char bits_per_pixel; /* bits per pixel (not depth!) */
39 unsigned short xmin; /* X position of left edge */
40 unsigned short ymin; /* Y position of top edge */
41 unsigned short xmax; /* X position of right edge */
42 unsigned short ymax; /* Y position of bottom edge */
43 unsigned short hres; /* X screen resolution of source image */
44 unsigned short vres; /* Y screen resolution of source image */
45 unsigned char palette[16][3]; /* PCX color map */
46 unsigned char reserved; /* should be 0, 1 if std res fax */
47 unsigned char color_planes; /* "color planes" in image */
48 unsigned short bytes_per_line;/* byte delta between scanlines */
49 unsigned short palette_type; /* 0 = undef, 1 = color, 2 = grayscale */
50 unsigned char filler[58]; /* fill to struct size of 128 */
53 /* global PCX error value */
54 int errno_pcx = PCX_Success;
57 static byte *PCX_ReadBitmap(Image *image, byte *buffer_ptr, byte *buffer_last)
59 /* Run Length Encoding: If the two high bits are set,
60 * then the low 6 bits contain a repeat count, and the byte to
61 * repeat is the next byte in the file. If the two high bits are
62 * not set, then this is the byte to write.
65 unsigned int bytes_per_pixel = (image->depth + 7) / 8;
66 register byte *bitmap_ptr, *bitmap_last;
67 register byte value, count;
69 bitmap_ptr = image->data;
70 bitmap_last = bitmap_ptr + (image->width * image->height * bytes_per_pixel);
72 while (bitmap_ptr < bitmap_last && buffer_ptr < buffer_last)
74 value = *buffer_ptr++;
76 if ((value & 0xc0) == 0xc0) /* this is a repeat count byte */
78 count = value & 0x3f; /* extract repeat count from byte */
79 value = *buffer_ptr++; /* next byte is value to repeat */
81 for (; count && bitmap_ptr < bitmap_last; count--)
82 *bitmap_ptr++ = value;
84 if (count) /* repeat count spans end of bitmap */
88 *bitmap_ptr++ = value;
90 image->rgb.color_used[value] = TRUE;
93 /* check if end of buffer was reached before end of bitmap */
94 if (bitmap_ptr < bitmap_last)
97 /* return current buffer position for next decoding function */
102 static boolean PCX_ReadBitmap(FILE *file, struct PCX_Header *pcx, Image *image)
104 int width = image->width;
105 int height = image->height;
106 int pcx_depth = pcx->bits_per_pixel * pcx->color_planes;
107 int bytes_per_row = pcx->color_planes * pcx->bytes_per_line;
108 byte *row_buffer = checked_malloc(bytes_per_row);
109 byte *bitmap_ptr = image->data;
112 for (y = 0; y < height; y++)
114 /* decode a scan line into a temporary buffer first */
115 byte *dst_ptr = (pcx_depth == 8 ? bitmap_ptr : row_buffer);
116 byte value = 0, count = 0;
120 for (i = 0; i < bytes_per_row; i++)
124 if ((value_int = fgetc(file)) == EOF)
126 value = (byte)value_int;
128 if ((value & 0xc0) == 0xc0) /* this is a repeat count byte */
130 count = value & 0x3f; /* extract repeat count from byte */
131 if ((value_int = fgetc(file)) == EOF)
133 value = (byte)value_int;
143 image->rgb.color_used[value] = TRUE;
146 if (pcx_depth <= 4) /* expand planes to 1 byte/pixel */
148 byte *src_ptr = row_buffer;
151 for (plane = 0; plane < pcx->color_planes; plane++)
155 for (i = 0; i < pcx->bytes_per_line; i++)
157 byte value = *src_ptr++;
159 for (j = 7; j >= 0; j--)
161 byte bit = (value >> j) & 1;
163 bitmap_ptr[x++] |= bit << plane;
168 else if (pcx_depth == 24) /* de-interlace planes */
170 byte *src_ptr = row_buffer;
173 for (plane = 0; plane < pcx->color_planes; plane++)
177 dst_ptr = bitmap_ptr + plane;
178 for (x = 0; x < width; x++)
180 *dst_ptr = *src_ptr++;
181 dst_ptr += pcx->color_planes;
186 bitmap_ptr += image->bytes_per_row;
193 static byte *PCX_ReadColormap(Image *image,byte *buffer_ptr, byte *buffer_last)
197 /* read colormap magic byte */
198 magic = *buffer_ptr++;
200 /* check magic colormap header byte */
201 if (magic != PCX_256COLORS_MAGIC)
204 /* check if enough bytes left for a complete colormap */
205 if (buffer_ptr + PCX_COLORMAP_SIZE > buffer_last)
208 /* read 256 colors from PCX colormap */
209 for (i=0; i<PCX_MAXCOLORS; i++)
211 image->rgb.red[i] = *buffer_ptr++ << 8;
212 image->rgb.green[i] = *buffer_ptr++ << 8;
213 image->rgb.blue[i] = *buffer_ptr++ << 8;
216 /* return current buffer position for next decoding function */
221 static boolean PCX_ReadColormap(FILE *file,struct PCX_Header *pcx,Image *image)
223 int pcx_depth = pcx->bits_per_pixel * pcx->color_planes;
224 int num_colors = (1 << pcx_depth);
227 if (image->depth != 8)
235 /* look for a 256-colour palette */
238 if ((value_int = fgetc(file)) == EOF)
240 value = (byte)value_int;
242 while (value != PCX_256COLORS_MAGIC);
244 /* read 256 colors from PCX colormap */
245 for(i = 0; i < PCX_MAXCOLORS; i++)
247 image->rgb.red[i] = (byte)fgetc(file) << 8;
248 image->rgb.green[i] = (byte)fgetc(file) << 8;
249 image->rgb.blue[i] = (byte)fgetc(file) << 8;
254 for(i = 0; i < num_colors; i++)
256 image->rgb.red[i] = pcx->palette[i][0] << 8;
257 image->rgb.green[i] = pcx->palette[i][1] << 8;
258 image->rgb.blue[i] = pcx->palette[i][2] << 8;
265 Image *Read_PCX_to_Image(char *filename)
268 byte header_buffer[PCX_HEADER_SIZE];
269 struct PCX_Header pcx;
271 int width, height, depth, pcx_depth;
274 errno_pcx = PCX_Success;
276 if (!(file = fopen(filename, MODE_READ)))
278 errno_pcx = PCX_OpenFailed;
282 if (fread(header_buffer, 1, PCX_HEADER_SIZE, file) != PCX_HEADER_SIZE)
286 errno_pcx = PCX_ReadFailed;
290 pcx.signature = header_buffer[0];
291 pcx.version = header_buffer[1];
292 pcx.encoding = header_buffer[2];
293 pcx.bits_per_pixel = header_buffer[3];
294 pcx.xmin = (header_buffer[5] << 8) | header_buffer[4];
295 pcx.ymin = (header_buffer[7] << 8) | header_buffer[6];
296 pcx.xmax = (header_buffer[9] << 8) | header_buffer[8];
297 pcx.ymax = (header_buffer[11] << 8) | header_buffer[10];
298 pcx.color_planes = header_buffer[65];
299 pcx.bytes_per_line = (header_buffer[67] << 8) | header_buffer[66];
300 pcx.palette_type = (header_buffer[69] << 8) | header_buffer[68];
302 for (i = 0; i < 48; i++)
303 pcx.palette[i / 3][i % 3] = header_buffer[16 + i];
305 width = pcx.xmax - pcx.xmin + 1;
306 height = pcx.ymax - pcx.ymin + 1;
307 pcx_depth = pcx.bits_per_pixel * pcx.color_planes;
308 depth = ((pcx_depth + 7) / 8) * 8;
310 if (pcx.signature != PCX_MAGIC ||
311 pcx.version != PCX_SUPPORTED_VERSION ||
312 pcx.encoding != PCX_ENCODING ||
313 width < 0 || height < 0)
317 errno_pcx = PCX_FileInvalid;
324 printf("%s is a %dx%d PC Paintbrush image\n", filename, width, height);
325 printf("depth: %d\n", depth);
326 printf("bits_per_pixel: %d\n", pcx.bits_per_pixel);
327 printf("color_planes: %d\n", pcx.color_planes);
328 printf("bytes_per_line: %d\n", pcx.bytes_per_line);
329 printf("palette type: %s\n",
330 (pcx.palette_type == 1 ? "color" :
331 pcx.palette_type == 2 ? "grayscale" : "undefined"));
335 /* allocate new image structure */
336 image = newImage(width, height, depth);
338 /* read compressed bitmap data */
339 if (!PCX_ReadBitmap(file, &pcx, image))
344 errno_pcx = PCX_FileInvalid;
348 /* read colormap data */
349 if (!PCX_ReadColormap(file, &pcx, image))
354 errno_pcx = PCX_ColorFailed;
362 /* determine number of used colormap entries for 8-bit PCX images */
364 for (i=0; i<PCX_MAXCOLORS; i++)
365 if (image->rgb.color_used[i])
371 printf("Read_PCX_to_Image: %d colors found\n", image->rgb.used);
377 #endif /* !TARGET_SDL */