(thumbs-thumbname): The resulting thubname includes a hash value to improve its
[emacs.git] / src / image.c
blob15e835fef3badfb66864d8ab105ea4eced2d8451
1 /* Functions for image support on window system.
2 Copyright (C) 1989, 92, 93, 94, 95, 96, 97, 98, 99, 2000,01,02,03,04
3 Free Software Foundation.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 #include <config.h>
23 #include <stdio.h>
24 #include <math.h>
25 #include <ctype.h>
27 #ifdef HAVE_UNISTD_H
28 #include <unistd.h>
29 #endif
31 /* This makes the fields of a Display accessible, in Xlib header files. */
33 #define XLIB_ILLEGAL_ACCESS
35 #include "lisp.h"
36 #include "frame.h"
37 #include "window.h"
38 #include "dispextern.h"
39 #include "blockinput.h"
40 #include "systime.h"
41 #include <epaths.h>
44 #ifdef HAVE_X_WINDOWS
45 #include "xterm.h"
46 #include <sys/types.h>
47 #include <sys/stat.h>
49 #define COLOR_TABLE_SUPPORT 1
51 typedef struct x_bitmap_record Bitmap_Record;
52 #define GET_PIXEL(ximg, x, y) XGetPixel(ximg, x, y)
53 #define NO_PIXMAP None
55 #define RGB_PIXEL_COLOR unsigned long
57 #define PIX_MASK_RETAIN(f) 0
58 #define PIX_MASK_DRAW(f) 1
59 #endif /* HAVE_X_WINDOWS */
62 #ifdef HAVE_NTGUI
63 #include "w32term.h"
65 /* W32_TODO : Color tables on W32. */
66 #undef COLOR_TABLE_SUPPORT
68 typedef struct w32_bitmap_record Bitmap_Record;
69 #define GET_PIXEL(ximg, x, y) GetPixel(ximg, x, y)
70 #define NO_PIXMAP 0
72 #define RGB_PIXEL_COLOR COLORREF
74 #define PIX_MASK_RETAIN(f) 0
75 #define PIX_MASK_DRAW(f) 1
77 #define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
78 #define x_defined_color w32_defined_color
79 #define DefaultDepthOfScreen(screen) (one_w32_display_info.n_cbits)
80 #endif /* HAVE_NTGUI */
83 #ifdef MAC_OS
84 #include "macterm.h"
85 #include <sys/stat.h>
86 #ifndef MAC_OSX
87 #include <alloca.h>
88 #include <sys/param.h>
89 #endif
90 #if TARGET_API_MAC_CARBON
91 #ifdef MAC_OSX
92 #include <QuickTime/QuickTime.h>
93 #else /* not MAC_OSX */
94 #include <QuickTime.h>
95 #endif /* not MAC_OSX */
96 #else /* not TARGET_API_MAC_CARBON */
97 #include <Windows.h>
98 #include <Gestalt.h>
99 #include <TextUtils.h>
100 #include <ImageCompression.h>
101 #include <QuickTimeComponents.h>
102 #endif /* not TARGET_API_MAC_CARBON */
104 /* MAC_TODO : Color tables on Mac. */
105 #undef COLOR_TABLE_SUPPORT
107 #define ZPixmap 0 /* arbitrary */
108 typedef struct mac_bitmap_record Bitmap_Record;
110 #define GET_PIXEL(ximg, x, y) XGetPixel(ximg, x, y)
111 #define NO_PIXMAP 0
113 #define RGB_PIXEL_COLOR unsigned long
115 #define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
116 #define x_defined_color mac_defined_color
117 #define DefaultDepthOfScreen(screen) (one_mac_display_info.n_planes)
118 #define XDrawLine(display, w, gc, x1, y1, x2, y2) \
119 mac_draw_line_to_pixmap(display, w, gc, x1, y1, x2, y2)
121 #endif /* MAC_OS */
124 /* Search path for bitmap files. */
126 Lisp_Object Vx_bitmap_file_path;
129 static void x_disable_image P_ ((struct frame *, struct image *));
130 static void x_edge_detection P_ ((struct frame *, struct image *, Lisp_Object,
131 Lisp_Object));
133 static void init_color_table P_ ((void));
134 static unsigned long lookup_rgb_color P_ ((struct frame *f, int r, int g, int b));
135 #ifdef COLOR_TABLE_SUPPORT
136 static void free_color_table P_ ((void));
137 static unsigned long *colors_in_color_table P_ ((int *n));
138 static unsigned long lookup_pixel_color P_ ((struct frame *f, unsigned long p));
139 #endif
141 /* Code to deal with bitmaps. Bitmaps are referenced by their bitmap
142 id, which is just an int that this section returns. Bitmaps are
143 reference counted so they can be shared among frames.
145 Bitmap indices are guaranteed to be > 0, so a negative number can
146 be used to indicate no bitmap.
148 If you use x_create_bitmap_from_data, then you must keep track of
149 the bitmaps yourself. That is, creating a bitmap from the same
150 data more than once will not be caught. */
152 #ifdef MAC_OS
154 static XImagePtr
155 XGetImage (display, pixmap, x, y, width, height, plane_mask, format)
156 Display *display; /* not used */
157 Pixmap pixmap;
158 int x, y; /* not used */
159 unsigned int width, height; /* not used */
160 unsigned long plane_mask; /* not used */
161 int format; /* not used */
163 #if GLYPH_DEBUG
164 xassert (x == 0 && y == 0);
166 Rect ri, rp;
167 SetRect (&ri, 0, 0, width, height);
168 xassert (EqualRect (&ri, GetPixBounds (GetGWorldPixMap (pixmap), &rp)));
170 xassert (! (pixelsLocked & GetPixelsState (GetGWorldPixMap (pixmap))));
171 #endif
173 LockPixels (GetGWorldPixMap (pixmap));
175 return pixmap;
178 static void
179 XPutPixel (ximage, x, y, pixel)
180 XImagePtr ximage;
181 int x, y;
182 unsigned long pixel;
184 CGrafPtr old_port;
185 GDHandle old_gdh;
186 RGBColor color;
188 GetGWorld (&old_port, &old_gdh);
189 SetGWorld (ximage, NULL);
191 color.red = RED16_FROM_ULONG (pixel);
192 color.green = GREEN16_FROM_ULONG (pixel);
193 color.blue = BLUE16_FROM_ULONG (pixel);
194 SetCPixel (x, y, &color);
196 SetGWorld (old_port, old_gdh);
199 static unsigned long
200 XGetPixel (ximage, x, y)
201 XImagePtr ximage;
202 int x, y;
204 CGrafPtr old_port;
205 GDHandle old_gdh;
206 RGBColor color;
208 GetGWorld (&old_port, &old_gdh);
209 SetGWorld (ximage, NULL);
211 GetCPixel (x, y, &color);
213 SetGWorld (old_port, old_gdh);
214 return RGB_TO_ULONG (color.red >> 8, color.green >> 8, color.blue >> 8);
217 static void
218 XDestroyImage (ximg)
219 XImagePtr ximg;
221 UnlockPixels (GetGWorldPixMap (ximg));
223 #endif /* MAC_OS */
226 /* Functions to access the contents of a bitmap, given an id. */
229 x_bitmap_height (f, id)
230 FRAME_PTR f;
231 int id;
233 return FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].height;
237 x_bitmap_width (f, id)
238 FRAME_PTR f;
239 int id;
241 return FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].width;
244 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI)
246 x_bitmap_pixmap (f, id)
247 FRAME_PTR f;
248 int id;
250 return (int) FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].pixmap;
252 #endif
254 #ifdef HAVE_X_WINDOWS
256 x_bitmap_mask (f, id)
257 FRAME_PTR f;
258 int id;
260 return FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].mask;
262 #endif
264 /* Allocate a new bitmap record. Returns index of new record. */
266 static int
267 x_allocate_bitmap_record (f)
268 FRAME_PTR f;
270 Display_Info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
271 int i;
273 if (dpyinfo->bitmaps == NULL)
275 dpyinfo->bitmaps_size = 10;
276 dpyinfo->bitmaps
277 = (Bitmap_Record *) xmalloc (dpyinfo->bitmaps_size * sizeof (Bitmap_Record));
278 dpyinfo->bitmaps_last = 1;
279 return 1;
282 if (dpyinfo->bitmaps_last < dpyinfo->bitmaps_size)
283 return ++dpyinfo->bitmaps_last;
285 for (i = 0; i < dpyinfo->bitmaps_size; ++i)
286 if (dpyinfo->bitmaps[i].refcount == 0)
287 return i + 1;
289 dpyinfo->bitmaps_size *= 2;
290 dpyinfo->bitmaps
291 = (Bitmap_Record *) xrealloc (dpyinfo->bitmaps,
292 dpyinfo->bitmaps_size * sizeof (Bitmap_Record));
293 return ++dpyinfo->bitmaps_last;
296 /* Add one reference to the reference count of the bitmap with id ID. */
298 void
299 x_reference_bitmap (f, id)
300 FRAME_PTR f;
301 int id;
303 ++FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].refcount;
306 /* Create a bitmap for frame F from a HEIGHT x WIDTH array of bits at BITS. */
309 x_create_bitmap_from_data (f, bits, width, height)
310 struct frame *f;
311 char *bits;
312 unsigned int width, height;
314 Display_Info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
315 int id;
317 #ifdef HAVE_X_WINDOWS
318 Pixmap bitmap;
319 bitmap = XCreateBitmapFromData (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
320 bits, width, height);
321 if (! bitmap)
322 return -1;
323 #endif /* HAVE_X_WINDOWS */
325 #ifdef HAVE_NTGUI
326 Pixmap bitmap;
327 bitmap = CreateBitmap (width, height,
328 FRAME_X_DISPLAY_INFO (XFRAME (frame))->n_planes,
329 FRAME_X_DISPLAY_INFO (XFRAME (frame))->n_cbits,
330 bits);
331 if (! bitmap)
332 return -1;
333 #endif /* HAVE_NTGUI */
335 #ifdef MAC_OS
336 /* MAC_TODO: for now fail if width is not mod 16 (toolbox requires it) */
337 if (width % 16 != 0)
338 return -1;
339 #endif
341 id = x_allocate_bitmap_record (f);
342 #ifdef MAC_OS
343 dpyinfo->bitmaps[id - 1].bitmap_data = (char *) xmalloc (height * width);
344 if (! dpyinfo->bitmaps[id - 1].bitmap_data)
345 return -1;
346 bcopy (bits, dpyinfo->bitmaps[id - 1].bitmap_data, height * width);
347 #endif /* MAC_OS */
349 dpyinfo->bitmaps[id - 1].file = NULL;
350 dpyinfo->bitmaps[id - 1].height = height;
351 dpyinfo->bitmaps[id - 1].width = width;
352 dpyinfo->bitmaps[id - 1].refcount = 1;
354 #ifdef HAVE_X_WINDOWS
355 dpyinfo->bitmaps[id - 1].pixmap = bitmap;
356 dpyinfo->bitmaps[id - 1].have_mask = 0;
357 dpyinfo->bitmaps[id - 1].depth = 1;
358 #endif /* HAVE_X_WINDOWS */
360 #ifdef HAVE_NTGUI
361 dpyinfo->bitmaps[id - 1].pixmap = bitmap;
362 dpyinfo->bitmaps[id - 1].hinst = NULL;
363 dpyinfo->bitmaps[id - 1].depth = 1;
364 #endif /* HAVE_NTGUI */
366 return id;
369 /* Create bitmap from file FILE for frame F. */
372 x_create_bitmap_from_file (f, file)
373 struct frame *f;
374 Lisp_Object file;
376 #ifdef MAC_OS
377 return -1; /* MAC_TODO : bitmap support */
378 #endif /* MAC_OS */
380 #ifdef HAVE_NTGUI
381 return -1; /* W32_TODO : bitmap support */
382 #endif /* HAVE_NTGUI */
384 #ifdef HAVE_X_WINDOWS
385 Display_Info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
386 unsigned int width, height;
387 Pixmap bitmap;
388 int xhot, yhot, result, id;
389 Lisp_Object found;
390 int fd;
391 char *filename;
393 /* Look for an existing bitmap with the same name. */
394 for (id = 0; id < dpyinfo->bitmaps_last; ++id)
396 if (dpyinfo->bitmaps[id].refcount
397 && dpyinfo->bitmaps[id].file
398 && !strcmp (dpyinfo->bitmaps[id].file, (char *) SDATA (file)))
400 ++dpyinfo->bitmaps[id].refcount;
401 return id + 1;
405 /* Search bitmap-file-path for the file, if appropriate. */
406 fd = openp (Vx_bitmap_file_path, file, Qnil, &found, Qnil);
407 if (fd < 0)
408 return -1;
409 emacs_close (fd);
411 filename = (char *) SDATA (found);
413 result = XReadBitmapFile (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
414 filename, &width, &height, &bitmap, &xhot, &yhot);
415 if (result != BitmapSuccess)
416 return -1;
418 id = x_allocate_bitmap_record (f);
419 dpyinfo->bitmaps[id - 1].pixmap = bitmap;
420 dpyinfo->bitmaps[id - 1].have_mask = 0;
421 dpyinfo->bitmaps[id - 1].refcount = 1;
422 dpyinfo->bitmaps[id - 1].file = (char *) xmalloc (SBYTES (file) + 1);
423 dpyinfo->bitmaps[id - 1].depth = 1;
424 dpyinfo->bitmaps[id - 1].height = height;
425 dpyinfo->bitmaps[id - 1].width = width;
426 strcpy (dpyinfo->bitmaps[id - 1].file, SDATA (file));
428 return id;
429 #endif /* HAVE_X_WINDOWS */
432 /* Free bitmap B. */
434 static void
435 Free_Bitmap_Record (dpyinfo, bm)
436 Display_Info *dpyinfo;
437 Bitmap_Record *bm;
439 #ifdef HAVE_X_WINDOWS
440 XFreePixmap (dpyinfo->display, bm->pixmap);
441 if (bm->have_mask)
442 XFreePixmap (dpyinfo->display, bm->mask);
443 #endif /* HAVE_X_WINDOWS */
445 #ifdef HAVE_NTGUI
446 DeleteObject (bm->pixmap);
447 #endif /* HAVE_NTGUI */
449 #ifdef MAC_OS
450 xfree (bm->bitmap_data); /* Added ++kfs */
451 bm->bitmap_data = NULL;
452 #endif /* MAC_OS */
454 if (bm->file)
456 xfree (bm->file);
457 bm->file = NULL;
461 /* Remove reference to bitmap with id number ID. */
463 void
464 x_destroy_bitmap (f, id)
465 FRAME_PTR f;
466 int id;
468 Display_Info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
470 if (id > 0)
472 Bitmap_Record *bm = &dpyinfo->bitmaps[id - 1];
474 if (--bm->refcount == 0)
476 BLOCK_INPUT;
477 Free_Bitmap_Record (dpyinfo, bm);
478 UNBLOCK_INPUT;
483 /* Free all the bitmaps for the display specified by DPYINFO. */
485 void
486 x_destroy_all_bitmaps (dpyinfo)
487 Display_Info *dpyinfo;
489 int i;
490 Bitmap_Record *bm = dpyinfo->bitmaps;
492 for (i = 0; i < dpyinfo->bitmaps_last; i++, bm++)
493 if (bm->refcount > 0)
494 Free_Bitmap_Record (dpyinfo, bm);
496 dpyinfo->bitmaps_last = 0;
500 #ifdef HAVE_X_WINDOWS
502 /* Useful functions defined in the section
503 `Image type independent image structures' below. */
505 static unsigned long four_corners_best P_ ((XImagePtr ximg, unsigned long width,
506 unsigned long height));
508 static int x_create_x_image_and_pixmap P_ ((struct frame *f, int width, int height,
509 int depth, XImagePtr *ximg,
510 Pixmap *pixmap));
512 static void x_destroy_x_image P_ ((XImagePtr ximg));
515 /* Create a mask of a bitmap. Note is this not a perfect mask.
516 It's nicer with some borders in this context */
519 x_create_bitmap_mask (f, id)
520 struct frame *f;
521 int id;
523 Pixmap pixmap, mask;
524 XImagePtr ximg, mask_img;
525 unsigned long width, height;
526 int result;
527 unsigned long bg;
528 unsigned long x, y, xp, xm, yp, ym;
529 GC gc;
531 Display_Info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
533 if (!(id > 0))
534 return -1;
536 pixmap = x_bitmap_pixmap (f, id);
537 width = x_bitmap_width (f, id);
538 height = x_bitmap_height (f, id);
540 BLOCK_INPUT;
541 ximg = XGetImage (FRAME_X_DISPLAY (f), pixmap, 0, 0, width, height,
542 ~0, ZPixmap);
544 if (!ximg)
546 UNBLOCK_INPUT;
547 return -1;
550 result = x_create_x_image_and_pixmap (f, width, height, 1, &mask_img, &mask);
552 UNBLOCK_INPUT;
553 if (!result)
555 XDestroyImage (ximg);
556 return -1;
559 bg = four_corners_best (ximg, width, height);
561 for (y = 0; y < ximg->height; ++y)
563 for (x = 0; x < ximg->width; ++x)
565 xp = x != ximg->width - 1 ? x + 1 : 0;
566 xm = x != 0 ? x - 1 : ximg->width - 1;
567 yp = y != ximg->height - 1 ? y + 1 : 0;
568 ym = y != 0 ? y - 1 : ximg->height - 1;
569 if (XGetPixel (ximg, x, y) == bg
570 && XGetPixel (ximg, x, yp) == bg
571 && XGetPixel (ximg, x, ym) == bg
572 && XGetPixel (ximg, xp, y) == bg
573 && XGetPixel (ximg, xp, yp) == bg
574 && XGetPixel (ximg, xp, ym) == bg
575 && XGetPixel (ximg, xm, y) == bg
576 && XGetPixel (ximg, xm, yp) == bg
577 && XGetPixel (ximg, xm, ym) == bg)
578 XPutPixel (mask_img, x, y, 0);
579 else
580 XPutPixel (mask_img, x, y, 1);
584 xassert (interrupt_input_blocked);
585 gc = XCreateGC (FRAME_X_DISPLAY (f), mask, 0, NULL);
586 XPutImage (FRAME_X_DISPLAY (f), mask, gc, mask_img, 0, 0, 0, 0,
587 width, height);
588 XFreeGC (FRAME_X_DISPLAY (f), gc);
590 dpyinfo->bitmaps[id - 1].have_mask = 1;
591 dpyinfo->bitmaps[id - 1].mask = mask;
593 XDestroyImage (ximg);
594 x_destroy_x_image (mask_img);
596 return 0;
599 #endif /* HAVE_X_WINDOWS */
602 /***********************************************************************
603 Image types
604 ***********************************************************************/
606 /* Value is the number of elements of vector VECTOR. */
608 #define DIM(VECTOR) (sizeof (VECTOR) / sizeof *(VECTOR))
610 /* List of supported image types. Use define_image_type to add new
611 types. Use lookup_image_type to find a type for a given symbol. */
613 static struct image_type *image_types;
615 /* A list of symbols, one for each supported image type. */
617 Lisp_Object Vimage_types;
619 /* An alist of image types and libraries that implement the type. */
621 Lisp_Object Vimage_library_alist;
623 /* Cache for delayed-loading image types. */
625 static Lisp_Object Vimage_type_cache;
627 /* The symbol `xbm' which is used as the type symbol for XBM images. */
629 Lisp_Object Qxbm;
631 /* Keywords. */
633 extern Lisp_Object QCwidth, QCheight, QCforeground, QCbackground, QCfile;
634 extern Lisp_Object QCdata, QCtype;
635 extern Lisp_Object Qcenter;
636 Lisp_Object QCascent, QCmargin, QCrelief;
637 Lisp_Object QCconversion, QCcolor_symbols, QCheuristic_mask;
638 Lisp_Object QCindex, QCmatrix, QCcolor_adjustment, QCmask;
640 /* Other symbols. */
642 Lisp_Object Qlaplace, Qemboss, Qedge_detection, Qheuristic;
644 /* Time in seconds after which images should be removed from the cache
645 if not displayed. */
647 Lisp_Object Vimage_cache_eviction_delay;
649 /* Function prototypes. */
651 static Lisp_Object define_image_type P_ ((struct image_type *type, int loaded));
652 static struct image_type *lookup_image_type P_ ((Lisp_Object symbol));
653 static void image_error P_ ((char *format, Lisp_Object, Lisp_Object));
654 static void x_laplace P_ ((struct frame *, struct image *));
655 static void x_emboss P_ ((struct frame *, struct image *));
656 static int x_build_heuristic_mask P_ ((struct frame *, struct image *,
657 Lisp_Object));
659 #define CACHE_IMAGE_TYPE(type, status) \
660 do { Vimage_type_cache = Fcons (Fcons (type, status), Vimage_type_cache); } while (0)
662 #define ADD_IMAGE_TYPE(type) \
663 do { Vimage_types = Fcons (type, Vimage_types); } while (0)
665 /* Define a new image type from TYPE. This adds a copy of TYPE to
666 image_types and caches the loading status of TYPE. */
668 static Lisp_Object
669 define_image_type (type, loaded)
670 struct image_type *type;
671 int loaded;
673 Lisp_Object success;
675 if (!loaded)
676 success = Qnil;
677 else
679 /* Make a copy of TYPE to avoid a bus error in a dumped Emacs.
680 The initialized data segment is read-only. */
681 struct image_type *p = (struct image_type *) xmalloc (sizeof *p);
682 bcopy (type, p, sizeof *p);
683 p->next = image_types;
684 image_types = p;
685 success = Qt;
688 CACHE_IMAGE_TYPE (*type->type, success);
689 return success;
693 /* Look up image type SYMBOL, and return a pointer to its image_type
694 structure. Value is null if SYMBOL is not a known image type. */
696 static INLINE struct image_type *
697 lookup_image_type (symbol)
698 Lisp_Object symbol;
700 struct image_type *type;
702 /* We must initialize the image-type if it hasn't been already. */
703 if (NILP (Finit_image_library (symbol, Vimage_library_alist)))
704 return 0; /* unimplemented */
706 for (type = image_types; type; type = type->next)
707 if (EQ (symbol, *type->type))
708 break;
710 return type;
714 /* Value is non-zero if OBJECT is a valid Lisp image specification. A
715 valid image specification is a list whose car is the symbol
716 `image', and whose rest is a property list. The property list must
717 contain a value for key `:type'. That value must be the name of a
718 supported image type. The rest of the property list depends on the
719 image type. */
722 valid_image_p (object)
723 Lisp_Object object;
725 int valid_p = 0;
727 if (IMAGEP (object))
729 Lisp_Object tem;
731 for (tem = XCDR (object); CONSP (tem); tem = XCDR (tem))
732 if (EQ (XCAR (tem), QCtype))
734 tem = XCDR (tem);
735 if (CONSP (tem) && SYMBOLP (XCAR (tem)))
737 struct image_type *type;
738 type = lookup_image_type (XCAR (tem));
739 if (type)
740 valid_p = type->valid_p (object);
743 break;
747 return valid_p;
751 /* Log error message with format string FORMAT and argument ARG.
752 Signaling an error, e.g. when an image cannot be loaded, is not a
753 good idea because this would interrupt redisplay, and the error
754 message display would lead to another redisplay. This function
755 therefore simply displays a message. */
757 static void
758 image_error (format, arg1, arg2)
759 char *format;
760 Lisp_Object arg1, arg2;
762 add_to_log (format, arg1, arg2);
767 /***********************************************************************
768 Image specifications
769 ***********************************************************************/
771 enum image_value_type
773 IMAGE_DONT_CHECK_VALUE_TYPE,
774 IMAGE_STRING_VALUE,
775 IMAGE_STRING_OR_NIL_VALUE,
776 IMAGE_SYMBOL_VALUE,
777 IMAGE_POSITIVE_INTEGER_VALUE,
778 IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR,
779 IMAGE_NON_NEGATIVE_INTEGER_VALUE,
780 IMAGE_ASCENT_VALUE,
781 IMAGE_INTEGER_VALUE,
782 IMAGE_FUNCTION_VALUE,
783 IMAGE_NUMBER_VALUE,
784 IMAGE_BOOL_VALUE
787 /* Structure used when parsing image specifications. */
789 struct image_keyword
791 /* Name of keyword. */
792 char *name;
794 /* The type of value allowed. */
795 enum image_value_type type;
797 /* Non-zero means key must be present. */
798 int mandatory_p;
800 /* Used to recognize duplicate keywords in a property list. */
801 int count;
803 /* The value that was found. */
804 Lisp_Object value;
808 static int parse_image_spec P_ ((Lisp_Object, struct image_keyword *,
809 int, Lisp_Object));
810 static Lisp_Object image_spec_value P_ ((Lisp_Object, Lisp_Object, int *));
813 /* Parse image spec SPEC according to KEYWORDS. A valid image spec
814 has the format (image KEYWORD VALUE ...). One of the keyword/
815 value pairs must be `:type TYPE'. KEYWORDS is a vector of
816 image_keywords structures of size NKEYWORDS describing other
817 allowed keyword/value pairs. Value is non-zero if SPEC is valid. */
819 static int
820 parse_image_spec (spec, keywords, nkeywords, type)
821 Lisp_Object spec;
822 struct image_keyword *keywords;
823 int nkeywords;
824 Lisp_Object type;
826 int i;
827 Lisp_Object plist;
829 if (!IMAGEP (spec))
830 return 0;
832 plist = XCDR (spec);
833 while (CONSP (plist))
835 Lisp_Object key, value;
837 /* First element of a pair must be a symbol. */
838 key = XCAR (plist);
839 plist = XCDR (plist);
840 if (!SYMBOLP (key))
841 return 0;
843 /* There must follow a value. */
844 if (!CONSP (plist))
845 return 0;
846 value = XCAR (plist);
847 plist = XCDR (plist);
849 /* Find key in KEYWORDS. Error if not found. */
850 for (i = 0; i < nkeywords; ++i)
851 if (strcmp (keywords[i].name, SDATA (SYMBOL_NAME (key))) == 0)
852 break;
854 if (i == nkeywords)
855 continue;
857 /* Record that we recognized the keyword. If a keywords
858 was found more than once, it's an error. */
859 keywords[i].value = value;
860 ++keywords[i].count;
862 if (keywords[i].count > 1)
863 return 0;
865 /* Check type of value against allowed type. */
866 switch (keywords[i].type)
868 case IMAGE_STRING_VALUE:
869 if (!STRINGP (value))
870 return 0;
871 break;
873 case IMAGE_STRING_OR_NIL_VALUE:
874 if (!STRINGP (value) && !NILP (value))
875 return 0;
876 break;
878 case IMAGE_SYMBOL_VALUE:
879 if (!SYMBOLP (value))
880 return 0;
881 break;
883 case IMAGE_POSITIVE_INTEGER_VALUE:
884 if (!INTEGERP (value) || XINT (value) <= 0)
885 return 0;
886 break;
888 case IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR:
889 if (INTEGERP (value) && XINT (value) >= 0)
890 break;
891 if (CONSP (value)
892 && INTEGERP (XCAR (value)) && INTEGERP (XCDR (value))
893 && XINT (XCAR (value)) >= 0 && XINT (XCDR (value)) >= 0)
894 break;
895 return 0;
897 case IMAGE_ASCENT_VALUE:
898 if (SYMBOLP (value) && EQ (value, Qcenter))
899 break;
900 else if (INTEGERP (value)
901 && XINT (value) >= 0
902 && XINT (value) <= 100)
903 break;
904 return 0;
906 case IMAGE_NON_NEGATIVE_INTEGER_VALUE:
907 if (!INTEGERP (value) || XINT (value) < 0)
908 return 0;
909 break;
911 case IMAGE_DONT_CHECK_VALUE_TYPE:
912 break;
914 case IMAGE_FUNCTION_VALUE:
915 value = indirect_function (value);
916 if (SUBRP (value)
917 || COMPILEDP (value)
918 || (CONSP (value) && EQ (XCAR (value), Qlambda)))
919 break;
920 return 0;
922 case IMAGE_NUMBER_VALUE:
923 if (!INTEGERP (value) && !FLOATP (value))
924 return 0;
925 break;
927 case IMAGE_INTEGER_VALUE:
928 if (!INTEGERP (value))
929 return 0;
930 break;
932 case IMAGE_BOOL_VALUE:
933 if (!NILP (value) && !EQ (value, Qt))
934 return 0;
935 break;
937 default:
938 abort ();
939 break;
942 if (EQ (key, QCtype) && !EQ (type, value))
943 return 0;
946 /* Check that all mandatory fields are present. */
947 for (i = 0; i < nkeywords; ++i)
948 if (keywords[i].mandatory_p && keywords[i].count == 0)
949 return 0;
951 return NILP (plist);
955 /* Return the value of KEY in image specification SPEC. Value is nil
956 if KEY is not present in SPEC. if FOUND is not null, set *FOUND
957 to 1 if KEY was found in SPEC, set it to 0 otherwise. */
959 static Lisp_Object
960 image_spec_value (spec, key, found)
961 Lisp_Object spec, key;
962 int *found;
964 Lisp_Object tail;
966 xassert (valid_image_p (spec));
968 for (tail = XCDR (spec);
969 CONSP (tail) && CONSP (XCDR (tail));
970 tail = XCDR (XCDR (tail)))
972 if (EQ (XCAR (tail), key))
974 if (found)
975 *found = 1;
976 return XCAR (XCDR (tail));
980 if (found)
981 *found = 0;
982 return Qnil;
986 DEFUN ("image-size", Fimage_size, Simage_size, 1, 3, 0,
987 doc: /* Return the size of image SPEC as pair (WIDTH . HEIGHT).
988 PIXELS non-nil means return the size in pixels, otherwise return the
989 size in canonical character units.
990 FRAME is the frame on which the image will be displayed. FRAME nil
991 or omitted means use the selected frame. */)
992 (spec, pixels, frame)
993 Lisp_Object spec, pixels, frame;
995 Lisp_Object size;
997 size = Qnil;
998 if (valid_image_p (spec))
1000 struct frame *f = check_x_frame (frame);
1001 int id = lookup_image (f, spec);
1002 struct image *img = IMAGE_FROM_ID (f, id);
1003 int width = img->width + 2 * img->hmargin;
1004 int height = img->height + 2 * img->vmargin;
1006 if (NILP (pixels))
1007 size = Fcons (make_float ((double) width / FRAME_COLUMN_WIDTH (f)),
1008 make_float ((double) height / FRAME_LINE_HEIGHT (f)));
1009 else
1010 size = Fcons (make_number (width), make_number (height));
1012 else
1013 error ("Invalid image specification");
1015 return size;
1019 DEFUN ("image-mask-p", Fimage_mask_p, Simage_mask_p, 1, 2, 0,
1020 doc: /* Return t if image SPEC has a mask bitmap.
1021 FRAME is the frame on which the image will be displayed. FRAME nil
1022 or omitted means use the selected frame. */)
1023 (spec, frame)
1024 Lisp_Object spec, frame;
1026 Lisp_Object mask;
1028 mask = Qnil;
1029 if (valid_image_p (spec))
1031 struct frame *f = check_x_frame (frame);
1032 int id = lookup_image (f, spec);
1033 struct image *img = IMAGE_FROM_ID (f, id);
1034 if (img->mask)
1035 mask = Qt;
1037 else
1038 error ("Invalid image specification");
1040 return mask;
1044 /***********************************************************************
1045 Image type independent image structures
1046 ***********************************************************************/
1048 static struct image *make_image P_ ((Lisp_Object spec, unsigned hash));
1049 static void free_image P_ ((struct frame *f, struct image *img));
1052 /* Allocate and return a new image structure for image specification
1053 SPEC. SPEC has a hash value of HASH. */
1055 static struct image *
1056 make_image (spec, hash)
1057 Lisp_Object spec;
1058 unsigned hash;
1060 struct image *img = (struct image *) xmalloc (sizeof *img);
1062 xassert (valid_image_p (spec));
1063 bzero (img, sizeof *img);
1064 img->type = lookup_image_type (image_spec_value (spec, QCtype, NULL));
1065 xassert (img->type != NULL);
1066 img->spec = spec;
1067 img->data.lisp_val = Qnil;
1068 img->ascent = DEFAULT_IMAGE_ASCENT;
1069 img->hash = hash;
1070 return img;
1074 /* Free image IMG which was used on frame F, including its resources. */
1076 static void
1077 free_image (f, img)
1078 struct frame *f;
1079 struct image *img;
1081 if (img)
1083 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
1085 /* Remove IMG from the hash table of its cache. */
1086 if (img->prev)
1087 img->prev->next = img->next;
1088 else
1089 c->buckets[img->hash % IMAGE_CACHE_BUCKETS_SIZE] = img->next;
1091 if (img->next)
1092 img->next->prev = img->prev;
1094 c->images[img->id] = NULL;
1096 /* Free resources, then free IMG. */
1097 img->type->free (f, img);
1098 xfree (img);
1103 /* Prepare image IMG for display on frame F. Must be called before
1104 drawing an image. */
1106 void
1107 prepare_image_for_display (f, img)
1108 struct frame *f;
1109 struct image *img;
1111 EMACS_TIME t;
1113 /* We're about to display IMG, so set its timestamp to `now'. */
1114 EMACS_GET_TIME (t);
1115 img->timestamp = EMACS_SECS (t);
1117 /* If IMG doesn't have a pixmap yet, load it now, using the image
1118 type dependent loader function. */
1119 if (img->pixmap == NO_PIXMAP && !img->load_failed_p)
1120 img->load_failed_p = img->type->load (f, img) == 0;
1124 /* Value is the number of pixels for the ascent of image IMG when
1125 drawn in face FACE. */
1128 image_ascent (img, face, slice)
1129 struct image *img;
1130 struct face *face;
1131 struct glyph_slice *slice;
1133 int height;
1134 int ascent;
1136 if (slice->height == img->height)
1137 height = img->height + img->vmargin;
1138 else if (slice->y == 0)
1139 height = slice->height + img->vmargin;
1140 else
1141 height = slice->height;
1143 if (img->ascent == CENTERED_IMAGE_ASCENT)
1145 if (face->font)
1147 #ifdef HAVE_NTGUI
1148 /* W32 specific version. Why?. ++kfs */
1149 ascent = height / 2 - (FONT_DESCENT(face->font)
1150 - FONT_BASE(face->font)) / 2;
1151 #else
1152 /* This expression is arranged so that if the image can't be
1153 exactly centered, it will be moved slightly up. This is
1154 because a typical font is `top-heavy' (due to the presence
1155 uppercase letters), so the image placement should err towards
1156 being top-heavy too. It also just generally looks better. */
1157 ascent = (height + face->font->ascent - face->font->descent + 1) / 2;
1158 #endif /* HAVE_NTGUI */
1160 else
1161 ascent = height / 2;
1163 else
1164 ascent = (int) (height * img->ascent / 100.0);
1166 return ascent;
1170 /* Image background colors. */
1172 /* Find the "best" corner color of a bitmap.
1173 On W32, XIMG is assumed to a device context with the bitmap selected. */
1175 static RGB_PIXEL_COLOR
1176 four_corners_best (ximg, width, height)
1177 XImagePtr_or_DC ximg;
1178 unsigned long width, height;
1180 RGB_PIXEL_COLOR corners[4], best;
1181 int i, best_count;
1183 /* Get the colors at the corners of ximg. */
1184 corners[0] = GET_PIXEL (ximg, 0, 0);
1185 corners[1] = GET_PIXEL (ximg, width - 1, 0);
1186 corners[2] = GET_PIXEL (ximg, width - 1, height - 1);
1187 corners[3] = GET_PIXEL (ximg, 0, height - 1);
1189 /* Choose the most frequently found color as background. */
1190 for (i = best_count = 0; i < 4; ++i)
1192 int j, n;
1194 for (j = n = 0; j < 4; ++j)
1195 if (corners[i] == corners[j])
1196 ++n;
1198 if (n > best_count)
1199 best = corners[i], best_count = n;
1202 return best;
1205 /* Portability macros */
1207 #ifdef HAVE_NTGUI
1209 #define Destroy_Image(img_dc, prev) \
1210 do { SelectObject (img_dc, prev); DeleteDC (img_dc); } while (0)
1212 #define Free_Pixmap(display, pixmap) \
1213 DeleteObject (pixmap)
1215 #else
1217 #define Destroy_Image(ximg, dummy) \
1218 XDestroyImage (ximg)
1220 #define Free_Pixmap(display, pixmap) \
1221 XFreePixmap (display, pixmap)
1223 #endif /* HAVE_NTGUI */
1226 /* Return the `background' field of IMG. If IMG doesn't have one yet,
1227 it is guessed heuristically. If non-zero, XIMG is an existing
1228 XImage object (or device context with the image selected on W32) to
1229 use for the heuristic. */
1231 RGB_PIXEL_COLOR
1232 image_background (img, f, ximg)
1233 struct image *img;
1234 struct frame *f;
1235 XImagePtr_or_DC ximg;
1237 if (! img->background_valid)
1238 /* IMG doesn't have a background yet, try to guess a reasonable value. */
1240 int free_ximg = !ximg;
1241 #ifdef HAVE_NTGUI
1242 HGDIOBJ prev;
1243 #endif /* HAVE_NTGUI */
1245 if (free_ximg)
1247 #ifndef HAVE_NTGUI
1248 ximg = XGetImage (FRAME_X_DISPLAY (f), img->pixmap,
1249 0, 0, img->width, img->height, ~0, ZPixmap);
1250 #else
1251 HDC frame_dc = get_frame_dc (f);
1252 ximg = CreateCompatibleDC (frame_dc);
1253 release_frame_dc (f, frame_dc);
1254 prev = SelectObject (ximg, img->pixmap);
1255 #endif /* !HAVE_NTGUI */
1258 img->background = four_corners_best (ximg, img->width, img->height);
1260 if (free_ximg)
1261 Destroy_Image (ximg, prev);
1263 img->background_valid = 1;
1266 return img->background;
1269 /* Return the `background_transparent' field of IMG. If IMG doesn't
1270 have one yet, it is guessed heuristically. If non-zero, MASK is an
1271 existing XImage object to use for the heuristic. */
1274 image_background_transparent (img, f, mask)
1275 struct image *img;
1276 struct frame *f;
1277 XImagePtr_or_DC mask;
1279 if (! img->background_transparent_valid)
1280 /* IMG doesn't have a background yet, try to guess a reasonable value. */
1282 if (img->mask)
1284 int free_mask = !mask;
1285 #ifdef HAVE_NTGUI
1286 HGDIOBJ prev;
1287 #endif /* HAVE_NTGUI */
1289 if (free_mask)
1291 #ifndef HAVE_NTGUI
1292 mask = XGetImage (FRAME_X_DISPLAY (f), img->mask,
1293 0, 0, img->width, img->height, ~0, ZPixmap);
1294 #else
1295 HDC frame_dc = get_frame_dc (f);
1296 mask = CreateCompatibleDC (frame_dc);
1297 release_frame_dc (f, frame_dc);
1298 prev = SelectObject (mask, img->mask);
1299 #endif /* HAVE_NTGUI */
1302 img->background_transparent
1303 = (four_corners_best (mask, img->width, img->height) == PIX_MASK_RETAIN (f));
1305 if (free_mask)
1306 Destroy_Image (mask, prev);
1308 else
1309 img->background_transparent = 0;
1311 img->background_transparent_valid = 1;
1314 return img->background_transparent;
1318 /***********************************************************************
1319 Helper functions for X image types
1320 ***********************************************************************/
1322 static void x_clear_image_1 P_ ((struct frame *, struct image *, int,
1323 int, int));
1324 static void x_clear_image P_ ((struct frame *f, struct image *img));
1325 static unsigned long x_alloc_image_color P_ ((struct frame *f,
1326 struct image *img,
1327 Lisp_Object color_name,
1328 unsigned long dflt));
1331 /* Clear X resources of image IMG on frame F. PIXMAP_P non-zero means
1332 free the pixmap if any. MASK_P non-zero means clear the mask
1333 pixmap if any. COLORS_P non-zero means free colors allocated for
1334 the image, if any. */
1336 static void
1337 x_clear_image_1 (f, img, pixmap_p, mask_p, colors_p)
1338 struct frame *f;
1339 struct image *img;
1340 int pixmap_p, mask_p, colors_p;
1342 if (pixmap_p && img->pixmap)
1344 Free_Pixmap (FRAME_X_DISPLAY (f), img->pixmap);
1345 img->pixmap = NO_PIXMAP;
1346 img->background_valid = 0;
1349 if (mask_p && img->mask)
1351 Free_Pixmap (FRAME_X_DISPLAY (f), img->mask);
1352 img->mask = NO_PIXMAP;
1353 img->background_transparent_valid = 0;
1356 if (colors_p && img->ncolors)
1358 /* MAC_TODO: color table support. */
1359 /* W32_TODO: color table support. */
1360 #ifdef HAVE_X_WINDOWS
1361 x_free_colors (f, img->colors, img->ncolors);
1362 #endif /* HAVE_X_WINDOWS */
1363 xfree (img->colors);
1364 img->colors = NULL;
1365 img->ncolors = 0;
1369 /* Free X resources of image IMG which is used on frame F. */
1371 static void
1372 x_clear_image (f, img)
1373 struct frame *f;
1374 struct image *img;
1376 BLOCK_INPUT;
1377 x_clear_image_1 (f, img, 1, 1, 1);
1378 UNBLOCK_INPUT;
1382 /* Allocate color COLOR_NAME for image IMG on frame F. If color
1383 cannot be allocated, use DFLT. Add a newly allocated color to
1384 IMG->colors, so that it can be freed again. Value is the pixel
1385 color. */
1387 static unsigned long
1388 x_alloc_image_color (f, img, color_name, dflt)
1389 struct frame *f;
1390 struct image *img;
1391 Lisp_Object color_name;
1392 unsigned long dflt;
1394 XColor color;
1395 unsigned long result;
1397 xassert (STRINGP (color_name));
1399 if (x_defined_color (f, SDATA (color_name), &color, 1))
1401 /* This isn't called frequently so we get away with simply
1402 reallocating the color vector to the needed size, here. */
1403 ++img->ncolors;
1404 img->colors =
1405 (unsigned long *) xrealloc (img->colors,
1406 img->ncolors * sizeof *img->colors);
1407 img->colors[img->ncolors - 1] = color.pixel;
1408 result = color.pixel;
1410 else
1411 result = dflt;
1413 return result;
1418 /***********************************************************************
1419 Image Cache
1420 ***********************************************************************/
1422 static void cache_image P_ ((struct frame *f, struct image *img));
1423 static void postprocess_image P_ ((struct frame *, struct image *));
1425 /* Return a new, initialized image cache that is allocated from the
1426 heap. Call free_image_cache to free an image cache. */
1428 struct image_cache *
1429 make_image_cache ()
1431 struct image_cache *c = (struct image_cache *) xmalloc (sizeof *c);
1432 int size;
1434 bzero (c, sizeof *c);
1435 c->size = 50;
1436 c->images = (struct image **) xmalloc (c->size * sizeof *c->images);
1437 size = IMAGE_CACHE_BUCKETS_SIZE * sizeof *c->buckets;
1438 c->buckets = (struct image **) xmalloc (size);
1439 bzero (c->buckets, size);
1440 return c;
1444 /* Free image cache of frame F. Be aware that X frames share images
1445 caches. */
1447 void
1448 free_image_cache (f)
1449 struct frame *f;
1451 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
1452 if (c)
1454 int i;
1456 /* Cache should not be referenced by any frame when freed. */
1457 xassert (c->refcount == 0);
1459 for (i = 0; i < c->used; ++i)
1460 free_image (f, c->images[i]);
1461 xfree (c->images);
1462 xfree (c->buckets);
1463 xfree (c);
1464 FRAME_X_IMAGE_CACHE (f) = NULL;
1469 /* Clear image cache of frame F. FORCE_P non-zero means free all
1470 images. FORCE_P zero means clear only images that haven't been
1471 displayed for some time. Should be called from time to time to
1472 reduce the number of loaded images. If image-eviction-seconds is
1473 non-nil, this frees images in the cache which weren't displayed for
1474 at least that many seconds. */
1476 void
1477 clear_image_cache (f, force_p)
1478 struct frame *f;
1479 int force_p;
1481 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
1483 if (c && INTEGERP (Vimage_cache_eviction_delay))
1485 EMACS_TIME t;
1486 unsigned long old;
1487 int i, nfreed;
1489 EMACS_GET_TIME (t);
1490 old = EMACS_SECS (t) - XFASTINT (Vimage_cache_eviction_delay);
1492 /* Block input so that we won't be interrupted by a SIGIO
1493 while being in an inconsistent state. */
1494 BLOCK_INPUT;
1496 for (i = nfreed = 0; i < c->used; ++i)
1498 struct image *img = c->images[i];
1499 if (img != NULL
1500 && (force_p || img->timestamp < old))
1502 free_image (f, img);
1503 ++nfreed;
1507 /* We may be clearing the image cache because, for example,
1508 Emacs was iconified for a longer period of time. In that
1509 case, current matrices may still contain references to
1510 images freed above. So, clear these matrices. */
1511 if (nfreed)
1513 Lisp_Object tail, frame;
1515 FOR_EACH_FRAME (tail, frame)
1517 struct frame *f = XFRAME (frame);
1518 if (FRAME_WINDOW_P (f)
1519 && FRAME_X_IMAGE_CACHE (f) == c)
1520 clear_current_matrices (f);
1523 ++windows_or_buffers_changed;
1526 UNBLOCK_INPUT;
1531 DEFUN ("clear-image-cache", Fclear_image_cache, Sclear_image_cache,
1532 0, 1, 0,
1533 doc: /* Clear the image cache of FRAME.
1534 FRAME nil or omitted means use the selected frame.
1535 FRAME t means clear the image caches of all frames. */)
1536 (frame)
1537 Lisp_Object frame;
1539 if (EQ (frame, Qt))
1541 Lisp_Object tail;
1543 FOR_EACH_FRAME (tail, frame)
1544 if (FRAME_WINDOW_P (XFRAME (frame)))
1545 clear_image_cache (XFRAME (frame), 1);
1547 else
1548 clear_image_cache (check_x_frame (frame), 1);
1550 return Qnil;
1554 /* Compute masks and transform image IMG on frame F, as specified
1555 by the image's specification, */
1557 static void
1558 postprocess_image (f, img)
1559 struct frame *f;
1560 struct image *img;
1562 /* Manipulation of the image's mask. */
1563 if (img->pixmap)
1565 Lisp_Object conversion, spec;
1566 Lisp_Object mask;
1568 spec = img->spec;
1570 /* `:heuristic-mask t'
1571 `:mask heuristic'
1572 means build a mask heuristically.
1573 `:heuristic-mask (R G B)'
1574 `:mask (heuristic (R G B))'
1575 means build a mask from color (R G B) in the
1576 image.
1577 `:mask nil'
1578 means remove a mask, if any. */
1580 mask = image_spec_value (spec, QCheuristic_mask, NULL);
1581 if (!NILP (mask))
1582 x_build_heuristic_mask (f, img, mask);
1583 else
1585 int found_p;
1587 mask = image_spec_value (spec, QCmask, &found_p);
1589 if (EQ (mask, Qheuristic))
1590 x_build_heuristic_mask (f, img, Qt);
1591 else if (CONSP (mask)
1592 && EQ (XCAR (mask), Qheuristic))
1594 if (CONSP (XCDR (mask)))
1595 x_build_heuristic_mask (f, img, XCAR (XCDR (mask)));
1596 else
1597 x_build_heuristic_mask (f, img, XCDR (mask));
1599 else if (NILP (mask) && found_p && img->mask)
1601 Free_Pixmap (FRAME_X_DISPLAY (f), img->mask);
1602 img->mask = NO_PIXMAP;
1607 /* Should we apply an image transformation algorithm? */
1608 conversion = image_spec_value (spec, QCconversion, NULL);
1609 if (EQ (conversion, Qdisabled))
1610 x_disable_image (f, img);
1611 else if (EQ (conversion, Qlaplace))
1612 x_laplace (f, img);
1613 else if (EQ (conversion, Qemboss))
1614 x_emboss (f, img);
1615 else if (CONSP (conversion)
1616 && EQ (XCAR (conversion), Qedge_detection))
1618 Lisp_Object tem;
1619 tem = XCDR (conversion);
1620 if (CONSP (tem))
1621 x_edge_detection (f, img,
1622 Fplist_get (tem, QCmatrix),
1623 Fplist_get (tem, QCcolor_adjustment));
1629 /* Return the id of image with Lisp specification SPEC on frame F.
1630 SPEC must be a valid Lisp image specification (see valid_image_p). */
1633 lookup_image (f, spec)
1634 struct frame *f;
1635 Lisp_Object spec;
1637 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
1638 struct image *img;
1639 int i;
1640 unsigned hash;
1641 struct gcpro gcpro1;
1642 EMACS_TIME now;
1644 /* F must be a window-system frame, and SPEC must be a valid image
1645 specification. */
1646 xassert (FRAME_WINDOW_P (f));
1647 xassert (valid_image_p (spec));
1649 GCPRO1 (spec);
1651 /* Look up SPEC in the hash table of the image cache. */
1652 hash = sxhash (spec, 0);
1653 i = hash % IMAGE_CACHE_BUCKETS_SIZE;
1655 for (img = c->buckets[i]; img; img = img->next)
1656 if (img->hash == hash && !NILP (Fequal (img->spec, spec)))
1657 break;
1659 /* If not found, create a new image and cache it. */
1660 if (img == NULL)
1662 extern Lisp_Object Qpostscript;
1664 BLOCK_INPUT;
1665 img = make_image (spec, hash);
1666 cache_image (f, img);
1667 img->load_failed_p = img->type->load (f, img) == 0;
1669 /* If we can't load the image, and we don't have a width and
1670 height, use some arbitrary width and height so that we can
1671 draw a rectangle for it. */
1672 if (img->load_failed_p)
1674 Lisp_Object value;
1676 value = image_spec_value (spec, QCwidth, NULL);
1677 img->width = (INTEGERP (value)
1678 ? XFASTINT (value) : DEFAULT_IMAGE_WIDTH);
1679 value = image_spec_value (spec, QCheight, NULL);
1680 img->height = (INTEGERP (value)
1681 ? XFASTINT (value) : DEFAULT_IMAGE_HEIGHT);
1683 else
1685 /* Handle image type independent image attributes
1686 `:ascent ASCENT', `:margin MARGIN', `:relief RELIEF',
1687 `:background COLOR'. */
1688 Lisp_Object ascent, margin, relief, bg;
1690 ascent = image_spec_value (spec, QCascent, NULL);
1691 if (INTEGERP (ascent))
1692 img->ascent = XFASTINT (ascent);
1693 else if (EQ (ascent, Qcenter))
1694 img->ascent = CENTERED_IMAGE_ASCENT;
1696 margin = image_spec_value (spec, QCmargin, NULL);
1697 if (INTEGERP (margin) && XINT (margin) >= 0)
1698 img->vmargin = img->hmargin = XFASTINT (margin);
1699 else if (CONSP (margin) && INTEGERP (XCAR (margin))
1700 && INTEGERP (XCDR (margin)))
1702 if (XINT (XCAR (margin)) > 0)
1703 img->hmargin = XFASTINT (XCAR (margin));
1704 if (XINT (XCDR (margin)) > 0)
1705 img->vmargin = XFASTINT (XCDR (margin));
1708 relief = image_spec_value (spec, QCrelief, NULL);
1709 if (INTEGERP (relief))
1711 img->relief = XINT (relief);
1712 img->hmargin += abs (img->relief);
1713 img->vmargin += abs (img->relief);
1716 if (! img->background_valid)
1718 bg = image_spec_value (img->spec, QCbackground, NULL);
1719 if (!NILP (bg))
1721 img->background
1722 = x_alloc_image_color (f, img, bg,
1723 FRAME_BACKGROUND_PIXEL (f));
1724 img->background_valid = 1;
1728 /* Do image transformations and compute masks, unless we
1729 don't have the image yet. */
1730 if (!EQ (*img->type->type, Qpostscript))
1731 postprocess_image (f, img);
1734 UNBLOCK_INPUT;
1737 /* We're using IMG, so set its timestamp to `now'. */
1738 EMACS_GET_TIME (now);
1739 img->timestamp = EMACS_SECS (now);
1741 UNGCPRO;
1743 /* Value is the image id. */
1744 return img->id;
1748 /* Cache image IMG in the image cache of frame F. */
1750 static void
1751 cache_image (f, img)
1752 struct frame *f;
1753 struct image *img;
1755 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
1756 int i;
1758 /* Find a free slot in c->images. */
1759 for (i = 0; i < c->used; ++i)
1760 if (c->images[i] == NULL)
1761 break;
1763 /* If no free slot found, maybe enlarge c->images. */
1764 if (i == c->used && c->used == c->size)
1766 c->size *= 2;
1767 c->images = (struct image **) xrealloc (c->images,
1768 c->size * sizeof *c->images);
1771 /* Add IMG to c->images, and assign IMG an id. */
1772 c->images[i] = img;
1773 img->id = i;
1774 if (i == c->used)
1775 ++c->used;
1777 /* Add IMG to the cache's hash table. */
1778 i = img->hash % IMAGE_CACHE_BUCKETS_SIZE;
1779 img->next = c->buckets[i];
1780 if (img->next)
1781 img->next->prev = img;
1782 img->prev = NULL;
1783 c->buckets[i] = img;
1787 /* Call FN on every image in the image cache of frame F. Used to mark
1788 Lisp Objects in the image cache. */
1790 void
1791 forall_images_in_image_cache (f, fn)
1792 struct frame *f;
1793 void (*fn) P_ ((struct image *img));
1795 if (FRAME_LIVE_P (f) && FRAME_WINDOW_P (f))
1797 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
1798 if (c)
1800 int i;
1801 for (i = 0; i < c->used; ++i)
1802 if (c->images[i])
1803 fn (c->images[i]);
1810 /***********************************************************************
1811 X / MAC / W32 support code
1812 ***********************************************************************/
1814 #ifdef HAVE_NTGUI
1816 /* Macro for defining functions that will be loaded from image DLLs. */
1817 #define DEF_IMGLIB_FN(func) int (FAR CDECL *fn_##func)()
1819 /* Macro for loading those image functions from the library. */
1820 #define LOAD_IMGLIB_FN(lib,func) { \
1821 fn_##func = (void *) GetProcAddress (lib, #func); \
1822 if (!fn_##func) return 0; \
1825 /* Load a DLL implementing an image type.
1826 The `image-library-alist' variable associates a symbol,
1827 identifying an image type, to a list of possible filenames.
1828 The function returns NULL if no library could be loaded for
1829 the given image type, or if the library was previously loaded;
1830 else the handle of the DLL. */
1831 static HMODULE
1832 w32_delayed_load (Lisp_Object libraries, Lisp_Object type)
1834 HMODULE library = NULL;
1836 if (CONSP (libraries) && NILP (Fassq (type, Vimage_type_cache)))
1838 Lisp_Object dlls = Fassq (type, libraries);
1840 if (CONSP (dlls))
1841 for (dlls = XCDR (dlls); CONSP (dlls); dlls = XCDR (dlls))
1843 CHECK_STRING_CAR (dlls);
1844 if (library = LoadLibrary (SDATA (XCAR (dlls))))
1845 break;
1849 return library;
1852 #endif /* HAVE_NTGUI */
1854 static int x_create_x_image_and_pixmap P_ ((struct frame *, int, int, int,
1855 XImagePtr *, Pixmap *));
1856 static void x_destroy_x_image P_ ((XImagePtr));
1857 static void x_put_x_image P_ ((struct frame *, XImagePtr, Pixmap, int, int));
1860 /* Create an XImage and a pixmap of size WIDTH x HEIGHT for use on
1861 frame F. Set *XIMG and *PIXMAP to the XImage and Pixmap created.
1862 Set (*XIMG)->data to a raster of WIDTH x HEIGHT pixels allocated
1863 via xmalloc. Print error messages via image_error if an error
1864 occurs. Value is non-zero if successful.
1866 On W32, a DEPTH of zero signifies a 24 bit image, otherwise DEPTH
1867 should indicate the bit depth of the image. */
1869 static int
1870 x_create_x_image_and_pixmap (f, width, height, depth, ximg, pixmap)
1871 struct frame *f;
1872 int width, height, depth;
1873 XImagePtr *ximg;
1874 Pixmap *pixmap;
1876 #ifdef HAVE_X_WINDOWS
1877 Display *display = FRAME_X_DISPLAY (f);
1878 Window window = FRAME_X_WINDOW (f);
1879 Screen *screen = FRAME_X_SCREEN (f);
1881 xassert (interrupt_input_blocked);
1883 if (depth <= 0)
1884 depth = DefaultDepthOfScreen (screen);
1885 *ximg = XCreateImage (display, DefaultVisualOfScreen (screen),
1886 depth, ZPixmap, 0, NULL, width, height,
1887 depth > 16 ? 32 : depth > 8 ? 16 : 8, 0);
1888 if (*ximg == NULL)
1890 image_error ("Unable to allocate X image", Qnil, Qnil);
1891 return 0;
1894 /* Allocate image raster. */
1895 (*ximg)->data = (char *) xmalloc ((*ximg)->bytes_per_line * height);
1897 /* Allocate a pixmap of the same size. */
1898 *pixmap = XCreatePixmap (display, window, width, height, depth);
1899 if (*pixmap == NO_PIXMAP)
1901 x_destroy_x_image (*ximg);
1902 *ximg = NULL;
1903 image_error ("Unable to create X pixmap", Qnil, Qnil);
1904 return 0;
1907 return 1;
1908 #endif /* HAVE_X_WINDOWS */
1910 #ifdef HAVE_NTGUI
1912 BITMAPINFOHEADER *header;
1913 HDC hdc;
1914 int scanline_width_bits;
1915 int remainder;
1916 int palette_colors = 0;
1918 if (depth == 0)
1919 depth = 24;
1921 if (depth != 1 && depth != 4 && depth != 8
1922 && depth != 16 && depth != 24 && depth != 32)
1924 image_error ("Invalid image bit depth specified", Qnil, Qnil);
1925 return 0;
1928 scanline_width_bits = width * depth;
1929 remainder = scanline_width_bits % 32;
1931 if (remainder)
1932 scanline_width_bits += 32 - remainder;
1934 /* Bitmaps with a depth less than 16 need a palette. */
1935 /* BITMAPINFO structure already contains the first RGBQUAD. */
1936 if (depth < 16)
1937 palette_colors = 1 << depth - 1;
1939 *ximg = xmalloc (sizeof (XImage) + palette_colors * sizeof (RGBQUAD));
1940 if (*ximg == NULL)
1942 image_error ("Unable to allocate memory for XImage", Qnil, Qnil);
1943 return 0;
1946 header = &((*ximg)->info.bmiHeader);
1947 bzero (&((*ximg)->info), sizeof (BITMAPINFO));
1948 header->biSize = sizeof (*header);
1949 header->biWidth = width;
1950 header->biHeight = -height; /* negative indicates a top-down bitmap. */
1951 header->biPlanes = 1;
1952 header->biBitCount = depth;
1953 header->biCompression = BI_RGB;
1954 header->biClrUsed = palette_colors;
1956 /* TODO: fill in palette. */
1957 if (depth == 1)
1959 (*ximg)->info.bmiColors[0].rgbBlue = 0;
1960 (*ximg)->info.bmiColors[0].rgbGreen = 0;
1961 (*ximg)->info.bmiColors[0].rgbRed = 0;
1962 (*ximg)->info.bmiColors[0].rgbReserved = 0;
1963 (*ximg)->info.bmiColors[1].rgbBlue = 255;
1964 (*ximg)->info.bmiColors[1].rgbGreen = 255;
1965 (*ximg)->info.bmiColors[1].rgbRed = 255;
1966 (*ximg)->info.bmiColors[1].rgbReserved = 0;
1969 hdc = get_frame_dc (f);
1971 /* Create a DIBSection and raster array for the bitmap,
1972 and store its handle in *pixmap. */
1973 *pixmap = CreateDIBSection (hdc, &((*ximg)->info),
1974 (depth < 16) ? DIB_PAL_COLORS : DIB_RGB_COLORS,
1975 &((*ximg)->data), NULL, 0);
1977 /* Realize display palette and garbage all frames. */
1978 release_frame_dc (f, hdc);
1980 if (*pixmap == NULL)
1982 DWORD err = GetLastError();
1983 Lisp_Object errcode;
1984 /* All system errors are < 10000, so the following is safe. */
1985 XSETINT (errcode, (int) err);
1986 image_error ("Unable to create bitmap, error code %d", errcode, Qnil);
1987 x_destroy_x_image (*ximg);
1988 return 0;
1991 return 1;
1993 #endif /* HAVE_NTGUI */
1995 #ifdef MAC_OS
1996 Display *display = FRAME_X_DISPLAY (f);
1997 Window window = FRAME_X_WINDOW (f);
1999 xassert (interrupt_input_blocked);
2001 /* Allocate a pixmap of the same size. */
2002 *pixmap = XCreatePixmap (display, window, width, height, depth);
2003 if (*pixmap == NO_PIXMAP)
2005 x_destroy_x_image (*ximg);
2006 *ximg = NULL;
2007 image_error ("Unable to create X pixmap", Qnil, Qnil);
2008 return 0;
2011 LockPixels (GetGWorldPixMap (*pixmap));
2012 *ximg = *pixmap;
2013 return 1;
2015 #endif /* MAC_OS */
2019 /* Destroy XImage XIMG. Free XIMG->data. */
2021 static void
2022 x_destroy_x_image (ximg)
2023 XImagePtr ximg;
2025 xassert (interrupt_input_blocked);
2026 if (ximg)
2028 #ifdef HAVE_X_WINDOWS
2029 xfree (ximg->data);
2030 ximg->data = NULL;
2031 XDestroyImage (ximg);
2032 #endif /* HAVE_X_WINDOWS */
2033 #ifdef HAVE_NTGUI
2034 /* Data will be freed by DestroyObject. */
2035 ximg->data = NULL;
2036 xfree (ximg);
2037 #endif /* HAVE_NTGUI */
2038 #ifdef MAC_OS
2039 XDestroyImage (ximg);
2040 #endif /* MAC_OS */
2045 /* Put XImage XIMG into pixmap PIXMAP on frame F. WIDTH and HEIGHT
2046 are width and height of both the image and pixmap. */
2048 static void
2049 x_put_x_image (f, ximg, pixmap, width, height)
2050 struct frame *f;
2051 XImagePtr ximg;
2052 Pixmap pixmap;
2053 int width, height;
2055 #ifdef HAVE_X_WINDOWS
2056 GC gc;
2058 xassert (interrupt_input_blocked);
2059 gc = XCreateGC (FRAME_X_DISPLAY (f), pixmap, 0, NULL);
2060 XPutImage (FRAME_X_DISPLAY (f), pixmap, gc, ximg, 0, 0, 0, 0, width, height);
2061 XFreeGC (FRAME_X_DISPLAY (f), gc);
2062 #endif /* HAVE_X_WINDOWS */
2064 #ifdef HAVE_NTGUI
2065 #if 0 /* I don't think this is necessary looking at where it is used. */
2066 HDC hdc = get_frame_dc (f);
2067 SetDIBits (hdc, pixmap, 0, height, ximg->data, &(ximg->info), DIB_RGB_COLORS);
2068 release_frame_dc (f, hdc);
2069 #endif
2070 #endif /* HAVE_NTGUI */
2072 #ifdef MAC_OS
2073 xassert (ximg == pixmap);
2074 #endif /* MAC_OS */
2078 /***********************************************************************
2079 File Handling
2080 ***********************************************************************/
2082 static unsigned char *slurp_file P_ ((char *, int *));
2085 /* Find image file FILE. Look in data-directory, then
2086 x-bitmap-file-path. Value is the full name of the file found, or
2087 nil if not found. */
2089 Lisp_Object
2090 x_find_image_file (file)
2091 Lisp_Object file;
2093 Lisp_Object file_found, search_path;
2094 struct gcpro gcpro1, gcpro2;
2095 int fd;
2097 file_found = Qnil;
2098 search_path = Fcons (Vdata_directory, Vx_bitmap_file_path);
2099 GCPRO2 (file_found, search_path);
2101 /* Try to find FILE in data-directory, then x-bitmap-file-path. */
2102 fd = openp (search_path, file, Qnil, &file_found, Qnil);
2104 if (fd == -1)
2105 file_found = Qnil;
2106 else
2107 close (fd);
2109 UNGCPRO;
2110 return file_found;
2114 /* Read FILE into memory. Value is a pointer to a buffer allocated
2115 with xmalloc holding FILE's contents. Value is null if an error
2116 occurred. *SIZE is set to the size of the file. */
2118 static unsigned char *
2119 slurp_file (file, size)
2120 char *file;
2121 int *size;
2123 FILE *fp = NULL;
2124 unsigned char *buf = NULL;
2125 struct stat st;
2127 if (stat (file, &st) == 0
2128 && (fp = fopen (file, "rb")) != NULL
2129 && (buf = (char *) xmalloc (st.st_size),
2130 fread (buf, 1, st.st_size, fp) == st.st_size))
2132 *size = st.st_size;
2133 fclose (fp);
2135 else
2137 if (fp)
2138 fclose (fp);
2139 if (buf)
2141 xfree (buf);
2142 buf = NULL;
2146 return buf;
2151 #ifdef MAC_OS
2153 /***********************************************************************
2154 MAC Image Load Functions
2155 ***********************************************************************/
2157 static int image_load_quicktime P_ ((struct frame *, struct image *img,
2158 OSType));
2159 #ifdef MAC_OSX
2160 static int image_load_quartz2d P_ ((struct frame *, struct image *img, int));
2161 #endif
2163 static OSErr
2164 find_image_fsspec (specified_file, file, fss)
2165 Lisp_Object specified_file, *file;
2166 FSSpec *fss;
2168 #if TARGET_API_MAC_CARBON
2169 FSRef fsr;
2170 #else
2171 Str255 mac_pathname;
2172 #endif
2173 OSErr err;
2175 *file = x_find_image_file (specified_file);
2176 if (!STRINGP (*file))
2177 return fnfErr; /* file or directory not found;
2178 incomplete pathname */
2179 /* Try to open the image file. */
2180 #if TARGET_API_MAC_CARBON
2181 err = FSPathMakeRef (SDATA (*file), &fsr, NULL);
2182 if (err == noErr)
2183 err = FSGetCatalogInfo (&fsr, kFSCatInfoNone, NULL, NULL, fss, NULL);
2184 #else
2185 if (posix_to_mac_pathname (SDATA (*file), mac_pathname, MAXPATHLEN+1) == 0)
2186 return fnfErr;
2187 c2pstr (mac_pathname);
2188 err = FSMakeFSSpec (0, 0, mac_pathname, fss);
2189 #endif
2190 return err;
2193 static int
2194 image_load_qt_1 (f, img, type, fss, dh)
2195 struct frame *f;
2196 struct image *img;
2197 OSType type;
2198 FSSpec *fss;
2199 Handle dh;
2201 OSErr err;
2202 GraphicsImportComponent gi;
2203 Rect rect;
2204 int width, height;
2205 short draw_all_pixels;
2206 Lisp_Object specified_bg;
2207 XColor color;
2208 XImagePtr ximg;
2209 RGBColor bg_color;
2211 err = OpenADefaultComponent (GraphicsImporterComponentType,
2212 type, &gi);
2213 if (err != noErr)
2215 image_error ("Cannot get importer component for `%s'", img->spec, Qnil);
2216 return 0;
2218 if (dh == NULL)
2220 /* read from file system spec */
2221 err = GraphicsImportSetDataFile (gi, fss);
2222 if (err != noErr)
2224 image_error ("Cannot set fsspec to graphics importer for '%s'",
2225 img->spec, Qnil);
2226 goto error;
2229 else
2231 /* read from data handle */
2232 err = GraphicsImportSetDataHandle (gi, dh);
2233 if (err != noErr)
2235 image_error ("Cannot set data handle to graphics importer for `%s'",
2236 img->spec, Qnil);
2237 goto error;
2240 err = GraphicsImportGetNaturalBounds (gi, &rect);
2241 if (err != noErr)
2243 image_error ("Error reading `%s'", img->spec, Qnil);
2244 goto error;
2246 width = img->width = rect.right - rect.left;
2247 height = img->height = rect.bottom - rect.top;
2248 err = GraphicsImportDoesDrawAllPixels (gi, &draw_all_pixels);
2249 #if 0
2250 /* Don't check the error code here. It may have an undocumented
2251 value -32766. */
2252 if (err != noErr)
2254 image_error ("Error reading `%s'", img->spec, Qnil);
2255 goto error;
2257 #endif
2258 if (draw_all_pixels != graphicsImporterDrawsAllPixels)
2260 specified_bg = image_spec_value (img->spec, QCbackground, NULL);
2261 if (!STRINGP (specified_bg) ||
2262 !mac_defined_color (f, SDATA (specified_bg), &color, 0))
2264 color.pixel = FRAME_BACKGROUND_PIXEL (f);
2265 color.red = RED16_FROM_ULONG (color.pixel);
2266 color.green = GREEN16_FROM_ULONG (color.pixel);
2267 color.blue = BLUE16_FROM_ULONG (color.pixel);
2271 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
2272 goto error;
2273 if (draw_all_pixels != graphicsImporterDrawsAllPixels)
2275 CGrafPtr old_port;
2276 GDHandle old_gdh;
2278 GetGWorld (&old_port, &old_gdh);
2279 SetGWorld (ximg, NULL);
2280 bg_color.red = color.red;
2281 bg_color.green = color.green;
2282 bg_color.blue = color.blue;
2283 RGBBackColor (&bg_color);
2284 #if TARGET_API_MAC_CARBON
2285 GetPortBounds (ximg, &rect);
2286 EraseRect (&rect);
2287 #else
2288 EraseRect (&(ximg->portRect));
2289 #endif
2290 SetGWorld (old_port, old_gdh);
2292 GraphicsImportSetGWorld (gi, ximg, NULL);
2293 GraphicsImportDraw (gi);
2294 CloseComponent (gi);
2296 /* Maybe fill in the background field while we have ximg handy. */
2297 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
2298 IMAGE_BACKGROUND (img, f, ximg);
2300 /* Put the image into the pixmap. */
2301 x_put_x_image (f, ximg, img->pixmap, width, height);
2302 x_destroy_x_image (ximg);
2303 return 1;
2305 error:
2306 CloseComponent (gi);
2307 return 0;
2311 /* Load an image using the QuickTime Graphics Importer.
2312 Note: The alpha channel does not work for PNG images. */
2313 static int
2314 image_load_quicktime (f, img, type)
2315 struct frame *f;
2316 struct image *img;
2317 OSType type;
2319 Lisp_Object specified_file;
2320 Lisp_Object specified_data;
2321 OSErr err;
2323 specified_file = image_spec_value (img->spec, QCfile, NULL);
2324 specified_data = image_spec_value (img->spec, QCdata, NULL);
2326 if (NILP (specified_data))
2328 /* Read from a file */
2329 Lisp_Object file;
2330 FSSpec fss;
2332 err = find_image_fsspec (specified_file, &file, &fss);
2333 if (err != noErr)
2335 if (err == fnfErr)
2336 image_error ("Cannot find image file `%s'", specified_file, Qnil);
2337 else
2338 image_error ("Cannot open `%s'", file, Qnil);
2339 return 0;
2341 return image_load_qt_1 (f, img, type, &fss, NULL);
2343 else
2345 /* Memory source! */
2346 int success_p;
2347 Handle dh;
2349 err = PtrToHand (SDATA (specified_data), &dh, SBYTES (specified_data));
2350 if (err != noErr)
2352 image_error ("Cannot allocate data handle for `%s'",
2353 img->spec, Qnil);
2354 return 0;
2356 success_p = image_load_qt_1 (f, img, type, NULL, dh);
2357 DisposeHandle (dh);
2358 return success_p;
2363 #ifdef MAC_OSX
2364 /* Load a PNG/JPEG image using Quartz 2D decoding routines.
2365 CGImageCreateWithPNGDataProvider is provided after Mac OS X 10.2.
2366 So don't use this function directly but determine at runtime
2367 whether it exists. */
2368 typedef CGImageRef (*CGImageCreateWithPNGDataProviderProcType)
2369 (CGDataProviderRef, const float [], bool, CGColorRenderingIntent);
2370 static CGImageCreateWithPNGDataProviderProcType MyCGImageCreateWithPNGDataProvider;
2373 static void
2374 init_image_func_pointer ()
2376 if (NSIsSymbolNameDefined ("_CGImageCreateWithPNGDataProvider"))
2378 MyCGImageCreateWithPNGDataProvider
2379 = (CGImageCreateWithPNGDataProviderProcType)
2380 NSAddressOfSymbol (NSLookupAndBindSymbol
2381 ("_CGImageCreateWithPNGDataProvider"));
2383 else
2384 MyCGImageCreateWithPNGDataProvider = NULL;
2388 static int
2389 image_load_quartz2d (f, img, png_p)
2390 struct frame *f;
2391 struct image *img;
2392 int png_p;
2394 Lisp_Object file, specified_file;
2395 Lisp_Object specified_data, specified_bg;
2396 struct gcpro gcpro1;
2397 CGDataProviderRef source;
2398 CGImageRef image;
2399 int width, height;
2400 XColor color;
2401 XImagePtr ximg = NULL;
2402 CGContextRef context;
2403 CGRect rectangle;
2405 /* Open the file. */
2406 specified_file = image_spec_value (img->spec, QCfile, NULL);
2407 specified_data = image_spec_value (img->spec, QCdata, NULL);
2409 file = Qnil;
2410 GCPRO1 (file);
2412 if (NILP (specified_data))
2414 CFStringRef path;
2415 CFURLRef url;
2417 file = x_find_image_file (specified_file);
2418 if (!STRINGP (file))
2420 image_error ("Cannot find image file `%s'", specified_file, Qnil);
2421 UNGCPRO;
2422 return 0;
2424 path = cfstring_create_with_string (file);
2425 url = CFURLCreateWithFileSystemPath (NULL, path,
2426 kCFURLPOSIXPathStyle, 0);
2427 CFRelease (path);
2428 source = CGDataProviderCreateWithURL (url);
2429 CFRelease (url);
2431 else
2432 source = CGDataProviderCreateWithData (NULL, SDATA (specified_data),
2433 SBYTES (specified_data), NULL);
2435 if (png_p)
2436 image = (*MyCGImageCreateWithPNGDataProvider) (source, NULL, FALSE,
2437 kCGRenderingIntentDefault);
2438 else
2439 image = CGImageCreateWithJPEGDataProvider (source, NULL, FALSE,
2440 kCGRenderingIntentDefault);
2442 CGDataProviderRelease (source);
2443 if (image == NULL)
2445 UNGCPRO;
2446 image_error ("Error reading image `%s'", img->spec, Qnil);
2447 return 0;
2450 if (png_p)
2452 specified_bg = image_spec_value (img->spec, QCbackground, NULL);
2453 if (!STRINGP (specified_bg) ||
2454 !mac_defined_color (f, SDATA (specified_bg), &color, 0))
2456 color.pixel = FRAME_BACKGROUND_PIXEL (f);
2457 color.red = RED16_FROM_ULONG (color.pixel);
2458 color.green = GREEN16_FROM_ULONG (color.pixel);
2459 color.blue = BLUE16_FROM_ULONG (color.pixel);
2462 width = img->width = CGImageGetWidth (image);
2463 height = img->height = CGImageGetHeight (image);
2464 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
2466 CGImageRelease (image);
2467 UNGCPRO;
2468 return 0;
2470 rectangle = CGRectMake (0, 0, width, height);
2471 QDBeginCGContext (ximg, &context);
2472 if (png_p)
2474 CGContextSetRGBFillColor (context, color.red / 65535.0,
2475 color.green / 65535.0,
2476 color.blue / 65535.0, 1.0);
2477 CGContextFillRect (context, rectangle);
2479 CGContextDrawImage (context, rectangle, image);
2480 QDEndCGContext (ximg, &context);
2481 CGImageRelease (image);
2483 /* Maybe fill in the background field while we have ximg handy. */
2484 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
2485 IMAGE_BACKGROUND (img, f, ximg);
2487 /* Put the image into the pixmap. */
2488 x_put_x_image (f, ximg, img->pixmap, width, height);
2489 x_destroy_x_image (ximg);
2490 UNGCPRO;
2491 return 1;
2493 #endif
2495 #endif /* MAC_OS */
2498 /***********************************************************************
2499 XBM images
2500 ***********************************************************************/
2502 static int xbm_scan P_ ((unsigned char **, unsigned char *, char *, int *));
2503 static int xbm_load P_ ((struct frame *f, struct image *img));
2504 static int xbm_load_image P_ ((struct frame *f, struct image *img,
2505 unsigned char *, unsigned char *));
2506 static int xbm_image_p P_ ((Lisp_Object object));
2507 static int xbm_read_bitmap_data P_ ((unsigned char *, unsigned char *,
2508 int *, int *, unsigned char **));
2509 static int xbm_file_p P_ ((Lisp_Object));
2512 /* Indices of image specification fields in xbm_format, below. */
2514 enum xbm_keyword_index
2516 XBM_TYPE,
2517 XBM_FILE,
2518 XBM_WIDTH,
2519 XBM_HEIGHT,
2520 XBM_DATA,
2521 XBM_FOREGROUND,
2522 XBM_BACKGROUND,
2523 XBM_ASCENT,
2524 XBM_MARGIN,
2525 XBM_RELIEF,
2526 XBM_ALGORITHM,
2527 XBM_HEURISTIC_MASK,
2528 XBM_MASK,
2529 XBM_LAST
2532 /* Vector of image_keyword structures describing the format
2533 of valid XBM image specifications. */
2535 static struct image_keyword xbm_format[XBM_LAST] =
2537 {":type", IMAGE_SYMBOL_VALUE, 1},
2538 {":file", IMAGE_STRING_VALUE, 0},
2539 {":width", IMAGE_POSITIVE_INTEGER_VALUE, 0},
2540 {":height", IMAGE_POSITIVE_INTEGER_VALUE, 0},
2541 {":data", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
2542 {":foreground", IMAGE_STRING_OR_NIL_VALUE, 0},
2543 {":background", IMAGE_STRING_OR_NIL_VALUE, 0},
2544 {":ascent", IMAGE_ASCENT_VALUE, 0},
2545 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
2546 {":relief", IMAGE_INTEGER_VALUE, 0},
2547 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
2548 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
2549 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
2552 /* Structure describing the image type XBM. */
2554 static struct image_type xbm_type =
2556 &Qxbm,
2557 xbm_image_p,
2558 xbm_load,
2559 x_clear_image,
2560 NULL
2563 /* Tokens returned from xbm_scan. */
2565 enum xbm_token
2567 XBM_TK_IDENT = 256,
2568 XBM_TK_NUMBER
2572 /* Return non-zero if OBJECT is a valid XBM-type image specification.
2573 A valid specification is a list starting with the symbol `image'
2574 The rest of the list is a property list which must contain an
2575 entry `:type xbm..
2577 If the specification specifies a file to load, it must contain
2578 an entry `:file FILENAME' where FILENAME is a string.
2580 If the specification is for a bitmap loaded from memory it must
2581 contain `:width WIDTH', `:height HEIGHT', and `:data DATA', where
2582 WIDTH and HEIGHT are integers > 0. DATA may be:
2584 1. a string large enough to hold the bitmap data, i.e. it must
2585 have a size >= (WIDTH + 7) / 8 * HEIGHT
2587 2. a bool-vector of size >= WIDTH * HEIGHT
2589 3. a vector of strings or bool-vectors, one for each line of the
2590 bitmap.
2592 4. A string containing an in-memory XBM file. WIDTH and HEIGHT
2593 may not be specified in this case because they are defined in the
2594 XBM file.
2596 Both the file and data forms may contain the additional entries
2597 `:background COLOR' and `:foreground COLOR'. If not present,
2598 foreground and background of the frame on which the image is
2599 displayed is used. */
2601 static int
2602 xbm_image_p (object)
2603 Lisp_Object object;
2605 struct image_keyword kw[XBM_LAST];
2607 bcopy (xbm_format, kw, sizeof kw);
2608 if (!parse_image_spec (object, kw, XBM_LAST, Qxbm))
2609 return 0;
2611 xassert (EQ (kw[XBM_TYPE].value, Qxbm));
2613 if (kw[XBM_FILE].count)
2615 if (kw[XBM_WIDTH].count || kw[XBM_HEIGHT].count || kw[XBM_DATA].count)
2616 return 0;
2618 else if (kw[XBM_DATA].count && xbm_file_p (kw[XBM_DATA].value))
2620 /* In-memory XBM file. */
2621 if (kw[XBM_WIDTH].count || kw[XBM_HEIGHT].count || kw[XBM_FILE].count)
2622 return 0;
2624 else
2626 Lisp_Object data;
2627 int width, height;
2629 /* Entries for `:width', `:height' and `:data' must be present. */
2630 if (!kw[XBM_WIDTH].count
2631 || !kw[XBM_HEIGHT].count
2632 || !kw[XBM_DATA].count)
2633 return 0;
2635 data = kw[XBM_DATA].value;
2636 width = XFASTINT (kw[XBM_WIDTH].value);
2637 height = XFASTINT (kw[XBM_HEIGHT].value);
2639 /* Check type of data, and width and height against contents of
2640 data. */
2641 if (VECTORP (data))
2643 int i;
2645 /* Number of elements of the vector must be >= height. */
2646 if (XVECTOR (data)->size < height)
2647 return 0;
2649 /* Each string or bool-vector in data must be large enough
2650 for one line of the image. */
2651 for (i = 0; i < height; ++i)
2653 Lisp_Object elt = XVECTOR (data)->contents[i];
2655 if (STRINGP (elt))
2657 if (SCHARS (elt)
2658 < (width + BITS_PER_CHAR - 1) / BITS_PER_CHAR)
2659 return 0;
2661 else if (BOOL_VECTOR_P (elt))
2663 if (XBOOL_VECTOR (elt)->size < width)
2664 return 0;
2666 else
2667 return 0;
2670 else if (STRINGP (data))
2672 if (SCHARS (data)
2673 < (width + BITS_PER_CHAR - 1) / BITS_PER_CHAR * height)
2674 return 0;
2676 else if (BOOL_VECTOR_P (data))
2678 if (XBOOL_VECTOR (data)->size < width * height)
2679 return 0;
2681 else
2682 return 0;
2685 return 1;
2689 /* Scan a bitmap file. FP is the stream to read from. Value is
2690 either an enumerator from enum xbm_token, or a character for a
2691 single-character token, or 0 at end of file. If scanning an
2692 identifier, store the lexeme of the identifier in SVAL. If
2693 scanning a number, store its value in *IVAL. */
2695 static int
2696 xbm_scan (s, end, sval, ival)
2697 unsigned char **s, *end;
2698 char *sval;
2699 int *ival;
2701 unsigned int c;
2703 loop:
2705 /* Skip white space. */
2706 while (*s < end && (c = *(*s)++, isspace (c)))
2709 if (*s >= end)
2710 c = 0;
2711 else if (isdigit (c))
2713 int value = 0, digit;
2715 if (c == '0' && *s < end)
2717 c = *(*s)++;
2718 if (c == 'x' || c == 'X')
2720 while (*s < end)
2722 c = *(*s)++;
2723 if (isdigit (c))
2724 digit = c - '0';
2725 else if (c >= 'a' && c <= 'f')
2726 digit = c - 'a' + 10;
2727 else if (c >= 'A' && c <= 'F')
2728 digit = c - 'A' + 10;
2729 else
2730 break;
2731 value = 16 * value + digit;
2734 else if (isdigit (c))
2736 value = c - '0';
2737 while (*s < end
2738 && (c = *(*s)++, isdigit (c)))
2739 value = 8 * value + c - '0';
2742 else
2744 value = c - '0';
2745 while (*s < end
2746 && (c = *(*s)++, isdigit (c)))
2747 value = 10 * value + c - '0';
2750 if (*s < end)
2751 *s = *s - 1;
2752 *ival = value;
2753 c = XBM_TK_NUMBER;
2755 else if (isalpha (c) || c == '_')
2757 *sval++ = c;
2758 while (*s < end
2759 && (c = *(*s)++, (isalnum (c) || c == '_')))
2760 *sval++ = c;
2761 *sval = 0;
2762 if (*s < end)
2763 *s = *s - 1;
2764 c = XBM_TK_IDENT;
2766 else if (c == '/' && **s == '*')
2768 /* C-style comment. */
2769 ++*s;
2770 while (**s && (**s != '*' || *(*s + 1) != '/'))
2771 ++*s;
2772 if (**s)
2774 *s += 2;
2775 goto loop;
2779 return c;
2782 #ifdef HAVE_NTGUI
2784 /* Create a Windows bitmap from X bitmap data. */
2785 static HBITMAP
2786 w32_create_pixmap_from_bitmap_data (int width, int height, char *data)
2788 static unsigned char swap_nibble[16]
2789 = { 0x0, 0x8, 0x4, 0xc, /* 0000 1000 0100 1100 */
2790 0x2, 0xa, 0x6, 0xe, /* 0010 1010 0110 1110 */
2791 0x1, 0x9, 0x5, 0xd, /* 0001 1001 0101 1101 */
2792 0x3, 0xb, 0x7, 0xf }; /* 0011 1011 0111 1111 */
2793 int i, j, w1, w2;
2794 unsigned char *bits, *p;
2795 HBITMAP bmp;
2797 w1 = (width + 7) / 8; /* nb of 8bits elt in X bitmap */
2798 w2 = ((width + 15) / 16) * 2; /* nb of 16bits elt in W32 bitmap */
2799 bits = (unsigned char *) alloca (height * w2);
2800 bzero (bits, height * w2);
2801 for (i = 0; i < height; i++)
2803 p = bits + i*w2;
2804 for (j = 0; j < w1; j++)
2806 /* Bitswap XBM bytes to match how Windows does things. */
2807 unsigned char c = *data++;
2808 *p++ = (unsigned char)((swap_nibble[c & 0xf] << 4)
2809 | (swap_nibble[(c>>4) & 0xf]));
2812 bmp = CreateBitmap (width, height, 1, 1, (char *) bits);
2814 return bmp;
2817 static void convert_mono_to_color_image (f, img, foreground, background)
2818 struct frame *f;
2819 struct image *img;
2820 COLORREF foreground, background;
2822 HDC hdc, old_img_dc, new_img_dc;
2823 HGDIOBJ old_prev, new_prev;
2824 HBITMAP new_pixmap;
2826 hdc = get_frame_dc (f);
2827 old_img_dc = CreateCompatibleDC (hdc);
2828 new_img_dc = CreateCompatibleDC (hdc);
2829 new_pixmap = CreateCompatibleBitmap (hdc, img->width, img->height);
2830 release_frame_dc (f, hdc);
2831 old_prev = SelectObject (old_img_dc, img->pixmap);
2832 new_prev = SelectObject (new_img_dc, new_pixmap);
2833 SetTextColor (new_img_dc, foreground);
2834 SetBkColor (new_img_dc, background);
2836 BitBlt (new_img_dc, 0, 0, img->width, img->height, old_img_dc,
2837 0, 0, SRCCOPY);
2839 SelectObject (old_img_dc, old_prev);
2840 SelectObject (new_img_dc, new_prev);
2841 DeleteDC (old_img_dc);
2842 DeleteDC (new_img_dc);
2843 DeleteObject (img->pixmap);
2844 if (new_pixmap == 0)
2845 fprintf (stderr, "Failed to convert image to color.\n");
2846 else
2847 img->pixmap = new_pixmap;
2850 #define XBM_BIT_SHUFFLE(b) (~(b))
2852 #else
2854 #define XBM_BIT_SHUFFLE(b) (b)
2856 #endif /* HAVE_NTGUI */
2859 static void
2860 Create_Pixmap_From_Bitmap_Data(f, img, data, fg, bg, non_default_colors)
2861 struct frame *f;
2862 struct image *img;
2863 char *data;
2864 RGB_PIXEL_COLOR fg, bg;
2865 int non_default_colors;
2867 #ifdef HAVE_NTGUI
2868 img->pixmap
2869 = w32_create_pixmap_from_bitmap_data (img->width, img->height, data);
2871 /* If colors were specified, transfer the bitmap to a color one. */
2872 if (non_default_colors)
2873 convert_mono_to_color_image (f, img, fg, bg);
2874 #else
2875 img->pixmap
2876 = XCreatePixmapFromBitmapData (FRAME_X_DISPLAY (f),
2877 FRAME_X_WINDOW (f),
2878 data,
2879 img->width, img->height,
2880 fg, bg,
2881 DefaultDepthOfScreen (FRAME_X_SCREEN (f)));
2882 #endif /* HAVE_NTGUI */
2887 /* Replacement for XReadBitmapFileData which isn't available under old
2888 X versions. CONTENTS is a pointer to a buffer to parse; END is the
2889 buffer's end. Set *WIDTH and *HEIGHT to the width and height of
2890 the image. Return in *DATA the bitmap data allocated with xmalloc.
2891 Value is non-zero if successful. DATA null means just test if
2892 CONTENTS looks like an in-memory XBM file. */
2894 static int
2895 xbm_read_bitmap_data (contents, end, width, height, data)
2896 unsigned char *contents, *end;
2897 int *width, *height;
2898 unsigned char **data;
2900 unsigned char *s = contents;
2901 char buffer[BUFSIZ];
2902 int padding_p = 0;
2903 int v10 = 0;
2904 int bytes_per_line, i, nbytes;
2905 unsigned char *p;
2906 int value;
2907 int LA1;
2909 #define match() \
2910 LA1 = xbm_scan (&s, end, buffer, &value)
2912 #define expect(TOKEN) \
2913 if (LA1 != (TOKEN)) \
2914 goto failure; \
2915 else \
2916 match ()
2918 #define expect_ident(IDENT) \
2919 if (LA1 == XBM_TK_IDENT && strcmp (buffer, (IDENT)) == 0) \
2920 match (); \
2921 else \
2922 goto failure
2924 *width = *height = -1;
2925 if (data)
2926 *data = NULL;
2927 LA1 = xbm_scan (&s, end, buffer, &value);
2929 /* Parse defines for width, height and hot-spots. */
2930 while (LA1 == '#')
2932 match ();
2933 expect_ident ("define");
2934 expect (XBM_TK_IDENT);
2936 if (LA1 == XBM_TK_NUMBER);
2938 char *p = strrchr (buffer, '_');
2939 p = p ? p + 1 : buffer;
2940 if (strcmp (p, "width") == 0)
2941 *width = value;
2942 else if (strcmp (p, "height") == 0)
2943 *height = value;
2945 expect (XBM_TK_NUMBER);
2948 if (*width < 0 || *height < 0)
2949 goto failure;
2950 else if (data == NULL)
2951 goto success;
2953 /* Parse bits. Must start with `static'. */
2954 expect_ident ("static");
2955 if (LA1 == XBM_TK_IDENT)
2957 if (strcmp (buffer, "unsigned") == 0)
2959 match ();
2960 expect_ident ("char");
2962 else if (strcmp (buffer, "short") == 0)
2964 match ();
2965 v10 = 1;
2966 if (*width % 16 && *width % 16 < 9)
2967 padding_p = 1;
2969 else if (strcmp (buffer, "char") == 0)
2970 match ();
2971 else
2972 goto failure;
2974 else
2975 goto failure;
2977 expect (XBM_TK_IDENT);
2978 expect ('[');
2979 expect (']');
2980 expect ('=');
2981 expect ('{');
2983 bytes_per_line = (*width + 7) / 8 + padding_p;
2984 nbytes = bytes_per_line * *height;
2985 p = *data = (char *) xmalloc (nbytes);
2987 if (v10)
2989 for (i = 0; i < nbytes; i += 2)
2991 int val = value;
2992 expect (XBM_TK_NUMBER);
2994 *p++ = XBM_BIT_SHUFFLE (val);
2995 if (!padding_p || ((i + 2) % bytes_per_line))
2996 *p++ = XBM_BIT_SHUFFLE (value >> 8);
2998 if (LA1 == ',' || LA1 == '}')
2999 match ();
3000 else
3001 goto failure;
3004 else
3006 for (i = 0; i < nbytes; ++i)
3008 int val = value;
3009 expect (XBM_TK_NUMBER);
3011 *p++ = XBM_BIT_SHUFFLE (val);
3013 if (LA1 == ',' || LA1 == '}')
3014 match ();
3015 else
3016 goto failure;
3020 success:
3021 return 1;
3023 failure:
3025 if (data && *data)
3027 xfree (*data);
3028 *data = NULL;
3030 return 0;
3032 #undef match
3033 #undef expect
3034 #undef expect_ident
3038 /* Load XBM image IMG which will be displayed on frame F from buffer
3039 CONTENTS. END is the end of the buffer. Value is non-zero if
3040 successful. */
3042 static int
3043 xbm_load_image (f, img, contents, end)
3044 struct frame *f;
3045 struct image *img;
3046 unsigned char *contents, *end;
3048 int rc;
3049 unsigned char *data;
3050 int success_p = 0;
3052 rc = xbm_read_bitmap_data (contents, end, &img->width, &img->height, &data);
3053 if (rc)
3055 unsigned long foreground = FRAME_FOREGROUND_PIXEL (f);
3056 unsigned long background = FRAME_BACKGROUND_PIXEL (f);
3057 int non_default_colors = 0;
3058 Lisp_Object value;
3060 xassert (img->width > 0 && img->height > 0);
3062 /* Get foreground and background colors, maybe allocate colors. */
3063 value = image_spec_value (img->spec, QCforeground, NULL);
3064 if (!NILP (value))
3066 foreground = x_alloc_image_color (f, img, value, foreground);
3067 non_default_colors = 1;
3069 value = image_spec_value (img->spec, QCbackground, NULL);
3070 if (!NILP (value))
3072 background = x_alloc_image_color (f, img, value, background);
3073 img->background = background;
3074 img->background_valid = 1;
3075 non_default_colors = 1;
3078 Create_Pixmap_From_Bitmap_Data (f, img, data,
3079 foreground, background,
3080 non_default_colors);
3081 xfree (data);
3083 if (img->pixmap == NO_PIXMAP)
3085 x_clear_image (f, img);
3086 image_error ("Unable to create X pixmap for `%s'", img->spec, Qnil);
3088 else
3089 success_p = 1;
3091 else
3092 image_error ("Error loading XBM image `%s'", img->spec, Qnil);
3094 return success_p;
3098 /* Value is non-zero if DATA looks like an in-memory XBM file. */
3100 static int
3101 xbm_file_p (data)
3102 Lisp_Object data;
3104 int w, h;
3105 return (STRINGP (data)
3106 && xbm_read_bitmap_data (SDATA (data),
3107 (SDATA (data)
3108 + SBYTES (data)),
3109 &w, &h, NULL));
3113 /* Fill image IMG which is used on frame F with pixmap data. Value is
3114 non-zero if successful. */
3116 static int
3117 xbm_load (f, img)
3118 struct frame *f;
3119 struct image *img;
3121 int success_p = 0;
3122 Lisp_Object file_name;
3124 xassert (xbm_image_p (img->spec));
3126 /* If IMG->spec specifies a file name, create a non-file spec from it. */
3127 file_name = image_spec_value (img->spec, QCfile, NULL);
3128 if (STRINGP (file_name))
3130 Lisp_Object file;
3131 unsigned char *contents;
3132 int size;
3133 struct gcpro gcpro1;
3135 file = x_find_image_file (file_name);
3136 GCPRO1 (file);
3137 if (!STRINGP (file))
3139 image_error ("Cannot find image file `%s'", file_name, Qnil);
3140 UNGCPRO;
3141 return 0;
3144 contents = slurp_file (SDATA (file), &size);
3145 if (contents == NULL)
3147 image_error ("Error loading XBM image `%s'", img->spec, Qnil);
3148 UNGCPRO;
3149 return 0;
3152 success_p = xbm_load_image (f, img, contents, contents + size);
3153 UNGCPRO;
3155 else
3157 struct image_keyword fmt[XBM_LAST];
3158 Lisp_Object data;
3159 unsigned long foreground = FRAME_FOREGROUND_PIXEL (f);
3160 unsigned long background = FRAME_BACKGROUND_PIXEL (f);
3161 int non_default_colors = 0;
3162 char *bits;
3163 int parsed_p;
3164 int in_memory_file_p = 0;
3166 /* See if data looks like an in-memory XBM file. */
3167 data = image_spec_value (img->spec, QCdata, NULL);
3168 in_memory_file_p = xbm_file_p (data);
3170 /* Parse the image specification. */
3171 bcopy (xbm_format, fmt, sizeof fmt);
3172 parsed_p = parse_image_spec (img->spec, fmt, XBM_LAST, Qxbm);
3173 xassert (parsed_p);
3175 /* Get specified width, and height. */
3176 if (!in_memory_file_p)
3178 img->width = XFASTINT (fmt[XBM_WIDTH].value);
3179 img->height = XFASTINT (fmt[XBM_HEIGHT].value);
3180 xassert (img->width > 0 && img->height > 0);
3183 /* Get foreground and background colors, maybe allocate colors. */
3184 if (fmt[XBM_FOREGROUND].count
3185 && STRINGP (fmt[XBM_FOREGROUND].value))
3187 foreground = x_alloc_image_color (f, img, fmt[XBM_FOREGROUND].value,
3188 foreground);
3189 non_default_colors = 1;
3192 if (fmt[XBM_BACKGROUND].count
3193 && STRINGP (fmt[XBM_BACKGROUND].value))
3195 background = x_alloc_image_color (f, img, fmt[XBM_BACKGROUND].value,
3196 background);
3197 non_default_colors = 1;
3200 if (in_memory_file_p)
3201 success_p = xbm_load_image (f, img, SDATA (data),
3202 (SDATA (data)
3203 + SBYTES (data)));
3204 else
3206 if (VECTORP (data))
3208 int i;
3209 char *p;
3210 int nbytes = (img->width + BITS_PER_CHAR - 1) / BITS_PER_CHAR;
3212 p = bits = (char *) alloca (nbytes * img->height);
3213 for (i = 0; i < img->height; ++i, p += nbytes)
3215 Lisp_Object line = XVECTOR (data)->contents[i];
3216 if (STRINGP (line))
3217 bcopy (SDATA (line), p, nbytes);
3218 else
3219 bcopy (XBOOL_VECTOR (line)->data, p, nbytes);
3222 else if (STRINGP (data))
3223 bits = SDATA (data);
3224 else
3225 bits = XBOOL_VECTOR (data)->data;
3227 /* Create the pixmap. */
3229 Create_Pixmap_From_Bitmap_Data (f, img, bits,
3230 foreground, background,
3231 non_default_colors);
3232 if (img->pixmap)
3233 success_p = 1;
3234 else
3236 image_error ("Unable to create pixmap for XBM image `%s'",
3237 img->spec, Qnil);
3238 x_clear_image (f, img);
3243 return success_p;
3248 /***********************************************************************
3249 XPM images
3250 ***********************************************************************/
3252 #if defined (HAVE_XPM) || defined (MAC_OS)
3254 static int xpm_image_p P_ ((Lisp_Object object));
3255 static int xpm_load P_ ((struct frame *f, struct image *img));
3256 static int xpm_valid_color_symbols_p P_ ((Lisp_Object));
3258 #endif /* HAVE_XPM || MAC_OS */
3260 #ifdef HAVE_XPM
3261 #ifdef HAVE_NTGUI
3262 /* Indicate to xpm.h that we don't have Xlib. */
3263 #define FOR_MSW
3264 /* simx.h in xpm defines XColor and XImage differently than Emacs. */
3265 /* It also defines Display the same way as Emacs, but gcc 3.3 still barfs. */
3266 #define XColor xpm_XColor
3267 #define XImage xpm_XImage
3268 #define Display xpm_Display
3269 #define PIXEL_ALREADY_TYPEDEFED
3270 #include "X11/xpm.h"
3271 #undef FOR_MSW
3272 #undef XColor
3273 #undef XImage
3274 #undef Display
3275 #undef PIXEL_ALREADY_TYPEDEFED
3276 #else
3277 #include "X11/xpm.h"
3278 #endif /* HAVE_NTGUI */
3279 #endif /* HAVE_XPM */
3281 #if defined (HAVE_XPM) || defined (MAC_OS)
3282 /* The symbol `xpm' identifying XPM-format images. */
3284 Lisp_Object Qxpm;
3286 /* Indices of image specification fields in xpm_format, below. */
3288 enum xpm_keyword_index
3290 XPM_TYPE,
3291 XPM_FILE,
3292 XPM_DATA,
3293 XPM_ASCENT,
3294 XPM_MARGIN,
3295 XPM_RELIEF,
3296 XPM_ALGORITHM,
3297 XPM_HEURISTIC_MASK,
3298 XPM_MASK,
3299 XPM_COLOR_SYMBOLS,
3300 XPM_BACKGROUND,
3301 XPM_LAST
3304 /* Vector of image_keyword structures describing the format
3305 of valid XPM image specifications. */
3307 static struct image_keyword xpm_format[XPM_LAST] =
3309 {":type", IMAGE_SYMBOL_VALUE, 1},
3310 {":file", IMAGE_STRING_VALUE, 0},
3311 {":data", IMAGE_STRING_VALUE, 0},
3312 {":ascent", IMAGE_ASCENT_VALUE, 0},
3313 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
3314 {":relief", IMAGE_INTEGER_VALUE, 0},
3315 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
3316 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
3317 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
3318 {":color-symbols", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
3319 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
3322 /* Structure describing the image type XPM. */
3324 static struct image_type xpm_type =
3326 &Qxpm,
3327 xpm_image_p,
3328 xpm_load,
3329 x_clear_image,
3330 NULL
3333 #ifdef HAVE_X_WINDOWS
3335 /* Define ALLOC_XPM_COLORS if we can use Emacs' own color allocation
3336 functions for allocating image colors. Our own functions handle
3337 color allocation failures more gracefully than the ones on the XPM
3338 lib. */
3340 #if defined XpmAllocColor && defined XpmFreeColors && defined XpmColorClosure
3341 #define ALLOC_XPM_COLORS
3342 #endif
3343 #endif /* HAVE_X_WINDOWS */
3345 #ifdef ALLOC_XPM_COLORS
3347 static void xpm_init_color_cache P_ ((struct frame *, XpmAttributes *));
3348 static void xpm_free_color_cache P_ ((void));
3349 static int xpm_lookup_color P_ ((struct frame *, char *, XColor *));
3350 static int xpm_color_bucket P_ ((char *));
3351 static struct xpm_cached_color *xpm_cache_color P_ ((struct frame *, char *,
3352 XColor *, int));
3354 /* An entry in a hash table used to cache color definitions of named
3355 colors. This cache is necessary to speed up XPM image loading in
3356 case we do color allocations ourselves. Without it, we would need
3357 a call to XParseColor per pixel in the image. */
3359 struct xpm_cached_color
3361 /* Next in collision chain. */
3362 struct xpm_cached_color *next;
3364 /* Color definition (RGB and pixel color). */
3365 XColor color;
3367 /* Color name. */
3368 char name[1];
3371 /* The hash table used for the color cache, and its bucket vector
3372 size. */
3374 #define XPM_COLOR_CACHE_BUCKETS 1001
3375 struct xpm_cached_color **xpm_color_cache;
3377 /* Initialize the color cache. */
3379 static void
3380 xpm_init_color_cache (f, attrs)
3381 struct frame *f;
3382 XpmAttributes *attrs;
3384 size_t nbytes = XPM_COLOR_CACHE_BUCKETS * sizeof *xpm_color_cache;
3385 xpm_color_cache = (struct xpm_cached_color **) xmalloc (nbytes);
3386 memset (xpm_color_cache, 0, nbytes);
3387 init_color_table ();
3389 if (attrs->valuemask & XpmColorSymbols)
3391 int i;
3392 XColor color;
3394 for (i = 0; i < attrs->numsymbols; ++i)
3395 if (XParseColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
3396 attrs->colorsymbols[i].value, &color))
3398 color.pixel = lookup_rgb_color (f, color.red, color.green,
3399 color.blue);
3400 xpm_cache_color (f, attrs->colorsymbols[i].name, &color, -1);
3405 /* Free the color cache. */
3407 static void
3408 xpm_free_color_cache ()
3410 struct xpm_cached_color *p, *next;
3411 int i;
3413 for (i = 0; i < XPM_COLOR_CACHE_BUCKETS; ++i)
3414 for (p = xpm_color_cache[i]; p; p = next)
3416 next = p->next;
3417 xfree (p);
3420 xfree (xpm_color_cache);
3421 xpm_color_cache = NULL;
3422 free_color_table ();
3425 /* Return the bucket index for color named COLOR_NAME in the color
3426 cache. */
3428 static int
3429 xpm_color_bucket (color_name)
3430 char *color_name;
3432 unsigned h = 0;
3433 char *s;
3435 for (s = color_name; *s; ++s)
3436 h = (h << 2) ^ *s;
3437 return h %= XPM_COLOR_CACHE_BUCKETS;
3441 /* On frame F, cache values COLOR for color with name COLOR_NAME.
3442 BUCKET, if >= 0, is a precomputed bucket index. Value is the cache
3443 entry added. */
3445 static struct xpm_cached_color *
3446 xpm_cache_color (f, color_name, color, bucket)
3447 struct frame *f;
3448 char *color_name;
3449 XColor *color;
3450 int bucket;
3452 size_t nbytes;
3453 struct xpm_cached_color *p;
3455 if (bucket < 0)
3456 bucket = xpm_color_bucket (color_name);
3458 nbytes = sizeof *p + strlen (color_name);
3459 p = (struct xpm_cached_color *) xmalloc (nbytes);
3460 strcpy (p->name, color_name);
3461 p->color = *color;
3462 p->next = xpm_color_cache[bucket];
3463 xpm_color_cache[bucket] = p;
3464 return p;
3467 /* Look up color COLOR_NAME for frame F in the color cache. If found,
3468 return the cached definition in *COLOR. Otherwise, make a new
3469 entry in the cache and allocate the color. Value is zero if color
3470 allocation failed. */
3472 static int
3473 xpm_lookup_color (f, color_name, color)
3474 struct frame *f;
3475 char *color_name;
3476 XColor *color;
3478 struct xpm_cached_color *p;
3479 int h = xpm_color_bucket (color_name);
3481 for (p = xpm_color_cache[h]; p; p = p->next)
3482 if (strcmp (p->name, color_name) == 0)
3483 break;
3485 if (p != NULL)
3486 *color = p->color;
3487 else if (XParseColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
3488 color_name, color))
3490 color->pixel = lookup_rgb_color (f, color->red, color->green,
3491 color->blue);
3492 p = xpm_cache_color (f, color_name, color, h);
3494 /* You get `opaque' at least from ImageMagick converting pbm to xpm
3495 with transparency, and it's useful. */
3496 else if (strcmp ("opaque", color_name) == 0)
3498 bzero (color, sizeof (XColor)); /* Is this necessary/correct? */
3499 color->pixel = FRAME_FOREGROUND_PIXEL (f);
3500 p = xpm_cache_color (f, color_name, color, h);
3503 return p != NULL;
3507 /* Callback for allocating color COLOR_NAME. Called from the XPM lib.
3508 CLOSURE is a pointer to the frame on which we allocate the
3509 color. Return in *COLOR the allocated color. Value is non-zero
3510 if successful. */
3512 static int
3513 xpm_alloc_color (dpy, cmap, color_name, color, closure)
3514 Display *dpy;
3515 Colormap cmap;
3516 char *color_name;
3517 XColor *color;
3518 void *closure;
3520 return xpm_lookup_color ((struct frame *) closure, color_name, color);
3524 /* Callback for freeing NPIXELS colors contained in PIXELS. CLOSURE
3525 is a pointer to the frame on which we allocate the color. Value is
3526 non-zero if successful. */
3528 static int
3529 xpm_free_colors (dpy, cmap, pixels, npixels, closure)
3530 Display *dpy;
3531 Colormap cmap;
3532 Pixel *pixels;
3533 int npixels;
3534 void *closure;
3536 return 1;
3539 #endif /* ALLOC_XPM_COLORS */
3542 #ifdef HAVE_NTGUI
3544 /* XPM library details. */
3546 DEF_IMGLIB_FN (XpmFreeAttributes);
3547 DEF_IMGLIB_FN (XpmCreateImageFromBuffer);
3548 DEF_IMGLIB_FN (XpmReadFileToImage);
3549 DEF_IMGLIB_FN (XImageFree);
3551 static int
3552 init_xpm_functions (Lisp_Object libraries)
3554 HMODULE library;
3556 if (!(library = w32_delayed_load (libraries, Qxpm)))
3557 return 0;
3559 LOAD_IMGLIB_FN (library, XpmFreeAttributes);
3560 LOAD_IMGLIB_FN (library, XpmCreateImageFromBuffer);
3561 LOAD_IMGLIB_FN (library, XpmReadFileToImage);
3562 LOAD_IMGLIB_FN (library, XImageFree);
3563 return 1;
3566 #endif /* HAVE_NTGUI */
3569 /* Value is non-zero if COLOR_SYMBOLS is a valid color symbols list
3570 for XPM images. Such a list must consist of conses whose car and
3571 cdr are strings. */
3573 static int
3574 xpm_valid_color_symbols_p (color_symbols)
3575 Lisp_Object color_symbols;
3577 while (CONSP (color_symbols))
3579 Lisp_Object sym = XCAR (color_symbols);
3580 if (!CONSP (sym)
3581 || !STRINGP (XCAR (sym))
3582 || !STRINGP (XCDR (sym)))
3583 break;
3584 color_symbols = XCDR (color_symbols);
3587 return NILP (color_symbols);
3591 /* Value is non-zero if OBJECT is a valid XPM image specification. */
3593 static int
3594 xpm_image_p (object)
3595 Lisp_Object object;
3597 struct image_keyword fmt[XPM_LAST];
3598 bcopy (xpm_format, fmt, sizeof fmt);
3599 return (parse_image_spec (object, fmt, XPM_LAST, Qxpm)
3600 /* Either `:file' or `:data' must be present. */
3601 && fmt[XPM_FILE].count + fmt[XPM_DATA].count == 1
3602 /* Either no `:color-symbols' or it's a list of conses
3603 whose car and cdr are strings. */
3604 && (fmt[XPM_COLOR_SYMBOLS].count == 0
3605 || xpm_valid_color_symbols_p (fmt[XPM_COLOR_SYMBOLS].value)));
3608 #endif /* HAVE_XPM || MAC_OS */
3610 /* Load image IMG which will be displayed on frame F. Value is
3611 non-zero if successful. */
3613 #ifdef HAVE_XPM
3615 static int
3616 xpm_load (f, img)
3617 struct frame *f;
3618 struct image *img;
3620 int rc;
3621 XpmAttributes attrs;
3622 Lisp_Object specified_file, color_symbols;
3623 #ifdef HAVE_NTGUI
3624 HDC hdc;
3625 xpm_XImage * xpm_image = NULL, * xpm_mask = NULL;
3626 #endif /* HAVE_NTGUI */
3628 /* Configure the XPM lib. Use the visual of frame F. Allocate
3629 close colors. Return colors allocated. */
3630 bzero (&attrs, sizeof attrs);
3632 #ifndef HAVE_NTGUI
3633 attrs.visual = FRAME_X_VISUAL (f);
3634 attrs.colormap = FRAME_X_COLORMAP (f);
3635 attrs.valuemask |= XpmVisual;
3636 attrs.valuemask |= XpmColormap;
3637 #endif /* HAVE_NTGUI */
3639 #ifdef ALLOC_XPM_COLORS
3640 /* Allocate colors with our own functions which handle
3641 failing color allocation more gracefully. */
3642 attrs.color_closure = f;
3643 attrs.alloc_color = xpm_alloc_color;
3644 attrs.free_colors = xpm_free_colors;
3645 attrs.valuemask |= XpmAllocColor | XpmFreeColors | XpmColorClosure;
3646 #else /* not ALLOC_XPM_COLORS */
3647 /* Let the XPM lib allocate colors. */
3648 attrs.valuemask |= XpmReturnAllocPixels;
3649 #ifdef XpmAllocCloseColors
3650 attrs.alloc_close_colors = 1;
3651 attrs.valuemask |= XpmAllocCloseColors;
3652 #else /* not XpmAllocCloseColors */
3653 attrs.closeness = 600;
3654 attrs.valuemask |= XpmCloseness;
3655 #endif /* not XpmAllocCloseColors */
3656 #endif /* ALLOC_XPM_COLORS */
3658 /* If image specification contains symbolic color definitions, add
3659 these to `attrs'. */
3660 color_symbols = image_spec_value (img->spec, QCcolor_symbols, NULL);
3661 if (CONSP (color_symbols))
3663 Lisp_Object tail;
3664 XpmColorSymbol *xpm_syms;
3665 int i, size;
3667 attrs.valuemask |= XpmColorSymbols;
3669 /* Count number of symbols. */
3670 attrs.numsymbols = 0;
3671 for (tail = color_symbols; CONSP (tail); tail = XCDR (tail))
3672 ++attrs.numsymbols;
3674 /* Allocate an XpmColorSymbol array. */
3675 size = attrs.numsymbols * sizeof *xpm_syms;
3676 xpm_syms = (XpmColorSymbol *) alloca (size);
3677 bzero (xpm_syms, size);
3678 attrs.colorsymbols = xpm_syms;
3680 /* Fill the color symbol array. */
3681 for (tail = color_symbols, i = 0;
3682 CONSP (tail);
3683 ++i, tail = XCDR (tail))
3685 Lisp_Object name = XCAR (XCAR (tail));
3686 Lisp_Object color = XCDR (XCAR (tail));
3687 xpm_syms[i].name = (char *) alloca (SCHARS (name) + 1);
3688 strcpy (xpm_syms[i].name, SDATA (name));
3689 xpm_syms[i].value = (char *) alloca (SCHARS (color) + 1);
3690 strcpy (xpm_syms[i].value, SDATA (color));
3694 /* Create a pixmap for the image, either from a file, or from a
3695 string buffer containing data in the same format as an XPM file. */
3696 #ifdef ALLOC_XPM_COLORS
3697 xpm_init_color_cache (f, &attrs);
3698 #endif
3700 specified_file = image_spec_value (img->spec, QCfile, NULL);
3702 #ifdef HAVE_NTGUI
3704 HDC frame_dc = get_frame_dc (f);
3705 hdc = CreateCompatibleDC (frame_dc);
3706 release_frame_dc (f, frame_dc);
3708 #endif /* HAVE_NTGUI */
3710 if (STRINGP (specified_file))
3712 Lisp_Object file = x_find_image_file (specified_file);
3713 if (!STRINGP (file))
3715 image_error ("Cannot find image file `%s'", specified_file, Qnil);
3716 return 0;
3719 #ifdef HAVE_NTGUI
3720 /* XpmReadFileToPixmap is not available in the Windows port of
3721 libxpm. But XpmReadFileToImage almost does what we want. */
3722 rc = fn_XpmReadFileToImage (&hdc, SDATA (file),
3723 &xpm_image, &xpm_mask,
3724 &attrs);
3725 #else
3726 rc = XpmReadFileToPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3727 SDATA (file), &img->pixmap, &img->mask,
3728 &attrs);
3729 #endif /* HAVE_NTGUI */
3731 else
3733 Lisp_Object buffer = image_spec_value (img->spec, QCdata, NULL);
3734 #ifdef HAVE_NTGUI
3735 /* XpmCreatePixmapFromBuffer is not available in the Windows port
3736 of libxpm. But XpmCreateImageFromBuffer almost does what we want. */
3737 rc = fn_XpmCreateImageFromBuffer (&hdc, SDATA (buffer),
3738 &xpm_image, &xpm_mask,
3739 &attrs);
3740 #else
3741 rc = XpmCreatePixmapFromBuffer (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3742 SDATA (buffer),
3743 &img->pixmap, &img->mask,
3744 &attrs);
3745 #endif /* HAVE_NTGUI */
3748 if (rc == XpmSuccess)
3750 #if defined (COLOR_TABLE_SUPPORT) && defined (ALLOC_XPM_COLORS)
3751 img->colors = colors_in_color_table (&img->ncolors);
3752 #else /* not ALLOC_XPM_COLORS */
3753 int i;
3755 #ifdef HAVE_NTGUI
3756 /* W32 XPM uses XImage to wrap what W32 Emacs calls a Pixmap,
3757 plus some duplicate attributes. */
3758 if (xpm_image && xpm_image->bitmap)
3760 img->pixmap = xpm_image->bitmap;
3761 /* XImageFree in libXpm frees XImage struct without destroying
3762 the bitmap, which is what we want. */
3763 fn_XImageFree (xpm_image);
3765 if (xpm_mask && xpm_mask->bitmap)
3767 /* The mask appears to be inverted compared with what we expect.
3768 TODO: invert our expectations. See other places where we
3769 have to invert bits because our idea of masks is backwards. */
3770 HGDIOBJ old_obj;
3771 old_obj = SelectObject (hdc, xpm_mask->bitmap);
3773 PatBlt (hdc, 0, 0, xpm_mask->width, xpm_mask->height, DSTINVERT);
3774 SelectObject (hdc, old_obj);
3776 img->mask = xpm_mask->bitmap;
3777 fn_XImageFree (xpm_mask);
3778 DeleteDC (hdc);
3781 DeleteDC (hdc);
3782 #endif /* HAVE_NTGUI */
3784 /* Remember allocated colors. */
3785 img->ncolors = attrs.nalloc_pixels;
3786 img->colors = (unsigned long *) xmalloc (img->ncolors
3787 * sizeof *img->colors);
3788 for (i = 0; i < attrs.nalloc_pixels; ++i)
3790 img->colors[i] = attrs.alloc_pixels[i];
3791 #ifdef DEBUG_X_COLORS
3792 register_color (img->colors[i]);
3793 #endif
3795 #endif /* not ALLOC_XPM_COLORS */
3797 img->width = attrs.width;
3798 img->height = attrs.height;
3799 xassert (img->width > 0 && img->height > 0);
3801 /* The call to XpmFreeAttributes below frees attrs.alloc_pixels. */
3802 #ifdef HAVE_NTGUI
3803 fn_XpmFreeAttributes (&attrs);
3804 #else
3805 XpmFreeAttributes (&attrs);
3806 #endif /* HAVE_NTGUI */
3808 else
3810 #ifdef HAVE_NTGUI
3811 DeleteDC (hdc);
3812 #endif /* HAVE_NTGUI */
3814 switch (rc)
3816 case XpmOpenFailed:
3817 image_error ("Error opening XPM file (%s)", img->spec, Qnil);
3818 break;
3820 case XpmFileInvalid:
3821 image_error ("Invalid XPM file (%s)", img->spec, Qnil);
3822 break;
3824 case XpmNoMemory:
3825 image_error ("Out of memory (%s)", img->spec, Qnil);
3826 break;
3828 case XpmColorFailed:
3829 image_error ("Color allocation error (%s)", img->spec, Qnil);
3830 break;
3832 default:
3833 image_error ("Unknown error (%s)", img->spec, Qnil);
3834 break;
3838 #ifdef ALLOC_XPM_COLORS
3839 xpm_free_color_cache ();
3840 #endif
3841 return rc == XpmSuccess;
3844 #endif /* HAVE_XPM */
3846 #ifdef MAC_OS
3848 /* XPM support functions for Mac OS where libxpm is not available.
3849 Only XPM version 3 (without any extensions) is supported. */
3851 static int xpm_scan P_ ((unsigned char **, unsigned char *,
3852 unsigned char **, int *));
3853 static Lisp_Object xpm_make_color_table_v
3854 P_ ((void (**) (Lisp_Object, unsigned char *, int, Lisp_Object),
3855 Lisp_Object (**) (Lisp_Object, unsigned char *, int)));
3856 static void xpm_put_color_table_v P_ ((Lisp_Object, unsigned char *,
3857 int, Lisp_Object));
3858 static Lisp_Object xpm_get_color_table_v P_ ((Lisp_Object,
3859 unsigned char *, int));
3860 static Lisp_Object xpm_make_color_table_h
3861 P_ ((void (**) (Lisp_Object, unsigned char *, int, Lisp_Object),
3862 Lisp_Object (**) (Lisp_Object, unsigned char *, int)));
3863 static void xpm_put_color_table_h P_ ((Lisp_Object, unsigned char *,
3864 int, Lisp_Object));
3865 static Lisp_Object xpm_get_color_table_h P_ ((Lisp_Object,
3866 unsigned char *, int));
3867 static int xpm_str_to_color_key P_ ((char *));
3868 static int xpm_load_image P_ ((struct frame *, struct image *,
3869 unsigned char *, unsigned char *));
3871 /* Tokens returned from xpm_scan. */
3873 enum xpm_token
3875 XPM_TK_IDENT = 256,
3876 XPM_TK_STRING,
3877 XPM_TK_EOF
3880 /* Scan an XPM data and return a character (< 256) or a token defined
3881 by enum xpm_token above. *S and END are the start (inclusive) and
3882 the end (exclusive) addresses of the data, respectively. Advance
3883 *S while scanning. If token is either XPM_TK_IDENT or
3884 XPM_TK_STRING, *BEG and *LEN are set to the start address and the
3885 length of the corresponding token, respectively. */
3887 static int
3888 xpm_scan (s, end, beg, len)
3889 unsigned char **s, *end, **beg;
3890 int *len;
3892 int c;
3894 while (*s < end)
3896 /* Skip white-space. */
3897 while (*s < end && (c = *(*s)++, isspace (c)))
3900 /* gnus-pointer.xpm uses '-' in its identifier.
3901 sb-dir-plus.xpm uses '+' in its identifier. */
3902 if (isalpha (c) || c == '_' || c == '-' || c == '+')
3904 *beg = *s - 1;
3905 while (*s < end &&
3906 (c = **s, isalnum (c) || c == '_' || c == '-' || c == '+'))
3907 ++*s;
3908 *len = *s - *beg;
3909 return XPM_TK_IDENT;
3911 else if (c == '"')
3913 *beg = *s;
3914 while (*s < end && **s != '"')
3915 ++*s;
3916 *len = *s - *beg;
3917 if (*s < end)
3918 ++*s;
3919 return XPM_TK_STRING;
3921 else if (c == '/')
3923 if (*s < end && **s == '*')
3925 /* C-style comment. */
3926 ++*s;
3929 while (*s < end && *(*s)++ != '*')
3932 while (*s < end && **s != '/');
3933 if (*s < end)
3934 ++*s;
3936 else
3937 return c;
3939 else
3940 return c;
3943 return XPM_TK_EOF;
3946 /* Functions for color table lookup in XPM data. A Key is a string
3947 specifying the color of each pixel in XPM data. A value is either
3948 an integer that specifies a pixel color, Qt that specifies
3949 transparency, or Qnil for the unspecified color. If the length of
3950 the key string is one, a vector is used as a table. Otherwise, a
3951 hash table is used. */
3953 static Lisp_Object
3954 xpm_make_color_table_v (put_func, get_func)
3955 void (**put_func) (Lisp_Object, unsigned char *, int, Lisp_Object);
3956 Lisp_Object (**get_func) (Lisp_Object, unsigned char *, int);
3958 *put_func = xpm_put_color_table_v;
3959 *get_func = xpm_get_color_table_v;
3960 return Fmake_vector (make_number (256), Qnil);
3963 static void
3964 xpm_put_color_table_v (color_table, chars_start, chars_len, color)
3965 Lisp_Object color_table;
3966 unsigned char *chars_start;
3967 int chars_len;
3968 Lisp_Object color;
3970 XVECTOR (color_table)->contents[*chars_start] = color;
3973 static Lisp_Object
3974 xpm_get_color_table_v (color_table, chars_start, chars_len)
3975 Lisp_Object color_table;
3976 unsigned char *chars_start;
3977 int chars_len;
3979 return XVECTOR (color_table)->contents[*chars_start];
3982 static Lisp_Object
3983 xpm_make_color_table_h (put_func, get_func)
3984 void (**put_func) (Lisp_Object, unsigned char *, int, Lisp_Object);
3985 Lisp_Object (**get_func) (Lisp_Object, unsigned char *, int);
3987 *put_func = xpm_put_color_table_h;
3988 *get_func = xpm_get_color_table_h;
3989 return make_hash_table (Qequal, make_number (DEFAULT_HASH_SIZE),
3990 make_float (DEFAULT_REHASH_SIZE),
3991 make_float (DEFAULT_REHASH_THRESHOLD),
3992 Qnil, Qnil, Qnil);
3995 static void
3996 xpm_put_color_table_h (color_table, chars_start, chars_len, color)
3997 Lisp_Object color_table;
3998 unsigned char *chars_start;
3999 int chars_len;
4000 Lisp_Object color;
4002 struct Lisp_Hash_Table *table = XHASH_TABLE (color_table);
4003 unsigned hash_code;
4004 Lisp_Object chars = make_unibyte_string (chars_start, chars_len);
4006 hash_lookup (table, chars, &hash_code);
4007 hash_put (table, chars, color, hash_code);
4010 static Lisp_Object
4011 xpm_get_color_table_h (color_table, chars_start, chars_len)
4012 Lisp_Object color_table;
4013 unsigned char *chars_start;
4014 int chars_len;
4016 struct Lisp_Hash_Table *table = XHASH_TABLE (color_table);
4017 int i = hash_lookup (table, make_unibyte_string (chars_start, chars_len),
4018 NULL);
4020 return i >= 0 ? HASH_VALUE (table, i) : Qnil;
4023 enum xpm_color_key {
4024 XPM_COLOR_KEY_S,
4025 XPM_COLOR_KEY_M,
4026 XPM_COLOR_KEY_G4,
4027 XPM_COLOR_KEY_G,
4028 XPM_COLOR_KEY_C
4031 static char xpm_color_key_strings[][4] = {"s", "m", "g4", "g", "c"};
4033 static int
4034 xpm_str_to_color_key (s)
4035 char *s;
4037 int i;
4039 for (i = 0;
4040 i < sizeof xpm_color_key_strings / sizeof xpm_color_key_strings[0];
4041 i++)
4042 if (strcmp (xpm_color_key_strings[i], s) == 0)
4043 return i;
4044 return -1;
4047 static int
4048 xpm_load_image (f, img, contents, end)
4049 struct frame *f;
4050 struct image *img;
4051 unsigned char *contents, *end;
4053 unsigned char *s = contents, *beg, *str;
4054 unsigned char buffer[BUFSIZ];
4055 int width, height, x, y;
4056 int num_colors, chars_per_pixel;
4057 int len, LA1;
4058 void (*put_color_table) (Lisp_Object, unsigned char *, int, Lisp_Object);
4059 Lisp_Object (*get_color_table) (Lisp_Object, unsigned char *, int);
4060 Lisp_Object frame, color_symbols, color_table;
4061 int best_key, have_mask = 0;
4062 XImagePtr ximg = NULL, mask_img = NULL;
4064 #define match() \
4065 LA1 = xpm_scan (&s, end, &beg, &len)
4067 #define expect(TOKEN) \
4068 if (LA1 != (TOKEN)) \
4069 goto failure; \
4070 else \
4071 match ()
4073 #define expect_ident(IDENT) \
4074 if (LA1 == XPM_TK_IDENT \
4075 && strlen ((IDENT)) == len && memcmp ((IDENT), beg, len) == 0) \
4076 match (); \
4077 else \
4078 goto failure
4080 if (!(end - s >= 9 && memcmp (s, "/* XPM */", 9) == 0))
4081 goto failure;
4082 s += 9;
4083 match();
4084 expect_ident ("static");
4085 expect_ident ("char");
4086 expect ('*');
4087 expect (XPM_TK_IDENT);
4088 expect ('[');
4089 expect (']');
4090 expect ('=');
4091 expect ('{');
4092 expect (XPM_TK_STRING);
4093 if (len >= BUFSIZ)
4094 goto failure;
4095 memcpy (buffer, beg, len);
4096 buffer[len] = '\0';
4097 if (sscanf (buffer, "%d %d %d %d", &width, &height,
4098 &num_colors, &chars_per_pixel) != 4
4099 || width <= 0 || height <= 0
4100 || num_colors <= 0 || chars_per_pixel <= 0)
4101 goto failure;
4102 expect (',');
4104 XSETFRAME (frame, f);
4105 if (!NILP (Fxw_display_color_p (frame)))
4106 best_key = XPM_COLOR_KEY_C;
4107 else if (!NILP (Fx_display_grayscale_p (frame)))
4108 best_key = (XFASTINT (Fx_display_planes (frame)) > 2
4109 ? XPM_COLOR_KEY_G : XPM_COLOR_KEY_G4);
4110 else
4111 best_key = XPM_COLOR_KEY_M;
4113 color_symbols = image_spec_value (img->spec, QCcolor_symbols, NULL);
4114 if (chars_per_pixel == 1)
4115 color_table = xpm_make_color_table_v (&put_color_table,
4116 &get_color_table);
4117 else
4118 color_table = xpm_make_color_table_h (&put_color_table,
4119 &get_color_table);
4121 while (num_colors-- > 0)
4123 unsigned char *color, *max_color;
4124 int key, next_key, max_key = 0;
4125 Lisp_Object symbol_color = Qnil, color_val;
4126 XColor cdef;
4128 expect (XPM_TK_STRING);
4129 if (len <= chars_per_pixel || len >= BUFSIZ + chars_per_pixel)
4130 goto failure;
4131 memcpy (buffer, beg + chars_per_pixel, len - chars_per_pixel);
4132 buffer[len - chars_per_pixel] = '\0';
4134 str = strtok (buffer, " \t");
4135 if (str == NULL)
4136 goto failure;
4137 key = xpm_str_to_color_key (str);
4138 if (key < 0)
4139 goto failure;
4142 color = strtok (NULL, " \t");
4143 if (color == NULL)
4144 goto failure;
4146 while (str = strtok (NULL, " \t"))
4148 next_key = xpm_str_to_color_key (str);
4149 if (next_key >= 0)
4150 break;
4151 color[strlen (color)] = ' ';
4154 if (key == XPM_COLOR_KEY_S)
4156 if (NILP (symbol_color))
4157 symbol_color = build_string (color);
4159 else if (max_key < key && key <= best_key)
4161 max_key = key;
4162 max_color = color;
4164 key = next_key;
4166 while (str);
4168 color_val = Qnil;
4169 if (!NILP (color_symbols) && !NILP (symbol_color))
4171 Lisp_Object specified_color = Fassoc (symbol_color, color_symbols);
4173 if (CONSP (specified_color) && STRINGP (XCDR (specified_color)))
4174 if (xstricmp (SDATA (XCDR (specified_color)), "None") == 0)
4175 color_val = Qt;
4176 else if (x_defined_color (f, SDATA (XCDR (specified_color)),
4177 &cdef, 0))
4178 color_val = make_number (cdef.pixel);
4180 if (NILP (color_val) && max_key > 0)
4181 if (xstricmp (max_color, "None") == 0)
4182 color_val = Qt;
4183 else if (x_defined_color (f, max_color, &cdef, 0))
4184 color_val = make_number (cdef.pixel);
4185 if (!NILP (color_val))
4186 (*put_color_table) (color_table, beg, chars_per_pixel, color_val);
4188 expect (',');
4191 if (!x_create_x_image_and_pixmap (f, width, height, 0,
4192 &ximg, &img->pixmap)
4193 || !x_create_x_image_and_pixmap (f, width, height, 1,
4194 &mask_img, &img->mask))
4196 image_error ("Out of memory (%s)", img->spec, Qnil);
4197 goto error;
4200 for (y = 0; y < height; y++)
4202 expect (XPM_TK_STRING);
4203 str = beg;
4204 if (len < width * chars_per_pixel)
4205 goto failure;
4206 for (x = 0; x < width; x++, str += chars_per_pixel)
4208 Lisp_Object color_val =
4209 (*get_color_table) (color_table, str, chars_per_pixel);
4211 XPutPixel (ximg, x, y,
4212 (INTEGERP (color_val) ? XINT (color_val)
4213 : FRAME_FOREGROUND_PIXEL (f)));
4214 XPutPixel (mask_img, x, y,
4215 (!EQ (color_val, Qt) ? PIX_MASK_DRAW (f)
4216 : (have_mask = 1, PIX_MASK_RETAIN (f))));
4218 if (y + 1 < height)
4219 expect (',');
4222 img->width = width;
4223 img->height = height;
4225 x_put_x_image (f, ximg, img->pixmap, width, height);
4226 x_destroy_x_image (ximg);
4227 if (have_mask)
4229 x_put_x_image (f, mask_img, img->mask, width, height);
4230 x_destroy_x_image (mask_img);
4232 else
4234 x_destroy_x_image (mask_img);
4235 Free_Pixmap (FRAME_X_DISPLAY (f), img->mask);
4236 img->mask = NO_PIXMAP;
4239 return 1;
4241 failure:
4242 image_error ("Invalid XPM file (%s)", img->spec, Qnil);
4243 error:
4244 x_destroy_x_image (ximg);
4245 x_destroy_x_image (mask_img);
4246 x_clear_image (f, img);
4247 return 0;
4249 #undef match
4250 #undef expect
4251 #undef expect_ident
4254 static int
4255 xpm_load (f, img)
4256 struct frame *f;
4257 struct image *img;
4259 int success_p = 0;
4260 Lisp_Object file_name;
4262 /* If IMG->spec specifies a file name, create a non-file spec from it. */
4263 file_name = image_spec_value (img->spec, QCfile, NULL);
4264 if (STRINGP (file_name))
4266 Lisp_Object file;
4267 unsigned char *contents;
4268 int size;
4269 struct gcpro gcpro1;
4271 file = x_find_image_file (file_name);
4272 GCPRO1 (file);
4273 if (!STRINGP (file))
4275 image_error ("Cannot find image file `%s'", file_name, Qnil);
4276 UNGCPRO;
4277 return 0;
4280 contents = slurp_file (SDATA (file), &size);
4281 if (contents == NULL)
4283 image_error ("Error loading XPM image `%s'", img->spec, Qnil);
4284 UNGCPRO;
4285 return 0;
4288 success_p = xpm_load_image (f, img, contents, contents + size);
4289 xfree (contents);
4290 UNGCPRO;
4292 else
4294 Lisp_Object data;
4296 data = image_spec_value (img->spec, QCdata, NULL);
4297 success_p = xpm_load_image (f, img, SDATA (data),
4298 SDATA (data) + SBYTES (data));
4301 return success_p;
4304 #endif /* MAC_OS */
4308 /***********************************************************************
4309 Color table
4310 ***********************************************************************/
4312 #ifdef COLOR_TABLE_SUPPORT
4314 /* An entry in the color table mapping an RGB color to a pixel color. */
4316 struct ct_color
4318 int r, g, b;
4319 unsigned long pixel;
4321 /* Next in color table collision list. */
4322 struct ct_color *next;
4325 /* The bucket vector size to use. Must be prime. */
4327 #define CT_SIZE 101
4329 /* Value is a hash of the RGB color given by R, G, and B. */
4331 #define CT_HASH_RGB(R, G, B) (((R) << 16) ^ ((G) << 8) ^ (B))
4333 /* The color hash table. */
4335 struct ct_color **ct_table;
4337 /* Number of entries in the color table. */
4339 int ct_colors_allocated;
4341 /* Initialize the color table. */
4343 static void
4344 init_color_table ()
4346 int size = CT_SIZE * sizeof (*ct_table);
4347 ct_table = (struct ct_color **) xmalloc (size);
4348 bzero (ct_table, size);
4349 ct_colors_allocated = 0;
4353 /* Free memory associated with the color table. */
4355 static void
4356 free_color_table ()
4358 int i;
4359 struct ct_color *p, *next;
4361 for (i = 0; i < CT_SIZE; ++i)
4362 for (p = ct_table[i]; p; p = next)
4364 next = p->next;
4365 xfree (p);
4368 xfree (ct_table);
4369 ct_table = NULL;
4373 /* Value is a pixel color for RGB color R, G, B on frame F. If an
4374 entry for that color already is in the color table, return the
4375 pixel color of that entry. Otherwise, allocate a new color for R,
4376 G, B, and make an entry in the color table. */
4378 static unsigned long
4379 lookup_rgb_color (f, r, g, b)
4380 struct frame *f;
4381 int r, g, b;
4383 unsigned hash = CT_HASH_RGB (r, g, b);
4384 int i = hash % CT_SIZE;
4385 struct ct_color *p;
4386 Display_Info *dpyinfo;
4388 /* Handle TrueColor visuals specially, which improves performance by
4389 two orders of magnitude. Freeing colors on TrueColor visuals is
4390 a nop, and pixel colors specify RGB values directly. See also
4391 the Xlib spec, chapter 3.1. */
4392 dpyinfo = FRAME_X_DISPLAY_INFO (f);
4393 if (dpyinfo->red_bits > 0)
4395 unsigned long pr, pg, pb;
4397 /* Apply gamma-correction like normal color allocation does. */
4398 if (f->gamma)
4400 XColor color;
4401 color.red = r, color.green = g, color.blue = b;
4402 gamma_correct (f, &color);
4403 r = color.red, g = color.green, b = color.blue;
4406 /* Scale down RGB values to the visual's bits per RGB, and shift
4407 them to the right position in the pixel color. Note that the
4408 original RGB values are 16-bit values, as usual in X. */
4409 pr = (r >> (16 - dpyinfo->red_bits)) << dpyinfo->red_offset;
4410 pg = (g >> (16 - dpyinfo->green_bits)) << dpyinfo->green_offset;
4411 pb = (b >> (16 - dpyinfo->blue_bits)) << dpyinfo->blue_offset;
4413 /* Assemble the pixel color. */
4414 return pr | pg | pb;
4417 for (p = ct_table[i]; p; p = p->next)
4418 if (p->r == r && p->g == g && p->b == b)
4419 break;
4421 if (p == NULL)
4424 #ifdef HAVE_X_WINDOWS
4425 XColor color;
4426 Colormap cmap;
4427 int rc;
4429 color.red = r;
4430 color.green = g;
4431 color.blue = b;
4433 cmap = FRAME_X_COLORMAP (f);
4434 rc = x_alloc_nearest_color (f, cmap, &color);
4435 if (rc)
4437 ++ct_colors_allocated;
4438 p = (struct ct_color *) xmalloc (sizeof *p);
4439 p->r = r;
4440 p->g = g;
4441 p->b = b;
4442 p->pixel = color.pixel;
4443 p->next = ct_table[i];
4444 ct_table[i] = p;
4446 else
4447 return FRAME_FOREGROUND_PIXEL (f);
4449 #else
4450 COLORREF color;
4451 #ifdef HAVE_NTGUI
4452 color = PALETTERGB (r, g, b);
4453 #else
4454 color = RGB_TO_ULONG (r, g, b);
4455 #endif /* HAVE_NTGUI */
4456 ++ct_colors_allocated;
4457 p = (struct ct_color *) xmalloc (sizeof *p);
4458 p->r = r;
4459 p->g = g;
4460 p->b = b;
4461 p->pixel = color;
4462 p->next = ct_table[i];
4463 ct_table[i] = p;
4464 #endif /* HAVE_X_WINDOWS */
4468 return p->pixel;
4472 /* Look up pixel color PIXEL which is used on frame F in the color
4473 table. If not already present, allocate it. Value is PIXEL. */
4475 static unsigned long
4476 lookup_pixel_color (f, pixel)
4477 struct frame *f;
4478 unsigned long pixel;
4480 int i = pixel % CT_SIZE;
4481 struct ct_color *p;
4483 for (p = ct_table[i]; p; p = p->next)
4484 if (p->pixel == pixel)
4485 break;
4487 if (p == NULL)
4489 XColor color;
4490 Colormap cmap;
4491 int rc;
4493 #ifdef HAVE_X_WINDOWS
4494 cmap = FRAME_X_COLORMAP (f);
4495 color.pixel = pixel;
4496 x_query_color (f, &color);
4497 rc = x_alloc_nearest_color (f, cmap, &color);
4498 #else
4499 BLOCK_INPUT;
4500 cmap = DefaultColormapOfScreen (FRAME_X_SCREEN (f));
4501 color.pixel = pixel;
4502 XQueryColor (NULL, cmap, &color);
4503 rc = x_alloc_nearest_color (f, cmap, &color);
4504 UNBLOCK_INPUT;
4505 #endif /* HAVE_X_WINDOWS */
4507 if (rc)
4509 ++ct_colors_allocated;
4511 p = (struct ct_color *) xmalloc (sizeof *p);
4512 p->r = color.red;
4513 p->g = color.green;
4514 p->b = color.blue;
4515 p->pixel = pixel;
4516 p->next = ct_table[i];
4517 ct_table[i] = p;
4519 else
4520 return FRAME_FOREGROUND_PIXEL (f);
4522 return p->pixel;
4526 /* Value is a vector of all pixel colors contained in the color table,
4527 allocated via xmalloc. Set *N to the number of colors. */
4529 static unsigned long *
4530 colors_in_color_table (n)
4531 int *n;
4533 int i, j;
4534 struct ct_color *p;
4535 unsigned long *colors;
4537 if (ct_colors_allocated == 0)
4539 *n = 0;
4540 colors = NULL;
4542 else
4544 colors = (unsigned long *) xmalloc (ct_colors_allocated
4545 * sizeof *colors);
4546 *n = ct_colors_allocated;
4548 for (i = j = 0; i < CT_SIZE; ++i)
4549 for (p = ct_table[i]; p; p = p->next)
4550 colors[j++] = p->pixel;
4553 return colors;
4556 #else /* COLOR_TABLE_SUPPORT */
4558 static unsigned long
4559 lookup_rgb_color (f, r, g, b)
4560 struct frame *f;
4561 int r, g, b;
4563 unsigned long pixel;
4565 #ifdef MAC_OS
4566 pixel = RGB_TO_ULONG (r >> 8, g >> 8, b >> 8);
4567 gamma_correct (f, &pixel);
4568 #endif /* MAC_OS */
4570 #ifdef HAVE_NTGUI
4571 pixel = PALETTERGB (r >> 8, g >> 8, b >> 8);
4572 #endif /* HAVE_NTGUI */
4574 return pixel;
4577 static void
4578 init_color_table ()
4581 #endif /* COLOR_TABLE_SUPPORT */
4584 /***********************************************************************
4585 Algorithms
4586 ***********************************************************************/
4588 static XColor *x_to_xcolors P_ ((struct frame *, struct image *, int));
4589 static void x_from_xcolors P_ ((struct frame *, struct image *, XColor *));
4590 static void x_detect_edges P_ ((struct frame *, struct image *, int[9], int));
4592 #ifdef HAVE_NTGUI
4593 static void XPutPixel (XImagePtr , int, int, COLORREF);
4594 #endif /* HAVE_NTGUI */
4596 /* Non-zero means draw a cross on images having `:conversion
4597 disabled'. */
4599 int cross_disabled_images;
4601 /* Edge detection matrices for different edge-detection
4602 strategies. */
4604 static int emboss_matrix[9] = {
4605 /* x - 1 x x + 1 */
4606 2, -1, 0, /* y - 1 */
4607 -1, 0, 1, /* y */
4608 0, 1, -2 /* y + 1 */
4611 static int laplace_matrix[9] = {
4612 /* x - 1 x x + 1 */
4613 1, 0, 0, /* y - 1 */
4614 0, 0, 0, /* y */
4615 0, 0, -1 /* y + 1 */
4618 /* Value is the intensity of the color whose red/green/blue values
4619 are R, G, and B. */
4621 #define COLOR_INTENSITY(R, G, B) ((2 * (R) + 3 * (G) + (B)) / 6)
4624 /* On frame F, return an array of XColor structures describing image
4625 IMG->pixmap. Each XColor structure has its pixel color set. RGB_P
4626 non-zero means also fill the red/green/blue members of the XColor
4627 structures. Value is a pointer to the array of XColors structures,
4628 allocated with xmalloc; it must be freed by the caller. */
4630 static XColor *
4631 x_to_xcolors (f, img, rgb_p)
4632 struct frame *f;
4633 struct image *img;
4634 int rgb_p;
4636 int x, y;
4637 XColor *colors, *p;
4638 XImagePtr_or_DC ximg;
4639 #ifdef HAVE_NTGUI
4640 HDC hdc;
4641 HGDIOBJ prev;
4642 #endif /* HAVE_NTGUI */
4644 colors = (XColor *) xmalloc (img->width * img->height * sizeof *colors);
4646 #ifndef HAVE_NTGUI
4647 /* Get the X image IMG->pixmap. */
4648 ximg = XGetImage (FRAME_X_DISPLAY (f), img->pixmap,
4649 0, 0, img->width, img->height, ~0, ZPixmap);
4650 #else
4651 /* Load the image into a memory device context. */
4652 hdc = get_frame_dc (f);
4653 ximg = CreateCompatibleDC (hdc);
4654 release_frame_dc (f, hdc);
4655 prev = SelectObject (ximg, img->pixmap);
4656 #endif /* HAVE_NTGUI */
4658 /* Fill the `pixel' members of the XColor array. I wished there
4659 were an easy and portable way to circumvent XGetPixel. */
4660 p = colors;
4661 for (y = 0; y < img->height; ++y)
4663 XColor *row = p;
4665 #ifdef HAVE_X_WINDOWS
4666 for (x = 0; x < img->width; ++x, ++p)
4667 p->pixel = XGetPixel (ximg, x, y);
4668 if (rgb_p)
4669 x_query_colors (f, row, img->width);
4671 #else
4673 for (x = 0; x < img->width; ++x, ++p)
4675 /* W32_TODO: palette support needed here? */
4676 p->pixel = GET_PIXEL (ximg, x, y);
4677 if (rgb_p)
4679 #ifdef MAC_OS
4680 p->red = RED16_FROM_ULONG (p->pixel);
4681 p->green = GREEN16_FROM_ULONG (p->pixel);
4682 p->blue = BLUE16_FROM_ULONG (p->pixel);
4683 #endif /* MAC_OS */
4684 #ifdef HAVE_NTGUI
4685 p->red = 256 * GetRValue (p->pixel);
4686 p->green = 256 * GetGValue (p->pixel);
4687 p->blue = 256 * GetBValue (p->pixel);
4688 #endif /* HAVE_NTGUI */
4691 #endif /* HAVE_X_WINDOWS */
4694 Destroy_Image (ximg, prev);
4696 return colors;
4699 #ifdef HAVE_NTGUI
4701 /* Put a pixel of COLOR at position X, Y in XIMG. XIMG must have been
4702 created with CreateDIBSection, with the pointer to the bit values
4703 stored in ximg->data. */
4705 static void XPutPixel (ximg, x, y, color)
4706 XImagePtr ximg;
4707 int x, y;
4708 COLORREF color;
4710 int width = ximg->info.bmiHeader.biWidth;
4711 int height = ximg->info.bmiHeader.biHeight;
4712 unsigned char * pixel;
4714 /* True color images. */
4715 if (ximg->info.bmiHeader.biBitCount == 24)
4717 int rowbytes = width * 3;
4718 /* Ensure scanlines are aligned on 4 byte boundaries. */
4719 if (rowbytes % 4)
4720 rowbytes += 4 - (rowbytes % 4);
4722 pixel = ximg->data + y * rowbytes + x * 3;
4723 /* Windows bitmaps are in BGR order. */
4724 *pixel = GetBValue (color);
4725 *(pixel + 1) = GetGValue (color);
4726 *(pixel + 2) = GetRValue (color);
4728 /* Monochrome images. */
4729 else if (ximg->info.bmiHeader.biBitCount == 1)
4731 int rowbytes = width / 8;
4732 /* Ensure scanlines are aligned on 4 byte boundaries. */
4733 if (rowbytes % 4)
4734 rowbytes += 4 - (rowbytes % 4);
4735 pixel = ximg->data + y * rowbytes + x / 8;
4736 /* Filter out palette info. */
4737 if (color & 0x00ffffff)
4738 *pixel = *pixel | (1 << x % 8);
4739 else
4740 *pixel = *pixel & ~(1 << x % 8);
4742 else
4743 image_error ("XPutPixel: palette image not supported", Qnil, Qnil);
4746 #endif /* HAVE_NTGUI */
4748 /* Create IMG->pixmap from an array COLORS of XColor structures, whose
4749 RGB members are set. F is the frame on which this all happens.
4750 COLORS will be freed; an existing IMG->pixmap will be freed, too. */
4752 static void
4753 x_from_xcolors (f, img, colors)
4754 struct frame *f;
4755 struct image *img;
4756 XColor *colors;
4758 int x, y;
4759 XImagePtr oimg;
4760 Pixmap pixmap;
4761 XColor *p;
4763 init_color_table ();
4765 x_create_x_image_and_pixmap (f, img->width, img->height, 0,
4766 &oimg, &pixmap);
4767 p = colors;
4768 for (y = 0; y < img->height; ++y)
4769 for (x = 0; x < img->width; ++x, ++p)
4771 unsigned long pixel;
4772 pixel = lookup_rgb_color (f, p->red, p->green, p->blue);
4773 XPutPixel (oimg, x, y, pixel);
4776 xfree (colors);
4777 x_clear_image_1 (f, img, 1, 0, 1);
4779 x_put_x_image (f, oimg, pixmap, img->width, img->height);
4780 x_destroy_x_image (oimg);
4781 img->pixmap = pixmap;
4782 #ifdef COLOR_TABLE_SUPPORT
4783 img->colors = colors_in_color_table (&img->ncolors);
4784 free_color_table ();
4785 #endif /* COLOR_TABLE_SUPPORT */
4789 /* On frame F, perform edge-detection on image IMG.
4791 MATRIX is a nine-element array specifying the transformation
4792 matrix. See emboss_matrix for an example.
4794 COLOR_ADJUST is a color adjustment added to each pixel of the
4795 outgoing image. */
4797 static void
4798 x_detect_edges (f, img, matrix, color_adjust)
4799 struct frame *f;
4800 struct image *img;
4801 int matrix[9], color_adjust;
4803 XColor *colors = x_to_xcolors (f, img, 1);
4804 XColor *new, *p;
4805 int x, y, i, sum;
4807 for (i = sum = 0; i < 9; ++i)
4808 sum += abs (matrix[i]);
4810 #define COLOR(A, X, Y) ((A) + (Y) * img->width + (X))
4812 new = (XColor *) xmalloc (img->width * img->height * sizeof *new);
4814 for (y = 0; y < img->height; ++y)
4816 p = COLOR (new, 0, y);
4817 p->red = p->green = p->blue = 0xffff/2;
4818 p = COLOR (new, img->width - 1, y);
4819 p->red = p->green = p->blue = 0xffff/2;
4822 for (x = 1; x < img->width - 1; ++x)
4824 p = COLOR (new, x, 0);
4825 p->red = p->green = p->blue = 0xffff/2;
4826 p = COLOR (new, x, img->height - 1);
4827 p->red = p->green = p->blue = 0xffff/2;
4830 for (y = 1; y < img->height - 1; ++y)
4832 p = COLOR (new, 1, y);
4834 for (x = 1; x < img->width - 1; ++x, ++p)
4836 int r, g, b, y1, x1;
4838 r = g = b = i = 0;
4839 for (y1 = y - 1; y1 < y + 2; ++y1)
4840 for (x1 = x - 1; x1 < x + 2; ++x1, ++i)
4841 if (matrix[i])
4843 XColor *t = COLOR (colors, x1, y1);
4844 r += matrix[i] * t->red;
4845 g += matrix[i] * t->green;
4846 b += matrix[i] * t->blue;
4849 r = (r / sum + color_adjust) & 0xffff;
4850 g = (g / sum + color_adjust) & 0xffff;
4851 b = (b / sum + color_adjust) & 0xffff;
4852 p->red = p->green = p->blue = COLOR_INTENSITY (r, g, b);
4856 xfree (colors);
4857 x_from_xcolors (f, img, new);
4859 #undef COLOR
4863 /* Perform the pre-defined `emboss' edge-detection on image IMG
4864 on frame F. */
4866 static void
4867 x_emboss (f, img)
4868 struct frame *f;
4869 struct image *img;
4871 x_detect_edges (f, img, emboss_matrix, 0xffff / 2);
4875 /* Transform image IMG which is used on frame F with a Laplace
4876 edge-detection algorithm. The result is an image that can be used
4877 to draw disabled buttons, for example. */
4879 static void
4880 x_laplace (f, img)
4881 struct frame *f;
4882 struct image *img;
4884 x_detect_edges (f, img, laplace_matrix, 45000);
4888 /* Perform edge-detection on image IMG on frame F, with specified
4889 transformation matrix MATRIX and color-adjustment COLOR_ADJUST.
4891 MATRIX must be either
4893 - a list of at least 9 numbers in row-major form
4894 - a vector of at least 9 numbers
4896 COLOR_ADJUST nil means use a default; otherwise it must be a
4897 number. */
4899 static void
4900 x_edge_detection (f, img, matrix, color_adjust)
4901 struct frame *f;
4902 struct image *img;
4903 Lisp_Object matrix, color_adjust;
4905 int i = 0;
4906 int trans[9];
4908 if (CONSP (matrix))
4910 for (i = 0;
4911 i < 9 && CONSP (matrix) && NUMBERP (XCAR (matrix));
4912 ++i, matrix = XCDR (matrix))
4913 trans[i] = XFLOATINT (XCAR (matrix));
4915 else if (VECTORP (matrix) && ASIZE (matrix) >= 9)
4917 for (i = 0; i < 9 && NUMBERP (AREF (matrix, i)); ++i)
4918 trans[i] = XFLOATINT (AREF (matrix, i));
4921 if (NILP (color_adjust))
4922 color_adjust = make_number (0xffff / 2);
4924 if (i == 9 && NUMBERP (color_adjust))
4925 x_detect_edges (f, img, trans, (int) XFLOATINT (color_adjust));
4929 /* Transform image IMG on frame F so that it looks disabled. */
4931 static void
4932 x_disable_image (f, img)
4933 struct frame *f;
4934 struct image *img;
4936 Display_Info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
4937 #ifdef HAVE_NTGUI
4938 int n_planes = dpyinfo->n_planes * dpyinfo->n_cbits;
4939 #else
4940 int n_planes = dpyinfo->n_planes;
4941 #endif /* HAVE_NTGUI */
4943 if (n_planes >= 2)
4945 /* Color (or grayscale). Convert to gray, and equalize. Just
4946 drawing such images with a stipple can look very odd, so
4947 we're using this method instead. */
4948 XColor *colors = x_to_xcolors (f, img, 1);
4949 XColor *p, *end;
4950 const int h = 15000;
4951 const int l = 30000;
4953 for (p = colors, end = colors + img->width * img->height;
4954 p < end;
4955 ++p)
4957 int i = COLOR_INTENSITY (p->red, p->green, p->blue);
4958 int i2 = (0xffff - h - l) * i / 0xffff + l;
4959 p->red = p->green = p->blue = i2;
4962 x_from_xcolors (f, img, colors);
4965 /* Draw a cross over the disabled image, if we must or if we
4966 should. */
4967 if (n_planes < 2 || cross_disabled_images)
4969 #ifndef HAVE_NTGUI
4970 Display *dpy = FRAME_X_DISPLAY (f);
4971 GC gc;
4973 #ifdef MAC_OS
4974 #define XCreateGC_pixmap(dpy, pixmap) XCreateGC (dpy, NULL, 0, NULL)
4975 #define MaskForeground(f) PIX_MASK_DRAW (f)
4976 #else
4977 #define XCreateGC_pixmap(dpy, pixmap) XCreateGC (dpy, pixmap, 0, NULL)
4978 #define MaskForeground(f) WHITE_PIX_DEFAULT (f)
4979 #endif
4981 gc = XCreateGC_pixmap (dpy, img->pixmap);
4982 XSetForeground (dpy, gc, BLACK_PIX_DEFAULT (f));
4983 XDrawLine (dpy, img->pixmap, gc, 0, 0,
4984 img->width - 1, img->height - 1);
4985 XDrawLine (dpy, img->pixmap, gc, 0, img->height - 1,
4986 img->width - 1, 0);
4987 XFreeGC (dpy, gc);
4989 if (img->mask)
4991 gc = XCreateGC_pixmap (dpy, img->mask);
4992 XSetForeground (dpy, gc, MaskForeground (f));
4993 XDrawLine (dpy, img->mask, gc, 0, 0,
4994 img->width - 1, img->height - 1);
4995 XDrawLine (dpy, img->mask, gc, 0, img->height - 1,
4996 img->width - 1, 0);
4997 XFreeGC (dpy, gc);
4999 #else
5000 HDC hdc, bmpdc;
5001 HGDIOBJ prev;
5003 hdc = get_frame_dc (f);
5004 bmpdc = CreateCompatibleDC (hdc);
5005 release_frame_dc (f, hdc);
5007 prev = SelectObject (bmpdc, img->pixmap);
5009 SetTextColor (bmpdc, BLACK_PIX_DEFAULT (f));
5010 MoveToEx (bmpdc, 0, 0, NULL);
5011 LineTo (bmpdc, img->width - 1, img->height - 1);
5012 MoveToEx (bmpdc, 0, img->height - 1, NULL);
5013 LineTo (bmpdc, img->width - 1, 0);
5015 if (img->mask)
5017 SelectObject (bmpdc, img->mask);
5018 SetTextColor (bmpdc, WHITE_PIX_DEFAULT (f));
5019 MoveToEx (bmpdc, 0, 0, NULL);
5020 LineTo (bmpdc, img->width - 1, img->height - 1);
5021 MoveToEx (bmpdc, 0, img->height - 1, NULL);
5022 LineTo (bmpdc, img->width - 1, 0);
5024 SelectObject (bmpdc, prev);
5025 DeleteDC (bmpdc);
5026 #endif /* HAVE_NTGUI */
5031 /* Build a mask for image IMG which is used on frame F. FILE is the
5032 name of an image file, for error messages. HOW determines how to
5033 determine the background color of IMG. If it is a list '(R G B)',
5034 with R, G, and B being integers >= 0, take that as the color of the
5035 background. Otherwise, determine the background color of IMG
5036 heuristically. Value is non-zero if successful. */
5038 static int
5039 x_build_heuristic_mask (f, img, how)
5040 struct frame *f;
5041 struct image *img;
5042 Lisp_Object how;
5044 XImagePtr_or_DC ximg;
5045 #ifndef HAVE_NTGUI
5046 XImagePtr mask_img;
5047 #else
5048 HDC frame_dc;
5049 HGDIOBJ prev;
5050 char *mask_img;
5051 int row_width;
5052 #endif /* HAVE_NTGUI */
5053 int x, y, rc, use_img_background;
5054 unsigned long bg = 0;
5056 if (img->mask)
5058 Free_Pixmap (FRAME_X_DISPLAY (f), img->mask);
5059 img->mask = NO_PIXMAP;
5060 img->background_transparent_valid = 0;
5063 #ifndef HAVE_NTGUI
5064 /* Create an image and pixmap serving as mask. */
5065 rc = x_create_x_image_and_pixmap (f, img->width, img->height, 1,
5066 &mask_img, &img->mask);
5067 if (!rc)
5068 return 0;
5070 /* Get the X image of IMG->pixmap. */
5071 ximg = XGetImage (FRAME_X_DISPLAY (f), img->pixmap, 0, 0,
5072 img->width, img->height,
5073 ~0, ZPixmap);
5074 #else
5075 /* Create the bit array serving as mask. */
5076 row_width = (img->width + 7) / 8;
5077 mask_img = xmalloc (row_width * img->height);
5078 bzero (mask_img, row_width * img->height);
5080 /* Create a memory device context for IMG->pixmap. */
5081 frame_dc = get_frame_dc (f);
5082 ximg = CreateCompatibleDC (frame_dc);
5083 release_frame_dc (f, frame_dc);
5084 prev = SelectObject (ximg, img->pixmap);
5085 #endif /* HAVE_NTGUI */
5087 /* Determine the background color of ximg. If HOW is `(R G B)'
5088 take that as color. Otherwise, use the image's background color. */
5089 use_img_background = 1;
5091 if (CONSP (how))
5093 int rgb[3], i;
5095 for (i = 0; i < 3 && CONSP (how) && NATNUMP (XCAR (how)); ++i)
5097 rgb[i] = XFASTINT (XCAR (how)) & 0xffff;
5098 how = XCDR (how);
5101 if (i == 3 && NILP (how))
5103 char color_name[30];
5104 sprintf (color_name, "#%04x%04x%04x", rgb[0], rgb[1], rgb[2]);
5105 bg = (
5106 #ifdef HAVE_NTGUI
5107 0x00ffffff & /* Filter out palette info. */
5108 #endif /* HAVE_NTGUI */
5109 x_alloc_image_color (f, img, build_string (color_name), 0));
5110 use_img_background = 0;
5114 if (use_img_background)
5115 bg = four_corners_best (ximg, img->width, img->height);
5117 /* Set all bits in mask_img to 1 whose color in ximg is different
5118 from the background color bg. */
5119 #ifndef HAVE_NTGUI
5120 for (y = 0; y < img->height; ++y)
5121 for (x = 0; x < img->width; ++x)
5122 XPutPixel (mask_img, x, y, (XGetPixel (ximg, x, y) != bg
5123 ? PIX_MASK_DRAW (f) : PIX_MASK_RETAIN (f)));
5125 /* Fill in the background_transparent field while we have the mask handy. */
5126 image_background_transparent (img, f, mask_img);
5128 /* Put mask_img into img->mask. */
5129 x_put_x_image (f, mask_img, img->mask, img->width, img->height);
5130 x_destroy_x_image (mask_img);
5132 #else
5133 for (y = 0; y < img->height; ++y)
5134 for (x = 0; x < img->width; ++x)
5136 COLORREF p = GetPixel (ximg, x, y);
5137 if (p != bg)
5138 mask_img[y * row_width + x / 8] |= 1 << (x % 8);
5141 /* Create the mask image. */
5142 img->mask = w32_create_pixmap_from_bitmap_data (img->width, img->height,
5143 mask_img);
5144 /* Fill in the background_transparent field while we have the mask handy. */
5145 SelectObject (ximg, img->mask);
5146 image_background_transparent (img, f, ximg);
5148 /* Was: x_destroy_x_image ((XImagePtr )mask_img); which seems bogus ++kfs */
5149 xfree (mask_img);
5150 #endif /* HAVE_NTGUI */
5152 Destroy_Image (ximg, prev);
5154 return 1;
5158 /***********************************************************************
5159 PBM (mono, gray, color)
5160 ***********************************************************************/
5162 static int pbm_image_p P_ ((Lisp_Object object));
5163 static int pbm_load P_ ((struct frame *f, struct image *img));
5164 static int pbm_scan_number P_ ((unsigned char **, unsigned char *));
5166 /* The symbol `pbm' identifying images of this type. */
5168 Lisp_Object Qpbm;
5170 /* Indices of image specification fields in gs_format, below. */
5172 enum pbm_keyword_index
5174 PBM_TYPE,
5175 PBM_FILE,
5176 PBM_DATA,
5177 PBM_ASCENT,
5178 PBM_MARGIN,
5179 PBM_RELIEF,
5180 PBM_ALGORITHM,
5181 PBM_HEURISTIC_MASK,
5182 PBM_MASK,
5183 PBM_FOREGROUND,
5184 PBM_BACKGROUND,
5185 PBM_LAST
5188 /* Vector of image_keyword structures describing the format
5189 of valid user-defined image specifications. */
5191 static struct image_keyword pbm_format[PBM_LAST] =
5193 {":type", IMAGE_SYMBOL_VALUE, 1},
5194 {":file", IMAGE_STRING_VALUE, 0},
5195 {":data", IMAGE_STRING_VALUE, 0},
5196 {":ascent", IMAGE_ASCENT_VALUE, 0},
5197 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
5198 {":relief", IMAGE_INTEGER_VALUE, 0},
5199 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
5200 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
5201 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
5202 {":foreground", IMAGE_STRING_OR_NIL_VALUE, 0},
5203 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
5206 /* Structure describing the image type `pbm'. */
5208 static struct image_type pbm_type =
5210 &Qpbm,
5211 pbm_image_p,
5212 pbm_load,
5213 x_clear_image,
5214 NULL
5218 /* Return non-zero if OBJECT is a valid PBM image specification. */
5220 static int
5221 pbm_image_p (object)
5222 Lisp_Object object;
5224 struct image_keyword fmt[PBM_LAST];
5226 bcopy (pbm_format, fmt, sizeof fmt);
5228 if (!parse_image_spec (object, fmt, PBM_LAST, Qpbm))
5229 return 0;
5231 /* Must specify either :data or :file. */
5232 return fmt[PBM_DATA].count + fmt[PBM_FILE].count == 1;
5236 /* Scan a decimal number from *S and return it. Advance *S while
5237 reading the number. END is the end of the string. Value is -1 at
5238 end of input. */
5240 static int
5241 pbm_scan_number (s, end)
5242 unsigned char **s, *end;
5244 int c = 0, val = -1;
5246 while (*s < end)
5248 /* Skip white-space. */
5249 while (*s < end && (c = *(*s)++, isspace (c)))
5252 if (c == '#')
5254 /* Skip comment to end of line. */
5255 while (*s < end && (c = *(*s)++, c != '\n'))
5258 else if (isdigit (c))
5260 /* Read decimal number. */
5261 val = c - '0';
5262 while (*s < end && (c = *(*s)++, isdigit (c)))
5263 val = 10 * val + c - '0';
5264 break;
5266 else
5267 break;
5270 return val;
5274 #ifdef HAVE_NTGUI
5275 #if 0 /* Unused. ++kfs */
5277 /* Read FILE into memory. Value is a pointer to a buffer allocated
5278 with xmalloc holding FILE's contents. Value is null if an error
5279 occurred. *SIZE is set to the size of the file. */
5281 static char *
5282 pbm_read_file (file, size)
5283 Lisp_Object file;
5284 int *size;
5286 FILE *fp = NULL;
5287 char *buf = NULL;
5288 struct stat st;
5290 if (stat (SDATA (file), &st) == 0
5291 && (fp = fopen (SDATA (file), "rb")) != NULL
5292 && (buf = (char *) xmalloc (st.st_size),
5293 fread (buf, 1, st.st_size, fp) == st.st_size))
5295 *size = st.st_size;
5296 fclose (fp);
5298 else
5300 if (fp)
5301 fclose (fp);
5302 if (buf)
5304 xfree (buf);
5305 buf = NULL;
5309 return buf;
5311 #endif
5312 #endif /* HAVE_NTGUI */
5314 /* Load PBM image IMG for use on frame F. */
5316 static int
5317 pbm_load (f, img)
5318 struct frame *f;
5319 struct image *img;
5321 int raw_p, x, y;
5322 int width, height, max_color_idx = 0;
5323 XImagePtr ximg;
5324 Lisp_Object file, specified_file;
5325 enum {PBM_MONO, PBM_GRAY, PBM_COLOR} type;
5326 struct gcpro gcpro1;
5327 unsigned char *contents = NULL;
5328 unsigned char *end, *p;
5329 int size;
5331 specified_file = image_spec_value (img->spec, QCfile, NULL);
5332 file = Qnil;
5333 GCPRO1 (file);
5335 if (STRINGP (specified_file))
5337 file = x_find_image_file (specified_file);
5338 if (!STRINGP (file))
5340 image_error ("Cannot find image file `%s'", specified_file, Qnil);
5341 UNGCPRO;
5342 return 0;
5345 contents = slurp_file (SDATA (file), &size);
5346 if (contents == NULL)
5348 image_error ("Error reading `%s'", file, Qnil);
5349 UNGCPRO;
5350 return 0;
5353 p = contents;
5354 end = contents + size;
5356 else
5358 Lisp_Object data;
5359 data = image_spec_value (img->spec, QCdata, NULL);
5360 p = SDATA (data);
5361 end = p + SBYTES (data);
5364 /* Check magic number. */
5365 if (end - p < 2 || *p++ != 'P')
5367 image_error ("Not a PBM image: `%s'", img->spec, Qnil);
5368 error:
5369 xfree (contents);
5370 UNGCPRO;
5371 return 0;
5374 switch (*p++)
5376 case '1':
5377 raw_p = 0, type = PBM_MONO;
5378 break;
5380 case '2':
5381 raw_p = 0, type = PBM_GRAY;
5382 break;
5384 case '3':
5385 raw_p = 0, type = PBM_COLOR;
5386 break;
5388 case '4':
5389 raw_p = 1, type = PBM_MONO;
5390 break;
5392 case '5':
5393 raw_p = 1, type = PBM_GRAY;
5394 break;
5396 case '6':
5397 raw_p = 1, type = PBM_COLOR;
5398 break;
5400 default:
5401 image_error ("Not a PBM image: `%s'", img->spec, Qnil);
5402 goto error;
5405 /* Read width, height, maximum color-component. Characters
5406 starting with `#' up to the end of a line are ignored. */
5407 width = pbm_scan_number (&p, end);
5408 height = pbm_scan_number (&p, end);
5410 if (type != PBM_MONO)
5412 max_color_idx = pbm_scan_number (&p, end);
5413 if (raw_p && max_color_idx > 255)
5414 max_color_idx = 255;
5417 if (width < 0
5418 || height < 0
5419 || (type != PBM_MONO && max_color_idx < 0))
5420 goto error;
5422 if (!x_create_x_image_and_pixmap (f, width, height, 0,
5423 &ximg, &img->pixmap))
5424 goto error;
5426 /* Initialize the color hash table. */
5427 init_color_table ();
5429 if (type == PBM_MONO)
5431 int c = 0, g;
5432 struct image_keyword fmt[PBM_LAST];
5433 unsigned long fg = FRAME_FOREGROUND_PIXEL (f);
5434 unsigned long bg = FRAME_BACKGROUND_PIXEL (f);
5436 /* Parse the image specification. */
5437 bcopy (pbm_format, fmt, sizeof fmt);
5438 parse_image_spec (img->spec, fmt, PBM_LAST, Qpbm);
5440 /* Get foreground and background colors, maybe allocate colors. */
5441 if (fmt[PBM_FOREGROUND].count
5442 && STRINGP (fmt[PBM_FOREGROUND].value))
5443 fg = x_alloc_image_color (f, img, fmt[PBM_FOREGROUND].value, fg);
5444 if (fmt[PBM_BACKGROUND].count
5445 && STRINGP (fmt[PBM_BACKGROUND].value))
5447 bg = x_alloc_image_color (f, img, fmt[PBM_BACKGROUND].value, bg);
5448 img->background = bg;
5449 img->background_valid = 1;
5452 for (y = 0; y < height; ++y)
5453 for (x = 0; x < width; ++x)
5455 if (raw_p)
5457 if ((x & 7) == 0)
5458 c = *p++;
5459 g = c & 0x80;
5460 c <<= 1;
5462 else
5463 g = pbm_scan_number (&p, end);
5465 XPutPixel (ximg, x, y, g ? fg : bg);
5468 else
5470 for (y = 0; y < height; ++y)
5471 for (x = 0; x < width; ++x)
5473 int r, g, b;
5475 if (type == PBM_GRAY)
5476 r = g = b = raw_p ? *p++ : pbm_scan_number (&p, end);
5477 else if (raw_p)
5479 r = *p++;
5480 g = *p++;
5481 b = *p++;
5483 else
5485 r = pbm_scan_number (&p, end);
5486 g = pbm_scan_number (&p, end);
5487 b = pbm_scan_number (&p, end);
5490 if (r < 0 || g < 0 || b < 0)
5492 x_destroy_x_image (ximg);
5493 image_error ("Invalid pixel value in image `%s'",
5494 img->spec, Qnil);
5495 goto error;
5498 /* RGB values are now in the range 0..max_color_idx.
5499 Scale this to the range 0..0xffff supported by X. */
5500 r = (double) r * 65535 / max_color_idx;
5501 g = (double) g * 65535 / max_color_idx;
5502 b = (double) b * 65535 / max_color_idx;
5503 XPutPixel (ximg, x, y, lookup_rgb_color (f, r, g, b));
5507 #ifdef COLOR_TABLE_SUPPORT
5508 /* Store in IMG->colors the colors allocated for the image, and
5509 free the color table. */
5510 img->colors = colors_in_color_table (&img->ncolors);
5511 free_color_table ();
5512 #endif /* COLOR_TABLE_SUPPORT */
5514 img->width = width;
5515 img->height = height;
5517 /* Maybe fill in the background field while we have ximg handy. */
5519 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
5520 IMAGE_BACKGROUND (img, f, ximg);
5522 /* Put the image into a pixmap. */
5523 x_put_x_image (f, ximg, img->pixmap, width, height);
5524 x_destroy_x_image (ximg);
5526 /* X and W32 versions did it here, MAC version above. ++kfs
5527 img->width = width;
5528 img->height = height; */
5530 UNGCPRO;
5531 xfree (contents);
5532 return 1;
5536 /***********************************************************************
5538 ***********************************************************************/
5540 #if defined (HAVE_PNG) || defined (MAC_OS)
5542 /* Function prototypes. */
5544 static int png_image_p P_ ((Lisp_Object object));
5545 static int png_load P_ ((struct frame *f, struct image *img));
5547 /* The symbol `png' identifying images of this type. */
5549 Lisp_Object Qpng;
5551 /* Indices of image specification fields in png_format, below. */
5553 enum png_keyword_index
5555 PNG_TYPE,
5556 PNG_DATA,
5557 PNG_FILE,
5558 PNG_ASCENT,
5559 PNG_MARGIN,
5560 PNG_RELIEF,
5561 PNG_ALGORITHM,
5562 PNG_HEURISTIC_MASK,
5563 PNG_MASK,
5564 PNG_BACKGROUND,
5565 PNG_LAST
5568 /* Vector of image_keyword structures describing the format
5569 of valid user-defined image specifications. */
5571 static struct image_keyword png_format[PNG_LAST] =
5573 {":type", IMAGE_SYMBOL_VALUE, 1},
5574 {":data", IMAGE_STRING_VALUE, 0},
5575 {":file", IMAGE_STRING_VALUE, 0},
5576 {":ascent", IMAGE_ASCENT_VALUE, 0},
5577 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
5578 {":relief", IMAGE_INTEGER_VALUE, 0},
5579 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
5580 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
5581 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
5582 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
5585 /* Structure describing the image type `png'. */
5587 static struct image_type png_type =
5589 &Qpng,
5590 png_image_p,
5591 png_load,
5592 x_clear_image,
5593 NULL
5596 /* Return non-zero if OBJECT is a valid PNG image specification. */
5598 static int
5599 png_image_p (object)
5600 Lisp_Object object;
5602 struct image_keyword fmt[PNG_LAST];
5603 bcopy (png_format, fmt, sizeof fmt);
5605 if (!parse_image_spec (object, fmt, PNG_LAST, Qpng))
5606 return 0;
5608 /* Must specify either the :data or :file keyword. */
5609 return fmt[PNG_FILE].count + fmt[PNG_DATA].count == 1;
5612 #endif /* HAVE_PNG || MAC_OS */
5615 #ifdef HAVE_PNG
5617 #if defined HAVE_LIBPNG_PNG_H
5618 # include <libpng/png.h>
5619 #else
5620 # include <png.h>
5621 #endif
5623 #ifdef HAVE_NTGUI
5624 /* PNG library details. */
5626 DEF_IMGLIB_FN (png_get_io_ptr);
5627 DEF_IMGLIB_FN (png_check_sig);
5628 DEF_IMGLIB_FN (png_create_read_struct);
5629 DEF_IMGLIB_FN (png_create_info_struct);
5630 DEF_IMGLIB_FN (png_destroy_read_struct);
5631 DEF_IMGLIB_FN (png_set_read_fn);
5632 DEF_IMGLIB_FN (png_init_io);
5633 DEF_IMGLIB_FN (png_set_sig_bytes);
5634 DEF_IMGLIB_FN (png_read_info);
5635 DEF_IMGLIB_FN (png_get_IHDR);
5636 DEF_IMGLIB_FN (png_get_valid);
5637 DEF_IMGLIB_FN (png_set_strip_16);
5638 DEF_IMGLIB_FN (png_set_expand);
5639 DEF_IMGLIB_FN (png_set_gray_to_rgb);
5640 DEF_IMGLIB_FN (png_set_background);
5641 DEF_IMGLIB_FN (png_get_bKGD);
5642 DEF_IMGLIB_FN (png_read_update_info);
5643 DEF_IMGLIB_FN (png_get_channels);
5644 DEF_IMGLIB_FN (png_get_rowbytes);
5645 DEF_IMGLIB_FN (png_read_image);
5646 DEF_IMGLIB_FN (png_read_end);
5647 DEF_IMGLIB_FN (png_error);
5649 static int
5650 init_png_functions (Lisp_Object libraries)
5652 HMODULE library;
5654 /* Try loading libpng under probable names. */
5655 if (!(library = w32_delayed_load (libraries, Qpng)))
5656 return 0;
5658 LOAD_IMGLIB_FN (library, png_get_io_ptr);
5659 LOAD_IMGLIB_FN (library, png_check_sig);
5660 LOAD_IMGLIB_FN (library, png_create_read_struct);
5661 LOAD_IMGLIB_FN (library, png_create_info_struct);
5662 LOAD_IMGLIB_FN (library, png_destroy_read_struct);
5663 LOAD_IMGLIB_FN (library, png_set_read_fn);
5664 LOAD_IMGLIB_FN (library, png_init_io);
5665 LOAD_IMGLIB_FN (library, png_set_sig_bytes);
5666 LOAD_IMGLIB_FN (library, png_read_info);
5667 LOAD_IMGLIB_FN (library, png_get_IHDR);
5668 LOAD_IMGLIB_FN (library, png_get_valid);
5669 LOAD_IMGLIB_FN (library, png_set_strip_16);
5670 LOAD_IMGLIB_FN (library, png_set_expand);
5671 LOAD_IMGLIB_FN (library, png_set_gray_to_rgb);
5672 LOAD_IMGLIB_FN (library, png_set_background);
5673 LOAD_IMGLIB_FN (library, png_get_bKGD);
5674 LOAD_IMGLIB_FN (library, png_read_update_info);
5675 LOAD_IMGLIB_FN (library, png_get_channels);
5676 LOAD_IMGLIB_FN (library, png_get_rowbytes);
5677 LOAD_IMGLIB_FN (library, png_read_image);
5678 LOAD_IMGLIB_FN (library, png_read_end);
5679 LOAD_IMGLIB_FN (library, png_error);
5680 return 1;
5682 #else
5684 #define fn_png_get_io_ptr png_get_io_ptr
5685 #define fn_png_check_sig png_check_sig
5686 #define fn_png_create_read_struct png_create_read_struct
5687 #define fn_png_create_info_struct png_create_info_struct
5688 #define fn_png_destroy_read_struct png_destroy_read_struct
5689 #define fn_png_set_read_fn png_set_read_fn
5690 #define fn_png_init_io png_init_io
5691 #define fn_png_set_sig_bytes png_set_sig_bytes
5692 #define fn_png_read_info png_read_info
5693 #define fn_png_get_IHDR png_get_IHDR
5694 #define fn_png_get_valid png_get_valid
5695 #define fn_png_set_strip_16 png_set_strip_16
5696 #define fn_png_set_expand png_set_expand
5697 #define fn_png_set_gray_to_rgb png_set_gray_to_rgb
5698 #define fn_png_set_background png_set_background
5699 #define fn_png_get_bKGD png_get_bKGD
5700 #define fn_png_read_update_info png_read_update_info
5701 #define fn_png_get_channels png_get_channels
5702 #define fn_png_get_rowbytes png_get_rowbytes
5703 #define fn_png_read_image png_read_image
5704 #define fn_png_read_end png_read_end
5705 #define fn_png_error png_error
5707 #endif /* HAVE_NTGUI */
5709 /* Error and warning handlers installed when the PNG library
5710 is initialized. */
5712 static void
5713 my_png_error (png_ptr, msg)
5714 png_struct *png_ptr;
5715 char *msg;
5717 xassert (png_ptr != NULL);
5718 image_error ("PNG error: %s", build_string (msg), Qnil);
5719 longjmp (png_ptr->jmpbuf, 1);
5723 static void
5724 my_png_warning (png_ptr, msg)
5725 png_struct *png_ptr;
5726 char *msg;
5728 xassert (png_ptr != NULL);
5729 image_error ("PNG warning: %s", build_string (msg), Qnil);
5732 /* Memory source for PNG decoding. */
5734 struct png_memory_storage
5736 unsigned char *bytes; /* The data */
5737 size_t len; /* How big is it? */
5738 int index; /* Where are we? */
5742 /* Function set as reader function when reading PNG image from memory.
5743 PNG_PTR is a pointer to the PNG control structure. Copy LENGTH
5744 bytes from the input to DATA. */
5746 static void
5747 png_read_from_memory (png_ptr, data, length)
5748 png_structp png_ptr;
5749 png_bytep data;
5750 png_size_t length;
5752 struct png_memory_storage *tbr
5753 = (struct png_memory_storage *) fn_png_get_io_ptr (png_ptr);
5755 if (length > tbr->len - tbr->index)
5756 fn_png_error (png_ptr, "Read error");
5758 bcopy (tbr->bytes + tbr->index, data, length);
5759 tbr->index = tbr->index + length;
5763 /* Load PNG image IMG for use on frame F. Value is non-zero if
5764 successful. */
5766 static int
5767 png_load (f, img)
5768 struct frame *f;
5769 struct image *img;
5771 Lisp_Object file, specified_file;
5772 Lisp_Object specified_data;
5773 int x, y, i;
5774 XImagePtr ximg, mask_img = NULL;
5775 struct gcpro gcpro1;
5776 png_struct *png_ptr = NULL;
5777 png_info *info_ptr = NULL, *end_info = NULL;
5778 FILE *volatile fp = NULL;
5779 png_byte sig[8];
5780 png_byte * volatile pixels = NULL;
5781 png_byte ** volatile rows = NULL;
5782 png_uint_32 width, height;
5783 int bit_depth, color_type, interlace_type;
5784 png_byte channels;
5785 png_uint_32 row_bytes;
5786 int transparent_p;
5787 double screen_gamma;
5788 struct png_memory_storage tbr; /* Data to be read */
5790 /* Find out what file to load. */
5791 specified_file = image_spec_value (img->spec, QCfile, NULL);
5792 specified_data = image_spec_value (img->spec, QCdata, NULL);
5793 file = Qnil;
5794 GCPRO1 (file);
5796 if (NILP (specified_data))
5798 file = x_find_image_file (specified_file);
5799 if (!STRINGP (file))
5801 image_error ("Cannot find image file `%s'", specified_file, Qnil);
5802 UNGCPRO;
5803 return 0;
5806 /* Open the image file. */
5807 fp = fopen (SDATA (file), "rb");
5808 if (!fp)
5810 image_error ("Cannot open image file `%s'", file, Qnil);
5811 UNGCPRO;
5812 fclose (fp);
5813 return 0;
5816 /* Check PNG signature. */
5817 if (fread (sig, 1, sizeof sig, fp) != sizeof sig
5818 || !fn_png_check_sig (sig, sizeof sig))
5820 image_error ("Not a PNG file: `%s'", file, Qnil);
5821 UNGCPRO;
5822 fclose (fp);
5823 return 0;
5826 else
5828 /* Read from memory. */
5829 tbr.bytes = SDATA (specified_data);
5830 tbr.len = SBYTES (specified_data);
5831 tbr.index = 0;
5833 /* Check PNG signature. */
5834 if (tbr.len < sizeof sig
5835 || !fn_png_check_sig (tbr.bytes, sizeof sig))
5837 image_error ("Not a PNG image: `%s'", img->spec, Qnil);
5838 UNGCPRO;
5839 return 0;
5842 /* Need to skip past the signature. */
5843 tbr.bytes += sizeof (sig);
5846 /* Initialize read and info structs for PNG lib. */
5847 png_ptr = fn_png_create_read_struct (PNG_LIBPNG_VER_STRING, NULL,
5848 my_png_error, my_png_warning);
5849 if (!png_ptr)
5851 if (fp) fclose (fp);
5852 UNGCPRO;
5853 return 0;
5856 info_ptr = fn_png_create_info_struct (png_ptr);
5857 if (!info_ptr)
5859 fn_png_destroy_read_struct (&png_ptr, NULL, NULL);
5860 if (fp) fclose (fp);
5861 UNGCPRO;
5862 return 0;
5865 end_info = fn_png_create_info_struct (png_ptr);
5866 if (!end_info)
5868 fn_png_destroy_read_struct (&png_ptr, &info_ptr, NULL);
5869 if (fp) fclose (fp);
5870 UNGCPRO;
5871 return 0;
5874 /* Set error jump-back. We come back here when the PNG library
5875 detects an error. */
5876 if (setjmp (png_ptr->jmpbuf))
5878 error:
5879 if (png_ptr)
5880 fn_png_destroy_read_struct (&png_ptr, &info_ptr, &end_info);
5881 xfree (pixels);
5882 xfree (rows);
5883 if (fp) fclose (fp);
5884 UNGCPRO;
5885 return 0;
5888 /* Read image info. */
5889 if (!NILP (specified_data))
5890 fn_png_set_read_fn (png_ptr, (void *) &tbr, png_read_from_memory);
5891 else
5892 fn_png_init_io (png_ptr, fp);
5894 fn_png_set_sig_bytes (png_ptr, sizeof sig);
5895 fn_png_read_info (png_ptr, info_ptr);
5896 fn_png_get_IHDR (png_ptr, info_ptr, &width, &height, &bit_depth, &color_type,
5897 &interlace_type, NULL, NULL);
5899 /* If image contains simply transparency data, we prefer to
5900 construct a clipping mask. */
5901 if (fn_png_get_valid (png_ptr, info_ptr, PNG_INFO_tRNS))
5902 transparent_p = 1;
5903 else
5904 transparent_p = 0;
5906 /* This function is easier to write if we only have to handle
5907 one data format: RGB or RGBA with 8 bits per channel. Let's
5908 transform other formats into that format. */
5910 /* Strip more than 8 bits per channel. */
5911 if (bit_depth == 16)
5912 fn_png_set_strip_16 (png_ptr);
5914 /* Expand data to 24 bit RGB, or 8 bit grayscale, with alpha channel
5915 if available. */
5916 fn_png_set_expand (png_ptr);
5918 /* Convert grayscale images to RGB. */
5919 if (color_type == PNG_COLOR_TYPE_GRAY
5920 || color_type == PNG_COLOR_TYPE_GRAY_ALPHA)
5921 fn_png_set_gray_to_rgb (png_ptr);
5923 screen_gamma = (f->gamma ? 1 / f->gamma / 0.45455 : 2.2);
5925 #if 0 /* Avoid double gamma correction for PNG images. */
5926 { /* Tell the PNG lib to handle gamma correction for us. */
5927 int intent;
5928 double image_gamma;
5929 #if defined(PNG_READ_sRGB_SUPPORTED) || defined(PNG_WRITE_sRGB_SUPPORTED)
5930 if (png_get_sRGB (png_ptr, info_ptr, &intent))
5931 /* The libpng documentation says this is right in this case. */
5932 png_set_gamma (png_ptr, screen_gamma, 0.45455);
5933 else
5934 #endif
5935 if (png_get_gAMA (png_ptr, info_ptr, &image_gamma))
5936 /* Image contains gamma information. */
5937 png_set_gamma (png_ptr, screen_gamma, image_gamma);
5938 else
5939 /* Use the standard default for the image gamma. */
5940 png_set_gamma (png_ptr, screen_gamma, 0.45455);
5942 #endif /* if 0 */
5944 /* Handle alpha channel by combining the image with a background
5945 color. Do this only if a real alpha channel is supplied. For
5946 simple transparency, we prefer a clipping mask. */
5947 if (!transparent_p)
5949 png_color_16 *image_bg;
5950 Lisp_Object specified_bg
5951 = image_spec_value (img->spec, QCbackground, NULL);
5953 if (STRINGP (specified_bg))
5954 /* The user specified `:background', use that. */
5956 /* W32 version incorrectly used COLORREF here!! ++kfs */
5957 XColor color;
5958 if (x_defined_color (f, SDATA (specified_bg), &color, 0))
5960 png_color_16 user_bg;
5962 bzero (&user_bg, sizeof user_bg);
5963 user_bg.red = color.red >> 8;
5964 user_bg.green = color.green >> 8;
5965 user_bg.blue = color.blue >> 8;
5967 fn_png_set_background (png_ptr, &user_bg,
5968 PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
5971 else if (fn_png_get_bKGD (png_ptr, info_ptr, &image_bg))
5972 /* Image contains a background color with which to
5973 combine the image. */
5974 fn_png_set_background (png_ptr, image_bg,
5975 PNG_BACKGROUND_GAMMA_FILE, 1, 1.0);
5976 else
5978 /* Image does not contain a background color with which
5979 to combine the image data via an alpha channel. Use
5980 the frame's background instead. */
5981 #ifdef HAVE_X_WINDOWS
5982 XColor color;
5983 png_color_16 frame_background;
5985 color.pixel = FRAME_BACKGROUND_PIXEL (f);
5986 x_query_color (f, &color);
5988 bzero (&frame_background, sizeof frame_background);
5989 frame_background.red = color.red >> 8;
5990 frame_background.green = color.green >> 8;
5991 frame_background.blue = color.blue >> 8;
5992 #endif /* HAVE_X_WINDOWS */
5994 #ifdef HAVE_NTGUI
5995 COLORREF color;
5996 png_color_16 frame_background;
5997 color = FRAME_BACKGROUND_PIXEL (f);
5998 #if 0 /* W32 TODO : Colormap support. */
5999 x_query_color (f, &color);
6000 #endif
6001 bzero (&frame_background, sizeof frame_background);
6002 frame_background.red = GetRValue (color);
6003 frame_background.green = GetGValue (color);
6004 frame_background.blue = GetBValue (color);
6005 #endif /* HAVE_NTGUI */
6007 #ifdef MAC_OS
6008 unsigned long color;
6009 png_color_16 frame_background;
6010 color = FRAME_BACKGROUND_PIXEL (f);
6011 #if 0 /* MAC/W32 TODO : Colormap support. */
6012 x_query_color (f, &color);
6013 #endif
6014 bzero (&frame_background, sizeof frame_background);
6015 frame_background.red = RED_FROM_ULONG (color);
6016 frame_background.green = GREEN_FROM_ULONG (color);
6017 frame_background.blue = BLUE_FROM_ULONG (color);
6018 #endif /* MAC_OS */
6020 fn_png_set_background (png_ptr, &frame_background,
6021 PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
6025 /* Update info structure. */
6026 fn_png_read_update_info (png_ptr, info_ptr);
6028 /* Get number of channels. Valid values are 1 for grayscale images
6029 and images with a palette, 2 for grayscale images with transparency
6030 information (alpha channel), 3 for RGB images, and 4 for RGB
6031 images with alpha channel, i.e. RGBA. If conversions above were
6032 sufficient we should only have 3 or 4 channels here. */
6033 channels = fn_png_get_channels (png_ptr, info_ptr);
6034 xassert (channels == 3 || channels == 4);
6036 /* Number of bytes needed for one row of the image. */
6037 row_bytes = fn_png_get_rowbytes (png_ptr, info_ptr);
6039 /* Allocate memory for the image. */
6040 pixels = (png_byte *) xmalloc (row_bytes * height * sizeof *pixels);
6041 rows = (png_byte **) xmalloc (height * sizeof *rows);
6042 for (i = 0; i < height; ++i)
6043 rows[i] = pixels + i * row_bytes;
6045 /* Read the entire image. */
6046 fn_png_read_image (png_ptr, rows);
6047 fn_png_read_end (png_ptr, info_ptr);
6048 if (fp)
6050 fclose (fp);
6051 fp = NULL;
6054 /* Create the X image and pixmap. */
6055 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg,
6056 &img->pixmap))
6057 goto error;
6059 /* Create an image and pixmap serving as mask if the PNG image
6060 contains an alpha channel. */
6061 if (channels == 4
6062 && !transparent_p
6063 && !x_create_x_image_and_pixmap (f, width, height, 1,
6064 &mask_img, &img->mask))
6066 x_destroy_x_image (ximg);
6067 Free_Pixmap (FRAME_X_DISPLAY (f), img->pixmap);
6068 img->pixmap = NO_PIXMAP;
6069 goto error;
6072 /* Fill the X image and mask from PNG data. */
6073 init_color_table ();
6075 for (y = 0; y < height; ++y)
6077 png_byte *p = rows[y];
6079 for (x = 0; x < width; ++x)
6081 unsigned r, g, b;
6083 r = *p++ << 8;
6084 g = *p++ << 8;
6085 b = *p++ << 8;
6086 XPutPixel (ximg, x, y, lookup_rgb_color (f, r, g, b));
6087 /* An alpha channel, aka mask channel, associates variable
6088 transparency with an image. Where other image formats
6089 support binary transparency---fully transparent or fully
6090 opaque---PNG allows up to 254 levels of partial transparency.
6091 The PNG library implements partial transparency by combining
6092 the image with a specified background color.
6094 I'm not sure how to handle this here nicely: because the
6095 background on which the image is displayed may change, for
6096 real alpha channel support, it would be necessary to create
6097 a new image for each possible background.
6099 What I'm doing now is that a mask is created if we have
6100 boolean transparency information. Otherwise I'm using
6101 the frame's background color to combine the image with. */
6103 if (channels == 4)
6105 if (mask_img)
6106 XPutPixel (mask_img, x, y, *p > 0 ? PIX_MASK_DRAW (f) : PIX_MASK_RETAIN (f));
6107 ++p;
6112 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
6113 /* Set IMG's background color from the PNG image, unless the user
6114 overrode it. */
6116 png_color_16 *bg;
6117 if (fn_png_get_bKGD (png_ptr, info_ptr, &bg))
6119 img->background = lookup_rgb_color (f, bg->red, bg->green, bg->blue);
6120 img->background_valid = 1;
6124 #ifdef COLOR_TABLE_SUPPORT
6125 /* Remember colors allocated for this image. */
6126 img->colors = colors_in_color_table (&img->ncolors);
6127 free_color_table ();
6128 #endif /* COLOR_TABLE_SUPPORT */
6130 /* Clean up. */
6131 fn_png_destroy_read_struct (&png_ptr, &info_ptr, &end_info);
6132 xfree (rows);
6133 xfree (pixels);
6135 img->width = width;
6136 img->height = height;
6138 /* Maybe fill in the background field while we have ximg handy. */
6139 IMAGE_BACKGROUND (img, f, ximg);
6141 /* Put the image into the pixmap, then free the X image and its buffer. */
6142 x_put_x_image (f, ximg, img->pixmap, width, height);
6143 x_destroy_x_image (ximg);
6145 /* Same for the mask. */
6146 if (mask_img)
6148 /* Fill in the background_transparent field while we have the mask
6149 handy. */
6150 image_background_transparent (img, f, mask_img);
6152 x_put_x_image (f, mask_img, img->mask, img->width, img->height);
6153 x_destroy_x_image (mask_img);
6156 UNGCPRO;
6157 return 1;
6160 #else /* HAVE_PNG */
6162 #ifdef MAC_OS
6163 static int
6164 png_load (f, img)
6165 struct frame *f;
6166 struct image *img;
6168 #ifdef MAC_OSX
6169 if (MyCGImageCreateWithPNGDataProvider)
6170 return image_load_quartz2d (f, img, 1);
6171 else
6172 #endif
6173 return image_load_quicktime (f, img, kQTFileTypePNG);
6175 #endif /* MAC_OS */
6177 #endif /* !HAVE_PNG */
6181 /***********************************************************************
6182 JPEG
6183 ***********************************************************************/
6185 #if defined (HAVE_JPEG) || defined (MAC_OS)
6187 static int jpeg_image_p P_ ((Lisp_Object object));
6188 static int jpeg_load P_ ((struct frame *f, struct image *img));
6190 /* The symbol `jpeg' identifying images of this type. */
6192 Lisp_Object Qjpeg;
6194 /* Indices of image specification fields in gs_format, below. */
6196 enum jpeg_keyword_index
6198 JPEG_TYPE,
6199 JPEG_DATA,
6200 JPEG_FILE,
6201 JPEG_ASCENT,
6202 JPEG_MARGIN,
6203 JPEG_RELIEF,
6204 JPEG_ALGORITHM,
6205 JPEG_HEURISTIC_MASK,
6206 JPEG_MASK,
6207 JPEG_BACKGROUND,
6208 JPEG_LAST
6211 /* Vector of image_keyword structures describing the format
6212 of valid user-defined image specifications. */
6214 static struct image_keyword jpeg_format[JPEG_LAST] =
6216 {":type", IMAGE_SYMBOL_VALUE, 1},
6217 {":data", IMAGE_STRING_VALUE, 0},
6218 {":file", IMAGE_STRING_VALUE, 0},
6219 {":ascent", IMAGE_ASCENT_VALUE, 0},
6220 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
6221 {":relief", IMAGE_INTEGER_VALUE, 0},
6222 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6223 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6224 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6225 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
6228 /* Structure describing the image type `jpeg'. */
6230 static struct image_type jpeg_type =
6232 &Qjpeg,
6233 jpeg_image_p,
6234 jpeg_load,
6235 x_clear_image,
6236 NULL
6239 /* Return non-zero if OBJECT is a valid JPEG image specification. */
6241 static int
6242 jpeg_image_p (object)
6243 Lisp_Object object;
6245 struct image_keyword fmt[JPEG_LAST];
6247 bcopy (jpeg_format, fmt, sizeof fmt);
6249 if (!parse_image_spec (object, fmt, JPEG_LAST, Qjpeg))
6250 return 0;
6252 /* Must specify either the :data or :file keyword. */
6253 return fmt[JPEG_FILE].count + fmt[JPEG_DATA].count == 1;
6256 #endif /* HAVE_JPEG || MAC_OS */
6258 #ifdef HAVE_JPEG
6260 /* Work around a warning about HAVE_STDLIB_H being redefined in
6261 jconfig.h. */
6262 #ifdef HAVE_STDLIB_H
6263 #define HAVE_STDLIB_H_1
6264 #undef HAVE_STDLIB_H
6265 #endif /* HAVE_STLIB_H */
6267 #if defined (HAVE_NTGUI) && !defined (__WIN32__)
6268 /* jpeglib.h will define boolean differently depending on __WIN32__,
6269 so make sure it is defined. */
6270 #define __WIN32__ 1
6271 #endif
6273 #include <jpeglib.h>
6274 #include <jerror.h>
6275 #include <setjmp.h>
6277 #ifdef HAVE_STLIB_H_1
6278 #define HAVE_STDLIB_H 1
6279 #endif
6281 #ifdef HAVE_NTGUI
6283 /* JPEG library details. */
6284 DEF_IMGLIB_FN (jpeg_CreateDecompress);
6285 DEF_IMGLIB_FN (jpeg_start_decompress);
6286 DEF_IMGLIB_FN (jpeg_finish_decompress);
6287 DEF_IMGLIB_FN (jpeg_destroy_decompress);
6288 DEF_IMGLIB_FN (jpeg_read_header);
6289 DEF_IMGLIB_FN (jpeg_read_scanlines);
6290 DEF_IMGLIB_FN (jpeg_stdio_src);
6291 DEF_IMGLIB_FN (jpeg_std_error);
6292 DEF_IMGLIB_FN (jpeg_resync_to_restart);
6294 static int
6295 init_jpeg_functions (Lisp_Object libraries)
6297 HMODULE library;
6299 if (!(library = w32_delayed_load (libraries, Qjpeg)))
6300 return 0;
6302 LOAD_IMGLIB_FN (library, jpeg_finish_decompress);
6303 LOAD_IMGLIB_FN (library, jpeg_read_scanlines);
6304 LOAD_IMGLIB_FN (library, jpeg_start_decompress);
6305 LOAD_IMGLIB_FN (library, jpeg_read_header);
6306 LOAD_IMGLIB_FN (library, jpeg_stdio_src);
6307 LOAD_IMGLIB_FN (library, jpeg_CreateDecompress);
6308 LOAD_IMGLIB_FN (library, jpeg_destroy_decompress);
6309 LOAD_IMGLIB_FN (library, jpeg_std_error);
6310 LOAD_IMGLIB_FN (library, jpeg_resync_to_restart);
6311 return 1;
6314 /* Wrapper since we can't directly assign the function pointer
6315 to another function pointer that was declared more completely easily. */
6316 static boolean
6317 jpeg_resync_to_restart_wrapper(cinfo, desired)
6318 j_decompress_ptr cinfo;
6319 int desired;
6321 return fn_jpeg_resync_to_restart (cinfo, desired);
6324 #else
6326 #define fn_jpeg_CreateDecompress(a,b,c) jpeg_create_decompress(a)
6327 #define fn_jpeg_start_decompress jpeg_start_decompress
6328 #define fn_jpeg_finish_decompress jpeg_finish_decompress
6329 #define fn_jpeg_destroy_decompress jpeg_destroy_decompress
6330 #define fn_jpeg_read_header jpeg_read_header
6331 #define fn_jpeg_read_scanlines jpeg_read_scanlines
6332 #define fn_jpeg_stdio_src jpeg_stdio_src
6333 #define fn_jpeg_std_error jpeg_std_error
6334 #define jpeg_resync_to_restart_wrapper jpeg_resync_to_restart
6336 #endif /* HAVE_NTGUI */
6338 struct my_jpeg_error_mgr
6340 struct jpeg_error_mgr pub;
6341 jmp_buf setjmp_buffer;
6345 static void
6346 my_error_exit (cinfo)
6347 j_common_ptr cinfo;
6349 struct my_jpeg_error_mgr *mgr = (struct my_jpeg_error_mgr *) cinfo->err;
6350 longjmp (mgr->setjmp_buffer, 1);
6354 /* Init source method for JPEG data source manager. Called by
6355 jpeg_read_header() before any data is actually read. See
6356 libjpeg.doc from the JPEG lib distribution. */
6358 static void
6359 our_init_source (cinfo)
6360 j_decompress_ptr cinfo;
6365 /* Fill input buffer method for JPEG data source manager. Called
6366 whenever more data is needed. We read the whole image in one step,
6367 so this only adds a fake end of input marker at the end. */
6369 static boolean
6370 our_fill_input_buffer (cinfo)
6371 j_decompress_ptr cinfo;
6373 /* Insert a fake EOI marker. */
6374 struct jpeg_source_mgr *src = cinfo->src;
6375 static JOCTET buffer[2];
6377 buffer[0] = (JOCTET) 0xFF;
6378 buffer[1] = (JOCTET) JPEG_EOI;
6380 src->next_input_byte = buffer;
6381 src->bytes_in_buffer = 2;
6382 return 1;
6386 /* Method to skip over NUM_BYTES bytes in the image data. CINFO->src
6387 is the JPEG data source manager. */
6389 static void
6390 our_skip_input_data (cinfo, num_bytes)
6391 j_decompress_ptr cinfo;
6392 long num_bytes;
6394 struct jpeg_source_mgr *src = (struct jpeg_source_mgr *) cinfo->src;
6396 if (src)
6398 if (num_bytes > src->bytes_in_buffer)
6399 ERREXIT (cinfo, JERR_INPUT_EOF);
6401 src->bytes_in_buffer -= num_bytes;
6402 src->next_input_byte += num_bytes;
6407 /* Method to terminate data source. Called by
6408 jpeg_finish_decompress() after all data has been processed. */
6410 static void
6411 our_term_source (cinfo)
6412 j_decompress_ptr cinfo;
6417 /* Set up the JPEG lib for reading an image from DATA which contains
6418 LEN bytes. CINFO is the decompression info structure created for
6419 reading the image. */
6421 static void
6422 jpeg_memory_src (cinfo, data, len)
6423 j_decompress_ptr cinfo;
6424 JOCTET *data;
6425 unsigned int len;
6427 struct jpeg_source_mgr *src;
6429 if (cinfo->src == NULL)
6431 /* First time for this JPEG object? */
6432 cinfo->src = (struct jpeg_source_mgr *)
6433 (*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_PERMANENT,
6434 sizeof (struct jpeg_source_mgr));
6435 src = (struct jpeg_source_mgr *) cinfo->src;
6436 src->next_input_byte = data;
6439 src = (struct jpeg_source_mgr *) cinfo->src;
6440 src->init_source = our_init_source;
6441 src->fill_input_buffer = our_fill_input_buffer;
6442 src->skip_input_data = our_skip_input_data;
6443 src->resync_to_restart = jpeg_resync_to_restart_wrapper; /* Use default method. */
6444 src->term_source = our_term_source;
6445 src->bytes_in_buffer = len;
6446 src->next_input_byte = data;
6450 /* Load image IMG for use on frame F. Patterned after example.c
6451 from the JPEG lib. */
6453 static int
6454 jpeg_load (f, img)
6455 struct frame *f;
6456 struct image *img;
6458 struct jpeg_decompress_struct cinfo;
6459 struct my_jpeg_error_mgr mgr;
6460 Lisp_Object file, specified_file;
6461 Lisp_Object specified_data;
6462 FILE * volatile fp = NULL;
6463 JSAMPARRAY buffer;
6464 int row_stride, x, y;
6465 XImagePtr ximg = NULL;
6466 int rc;
6467 unsigned long *colors;
6468 int width, height;
6469 struct gcpro gcpro1;
6471 /* Open the JPEG file. */
6472 specified_file = image_spec_value (img->spec, QCfile, NULL);
6473 specified_data = image_spec_value (img->spec, QCdata, NULL);
6474 file = Qnil;
6475 GCPRO1 (file);
6477 if (NILP (specified_data))
6479 file = x_find_image_file (specified_file);
6480 if (!STRINGP (file))
6482 image_error ("Cannot find image file `%s'", specified_file, Qnil);
6483 UNGCPRO;
6484 return 0;
6487 fp = fopen (SDATA (file), "rb");
6488 if (fp == NULL)
6490 image_error ("Cannot open `%s'", file, Qnil);
6491 UNGCPRO;
6492 return 0;
6496 /* Customize libjpeg's error handling to call my_error_exit when an
6497 error is detected. This function will perform a longjmp. */
6498 cinfo.err = fn_jpeg_std_error (&mgr.pub);
6499 mgr.pub.error_exit = my_error_exit;
6501 if ((rc = setjmp (mgr.setjmp_buffer)) != 0)
6503 if (rc == 1)
6505 /* Called from my_error_exit. Display a JPEG error. */
6506 char buffer[JMSG_LENGTH_MAX];
6507 cinfo.err->format_message ((j_common_ptr) &cinfo, buffer);
6508 image_error ("Error reading JPEG image `%s': %s", img->spec,
6509 build_string (buffer));
6512 /* Close the input file and destroy the JPEG object. */
6513 if (fp)
6514 fclose ((FILE *) fp);
6515 fn_jpeg_destroy_decompress (&cinfo);
6517 /* If we already have an XImage, free that. */
6518 x_destroy_x_image (ximg);
6520 /* Free pixmap and colors. */
6521 x_clear_image (f, img);
6523 UNGCPRO;
6524 return 0;
6527 /* Create the JPEG decompression object. Let it read from fp.
6528 Read the JPEG image header. */
6529 fn_jpeg_CreateDecompress (&cinfo, JPEG_LIB_VERSION, sizeof (cinfo));
6531 if (NILP (specified_data))
6532 fn_jpeg_stdio_src (&cinfo, (FILE *) fp);
6533 else
6534 jpeg_memory_src (&cinfo, SDATA (specified_data),
6535 SBYTES (specified_data));
6537 fn_jpeg_read_header (&cinfo, 1);
6539 /* Customize decompression so that color quantization will be used.
6540 Start decompression. */
6541 cinfo.quantize_colors = 1;
6542 fn_jpeg_start_decompress (&cinfo);
6543 width = img->width = cinfo.output_width;
6544 height = img->height = cinfo.output_height;
6546 /* Create X image and pixmap. */
6547 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
6548 longjmp (mgr.setjmp_buffer, 2);
6550 /* Allocate colors. When color quantization is used,
6551 cinfo.actual_number_of_colors has been set with the number of
6552 colors generated, and cinfo.colormap is a two-dimensional array
6553 of color indices in the range 0..cinfo.actual_number_of_colors.
6554 No more than 255 colors will be generated. */
6556 int i, ir, ig, ib;
6558 if (cinfo.out_color_components > 2)
6559 ir = 0, ig = 1, ib = 2;
6560 else if (cinfo.out_color_components > 1)
6561 ir = 0, ig = 1, ib = 0;
6562 else
6563 ir = 0, ig = 0, ib = 0;
6565 /* Use the color table mechanism because it handles colors that
6566 cannot be allocated nicely. Such colors will be replaced with
6567 a default color, and we don't have to care about which colors
6568 can be freed safely, and which can't. */
6569 init_color_table ();
6570 colors = (unsigned long *) alloca (cinfo.actual_number_of_colors
6571 * sizeof *colors);
6573 for (i = 0; i < cinfo.actual_number_of_colors; ++i)
6575 /* Multiply RGB values with 255 because X expects RGB values
6576 in the range 0..0xffff. */
6577 int r = cinfo.colormap[ir][i] << 8;
6578 int g = cinfo.colormap[ig][i] << 8;
6579 int b = cinfo.colormap[ib][i] << 8;
6580 colors[i] = lookup_rgb_color (f, r, g, b);
6583 #ifdef COLOR_TABLE_SUPPORT
6584 /* Remember those colors actually allocated. */
6585 img->colors = colors_in_color_table (&img->ncolors);
6586 free_color_table ();
6587 #endif /* COLOR_TABLE_SUPPORT */
6590 /* Read pixels. */
6591 row_stride = width * cinfo.output_components;
6592 buffer = cinfo.mem->alloc_sarray ((j_common_ptr) &cinfo, JPOOL_IMAGE,
6593 row_stride, 1);
6594 for (y = 0; y < height; ++y)
6596 fn_jpeg_read_scanlines (&cinfo, buffer, 1);
6597 for (x = 0; x < cinfo.output_width; ++x)
6598 XPutPixel (ximg, x, y, colors[buffer[0][x]]);
6601 /* Clean up. */
6602 fn_jpeg_finish_decompress (&cinfo);
6603 fn_jpeg_destroy_decompress (&cinfo);
6604 if (fp)
6605 fclose ((FILE *) fp);
6607 /* Maybe fill in the background field while we have ximg handy. */
6608 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
6609 IMAGE_BACKGROUND (img, f, ximg);
6611 /* Put the image into the pixmap. */
6612 x_put_x_image (f, ximg, img->pixmap, width, height);
6613 x_destroy_x_image (ximg);
6614 UNGCPRO;
6615 return 1;
6618 #else /* HAVE_JPEG */
6620 #ifdef MAC_OS
6621 static int
6622 jpeg_load (f, img)
6623 struct frame *f;
6624 struct image *img;
6626 #ifdef MAC_OSX
6627 return image_load_quartz2d (f, img, 0);
6628 #else
6629 return image_load_quicktime (f, img, kQTFileTypeJPEG);
6630 #endif
6632 #endif /* MAC_OS */
6634 #endif /* !HAVE_JPEG */
6638 /***********************************************************************
6639 TIFF
6640 ***********************************************************************/
6642 #if defined (HAVE_TIFF) || defined (MAC_OS)
6644 static int tiff_image_p P_ ((Lisp_Object object));
6645 static int tiff_load P_ ((struct frame *f, struct image *img));
6647 /* The symbol `tiff' identifying images of this type. */
6649 Lisp_Object Qtiff;
6651 /* Indices of image specification fields in tiff_format, below. */
6653 enum tiff_keyword_index
6655 TIFF_TYPE,
6656 TIFF_DATA,
6657 TIFF_FILE,
6658 TIFF_ASCENT,
6659 TIFF_MARGIN,
6660 TIFF_RELIEF,
6661 TIFF_ALGORITHM,
6662 TIFF_HEURISTIC_MASK,
6663 TIFF_MASK,
6664 TIFF_BACKGROUND,
6665 TIFF_LAST
6668 /* Vector of image_keyword structures describing the format
6669 of valid user-defined image specifications. */
6671 static struct image_keyword tiff_format[TIFF_LAST] =
6673 {":type", IMAGE_SYMBOL_VALUE, 1},
6674 {":data", IMAGE_STRING_VALUE, 0},
6675 {":file", IMAGE_STRING_VALUE, 0},
6676 {":ascent", IMAGE_ASCENT_VALUE, 0},
6677 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
6678 {":relief", IMAGE_INTEGER_VALUE, 0},
6679 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6680 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6681 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6682 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
6685 /* Structure describing the image type `tiff'. */
6687 static struct image_type tiff_type =
6689 &Qtiff,
6690 tiff_image_p,
6691 tiff_load,
6692 x_clear_image,
6693 NULL
6696 /* Return non-zero if OBJECT is a valid TIFF image specification. */
6698 static int
6699 tiff_image_p (object)
6700 Lisp_Object object;
6702 struct image_keyword fmt[TIFF_LAST];
6703 bcopy (tiff_format, fmt, sizeof fmt);
6705 if (!parse_image_spec (object, fmt, TIFF_LAST, Qtiff))
6706 return 0;
6708 /* Must specify either the :data or :file keyword. */
6709 return fmt[TIFF_FILE].count + fmt[TIFF_DATA].count == 1;
6712 #endif /* HAVE_TIFF || MAC_OS */
6714 #ifdef HAVE_TIFF
6716 #include <tiffio.h>
6718 #ifdef HAVE_NTGUI
6720 /* TIFF library details. */
6721 DEF_IMGLIB_FN (TIFFSetErrorHandler);
6722 DEF_IMGLIB_FN (TIFFSetWarningHandler);
6723 DEF_IMGLIB_FN (TIFFOpen);
6724 DEF_IMGLIB_FN (TIFFClientOpen);
6725 DEF_IMGLIB_FN (TIFFGetField);
6726 DEF_IMGLIB_FN (TIFFReadRGBAImage);
6727 DEF_IMGLIB_FN (TIFFClose);
6729 static int
6730 init_tiff_functions (Lisp_Object libraries)
6732 HMODULE library;
6734 if (!(library = w32_delayed_load (libraries, Qtiff)))
6735 return 0;
6737 LOAD_IMGLIB_FN (library, TIFFSetErrorHandler);
6738 LOAD_IMGLIB_FN (library, TIFFSetWarningHandler);
6739 LOAD_IMGLIB_FN (library, TIFFOpen);
6740 LOAD_IMGLIB_FN (library, TIFFClientOpen);
6741 LOAD_IMGLIB_FN (library, TIFFGetField);
6742 LOAD_IMGLIB_FN (library, TIFFReadRGBAImage);
6743 LOAD_IMGLIB_FN (library, TIFFClose);
6744 return 1;
6747 #else
6749 #define fn_TIFFSetErrorHandler TIFFSetErrorHandler
6750 #define fn_TIFFSetWarningHandler TIFFSetWarningHandler
6751 #define fn_TIFFOpen TIFFOpen
6752 #define fn_TIFFClientOpen TIFFClientOpen
6753 #define fn_TIFFGetField TIFFGetField
6754 #define fn_TIFFReadRGBAImage TIFFReadRGBAImage
6755 #define fn_TIFFClose TIFFClose
6757 #endif /* HAVE_NTGUI */
6760 /* Reading from a memory buffer for TIFF images Based on the PNG
6761 memory source, but we have to provide a lot of extra functions.
6762 Blah.
6764 We really only need to implement read and seek, but I am not
6765 convinced that the TIFF library is smart enough not to destroy
6766 itself if we only hand it the function pointers we need to
6767 override. */
6769 typedef struct
6771 unsigned char *bytes;
6772 size_t len;
6773 int index;
6775 tiff_memory_source;
6777 static size_t
6778 tiff_read_from_memory (data, buf, size)
6779 thandle_t data;
6780 tdata_t buf;
6781 tsize_t size;
6783 tiff_memory_source *src = (tiff_memory_source *) data;
6785 if (size > src->len - src->index)
6786 return (size_t) -1;
6787 bcopy (src->bytes + src->index, buf, size);
6788 src->index += size;
6789 return size;
6792 static size_t
6793 tiff_write_from_memory (data, buf, size)
6794 thandle_t data;
6795 tdata_t buf;
6796 tsize_t size;
6798 return (size_t) -1;
6801 static toff_t
6802 tiff_seek_in_memory (data, off, whence)
6803 thandle_t data;
6804 toff_t off;
6805 int whence;
6807 tiff_memory_source *src = (tiff_memory_source *) data;
6808 int idx;
6810 switch (whence)
6812 case SEEK_SET: /* Go from beginning of source. */
6813 idx = off;
6814 break;
6816 case SEEK_END: /* Go from end of source. */
6817 idx = src->len + off;
6818 break;
6820 case SEEK_CUR: /* Go from current position. */
6821 idx = src->index + off;
6822 break;
6824 default: /* Invalid `whence'. */
6825 return -1;
6828 if (idx > src->len || idx < 0)
6829 return -1;
6831 src->index = idx;
6832 return src->index;
6835 static int
6836 tiff_close_memory (data)
6837 thandle_t data;
6839 /* NOOP */
6840 return 0;
6843 static int
6844 tiff_mmap_memory (data, pbase, psize)
6845 thandle_t data;
6846 tdata_t *pbase;
6847 toff_t *psize;
6849 /* It is already _IN_ memory. */
6850 return 0;
6853 static void
6854 tiff_unmap_memory (data, base, size)
6855 thandle_t data;
6856 tdata_t base;
6857 toff_t size;
6859 /* We don't need to do this. */
6862 static toff_t
6863 tiff_size_of_memory (data)
6864 thandle_t data;
6866 return ((tiff_memory_source *) data)->len;
6870 static void
6871 tiff_error_handler (title, format, ap)
6872 const char *title, *format;
6873 va_list ap;
6875 char buf[512];
6876 int len;
6878 len = sprintf (buf, "TIFF error: %s ", title);
6879 vsprintf (buf + len, format, ap);
6880 add_to_log (buf, Qnil, Qnil);
6884 static void
6885 tiff_warning_handler (title, format, ap)
6886 const char *title, *format;
6887 va_list ap;
6889 char buf[512];
6890 int len;
6892 len = sprintf (buf, "TIFF warning: %s ", title);
6893 vsprintf (buf + len, format, ap);
6894 add_to_log (buf, Qnil, Qnil);
6898 /* Load TIFF image IMG for use on frame F. Value is non-zero if
6899 successful. */
6901 static int
6902 tiff_load (f, img)
6903 struct frame *f;
6904 struct image *img;
6906 Lisp_Object file, specified_file;
6907 Lisp_Object specified_data;
6908 TIFF *tiff;
6909 int width, height, x, y;
6910 uint32 *buf;
6911 int rc;
6912 XImagePtr ximg;
6913 struct gcpro gcpro1;
6914 tiff_memory_source memsrc;
6916 specified_file = image_spec_value (img->spec, QCfile, NULL);
6917 specified_data = image_spec_value (img->spec, QCdata, NULL);
6918 file = Qnil;
6919 GCPRO1 (file);
6921 fn_TIFFSetErrorHandler (tiff_error_handler);
6922 fn_TIFFSetWarningHandler (tiff_warning_handler);
6924 if (NILP (specified_data))
6926 /* Read from a file */
6927 file = x_find_image_file (specified_file);
6928 if (!STRINGP (file))
6930 image_error ("Cannot find image file `%s'", specified_file, Qnil);
6931 UNGCPRO;
6932 return 0;
6935 /* Try to open the image file. */
6936 tiff = fn_TIFFOpen (SDATA (file), "r");
6937 if (tiff == NULL)
6939 image_error ("Cannot open `%s'", file, Qnil);
6940 UNGCPRO;
6941 return 0;
6944 else
6946 /* Memory source! */
6947 memsrc.bytes = SDATA (specified_data);
6948 memsrc.len = SBYTES (specified_data);
6949 memsrc.index = 0;
6951 tiff = fn_TIFFClientOpen ("memory_source", "r", &memsrc,
6952 (TIFFReadWriteProc) tiff_read_from_memory,
6953 (TIFFReadWriteProc) tiff_write_from_memory,
6954 tiff_seek_in_memory,
6955 tiff_close_memory,
6956 tiff_size_of_memory,
6957 tiff_mmap_memory,
6958 tiff_unmap_memory);
6960 if (!tiff)
6962 image_error ("Cannot open memory source for `%s'", img->spec, Qnil);
6963 UNGCPRO;
6964 return 0;
6968 /* Get width and height of the image, and allocate a raster buffer
6969 of width x height 32-bit values. */
6970 fn_TIFFGetField (tiff, TIFFTAG_IMAGEWIDTH, &width);
6971 fn_TIFFGetField (tiff, TIFFTAG_IMAGELENGTH, &height);
6972 buf = (uint32 *) xmalloc (width * height * sizeof *buf);
6974 rc = fn_TIFFReadRGBAImage (tiff, width, height, buf, 0);
6975 fn_TIFFClose (tiff);
6976 if (!rc)
6978 image_error ("Error reading TIFF image `%s'", img->spec, Qnil);
6979 xfree (buf);
6980 UNGCPRO;
6981 return 0;
6984 /* Create the X image and pixmap. */
6985 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
6987 xfree (buf);
6988 UNGCPRO;
6989 return 0;
6992 /* Initialize the color table. */
6993 init_color_table ();
6995 /* Process the pixel raster. Origin is in the lower-left corner. */
6996 for (y = 0; y < height; ++y)
6998 uint32 *row = buf + y * width;
7000 for (x = 0; x < width; ++x)
7002 uint32 abgr = row[x];
7003 int r = TIFFGetR (abgr) << 8;
7004 int g = TIFFGetG (abgr) << 8;
7005 int b = TIFFGetB (abgr) << 8;
7006 XPutPixel (ximg, x, height - 1 - y, lookup_rgb_color (f, r, g, b));
7010 #ifdef COLOR_TABLE_SUPPORT
7011 /* Remember the colors allocated for the image. Free the color table. */
7012 img->colors = colors_in_color_table (&img->ncolors);
7013 free_color_table ();
7014 #endif /* COLOR_TABLE_SUPPORT */
7016 img->width = width;
7017 img->height = height;
7019 /* Maybe fill in the background field while we have ximg handy. */
7020 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
7021 IMAGE_BACKGROUND (img, f, ximg);
7023 /* Put the image into the pixmap, then free the X image and its buffer. */
7024 x_put_x_image (f, ximg, img->pixmap, width, height);
7025 x_destroy_x_image (ximg);
7026 xfree (buf);
7028 UNGCPRO;
7029 return 1;
7032 #else /* HAVE_TIFF */
7034 #ifdef MAC_OS
7035 static int
7036 tiff_load (f, img)
7037 struct frame *f;
7038 struct image *img;
7040 return image_load_quicktime (f, img, kQTFileTypeTIFF);
7042 #endif /* MAC_OS */
7044 #endif /* !HAVE_TIFF */
7048 /***********************************************************************
7050 ***********************************************************************/
7052 #if defined (HAVE_GIF) || defined (MAC_OS)
7054 static int gif_image_p P_ ((Lisp_Object object));
7055 static int gif_load P_ ((struct frame *f, struct image *img));
7057 /* The symbol `gif' identifying images of this type. */
7059 Lisp_Object Qgif;
7061 /* Indices of image specification fields in gif_format, below. */
7063 enum gif_keyword_index
7065 GIF_TYPE,
7066 GIF_DATA,
7067 GIF_FILE,
7068 GIF_ASCENT,
7069 GIF_MARGIN,
7070 GIF_RELIEF,
7071 GIF_ALGORITHM,
7072 GIF_HEURISTIC_MASK,
7073 GIF_MASK,
7074 GIF_IMAGE,
7075 GIF_BACKGROUND,
7076 GIF_LAST
7079 /* Vector of image_keyword structures describing the format
7080 of valid user-defined image specifications. */
7082 static struct image_keyword gif_format[GIF_LAST] =
7084 {":type", IMAGE_SYMBOL_VALUE, 1},
7085 {":data", IMAGE_STRING_VALUE, 0},
7086 {":file", IMAGE_STRING_VALUE, 0},
7087 {":ascent", IMAGE_ASCENT_VALUE, 0},
7088 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
7089 {":relief", IMAGE_INTEGER_VALUE, 0},
7090 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7091 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7092 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7093 {":image", IMAGE_NON_NEGATIVE_INTEGER_VALUE, 0},
7094 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
7097 /* Structure describing the image type `gif'. */
7099 static struct image_type gif_type =
7101 &Qgif,
7102 gif_image_p,
7103 gif_load,
7104 x_clear_image,
7105 NULL
7108 /* Return non-zero if OBJECT is a valid GIF image specification. */
7110 static int
7111 gif_image_p (object)
7112 Lisp_Object object;
7114 struct image_keyword fmt[GIF_LAST];
7115 bcopy (gif_format, fmt, sizeof fmt);
7117 if (!parse_image_spec (object, fmt, GIF_LAST, Qgif))
7118 return 0;
7120 /* Must specify either the :data or :file keyword. */
7121 return fmt[GIF_FILE].count + fmt[GIF_DATA].count == 1;
7124 #endif /* HAVE_GIF || MAC_OS */
7126 #ifdef HAVE_GIF
7128 #if defined (HAVE_NTGUI) || defined (MAC_OS)
7129 /* avoid conflict with QuickdrawText.h */
7130 #define DrawText gif_DrawText
7131 #include <gif_lib.h>
7132 #undef DrawText
7134 #else /* HAVE_NTGUI || MAC_OS */
7136 #include <gif_lib.h>
7138 #endif /* HAVE_NTGUI || MAC_OS */
7141 #ifdef HAVE_NTGUI
7143 /* GIF library details. */
7144 DEF_IMGLIB_FN (DGifCloseFile);
7145 DEF_IMGLIB_FN (DGifSlurp);
7146 DEF_IMGLIB_FN (DGifOpen);
7147 DEF_IMGLIB_FN (DGifOpenFileName);
7149 static int
7150 init_gif_functions (Lisp_Object libraries)
7152 HMODULE library;
7154 if (!(library = w32_delayed_load (libraries, Qgif)))
7155 return 0;
7157 LOAD_IMGLIB_FN (library, DGifCloseFile);
7158 LOAD_IMGLIB_FN (library, DGifSlurp);
7159 LOAD_IMGLIB_FN (library, DGifOpen);
7160 LOAD_IMGLIB_FN (library, DGifOpenFileName);
7161 return 1;
7164 #else
7166 #define fn_DGifCloseFile DGifCloseFile
7167 #define fn_DGifSlurp DGifSlurp
7168 #define fn_DGifOpen DGifOpen
7169 #define fn_DGifOpenFileName DGifOpenFileName
7171 #endif /* HAVE_NTGUI */
7173 /* Reading a GIF image from memory
7174 Based on the PNG memory stuff to a certain extent. */
7176 typedef struct
7178 unsigned char *bytes;
7179 size_t len;
7180 int index;
7182 gif_memory_source;
7184 /* Make the current memory source available to gif_read_from_memory.
7185 It's done this way because not all versions of libungif support
7186 a UserData field in the GifFileType structure. */
7187 static gif_memory_source *current_gif_memory_src;
7189 static int
7190 gif_read_from_memory (file, buf, len)
7191 GifFileType *file;
7192 GifByteType *buf;
7193 int len;
7195 gif_memory_source *src = current_gif_memory_src;
7197 if (len > src->len - src->index)
7198 return -1;
7200 bcopy (src->bytes + src->index, buf, len);
7201 src->index += len;
7202 return len;
7206 /* Load GIF image IMG for use on frame F. Value is non-zero if
7207 successful. */
7209 static int
7210 gif_load (f, img)
7211 struct frame *f;
7212 struct image *img;
7214 Lisp_Object file, specified_file;
7215 Lisp_Object specified_data;
7216 int rc, width, height, x, y, i;
7217 XImagePtr ximg;
7218 ColorMapObject *gif_color_map;
7219 unsigned long pixel_colors[256];
7220 GifFileType *gif;
7221 struct gcpro gcpro1;
7222 Lisp_Object image;
7223 int ino, image_left, image_top, image_width, image_height;
7224 gif_memory_source memsrc;
7225 unsigned char *raster;
7227 specified_file = image_spec_value (img->spec, QCfile, NULL);
7228 specified_data = image_spec_value (img->spec, QCdata, NULL);
7229 file = Qnil;
7230 GCPRO1 (file);
7232 if (NILP (specified_data))
7234 file = x_find_image_file (specified_file);
7235 if (!STRINGP (file))
7237 image_error ("Cannot find image file `%s'", specified_file, Qnil);
7238 UNGCPRO;
7239 return 0;
7242 /* Open the GIF file. */
7243 gif = fn_DGifOpenFileName (SDATA (file));
7244 if (gif == NULL)
7246 image_error ("Cannot open `%s'", file, Qnil);
7247 UNGCPRO;
7248 return 0;
7251 else
7253 /* Read from memory! */
7254 current_gif_memory_src = &memsrc;
7255 memsrc.bytes = SDATA (specified_data);
7256 memsrc.len = SBYTES (specified_data);
7257 memsrc.index = 0;
7259 gif = fn_DGifOpen(&memsrc, gif_read_from_memory);
7260 if (!gif)
7262 image_error ("Cannot open memory source `%s'", img->spec, Qnil);
7263 UNGCPRO;
7264 return 0;
7268 /* Read entire contents. */
7269 rc = fn_DGifSlurp (gif);
7270 if (rc == GIF_ERROR)
7272 image_error ("Error reading `%s'", img->spec, Qnil);
7273 fn_DGifCloseFile (gif);
7274 UNGCPRO;
7275 return 0;
7278 image = image_spec_value (img->spec, QCindex, NULL);
7279 ino = INTEGERP (image) ? XFASTINT (image) : 0;
7280 if (ino >= gif->ImageCount)
7282 image_error ("Invalid image number `%s' in image `%s'",
7283 image, img->spec);
7284 fn_DGifCloseFile (gif);
7285 UNGCPRO;
7286 return 0;
7289 width = img->width = max (gif->SWidth, gif->Image.Left + gif->Image.Width);
7290 height = img->height = max (gif->SHeight, gif->Image.Top + gif->Image.Height);
7292 /* Create the X image and pixmap. */
7293 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
7295 fn_DGifCloseFile (gif);
7296 UNGCPRO;
7297 return 0;
7300 /* Allocate colors. */
7301 gif_color_map = gif->SavedImages[ino].ImageDesc.ColorMap;
7302 if (!gif_color_map)
7303 gif_color_map = gif->SColorMap;
7304 init_color_table ();
7305 bzero (pixel_colors, sizeof pixel_colors);
7307 for (i = 0; i < gif_color_map->ColorCount; ++i)
7309 int r = gif_color_map->Colors[i].Red << 8;
7310 int g = gif_color_map->Colors[i].Green << 8;
7311 int b = gif_color_map->Colors[i].Blue << 8;
7312 pixel_colors[i] = lookup_rgb_color (f, r, g, b);
7315 #ifdef COLOR_TABLE_SUPPORT
7316 img->colors = colors_in_color_table (&img->ncolors);
7317 free_color_table ();
7318 #endif /* COLOR_TABLE_SUPPORT */
7320 /* Clear the part of the screen image that are not covered by
7321 the image from the GIF file. Full animated GIF support
7322 requires more than can be done here (see the gif89 spec,
7323 disposal methods). Let's simply assume that the part
7324 not covered by a sub-image is in the frame's background color. */
7325 image_top = gif->SavedImages[ino].ImageDesc.Top;
7326 image_left = gif->SavedImages[ino].ImageDesc.Left;
7327 image_width = gif->SavedImages[ino].ImageDesc.Width;
7328 image_height = gif->SavedImages[ino].ImageDesc.Height;
7330 for (y = 0; y < image_top; ++y)
7331 for (x = 0; x < width; ++x)
7332 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
7334 for (y = image_top + image_height; y < height; ++y)
7335 for (x = 0; x < width; ++x)
7336 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
7338 for (y = image_top; y < image_top + image_height; ++y)
7340 for (x = 0; x < image_left; ++x)
7341 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
7342 for (x = image_left + image_width; x < width; ++x)
7343 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
7346 /* Read the GIF image into the X image. We use a local variable
7347 `raster' here because RasterBits below is a char *, and invites
7348 problems with bytes >= 0x80. */
7349 raster = (unsigned char *) gif->SavedImages[ino].RasterBits;
7351 if (gif->SavedImages[ino].ImageDesc.Interlace)
7353 static int interlace_start[] = {0, 4, 2, 1};
7354 static int interlace_increment[] = {8, 8, 4, 2};
7355 int pass;
7356 int row = interlace_start[0];
7358 pass = 0;
7360 for (y = 0; y < image_height; y++)
7362 if (row >= image_height)
7364 row = interlace_start[++pass];
7365 while (row >= image_height)
7366 row = interlace_start[++pass];
7369 for (x = 0; x < image_width; x++)
7371 int i = raster[(y * image_width) + x];
7372 XPutPixel (ximg, x + image_left, row + image_top,
7373 pixel_colors[i]);
7376 row += interlace_increment[pass];
7379 else
7381 for (y = 0; y < image_height; ++y)
7382 for (x = 0; x < image_width; ++x)
7384 int i = raster[y * image_width + x];
7385 XPutPixel (ximg, x + image_left, y + image_top, pixel_colors[i]);
7389 fn_DGifCloseFile (gif);
7391 /* Maybe fill in the background field while we have ximg handy. */
7392 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
7393 IMAGE_BACKGROUND (img, f, ximg);
7395 /* Put the image into the pixmap, then free the X image and its buffer. */
7396 x_put_x_image (f, ximg, img->pixmap, width, height);
7397 x_destroy_x_image (ximg);
7399 UNGCPRO;
7400 return 1;
7403 #else
7405 #ifdef MAC_OS
7406 static int
7407 gif_load (f, img)
7408 struct frame *f;
7409 struct image *img;
7411 Lisp_Object specified_file, file;
7412 Lisp_Object specified_data;
7413 OSErr err;
7414 Boolean graphic_p, movie_p, prefer_graphic_p;
7415 Handle dh = NULL;
7416 Movie movie = NULL;
7417 Lisp_Object image;
7418 Track track = NULL;
7419 Media media = NULL;
7420 long nsamples;
7421 Rect rect;
7422 Lisp_Object specified_bg;
7423 XColor color;
7424 RGBColor bg_color;
7425 int width, height;
7426 XImagePtr ximg;
7427 TimeValue time;
7428 struct gcpro gcpro1;
7429 int ino;
7430 CGrafPtr old_port;
7431 GDHandle old_gdh;
7433 specified_file = image_spec_value (img->spec, QCfile, NULL);
7434 specified_data = image_spec_value (img->spec, QCdata, NULL);
7436 if (NILP (specified_data))
7438 /* Read from a file */
7439 FSSpec fss;
7440 short refnum;
7442 err = find_image_fsspec (specified_file, &file, &fss);
7443 if (err != noErr)
7445 if (err == fnfErr)
7446 image_error ("Cannot find image file `%s'", specified_file, Qnil);
7447 else
7448 goto open_error;
7451 err = CanQuickTimeOpenFile (&fss, kQTFileTypeGIF, 0,
7452 &graphic_p, &movie_p, &prefer_graphic_p, 0);
7453 if (err != noErr)
7454 goto open_error;
7456 if (!graphic_p && !movie_p)
7457 goto open_error;
7458 if (prefer_graphic_p)
7459 return image_load_qt_1 (f, img, kQTFileTypeGIF, &fss, NULL);
7460 err = OpenMovieFile (&fss, &refnum, fsRdPerm);
7461 if (err != noErr)
7462 goto open_error;
7463 err = NewMovieFromFile (&movie, refnum, NULL, NULL, 0, NULL);
7464 CloseMovieFile (refnum);
7465 if (err != noErr)
7467 image_error ("Error reading `%s'", file, Qnil);
7468 return 0;
7471 else
7473 /* Memory source! */
7474 Handle dref = NULL;
7475 long file_type_atom[3];
7477 err = PtrToHand (SDATA (specified_data), &dh, SBYTES (specified_data));
7478 if (err != noErr)
7480 image_error ("Cannot allocate data handle for `%s'",
7481 img->spec, Qnil);
7482 goto error;
7485 file_type_atom[0] = EndianU32_NtoB (sizeof (long) * 3);
7486 file_type_atom[1] = EndianU32_NtoB (kDataRefExtensionMacOSFileType);
7487 file_type_atom[2] = EndianU32_NtoB (kQTFileTypeGIF);
7488 err = PtrToHand (&dh, &dref, sizeof (Handle));
7489 if (err == noErr)
7490 /* no file name */
7491 err = PtrAndHand ("\p", dref, 1);
7492 if (err == noErr)
7493 err = PtrAndHand (file_type_atom, dref, sizeof (long) * 3);
7494 if (err != noErr)
7496 image_error ("Cannot allocate handle data ref for `%s'", img->spec, Qnil);
7497 goto error;
7499 err = CanQuickTimeOpenDataRef (dref, HandleDataHandlerSubType, &graphic_p,
7500 &movie_p, &prefer_graphic_p, 0);
7501 if (err != noErr)
7502 goto open_error;
7504 if (!graphic_p && !movie_p)
7505 goto open_error;
7506 if (prefer_graphic_p)
7508 int success_p;
7510 DisposeHandle (dref);
7511 success_p = image_load_qt_1 (f, img, kQTFileTypeGIF, NULL, dh);
7512 DisposeHandle (dh);
7513 return success_p;
7515 err = NewMovieFromDataRef (&movie, 0, NULL, dref,
7516 HandleDataHandlerSubType);
7517 DisposeHandle (dref);
7518 if (err != noErr)
7519 goto open_error;
7522 image = image_spec_value (img->spec, QCindex, NULL);
7523 ino = INTEGERP (image) ? XFASTINT (image) : 0;
7524 track = GetMovieIndTrack (movie, 1);
7525 media = GetTrackMedia (track);
7526 nsamples = GetMediaSampleCount (media);
7527 if (ino >= nsamples)
7529 image_error ("Invalid image number `%s' in image `%s'",
7530 image, img->spec);
7531 goto error;
7534 specified_bg = image_spec_value (img->spec, QCbackground, NULL);
7535 if (!STRINGP (specified_bg) ||
7536 !mac_defined_color (f, SDATA (specified_bg), &color, 0))
7538 color.pixel = FRAME_BACKGROUND_PIXEL (f);
7539 color.red = RED16_FROM_ULONG (color.pixel);
7540 color.green = GREEN16_FROM_ULONG (color.pixel);
7541 color.blue = BLUE16_FROM_ULONG (color.pixel);
7543 GetMovieBox (movie, &rect);
7544 width = img->width = rect.right - rect.left;
7545 height = img->height = rect.bottom - rect.top;
7546 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
7547 goto error;
7549 GetGWorld (&old_port, &old_gdh);
7550 SetGWorld (ximg, NULL);
7551 bg_color.red = color.red;
7552 bg_color.green = color.green;
7553 bg_color.blue = color.blue;
7554 RGBBackColor (&bg_color);
7555 SetGWorld (old_port, old_gdh);
7556 SetMovieActive (movie, 1);
7557 SetMovieGWorld (movie, ximg, NULL);
7558 SampleNumToMediaTime (media, ino + 1, &time, NULL);
7559 SetMovieTimeValue (movie, time);
7560 MoviesTask (movie, 0L);
7561 DisposeTrackMedia (media);
7562 DisposeMovieTrack (track);
7563 DisposeMovie (movie);
7564 if (dh)
7565 DisposeHandle (dh);
7566 /* Maybe fill in the background field while we have ximg handy. */
7567 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
7568 IMAGE_BACKGROUND (img, f, ximg);
7570 /* Put the image into the pixmap. */
7571 x_put_x_image (f, ximg, img->pixmap, width, height);
7572 x_destroy_x_image (ximg);
7573 return 1;
7575 open_error:
7576 image_error ("Cannot open `%s'", file, Qnil);
7577 error:
7578 if (media)
7579 DisposeTrackMedia (media);
7580 if (track)
7581 DisposeMovieTrack (track);
7582 if (movie)
7583 DisposeMovie (movie);
7584 if (dh)
7585 DisposeHandle (dh);
7586 return 0;
7588 #endif /* MAC_OS */
7590 #endif /* HAVE_GIF */
7594 /***********************************************************************
7595 Ghostscript
7596 ***********************************************************************/
7598 #ifdef HAVE_X_WINDOWS
7599 #define HAVE_GHOSTSCRIPT 1
7600 #endif /* HAVE_X_WINDOWS */
7602 /* The symbol `postscript' identifying images of this type. */
7604 Lisp_Object Qpostscript;
7606 #ifdef HAVE_GHOSTSCRIPT
7608 static int gs_image_p P_ ((Lisp_Object object));
7609 static int gs_load P_ ((struct frame *f, struct image *img));
7610 static void gs_clear_image P_ ((struct frame *f, struct image *img));
7612 /* Keyword symbols. */
7614 Lisp_Object QCloader, QCbounding_box, QCpt_width, QCpt_height;
7616 /* Indices of image specification fields in gs_format, below. */
7618 enum gs_keyword_index
7620 GS_TYPE,
7621 GS_PT_WIDTH,
7622 GS_PT_HEIGHT,
7623 GS_FILE,
7624 GS_LOADER,
7625 GS_BOUNDING_BOX,
7626 GS_ASCENT,
7627 GS_MARGIN,
7628 GS_RELIEF,
7629 GS_ALGORITHM,
7630 GS_HEURISTIC_MASK,
7631 GS_MASK,
7632 GS_BACKGROUND,
7633 GS_LAST
7636 /* Vector of image_keyword structures describing the format
7637 of valid user-defined image specifications. */
7639 static struct image_keyword gs_format[GS_LAST] =
7641 {":type", IMAGE_SYMBOL_VALUE, 1},
7642 {":pt-width", IMAGE_POSITIVE_INTEGER_VALUE, 1},
7643 {":pt-height", IMAGE_POSITIVE_INTEGER_VALUE, 1},
7644 {":file", IMAGE_STRING_VALUE, 1},
7645 {":loader", IMAGE_FUNCTION_VALUE, 0},
7646 {":bounding-box", IMAGE_DONT_CHECK_VALUE_TYPE, 1},
7647 {":ascent", IMAGE_ASCENT_VALUE, 0},
7648 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
7649 {":relief", IMAGE_INTEGER_VALUE, 0},
7650 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7651 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7652 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7653 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
7656 /* Structure describing the image type `ghostscript'. */
7658 static struct image_type gs_type =
7660 &Qpostscript,
7661 gs_image_p,
7662 gs_load,
7663 gs_clear_image,
7664 NULL
7668 /* Free X resources of Ghostscript image IMG which is used on frame F. */
7670 static void
7671 gs_clear_image (f, img)
7672 struct frame *f;
7673 struct image *img;
7675 /* IMG->data.ptr_val may contain a recorded colormap. */
7676 xfree (img->data.ptr_val);
7677 x_clear_image (f, img);
7681 /* Return non-zero if OBJECT is a valid Ghostscript image
7682 specification. */
7684 static int
7685 gs_image_p (object)
7686 Lisp_Object object;
7688 struct image_keyword fmt[GS_LAST];
7689 Lisp_Object tem;
7690 int i;
7692 bcopy (gs_format, fmt, sizeof fmt);
7694 if (!parse_image_spec (object, fmt, GS_LAST, Qpostscript))
7695 return 0;
7697 /* Bounding box must be a list or vector containing 4 integers. */
7698 tem = fmt[GS_BOUNDING_BOX].value;
7699 if (CONSP (tem))
7701 for (i = 0; i < 4; ++i, tem = XCDR (tem))
7702 if (!CONSP (tem) || !INTEGERP (XCAR (tem)))
7703 return 0;
7704 if (!NILP (tem))
7705 return 0;
7707 else if (VECTORP (tem))
7709 if (XVECTOR (tem)->size != 4)
7710 return 0;
7711 for (i = 0; i < 4; ++i)
7712 if (!INTEGERP (XVECTOR (tem)->contents[i]))
7713 return 0;
7715 else
7716 return 0;
7718 return 1;
7722 /* Load Ghostscript image IMG for use on frame F. Value is non-zero
7723 if successful. */
7725 static int
7726 gs_load (f, img)
7727 struct frame *f;
7728 struct image *img;
7730 char buffer[100];
7731 Lisp_Object window_and_pixmap_id = Qnil, loader, pt_height, pt_width;
7732 struct gcpro gcpro1, gcpro2;
7733 Lisp_Object frame;
7734 double in_width, in_height;
7735 Lisp_Object pixel_colors = Qnil;
7737 /* Compute pixel size of pixmap needed from the given size in the
7738 image specification. Sizes in the specification are in pt. 1 pt
7739 = 1/72 in, xdpi and ydpi are stored in the frame's X display
7740 info. */
7741 pt_width = image_spec_value (img->spec, QCpt_width, NULL);
7742 in_width = XFASTINT (pt_width) / 72.0;
7743 img->width = in_width * FRAME_X_DISPLAY_INFO (f)->resx;
7744 pt_height = image_spec_value (img->spec, QCpt_height, NULL);
7745 in_height = XFASTINT (pt_height) / 72.0;
7746 img->height = in_height * FRAME_X_DISPLAY_INFO (f)->resy;
7748 /* Create the pixmap. */
7749 xassert (img->pixmap == NO_PIXMAP);
7751 /* Only W32 version did BLOCK_INPUT here. ++kfs */
7752 BLOCK_INPUT;
7753 img->pixmap = XCreatePixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7754 img->width, img->height,
7755 DefaultDepthOfScreen (FRAME_X_SCREEN (f)));
7756 UNBLOCK_INPUT;
7758 if (!img->pixmap)
7760 image_error ("Unable to create pixmap for `%s'", img->spec, Qnil);
7761 return 0;
7764 /* Call the loader to fill the pixmap. It returns a process object
7765 if successful. We do not record_unwind_protect here because
7766 other places in redisplay like calling window scroll functions
7767 don't either. Let the Lisp loader use `unwind-protect' instead. */
7768 GCPRO2 (window_and_pixmap_id, pixel_colors);
7770 sprintf (buffer, "%lu %lu",
7771 (unsigned long) FRAME_X_WINDOW (f),
7772 (unsigned long) img->pixmap);
7773 window_and_pixmap_id = build_string (buffer);
7775 sprintf (buffer, "%lu %lu",
7776 FRAME_FOREGROUND_PIXEL (f),
7777 FRAME_BACKGROUND_PIXEL (f));
7778 pixel_colors = build_string (buffer);
7780 XSETFRAME (frame, f);
7781 loader = image_spec_value (img->spec, QCloader, NULL);
7782 if (NILP (loader))
7783 loader = intern ("gs-load-image");
7785 img->data.lisp_val = call6 (loader, frame, img->spec,
7786 make_number (img->width),
7787 make_number (img->height),
7788 window_and_pixmap_id,
7789 pixel_colors);
7790 UNGCPRO;
7791 return PROCESSP (img->data.lisp_val);
7795 /* Kill the Ghostscript process that was started to fill PIXMAP on
7796 frame F. Called from XTread_socket when receiving an event
7797 telling Emacs that Ghostscript has finished drawing. */
7799 void
7800 x_kill_gs_process (pixmap, f)
7801 Pixmap pixmap;
7802 struct frame *f;
7804 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
7805 int class, i;
7806 struct image *img;
7808 /* Find the image containing PIXMAP. */
7809 for (i = 0; i < c->used; ++i)
7810 if (c->images[i]->pixmap == pixmap)
7811 break;
7813 /* Should someone in between have cleared the image cache, for
7814 instance, give up. */
7815 if (i == c->used)
7816 return;
7818 /* Kill the GS process. We should have found PIXMAP in the image
7819 cache and its image should contain a process object. */
7820 img = c->images[i];
7821 xassert (PROCESSP (img->data.lisp_val));
7822 Fkill_process (img->data.lisp_val, Qnil);
7823 img->data.lisp_val = Qnil;
7825 #if defined (HAVE_X_WINDOWS)
7827 /* On displays with a mutable colormap, figure out the colors
7828 allocated for the image by looking at the pixels of an XImage for
7829 img->pixmap. */
7830 class = FRAME_X_VISUAL (f)->class;
7831 if (class != StaticColor && class != StaticGray && class != TrueColor)
7833 XImagePtr ximg;
7835 BLOCK_INPUT;
7837 /* Try to get an XImage for img->pixmep. */
7838 ximg = XGetImage (FRAME_X_DISPLAY (f), img->pixmap,
7839 0, 0, img->width, img->height, ~0, ZPixmap);
7840 if (ximg)
7842 int x, y;
7844 /* Initialize the color table. */
7845 init_color_table ();
7847 /* For each pixel of the image, look its color up in the
7848 color table. After having done so, the color table will
7849 contain an entry for each color used by the image. */
7850 for (y = 0; y < img->height; ++y)
7851 for (x = 0; x < img->width; ++x)
7853 unsigned long pixel = XGetPixel (ximg, x, y);
7854 lookup_pixel_color (f, pixel);
7857 /* Record colors in the image. Free color table and XImage. */
7858 #ifdef COLOR_TABLE_SUPPORT
7859 img->colors = colors_in_color_table (&img->ncolors);
7860 free_color_table ();
7861 #endif
7862 XDestroyImage (ximg);
7864 #if 0 /* This doesn't seem to be the case. If we free the colors
7865 here, we get a BadAccess later in x_clear_image when
7866 freeing the colors. */
7867 /* We have allocated colors once, but Ghostscript has also
7868 allocated colors on behalf of us. So, to get the
7869 reference counts right, free them once. */
7870 if (img->ncolors)
7871 x_free_colors (f, img->colors, img->ncolors);
7872 #endif
7874 else
7875 image_error ("Cannot get X image of `%s'; colors will not be freed",
7876 img->spec, Qnil);
7878 UNBLOCK_INPUT;
7880 #endif /* HAVE_X_WINDOWS */
7882 /* Now that we have the pixmap, compute mask and transform the
7883 image if requested. */
7884 BLOCK_INPUT;
7885 postprocess_image (f, img);
7886 UNBLOCK_INPUT;
7889 #endif /* HAVE_GHOSTSCRIPT */
7892 /***********************************************************************
7893 Tests
7894 ***********************************************************************/
7896 #if GLYPH_DEBUG
7898 DEFUN ("imagep", Fimagep, Simagep, 1, 1, 0,
7899 doc: /* Value is non-nil if SPEC is a valid image specification. */)
7900 (spec)
7901 Lisp_Object spec;
7903 return valid_image_p (spec) ? Qt : Qnil;
7907 DEFUN ("lookup-image", Flookup_image, Slookup_image, 1, 1, 0, "")
7908 (spec)
7909 Lisp_Object spec;
7911 int id = -1;
7913 if (valid_image_p (spec))
7914 id = lookup_image (SELECTED_FRAME (), spec);
7916 debug_print (spec);
7917 return make_number (id);
7920 #endif /* GLYPH_DEBUG != 0 */
7923 /***********************************************************************
7924 Initialization
7925 ***********************************************************************/
7927 #ifdef HAVE_NTGUI
7928 /* Image types that rely on external libraries are loaded dynamically
7929 if the library is available. */
7930 #define CHECK_LIB_AVAILABLE(image_type, init_lib_fn, libraries) \
7931 define_image_type (image_type, init_lib_fn (libraries))
7932 #else
7933 #define CHECK_LIB_AVAILABLE(image_type, init_lib_fn, libraries) \
7934 define_image_type (image_type, 1)
7935 #endif /* HAVE_NTGUI */
7937 DEFUN ("init-image-library", Finit_image_library, Sinit_image_library, 2, 2, 0,
7938 doc: /* Initialize image library implementing image type TYPE.
7939 Return non-nil if TYPE is a supported image type.
7941 Image types pbm and xbm are prebuilt; other types are loaded here.
7942 Libraries to load are specified in alist LIBRARIES (usually, the value
7943 of `image-library-alist', which see). */)
7944 (type, libraries)
7945 Lisp_Object type, libraries;
7947 Lisp_Object tested;
7949 /* Don't try to reload the library. */
7950 tested = Fassq (type, Vimage_type_cache);
7951 if (CONSP (tested))
7952 return XCDR (tested);
7954 #if defined (HAVE_XPM) || defined (MAC_OS)
7955 if (EQ (type, Qxpm))
7956 return CHECK_LIB_AVAILABLE (&xpm_type, init_xpm_functions, libraries);
7957 #endif
7959 #if defined (HAVE_JPEG) || defined (MAC_OS)
7960 if (EQ (type, Qjpeg))
7961 return CHECK_LIB_AVAILABLE (&jpeg_type, init_jpeg_functions, libraries);
7962 #endif
7964 #if defined (HAVE_TIFF) || defined (MAC_OS)
7965 if (EQ (type, Qtiff))
7966 return CHECK_LIB_AVAILABLE (&tiff_type, init_tiff_functions, libraries);
7967 #endif
7969 #if defined (HAVE_GIF) || defined (MAC_OS)
7970 if (EQ (type, Qgif))
7971 return CHECK_LIB_AVAILABLE (&gif_type, init_gif_functions, libraries);
7972 #endif
7974 #if defined (HAVE_PNG) || defined (MAC_OS)
7975 if (EQ (type, Qpng))
7976 return CHECK_LIB_AVAILABLE (&png_type, init_png_functions, libraries);
7977 #endif
7979 #ifdef HAVE_GHOSTSCRIPT
7980 if (EQ (type, Qpostscript))
7981 return CHECK_LIB_AVAILABLE (&gs_type, init_gs_functions, libraries);
7982 #endif
7984 /* If the type is not recognized, avoid testing it ever again. */
7985 CACHE_IMAGE_TYPE (type, Qnil);
7986 return Qnil;
7989 void
7990 syms_of_image ()
7992 extern Lisp_Object Qrisky_local_variable; /* Syms_of_xdisp has already run. */
7994 /* Must be defined now becase we're going to update it below, while
7995 defining the supported image types. */
7996 DEFVAR_LISP ("image-types", &Vimage_types,
7997 doc: /* List of potentially supported image types.
7998 Each element of the list is a symbol for a image type, like 'jpeg or 'png.
7999 To check whether it is really supported, use `image-type-available-p'. */);
8000 Vimage_types = Qnil;
8002 DEFVAR_LISP ("image-library-alist", &Vimage_library_alist,
8003 doc: /* Alist of image types vs external libraries needed to display them.
8005 Each element is a list (IMAGE-TYPE LIBRARY...), where the car is a symbol
8006 representing a supported image type, and the rest are strings giving
8007 alternate filenames for the corresponding external libraries.
8009 Emacs tries to load the libraries in the order they appear on the
8010 list; if none is loaded, the running session of Emacs won't
8011 support the image type. Types 'pbm and 'xbm don't need to be
8012 listed; they're always supported. */);
8013 Vimage_library_alist = Qnil;
8014 Fput (intern ("image-library-alist"), Qrisky_local_variable, Qt);
8016 Vimage_type_cache = Qnil;
8017 staticpro (&Vimage_type_cache);
8019 QCascent = intern (":ascent");
8020 staticpro (&QCascent);
8021 QCmargin = intern (":margin");
8022 staticpro (&QCmargin);
8023 QCrelief = intern (":relief");
8024 staticpro (&QCrelief);
8025 QCconversion = intern (":conversion");
8026 staticpro (&QCconversion);
8027 QCcolor_symbols = intern (":color-symbols");
8028 staticpro (&QCcolor_symbols);
8029 QCheuristic_mask = intern (":heuristic-mask");
8030 staticpro (&QCheuristic_mask);
8031 QCindex = intern (":index");
8032 staticpro (&QCindex);
8033 QCmatrix = intern (":matrix");
8034 staticpro (&QCmatrix);
8035 QCcolor_adjustment = intern (":color-adjustment");
8036 staticpro (&QCcolor_adjustment);
8037 QCmask = intern (":mask");
8038 staticpro (&QCmask);
8040 Qlaplace = intern ("laplace");
8041 staticpro (&Qlaplace);
8042 Qemboss = intern ("emboss");
8043 staticpro (&Qemboss);
8044 Qedge_detection = intern ("edge-detection");
8045 staticpro (&Qedge_detection);
8046 Qheuristic = intern ("heuristic");
8047 staticpro (&Qheuristic);
8049 Qpostscript = intern ("postscript");
8050 staticpro (&Qpostscript);
8051 #ifdef HAVE_GHOSTSCRIPT
8052 ADD_IMAGE_TYPE(Qpostscript);
8053 QCloader = intern (":loader");
8054 staticpro (&QCloader);
8055 QCbounding_box = intern (":bounding-box");
8056 staticpro (&QCbounding_box);
8057 QCpt_width = intern (":pt-width");
8058 staticpro (&QCpt_width);
8059 QCpt_height = intern (":pt-height");
8060 staticpro (&QCpt_height);
8061 #endif /* HAVE_GHOSTSCRIPT */
8063 Qpbm = intern ("pbm");
8064 staticpro (&Qpbm);
8065 ADD_IMAGE_TYPE(Qpbm);
8067 Qxbm = intern ("xbm");
8068 staticpro (&Qxbm);
8069 ADD_IMAGE_TYPE(Qxbm);
8071 #if defined (HAVE_XPM) || defined (MAC_OS)
8072 Qxpm = intern ("xpm");
8073 staticpro (&Qxpm);
8074 ADD_IMAGE_TYPE(Qxpm);
8075 #endif
8077 #if defined (HAVE_JPEG) || defined (MAC_OS)
8078 Qjpeg = intern ("jpeg");
8079 staticpro (&Qjpeg);
8080 ADD_IMAGE_TYPE(Qjpeg);
8081 #endif
8083 #if defined (HAVE_TIFF) || defined (MAC_OS)
8084 Qtiff = intern ("tiff");
8085 staticpro (&Qtiff);
8086 ADD_IMAGE_TYPE(Qtiff);
8087 #endif
8089 #if defined (HAVE_GIF) || defined (MAC_OS)
8090 Qgif = intern ("gif");
8091 staticpro (&Qgif);
8092 ADD_IMAGE_TYPE(Qgif);
8093 #endif
8095 #if defined (HAVE_PNG) || defined (MAC_OS)
8096 Qpng = intern ("png");
8097 staticpro (&Qpng);
8098 ADD_IMAGE_TYPE(Qpng);
8099 #endif
8101 defsubr (&Sinit_image_library);
8102 defsubr (&Sclear_image_cache);
8103 defsubr (&Simage_size);
8104 defsubr (&Simage_mask_p);
8106 #if GLYPH_DEBUG
8107 defsubr (&Simagep);
8108 defsubr (&Slookup_image);
8109 #endif
8111 DEFVAR_BOOL ("cross-disabled-images", &cross_disabled_images,
8112 doc: /* Non-nil means always draw a cross over disabled images.
8113 Disabled images are those having an `:conversion disabled' property.
8114 A cross is always drawn on black & white displays. */);
8115 cross_disabled_images = 0;
8117 DEFVAR_LISP ("x-bitmap-file-path", &Vx_bitmap_file_path,
8118 doc: /* List of directories to search for window system bitmap files. */);
8119 Vx_bitmap_file_path = decode_env_path ((char *) 0, PATH_BITMAPS);
8121 DEFVAR_LISP ("image-cache-eviction-delay", &Vimage_cache_eviction_delay,
8122 doc: /* Time after which cached images are removed from the cache.
8123 When an image has not been displayed this many seconds, remove it
8124 from the image cache. Value must be an integer or nil with nil
8125 meaning don't clear the cache. */);
8126 Vimage_cache_eviction_delay = make_number (30 * 60);
8129 void
8130 init_image ()
8132 image_types = NULL;
8134 define_image_type (&xbm_type, 1);
8135 define_image_type (&pbm_type, 1);
8137 #ifdef MAC_OS
8138 /* Animated gifs use QuickTime Movie Toolbox. So initialize it here. */
8139 EnterMovies ();
8140 #ifdef MAC_OSX
8141 init_image_func_pointer ();
8142 #endif
8143 #endif
8146 /* arch-tag: 123c2a5e-14a8-4c53-ab95-af47d7db49b9
8147 (do not change this comment) */