1 /* Functions for image support on window system.
3 Copyright (C) 1989, 1992-2013 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/>. */
25 #if defined HAVE_LIBPNG_PNG_H
26 # include <libpng/png.h>
36 /* This makes the fields of a Display accessible, in Xlib header files. */
38 #define XLIB_ILLEGAL_ACCESS
43 #include "dispextern.h"
44 #include "blockinput.h"
47 #include "character.h"
49 #include "termhooks.h"
52 #ifdef HAVE_SYS_STAT_H
54 #endif /* HAVE_SYS_STAT_H */
56 #ifdef HAVE_SYS_TYPES_H
57 #include <sys/types.h>
58 #endif /* HAVE_SYS_TYPES_H */
60 #ifdef HAVE_WINDOW_SYSTEM
62 #endif /* HAVE_WINDOW_SYSTEM */
65 #define COLOR_TABLE_SUPPORT 1
67 typedef struct x_bitmap_record Bitmap_Record
;
68 #define GET_PIXEL(ximg, x, y) XGetPixel (ximg, x, y)
69 #define NO_PIXMAP None
71 #define PIX_MASK_RETAIN 0
72 #define PIX_MASK_DRAW 1
73 #endif /* HAVE_X_WINDOWS */
77 /* We need (or want) w32.h only when we're _not_ compiling for Cygwin. */
82 /* W32_TODO : Color tables on W32. */
83 #undef COLOR_TABLE_SUPPORT
85 typedef struct w32_bitmap_record Bitmap_Record
;
86 #define GET_PIXEL(ximg, x, y) GetPixel (ximg, x, y)
89 #define PIX_MASK_RETAIN 0
90 #define PIX_MASK_DRAW 1
92 #define x_defined_color w32_defined_color
93 #define DefaultDepthOfScreen(screen) (one_w32_display_info.n_cbits)
95 /* Version of libpng that we were compiled with, or -1 if no PNG
96 support was compiled in. This is tested by w32-win.el to correctly
97 set up the alist used to search for PNG libraries. */
98 Lisp_Object Qlibpng_version
;
99 #endif /* HAVE_NTGUI */
102 #undef COLOR_TABLE_SUPPORT
104 typedef struct ns_bitmap_record Bitmap_Record
;
106 #define GET_PIXEL(ximg, x, y) XGetPixel (ximg, x, y)
109 #define PIX_MASK_RETAIN 0
110 #define PIX_MASK_DRAW 1
112 #define x_defined_color(f, name, color_def, alloc) \
113 ns_defined_color (f, name, color_def, alloc, 0)
114 #define DefaultDepthOfScreen(screen) x_display_list->n_planes
118 /* The symbol `postscript' identifying images of this type. */
120 static Lisp_Object Qpostscript
;
122 static void x_disable_image (struct frame
*, struct image
*);
123 static void x_edge_detection (struct frame
*, struct image
*, Lisp_Object
,
126 static void init_color_table (void);
127 static unsigned long lookup_rgb_color (struct frame
*f
, int r
, int g
, int b
);
128 #ifdef COLOR_TABLE_SUPPORT
129 static void free_color_table (void);
130 static unsigned long *colors_in_color_table (int *n
);
133 static Lisp_Object QCmax_width
, QCmax_height
;
135 /* Code to deal with bitmaps. Bitmaps are referenced by their bitmap
136 id, which is just an int that this section returns. Bitmaps are
137 reference counted so they can be shared among frames.
139 Bitmap indices are guaranteed to be > 0, so a negative number can
140 be used to indicate no bitmap.
142 If you use x_create_bitmap_from_data, then you must keep track of
143 the bitmaps yourself. That is, creating a bitmap from the same
144 data more than once will not be caught. */
147 /* Use with images created by ns_image_for_XPM. */
149 XGetPixel (XImagePtr ximage
, int x
, int y
)
151 return ns_get_pixel (ximage
, x
, y
);
154 /* Use with images created by ns_image_for_XPM; alpha set to 1;
155 pixel is assumed to be in RGB form. */
157 XPutPixel (XImagePtr ximage
, int x
, int y
, unsigned long pixel
)
159 ns_put_pixel (ximage
, x
, y
, pixel
);
164 /* Functions to access the contents of a bitmap, given an id. */
167 x_bitmap_height (struct frame
*f
, ptrdiff_t id
)
169 return FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].height
;
173 x_bitmap_width (struct frame
*f
, ptrdiff_t id
)
175 return FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].width
;
178 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI)
180 x_bitmap_pixmap (struct frame
*f
, ptrdiff_t id
)
182 /* HAVE_NTGUI needs the explicit cast here. */
183 return (ptrdiff_t) FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].pixmap
;
187 #ifdef HAVE_X_WINDOWS
189 x_bitmap_mask (struct frame
*f
, ptrdiff_t id
)
191 return FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].mask
;
195 /* Allocate a new bitmap record. Returns index of new record. */
198 x_allocate_bitmap_record (struct frame
*f
)
200 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
203 if (dpyinfo
->bitmaps_last
< dpyinfo
->bitmaps_size
)
204 return ++dpyinfo
->bitmaps_last
;
206 for (i
= 0; i
< dpyinfo
->bitmaps_size
; ++i
)
207 if (dpyinfo
->bitmaps
[i
].refcount
== 0)
211 xpalloc (dpyinfo
->bitmaps
, &dpyinfo
->bitmaps_size
,
212 10, -1, sizeof *dpyinfo
->bitmaps
);
213 return ++dpyinfo
->bitmaps_last
;
216 /* Add one reference to the reference count of the bitmap with id ID. */
219 x_reference_bitmap (struct frame
*f
, ptrdiff_t id
)
221 ++FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].refcount
;
224 /* Create a bitmap for frame F from a HEIGHT x WIDTH array of bits at BITS. */
227 x_create_bitmap_from_data (struct frame
*f
, char *bits
, unsigned int width
, unsigned int height
)
229 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
232 #ifdef HAVE_X_WINDOWS
234 bitmap
= XCreateBitmapFromData (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
235 bits
, width
, height
);
238 #endif /* HAVE_X_WINDOWS */
242 bitmap
= CreateBitmap (width
, height
,
243 FRAME_X_DISPLAY_INFO (XFRAME (frame
))->n_planes
,
244 FRAME_X_DISPLAY_INFO (XFRAME (frame
))->n_cbits
,
248 #endif /* HAVE_NTGUI */
251 void *bitmap
= ns_image_from_XBM (bits
, width
, height
);
256 id
= x_allocate_bitmap_record (f
);
259 dpyinfo
->bitmaps
[id
- 1].img
= bitmap
;
260 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
263 dpyinfo
->bitmaps
[id
- 1].file
= NULL
;
264 dpyinfo
->bitmaps
[id
- 1].height
= height
;
265 dpyinfo
->bitmaps
[id
- 1].width
= width
;
266 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
268 #ifdef HAVE_X_WINDOWS
269 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
270 dpyinfo
->bitmaps
[id
- 1].have_mask
= 0;
271 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
272 #endif /* HAVE_X_WINDOWS */
275 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
276 dpyinfo
->bitmaps
[id
- 1].hinst
= NULL
;
277 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
278 #endif /* HAVE_NTGUI */
283 /* Create bitmap from file FILE for frame F. */
286 x_create_bitmap_from_file (struct frame
*f
, Lisp_Object file
)
288 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
291 return -1; /* W32_TODO : bitmap support */
292 #endif /* HAVE_NTGUI */
296 void *bitmap
= ns_image_from_file (file
);
302 id
= x_allocate_bitmap_record (f
);
303 dpyinfo
->bitmaps
[id
- 1].img
= bitmap
;
304 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
305 dpyinfo
->bitmaps
[id
- 1].file
= xmalloc (SBYTES (file
) + 1);
306 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
307 dpyinfo
->bitmaps
[id
- 1].height
= ns_image_width (bitmap
);
308 dpyinfo
->bitmaps
[id
- 1].width
= ns_image_height (bitmap
);
309 strcpy (dpyinfo
->bitmaps
[id
- 1].file
, SSDATA (file
));
313 #ifdef HAVE_X_WINDOWS
314 unsigned int width
, height
;
316 int xhot
, yhot
, result
;
321 /* Look for an existing bitmap with the same name. */
322 for (id
= 0; id
< dpyinfo
->bitmaps_last
; ++id
)
324 if (dpyinfo
->bitmaps
[id
].refcount
325 && dpyinfo
->bitmaps
[id
].file
326 && !strcmp (dpyinfo
->bitmaps
[id
].file
, SSDATA (file
)))
328 ++dpyinfo
->bitmaps
[id
].refcount
;
333 /* Search bitmap-file-path for the file, if appropriate. */
334 if (openp (Vx_bitmap_file_path
, file
, Qnil
, &found
, make_number (R_OK
)) < 0)
337 filename
= SSDATA (found
);
339 result
= XReadBitmapFile (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
340 filename
, &width
, &height
, &bitmap
, &xhot
, &yhot
);
341 if (result
!= BitmapSuccess
)
344 id
= x_allocate_bitmap_record (f
);
345 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
346 dpyinfo
->bitmaps
[id
- 1].have_mask
= 0;
347 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
348 dpyinfo
->bitmaps
[id
- 1].file
= xmalloc (SBYTES (file
) + 1);
349 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
350 dpyinfo
->bitmaps
[id
- 1].height
= height
;
351 dpyinfo
->bitmaps
[id
- 1].width
= width
;
352 strcpy (dpyinfo
->bitmaps
[id
- 1].file
, SSDATA (file
));
355 #endif /* HAVE_X_WINDOWS */
361 free_bitmap_record (Display_Info
*dpyinfo
, Bitmap_Record
*bm
)
363 #ifdef HAVE_X_WINDOWS
364 XFreePixmap (dpyinfo
->display
, bm
->pixmap
);
366 XFreePixmap (dpyinfo
->display
, bm
->mask
);
367 #endif /* HAVE_X_WINDOWS */
370 DeleteObject (bm
->pixmap
);
371 #endif /* HAVE_NTGUI */
374 ns_release_object (bm
->img
);
384 /* Remove reference to bitmap with id number ID. */
387 x_destroy_bitmap (struct frame
*f
, ptrdiff_t id
)
389 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
393 Bitmap_Record
*bm
= &dpyinfo
->bitmaps
[id
- 1];
395 if (--bm
->refcount
== 0)
398 free_bitmap_record (dpyinfo
, bm
);
404 /* Free all the bitmaps for the display specified by DPYINFO. */
407 x_destroy_all_bitmaps (Display_Info
*dpyinfo
)
410 Bitmap_Record
*bm
= dpyinfo
->bitmaps
;
412 for (i
= 0; i
< dpyinfo
->bitmaps_last
; i
++, bm
++)
413 if (bm
->refcount
> 0)
414 free_bitmap_record (dpyinfo
, bm
);
416 dpyinfo
->bitmaps_last
= 0;
419 static bool x_create_x_image_and_pixmap (struct frame
*, int, int, int,
420 XImagePtr
*, Pixmap
*);
421 static void x_destroy_x_image (XImagePtr ximg
);
424 static XImagePtr_or_DC
image_get_x_image_or_dc (struct frame
*, struct image
*,
426 static void image_unget_x_image_or_dc (struct image
*, bool, XImagePtr_or_DC
,
429 static XImagePtr
image_get_x_image (struct frame
*, struct image
*, bool);
430 static void image_unget_x_image (struct image
*, bool, XImagePtr
);
431 #define image_get_x_image_or_dc(f, img, mask_p, dummy) \
432 image_get_x_image (f, img, mask_p)
433 #define image_unget_x_image_or_dc(img, mask_p, ximg, dummy) \
434 image_unget_x_image (img, mask_p, ximg)
437 #ifdef HAVE_X_WINDOWS
439 static void image_sync_to_pixmaps (struct frame
*, struct image
*);
441 /* Useful functions defined in the section
442 `Image type independent image structures' below. */
444 static unsigned long four_corners_best (XImagePtr ximg
,
447 unsigned long height
);
450 /* Create a mask of a bitmap. Note is this not a perfect mask.
451 It's nicer with some borders in this context */
454 x_create_bitmap_mask (struct frame
*f
, ptrdiff_t id
)
457 XImagePtr ximg
, mask_img
;
458 unsigned long width
, height
;
461 unsigned long x
, y
, xp
, xm
, yp
, ym
;
464 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
469 pixmap
= x_bitmap_pixmap (f
, id
);
470 width
= x_bitmap_width (f
, id
);
471 height
= x_bitmap_height (f
, id
);
474 ximg
= XGetImage (FRAME_X_DISPLAY (f
), pixmap
, 0, 0, width
, height
,
483 result
= x_create_x_image_and_pixmap (f
, width
, height
, 1, &mask_img
, &mask
);
488 XDestroyImage (ximg
);
492 bg
= four_corners_best (ximg
, NULL
, width
, height
);
494 for (y
= 0; y
< ximg
->height
; ++y
)
496 for (x
= 0; x
< ximg
->width
; ++x
)
498 xp
= x
!= ximg
->width
- 1 ? x
+ 1 : 0;
499 xm
= x
!= 0 ? x
- 1 : ximg
->width
- 1;
500 yp
= y
!= ximg
->height
- 1 ? y
+ 1 : 0;
501 ym
= y
!= 0 ? y
- 1 : ximg
->height
- 1;
502 if (XGetPixel (ximg
, x
, y
) == bg
503 && XGetPixel (ximg
, x
, yp
) == bg
504 && XGetPixel (ximg
, x
, ym
) == bg
505 && XGetPixel (ximg
, xp
, y
) == bg
506 && XGetPixel (ximg
, xp
, yp
) == bg
507 && XGetPixel (ximg
, xp
, ym
) == bg
508 && XGetPixel (ximg
, xm
, y
) == bg
509 && XGetPixel (ximg
, xm
, yp
) == bg
510 && XGetPixel (ximg
, xm
, ym
) == bg
)
511 XPutPixel (mask_img
, x
, y
, 0);
513 XPutPixel (mask_img
, x
, y
, 1);
517 eassert (input_blocked_p ());
518 gc
= XCreateGC (FRAME_X_DISPLAY (f
), mask
, 0, NULL
);
519 XPutImage (FRAME_X_DISPLAY (f
), mask
, gc
, mask_img
, 0, 0, 0, 0,
521 XFreeGC (FRAME_X_DISPLAY (f
), gc
);
523 dpyinfo
->bitmaps
[id
- 1].have_mask
= 1;
524 dpyinfo
->bitmaps
[id
- 1].mask
= mask
;
526 XDestroyImage (ximg
);
527 x_destroy_x_image (mask_img
);
530 #endif /* HAVE_X_WINDOWS */
533 /***********************************************************************
535 ***********************************************************************/
537 /* List of supported image types. Use define_image_type to add new
538 types. Use lookup_image_type to find a type for a given symbol. */
540 static struct image_type
*image_types
;
542 /* The symbol `xbm' which is used as the type symbol for XBM images. */
544 static Lisp_Object Qxbm
;
548 Lisp_Object QCascent
, QCmargin
, QCrelief
;
549 Lisp_Object QCconversion
;
550 static Lisp_Object QCheuristic_mask
;
551 static Lisp_Object QCcolor_symbols
;
552 static Lisp_Object QCindex
, QCmatrix
, QCcolor_adjustment
, QCmask
, QCgeometry
;
553 static Lisp_Object QCcrop
, QCrotation
;
557 static Lisp_Object Qcount
, Qextension_data
, Qdelay
;
558 static Lisp_Object Qlaplace
, Qemboss
, Qedge_detection
, Qheuristic
;
560 /* Forward function prototypes. */
562 static struct image_type
*lookup_image_type (Lisp_Object
);
563 static void x_laplace (struct frame
*, struct image
*);
564 static void x_emboss (struct frame
*, struct image
*);
565 static void x_build_heuristic_mask (struct frame
*, struct image
*,
568 extern Lisp_Object Vlibrary_cache
;
569 #define CACHE_IMAGE_TYPE(type, status) \
570 do { Vlibrary_cache = Fcons (Fcons (type, status), Vlibrary_cache); } while (0)
572 #define CACHE_IMAGE_TYPE(type, status)
575 #define ADD_IMAGE_TYPE(type) \
576 do { Vimage_types = Fcons (type, Vimage_types); } while (0)
578 /* Define a new image type from TYPE. This adds a copy of TYPE to
579 image_types and caches the loading status of TYPE. */
581 static struct image_type
*
582 define_image_type (struct image_type
*type
)
584 struct image_type
*p
= NULL
;
585 Lisp_Object target_type
= *type
->type
;
590 for (p
= image_types
; p
; p
= p
->next
)
591 if (EQ (*p
->type
, target_type
))
596 #if defined HAVE_NTGUI && defined WINDOWSNT
597 /* If we failed to load the library before, don't try again. */
598 Lisp_Object tested
= Fassq (target_type
, Vlibrary_cache
);
599 if (CONSP (tested
) && NILP (XCDR (tested
)))
604 type_valid
= type
->init ();
605 CACHE_IMAGE_TYPE (target_type
, type_valid
? Qt
: Qnil
);
611 /* Make a copy of TYPE to avoid a bus error in a dumped Emacs.
612 The initialized data segment is read-only. */
613 p
= xmalloc (sizeof *p
);
615 p
->next
= image_types
;
625 /* Value is true if OBJECT is a valid Lisp image specification. A
626 valid image specification is a list whose car is the symbol
627 `image', and whose rest is a property list. The property list must
628 contain a value for key `:type'. That value must be the name of a
629 supported image type. The rest of the property list depends on the
633 valid_image_p (Lisp_Object object
)
641 for (tem
= XCDR (object
); CONSP (tem
); tem
= XCDR (tem
))
642 if (EQ (XCAR (tem
), QCtype
))
645 if (CONSP (tem
) && SYMBOLP (XCAR (tem
)))
647 struct image_type
*type
;
648 type
= lookup_image_type (XCAR (tem
));
650 valid_p
= type
->valid_p (object
);
661 /* Log error message with format string FORMAT and argument ARG.
662 Signaling an error, e.g. when an image cannot be loaded, is not a
663 good idea because this would interrupt redisplay, and the error
664 message display would lead to another redisplay. This function
665 therefore simply displays a message. */
668 image_error (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
670 add_to_log (format
, arg1
, arg2
);
675 /***********************************************************************
677 ***********************************************************************/
679 enum image_value_type
681 IMAGE_DONT_CHECK_VALUE_TYPE
,
683 IMAGE_STRING_OR_NIL_VALUE
,
685 IMAGE_POSITIVE_INTEGER_VALUE
,
686 IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
,
687 IMAGE_NON_NEGATIVE_INTEGER_VALUE
,
690 IMAGE_FUNCTION_VALUE
,
695 /* Structure used when parsing image specifications. */
699 /* Name of keyword. */
702 /* The type of value allowed. */
703 enum image_value_type type
;
705 /* True means key must be present. */
708 /* Used to recognize duplicate keywords in a property list. */
711 /* The value that was found. */
716 /* Parse image spec SPEC according to KEYWORDS. A valid image spec
717 has the format (image KEYWORD VALUE ...). One of the keyword/
718 value pairs must be `:type TYPE'. KEYWORDS is a vector of
719 image_keywords structures of size NKEYWORDS describing other
720 allowed keyword/value pairs. Value is true if SPEC is valid. */
723 parse_image_spec (Lisp_Object spec
, struct image_keyword
*keywords
,
724 int nkeywords
, Lisp_Object type
)
733 while (CONSP (plist
))
735 Lisp_Object key
, value
;
737 /* First element of a pair must be a symbol. */
739 plist
= XCDR (plist
);
743 /* There must follow a value. */
746 value
= XCAR (plist
);
747 plist
= XCDR (plist
);
749 /* Find key in KEYWORDS. Error if not found. */
750 for (i
= 0; i
< nkeywords
; ++i
)
751 if (strcmp (keywords
[i
].name
, SSDATA (SYMBOL_NAME (key
))) == 0)
757 /* Record that we recognized the keyword. If a keywords
758 was found more than once, it's an error. */
759 keywords
[i
].value
= value
;
760 if (keywords
[i
].count
> 1)
764 /* Check type of value against allowed type. */
765 switch (keywords
[i
].type
)
767 case IMAGE_STRING_VALUE
:
768 if (!STRINGP (value
))
772 case IMAGE_STRING_OR_NIL_VALUE
:
773 if (!STRINGP (value
) && !NILP (value
))
777 case IMAGE_SYMBOL_VALUE
:
778 if (!SYMBOLP (value
))
782 case IMAGE_POSITIVE_INTEGER_VALUE
:
783 if (! RANGED_INTEGERP (1, value
, INT_MAX
))
787 case IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
:
788 if (RANGED_INTEGERP (0, value
, INT_MAX
))
791 && RANGED_INTEGERP (0, XCAR (value
), INT_MAX
)
792 && RANGED_INTEGERP (0, XCDR (value
), INT_MAX
))
796 case IMAGE_ASCENT_VALUE
:
797 if (SYMBOLP (value
) && EQ (value
, Qcenter
))
799 else if (RANGED_INTEGERP (0, value
, 100))
803 case IMAGE_NON_NEGATIVE_INTEGER_VALUE
:
804 /* Unlike the other integer-related cases, this one does not
805 verify that VALUE fits in 'int'. This is because callers
807 if (!INTEGERP (value
) || XINT (value
) < 0)
811 case IMAGE_DONT_CHECK_VALUE_TYPE
:
814 case IMAGE_FUNCTION_VALUE
:
815 value
= indirect_function (value
);
816 if (!NILP (Ffunctionp (value
)))
820 case IMAGE_NUMBER_VALUE
:
821 if (!INTEGERP (value
) && !FLOATP (value
))
825 case IMAGE_INTEGER_VALUE
:
826 if (! TYPE_RANGED_INTEGERP (int, value
))
830 case IMAGE_BOOL_VALUE
:
831 if (!NILP (value
) && !EQ (value
, Qt
))
840 if (EQ (key
, QCtype
) && !EQ (type
, value
))
844 /* Check that all mandatory fields are present. */
845 for (i
= 0; i
< nkeywords
; ++i
)
846 if (keywords
[i
].mandatory_p
&& keywords
[i
].count
== 0)
853 /* Return the value of KEY in image specification SPEC. Value is nil
854 if KEY is not present in SPEC. Set *FOUND depending on whether KEY
855 was found in SPEC. */
858 image_spec_value (Lisp_Object spec
, Lisp_Object key
, bool *found
)
862 eassert (valid_image_p (spec
));
864 for (tail
= XCDR (spec
);
865 CONSP (tail
) && CONSP (XCDR (tail
));
866 tail
= XCDR (XCDR (tail
)))
868 if (EQ (XCAR (tail
), key
))
872 return XCAR (XCDR (tail
));
882 DEFUN ("image-size", Fimage_size
, Simage_size
, 1, 3, 0,
883 doc
: /* Return the size of image SPEC as pair (WIDTH . HEIGHT).
884 PIXELS non-nil means return the size in pixels, otherwise return the
885 size in canonical character units.
886 FRAME is the frame on which the image will be displayed. FRAME nil
887 or omitted means use the selected frame. */)
888 (Lisp_Object spec
, Lisp_Object pixels
, Lisp_Object frame
)
893 if (valid_image_p (spec
))
895 struct frame
*f
= decode_window_system_frame (frame
);
896 ptrdiff_t id
= lookup_image (f
, spec
);
897 struct image
*img
= IMAGE_FROM_ID (f
, id
);
898 int width
= img
->width
+ 2 * img
->hmargin
;
899 int height
= img
->height
+ 2 * img
->vmargin
;
902 size
= Fcons (make_float ((double) width
/ FRAME_COLUMN_WIDTH (f
)),
903 make_float ((double) height
/ FRAME_LINE_HEIGHT (f
)));
905 size
= Fcons (make_number (width
), make_number (height
));
908 error ("Invalid image specification");
914 DEFUN ("image-mask-p", Fimage_mask_p
, Simage_mask_p
, 1, 2, 0,
915 doc
: /* Return t if image SPEC has a mask bitmap.
916 FRAME is the frame on which the image will be displayed. FRAME nil
917 or omitted means use the selected frame. */)
918 (Lisp_Object spec
, Lisp_Object frame
)
923 if (valid_image_p (spec
))
925 struct frame
*f
= decode_window_system_frame (frame
);
926 ptrdiff_t id
= lookup_image (f
, spec
);
927 struct image
*img
= IMAGE_FROM_ID (f
, id
);
932 error ("Invalid image specification");
937 DEFUN ("image-metadata", Fimage_metadata
, Simage_metadata
, 1, 2, 0,
938 doc
: /* Return metadata for image SPEC.
939 FRAME is the frame on which the image will be displayed. FRAME nil
940 or omitted means use the selected frame. */)
941 (Lisp_Object spec
, Lisp_Object frame
)
946 if (valid_image_p (spec
))
948 struct frame
*f
= decode_window_system_frame (frame
);
949 ptrdiff_t id
= lookup_image (f
, spec
);
950 struct image
*img
= IMAGE_FROM_ID (f
, id
);
951 ext
= img
->lisp_data
;
958 /***********************************************************************
959 Image type independent image structures
960 ***********************************************************************/
962 #define MAX_IMAGE_SIZE 10.0
963 /* Allocate and return a new image structure for image specification
964 SPEC. SPEC has a hash value of HASH. */
966 static struct image
*
967 make_image (Lisp_Object spec
, EMACS_UINT hash
)
969 struct image
*img
= xzalloc (sizeof *img
);
970 Lisp_Object file
= image_spec_value (spec
, QCfile
, NULL
);
972 eassert (valid_image_p (spec
));
973 img
->dependencies
= NILP (file
) ? Qnil
: list1 (file
);
974 img
->type
= lookup_image_type (image_spec_value (spec
, QCtype
, NULL
));
975 eassert (img
->type
!= NULL
);
977 img
->lisp_data
= Qnil
;
978 img
->ascent
= DEFAULT_IMAGE_ASCENT
;
980 img
->corners
[BOT_CORNER
] = -1; /* Full image */
985 /* Free image IMG which was used on frame F, including its resources. */
988 free_image (struct frame
*f
, struct image
*img
)
992 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
994 /* Remove IMG from the hash table of its cache. */
996 img
->prev
->next
= img
->next
;
998 c
->buckets
[img
->hash
% IMAGE_CACHE_BUCKETS_SIZE
] = img
->next
;
1001 img
->next
->prev
= img
->prev
;
1003 c
->images
[img
->id
] = NULL
;
1005 /* Free resources, then free IMG. */
1006 img
->type
->free (f
, img
);
1011 /* Return true if the given widths and heights are valid for display. */
1014 check_image_size (struct frame
*f
, int width
, int height
)
1018 if (width
<= 0 || height
<= 0)
1021 if (INTEGERP (Vmax_image_size
))
1022 return (width
<= XINT (Vmax_image_size
)
1023 && height
<= XINT (Vmax_image_size
));
1024 else if (FLOATP (Vmax_image_size
))
1028 w
= FRAME_PIXEL_WIDTH (f
);
1029 h
= FRAME_PIXEL_HEIGHT (f
);
1032 w
= h
= 1024; /* Arbitrary size for unknown frame. */
1033 return (width
<= XFLOAT_DATA (Vmax_image_size
) * w
1034 && height
<= XFLOAT_DATA (Vmax_image_size
) * h
);
1040 /* Prepare image IMG for display on frame F. Must be called before
1041 drawing an image. */
1044 prepare_image_for_display (struct frame
*f
, struct image
*img
)
1046 /* We're about to display IMG, so set its timestamp to `now'. */
1047 img
->timestamp
= current_emacs_time ();
1049 /* If IMG doesn't have a pixmap yet, load it now, using the image
1050 type dependent loader function. */
1051 if (img
->pixmap
== NO_PIXMAP
&& !img
->load_failed_p
)
1052 img
->load_failed_p
= ! img
->type
->load (f
, img
);
1054 #ifdef HAVE_X_WINDOWS
1055 if (!img
->load_failed_p
)
1058 image_sync_to_pixmaps (f
, img
);
1065 /* Value is the number of pixels for the ascent of image IMG when
1066 drawn in face FACE. */
1069 image_ascent (struct image
*img
, struct face
*face
, struct glyph_slice
*slice
)
1074 if (slice
->height
== img
->height
)
1075 height
= img
->height
+ img
->vmargin
;
1076 else if (slice
->y
== 0)
1077 height
= slice
->height
+ img
->vmargin
;
1079 height
= slice
->height
;
1081 if (img
->ascent
== CENTERED_IMAGE_ASCENT
)
1086 /* W32 specific version. Why?. ++kfs */
1087 ascent
= height
/ 2 - (FONT_DESCENT (face
->font
)
1088 - FONT_BASE (face
->font
)) / 2;
1090 /* This expression is arranged so that if the image can't be
1091 exactly centered, it will be moved slightly up. This is
1092 because a typical font is `top-heavy' (due to the presence
1093 uppercase letters), so the image placement should err towards
1094 being top-heavy too. It also just generally looks better. */
1095 ascent
= (height
+ FONT_BASE (face
->font
)
1096 - FONT_DESCENT (face
->font
) + 1) / 2;
1097 #endif /* HAVE_NTGUI */
1100 ascent
= height
/ 2;
1103 ascent
= height
* (img
->ascent
/ 100.0);
1109 /* Image background colors. */
1111 /* Find the "best" corner color of a bitmap.
1112 On W32, XIMG is assumed to a device context with the bitmap selected. */
1114 static RGB_PIXEL_COLOR
1115 four_corners_best (XImagePtr_or_DC ximg
, int *corners
,
1116 unsigned long width
, unsigned long height
)
1118 RGB_PIXEL_COLOR corner_pixels
[4], best
IF_LINT (= 0);
1121 if (corners
&& corners
[BOT_CORNER
] >= 0)
1123 /* Get the colors at the corner_pixels of ximg. */
1124 corner_pixels
[0] = GET_PIXEL (ximg
, corners
[LEFT_CORNER
], corners
[TOP_CORNER
]);
1125 corner_pixels
[1] = GET_PIXEL (ximg
, corners
[RIGHT_CORNER
] - 1, corners
[TOP_CORNER
]);
1126 corner_pixels
[2] = GET_PIXEL (ximg
, corners
[RIGHT_CORNER
] - 1, corners
[BOT_CORNER
] - 1);
1127 corner_pixels
[3] = GET_PIXEL (ximg
, corners
[LEFT_CORNER
], corners
[BOT_CORNER
] - 1);
1131 /* Get the colors at the corner_pixels of ximg. */
1132 corner_pixels
[0] = GET_PIXEL (ximg
, 0, 0);
1133 corner_pixels
[1] = GET_PIXEL (ximg
, width
- 1, 0);
1134 corner_pixels
[2] = GET_PIXEL (ximg
, width
- 1, height
- 1);
1135 corner_pixels
[3] = GET_PIXEL (ximg
, 0, height
- 1);
1137 /* Choose the most frequently found color as background. */
1138 for (i
= best_count
= 0; i
< 4; ++i
)
1142 for (j
= n
= 0; j
< 4; ++j
)
1143 if (corner_pixels
[i
] == corner_pixels
[j
])
1147 best
= corner_pixels
[i
], best_count
= n
;
1153 /* Portability macros */
1157 #define Free_Pixmap(display, pixmap) \
1158 DeleteObject (pixmap)
1160 #elif defined (HAVE_NS)
1162 #define Free_Pixmap(display, pixmap) \
1163 ns_release_object (pixmap)
1167 #define Free_Pixmap(display, pixmap) \
1168 XFreePixmap (display, pixmap)
1170 #endif /* !HAVE_NTGUI && !HAVE_NS */
1173 /* Return the `background' field of IMG. If IMG doesn't have one yet,
1174 it is guessed heuristically. If non-zero, XIMG is an existing
1175 XImage object (or device context with the image selected on W32) to
1176 use for the heuristic. */
1179 image_background (struct image
*img
, struct frame
*f
, XImagePtr_or_DC ximg
)
1181 if (! img
->background_valid
)
1182 /* IMG doesn't have a background yet, try to guess a reasonable value. */
1184 bool free_ximg
= !ximg
;
1187 #endif /* HAVE_NTGUI */
1190 ximg
= image_get_x_image_or_dc (f
, img
, 0, &prev
);
1192 img
->background
= four_corners_best (ximg
, img
->corners
, img
->width
, img
->height
);
1195 image_unget_x_image_or_dc (img
, 0, ximg
, prev
);
1197 img
->background_valid
= 1;
1200 return img
->background
;
1203 /* Return the `background_transparent' field of IMG. If IMG doesn't
1204 have one yet, it is guessed heuristically. If non-zero, MASK is an
1205 existing XImage object to use for the heuristic. */
1208 image_background_transparent (struct image
*img
, struct frame
*f
, XImagePtr_or_DC mask
)
1210 if (! img
->background_transparent_valid
)
1211 /* IMG doesn't have a background yet, try to guess a reasonable value. */
1215 bool free_mask
= !mask
;
1218 #endif /* HAVE_NTGUI */
1221 mask
= image_get_x_image_or_dc (f
, img
, 1, &prev
);
1223 img
->background_transparent
1224 = (four_corners_best (mask
, img
->corners
, img
->width
, img
->height
) == PIX_MASK_RETAIN
);
1227 image_unget_x_image_or_dc (img
, 1, mask
, prev
);
1230 img
->background_transparent
= 0;
1232 img
->background_transparent_valid
= 1;
1235 return img
->background_transparent
;
1239 /***********************************************************************
1240 Helper functions for X image types
1241 ***********************************************************************/
1243 /* Clear X resources of image IMG on frame F according to FLAGS.
1244 FLAGS is bitwise-or of the following masks:
1245 CLEAR_IMAGE_PIXMAP free the pixmap if any.
1246 CLEAR_IMAGE_MASK means clear the mask pixmap if any.
1247 CLEAR_IMAGE_COLORS means free colors allocated for the image, if
1250 #define CLEAR_IMAGE_PIXMAP (1 << 0)
1251 #define CLEAR_IMAGE_MASK (1 << 1)
1252 #define CLEAR_IMAGE_COLORS (1 << 2)
1255 x_clear_image_1 (struct frame
*f
, struct image
*img
, int flags
)
1257 if (flags
& CLEAR_IMAGE_PIXMAP
)
1261 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->pixmap
);
1262 img
->pixmap
= NO_PIXMAP
;
1263 /* NOTE (HAVE_NS): background color is NOT an indexed color! */
1264 img
->background_valid
= 0;
1266 #ifdef HAVE_X_WINDOWS
1269 x_destroy_x_image (img
->ximg
);
1271 img
->background_valid
= 0;
1276 if (flags
& CLEAR_IMAGE_MASK
)
1280 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->mask
);
1281 img
->mask
= NO_PIXMAP
;
1282 img
->background_transparent_valid
= 0;
1284 #ifdef HAVE_X_WINDOWS
1287 x_destroy_x_image (img
->mask_img
);
1288 img
->mask_img
= NULL
;
1289 img
->background_transparent_valid
= 0;
1294 if ((flags
& CLEAR_IMAGE_COLORS
) && img
->ncolors
)
1296 /* W32_TODO: color table support. */
1297 #ifdef HAVE_X_WINDOWS
1298 x_free_colors (f
, img
->colors
, img
->ncolors
);
1299 #endif /* HAVE_X_WINDOWS */
1300 xfree (img
->colors
);
1307 /* Free X resources of image IMG which is used on frame F. */
1310 x_clear_image (struct frame
*f
, struct image
*img
)
1313 x_clear_image_1 (f
, img
,
1314 CLEAR_IMAGE_PIXMAP
| CLEAR_IMAGE_MASK
| CLEAR_IMAGE_COLORS
);
1319 /* Allocate color COLOR_NAME for image IMG on frame F. If color
1320 cannot be allocated, use DFLT. Add a newly allocated color to
1321 IMG->colors, so that it can be freed again. Value is the pixel
1324 static unsigned long
1325 x_alloc_image_color (struct frame
*f
, struct image
*img
, Lisp_Object color_name
,
1329 unsigned long result
;
1331 eassert (STRINGP (color_name
));
1333 if (x_defined_color (f
, SSDATA (color_name
), &color
, 1)
1334 && img
->ncolors
< min (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *img
->colors
,
1337 /* This isn't called frequently so we get away with simply
1338 reallocating the color vector to the needed size, here. */
1339 ptrdiff_t ncolors
= img
->ncolors
+ 1;
1340 img
->colors
= xrealloc (img
->colors
, ncolors
* sizeof *img
->colors
);
1341 img
->colors
[ncolors
- 1] = color
.pixel
;
1342 img
->ncolors
= ncolors
;
1343 result
= color
.pixel
;
1353 /***********************************************************************
1355 ***********************************************************************/
1357 static void cache_image (struct frame
*f
, struct image
*img
);
1359 /* Return a new, initialized image cache that is allocated from the
1360 heap. Call free_image_cache to free an image cache. */
1362 struct image_cache
*
1363 make_image_cache (void)
1365 struct image_cache
*c
= xzalloc (sizeof *c
);
1369 c
->images
= xmalloc (size
* sizeof *c
->images
);
1371 size
= IMAGE_CACHE_BUCKETS_SIZE
* sizeof *c
->buckets
;
1372 c
->buckets
= xzalloc (size
);
1377 /* Find an image matching SPEC in the cache, and return it. If no
1378 image is found, return NULL. */
1379 static struct image
*
1380 search_image_cache (struct frame
*f
, Lisp_Object spec
, EMACS_UINT hash
)
1383 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1384 int i
= hash
% IMAGE_CACHE_BUCKETS_SIZE
;
1386 if (!c
) return NULL
;
1388 /* If the image spec does not specify a background color, the cached
1389 image must have the same background color as the current frame.
1390 The foreground color must also match, for the sake of monochrome
1393 In fact, we could ignore the foreground color matching condition
1394 for color images, or if the image spec specifies :foreground;
1395 similarly we could ignore the background color matching condition
1396 for formats that don't use transparency (such as jpeg), or if the
1397 image spec specifies :background. However, the extra memory
1398 usage is probably negligible in practice, so we don't bother. */
1400 for (img
= c
->buckets
[i
]; img
; img
= img
->next
)
1401 if (img
->hash
== hash
1402 && !NILP (Fequal (img
->spec
, spec
))
1403 && img
->frame_foreground
== FRAME_FOREGROUND_PIXEL (f
)
1404 && img
->frame_background
== FRAME_BACKGROUND_PIXEL (f
))
1410 /* Search frame F for an image with spec SPEC, and free it. */
1413 uncache_image (struct frame
*f
, Lisp_Object spec
)
1415 struct image
*img
= search_image_cache (f
, spec
, sxhash (spec
, 0));
1418 free_image (f
, img
);
1419 /* As display glyphs may still be referring to the image ID, we
1420 must garbage the frame (Bug#6426). */
1421 SET_FRAME_GARBAGED (f
);
1426 /* Free image cache of frame F. Be aware that X frames share images
1430 free_image_cache (struct frame
*f
)
1432 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1437 /* Cache should not be referenced by any frame when freed. */
1438 eassert (c
->refcount
== 0);
1440 for (i
= 0; i
< c
->used
; ++i
)
1441 free_image (f
, c
->images
[i
]);
1445 FRAME_IMAGE_CACHE (f
) = NULL
;
1450 /* Clear image cache of frame F. FILTER=t means free all images.
1451 FILTER=nil means clear only images that haven't been
1452 displayed for some time.
1453 Else, only free the images which have FILTER in their `dependencies'.
1454 Should be called from time to time to reduce the number of loaded images.
1455 If image-cache-eviction-delay is non-nil, this frees images in the cache
1456 which weren't displayed for at least that many seconds. */
1459 clear_image_cache (struct frame
*f
, Lisp_Object filter
)
1461 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1465 ptrdiff_t i
, nfreed
= 0;
1467 /* Block input so that we won't be interrupted by a SIGIO
1468 while being in an inconsistent state. */
1473 /* Filter image cache. */
1474 for (i
= 0; i
< c
->used
; ++i
)
1476 struct image
*img
= c
->images
[i
];
1477 if (img
&& (EQ (Qt
, filter
)
1478 || !NILP (Fmember (filter
, img
->dependencies
))))
1480 free_image (f
, img
);
1485 else if (INTEGERP (Vimage_cache_eviction_delay
))
1487 /* Free cache based on timestamp. */
1490 ptrdiff_t nimages
= 0;
1492 for (i
= 0; i
< c
->used
; ++i
)
1496 /* If the number of cached images has grown unusually large,
1497 decrease the cache eviction delay (Bug#6230). */
1498 delay
= XINT (Vimage_cache_eviction_delay
);
1500 delay
= 1600 * delay
/ nimages
/ nimages
;
1501 delay
= max (delay
, 1);
1503 t
= current_emacs_time ();
1504 old
= sub_emacs_time (t
, EMACS_TIME_FROM_DOUBLE (delay
));
1506 for (i
= 0; i
< c
->used
; ++i
)
1508 struct image
*img
= c
->images
[i
];
1509 if (img
&& EMACS_TIME_LT (img
->timestamp
, old
))
1511 free_image (f
, img
);
1517 /* We may be clearing the image cache because, for example,
1518 Emacs was iconified for a longer period of time. In that
1519 case, current matrices may still contain references to
1520 images freed above. So, clear these matrices. */
1523 Lisp_Object tail
, frame
;
1525 FOR_EACH_FRAME (tail
, frame
)
1527 struct frame
*fr
= XFRAME (frame
);
1528 if (FRAME_IMAGE_CACHE (fr
) == c
)
1529 clear_current_matrices (fr
);
1532 ++windows_or_buffers_changed
;
1540 clear_image_caches (Lisp_Object filter
)
1542 /* FIXME: We want to do
1543 * struct terminal *t;
1544 * for (t = terminal_list; t; t = t->next_terminal)
1545 * clear_image_cache (t, filter); */
1546 Lisp_Object tail
, frame
;
1547 FOR_EACH_FRAME (tail
, frame
)
1548 if (FRAME_WINDOW_P (XFRAME (frame
)))
1549 clear_image_cache (XFRAME (frame
), filter
);
1552 DEFUN ("clear-image-cache", Fclear_image_cache
, Sclear_image_cache
,
1554 doc
: /* Clear the image cache.
1555 FILTER nil or a frame means clear all images in the selected frame.
1556 FILTER t means clear the image caches of all frames.
1557 Anything else, means only clear those images which refer to FILTER,
1558 which is then usually a filename. */)
1559 (Lisp_Object filter
)
1561 if (!(EQ (filter
, Qnil
) || FRAMEP (filter
)))
1562 clear_image_caches (filter
);
1564 clear_image_cache (decode_window_system_frame (filter
), Qt
);
1570 DEFUN ("image-flush", Fimage_flush
, Simage_flush
,
1572 doc
: /* Flush the image with specification SPEC on frame FRAME.
1573 This removes the image from the Emacs image cache. If SPEC specifies
1574 an image file, the next redisplay of this image will read from the
1575 current contents of that file.
1577 FRAME nil or omitted means use the selected frame.
1578 FRAME t means refresh the image on all frames. */)
1579 (Lisp_Object spec
, Lisp_Object frame
)
1581 if (!valid_image_p (spec
))
1582 error ("Invalid image specification");
1587 FOR_EACH_FRAME (tail
, frame
)
1589 struct frame
*f
= XFRAME (frame
);
1590 if (FRAME_WINDOW_P (f
))
1591 uncache_image (f
, spec
);
1595 uncache_image (decode_window_system_frame (frame
), spec
);
1601 /* Compute masks and transform image IMG on frame F, as specified
1602 by the image's specification, */
1605 postprocess_image (struct frame
*f
, struct image
*img
)
1607 /* Manipulation of the image's mask. */
1610 Lisp_Object conversion
, spec
;
1615 /* `:heuristic-mask t'
1617 means build a mask heuristically.
1618 `:heuristic-mask (R G B)'
1619 `:mask (heuristic (R G B))'
1620 means build a mask from color (R G B) in the
1623 means remove a mask, if any. */
1625 mask
= image_spec_value (spec
, QCheuristic_mask
, NULL
);
1627 x_build_heuristic_mask (f
, img
, mask
);
1632 mask
= image_spec_value (spec
, QCmask
, &found_p
);
1634 if (EQ (mask
, Qheuristic
))
1635 x_build_heuristic_mask (f
, img
, Qt
);
1636 else if (CONSP (mask
)
1637 && EQ (XCAR (mask
), Qheuristic
))
1639 if (CONSP (XCDR (mask
)))
1640 x_build_heuristic_mask (f
, img
, XCAR (XCDR (mask
)));
1642 x_build_heuristic_mask (f
, img
, XCDR (mask
));
1644 else if (NILP (mask
) && found_p
&& img
->mask
)
1645 x_clear_image_1 (f
, img
, CLEAR_IMAGE_MASK
);
1649 /* Should we apply an image transformation algorithm? */
1650 conversion
= image_spec_value (spec
, QCconversion
, NULL
);
1651 if (EQ (conversion
, Qdisabled
))
1652 x_disable_image (f
, img
);
1653 else if (EQ (conversion
, Qlaplace
))
1655 else if (EQ (conversion
, Qemboss
))
1657 else if (CONSP (conversion
)
1658 && EQ (XCAR (conversion
), Qedge_detection
))
1661 tem
= XCDR (conversion
);
1663 x_edge_detection (f
, img
,
1664 Fplist_get (tem
, QCmatrix
),
1665 Fplist_get (tem
, QCcolor_adjustment
));
1671 /* Return the id of image with Lisp specification SPEC on frame F.
1672 SPEC must be a valid Lisp image specification (see valid_image_p). */
1675 lookup_image (struct frame
*f
, Lisp_Object spec
)
1680 /* F must be a window-system frame, and SPEC must be a valid image
1682 eassert (FRAME_WINDOW_P (f
));
1683 eassert (valid_image_p (spec
));
1685 /* Look up SPEC in the hash table of the image cache. */
1686 hash
= sxhash (spec
, 0);
1687 img
= search_image_cache (f
, spec
, hash
);
1688 if (img
&& img
->load_failed_p
)
1690 free_image (f
, img
);
1694 /* If not found, create a new image and cache it. */
1698 img
= make_image (spec
, hash
);
1699 cache_image (f
, img
);
1700 img
->load_failed_p
= ! img
->type
->load (f
, img
);
1701 img
->frame_foreground
= FRAME_FOREGROUND_PIXEL (f
);
1702 img
->frame_background
= FRAME_BACKGROUND_PIXEL (f
);
1704 /* If we can't load the image, and we don't have a width and
1705 height, use some arbitrary width and height so that we can
1706 draw a rectangle for it. */
1707 if (img
->load_failed_p
)
1711 value
= image_spec_value (spec
, QCwidth
, NULL
);
1712 img
->width
= (INTEGERP (value
)
1713 ? XFASTINT (value
) : DEFAULT_IMAGE_WIDTH
);
1714 value
= image_spec_value (spec
, QCheight
, NULL
);
1715 img
->height
= (INTEGERP (value
)
1716 ? XFASTINT (value
) : DEFAULT_IMAGE_HEIGHT
);
1720 /* Handle image type independent image attributes
1721 `:ascent ASCENT', `:margin MARGIN', `:relief RELIEF',
1722 `:background COLOR'. */
1723 Lisp_Object ascent
, margin
, relief
, bg
;
1726 ascent
= image_spec_value (spec
, QCascent
, NULL
);
1727 if (INTEGERP (ascent
))
1728 img
->ascent
= XFASTINT (ascent
);
1729 else if (EQ (ascent
, Qcenter
))
1730 img
->ascent
= CENTERED_IMAGE_ASCENT
;
1732 margin
= image_spec_value (spec
, QCmargin
, NULL
);
1733 if (INTEGERP (margin
))
1734 img
->vmargin
= img
->hmargin
= XFASTINT (margin
);
1735 else if (CONSP (margin
))
1737 img
->hmargin
= XFASTINT (XCAR (margin
));
1738 img
->vmargin
= XFASTINT (XCDR (margin
));
1741 relief
= image_spec_value (spec
, QCrelief
, NULL
);
1742 relief_bound
= INT_MAX
- max (img
->hmargin
, img
->vmargin
);
1743 if (RANGED_INTEGERP (- relief_bound
, relief
, relief_bound
))
1745 img
->relief
= XINT (relief
);
1746 img
->hmargin
+= eabs (img
->relief
);
1747 img
->vmargin
+= eabs (img
->relief
);
1750 if (! img
->background_valid
)
1752 bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
1756 = x_alloc_image_color (f
, img
, bg
,
1757 FRAME_BACKGROUND_PIXEL (f
));
1758 img
->background_valid
= 1;
1762 /* Do image transformations and compute masks, unless we
1763 don't have the image yet. */
1764 if (!EQ (*img
->type
->type
, Qpostscript
))
1765 postprocess_image (f
, img
);
1771 /* We're using IMG, so set its timestamp to `now'. */
1772 img
->timestamp
= current_emacs_time ();
1774 /* Value is the image id. */
1779 /* Cache image IMG in the image cache of frame F. */
1782 cache_image (struct frame
*f
, struct image
*img
)
1784 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1787 /* Find a free slot in c->images. */
1788 for (i
= 0; i
< c
->used
; ++i
)
1789 if (c
->images
[i
] == NULL
)
1792 /* If no free slot found, maybe enlarge c->images. */
1793 if (i
== c
->used
&& c
->used
== c
->size
)
1794 c
->images
= xpalloc (c
->images
, &c
->size
, 1, -1, sizeof *c
->images
);
1796 /* Add IMG to c->images, and assign IMG an id. */
1802 /* Add IMG to the cache's hash table. */
1803 i
= img
->hash
% IMAGE_CACHE_BUCKETS_SIZE
;
1804 img
->next
= c
->buckets
[i
];
1806 img
->next
->prev
= img
;
1808 c
->buckets
[i
] = img
;
1812 /* Call FN on every image in the image cache of frame F. Used to mark
1813 Lisp Objects in the image cache. */
1815 /* Mark Lisp objects in image IMG. */
1818 mark_image (struct image
*img
)
1820 mark_object (img
->spec
);
1821 mark_object (img
->dependencies
);
1823 if (!NILP (img
->lisp_data
))
1824 mark_object (img
->lisp_data
);
1829 mark_image_cache (struct image_cache
*c
)
1834 for (i
= 0; i
< c
->used
; ++i
)
1836 mark_image (c
->images
[i
]);
1842 /***********************************************************************
1843 X / NS / W32 support code
1844 ***********************************************************************/
1848 /* Macro for defining functions that will be loaded from image DLLs. */
1849 #define DEF_IMGLIB_FN(rettype,func,args) static rettype (FAR CDECL *fn_##func)args
1851 /* Macro for loading those image functions from the library. */
1852 #define LOAD_IMGLIB_FN(lib,func) { \
1853 fn_##func = (void *) GetProcAddress (lib, #func); \
1854 if (!fn_##func) return 0; \
1857 #endif /* WINDOWSNT */
1859 /* Return true if XIMG's size WIDTH x HEIGHT doesn't break the
1861 WIDTH and HEIGHT must both be positive.
1862 If XIMG is null, assume it is a bitmap. */
1864 x_check_image_size (XImagePtr ximg
, int width
, int height
)
1866 #ifdef HAVE_X_WINDOWS
1867 /* Respect Xlib's limits: it cannot deal with images that have more
1868 than INT_MAX (and/or UINT_MAX) bytes. And respect Emacs's limits
1869 of PTRDIFF_MAX (and/or SIZE_MAX) bytes for any object. */
1872 XLIB_BYTES_MAX
= min (INT_MAX
, UINT_MAX
),
1873 X_IMAGE_BYTES_MAX
= min (XLIB_BYTES_MAX
, min (PTRDIFF_MAX
, SIZE_MAX
))
1876 int bitmap_pad
, depth
, bytes_per_line
;
1879 bitmap_pad
= ximg
->bitmap_pad
;
1880 depth
= ximg
->depth
;
1881 bytes_per_line
= ximg
->bytes_per_line
;
1887 bytes_per_line
= (width
>> 3) + ((width
& 7) != 0);
1889 return (width
<= (INT_MAX
- (bitmap_pad
- 1)) / depth
1890 && height
<= X_IMAGE_BYTES_MAX
/ bytes_per_line
);
1892 /* FIXME: Implement this check for the HAVE_NS and HAVE_NTGUI cases.
1893 For now, assume that every image size is allowed on these systems. */
1898 /* Create an XImage and a pixmap of size WIDTH x HEIGHT for use on
1899 frame F. Set *XIMG and *PIXMAP to the XImage and Pixmap created.
1900 Set (*XIMG)->data to a raster of WIDTH x HEIGHT pixels allocated
1901 via xmalloc. Print error messages via image_error if an error
1902 occurs. Value is true if successful.
1904 On W32, a DEPTH of zero signifies a 24 bit image, otherwise DEPTH
1905 should indicate the bit depth of the image. */
1908 x_create_x_image_and_pixmap (struct frame
*f
, int width
, int height
, int depth
,
1909 XImagePtr
*ximg
, Pixmap
*pixmap
)
1911 #ifdef HAVE_X_WINDOWS
1912 Display
*display
= FRAME_X_DISPLAY (f
);
1913 Window window
= FRAME_X_WINDOW (f
);
1914 Screen
*screen
= FRAME_X_SCREEN (f
);
1916 eassert (input_blocked_p ());
1919 depth
= DefaultDepthOfScreen (screen
);
1920 *ximg
= XCreateImage (display
, DefaultVisualOfScreen (screen
),
1921 depth
, ZPixmap
, 0, NULL
, width
, height
,
1922 depth
> 16 ? 32 : depth
> 8 ? 16 : 8, 0);
1925 image_error ("Unable to allocate X image", Qnil
, Qnil
);
1929 if (! x_check_image_size (*ximg
, width
, height
))
1931 x_destroy_x_image (*ximg
);
1933 image_error ("Image too large (%dx%d)",
1934 make_number (width
), make_number (height
));
1938 /* Allocate image raster. */
1939 (*ximg
)->data
= xmalloc ((*ximg
)->bytes_per_line
* height
);
1941 /* Allocate a pixmap of the same size. */
1942 *pixmap
= XCreatePixmap (display
, window
, width
, height
, depth
);
1943 if (*pixmap
== NO_PIXMAP
)
1945 x_destroy_x_image (*ximg
);
1947 image_error ("Unable to create X pixmap", Qnil
, Qnil
);
1952 #endif /* HAVE_X_WINDOWS */
1956 BITMAPINFOHEADER
*header
;
1958 int scanline_width_bits
;
1960 int palette_colors
= 0;
1965 if (depth
!= 1 && depth
!= 4 && depth
!= 8
1966 && depth
!= 16 && depth
!= 24 && depth
!= 32)
1968 image_error ("Invalid image bit depth specified", Qnil
, Qnil
);
1972 scanline_width_bits
= width
* depth
;
1973 remainder
= scanline_width_bits
% 32;
1976 scanline_width_bits
+= 32 - remainder
;
1978 /* Bitmaps with a depth less than 16 need a palette. */
1979 /* BITMAPINFO structure already contains the first RGBQUAD. */
1981 palette_colors
= 1 << (depth
- 1);
1983 *ximg
= xmalloc (sizeof (XImage
) + palette_colors
* sizeof (RGBQUAD
));
1985 header
= &(*ximg
)->info
.bmiHeader
;
1986 memset (&(*ximg
)->info
, 0, sizeof (BITMAPINFO
));
1987 header
->biSize
= sizeof (*header
);
1988 header
->biWidth
= width
;
1989 header
->biHeight
= -height
; /* negative indicates a top-down bitmap. */
1990 header
->biPlanes
= 1;
1991 header
->biBitCount
= depth
;
1992 header
->biCompression
= BI_RGB
;
1993 header
->biClrUsed
= palette_colors
;
1995 /* TODO: fill in palette. */
1998 (*ximg
)->info
.bmiColors
[0].rgbBlue
= 0;
1999 (*ximg
)->info
.bmiColors
[0].rgbGreen
= 0;
2000 (*ximg
)->info
.bmiColors
[0].rgbRed
= 0;
2001 (*ximg
)->info
.bmiColors
[0].rgbReserved
= 0;
2002 (*ximg
)->info
.bmiColors
[1].rgbBlue
= 255;
2003 (*ximg
)->info
.bmiColors
[1].rgbGreen
= 255;
2004 (*ximg
)->info
.bmiColors
[1].rgbRed
= 255;
2005 (*ximg
)->info
.bmiColors
[1].rgbReserved
= 0;
2008 hdc
= get_frame_dc (f
);
2010 /* Create a DIBSection and raster array for the bitmap,
2011 and store its handle in *pixmap. */
2012 *pixmap
= CreateDIBSection (hdc
, &((*ximg
)->info
),
2013 (depth
< 16) ? DIB_PAL_COLORS
: DIB_RGB_COLORS
,
2014 /* casting avoids a GCC warning */
2015 (void **)&((*ximg
)->data
), NULL
, 0);
2017 /* Realize display palette and garbage all frames. */
2018 release_frame_dc (f
, hdc
);
2020 if (*pixmap
== NULL
)
2022 DWORD err
= GetLastError ();
2023 Lisp_Object errcode
;
2024 /* All system errors are < 10000, so the following is safe. */
2025 XSETINT (errcode
, err
);
2026 image_error ("Unable to create bitmap, error code %d", errcode
, Qnil
);
2027 x_destroy_x_image (*ximg
);
2033 #endif /* HAVE_NTGUI */
2036 *pixmap
= ns_image_for_XPM (width
, height
, depth
);
2040 image_error ("Unable to allocate NSImage for XPM pixmap", Qnil
, Qnil
);
2049 /* Destroy XImage XIMG. Free XIMG->data. */
2052 x_destroy_x_image (XImagePtr ximg
)
2054 eassert (input_blocked_p ());
2057 #ifdef HAVE_X_WINDOWS
2060 XDestroyImage (ximg
);
2061 #endif /* HAVE_X_WINDOWS */
2063 /* Data will be freed by DestroyObject. */
2066 #endif /* HAVE_NTGUI */
2068 ns_release_object (ximg
);
2069 #endif /* HAVE_NS */
2074 /* Put XImage XIMG into pixmap PIXMAP on frame F. WIDTH and HEIGHT
2075 are width and height of both the image and pixmap. */
2078 x_put_x_image (struct frame
*f
, XImagePtr ximg
, Pixmap pixmap
, int width
, int height
)
2080 #ifdef HAVE_X_WINDOWS
2083 eassert (input_blocked_p ());
2084 gc
= XCreateGC (FRAME_X_DISPLAY (f
), pixmap
, 0, NULL
);
2085 XPutImage (FRAME_X_DISPLAY (f
), pixmap
, gc
, ximg
, 0, 0, 0, 0, width
, height
);
2086 XFreeGC (FRAME_X_DISPLAY (f
), gc
);
2087 #endif /* HAVE_X_WINDOWS */
2090 #if 0 /* I don't think this is necessary looking at where it is used. */
2091 HDC hdc
= get_frame_dc (f
);
2092 SetDIBits (hdc
, pixmap
, 0, height
, ximg
->data
, &(ximg
->info
), DIB_RGB_COLORS
);
2093 release_frame_dc (f
, hdc
);
2095 #endif /* HAVE_NTGUI */
2098 eassert (ximg
== pixmap
);
2099 ns_retain_object (ximg
);
2103 /* Thin wrapper for x_create_x_image_and_pixmap, so that it matches
2104 with image_put_x_image. */
2107 image_create_x_image_and_pixmap (struct frame
*f
, struct image
*img
,
2108 int width
, int height
, int depth
,
2109 XImagePtr
*ximg
, bool mask_p
)
2111 eassert ((!mask_p
? img
->pixmap
: img
->mask
) == NO_PIXMAP
);
2113 return x_create_x_image_and_pixmap (f
, width
, height
, depth
, ximg
,
2114 !mask_p
? &img
->pixmap
: &img
->mask
);
2117 /* Put X image XIMG into image IMG on frame F, as a mask if and only
2118 if MASK_P. On X, this simply records XIMG on a member of IMG, so
2119 it can be put into the pixmap afterwards via image_sync_to_pixmaps.
2120 On the other platforms, it puts XIMG into the pixmap, then frees
2121 the X image and its buffer. */
2124 image_put_x_image (struct frame
*f
, struct image
*img
, XImagePtr ximg
,
2127 #ifdef HAVE_X_WINDOWS
2130 eassert (img
->ximg
== NULL
);
2135 eassert (img
->mask_img
== NULL
);
2136 img
->mask_img
= ximg
;
2139 x_put_x_image (f
, ximg
, !mask_p
? img
->pixmap
: img
->mask
,
2140 img
->width
, img
->height
);
2141 x_destroy_x_image (ximg
);
2145 #ifdef HAVE_X_WINDOWS
2146 /* Put the X images recorded in IMG on frame F into pixmaps, then free
2147 the X images and their buffers. */
2150 image_sync_to_pixmaps (struct frame
*f
, struct image
*img
)
2154 x_put_x_image (f
, img
->ximg
, img
->pixmap
, img
->width
, img
->height
);
2155 x_destroy_x_image (img
->ximg
);
2160 x_put_x_image (f
, img
->mask_img
, img
->mask
, img
->width
, img
->height
);
2161 x_destroy_x_image (img
->mask_img
);
2162 img
->mask_img
= NULL
;
2168 /* Create a memory device context for IMG on frame F. It stores the
2169 currently selected GDI object into *PREV for future restoration by
2170 image_unget_x_image_or_dc. */
2172 static XImagePtr_or_DC
2173 image_get_x_image_or_dc (struct frame
*f
, struct image
*img
, bool mask_p
,
2176 HDC frame_dc
= get_frame_dc (f
);
2177 XImagePtr_or_DC ximg
= CreateCompatibleDC (frame_dc
);
2179 release_frame_dc (f
, frame_dc
);
2180 *prev
= SelectObject (ximg
, !mask_p
? img
->pixmap
: img
->mask
);
2186 image_unget_x_image_or_dc (struct image
*img
, bool mask_p
,
2187 XImagePtr_or_DC ximg
, HGDIOBJ prev
)
2189 SelectObject (ximg
, prev
);
2192 #else /* !HAVE_NTGUI */
2193 /* Get the X image for IMG on frame F. The resulting X image data
2194 should be treated as read-only at least on X. */
2197 image_get_x_image (struct frame
*f
, struct image
*img
, bool mask_p
)
2199 #ifdef HAVE_X_WINDOWS
2200 XImagePtr ximg_in_img
= !mask_p
? img
->ximg
: img
->mask_img
;
2205 return XGetImage (FRAME_X_DISPLAY (f
), !mask_p
? img
->pixmap
: img
->mask
,
2206 0, 0, img
->width
, img
->height
, ~0, ZPixmap
);
2207 #elif defined (HAVE_NS)
2208 XImagePtr pixmap
= !mask_p
? img
->pixmap
: img
->mask
;
2210 ns_retain_object (pixmap
);
2216 image_unget_x_image (struct image
*img
, bool mask_p
, XImagePtr ximg
)
2218 #ifdef HAVE_X_WINDOWS
2219 XImagePtr ximg_in_img
= !mask_p
? img
->ximg
: img
->mask_img
;
2222 eassert (ximg
== ximg_in_img
);
2224 XDestroyImage (ximg
);
2225 #elif defined (HAVE_NS)
2226 ns_release_object (ximg
);
2229 #endif /* !HAVE_NTGUI */
2232 /***********************************************************************
2234 ***********************************************************************/
2236 /* Find image file FILE. Look in data-directory/images, then
2237 x-bitmap-file-path. Value is the encoded full name of the file
2238 found, or nil if not found. */
2241 x_find_image_file (Lisp_Object file
)
2243 Lisp_Object file_found
, search_path
;
2246 /* TODO I think this should use something like image-load-path
2247 instead. Unfortunately, that can contain non-string elements. */
2248 search_path
= Fcons (Fexpand_file_name (build_string ("images"),
2250 Vx_bitmap_file_path
);
2252 /* Try to find FILE in data-directory/images, then x-bitmap-file-path. */
2253 fd
= openp (search_path
, file
, Qnil
, &file_found
, Qnil
);
2259 file_found
= ENCODE_FILE (file_found
);
2268 /* Read FILE into memory. Value is a pointer to a buffer allocated
2269 with xmalloc holding FILE's contents. Value is null if an error
2270 occurred. *SIZE is set to the size of the file. */
2272 static unsigned char *
2273 slurp_file (char *file
, ptrdiff_t *size
)
2275 FILE *fp
= emacs_fopen (file
, "rb");
2276 unsigned char *buf
= NULL
;
2281 ptrdiff_t count
= SPECPDL_INDEX ();
2282 record_unwind_protect_ptr (fclose_unwind
, fp
);
2284 if (fstat (fileno (fp
), &st
) == 0
2285 && 0 <= st
.st_size
&& st
.st_size
< min (PTRDIFF_MAX
, SIZE_MAX
))
2287 /* Report an error if we read past the purported EOF.
2288 This can happen if the file grows as we read it. */
2289 ptrdiff_t buflen
= st
.st_size
;
2290 buf
= xmalloc (buflen
+ 1);
2291 if (fread (buf
, 1, buflen
+ 1, fp
) == buflen
)
2300 unbind_to (count
, Qnil
);
2308 /***********************************************************************
2310 ***********************************************************************/
2312 static bool xbm_load (struct frame
*f
, struct image
*img
);
2313 static bool xbm_image_p (Lisp_Object object
);
2314 static bool xbm_file_p (Lisp_Object
);
2317 /* Indices of image specification fields in xbm_format, below. */
2319 enum xbm_keyword_index
2337 /* Vector of image_keyword structures describing the format
2338 of valid XBM image specifications. */
2340 static const struct image_keyword xbm_format
[XBM_LAST
] =
2342 {":type", IMAGE_SYMBOL_VALUE
, 1},
2343 {":file", IMAGE_STRING_VALUE
, 0},
2344 {":width", IMAGE_POSITIVE_INTEGER_VALUE
, 0},
2345 {":height", IMAGE_POSITIVE_INTEGER_VALUE
, 0},
2346 {":data", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
2347 {":foreground", IMAGE_STRING_OR_NIL_VALUE
, 0},
2348 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0},
2349 {":ascent", IMAGE_ASCENT_VALUE
, 0},
2350 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
2351 {":relief", IMAGE_INTEGER_VALUE
, 0},
2352 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
2353 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
2354 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0}
2357 /* Structure describing the image type XBM. */
2359 static struct image_type xbm_type
=
2369 /* Tokens returned from xbm_scan. */
2378 /* Return true if OBJECT is a valid XBM-type image specification.
2379 A valid specification is a list starting with the symbol `image'
2380 The rest of the list is a property list which must contain an
2383 If the specification specifies a file to load, it must contain
2384 an entry `:file FILENAME' where FILENAME is a string.
2386 If the specification is for a bitmap loaded from memory it must
2387 contain `:width WIDTH', `:height HEIGHT', and `:data DATA', where
2388 WIDTH and HEIGHT are integers > 0. DATA may be:
2390 1. a string large enough to hold the bitmap data, i.e. it must
2391 have a size >= (WIDTH + 7) / 8 * HEIGHT
2393 2. a bool-vector of size >= WIDTH * HEIGHT
2395 3. a vector of strings or bool-vectors, one for each line of the
2398 4. a string containing an in-memory XBM file. WIDTH and HEIGHT
2399 may not be specified in this case because they are defined in the
2402 Both the file and data forms may contain the additional entries
2403 `:background COLOR' and `:foreground COLOR'. If not present,
2404 foreground and background of the frame on which the image is
2405 displayed is used. */
2408 xbm_image_p (Lisp_Object object
)
2410 struct image_keyword kw
[XBM_LAST
];
2412 memcpy (kw
, xbm_format
, sizeof kw
);
2413 if (!parse_image_spec (object
, kw
, XBM_LAST
, Qxbm
))
2416 eassert (EQ (kw
[XBM_TYPE
].value
, Qxbm
));
2418 if (kw
[XBM_FILE
].count
)
2420 if (kw
[XBM_WIDTH
].count
|| kw
[XBM_HEIGHT
].count
|| kw
[XBM_DATA
].count
)
2423 else if (kw
[XBM_DATA
].count
&& xbm_file_p (kw
[XBM_DATA
].value
))
2425 /* In-memory XBM file. */
2426 if (kw
[XBM_WIDTH
].count
|| kw
[XBM_HEIGHT
].count
|| kw
[XBM_FILE
].count
)
2434 /* Entries for `:width', `:height' and `:data' must be present. */
2435 if (!kw
[XBM_WIDTH
].count
2436 || !kw
[XBM_HEIGHT
].count
2437 || !kw
[XBM_DATA
].count
)
2440 data
= kw
[XBM_DATA
].value
;
2441 width
= XFASTINT (kw
[XBM_WIDTH
].value
);
2442 height
= XFASTINT (kw
[XBM_HEIGHT
].value
);
2444 /* Check type of data, and width and height against contents of
2450 /* Number of elements of the vector must be >= height. */
2451 if (ASIZE (data
) < height
)
2454 /* Each string or bool-vector in data must be large enough
2455 for one line of the image. */
2456 for (i
= 0; i
< height
; ++i
)
2458 Lisp_Object elt
= AREF (data
, i
);
2463 < (width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
)
2466 else if (BOOL_VECTOR_P (elt
))
2468 if (XBOOL_VECTOR (elt
)->size
< width
)
2475 else if (STRINGP (data
))
2478 < (width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
* height
)
2481 else if (BOOL_VECTOR_P (data
))
2483 if (XBOOL_VECTOR (data
)->size
/ height
< width
)
2494 /* Scan a bitmap file. FP is the stream to read from. Value is
2495 either an enumerator from enum xbm_token, or a character for a
2496 single-character token, or 0 at end of file. If scanning an
2497 identifier, store the lexeme of the identifier in SVAL. If
2498 scanning a number, store its value in *IVAL. */
2501 xbm_scan (unsigned char **s
, unsigned char *end
, char *sval
, int *ival
)
2507 /* Skip white space. */
2508 while (*s
< end
&& (c
= *(*s
)++, c_isspace (c
)))
2513 else if (c_isdigit (c
))
2515 int value
= 0, digit
;
2517 if (c
== '0' && *s
< end
)
2520 if (c
== 'x' || c
== 'X')
2527 else if (c
>= 'a' && c
<= 'f')
2528 digit
= c
- 'a' + 10;
2529 else if (c
>= 'A' && c
<= 'F')
2530 digit
= c
- 'A' + 10;
2533 value
= 16 * value
+ digit
;
2536 else if (c_isdigit (c
))
2540 && (c
= *(*s
)++, c_isdigit (c
)))
2541 value
= 8 * value
+ c
- '0';
2548 && (c
= *(*s
)++, c_isdigit (c
)))
2549 value
= 10 * value
+ c
- '0';
2557 else if (c_isalpha (c
) || c
== '_')
2561 && (c
= *(*s
)++, (c_isalnum (c
) || c
== '_')))
2568 else if (c
== '/' && **s
== '*')
2570 /* C-style comment. */
2572 while (**s
&& (**s
!= '*' || *(*s
+ 1) != '/'))
2586 /* Create a Windows bitmap from X bitmap data. */
2588 w32_create_pixmap_from_bitmap_data (int width
, int height
, char *data
)
2590 static unsigned char swap_nibble
[16]
2591 = { 0x0, 0x8, 0x4, 0xc, /* 0000 1000 0100 1100 */
2592 0x2, 0xa, 0x6, 0xe, /* 0010 1010 0110 1110 */
2593 0x1, 0x9, 0x5, 0xd, /* 0001 1001 0101 1101 */
2594 0x3, 0xb, 0x7, 0xf }; /* 0011 1011 0111 1111 */
2596 unsigned char *bits
, *p
;
2599 w1
= (width
+ 7) / 8; /* nb of 8bits elt in X bitmap */
2600 w2
= ((width
+ 15) / 16) * 2; /* nb of 16bits elt in W32 bitmap */
2601 bits
= alloca (height
* w2
);
2602 memset (bits
, 0, height
* w2
);
2603 for (i
= 0; i
< height
; i
++)
2606 for (j
= 0; j
< w1
; j
++)
2608 /* Bitswap XBM bytes to match how Windows does things. */
2609 unsigned char c
= *data
++;
2610 *p
++ = (unsigned char)((swap_nibble
[c
& 0xf] << 4)
2611 | (swap_nibble
[(c
>>4) & 0xf]));
2614 bmp
= CreateBitmap (width
, height
, 1, 1, (char *) bits
);
2620 convert_mono_to_color_image (struct frame
*f
, struct image
*img
,
2621 COLORREF foreground
, COLORREF background
)
2623 HDC hdc
, old_img_dc
, new_img_dc
;
2624 HGDIOBJ old_prev
, new_prev
;
2627 hdc
= get_frame_dc (f
);
2628 old_img_dc
= CreateCompatibleDC (hdc
);
2629 new_img_dc
= CreateCompatibleDC (hdc
);
2630 new_pixmap
= CreateCompatibleBitmap (hdc
, img
->width
, img
->height
);
2631 release_frame_dc (f
, hdc
);
2632 old_prev
= SelectObject (old_img_dc
, img
->pixmap
);
2633 new_prev
= SelectObject (new_img_dc
, new_pixmap
);
2634 /* Windows convention for mono bitmaps is black = background,
2635 white = foreground. */
2636 SetTextColor (new_img_dc
, background
);
2637 SetBkColor (new_img_dc
, foreground
);
2639 BitBlt (new_img_dc
, 0, 0, img
->width
, img
->height
, old_img_dc
,
2642 SelectObject (old_img_dc
, old_prev
);
2643 SelectObject (new_img_dc
, new_prev
);
2644 DeleteDC (old_img_dc
);
2645 DeleteDC (new_img_dc
);
2646 DeleteObject (img
->pixmap
);
2647 if (new_pixmap
== 0)
2648 fprintf (stderr
, "Failed to convert image to color.\n");
2650 img
->pixmap
= new_pixmap
;
2653 #define XBM_BIT_SHUFFLE(b) (~(b))
2657 #define XBM_BIT_SHUFFLE(b) (b)
2659 #endif /* HAVE_NTGUI */
2663 Create_Pixmap_From_Bitmap_Data (struct frame
*f
, struct image
*img
, char *data
,
2664 RGB_PIXEL_COLOR fg
, RGB_PIXEL_COLOR bg
,
2665 bool non_default_colors
)
2669 = w32_create_pixmap_from_bitmap_data (img
->width
, img
->height
, data
);
2671 /* If colors were specified, transfer the bitmap to a color one. */
2672 if (non_default_colors
)
2673 convert_mono_to_color_image (f
, img
, fg
, bg
);
2675 #elif defined (HAVE_NS)
2676 img
->pixmap
= ns_image_from_XBM (data
, img
->width
, img
->height
);
2680 (x_check_image_size (0, img
->width
, img
->height
)
2681 ? XCreatePixmapFromBitmapData (FRAME_X_DISPLAY (f
),
2684 img
->width
, img
->height
,
2686 DefaultDepthOfScreen (FRAME_X_SCREEN (f
)))
2688 #endif /* !HAVE_NTGUI && !HAVE_NS */
2693 /* Replacement for XReadBitmapFileData which isn't available under old
2694 X versions. CONTENTS is a pointer to a buffer to parse; END is the
2695 buffer's end. Set *WIDTH and *HEIGHT to the width and height of
2696 the image. Return in *DATA the bitmap data allocated with xmalloc.
2697 Value is true if successful. DATA null means just test if
2698 CONTENTS looks like an in-memory XBM file. If INHIBIT_IMAGE_ERROR,
2699 inhibit the call to image_error when the image size is invalid (the
2700 bitmap remains unread). */
2703 xbm_read_bitmap_data (struct frame
*f
, unsigned char *contents
, unsigned char *end
,
2704 int *width
, int *height
, char **data
,
2705 bool inhibit_image_error
)
2707 unsigned char *s
= contents
;
2708 char buffer
[BUFSIZ
];
2711 int bytes_per_line
, i
, nbytes
;
2717 LA1 = xbm_scan (&s, end, buffer, &value)
2719 #define expect(TOKEN) \
2720 if (LA1 != (TOKEN)) \
2725 #define expect_ident(IDENT) \
2726 if (LA1 == XBM_TK_IDENT && strcmp (buffer, (IDENT)) == 0) \
2731 *width
= *height
= -1;
2734 LA1
= xbm_scan (&s
, end
, buffer
, &value
);
2736 /* Parse defines for width, height and hot-spots. */
2740 expect_ident ("define");
2741 expect (XBM_TK_IDENT
);
2743 if (LA1
== XBM_TK_NUMBER
)
2745 char *q
= strrchr (buffer
, '_');
2746 q
= q
? q
+ 1 : buffer
;
2747 if (strcmp (q
, "width") == 0)
2749 else if (strcmp (q
, "height") == 0)
2752 expect (XBM_TK_NUMBER
);
2755 if (!check_image_size (f
, *width
, *height
))
2757 if (!inhibit_image_error
)
2758 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
2761 else if (data
== NULL
)
2764 /* Parse bits. Must start with `static'. */
2765 expect_ident ("static");
2766 if (LA1
== XBM_TK_IDENT
)
2768 if (strcmp (buffer
, "unsigned") == 0)
2771 expect_ident ("char");
2773 else if (strcmp (buffer
, "short") == 0)
2777 if (*width
% 16 && *width
% 16 < 9)
2780 else if (strcmp (buffer
, "char") == 0)
2788 expect (XBM_TK_IDENT
);
2794 if (! x_check_image_size (0, *width
, *height
))
2796 if (!inhibit_image_error
)
2797 image_error ("Image too large (%dx%d)",
2798 make_number (*width
), make_number (*height
));
2801 bytes_per_line
= (*width
+ 7) / 8 + padding_p
;
2802 nbytes
= bytes_per_line
* *height
;
2803 p
= *data
= xmalloc (nbytes
);
2807 for (i
= 0; i
< nbytes
; i
+= 2)
2810 expect (XBM_TK_NUMBER
);
2812 *p
++ = XBM_BIT_SHUFFLE (val
);
2813 if (!padding_p
|| ((i
+ 2) % bytes_per_line
))
2814 *p
++ = XBM_BIT_SHUFFLE (value
>> 8);
2816 if (LA1
== ',' || LA1
== '}')
2824 for (i
= 0; i
< nbytes
; ++i
)
2827 expect (XBM_TK_NUMBER
);
2829 *p
++ = XBM_BIT_SHUFFLE (val
);
2831 if (LA1
== ',' || LA1
== '}')
2856 /* Load XBM image IMG which will be displayed on frame F from buffer
2857 CONTENTS. END is the end of the buffer. Value is true if
2861 xbm_load_image (struct frame
*f
, struct image
*img
, unsigned char *contents
,
2868 rc
= xbm_read_bitmap_data (f
, contents
, end
, &img
->width
, &img
->height
,
2872 unsigned long foreground
= FRAME_FOREGROUND_PIXEL (f
);
2873 unsigned long background
= FRAME_BACKGROUND_PIXEL (f
);
2874 bool non_default_colors
= 0;
2877 eassert (img
->width
> 0 && img
->height
> 0);
2879 /* Get foreground and background colors, maybe allocate colors. */
2880 value
= image_spec_value (img
->spec
, QCforeground
, NULL
);
2883 foreground
= x_alloc_image_color (f
, img
, value
, foreground
);
2884 non_default_colors
= 1;
2886 value
= image_spec_value (img
->spec
, QCbackground
, NULL
);
2889 background
= x_alloc_image_color (f
, img
, value
, background
);
2890 img
->background
= background
;
2891 img
->background_valid
= 1;
2892 non_default_colors
= 1;
2895 Create_Pixmap_From_Bitmap_Data (f
, img
, data
,
2896 foreground
, background
,
2897 non_default_colors
);
2900 if (img
->pixmap
== NO_PIXMAP
)
2902 x_clear_image (f
, img
);
2903 image_error ("Unable to create X pixmap for `%s'", img
->spec
, Qnil
);
2909 image_error ("Error loading XBM image `%s'", img
->spec
, Qnil
);
2915 /* Value is true if DATA looks like an in-memory XBM file. */
2918 xbm_file_p (Lisp_Object data
)
2921 return (STRINGP (data
)
2922 && xbm_read_bitmap_data (NULL
, SDATA (data
),
2923 (SDATA (data
) + SBYTES (data
)),
2928 /* Fill image IMG which is used on frame F with pixmap data. Value is
2929 true if successful. */
2932 xbm_load (struct frame
*f
, struct image
*img
)
2935 Lisp_Object file_name
;
2937 eassert (xbm_image_p (img
->spec
));
2939 /* If IMG->spec specifies a file name, create a non-file spec from it. */
2940 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
2941 if (STRINGP (file_name
))
2944 unsigned char *contents
;
2947 file
= x_find_image_file (file_name
);
2948 if (!STRINGP (file
))
2950 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
2954 contents
= slurp_file (SSDATA (file
), &size
);
2955 if (contents
== NULL
)
2957 image_error ("Error loading XBM image `%s'", img
->spec
, Qnil
);
2961 success_p
= xbm_load_image (f
, img
, contents
, contents
+ size
);
2966 struct image_keyword fmt
[XBM_LAST
];
2968 unsigned long foreground
= FRAME_FOREGROUND_PIXEL (f
);
2969 unsigned long background
= FRAME_BACKGROUND_PIXEL (f
);
2970 bool non_default_colors
= 0;
2973 bool in_memory_file_p
= 0;
2975 /* See if data looks like an in-memory XBM file. */
2976 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
2977 in_memory_file_p
= xbm_file_p (data
);
2979 /* Parse the image specification. */
2980 memcpy (fmt
, xbm_format
, sizeof fmt
);
2981 parsed_p
= parse_image_spec (img
->spec
, fmt
, XBM_LAST
, Qxbm
);
2984 /* Get specified width, and height. */
2985 if (!in_memory_file_p
)
2987 img
->width
= XFASTINT (fmt
[XBM_WIDTH
].value
);
2988 img
->height
= XFASTINT (fmt
[XBM_HEIGHT
].value
);
2989 eassert (img
->width
> 0 && img
->height
> 0);
2990 if (!check_image_size (f
, img
->width
, img
->height
))
2992 image_error ("Invalid image size (see `max-image-size')",
2998 /* Get foreground and background colors, maybe allocate colors. */
2999 if (fmt
[XBM_FOREGROUND
].count
3000 && STRINGP (fmt
[XBM_FOREGROUND
].value
))
3002 foreground
= x_alloc_image_color (f
, img
, fmt
[XBM_FOREGROUND
].value
,
3004 non_default_colors
= 1;
3007 if (fmt
[XBM_BACKGROUND
].count
3008 && STRINGP (fmt
[XBM_BACKGROUND
].value
))
3010 background
= x_alloc_image_color (f
, img
, fmt
[XBM_BACKGROUND
].value
,
3012 non_default_colors
= 1;
3015 if (in_memory_file_p
)
3016 success_p
= xbm_load_image (f
, img
, SDATA (data
),
3025 int nbytes
= (img
->width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
;
3027 p
= bits
= alloca (nbytes
* img
->height
);
3028 for (i
= 0; i
< img
->height
; ++i
, p
+= nbytes
)
3030 Lisp_Object line
= AREF (data
, i
);
3032 memcpy (p
, SDATA (line
), nbytes
);
3034 memcpy (p
, XBOOL_VECTOR (line
)->data
, nbytes
);
3037 else if (STRINGP (data
))
3038 bits
= SSDATA (data
);
3040 bits
= (char *) XBOOL_VECTOR (data
)->data
;
3046 /* Windows mono bitmaps are reversed compared with X. */
3047 invertedBits
= bits
;
3048 nbytes
= (img
->width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
3050 bits
= alloca (nbytes
);
3051 for (i
= 0; i
< nbytes
; i
++)
3052 bits
[i
] = XBM_BIT_SHUFFLE (invertedBits
[i
]);
3055 /* Create the pixmap. */
3057 if (x_check_image_size (0, img
->width
, img
->height
))
3058 Create_Pixmap_From_Bitmap_Data (f
, img
, bits
,
3059 foreground
, background
,
3060 non_default_colors
);
3062 img
->pixmap
= NO_PIXMAP
;
3068 image_error ("Unable to create pixmap for XBM image `%s'",
3070 x_clear_image (f
, img
);
3080 /***********************************************************************
3082 ***********************************************************************/
3084 #if defined (HAVE_XPM) || defined (HAVE_NS)
3086 static bool xpm_image_p (Lisp_Object object
);
3087 static bool xpm_load (struct frame
*f
, struct image
*img
);
3089 #endif /* HAVE_XPM || HAVE_NS */
3093 /* Indicate to xpm.h that we don't have Xlib. */
3095 /* simx.h in xpm defines XColor and XImage differently than Emacs. */
3096 /* It also defines Display the same way as Emacs, but gcc 3.3 still barfs. */
3097 #define XColor xpm_XColor
3098 #define XImage xpm_XImage
3099 #define Display xpm_Display
3100 #define PIXEL_ALREADY_TYPEDEFED
3101 #include "X11/xpm.h"
3106 #undef PIXEL_ALREADY_TYPEDEFED
3108 #include "X11/xpm.h"
3109 #endif /* HAVE_NTGUI */
3110 #endif /* HAVE_XPM */
3112 #if defined (HAVE_XPM) || defined (HAVE_NS)
3113 /* The symbol `xpm' identifying XPM-format images. */
3115 static Lisp_Object Qxpm
;
3117 /* Indices of image specification fields in xpm_format, below. */
3119 enum xpm_keyword_index
3135 /* Vector of image_keyword structures describing the format
3136 of valid XPM image specifications. */
3138 static const struct image_keyword xpm_format
[XPM_LAST
] =
3140 {":type", IMAGE_SYMBOL_VALUE
, 1},
3141 {":file", IMAGE_STRING_VALUE
, 0},
3142 {":data", IMAGE_STRING_VALUE
, 0},
3143 {":ascent", IMAGE_ASCENT_VALUE
, 0},
3144 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
3145 {":relief", IMAGE_INTEGER_VALUE
, 0},
3146 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3147 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3148 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3149 {":color-symbols", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3150 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
3153 #if defined HAVE_NTGUI && defined WINDOWSNT
3154 static bool init_xpm_functions (void);
3156 #define init_xpm_functions NULL
3159 /* Structure describing the image type XPM. */
3161 static struct image_type xpm_type
=
3171 #ifdef HAVE_X_WINDOWS
3173 /* Define ALLOC_XPM_COLORS if we can use Emacs' own color allocation
3174 functions for allocating image colors. Our own functions handle
3175 color allocation failures more gracefully than the ones on the XPM
3178 #if defined XpmAllocColor && defined XpmFreeColors && defined XpmColorClosure
3179 #define ALLOC_XPM_COLORS
3181 #endif /* HAVE_X_WINDOWS */
3183 #ifdef ALLOC_XPM_COLORS
3185 static struct xpm_cached_color
*xpm_cache_color (struct frame
*, char *,
3188 /* An entry in a hash table used to cache color definitions of named
3189 colors. This cache is necessary to speed up XPM image loading in
3190 case we do color allocations ourselves. Without it, we would need
3191 a call to XParseColor per pixel in the image. */
3193 struct xpm_cached_color
3195 /* Next in collision chain. */
3196 struct xpm_cached_color
*next
;
3198 /* Color definition (RGB and pixel color). */
3202 char name
[FLEXIBLE_ARRAY_MEMBER
];
3205 /* The hash table used for the color cache, and its bucket vector
3208 #define XPM_COLOR_CACHE_BUCKETS 1001
3209 static struct xpm_cached_color
**xpm_color_cache
;
3211 /* Initialize the color cache. */
3214 xpm_init_color_cache (struct frame
*f
, XpmAttributes
*attrs
)
3216 size_t nbytes
= XPM_COLOR_CACHE_BUCKETS
* sizeof *xpm_color_cache
;
3217 xpm_color_cache
= xzalloc (nbytes
);
3218 init_color_table ();
3220 if (attrs
->valuemask
& XpmColorSymbols
)
3225 for (i
= 0; i
< attrs
->numsymbols
; ++i
)
3226 if (XParseColor (FRAME_X_DISPLAY (f
), FRAME_X_COLORMAP (f
),
3227 attrs
->colorsymbols
[i
].value
, &color
))
3229 color
.pixel
= lookup_rgb_color (f
, color
.red
, color
.green
,
3231 xpm_cache_color (f
, attrs
->colorsymbols
[i
].name
, &color
, -1);
3236 /* Free the color cache. */
3239 xpm_free_color_cache (void)
3241 struct xpm_cached_color
*p
, *next
;
3244 for (i
= 0; i
< XPM_COLOR_CACHE_BUCKETS
; ++i
)
3245 for (p
= xpm_color_cache
[i
]; p
; p
= next
)
3251 xfree (xpm_color_cache
);
3252 xpm_color_cache
= NULL
;
3253 free_color_table ();
3256 /* Return the bucket index for color named COLOR_NAME in the color
3260 xpm_color_bucket (char *color_name
)
3262 EMACS_UINT hash
= hash_string (color_name
, strlen (color_name
));
3263 return hash
% XPM_COLOR_CACHE_BUCKETS
;
3267 /* On frame F, cache values COLOR for color with name COLOR_NAME.
3268 BUCKET, if >= 0, is a precomputed bucket index. Value is the cache
3271 static struct xpm_cached_color
*
3272 xpm_cache_color (struct frame
*f
, char *color_name
, XColor
*color
, int bucket
)
3275 struct xpm_cached_color
*p
;
3278 bucket
= xpm_color_bucket (color_name
);
3280 nbytes
= offsetof (struct xpm_cached_color
, name
) + strlen (color_name
) + 1;
3281 p
= xmalloc (nbytes
);
3282 strcpy (p
->name
, color_name
);
3284 p
->next
= xpm_color_cache
[bucket
];
3285 xpm_color_cache
[bucket
] = p
;
3289 /* Look up color COLOR_NAME for frame F in the color cache. If found,
3290 return the cached definition in *COLOR. Otherwise, make a new
3291 entry in the cache and allocate the color. Value is false if color
3292 allocation failed. */
3295 xpm_lookup_color (struct frame
*f
, char *color_name
, XColor
*color
)
3297 struct xpm_cached_color
*p
;
3298 int h
= xpm_color_bucket (color_name
);
3300 for (p
= xpm_color_cache
[h
]; p
; p
= p
->next
)
3301 if (strcmp (p
->name
, color_name
) == 0)
3306 else if (XParseColor (FRAME_X_DISPLAY (f
), FRAME_X_COLORMAP (f
),
3309 color
->pixel
= lookup_rgb_color (f
, color
->red
, color
->green
,
3311 p
= xpm_cache_color (f
, color_name
, color
, h
);
3313 /* You get `opaque' at least from ImageMagick converting pbm to xpm
3314 with transparency, and it's useful. */
3315 else if (strcmp ("opaque", color_name
) == 0)
3317 memset (color
, 0, sizeof (XColor
)); /* Is this necessary/correct? */
3318 color
->pixel
= FRAME_FOREGROUND_PIXEL (f
);
3319 p
= xpm_cache_color (f
, color_name
, color
, h
);
3326 /* Callback for allocating color COLOR_NAME. Called from the XPM lib.
3327 CLOSURE is a pointer to the frame on which we allocate the
3328 color. Return in *COLOR the allocated color. Value is non-zero
3332 xpm_alloc_color (Display
*dpy
, Colormap cmap
, char *color_name
, XColor
*color
,
3335 return xpm_lookup_color (closure
, color_name
, color
);
3339 /* Callback for freeing NPIXELS colors contained in PIXELS. CLOSURE
3340 is a pointer to the frame on which we allocate the color. Value is
3341 non-zero if successful. */
3344 xpm_free_colors (Display
*dpy
, Colormap cmap
, Pixel
*pixels
, int npixels
, void *closure
)
3349 #endif /* ALLOC_XPM_COLORS */
3354 /* XPM library details. */
3356 DEF_IMGLIB_FN (void, XpmFreeAttributes
, (XpmAttributes
*));
3357 DEF_IMGLIB_FN (int, XpmCreateImageFromBuffer
, (Display
*, char *, xpm_XImage
**,
3358 xpm_XImage
**, XpmAttributes
*));
3359 DEF_IMGLIB_FN (int, XpmReadFileToImage
, (Display
*, char *, xpm_XImage
**,
3360 xpm_XImage
**, XpmAttributes
*));
3361 DEF_IMGLIB_FN (void, XImageFree
, (xpm_XImage
*));
3364 init_xpm_functions (void)
3368 if (!(library
= w32_delayed_load (Qxpm
)))
3371 LOAD_IMGLIB_FN (library
, XpmFreeAttributes
);
3372 LOAD_IMGLIB_FN (library
, XpmCreateImageFromBuffer
);
3373 LOAD_IMGLIB_FN (library
, XpmReadFileToImage
);
3374 LOAD_IMGLIB_FN (library
, XImageFree
);
3378 #endif /* WINDOWSNT */
3380 #if defined HAVE_NTGUI && !defined WINDOWSNT
3381 /* Glue for code below */
3382 #define fn_XpmReadFileToImage XpmReadFileToImage
3383 #define fn_XpmCreateImageFromBuffer XpmCreateImageFromBuffer
3384 #define fn_XImageFree XImageFree
3385 #define fn_XpmFreeAttributes XpmFreeAttributes
3386 #endif /* HAVE_NTGUI && !WINDOWSNT */
3388 /* Value is true if COLOR_SYMBOLS is a valid color symbols list
3389 for XPM images. Such a list must consist of conses whose car and
3393 xpm_valid_color_symbols_p (Lisp_Object color_symbols
)
3395 while (CONSP (color_symbols
))
3397 Lisp_Object sym
= XCAR (color_symbols
);
3399 || !STRINGP (XCAR (sym
))
3400 || !STRINGP (XCDR (sym
)))
3402 color_symbols
= XCDR (color_symbols
);
3405 return NILP (color_symbols
);
3409 /* Value is true if OBJECT is a valid XPM image specification. */
3412 xpm_image_p (Lisp_Object object
)
3414 struct image_keyword fmt
[XPM_LAST
];
3415 memcpy (fmt
, xpm_format
, sizeof fmt
);
3416 return (parse_image_spec (object
, fmt
, XPM_LAST
, Qxpm
)
3417 /* Either `:file' or `:data' must be present. */
3418 && fmt
[XPM_FILE
].count
+ fmt
[XPM_DATA
].count
== 1
3419 /* Either no `:color-symbols' or it's a list of conses
3420 whose car and cdr are strings. */
3421 && (fmt
[XPM_COLOR_SYMBOLS
].count
== 0
3422 || xpm_valid_color_symbols_p (fmt
[XPM_COLOR_SYMBOLS
].value
)));
3425 #endif /* HAVE_XPM || HAVE_NS */
3427 #if defined HAVE_XPM && defined HAVE_X_WINDOWS && !defined USE_GTK
3429 x_create_bitmap_from_xpm_data (struct frame
*f
, const char **bits
)
3431 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
3434 XpmAttributes attrs
;
3435 Pixmap bitmap
, mask
;
3437 memset (&attrs
, 0, sizeof attrs
);
3439 attrs
.visual
= FRAME_X_VISUAL (f
);
3440 attrs
.colormap
= FRAME_X_COLORMAP (f
);
3441 attrs
.valuemask
|= XpmVisual
;
3442 attrs
.valuemask
|= XpmColormap
;
3444 rc
= XpmCreatePixmapFromData (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
3445 (char **) bits
, &bitmap
, &mask
, &attrs
);
3446 if (rc
!= XpmSuccess
)
3448 XpmFreeAttributes (&attrs
);
3452 id
= x_allocate_bitmap_record (f
);
3453 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
3454 dpyinfo
->bitmaps
[id
- 1].have_mask
= 1;
3455 dpyinfo
->bitmaps
[id
- 1].mask
= mask
;
3456 dpyinfo
->bitmaps
[id
- 1].file
= NULL
;
3457 dpyinfo
->bitmaps
[id
- 1].height
= attrs
.height
;
3458 dpyinfo
->bitmaps
[id
- 1].width
= attrs
.width
;
3459 dpyinfo
->bitmaps
[id
- 1].depth
= attrs
.depth
;
3460 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
3462 XpmFreeAttributes (&attrs
);
3465 #endif /* defined (HAVE_XPM) && defined (HAVE_X_WINDOWS) */
3467 /* Load image IMG which will be displayed on frame F. Value is
3468 true if successful. */
3473 xpm_load (struct frame
*f
, struct image
*img
)
3476 XpmAttributes attrs
;
3477 Lisp_Object specified_file
, color_symbols
;
3480 xpm_XImage
* xpm_image
= NULL
, * xpm_mask
= NULL
;
3481 #endif /* HAVE_NTGUI */
3483 /* Configure the XPM lib. Use the visual of frame F. Allocate
3484 close colors. Return colors allocated. */
3485 memset (&attrs
, 0, sizeof attrs
);
3488 attrs
.visual
= FRAME_X_VISUAL (f
);
3489 attrs
.colormap
= FRAME_X_COLORMAP (f
);
3490 attrs
.valuemask
|= XpmVisual
;
3491 attrs
.valuemask
|= XpmColormap
;
3492 #endif /* HAVE_NTGUI */
3494 #ifdef ALLOC_XPM_COLORS
3495 /* Allocate colors with our own functions which handle
3496 failing color allocation more gracefully. */
3497 attrs
.color_closure
= f
;
3498 attrs
.alloc_color
= xpm_alloc_color
;
3499 attrs
.free_colors
= xpm_free_colors
;
3500 attrs
.valuemask
|= XpmAllocColor
| XpmFreeColors
| XpmColorClosure
;
3501 #else /* not ALLOC_XPM_COLORS */
3502 /* Let the XPM lib allocate colors. */
3503 attrs
.valuemask
|= XpmReturnAllocPixels
;
3504 #ifdef XpmAllocCloseColors
3505 attrs
.alloc_close_colors
= 1;
3506 attrs
.valuemask
|= XpmAllocCloseColors
;
3507 #else /* not XpmAllocCloseColors */
3508 attrs
.closeness
= 600;
3509 attrs
.valuemask
|= XpmCloseness
;
3510 #endif /* not XpmAllocCloseColors */
3511 #endif /* ALLOC_XPM_COLORS */
3513 /* If image specification contains symbolic color definitions, add
3514 these to `attrs'. */
3515 color_symbols
= image_spec_value (img
->spec
, QCcolor_symbols
, NULL
);
3516 if (CONSP (color_symbols
))
3519 XpmColorSymbol
*xpm_syms
;
3522 attrs
.valuemask
|= XpmColorSymbols
;
3524 /* Count number of symbols. */
3525 attrs
.numsymbols
= 0;
3526 for (tail
= color_symbols
; CONSP (tail
); tail
= XCDR (tail
))
3529 /* Allocate an XpmColorSymbol array. */
3530 size
= attrs
.numsymbols
* sizeof *xpm_syms
;
3531 xpm_syms
= alloca (size
);
3532 memset (xpm_syms
, 0, size
);
3533 attrs
.colorsymbols
= xpm_syms
;
3535 /* Fill the color symbol array. */
3536 for (tail
= color_symbols
, i
= 0;
3538 ++i
, tail
= XCDR (tail
))
3542 char *empty_string
= (char *) "";
3544 if (!CONSP (XCAR (tail
)))
3546 xpm_syms
[i
].name
= empty_string
;
3547 xpm_syms
[i
].value
= empty_string
;
3550 name
= XCAR (XCAR (tail
));
3551 color
= XCDR (XCAR (tail
));
3554 xpm_syms
[i
].name
= alloca (SCHARS (name
) + 1);
3555 strcpy (xpm_syms
[i
].name
, SSDATA (name
));
3558 xpm_syms
[i
].name
= empty_string
;
3559 if (STRINGP (color
))
3561 xpm_syms
[i
].value
= alloca (SCHARS (color
) + 1);
3562 strcpy (xpm_syms
[i
].value
, SSDATA (color
));
3565 xpm_syms
[i
].value
= empty_string
;
3569 /* Create a pixmap for the image, either from a file, or from a
3570 string buffer containing data in the same format as an XPM file. */
3571 #ifdef ALLOC_XPM_COLORS
3572 xpm_init_color_cache (f
, &attrs
);
3575 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
3579 HDC frame_dc
= get_frame_dc (f
);
3580 hdc
= CreateCompatibleDC (frame_dc
);
3581 release_frame_dc (f
, frame_dc
);
3583 #endif /* HAVE_NTGUI */
3585 if (STRINGP (specified_file
))
3587 Lisp_Object file
= x_find_image_file (specified_file
);
3588 if (!STRINGP (file
))
3590 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
3591 #ifdef ALLOC_XPM_COLORS
3592 xpm_free_color_cache ();
3598 /* XpmReadFileToPixmap is not available in the Windows port of
3599 libxpm. But XpmReadFileToImage almost does what we want. */
3600 rc
= fn_XpmReadFileToImage (&hdc
, SDATA (file
),
3601 &xpm_image
, &xpm_mask
,
3604 rc
= XpmReadFileToImage (FRAME_X_DISPLAY (f
), SSDATA (file
),
3605 &img
->ximg
, &img
->mask_img
,
3607 #endif /* HAVE_NTGUI */
3611 Lisp_Object buffer
= image_spec_value (img
->spec
, QCdata
, NULL
);
3612 if (!STRINGP (buffer
))
3614 image_error ("Invalid image data `%s'", buffer
, Qnil
);
3615 #ifdef ALLOC_XPM_COLORS
3616 xpm_free_color_cache ();
3621 /* XpmCreatePixmapFromBuffer is not available in the Windows port
3622 of libxpm. But XpmCreateImageFromBuffer almost does what we want. */
3623 rc
= fn_XpmCreateImageFromBuffer (&hdc
, SDATA (buffer
),
3624 &xpm_image
, &xpm_mask
,
3627 rc
= XpmCreateImageFromBuffer (FRAME_X_DISPLAY (f
), SSDATA (buffer
),
3628 &img
->ximg
, &img
->mask_img
,
3630 #endif /* HAVE_NTGUI */
3633 #ifdef HAVE_X_WINDOWS
3634 if (rc
== XpmSuccess
)
3636 img
->pixmap
= XCreatePixmap (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
3637 img
->ximg
->width
, img
->ximg
->height
,
3639 if (img
->pixmap
== NO_PIXMAP
)
3641 x_clear_image (f
, img
);
3644 else if (img
->mask_img
)
3646 img
->mask
= XCreatePixmap (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
3647 img
->mask_img
->width
,
3648 img
->mask_img
->height
,
3649 img
->mask_img
->depth
);
3650 if (img
->mask
== NO_PIXMAP
)
3652 x_clear_image (f
, img
);
3659 if (rc
== XpmSuccess
)
3661 #if defined (COLOR_TABLE_SUPPORT) && defined (ALLOC_XPM_COLORS)
3662 img
->colors
= colors_in_color_table (&img
->ncolors
);
3663 #else /* not ALLOC_XPM_COLORS */
3667 /* W32 XPM uses XImage to wrap what W32 Emacs calls a Pixmap,
3668 plus some duplicate attributes. */
3669 if (xpm_image
&& xpm_image
->bitmap
)
3671 img
->pixmap
= xpm_image
->bitmap
;
3672 /* XImageFree in libXpm frees XImage struct without destroying
3673 the bitmap, which is what we want. */
3674 fn_XImageFree (xpm_image
);
3676 if (xpm_mask
&& xpm_mask
->bitmap
)
3678 /* The mask appears to be inverted compared with what we expect.
3679 TODO: invert our expectations. See other places where we
3680 have to invert bits because our idea of masks is backwards. */
3682 old_obj
= SelectObject (hdc
, xpm_mask
->bitmap
);
3684 PatBlt (hdc
, 0, 0, xpm_mask
->width
, xpm_mask
->height
, DSTINVERT
);
3685 SelectObject (hdc
, old_obj
);
3687 img
->mask
= xpm_mask
->bitmap
;
3688 fn_XImageFree (xpm_mask
);
3693 #endif /* HAVE_NTGUI */
3695 /* Remember allocated colors. */
3696 img
->colors
= xnmalloc (attrs
.nalloc_pixels
, sizeof *img
->colors
);
3697 img
->ncolors
= attrs
.nalloc_pixels
;
3698 for (i
= 0; i
< attrs
.nalloc_pixels
; ++i
)
3700 img
->colors
[i
] = attrs
.alloc_pixels
[i
];
3701 #ifdef DEBUG_X_COLORS
3702 register_color (img
->colors
[i
]);
3705 #endif /* not ALLOC_XPM_COLORS */
3707 img
->width
= attrs
.width
;
3708 img
->height
= attrs
.height
;
3709 eassert (img
->width
> 0 && img
->height
> 0);
3711 /* The call to XpmFreeAttributes below frees attrs.alloc_pixels. */
3713 fn_XpmFreeAttributes (&attrs
);
3715 XpmFreeAttributes (&attrs
);
3716 #endif /* HAVE_NTGUI */
3718 #ifdef HAVE_X_WINDOWS
3719 /* Maybe fill in the background field while we have ximg handy. */
3720 IMAGE_BACKGROUND (img
, f
, img
->ximg
);
3722 /* Fill in the background_transparent field while we have the
3724 image_background_transparent (img
, f
, img
->mask_img
);
3731 #endif /* HAVE_NTGUI */
3736 image_error ("Error opening XPM file (%s)", img
->spec
, Qnil
);
3739 case XpmFileInvalid
:
3740 image_error ("Invalid XPM file (%s)", img
->spec
, Qnil
);
3744 image_error ("Out of memory (%s)", img
->spec
, Qnil
);
3747 case XpmColorFailed
:
3748 image_error ("Color allocation error (%s)", img
->spec
, Qnil
);
3752 image_error ("Unknown error (%s)", img
->spec
, Qnil
);
3757 #ifdef ALLOC_XPM_COLORS
3758 xpm_free_color_cache ();
3760 return rc
== XpmSuccess
;
3763 #endif /* HAVE_XPM */
3765 #if defined (HAVE_NS) && !defined (HAVE_XPM)
3767 /* XPM support functions for NS where libxpm is not available.
3768 Only XPM version 3 (without any extensions) is supported. */
3770 static void xpm_put_color_table_v (Lisp_Object
, const unsigned char *,
3772 static Lisp_Object
xpm_get_color_table_v (Lisp_Object
,
3773 const unsigned char *, int);
3774 static void xpm_put_color_table_h (Lisp_Object
, const unsigned char *,
3776 static Lisp_Object
xpm_get_color_table_h (Lisp_Object
,
3777 const unsigned char *, int);
3779 /* Tokens returned from xpm_scan. */
3788 /* Scan an XPM data and return a character (< 256) or a token defined
3789 by enum xpm_token above. *S and END are the start (inclusive) and
3790 the end (exclusive) addresses of the data, respectively. Advance
3791 *S while scanning. If token is either XPM_TK_IDENT or
3792 XPM_TK_STRING, *BEG and *LEN are set to the start address and the
3793 length of the corresponding token, respectively. */
3796 xpm_scan (const unsigned char **s
,
3797 const unsigned char *end
,
3798 const unsigned char **beg
,
3805 /* Skip white-space. */
3806 while (*s
< end
&& (c
= *(*s
)++, c_isspace (c
)))
3809 /* gnus-pointer.xpm uses '-' in its identifier.
3810 sb-dir-plus.xpm uses '+' in its identifier. */
3811 if (c_isalpha (c
) || c
== '_' || c
== '-' || c
== '+')
3815 && (c
= **s
, c_isalnum (c
)
3816 || c
== '_' || c
== '-' || c
== '+'))
3819 return XPM_TK_IDENT
;
3824 while (*s
< end
&& **s
!= '"')
3829 return XPM_TK_STRING
;
3833 if (*s
< end
&& **s
== '*')
3835 /* C-style comment. */
3839 while (*s
< end
&& *(*s
)++ != '*')
3842 while (*s
< end
&& **s
!= '/');
3856 /* Functions for color table lookup in XPM data. A key is a string
3857 specifying the color of each pixel in XPM data. A value is either
3858 an integer that specifies a pixel color, Qt that specifies
3859 transparency, or Qnil for the unspecified color. If the length of
3860 the key string is one, a vector is used as a table. Otherwise, a
3861 hash table is used. */
3864 xpm_make_color_table_v (void (**put_func
) (Lisp_Object
,
3865 const unsigned char *,
3868 Lisp_Object (**get_func
) (Lisp_Object
,
3869 const unsigned char *,
3872 *put_func
= xpm_put_color_table_v
;
3873 *get_func
= xpm_get_color_table_v
;
3874 return Fmake_vector (make_number (256), Qnil
);
3878 xpm_put_color_table_v (Lisp_Object color_table
,
3879 const unsigned char *chars_start
,
3883 ASET (color_table
, *chars_start
, color
);
3887 xpm_get_color_table_v (Lisp_Object color_table
,
3888 const unsigned char *chars_start
,
3891 return AREF (color_table
, *chars_start
);
3895 xpm_make_color_table_h (void (**put_func
) (Lisp_Object
,
3896 const unsigned char *,
3899 Lisp_Object (**get_func
) (Lisp_Object
,
3900 const unsigned char *,
3903 *put_func
= xpm_put_color_table_h
;
3904 *get_func
= xpm_get_color_table_h
;
3905 return make_hash_table (hashtest_equal
, make_number (DEFAULT_HASH_SIZE
),
3906 make_float (DEFAULT_REHASH_SIZE
),
3907 make_float (DEFAULT_REHASH_THRESHOLD
),
3912 xpm_put_color_table_h (Lisp_Object color_table
,
3913 const unsigned char *chars_start
,
3917 struct Lisp_Hash_Table
*table
= XHASH_TABLE (color_table
);
3918 EMACS_UINT hash_code
;
3919 Lisp_Object chars
= make_unibyte_string (chars_start
, chars_len
);
3921 hash_lookup (table
, chars
, &hash_code
);
3922 hash_put (table
, chars
, color
, hash_code
);
3926 xpm_get_color_table_h (Lisp_Object color_table
,
3927 const unsigned char *chars_start
,
3930 struct Lisp_Hash_Table
*table
= XHASH_TABLE (color_table
);
3932 hash_lookup (table
, make_unibyte_string (chars_start
, chars_len
), NULL
);
3934 return i
>= 0 ? HASH_VALUE (table
, i
) : Qnil
;
3937 enum xpm_color_key
{
3945 static const char xpm_color_key_strings
[][4] = {"s", "m", "g4", "g", "c"};
3948 xpm_str_to_color_key (const char *s
)
3953 i
< sizeof xpm_color_key_strings
/ sizeof xpm_color_key_strings
[0];
3955 if (strcmp (xpm_color_key_strings
[i
], s
) == 0)
3961 xpm_load_image (struct frame
*f
,
3963 const unsigned char *contents
,
3964 const unsigned char *end
)
3966 const unsigned char *s
= contents
, *beg
, *str
;
3967 unsigned char buffer
[BUFSIZ
];
3968 int width
, height
, x
, y
;
3969 int num_colors
, chars_per_pixel
;
3972 void (*put_color_table
) (Lisp_Object
, const unsigned char *, int, Lisp_Object
);
3973 Lisp_Object (*get_color_table
) (Lisp_Object
, const unsigned char *, int);
3974 Lisp_Object frame
, color_symbols
, color_table
;
3977 XImagePtr ximg
= NULL
, mask_img
= NULL
;
3980 LA1 = xpm_scan (&s, end, &beg, &len)
3982 #define expect(TOKEN) \
3983 if (LA1 != (TOKEN)) \
3988 #define expect_ident(IDENT) \
3989 if (LA1 == XPM_TK_IDENT \
3990 && strlen ((IDENT)) == len && memcmp ((IDENT), beg, len) == 0) \
3995 if (!(end
- s
>= 9 && memcmp (s
, "/* XPM */", 9) == 0))
3999 expect_ident ("static");
4000 expect_ident ("char");
4002 expect (XPM_TK_IDENT
);
4007 expect (XPM_TK_STRING
);
4010 memcpy (buffer
, beg
, len
);
4012 if (sscanf (buffer
, "%d %d %d %d", &width
, &height
,
4013 &num_colors
, &chars_per_pixel
) != 4
4014 || width
<= 0 || height
<= 0
4015 || num_colors
<= 0 || chars_per_pixel
<= 0)
4018 if (!check_image_size (f
, width
, height
))
4020 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
4024 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, 0, &ximg
, 0)
4026 || !image_create_x_image_and_pixmap (f
, img
, width
, height
, 1,
4031 image_error ("Image too large", Qnil
, Qnil
);
4037 XSETFRAME (frame
, f
);
4038 if (!NILP (Fxw_display_color_p (frame
)))
4039 best_key
= XPM_COLOR_KEY_C
;
4040 else if (!NILP (Fx_display_grayscale_p (frame
)))
4041 best_key
= (XFASTINT (Fx_display_planes (frame
)) > 2
4042 ? XPM_COLOR_KEY_G
: XPM_COLOR_KEY_G4
);
4044 best_key
= XPM_COLOR_KEY_M
;
4046 color_symbols
= image_spec_value (img
->spec
, QCcolor_symbols
, NULL
);
4047 if (chars_per_pixel
== 1)
4048 color_table
= xpm_make_color_table_v (&put_color_table
,
4051 color_table
= xpm_make_color_table_h (&put_color_table
,
4054 while (num_colors
-- > 0)
4056 char *color
, *max_color
;
4057 int key
, next_key
, max_key
= 0;
4058 Lisp_Object symbol_color
= Qnil
, color_val
;
4061 expect (XPM_TK_STRING
);
4062 if (len
<= chars_per_pixel
|| len
>= BUFSIZ
+ chars_per_pixel
)
4064 memcpy (buffer
, beg
+ chars_per_pixel
, len
- chars_per_pixel
);
4065 buffer
[len
- chars_per_pixel
] = '\0';
4067 str
= strtok (buffer
, " \t");
4070 key
= xpm_str_to_color_key (str
);
4075 color
= strtok (NULL
, " \t");
4079 while ((str
= strtok (NULL
, " \t")) != NULL
)
4081 next_key
= xpm_str_to_color_key (str
);
4084 color
[strlen (color
)] = ' ';
4087 if (key
== XPM_COLOR_KEY_S
)
4089 if (NILP (symbol_color
))
4090 symbol_color
= build_string (color
);
4092 else if (max_key
< key
&& key
<= best_key
)
4102 if (!NILP (color_symbols
) && !NILP (symbol_color
))
4104 Lisp_Object specified_color
= Fassoc (symbol_color
, color_symbols
);
4106 if (CONSP (specified_color
) && STRINGP (XCDR (specified_color
)))
4108 if (xstrcasecmp (SSDATA (XCDR (specified_color
)), "None") == 0)
4110 else if (x_defined_color (f
, SSDATA (XCDR (specified_color
)),
4112 color_val
= make_number (cdef
.pixel
);
4115 if (NILP (color_val
) && max_key
> 0)
4117 if (xstrcasecmp (max_color
, "None") == 0)
4119 else if (x_defined_color (f
, max_color
, &cdef
, 0))
4120 color_val
= make_number (cdef
.pixel
);
4122 if (!NILP (color_val
))
4123 (*put_color_table
) (color_table
, beg
, chars_per_pixel
, color_val
);
4128 for (y
= 0; y
< height
; y
++)
4130 expect (XPM_TK_STRING
);
4132 if (len
< width
* chars_per_pixel
)
4134 for (x
= 0; x
< width
; x
++, str
+= chars_per_pixel
)
4136 Lisp_Object color_val
=
4137 (*get_color_table
) (color_table
, str
, chars_per_pixel
);
4139 XPutPixel (ximg
, x
, y
,
4140 (INTEGERP (color_val
) ? XINT (color_val
)
4141 : FRAME_FOREGROUND_PIXEL (f
)));
4143 XPutPixel (mask_img
, x
, y
,
4144 (!EQ (color_val
, Qt
) ? PIX_MASK_DRAW
4145 : (have_mask
= 1, PIX_MASK_RETAIN
)));
4147 if (EQ (color_val
, Qt
))
4148 ns_set_alpha (ximg
, x
, y
, 0);
4156 img
->height
= height
;
4158 /* Maybe fill in the background field while we have ximg handy. */
4159 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
4160 IMAGE_BACKGROUND (img
, f
, ximg
);
4162 image_put_x_image (f
, img
, ximg
, 0);
4166 /* Fill in the background_transparent field while we have the
4168 image_background_transparent (img
, f
, mask_img
);
4170 image_put_x_image (f
, img
, mask_img
, 1);
4174 x_destroy_x_image (mask_img
);
4175 x_clear_image_1 (f
, img
, CLEAR_IMAGE_MASK
);
4181 image_error ("Invalid XPM file (%s)", img
->spec
, Qnil
);
4182 x_destroy_x_image (ximg
);
4183 x_destroy_x_image (mask_img
);
4184 x_clear_image (f
, img
);
4193 xpm_load (struct frame
*f
,
4197 Lisp_Object file_name
;
4199 /* If IMG->spec specifies a file name, create a non-file spec from it. */
4200 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
4201 if (STRINGP (file_name
))
4204 unsigned char *contents
;
4207 file
= x_find_image_file (file_name
);
4208 if (!STRINGP (file
))
4210 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
4214 contents
= slurp_file (SSDATA (file
), &size
);
4215 if (contents
== NULL
)
4217 image_error ("Error loading XPM image `%s'", img
->spec
, Qnil
);
4221 success_p
= xpm_load_image (f
, img
, contents
, contents
+ size
);
4228 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
4229 if (!STRINGP (data
))
4231 image_error ("Invalid image data `%s'", data
, Qnil
);
4234 success_p
= xpm_load_image (f
, img
, SDATA (data
),
4235 SDATA (data
) + SBYTES (data
));
4241 #endif /* HAVE_NS && !HAVE_XPM */
4245 /***********************************************************************
4247 ***********************************************************************/
4249 #ifdef COLOR_TABLE_SUPPORT
4251 /* An entry in the color table mapping an RGB color to a pixel color. */
4256 unsigned long pixel
;
4258 /* Next in color table collision list. */
4259 struct ct_color
*next
;
4262 /* The bucket vector size to use. Must be prime. */
4266 /* Value is a hash of the RGB color given by R, G, and B. */
4268 #define CT_HASH_RGB(R, G, B) (((R) << 16) ^ ((G) << 8) ^ (B))
4270 /* The color hash table. */
4272 static struct ct_color
**ct_table
;
4274 /* Number of entries in the color table. */
4276 static int ct_colors_allocated
;
4279 ct_colors_allocated_max
=
4281 min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof (unsigned long))
4284 /* Initialize the color table. */
4287 init_color_table (void)
4289 int size
= CT_SIZE
* sizeof (*ct_table
);
4290 ct_table
= xzalloc (size
);
4291 ct_colors_allocated
= 0;
4295 /* Free memory associated with the color table. */
4298 free_color_table (void)
4301 struct ct_color
*p
, *next
;
4303 for (i
= 0; i
< CT_SIZE
; ++i
)
4304 for (p
= ct_table
[i
]; p
; p
= next
)
4315 /* Value is a pixel color for RGB color R, G, B on frame F. If an
4316 entry for that color already is in the color table, return the
4317 pixel color of that entry. Otherwise, allocate a new color for R,
4318 G, B, and make an entry in the color table. */
4320 static unsigned long
4321 lookup_rgb_color (struct frame
*f
, int r
, int g
, int b
)
4323 unsigned hash
= CT_HASH_RGB (r
, g
, b
);
4324 int i
= hash
% CT_SIZE
;
4326 Display_Info
*dpyinfo
;
4328 /* Handle TrueColor visuals specially, which improves performance by
4329 two orders of magnitude. Freeing colors on TrueColor visuals is
4330 a nop, and pixel colors specify RGB values directly. See also
4331 the Xlib spec, chapter 3.1. */
4332 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
4333 if (dpyinfo
->red_bits
> 0)
4335 unsigned long pr
, pg
, pb
;
4337 /* Apply gamma-correction like normal color allocation does. */
4341 color
.red
= r
, color
.green
= g
, color
.blue
= b
;
4342 gamma_correct (f
, &color
);
4343 r
= color
.red
, g
= color
.green
, b
= color
.blue
;
4346 /* Scale down RGB values to the visual's bits per RGB, and shift
4347 them to the right position in the pixel color. Note that the
4348 original RGB values are 16-bit values, as usual in X. */
4349 pr
= (r
>> (16 - dpyinfo
->red_bits
)) << dpyinfo
->red_offset
;
4350 pg
= (g
>> (16 - dpyinfo
->green_bits
)) << dpyinfo
->green_offset
;
4351 pb
= (b
>> (16 - dpyinfo
->blue_bits
)) << dpyinfo
->blue_offset
;
4353 /* Assemble the pixel color. */
4354 return pr
| pg
| pb
;
4357 for (p
= ct_table
[i
]; p
; p
= p
->next
)
4358 if (p
->r
== r
&& p
->g
== g
&& p
->b
== b
)
4364 #ifdef HAVE_X_WINDOWS
4372 if (ct_colors_allocated_max
<= ct_colors_allocated
)
4373 return FRAME_FOREGROUND_PIXEL (f
);
4375 #ifdef HAVE_X_WINDOWS
4380 cmap
= FRAME_X_COLORMAP (f
);
4381 rc
= x_alloc_nearest_color (f
, cmap
, &color
);
4384 ++ct_colors_allocated
;
4385 p
= xmalloc (sizeof *p
);
4389 p
->pixel
= color
.pixel
;
4390 p
->next
= ct_table
[i
];
4394 return FRAME_FOREGROUND_PIXEL (f
);
4398 color
= PALETTERGB (r
, g
, b
);
4400 color
= RGB_TO_ULONG (r
, g
, b
);
4401 #endif /* HAVE_NTGUI */
4402 ++ct_colors_allocated
;
4403 p
= xmalloc (sizeof *p
);
4408 p
->next
= ct_table
[i
];
4410 #endif /* HAVE_X_WINDOWS */
4418 /* Look up pixel color PIXEL which is used on frame F in the color
4419 table. If not already present, allocate it. Value is PIXEL. */
4421 static unsigned long
4422 lookup_pixel_color (struct frame
*f
, unsigned long pixel
)
4424 int i
= pixel
% CT_SIZE
;
4427 for (p
= ct_table
[i
]; p
; p
= p
->next
)
4428 if (p
->pixel
== pixel
)
4437 if (ct_colors_allocated_max
<= ct_colors_allocated
)
4438 return FRAME_FOREGROUND_PIXEL (f
);
4440 #ifdef HAVE_X_WINDOWS
4441 cmap
= FRAME_X_COLORMAP (f
);
4442 color
.pixel
= pixel
;
4443 x_query_color (f
, &color
);
4444 rc
= x_alloc_nearest_color (f
, cmap
, &color
);
4447 cmap
= DefaultColormapOfScreen (FRAME_X_SCREEN (f
));
4448 color
.pixel
= pixel
;
4449 XQueryColor (NULL
, cmap
, &color
);
4450 rc
= x_alloc_nearest_color (f
, cmap
, &color
);
4452 #endif /* HAVE_X_WINDOWS */
4456 ++ct_colors_allocated
;
4458 p
= xmalloc (sizeof *p
);
4463 p
->next
= ct_table
[i
];
4467 return FRAME_FOREGROUND_PIXEL (f
);
4473 /* Value is a vector of all pixel colors contained in the color table,
4474 allocated via xmalloc. Set *N to the number of colors. */
4476 static unsigned long *
4477 colors_in_color_table (int *n
)
4481 unsigned long *colors
;
4483 if (ct_colors_allocated
== 0)
4490 colors
= xmalloc (ct_colors_allocated
* sizeof *colors
);
4491 *n
= ct_colors_allocated
;
4493 for (i
= j
= 0; i
< CT_SIZE
; ++i
)
4494 for (p
= ct_table
[i
]; p
; p
= p
->next
)
4495 colors
[j
++] = p
->pixel
;
4501 #else /* COLOR_TABLE_SUPPORT */
4503 static unsigned long
4504 lookup_rgb_color (struct frame
*f
, int r
, int g
, int b
)
4506 unsigned long pixel
;
4509 pixel
= PALETTERGB (r
>> 8, g
>> 8, b
>> 8);
4510 #endif /* HAVE_NTGUI */
4513 pixel
= RGB_TO_ULONG (r
>> 8, g
>> 8, b
>> 8);
4514 #endif /* HAVE_NS */
4519 init_color_table (void)
4522 #endif /* COLOR_TABLE_SUPPORT */
4525 /***********************************************************************
4527 ***********************************************************************/
4529 /* Edge detection matrices for different edge-detection
4532 static int emboss_matrix
[9] = {
4534 2, -1, 0, /* y - 1 */
4536 0, 1, -2 /* y + 1 */
4539 static int laplace_matrix
[9] = {
4541 1, 0, 0, /* y - 1 */
4543 0, 0, -1 /* y + 1 */
4546 /* Value is the intensity of the color whose red/green/blue values
4549 #define COLOR_INTENSITY(R, G, B) ((2 * (R) + 3 * (G) + (B)) / 6)
4552 /* On frame F, return an array of XColor structures describing image
4553 IMG->pixmap. Each XColor structure has its pixel color set. RGB_P
4554 means also fill the red/green/blue members of the XColor
4555 structures. Value is a pointer to the array of XColors structures,
4556 allocated with xmalloc; it must be freed by the caller. */
4559 x_to_xcolors (struct frame
*f
, struct image
*img
, bool rgb_p
)
4563 XImagePtr_or_DC ximg
;
4566 #endif /* HAVE_NTGUI */
4568 if (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *colors
/ img
->width
< img
->height
)
4569 memory_full (SIZE_MAX
);
4570 colors
= xmalloc (sizeof *colors
* img
->width
* img
->height
);
4572 /* Get the X image or create a memory device context for IMG. */
4573 ximg
= image_get_x_image_or_dc (f
, img
, 0, &prev
);
4575 /* Fill the `pixel' members of the XColor array. I wished there
4576 were an easy and portable way to circumvent XGetPixel. */
4578 for (y
= 0; y
< img
->height
; ++y
)
4580 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI)
4582 for (x
= 0; x
< img
->width
; ++x
, ++p
)
4583 p
->pixel
= GET_PIXEL (ximg
, x
, y
);
4585 x_query_colors (f
, row
, img
->width
);
4589 for (x
= 0; x
< img
->width
; ++x
, ++p
)
4591 /* W32_TODO: palette support needed here? */
4592 p
->pixel
= GET_PIXEL (ximg
, x
, y
);
4595 p
->red
= RED16_FROM_ULONG (p
->pixel
);
4596 p
->green
= GREEN16_FROM_ULONG (p
->pixel
);
4597 p
->blue
= BLUE16_FROM_ULONG (p
->pixel
);
4600 #endif /* HAVE_X_WINDOWS */
4603 image_unget_x_image_or_dc (img
, 0, ximg
, prev
);
4610 /* Put a pixel of COLOR at position X, Y in XIMG. XIMG must have been
4611 created with CreateDIBSection, with the pointer to the bit values
4612 stored in ximg->data. */
4615 XPutPixel (XImagePtr ximg
, int x
, int y
, COLORREF color
)
4617 int width
= ximg
->info
.bmiHeader
.biWidth
;
4618 unsigned char * pixel
;
4620 /* True color images. */
4621 if (ximg
->info
.bmiHeader
.biBitCount
== 24)
4623 int rowbytes
= width
* 3;
4624 /* Ensure scanlines are aligned on 4 byte boundaries. */
4626 rowbytes
+= 4 - (rowbytes
% 4);
4628 pixel
= ximg
->data
+ y
* rowbytes
+ x
* 3;
4629 /* Windows bitmaps are in BGR order. */
4630 *pixel
= GetBValue (color
);
4631 *(pixel
+ 1) = GetGValue (color
);
4632 *(pixel
+ 2) = GetRValue (color
);
4634 /* Monochrome images. */
4635 else if (ximg
->info
.bmiHeader
.biBitCount
== 1)
4637 int rowbytes
= width
/ 8;
4638 /* Ensure scanlines are aligned on 4 byte boundaries. */
4640 rowbytes
+= 4 - (rowbytes
% 4);
4641 pixel
= ximg
->data
+ y
* rowbytes
+ x
/ 8;
4642 /* Filter out palette info. */
4643 if (color
& 0x00ffffff)
4644 *pixel
= *pixel
| (1 << x
% 8);
4646 *pixel
= *pixel
& ~(1 << x
% 8);
4649 image_error ("XPutPixel: palette image not supported", Qnil
, Qnil
);
4652 #endif /* HAVE_NTGUI */
4654 /* Create IMG->pixmap from an array COLORS of XColor structures, whose
4655 RGB members are set. F is the frame on which this all happens.
4656 COLORS will be freed; an existing IMG->pixmap will be freed, too. */
4659 x_from_xcolors (struct frame
*f
, struct image
*img
, XColor
*colors
)
4662 XImagePtr oimg
= NULL
;
4665 init_color_table ();
4667 x_clear_image_1 (f
, img
, CLEAR_IMAGE_PIXMAP
| CLEAR_IMAGE_COLORS
);
4668 image_create_x_image_and_pixmap (f
, img
, img
->width
, img
->height
, 0,
4671 for (y
= 0; y
< img
->height
; ++y
)
4672 for (x
= 0; x
< img
->width
; ++x
, ++p
)
4674 unsigned long pixel
;
4675 pixel
= lookup_rgb_color (f
, p
->red
, p
->green
, p
->blue
);
4676 XPutPixel (oimg
, x
, y
, pixel
);
4681 image_put_x_image (f
, img
, oimg
, 0);
4682 #ifdef COLOR_TABLE_SUPPORT
4683 img
->colors
= colors_in_color_table (&img
->ncolors
);
4684 free_color_table ();
4685 #endif /* COLOR_TABLE_SUPPORT */
4689 /* On frame F, perform edge-detection on image IMG.
4691 MATRIX is a nine-element array specifying the transformation
4692 matrix. See emboss_matrix for an example.
4694 COLOR_ADJUST is a color adjustment added to each pixel of the
4698 x_detect_edges (struct frame
*f
, struct image
*img
, int *matrix
, int color_adjust
)
4700 XColor
*colors
= x_to_xcolors (f
, img
, 1);
4704 for (i
= sum
= 0; i
< 9; ++i
)
4705 sum
+= eabs (matrix
[i
]);
4707 #define COLOR(A, X, Y) ((A) + (Y) * img->width + (X))
4709 if (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *new / img
->width
< img
->height
)
4710 memory_full (SIZE_MAX
);
4711 new = xmalloc (sizeof *new * img
->width
* img
->height
);
4713 for (y
= 0; y
< img
->height
; ++y
)
4715 p
= COLOR (new, 0, y
);
4716 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4717 p
= COLOR (new, img
->width
- 1, y
);
4718 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4721 for (x
= 1; x
< img
->width
- 1; ++x
)
4723 p
= COLOR (new, x
, 0);
4724 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4725 p
= COLOR (new, x
, img
->height
- 1);
4726 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4729 for (y
= 1; y
< img
->height
- 1; ++y
)
4731 p
= COLOR (new, 1, y
);
4733 for (x
= 1; x
< img
->width
- 1; ++x
, ++p
)
4735 int r
, g
, b
, yy
, xx
;
4738 for (yy
= y
- 1; yy
< y
+ 2; ++yy
)
4739 for (xx
= x
- 1; xx
< x
+ 2; ++xx
, ++i
)
4742 XColor
*t
= COLOR (colors
, xx
, yy
);
4743 r
+= matrix
[i
] * t
->red
;
4744 g
+= matrix
[i
] * t
->green
;
4745 b
+= matrix
[i
] * t
->blue
;
4748 r
= (r
/ sum
+ color_adjust
) & 0xffff;
4749 g
= (g
/ sum
+ color_adjust
) & 0xffff;
4750 b
= (b
/ sum
+ color_adjust
) & 0xffff;
4751 p
->red
= p
->green
= p
->blue
= COLOR_INTENSITY (r
, g
, b
);
4756 x_from_xcolors (f
, img
, new);
4762 /* Perform the pre-defined `emboss' edge-detection on image IMG
4766 x_emboss (struct frame
*f
, struct image
*img
)
4768 x_detect_edges (f
, img
, emboss_matrix
, 0xffff / 2);
4772 /* Transform image IMG which is used on frame F with a Laplace
4773 edge-detection algorithm. The result is an image that can be used
4774 to draw disabled buttons, for example. */
4777 x_laplace (struct frame
*f
, struct image
*img
)
4779 x_detect_edges (f
, img
, laplace_matrix
, 45000);
4783 /* Perform edge-detection on image IMG on frame F, with specified
4784 transformation matrix MATRIX and color-adjustment COLOR_ADJUST.
4786 MATRIX must be either
4788 - a list of at least 9 numbers in row-major form
4789 - a vector of at least 9 numbers
4791 COLOR_ADJUST nil means use a default; otherwise it must be a
4795 x_edge_detection (struct frame
*f
, struct image
*img
, Lisp_Object matrix
,
4796 Lisp_Object color_adjust
)
4804 i
< 9 && CONSP (matrix
) && NUMBERP (XCAR (matrix
));
4805 ++i
, matrix
= XCDR (matrix
))
4806 trans
[i
] = XFLOATINT (XCAR (matrix
));
4808 else if (VECTORP (matrix
) && ASIZE (matrix
) >= 9)
4810 for (i
= 0; i
< 9 && NUMBERP (AREF (matrix
, i
)); ++i
)
4811 trans
[i
] = XFLOATINT (AREF (matrix
, i
));
4814 if (NILP (color_adjust
))
4815 color_adjust
= make_number (0xffff / 2);
4817 if (i
== 9 && NUMBERP (color_adjust
))
4818 x_detect_edges (f
, img
, trans
, XFLOATINT (color_adjust
));
4822 /* Transform image IMG on frame F so that it looks disabled. */
4825 x_disable_image (struct frame
*f
, struct image
*img
)
4827 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
4829 int n_planes
= dpyinfo
->n_planes
* dpyinfo
->n_cbits
;
4831 int n_planes
= dpyinfo
->n_planes
;
4832 #endif /* HAVE_NTGUI */
4836 /* Color (or grayscale). Convert to gray, and equalize. Just
4837 drawing such images with a stipple can look very odd, so
4838 we're using this method instead. */
4839 XColor
*colors
= x_to_xcolors (f
, img
, 1);
4841 const int h
= 15000;
4842 const int l
= 30000;
4844 for (p
= colors
, end
= colors
+ img
->width
* img
->height
;
4848 int i
= COLOR_INTENSITY (p
->red
, p
->green
, p
->blue
);
4849 int i2
= (0xffff - h
- l
) * i
/ 0xffff + l
;
4850 p
->red
= p
->green
= p
->blue
= i2
;
4853 x_from_xcolors (f
, img
, colors
);
4856 /* Draw a cross over the disabled image, if we must or if we
4858 if (n_planes
< 2 || cross_disabled_images
)
4861 #ifndef HAVE_NS /* TODO: NS support, however this not needed for toolbars */
4863 #define MaskForeground(f) WHITE_PIX_DEFAULT (f)
4865 Display
*dpy
= FRAME_X_DISPLAY (f
);
4868 image_sync_to_pixmaps (f
, img
);
4869 gc
= XCreateGC (dpy
, img
->pixmap
, 0, NULL
);
4870 XSetForeground (dpy
, gc
, BLACK_PIX_DEFAULT (f
));
4871 XDrawLine (dpy
, img
->pixmap
, gc
, 0, 0,
4872 img
->width
- 1, img
->height
- 1);
4873 XDrawLine (dpy
, img
->pixmap
, gc
, 0, img
->height
- 1,
4879 gc
= XCreateGC (dpy
, img
->mask
, 0, NULL
);
4880 XSetForeground (dpy
, gc
, MaskForeground (f
));
4881 XDrawLine (dpy
, img
->mask
, gc
, 0, 0,
4882 img
->width
- 1, img
->height
- 1);
4883 XDrawLine (dpy
, img
->mask
, gc
, 0, img
->height
- 1,
4887 #endif /* !HAVE_NS */
4892 hdc
= get_frame_dc (f
);
4893 bmpdc
= CreateCompatibleDC (hdc
);
4894 release_frame_dc (f
, hdc
);
4896 prev
= SelectObject (bmpdc
, img
->pixmap
);
4898 SetTextColor (bmpdc
, BLACK_PIX_DEFAULT (f
));
4899 MoveToEx (bmpdc
, 0, 0, NULL
);
4900 LineTo (bmpdc
, img
->width
- 1, img
->height
- 1);
4901 MoveToEx (bmpdc
, 0, img
->height
- 1, NULL
);
4902 LineTo (bmpdc
, img
->width
- 1, 0);
4906 SelectObject (bmpdc
, img
->mask
);
4907 SetTextColor (bmpdc
, WHITE_PIX_DEFAULT (f
));
4908 MoveToEx (bmpdc
, 0, 0, NULL
);
4909 LineTo (bmpdc
, img
->width
- 1, img
->height
- 1);
4910 MoveToEx (bmpdc
, 0, img
->height
- 1, NULL
);
4911 LineTo (bmpdc
, img
->width
- 1, 0);
4913 SelectObject (bmpdc
, prev
);
4915 #endif /* HAVE_NTGUI */
4920 /* Build a mask for image IMG which is used on frame F. FILE is the
4921 name of an image file, for error messages. HOW determines how to
4922 determine the background color of IMG. If it is a list '(R G B)',
4923 with R, G, and B being integers >= 0, take that as the color of the
4924 background. Otherwise, determine the background color of IMG
4928 x_build_heuristic_mask (struct frame
*f
, struct image
*img
, Lisp_Object how
)
4930 XImagePtr_or_DC ximg
;
4937 #endif /* HAVE_NTGUI */
4939 bool rc
, use_img_background
;
4940 unsigned long bg
= 0;
4943 x_clear_image_1 (f
, img
, CLEAR_IMAGE_MASK
);
4947 /* Create an image and pixmap serving as mask. */
4948 rc
= image_create_x_image_and_pixmap (f
, img
, img
->width
, img
->height
, 1,
4952 #endif /* !HAVE_NS */
4954 /* Create the bit array serving as mask. */
4955 row_width
= (img
->width
+ 7) / 8;
4956 mask_img
= xzalloc (row_width
* img
->height
);
4957 #endif /* HAVE_NTGUI */
4959 /* Get the X image or create a memory device context for IMG. */
4960 ximg
= image_get_x_image_or_dc (f
, img
, 0, &prev
);
4962 /* Determine the background color of ximg. If HOW is `(R G B)'
4963 take that as color. Otherwise, use the image's background color. */
4964 use_img_background
= 1;
4970 for (i
= 0; i
< 3 && CONSP (how
) && NATNUMP (XCAR (how
)); ++i
)
4972 rgb
[i
] = XFASTINT (XCAR (how
)) & 0xffff;
4976 if (i
== 3 && NILP (how
))
4978 char color_name
[30];
4979 sprintf (color_name
, "#%04x%04x%04x", rgb
[0], rgb
[1], rgb
[2]);
4982 0x00ffffff & /* Filter out palette info. */
4983 #endif /* HAVE_NTGUI */
4984 x_alloc_image_color (f
, img
, build_string (color_name
), 0));
4985 use_img_background
= 0;
4989 if (use_img_background
)
4990 bg
= four_corners_best (ximg
, img
->corners
, img
->width
, img
->height
);
4992 /* Set all bits in mask_img to 1 whose color in ximg is different
4993 from the background color bg. */
4995 for (y
= 0; y
< img
->height
; ++y
)
4996 for (x
= 0; x
< img
->width
; ++x
)
4998 XPutPixel (mask_img
, x
, y
, (XGetPixel (ximg
, x
, y
) != bg
4999 ? PIX_MASK_DRAW
: PIX_MASK_RETAIN
));
5001 if (XGetPixel (ximg
, x
, y
) == bg
)
5002 ns_set_alpha (ximg
, x
, y
, 0);
5003 #endif /* HAVE_NS */
5005 /* Fill in the background_transparent field while we have the mask handy. */
5006 image_background_transparent (img
, f
, mask_img
);
5008 /* Put mask_img into the image. */
5009 image_put_x_image (f
, img
, mask_img
, 1);
5010 #endif /* !HAVE_NS */
5012 for (y
= 0; y
< img
->height
; ++y
)
5013 for (x
= 0; x
< img
->width
; ++x
)
5015 COLORREF p
= GetPixel (ximg
, x
, y
);
5017 mask_img
[y
* row_width
+ x
/ 8] |= 1 << (x
% 8);
5020 /* Create the mask image. */
5021 img
->mask
= w32_create_pixmap_from_bitmap_data (img
->width
, img
->height
,
5023 /* Fill in the background_transparent field while we have the mask handy. */
5024 SelectObject (ximg
, img
->mask
);
5025 image_background_transparent (img
, f
, ximg
);
5027 /* Was: x_destroy_x_image ((XImagePtr )mask_img); which seems bogus ++kfs */
5029 #endif /* HAVE_NTGUI */
5031 image_unget_x_image_or_dc (img
, 0, ximg
, prev
);
5035 /***********************************************************************
5036 PBM (mono, gray, color)
5037 ***********************************************************************/
5039 static bool pbm_image_p (Lisp_Object object
);
5040 static bool pbm_load (struct frame
*f
, struct image
*img
);
5042 /* The symbol `pbm' identifying images of this type. */
5044 static Lisp_Object Qpbm
;
5046 /* Indices of image specification fields in gs_format, below. */
5048 enum pbm_keyword_index
5064 /* Vector of image_keyword structures describing the format
5065 of valid user-defined image specifications. */
5067 static const struct image_keyword pbm_format
[PBM_LAST
] =
5069 {":type", IMAGE_SYMBOL_VALUE
, 1},
5070 {":file", IMAGE_STRING_VALUE
, 0},
5071 {":data", IMAGE_STRING_VALUE
, 0},
5072 {":ascent", IMAGE_ASCENT_VALUE
, 0},
5073 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
5074 {":relief", IMAGE_INTEGER_VALUE
, 0},
5075 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5076 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5077 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5078 {":foreground", IMAGE_STRING_OR_NIL_VALUE
, 0},
5079 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
5082 /* Structure describing the image type `pbm'. */
5084 static struct image_type pbm_type
=
5095 /* Return true if OBJECT is a valid PBM image specification. */
5098 pbm_image_p (Lisp_Object object
)
5100 struct image_keyword fmt
[PBM_LAST
];
5102 memcpy (fmt
, pbm_format
, sizeof fmt
);
5104 if (!parse_image_spec (object
, fmt
, PBM_LAST
, Qpbm
))
5107 /* Must specify either :data or :file. */
5108 return fmt
[PBM_DATA
].count
+ fmt
[PBM_FILE
].count
== 1;
5112 /* Scan a decimal number from *S and return it. Advance *S while
5113 reading the number. END is the end of the string. Value is -1 at
5117 pbm_scan_number (unsigned char **s
, unsigned char *end
)
5119 int c
= 0, val
= -1;
5123 /* Skip white-space. */
5124 while (*s
< end
&& (c
= *(*s
)++, c_isspace (c
)))
5129 /* Skip comment to end of line. */
5130 while (*s
< end
&& (c
= *(*s
)++, c
!= '\n'))
5133 else if (c_isdigit (c
))
5135 /* Read decimal number. */
5137 while (*s
< end
&& (c
= *(*s
)++, c_isdigit (c
)))
5138 val
= 10 * val
+ c
- '0';
5149 /* Load PBM image IMG for use on frame F. */
5152 pbm_load (struct frame
*f
, struct image
*img
)
5156 int width
, height
, max_color_idx
= 0;
5158 Lisp_Object file
, specified_file
;
5159 enum {PBM_MONO
, PBM_GRAY
, PBM_COLOR
} type
;
5160 unsigned char *contents
= NULL
;
5161 unsigned char *end
, *p
;
5164 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
5166 if (STRINGP (specified_file
))
5168 file
= x_find_image_file (specified_file
);
5169 if (!STRINGP (file
))
5171 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
5175 contents
= slurp_file (SSDATA (file
), &size
);
5176 if (contents
== NULL
)
5178 image_error ("Error reading `%s'", file
, Qnil
);
5183 end
= contents
+ size
;
5188 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
5189 if (!STRINGP (data
))
5191 image_error ("Invalid image data `%s'", data
, Qnil
);
5195 end
= p
+ SBYTES (data
);
5198 /* Check magic number. */
5199 if (end
- p
< 2 || *p
++ != 'P')
5201 image_error ("Not a PBM image: `%s'", img
->spec
, Qnil
);
5210 raw_p
= 0, type
= PBM_MONO
;
5214 raw_p
= 0, type
= PBM_GRAY
;
5218 raw_p
= 0, type
= PBM_COLOR
;
5222 raw_p
= 1, type
= PBM_MONO
;
5226 raw_p
= 1, type
= PBM_GRAY
;
5230 raw_p
= 1, type
= PBM_COLOR
;
5234 image_error ("Not a PBM image: `%s'", img
->spec
, Qnil
);
5238 /* Read width, height, maximum color-component. Characters
5239 starting with `#' up to the end of a line are ignored. */
5240 width
= pbm_scan_number (&p
, end
);
5241 height
= pbm_scan_number (&p
, end
);
5243 if (type
!= PBM_MONO
)
5245 max_color_idx
= pbm_scan_number (&p
, end
);
5246 if (max_color_idx
> 65535 || max_color_idx
< 0)
5248 image_error ("Unsupported maximum PBM color value", Qnil
, Qnil
);
5253 if (!check_image_size (f
, width
, height
))
5255 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
5259 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, 0, &ximg
, 0))
5262 /* Initialize the color hash table. */
5263 init_color_table ();
5265 if (type
== PBM_MONO
)
5268 struct image_keyword fmt
[PBM_LAST
];
5269 unsigned long fg
= FRAME_FOREGROUND_PIXEL (f
);
5270 unsigned long bg
= FRAME_BACKGROUND_PIXEL (f
);
5272 /* Parse the image specification. */
5273 memcpy (fmt
, pbm_format
, sizeof fmt
);
5274 parse_image_spec (img
->spec
, fmt
, PBM_LAST
, Qpbm
);
5276 /* Get foreground and background colors, maybe allocate colors. */
5277 if (fmt
[PBM_FOREGROUND
].count
5278 && STRINGP (fmt
[PBM_FOREGROUND
].value
))
5279 fg
= x_alloc_image_color (f
, img
, fmt
[PBM_FOREGROUND
].value
, fg
);
5280 if (fmt
[PBM_BACKGROUND
].count
5281 && STRINGP (fmt
[PBM_BACKGROUND
].value
))
5283 bg
= x_alloc_image_color (f
, img
, fmt
[PBM_BACKGROUND
].value
, bg
);
5284 img
->background
= bg
;
5285 img
->background_valid
= 1;
5288 for (y
= 0; y
< height
; ++y
)
5289 for (x
= 0; x
< width
; ++x
)
5297 x_destroy_x_image (ximg
);
5298 x_clear_image (f
, img
);
5299 image_error ("Invalid image size in image `%s'",
5309 g
= pbm_scan_number (&p
, end
);
5311 XPutPixel (ximg
, x
, y
, g
? fg
: bg
);
5316 int expected_size
= height
* width
;
5317 if (max_color_idx
> 255)
5319 if (type
== PBM_COLOR
)
5322 if (raw_p
&& p
+ expected_size
> end
)
5324 x_destroy_x_image (ximg
);
5325 x_clear_image (f
, img
);
5326 image_error ("Invalid image size in image `%s'",
5331 for (y
= 0; y
< height
; ++y
)
5332 for (x
= 0; x
< width
; ++x
)
5336 if (type
== PBM_GRAY
&& raw_p
)
5339 if (max_color_idx
> 255)
5340 r
= g
= b
= r
* 256 + *p
++;
5342 else if (type
== PBM_GRAY
)
5343 r
= g
= b
= pbm_scan_number (&p
, end
);
5347 if (max_color_idx
> 255)
5350 if (max_color_idx
> 255)
5353 if (max_color_idx
> 255)
5358 r
= pbm_scan_number (&p
, end
);
5359 g
= pbm_scan_number (&p
, end
);
5360 b
= pbm_scan_number (&p
, end
);
5363 if (r
< 0 || g
< 0 || b
< 0)
5365 x_destroy_x_image (ximg
);
5366 image_error ("Invalid pixel value in image `%s'",
5371 /* RGB values are now in the range 0..max_color_idx.
5372 Scale this to the range 0..0xffff supported by X. */
5373 r
= (double) r
* 65535 / max_color_idx
;
5374 g
= (double) g
* 65535 / max_color_idx
;
5375 b
= (double) b
* 65535 / max_color_idx
;
5376 XPutPixel (ximg
, x
, y
, lookup_rgb_color (f
, r
, g
, b
));
5380 #ifdef COLOR_TABLE_SUPPORT
5381 /* Store in IMG->colors the colors allocated for the image, and
5382 free the color table. */
5383 img
->colors
= colors_in_color_table (&img
->ncolors
);
5384 free_color_table ();
5385 #endif /* COLOR_TABLE_SUPPORT */
5388 img
->height
= height
;
5390 /* Maybe fill in the background field while we have ximg handy. */
5392 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
5393 /* Casting avoids a GCC warning. */
5394 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
5396 /* Put ximg into the image. */
5397 image_put_x_image (f
, img
, ximg
, 0);
5399 /* X and W32 versions did it here, MAC version above. ++kfs
5401 img->height = height; */
5408 /***********************************************************************
5410 ***********************************************************************/
5412 #if defined (HAVE_PNG) || defined (HAVE_NS)
5414 /* Function prototypes. */
5416 static bool png_image_p (Lisp_Object object
);
5417 static bool png_load (struct frame
*f
, struct image
*img
);
5419 /* The symbol `png' identifying images of this type. */
5421 static Lisp_Object Qpng
;
5423 /* Indices of image specification fields in png_format, below. */
5425 enum png_keyword_index
5440 /* Vector of image_keyword structures describing the format
5441 of valid user-defined image specifications. */
5443 static const struct image_keyword png_format
[PNG_LAST
] =
5445 {":type", IMAGE_SYMBOL_VALUE
, 1},
5446 {":data", IMAGE_STRING_VALUE
, 0},
5447 {":file", IMAGE_STRING_VALUE
, 0},
5448 {":ascent", IMAGE_ASCENT_VALUE
, 0},
5449 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
5450 {":relief", IMAGE_INTEGER_VALUE
, 0},
5451 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5452 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5453 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5454 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
5457 #if defined HAVE_NTGUI && defined WINDOWSNT
5458 static bool init_png_functions (void);
5460 #define init_png_functions NULL
5463 /* Structure describing the image type `png'. */
5465 static struct image_type png_type
=
5475 /* Return true if OBJECT is a valid PNG image specification. */
5478 png_image_p (Lisp_Object object
)
5480 struct image_keyword fmt
[PNG_LAST
];
5481 memcpy (fmt
, png_format
, sizeof fmt
);
5483 if (!parse_image_spec (object
, fmt
, PNG_LAST
, Qpng
))
5486 /* Must specify either the :data or :file keyword. */
5487 return fmt
[PNG_FILE
].count
+ fmt
[PNG_DATA
].count
== 1;
5490 #endif /* HAVE_PNG || HAVE_NS */
5496 /* PNG library details. */
5498 DEF_IMGLIB_FN (png_voidp
, png_get_io_ptr
, (png_structp
));
5499 DEF_IMGLIB_FN (int, png_sig_cmp
, (png_bytep
, png_size_t
, png_size_t
));
5500 DEF_IMGLIB_FN (png_structp
, png_create_read_struct
, (png_const_charp
, png_voidp
,
5501 png_error_ptr
, png_error_ptr
));
5502 DEF_IMGLIB_FN (png_infop
, png_create_info_struct
, (png_structp
));
5503 DEF_IMGLIB_FN (void, png_destroy_read_struct
, (png_structpp
, png_infopp
, png_infopp
));
5504 DEF_IMGLIB_FN (void, png_set_read_fn
, (png_structp
, png_voidp
, png_rw_ptr
));
5505 DEF_IMGLIB_FN (void, png_set_sig_bytes
, (png_structp
, int));
5506 DEF_IMGLIB_FN (void, png_read_info
, (png_structp
, png_infop
));
5507 DEF_IMGLIB_FN (png_uint_32
, png_get_IHDR
, (png_structp
, png_infop
,
5508 png_uint_32
*, png_uint_32
*,
5509 int *, int *, int *, int *, int *));
5510 DEF_IMGLIB_FN (png_uint_32
, png_get_valid
, (png_structp
, png_infop
, png_uint_32
));
5511 DEF_IMGLIB_FN (void, png_set_strip_16
, (png_structp
));
5512 DEF_IMGLIB_FN (void, png_set_expand
, (png_structp
));
5513 DEF_IMGLIB_FN (void, png_set_gray_to_rgb
, (png_structp
));
5514 DEF_IMGLIB_FN (void, png_set_background
, (png_structp
, png_color_16p
,
5516 DEF_IMGLIB_FN (png_uint_32
, png_get_bKGD
, (png_structp
, png_infop
, png_color_16p
*));
5517 DEF_IMGLIB_FN (void, png_read_update_info
, (png_structp
, png_infop
));
5518 DEF_IMGLIB_FN (png_byte
, png_get_channels
, (png_structp
, png_infop
));
5519 DEF_IMGLIB_FN (png_size_t
, png_get_rowbytes
, (png_structp
, png_infop
));
5520 DEF_IMGLIB_FN (void, png_read_image
, (png_structp
, png_bytepp
));
5521 DEF_IMGLIB_FN (void, png_read_end
, (png_structp
, png_infop
));
5522 DEF_IMGLIB_FN (void, png_error
, (png_structp
, png_const_charp
));
5524 #if (PNG_LIBPNG_VER >= 10500)
5525 DEF_IMGLIB_FN (void, png_longjmp
, (png_structp
, int));
5526 DEF_IMGLIB_FN (jmp_buf *, png_set_longjmp_fn
, (png_structp
, png_longjmp_ptr
, size_t));
5527 #endif /* libpng version >= 1.5 */
5530 init_png_functions (void)
5534 if (!(library
= w32_delayed_load (Qpng
)))
5537 LOAD_IMGLIB_FN (library
, png_get_io_ptr
);
5538 LOAD_IMGLIB_FN (library
, png_sig_cmp
);
5539 LOAD_IMGLIB_FN (library
, png_create_read_struct
);
5540 LOAD_IMGLIB_FN (library
, png_create_info_struct
);
5541 LOAD_IMGLIB_FN (library
, png_destroy_read_struct
);
5542 LOAD_IMGLIB_FN (library
, png_set_read_fn
);
5543 LOAD_IMGLIB_FN (library
, png_set_sig_bytes
);
5544 LOAD_IMGLIB_FN (library
, png_read_info
);
5545 LOAD_IMGLIB_FN (library
, png_get_IHDR
);
5546 LOAD_IMGLIB_FN (library
, png_get_valid
);
5547 LOAD_IMGLIB_FN (library
, png_set_strip_16
);
5548 LOAD_IMGLIB_FN (library
, png_set_expand
);
5549 LOAD_IMGLIB_FN (library
, png_set_gray_to_rgb
);
5550 LOAD_IMGLIB_FN (library
, png_set_background
);
5551 LOAD_IMGLIB_FN (library
, png_get_bKGD
);
5552 LOAD_IMGLIB_FN (library
, png_read_update_info
);
5553 LOAD_IMGLIB_FN (library
, png_get_channels
);
5554 LOAD_IMGLIB_FN (library
, png_get_rowbytes
);
5555 LOAD_IMGLIB_FN (library
, png_read_image
);
5556 LOAD_IMGLIB_FN (library
, png_read_end
);
5557 LOAD_IMGLIB_FN (library
, png_error
);
5559 #if (PNG_LIBPNG_VER >= 10500)
5560 LOAD_IMGLIB_FN (library
, png_longjmp
);
5561 LOAD_IMGLIB_FN (library
, png_set_longjmp_fn
);
5562 #endif /* libpng version >= 1.5 */
5568 #define fn_png_get_io_ptr png_get_io_ptr
5569 #define fn_png_sig_cmp png_sig_cmp
5570 #define fn_png_create_read_struct png_create_read_struct
5571 #define fn_png_create_info_struct png_create_info_struct
5572 #define fn_png_destroy_read_struct png_destroy_read_struct
5573 #define fn_png_set_read_fn png_set_read_fn
5574 #define fn_png_set_sig_bytes png_set_sig_bytes
5575 #define fn_png_read_info png_read_info
5576 #define fn_png_get_IHDR png_get_IHDR
5577 #define fn_png_get_valid png_get_valid
5578 #define fn_png_set_strip_16 png_set_strip_16
5579 #define fn_png_set_expand png_set_expand
5580 #define fn_png_set_gray_to_rgb png_set_gray_to_rgb
5581 #define fn_png_set_background png_set_background
5582 #define fn_png_get_bKGD png_get_bKGD
5583 #define fn_png_read_update_info png_read_update_info
5584 #define fn_png_get_channels png_get_channels
5585 #define fn_png_get_rowbytes png_get_rowbytes
5586 #define fn_png_read_image png_read_image
5587 #define fn_png_read_end png_read_end
5588 #define fn_png_error png_error
5590 #if (PNG_LIBPNG_VER >= 10500)
5591 #define fn_png_longjmp png_longjmp
5592 #define fn_png_set_longjmp_fn png_set_longjmp_fn
5593 #endif /* libpng version >= 1.5 */
5595 #endif /* WINDOWSNT */
5597 /* Possibly inefficient/inexact substitutes for _setjmp and _longjmp.
5598 Do not use sys_setjmp, as PNG supports only jmp_buf. The _longjmp
5599 substitute may munge the signal mask, but that should be OK here.
5600 MinGW (MS-Windows) uses _setjmp and defines setjmp to _setjmp in
5601 the system header setjmp.h; don't mess up that. */
5602 #ifndef HAVE__SETJMP
5603 # define _setjmp(j) setjmp (j)
5604 # define _longjmp longjmp
5607 #if (PNG_LIBPNG_VER < 10500)
5608 #define PNG_LONGJMP(ptr) (_longjmp ((ptr)->jmpbuf, 1))
5609 #define PNG_JMPBUF(ptr) ((ptr)->jmpbuf)
5611 /* In libpng version 1.5, the jmpbuf member is hidden. (Bug#7908) */
5612 #define PNG_LONGJMP(ptr) (fn_png_longjmp ((ptr), 1))
5613 #define PNG_JMPBUF(ptr) \
5614 (*fn_png_set_longjmp_fn ((ptr), _longjmp, sizeof (jmp_buf)))
5617 /* Error and warning handlers installed when the PNG library
5620 static _Noreturn
void
5621 my_png_error (png_struct
*png_ptr
, const char *msg
)
5623 eassert (png_ptr
!= NULL
);
5624 /* Avoid compiler warning about deprecated direct access to
5625 png_ptr's fields in libpng versions 1.4.x. */
5626 image_error ("PNG error: %s", build_string (msg
), Qnil
);
5627 PNG_LONGJMP (png_ptr
);
5632 my_png_warning (png_struct
*png_ptr
, const char *msg
)
5634 eassert (png_ptr
!= NULL
);
5635 image_error ("PNG warning: %s", build_string (msg
), Qnil
);
5638 /* Memory source for PNG decoding. */
5640 struct png_memory_storage
5642 unsigned char *bytes
; /* The data */
5643 ptrdiff_t len
; /* How big is it? */
5644 ptrdiff_t index
; /* Where are we? */
5648 /* Function set as reader function when reading PNG image from memory.
5649 PNG_PTR is a pointer to the PNG control structure. Copy LENGTH
5650 bytes from the input to DATA. */
5653 png_read_from_memory (png_structp png_ptr
, png_bytep data
, png_size_t length
)
5655 struct png_memory_storage
*tbr
= fn_png_get_io_ptr (png_ptr
);
5657 if (length
> tbr
->len
- tbr
->index
)
5658 fn_png_error (png_ptr
, "Read error");
5660 memcpy (data
, tbr
->bytes
+ tbr
->index
, length
);
5661 tbr
->index
= tbr
->index
+ length
;
5665 /* Function set as reader function when reading PNG image from a file.
5666 PNG_PTR is a pointer to the PNG control structure. Copy LENGTH
5667 bytes from the input to DATA. */
5670 png_read_from_file (png_structp png_ptr
, png_bytep data
, png_size_t length
)
5672 FILE *fp
= fn_png_get_io_ptr (png_ptr
);
5674 if (fread (data
, 1, length
, fp
) < length
)
5675 fn_png_error (png_ptr
, "Read error");
5679 /* Load PNG image IMG for use on frame F. Value is true if
5682 struct png_load_context
5684 /* These are members so that longjmp doesn't munge local variables. */
5685 png_struct
*png_ptr
;
5694 png_load_body (struct frame
*f
, struct image
*img
, struct png_load_context
*c
)
5696 Lisp_Object file
, specified_file
;
5697 Lisp_Object specified_data
;
5700 XImagePtr ximg
, mask_img
= NULL
;
5701 png_struct
*png_ptr
;
5702 png_info
*info_ptr
= NULL
, *end_info
= NULL
;
5705 png_byte
*pixels
= NULL
;
5706 png_byte
**rows
= NULL
;
5707 png_uint_32 width
, height
;
5708 int bit_depth
, color_type
, interlace_type
;
5710 png_uint_32 row_bytes
;
5712 struct png_memory_storage tbr
; /* Data to be read */
5714 /* Find out what file to load. */
5715 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
5716 specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
5718 if (NILP (specified_data
))
5720 file
= x_find_image_file (specified_file
);
5721 if (!STRINGP (file
))
5723 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
5727 /* Open the image file. */
5728 fp
= emacs_fopen (SSDATA (file
), "rb");
5731 image_error ("Cannot open image file `%s'", file
, Qnil
);
5735 /* Check PNG signature. */
5736 if (fread (sig
, 1, sizeof sig
, fp
) != sizeof sig
5737 || fn_png_sig_cmp (sig
, 0, sizeof sig
))
5740 image_error ("Not a PNG file: `%s'", file
, Qnil
);
5746 if (!STRINGP (specified_data
))
5748 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
5752 /* Read from memory. */
5753 tbr
.bytes
= SDATA (specified_data
);
5754 tbr
.len
= SBYTES (specified_data
);
5757 /* Check PNG signature. */
5758 if (tbr
.len
< sizeof sig
5759 || fn_png_sig_cmp (tbr
.bytes
, 0, sizeof sig
))
5761 image_error ("Not a PNG image: `%s'", img
->spec
, Qnil
);
5765 /* Need to skip past the signature. */
5766 tbr
.bytes
+= sizeof (sig
);
5769 /* Initialize read and info structs for PNG lib. */
5770 png_ptr
= fn_png_create_read_struct (PNG_LIBPNG_VER_STRING
,
5775 info_ptr
= fn_png_create_info_struct (png_ptr
);
5776 end_info
= fn_png_create_info_struct (png_ptr
);
5779 c
->png_ptr
= png_ptr
;
5780 c
->info_ptr
= info_ptr
;
5781 c
->end_info
= end_info
;
5786 if (! (info_ptr
&& end_info
))
5788 fn_png_destroy_read_struct (&c
->png_ptr
, &c
->info_ptr
, &c
->end_info
);
5793 if (fp
) fclose (fp
);
5797 /* Set error jump-back. We come back here when the PNG library
5798 detects an error. */
5799 if (_setjmp (PNG_JMPBUF (png_ptr
)))
5803 fn_png_destroy_read_struct (&c
->png_ptr
, &c
->info_ptr
, &c
->end_info
);
5811 /* Silence a bogus diagnostic; see GCC bug 54561. */
5812 IF_LINT (fp
= c
->fp
);
5814 /* Read image info. */
5815 if (!NILP (specified_data
))
5816 fn_png_set_read_fn (png_ptr
, &tbr
, png_read_from_memory
);
5818 fn_png_set_read_fn (png_ptr
, fp
, png_read_from_file
);
5820 fn_png_set_sig_bytes (png_ptr
, sizeof sig
);
5821 fn_png_read_info (png_ptr
, info_ptr
);
5822 fn_png_get_IHDR (png_ptr
, info_ptr
, &width
, &height
, &bit_depth
, &color_type
,
5823 &interlace_type
, NULL
, NULL
);
5825 if (! (width
<= INT_MAX
&& height
<= INT_MAX
5826 && check_image_size (f
, width
, height
)))
5828 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
5832 /* Create the X image and pixmap now, so that the work below can be
5833 omitted if the image is too large for X. */
5834 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, 0, &ximg
, 0))
5837 /* If image contains simply transparency data, we prefer to
5838 construct a clipping mask. */
5839 if (fn_png_get_valid (png_ptr
, info_ptr
, PNG_INFO_tRNS
))
5844 /* This function is easier to write if we only have to handle
5845 one data format: RGB or RGBA with 8 bits per channel. Let's
5846 transform other formats into that format. */
5848 /* Strip more than 8 bits per channel. */
5849 if (bit_depth
== 16)
5850 fn_png_set_strip_16 (png_ptr
);
5852 /* Expand data to 24 bit RGB, or 8 bit grayscale, with alpha channel
5854 fn_png_set_expand (png_ptr
);
5856 /* Convert grayscale images to RGB. */
5857 if (color_type
== PNG_COLOR_TYPE_GRAY
5858 || color_type
== PNG_COLOR_TYPE_GRAY_ALPHA
)
5859 fn_png_set_gray_to_rgb (png_ptr
);
5861 /* Handle alpha channel by combining the image with a background
5862 color. Do this only if a real alpha channel is supplied. For
5863 simple transparency, we prefer a clipping mask. */
5866 /* png_color_16 *image_bg; */
5867 Lisp_Object specified_bg
5868 = image_spec_value (img
->spec
, QCbackground
, NULL
);
5869 int shift
= (bit_depth
== 16) ? 0 : 8;
5871 if (STRINGP (specified_bg
))
5872 /* The user specified `:background', use that. */
5875 if (x_defined_color (f
, SSDATA (specified_bg
), &color
, 0))
5877 png_color_16 user_bg
;
5879 memset (&user_bg
, 0, sizeof user_bg
);
5880 user_bg
.red
= color
.red
>> shift
;
5881 user_bg
.green
= color
.green
>> shift
;
5882 user_bg
.blue
= color
.blue
>> shift
;
5884 fn_png_set_background (png_ptr
, &user_bg
,
5885 PNG_BACKGROUND_GAMMA_SCREEN
, 0, 1.0);
5890 /* We use the current frame background, ignoring any default
5891 background color set by the image. */
5892 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI)
5894 png_color_16 frame_background
;
5896 color
.pixel
= FRAME_BACKGROUND_PIXEL (f
);
5897 x_query_color (f
, &color
);
5899 memset (&frame_background
, 0, sizeof frame_background
);
5900 frame_background
.red
= color
.red
>> shift
;
5901 frame_background
.green
= color
.green
>> shift
;
5902 frame_background
.blue
= color
.blue
>> shift
;
5903 #endif /* HAVE_X_WINDOWS */
5905 fn_png_set_background (png_ptr
, &frame_background
,
5906 PNG_BACKGROUND_GAMMA_SCREEN
, 0, 1.0);
5910 /* Update info structure. */
5911 fn_png_read_update_info (png_ptr
, info_ptr
);
5913 /* Get number of channels. Valid values are 1 for grayscale images
5914 and images with a palette, 2 for grayscale images with transparency
5915 information (alpha channel), 3 for RGB images, and 4 for RGB
5916 images with alpha channel, i.e. RGBA. If conversions above were
5917 sufficient we should only have 3 or 4 channels here. */
5918 channels
= fn_png_get_channels (png_ptr
, info_ptr
);
5919 eassert (channels
== 3 || channels
== 4);
5921 /* Number of bytes needed for one row of the image. */
5922 row_bytes
= fn_png_get_rowbytes (png_ptr
, info_ptr
);
5924 /* Allocate memory for the image. */
5925 if (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *rows
< height
5926 || min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *pixels
/ height
< row_bytes
)
5927 memory_full (SIZE_MAX
);
5928 c
->pixels
= pixels
= xmalloc (sizeof *pixels
* row_bytes
* height
);
5929 c
->rows
= rows
= xmalloc (height
* sizeof *rows
);
5930 for (i
= 0; i
< height
; ++i
)
5931 rows
[i
] = pixels
+ i
* row_bytes
;
5933 /* Read the entire image. */
5934 fn_png_read_image (png_ptr
, rows
);
5935 fn_png_read_end (png_ptr
, info_ptr
);
5942 /* Create an image and pixmap serving as mask if the PNG image
5943 contains an alpha channel. */
5946 && !image_create_x_image_and_pixmap (f
, img
, width
, height
, 1,
5949 x_destroy_x_image (ximg
);
5950 x_clear_image_1 (f
, img
, CLEAR_IMAGE_PIXMAP
);
5954 /* Fill the X image and mask from PNG data. */
5955 init_color_table ();
5957 for (y
= 0; y
< height
; ++y
)
5959 png_byte
*p
= rows
[y
];
5961 for (x
= 0; x
< width
; ++x
)
5968 XPutPixel (ximg
, x
, y
, lookup_rgb_color (f
, r
, g
, b
));
5969 /* An alpha channel, aka mask channel, associates variable
5970 transparency with an image. Where other image formats
5971 support binary transparency---fully transparent or fully
5972 opaque---PNG allows up to 254 levels of partial transparency.
5973 The PNG library implements partial transparency by combining
5974 the image with a specified background color.
5976 I'm not sure how to handle this here nicely: because the
5977 background on which the image is displayed may change, for
5978 real alpha channel support, it would be necessary to create
5979 a new image for each possible background.
5981 What I'm doing now is that a mask is created if we have
5982 boolean transparency information. Otherwise I'm using
5983 the frame's background color to combine the image with. */
5988 XPutPixel (mask_img
, x
, y
, *p
> 0 ? PIX_MASK_DRAW
: PIX_MASK_RETAIN
);
5994 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
5995 /* Set IMG's background color from the PNG image, unless the user
5999 if (fn_png_get_bKGD (png_ptr
, info_ptr
, &bg
))
6001 img
->background
= lookup_rgb_color (f
, bg
->red
, bg
->green
, bg
->blue
);
6002 img
->background_valid
= 1;
6006 #ifdef COLOR_TABLE_SUPPORT
6007 /* Remember colors allocated for this image. */
6008 img
->colors
= colors_in_color_table (&img
->ncolors
);
6009 free_color_table ();
6010 #endif /* COLOR_TABLE_SUPPORT */
6013 fn_png_destroy_read_struct (&c
->png_ptr
, &c
->info_ptr
, &c
->end_info
);
6018 img
->height
= height
;
6020 /* Maybe fill in the background field while we have ximg handy.
6021 Casting avoids a GCC warning. */
6022 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
6024 /* Put ximg into the image. */
6025 image_put_x_image (f
, img
, ximg
, 0);
6027 /* Same for the mask. */
6030 /* Fill in the background_transparent field while we have the
6031 mask handy. Casting avoids a GCC warning. */
6032 image_background_transparent (img
, f
, (XImagePtr_or_DC
)mask_img
);
6034 image_put_x_image (f
, img
, mask_img
, 1);
6041 png_load (struct frame
*f
, struct image
*img
)
6043 struct png_load_context c
;
6044 return png_load_body (f
, img
, &c
);
6047 #else /* HAVE_PNG */
6051 png_load (struct frame
*f
, struct image
*img
)
6053 return ns_load_image (f
, img
,
6054 image_spec_value (img
->spec
, QCfile
, NULL
),
6055 image_spec_value (img
->spec
, QCdata
, NULL
));
6057 #endif /* HAVE_NS */
6060 #endif /* !HAVE_PNG */
6064 /***********************************************************************
6066 ***********************************************************************/
6068 #if defined (HAVE_JPEG) || defined (HAVE_NS)
6070 static bool jpeg_image_p (Lisp_Object object
);
6071 static bool jpeg_load (struct frame
*f
, struct image
*img
);
6073 /* The symbol `jpeg' identifying images of this type. */
6075 static Lisp_Object Qjpeg
;
6077 /* Indices of image specification fields in gs_format, below. */
6079 enum jpeg_keyword_index
6088 JPEG_HEURISTIC_MASK
,
6094 /* Vector of image_keyword structures describing the format
6095 of valid user-defined image specifications. */
6097 static const struct image_keyword jpeg_format
[JPEG_LAST
] =
6099 {":type", IMAGE_SYMBOL_VALUE
, 1},
6100 {":data", IMAGE_STRING_VALUE
, 0},
6101 {":file", IMAGE_STRING_VALUE
, 0},
6102 {":ascent", IMAGE_ASCENT_VALUE
, 0},
6103 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
6104 {":relief", IMAGE_INTEGER_VALUE
, 0},
6105 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6106 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6107 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6108 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
6111 #if defined HAVE_NTGUI && defined WINDOWSNT
6112 static bool init_jpeg_functions (void);
6114 #define init_jpeg_functions NULL
6117 /* Structure describing the image type `jpeg'. */
6119 static struct image_type jpeg_type
=
6125 init_jpeg_functions
,
6129 /* Return true if OBJECT is a valid JPEG image specification. */
6132 jpeg_image_p (Lisp_Object object
)
6134 struct image_keyword fmt
[JPEG_LAST
];
6136 memcpy (fmt
, jpeg_format
, sizeof fmt
);
6138 if (!parse_image_spec (object
, fmt
, JPEG_LAST
, Qjpeg
))
6141 /* Must specify either the :data or :file keyword. */
6142 return fmt
[JPEG_FILE
].count
+ fmt
[JPEG_DATA
].count
== 1;
6145 #endif /* HAVE_JPEG || HAVE_NS */
6149 /* Work around a warning about HAVE_STDLIB_H being redefined in
6151 #ifdef HAVE_STDLIB_H
6152 #undef HAVE_STDLIB_H
6153 #endif /* HAVE_STLIB_H */
6155 #if defined (HAVE_NTGUI) && !defined (__WIN32__)
6156 /* In older releases of the jpeg library, jpeglib.h will define boolean
6157 differently depending on __WIN32__, so make sure it is defined. */
6161 /* rpcndr.h (via windows.h) and jpeglib.h both define boolean types.
6162 Some versions of jpeglib try to detect whether rpcndr.h is loaded,
6163 using the Windows boolean type instead of the jpeglib boolean type
6164 if so. Cygwin jpeglib, however, doesn't try to detect whether its
6165 headers are included along with windows.h, so under Cygwin, jpeglib
6166 attempts to define a conflicting boolean type. Worse, forcing
6167 Cygwin jpeglib headers to use the Windows boolean type doesn't work
6168 because it created an ABI incompatibility between the
6169 already-compiled jpeg library and the header interface definition.
6171 The best we can do is to define jpeglib's boolean type to a
6172 different name. This name, jpeg_boolean, remains in effect through
6173 the rest of image.c.
6175 #if defined CYGWIN && defined HAVE_NTGUI
6176 #define boolean jpeg_boolean
6178 #include <jpeglib.h>
6183 /* JPEG library details. */
6184 DEF_IMGLIB_FN (void, jpeg_CreateDecompress
, (j_decompress_ptr
, int, size_t));
6185 DEF_IMGLIB_FN (boolean
, jpeg_start_decompress
, (j_decompress_ptr
));
6186 DEF_IMGLIB_FN (boolean
, jpeg_finish_decompress
, (j_decompress_ptr
));
6187 DEF_IMGLIB_FN (void, jpeg_destroy_decompress
, (j_decompress_ptr
));
6188 DEF_IMGLIB_FN (int, jpeg_read_header
, (j_decompress_ptr
, boolean
));
6189 DEF_IMGLIB_FN (JDIMENSION
, jpeg_read_scanlines
, (j_decompress_ptr
, JSAMPARRAY
, JDIMENSION
));
6190 DEF_IMGLIB_FN (struct jpeg_error_mgr
*, jpeg_std_error
, (struct jpeg_error_mgr
*));
6191 DEF_IMGLIB_FN (boolean
, jpeg_resync_to_restart
, (j_decompress_ptr
, int));
6194 init_jpeg_functions (void)
6198 if (!(library
= w32_delayed_load (Qjpeg
)))
6201 LOAD_IMGLIB_FN (library
, jpeg_finish_decompress
);
6202 LOAD_IMGLIB_FN (library
, jpeg_read_scanlines
);
6203 LOAD_IMGLIB_FN (library
, jpeg_start_decompress
);
6204 LOAD_IMGLIB_FN (library
, jpeg_read_header
);
6205 LOAD_IMGLIB_FN (library
, jpeg_CreateDecompress
);
6206 LOAD_IMGLIB_FN (library
, jpeg_destroy_decompress
);
6207 LOAD_IMGLIB_FN (library
, jpeg_std_error
);
6208 LOAD_IMGLIB_FN (library
, jpeg_resync_to_restart
);
6212 /* Wrapper since we can't directly assign the function pointer
6213 to another function pointer that was declared more completely easily. */
6215 jpeg_resync_to_restart_wrapper (j_decompress_ptr cinfo
, int desired
)
6217 return fn_jpeg_resync_to_restart (cinfo
, desired
);
6222 #define fn_jpeg_CreateDecompress(a,b,c) jpeg_create_decompress (a)
6223 #define fn_jpeg_start_decompress jpeg_start_decompress
6224 #define fn_jpeg_finish_decompress jpeg_finish_decompress
6225 #define fn_jpeg_destroy_decompress jpeg_destroy_decompress
6226 #define fn_jpeg_read_header jpeg_read_header
6227 #define fn_jpeg_read_scanlines jpeg_read_scanlines
6228 #define fn_jpeg_std_error jpeg_std_error
6229 #define jpeg_resync_to_restart_wrapper jpeg_resync_to_restart
6231 #endif /* WINDOWSNT */
6233 struct my_jpeg_error_mgr
6235 struct jpeg_error_mgr pub
;
6236 sys_jmp_buf setjmp_buffer
;
6238 /* The remaining members are so that longjmp doesn't munge local
6240 struct jpeg_decompress_struct cinfo
;
6244 MY_JPEG_INVALID_IMAGE_SIZE
,
6245 MY_JPEG_CANNOT_CREATE_X
6253 static _Noreturn
void
6254 my_error_exit (j_common_ptr cinfo
)
6256 struct my_jpeg_error_mgr
*mgr
= (struct my_jpeg_error_mgr
*) cinfo
->err
;
6257 mgr
->failure_code
= MY_JPEG_ERROR_EXIT
;
6258 sys_longjmp (mgr
->setjmp_buffer
, 1);
6262 /* Init source method for JPEG data source manager. Called by
6263 jpeg_read_header() before any data is actually read. See
6264 libjpeg.doc from the JPEG lib distribution. */
6267 our_common_init_source (j_decompress_ptr cinfo
)
6272 /* Method to terminate data source. Called by
6273 jpeg_finish_decompress() after all data has been processed. */
6276 our_common_term_source (j_decompress_ptr cinfo
)
6281 /* Fill input buffer method for JPEG data source manager. Called
6282 whenever more data is needed. We read the whole image in one step,
6283 so this only adds a fake end of input marker at the end. */
6285 static JOCTET our_memory_buffer
[2];
6288 our_memory_fill_input_buffer (j_decompress_ptr cinfo
)
6290 /* Insert a fake EOI marker. */
6291 struct jpeg_source_mgr
*src
= cinfo
->src
;
6293 our_memory_buffer
[0] = (JOCTET
) 0xFF;
6294 our_memory_buffer
[1] = (JOCTET
) JPEG_EOI
;
6296 src
->next_input_byte
= our_memory_buffer
;
6297 src
->bytes_in_buffer
= 2;
6302 /* Method to skip over NUM_BYTES bytes in the image data. CINFO->src
6303 is the JPEG data source manager. */
6306 our_memory_skip_input_data (j_decompress_ptr cinfo
, long int num_bytes
)
6308 struct jpeg_source_mgr
*src
= cinfo
->src
;
6312 if (num_bytes
> src
->bytes_in_buffer
)
6313 ERREXIT (cinfo
, JERR_INPUT_EOF
);
6315 src
->bytes_in_buffer
-= num_bytes
;
6316 src
->next_input_byte
+= num_bytes
;
6321 /* Set up the JPEG lib for reading an image from DATA which contains
6322 LEN bytes. CINFO is the decompression info structure created for
6323 reading the image. */
6326 jpeg_memory_src (j_decompress_ptr cinfo
, JOCTET
*data
, ptrdiff_t len
)
6328 struct jpeg_source_mgr
*src
= cinfo
->src
;
6332 /* First time for this JPEG object? */
6333 src
= cinfo
->mem
->alloc_small ((j_common_ptr
) cinfo
,
6334 JPOOL_PERMANENT
, sizeof *src
);
6336 src
->next_input_byte
= data
;
6339 src
->init_source
= our_common_init_source
;
6340 src
->fill_input_buffer
= our_memory_fill_input_buffer
;
6341 src
->skip_input_data
= our_memory_skip_input_data
;
6342 src
->resync_to_restart
= jpeg_resync_to_restart_wrapper
; /* Use default method. */
6343 src
->term_source
= our_common_term_source
;
6344 src
->bytes_in_buffer
= len
;
6345 src
->next_input_byte
= data
;
6349 struct jpeg_stdio_mgr
6351 struct jpeg_source_mgr mgr
;
6358 /* Size of buffer to read JPEG from file.
6359 Not too big, as we want to use alloc_small. */
6360 #define JPEG_STDIO_BUFFER_SIZE 8192
6363 /* Fill input buffer method for JPEG data source manager. Called
6364 whenever more data is needed. The data is read from a FILE *. */
6367 our_stdio_fill_input_buffer (j_decompress_ptr cinfo
)
6369 struct jpeg_stdio_mgr
*src
;
6371 src
= (struct jpeg_stdio_mgr
*) cinfo
->src
;
6376 bytes
= fread (src
->buffer
, 1, JPEG_STDIO_BUFFER_SIZE
, src
->file
);
6378 src
->mgr
.bytes_in_buffer
= bytes
;
6381 WARNMS (cinfo
, JWRN_JPEG_EOF
);
6383 src
->buffer
[0] = (JOCTET
) 0xFF;
6384 src
->buffer
[1] = (JOCTET
) JPEG_EOI
;
6385 src
->mgr
.bytes_in_buffer
= 2;
6387 src
->mgr
.next_input_byte
= src
->buffer
;
6394 /* Method to skip over NUM_BYTES bytes in the image data. CINFO->src
6395 is the JPEG data source manager. */
6398 our_stdio_skip_input_data (j_decompress_ptr cinfo
, long int num_bytes
)
6400 struct jpeg_stdio_mgr
*src
;
6401 src
= (struct jpeg_stdio_mgr
*) cinfo
->src
;
6403 while (num_bytes
> 0 && !src
->finished
)
6405 if (num_bytes
<= src
->mgr
.bytes_in_buffer
)
6407 src
->mgr
.bytes_in_buffer
-= num_bytes
;
6408 src
->mgr
.next_input_byte
+= num_bytes
;
6413 num_bytes
-= src
->mgr
.bytes_in_buffer
;
6414 src
->mgr
.bytes_in_buffer
= 0;
6415 src
->mgr
.next_input_byte
= NULL
;
6417 our_stdio_fill_input_buffer (cinfo
);
6423 /* Set up the JPEG lib for reading an image from a FILE *.
6424 CINFO is the decompression info structure created for
6425 reading the image. */
6428 jpeg_file_src (j_decompress_ptr cinfo
, FILE *fp
)
6430 struct jpeg_stdio_mgr
*src
= (struct jpeg_stdio_mgr
*) cinfo
->src
;
6434 /* First time for this JPEG object? */
6435 src
= cinfo
->mem
->alloc_small ((j_common_ptr
) cinfo
,
6436 JPOOL_PERMANENT
, sizeof *src
);
6437 cinfo
->src
= (struct jpeg_source_mgr
*) src
;
6438 src
->buffer
= cinfo
->mem
->alloc_small ((j_common_ptr
) cinfo
,
6440 JPEG_STDIO_BUFFER_SIZE
);
6445 src
->mgr
.init_source
= our_common_init_source
;
6446 src
->mgr
.fill_input_buffer
= our_stdio_fill_input_buffer
;
6447 src
->mgr
.skip_input_data
= our_stdio_skip_input_data
;
6448 src
->mgr
.resync_to_restart
= jpeg_resync_to_restart_wrapper
; /* Use default method. */
6449 src
->mgr
.term_source
= our_common_term_source
;
6450 src
->mgr
.bytes_in_buffer
= 0;
6451 src
->mgr
.next_input_byte
= NULL
;
6455 /* Load image IMG for use on frame F. Patterned after example.c
6456 from the JPEG lib. */
6459 jpeg_load_body (struct frame
*f
, struct image
*img
,
6460 struct my_jpeg_error_mgr
*mgr
)
6462 Lisp_Object file
, specified_file
;
6463 Lisp_Object specified_data
;
6466 int row_stride
, x
, y
;
6467 XImagePtr ximg
= NULL
;
6468 unsigned long *colors
;
6471 /* Open the JPEG file. */
6472 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
6473 specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
6475 if (NILP (specified_data
))
6477 file
= x_find_image_file (specified_file
);
6478 if (!STRINGP (file
))
6480 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
6484 fp
= emacs_fopen (SSDATA (file
), "rb");
6487 image_error ("Cannot open `%s'", file
, Qnil
);
6491 else if (!STRINGP (specified_data
))
6493 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
6497 IF_LINT (mgr
->fp
= fp
);
6499 /* Customize libjpeg's error handling to call my_error_exit when an
6500 error is detected. This function will perform a longjmp. */
6501 mgr
->cinfo
.err
= fn_jpeg_std_error (&mgr
->pub
);
6502 mgr
->pub
.error_exit
= my_error_exit
;
6503 if (sys_setjmp (mgr
->setjmp_buffer
))
6505 switch (mgr
->failure_code
)
6507 case MY_JPEG_ERROR_EXIT
:
6509 char buf
[JMSG_LENGTH_MAX
];
6510 mgr
->cinfo
.err
->format_message ((j_common_ptr
) &mgr
->cinfo
, buf
);
6511 image_error ("Error reading JPEG image `%s': %s", img
->spec
,
6512 build_string (buf
));
6516 case MY_JPEG_INVALID_IMAGE_SIZE
:
6517 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
6520 case MY_JPEG_CANNOT_CREATE_X
:
6524 /* Close the input file and destroy the JPEG object. */
6527 fn_jpeg_destroy_decompress (&mgr
->cinfo
);
6529 /* If we already have an XImage, free that. */
6530 x_destroy_x_image (ximg
);
6532 /* Free pixmap and colors. */
6533 x_clear_image (f
, img
);
6537 /* Silence a bogus diagnostic; see GCC bug 54561. */
6538 IF_LINT (fp
= mgr
->fp
);
6540 /* Create the JPEG decompression object. Let it read from fp.
6541 Read the JPEG image header. */
6542 fn_jpeg_CreateDecompress (&mgr
->cinfo
, JPEG_LIB_VERSION
, sizeof *&mgr
->cinfo
);
6544 if (NILP (specified_data
))
6545 jpeg_file_src (&mgr
->cinfo
, fp
);
6547 jpeg_memory_src (&mgr
->cinfo
, SDATA (specified_data
),
6548 SBYTES (specified_data
));
6550 fn_jpeg_read_header (&mgr
->cinfo
, 1);
6552 /* Customize decompression so that color quantization will be used.
6553 Start decompression. */
6554 mgr
->cinfo
.quantize_colors
= 1;
6555 fn_jpeg_start_decompress (&mgr
->cinfo
);
6556 width
= img
->width
= mgr
->cinfo
.output_width
;
6557 height
= img
->height
= mgr
->cinfo
.output_height
;
6559 if (!check_image_size (f
, width
, height
))
6561 mgr
->failure_code
= MY_JPEG_INVALID_IMAGE_SIZE
;
6562 sys_longjmp (mgr
->setjmp_buffer
, 1);
6565 /* Create X image and pixmap. */
6566 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, 0, &ximg
, 0))
6568 mgr
->failure_code
= MY_JPEG_CANNOT_CREATE_X
;
6569 sys_longjmp (mgr
->setjmp_buffer
, 1);
6572 /* Allocate colors. When color quantization is used,
6573 mgr->cinfo.actual_number_of_colors has been set with the number of
6574 colors generated, and mgr->cinfo.colormap is a two-dimensional array
6575 of color indices in the range 0..mgr->cinfo.actual_number_of_colors.
6576 No more than 255 colors will be generated. */
6580 if (mgr
->cinfo
.out_color_components
> 2)
6581 ir
= 0, ig
= 1, ib
= 2;
6582 else if (mgr
->cinfo
.out_color_components
> 1)
6583 ir
= 0, ig
= 1, ib
= 0;
6585 ir
= 0, ig
= 0, ib
= 0;
6587 /* Use the color table mechanism because it handles colors that
6588 cannot be allocated nicely. Such colors will be replaced with
6589 a default color, and we don't have to care about which colors
6590 can be freed safely, and which can't. */
6591 init_color_table ();
6592 colors
= alloca (mgr
->cinfo
.actual_number_of_colors
* sizeof *colors
);
6594 for (i
= 0; i
< mgr
->cinfo
.actual_number_of_colors
; ++i
)
6596 /* Multiply RGB values with 255 because X expects RGB values
6597 in the range 0..0xffff. */
6598 int r
= mgr
->cinfo
.colormap
[ir
][i
] << 8;
6599 int g
= mgr
->cinfo
.colormap
[ig
][i
] << 8;
6600 int b
= mgr
->cinfo
.colormap
[ib
][i
] << 8;
6601 colors
[i
] = lookup_rgb_color (f
, r
, g
, b
);
6604 #ifdef COLOR_TABLE_SUPPORT
6605 /* Remember those colors actually allocated. */
6606 img
->colors
= colors_in_color_table (&img
->ncolors
);
6607 free_color_table ();
6608 #endif /* COLOR_TABLE_SUPPORT */
6612 row_stride
= width
* mgr
->cinfo
.output_components
;
6613 buffer
= mgr
->cinfo
.mem
->alloc_sarray ((j_common_ptr
) &mgr
->cinfo
,
6614 JPOOL_IMAGE
, row_stride
, 1);
6615 for (y
= 0; y
< height
; ++y
)
6617 fn_jpeg_read_scanlines (&mgr
->cinfo
, buffer
, 1);
6618 for (x
= 0; x
< mgr
->cinfo
.output_width
; ++x
)
6619 XPutPixel (ximg
, x
, y
, colors
[buffer
[0][x
]]);
6623 fn_jpeg_finish_decompress (&mgr
->cinfo
);
6624 fn_jpeg_destroy_decompress (&mgr
->cinfo
);
6628 /* Maybe fill in the background field while we have ximg handy. */
6629 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
6630 /* Casting avoids a GCC warning. */
6631 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
6633 /* Put ximg into the image. */
6634 image_put_x_image (f
, img
, ximg
, 0);
6639 jpeg_load (struct frame
*f
, struct image
*img
)
6641 struct my_jpeg_error_mgr mgr
;
6642 return jpeg_load_body (f
, img
, &mgr
);
6645 #else /* HAVE_JPEG */
6649 jpeg_load (struct frame
*f
, struct image
*img
)
6651 return ns_load_image (f
, img
,
6652 image_spec_value (img
->spec
, QCfile
, NULL
),
6653 image_spec_value (img
->spec
, QCdata
, NULL
));
6655 #endif /* HAVE_NS */
6657 #endif /* !HAVE_JPEG */
6661 /***********************************************************************
6663 ***********************************************************************/
6665 #if defined (HAVE_TIFF) || defined (HAVE_NS)
6667 static bool tiff_image_p (Lisp_Object object
);
6668 static bool tiff_load (struct frame
*f
, struct image
*img
);
6670 /* The symbol `tiff' identifying images of this type. */
6672 static Lisp_Object Qtiff
;
6674 /* Indices of image specification fields in tiff_format, below. */
6676 enum tiff_keyword_index
6685 TIFF_HEURISTIC_MASK
,
6692 /* Vector of image_keyword structures describing the format
6693 of valid user-defined image specifications. */
6695 static const struct image_keyword tiff_format
[TIFF_LAST
] =
6697 {":type", IMAGE_SYMBOL_VALUE
, 1},
6698 {":data", IMAGE_STRING_VALUE
, 0},
6699 {":file", IMAGE_STRING_VALUE
, 0},
6700 {":ascent", IMAGE_ASCENT_VALUE
, 0},
6701 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
6702 {":relief", IMAGE_INTEGER_VALUE
, 0},
6703 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6704 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6705 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6706 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0},
6707 {":index", IMAGE_NON_NEGATIVE_INTEGER_VALUE
, 0}
6710 #if defined HAVE_NTGUI && defined WINDOWSNT
6711 static bool init_tiff_functions (void);
6713 #define init_tiff_functions NULL
6716 /* Structure describing the image type `tiff'. */
6718 static struct image_type tiff_type
=
6724 init_tiff_functions
,
6728 /* Return true if OBJECT is a valid TIFF image specification. */
6731 tiff_image_p (Lisp_Object object
)
6733 struct image_keyword fmt
[TIFF_LAST
];
6734 memcpy (fmt
, tiff_format
, sizeof fmt
);
6736 if (!parse_image_spec (object
, fmt
, TIFF_LAST
, Qtiff
))
6739 /* Must specify either the :data or :file keyword. */
6740 return fmt
[TIFF_FILE
].count
+ fmt
[TIFF_DATA
].count
== 1;
6743 #endif /* HAVE_TIFF || HAVE_NS */
6751 /* TIFF library details. */
6752 DEF_IMGLIB_FN (TIFFErrorHandler
, TIFFSetErrorHandler
, (TIFFErrorHandler
));
6753 DEF_IMGLIB_FN (TIFFErrorHandler
, TIFFSetWarningHandler
, (TIFFErrorHandler
));
6754 DEF_IMGLIB_FN (TIFF
*, TIFFOpen
, (const char *, const char *));
6755 DEF_IMGLIB_FN (TIFF
*, TIFFClientOpen
, (const char *, const char *, thandle_t
,
6756 TIFFReadWriteProc
, TIFFReadWriteProc
,
6757 TIFFSeekProc
, TIFFCloseProc
, TIFFSizeProc
,
6758 TIFFMapFileProc
, TIFFUnmapFileProc
));
6759 DEF_IMGLIB_FN (int, TIFFGetField
, (TIFF
*, ttag_t
, ...));
6760 DEF_IMGLIB_FN (int, TIFFReadRGBAImage
, (TIFF
*, uint32
, uint32
, uint32
*, int));
6761 DEF_IMGLIB_FN (void, TIFFClose
, (TIFF
*));
6762 DEF_IMGLIB_FN (int, TIFFSetDirectory
, (TIFF
*, tdir_t
));
6765 init_tiff_functions (void)
6769 if (!(library
= w32_delayed_load (Qtiff
)))
6772 LOAD_IMGLIB_FN (library
, TIFFSetErrorHandler
);
6773 LOAD_IMGLIB_FN (library
, TIFFSetWarningHandler
);
6774 LOAD_IMGLIB_FN (library
, TIFFOpen
);
6775 LOAD_IMGLIB_FN (library
, TIFFClientOpen
);
6776 LOAD_IMGLIB_FN (library
, TIFFGetField
);
6777 LOAD_IMGLIB_FN (library
, TIFFReadRGBAImage
);
6778 LOAD_IMGLIB_FN (library
, TIFFClose
);
6779 LOAD_IMGLIB_FN (library
, TIFFSetDirectory
);
6785 #define fn_TIFFSetErrorHandler TIFFSetErrorHandler
6786 #define fn_TIFFSetWarningHandler TIFFSetWarningHandler
6787 #define fn_TIFFOpen TIFFOpen
6788 #define fn_TIFFClientOpen TIFFClientOpen
6789 #define fn_TIFFGetField TIFFGetField
6790 #define fn_TIFFReadRGBAImage TIFFReadRGBAImage
6791 #define fn_TIFFClose TIFFClose
6792 #define fn_TIFFSetDirectory TIFFSetDirectory
6793 #endif /* WINDOWSNT */
6796 /* Reading from a memory buffer for TIFF images Based on the PNG
6797 memory source, but we have to provide a lot of extra functions.
6800 We really only need to implement read and seek, but I am not
6801 convinced that the TIFF library is smart enough not to destroy
6802 itself if we only hand it the function pointers we need to
6807 unsigned char *bytes
;
6814 tiff_read_from_memory (thandle_t data
, tdata_t buf
, tsize_t size
)
6816 tiff_memory_source
*src
= (tiff_memory_source
*) data
;
6818 size
= min (size
, src
->len
- src
->index
);
6819 memcpy (buf
, src
->bytes
+ src
->index
, size
);
6825 tiff_write_from_memory (thandle_t data
, tdata_t buf
, tsize_t size
)
6831 tiff_seek_in_memory (thandle_t data
, toff_t off
, int whence
)
6833 tiff_memory_source
*src
= (tiff_memory_source
*) data
;
6838 case SEEK_SET
: /* Go from beginning of source. */
6842 case SEEK_END
: /* Go from end of source. */
6843 idx
= src
->len
+ off
;
6846 case SEEK_CUR
: /* Go from current position. */
6847 idx
= src
->index
+ off
;
6850 default: /* Invalid `whence'. */
6854 if (idx
> src
->len
|| idx
< 0)
6862 tiff_close_memory (thandle_t data
)
6869 tiff_mmap_memory (thandle_t data
, tdata_t
*pbase
, toff_t
*psize
)
6871 /* It is already _IN_ memory. */
6876 tiff_unmap_memory (thandle_t data
, tdata_t base
, toff_t size
)
6878 /* We don't need to do this. */
6882 tiff_size_of_memory (thandle_t data
)
6884 return ((tiff_memory_source
*) data
)->len
;
6887 /* GCC 3.x on x86 Windows targets has a bug that triggers an internal
6888 compiler error compiling tiff_handler, see Bugzilla bug #17406
6889 (http://gcc.gnu.org/bugzilla/show_bug.cgi?id=17406). Declaring
6890 this function as external works around that problem. */
6891 #if defined (__MINGW32__) && __GNUC__ == 3
6892 # define MINGW_STATIC
6894 # define MINGW_STATIC static
6898 tiff_handler (const char *, const char *, const char *, va_list)
6899 ATTRIBUTE_FORMAT_PRINTF (3, 0);
6901 tiff_handler (const char *log_format
, const char *title
,
6902 const char *format
, va_list ap
)
6904 /* doprnt is not suitable here, as TIFF handlers are called from
6905 libtiff and are passed arbitrary printf directives. Instead, use
6906 vsnprintf, taking care to be portable to nonstandard environments
6907 where vsnprintf returns -1 on buffer overflow. Since it's just a
6908 log entry, it's OK to truncate it. */
6910 int len
= vsnprintf (buf
, sizeof buf
, format
, ap
);
6911 add_to_log (log_format
, build_string (title
),
6912 make_string (buf
, max (0, min (len
, sizeof buf
- 1))));
6916 static void tiff_error_handler (const char *, const char *, va_list)
6917 ATTRIBUTE_FORMAT_PRINTF (2, 0);
6919 tiff_error_handler (const char *title
, const char *format
, va_list ap
)
6921 tiff_handler ("TIFF error: %s %s", title
, format
, ap
);
6925 static void tiff_warning_handler (const char *, const char *, va_list)
6926 ATTRIBUTE_FORMAT_PRINTF (2, 0);
6928 tiff_warning_handler (const char *title
, const char *format
, va_list ap
)
6930 tiff_handler ("TIFF warning: %s %s", title
, format
, ap
);
6934 /* Load TIFF image IMG for use on frame F. Value is true if
6938 tiff_load (struct frame
*f
, struct image
*img
)
6940 Lisp_Object file
, specified_file
;
6941 Lisp_Object specified_data
;
6943 int width
, height
, x
, y
, count
;
6947 tiff_memory_source memsrc
;
6950 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
6951 specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
6953 fn_TIFFSetErrorHandler ((TIFFErrorHandler
) tiff_error_handler
);
6954 fn_TIFFSetWarningHandler ((TIFFErrorHandler
) tiff_warning_handler
);
6956 if (NILP (specified_data
))
6958 /* Read from a file */
6959 file
= x_find_image_file (specified_file
);
6960 if (!STRINGP (file
))
6962 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
6966 /* Try to open the image file. */
6967 tiff
= fn_TIFFOpen (SSDATA (file
), "r");
6970 image_error ("Cannot open `%s'", file
, Qnil
);
6976 if (!STRINGP (specified_data
))
6978 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
6982 /* Memory source! */
6983 memsrc
.bytes
= SDATA (specified_data
);
6984 memsrc
.len
= SBYTES (specified_data
);
6987 tiff
= fn_TIFFClientOpen ("memory_source", "r", (thandle_t
)&memsrc
,
6988 tiff_read_from_memory
,
6989 tiff_write_from_memory
,
6990 tiff_seek_in_memory
,
6992 tiff_size_of_memory
,
6998 image_error ("Cannot open memory source for `%s'", img
->spec
, Qnil
);
7003 image
= image_spec_value (img
->spec
, QCindex
, NULL
);
7004 if (INTEGERP (image
))
7006 EMACS_INT ino
= XFASTINT (image
);
7007 if (! (TYPE_MINIMUM (tdir_t
) <= ino
&& ino
<= TYPE_MAXIMUM (tdir_t
)
7008 && fn_TIFFSetDirectory (tiff
, ino
)))
7010 image_error ("Invalid image number `%s' in image `%s'",
7012 fn_TIFFClose (tiff
);
7017 /* Get width and height of the image, and allocate a raster buffer
7018 of width x height 32-bit values. */
7019 fn_TIFFGetField (tiff
, TIFFTAG_IMAGEWIDTH
, &width
);
7020 fn_TIFFGetField (tiff
, TIFFTAG_IMAGELENGTH
, &height
);
7022 if (!check_image_size (f
, width
, height
))
7024 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
7025 fn_TIFFClose (tiff
);
7029 /* Create the X image and pixmap. */
7030 if (! (height
<= min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *buf
/ width
7031 && image_create_x_image_and_pixmap (f
, img
, width
, height
, 0,
7034 fn_TIFFClose (tiff
);
7038 buf
= xmalloc (sizeof *buf
* width
* height
);
7040 rc
= fn_TIFFReadRGBAImage (tiff
, width
, height
, buf
, 0);
7042 /* Count the number of images in the file. */
7043 for (count
= 1; fn_TIFFSetDirectory (tiff
, count
); count
++)
7047 img
->lisp_data
= Fcons (Qcount
,
7048 Fcons (make_number (count
),
7051 fn_TIFFClose (tiff
);
7054 image_error ("Error reading TIFF image `%s'", img
->spec
, Qnil
);
7059 /* Initialize the color table. */
7060 init_color_table ();
7062 /* Process the pixel raster. Origin is in the lower-left corner. */
7063 for (y
= 0; y
< height
; ++y
)
7065 uint32
*row
= buf
+ y
* width
;
7067 for (x
= 0; x
< width
; ++x
)
7069 uint32 abgr
= row
[x
];
7070 int r
= TIFFGetR (abgr
) << 8;
7071 int g
= TIFFGetG (abgr
) << 8;
7072 int b
= TIFFGetB (abgr
) << 8;
7073 XPutPixel (ximg
, x
, height
- 1 - y
, lookup_rgb_color (f
, r
, g
, b
));
7077 #ifdef COLOR_TABLE_SUPPORT
7078 /* Remember the colors allocated for the image. Free the color table. */
7079 img
->colors
= colors_in_color_table (&img
->ncolors
);
7080 free_color_table ();
7081 #endif /* COLOR_TABLE_SUPPORT */
7084 img
->height
= height
;
7086 /* Maybe fill in the background field while we have ximg handy. */
7087 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
7088 /* Casting avoids a GCC warning on W32. */
7089 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
7091 /* Put ximg into the image. */
7092 image_put_x_image (f
, img
, ximg
, 0);
7098 #else /* HAVE_TIFF */
7102 tiff_load (struct frame
*f
, struct image
*img
)
7104 return ns_load_image (f
, img
,
7105 image_spec_value (img
->spec
, QCfile
, NULL
),
7106 image_spec_value (img
->spec
, QCdata
, NULL
));
7108 #endif /* HAVE_NS */
7110 #endif /* !HAVE_TIFF */
7114 /***********************************************************************
7116 ***********************************************************************/
7118 #if defined (HAVE_GIF) || defined (HAVE_NS)
7120 static bool gif_image_p (Lisp_Object object
);
7121 static bool gif_load (struct frame
*f
, struct image
*img
);
7122 static void gif_clear_image (struct frame
*f
, struct image
*img
);
7124 /* The symbol `gif' identifying images of this type. */
7126 static Lisp_Object Qgif
;
7128 /* Indices of image specification fields in gif_format, below. */
7130 enum gif_keyword_index
7146 /* Vector of image_keyword structures describing the format
7147 of valid user-defined image specifications. */
7149 static const struct image_keyword gif_format
[GIF_LAST
] =
7151 {":type", IMAGE_SYMBOL_VALUE
, 1},
7152 {":data", IMAGE_STRING_VALUE
, 0},
7153 {":file", IMAGE_STRING_VALUE
, 0},
7154 {":ascent", IMAGE_ASCENT_VALUE
, 0},
7155 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
7156 {":relief", IMAGE_INTEGER_VALUE
, 0},
7157 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7158 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7159 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7160 {":index", IMAGE_NON_NEGATIVE_INTEGER_VALUE
, 0},
7161 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
7164 #if defined HAVE_NTGUI && defined WINDOWSNT
7165 static bool init_gif_functions (void);
7167 #define init_gif_functions NULL
7170 /* Structure describing the image type `gif'. */
7172 static struct image_type gif_type
=
7182 /* Free X resources of GIF image IMG which is used on frame F. */
7185 gif_clear_image (struct frame
*f
, struct image
*img
)
7187 img
->lisp_data
= Qnil
;
7188 x_clear_image (f
, img
);
7191 /* Return true if OBJECT is a valid GIF image specification. */
7194 gif_image_p (Lisp_Object object
)
7196 struct image_keyword fmt
[GIF_LAST
];
7197 memcpy (fmt
, gif_format
, sizeof fmt
);
7199 if (!parse_image_spec (object
, fmt
, GIF_LAST
, Qgif
))
7202 /* Must specify either the :data or :file keyword. */
7203 return fmt
[GIF_FILE
].count
+ fmt
[GIF_DATA
].count
== 1;
7206 #endif /* HAVE_GIF */
7210 #if defined (HAVE_NTGUI)
7211 /* winuser.h might define DrawText to DrawTextA or DrawTextW.
7212 Undefine before redefining to avoid a preprocessor warning. */
7216 /* avoid conflict with QuickdrawText.h */
7217 #define DrawText gif_DrawText
7218 #include <gif_lib.h>
7221 #else /* HAVE_NTGUI */
7223 #include <gif_lib.h>
7225 #endif /* HAVE_NTGUI */
7230 /* GIF library details. */
7231 DEF_IMGLIB_FN (int, DGifCloseFile
, (GifFileType
*));
7232 DEF_IMGLIB_FN (int, DGifSlurp
, (GifFileType
*));
7233 DEF_IMGLIB_FN (GifFileType
*, DGifOpen
, (void *, InputFunc
));
7234 DEF_IMGLIB_FN (GifFileType
*, DGifOpenFileName
, (const char *));
7237 init_gif_functions (void)
7241 if (!(library
= w32_delayed_load (Qgif
)))
7244 LOAD_IMGLIB_FN (library
, DGifCloseFile
);
7245 LOAD_IMGLIB_FN (library
, DGifSlurp
);
7246 LOAD_IMGLIB_FN (library
, DGifOpen
);
7247 LOAD_IMGLIB_FN (library
, DGifOpenFileName
);
7253 #define fn_DGifCloseFile DGifCloseFile
7254 #define fn_DGifSlurp DGifSlurp
7255 #define fn_DGifOpen DGifOpen
7256 #define fn_DGifOpenFileName DGifOpenFileName
7258 #endif /* WINDOWSNT */
7260 /* Reading a GIF image from memory
7261 Based on the PNG memory stuff to a certain extent. */
7265 unsigned char *bytes
;
7271 /* Make the current memory source available to gif_read_from_memory.
7272 It's done this way because not all versions of libungif support
7273 a UserData field in the GifFileType structure. */
7274 static gif_memory_source
*current_gif_memory_src
;
7277 gif_read_from_memory (GifFileType
*file
, GifByteType
*buf
, int len
)
7279 gif_memory_source
*src
= current_gif_memory_src
;
7281 if (len
> src
->len
- src
->index
)
7284 memcpy (buf
, src
->bytes
+ src
->index
, len
);
7290 /* Load GIF image IMG for use on frame F. Value is true if
7293 static const int interlace_start
[] = {0, 4, 2, 1};
7294 static const int interlace_increment
[] = {8, 8, 4, 2};
7296 #define GIF_LOCAL_DESCRIPTOR_EXTENSION 249
7299 gif_load (struct frame
*f
, struct image
*img
)
7302 int rc
, width
, height
, x
, y
, i
, j
;
7304 ColorMapObject
*gif_color_map
;
7305 unsigned long pixel_colors
[256];
7307 gif_memory_source memsrc
;
7308 Lisp_Object specified_bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
7309 Lisp_Object specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
7310 Lisp_Object specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
7311 unsigned long bgcolor
= 0;
7314 if (NILP (specified_data
))
7316 file
= x_find_image_file (specified_file
);
7317 if (!STRINGP (file
))
7319 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
7323 /* Open the GIF file. */
7324 gif
= fn_DGifOpenFileName (SSDATA (file
));
7327 image_error ("Cannot open `%s'", file
, Qnil
);
7333 if (!STRINGP (specified_data
))
7335 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
7339 /* Read from memory! */
7340 current_gif_memory_src
= &memsrc
;
7341 memsrc
.bytes
= SDATA (specified_data
);
7342 memsrc
.len
= SBYTES (specified_data
);
7345 gif
= fn_DGifOpen (&memsrc
, gif_read_from_memory
);
7348 image_error ("Cannot open memory source `%s'", img
->spec
, Qnil
);
7353 /* Before reading entire contents, check the declared image size. */
7354 if (!check_image_size (f
, gif
->SWidth
, gif
->SHeight
))
7356 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
7357 fn_DGifCloseFile (gif
);
7361 /* Read entire contents. */
7362 rc
= fn_DGifSlurp (gif
);
7363 if (rc
== GIF_ERROR
|| gif
->ImageCount
<= 0)
7365 image_error ("Error reading `%s'", img
->spec
, Qnil
);
7366 fn_DGifCloseFile (gif
);
7370 /* Which sub-image are we to display? */
7372 Lisp_Object image_number
= image_spec_value (img
->spec
, QCindex
, NULL
);
7373 idx
= INTEGERP (image_number
) ? XFASTINT (image_number
) : 0;
7374 if (idx
< 0 || idx
>= gif
->ImageCount
)
7376 image_error ("Invalid image number `%s' in image `%s'",
7377 image_number
, img
->spec
);
7378 fn_DGifCloseFile (gif
);
7383 width
= img
->width
= gif
->SWidth
;
7384 height
= img
->height
= gif
->SHeight
;
7386 img
->corners
[TOP_CORNER
] = gif
->SavedImages
[0].ImageDesc
.Top
;
7387 img
->corners
[LEFT_CORNER
] = gif
->SavedImages
[0].ImageDesc
.Left
;
7388 img
->corners
[BOT_CORNER
]
7389 = img
->corners
[TOP_CORNER
] + gif
->SavedImages
[0].ImageDesc
.Height
;
7390 img
->corners
[RIGHT_CORNER
]
7391 = img
->corners
[LEFT_CORNER
] + gif
->SavedImages
[0].ImageDesc
.Width
;
7393 if (!check_image_size (f
, width
, height
))
7395 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
7396 fn_DGifCloseFile (gif
);
7400 /* Check that the selected subimages fit. It's not clear whether
7401 the GIF spec requires this, but Emacs can crash if they don't fit. */
7402 for (j
= 0; j
<= idx
; ++j
)
7404 struct SavedImage
*subimage
= gif
->SavedImages
+ j
;
7405 int subimg_width
= subimage
->ImageDesc
.Width
;
7406 int subimg_height
= subimage
->ImageDesc
.Height
;
7407 int subimg_top
= subimage
->ImageDesc
.Top
;
7408 int subimg_left
= subimage
->ImageDesc
.Left
;
7409 if (! (0 <= subimg_width
&& 0 <= subimg_height
7410 && 0 <= subimg_top
&& subimg_top
<= height
- subimg_height
7411 && 0 <= subimg_left
&& subimg_left
<= width
- subimg_width
))
7413 image_error ("Subimage does not fit in image", Qnil
, Qnil
);
7414 fn_DGifCloseFile (gif
);
7419 /* Create the X image and pixmap. */
7420 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, 0, &ximg
, 0))
7422 fn_DGifCloseFile (gif
);
7426 /* Clear the part of the screen image not covered by the image.
7427 Full animated GIF support requires more here (see the gif89 spec,
7428 disposal methods). Let's simply assume that the part not covered
7429 by a sub-image is in the frame's background color. */
7430 for (y
= 0; y
< img
->corners
[TOP_CORNER
]; ++y
)
7431 for (x
= 0; x
< width
; ++x
)
7432 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7434 for (y
= img
->corners
[BOT_CORNER
]; y
< height
; ++y
)
7435 for (x
= 0; x
< width
; ++x
)
7436 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7438 for (y
= img
->corners
[TOP_CORNER
]; y
< img
->corners
[BOT_CORNER
]; ++y
)
7440 for (x
= 0; x
< img
->corners
[LEFT_CORNER
]; ++x
)
7441 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7442 for (x
= img
->corners
[RIGHT_CORNER
]; x
< width
; ++x
)
7443 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7446 /* Read the GIF image into the X image. */
7448 /* FIXME: With the current implementation, loading an animated gif
7449 is quadratic in the number of animation frames, since each frame
7450 is a separate struct image. We must provide a way for a single
7451 gif_load call to construct and save all animation frames. */
7453 init_color_table ();
7454 if (STRINGP (specified_bg
))
7455 bgcolor
= x_alloc_image_color (f
, img
, specified_bg
,
7456 FRAME_BACKGROUND_PIXEL (f
));
7457 for (j
= 0; j
<= idx
; ++j
)
7459 /* We use a local variable `raster' here because RasterBits is a
7460 char *, which invites problems with bytes >= 0x80. */
7461 struct SavedImage
*subimage
= gif
->SavedImages
+ j
;
7462 unsigned char *raster
= (unsigned char *) subimage
->RasterBits
;
7463 int transparency_color_index
= -1;
7465 int subimg_width
= subimage
->ImageDesc
.Width
;
7466 int subimg_height
= subimage
->ImageDesc
.Height
;
7467 int subimg_top
= subimage
->ImageDesc
.Top
;
7468 int subimg_left
= subimage
->ImageDesc
.Left
;
7470 /* Find the Graphic Control Extension block for this sub-image.
7471 Extract the disposal method and transparency color. */
7472 for (i
= 0; i
< subimage
->ExtensionBlockCount
; i
++)
7474 ExtensionBlock
*extblock
= subimage
->ExtensionBlocks
+ i
;
7476 if ((extblock
->Function
== GIF_LOCAL_DESCRIPTOR_EXTENSION
)
7477 && extblock
->ByteCount
== 4
7478 && extblock
->Bytes
[0] & 1)
7480 /* From gif89a spec: 1 = "keep in place", 2 = "restore
7481 to background". Treat any other value like 2. */
7482 disposal
= (extblock
->Bytes
[0] >> 2) & 7;
7483 transparency_color_index
= (unsigned char) extblock
->Bytes
[3];
7488 /* We can't "keep in place" the first subimage. */
7492 /* For disposal == 0, the spec says "No disposal specified. The
7493 decoder is not required to take any action." In practice, it
7494 seems we need to treat this like "keep in place", see e.g.
7495 http://upload.wikimedia.org/wikipedia/commons/3/37/Clock.gif */
7499 /* Allocate subimage colors. */
7500 memset (pixel_colors
, 0, sizeof pixel_colors
);
7501 gif_color_map
= subimage
->ImageDesc
.ColorMap
;
7503 gif_color_map
= gif
->SColorMap
;
7506 for (i
= 0; i
< gif_color_map
->ColorCount
; ++i
)
7508 if (transparency_color_index
== i
)
7509 pixel_colors
[i
] = STRINGP (specified_bg
)
7510 ? bgcolor
: FRAME_BACKGROUND_PIXEL (f
);
7513 int r
= gif_color_map
->Colors
[i
].Red
<< 8;
7514 int g
= gif_color_map
->Colors
[i
].Green
<< 8;
7515 int b
= gif_color_map
->Colors
[i
].Blue
<< 8;
7516 pixel_colors
[i
] = lookup_rgb_color (f
, r
, g
, b
);
7520 /* Apply the pixel values. */
7521 if (gif
->SavedImages
[j
].ImageDesc
.Interlace
)
7525 for (y
= 0, row
= interlace_start
[0], pass
= 0;
7527 y
++, row
+= interlace_increment
[pass
])
7529 while (subimg_height
<= row
)
7531 lint_assume (pass
< 3);
7532 row
= interlace_start
[++pass
];
7535 for (x
= 0; x
< subimg_width
; x
++)
7537 int c
= raster
[y
* subimg_width
+ x
];
7538 if (transparency_color_index
!= c
|| disposal
!= 1)
7539 XPutPixel (ximg
, x
+ subimg_left
, row
+ subimg_top
,
7546 for (y
= 0; y
< subimg_height
; ++y
)
7547 for (x
= 0; x
< subimg_width
; ++x
)
7549 int c
= raster
[y
* subimg_width
+ x
];
7550 if (transparency_color_index
!= c
|| disposal
!= 1)
7551 XPutPixel (ximg
, x
+ subimg_left
, y
+ subimg_top
,
7557 #ifdef COLOR_TABLE_SUPPORT
7558 img
->colors
= colors_in_color_table (&img
->ncolors
);
7559 free_color_table ();
7560 #endif /* COLOR_TABLE_SUPPORT */
7562 /* Save GIF image extension data for `image-metadata'.
7563 Format is (count IMAGES extension-data (FUNCTION "BYTES" ...)). */
7564 img
->lisp_data
= Qnil
;
7565 if (gif
->SavedImages
[idx
].ExtensionBlockCount
> 0)
7568 ExtensionBlock
*ext
= gif
->SavedImages
[idx
].ExtensionBlocks
;
7569 for (i
= 0; i
< gif
->SavedImages
[idx
].ExtensionBlockCount
; i
++, ext
++)
7570 /* Append (... FUNCTION "BYTES") */
7573 = Fcons (make_number (ext
->Function
),
7574 Fcons (make_unibyte_string (ext
->Bytes
, ext
->ByteCount
),
7576 if (ext
->Function
== GIF_LOCAL_DESCRIPTOR_EXTENSION
7577 && ext
->ByteCount
== 4)
7579 delay
= ext
->Bytes
[2] << CHAR_BIT
;
7580 delay
|= ext
->Bytes
[1];
7583 img
->lisp_data
= list2 (Qextension_data
, img
->lisp_data
);
7587 Fcons (make_float (delay
/ 100.0),
7591 if (gif
->ImageCount
> 1)
7592 img
->lisp_data
= Fcons (Qcount
,
7593 Fcons (make_number (gif
->ImageCount
),
7596 fn_DGifCloseFile (gif
);
7598 /* Maybe fill in the background field while we have ximg handy. */
7599 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
7600 /* Casting avoids a GCC warning. */
7601 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
7603 /* Put ximg into the image. */
7604 image_put_x_image (f
, img
, ximg
, 0);
7609 #else /* !HAVE_GIF */
7613 gif_load (struct frame
*f
, struct image
*img
)
7615 return ns_load_image (f
, img
,
7616 image_spec_value (img
->spec
, QCfile
, NULL
),
7617 image_spec_value (img
->spec
, QCdata
, NULL
));
7619 #endif /* HAVE_NS */
7621 #endif /* HAVE_GIF */
7624 #ifdef HAVE_IMAGEMAGICK
7626 /***********************************************************************
7628 ***********************************************************************/
7630 /* Scale an image size by returning SIZE / DIVISOR * MULTIPLIER,
7631 safely rounded and clipped to int range. */
7634 scale_image_size (int size
, size_t divisor
, size_t multiplier
)
7639 double scaled
= s
* multiplier
/ divisor
+ 0.5;
7640 if (scaled
< INT_MAX
)
7646 /* Compute the desired size of an image with native size WIDTH x HEIGHT.
7647 Use SPEC to deduce the size. Store the desired size into
7648 *D_WIDTH x *D_HEIGHT. Store -1 x -1 if the native size is OK. */
7650 compute_image_size (size_t width
, size_t height
,
7652 int *d_width
, int *d_height
)
7655 int desired_width
, desired_height
;
7657 /* If width and/or height is set in the display spec assume we want
7658 to scale to those values. If either h or w is unspecified, the
7659 unspecified should be calculated from the specified to preserve
7661 value
= image_spec_value (spec
, QCwidth
, NULL
);
7662 desired_width
= NATNUMP (value
) ? min (XFASTINT (value
), INT_MAX
) : -1;
7663 value
= image_spec_value (spec
, QCheight
, NULL
);
7664 desired_height
= NATNUMP (value
) ? min (XFASTINT (value
), INT_MAX
) : -1;
7666 if (desired_width
== -1)
7668 value
= image_spec_value (spec
, QCmax_width
, NULL
);
7669 if (NATNUMP (value
))
7671 int max_width
= min (XFASTINT (value
), INT_MAX
);
7672 if (max_width
< width
)
7674 /* The image is wider than :max-width. */
7675 desired_width
= max_width
;
7676 if (desired_height
== -1)
7678 desired_height
= scale_image_size (desired_width
,
7680 value
= image_spec_value (spec
, QCmax_height
, NULL
);
7681 if (NATNUMP (value
))
7683 int max_height
= min (XFASTINT (value
), INT_MAX
);
7684 if (max_height
< desired_height
)
7686 desired_height
= max_height
;
7687 desired_width
= scale_image_size (desired_height
,
7696 if (desired_height
== -1)
7698 value
= image_spec_value (spec
, QCmax_height
, NULL
);
7699 if (NATNUMP (value
))
7701 int max_height
= min (XFASTINT (value
), INT_MAX
);
7702 if (max_height
< height
)
7703 desired_height
= max_height
;
7707 if (desired_width
!= -1 && desired_height
== -1)
7708 /* w known, calculate h. */
7709 desired_height
= scale_image_size (desired_width
, width
, height
);
7711 if (desired_width
== -1 && desired_height
!= -1)
7712 /* h known, calculate w. */
7713 desired_width
= scale_image_size (desired_height
, height
, width
);
7715 *d_width
= desired_width
;
7716 *d_height
= desired_height
;
7719 static Lisp_Object Qimagemagick
;
7721 static bool imagemagick_image_p (Lisp_Object
);
7722 static bool imagemagick_load (struct frame
*, struct image
*);
7723 static void imagemagick_clear_image (struct frame
*, struct image
*);
7725 /* Indices of image specification fields in imagemagick_format. */
7727 enum imagemagick_keyword_index
7735 IMAGEMAGICK_ALGORITHM
,
7736 IMAGEMAGICK_HEURISTIC_MASK
,
7738 IMAGEMAGICK_BACKGROUND
,
7741 IMAGEMAGICK_MAX_HEIGHT
,
7742 IMAGEMAGICK_MAX_WIDTH
,
7743 IMAGEMAGICK_ROTATION
,
7748 /* Vector of image_keyword structures describing the format
7749 of valid user-defined image specifications. */
7751 static struct image_keyword imagemagick_format
[IMAGEMAGICK_LAST
] =
7753 {":type", IMAGE_SYMBOL_VALUE
, 1},
7754 {":data", IMAGE_STRING_VALUE
, 0},
7755 {":file", IMAGE_STRING_VALUE
, 0},
7756 {":ascent", IMAGE_ASCENT_VALUE
, 0},
7757 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
7758 {":relief", IMAGE_INTEGER_VALUE
, 0},
7759 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7760 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7761 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7762 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0},
7763 {":height", IMAGE_INTEGER_VALUE
, 0},
7764 {":width", IMAGE_INTEGER_VALUE
, 0},
7765 {":max-height", IMAGE_INTEGER_VALUE
, 0},
7766 {":max-width", IMAGE_INTEGER_VALUE
, 0},
7767 {":rotation", IMAGE_NUMBER_VALUE
, 0},
7768 {":crop", IMAGE_DONT_CHECK_VALUE_TYPE
, 0}
7771 #if defined HAVE_NTGUI && defined WINDOWSNT
7772 static bool init_imagemagick_functions (void);
7774 #define init_imagemagick_functions NULL
7777 /* Structure describing the image type for any image handled via
7780 static struct image_type imagemagick_type
=
7783 imagemagick_image_p
,
7785 imagemagick_clear_image
,
7786 init_imagemagick_functions
,
7790 /* Free X resources of imagemagick image IMG which is used on frame F. */
7793 imagemagick_clear_image (struct frame
*f
,
7796 x_clear_image (f
, img
);
7799 /* Return true if OBJECT is a valid IMAGEMAGICK image specification. Do
7800 this by calling parse_image_spec and supplying the keywords that
7801 identify the IMAGEMAGICK format. */
7804 imagemagick_image_p (Lisp_Object object
)
7806 struct image_keyword fmt
[IMAGEMAGICK_LAST
];
7807 memcpy (fmt
, imagemagick_format
, sizeof fmt
);
7809 if (!parse_image_spec (object
, fmt
, IMAGEMAGICK_LAST
, Qimagemagick
))
7812 /* Must specify either the :data or :file keyword. */
7813 return fmt
[IMAGEMAGICK_FILE
].count
+ fmt
[IMAGEMAGICK_DATA
].count
== 1;
7816 /* The GIF library also defines DrawRectangle, but its never used in Emacs.
7817 Therefore rename the function so it doesn't collide with ImageMagick. */
7818 #define DrawRectangle DrawRectangleGif
7819 #include <wand/MagickWand.h>
7821 /* ImageMagick 6.5.3 through 6.6.5 hid PixelGetMagickColor for some reason.
7822 Emacs seems to work fine with the hidden version, so unhide it. */
7823 #include <magick/version.h>
7824 #if 0x653 <= MagickLibVersion && MagickLibVersion <= 0x665
7825 extern WandExport
void PixelGetMagickColor (const PixelWand
*,
7826 MagickPixelPacket
*);
7829 /* Log ImageMagick error message.
7830 Useful when a ImageMagick function returns the status `MagickFalse'. */
7833 imagemagick_error (MagickWand
*wand
)
7836 ExceptionType severity
;
7838 description
= MagickGetException (wand
, &severity
);
7839 image_error ("ImageMagick error: %s",
7840 build_string (description
),
7842 description
= (char *) MagickRelinquishMemory (description
);
7845 /* Helper function for imagemagick_load, which does the actual loading
7846 given contents and size, apart from frame and image structures,
7847 passed from imagemagick_load. Uses librimagemagick to do most of
7848 the image processing.
7850 F is a pointer to the Emacs frame; IMG to the image structure to
7851 prepare; CONTENTS is the string containing the IMAGEMAGICK data to
7852 be parsed; SIZE is the number of bytes of data; and FILENAME is
7853 either the file name or the image data.
7855 Return true if successful. */
7858 imagemagick_load_image (struct frame
*f
, struct image
*img
,
7859 unsigned char *contents
, unsigned int size
,
7862 size_t width
, height
;
7863 MagickBooleanType status
;
7866 MagickWand
*image_wand
;
7867 MagickWand
*ping_wand
;
7868 PixelIterator
*iterator
;
7869 PixelWand
**pixels
, *bg_wand
= NULL
;
7870 MagickPixelPacket pixel
;
7875 int desired_width
, desired_height
;
7879 /* Handle image index for image types who can contain more than one image.
7880 Interface :index is same as for GIF. First we "ping" the image to see how
7881 many sub-images it contains. Pinging is faster than loading the image to
7882 find out things about it. */
7884 /* Initialize the imagemagick environment. */
7885 MagickWandGenesis ();
7886 image
= image_spec_value (img
->spec
, QCindex
, NULL
);
7887 ino
= INTEGERP (image
) ? XFASTINT (image
) : 0;
7888 ping_wand
= NewMagickWand ();
7889 /* MagickSetResolution (ping_wand, 2, 2); (Bug#10112) */
7892 ? MagickPingImage (ping_wand
, filename
)
7893 : MagickPingImageBlob (ping_wand
, contents
, size
);
7895 if (status
== MagickFalse
)
7897 imagemagick_error (ping_wand
);
7898 DestroyMagickWand (ping_wand
);
7902 if (ino
< 0 || ino
>= MagickGetNumberImages (ping_wand
))
7904 image_error ("Invalid image number `%s' in image `%s'",
7906 DestroyMagickWand (ping_wand
);
7910 if (MagickGetNumberImages (ping_wand
) > 1)
7913 Fcons (make_number (MagickGetNumberImages (ping_wand
)),
7916 DestroyMagickWand (ping_wand
);
7918 /* Now we know how many images are inside the file. If it's not a
7919 bundle, the number is one. Load the image data. */
7921 image_wand
= NewMagickWand ();
7924 ? MagickReadImage (image_wand
, filename
)
7925 : MagickReadImageBlob (image_wand
, contents
, size
))
7928 imagemagick_error (image_wand
);
7929 goto imagemagick_error
;
7932 /* Retrieve the frame's background color, for use later. */
7935 Lisp_Object specified_bg
;
7937 specified_bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
7938 if (!STRINGP (specified_bg
)
7939 || !x_defined_color (f
, SSDATA (specified_bg
), &bgcolor
, 0))
7942 bgcolor
.pixel
= FRAME_BACKGROUND_PIXEL (f
);
7943 x_query_color (f
, &bgcolor
);
7945 ns_query_color (FRAME_BACKGROUND_COLOR (f
), &bgcolor
, 1);
7949 bg_wand
= NewPixelWand ();
7950 PixelSetRed (bg_wand
, (double) bgcolor
.red
/ 65535);
7951 PixelSetGreen (bg_wand
, (double) bgcolor
.green
/ 65535);
7952 PixelSetBlue (bg_wand
, (double) bgcolor
.blue
/ 65535);
7955 compute_image_size (MagickGetImageWidth (image_wand
),
7956 MagickGetImageHeight (image_wand
),
7957 img
->spec
, &desired_width
, &desired_height
);
7959 if (desired_width
!= -1 && desired_height
!= -1)
7961 status
= MagickScaleImage (image_wand
, desired_width
, desired_height
);
7962 if (status
== MagickFalse
)
7964 image_error ("Imagemagick scale failed", Qnil
, Qnil
);
7965 imagemagick_error (image_wand
);
7966 goto imagemagick_error
;
7970 /* crop behaves similar to image slicing in Emacs but is more memory
7972 crop
= image_spec_value (img
->spec
, QCcrop
, NULL
);
7974 if (CONSP (crop
) && TYPE_RANGED_INTEGERP (size_t, XCAR (crop
)))
7976 /* After some testing, it seems MagickCropImage is the fastest crop
7977 function in ImageMagick. This crop function seems to do less copying
7978 than the alternatives, but it still reads the entire image into memory
7979 before cropping, which is apparently difficult to avoid when using
7981 size_t crop_width
= XINT (XCAR (crop
));
7983 if (CONSP (crop
) && TYPE_RANGED_INTEGERP (size_t, XCAR (crop
)))
7985 size_t crop_height
= XINT (XCAR (crop
));
7987 if (CONSP (crop
) && TYPE_RANGED_INTEGERP (ssize_t
, XCAR (crop
)))
7989 ssize_t crop_x
= XINT (XCAR (crop
));
7991 if (CONSP (crop
) && TYPE_RANGED_INTEGERP (ssize_t
, XCAR (crop
)))
7993 ssize_t crop_y
= XINT (XCAR (crop
));
7994 MagickCropImage (image_wand
, crop_width
, crop_height
,
8001 /* Furthermore :rotation. we need background color and angle for
8004 TODO background handling for rotation specified_bg =
8005 image_spec_value (img->spec, QCbackground, NULL); if (!STRINGP
8007 value
= image_spec_value (img
->spec
, QCrotation
, NULL
);
8010 rotation
= extract_float (value
);
8011 status
= MagickRotateImage (image_wand
, bg_wand
, rotation
);
8012 if (status
== MagickFalse
)
8014 image_error ("Imagemagick image rotate failed", Qnil
, Qnil
);
8015 imagemagick_error (image_wand
);
8016 goto imagemagick_error
;
8020 /* Set the canvas background color to the frame or specified
8021 background, and flatten the image. Note: as of ImageMagick
8022 6.6.0, SVG image transparency is not handled properly
8023 (e.g. etc/images/splash.svg shows a white background always). */
8025 MagickWand
*new_wand
;
8026 MagickSetImageBackgroundColor (image_wand
, bg_wand
);
8027 #ifdef HAVE_MAGICKMERGEIMAGELAYERS
8028 new_wand
= MagickMergeImageLayers (image_wand
, MergeLayer
);
8030 new_wand
= MagickFlattenImages (image_wand
);
8032 DestroyMagickWand (image_wand
);
8033 image_wand
= new_wand
;
8036 /* Finally we are done manipulating the image. Figure out the
8037 resulting width/height and transfer ownership to Emacs. */
8038 height
= MagickGetImageHeight (image_wand
);
8039 width
= MagickGetImageWidth (image_wand
);
8041 if (! (width
<= INT_MAX
&& height
<= INT_MAX
8042 && check_image_size (f
, width
, height
)))
8044 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
8045 goto imagemagick_error
;
8048 /* We can now get a valid pixel buffer from the imagemagick file, if all
8051 init_color_table ();
8053 #if defined (HAVE_MAGICKEXPORTIMAGEPIXELS) && ! defined (HAVE_NS)
8054 if (imagemagick_render_type
!= 0)
8056 /* Magicexportimage is normally faster than pixelpushing. This
8057 method is also well tested. Some aspects of this method are
8058 ad-hoc and needs to be more researched. */
8059 int imagedepth
= 24; /*MagickGetImageDepth(image_wand);*/
8060 const char *exportdepth
= imagedepth
<= 8 ? "I" : "BGRP"; /*"RGBP";*/
8061 /* Try to create a x pixmap to hold the imagemagick pixmap. */
8062 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, imagedepth
,
8065 #ifdef COLOR_TABLE_SUPPORT
8066 free_color_table ();
8068 image_error ("Imagemagick X bitmap allocation failure", Qnil
, Qnil
);
8069 goto imagemagick_error
;
8072 /* Oddly, the below code doesn't seem to work:*/
8073 /* switch(ximg->bitmap_unit){ */
8075 /* pixelwidth=CharPixel; */
8078 /* pixelwidth=ShortPixel; */
8081 /* pixelwidth=LongPixel; */
8085 Here im just guessing the format of the bitmap.
8086 happens to work fine for:
8089 seems about 3 times as fast as pixel pushing(not carefully measured)
8091 pixelwidth
= CharPixel
; /*??? TODO figure out*/
8092 MagickExportImagePixels (image_wand
, 0, 0, width
, height
,
8093 exportdepth
, pixelwidth
, ximg
->data
);
8096 #endif /* HAVE_MAGICKEXPORTIMAGEPIXELS */
8098 size_t image_height
;
8100 /* Try to create a x pixmap to hold the imagemagick pixmap. */
8101 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, 0,
8104 #ifdef COLOR_TABLE_SUPPORT
8105 free_color_table ();
8107 image_error ("Imagemagick X bitmap allocation failure", Qnil
, Qnil
);
8108 goto imagemagick_error
;
8111 /* Copy imagemagick image to x with primitive yet robust pixel
8112 pusher loop. This has been tested a lot with many different
8115 /* Copy pixels from the imagemagick image structure to the x image map. */
8116 iterator
= NewPixelIterator (image_wand
);
8119 #ifdef COLOR_TABLE_SUPPORT
8120 free_color_table ();
8122 x_destroy_x_image (ximg
);
8123 image_error ("Imagemagick pixel iterator creation failed",
8125 goto imagemagick_error
;
8128 image_height
= MagickGetImageHeight (image_wand
);
8129 for (y
= 0; y
< image_height
; y
++)
8131 pixels
= PixelGetNextIteratorRow (iterator
, &width
);
8134 for (x
= 0; x
< (long) width
; x
++)
8136 PixelGetMagickColor (pixels
[x
], &pixel
);
8137 XPutPixel (ximg
, x
, y
,
8138 lookup_rgb_color (f
,
8144 DestroyPixelIterator (iterator
);
8147 #ifdef COLOR_TABLE_SUPPORT
8148 /* Remember colors allocated for this image. */
8149 img
->colors
= colors_in_color_table (&img
->ncolors
);
8150 free_color_table ();
8151 #endif /* COLOR_TABLE_SUPPORT */
8154 img
->height
= height
;
8156 /* Put ximg into the image. */
8157 image_put_x_image (f
, img
, ximg
, 0);
8159 /* Final cleanup. image_wand should be the only resource left. */
8160 DestroyMagickWand (image_wand
);
8161 if (bg_wand
) DestroyPixelWand (bg_wand
);
8163 /* `MagickWandTerminus' terminates the imagemagick environment. */
8164 MagickWandTerminus ();
8169 DestroyMagickWand (image_wand
);
8170 if (bg_wand
) DestroyPixelWand (bg_wand
);
8172 MagickWandTerminus ();
8173 /* TODO more cleanup. */
8174 image_error ("Error parsing IMAGEMAGICK image `%s'", img
->spec
, Qnil
);
8179 /* Load IMAGEMAGICK image IMG for use on frame F. Value is true if
8180 successful. this function will go into the imagemagick_type structure, and
8181 the prototype thus needs to be compatible with that structure. */
8184 imagemagick_load (struct frame
*f
, struct image
*img
)
8187 Lisp_Object file_name
;
8189 /* If IMG->spec specifies a file name, create a non-file spec from it. */
8190 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
8191 if (STRINGP (file_name
))
8195 file
= x_find_image_file (file_name
);
8196 if (!STRINGP (file
))
8198 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
8201 success_p
= imagemagick_load_image (f
, img
, 0, 0, SSDATA (file
));
8203 /* Else its not a file, its a lisp object. Load the image from a
8204 lisp object rather than a file. */
8209 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
8210 if (!STRINGP (data
))
8212 image_error ("Invalid image data `%s'", data
, Qnil
);
8215 success_p
= imagemagick_load_image (f
, img
, SDATA (data
),
8216 SBYTES (data
), NULL
);
8222 DEFUN ("imagemagick-types", Fimagemagick_types
, Simagemagick_types
, 0, 0, 0,
8223 doc
: /* Return a list of image types supported by ImageMagick.
8224 Each entry in this list is a symbol named after an ImageMagick format
8225 tag. See the ImageMagick manual for a list of ImageMagick formats and
8226 their descriptions (http://www.imagemagick.org/script/formats.php).
8227 You can also try the shell command: `identify -list format'.
8229 Note that ImageMagick recognizes many file-types that Emacs does not
8230 recognize as images, such as C. See `imagemagick-types-enable'
8231 and `imagemagick-types-inhibit'. */)
8234 Lisp_Object typelist
= Qnil
;
8239 Lisp_Object Qimagemagicktype
;
8241 GetExceptionInfo(&ex
);
8242 imtypes
= GetMagickList ("*", &numf
, &ex
);
8243 DestroyExceptionInfo(&ex
);
8245 for (i
= 0; i
< numf
; i
++)
8247 Qimagemagicktype
= intern (imtypes
[i
]);
8248 typelist
= Fcons (Qimagemagicktype
, typelist
);
8250 return Fnreverse (typelist
);
8253 #endif /* defined (HAVE_IMAGEMAGICK) */
8257 /***********************************************************************
8259 ***********************************************************************/
8261 #if defined (HAVE_RSVG)
8263 /* Function prototypes. */
8265 static bool svg_image_p (Lisp_Object object
);
8266 static bool svg_load (struct frame
*f
, struct image
*img
);
8268 static bool svg_load_image (struct frame
*, struct image
*,
8269 unsigned char *, ptrdiff_t);
8271 /* The symbol `svg' identifying images of this type. */
8273 static Lisp_Object Qsvg
;
8275 /* Indices of image specification fields in svg_format, below. */
8277 enum svg_keyword_index
8292 /* Vector of image_keyword structures describing the format
8293 of valid user-defined image specifications. */
8295 static const struct image_keyword svg_format
[SVG_LAST
] =
8297 {":type", IMAGE_SYMBOL_VALUE
, 1},
8298 {":data", IMAGE_STRING_VALUE
, 0},
8299 {":file", IMAGE_STRING_VALUE
, 0},
8300 {":ascent", IMAGE_ASCENT_VALUE
, 0},
8301 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
8302 {":relief", IMAGE_INTEGER_VALUE
, 0},
8303 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8304 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8305 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8306 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
8309 #if defined HAVE_NTGUI && defined WINDOWSNT
8310 static bool init_svg_functions (void);
8312 #define init_svg_functions NULL
8315 /* Structure describing the image type `svg'. Its the same type of
8316 structure defined for all image formats, handled by emacs image
8317 functions. See struct image_type in dispextern.h. */
8319 static struct image_type svg_type
=
8330 /* Return true if OBJECT is a valid SVG image specification. Do
8331 this by calling parse_image_spec and supplying the keywords that
8332 identify the SVG format. */
8335 svg_image_p (Lisp_Object object
)
8337 struct image_keyword fmt
[SVG_LAST
];
8338 memcpy (fmt
, svg_format
, sizeof fmt
);
8340 if (!parse_image_spec (object
, fmt
, SVG_LAST
, Qsvg
))
8343 /* Must specify either the :data or :file keyword. */
8344 return fmt
[SVG_FILE
].count
+ fmt
[SVG_DATA
].count
== 1;
8347 #include <librsvg/rsvg.h>
8351 /* SVG library functions. */
8352 DEF_IMGLIB_FN (RsvgHandle
*, rsvg_handle_new
, (void));
8353 DEF_IMGLIB_FN (void, rsvg_handle_get_dimensions
, (RsvgHandle
*, RsvgDimensionData
*));
8354 DEF_IMGLIB_FN (gboolean
, rsvg_handle_write
, (RsvgHandle
*, const guchar
*, gsize
, GError
**));
8355 DEF_IMGLIB_FN (gboolean
, rsvg_handle_close
, (RsvgHandle
*, GError
**));
8356 DEF_IMGLIB_FN (GdkPixbuf
*, rsvg_handle_get_pixbuf
, (RsvgHandle
*));
8357 DEF_IMGLIB_FN (void *, rsvg_handle_set_size_callback
, (RsvgHandle
*, RsvgSizeFunc
, gpointer
, GDestroyNotify
));
8359 DEF_IMGLIB_FN (int, gdk_pixbuf_get_width
, (const GdkPixbuf
*));
8360 DEF_IMGLIB_FN (int, gdk_pixbuf_get_height
, (const GdkPixbuf
*));
8361 DEF_IMGLIB_FN (guchar
*, gdk_pixbuf_get_pixels
, (const GdkPixbuf
*));
8362 DEF_IMGLIB_FN (int, gdk_pixbuf_get_rowstride
, (const GdkPixbuf
*));
8363 DEF_IMGLIB_FN (GdkColorspace
, gdk_pixbuf_get_colorspace
, (const GdkPixbuf
*));
8364 DEF_IMGLIB_FN (int, gdk_pixbuf_get_n_channels
, (const GdkPixbuf
*));
8365 DEF_IMGLIB_FN (gboolean
, gdk_pixbuf_get_has_alpha
, (const GdkPixbuf
*));
8366 DEF_IMGLIB_FN (int, gdk_pixbuf_get_bits_per_sample
, (const GdkPixbuf
*));
8368 DEF_IMGLIB_FN (void, g_type_init
, (void));
8369 DEF_IMGLIB_FN (void, g_object_unref
, (gpointer
));
8370 DEF_IMGLIB_FN (void, g_error_free
, (GError
*));
8372 Lisp_Object Qgdk_pixbuf
, Qglib
, Qgobject
;
8375 init_svg_functions (void)
8377 HMODULE library
, gdklib
, glib
, gobject
;
8379 if (!(glib
= w32_delayed_load (Qglib
))
8380 || !(gobject
= w32_delayed_load (Qgobject
))
8381 || !(gdklib
= w32_delayed_load (Qgdk_pixbuf
))
8382 || !(library
= w32_delayed_load (Qsvg
)))
8385 LOAD_IMGLIB_FN (library
, rsvg_handle_new
);
8386 LOAD_IMGLIB_FN (library
, rsvg_handle_get_dimensions
);
8387 LOAD_IMGLIB_FN (library
, rsvg_handle_write
);
8388 LOAD_IMGLIB_FN (library
, rsvg_handle_close
);
8389 LOAD_IMGLIB_FN (library
, rsvg_handle_get_pixbuf
);
8391 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_width
);
8392 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_height
);
8393 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_pixels
);
8394 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_rowstride
);
8395 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_colorspace
);
8396 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_n_channels
);
8397 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_has_alpha
);
8398 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_bits_per_sample
);
8400 LOAD_IMGLIB_FN (gobject
, g_type_init
);
8401 LOAD_IMGLIB_FN (gobject
, g_object_unref
);
8402 LOAD_IMGLIB_FN (glib
, g_error_free
);
8408 /* The following aliases for library functions allow dynamic loading
8409 to be used on some platforms. */
8410 #define fn_rsvg_handle_new rsvg_handle_new
8411 #define fn_rsvg_handle_get_dimensions rsvg_handle_get_dimensions
8412 #define fn_rsvg_handle_write rsvg_handle_write
8413 #define fn_rsvg_handle_close rsvg_handle_close
8414 #define fn_rsvg_handle_get_pixbuf rsvg_handle_get_pixbuf
8416 #define fn_gdk_pixbuf_get_width gdk_pixbuf_get_width
8417 #define fn_gdk_pixbuf_get_height gdk_pixbuf_get_height
8418 #define fn_gdk_pixbuf_get_pixels gdk_pixbuf_get_pixels
8419 #define fn_gdk_pixbuf_get_rowstride gdk_pixbuf_get_rowstride
8420 #define fn_gdk_pixbuf_get_colorspace gdk_pixbuf_get_colorspace
8421 #define fn_gdk_pixbuf_get_n_channels gdk_pixbuf_get_n_channels
8422 #define fn_gdk_pixbuf_get_has_alpha gdk_pixbuf_get_has_alpha
8423 #define fn_gdk_pixbuf_get_bits_per_sample gdk_pixbuf_get_bits_per_sample
8425 #define fn_g_type_init g_type_init
8426 #define fn_g_object_unref g_object_unref
8427 #define fn_g_error_free g_error_free
8428 #endif /* !WINDOWSNT */
8430 /* Load SVG image IMG for use on frame F. Value is true if
8434 svg_load (struct frame
*f
, struct image
*img
)
8437 Lisp_Object file_name
;
8439 /* If IMG->spec specifies a file name, create a non-file spec from it. */
8440 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
8441 if (STRINGP (file_name
))
8444 unsigned char *contents
;
8447 file
= x_find_image_file (file_name
);
8448 if (!STRINGP (file
))
8450 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
8454 /* Read the entire file into memory. */
8455 contents
= slurp_file (SSDATA (file
), &size
);
8456 if (contents
== NULL
)
8458 image_error ("Error loading SVG image `%s'", img
->spec
, Qnil
);
8461 /* If the file was slurped into memory properly, parse it. */
8462 success_p
= svg_load_image (f
, img
, contents
, size
);
8465 /* Else its not a file, its a lisp object. Load the image from a
8466 lisp object rather than a file. */
8471 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
8472 if (!STRINGP (data
))
8474 image_error ("Invalid image data `%s'", data
, Qnil
);
8477 success_p
= svg_load_image (f
, img
, SDATA (data
), SBYTES (data
));
8483 /* svg_load_image is a helper function for svg_load, which does the
8484 actual loading given contents and size, apart from frame and image
8485 structures, passed from svg_load.
8487 Uses librsvg to do most of the image processing.
8489 Returns true when successful. */
8491 svg_load_image (struct frame
*f
, /* Pointer to emacs frame structure. */
8492 struct image
*img
, /* Pointer to emacs image structure. */
8493 unsigned char *contents
, /* String containing the SVG XML data to be parsed. */
8494 ptrdiff_t size
) /* Size of data in bytes. */
8496 RsvgHandle
*rsvg_handle
;
8497 RsvgDimensionData dimension_data
;
8502 const guint8
*pixels
;
8505 Lisp_Object specified_bg
;
8510 /* g_type_init is a glib function that must be called prior to using
8511 gnome type library functions. */
8513 /* Make a handle to a new rsvg object. */
8514 rsvg_handle
= fn_rsvg_handle_new ();
8516 /* Parse the contents argument and fill in the rsvg_handle. */
8517 fn_rsvg_handle_write (rsvg_handle
, contents
, size
, &err
);
8518 if (err
) goto rsvg_error
;
8520 /* The parsing is complete, rsvg_handle is ready to used, close it
8521 for further writes. */
8522 fn_rsvg_handle_close (rsvg_handle
, &err
);
8523 if (err
) goto rsvg_error
;
8525 fn_rsvg_handle_get_dimensions (rsvg_handle
, &dimension_data
);
8526 if (! check_image_size (f
, dimension_data
.width
, dimension_data
.height
))
8528 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
8532 /* We can now get a valid pixel buffer from the svg file, if all
8534 pixbuf
= fn_rsvg_handle_get_pixbuf (rsvg_handle
);
8535 if (!pixbuf
) goto rsvg_error
;
8536 fn_g_object_unref (rsvg_handle
);
8538 /* Extract some meta data from the svg handle. */
8539 width
= fn_gdk_pixbuf_get_width (pixbuf
);
8540 height
= fn_gdk_pixbuf_get_height (pixbuf
);
8541 pixels
= fn_gdk_pixbuf_get_pixels (pixbuf
);
8542 rowstride
= fn_gdk_pixbuf_get_rowstride (pixbuf
);
8544 /* Validate the svg meta data. */
8545 eassert (fn_gdk_pixbuf_get_colorspace (pixbuf
) == GDK_COLORSPACE_RGB
);
8546 eassert (fn_gdk_pixbuf_get_n_channels (pixbuf
) == 4);
8547 eassert (fn_gdk_pixbuf_get_has_alpha (pixbuf
));
8548 eassert (fn_gdk_pixbuf_get_bits_per_sample (pixbuf
) == 8);
8550 /* Try to create a x pixmap to hold the svg pixmap. */
8551 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, 0, &ximg
, 0))
8553 fn_g_object_unref (pixbuf
);
8557 init_color_table ();
8559 /* Handle alpha channel by combining the image with a background
8561 specified_bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
8562 if (!STRINGP (specified_bg
)
8563 || !x_defined_color (f
, SSDATA (specified_bg
), &background
, 0))
8566 background
.pixel
= FRAME_BACKGROUND_PIXEL (f
);
8567 x_query_color (f
, &background
);
8569 ns_query_color (FRAME_BACKGROUND_COLOR (f
), &background
, 1);
8573 /* SVG pixmaps specify transparency in the last byte, so right
8574 shift 8 bits to get rid of it, since emacs doesn't support
8576 background
.red
>>= 8;
8577 background
.green
>>= 8;
8578 background
.blue
>>= 8;
8580 /* This loop handles opacity values, since Emacs assumes
8581 non-transparent images. Each pixel must be "flattened" by
8582 calculating the resulting color, given the transparency of the
8583 pixel, and the image background color. */
8584 for (y
= 0; y
< height
; ++y
)
8586 for (x
= 0; x
< width
; ++x
)
8596 opacity
= *pixels
++;
8598 red
= ((red
* opacity
)
8599 + (background
.red
* ((1 << 8) - opacity
)));
8600 green
= ((green
* opacity
)
8601 + (background
.green
* ((1 << 8) - opacity
)));
8602 blue
= ((blue
* opacity
)
8603 + (background
.blue
* ((1 << 8) - opacity
)));
8605 XPutPixel (ximg
, x
, y
, lookup_rgb_color (f
, red
, green
, blue
));
8608 pixels
+= rowstride
- 4 * width
;
8611 #ifdef COLOR_TABLE_SUPPORT
8612 /* Remember colors allocated for this image. */
8613 img
->colors
= colors_in_color_table (&img
->ncolors
);
8614 free_color_table ();
8615 #endif /* COLOR_TABLE_SUPPORT */
8617 fn_g_object_unref (pixbuf
);
8620 img
->height
= height
;
8622 /* Maybe fill in the background field while we have ximg handy.
8623 Casting avoids a GCC warning. */
8624 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
8626 /* Put ximg into the image. */
8627 image_put_x_image (f
, img
, ximg
, 0);
8632 fn_g_object_unref (rsvg_handle
);
8633 /* FIXME: Use error->message so the user knows what is the actual
8634 problem with the image. */
8635 image_error ("Error parsing SVG image `%s'", img
->spec
, Qnil
);
8636 fn_g_error_free (err
);
8640 #endif /* defined (HAVE_RSVG) */
8645 /***********************************************************************
8647 ***********************************************************************/
8649 #ifdef HAVE_X_WINDOWS
8650 #define HAVE_GHOSTSCRIPT 1
8651 #endif /* HAVE_X_WINDOWS */
8653 #ifdef HAVE_GHOSTSCRIPT
8655 static bool gs_image_p (Lisp_Object object
);
8656 static bool gs_load (struct frame
*f
, struct image
*img
);
8657 static void gs_clear_image (struct frame
*f
, struct image
*img
);
8659 /* Keyword symbols. */
8661 static Lisp_Object QCloader
, QCbounding_box
, QCpt_width
, QCpt_height
;
8663 /* Indices of image specification fields in gs_format, below. */
8665 enum gs_keyword_index
8683 /* Vector of image_keyword structures describing the format
8684 of valid user-defined image specifications. */
8686 static const struct image_keyword gs_format
[GS_LAST
] =
8688 {":type", IMAGE_SYMBOL_VALUE
, 1},
8689 {":pt-width", IMAGE_POSITIVE_INTEGER_VALUE
, 1},
8690 {":pt-height", IMAGE_POSITIVE_INTEGER_VALUE
, 1},
8691 {":file", IMAGE_STRING_VALUE
, 1},
8692 {":loader", IMAGE_FUNCTION_VALUE
, 0},
8693 {":bounding-box", IMAGE_DONT_CHECK_VALUE_TYPE
, 1},
8694 {":ascent", IMAGE_ASCENT_VALUE
, 0},
8695 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
8696 {":relief", IMAGE_INTEGER_VALUE
, 0},
8697 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8698 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8699 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8700 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
8703 /* Structure describing the image type `ghostscript'. */
8705 static struct image_type gs_type
=
8716 /* Free X resources of Ghostscript image IMG which is used on frame F. */
8719 gs_clear_image (struct frame
*f
, struct image
*img
)
8721 x_clear_image (f
, img
);
8725 /* Return true if OBJECT is a valid Ghostscript image
8729 gs_image_p (Lisp_Object object
)
8731 struct image_keyword fmt
[GS_LAST
];
8735 memcpy (fmt
, gs_format
, sizeof fmt
);
8737 if (!parse_image_spec (object
, fmt
, GS_LAST
, Qpostscript
))
8740 /* Bounding box must be a list or vector containing 4 integers. */
8741 tem
= fmt
[GS_BOUNDING_BOX
].value
;
8744 for (i
= 0; i
< 4; ++i
, tem
= XCDR (tem
))
8745 if (!CONSP (tem
) || !INTEGERP (XCAR (tem
)))
8750 else if (VECTORP (tem
))
8752 if (ASIZE (tem
) != 4)
8754 for (i
= 0; i
< 4; ++i
)
8755 if (!INTEGERP (AREF (tem
, i
)))
8765 /* Load Ghostscript image IMG for use on frame F. Value is true
8769 gs_load (struct frame
*f
, struct image
*img
)
8771 uprintmax_t printnum1
, printnum2
;
8772 char buffer
[sizeof " " + INT_STRLEN_BOUND (printmax_t
)];
8773 Lisp_Object window_and_pixmap_id
= Qnil
, loader
, pt_height
, pt_width
;
8775 double in_width
, in_height
;
8776 Lisp_Object pixel_colors
= Qnil
;
8778 /* Compute pixel size of pixmap needed from the given size in the
8779 image specification. Sizes in the specification are in pt. 1 pt
8780 = 1/72 in, xdpi and ydpi are stored in the frame's X display
8782 pt_width
= image_spec_value (img
->spec
, QCpt_width
, NULL
);
8783 in_width
= INTEGERP (pt_width
) ? XFASTINT (pt_width
) / 72.0 : 0;
8784 in_width
*= FRAME_RES_X (f
);
8785 pt_height
= image_spec_value (img
->spec
, QCpt_height
, NULL
);
8786 in_height
= INTEGERP (pt_height
) ? XFASTINT (pt_height
) / 72.0 : 0;
8787 in_height
*= FRAME_RES_Y (f
);
8789 if (! (in_width
<= INT_MAX
&& in_height
<= INT_MAX
8790 && check_image_size (f
, in_width
, in_height
)))
8792 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
8795 img
->width
= in_width
;
8796 img
->height
= in_height
;
8798 /* Create the pixmap. */
8799 eassert (img
->pixmap
== NO_PIXMAP
);
8801 if (x_check_image_size (0, img
->width
, img
->height
))
8803 /* Only W32 version did BLOCK_INPUT here. ++kfs */
8805 img
->pixmap
= XCreatePixmap (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
8806 img
->width
, img
->height
,
8807 DefaultDepthOfScreen (FRAME_X_SCREEN (f
)));
8813 image_error ("Unable to create pixmap for `%s'", img
->spec
, Qnil
);
8817 /* Call the loader to fill the pixmap. It returns a process object
8818 if successful. We do not record_unwind_protect here because
8819 other places in redisplay like calling window scroll functions
8820 don't either. Let the Lisp loader use `unwind-protect' instead. */
8821 printnum1
= FRAME_X_WINDOW (f
);
8822 printnum2
= img
->pixmap
;
8823 window_and_pixmap_id
8824 = make_formatted_string (buffer
, "%"pMu
" %"pMu
, printnum1
, printnum2
);
8826 printnum1
= FRAME_FOREGROUND_PIXEL (f
);
8827 printnum2
= FRAME_BACKGROUND_PIXEL (f
);
8829 = make_formatted_string (buffer
, "%"pMu
" %"pMu
, printnum1
, printnum2
);
8831 XSETFRAME (frame
, f
);
8832 loader
= image_spec_value (img
->spec
, QCloader
, NULL
);
8834 loader
= intern ("gs-load-image");
8836 img
->lisp_data
= call6 (loader
, frame
, img
->spec
,
8837 make_number (img
->width
),
8838 make_number (img
->height
),
8839 window_and_pixmap_id
,
8841 return PROCESSP (img
->lisp_data
);
8845 /* Kill the Ghostscript process that was started to fill PIXMAP on
8846 frame F. Called from XTread_socket when receiving an event
8847 telling Emacs that Ghostscript has finished drawing. */
8850 x_kill_gs_process (Pixmap pixmap
, struct frame
*f
)
8852 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
8857 /* Find the image containing PIXMAP. */
8858 for (i
= 0; i
< c
->used
; ++i
)
8859 if (c
->images
[i
]->pixmap
== pixmap
)
8862 /* Should someone in between have cleared the image cache, for
8863 instance, give up. */
8867 /* Kill the GS process. We should have found PIXMAP in the image
8868 cache and its image should contain a process object. */
8870 eassert (PROCESSP (img
->lisp_data
));
8871 Fkill_process (img
->lisp_data
, Qnil
);
8872 img
->lisp_data
= Qnil
;
8874 #if defined (HAVE_X_WINDOWS)
8876 /* On displays with a mutable colormap, figure out the colors
8877 allocated for the image by looking at the pixels of an XImage for
8879 class = FRAME_X_VISUAL (f
)->class;
8880 if (class != StaticColor
&& class != StaticGray
&& class != TrueColor
)
8886 /* Try to get an XImage for img->pixmep. */
8887 ximg
= XGetImage (FRAME_X_DISPLAY (f
), img
->pixmap
,
8888 0, 0, img
->width
, img
->height
, ~0, ZPixmap
);
8893 /* Initialize the color table. */
8894 init_color_table ();
8896 /* For each pixel of the image, look its color up in the
8897 color table. After having done so, the color table will
8898 contain an entry for each color used by the image. */
8899 for (y
= 0; y
< img
->height
; ++y
)
8900 for (x
= 0; x
< img
->width
; ++x
)
8902 unsigned long pixel
= XGetPixel (ximg
, x
, y
);
8903 lookup_pixel_color (f
, pixel
);
8906 /* Record colors in the image. Free color table and XImage. */
8907 #ifdef COLOR_TABLE_SUPPORT
8908 img
->colors
= colors_in_color_table (&img
->ncolors
);
8909 free_color_table ();
8911 XDestroyImage (ximg
);
8913 #if 0 /* This doesn't seem to be the case. If we free the colors
8914 here, we get a BadAccess later in x_clear_image when
8915 freeing the colors. */
8916 /* We have allocated colors once, but Ghostscript has also
8917 allocated colors on behalf of us. So, to get the
8918 reference counts right, free them once. */
8920 x_free_colors (f
, img
->colors
, img
->ncolors
);
8924 image_error ("Cannot get X image of `%s'; colors will not be freed",
8929 #endif /* HAVE_X_WINDOWS */
8931 /* Now that we have the pixmap, compute mask and transform the
8932 image if requested. */
8934 postprocess_image (f
, img
);
8938 #endif /* HAVE_GHOSTSCRIPT */
8941 /***********************************************************************
8943 ***********************************************************************/
8947 DEFUN ("imagep", Fimagep
, Simagep
, 1, 1, 0,
8948 doc
: /* Value is non-nil if SPEC is a valid image specification. */)
8951 return valid_image_p (spec
) ? Qt
: Qnil
;
8955 DEFUN ("lookup-image", Flookup_image
, Slookup_image
, 1, 1, 0, "")
8960 if (valid_image_p (spec
))
8961 id
= lookup_image (SELECTED_FRAME (), spec
);
8964 return make_number (id
);
8967 #endif /* GLYPH_DEBUG */
8970 /***********************************************************************
8972 ***********************************************************************/
8974 DEFUN ("init-image-library", Finit_image_library
, Sinit_image_library
, 1, 1, 0,
8975 doc
: /* Initialize image library implementing image type TYPE.
8976 Return non-nil if TYPE is a supported image type.
8978 If image libraries are loaded dynamically (currently only the case on
8979 MS-Windows), load the library for TYPE if it is not yet loaded, using
8980 the library file(s) specified by `dynamic-library-alist'. */)
8983 return lookup_image_type (type
) ? Qt
: Qnil
;
8986 /* Look up image type TYPE, and return a pointer to its image_type
8987 structure. Return 0 if TYPE is not a known image type. */
8989 static struct image_type
*
8990 lookup_image_type (Lisp_Object type
)
8992 /* Types pbm and xbm are built-in and always available. */
8993 if (EQ (type
, Qpbm
))
8994 return define_image_type (&pbm_type
);
8996 if (EQ (type
, Qxbm
))
8997 return define_image_type (&xbm_type
);
8999 #if defined (HAVE_XPM) || defined (HAVE_NS)
9000 if (EQ (type
, Qxpm
))
9001 return define_image_type (&xpm_type
);
9004 #if defined (HAVE_JPEG) || defined (HAVE_NS)
9005 if (EQ (type
, Qjpeg
))
9006 return define_image_type (&jpeg_type
);
9009 #if defined (HAVE_TIFF) || defined (HAVE_NS)
9010 if (EQ (type
, Qtiff
))
9011 return define_image_type (&tiff_type
);
9014 #if defined (HAVE_GIF) || defined (HAVE_NS)
9015 if (EQ (type
, Qgif
))
9016 return define_image_type (&gif_type
);
9019 #if defined (HAVE_PNG) || defined (HAVE_NS)
9020 if (EQ (type
, Qpng
))
9021 return define_image_type (&png_type
);
9024 #if defined (HAVE_RSVG)
9025 if (EQ (type
, Qsvg
))
9026 return define_image_type (&svg_type
);
9029 #if defined (HAVE_IMAGEMAGICK)
9030 if (EQ (type
, Qimagemagick
))
9031 return define_image_type (&imagemagick_type
);
9034 #ifdef HAVE_GHOSTSCRIPT
9035 if (EQ (type
, Qpostscript
))
9036 return define_image_type (&gs_type
);
9042 /* Reset image_types before dumping.
9043 Called from Fdump_emacs. */
9046 reset_image_types (void)
9050 struct image_type
*next
= image_types
->next
;
9051 xfree (image_types
);
9057 syms_of_image (void)
9059 /* Initialize this only once; it will be reset before dumping. */
9062 /* Must be defined now because we're going to update it below, while
9063 defining the supported image types. */
9064 DEFVAR_LISP ("image-types", Vimage_types
,
9065 doc
: /* List of potentially supported image types.
9066 Each element of the list is a symbol for an image type, like 'jpeg or 'png.
9067 To check whether it is really supported, use `image-type-available-p'. */);
9068 Vimage_types
= Qnil
;
9070 DEFVAR_LISP ("max-image-size", Vmax_image_size
,
9071 doc
: /* Maximum size of images.
9072 Emacs will not load an image into memory if its pixel width or
9073 pixel height exceeds this limit.
9075 If the value is an integer, it directly specifies the maximum
9076 image height and width, measured in pixels. If it is a floating
9077 point number, it specifies the maximum image height and width
9078 as a ratio to the frame height and width. If the value is
9079 non-numeric, there is no explicit limit on the size of images. */);
9080 Vmax_image_size
= make_float (MAX_IMAGE_SIZE
);
9082 DEFSYM (Qcount
, "count");
9083 DEFSYM (Qextension_data
, "extension-data");
9084 DEFSYM (Qdelay
, "delay");
9086 DEFSYM (QCascent
, ":ascent");
9087 DEFSYM (QCmargin
, ":margin");
9088 DEFSYM (QCrelief
, ":relief");
9089 DEFSYM (QCconversion
, ":conversion");
9090 DEFSYM (QCcolor_symbols
, ":color-symbols");
9091 DEFSYM (QCheuristic_mask
, ":heuristic-mask");
9092 DEFSYM (QCindex
, ":index");
9093 DEFSYM (QCgeometry
, ":geometry");
9094 DEFSYM (QCcrop
, ":crop");
9095 DEFSYM (QCrotation
, ":rotation");
9096 DEFSYM (QCmatrix
, ":matrix");
9097 DEFSYM (QCcolor_adjustment
, ":color-adjustment");
9098 DEFSYM (QCmask
, ":mask");
9100 DEFSYM (Qlaplace
, "laplace");
9101 DEFSYM (Qemboss
, "emboss");
9102 DEFSYM (Qedge_detection
, "edge-detection");
9103 DEFSYM (Qheuristic
, "heuristic");
9105 DEFSYM (Qpostscript
, "postscript");
9106 DEFSYM (QCmax_width
, ":max-width");
9107 DEFSYM (QCmax_height
, ":max-height");
9108 #ifdef HAVE_GHOSTSCRIPT
9109 ADD_IMAGE_TYPE (Qpostscript
);
9110 DEFSYM (QCloader
, ":loader");
9111 DEFSYM (QCbounding_box
, ":bounding-box");
9112 DEFSYM (QCpt_width
, ":pt-width");
9113 DEFSYM (QCpt_height
, ":pt-height");
9114 #endif /* HAVE_GHOSTSCRIPT */
9117 DEFSYM (Qlibpng_version
, "libpng-version");
9118 Fset (Qlibpng_version
,
9120 make_number (PNG_LIBPNG_VER
)
9127 DEFSYM (Qpbm
, "pbm");
9128 ADD_IMAGE_TYPE (Qpbm
);
9130 DEFSYM (Qxbm
, "xbm");
9131 ADD_IMAGE_TYPE (Qxbm
);
9133 #if defined (HAVE_XPM) || defined (HAVE_NS)
9134 DEFSYM (Qxpm
, "xpm");
9135 ADD_IMAGE_TYPE (Qxpm
);
9138 #if defined (HAVE_JPEG) || defined (HAVE_NS)
9139 DEFSYM (Qjpeg
, "jpeg");
9140 ADD_IMAGE_TYPE (Qjpeg
);
9143 #if defined (HAVE_TIFF) || defined (HAVE_NS)
9144 DEFSYM (Qtiff
, "tiff");
9145 ADD_IMAGE_TYPE (Qtiff
);
9148 #if defined (HAVE_GIF) || defined (HAVE_NS)
9149 DEFSYM (Qgif
, "gif");
9150 ADD_IMAGE_TYPE (Qgif
);
9153 #if defined (HAVE_PNG) || defined (HAVE_NS)
9154 DEFSYM (Qpng
, "png");
9155 ADD_IMAGE_TYPE (Qpng
);
9158 #if defined (HAVE_IMAGEMAGICK)
9159 DEFSYM (Qimagemagick
, "imagemagick");
9160 ADD_IMAGE_TYPE (Qimagemagick
);
9163 #if defined (HAVE_RSVG)
9164 DEFSYM (Qsvg
, "svg");
9165 ADD_IMAGE_TYPE (Qsvg
);
9167 /* Other libraries used directly by svg code. */
9168 DEFSYM (Qgdk_pixbuf
, "gdk-pixbuf");
9169 DEFSYM (Qglib
, "glib");
9170 DEFSYM (Qgobject
, "gobject");
9171 #endif /* HAVE_NTGUI */
9172 #endif /* HAVE_RSVG */
9174 defsubr (&Sinit_image_library
);
9175 #ifdef HAVE_IMAGEMAGICK
9176 defsubr (&Simagemagick_types
);
9178 defsubr (&Sclear_image_cache
);
9179 defsubr (&Simage_flush
);
9180 defsubr (&Simage_size
);
9181 defsubr (&Simage_mask_p
);
9182 defsubr (&Simage_metadata
);
9186 defsubr (&Slookup_image
);
9189 DEFVAR_BOOL ("cross-disabled-images", cross_disabled_images
,
9190 doc
: /* Non-nil means always draw a cross over disabled images.
9191 Disabled images are those having a `:conversion disabled' property.
9192 A cross is always drawn on black & white displays. */);
9193 cross_disabled_images
= 0;
9195 DEFVAR_LISP ("x-bitmap-file-path", Vx_bitmap_file_path
,
9196 doc
: /* List of directories to search for window system bitmap files. */);
9197 Vx_bitmap_file_path
= decode_env_path (0, PATH_BITMAPS
);
9199 DEFVAR_LISP ("image-cache-eviction-delay", Vimage_cache_eviction_delay
,
9200 doc
: /* Maximum time after which images are removed from the cache.
9201 When an image has not been displayed this many seconds, Emacs
9202 automatically removes it from the image cache. If the cache contains
9203 a large number of images, the actual eviction time may be shorter.
9204 The value can also be nil, meaning the cache is never cleared.
9206 The function `clear-image-cache' disregards this variable. */);
9207 Vimage_cache_eviction_delay
= make_number (300);
9208 #ifdef HAVE_IMAGEMAGICK
9209 DEFVAR_INT ("imagemagick-render-type", imagemagick_render_type
,
9210 doc
: /* Integer indicating which ImageMagick rendering method to use.
9212 0 -- the default method (pixel pushing)
9213 1 -- a newer method ("MagickExportImagePixels") that may perform
9214 better (speed etc) in some cases, but has not been as thoroughly
9215 tested with Emacs as the default method. This method requires
9216 ImageMagick version 6.4.6 (approximately) or later.
9218 /* MagickExportImagePixels is in 6.4.6-9, but not 6.4.4-10. */
9219 imagemagick_render_type
= 0;