From 3c57dd931145d43f2b0aef96c4d178135956bf91 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Fri, 19 Apr 2024 05:13:10 +0200 Subject: Adding upstream version 2.10.36. Signed-off-by: Daniel Baumann --- plug-ins/common/file-xpm.c | 881 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 881 insertions(+) create mode 100644 plug-ins/common/file-xpm.c (limited to 'plug-ins/common/file-xpm.c') diff --git a/plug-ins/common/file-xpm.c b/plug-ins/common/file-xpm.c new file mode 100644 index 0000000..34c946e --- /dev/null +++ b/plug-ins/common/file-xpm.c @@ -0,0 +1,881 @@ +/* GIMP - The GNU Image Manipulation Program + * Copyright (C) 1995 Spencer Kimball and Peter Mattis + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +/* XPM plugin version 1.2.7 */ + +/* +1.2.7 fixes saving unused transparency (bug #4560) + +1.2.6 fixes crash when saving indexed images (bug #109567) + +1.2.5 only creates a "None" color entry if the image has alpha (bug #108034) + +1.2.4 displays an error message if saving fails (bug #87588) + +1.2.3 fixes bug when running in noninteractive mode +changes alpha_threshold range from [0, 1] to [0,255] for consistency with +the threshold_alpha plugin + +1.2.2 fixes bug that generated bad digits on images with more than 20000 +colors. (thanks, yanele) +parses gtkrc (thanks, yosh) +doesn't load parameter screen on images that don't have alpha + +1.2.1 fixes some minor bugs -- spaces in #XXXXXX strings, small typos in code. + +1.2 compute color indexes so that we don't have to use XpmSaveXImage* + +Previous...Inherited code from Ray Lehtiniemi, who inherited it from S & P. +*/ + +#include "config.h" + +#include + +#include + +#include /* For GDK_WINDOWING_WIN32 */ + +#ifndef GDK_WINDOWING_X11 +#ifndef XPM_NO_X +#define XPM_NO_X +#endif +#else +#include +#endif + +#include + +#include +#include + +#include "libgimp/stdplugins-intl.h" + + +static const gchar linenoise [] = +" .+@#$%&*=-;>,')!~{]^/(_:<[}|1234567890abcdefghijklmnopqrstuvwxyz\ +ABCDEFGHIJKLMNOPQRSTUVWXYZ`"; + +#define LOAD_PROC "file-xpm-load" +#define SAVE_PROC "file-xpm-save" +#define PLUG_IN_BINARY "file-xpm" +#define PLUG_IN_ROLE "gimp-file-xpm" +#define SCALE_WIDTH 125 + +/* Structs for the save dialog */ +typedef struct +{ + gint threshold; +} XpmSaveVals; + +typedef struct +{ + guchar r; + guchar g; + guchar b; +} rgbkey; + +/* whether the image is color or not. global so I only have to pass + * one user value to the GHFunc + */ +static gboolean color; + +/* bytes per pixel. global so I only have to pass one user value + * to the GHFunc + */ +static gint cpp; + +/* Declare local functions */ +static void query (void); +static void run (const gchar *name, + gint nparams, + const GimpParam *param, + gint *nreturn_vals, + GimpParam **return_vals); + +static gint32 load_image (const gchar *filename, + GError **error); +static guchar * parse_colors (XpmImage *xpm_image); +static void parse_image (gint32 image_ID, + XpmImage *xpm_image, + guchar *cmap); +static gboolean save_image (const gchar *filename, + gint32 image_ID, + gint32 drawable_ID, + GError **error); +static gboolean save_dialog (void); + + +const GimpPlugInInfo PLUG_IN_INFO = +{ + NULL, /* init_proc */ + NULL, /* quit_proc */ + query, /* query_proc */ + run, /* run_proc */ +}; + +static XpmSaveVals xpmvals = +{ + 127 /* alpha threshold */ +}; + + +MAIN () + +static void +query (void) +{ + static const GimpParamDef load_args[] = + { + { GIMP_PDB_INT32, "run-mode", "The run mode { RUN-INTERACTIVE (0), RUN-NONINTERACTIVE (1) }" }, + { GIMP_PDB_STRING, "filename", "The name of the file to load" }, + { GIMP_PDB_STRING, "raw-filename", "The name entered" } + }; + + static const GimpParamDef load_return_vals[] = + { + { GIMP_PDB_IMAGE, "image", "Output image" } + }; + + static const GimpParamDef save_args[] = + { + { GIMP_PDB_INT32, "run-mode", "The run mode { RUN-INTERACTIVE (0), RUN-NONINTERACTIVE (1) }" }, + { GIMP_PDB_IMAGE, "image", "Input image" }, + { GIMP_PDB_DRAWABLE, "drawable", "Drawable to export" }, + { GIMP_PDB_STRING, "filename", "The name of the file to export the image in" }, + { GIMP_PDB_STRING, "raw-filename", "The name of the file to export the image in" }, + { GIMP_PDB_INT32, "threshold", "Alpha threshold (0-255)" } + }; + + gimp_install_procedure (LOAD_PROC, + "Load files in XPM (X11 Pixmap) format.", + "Load files in XPM (X11 Pixmap) format. " + "XPM is a portable image format designed to be " + "included in C source code. XLib provides utility " + "functions to read this format. Newer code should " + "however be using gdk-pixbuf-csource instead. " + "XPM supports colored images, unlike the XBM " + "format which XPM was designed to replace.", + "Spencer Kimball & Peter Mattis & Ray Lehtiniemi", + "Spencer Kimball & Peter Mattis", + "1997", + N_("X PixMap image"), + NULL, + GIMP_PLUGIN, + G_N_ELEMENTS (load_args), + G_N_ELEMENTS (load_return_vals), + load_args, load_return_vals); + + gimp_register_file_handler_mime (LOAD_PROC, "image/x-xpixmap"); + gimp_register_magic_load_handler (LOAD_PROC, + "xpm", + "", + "0, string,/*\\040XPM\\040*/"); + + gimp_install_procedure (SAVE_PROC, + "Export files in XPM (X11 Pixmap) format.", + "Export files in XPM (X11 Pixmap) format. " + "XPM is a portable image format designed to be " + "included in C source code. XLib provides utility " + "functions to read this format. Newer code should " + "however be using gdk-pixbuf-csource instead. " + "XPM supports colored images, unlike the XBM " + "format which XPM was designed to replace.", + "Spencer Kimball & Peter Mattis & Ray Lehtiniemi & Nathan Summers", + "Spencer Kimball & Peter Mattis", + "1997", + N_("X PixMap image"), + "RGB*, GRAY*, INDEXED*", + GIMP_PLUGIN, + G_N_ELEMENTS (save_args), 0, + save_args, NULL); + + gimp_register_file_handler_mime (SAVE_PROC, "image/x-xpixmap"); + gimp_register_save_handler (SAVE_PROC, "xpm", ""); +} + +static void +run (const gchar *name, + gint nparams, + const GimpParam *param, + gint *nreturn_vals, + GimpParam **return_vals) +{ + static GimpParam values[2]; + GimpRunMode run_mode; + GimpPDBStatusType status = GIMP_PDB_SUCCESS; + gint32 image_ID; + gint32 drawable_ID; + GimpExportReturn export = GIMP_EXPORT_CANCEL; + GError *error = NULL; + + INIT_I18N (); + gegl_init (NULL, NULL); + + run_mode = param[0].data.d_int32; + + *nreturn_vals = 1; + *return_vals = values; + + values[0].type = GIMP_PDB_STATUS; + values[0].data.d_status = GIMP_PDB_EXECUTION_ERROR; + + if (strcmp (name, LOAD_PROC) == 0) + { + image_ID = load_image (param[1].data.d_string, &error); + + if (image_ID != -1) + { + *nreturn_vals = 2; + values[1].type = GIMP_PDB_IMAGE; + values[1].data.d_image = image_ID; + } + else + { + status = GIMP_PDB_EXECUTION_ERROR; + } + } + else if (strcmp (name, SAVE_PROC) == 0) + { + gimp_ui_init (PLUG_IN_BINARY, FALSE); + + image_ID = param[1].data.d_int32; + drawable_ID = param[2].data.d_int32; + + /* eventually export the image */ + switch (run_mode) + { + case GIMP_RUN_INTERACTIVE: + case GIMP_RUN_WITH_LAST_VALS: + export = gimp_export_image (&image_ID, &drawable_ID, "XPM", + GIMP_EXPORT_CAN_HANDLE_RGB | + GIMP_EXPORT_CAN_HANDLE_GRAY | + GIMP_EXPORT_CAN_HANDLE_INDEXED | + GIMP_EXPORT_CAN_HANDLE_ALPHA); + + if (export == GIMP_EXPORT_CANCEL) + { + values[0].data.d_status = GIMP_PDB_CANCEL; + return; + } + break; + default: + break; + } + + switch (run_mode) + { + case GIMP_RUN_INTERACTIVE: + /* Possibly retrieve data */ + gimp_get_data ("file_xpm_save", &xpmvals); + + /* First acquire information with a dialog */ + if (gimp_drawable_has_alpha (drawable_ID)) + if (! save_dialog ()) + status = GIMP_PDB_CANCEL; + break; + + case GIMP_RUN_NONINTERACTIVE: + /* Make sure all the arguments are there! */ + if (nparams != 6) + { + status = GIMP_PDB_CALLING_ERROR; + } + else + { + xpmvals.threshold = param[5].data.d_int32; + + if (xpmvals.threshold < 0 || + xpmvals.threshold > 255) + status = GIMP_PDB_CALLING_ERROR; + } + break; + + case GIMP_RUN_WITH_LAST_VALS: + /* Possibly retrieve data */ + gimp_get_data ("file_xpm_save", &xpmvals); + break; + + default: + break; + } + + if (status == GIMP_PDB_SUCCESS) + { + if (save_image (param[3].data.d_string, + image_ID, drawable_ID, &error)) + { + gimp_set_data ("file_xpm_save", &xpmvals, sizeof (XpmSaveVals)); + } + else + { + status = GIMP_PDB_EXECUTION_ERROR; + } + } + + if (export == GIMP_EXPORT_EXPORT) + gimp_image_delete (image_ID); + } + else + { + status = GIMP_PDB_CALLING_ERROR; + } + + if (status != GIMP_PDB_SUCCESS && error) + { + *nreturn_vals = 2; + values[1].type = GIMP_PDB_STRING; + values[1].data.d_string = error->message; + } + + values[0].data.d_status = status; +} + +static gint32 +load_image (const gchar *filename, + GError **error) +{ + XpmImage xpm_image; + guchar *cmap; + gint32 image_ID; + + gimp_progress_init_printf (_("Opening '%s'"), + gimp_filename_to_utf8 (filename)); + + /* read the raw file */ + switch (XpmReadFileToXpmImage ((char *) filename, &xpm_image, NULL)) + { + case XpmSuccess: + break; + + case XpmOpenFailed: + g_set_error (error, G_FILE_ERROR, G_FILE_ERROR_FAILED, + _("Error opening file '%s'"), + gimp_filename_to_utf8 (filename)); + return -1; + + case XpmFileInvalid: + g_set_error (error, G_FILE_ERROR, G_FILE_ERROR_FAILED, + "%s", _("XPM file invalid")); + return -1; + + default: + return -1; + } + + /* parse out the colors into a cmap */ + cmap = parse_colors (&xpm_image); + + /* create the new image */ + image_ID = gimp_image_new (xpm_image.width, + xpm_image.height, + GIMP_RGB); + + /* name it */ + gimp_image_set_filename (image_ID, filename); + + /* fill it */ + parse_image (image_ID, &xpm_image, cmap); + + /* clean up and exit */ + g_free (cmap); + + return image_ID; +} + +static guchar * +parse_colors (XpmImage *xpm_image) +{ +#ifndef XPM_NO_X + Display *display; + Colormap colormap; +#endif + gint i, j; + guchar *cmap; + +#ifndef XPM_NO_X + /* open the display and get the default color map */ + display = XOpenDisplay (NULL); + if (display == NULL) + g_printerr ("Could not open display\n"); + + colormap = DefaultColormap (display, DefaultScreen (display)); +#endif + + /* alloc a buffer to hold the parsed colors */ + cmap = g_new0 (guchar, 4 * xpm_image->ncolors); + + /* parse each color in the file */ + for (i = 0, j = 0; i < xpm_image->ncolors; i++) + { + gchar *colorspec = "None"; + XpmColor *xpm_color; +#ifndef XPM_NO_X + XColor xcolor; +#else + GdkColor xcolor; +#endif + + xpm_color = &(xpm_image->colorTable[i]); + + /* pick the best spec available */ + if (xpm_color->c_color) + colorspec = xpm_color->c_color; + else if (xpm_color->g_color) + colorspec = xpm_color->g_color; + else if (xpm_color->g4_color) + colorspec = xpm_color->g4_color; + else if (xpm_color->m_color) + colorspec = xpm_color->m_color; + + /* parse if it's not transparent */ + if (strcmp (colorspec, "None") != 0) + { +#ifndef XPM_NO_X + XParseColor (display, colormap, colorspec, &xcolor); +#else + gdk_color_parse (colorspec, &xcolor); +#endif + cmap[j++] = xcolor.red >> 8; + cmap[j++] = xcolor.green >> 8; + cmap[j++] = xcolor.blue >> 8; + cmap[j++] = ~0; + } + else + { + j += 4; + } + } +#ifndef XPM_NO_X + XCloseDisplay (display); +#endif + return cmap; +} + +static void +parse_image (gint32 image_ID, + XpmImage *xpm_image, + guchar *cmap) +{ + GeglBuffer *buffer; + gint tile_height; + gint scanlines; + gint val; + guchar *buf; + guchar *dest; + guint *src; + gint32 layer_ID; + gint i; + + layer_ID = gimp_layer_new (image_ID, + _("Color"), + xpm_image->width, + xpm_image->height, + GIMP_RGBA_IMAGE, + 100, + gimp_image_get_default_new_layer_mode (image_ID)); + + gimp_image_insert_layer (image_ID, layer_ID, -1, 0); + + buffer = gimp_drawable_get_buffer (layer_ID); + + tile_height = gimp_tile_height (); + + buf = g_new (guchar, tile_height * xpm_image->width * 4); + + src = xpm_image->data; + for (i = 0; i < xpm_image->height; i += tile_height) + { + gint j; + + dest = buf; + scanlines = MIN (tile_height, xpm_image->height - i); + j = scanlines * xpm_image->width; + while (j--) + { + { + val = *(src++) * 4; + *(dest) = cmap[val]; + *(dest+1) = cmap[val+1]; + *(dest+2) = cmap[val+2]; + *(dest+3) = cmap[val+3]; + dest += 4; + } + + if ((j % 100) == 0) + gimp_progress_update ((double) i / (double) xpm_image->height); + } + + gegl_buffer_set (buffer, + GEGL_RECTANGLE (0, i, xpm_image->width, scanlines), 0, + NULL, buf, GEGL_AUTO_ROWSTRIDE); + } + + g_free (buf); + g_object_unref (buffer); + + gimp_progress_update (1.0); +} + +static guint +rgbhash (rgbkey *c) +{ + return ((guint)c->r) ^ ((guint)c->g) ^ ((guint)c->b); +} + +static guint +compare (rgbkey *c1, + rgbkey *c2) +{ + return (c1->r == c2->r) && (c1->g == c2->g) && (c1->b == c2->b); +} + +static void +set_XpmImage (XpmColor *array, + guint index, + gchar *colorstring) +{ + gchar *p; + gint i, charnum, indtemp; + + indtemp=index; + array[index].string = p = g_new (gchar, cpp+1); + + /*convert the index number to base sizeof(linenoise)-1 */ + for (i=0; ir, (int)key->g, (int)key->b); + set_XpmImage (user_data, *((int *) value), string); +} + +static void +decrement_hash_values (gpointer gkey, + gpointer value, + gpointer user_data) +{ + --(*((guint*) value)); +} + +static gboolean +save_image (const gchar *filename, + gint32 image_ID, + gint32 drawable_ID, + GError **error) +{ + GeglBuffer *buffer; + const Babl *format; + gint width; + gint height; + gint ncolors = 1; + gint *indexno; + gboolean indexed; + gboolean alpha; + gboolean alpha_used = FALSE; + XpmColor *colormap; + XpmImage *image; + guint *ibuff = NULL; + guchar *buf; + guchar *data; + GHashTable *hash = NULL; + gint i, j, k; + gint threshold = xpmvals.threshold; + gboolean success = FALSE; + + buffer = gimp_drawable_get_buffer (drawable_ID); + + width = gegl_buffer_get_width (buffer); + height = gegl_buffer_get_height (buffer); + + alpha = gimp_drawable_has_alpha (drawable_ID); + color = !gimp_drawable_is_gray (drawable_ID); + indexed = gimp_drawable_is_indexed (drawable_ID); + + switch (gimp_drawable_type (drawable_ID)) + { + case GIMP_RGB_IMAGE: + format = babl_format ("R'G'B' u8"); + break; + + case GIMP_RGBA_IMAGE: + format = babl_format ("R'G'B'A u8"); + break; + + case GIMP_GRAY_IMAGE: + format = babl_format ("Y' u8"); + break; + + case GIMP_GRAYA_IMAGE: + format = babl_format ("Y'A u8"); + break; + + case GIMP_INDEXED_IMAGE: + case GIMP_INDEXEDA_IMAGE: + format = gegl_buffer_get_format (buffer); + break; + + default: + g_set_error (error, G_FILE_ERROR, G_FILE_ERROR_FAILED, + _("Unsupported drawable type")); + g_object_unref (buffer); + return FALSE; + } + + /* allocate buffer making the assumption that ibuff is 32 bit aligned... */ + ibuff = g_new (guint, width * height); + + hash = g_hash_table_new ((GHashFunc) rgbhash, (GCompareFunc) compare); + + gimp_progress_init_printf (_("Exporting '%s'"), + gimp_filename_to_utf8 (filename)); + + ncolors = alpha ? 1 : 0; + + /* allocate a pixel region to work with */ + buf = g_new (guchar, + gimp_tile_height () * width * + babl_format_get_bytes_per_pixel (format)); + + /* process each row of tiles */ + for (i = 0; i < height; i += gimp_tile_height ()) + { + gint scanlines; + + /* read the next row of tiles */ + scanlines = MIN (gimp_tile_height(), height - i); + + gegl_buffer_get (buffer, GEGL_RECTANGLE (0, i, width, scanlines), 1.0, + format, buf, + GEGL_AUTO_ROWSTRIDE, GEGL_ABYSS_NONE); + + data = buf; + + /* process each pixel row */ + for (j = 0; j < scanlines; j++) + { + /* go to the start of this row in each image */ + guint *idata = ibuff + (i+j) * width; + + /* do each pixel in the row */ + for (k = 0; k < width; k++) + { + rgbkey *key = g_new (rgbkey, 1); + guchar a; + + /* get pixel data */ + key->r = *(data++); + key->g = color && !indexed ? *(data++) : key->r; + key->b = color && !indexed ? *(data++) : key->r; + a = alpha ? *(data++) : 255; + + if (a < threshold) + { + *(idata++) = 0; + alpha_used = TRUE; + } + else + { + if (indexed) + { + *(idata++) = (key->r) + (alpha ? 1 : 0); + } + else + { + indexno = g_hash_table_lookup (hash, key); + if (!indexno) + { + indexno = g_new (gint, 1); + *indexno = ncolors++; + g_hash_table_insert (hash, key, indexno); + key = g_new (rgbkey, 1); + } + *(idata++) = *indexno; + } + } + } + + /* kick the progress bar */ + gimp_progress_update ((gdouble) (i+j) / (gdouble) height); + } + } + + g_free (buf); + + /* remove alpha if not actually used */ + if (alpha && !alpha_used) + { + gint i; + --ncolors; + for (i = 0; i < width * height; ++i) + --ibuff[i]; + + g_hash_table_foreach (hash, decrement_hash_values, NULL); + } + + if (indexed) + { + guchar *cmap = gimp_image_get_colormap (image_ID, &ncolors); + guchar *c; + + c = cmap; + + if (alpha_used) + ncolors++; + + colormap = g_new (XpmColor, ncolors); + cpp = + 1 + (gdouble) log (ncolors) / (gdouble) log (sizeof (linenoise) - 1.0); + + if (alpha_used) + set_XpmImage (colormap, 0, "None"); + + for (i = alpha_used ? 1 : 0; i < ncolors; i++) + { + gchar *string; + guchar r, g, b; + + r = *c++; + g = *c++; + b = *c++; + + string = g_new (gchar, 8); + sprintf (string, "#%02X%02X%02X", (int)r, (int)g, (int)b); + set_XpmImage (colormap, i, string); + } + + g_free (cmap); + } + else + { + colormap = g_new (XpmColor, ncolors); + cpp = + 1 + (gdouble) log (ncolors) / (gdouble) log (sizeof (linenoise) - 1.0); + + if (alpha_used) + set_XpmImage (colormap, 0, "None"); + + g_hash_table_foreach (hash, create_colormap_from_hash, colormap); + } + + image = g_new (XpmImage, 1); + + image->width = width; + image->height = height; + image->ncolors = ncolors; + image->cpp = cpp; + image->colorTable = colormap; + image->data = ibuff; + + /* do the save */ + switch (XpmWriteFileFromXpmImage ((char *) filename, image, NULL)) + { + case XpmSuccess: + success = TRUE; + break; + + case XpmOpenFailed: + g_set_error (error, G_FILE_ERROR, G_FILE_ERROR_FAILED, + _("Error opening file '%s'"), + gimp_filename_to_utf8 (filename)); + break; + + case XpmFileInvalid: + g_set_error (error, G_FILE_ERROR, G_FILE_ERROR_FAILED, + "%s", _("XPM file invalid")); + break; + + default: + break; + } + + g_object_unref (buffer); + g_free (ibuff); + + if (hash) + g_hash_table_destroy (hash); + + gimp_progress_update (1.0); + + return success; +} + +static gboolean +save_dialog (void) +{ + GtkWidget *dialog; + GtkWidget *table; + GtkObject *scale_data; + gboolean run; + + dialog = gimp_export_dialog_new (_("XPM"), PLUG_IN_BINARY, SAVE_PROC); + + table = gtk_table_new (1, 3, FALSE); + gtk_table_set_col_spacings (GTK_TABLE (table), 6); + gtk_container_set_border_width (GTK_CONTAINER (table), 12); + gtk_box_pack_start (GTK_BOX (gimp_export_dialog_get_content_area (dialog)), + table, TRUE, TRUE, 0); + gtk_widget_show (table); + + scale_data = gimp_scale_entry_new (GTK_TABLE (table), 0, 0, + _("_Alpha threshold:"), SCALE_WIDTH, 0, + xpmvals.threshold, 0, 255, 1, 8, 0, + TRUE, 0, 0, + NULL, NULL); + + g_signal_connect (scale_data, "value-changed", + G_CALLBACK (gimp_int_adjustment_update), + &xpmvals.threshold); + + gtk_widget_show (dialog); + + run = (gimp_dialog_run (GIMP_DIALOG (dialog)) == GTK_RESPONSE_OK); + + gtk_widget_destroy (dialog); + + return run; +} -- cgit v1.2.3