PIKApp/plug-ins/common/file-gif-load.c

1418 lines
40 KiB
C

/* GIF loading file filter for PIKA 2.x
* +-------------------------------------------------------------------+
* | Copyright Adam D. Moss, Peter Mattis, Spencer Kimball |
* +-------------------------------------------------------------------+
* Version 1.50.4 - 2003/06/03
* Adam D. Moss - <adam@gimp.org> <adam@foxbox.org>
*/
/* Copyright notice for old GIF code from which this plugin was long ago */
/* derived (David Koblas has kindly granted permission to relicense): */
/* +-------------------------------------------------------------------+ */
/* | Copyright 1990, 1991, 1993, David Koblas. (koblas@extra.com) | */
/* +-------------------------------------------------------------------+ */
/* Also...
* 'This filter uses code taken from the "giftopnm" and "ppmtogif" programs
* which are part of the "netpbm" package.'
*/
/* Additionally...
* "The Graphics Interchange Format(c) is the Copyright property of
* CompuServe Incorporated. GIF(sm) is a Service Mark property of
* CompuServe Incorporated."
*/
/*
* REVISION HISTORY
*
* 2003/06/03
* 1.50.04 - When initializing the LZW state, watch out for a completely
* bogus input_code_size [based on fix by Raphael Quinet]
* Also, fix a stupid old bug when clearing the code table between
* subimages. (Enables us to deal better with errors when the stream is
* corrupted pretty early in a subimage.) [adam]
* Minor-version-bump to distinguish between pika1.2/1.4 branches.
*
* 2000/03/31
* 1.00.03 - Just mildly more useful comments/messages concerning frame
* disposals.
*
* 1999/11/20
* 1.00.02 - Fixed a couple of possible infinite loops where an
* error condition was not being checked. Also changed some g_message()s
* back to g_warning()s as they should be (don't get carried away with
* the user feedback fellahs, no-one wants to be told of every single
* corrupt byte and block in its own little window. :-( ).
*
* 1999/11/11
* 1.00.01 - Fixed an uninitialized variable which has been around
* forever... thanks to jrb@redhat.com for noticing that there
* was a problem somewhere!
*
* 1999/03/20
* 1.00.00 - GIF load-only code split from main GIF plugin.
*
* For previous revision information, please consult the comments
* in the 'gif' plugin.
*/
/*
* TODO (more *'s means more important!)
*
* - PDB stuff for comments
*
* - Remove unused colormap entries for GRAYSCALE images.
*/
#include "config.h"
#include <errno.h>
#include <string.h>
#include <glib/gstdio.h>
#include <libpika/pika.h>
#include "libpika/stdplugins-intl.h"
#define LOAD_PROC "file-gif-load"
#define LOAD_THUMB_PROC "file-gif-load-thumb"
/* uncomment the line below for a little debugging info */
/* #define GIFDEBUG yesplease */
typedef struct _Gif Gif;
typedef struct _GifClass GifClass;
struct _Gif
{
PikaPlugIn parent_instance;
};
struct _GifClass
{
PikaPlugInClass parent_class;
};
#define GIF_TYPE (gif_get_type ())
#define GIF(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GIF_TYPE, Gif))
GType gif_get_type (void) G_GNUC_CONST;
static GList * gif_query_procedures (PikaPlugIn *plug_in);
static PikaProcedure * gif_create_procedure (PikaPlugIn *plug_in,
const gchar *name);
static PikaValueArray * gif_load (PikaProcedure *procedure,
PikaRunMode run_mode,
GFile *file,
PikaMetadata *metadata,
PikaMetadataLoadFlags *flags,
PikaProcedureConfig *config,
gpointer run_data);
static PikaValueArray * gif_load_thumb (PikaProcedure *procedure,
GFile *file,
gint size,
PikaProcedureConfig *config,
gpointer run_data);
static PikaImage * load_image (GFile *file,
gboolean thumbnail,
GError **error);
G_DEFINE_TYPE (Gif, gif, PIKA_TYPE_PLUG_IN)
PIKA_MAIN (GIF_TYPE)
DEFINE_STD_SET_I18N
static guchar used_cmap[3][256];
static guint highest_used_index;
static gboolean promote_to_rgb = FALSE;
static guchar pika_cmap[768];
static PikaParasite *comment_parasite = NULL;
static void
gif_class_init (GifClass *klass)
{
PikaPlugInClass *plug_in_class = PIKA_PLUG_IN_CLASS (klass);
plug_in_class->query_procedures = gif_query_procedures;
plug_in_class->create_procedure = gif_create_procedure;
plug_in_class->set_i18n = STD_SET_I18N;
}
static void
gif_init (Gif *gif)
{
}
static GList *
gif_query_procedures (PikaPlugIn *plug_in)
{
GList *list = NULL;
list = g_list_append (list, g_strdup (LOAD_THUMB_PROC));
list = g_list_append (list, g_strdup (LOAD_PROC));
return list;
}
static PikaProcedure *
gif_create_procedure (PikaPlugIn *plug_in,
const gchar *name)
{
PikaProcedure *procedure = NULL;
if (! strcmp (name, LOAD_PROC))
{
procedure = pika_load_procedure_new (plug_in, name,
PIKA_PDB_PROC_TYPE_PLUGIN,
gif_load, NULL, NULL);
pika_procedure_set_menu_label (procedure, _("GIF image"));
pika_procedure_set_documentation (procedure,
"Loads files of Compuserve GIF "
"file format", NULL,
name);
pika_procedure_set_attribution (procedure,
"Spencer Kimball, Peter Mattis, "
"Adam Moss, David Koblas",
"Spencer Kimball, Peter Mattis, "
"Adam Moss, David Koblas",
"1995-2006");
pika_file_procedure_set_mime_types (PIKA_FILE_PROCEDURE (procedure),
"image/gif");
pika_file_procedure_set_extensions (PIKA_FILE_PROCEDURE (procedure),
"gif");
pika_file_procedure_set_magics (PIKA_FILE_PROCEDURE (procedure),
"0,string,GIF8");
pika_load_procedure_set_thumbnail_loader (PIKA_LOAD_PROCEDURE (procedure),
LOAD_THUMB_PROC);
}
else if (! strcmp (name, LOAD_THUMB_PROC))
{
procedure = pika_thumbnail_procedure_new (plug_in, name,
PIKA_PDB_PROC_TYPE_PLUGIN,
gif_load_thumb, NULL, NULL);
pika_procedure_set_documentation (procedure,
"Loads only the first frame of a "
"GIF image, to be "
"used as a thumbnail",
"",
name);
pika_procedure_set_attribution (procedure,
"Sven Neumann",
"Sven Neumann",
"2006");
}
return procedure;
}
static PikaValueArray *
gif_load (PikaProcedure *procedure,
PikaRunMode run_mode,
GFile *file,
PikaMetadata *metadata,
PikaMetadataLoadFlags *flags,
PikaProcedureConfig *config,
gpointer run_data)
{
PikaValueArray *return_vals;
PikaImage *image;
GError *error = NULL;
gegl_init (NULL, NULL);
image = load_image (file, FALSE, &error);
if (! image)
return pika_procedure_new_return_values (procedure,
PIKA_PDB_EXECUTION_ERROR,
error);
/* The GIF format only tells you how many bits per pixel are in the
* image, not the actual number of used indices (D'OH!)
*
* So if we're not careful, repeated load/save of a transparent GIF
* without intermediate indexed->RGB->indexed pumps up the number
* of bits used, as we add an index each time for the transparent
* color. Ouch. We either do some heavier analysis at save-time,
* or trim down the number of PIKA colors at load-time. We do the
* latter for now.
*/
#ifdef GIFDEBUG
g_print ("GIF: Highest used index is %d\n", highest_used_index);
#endif
if (! promote_to_rgb)
pika_image_set_colormap (image,
pika_cmap, highest_used_index);
return_vals = pika_procedure_new_return_values (procedure,
PIKA_PDB_SUCCESS,
NULL);
*flags = PIKA_METADATA_LOAD_ALL;
PIKA_VALUES_SET_IMAGE (return_vals, 1, image);
return return_vals;
}
static PikaValueArray *
gif_load_thumb (PikaProcedure *procedure,
GFile *file,
gint size,
PikaProcedureConfig *config,
gpointer run_data)
{
PikaValueArray *return_vals;
PikaImage *image;
GError *error = NULL;
gegl_init (NULL, NULL);
image = load_image (file, TRUE, &error);
if (! image)
return pika_procedure_new_return_values (procedure,
PIKA_PDB_EXECUTION_ERROR,
error);
if (! promote_to_rgb)
pika_image_set_colormap (image, pika_cmap, highest_used_index);
return_vals = pika_procedure_new_return_values (procedure,
PIKA_PDB_SUCCESS,
NULL);
PIKA_VALUES_SET_IMAGE (return_vals, 1, image);
PIKA_VALUES_SET_INT (return_vals, 2, pika_image_get_width (image));
PIKA_VALUES_SET_INT (return_vals, 3, pika_image_get_height (image));
pika_value_array_truncate (return_vals, 4);
return return_vals;
}
#define MAXCOLORMAPSIZE 256
/* Max size of data buffer. Count is one byte so maximum read is 255. In
* GetCode we use 2 extra bytes, so let's set it to 260 to be safe. */
#define MAXDATABLOCKSIZE 260
#define CM_RED 0
#define CM_GREEN 1
#define CM_BLUE 2
#define MAX_LZW_BITS 12
#define INTERLACE 0x40
#define LOCALCOLORMAP 0x80
#define BitSet(byte, bit) (((byte) & (bit)) == (bit))
#define gif_message(...) (g_message("%s. %s", __VA_ARGS__))
#define ReadOK(file,buffer,len) (fread(buffer, len, 1, file) != 0)
#define LM_to_uint(a,b) (((b)<<8)|(a))
#define GRAYSCALE 1
#define COLOR 2
typedef guchar CMap[3][MAXCOLORMAPSIZE];
static struct
{
guint Width;
guint Height;
CMap ColorMap;
guint BitPixel;
guint ColorResolution;
guint Background;
guint AspectRatio;
/*
**
*/
gint GrayScale;
} GifScreen;
static struct
{
gint transparent;
gint delayTime;
gint inputFlag;
gint disposal;
gint num_loops;
} Gif89 = { -1, -1, -1, 0, -1 };
static void read_error (const gchar *error_type,
PikaImage *image,
GError **error);
static gboolean ReadColorMap (FILE *fd,
gint number,
CMap buffer,
gint *format);
static gint DoExtension (FILE *fd,
gint label);
static gint GetDataBlock (FILE *fd,
guchar *buf);
static gint GetCode (FILE *fd,
gint code_size,
gboolean flag);
static gint LZWReadByte (FILE *fd,
gint just_reset_LZW,
gint input_code_size);
static gboolean ReadImage (FILE *fd,
GFile *file,
gint len,
gint height,
CMap cmap,
gint ncols,
gint format,
gint interlace,
gint number,
guint leftpos,
guint toppos,
guint screenwidth,
guint screenheight,
PikaImage **image,
GError **error);
static PikaImage *
load_image (GFile *file,
gboolean thumbnail,
GError **error)
{
FILE *fd;
guchar buf[16];
guchar c;
CMap localColorMap;
gint grayScale;
gboolean useGlobalColormap;
gint bitPixel;
gint imageCount = 0;
PikaImage *image = NULL;
gboolean status;
gboolean saved_parasite = FALSE;
pika_progress_init_printf (_("Opening '%s'"),
pika_file_get_utf8_name (file));
fd = g_fopen (g_file_peek_path (file), "rb");
if (! fd)
{
g_set_error (error, G_FILE_ERROR, g_file_error_from_errno (errno),
_("Could not open '%s' for reading: %s"),
pika_file_get_utf8_name (file), g_strerror (errno));
return NULL;
}
if (! ReadOK (fd, buf, 6))
{
read_error (_("GIF magic code"), NULL, error);
fclose (fd);
return NULL;
}
if (strncmp ((gchar *) buf, "GIF", 3) != 0)
{
g_set_error (error, PIKA_PLUG_IN_ERROR, 0,
_("This is not a GIF file: incorrect magic code"));
fclose (fd);
return NULL;
}
if ((strncmp ((gchar *) buf + 3, "87a", 3) != 0) && (strncmp ((gchar *) buf + 3, "89a", 3) != 0))
{
g_set_error (error, PIKA_PLUG_IN_ERROR, 0,
_("Incorrect GIF version: not '87a' or '89a'"));
fclose (fd);
return NULL;
}
if (! ReadOK (fd, buf, 7))
{
read_error (_("screen descriptor"), NULL, error);
fclose (fd);
return NULL;
}
GifScreen.Width = LM_to_uint (buf[0], buf[1]);
GifScreen.Height = LM_to_uint (buf[2], buf[3]);
GifScreen.BitPixel = 2 << (buf[4] & 0x07);
GifScreen.ColorResolution = (((buf[4] & 0x70) >> 3) + 1);
GifScreen.Background = buf[5];
GifScreen.AspectRatio = buf[6];
if (BitSet (buf[4], LOCALCOLORMAP))
{
/* Global Colormap */
if (! ReadColorMap (fd, GifScreen.BitPixel, GifScreen.ColorMap,
&GifScreen.GrayScale))
{
read_error (_("global colormap"), NULL, error);
fclose (fd);
return NULL;
}
}
highest_used_index = GifScreen.BitPixel;
while (TRUE)
{
if (! ReadOK (fd, &c, 1))
{
read_error (_("image data"), image, error);
fclose (fd);
return image; /* will be NULL if failed on first image! */
}
if (c == ';')
{
/* GIF terminator */
fclose (fd);
return image;
}
if (c == '!')
{
/* Extension */
if (! ReadOK (fd, &c, 1))
{
read_error (_("extension data"), image, error);
fclose (fd);
return image; /* will be NULL if failed on first image! */
}
DoExtension (fd, c);
continue;
}
if (c != ',')
{
/* Not a valid start character */
g_printerr ("GIF: bogus character 0x%02x, ignoring.\n", (int) c);
continue;
}
++imageCount;
if (! ReadOK (fd, buf, 9))
{
read_error (_("frame info"), image, error);
fclose (fd);
return image; /* will be NULL if failed on first image! */
}
useGlobalColormap = !BitSet (buf[8], LOCALCOLORMAP);
bitPixel = 1 << ((buf[8] & 0x07) + 1);
if (! useGlobalColormap)
{
if (! ReadColorMap (fd, bitPixel, localColorMap, &grayScale))
{
read_error (_("local colormap"), image, error);
fclose (fd);
return image; /* will be NULL if failed on first image! */
}
highest_used_index = bitPixel;
status = ReadImage (fd, file, LM_to_uint (buf[4], buf[5]),
LM_to_uint (buf[6], buf[7]),
localColorMap, bitPixel,
grayScale,
BitSet (buf[8], INTERLACE), imageCount,
(guint) LM_to_uint (buf[0], buf[1]),
(guint) LM_to_uint (buf[2], buf[3]),
GifScreen.Width,
GifScreen.Height,
&image, error);
}
else
{
status = ReadImage (fd, file, LM_to_uint (buf[4], buf[5]),
LM_to_uint (buf[6], buf[7]),
GifScreen.ColorMap, GifScreen.BitPixel,
GifScreen.GrayScale,
BitSet (buf[8], INTERLACE), imageCount,
(guint) LM_to_uint (buf[0], buf[1]),
(guint) LM_to_uint (buf[2], buf[3]),
GifScreen.Width,
GifScreen.Height,
&image, error);
}
if (!status)
break;
if (GifScreen.AspectRatio != 0 && GifScreen.AspectRatio != 49)
{
/* Byte overflow is allowed per the GIF specification */
guint8 par = GifScreen.AspectRatio + 15;
if (par > 0)
{
gdouble image_xres;
gdouble image_yres;
gfloat ratio = par / 64.0;
g_message (_("Non-square pixels. Image might look squashed if "
"Dot for Dot mode is enabled."));
pika_image_get_resolution (image, &image_xres, &image_yres);
if (ratio < 1)
image_xres = image_yres * (1 / ratio);
else
image_yres = image_xres * ratio;
pika_image_set_resolution (image, image_xres, image_yres);
}
}
if (comment_parasite != NULL)
{
if (! thumbnail)
pika_image_attach_parasite (image, comment_parasite);
pika_parasite_free (comment_parasite);
comment_parasite = NULL;
}
/* If we are loading a thumbnail, we stop after the first frame. */
if (thumbnail)
break;
/* If there is more than one frame, we add a parasite so that
* we know to export as an animation on overwrite */
if (Gif89.num_loops > -1 && ! saved_parasite)
{
PikaParasite *parasite;
gchar *str;
str = g_strdup_printf ("%d", Gif89.num_loops);
parasite = pika_parasite_new ("gif/animated",
PIKA_PARASITE_PERSISTENT,
strlen (str) + 1,
(gpointer) str);
g_free (str);
pika_image_attach_parasite (image, parasite);
pika_parasite_free (parasite);
saved_parasite = TRUE;
}
}
fclose (fd);
return image;
}
static void
read_error (const gchar *error_type, PikaImage *image, GError **error)
{
if (! image)
{
g_set_error (error, PIKA_PLUG_IN_ERROR, 0,
_("Error reading %s. %s"),
error_type, _("Image may be corrupt!"));
}
else
{
g_message (_("Error reading %s. %s"),
error_type, _("Image may be corrupt!"));
}
}
static gboolean
ReadColorMap (FILE *fd,
gint number,
CMap buffer,
gint *format)
{
guchar rgb[3];
gint flag;
gint i;
flag = TRUE;
for (i = 0; i < number; ++i)
{
if (! ReadOK (fd, rgb, sizeof (rgb)))
return FALSE;
buffer[CM_RED][i] = rgb[0];
buffer[CM_GREEN][i] = rgb[1];
buffer[CM_BLUE][i] = rgb[2];
flag &= (rgb[0] == rgb[1] && rgb[1] == rgb[2]);
}
*format = (flag) ? GRAYSCALE : COLOR;
return TRUE;
}
static gint
DoExtension (FILE *fd,
gint label)
{
static guchar buf[MAXDATABLOCKSIZE];
gint bufsize;
#ifdef GIFDEBUG
gchar *str;
#endif
switch (label)
{
case 0x01: /* Plain Text Extension */
#ifdef GIFDEBUG
str = "Plain Text Extension";
#endif
#ifdef notdef
if (GetDataBlock (fd, (guchar *) buf) == 0)
;
lpos = LM_to_uint (buf[0], buf[1]);
tpos = LM_to_uint (buf[2], buf[3]);
width = LM_to_uint (buf[4], buf[5]);
height = LM_to_uint (buf[6], buf[7]);
cellw = buf[8];
cellh = buf[9];
foreground = buf[10];
background = buf[11];
while (GetDataBlock (fd, (guchar *) buf) > 0)
{
PPM_ASSIGN (image[ypos][xpos],
cmap[CM_RED][v],
cmap[CM_GREEN][v],
cmap[CM_BLUE][v]);
++index;
}
return FALSE;
#else
break;
#endif
case 0xff: /* Application Extension */
#ifdef GIFDEBUG
str = "Application Extension";
#endif
/* Animation block */
if (GetDataBlock (fd, (guchar *) buf))
{
if (strncmp ((const gchar *) buf, "NETSCAPE2.0", 8) == 0)
{
if (GetDataBlock (fd, (guchar *) buf))
Gif89.num_loops = (buf[0] << 8) | buf[1];
}
}
break;
case 0xfe: /* Comment Extension */
#ifdef GIFDEBUG
str = "Comment Extension";
#endif
while ((bufsize = GetDataBlock (fd, (guchar *) buf)) > 0)
{
gchar *comment = (gchar *) buf;
/* Make sure we end with a NULL */
comment[bufsize] = '\0';
if (! g_utf8_validate (comment, -1, NULL))
continue;
if (comment_parasite)
pika_parasite_free (comment_parasite);
comment_parasite = pika_parasite_new ("pika-comment",
PIKA_PARASITE_PERSISTENT,
strlen (comment) + 1, comment);
}
return TRUE;
break;
case 0xf9: /* Graphic Control Extension */
#ifdef GIFDEBUG
str = "Graphic Control Extension";
#endif
(void) GetDataBlock (fd, (guchar *) buf);
Gif89.disposal = (buf[0] >> 2) & 0x7;
Gif89.inputFlag = (buf[0] >> 1) & 0x1;
Gif89.delayTime = LM_to_uint (buf[1], buf[2]);
if ((buf[0] & 0x1) != 0)
Gif89.transparent = buf[3];
else
Gif89.transparent = -1;
while (GetDataBlock (fd, (guchar *) buf) > 0);
return FALSE;
break;
default:
#ifdef GIFDEBUG
str = (gchar *)buf;
#endif
sprintf ((gchar *)buf, "UNKNOWN (0x%02x)", label);
break;
}
#ifdef GIFDEBUG
g_print ("GIF: got a '%s'\n", str);
#endif
while (GetDataBlock (fd, (guchar *) buf) > 0);
return FALSE;
}
static gint ZeroDataBlock = FALSE;
static gint
GetDataBlock (FILE *fd,
guchar *buf)
{
guchar count;
if (! ReadOK (fd, &count, 1))
{
gif_message (_("Error reading data size"), _("Image may be corrupt!"));
return -1;
}
ZeroDataBlock = (count == 0);
if ((count != 0) && (! ReadOK (fd, buf, count)))
{
gif_message (_("Error reading data"), _("Image may be corrupt!"));
return -1;
}
return count;
}
static gint
GetCode (FILE *fd,
gint code_size,
gboolean flag)
{
static guchar buf[MAXDATABLOCKSIZE];
static gint curbit, lastbit, done, last_byte;
gint i, j, ret, count;
if (flag)
{
curbit = 0;
lastbit = 0;
done = FALSE;
last_byte = 2;
return 0;
}
while ((curbit + code_size) > lastbit)
{
if (done)
{
if (curbit >= lastbit)
{
gif_message (_("Not enough compressed data"), _("Image may be corrupt!"));
return -1;
}
return -2;
}
buf[0] = buf[last_byte - 2];
buf[1] = buf[last_byte - 1];
count = GetDataBlock (fd, &buf[2]);
if (count < 0)
{
return -1;
}
else if (count == 0)
{
done = TRUE;
}
last_byte = 2 + count;
curbit = (curbit - lastbit) + 16;
lastbit = (2 + count) * 8;
}
ret = 0;
for (i = curbit, j = 0; j < code_size; ++i, ++j)
ret |= ((buf[i / 8] & (1 << (i % 8))) != 0) << j;
curbit += code_size;
return ret;
}
static gint
LZWReadByte (FILE *fd,
gint just_reset_LZW,
gint input_code_size)
{
static gint fresh = FALSE;
gint code, incode;
static gint code_size, set_code_size;
static gint max_code, max_code_size;
static gint firstcode, oldcode;
static gint clear_code, end_code;
static gint table[2][(1 << MAX_LZW_BITS)];
#define STACK_SIZE ((1 << (MAX_LZW_BITS)) * 2)
static gint stack[STACK_SIZE], *sp;
gint i;
if (just_reset_LZW)
{
if (input_code_size > MAX_LZW_BITS || input_code_size <= 1)
{
gif_message (_("Value out of range for code size"), _("Image may be corrupt!"));
return -1;
}
set_code_size = input_code_size;
code_size = set_code_size + 1;
clear_code = 1 << set_code_size;
end_code = clear_code + 1;
max_code_size = 2 * clear_code;
max_code = clear_code + 2;
if ((code = GetCode (fd, 0, TRUE)) < 0)
{
return code;
}
fresh = TRUE;
sp = stack;
for (i = 0; i < clear_code; ++i)
{
table[0][i] = 0;
table[1][i] = i;
}
for (; i < (1 << MAX_LZW_BITS); ++i)
{
table[0][i] = 0;
table[1][i] = 0;
}
return 0;
}
else if (fresh)
{
fresh = FALSE;
do
{
firstcode = oldcode = GetCode (fd, code_size, FALSE);
}
while (firstcode == clear_code);
if (firstcode < 0)
{
return firstcode;
}
return firstcode & 255;
}
if (sp > stack)
return (*--sp) & 255;
while ((code = GetCode (fd, code_size, FALSE)) >= 0)
{
if (code == clear_code)
{
for (i = 0; i < clear_code; ++i)
{
table[0][i] = 0;
table[1][i] = i;
}
for (; i < (1 << MAX_LZW_BITS); ++i)
{
table[0][i] = 0;
table[1][i] = 0;
}
code_size = set_code_size + 1;
max_code_size = 2 * clear_code;
max_code = clear_code + 2;
sp = stack;
firstcode = oldcode = GetCode (fd, code_size, FALSE);
if (firstcode < 0)
{
return firstcode;
}
return firstcode & 255;
}
else if (code == end_code || code > max_code)
{
gint count;
guchar buf[MAXDATABLOCKSIZE];
gboolean extra_data = FALSE;
if (code != end_code)
{
gif_message (_("Invalid code, expecting end of data marker"),
_("Image may be corrupt!"));
code = -1;
}
else
{
code = -2;
}
if (ZeroDataBlock)
{
return code;
}
while ((count = GetDataBlock (fd, buf)) > 0)
{
extra_data = TRUE;
}
if (count != 0 || extra_data)
{
gif_message (_("Unexpected extra data"), _("Image may be corrupt!"));
}
return -1;
}
incode = code;
if (code == max_code)
{
if (sp < &(stack[STACK_SIZE]))
*sp++ = firstcode;
code = oldcode;
}
while (code >= clear_code && sp < &(stack[STACK_SIZE]))
{
if (code >= (1 << MAX_LZW_BITS))
{
gif_message (_("Invalid table entry"), _("Image is corrupt!"));
return -1;
}
*sp++ = table[1][code];
if (code == table[0][code])
{
gif_message (_("Circular table entry"), _("Image is corrupt!"));
return -1;
}
code = table[0][code];
}
if (sp < &(stack[STACK_SIZE]))
*sp++ = firstcode = table[1][code];
if ((code = max_code) < (1 << MAX_LZW_BITS))
{
table[0][code] = oldcode;
table[1][code] = firstcode;
++max_code;
if ((max_code >= max_code_size) &&
(max_code_size < (1 << MAX_LZW_BITS)))
{
max_code_size *= 2;
++code_size;
}
}
oldcode = incode;
if (sp > stack)
return (*--sp) & 255;
}
if (code < 0)
{
return code;
}
return code & 255;
}
static gboolean
ReadImage (FILE *fd,
GFile *file,
gint len,
gint height,
CMap cmap,
gint ncols,
gint format,
gint interlace,
gint number,
guint leftpos,
guint toppos,
guint screenwidth,
guint screenheight,
PikaImage **image,
GError **error)
{
static gint frame_number = 1;
PikaLayer *layer;
GeglBuffer *buffer;
guchar *dest, *temp;
guchar c;
gint xpos = 0, ypos = 0, pass = 0;
gint cur_progress, max_progress;
gint v;
gint i, j;
gchar *framename;
gchar *framename_ptr;
gboolean alpha_frame = FALSE;
static gint previous_disposal;
/* Guard against bogus frame size */
if (len < 1 || height < 1 ||
leftpos + len > screenwidth || toppos + height > screenheight)
{
if (frame_number == 1)
{
g_set_error (error, PIKA_PLUG_IN_ERROR, 0,
_("%s. %s"),
_("Invalid frame dimensions"), _("Image may be corrupt!"));
}
else
{
gif_message (_("Invalid frame dimensions"), _("Image may be corrupt!"));
}
return FALSE;
}
/*
** Initialize the Compression routines
*/
if (! ReadOK (fd, &c, 1))
{
read_error (_("image data"), *image, error);
return FALSE;
}
if (LZWReadByte (fd, TRUE, c) < 0)
{
read_error (_("compressed image data"), *image, error);
return FALSE;
}
if (frame_number == 1)
{
/* Guard against bogus logical screen size values */
if (screenwidth == 0)
{
g_printerr ("Invalid zero screenwidth changed to %d", len);
screenwidth = len;
}
if (screenheight == 0)
{
g_printerr ("Invalid zero screenheight changed to %d", height);
screenheight = height;
}
*image = pika_image_new (screenwidth, screenheight, PIKA_INDEXED);
for (i = 0, j = 0; i < ncols; i++)
{
used_cmap[0][i] = pika_cmap[j++] = cmap[0][i];
used_cmap[1][i] = pika_cmap[j++] = cmap[1][i];
used_cmap[2][i] = pika_cmap[j++] = cmap[2][i];
}
pika_image_set_colormap (*image, pika_cmap, ncols);
if (Gif89.delayTime < 0)
framename = g_strdup (_("Background"));
else
framename = g_strdup_printf (_("Background (%d%s)"),
10 * Gif89.delayTime, "ms");
previous_disposal = Gif89.disposal;
if (Gif89.transparent == -1)
{
layer = pika_layer_new (*image, framename,
len, height,
PIKA_INDEXED_IMAGE,
100,
pika_image_get_default_new_layer_mode (*image));
}
else
{
layer = pika_layer_new (*image, framename,
len, height,
PIKA_INDEXEDA_IMAGE,
100,
pika_image_get_default_new_layer_mode (*image));
alpha_frame=TRUE;
}
g_free (framename);
}
else /* NOT FIRST FRAME */
{
pika_progress_set_text_printf (_("Opening '%s' (frame %d)"),
pika_file_get_utf8_name (file),
frame_number);
pika_progress_pulse ();
/* If the colormap is now different, we have to promote to RGB! */
if (! promote_to_rgb)
{
for (i = 0; i < ncols; i++)
{
if ((used_cmap[0][i] != cmap[0][i]) ||
(used_cmap[1][i] != cmap[1][i]) ||
(used_cmap[2][i] != cmap[2][i]))
{
/* Everything is RGB(A) from now on... sigh. */
promote_to_rgb = TRUE;
/* Promote everything we have so far into RGB(A) */
#ifdef GIFDEBUG
g_print ("GIF: Promoting image to RGB...\n");
#endif
pika_image_convert_rgb (*image);
break;
}
}
}
if (Gif89.delayTime < 0)
framename = g_strdup_printf (_("Frame %d"), frame_number);
else
framename = g_strdup_printf (_("Frame %d (%d%s)"),
frame_number, 10 * Gif89.delayTime, "ms");
switch (previous_disposal)
{
case 0x00:
break; /* 'don't care' */
case 0x01:
framename_ptr = framename;
framename = g_strconcat (framename, " (combine)", NULL);
g_free (framename_ptr);
break;
case 0x02:
framename_ptr = framename;
framename = g_strconcat (framename, " (replace)", NULL);
g_free (framename_ptr);
break;
case 0x03: /* Rarely-used, and unhandled by many
loaders/players (including PIKA: we treat as
'combine' mode). */
framename_ptr = framename;
framename = g_strconcat (framename, " (combine) (!)", NULL);
g_free (framename_ptr);
break;
case 0x04: /* I've seen a composite of this type. stvo_online_banner2.gif */
case 0x05:
case 0x06: /* I've seen a composite of this type. bn31.Gif */
case 0x07:
framename_ptr = framename;
framename = g_strconcat (framename, " (unknown disposal)", NULL);
g_free (framename_ptr);
g_message (_("GIF: Undocumented GIF composite type %d is "
"not handled. Animation might not play or "
"re-save perfectly."),
previous_disposal);
break;
default:
g_message (_("Unknown composite type %d. %s"),
previous_disposal, _("Image may be corrupt!"));
break;
}
previous_disposal = Gif89.disposal;
layer = pika_layer_new (*image, framename,
len, height,
promote_to_rgb ?
PIKA_RGBA_IMAGE : PIKA_INDEXEDA_IMAGE,
100,
pika_image_get_default_new_layer_mode (*image));
alpha_frame = TRUE;
g_free (framename);
}
frame_number++;
pika_image_insert_layer (*image, layer, NULL, 0);
pika_item_transform_translate (PIKA_ITEM (layer), (gint) leftpos, (gint) toppos);
cur_progress = 0;
max_progress = height;
if (len > (G_MAXSIZE / height / (alpha_frame ? (promote_to_rgb ? 4 : 2) : 1)))
{
g_message ("'%s' has a larger image size than PIKA can handle.",
pika_file_get_utf8_name (file));
pika_image_delete (*image);
*image = NULL;
return FALSE;
}
#ifdef GIFDEBUG
g_print ("GIF: reading %d by %d%s GIF image, ncols=%d\n",
len, height, interlace ? " interlaced" : "", ncols);
#endif
if (! alpha_frame && promote_to_rgb)
{
/* I don't see how one would easily construct a GIF in which
this could happen, but it's a mad mad world. */
g_set_error (error, PIKA_PLUG_IN_ERROR, 0,
_("Can't handle non-alpha RGB frames.\n"
"Please file a bug report at "
"https://gitlab.gnome.org/GNOME/pika/issues"));
pika_image_delete (*image);
*image = NULL;
return FALSE;
}
if (alpha_frame)
dest = (guchar *) g_malloc ((gsize)len * (gsize)height * (promote_to_rgb ? 4 : 2));
else
dest = (guchar *) g_malloc ((gsize)len * (gsize)height);
while ((v = LZWReadByte (fd, FALSE, c)) >= 0)
{
if (alpha_frame)
{
if (promote_to_rgb)
{
temp = dest + ( (ypos * len) + xpos ) * 4;
*(temp ) = (guchar) cmap[0][v];
*(temp+1) = (guchar) cmap[1][v];
*(temp+2) = (guchar) cmap[2][v];
*(temp+3) = (guchar) ((v == Gif89.transparent) ? 0 : 255);
}
else
{
temp = dest + ( (ypos * len) + xpos ) * 2;
*temp = (guchar) v;
*(temp+1) = (guchar) ((v == Gif89.transparent) ? 0 : 255);
}
}
else
{
temp = dest + (ypos * len) + xpos;
*temp = (guchar) v;
}
xpos++;
if (xpos == len)
{
xpos = 0;
if (interlace)
{
switch (pass)
{
case 0:
case 1:
ypos += 8;
break;
case 2:
ypos += 4;
break;
case 3:
ypos += 2;
break;
}
if (ypos >= height)
{
pass++;
switch (pass)
{
case 1:
ypos = 4;
break;
case 2:
ypos = 2;
break;
case 3:
ypos = 1;
break;
default:
goto fini;
}
}
}
else
{
ypos++;
}
if (frame_number == 1)
{
cur_progress++;
if ((cur_progress % 16) == 0)
pika_progress_update ((gdouble) cur_progress /
(gdouble) max_progress);
}
}
if (ypos >= height)
break;
}
/* v can be < 0 here, indicating an error or encountering an end_code (-2).
* At this point we have already safely handled any corruption, so we might
* as well load any partial data we can instead of returning false.
*/
fini:
buffer = pika_drawable_get_buffer (PIKA_DRAWABLE (layer));
gegl_buffer_set (buffer, GEGL_RECTANGLE (0, 0, len, height), 0,
NULL, dest, GEGL_AUTO_ROWSTRIDE);
g_free (dest);
g_object_unref (buffer);
pika_progress_update (1.0);
{
gboolean first = TRUE;
/* Skip remaining compressed data if any. */
while (LZWReadByte (fd, FALSE, c) >= 0)
{
if (first)
{
g_message (_("Too much compressed data, ignoring extra..."));
first = FALSE;
}
}
}
return TRUE;
}