1 /* Functions for image support on window system.
3 Copyright (C) 1989, 1992-2012 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/>. */
26 #if defined HAVE_LIBPNG_PNG_H
27 # include <libpng/png.h>
37 /* This makes the fields of a Display accessible, in Xlib header files. */
39 #define XLIB_ILLEGAL_ACCESS
44 #include "dispextern.h"
45 #include "blockinput.h"
48 #include "character.h"
50 #include "termhooks.h"
55 #include <sys/types.h>
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 RGB_PIXEL_COLOR unsigned long
66 #define PIX_MASK_RETAIN 0
67 #define PIX_MASK_DRAW 1
68 #endif /* HAVE_X_WINDOWS */
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 RGB_PIXEL_COLOR COLORREF
84 #define PIX_MASK_RETAIN 0
85 #define PIX_MASK_DRAW 1
87 #define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
88 #define x_defined_color w32_defined_color
89 #define DefaultDepthOfScreen(screen) (one_w32_display_info.n_cbits)
91 /* Functions from w32term.c that depend on XColor (so can't go in w32term.h
92 without modifying lots of files). */
93 extern void x_query_colors (struct frame
*f
, XColor
*colors
, int ncolors
);
94 extern void x_query_color (struct frame
*f
, XColor
*color
);
96 /* Version of libpng that we were compiled with, or -1 if no PNG
97 support was compiled in. This is tested by w32-win.el to correctly
98 set up the alist used to search for PNG libraries. */
99 Lisp_Object Qlibpng_version
;
100 #endif /* HAVE_NTGUI */
104 #include <sys/types.h>
105 #include <sys/stat.h>
107 #undef COLOR_TABLE_SUPPORT
109 typedef struct ns_bitmap_record Bitmap_Record
;
111 #define GET_PIXEL(ximg, x, y) XGetPixel (ximg, x, y)
114 #define RGB_PIXEL_COLOR unsigned long
117 #define PIX_MASK_RETAIN 0
118 #define PIX_MASK_DRAW 1
120 #define FRAME_X_VISUAL FRAME_NS_DISPLAY_INFO (f)->visual
121 #define x_defined_color(f, name, color_def, alloc) \
122 ns_defined_color (f, name, color_def, alloc, 0)
123 #define FRAME_X_SCREEN(f) 0
124 #define DefaultDepthOfScreen(screen) x_display_list->n_planes
128 /* The symbol `postscript' identifying images of this type. */
130 static Lisp_Object Qpostscript
;
132 static void x_disable_image (struct frame
*, struct image
*);
133 static void x_edge_detection (struct frame
*, struct image
*, Lisp_Object
,
136 static void init_color_table (void);
137 static unsigned long lookup_rgb_color (struct frame
*f
, int r
, int g
, int b
);
138 #ifdef COLOR_TABLE_SUPPORT
139 static void free_color_table (void);
140 static unsigned long *colors_in_color_table (int *n
);
143 /* Code to deal with bitmaps. Bitmaps are referenced by their bitmap
144 id, which is just an int that this section returns. Bitmaps are
145 reference counted so they can be shared among frames.
147 Bitmap indices are guaranteed to be > 0, so a negative number can
148 be used to indicate no bitmap.
150 If you use x_create_bitmap_from_data, then you must keep track of
151 the bitmaps yourself. That is, creating a bitmap from the same
152 data more than once will not be caught. */
156 XGetImage (Display
*display
, Pixmap pixmap
, int x
, int y
,
157 unsigned int width
, unsigned int height
,
158 unsigned long plane_mask
, int format
)
160 /* TODO: not sure what this function is supposed to do.. */
161 ns_retain_object (pixmap
);
165 /* use with imgs created by ns_image_for_XPM */
167 XGetPixel (XImagePtr ximage
, int x
, int y
)
169 return ns_get_pixel (ximage
, x
, y
);
172 /* use with imgs created by ns_image_for_XPM; alpha set to 1;
173 pixel is assumed to be in form RGB */
175 XPutPixel (XImagePtr ximage
, int x
, int y
, unsigned long pixel
)
177 ns_put_pixel (ximage
, x
, y
, pixel
);
182 /* Functions to access the contents of a bitmap, given an id. */
185 x_bitmap_height (FRAME_PTR f
, ptrdiff_t id
)
187 return FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].height
;
191 x_bitmap_width (FRAME_PTR f
, ptrdiff_t id
)
193 return FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].width
;
196 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI)
198 x_bitmap_pixmap (FRAME_PTR f
, ptrdiff_t id
)
200 /* HAVE_NTGUI needs the explicit cast here. */
201 return (int) FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].pixmap
;
205 #ifdef HAVE_X_WINDOWS
207 x_bitmap_mask (FRAME_PTR f
, ptrdiff_t id
)
209 return FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].mask
;
213 /* Allocate a new bitmap record. Returns index of new record. */
216 x_allocate_bitmap_record (FRAME_PTR f
)
218 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
221 if (dpyinfo
->bitmaps_last
< dpyinfo
->bitmaps_size
)
222 return ++dpyinfo
->bitmaps_last
;
224 for (i
= 0; i
< dpyinfo
->bitmaps_size
; ++i
)
225 if (dpyinfo
->bitmaps
[i
].refcount
== 0)
229 xpalloc (dpyinfo
->bitmaps
, &dpyinfo
->bitmaps_size
,
230 10, -1, sizeof *dpyinfo
->bitmaps
);
231 return ++dpyinfo
->bitmaps_last
;
234 /* Add one reference to the reference count of the bitmap with id ID. */
237 x_reference_bitmap (FRAME_PTR f
, ptrdiff_t id
)
239 ++FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].refcount
;
242 /* Create a bitmap for frame F from a HEIGHT x WIDTH array of bits at BITS. */
245 x_create_bitmap_from_data (struct frame
*f
, char *bits
, unsigned int width
, unsigned int height
)
247 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
250 #ifdef HAVE_X_WINDOWS
252 bitmap
= XCreateBitmapFromData (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
253 bits
, width
, height
);
256 #endif /* HAVE_X_WINDOWS */
260 bitmap
= CreateBitmap (width
, height
,
261 FRAME_X_DISPLAY_INFO (XFRAME (frame
))->n_planes
,
262 FRAME_X_DISPLAY_INFO (XFRAME (frame
))->n_cbits
,
266 #endif /* HAVE_NTGUI */
269 void *bitmap
= ns_image_from_XBM (bits
, width
, height
);
274 id
= x_allocate_bitmap_record (f
);
277 dpyinfo
->bitmaps
[id
- 1].img
= bitmap
;
278 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
281 dpyinfo
->bitmaps
[id
- 1].file
= NULL
;
282 dpyinfo
->bitmaps
[id
- 1].height
= height
;
283 dpyinfo
->bitmaps
[id
- 1].width
= width
;
284 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
286 #ifdef HAVE_X_WINDOWS
287 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
288 dpyinfo
->bitmaps
[id
- 1].have_mask
= 0;
289 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
290 #endif /* HAVE_X_WINDOWS */
293 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
294 dpyinfo
->bitmaps
[id
- 1].hinst
= NULL
;
295 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
296 #endif /* HAVE_NTGUI */
301 /* Create bitmap from file FILE for frame F. */
304 x_create_bitmap_from_file (struct frame
*f
, Lisp_Object file
)
306 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
309 return -1; /* W32_TODO : bitmap support */
310 #endif /* HAVE_NTGUI */
314 void *bitmap
= ns_image_from_file (file
);
320 id
= x_allocate_bitmap_record (f
);
321 dpyinfo
->bitmaps
[id
- 1].img
= bitmap
;
322 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
323 dpyinfo
->bitmaps
[id
- 1].file
= xmalloc (SBYTES (file
) + 1);
324 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
325 dpyinfo
->bitmaps
[id
- 1].height
= ns_image_width (bitmap
);
326 dpyinfo
->bitmaps
[id
- 1].width
= ns_image_height (bitmap
);
327 strcpy (dpyinfo
->bitmaps
[id
- 1].file
, SSDATA (file
));
331 #ifdef HAVE_X_WINDOWS
332 unsigned int width
, height
;
334 int xhot
, yhot
, result
;
340 /* Look for an existing bitmap with the same name. */
341 for (id
= 0; id
< dpyinfo
->bitmaps_last
; ++id
)
343 if (dpyinfo
->bitmaps
[id
].refcount
344 && dpyinfo
->bitmaps
[id
].file
345 && !strcmp (dpyinfo
->bitmaps
[id
].file
, SSDATA (file
)))
347 ++dpyinfo
->bitmaps
[id
].refcount
;
352 /* Search bitmap-file-path for the file, if appropriate. */
353 fd
= openp (Vx_bitmap_file_path
, file
, Qnil
, &found
, Qnil
);
358 filename
= SSDATA (found
);
360 result
= XReadBitmapFile (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
361 filename
, &width
, &height
, &bitmap
, &xhot
, &yhot
);
362 if (result
!= BitmapSuccess
)
365 id
= x_allocate_bitmap_record (f
);
366 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
367 dpyinfo
->bitmaps
[id
- 1].have_mask
= 0;
368 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
369 dpyinfo
->bitmaps
[id
- 1].file
= xmalloc (SBYTES (file
) + 1);
370 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
371 dpyinfo
->bitmaps
[id
- 1].height
= height
;
372 dpyinfo
->bitmaps
[id
- 1].width
= width
;
373 strcpy (dpyinfo
->bitmaps
[id
- 1].file
, SSDATA (file
));
376 #endif /* HAVE_X_WINDOWS */
382 free_bitmap_record (Display_Info
*dpyinfo
, Bitmap_Record
*bm
)
384 #ifdef HAVE_X_WINDOWS
385 XFreePixmap (dpyinfo
->display
, bm
->pixmap
);
387 XFreePixmap (dpyinfo
->display
, bm
->mask
);
388 #endif /* HAVE_X_WINDOWS */
391 DeleteObject (bm
->pixmap
);
392 #endif /* HAVE_NTGUI */
395 ns_release_object (bm
->img
);
405 /* Remove reference to bitmap with id number ID. */
408 x_destroy_bitmap (FRAME_PTR f
, ptrdiff_t id
)
410 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
414 Bitmap_Record
*bm
= &dpyinfo
->bitmaps
[id
- 1];
416 if (--bm
->refcount
== 0)
419 free_bitmap_record (dpyinfo
, bm
);
425 /* Free all the bitmaps for the display specified by DPYINFO. */
428 x_destroy_all_bitmaps (Display_Info
*dpyinfo
)
431 Bitmap_Record
*bm
= dpyinfo
->bitmaps
;
433 for (i
= 0; i
< dpyinfo
->bitmaps_last
; i
++, bm
++)
434 if (bm
->refcount
> 0)
435 free_bitmap_record (dpyinfo
, bm
);
437 dpyinfo
->bitmaps_last
= 0;
441 #ifdef HAVE_X_WINDOWS
443 /* Useful functions defined in the section
444 `Image type independent image structures' below. */
446 static unsigned long four_corners_best (XImagePtr ximg
,
449 unsigned long height
);
451 static int x_create_x_image_and_pixmap (struct frame
*f
, int width
, int height
,
452 int depth
, XImagePtr
*ximg
,
455 static void x_destroy_x_image (XImagePtr ximg
);
458 /* Create a mask of a bitmap. Note is this not a perfect mask.
459 It's nicer with some borders in this context */
462 x_create_bitmap_mask (struct frame
*f
, ptrdiff_t id
)
465 XImagePtr ximg
, mask_img
;
466 unsigned long width
, height
;
469 unsigned long x
, y
, xp
, xm
, yp
, ym
;
472 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
477 pixmap
= x_bitmap_pixmap (f
, id
);
478 width
= x_bitmap_width (f
, id
);
479 height
= x_bitmap_height (f
, id
);
482 ximg
= XGetImage (FRAME_X_DISPLAY (f
), pixmap
, 0, 0, width
, height
,
491 result
= x_create_x_image_and_pixmap (f
, width
, height
, 1, &mask_img
, &mask
);
496 XDestroyImage (ximg
);
500 bg
= four_corners_best (ximg
, NULL
, width
, height
);
502 for (y
= 0; y
< ximg
->height
; ++y
)
504 for (x
= 0; x
< ximg
->width
; ++x
)
506 xp
= x
!= ximg
->width
- 1 ? x
+ 1 : 0;
507 xm
= x
!= 0 ? x
- 1 : ximg
->width
- 1;
508 yp
= y
!= ximg
->height
- 1 ? y
+ 1 : 0;
509 ym
= y
!= 0 ? y
- 1 : ximg
->height
- 1;
510 if (XGetPixel (ximg
, x
, y
) == bg
511 && XGetPixel (ximg
, x
, yp
) == bg
512 && XGetPixel (ximg
, x
, ym
) == bg
513 && XGetPixel (ximg
, xp
, y
) == bg
514 && XGetPixel (ximg
, xp
, yp
) == bg
515 && XGetPixel (ximg
, xp
, ym
) == bg
516 && XGetPixel (ximg
, xm
, y
) == bg
517 && XGetPixel (ximg
, xm
, yp
) == bg
518 && XGetPixel (ximg
, xm
, ym
) == bg
)
519 XPutPixel (mask_img
, x
, y
, 0);
521 XPutPixel (mask_img
, x
, y
, 1);
525 eassert (interrupt_input_blocked
);
526 gc
= XCreateGC (FRAME_X_DISPLAY (f
), mask
, 0, NULL
);
527 XPutImage (FRAME_X_DISPLAY (f
), mask
, gc
, mask_img
, 0, 0, 0, 0,
529 XFreeGC (FRAME_X_DISPLAY (f
), gc
);
531 dpyinfo
->bitmaps
[id
- 1].have_mask
= 1;
532 dpyinfo
->bitmaps
[id
- 1].mask
= mask
;
534 XDestroyImage (ximg
);
535 x_destroy_x_image (mask_img
);
540 #endif /* HAVE_X_WINDOWS */
543 /***********************************************************************
545 ***********************************************************************/
547 /* List of supported image types. Use define_image_type to add new
548 types. Use lookup_image_type to find a type for a given symbol. */
550 static struct image_type
*image_types
;
552 /* The symbol `xbm' which is used as the type symbol for XBM images. */
554 static Lisp_Object Qxbm
;
558 Lisp_Object QCascent
, QCmargin
, QCrelief
;
559 Lisp_Object QCconversion
;
560 static Lisp_Object QCheuristic_mask
;
561 static Lisp_Object QCcolor_symbols
;
562 static Lisp_Object QCindex
, QCmatrix
, QCcolor_adjustment
, QCmask
, QCgeometry
;
563 static Lisp_Object QCcrop
, QCrotation
;
567 static Lisp_Object Qcount
, Qextension_data
, Qdelay
;
568 static Lisp_Object Qlaplace
, Qemboss
, Qedge_detection
, Qheuristic
;
570 /* Function prototypes. */
572 static Lisp_Object
define_image_type (struct image_type
*type
, int loaded
);
573 static struct image_type
*lookup_image_type (Lisp_Object symbol
);
574 static void image_error (const char *format
, Lisp_Object
, Lisp_Object
);
575 static void x_laplace (struct frame
*, struct image
*);
576 static void x_emboss (struct frame
*, struct image
*);
577 static int x_build_heuristic_mask (struct frame
*, struct image
*,
580 #define CACHE_IMAGE_TYPE(type, status) \
581 do { Vlibrary_cache = Fcons (Fcons (type, status), Vlibrary_cache); } while (0)
583 #define CACHE_IMAGE_TYPE(type, status)
586 #define ADD_IMAGE_TYPE(type) \
587 do { Vimage_types = Fcons (type, Vimage_types); } while (0)
589 /* Define a new image type from TYPE. This adds a copy of TYPE to
590 image_types and caches the loading status of TYPE. */
593 define_image_type (struct image_type
*type
, int loaded
)
601 /* Make a copy of TYPE to avoid a bus error in a dumped Emacs.
602 The initialized data segment is read-only. */
603 struct image_type
*p
= xmalloc (sizeof *p
);
604 memcpy (p
, type
, sizeof *p
);
605 p
->next
= image_types
;
610 CACHE_IMAGE_TYPE (*type
->type
, success
);
615 /* Look up image type SYMBOL, and return a pointer to its image_type
616 structure. Value is null if SYMBOL is not a known image type. */
618 static inline struct image_type
*
619 lookup_image_type (Lisp_Object symbol
)
621 struct image_type
*type
;
623 /* We must initialize the image-type if it hasn't been already. */
624 if (NILP (Finit_image_library (symbol
, Vdynamic_library_alist
)))
625 return 0; /* unimplemented */
627 for (type
= image_types
; type
; type
= type
->next
)
628 if (EQ (symbol
, *type
->type
))
635 /* Value is non-zero if OBJECT is a valid Lisp image specification. A
636 valid image specification is a list whose car is the symbol
637 `image', and whose rest is a property list. The property list must
638 contain a value for key `:type'. That value must be the name of a
639 supported image type. The rest of the property list depends on the
643 valid_image_p (Lisp_Object object
)
651 for (tem
= XCDR (object
); CONSP (tem
); tem
= XCDR (tem
))
652 if (EQ (XCAR (tem
), QCtype
))
655 if (CONSP (tem
) && SYMBOLP (XCAR (tem
)))
657 struct image_type
*type
;
658 type
= lookup_image_type (XCAR (tem
));
660 valid_p
= type
->valid_p (object
);
671 /* Log error message with format string FORMAT and argument ARG.
672 Signaling an error, e.g. when an image cannot be loaded, is not a
673 good idea because this would interrupt redisplay, and the error
674 message display would lead to another redisplay. This function
675 therefore simply displays a message. */
678 image_error (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
680 add_to_log (format
, arg1
, arg2
);
685 /***********************************************************************
687 ***********************************************************************/
689 enum image_value_type
691 IMAGE_DONT_CHECK_VALUE_TYPE
,
693 IMAGE_STRING_OR_NIL_VALUE
,
695 IMAGE_POSITIVE_INTEGER_VALUE
,
696 IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
,
697 IMAGE_NON_NEGATIVE_INTEGER_VALUE
,
700 IMAGE_FUNCTION_VALUE
,
705 /* Structure used when parsing image specifications. */
709 /* Name of keyword. */
712 /* The type of value allowed. */
713 enum image_value_type type
;
715 /* Non-zero means key must be present. */
718 /* Used to recognize duplicate keywords in a property list. */
721 /* The value that was found. */
726 static int parse_image_spec (Lisp_Object
, struct image_keyword
*,
728 static Lisp_Object
image_spec_value (Lisp_Object
, Lisp_Object
, int *);
731 /* Parse image spec SPEC according to KEYWORDS. A valid image spec
732 has the format (image KEYWORD VALUE ...). One of the keyword/
733 value pairs must be `:type TYPE'. KEYWORDS is a vector of
734 image_keywords structures of size NKEYWORDS describing other
735 allowed keyword/value pairs. Value is non-zero if SPEC is valid. */
738 parse_image_spec (Lisp_Object spec
, struct image_keyword
*keywords
,
739 int nkeywords
, Lisp_Object type
)
748 while (CONSP (plist
))
750 Lisp_Object key
, value
;
752 /* First element of a pair must be a symbol. */
754 plist
= XCDR (plist
);
758 /* There must follow a value. */
761 value
= XCAR (plist
);
762 plist
= XCDR (plist
);
764 /* Find key in KEYWORDS. Error if not found. */
765 for (i
= 0; i
< nkeywords
; ++i
)
766 if (strcmp (keywords
[i
].name
, SSDATA (SYMBOL_NAME (key
))) == 0)
772 /* Record that we recognized the keyword. If a keywords
773 was found more than once, it's an error. */
774 keywords
[i
].value
= value
;
775 if (keywords
[i
].count
> 1)
779 /* Check type of value against allowed type. */
780 switch (keywords
[i
].type
)
782 case IMAGE_STRING_VALUE
:
783 if (!STRINGP (value
))
787 case IMAGE_STRING_OR_NIL_VALUE
:
788 if (!STRINGP (value
) && !NILP (value
))
792 case IMAGE_SYMBOL_VALUE
:
793 if (!SYMBOLP (value
))
797 case IMAGE_POSITIVE_INTEGER_VALUE
:
798 if (! RANGED_INTEGERP (1, value
, INT_MAX
))
802 case IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
:
803 if (RANGED_INTEGERP (0, value
, INT_MAX
))
806 && RANGED_INTEGERP (0, XCAR (value
), INT_MAX
)
807 && RANGED_INTEGERP (0, XCDR (value
), INT_MAX
))
811 case IMAGE_ASCENT_VALUE
:
812 if (SYMBOLP (value
) && EQ (value
, Qcenter
))
814 else if (RANGED_INTEGERP (0, value
, 100))
818 case IMAGE_NON_NEGATIVE_INTEGER_VALUE
:
819 /* Unlike the other integer-related cases, this one does not
820 verify that VALUE fits in 'int'. This is because callers
822 if (!INTEGERP (value
) || XINT (value
) < 0)
826 case IMAGE_DONT_CHECK_VALUE_TYPE
:
829 case IMAGE_FUNCTION_VALUE
:
830 value
= indirect_function (value
);
831 if (!NILP (Ffunctionp (value
)))
835 case IMAGE_NUMBER_VALUE
:
836 if (!INTEGERP (value
) && !FLOATP (value
))
840 case IMAGE_INTEGER_VALUE
:
841 if (! TYPE_RANGED_INTEGERP (int, value
))
845 case IMAGE_BOOL_VALUE
:
846 if (!NILP (value
) && !EQ (value
, Qt
))
855 if (EQ (key
, QCtype
) && !EQ (type
, value
))
859 /* Check that all mandatory fields are present. */
860 for (i
= 0; i
< nkeywords
; ++i
)
861 if (keywords
[i
].mandatory_p
&& keywords
[i
].count
== 0)
868 /* Return the value of KEY in image specification SPEC. Value is nil
869 if KEY is not present in SPEC. if FOUND is not null, set *FOUND
870 to 1 if KEY was found in SPEC, set it to 0 otherwise. */
873 image_spec_value (Lisp_Object spec
, Lisp_Object key
, int *found
)
877 eassert (valid_image_p (spec
));
879 for (tail
= XCDR (spec
);
880 CONSP (tail
) && CONSP (XCDR (tail
));
881 tail
= XCDR (XCDR (tail
)))
883 if (EQ (XCAR (tail
), key
))
887 return XCAR (XCDR (tail
));
897 DEFUN ("image-size", Fimage_size
, Simage_size
, 1, 3, 0,
898 doc
: /* Return the size of image SPEC as pair (WIDTH . HEIGHT).
899 PIXELS non-nil means return the size in pixels, otherwise return the
900 size in canonical character units.
901 FRAME is the frame on which the image will be displayed. FRAME nil
902 or omitted means use the selected frame. */)
903 (Lisp_Object spec
, Lisp_Object pixels
, Lisp_Object frame
)
908 if (valid_image_p (spec
))
910 struct frame
*f
= check_x_frame (frame
);
911 ptrdiff_t id
= lookup_image (f
, spec
);
912 struct image
*img
= IMAGE_FROM_ID (f
, id
);
913 int width
= img
->width
+ 2 * img
->hmargin
;
914 int height
= img
->height
+ 2 * img
->vmargin
;
917 size
= Fcons (make_float ((double) width
/ FRAME_COLUMN_WIDTH (f
)),
918 make_float ((double) height
/ FRAME_LINE_HEIGHT (f
)));
920 size
= Fcons (make_number (width
), make_number (height
));
923 error ("Invalid image specification");
929 DEFUN ("image-mask-p", Fimage_mask_p
, Simage_mask_p
, 1, 2, 0,
930 doc
: /* Return t if image SPEC has a mask bitmap.
931 FRAME is the frame on which the image will be displayed. FRAME nil
932 or omitted means use the selected frame. */)
933 (Lisp_Object spec
, Lisp_Object frame
)
938 if (valid_image_p (spec
))
940 struct frame
*f
= check_x_frame (frame
);
941 ptrdiff_t id
= lookup_image (f
, spec
);
942 struct image
*img
= IMAGE_FROM_ID (f
, id
);
947 error ("Invalid image specification");
952 DEFUN ("image-metadata", Fimage_metadata
, Simage_metadata
, 1, 2, 0,
953 doc
: /* Return metadata for image SPEC.
954 FRAME is the frame on which the image will be displayed. FRAME nil
955 or omitted means use the selected frame. */)
956 (Lisp_Object spec
, Lisp_Object frame
)
961 if (valid_image_p (spec
))
963 struct frame
*f
= check_x_frame (frame
);
964 ptrdiff_t id
= lookup_image (f
, spec
);
965 struct image
*img
= IMAGE_FROM_ID (f
, id
);
966 ext
= img
->lisp_data
;
973 /***********************************************************************
974 Image type independent image structures
975 ***********************************************************************/
977 static void free_image (struct frame
*f
, struct image
*img
);
979 #define MAX_IMAGE_SIZE 10.0
980 /* Allocate and return a new image structure for image specification
981 SPEC. SPEC has a hash value of HASH. */
983 static struct image
*
984 make_image (Lisp_Object spec
, EMACS_UINT hash
)
986 struct image
*img
= xzalloc (sizeof *img
);
987 Lisp_Object file
= image_spec_value (spec
, QCfile
, NULL
);
989 eassert (valid_image_p (spec
));
990 img
->dependencies
= NILP (file
) ? Qnil
: list1 (file
);
991 img
->type
= lookup_image_type (image_spec_value (spec
, QCtype
, NULL
));
992 eassert (img
->type
!= NULL
);
994 img
->lisp_data
= Qnil
;
995 img
->ascent
= DEFAULT_IMAGE_ASCENT
;
997 img
->corners
[BOT_CORNER
] = -1; /* Full image */
1002 /* Free image IMG which was used on frame F, including its resources. */
1005 free_image (struct frame
*f
, struct image
*img
)
1009 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1011 /* Remove IMG from the hash table of its cache. */
1013 img
->prev
->next
= img
->next
;
1015 c
->buckets
[img
->hash
% IMAGE_CACHE_BUCKETS_SIZE
] = img
->next
;
1018 img
->next
->prev
= img
->prev
;
1020 c
->images
[img
->id
] = NULL
;
1022 /* Free resources, then free IMG. */
1023 img
->type
->free (f
, img
);
1028 /* Return 1 if the given widths and heights are valid for display;
1029 otherwise, return 0. */
1032 check_image_size (struct frame
*f
, int width
, int height
)
1036 if (width
<= 0 || height
<= 0)
1039 if (INTEGERP (Vmax_image_size
))
1040 return (width
<= XINT (Vmax_image_size
)
1041 && height
<= XINT (Vmax_image_size
));
1042 else if (FLOATP (Vmax_image_size
))
1046 w
= FRAME_PIXEL_WIDTH (f
);
1047 h
= FRAME_PIXEL_HEIGHT (f
);
1050 w
= h
= 1024; /* Arbitrary size for unknown frame. */
1051 return (width
<= XFLOAT_DATA (Vmax_image_size
) * w
1052 && height
<= XFLOAT_DATA (Vmax_image_size
) * h
);
1058 /* Prepare image IMG for display on frame F. Must be called before
1059 drawing an image. */
1062 prepare_image_for_display (struct frame
*f
, struct image
*img
)
1064 /* We're about to display IMG, so set its timestamp to `now'. */
1065 img
->timestamp
= current_emacs_time ();
1067 /* If IMG doesn't have a pixmap yet, load it now, using the image
1068 type dependent loader function. */
1069 if (img
->pixmap
== NO_PIXMAP
&& !img
->load_failed_p
)
1070 img
->load_failed_p
= img
->type
->load (f
, img
) == 0;
1075 /* Value is the number of pixels for the ascent of image IMG when
1076 drawn in face FACE. */
1079 image_ascent (struct image
*img
, struct face
*face
, struct glyph_slice
*slice
)
1084 if (slice
->height
== img
->height
)
1085 height
= img
->height
+ img
->vmargin
;
1086 else if (slice
->y
== 0)
1087 height
= slice
->height
+ img
->vmargin
;
1089 height
= slice
->height
;
1091 if (img
->ascent
== CENTERED_IMAGE_ASCENT
)
1096 /* W32 specific version. Why?. ++kfs */
1097 ascent
= height
/ 2 - (FONT_DESCENT (face
->font
)
1098 - FONT_BASE (face
->font
)) / 2;
1100 /* This expression is arranged so that if the image can't be
1101 exactly centered, it will be moved slightly up. This is
1102 because a typical font is `top-heavy' (due to the presence
1103 uppercase letters), so the image placement should err towards
1104 being top-heavy too. It also just generally looks better. */
1105 ascent
= (height
+ FONT_BASE (face
->font
)
1106 - FONT_DESCENT (face
->font
) + 1) / 2;
1107 #endif /* HAVE_NTGUI */
1110 ascent
= height
/ 2;
1113 ascent
= height
* (img
->ascent
/ 100.0);
1119 /* Image background colors. */
1121 /* Find the "best" corner color of a bitmap.
1122 On W32, XIMG is assumed to a device context with the bitmap selected. */
1124 static RGB_PIXEL_COLOR
1125 four_corners_best (XImagePtr_or_DC ximg
, int *corners
,
1126 unsigned long width
, unsigned long height
)
1128 RGB_PIXEL_COLOR corner_pixels
[4], best
IF_LINT (= 0);
1131 if (corners
&& corners
[BOT_CORNER
] >= 0)
1133 /* Get the colors at the corner_pixels of ximg. */
1134 corner_pixels
[0] = GET_PIXEL (ximg
, corners
[LEFT_CORNER
], corners
[TOP_CORNER
]);
1135 corner_pixels
[1] = GET_PIXEL (ximg
, corners
[RIGHT_CORNER
] - 1, corners
[TOP_CORNER
]);
1136 corner_pixels
[2] = GET_PIXEL (ximg
, corners
[RIGHT_CORNER
] - 1, corners
[BOT_CORNER
] - 1);
1137 corner_pixels
[3] = GET_PIXEL (ximg
, corners
[LEFT_CORNER
], corners
[BOT_CORNER
] - 1);
1141 /* Get the colors at the corner_pixels of ximg. */
1142 corner_pixels
[0] = GET_PIXEL (ximg
, 0, 0);
1143 corner_pixels
[1] = GET_PIXEL (ximg
, width
- 1, 0);
1144 corner_pixels
[2] = GET_PIXEL (ximg
, width
- 1, height
- 1);
1145 corner_pixels
[3] = GET_PIXEL (ximg
, 0, height
- 1);
1147 /* Choose the most frequently found color as background. */
1148 for (i
= best_count
= 0; i
< 4; ++i
)
1152 for (j
= n
= 0; j
< 4; ++j
)
1153 if (corner_pixels
[i
] == corner_pixels
[j
])
1157 best
= corner_pixels
[i
], best_count
= n
;
1163 /* Portability macros */
1167 #define Destroy_Image(img_dc, prev) \
1168 do { SelectObject (img_dc, prev); DeleteDC (img_dc); } while (0)
1170 #define Free_Pixmap(display, pixmap) \
1171 DeleteObject (pixmap)
1173 #elif defined (HAVE_NS)
1175 #define Destroy_Image(ximg, dummy) \
1176 ns_release_object (ximg)
1178 #define Free_Pixmap(display, pixmap) \
1179 ns_release_object (pixmap)
1183 #define Destroy_Image(ximg, dummy) \
1184 XDestroyImage (ximg)
1186 #define Free_Pixmap(display, pixmap) \
1187 XFreePixmap (display, pixmap)
1189 #endif /* !HAVE_NTGUI && !HAVE_NS */
1192 /* Return the `background' field of IMG. If IMG doesn't have one yet,
1193 it is guessed heuristically. If non-zero, XIMG is an existing
1194 XImage object (or device context with the image selected on W32) to
1195 use for the heuristic. */
1198 image_background (struct image
*img
, struct frame
*f
, XImagePtr_or_DC ximg
)
1200 if (! img
->background_valid
)
1201 /* IMG doesn't have a background yet, try to guess a reasonable value. */
1203 int free_ximg
= !ximg
;
1206 #endif /* HAVE_NTGUI */
1211 ximg
= XGetImage (FRAME_X_DISPLAY (f
), img
->pixmap
,
1212 0, 0, img
->width
, img
->height
, ~0, ZPixmap
);
1214 HDC frame_dc
= get_frame_dc (f
);
1215 ximg
= CreateCompatibleDC (frame_dc
);
1216 release_frame_dc (f
, frame_dc
);
1217 prev
= SelectObject (ximg
, img
->pixmap
);
1218 #endif /* !HAVE_NTGUI */
1221 img
->background
= four_corners_best (ximg
, img
->corners
, img
->width
, img
->height
);
1224 Destroy_Image (ximg
, prev
);
1226 img
->background_valid
= 1;
1229 return img
->background
;
1232 /* Return the `background_transparent' field of IMG. If IMG doesn't
1233 have one yet, it is guessed heuristically. If non-zero, MASK is an
1234 existing XImage object to use for the heuristic. */
1237 image_background_transparent (struct image
*img
, struct frame
*f
, XImagePtr_or_DC mask
)
1239 if (! img
->background_transparent_valid
)
1240 /* IMG doesn't have a background yet, try to guess a reasonable value. */
1244 int free_mask
= !mask
;
1247 #endif /* HAVE_NTGUI */
1252 mask
= XGetImage (FRAME_X_DISPLAY (f
), img
->mask
,
1253 0, 0, img
->width
, img
->height
, ~0, ZPixmap
);
1255 HDC frame_dc
= get_frame_dc (f
);
1256 mask
= CreateCompatibleDC (frame_dc
);
1257 release_frame_dc (f
, frame_dc
);
1258 prev
= SelectObject (mask
, img
->mask
);
1259 #endif /* HAVE_NTGUI */
1262 img
->background_transparent
1263 = (four_corners_best (mask
, img
->corners
, img
->width
, img
->height
) == PIX_MASK_RETAIN
);
1266 Destroy_Image (mask
, prev
);
1269 img
->background_transparent
= 0;
1271 img
->background_transparent_valid
= 1;
1274 return img
->background_transparent
;
1278 /***********************************************************************
1279 Helper functions for X image types
1280 ***********************************************************************/
1282 static void x_clear_image_1 (struct frame
*, struct image
*, int,
1284 static void x_clear_image (struct frame
*f
, struct image
*img
);
1285 static unsigned long x_alloc_image_color (struct frame
*f
,
1287 Lisp_Object color_name
,
1288 unsigned long dflt
);
1291 /* Clear X resources of image IMG on frame F. PIXMAP_P non-zero means
1292 free the pixmap if any. MASK_P non-zero means clear the mask
1293 pixmap if any. COLORS_P non-zero means free colors allocated for
1294 the image, if any. */
1297 x_clear_image_1 (struct frame
*f
, struct image
*img
, int pixmap_p
, int mask_p
,
1300 if (pixmap_p
&& img
->pixmap
)
1302 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->pixmap
);
1303 img
->pixmap
= NO_PIXMAP
;
1304 /* NOTE (HAVE_NS): background color is NOT an indexed color! */
1305 img
->background_valid
= 0;
1308 if (mask_p
&& img
->mask
)
1310 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->mask
);
1311 img
->mask
= NO_PIXMAP
;
1312 img
->background_transparent_valid
= 0;
1315 if (colors_p
&& img
->ncolors
)
1317 /* W32_TODO: color table support. */
1318 #ifdef HAVE_X_WINDOWS
1319 x_free_colors (f
, img
->colors
, img
->ncolors
);
1320 #endif /* HAVE_X_WINDOWS */
1321 xfree (img
->colors
);
1328 /* Free X resources of image IMG which is used on frame F. */
1331 x_clear_image (struct frame
*f
, struct image
*img
)
1334 x_clear_image_1 (f
, img
, 1, 1, 1);
1339 /* Allocate color COLOR_NAME for image IMG on frame F. If color
1340 cannot be allocated, use DFLT. Add a newly allocated color to
1341 IMG->colors, so that it can be freed again. Value is the pixel
1344 static unsigned long
1345 x_alloc_image_color (struct frame
*f
, struct image
*img
, Lisp_Object color_name
,
1349 unsigned long result
;
1351 eassert (STRINGP (color_name
));
1353 if (x_defined_color (f
, SSDATA (color_name
), &color
, 1)
1354 && img
->ncolors
< min (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *img
->colors
,
1357 /* This isn't called frequently so we get away with simply
1358 reallocating the color vector to the needed size, here. */
1359 ptrdiff_t ncolors
= img
->ncolors
+ 1;
1360 img
->colors
= xrealloc (img
->colors
, ncolors
* sizeof *img
->colors
);
1361 img
->colors
[ncolors
- 1] = color
.pixel
;
1362 img
->ncolors
= ncolors
;
1363 result
= color
.pixel
;
1373 /***********************************************************************
1375 ***********************************************************************/
1377 static void cache_image (struct frame
*f
, struct image
*img
);
1378 static void postprocess_image (struct frame
*, struct image
*);
1380 /* Return a new, initialized image cache that is allocated from the
1381 heap. Call free_image_cache to free an image cache. */
1383 struct image_cache
*
1384 make_image_cache (void)
1386 struct image_cache
*c
= xzalloc (sizeof *c
);
1390 c
->images
= xmalloc (size
* sizeof *c
->images
);
1392 size
= IMAGE_CACHE_BUCKETS_SIZE
* sizeof *c
->buckets
;
1393 c
->buckets
= xzalloc (size
);
1398 /* Find an image matching SPEC in the cache, and return it. If no
1399 image is found, return NULL. */
1400 static struct image
*
1401 search_image_cache (struct frame
*f
, Lisp_Object spec
, EMACS_UINT hash
)
1404 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1405 int i
= hash
% IMAGE_CACHE_BUCKETS_SIZE
;
1407 if (!c
) return NULL
;
1409 /* If the image spec does not specify a background color, the cached
1410 image must have the same background color as the current frame.
1411 The foreground color must also match, for the sake of monochrome
1414 In fact, we could ignore the foreground color matching condition
1415 for color images, or if the image spec specifies :foreground;
1416 similarly we could ignore the background color matching condition
1417 for formats that don't use transparency (such as jpeg), or if the
1418 image spec specifies :background. However, the extra memory
1419 usage is probably negligible in practice, so we don't bother. */
1421 for (img
= c
->buckets
[i
]; img
; img
= img
->next
)
1422 if (img
->hash
== hash
1423 && !NILP (Fequal (img
->spec
, spec
))
1424 && img
->frame_foreground
== FRAME_FOREGROUND_PIXEL (f
)
1425 && img
->frame_background
== FRAME_BACKGROUND_PIXEL (f
))
1431 /* Search frame F for an image with spec SPEC, and free it. */
1434 uncache_image (struct frame
*f
, Lisp_Object spec
)
1436 struct image
*img
= search_image_cache (f
, spec
, sxhash (spec
, 0));
1439 free_image (f
, img
);
1440 /* As display glyphs may still be referring to the image ID, we
1441 must garbage the frame (Bug#6426). */
1442 SET_FRAME_GARBAGED (f
);
1447 /* Free image cache of frame F. Be aware that X frames share images
1451 free_image_cache (struct frame
*f
)
1453 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1458 /* Cache should not be referenced by any frame when freed. */
1459 eassert (c
->refcount
== 0);
1461 for (i
= 0; i
< c
->used
; ++i
)
1462 free_image (f
, c
->images
[i
]);
1466 FRAME_IMAGE_CACHE (f
) = NULL
;
1471 /* Clear image cache of frame F. FILTER=t means free all images.
1472 FILTER=nil means clear only images that haven't been
1473 displayed for some time.
1474 Else, only free the images which have FILTER in their `dependencies'.
1475 Should be called from time to time to reduce the number of loaded images.
1476 If image-cache-eviction-delay is non-nil, this frees images in the cache
1477 which weren't displayed for at least that many seconds. */
1480 clear_image_cache (struct frame
*f
, Lisp_Object filter
)
1482 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1486 ptrdiff_t i
, nfreed
= 0;
1488 /* Block input so that we won't be interrupted by a SIGIO
1489 while being in an inconsistent state. */
1494 /* Filter image cache. */
1495 for (i
= 0; i
< c
->used
; ++i
)
1497 struct image
*img
= c
->images
[i
];
1498 if (img
&& (EQ (Qt
, filter
)
1499 || !NILP (Fmember (filter
, img
->dependencies
))))
1501 free_image (f
, img
);
1506 else if (INTEGERP (Vimage_cache_eviction_delay
))
1508 /* Free cache based on timestamp. */
1511 ptrdiff_t nimages
= 0;
1513 for (i
= 0; i
< c
->used
; ++i
)
1517 /* If the number of cached images has grown unusually large,
1518 decrease the cache eviction delay (Bug#6230). */
1519 delay
= XINT (Vimage_cache_eviction_delay
);
1521 delay
= 1600 * delay
/ nimages
/ nimages
;
1522 delay
= max (delay
, 1);
1524 t
= current_emacs_time ();
1525 old
= sub_emacs_time (t
, EMACS_TIME_FROM_DOUBLE (delay
));
1527 for (i
= 0; i
< c
->used
; ++i
)
1529 struct image
*img
= c
->images
[i
];
1530 if (img
&& EMACS_TIME_LT (img
->timestamp
, old
))
1532 free_image (f
, img
);
1538 /* We may be clearing the image cache because, for example,
1539 Emacs was iconified for a longer period of time. In that
1540 case, current matrices may still contain references to
1541 images freed above. So, clear these matrices. */
1544 Lisp_Object tail
, frame
;
1546 FOR_EACH_FRAME (tail
, frame
)
1548 struct frame
*fr
= XFRAME (frame
);
1549 if (FRAME_IMAGE_CACHE (fr
) == c
)
1550 clear_current_matrices (fr
);
1553 ++windows_or_buffers_changed
;
1561 clear_image_caches (Lisp_Object filter
)
1563 /* FIXME: We want to do
1564 * struct terminal *t;
1565 * for (t = terminal_list; t; t = t->next_terminal)
1566 * clear_image_cache (t, filter); */
1567 Lisp_Object tail
, frame
;
1568 FOR_EACH_FRAME (tail
, frame
)
1569 if (FRAME_WINDOW_P (XFRAME (frame
)))
1570 clear_image_cache (XFRAME (frame
), filter
);
1573 DEFUN ("clear-image-cache", Fclear_image_cache
, Sclear_image_cache
,
1575 doc
: /* Clear the image cache.
1576 FILTER nil or a frame means clear all images in the selected frame.
1577 FILTER t means clear the image caches of all frames.
1578 Anything else, means only clear those images which refer to FILTER,
1579 which is then usually a filename. */)
1580 (Lisp_Object filter
)
1582 if (!(EQ (filter
, Qnil
) || FRAMEP (filter
)))
1583 clear_image_caches (filter
);
1585 clear_image_cache (check_x_frame (filter
), Qt
);
1591 DEFUN ("image-flush", Fimage_flush
, Simage_flush
,
1593 doc
: /* Fush the image with specification SPEC on frame FRAME.
1594 This removes the image from the Emacs image cache. If SPEC specifies
1595 an image file, the next redisplay of this image will read from the
1596 current contents of that file.
1598 FRAME nil or omitted means use the selected frame.
1599 FRAME t means refresh the image on all frames. */)
1600 (Lisp_Object spec
, Lisp_Object frame
)
1602 if (!valid_image_p (spec
))
1603 error ("Invalid image specification");
1608 FOR_EACH_FRAME (tail
, frame
)
1610 struct frame
*f
= XFRAME (frame
);
1611 if (FRAME_WINDOW_P (f
))
1612 uncache_image (f
, spec
);
1616 uncache_image (check_x_frame (frame
), spec
);
1622 /* Compute masks and transform image IMG on frame F, as specified
1623 by the image's specification, */
1626 postprocess_image (struct frame
*f
, struct image
*img
)
1628 /* Manipulation of the image's mask. */
1631 Lisp_Object conversion
, spec
;
1636 /* `:heuristic-mask t'
1638 means build a mask heuristically.
1639 `:heuristic-mask (R G B)'
1640 `:mask (heuristic (R G B))'
1641 means build a mask from color (R G B) in the
1644 means remove a mask, if any. */
1646 mask
= image_spec_value (spec
, QCheuristic_mask
, NULL
);
1648 x_build_heuristic_mask (f
, img
, mask
);
1653 mask
= image_spec_value (spec
, QCmask
, &found_p
);
1655 if (EQ (mask
, Qheuristic
))
1656 x_build_heuristic_mask (f
, img
, Qt
);
1657 else if (CONSP (mask
)
1658 && EQ (XCAR (mask
), Qheuristic
))
1660 if (CONSP (XCDR (mask
)))
1661 x_build_heuristic_mask (f
, img
, XCAR (XCDR (mask
)));
1663 x_build_heuristic_mask (f
, img
, XCDR (mask
));
1665 else if (NILP (mask
) && found_p
&& img
->mask
)
1667 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->mask
);
1668 img
->mask
= NO_PIXMAP
;
1673 /* Should we apply an image transformation algorithm? */
1674 conversion
= image_spec_value (spec
, QCconversion
, NULL
);
1675 if (EQ (conversion
, Qdisabled
))
1676 x_disable_image (f
, img
);
1677 else if (EQ (conversion
, Qlaplace
))
1679 else if (EQ (conversion
, Qemboss
))
1681 else if (CONSP (conversion
)
1682 && EQ (XCAR (conversion
), Qedge_detection
))
1685 tem
= XCDR (conversion
);
1687 x_edge_detection (f
, img
,
1688 Fplist_get (tem
, QCmatrix
),
1689 Fplist_get (tem
, QCcolor_adjustment
));
1695 /* Return the id of image with Lisp specification SPEC on frame F.
1696 SPEC must be a valid Lisp image specification (see valid_image_p). */
1699 lookup_image (struct frame
*f
, Lisp_Object spec
)
1704 /* F must be a window-system frame, and SPEC must be a valid image
1706 eassert (FRAME_WINDOW_P (f
));
1707 eassert (valid_image_p (spec
));
1709 /* Look up SPEC in the hash table of the image cache. */
1710 hash
= sxhash (spec
, 0);
1711 img
= search_image_cache (f
, spec
, hash
);
1712 if (img
&& img
->load_failed_p
)
1714 free_image (f
, img
);
1718 /* If not found, create a new image and cache it. */
1722 img
= make_image (spec
, hash
);
1723 cache_image (f
, img
);
1724 img
->load_failed_p
= img
->type
->load (f
, img
) == 0;
1725 img
->frame_foreground
= FRAME_FOREGROUND_PIXEL (f
);
1726 img
->frame_background
= FRAME_BACKGROUND_PIXEL (f
);
1728 /* If we can't load the image, and we don't have a width and
1729 height, use some arbitrary width and height so that we can
1730 draw a rectangle for it. */
1731 if (img
->load_failed_p
)
1735 value
= image_spec_value (spec
, QCwidth
, NULL
);
1736 img
->width
= (INTEGERP (value
)
1737 ? XFASTINT (value
) : DEFAULT_IMAGE_WIDTH
);
1738 value
= image_spec_value (spec
, QCheight
, NULL
);
1739 img
->height
= (INTEGERP (value
)
1740 ? XFASTINT (value
) : DEFAULT_IMAGE_HEIGHT
);
1744 /* Handle image type independent image attributes
1745 `:ascent ASCENT', `:margin MARGIN', `:relief RELIEF',
1746 `:background COLOR'. */
1747 Lisp_Object ascent
, margin
, relief
, bg
;
1750 ascent
= image_spec_value (spec
, QCascent
, NULL
);
1751 if (INTEGERP (ascent
))
1752 img
->ascent
= XFASTINT (ascent
);
1753 else if (EQ (ascent
, Qcenter
))
1754 img
->ascent
= CENTERED_IMAGE_ASCENT
;
1756 margin
= image_spec_value (spec
, QCmargin
, NULL
);
1757 if (INTEGERP (margin
))
1758 img
->vmargin
= img
->hmargin
= XFASTINT (margin
);
1759 else if (CONSP (margin
))
1761 img
->hmargin
= XFASTINT (XCAR (margin
));
1762 img
->vmargin
= XFASTINT (XCDR (margin
));
1765 relief
= image_spec_value (spec
, QCrelief
, NULL
);
1766 relief_bound
= INT_MAX
- max (img
->hmargin
, img
->vmargin
);
1767 if (RANGED_INTEGERP (- relief_bound
, relief
, relief_bound
))
1769 img
->relief
= XINT (relief
);
1770 img
->hmargin
+= eabs (img
->relief
);
1771 img
->vmargin
+= eabs (img
->relief
);
1774 if (! img
->background_valid
)
1776 bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
1780 = x_alloc_image_color (f
, img
, bg
,
1781 FRAME_BACKGROUND_PIXEL (f
));
1782 img
->background_valid
= 1;
1786 /* Do image transformations and compute masks, unless we
1787 don't have the image yet. */
1788 if (!EQ (*img
->type
->type
, Qpostscript
))
1789 postprocess_image (f
, img
);
1795 /* We're using IMG, so set its timestamp to `now'. */
1796 img
->timestamp
= current_emacs_time ();
1798 /* Value is the image id. */
1803 /* Cache image IMG in the image cache of frame F. */
1806 cache_image (struct frame
*f
, struct image
*img
)
1808 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1811 /* Find a free slot in c->images. */
1812 for (i
= 0; i
< c
->used
; ++i
)
1813 if (c
->images
[i
] == NULL
)
1816 /* If no free slot found, maybe enlarge c->images. */
1817 if (i
== c
->used
&& c
->used
== c
->size
)
1818 c
->images
= xpalloc (c
->images
, &c
->size
, 1, -1, sizeof *c
->images
);
1820 /* Add IMG to c->images, and assign IMG an id. */
1826 /* Add IMG to the cache's hash table. */
1827 i
= img
->hash
% IMAGE_CACHE_BUCKETS_SIZE
;
1828 img
->next
= c
->buckets
[i
];
1830 img
->next
->prev
= img
;
1832 c
->buckets
[i
] = img
;
1836 /* Call FN on every image in the image cache of frame F. Used to mark
1837 Lisp Objects in the image cache. */
1839 /* Mark Lisp objects in image IMG. */
1842 mark_image (struct image
*img
)
1844 mark_object (img
->spec
);
1845 mark_object (img
->dependencies
);
1847 if (!NILP (img
->lisp_data
))
1848 mark_object (img
->lisp_data
);
1853 mark_image_cache (struct image_cache
*c
)
1858 for (i
= 0; i
< c
->used
; ++i
)
1860 mark_image (c
->images
[i
]);
1866 /***********************************************************************
1867 X / NS / W32 support code
1868 ***********************************************************************/
1872 /* Macro for defining functions that will be loaded from image DLLs. */
1873 #define DEF_IMGLIB_FN(rettype,func,args) static rettype (FAR CDECL *fn_##func)args
1875 /* Macro for loading those image functions from the library. */
1876 #define LOAD_IMGLIB_FN(lib,func) { \
1877 fn_##func = (void *) GetProcAddress (lib, #func); \
1878 if (!fn_##func) return 0; \
1881 #endif /* HAVE_NTGUI */
1883 static int x_create_x_image_and_pixmap (struct frame
*, int, int, int,
1884 XImagePtr
*, Pixmap
*);
1885 static void x_destroy_x_image (XImagePtr
);
1886 static void x_put_x_image (struct frame
*, XImagePtr
, Pixmap
, int, int);
1888 /* Return nonzero if XIMG's size WIDTH x HEIGHT doesn't break the
1890 WIDTH and HEIGHT must both be positive.
1891 If XIMG is null, assume it is a bitmap. */
1893 x_check_image_size (XImagePtr ximg
, int width
, int height
)
1895 #ifdef HAVE_X_WINDOWS
1896 /* Respect Xlib's limits: it cannot deal with images that have more
1897 than INT_MAX (and/or UINT_MAX) bytes. And respect Emacs's limits
1898 of PTRDIFF_MAX (and/or SIZE_MAX) bytes for any object. */
1901 XLIB_BYTES_MAX
= min (INT_MAX
, UINT_MAX
),
1902 X_IMAGE_BYTES_MAX
= min (XLIB_BYTES_MAX
, min (PTRDIFF_MAX
, SIZE_MAX
))
1905 int bitmap_pad
, depth
, bytes_per_line
;
1908 bitmap_pad
= ximg
->bitmap_pad
;
1909 depth
= ximg
->depth
;
1910 bytes_per_line
= ximg
->bytes_per_line
;
1916 bytes_per_line
= (width
>> 3) + ((width
& 7) != 0);
1918 return (width
<= (INT_MAX
- (bitmap_pad
- 1)) / depth
1919 && height
<= X_IMAGE_BYTES_MAX
/ bytes_per_line
);
1921 /* FIXME: Implement this check for the HAVE_NS and HAVE_NTGUI cases.
1922 For now, assume that every image size is allowed on these systems. */
1927 /* Create an XImage and a pixmap of size WIDTH x HEIGHT for use on
1928 frame F. Set *XIMG and *PIXMAP to the XImage and Pixmap created.
1929 Set (*XIMG)->data to a raster of WIDTH x HEIGHT pixels allocated
1930 via xmalloc. Print error messages via image_error if an error
1931 occurs. Value is non-zero if successful.
1933 On W32, a DEPTH of zero signifies a 24 bit image, otherwise DEPTH
1934 should indicate the bit depth of the image. */
1937 x_create_x_image_and_pixmap (struct frame
*f
, int width
, int height
, int depth
,
1938 XImagePtr
*ximg
, Pixmap
*pixmap
)
1940 #ifdef HAVE_X_WINDOWS
1941 Display
*display
= FRAME_X_DISPLAY (f
);
1942 Window window
= FRAME_X_WINDOW (f
);
1943 Screen
*screen
= FRAME_X_SCREEN (f
);
1945 eassert (interrupt_input_blocked
);
1948 depth
= DefaultDepthOfScreen (screen
);
1949 *ximg
= XCreateImage (display
, DefaultVisualOfScreen (screen
),
1950 depth
, ZPixmap
, 0, NULL
, width
, height
,
1951 depth
> 16 ? 32 : depth
> 8 ? 16 : 8, 0);
1954 image_error ("Unable to allocate X image", Qnil
, Qnil
);
1958 if (! x_check_image_size (*ximg
, width
, height
))
1960 x_destroy_x_image (*ximg
);
1962 image_error ("Image too large (%dx%d)",
1963 make_number (width
), make_number (height
));
1967 /* Allocate image raster. */
1968 (*ximg
)->data
= xmalloc ((*ximg
)->bytes_per_line
* height
);
1970 /* Allocate a pixmap of the same size. */
1971 *pixmap
= XCreatePixmap (display
, window
, width
, height
, depth
);
1972 if (*pixmap
== NO_PIXMAP
)
1974 x_destroy_x_image (*ximg
);
1976 image_error ("Unable to create X pixmap", Qnil
, Qnil
);
1981 #endif /* HAVE_X_WINDOWS */
1985 BITMAPINFOHEADER
*header
;
1987 int scanline_width_bits
;
1989 int palette_colors
= 0;
1994 if (depth
!= 1 && depth
!= 4 && depth
!= 8
1995 && depth
!= 16 && depth
!= 24 && depth
!= 32)
1997 image_error ("Invalid image bit depth specified", Qnil
, Qnil
);
2001 scanline_width_bits
= width
* depth
;
2002 remainder
= scanline_width_bits
% 32;
2005 scanline_width_bits
+= 32 - remainder
;
2007 /* Bitmaps with a depth less than 16 need a palette. */
2008 /* BITMAPINFO structure already contains the first RGBQUAD. */
2010 palette_colors
= 1 << (depth
- 1);
2012 *ximg
= xmalloc (sizeof (XImage
) + palette_colors
* sizeof (RGBQUAD
));
2014 header
= &(*ximg
)->info
.bmiHeader
;
2015 memset (&(*ximg
)->info
, 0, sizeof (BITMAPINFO
));
2016 header
->biSize
= sizeof (*header
);
2017 header
->biWidth
= width
;
2018 header
->biHeight
= -height
; /* negative indicates a top-down bitmap. */
2019 header
->biPlanes
= 1;
2020 header
->biBitCount
= depth
;
2021 header
->biCompression
= BI_RGB
;
2022 header
->biClrUsed
= palette_colors
;
2024 /* TODO: fill in palette. */
2027 (*ximg
)->info
.bmiColors
[0].rgbBlue
= 0;
2028 (*ximg
)->info
.bmiColors
[0].rgbGreen
= 0;
2029 (*ximg
)->info
.bmiColors
[0].rgbRed
= 0;
2030 (*ximg
)->info
.bmiColors
[0].rgbReserved
= 0;
2031 (*ximg
)->info
.bmiColors
[1].rgbBlue
= 255;
2032 (*ximg
)->info
.bmiColors
[1].rgbGreen
= 255;
2033 (*ximg
)->info
.bmiColors
[1].rgbRed
= 255;
2034 (*ximg
)->info
.bmiColors
[1].rgbReserved
= 0;
2037 hdc
= get_frame_dc (f
);
2039 /* Create a DIBSection and raster array for the bitmap,
2040 and store its handle in *pixmap. */
2041 *pixmap
= CreateDIBSection (hdc
, &((*ximg
)->info
),
2042 (depth
< 16) ? DIB_PAL_COLORS
: DIB_RGB_COLORS
,
2043 /* casting avoids a GCC warning */
2044 (void **)&((*ximg
)->data
), NULL
, 0);
2046 /* Realize display palette and garbage all frames. */
2047 release_frame_dc (f
, hdc
);
2049 if (*pixmap
== NULL
)
2051 DWORD err
= GetLastError ();
2052 Lisp_Object errcode
;
2053 /* All system errors are < 10000, so the following is safe. */
2054 XSETINT (errcode
, err
);
2055 image_error ("Unable to create bitmap, error code %d", errcode
, Qnil
);
2056 x_destroy_x_image (*ximg
);
2062 #endif /* HAVE_NTGUI */
2065 *pixmap
= ns_image_for_XPM (width
, height
, depth
);
2069 image_error ("Unable to allocate NSImage for XPM pixmap", Qnil
, Qnil
);
2078 /* Destroy XImage XIMG. Free XIMG->data. */
2081 x_destroy_x_image (XImagePtr ximg
)
2083 eassert (interrupt_input_blocked
);
2086 #ifdef HAVE_X_WINDOWS
2089 XDestroyImage (ximg
);
2090 #endif /* HAVE_X_WINDOWS */
2092 /* Data will be freed by DestroyObject. */
2095 #endif /* HAVE_NTGUI */
2097 ns_release_object (ximg
);
2098 #endif /* HAVE_NS */
2103 /* Put XImage XIMG into pixmap PIXMAP on frame F. WIDTH and HEIGHT
2104 are width and height of both the image and pixmap. */
2107 x_put_x_image (struct frame
*f
, XImagePtr ximg
, Pixmap pixmap
, int width
, int height
)
2109 #ifdef HAVE_X_WINDOWS
2112 eassert (interrupt_input_blocked
);
2113 gc
= XCreateGC (FRAME_X_DISPLAY (f
), pixmap
, 0, NULL
);
2114 XPutImage (FRAME_X_DISPLAY (f
), pixmap
, gc
, ximg
, 0, 0, 0, 0, width
, height
);
2115 XFreeGC (FRAME_X_DISPLAY (f
), gc
);
2116 #endif /* HAVE_X_WINDOWS */
2119 #if 0 /* I don't think this is necessary looking at where it is used. */
2120 HDC hdc
= get_frame_dc (f
);
2121 SetDIBits (hdc
, pixmap
, 0, height
, ximg
->data
, &(ximg
->info
), DIB_RGB_COLORS
);
2122 release_frame_dc (f
, hdc
);
2124 #endif /* HAVE_NTGUI */
2127 eassert (ximg
== pixmap
);
2128 ns_retain_object (ximg
);
2133 /***********************************************************************
2135 ***********************************************************************/
2137 /* Find image file FILE. Look in data-directory/images, then
2138 x-bitmap-file-path. Value is the encoded full name of the file
2139 found, or nil if not found. */
2142 x_find_image_file (Lisp_Object file
)
2144 Lisp_Object file_found
, search_path
;
2147 /* TODO I think this should use something like image-load-path
2148 instead. Unfortunately, that can contain non-string elements. */
2149 search_path
= Fcons (Fexpand_file_name (build_string ("images"),
2151 Vx_bitmap_file_path
);
2153 /* Try to find FILE in data-directory/images, then x-bitmap-file-path. */
2154 fd
= openp (search_path
, file
, Qnil
, &file_found
, Qnil
);
2160 file_found
= ENCODE_FILE (file_found
);
2168 /* Read FILE into memory. Value is a pointer to a buffer allocated
2169 with xmalloc holding FILE's contents. Value is null if an error
2170 occurred. *SIZE is set to the size of the file. */
2172 static unsigned char *
2173 slurp_file (char *file
, ptrdiff_t *size
)
2176 unsigned char *buf
= NULL
;
2179 if (stat (file
, &st
) == 0
2180 && (fp
= fopen (file
, "rb")) != NULL
2181 && 0 <= st
.st_size
&& st
.st_size
<= min (PTRDIFF_MAX
, SIZE_MAX
)
2182 && (buf
= xmalloc (st
.st_size
),
2183 fread (buf
, 1, st
.st_size
, fp
) == st
.st_size
))
2204 /***********************************************************************
2206 ***********************************************************************/
2208 static int xbm_scan (unsigned char **, unsigned char *, char *, int *);
2209 static int xbm_load (struct frame
*f
, struct image
*img
);
2210 static int xbm_load_image (struct frame
*f
, struct image
*img
,
2211 unsigned char *, unsigned char *);
2212 static int xbm_image_p (Lisp_Object object
);
2213 static int xbm_read_bitmap_data (struct frame
*f
,
2214 unsigned char *, unsigned char *,
2215 int *, int *, char **, int);
2216 static int xbm_file_p (Lisp_Object
);
2219 /* Indices of image specification fields in xbm_format, below. */
2221 enum xbm_keyword_index
2239 /* Vector of image_keyword structures describing the format
2240 of valid XBM image specifications. */
2242 static const struct image_keyword xbm_format
[XBM_LAST
] =
2244 {":type", IMAGE_SYMBOL_VALUE
, 1},
2245 {":file", IMAGE_STRING_VALUE
, 0},
2246 {":width", IMAGE_POSITIVE_INTEGER_VALUE
, 0},
2247 {":height", IMAGE_POSITIVE_INTEGER_VALUE
, 0},
2248 {":data", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
2249 {":foreground", IMAGE_STRING_OR_NIL_VALUE
, 0},
2250 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0},
2251 {":ascent", IMAGE_ASCENT_VALUE
, 0},
2252 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
2253 {":relief", IMAGE_INTEGER_VALUE
, 0},
2254 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
2255 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
2256 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0}
2259 /* Structure describing the image type XBM. */
2261 static struct image_type xbm_type
=
2270 /* Tokens returned from xbm_scan. */
2279 /* Return non-zero if OBJECT is a valid XBM-type image specification.
2280 A valid specification is a list starting with the symbol `image'
2281 The rest of the list is a property list which must contain an
2284 If the specification specifies a file to load, it must contain
2285 an entry `:file FILENAME' where FILENAME is a string.
2287 If the specification is for a bitmap loaded from memory it must
2288 contain `:width WIDTH', `:height HEIGHT', and `:data DATA', where
2289 WIDTH and HEIGHT are integers > 0. DATA may be:
2291 1. a string large enough to hold the bitmap data, i.e. it must
2292 have a size >= (WIDTH + 7) / 8 * HEIGHT
2294 2. a bool-vector of size >= WIDTH * HEIGHT
2296 3. a vector of strings or bool-vectors, one for each line of the
2299 4. a string containing an in-memory XBM file. WIDTH and HEIGHT
2300 may not be specified in this case because they are defined in the
2303 Both the file and data forms may contain the additional entries
2304 `:background COLOR' and `:foreground COLOR'. If not present,
2305 foreground and background of the frame on which the image is
2306 displayed is used. */
2309 xbm_image_p (Lisp_Object object
)
2311 struct image_keyword kw
[XBM_LAST
];
2313 memcpy (kw
, xbm_format
, sizeof kw
);
2314 if (!parse_image_spec (object
, kw
, XBM_LAST
, Qxbm
))
2317 eassert (EQ (kw
[XBM_TYPE
].value
, Qxbm
));
2319 if (kw
[XBM_FILE
].count
)
2321 if (kw
[XBM_WIDTH
].count
|| kw
[XBM_HEIGHT
].count
|| kw
[XBM_DATA
].count
)
2324 else if (kw
[XBM_DATA
].count
&& xbm_file_p (kw
[XBM_DATA
].value
))
2326 /* In-memory XBM file. */
2327 if (kw
[XBM_WIDTH
].count
|| kw
[XBM_HEIGHT
].count
|| kw
[XBM_FILE
].count
)
2335 /* Entries for `:width', `:height' and `:data' must be present. */
2336 if (!kw
[XBM_WIDTH
].count
2337 || !kw
[XBM_HEIGHT
].count
2338 || !kw
[XBM_DATA
].count
)
2341 data
= kw
[XBM_DATA
].value
;
2342 width
= XFASTINT (kw
[XBM_WIDTH
].value
);
2343 height
= XFASTINT (kw
[XBM_HEIGHT
].value
);
2345 /* Check type of data, and width and height against contents of
2351 /* Number of elements of the vector must be >= height. */
2352 if (ASIZE (data
) < height
)
2355 /* Each string or bool-vector in data must be large enough
2356 for one line of the image. */
2357 for (i
= 0; i
< height
; ++i
)
2359 Lisp_Object elt
= AREF (data
, i
);
2364 < (width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
)
2367 else if (BOOL_VECTOR_P (elt
))
2369 if (XBOOL_VECTOR (elt
)->size
< width
)
2376 else if (STRINGP (data
))
2379 < (width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
* height
)
2382 else if (BOOL_VECTOR_P (data
))
2384 if (XBOOL_VECTOR (data
)->size
/ height
< width
)
2395 /* Scan a bitmap file. FP is the stream to read from. Value is
2396 either an enumerator from enum xbm_token, or a character for a
2397 single-character token, or 0 at end of file. If scanning an
2398 identifier, store the lexeme of the identifier in SVAL. If
2399 scanning a number, store its value in *IVAL. */
2402 xbm_scan (unsigned char **s
, unsigned char *end
, char *sval
, int *ival
)
2408 /* Skip white space. */
2409 while (*s
< end
&& (c
= *(*s
)++, c_isspace (c
)))
2414 else if (c_isdigit (c
))
2416 int value
= 0, digit
;
2418 if (c
== '0' && *s
< end
)
2421 if (c
== 'x' || c
== 'X')
2428 else if (c
>= 'a' && c
<= 'f')
2429 digit
= c
- 'a' + 10;
2430 else if (c
>= 'A' && c
<= 'F')
2431 digit
= c
- 'A' + 10;
2434 value
= 16 * value
+ digit
;
2437 else if (c_isdigit (c
))
2441 && (c
= *(*s
)++, c_isdigit (c
)))
2442 value
= 8 * value
+ c
- '0';
2449 && (c
= *(*s
)++, c_isdigit (c
)))
2450 value
= 10 * value
+ c
- '0';
2458 else if (c_isalpha (c
) || c
== '_')
2462 && (c
= *(*s
)++, (c_isalnum (c
) || c
== '_')))
2469 else if (c
== '/' && **s
== '*')
2471 /* C-style comment. */
2473 while (**s
&& (**s
!= '*' || *(*s
+ 1) != '/'))
2487 /* Create a Windows bitmap from X bitmap data. */
2489 w32_create_pixmap_from_bitmap_data (int width
, int height
, char *data
)
2491 static unsigned char swap_nibble
[16]
2492 = { 0x0, 0x8, 0x4, 0xc, /* 0000 1000 0100 1100 */
2493 0x2, 0xa, 0x6, 0xe, /* 0010 1010 0110 1110 */
2494 0x1, 0x9, 0x5, 0xd, /* 0001 1001 0101 1101 */
2495 0x3, 0xb, 0x7, 0xf }; /* 0011 1011 0111 1111 */
2497 unsigned char *bits
, *p
;
2500 w1
= (width
+ 7) / 8; /* nb of 8bits elt in X bitmap */
2501 w2
= ((width
+ 15) / 16) * 2; /* nb of 16bits elt in W32 bitmap */
2502 bits
= alloca (height
* w2
);
2503 memset (bits
, 0, height
* w2
);
2504 for (i
= 0; i
< height
; i
++)
2507 for (j
= 0; j
< w1
; j
++)
2509 /* Bitswap XBM bytes to match how Windows does things. */
2510 unsigned char c
= *data
++;
2511 *p
++ = (unsigned char)((swap_nibble
[c
& 0xf] << 4)
2512 | (swap_nibble
[(c
>>4) & 0xf]));
2515 bmp
= CreateBitmap (width
, height
, 1, 1, (char *) bits
);
2521 convert_mono_to_color_image (struct frame
*f
, struct image
*img
,
2522 COLORREF foreground
, COLORREF background
)
2524 HDC hdc
, old_img_dc
, new_img_dc
;
2525 HGDIOBJ old_prev
, new_prev
;
2528 hdc
= get_frame_dc (f
);
2529 old_img_dc
= CreateCompatibleDC (hdc
);
2530 new_img_dc
= CreateCompatibleDC (hdc
);
2531 new_pixmap
= CreateCompatibleBitmap (hdc
, img
->width
, img
->height
);
2532 release_frame_dc (f
, hdc
);
2533 old_prev
= SelectObject (old_img_dc
, img
->pixmap
);
2534 new_prev
= SelectObject (new_img_dc
, new_pixmap
);
2535 /* Windows convention for mono bitmaps is black = background,
2536 white = foreground. */
2537 SetTextColor (new_img_dc
, background
);
2538 SetBkColor (new_img_dc
, foreground
);
2540 BitBlt (new_img_dc
, 0, 0, img
->width
, img
->height
, old_img_dc
,
2543 SelectObject (old_img_dc
, old_prev
);
2544 SelectObject (new_img_dc
, new_prev
);
2545 DeleteDC (old_img_dc
);
2546 DeleteDC (new_img_dc
);
2547 DeleteObject (img
->pixmap
);
2548 if (new_pixmap
== 0)
2549 fprintf (stderr
, "Failed to convert image to color.\n");
2551 img
->pixmap
= new_pixmap
;
2554 #define XBM_BIT_SHUFFLE(b) (~(b))
2558 #define XBM_BIT_SHUFFLE(b) (b)
2560 #endif /* HAVE_NTGUI */
2564 Create_Pixmap_From_Bitmap_Data (struct frame
*f
, struct image
*img
, char *data
,
2565 RGB_PIXEL_COLOR fg
, RGB_PIXEL_COLOR bg
,
2566 int non_default_colors
)
2570 = w32_create_pixmap_from_bitmap_data (img
->width
, img
->height
, data
);
2572 /* If colors were specified, transfer the bitmap to a color one. */
2573 if (non_default_colors
)
2574 convert_mono_to_color_image (f
, img
, fg
, bg
);
2576 #elif defined (HAVE_NS)
2577 img
->pixmap
= ns_image_from_XBM (data
, img
->width
, img
->height
);
2581 (x_check_image_size (0, img
->width
, img
->height
)
2582 ? XCreatePixmapFromBitmapData (FRAME_X_DISPLAY (f
),
2585 img
->width
, img
->height
,
2587 DefaultDepthOfScreen (FRAME_X_SCREEN (f
)))
2589 #endif /* !HAVE_NTGUI && !HAVE_NS */
2594 /* Replacement for XReadBitmapFileData which isn't available under old
2595 X versions. CONTENTS is a pointer to a buffer to parse; END is the
2596 buffer's end. Set *WIDTH and *HEIGHT to the width and height of
2597 the image. Return in *DATA the bitmap data allocated with xmalloc.
2598 Value is non-zero if successful. DATA null means just test if
2599 CONTENTS looks like an in-memory XBM file. If INHIBIT_IMAGE_ERROR
2600 is non-zero, inhibit the call to image_error when the image size is
2601 invalid (the bitmap remains unread). */
2604 xbm_read_bitmap_data (struct frame
*f
, unsigned char *contents
, unsigned char *end
,
2605 int *width
, int *height
, char **data
,
2606 int inhibit_image_error
)
2608 unsigned char *s
= contents
;
2609 char buffer
[BUFSIZ
];
2612 int bytes_per_line
, i
, nbytes
;
2618 LA1 = xbm_scan (&s, end, buffer, &value)
2620 #define expect(TOKEN) \
2621 if (LA1 != (TOKEN)) \
2626 #define expect_ident(IDENT) \
2627 if (LA1 == XBM_TK_IDENT && strcmp (buffer, (IDENT)) == 0) \
2632 *width
= *height
= -1;
2635 LA1
= xbm_scan (&s
, end
, buffer
, &value
);
2637 /* Parse defines for width, height and hot-spots. */
2641 expect_ident ("define");
2642 expect (XBM_TK_IDENT
);
2644 if (LA1
== XBM_TK_NUMBER
)
2646 char *q
= strrchr (buffer
, '_');
2647 q
= q
? q
+ 1 : buffer
;
2648 if (strcmp (q
, "width") == 0)
2650 else if (strcmp (q
, "height") == 0)
2653 expect (XBM_TK_NUMBER
);
2656 if (!check_image_size (f
, *width
, *height
))
2658 if (!inhibit_image_error
)
2659 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
2662 else if (data
== NULL
)
2665 /* Parse bits. Must start with `static'. */
2666 expect_ident ("static");
2667 if (LA1
== XBM_TK_IDENT
)
2669 if (strcmp (buffer
, "unsigned") == 0)
2672 expect_ident ("char");
2674 else if (strcmp (buffer
, "short") == 0)
2678 if (*width
% 16 && *width
% 16 < 9)
2681 else if (strcmp (buffer
, "char") == 0)
2689 expect (XBM_TK_IDENT
);
2695 if (! x_check_image_size (0, *width
, *height
))
2697 if (!inhibit_image_error
)
2698 image_error ("Image too large (%dx%d)",
2699 make_number (*width
), make_number (*height
));
2702 bytes_per_line
= (*width
+ 7) / 8 + padding_p
;
2703 nbytes
= bytes_per_line
* *height
;
2704 p
= *data
= xmalloc (nbytes
);
2708 for (i
= 0; i
< nbytes
; i
+= 2)
2711 expect (XBM_TK_NUMBER
);
2713 *p
++ = XBM_BIT_SHUFFLE (val
);
2714 if (!padding_p
|| ((i
+ 2) % bytes_per_line
))
2715 *p
++ = XBM_BIT_SHUFFLE (value
>> 8);
2717 if (LA1
== ',' || LA1
== '}')
2725 for (i
= 0; i
< nbytes
; ++i
)
2728 expect (XBM_TK_NUMBER
);
2730 *p
++ = XBM_BIT_SHUFFLE (val
);
2732 if (LA1
== ',' || LA1
== '}')
2757 /* Load XBM image IMG which will be displayed on frame F from buffer
2758 CONTENTS. END is the end of the buffer. Value is non-zero if
2762 xbm_load_image (struct frame
*f
, struct image
*img
, unsigned char *contents
,
2769 rc
= xbm_read_bitmap_data (f
, contents
, end
, &img
->width
, &img
->height
,
2773 unsigned long foreground
= FRAME_FOREGROUND_PIXEL (f
);
2774 unsigned long background
= FRAME_BACKGROUND_PIXEL (f
);
2775 int non_default_colors
= 0;
2778 eassert (img
->width
> 0 && img
->height
> 0);
2780 /* Get foreground and background colors, maybe allocate colors. */
2781 value
= image_spec_value (img
->spec
, QCforeground
, NULL
);
2784 foreground
= x_alloc_image_color (f
, img
, value
, foreground
);
2785 non_default_colors
= 1;
2787 value
= image_spec_value (img
->spec
, QCbackground
, NULL
);
2790 background
= x_alloc_image_color (f
, img
, value
, background
);
2791 img
->background
= background
;
2792 img
->background_valid
= 1;
2793 non_default_colors
= 1;
2796 Create_Pixmap_From_Bitmap_Data (f
, img
, data
,
2797 foreground
, background
,
2798 non_default_colors
);
2801 if (img
->pixmap
== NO_PIXMAP
)
2803 x_clear_image (f
, img
);
2804 image_error ("Unable to create X pixmap for `%s'", img
->spec
, Qnil
);
2810 image_error ("Error loading XBM image `%s'", img
->spec
, Qnil
);
2816 /* Value is non-zero if DATA looks like an in-memory XBM file. */
2819 xbm_file_p (Lisp_Object data
)
2822 return (STRINGP (data
)
2823 && xbm_read_bitmap_data (NULL
, SDATA (data
),
2824 (SDATA (data
) + SBYTES (data
)),
2829 /* Fill image IMG which is used on frame F with pixmap data. Value is
2830 non-zero if successful. */
2833 xbm_load (struct frame
*f
, struct image
*img
)
2836 Lisp_Object file_name
;
2838 eassert (xbm_image_p (img
->spec
));
2840 /* If IMG->spec specifies a file name, create a non-file spec from it. */
2841 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
2842 if (STRINGP (file_name
))
2845 unsigned char *contents
;
2848 file
= x_find_image_file (file_name
);
2849 if (!STRINGP (file
))
2851 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
2855 contents
= slurp_file (SSDATA (file
), &size
);
2856 if (contents
== NULL
)
2858 image_error ("Error loading XBM image `%s'", img
->spec
, Qnil
);
2862 success_p
= xbm_load_image (f
, img
, contents
, contents
+ size
);
2867 struct image_keyword fmt
[XBM_LAST
];
2869 unsigned long foreground
= FRAME_FOREGROUND_PIXEL (f
);
2870 unsigned long background
= FRAME_BACKGROUND_PIXEL (f
);
2871 int non_default_colors
= 0;
2874 int in_memory_file_p
= 0;
2876 /* See if data looks like an in-memory XBM file. */
2877 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
2878 in_memory_file_p
= xbm_file_p (data
);
2880 /* Parse the image specification. */
2881 memcpy (fmt
, xbm_format
, sizeof fmt
);
2882 parsed_p
= parse_image_spec (img
->spec
, fmt
, XBM_LAST
, Qxbm
);
2886 /* Get specified width, and height. */
2887 if (!in_memory_file_p
)
2889 img
->width
= XFASTINT (fmt
[XBM_WIDTH
].value
);
2890 img
->height
= XFASTINT (fmt
[XBM_HEIGHT
].value
);
2891 eassert (img
->width
> 0 && img
->height
> 0);
2892 if (!check_image_size (f
, img
->width
, img
->height
))
2894 image_error ("Invalid image size (see `max-image-size')",
2900 /* Get foreground and background colors, maybe allocate colors. */
2901 if (fmt
[XBM_FOREGROUND
].count
2902 && STRINGP (fmt
[XBM_FOREGROUND
].value
))
2904 foreground
= x_alloc_image_color (f
, img
, fmt
[XBM_FOREGROUND
].value
,
2906 non_default_colors
= 1;
2909 if (fmt
[XBM_BACKGROUND
].count
2910 && STRINGP (fmt
[XBM_BACKGROUND
].value
))
2912 background
= x_alloc_image_color (f
, img
, fmt
[XBM_BACKGROUND
].value
,
2914 non_default_colors
= 1;
2917 if (in_memory_file_p
)
2918 success_p
= xbm_load_image (f
, img
, SDATA (data
),
2927 int nbytes
= (img
->width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
;
2929 p
= bits
= alloca (nbytes
* img
->height
);
2930 for (i
= 0; i
< img
->height
; ++i
, p
+= nbytes
)
2932 Lisp_Object line
= AREF (data
, i
);
2934 memcpy (p
, SDATA (line
), nbytes
);
2936 memcpy (p
, XBOOL_VECTOR (line
)->data
, nbytes
);
2939 else if (STRINGP (data
))
2940 bits
= SSDATA (data
);
2942 bits
= (char *) XBOOL_VECTOR (data
)->data
;
2948 /* Windows mono bitmaps are reversed compared with X. */
2949 invertedBits
= bits
;
2950 nbytes
= (img
->width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
2952 bits
= alloca (nbytes
);
2953 for (i
= 0; i
< nbytes
; i
++)
2954 bits
[i
] = XBM_BIT_SHUFFLE (invertedBits
[i
]);
2957 /* Create the pixmap. */
2959 if (x_check_image_size (0, img
->width
, img
->height
))
2960 Create_Pixmap_From_Bitmap_Data (f
, img
, bits
,
2961 foreground
, background
,
2962 non_default_colors
);
2964 img
->pixmap
= NO_PIXMAP
;
2970 image_error ("Unable to create pixmap for XBM image `%s'",
2972 x_clear_image (f
, img
);
2982 /***********************************************************************
2984 ***********************************************************************/
2986 #if defined (HAVE_XPM) || defined (HAVE_NS)
2988 static int xpm_image_p (Lisp_Object object
);
2989 static int xpm_load (struct frame
*f
, struct image
*img
);
2990 static int xpm_valid_color_symbols_p (Lisp_Object
);
2992 #endif /* HAVE_XPM || HAVE_NS */
2996 /* Indicate to xpm.h that we don't have Xlib. */
2998 /* simx.h in xpm defines XColor and XImage differently than Emacs. */
2999 /* It also defines Display the same way as Emacs, but gcc 3.3 still barfs. */
3000 #define XColor xpm_XColor
3001 #define XImage xpm_XImage
3002 #define Display xpm_Display
3003 #define PIXEL_ALREADY_TYPEDEFED
3004 #include "X11/xpm.h"
3009 #undef PIXEL_ALREADY_TYPEDEFED
3011 #include "X11/xpm.h"
3012 #endif /* HAVE_NTGUI */
3013 #endif /* HAVE_XPM */
3015 #if defined (HAVE_XPM) || defined (HAVE_NS)
3016 /* The symbol `xpm' identifying XPM-format images. */
3018 static Lisp_Object Qxpm
;
3020 /* Indices of image specification fields in xpm_format, below. */
3022 enum xpm_keyword_index
3038 /* Vector of image_keyword structures describing the format
3039 of valid XPM image specifications. */
3041 static const struct image_keyword xpm_format
[XPM_LAST
] =
3043 {":type", IMAGE_SYMBOL_VALUE
, 1},
3044 {":file", IMAGE_STRING_VALUE
, 0},
3045 {":data", IMAGE_STRING_VALUE
, 0},
3046 {":ascent", IMAGE_ASCENT_VALUE
, 0},
3047 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
3048 {":relief", IMAGE_INTEGER_VALUE
, 0},
3049 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3050 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3051 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3052 {":color-symbols", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3053 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
3056 /* Structure describing the image type XPM. */
3058 static struct image_type xpm_type
=
3067 #ifdef HAVE_X_WINDOWS
3069 /* Define ALLOC_XPM_COLORS if we can use Emacs' own color allocation
3070 functions for allocating image colors. Our own functions handle
3071 color allocation failures more gracefully than the ones on the XPM
3074 #if defined XpmAllocColor && defined XpmFreeColors && defined XpmColorClosure
3075 #define ALLOC_XPM_COLORS
3077 #endif /* HAVE_X_WINDOWS */
3079 #ifdef ALLOC_XPM_COLORS
3081 static void xpm_init_color_cache (struct frame
*, XpmAttributes
*);
3082 static void xpm_free_color_cache (void);
3083 static int xpm_lookup_color (struct frame
*, char *, XColor
*);
3084 static int xpm_color_bucket (char *);
3085 static struct xpm_cached_color
*xpm_cache_color (struct frame
*, char *,
3088 /* An entry in a hash table used to cache color definitions of named
3089 colors. This cache is necessary to speed up XPM image loading in
3090 case we do color allocations ourselves. Without it, we would need
3091 a call to XParseColor per pixel in the image. */
3093 struct xpm_cached_color
3095 /* Next in collision chain. */
3096 struct xpm_cached_color
*next
;
3098 /* Color definition (RGB and pixel color). */
3105 /* The hash table used for the color cache, and its bucket vector
3108 #define XPM_COLOR_CACHE_BUCKETS 1001
3109 static struct xpm_cached_color
**xpm_color_cache
;
3111 /* Initialize the color cache. */
3114 xpm_init_color_cache (struct frame
*f
, XpmAttributes
*attrs
)
3116 size_t nbytes
= XPM_COLOR_CACHE_BUCKETS
* sizeof *xpm_color_cache
;
3117 xpm_color_cache
= xzalloc (nbytes
);
3118 init_color_table ();
3120 if (attrs
->valuemask
& XpmColorSymbols
)
3125 for (i
= 0; i
< attrs
->numsymbols
; ++i
)
3126 if (XParseColor (FRAME_X_DISPLAY (f
), FRAME_X_COLORMAP (f
),
3127 attrs
->colorsymbols
[i
].value
, &color
))
3129 color
.pixel
= lookup_rgb_color (f
, color
.red
, color
.green
,
3131 xpm_cache_color (f
, attrs
->colorsymbols
[i
].name
, &color
, -1);
3136 /* Free the color cache. */
3139 xpm_free_color_cache (void)
3141 struct xpm_cached_color
*p
, *next
;
3144 for (i
= 0; i
< XPM_COLOR_CACHE_BUCKETS
; ++i
)
3145 for (p
= xpm_color_cache
[i
]; p
; p
= next
)
3151 xfree (xpm_color_cache
);
3152 xpm_color_cache
= NULL
;
3153 free_color_table ();
3156 /* Return the bucket index for color named COLOR_NAME in the color
3160 xpm_color_bucket (char *color_name
)
3162 EMACS_UINT hash
= hash_string (color_name
, strlen (color_name
));
3163 return hash
% XPM_COLOR_CACHE_BUCKETS
;
3167 /* On frame F, cache values COLOR for color with name COLOR_NAME.
3168 BUCKET, if >= 0, is a precomputed bucket index. Value is the cache
3171 static struct xpm_cached_color
*
3172 xpm_cache_color (struct frame
*f
, char *color_name
, XColor
*color
, int bucket
)
3175 struct xpm_cached_color
*p
;
3178 bucket
= xpm_color_bucket (color_name
);
3180 nbytes
= offsetof (struct xpm_cached_color
, name
) + strlen (color_name
) + 1;
3181 p
= xmalloc (nbytes
);
3182 strcpy (p
->name
, color_name
);
3184 p
->next
= xpm_color_cache
[bucket
];
3185 xpm_color_cache
[bucket
] = p
;
3189 /* Look up color COLOR_NAME for frame F in the color cache. If found,
3190 return the cached definition in *COLOR. Otherwise, make a new
3191 entry in the cache and allocate the color. Value is zero if color
3192 allocation failed. */
3195 xpm_lookup_color (struct frame
*f
, char *color_name
, XColor
*color
)
3197 struct xpm_cached_color
*p
;
3198 int h
= xpm_color_bucket (color_name
);
3200 for (p
= xpm_color_cache
[h
]; p
; p
= p
->next
)
3201 if (strcmp (p
->name
, color_name
) == 0)
3206 else if (XParseColor (FRAME_X_DISPLAY (f
), FRAME_X_COLORMAP (f
),
3209 color
->pixel
= lookup_rgb_color (f
, color
->red
, color
->green
,
3211 p
= xpm_cache_color (f
, color_name
, color
, h
);
3213 /* You get `opaque' at least from ImageMagick converting pbm to xpm
3214 with transparency, and it's useful. */
3215 else if (strcmp ("opaque", color_name
) == 0)
3217 memset (color
, 0, sizeof (XColor
)); /* Is this necessary/correct? */
3218 color
->pixel
= FRAME_FOREGROUND_PIXEL (f
);
3219 p
= xpm_cache_color (f
, color_name
, color
, h
);
3226 /* Callback for allocating color COLOR_NAME. Called from the XPM lib.
3227 CLOSURE is a pointer to the frame on which we allocate the
3228 color. Return in *COLOR the allocated color. Value is non-zero
3232 xpm_alloc_color (Display
*dpy
, Colormap cmap
, char *color_name
, XColor
*color
,
3235 return xpm_lookup_color ((struct frame
*) closure
, color_name
, color
);
3239 /* Callback for freeing NPIXELS colors contained in PIXELS. CLOSURE
3240 is a pointer to the frame on which we allocate the color. Value is
3241 non-zero if successful. */
3244 xpm_free_colors (Display
*dpy
, Colormap cmap
, Pixel
*pixels
, int npixels
, void *closure
)
3249 #endif /* ALLOC_XPM_COLORS */
3254 /* XPM library details. */
3256 DEF_IMGLIB_FN (void, XpmFreeAttributes
, (XpmAttributes
*));
3257 DEF_IMGLIB_FN (int, XpmCreateImageFromBuffer
, (Display
*, char *, xpm_XImage
**,
3258 xpm_XImage
**, XpmAttributes
*));
3259 DEF_IMGLIB_FN (int, XpmReadFileToImage
, (Display
*, char *, xpm_XImage
**,
3260 xpm_XImage
**, XpmAttributes
*));
3261 DEF_IMGLIB_FN (void, XImageFree
, (xpm_XImage
*));
3264 init_xpm_functions (Lisp_Object libraries
)
3268 if (!(library
= w32_delayed_load (libraries
, Qxpm
)))
3271 LOAD_IMGLIB_FN (library
, XpmFreeAttributes
);
3272 LOAD_IMGLIB_FN (library
, XpmCreateImageFromBuffer
);
3273 LOAD_IMGLIB_FN (library
, XpmReadFileToImage
);
3274 LOAD_IMGLIB_FN (library
, XImageFree
);
3278 #endif /* HAVE_NTGUI */
3281 /* Value is non-zero if COLOR_SYMBOLS is a valid color symbols list
3282 for XPM images. Such a list must consist of conses whose car and
3286 xpm_valid_color_symbols_p (Lisp_Object color_symbols
)
3288 while (CONSP (color_symbols
))
3290 Lisp_Object sym
= XCAR (color_symbols
);
3292 || !STRINGP (XCAR (sym
))
3293 || !STRINGP (XCDR (sym
)))
3295 color_symbols
= XCDR (color_symbols
);
3298 return NILP (color_symbols
);
3302 /* Value is non-zero if OBJECT is a valid XPM image specification. */
3305 xpm_image_p (Lisp_Object object
)
3307 struct image_keyword fmt
[XPM_LAST
];
3308 memcpy (fmt
, xpm_format
, sizeof fmt
);
3309 return (parse_image_spec (object
, fmt
, XPM_LAST
, Qxpm
)
3310 /* Either `:file' or `:data' must be present. */
3311 && fmt
[XPM_FILE
].count
+ fmt
[XPM_DATA
].count
== 1
3312 /* Either no `:color-symbols' or it's a list of conses
3313 whose car and cdr are strings. */
3314 && (fmt
[XPM_COLOR_SYMBOLS
].count
== 0
3315 || xpm_valid_color_symbols_p (fmt
[XPM_COLOR_SYMBOLS
].value
)));
3318 #endif /* HAVE_XPM || HAVE_NS */
3320 #if defined HAVE_XPM && defined HAVE_X_WINDOWS && !defined USE_GTK
3322 x_create_bitmap_from_xpm_data (struct frame
*f
, const char **bits
)
3324 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
3327 XpmAttributes attrs
;
3328 Pixmap bitmap
, mask
;
3330 memset (&attrs
, 0, sizeof attrs
);
3332 attrs
.visual
= FRAME_X_VISUAL (f
);
3333 attrs
.colormap
= FRAME_X_COLORMAP (f
);
3334 attrs
.valuemask
|= XpmVisual
;
3335 attrs
.valuemask
|= XpmColormap
;
3337 rc
= XpmCreatePixmapFromData (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
3338 (char **) bits
, &bitmap
, &mask
, &attrs
);
3339 if (rc
!= XpmSuccess
)
3341 XpmFreeAttributes (&attrs
);
3345 id
= x_allocate_bitmap_record (f
);
3346 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
3347 dpyinfo
->bitmaps
[id
- 1].have_mask
= 1;
3348 dpyinfo
->bitmaps
[id
- 1].mask
= mask
;
3349 dpyinfo
->bitmaps
[id
- 1].file
= NULL
;
3350 dpyinfo
->bitmaps
[id
- 1].height
= attrs
.height
;
3351 dpyinfo
->bitmaps
[id
- 1].width
= attrs
.width
;
3352 dpyinfo
->bitmaps
[id
- 1].depth
= attrs
.depth
;
3353 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
3355 XpmFreeAttributes (&attrs
);
3358 #endif /* defined (HAVE_XPM) && defined (HAVE_X_WINDOWS) */
3360 /* Load image IMG which will be displayed on frame F. Value is
3361 non-zero if successful. */
3366 xpm_load (struct frame
*f
, struct image
*img
)
3369 XpmAttributes attrs
;
3370 Lisp_Object specified_file
, color_symbols
;
3373 xpm_XImage
* xpm_image
= NULL
, * xpm_mask
= NULL
;
3374 #endif /* HAVE_NTGUI */
3376 /* Configure the XPM lib. Use the visual of frame F. Allocate
3377 close colors. Return colors allocated. */
3378 memset (&attrs
, 0, sizeof attrs
);
3381 attrs
.visual
= FRAME_X_VISUAL (f
);
3382 attrs
.colormap
= FRAME_X_COLORMAP (f
);
3383 attrs
.valuemask
|= XpmVisual
;
3384 attrs
.valuemask
|= XpmColormap
;
3385 #endif /* HAVE_NTGUI */
3387 #ifdef ALLOC_XPM_COLORS
3388 /* Allocate colors with our own functions which handle
3389 failing color allocation more gracefully. */
3390 attrs
.color_closure
= f
;
3391 attrs
.alloc_color
= xpm_alloc_color
;
3392 attrs
.free_colors
= xpm_free_colors
;
3393 attrs
.valuemask
|= XpmAllocColor
| XpmFreeColors
| XpmColorClosure
;
3394 #else /* not ALLOC_XPM_COLORS */
3395 /* Let the XPM lib allocate colors. */
3396 attrs
.valuemask
|= XpmReturnAllocPixels
;
3397 #ifdef XpmAllocCloseColors
3398 attrs
.alloc_close_colors
= 1;
3399 attrs
.valuemask
|= XpmAllocCloseColors
;
3400 #else /* not XpmAllocCloseColors */
3401 attrs
.closeness
= 600;
3402 attrs
.valuemask
|= XpmCloseness
;
3403 #endif /* not XpmAllocCloseColors */
3404 #endif /* ALLOC_XPM_COLORS */
3406 /* If image specification contains symbolic color definitions, add
3407 these to `attrs'. */
3408 color_symbols
= image_spec_value (img
->spec
, QCcolor_symbols
, NULL
);
3409 if (CONSP (color_symbols
))
3412 XpmColorSymbol
*xpm_syms
;
3415 attrs
.valuemask
|= XpmColorSymbols
;
3417 /* Count number of symbols. */
3418 attrs
.numsymbols
= 0;
3419 for (tail
= color_symbols
; CONSP (tail
); tail
= XCDR (tail
))
3422 /* Allocate an XpmColorSymbol array. */
3423 size
= attrs
.numsymbols
* sizeof *xpm_syms
;
3424 xpm_syms
= alloca (size
);
3425 memset (xpm_syms
, 0, size
);
3426 attrs
.colorsymbols
= xpm_syms
;
3428 /* Fill the color symbol array. */
3429 for (tail
= color_symbols
, i
= 0;
3431 ++i
, tail
= XCDR (tail
))
3435 char *empty_string
= (char *) "";
3437 if (!CONSP (XCAR (tail
)))
3439 xpm_syms
[i
].name
= empty_string
;
3440 xpm_syms
[i
].value
= empty_string
;
3443 name
= XCAR (XCAR (tail
));
3444 color
= XCDR (XCAR (tail
));
3447 xpm_syms
[i
].name
= alloca (SCHARS (name
) + 1);
3448 strcpy (xpm_syms
[i
].name
, SSDATA (name
));
3451 xpm_syms
[i
].name
= empty_string
;
3452 if (STRINGP (color
))
3454 xpm_syms
[i
].value
= alloca (SCHARS (color
) + 1);
3455 strcpy (xpm_syms
[i
].value
, SSDATA (color
));
3458 xpm_syms
[i
].value
= empty_string
;
3462 /* Create a pixmap for the image, either from a file, or from a
3463 string buffer containing data in the same format as an XPM file. */
3464 #ifdef ALLOC_XPM_COLORS
3465 xpm_init_color_cache (f
, &attrs
);
3468 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
3472 HDC frame_dc
= get_frame_dc (f
);
3473 hdc
= CreateCompatibleDC (frame_dc
);
3474 release_frame_dc (f
, frame_dc
);
3476 #endif /* HAVE_NTGUI */
3478 if (STRINGP (specified_file
))
3480 Lisp_Object file
= x_find_image_file (specified_file
);
3481 if (!STRINGP (file
))
3483 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
3484 #ifdef ALLOC_XPM_COLORS
3485 xpm_free_color_cache ();
3491 /* XpmReadFileToPixmap is not available in the Windows port of
3492 libxpm. But XpmReadFileToImage almost does what we want. */
3493 rc
= fn_XpmReadFileToImage (&hdc
, SDATA (file
),
3494 &xpm_image
, &xpm_mask
,
3497 rc
= XpmReadFileToPixmap (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
3498 SSDATA (file
), &img
->pixmap
, &img
->mask
,
3500 #endif /* HAVE_NTGUI */
3504 Lisp_Object buffer
= image_spec_value (img
->spec
, QCdata
, NULL
);
3505 if (!STRINGP (buffer
))
3507 image_error ("Invalid image data `%s'", buffer
, Qnil
);
3508 #ifdef ALLOC_XPM_COLORS
3509 xpm_free_color_cache ();
3514 /* XpmCreatePixmapFromBuffer is not available in the Windows port
3515 of libxpm. But XpmCreateImageFromBuffer almost does what we want. */
3516 rc
= fn_XpmCreateImageFromBuffer (&hdc
, SDATA (buffer
),
3517 &xpm_image
, &xpm_mask
,
3520 rc
= XpmCreatePixmapFromBuffer (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
3522 &img
->pixmap
, &img
->mask
,
3524 #endif /* HAVE_NTGUI */
3527 if (rc
== XpmSuccess
)
3529 #if defined (COLOR_TABLE_SUPPORT) && defined (ALLOC_XPM_COLORS)
3530 img
->colors
= colors_in_color_table (&img
->ncolors
);
3531 #else /* not ALLOC_XPM_COLORS */
3535 /* W32 XPM uses XImage to wrap what W32 Emacs calls a Pixmap,
3536 plus some duplicate attributes. */
3537 if (xpm_image
&& xpm_image
->bitmap
)
3539 img
->pixmap
= xpm_image
->bitmap
;
3540 /* XImageFree in libXpm frees XImage struct without destroying
3541 the bitmap, which is what we want. */
3542 fn_XImageFree (xpm_image
);
3544 if (xpm_mask
&& xpm_mask
->bitmap
)
3546 /* The mask appears to be inverted compared with what we expect.
3547 TODO: invert our expectations. See other places where we
3548 have to invert bits because our idea of masks is backwards. */
3550 old_obj
= SelectObject (hdc
, xpm_mask
->bitmap
);
3552 PatBlt (hdc
, 0, 0, xpm_mask
->width
, xpm_mask
->height
, DSTINVERT
);
3553 SelectObject (hdc
, old_obj
);
3555 img
->mask
= xpm_mask
->bitmap
;
3556 fn_XImageFree (xpm_mask
);
3561 #endif /* HAVE_NTGUI */
3563 /* Remember allocated colors. */
3564 img
->colors
= xnmalloc (attrs
.nalloc_pixels
, sizeof *img
->colors
);
3565 img
->ncolors
= attrs
.nalloc_pixels
;
3566 for (i
= 0; i
< attrs
.nalloc_pixels
; ++i
)
3568 img
->colors
[i
] = attrs
.alloc_pixels
[i
];
3569 #ifdef DEBUG_X_COLORS
3570 register_color (img
->colors
[i
]);
3573 #endif /* not ALLOC_XPM_COLORS */
3575 img
->width
= attrs
.width
;
3576 img
->height
= attrs
.height
;
3577 eassert (img
->width
> 0 && img
->height
> 0);
3579 /* The call to XpmFreeAttributes below frees attrs.alloc_pixels. */
3581 fn_XpmFreeAttributes (&attrs
);
3583 XpmFreeAttributes (&attrs
);
3584 #endif /* HAVE_NTGUI */
3590 #endif /* HAVE_NTGUI */
3595 image_error ("Error opening XPM file (%s)", img
->spec
, Qnil
);
3598 case XpmFileInvalid
:
3599 image_error ("Invalid XPM file (%s)", img
->spec
, Qnil
);
3603 image_error ("Out of memory (%s)", img
->spec
, Qnil
);
3606 case XpmColorFailed
:
3607 image_error ("Color allocation error (%s)", img
->spec
, Qnil
);
3611 image_error ("Unknown error (%s)", img
->spec
, Qnil
);
3616 #ifdef ALLOC_XPM_COLORS
3617 xpm_free_color_cache ();
3619 return rc
== XpmSuccess
;
3622 #endif /* HAVE_XPM */
3624 #if defined (HAVE_NS) && !defined (HAVE_XPM)
3626 /* XPM support functions for NS where libxpm is not available.
3627 Only XPM version 3 (without any extensions) is supported. */
3629 static void xpm_put_color_table_v (Lisp_Object
, const unsigned char *,
3631 static Lisp_Object
xpm_get_color_table_v (Lisp_Object
,
3632 const unsigned char *, int);
3633 static void xpm_put_color_table_h (Lisp_Object
, const unsigned char *,
3635 static Lisp_Object
xpm_get_color_table_h (Lisp_Object
,
3636 const unsigned char *, int);
3638 /* Tokens returned from xpm_scan. */
3647 /* Scan an XPM data and return a character (< 256) or a token defined
3648 by enum xpm_token above. *S and END are the start (inclusive) and
3649 the end (exclusive) addresses of the data, respectively. Advance
3650 *S while scanning. If token is either XPM_TK_IDENT or
3651 XPM_TK_STRING, *BEG and *LEN are set to the start address and the
3652 length of the corresponding token, respectively. */
3655 xpm_scan (const unsigned char **s
,
3656 const unsigned char *end
,
3657 const unsigned char **beg
,
3664 /* Skip white-space. */
3665 while (*s
< end
&& (c
= *(*s
)++, c_isspace (c
)))
3668 /* gnus-pointer.xpm uses '-' in its identifier.
3669 sb-dir-plus.xpm uses '+' in its identifier. */
3670 if (c_isalpha (c
) || c
== '_' || c
== '-' || c
== '+')
3674 && (c
= **s
, c_isalnum (c
)
3675 || c
== '_' || c
== '-' || c
== '+'))
3678 return XPM_TK_IDENT
;
3683 while (*s
< end
&& **s
!= '"')
3688 return XPM_TK_STRING
;
3692 if (*s
< end
&& **s
== '*')
3694 /* C-style comment. */
3698 while (*s
< end
&& *(*s
)++ != '*')
3701 while (*s
< end
&& **s
!= '/');
3715 /* Functions for color table lookup in XPM data. A key is a string
3716 specifying the color of each pixel in XPM data. A value is either
3717 an integer that specifies a pixel color, Qt that specifies
3718 transparency, or Qnil for the unspecified color. If the length of
3719 the key string is one, a vector is used as a table. Otherwise, a
3720 hash table is used. */
3723 xpm_make_color_table_v (void (**put_func
) (Lisp_Object
,
3724 const unsigned char *,
3727 Lisp_Object (**get_func
) (Lisp_Object
,
3728 const unsigned char *,
3731 *put_func
= xpm_put_color_table_v
;
3732 *get_func
= xpm_get_color_table_v
;
3733 return Fmake_vector (make_number (256), Qnil
);
3737 xpm_put_color_table_v (Lisp_Object color_table
,
3738 const unsigned char *chars_start
,
3742 ASET (color_table
, *chars_start
, color
);
3746 xpm_get_color_table_v (Lisp_Object color_table
,
3747 const unsigned char *chars_start
,
3750 return AREF (color_table
, *chars_start
);
3754 xpm_make_color_table_h (void (**put_func
) (Lisp_Object
,
3755 const unsigned char *,
3758 Lisp_Object (**get_func
) (Lisp_Object
,
3759 const unsigned char *,
3762 *put_func
= xpm_put_color_table_h
;
3763 *get_func
= xpm_get_color_table_h
;
3764 return make_hash_table (Qequal
, make_number (DEFAULT_HASH_SIZE
),
3765 make_float (DEFAULT_REHASH_SIZE
),
3766 make_float (DEFAULT_REHASH_THRESHOLD
),
3771 xpm_put_color_table_h (Lisp_Object color_table
,
3772 const unsigned char *chars_start
,
3776 struct Lisp_Hash_Table
*table
= XHASH_TABLE (color_table
);
3777 EMACS_UINT hash_code
;
3778 Lisp_Object chars
= make_unibyte_string (chars_start
, chars_len
);
3780 hash_lookup (table
, chars
, &hash_code
);
3781 hash_put (table
, chars
, color
, hash_code
);
3785 xpm_get_color_table_h (Lisp_Object color_table
,
3786 const unsigned char *chars_start
,
3789 struct Lisp_Hash_Table
*table
= XHASH_TABLE (color_table
);
3791 hash_lookup (table
, make_unibyte_string (chars_start
, chars_len
), NULL
);
3793 return i
>= 0 ? HASH_VALUE (table
, i
) : Qnil
;
3796 enum xpm_color_key
{
3804 static const char xpm_color_key_strings
[][4] = {"s", "m", "g4", "g", "c"};
3807 xpm_str_to_color_key (const char *s
)
3812 i
< sizeof xpm_color_key_strings
/ sizeof xpm_color_key_strings
[0];
3814 if (strcmp (xpm_color_key_strings
[i
], s
) == 0)
3820 xpm_load_image (struct frame
*f
,
3822 const unsigned char *contents
,
3823 const unsigned char *end
)
3825 const unsigned char *s
= contents
, *beg
, *str
;
3826 unsigned char buffer
[BUFSIZ
];
3827 int width
, height
, x
, y
;
3828 int num_colors
, chars_per_pixel
;
3831 void (*put_color_table
) (Lisp_Object
, const unsigned char *, int, Lisp_Object
);
3832 Lisp_Object (*get_color_table
) (Lisp_Object
, const unsigned char *, int);
3833 Lisp_Object frame
, color_symbols
, color_table
;
3834 int best_key
, have_mask
= 0;
3835 XImagePtr ximg
= NULL
, mask_img
= NULL
;
3838 LA1 = xpm_scan (&s, end, &beg, &len)
3840 #define expect(TOKEN) \
3841 if (LA1 != (TOKEN)) \
3846 #define expect_ident(IDENT) \
3847 if (LA1 == XPM_TK_IDENT \
3848 && strlen ((IDENT)) == len && memcmp ((IDENT), beg, len) == 0) \
3853 if (!(end
- s
>= 9 && memcmp (s
, "/* XPM */", 9) == 0))
3857 expect_ident ("static");
3858 expect_ident ("char");
3860 expect (XPM_TK_IDENT
);
3865 expect (XPM_TK_STRING
);
3868 memcpy (buffer
, beg
, len
);
3870 if (sscanf (buffer
, "%d %d %d %d", &width
, &height
,
3871 &num_colors
, &chars_per_pixel
) != 4
3872 || width
<= 0 || height
<= 0
3873 || num_colors
<= 0 || chars_per_pixel
<= 0)
3876 if (!check_image_size (f
, width
, height
))
3878 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
3882 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0,
3883 &ximg
, &img
->pixmap
)
3885 || !x_create_x_image_and_pixmap (f
, width
, height
, 1,
3886 &mask_img
, &img
->mask
)
3890 image_error ("Image too large", Qnil
, Qnil
);
3896 XSETFRAME (frame
, f
);
3897 if (!NILP (Fxw_display_color_p (frame
)))
3898 best_key
= XPM_COLOR_KEY_C
;
3899 else if (!NILP (Fx_display_grayscale_p (frame
)))
3900 best_key
= (XFASTINT (Fx_display_planes (frame
)) > 2
3901 ? XPM_COLOR_KEY_G
: XPM_COLOR_KEY_G4
);
3903 best_key
= XPM_COLOR_KEY_M
;
3905 color_symbols
= image_spec_value (img
->spec
, QCcolor_symbols
, NULL
);
3906 if (chars_per_pixel
== 1)
3907 color_table
= xpm_make_color_table_v (&put_color_table
,
3910 color_table
= xpm_make_color_table_h (&put_color_table
,
3913 while (num_colors
-- > 0)
3915 char *color
, *max_color
;
3916 int key
, next_key
, max_key
= 0;
3917 Lisp_Object symbol_color
= Qnil
, color_val
;
3920 expect (XPM_TK_STRING
);
3921 if (len
<= chars_per_pixel
|| len
>= BUFSIZ
+ chars_per_pixel
)
3923 memcpy (buffer
, beg
+ chars_per_pixel
, len
- chars_per_pixel
);
3924 buffer
[len
- chars_per_pixel
] = '\0';
3926 str
= strtok (buffer
, " \t");
3929 key
= xpm_str_to_color_key (str
);
3934 color
= strtok (NULL
, " \t");
3938 while ((str
= strtok (NULL
, " \t")) != NULL
)
3940 next_key
= xpm_str_to_color_key (str
);
3943 color
[strlen (color
)] = ' ';
3946 if (key
== XPM_COLOR_KEY_S
)
3948 if (NILP (symbol_color
))
3949 symbol_color
= build_string (color
);
3951 else if (max_key
< key
&& key
<= best_key
)
3961 if (!NILP (color_symbols
) && !NILP (symbol_color
))
3963 Lisp_Object specified_color
= Fassoc (symbol_color
, color_symbols
);
3965 if (CONSP (specified_color
) && STRINGP (XCDR (specified_color
)))
3967 if (xstrcasecmp (SSDATA (XCDR (specified_color
)), "None") == 0)
3969 else if (x_defined_color (f
, SSDATA (XCDR (specified_color
)),
3971 color_val
= make_number (cdef
.pixel
);
3974 if (NILP (color_val
) && max_key
> 0)
3976 if (xstrcasecmp (max_color
, "None") == 0)
3978 else if (x_defined_color (f
, max_color
, &cdef
, 0))
3979 color_val
= make_number (cdef
.pixel
);
3981 if (!NILP (color_val
))
3982 (*put_color_table
) (color_table
, beg
, chars_per_pixel
, color_val
);
3987 for (y
= 0; y
< height
; y
++)
3989 expect (XPM_TK_STRING
);
3991 if (len
< width
* chars_per_pixel
)
3993 for (x
= 0; x
< width
; x
++, str
+= chars_per_pixel
)
3995 Lisp_Object color_val
=
3996 (*get_color_table
) (color_table
, str
, chars_per_pixel
);
3998 XPutPixel (ximg
, x
, y
,
3999 (INTEGERP (color_val
) ? XINT (color_val
)
4000 : FRAME_FOREGROUND_PIXEL (f
)));
4002 XPutPixel (mask_img
, x
, y
,
4003 (!EQ (color_val
, Qt
) ? PIX_MASK_DRAW
4004 : (have_mask
= 1, PIX_MASK_RETAIN
)));
4006 if (EQ (color_val
, Qt
))
4007 ns_set_alpha (ximg
, x
, y
, 0);
4015 img
->height
= height
;
4017 /* Maybe fill in the background field while we have ximg handy. */
4018 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
4019 IMAGE_BACKGROUND (img
, f
, ximg
);
4021 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
4022 x_destroy_x_image (ximg
);
4026 /* Fill in the background_transparent field while we have the
4028 image_background_transparent (img
, f
, mask_img
);
4030 x_put_x_image (f
, mask_img
, img
->mask
, width
, height
);
4031 x_destroy_x_image (mask_img
);
4035 x_destroy_x_image (mask_img
);
4036 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->mask
);
4037 img
->mask
= NO_PIXMAP
;
4043 image_error ("Invalid XPM file (%s)", img
->spec
, Qnil
);
4044 x_destroy_x_image (ximg
);
4045 x_destroy_x_image (mask_img
);
4046 x_clear_image (f
, img
);
4055 xpm_load (struct frame
*f
,
4059 Lisp_Object file_name
;
4061 /* If IMG->spec specifies a file name, create a non-file spec from it. */
4062 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
4063 if (STRINGP (file_name
))
4066 unsigned char *contents
;
4069 file
= x_find_image_file (file_name
);
4070 if (!STRINGP (file
))
4072 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
4076 contents
= slurp_file (SSDATA (file
), &size
);
4077 if (contents
== NULL
)
4079 image_error ("Error loading XPM image `%s'", img
->spec
, Qnil
);
4083 success_p
= xpm_load_image (f
, img
, contents
, contents
+ size
);
4090 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
4091 if (!STRINGP (data
))
4093 image_error ("Invalid image data `%s'", data
, Qnil
);
4096 success_p
= xpm_load_image (f
, img
, SDATA (data
),
4097 SDATA (data
) + SBYTES (data
));
4103 #endif /* HAVE_NS && !HAVE_XPM */
4107 /***********************************************************************
4109 ***********************************************************************/
4111 #ifdef COLOR_TABLE_SUPPORT
4113 /* An entry in the color table mapping an RGB color to a pixel color. */
4118 unsigned long pixel
;
4120 /* Next in color table collision list. */
4121 struct ct_color
*next
;
4124 /* The bucket vector size to use. Must be prime. */
4128 /* Value is a hash of the RGB color given by R, G, and B. */
4130 #define CT_HASH_RGB(R, G, B) (((R) << 16) ^ ((G) << 8) ^ (B))
4132 /* The color hash table. */
4134 static struct ct_color
**ct_table
;
4136 /* Number of entries in the color table. */
4138 static int ct_colors_allocated
;
4141 ct_colors_allocated_max
=
4143 min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof (unsigned long))
4146 /* Initialize the color table. */
4149 init_color_table (void)
4151 int size
= CT_SIZE
* sizeof (*ct_table
);
4152 ct_table
= xzalloc (size
);
4153 ct_colors_allocated
= 0;
4157 /* Free memory associated with the color table. */
4160 free_color_table (void)
4163 struct ct_color
*p
, *next
;
4165 for (i
= 0; i
< CT_SIZE
; ++i
)
4166 for (p
= ct_table
[i
]; p
; p
= next
)
4177 /* Value is a pixel color for RGB color R, G, B on frame F. If an
4178 entry for that color already is in the color table, return the
4179 pixel color of that entry. Otherwise, allocate a new color for R,
4180 G, B, and make an entry in the color table. */
4182 static unsigned long
4183 lookup_rgb_color (struct frame
*f
, int r
, int g
, int b
)
4185 unsigned hash
= CT_HASH_RGB (r
, g
, b
);
4186 int i
= hash
% CT_SIZE
;
4188 Display_Info
*dpyinfo
;
4190 /* Handle TrueColor visuals specially, which improves performance by
4191 two orders of magnitude. Freeing colors on TrueColor visuals is
4192 a nop, and pixel colors specify RGB values directly. See also
4193 the Xlib spec, chapter 3.1. */
4194 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
4195 if (dpyinfo
->red_bits
> 0)
4197 unsigned long pr
, pg
, pb
;
4199 /* Apply gamma-correction like normal color allocation does. */
4203 color
.red
= r
, color
.green
= g
, color
.blue
= b
;
4204 gamma_correct (f
, &color
);
4205 r
= color
.red
, g
= color
.green
, b
= color
.blue
;
4208 /* Scale down RGB values to the visual's bits per RGB, and shift
4209 them to the right position in the pixel color. Note that the
4210 original RGB values are 16-bit values, as usual in X. */
4211 pr
= (r
>> (16 - dpyinfo
->red_bits
)) << dpyinfo
->red_offset
;
4212 pg
= (g
>> (16 - dpyinfo
->green_bits
)) << dpyinfo
->green_offset
;
4213 pb
= (b
>> (16 - dpyinfo
->blue_bits
)) << dpyinfo
->blue_offset
;
4215 /* Assemble the pixel color. */
4216 return pr
| pg
| pb
;
4219 for (p
= ct_table
[i
]; p
; p
= p
->next
)
4220 if (p
->r
== r
&& p
->g
== g
&& p
->b
== b
)
4226 #ifdef HAVE_X_WINDOWS
4234 if (ct_colors_allocated_max
<= ct_colors_allocated
)
4235 return FRAME_FOREGROUND_PIXEL (f
);
4237 #ifdef HAVE_X_WINDOWS
4242 cmap
= FRAME_X_COLORMAP (f
);
4243 rc
= x_alloc_nearest_color (f
, cmap
, &color
);
4246 ++ct_colors_allocated
;
4247 p
= xmalloc (sizeof *p
);
4251 p
->pixel
= color
.pixel
;
4252 p
->next
= ct_table
[i
];
4256 return FRAME_FOREGROUND_PIXEL (f
);
4260 color
= PALETTERGB (r
, g
, b
);
4262 color
= RGB_TO_ULONG (r
, g
, b
);
4263 #endif /* HAVE_NTGUI */
4264 ++ct_colors_allocated
;
4265 p
= xmalloc (sizeof *p
);
4270 p
->next
= ct_table
[i
];
4272 #endif /* HAVE_X_WINDOWS */
4280 /* Look up pixel color PIXEL which is used on frame F in the color
4281 table. If not already present, allocate it. Value is PIXEL. */
4283 static unsigned long
4284 lookup_pixel_color (struct frame
*f
, unsigned long pixel
)
4286 int i
= pixel
% CT_SIZE
;
4289 for (p
= ct_table
[i
]; p
; p
= p
->next
)
4290 if (p
->pixel
== pixel
)
4299 if (ct_colors_allocated_max
<= ct_colors_allocated
)
4300 return FRAME_FOREGROUND_PIXEL (f
);
4302 #ifdef HAVE_X_WINDOWS
4303 cmap
= FRAME_X_COLORMAP (f
);
4304 color
.pixel
= pixel
;
4305 x_query_color (f
, &color
);
4306 rc
= x_alloc_nearest_color (f
, cmap
, &color
);
4309 cmap
= DefaultColormapOfScreen (FRAME_X_SCREEN (f
));
4310 color
.pixel
= pixel
;
4311 XQueryColor (NULL
, cmap
, &color
);
4312 rc
= x_alloc_nearest_color (f
, cmap
, &color
);
4314 #endif /* HAVE_X_WINDOWS */
4318 ++ct_colors_allocated
;
4320 p
= xmalloc (sizeof *p
);
4325 p
->next
= ct_table
[i
];
4329 return FRAME_FOREGROUND_PIXEL (f
);
4335 /* Value is a vector of all pixel colors contained in the color table,
4336 allocated via xmalloc. Set *N to the number of colors. */
4338 static unsigned long *
4339 colors_in_color_table (int *n
)
4343 unsigned long *colors
;
4345 if (ct_colors_allocated
== 0)
4352 colors
= xmalloc (ct_colors_allocated
* sizeof *colors
);
4353 *n
= ct_colors_allocated
;
4355 for (i
= j
= 0; i
< CT_SIZE
; ++i
)
4356 for (p
= ct_table
[i
]; p
; p
= p
->next
)
4357 colors
[j
++] = p
->pixel
;
4363 #else /* COLOR_TABLE_SUPPORT */
4365 static unsigned long
4366 lookup_rgb_color (struct frame
*f
, int r
, int g
, int b
)
4368 unsigned long pixel
;
4371 pixel
= PALETTERGB (r
>> 8, g
>> 8, b
>> 8);
4372 #endif /* HAVE_NTGUI */
4375 pixel
= RGB_TO_ULONG (r
>> 8, g
>> 8, b
>> 8);
4376 #endif /* HAVE_NS */
4381 init_color_table (void)
4384 #endif /* COLOR_TABLE_SUPPORT */
4387 /***********************************************************************
4389 ***********************************************************************/
4391 static XColor
*x_to_xcolors (struct frame
*, struct image
*, int);
4392 static void x_from_xcolors (struct frame
*, struct image
*, XColor
*);
4393 static void x_detect_edges (struct frame
*, struct image
*, int[9], int);
4396 static void XPutPixel (XImagePtr
, int, int, COLORREF
);
4397 #endif /* HAVE_NTGUI */
4399 /* Edge detection matrices for different edge-detection
4402 static int emboss_matrix
[9] = {
4404 2, -1, 0, /* y - 1 */
4406 0, 1, -2 /* y + 1 */
4409 static int laplace_matrix
[9] = {
4411 1, 0, 0, /* y - 1 */
4413 0, 0, -1 /* y + 1 */
4416 /* Value is the intensity of the color whose red/green/blue values
4419 #define COLOR_INTENSITY(R, G, B) ((2 * (R) + 3 * (G) + (B)) / 6)
4422 /* On frame F, return an array of XColor structures describing image
4423 IMG->pixmap. Each XColor structure has its pixel color set. RGB_P
4424 non-zero means also fill the red/green/blue members of the XColor
4425 structures. Value is a pointer to the array of XColors structures,
4426 allocated with xmalloc; it must be freed by the caller. */
4429 x_to_xcolors (struct frame
*f
, struct image
*img
, int rgb_p
)
4433 XImagePtr_or_DC ximg
;
4437 #endif /* HAVE_NTGUI */
4439 if (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *colors
/ img
->width
< img
->height
)
4440 memory_full (SIZE_MAX
);
4441 colors
= xmalloc (sizeof *colors
* img
->width
* img
->height
);
4444 /* Get the X image IMG->pixmap. */
4445 ximg
= XGetImage (FRAME_X_DISPLAY (f
), img
->pixmap
,
4446 0, 0, img
->width
, img
->height
, ~0, ZPixmap
);
4448 /* Load the image into a memory device context. */
4449 hdc
= get_frame_dc (f
);
4450 ximg
= CreateCompatibleDC (hdc
);
4451 release_frame_dc (f
, hdc
);
4452 prev
= SelectObject (ximg
, img
->pixmap
);
4453 #endif /* HAVE_NTGUI */
4455 /* Fill the `pixel' members of the XColor array. I wished there
4456 were an easy and portable way to circumvent XGetPixel. */
4458 for (y
= 0; y
< img
->height
; ++y
)
4460 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI)
4462 for (x
= 0; x
< img
->width
; ++x
, ++p
)
4463 p
->pixel
= GET_PIXEL (ximg
, x
, y
);
4465 x_query_colors (f
, row
, img
->width
);
4469 for (x
= 0; x
< img
->width
; ++x
, ++p
)
4471 /* W32_TODO: palette support needed here? */
4472 p
->pixel
= GET_PIXEL (ximg
, x
, y
);
4475 p
->red
= RED16_FROM_ULONG (p
->pixel
);
4476 p
->green
= GREEN16_FROM_ULONG (p
->pixel
);
4477 p
->blue
= BLUE16_FROM_ULONG (p
->pixel
);
4480 #endif /* HAVE_X_WINDOWS */
4483 Destroy_Image (ximg
, prev
);
4490 /* Put a pixel of COLOR at position X, Y in XIMG. XIMG must have been
4491 created with CreateDIBSection, with the pointer to the bit values
4492 stored in ximg->data. */
4495 XPutPixel (XImagePtr ximg
, int x
, int y
, COLORREF color
)
4497 int width
= ximg
->info
.bmiHeader
.biWidth
;
4498 unsigned char * pixel
;
4500 /* True color images. */
4501 if (ximg
->info
.bmiHeader
.biBitCount
== 24)
4503 int rowbytes
= width
* 3;
4504 /* Ensure scanlines are aligned on 4 byte boundaries. */
4506 rowbytes
+= 4 - (rowbytes
% 4);
4508 pixel
= ximg
->data
+ y
* rowbytes
+ x
* 3;
4509 /* Windows bitmaps are in BGR order. */
4510 *pixel
= GetBValue (color
);
4511 *(pixel
+ 1) = GetGValue (color
);
4512 *(pixel
+ 2) = GetRValue (color
);
4514 /* Monochrome images. */
4515 else if (ximg
->info
.bmiHeader
.biBitCount
== 1)
4517 int rowbytes
= width
/ 8;
4518 /* Ensure scanlines are aligned on 4 byte boundaries. */
4520 rowbytes
+= 4 - (rowbytes
% 4);
4521 pixel
= ximg
->data
+ y
* rowbytes
+ x
/ 8;
4522 /* Filter out palette info. */
4523 if (color
& 0x00ffffff)
4524 *pixel
= *pixel
| (1 << x
% 8);
4526 *pixel
= *pixel
& ~(1 << x
% 8);
4529 image_error ("XPutPixel: palette image not supported", Qnil
, Qnil
);
4532 #endif /* HAVE_NTGUI */
4534 /* Create IMG->pixmap from an array COLORS of XColor structures, whose
4535 RGB members are set. F is the frame on which this all happens.
4536 COLORS will be freed; an existing IMG->pixmap will be freed, too. */
4539 x_from_xcolors (struct frame
*f
, struct image
*img
, XColor
*colors
)
4542 XImagePtr oimg
= NULL
;
4546 init_color_table ();
4548 x_create_x_image_and_pixmap (f
, img
->width
, img
->height
, 0,
4551 for (y
= 0; y
< img
->height
; ++y
)
4552 for (x
= 0; x
< img
->width
; ++x
, ++p
)
4554 unsigned long pixel
;
4555 pixel
= lookup_rgb_color (f
, p
->red
, p
->green
, p
->blue
);
4556 XPutPixel (oimg
, x
, y
, pixel
);
4560 x_clear_image_1 (f
, img
, 1, 0, 1);
4562 x_put_x_image (f
, oimg
, pixmap
, img
->width
, img
->height
);
4563 x_destroy_x_image (oimg
);
4564 img
->pixmap
= pixmap
;
4565 #ifdef COLOR_TABLE_SUPPORT
4566 img
->colors
= colors_in_color_table (&img
->ncolors
);
4567 free_color_table ();
4568 #endif /* COLOR_TABLE_SUPPORT */
4572 /* On frame F, perform edge-detection on image IMG.
4574 MATRIX is a nine-element array specifying the transformation
4575 matrix. See emboss_matrix for an example.
4577 COLOR_ADJUST is a color adjustment added to each pixel of the
4581 x_detect_edges (struct frame
*f
, struct image
*img
, int *matrix
, int color_adjust
)
4583 XColor
*colors
= x_to_xcolors (f
, img
, 1);
4587 for (i
= sum
= 0; i
< 9; ++i
)
4588 sum
+= eabs (matrix
[i
]);
4590 #define COLOR(A, X, Y) ((A) + (Y) * img->width + (X))
4592 if (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *new / img
->width
< img
->height
)
4593 memory_full (SIZE_MAX
);
4594 new = xmalloc (sizeof *new * img
->width
* img
->height
);
4596 for (y
= 0; y
< img
->height
; ++y
)
4598 p
= COLOR (new, 0, y
);
4599 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4600 p
= COLOR (new, img
->width
- 1, y
);
4601 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4604 for (x
= 1; x
< img
->width
- 1; ++x
)
4606 p
= COLOR (new, x
, 0);
4607 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4608 p
= COLOR (new, x
, img
->height
- 1);
4609 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4612 for (y
= 1; y
< img
->height
- 1; ++y
)
4614 p
= COLOR (new, 1, y
);
4616 for (x
= 1; x
< img
->width
- 1; ++x
, ++p
)
4618 int r
, g
, b
, yy
, xx
;
4621 for (yy
= y
- 1; yy
< y
+ 2; ++yy
)
4622 for (xx
= x
- 1; xx
< x
+ 2; ++xx
, ++i
)
4625 XColor
*t
= COLOR (colors
, xx
, yy
);
4626 r
+= matrix
[i
] * t
->red
;
4627 g
+= matrix
[i
] * t
->green
;
4628 b
+= matrix
[i
] * t
->blue
;
4631 r
= (r
/ sum
+ color_adjust
) & 0xffff;
4632 g
= (g
/ sum
+ color_adjust
) & 0xffff;
4633 b
= (b
/ sum
+ color_adjust
) & 0xffff;
4634 p
->red
= p
->green
= p
->blue
= COLOR_INTENSITY (r
, g
, b
);
4639 x_from_xcolors (f
, img
, new);
4645 /* Perform the pre-defined `emboss' edge-detection on image IMG
4649 x_emboss (struct frame
*f
, struct image
*img
)
4651 x_detect_edges (f
, img
, emboss_matrix
, 0xffff / 2);
4655 /* Transform image IMG which is used on frame F with a Laplace
4656 edge-detection algorithm. The result is an image that can be used
4657 to draw disabled buttons, for example. */
4660 x_laplace (struct frame
*f
, struct image
*img
)
4662 x_detect_edges (f
, img
, laplace_matrix
, 45000);
4666 /* Perform edge-detection on image IMG on frame F, with specified
4667 transformation matrix MATRIX and color-adjustment COLOR_ADJUST.
4669 MATRIX must be either
4671 - a list of at least 9 numbers in row-major form
4672 - a vector of at least 9 numbers
4674 COLOR_ADJUST nil means use a default; otherwise it must be a
4678 x_edge_detection (struct frame
*f
, struct image
*img
, Lisp_Object matrix
,
4679 Lisp_Object color_adjust
)
4687 i
< 9 && CONSP (matrix
) && NUMBERP (XCAR (matrix
));
4688 ++i
, matrix
= XCDR (matrix
))
4689 trans
[i
] = XFLOATINT (XCAR (matrix
));
4691 else if (VECTORP (matrix
) && ASIZE (matrix
) >= 9)
4693 for (i
= 0; i
< 9 && NUMBERP (AREF (matrix
, i
)); ++i
)
4694 trans
[i
] = XFLOATINT (AREF (matrix
, i
));
4697 if (NILP (color_adjust
))
4698 color_adjust
= make_number (0xffff / 2);
4700 if (i
== 9 && NUMBERP (color_adjust
))
4701 x_detect_edges (f
, img
, trans
, XFLOATINT (color_adjust
));
4705 /* Transform image IMG on frame F so that it looks disabled. */
4708 x_disable_image (struct frame
*f
, struct image
*img
)
4710 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
4712 int n_planes
= dpyinfo
->n_planes
* dpyinfo
->n_cbits
;
4714 int n_planes
= dpyinfo
->n_planes
;
4715 #endif /* HAVE_NTGUI */
4719 /* Color (or grayscale). Convert to gray, and equalize. Just
4720 drawing such images with a stipple can look very odd, so
4721 we're using this method instead. */
4722 XColor
*colors
= x_to_xcolors (f
, img
, 1);
4724 const int h
= 15000;
4725 const int l
= 30000;
4727 for (p
= colors
, end
= colors
+ img
->width
* img
->height
;
4731 int i
= COLOR_INTENSITY (p
->red
, p
->green
, p
->blue
);
4732 int i2
= (0xffff - h
- l
) * i
/ 0xffff + l
;
4733 p
->red
= p
->green
= p
->blue
= i2
;
4736 x_from_xcolors (f
, img
, colors
);
4739 /* Draw a cross over the disabled image, if we must or if we
4741 if (n_planes
< 2 || cross_disabled_images
)
4744 #ifndef HAVE_NS /* TODO: NS support, however this not needed for toolbars */
4746 #define MaskForeground(f) WHITE_PIX_DEFAULT (f)
4748 Display
*dpy
= FRAME_X_DISPLAY (f
);
4749 GC gc
= XCreateGC (dpy
, img
->pixmap
, 0, NULL
);
4750 XSetForeground (dpy
, gc
, BLACK_PIX_DEFAULT (f
));
4751 XDrawLine (dpy
, img
->pixmap
, gc
, 0, 0,
4752 img
->width
- 1, img
->height
- 1);
4753 XDrawLine (dpy
, img
->pixmap
, gc
, 0, img
->height
- 1,
4759 gc
= XCreateGC (dpy
, img
->mask
, 0, NULL
);
4760 XSetForeground (dpy
, gc
, MaskForeground (f
));
4761 XDrawLine (dpy
, img
->mask
, gc
, 0, 0,
4762 img
->width
- 1, img
->height
- 1);
4763 XDrawLine (dpy
, img
->mask
, gc
, 0, img
->height
- 1,
4767 #endif /* !HAVE_NS */
4772 hdc
= get_frame_dc (f
);
4773 bmpdc
= CreateCompatibleDC (hdc
);
4774 release_frame_dc (f
, hdc
);
4776 prev
= SelectObject (bmpdc
, img
->pixmap
);
4778 SetTextColor (bmpdc
, BLACK_PIX_DEFAULT (f
));
4779 MoveToEx (bmpdc
, 0, 0, NULL
);
4780 LineTo (bmpdc
, img
->width
- 1, img
->height
- 1);
4781 MoveToEx (bmpdc
, 0, img
->height
- 1, NULL
);
4782 LineTo (bmpdc
, img
->width
- 1, 0);
4786 SelectObject (bmpdc
, img
->mask
);
4787 SetTextColor (bmpdc
, WHITE_PIX_DEFAULT (f
));
4788 MoveToEx (bmpdc
, 0, 0, NULL
);
4789 LineTo (bmpdc
, img
->width
- 1, img
->height
- 1);
4790 MoveToEx (bmpdc
, 0, img
->height
- 1, NULL
);
4791 LineTo (bmpdc
, img
->width
- 1, 0);
4793 SelectObject (bmpdc
, prev
);
4795 #endif /* HAVE_NTGUI */
4800 /* Build a mask for image IMG which is used on frame F. FILE is the
4801 name of an image file, for error messages. HOW determines how to
4802 determine the background color of IMG. If it is a list '(R G B)',
4803 with R, G, and B being integers >= 0, take that as the color of the
4804 background. Otherwise, determine the background color of IMG
4805 heuristically. Value is non-zero if successful. */
4808 x_build_heuristic_mask (struct frame
*f
, struct image
*img
, Lisp_Object how
)
4810 XImagePtr_or_DC ximg
;
4818 #endif /* HAVE_NTGUI */
4819 int x
, y
, rc
, use_img_background
;
4820 unsigned long bg
= 0;
4824 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->mask
);
4825 img
->mask
= NO_PIXMAP
;
4826 img
->background_transparent_valid
= 0;
4831 /* Create an image and pixmap serving as mask. */
4832 rc
= x_create_x_image_and_pixmap (f
, img
->width
, img
->height
, 1,
4833 &mask_img
, &img
->mask
);
4836 #endif /* !HAVE_NS */
4838 /* Get the X image of IMG->pixmap. */
4839 ximg
= XGetImage (FRAME_X_DISPLAY (f
), img
->pixmap
, 0, 0,
4840 img
->width
, img
->height
,
4843 /* Create the bit array serving as mask. */
4844 row_width
= (img
->width
+ 7) / 8;
4845 mask_img
= xzalloc (row_width
* img
->height
);
4847 /* Create a memory device context for IMG->pixmap. */
4848 frame_dc
= get_frame_dc (f
);
4849 ximg
= CreateCompatibleDC (frame_dc
);
4850 release_frame_dc (f
, frame_dc
);
4851 prev
= SelectObject (ximg
, img
->pixmap
);
4852 #endif /* HAVE_NTGUI */
4854 /* Determine the background color of ximg. If HOW is `(R G B)'
4855 take that as color. Otherwise, use the image's background color. */
4856 use_img_background
= 1;
4862 for (i
= 0; i
< 3 && CONSP (how
) && NATNUMP (XCAR (how
)); ++i
)
4864 rgb
[i
] = XFASTINT (XCAR (how
)) & 0xffff;
4868 if (i
== 3 && NILP (how
))
4870 char color_name
[30];
4871 sprintf (color_name
, "#%04x%04x%04x", rgb
[0], rgb
[1], rgb
[2]);
4874 0x00ffffff & /* Filter out palette info. */
4875 #endif /* HAVE_NTGUI */
4876 x_alloc_image_color (f
, img
, build_string (color_name
), 0));
4877 use_img_background
= 0;
4881 if (use_img_background
)
4882 bg
= four_corners_best (ximg
, img
->corners
, img
->width
, img
->height
);
4884 /* Set all bits in mask_img to 1 whose color in ximg is different
4885 from the background color bg. */
4887 for (y
= 0; y
< img
->height
; ++y
)
4888 for (x
= 0; x
< img
->width
; ++x
)
4890 XPutPixel (mask_img
, x
, y
, (XGetPixel (ximg
, x
, y
) != bg
4891 ? PIX_MASK_DRAW
: PIX_MASK_RETAIN
));
4893 if (XGetPixel (ximg
, x
, y
) == bg
)
4894 ns_set_alpha (ximg
, x
, y
, 0);
4895 #endif /* HAVE_NS */
4897 /* Fill in the background_transparent field while we have the mask handy. */
4898 image_background_transparent (img
, f
, mask_img
);
4900 /* Put mask_img into img->mask. */
4901 x_put_x_image (f
, mask_img
, img
->mask
, img
->width
, img
->height
);
4902 x_destroy_x_image (mask_img
);
4903 #endif /* !HAVE_NS */
4905 for (y
= 0; y
< img
->height
; ++y
)
4906 for (x
= 0; x
< img
->width
; ++x
)
4908 COLORREF p
= GetPixel (ximg
, x
, y
);
4910 mask_img
[y
* row_width
+ x
/ 8] |= 1 << (x
% 8);
4913 /* Create the mask image. */
4914 img
->mask
= w32_create_pixmap_from_bitmap_data (img
->width
, img
->height
,
4916 /* Fill in the background_transparent field while we have the mask handy. */
4917 SelectObject (ximg
, img
->mask
);
4918 image_background_transparent (img
, f
, ximg
);
4920 /* Was: x_destroy_x_image ((XImagePtr )mask_img); which seems bogus ++kfs */
4922 #endif /* HAVE_NTGUI */
4924 Destroy_Image (ximg
, prev
);
4930 /***********************************************************************
4931 PBM (mono, gray, color)
4932 ***********************************************************************/
4934 static int pbm_image_p (Lisp_Object object
);
4935 static int pbm_load (struct frame
*f
, struct image
*img
);
4936 static int pbm_scan_number (unsigned char **, unsigned char *);
4938 /* The symbol `pbm' identifying images of this type. */
4940 static Lisp_Object Qpbm
;
4942 /* Indices of image specification fields in gs_format, below. */
4944 enum pbm_keyword_index
4960 /* Vector of image_keyword structures describing the format
4961 of valid user-defined image specifications. */
4963 static const struct image_keyword pbm_format
[PBM_LAST
] =
4965 {":type", IMAGE_SYMBOL_VALUE
, 1},
4966 {":file", IMAGE_STRING_VALUE
, 0},
4967 {":data", IMAGE_STRING_VALUE
, 0},
4968 {":ascent", IMAGE_ASCENT_VALUE
, 0},
4969 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
4970 {":relief", IMAGE_INTEGER_VALUE
, 0},
4971 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
4972 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
4973 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
4974 {":foreground", IMAGE_STRING_OR_NIL_VALUE
, 0},
4975 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
4978 /* Structure describing the image type `pbm'. */
4980 static struct image_type pbm_type
=
4990 /* Return non-zero if OBJECT is a valid PBM image specification. */
4993 pbm_image_p (Lisp_Object object
)
4995 struct image_keyword fmt
[PBM_LAST
];
4997 memcpy (fmt
, pbm_format
, sizeof fmt
);
4999 if (!parse_image_spec (object
, fmt
, PBM_LAST
, Qpbm
))
5002 /* Must specify either :data or :file. */
5003 return fmt
[PBM_DATA
].count
+ fmt
[PBM_FILE
].count
== 1;
5007 /* Scan a decimal number from *S and return it. Advance *S while
5008 reading the number. END is the end of the string. Value is -1 at
5012 pbm_scan_number (unsigned char **s
, unsigned char *end
)
5014 int c
= 0, val
= -1;
5018 /* Skip white-space. */
5019 while (*s
< end
&& (c
= *(*s
)++, c_isspace (c
)))
5024 /* Skip comment to end of line. */
5025 while (*s
< end
&& (c
= *(*s
)++, c
!= '\n'))
5028 else if (c_isdigit (c
))
5030 /* Read decimal number. */
5032 while (*s
< end
&& (c
= *(*s
)++, c_isdigit (c
)))
5033 val
= 10 * val
+ c
- '0';
5045 #if 0 /* Unused. ++kfs */
5047 /* Read FILE into memory. Value is a pointer to a buffer allocated
5048 with xmalloc holding FILE's contents. Value is null if an error
5049 occurred. *SIZE is set to the size of the file. */
5052 pbm_read_file (Lisp_Object file
, int *size
)
5058 if (stat (SDATA (file
), &st
) == 0
5059 && (fp
= fopen (SDATA (file
), "rb")) != NULL
5060 && 0 <= st
.st_size
&& st
.st_size
<= min (PTRDIFF_MAX
, SIZE_MAX
)
5061 && (buf
= xmalloc (st
.st_size
),
5062 fread (buf
, 1, st
.st_size
, fp
) == st
.st_size
))
5081 #endif /* HAVE_NTGUI */
5083 /* Load PBM image IMG for use on frame F. */
5086 pbm_load (struct frame
*f
, struct image
*img
)
5089 int width
, height
, max_color_idx
= 0;
5091 Lisp_Object file
, specified_file
;
5092 enum {PBM_MONO
, PBM_GRAY
, PBM_COLOR
} type
;
5093 unsigned char *contents
= NULL
;
5094 unsigned char *end
, *p
;
5097 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
5099 if (STRINGP (specified_file
))
5101 file
= x_find_image_file (specified_file
);
5102 if (!STRINGP (file
))
5104 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
5108 contents
= slurp_file (SSDATA (file
), &size
);
5109 if (contents
== NULL
)
5111 image_error ("Error reading `%s'", file
, Qnil
);
5116 end
= contents
+ size
;
5121 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
5122 if (!STRINGP (data
))
5124 image_error ("Invalid image data `%s'", data
, Qnil
);
5128 end
= p
+ SBYTES (data
);
5131 /* Check magic number. */
5132 if (end
- p
< 2 || *p
++ != 'P')
5134 image_error ("Not a PBM image: `%s'", img
->spec
, Qnil
);
5143 raw_p
= 0, type
= PBM_MONO
;
5147 raw_p
= 0, type
= PBM_GRAY
;
5151 raw_p
= 0, type
= PBM_COLOR
;
5155 raw_p
= 1, type
= PBM_MONO
;
5159 raw_p
= 1, type
= PBM_GRAY
;
5163 raw_p
= 1, type
= PBM_COLOR
;
5167 image_error ("Not a PBM image: `%s'", img
->spec
, Qnil
);
5171 /* Read width, height, maximum color-component. Characters
5172 starting with `#' up to the end of a line are ignored. */
5173 width
= pbm_scan_number (&p
, end
);
5174 height
= pbm_scan_number (&p
, end
);
5176 if (type
!= PBM_MONO
)
5178 max_color_idx
= pbm_scan_number (&p
, end
);
5179 if (max_color_idx
> 65535 || max_color_idx
< 0)
5181 image_error ("Unsupported maximum PBM color value", Qnil
, Qnil
);
5186 if (!check_image_size (f
, width
, height
))
5188 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
5192 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0,
5193 &ximg
, &img
->pixmap
))
5196 /* Initialize the color hash table. */
5197 init_color_table ();
5199 if (type
== PBM_MONO
)
5202 struct image_keyword fmt
[PBM_LAST
];
5203 unsigned long fg
= FRAME_FOREGROUND_PIXEL (f
);
5204 unsigned long bg
= FRAME_BACKGROUND_PIXEL (f
);
5206 /* Parse the image specification. */
5207 memcpy (fmt
, pbm_format
, sizeof fmt
);
5208 parse_image_spec (img
->spec
, fmt
, PBM_LAST
, Qpbm
);
5210 /* Get foreground and background colors, maybe allocate colors. */
5211 if (fmt
[PBM_FOREGROUND
].count
5212 && STRINGP (fmt
[PBM_FOREGROUND
].value
))
5213 fg
= x_alloc_image_color (f
, img
, fmt
[PBM_FOREGROUND
].value
, fg
);
5214 if (fmt
[PBM_BACKGROUND
].count
5215 && STRINGP (fmt
[PBM_BACKGROUND
].value
))
5217 bg
= x_alloc_image_color (f
, img
, fmt
[PBM_BACKGROUND
].value
, bg
);
5218 img
->background
= bg
;
5219 img
->background_valid
= 1;
5222 for (y
= 0; y
< height
; ++y
)
5223 for (x
= 0; x
< width
; ++x
)
5231 x_destroy_x_image (ximg
);
5232 x_clear_image (f
, img
);
5233 image_error ("Invalid image size in image `%s'",
5243 g
= pbm_scan_number (&p
, end
);
5245 XPutPixel (ximg
, x
, y
, g
? fg
: bg
);
5250 int expected_size
= height
* width
;
5251 if (max_color_idx
> 255)
5253 if (type
== PBM_COLOR
)
5256 if (raw_p
&& p
+ expected_size
> end
)
5258 x_destroy_x_image (ximg
);
5259 x_clear_image (f
, img
);
5260 image_error ("Invalid image size in image `%s'",
5265 for (y
= 0; y
< height
; ++y
)
5266 for (x
= 0; x
< width
; ++x
)
5270 if (type
== PBM_GRAY
&& raw_p
)
5273 if (max_color_idx
> 255)
5274 r
= g
= b
= r
* 256 + *p
++;
5276 else if (type
== PBM_GRAY
)
5277 r
= g
= b
= pbm_scan_number (&p
, end
);
5281 if (max_color_idx
> 255)
5284 if (max_color_idx
> 255)
5287 if (max_color_idx
> 255)
5292 r
= pbm_scan_number (&p
, end
);
5293 g
= pbm_scan_number (&p
, end
);
5294 b
= pbm_scan_number (&p
, end
);
5297 if (r
< 0 || g
< 0 || b
< 0)
5299 x_destroy_x_image (ximg
);
5300 image_error ("Invalid pixel value in image `%s'",
5305 /* RGB values are now in the range 0..max_color_idx.
5306 Scale this to the range 0..0xffff supported by X. */
5307 r
= (double) r
* 65535 / max_color_idx
;
5308 g
= (double) g
* 65535 / max_color_idx
;
5309 b
= (double) b
* 65535 / max_color_idx
;
5310 XPutPixel (ximg
, x
, y
, lookup_rgb_color (f
, r
, g
, b
));
5314 #ifdef COLOR_TABLE_SUPPORT
5315 /* Store in IMG->colors the colors allocated for the image, and
5316 free the color table. */
5317 img
->colors
= colors_in_color_table (&img
->ncolors
);
5318 free_color_table ();
5319 #endif /* COLOR_TABLE_SUPPORT */
5322 img
->height
= height
;
5324 /* Maybe fill in the background field while we have ximg handy. */
5326 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
5327 /* Casting avoids a GCC warning. */
5328 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
5330 /* Put the image into a pixmap. */
5331 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
5332 x_destroy_x_image (ximg
);
5334 /* X and W32 versions did it here, MAC version above. ++kfs
5336 img->height = height; */
5343 /***********************************************************************
5345 ***********************************************************************/
5347 #if defined (HAVE_PNG) || defined (HAVE_NS)
5349 /* Function prototypes. */
5351 static int png_image_p (Lisp_Object object
);
5352 static int png_load (struct frame
*f
, struct image
*img
);
5354 /* The symbol `png' identifying images of this type. */
5356 static Lisp_Object Qpng
;
5358 /* Indices of image specification fields in png_format, below. */
5360 enum png_keyword_index
5375 /* Vector of image_keyword structures describing the format
5376 of valid user-defined image specifications. */
5378 static const struct image_keyword png_format
[PNG_LAST
] =
5380 {":type", IMAGE_SYMBOL_VALUE
, 1},
5381 {":data", IMAGE_STRING_VALUE
, 0},
5382 {":file", IMAGE_STRING_VALUE
, 0},
5383 {":ascent", IMAGE_ASCENT_VALUE
, 0},
5384 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
5385 {":relief", IMAGE_INTEGER_VALUE
, 0},
5386 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5387 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5388 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5389 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
5392 /* Structure describing the image type `png'. */
5394 static struct image_type png_type
=
5403 /* Return non-zero if OBJECT is a valid PNG image specification. */
5406 png_image_p (Lisp_Object object
)
5408 struct image_keyword fmt
[PNG_LAST
];
5409 memcpy (fmt
, png_format
, sizeof fmt
);
5411 if (!parse_image_spec (object
, fmt
, PNG_LAST
, Qpng
))
5414 /* Must specify either the :data or :file keyword. */
5415 return fmt
[PNG_FILE
].count
+ fmt
[PNG_DATA
].count
== 1;
5418 #endif /* HAVE_PNG || HAVE_NS */
5424 /* PNG library details. */
5426 DEF_IMGLIB_FN (png_voidp
, png_get_io_ptr
, (png_structp
));
5427 DEF_IMGLIB_FN (int, png_sig_cmp
, (png_bytep
, png_size_t
, png_size_t
));
5428 DEF_IMGLIB_FN (png_structp
, png_create_read_struct
, (png_const_charp
, png_voidp
,
5429 png_error_ptr
, png_error_ptr
));
5430 DEF_IMGLIB_FN (png_infop
, png_create_info_struct
, (png_structp
));
5431 DEF_IMGLIB_FN (void, png_destroy_read_struct
, (png_structpp
, png_infopp
, png_infopp
));
5432 DEF_IMGLIB_FN (void, png_set_read_fn
, (png_structp
, png_voidp
, png_rw_ptr
));
5433 DEF_IMGLIB_FN (void, png_set_sig_bytes
, (png_structp
, int));
5434 DEF_IMGLIB_FN (void, png_read_info
, (png_structp
, png_infop
));
5435 DEF_IMGLIB_FN (png_uint_32
, png_get_IHDR
, (png_structp
, png_infop
,
5436 png_uint_32
*, png_uint_32
*,
5437 int *, int *, int *, int *, int *));
5438 DEF_IMGLIB_FN (png_uint_32
, png_get_valid
, (png_structp
, png_infop
, png_uint_32
));
5439 DEF_IMGLIB_FN (void, png_set_strip_16
, (png_structp
));
5440 DEF_IMGLIB_FN (void, png_set_expand
, (png_structp
));
5441 DEF_IMGLIB_FN (void, png_set_gray_to_rgb
, (png_structp
));
5442 DEF_IMGLIB_FN (void, png_set_background
, (png_structp
, png_color_16p
,
5444 DEF_IMGLIB_FN (png_uint_32
, png_get_bKGD
, (png_structp
, png_infop
, png_color_16p
*));
5445 DEF_IMGLIB_FN (void, png_read_update_info
, (png_structp
, png_infop
));
5446 DEF_IMGLIB_FN (png_byte
, png_get_channels
, (png_structp
, png_infop
));
5447 DEF_IMGLIB_FN (png_size_t
, png_get_rowbytes
, (png_structp
, png_infop
));
5448 DEF_IMGLIB_FN (void, png_read_image
, (png_structp
, png_bytepp
));
5449 DEF_IMGLIB_FN (void, png_read_end
, (png_structp
, png_infop
));
5450 DEF_IMGLIB_FN (void, png_error
, (png_structp
, png_const_charp
));
5452 #if (PNG_LIBPNG_VER >= 10500)
5453 DEF_IMGLIB_FN (void, png_longjmp
, (png_structp
, int));
5454 DEF_IMGLIB_FN (jmp_buf *, png_set_longjmp_fn
, (png_structp
, png_longjmp_ptr
, size_t));
5455 #endif /* libpng version >= 1.5 */
5458 init_png_functions (Lisp_Object libraries
)
5462 if (!(library
= w32_delayed_load (libraries
, Qpng
)))
5465 LOAD_IMGLIB_FN (library
, png_get_io_ptr
);
5466 LOAD_IMGLIB_FN (library
, png_sig_cmp
);
5467 LOAD_IMGLIB_FN (library
, png_create_read_struct
);
5468 LOAD_IMGLIB_FN (library
, png_create_info_struct
);
5469 LOAD_IMGLIB_FN (library
, png_destroy_read_struct
);
5470 LOAD_IMGLIB_FN (library
, png_set_read_fn
);
5471 LOAD_IMGLIB_FN (library
, png_set_sig_bytes
);
5472 LOAD_IMGLIB_FN (library
, png_read_info
);
5473 LOAD_IMGLIB_FN (library
, png_get_IHDR
);
5474 LOAD_IMGLIB_FN (library
, png_get_valid
);
5475 LOAD_IMGLIB_FN (library
, png_set_strip_16
);
5476 LOAD_IMGLIB_FN (library
, png_set_expand
);
5477 LOAD_IMGLIB_FN (library
, png_set_gray_to_rgb
);
5478 LOAD_IMGLIB_FN (library
, png_set_background
);
5479 LOAD_IMGLIB_FN (library
, png_get_bKGD
);
5480 LOAD_IMGLIB_FN (library
, png_read_update_info
);
5481 LOAD_IMGLIB_FN (library
, png_get_channels
);
5482 LOAD_IMGLIB_FN (library
, png_get_rowbytes
);
5483 LOAD_IMGLIB_FN (library
, png_read_image
);
5484 LOAD_IMGLIB_FN (library
, png_read_end
);
5485 LOAD_IMGLIB_FN (library
, png_error
);
5487 #if (PNG_LIBPNG_VER >= 10500)
5488 LOAD_IMGLIB_FN (library
, png_longjmp
);
5489 LOAD_IMGLIB_FN (library
, png_set_longjmp_fn
);
5490 #endif /* libpng version >= 1.5 */
5496 #define fn_png_get_io_ptr png_get_io_ptr
5497 #define fn_png_sig_cmp png_sig_cmp
5498 #define fn_png_create_read_struct png_create_read_struct
5499 #define fn_png_create_info_struct png_create_info_struct
5500 #define fn_png_destroy_read_struct png_destroy_read_struct
5501 #define fn_png_set_read_fn png_set_read_fn
5502 #define fn_png_set_sig_bytes png_set_sig_bytes
5503 #define fn_png_read_info png_read_info
5504 #define fn_png_get_IHDR png_get_IHDR
5505 #define fn_png_get_valid png_get_valid
5506 #define fn_png_set_strip_16 png_set_strip_16
5507 #define fn_png_set_expand png_set_expand
5508 #define fn_png_set_gray_to_rgb png_set_gray_to_rgb
5509 #define fn_png_set_background png_set_background
5510 #define fn_png_get_bKGD png_get_bKGD
5511 #define fn_png_read_update_info png_read_update_info
5512 #define fn_png_get_channels png_get_channels
5513 #define fn_png_get_rowbytes png_get_rowbytes
5514 #define fn_png_read_image png_read_image
5515 #define fn_png_read_end png_read_end
5516 #define fn_png_error png_error
5518 #if (PNG_LIBPNG_VER >= 10500)
5519 #define fn_png_longjmp png_longjmp
5520 #define fn_png_set_longjmp_fn png_set_longjmp_fn
5521 #endif /* libpng version >= 1.5 */
5523 #endif /* HAVE_NTGUI */
5526 #if (PNG_LIBPNG_VER < 10500)
5527 #define PNG_LONGJMP(ptr) (longjmp ((ptr)->jmpbuf, 1))
5528 #define PNG_JMPBUF(ptr) ((ptr)->jmpbuf)
5530 /* In libpng version 1.5, the jmpbuf member is hidden. (Bug#7908) */
5531 #define PNG_LONGJMP(ptr) (fn_png_longjmp ((ptr), 1))
5532 #define PNG_JMPBUF(ptr) \
5533 (*fn_png_set_longjmp_fn ((ptr), longjmp, sizeof (jmp_buf)))
5536 /* Error and warning handlers installed when the PNG library
5539 static _Noreturn
void
5540 my_png_error (png_struct
*png_ptr
, const char *msg
)
5542 eassert (png_ptr
!= NULL
);
5543 /* Avoid compiler warning about deprecated direct access to
5544 png_ptr's fields in libpng versions 1.4.x. */
5545 image_error ("PNG error: %s", build_string (msg
), Qnil
);
5546 PNG_LONGJMP (png_ptr
);
5551 my_png_warning (png_struct
*png_ptr
, const char *msg
)
5553 eassert (png_ptr
!= NULL
);
5554 image_error ("PNG warning: %s", build_string (msg
), Qnil
);
5557 /* Memory source for PNG decoding. */
5559 struct png_memory_storage
5561 unsigned char *bytes
; /* The data */
5562 ptrdiff_t len
; /* How big is it? */
5563 ptrdiff_t index
; /* Where are we? */
5567 /* Function set as reader function when reading PNG image from memory.
5568 PNG_PTR is a pointer to the PNG control structure. Copy LENGTH
5569 bytes from the input to DATA. */
5572 png_read_from_memory (png_structp png_ptr
, png_bytep data
, png_size_t length
)
5574 struct png_memory_storage
*tbr
5575 = (struct png_memory_storage
*) fn_png_get_io_ptr (png_ptr
);
5577 if (length
> tbr
->len
- tbr
->index
)
5578 fn_png_error (png_ptr
, "Read error");
5580 memcpy (data
, tbr
->bytes
+ tbr
->index
, length
);
5581 tbr
->index
= tbr
->index
+ length
;
5585 /* Function set as reader function when reading PNG image from a file.
5586 PNG_PTR is a pointer to the PNG control structure. Copy LENGTH
5587 bytes from the input to DATA. */
5590 png_read_from_file (png_structp png_ptr
, png_bytep data
, png_size_t length
)
5592 FILE *fp
= (FILE *) fn_png_get_io_ptr (png_ptr
);
5594 if (fread (data
, 1, length
, fp
) < length
)
5595 fn_png_error (png_ptr
, "Read error");
5599 /* Load PNG image IMG for use on frame F. Value is non-zero if
5603 png_load (struct frame
*f
, struct image
*img
)
5605 Lisp_Object file
, specified_file
;
5606 Lisp_Object specified_data
;
5609 XImagePtr ximg
, mask_img
= NULL
;
5610 png_struct
*png_ptr
= NULL
;
5611 png_info
*info_ptr
= NULL
, *end_info
= NULL
;
5612 FILE *volatile fp
= NULL
;
5614 png_byte
* volatile pixels
= NULL
;
5615 png_byte
** volatile rows
= NULL
;
5616 png_uint_32 width
, height
;
5617 int bit_depth
, color_type
, interlace_type
;
5619 png_uint_32 row_bytes
;
5621 struct png_memory_storage tbr
; /* Data to be read */
5623 /* Find out what file to load. */
5624 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
5625 specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
5627 if (NILP (specified_data
))
5629 file
= x_find_image_file (specified_file
);
5630 if (!STRINGP (file
))
5632 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
5636 /* Open the image file. */
5637 fp
= fopen (SSDATA (file
), "rb");
5640 image_error ("Cannot open image file `%s'", file
, Qnil
);
5644 /* Check PNG signature. */
5645 if (fread (sig
, 1, sizeof sig
, fp
) != sizeof sig
5646 || fn_png_sig_cmp (sig
, 0, sizeof sig
))
5648 image_error ("Not a PNG file: `%s'", file
, Qnil
);
5655 if (!STRINGP (specified_data
))
5657 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
5661 /* Read from memory. */
5662 tbr
.bytes
= SDATA (specified_data
);
5663 tbr
.len
= SBYTES (specified_data
);
5666 /* Check PNG signature. */
5667 if (tbr
.len
< sizeof sig
5668 || fn_png_sig_cmp (tbr
.bytes
, 0, sizeof sig
))
5670 image_error ("Not a PNG image: `%s'", img
->spec
, Qnil
);
5674 /* Need to skip past the signature. */
5675 tbr
.bytes
+= sizeof (sig
);
5678 /* Initialize read and info structs for PNG lib. */
5679 png_ptr
= fn_png_create_read_struct (PNG_LIBPNG_VER_STRING
,
5684 if (fp
) fclose (fp
);
5688 info_ptr
= fn_png_create_info_struct (png_ptr
);
5691 fn_png_destroy_read_struct (&png_ptr
, NULL
, NULL
);
5692 if (fp
) fclose (fp
);
5696 end_info
= fn_png_create_info_struct (png_ptr
);
5699 fn_png_destroy_read_struct (&png_ptr
, &info_ptr
, NULL
);
5700 if (fp
) fclose (fp
);
5704 /* Set error jump-back. We come back here when the PNG library
5705 detects an error. */
5706 if (setjmp (PNG_JMPBUF (png_ptr
)))
5710 fn_png_destroy_read_struct (&png_ptr
, &info_ptr
, &end_info
);
5713 if (fp
) fclose (fp
);
5717 /* Read image info. */
5718 if (!NILP (specified_data
))
5719 fn_png_set_read_fn (png_ptr
, (void *) &tbr
, png_read_from_memory
);
5721 fn_png_set_read_fn (png_ptr
, (void *) fp
, png_read_from_file
);
5723 fn_png_set_sig_bytes (png_ptr
, sizeof sig
);
5724 fn_png_read_info (png_ptr
, info_ptr
);
5725 fn_png_get_IHDR (png_ptr
, info_ptr
, &width
, &height
, &bit_depth
, &color_type
,
5726 &interlace_type
, NULL
, NULL
);
5728 if (! (width
<= INT_MAX
&& height
<= INT_MAX
5729 && check_image_size (f
, width
, height
)))
5731 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
5735 /* Create the X image and pixmap now, so that the work below can be
5736 omitted if the image is too large for X. */
5737 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0, &ximg
,
5741 /* If image contains simply transparency data, we prefer to
5742 construct a clipping mask. */
5743 if (fn_png_get_valid (png_ptr
, info_ptr
, PNG_INFO_tRNS
))
5748 /* This function is easier to write if we only have to handle
5749 one data format: RGB or RGBA with 8 bits per channel. Let's
5750 transform other formats into that format. */
5752 /* Strip more than 8 bits per channel. */
5753 if (bit_depth
== 16)
5754 fn_png_set_strip_16 (png_ptr
);
5756 /* Expand data to 24 bit RGB, or 8 bit grayscale, with alpha channel
5758 fn_png_set_expand (png_ptr
);
5760 /* Convert grayscale images to RGB. */
5761 if (color_type
== PNG_COLOR_TYPE_GRAY
5762 || color_type
== PNG_COLOR_TYPE_GRAY_ALPHA
)
5763 fn_png_set_gray_to_rgb (png_ptr
);
5765 /* Handle alpha channel by combining the image with a background
5766 color. Do this only if a real alpha channel is supplied. For
5767 simple transparency, we prefer a clipping mask. */
5770 /* png_color_16 *image_bg; */
5771 Lisp_Object specified_bg
5772 = image_spec_value (img
->spec
, QCbackground
, NULL
);
5773 int shift
= (bit_depth
== 16) ? 0 : 8;
5775 if (STRINGP (specified_bg
))
5776 /* The user specified `:background', use that. */
5779 if (x_defined_color (f
, SSDATA (specified_bg
), &color
, 0))
5781 png_color_16 user_bg
;
5783 memset (&user_bg
, 0, sizeof user_bg
);
5784 user_bg
.red
= color
.red
>> shift
;
5785 user_bg
.green
= color
.green
>> shift
;
5786 user_bg
.blue
= color
.blue
>> shift
;
5788 fn_png_set_background (png_ptr
, &user_bg
,
5789 PNG_BACKGROUND_GAMMA_SCREEN
, 0, 1.0);
5794 /* We use the current frame background, ignoring any default
5795 background color set by the image. */
5796 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI)
5798 png_color_16 frame_background
;
5800 color
.pixel
= FRAME_BACKGROUND_PIXEL (f
);
5801 x_query_color (f
, &color
);
5803 memset (&frame_background
, 0, sizeof frame_background
);
5804 frame_background
.red
= color
.red
>> shift
;
5805 frame_background
.green
= color
.green
>> shift
;
5806 frame_background
.blue
= color
.blue
>> shift
;
5807 #endif /* HAVE_X_WINDOWS */
5809 fn_png_set_background (png_ptr
, &frame_background
,
5810 PNG_BACKGROUND_GAMMA_SCREEN
, 0, 1.0);
5814 /* Update info structure. */
5815 fn_png_read_update_info (png_ptr
, info_ptr
);
5817 /* Get number of channels. Valid values are 1 for grayscale images
5818 and images with a palette, 2 for grayscale images with transparency
5819 information (alpha channel), 3 for RGB images, and 4 for RGB
5820 images with alpha channel, i.e. RGBA. If conversions above were
5821 sufficient we should only have 3 or 4 channels here. */
5822 channels
= fn_png_get_channels (png_ptr
, info_ptr
);
5823 eassert (channels
== 3 || channels
== 4);
5825 /* Number of bytes needed for one row of the image. */
5826 row_bytes
= fn_png_get_rowbytes (png_ptr
, info_ptr
);
5828 /* Allocate memory for the image. */
5829 if (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *rows
< height
5830 || min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *pixels
/ height
< row_bytes
)
5831 memory_full (SIZE_MAX
);
5832 pixels
= xmalloc (sizeof *pixels
* row_bytes
* height
);
5833 rows
= xmalloc (height
* sizeof *rows
);
5834 for (i
= 0; i
< height
; ++i
)
5835 rows
[i
] = pixels
+ i
* row_bytes
;
5837 /* Read the entire image. */
5838 fn_png_read_image (png_ptr
, rows
);
5839 fn_png_read_end (png_ptr
, info_ptr
);
5846 /* Create an image and pixmap serving as mask if the PNG image
5847 contains an alpha channel. */
5850 && !x_create_x_image_and_pixmap (f
, width
, height
, 1,
5851 &mask_img
, &img
->mask
))
5853 x_destroy_x_image (ximg
);
5854 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->pixmap
);
5855 img
->pixmap
= NO_PIXMAP
;
5859 /* Fill the X image and mask from PNG data. */
5860 init_color_table ();
5862 for (y
= 0; y
< height
; ++y
)
5864 png_byte
*p
= rows
[y
];
5866 for (x
= 0; x
< width
; ++x
)
5873 XPutPixel (ximg
, x
, y
, lookup_rgb_color (f
, r
, g
, b
));
5874 /* An alpha channel, aka mask channel, associates variable
5875 transparency with an image. Where other image formats
5876 support binary transparency---fully transparent or fully
5877 opaque---PNG allows up to 254 levels of partial transparency.
5878 The PNG library implements partial transparency by combining
5879 the image with a specified background color.
5881 I'm not sure how to handle this here nicely: because the
5882 background on which the image is displayed may change, for
5883 real alpha channel support, it would be necessary to create
5884 a new image for each possible background.
5886 What I'm doing now is that a mask is created if we have
5887 boolean transparency information. Otherwise I'm using
5888 the frame's background color to combine the image with. */
5893 XPutPixel (mask_img
, x
, y
, *p
> 0 ? PIX_MASK_DRAW
: PIX_MASK_RETAIN
);
5899 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
5900 /* Set IMG's background color from the PNG image, unless the user
5904 if (fn_png_get_bKGD (png_ptr
, info_ptr
, &bg
))
5906 img
->background
= lookup_rgb_color (f
, bg
->red
, bg
->green
, bg
->blue
);
5907 img
->background_valid
= 1;
5911 #ifdef COLOR_TABLE_SUPPORT
5912 /* Remember colors allocated for this image. */
5913 img
->colors
= colors_in_color_table (&img
->ncolors
);
5914 free_color_table ();
5915 #endif /* COLOR_TABLE_SUPPORT */
5918 fn_png_destroy_read_struct (&png_ptr
, &info_ptr
, &end_info
);
5923 img
->height
= height
;
5925 /* Maybe fill in the background field while we have ximg handy.
5926 Casting avoids a GCC warning. */
5927 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
5929 /* Put the image into the pixmap, then free the X image and its buffer. */
5930 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
5931 x_destroy_x_image (ximg
);
5933 /* Same for the mask. */
5936 /* Fill in the background_transparent field while we have the
5937 mask handy. Casting avoids a GCC warning. */
5938 image_background_transparent (img
, f
, (XImagePtr_or_DC
)mask_img
);
5940 x_put_x_image (f
, mask_img
, img
->mask
, img
->width
, img
->height
);
5941 x_destroy_x_image (mask_img
);
5947 #else /* HAVE_PNG */
5951 png_load (struct frame
*f
, struct image
*img
)
5953 return ns_load_image (f
, img
,
5954 image_spec_value (img
->spec
, QCfile
, NULL
),
5955 image_spec_value (img
->spec
, QCdata
, NULL
));
5957 #endif /* HAVE_NS */
5960 #endif /* !HAVE_PNG */
5964 /***********************************************************************
5966 ***********************************************************************/
5968 #if defined (HAVE_JPEG) || defined (HAVE_NS)
5970 static int jpeg_image_p (Lisp_Object object
);
5971 static int jpeg_load (struct frame
*f
, struct image
*img
);
5973 /* The symbol `jpeg' identifying images of this type. */
5975 static Lisp_Object Qjpeg
;
5977 /* Indices of image specification fields in gs_format, below. */
5979 enum jpeg_keyword_index
5988 JPEG_HEURISTIC_MASK
,
5994 /* Vector of image_keyword structures describing the format
5995 of valid user-defined image specifications. */
5997 static const struct image_keyword jpeg_format
[JPEG_LAST
] =
5999 {":type", IMAGE_SYMBOL_VALUE
, 1},
6000 {":data", IMAGE_STRING_VALUE
, 0},
6001 {":file", IMAGE_STRING_VALUE
, 0},
6002 {":ascent", IMAGE_ASCENT_VALUE
, 0},
6003 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
6004 {":relief", IMAGE_INTEGER_VALUE
, 0},
6005 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6006 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6007 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6008 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
6011 /* Structure describing the image type `jpeg'. */
6013 static struct image_type jpeg_type
=
6022 /* Return non-zero if OBJECT is a valid JPEG image specification. */
6025 jpeg_image_p (Lisp_Object object
)
6027 struct image_keyword fmt
[JPEG_LAST
];
6029 memcpy (fmt
, jpeg_format
, sizeof fmt
);
6031 if (!parse_image_spec (object
, fmt
, JPEG_LAST
, Qjpeg
))
6034 /* Must specify either the :data or :file keyword. */
6035 return fmt
[JPEG_FILE
].count
+ fmt
[JPEG_DATA
].count
== 1;
6038 #endif /* HAVE_JPEG || HAVE_NS */
6042 /* Work around a warning about HAVE_STDLIB_H being redefined in
6044 #ifdef HAVE_STDLIB_H
6045 #undef HAVE_STDLIB_H
6046 #endif /* HAVE_STLIB_H */
6048 #if defined (HAVE_NTGUI) && !defined (__WIN32__)
6049 /* In older releases of the jpeg library, jpeglib.h will define boolean
6050 differently depending on __WIN32__, so make sure it is defined. */
6054 #include <jpeglib.h>
6057 #ifdef HAVE_STLIB_H_1
6058 #define HAVE_STDLIB_H 1
6063 /* JPEG library details. */
6064 DEF_IMGLIB_FN (void, jpeg_CreateDecompress
, (j_decompress_ptr
, int, size_t));
6065 DEF_IMGLIB_FN (boolean
, jpeg_start_decompress
, (j_decompress_ptr
));
6066 DEF_IMGLIB_FN (boolean
, jpeg_finish_decompress
, (j_decompress_ptr
));
6067 DEF_IMGLIB_FN (void, jpeg_destroy_decompress
, (j_decompress_ptr
));
6068 DEF_IMGLIB_FN (int, jpeg_read_header
, (j_decompress_ptr
, boolean
));
6069 DEF_IMGLIB_FN (JDIMENSION
, jpeg_read_scanlines
, (j_decompress_ptr
, JSAMPARRAY
, JDIMENSION
));
6070 DEF_IMGLIB_FN (struct jpeg_error_mgr
*, jpeg_std_error
, (struct jpeg_error_mgr
*));
6071 DEF_IMGLIB_FN (boolean
, jpeg_resync_to_restart
, (j_decompress_ptr
, int));
6074 init_jpeg_functions (Lisp_Object libraries
)
6078 if (!(library
= w32_delayed_load (libraries
, Qjpeg
)))
6081 LOAD_IMGLIB_FN (library
, jpeg_finish_decompress
);
6082 LOAD_IMGLIB_FN (library
, jpeg_read_scanlines
);
6083 LOAD_IMGLIB_FN (library
, jpeg_start_decompress
);
6084 LOAD_IMGLIB_FN (library
, jpeg_read_header
);
6085 LOAD_IMGLIB_FN (library
, jpeg_CreateDecompress
);
6086 LOAD_IMGLIB_FN (library
, jpeg_destroy_decompress
);
6087 LOAD_IMGLIB_FN (library
, jpeg_std_error
);
6088 LOAD_IMGLIB_FN (library
, jpeg_resync_to_restart
);
6092 /* Wrapper since we can't directly assign the function pointer
6093 to another function pointer that was declared more completely easily. */
6095 jpeg_resync_to_restart_wrapper (j_decompress_ptr cinfo
, int desired
)
6097 return fn_jpeg_resync_to_restart (cinfo
, desired
);
6102 #define fn_jpeg_CreateDecompress(a,b,c) jpeg_create_decompress (a)
6103 #define fn_jpeg_start_decompress jpeg_start_decompress
6104 #define fn_jpeg_finish_decompress jpeg_finish_decompress
6105 #define fn_jpeg_destroy_decompress jpeg_destroy_decompress
6106 #define fn_jpeg_read_header jpeg_read_header
6107 #define fn_jpeg_read_scanlines jpeg_read_scanlines
6108 #define fn_jpeg_std_error jpeg_std_error
6109 #define jpeg_resync_to_restart_wrapper jpeg_resync_to_restart
6111 #endif /* HAVE_NTGUI */
6113 struct my_jpeg_error_mgr
6115 struct jpeg_error_mgr pub
;
6116 jmp_buf setjmp_buffer
;
6120 static _Noreturn
void
6121 my_error_exit (j_common_ptr cinfo
)
6123 struct my_jpeg_error_mgr
*mgr
= (struct my_jpeg_error_mgr
*) cinfo
->err
;
6124 longjmp (mgr
->setjmp_buffer
, 1);
6128 /* Init source method for JPEG data source manager. Called by
6129 jpeg_read_header() before any data is actually read. See
6130 libjpeg.doc from the JPEG lib distribution. */
6133 our_common_init_source (j_decompress_ptr cinfo
)
6138 /* Method to terminate data source. Called by
6139 jpeg_finish_decompress() after all data has been processed. */
6142 our_common_term_source (j_decompress_ptr cinfo
)
6147 /* Fill input buffer method for JPEG data source manager. Called
6148 whenever more data is needed. We read the whole image in one step,
6149 so this only adds a fake end of input marker at the end. */
6151 static JOCTET our_memory_buffer
[2];
6154 our_memory_fill_input_buffer (j_decompress_ptr cinfo
)
6156 /* Insert a fake EOI marker. */
6157 struct jpeg_source_mgr
*src
= cinfo
->src
;
6159 our_memory_buffer
[0] = (JOCTET
) 0xFF;
6160 our_memory_buffer
[1] = (JOCTET
) JPEG_EOI
;
6162 src
->next_input_byte
= our_memory_buffer
;
6163 src
->bytes_in_buffer
= 2;
6168 /* Method to skip over NUM_BYTES bytes in the image data. CINFO->src
6169 is the JPEG data source manager. */
6172 our_memory_skip_input_data (j_decompress_ptr cinfo
, long int num_bytes
)
6174 struct jpeg_source_mgr
*src
= (struct jpeg_source_mgr
*) cinfo
->src
;
6178 if (num_bytes
> src
->bytes_in_buffer
)
6179 ERREXIT (cinfo
, JERR_INPUT_EOF
);
6181 src
->bytes_in_buffer
-= num_bytes
;
6182 src
->next_input_byte
+= num_bytes
;
6187 /* Set up the JPEG lib for reading an image from DATA which contains
6188 LEN bytes. CINFO is the decompression info structure created for
6189 reading the image. */
6192 jpeg_memory_src (j_decompress_ptr cinfo
, JOCTET
*data
, unsigned int len
)
6194 struct jpeg_source_mgr
*src
;
6196 if (cinfo
->src
== NULL
)
6198 /* First time for this JPEG object? */
6199 cinfo
->src
= (struct jpeg_source_mgr
*)
6200 (*cinfo
->mem
->alloc_small
) ((j_common_ptr
) cinfo
, JPOOL_PERMANENT
,
6201 sizeof (struct jpeg_source_mgr
));
6202 src
= (struct jpeg_source_mgr
*) cinfo
->src
;
6203 src
->next_input_byte
= data
;
6206 src
= (struct jpeg_source_mgr
*) cinfo
->src
;
6207 src
->init_source
= our_common_init_source
;
6208 src
->fill_input_buffer
= our_memory_fill_input_buffer
;
6209 src
->skip_input_data
= our_memory_skip_input_data
;
6210 src
->resync_to_restart
= jpeg_resync_to_restart_wrapper
; /* Use default method. */
6211 src
->term_source
= our_common_term_source
;
6212 src
->bytes_in_buffer
= len
;
6213 src
->next_input_byte
= data
;
6217 struct jpeg_stdio_mgr
6219 struct jpeg_source_mgr mgr
;
6226 /* Size of buffer to read JPEG from file.
6227 Not too big, as we want to use alloc_small. */
6228 #define JPEG_STDIO_BUFFER_SIZE 8192
6231 /* Fill input buffer method for JPEG data source manager. Called
6232 whenever more data is needed. The data is read from a FILE *. */
6235 our_stdio_fill_input_buffer (j_decompress_ptr cinfo
)
6237 struct jpeg_stdio_mgr
*src
;
6239 src
= (struct jpeg_stdio_mgr
*) cinfo
->src
;
6244 bytes
= fread (src
->buffer
, 1, JPEG_STDIO_BUFFER_SIZE
, src
->file
);
6246 src
->mgr
.bytes_in_buffer
= bytes
;
6249 WARNMS (cinfo
, JWRN_JPEG_EOF
);
6251 src
->buffer
[0] = (JOCTET
) 0xFF;
6252 src
->buffer
[1] = (JOCTET
) JPEG_EOI
;
6253 src
->mgr
.bytes_in_buffer
= 2;
6255 src
->mgr
.next_input_byte
= src
->buffer
;
6262 /* Method to skip over NUM_BYTES bytes in the image data. CINFO->src
6263 is the JPEG data source manager. */
6266 our_stdio_skip_input_data (j_decompress_ptr cinfo
, long int num_bytes
)
6268 struct jpeg_stdio_mgr
*src
;
6269 src
= (struct jpeg_stdio_mgr
*) cinfo
->src
;
6271 while (num_bytes
> 0 && !src
->finished
)
6273 if (num_bytes
<= src
->mgr
.bytes_in_buffer
)
6275 src
->mgr
.bytes_in_buffer
-= num_bytes
;
6276 src
->mgr
.next_input_byte
+= num_bytes
;
6281 num_bytes
-= src
->mgr
.bytes_in_buffer
;
6282 src
->mgr
.bytes_in_buffer
= 0;
6283 src
->mgr
.next_input_byte
= NULL
;
6285 our_stdio_fill_input_buffer (cinfo
);
6291 /* Set up the JPEG lib for reading an image from a FILE *.
6292 CINFO is the decompression info structure created for
6293 reading the image. */
6296 jpeg_file_src (j_decompress_ptr cinfo
, FILE *fp
)
6298 struct jpeg_stdio_mgr
*src
;
6300 if (cinfo
->src
!= NULL
)
6301 src
= (struct jpeg_stdio_mgr
*) cinfo
->src
;
6304 /* First time for this JPEG object? */
6305 cinfo
->src
= (struct jpeg_source_mgr
*)
6306 (*cinfo
->mem
->alloc_small
) ((j_common_ptr
) cinfo
, JPOOL_PERMANENT
,
6307 sizeof (struct jpeg_stdio_mgr
));
6308 src
= (struct jpeg_stdio_mgr
*) cinfo
->src
;
6309 src
->buffer
= (JOCTET
*)
6310 (*cinfo
->mem
->alloc_small
) ((j_common_ptr
) cinfo
, JPOOL_PERMANENT
,
6311 JPEG_STDIO_BUFFER_SIZE
);
6316 src
->mgr
.init_source
= our_common_init_source
;
6317 src
->mgr
.fill_input_buffer
= our_stdio_fill_input_buffer
;
6318 src
->mgr
.skip_input_data
= our_stdio_skip_input_data
;
6319 src
->mgr
.resync_to_restart
= jpeg_resync_to_restart_wrapper
; /* Use default method. */
6320 src
->mgr
.term_source
= our_common_term_source
;
6321 src
->mgr
.bytes_in_buffer
= 0;
6322 src
->mgr
.next_input_byte
= NULL
;
6326 /* Load image IMG for use on frame F. Patterned after example.c
6327 from the JPEG lib. */
6330 jpeg_load (struct frame
*f
, struct image
*img
)
6332 struct jpeg_decompress_struct cinfo
;
6333 struct my_jpeg_error_mgr mgr
;
6334 Lisp_Object file
, specified_file
;
6335 Lisp_Object specified_data
;
6336 FILE * volatile fp
= NULL
;
6338 int row_stride
, x
, y
;
6339 XImagePtr ximg
= NULL
;
6341 unsigned long *colors
;
6344 /* Open the JPEG file. */
6345 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
6346 specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
6348 if (NILP (specified_data
))
6350 file
= x_find_image_file (specified_file
);
6351 if (!STRINGP (file
))
6353 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
6357 fp
= fopen (SSDATA (file
), "rb");
6360 image_error ("Cannot open `%s'", file
, Qnil
);
6364 else if (!STRINGP (specified_data
))
6366 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
6370 /* Customize libjpeg's error handling to call my_error_exit when an
6371 error is detected. This function will perform a longjmp. */
6372 cinfo
.err
= fn_jpeg_std_error (&mgr
.pub
);
6373 mgr
.pub
.error_exit
= my_error_exit
;
6375 if ((rc
= setjmp (mgr
.setjmp_buffer
)) != 0)
6379 /* Called from my_error_exit. Display a JPEG error. */
6380 char buf
[JMSG_LENGTH_MAX
];
6381 cinfo
.err
->format_message ((j_common_ptr
) &cinfo
, buf
);
6382 image_error ("Error reading JPEG image `%s': %s", img
->spec
,
6383 build_string (buf
));
6386 /* Close the input file and destroy the JPEG object. */
6388 fclose ((FILE *) fp
);
6389 fn_jpeg_destroy_decompress (&cinfo
);
6391 /* If we already have an XImage, free that. */
6392 x_destroy_x_image (ximg
);
6394 /* Free pixmap and colors. */
6395 x_clear_image (f
, img
);
6399 /* Create the JPEG decompression object. Let it read from fp.
6400 Read the JPEG image header. */
6401 fn_jpeg_CreateDecompress (&cinfo
, JPEG_LIB_VERSION
, sizeof (cinfo
));
6403 if (NILP (specified_data
))
6404 jpeg_file_src (&cinfo
, (FILE *) fp
);
6406 jpeg_memory_src (&cinfo
, SDATA (specified_data
),
6407 SBYTES (specified_data
));
6409 fn_jpeg_read_header (&cinfo
, 1);
6411 /* Customize decompression so that color quantization will be used.
6412 Start decompression. */
6413 cinfo
.quantize_colors
= 1;
6414 fn_jpeg_start_decompress (&cinfo
);
6415 width
= img
->width
= cinfo
.output_width
;
6416 height
= img
->height
= cinfo
.output_height
;
6418 if (!check_image_size (f
, width
, height
))
6420 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
6421 longjmp (mgr
.setjmp_buffer
, 2);
6424 /* Create X image and pixmap. */
6425 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0, &ximg
, &img
->pixmap
))
6426 longjmp (mgr
.setjmp_buffer
, 2);
6428 /* Allocate colors. When color quantization is used,
6429 cinfo.actual_number_of_colors has been set with the number of
6430 colors generated, and cinfo.colormap is a two-dimensional array
6431 of color indices in the range 0..cinfo.actual_number_of_colors.
6432 No more than 255 colors will be generated. */
6436 if (cinfo
.out_color_components
> 2)
6437 ir
= 0, ig
= 1, ib
= 2;
6438 else if (cinfo
.out_color_components
> 1)
6439 ir
= 0, ig
= 1, ib
= 0;
6441 ir
= 0, ig
= 0, ib
= 0;
6443 /* Use the color table mechanism because it handles colors that
6444 cannot be allocated nicely. Such colors will be replaced with
6445 a default color, and we don't have to care about which colors
6446 can be freed safely, and which can't. */
6447 init_color_table ();
6448 colors
= alloca (cinfo
.actual_number_of_colors
* sizeof *colors
);
6450 for (i
= 0; i
< cinfo
.actual_number_of_colors
; ++i
)
6452 /* Multiply RGB values with 255 because X expects RGB values
6453 in the range 0..0xffff. */
6454 int r
= cinfo
.colormap
[ir
][i
] << 8;
6455 int g
= cinfo
.colormap
[ig
][i
] << 8;
6456 int b
= cinfo
.colormap
[ib
][i
] << 8;
6457 colors
[i
] = lookup_rgb_color (f
, r
, g
, b
);
6460 #ifdef COLOR_TABLE_SUPPORT
6461 /* Remember those colors actually allocated. */
6462 img
->colors
= colors_in_color_table (&img
->ncolors
);
6463 free_color_table ();
6464 #endif /* COLOR_TABLE_SUPPORT */
6468 row_stride
= width
* cinfo
.output_components
;
6469 buffer
= cinfo
.mem
->alloc_sarray ((j_common_ptr
) &cinfo
, JPOOL_IMAGE
,
6471 for (y
= 0; y
< height
; ++y
)
6473 fn_jpeg_read_scanlines (&cinfo
, buffer
, 1);
6474 for (x
= 0; x
< cinfo
.output_width
; ++x
)
6475 XPutPixel (ximg
, x
, y
, colors
[buffer
[0][x
]]);
6479 fn_jpeg_finish_decompress (&cinfo
);
6480 fn_jpeg_destroy_decompress (&cinfo
);
6482 fclose ((FILE *) fp
);
6484 /* Maybe fill in the background field while we have ximg handy. */
6485 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
6486 /* Casting avoids a GCC warning. */
6487 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
6489 /* Put the image into the pixmap. */
6490 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
6491 x_destroy_x_image (ximg
);
6495 #else /* HAVE_JPEG */
6499 jpeg_load (struct frame
*f
, struct image
*img
)
6501 return ns_load_image (f
, img
,
6502 image_spec_value (img
->spec
, QCfile
, NULL
),
6503 image_spec_value (img
->spec
, QCdata
, NULL
));
6505 #endif /* HAVE_NS */
6507 #endif /* !HAVE_JPEG */
6511 /***********************************************************************
6513 ***********************************************************************/
6515 #if defined (HAVE_TIFF) || defined (HAVE_NS)
6517 static int tiff_image_p (Lisp_Object object
);
6518 static int tiff_load (struct frame
*f
, struct image
*img
);
6520 /* The symbol `tiff' identifying images of this type. */
6522 static Lisp_Object Qtiff
;
6524 /* Indices of image specification fields in tiff_format, below. */
6526 enum tiff_keyword_index
6535 TIFF_HEURISTIC_MASK
,
6542 /* Vector of image_keyword structures describing the format
6543 of valid user-defined image specifications. */
6545 static const struct image_keyword tiff_format
[TIFF_LAST
] =
6547 {":type", IMAGE_SYMBOL_VALUE
, 1},
6548 {":data", IMAGE_STRING_VALUE
, 0},
6549 {":file", IMAGE_STRING_VALUE
, 0},
6550 {":ascent", IMAGE_ASCENT_VALUE
, 0},
6551 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
6552 {":relief", IMAGE_INTEGER_VALUE
, 0},
6553 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6554 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6555 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6556 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0},
6557 {":index", IMAGE_NON_NEGATIVE_INTEGER_VALUE
, 0}
6560 /* Structure describing the image type `tiff'. */
6562 static struct image_type tiff_type
=
6571 /* Return non-zero if OBJECT is a valid TIFF image specification. */
6574 tiff_image_p (Lisp_Object object
)
6576 struct image_keyword fmt
[TIFF_LAST
];
6577 memcpy (fmt
, tiff_format
, sizeof fmt
);
6579 if (!parse_image_spec (object
, fmt
, TIFF_LAST
, Qtiff
))
6582 /* Must specify either the :data or :file keyword. */
6583 return fmt
[TIFF_FILE
].count
+ fmt
[TIFF_DATA
].count
== 1;
6586 #endif /* HAVE_TIFF || HAVE_NS */
6594 /* TIFF library details. */
6595 DEF_IMGLIB_FN (TIFFErrorHandler
, TIFFSetErrorHandler
, (TIFFErrorHandler
));
6596 DEF_IMGLIB_FN (TIFFErrorHandler
, TIFFSetWarningHandler
, (TIFFErrorHandler
));
6597 DEF_IMGLIB_FN (TIFF
*, TIFFOpen
, (const char *, const char *));
6598 DEF_IMGLIB_FN (TIFF
*, TIFFClientOpen
, (const char *, const char *, thandle_t
,
6599 TIFFReadWriteProc
, TIFFReadWriteProc
,
6600 TIFFSeekProc
, TIFFCloseProc
, TIFFSizeProc
,
6601 TIFFMapFileProc
, TIFFUnmapFileProc
));
6602 DEF_IMGLIB_FN (int, TIFFGetField
, (TIFF
*, ttag_t
, ...));
6603 DEF_IMGLIB_FN (int, TIFFReadRGBAImage
, (TIFF
*, uint32
, uint32
, uint32
*, int));
6604 DEF_IMGLIB_FN (void, TIFFClose
, (TIFF
*));
6605 DEF_IMGLIB_FN (int, TIFFSetDirectory
, (TIFF
*, tdir_t
));
6608 init_tiff_functions (Lisp_Object libraries
)
6612 if (!(library
= w32_delayed_load (libraries
, Qtiff
)))
6615 LOAD_IMGLIB_FN (library
, TIFFSetErrorHandler
);
6616 LOAD_IMGLIB_FN (library
, TIFFSetWarningHandler
);
6617 LOAD_IMGLIB_FN (library
, TIFFOpen
);
6618 LOAD_IMGLIB_FN (library
, TIFFClientOpen
);
6619 LOAD_IMGLIB_FN (library
, TIFFGetField
);
6620 LOAD_IMGLIB_FN (library
, TIFFReadRGBAImage
);
6621 LOAD_IMGLIB_FN (library
, TIFFClose
);
6622 LOAD_IMGLIB_FN (library
, TIFFSetDirectory
);
6628 #define fn_TIFFSetErrorHandler TIFFSetErrorHandler
6629 #define fn_TIFFSetWarningHandler TIFFSetWarningHandler
6630 #define fn_TIFFOpen TIFFOpen
6631 #define fn_TIFFClientOpen TIFFClientOpen
6632 #define fn_TIFFGetField TIFFGetField
6633 #define fn_TIFFReadRGBAImage TIFFReadRGBAImage
6634 #define fn_TIFFClose TIFFClose
6635 #define fn_TIFFSetDirectory TIFFSetDirectory
6636 #endif /* HAVE_NTGUI */
6639 /* Reading from a memory buffer for TIFF images Based on the PNG
6640 memory source, but we have to provide a lot of extra functions.
6643 We really only need to implement read and seek, but I am not
6644 convinced that the TIFF library is smart enough not to destroy
6645 itself if we only hand it the function pointers we need to
6650 unsigned char *bytes
;
6657 tiff_read_from_memory (thandle_t data
, tdata_t buf
, tsize_t size
)
6659 tiff_memory_source
*src
= (tiff_memory_source
*) data
;
6661 size
= min (size
, src
->len
- src
->index
);
6662 memcpy (buf
, src
->bytes
+ src
->index
, size
);
6668 tiff_write_from_memory (thandle_t data
, tdata_t buf
, tsize_t size
)
6674 tiff_seek_in_memory (thandle_t data
, toff_t off
, int whence
)
6676 tiff_memory_source
*src
= (tiff_memory_source
*) data
;
6681 case SEEK_SET
: /* Go from beginning of source. */
6685 case SEEK_END
: /* Go from end of source. */
6686 idx
= src
->len
+ off
;
6689 case SEEK_CUR
: /* Go from current position. */
6690 idx
= src
->index
+ off
;
6693 default: /* Invalid `whence'. */
6697 if (idx
> src
->len
|| idx
< 0)
6705 tiff_close_memory (thandle_t data
)
6712 tiff_mmap_memory (thandle_t data
, tdata_t
*pbase
, toff_t
*psize
)
6714 /* It is already _IN_ memory. */
6719 tiff_unmap_memory (thandle_t data
, tdata_t base
, toff_t size
)
6721 /* We don't need to do this. */
6725 tiff_size_of_memory (thandle_t data
)
6727 return ((tiff_memory_source
*) data
)->len
;
6730 /* GCC 3.x on x86 Windows targets has a bug that triggers an internal
6731 compiler error compiling tiff_handler, see Bugzilla bug #17406
6732 (http://gcc.gnu.org/bugzilla/show_bug.cgi?id=17406). Declaring
6733 this function as external works around that problem. */
6734 #if defined (__MINGW32__) && __GNUC__ == 3
6735 # define MINGW_STATIC
6737 # define MINGW_STATIC static
6741 tiff_handler (const char *, const char *, const char *, va_list)
6742 ATTRIBUTE_FORMAT_PRINTF (3, 0);
6744 tiff_handler (const char *log_format
, const char *title
,
6745 const char *format
, va_list ap
)
6747 /* doprnt is not suitable here, as TIFF handlers are called from
6748 libtiff and are passed arbitrary printf directives. Instead, use
6749 vsnprintf, taking care to be portable to nonstandard environments
6750 where vsnprintf returns -1 on buffer overflow. Since it's just a
6751 log entry, it's OK to truncate it. */
6753 int len
= vsnprintf (buf
, sizeof buf
, format
, ap
);
6754 add_to_log (log_format
, build_string (title
),
6755 make_string (buf
, max (0, min (len
, sizeof buf
- 1))));
6759 static void tiff_error_handler (const char *, const char *, va_list)
6760 ATTRIBUTE_FORMAT_PRINTF (2, 0);
6762 tiff_error_handler (const char *title
, const char *format
, va_list ap
)
6764 tiff_handler ("TIFF error: %s %s", title
, format
, ap
);
6768 static void tiff_warning_handler (const char *, const char *, va_list)
6769 ATTRIBUTE_FORMAT_PRINTF (2, 0);
6771 tiff_warning_handler (const char *title
, const char *format
, va_list ap
)
6773 tiff_handler ("TIFF warning: %s %s", title
, format
, ap
);
6777 /* Load TIFF image IMG for use on frame F. Value is non-zero if
6781 tiff_load (struct frame
*f
, struct image
*img
)
6783 Lisp_Object file
, specified_file
;
6784 Lisp_Object specified_data
;
6786 int width
, height
, x
, y
, count
;
6790 tiff_memory_source memsrc
;
6793 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
6794 specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
6796 fn_TIFFSetErrorHandler ((TIFFErrorHandler
) tiff_error_handler
);
6797 fn_TIFFSetWarningHandler ((TIFFErrorHandler
) tiff_warning_handler
);
6799 if (NILP (specified_data
))
6801 /* Read from a file */
6802 file
= x_find_image_file (specified_file
);
6803 if (!STRINGP (file
))
6805 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
6809 /* Try to open the image file. */
6810 tiff
= fn_TIFFOpen (SSDATA (file
), "r");
6813 image_error ("Cannot open `%s'", file
, Qnil
);
6819 if (!STRINGP (specified_data
))
6821 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
6825 /* Memory source! */
6826 memsrc
.bytes
= SDATA (specified_data
);
6827 memsrc
.len
= SBYTES (specified_data
);
6830 tiff
= fn_TIFFClientOpen ("memory_source", "r", (thandle_t
)&memsrc
,
6831 tiff_read_from_memory
,
6832 tiff_write_from_memory
,
6833 tiff_seek_in_memory
,
6835 tiff_size_of_memory
,
6841 image_error ("Cannot open memory source for `%s'", img
->spec
, Qnil
);
6846 image
= image_spec_value (img
->spec
, QCindex
, NULL
);
6847 if (INTEGERP (image
))
6849 EMACS_INT ino
= XFASTINT (image
);
6850 if (! (TYPE_MINIMUM (tdir_t
) <= ino
&& ino
<= TYPE_MAXIMUM (tdir_t
)
6851 && fn_TIFFSetDirectory (tiff
, ino
)))
6853 image_error ("Invalid image number `%s' in image `%s'",
6855 fn_TIFFClose (tiff
);
6860 /* Get width and height of the image, and allocate a raster buffer
6861 of width x height 32-bit values. */
6862 fn_TIFFGetField (tiff
, TIFFTAG_IMAGEWIDTH
, &width
);
6863 fn_TIFFGetField (tiff
, TIFFTAG_IMAGELENGTH
, &height
);
6865 if (!check_image_size (f
, width
, height
))
6867 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
6868 fn_TIFFClose (tiff
);
6872 /* Create the X image and pixmap. */
6873 if (! (height
<= min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *buf
/ width
6874 && x_create_x_image_and_pixmap (f
, width
, height
, 0,
6875 &ximg
, &img
->pixmap
)))
6877 fn_TIFFClose (tiff
);
6881 buf
= xmalloc (sizeof *buf
* width
* height
);
6883 rc
= fn_TIFFReadRGBAImage (tiff
, width
, height
, buf
, 0);
6885 /* Count the number of images in the file. */
6886 for (count
= 1; fn_TIFFSetDirectory (tiff
, count
); count
++)
6890 img
->lisp_data
= Fcons (Qcount
,
6891 Fcons (make_number (count
),
6894 fn_TIFFClose (tiff
);
6897 image_error ("Error reading TIFF image `%s'", img
->spec
, Qnil
);
6902 /* Initialize the color table. */
6903 init_color_table ();
6905 /* Process the pixel raster. Origin is in the lower-left corner. */
6906 for (y
= 0; y
< height
; ++y
)
6908 uint32
*row
= buf
+ y
* width
;
6910 for (x
= 0; x
< width
; ++x
)
6912 uint32 abgr
= row
[x
];
6913 int r
= TIFFGetR (abgr
) << 8;
6914 int g
= TIFFGetG (abgr
) << 8;
6915 int b
= TIFFGetB (abgr
) << 8;
6916 XPutPixel (ximg
, x
, height
- 1 - y
, lookup_rgb_color (f
, r
, g
, b
));
6920 #ifdef COLOR_TABLE_SUPPORT
6921 /* Remember the colors allocated for the image. Free the color table. */
6922 img
->colors
= colors_in_color_table (&img
->ncolors
);
6923 free_color_table ();
6924 #endif /* COLOR_TABLE_SUPPORT */
6927 img
->height
= height
;
6929 /* Maybe fill in the background field while we have ximg handy. */
6930 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
6931 /* Casting avoids a GCC warning on W32. */
6932 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
6934 /* Put the image into the pixmap, then free the X image and its buffer. */
6935 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
6936 x_destroy_x_image (ximg
);
6942 #else /* HAVE_TIFF */
6946 tiff_load (struct frame
*f
, struct image
*img
)
6948 return ns_load_image (f
, img
,
6949 image_spec_value (img
->spec
, QCfile
, NULL
),
6950 image_spec_value (img
->spec
, QCdata
, NULL
));
6952 #endif /* HAVE_NS */
6954 #endif /* !HAVE_TIFF */
6958 /***********************************************************************
6960 ***********************************************************************/
6962 #if defined (HAVE_GIF) || defined (HAVE_NS)
6964 static int gif_image_p (Lisp_Object object
);
6965 static int gif_load (struct frame
*f
, struct image
*img
);
6966 static void gif_clear_image (struct frame
*f
, struct image
*img
);
6968 /* The symbol `gif' identifying images of this type. */
6970 static Lisp_Object Qgif
;
6972 /* Indices of image specification fields in gif_format, below. */
6974 enum gif_keyword_index
6990 /* Vector of image_keyword structures describing the format
6991 of valid user-defined image specifications. */
6993 static const struct image_keyword gif_format
[GIF_LAST
] =
6995 {":type", IMAGE_SYMBOL_VALUE
, 1},
6996 {":data", IMAGE_STRING_VALUE
, 0},
6997 {":file", IMAGE_STRING_VALUE
, 0},
6998 {":ascent", IMAGE_ASCENT_VALUE
, 0},
6999 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
7000 {":relief", IMAGE_INTEGER_VALUE
, 0},
7001 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7002 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7003 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7004 {":index", IMAGE_NON_NEGATIVE_INTEGER_VALUE
, 0},
7005 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
7008 /* Structure describing the image type `gif'. */
7010 static struct image_type gif_type
=
7019 /* Free X resources of GIF image IMG which is used on frame F. */
7022 gif_clear_image (struct frame
*f
, struct image
*img
)
7024 img
->lisp_data
= Qnil
;
7025 x_clear_image (f
, img
);
7028 /* Return non-zero if OBJECT is a valid GIF image specification. */
7031 gif_image_p (Lisp_Object object
)
7033 struct image_keyword fmt
[GIF_LAST
];
7034 memcpy (fmt
, gif_format
, sizeof fmt
);
7036 if (!parse_image_spec (object
, fmt
, GIF_LAST
, Qgif
))
7039 /* Must specify either the :data or :file keyword. */
7040 return fmt
[GIF_FILE
].count
+ fmt
[GIF_DATA
].count
== 1;
7043 #endif /* HAVE_GIF */
7047 #if defined (HAVE_NTGUI)
7048 /* winuser.h might define DrawText to DrawTextA or DrawTextW.
7049 Undefine before redefining to avoid a preprocessor warning. */
7053 /* avoid conflict with QuickdrawText.h */
7054 #define DrawText gif_DrawText
7055 #include <gif_lib.h>
7058 #else /* HAVE_NTGUI */
7060 #include <gif_lib.h>
7062 #endif /* HAVE_NTGUI */
7067 /* GIF library details. */
7068 DEF_IMGLIB_FN (int, DGifCloseFile
, (GifFileType
*));
7069 DEF_IMGLIB_FN (int, DGifSlurp
, (GifFileType
*));
7070 DEF_IMGLIB_FN (GifFileType
*, DGifOpen
, (void *, InputFunc
));
7071 DEF_IMGLIB_FN (GifFileType
*, DGifOpenFileName
, (const char *));
7074 init_gif_functions (Lisp_Object libraries
)
7078 if (!(library
= w32_delayed_load (libraries
, Qgif
)))
7081 LOAD_IMGLIB_FN (library
, DGifCloseFile
);
7082 LOAD_IMGLIB_FN (library
, DGifSlurp
);
7083 LOAD_IMGLIB_FN (library
, DGifOpen
);
7084 LOAD_IMGLIB_FN (library
, DGifOpenFileName
);
7090 #define fn_DGifCloseFile DGifCloseFile
7091 #define fn_DGifSlurp DGifSlurp
7092 #define fn_DGifOpen DGifOpen
7093 #define fn_DGifOpenFileName DGifOpenFileName
7095 #endif /* HAVE_NTGUI */
7097 /* Reading a GIF image from memory
7098 Based on the PNG memory stuff to a certain extent. */
7102 unsigned char *bytes
;
7108 /* Make the current memory source available to gif_read_from_memory.
7109 It's done this way because not all versions of libungif support
7110 a UserData field in the GifFileType structure. */
7111 static gif_memory_source
*current_gif_memory_src
;
7114 gif_read_from_memory (GifFileType
*file
, GifByteType
*buf
, int len
)
7116 gif_memory_source
*src
= current_gif_memory_src
;
7118 if (len
> src
->len
- src
->index
)
7121 memcpy (buf
, src
->bytes
+ src
->index
, len
);
7127 /* Load GIF image IMG for use on frame F. Value is non-zero if
7130 static const int interlace_start
[] = {0, 4, 2, 1};
7131 static const int interlace_increment
[] = {8, 8, 4, 2};
7133 #define GIF_LOCAL_DESCRIPTOR_EXTENSION 249
7136 gif_load (struct frame
*f
, struct image
*img
)
7139 int rc
, width
, height
, x
, y
, i
, j
;
7141 ColorMapObject
*gif_color_map
;
7142 unsigned long pixel_colors
[256];
7144 gif_memory_source memsrc
;
7145 Lisp_Object specified_bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
7146 Lisp_Object specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
7147 Lisp_Object specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
7148 unsigned long bgcolor
= 0;
7151 if (NILP (specified_data
))
7153 file
= x_find_image_file (specified_file
);
7154 if (!STRINGP (file
))
7156 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
7160 /* Open the GIF file. */
7161 gif
= fn_DGifOpenFileName (SSDATA (file
));
7164 image_error ("Cannot open `%s'", file
, Qnil
);
7170 if (!STRINGP (specified_data
))
7172 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
7176 /* Read from memory! */
7177 current_gif_memory_src
= &memsrc
;
7178 memsrc
.bytes
= SDATA (specified_data
);
7179 memsrc
.len
= SBYTES (specified_data
);
7182 gif
= fn_DGifOpen (&memsrc
, gif_read_from_memory
);
7185 image_error ("Cannot open memory source `%s'", img
->spec
, Qnil
);
7190 /* Before reading entire contents, check the declared image size. */
7191 if (!check_image_size (f
, gif
->SWidth
, gif
->SHeight
))
7193 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
7194 fn_DGifCloseFile (gif
);
7198 /* Read entire contents. */
7199 rc
= fn_DGifSlurp (gif
);
7200 if (rc
== GIF_ERROR
|| gif
->ImageCount
<= 0)
7202 image_error ("Error reading `%s'", img
->spec
, Qnil
);
7203 fn_DGifCloseFile (gif
);
7207 /* Which sub-image are we to display? */
7209 Lisp_Object image_number
= image_spec_value (img
->spec
, QCindex
, NULL
);
7210 idx
= INTEGERP (image_number
) ? XFASTINT (image_number
) : 0;
7211 if (idx
< 0 || idx
>= gif
->ImageCount
)
7213 image_error ("Invalid image number `%s' in image `%s'",
7214 image_number
, img
->spec
);
7215 fn_DGifCloseFile (gif
);
7220 width
= img
->width
= gif
->SWidth
;
7221 height
= img
->height
= gif
->SHeight
;
7223 img
->corners
[TOP_CORNER
] = gif
->SavedImages
[0].ImageDesc
.Top
;
7224 img
->corners
[LEFT_CORNER
] = gif
->SavedImages
[0].ImageDesc
.Left
;
7225 img
->corners
[BOT_CORNER
]
7226 = img
->corners
[TOP_CORNER
] + gif
->SavedImages
[0].ImageDesc
.Height
;
7227 img
->corners
[RIGHT_CORNER
]
7228 = img
->corners
[LEFT_CORNER
] + gif
->SavedImages
[0].ImageDesc
.Width
;
7230 if (!check_image_size (f
, width
, height
))
7232 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
7233 fn_DGifCloseFile (gif
);
7237 /* Create the X image and pixmap. */
7238 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0, &ximg
, &img
->pixmap
))
7240 fn_DGifCloseFile (gif
);
7244 /* Clear the part of the screen image not covered by the image.
7245 Full animated GIF support requires more here (see the gif89 spec,
7246 disposal methods). Let's simply assume that the part not covered
7247 by a sub-image is in the frame's background color. */
7248 for (y
= 0; y
< img
->corners
[TOP_CORNER
]; ++y
)
7249 for (x
= 0; x
< width
; ++x
)
7250 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7252 for (y
= img
->corners
[BOT_CORNER
]; y
< height
; ++y
)
7253 for (x
= 0; x
< width
; ++x
)
7254 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7256 for (y
= img
->corners
[TOP_CORNER
]; y
< img
->corners
[BOT_CORNER
]; ++y
)
7258 for (x
= 0; x
< img
->corners
[LEFT_CORNER
]; ++x
)
7259 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7260 for (x
= img
->corners
[RIGHT_CORNER
]; x
< width
; ++x
)
7261 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7264 /* Read the GIF image into the X image. */
7266 /* FIXME: With the current implementation, loading an animated gif
7267 is quadratic in the number of animation frames, since each frame
7268 is a separate struct image. We must provide a way for a single
7269 gif_load call to construct and save all animation frames. */
7271 init_color_table ();
7272 if (STRINGP (specified_bg
))
7273 bgcolor
= x_alloc_image_color (f
, img
, specified_bg
,
7274 FRAME_BACKGROUND_PIXEL (f
));
7275 for (j
= 0; j
<= idx
; ++j
)
7277 /* We use a local variable `raster' here because RasterBits is a
7278 char *, which invites problems with bytes >= 0x80. */
7279 struct SavedImage
*subimage
= gif
->SavedImages
+ j
;
7280 unsigned char *raster
= (unsigned char *) subimage
->RasterBits
;
7281 int transparency_color_index
= -1;
7283 int subimg_width
= subimage
->ImageDesc
.Width
;
7284 int subimg_height
= subimage
->ImageDesc
.Height
;
7285 int subimg_top
= subimage
->ImageDesc
.Top
;
7286 int subimg_left
= subimage
->ImageDesc
.Left
;
7288 /* Find the Graphic Control Extension block for this sub-image.
7289 Extract the disposal method and transparency color. */
7290 for (i
= 0; i
< subimage
->ExtensionBlockCount
; i
++)
7292 ExtensionBlock
*extblock
= subimage
->ExtensionBlocks
+ i
;
7294 if ((extblock
->Function
== GIF_LOCAL_DESCRIPTOR_EXTENSION
)
7295 && extblock
->ByteCount
== 4
7296 && extblock
->Bytes
[0] & 1)
7298 /* From gif89a spec: 1 = "keep in place", 2 = "restore
7299 to background". Treat any other value like 2. */
7300 disposal
= (extblock
->Bytes
[0] >> 2) & 7;
7301 transparency_color_index
= (unsigned char) extblock
->Bytes
[3];
7306 /* We can't "keep in place" the first subimage. */
7310 /* For disposal == 0, the spec says "No disposal specified. The
7311 decoder is not required to take any action." In practice, it
7312 seems we need to treat this like "keep in place", see e.g.
7313 http://upload.wikimedia.org/wikipedia/commons/3/37/Clock.gif */
7317 /* Allocate subimage colors. */
7318 memset (pixel_colors
, 0, sizeof pixel_colors
);
7319 gif_color_map
= subimage
->ImageDesc
.ColorMap
;
7321 gif_color_map
= gif
->SColorMap
;
7324 for (i
= 0; i
< gif_color_map
->ColorCount
; ++i
)
7326 if (transparency_color_index
== i
)
7327 pixel_colors
[i
] = STRINGP (specified_bg
)
7328 ? bgcolor
: FRAME_BACKGROUND_PIXEL (f
);
7331 int r
= gif_color_map
->Colors
[i
].Red
<< 8;
7332 int g
= gif_color_map
->Colors
[i
].Green
<< 8;
7333 int b
= gif_color_map
->Colors
[i
].Blue
<< 8;
7334 pixel_colors
[i
] = lookup_rgb_color (f
, r
, g
, b
);
7338 /* Apply the pixel values. */
7339 if (gif
->SavedImages
[j
].ImageDesc
.Interlace
)
7343 for (y
= 0, row
= interlace_start
[0], pass
= 0;
7345 y
++, row
+= interlace_increment
[pass
])
7347 if (row
>= subimg_height
)
7349 row
= interlace_start
[++pass
];
7350 while (row
>= subimg_height
)
7351 row
= interlace_start
[++pass
];
7354 for (x
= 0; x
< subimg_width
; x
++)
7356 int c
= raster
[y
* subimg_width
+ x
];
7357 if (transparency_color_index
!= c
|| disposal
!= 1)
7358 XPutPixel (ximg
, x
+ subimg_left
, row
+ subimg_top
,
7365 for (y
= 0; y
< subimg_height
; ++y
)
7366 for (x
= 0; x
< subimg_width
; ++x
)
7368 int c
= raster
[y
* subimg_width
+ x
];
7369 if (transparency_color_index
!= c
|| disposal
!= 1)
7370 XPutPixel (ximg
, x
+ subimg_left
, y
+ subimg_top
,
7376 #ifdef COLOR_TABLE_SUPPORT
7377 img
->colors
= colors_in_color_table (&img
->ncolors
);
7378 free_color_table ();
7379 #endif /* COLOR_TABLE_SUPPORT */
7381 /* Save GIF image extension data for `image-metadata'.
7382 Format is (count IMAGES extension-data (FUNCTION "BYTES" ...)). */
7383 img
->lisp_data
= Qnil
;
7384 if (gif
->SavedImages
[idx
].ExtensionBlockCount
> 0)
7387 ExtensionBlock
*ext
= gif
->SavedImages
[idx
].ExtensionBlocks
;
7388 for (i
= 0; i
< gif
->SavedImages
[idx
].ExtensionBlockCount
; i
++, ext
++)
7389 /* Append (... FUNCTION "BYTES") */
7392 = Fcons (make_number (ext
->Function
),
7393 Fcons (make_unibyte_string (ext
->Bytes
, ext
->ByteCount
),
7395 if (ext
->Function
== GIF_LOCAL_DESCRIPTOR_EXTENSION
7396 && ext
->ByteCount
== 4)
7398 delay
= ext
->Bytes
[2] << CHAR_BIT
;
7399 delay
|= ext
->Bytes
[1];
7402 img
->lisp_data
= Fcons (Qextension_data
,
7403 Fcons (img
->lisp_data
, Qnil
));
7407 Fcons (make_float (delay
/ 100.0),
7411 if (gif
->ImageCount
> 1)
7412 img
->lisp_data
= Fcons (Qcount
,
7413 Fcons (make_number (gif
->ImageCount
),
7416 fn_DGifCloseFile (gif
);
7418 /* Maybe fill in the background field while we have ximg handy. */
7419 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
7420 /* Casting avoids a GCC warning. */
7421 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
7423 /* Put the image into the pixmap, then free the X image and its buffer. */
7424 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
7425 x_destroy_x_image (ximg
);
7430 #else /* !HAVE_GIF */
7434 gif_load (struct frame
*f
, struct image
*img
)
7436 return ns_load_image (f
, img
,
7437 image_spec_value (img
->spec
, QCfile
, NULL
),
7438 image_spec_value (img
->spec
, QCdata
, NULL
));
7440 #endif /* HAVE_NS */
7442 #endif /* HAVE_GIF */
7445 /***********************************************************************
7447 ***********************************************************************/
7448 #if defined (HAVE_IMAGEMAGICK)
7450 static Lisp_Object Qimagemagick
;
7452 static int imagemagick_image_p (Lisp_Object
);
7453 static int imagemagick_load (struct frame
*, struct image
*);
7454 static void imagemagick_clear_image (struct frame
*, struct image
*);
7456 /* Indices of image specification fields in imagemagick_format. */
7458 enum imagemagick_keyword_index
7466 IMAGEMAGICK_ALGORITHM
,
7467 IMAGEMAGICK_HEURISTIC_MASK
,
7469 IMAGEMAGICK_BACKGROUND
,
7472 IMAGEMAGICK_ROTATION
,
7477 /* Vector of image_keyword structures describing the format
7478 of valid user-defined image specifications. */
7480 static struct image_keyword imagemagick_format
[IMAGEMAGICK_LAST
] =
7482 {":type", IMAGE_SYMBOL_VALUE
, 1},
7483 {":data", IMAGE_STRING_VALUE
, 0},
7484 {":file", IMAGE_STRING_VALUE
, 0},
7485 {":ascent", IMAGE_ASCENT_VALUE
, 0},
7486 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
7487 {":relief", IMAGE_INTEGER_VALUE
, 0},
7488 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7489 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7490 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7491 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0},
7492 {":height", IMAGE_INTEGER_VALUE
, 0},
7493 {":width", IMAGE_INTEGER_VALUE
, 0},
7494 {":rotation", IMAGE_NUMBER_VALUE
, 0},
7495 {":crop", IMAGE_DONT_CHECK_VALUE_TYPE
, 0}
7498 /* Structure describing the image type for any image handled via
7501 static struct image_type imagemagick_type
=
7504 imagemagick_image_p
,
7506 imagemagick_clear_image
,
7510 /* Free X resources of imagemagick image IMG which is used on frame F. */
7513 imagemagick_clear_image (struct frame
*f
,
7516 x_clear_image (f
, img
);
7519 /* Return non-zero if OBJECT is a valid IMAGEMAGICK image specification. Do
7520 this by calling parse_image_spec and supplying the keywords that
7521 identify the IMAGEMAGICK format. */
7524 imagemagick_image_p (Lisp_Object object
)
7526 struct image_keyword fmt
[IMAGEMAGICK_LAST
];
7527 memcpy (fmt
, imagemagick_format
, sizeof fmt
);
7529 if (!parse_image_spec (object
, fmt
, IMAGEMAGICK_LAST
, Qimagemagick
))
7532 /* Must specify either the :data or :file keyword. */
7533 return fmt
[IMAGEMAGICK_FILE
].count
+ fmt
[IMAGEMAGICK_DATA
].count
== 1;
7536 /* The GIF library also defines DrawRectangle, but its never used in Emacs.
7537 Therefore rename the function so it doesn't collide with ImageMagick. */
7538 #define DrawRectangle DrawRectangleGif
7539 #include <wand/MagickWand.h>
7541 /* ImageMagick 6.5.3 through 6.6.5 hid PixelGetMagickColor for some reason.
7542 Emacs seems to work fine with the hidden version, so unhide it. */
7543 #include <magick/version.h>
7544 #if 0x653 <= MagickLibVersion && MagickLibVersion <= 0x665
7545 extern WandExport
void PixelGetMagickColor (const PixelWand
*,
7546 MagickPixelPacket
*);
7549 /* Log ImageMagick error message.
7550 Useful when a ImageMagick function returns the status `MagickFalse'. */
7553 imagemagick_error (MagickWand
*wand
)
7556 ExceptionType severity
;
7558 description
= MagickGetException (wand
, &severity
);
7559 image_error ("ImageMagick error: %s",
7560 build_string (description
),
7562 description
= (char *) MagickRelinquishMemory (description
);
7565 /* Helper function for imagemagick_load, which does the actual loading
7566 given contents and size, apart from frame and image structures,
7567 passed from imagemagick_load. Uses librimagemagick to do most of
7568 the image processing.
7570 F is a pointer to the Emacs frame; IMG to the image structure to
7571 prepare; CONTENTS is the string containing the IMAGEMAGICK data to
7572 be parsed; SIZE is the number of bytes of data; and FILENAME is
7573 either the file name or the image data.
7575 Return non-zero if successful. */
7578 imagemagick_load_image (struct frame
*f
, struct image
*img
,
7579 unsigned char *contents
, unsigned int size
,
7582 size_t width
, height
;
7583 MagickBooleanType status
;
7586 MagickWand
*image_wand
;
7587 MagickWand
*ping_wand
;
7588 PixelIterator
*iterator
;
7589 PixelWand
**pixels
, *bg_wand
= NULL
;
7590 MagickPixelPacket pixel
;
7595 int desired_width
, desired_height
;
7599 /* Handle image index for image types who can contain more than one image.
7600 Interface :index is same as for GIF. First we "ping" the image to see how
7601 many sub-images it contains. Pinging is faster than loading the image to
7602 find out things about it. */
7604 /* Initialize the imagemagick environment. */
7605 MagickWandGenesis ();
7606 image
= image_spec_value (img
->spec
, QCindex
, NULL
);
7607 ino
= INTEGERP (image
) ? XFASTINT (image
) : 0;
7608 ping_wand
= NewMagickWand ();
7609 /* MagickSetResolution (ping_wand, 2, 2); (Bug#10112) */
7612 ? MagickPingImage (ping_wand
, filename
)
7613 : MagickPingImageBlob (ping_wand
, contents
, size
);
7615 if (status
== MagickFalse
)
7617 imagemagick_error (ping_wand
);
7618 DestroyMagickWand (ping_wand
);
7622 if (ino
< 0 || ino
>= MagickGetNumberImages (ping_wand
))
7624 image_error ("Invalid image number `%s' in image `%s'",
7626 DestroyMagickWand (ping_wand
);
7630 if (MagickGetNumberImages (ping_wand
) > 1)
7633 Fcons (make_number (MagickGetNumberImages (ping_wand
)),
7636 DestroyMagickWand (ping_wand
);
7638 /* Now we know how many images are inside the file. If it's not a
7639 bundle, the number is one. Load the image data. */
7641 image_wand
= NewMagickWand ();
7644 ? MagickReadImage (image_wand
, filename
)
7645 : MagickReadImageBlob (image_wand
, contents
, size
))
7648 imagemagick_error (image_wand
);
7649 goto imagemagick_error
;
7652 /* Retrieve the frame's background color, for use later. */
7655 Lisp_Object specified_bg
;
7657 specified_bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
7658 if (!STRINGP (specified_bg
)
7659 || !x_defined_color (f
, SSDATA (specified_bg
), &bgcolor
, 0))
7662 bgcolor
.pixel
= FRAME_BACKGROUND_PIXEL (f
);
7663 x_query_color (f
, &bgcolor
);
7665 ns_query_color (FRAME_BACKGROUND_COLOR (f
), &bgcolor
, 1);
7669 bg_wand
= NewPixelWand ();
7670 PixelSetRed (bg_wand
, (double) bgcolor
.red
/ 65535);
7671 PixelSetGreen (bg_wand
, (double) bgcolor
.green
/ 65535);
7672 PixelSetBlue (bg_wand
, (double) bgcolor
.blue
/ 65535);
7675 /* If width and/or height is set in the display spec assume we want
7676 to scale to those values. If either h or w is unspecified, the
7677 unspecified should be calculated from the specified to preserve
7679 value
= image_spec_value (img
->spec
, QCwidth
, NULL
);
7680 desired_width
= (INTEGERP (value
) ? XFASTINT (value
) : -1);
7681 value
= image_spec_value (img
->spec
, QCheight
, NULL
);
7682 desired_height
= (INTEGERP (value
) ? XFASTINT (value
) : -1);
7684 height
= MagickGetImageHeight (image_wand
);
7685 width
= MagickGetImageWidth (image_wand
);
7687 if (desired_width
!= -1 && desired_height
== -1)
7688 /* w known, calculate h. */
7689 desired_height
= (double) desired_width
/ width
* height
;
7690 if (desired_width
== -1 && desired_height
!= -1)
7691 /* h known, calculate w. */
7692 desired_width
= (double) desired_height
/ height
* width
;
7693 if (desired_width
!= -1 && desired_height
!= -1)
7695 status
= MagickScaleImage (image_wand
, desired_width
, desired_height
);
7696 if (status
== MagickFalse
)
7698 image_error ("Imagemagick scale failed", Qnil
, Qnil
);
7699 imagemagick_error (image_wand
);
7700 goto imagemagick_error
;
7704 /* crop behaves similar to image slicing in Emacs but is more memory
7706 crop
= image_spec_value (img
->spec
, QCcrop
, NULL
);
7708 if (CONSP (crop
) && TYPE_RANGED_INTEGERP (size_t, XCAR (crop
)))
7710 /* After some testing, it seems MagickCropImage is the fastest crop
7711 function in ImageMagick. This crop function seems to do less copying
7712 than the alternatives, but it still reads the entire image into memory
7713 before cropping, which is apparently difficult to avoid when using
7715 size_t crop_width
= XINT (XCAR (crop
));
7717 if (CONSP (crop
) && TYPE_RANGED_INTEGERP (size_t, XCAR (crop
)))
7719 size_t crop_height
= XINT (XCAR (crop
));
7721 if (CONSP (crop
) && TYPE_RANGED_INTEGERP (ssize_t
, XCAR (crop
)))
7723 ssize_t crop_x
= XINT (XCAR (crop
));
7725 if (CONSP (crop
) && TYPE_RANGED_INTEGERP (ssize_t
, XCAR (crop
)))
7727 ssize_t crop_y
= XINT (XCAR (crop
));
7728 MagickCropImage (image_wand
, crop_width
, crop_height
,
7735 /* Furthermore :rotation. we need background color and angle for
7738 TODO background handling for rotation specified_bg =
7739 image_spec_value (img->spec, QCbackground, NULL); if (!STRINGP
7741 value
= image_spec_value (img
->spec
, QCrotation
, NULL
);
7744 rotation
= extract_float (value
);
7745 status
= MagickRotateImage (image_wand
, bg_wand
, rotation
);
7746 if (status
== MagickFalse
)
7748 image_error ("Imagemagick image rotate failed", Qnil
, Qnil
);
7749 imagemagick_error (image_wand
);
7750 goto imagemagick_error
;
7754 /* Finally we are done manipulating the image. Figure out the
7755 resulting width/height and transfer ownership to Emacs. */
7756 height
= MagickGetImageHeight (image_wand
);
7757 width
= MagickGetImageWidth (image_wand
);
7759 /* Set the canvas background color to the frame or specified
7760 background, and flatten the image. Note: as of ImageMagick
7761 6.6.0, SVG image transparency is not handled properly
7762 (e.g. etc/images/splash.svg shows a white background always). */
7764 MagickWand
*new_wand
;
7765 MagickSetImageBackgroundColor (image_wand
, bg_wand
);
7766 #ifdef HAVE_MAGICKMERGEIMAGELAYERS
7767 new_wand
= MagickMergeImageLayers (image_wand
, MergeLayer
);
7769 new_wand
= MagickFlattenImages (image_wand
);
7771 DestroyMagickWand (image_wand
);
7772 image_wand
= new_wand
;
7775 if (! (width
<= INT_MAX
&& height
<= INT_MAX
7776 && check_image_size (f
, width
, height
)))
7778 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
7779 goto imagemagick_error
;
7782 /* We can now get a valid pixel buffer from the imagemagick file, if all
7785 init_color_table ();
7787 #ifdef HAVE_MAGICKEXPORTIMAGEPIXELS
7788 if (imagemagick_render_type
!= 0)
7790 /* Magicexportimage is normally faster than pixelpushing. This
7791 method is also well tested. Some aspects of this method are
7792 ad-hoc and needs to be more researched. */
7793 int imagedepth
= 24; /*MagickGetImageDepth(image_wand);*/
7794 const char *exportdepth
= imagedepth
<= 8 ? "I" : "BGRP"; /*"RGBP";*/
7795 /* Try to create a x pixmap to hold the imagemagick pixmap. */
7796 if (!x_create_x_image_and_pixmap (f
, width
, height
, imagedepth
,
7797 &ximg
, &img
->pixmap
))
7799 #ifdef COLOR_TABLE_SUPPORT
7800 free_color_table ();
7802 image_error ("Imagemagick X bitmap allocation failure", Qnil
, Qnil
);
7803 goto imagemagick_error
;
7806 /* Oddly, the below code doesn't seem to work:*/
7807 /* switch(ximg->bitmap_unit){ */
7809 /* pixelwidth=CharPixel; */
7812 /* pixelwidth=ShortPixel; */
7815 /* pixelwidth=LongPixel; */
7819 Here im just guessing the format of the bitmap.
7820 happens to work fine for:
7823 seems about 3 times as fast as pixel pushing(not carefully measured)
7825 pixelwidth
= CharPixel
; /*??? TODO figure out*/
7826 MagickExportImagePixels (image_wand
, 0, 0, width
, height
,
7827 exportdepth
, pixelwidth
, ximg
->data
);
7830 #endif /* HAVE_MAGICKEXPORTIMAGEPIXELS */
7832 size_t image_height
;
7834 /* Try to create a x pixmap to hold the imagemagick pixmap. */
7835 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0,
7836 &ximg
, &img
->pixmap
))
7838 #ifdef COLOR_TABLE_SUPPORT
7839 free_color_table ();
7841 image_error ("Imagemagick X bitmap allocation failure", Qnil
, Qnil
);
7842 goto imagemagick_error
;
7845 /* Copy imagemagick image to x with primitive yet robust pixel
7846 pusher loop. This has been tested a lot with many different
7849 /* Copy pixels from the imagemagick image structure to the x image map. */
7850 iterator
= NewPixelIterator (image_wand
);
7851 if (iterator
== (PixelIterator
*) NULL
)
7853 #ifdef COLOR_TABLE_SUPPORT
7854 free_color_table ();
7856 x_destroy_x_image (ximg
);
7857 image_error ("Imagemagick pixel iterator creation failed",
7859 goto imagemagick_error
;
7862 image_height
= MagickGetImageHeight (image_wand
);
7863 for (y
= 0; y
< image_height
; y
++)
7865 pixels
= PixelGetNextIteratorRow (iterator
, &width
);
7866 if (pixels
== (PixelWand
**) NULL
)
7868 for (x
= 0; x
< (long) width
; x
++)
7870 PixelGetMagickColor (pixels
[x
], &pixel
);
7871 XPutPixel (ximg
, x
, y
,
7872 lookup_rgb_color (f
,
7878 DestroyPixelIterator (iterator
);
7881 #ifdef COLOR_TABLE_SUPPORT
7882 /* Remember colors allocated for this image. */
7883 img
->colors
= colors_in_color_table (&img
->ncolors
);
7884 free_color_table ();
7885 #endif /* COLOR_TABLE_SUPPORT */
7888 img
->height
= height
;
7890 /* Put the image into the pixmap, then free the X image and its
7892 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
7893 x_destroy_x_image (ximg
);
7895 /* Final cleanup. image_wand should be the only resource left. */
7896 DestroyMagickWand (image_wand
);
7897 if (bg_wand
) DestroyPixelWand (bg_wand
);
7899 /* `MagickWandTerminus' terminates the imagemagick environment. */
7900 MagickWandTerminus ();
7905 DestroyMagickWand (image_wand
);
7906 if (bg_wand
) DestroyPixelWand (bg_wand
);
7908 MagickWandTerminus ();
7909 /* TODO more cleanup. */
7910 image_error ("Error parsing IMAGEMAGICK image `%s'", img
->spec
, Qnil
);
7915 /* Load IMAGEMAGICK image IMG for use on frame F. Value is non-zero if
7916 successful. this function will go into the imagemagick_type structure, and
7917 the prototype thus needs to be compatible with that structure. */
7920 imagemagick_load (struct frame
*f
, struct image
*img
)
7923 Lisp_Object file_name
;
7925 /* If IMG->spec specifies a file name, create a non-file spec from it. */
7926 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
7927 if (STRINGP (file_name
))
7931 file
= x_find_image_file (file_name
);
7932 if (!STRINGP (file
))
7934 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
7937 success_p
= imagemagick_load_image (f
, img
, 0, 0, SSDATA (file
));
7939 /* Else its not a file, its a lisp object. Load the image from a
7940 lisp object rather than a file. */
7945 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
7946 if (!STRINGP (data
))
7948 image_error ("Invalid image data `%s'", data
, Qnil
);
7951 success_p
= imagemagick_load_image (f
, img
, SDATA (data
),
7952 SBYTES (data
), NULL
);
7958 DEFUN ("imagemagick-types", Fimagemagick_types
, Simagemagick_types
, 0, 0, 0,
7959 doc
: /* Return a list of image types supported by ImageMagick.
7960 Each entry in this list is a symbol named after an ImageMagick format
7961 tag. See the ImageMagick manual for a list of ImageMagick formats and
7962 their descriptions (http://www.imagemagick.org/script/formats.php).
7963 You can also try the shell command: `identify -list format'.
7965 Note that ImageMagick recognizes many file-types that Emacs does not
7966 recognize as images, such as C. See `imagemagick-types-enable'
7967 and `imagemagick-types-inhibit'. */)
7970 Lisp_Object typelist
= Qnil
;
7975 Lisp_Object Qimagemagicktype
;
7977 GetExceptionInfo(&ex
);
7978 imtypes
= GetMagickList ("*", &numf
, &ex
);
7979 DestroyExceptionInfo(&ex
);
7981 for (i
= 0; i
< numf
; i
++)
7983 Qimagemagicktype
= intern (imtypes
[i
]);
7984 typelist
= Fcons (Qimagemagicktype
, typelist
);
7986 return Fnreverse (typelist
);
7989 #endif /* defined (HAVE_IMAGEMAGICK) */
7993 /***********************************************************************
7995 ***********************************************************************/
7997 #if defined (HAVE_RSVG)
7999 /* Function prototypes. */
8001 static int svg_image_p (Lisp_Object object
);
8002 static int svg_load (struct frame
*f
, struct image
*img
);
8004 static int svg_load_image (struct frame
*, struct image
*,
8005 unsigned char *, ptrdiff_t);
8007 /* The symbol `svg' identifying images of this type. */
8009 static Lisp_Object Qsvg
;
8011 /* Indices of image specification fields in svg_format, below. */
8013 enum svg_keyword_index
8028 /* Vector of image_keyword structures describing the format
8029 of valid user-defined image specifications. */
8031 static const struct image_keyword svg_format
[SVG_LAST
] =
8033 {":type", IMAGE_SYMBOL_VALUE
, 1},
8034 {":data", IMAGE_STRING_VALUE
, 0},
8035 {":file", IMAGE_STRING_VALUE
, 0},
8036 {":ascent", IMAGE_ASCENT_VALUE
, 0},
8037 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
8038 {":relief", IMAGE_INTEGER_VALUE
, 0},
8039 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8040 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8041 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8042 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
8045 /* Structure describing the image type `svg'. Its the same type of
8046 structure defined for all image formats, handled by emacs image
8047 functions. See struct image_type in dispextern.h. */
8049 static struct image_type svg_type
=
8051 /* An identifier showing that this is an image structure for the SVG format. */
8053 /* Handle to a function that can be used to identify a SVG file. */
8055 /* Handle to function used to load a SVG file. */
8057 /* Handle to function to free sresources for SVG. */
8059 /* An internal field to link to the next image type in a list of
8060 image types, will be filled in when registering the format. */
8065 /* Return non-zero if OBJECT is a valid SVG image specification. Do
8066 this by calling parse_image_spec and supplying the keywords that
8067 identify the SVG format. */
8070 svg_image_p (Lisp_Object object
)
8072 struct image_keyword fmt
[SVG_LAST
];
8073 memcpy (fmt
, svg_format
, sizeof fmt
);
8075 if (!parse_image_spec (object
, fmt
, SVG_LAST
, Qsvg
))
8078 /* Must specify either the :data or :file keyword. */
8079 return fmt
[SVG_FILE
].count
+ fmt
[SVG_DATA
].count
== 1;
8082 #include <librsvg/rsvg.h>
8086 /* SVG library functions. */
8087 DEF_IMGLIB_FN (RsvgHandle
*, rsvg_handle_new
);
8088 DEF_IMGLIB_FN (void, rsvg_handle_get_dimensions
);
8089 DEF_IMGLIB_FN (gboolean
, rsvg_handle_write
);
8090 DEF_IMGLIB_FN (gboolean
, rsvg_handle_close
);
8091 DEF_IMGLIB_FN (GdkPixbuf
*, rsvg_handle_get_pixbuf
);
8093 DEF_IMGLIB_FN (int, gdk_pixbuf_get_width
);
8094 DEF_IMGLIB_FN (int, gdk_pixbuf_get_height
);
8095 DEF_IMGLIB_FN (guchar
*, gdk_pixbuf_get_pixels
);
8096 DEF_IMGLIB_FN (int, gdk_pixbuf_get_rowstride
);
8097 DEF_IMGLIB_FN (GdkColorspace
, gdk_pixbuf_get_colorspace
);
8098 DEF_IMGLIB_FN (int, gdk_pixbuf_get_n_channels
);
8099 DEF_IMGLIB_FN (gboolean
, gdk_pixbuf_get_has_alpha
);
8100 DEF_IMGLIB_FN (int, gdk_pixbuf_get_bits_per_sample
);
8102 DEF_IMGLIB_FN (void, g_type_init
);
8103 DEF_IMGLIB_FN (void, g_object_unref
);
8104 DEF_IMGLIB_FN (void, g_error_free
);
8106 Lisp_Object Qgdk_pixbuf
, Qglib
, Qgobject
;
8109 init_svg_functions (Lisp_Object libraries
)
8111 HMODULE library
, gdklib
, glib
, gobject
;
8113 if (!(glib
= w32_delayed_load (libraries
, Qglib
))
8114 || !(gobject
= w32_delayed_load (libraries
, Qgobject
))
8115 || !(gdklib
= w32_delayed_load (libraries
, Qgdk_pixbuf
))
8116 || !(library
= w32_delayed_load (libraries
, Qsvg
)))
8119 LOAD_IMGLIB_FN (library
, rsvg_handle_new
);
8120 LOAD_IMGLIB_FN (library
, rsvg_handle_get_dimensions
);
8121 LOAD_IMGLIB_FN (library
, rsvg_handle_write
);
8122 LOAD_IMGLIB_FN (library
, rsvg_handle_close
);
8123 LOAD_IMGLIB_FN (library
, rsvg_handle_get_pixbuf
);
8125 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_width
);
8126 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_height
);
8127 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_pixels
);
8128 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_rowstride
);
8129 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_colorspace
);
8130 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_n_channels
);
8131 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_has_alpha
);
8132 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_bits_per_sample
);
8134 LOAD_IMGLIB_FN (gobject
, g_type_init
);
8135 LOAD_IMGLIB_FN (gobject
, g_object_unref
);
8136 LOAD_IMGLIB_FN (glib
, g_error_free
);
8142 /* The following aliases for library functions allow dynamic loading
8143 to be used on some platforms. */
8144 #define fn_rsvg_handle_new rsvg_handle_new
8145 #define fn_rsvg_handle_get_dimensions rsvg_handle_get_dimensions
8146 #define fn_rsvg_handle_write rsvg_handle_write
8147 #define fn_rsvg_handle_close rsvg_handle_close
8148 #define fn_rsvg_handle_get_pixbuf rsvg_handle_get_pixbuf
8150 #define fn_gdk_pixbuf_get_width gdk_pixbuf_get_width
8151 #define fn_gdk_pixbuf_get_height gdk_pixbuf_get_height
8152 #define fn_gdk_pixbuf_get_pixels gdk_pixbuf_get_pixels
8153 #define fn_gdk_pixbuf_get_rowstride gdk_pixbuf_get_rowstride
8154 #define fn_gdk_pixbuf_get_colorspace gdk_pixbuf_get_colorspace
8155 #define fn_gdk_pixbuf_get_n_channels gdk_pixbuf_get_n_channels
8156 #define fn_gdk_pixbuf_get_has_alpha gdk_pixbuf_get_has_alpha
8157 #define fn_gdk_pixbuf_get_bits_per_sample gdk_pixbuf_get_bits_per_sample
8159 #define fn_g_type_init g_type_init
8160 #define fn_g_object_unref g_object_unref
8161 #define fn_g_error_free g_error_free
8162 #endif /* !HAVE_NTGUI */
8164 /* Load SVG image IMG for use on frame F. Value is non-zero if
8165 successful. this function will go into the svg_type structure, and
8166 the prototype thus needs to be compatible with that structure. */
8169 svg_load (struct frame
*f
, struct image
*img
)
8172 Lisp_Object file_name
;
8174 /* If IMG->spec specifies a file name, create a non-file spec from it. */
8175 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
8176 if (STRINGP (file_name
))
8179 unsigned char *contents
;
8182 file
= x_find_image_file (file_name
);
8183 if (!STRINGP (file
))
8185 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
8189 /* Read the entire file into memory. */
8190 contents
= slurp_file (SSDATA (file
), &size
);
8191 if (contents
== NULL
)
8193 image_error ("Error loading SVG image `%s'", img
->spec
, Qnil
);
8196 /* If the file was slurped into memory properly, parse it. */
8197 success_p
= svg_load_image (f
, img
, contents
, size
);
8200 /* Else its not a file, its a lisp object. Load the image from a
8201 lisp object rather than a file. */
8206 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
8207 if (!STRINGP (data
))
8209 image_error ("Invalid image data `%s'", data
, Qnil
);
8212 success_p
= svg_load_image (f
, img
, SDATA (data
), SBYTES (data
));
8218 /* svg_load_image is a helper function for svg_load, which does the
8219 actual loading given contents and size, apart from frame and image
8220 structures, passed from svg_load.
8222 Uses librsvg to do most of the image processing.
8224 Returns non-zero when successful. */
8226 svg_load_image (struct frame
*f
, /* Pointer to emacs frame structure. */
8227 struct image
*img
, /* Pointer to emacs image structure. */
8228 unsigned char *contents
, /* String containing the SVG XML data to be parsed. */
8229 ptrdiff_t size
) /* Size of data in bytes. */
8231 RsvgHandle
*rsvg_handle
;
8232 RsvgDimensionData dimension_data
;
8237 const guint8
*pixels
;
8240 Lisp_Object specified_bg
;
8245 /* g_type_init is a glib function that must be called prior to using
8246 gnome type library functions. */
8248 /* Make a handle to a new rsvg object. */
8249 rsvg_handle
= fn_rsvg_handle_new ();
8251 /* Parse the contents argument and fill in the rsvg_handle. */
8252 fn_rsvg_handle_write (rsvg_handle
, contents
, size
, &err
);
8253 if (err
) goto rsvg_error
;
8255 /* The parsing is complete, rsvg_handle is ready to used, close it
8256 for further writes. */
8257 fn_rsvg_handle_close (rsvg_handle
, &err
);
8258 if (err
) goto rsvg_error
;
8260 fn_rsvg_handle_get_dimensions (rsvg_handle
, &dimension_data
);
8261 if (! check_image_size (f
, dimension_data
.width
, dimension_data
.height
))
8263 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
8267 /* We can now get a valid pixel buffer from the svg file, if all
8269 pixbuf
= fn_rsvg_handle_get_pixbuf (rsvg_handle
);
8270 if (!pixbuf
) goto rsvg_error
;
8271 fn_g_object_unref (rsvg_handle
);
8273 /* Extract some meta data from the svg handle. */
8274 width
= fn_gdk_pixbuf_get_width (pixbuf
);
8275 height
= fn_gdk_pixbuf_get_height (pixbuf
);
8276 pixels
= fn_gdk_pixbuf_get_pixels (pixbuf
);
8277 rowstride
= fn_gdk_pixbuf_get_rowstride (pixbuf
);
8279 /* Validate the svg meta data. */
8280 eassert (fn_gdk_pixbuf_get_colorspace (pixbuf
) == GDK_COLORSPACE_RGB
);
8281 eassert (fn_gdk_pixbuf_get_n_channels (pixbuf
) == 4);
8282 eassert (fn_gdk_pixbuf_get_has_alpha (pixbuf
));
8283 eassert (fn_gdk_pixbuf_get_bits_per_sample (pixbuf
) == 8);
8285 /* Try to create a x pixmap to hold the svg pixmap. */
8286 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0, &ximg
, &img
->pixmap
))
8288 fn_g_object_unref (pixbuf
);
8292 init_color_table ();
8294 /* Handle alpha channel by combining the image with a background
8296 specified_bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
8297 if (!STRINGP (specified_bg
)
8298 || !x_defined_color (f
, SSDATA (specified_bg
), &background
, 0))
8301 background
.pixel
= FRAME_BACKGROUND_PIXEL (f
);
8302 x_query_color (f
, &background
);
8304 ns_query_color (FRAME_BACKGROUND_COLOR (f
), &background
, 1);
8308 /* SVG pixmaps specify transparency in the last byte, so right
8309 shift 8 bits to get rid of it, since emacs doesn't support
8311 background
.red
>>= 8;
8312 background
.green
>>= 8;
8313 background
.blue
>>= 8;
8315 /* This loop handles opacity values, since Emacs assumes
8316 non-transparent images. Each pixel must be "flattened" by
8317 calculating the resulting color, given the transparency of the
8318 pixel, and the image background color. */
8319 for (y
= 0; y
< height
; ++y
)
8321 for (x
= 0; x
< width
; ++x
)
8331 opacity
= *pixels
++;
8333 red
= ((red
* opacity
)
8334 + (background
.red
* ((1 << 8) - opacity
)));
8335 green
= ((green
* opacity
)
8336 + (background
.green
* ((1 << 8) - opacity
)));
8337 blue
= ((blue
* opacity
)
8338 + (background
.blue
* ((1 << 8) - opacity
)));
8340 XPutPixel (ximg
, x
, y
, lookup_rgb_color (f
, red
, green
, blue
));
8343 pixels
+= rowstride
- 4 * width
;
8346 #ifdef COLOR_TABLE_SUPPORT
8347 /* Remember colors allocated for this image. */
8348 img
->colors
= colors_in_color_table (&img
->ncolors
);
8349 free_color_table ();
8350 #endif /* COLOR_TABLE_SUPPORT */
8352 fn_g_object_unref (pixbuf
);
8355 img
->height
= height
;
8357 /* Maybe fill in the background field while we have ximg handy.
8358 Casting avoids a GCC warning. */
8359 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
8361 /* Put the image into the pixmap, then free the X image and its
8363 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
8364 x_destroy_x_image (ximg
);
8369 fn_g_object_unref (rsvg_handle
);
8370 /* FIXME: Use error->message so the user knows what is the actual
8371 problem with the image. */
8372 image_error ("Error parsing SVG image `%s'", img
->spec
, Qnil
);
8373 fn_g_error_free (err
);
8377 #endif /* defined (HAVE_RSVG) */
8382 /***********************************************************************
8384 ***********************************************************************/
8386 #ifdef HAVE_X_WINDOWS
8387 #define HAVE_GHOSTSCRIPT 1
8388 #endif /* HAVE_X_WINDOWS */
8390 #ifdef HAVE_GHOSTSCRIPT
8392 static int gs_image_p (Lisp_Object object
);
8393 static int gs_load (struct frame
*f
, struct image
*img
);
8394 static void gs_clear_image (struct frame
*f
, struct image
*img
);
8396 /* Keyword symbols. */
8398 static Lisp_Object QCloader
, QCbounding_box
, QCpt_width
, QCpt_height
;
8400 /* Indices of image specification fields in gs_format, below. */
8402 enum gs_keyword_index
8420 /* Vector of image_keyword structures describing the format
8421 of valid user-defined image specifications. */
8423 static const struct image_keyword gs_format
[GS_LAST
] =
8425 {":type", IMAGE_SYMBOL_VALUE
, 1},
8426 {":pt-width", IMAGE_POSITIVE_INTEGER_VALUE
, 1},
8427 {":pt-height", IMAGE_POSITIVE_INTEGER_VALUE
, 1},
8428 {":file", IMAGE_STRING_VALUE
, 1},
8429 {":loader", IMAGE_FUNCTION_VALUE
, 0},
8430 {":bounding-box", IMAGE_DONT_CHECK_VALUE_TYPE
, 1},
8431 {":ascent", IMAGE_ASCENT_VALUE
, 0},
8432 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
8433 {":relief", IMAGE_INTEGER_VALUE
, 0},
8434 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8435 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8436 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8437 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
8440 /* Structure describing the image type `ghostscript'. */
8442 static struct image_type gs_type
=
8452 /* Free X resources of Ghostscript image IMG which is used on frame F. */
8455 gs_clear_image (struct frame
*f
, struct image
*img
)
8457 x_clear_image (f
, img
);
8461 /* Return non-zero if OBJECT is a valid Ghostscript image
8465 gs_image_p (Lisp_Object object
)
8467 struct image_keyword fmt
[GS_LAST
];
8471 memcpy (fmt
, gs_format
, sizeof fmt
);
8473 if (!parse_image_spec (object
, fmt
, GS_LAST
, Qpostscript
))
8476 /* Bounding box must be a list or vector containing 4 integers. */
8477 tem
= fmt
[GS_BOUNDING_BOX
].value
;
8480 for (i
= 0; i
< 4; ++i
, tem
= XCDR (tem
))
8481 if (!CONSP (tem
) || !INTEGERP (XCAR (tem
)))
8486 else if (VECTORP (tem
))
8488 if (ASIZE (tem
) != 4)
8490 for (i
= 0; i
< 4; ++i
)
8491 if (!INTEGERP (AREF (tem
, i
)))
8501 /* Load Ghostscript image IMG for use on frame F. Value is non-zero
8505 gs_load (struct frame
*f
, struct image
*img
)
8507 uprintmax_t printnum1
, printnum2
;
8508 char buffer
[sizeof " " + INT_STRLEN_BOUND (printmax_t
)];
8509 Lisp_Object window_and_pixmap_id
= Qnil
, loader
, pt_height
, pt_width
;
8511 double in_width
, in_height
;
8512 Lisp_Object pixel_colors
= Qnil
;
8514 /* Compute pixel size of pixmap needed from the given size in the
8515 image specification. Sizes in the specification are in pt. 1 pt
8516 = 1/72 in, xdpi and ydpi are stored in the frame's X display
8518 pt_width
= image_spec_value (img
->spec
, QCpt_width
, NULL
);
8519 in_width
= INTEGERP (pt_width
) ? XFASTINT (pt_width
) / 72.0 : 0;
8520 in_width
*= FRAME_X_DISPLAY_INFO (f
)->resx
;
8521 pt_height
= image_spec_value (img
->spec
, QCpt_height
, NULL
);
8522 in_height
= INTEGERP (pt_height
) ? XFASTINT (pt_height
) / 72.0 : 0;
8523 in_height
*= FRAME_X_DISPLAY_INFO (f
)->resy
;
8525 if (! (in_width
<= INT_MAX
&& in_height
<= INT_MAX
8526 && check_image_size (f
, in_width
, in_height
)))
8528 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
8531 img
->width
= in_width
;
8532 img
->height
= in_height
;
8534 /* Create the pixmap. */
8535 eassert (img
->pixmap
== NO_PIXMAP
);
8537 if (x_check_image_size (0, img
->width
, img
->height
))
8539 /* Only W32 version did BLOCK_INPUT here. ++kfs */
8541 img
->pixmap
= XCreatePixmap (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
8542 img
->width
, img
->height
,
8543 DefaultDepthOfScreen (FRAME_X_SCREEN (f
)));
8549 image_error ("Unable to create pixmap for `%s'", img
->spec
, Qnil
);
8553 /* Call the loader to fill the pixmap. It returns a process object
8554 if successful. We do not record_unwind_protect here because
8555 other places in redisplay like calling window scroll functions
8556 don't either. Let the Lisp loader use `unwind-protect' instead. */
8557 printnum1
= FRAME_X_WINDOW (f
);
8558 printnum2
= img
->pixmap
;
8559 window_and_pixmap_id
8560 = make_formatted_string (buffer
, "%"pMu
" %"pMu
, printnum1
, printnum2
);
8562 printnum1
= FRAME_FOREGROUND_PIXEL (f
);
8563 printnum2
= FRAME_BACKGROUND_PIXEL (f
);
8565 = make_formatted_string (buffer
, "%"pMu
" %"pMu
, printnum1
, printnum2
);
8567 XSETFRAME (frame
, f
);
8568 loader
= image_spec_value (img
->spec
, QCloader
, NULL
);
8570 loader
= intern ("gs-load-image");
8572 img
->lisp_data
= call6 (loader
, frame
, img
->spec
,
8573 make_number (img
->width
),
8574 make_number (img
->height
),
8575 window_and_pixmap_id
,
8577 return PROCESSP (img
->lisp_data
);
8581 /* Kill the Ghostscript process that was started to fill PIXMAP on
8582 frame F. Called from XTread_socket when receiving an event
8583 telling Emacs that Ghostscript has finished drawing. */
8586 x_kill_gs_process (Pixmap pixmap
, struct frame
*f
)
8588 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
8593 /* Find the image containing PIXMAP. */
8594 for (i
= 0; i
< c
->used
; ++i
)
8595 if (c
->images
[i
]->pixmap
== pixmap
)
8598 /* Should someone in between have cleared the image cache, for
8599 instance, give up. */
8603 /* Kill the GS process. We should have found PIXMAP in the image
8604 cache and its image should contain a process object. */
8606 eassert (PROCESSP (img
->lisp_data
));
8607 Fkill_process (img
->lisp_data
, Qnil
);
8608 img
->lisp_data
= Qnil
;
8610 #if defined (HAVE_X_WINDOWS)
8612 /* On displays with a mutable colormap, figure out the colors
8613 allocated for the image by looking at the pixels of an XImage for
8615 class = FRAME_X_VISUAL (f
)->class;
8616 if (class != StaticColor
&& class != StaticGray
&& class != TrueColor
)
8622 /* Try to get an XImage for img->pixmep. */
8623 ximg
= XGetImage (FRAME_X_DISPLAY (f
), img
->pixmap
,
8624 0, 0, img
->width
, img
->height
, ~0, ZPixmap
);
8629 /* Initialize the color table. */
8630 init_color_table ();
8632 /* For each pixel of the image, look its color up in the
8633 color table. After having done so, the color table will
8634 contain an entry for each color used by the image. */
8635 for (y
= 0; y
< img
->height
; ++y
)
8636 for (x
= 0; x
< img
->width
; ++x
)
8638 unsigned long pixel
= XGetPixel (ximg
, x
, y
);
8639 lookup_pixel_color (f
, pixel
);
8642 /* Record colors in the image. Free color table and XImage. */
8643 #ifdef COLOR_TABLE_SUPPORT
8644 img
->colors
= colors_in_color_table (&img
->ncolors
);
8645 free_color_table ();
8647 XDestroyImage (ximg
);
8649 #if 0 /* This doesn't seem to be the case. If we free the colors
8650 here, we get a BadAccess later in x_clear_image when
8651 freeing the colors. */
8652 /* We have allocated colors once, but Ghostscript has also
8653 allocated colors on behalf of us. So, to get the
8654 reference counts right, free them once. */
8656 x_free_colors (f
, img
->colors
, img
->ncolors
);
8660 image_error ("Cannot get X image of `%s'; colors will not be freed",
8665 #endif /* HAVE_X_WINDOWS */
8667 /* Now that we have the pixmap, compute mask and transform the
8668 image if requested. */
8670 postprocess_image (f
, img
);
8674 #endif /* HAVE_GHOSTSCRIPT */
8677 /***********************************************************************
8679 ***********************************************************************/
8683 DEFUN ("imagep", Fimagep
, Simagep
, 1, 1, 0,
8684 doc
: /* Value is non-nil if SPEC is a valid image specification. */)
8687 return valid_image_p (spec
) ? Qt
: Qnil
;
8691 DEFUN ("lookup-image", Flookup_image
, Slookup_image
, 1, 1, 0, "")
8696 if (valid_image_p (spec
))
8697 id
= lookup_image (SELECTED_FRAME (), spec
);
8700 return make_number (id
);
8703 #endif /* GLYPH_DEBUG */
8706 /***********************************************************************
8708 ***********************************************************************/
8711 /* Image types that rely on external libraries are loaded dynamically
8712 if the library is available. */
8713 #define CHECK_LIB_AVAILABLE(image_type, init_lib_fn, libraries) \
8714 define_image_type (image_type, init_lib_fn (libraries))
8716 #define CHECK_LIB_AVAILABLE(image_type, init_lib_fn, libraries) \
8717 define_image_type (image_type, 1)
8718 #endif /* HAVE_NTGUI */
8720 DEFUN ("init-image-library", Finit_image_library
, Sinit_image_library
, 2, 2, 0,
8721 doc
: /* Initialize image library implementing image type TYPE.
8722 Return non-nil if TYPE is a supported image type.
8724 Image types pbm and xbm are prebuilt; other types are loaded here.
8725 Libraries to load are specified in alist LIBRARIES (usually, the value
8726 of `dynamic-library-alist', which see). */)
8727 (Lisp_Object type
, Lisp_Object libraries
)
8730 /* Don't try to reload the library. */
8731 Lisp_Object tested
= Fassq (type
, Vlibrary_cache
);
8733 return XCDR (tested
);
8736 /* Types pbm and xbm are built-in and always available. */
8737 if (EQ (type
, Qpbm
) || EQ (type
, Qxbm
))
8740 #if defined (HAVE_XPM) || defined (HAVE_NS)
8741 if (EQ (type
, Qxpm
))
8742 return CHECK_LIB_AVAILABLE (&xpm_type
, init_xpm_functions
, libraries
);
8745 #if defined (HAVE_JPEG) || defined (HAVE_NS)
8746 if (EQ (type
, Qjpeg
))
8747 return CHECK_LIB_AVAILABLE (&jpeg_type
, init_jpeg_functions
, libraries
);
8750 #if defined (HAVE_TIFF) || defined (HAVE_NS)
8751 if (EQ (type
, Qtiff
))
8752 return CHECK_LIB_AVAILABLE (&tiff_type
, init_tiff_functions
, libraries
);
8755 #if defined (HAVE_GIF) || defined (HAVE_NS)
8756 if (EQ (type
, Qgif
))
8757 return CHECK_LIB_AVAILABLE (&gif_type
, init_gif_functions
, libraries
);
8760 #if defined (HAVE_PNG) || defined (HAVE_NS)
8761 if (EQ (type
, Qpng
))
8762 return CHECK_LIB_AVAILABLE (&png_type
, init_png_functions
, libraries
);
8765 #if defined (HAVE_RSVG)
8766 if (EQ (type
, Qsvg
))
8767 return CHECK_LIB_AVAILABLE (&svg_type
, init_svg_functions
, libraries
);
8770 #if defined (HAVE_IMAGEMAGICK)
8771 if (EQ (type
, Qimagemagick
))
8772 return CHECK_LIB_AVAILABLE (&imagemagick_type
, init_imagemagick_functions
,
8776 #ifdef HAVE_GHOSTSCRIPT
8777 if (EQ (type
, Qpostscript
))
8778 return CHECK_LIB_AVAILABLE (&gs_type
, init_gs_functions
, libraries
);
8781 /* If the type is not recognized, avoid testing it ever again. */
8782 CACHE_IMAGE_TYPE (type
, Qnil
);
8787 syms_of_image (void)
8789 /* Initialize this only once, since that's what we do with Vimage_types
8790 and they are supposed to be in sync. Initializing here gives correct
8791 operation on GNU/Linux of calling dump-emacs after loading some images. */
8794 /* Must be defined now because we're going to update it below, while
8795 defining the supported image types. */
8796 DEFVAR_LISP ("image-types", Vimage_types
,
8797 doc
: /* List of potentially supported image types.
8798 Each element of the list is a symbol for an image type, like 'jpeg or 'png.
8799 To check whether it is really supported, use `image-type-available-p'. */);
8800 Vimage_types
= Qnil
;
8802 DEFVAR_LISP ("max-image-size", Vmax_image_size
,
8803 doc
: /* Maximum size of images.
8804 Emacs will not load an image into memory if its pixel width or
8805 pixel height exceeds this limit.
8807 If the value is an integer, it directly specifies the maximum
8808 image height and width, measured in pixels. If it is a floating
8809 point number, it specifies the maximum image height and width
8810 as a ratio to the frame height and width. If the value is
8811 non-numeric, there is no explicit limit on the size of images. */);
8812 Vmax_image_size
= make_float (MAX_IMAGE_SIZE
);
8814 DEFSYM (Qpbm
, "pbm");
8815 ADD_IMAGE_TYPE (Qpbm
);
8817 DEFSYM (Qxbm
, "xbm");
8818 ADD_IMAGE_TYPE (Qxbm
);
8820 define_image_type (&xbm_type
, 1);
8821 define_image_type (&pbm_type
, 1);
8823 DEFSYM (Qcount
, "count");
8824 DEFSYM (Qextension_data
, "extension-data");
8825 DEFSYM (Qdelay
, "delay");
8827 DEFSYM (QCascent
, ":ascent");
8828 DEFSYM (QCmargin
, ":margin");
8829 DEFSYM (QCrelief
, ":relief");
8830 DEFSYM (QCconversion
, ":conversion");
8831 DEFSYM (QCcolor_symbols
, ":color-symbols");
8832 DEFSYM (QCheuristic_mask
, ":heuristic-mask");
8833 DEFSYM (QCindex
, ":index");
8834 DEFSYM (QCgeometry
, ":geometry");
8835 DEFSYM (QCcrop
, ":crop");
8836 DEFSYM (QCrotation
, ":rotation");
8837 DEFSYM (QCmatrix
, ":matrix");
8838 DEFSYM (QCcolor_adjustment
, ":color-adjustment");
8839 DEFSYM (QCmask
, ":mask");
8841 DEFSYM (Qlaplace
, "laplace");
8842 DEFSYM (Qemboss
, "emboss");
8843 DEFSYM (Qedge_detection
, "edge-detection");
8844 DEFSYM (Qheuristic
, "heuristic");
8846 DEFSYM (Qpostscript
, "postscript");
8847 #ifdef HAVE_GHOSTSCRIPT
8848 ADD_IMAGE_TYPE (Qpostscript
);
8849 DEFSYM (QCloader
, ":loader");
8850 DEFSYM (QCbounding_box
, ":bounding-box");
8851 DEFSYM (QCpt_width
, ":pt-width");
8852 DEFSYM (QCpt_height
, ":pt-height");
8853 #endif /* HAVE_GHOSTSCRIPT */
8856 DEFSYM (Qlibpng_version
, "libpng-version");
8857 Fset (Qlibpng_version
,
8859 make_number (PNG_LIBPNG_VER
)
8866 #if defined (HAVE_XPM) || defined (HAVE_NS)
8867 DEFSYM (Qxpm
, "xpm");
8868 ADD_IMAGE_TYPE (Qxpm
);
8871 #if defined (HAVE_JPEG) || defined (HAVE_NS)
8872 DEFSYM (Qjpeg
, "jpeg");
8873 ADD_IMAGE_TYPE (Qjpeg
);
8876 #if defined (HAVE_TIFF) || defined (HAVE_NS)
8877 DEFSYM (Qtiff
, "tiff");
8878 ADD_IMAGE_TYPE (Qtiff
);
8881 #if defined (HAVE_GIF) || defined (HAVE_NS)
8882 DEFSYM (Qgif
, "gif");
8883 ADD_IMAGE_TYPE (Qgif
);
8886 #if defined (HAVE_PNG) || defined (HAVE_NS)
8887 DEFSYM (Qpng
, "png");
8888 ADD_IMAGE_TYPE (Qpng
);
8891 #if defined (HAVE_IMAGEMAGICK)
8892 DEFSYM (Qimagemagick
, "imagemagick");
8893 ADD_IMAGE_TYPE (Qimagemagick
);
8896 #if defined (HAVE_RSVG)
8897 DEFSYM (Qsvg
, "svg");
8898 ADD_IMAGE_TYPE (Qsvg
);
8900 /* Other libraries used directly by svg code. */
8901 DEFSYM (Qgdk_pixbuf
, "gdk-pixbuf");
8902 DEFSYM (Qglib
, "glib");
8903 DEFSYM (Qgobject
, "gobject");
8904 #endif /* HAVE_NTGUI */
8905 #endif /* HAVE_RSVG */
8907 defsubr (&Sinit_image_library
);
8908 #ifdef HAVE_IMAGEMAGICK
8909 defsubr (&Simagemagick_types
);
8911 defsubr (&Sclear_image_cache
);
8912 defsubr (&Simage_flush
);
8913 defsubr (&Simage_size
);
8914 defsubr (&Simage_mask_p
);
8915 defsubr (&Simage_metadata
);
8919 defsubr (&Slookup_image
);
8922 DEFVAR_BOOL ("cross-disabled-images", cross_disabled_images
,
8923 doc
: /* Non-nil means always draw a cross over disabled images.
8924 Disabled images are those having a `:conversion disabled' property.
8925 A cross is always drawn on black & white displays. */);
8926 cross_disabled_images
= 0;
8928 DEFVAR_LISP ("x-bitmap-file-path", Vx_bitmap_file_path
,
8929 doc
: /* List of directories to search for window system bitmap files. */);
8930 Vx_bitmap_file_path
= decode_env_path ((char *) 0, PATH_BITMAPS
);
8932 DEFVAR_LISP ("image-cache-eviction-delay", Vimage_cache_eviction_delay
,
8933 doc
: /* Maximum time after which images are removed from the cache.
8934 When an image has not been displayed this many seconds, Emacs
8935 automatically removes it from the image cache. If the cache contains
8936 a large number of images, the actual eviction time may be shorter.
8937 The value can also be nil, meaning the cache is never cleared.
8939 The function `clear-image-cache' disregards this variable. */);
8940 Vimage_cache_eviction_delay
= make_number (300);
8941 #ifdef HAVE_IMAGEMAGICK
8942 DEFVAR_INT ("imagemagick-render-type", imagemagick_render_type
,
8943 doc
: /* Integer indicating which ImageMagick rendering method to use.
8945 0 -- the default method (pixel pushing)
8946 1 -- a newer method ("MagickExportImagePixels") that may perform
8947 better (speed etc) in some cases, but has not been as thoroughly
8948 tested with Emacs as the default method. This method requires
8949 ImageMagick version 6.4.6 (approximately) or later.
8951 /* MagickExportImagePixels is in 6.4.6-9, but not 6.4.4-10. */
8952 imagemagick_render_type
= 0;