Replace `string-to-int' by `string-to-number'.
[emacs.git] / src / image.c
blobf03adfdc48f0f5d76bde38128a6b180d01707261
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 /* Cache for delayed-loading image types. */
621 static Lisp_Object Vimage_type_cache;
623 /* The symbol `xbm' which is used as the type symbol for XBM images. */
625 Lisp_Object Qxbm;
627 /* Keywords. */
629 extern Lisp_Object QCwidth, QCheight, QCforeground, QCbackground, QCfile;
630 extern Lisp_Object QCdata, QCtype;
631 extern Lisp_Object Qcenter;
632 Lisp_Object QCascent, QCmargin, QCrelief;
633 Lisp_Object QCconversion, QCcolor_symbols, QCheuristic_mask;
634 Lisp_Object QCindex, QCmatrix, QCcolor_adjustment, QCmask;
636 /* Other symbols. */
638 Lisp_Object Qlaplace, Qemboss, Qedge_detection, Qheuristic;
640 /* Time in seconds after which images should be removed from the cache
641 if not displayed. */
643 Lisp_Object Vimage_cache_eviction_delay;
645 /* Function prototypes. */
647 static Lisp_Object define_image_type P_ ((struct image_type *type, int loaded));
648 static struct image_type *lookup_image_type P_ ((Lisp_Object symbol));
649 static void image_error P_ ((char *format, Lisp_Object, Lisp_Object));
650 static void x_laplace P_ ((struct frame *, struct image *));
651 static void x_emboss P_ ((struct frame *, struct image *));
652 static int x_build_heuristic_mask P_ ((struct frame *, struct image *,
653 Lisp_Object));
655 #define CACHE_IMAGE_TYPE(type, status) \
656 do { Vimage_type_cache = Fcons (Fcons (type, status), Vimage_type_cache); } while (0)
658 #define ADD_IMAGE_TYPE(type) \
659 do { Vimage_types = Fcons (type, Vimage_types); } while (0)
661 /* Define a new image type from TYPE. This adds a copy of TYPE to
662 image_types and caches the loading status of TYPE. */
664 static Lisp_Object
665 define_image_type (type, loaded)
666 struct image_type *type;
667 int loaded;
669 Lisp_Object success;
671 if (!loaded)
672 success = Qnil;
673 else
675 /* Make a copy of TYPE to avoid a bus error in a dumped Emacs.
676 The initialized data segment is read-only. */
677 struct image_type *p = (struct image_type *) xmalloc (sizeof *p);
678 bcopy (type, p, sizeof *p);
679 p->next = image_types;
680 image_types = p;
681 success = Qt;
684 CACHE_IMAGE_TYPE (*type->type, success);
685 return success;
689 /* Look up image type SYMBOL, and return a pointer to its image_type
690 structure. Value is null if SYMBOL is not a known image type. */
692 static INLINE struct image_type *
693 lookup_image_type (symbol)
694 Lisp_Object symbol;
696 struct image_type *type;
698 /* We must initialize the image-type if it hasn't been already. */
699 if (NILP (Finit_image_library (symbol, Qnil)))
700 return 0; /* unimplemented */
702 for (type = image_types; type; type = type->next)
703 if (EQ (symbol, *type->type))
704 break;
706 return type;
710 /* Value is non-zero if OBJECT is a valid Lisp image specification. A
711 valid image specification is a list whose car is the symbol
712 `image', and whose rest is a property list. The property list must
713 contain a value for key `:type'. That value must be the name of a
714 supported image type. The rest of the property list depends on the
715 image type. */
718 valid_image_p (object)
719 Lisp_Object object;
721 int valid_p = 0;
723 if (IMAGEP (object))
725 Lisp_Object tem;
727 for (tem = XCDR (object); CONSP (tem); tem = XCDR (tem))
728 if (EQ (XCAR (tem), QCtype))
730 tem = XCDR (tem);
731 if (CONSP (tem) && SYMBOLP (XCAR (tem)))
733 struct image_type *type;
734 type = lookup_image_type (XCAR (tem));
735 if (type)
736 valid_p = type->valid_p (object);
739 break;
743 return valid_p;
747 /* Log error message with format string FORMAT and argument ARG.
748 Signaling an error, e.g. when an image cannot be loaded, is not a
749 good idea because this would interrupt redisplay, and the error
750 message display would lead to another redisplay. This function
751 therefore simply displays a message. */
753 static void
754 image_error (format, arg1, arg2)
755 char *format;
756 Lisp_Object arg1, arg2;
758 add_to_log (format, arg1, arg2);
763 /***********************************************************************
764 Image specifications
765 ***********************************************************************/
767 enum image_value_type
769 IMAGE_DONT_CHECK_VALUE_TYPE,
770 IMAGE_STRING_VALUE,
771 IMAGE_STRING_OR_NIL_VALUE,
772 IMAGE_SYMBOL_VALUE,
773 IMAGE_POSITIVE_INTEGER_VALUE,
774 IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR,
775 IMAGE_NON_NEGATIVE_INTEGER_VALUE,
776 IMAGE_ASCENT_VALUE,
777 IMAGE_INTEGER_VALUE,
778 IMAGE_FUNCTION_VALUE,
779 IMAGE_NUMBER_VALUE,
780 IMAGE_BOOL_VALUE
783 /* Structure used when parsing image specifications. */
785 struct image_keyword
787 /* Name of keyword. */
788 char *name;
790 /* The type of value allowed. */
791 enum image_value_type type;
793 /* Non-zero means key must be present. */
794 int mandatory_p;
796 /* Used to recognize duplicate keywords in a property list. */
797 int count;
799 /* The value that was found. */
800 Lisp_Object value;
804 static int parse_image_spec P_ ((Lisp_Object, struct image_keyword *,
805 int, Lisp_Object));
806 static Lisp_Object image_spec_value P_ ((Lisp_Object, Lisp_Object, int *));
809 /* Parse image spec SPEC according to KEYWORDS. A valid image spec
810 has the format (image KEYWORD VALUE ...). One of the keyword/
811 value pairs must be `:type TYPE'. KEYWORDS is a vector of
812 image_keywords structures of size NKEYWORDS describing other
813 allowed keyword/value pairs. Value is non-zero if SPEC is valid. */
815 static int
816 parse_image_spec (spec, keywords, nkeywords, type)
817 Lisp_Object spec;
818 struct image_keyword *keywords;
819 int nkeywords;
820 Lisp_Object type;
822 int i;
823 Lisp_Object plist;
825 if (!IMAGEP (spec))
826 return 0;
828 plist = XCDR (spec);
829 while (CONSP (plist))
831 Lisp_Object key, value;
833 /* First element of a pair must be a symbol. */
834 key = XCAR (plist);
835 plist = XCDR (plist);
836 if (!SYMBOLP (key))
837 return 0;
839 /* There must follow a value. */
840 if (!CONSP (plist))
841 return 0;
842 value = XCAR (plist);
843 plist = XCDR (plist);
845 /* Find key in KEYWORDS. Error if not found. */
846 for (i = 0; i < nkeywords; ++i)
847 if (strcmp (keywords[i].name, SDATA (SYMBOL_NAME (key))) == 0)
848 break;
850 if (i == nkeywords)
851 continue;
853 /* Record that we recognized the keyword. If a keywords
854 was found more than once, it's an error. */
855 keywords[i].value = value;
856 ++keywords[i].count;
858 if (keywords[i].count > 1)
859 return 0;
861 /* Check type of value against allowed type. */
862 switch (keywords[i].type)
864 case IMAGE_STRING_VALUE:
865 if (!STRINGP (value))
866 return 0;
867 break;
869 case IMAGE_STRING_OR_NIL_VALUE:
870 if (!STRINGP (value) && !NILP (value))
871 return 0;
872 break;
874 case IMAGE_SYMBOL_VALUE:
875 if (!SYMBOLP (value))
876 return 0;
877 break;
879 case IMAGE_POSITIVE_INTEGER_VALUE:
880 if (!INTEGERP (value) || XINT (value) <= 0)
881 return 0;
882 break;
884 case IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR:
885 if (INTEGERP (value) && XINT (value) >= 0)
886 break;
887 if (CONSP (value)
888 && INTEGERP (XCAR (value)) && INTEGERP (XCDR (value))
889 && XINT (XCAR (value)) >= 0 && XINT (XCDR (value)) >= 0)
890 break;
891 return 0;
893 case IMAGE_ASCENT_VALUE:
894 if (SYMBOLP (value) && EQ (value, Qcenter))
895 break;
896 else if (INTEGERP (value)
897 && XINT (value) >= 0
898 && XINT (value) <= 100)
899 break;
900 return 0;
902 case IMAGE_NON_NEGATIVE_INTEGER_VALUE:
903 if (!INTEGERP (value) || XINT (value) < 0)
904 return 0;
905 break;
907 case IMAGE_DONT_CHECK_VALUE_TYPE:
908 break;
910 case IMAGE_FUNCTION_VALUE:
911 value = indirect_function (value);
912 if (SUBRP (value)
913 || COMPILEDP (value)
914 || (CONSP (value) && EQ (XCAR (value), Qlambda)))
915 break;
916 return 0;
918 case IMAGE_NUMBER_VALUE:
919 if (!INTEGERP (value) && !FLOATP (value))
920 return 0;
921 break;
923 case IMAGE_INTEGER_VALUE:
924 if (!INTEGERP (value))
925 return 0;
926 break;
928 case IMAGE_BOOL_VALUE:
929 if (!NILP (value) && !EQ (value, Qt))
930 return 0;
931 break;
933 default:
934 abort ();
935 break;
938 if (EQ (key, QCtype) && !EQ (type, value))
939 return 0;
942 /* Check that all mandatory fields are present. */
943 for (i = 0; i < nkeywords; ++i)
944 if (keywords[i].mandatory_p && keywords[i].count == 0)
945 return 0;
947 return NILP (plist);
951 /* Return the value of KEY in image specification SPEC. Value is nil
952 if KEY is not present in SPEC. if FOUND is not null, set *FOUND
953 to 1 if KEY was found in SPEC, set it to 0 otherwise. */
955 static Lisp_Object
956 image_spec_value (spec, key, found)
957 Lisp_Object spec, key;
958 int *found;
960 Lisp_Object tail;
962 xassert (valid_image_p (spec));
964 for (tail = XCDR (spec);
965 CONSP (tail) && CONSP (XCDR (tail));
966 tail = XCDR (XCDR (tail)))
968 if (EQ (XCAR (tail), key))
970 if (found)
971 *found = 1;
972 return XCAR (XCDR (tail));
976 if (found)
977 *found = 0;
978 return Qnil;
982 DEFUN ("image-size", Fimage_size, Simage_size, 1, 3, 0,
983 doc: /* Return the size of image SPEC as pair (WIDTH . HEIGHT).
984 PIXELS non-nil means return the size in pixels, otherwise return the
985 size in canonical character units.
986 FRAME is the frame on which the image will be displayed. FRAME nil
987 or omitted means use the selected frame. */)
988 (spec, pixels, frame)
989 Lisp_Object spec, pixels, frame;
991 Lisp_Object size;
993 size = Qnil;
994 if (valid_image_p (spec))
996 struct frame *f = check_x_frame (frame);
997 int id = lookup_image (f, spec);
998 struct image *img = IMAGE_FROM_ID (f, id);
999 int width = img->width + 2 * img->hmargin;
1000 int height = img->height + 2 * img->vmargin;
1002 if (NILP (pixels))
1003 size = Fcons (make_float ((double) width / FRAME_COLUMN_WIDTH (f)),
1004 make_float ((double) height / FRAME_LINE_HEIGHT (f)));
1005 else
1006 size = Fcons (make_number (width), make_number (height));
1008 else
1009 error ("Invalid image specification");
1011 return size;
1015 DEFUN ("image-mask-p", Fimage_mask_p, Simage_mask_p, 1, 2, 0,
1016 doc: /* Return t if image SPEC has a mask bitmap.
1017 FRAME is the frame on which the image will be displayed. FRAME nil
1018 or omitted means use the selected frame. */)
1019 (spec, frame)
1020 Lisp_Object spec, frame;
1022 Lisp_Object mask;
1024 mask = Qnil;
1025 if (valid_image_p (spec))
1027 struct frame *f = check_x_frame (frame);
1028 int id = lookup_image (f, spec);
1029 struct image *img = IMAGE_FROM_ID (f, id);
1030 if (img->mask)
1031 mask = Qt;
1033 else
1034 error ("Invalid image specification");
1036 return mask;
1040 /***********************************************************************
1041 Image type independent image structures
1042 ***********************************************************************/
1044 static struct image *make_image P_ ((Lisp_Object spec, unsigned hash));
1045 static void free_image P_ ((struct frame *f, struct image *img));
1048 /* Allocate and return a new image structure for image specification
1049 SPEC. SPEC has a hash value of HASH. */
1051 static struct image *
1052 make_image (spec, hash)
1053 Lisp_Object spec;
1054 unsigned hash;
1056 struct image *img = (struct image *) xmalloc (sizeof *img);
1058 xassert (valid_image_p (spec));
1059 bzero (img, sizeof *img);
1060 img->type = lookup_image_type (image_spec_value (spec, QCtype, NULL));
1061 xassert (img->type != NULL);
1062 img->spec = spec;
1063 img->data.lisp_val = Qnil;
1064 img->ascent = DEFAULT_IMAGE_ASCENT;
1065 img->hash = hash;
1066 return img;
1070 /* Free image IMG which was used on frame F, including its resources. */
1072 static void
1073 free_image (f, img)
1074 struct frame *f;
1075 struct image *img;
1077 if (img)
1079 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
1081 /* Remove IMG from the hash table of its cache. */
1082 if (img->prev)
1083 img->prev->next = img->next;
1084 else
1085 c->buckets[img->hash % IMAGE_CACHE_BUCKETS_SIZE] = img->next;
1087 if (img->next)
1088 img->next->prev = img->prev;
1090 c->images[img->id] = NULL;
1092 /* Free resources, then free IMG. */
1093 img->type->free (f, img);
1094 xfree (img);
1099 /* Prepare image IMG for display on frame F. Must be called before
1100 drawing an image. */
1102 void
1103 prepare_image_for_display (f, img)
1104 struct frame *f;
1105 struct image *img;
1107 EMACS_TIME t;
1109 /* We're about to display IMG, so set its timestamp to `now'. */
1110 EMACS_GET_TIME (t);
1111 img->timestamp = EMACS_SECS (t);
1113 /* If IMG doesn't have a pixmap yet, load it now, using the image
1114 type dependent loader function. */
1115 if (img->pixmap == NO_PIXMAP && !img->load_failed_p)
1116 img->load_failed_p = img->type->load (f, img) == 0;
1120 /* Value is the number of pixels for the ascent of image IMG when
1121 drawn in face FACE. */
1124 image_ascent (img, face, slice)
1125 struct image *img;
1126 struct face *face;
1127 struct glyph_slice *slice;
1129 int height;
1130 int ascent;
1132 if (slice->height == img->height)
1133 height = img->height + img->vmargin;
1134 else if (slice->y == 0)
1135 height = slice->height + img->vmargin;
1136 else
1137 height = slice->height;
1139 if (img->ascent == CENTERED_IMAGE_ASCENT)
1141 if (face->font)
1143 #ifdef HAVE_NTGUI
1144 /* W32 specific version. Why?. ++kfs */
1145 ascent = height / 2 - (FONT_DESCENT(face->font)
1146 - FONT_BASE(face->font)) / 2;
1147 #else
1148 /* This expression is arranged so that if the image can't be
1149 exactly centered, it will be moved slightly up. This is
1150 because a typical font is `top-heavy' (due to the presence
1151 uppercase letters), so the image placement should err towards
1152 being top-heavy too. It also just generally looks better. */
1153 ascent = (height + face->font->ascent - face->font->descent + 1) / 2;
1154 #endif /* HAVE_NTGUI */
1156 else
1157 ascent = height / 2;
1159 else
1160 ascent = (int) (height * img->ascent / 100.0);
1162 return ascent;
1166 /* Image background colors. */
1168 /* Find the "best" corner color of a bitmap.
1169 On W32, XIMG is assumed to a device context with the bitmap selected. */
1171 static RGB_PIXEL_COLOR
1172 four_corners_best (ximg, width, height)
1173 XImagePtr_or_DC ximg;
1174 unsigned long width, height;
1176 RGB_PIXEL_COLOR corners[4], best;
1177 int i, best_count;
1179 /* Get the colors at the corners of ximg. */
1180 corners[0] = GET_PIXEL (ximg, 0, 0);
1181 corners[1] = GET_PIXEL (ximg, width - 1, 0);
1182 corners[2] = GET_PIXEL (ximg, width - 1, height - 1);
1183 corners[3] = GET_PIXEL (ximg, 0, height - 1);
1185 /* Choose the most frequently found color as background. */
1186 for (i = best_count = 0; i < 4; ++i)
1188 int j, n;
1190 for (j = n = 0; j < 4; ++j)
1191 if (corners[i] == corners[j])
1192 ++n;
1194 if (n > best_count)
1195 best = corners[i], best_count = n;
1198 return best;
1201 /* Portability macros */
1203 #ifdef HAVE_NTGUI
1205 #define Destroy_Image(img_dc, prev) \
1206 do { SelectObject (img_dc, prev); DeleteDC (img_dc); } while (0)
1208 #define Free_Pixmap(display, pixmap) \
1209 DeleteObject (pixmap)
1211 #else
1213 #define Destroy_Image(ximg, dummy) \
1214 XDestroyImage (ximg)
1216 #define Free_Pixmap(display, pixmap) \
1217 XFreePixmap (display, pixmap)
1219 #endif /* HAVE_NTGUI */
1222 /* Return the `background' field of IMG. If IMG doesn't have one yet,
1223 it is guessed heuristically. If non-zero, XIMG is an existing
1224 XImage object (or device context with the image selected on W32) to
1225 use for the heuristic. */
1227 RGB_PIXEL_COLOR
1228 image_background (img, f, ximg)
1229 struct image *img;
1230 struct frame *f;
1231 XImagePtr_or_DC ximg;
1233 if (! img->background_valid)
1234 /* IMG doesn't have a background yet, try to guess a reasonable value. */
1236 int free_ximg = !ximg;
1237 #ifdef HAVE_NTGUI
1238 HGDIOBJ prev;
1239 #endif /* HAVE_NTGUI */
1241 if (free_ximg)
1243 #ifndef HAVE_NTGUI
1244 ximg = XGetImage (FRAME_X_DISPLAY (f), img->pixmap,
1245 0, 0, img->width, img->height, ~0, ZPixmap);
1246 #else
1247 HDC frame_dc = get_frame_dc (f);
1248 ximg = CreateCompatibleDC (frame_dc);
1249 release_frame_dc (f, frame_dc);
1250 prev = SelectObject (ximg, img->pixmap);
1251 #endif /* !HAVE_NTGUI */
1254 img->background = four_corners_best (ximg, img->width, img->height);
1256 if (free_ximg)
1257 Destroy_Image (ximg, prev);
1259 img->background_valid = 1;
1262 return img->background;
1265 /* Return the `background_transparent' field of IMG. If IMG doesn't
1266 have one yet, it is guessed heuristically. If non-zero, MASK is an
1267 existing XImage object to use for the heuristic. */
1270 image_background_transparent (img, f, mask)
1271 struct image *img;
1272 struct frame *f;
1273 XImagePtr_or_DC mask;
1275 if (! img->background_transparent_valid)
1276 /* IMG doesn't have a background yet, try to guess a reasonable value. */
1278 if (img->mask)
1280 int free_mask = !mask;
1281 #ifdef HAVE_NTGUI
1282 HGDIOBJ prev;
1283 #endif /* HAVE_NTGUI */
1285 if (free_mask)
1287 #ifndef HAVE_NTGUI
1288 mask = XGetImage (FRAME_X_DISPLAY (f), img->mask,
1289 0, 0, img->width, img->height, ~0, ZPixmap);
1290 #else
1291 HDC frame_dc = get_frame_dc (f);
1292 mask = CreateCompatibleDC (frame_dc);
1293 release_frame_dc (f, frame_dc);
1294 prev = SelectObject (mask, img->mask);
1295 #endif /* HAVE_NTGUI */
1298 img->background_transparent
1299 = (four_corners_best (mask, img->width, img->height) == PIX_MASK_RETAIN (f));
1301 if (free_mask)
1302 Destroy_Image (mask, prev);
1304 else
1305 img->background_transparent = 0;
1307 img->background_transparent_valid = 1;
1310 return img->background_transparent;
1314 /***********************************************************************
1315 Helper functions for X image types
1316 ***********************************************************************/
1318 static void x_clear_image_1 P_ ((struct frame *, struct image *, int,
1319 int, int));
1320 static void x_clear_image P_ ((struct frame *f, struct image *img));
1321 static unsigned long x_alloc_image_color P_ ((struct frame *f,
1322 struct image *img,
1323 Lisp_Object color_name,
1324 unsigned long dflt));
1327 /* Clear X resources of image IMG on frame F. PIXMAP_P non-zero means
1328 free the pixmap if any. MASK_P non-zero means clear the mask
1329 pixmap if any. COLORS_P non-zero means free colors allocated for
1330 the image, if any. */
1332 static void
1333 x_clear_image_1 (f, img, pixmap_p, mask_p, colors_p)
1334 struct frame *f;
1335 struct image *img;
1336 int pixmap_p, mask_p, colors_p;
1338 if (pixmap_p && img->pixmap)
1340 Free_Pixmap (FRAME_X_DISPLAY (f), img->pixmap);
1341 img->pixmap = NO_PIXMAP;
1342 img->background_valid = 0;
1345 if (mask_p && img->mask)
1347 Free_Pixmap (FRAME_X_DISPLAY (f), img->mask);
1348 img->mask = NO_PIXMAP;
1349 img->background_transparent_valid = 0;
1352 if (colors_p && img->ncolors)
1354 /* MAC_TODO: color table support. */
1355 /* W32_TODO: color table support. */
1356 #ifdef HAVE_X_WINDOWS
1357 x_free_colors (f, img->colors, img->ncolors);
1358 #endif /* HAVE_X_WINDOWS */
1359 xfree (img->colors);
1360 img->colors = NULL;
1361 img->ncolors = 0;
1365 /* Free X resources of image IMG which is used on frame F. */
1367 static void
1368 x_clear_image (f, img)
1369 struct frame *f;
1370 struct image *img;
1372 BLOCK_INPUT;
1373 x_clear_image_1 (f, img, 1, 1, 1);
1374 UNBLOCK_INPUT;
1378 /* Allocate color COLOR_NAME for image IMG on frame F. If color
1379 cannot be allocated, use DFLT. Add a newly allocated color to
1380 IMG->colors, so that it can be freed again. Value is the pixel
1381 color. */
1383 static unsigned long
1384 x_alloc_image_color (f, img, color_name, dflt)
1385 struct frame *f;
1386 struct image *img;
1387 Lisp_Object color_name;
1388 unsigned long dflt;
1390 XColor color;
1391 unsigned long result;
1393 xassert (STRINGP (color_name));
1395 if (x_defined_color (f, SDATA (color_name), &color, 1))
1397 /* This isn't called frequently so we get away with simply
1398 reallocating the color vector to the needed size, here. */
1399 ++img->ncolors;
1400 img->colors =
1401 (unsigned long *) xrealloc (img->colors,
1402 img->ncolors * sizeof *img->colors);
1403 img->colors[img->ncolors - 1] = color.pixel;
1404 result = color.pixel;
1406 else
1407 result = dflt;
1409 return result;
1414 /***********************************************************************
1415 Image Cache
1416 ***********************************************************************/
1418 static void cache_image P_ ((struct frame *f, struct image *img));
1419 static void postprocess_image P_ ((struct frame *, struct image *));
1421 /* Return a new, initialized image cache that is allocated from the
1422 heap. Call free_image_cache to free an image cache. */
1424 struct image_cache *
1425 make_image_cache ()
1427 struct image_cache *c = (struct image_cache *) xmalloc (sizeof *c);
1428 int size;
1430 bzero (c, sizeof *c);
1431 c->size = 50;
1432 c->images = (struct image **) xmalloc (c->size * sizeof *c->images);
1433 size = IMAGE_CACHE_BUCKETS_SIZE * sizeof *c->buckets;
1434 c->buckets = (struct image **) xmalloc (size);
1435 bzero (c->buckets, size);
1436 return c;
1440 /* Free image cache of frame F. Be aware that X frames share images
1441 caches. */
1443 void
1444 free_image_cache (f)
1445 struct frame *f;
1447 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
1448 if (c)
1450 int i;
1452 /* Cache should not be referenced by any frame when freed. */
1453 xassert (c->refcount == 0);
1455 for (i = 0; i < c->used; ++i)
1456 free_image (f, c->images[i]);
1457 xfree (c->images);
1458 xfree (c->buckets);
1459 xfree (c);
1460 FRAME_X_IMAGE_CACHE (f) = NULL;
1465 /* Clear image cache of frame F. FORCE_P non-zero means free all
1466 images. FORCE_P zero means clear only images that haven't been
1467 displayed for some time. Should be called from time to time to
1468 reduce the number of loaded images. If image-eviction-seconds is
1469 non-nil, this frees images in the cache which weren't displayed for
1470 at least that many seconds. */
1472 void
1473 clear_image_cache (f, force_p)
1474 struct frame *f;
1475 int force_p;
1477 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
1479 if (c && INTEGERP (Vimage_cache_eviction_delay))
1481 EMACS_TIME t;
1482 unsigned long old;
1483 int i, nfreed;
1485 EMACS_GET_TIME (t);
1486 old = EMACS_SECS (t) - XFASTINT (Vimage_cache_eviction_delay);
1488 /* Block input so that we won't be interrupted by a SIGIO
1489 while being in an inconsistent state. */
1490 BLOCK_INPUT;
1492 for (i = nfreed = 0; i < c->used; ++i)
1494 struct image *img = c->images[i];
1495 if (img != NULL
1496 && (force_p || img->timestamp < old))
1498 free_image (f, img);
1499 ++nfreed;
1503 /* We may be clearing the image cache because, for example,
1504 Emacs was iconified for a longer period of time. In that
1505 case, current matrices may still contain references to
1506 images freed above. So, clear these matrices. */
1507 if (nfreed)
1509 Lisp_Object tail, frame;
1511 FOR_EACH_FRAME (tail, frame)
1513 struct frame *f = XFRAME (frame);
1514 if (FRAME_WINDOW_P (f)
1515 && FRAME_X_IMAGE_CACHE (f) == c)
1516 clear_current_matrices (f);
1519 ++windows_or_buffers_changed;
1522 UNBLOCK_INPUT;
1527 DEFUN ("clear-image-cache", Fclear_image_cache, Sclear_image_cache,
1528 0, 1, 0,
1529 doc: /* Clear the image cache of FRAME.
1530 FRAME nil or omitted means use the selected frame.
1531 FRAME t means clear the image caches of all frames. */)
1532 (frame)
1533 Lisp_Object frame;
1535 if (EQ (frame, Qt))
1537 Lisp_Object tail;
1539 FOR_EACH_FRAME (tail, frame)
1540 if (FRAME_WINDOW_P (XFRAME (frame)))
1541 clear_image_cache (XFRAME (frame), 1);
1543 else
1544 clear_image_cache (check_x_frame (frame), 1);
1546 return Qnil;
1550 /* Compute masks and transform image IMG on frame F, as specified
1551 by the image's specification, */
1553 static void
1554 postprocess_image (f, img)
1555 struct frame *f;
1556 struct image *img;
1558 /* Manipulation of the image's mask. */
1559 if (img->pixmap)
1561 Lisp_Object conversion, spec;
1562 Lisp_Object mask;
1564 spec = img->spec;
1566 /* `:heuristic-mask t'
1567 `:mask heuristic'
1568 means build a mask heuristically.
1569 `:heuristic-mask (R G B)'
1570 `:mask (heuristic (R G B))'
1571 means build a mask from color (R G B) in the
1572 image.
1573 `:mask nil'
1574 means remove a mask, if any. */
1576 mask = image_spec_value (spec, QCheuristic_mask, NULL);
1577 if (!NILP (mask))
1578 x_build_heuristic_mask (f, img, mask);
1579 else
1581 int found_p;
1583 mask = image_spec_value (spec, QCmask, &found_p);
1585 if (EQ (mask, Qheuristic))
1586 x_build_heuristic_mask (f, img, Qt);
1587 else if (CONSP (mask)
1588 && EQ (XCAR (mask), Qheuristic))
1590 if (CONSP (XCDR (mask)))
1591 x_build_heuristic_mask (f, img, XCAR (XCDR (mask)));
1592 else
1593 x_build_heuristic_mask (f, img, XCDR (mask));
1595 else if (NILP (mask) && found_p && img->mask)
1597 Free_Pixmap (FRAME_X_DISPLAY (f), img->mask);
1598 img->mask = NO_PIXMAP;
1603 /* Should we apply an image transformation algorithm? */
1604 conversion = image_spec_value (spec, QCconversion, NULL);
1605 if (EQ (conversion, Qdisabled))
1606 x_disable_image (f, img);
1607 else if (EQ (conversion, Qlaplace))
1608 x_laplace (f, img);
1609 else if (EQ (conversion, Qemboss))
1610 x_emboss (f, img);
1611 else if (CONSP (conversion)
1612 && EQ (XCAR (conversion), Qedge_detection))
1614 Lisp_Object tem;
1615 tem = XCDR (conversion);
1616 if (CONSP (tem))
1617 x_edge_detection (f, img,
1618 Fplist_get (tem, QCmatrix),
1619 Fplist_get (tem, QCcolor_adjustment));
1625 /* Return the id of image with Lisp specification SPEC on frame F.
1626 SPEC must be a valid Lisp image specification (see valid_image_p). */
1629 lookup_image (f, spec)
1630 struct frame *f;
1631 Lisp_Object spec;
1633 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
1634 #ifdef _MSC_VER
1635 /* Work around a problem with MinGW builds of graphics libraries
1636 not honoring calling conventions. */
1637 static
1638 #endif
1639 struct image *img;
1640 int i;
1641 unsigned hash;
1642 struct gcpro gcpro1;
1643 EMACS_TIME now;
1645 /* F must be a window-system frame, and SPEC must be a valid image
1646 specification. */
1647 xassert (FRAME_WINDOW_P (f));
1648 xassert (valid_image_p (spec));
1650 GCPRO1 (spec);
1652 /* Look up SPEC in the hash table of the image cache. */
1653 hash = sxhash (spec, 0);
1654 i = hash % IMAGE_CACHE_BUCKETS_SIZE;
1656 for (img = c->buckets[i]; img; img = img->next)
1657 if (img->hash == hash && !NILP (Fequal (img->spec, spec)))
1658 break;
1660 /* If not found, create a new image and cache it. */
1661 if (img == NULL)
1663 extern Lisp_Object Qpostscript;
1665 BLOCK_INPUT;
1666 img = make_image (spec, hash);
1667 cache_image (f, img);
1668 img->load_failed_p = img->type->load (f, img) == 0;
1670 /* If we can't load the image, and we don't have a width and
1671 height, use some arbitrary width and height so that we can
1672 draw a rectangle for it. */
1673 if (img->load_failed_p)
1675 Lisp_Object value;
1677 value = image_spec_value (spec, QCwidth, NULL);
1678 img->width = (INTEGERP (value)
1679 ? XFASTINT (value) : DEFAULT_IMAGE_WIDTH);
1680 value = image_spec_value (spec, QCheight, NULL);
1681 img->height = (INTEGERP (value)
1682 ? XFASTINT (value) : DEFAULT_IMAGE_HEIGHT);
1684 else
1686 /* Handle image type independent image attributes
1687 `:ascent ASCENT', `:margin MARGIN', `:relief RELIEF',
1688 `:background COLOR'. */
1689 Lisp_Object ascent, margin, relief, bg;
1691 ascent = image_spec_value (spec, QCascent, NULL);
1692 if (INTEGERP (ascent))
1693 img->ascent = XFASTINT (ascent);
1694 else if (EQ (ascent, Qcenter))
1695 img->ascent = CENTERED_IMAGE_ASCENT;
1697 margin = image_spec_value (spec, QCmargin, NULL);
1698 if (INTEGERP (margin) && XINT (margin) >= 0)
1699 img->vmargin = img->hmargin = XFASTINT (margin);
1700 else if (CONSP (margin) && INTEGERP (XCAR (margin))
1701 && INTEGERP (XCDR (margin)))
1703 if (XINT (XCAR (margin)) > 0)
1704 img->hmargin = XFASTINT (XCAR (margin));
1705 if (XINT (XCDR (margin)) > 0)
1706 img->vmargin = XFASTINT (XCDR (margin));
1709 relief = image_spec_value (spec, QCrelief, NULL);
1710 if (INTEGERP (relief))
1712 img->relief = XINT (relief);
1713 img->hmargin += abs (img->relief);
1714 img->vmargin += abs (img->relief);
1717 if (! img->background_valid)
1719 bg = image_spec_value (img->spec, QCbackground, NULL);
1720 if (!NILP (bg))
1722 img->background
1723 = x_alloc_image_color (f, img, bg,
1724 FRAME_BACKGROUND_PIXEL (f));
1725 img->background_valid = 1;
1729 /* Do image transformations and compute masks, unless we
1730 don't have the image yet. */
1731 if (!EQ (*img->type->type, Qpostscript))
1732 postprocess_image (f, img);
1735 UNBLOCK_INPUT;
1738 /* We're using IMG, so set its timestamp to `now'. */
1739 EMACS_GET_TIME (now);
1740 img->timestamp = EMACS_SECS (now);
1742 UNGCPRO;
1744 /* Value is the image id. */
1745 return img->id;
1749 /* Cache image IMG in the image cache of frame F. */
1751 static void
1752 cache_image (f, img)
1753 struct frame *f;
1754 struct image *img;
1756 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
1757 int i;
1759 /* Find a free slot in c->images. */
1760 for (i = 0; i < c->used; ++i)
1761 if (c->images[i] == NULL)
1762 break;
1764 /* If no free slot found, maybe enlarge c->images. */
1765 if (i == c->used && c->used == c->size)
1767 c->size *= 2;
1768 c->images = (struct image **) xrealloc (c->images,
1769 c->size * sizeof *c->images);
1772 /* Add IMG to c->images, and assign IMG an id. */
1773 c->images[i] = img;
1774 img->id = i;
1775 if (i == c->used)
1776 ++c->used;
1778 /* Add IMG to the cache's hash table. */
1779 i = img->hash % IMAGE_CACHE_BUCKETS_SIZE;
1780 img->next = c->buckets[i];
1781 if (img->next)
1782 img->next->prev = img;
1783 img->prev = NULL;
1784 c->buckets[i] = img;
1788 /* Call FN on every image in the image cache of frame F. Used to mark
1789 Lisp Objects in the image cache. */
1791 void
1792 forall_images_in_image_cache (f, fn)
1793 struct frame *f;
1794 void (*fn) P_ ((struct image *img));
1796 if (FRAME_LIVE_P (f) && FRAME_WINDOW_P (f))
1798 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
1799 if (c)
1801 int i;
1802 for (i = 0; i < c->used; ++i)
1803 if (c->images[i])
1804 fn (c->images[i]);
1811 /***********************************************************************
1812 X / MAC / W32 support code
1813 ***********************************************************************/
1815 #ifdef HAVE_NTGUI
1817 /* Macro for defining functions that will be loaded from image DLLs. */
1818 #define DEF_IMGLIB_FN(func) FARPROC fn_##func
1820 /* Macro for loading those image functions from the library. */
1821 #define LOAD_IMGLIB_FN(lib,func) { \
1822 fn_##func = (void *) GetProcAddress (lib, #func); \
1823 if (!fn_##func) return 0; \
1826 /* Load a DLL implementing an image type.
1827 The `image-library-alist' variable associates a symbol,
1828 identifying an image type, to a list of possible filenames.
1829 The function returns NULL if no library could be loaded for
1830 the given image type, or if the library was previously loaded;
1831 else the handle of the DLL. */
1832 static HMODULE
1833 w32_delayed_load (Lisp_Object libraries, Lisp_Object type)
1835 HMODULE library = NULL;
1837 if (CONSP (libraries) && NILP (Fassq (type, Vimage_type_cache)))
1839 Lisp_Object dlls = Fassq (type, libraries);
1841 if (CONSP (dlls))
1842 for (dlls = XCDR (dlls); CONSP (dlls); dlls = XCDR (dlls))
1844 CHECK_STRING_CAR (dlls);
1845 if (library = LoadLibrary (SDATA (XCAR (dlls))))
1846 break;
1850 return library;
1853 #endif /* HAVE_NTGUI */
1855 static int x_create_x_image_and_pixmap P_ ((struct frame *, int, int, int,
1856 XImagePtr *, Pixmap *));
1857 static void x_destroy_x_image P_ ((XImagePtr));
1858 static void x_put_x_image P_ ((struct frame *, XImagePtr, Pixmap, int, int));
1861 /* Create an XImage and a pixmap of size WIDTH x HEIGHT for use on
1862 frame F. Set *XIMG and *PIXMAP to the XImage and Pixmap created.
1863 Set (*XIMG)->data to a raster of WIDTH x HEIGHT pixels allocated
1864 via xmalloc. Print error messages via image_error if an error
1865 occurs. Value is non-zero if successful.
1867 On W32, a DEPTH of zero signifies a 24 bit image, otherwise DEPTH
1868 should indicate the bit depth of the image. */
1870 static int
1871 x_create_x_image_and_pixmap (f, width, height, depth, ximg, pixmap)
1872 struct frame *f;
1873 int width, height, depth;
1874 XImagePtr *ximg;
1875 Pixmap *pixmap;
1877 #ifdef HAVE_X_WINDOWS
1878 Display *display = FRAME_X_DISPLAY (f);
1879 Window window = FRAME_X_WINDOW (f);
1880 Screen *screen = FRAME_X_SCREEN (f);
1882 xassert (interrupt_input_blocked);
1884 if (depth <= 0)
1885 depth = DefaultDepthOfScreen (screen);
1886 *ximg = XCreateImage (display, DefaultVisualOfScreen (screen),
1887 depth, ZPixmap, 0, NULL, width, height,
1888 depth > 16 ? 32 : depth > 8 ? 16 : 8, 0);
1889 if (*ximg == NULL)
1891 image_error ("Unable to allocate X image", Qnil, Qnil);
1892 return 0;
1895 /* Allocate image raster. */
1896 (*ximg)->data = (char *) xmalloc ((*ximg)->bytes_per_line * height);
1898 /* Allocate a pixmap of the same size. */
1899 *pixmap = XCreatePixmap (display, window, width, height, depth);
1900 if (*pixmap == NO_PIXMAP)
1902 x_destroy_x_image (*ximg);
1903 *ximg = NULL;
1904 image_error ("Unable to create X pixmap", Qnil, Qnil);
1905 return 0;
1908 return 1;
1909 #endif /* HAVE_X_WINDOWS */
1911 #ifdef HAVE_NTGUI
1913 BITMAPINFOHEADER *header;
1914 HDC hdc;
1915 int scanline_width_bits;
1916 int remainder;
1917 int palette_colors = 0;
1919 if (depth == 0)
1920 depth = 24;
1922 if (depth != 1 && depth != 4 && depth != 8
1923 && depth != 16 && depth != 24 && depth != 32)
1925 image_error ("Invalid image bit depth specified", Qnil, Qnil);
1926 return 0;
1929 scanline_width_bits = width * depth;
1930 remainder = scanline_width_bits % 32;
1932 if (remainder)
1933 scanline_width_bits += 32 - remainder;
1935 /* Bitmaps with a depth less than 16 need a palette. */
1936 /* BITMAPINFO structure already contains the first RGBQUAD. */
1937 if (depth < 16)
1938 palette_colors = 1 << depth - 1;
1940 *ximg = xmalloc (sizeof (XImage) + palette_colors * sizeof (RGBQUAD));
1941 if (*ximg == NULL)
1943 image_error ("Unable to allocate memory for XImage", Qnil, Qnil);
1944 return 0;
1947 header = &((*ximg)->info.bmiHeader);
1948 bzero (&((*ximg)->info), sizeof (BITMAPINFO));
1949 header->biSize = sizeof (*header);
1950 header->biWidth = width;
1951 header->biHeight = -height; /* negative indicates a top-down bitmap. */
1952 header->biPlanes = 1;
1953 header->biBitCount = depth;
1954 header->biCompression = BI_RGB;
1955 header->biClrUsed = palette_colors;
1957 /* TODO: fill in palette. */
1958 if (depth == 1)
1960 (*ximg)->info.bmiColors[0].rgbBlue = 0;
1961 (*ximg)->info.bmiColors[0].rgbGreen = 0;
1962 (*ximg)->info.bmiColors[0].rgbRed = 0;
1963 (*ximg)->info.bmiColors[0].rgbReserved = 0;
1964 (*ximg)->info.bmiColors[1].rgbBlue = 255;
1965 (*ximg)->info.bmiColors[1].rgbGreen = 255;
1966 (*ximg)->info.bmiColors[1].rgbRed = 255;
1967 (*ximg)->info.bmiColors[1].rgbReserved = 0;
1970 hdc = get_frame_dc (f);
1972 /* Create a DIBSection and raster array for the bitmap,
1973 and store its handle in *pixmap. */
1974 *pixmap = CreateDIBSection (hdc, &((*ximg)->info),
1975 (depth < 16) ? DIB_PAL_COLORS : DIB_RGB_COLORS,
1976 &((*ximg)->data), NULL, 0);
1978 /* Realize display palette and garbage all frames. */
1979 release_frame_dc (f, hdc);
1981 if (*pixmap == NULL)
1983 DWORD err = GetLastError();
1984 Lisp_Object errcode;
1985 /* All system errors are < 10000, so the following is safe. */
1986 XSETINT (errcode, (int) err);
1987 image_error ("Unable to create bitmap, error code %d", errcode, Qnil);
1988 x_destroy_x_image (*ximg);
1989 return 0;
1992 return 1;
1994 #endif /* HAVE_NTGUI */
1996 #ifdef MAC_OS
1997 Display *display = FRAME_X_DISPLAY (f);
1998 Window window = FRAME_X_WINDOW (f);
2000 xassert (interrupt_input_blocked);
2002 /* Allocate a pixmap of the same size. */
2003 *pixmap = XCreatePixmap (display, window, width, height, depth);
2004 if (*pixmap == NO_PIXMAP)
2006 x_destroy_x_image (*ximg);
2007 *ximg = NULL;
2008 image_error ("Unable to create X pixmap", Qnil, Qnil);
2009 return 0;
2012 LockPixels (GetGWorldPixMap (*pixmap));
2013 *ximg = *pixmap;
2014 return 1;
2016 #endif /* MAC_OS */
2020 /* Destroy XImage XIMG. Free XIMG->data. */
2022 static void
2023 x_destroy_x_image (ximg)
2024 XImagePtr ximg;
2026 xassert (interrupt_input_blocked);
2027 if (ximg)
2029 #ifdef HAVE_X_WINDOWS
2030 xfree (ximg->data);
2031 ximg->data = NULL;
2032 XDestroyImage (ximg);
2033 #endif /* HAVE_X_WINDOWS */
2034 #ifdef HAVE_NTGUI
2035 /* Data will be freed by DestroyObject. */
2036 ximg->data = NULL;
2037 xfree (ximg);
2038 #endif /* HAVE_NTGUI */
2039 #ifdef MAC_OS
2040 XDestroyImage (ximg);
2041 #endif /* MAC_OS */
2046 /* Put XImage XIMG into pixmap PIXMAP on frame F. WIDTH and HEIGHT
2047 are width and height of both the image and pixmap. */
2049 static void
2050 x_put_x_image (f, ximg, pixmap, width, height)
2051 struct frame *f;
2052 XImagePtr ximg;
2053 Pixmap pixmap;
2054 int width, height;
2056 #ifdef HAVE_X_WINDOWS
2057 GC gc;
2059 xassert (interrupt_input_blocked);
2060 gc = XCreateGC (FRAME_X_DISPLAY (f), pixmap, 0, NULL);
2061 XPutImage (FRAME_X_DISPLAY (f), pixmap, gc, ximg, 0, 0, 0, 0, width, height);
2062 XFreeGC (FRAME_X_DISPLAY (f), gc);
2063 #endif /* HAVE_X_WINDOWS */
2065 #ifdef HAVE_NTGUI
2066 #if 0 /* I don't think this is necessary looking at where it is used. */
2067 HDC hdc = get_frame_dc (f);
2068 SetDIBits (hdc, pixmap, 0, height, ximg->data, &(ximg->info), DIB_RGB_COLORS);
2069 release_frame_dc (f, hdc);
2070 #endif
2071 #endif /* HAVE_NTGUI */
2073 #ifdef MAC_OS
2074 xassert (ximg == pixmap);
2075 #endif /* MAC_OS */
2079 /***********************************************************************
2080 File Handling
2081 ***********************************************************************/
2083 static unsigned char *slurp_file P_ ((char *, int *));
2086 /* Find image file FILE. Look in data-directory, then
2087 x-bitmap-file-path. Value is the full name of the file found, or
2088 nil if not found. */
2090 Lisp_Object
2091 x_find_image_file (file)
2092 Lisp_Object file;
2094 Lisp_Object file_found, search_path;
2095 struct gcpro gcpro1, gcpro2;
2096 int fd;
2098 file_found = Qnil;
2099 search_path = Fcons (Vdata_directory, Vx_bitmap_file_path);
2100 GCPRO2 (file_found, search_path);
2102 /* Try to find FILE in data-directory, then x-bitmap-file-path. */
2103 fd = openp (search_path, file, Qnil, &file_found, Qnil);
2105 if (fd == -1)
2106 file_found = Qnil;
2107 else
2108 close (fd);
2110 UNGCPRO;
2111 return file_found;
2115 /* Read FILE into memory. Value is a pointer to a buffer allocated
2116 with xmalloc holding FILE's contents. Value is null if an error
2117 occurred. *SIZE is set to the size of the file. */
2119 static unsigned char *
2120 slurp_file (file, size)
2121 char *file;
2122 int *size;
2124 FILE *fp = NULL;
2125 unsigned char *buf = NULL;
2126 struct stat st;
2128 if (stat (file, &st) == 0
2129 && (fp = fopen (file, "rb")) != NULL
2130 && (buf = (char *) xmalloc (st.st_size),
2131 fread (buf, 1, st.st_size, fp) == st.st_size))
2133 *size = st.st_size;
2134 fclose (fp);
2136 else
2138 if (fp)
2139 fclose (fp);
2140 if (buf)
2142 xfree (buf);
2143 buf = NULL;
2147 return buf;
2152 #ifdef MAC_OS
2154 /***********************************************************************
2155 MAC Image Load Functions
2156 ***********************************************************************/
2158 static int image_load_quicktime P_ ((struct frame *, struct image *img,
2159 OSType));
2160 #ifdef MAC_OSX
2161 static int image_load_quartz2d P_ ((struct frame *, struct image *img, int));
2162 #endif
2164 static OSErr
2165 find_image_fsspec (specified_file, file, fss)
2166 Lisp_Object specified_file, *file;
2167 FSSpec *fss;
2169 #if TARGET_API_MAC_CARBON
2170 FSRef fsr;
2171 #else
2172 Str255 mac_pathname;
2173 #endif
2174 OSErr err;
2176 *file = x_find_image_file (specified_file);
2177 if (!STRINGP (*file))
2178 return fnfErr; /* file or directory not found;
2179 incomplete pathname */
2180 /* Try to open the image file. */
2181 #if TARGET_API_MAC_CARBON
2182 err = FSPathMakeRef (SDATA (*file), &fsr, NULL);
2183 if (err == noErr)
2184 err = FSGetCatalogInfo (&fsr, kFSCatInfoNone, NULL, NULL, fss, NULL);
2185 #else
2186 if (posix_to_mac_pathname (SDATA (*file), mac_pathname, MAXPATHLEN+1) == 0)
2187 return fnfErr;
2188 c2pstr (mac_pathname);
2189 err = FSMakeFSSpec (0, 0, mac_pathname, fss);
2190 #endif
2191 return err;
2194 static int
2195 image_load_qt_1 (f, img, type, fss, dh)
2196 struct frame *f;
2197 struct image *img;
2198 OSType type;
2199 FSSpec *fss;
2200 Handle dh;
2202 OSErr err;
2203 GraphicsImportComponent gi;
2204 Rect rect;
2205 int width, height;
2206 short draw_all_pixels;
2207 Lisp_Object specified_bg;
2208 XColor color;
2209 XImagePtr ximg;
2210 RGBColor bg_color;
2212 err = OpenADefaultComponent (GraphicsImporterComponentType,
2213 type, &gi);
2214 if (err != noErr)
2216 image_error ("Cannot get importer component for `%s'", img->spec, Qnil);
2217 return 0;
2219 if (dh == NULL)
2221 /* read from file system spec */
2222 err = GraphicsImportSetDataFile (gi, fss);
2223 if (err != noErr)
2225 image_error ("Cannot set fsspec to graphics importer for '%s'",
2226 img->spec, Qnil);
2227 goto error;
2230 else
2232 /* read from data handle */
2233 err = GraphicsImportSetDataHandle (gi, dh);
2234 if (err != noErr)
2236 image_error ("Cannot set data handle to graphics importer for `%s'",
2237 img->spec, Qnil);
2238 goto error;
2241 err = GraphicsImportGetNaturalBounds (gi, &rect);
2242 if (err != noErr)
2244 image_error ("Error reading `%s'", img->spec, Qnil);
2245 goto error;
2247 width = img->width = rect.right - rect.left;
2248 height = img->height = rect.bottom - rect.top;
2249 err = GraphicsImportDoesDrawAllPixels (gi, &draw_all_pixels);
2250 #if 0
2251 /* Don't check the error code here. It may have an undocumented
2252 value -32766. */
2253 if (err != noErr)
2255 image_error ("Error reading `%s'", img->spec, Qnil);
2256 goto error;
2258 #endif
2259 if (draw_all_pixels != graphicsImporterDrawsAllPixels)
2261 specified_bg = image_spec_value (img->spec, QCbackground, NULL);
2262 if (!STRINGP (specified_bg) ||
2263 !mac_defined_color (f, SDATA (specified_bg), &color, 0))
2265 color.pixel = FRAME_BACKGROUND_PIXEL (f);
2266 color.red = RED16_FROM_ULONG (color.pixel);
2267 color.green = GREEN16_FROM_ULONG (color.pixel);
2268 color.blue = BLUE16_FROM_ULONG (color.pixel);
2272 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
2273 goto error;
2274 if (draw_all_pixels != graphicsImporterDrawsAllPixels)
2276 CGrafPtr old_port;
2277 GDHandle old_gdh;
2279 GetGWorld (&old_port, &old_gdh);
2280 SetGWorld (ximg, NULL);
2281 bg_color.red = color.red;
2282 bg_color.green = color.green;
2283 bg_color.blue = color.blue;
2284 RGBBackColor (&bg_color);
2285 #if TARGET_API_MAC_CARBON
2286 GetPortBounds (ximg, &rect);
2287 EraseRect (&rect);
2288 #else
2289 EraseRect (&(ximg->portRect));
2290 #endif
2291 SetGWorld (old_port, old_gdh);
2293 GraphicsImportSetGWorld (gi, ximg, NULL);
2294 GraphicsImportDraw (gi);
2295 CloseComponent (gi);
2297 /* Maybe fill in the background field while we have ximg handy. */
2298 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
2299 IMAGE_BACKGROUND (img, f, ximg);
2301 /* Put the image into the pixmap. */
2302 x_put_x_image (f, ximg, img->pixmap, width, height);
2303 x_destroy_x_image (ximg);
2304 return 1;
2306 error:
2307 CloseComponent (gi);
2308 return 0;
2312 /* Load an image using the QuickTime Graphics Importer.
2313 Note: The alpha channel does not work for PNG images. */
2314 static int
2315 image_load_quicktime (f, img, type)
2316 struct frame *f;
2317 struct image *img;
2318 OSType type;
2320 Lisp_Object specified_file;
2321 Lisp_Object specified_data;
2322 OSErr err;
2324 specified_file = image_spec_value (img->spec, QCfile, NULL);
2325 specified_data = image_spec_value (img->spec, QCdata, NULL);
2327 if (NILP (specified_data))
2329 /* Read from a file */
2330 Lisp_Object file;
2331 FSSpec fss;
2333 err = find_image_fsspec (specified_file, &file, &fss);
2334 if (err != noErr)
2336 if (err == fnfErr)
2337 image_error ("Cannot find image file `%s'", specified_file, Qnil);
2338 else
2339 image_error ("Cannot open `%s'", file, Qnil);
2340 return 0;
2342 return image_load_qt_1 (f, img, type, &fss, NULL);
2344 else
2346 /* Memory source! */
2347 int success_p;
2348 Handle dh;
2350 err = PtrToHand (SDATA (specified_data), &dh, SBYTES (specified_data));
2351 if (err != noErr)
2353 image_error ("Cannot allocate data handle for `%s'",
2354 img->spec, Qnil);
2355 return 0;
2357 success_p = image_load_qt_1 (f, img, type, NULL, dh);
2358 DisposeHandle (dh);
2359 return success_p;
2364 #ifdef MAC_OSX
2365 /* Load a PNG/JPEG image using Quartz 2D decoding routines.
2366 CGImageCreateWithPNGDataProvider is provided after Mac OS X 10.2.
2367 So don't use this function directly but determine at runtime
2368 whether it exists. */
2369 typedef CGImageRef (*CGImageCreateWithPNGDataProviderProcType)
2370 (CGDataProviderRef, const float [], bool, CGColorRenderingIntent);
2371 static CGImageCreateWithPNGDataProviderProcType MyCGImageCreateWithPNGDataProvider;
2374 static void
2375 init_image_func_pointer ()
2377 if (NSIsSymbolNameDefined ("_CGImageCreateWithPNGDataProvider"))
2379 MyCGImageCreateWithPNGDataProvider
2380 = (CGImageCreateWithPNGDataProviderProcType)
2381 NSAddressOfSymbol (NSLookupAndBindSymbol
2382 ("_CGImageCreateWithPNGDataProvider"));
2384 else
2385 MyCGImageCreateWithPNGDataProvider = NULL;
2389 static int
2390 image_load_quartz2d (f, img, png_p)
2391 struct frame *f;
2392 struct image *img;
2393 int png_p;
2395 Lisp_Object file, specified_file;
2396 Lisp_Object specified_data, specified_bg;
2397 struct gcpro gcpro1;
2398 CGDataProviderRef source;
2399 CGImageRef image;
2400 int width, height;
2401 XColor color;
2402 XImagePtr ximg = NULL;
2403 CGContextRef context;
2404 CGRect rectangle;
2406 /* Open the file. */
2407 specified_file = image_spec_value (img->spec, QCfile, NULL);
2408 specified_data = image_spec_value (img->spec, QCdata, NULL);
2410 file = Qnil;
2411 GCPRO1 (file);
2413 if (NILP (specified_data))
2415 CFStringRef path;
2416 CFURLRef url;
2418 file = x_find_image_file (specified_file);
2419 if (!STRINGP (file))
2421 image_error ("Cannot find image file `%s'", specified_file, Qnil);
2422 UNGCPRO;
2423 return 0;
2425 path = cfstring_create_with_string (file);
2426 url = CFURLCreateWithFileSystemPath (NULL, path,
2427 kCFURLPOSIXPathStyle, 0);
2428 CFRelease (path);
2429 source = CGDataProviderCreateWithURL (url);
2430 CFRelease (url);
2432 else
2433 source = CGDataProviderCreateWithData (NULL, SDATA (specified_data),
2434 SBYTES (specified_data), NULL);
2436 if (png_p)
2437 image = (*MyCGImageCreateWithPNGDataProvider) (source, NULL, FALSE,
2438 kCGRenderingIntentDefault);
2439 else
2440 image = CGImageCreateWithJPEGDataProvider (source, NULL, FALSE,
2441 kCGRenderingIntentDefault);
2443 CGDataProviderRelease (source);
2444 if (image == NULL)
2446 UNGCPRO;
2447 image_error ("Error reading image `%s'", img->spec, Qnil);
2448 return 0;
2451 if (png_p)
2453 specified_bg = image_spec_value (img->spec, QCbackground, NULL);
2454 if (!STRINGP (specified_bg) ||
2455 !mac_defined_color (f, SDATA (specified_bg), &color, 0))
2457 color.pixel = FRAME_BACKGROUND_PIXEL (f);
2458 color.red = RED16_FROM_ULONG (color.pixel);
2459 color.green = GREEN16_FROM_ULONG (color.pixel);
2460 color.blue = BLUE16_FROM_ULONG (color.pixel);
2463 width = img->width = CGImageGetWidth (image);
2464 height = img->height = CGImageGetHeight (image);
2465 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
2467 CGImageRelease (image);
2468 UNGCPRO;
2469 return 0;
2471 rectangle = CGRectMake (0, 0, width, height);
2472 QDBeginCGContext (ximg, &context);
2473 if (png_p)
2475 CGContextSetRGBFillColor (context, color.red / 65535.0,
2476 color.green / 65535.0,
2477 color.blue / 65535.0, 1.0);
2478 CGContextFillRect (context, rectangle);
2480 CGContextDrawImage (context, rectangle, image);
2481 QDEndCGContext (ximg, &context);
2482 CGImageRelease (image);
2484 /* Maybe fill in the background field while we have ximg handy. */
2485 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
2486 IMAGE_BACKGROUND (img, f, ximg);
2488 /* Put the image into the pixmap. */
2489 x_put_x_image (f, ximg, img->pixmap, width, height);
2490 x_destroy_x_image (ximg);
2491 UNGCPRO;
2492 return 1;
2494 #endif
2496 #endif /* MAC_OS */
2499 /***********************************************************************
2500 XBM images
2501 ***********************************************************************/
2503 static int xbm_scan P_ ((unsigned char **, unsigned char *, char *, int *));
2504 static int xbm_load P_ ((struct frame *f, struct image *img));
2505 static int xbm_load_image P_ ((struct frame *f, struct image *img,
2506 unsigned char *, unsigned char *));
2507 static int xbm_image_p P_ ((Lisp_Object object));
2508 static int xbm_read_bitmap_data P_ ((unsigned char *, unsigned char *,
2509 int *, int *, unsigned char **));
2510 static int xbm_file_p P_ ((Lisp_Object));
2513 /* Indices of image specification fields in xbm_format, below. */
2515 enum xbm_keyword_index
2517 XBM_TYPE,
2518 XBM_FILE,
2519 XBM_WIDTH,
2520 XBM_HEIGHT,
2521 XBM_DATA,
2522 XBM_FOREGROUND,
2523 XBM_BACKGROUND,
2524 XBM_ASCENT,
2525 XBM_MARGIN,
2526 XBM_RELIEF,
2527 XBM_ALGORITHM,
2528 XBM_HEURISTIC_MASK,
2529 XBM_MASK,
2530 XBM_LAST
2533 /* Vector of image_keyword structures describing the format
2534 of valid XBM image specifications. */
2536 static struct image_keyword xbm_format[XBM_LAST] =
2538 {":type", IMAGE_SYMBOL_VALUE, 1},
2539 {":file", IMAGE_STRING_VALUE, 0},
2540 {":width", IMAGE_POSITIVE_INTEGER_VALUE, 0},
2541 {":height", IMAGE_POSITIVE_INTEGER_VALUE, 0},
2542 {":data", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
2543 {":foreground", IMAGE_STRING_OR_NIL_VALUE, 0},
2544 {":background", IMAGE_STRING_OR_NIL_VALUE, 0},
2545 {":ascent", IMAGE_ASCENT_VALUE, 0},
2546 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
2547 {":relief", IMAGE_INTEGER_VALUE, 0},
2548 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
2549 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
2550 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
2553 /* Structure describing the image type XBM. */
2555 static struct image_type xbm_type =
2557 &Qxbm,
2558 xbm_image_p,
2559 xbm_load,
2560 x_clear_image,
2561 NULL
2564 /* Tokens returned from xbm_scan. */
2566 enum xbm_token
2568 XBM_TK_IDENT = 256,
2569 XBM_TK_NUMBER
2573 /* Return non-zero if OBJECT is a valid XBM-type image specification.
2574 A valid specification is a list starting with the symbol `image'
2575 The rest of the list is a property list which must contain an
2576 entry `:type xbm..
2578 If the specification specifies a file to load, it must contain
2579 an entry `:file FILENAME' where FILENAME is a string.
2581 If the specification is for a bitmap loaded from memory it must
2582 contain `:width WIDTH', `:height HEIGHT', and `:data DATA', where
2583 WIDTH and HEIGHT are integers > 0. DATA may be:
2585 1. a string large enough to hold the bitmap data, i.e. it must
2586 have a size >= (WIDTH + 7) / 8 * HEIGHT
2588 2. a bool-vector of size >= WIDTH * HEIGHT
2590 3. a vector of strings or bool-vectors, one for each line of the
2591 bitmap.
2593 4. A string containing an in-memory XBM file. WIDTH and HEIGHT
2594 may not be specified in this case because they are defined in the
2595 XBM file.
2597 Both the file and data forms may contain the additional entries
2598 `:background COLOR' and `:foreground COLOR'. If not present,
2599 foreground and background of the frame on which the image is
2600 displayed is used. */
2602 static int
2603 xbm_image_p (object)
2604 Lisp_Object object;
2606 struct image_keyword kw[XBM_LAST];
2608 bcopy (xbm_format, kw, sizeof kw);
2609 if (!parse_image_spec (object, kw, XBM_LAST, Qxbm))
2610 return 0;
2612 xassert (EQ (kw[XBM_TYPE].value, Qxbm));
2614 if (kw[XBM_FILE].count)
2616 if (kw[XBM_WIDTH].count || kw[XBM_HEIGHT].count || kw[XBM_DATA].count)
2617 return 0;
2619 else if (kw[XBM_DATA].count && xbm_file_p (kw[XBM_DATA].value))
2621 /* In-memory XBM file. */
2622 if (kw[XBM_WIDTH].count || kw[XBM_HEIGHT].count || kw[XBM_FILE].count)
2623 return 0;
2625 else
2627 Lisp_Object data;
2628 int width, height;
2630 /* Entries for `:width', `:height' and `:data' must be present. */
2631 if (!kw[XBM_WIDTH].count
2632 || !kw[XBM_HEIGHT].count
2633 || !kw[XBM_DATA].count)
2634 return 0;
2636 data = kw[XBM_DATA].value;
2637 width = XFASTINT (kw[XBM_WIDTH].value);
2638 height = XFASTINT (kw[XBM_HEIGHT].value);
2640 /* Check type of data, and width and height against contents of
2641 data. */
2642 if (VECTORP (data))
2644 int i;
2646 /* Number of elements of the vector must be >= height. */
2647 if (XVECTOR (data)->size < height)
2648 return 0;
2650 /* Each string or bool-vector in data must be large enough
2651 for one line of the image. */
2652 for (i = 0; i < height; ++i)
2654 Lisp_Object elt = XVECTOR (data)->contents[i];
2656 if (STRINGP (elt))
2658 if (SCHARS (elt)
2659 < (width + BITS_PER_CHAR - 1) / BITS_PER_CHAR)
2660 return 0;
2662 else if (BOOL_VECTOR_P (elt))
2664 if (XBOOL_VECTOR (elt)->size < width)
2665 return 0;
2667 else
2668 return 0;
2671 else if (STRINGP (data))
2673 if (SCHARS (data)
2674 < (width + BITS_PER_CHAR - 1) / BITS_PER_CHAR * height)
2675 return 0;
2677 else if (BOOL_VECTOR_P (data))
2679 if (XBOOL_VECTOR (data)->size < width * height)
2680 return 0;
2682 else
2683 return 0;
2686 return 1;
2690 /* Scan a bitmap file. FP is the stream to read from. Value is
2691 either an enumerator from enum xbm_token, or a character for a
2692 single-character token, or 0 at end of file. If scanning an
2693 identifier, store the lexeme of the identifier in SVAL. If
2694 scanning a number, store its value in *IVAL. */
2696 static int
2697 xbm_scan (s, end, sval, ival)
2698 unsigned char **s, *end;
2699 char *sval;
2700 int *ival;
2702 unsigned int c;
2704 loop:
2706 /* Skip white space. */
2707 while (*s < end && (c = *(*s)++, isspace (c)))
2710 if (*s >= end)
2711 c = 0;
2712 else if (isdigit (c))
2714 int value = 0, digit;
2716 if (c == '0' && *s < end)
2718 c = *(*s)++;
2719 if (c == 'x' || c == 'X')
2721 while (*s < end)
2723 c = *(*s)++;
2724 if (isdigit (c))
2725 digit = c - '0';
2726 else if (c >= 'a' && c <= 'f')
2727 digit = c - 'a' + 10;
2728 else if (c >= 'A' && c <= 'F')
2729 digit = c - 'A' + 10;
2730 else
2731 break;
2732 value = 16 * value + digit;
2735 else if (isdigit (c))
2737 value = c - '0';
2738 while (*s < end
2739 && (c = *(*s)++, isdigit (c)))
2740 value = 8 * value + c - '0';
2743 else
2745 value = c - '0';
2746 while (*s < end
2747 && (c = *(*s)++, isdigit (c)))
2748 value = 10 * value + c - '0';
2751 if (*s < end)
2752 *s = *s - 1;
2753 *ival = value;
2754 c = XBM_TK_NUMBER;
2756 else if (isalpha (c) || c == '_')
2758 *sval++ = c;
2759 while (*s < end
2760 && (c = *(*s)++, (isalnum (c) || c == '_')))
2761 *sval++ = c;
2762 *sval = 0;
2763 if (*s < end)
2764 *s = *s - 1;
2765 c = XBM_TK_IDENT;
2767 else if (c == '/' && **s == '*')
2769 /* C-style comment. */
2770 ++*s;
2771 while (**s && (**s != '*' || *(*s + 1) != '/'))
2772 ++*s;
2773 if (**s)
2775 *s += 2;
2776 goto loop;
2780 return c;
2783 #ifdef HAVE_NTGUI
2785 /* Create a Windows bitmap from X bitmap data. */
2786 static HBITMAP
2787 w32_create_pixmap_from_bitmap_data (int width, int height, char *data)
2789 static unsigned char swap_nibble[16]
2790 = { 0x0, 0x8, 0x4, 0xc, /* 0000 1000 0100 1100 */
2791 0x2, 0xa, 0x6, 0xe, /* 0010 1010 0110 1110 */
2792 0x1, 0x9, 0x5, 0xd, /* 0001 1001 0101 1101 */
2793 0x3, 0xb, 0x7, 0xf }; /* 0011 1011 0111 1111 */
2794 int i, j, w1, w2;
2795 unsigned char *bits, *p;
2796 HBITMAP bmp;
2798 w1 = (width + 7) / 8; /* nb of 8bits elt in X bitmap */
2799 w2 = ((width + 15) / 16) * 2; /* nb of 16bits elt in W32 bitmap */
2800 bits = (unsigned char *) alloca (height * w2);
2801 bzero (bits, height * w2);
2802 for (i = 0; i < height; i++)
2804 p = bits + i*w2;
2805 for (j = 0; j < w1; j++)
2807 /* Bitswap XBM bytes to match how Windows does things. */
2808 unsigned char c = *data++;
2809 *p++ = (unsigned char)((swap_nibble[c & 0xf] << 4)
2810 | (swap_nibble[(c>>4) & 0xf]));
2813 bmp = CreateBitmap (width, height, 1, 1, (char *) bits);
2815 return bmp;
2818 static void convert_mono_to_color_image (f, img, foreground, background)
2819 struct frame *f;
2820 struct image *img;
2821 COLORREF foreground, background;
2823 HDC hdc, old_img_dc, new_img_dc;
2824 HGDIOBJ old_prev, new_prev;
2825 HBITMAP new_pixmap;
2827 hdc = get_frame_dc (f);
2828 old_img_dc = CreateCompatibleDC (hdc);
2829 new_img_dc = CreateCompatibleDC (hdc);
2830 new_pixmap = CreateCompatibleBitmap (hdc, img->width, img->height);
2831 release_frame_dc (f, hdc);
2832 old_prev = SelectObject (old_img_dc, img->pixmap);
2833 new_prev = SelectObject (new_img_dc, new_pixmap);
2834 SetTextColor (new_img_dc, foreground);
2835 SetBkColor (new_img_dc, background);
2837 BitBlt (new_img_dc, 0, 0, img->width, img->height, old_img_dc,
2838 0, 0, SRCCOPY);
2840 SelectObject (old_img_dc, old_prev);
2841 SelectObject (new_img_dc, new_prev);
2842 DeleteDC (old_img_dc);
2843 DeleteDC (new_img_dc);
2844 DeleteObject (img->pixmap);
2845 if (new_pixmap == 0)
2846 fprintf (stderr, "Failed to convert image to color.\n");
2847 else
2848 img->pixmap = new_pixmap;
2851 #define XBM_BIT_SHUFFLE(b) (~(b))
2853 #else
2855 #define XBM_BIT_SHUFFLE(b) (b)
2857 #endif /* HAVE_NTGUI */
2860 static void
2861 Create_Pixmap_From_Bitmap_Data(f, img, data, fg, bg, non_default_colors)
2862 struct frame *f;
2863 struct image *img;
2864 char *data;
2865 RGB_PIXEL_COLOR fg, bg;
2866 int non_default_colors;
2868 #ifdef HAVE_NTGUI
2869 img->pixmap
2870 = w32_create_pixmap_from_bitmap_data (img->width, img->height, data);
2872 /* If colors were specified, transfer the bitmap to a color one. */
2873 if (non_default_colors)
2874 convert_mono_to_color_image (f, img, fg, bg);
2875 #else
2876 img->pixmap
2877 = XCreatePixmapFromBitmapData (FRAME_X_DISPLAY (f),
2878 FRAME_X_WINDOW (f),
2879 data,
2880 img->width, img->height,
2881 fg, bg,
2882 DefaultDepthOfScreen (FRAME_X_SCREEN (f)));
2883 #endif /* HAVE_NTGUI */
2888 /* Replacement for XReadBitmapFileData which isn't available under old
2889 X versions. CONTENTS is a pointer to a buffer to parse; END is the
2890 buffer's end. Set *WIDTH and *HEIGHT to the width and height of
2891 the image. Return in *DATA the bitmap data allocated with xmalloc.
2892 Value is non-zero if successful. DATA null means just test if
2893 CONTENTS looks like an in-memory XBM file. */
2895 static int
2896 xbm_read_bitmap_data (contents, end, width, height, data)
2897 unsigned char *contents, *end;
2898 int *width, *height;
2899 unsigned char **data;
2901 unsigned char *s = contents;
2902 char buffer[BUFSIZ];
2903 int padding_p = 0;
2904 int v10 = 0;
2905 int bytes_per_line, i, nbytes;
2906 unsigned char *p;
2907 int value;
2908 int LA1;
2910 #define match() \
2911 LA1 = xbm_scan (&s, end, buffer, &value)
2913 #define expect(TOKEN) \
2914 if (LA1 != (TOKEN)) \
2915 goto failure; \
2916 else \
2917 match ()
2919 #define expect_ident(IDENT) \
2920 if (LA1 == XBM_TK_IDENT && strcmp (buffer, (IDENT)) == 0) \
2921 match (); \
2922 else \
2923 goto failure
2925 *width = *height = -1;
2926 if (data)
2927 *data = NULL;
2928 LA1 = xbm_scan (&s, end, buffer, &value);
2930 /* Parse defines for width, height and hot-spots. */
2931 while (LA1 == '#')
2933 match ();
2934 expect_ident ("define");
2935 expect (XBM_TK_IDENT);
2937 if (LA1 == XBM_TK_NUMBER);
2939 char *p = strrchr (buffer, '_');
2940 p = p ? p + 1 : buffer;
2941 if (strcmp (p, "width") == 0)
2942 *width = value;
2943 else if (strcmp (p, "height") == 0)
2944 *height = value;
2946 expect (XBM_TK_NUMBER);
2949 if (*width < 0 || *height < 0)
2950 goto failure;
2951 else if (data == NULL)
2952 goto success;
2954 /* Parse bits. Must start with `static'. */
2955 expect_ident ("static");
2956 if (LA1 == XBM_TK_IDENT)
2958 if (strcmp (buffer, "unsigned") == 0)
2960 match ();
2961 expect_ident ("char");
2963 else if (strcmp (buffer, "short") == 0)
2965 match ();
2966 v10 = 1;
2967 if (*width % 16 && *width % 16 < 9)
2968 padding_p = 1;
2970 else if (strcmp (buffer, "char") == 0)
2971 match ();
2972 else
2973 goto failure;
2975 else
2976 goto failure;
2978 expect (XBM_TK_IDENT);
2979 expect ('[');
2980 expect (']');
2981 expect ('=');
2982 expect ('{');
2984 bytes_per_line = (*width + 7) / 8 + padding_p;
2985 nbytes = bytes_per_line * *height;
2986 p = *data = (char *) xmalloc (nbytes);
2988 if (v10)
2990 for (i = 0; i < nbytes; i += 2)
2992 int val = value;
2993 expect (XBM_TK_NUMBER);
2995 *p++ = XBM_BIT_SHUFFLE (val);
2996 if (!padding_p || ((i + 2) % bytes_per_line))
2997 *p++ = XBM_BIT_SHUFFLE (value >> 8);
2999 if (LA1 == ',' || LA1 == '}')
3000 match ();
3001 else
3002 goto failure;
3005 else
3007 for (i = 0; i < nbytes; ++i)
3009 int val = value;
3010 expect (XBM_TK_NUMBER);
3012 *p++ = XBM_BIT_SHUFFLE (val);
3014 if (LA1 == ',' || LA1 == '}')
3015 match ();
3016 else
3017 goto failure;
3021 success:
3022 return 1;
3024 failure:
3026 if (data && *data)
3028 xfree (*data);
3029 *data = NULL;
3031 return 0;
3033 #undef match
3034 #undef expect
3035 #undef expect_ident
3039 /* Load XBM image IMG which will be displayed on frame F from buffer
3040 CONTENTS. END is the end of the buffer. Value is non-zero if
3041 successful. */
3043 static int
3044 xbm_load_image (f, img, contents, end)
3045 struct frame *f;
3046 struct image *img;
3047 unsigned char *contents, *end;
3049 int rc;
3050 unsigned char *data;
3051 int success_p = 0;
3053 rc = xbm_read_bitmap_data (contents, end, &img->width, &img->height, &data);
3054 if (rc)
3056 unsigned long foreground = FRAME_FOREGROUND_PIXEL (f);
3057 unsigned long background = FRAME_BACKGROUND_PIXEL (f);
3058 int non_default_colors = 0;
3059 Lisp_Object value;
3061 xassert (img->width > 0 && img->height > 0);
3063 /* Get foreground and background colors, maybe allocate colors. */
3064 value = image_spec_value (img->spec, QCforeground, NULL);
3065 if (!NILP (value))
3067 foreground = x_alloc_image_color (f, img, value, foreground);
3068 non_default_colors = 1;
3070 value = image_spec_value (img->spec, QCbackground, NULL);
3071 if (!NILP (value))
3073 background = x_alloc_image_color (f, img, value, background);
3074 img->background = background;
3075 img->background_valid = 1;
3076 non_default_colors = 1;
3079 Create_Pixmap_From_Bitmap_Data (f, img, data,
3080 foreground, background,
3081 non_default_colors);
3082 xfree (data);
3084 if (img->pixmap == NO_PIXMAP)
3086 x_clear_image (f, img);
3087 image_error ("Unable to create X pixmap for `%s'", img->spec, Qnil);
3089 else
3090 success_p = 1;
3092 else
3093 image_error ("Error loading XBM image `%s'", img->spec, Qnil);
3095 return success_p;
3099 /* Value is non-zero if DATA looks like an in-memory XBM file. */
3101 static int
3102 xbm_file_p (data)
3103 Lisp_Object data;
3105 int w, h;
3106 return (STRINGP (data)
3107 && xbm_read_bitmap_data (SDATA (data),
3108 (SDATA (data)
3109 + SBYTES (data)),
3110 &w, &h, NULL));
3114 /* Fill image IMG which is used on frame F with pixmap data. Value is
3115 non-zero if successful. */
3117 static int
3118 xbm_load (f, img)
3119 struct frame *f;
3120 struct image *img;
3122 int success_p = 0;
3123 Lisp_Object file_name;
3125 xassert (xbm_image_p (img->spec));
3127 /* If IMG->spec specifies a file name, create a non-file spec from it. */
3128 file_name = image_spec_value (img->spec, QCfile, NULL);
3129 if (STRINGP (file_name))
3131 Lisp_Object file;
3132 unsigned char *contents;
3133 int size;
3134 struct gcpro gcpro1;
3136 file = x_find_image_file (file_name);
3137 GCPRO1 (file);
3138 if (!STRINGP (file))
3140 image_error ("Cannot find image file `%s'", file_name, Qnil);
3141 UNGCPRO;
3142 return 0;
3145 contents = slurp_file (SDATA (file), &size);
3146 if (contents == NULL)
3148 image_error ("Error loading XBM image `%s'", img->spec, Qnil);
3149 UNGCPRO;
3150 return 0;
3153 success_p = xbm_load_image (f, img, contents, contents + size);
3154 UNGCPRO;
3156 else
3158 struct image_keyword fmt[XBM_LAST];
3159 Lisp_Object data;
3160 unsigned long foreground = FRAME_FOREGROUND_PIXEL (f);
3161 unsigned long background = FRAME_BACKGROUND_PIXEL (f);
3162 int non_default_colors = 0;
3163 char *bits;
3164 int parsed_p;
3165 int in_memory_file_p = 0;
3167 /* See if data looks like an in-memory XBM file. */
3168 data = image_spec_value (img->spec, QCdata, NULL);
3169 in_memory_file_p = xbm_file_p (data);
3171 /* Parse the image specification. */
3172 bcopy (xbm_format, fmt, sizeof fmt);
3173 parsed_p = parse_image_spec (img->spec, fmt, XBM_LAST, Qxbm);
3174 xassert (parsed_p);
3176 /* Get specified width, and height. */
3177 if (!in_memory_file_p)
3179 img->width = XFASTINT (fmt[XBM_WIDTH].value);
3180 img->height = XFASTINT (fmt[XBM_HEIGHT].value);
3181 xassert (img->width > 0 && img->height > 0);
3184 /* Get foreground and background colors, maybe allocate colors. */
3185 if (fmt[XBM_FOREGROUND].count
3186 && STRINGP (fmt[XBM_FOREGROUND].value))
3188 foreground = x_alloc_image_color (f, img, fmt[XBM_FOREGROUND].value,
3189 foreground);
3190 non_default_colors = 1;
3193 if (fmt[XBM_BACKGROUND].count
3194 && STRINGP (fmt[XBM_BACKGROUND].value))
3196 background = x_alloc_image_color (f, img, fmt[XBM_BACKGROUND].value,
3197 background);
3198 non_default_colors = 1;
3201 if (in_memory_file_p)
3202 success_p = xbm_load_image (f, img, SDATA (data),
3203 (SDATA (data)
3204 + SBYTES (data)));
3205 else
3207 if (VECTORP (data))
3209 int i;
3210 char *p;
3211 int nbytes = (img->width + BITS_PER_CHAR - 1) / BITS_PER_CHAR;
3213 p = bits = (char *) alloca (nbytes * img->height);
3214 for (i = 0; i < img->height; ++i, p += nbytes)
3216 Lisp_Object line = XVECTOR (data)->contents[i];
3217 if (STRINGP (line))
3218 bcopy (SDATA (line), p, nbytes);
3219 else
3220 bcopy (XBOOL_VECTOR (line)->data, p, nbytes);
3223 else if (STRINGP (data))
3224 bits = SDATA (data);
3225 else
3226 bits = XBOOL_VECTOR (data)->data;
3228 /* Create the pixmap. */
3230 Create_Pixmap_From_Bitmap_Data (f, img, bits,
3231 foreground, background,
3232 non_default_colors);
3233 if (img->pixmap)
3234 success_p = 1;
3235 else
3237 image_error ("Unable to create pixmap for XBM image `%s'",
3238 img->spec, Qnil);
3239 x_clear_image (f, img);
3244 return success_p;
3249 /***********************************************************************
3250 XPM images
3251 ***********************************************************************/
3253 #if defined (HAVE_XPM) || defined (MAC_OS)
3255 static int xpm_image_p P_ ((Lisp_Object object));
3256 static int xpm_load P_ ((struct frame *f, struct image *img));
3257 static int xpm_valid_color_symbols_p P_ ((Lisp_Object));
3259 #endif /* HAVE_XPM || MAC_OS */
3261 #ifdef HAVE_XPM
3262 #ifdef HAVE_NTGUI
3263 /* Indicate to xpm.h that we don't have Xlib. */
3264 #define FOR_MSW
3265 /* simx.h in xpm defines XColor and XImage differently than Emacs. */
3266 /* It also defines Display the same way as Emacs, but gcc 3.3 still barfs. */
3267 #define XColor xpm_XColor
3268 #define XImage xpm_XImage
3269 #define Display xpm_Display
3270 #define PIXEL_ALREADY_TYPEDEFED
3271 #include "X11/xpm.h"
3272 #undef FOR_MSW
3273 #undef XColor
3274 #undef XImage
3275 #undef Display
3276 #undef PIXEL_ALREADY_TYPEDEFED
3277 #else
3278 #include "X11/xpm.h"
3279 #endif /* HAVE_NTGUI */
3280 #endif /* HAVE_XPM */
3282 #if defined (HAVE_XPM) || defined (MAC_OS)
3283 /* The symbol `xpm' identifying XPM-format images. */
3285 Lisp_Object Qxpm;
3287 /* Indices of image specification fields in xpm_format, below. */
3289 enum xpm_keyword_index
3291 XPM_TYPE,
3292 XPM_FILE,
3293 XPM_DATA,
3294 XPM_ASCENT,
3295 XPM_MARGIN,
3296 XPM_RELIEF,
3297 XPM_ALGORITHM,
3298 XPM_HEURISTIC_MASK,
3299 XPM_MASK,
3300 XPM_COLOR_SYMBOLS,
3301 XPM_BACKGROUND,
3302 XPM_LAST
3305 /* Vector of image_keyword structures describing the format
3306 of valid XPM image specifications. */
3308 static struct image_keyword xpm_format[XPM_LAST] =
3310 {":type", IMAGE_SYMBOL_VALUE, 1},
3311 {":file", IMAGE_STRING_VALUE, 0},
3312 {":data", IMAGE_STRING_VALUE, 0},
3313 {":ascent", IMAGE_ASCENT_VALUE, 0},
3314 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
3315 {":relief", IMAGE_INTEGER_VALUE, 0},
3316 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
3317 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
3318 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
3319 {":color-symbols", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
3320 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
3323 /* Structure describing the image type XPM. */
3325 static struct image_type xpm_type =
3327 &Qxpm,
3328 xpm_image_p,
3329 xpm_load,
3330 x_clear_image,
3331 NULL
3334 #ifdef HAVE_X_WINDOWS
3336 /* Define ALLOC_XPM_COLORS if we can use Emacs' own color allocation
3337 functions for allocating image colors. Our own functions handle
3338 color allocation failures more gracefully than the ones on the XPM
3339 lib. */
3341 #if defined XpmAllocColor && defined XpmFreeColors && defined XpmColorClosure
3342 #define ALLOC_XPM_COLORS
3343 #endif
3344 #endif /* HAVE_X_WINDOWS */
3346 #ifdef ALLOC_XPM_COLORS
3348 static void xpm_init_color_cache P_ ((struct frame *, XpmAttributes *));
3349 static void xpm_free_color_cache P_ ((void));
3350 static int xpm_lookup_color P_ ((struct frame *, char *, XColor *));
3351 static int xpm_color_bucket P_ ((char *));
3352 static struct xpm_cached_color *xpm_cache_color P_ ((struct frame *, char *,
3353 XColor *, int));
3355 /* An entry in a hash table used to cache color definitions of named
3356 colors. This cache is necessary to speed up XPM image loading in
3357 case we do color allocations ourselves. Without it, we would need
3358 a call to XParseColor per pixel in the image. */
3360 struct xpm_cached_color
3362 /* Next in collision chain. */
3363 struct xpm_cached_color *next;
3365 /* Color definition (RGB and pixel color). */
3366 XColor color;
3368 /* Color name. */
3369 char name[1];
3372 /* The hash table used for the color cache, and its bucket vector
3373 size. */
3375 #define XPM_COLOR_CACHE_BUCKETS 1001
3376 struct xpm_cached_color **xpm_color_cache;
3378 /* Initialize the color cache. */
3380 static void
3381 xpm_init_color_cache (f, attrs)
3382 struct frame *f;
3383 XpmAttributes *attrs;
3385 size_t nbytes = XPM_COLOR_CACHE_BUCKETS * sizeof *xpm_color_cache;
3386 xpm_color_cache = (struct xpm_cached_color **) xmalloc (nbytes);
3387 memset (xpm_color_cache, 0, nbytes);
3388 init_color_table ();
3390 if (attrs->valuemask & XpmColorSymbols)
3392 int i;
3393 XColor color;
3395 for (i = 0; i < attrs->numsymbols; ++i)
3396 if (XParseColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
3397 attrs->colorsymbols[i].value, &color))
3399 color.pixel = lookup_rgb_color (f, color.red, color.green,
3400 color.blue);
3401 xpm_cache_color (f, attrs->colorsymbols[i].name, &color, -1);
3406 /* Free the color cache. */
3408 static void
3409 xpm_free_color_cache ()
3411 struct xpm_cached_color *p, *next;
3412 int i;
3414 for (i = 0; i < XPM_COLOR_CACHE_BUCKETS; ++i)
3415 for (p = xpm_color_cache[i]; p; p = next)
3417 next = p->next;
3418 xfree (p);
3421 xfree (xpm_color_cache);
3422 xpm_color_cache = NULL;
3423 free_color_table ();
3426 /* Return the bucket index for color named COLOR_NAME in the color
3427 cache. */
3429 static int
3430 xpm_color_bucket (color_name)
3431 char *color_name;
3433 unsigned h = 0;
3434 char *s;
3436 for (s = color_name; *s; ++s)
3437 h = (h << 2) ^ *s;
3438 return h %= XPM_COLOR_CACHE_BUCKETS;
3442 /* On frame F, cache values COLOR for color with name COLOR_NAME.
3443 BUCKET, if >= 0, is a precomputed bucket index. Value is the cache
3444 entry added. */
3446 static struct xpm_cached_color *
3447 xpm_cache_color (f, color_name, color, bucket)
3448 struct frame *f;
3449 char *color_name;
3450 XColor *color;
3451 int bucket;
3453 size_t nbytes;
3454 struct xpm_cached_color *p;
3456 if (bucket < 0)
3457 bucket = xpm_color_bucket (color_name);
3459 nbytes = sizeof *p + strlen (color_name);
3460 p = (struct xpm_cached_color *) xmalloc (nbytes);
3461 strcpy (p->name, color_name);
3462 p->color = *color;
3463 p->next = xpm_color_cache[bucket];
3464 xpm_color_cache[bucket] = p;
3465 return p;
3468 /* Look up color COLOR_NAME for frame F in the color cache. If found,
3469 return the cached definition in *COLOR. Otherwise, make a new
3470 entry in the cache and allocate the color. Value is zero if color
3471 allocation failed. */
3473 static int
3474 xpm_lookup_color (f, color_name, color)
3475 struct frame *f;
3476 char *color_name;
3477 XColor *color;
3479 struct xpm_cached_color *p;
3480 int h = xpm_color_bucket (color_name);
3482 for (p = xpm_color_cache[h]; p; p = p->next)
3483 if (strcmp (p->name, color_name) == 0)
3484 break;
3486 if (p != NULL)
3487 *color = p->color;
3488 else if (XParseColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
3489 color_name, color))
3491 color->pixel = lookup_rgb_color (f, color->red, color->green,
3492 color->blue);
3493 p = xpm_cache_color (f, color_name, color, h);
3495 /* You get `opaque' at least from ImageMagick converting pbm to xpm
3496 with transparency, and it's useful. */
3497 else if (strcmp ("opaque", color_name) == 0)
3499 bzero (color, sizeof (XColor)); /* Is this necessary/correct? */
3500 color->pixel = FRAME_FOREGROUND_PIXEL (f);
3501 p = xpm_cache_color (f, color_name, color, h);
3504 return p != NULL;
3508 /* Callback for allocating color COLOR_NAME. Called from the XPM lib.
3509 CLOSURE is a pointer to the frame on which we allocate the
3510 color. Return in *COLOR the allocated color. Value is non-zero
3511 if successful. */
3513 static int
3514 xpm_alloc_color (dpy, cmap, color_name, color, closure)
3515 Display *dpy;
3516 Colormap cmap;
3517 char *color_name;
3518 XColor *color;
3519 void *closure;
3521 return xpm_lookup_color ((struct frame *) closure, color_name, color);
3525 /* Callback for freeing NPIXELS colors contained in PIXELS. CLOSURE
3526 is a pointer to the frame on which we allocate the color. Value is
3527 non-zero if successful. */
3529 static int
3530 xpm_free_colors (dpy, cmap, pixels, npixels, closure)
3531 Display *dpy;
3532 Colormap cmap;
3533 Pixel *pixels;
3534 int npixels;
3535 void *closure;
3537 return 1;
3540 #endif /* ALLOC_XPM_COLORS */
3543 #ifdef HAVE_NTGUI
3545 /* XPM library details. */
3547 DEF_IMGLIB_FN (XpmFreeAttributes);
3548 DEF_IMGLIB_FN (XpmCreateImageFromBuffer);
3549 DEF_IMGLIB_FN (XpmReadFileToImage);
3550 DEF_IMGLIB_FN (XImageFree);
3552 static int
3553 init_xpm_functions (Lisp_Object libraries)
3555 HMODULE library;
3557 if (!(library = w32_delayed_load (libraries, Qxpm)))
3558 return 0;
3560 LOAD_IMGLIB_FN (library, XpmFreeAttributes);
3561 LOAD_IMGLIB_FN (library, XpmCreateImageFromBuffer);
3562 LOAD_IMGLIB_FN (library, XpmReadFileToImage);
3563 LOAD_IMGLIB_FN (library, XImageFree);
3564 return 1;
3567 #endif /* HAVE_NTGUI */
3570 /* Value is non-zero if COLOR_SYMBOLS is a valid color symbols list
3571 for XPM images. Such a list must consist of conses whose car and
3572 cdr are strings. */
3574 static int
3575 xpm_valid_color_symbols_p (color_symbols)
3576 Lisp_Object color_symbols;
3578 while (CONSP (color_symbols))
3580 Lisp_Object sym = XCAR (color_symbols);
3581 if (!CONSP (sym)
3582 || !STRINGP (XCAR (sym))
3583 || !STRINGP (XCDR (sym)))
3584 break;
3585 color_symbols = XCDR (color_symbols);
3588 return NILP (color_symbols);
3592 /* Value is non-zero if OBJECT is a valid XPM image specification. */
3594 static int
3595 xpm_image_p (object)
3596 Lisp_Object object;
3598 struct image_keyword fmt[XPM_LAST];
3599 bcopy (xpm_format, fmt, sizeof fmt);
3600 return (parse_image_spec (object, fmt, XPM_LAST, Qxpm)
3601 /* Either `:file' or `:data' must be present. */
3602 && fmt[XPM_FILE].count + fmt[XPM_DATA].count == 1
3603 /* Either no `:color-symbols' or it's a list of conses
3604 whose car and cdr are strings. */
3605 && (fmt[XPM_COLOR_SYMBOLS].count == 0
3606 || xpm_valid_color_symbols_p (fmt[XPM_COLOR_SYMBOLS].value)));
3609 #endif /* HAVE_XPM || MAC_OS */
3611 /* Load image IMG which will be displayed on frame F. Value is
3612 non-zero if successful. */
3614 #ifdef HAVE_XPM
3616 static int
3617 xpm_load (f, img)
3618 struct frame *f;
3619 struct image *img;
3621 int rc;
3622 XpmAttributes attrs;
3623 Lisp_Object specified_file, color_symbols;
3624 #ifdef HAVE_NTGUI
3625 HDC hdc;
3626 xpm_XImage * xpm_image = NULL, * xpm_mask = NULL;
3627 #endif /* HAVE_NTGUI */
3629 /* Configure the XPM lib. Use the visual of frame F. Allocate
3630 close colors. Return colors allocated. */
3631 bzero (&attrs, sizeof attrs);
3633 #ifndef HAVE_NTGUI
3634 attrs.visual = FRAME_X_VISUAL (f);
3635 attrs.colormap = FRAME_X_COLORMAP (f);
3636 attrs.valuemask |= XpmVisual;
3637 attrs.valuemask |= XpmColormap;
3638 #endif /* HAVE_NTGUI */
3640 #ifdef ALLOC_XPM_COLORS
3641 /* Allocate colors with our own functions which handle
3642 failing color allocation more gracefully. */
3643 attrs.color_closure = f;
3644 attrs.alloc_color = xpm_alloc_color;
3645 attrs.free_colors = xpm_free_colors;
3646 attrs.valuemask |= XpmAllocColor | XpmFreeColors | XpmColorClosure;
3647 #else /* not ALLOC_XPM_COLORS */
3648 /* Let the XPM lib allocate colors. */
3649 attrs.valuemask |= XpmReturnAllocPixels;
3650 #ifdef XpmAllocCloseColors
3651 attrs.alloc_close_colors = 1;
3652 attrs.valuemask |= XpmAllocCloseColors;
3653 #else /* not XpmAllocCloseColors */
3654 attrs.closeness = 600;
3655 attrs.valuemask |= XpmCloseness;
3656 #endif /* not XpmAllocCloseColors */
3657 #endif /* ALLOC_XPM_COLORS */
3659 /* If image specification contains symbolic color definitions, add
3660 these to `attrs'. */
3661 color_symbols = image_spec_value (img->spec, QCcolor_symbols, NULL);
3662 if (CONSP (color_symbols))
3664 Lisp_Object tail;
3665 XpmColorSymbol *xpm_syms;
3666 int i, size;
3668 attrs.valuemask |= XpmColorSymbols;
3670 /* Count number of symbols. */
3671 attrs.numsymbols = 0;
3672 for (tail = color_symbols; CONSP (tail); tail = XCDR (tail))
3673 ++attrs.numsymbols;
3675 /* Allocate an XpmColorSymbol array. */
3676 size = attrs.numsymbols * sizeof *xpm_syms;
3677 xpm_syms = (XpmColorSymbol *) alloca (size);
3678 bzero (xpm_syms, size);
3679 attrs.colorsymbols = xpm_syms;
3681 /* Fill the color symbol array. */
3682 for (tail = color_symbols, i = 0;
3683 CONSP (tail);
3684 ++i, tail = XCDR (tail))
3686 Lisp_Object name = XCAR (XCAR (tail));
3687 Lisp_Object color = XCDR (XCAR (tail));
3688 xpm_syms[i].name = (char *) alloca (SCHARS (name) + 1);
3689 strcpy (xpm_syms[i].name, SDATA (name));
3690 xpm_syms[i].value = (char *) alloca (SCHARS (color) + 1);
3691 strcpy (xpm_syms[i].value, SDATA (color));
3695 /* Create a pixmap for the image, either from a file, or from a
3696 string buffer containing data in the same format as an XPM file. */
3697 #ifdef ALLOC_XPM_COLORS
3698 xpm_init_color_cache (f, &attrs);
3699 #endif
3701 specified_file = image_spec_value (img->spec, QCfile, NULL);
3703 #ifdef HAVE_NTGUI
3705 HDC frame_dc = get_frame_dc (f);
3706 hdc = CreateCompatibleDC (frame_dc);
3707 release_frame_dc (f, frame_dc);
3709 #endif /* HAVE_NTGUI */
3711 if (STRINGP (specified_file))
3713 Lisp_Object file = x_find_image_file (specified_file);
3714 if (!STRINGP (file))
3716 image_error ("Cannot find image file `%s'", specified_file, Qnil);
3717 return 0;
3720 #ifdef HAVE_NTGUI
3721 /* XpmReadFileToPixmap is not available in the Windows port of
3722 libxpm. But XpmReadFileToImage almost does what we want. */
3723 rc = fn_XpmReadFileToImage (&hdc, SDATA (file),
3724 &xpm_image, &xpm_mask,
3725 &attrs);
3726 #else
3727 rc = XpmReadFileToPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3728 SDATA (file), &img->pixmap, &img->mask,
3729 &attrs);
3730 #endif /* HAVE_NTGUI */
3732 else
3734 Lisp_Object buffer = image_spec_value (img->spec, QCdata, NULL);
3735 #ifdef HAVE_NTGUI
3736 /* XpmCreatePixmapFromBuffer is not available in the Windows port
3737 of libxpm. But XpmCreateImageFromBuffer almost does what we want. */
3738 rc = fn_XpmCreateImageFromBuffer (&hdc, SDATA (buffer),
3739 &xpm_image, &xpm_mask,
3740 &attrs);
3741 #else
3742 rc = XpmCreatePixmapFromBuffer (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3743 SDATA (buffer),
3744 &img->pixmap, &img->mask,
3745 &attrs);
3746 #endif /* HAVE_NTGUI */
3749 if (rc == XpmSuccess)
3751 #if defined (COLOR_TABLE_SUPPORT) && defined (ALLOC_XPM_COLORS)
3752 img->colors = colors_in_color_table (&img->ncolors);
3753 #else /* not ALLOC_XPM_COLORS */
3754 int i;
3756 #ifdef HAVE_NTGUI
3757 /* W32 XPM uses XImage to wrap what W32 Emacs calls a Pixmap,
3758 plus some duplicate attributes. */
3759 if (xpm_image && xpm_image->bitmap)
3761 img->pixmap = xpm_image->bitmap;
3762 /* XImageFree in libXpm frees XImage struct without destroying
3763 the bitmap, which is what we want. */
3764 fn_XImageFree (xpm_image);
3766 if (xpm_mask && xpm_mask->bitmap)
3768 /* The mask appears to be inverted compared with what we expect.
3769 TODO: invert our expectations. See other places where we
3770 have to invert bits because our idea of masks is backwards. */
3771 HGDIOBJ old_obj;
3772 old_obj = SelectObject (hdc, xpm_mask->bitmap);
3774 PatBlt (hdc, 0, 0, xpm_mask->width, xpm_mask->height, DSTINVERT);
3775 SelectObject (hdc, old_obj);
3777 img->mask = xpm_mask->bitmap;
3778 fn_XImageFree (xpm_mask);
3779 DeleteDC (hdc);
3782 DeleteDC (hdc);
3783 #endif /* HAVE_NTGUI */
3785 /* Remember allocated colors. */
3786 img->ncolors = attrs.nalloc_pixels;
3787 img->colors = (unsigned long *) xmalloc (img->ncolors
3788 * sizeof *img->colors);
3789 for (i = 0; i < attrs.nalloc_pixels; ++i)
3791 img->colors[i] = attrs.alloc_pixels[i];
3792 #ifdef DEBUG_X_COLORS
3793 register_color (img->colors[i]);
3794 #endif
3796 #endif /* not ALLOC_XPM_COLORS */
3798 img->width = attrs.width;
3799 img->height = attrs.height;
3800 xassert (img->width > 0 && img->height > 0);
3802 /* The call to XpmFreeAttributes below frees attrs.alloc_pixels. */
3803 #ifdef HAVE_NTGUI
3804 fn_XpmFreeAttributes (&attrs);
3805 #else
3806 XpmFreeAttributes (&attrs);
3807 #endif /* HAVE_NTGUI */
3809 else
3811 #ifdef HAVE_NTGUI
3812 DeleteDC (hdc);
3813 #endif /* HAVE_NTGUI */
3815 switch (rc)
3817 case XpmOpenFailed:
3818 image_error ("Error opening XPM file (%s)", img->spec, Qnil);
3819 break;
3821 case XpmFileInvalid:
3822 image_error ("Invalid XPM file (%s)", img->spec, Qnil);
3823 break;
3825 case XpmNoMemory:
3826 image_error ("Out of memory (%s)", img->spec, Qnil);
3827 break;
3829 case XpmColorFailed:
3830 image_error ("Color allocation error (%s)", img->spec, Qnil);
3831 break;
3833 default:
3834 image_error ("Unknown error (%s)", img->spec, Qnil);
3835 break;
3839 #ifdef ALLOC_XPM_COLORS
3840 xpm_free_color_cache ();
3841 #endif
3842 return rc == XpmSuccess;
3845 #endif /* HAVE_XPM */
3847 #ifdef MAC_OS
3849 /* XPM support functions for Mac OS where libxpm is not available.
3850 Only XPM version 3 (without any extensions) is supported. */
3852 static int xpm_scan P_ ((unsigned char **, unsigned char *,
3853 unsigned char **, int *));
3854 static Lisp_Object xpm_make_color_table_v
3855 P_ ((void (**) (Lisp_Object, unsigned char *, int, Lisp_Object),
3856 Lisp_Object (**) (Lisp_Object, unsigned char *, int)));
3857 static void xpm_put_color_table_v P_ ((Lisp_Object, unsigned char *,
3858 int, Lisp_Object));
3859 static Lisp_Object xpm_get_color_table_v P_ ((Lisp_Object,
3860 unsigned char *, int));
3861 static Lisp_Object xpm_make_color_table_h
3862 P_ ((void (**) (Lisp_Object, unsigned char *, int, Lisp_Object),
3863 Lisp_Object (**) (Lisp_Object, unsigned char *, int)));
3864 static void xpm_put_color_table_h P_ ((Lisp_Object, unsigned char *,
3865 int, Lisp_Object));
3866 static Lisp_Object xpm_get_color_table_h P_ ((Lisp_Object,
3867 unsigned char *, int));
3868 static int xpm_str_to_color_key P_ ((char *));
3869 static int xpm_load_image P_ ((struct frame *, struct image *,
3870 unsigned char *, unsigned char *));
3872 /* Tokens returned from xpm_scan. */
3874 enum xpm_token
3876 XPM_TK_IDENT = 256,
3877 XPM_TK_STRING,
3878 XPM_TK_EOF
3881 /* Scan an XPM data and return a character (< 256) or a token defined
3882 by enum xpm_token above. *S and END are the start (inclusive) and
3883 the end (exclusive) addresses of the data, respectively. Advance
3884 *S while scanning. If token is either XPM_TK_IDENT or
3885 XPM_TK_STRING, *BEG and *LEN are set to the start address and the
3886 length of the corresponding token, respectively. */
3888 static int
3889 xpm_scan (s, end, beg, len)
3890 unsigned char **s, *end, **beg;
3891 int *len;
3893 int c;
3895 while (*s < end)
3897 /* Skip white-space. */
3898 while (*s < end && (c = *(*s)++, isspace (c)))
3901 /* gnus-pointer.xpm uses '-' in its identifier.
3902 sb-dir-plus.xpm uses '+' in its identifier. */
3903 if (isalpha (c) || c == '_' || c == '-' || c == '+')
3905 *beg = *s - 1;
3906 while (*s < end &&
3907 (c = **s, isalnum (c) || c == '_' || c == '-' || c == '+'))
3908 ++*s;
3909 *len = *s - *beg;
3910 return XPM_TK_IDENT;
3912 else if (c == '"')
3914 *beg = *s;
3915 while (*s < end && **s != '"')
3916 ++*s;
3917 *len = *s - *beg;
3918 if (*s < end)
3919 ++*s;
3920 return XPM_TK_STRING;
3922 else if (c == '/')
3924 if (*s < end && **s == '*')
3926 /* C-style comment. */
3927 ++*s;
3930 while (*s < end && *(*s)++ != '*')
3933 while (*s < end && **s != '/');
3934 if (*s < end)
3935 ++*s;
3937 else
3938 return c;
3940 else
3941 return c;
3944 return XPM_TK_EOF;
3947 /* Functions for color table lookup in XPM data. A Key is a string
3948 specifying the color of each pixel in XPM data. A value is either
3949 an integer that specifies a pixel color, Qt that specifies
3950 transparency, or Qnil for the unspecified color. If the length of
3951 the key string is one, a vector is used as a table. Otherwise, a
3952 hash table is used. */
3954 static Lisp_Object
3955 xpm_make_color_table_v (put_func, get_func)
3956 void (**put_func) (Lisp_Object, unsigned char *, int, Lisp_Object);
3957 Lisp_Object (**get_func) (Lisp_Object, unsigned char *, int);
3959 *put_func = xpm_put_color_table_v;
3960 *get_func = xpm_get_color_table_v;
3961 return Fmake_vector (make_number (256), Qnil);
3964 static void
3965 xpm_put_color_table_v (color_table, chars_start, chars_len, color)
3966 Lisp_Object color_table;
3967 unsigned char *chars_start;
3968 int chars_len;
3969 Lisp_Object color;
3971 XVECTOR (color_table)->contents[*chars_start] = color;
3974 static Lisp_Object
3975 xpm_get_color_table_v (color_table, chars_start, chars_len)
3976 Lisp_Object color_table;
3977 unsigned char *chars_start;
3978 int chars_len;
3980 return XVECTOR (color_table)->contents[*chars_start];
3983 static Lisp_Object
3984 xpm_make_color_table_h (put_func, get_func)
3985 void (**put_func) (Lisp_Object, unsigned char *, int, Lisp_Object);
3986 Lisp_Object (**get_func) (Lisp_Object, unsigned char *, int);
3988 *put_func = xpm_put_color_table_h;
3989 *get_func = xpm_get_color_table_h;
3990 return make_hash_table (Qequal, make_number (DEFAULT_HASH_SIZE),
3991 make_float (DEFAULT_REHASH_SIZE),
3992 make_float (DEFAULT_REHASH_THRESHOLD),
3993 Qnil, Qnil, Qnil);
3996 static void
3997 xpm_put_color_table_h (color_table, chars_start, chars_len, color)
3998 Lisp_Object color_table;
3999 unsigned char *chars_start;
4000 int chars_len;
4001 Lisp_Object color;
4003 struct Lisp_Hash_Table *table = XHASH_TABLE (color_table);
4004 unsigned hash_code;
4005 Lisp_Object chars = make_unibyte_string (chars_start, chars_len);
4007 hash_lookup (table, chars, &hash_code);
4008 hash_put (table, chars, color, hash_code);
4011 static Lisp_Object
4012 xpm_get_color_table_h (color_table, chars_start, chars_len)
4013 Lisp_Object color_table;
4014 unsigned char *chars_start;
4015 int chars_len;
4017 struct Lisp_Hash_Table *table = XHASH_TABLE (color_table);
4018 int i = hash_lookup (table, make_unibyte_string (chars_start, chars_len),
4019 NULL);
4021 return i >= 0 ? HASH_VALUE (table, i) : Qnil;
4024 enum xpm_color_key {
4025 XPM_COLOR_KEY_S,
4026 XPM_COLOR_KEY_M,
4027 XPM_COLOR_KEY_G4,
4028 XPM_COLOR_KEY_G,
4029 XPM_COLOR_KEY_C
4032 static char xpm_color_key_strings[][4] = {"s", "m", "g4", "g", "c"};
4034 static int
4035 xpm_str_to_color_key (s)
4036 char *s;
4038 int i;
4040 for (i = 0;
4041 i < sizeof xpm_color_key_strings / sizeof xpm_color_key_strings[0];
4042 i++)
4043 if (strcmp (xpm_color_key_strings[i], s) == 0)
4044 return i;
4045 return -1;
4048 static int
4049 xpm_load_image (f, img, contents, end)
4050 struct frame *f;
4051 struct image *img;
4052 unsigned char *contents, *end;
4054 unsigned char *s = contents, *beg, *str;
4055 unsigned char buffer[BUFSIZ];
4056 int width, height, x, y;
4057 int num_colors, chars_per_pixel;
4058 int len, LA1;
4059 void (*put_color_table) (Lisp_Object, unsigned char *, int, Lisp_Object);
4060 Lisp_Object (*get_color_table) (Lisp_Object, unsigned char *, int);
4061 Lisp_Object frame, color_symbols, color_table;
4062 int best_key, have_mask = 0;
4063 XImagePtr ximg = NULL, mask_img = NULL;
4065 #define match() \
4066 LA1 = xpm_scan (&s, end, &beg, &len)
4068 #define expect(TOKEN) \
4069 if (LA1 != (TOKEN)) \
4070 goto failure; \
4071 else \
4072 match ()
4074 #define expect_ident(IDENT) \
4075 if (LA1 == XPM_TK_IDENT \
4076 && strlen ((IDENT)) == len && memcmp ((IDENT), beg, len) == 0) \
4077 match (); \
4078 else \
4079 goto failure
4081 if (!(end - s >= 9 && memcmp (s, "/* XPM */", 9) == 0))
4082 goto failure;
4083 s += 9;
4084 match();
4085 expect_ident ("static");
4086 expect_ident ("char");
4087 expect ('*');
4088 expect (XPM_TK_IDENT);
4089 expect ('[');
4090 expect (']');
4091 expect ('=');
4092 expect ('{');
4093 expect (XPM_TK_STRING);
4094 if (len >= BUFSIZ)
4095 goto failure;
4096 memcpy (buffer, beg, len);
4097 buffer[len] = '\0';
4098 if (sscanf (buffer, "%d %d %d %d", &width, &height,
4099 &num_colors, &chars_per_pixel) != 4
4100 || width <= 0 || height <= 0
4101 || num_colors <= 0 || chars_per_pixel <= 0)
4102 goto failure;
4103 expect (',');
4105 XSETFRAME (frame, f);
4106 if (!NILP (Fxw_display_color_p (frame)))
4107 best_key = XPM_COLOR_KEY_C;
4108 else if (!NILP (Fx_display_grayscale_p (frame)))
4109 best_key = (XFASTINT (Fx_display_planes (frame)) > 2
4110 ? XPM_COLOR_KEY_G : XPM_COLOR_KEY_G4);
4111 else
4112 best_key = XPM_COLOR_KEY_M;
4114 color_symbols = image_spec_value (img->spec, QCcolor_symbols, NULL);
4115 if (chars_per_pixel == 1)
4116 color_table = xpm_make_color_table_v (&put_color_table,
4117 &get_color_table);
4118 else
4119 color_table = xpm_make_color_table_h (&put_color_table,
4120 &get_color_table);
4122 while (num_colors-- > 0)
4124 unsigned char *color, *max_color;
4125 int key, next_key, max_key = 0;
4126 Lisp_Object symbol_color = Qnil, color_val;
4127 XColor cdef;
4129 expect (XPM_TK_STRING);
4130 if (len <= chars_per_pixel || len >= BUFSIZ + chars_per_pixel)
4131 goto failure;
4132 memcpy (buffer, beg + chars_per_pixel, len - chars_per_pixel);
4133 buffer[len - chars_per_pixel] = '\0';
4135 str = strtok (buffer, " \t");
4136 if (str == NULL)
4137 goto failure;
4138 key = xpm_str_to_color_key (str);
4139 if (key < 0)
4140 goto failure;
4143 color = strtok (NULL, " \t");
4144 if (color == NULL)
4145 goto failure;
4147 while (str = strtok (NULL, " \t"))
4149 next_key = xpm_str_to_color_key (str);
4150 if (next_key >= 0)
4151 break;
4152 color[strlen (color)] = ' ';
4155 if (key == XPM_COLOR_KEY_S)
4157 if (NILP (symbol_color))
4158 symbol_color = build_string (color);
4160 else if (max_key < key && key <= best_key)
4162 max_key = key;
4163 max_color = color;
4165 key = next_key;
4167 while (str);
4169 color_val = Qnil;
4170 if (!NILP (color_symbols) && !NILP (symbol_color))
4172 Lisp_Object specified_color = Fassoc (symbol_color, color_symbols);
4174 if (CONSP (specified_color) && STRINGP (XCDR (specified_color)))
4175 if (xstricmp (SDATA (XCDR (specified_color)), "None") == 0)
4176 color_val = Qt;
4177 else if (x_defined_color (f, SDATA (XCDR (specified_color)),
4178 &cdef, 0))
4179 color_val = make_number (cdef.pixel);
4181 if (NILP (color_val) && max_key > 0)
4182 if (xstricmp (max_color, "None") == 0)
4183 color_val = Qt;
4184 else if (x_defined_color (f, max_color, &cdef, 0))
4185 color_val = make_number (cdef.pixel);
4186 if (!NILP (color_val))
4187 (*put_color_table) (color_table, beg, chars_per_pixel, color_val);
4189 expect (',');
4192 if (!x_create_x_image_and_pixmap (f, width, height, 0,
4193 &ximg, &img->pixmap)
4194 || !x_create_x_image_and_pixmap (f, width, height, 1,
4195 &mask_img, &img->mask))
4197 image_error ("Out of memory (%s)", img->spec, Qnil);
4198 goto error;
4201 for (y = 0; y < height; y++)
4203 expect (XPM_TK_STRING);
4204 str = beg;
4205 if (len < width * chars_per_pixel)
4206 goto failure;
4207 for (x = 0; x < width; x++, str += chars_per_pixel)
4209 Lisp_Object color_val =
4210 (*get_color_table) (color_table, str, chars_per_pixel);
4212 XPutPixel (ximg, x, y,
4213 (INTEGERP (color_val) ? XINT (color_val)
4214 : FRAME_FOREGROUND_PIXEL (f)));
4215 XPutPixel (mask_img, x, y,
4216 (!EQ (color_val, Qt) ? PIX_MASK_DRAW (f)
4217 : (have_mask = 1, PIX_MASK_RETAIN (f))));
4219 if (y + 1 < height)
4220 expect (',');
4223 img->width = width;
4224 img->height = height;
4226 x_put_x_image (f, ximg, img->pixmap, width, height);
4227 x_destroy_x_image (ximg);
4228 if (have_mask)
4230 x_put_x_image (f, mask_img, img->mask, width, height);
4231 x_destroy_x_image (mask_img);
4233 else
4235 x_destroy_x_image (mask_img);
4236 Free_Pixmap (FRAME_X_DISPLAY (f), img->mask);
4237 img->mask = NO_PIXMAP;
4240 return 1;
4242 failure:
4243 image_error ("Invalid XPM file (%s)", img->spec, Qnil);
4244 error:
4245 x_destroy_x_image (ximg);
4246 x_destroy_x_image (mask_img);
4247 x_clear_image (f, img);
4248 return 0;
4250 #undef match
4251 #undef expect
4252 #undef expect_ident
4255 static int
4256 xpm_load (f, img)
4257 struct frame *f;
4258 struct image *img;
4260 int success_p = 0;
4261 Lisp_Object file_name;
4263 /* If IMG->spec specifies a file name, create a non-file spec from it. */
4264 file_name = image_spec_value (img->spec, QCfile, NULL);
4265 if (STRINGP (file_name))
4267 Lisp_Object file;
4268 unsigned char *contents;
4269 int size;
4270 struct gcpro gcpro1;
4272 file = x_find_image_file (file_name);
4273 GCPRO1 (file);
4274 if (!STRINGP (file))
4276 image_error ("Cannot find image file `%s'", file_name, Qnil);
4277 UNGCPRO;
4278 return 0;
4281 contents = slurp_file (SDATA (file), &size);
4282 if (contents == NULL)
4284 image_error ("Error loading XPM image `%s'", img->spec, Qnil);
4285 UNGCPRO;
4286 return 0;
4289 success_p = xpm_load_image (f, img, contents, contents + size);
4290 xfree (contents);
4291 UNGCPRO;
4293 else
4295 Lisp_Object data;
4297 data = image_spec_value (img->spec, QCdata, NULL);
4298 success_p = xpm_load_image (f, img, SDATA (data),
4299 SDATA (data) + SBYTES (data));
4302 return success_p;
4305 #endif /* MAC_OS */
4309 /***********************************************************************
4310 Color table
4311 ***********************************************************************/
4313 #ifdef COLOR_TABLE_SUPPORT
4315 /* An entry in the color table mapping an RGB color to a pixel color. */
4317 struct ct_color
4319 int r, g, b;
4320 unsigned long pixel;
4322 /* Next in color table collision list. */
4323 struct ct_color *next;
4326 /* The bucket vector size to use. Must be prime. */
4328 #define CT_SIZE 101
4330 /* Value is a hash of the RGB color given by R, G, and B. */
4332 #define CT_HASH_RGB(R, G, B) (((R) << 16) ^ ((G) << 8) ^ (B))
4334 /* The color hash table. */
4336 struct ct_color **ct_table;
4338 /* Number of entries in the color table. */
4340 int ct_colors_allocated;
4342 /* Initialize the color table. */
4344 static void
4345 init_color_table ()
4347 int size = CT_SIZE * sizeof (*ct_table);
4348 ct_table = (struct ct_color **) xmalloc (size);
4349 bzero (ct_table, size);
4350 ct_colors_allocated = 0;
4354 /* Free memory associated with the color table. */
4356 static void
4357 free_color_table ()
4359 int i;
4360 struct ct_color *p, *next;
4362 for (i = 0; i < CT_SIZE; ++i)
4363 for (p = ct_table[i]; p; p = next)
4365 next = p->next;
4366 xfree (p);
4369 xfree (ct_table);
4370 ct_table = NULL;
4374 /* Value is a pixel color for RGB color R, G, B on frame F. If an
4375 entry for that color already is in the color table, return the
4376 pixel color of that entry. Otherwise, allocate a new color for R,
4377 G, B, and make an entry in the color table. */
4379 static unsigned long
4380 lookup_rgb_color (f, r, g, b)
4381 struct frame *f;
4382 int r, g, b;
4384 unsigned hash = CT_HASH_RGB (r, g, b);
4385 int i = hash % CT_SIZE;
4386 struct ct_color *p;
4387 Display_Info *dpyinfo;
4389 /* Handle TrueColor visuals specially, which improves performance by
4390 two orders of magnitude. Freeing colors on TrueColor visuals is
4391 a nop, and pixel colors specify RGB values directly. See also
4392 the Xlib spec, chapter 3.1. */
4393 dpyinfo = FRAME_X_DISPLAY_INFO (f);
4394 if (dpyinfo->red_bits > 0)
4396 unsigned long pr, pg, pb;
4398 /* Apply gamma-correction like normal color allocation does. */
4399 if (f->gamma)
4401 XColor color;
4402 color.red = r, color.green = g, color.blue = b;
4403 gamma_correct (f, &color);
4404 r = color.red, g = color.green, b = color.blue;
4407 /* Scale down RGB values to the visual's bits per RGB, and shift
4408 them to the right position in the pixel color. Note that the
4409 original RGB values are 16-bit values, as usual in X. */
4410 pr = (r >> (16 - dpyinfo->red_bits)) << dpyinfo->red_offset;
4411 pg = (g >> (16 - dpyinfo->green_bits)) << dpyinfo->green_offset;
4412 pb = (b >> (16 - dpyinfo->blue_bits)) << dpyinfo->blue_offset;
4414 /* Assemble the pixel color. */
4415 return pr | pg | pb;
4418 for (p = ct_table[i]; p; p = p->next)
4419 if (p->r == r && p->g == g && p->b == b)
4420 break;
4422 if (p == NULL)
4425 #ifdef HAVE_X_WINDOWS
4426 XColor color;
4427 Colormap cmap;
4428 int rc;
4430 color.red = r;
4431 color.green = g;
4432 color.blue = b;
4434 cmap = FRAME_X_COLORMAP (f);
4435 rc = x_alloc_nearest_color (f, cmap, &color);
4436 if (rc)
4438 ++ct_colors_allocated;
4439 p = (struct ct_color *) xmalloc (sizeof *p);
4440 p->r = r;
4441 p->g = g;
4442 p->b = b;
4443 p->pixel = color.pixel;
4444 p->next = ct_table[i];
4445 ct_table[i] = p;
4447 else
4448 return FRAME_FOREGROUND_PIXEL (f);
4450 #else
4451 COLORREF color;
4452 #ifdef HAVE_NTGUI
4453 color = PALETTERGB (r, g, b);
4454 #else
4455 color = RGB_TO_ULONG (r, g, b);
4456 #endif /* HAVE_NTGUI */
4457 ++ct_colors_allocated;
4458 p = (struct ct_color *) xmalloc (sizeof *p);
4459 p->r = r;
4460 p->g = g;
4461 p->b = b;
4462 p->pixel = color;
4463 p->next = ct_table[i];
4464 ct_table[i] = p;
4465 #endif /* HAVE_X_WINDOWS */
4469 return p->pixel;
4473 /* Look up pixel color PIXEL which is used on frame F in the color
4474 table. If not already present, allocate it. Value is PIXEL. */
4476 static unsigned long
4477 lookup_pixel_color (f, pixel)
4478 struct frame *f;
4479 unsigned long pixel;
4481 int i = pixel % CT_SIZE;
4482 struct ct_color *p;
4484 for (p = ct_table[i]; p; p = p->next)
4485 if (p->pixel == pixel)
4486 break;
4488 if (p == NULL)
4490 XColor color;
4491 Colormap cmap;
4492 int rc;
4494 #ifdef HAVE_X_WINDOWS
4495 cmap = FRAME_X_COLORMAP (f);
4496 color.pixel = pixel;
4497 x_query_color (f, &color);
4498 rc = x_alloc_nearest_color (f, cmap, &color);
4499 #else
4500 BLOCK_INPUT;
4501 cmap = DefaultColormapOfScreen (FRAME_X_SCREEN (f));
4502 color.pixel = pixel;
4503 XQueryColor (NULL, cmap, &color);
4504 rc = x_alloc_nearest_color (f, cmap, &color);
4505 UNBLOCK_INPUT;
4506 #endif /* HAVE_X_WINDOWS */
4508 if (rc)
4510 ++ct_colors_allocated;
4512 p = (struct ct_color *) xmalloc (sizeof *p);
4513 p->r = color.red;
4514 p->g = color.green;
4515 p->b = color.blue;
4516 p->pixel = pixel;
4517 p->next = ct_table[i];
4518 ct_table[i] = p;
4520 else
4521 return FRAME_FOREGROUND_PIXEL (f);
4523 return p->pixel;
4527 /* Value is a vector of all pixel colors contained in the color table,
4528 allocated via xmalloc. Set *N to the number of colors. */
4530 static unsigned long *
4531 colors_in_color_table (n)
4532 int *n;
4534 int i, j;
4535 struct ct_color *p;
4536 unsigned long *colors;
4538 if (ct_colors_allocated == 0)
4540 *n = 0;
4541 colors = NULL;
4543 else
4545 colors = (unsigned long *) xmalloc (ct_colors_allocated
4546 * sizeof *colors);
4547 *n = ct_colors_allocated;
4549 for (i = j = 0; i < CT_SIZE; ++i)
4550 for (p = ct_table[i]; p; p = p->next)
4551 colors[j++] = p->pixel;
4554 return colors;
4557 #else /* COLOR_TABLE_SUPPORT */
4559 static unsigned long
4560 lookup_rgb_color (f, r, g, b)
4561 struct frame *f;
4562 int r, g, b;
4564 unsigned long pixel;
4566 #ifdef MAC_OS
4567 pixel = RGB_TO_ULONG (r >> 8, g >> 8, b >> 8);
4568 gamma_correct (f, &pixel);
4569 #endif /* MAC_OS */
4571 #ifdef HAVE_NTGUI
4572 pixel = PALETTERGB (r >> 8, g >> 8, b >> 8);
4573 #endif /* HAVE_NTGUI */
4575 return pixel;
4578 static void
4579 init_color_table ()
4582 #endif /* COLOR_TABLE_SUPPORT */
4585 /***********************************************************************
4586 Algorithms
4587 ***********************************************************************/
4589 static XColor *x_to_xcolors P_ ((struct frame *, struct image *, int));
4590 static void x_from_xcolors P_ ((struct frame *, struct image *, XColor *));
4591 static void x_detect_edges P_ ((struct frame *, struct image *, int[9], int));
4593 #ifdef HAVE_NTGUI
4594 static void XPutPixel (XImagePtr , int, int, COLORREF);
4595 #endif /* HAVE_NTGUI */
4597 /* Non-zero means draw a cross on images having `:conversion
4598 disabled'. */
4600 int cross_disabled_images;
4602 /* Edge detection matrices for different edge-detection
4603 strategies. */
4605 static int emboss_matrix[9] = {
4606 /* x - 1 x x + 1 */
4607 2, -1, 0, /* y - 1 */
4608 -1, 0, 1, /* y */
4609 0, 1, -2 /* y + 1 */
4612 static int laplace_matrix[9] = {
4613 /* x - 1 x x + 1 */
4614 1, 0, 0, /* y - 1 */
4615 0, 0, 0, /* y */
4616 0, 0, -1 /* y + 1 */
4619 /* Value is the intensity of the color whose red/green/blue values
4620 are R, G, and B. */
4622 #define COLOR_INTENSITY(R, G, B) ((2 * (R) + 3 * (G) + (B)) / 6)
4625 /* On frame F, return an array of XColor structures describing image
4626 IMG->pixmap. Each XColor structure has its pixel color set. RGB_P
4627 non-zero means also fill the red/green/blue members of the XColor
4628 structures. Value is a pointer to the array of XColors structures,
4629 allocated with xmalloc; it must be freed by the caller. */
4631 static XColor *
4632 x_to_xcolors (f, img, rgb_p)
4633 struct frame *f;
4634 struct image *img;
4635 int rgb_p;
4637 int x, y;
4638 XColor *colors, *p;
4639 XImagePtr_or_DC ximg;
4640 #ifdef HAVE_NTGUI
4641 HDC hdc;
4642 HGDIOBJ prev;
4643 #endif /* HAVE_NTGUI */
4645 colors = (XColor *) xmalloc (img->width * img->height * sizeof *colors);
4647 #ifndef HAVE_NTGUI
4648 /* Get the X image IMG->pixmap. */
4649 ximg = XGetImage (FRAME_X_DISPLAY (f), img->pixmap,
4650 0, 0, img->width, img->height, ~0, ZPixmap);
4651 #else
4652 /* Load the image into a memory device context. */
4653 hdc = get_frame_dc (f);
4654 ximg = CreateCompatibleDC (hdc);
4655 release_frame_dc (f, hdc);
4656 prev = SelectObject (ximg, img->pixmap);
4657 #endif /* HAVE_NTGUI */
4659 /* Fill the `pixel' members of the XColor array. I wished there
4660 were an easy and portable way to circumvent XGetPixel. */
4661 p = colors;
4662 for (y = 0; y < img->height; ++y)
4664 XColor *row = p;
4666 #ifdef HAVE_X_WINDOWS
4667 for (x = 0; x < img->width; ++x, ++p)
4668 p->pixel = XGetPixel (ximg, x, y);
4669 if (rgb_p)
4670 x_query_colors (f, row, img->width);
4672 #else
4674 for (x = 0; x < img->width; ++x, ++p)
4676 /* W32_TODO: palette support needed here? */
4677 p->pixel = GET_PIXEL (ximg, x, y);
4678 if (rgb_p)
4680 #ifdef MAC_OS
4681 p->red = RED16_FROM_ULONG (p->pixel);
4682 p->green = GREEN16_FROM_ULONG (p->pixel);
4683 p->blue = BLUE16_FROM_ULONG (p->pixel);
4684 #endif /* MAC_OS */
4685 #ifdef HAVE_NTGUI
4686 p->red = 256 * GetRValue (p->pixel);
4687 p->green = 256 * GetGValue (p->pixel);
4688 p->blue = 256 * GetBValue (p->pixel);
4689 #endif /* HAVE_NTGUI */
4692 #endif /* HAVE_X_WINDOWS */
4695 Destroy_Image (ximg, prev);
4697 return colors;
4700 #ifdef HAVE_NTGUI
4702 /* Put a pixel of COLOR at position X, Y in XIMG. XIMG must have been
4703 created with CreateDIBSection, with the pointer to the bit values
4704 stored in ximg->data. */
4706 static void XPutPixel (ximg, x, y, color)
4707 XImagePtr ximg;
4708 int x, y;
4709 COLORREF color;
4711 int width = ximg->info.bmiHeader.biWidth;
4712 int height = ximg->info.bmiHeader.biHeight;
4713 unsigned char * pixel;
4715 /* True color images. */
4716 if (ximg->info.bmiHeader.biBitCount == 24)
4718 int rowbytes = width * 3;
4719 /* Ensure scanlines are aligned on 4 byte boundaries. */
4720 if (rowbytes % 4)
4721 rowbytes += 4 - (rowbytes % 4);
4723 pixel = ximg->data + y * rowbytes + x * 3;
4724 /* Windows bitmaps are in BGR order. */
4725 *pixel = GetBValue (color);
4726 *(pixel + 1) = GetGValue (color);
4727 *(pixel + 2) = GetRValue (color);
4729 /* Monochrome images. */
4730 else if (ximg->info.bmiHeader.biBitCount == 1)
4732 int rowbytes = width / 8;
4733 /* Ensure scanlines are aligned on 4 byte boundaries. */
4734 if (rowbytes % 4)
4735 rowbytes += 4 - (rowbytes % 4);
4736 pixel = ximg->data + y * rowbytes + x / 8;
4737 /* Filter out palette info. */
4738 if (color & 0x00ffffff)
4739 *pixel = *pixel | (1 << x % 8);
4740 else
4741 *pixel = *pixel & ~(1 << x % 8);
4743 else
4744 image_error ("XPutPixel: palette image not supported", Qnil, Qnil);
4747 #endif /* HAVE_NTGUI */
4749 /* Create IMG->pixmap from an array COLORS of XColor structures, whose
4750 RGB members are set. F is the frame on which this all happens.
4751 COLORS will be freed; an existing IMG->pixmap will be freed, too. */
4753 static void
4754 x_from_xcolors (f, img, colors)
4755 struct frame *f;
4756 struct image *img;
4757 XColor *colors;
4759 int x, y;
4760 XImagePtr oimg;
4761 Pixmap pixmap;
4762 XColor *p;
4764 init_color_table ();
4766 x_create_x_image_and_pixmap (f, img->width, img->height, 0,
4767 &oimg, &pixmap);
4768 p = colors;
4769 for (y = 0; y < img->height; ++y)
4770 for (x = 0; x < img->width; ++x, ++p)
4772 unsigned long pixel;
4773 pixel = lookup_rgb_color (f, p->red, p->green, p->blue);
4774 XPutPixel (oimg, x, y, pixel);
4777 xfree (colors);
4778 x_clear_image_1 (f, img, 1, 0, 1);
4780 x_put_x_image (f, oimg, pixmap, img->width, img->height);
4781 x_destroy_x_image (oimg);
4782 img->pixmap = pixmap;
4783 #ifdef COLOR_TABLE_SUPPORT
4784 img->colors = colors_in_color_table (&img->ncolors);
4785 free_color_table ();
4786 #endif /* COLOR_TABLE_SUPPORT */
4790 /* On frame F, perform edge-detection on image IMG.
4792 MATRIX is a nine-element array specifying the transformation
4793 matrix. See emboss_matrix for an example.
4795 COLOR_ADJUST is a color adjustment added to each pixel of the
4796 outgoing image. */
4798 static void
4799 x_detect_edges (f, img, matrix, color_adjust)
4800 struct frame *f;
4801 struct image *img;
4802 int matrix[9], color_adjust;
4804 XColor *colors = x_to_xcolors (f, img, 1);
4805 XColor *new, *p;
4806 int x, y, i, sum;
4808 for (i = sum = 0; i < 9; ++i)
4809 sum += abs (matrix[i]);
4811 #define COLOR(A, X, Y) ((A) + (Y) * img->width + (X))
4813 new = (XColor *) xmalloc (img->width * img->height * sizeof *new);
4815 for (y = 0; y < img->height; ++y)
4817 p = COLOR (new, 0, y);
4818 p->red = p->green = p->blue = 0xffff/2;
4819 p = COLOR (new, img->width - 1, y);
4820 p->red = p->green = p->blue = 0xffff/2;
4823 for (x = 1; x < img->width - 1; ++x)
4825 p = COLOR (new, x, 0);
4826 p->red = p->green = p->blue = 0xffff/2;
4827 p = COLOR (new, x, img->height - 1);
4828 p->red = p->green = p->blue = 0xffff/2;
4831 for (y = 1; y < img->height - 1; ++y)
4833 p = COLOR (new, 1, y);
4835 for (x = 1; x < img->width - 1; ++x, ++p)
4837 int r, g, b, y1, x1;
4839 r = g = b = i = 0;
4840 for (y1 = y - 1; y1 < y + 2; ++y1)
4841 for (x1 = x - 1; x1 < x + 2; ++x1, ++i)
4842 if (matrix[i])
4844 XColor *t = COLOR (colors, x1, y1);
4845 r += matrix[i] * t->red;
4846 g += matrix[i] * t->green;
4847 b += matrix[i] * t->blue;
4850 r = (r / sum + color_adjust) & 0xffff;
4851 g = (g / sum + color_adjust) & 0xffff;
4852 b = (b / sum + color_adjust) & 0xffff;
4853 p->red = p->green = p->blue = COLOR_INTENSITY (r, g, b);
4857 xfree (colors);
4858 x_from_xcolors (f, img, new);
4860 #undef COLOR
4864 /* Perform the pre-defined `emboss' edge-detection on image IMG
4865 on frame F. */
4867 static void
4868 x_emboss (f, img)
4869 struct frame *f;
4870 struct image *img;
4872 x_detect_edges (f, img, emboss_matrix, 0xffff / 2);
4876 /* Transform image IMG which is used on frame F with a Laplace
4877 edge-detection algorithm. The result is an image that can be used
4878 to draw disabled buttons, for example. */
4880 static void
4881 x_laplace (f, img)
4882 struct frame *f;
4883 struct image *img;
4885 x_detect_edges (f, img, laplace_matrix, 45000);
4889 /* Perform edge-detection on image IMG on frame F, with specified
4890 transformation matrix MATRIX and color-adjustment COLOR_ADJUST.
4892 MATRIX must be either
4894 - a list of at least 9 numbers in row-major form
4895 - a vector of at least 9 numbers
4897 COLOR_ADJUST nil means use a default; otherwise it must be a
4898 number. */
4900 static void
4901 x_edge_detection (f, img, matrix, color_adjust)
4902 struct frame *f;
4903 struct image *img;
4904 Lisp_Object matrix, color_adjust;
4906 int i = 0;
4907 int trans[9];
4909 if (CONSP (matrix))
4911 for (i = 0;
4912 i < 9 && CONSP (matrix) && NUMBERP (XCAR (matrix));
4913 ++i, matrix = XCDR (matrix))
4914 trans[i] = XFLOATINT (XCAR (matrix));
4916 else if (VECTORP (matrix) && ASIZE (matrix) >= 9)
4918 for (i = 0; i < 9 && NUMBERP (AREF (matrix, i)); ++i)
4919 trans[i] = XFLOATINT (AREF (matrix, i));
4922 if (NILP (color_adjust))
4923 color_adjust = make_number (0xffff / 2);
4925 if (i == 9 && NUMBERP (color_adjust))
4926 x_detect_edges (f, img, trans, (int) XFLOATINT (color_adjust));
4930 /* Transform image IMG on frame F so that it looks disabled. */
4932 static void
4933 x_disable_image (f, img)
4934 struct frame *f;
4935 struct image *img;
4937 Display_Info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
4938 #ifdef HAVE_NTGUI
4939 int n_planes = dpyinfo->n_planes * dpyinfo->n_cbits;
4940 #else
4941 int n_planes = dpyinfo->n_planes;
4942 #endif /* HAVE_NTGUI */
4944 if (n_planes >= 2)
4946 /* Color (or grayscale). Convert to gray, and equalize. Just
4947 drawing such images with a stipple can look very odd, so
4948 we're using this method instead. */
4949 XColor *colors = x_to_xcolors (f, img, 1);
4950 XColor *p, *end;
4951 const int h = 15000;
4952 const int l = 30000;
4954 for (p = colors, end = colors + img->width * img->height;
4955 p < end;
4956 ++p)
4958 int i = COLOR_INTENSITY (p->red, p->green, p->blue);
4959 int i2 = (0xffff - h - l) * i / 0xffff + l;
4960 p->red = p->green = p->blue = i2;
4963 x_from_xcolors (f, img, colors);
4966 /* Draw a cross over the disabled image, if we must or if we
4967 should. */
4968 if (n_planes < 2 || cross_disabled_images)
4970 #ifndef HAVE_NTGUI
4971 Display *dpy = FRAME_X_DISPLAY (f);
4972 GC gc;
4974 #ifdef MAC_OS
4975 #define XCreateGC_pixmap(dpy, pixmap) XCreateGC (dpy, NULL, 0, NULL)
4976 #define MaskForeground(f) PIX_MASK_DRAW (f)
4977 #else
4978 #define XCreateGC_pixmap(dpy, pixmap) XCreateGC (dpy, pixmap, 0, NULL)
4979 #define MaskForeground(f) WHITE_PIX_DEFAULT (f)
4980 #endif
4982 gc = XCreateGC_pixmap (dpy, img->pixmap);
4983 XSetForeground (dpy, gc, BLACK_PIX_DEFAULT (f));
4984 XDrawLine (dpy, img->pixmap, gc, 0, 0,
4985 img->width - 1, img->height - 1);
4986 XDrawLine (dpy, img->pixmap, gc, 0, img->height - 1,
4987 img->width - 1, 0);
4988 XFreeGC (dpy, gc);
4990 if (img->mask)
4992 gc = XCreateGC_pixmap (dpy, img->mask);
4993 XSetForeground (dpy, gc, MaskForeground (f));
4994 XDrawLine (dpy, img->mask, gc, 0, 0,
4995 img->width - 1, img->height - 1);
4996 XDrawLine (dpy, img->mask, gc, 0, img->height - 1,
4997 img->width - 1, 0);
4998 XFreeGC (dpy, gc);
5000 #else
5001 HDC hdc, bmpdc;
5002 HGDIOBJ prev;
5004 hdc = get_frame_dc (f);
5005 bmpdc = CreateCompatibleDC (hdc);
5006 release_frame_dc (f, hdc);
5008 prev = SelectObject (bmpdc, img->pixmap);
5010 SetTextColor (bmpdc, BLACK_PIX_DEFAULT (f));
5011 MoveToEx (bmpdc, 0, 0, NULL);
5012 LineTo (bmpdc, img->width - 1, img->height - 1);
5013 MoveToEx (bmpdc, 0, img->height - 1, NULL);
5014 LineTo (bmpdc, img->width - 1, 0);
5016 if (img->mask)
5018 SelectObject (bmpdc, img->mask);
5019 SetTextColor (bmpdc, WHITE_PIX_DEFAULT (f));
5020 MoveToEx (bmpdc, 0, 0, NULL);
5021 LineTo (bmpdc, img->width - 1, img->height - 1);
5022 MoveToEx (bmpdc, 0, img->height - 1, NULL);
5023 LineTo (bmpdc, img->width - 1, 0);
5025 SelectObject (bmpdc, prev);
5026 DeleteDC (bmpdc);
5027 #endif /* HAVE_NTGUI */
5032 /* Build a mask for image IMG which is used on frame F. FILE is the
5033 name of an image file, for error messages. HOW determines how to
5034 determine the background color of IMG. If it is a list '(R G B)',
5035 with R, G, and B being integers >= 0, take that as the color of the
5036 background. Otherwise, determine the background color of IMG
5037 heuristically. Value is non-zero if successful. */
5039 static int
5040 x_build_heuristic_mask (f, img, how)
5041 struct frame *f;
5042 struct image *img;
5043 Lisp_Object how;
5045 XImagePtr_or_DC ximg;
5046 #ifndef HAVE_NTGUI
5047 XImagePtr mask_img;
5048 #else
5049 HDC frame_dc;
5050 HGDIOBJ prev;
5051 char *mask_img;
5052 int row_width;
5053 #endif /* HAVE_NTGUI */
5054 int x, y, rc, use_img_background;
5055 unsigned long bg = 0;
5057 if (img->mask)
5059 Free_Pixmap (FRAME_X_DISPLAY (f), img->mask);
5060 img->mask = NO_PIXMAP;
5061 img->background_transparent_valid = 0;
5064 #ifndef HAVE_NTGUI
5065 /* Create an image and pixmap serving as mask. */
5066 rc = x_create_x_image_and_pixmap (f, img->width, img->height, 1,
5067 &mask_img, &img->mask);
5068 if (!rc)
5069 return 0;
5071 /* Get the X image of IMG->pixmap. */
5072 ximg = XGetImage (FRAME_X_DISPLAY (f), img->pixmap, 0, 0,
5073 img->width, img->height,
5074 ~0, ZPixmap);
5075 #else
5076 /* Create the bit array serving as mask. */
5077 row_width = (img->width + 7) / 8;
5078 mask_img = xmalloc (row_width * img->height);
5079 bzero (mask_img, row_width * img->height);
5081 /* Create a memory device context for IMG->pixmap. */
5082 frame_dc = get_frame_dc (f);
5083 ximg = CreateCompatibleDC (frame_dc);
5084 release_frame_dc (f, frame_dc);
5085 prev = SelectObject (ximg, img->pixmap);
5086 #endif /* HAVE_NTGUI */
5088 /* Determine the background color of ximg. If HOW is `(R G B)'
5089 take that as color. Otherwise, use the image's background color. */
5090 use_img_background = 1;
5092 if (CONSP (how))
5094 int rgb[3], i;
5096 for (i = 0; i < 3 && CONSP (how) && NATNUMP (XCAR (how)); ++i)
5098 rgb[i] = XFASTINT (XCAR (how)) & 0xffff;
5099 how = XCDR (how);
5102 if (i == 3 && NILP (how))
5104 char color_name[30];
5105 sprintf (color_name, "#%04x%04x%04x", rgb[0], rgb[1], rgb[2]);
5106 bg = (
5107 #ifdef HAVE_NTGUI
5108 0x00ffffff & /* Filter out palette info. */
5109 #endif /* HAVE_NTGUI */
5110 x_alloc_image_color (f, img, build_string (color_name), 0));
5111 use_img_background = 0;
5115 if (use_img_background)
5116 bg = four_corners_best (ximg, img->width, img->height);
5118 /* Set all bits in mask_img to 1 whose color in ximg is different
5119 from the background color bg. */
5120 #ifndef HAVE_NTGUI
5121 for (y = 0; y < img->height; ++y)
5122 for (x = 0; x < img->width; ++x)
5123 XPutPixel (mask_img, x, y, (XGetPixel (ximg, x, y) != bg
5124 ? PIX_MASK_DRAW (f) : PIX_MASK_RETAIN (f)));
5126 /* Fill in the background_transparent field while we have the mask handy. */
5127 image_background_transparent (img, f, mask_img);
5129 /* Put mask_img into img->mask. */
5130 x_put_x_image (f, mask_img, img->mask, img->width, img->height);
5131 x_destroy_x_image (mask_img);
5133 #else
5134 for (y = 0; y < img->height; ++y)
5135 for (x = 0; x < img->width; ++x)
5137 COLORREF p = GetPixel (ximg, x, y);
5138 if (p != bg)
5139 mask_img[y * row_width + x / 8] |= 1 << (x % 8);
5142 /* Create the mask image. */
5143 img->mask = w32_create_pixmap_from_bitmap_data (img->width, img->height,
5144 mask_img);
5145 /* Fill in the background_transparent field while we have the mask handy. */
5146 SelectObject (ximg, img->mask);
5147 image_background_transparent (img, f, ximg);
5149 /* Was: x_destroy_x_image ((XImagePtr )mask_img); which seems bogus ++kfs */
5150 xfree (mask_img);
5151 #endif /* HAVE_NTGUI */
5153 Destroy_Image (ximg, prev);
5155 return 1;
5159 /***********************************************************************
5160 PBM (mono, gray, color)
5161 ***********************************************************************/
5163 static int pbm_image_p P_ ((Lisp_Object object));
5164 static int pbm_load P_ ((struct frame *f, struct image *img));
5165 static int pbm_scan_number P_ ((unsigned char **, unsigned char *));
5167 /* The symbol `pbm' identifying images of this type. */
5169 Lisp_Object Qpbm;
5171 /* Indices of image specification fields in gs_format, below. */
5173 enum pbm_keyword_index
5175 PBM_TYPE,
5176 PBM_FILE,
5177 PBM_DATA,
5178 PBM_ASCENT,
5179 PBM_MARGIN,
5180 PBM_RELIEF,
5181 PBM_ALGORITHM,
5182 PBM_HEURISTIC_MASK,
5183 PBM_MASK,
5184 PBM_FOREGROUND,
5185 PBM_BACKGROUND,
5186 PBM_LAST
5189 /* Vector of image_keyword structures describing the format
5190 of valid user-defined image specifications. */
5192 static struct image_keyword pbm_format[PBM_LAST] =
5194 {":type", IMAGE_SYMBOL_VALUE, 1},
5195 {":file", IMAGE_STRING_VALUE, 0},
5196 {":data", IMAGE_STRING_VALUE, 0},
5197 {":ascent", IMAGE_ASCENT_VALUE, 0},
5198 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
5199 {":relief", IMAGE_INTEGER_VALUE, 0},
5200 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
5201 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
5202 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
5203 {":foreground", IMAGE_STRING_OR_NIL_VALUE, 0},
5204 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
5207 /* Structure describing the image type `pbm'. */
5209 static struct image_type pbm_type =
5211 &Qpbm,
5212 pbm_image_p,
5213 pbm_load,
5214 x_clear_image,
5215 NULL
5219 /* Return non-zero if OBJECT is a valid PBM image specification. */
5221 static int
5222 pbm_image_p (object)
5223 Lisp_Object object;
5225 struct image_keyword fmt[PBM_LAST];
5227 bcopy (pbm_format, fmt, sizeof fmt);
5229 if (!parse_image_spec (object, fmt, PBM_LAST, Qpbm))
5230 return 0;
5232 /* Must specify either :data or :file. */
5233 return fmt[PBM_DATA].count + fmt[PBM_FILE].count == 1;
5237 /* Scan a decimal number from *S and return it. Advance *S while
5238 reading the number. END is the end of the string. Value is -1 at
5239 end of input. */
5241 static int
5242 pbm_scan_number (s, end)
5243 unsigned char **s, *end;
5245 int c = 0, val = -1;
5247 while (*s < end)
5249 /* Skip white-space. */
5250 while (*s < end && (c = *(*s)++, isspace (c)))
5253 if (c == '#')
5255 /* Skip comment to end of line. */
5256 while (*s < end && (c = *(*s)++, c != '\n'))
5259 else if (isdigit (c))
5261 /* Read decimal number. */
5262 val = c - '0';
5263 while (*s < end && (c = *(*s)++, isdigit (c)))
5264 val = 10 * val + c - '0';
5265 break;
5267 else
5268 break;
5271 return val;
5275 #ifdef HAVE_NTGUI
5276 #if 0 /* Unused. ++kfs */
5278 /* Read FILE into memory. Value is a pointer to a buffer allocated
5279 with xmalloc holding FILE's contents. Value is null if an error
5280 occurred. *SIZE is set to the size of the file. */
5282 static char *
5283 pbm_read_file (file, size)
5284 Lisp_Object file;
5285 int *size;
5287 FILE *fp = NULL;
5288 char *buf = NULL;
5289 struct stat st;
5291 if (stat (SDATA (file), &st) == 0
5292 && (fp = fopen (SDATA (file), "rb")) != NULL
5293 && (buf = (char *) xmalloc (st.st_size),
5294 fread (buf, 1, st.st_size, fp) == st.st_size))
5296 *size = st.st_size;
5297 fclose (fp);
5299 else
5301 if (fp)
5302 fclose (fp);
5303 if (buf)
5305 xfree (buf);
5306 buf = NULL;
5310 return buf;
5312 #endif
5313 #endif /* HAVE_NTGUI */
5315 /* Load PBM image IMG for use on frame F. */
5317 static int
5318 pbm_load (f, img)
5319 struct frame *f;
5320 struct image *img;
5322 int raw_p, x, y;
5323 int width, height, max_color_idx = 0;
5324 XImagePtr ximg;
5325 Lisp_Object file, specified_file;
5326 enum {PBM_MONO, PBM_GRAY, PBM_COLOR} type;
5327 struct gcpro gcpro1;
5328 unsigned char *contents = NULL;
5329 unsigned char *end, *p;
5330 int size;
5332 specified_file = image_spec_value (img->spec, QCfile, NULL);
5333 file = Qnil;
5334 GCPRO1 (file);
5336 if (STRINGP (specified_file))
5338 file = x_find_image_file (specified_file);
5339 if (!STRINGP (file))
5341 image_error ("Cannot find image file `%s'", specified_file, Qnil);
5342 UNGCPRO;
5343 return 0;
5346 contents = slurp_file (SDATA (file), &size);
5347 if (contents == NULL)
5349 image_error ("Error reading `%s'", file, Qnil);
5350 UNGCPRO;
5351 return 0;
5354 p = contents;
5355 end = contents + size;
5357 else
5359 Lisp_Object data;
5360 data = image_spec_value (img->spec, QCdata, NULL);
5361 p = SDATA (data);
5362 end = p + SBYTES (data);
5365 /* Check magic number. */
5366 if (end - p < 2 || *p++ != 'P')
5368 image_error ("Not a PBM image: `%s'", img->spec, Qnil);
5369 error:
5370 xfree (contents);
5371 UNGCPRO;
5372 return 0;
5375 switch (*p++)
5377 case '1':
5378 raw_p = 0, type = PBM_MONO;
5379 break;
5381 case '2':
5382 raw_p = 0, type = PBM_GRAY;
5383 break;
5385 case '3':
5386 raw_p = 0, type = PBM_COLOR;
5387 break;
5389 case '4':
5390 raw_p = 1, type = PBM_MONO;
5391 break;
5393 case '5':
5394 raw_p = 1, type = PBM_GRAY;
5395 break;
5397 case '6':
5398 raw_p = 1, type = PBM_COLOR;
5399 break;
5401 default:
5402 image_error ("Not a PBM image: `%s'", img->spec, Qnil);
5403 goto error;
5406 /* Read width, height, maximum color-component. Characters
5407 starting with `#' up to the end of a line are ignored. */
5408 width = pbm_scan_number (&p, end);
5409 height = pbm_scan_number (&p, end);
5411 if (type != PBM_MONO)
5413 max_color_idx = pbm_scan_number (&p, end);
5414 if (raw_p && max_color_idx > 255)
5415 max_color_idx = 255;
5418 if (width < 0
5419 || height < 0
5420 || (type != PBM_MONO && max_color_idx < 0))
5421 goto error;
5423 if (!x_create_x_image_and_pixmap (f, width, height, 0,
5424 &ximg, &img->pixmap))
5425 goto error;
5427 /* Initialize the color hash table. */
5428 init_color_table ();
5430 if (type == PBM_MONO)
5432 int c = 0, g;
5433 struct image_keyword fmt[PBM_LAST];
5434 unsigned long fg = FRAME_FOREGROUND_PIXEL (f);
5435 unsigned long bg = FRAME_BACKGROUND_PIXEL (f);
5437 /* Parse the image specification. */
5438 bcopy (pbm_format, fmt, sizeof fmt);
5439 parse_image_spec (img->spec, fmt, PBM_LAST, Qpbm);
5441 /* Get foreground and background colors, maybe allocate colors. */
5442 if (fmt[PBM_FOREGROUND].count
5443 && STRINGP (fmt[PBM_FOREGROUND].value))
5444 fg = x_alloc_image_color (f, img, fmt[PBM_FOREGROUND].value, fg);
5445 if (fmt[PBM_BACKGROUND].count
5446 && STRINGP (fmt[PBM_BACKGROUND].value))
5448 bg = x_alloc_image_color (f, img, fmt[PBM_BACKGROUND].value, bg);
5449 img->background = bg;
5450 img->background_valid = 1;
5453 for (y = 0; y < height; ++y)
5454 for (x = 0; x < width; ++x)
5456 if (raw_p)
5458 if ((x & 7) == 0)
5459 c = *p++;
5460 g = c & 0x80;
5461 c <<= 1;
5463 else
5464 g = pbm_scan_number (&p, end);
5466 XPutPixel (ximg, x, y, g ? fg : bg);
5469 else
5471 for (y = 0; y < height; ++y)
5472 for (x = 0; x < width; ++x)
5474 int r, g, b;
5476 if (type == PBM_GRAY)
5477 r = g = b = raw_p ? *p++ : pbm_scan_number (&p, end);
5478 else if (raw_p)
5480 r = *p++;
5481 g = *p++;
5482 b = *p++;
5484 else
5486 r = pbm_scan_number (&p, end);
5487 g = pbm_scan_number (&p, end);
5488 b = pbm_scan_number (&p, end);
5491 if (r < 0 || g < 0 || b < 0)
5493 x_destroy_x_image (ximg);
5494 image_error ("Invalid pixel value in image `%s'",
5495 img->spec, Qnil);
5496 goto error;
5499 /* RGB values are now in the range 0..max_color_idx.
5500 Scale this to the range 0..0xffff supported by X. */
5501 r = (double) r * 65535 / max_color_idx;
5502 g = (double) g * 65535 / max_color_idx;
5503 b = (double) b * 65535 / max_color_idx;
5504 XPutPixel (ximg, x, y, lookup_rgb_color (f, r, g, b));
5508 #ifdef COLOR_TABLE_SUPPORT
5509 /* Store in IMG->colors the colors allocated for the image, and
5510 free the color table. */
5511 img->colors = colors_in_color_table (&img->ncolors);
5512 free_color_table ();
5513 #endif /* COLOR_TABLE_SUPPORT */
5515 img->width = width;
5516 img->height = height;
5518 /* Maybe fill in the background field while we have ximg handy. */
5520 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
5521 IMAGE_BACKGROUND (img, f, ximg);
5523 /* Put the image into a pixmap. */
5524 x_put_x_image (f, ximg, img->pixmap, width, height);
5525 x_destroy_x_image (ximg);
5527 /* X and W32 versions did it here, MAC version above. ++kfs
5528 img->width = width;
5529 img->height = height; */
5531 UNGCPRO;
5532 xfree (contents);
5533 return 1;
5537 /***********************************************************************
5539 ***********************************************************************/
5541 #if defined (HAVE_PNG) || defined (MAC_OS)
5543 /* Function prototypes. */
5545 static int png_image_p P_ ((Lisp_Object object));
5546 static int png_load P_ ((struct frame *f, struct image *img));
5548 /* The symbol `png' identifying images of this type. */
5550 Lisp_Object Qpng;
5552 /* Indices of image specification fields in png_format, below. */
5554 enum png_keyword_index
5556 PNG_TYPE,
5557 PNG_DATA,
5558 PNG_FILE,
5559 PNG_ASCENT,
5560 PNG_MARGIN,
5561 PNG_RELIEF,
5562 PNG_ALGORITHM,
5563 PNG_HEURISTIC_MASK,
5564 PNG_MASK,
5565 PNG_BACKGROUND,
5566 PNG_LAST
5569 /* Vector of image_keyword structures describing the format
5570 of valid user-defined image specifications. */
5572 static struct image_keyword png_format[PNG_LAST] =
5574 {":type", IMAGE_SYMBOL_VALUE, 1},
5575 {":data", IMAGE_STRING_VALUE, 0},
5576 {":file", IMAGE_STRING_VALUE, 0},
5577 {":ascent", IMAGE_ASCENT_VALUE, 0},
5578 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
5579 {":relief", IMAGE_INTEGER_VALUE, 0},
5580 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
5581 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
5582 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
5583 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
5586 /* Structure describing the image type `png'. */
5588 static struct image_type png_type =
5590 &Qpng,
5591 png_image_p,
5592 png_load,
5593 x_clear_image,
5594 NULL
5597 /* Return non-zero if OBJECT is a valid PNG image specification. */
5599 static int
5600 png_image_p (object)
5601 Lisp_Object object;
5603 struct image_keyword fmt[PNG_LAST];
5604 bcopy (png_format, fmt, sizeof fmt);
5606 if (!parse_image_spec (object, fmt, PNG_LAST, Qpng))
5607 return 0;
5609 /* Must specify either the :data or :file keyword. */
5610 return fmt[PNG_FILE].count + fmt[PNG_DATA].count == 1;
5613 #endif /* HAVE_PNG || MAC_OS */
5616 #ifdef HAVE_PNG
5618 #if defined HAVE_LIBPNG_PNG_H
5619 # include <libpng/png.h>
5620 #else
5621 # include <png.h>
5622 #endif
5624 #ifdef HAVE_NTGUI
5625 /* PNG library details. */
5627 DEF_IMGLIB_FN (png_get_io_ptr);
5628 DEF_IMGLIB_FN (png_check_sig);
5629 DEF_IMGLIB_FN (png_create_read_struct);
5630 DEF_IMGLIB_FN (png_create_info_struct);
5631 DEF_IMGLIB_FN (png_destroy_read_struct);
5632 DEF_IMGLIB_FN (png_set_read_fn);
5633 DEF_IMGLIB_FN (png_init_io);
5634 DEF_IMGLIB_FN (png_set_sig_bytes);
5635 DEF_IMGLIB_FN (png_read_info);
5636 DEF_IMGLIB_FN (png_get_IHDR);
5637 DEF_IMGLIB_FN (png_get_valid);
5638 DEF_IMGLIB_FN (png_set_strip_16);
5639 DEF_IMGLIB_FN (png_set_expand);
5640 DEF_IMGLIB_FN (png_set_gray_to_rgb);
5641 DEF_IMGLIB_FN (png_set_background);
5642 DEF_IMGLIB_FN (png_get_bKGD);
5643 DEF_IMGLIB_FN (png_read_update_info);
5644 DEF_IMGLIB_FN (png_get_channels);
5645 DEF_IMGLIB_FN (png_get_rowbytes);
5646 DEF_IMGLIB_FN (png_read_image);
5647 DEF_IMGLIB_FN (png_read_end);
5648 DEF_IMGLIB_FN (png_error);
5650 static int
5651 init_png_functions (Lisp_Object libraries)
5653 HMODULE library;
5655 /* Try loading libpng under probable names. */
5656 if (!(library = w32_delayed_load (libraries, Qpng)))
5657 return 0;
5659 LOAD_IMGLIB_FN (library, png_get_io_ptr);
5660 LOAD_IMGLIB_FN (library, png_check_sig);
5661 LOAD_IMGLIB_FN (library, png_create_read_struct);
5662 LOAD_IMGLIB_FN (library, png_create_info_struct);
5663 LOAD_IMGLIB_FN (library, png_destroy_read_struct);
5664 LOAD_IMGLIB_FN (library, png_set_read_fn);
5665 LOAD_IMGLIB_FN (library, png_init_io);
5666 LOAD_IMGLIB_FN (library, png_set_sig_bytes);
5667 LOAD_IMGLIB_FN (library, png_read_info);
5668 LOAD_IMGLIB_FN (library, png_get_IHDR);
5669 LOAD_IMGLIB_FN (library, png_get_valid);
5670 LOAD_IMGLIB_FN (library, png_set_strip_16);
5671 LOAD_IMGLIB_FN (library, png_set_expand);
5672 LOAD_IMGLIB_FN (library, png_set_gray_to_rgb);
5673 LOAD_IMGLIB_FN (library, png_set_background);
5674 LOAD_IMGLIB_FN (library, png_get_bKGD);
5675 LOAD_IMGLIB_FN (library, png_read_update_info);
5676 LOAD_IMGLIB_FN (library, png_get_channels);
5677 LOAD_IMGLIB_FN (library, png_get_rowbytes);
5678 LOAD_IMGLIB_FN (library, png_read_image);
5679 LOAD_IMGLIB_FN (library, png_read_end);
5680 LOAD_IMGLIB_FN (library, png_error);
5681 return 1;
5683 #else
5685 #define fn_png_get_io_ptr png_get_io_ptr
5686 #define fn_png_check_sig png_check_sig
5687 #define fn_png_create_read_struct png_create_read_struct
5688 #define fn_png_create_info_struct png_create_info_struct
5689 #define fn_png_destroy_read_struct png_destroy_read_struct
5690 #define fn_png_set_read_fn png_set_read_fn
5691 #define fn_png_init_io png_init_io
5692 #define fn_png_set_sig_bytes png_set_sig_bytes
5693 #define fn_png_read_info png_read_info
5694 #define fn_png_get_IHDR png_get_IHDR
5695 #define fn_png_get_valid png_get_valid
5696 #define fn_png_set_strip_16 png_set_strip_16
5697 #define fn_png_set_expand png_set_expand
5698 #define fn_png_set_gray_to_rgb png_set_gray_to_rgb
5699 #define fn_png_set_background png_set_background
5700 #define fn_png_get_bKGD png_get_bKGD
5701 #define fn_png_read_update_info png_read_update_info
5702 #define fn_png_get_channels png_get_channels
5703 #define fn_png_get_rowbytes png_get_rowbytes
5704 #define fn_png_read_image png_read_image
5705 #define fn_png_read_end png_read_end
5706 #define fn_png_error png_error
5708 #endif /* HAVE_NTGUI */
5710 /* Error and warning handlers installed when the PNG library
5711 is initialized. */
5713 static void
5714 my_png_error (png_ptr, msg)
5715 png_struct *png_ptr;
5716 char *msg;
5718 xassert (png_ptr != NULL);
5719 image_error ("PNG error: %s", build_string (msg), Qnil);
5720 longjmp (png_ptr->jmpbuf, 1);
5724 static void
5725 my_png_warning (png_ptr, msg)
5726 png_struct *png_ptr;
5727 char *msg;
5729 xassert (png_ptr != NULL);
5730 image_error ("PNG warning: %s", build_string (msg), Qnil);
5733 /* Memory source for PNG decoding. */
5735 struct png_memory_storage
5737 unsigned char *bytes; /* The data */
5738 size_t len; /* How big is it? */
5739 int index; /* Where are we? */
5743 /* Function set as reader function when reading PNG image from memory.
5744 PNG_PTR is a pointer to the PNG control structure. Copy LENGTH
5745 bytes from the input to DATA. */
5747 #ifdef _MSC_VER
5748 /* Work around a problem with MinGW builds of graphics libraries
5749 not honoring calling conventions. */
5750 #pragma optimize("g", off)
5751 #endif
5753 static void
5754 png_read_from_memory (png_ptr, data, length)
5755 png_structp png_ptr;
5756 png_bytep data;
5757 png_size_t length;
5759 struct png_memory_storage *tbr
5760 = (struct png_memory_storage *) fn_png_get_io_ptr (png_ptr);
5762 if (length > tbr->len - tbr->index)
5763 fn_png_error (png_ptr, "Read error");
5765 bcopy (tbr->bytes + tbr->index, data, length);
5766 tbr->index = tbr->index + length;
5769 #ifdef _MSC_VER
5770 /* Restore normal optimization, as specified on the command line. */
5771 #pragma optimize("", on)
5772 #endif
5774 /* Load PNG image IMG for use on frame F. Value is non-zero if
5775 successful. */
5777 static int
5778 png_load (f, img)
5779 struct frame *f;
5780 struct image *img;
5782 Lisp_Object file, specified_file;
5783 Lisp_Object specified_data;
5784 int x, y, i;
5785 XImagePtr ximg, mask_img = NULL;
5786 struct gcpro gcpro1;
5787 png_struct *png_ptr = NULL;
5788 png_info *info_ptr = NULL, *end_info = NULL;
5789 FILE *volatile fp = NULL;
5790 png_byte sig[8];
5791 png_byte * volatile pixels = NULL;
5792 png_byte ** volatile rows = NULL;
5793 png_uint_32 width, height;
5794 int bit_depth, color_type, interlace_type;
5795 png_byte channels;
5796 png_uint_32 row_bytes;
5797 int transparent_p;
5798 double screen_gamma;
5799 struct png_memory_storage tbr; /* Data to be read */
5801 /* Find out what file to load. */
5802 specified_file = image_spec_value (img->spec, QCfile, NULL);
5803 specified_data = image_spec_value (img->spec, QCdata, NULL);
5804 file = Qnil;
5805 GCPRO1 (file);
5807 if (NILP (specified_data))
5809 file = x_find_image_file (specified_file);
5810 if (!STRINGP (file))
5812 image_error ("Cannot find image file `%s'", specified_file, Qnil);
5813 UNGCPRO;
5814 return 0;
5817 /* Open the image file. */
5818 fp = fopen (SDATA (file), "rb");
5819 if (!fp)
5821 image_error ("Cannot open image file `%s'", file, Qnil);
5822 UNGCPRO;
5823 fclose (fp);
5824 return 0;
5827 /* Check PNG signature. */
5828 if (fread (sig, 1, sizeof sig, fp) != sizeof sig
5829 || !fn_png_check_sig (sig, sizeof sig))
5831 image_error ("Not a PNG file: `%s'", file, Qnil);
5832 UNGCPRO;
5833 fclose (fp);
5834 return 0;
5837 else
5839 /* Read from memory. */
5840 tbr.bytes = SDATA (specified_data);
5841 tbr.len = SBYTES (specified_data);
5842 tbr.index = 0;
5844 /* Check PNG signature. */
5845 if (tbr.len < sizeof sig
5846 || !fn_png_check_sig (tbr.bytes, sizeof sig))
5848 image_error ("Not a PNG image: `%s'", img->spec, Qnil);
5849 UNGCPRO;
5850 return 0;
5853 /* Need to skip past the signature. */
5854 tbr.bytes += sizeof (sig);
5857 /* Initialize read and info structs for PNG lib. */
5858 png_ptr = fn_png_create_read_struct (PNG_LIBPNG_VER_STRING, NULL,
5859 my_png_error, my_png_warning);
5860 if (!png_ptr)
5862 if (fp) fclose (fp);
5863 UNGCPRO;
5864 return 0;
5867 info_ptr = fn_png_create_info_struct (png_ptr);
5868 if (!info_ptr)
5870 fn_png_destroy_read_struct (&png_ptr, NULL, NULL);
5871 if (fp) fclose (fp);
5872 UNGCPRO;
5873 return 0;
5876 end_info = fn_png_create_info_struct (png_ptr);
5877 if (!end_info)
5879 fn_png_destroy_read_struct (&png_ptr, &info_ptr, NULL);
5880 if (fp) fclose (fp);
5881 UNGCPRO;
5882 return 0;
5885 /* Set error jump-back. We come back here when the PNG library
5886 detects an error. */
5887 if (setjmp (png_ptr->jmpbuf))
5889 error:
5890 if (png_ptr)
5891 fn_png_destroy_read_struct (&png_ptr, &info_ptr, &end_info);
5892 xfree (pixels);
5893 xfree (rows);
5894 if (fp) fclose (fp);
5895 UNGCPRO;
5896 return 0;
5899 /* Read image info. */
5900 if (!NILP (specified_data))
5901 fn_png_set_read_fn (png_ptr, (void *) &tbr, png_read_from_memory);
5902 else
5903 fn_png_init_io (png_ptr, fp);
5905 fn_png_set_sig_bytes (png_ptr, sizeof sig);
5906 fn_png_read_info (png_ptr, info_ptr);
5907 fn_png_get_IHDR (png_ptr, info_ptr, &width, &height, &bit_depth, &color_type,
5908 &interlace_type, NULL, NULL);
5910 /* If image contains simply transparency data, we prefer to
5911 construct a clipping mask. */
5912 if (fn_png_get_valid (png_ptr, info_ptr, PNG_INFO_tRNS))
5913 transparent_p = 1;
5914 else
5915 transparent_p = 0;
5917 /* This function is easier to write if we only have to handle
5918 one data format: RGB or RGBA with 8 bits per channel. Let's
5919 transform other formats into that format. */
5921 /* Strip more than 8 bits per channel. */
5922 if (bit_depth == 16)
5923 fn_png_set_strip_16 (png_ptr);
5925 /* Expand data to 24 bit RGB, or 8 bit grayscale, with alpha channel
5926 if available. */
5927 fn_png_set_expand (png_ptr);
5929 /* Convert grayscale images to RGB. */
5930 if (color_type == PNG_COLOR_TYPE_GRAY
5931 || color_type == PNG_COLOR_TYPE_GRAY_ALPHA)
5932 fn_png_set_gray_to_rgb (png_ptr);
5934 screen_gamma = (f->gamma ? 1 / f->gamma / 0.45455 : 2.2);
5936 #if 0 /* Avoid double gamma correction for PNG images. */
5937 { /* Tell the PNG lib to handle gamma correction for us. */
5938 int intent;
5939 double image_gamma;
5940 #if defined(PNG_READ_sRGB_SUPPORTED) || defined(PNG_WRITE_sRGB_SUPPORTED)
5941 if (png_get_sRGB (png_ptr, info_ptr, &intent))
5942 /* The libpng documentation says this is right in this case. */
5943 png_set_gamma (png_ptr, screen_gamma, 0.45455);
5944 else
5945 #endif
5946 if (png_get_gAMA (png_ptr, info_ptr, &image_gamma))
5947 /* Image contains gamma information. */
5948 png_set_gamma (png_ptr, screen_gamma, image_gamma);
5949 else
5950 /* Use the standard default for the image gamma. */
5951 png_set_gamma (png_ptr, screen_gamma, 0.45455);
5953 #endif /* if 0 */
5955 /* Handle alpha channel by combining the image with a background
5956 color. Do this only if a real alpha channel is supplied. For
5957 simple transparency, we prefer a clipping mask. */
5958 if (!transparent_p)
5960 png_color_16 *image_bg;
5961 Lisp_Object specified_bg
5962 = image_spec_value (img->spec, QCbackground, NULL);
5964 if (STRINGP (specified_bg))
5965 /* The user specified `:background', use that. */
5967 /* W32 version incorrectly used COLORREF here!! ++kfs */
5968 XColor color;
5969 if (x_defined_color (f, SDATA (specified_bg), &color, 0))
5971 png_color_16 user_bg;
5973 bzero (&user_bg, sizeof user_bg);
5974 user_bg.red = color.red >> 8;
5975 user_bg.green = color.green >> 8;
5976 user_bg.blue = color.blue >> 8;
5978 fn_png_set_background (png_ptr, &user_bg,
5979 PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
5982 else if (fn_png_get_bKGD (png_ptr, info_ptr, &image_bg))
5983 /* Image contains a background color with which to
5984 combine the image. */
5985 fn_png_set_background (png_ptr, image_bg,
5986 PNG_BACKGROUND_GAMMA_FILE, 1, 1.0);
5987 else
5989 /* Image does not contain a background color with which
5990 to combine the image data via an alpha channel. Use
5991 the frame's background instead. */
5992 #ifdef HAVE_X_WINDOWS
5993 XColor color;
5994 png_color_16 frame_background;
5996 color.pixel = FRAME_BACKGROUND_PIXEL (f);
5997 x_query_color (f, &color);
5999 bzero (&frame_background, sizeof frame_background);
6000 frame_background.red = color.red >> 8;
6001 frame_background.green = color.green >> 8;
6002 frame_background.blue = color.blue >> 8;
6003 #endif /* HAVE_X_WINDOWS */
6005 #ifdef HAVE_NTGUI
6006 COLORREF color;
6007 png_color_16 frame_background;
6008 color = FRAME_BACKGROUND_PIXEL (f);
6009 #if 0 /* W32 TODO : Colormap support. */
6010 x_query_color (f, &color);
6011 #endif
6012 bzero (&frame_background, sizeof frame_background);
6013 frame_background.red = GetRValue (color);
6014 frame_background.green = GetGValue (color);
6015 frame_background.blue = GetBValue (color);
6016 #endif /* HAVE_NTGUI */
6018 #ifdef MAC_OS
6019 unsigned long color;
6020 png_color_16 frame_background;
6021 color = FRAME_BACKGROUND_PIXEL (f);
6022 #if 0 /* MAC/W32 TODO : Colormap support. */
6023 x_query_color (f, &color);
6024 #endif
6025 bzero (&frame_background, sizeof frame_background);
6026 frame_background.red = RED_FROM_ULONG (color);
6027 frame_background.green = GREEN_FROM_ULONG (color);
6028 frame_background.blue = BLUE_FROM_ULONG (color);
6029 #endif /* MAC_OS */
6031 fn_png_set_background (png_ptr, &frame_background,
6032 PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
6036 /* Update info structure. */
6037 fn_png_read_update_info (png_ptr, info_ptr);
6039 /* Get number of channels. Valid values are 1 for grayscale images
6040 and images with a palette, 2 for grayscale images with transparency
6041 information (alpha channel), 3 for RGB images, and 4 for RGB
6042 images with alpha channel, i.e. RGBA. If conversions above were
6043 sufficient we should only have 3 or 4 channels here. */
6044 channels = fn_png_get_channels (png_ptr, info_ptr);
6045 xassert (channels == 3 || channels == 4);
6047 /* Number of bytes needed for one row of the image. */
6048 row_bytes = fn_png_get_rowbytes (png_ptr, info_ptr);
6050 /* Allocate memory for the image. */
6051 pixels = (png_byte *) xmalloc (row_bytes * height * sizeof *pixels);
6052 rows = (png_byte **) xmalloc (height * sizeof *rows);
6053 for (i = 0; i < height; ++i)
6054 rows[i] = pixels + i * row_bytes;
6056 /* Read the entire image. */
6057 fn_png_read_image (png_ptr, rows);
6058 fn_png_read_end (png_ptr, info_ptr);
6059 if (fp)
6061 fclose (fp);
6062 fp = NULL;
6065 /* Create the X image and pixmap. */
6066 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg,
6067 &img->pixmap))
6068 goto error;
6070 /* Create an image and pixmap serving as mask if the PNG image
6071 contains an alpha channel. */
6072 if (channels == 4
6073 && !transparent_p
6074 && !x_create_x_image_and_pixmap (f, width, height, 1,
6075 &mask_img, &img->mask))
6077 x_destroy_x_image (ximg);
6078 Free_Pixmap (FRAME_X_DISPLAY (f), img->pixmap);
6079 img->pixmap = NO_PIXMAP;
6080 goto error;
6083 /* Fill the X image and mask from PNG data. */
6084 init_color_table ();
6086 for (y = 0; y < height; ++y)
6088 png_byte *p = rows[y];
6090 for (x = 0; x < width; ++x)
6092 unsigned r, g, b;
6094 r = *p++ << 8;
6095 g = *p++ << 8;
6096 b = *p++ << 8;
6097 XPutPixel (ximg, x, y, lookup_rgb_color (f, r, g, b));
6098 /* An alpha channel, aka mask channel, associates variable
6099 transparency with an image. Where other image formats
6100 support binary transparency---fully transparent or fully
6101 opaque---PNG allows up to 254 levels of partial transparency.
6102 The PNG library implements partial transparency by combining
6103 the image with a specified background color.
6105 I'm not sure how to handle this here nicely: because the
6106 background on which the image is displayed may change, for
6107 real alpha channel support, it would be necessary to create
6108 a new image for each possible background.
6110 What I'm doing now is that a mask is created if we have
6111 boolean transparency information. Otherwise I'm using
6112 the frame's background color to combine the image with. */
6114 if (channels == 4)
6116 if (mask_img)
6117 XPutPixel (mask_img, x, y, *p > 0 ? PIX_MASK_DRAW (f) : PIX_MASK_RETAIN (f));
6118 ++p;
6123 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
6124 /* Set IMG's background color from the PNG image, unless the user
6125 overrode it. */
6127 png_color_16 *bg;
6128 if (fn_png_get_bKGD (png_ptr, info_ptr, &bg))
6130 img->background = lookup_rgb_color (f, bg->red, bg->green, bg->blue);
6131 img->background_valid = 1;
6135 #ifdef COLOR_TABLE_SUPPORT
6136 /* Remember colors allocated for this image. */
6137 img->colors = colors_in_color_table (&img->ncolors);
6138 free_color_table ();
6139 #endif /* COLOR_TABLE_SUPPORT */
6141 /* Clean up. */
6142 fn_png_destroy_read_struct (&png_ptr, &info_ptr, &end_info);
6143 xfree (rows);
6144 xfree (pixels);
6146 img->width = width;
6147 img->height = height;
6149 /* Maybe fill in the background field while we have ximg handy. */
6150 IMAGE_BACKGROUND (img, f, ximg);
6152 /* Put the image into the pixmap, then free the X image and its buffer. */
6153 x_put_x_image (f, ximg, img->pixmap, width, height);
6154 x_destroy_x_image (ximg);
6156 /* Same for the mask. */
6157 if (mask_img)
6159 /* Fill in the background_transparent field while we have the mask
6160 handy. */
6161 image_background_transparent (img, f, mask_img);
6163 x_put_x_image (f, mask_img, img->mask, img->width, img->height);
6164 x_destroy_x_image (mask_img);
6167 UNGCPRO;
6168 return 1;
6171 #else /* HAVE_PNG */
6173 #ifdef MAC_OS
6174 static int
6175 png_load (f, img)
6176 struct frame *f;
6177 struct image *img;
6179 #ifdef MAC_OSX
6180 if (MyCGImageCreateWithPNGDataProvider)
6181 return image_load_quartz2d (f, img, 1);
6182 else
6183 #endif
6184 return image_load_quicktime (f, img, kQTFileTypePNG);
6186 #endif /* MAC_OS */
6188 #endif /* !HAVE_PNG */
6192 /***********************************************************************
6193 JPEG
6194 ***********************************************************************/
6196 #if defined (HAVE_JPEG) || defined (MAC_OS)
6198 static int jpeg_image_p P_ ((Lisp_Object object));
6199 static int jpeg_load P_ ((struct frame *f, struct image *img));
6201 /* The symbol `jpeg' identifying images of this type. */
6203 Lisp_Object Qjpeg;
6205 /* Indices of image specification fields in gs_format, below. */
6207 enum jpeg_keyword_index
6209 JPEG_TYPE,
6210 JPEG_DATA,
6211 JPEG_FILE,
6212 JPEG_ASCENT,
6213 JPEG_MARGIN,
6214 JPEG_RELIEF,
6215 JPEG_ALGORITHM,
6216 JPEG_HEURISTIC_MASK,
6217 JPEG_MASK,
6218 JPEG_BACKGROUND,
6219 JPEG_LAST
6222 /* Vector of image_keyword structures describing the format
6223 of valid user-defined image specifications. */
6225 static struct image_keyword jpeg_format[JPEG_LAST] =
6227 {":type", IMAGE_SYMBOL_VALUE, 1},
6228 {":data", IMAGE_STRING_VALUE, 0},
6229 {":file", IMAGE_STRING_VALUE, 0},
6230 {":ascent", IMAGE_ASCENT_VALUE, 0},
6231 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
6232 {":relief", IMAGE_INTEGER_VALUE, 0},
6233 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6234 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6235 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6236 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
6239 /* Structure describing the image type `jpeg'. */
6241 static struct image_type jpeg_type =
6243 &Qjpeg,
6244 jpeg_image_p,
6245 jpeg_load,
6246 x_clear_image,
6247 NULL
6250 /* Return non-zero if OBJECT is a valid JPEG image specification. */
6252 static int
6253 jpeg_image_p (object)
6254 Lisp_Object object;
6256 struct image_keyword fmt[JPEG_LAST];
6258 bcopy (jpeg_format, fmt, sizeof fmt);
6260 if (!parse_image_spec (object, fmt, JPEG_LAST, Qjpeg))
6261 return 0;
6263 /* Must specify either the :data or :file keyword. */
6264 return fmt[JPEG_FILE].count + fmt[JPEG_DATA].count == 1;
6267 #endif /* HAVE_JPEG || MAC_OS */
6269 #ifdef HAVE_JPEG
6271 /* Work around a warning about HAVE_STDLIB_H being redefined in
6272 jconfig.h. */
6273 #ifdef HAVE_STDLIB_H
6274 #define HAVE_STDLIB_H_1
6275 #undef HAVE_STDLIB_H
6276 #endif /* HAVE_STLIB_H */
6278 #if defined (HAVE_NTGUI) && !defined (__WIN32__)
6279 /* jpeglib.h will define boolean differently depending on __WIN32__,
6280 so make sure it is defined. */
6281 #define __WIN32__ 1
6282 #endif
6284 #include <jpeglib.h>
6285 #include <jerror.h>
6286 #include <setjmp.h>
6288 #ifdef HAVE_STLIB_H_1
6289 #define HAVE_STDLIB_H 1
6290 #endif
6292 #ifdef HAVE_NTGUI
6294 /* JPEG library details. */
6295 DEF_IMGLIB_FN (jpeg_CreateDecompress);
6296 DEF_IMGLIB_FN (jpeg_start_decompress);
6297 DEF_IMGLIB_FN (jpeg_finish_decompress);
6298 DEF_IMGLIB_FN (jpeg_destroy_decompress);
6299 DEF_IMGLIB_FN (jpeg_read_header);
6300 DEF_IMGLIB_FN (jpeg_read_scanlines);
6301 DEF_IMGLIB_FN (jpeg_stdio_src);
6302 DEF_IMGLIB_FN (jpeg_std_error);
6303 DEF_IMGLIB_FN (jpeg_resync_to_restart);
6305 static int
6306 init_jpeg_functions (Lisp_Object libraries)
6308 HMODULE library;
6310 if (!(library = w32_delayed_load (libraries, Qjpeg)))
6311 return 0;
6313 LOAD_IMGLIB_FN (library, jpeg_finish_decompress);
6314 LOAD_IMGLIB_FN (library, jpeg_read_scanlines);
6315 LOAD_IMGLIB_FN (library, jpeg_start_decompress);
6316 LOAD_IMGLIB_FN (library, jpeg_read_header);
6317 LOAD_IMGLIB_FN (library, jpeg_stdio_src);
6318 LOAD_IMGLIB_FN (library, jpeg_CreateDecompress);
6319 LOAD_IMGLIB_FN (library, jpeg_destroy_decompress);
6320 LOAD_IMGLIB_FN (library, jpeg_std_error);
6321 LOAD_IMGLIB_FN (library, jpeg_resync_to_restart);
6322 return 1;
6325 /* Wrapper since we can't directly assign the function pointer
6326 to another function pointer that was declared more completely easily. */
6327 static boolean
6328 jpeg_resync_to_restart_wrapper(cinfo, desired)
6329 j_decompress_ptr cinfo;
6330 int desired;
6332 return fn_jpeg_resync_to_restart (cinfo, desired);
6335 #else
6337 #define fn_jpeg_CreateDecompress(a,b,c) jpeg_create_decompress(a)
6338 #define fn_jpeg_start_decompress jpeg_start_decompress
6339 #define fn_jpeg_finish_decompress jpeg_finish_decompress
6340 #define fn_jpeg_destroy_decompress jpeg_destroy_decompress
6341 #define fn_jpeg_read_header jpeg_read_header
6342 #define fn_jpeg_read_scanlines jpeg_read_scanlines
6343 #define fn_jpeg_stdio_src jpeg_stdio_src
6344 #define fn_jpeg_std_error jpeg_std_error
6345 #define jpeg_resync_to_restart_wrapper jpeg_resync_to_restart
6347 #endif /* HAVE_NTGUI */
6349 struct my_jpeg_error_mgr
6351 struct jpeg_error_mgr pub;
6352 jmp_buf setjmp_buffer;
6356 static void
6357 my_error_exit (cinfo)
6358 j_common_ptr cinfo;
6360 struct my_jpeg_error_mgr *mgr = (struct my_jpeg_error_mgr *) cinfo->err;
6361 longjmp (mgr->setjmp_buffer, 1);
6365 /* Init source method for JPEG data source manager. Called by
6366 jpeg_read_header() before any data is actually read. See
6367 libjpeg.doc from the JPEG lib distribution. */
6369 static void
6370 our_init_source (cinfo)
6371 j_decompress_ptr cinfo;
6376 /* Fill input buffer method for JPEG data source manager. Called
6377 whenever more data is needed. We read the whole image in one step,
6378 so this only adds a fake end of input marker at the end. */
6380 static boolean
6381 our_fill_input_buffer (cinfo)
6382 j_decompress_ptr cinfo;
6384 /* Insert a fake EOI marker. */
6385 struct jpeg_source_mgr *src = cinfo->src;
6386 static JOCTET buffer[2];
6388 buffer[0] = (JOCTET) 0xFF;
6389 buffer[1] = (JOCTET) JPEG_EOI;
6391 src->next_input_byte = buffer;
6392 src->bytes_in_buffer = 2;
6393 return 1;
6397 /* Method to skip over NUM_BYTES bytes in the image data. CINFO->src
6398 is the JPEG data source manager. */
6400 static void
6401 our_skip_input_data (cinfo, num_bytes)
6402 j_decompress_ptr cinfo;
6403 long num_bytes;
6405 struct jpeg_source_mgr *src = (struct jpeg_source_mgr *) cinfo->src;
6407 if (src)
6409 if (num_bytes > src->bytes_in_buffer)
6410 ERREXIT (cinfo, JERR_INPUT_EOF);
6412 src->bytes_in_buffer -= num_bytes;
6413 src->next_input_byte += num_bytes;
6418 /* Method to terminate data source. Called by
6419 jpeg_finish_decompress() after all data has been processed. */
6421 static void
6422 our_term_source (cinfo)
6423 j_decompress_ptr cinfo;
6428 /* Set up the JPEG lib for reading an image from DATA which contains
6429 LEN bytes. CINFO is the decompression info structure created for
6430 reading the image. */
6432 static void
6433 jpeg_memory_src (cinfo, data, len)
6434 j_decompress_ptr cinfo;
6435 JOCTET *data;
6436 unsigned int len;
6438 struct jpeg_source_mgr *src;
6440 if (cinfo->src == NULL)
6442 /* First time for this JPEG object? */
6443 cinfo->src = (struct jpeg_source_mgr *)
6444 (*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_PERMANENT,
6445 sizeof (struct jpeg_source_mgr));
6446 src = (struct jpeg_source_mgr *) cinfo->src;
6447 src->next_input_byte = data;
6450 src = (struct jpeg_source_mgr *) cinfo->src;
6451 src->init_source = our_init_source;
6452 src->fill_input_buffer = our_fill_input_buffer;
6453 src->skip_input_data = our_skip_input_data;
6454 src->resync_to_restart = jpeg_resync_to_restart_wrapper; /* Use default method. */
6455 src->term_source = our_term_source;
6456 src->bytes_in_buffer = len;
6457 src->next_input_byte = data;
6461 /* Load image IMG for use on frame F. Patterned after example.c
6462 from the JPEG lib. */
6464 static int
6465 jpeg_load (f, img)
6466 struct frame *f;
6467 struct image *img;
6469 struct jpeg_decompress_struct cinfo;
6470 struct my_jpeg_error_mgr mgr;
6471 Lisp_Object file, specified_file;
6472 Lisp_Object specified_data;
6473 FILE * volatile fp = NULL;
6474 JSAMPARRAY buffer;
6475 int row_stride, x, y;
6476 XImagePtr ximg = NULL;
6477 int rc;
6478 unsigned long *colors;
6479 int width, height;
6480 struct gcpro gcpro1;
6482 /* Open the JPEG file. */
6483 specified_file = image_spec_value (img->spec, QCfile, NULL);
6484 specified_data = image_spec_value (img->spec, QCdata, NULL);
6485 file = Qnil;
6486 GCPRO1 (file);
6488 if (NILP (specified_data))
6490 file = x_find_image_file (specified_file);
6491 if (!STRINGP (file))
6493 image_error ("Cannot find image file `%s'", specified_file, Qnil);
6494 UNGCPRO;
6495 return 0;
6498 fp = fopen (SDATA (file), "rb");
6499 if (fp == NULL)
6501 image_error ("Cannot open `%s'", file, Qnil);
6502 UNGCPRO;
6503 return 0;
6507 /* Customize libjpeg's error handling to call my_error_exit when an
6508 error is detected. This function will perform a longjmp. */
6509 cinfo.err = fn_jpeg_std_error (&mgr.pub);
6510 mgr.pub.error_exit = my_error_exit;
6512 if ((rc = setjmp (mgr.setjmp_buffer)) != 0)
6514 if (rc == 1)
6516 /* Called from my_error_exit. Display a JPEG error. */
6517 char buffer[JMSG_LENGTH_MAX];
6518 cinfo.err->format_message ((j_common_ptr) &cinfo, buffer);
6519 image_error ("Error reading JPEG image `%s': %s", img->spec,
6520 build_string (buffer));
6523 /* Close the input file and destroy the JPEG object. */
6524 if (fp)
6525 fclose ((FILE *) fp);
6526 fn_jpeg_destroy_decompress (&cinfo);
6528 /* If we already have an XImage, free that. */
6529 x_destroy_x_image (ximg);
6531 /* Free pixmap and colors. */
6532 x_clear_image (f, img);
6534 UNGCPRO;
6535 return 0;
6538 /* Create the JPEG decompression object. Let it read from fp.
6539 Read the JPEG image header. */
6540 fn_jpeg_CreateDecompress (&cinfo, JPEG_LIB_VERSION, sizeof (cinfo));
6542 if (NILP (specified_data))
6543 fn_jpeg_stdio_src (&cinfo, (FILE *) fp);
6544 else
6545 jpeg_memory_src (&cinfo, SDATA (specified_data),
6546 SBYTES (specified_data));
6548 fn_jpeg_read_header (&cinfo, 1);
6550 /* Customize decompression so that color quantization will be used.
6551 Start decompression. */
6552 cinfo.quantize_colors = 1;
6553 fn_jpeg_start_decompress (&cinfo);
6554 width = img->width = cinfo.output_width;
6555 height = img->height = cinfo.output_height;
6557 /* Create X image and pixmap. */
6558 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
6559 longjmp (mgr.setjmp_buffer, 2);
6561 /* Allocate colors. When color quantization is used,
6562 cinfo.actual_number_of_colors has been set with the number of
6563 colors generated, and cinfo.colormap is a two-dimensional array
6564 of color indices in the range 0..cinfo.actual_number_of_colors.
6565 No more than 255 colors will be generated. */
6567 int i, ir, ig, ib;
6569 if (cinfo.out_color_components > 2)
6570 ir = 0, ig = 1, ib = 2;
6571 else if (cinfo.out_color_components > 1)
6572 ir = 0, ig = 1, ib = 0;
6573 else
6574 ir = 0, ig = 0, ib = 0;
6576 /* Use the color table mechanism because it handles colors that
6577 cannot be allocated nicely. Such colors will be replaced with
6578 a default color, and we don't have to care about which colors
6579 can be freed safely, and which can't. */
6580 init_color_table ();
6581 colors = (unsigned long *) alloca (cinfo.actual_number_of_colors
6582 * sizeof *colors);
6584 for (i = 0; i < cinfo.actual_number_of_colors; ++i)
6586 /* Multiply RGB values with 255 because X expects RGB values
6587 in the range 0..0xffff. */
6588 int r = cinfo.colormap[ir][i] << 8;
6589 int g = cinfo.colormap[ig][i] << 8;
6590 int b = cinfo.colormap[ib][i] << 8;
6591 colors[i] = lookup_rgb_color (f, r, g, b);
6594 #ifdef COLOR_TABLE_SUPPORT
6595 /* Remember those colors actually allocated. */
6596 img->colors = colors_in_color_table (&img->ncolors);
6597 free_color_table ();
6598 #endif /* COLOR_TABLE_SUPPORT */
6601 /* Read pixels. */
6602 row_stride = width * cinfo.output_components;
6603 buffer = cinfo.mem->alloc_sarray ((j_common_ptr) &cinfo, JPOOL_IMAGE,
6604 row_stride, 1);
6605 for (y = 0; y < height; ++y)
6607 fn_jpeg_read_scanlines (&cinfo, buffer, 1);
6608 for (x = 0; x < cinfo.output_width; ++x)
6609 XPutPixel (ximg, x, y, colors[buffer[0][x]]);
6612 /* Clean up. */
6613 fn_jpeg_finish_decompress (&cinfo);
6614 fn_jpeg_destroy_decompress (&cinfo);
6615 if (fp)
6616 fclose ((FILE *) fp);
6618 /* Maybe fill in the background field while we have ximg handy. */
6619 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
6620 IMAGE_BACKGROUND (img, f, ximg);
6622 /* Put the image into the pixmap. */
6623 x_put_x_image (f, ximg, img->pixmap, width, height);
6624 x_destroy_x_image (ximg);
6625 UNGCPRO;
6626 return 1;
6629 #else /* HAVE_JPEG */
6631 #ifdef MAC_OS
6632 static int
6633 jpeg_load (f, img)
6634 struct frame *f;
6635 struct image *img;
6637 #ifdef MAC_OSX
6638 return image_load_quartz2d (f, img, 0);
6639 #else
6640 return image_load_quicktime (f, img, kQTFileTypeJPEG);
6641 #endif
6643 #endif /* MAC_OS */
6645 #endif /* !HAVE_JPEG */
6649 /***********************************************************************
6650 TIFF
6651 ***********************************************************************/
6653 #if defined (HAVE_TIFF) || defined (MAC_OS)
6655 static int tiff_image_p P_ ((Lisp_Object object));
6656 static int tiff_load P_ ((struct frame *f, struct image *img));
6658 /* The symbol `tiff' identifying images of this type. */
6660 Lisp_Object Qtiff;
6662 /* Indices of image specification fields in tiff_format, below. */
6664 enum tiff_keyword_index
6666 TIFF_TYPE,
6667 TIFF_DATA,
6668 TIFF_FILE,
6669 TIFF_ASCENT,
6670 TIFF_MARGIN,
6671 TIFF_RELIEF,
6672 TIFF_ALGORITHM,
6673 TIFF_HEURISTIC_MASK,
6674 TIFF_MASK,
6675 TIFF_BACKGROUND,
6676 TIFF_LAST
6679 /* Vector of image_keyword structures describing the format
6680 of valid user-defined image specifications. */
6682 static struct image_keyword tiff_format[TIFF_LAST] =
6684 {":type", IMAGE_SYMBOL_VALUE, 1},
6685 {":data", IMAGE_STRING_VALUE, 0},
6686 {":file", IMAGE_STRING_VALUE, 0},
6687 {":ascent", IMAGE_ASCENT_VALUE, 0},
6688 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
6689 {":relief", IMAGE_INTEGER_VALUE, 0},
6690 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6691 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6692 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6693 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
6696 /* Structure describing the image type `tiff'. */
6698 static struct image_type tiff_type =
6700 &Qtiff,
6701 tiff_image_p,
6702 tiff_load,
6703 x_clear_image,
6704 NULL
6707 /* Return non-zero if OBJECT is a valid TIFF image specification. */
6709 static int
6710 tiff_image_p (object)
6711 Lisp_Object object;
6713 struct image_keyword fmt[TIFF_LAST];
6714 bcopy (tiff_format, fmt, sizeof fmt);
6716 if (!parse_image_spec (object, fmt, TIFF_LAST, Qtiff))
6717 return 0;
6719 /* Must specify either the :data or :file keyword. */
6720 return fmt[TIFF_FILE].count + fmt[TIFF_DATA].count == 1;
6723 #endif /* HAVE_TIFF || MAC_OS */
6725 #ifdef HAVE_TIFF
6727 #include <tiffio.h>
6729 #ifdef HAVE_NTGUI
6731 /* TIFF library details. */
6732 DEF_IMGLIB_FN (TIFFSetErrorHandler);
6733 DEF_IMGLIB_FN (TIFFSetWarningHandler);
6734 DEF_IMGLIB_FN (TIFFOpen);
6735 DEF_IMGLIB_FN (TIFFClientOpen);
6736 DEF_IMGLIB_FN (TIFFGetField);
6737 DEF_IMGLIB_FN (TIFFReadRGBAImage);
6738 DEF_IMGLIB_FN (TIFFClose);
6740 static int
6741 init_tiff_functions (Lisp_Object libraries)
6743 HMODULE library;
6745 if (!(library = w32_delayed_load (libraries, Qtiff)))
6746 return 0;
6748 LOAD_IMGLIB_FN (library, TIFFSetErrorHandler);
6749 LOAD_IMGLIB_FN (library, TIFFSetWarningHandler);
6750 LOAD_IMGLIB_FN (library, TIFFOpen);
6751 LOAD_IMGLIB_FN (library, TIFFClientOpen);
6752 LOAD_IMGLIB_FN (library, TIFFGetField);
6753 LOAD_IMGLIB_FN (library, TIFFReadRGBAImage);
6754 LOAD_IMGLIB_FN (library, TIFFClose);
6755 return 1;
6758 #else
6760 #define fn_TIFFSetErrorHandler TIFFSetErrorHandler
6761 #define fn_TIFFSetWarningHandler TIFFSetWarningHandler
6762 #define fn_TIFFOpen TIFFOpen
6763 #define fn_TIFFClientOpen TIFFClientOpen
6764 #define fn_TIFFGetField TIFFGetField
6765 #define fn_TIFFReadRGBAImage TIFFReadRGBAImage
6766 #define fn_TIFFClose TIFFClose
6768 #endif /* HAVE_NTGUI */
6771 /* Reading from a memory buffer for TIFF images Based on the PNG
6772 memory source, but we have to provide a lot of extra functions.
6773 Blah.
6775 We really only need to implement read and seek, but I am not
6776 convinced that the TIFF library is smart enough not to destroy
6777 itself if we only hand it the function pointers we need to
6778 override. */
6780 typedef struct
6782 unsigned char *bytes;
6783 size_t len;
6784 int index;
6786 tiff_memory_source;
6788 static size_t
6789 tiff_read_from_memory (data, buf, size)
6790 thandle_t data;
6791 tdata_t buf;
6792 tsize_t size;
6794 tiff_memory_source *src = (tiff_memory_source *) data;
6796 if (size > src->len - src->index)
6797 return (size_t) -1;
6798 bcopy (src->bytes + src->index, buf, size);
6799 src->index += size;
6800 return size;
6803 static size_t
6804 tiff_write_from_memory (data, buf, size)
6805 thandle_t data;
6806 tdata_t buf;
6807 tsize_t size;
6809 return (size_t) -1;
6812 static toff_t
6813 tiff_seek_in_memory (data, off, whence)
6814 thandle_t data;
6815 toff_t off;
6816 int whence;
6818 tiff_memory_source *src = (tiff_memory_source *) data;
6819 int idx;
6821 switch (whence)
6823 case SEEK_SET: /* Go from beginning of source. */
6824 idx = off;
6825 break;
6827 case SEEK_END: /* Go from end of source. */
6828 idx = src->len + off;
6829 break;
6831 case SEEK_CUR: /* Go from current position. */
6832 idx = src->index + off;
6833 break;
6835 default: /* Invalid `whence'. */
6836 return -1;
6839 if (idx > src->len || idx < 0)
6840 return -1;
6842 src->index = idx;
6843 return src->index;
6846 static int
6847 tiff_close_memory (data)
6848 thandle_t data;
6850 /* NOOP */
6851 return 0;
6854 static int
6855 tiff_mmap_memory (data, pbase, psize)
6856 thandle_t data;
6857 tdata_t *pbase;
6858 toff_t *psize;
6860 /* It is already _IN_ memory. */
6861 return 0;
6864 static void
6865 tiff_unmap_memory (data, base, size)
6866 thandle_t data;
6867 tdata_t base;
6868 toff_t size;
6870 /* We don't need to do this. */
6873 static toff_t
6874 tiff_size_of_memory (data)
6875 thandle_t data;
6877 return ((tiff_memory_source *) data)->len;
6881 static void
6882 tiff_error_handler (title, format, ap)
6883 const char *title, *format;
6884 va_list ap;
6886 char buf[512];
6887 int len;
6889 len = sprintf (buf, "TIFF error: %s ", title);
6890 vsprintf (buf + len, format, ap);
6891 add_to_log (buf, Qnil, Qnil);
6895 static void
6896 tiff_warning_handler (title, format, ap)
6897 const char *title, *format;
6898 va_list ap;
6900 char buf[512];
6901 int len;
6903 len = sprintf (buf, "TIFF warning: %s ", title);
6904 vsprintf (buf + len, format, ap);
6905 add_to_log (buf, Qnil, Qnil);
6909 /* Load TIFF image IMG for use on frame F. Value is non-zero if
6910 successful. */
6912 static int
6913 tiff_load (f, img)
6914 struct frame *f;
6915 struct image *img;
6917 Lisp_Object file, specified_file;
6918 Lisp_Object specified_data;
6919 TIFF *tiff;
6920 int width, height, x, y;
6921 uint32 *buf;
6922 int rc;
6923 XImagePtr ximg;
6924 struct gcpro gcpro1;
6925 tiff_memory_source memsrc;
6927 specified_file = image_spec_value (img->spec, QCfile, NULL);
6928 specified_data = image_spec_value (img->spec, QCdata, NULL);
6929 file = Qnil;
6930 GCPRO1 (file);
6932 fn_TIFFSetErrorHandler (tiff_error_handler);
6933 fn_TIFFSetWarningHandler (tiff_warning_handler);
6935 if (NILP (specified_data))
6937 /* Read from a file */
6938 file = x_find_image_file (specified_file);
6939 if (!STRINGP (file))
6941 image_error ("Cannot find image file `%s'", specified_file, Qnil);
6942 UNGCPRO;
6943 return 0;
6946 /* Try to open the image file. */
6947 tiff = fn_TIFFOpen (SDATA (file), "r");
6948 if (tiff == NULL)
6950 image_error ("Cannot open `%s'", file, Qnil);
6951 UNGCPRO;
6952 return 0;
6955 else
6957 /* Memory source! */
6958 memsrc.bytes = SDATA (specified_data);
6959 memsrc.len = SBYTES (specified_data);
6960 memsrc.index = 0;
6962 tiff = fn_TIFFClientOpen ("memory_source", "r", &memsrc,
6963 (TIFFReadWriteProc) tiff_read_from_memory,
6964 (TIFFReadWriteProc) tiff_write_from_memory,
6965 tiff_seek_in_memory,
6966 tiff_close_memory,
6967 tiff_size_of_memory,
6968 tiff_mmap_memory,
6969 tiff_unmap_memory);
6971 if (!tiff)
6973 image_error ("Cannot open memory source for `%s'", img->spec, Qnil);
6974 UNGCPRO;
6975 return 0;
6979 /* Get width and height of the image, and allocate a raster buffer
6980 of width x height 32-bit values. */
6981 fn_TIFFGetField (tiff, TIFFTAG_IMAGEWIDTH, &width);
6982 fn_TIFFGetField (tiff, TIFFTAG_IMAGELENGTH, &height);
6983 buf = (uint32 *) xmalloc (width * height * sizeof *buf);
6985 rc = fn_TIFFReadRGBAImage (tiff, width, height, buf, 0);
6986 fn_TIFFClose (tiff);
6987 if (!rc)
6989 image_error ("Error reading TIFF image `%s'", img->spec, Qnil);
6990 xfree (buf);
6991 UNGCPRO;
6992 return 0;
6995 /* Create the X image and pixmap. */
6996 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
6998 xfree (buf);
6999 UNGCPRO;
7000 return 0;
7003 /* Initialize the color table. */
7004 init_color_table ();
7006 /* Process the pixel raster. Origin is in the lower-left corner. */
7007 for (y = 0; y < height; ++y)
7009 uint32 *row = buf + y * width;
7011 for (x = 0; x < width; ++x)
7013 uint32 abgr = row[x];
7014 int r = TIFFGetR (abgr) << 8;
7015 int g = TIFFGetG (abgr) << 8;
7016 int b = TIFFGetB (abgr) << 8;
7017 XPutPixel (ximg, x, height - 1 - y, lookup_rgb_color (f, r, g, b));
7021 #ifdef COLOR_TABLE_SUPPORT
7022 /* Remember the colors allocated for the image. Free the color table. */
7023 img->colors = colors_in_color_table (&img->ncolors);
7024 free_color_table ();
7025 #endif /* COLOR_TABLE_SUPPORT */
7027 img->width = width;
7028 img->height = height;
7030 /* Maybe fill in the background field while we have ximg handy. */
7031 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
7032 IMAGE_BACKGROUND (img, f, ximg);
7034 /* Put the image into the pixmap, then free the X image and its buffer. */
7035 x_put_x_image (f, ximg, img->pixmap, width, height);
7036 x_destroy_x_image (ximg);
7037 xfree (buf);
7039 UNGCPRO;
7040 return 1;
7043 #else /* HAVE_TIFF */
7045 #ifdef MAC_OS
7046 static int
7047 tiff_load (f, img)
7048 struct frame *f;
7049 struct image *img;
7051 return image_load_quicktime (f, img, kQTFileTypeTIFF);
7053 #endif /* MAC_OS */
7055 #endif /* !HAVE_TIFF */
7059 /***********************************************************************
7061 ***********************************************************************/
7063 #if defined (HAVE_GIF) || defined (MAC_OS)
7065 static int gif_image_p P_ ((Lisp_Object object));
7066 static int gif_load P_ ((struct frame *f, struct image *img));
7068 /* The symbol `gif' identifying images of this type. */
7070 Lisp_Object Qgif;
7072 /* Indices of image specification fields in gif_format, below. */
7074 enum gif_keyword_index
7076 GIF_TYPE,
7077 GIF_DATA,
7078 GIF_FILE,
7079 GIF_ASCENT,
7080 GIF_MARGIN,
7081 GIF_RELIEF,
7082 GIF_ALGORITHM,
7083 GIF_HEURISTIC_MASK,
7084 GIF_MASK,
7085 GIF_IMAGE,
7086 GIF_BACKGROUND,
7087 GIF_LAST
7090 /* Vector of image_keyword structures describing the format
7091 of valid user-defined image specifications. */
7093 static struct image_keyword gif_format[GIF_LAST] =
7095 {":type", IMAGE_SYMBOL_VALUE, 1},
7096 {":data", IMAGE_STRING_VALUE, 0},
7097 {":file", IMAGE_STRING_VALUE, 0},
7098 {":ascent", IMAGE_ASCENT_VALUE, 0},
7099 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
7100 {":relief", IMAGE_INTEGER_VALUE, 0},
7101 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7102 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7103 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7104 {":image", IMAGE_NON_NEGATIVE_INTEGER_VALUE, 0},
7105 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
7108 /* Structure describing the image type `gif'. */
7110 static struct image_type gif_type =
7112 &Qgif,
7113 gif_image_p,
7114 gif_load,
7115 x_clear_image,
7116 NULL
7119 /* Return non-zero if OBJECT is a valid GIF image specification. */
7121 static int
7122 gif_image_p (object)
7123 Lisp_Object object;
7125 struct image_keyword fmt[GIF_LAST];
7126 bcopy (gif_format, fmt, sizeof fmt);
7128 if (!parse_image_spec (object, fmt, GIF_LAST, Qgif))
7129 return 0;
7131 /* Must specify either the :data or :file keyword. */
7132 return fmt[GIF_FILE].count + fmt[GIF_DATA].count == 1;
7135 #endif /* HAVE_GIF || MAC_OS */
7137 #ifdef HAVE_GIF
7139 #if defined (HAVE_NTGUI) || defined (MAC_OS)
7140 /* avoid conflict with QuickdrawText.h */
7141 #define DrawText gif_DrawText
7142 #include <gif_lib.h>
7143 #undef DrawText
7145 #else /* HAVE_NTGUI || MAC_OS */
7147 #include <gif_lib.h>
7149 #endif /* HAVE_NTGUI || MAC_OS */
7152 #ifdef HAVE_NTGUI
7154 /* GIF library details. */
7155 DEF_IMGLIB_FN (DGifCloseFile);
7156 DEF_IMGLIB_FN (DGifSlurp);
7157 DEF_IMGLIB_FN (DGifOpen);
7158 DEF_IMGLIB_FN (DGifOpenFileName);
7160 static int
7161 init_gif_functions (Lisp_Object libraries)
7163 HMODULE library;
7165 if (!(library = w32_delayed_load (libraries, Qgif)))
7166 return 0;
7168 LOAD_IMGLIB_FN (library, DGifCloseFile);
7169 LOAD_IMGLIB_FN (library, DGifSlurp);
7170 LOAD_IMGLIB_FN (library, DGifOpen);
7171 LOAD_IMGLIB_FN (library, DGifOpenFileName);
7172 return 1;
7175 #else
7177 #define fn_DGifCloseFile DGifCloseFile
7178 #define fn_DGifSlurp DGifSlurp
7179 #define fn_DGifOpen DGifOpen
7180 #define fn_DGifOpenFileName DGifOpenFileName
7182 #endif /* HAVE_NTGUI */
7184 /* Reading a GIF image from memory
7185 Based on the PNG memory stuff to a certain extent. */
7187 typedef struct
7189 unsigned char *bytes;
7190 size_t len;
7191 int index;
7193 gif_memory_source;
7195 /* Make the current memory source available to gif_read_from_memory.
7196 It's done this way because not all versions of libungif support
7197 a UserData field in the GifFileType structure. */
7198 static gif_memory_source *current_gif_memory_src;
7200 static int
7201 gif_read_from_memory (file, buf, len)
7202 GifFileType *file;
7203 GifByteType *buf;
7204 int len;
7206 gif_memory_source *src = current_gif_memory_src;
7208 if (len > src->len - src->index)
7209 return -1;
7211 bcopy (src->bytes + src->index, buf, len);
7212 src->index += len;
7213 return len;
7217 /* Load GIF image IMG for use on frame F. Value is non-zero if
7218 successful. */
7220 static int
7221 gif_load (f, img)
7222 struct frame *f;
7223 struct image *img;
7225 Lisp_Object file, specified_file;
7226 Lisp_Object specified_data;
7227 int rc, width, height, x, y, i;
7228 XImagePtr ximg;
7229 ColorMapObject *gif_color_map;
7230 unsigned long pixel_colors[256];
7231 GifFileType *gif;
7232 struct gcpro gcpro1;
7233 Lisp_Object image;
7234 int ino, image_left, image_top, image_width, image_height;
7235 gif_memory_source memsrc;
7236 unsigned char *raster;
7238 specified_file = image_spec_value (img->spec, QCfile, NULL);
7239 specified_data = image_spec_value (img->spec, QCdata, NULL);
7240 file = Qnil;
7241 GCPRO1 (file);
7243 if (NILP (specified_data))
7245 file = x_find_image_file (specified_file);
7246 if (!STRINGP (file))
7248 image_error ("Cannot find image file `%s'", specified_file, Qnil);
7249 UNGCPRO;
7250 return 0;
7253 /* Open the GIF file. */
7254 gif = fn_DGifOpenFileName (SDATA (file));
7255 if (gif == NULL)
7257 image_error ("Cannot open `%s'", file, Qnil);
7258 UNGCPRO;
7259 return 0;
7262 else
7264 /* Read from memory! */
7265 current_gif_memory_src = &memsrc;
7266 memsrc.bytes = SDATA (specified_data);
7267 memsrc.len = SBYTES (specified_data);
7268 memsrc.index = 0;
7270 gif = fn_DGifOpen(&memsrc, gif_read_from_memory);
7271 if (!gif)
7273 image_error ("Cannot open memory source `%s'", img->spec, Qnil);
7274 UNGCPRO;
7275 return 0;
7279 /* Read entire contents. */
7280 rc = fn_DGifSlurp (gif);
7281 if (rc == GIF_ERROR)
7283 image_error ("Error reading `%s'", img->spec, Qnil);
7284 fn_DGifCloseFile (gif);
7285 UNGCPRO;
7286 return 0;
7289 image = image_spec_value (img->spec, QCindex, NULL);
7290 ino = INTEGERP (image) ? XFASTINT (image) : 0;
7291 if (ino >= gif->ImageCount)
7293 image_error ("Invalid image number `%s' in image `%s'",
7294 image, img->spec);
7295 fn_DGifCloseFile (gif);
7296 UNGCPRO;
7297 return 0;
7300 width = img->width = max (gif->SWidth, gif->Image.Left + gif->Image.Width);
7301 height = img->height = max (gif->SHeight, gif->Image.Top + gif->Image.Height);
7303 /* Create the X image and pixmap. */
7304 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
7306 fn_DGifCloseFile (gif);
7307 UNGCPRO;
7308 return 0;
7311 /* Allocate colors. */
7312 gif_color_map = gif->SavedImages[ino].ImageDesc.ColorMap;
7313 if (!gif_color_map)
7314 gif_color_map = gif->SColorMap;
7315 init_color_table ();
7316 bzero (pixel_colors, sizeof pixel_colors);
7318 for (i = 0; i < gif_color_map->ColorCount; ++i)
7320 int r = gif_color_map->Colors[i].Red << 8;
7321 int g = gif_color_map->Colors[i].Green << 8;
7322 int b = gif_color_map->Colors[i].Blue << 8;
7323 pixel_colors[i] = lookup_rgb_color (f, r, g, b);
7326 #ifdef COLOR_TABLE_SUPPORT
7327 img->colors = colors_in_color_table (&img->ncolors);
7328 free_color_table ();
7329 #endif /* COLOR_TABLE_SUPPORT */
7331 /* Clear the part of the screen image that are not covered by
7332 the image from the GIF file. Full animated GIF support
7333 requires more than can be done here (see the gif89 spec,
7334 disposal methods). Let's simply assume that the part
7335 not covered by a sub-image is in the frame's background color. */
7336 image_top = gif->SavedImages[ino].ImageDesc.Top;
7337 image_left = gif->SavedImages[ino].ImageDesc.Left;
7338 image_width = gif->SavedImages[ino].ImageDesc.Width;
7339 image_height = gif->SavedImages[ino].ImageDesc.Height;
7341 for (y = 0; y < image_top; ++y)
7342 for (x = 0; x < width; ++x)
7343 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
7345 for (y = image_top + image_height; y < height; ++y)
7346 for (x = 0; x < width; ++x)
7347 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
7349 for (y = image_top; y < image_top + image_height; ++y)
7351 for (x = 0; x < image_left; ++x)
7352 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
7353 for (x = image_left + image_width; x < width; ++x)
7354 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
7357 /* Read the GIF image into the X image. We use a local variable
7358 `raster' here because RasterBits below is a char *, and invites
7359 problems with bytes >= 0x80. */
7360 raster = (unsigned char *) gif->SavedImages[ino].RasterBits;
7362 if (gif->SavedImages[ino].ImageDesc.Interlace)
7364 static int interlace_start[] = {0, 4, 2, 1};
7365 static int interlace_increment[] = {8, 8, 4, 2};
7366 int pass;
7367 int row = interlace_start[0];
7369 pass = 0;
7371 for (y = 0; y < image_height; y++)
7373 if (row >= image_height)
7375 row = interlace_start[++pass];
7376 while (row >= image_height)
7377 row = interlace_start[++pass];
7380 for (x = 0; x < image_width; x++)
7382 int i = raster[(y * image_width) + x];
7383 XPutPixel (ximg, x + image_left, row + image_top,
7384 pixel_colors[i]);
7387 row += interlace_increment[pass];
7390 else
7392 for (y = 0; y < image_height; ++y)
7393 for (x = 0; x < image_width; ++x)
7395 int i = raster[y * image_width + x];
7396 XPutPixel (ximg, x + image_left, y + image_top, pixel_colors[i]);
7400 fn_DGifCloseFile (gif);
7402 /* Maybe fill in the background field while we have ximg handy. */
7403 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
7404 IMAGE_BACKGROUND (img, f, ximg);
7406 /* Put the image into the pixmap, then free the X image and its buffer. */
7407 x_put_x_image (f, ximg, img->pixmap, width, height);
7408 x_destroy_x_image (ximg);
7410 UNGCPRO;
7411 return 1;
7414 #else
7416 #ifdef MAC_OS
7417 static int
7418 gif_load (f, img)
7419 struct frame *f;
7420 struct image *img;
7422 Lisp_Object specified_file, file;
7423 Lisp_Object specified_data;
7424 OSErr err;
7425 Boolean graphic_p, movie_p, prefer_graphic_p;
7426 Handle dh = NULL;
7427 Movie movie = NULL;
7428 Lisp_Object image;
7429 Track track = NULL;
7430 Media media = NULL;
7431 long nsamples;
7432 Rect rect;
7433 Lisp_Object specified_bg;
7434 XColor color;
7435 RGBColor bg_color;
7436 int width, height;
7437 XImagePtr ximg;
7438 TimeValue time;
7439 struct gcpro gcpro1;
7440 int ino;
7441 CGrafPtr old_port;
7442 GDHandle old_gdh;
7444 specified_file = image_spec_value (img->spec, QCfile, NULL);
7445 specified_data = image_spec_value (img->spec, QCdata, NULL);
7447 if (NILP (specified_data))
7449 /* Read from a file */
7450 FSSpec fss;
7451 short refnum;
7453 err = find_image_fsspec (specified_file, &file, &fss);
7454 if (err != noErr)
7456 if (err == fnfErr)
7457 image_error ("Cannot find image file `%s'", specified_file, Qnil);
7458 else
7459 goto open_error;
7462 err = CanQuickTimeOpenFile (&fss, kQTFileTypeGIF, 0,
7463 &graphic_p, &movie_p, &prefer_graphic_p, 0);
7464 if (err != noErr)
7465 goto open_error;
7467 if (!graphic_p && !movie_p)
7468 goto open_error;
7469 if (prefer_graphic_p)
7470 return image_load_qt_1 (f, img, kQTFileTypeGIF, &fss, NULL);
7471 err = OpenMovieFile (&fss, &refnum, fsRdPerm);
7472 if (err != noErr)
7473 goto open_error;
7474 err = NewMovieFromFile (&movie, refnum, NULL, NULL, 0, NULL);
7475 CloseMovieFile (refnum);
7476 if (err != noErr)
7478 image_error ("Error reading `%s'", file, Qnil);
7479 return 0;
7482 else
7484 /* Memory source! */
7485 Handle dref = NULL;
7486 long file_type_atom[3];
7488 err = PtrToHand (SDATA (specified_data), &dh, SBYTES (specified_data));
7489 if (err != noErr)
7491 image_error ("Cannot allocate data handle for `%s'",
7492 img->spec, Qnil);
7493 goto error;
7496 file_type_atom[0] = EndianU32_NtoB (sizeof (long) * 3);
7497 file_type_atom[1] = EndianU32_NtoB (kDataRefExtensionMacOSFileType);
7498 file_type_atom[2] = EndianU32_NtoB (kQTFileTypeGIF);
7499 err = PtrToHand (&dh, &dref, sizeof (Handle));
7500 if (err == noErr)
7501 /* no file name */
7502 err = PtrAndHand ("\p", dref, 1);
7503 if (err == noErr)
7504 err = PtrAndHand (file_type_atom, dref, sizeof (long) * 3);
7505 if (err != noErr)
7507 image_error ("Cannot allocate handle data ref for `%s'", img->spec, Qnil);
7508 goto error;
7510 err = CanQuickTimeOpenDataRef (dref, HandleDataHandlerSubType, &graphic_p,
7511 &movie_p, &prefer_graphic_p, 0);
7512 if (err != noErr)
7513 goto open_error;
7515 if (!graphic_p && !movie_p)
7516 goto open_error;
7517 if (prefer_graphic_p)
7519 int success_p;
7521 DisposeHandle (dref);
7522 success_p = image_load_qt_1 (f, img, kQTFileTypeGIF, NULL, dh);
7523 DisposeHandle (dh);
7524 return success_p;
7526 err = NewMovieFromDataRef (&movie, 0, NULL, dref,
7527 HandleDataHandlerSubType);
7528 DisposeHandle (dref);
7529 if (err != noErr)
7530 goto open_error;
7533 image = image_spec_value (img->spec, QCindex, NULL);
7534 ino = INTEGERP (image) ? XFASTINT (image) : 0;
7535 track = GetMovieIndTrack (movie, 1);
7536 media = GetTrackMedia (track);
7537 nsamples = GetMediaSampleCount (media);
7538 if (ino >= nsamples)
7540 image_error ("Invalid image number `%s' in image `%s'",
7541 image, img->spec);
7542 goto error;
7545 specified_bg = image_spec_value (img->spec, QCbackground, NULL);
7546 if (!STRINGP (specified_bg) ||
7547 !mac_defined_color (f, SDATA (specified_bg), &color, 0))
7549 color.pixel = FRAME_BACKGROUND_PIXEL (f);
7550 color.red = RED16_FROM_ULONG (color.pixel);
7551 color.green = GREEN16_FROM_ULONG (color.pixel);
7552 color.blue = BLUE16_FROM_ULONG (color.pixel);
7554 GetMovieBox (movie, &rect);
7555 width = img->width = rect.right - rect.left;
7556 height = img->height = rect.bottom - rect.top;
7557 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
7558 goto error;
7560 GetGWorld (&old_port, &old_gdh);
7561 SetGWorld (ximg, NULL);
7562 bg_color.red = color.red;
7563 bg_color.green = color.green;
7564 bg_color.blue = color.blue;
7565 RGBBackColor (&bg_color);
7566 SetGWorld (old_port, old_gdh);
7567 SetMovieActive (movie, 1);
7568 SetMovieGWorld (movie, ximg, NULL);
7569 SampleNumToMediaTime (media, ino + 1, &time, NULL);
7570 SetMovieTimeValue (movie, time);
7571 MoviesTask (movie, 0L);
7572 DisposeTrackMedia (media);
7573 DisposeMovieTrack (track);
7574 DisposeMovie (movie);
7575 if (dh)
7576 DisposeHandle (dh);
7577 /* Maybe fill in the background field while we have ximg handy. */
7578 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
7579 IMAGE_BACKGROUND (img, f, ximg);
7581 /* Put the image into the pixmap. */
7582 x_put_x_image (f, ximg, img->pixmap, width, height);
7583 x_destroy_x_image (ximg);
7584 return 1;
7586 open_error:
7587 image_error ("Cannot open `%s'", file, Qnil);
7588 error:
7589 if (media)
7590 DisposeTrackMedia (media);
7591 if (track)
7592 DisposeMovieTrack (track);
7593 if (movie)
7594 DisposeMovie (movie);
7595 if (dh)
7596 DisposeHandle (dh);
7597 return 0;
7599 #endif /* MAC_OS */
7601 #endif /* HAVE_GIF */
7605 /***********************************************************************
7606 Ghostscript
7607 ***********************************************************************/
7609 #ifdef HAVE_X_WINDOWS
7610 #define HAVE_GHOSTSCRIPT 1
7611 #endif /* HAVE_X_WINDOWS */
7613 /* The symbol `postscript' identifying images of this type. */
7615 Lisp_Object Qpostscript;
7617 #ifdef HAVE_GHOSTSCRIPT
7619 static int gs_image_p P_ ((Lisp_Object object));
7620 static int gs_load P_ ((struct frame *f, struct image *img));
7621 static void gs_clear_image P_ ((struct frame *f, struct image *img));
7623 /* Keyword symbols. */
7625 Lisp_Object QCloader, QCbounding_box, QCpt_width, QCpt_height;
7627 /* Indices of image specification fields in gs_format, below. */
7629 enum gs_keyword_index
7631 GS_TYPE,
7632 GS_PT_WIDTH,
7633 GS_PT_HEIGHT,
7634 GS_FILE,
7635 GS_LOADER,
7636 GS_BOUNDING_BOX,
7637 GS_ASCENT,
7638 GS_MARGIN,
7639 GS_RELIEF,
7640 GS_ALGORITHM,
7641 GS_HEURISTIC_MASK,
7642 GS_MASK,
7643 GS_BACKGROUND,
7644 GS_LAST
7647 /* Vector of image_keyword structures describing the format
7648 of valid user-defined image specifications. */
7650 static struct image_keyword gs_format[GS_LAST] =
7652 {":type", IMAGE_SYMBOL_VALUE, 1},
7653 {":pt-width", IMAGE_POSITIVE_INTEGER_VALUE, 1},
7654 {":pt-height", IMAGE_POSITIVE_INTEGER_VALUE, 1},
7655 {":file", IMAGE_STRING_VALUE, 1},
7656 {":loader", IMAGE_FUNCTION_VALUE, 0},
7657 {":bounding-box", IMAGE_DONT_CHECK_VALUE_TYPE, 1},
7658 {":ascent", IMAGE_ASCENT_VALUE, 0},
7659 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
7660 {":relief", IMAGE_INTEGER_VALUE, 0},
7661 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7662 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7663 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7664 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
7667 /* Structure describing the image type `ghostscript'. */
7669 static struct image_type gs_type =
7671 &Qpostscript,
7672 gs_image_p,
7673 gs_load,
7674 gs_clear_image,
7675 NULL
7679 /* Free X resources of Ghostscript image IMG which is used on frame F. */
7681 static void
7682 gs_clear_image (f, img)
7683 struct frame *f;
7684 struct image *img;
7686 /* IMG->data.ptr_val may contain a recorded colormap. */
7687 xfree (img->data.ptr_val);
7688 x_clear_image (f, img);
7692 /* Return non-zero if OBJECT is a valid Ghostscript image
7693 specification. */
7695 static int
7696 gs_image_p (object)
7697 Lisp_Object object;
7699 struct image_keyword fmt[GS_LAST];
7700 Lisp_Object tem;
7701 int i;
7703 bcopy (gs_format, fmt, sizeof fmt);
7705 if (!parse_image_spec (object, fmt, GS_LAST, Qpostscript))
7706 return 0;
7708 /* Bounding box must be a list or vector containing 4 integers. */
7709 tem = fmt[GS_BOUNDING_BOX].value;
7710 if (CONSP (tem))
7712 for (i = 0; i < 4; ++i, tem = XCDR (tem))
7713 if (!CONSP (tem) || !INTEGERP (XCAR (tem)))
7714 return 0;
7715 if (!NILP (tem))
7716 return 0;
7718 else if (VECTORP (tem))
7720 if (XVECTOR (tem)->size != 4)
7721 return 0;
7722 for (i = 0; i < 4; ++i)
7723 if (!INTEGERP (XVECTOR (tem)->contents[i]))
7724 return 0;
7726 else
7727 return 0;
7729 return 1;
7733 /* Load Ghostscript image IMG for use on frame F. Value is non-zero
7734 if successful. */
7736 static int
7737 gs_load (f, img)
7738 struct frame *f;
7739 struct image *img;
7741 char buffer[100];
7742 Lisp_Object window_and_pixmap_id = Qnil, loader, pt_height, pt_width;
7743 struct gcpro gcpro1, gcpro2;
7744 Lisp_Object frame;
7745 double in_width, in_height;
7746 Lisp_Object pixel_colors = Qnil;
7748 /* Compute pixel size of pixmap needed from the given size in the
7749 image specification. Sizes in the specification are in pt. 1 pt
7750 = 1/72 in, xdpi and ydpi are stored in the frame's X display
7751 info. */
7752 pt_width = image_spec_value (img->spec, QCpt_width, NULL);
7753 in_width = XFASTINT (pt_width) / 72.0;
7754 img->width = in_width * FRAME_X_DISPLAY_INFO (f)->resx;
7755 pt_height = image_spec_value (img->spec, QCpt_height, NULL);
7756 in_height = XFASTINT (pt_height) / 72.0;
7757 img->height = in_height * FRAME_X_DISPLAY_INFO (f)->resy;
7759 /* Create the pixmap. */
7760 xassert (img->pixmap == NO_PIXMAP);
7762 /* Only W32 version did BLOCK_INPUT here. ++kfs */
7763 BLOCK_INPUT;
7764 img->pixmap = XCreatePixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7765 img->width, img->height,
7766 DefaultDepthOfScreen (FRAME_X_SCREEN (f)));
7767 UNBLOCK_INPUT;
7769 if (!img->pixmap)
7771 image_error ("Unable to create pixmap for `%s'", img->spec, Qnil);
7772 return 0;
7775 /* Call the loader to fill the pixmap. It returns a process object
7776 if successful. We do not record_unwind_protect here because
7777 other places in redisplay like calling window scroll functions
7778 don't either. Let the Lisp loader use `unwind-protect' instead. */
7779 GCPRO2 (window_and_pixmap_id, pixel_colors);
7781 sprintf (buffer, "%lu %lu",
7782 (unsigned long) FRAME_X_WINDOW (f),
7783 (unsigned long) img->pixmap);
7784 window_and_pixmap_id = build_string (buffer);
7786 sprintf (buffer, "%lu %lu",
7787 FRAME_FOREGROUND_PIXEL (f),
7788 FRAME_BACKGROUND_PIXEL (f));
7789 pixel_colors = build_string (buffer);
7791 XSETFRAME (frame, f);
7792 loader = image_spec_value (img->spec, QCloader, NULL);
7793 if (NILP (loader))
7794 loader = intern ("gs-load-image");
7796 img->data.lisp_val = call6 (loader, frame, img->spec,
7797 make_number (img->width),
7798 make_number (img->height),
7799 window_and_pixmap_id,
7800 pixel_colors);
7801 UNGCPRO;
7802 return PROCESSP (img->data.lisp_val);
7806 /* Kill the Ghostscript process that was started to fill PIXMAP on
7807 frame F. Called from XTread_socket when receiving an event
7808 telling Emacs that Ghostscript has finished drawing. */
7810 void
7811 x_kill_gs_process (pixmap, f)
7812 Pixmap pixmap;
7813 struct frame *f;
7815 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
7816 int class, i;
7817 struct image *img;
7819 /* Find the image containing PIXMAP. */
7820 for (i = 0; i < c->used; ++i)
7821 if (c->images[i]->pixmap == pixmap)
7822 break;
7824 /* Should someone in between have cleared the image cache, for
7825 instance, give up. */
7826 if (i == c->used)
7827 return;
7829 /* Kill the GS process. We should have found PIXMAP in the image
7830 cache and its image should contain a process object. */
7831 img = c->images[i];
7832 xassert (PROCESSP (img->data.lisp_val));
7833 Fkill_process (img->data.lisp_val, Qnil);
7834 img->data.lisp_val = Qnil;
7836 #if defined (HAVE_X_WINDOWS)
7838 /* On displays with a mutable colormap, figure out the colors
7839 allocated for the image by looking at the pixels of an XImage for
7840 img->pixmap. */
7841 class = FRAME_X_VISUAL (f)->class;
7842 if (class != StaticColor && class != StaticGray && class != TrueColor)
7844 XImagePtr ximg;
7846 BLOCK_INPUT;
7848 /* Try to get an XImage for img->pixmep. */
7849 ximg = XGetImage (FRAME_X_DISPLAY (f), img->pixmap,
7850 0, 0, img->width, img->height, ~0, ZPixmap);
7851 if (ximg)
7853 int x, y;
7855 /* Initialize the color table. */
7856 init_color_table ();
7858 /* For each pixel of the image, look its color up in the
7859 color table. After having done so, the color table will
7860 contain an entry for each color used by the image. */
7861 for (y = 0; y < img->height; ++y)
7862 for (x = 0; x < img->width; ++x)
7864 unsigned long pixel = XGetPixel (ximg, x, y);
7865 lookup_pixel_color (f, pixel);
7868 /* Record colors in the image. Free color table and XImage. */
7869 #ifdef COLOR_TABLE_SUPPORT
7870 img->colors = colors_in_color_table (&img->ncolors);
7871 free_color_table ();
7872 #endif
7873 XDestroyImage (ximg);
7875 #if 0 /* This doesn't seem to be the case. If we free the colors
7876 here, we get a BadAccess later in x_clear_image when
7877 freeing the colors. */
7878 /* We have allocated colors once, but Ghostscript has also
7879 allocated colors on behalf of us. So, to get the
7880 reference counts right, free them once. */
7881 if (img->ncolors)
7882 x_free_colors (f, img->colors, img->ncolors);
7883 #endif
7885 else
7886 image_error ("Cannot get X image of `%s'; colors will not be freed",
7887 img->spec, Qnil);
7889 UNBLOCK_INPUT;
7891 #endif /* HAVE_X_WINDOWS */
7893 /* Now that we have the pixmap, compute mask and transform the
7894 image if requested. */
7895 BLOCK_INPUT;
7896 postprocess_image (f, img);
7897 UNBLOCK_INPUT;
7900 #endif /* HAVE_GHOSTSCRIPT */
7903 /***********************************************************************
7904 Tests
7905 ***********************************************************************/
7907 #if GLYPH_DEBUG
7909 DEFUN ("imagep", Fimagep, Simagep, 1, 1, 0,
7910 doc: /* Value is non-nil if SPEC is a valid image specification. */)
7911 (spec)
7912 Lisp_Object spec;
7914 return valid_image_p (spec) ? Qt : Qnil;
7918 DEFUN ("lookup-image", Flookup_image, Slookup_image, 1, 1, 0, "")
7919 (spec)
7920 Lisp_Object spec;
7922 int id = -1;
7924 if (valid_image_p (spec))
7925 id = lookup_image (SELECTED_FRAME (), spec);
7927 debug_print (spec);
7928 return make_number (id);
7931 #endif /* GLYPH_DEBUG != 0 */
7934 /***********************************************************************
7935 Initialization
7936 ***********************************************************************/
7938 #ifdef HAVE_NTGUI
7939 /* Image types that rely on external libraries are loaded dynamically
7940 if the library is available. */
7941 #define CHECK_LIB_AVAILABLE(image_type, init_lib_fn, libraries) \
7942 define_image_type (image_type, init_lib_fn (libraries))
7943 #else
7944 #define CHECK_LIB_AVAILABLE(image_type, init_lib_fn, libraries) \
7945 define_image_type (image_type, 1)
7946 #endif /* HAVE_NTGUI */
7948 DEFUN ("init-image-library", Finit_image_library, Sinit_image_library, 2, 2, 0,
7949 doc: /* Initialize image library implementing image type TYPE.
7950 Return non-nil if TYPE is a supported image type.
7952 Image types pbm and xbm are prebuilt; other types are loaded here.
7953 Libraries to load are specified in alist LIBRARIES (usually, the value
7954 of `image-library-alist', which see). */)
7955 (type, libraries)
7956 Lisp_Object type, libraries;
7958 Lisp_Object tested;
7960 /* Don't try to reload the library. */
7961 tested = Fassq (type, Vimage_type_cache);
7962 if (CONSP (tested))
7963 return XCDR (tested);
7965 #if defined (HAVE_XPM) || defined (MAC_OS)
7966 if (EQ (type, Qxpm))
7967 return CHECK_LIB_AVAILABLE (&xpm_type, init_xpm_functions, libraries);
7968 #endif
7970 #if defined (HAVE_JPEG) || defined (MAC_OS)
7971 if (EQ (type, Qjpeg))
7972 return CHECK_LIB_AVAILABLE (&jpeg_type, init_jpeg_functions, libraries);
7973 #endif
7975 #if defined (HAVE_TIFF) || defined (MAC_OS)
7976 if (EQ (type, Qtiff))
7977 return CHECK_LIB_AVAILABLE (&tiff_type, init_tiff_functions, libraries);
7978 #endif
7980 #if defined (HAVE_GIF) || defined (MAC_OS)
7981 if (EQ (type, Qgif))
7982 return CHECK_LIB_AVAILABLE (&gif_type, init_gif_functions, libraries);
7983 #endif
7985 #if defined (HAVE_PNG) || defined (MAC_OS)
7986 if (EQ (type, Qpng))
7987 return CHECK_LIB_AVAILABLE (&png_type, init_png_functions, libraries);
7988 #endif
7990 #ifdef HAVE_GHOSTSCRIPT
7991 if (EQ (type, Qpostscript))
7992 return CHECK_LIB_AVAILABLE (&gs_type, init_gs_functions, libraries);
7993 #endif
7995 /* If the type is not recognized, avoid testing it ever again. */
7996 CACHE_IMAGE_TYPE (type, Qnil);
7997 return Qnil;
8000 void
8001 syms_of_image ()
8003 /* Must be defined now becase we're going to update it below, while
8004 defining the supported image types. */
8005 DEFVAR_LISP ("image-types", &Vimage_types,
8006 doc: /* List of potentially supported image types.
8007 Each element of the list is a symbol for a image type, like 'jpeg or 'png.
8008 To check whether it is really supported, use `image-type-available-p'. */);
8009 Vimage_types = Qnil;
8011 Vimage_type_cache = Qnil;
8012 staticpro (&Vimage_type_cache);
8014 QCascent = intern (":ascent");
8015 staticpro (&QCascent);
8016 QCmargin = intern (":margin");
8017 staticpro (&QCmargin);
8018 QCrelief = intern (":relief");
8019 staticpro (&QCrelief);
8020 QCconversion = intern (":conversion");
8021 staticpro (&QCconversion);
8022 QCcolor_symbols = intern (":color-symbols");
8023 staticpro (&QCcolor_symbols);
8024 QCheuristic_mask = intern (":heuristic-mask");
8025 staticpro (&QCheuristic_mask);
8026 QCindex = intern (":index");
8027 staticpro (&QCindex);
8028 QCmatrix = intern (":matrix");
8029 staticpro (&QCmatrix);
8030 QCcolor_adjustment = intern (":color-adjustment");
8031 staticpro (&QCcolor_adjustment);
8032 QCmask = intern (":mask");
8033 staticpro (&QCmask);
8035 Qlaplace = intern ("laplace");
8036 staticpro (&Qlaplace);
8037 Qemboss = intern ("emboss");
8038 staticpro (&Qemboss);
8039 Qedge_detection = intern ("edge-detection");
8040 staticpro (&Qedge_detection);
8041 Qheuristic = intern ("heuristic");
8042 staticpro (&Qheuristic);
8044 Qpostscript = intern ("postscript");
8045 staticpro (&Qpostscript);
8046 #ifdef HAVE_GHOSTSCRIPT
8047 ADD_IMAGE_TYPE(Qpostscript);
8048 QCloader = intern (":loader");
8049 staticpro (&QCloader);
8050 QCbounding_box = intern (":bounding-box");
8051 staticpro (&QCbounding_box);
8052 QCpt_width = intern (":pt-width");
8053 staticpro (&QCpt_width);
8054 QCpt_height = intern (":pt-height");
8055 staticpro (&QCpt_height);
8056 #endif /* HAVE_GHOSTSCRIPT */
8058 Qpbm = intern ("pbm");
8059 staticpro (&Qpbm);
8060 ADD_IMAGE_TYPE(Qpbm);
8062 Qxbm = intern ("xbm");
8063 staticpro (&Qxbm);
8064 ADD_IMAGE_TYPE(Qxbm);
8066 #if defined (HAVE_XPM) || defined (MAC_OS)
8067 Qxpm = intern ("xpm");
8068 staticpro (&Qxpm);
8069 ADD_IMAGE_TYPE(Qxpm);
8070 #endif
8072 #if defined (HAVE_JPEG) || defined (MAC_OS)
8073 Qjpeg = intern ("jpeg");
8074 staticpro (&Qjpeg);
8075 ADD_IMAGE_TYPE(Qjpeg);
8076 #endif
8078 #if defined (HAVE_TIFF) || defined (MAC_OS)
8079 Qtiff = intern ("tiff");
8080 staticpro (&Qtiff);
8081 ADD_IMAGE_TYPE(Qtiff);
8082 #endif
8084 #if defined (HAVE_GIF) || defined (MAC_OS)
8085 Qgif = intern ("gif");
8086 staticpro (&Qgif);
8087 ADD_IMAGE_TYPE(Qgif);
8088 #endif
8090 #if defined (HAVE_PNG) || defined (MAC_OS)
8091 Qpng = intern ("png");
8092 staticpro (&Qpng);
8093 ADD_IMAGE_TYPE(Qpng);
8094 #endif
8096 defsubr (&Sinit_image_library);
8097 defsubr (&Sclear_image_cache);
8098 defsubr (&Simage_size);
8099 defsubr (&Simage_mask_p);
8101 #if GLYPH_DEBUG
8102 defsubr (&Simagep);
8103 defsubr (&Slookup_image);
8104 #endif
8106 DEFVAR_BOOL ("cross-disabled-images", &cross_disabled_images,
8107 doc: /* Non-nil means always draw a cross over disabled images.
8108 Disabled images are those having an `:conversion disabled' property.
8109 A cross is always drawn on black & white displays. */);
8110 cross_disabled_images = 0;
8112 DEFVAR_LISP ("x-bitmap-file-path", &Vx_bitmap_file_path,
8113 doc: /* List of directories to search for window system bitmap files. */);
8114 Vx_bitmap_file_path = decode_env_path ((char *) 0, PATH_BITMAPS);
8116 DEFVAR_LISP ("image-cache-eviction-delay", &Vimage_cache_eviction_delay,
8117 doc: /* Time after which cached images are removed from the cache.
8118 When an image has not been displayed this many seconds, remove it
8119 from the image cache. Value must be an integer or nil with nil
8120 meaning don't clear the cache. */);
8121 Vimage_cache_eviction_delay = make_number (30 * 60);
8124 void
8125 init_image ()
8127 image_types = NULL;
8129 define_image_type (&xbm_type, 1);
8130 define_image_type (&pbm_type, 1);
8132 #ifdef MAC_OS
8133 /* Animated gifs use QuickTime Movie Toolbox. So initialize it here. */
8134 EnterMovies ();
8135 #ifdef MAC_OSX
8136 init_image_func_pointer ();
8137 #endif
8138 #endif
8141 /* arch-tag: 123c2a5e-14a8-4c53-ab95-af47d7db49b9
8142 (do not change this comment) */