1 /* Functions for image support on window system.
3 Copyright (C) 1989, 1992-2014 Free Software Foundation, Inc.
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 3 of the License, or
10 (at your option) 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. If not, see <http://www.gnu.org/licenses/>. */
24 /* Include this before including <setjmp.h> to work around bugs with
25 older libpng; see Bug#17429. */
26 #if defined HAVE_PNG && !defined HAVE_NS
36 #include "dispextern.h"
37 #include "blockinput.h"
40 #include "character.h"
42 #include "termhooks.h"
45 #ifdef HAVE_SYS_STAT_H
47 #endif /* HAVE_SYS_STAT_H */
49 #ifdef HAVE_SYS_TYPES_H
50 #include <sys/types.h>
51 #endif /* HAVE_SYS_TYPES_H */
53 #ifdef HAVE_WINDOW_SYSTEM
55 #endif /* HAVE_WINDOW_SYSTEM */
58 #define COLOR_TABLE_SUPPORT 1
60 typedef struct x_bitmap_record Bitmap_Record
;
61 #define GET_PIXEL(ximg, x, y) XGetPixel (ximg, x, y)
62 #define NO_PIXMAP None
64 #define PIX_MASK_RETAIN 0
65 #define PIX_MASK_DRAW 1
66 #endif /* HAVE_X_WINDOWS */
70 /* We need (or want) w32.h only when we're _not_ compiling for Cygwin. */
75 /* W32_TODO : Color tables on W32. */
76 #undef COLOR_TABLE_SUPPORT
78 typedef struct w32_bitmap_record Bitmap_Record
;
79 #define GET_PIXEL(ximg, x, y) GetPixel (ximg, x, y)
82 #define PIX_MASK_RETAIN 0
83 #define PIX_MASK_DRAW 1
85 #define x_defined_color w32_defined_color
86 #define DefaultDepthOfScreen(screen) (one_w32_display_info.n_cbits)
88 /* Versions of libpng, libgif, and libjpeg that we were compiled with,
89 or -1 if no PNG/GIF support was compiled in. This is tested by
90 w32-win.el to correctly set up the alist used to search for the
91 respective image libraries. */
92 Lisp_Object Qlibpng_version
, Qlibgif_version
, Qlibjpeg_version
;
94 #endif /* HAVE_NTGUI */
97 #undef COLOR_TABLE_SUPPORT
99 typedef struct ns_bitmap_record Bitmap_Record
;
101 #define GET_PIXEL(ximg, x, y) XGetPixel (ximg, x, y)
104 #define PIX_MASK_RETAIN 0
105 #define PIX_MASK_DRAW 1
107 #define x_defined_color(f, name, color_def, alloc) \
108 ns_defined_color (f, name, color_def, alloc, 0)
109 #define DefaultDepthOfScreen(screen) x_display_list->n_planes
113 /* The symbol `postscript' identifying images of this type. */
115 static Lisp_Object Qpostscript
;
117 static void x_disable_image (struct frame
*, struct image
*);
118 static void x_edge_detection (struct frame
*, struct image
*, Lisp_Object
,
121 static void init_color_table (void);
122 static unsigned long lookup_rgb_color (struct frame
*f
, int r
, int g
, int b
);
123 #ifdef COLOR_TABLE_SUPPORT
124 static void free_color_table (void);
125 static unsigned long *colors_in_color_table (int *n
);
128 static Lisp_Object QCmax_width
, QCmax_height
;
130 /* Code to deal with bitmaps. Bitmaps are referenced by their bitmap
131 id, which is just an int that this section returns. Bitmaps are
132 reference counted so they can be shared among frames.
134 Bitmap indices are guaranteed to be > 0, so a negative number can
135 be used to indicate no bitmap.
137 If you use x_create_bitmap_from_data, then you must keep track of
138 the bitmaps yourself. That is, creating a bitmap from the same
139 data more than once will not be caught. */
142 /* Use with images created by ns_image_for_XPM. */
144 XGetPixel (XImagePtr ximage
, int x
, int y
)
146 return ns_get_pixel (ximage
, x
, y
);
149 /* Use with images created by ns_image_for_XPM; alpha set to 1;
150 pixel is assumed to be in RGB form. */
152 XPutPixel (XImagePtr ximage
, int x
, int y
, unsigned long pixel
)
154 ns_put_pixel (ximage
, x
, y
, pixel
);
159 /* Functions to access the contents of a bitmap, given an id. */
161 #ifdef HAVE_X_WINDOWS
163 x_bitmap_height (struct frame
*f
, ptrdiff_t id
)
165 return FRAME_DISPLAY_INFO (f
)->bitmaps
[id
- 1].height
;
169 x_bitmap_width (struct frame
*f
, ptrdiff_t id
)
171 return FRAME_DISPLAY_INFO (f
)->bitmaps
[id
- 1].width
;
175 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI)
177 x_bitmap_pixmap (struct frame
*f
, ptrdiff_t id
)
179 /* HAVE_NTGUI needs the explicit cast here. */
180 return (ptrdiff_t) FRAME_DISPLAY_INFO (f
)->bitmaps
[id
- 1].pixmap
;
184 #ifdef HAVE_X_WINDOWS
186 x_bitmap_mask (struct frame
*f
, ptrdiff_t id
)
188 return FRAME_DISPLAY_INFO (f
)->bitmaps
[id
- 1].mask
;
192 /* Allocate a new bitmap record. Returns index of new record. */
195 x_allocate_bitmap_record (struct frame
*f
)
197 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
200 if (dpyinfo
->bitmaps_last
< dpyinfo
->bitmaps_size
)
201 return ++dpyinfo
->bitmaps_last
;
203 for (i
= 0; i
< dpyinfo
->bitmaps_size
; ++i
)
204 if (dpyinfo
->bitmaps
[i
].refcount
== 0)
208 xpalloc (dpyinfo
->bitmaps
, &dpyinfo
->bitmaps_size
,
209 10, -1, sizeof *dpyinfo
->bitmaps
);
210 return ++dpyinfo
->bitmaps_last
;
213 /* Add one reference to the reference count of the bitmap with id ID. */
216 x_reference_bitmap (struct frame
*f
, ptrdiff_t id
)
218 ++FRAME_DISPLAY_INFO (f
)->bitmaps
[id
- 1].refcount
;
221 /* Create a bitmap for frame F from a HEIGHT x WIDTH array of bits at BITS. */
224 x_create_bitmap_from_data (struct frame
*f
, char *bits
, unsigned int width
, unsigned int height
)
226 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
229 #ifdef HAVE_X_WINDOWS
231 bitmap
= XCreateBitmapFromData (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
232 bits
, width
, height
);
235 #endif /* HAVE_X_WINDOWS */
239 bitmap
= CreateBitmap (width
, height
,
240 FRAME_DISPLAY_INFO (XFRAME (frame
))->n_planes
,
241 FRAME_DISPLAY_INFO (XFRAME (frame
))->n_cbits
,
245 #endif /* HAVE_NTGUI */
248 void *bitmap
= ns_image_from_XBM (bits
, width
, height
);
253 id
= x_allocate_bitmap_record (f
);
256 dpyinfo
->bitmaps
[id
- 1].img
= bitmap
;
257 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
260 dpyinfo
->bitmaps
[id
- 1].file
= NULL
;
261 dpyinfo
->bitmaps
[id
- 1].height
= height
;
262 dpyinfo
->bitmaps
[id
- 1].width
= width
;
263 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
265 #ifdef HAVE_X_WINDOWS
266 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
267 dpyinfo
->bitmaps
[id
- 1].have_mask
= false;
268 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
269 #endif /* HAVE_X_WINDOWS */
272 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
273 dpyinfo
->bitmaps
[id
- 1].hinst
= NULL
;
274 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
275 #endif /* HAVE_NTGUI */
280 /* Create bitmap from file FILE for frame F. */
283 x_create_bitmap_from_file (struct frame
*f
, Lisp_Object file
)
285 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
288 return -1; /* W32_TODO : bitmap support */
289 #endif /* HAVE_NTGUI */
293 void *bitmap
= ns_image_from_file (file
);
299 id
= x_allocate_bitmap_record (f
);
300 dpyinfo
->bitmaps
[id
- 1].img
= bitmap
;
301 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
302 dpyinfo
->bitmaps
[id
- 1].file
= xlispstrdup (file
);
303 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
304 dpyinfo
->bitmaps
[id
- 1].height
= ns_image_width (bitmap
);
305 dpyinfo
->bitmaps
[id
- 1].width
= ns_image_height (bitmap
);
309 #ifdef HAVE_X_WINDOWS
310 unsigned int width
, height
;
312 int xhot
, yhot
, result
;
317 /* Look for an existing bitmap with the same name. */
318 for (id
= 0; id
< dpyinfo
->bitmaps_last
; ++id
)
320 if (dpyinfo
->bitmaps
[id
].refcount
321 && dpyinfo
->bitmaps
[id
].file
322 && !strcmp (dpyinfo
->bitmaps
[id
].file
, SSDATA (file
)))
324 ++dpyinfo
->bitmaps
[id
].refcount
;
329 /* Search bitmap-file-path for the file, if appropriate. */
330 if (openp (Vx_bitmap_file_path
, file
, Qnil
, &found
,
331 make_number (R_OK
), false)
335 filename
= SSDATA (found
);
337 result
= XReadBitmapFile (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
338 filename
, &width
, &height
, &bitmap
, &xhot
, &yhot
);
339 if (result
!= BitmapSuccess
)
342 id
= x_allocate_bitmap_record (f
);
343 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
344 dpyinfo
->bitmaps
[id
- 1].have_mask
= false;
345 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
346 dpyinfo
->bitmaps
[id
- 1].file
= xlispstrdup (file
);
347 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
348 dpyinfo
->bitmaps
[id
- 1].height
= height
;
349 dpyinfo
->bitmaps
[id
- 1].width
= width
;
352 #endif /* HAVE_X_WINDOWS */
358 free_bitmap_record (Display_Info
*dpyinfo
, Bitmap_Record
*bm
)
360 #ifdef HAVE_X_WINDOWS
361 XFreePixmap (dpyinfo
->display
, bm
->pixmap
);
363 XFreePixmap (dpyinfo
->display
, bm
->mask
);
364 #endif /* HAVE_X_WINDOWS */
367 DeleteObject (bm
->pixmap
);
368 #endif /* HAVE_NTGUI */
371 ns_release_object (bm
->img
);
381 /* Remove reference to bitmap with id number ID. */
384 x_destroy_bitmap (struct frame
*f
, ptrdiff_t id
)
386 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
390 Bitmap_Record
*bm
= &dpyinfo
->bitmaps
[id
- 1];
392 if (--bm
->refcount
== 0)
395 free_bitmap_record (dpyinfo
, bm
);
401 /* Free all the bitmaps for the display specified by DPYINFO. */
404 x_destroy_all_bitmaps (Display_Info
*dpyinfo
)
407 Bitmap_Record
*bm
= dpyinfo
->bitmaps
;
409 for (i
= 0; i
< dpyinfo
->bitmaps_last
; i
++, bm
++)
410 if (bm
->refcount
> 0)
411 free_bitmap_record (dpyinfo
, bm
);
413 dpyinfo
->bitmaps_last
= 0;
416 static bool x_create_x_image_and_pixmap (struct frame
*, int, int, int,
417 XImagePtr
*, Pixmap
*);
418 static void x_destroy_x_image (XImagePtr ximg
);
421 static XImagePtr_or_DC
image_get_x_image_or_dc (struct frame
*, struct image
*,
423 static void image_unget_x_image_or_dc (struct image
*, bool, XImagePtr_or_DC
,
426 static XImagePtr
image_get_x_image (struct frame
*, struct image
*, bool);
427 static void image_unget_x_image (struct image
*, bool, XImagePtr
);
428 #define image_get_x_image_or_dc(f, img, mask_p, dummy) \
429 image_get_x_image (f, img, mask_p)
430 #define image_unget_x_image_or_dc(img, mask_p, ximg, dummy) \
431 image_unget_x_image (img, mask_p, ximg)
434 #ifdef HAVE_X_WINDOWS
436 static void image_sync_to_pixmaps (struct frame
*, struct image
*);
438 /* Useful functions defined in the section
439 `Image type independent image structures' below. */
441 static unsigned long four_corners_best (XImagePtr ximg
,
444 unsigned long height
);
447 /* Create a mask of a bitmap. Note is this not a perfect mask.
448 It's nicer with some borders in this context */
451 x_create_bitmap_mask (struct frame
*f
, ptrdiff_t id
)
454 XImagePtr ximg
, mask_img
;
455 unsigned long width
, height
;
458 unsigned long x
, y
, xp
, xm
, yp
, ym
;
461 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
466 pixmap
= x_bitmap_pixmap (f
, id
);
467 width
= x_bitmap_width (f
, id
);
468 height
= x_bitmap_height (f
, id
);
471 ximg
= XGetImage (FRAME_X_DISPLAY (f
), pixmap
, 0, 0, width
, height
,
480 result
= x_create_x_image_and_pixmap (f
, width
, height
, 1, &mask_img
, &mask
);
485 XDestroyImage (ximg
);
489 bg
= four_corners_best (ximg
, NULL
, width
, height
);
491 for (y
= 0; y
< ximg
->height
; ++y
)
493 for (x
= 0; x
< ximg
->width
; ++x
)
495 xp
= x
!= ximg
->width
- 1 ? x
+ 1 : 0;
496 xm
= x
!= 0 ? x
- 1 : ximg
->width
- 1;
497 yp
= y
!= ximg
->height
- 1 ? y
+ 1 : 0;
498 ym
= y
!= 0 ? y
- 1 : ximg
->height
- 1;
499 if (XGetPixel (ximg
, x
, y
) == bg
500 && XGetPixel (ximg
, x
, yp
) == bg
501 && XGetPixel (ximg
, x
, ym
) == bg
502 && XGetPixel (ximg
, xp
, y
) == bg
503 && XGetPixel (ximg
, xp
, yp
) == bg
504 && XGetPixel (ximg
, xp
, ym
) == bg
505 && XGetPixel (ximg
, xm
, y
) == bg
506 && XGetPixel (ximg
, xm
, yp
) == bg
507 && XGetPixel (ximg
, xm
, ym
) == bg
)
508 XPutPixel (mask_img
, x
, y
, 0);
510 XPutPixel (mask_img
, x
, y
, 1);
514 eassert (input_blocked_p ());
515 gc
= XCreateGC (FRAME_X_DISPLAY (f
), mask
, 0, NULL
);
516 XPutImage (FRAME_X_DISPLAY (f
), mask
, gc
, mask_img
, 0, 0, 0, 0,
518 XFreeGC (FRAME_X_DISPLAY (f
), gc
);
520 dpyinfo
->bitmaps
[id
- 1].have_mask
= true;
521 dpyinfo
->bitmaps
[id
- 1].mask
= mask
;
523 XDestroyImage (ximg
);
524 x_destroy_x_image (mask_img
);
527 #endif /* HAVE_X_WINDOWS */
530 /***********************************************************************
532 ***********************************************************************/
534 /* List of supported image types. Use define_image_type to add new
535 types. Use lookup_image_type to find a type for a given symbol. */
537 static struct image_type
*image_types
;
539 /* The symbol `xbm' which is used as the type symbol for XBM images. */
541 static Lisp_Object Qxbm
;
545 Lisp_Object QCascent
, QCmargin
, QCrelief
;
546 Lisp_Object QCconversion
;
547 static Lisp_Object QCheuristic_mask
;
548 static Lisp_Object QCcolor_symbols
;
549 static Lisp_Object QCindex
, QCmatrix
, QCcolor_adjustment
, QCmask
, QCgeometry
;
550 static Lisp_Object QCcrop
, QCrotation
;
554 static Lisp_Object Qcount
, Qextension_data
, Qdelay
;
555 static Lisp_Object Qlaplace
, Qemboss
, Qedge_detection
, Qheuristic
;
557 /* Forward function prototypes. */
559 static struct image_type
*lookup_image_type (Lisp_Object
);
560 static void x_laplace (struct frame
*, struct image
*);
561 static void x_emboss (struct frame
*, struct image
*);
562 static void x_build_heuristic_mask (struct frame
*, struct image
*,
565 #define CACHE_IMAGE_TYPE(type, status) \
566 do { Vlibrary_cache = Fcons (Fcons (type, status), Vlibrary_cache); } while (0)
568 #define CACHE_IMAGE_TYPE(type, status)
571 #define ADD_IMAGE_TYPE(type) \
572 do { Vimage_types = Fcons (type, Vimage_types); } while (0)
574 /* Define a new image type from TYPE. This adds a copy of TYPE to
575 image_types and caches the loading status of TYPE. */
577 static struct image_type
*
578 define_image_type (struct image_type
*type
)
580 struct image_type
*p
= NULL
;
581 Lisp_Object target_type
= *type
->type
;
586 for (p
= image_types
; p
; p
= p
->next
)
587 if (EQ (*p
->type
, target_type
))
592 #if defined HAVE_NTGUI && defined WINDOWSNT
593 /* If we failed to load the library before, don't try again. */
594 Lisp_Object tested
= Fassq (target_type
, Vlibrary_cache
);
595 if (CONSP (tested
) && NILP (XCDR (tested
)))
600 type_valid
= type
->init ();
601 CACHE_IMAGE_TYPE (target_type
, type_valid
? Qt
: Qnil
);
607 /* Make a copy of TYPE to avoid a bus error in a dumped Emacs.
608 The initialized data segment is read-only. */
609 p
= xmalloc (sizeof *p
);
611 p
->next
= image_types
;
621 /* Value is true if OBJECT is a valid Lisp image specification. A
622 valid image specification is a list whose car is the symbol
623 `image', and whose rest is a property list. The property list must
624 contain a value for key `:type'. That value must be the name of a
625 supported image type. The rest of the property list depends on the
629 valid_image_p (Lisp_Object object
)
637 for (tem
= XCDR (object
); CONSP (tem
); tem
= XCDR (tem
))
638 if (EQ (XCAR (tem
), QCtype
))
641 if (CONSP (tem
) && SYMBOLP (XCAR (tem
)))
643 struct image_type
*type
;
644 type
= lookup_image_type (XCAR (tem
));
646 valid_p
= type
->valid_p (object
);
657 /* Log error message with format string FORMAT and argument ARG.
658 Signaling an error, e.g. when an image cannot be loaded, is not a
659 good idea because this would interrupt redisplay, and the error
660 message display would lead to another redisplay. This function
661 therefore simply displays a message. */
664 image_error (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
666 add_to_log (format
, arg1
, arg2
);
671 /***********************************************************************
673 ***********************************************************************/
675 enum image_value_type
677 IMAGE_DONT_CHECK_VALUE_TYPE
,
679 IMAGE_STRING_OR_NIL_VALUE
,
681 IMAGE_POSITIVE_INTEGER_VALUE
,
682 IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
,
683 IMAGE_NON_NEGATIVE_INTEGER_VALUE
,
686 IMAGE_FUNCTION_VALUE
,
691 /* Structure used when parsing image specifications. */
695 /* Name of keyword. */
698 /* The type of value allowed. */
699 enum image_value_type type
;
701 /* True means key must be present. */
704 /* Used to recognize duplicate keywords in a property list. */
707 /* The value that was found. */
712 /* Parse image spec SPEC according to KEYWORDS. A valid image spec
713 has the format (image KEYWORD VALUE ...). One of the keyword/
714 value pairs must be `:type TYPE'. KEYWORDS is a vector of
715 image_keywords structures of size NKEYWORDS describing other
716 allowed keyword/value pairs. Value is true if SPEC is valid. */
719 parse_image_spec (Lisp_Object spec
, struct image_keyword
*keywords
,
720 int nkeywords
, Lisp_Object type
)
729 while (CONSP (plist
))
731 Lisp_Object key
, value
;
733 /* First element of a pair must be a symbol. */
735 plist
= XCDR (plist
);
739 /* There must follow a value. */
742 value
= XCAR (plist
);
743 plist
= XCDR (plist
);
745 /* Find key in KEYWORDS. Error if not found. */
746 for (i
= 0; i
< nkeywords
; ++i
)
747 if (strcmp (keywords
[i
].name
, SSDATA (SYMBOL_NAME (key
))) == 0)
753 /* Record that we recognized the keyword. If a keywords
754 was found more than once, it's an error. */
755 keywords
[i
].value
= value
;
756 if (keywords
[i
].count
> 1)
760 /* Check type of value against allowed type. */
761 switch (keywords
[i
].type
)
763 case IMAGE_STRING_VALUE
:
764 if (!STRINGP (value
))
768 case IMAGE_STRING_OR_NIL_VALUE
:
769 if (!STRINGP (value
) && !NILP (value
))
773 case IMAGE_SYMBOL_VALUE
:
774 if (!SYMBOLP (value
))
778 case IMAGE_POSITIVE_INTEGER_VALUE
:
779 if (! RANGED_INTEGERP (1, value
, INT_MAX
))
783 case IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
:
784 if (RANGED_INTEGERP (0, value
, INT_MAX
))
787 && RANGED_INTEGERP (0, XCAR (value
), INT_MAX
)
788 && RANGED_INTEGERP (0, XCDR (value
), INT_MAX
))
792 case IMAGE_ASCENT_VALUE
:
793 if (SYMBOLP (value
) && EQ (value
, Qcenter
))
795 else if (RANGED_INTEGERP (0, value
, 100))
799 case IMAGE_NON_NEGATIVE_INTEGER_VALUE
:
800 /* Unlike the other integer-related cases, this one does not
801 verify that VALUE fits in 'int'. This is because callers
803 if (!INTEGERP (value
) || XINT (value
) < 0)
807 case IMAGE_DONT_CHECK_VALUE_TYPE
:
810 case IMAGE_FUNCTION_VALUE
:
811 value
= indirect_function (value
);
812 if (!NILP (Ffunctionp (value
)))
816 case IMAGE_NUMBER_VALUE
:
817 if (!INTEGERP (value
) && !FLOATP (value
))
821 case IMAGE_INTEGER_VALUE
:
822 if (! TYPE_RANGED_INTEGERP (int, value
))
826 case IMAGE_BOOL_VALUE
:
827 if (!NILP (value
) && !EQ (value
, Qt
))
836 if (EQ (key
, QCtype
) && !EQ (type
, value
))
840 /* Check that all mandatory fields are present. */
841 for (i
= 0; i
< nkeywords
; ++i
)
842 if (keywords
[i
].mandatory_p
&& keywords
[i
].count
== 0)
849 /* Return the value of KEY in image specification SPEC. Value is nil
850 if KEY is not present in SPEC. Set *FOUND depending on whether KEY
851 was found in SPEC. */
854 image_spec_value (Lisp_Object spec
, Lisp_Object key
, bool *found
)
858 eassert (valid_image_p (spec
));
860 for (tail
= XCDR (spec
);
861 CONSP (tail
) && CONSP (XCDR (tail
));
862 tail
= XCDR (XCDR (tail
)))
864 if (EQ (XCAR (tail
), key
))
868 return XCAR (XCDR (tail
));
878 DEFUN ("image-size", Fimage_size
, Simage_size
, 1, 3, 0,
879 doc
: /* Return the size of image SPEC as pair (WIDTH . HEIGHT).
880 PIXELS non-nil means return the size in pixels, otherwise return the
881 size in canonical character units.
882 FRAME is the frame on which the image will be displayed. FRAME nil
883 or omitted means use the selected frame. */)
884 (Lisp_Object spec
, Lisp_Object pixels
, Lisp_Object frame
)
889 if (valid_image_p (spec
))
891 struct frame
*f
= decode_window_system_frame (frame
);
892 ptrdiff_t id
= lookup_image (f
, spec
);
893 struct image
*img
= IMAGE_FROM_ID (f
, id
);
894 int width
= img
->width
+ 2 * img
->hmargin
;
895 int height
= img
->height
+ 2 * img
->vmargin
;
898 size
= Fcons (make_float ((double) width
/ FRAME_COLUMN_WIDTH (f
)),
899 make_float ((double) height
/ FRAME_LINE_HEIGHT (f
)));
901 size
= Fcons (make_number (width
), make_number (height
));
904 error ("Invalid image specification");
910 DEFUN ("image-mask-p", Fimage_mask_p
, Simage_mask_p
, 1, 2, 0,
911 doc
: /* Return t if image SPEC has a mask bitmap.
912 FRAME is the frame on which the image will be displayed. FRAME nil
913 or omitted means use the selected frame. */)
914 (Lisp_Object spec
, Lisp_Object frame
)
919 if (valid_image_p (spec
))
921 struct frame
*f
= decode_window_system_frame (frame
);
922 ptrdiff_t id
= lookup_image (f
, spec
);
923 struct image
*img
= IMAGE_FROM_ID (f
, id
);
928 error ("Invalid image specification");
933 DEFUN ("image-metadata", Fimage_metadata
, Simage_metadata
, 1, 2, 0,
934 doc
: /* Return metadata for image SPEC.
935 FRAME is the frame on which the image will be displayed. FRAME nil
936 or omitted means use the selected frame. */)
937 (Lisp_Object spec
, Lisp_Object frame
)
942 if (valid_image_p (spec
))
944 struct frame
*f
= decode_window_system_frame (frame
);
945 ptrdiff_t id
= lookup_image (f
, spec
);
946 struct image
*img
= IMAGE_FROM_ID (f
, id
);
947 ext
= img
->lisp_data
;
954 /***********************************************************************
955 Image type independent image structures
956 ***********************************************************************/
958 #define MAX_IMAGE_SIZE 10.0
959 /* Allocate and return a new image structure for image specification
960 SPEC. SPEC has a hash value of HASH. */
962 static struct image
*
963 make_image (Lisp_Object spec
, EMACS_UINT hash
)
965 struct image
*img
= xzalloc (sizeof *img
);
966 Lisp_Object file
= image_spec_value (spec
, QCfile
, NULL
);
968 eassert (valid_image_p (spec
));
969 img
->dependencies
= NILP (file
) ? Qnil
: list1 (file
);
970 img
->type
= lookup_image_type (image_spec_value (spec
, QCtype
, NULL
));
971 eassert (img
->type
!= NULL
);
973 img
->lisp_data
= Qnil
;
974 img
->ascent
= DEFAULT_IMAGE_ASCENT
;
976 img
->corners
[BOT_CORNER
] = -1; /* Full image */
981 /* Free image IMG which was used on frame F, including its resources. */
984 free_image (struct frame
*f
, struct image
*img
)
988 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
990 /* Remove IMG from the hash table of its cache. */
992 img
->prev
->next
= img
->next
;
994 c
->buckets
[img
->hash
% IMAGE_CACHE_BUCKETS_SIZE
] = img
->next
;
997 img
->next
->prev
= img
->prev
;
999 c
->images
[img
->id
] = NULL
;
1001 /* Windows NT redefines 'free', but in this file, we need to
1002 avoid the redefinition. */
1006 /* Free resources, then free IMG. */
1007 img
->type
->free (f
, img
);
1012 /* Return true if the given widths and heights are valid for display. */
1015 check_image_size (struct frame
*f
, int width
, int height
)
1019 if (width
<= 0 || height
<= 0)
1022 if (INTEGERP (Vmax_image_size
))
1023 return (width
<= XINT (Vmax_image_size
)
1024 && height
<= XINT (Vmax_image_size
));
1025 else if (FLOATP (Vmax_image_size
))
1029 w
= FRAME_PIXEL_WIDTH (f
);
1030 h
= FRAME_PIXEL_HEIGHT (f
);
1033 w
= h
= 1024; /* Arbitrary size for unknown frame. */
1034 return (width
<= XFLOAT_DATA (Vmax_image_size
) * w
1035 && height
<= XFLOAT_DATA (Vmax_image_size
) * h
);
1041 /* Prepare image IMG for display on frame F. Must be called before
1042 drawing an image. */
1045 prepare_image_for_display (struct frame
*f
, struct image
*img
)
1047 /* We're about to display IMG, so set its timestamp to `now'. */
1048 img
->timestamp
= current_timespec ();
1050 /* If IMG doesn't have a pixmap yet, load it now, using the image
1051 type dependent loader function. */
1052 if (img
->pixmap
== NO_PIXMAP
&& !img
->load_failed_p
)
1053 img
->load_failed_p
= ! img
->type
->load (f
, img
);
1055 #ifdef HAVE_X_WINDOWS
1056 if (!img
->load_failed_p
)
1059 image_sync_to_pixmaps (f
, img
);
1066 /* Value is the number of pixels for the ascent of image IMG when
1067 drawn in face FACE. */
1070 image_ascent (struct image
*img
, struct face
*face
, struct glyph_slice
*slice
)
1075 if (slice
->height
== img
->height
)
1076 height
= img
->height
+ img
->vmargin
;
1077 else if (slice
->y
== 0)
1078 height
= slice
->height
+ img
->vmargin
;
1080 height
= slice
->height
;
1082 if (img
->ascent
== CENTERED_IMAGE_ASCENT
)
1087 /* W32 specific version. Why?. ++kfs */
1088 ascent
= height
/ 2 - (FONT_DESCENT (face
->font
)
1089 - FONT_BASE (face
->font
)) / 2;
1091 /* This expression is arranged so that if the image can't be
1092 exactly centered, it will be moved slightly up. This is
1093 because a typical font is `top-heavy' (due to the presence
1094 uppercase letters), so the image placement should err towards
1095 being top-heavy too. It also just generally looks better. */
1096 ascent
= (height
+ FONT_BASE (face
->font
)
1097 - FONT_DESCENT (face
->font
) + 1) / 2;
1098 #endif /* HAVE_NTGUI */
1101 ascent
= height
/ 2;
1104 ascent
= height
* (img
->ascent
/ 100.0);
1110 /* Image background colors. */
1112 /* Find the "best" corner color of a bitmap.
1113 On W32, XIMG is assumed to a device context with the bitmap selected. */
1115 static RGB_PIXEL_COLOR
1116 four_corners_best (XImagePtr_or_DC ximg
, int *corners
,
1117 unsigned long width
, unsigned long height
)
1119 RGB_PIXEL_COLOR corner_pixels
[4], best
IF_LINT (= 0);
1122 if (corners
&& corners
[BOT_CORNER
] >= 0)
1124 /* Get the colors at the corner_pixels of ximg. */
1125 corner_pixels
[0] = GET_PIXEL (ximg
, corners
[LEFT_CORNER
], corners
[TOP_CORNER
]);
1126 corner_pixels
[1] = GET_PIXEL (ximg
, corners
[RIGHT_CORNER
] - 1, corners
[TOP_CORNER
]);
1127 corner_pixels
[2] = GET_PIXEL (ximg
, corners
[RIGHT_CORNER
] - 1, corners
[BOT_CORNER
] - 1);
1128 corner_pixels
[3] = GET_PIXEL (ximg
, corners
[LEFT_CORNER
], corners
[BOT_CORNER
] - 1);
1132 /* Get the colors at the corner_pixels of ximg. */
1133 corner_pixels
[0] = GET_PIXEL (ximg
, 0, 0);
1134 corner_pixels
[1] = GET_PIXEL (ximg
, width
- 1, 0);
1135 corner_pixels
[2] = GET_PIXEL (ximg
, width
- 1, height
- 1);
1136 corner_pixels
[3] = GET_PIXEL (ximg
, 0, height
- 1);
1138 /* Choose the most frequently found color as background. */
1139 for (i
= best_count
= 0; i
< 4; ++i
)
1143 for (j
= n
= 0; j
< 4; ++j
)
1144 if (corner_pixels
[i
] == corner_pixels
[j
])
1148 best
= corner_pixels
[i
], best_count
= n
;
1154 /* Portability macros */
1158 #define Free_Pixmap(display, pixmap) \
1159 DeleteObject (pixmap)
1161 #elif defined (HAVE_NS)
1163 #define Free_Pixmap(display, pixmap) \
1164 ns_release_object (pixmap)
1168 #define Free_Pixmap(display, pixmap) \
1169 XFreePixmap (display, pixmap)
1171 #endif /* !HAVE_NTGUI && !HAVE_NS */
1174 /* Return the `background' field of IMG. If IMG doesn't have one yet,
1175 it is guessed heuristically. If non-zero, XIMG is an existing
1176 XImage object (or device context with the image selected on W32) to
1177 use for the heuristic. */
1180 image_background (struct image
*img
, struct frame
*f
, XImagePtr_or_DC ximg
)
1182 if (! img
->background_valid
)
1183 /* IMG doesn't have a background yet, try to guess a reasonable value. */
1185 bool free_ximg
= !ximg
;
1188 #endif /* HAVE_NTGUI */
1191 ximg
= image_get_x_image_or_dc (f
, img
, 0, &prev
);
1193 img
->background
= four_corners_best (ximg
, img
->corners
, img
->width
, img
->height
);
1196 image_unget_x_image_or_dc (img
, 0, ximg
, prev
);
1198 img
->background_valid
= 1;
1201 return img
->background
;
1204 /* Return the `background_transparent' field of IMG. If IMG doesn't
1205 have one yet, it is guessed heuristically. If non-zero, MASK is an
1206 existing XImage object to use for the heuristic. */
1209 image_background_transparent (struct image
*img
, struct frame
*f
, XImagePtr_or_DC mask
)
1211 if (! img
->background_transparent_valid
)
1212 /* IMG doesn't have a background yet, try to guess a reasonable value. */
1216 bool free_mask
= !mask
;
1219 #endif /* HAVE_NTGUI */
1222 mask
= image_get_x_image_or_dc (f
, img
, 1, &prev
);
1224 img
->background_transparent
1225 = (four_corners_best (mask
, img
->corners
, img
->width
, img
->height
) == PIX_MASK_RETAIN
);
1228 image_unget_x_image_or_dc (img
, 1, mask
, prev
);
1231 img
->background_transparent
= 0;
1233 img
->background_transparent_valid
= 1;
1236 return img
->background_transparent
;
1239 #if defined (HAVE_PNG) || defined (HAVE_NS) \
1240 || defined (HAVE_IMAGEMAGICK) || defined (HAVE_RSVG)
1242 /* Store F's background color into *BGCOLOR. */
1244 x_query_frame_background_color (struct frame
*f
, XColor
*bgcolor
)
1247 bgcolor
->pixel
= FRAME_BACKGROUND_PIXEL (f
);
1248 x_query_color (f
, bgcolor
);
1250 ns_query_color (FRAME_BACKGROUND_COLOR (f
), bgcolor
, 1);
1254 #endif /* HAVE_PNG || HAVE_NS || HAVE_IMAGEMAGICK || HAVE_RSVG */
1256 /***********************************************************************
1257 Helper functions for X image types
1258 ***********************************************************************/
1260 /* Clear X resources of image IMG on frame F according to FLAGS.
1261 FLAGS is bitwise-or of the following masks:
1262 CLEAR_IMAGE_PIXMAP free the pixmap if any.
1263 CLEAR_IMAGE_MASK means clear the mask pixmap if any.
1264 CLEAR_IMAGE_COLORS means free colors allocated for the image, if
1267 #define CLEAR_IMAGE_PIXMAP (1 << 0)
1268 #define CLEAR_IMAGE_MASK (1 << 1)
1269 #define CLEAR_IMAGE_COLORS (1 << 2)
1272 x_clear_image_1 (struct frame
*f
, struct image
*img
, int flags
)
1274 if (flags
& CLEAR_IMAGE_PIXMAP
)
1278 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->pixmap
);
1279 img
->pixmap
= NO_PIXMAP
;
1280 /* NOTE (HAVE_NS): background color is NOT an indexed color! */
1281 img
->background_valid
= 0;
1283 #ifdef HAVE_X_WINDOWS
1286 x_destroy_x_image (img
->ximg
);
1288 img
->background_valid
= 0;
1293 if (flags
& CLEAR_IMAGE_MASK
)
1297 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->mask
);
1298 img
->mask
= NO_PIXMAP
;
1299 img
->background_transparent_valid
= 0;
1301 #ifdef HAVE_X_WINDOWS
1304 x_destroy_x_image (img
->mask_img
);
1305 img
->mask_img
= NULL
;
1306 img
->background_transparent_valid
= 0;
1311 if ((flags
& CLEAR_IMAGE_COLORS
) && img
->ncolors
)
1313 /* W32_TODO: color table support. */
1314 #ifdef HAVE_X_WINDOWS
1315 x_free_colors (f
, img
->colors
, img
->ncolors
);
1316 #endif /* HAVE_X_WINDOWS */
1317 xfree (img
->colors
);
1324 /* Free X resources of image IMG which is used on frame F. */
1327 x_clear_image (struct frame
*f
, struct image
*img
)
1330 x_clear_image_1 (f
, img
,
1331 CLEAR_IMAGE_PIXMAP
| CLEAR_IMAGE_MASK
| CLEAR_IMAGE_COLORS
);
1336 /* Allocate color COLOR_NAME for image IMG on frame F. If color
1337 cannot be allocated, use DFLT. Add a newly allocated color to
1338 IMG->colors, so that it can be freed again. Value is the pixel
1341 static unsigned long
1342 x_alloc_image_color (struct frame
*f
, struct image
*img
, Lisp_Object color_name
,
1346 unsigned long result
;
1348 eassert (STRINGP (color_name
));
1350 if (x_defined_color (f
, SSDATA (color_name
), &color
, 1)
1351 && img
->ncolors
< min (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *img
->colors
,
1354 /* This isn't called frequently so we get away with simply
1355 reallocating the color vector to the needed size, here. */
1356 ptrdiff_t ncolors
= img
->ncolors
+ 1;
1357 img
->colors
= xrealloc (img
->colors
, ncolors
* sizeof *img
->colors
);
1358 img
->colors
[ncolors
- 1] = color
.pixel
;
1359 img
->ncolors
= ncolors
;
1360 result
= color
.pixel
;
1370 /***********************************************************************
1372 ***********************************************************************/
1374 static void cache_image (struct frame
*f
, struct image
*img
);
1376 /* Return a new, initialized image cache that is allocated from the
1377 heap. Call free_image_cache to free an image cache. */
1379 struct image_cache
*
1380 make_image_cache (void)
1382 struct image_cache
*c
= xmalloc (sizeof *c
);
1385 c
->used
= c
->refcount
= 0;
1386 c
->images
= xmalloc (c
->size
* sizeof *c
->images
);
1387 c
->buckets
= xzalloc (IMAGE_CACHE_BUCKETS_SIZE
* sizeof *c
->buckets
);
1392 /* Find an image matching SPEC in the cache, and return it. If no
1393 image is found, return NULL. */
1394 static struct image
*
1395 search_image_cache (struct frame
*f
, Lisp_Object spec
, EMACS_UINT hash
)
1398 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1399 int i
= hash
% IMAGE_CACHE_BUCKETS_SIZE
;
1401 if (!c
) return NULL
;
1403 /* If the image spec does not specify a background color, the cached
1404 image must have the same background color as the current frame.
1405 The foreground color must also match, for the sake of monochrome
1408 In fact, we could ignore the foreground color matching condition
1409 for color images, or if the image spec specifies :foreground;
1410 similarly we could ignore the background color matching condition
1411 for formats that don't use transparency (such as jpeg), or if the
1412 image spec specifies :background. However, the extra memory
1413 usage is probably negligible in practice, so we don't bother. */
1415 for (img
= c
->buckets
[i
]; img
; img
= img
->next
)
1416 if (img
->hash
== hash
1417 && !NILP (Fequal (img
->spec
, spec
))
1418 && img
->frame_foreground
== FRAME_FOREGROUND_PIXEL (f
)
1419 && img
->frame_background
== FRAME_BACKGROUND_PIXEL (f
))
1425 /* Search frame F for an image with spec SPEC, and free it. */
1428 uncache_image (struct frame
*f
, Lisp_Object spec
)
1430 struct image
*img
= search_image_cache (f
, spec
, sxhash (spec
, 0));
1433 free_image (f
, img
);
1434 /* As display glyphs may still be referring to the image ID, we
1435 must garbage the frame (Bug#6426). */
1436 SET_FRAME_GARBAGED (f
);
1441 /* Free image cache of frame F. Be aware that X frames share images
1445 free_image_cache (struct frame
*f
)
1447 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1452 /* Cache should not be referenced by any frame when freed. */
1453 eassert (c
->refcount
== 0);
1455 for (i
= 0; i
< c
->used
; ++i
)
1456 free_image (f
, c
->images
[i
]);
1460 FRAME_IMAGE_CACHE (f
) = NULL
;
1465 /* Clear image cache of frame F. FILTER=t means free all images.
1466 FILTER=nil means clear only images that haven't been
1467 displayed for some time.
1468 Else, only free the images which have FILTER in their `dependencies'.
1469 Should be called from time to time to reduce the number of loaded images.
1470 If image-cache-eviction-delay is non-nil, this frees images in the cache
1471 which weren't displayed for at least that many seconds. */
1474 clear_image_cache (struct frame
*f
, Lisp_Object filter
)
1476 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1480 ptrdiff_t i
, nfreed
= 0;
1482 /* Block input so that we won't be interrupted by a SIGIO
1483 while being in an inconsistent state. */
1488 /* Filter image cache. */
1489 for (i
= 0; i
< c
->used
; ++i
)
1491 struct image
*img
= c
->images
[i
];
1492 if (img
&& (EQ (Qt
, filter
)
1493 || !NILP (Fmember (filter
, img
->dependencies
))))
1495 free_image (f
, img
);
1500 else if (INTEGERP (Vimage_cache_eviction_delay
))
1502 /* Free cache based on timestamp. */
1503 struct timespec old
, t
;
1505 ptrdiff_t nimages
= 0;
1507 for (i
= 0; i
< c
->used
; ++i
)
1511 /* If the number of cached images has grown unusually large,
1512 decrease the cache eviction delay (Bug#6230). */
1513 delay
= XINT (Vimage_cache_eviction_delay
);
1515 delay
= 1600 * delay
/ nimages
/ nimages
;
1516 delay
= max (delay
, 1);
1518 t
= current_timespec ();
1519 old
= timespec_sub (t
, dtotimespec (delay
));
1521 for (i
= 0; i
< c
->used
; ++i
)
1523 struct image
*img
= c
->images
[i
];
1524 if (img
&& timespec_cmp (img
->timestamp
, old
) < 0)
1526 free_image (f
, img
);
1532 /* We may be clearing the image cache because, for example,
1533 Emacs was iconified for a longer period of time. In that
1534 case, current matrices may still contain references to
1535 images freed above. So, clear these matrices. */
1538 Lisp_Object tail
, frame
;
1540 FOR_EACH_FRAME (tail
, frame
)
1542 struct frame
*fr
= XFRAME (frame
);
1543 if (FRAME_IMAGE_CACHE (fr
) == c
)
1544 clear_current_matrices (fr
);
1547 windows_or_buffers_changed
= 19;
1555 clear_image_caches (Lisp_Object filter
)
1557 /* FIXME: We want to do
1558 * struct terminal *t;
1559 * for (t = terminal_list; t; t = t->next_terminal)
1560 * clear_image_cache (t, filter); */
1561 Lisp_Object tail
, frame
;
1562 FOR_EACH_FRAME (tail
, frame
)
1563 if (FRAME_WINDOW_P (XFRAME (frame
)))
1564 clear_image_cache (XFRAME (frame
), filter
);
1567 DEFUN ("clear-image-cache", Fclear_image_cache
, Sclear_image_cache
,
1569 doc
: /* Clear the image cache.
1570 FILTER nil or a frame means clear all images in the selected frame.
1571 FILTER t means clear the image caches of all frames.
1572 Anything else, means only clear those images which refer to FILTER,
1573 which is then usually a filename. */)
1574 (Lisp_Object filter
)
1576 if (!(EQ (filter
, Qnil
) || FRAMEP (filter
)))
1577 clear_image_caches (filter
);
1579 clear_image_cache (decode_window_system_frame (filter
), Qt
);
1585 DEFUN ("image-flush", Fimage_flush
, Simage_flush
,
1587 doc
: /* Flush the image with specification SPEC on frame FRAME.
1588 This removes the image from the Emacs image cache. If SPEC specifies
1589 an image file, the next redisplay of this image will read from the
1590 current contents of that file.
1592 FRAME nil or omitted means use the selected frame.
1593 FRAME t means refresh the image on all frames. */)
1594 (Lisp_Object spec
, Lisp_Object frame
)
1596 if (!valid_image_p (spec
))
1597 error ("Invalid image specification");
1602 FOR_EACH_FRAME (tail
, frame
)
1604 struct frame
*f
= XFRAME (frame
);
1605 if (FRAME_WINDOW_P (f
))
1606 uncache_image (f
, spec
);
1610 uncache_image (decode_window_system_frame (frame
), spec
);
1616 /* Compute masks and transform image IMG on frame F, as specified
1617 by the image's specification, */
1620 postprocess_image (struct frame
*f
, struct image
*img
)
1622 /* Manipulation of the image's mask. */
1625 Lisp_Object conversion
, spec
;
1630 /* `:heuristic-mask t'
1632 means build a mask heuristically.
1633 `:heuristic-mask (R G B)'
1634 `:mask (heuristic (R G B))'
1635 means build a mask from color (R G B) in the
1638 means remove a mask, if any. */
1640 mask
= image_spec_value (spec
, QCheuristic_mask
, NULL
);
1642 x_build_heuristic_mask (f
, img
, mask
);
1647 mask
= image_spec_value (spec
, QCmask
, &found_p
);
1649 if (EQ (mask
, Qheuristic
))
1650 x_build_heuristic_mask (f
, img
, Qt
);
1651 else if (CONSP (mask
)
1652 && EQ (XCAR (mask
), Qheuristic
))
1654 if (CONSP (XCDR (mask
)))
1655 x_build_heuristic_mask (f
, img
, XCAR (XCDR (mask
)));
1657 x_build_heuristic_mask (f
, img
, XCDR (mask
));
1659 else if (NILP (mask
) && found_p
&& img
->mask
)
1660 x_clear_image_1 (f
, img
, CLEAR_IMAGE_MASK
);
1664 /* Should we apply an image transformation algorithm? */
1665 conversion
= image_spec_value (spec
, QCconversion
, NULL
);
1666 if (EQ (conversion
, Qdisabled
))
1667 x_disable_image (f
, img
);
1668 else if (EQ (conversion
, Qlaplace
))
1670 else if (EQ (conversion
, Qemboss
))
1672 else if (CONSP (conversion
)
1673 && EQ (XCAR (conversion
), Qedge_detection
))
1676 tem
= XCDR (conversion
);
1678 x_edge_detection (f
, img
,
1679 Fplist_get (tem
, QCmatrix
),
1680 Fplist_get (tem
, QCcolor_adjustment
));
1686 /* Return the id of image with Lisp specification SPEC on frame F.
1687 SPEC must be a valid Lisp image specification (see valid_image_p). */
1690 lookup_image (struct frame
*f
, Lisp_Object spec
)
1695 /* F must be a window-system frame, and SPEC must be a valid image
1697 eassert (FRAME_WINDOW_P (f
));
1698 eassert (valid_image_p (spec
));
1700 /* Look up SPEC in the hash table of the image cache. */
1701 hash
= sxhash (spec
, 0);
1702 img
= search_image_cache (f
, spec
, hash
);
1703 if (img
&& img
->load_failed_p
)
1705 free_image (f
, img
);
1709 /* If not found, create a new image and cache it. */
1713 img
= make_image (spec
, hash
);
1714 cache_image (f
, img
);
1715 img
->load_failed_p
= ! img
->type
->load (f
, img
);
1716 img
->frame_foreground
= FRAME_FOREGROUND_PIXEL (f
);
1717 img
->frame_background
= FRAME_BACKGROUND_PIXEL (f
);
1719 /* If we can't load the image, and we don't have a width and
1720 height, use some arbitrary width and height so that we can
1721 draw a rectangle for it. */
1722 if (img
->load_failed_p
)
1726 value
= image_spec_value (spec
, QCwidth
, NULL
);
1727 img
->width
= (INTEGERP (value
)
1728 ? XFASTINT (value
) : DEFAULT_IMAGE_WIDTH
);
1729 value
= image_spec_value (spec
, QCheight
, NULL
);
1730 img
->height
= (INTEGERP (value
)
1731 ? XFASTINT (value
) : DEFAULT_IMAGE_HEIGHT
);
1735 /* Handle image type independent image attributes
1736 `:ascent ASCENT', `:margin MARGIN', `:relief RELIEF',
1737 `:background COLOR'. */
1738 Lisp_Object ascent
, margin
, relief
, bg
;
1741 ascent
= image_spec_value (spec
, QCascent
, NULL
);
1742 if (INTEGERP (ascent
))
1743 img
->ascent
= XFASTINT (ascent
);
1744 else if (EQ (ascent
, Qcenter
))
1745 img
->ascent
= CENTERED_IMAGE_ASCENT
;
1747 margin
= image_spec_value (spec
, QCmargin
, NULL
);
1748 if (INTEGERP (margin
))
1749 img
->vmargin
= img
->hmargin
= XFASTINT (margin
);
1750 else if (CONSP (margin
))
1752 img
->hmargin
= XFASTINT (XCAR (margin
));
1753 img
->vmargin
= XFASTINT (XCDR (margin
));
1756 relief
= image_spec_value (spec
, QCrelief
, NULL
);
1757 relief_bound
= INT_MAX
- max (img
->hmargin
, img
->vmargin
);
1758 if (RANGED_INTEGERP (- relief_bound
, relief
, relief_bound
))
1760 img
->relief
= XINT (relief
);
1761 img
->hmargin
+= eabs (img
->relief
);
1762 img
->vmargin
+= eabs (img
->relief
);
1765 if (! img
->background_valid
)
1767 bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
1771 = x_alloc_image_color (f
, img
, bg
,
1772 FRAME_BACKGROUND_PIXEL (f
));
1773 img
->background_valid
= 1;
1777 /* Do image transformations and compute masks, unless we
1778 don't have the image yet. */
1779 if (!EQ (*img
->type
->type
, Qpostscript
))
1780 postprocess_image (f
, img
);
1786 /* We're using IMG, so set its timestamp to `now'. */
1787 img
->timestamp
= current_timespec ();
1789 /* Value is the image id. */
1794 /* Cache image IMG in the image cache of frame F. */
1797 cache_image (struct frame
*f
, struct image
*img
)
1799 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1802 /* Find a free slot in c->images. */
1803 for (i
= 0; i
< c
->used
; ++i
)
1804 if (c
->images
[i
] == NULL
)
1807 /* If no free slot found, maybe enlarge c->images. */
1808 if (i
== c
->used
&& c
->used
== c
->size
)
1809 c
->images
= xpalloc (c
->images
, &c
->size
, 1, -1, sizeof *c
->images
);
1811 /* Add IMG to c->images, and assign IMG an id. */
1817 /* Add IMG to the cache's hash table. */
1818 i
= img
->hash
% IMAGE_CACHE_BUCKETS_SIZE
;
1819 img
->next
= c
->buckets
[i
];
1821 img
->next
->prev
= img
;
1823 c
->buckets
[i
] = img
;
1827 /* Call FN on every image in the image cache of frame F. Used to mark
1828 Lisp Objects in the image cache. */
1830 /* Mark Lisp objects in image IMG. */
1833 mark_image (struct image
*img
)
1835 mark_object (img
->spec
);
1836 mark_object (img
->dependencies
);
1838 if (!NILP (img
->lisp_data
))
1839 mark_object (img
->lisp_data
);
1844 mark_image_cache (struct image_cache
*c
)
1849 for (i
= 0; i
< c
->used
; ++i
)
1851 mark_image (c
->images
[i
]);
1857 /***********************************************************************
1858 X / NS / W32 support code
1859 ***********************************************************************/
1863 /* Macro for defining functions that will be loaded from image DLLs. */
1864 #define DEF_IMGLIB_FN(rettype,func,args) static rettype (FAR CDECL *fn_##func)args
1866 /* Macro for loading those image functions from the library. */
1867 #define LOAD_IMGLIB_FN(lib,func) { \
1868 fn_##func = (void *) GetProcAddress (lib, #func); \
1869 if (!fn_##func) return 0; \
1872 #endif /* WINDOWSNT */
1874 /* Return true if XIMG's size WIDTH x HEIGHT doesn't break the
1876 WIDTH and HEIGHT must both be positive.
1877 If XIMG is null, assume it is a bitmap. */
1879 x_check_image_size (XImagePtr ximg
, int width
, int height
)
1881 #ifdef HAVE_X_WINDOWS
1882 /* Respect Xlib's limits: it cannot deal with images that have more
1883 than INT_MAX (and/or UINT_MAX) bytes. And respect Emacs's limits
1884 of PTRDIFF_MAX (and/or SIZE_MAX) bytes for any object. */
1887 XLIB_BYTES_MAX
= min (INT_MAX
, UINT_MAX
),
1888 X_IMAGE_BYTES_MAX
= min (XLIB_BYTES_MAX
, min (PTRDIFF_MAX
, SIZE_MAX
))
1891 int bitmap_pad
, depth
, bytes_per_line
;
1894 bitmap_pad
= ximg
->bitmap_pad
;
1895 depth
= ximg
->depth
;
1896 bytes_per_line
= ximg
->bytes_per_line
;
1902 bytes_per_line
= (width
>> 3) + ((width
& 7) != 0);
1904 return (width
<= (INT_MAX
- (bitmap_pad
- 1)) / depth
1905 && height
<= X_IMAGE_BYTES_MAX
/ bytes_per_line
);
1907 /* FIXME: Implement this check for the HAVE_NS and HAVE_NTGUI cases.
1908 For now, assume that every image size is allowed on these systems. */
1913 /* Create an XImage and a pixmap of size WIDTH x HEIGHT for use on
1914 frame F. Set *XIMG and *PIXMAP to the XImage and Pixmap created.
1915 Set (*XIMG)->data to a raster of WIDTH x HEIGHT pixels allocated
1916 via xmalloc. Print error messages via image_error if an error
1917 occurs. Value is true if successful.
1919 On W32, a DEPTH of zero signifies a 24 bit image, otherwise DEPTH
1920 should indicate the bit depth of the image. */
1923 x_create_x_image_and_pixmap (struct frame
*f
, int width
, int height
, int depth
,
1924 XImagePtr
*ximg
, Pixmap
*pixmap
)
1926 #ifdef HAVE_X_WINDOWS
1927 Display
*display
= FRAME_X_DISPLAY (f
);
1928 Window window
= FRAME_X_WINDOW (f
);
1929 Screen
*screen
= FRAME_X_SCREEN (f
);
1931 eassert (input_blocked_p ());
1934 depth
= DefaultDepthOfScreen (screen
);
1935 *ximg
= XCreateImage (display
, DefaultVisualOfScreen (screen
),
1936 depth
, ZPixmap
, 0, NULL
, width
, height
,
1937 depth
> 16 ? 32 : depth
> 8 ? 16 : 8, 0);
1940 image_error ("Unable to allocate X image", Qnil
, Qnil
);
1944 if (! x_check_image_size (*ximg
, width
, height
))
1946 x_destroy_x_image (*ximg
);
1948 image_error ("Image too large (%dx%d)",
1949 make_number (width
), make_number (height
));
1953 /* Allocate image raster. */
1954 (*ximg
)->data
= xmalloc ((*ximg
)->bytes_per_line
* height
);
1956 /* Allocate a pixmap of the same size. */
1957 *pixmap
= XCreatePixmap (display
, window
, width
, height
, depth
);
1958 if (*pixmap
== NO_PIXMAP
)
1960 x_destroy_x_image (*ximg
);
1962 image_error ("Unable to create X pixmap", Qnil
, Qnil
);
1967 #endif /* HAVE_X_WINDOWS */
1971 BITMAPINFOHEADER
*header
;
1973 int scanline_width_bits
;
1975 int palette_colors
= 0;
1980 if (depth
!= 1 && depth
!= 4 && depth
!= 8
1981 && depth
!= 16 && depth
!= 24 && depth
!= 32)
1983 image_error ("Invalid image bit depth specified", Qnil
, Qnil
);
1987 scanline_width_bits
= width
* depth
;
1988 remainder
= scanline_width_bits
% 32;
1991 scanline_width_bits
+= 32 - remainder
;
1993 /* Bitmaps with a depth less than 16 need a palette. */
1994 /* BITMAPINFO structure already contains the first RGBQUAD. */
1996 palette_colors
= 1 << (depth
- 1);
1998 *ximg
= xmalloc (sizeof (XImage
) + palette_colors
* sizeof (RGBQUAD
));
2000 header
= &(*ximg
)->info
.bmiHeader
;
2001 memset (&(*ximg
)->info
, 0, sizeof (BITMAPINFO
));
2002 header
->biSize
= sizeof (*header
);
2003 header
->biWidth
= width
;
2004 header
->biHeight
= -height
; /* negative indicates a top-down bitmap. */
2005 header
->biPlanes
= 1;
2006 header
->biBitCount
= depth
;
2007 header
->biCompression
= BI_RGB
;
2008 header
->biClrUsed
= palette_colors
;
2010 /* TODO: fill in palette. */
2013 (*ximg
)->info
.bmiColors
[0].rgbBlue
= 0;
2014 (*ximg
)->info
.bmiColors
[0].rgbGreen
= 0;
2015 (*ximg
)->info
.bmiColors
[0].rgbRed
= 0;
2016 (*ximg
)->info
.bmiColors
[0].rgbReserved
= 0;
2017 (*ximg
)->info
.bmiColors
[1].rgbBlue
= 255;
2018 (*ximg
)->info
.bmiColors
[1].rgbGreen
= 255;
2019 (*ximg
)->info
.bmiColors
[1].rgbRed
= 255;
2020 (*ximg
)->info
.bmiColors
[1].rgbReserved
= 0;
2023 hdc
= get_frame_dc (f
);
2025 /* Create a DIBSection and raster array for the bitmap,
2026 and store its handle in *pixmap. */
2027 *pixmap
= CreateDIBSection (hdc
, &((*ximg
)->info
),
2028 (depth
< 16) ? DIB_PAL_COLORS
: DIB_RGB_COLORS
,
2029 /* casting avoids a GCC warning */
2030 (void **)&((*ximg
)->data
), NULL
, 0);
2032 /* Realize display palette and garbage all frames. */
2033 release_frame_dc (f
, hdc
);
2035 if (*pixmap
== NULL
)
2037 DWORD err
= GetLastError ();
2038 Lisp_Object errcode
;
2039 /* All system errors are < 10000, so the following is safe. */
2040 XSETINT (errcode
, err
);
2041 image_error ("Unable to create bitmap, error code %d", errcode
, Qnil
);
2042 x_destroy_x_image (*ximg
);
2049 #endif /* HAVE_NTGUI */
2052 *pixmap
= ns_image_for_XPM (width
, height
, depth
);
2056 image_error ("Unable to allocate NSImage for XPM pixmap", Qnil
, Qnil
);
2065 /* Destroy XImage XIMG. Free XIMG->data. */
2068 x_destroy_x_image (XImagePtr ximg
)
2070 eassert (input_blocked_p ());
2073 #ifdef HAVE_X_WINDOWS
2076 XDestroyImage (ximg
);
2077 #endif /* HAVE_X_WINDOWS */
2079 /* Data will be freed by DestroyObject. */
2082 #endif /* HAVE_NTGUI */
2084 ns_release_object (ximg
);
2085 #endif /* HAVE_NS */
2090 /* Put XImage XIMG into pixmap PIXMAP on frame F. WIDTH and HEIGHT
2091 are width and height of both the image and pixmap. */
2094 x_put_x_image (struct frame
*f
, XImagePtr ximg
, Pixmap pixmap
, int width
, int height
)
2096 #ifdef HAVE_X_WINDOWS
2099 eassert (input_blocked_p ());
2100 gc
= XCreateGC (FRAME_X_DISPLAY (f
), pixmap
, 0, NULL
);
2101 XPutImage (FRAME_X_DISPLAY (f
), pixmap
, gc
, ximg
, 0, 0, 0, 0, width
, height
);
2102 XFreeGC (FRAME_X_DISPLAY (f
), gc
);
2103 #endif /* HAVE_X_WINDOWS */
2106 #if 0 /* I don't think this is necessary looking at where it is used. */
2107 HDC hdc
= get_frame_dc (f
);
2108 SetDIBits (hdc
, pixmap
, 0, height
, ximg
->data
, &(ximg
->info
), DIB_RGB_COLORS
);
2109 release_frame_dc (f
, hdc
);
2111 #endif /* HAVE_NTGUI */
2114 eassert (ximg
== pixmap
);
2115 ns_retain_object (ximg
);
2119 /* Thin wrapper for x_create_x_image_and_pixmap, so that it matches
2120 with image_put_x_image. */
2123 image_create_x_image_and_pixmap (struct frame
*f
, struct image
*img
,
2124 int width
, int height
, int depth
,
2125 XImagePtr
*ximg
, bool mask_p
)
2127 eassert ((!mask_p
? img
->pixmap
: img
->mask
) == NO_PIXMAP
);
2129 return x_create_x_image_and_pixmap (f
, width
, height
, depth
, ximg
,
2130 !mask_p
? &img
->pixmap
: &img
->mask
);
2133 /* Put X image XIMG into image IMG on frame F, as a mask if and only
2134 if MASK_P. On X, this simply records XIMG on a member of IMG, so
2135 it can be put into the pixmap afterwards via image_sync_to_pixmaps.
2136 On the other platforms, it puts XIMG into the pixmap, then frees
2137 the X image and its buffer. */
2140 image_put_x_image (struct frame
*f
, struct image
*img
, XImagePtr ximg
,
2143 #ifdef HAVE_X_WINDOWS
2146 eassert (img
->ximg
== NULL
);
2151 eassert (img
->mask_img
== NULL
);
2152 img
->mask_img
= ximg
;
2155 x_put_x_image (f
, ximg
, !mask_p
? img
->pixmap
: img
->mask
,
2156 img
->width
, img
->height
);
2157 x_destroy_x_image (ximg
);
2161 #ifdef HAVE_X_WINDOWS
2162 /* Put the X images recorded in IMG on frame F into pixmaps, then free
2163 the X images and their buffers. */
2166 image_sync_to_pixmaps (struct frame
*f
, struct image
*img
)
2170 x_put_x_image (f
, img
->ximg
, img
->pixmap
, img
->width
, img
->height
);
2171 x_destroy_x_image (img
->ximg
);
2176 x_put_x_image (f
, img
->mask_img
, img
->mask
, img
->width
, img
->height
);
2177 x_destroy_x_image (img
->mask_img
);
2178 img
->mask_img
= NULL
;
2184 /* Create a memory device context for IMG on frame F. It stores the
2185 currently selected GDI object into *PREV for future restoration by
2186 image_unget_x_image_or_dc. */
2188 static XImagePtr_or_DC
2189 image_get_x_image_or_dc (struct frame
*f
, struct image
*img
, bool mask_p
,
2192 HDC frame_dc
= get_frame_dc (f
);
2193 XImagePtr_or_DC ximg
= CreateCompatibleDC (frame_dc
);
2195 release_frame_dc (f
, frame_dc
);
2196 *prev
= SelectObject (ximg
, !mask_p
? img
->pixmap
: img
->mask
);
2202 image_unget_x_image_or_dc (struct image
*img
, bool mask_p
,
2203 XImagePtr_or_DC ximg
, HGDIOBJ prev
)
2205 SelectObject (ximg
, prev
);
2208 #else /* !HAVE_NTGUI */
2209 /* Get the X image for IMG on frame F. The resulting X image data
2210 should be treated as read-only at least on X. */
2213 image_get_x_image (struct frame
*f
, struct image
*img
, bool mask_p
)
2215 #ifdef HAVE_X_WINDOWS
2216 XImagePtr ximg_in_img
= !mask_p
? img
->ximg
: img
->mask_img
;
2221 return XGetImage (FRAME_X_DISPLAY (f
), !mask_p
? img
->pixmap
: img
->mask
,
2222 0, 0, img
->width
, img
->height
, ~0, ZPixmap
);
2223 #elif defined (HAVE_NS)
2224 XImagePtr pixmap
= !mask_p
? img
->pixmap
: img
->mask
;
2226 ns_retain_object (pixmap
);
2232 image_unget_x_image (struct image
*img
, bool mask_p
, XImagePtr ximg
)
2234 #ifdef HAVE_X_WINDOWS
2235 XImagePtr ximg_in_img
= !mask_p
? img
->ximg
: img
->mask_img
;
2238 eassert (ximg
== ximg_in_img
);
2240 XDestroyImage (ximg
);
2241 #elif defined (HAVE_NS)
2242 ns_release_object (ximg
);
2245 #endif /* !HAVE_NTGUI */
2248 /***********************************************************************
2250 ***********************************************************************/
2252 /* Find image file FILE. Look in data-directory/images, then
2253 x-bitmap-file-path. Value is the encoded full name of the file
2254 found, or nil if not found. */
2257 x_find_image_file (Lisp_Object file
)
2259 Lisp_Object file_found
, search_path
;
2262 /* TODO I think this should use something like image-load-path
2263 instead. Unfortunately, that can contain non-string elements. */
2264 search_path
= Fcons (Fexpand_file_name (build_string ("images"),
2266 Vx_bitmap_file_path
);
2268 /* Try to find FILE in data-directory/images, then x-bitmap-file-path. */
2269 fd
= openp (search_path
, file
, Qnil
, &file_found
, Qnil
, false);
2275 file_found
= ENCODE_FILE (file_found
);
2284 /* Read FILE into memory. Value is a pointer to a buffer allocated
2285 with xmalloc holding FILE's contents. Value is null if an error
2286 occurred. *SIZE is set to the size of the file. */
2288 static unsigned char *
2289 slurp_file (char *file
, ptrdiff_t *size
)
2291 FILE *fp
= emacs_fopen (file
, "rb");
2292 unsigned char *buf
= NULL
;
2297 ptrdiff_t count
= SPECPDL_INDEX ();
2298 record_unwind_protect_ptr (fclose_unwind
, fp
);
2300 if (fstat (fileno (fp
), &st
) == 0
2301 && 0 <= st
.st_size
&& st
.st_size
< min (PTRDIFF_MAX
, SIZE_MAX
))
2303 /* Report an error if we read past the purported EOF.
2304 This can happen if the file grows as we read it. */
2305 ptrdiff_t buflen
= st
.st_size
;
2306 buf
= xmalloc (buflen
+ 1);
2307 if (fread (buf
, 1, buflen
+ 1, fp
) == buflen
)
2316 unbind_to (count
, Qnil
);
2324 /***********************************************************************
2326 ***********************************************************************/
2328 static bool xbm_load (struct frame
*f
, struct image
*img
);
2329 static bool xbm_image_p (Lisp_Object object
);
2330 static bool xbm_file_p (Lisp_Object
);
2333 /* Indices of image specification fields in xbm_format, below. */
2335 enum xbm_keyword_index
2353 /* Vector of image_keyword structures describing the format
2354 of valid XBM image specifications. */
2356 static const struct image_keyword xbm_format
[XBM_LAST
] =
2358 {":type", IMAGE_SYMBOL_VALUE
, 1},
2359 {":file", IMAGE_STRING_VALUE
, 0},
2360 {":width", IMAGE_POSITIVE_INTEGER_VALUE
, 0},
2361 {":height", IMAGE_POSITIVE_INTEGER_VALUE
, 0},
2362 {":data", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
2363 {":foreground", IMAGE_STRING_OR_NIL_VALUE
, 0},
2364 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0},
2365 {":ascent", IMAGE_ASCENT_VALUE
, 0},
2366 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
2367 {":relief", IMAGE_INTEGER_VALUE
, 0},
2368 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
2369 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
2370 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0}
2373 /* Structure describing the image type XBM. */
2375 static struct image_type xbm_type
=
2385 /* Tokens returned from xbm_scan. */
2394 /* Return true if OBJECT is a valid XBM-type image specification.
2395 A valid specification is a list starting with the symbol `image'
2396 The rest of the list is a property list which must contain an
2399 If the specification specifies a file to load, it must contain
2400 an entry `:file FILENAME' where FILENAME is a string.
2402 If the specification is for a bitmap loaded from memory it must
2403 contain `:width WIDTH', `:height HEIGHT', and `:data DATA', where
2404 WIDTH and HEIGHT are integers > 0. DATA may be:
2406 1. a string large enough to hold the bitmap data, i.e. it must
2407 have a size >= (WIDTH + 7) / 8 * HEIGHT
2409 2. a bool-vector of size >= WIDTH * HEIGHT
2411 3. a vector of strings or bool-vectors, one for each line of the
2414 4. a string containing an in-memory XBM file. WIDTH and HEIGHT
2415 may not be specified in this case because they are defined in the
2418 Both the file and data forms may contain the additional entries
2419 `:background COLOR' and `:foreground COLOR'. If not present,
2420 foreground and background of the frame on which the image is
2421 displayed is used. */
2424 xbm_image_p (Lisp_Object object
)
2426 struct image_keyword kw
[XBM_LAST
];
2428 memcpy (kw
, xbm_format
, sizeof kw
);
2429 if (!parse_image_spec (object
, kw
, XBM_LAST
, Qxbm
))
2432 eassert (EQ (kw
[XBM_TYPE
].value
, Qxbm
));
2434 if (kw
[XBM_FILE
].count
)
2436 if (kw
[XBM_WIDTH
].count
|| kw
[XBM_HEIGHT
].count
|| kw
[XBM_DATA
].count
)
2439 else if (kw
[XBM_DATA
].count
&& xbm_file_p (kw
[XBM_DATA
].value
))
2441 /* In-memory XBM file. */
2442 if (kw
[XBM_WIDTH
].count
|| kw
[XBM_HEIGHT
].count
|| kw
[XBM_FILE
].count
)
2450 /* Entries for `:width', `:height' and `:data' must be present. */
2451 if (!kw
[XBM_WIDTH
].count
2452 || !kw
[XBM_HEIGHT
].count
2453 || !kw
[XBM_DATA
].count
)
2456 data
= kw
[XBM_DATA
].value
;
2457 width
= XFASTINT (kw
[XBM_WIDTH
].value
);
2458 height
= XFASTINT (kw
[XBM_HEIGHT
].value
);
2460 /* Check type of data, and width and height against contents of
2466 /* Number of elements of the vector must be >= height. */
2467 if (ASIZE (data
) < height
)
2470 /* Each string or bool-vector in data must be large enough
2471 for one line of the image. */
2472 for (i
= 0; i
< height
; ++i
)
2474 Lisp_Object elt
= AREF (data
, i
);
2479 < (width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
)
2482 else if (BOOL_VECTOR_P (elt
))
2484 if (bool_vector_size (elt
) < width
)
2491 else if (STRINGP (data
))
2494 < (width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
* height
)
2497 else if (BOOL_VECTOR_P (data
))
2499 if (bool_vector_size (data
) / height
< width
)
2510 /* Scan a bitmap file. FP is the stream to read from. Value is
2511 either an enumerator from enum xbm_token, or a character for a
2512 single-character token, or 0 at end of file. If scanning an
2513 identifier, store the lexeme of the identifier in SVAL. If
2514 scanning a number, store its value in *IVAL. */
2517 xbm_scan (unsigned char **s
, unsigned char *end
, char *sval
, int *ival
)
2523 /* Skip white space. */
2524 while (*s
< end
&& (c
= *(*s
)++, c_isspace (c
)))
2529 else if (c_isdigit (c
))
2531 int value
= 0, digit
;
2533 if (c
== '0' && *s
< end
)
2536 if (c
== 'x' || c
== 'X')
2543 else if (c
>= 'a' && c
<= 'f')
2544 digit
= c
- 'a' + 10;
2545 else if (c
>= 'A' && c
<= 'F')
2546 digit
= c
- 'A' + 10;
2549 value
= 16 * value
+ digit
;
2552 else if (c_isdigit (c
))
2556 && (c
= *(*s
)++, c_isdigit (c
)))
2557 value
= 8 * value
+ c
- '0';
2564 && (c
= *(*s
)++, c_isdigit (c
)))
2565 value
= 10 * value
+ c
- '0';
2573 else if (c_isalpha (c
) || c
== '_')
2577 && (c
= *(*s
)++, (c_isalnum (c
) || c
== '_')))
2584 else if (c
== '/' && **s
== '*')
2586 /* C-style comment. */
2588 while (**s
&& (**s
!= '*' || *(*s
+ 1) != '/'))
2602 /* Create a Windows bitmap from X bitmap data. */
2604 w32_create_pixmap_from_bitmap_data (int width
, int height
, char *data
)
2606 static unsigned char swap_nibble
[16]
2607 = { 0x0, 0x8, 0x4, 0xc, /* 0000 1000 0100 1100 */
2608 0x2, 0xa, 0x6, 0xe, /* 0010 1010 0110 1110 */
2609 0x1, 0x9, 0x5, 0xd, /* 0001 1001 0101 1101 */
2610 0x3, 0xb, 0x7, 0xf }; /* 0011 1011 0111 1111 */
2612 unsigned char *bits
, *p
;
2615 w1
= (width
+ 7) / 8; /* nb of 8bits elt in X bitmap */
2616 w2
= ((width
+ 15) / 16) * 2; /* nb of 16bits elt in W32 bitmap */
2617 bits
= alloca (height
* w2
);
2618 memset (bits
, 0, height
* w2
);
2619 for (i
= 0; i
< height
; i
++)
2622 for (j
= 0; j
< w1
; j
++)
2624 /* Bitswap XBM bytes to match how Windows does things. */
2625 unsigned char c
= *data
++;
2626 *p
++ = (unsigned char)((swap_nibble
[c
& 0xf] << 4)
2627 | (swap_nibble
[(c
>>4) & 0xf]));
2630 bmp
= CreateBitmap (width
, height
, 1, 1, (char *) bits
);
2636 convert_mono_to_color_image (struct frame
*f
, struct image
*img
,
2637 COLORREF foreground
, COLORREF background
)
2639 HDC hdc
, old_img_dc
, new_img_dc
;
2640 HGDIOBJ old_prev
, new_prev
;
2643 hdc
= get_frame_dc (f
);
2644 old_img_dc
= CreateCompatibleDC (hdc
);
2645 new_img_dc
= CreateCompatibleDC (hdc
);
2646 new_pixmap
= CreateCompatibleBitmap (hdc
, img
->width
, img
->height
);
2647 release_frame_dc (f
, hdc
);
2648 old_prev
= SelectObject (old_img_dc
, img
->pixmap
);
2649 new_prev
= SelectObject (new_img_dc
, new_pixmap
);
2650 /* Windows convention for mono bitmaps is black = background,
2651 white = foreground. */
2652 SetTextColor (new_img_dc
, background
);
2653 SetBkColor (new_img_dc
, foreground
);
2655 BitBlt (new_img_dc
, 0, 0, img
->width
, img
->height
, old_img_dc
,
2658 SelectObject (old_img_dc
, old_prev
);
2659 SelectObject (new_img_dc
, new_prev
);
2660 DeleteDC (old_img_dc
);
2661 DeleteDC (new_img_dc
);
2662 DeleteObject (img
->pixmap
);
2663 if (new_pixmap
== 0)
2664 fprintf (stderr
, "Failed to convert image to color.\n");
2666 img
->pixmap
= new_pixmap
;
2669 #define XBM_BIT_SHUFFLE(b) (~(b))
2673 #define XBM_BIT_SHUFFLE(b) (b)
2675 #endif /* HAVE_NTGUI */
2679 Create_Pixmap_From_Bitmap_Data (struct frame
*f
, struct image
*img
, char *data
,
2680 RGB_PIXEL_COLOR fg
, RGB_PIXEL_COLOR bg
,
2681 bool non_default_colors
)
2685 = w32_create_pixmap_from_bitmap_data (img
->width
, img
->height
, data
);
2687 /* If colors were specified, transfer the bitmap to a color one. */
2688 if (non_default_colors
)
2689 convert_mono_to_color_image (f
, img
, fg
, bg
);
2691 #elif defined (HAVE_NS)
2692 img
->pixmap
= ns_image_from_XBM (data
, img
->width
, img
->height
);
2696 (x_check_image_size (0, img
->width
, img
->height
)
2697 ? XCreatePixmapFromBitmapData (FRAME_X_DISPLAY (f
),
2700 img
->width
, img
->height
,
2702 DefaultDepthOfScreen (FRAME_X_SCREEN (f
)))
2704 #endif /* !HAVE_NTGUI && !HAVE_NS */
2709 /* Replacement for XReadBitmapFileData which isn't available under old
2710 X versions. CONTENTS is a pointer to a buffer to parse; END is the
2711 buffer's end. Set *WIDTH and *HEIGHT to the width and height of
2712 the image. Return in *DATA the bitmap data allocated with xmalloc.
2713 Value is true if successful. DATA null means just test if
2714 CONTENTS looks like an in-memory XBM file. If INHIBIT_IMAGE_ERROR,
2715 inhibit the call to image_error when the image size is invalid (the
2716 bitmap remains unread). */
2719 xbm_read_bitmap_data (struct frame
*f
, unsigned char *contents
, unsigned char *end
,
2720 int *width
, int *height
, char **data
,
2721 bool inhibit_image_error
)
2723 unsigned char *s
= contents
;
2724 char buffer
[BUFSIZ
];
2727 int bytes_per_line
, i
, nbytes
;
2733 LA1 = xbm_scan (&s, end, buffer, &value)
2735 #define expect(TOKEN) \
2738 if (LA1 != (TOKEN)) \
2744 #define expect_ident(IDENT) \
2745 if (LA1 == XBM_TK_IDENT && strcmp (buffer, (IDENT)) == 0) \
2750 *width
= *height
= -1;
2753 LA1
= xbm_scan (&s
, end
, buffer
, &value
);
2755 /* Parse defines for width, height and hot-spots. */
2759 expect_ident ("define");
2760 expect (XBM_TK_IDENT
);
2762 if (LA1
== XBM_TK_NUMBER
)
2764 char *q
= strrchr (buffer
, '_');
2765 q
= q
? q
+ 1 : buffer
;
2766 if (strcmp (q
, "width") == 0)
2768 else if (strcmp (q
, "height") == 0)
2771 expect (XBM_TK_NUMBER
);
2774 if (!check_image_size (f
, *width
, *height
))
2776 if (!inhibit_image_error
)
2777 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
2780 else if (data
== NULL
)
2783 /* Parse bits. Must start with `static'. */
2784 expect_ident ("static");
2785 if (LA1
== XBM_TK_IDENT
)
2787 if (strcmp (buffer
, "unsigned") == 0)
2790 expect_ident ("char");
2792 else if (strcmp (buffer
, "short") == 0)
2796 if (*width
% 16 && *width
% 16 < 9)
2799 else if (strcmp (buffer
, "char") == 0)
2807 expect (XBM_TK_IDENT
);
2813 if (! x_check_image_size (0, *width
, *height
))
2815 if (!inhibit_image_error
)
2816 image_error ("Image too large (%dx%d)",
2817 make_number (*width
), make_number (*height
));
2820 bytes_per_line
= (*width
+ 7) / 8 + padding_p
;
2821 nbytes
= bytes_per_line
* *height
;
2822 p
= *data
= xmalloc (nbytes
);
2826 for (i
= 0; i
< nbytes
; i
+= 2)
2829 expect (XBM_TK_NUMBER
);
2831 *p
++ = XBM_BIT_SHUFFLE (val
);
2832 if (!padding_p
|| ((i
+ 2) % bytes_per_line
))
2833 *p
++ = XBM_BIT_SHUFFLE (value
>> 8);
2835 if (LA1
== ',' || LA1
== '}')
2843 for (i
= 0; i
< nbytes
; ++i
)
2846 expect (XBM_TK_NUMBER
);
2848 *p
++ = XBM_BIT_SHUFFLE (val
);
2850 if (LA1
== ',' || LA1
== '}')
2875 /* Load XBM image IMG which will be displayed on frame F from buffer
2876 CONTENTS. END is the end of the buffer. Value is true if
2880 xbm_load_image (struct frame
*f
, struct image
*img
, unsigned char *contents
,
2887 rc
= xbm_read_bitmap_data (f
, contents
, end
, &img
->width
, &img
->height
,
2891 unsigned long foreground
= FRAME_FOREGROUND_PIXEL (f
);
2892 unsigned long background
= FRAME_BACKGROUND_PIXEL (f
);
2893 bool non_default_colors
= 0;
2896 eassert (img
->width
> 0 && img
->height
> 0);
2898 /* Get foreground and background colors, maybe allocate colors. */
2899 value
= image_spec_value (img
->spec
, QCforeground
, NULL
);
2902 foreground
= x_alloc_image_color (f
, img
, value
, foreground
);
2903 non_default_colors
= 1;
2905 value
= image_spec_value (img
->spec
, QCbackground
, NULL
);
2908 background
= x_alloc_image_color (f
, img
, value
, background
);
2909 img
->background
= background
;
2910 img
->background_valid
= 1;
2911 non_default_colors
= 1;
2914 Create_Pixmap_From_Bitmap_Data (f
, img
, data
,
2915 foreground
, background
,
2916 non_default_colors
);
2919 if (img
->pixmap
== NO_PIXMAP
)
2921 x_clear_image (f
, img
);
2922 image_error ("Unable to create X pixmap for `%s'", img
->spec
, Qnil
);
2928 image_error ("Error loading XBM image `%s'", img
->spec
, Qnil
);
2934 /* Value is true if DATA looks like an in-memory XBM file. */
2937 xbm_file_p (Lisp_Object data
)
2940 return (STRINGP (data
)
2941 && xbm_read_bitmap_data (NULL
, SDATA (data
),
2942 (SDATA (data
) + SBYTES (data
)),
2947 /* Fill image IMG which is used on frame F with pixmap data. Value is
2948 true if successful. */
2951 xbm_load (struct frame
*f
, struct image
*img
)
2954 Lisp_Object file_name
;
2956 eassert (xbm_image_p (img
->spec
));
2958 /* If IMG->spec specifies a file name, create a non-file spec from it. */
2959 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
2960 if (STRINGP (file_name
))
2963 unsigned char *contents
;
2966 file
= x_find_image_file (file_name
);
2967 if (!STRINGP (file
))
2969 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
2973 contents
= slurp_file (SSDATA (file
), &size
);
2974 if (contents
== NULL
)
2976 image_error ("Error loading XBM image `%s'", img
->spec
, Qnil
);
2980 success_p
= xbm_load_image (f
, img
, contents
, contents
+ size
);
2985 struct image_keyword fmt
[XBM_LAST
];
2987 unsigned long foreground
= FRAME_FOREGROUND_PIXEL (f
);
2988 unsigned long background
= FRAME_BACKGROUND_PIXEL (f
);
2989 bool non_default_colors
= 0;
2992 bool in_memory_file_p
= 0;
2994 /* See if data looks like an in-memory XBM file. */
2995 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
2996 in_memory_file_p
= xbm_file_p (data
);
2998 /* Parse the image specification. */
2999 memcpy (fmt
, xbm_format
, sizeof fmt
);
3000 parsed_p
= parse_image_spec (img
->spec
, fmt
, XBM_LAST
, Qxbm
);
3003 /* Get specified width, and height. */
3004 if (!in_memory_file_p
)
3006 img
->width
= XFASTINT (fmt
[XBM_WIDTH
].value
);
3007 img
->height
= XFASTINT (fmt
[XBM_HEIGHT
].value
);
3008 eassert (img
->width
> 0 && img
->height
> 0);
3009 if (!check_image_size (f
, img
->width
, img
->height
))
3011 image_error ("Invalid image size (see `max-image-size')",
3017 /* Get foreground and background colors, maybe allocate colors. */
3018 if (fmt
[XBM_FOREGROUND
].count
3019 && STRINGP (fmt
[XBM_FOREGROUND
].value
))
3021 foreground
= x_alloc_image_color (f
, img
, fmt
[XBM_FOREGROUND
].value
,
3023 non_default_colors
= 1;
3026 if (fmt
[XBM_BACKGROUND
].count
3027 && STRINGP (fmt
[XBM_BACKGROUND
].value
))
3029 background
= x_alloc_image_color (f
, img
, fmt
[XBM_BACKGROUND
].value
,
3031 non_default_colors
= 1;
3034 if (in_memory_file_p
)
3035 success_p
= xbm_load_image (f
, img
, SDATA (data
),
3044 int nbytes
= (img
->width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
;
3046 p
= bits
= alloca (nbytes
* img
->height
);
3047 for (i
= 0; i
< img
->height
; ++i
, p
+= nbytes
)
3049 Lisp_Object line
= AREF (data
, i
);
3051 memcpy (p
, SDATA (line
), nbytes
);
3053 memcpy (p
, bool_vector_data (line
), nbytes
);
3056 else if (STRINGP (data
))
3057 bits
= SSDATA (data
);
3059 bits
= (char *) bool_vector_data (data
);
3065 /* Windows mono bitmaps are reversed compared with X. */
3066 invertedBits
= bits
;
3067 nbytes
= (img
->width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
3069 bits
= alloca (nbytes
);
3070 for (i
= 0; i
< nbytes
; i
++)
3071 bits
[i
] = XBM_BIT_SHUFFLE (invertedBits
[i
]);
3074 /* Create the pixmap. */
3076 if (x_check_image_size (0, img
->width
, img
->height
))
3077 Create_Pixmap_From_Bitmap_Data (f
, img
, bits
,
3078 foreground
, background
,
3079 non_default_colors
);
3081 img
->pixmap
= NO_PIXMAP
;
3087 image_error ("Unable to create pixmap for XBM image `%s'",
3089 x_clear_image (f
, img
);
3099 /***********************************************************************
3101 ***********************************************************************/
3103 #if defined (HAVE_XPM) || defined (HAVE_NS)
3105 static bool xpm_image_p (Lisp_Object object
);
3106 static bool xpm_load (struct frame
*f
, struct image
*img
);
3108 #endif /* HAVE_XPM || HAVE_NS */
3112 /* Indicate to xpm.h that we don't have Xlib. */
3114 /* simx.h in xpm defines XColor and XImage differently than Emacs. */
3115 /* It also defines Display the same way as Emacs, but gcc 3.3 still barfs. */
3116 #define XColor xpm_XColor
3117 #define XImage xpm_XImage
3118 #define Display xpm_Display
3119 #define PIXEL_ALREADY_TYPEDEFED
3120 #include "X11/xpm.h"
3125 #undef PIXEL_ALREADY_TYPEDEFED
3127 #include "X11/xpm.h"
3128 #endif /* HAVE_NTGUI */
3129 #endif /* HAVE_XPM */
3131 #if defined (HAVE_XPM) || defined (HAVE_NS)
3132 /* The symbol `xpm' identifying XPM-format images. */
3134 static Lisp_Object Qxpm
;
3136 /* Indices of image specification fields in xpm_format, below. */
3138 enum xpm_keyword_index
3154 /* Vector of image_keyword structures describing the format
3155 of valid XPM image specifications. */
3157 static const struct image_keyword xpm_format
[XPM_LAST
] =
3159 {":type", IMAGE_SYMBOL_VALUE
, 1},
3160 {":file", IMAGE_STRING_VALUE
, 0},
3161 {":data", IMAGE_STRING_VALUE
, 0},
3162 {":ascent", IMAGE_ASCENT_VALUE
, 0},
3163 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
3164 {":relief", IMAGE_INTEGER_VALUE
, 0},
3165 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3166 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3167 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3168 {":color-symbols", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3169 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
3172 #if defined HAVE_NTGUI && defined WINDOWSNT
3173 static bool init_xpm_functions (void);
3175 #define init_xpm_functions NULL
3178 /* Structure describing the image type XPM. */
3180 static struct image_type xpm_type
=
3190 #ifdef HAVE_X_WINDOWS
3192 /* Define ALLOC_XPM_COLORS if we can use Emacs' own color allocation
3193 functions for allocating image colors. Our own functions handle
3194 color allocation failures more gracefully than the ones on the XPM
3197 #if defined XpmAllocColor && defined XpmFreeColors && defined XpmColorClosure
3198 #define ALLOC_XPM_COLORS
3200 #endif /* HAVE_X_WINDOWS */
3202 #ifdef ALLOC_XPM_COLORS
3204 static struct xpm_cached_color
*xpm_cache_color (struct frame
*, char *,
3207 /* An entry in a hash table used to cache color definitions of named
3208 colors. This cache is necessary to speed up XPM image loading in
3209 case we do color allocations ourselves. Without it, we would need
3210 a call to XParseColor per pixel in the image. */
3212 struct xpm_cached_color
3214 /* Next in collision chain. */
3215 struct xpm_cached_color
*next
;
3217 /* Color definition (RGB and pixel color). */
3221 char name
[FLEXIBLE_ARRAY_MEMBER
];
3224 /* The hash table used for the color cache, and its bucket vector
3227 #define XPM_COLOR_CACHE_BUCKETS 1001
3228 static struct xpm_cached_color
**xpm_color_cache
;
3230 /* Initialize the color cache. */
3233 xpm_init_color_cache (struct frame
*f
, XpmAttributes
*attrs
)
3235 size_t nbytes
= XPM_COLOR_CACHE_BUCKETS
* sizeof *xpm_color_cache
;
3236 xpm_color_cache
= xzalloc (nbytes
);
3237 init_color_table ();
3239 if (attrs
->valuemask
& XpmColorSymbols
)
3244 for (i
= 0; i
< attrs
->numsymbols
; ++i
)
3245 if (XParseColor (FRAME_X_DISPLAY (f
), FRAME_X_COLORMAP (f
),
3246 attrs
->colorsymbols
[i
].value
, &color
))
3248 color
.pixel
= lookup_rgb_color (f
, color
.red
, color
.green
,
3250 xpm_cache_color (f
, attrs
->colorsymbols
[i
].name
, &color
, -1);
3255 /* Free the color cache. */
3258 xpm_free_color_cache (void)
3260 struct xpm_cached_color
*p
, *next
;
3263 for (i
= 0; i
< XPM_COLOR_CACHE_BUCKETS
; ++i
)
3264 for (p
= xpm_color_cache
[i
]; p
; p
= next
)
3270 xfree (xpm_color_cache
);
3271 xpm_color_cache
= NULL
;
3272 free_color_table ();
3275 /* Return the bucket index for color named COLOR_NAME in the color
3279 xpm_color_bucket (char *color_name
)
3281 EMACS_UINT hash
= hash_string (color_name
, strlen (color_name
));
3282 return hash
% XPM_COLOR_CACHE_BUCKETS
;
3286 /* On frame F, cache values COLOR for color with name COLOR_NAME.
3287 BUCKET, if >= 0, is a precomputed bucket index. Value is the cache
3290 static struct xpm_cached_color
*
3291 xpm_cache_color (struct frame
*f
, char *color_name
, XColor
*color
, int bucket
)
3294 struct xpm_cached_color
*p
;
3297 bucket
= xpm_color_bucket (color_name
);
3299 nbytes
= offsetof (struct xpm_cached_color
, name
) + strlen (color_name
) + 1;
3300 p
= xmalloc (nbytes
);
3301 strcpy (p
->name
, color_name
);
3303 p
->next
= xpm_color_cache
[bucket
];
3304 xpm_color_cache
[bucket
] = p
;
3308 /* Look up color COLOR_NAME for frame F in the color cache. If found,
3309 return the cached definition in *COLOR. Otherwise, make a new
3310 entry in the cache and allocate the color. Value is false if color
3311 allocation failed. */
3314 xpm_lookup_color (struct frame
*f
, char *color_name
, XColor
*color
)
3316 struct xpm_cached_color
*p
;
3317 int h
= xpm_color_bucket (color_name
);
3319 for (p
= xpm_color_cache
[h
]; p
; p
= p
->next
)
3320 if (strcmp (p
->name
, color_name
) == 0)
3325 else if (XParseColor (FRAME_X_DISPLAY (f
), FRAME_X_COLORMAP (f
),
3328 color
->pixel
= lookup_rgb_color (f
, color
->red
, color
->green
,
3330 p
= xpm_cache_color (f
, color_name
, color
, h
);
3332 /* You get `opaque' at least from ImageMagick converting pbm to xpm
3333 with transparency, and it's useful. */
3334 else if (strcmp ("opaque", color_name
) == 0)
3336 memset (color
, 0, sizeof (XColor
)); /* Is this necessary/correct? */
3337 color
->pixel
= FRAME_FOREGROUND_PIXEL (f
);
3338 p
= xpm_cache_color (f
, color_name
, color
, h
);
3345 /* Callback for allocating color COLOR_NAME. Called from the XPM lib.
3346 CLOSURE is a pointer to the frame on which we allocate the
3347 color. Return in *COLOR the allocated color. Value is non-zero
3351 xpm_alloc_color (Display
*dpy
, Colormap cmap
, char *color_name
, XColor
*color
,
3354 return xpm_lookup_color (closure
, color_name
, color
);
3358 /* Callback for freeing NPIXELS colors contained in PIXELS. CLOSURE
3359 is a pointer to the frame on which we allocate the color. Value is
3360 non-zero if successful. */
3363 xpm_free_colors (Display
*dpy
, Colormap cmap
, Pixel
*pixels
, int npixels
, void *closure
)
3368 #endif /* ALLOC_XPM_COLORS */
3373 /* XPM library details. */
3375 DEF_IMGLIB_FN (void, XpmFreeAttributes
, (XpmAttributes
*));
3376 DEF_IMGLIB_FN (int, XpmCreateImageFromBuffer
, (Display
*, char *, xpm_XImage
**,
3377 xpm_XImage
**, XpmAttributes
*));
3378 DEF_IMGLIB_FN (int, XpmReadFileToImage
, (Display
*, char *, xpm_XImage
**,
3379 xpm_XImage
**, XpmAttributes
*));
3380 DEF_IMGLIB_FN (void, XImageFree
, (xpm_XImage
*));
3383 init_xpm_functions (void)
3387 if (!(library
= w32_delayed_load (Qxpm
)))
3390 LOAD_IMGLIB_FN (library
, XpmFreeAttributes
);
3391 LOAD_IMGLIB_FN (library
, XpmCreateImageFromBuffer
);
3392 LOAD_IMGLIB_FN (library
, XpmReadFileToImage
);
3393 LOAD_IMGLIB_FN (library
, XImageFree
);
3397 #endif /* WINDOWSNT */
3399 #if defined HAVE_NTGUI && !defined WINDOWSNT
3400 /* Glue for code below */
3401 #define fn_XpmReadFileToImage XpmReadFileToImage
3402 #define fn_XpmCreateImageFromBuffer XpmCreateImageFromBuffer
3403 #define fn_XImageFree XImageFree
3404 #define fn_XpmFreeAttributes XpmFreeAttributes
3405 #endif /* HAVE_NTGUI && !WINDOWSNT */
3407 /* Value is true if COLOR_SYMBOLS is a valid color symbols list
3408 for XPM images. Such a list must consist of conses whose car and
3412 xpm_valid_color_symbols_p (Lisp_Object color_symbols
)
3414 while (CONSP (color_symbols
))
3416 Lisp_Object sym
= XCAR (color_symbols
);
3418 || !STRINGP (XCAR (sym
))
3419 || !STRINGP (XCDR (sym
)))
3421 color_symbols
= XCDR (color_symbols
);
3424 return NILP (color_symbols
);
3428 /* Value is true if OBJECT is a valid XPM image specification. */
3431 xpm_image_p (Lisp_Object object
)
3433 struct image_keyword fmt
[XPM_LAST
];
3434 memcpy (fmt
, xpm_format
, sizeof fmt
);
3435 return (parse_image_spec (object
, fmt
, XPM_LAST
, Qxpm
)
3436 /* Either `:file' or `:data' must be present. */
3437 && fmt
[XPM_FILE
].count
+ fmt
[XPM_DATA
].count
== 1
3438 /* Either no `:color-symbols' or it's a list of conses
3439 whose car and cdr are strings. */
3440 && (fmt
[XPM_COLOR_SYMBOLS
].count
== 0
3441 || xpm_valid_color_symbols_p (fmt
[XPM_COLOR_SYMBOLS
].value
)));
3444 #endif /* HAVE_XPM || HAVE_NS */
3446 #if defined HAVE_XPM && defined HAVE_X_WINDOWS && !defined USE_GTK
3448 x_create_bitmap_from_xpm_data (struct frame
*f
, const char **bits
)
3450 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
3453 XpmAttributes attrs
;
3454 Pixmap bitmap
, mask
;
3456 memset (&attrs
, 0, sizeof attrs
);
3458 attrs
.visual
= FRAME_X_VISUAL (f
);
3459 attrs
.colormap
= FRAME_X_COLORMAP (f
);
3460 attrs
.valuemask
|= XpmVisual
;
3461 attrs
.valuemask
|= XpmColormap
;
3463 rc
= XpmCreatePixmapFromData (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
3464 (char **) bits
, &bitmap
, &mask
, &attrs
);
3465 if (rc
!= XpmSuccess
)
3467 XpmFreeAttributes (&attrs
);
3471 id
= x_allocate_bitmap_record (f
);
3472 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
3473 dpyinfo
->bitmaps
[id
- 1].have_mask
= true;
3474 dpyinfo
->bitmaps
[id
- 1].mask
= mask
;
3475 dpyinfo
->bitmaps
[id
- 1].file
= NULL
;
3476 dpyinfo
->bitmaps
[id
- 1].height
= attrs
.height
;
3477 dpyinfo
->bitmaps
[id
- 1].width
= attrs
.width
;
3478 dpyinfo
->bitmaps
[id
- 1].depth
= attrs
.depth
;
3479 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
3481 XpmFreeAttributes (&attrs
);
3484 #endif /* defined (HAVE_XPM) && defined (HAVE_X_WINDOWS) */
3486 /* Load image IMG which will be displayed on frame F. Value is
3487 true if successful. */
3492 xpm_load (struct frame
*f
, struct image
*img
)
3495 XpmAttributes attrs
;
3496 Lisp_Object specified_file
, color_symbols
;
3499 xpm_XImage
* xpm_image
= NULL
, * xpm_mask
= NULL
;
3500 #endif /* HAVE_NTGUI */
3502 /* Configure the XPM lib. Use the visual of frame F. Allocate
3503 close colors. Return colors allocated. */
3504 memset (&attrs
, 0, sizeof attrs
);
3507 attrs
.visual
= FRAME_X_VISUAL (f
);
3508 attrs
.colormap
= FRAME_X_COLORMAP (f
);
3509 attrs
.valuemask
|= XpmVisual
;
3510 attrs
.valuemask
|= XpmColormap
;
3511 #endif /* HAVE_NTGUI */
3513 #ifdef ALLOC_XPM_COLORS
3514 /* Allocate colors with our own functions which handle
3515 failing color allocation more gracefully. */
3516 attrs
.color_closure
= f
;
3517 attrs
.alloc_color
= xpm_alloc_color
;
3518 attrs
.free_colors
= xpm_free_colors
;
3519 attrs
.valuemask
|= XpmAllocColor
| XpmFreeColors
| XpmColorClosure
;
3520 #else /* not ALLOC_XPM_COLORS */
3521 /* Let the XPM lib allocate colors. */
3522 attrs
.valuemask
|= XpmReturnAllocPixels
;
3523 #ifdef XpmAllocCloseColors
3524 attrs
.alloc_close_colors
= 1;
3525 attrs
.valuemask
|= XpmAllocCloseColors
;
3526 #else /* not XpmAllocCloseColors */
3527 attrs
.closeness
= 600;
3528 attrs
.valuemask
|= XpmCloseness
;
3529 #endif /* not XpmAllocCloseColors */
3530 #endif /* ALLOC_XPM_COLORS */
3532 /* If image specification contains symbolic color definitions, add
3533 these to `attrs'. */
3534 color_symbols
= image_spec_value (img
->spec
, QCcolor_symbols
, NULL
);
3535 if (CONSP (color_symbols
))
3538 XpmColorSymbol
*xpm_syms
;
3541 attrs
.valuemask
|= XpmColorSymbols
;
3543 /* Count number of symbols. */
3544 attrs
.numsymbols
= 0;
3545 for (tail
= color_symbols
; CONSP (tail
); tail
= XCDR (tail
))
3548 /* Allocate an XpmColorSymbol array. */
3549 size
= attrs
.numsymbols
* sizeof *xpm_syms
;
3550 xpm_syms
= alloca (size
);
3551 memset (xpm_syms
, 0, size
);
3552 attrs
.colorsymbols
= xpm_syms
;
3554 /* Fill the color symbol array. */
3555 for (tail
= color_symbols
, i
= 0;
3557 ++i
, tail
= XCDR (tail
))
3561 char *empty_string
= (char *) "";
3563 if (!CONSP (XCAR (tail
)))
3565 xpm_syms
[i
].name
= empty_string
;
3566 xpm_syms
[i
].value
= empty_string
;
3569 name
= XCAR (XCAR (tail
));
3570 color
= XCDR (XCAR (tail
));
3573 xpm_syms
[i
].name
= alloca (SCHARS (name
) + 1);
3574 strcpy (xpm_syms
[i
].name
, SSDATA (name
));
3577 xpm_syms
[i
].name
= empty_string
;
3578 if (STRINGP (color
))
3580 xpm_syms
[i
].value
= alloca (SCHARS (color
) + 1);
3581 strcpy (xpm_syms
[i
].value
, SSDATA (color
));
3584 xpm_syms
[i
].value
= empty_string
;
3588 /* Create a pixmap for the image, either from a file, or from a
3589 string buffer containing data in the same format as an XPM file. */
3590 #ifdef ALLOC_XPM_COLORS
3591 xpm_init_color_cache (f
, &attrs
);
3594 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
3598 HDC frame_dc
= get_frame_dc (f
);
3599 hdc
= CreateCompatibleDC (frame_dc
);
3600 release_frame_dc (f
, frame_dc
);
3602 #endif /* HAVE_NTGUI */
3604 if (STRINGP (specified_file
))
3606 Lisp_Object file
= x_find_image_file (specified_file
);
3607 if (!STRINGP (file
))
3609 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
3610 #ifdef ALLOC_XPM_COLORS
3611 xpm_free_color_cache ();
3618 /* FILE is encoded in UTF-8, but image libraries on Windows
3619 support neither UTF-8 nor UTF-16 encoded file names. So we
3620 need to re-encode it in ANSI. */
3621 file
= ansi_encode_filename (file
);
3623 /* XpmReadFileToPixmap is not available in the Windows port of
3624 libxpm. But XpmReadFileToImage almost does what we want. */
3625 rc
= fn_XpmReadFileToImage (&hdc
, SDATA (file
),
3626 &xpm_image
, &xpm_mask
,
3629 rc
= XpmReadFileToImage (FRAME_X_DISPLAY (f
), SSDATA (file
),
3630 &img
->ximg
, &img
->mask_img
,
3632 #endif /* HAVE_NTGUI */
3636 Lisp_Object buffer
= image_spec_value (img
->spec
, QCdata
, NULL
);
3637 if (!STRINGP (buffer
))
3639 image_error ("Invalid image data `%s'", buffer
, Qnil
);
3640 #ifdef ALLOC_XPM_COLORS
3641 xpm_free_color_cache ();
3646 /* XpmCreatePixmapFromBuffer is not available in the Windows port
3647 of libxpm. But XpmCreateImageFromBuffer almost does what we want. */
3648 rc
= fn_XpmCreateImageFromBuffer (&hdc
, SDATA (buffer
),
3649 &xpm_image
, &xpm_mask
,
3652 rc
= XpmCreateImageFromBuffer (FRAME_X_DISPLAY (f
), SSDATA (buffer
),
3653 &img
->ximg
, &img
->mask_img
,
3655 #endif /* HAVE_NTGUI */
3658 #ifdef HAVE_X_WINDOWS
3659 if (rc
== XpmSuccess
)
3661 img
->pixmap
= XCreatePixmap (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
3662 img
->ximg
->width
, img
->ximg
->height
,
3664 if (img
->pixmap
== NO_PIXMAP
)
3666 x_clear_image (f
, img
);
3669 else if (img
->mask_img
)
3671 img
->mask
= XCreatePixmap (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
3672 img
->mask_img
->width
,
3673 img
->mask_img
->height
,
3674 img
->mask_img
->depth
);
3675 if (img
->mask
== NO_PIXMAP
)
3677 x_clear_image (f
, img
);
3684 if (rc
== XpmSuccess
)
3686 #if defined (COLOR_TABLE_SUPPORT) && defined (ALLOC_XPM_COLORS)
3687 img
->colors
= colors_in_color_table (&img
->ncolors
);
3688 #else /* not ALLOC_XPM_COLORS */
3692 /* W32 XPM uses XImage to wrap what W32 Emacs calls a Pixmap,
3693 plus some duplicate attributes. */
3694 if (xpm_image
&& xpm_image
->bitmap
)
3696 img
->pixmap
= xpm_image
->bitmap
;
3697 /* XImageFree in libXpm frees XImage struct without destroying
3698 the bitmap, which is what we want. */
3699 fn_XImageFree (xpm_image
);
3701 if (xpm_mask
&& xpm_mask
->bitmap
)
3703 /* The mask appears to be inverted compared with what we expect.
3704 TODO: invert our expectations. See other places where we
3705 have to invert bits because our idea of masks is backwards. */
3707 old_obj
= SelectObject (hdc
, xpm_mask
->bitmap
);
3709 PatBlt (hdc
, 0, 0, xpm_mask
->width
, xpm_mask
->height
, DSTINVERT
);
3710 SelectObject (hdc
, old_obj
);
3712 img
->mask
= xpm_mask
->bitmap
;
3713 fn_XImageFree (xpm_mask
);
3718 #endif /* HAVE_NTGUI */
3720 /* Remember allocated colors. */
3721 img
->colors
= xnmalloc (attrs
.nalloc_pixels
, sizeof *img
->colors
);
3722 img
->ncolors
= attrs
.nalloc_pixels
;
3723 for (i
= 0; i
< attrs
.nalloc_pixels
; ++i
)
3725 img
->colors
[i
] = attrs
.alloc_pixels
[i
];
3726 #ifdef DEBUG_X_COLORS
3727 register_color (img
->colors
[i
]);
3730 #endif /* not ALLOC_XPM_COLORS */
3732 img
->width
= attrs
.width
;
3733 img
->height
= attrs
.height
;
3734 eassert (img
->width
> 0 && img
->height
> 0);
3736 /* The call to XpmFreeAttributes below frees attrs.alloc_pixels. */
3738 fn_XpmFreeAttributes (&attrs
);
3740 XpmFreeAttributes (&attrs
);
3741 #endif /* HAVE_NTGUI */
3743 #ifdef HAVE_X_WINDOWS
3744 /* Maybe fill in the background field while we have ximg handy. */
3745 IMAGE_BACKGROUND (img
, f
, img
->ximg
);
3747 /* Fill in the background_transparent field while we have the
3749 image_background_transparent (img
, f
, img
->mask_img
);
3756 #endif /* HAVE_NTGUI */
3761 image_error ("Error opening XPM file (%s)", img
->spec
, Qnil
);
3764 case XpmFileInvalid
:
3765 image_error ("Invalid XPM file (%s)", img
->spec
, Qnil
);
3769 image_error ("Out of memory (%s)", img
->spec
, Qnil
);
3772 case XpmColorFailed
:
3773 image_error ("Color allocation error (%s)", img
->spec
, Qnil
);
3777 image_error ("Unknown error (%s)", img
->spec
, Qnil
);
3782 #ifdef ALLOC_XPM_COLORS
3783 xpm_free_color_cache ();
3785 return rc
== XpmSuccess
;
3788 #endif /* HAVE_XPM */
3790 #if defined (HAVE_NS) && !defined (HAVE_XPM)
3792 /* XPM support functions for NS where libxpm is not available.
3793 Only XPM version 3 (without any extensions) is supported. */
3795 static void xpm_put_color_table_v (Lisp_Object
, const unsigned char *,
3797 static Lisp_Object
xpm_get_color_table_v (Lisp_Object
,
3798 const unsigned char *, int);
3799 static void xpm_put_color_table_h (Lisp_Object
, const unsigned char *,
3801 static Lisp_Object
xpm_get_color_table_h (Lisp_Object
,
3802 const unsigned char *, int);
3804 /* Tokens returned from xpm_scan. */
3813 /* Scan an XPM data and return a character (< 256) or a token defined
3814 by enum xpm_token above. *S and END are the start (inclusive) and
3815 the end (exclusive) addresses of the data, respectively. Advance
3816 *S while scanning. If token is either XPM_TK_IDENT or
3817 XPM_TK_STRING, *BEG and *LEN are set to the start address and the
3818 length of the corresponding token, respectively. */
3821 xpm_scan (const unsigned char **s
,
3822 const unsigned char *end
,
3823 const unsigned char **beg
,
3830 /* Skip white-space. */
3831 while (*s
< end
&& (c
= *(*s
)++, c_isspace (c
)))
3834 /* gnus-pointer.xpm uses '-' in its identifier.
3835 sb-dir-plus.xpm uses '+' in its identifier. */
3836 if (c_isalpha (c
) || c
== '_' || c
== '-' || c
== '+')
3840 && (c
= **s
, c_isalnum (c
)
3841 || c
== '_' || c
== '-' || c
== '+'))
3844 return XPM_TK_IDENT
;
3849 while (*s
< end
&& **s
!= '"')
3854 return XPM_TK_STRING
;
3858 if (*s
< end
&& **s
== '*')
3860 /* C-style comment. */
3864 while (*s
< end
&& *(*s
)++ != '*')
3867 while (*s
< end
&& **s
!= '/');
3881 /* Functions for color table lookup in XPM data. A key is a string
3882 specifying the color of each pixel in XPM data. A value is either
3883 an integer that specifies a pixel color, Qt that specifies
3884 transparency, or Qnil for the unspecified color. If the length of
3885 the key string is one, a vector is used as a table. Otherwise, a
3886 hash table is used. */
3889 xpm_make_color_table_v (void (**put_func
) (Lisp_Object
,
3890 const unsigned char *,
3893 Lisp_Object (**get_func
) (Lisp_Object
,
3894 const unsigned char *,
3897 *put_func
= xpm_put_color_table_v
;
3898 *get_func
= xpm_get_color_table_v
;
3899 return Fmake_vector (make_number (256), Qnil
);
3903 xpm_put_color_table_v (Lisp_Object color_table
,
3904 const unsigned char *chars_start
,
3908 ASET (color_table
, *chars_start
, color
);
3912 xpm_get_color_table_v (Lisp_Object color_table
,
3913 const unsigned char *chars_start
,
3916 return AREF (color_table
, *chars_start
);
3920 xpm_make_color_table_h (void (**put_func
) (Lisp_Object
,
3921 const unsigned char *,
3924 Lisp_Object (**get_func
) (Lisp_Object
,
3925 const unsigned char *,
3928 *put_func
= xpm_put_color_table_h
;
3929 *get_func
= xpm_get_color_table_h
;
3930 return make_hash_table (hashtest_equal
, make_number (DEFAULT_HASH_SIZE
),
3931 make_float (DEFAULT_REHASH_SIZE
),
3932 make_float (DEFAULT_REHASH_THRESHOLD
),
3937 xpm_put_color_table_h (Lisp_Object color_table
,
3938 const unsigned char *chars_start
,
3942 struct Lisp_Hash_Table
*table
= XHASH_TABLE (color_table
);
3943 EMACS_UINT hash_code
;
3944 Lisp_Object chars
= make_unibyte_string (chars_start
, chars_len
);
3946 hash_lookup (table
, chars
, &hash_code
);
3947 hash_put (table
, chars
, color
, hash_code
);
3951 xpm_get_color_table_h (Lisp_Object color_table
,
3952 const unsigned char *chars_start
,
3955 struct Lisp_Hash_Table
*table
= XHASH_TABLE (color_table
);
3957 hash_lookup (table
, make_unibyte_string (chars_start
, chars_len
), NULL
);
3959 return i
>= 0 ? HASH_VALUE (table
, i
) : Qnil
;
3962 enum xpm_color_key
{
3970 static const char xpm_color_key_strings
[][4] = {"s", "m", "g4", "g", "c"};
3973 xpm_str_to_color_key (const char *s
)
3977 for (i
= 0; i
< ARRAYELTS (xpm_color_key_strings
); i
++)
3978 if (strcmp (xpm_color_key_strings
[i
], s
) == 0)
3984 xpm_load_image (struct frame
*f
,
3986 const unsigned char *contents
,
3987 const unsigned char *end
)
3989 const unsigned char *s
= contents
, *beg
, *str
;
3990 unsigned char buffer
[BUFSIZ
];
3991 int width
, height
, x
, y
;
3992 int num_colors
, chars_per_pixel
;
3995 void (*put_color_table
) (Lisp_Object
, const unsigned char *, int, Lisp_Object
);
3996 Lisp_Object (*get_color_table
) (Lisp_Object
, const unsigned char *, int);
3997 Lisp_Object frame
, color_symbols
, color_table
;
3999 bool have_mask
= false;
4000 XImagePtr ximg
= NULL
, mask_img
= NULL
;
4003 LA1 = xpm_scan (&s, end, &beg, &len)
4005 #define expect(TOKEN) \
4008 if (LA1 != (TOKEN)) \
4014 #define expect_ident(IDENT) \
4015 if (LA1 == XPM_TK_IDENT \
4016 && strlen ((IDENT)) == len && memcmp ((IDENT), beg, len) == 0) \
4021 if (!(end
- s
>= 9 && memcmp (s
, "/* XPM */", 9) == 0))
4025 expect_ident ("static");
4026 expect_ident ("char");
4028 expect (XPM_TK_IDENT
);
4033 expect (XPM_TK_STRING
);
4036 memcpy (buffer
, beg
, len
);
4038 if (sscanf (buffer
, "%d %d %d %d", &width
, &height
,
4039 &num_colors
, &chars_per_pixel
) != 4
4040 || width
<= 0 || height
<= 0
4041 || num_colors
<= 0 || chars_per_pixel
<= 0)
4044 if (!check_image_size (f
, width
, height
))
4046 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
4050 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, 0, &ximg
, 0)
4052 || !image_create_x_image_and_pixmap (f
, img
, width
, height
, 1,
4057 image_error ("Image too large", Qnil
, Qnil
);
4063 XSETFRAME (frame
, f
);
4064 if (!NILP (Fxw_display_color_p (frame
)))
4065 best_key
= XPM_COLOR_KEY_C
;
4066 else if (!NILP (Fx_display_grayscale_p (frame
)))
4067 best_key
= (XFASTINT (Fx_display_planes (frame
)) > 2
4068 ? XPM_COLOR_KEY_G
: XPM_COLOR_KEY_G4
);
4070 best_key
= XPM_COLOR_KEY_M
;
4072 color_symbols
= image_spec_value (img
->spec
, QCcolor_symbols
, NULL
);
4073 if (chars_per_pixel
== 1)
4074 color_table
= xpm_make_color_table_v (&put_color_table
,
4077 color_table
= xpm_make_color_table_h (&put_color_table
,
4080 while (num_colors
-- > 0)
4082 char *color
, *max_color
;
4083 int key
, next_key
, max_key
= 0;
4084 Lisp_Object symbol_color
= Qnil
, color_val
;
4087 expect (XPM_TK_STRING
);
4088 if (len
<= chars_per_pixel
|| len
>= BUFSIZ
+ chars_per_pixel
)
4090 memcpy (buffer
, beg
+ chars_per_pixel
, len
- chars_per_pixel
);
4091 buffer
[len
- chars_per_pixel
] = '\0';
4093 str
= strtok (buffer
, " \t");
4096 key
= xpm_str_to_color_key (str
);
4101 color
= strtok (NULL
, " \t");
4105 while ((str
= strtok (NULL
, " \t")) != NULL
)
4107 next_key
= xpm_str_to_color_key (str
);
4110 color
[strlen (color
)] = ' ';
4113 if (key
== XPM_COLOR_KEY_S
)
4115 if (NILP (symbol_color
))
4116 symbol_color
= build_string (color
);
4118 else if (max_key
< key
&& key
<= best_key
)
4128 if (!NILP (color_symbols
) && !NILP (symbol_color
))
4130 Lisp_Object specified_color
= Fassoc (symbol_color
, color_symbols
);
4132 if (CONSP (specified_color
) && STRINGP (XCDR (specified_color
)))
4134 if (xstrcasecmp (SSDATA (XCDR (specified_color
)), "None") == 0)
4136 else if (x_defined_color (f
, SSDATA (XCDR (specified_color
)),
4138 color_val
= make_number (cdef
.pixel
);
4141 if (NILP (color_val
) && max_key
> 0)
4143 if (xstrcasecmp (max_color
, "None") == 0)
4145 else if (x_defined_color (f
, max_color
, &cdef
, 0))
4146 color_val
= make_number (cdef
.pixel
);
4148 if (!NILP (color_val
))
4149 (*put_color_table
) (color_table
, beg
, chars_per_pixel
, color_val
);
4154 for (y
= 0; y
< height
; y
++)
4156 expect (XPM_TK_STRING
);
4158 if (len
< width
* chars_per_pixel
)
4160 for (x
= 0; x
< width
; x
++, str
+= chars_per_pixel
)
4162 Lisp_Object color_val
=
4163 (*get_color_table
) (color_table
, str
, chars_per_pixel
);
4165 XPutPixel (ximg
, x
, y
,
4166 (INTEGERP (color_val
) ? XINT (color_val
)
4167 : FRAME_FOREGROUND_PIXEL (f
)));
4169 XPutPixel (mask_img
, x
, y
,
4170 (!EQ (color_val
, Qt
) ? PIX_MASK_DRAW
4171 : (have_mask
= true, PIX_MASK_RETAIN
)));
4173 if (EQ (color_val
, Qt
))
4174 ns_set_alpha (ximg
, x
, y
, 0);
4182 img
->height
= height
;
4184 /* Maybe fill in the background field while we have ximg handy. */
4185 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
4186 IMAGE_BACKGROUND (img
, f
, ximg
);
4188 image_put_x_image (f
, img
, ximg
, 0);
4192 /* Fill in the background_transparent field while we have the
4194 image_background_transparent (img
, f
, mask_img
);
4196 image_put_x_image (f
, img
, mask_img
, 1);
4200 x_destroy_x_image (mask_img
);
4201 x_clear_image_1 (f
, img
, CLEAR_IMAGE_MASK
);
4207 image_error ("Invalid XPM file (%s)", img
->spec
, Qnil
);
4208 x_destroy_x_image (ximg
);
4209 x_destroy_x_image (mask_img
);
4210 x_clear_image (f
, img
);
4219 xpm_load (struct frame
*f
,
4223 Lisp_Object file_name
;
4225 /* If IMG->spec specifies a file name, create a non-file spec from it. */
4226 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
4227 if (STRINGP (file_name
))
4230 unsigned char *contents
;
4233 file
= x_find_image_file (file_name
);
4234 if (!STRINGP (file
))
4236 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
4240 contents
= slurp_file (SSDATA (file
), &size
);
4241 if (contents
== NULL
)
4243 image_error ("Error loading XPM image `%s'", img
->spec
, Qnil
);
4247 success_p
= xpm_load_image (f
, img
, contents
, contents
+ size
);
4254 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
4255 if (!STRINGP (data
))
4257 image_error ("Invalid image data `%s'", data
, Qnil
);
4260 success_p
= xpm_load_image (f
, img
, SDATA (data
),
4261 SDATA (data
) + SBYTES (data
));
4267 #endif /* HAVE_NS && !HAVE_XPM */
4271 /***********************************************************************
4273 ***********************************************************************/
4275 #ifdef COLOR_TABLE_SUPPORT
4277 /* An entry in the color table mapping an RGB color to a pixel color. */
4282 unsigned long pixel
;
4284 /* Next in color table collision list. */
4285 struct ct_color
*next
;
4288 /* The bucket vector size to use. Must be prime. */
4292 /* Value is a hash of the RGB color given by R, G, and B. */
4294 #define CT_HASH_RGB(R, G, B) (((R) << 16) ^ ((G) << 8) ^ (B))
4296 /* The color hash table. */
4298 static struct ct_color
**ct_table
;
4300 /* Number of entries in the color table. */
4302 static int ct_colors_allocated
;
4305 ct_colors_allocated_max
=
4307 min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof (unsigned long))
4310 /* Initialize the color table. */
4313 init_color_table (void)
4315 int size
= CT_SIZE
* sizeof (*ct_table
);
4316 ct_table
= xzalloc (size
);
4317 ct_colors_allocated
= 0;
4321 /* Free memory associated with the color table. */
4324 free_color_table (void)
4327 struct ct_color
*p
, *next
;
4329 for (i
= 0; i
< CT_SIZE
; ++i
)
4330 for (p
= ct_table
[i
]; p
; p
= next
)
4341 /* Value is a pixel color for RGB color R, G, B on frame F. If an
4342 entry for that color already is in the color table, return the
4343 pixel color of that entry. Otherwise, allocate a new color for R,
4344 G, B, and make an entry in the color table. */
4346 static unsigned long
4347 lookup_rgb_color (struct frame
*f
, int r
, int g
, int b
)
4349 unsigned hash
= CT_HASH_RGB (r
, g
, b
);
4350 int i
= hash
% CT_SIZE
;
4352 Display_Info
*dpyinfo
;
4354 /* Handle TrueColor visuals specially, which improves performance by
4355 two orders of magnitude. Freeing colors on TrueColor visuals is
4356 a nop, and pixel colors specify RGB values directly. See also
4357 the Xlib spec, chapter 3.1. */
4358 dpyinfo
= FRAME_DISPLAY_INFO (f
);
4359 if (dpyinfo
->red_bits
> 0)
4361 unsigned long pr
, pg
, pb
;
4363 /* Apply gamma-correction like normal color allocation does. */
4367 color
.red
= r
, color
.green
= g
, color
.blue
= b
;
4368 gamma_correct (f
, &color
);
4369 r
= color
.red
, g
= color
.green
, b
= color
.blue
;
4372 /* Scale down RGB values to the visual's bits per RGB, and shift
4373 them to the right position in the pixel color. Note that the
4374 original RGB values are 16-bit values, as usual in X. */
4375 pr
= (r
>> (16 - dpyinfo
->red_bits
)) << dpyinfo
->red_offset
;
4376 pg
= (g
>> (16 - dpyinfo
->green_bits
)) << dpyinfo
->green_offset
;
4377 pb
= (b
>> (16 - dpyinfo
->blue_bits
)) << dpyinfo
->blue_offset
;
4379 /* Assemble the pixel color. */
4380 return pr
| pg
| pb
;
4383 for (p
= ct_table
[i
]; p
; p
= p
->next
)
4384 if (p
->r
== r
&& p
->g
== g
&& p
->b
== b
)
4390 #ifdef HAVE_X_WINDOWS
4398 if (ct_colors_allocated_max
<= ct_colors_allocated
)
4399 return FRAME_FOREGROUND_PIXEL (f
);
4401 #ifdef HAVE_X_WINDOWS
4406 cmap
= FRAME_X_COLORMAP (f
);
4407 rc
= x_alloc_nearest_color (f
, cmap
, &color
);
4410 ++ct_colors_allocated
;
4411 p
= xmalloc (sizeof *p
);
4415 p
->pixel
= color
.pixel
;
4416 p
->next
= ct_table
[i
];
4420 return FRAME_FOREGROUND_PIXEL (f
);
4424 color
= PALETTERGB (r
, g
, b
);
4426 color
= RGB_TO_ULONG (r
, g
, b
);
4427 #endif /* HAVE_NTGUI */
4428 ++ct_colors_allocated
;
4429 p
= xmalloc (sizeof *p
);
4434 p
->next
= ct_table
[i
];
4436 #endif /* HAVE_X_WINDOWS */
4444 /* Look up pixel color PIXEL which is used on frame F in the color
4445 table. If not already present, allocate it. Value is PIXEL. */
4447 static unsigned long
4448 lookup_pixel_color (struct frame
*f
, unsigned long pixel
)
4450 int i
= pixel
% CT_SIZE
;
4453 for (p
= ct_table
[i
]; p
; p
= p
->next
)
4454 if (p
->pixel
== pixel
)
4463 if (ct_colors_allocated_max
<= ct_colors_allocated
)
4464 return FRAME_FOREGROUND_PIXEL (f
);
4466 #ifdef HAVE_X_WINDOWS
4467 cmap
= FRAME_X_COLORMAP (f
);
4468 color
.pixel
= pixel
;
4469 x_query_color (f
, &color
);
4470 rc
= x_alloc_nearest_color (f
, cmap
, &color
);
4473 cmap
= DefaultColormapOfScreen (FRAME_X_SCREEN (f
));
4474 color
.pixel
= pixel
;
4475 XQueryColor (NULL
, cmap
, &color
);
4476 rc
= x_alloc_nearest_color (f
, cmap
, &color
);
4478 #endif /* HAVE_X_WINDOWS */
4482 ++ct_colors_allocated
;
4484 p
= xmalloc (sizeof *p
);
4489 p
->next
= ct_table
[i
];
4493 return FRAME_FOREGROUND_PIXEL (f
);
4499 /* Value is a vector of all pixel colors contained in the color table,
4500 allocated via xmalloc. Set *N to the number of colors. */
4502 static unsigned long *
4503 colors_in_color_table (int *n
)
4507 unsigned long *colors
;
4509 if (ct_colors_allocated
== 0)
4516 colors
= xmalloc (ct_colors_allocated
* sizeof *colors
);
4517 *n
= ct_colors_allocated
;
4519 for (i
= j
= 0; i
< CT_SIZE
; ++i
)
4520 for (p
= ct_table
[i
]; p
; p
= p
->next
)
4521 colors
[j
++] = p
->pixel
;
4527 #else /* COLOR_TABLE_SUPPORT */
4529 static unsigned long
4530 lookup_rgb_color (struct frame
*f
, int r
, int g
, int b
)
4532 unsigned long pixel
;
4535 pixel
= PALETTERGB (r
>> 8, g
>> 8, b
>> 8);
4536 #endif /* HAVE_NTGUI */
4539 pixel
= RGB_TO_ULONG (r
>> 8, g
>> 8, b
>> 8);
4540 #endif /* HAVE_NS */
4545 init_color_table (void)
4548 #endif /* COLOR_TABLE_SUPPORT */
4551 /***********************************************************************
4553 ***********************************************************************/
4555 /* Edge detection matrices for different edge-detection
4558 static int emboss_matrix
[9] = {
4560 2, -1, 0, /* y - 1 */
4562 0, 1, -2 /* y + 1 */
4565 static int laplace_matrix
[9] = {
4567 1, 0, 0, /* y - 1 */
4569 0, 0, -1 /* y + 1 */
4572 /* Value is the intensity of the color whose red/green/blue values
4575 #define COLOR_INTENSITY(R, G, B) ((2 * (R) + 3 * (G) + (B)) / 6)
4578 /* On frame F, return an array of XColor structures describing image
4579 IMG->pixmap. Each XColor structure has its pixel color set. RGB_P
4580 means also fill the red/green/blue members of the XColor
4581 structures. Value is a pointer to the array of XColors structures,
4582 allocated with xmalloc; it must be freed by the caller. */
4585 x_to_xcolors (struct frame
*f
, struct image
*img
, bool rgb_p
)
4589 XImagePtr_or_DC ximg
;
4592 #endif /* HAVE_NTGUI */
4594 if (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *colors
/ img
->width
< img
->height
)
4595 memory_full (SIZE_MAX
);
4596 colors
= xmalloc (sizeof *colors
* img
->width
* img
->height
);
4598 /* Get the X image or create a memory device context for IMG. */
4599 ximg
= image_get_x_image_or_dc (f
, img
, 0, &prev
);
4601 /* Fill the `pixel' members of the XColor array. I wished there
4602 were an easy and portable way to circumvent XGetPixel. */
4604 for (y
= 0; y
< img
->height
; ++y
)
4606 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI)
4608 for (x
= 0; x
< img
->width
; ++x
, ++p
)
4609 p
->pixel
= GET_PIXEL (ximg
, x
, y
);
4611 x_query_colors (f
, row
, img
->width
);
4615 for (x
= 0; x
< img
->width
; ++x
, ++p
)
4617 /* W32_TODO: palette support needed here? */
4618 p
->pixel
= GET_PIXEL (ximg
, x
, y
);
4621 p
->red
= RED16_FROM_ULONG (p
->pixel
);
4622 p
->green
= GREEN16_FROM_ULONG (p
->pixel
);
4623 p
->blue
= BLUE16_FROM_ULONG (p
->pixel
);
4626 #endif /* HAVE_X_WINDOWS */
4629 image_unget_x_image_or_dc (img
, 0, ximg
, prev
);
4636 /* Put a pixel of COLOR at position X, Y in XIMG. XIMG must have been
4637 created with CreateDIBSection, with the pointer to the bit values
4638 stored in ximg->data. */
4641 XPutPixel (XImagePtr ximg
, int x
, int y
, COLORREF color
)
4643 int width
= ximg
->info
.bmiHeader
.biWidth
;
4644 unsigned char * pixel
;
4646 /* True color images. */
4647 if (ximg
->info
.bmiHeader
.biBitCount
== 24)
4649 int rowbytes
= width
* 3;
4650 /* Ensure scanlines are aligned on 4 byte boundaries. */
4652 rowbytes
+= 4 - (rowbytes
% 4);
4654 pixel
= ximg
->data
+ y
* rowbytes
+ x
* 3;
4655 /* Windows bitmaps are in BGR order. */
4656 *pixel
= GetBValue (color
);
4657 *(pixel
+ 1) = GetGValue (color
);
4658 *(pixel
+ 2) = GetRValue (color
);
4660 /* Monochrome images. */
4661 else if (ximg
->info
.bmiHeader
.biBitCount
== 1)
4663 int rowbytes
= width
/ 8;
4664 /* Ensure scanlines are aligned on 4 byte boundaries. */
4666 rowbytes
+= 4 - (rowbytes
% 4);
4667 pixel
= ximg
->data
+ y
* rowbytes
+ x
/ 8;
4668 /* Filter out palette info. */
4669 if (color
& 0x00ffffff)
4670 *pixel
= *pixel
| (1 << x
% 8);
4672 *pixel
= *pixel
& ~(1 << x
% 8);
4675 image_error ("XPutPixel: palette image not supported", Qnil
, Qnil
);
4678 #endif /* HAVE_NTGUI */
4680 /* Create IMG->pixmap from an array COLORS of XColor structures, whose
4681 RGB members are set. F is the frame on which this all happens.
4682 COLORS will be freed; an existing IMG->pixmap will be freed, too. */
4685 x_from_xcolors (struct frame
*f
, struct image
*img
, XColor
*colors
)
4688 XImagePtr oimg
= NULL
;
4691 init_color_table ();
4693 x_clear_image_1 (f
, img
, CLEAR_IMAGE_PIXMAP
| CLEAR_IMAGE_COLORS
);
4694 image_create_x_image_and_pixmap (f
, img
, img
->width
, img
->height
, 0,
4697 for (y
= 0; y
< img
->height
; ++y
)
4698 for (x
= 0; x
< img
->width
; ++x
, ++p
)
4700 unsigned long pixel
;
4701 pixel
= lookup_rgb_color (f
, p
->red
, p
->green
, p
->blue
);
4702 XPutPixel (oimg
, x
, y
, pixel
);
4707 image_put_x_image (f
, img
, oimg
, 0);
4708 #ifdef COLOR_TABLE_SUPPORT
4709 img
->colors
= colors_in_color_table (&img
->ncolors
);
4710 free_color_table ();
4711 #endif /* COLOR_TABLE_SUPPORT */
4715 /* On frame F, perform edge-detection on image IMG.
4717 MATRIX is a nine-element array specifying the transformation
4718 matrix. See emboss_matrix for an example.
4720 COLOR_ADJUST is a color adjustment added to each pixel of the
4724 x_detect_edges (struct frame
*f
, struct image
*img
, int *matrix
, int color_adjust
)
4726 XColor
*colors
= x_to_xcolors (f
, img
, 1);
4730 for (i
= sum
= 0; i
< 9; ++i
)
4731 sum
+= eabs (matrix
[i
]);
4733 #define COLOR(A, X, Y) ((A) + (Y) * img->width + (X))
4735 if (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *new / img
->width
< img
->height
)
4736 memory_full (SIZE_MAX
);
4737 new = xmalloc (sizeof *new * img
->width
* img
->height
);
4739 for (y
= 0; y
< img
->height
; ++y
)
4741 p
= COLOR (new, 0, y
);
4742 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4743 p
= COLOR (new, img
->width
- 1, y
);
4744 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4747 for (x
= 1; x
< img
->width
- 1; ++x
)
4749 p
= COLOR (new, x
, 0);
4750 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4751 p
= COLOR (new, x
, img
->height
- 1);
4752 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4755 for (y
= 1; y
< img
->height
- 1; ++y
)
4757 p
= COLOR (new, 1, y
);
4759 for (x
= 1; x
< img
->width
- 1; ++x
, ++p
)
4761 int r
, g
, b
, yy
, xx
;
4764 for (yy
= y
- 1; yy
< y
+ 2; ++yy
)
4765 for (xx
= x
- 1; xx
< x
+ 2; ++xx
, ++i
)
4768 XColor
*t
= COLOR (colors
, xx
, yy
);
4769 r
+= matrix
[i
] * t
->red
;
4770 g
+= matrix
[i
] * t
->green
;
4771 b
+= matrix
[i
] * t
->blue
;
4774 r
= (r
/ sum
+ color_adjust
) & 0xffff;
4775 g
= (g
/ sum
+ color_adjust
) & 0xffff;
4776 b
= (b
/ sum
+ color_adjust
) & 0xffff;
4777 p
->red
= p
->green
= p
->blue
= COLOR_INTENSITY (r
, g
, b
);
4782 x_from_xcolors (f
, img
, new);
4788 /* Perform the pre-defined `emboss' edge-detection on image IMG
4792 x_emboss (struct frame
*f
, struct image
*img
)
4794 x_detect_edges (f
, img
, emboss_matrix
, 0xffff / 2);
4798 /* Transform image IMG which is used on frame F with a Laplace
4799 edge-detection algorithm. The result is an image that can be used
4800 to draw disabled buttons, for example. */
4803 x_laplace (struct frame
*f
, struct image
*img
)
4805 x_detect_edges (f
, img
, laplace_matrix
, 45000);
4809 /* Perform edge-detection on image IMG on frame F, with specified
4810 transformation matrix MATRIX and color-adjustment COLOR_ADJUST.
4812 MATRIX must be either
4814 - a list of at least 9 numbers in row-major form
4815 - a vector of at least 9 numbers
4817 COLOR_ADJUST nil means use a default; otherwise it must be a
4821 x_edge_detection (struct frame
*f
, struct image
*img
, Lisp_Object matrix
,
4822 Lisp_Object color_adjust
)
4830 i
< 9 && CONSP (matrix
) && NUMBERP (XCAR (matrix
));
4831 ++i
, matrix
= XCDR (matrix
))
4832 trans
[i
] = XFLOATINT (XCAR (matrix
));
4834 else if (VECTORP (matrix
) && ASIZE (matrix
) >= 9)
4836 for (i
= 0; i
< 9 && NUMBERP (AREF (matrix
, i
)); ++i
)
4837 trans
[i
] = XFLOATINT (AREF (matrix
, i
));
4840 if (NILP (color_adjust
))
4841 color_adjust
= make_number (0xffff / 2);
4843 if (i
== 9 && NUMBERP (color_adjust
))
4844 x_detect_edges (f
, img
, trans
, XFLOATINT (color_adjust
));
4848 /* Transform image IMG on frame F so that it looks disabled. */
4851 x_disable_image (struct frame
*f
, struct image
*img
)
4853 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
4855 int n_planes
= dpyinfo
->n_planes
* dpyinfo
->n_cbits
;
4857 int n_planes
= dpyinfo
->n_planes
;
4858 #endif /* HAVE_NTGUI */
4862 /* Color (or grayscale). Convert to gray, and equalize. Just
4863 drawing such images with a stipple can look very odd, so
4864 we're using this method instead. */
4865 XColor
*colors
= x_to_xcolors (f
, img
, 1);
4867 const int h
= 15000;
4868 const int l
= 30000;
4870 for (p
= colors
, end
= colors
+ img
->width
* img
->height
;
4874 int i
= COLOR_INTENSITY (p
->red
, p
->green
, p
->blue
);
4875 int i2
= (0xffff - h
- l
) * i
/ 0xffff + l
;
4876 p
->red
= p
->green
= p
->blue
= i2
;
4879 x_from_xcolors (f
, img
, colors
);
4882 /* Draw a cross over the disabled image, if we must or if we
4884 if (n_planes
< 2 || cross_disabled_images
)
4887 #ifndef HAVE_NS /* TODO: NS support, however this not needed for toolbars */
4889 #define MaskForeground(f) WHITE_PIX_DEFAULT (f)
4891 Display
*dpy
= FRAME_X_DISPLAY (f
);
4894 image_sync_to_pixmaps (f
, img
);
4895 gc
= XCreateGC (dpy
, img
->pixmap
, 0, NULL
);
4896 XSetForeground (dpy
, gc
, BLACK_PIX_DEFAULT (f
));
4897 XDrawLine (dpy
, img
->pixmap
, gc
, 0, 0,
4898 img
->width
- 1, img
->height
- 1);
4899 XDrawLine (dpy
, img
->pixmap
, gc
, 0, img
->height
- 1,
4905 gc
= XCreateGC (dpy
, img
->mask
, 0, NULL
);
4906 XSetForeground (dpy
, gc
, MaskForeground (f
));
4907 XDrawLine (dpy
, img
->mask
, gc
, 0, 0,
4908 img
->width
- 1, img
->height
- 1);
4909 XDrawLine (dpy
, img
->mask
, gc
, 0, img
->height
- 1,
4913 #endif /* !HAVE_NS */
4918 hdc
= get_frame_dc (f
);
4919 bmpdc
= CreateCompatibleDC (hdc
);
4920 release_frame_dc (f
, hdc
);
4922 prev
= SelectObject (bmpdc
, img
->pixmap
);
4924 SetTextColor (bmpdc
, BLACK_PIX_DEFAULT (f
));
4925 MoveToEx (bmpdc
, 0, 0, NULL
);
4926 LineTo (bmpdc
, img
->width
- 1, img
->height
- 1);
4927 MoveToEx (bmpdc
, 0, img
->height
- 1, NULL
);
4928 LineTo (bmpdc
, img
->width
- 1, 0);
4932 SelectObject (bmpdc
, img
->mask
);
4933 SetTextColor (bmpdc
, WHITE_PIX_DEFAULT (f
));
4934 MoveToEx (bmpdc
, 0, 0, NULL
);
4935 LineTo (bmpdc
, img
->width
- 1, img
->height
- 1);
4936 MoveToEx (bmpdc
, 0, img
->height
- 1, NULL
);
4937 LineTo (bmpdc
, img
->width
- 1, 0);
4939 SelectObject (bmpdc
, prev
);
4941 #endif /* HAVE_NTGUI */
4946 /* Build a mask for image IMG which is used on frame F. FILE is the
4947 name of an image file, for error messages. HOW determines how to
4948 determine the background color of IMG. If it is a list '(R G B)',
4949 with R, G, and B being integers >= 0, take that as the color of the
4950 background. Otherwise, determine the background color of IMG
4954 x_build_heuristic_mask (struct frame
*f
, struct image
*img
, Lisp_Object how
)
4956 XImagePtr_or_DC ximg
;
4963 #endif /* HAVE_NTGUI */
4965 bool use_img_background
;
4966 unsigned long bg
= 0;
4969 x_clear_image_1 (f
, img
, CLEAR_IMAGE_MASK
);
4973 /* Create an image and pixmap serving as mask. */
4974 if (! image_create_x_image_and_pixmap (f
, img
, img
->width
, img
->height
, 1,
4977 #endif /* !HAVE_NS */
4979 /* Create the bit array serving as mask. */
4980 row_width
= (img
->width
+ 7) / 8;
4981 mask_img
= xzalloc (row_width
* img
->height
);
4982 #endif /* HAVE_NTGUI */
4984 /* Get the X image or create a memory device context for IMG. */
4985 ximg
= image_get_x_image_or_dc (f
, img
, 0, &prev
);
4987 /* Determine the background color of ximg. If HOW is `(R G B)'
4988 take that as color. Otherwise, use the image's background color. */
4989 use_img_background
= 1;
4995 for (i
= 0; i
< 3 && CONSP (how
) && NATNUMP (XCAR (how
)); ++i
)
4997 rgb
[i
] = XFASTINT (XCAR (how
)) & 0xffff;
5001 if (i
== 3 && NILP (how
))
5003 char color_name
[30];
5004 sprintf (color_name
, "#%04x%04x%04x", rgb
[0], rgb
[1], rgb
[2]);
5007 0x00ffffff & /* Filter out palette info. */
5008 #endif /* HAVE_NTGUI */
5009 x_alloc_image_color (f
, img
, build_string (color_name
), 0));
5010 use_img_background
= 0;
5014 if (use_img_background
)
5015 bg
= four_corners_best (ximg
, img
->corners
, img
->width
, img
->height
);
5017 /* Set all bits in mask_img to 1 whose color in ximg is different
5018 from the background color bg. */
5020 for (y
= 0; y
< img
->height
; ++y
)
5021 for (x
= 0; x
< img
->width
; ++x
)
5023 XPutPixel (mask_img
, x
, y
, (XGetPixel (ximg
, x
, y
) != bg
5024 ? PIX_MASK_DRAW
: PIX_MASK_RETAIN
));
5026 if (XGetPixel (ximg
, x
, y
) == bg
)
5027 ns_set_alpha (ximg
, x
, y
, 0);
5028 #endif /* HAVE_NS */
5030 /* Fill in the background_transparent field while we have the mask handy. */
5031 image_background_transparent (img
, f
, mask_img
);
5033 /* Put mask_img into the image. */
5034 image_put_x_image (f
, img
, mask_img
, 1);
5035 #endif /* !HAVE_NS */
5037 for (y
= 0; y
< img
->height
; ++y
)
5038 for (x
= 0; x
< img
->width
; ++x
)
5040 COLORREF p
= GetPixel (ximg
, x
, y
);
5042 mask_img
[y
* row_width
+ x
/ 8] |= 1 << (x
% 8);
5045 /* Create the mask image. */
5046 img
->mask
= w32_create_pixmap_from_bitmap_data (img
->width
, img
->height
,
5048 /* Fill in the background_transparent field while we have the mask handy. */
5049 SelectObject (ximg
, img
->mask
);
5050 image_background_transparent (img
, f
, ximg
);
5052 /* Was: x_destroy_x_image ((XImagePtr )mask_img); which seems bogus ++kfs */
5054 #endif /* HAVE_NTGUI */
5056 image_unget_x_image_or_dc (img
, 0, ximg
, prev
);
5060 /***********************************************************************
5061 PBM (mono, gray, color)
5062 ***********************************************************************/
5064 static bool pbm_image_p (Lisp_Object object
);
5065 static bool pbm_load (struct frame
*f
, struct image
*img
);
5067 /* The symbol `pbm' identifying images of this type. */
5069 static Lisp_Object Qpbm
;
5071 /* Indices of image specification fields in gs_format, below. */
5073 enum pbm_keyword_index
5089 /* Vector of image_keyword structures describing the format
5090 of valid user-defined image specifications. */
5092 static const struct image_keyword pbm_format
[PBM_LAST
] =
5094 {":type", IMAGE_SYMBOL_VALUE
, 1},
5095 {":file", IMAGE_STRING_VALUE
, 0},
5096 {":data", IMAGE_STRING_VALUE
, 0},
5097 {":ascent", IMAGE_ASCENT_VALUE
, 0},
5098 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
5099 {":relief", IMAGE_INTEGER_VALUE
, 0},
5100 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5101 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5102 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5103 {":foreground", IMAGE_STRING_OR_NIL_VALUE
, 0},
5104 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
5107 /* Structure describing the image type `pbm'. */
5109 static struct image_type pbm_type
=
5120 /* Return true if OBJECT is a valid PBM image specification. */
5123 pbm_image_p (Lisp_Object object
)
5125 struct image_keyword fmt
[PBM_LAST
];
5127 memcpy (fmt
, pbm_format
, sizeof fmt
);
5129 if (!parse_image_spec (object
, fmt
, PBM_LAST
, Qpbm
))
5132 /* Must specify either :data or :file. */
5133 return fmt
[PBM_DATA
].count
+ fmt
[PBM_FILE
].count
== 1;
5137 /* Get next char skipping comments in Netpbm header. Returns -1 at
5141 pbm_next_char (unsigned char **s
, unsigned char *end
)
5145 while (*s
< end
&& (c
= *(*s
)++, c
== '#'))
5147 /* Skip to the next line break. */
5148 while (*s
< end
&& (c
= *(*s
)++, c
!= '\n' && c
!= '\r'))
5158 /* Scan a decimal number from *S and return it. Advance *S while
5159 reading the number. END is the end of the string. Value is -1 at
5163 pbm_scan_number (unsigned char **s
, unsigned char *end
)
5165 int c
= 0, val
= -1;
5167 /* Skip white-space. */
5168 while ((c
= pbm_next_char (s
, end
)) != -1 && c_isspace (c
))
5173 /* Read decimal number. */
5175 while ((c
= pbm_next_char (s
, end
)) != -1 && c_isdigit (c
))
5176 val
= 10 * val
+ c
- '0';
5183 /* Load PBM image IMG for use on frame F. */
5186 pbm_load (struct frame
*f
, struct image
*img
)
5190 int width
, height
, max_color_idx
= 0;
5192 Lisp_Object file
, specified_file
;
5193 enum {PBM_MONO
, PBM_GRAY
, PBM_COLOR
} type
;
5194 unsigned char *contents
= NULL
;
5195 unsigned char *end
, *p
;
5198 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
5200 if (STRINGP (specified_file
))
5202 file
= x_find_image_file (specified_file
);
5203 if (!STRINGP (file
))
5205 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
5209 contents
= slurp_file (SSDATA (file
), &size
);
5210 if (contents
== NULL
)
5212 image_error ("Error reading `%s'", file
, Qnil
);
5217 end
= contents
+ size
;
5222 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
5223 if (!STRINGP (data
))
5225 image_error ("Invalid image data `%s'", data
, Qnil
);
5229 end
= p
+ SBYTES (data
);
5232 /* Check magic number. */
5233 if (end
- p
< 2 || *p
++ != 'P')
5235 image_error ("Not a PBM image: `%s'", img
->spec
, Qnil
);
5238 img
->pixmap
= NO_PIXMAP
;
5245 raw_p
= 0, type
= PBM_MONO
;
5249 raw_p
= 0, type
= PBM_GRAY
;
5253 raw_p
= 0, type
= PBM_COLOR
;
5257 raw_p
= 1, type
= PBM_MONO
;
5261 raw_p
= 1, type
= PBM_GRAY
;
5265 raw_p
= 1, type
= PBM_COLOR
;
5269 image_error ("Not a PBM image: `%s'", img
->spec
, Qnil
);
5273 /* Read width, height, maximum color-component. Characters
5274 starting with `#' up to the end of a line are ignored. */
5275 width
= pbm_scan_number (&p
, end
);
5276 height
= pbm_scan_number (&p
, end
);
5278 if (type
!= PBM_MONO
)
5280 max_color_idx
= pbm_scan_number (&p
, end
);
5281 if (max_color_idx
> 65535 || max_color_idx
< 0)
5283 image_error ("Unsupported maximum PBM color value", Qnil
, Qnil
);
5288 if (!check_image_size (f
, width
, height
))
5290 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
5294 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, 0, &ximg
, 0))
5297 /* Initialize the color hash table. */
5298 init_color_table ();
5300 if (type
== PBM_MONO
)
5303 struct image_keyword fmt
[PBM_LAST
];
5304 unsigned long fg
= FRAME_FOREGROUND_PIXEL (f
);
5305 unsigned long bg
= FRAME_BACKGROUND_PIXEL (f
);
5307 /* Parse the image specification. */
5308 memcpy (fmt
, pbm_format
, sizeof fmt
);
5309 parse_image_spec (img
->spec
, fmt
, PBM_LAST
, Qpbm
);
5311 /* Get foreground and background colors, maybe allocate colors. */
5312 if (fmt
[PBM_FOREGROUND
].count
5313 && STRINGP (fmt
[PBM_FOREGROUND
].value
))
5314 fg
= x_alloc_image_color (f
, img
, fmt
[PBM_FOREGROUND
].value
, fg
);
5315 if (fmt
[PBM_BACKGROUND
].count
5316 && STRINGP (fmt
[PBM_BACKGROUND
].value
))
5318 bg
= x_alloc_image_color (f
, img
, fmt
[PBM_BACKGROUND
].value
, bg
);
5319 img
->background
= bg
;
5320 img
->background_valid
= 1;
5323 for (y
= 0; y
< height
; ++y
)
5324 for (x
= 0; x
< width
; ++x
)
5332 x_destroy_x_image (ximg
);
5333 x_clear_image (f
, img
);
5334 image_error ("Invalid image size in image `%s'",
5344 g
= pbm_scan_number (&p
, end
);
5346 XPutPixel (ximg
, x
, y
, g
? fg
: bg
);
5351 int expected_size
= height
* width
;
5352 if (max_color_idx
> 255)
5354 if (type
== PBM_COLOR
)
5357 if (raw_p
&& p
+ expected_size
> end
)
5359 x_destroy_x_image (ximg
);
5360 x_clear_image (f
, img
);
5361 image_error ("Invalid image size in image `%s'",
5366 for (y
= 0; y
< height
; ++y
)
5367 for (x
= 0; x
< width
; ++x
)
5371 if (type
== PBM_GRAY
&& raw_p
)
5374 if (max_color_idx
> 255)
5375 r
= g
= b
= r
* 256 + *p
++;
5377 else if (type
== PBM_GRAY
)
5378 r
= g
= b
= pbm_scan_number (&p
, end
);
5382 if (max_color_idx
> 255)
5385 if (max_color_idx
> 255)
5388 if (max_color_idx
> 255)
5393 r
= pbm_scan_number (&p
, end
);
5394 g
= pbm_scan_number (&p
, end
);
5395 b
= pbm_scan_number (&p
, end
);
5398 if (r
< 0 || g
< 0 || b
< 0)
5400 x_destroy_x_image (ximg
);
5401 image_error ("Invalid pixel value in image `%s'",
5406 /* RGB values are now in the range 0..max_color_idx.
5407 Scale this to the range 0..0xffff supported by X. */
5408 r
= (double) r
* 65535 / max_color_idx
;
5409 g
= (double) g
* 65535 / max_color_idx
;
5410 b
= (double) b
* 65535 / max_color_idx
;
5411 XPutPixel (ximg
, x
, y
, lookup_rgb_color (f
, r
, g
, b
));
5415 #ifdef COLOR_TABLE_SUPPORT
5416 /* Store in IMG->colors the colors allocated for the image, and
5417 free the color table. */
5418 img
->colors
= colors_in_color_table (&img
->ncolors
);
5419 free_color_table ();
5420 #endif /* COLOR_TABLE_SUPPORT */
5423 img
->height
= height
;
5425 /* Maybe fill in the background field while we have ximg handy. */
5427 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
5428 /* Casting avoids a GCC warning. */
5429 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
5431 /* Put ximg into the image. */
5432 image_put_x_image (f
, img
, ximg
, 0);
5434 /* X and W32 versions did it here, MAC version above. ++kfs
5436 img->height = height; */
5443 /***********************************************************************
5445 ***********************************************************************/
5447 #if defined (HAVE_PNG) || defined (HAVE_NS)
5449 /* Function prototypes. */
5451 static bool png_image_p (Lisp_Object object
);
5452 static bool png_load (struct frame
*f
, struct image
*img
);
5454 /* The symbol `png' identifying images of this type. */
5456 static Lisp_Object Qpng
;
5458 /* Indices of image specification fields in png_format, below. */
5460 enum png_keyword_index
5475 /* Vector of image_keyword structures describing the format
5476 of valid user-defined image specifications. */
5478 static const struct image_keyword png_format
[PNG_LAST
] =
5480 {":type", IMAGE_SYMBOL_VALUE
, 1},
5481 {":data", IMAGE_STRING_VALUE
, 0},
5482 {":file", IMAGE_STRING_VALUE
, 0},
5483 {":ascent", IMAGE_ASCENT_VALUE
, 0},
5484 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
5485 {":relief", IMAGE_INTEGER_VALUE
, 0},
5486 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5487 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5488 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5489 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
5492 #if defined HAVE_NTGUI && defined WINDOWSNT
5493 static bool init_png_functions (void);
5495 #define init_png_functions NULL
5498 /* Structure describing the image type `png'. */
5500 static struct image_type png_type
=
5510 /* Return true if OBJECT is a valid PNG image specification. */
5513 png_image_p (Lisp_Object object
)
5515 struct image_keyword fmt
[PNG_LAST
];
5516 memcpy (fmt
, png_format
, sizeof fmt
);
5518 if (!parse_image_spec (object
, fmt
, PNG_LAST
, Qpng
))
5521 /* Must specify either the :data or :file keyword. */
5522 return fmt
[PNG_FILE
].count
+ fmt
[PNG_DATA
].count
== 1;
5525 #endif /* HAVE_PNG || HAVE_NS */
5528 #if defined HAVE_PNG && !defined HAVE_NS
5531 /* PNG library details. */
5533 DEF_IMGLIB_FN (png_voidp
, png_get_io_ptr
, (png_structp
));
5534 DEF_IMGLIB_FN (int, png_sig_cmp
, (png_bytep
, png_size_t
, png_size_t
));
5535 DEF_IMGLIB_FN (png_structp
, png_create_read_struct
, (png_const_charp
, png_voidp
,
5536 png_error_ptr
, png_error_ptr
));
5537 DEF_IMGLIB_FN (png_infop
, png_create_info_struct
, (png_structp
));
5538 DEF_IMGLIB_FN (void, png_destroy_read_struct
, (png_structpp
, png_infopp
, png_infopp
));
5539 DEF_IMGLIB_FN (void, png_set_read_fn
, (png_structp
, png_voidp
, png_rw_ptr
));
5540 DEF_IMGLIB_FN (void, png_set_sig_bytes
, (png_structp
, int));
5541 DEF_IMGLIB_FN (void, png_read_info
, (png_structp
, png_infop
));
5542 DEF_IMGLIB_FN (png_uint_32
, png_get_IHDR
, (png_structp
, png_infop
,
5543 png_uint_32
*, png_uint_32
*,
5544 int *, int *, int *, int *, int *));
5545 DEF_IMGLIB_FN (png_uint_32
, png_get_valid
, (png_structp
, png_infop
, png_uint_32
));
5546 DEF_IMGLIB_FN (void, png_set_strip_16
, (png_structp
));
5547 DEF_IMGLIB_FN (void, png_set_expand
, (png_structp
));
5548 DEF_IMGLIB_FN (void, png_set_gray_to_rgb
, (png_structp
));
5549 DEF_IMGLIB_FN (void, png_set_background
, (png_structp
, png_color_16p
,
5551 DEF_IMGLIB_FN (png_uint_32
, png_get_bKGD
, (png_structp
, png_infop
, png_color_16p
*));
5552 DEF_IMGLIB_FN (void, png_read_update_info
, (png_structp
, png_infop
));
5553 DEF_IMGLIB_FN (png_byte
, png_get_channels
, (png_structp
, png_infop
));
5554 DEF_IMGLIB_FN (png_size_t
, png_get_rowbytes
, (png_structp
, png_infop
));
5555 DEF_IMGLIB_FN (void, png_read_image
, (png_structp
, png_bytepp
));
5556 DEF_IMGLIB_FN (void, png_read_end
, (png_structp
, png_infop
));
5557 DEF_IMGLIB_FN (void, png_error
, (png_structp
, png_const_charp
));
5559 #if (PNG_LIBPNG_VER >= 10500)
5560 DEF_IMGLIB_FN (void, png_longjmp
, (png_structp
, int)) PNG_NORETURN
;
5561 DEF_IMGLIB_FN (jmp_buf *, png_set_longjmp_fn
, (png_structp
, png_longjmp_ptr
, size_t));
5562 #endif /* libpng version >= 1.5 */
5565 init_png_functions (void)
5569 if (!(library
= w32_delayed_load (Qpng
)))
5572 LOAD_IMGLIB_FN (library
, png_get_io_ptr
);
5573 LOAD_IMGLIB_FN (library
, png_sig_cmp
);
5574 LOAD_IMGLIB_FN (library
, png_create_read_struct
);
5575 LOAD_IMGLIB_FN (library
, png_create_info_struct
);
5576 LOAD_IMGLIB_FN (library
, png_destroy_read_struct
);
5577 LOAD_IMGLIB_FN (library
, png_set_read_fn
);
5578 LOAD_IMGLIB_FN (library
, png_set_sig_bytes
);
5579 LOAD_IMGLIB_FN (library
, png_read_info
);
5580 LOAD_IMGLIB_FN (library
, png_get_IHDR
);
5581 LOAD_IMGLIB_FN (library
, png_get_valid
);
5582 LOAD_IMGLIB_FN (library
, png_set_strip_16
);
5583 LOAD_IMGLIB_FN (library
, png_set_expand
);
5584 LOAD_IMGLIB_FN (library
, png_set_gray_to_rgb
);
5585 LOAD_IMGLIB_FN (library
, png_set_background
);
5586 LOAD_IMGLIB_FN (library
, png_get_bKGD
);
5587 LOAD_IMGLIB_FN (library
, png_read_update_info
);
5588 LOAD_IMGLIB_FN (library
, png_get_channels
);
5589 LOAD_IMGLIB_FN (library
, png_get_rowbytes
);
5590 LOAD_IMGLIB_FN (library
, png_read_image
);
5591 LOAD_IMGLIB_FN (library
, png_read_end
);
5592 LOAD_IMGLIB_FN (library
, png_error
);
5594 #if (PNG_LIBPNG_VER >= 10500)
5595 LOAD_IMGLIB_FN (library
, png_longjmp
);
5596 LOAD_IMGLIB_FN (library
, png_set_longjmp_fn
);
5597 #endif /* libpng version >= 1.5 */
5603 #define fn_png_get_io_ptr png_get_io_ptr
5604 #define fn_png_sig_cmp png_sig_cmp
5605 #define fn_png_create_read_struct png_create_read_struct
5606 #define fn_png_create_info_struct png_create_info_struct
5607 #define fn_png_destroy_read_struct png_destroy_read_struct
5608 #define fn_png_set_read_fn png_set_read_fn
5609 #define fn_png_set_sig_bytes png_set_sig_bytes
5610 #define fn_png_read_info png_read_info
5611 #define fn_png_get_IHDR png_get_IHDR
5612 #define fn_png_get_valid png_get_valid
5613 #define fn_png_set_strip_16 png_set_strip_16
5614 #define fn_png_set_expand png_set_expand
5615 #define fn_png_set_gray_to_rgb png_set_gray_to_rgb
5616 #define fn_png_set_background png_set_background
5617 #define fn_png_get_bKGD png_get_bKGD
5618 #define fn_png_read_update_info png_read_update_info
5619 #define fn_png_get_channels png_get_channels
5620 #define fn_png_get_rowbytes png_get_rowbytes
5621 #define fn_png_read_image png_read_image
5622 #define fn_png_read_end png_read_end
5623 #define fn_png_error png_error
5625 #if (PNG_LIBPNG_VER >= 10500)
5626 #define fn_png_longjmp png_longjmp
5627 #define fn_png_set_longjmp_fn png_set_longjmp_fn
5628 #endif /* libpng version >= 1.5 */
5630 #endif /* WINDOWSNT */
5632 /* Fast implementations of setjmp and longjmp. Although setjmp and longjmp
5633 will do, POSIX _setjmp and _longjmp (if available) are often faster.
5634 Do not use sys_setjmp, as PNG supports only jmp_buf.
5635 It's OK if the longjmp substitute restores the signal mask. */
5637 # define FAST_SETJMP(j) _setjmp (j)
5638 # define FAST_LONGJMP _longjmp
5640 # define FAST_SETJMP(j) setjmp (j)
5641 # define FAST_LONGJMP longjmp
5644 #if PNG_LIBPNG_VER < 10500
5645 #define PNG_LONGJMP(ptr) FAST_LONGJMP ((ptr)->jmpbuf, 1)
5646 #define PNG_JMPBUF(ptr) ((ptr)->jmpbuf)
5648 /* In libpng version 1.5, the jmpbuf member is hidden. (Bug#7908) */
5649 #define PNG_LONGJMP(ptr) fn_png_longjmp (ptr, 1)
5650 #define PNG_JMPBUF(ptr) \
5651 (*fn_png_set_longjmp_fn (ptr, FAST_LONGJMP, sizeof (jmp_buf)))
5654 /* Error and warning handlers installed when the PNG library
5657 static _Noreturn
void
5658 my_png_error (png_struct
*png_ptr
, const char *msg
)
5660 eassert (png_ptr
!= NULL
);
5661 /* Avoid compiler warning about deprecated direct access to
5662 png_ptr's fields in libpng versions 1.4.x. */
5663 image_error ("PNG error: %s", build_string (msg
), Qnil
);
5664 PNG_LONGJMP (png_ptr
);
5669 my_png_warning (png_struct
*png_ptr
, const char *msg
)
5671 eassert (png_ptr
!= NULL
);
5672 image_error ("PNG warning: %s", build_string (msg
), Qnil
);
5675 /* Memory source for PNG decoding. */
5677 struct png_memory_storage
5679 unsigned char *bytes
; /* The data */
5680 ptrdiff_t len
; /* How big is it? */
5681 ptrdiff_t index
; /* Where are we? */
5685 /* Function set as reader function when reading PNG image from memory.
5686 PNG_PTR is a pointer to the PNG control structure. Copy LENGTH
5687 bytes from the input to DATA. */
5690 png_read_from_memory (png_structp png_ptr
, png_bytep data
, png_size_t length
)
5692 struct png_memory_storage
*tbr
= fn_png_get_io_ptr (png_ptr
);
5694 if (length
> tbr
->len
- tbr
->index
)
5695 fn_png_error (png_ptr
, "Read error");
5697 memcpy (data
, tbr
->bytes
+ tbr
->index
, length
);
5698 tbr
->index
= tbr
->index
+ length
;
5702 /* Function set as reader function when reading PNG image from a file.
5703 PNG_PTR is a pointer to the PNG control structure. Copy LENGTH
5704 bytes from the input to DATA. */
5707 png_read_from_file (png_structp png_ptr
, png_bytep data
, png_size_t length
)
5709 FILE *fp
= fn_png_get_io_ptr (png_ptr
);
5711 if (fread (data
, 1, length
, fp
) < length
)
5712 fn_png_error (png_ptr
, "Read error");
5716 /* Load PNG image IMG for use on frame F. Value is true if
5719 struct png_load_context
5721 /* These are members so that longjmp doesn't munge local variables. */
5722 png_struct
*png_ptr
;
5731 png_load_body (struct frame
*f
, struct image
*img
, struct png_load_context
*c
)
5733 Lisp_Object file
, specified_file
;
5734 Lisp_Object specified_data
;
5737 XImagePtr ximg
, mask_img
= NULL
;
5738 png_struct
*png_ptr
;
5739 png_info
*info_ptr
= NULL
, *end_info
= NULL
;
5742 png_byte
*pixels
= NULL
;
5743 png_byte
**rows
= NULL
;
5744 png_uint_32 width
, height
;
5745 int bit_depth
, color_type
, interlace_type
;
5747 png_uint_32 row_bytes
;
5749 struct png_memory_storage tbr
; /* Data to be read */
5751 /* Find out what file to load. */
5752 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
5753 specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
5755 if (NILP (specified_data
))
5757 file
= x_find_image_file (specified_file
);
5758 if (!STRINGP (file
))
5760 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
5764 /* Open the image file. */
5765 fp
= emacs_fopen (SSDATA (file
), "rb");
5768 image_error ("Cannot open image file `%s'", file
, Qnil
);
5772 /* Check PNG signature. */
5773 if (fread (sig
, 1, sizeof sig
, fp
) != sizeof sig
5774 || fn_png_sig_cmp (sig
, 0, sizeof sig
))
5777 image_error ("Not a PNG file: `%s'", file
, Qnil
);
5783 if (!STRINGP (specified_data
))
5785 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
5789 /* Read from memory. */
5790 tbr
.bytes
= SDATA (specified_data
);
5791 tbr
.len
= SBYTES (specified_data
);
5794 /* Check PNG signature. */
5795 if (tbr
.len
< sizeof sig
5796 || fn_png_sig_cmp (tbr
.bytes
, 0, sizeof sig
))
5798 image_error ("Not a PNG image: `%s'", img
->spec
, Qnil
);
5802 /* Need to skip past the signature. */
5803 tbr
.bytes
+= sizeof (sig
);
5806 /* Initialize read and info structs for PNG lib. */
5807 png_ptr
= fn_png_create_read_struct (PNG_LIBPNG_VER_STRING
,
5812 info_ptr
= fn_png_create_info_struct (png_ptr
);
5813 end_info
= fn_png_create_info_struct (png_ptr
);
5816 c
->png_ptr
= png_ptr
;
5817 c
->info_ptr
= info_ptr
;
5818 c
->end_info
= end_info
;
5823 if (! (info_ptr
&& end_info
))
5825 fn_png_destroy_read_struct (&c
->png_ptr
, &c
->info_ptr
, &c
->end_info
);
5830 if (fp
) fclose (fp
);
5834 /* Set error jump-back. We come back here when the PNG library
5835 detects an error. */
5836 if (FAST_SETJMP (PNG_JMPBUF (png_ptr
)))
5840 fn_png_destroy_read_struct (&c
->png_ptr
, &c
->info_ptr
, &c
->end_info
);
5848 /* Silence a bogus diagnostic; see GCC bug 54561. */
5849 IF_LINT (fp
= c
->fp
);
5851 /* Read image info. */
5852 if (!NILP (specified_data
))
5853 fn_png_set_read_fn (png_ptr
, &tbr
, png_read_from_memory
);
5855 fn_png_set_read_fn (png_ptr
, fp
, png_read_from_file
);
5857 fn_png_set_sig_bytes (png_ptr
, sizeof sig
);
5858 fn_png_read_info (png_ptr
, info_ptr
);
5859 fn_png_get_IHDR (png_ptr
, info_ptr
, &width
, &height
, &bit_depth
, &color_type
,
5860 &interlace_type
, NULL
, NULL
);
5862 if (! (width
<= INT_MAX
&& height
<= INT_MAX
5863 && check_image_size (f
, width
, height
)))
5865 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
5869 /* Create the X image and pixmap now, so that the work below can be
5870 omitted if the image is too large for X. */
5871 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, 0, &ximg
, 0))
5874 /* If image contains simply transparency data, we prefer to
5875 construct a clipping mask. */
5876 if (fn_png_get_valid (png_ptr
, info_ptr
, PNG_INFO_tRNS
))
5881 /* This function is easier to write if we only have to handle
5882 one data format: RGB or RGBA with 8 bits per channel. Let's
5883 transform other formats into that format. */
5885 /* Strip more than 8 bits per channel. */
5886 if (bit_depth
== 16)
5887 fn_png_set_strip_16 (png_ptr
);
5889 /* Expand data to 24 bit RGB, or 8 bit grayscale, with alpha channel
5891 fn_png_set_expand (png_ptr
);
5893 /* Convert grayscale images to RGB. */
5894 if (color_type
== PNG_COLOR_TYPE_GRAY
5895 || color_type
== PNG_COLOR_TYPE_GRAY_ALPHA
)
5896 fn_png_set_gray_to_rgb (png_ptr
);
5898 /* Handle alpha channel by combining the image with a background
5899 color. Do this only if a real alpha channel is supplied. For
5900 simple transparency, we prefer a clipping mask. */
5903 /* png_color_16 *image_bg; */
5904 Lisp_Object specified_bg
5905 = image_spec_value (img
->spec
, QCbackground
, NULL
);
5908 /* If the user specified a color, try to use it; if not, use the
5909 current frame background, ignoring any default background
5910 color set by the image. */
5911 if (STRINGP (specified_bg
)
5912 ? x_defined_color (f
, SSDATA (specified_bg
), &color
, false)
5913 : (x_query_frame_background_color (f
, &color
), true))
5914 /* The user specified `:background', use that. */
5916 int shift
= bit_depth
== 16 ? 0 : 8;
5917 png_color_16 bg
= { 0 };
5918 bg
.red
= color
.red
>> shift
;
5919 bg
.green
= color
.green
>> shift
;
5920 bg
.blue
= color
.blue
>> shift
;
5922 fn_png_set_background (png_ptr
, &bg
,
5923 PNG_BACKGROUND_GAMMA_SCREEN
, 0, 1.0);
5927 /* Update info structure. */
5928 fn_png_read_update_info (png_ptr
, info_ptr
);
5930 /* Get number of channels. Valid values are 1 for grayscale images
5931 and images with a palette, 2 for grayscale images with transparency
5932 information (alpha channel), 3 for RGB images, and 4 for RGB
5933 images with alpha channel, i.e. RGBA. If conversions above were
5934 sufficient we should only have 3 or 4 channels here. */
5935 channels
= fn_png_get_channels (png_ptr
, info_ptr
);
5936 eassert (channels
== 3 || channels
== 4);
5938 /* Number of bytes needed for one row of the image. */
5939 row_bytes
= fn_png_get_rowbytes (png_ptr
, info_ptr
);
5941 /* Allocate memory for the image. */
5942 if (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *rows
< height
5943 || min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *pixels
/ height
< row_bytes
)
5944 memory_full (SIZE_MAX
);
5945 c
->pixels
= pixels
= xmalloc (sizeof *pixels
* row_bytes
* height
);
5946 c
->rows
= rows
= xmalloc (height
* sizeof *rows
);
5947 for (i
= 0; i
< height
; ++i
)
5948 rows
[i
] = pixels
+ i
* row_bytes
;
5950 /* Read the entire image. */
5951 fn_png_read_image (png_ptr
, rows
);
5952 fn_png_read_end (png_ptr
, info_ptr
);
5959 /* Create an image and pixmap serving as mask if the PNG image
5960 contains an alpha channel. */
5963 && !image_create_x_image_and_pixmap (f
, img
, width
, height
, 1,
5966 x_destroy_x_image (ximg
);
5967 x_clear_image_1 (f
, img
, CLEAR_IMAGE_PIXMAP
);
5971 /* Fill the X image and mask from PNG data. */
5972 init_color_table ();
5974 for (y
= 0; y
< height
; ++y
)
5976 png_byte
*p
= rows
[y
];
5978 for (x
= 0; x
< width
; ++x
)
5985 XPutPixel (ximg
, x
, y
, lookup_rgb_color (f
, r
, g
, b
));
5986 /* An alpha channel, aka mask channel, associates variable
5987 transparency with an image. Where other image formats
5988 support binary transparency---fully transparent or fully
5989 opaque---PNG allows up to 254 levels of partial transparency.
5990 The PNG library implements partial transparency by combining
5991 the image with a specified background color.
5993 I'm not sure how to handle this here nicely: because the
5994 background on which the image is displayed may change, for
5995 real alpha channel support, it would be necessary to create
5996 a new image for each possible background.
5998 What I'm doing now is that a mask is created if we have
5999 boolean transparency information. Otherwise I'm using
6000 the frame's background color to combine the image with. */
6005 XPutPixel (mask_img
, x
, y
, *p
> 0 ? PIX_MASK_DRAW
: PIX_MASK_RETAIN
);
6011 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
6012 /* Set IMG's background color from the PNG image, unless the user
6016 if (fn_png_get_bKGD (png_ptr
, info_ptr
, &bg
))
6018 img
->background
= lookup_rgb_color (f
, bg
->red
, bg
->green
, bg
->blue
);
6019 img
->background_valid
= 1;
6023 #ifdef COLOR_TABLE_SUPPORT
6024 /* Remember colors allocated for this image. */
6025 img
->colors
= colors_in_color_table (&img
->ncolors
);
6026 free_color_table ();
6027 #endif /* COLOR_TABLE_SUPPORT */
6030 fn_png_destroy_read_struct (&c
->png_ptr
, &c
->info_ptr
, &c
->end_info
);
6035 img
->height
= height
;
6037 /* Maybe fill in the background field while we have ximg handy.
6038 Casting avoids a GCC warning. */
6039 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
6041 /* Put ximg into the image. */
6042 image_put_x_image (f
, img
, ximg
, 0);
6044 /* Same for the mask. */
6047 /* Fill in the background_transparent field while we have the
6048 mask handy. Casting avoids a GCC warning. */
6049 image_background_transparent (img
, f
, (XImagePtr_or_DC
)mask_img
);
6051 image_put_x_image (f
, img
, mask_img
, 1);
6058 png_load (struct frame
*f
, struct image
*img
)
6060 struct png_load_context c
;
6061 return png_load_body (f
, img
, &c
);
6064 #elif defined HAVE_NS
6067 png_load (struct frame
*f
, struct image
*img
)
6069 return ns_load_image (f
, img
,
6070 image_spec_value (img
->spec
, QCfile
, NULL
),
6071 image_spec_value (img
->spec
, QCdata
, NULL
));
6074 #endif /* HAVE_NS */
6078 /***********************************************************************
6080 ***********************************************************************/
6082 #if defined (HAVE_JPEG) || defined (HAVE_NS)
6084 static bool jpeg_image_p (Lisp_Object object
);
6085 static bool jpeg_load (struct frame
*f
, struct image
*img
);
6087 /* The symbol `jpeg' identifying images of this type. */
6089 static Lisp_Object Qjpeg
;
6091 /* Indices of image specification fields in gs_format, below. */
6093 enum jpeg_keyword_index
6102 JPEG_HEURISTIC_MASK
,
6108 /* Vector of image_keyword structures describing the format
6109 of valid user-defined image specifications. */
6111 static const struct image_keyword jpeg_format
[JPEG_LAST
] =
6113 {":type", IMAGE_SYMBOL_VALUE
, 1},
6114 {":data", IMAGE_STRING_VALUE
, 0},
6115 {":file", IMAGE_STRING_VALUE
, 0},
6116 {":ascent", IMAGE_ASCENT_VALUE
, 0},
6117 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
6118 {":relief", IMAGE_INTEGER_VALUE
, 0},
6119 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6120 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6121 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6122 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
6125 #if defined HAVE_NTGUI && defined WINDOWSNT
6126 static bool init_jpeg_functions (void);
6128 #define init_jpeg_functions NULL
6131 /* Structure describing the image type `jpeg'. */
6133 static struct image_type jpeg_type
=
6139 init_jpeg_functions
,
6143 /* Return true if OBJECT is a valid JPEG image specification. */
6146 jpeg_image_p (Lisp_Object object
)
6148 struct image_keyword fmt
[JPEG_LAST
];
6150 memcpy (fmt
, jpeg_format
, sizeof fmt
);
6152 if (!parse_image_spec (object
, fmt
, JPEG_LAST
, Qjpeg
))
6155 /* Must specify either the :data or :file keyword. */
6156 return fmt
[JPEG_FILE
].count
+ fmt
[JPEG_DATA
].count
== 1;
6159 #endif /* HAVE_JPEG || HAVE_NS */
6163 /* Work around a warning about HAVE_STDLIB_H being redefined in
6165 #ifdef HAVE_STDLIB_H
6166 #undef HAVE_STDLIB_H
6167 #endif /* HAVE_STLIB_H */
6169 #if defined (HAVE_NTGUI) && !defined (__WIN32__)
6170 /* In older releases of the jpeg library, jpeglib.h will define boolean
6171 differently depending on __WIN32__, so make sure it is defined. */
6175 /* rpcndr.h (via windows.h) and jpeglib.h both define boolean types.
6176 Some versions of jpeglib try to detect whether rpcndr.h is loaded,
6177 using the Windows boolean type instead of the jpeglib boolean type
6178 if so. Cygwin jpeglib, however, doesn't try to detect whether its
6179 headers are included along with windows.h, so under Cygwin, jpeglib
6180 attempts to define a conflicting boolean type. Worse, forcing
6181 Cygwin jpeglib headers to use the Windows boolean type doesn't work
6182 because it created an ABI incompatibility between the
6183 already-compiled jpeg library and the header interface definition.
6185 The best we can do is to define jpeglib's boolean type to a
6186 different name. This name, jpeg_boolean, remains in effect through
6187 the rest of image.c.
6189 #if defined CYGWIN && defined HAVE_NTGUI
6190 #define boolean jpeg_boolean
6192 #include <jpeglib.h>
6197 /* JPEG library details. */
6198 DEF_IMGLIB_FN (void, jpeg_CreateDecompress
, (j_decompress_ptr
, int, size_t));
6199 DEF_IMGLIB_FN (boolean
, jpeg_start_decompress
, (j_decompress_ptr
));
6200 DEF_IMGLIB_FN (boolean
, jpeg_finish_decompress
, (j_decompress_ptr
));
6201 DEF_IMGLIB_FN (void, jpeg_destroy_decompress
, (j_decompress_ptr
));
6202 DEF_IMGLIB_FN (int, jpeg_read_header
, (j_decompress_ptr
, boolean
));
6203 DEF_IMGLIB_FN (JDIMENSION
, jpeg_read_scanlines
, (j_decompress_ptr
, JSAMPARRAY
, JDIMENSION
));
6204 DEF_IMGLIB_FN (struct jpeg_error_mgr
*, jpeg_std_error
, (struct jpeg_error_mgr
*));
6205 DEF_IMGLIB_FN (boolean
, jpeg_resync_to_restart
, (j_decompress_ptr
, int));
6208 init_jpeg_functions (void)
6212 if (!(library
= w32_delayed_load (Qjpeg
)))
6215 LOAD_IMGLIB_FN (library
, jpeg_finish_decompress
);
6216 LOAD_IMGLIB_FN (library
, jpeg_read_scanlines
);
6217 LOAD_IMGLIB_FN (library
, jpeg_start_decompress
);
6218 LOAD_IMGLIB_FN (library
, jpeg_read_header
);
6219 LOAD_IMGLIB_FN (library
, jpeg_CreateDecompress
);
6220 LOAD_IMGLIB_FN (library
, jpeg_destroy_decompress
);
6221 LOAD_IMGLIB_FN (library
, jpeg_std_error
);
6222 LOAD_IMGLIB_FN (library
, jpeg_resync_to_restart
);
6226 /* Wrapper since we can't directly assign the function pointer
6227 to another function pointer that was declared more completely easily. */
6229 jpeg_resync_to_restart_wrapper (j_decompress_ptr cinfo
, int desired
)
6231 return fn_jpeg_resync_to_restart (cinfo
, desired
);
6236 #define fn_jpeg_CreateDecompress(a,b,c) jpeg_create_decompress (a)
6237 #define fn_jpeg_start_decompress jpeg_start_decompress
6238 #define fn_jpeg_finish_decompress jpeg_finish_decompress
6239 #define fn_jpeg_destroy_decompress jpeg_destroy_decompress
6240 #define fn_jpeg_read_header jpeg_read_header
6241 #define fn_jpeg_read_scanlines jpeg_read_scanlines
6242 #define fn_jpeg_std_error jpeg_std_error
6243 #define jpeg_resync_to_restart_wrapper jpeg_resync_to_restart
6245 #endif /* WINDOWSNT */
6247 struct my_jpeg_error_mgr
6249 struct jpeg_error_mgr pub
;
6250 sys_jmp_buf setjmp_buffer
;
6252 /* The remaining members are so that longjmp doesn't munge local
6254 struct jpeg_decompress_struct cinfo
;
6258 MY_JPEG_INVALID_IMAGE_SIZE
,
6259 MY_JPEG_CANNOT_CREATE_X
6264 static _Noreturn
void
6265 my_error_exit (j_common_ptr cinfo
)
6267 struct my_jpeg_error_mgr
*mgr
= (struct my_jpeg_error_mgr
*) cinfo
->err
;
6268 mgr
->failure_code
= MY_JPEG_ERROR_EXIT
;
6269 sys_longjmp (mgr
->setjmp_buffer
, 1);
6273 /* Init source method for JPEG data source manager. Called by
6274 jpeg_read_header() before any data is actually read. See
6275 libjpeg.doc from the JPEG lib distribution. */
6278 our_common_init_source (j_decompress_ptr cinfo
)
6283 /* Method to terminate data source. Called by
6284 jpeg_finish_decompress() after all data has been processed. */
6287 our_common_term_source (j_decompress_ptr cinfo
)
6292 /* Fill input buffer method for JPEG data source manager. Called
6293 whenever more data is needed. We read the whole image in one step,
6294 so this only adds a fake end of input marker at the end. */
6296 static JOCTET our_memory_buffer
[2];
6299 our_memory_fill_input_buffer (j_decompress_ptr cinfo
)
6301 /* Insert a fake EOI marker. */
6302 struct jpeg_source_mgr
*src
= cinfo
->src
;
6304 our_memory_buffer
[0] = (JOCTET
) 0xFF;
6305 our_memory_buffer
[1] = (JOCTET
) JPEG_EOI
;
6307 src
->next_input_byte
= our_memory_buffer
;
6308 src
->bytes_in_buffer
= 2;
6313 /* Method to skip over NUM_BYTES bytes in the image data. CINFO->src
6314 is the JPEG data source manager. */
6317 our_memory_skip_input_data (j_decompress_ptr cinfo
, long int num_bytes
)
6319 struct jpeg_source_mgr
*src
= cinfo
->src
;
6323 if (num_bytes
> src
->bytes_in_buffer
)
6324 ERREXIT (cinfo
, JERR_INPUT_EOF
);
6326 src
->bytes_in_buffer
-= num_bytes
;
6327 src
->next_input_byte
+= num_bytes
;
6332 /* Set up the JPEG lib for reading an image from DATA which contains
6333 LEN bytes. CINFO is the decompression info structure created for
6334 reading the image. */
6337 jpeg_memory_src (j_decompress_ptr cinfo
, JOCTET
*data
, ptrdiff_t len
)
6339 struct jpeg_source_mgr
*src
= cinfo
->src
;
6343 /* First time for this JPEG object? */
6344 src
= cinfo
->mem
->alloc_small ((j_common_ptr
) cinfo
,
6345 JPOOL_PERMANENT
, sizeof *src
);
6347 src
->next_input_byte
= data
;
6350 src
->init_source
= our_common_init_source
;
6351 src
->fill_input_buffer
= our_memory_fill_input_buffer
;
6352 src
->skip_input_data
= our_memory_skip_input_data
;
6353 src
->resync_to_restart
= jpeg_resync_to_restart_wrapper
; /* Use default method. */
6354 src
->term_source
= our_common_term_source
;
6355 src
->bytes_in_buffer
= len
;
6356 src
->next_input_byte
= data
;
6360 struct jpeg_stdio_mgr
6362 struct jpeg_source_mgr mgr
;
6369 /* Size of buffer to read JPEG from file.
6370 Not too big, as we want to use alloc_small. */
6371 #define JPEG_STDIO_BUFFER_SIZE 8192
6374 /* Fill input buffer method for JPEG data source manager. Called
6375 whenever more data is needed. The data is read from a FILE *. */
6378 our_stdio_fill_input_buffer (j_decompress_ptr cinfo
)
6380 struct jpeg_stdio_mgr
*src
;
6382 src
= (struct jpeg_stdio_mgr
*) cinfo
->src
;
6387 bytes
= fread (src
->buffer
, 1, JPEG_STDIO_BUFFER_SIZE
, src
->file
);
6389 src
->mgr
.bytes_in_buffer
= bytes
;
6392 WARNMS (cinfo
, JWRN_JPEG_EOF
);
6394 src
->buffer
[0] = (JOCTET
) 0xFF;
6395 src
->buffer
[1] = (JOCTET
) JPEG_EOI
;
6396 src
->mgr
.bytes_in_buffer
= 2;
6398 src
->mgr
.next_input_byte
= src
->buffer
;
6405 /* Method to skip over NUM_BYTES bytes in the image data. CINFO->src
6406 is the JPEG data source manager. */
6409 our_stdio_skip_input_data (j_decompress_ptr cinfo
, long int num_bytes
)
6411 struct jpeg_stdio_mgr
*src
;
6412 src
= (struct jpeg_stdio_mgr
*) cinfo
->src
;
6414 while (num_bytes
> 0 && !src
->finished
)
6416 if (num_bytes
<= src
->mgr
.bytes_in_buffer
)
6418 src
->mgr
.bytes_in_buffer
-= num_bytes
;
6419 src
->mgr
.next_input_byte
+= num_bytes
;
6424 num_bytes
-= src
->mgr
.bytes_in_buffer
;
6425 src
->mgr
.bytes_in_buffer
= 0;
6426 src
->mgr
.next_input_byte
= NULL
;
6428 our_stdio_fill_input_buffer (cinfo
);
6434 /* Set up the JPEG lib for reading an image from a FILE *.
6435 CINFO is the decompression info structure created for
6436 reading the image. */
6439 jpeg_file_src (j_decompress_ptr cinfo
, FILE *fp
)
6441 struct jpeg_stdio_mgr
*src
= (struct jpeg_stdio_mgr
*) cinfo
->src
;
6445 /* First time for this JPEG object? */
6446 src
= cinfo
->mem
->alloc_small ((j_common_ptr
) cinfo
,
6447 JPOOL_PERMANENT
, sizeof *src
);
6448 cinfo
->src
= (struct jpeg_source_mgr
*) src
;
6449 src
->buffer
= cinfo
->mem
->alloc_small ((j_common_ptr
) cinfo
,
6451 JPEG_STDIO_BUFFER_SIZE
);
6456 src
->mgr
.init_source
= our_common_init_source
;
6457 src
->mgr
.fill_input_buffer
= our_stdio_fill_input_buffer
;
6458 src
->mgr
.skip_input_data
= our_stdio_skip_input_data
;
6459 src
->mgr
.resync_to_restart
= jpeg_resync_to_restart_wrapper
; /* Use default method. */
6460 src
->mgr
.term_source
= our_common_term_source
;
6461 src
->mgr
.bytes_in_buffer
= 0;
6462 src
->mgr
.next_input_byte
= NULL
;
6465 /* Load image IMG for use on frame F. Patterned after example.c
6466 from the JPEG lib. */
6469 jpeg_load_body (struct frame
*f
, struct image
*img
,
6470 struct my_jpeg_error_mgr
*mgr
)
6472 Lisp_Object file
, specified_file
;
6473 Lisp_Object specified_data
;
6474 /* The 'volatile' silences a bogus diagnostic; see GCC bug 54561. */
6475 FILE * IF_LINT (volatile) fp
= NULL
;
6477 int row_stride
, x
, y
;
6478 XImagePtr ximg
= NULL
;
6479 unsigned long *colors
;
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
);
6486 if (NILP (specified_data
))
6488 file
= x_find_image_file (specified_file
);
6489 if (!STRINGP (file
))
6491 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
6495 fp
= emacs_fopen (SSDATA (file
), "rb");
6498 image_error ("Cannot open `%s'", file
, Qnil
);
6502 else if (!STRINGP (specified_data
))
6504 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
6508 /* Customize libjpeg's error handling to call my_error_exit when an
6509 error is detected. This function will perform a longjmp. */
6510 mgr
->cinfo
.err
= fn_jpeg_std_error (&mgr
->pub
);
6511 mgr
->pub
.error_exit
= my_error_exit
;
6512 if (sys_setjmp (mgr
->setjmp_buffer
))
6514 switch (mgr
->failure_code
)
6516 case MY_JPEG_ERROR_EXIT
:
6518 char buf
[JMSG_LENGTH_MAX
];
6519 mgr
->cinfo
.err
->format_message ((j_common_ptr
) &mgr
->cinfo
, buf
);
6520 image_error ("Error reading JPEG image `%s': %s", img
->spec
,
6521 build_string (buf
));
6525 case MY_JPEG_INVALID_IMAGE_SIZE
:
6526 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
6529 case MY_JPEG_CANNOT_CREATE_X
:
6533 /* Close the input file and destroy the JPEG object. */
6536 fn_jpeg_destroy_decompress (&mgr
->cinfo
);
6538 /* If we already have an XImage, free that. */
6539 x_destroy_x_image (ximg
);
6541 /* Free pixmap and colors. */
6542 x_clear_image (f
, img
);
6546 /* Create the JPEG decompression object. Let it read from fp.
6547 Read the JPEG image header. */
6548 fn_jpeg_CreateDecompress (&mgr
->cinfo
, JPEG_LIB_VERSION
, sizeof *&mgr
->cinfo
);
6550 if (NILP (specified_data
))
6551 jpeg_file_src (&mgr
->cinfo
, fp
);
6553 jpeg_memory_src (&mgr
->cinfo
, SDATA (specified_data
),
6554 SBYTES (specified_data
));
6556 fn_jpeg_read_header (&mgr
->cinfo
, 1);
6558 /* Customize decompression so that color quantization will be used.
6559 Start decompression. */
6560 mgr
->cinfo
.quantize_colors
= 1;
6561 fn_jpeg_start_decompress (&mgr
->cinfo
);
6562 width
= img
->width
= mgr
->cinfo
.output_width
;
6563 height
= img
->height
= mgr
->cinfo
.output_height
;
6565 if (!check_image_size (f
, width
, height
))
6567 mgr
->failure_code
= MY_JPEG_INVALID_IMAGE_SIZE
;
6568 sys_longjmp (mgr
->setjmp_buffer
, 1);
6571 /* Create X image and pixmap. */
6572 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, 0, &ximg
, 0))
6574 mgr
->failure_code
= MY_JPEG_CANNOT_CREATE_X
;
6575 sys_longjmp (mgr
->setjmp_buffer
, 1);
6578 /* Allocate colors. When color quantization is used,
6579 mgr->cinfo.actual_number_of_colors has been set with the number of
6580 colors generated, and mgr->cinfo.colormap is a two-dimensional array
6581 of color indices in the range 0..mgr->cinfo.actual_number_of_colors.
6582 No more than 255 colors will be generated. */
6586 if (mgr
->cinfo
.out_color_components
> 2)
6587 ir
= 0, ig
= 1, ib
= 2;
6588 else if (mgr
->cinfo
.out_color_components
> 1)
6589 ir
= 0, ig
= 1, ib
= 0;
6591 ir
= 0, ig
= 0, ib
= 0;
6593 /* Use the color table mechanism because it handles colors that
6594 cannot be allocated nicely. Such colors will be replaced with
6595 a default color, and we don't have to care about which colors
6596 can be freed safely, and which can't. */
6597 init_color_table ();
6598 colors
= alloca (mgr
->cinfo
.actual_number_of_colors
* sizeof *colors
);
6600 for (i
= 0; i
< mgr
->cinfo
.actual_number_of_colors
; ++i
)
6602 /* Multiply RGB values with 255 because X expects RGB values
6603 in the range 0..0xffff. */
6604 int r
= mgr
->cinfo
.colormap
[ir
][i
] << 8;
6605 int g
= mgr
->cinfo
.colormap
[ig
][i
] << 8;
6606 int b
= mgr
->cinfo
.colormap
[ib
][i
] << 8;
6607 colors
[i
] = lookup_rgb_color (f
, r
, g
, b
);
6610 #ifdef COLOR_TABLE_SUPPORT
6611 /* Remember those colors actually allocated. */
6612 img
->colors
= colors_in_color_table (&img
->ncolors
);
6613 free_color_table ();
6614 #endif /* COLOR_TABLE_SUPPORT */
6618 row_stride
= width
* mgr
->cinfo
.output_components
;
6619 buffer
= mgr
->cinfo
.mem
->alloc_sarray ((j_common_ptr
) &mgr
->cinfo
,
6620 JPOOL_IMAGE
, row_stride
, 1);
6621 for (y
= 0; y
< height
; ++y
)
6623 fn_jpeg_read_scanlines (&mgr
->cinfo
, buffer
, 1);
6624 for (x
= 0; x
< mgr
->cinfo
.output_width
; ++x
)
6625 XPutPixel (ximg
, x
, y
, colors
[buffer
[0][x
]]);
6629 fn_jpeg_finish_decompress (&mgr
->cinfo
);
6630 fn_jpeg_destroy_decompress (&mgr
->cinfo
);
6634 /* Maybe fill in the background field while we have ximg handy. */
6635 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
6636 /* Casting avoids a GCC warning. */
6637 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
6639 /* Put ximg into the image. */
6640 image_put_x_image (f
, img
, ximg
, 0);
6645 jpeg_load (struct frame
*f
, struct image
*img
)
6647 struct my_jpeg_error_mgr mgr
;
6648 return jpeg_load_body (f
, img
, &mgr
);
6651 #else /* HAVE_JPEG */
6655 jpeg_load (struct frame
*f
, struct image
*img
)
6657 return ns_load_image (f
, img
,
6658 image_spec_value (img
->spec
, QCfile
, NULL
),
6659 image_spec_value (img
->spec
, QCdata
, NULL
));
6661 #endif /* HAVE_NS */
6663 #endif /* !HAVE_JPEG */
6667 /***********************************************************************
6669 ***********************************************************************/
6671 #if defined (HAVE_TIFF) || defined (HAVE_NS)
6673 static bool tiff_image_p (Lisp_Object object
);
6674 static bool tiff_load (struct frame
*f
, struct image
*img
);
6676 /* The symbol `tiff' identifying images of this type. */
6678 static Lisp_Object Qtiff
;
6680 /* Indices of image specification fields in tiff_format, below. */
6682 enum tiff_keyword_index
6691 TIFF_HEURISTIC_MASK
,
6698 /* Vector of image_keyword structures describing the format
6699 of valid user-defined image specifications. */
6701 static const struct image_keyword tiff_format
[TIFF_LAST
] =
6703 {":type", IMAGE_SYMBOL_VALUE
, 1},
6704 {":data", IMAGE_STRING_VALUE
, 0},
6705 {":file", IMAGE_STRING_VALUE
, 0},
6706 {":ascent", IMAGE_ASCENT_VALUE
, 0},
6707 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
6708 {":relief", IMAGE_INTEGER_VALUE
, 0},
6709 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6710 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6711 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6712 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0},
6713 {":index", IMAGE_NON_NEGATIVE_INTEGER_VALUE
, 0}
6716 #if defined HAVE_NTGUI && defined WINDOWSNT
6717 static bool init_tiff_functions (void);
6719 #define init_tiff_functions NULL
6722 /* Structure describing the image type `tiff'. */
6724 static struct image_type tiff_type
=
6730 init_tiff_functions
,
6734 /* Return true if OBJECT is a valid TIFF image specification. */
6737 tiff_image_p (Lisp_Object object
)
6739 struct image_keyword fmt
[TIFF_LAST
];
6740 memcpy (fmt
, tiff_format
, sizeof fmt
);
6742 if (!parse_image_spec (object
, fmt
, TIFF_LAST
, Qtiff
))
6745 /* Must specify either the :data or :file keyword. */
6746 return fmt
[TIFF_FILE
].count
+ fmt
[TIFF_DATA
].count
== 1;
6749 #endif /* HAVE_TIFF || HAVE_NS */
6757 /* TIFF library details. */
6758 DEF_IMGLIB_FN (TIFFErrorHandler
, TIFFSetErrorHandler
, (TIFFErrorHandler
));
6759 DEF_IMGLIB_FN (TIFFErrorHandler
, TIFFSetWarningHandler
, (TIFFErrorHandler
));
6760 DEF_IMGLIB_FN (TIFF
*, TIFFOpen
, (const char *, const char *));
6761 DEF_IMGLIB_FN (TIFF
*, TIFFClientOpen
, (const char *, const char *, thandle_t
,
6762 TIFFReadWriteProc
, TIFFReadWriteProc
,
6763 TIFFSeekProc
, TIFFCloseProc
, TIFFSizeProc
,
6764 TIFFMapFileProc
, TIFFUnmapFileProc
));
6765 DEF_IMGLIB_FN (int, TIFFGetField
, (TIFF
*, ttag_t
, ...));
6766 DEF_IMGLIB_FN (int, TIFFReadRGBAImage
, (TIFF
*, uint32
, uint32
, uint32
*, int));
6767 DEF_IMGLIB_FN (void, TIFFClose
, (TIFF
*));
6768 DEF_IMGLIB_FN (int, TIFFSetDirectory
, (TIFF
*, tdir_t
));
6771 init_tiff_functions (void)
6775 if (!(library
= w32_delayed_load (Qtiff
)))
6778 LOAD_IMGLIB_FN (library
, TIFFSetErrorHandler
);
6779 LOAD_IMGLIB_FN (library
, TIFFSetWarningHandler
);
6780 LOAD_IMGLIB_FN (library
, TIFFOpen
);
6781 LOAD_IMGLIB_FN (library
, TIFFClientOpen
);
6782 LOAD_IMGLIB_FN (library
, TIFFGetField
);
6783 LOAD_IMGLIB_FN (library
, TIFFReadRGBAImage
);
6784 LOAD_IMGLIB_FN (library
, TIFFClose
);
6785 LOAD_IMGLIB_FN (library
, TIFFSetDirectory
);
6791 #define fn_TIFFSetErrorHandler TIFFSetErrorHandler
6792 #define fn_TIFFSetWarningHandler TIFFSetWarningHandler
6793 #define fn_TIFFOpen TIFFOpen
6794 #define fn_TIFFClientOpen TIFFClientOpen
6795 #define fn_TIFFGetField TIFFGetField
6796 #define fn_TIFFReadRGBAImage TIFFReadRGBAImage
6797 #define fn_TIFFClose TIFFClose
6798 #define fn_TIFFSetDirectory TIFFSetDirectory
6799 #endif /* WINDOWSNT */
6802 /* Reading from a memory buffer for TIFF images Based on the PNG
6803 memory source, but we have to provide a lot of extra functions.
6806 We really only need to implement read and seek, but I am not
6807 convinced that the TIFF library is smart enough not to destroy
6808 itself if we only hand it the function pointers we need to
6813 unsigned char *bytes
;
6820 tiff_read_from_memory (thandle_t data
, tdata_t buf
, tsize_t size
)
6822 tiff_memory_source
*src
= (tiff_memory_source
*) data
;
6824 size
= min (size
, src
->len
- src
->index
);
6825 memcpy (buf
, src
->bytes
+ src
->index
, size
);
6831 tiff_write_from_memory (thandle_t data
, tdata_t buf
, tsize_t size
)
6837 tiff_seek_in_memory (thandle_t data
, toff_t off
, int whence
)
6839 tiff_memory_source
*src
= (tiff_memory_source
*) data
;
6844 case SEEK_SET
: /* Go from beginning of source. */
6848 case SEEK_END
: /* Go from end of source. */
6849 idx
= src
->len
+ off
;
6852 case SEEK_CUR
: /* Go from current position. */
6853 idx
= src
->index
+ off
;
6856 default: /* Invalid `whence'. */
6860 if (idx
> src
->len
|| idx
< 0)
6868 tiff_close_memory (thandle_t data
)
6875 tiff_mmap_memory (thandle_t data
, tdata_t
*pbase
, toff_t
*psize
)
6877 /* It is already _IN_ memory. */
6882 tiff_unmap_memory (thandle_t data
, tdata_t base
, toff_t size
)
6884 /* We don't need to do this. */
6888 tiff_size_of_memory (thandle_t data
)
6890 return ((tiff_memory_source
*) data
)->len
;
6893 /* GCC 3.x on x86 Windows targets has a bug that triggers an internal
6894 compiler error compiling tiff_handler, see Bugzilla bug #17406
6895 (http://gcc.gnu.org/bugzilla/show_bug.cgi?id=17406). Declaring
6896 this function as external works around that problem. */
6897 #if defined (__MINGW32__) && __GNUC__ == 3
6898 # define MINGW_STATIC
6900 # define MINGW_STATIC static
6904 tiff_handler (const char *, const char *, const char *, va_list)
6905 ATTRIBUTE_FORMAT_PRINTF (3, 0);
6907 tiff_handler (const char *log_format
, const char *title
,
6908 const char *format
, va_list ap
)
6910 /* doprnt is not suitable here, as TIFF handlers are called from
6911 libtiff and are passed arbitrary printf directives. Instead, use
6912 vsnprintf, taking care to be portable to nonstandard environments
6913 where vsnprintf returns -1 on buffer overflow. Since it's just a
6914 log entry, it's OK to truncate it. */
6916 int len
= vsnprintf (buf
, sizeof buf
, format
, ap
);
6917 add_to_log (log_format
, build_string (title
),
6918 make_string (buf
, max (0, min (len
, sizeof buf
- 1))));
6922 static void tiff_error_handler (const char *, const char *, va_list)
6923 ATTRIBUTE_FORMAT_PRINTF (2, 0);
6925 tiff_error_handler (const char *title
, const char *format
, va_list ap
)
6927 tiff_handler ("TIFF error: %s %s", title
, format
, ap
);
6931 static void tiff_warning_handler (const char *, const char *, va_list)
6932 ATTRIBUTE_FORMAT_PRINTF (2, 0);
6934 tiff_warning_handler (const char *title
, const char *format
, va_list ap
)
6936 tiff_handler ("TIFF warning: %s %s", title
, format
, ap
);
6940 /* Load TIFF image IMG for use on frame F. Value is true if
6944 tiff_load (struct frame
*f
, struct image
*img
)
6946 Lisp_Object file
, specified_file
;
6947 Lisp_Object specified_data
;
6949 int width
, height
, x
, y
, count
;
6953 tiff_memory_source memsrc
;
6956 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
6957 specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
6959 fn_TIFFSetErrorHandler ((TIFFErrorHandler
) tiff_error_handler
);
6960 fn_TIFFSetWarningHandler ((TIFFErrorHandler
) tiff_warning_handler
);
6962 if (NILP (specified_data
))
6964 /* Read from a file */
6965 file
= x_find_image_file (specified_file
);
6966 if (!STRINGP (file
))
6968 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
6972 file
= ansi_encode_filename (file
);
6975 /* Try to open the image file. */
6976 tiff
= fn_TIFFOpen (SSDATA (file
), "r");
6979 image_error ("Cannot open `%s'", file
, Qnil
);
6985 if (!STRINGP (specified_data
))
6987 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
6991 /* Memory source! */
6992 memsrc
.bytes
= SDATA (specified_data
);
6993 memsrc
.len
= SBYTES (specified_data
);
6996 tiff
= fn_TIFFClientOpen ("memory_source", "r", (thandle_t
)&memsrc
,
6997 tiff_read_from_memory
,
6998 tiff_write_from_memory
,
6999 tiff_seek_in_memory
,
7001 tiff_size_of_memory
,
7007 image_error ("Cannot open memory source for `%s'", img
->spec
, Qnil
);
7012 image
= image_spec_value (img
->spec
, QCindex
, NULL
);
7013 if (INTEGERP (image
))
7015 EMACS_INT ino
= XFASTINT (image
);
7016 if (! (TYPE_MINIMUM (tdir_t
) <= ino
&& ino
<= TYPE_MAXIMUM (tdir_t
)
7017 && fn_TIFFSetDirectory (tiff
, ino
)))
7019 image_error ("Invalid image number `%s' in image `%s'",
7021 fn_TIFFClose (tiff
);
7026 /* Get width and height of the image, and allocate a raster buffer
7027 of width x height 32-bit values. */
7028 fn_TIFFGetField (tiff
, TIFFTAG_IMAGEWIDTH
, &width
);
7029 fn_TIFFGetField (tiff
, TIFFTAG_IMAGELENGTH
, &height
);
7031 if (!check_image_size (f
, width
, height
))
7033 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
7034 fn_TIFFClose (tiff
);
7038 /* Create the X image and pixmap. */
7039 if (! (height
<= min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *buf
/ width
7040 && image_create_x_image_and_pixmap (f
, img
, width
, height
, 0,
7043 fn_TIFFClose (tiff
);
7047 buf
= xmalloc (sizeof *buf
* width
* height
);
7049 rc
= fn_TIFFReadRGBAImage (tiff
, width
, height
, buf
, 0);
7051 /* Count the number of images in the file. */
7052 for (count
= 1; fn_TIFFSetDirectory (tiff
, count
); count
++)
7056 img
->lisp_data
= Fcons (Qcount
,
7057 Fcons (make_number (count
),
7060 fn_TIFFClose (tiff
);
7063 image_error ("Error reading TIFF image `%s'", img
->spec
, Qnil
);
7068 /* Initialize the color table. */
7069 init_color_table ();
7071 /* Process the pixel raster. Origin is in the lower-left corner. */
7072 for (y
= 0; y
< height
; ++y
)
7074 uint32
*row
= buf
+ y
* width
;
7076 for (x
= 0; x
< width
; ++x
)
7078 uint32 abgr
= row
[x
];
7079 int r
= TIFFGetR (abgr
) << 8;
7080 int g
= TIFFGetG (abgr
) << 8;
7081 int b
= TIFFGetB (abgr
) << 8;
7082 XPutPixel (ximg
, x
, height
- 1 - y
, lookup_rgb_color (f
, r
, g
, b
));
7086 #ifdef COLOR_TABLE_SUPPORT
7087 /* Remember the colors allocated for the image. Free the color table. */
7088 img
->colors
= colors_in_color_table (&img
->ncolors
);
7089 free_color_table ();
7090 #endif /* COLOR_TABLE_SUPPORT */
7093 img
->height
= height
;
7095 /* Maybe fill in the background field while we have ximg handy. */
7096 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
7097 /* Casting avoids a GCC warning on W32. */
7098 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
7100 /* Put ximg into the image. */
7101 image_put_x_image (f
, img
, ximg
, 0);
7107 #else /* HAVE_TIFF */
7111 tiff_load (struct frame
*f
, struct image
*img
)
7113 return ns_load_image (f
, img
,
7114 image_spec_value (img
->spec
, QCfile
, NULL
),
7115 image_spec_value (img
->spec
, QCdata
, NULL
));
7117 #endif /* HAVE_NS */
7119 #endif /* !HAVE_TIFF */
7123 /***********************************************************************
7125 ***********************************************************************/
7127 #if defined (HAVE_GIF) || defined (HAVE_NS)
7129 static bool gif_image_p (Lisp_Object object
);
7130 static bool gif_load (struct frame
*f
, struct image
*img
);
7131 static void gif_clear_image (struct frame
*f
, struct image
*img
);
7133 /* The symbol `gif' identifying images of this type. */
7135 static Lisp_Object Qgif
;
7137 /* Indices of image specification fields in gif_format, below. */
7139 enum gif_keyword_index
7155 /* Vector of image_keyword structures describing the format
7156 of valid user-defined image specifications. */
7158 static const struct image_keyword gif_format
[GIF_LAST
] =
7160 {":type", IMAGE_SYMBOL_VALUE
, 1},
7161 {":data", IMAGE_STRING_VALUE
, 0},
7162 {":file", IMAGE_STRING_VALUE
, 0},
7163 {":ascent", IMAGE_ASCENT_VALUE
, 0},
7164 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
7165 {":relief", IMAGE_INTEGER_VALUE
, 0},
7166 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7167 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7168 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7169 {":index", IMAGE_NON_NEGATIVE_INTEGER_VALUE
, 0},
7170 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
7173 #if defined HAVE_NTGUI && defined WINDOWSNT
7174 static bool init_gif_functions (void);
7176 #define init_gif_functions NULL
7179 /* Structure describing the image type `gif'. */
7181 static struct image_type gif_type
=
7191 /* Free X resources of GIF image IMG which is used on frame F. */
7194 gif_clear_image (struct frame
*f
, struct image
*img
)
7196 img
->lisp_data
= Qnil
;
7197 x_clear_image (f
, img
);
7200 /* Return true if OBJECT is a valid GIF image specification. */
7203 gif_image_p (Lisp_Object object
)
7205 struct image_keyword fmt
[GIF_LAST
];
7206 memcpy (fmt
, gif_format
, sizeof fmt
);
7208 if (!parse_image_spec (object
, fmt
, GIF_LAST
, Qgif
))
7211 /* Must specify either the :data or :file keyword. */
7212 return fmt
[GIF_FILE
].count
+ fmt
[GIF_DATA
].count
== 1;
7215 #endif /* HAVE_GIF */
7219 #if defined (HAVE_NTGUI)
7221 /* winuser.h might define DrawText to DrawTextA or DrawTextW.
7222 Undefine before redefining to avoid a preprocessor warning. */
7226 /* avoid conflict with QuickdrawText.h */
7227 #define DrawText gif_DrawText
7228 #include <gif_lib.h>
7231 /* Giflib before 5.0 didn't define these macros (used only if HAVE_NTGUI). */
7232 #ifndef GIFLIB_MINOR
7233 #define GIFLIB_MINOR 0
7235 #ifndef GIFLIB_RELEASE
7236 #define GIFLIB_RELEASE 0
7239 #else /* HAVE_NTGUI */
7241 #include <gif_lib.h>
7243 #endif /* HAVE_NTGUI */
7245 /* Giflib before 5.0 didn't define these macros. */
7246 #ifndef GIFLIB_MAJOR
7247 #define GIFLIB_MAJOR 4
7252 /* GIF library details. */
7253 DEF_IMGLIB_FN (int, DGifCloseFile
, (GifFileType
*));
7254 DEF_IMGLIB_FN (int, DGifSlurp
, (GifFileType
*));
7255 #if GIFLIB_MAJOR < 5
7256 DEF_IMGLIB_FN (GifFileType
*, DGifOpen
, (void *, InputFunc
));
7257 DEF_IMGLIB_FN (GifFileType
*, DGifOpenFileName
, (const char *));
7259 DEF_IMGLIB_FN (GifFileType
*, DGifOpen
, (void *, InputFunc
, int *));
7260 DEF_IMGLIB_FN (GifFileType
*, DGifOpenFileName
, (const char *, int *));
7261 DEF_IMGLIB_FN (char *, GifErrorString
, (int));
7265 init_gif_functions (void)
7269 if (!(library
= w32_delayed_load (Qgif
)))
7272 LOAD_IMGLIB_FN (library
, DGifCloseFile
);
7273 LOAD_IMGLIB_FN (library
, DGifSlurp
);
7274 LOAD_IMGLIB_FN (library
, DGifOpen
);
7275 LOAD_IMGLIB_FN (library
, DGifOpenFileName
);
7276 #if GIFLIB_MAJOR >= 5
7277 LOAD_IMGLIB_FN (library
, GifErrorString
);
7284 #define fn_DGifCloseFile DGifCloseFile
7285 #define fn_DGifSlurp DGifSlurp
7286 #define fn_DGifOpen DGifOpen
7287 #define fn_DGifOpenFileName DGifOpenFileName
7288 #if 5 <= GIFLIB_MAJOR
7289 # define fn_GifErrorString GifErrorString
7292 #endif /* WINDOWSNT */
7294 /* Reading a GIF image from memory
7295 Based on the PNG memory stuff to a certain extent. */
7299 unsigned char *bytes
;
7305 /* Make the current memory source available to gif_read_from_memory.
7306 It's done this way because not all versions of libungif support
7307 a UserData field in the GifFileType structure. */
7308 static gif_memory_source
*current_gif_memory_src
;
7311 gif_read_from_memory (GifFileType
*file
, GifByteType
*buf
, int len
)
7313 gif_memory_source
*src
= current_gif_memory_src
;
7315 if (len
> src
->len
- src
->index
)
7318 memcpy (buf
, src
->bytes
+ src
->index
, len
);
7324 /* Load GIF image IMG for use on frame F. Value is true if
7327 static const int interlace_start
[] = {0, 4, 2, 1};
7328 static const int interlace_increment
[] = {8, 8, 4, 2};
7330 #define GIF_LOCAL_DESCRIPTOR_EXTENSION 249
7333 gif_load (struct frame
*f
, struct image
*img
)
7336 int rc
, width
, height
, x
, y
, i
, j
;
7338 ColorMapObject
*gif_color_map
;
7339 unsigned long pixel_colors
[256];
7341 gif_memory_source memsrc
;
7342 Lisp_Object specified_bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
7343 Lisp_Object specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
7344 Lisp_Object specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
7345 unsigned long bgcolor
= 0;
7347 #if GIFLIB_MAJOR >= 5
7351 if (NILP (specified_data
))
7353 file
= x_find_image_file (specified_file
);
7354 if (!STRINGP (file
))
7356 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
7360 file
= ansi_encode_filename (file
);
7363 /* Open the GIF file. */
7364 #if GIFLIB_MAJOR < 5
7365 gif
= fn_DGifOpenFileName (SSDATA (file
));
7368 image_error ("Cannot open `%s'", file
, Qnil
);
7372 gif
= fn_DGifOpenFileName (SSDATA (file
), &gif_err
);
7375 image_error ("Cannot open `%s': %s",
7376 file
, build_string (fn_GifErrorString (gif_err
)));
7383 if (!STRINGP (specified_data
))
7385 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
7389 /* Read from memory! */
7390 current_gif_memory_src
= &memsrc
;
7391 memsrc
.bytes
= SDATA (specified_data
);
7392 memsrc
.len
= SBYTES (specified_data
);
7395 #if GIFLIB_MAJOR < 5
7396 gif
= fn_DGifOpen (&memsrc
, gif_read_from_memory
);
7399 image_error ("Cannot open memory source `%s'", img
->spec
, Qnil
);
7403 gif
= fn_DGifOpen (&memsrc
, gif_read_from_memory
, &gif_err
);
7406 image_error ("Cannot open memory source `%s': %s",
7407 img
->spec
, build_string (fn_GifErrorString (gif_err
)));
7413 /* Before reading entire contents, check the declared image size. */
7414 if (!check_image_size (f
, gif
->SWidth
, gif
->SHeight
))
7416 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
7417 fn_DGifCloseFile (gif
);
7421 /* Read entire contents. */
7422 rc
= fn_DGifSlurp (gif
);
7423 if (rc
== GIF_ERROR
|| gif
->ImageCount
<= 0)
7425 image_error ("Error reading `%s'", img
->spec
, Qnil
);
7426 fn_DGifCloseFile (gif
);
7430 /* Which sub-image are we to display? */
7432 Lisp_Object image_number
= image_spec_value (img
->spec
, QCindex
, NULL
);
7433 idx
= INTEGERP (image_number
) ? XFASTINT (image_number
) : 0;
7434 if (idx
< 0 || idx
>= gif
->ImageCount
)
7436 image_error ("Invalid image number `%s' in image `%s'",
7437 image_number
, img
->spec
);
7438 fn_DGifCloseFile (gif
);
7443 width
= img
->width
= gif
->SWidth
;
7444 height
= img
->height
= gif
->SHeight
;
7446 img
->corners
[TOP_CORNER
] = gif
->SavedImages
[0].ImageDesc
.Top
;
7447 img
->corners
[LEFT_CORNER
] = gif
->SavedImages
[0].ImageDesc
.Left
;
7448 img
->corners
[BOT_CORNER
]
7449 = img
->corners
[TOP_CORNER
] + gif
->SavedImages
[0].ImageDesc
.Height
;
7450 img
->corners
[RIGHT_CORNER
]
7451 = img
->corners
[LEFT_CORNER
] + gif
->SavedImages
[0].ImageDesc
.Width
;
7453 if (!check_image_size (f
, width
, height
))
7455 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
7456 fn_DGifCloseFile (gif
);
7460 /* Check that the selected subimages fit. It's not clear whether
7461 the GIF spec requires this, but Emacs can crash if they don't fit. */
7462 for (j
= 0; j
<= idx
; ++j
)
7464 struct SavedImage
*subimage
= gif
->SavedImages
+ j
;
7465 int subimg_width
= subimage
->ImageDesc
.Width
;
7466 int subimg_height
= subimage
->ImageDesc
.Height
;
7467 int subimg_top
= subimage
->ImageDesc
.Top
;
7468 int subimg_left
= subimage
->ImageDesc
.Left
;
7469 if (! (0 <= subimg_width
&& 0 <= subimg_height
7470 && 0 <= subimg_top
&& subimg_top
<= height
- subimg_height
7471 && 0 <= subimg_left
&& subimg_left
<= width
- subimg_width
))
7473 image_error ("Subimage does not fit in image", Qnil
, Qnil
);
7474 fn_DGifCloseFile (gif
);
7479 /* Create the X image and pixmap. */
7480 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, 0, &ximg
, 0))
7482 fn_DGifCloseFile (gif
);
7486 /* Clear the part of the screen image not covered by the image.
7487 Full animated GIF support requires more here (see the gif89 spec,
7488 disposal methods). Let's simply assume that the part not covered
7489 by a sub-image is in the frame's background color. */
7490 for (y
= 0; y
< img
->corners
[TOP_CORNER
]; ++y
)
7491 for (x
= 0; x
< width
; ++x
)
7492 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7494 for (y
= img
->corners
[BOT_CORNER
]; y
< height
; ++y
)
7495 for (x
= 0; x
< width
; ++x
)
7496 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7498 for (y
= img
->corners
[TOP_CORNER
]; y
< img
->corners
[BOT_CORNER
]; ++y
)
7500 for (x
= 0; x
< img
->corners
[LEFT_CORNER
]; ++x
)
7501 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7502 for (x
= img
->corners
[RIGHT_CORNER
]; x
< width
; ++x
)
7503 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7506 /* Read the GIF image into the X image. */
7508 /* FIXME: With the current implementation, loading an animated gif
7509 is quadratic in the number of animation frames, since each frame
7510 is a separate struct image. We must provide a way for a single
7511 gif_load call to construct and save all animation frames. */
7513 init_color_table ();
7514 if (STRINGP (specified_bg
))
7515 bgcolor
= x_alloc_image_color (f
, img
, specified_bg
,
7516 FRAME_BACKGROUND_PIXEL (f
));
7517 for (j
= 0; j
<= idx
; ++j
)
7519 /* We use a local variable `raster' here because RasterBits is a
7520 char *, which invites problems with bytes >= 0x80. */
7521 struct SavedImage
*subimage
= gif
->SavedImages
+ j
;
7522 unsigned char *raster
= (unsigned char *) subimage
->RasterBits
;
7523 int transparency_color_index
= -1;
7525 int subimg_width
= subimage
->ImageDesc
.Width
;
7526 int subimg_height
= subimage
->ImageDesc
.Height
;
7527 int subimg_top
= subimage
->ImageDesc
.Top
;
7528 int subimg_left
= subimage
->ImageDesc
.Left
;
7530 /* Find the Graphic Control Extension block for this sub-image.
7531 Extract the disposal method and transparency color. */
7532 for (i
= 0; i
< subimage
->ExtensionBlockCount
; i
++)
7534 ExtensionBlock
*extblock
= subimage
->ExtensionBlocks
+ i
;
7536 if ((extblock
->Function
== GIF_LOCAL_DESCRIPTOR_EXTENSION
)
7537 && extblock
->ByteCount
== 4
7538 && extblock
->Bytes
[0] & 1)
7540 /* From gif89a spec: 1 = "keep in place", 2 = "restore
7541 to background". Treat any other value like 2. */
7542 disposal
= (extblock
->Bytes
[0] >> 2) & 7;
7543 transparency_color_index
= (unsigned char) extblock
->Bytes
[3];
7548 /* We can't "keep in place" the first subimage. */
7552 /* For disposal == 0, the spec says "No disposal specified. The
7553 decoder is not required to take any action." In practice, it
7554 seems we need to treat this like "keep in place", see e.g.
7555 http://upload.wikimedia.org/wikipedia/commons/3/37/Clock.gif */
7559 /* Allocate subimage colors. */
7560 memset (pixel_colors
, 0, sizeof pixel_colors
);
7561 gif_color_map
= subimage
->ImageDesc
.ColorMap
;
7563 gif_color_map
= gif
->SColorMap
;
7566 for (i
= 0; i
< gif_color_map
->ColorCount
; ++i
)
7568 if (transparency_color_index
== i
)
7569 pixel_colors
[i
] = STRINGP (specified_bg
)
7570 ? bgcolor
: FRAME_BACKGROUND_PIXEL (f
);
7573 int r
= gif_color_map
->Colors
[i
].Red
<< 8;
7574 int g
= gif_color_map
->Colors
[i
].Green
<< 8;
7575 int b
= gif_color_map
->Colors
[i
].Blue
<< 8;
7576 pixel_colors
[i
] = lookup_rgb_color (f
, r
, g
, b
);
7580 /* Apply the pixel values. */
7581 if (GIFLIB_MAJOR
< 5 && gif
->SavedImages
[j
].ImageDesc
.Interlace
)
7585 for (y
= 0, row
= interlace_start
[0], pass
= 0;
7587 y
++, row
+= interlace_increment
[pass
])
7589 while (subimg_height
<= row
)
7590 row
= interlace_start
[++pass
];
7592 for (x
= 0; x
< subimg_width
; x
++)
7594 int c
= raster
[y
* subimg_width
+ x
];
7595 if (transparency_color_index
!= c
|| disposal
!= 1)
7596 XPutPixel (ximg
, x
+ subimg_left
, row
+ subimg_top
,
7603 for (y
= 0; y
< subimg_height
; ++y
)
7604 for (x
= 0; x
< subimg_width
; ++x
)
7606 int c
= raster
[y
* subimg_width
+ x
];
7607 if (transparency_color_index
!= c
|| disposal
!= 1)
7608 XPutPixel (ximg
, x
+ subimg_left
, y
+ subimg_top
,
7614 #ifdef COLOR_TABLE_SUPPORT
7615 img
->colors
= colors_in_color_table (&img
->ncolors
);
7616 free_color_table ();
7617 #endif /* COLOR_TABLE_SUPPORT */
7619 /* Save GIF image extension data for `image-metadata'.
7620 Format is (count IMAGES extension-data (FUNCTION "BYTES" ...)). */
7621 img
->lisp_data
= Qnil
;
7622 if (gif
->SavedImages
[idx
].ExtensionBlockCount
> 0)
7625 ExtensionBlock
*ext
= gif
->SavedImages
[idx
].ExtensionBlocks
;
7626 for (i
= 0; i
< gif
->SavedImages
[idx
].ExtensionBlockCount
; i
++, ext
++)
7627 /* Append (... FUNCTION "BYTES") */
7630 = Fcons (make_number (ext
->Function
),
7631 Fcons (make_unibyte_string (ext
->Bytes
, ext
->ByteCount
),
7633 if (ext
->Function
== GIF_LOCAL_DESCRIPTOR_EXTENSION
7634 && ext
->ByteCount
== 4)
7636 delay
= ext
->Bytes
[2] << CHAR_BIT
;
7637 delay
|= ext
->Bytes
[1];
7640 img
->lisp_data
= list2 (Qextension_data
, img
->lisp_data
);
7644 Fcons (make_float (delay
/ 100.0),
7648 if (gif
->ImageCount
> 1)
7649 img
->lisp_data
= Fcons (Qcount
,
7650 Fcons (make_number (gif
->ImageCount
),
7653 fn_DGifCloseFile (gif
);
7655 /* Maybe fill in the background field while we have ximg handy. */
7656 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
7657 /* Casting avoids a GCC warning. */
7658 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
7660 /* Put ximg into the image. */
7661 image_put_x_image (f
, img
, ximg
, 0);
7666 #else /* !HAVE_GIF */
7670 gif_load (struct frame
*f
, struct image
*img
)
7672 return ns_load_image (f
, img
,
7673 image_spec_value (img
->spec
, QCfile
, NULL
),
7674 image_spec_value (img
->spec
, QCdata
, NULL
));
7676 #endif /* HAVE_NS */
7678 #endif /* HAVE_GIF */
7681 #ifdef HAVE_IMAGEMAGICK
7683 /***********************************************************************
7685 ***********************************************************************/
7687 /* Scale an image size by returning SIZE / DIVISOR * MULTIPLIER,
7688 safely rounded and clipped to int range. */
7691 scale_image_size (int size
, size_t divisor
, size_t multiplier
)
7696 double scaled
= s
* multiplier
/ divisor
+ 0.5;
7697 if (scaled
< INT_MAX
)
7703 /* Compute the desired size of an image with native size WIDTH x HEIGHT.
7704 Use SPEC to deduce the size. Store the desired size into
7705 *D_WIDTH x *D_HEIGHT. Store -1 x -1 if the native size is OK. */
7707 compute_image_size (size_t width
, size_t height
,
7709 int *d_width
, int *d_height
)
7712 int desired_width
, desired_height
;
7714 /* If width and/or height is set in the display spec assume we want
7715 to scale to those values. If either h or w is unspecified, the
7716 unspecified should be calculated from the specified to preserve
7718 value
= image_spec_value (spec
, QCwidth
, NULL
);
7719 desired_width
= NATNUMP (value
) ? min (XFASTINT (value
), INT_MAX
) : -1;
7720 value
= image_spec_value (spec
, QCheight
, NULL
);
7721 desired_height
= NATNUMP (value
) ? min (XFASTINT (value
), INT_MAX
) : -1;
7723 if (desired_width
== -1)
7725 value
= image_spec_value (spec
, QCmax_width
, NULL
);
7726 if (NATNUMP (value
))
7728 int max_width
= min (XFASTINT (value
), INT_MAX
);
7729 if (max_width
< width
)
7731 /* The image is wider than :max-width. */
7732 desired_width
= max_width
;
7733 if (desired_height
== -1)
7735 desired_height
= scale_image_size (desired_width
,
7737 value
= image_spec_value (spec
, QCmax_height
, NULL
);
7738 if (NATNUMP (value
))
7740 int max_height
= min (XFASTINT (value
), INT_MAX
);
7741 if (max_height
< desired_height
)
7743 desired_height
= max_height
;
7744 desired_width
= scale_image_size (desired_height
,
7753 if (desired_height
== -1)
7755 value
= image_spec_value (spec
, QCmax_height
, NULL
);
7756 if (NATNUMP (value
))
7758 int max_height
= min (XFASTINT (value
), INT_MAX
);
7759 if (max_height
< height
)
7760 desired_height
= max_height
;
7764 if (desired_width
!= -1 && desired_height
== -1)
7765 /* w known, calculate h. */
7766 desired_height
= scale_image_size (desired_width
, width
, height
);
7768 if (desired_width
== -1 && desired_height
!= -1)
7769 /* h known, calculate w. */
7770 desired_width
= scale_image_size (desired_height
, height
, width
);
7772 *d_width
= desired_width
;
7773 *d_height
= desired_height
;
7776 static Lisp_Object Qimagemagick
;
7778 static bool imagemagick_image_p (Lisp_Object
);
7779 static bool imagemagick_load (struct frame
*, struct image
*);
7780 static void imagemagick_clear_image (struct frame
*, struct image
*);
7782 /* Indices of image specification fields in imagemagick_format. */
7784 enum imagemagick_keyword_index
7792 IMAGEMAGICK_ALGORITHM
,
7793 IMAGEMAGICK_HEURISTIC_MASK
,
7795 IMAGEMAGICK_BACKGROUND
,
7798 IMAGEMAGICK_MAX_HEIGHT
,
7799 IMAGEMAGICK_MAX_WIDTH
,
7801 IMAGEMAGICK_ROTATION
,
7806 /* Vector of image_keyword structures describing the format
7807 of valid user-defined image specifications. */
7809 static struct image_keyword imagemagick_format
[IMAGEMAGICK_LAST
] =
7811 {":type", IMAGE_SYMBOL_VALUE
, 1},
7812 {":data", IMAGE_STRING_VALUE
, 0},
7813 {":file", IMAGE_STRING_VALUE
, 0},
7814 {":ascent", IMAGE_ASCENT_VALUE
, 0},
7815 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
7816 {":relief", IMAGE_INTEGER_VALUE
, 0},
7817 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7818 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7819 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7820 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0},
7821 {":height", IMAGE_INTEGER_VALUE
, 0},
7822 {":width", IMAGE_INTEGER_VALUE
, 0},
7823 {":max-height", IMAGE_INTEGER_VALUE
, 0},
7824 {":max-width", IMAGE_INTEGER_VALUE
, 0},
7825 {":format", IMAGE_SYMBOL_VALUE
, 0},
7826 {":rotation", IMAGE_NUMBER_VALUE
, 0},
7827 {":crop", IMAGE_DONT_CHECK_VALUE_TYPE
, 0}
7830 #if defined HAVE_NTGUI && defined WINDOWSNT
7831 static bool init_imagemagick_functions (void);
7833 #define init_imagemagick_functions NULL
7836 /* Structure describing the image type for any image handled via
7839 static struct image_type imagemagick_type
=
7842 imagemagick_image_p
,
7844 imagemagick_clear_image
,
7845 init_imagemagick_functions
,
7849 /* Free X resources of imagemagick image IMG which is used on frame F. */
7852 imagemagick_clear_image (struct frame
*f
,
7855 x_clear_image (f
, img
);
7858 /* Return true if OBJECT is a valid IMAGEMAGICK image specification. Do
7859 this by calling parse_image_spec and supplying the keywords that
7860 identify the IMAGEMAGICK format. */
7863 imagemagick_image_p (Lisp_Object object
)
7865 struct image_keyword fmt
[IMAGEMAGICK_LAST
];
7866 memcpy (fmt
, imagemagick_format
, sizeof fmt
);
7868 if (!parse_image_spec (object
, fmt
, IMAGEMAGICK_LAST
, Qimagemagick
))
7871 /* Must specify either the :data or :file keyword. */
7872 return fmt
[IMAGEMAGICK_FILE
].count
+ fmt
[IMAGEMAGICK_DATA
].count
== 1;
7875 /* The GIF library also defines DrawRectangle, but its never used in Emacs.
7876 Therefore rename the function so it doesn't collide with ImageMagick. */
7877 #define DrawRectangle DrawRectangleGif
7878 #include <wand/MagickWand.h>
7880 /* ImageMagick 6.5.3 through 6.6.5 hid PixelGetMagickColor for some reason.
7881 Emacs seems to work fine with the hidden version, so unhide it. */
7882 #include <magick/version.h>
7883 #if 0x653 <= MagickLibVersion && MagickLibVersion <= 0x665
7884 extern WandExport
void PixelGetMagickColor (const PixelWand
*,
7885 MagickPixelPacket
*);
7888 /* Log ImageMagick error message.
7889 Useful when a ImageMagick function returns the status `MagickFalse'. */
7892 imagemagick_error (MagickWand
*wand
)
7895 ExceptionType severity
;
7897 description
= MagickGetException (wand
, &severity
);
7898 image_error ("ImageMagick error: %s",
7899 build_string (description
),
7901 MagickRelinquishMemory (description
);
7904 /* Possibly give ImageMagick some extra help to determine the image
7905 type by supplying a "dummy" filename based on the Content-Type. */
7908 imagemagick_filename_hint (Lisp_Object spec
, char hint_buffer
[MaxTextExtent
])
7910 Lisp_Object symbol
= intern ("image-format-suffixes");
7911 Lisp_Object val
= find_symbol_value (symbol
);
7917 format
= image_spec_value (spec
, intern (":format"), NULL
);
7918 val
= Fcar_safe (Fcdr_safe (Fassq (format
, val
)));
7919 if (! STRINGP (val
))
7922 /* It's OK to truncate the hint if it has MaxTextExtent or more bytes,
7923 as ImageMagick would ignore the extra bytes anyway. */
7924 snprintf (hint_buffer
, MaxTextExtent
, "/tmp/foo.%s", SSDATA (val
));
7928 /* Animated images (e.g., GIF89a) are composed from one "master image"
7929 (which is the first one, and then there's a number of images that
7930 follow. If following images have non-transparent colors, these are
7931 composed "on top" of the master image. So, in general, one has to
7932 compute ann the preceding images to be able to display a particular
7935 Computing all the preceding images is too slow, so we maintain a
7936 cache of previously computed images. We have to maintain a cache
7937 separate from the image cache, because the images may be scaled
7940 struct animation_cache
7944 struct timespec update_time
;
7945 struct animation_cache
*next
;
7946 char signature
[FLEXIBLE_ARRAY_MEMBER
];
7949 static struct animation_cache
*animation_cache
= NULL
;
7951 static struct animation_cache
*
7952 imagemagick_create_cache (char *signature
)
7954 struct animation_cache
*cache
7955 = xmalloc (offsetof (struct animation_cache
, signature
)
7956 + strlen (signature
) + 1);
7960 strcpy (cache
->signature
, signature
);
7964 /* Discard cached images that haven't been used for a minute. */
7966 imagemagick_prune_animation_cache (void)
7968 struct animation_cache
**pcache
= &animation_cache
;
7969 struct timespec old
= timespec_sub (current_timespec (),
7970 make_timespec (60, 0));
7974 struct animation_cache
*cache
= *pcache
;
7975 if (timespec_cmp (old
, cache
->update_time
) <= 0)
7976 pcache
= &cache
->next
;
7980 DestroyMagickWand (cache
->wand
);
7981 *pcache
= cache
->next
;
7987 static struct animation_cache
*
7988 imagemagick_get_animation_cache (MagickWand
*wand
)
7990 char *signature
= MagickGetImageSignature (wand
);
7991 struct animation_cache
*cache
;
7992 struct animation_cache
**pcache
= &animation_cache
;
7994 imagemagick_prune_animation_cache ();
8001 *pcache
= cache
= imagemagick_create_cache (signature
);
8004 if (strcmp (signature
, cache
->signature
) == 0)
8006 pcache
= &cache
->next
;
8009 DestroyString (signature
);
8010 cache
->update_time
= current_timespec ();
8015 imagemagick_compute_animated_image (MagickWand
*super_wand
, int ino
)
8018 MagickWand
*composite_wand
;
8019 size_t dest_width
, dest_height
;
8020 struct animation_cache
*cache
= imagemagick_get_animation_cache (super_wand
);
8022 MagickSetIteratorIndex (super_wand
, 0);
8024 if (ino
== 0 || cache
->wand
== NULL
|| cache
->index
> ino
)
8026 composite_wand
= MagickGetImage (super_wand
);
8028 DestroyMagickWand (cache
->wand
);
8031 composite_wand
= cache
->wand
;
8033 dest_width
= MagickGetImageWidth (composite_wand
);
8034 dest_height
= MagickGetImageHeight (composite_wand
);
8036 for (i
= max (1, cache
->index
+ 1); i
<= ino
; i
++)
8038 MagickWand
*sub_wand
;
8039 PixelIterator
*source_iterator
, *dest_iterator
;
8040 PixelWand
**source
, **dest
;
8041 size_t source_width
, source_height
;
8042 ssize_t source_left
, source_top
;
8043 MagickPixelPacket pixel
;
8044 DisposeType dispose
;
8045 ptrdiff_t lines
= 0;
8047 MagickSetIteratorIndex (super_wand
, i
);
8048 sub_wand
= MagickGetImage (super_wand
);
8050 MagickGetImagePage (sub_wand
, &source_width
, &source_height
,
8051 &source_left
, &source_top
);
8053 /* This flag says how to handle transparent pixels. */
8054 dispose
= MagickGetImageDispose (sub_wand
);
8056 source_iterator
= NewPixelIterator (sub_wand
);
8057 if (! source_iterator
)
8059 DestroyMagickWand (composite_wand
);
8060 DestroyMagickWand (sub_wand
);
8062 image_error ("Imagemagick pixel iterator creation failed",
8067 dest_iterator
= NewPixelIterator (composite_wand
);
8068 if (! dest_iterator
)
8070 DestroyMagickWand (composite_wand
);
8071 DestroyMagickWand (sub_wand
);
8072 DestroyPixelIterator (source_iterator
);
8074 image_error ("Imagemagick pixel iterator creation failed",
8079 /* The sub-image may not start at origin, so move the destination
8080 iterator to where the sub-image should start. */
8083 PixelSetIteratorRow (dest_iterator
, source_top
);
8087 while ((source
= PixelGetNextIteratorRow (source_iterator
, &source_width
))
8092 /* Sanity check. This shouldn't happen, but apparently
8093 does in some pictures. */
8094 if (++lines
>= dest_height
)
8097 dest
= PixelGetNextIteratorRow (dest_iterator
, &dest_width
);
8098 for (x
= 0; x
< source_width
; x
++)
8100 /* Sanity check. This shouldn't happen, but apparently
8101 also does in some pictures. */
8102 if (x
+ source_left
> dest_width
- 1)
8104 /* Normally we only copy over non-transparent pixels,
8105 but if the disposal method is "Background", then we
8106 copy over all pixels. */
8107 if (dispose
== BackgroundDispose
||
8108 PixelGetAlpha (source
[x
]))
8110 PixelGetMagickColor (source
[x
], &pixel
);
8111 PixelSetMagickColor (dest
[x
+ source_left
], &pixel
);
8114 PixelSyncIterator (dest_iterator
);
8117 DestroyPixelIterator (source_iterator
);
8118 DestroyPixelIterator (dest_iterator
);
8119 DestroyMagickWand (sub_wand
);
8122 /* Cache a copy for the next iteration. The current wand will be
8123 destroyed by the caller. */
8124 cache
->wand
= CloneMagickWand (composite_wand
);
8127 return composite_wand
;
8131 /* Helper function for imagemagick_load, which does the actual loading
8132 given contents and size, apart from frame and image structures,
8133 passed from imagemagick_load. Uses librimagemagick to do most of
8134 the image processing.
8136 F is a pointer to the Emacs frame; IMG to the image structure to
8137 prepare; CONTENTS is the string containing the IMAGEMAGICK data to
8138 be parsed; SIZE is the number of bytes of data; and FILENAME is
8139 either the file name or the image data.
8141 Return true if successful. */
8144 imagemagick_load_image (struct frame
*f
, struct image
*img
,
8145 unsigned char *contents
, unsigned int size
,
8148 size_t width
, height
;
8149 MagickBooleanType status
;
8152 MagickWand
*image_wand
;
8153 PixelIterator
*iterator
;
8154 PixelWand
**pixels
, *bg_wand
= NULL
;
8155 MagickPixelPacket pixel
;
8160 int desired_width
, desired_height
;
8163 char hint_buffer
[MaxTextExtent
];
8164 char *filename_hint
= NULL
;
8166 /* Handle image index for image types who can contain more than one image.
8167 Interface :index is same as for GIF. First we "ping" the image to see how
8168 many sub-images it contains. Pinging is faster than loading the image to
8169 find out things about it. */
8171 /* Initialize the imagemagick environment. */
8172 MagickWandGenesis ();
8173 image
= image_spec_value (img
->spec
, QCindex
, NULL
);
8174 ino
= INTEGERP (image
) ? XFASTINT (image
) : 0;
8175 image_wand
= NewMagickWand ();
8178 status
= MagickReadImage (image_wand
, filename
);
8181 filename_hint
= imagemagick_filename_hint (img
->spec
, hint_buffer
);
8182 MagickSetFilename (image_wand
, filename_hint
);
8183 status
= MagickReadImageBlob (image_wand
, contents
, size
);
8186 if (status
== MagickFalse
)
8188 imagemagick_error (image_wand
);
8189 DestroyMagickWand (image_wand
);
8193 if (ino
< 0 || ino
>= MagickGetNumberImages (image_wand
))
8195 image_error ("Invalid image number `%s' in image `%s'",
8197 DestroyMagickWand (image_wand
);
8201 if (MagickGetNumberImages (image_wand
) > 1)
8204 Fcons (make_number (MagickGetNumberImages (image_wand
)),
8207 /* If we have an animated image, get the new wand based on the
8209 if (MagickGetNumberImages (image_wand
) > 1)
8211 MagickWand
*super_wand
= image_wand
;
8212 image_wand
= imagemagick_compute_animated_image (super_wand
, ino
);
8214 image_wand
= super_wand
;
8216 DestroyMagickWand (super_wand
);
8219 /* Retrieve the frame's background color, for use later. */
8222 Lisp_Object specified_bg
;
8224 specified_bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
8225 if (!STRINGP (specified_bg
)
8226 || !x_defined_color (f
, SSDATA (specified_bg
), &bgcolor
, 0))
8227 x_query_frame_background_color (f
, &bgcolor
);
8229 bg_wand
= NewPixelWand ();
8230 PixelSetRed (bg_wand
, (double) bgcolor
.red
/ 65535);
8231 PixelSetGreen (bg_wand
, (double) bgcolor
.green
/ 65535);
8232 PixelSetBlue (bg_wand
, (double) bgcolor
.blue
/ 65535);
8235 compute_image_size (MagickGetImageWidth (image_wand
),
8236 MagickGetImageHeight (image_wand
),
8237 img
->spec
, &desired_width
, &desired_height
);
8239 if (desired_width
!= -1 && desired_height
!= -1)
8241 status
= MagickScaleImage (image_wand
, desired_width
, desired_height
);
8242 if (status
== MagickFalse
)
8244 image_error ("Imagemagick scale failed", Qnil
, Qnil
);
8245 imagemagick_error (image_wand
);
8246 goto imagemagick_error
;
8250 /* crop behaves similar to image slicing in Emacs but is more memory
8252 crop
= image_spec_value (img
->spec
, QCcrop
, NULL
);
8254 if (CONSP (crop
) && TYPE_RANGED_INTEGERP (size_t, XCAR (crop
)))
8256 /* After some testing, it seems MagickCropImage is the fastest crop
8257 function in ImageMagick. This crop function seems to do less copying
8258 than the alternatives, but it still reads the entire image into memory
8259 before cropping, which is apparently difficult to avoid when using
8261 size_t crop_width
= XINT (XCAR (crop
));
8263 if (CONSP (crop
) && TYPE_RANGED_INTEGERP (size_t, XCAR (crop
)))
8265 size_t crop_height
= XINT (XCAR (crop
));
8267 if (CONSP (crop
) && TYPE_RANGED_INTEGERP (ssize_t
, XCAR (crop
)))
8269 ssize_t crop_x
= XINT (XCAR (crop
));
8271 if (CONSP (crop
) && TYPE_RANGED_INTEGERP (ssize_t
, XCAR (crop
)))
8273 ssize_t crop_y
= XINT (XCAR (crop
));
8274 MagickCropImage (image_wand
, crop_width
, crop_height
,
8281 /* Furthermore :rotation. we need background color and angle for
8284 TODO background handling for rotation specified_bg =
8285 image_spec_value (img->spec, QCbackground, NULL); if (!STRINGP
8287 value
= image_spec_value (img
->spec
, QCrotation
, NULL
);
8290 rotation
= extract_float (value
);
8291 status
= MagickRotateImage (image_wand
, bg_wand
, rotation
);
8292 if (status
== MagickFalse
)
8294 image_error ("Imagemagick image rotate failed", Qnil
, Qnil
);
8295 imagemagick_error (image_wand
);
8296 goto imagemagick_error
;
8300 /* Set the canvas background color to the frame or specified
8301 background, and flatten the image. Note: as of ImageMagick
8302 6.6.0, SVG image transparency is not handled properly
8303 (e.g. etc/images/splash.svg shows a white background always). */
8305 MagickWand
*new_wand
;
8306 MagickSetImageBackgroundColor (image_wand
, bg_wand
);
8307 #ifdef HAVE_MAGICKMERGEIMAGELAYERS
8308 new_wand
= MagickMergeImageLayers (image_wand
, MergeLayer
);
8310 new_wand
= MagickFlattenImages (image_wand
);
8312 DestroyMagickWand (image_wand
);
8313 image_wand
= new_wand
;
8316 /* Finally we are done manipulating the image. Figure out the
8317 resulting width/height and transfer ownership to Emacs. */
8318 height
= MagickGetImageHeight (image_wand
);
8319 width
= MagickGetImageWidth (image_wand
);
8321 if (! (width
<= INT_MAX
&& height
<= INT_MAX
8322 && check_image_size (f
, width
, height
)))
8324 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
8325 goto imagemagick_error
;
8328 /* We can now get a valid pixel buffer from the imagemagick file, if all
8331 init_color_table ();
8333 #if defined (HAVE_MAGICKEXPORTIMAGEPIXELS) && ! defined (HAVE_NS)
8334 if (imagemagick_render_type
!= 0)
8336 /* Magicexportimage is normally faster than pixelpushing. This
8337 method is also well tested. Some aspects of this method are
8338 ad-hoc and needs to be more researched. */
8339 int imagedepth
= 24; /*MagickGetImageDepth(image_wand);*/
8340 const char *exportdepth
= imagedepth
<= 8 ? "I" : "BGRP"; /*"RGBP";*/
8341 /* Try to create a x pixmap to hold the imagemagick pixmap. */
8342 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, imagedepth
,
8345 #ifdef COLOR_TABLE_SUPPORT
8346 free_color_table ();
8348 image_error ("Imagemagick X bitmap allocation failure", Qnil
, Qnil
);
8349 goto imagemagick_error
;
8352 /* Oddly, the below code doesn't seem to work:*/
8353 /* switch(ximg->bitmap_unit){ */
8355 /* pixelwidth=CharPixel; */
8358 /* pixelwidth=ShortPixel; */
8361 /* pixelwidth=LongPixel; */
8365 Here im just guessing the format of the bitmap.
8366 happens to work fine for:
8369 seems about 3 times as fast as pixel pushing(not carefully measured)
8371 pixelwidth
= CharPixel
; /*??? TODO figure out*/
8372 MagickExportImagePixels (image_wand
, 0, 0, width
, height
,
8373 exportdepth
, pixelwidth
, ximg
->data
);
8376 #endif /* HAVE_MAGICKEXPORTIMAGEPIXELS */
8378 size_t image_height
;
8379 MagickRealType color_scale
= 65535.0 / QuantumRange
;
8381 /* Try to create a x pixmap to hold the imagemagick pixmap. */
8382 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, 0,
8385 #ifdef COLOR_TABLE_SUPPORT
8386 free_color_table ();
8388 image_error ("Imagemagick X bitmap allocation failure", Qnil
, Qnil
);
8389 goto imagemagick_error
;
8392 /* Copy imagemagick image to x with primitive yet robust pixel
8393 pusher loop. This has been tested a lot with many different
8396 /* Copy pixels from the imagemagick image structure to the x image map. */
8397 iterator
= NewPixelIterator (image_wand
);
8400 #ifdef COLOR_TABLE_SUPPORT
8401 free_color_table ();
8403 x_destroy_x_image (ximg
);
8404 image_error ("Imagemagick pixel iterator creation failed",
8406 goto imagemagick_error
;
8409 image_height
= MagickGetImageHeight (image_wand
);
8410 for (y
= 0; y
< image_height
; y
++)
8412 pixels
= PixelGetNextIteratorRow (iterator
, &width
);
8415 for (x
= 0; x
< (long) width
; x
++)
8417 PixelGetMagickColor (pixels
[x
], &pixel
);
8418 XPutPixel (ximg
, x
, y
,
8419 lookup_rgb_color (f
,
8420 color_scale
* pixel
.red
,
8421 color_scale
* pixel
.green
,
8422 color_scale
* pixel
.blue
));
8425 DestroyPixelIterator (iterator
);
8428 #ifdef COLOR_TABLE_SUPPORT
8429 /* Remember colors allocated for this image. */
8430 img
->colors
= colors_in_color_table (&img
->ncolors
);
8431 free_color_table ();
8432 #endif /* COLOR_TABLE_SUPPORT */
8435 img
->height
= height
;
8437 /* Put ximg into the image. */
8438 image_put_x_image (f
, img
, ximg
, 0);
8440 /* Final cleanup. image_wand should be the only resource left. */
8441 DestroyMagickWand (image_wand
);
8442 if (bg_wand
) DestroyPixelWand (bg_wand
);
8444 /* `MagickWandTerminus' terminates the imagemagick environment. */
8445 MagickWandTerminus ();
8450 DestroyMagickWand (image_wand
);
8451 if (bg_wand
) DestroyPixelWand (bg_wand
);
8453 MagickWandTerminus ();
8454 /* TODO more cleanup. */
8455 image_error ("Error parsing IMAGEMAGICK image `%s'", img
->spec
, Qnil
);
8460 /* Load IMAGEMAGICK image IMG for use on frame F. Value is true if
8461 successful. this function will go into the imagemagick_type structure, and
8462 the prototype thus needs to be compatible with that structure. */
8465 imagemagick_load (struct frame
*f
, struct image
*img
)
8468 Lisp_Object file_name
;
8470 /* If IMG->spec specifies a file name, create a non-file spec from it. */
8471 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
8472 if (STRINGP (file_name
))
8476 file
= x_find_image_file (file_name
);
8477 if (!STRINGP (file
))
8479 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
8483 file
= ansi_encode_filename (file
);
8485 success_p
= imagemagick_load_image (f
, img
, 0, 0, SSDATA (file
));
8487 /* Else its not a file, its a lisp object. Load the image from a
8488 lisp object rather than a file. */
8493 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
8494 if (!STRINGP (data
))
8496 image_error ("Invalid image data `%s'", data
, Qnil
);
8499 success_p
= imagemagick_load_image (f
, img
, SDATA (data
),
8500 SBYTES (data
), NULL
);
8506 DEFUN ("imagemagick-types", Fimagemagick_types
, Simagemagick_types
, 0, 0, 0,
8507 doc
: /* Return a list of image types supported by ImageMagick.
8508 Each entry in this list is a symbol named after an ImageMagick format
8509 tag. See the ImageMagick manual for a list of ImageMagick formats and
8510 their descriptions (http://www.imagemagick.org/script/formats.php).
8511 You can also try the shell command: `identify -list format'.
8513 Note that ImageMagick recognizes many file-types that Emacs does not
8514 recognize as images, such as C. See `imagemagick-types-enable'
8515 and `imagemagick-types-inhibit'. */)
8518 Lisp_Object typelist
= Qnil
;
8523 Lisp_Object Qimagemagicktype
;
8525 GetExceptionInfo(&ex
);
8526 imtypes
= GetMagickList ("*", &numf
, &ex
);
8527 DestroyExceptionInfo(&ex
);
8529 for (i
= 0; i
< numf
; i
++)
8531 Qimagemagicktype
= intern (imtypes
[i
]);
8532 typelist
= Fcons (Qimagemagicktype
, typelist
);
8533 imtypes
[i
] = MagickRelinquishMemory (imtypes
[i
]);
8536 MagickRelinquishMemory (imtypes
);
8537 return Fnreverse (typelist
);
8540 #endif /* defined (HAVE_IMAGEMAGICK) */
8544 /***********************************************************************
8546 ***********************************************************************/
8548 #if defined (HAVE_RSVG)
8550 /* Function prototypes. */
8552 static bool svg_image_p (Lisp_Object object
);
8553 static bool svg_load (struct frame
*f
, struct image
*img
);
8555 static bool svg_load_image (struct frame
*, struct image
*,
8556 unsigned char *, ptrdiff_t);
8558 /* The symbol `svg' identifying images of this type. */
8560 static Lisp_Object Qsvg
;
8562 /* Indices of image specification fields in svg_format, below. */
8564 enum svg_keyword_index
8579 /* Vector of image_keyword structures describing the format
8580 of valid user-defined image specifications. */
8582 static const struct image_keyword svg_format
[SVG_LAST
] =
8584 {":type", IMAGE_SYMBOL_VALUE
, 1},
8585 {":data", IMAGE_STRING_VALUE
, 0},
8586 {":file", IMAGE_STRING_VALUE
, 0},
8587 {":ascent", IMAGE_ASCENT_VALUE
, 0},
8588 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
8589 {":relief", IMAGE_INTEGER_VALUE
, 0},
8590 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8591 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8592 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8593 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
8596 #if defined HAVE_NTGUI && defined WINDOWSNT
8597 static bool init_svg_functions (void);
8599 #define init_svg_functions NULL
8602 /* Structure describing the image type `svg'. Its the same type of
8603 structure defined for all image formats, handled by emacs image
8604 functions. See struct image_type in dispextern.h. */
8606 static struct image_type svg_type
=
8617 /* Return true if OBJECT is a valid SVG image specification. Do
8618 this by calling parse_image_spec and supplying the keywords that
8619 identify the SVG format. */
8622 svg_image_p (Lisp_Object object
)
8624 struct image_keyword fmt
[SVG_LAST
];
8625 memcpy (fmt
, svg_format
, sizeof fmt
);
8627 if (!parse_image_spec (object
, fmt
, SVG_LAST
, Qsvg
))
8630 /* Must specify either the :data or :file keyword. */
8631 return fmt
[SVG_FILE
].count
+ fmt
[SVG_DATA
].count
== 1;
8634 #include <librsvg/rsvg.h>
8638 /* SVG library functions. */
8639 DEF_IMGLIB_FN (RsvgHandle
*, rsvg_handle_new
, (void));
8640 DEF_IMGLIB_FN (void, rsvg_handle_get_dimensions
, (RsvgHandle
*, RsvgDimensionData
*));
8641 DEF_IMGLIB_FN (gboolean
, rsvg_handle_write
, (RsvgHandle
*, const guchar
*, gsize
, GError
**));
8642 DEF_IMGLIB_FN (gboolean
, rsvg_handle_close
, (RsvgHandle
*, GError
**));
8643 DEF_IMGLIB_FN (GdkPixbuf
*, rsvg_handle_get_pixbuf
, (RsvgHandle
*));
8645 DEF_IMGLIB_FN (int, gdk_pixbuf_get_width
, (const GdkPixbuf
*));
8646 DEF_IMGLIB_FN (int, gdk_pixbuf_get_height
, (const GdkPixbuf
*));
8647 DEF_IMGLIB_FN (guchar
*, gdk_pixbuf_get_pixels
, (const GdkPixbuf
*));
8648 DEF_IMGLIB_FN (int, gdk_pixbuf_get_rowstride
, (const GdkPixbuf
*));
8649 DEF_IMGLIB_FN (GdkColorspace
, gdk_pixbuf_get_colorspace
, (const GdkPixbuf
*));
8650 DEF_IMGLIB_FN (int, gdk_pixbuf_get_n_channels
, (const GdkPixbuf
*));
8651 DEF_IMGLIB_FN (gboolean
, gdk_pixbuf_get_has_alpha
, (const GdkPixbuf
*));
8652 DEF_IMGLIB_FN (int, gdk_pixbuf_get_bits_per_sample
, (const GdkPixbuf
*));
8654 #if ! GLIB_CHECK_VERSION (2, 36, 0)
8655 DEF_IMGLIB_FN (void, g_type_init
, (void));
8657 DEF_IMGLIB_FN (void, g_object_unref
, (gpointer
));
8658 DEF_IMGLIB_FN (void, g_error_free
, (GError
*));
8660 Lisp_Object Qgdk_pixbuf
, Qglib
, Qgobject
;
8663 init_svg_functions (void)
8665 HMODULE library
, gdklib
= NULL
, glib
= NULL
, gobject
= NULL
;
8667 if (!(glib
= w32_delayed_load (Qglib
))
8668 || !(gobject
= w32_delayed_load (Qgobject
))
8669 || !(gdklib
= w32_delayed_load (Qgdk_pixbuf
))
8670 || !(library
= w32_delayed_load (Qsvg
)))
8672 if (gdklib
) FreeLibrary (gdklib
);
8673 if (gobject
) FreeLibrary (gobject
);
8674 if (glib
) FreeLibrary (glib
);
8678 LOAD_IMGLIB_FN (library
, rsvg_handle_new
);
8679 LOAD_IMGLIB_FN (library
, rsvg_handle_get_dimensions
);
8680 LOAD_IMGLIB_FN (library
, rsvg_handle_write
);
8681 LOAD_IMGLIB_FN (library
, rsvg_handle_close
);
8682 LOAD_IMGLIB_FN (library
, rsvg_handle_get_pixbuf
);
8684 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_width
);
8685 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_height
);
8686 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_pixels
);
8687 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_rowstride
);
8688 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_colorspace
);
8689 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_n_channels
);
8690 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_has_alpha
);
8691 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_bits_per_sample
);
8693 #if ! GLIB_CHECK_VERSION (2, 36, 0)
8694 LOAD_IMGLIB_FN (gobject
, g_type_init
);
8696 LOAD_IMGLIB_FN (gobject
, g_object_unref
);
8697 LOAD_IMGLIB_FN (glib
, g_error_free
);
8703 /* The following aliases for library functions allow dynamic loading
8704 to be used on some platforms. */
8705 #define fn_rsvg_handle_new rsvg_handle_new
8706 #define fn_rsvg_handle_get_dimensions rsvg_handle_get_dimensions
8707 #define fn_rsvg_handle_write rsvg_handle_write
8708 #define fn_rsvg_handle_close rsvg_handle_close
8709 #define fn_rsvg_handle_get_pixbuf rsvg_handle_get_pixbuf
8711 #define fn_gdk_pixbuf_get_width gdk_pixbuf_get_width
8712 #define fn_gdk_pixbuf_get_height gdk_pixbuf_get_height
8713 #define fn_gdk_pixbuf_get_pixels gdk_pixbuf_get_pixels
8714 #define fn_gdk_pixbuf_get_rowstride gdk_pixbuf_get_rowstride
8715 #define fn_gdk_pixbuf_get_colorspace gdk_pixbuf_get_colorspace
8716 #define fn_gdk_pixbuf_get_n_channels gdk_pixbuf_get_n_channels
8717 #define fn_gdk_pixbuf_get_has_alpha gdk_pixbuf_get_has_alpha
8718 #define fn_gdk_pixbuf_get_bits_per_sample gdk_pixbuf_get_bits_per_sample
8720 #if ! GLIB_CHECK_VERSION (2, 36, 0)
8721 #define fn_g_type_init g_type_init
8723 #define fn_g_object_unref g_object_unref
8724 #define fn_g_error_free g_error_free
8725 #endif /* !WINDOWSNT */
8727 /* Load SVG image IMG for use on frame F. Value is true if
8731 svg_load (struct frame
*f
, struct image
*img
)
8734 Lisp_Object file_name
;
8736 /* If IMG->spec specifies a file name, create a non-file spec from it. */
8737 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
8738 if (STRINGP (file_name
))
8741 unsigned char *contents
;
8744 file
= x_find_image_file (file_name
);
8745 if (!STRINGP (file
))
8747 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
8751 /* Read the entire file into memory. */
8752 contents
= slurp_file (SSDATA (file
), &size
);
8753 if (contents
== NULL
)
8755 image_error ("Error loading SVG image `%s'", img
->spec
, Qnil
);
8758 /* If the file was slurped into memory properly, parse it. */
8759 success_p
= svg_load_image (f
, img
, contents
, size
);
8762 /* Else its not a file, its a lisp object. Load the image from a
8763 lisp object rather than a file. */
8768 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
8769 if (!STRINGP (data
))
8771 image_error ("Invalid image data `%s'", data
, Qnil
);
8774 success_p
= svg_load_image (f
, img
, SDATA (data
), SBYTES (data
));
8780 /* svg_load_image is a helper function for svg_load, which does the
8781 actual loading given contents and size, apart from frame and image
8782 structures, passed from svg_load.
8784 Uses librsvg to do most of the image processing.
8786 Returns true when successful. */
8788 svg_load_image (struct frame
*f
, /* Pointer to emacs frame structure. */
8789 struct image
*img
, /* Pointer to emacs image structure. */
8790 unsigned char *contents
, /* String containing the SVG XML data to be parsed. */
8791 ptrdiff_t size
) /* Size of data in bytes. */
8793 RsvgHandle
*rsvg_handle
;
8794 RsvgDimensionData dimension_data
;
8799 const guint8
*pixels
;
8802 Lisp_Object specified_bg
;
8807 #if ! GLIB_CHECK_VERSION (2, 36, 0)
8808 /* g_type_init is a glib function that must be called prior to
8809 using gnome type library functions (obsolete since 2.36.0). */
8813 /* Make a handle to a new rsvg object. */
8814 rsvg_handle
= fn_rsvg_handle_new ();
8816 /* Parse the contents argument and fill in the rsvg_handle. */
8817 fn_rsvg_handle_write (rsvg_handle
, contents
, size
, &err
);
8818 if (err
) goto rsvg_error
;
8820 /* The parsing is complete, rsvg_handle is ready to used, close it
8821 for further writes. */
8822 fn_rsvg_handle_close (rsvg_handle
, &err
);
8823 if (err
) goto rsvg_error
;
8825 fn_rsvg_handle_get_dimensions (rsvg_handle
, &dimension_data
);
8826 if (! check_image_size (f
, dimension_data
.width
, dimension_data
.height
))
8828 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
8832 /* We can now get a valid pixel buffer from the svg file, if all
8834 pixbuf
= fn_rsvg_handle_get_pixbuf (rsvg_handle
);
8835 if (!pixbuf
) goto rsvg_error
;
8836 fn_g_object_unref (rsvg_handle
);
8838 /* Extract some meta data from the svg handle. */
8839 width
= fn_gdk_pixbuf_get_width (pixbuf
);
8840 height
= fn_gdk_pixbuf_get_height (pixbuf
);
8841 pixels
= fn_gdk_pixbuf_get_pixels (pixbuf
);
8842 rowstride
= fn_gdk_pixbuf_get_rowstride (pixbuf
);
8844 /* Validate the svg meta data. */
8845 eassert (fn_gdk_pixbuf_get_colorspace (pixbuf
) == GDK_COLORSPACE_RGB
);
8846 eassert (fn_gdk_pixbuf_get_n_channels (pixbuf
) == 4);
8847 eassert (fn_gdk_pixbuf_get_has_alpha (pixbuf
));
8848 eassert (fn_gdk_pixbuf_get_bits_per_sample (pixbuf
) == 8);
8850 /* Try to create a x pixmap to hold the svg pixmap. */
8851 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, 0, &ximg
, 0))
8853 fn_g_object_unref (pixbuf
);
8857 init_color_table ();
8859 /* Handle alpha channel by combining the image with a background
8861 specified_bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
8862 if (!STRINGP (specified_bg
)
8863 || !x_defined_color (f
, SSDATA (specified_bg
), &background
, 0))
8864 x_query_frame_background_color (f
, &background
);
8866 /* SVG pixmaps specify transparency in the last byte, so right
8867 shift 8 bits to get rid of it, since emacs doesn't support
8869 background
.red
>>= 8;
8870 background
.green
>>= 8;
8871 background
.blue
>>= 8;
8873 /* This loop handles opacity values, since Emacs assumes
8874 non-transparent images. Each pixel must be "flattened" by
8875 calculating the resulting color, given the transparency of the
8876 pixel, and the image background color. */
8877 for (y
= 0; y
< height
; ++y
)
8879 for (x
= 0; x
< width
; ++x
)
8889 opacity
= *pixels
++;
8891 red
= ((red
* opacity
)
8892 + (background
.red
* ((1 << 8) - opacity
)));
8893 green
= ((green
* opacity
)
8894 + (background
.green
* ((1 << 8) - opacity
)));
8895 blue
= ((blue
* opacity
)
8896 + (background
.blue
* ((1 << 8) - opacity
)));
8898 XPutPixel (ximg
, x
, y
, lookup_rgb_color (f
, red
, green
, blue
));
8901 pixels
+= rowstride
- 4 * width
;
8904 #ifdef COLOR_TABLE_SUPPORT
8905 /* Remember colors allocated for this image. */
8906 img
->colors
= colors_in_color_table (&img
->ncolors
);
8907 free_color_table ();
8908 #endif /* COLOR_TABLE_SUPPORT */
8910 fn_g_object_unref (pixbuf
);
8913 img
->height
= height
;
8915 /* Maybe fill in the background field while we have ximg handy.
8916 Casting avoids a GCC warning. */
8917 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
8919 /* Put ximg into the image. */
8920 image_put_x_image (f
, img
, ximg
, 0);
8925 fn_g_object_unref (rsvg_handle
);
8926 /* FIXME: Use error->message so the user knows what is the actual
8927 problem with the image. */
8928 image_error ("Error parsing SVG image `%s'", img
->spec
, Qnil
);
8929 fn_g_error_free (err
);
8933 #endif /* defined (HAVE_RSVG) */
8938 /***********************************************************************
8940 ***********************************************************************/
8942 #ifdef HAVE_X_WINDOWS
8943 #define HAVE_GHOSTSCRIPT 1
8944 #endif /* HAVE_X_WINDOWS */
8946 #ifdef HAVE_GHOSTSCRIPT
8948 static bool gs_image_p (Lisp_Object object
);
8949 static bool gs_load (struct frame
*f
, struct image
*img
);
8950 static void gs_clear_image (struct frame
*f
, struct image
*img
);
8952 /* Keyword symbols. */
8954 static Lisp_Object QCloader
, QCbounding_box
, QCpt_width
, QCpt_height
;
8956 /* Indices of image specification fields in gs_format, below. */
8958 enum gs_keyword_index
8976 /* Vector of image_keyword structures describing the format
8977 of valid user-defined image specifications. */
8979 static const struct image_keyword gs_format
[GS_LAST
] =
8981 {":type", IMAGE_SYMBOL_VALUE
, 1},
8982 {":pt-width", IMAGE_POSITIVE_INTEGER_VALUE
, 1},
8983 {":pt-height", IMAGE_POSITIVE_INTEGER_VALUE
, 1},
8984 {":file", IMAGE_STRING_VALUE
, 1},
8985 {":loader", IMAGE_FUNCTION_VALUE
, 0},
8986 {":bounding-box", IMAGE_DONT_CHECK_VALUE_TYPE
, 1},
8987 {":ascent", IMAGE_ASCENT_VALUE
, 0},
8988 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
8989 {":relief", IMAGE_INTEGER_VALUE
, 0},
8990 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8991 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8992 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8993 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
8996 /* Structure describing the image type `ghostscript'. */
8998 static struct image_type gs_type
=
9009 /* Free X resources of Ghostscript image IMG which is used on frame F. */
9012 gs_clear_image (struct frame
*f
, struct image
*img
)
9014 x_clear_image (f
, img
);
9018 /* Return true if OBJECT is a valid Ghostscript image
9022 gs_image_p (Lisp_Object object
)
9024 struct image_keyword fmt
[GS_LAST
];
9028 memcpy (fmt
, gs_format
, sizeof fmt
);
9030 if (!parse_image_spec (object
, fmt
, GS_LAST
, Qpostscript
))
9033 /* Bounding box must be a list or vector containing 4 integers. */
9034 tem
= fmt
[GS_BOUNDING_BOX
].value
;
9037 for (i
= 0; i
< 4; ++i
, tem
= XCDR (tem
))
9038 if (!CONSP (tem
) || !INTEGERP (XCAR (tem
)))
9043 else if (VECTORP (tem
))
9045 if (ASIZE (tem
) != 4)
9047 for (i
= 0; i
< 4; ++i
)
9048 if (!INTEGERP (AREF (tem
, i
)))
9058 /* Load Ghostscript image IMG for use on frame F. Value is true
9062 gs_load (struct frame
*f
, struct image
*img
)
9064 uprintmax_t printnum1
, printnum2
;
9065 char buffer
[sizeof " " + INT_STRLEN_BOUND (printmax_t
)];
9066 Lisp_Object window_and_pixmap_id
= Qnil
, loader
, pt_height
, pt_width
;
9068 double in_width
, in_height
;
9069 Lisp_Object pixel_colors
= Qnil
;
9071 /* Compute pixel size of pixmap needed from the given size in the
9072 image specification. Sizes in the specification are in pt. 1 pt
9073 = 1/72 in, xdpi and ydpi are stored in the frame's X display
9075 pt_width
= image_spec_value (img
->spec
, QCpt_width
, NULL
);
9076 in_width
= INTEGERP (pt_width
) ? XFASTINT (pt_width
) / 72.0 : 0;
9077 in_width
*= FRAME_RES_X (f
);
9078 pt_height
= image_spec_value (img
->spec
, QCpt_height
, NULL
);
9079 in_height
= INTEGERP (pt_height
) ? XFASTINT (pt_height
) / 72.0 : 0;
9080 in_height
*= FRAME_RES_Y (f
);
9082 if (! (in_width
<= INT_MAX
&& in_height
<= INT_MAX
9083 && check_image_size (f
, in_width
, in_height
)))
9085 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
9088 img
->width
= in_width
;
9089 img
->height
= in_height
;
9091 /* Create the pixmap. */
9092 eassert (img
->pixmap
== NO_PIXMAP
);
9094 if (x_check_image_size (0, img
->width
, img
->height
))
9096 /* Only W32 version did BLOCK_INPUT here. ++kfs */
9098 img
->pixmap
= XCreatePixmap (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
9099 img
->width
, img
->height
,
9100 DefaultDepthOfScreen (FRAME_X_SCREEN (f
)));
9106 image_error ("Unable to create pixmap for `%s'", img
->spec
, Qnil
);
9110 /* Call the loader to fill the pixmap. It returns a process object
9111 if successful. We do not record_unwind_protect here because
9112 other places in redisplay like calling window scroll functions
9113 don't either. Let the Lisp loader use `unwind-protect' instead. */
9114 printnum1
= FRAME_X_WINDOW (f
);
9115 printnum2
= img
->pixmap
;
9116 window_and_pixmap_id
9117 = make_formatted_string (buffer
, "%"pMu
" %"pMu
, printnum1
, printnum2
);
9119 printnum1
= FRAME_FOREGROUND_PIXEL (f
);
9120 printnum2
= FRAME_BACKGROUND_PIXEL (f
);
9122 = make_formatted_string (buffer
, "%"pMu
" %"pMu
, printnum1
, printnum2
);
9124 XSETFRAME (frame
, f
);
9125 loader
= image_spec_value (img
->spec
, QCloader
, NULL
);
9127 loader
= intern ("gs-load-image");
9129 img
->lisp_data
= call6 (loader
, frame
, img
->spec
,
9130 make_number (img
->width
),
9131 make_number (img
->height
),
9132 window_and_pixmap_id
,
9134 return PROCESSP (img
->lisp_data
);
9138 /* Kill the Ghostscript process that was started to fill PIXMAP on
9139 frame F. Called from XTread_socket when receiving an event
9140 telling Emacs that Ghostscript has finished drawing. */
9143 x_kill_gs_process (Pixmap pixmap
, struct frame
*f
)
9145 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
9150 /* Find the image containing PIXMAP. */
9151 for (i
= 0; i
< c
->used
; ++i
)
9152 if (c
->images
[i
]->pixmap
== pixmap
)
9155 /* Should someone in between have cleared the image cache, for
9156 instance, give up. */
9160 /* Kill the GS process. We should have found PIXMAP in the image
9161 cache and its image should contain a process object. */
9163 eassert (PROCESSP (img
->lisp_data
));
9164 Fkill_process (img
->lisp_data
, Qnil
);
9165 img
->lisp_data
= Qnil
;
9167 #if defined (HAVE_X_WINDOWS)
9169 /* On displays with a mutable colormap, figure out the colors
9170 allocated for the image by looking at the pixels of an XImage for
9172 class = FRAME_X_VISUAL (f
)->class;
9173 if (class != StaticColor
&& class != StaticGray
&& class != TrueColor
)
9179 /* Try to get an XImage for img->pixmep. */
9180 ximg
= XGetImage (FRAME_X_DISPLAY (f
), img
->pixmap
,
9181 0, 0, img
->width
, img
->height
, ~0, ZPixmap
);
9186 /* Initialize the color table. */
9187 init_color_table ();
9189 /* For each pixel of the image, look its color up in the
9190 color table. After having done so, the color table will
9191 contain an entry for each color used by the image. */
9192 for (y
= 0; y
< img
->height
; ++y
)
9193 for (x
= 0; x
< img
->width
; ++x
)
9195 unsigned long pixel
= XGetPixel (ximg
, x
, y
);
9196 lookup_pixel_color (f
, pixel
);
9199 /* Record colors in the image. Free color table and XImage. */
9200 #ifdef COLOR_TABLE_SUPPORT
9201 img
->colors
= colors_in_color_table (&img
->ncolors
);
9202 free_color_table ();
9204 XDestroyImage (ximg
);
9206 #if 0 /* This doesn't seem to be the case. If we free the colors
9207 here, we get a BadAccess later in x_clear_image when
9208 freeing the colors. */
9209 /* We have allocated colors once, but Ghostscript has also
9210 allocated colors on behalf of us. So, to get the
9211 reference counts right, free them once. */
9213 x_free_colors (f
, img
->colors
, img
->ncolors
);
9217 image_error ("Cannot get X image of `%s'; colors will not be freed",
9222 #endif /* HAVE_X_WINDOWS */
9224 /* Now that we have the pixmap, compute mask and transform the
9225 image if requested. */
9227 postprocess_image (f
, img
);
9231 #endif /* HAVE_GHOSTSCRIPT */
9234 /***********************************************************************
9236 ***********************************************************************/
9240 DEFUN ("imagep", Fimagep
, Simagep
, 1, 1, 0,
9241 doc
: /* Value is non-nil if SPEC is a valid image specification. */)
9244 return valid_image_p (spec
) ? Qt
: Qnil
;
9248 DEFUN ("lookup-image", Flookup_image
, Slookup_image
, 1, 1, 0, "")
9253 if (valid_image_p (spec
))
9254 id
= lookup_image (SELECTED_FRAME (), spec
);
9257 return make_number (id
);
9260 #endif /* GLYPH_DEBUG */
9263 /***********************************************************************
9265 ***********************************************************************/
9267 DEFUN ("init-image-library", Finit_image_library
, Sinit_image_library
, 1, 1, 0,
9268 doc
: /* Initialize image library implementing image type TYPE.
9269 Return non-nil if TYPE is a supported image type.
9271 If image libraries are loaded dynamically (currently only the case on
9272 MS-Windows), load the library for TYPE if it is not yet loaded, using
9273 the library file(s) specified by `dynamic-library-alist'. */)
9276 return lookup_image_type (type
) ? Qt
: Qnil
;
9279 /* Look up image type TYPE, and return a pointer to its image_type
9280 structure. Return 0 if TYPE is not a known image type. */
9282 static struct image_type
*
9283 lookup_image_type (Lisp_Object type
)
9285 /* Types pbm and xbm are built-in and always available. */
9286 if (EQ (type
, Qpbm
))
9287 return define_image_type (&pbm_type
);
9289 if (EQ (type
, Qxbm
))
9290 return define_image_type (&xbm_type
);
9292 #if defined (HAVE_XPM) || defined (HAVE_NS)
9293 if (EQ (type
, Qxpm
))
9294 return define_image_type (&xpm_type
);
9297 #if defined (HAVE_JPEG) || defined (HAVE_NS)
9298 if (EQ (type
, Qjpeg
))
9299 return define_image_type (&jpeg_type
);
9302 #if defined (HAVE_TIFF) || defined (HAVE_NS)
9303 if (EQ (type
, Qtiff
))
9304 return define_image_type (&tiff_type
);
9307 #if defined (HAVE_GIF) || defined (HAVE_NS)
9308 if (EQ (type
, Qgif
))
9309 return define_image_type (&gif_type
);
9312 #if defined (HAVE_PNG) || defined (HAVE_NS)
9313 if (EQ (type
, Qpng
))
9314 return define_image_type (&png_type
);
9317 #if defined (HAVE_RSVG)
9318 if (EQ (type
, Qsvg
))
9319 return define_image_type (&svg_type
);
9322 #if defined (HAVE_IMAGEMAGICK)
9323 if (EQ (type
, Qimagemagick
))
9324 return define_image_type (&imagemagick_type
);
9327 #ifdef HAVE_GHOSTSCRIPT
9328 if (EQ (type
, Qpostscript
))
9329 return define_image_type (&gs_type
);
9335 /* Reset image_types before dumping.
9336 Called from Fdump_emacs. */
9339 reset_image_types (void)
9343 struct image_type
*next
= image_types
->next
;
9344 xfree (image_types
);
9350 syms_of_image (void)
9352 /* Initialize this only once; it will be reset before dumping. */
9355 /* Must be defined now because we're going to update it below, while
9356 defining the supported image types. */
9357 DEFVAR_LISP ("image-types", Vimage_types
,
9358 doc
: /* List of potentially supported image types.
9359 Each element of the list is a symbol for an image type, like 'jpeg or 'png.
9360 To check whether it is really supported, use `image-type-available-p'. */);
9361 Vimage_types
= Qnil
;
9363 DEFVAR_LISP ("max-image-size", Vmax_image_size
,
9364 doc
: /* Maximum size of images.
9365 Emacs will not load an image into memory if its pixel width or
9366 pixel height exceeds this limit.
9368 If the value is an integer, it directly specifies the maximum
9369 image height and width, measured in pixels. If it is a floating
9370 point number, it specifies the maximum image height and width
9371 as a ratio to the frame height and width. If the value is
9372 non-numeric, there is no explicit limit on the size of images. */);
9373 Vmax_image_size
= make_float (MAX_IMAGE_SIZE
);
9375 DEFSYM (Qcount
, "count");
9376 DEFSYM (Qextension_data
, "extension-data");
9377 DEFSYM (Qdelay
, "delay");
9379 DEFSYM (QCascent
, ":ascent");
9380 DEFSYM (QCmargin
, ":margin");
9381 DEFSYM (QCrelief
, ":relief");
9382 DEFSYM (QCconversion
, ":conversion");
9383 DEFSYM (QCcolor_symbols
, ":color-symbols");
9384 DEFSYM (QCheuristic_mask
, ":heuristic-mask");
9385 DEFSYM (QCindex
, ":index");
9386 DEFSYM (QCgeometry
, ":geometry");
9387 DEFSYM (QCcrop
, ":crop");
9388 DEFSYM (QCrotation
, ":rotation");
9389 DEFSYM (QCmatrix
, ":matrix");
9390 DEFSYM (QCcolor_adjustment
, ":color-adjustment");
9391 DEFSYM (QCmask
, ":mask");
9393 DEFSYM (Qlaplace
, "laplace");
9394 DEFSYM (Qemboss
, "emboss");
9395 DEFSYM (Qedge_detection
, "edge-detection");
9396 DEFSYM (Qheuristic
, "heuristic");
9398 DEFSYM (Qpostscript
, "postscript");
9399 DEFSYM (QCmax_width
, ":max-width");
9400 DEFSYM (QCmax_height
, ":max-height");
9401 #ifdef HAVE_GHOSTSCRIPT
9402 ADD_IMAGE_TYPE (Qpostscript
);
9403 DEFSYM (QCloader
, ":loader");
9404 DEFSYM (QCbounding_box
, ":bounding-box");
9405 DEFSYM (QCpt_width
, ":pt-width");
9406 DEFSYM (QCpt_height
, ":pt-height");
9407 #endif /* HAVE_GHOSTSCRIPT */
9410 DEFSYM (Qlibpng_version
, "libpng-version");
9411 Fset (Qlibpng_version
,
9413 make_number (PNG_LIBPNG_VER
)
9418 DEFSYM (Qlibgif_version
, "libgif-version");
9419 Fset (Qlibgif_version
,
9421 make_number (GIFLIB_MAJOR
* 10000
9422 + GIFLIB_MINOR
* 100
9428 DEFSYM (Qlibjpeg_version
, "libjpeg-version");
9429 Fset (Qlibjpeg_version
,
9431 make_number (JPEG_LIB_VERSION
)
9438 DEFSYM (Qpbm
, "pbm");
9439 ADD_IMAGE_TYPE (Qpbm
);
9441 DEFSYM (Qxbm
, "xbm");
9442 ADD_IMAGE_TYPE (Qxbm
);
9444 #if defined (HAVE_XPM) || defined (HAVE_NS)
9445 DEFSYM (Qxpm
, "xpm");
9446 ADD_IMAGE_TYPE (Qxpm
);
9449 #if defined (HAVE_JPEG) || defined (HAVE_NS)
9450 DEFSYM (Qjpeg
, "jpeg");
9451 ADD_IMAGE_TYPE (Qjpeg
);
9454 #if defined (HAVE_TIFF) || defined (HAVE_NS)
9455 DEFSYM (Qtiff
, "tiff");
9456 ADD_IMAGE_TYPE (Qtiff
);
9459 #if defined (HAVE_GIF) || defined (HAVE_NS)
9460 DEFSYM (Qgif
, "gif");
9461 ADD_IMAGE_TYPE (Qgif
);
9464 #if defined (HAVE_PNG) || defined (HAVE_NS)
9465 DEFSYM (Qpng
, "png");
9466 ADD_IMAGE_TYPE (Qpng
);
9469 #if defined (HAVE_IMAGEMAGICK)
9470 DEFSYM (Qimagemagick
, "imagemagick");
9471 ADD_IMAGE_TYPE (Qimagemagick
);
9474 #if defined (HAVE_RSVG)
9475 DEFSYM (Qsvg
, "svg");
9476 ADD_IMAGE_TYPE (Qsvg
);
9478 /* Other libraries used directly by svg code. */
9479 DEFSYM (Qgdk_pixbuf
, "gdk-pixbuf");
9480 DEFSYM (Qglib
, "glib");
9481 DEFSYM (Qgobject
, "gobject");
9482 #endif /* HAVE_NTGUI */
9483 #endif /* HAVE_RSVG */
9485 defsubr (&Sinit_image_library
);
9486 #ifdef HAVE_IMAGEMAGICK
9487 defsubr (&Simagemagick_types
);
9489 defsubr (&Sclear_image_cache
);
9490 defsubr (&Simage_flush
);
9491 defsubr (&Simage_size
);
9492 defsubr (&Simage_mask_p
);
9493 defsubr (&Simage_metadata
);
9497 defsubr (&Slookup_image
);
9500 DEFVAR_BOOL ("cross-disabled-images", cross_disabled_images
,
9501 doc
: /* Non-nil means always draw a cross over disabled images.
9502 Disabled images are those having a `:conversion disabled' property.
9503 A cross is always drawn on black & white displays. */);
9504 cross_disabled_images
= 0;
9506 DEFVAR_LISP ("x-bitmap-file-path", Vx_bitmap_file_path
,
9507 doc
: /* List of directories to search for window system bitmap files. */);
9508 Vx_bitmap_file_path
= decode_env_path (0, PATH_BITMAPS
, 0);
9510 DEFVAR_LISP ("image-cache-eviction-delay", Vimage_cache_eviction_delay
,
9511 doc
: /* Maximum time after which images are removed from the cache.
9512 When an image has not been displayed this many seconds, Emacs
9513 automatically removes it from the image cache. If the cache contains
9514 a large number of images, the actual eviction time may be shorter.
9515 The value can also be nil, meaning the cache is never cleared.
9517 The function `clear-image-cache' disregards this variable. */);
9518 Vimage_cache_eviction_delay
= make_number (300);
9519 #ifdef HAVE_IMAGEMAGICK
9520 DEFVAR_INT ("imagemagick-render-type", imagemagick_render_type
,
9521 doc
: /* Integer indicating which ImageMagick rendering method to use.
9523 0 -- the default method (pixel pushing)
9524 1 -- a newer method ("MagickExportImagePixels") that may perform
9525 better (speed etc) in some cases, but has not been as thoroughly
9526 tested with Emacs as the default method. This method requires
9527 ImageMagick version 6.4.6 (approximately) or later.
9529 /* MagickExportImagePixels is in 6.4.6-9, but not 6.4.4-10. */
9530 imagemagick_render_type
= 0;