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 (FRAME_PTR f
, ptrdiff_t id
)
169 return FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].height
;
173 x_bitmap_width (FRAME_PTR 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 (FRAME_PTR 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 (FRAME_PTR 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 (FRAME_PTR 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 (FRAME_PTR 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
;
322 /* Look for an existing bitmap with the same name. */
323 for (id
= 0; id
< dpyinfo
->bitmaps_last
; ++id
)
325 if (dpyinfo
->bitmaps
[id
].refcount
326 && dpyinfo
->bitmaps
[id
].file
327 && !strcmp (dpyinfo
->bitmaps
[id
].file
, SSDATA (file
)))
329 ++dpyinfo
->bitmaps
[id
].refcount
;
334 /* Search bitmap-file-path for the file, if appropriate. */
335 fd
= openp (Vx_bitmap_file_path
, file
, Qnil
, &found
, Qnil
);
340 filename
= SSDATA (found
);
342 result
= XReadBitmapFile (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
343 filename
, &width
, &height
, &bitmap
, &xhot
, &yhot
);
344 if (result
!= BitmapSuccess
)
347 id
= x_allocate_bitmap_record (f
);
348 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
349 dpyinfo
->bitmaps
[id
- 1].have_mask
= 0;
350 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
351 dpyinfo
->bitmaps
[id
- 1].file
= xmalloc (SBYTES (file
) + 1);
352 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
353 dpyinfo
->bitmaps
[id
- 1].height
= height
;
354 dpyinfo
->bitmaps
[id
- 1].width
= width
;
355 strcpy (dpyinfo
->bitmaps
[id
- 1].file
, SSDATA (file
));
358 #endif /* HAVE_X_WINDOWS */
364 free_bitmap_record (Display_Info
*dpyinfo
, Bitmap_Record
*bm
)
366 #ifdef HAVE_X_WINDOWS
367 XFreePixmap (dpyinfo
->display
, bm
->pixmap
);
369 XFreePixmap (dpyinfo
->display
, bm
->mask
);
370 #endif /* HAVE_X_WINDOWS */
373 DeleteObject (bm
->pixmap
);
374 #endif /* HAVE_NTGUI */
377 ns_release_object (bm
->img
);
387 /* Remove reference to bitmap with id number ID. */
390 x_destroy_bitmap (FRAME_PTR f
, ptrdiff_t id
)
392 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
396 Bitmap_Record
*bm
= &dpyinfo
->bitmaps
[id
- 1];
398 if (--bm
->refcount
== 0)
401 free_bitmap_record (dpyinfo
, bm
);
407 /* Free all the bitmaps for the display specified by DPYINFO. */
410 x_destroy_all_bitmaps (Display_Info
*dpyinfo
)
413 Bitmap_Record
*bm
= dpyinfo
->bitmaps
;
415 for (i
= 0; i
< dpyinfo
->bitmaps_last
; i
++, bm
++)
416 if (bm
->refcount
> 0)
417 free_bitmap_record (dpyinfo
, bm
);
419 dpyinfo
->bitmaps_last
= 0;
422 static bool x_create_x_image_and_pixmap (struct frame
*, int, int, int,
423 XImagePtr
*, Pixmap
*);
424 static void x_destroy_x_image (XImagePtr ximg
);
427 static XImagePtr_or_DC
image_get_x_image_or_dc (struct frame
*, struct image
*,
429 static void image_unget_x_image_or_dc (struct image
*, bool, XImagePtr_or_DC
,
432 static XImagePtr
image_get_x_image (struct frame
*, struct image
*, bool);
433 static void image_unget_x_image (struct image
*, bool, XImagePtr
);
434 #define image_get_x_image_or_dc(f, img, mask_p, dummy) \
435 image_get_x_image (f, img, mask_p)
436 #define image_unget_x_image_or_dc(img, mask_p, ximg, dummy) \
437 image_unget_x_image (img, mask_p, ximg)
440 #ifdef HAVE_X_WINDOWS
442 static void image_sync_to_pixmaps (struct frame
*, struct image
*);
444 /* Useful functions defined in the section
445 `Image type independent image structures' below. */
447 static unsigned long four_corners_best (XImagePtr ximg
,
450 unsigned long height
);
453 /* Create a mask of a bitmap. Note is this not a perfect mask.
454 It's nicer with some borders in this context */
457 x_create_bitmap_mask (struct frame
*f
, ptrdiff_t id
)
460 XImagePtr ximg
, mask_img
;
461 unsigned long width
, height
;
464 unsigned long x
, y
, xp
, xm
, yp
, ym
;
467 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
472 pixmap
= x_bitmap_pixmap (f
, id
);
473 width
= x_bitmap_width (f
, id
);
474 height
= x_bitmap_height (f
, id
);
477 ximg
= XGetImage (FRAME_X_DISPLAY (f
), pixmap
, 0, 0, width
, height
,
486 result
= x_create_x_image_and_pixmap (f
, width
, height
, 1, &mask_img
, &mask
);
491 XDestroyImage (ximg
);
495 bg
= four_corners_best (ximg
, NULL
, width
, height
);
497 for (y
= 0; y
< ximg
->height
; ++y
)
499 for (x
= 0; x
< ximg
->width
; ++x
)
501 xp
= x
!= ximg
->width
- 1 ? x
+ 1 : 0;
502 xm
= x
!= 0 ? x
- 1 : ximg
->width
- 1;
503 yp
= y
!= ximg
->height
- 1 ? y
+ 1 : 0;
504 ym
= y
!= 0 ? y
- 1 : ximg
->height
- 1;
505 if (XGetPixel (ximg
, x
, y
) == bg
506 && XGetPixel (ximg
, x
, yp
) == bg
507 && XGetPixel (ximg
, x
, ym
) == bg
508 && XGetPixel (ximg
, xp
, y
) == bg
509 && XGetPixel (ximg
, xp
, yp
) == bg
510 && XGetPixel (ximg
, xp
, ym
) == bg
511 && XGetPixel (ximg
, xm
, y
) == bg
512 && XGetPixel (ximg
, xm
, yp
) == bg
513 && XGetPixel (ximg
, xm
, ym
) == bg
)
514 XPutPixel (mask_img
, x
, y
, 0);
516 XPutPixel (mask_img
, x
, y
, 1);
520 eassert (input_blocked_p ());
521 gc
= XCreateGC (FRAME_X_DISPLAY (f
), mask
, 0, NULL
);
522 XPutImage (FRAME_X_DISPLAY (f
), mask
, gc
, mask_img
, 0, 0, 0, 0,
524 XFreeGC (FRAME_X_DISPLAY (f
), gc
);
526 dpyinfo
->bitmaps
[id
- 1].have_mask
= 1;
527 dpyinfo
->bitmaps
[id
- 1].mask
= mask
;
529 XDestroyImage (ximg
);
530 x_destroy_x_image (mask_img
);
533 #endif /* HAVE_X_WINDOWS */
536 /***********************************************************************
538 ***********************************************************************/
540 /* List of supported image types. Use define_image_type to add new
541 types. Use lookup_image_type to find a type for a given symbol. */
543 static struct image_type
*image_types
;
545 /* The symbol `xbm' which is used as the type symbol for XBM images. */
547 static Lisp_Object Qxbm
;
551 Lisp_Object QCascent
, QCmargin
, QCrelief
;
552 Lisp_Object QCconversion
;
553 static Lisp_Object QCheuristic_mask
;
554 static Lisp_Object QCcolor_symbols
;
555 static Lisp_Object QCindex
, QCmatrix
, QCcolor_adjustment
, QCmask
, QCgeometry
;
556 static Lisp_Object QCcrop
, QCrotation
;
560 static Lisp_Object Qcount
, Qextension_data
, Qdelay
;
561 static Lisp_Object Qlaplace
, Qemboss
, Qedge_detection
, Qheuristic
;
563 /* Forward function prototypes. */
565 static struct image_type
*lookup_image_type (Lisp_Object
);
566 static void x_laplace (struct frame
*, struct image
*);
567 static void x_emboss (struct frame
*, struct image
*);
568 static void x_build_heuristic_mask (struct frame
*, struct image
*,
571 extern Lisp_Object Vlibrary_cache
;
572 #define CACHE_IMAGE_TYPE(type, status) \
573 do { Vlibrary_cache = Fcons (Fcons (type, status), Vlibrary_cache); } while (0)
575 #define CACHE_IMAGE_TYPE(type, status)
578 #define ADD_IMAGE_TYPE(type) \
579 do { Vimage_types = Fcons (type, Vimage_types); } while (0)
581 /* Define a new image type from TYPE. This adds a copy of TYPE to
582 image_types and caches the loading status of TYPE. */
584 static struct image_type
*
585 define_image_type (struct image_type
*type
)
587 struct image_type
*p
= NULL
;
588 Lisp_Object target_type
= *type
->type
;
593 for (p
= image_types
; p
; p
= p
->next
)
594 if (EQ (*p
->type
, target_type
))
599 #if defined HAVE_NTGUI && defined WINDOWSNT
600 /* If we failed to load the library before, don't try again. */
601 Lisp_Object tested
= Fassq (target_type
, Vlibrary_cache
);
602 if (CONSP (tested
) && NILP (XCDR (tested
)))
607 type_valid
= type
->init ();
608 CACHE_IMAGE_TYPE (target_type
, type_valid
? Qt
: Qnil
);
614 /* Make a copy of TYPE to avoid a bus error in a dumped Emacs.
615 The initialized data segment is read-only. */
616 p
= xmalloc (sizeof *p
);
618 p
->next
= image_types
;
628 /* Value is true if OBJECT is a valid Lisp image specification. A
629 valid image specification is a list whose car is the symbol
630 `image', and whose rest is a property list. The property list must
631 contain a value for key `:type'. That value must be the name of a
632 supported image type. The rest of the property list depends on the
636 valid_image_p (Lisp_Object object
)
644 for (tem
= XCDR (object
); CONSP (tem
); tem
= XCDR (tem
))
645 if (EQ (XCAR (tem
), QCtype
))
648 if (CONSP (tem
) && SYMBOLP (XCAR (tem
)))
650 struct image_type
*type
;
651 type
= lookup_image_type (XCAR (tem
));
653 valid_p
= type
->valid_p (object
);
664 /* Log error message with format string FORMAT and argument ARG.
665 Signaling an error, e.g. when an image cannot be loaded, is not a
666 good idea because this would interrupt redisplay, and the error
667 message display would lead to another redisplay. This function
668 therefore simply displays a message. */
671 image_error (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
673 add_to_log (format
, arg1
, arg2
);
678 /***********************************************************************
680 ***********************************************************************/
682 enum image_value_type
684 IMAGE_DONT_CHECK_VALUE_TYPE
,
686 IMAGE_STRING_OR_NIL_VALUE
,
688 IMAGE_POSITIVE_INTEGER_VALUE
,
689 IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
,
690 IMAGE_NON_NEGATIVE_INTEGER_VALUE
,
693 IMAGE_FUNCTION_VALUE
,
698 /* Structure used when parsing image specifications. */
702 /* Name of keyword. */
705 /* The type of value allowed. */
706 enum image_value_type type
;
708 /* True means key must be present. */
711 /* Used to recognize duplicate keywords in a property list. */
714 /* The value that was found. */
719 /* Parse image spec SPEC according to KEYWORDS. A valid image spec
720 has the format (image KEYWORD VALUE ...). One of the keyword/
721 value pairs must be `:type TYPE'. KEYWORDS is a vector of
722 image_keywords structures of size NKEYWORDS describing other
723 allowed keyword/value pairs. Value is true if SPEC is valid. */
726 parse_image_spec (Lisp_Object spec
, struct image_keyword
*keywords
,
727 int nkeywords
, Lisp_Object type
)
736 while (CONSP (plist
))
738 Lisp_Object key
, value
;
740 /* First element of a pair must be a symbol. */
742 plist
= XCDR (plist
);
746 /* There must follow a value. */
749 value
= XCAR (plist
);
750 plist
= XCDR (plist
);
752 /* Find key in KEYWORDS. Error if not found. */
753 for (i
= 0; i
< nkeywords
; ++i
)
754 if (strcmp (keywords
[i
].name
, SSDATA (SYMBOL_NAME (key
))) == 0)
760 /* Record that we recognized the keyword. If a keywords
761 was found more than once, it's an error. */
762 keywords
[i
].value
= value
;
763 if (keywords
[i
].count
> 1)
767 /* Check type of value against allowed type. */
768 switch (keywords
[i
].type
)
770 case IMAGE_STRING_VALUE
:
771 if (!STRINGP (value
))
775 case IMAGE_STRING_OR_NIL_VALUE
:
776 if (!STRINGP (value
) && !NILP (value
))
780 case IMAGE_SYMBOL_VALUE
:
781 if (!SYMBOLP (value
))
785 case IMAGE_POSITIVE_INTEGER_VALUE
:
786 if (! RANGED_INTEGERP (1, value
, INT_MAX
))
790 case IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
:
791 if (RANGED_INTEGERP (0, value
, INT_MAX
))
794 && RANGED_INTEGERP (0, XCAR (value
), INT_MAX
)
795 && RANGED_INTEGERP (0, XCDR (value
), INT_MAX
))
799 case IMAGE_ASCENT_VALUE
:
800 if (SYMBOLP (value
) && EQ (value
, Qcenter
))
802 else if (RANGED_INTEGERP (0, value
, 100))
806 case IMAGE_NON_NEGATIVE_INTEGER_VALUE
:
807 /* Unlike the other integer-related cases, this one does not
808 verify that VALUE fits in 'int'. This is because callers
810 if (!INTEGERP (value
) || XINT (value
) < 0)
814 case IMAGE_DONT_CHECK_VALUE_TYPE
:
817 case IMAGE_FUNCTION_VALUE
:
818 value
= indirect_function (value
);
819 if (!NILP (Ffunctionp (value
)))
823 case IMAGE_NUMBER_VALUE
:
824 if (!INTEGERP (value
) && !FLOATP (value
))
828 case IMAGE_INTEGER_VALUE
:
829 if (! TYPE_RANGED_INTEGERP (int, value
))
833 case IMAGE_BOOL_VALUE
:
834 if (!NILP (value
) && !EQ (value
, Qt
))
843 if (EQ (key
, QCtype
) && !EQ (type
, value
))
847 /* Check that all mandatory fields are present. */
848 for (i
= 0; i
< nkeywords
; ++i
)
849 if (keywords
[i
].mandatory_p
&& keywords
[i
].count
== 0)
856 /* Return the value of KEY in image specification SPEC. Value is nil
857 if KEY is not present in SPEC. Set *FOUND depending on whether KEY
858 was found in SPEC. */
861 image_spec_value (Lisp_Object spec
, Lisp_Object key
, bool *found
)
865 eassert (valid_image_p (spec
));
867 for (tail
= XCDR (spec
);
868 CONSP (tail
) && CONSP (XCDR (tail
));
869 tail
= XCDR (XCDR (tail
)))
871 if (EQ (XCAR (tail
), key
))
875 return XCAR (XCDR (tail
));
885 DEFUN ("image-size", Fimage_size
, Simage_size
, 1, 3, 0,
886 doc
: /* Return the size of image SPEC as pair (WIDTH . HEIGHT).
887 PIXELS non-nil means return the size in pixels, otherwise return the
888 size in canonical character units.
889 FRAME is the frame on which the image will be displayed. FRAME nil
890 or omitted means use the selected frame. */)
891 (Lisp_Object spec
, Lisp_Object pixels
, Lisp_Object frame
)
896 if (valid_image_p (spec
))
898 struct frame
*f
= decode_window_system_frame (frame
);
899 ptrdiff_t id
= lookup_image (f
, spec
);
900 struct image
*img
= IMAGE_FROM_ID (f
, id
);
901 int width
= img
->width
+ 2 * img
->hmargin
;
902 int height
= img
->height
+ 2 * img
->vmargin
;
905 size
= Fcons (make_float ((double) width
/ FRAME_COLUMN_WIDTH (f
)),
906 make_float ((double) height
/ FRAME_LINE_HEIGHT (f
)));
908 size
= Fcons (make_number (width
), make_number (height
));
911 error ("Invalid image specification");
917 DEFUN ("image-mask-p", Fimage_mask_p
, Simage_mask_p
, 1, 2, 0,
918 doc
: /* Return t if image SPEC has a mask bitmap.
919 FRAME is the frame on which the image will be displayed. FRAME nil
920 or omitted means use the selected frame. */)
921 (Lisp_Object spec
, Lisp_Object frame
)
926 if (valid_image_p (spec
))
928 struct frame
*f
= decode_window_system_frame (frame
);
929 ptrdiff_t id
= lookup_image (f
, spec
);
930 struct image
*img
= IMAGE_FROM_ID (f
, id
);
935 error ("Invalid image specification");
940 DEFUN ("image-metadata", Fimage_metadata
, Simage_metadata
, 1, 2, 0,
941 doc
: /* Return metadata for image SPEC.
942 FRAME is the frame on which the image will be displayed. FRAME nil
943 or omitted means use the selected frame. */)
944 (Lisp_Object spec
, Lisp_Object frame
)
949 if (valid_image_p (spec
))
951 struct frame
*f
= decode_window_system_frame (frame
);
952 ptrdiff_t id
= lookup_image (f
, spec
);
953 struct image
*img
= IMAGE_FROM_ID (f
, id
);
954 ext
= img
->lisp_data
;
961 /***********************************************************************
962 Image type independent image structures
963 ***********************************************************************/
965 #define MAX_IMAGE_SIZE 10.0
966 /* Allocate and return a new image structure for image specification
967 SPEC. SPEC has a hash value of HASH. */
969 static struct image
*
970 make_image (Lisp_Object spec
, EMACS_UINT hash
)
972 struct image
*img
= xzalloc (sizeof *img
);
973 Lisp_Object file
= image_spec_value (spec
, QCfile
, NULL
);
975 eassert (valid_image_p (spec
));
976 img
->dependencies
= NILP (file
) ? Qnil
: list1 (file
);
977 img
->type
= lookup_image_type (image_spec_value (spec
, QCtype
, NULL
));
978 eassert (img
->type
!= NULL
);
980 img
->lisp_data
= Qnil
;
981 img
->ascent
= DEFAULT_IMAGE_ASCENT
;
983 img
->corners
[BOT_CORNER
] = -1; /* Full image */
988 /* Free image IMG which was used on frame F, including its resources. */
991 free_image (struct frame
*f
, struct image
*img
)
995 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
997 /* Remove IMG from the hash table of its cache. */
999 img
->prev
->next
= img
->next
;
1001 c
->buckets
[img
->hash
% IMAGE_CACHE_BUCKETS_SIZE
] = img
->next
;
1004 img
->next
->prev
= img
->prev
;
1006 c
->images
[img
->id
] = NULL
;
1008 /* Free resources, then free IMG. */
1009 img
->type
->free (f
, img
);
1014 /* Return true if the given widths and heights are valid for display. */
1017 check_image_size (struct frame
*f
, int width
, int height
)
1021 if (width
<= 0 || height
<= 0)
1024 if (INTEGERP (Vmax_image_size
))
1025 return (width
<= XINT (Vmax_image_size
)
1026 && height
<= XINT (Vmax_image_size
));
1027 else if (FLOATP (Vmax_image_size
))
1031 w
= FRAME_PIXEL_WIDTH (f
);
1032 h
= FRAME_PIXEL_HEIGHT (f
);
1035 w
= h
= 1024; /* Arbitrary size for unknown frame. */
1036 return (width
<= XFLOAT_DATA (Vmax_image_size
) * w
1037 && height
<= XFLOAT_DATA (Vmax_image_size
) * h
);
1043 /* Prepare image IMG for display on frame F. Must be called before
1044 drawing an image. */
1047 prepare_image_for_display (struct frame
*f
, struct image
*img
)
1049 /* We're about to display IMG, so set its timestamp to `now'. */
1050 img
->timestamp
= current_emacs_time ();
1052 /* If IMG doesn't have a pixmap yet, load it now, using the image
1053 type dependent loader function. */
1054 if (img
->pixmap
== NO_PIXMAP
&& !img
->load_failed_p
)
1055 img
->load_failed_p
= ! img
->type
->load (f
, img
);
1057 #ifdef HAVE_X_WINDOWS
1058 if (!img
->load_failed_p
)
1061 image_sync_to_pixmaps (f
, img
);
1068 /* Value is the number of pixels for the ascent of image IMG when
1069 drawn in face FACE. */
1072 image_ascent (struct image
*img
, struct face
*face
, struct glyph_slice
*slice
)
1077 if (slice
->height
== img
->height
)
1078 height
= img
->height
+ img
->vmargin
;
1079 else if (slice
->y
== 0)
1080 height
= slice
->height
+ img
->vmargin
;
1082 height
= slice
->height
;
1084 if (img
->ascent
== CENTERED_IMAGE_ASCENT
)
1089 /* W32 specific version. Why?. ++kfs */
1090 ascent
= height
/ 2 - (FONT_DESCENT (face
->font
)
1091 - FONT_BASE (face
->font
)) / 2;
1093 /* This expression is arranged so that if the image can't be
1094 exactly centered, it will be moved slightly up. This is
1095 because a typical font is `top-heavy' (due to the presence
1096 uppercase letters), so the image placement should err towards
1097 being top-heavy too. It also just generally looks better. */
1098 ascent
= (height
+ FONT_BASE (face
->font
)
1099 - FONT_DESCENT (face
->font
) + 1) / 2;
1100 #endif /* HAVE_NTGUI */
1103 ascent
= height
/ 2;
1106 ascent
= height
* (img
->ascent
/ 100.0);
1112 /* Image background colors. */
1114 /* Find the "best" corner color of a bitmap.
1115 On W32, XIMG is assumed to a device context with the bitmap selected. */
1117 static RGB_PIXEL_COLOR
1118 four_corners_best (XImagePtr_or_DC ximg
, int *corners
,
1119 unsigned long width
, unsigned long height
)
1121 RGB_PIXEL_COLOR corner_pixels
[4], best
IF_LINT (= 0);
1124 if (corners
&& corners
[BOT_CORNER
] >= 0)
1126 /* Get the colors at the corner_pixels of ximg. */
1127 corner_pixels
[0] = GET_PIXEL (ximg
, corners
[LEFT_CORNER
], corners
[TOP_CORNER
]);
1128 corner_pixels
[1] = GET_PIXEL (ximg
, corners
[RIGHT_CORNER
] - 1, corners
[TOP_CORNER
]);
1129 corner_pixels
[2] = GET_PIXEL (ximg
, corners
[RIGHT_CORNER
] - 1, corners
[BOT_CORNER
] - 1);
1130 corner_pixels
[3] = GET_PIXEL (ximg
, corners
[LEFT_CORNER
], corners
[BOT_CORNER
] - 1);
1134 /* Get the colors at the corner_pixels of ximg. */
1135 corner_pixels
[0] = GET_PIXEL (ximg
, 0, 0);
1136 corner_pixels
[1] = GET_PIXEL (ximg
, width
- 1, 0);
1137 corner_pixels
[2] = GET_PIXEL (ximg
, width
- 1, height
- 1);
1138 corner_pixels
[3] = GET_PIXEL (ximg
, 0, height
- 1);
1140 /* Choose the most frequently found color as background. */
1141 for (i
= best_count
= 0; i
< 4; ++i
)
1145 for (j
= n
= 0; j
< 4; ++j
)
1146 if (corner_pixels
[i
] == corner_pixels
[j
])
1150 best
= corner_pixels
[i
], best_count
= n
;
1156 /* Portability macros */
1160 #define Free_Pixmap(display, pixmap) \
1161 DeleteObject (pixmap)
1163 #elif defined (HAVE_NS)
1165 #define Free_Pixmap(display, pixmap) \
1166 ns_release_object (pixmap)
1170 #define Free_Pixmap(display, pixmap) \
1171 XFreePixmap (display, pixmap)
1173 #endif /* !HAVE_NTGUI && !HAVE_NS */
1176 /* Return the `background' field of IMG. If IMG doesn't have one yet,
1177 it is guessed heuristically. If non-zero, XIMG is an existing
1178 XImage object (or device context with the image selected on W32) to
1179 use for the heuristic. */
1182 image_background (struct image
*img
, struct frame
*f
, XImagePtr_or_DC ximg
)
1184 if (! img
->background_valid
)
1185 /* IMG doesn't have a background yet, try to guess a reasonable value. */
1187 bool free_ximg
= !ximg
;
1190 #endif /* HAVE_NTGUI */
1193 ximg
= image_get_x_image_or_dc (f
, img
, 0, &prev
);
1195 img
->background
= four_corners_best (ximg
, img
->corners
, img
->width
, img
->height
);
1198 image_unget_x_image_or_dc (img
, 0, ximg
, prev
);
1200 img
->background_valid
= 1;
1203 return img
->background
;
1206 /* Return the `background_transparent' field of IMG. If IMG doesn't
1207 have one yet, it is guessed heuristically. If non-zero, MASK is an
1208 existing XImage object to use for the heuristic. */
1211 image_background_transparent (struct image
*img
, struct frame
*f
, XImagePtr_or_DC mask
)
1213 if (! img
->background_transparent_valid
)
1214 /* IMG doesn't have a background yet, try to guess a reasonable value. */
1218 bool free_mask
= !mask
;
1221 #endif /* HAVE_NTGUI */
1224 mask
= image_get_x_image_or_dc (f
, img
, 1, &prev
);
1226 img
->background_transparent
1227 = (four_corners_best (mask
, img
->corners
, img
->width
, img
->height
) == PIX_MASK_RETAIN
);
1230 image_unget_x_image_or_dc (img
, 1, mask
, prev
);
1233 img
->background_transparent
= 0;
1235 img
->background_transparent_valid
= 1;
1238 return img
->background_transparent
;
1242 /***********************************************************************
1243 Helper functions for X image types
1244 ***********************************************************************/
1246 /* Clear X resources of image IMG on frame F according to FLAGS.
1247 FLAGS is bitwise-or of the following masks:
1248 CLEAR_IMAGE_PIXMAP free the pixmap if any.
1249 CLEAR_IMAGE_MASK means clear the mask pixmap if any.
1250 CLEAR_IMAGE_COLORS means free colors allocated for the image, if
1253 #define CLEAR_IMAGE_PIXMAP (1 << 0)
1254 #define CLEAR_IMAGE_MASK (1 << 1)
1255 #define CLEAR_IMAGE_COLORS (1 << 2)
1258 x_clear_image_1 (struct frame
*f
, struct image
*img
, int flags
)
1260 if (flags
& CLEAR_IMAGE_PIXMAP
)
1264 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->pixmap
);
1265 img
->pixmap
= NO_PIXMAP
;
1266 /* NOTE (HAVE_NS): background color is NOT an indexed color! */
1267 img
->background_valid
= 0;
1269 #ifdef HAVE_X_WINDOWS
1272 x_destroy_x_image (img
->ximg
);
1274 img
->background_valid
= 0;
1279 if (flags
& CLEAR_IMAGE_MASK
)
1283 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->mask
);
1284 img
->mask
= NO_PIXMAP
;
1285 img
->background_transparent_valid
= 0;
1287 #ifdef HAVE_X_WINDOWS
1290 x_destroy_x_image (img
->mask_img
);
1291 img
->mask_img
= NULL
;
1292 img
->background_transparent_valid
= 0;
1297 if ((flags
& CLEAR_IMAGE_COLORS
) && img
->ncolors
)
1299 /* W32_TODO: color table support. */
1300 #ifdef HAVE_X_WINDOWS
1301 x_free_colors (f
, img
->colors
, img
->ncolors
);
1302 #endif /* HAVE_X_WINDOWS */
1303 xfree (img
->colors
);
1310 /* Free X resources of image IMG which is used on frame F. */
1313 x_clear_image (struct frame
*f
, struct image
*img
)
1316 x_clear_image_1 (f
, img
,
1317 CLEAR_IMAGE_PIXMAP
| CLEAR_IMAGE_MASK
| CLEAR_IMAGE_COLORS
);
1322 /* Allocate color COLOR_NAME for image IMG on frame F. If color
1323 cannot be allocated, use DFLT. Add a newly allocated color to
1324 IMG->colors, so that it can be freed again. Value is the pixel
1327 static unsigned long
1328 x_alloc_image_color (struct frame
*f
, struct image
*img
, Lisp_Object color_name
,
1332 unsigned long result
;
1334 eassert (STRINGP (color_name
));
1336 if (x_defined_color (f
, SSDATA (color_name
), &color
, 1)
1337 && img
->ncolors
< min (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *img
->colors
,
1340 /* This isn't called frequently so we get away with simply
1341 reallocating the color vector to the needed size, here. */
1342 ptrdiff_t ncolors
= img
->ncolors
+ 1;
1343 img
->colors
= xrealloc (img
->colors
, ncolors
* sizeof *img
->colors
);
1344 img
->colors
[ncolors
- 1] = color
.pixel
;
1345 img
->ncolors
= ncolors
;
1346 result
= color
.pixel
;
1356 /***********************************************************************
1358 ***********************************************************************/
1360 static void cache_image (struct frame
*f
, struct image
*img
);
1362 /* Return a new, initialized image cache that is allocated from the
1363 heap. Call free_image_cache to free an image cache. */
1365 struct image_cache
*
1366 make_image_cache (void)
1368 struct image_cache
*c
= xzalloc (sizeof *c
);
1372 c
->images
= xmalloc (size
* sizeof *c
->images
);
1374 size
= IMAGE_CACHE_BUCKETS_SIZE
* sizeof *c
->buckets
;
1375 c
->buckets
= xzalloc (size
);
1380 /* Find an image matching SPEC in the cache, and return it. If no
1381 image is found, return NULL. */
1382 static struct image
*
1383 search_image_cache (struct frame
*f
, Lisp_Object spec
, EMACS_UINT hash
)
1386 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1387 int i
= hash
% IMAGE_CACHE_BUCKETS_SIZE
;
1389 if (!c
) return NULL
;
1391 /* If the image spec does not specify a background color, the cached
1392 image must have the same background color as the current frame.
1393 The foreground color must also match, for the sake of monochrome
1396 In fact, we could ignore the foreground color matching condition
1397 for color images, or if the image spec specifies :foreground;
1398 similarly we could ignore the background color matching condition
1399 for formats that don't use transparency (such as jpeg), or if the
1400 image spec specifies :background. However, the extra memory
1401 usage is probably negligible in practice, so we don't bother. */
1403 for (img
= c
->buckets
[i
]; img
; img
= img
->next
)
1404 if (img
->hash
== hash
1405 && !NILP (Fequal (img
->spec
, spec
))
1406 && img
->frame_foreground
== FRAME_FOREGROUND_PIXEL (f
)
1407 && img
->frame_background
== FRAME_BACKGROUND_PIXEL (f
))
1413 /* Search frame F for an image with spec SPEC, and free it. */
1416 uncache_image (struct frame
*f
, Lisp_Object spec
)
1418 struct image
*img
= search_image_cache (f
, spec
, sxhash (spec
, 0));
1421 free_image (f
, img
);
1422 /* As display glyphs may still be referring to the image ID, we
1423 must garbage the frame (Bug#6426). */
1424 SET_FRAME_GARBAGED (f
);
1429 /* Free image cache of frame F. Be aware that X frames share images
1433 free_image_cache (struct frame
*f
)
1435 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1440 /* Cache should not be referenced by any frame when freed. */
1441 eassert (c
->refcount
== 0);
1443 for (i
= 0; i
< c
->used
; ++i
)
1444 free_image (f
, c
->images
[i
]);
1448 FRAME_IMAGE_CACHE (f
) = NULL
;
1453 /* Clear image cache of frame F. FILTER=t means free all images.
1454 FILTER=nil means clear only images that haven't been
1455 displayed for some time.
1456 Else, only free the images which have FILTER in their `dependencies'.
1457 Should be called from time to time to reduce the number of loaded images.
1458 If image-cache-eviction-delay is non-nil, this frees images in the cache
1459 which weren't displayed for at least that many seconds. */
1462 clear_image_cache (struct frame
*f
, Lisp_Object filter
)
1464 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1468 ptrdiff_t i
, nfreed
= 0;
1470 /* Block input so that we won't be interrupted by a SIGIO
1471 while being in an inconsistent state. */
1476 /* Filter image cache. */
1477 for (i
= 0; i
< c
->used
; ++i
)
1479 struct image
*img
= c
->images
[i
];
1480 if (img
&& (EQ (Qt
, filter
)
1481 || !NILP (Fmember (filter
, img
->dependencies
))))
1483 free_image (f
, img
);
1488 else if (INTEGERP (Vimage_cache_eviction_delay
))
1490 /* Free cache based on timestamp. */
1493 ptrdiff_t nimages
= 0;
1495 for (i
= 0; i
< c
->used
; ++i
)
1499 /* If the number of cached images has grown unusually large,
1500 decrease the cache eviction delay (Bug#6230). */
1501 delay
= XINT (Vimage_cache_eviction_delay
);
1503 delay
= 1600 * delay
/ nimages
/ nimages
;
1504 delay
= max (delay
, 1);
1506 t
= current_emacs_time ();
1507 old
= sub_emacs_time (t
, EMACS_TIME_FROM_DOUBLE (delay
));
1509 for (i
= 0; i
< c
->used
; ++i
)
1511 struct image
*img
= c
->images
[i
];
1512 if (img
&& EMACS_TIME_LT (img
->timestamp
, old
))
1514 free_image (f
, img
);
1520 /* We may be clearing the image cache because, for example,
1521 Emacs was iconified for a longer period of time. In that
1522 case, current matrices may still contain references to
1523 images freed above. So, clear these matrices. */
1526 Lisp_Object tail
, frame
;
1528 FOR_EACH_FRAME (tail
, frame
)
1530 struct frame
*fr
= XFRAME (frame
);
1531 if (FRAME_IMAGE_CACHE (fr
) == c
)
1532 clear_current_matrices (fr
);
1535 ++windows_or_buffers_changed
;
1543 clear_image_caches (Lisp_Object filter
)
1545 /* FIXME: We want to do
1546 * struct terminal *t;
1547 * for (t = terminal_list; t; t = t->next_terminal)
1548 * clear_image_cache (t, filter); */
1549 Lisp_Object tail
, frame
;
1550 FOR_EACH_FRAME (tail
, frame
)
1551 if (FRAME_WINDOW_P (XFRAME (frame
)))
1552 clear_image_cache (XFRAME (frame
), filter
);
1555 DEFUN ("clear-image-cache", Fclear_image_cache
, Sclear_image_cache
,
1557 doc
: /* Clear the image cache.
1558 FILTER nil or a frame means clear all images in the selected frame.
1559 FILTER t means clear the image caches of all frames.
1560 Anything else, means only clear those images which refer to FILTER,
1561 which is then usually a filename. */)
1562 (Lisp_Object filter
)
1564 if (!(EQ (filter
, Qnil
) || FRAMEP (filter
)))
1565 clear_image_caches (filter
);
1567 clear_image_cache (decode_window_system_frame (filter
), Qt
);
1573 DEFUN ("image-flush", Fimage_flush
, Simage_flush
,
1575 doc
: /* Fush the image with specification SPEC on frame FRAME.
1576 This removes the image from the Emacs image cache. If SPEC specifies
1577 an image file, the next redisplay of this image will read from the
1578 current contents of that file.
1580 FRAME nil or omitted means use the selected frame.
1581 FRAME t means refresh the image on all frames. */)
1582 (Lisp_Object spec
, Lisp_Object frame
)
1584 if (!valid_image_p (spec
))
1585 error ("Invalid image specification");
1590 FOR_EACH_FRAME (tail
, frame
)
1592 struct frame
*f
= XFRAME (frame
);
1593 if (FRAME_WINDOW_P (f
))
1594 uncache_image (f
, spec
);
1598 uncache_image (decode_window_system_frame (frame
), spec
);
1604 /* Compute masks and transform image IMG on frame F, as specified
1605 by the image's specification, */
1608 postprocess_image (struct frame
*f
, struct image
*img
)
1610 /* Manipulation of the image's mask. */
1613 Lisp_Object conversion
, spec
;
1618 /* `:heuristic-mask t'
1620 means build a mask heuristically.
1621 `:heuristic-mask (R G B)'
1622 `:mask (heuristic (R G B))'
1623 means build a mask from color (R G B) in the
1626 means remove a mask, if any. */
1628 mask
= image_spec_value (spec
, QCheuristic_mask
, NULL
);
1630 x_build_heuristic_mask (f
, img
, mask
);
1635 mask
= image_spec_value (spec
, QCmask
, &found_p
);
1637 if (EQ (mask
, Qheuristic
))
1638 x_build_heuristic_mask (f
, img
, Qt
);
1639 else if (CONSP (mask
)
1640 && EQ (XCAR (mask
), Qheuristic
))
1642 if (CONSP (XCDR (mask
)))
1643 x_build_heuristic_mask (f
, img
, XCAR (XCDR (mask
)));
1645 x_build_heuristic_mask (f
, img
, XCDR (mask
));
1647 else if (NILP (mask
) && found_p
&& img
->mask
)
1648 x_clear_image_1 (f
, img
, CLEAR_IMAGE_MASK
);
1652 /* Should we apply an image transformation algorithm? */
1653 conversion
= image_spec_value (spec
, QCconversion
, NULL
);
1654 if (EQ (conversion
, Qdisabled
))
1655 x_disable_image (f
, img
);
1656 else if (EQ (conversion
, Qlaplace
))
1658 else if (EQ (conversion
, Qemboss
))
1660 else if (CONSP (conversion
)
1661 && EQ (XCAR (conversion
), Qedge_detection
))
1664 tem
= XCDR (conversion
);
1666 x_edge_detection (f
, img
,
1667 Fplist_get (tem
, QCmatrix
),
1668 Fplist_get (tem
, QCcolor_adjustment
));
1674 /* Return the id of image with Lisp specification SPEC on frame F.
1675 SPEC must be a valid Lisp image specification (see valid_image_p). */
1678 lookup_image (struct frame
*f
, Lisp_Object spec
)
1683 /* F must be a window-system frame, and SPEC must be a valid image
1685 eassert (FRAME_WINDOW_P (f
));
1686 eassert (valid_image_p (spec
));
1688 /* Look up SPEC in the hash table of the image cache. */
1689 hash
= sxhash (spec
, 0);
1690 img
= search_image_cache (f
, spec
, hash
);
1691 if (img
&& img
->load_failed_p
)
1693 free_image (f
, img
);
1697 /* If not found, create a new image and cache it. */
1701 img
= make_image (spec
, hash
);
1702 cache_image (f
, img
);
1703 img
->load_failed_p
= ! img
->type
->load (f
, img
);
1704 img
->frame_foreground
= FRAME_FOREGROUND_PIXEL (f
);
1705 img
->frame_background
= FRAME_BACKGROUND_PIXEL (f
);
1707 /* If we can't load the image, and we don't have a width and
1708 height, use some arbitrary width and height so that we can
1709 draw a rectangle for it. */
1710 if (img
->load_failed_p
)
1714 value
= image_spec_value (spec
, QCwidth
, NULL
);
1715 img
->width
= (INTEGERP (value
)
1716 ? XFASTINT (value
) : DEFAULT_IMAGE_WIDTH
);
1717 value
= image_spec_value (spec
, QCheight
, NULL
);
1718 img
->height
= (INTEGERP (value
)
1719 ? XFASTINT (value
) : DEFAULT_IMAGE_HEIGHT
);
1723 /* Handle image type independent image attributes
1724 `:ascent ASCENT', `:margin MARGIN', `:relief RELIEF',
1725 `:background COLOR'. */
1726 Lisp_Object ascent
, margin
, relief
, bg
;
1729 ascent
= image_spec_value (spec
, QCascent
, NULL
);
1730 if (INTEGERP (ascent
))
1731 img
->ascent
= XFASTINT (ascent
);
1732 else if (EQ (ascent
, Qcenter
))
1733 img
->ascent
= CENTERED_IMAGE_ASCENT
;
1735 margin
= image_spec_value (spec
, QCmargin
, NULL
);
1736 if (INTEGERP (margin
))
1737 img
->vmargin
= img
->hmargin
= XFASTINT (margin
);
1738 else if (CONSP (margin
))
1740 img
->hmargin
= XFASTINT (XCAR (margin
));
1741 img
->vmargin
= XFASTINT (XCDR (margin
));
1744 relief
= image_spec_value (spec
, QCrelief
, NULL
);
1745 relief_bound
= INT_MAX
- max (img
->hmargin
, img
->vmargin
);
1746 if (RANGED_INTEGERP (- relief_bound
, relief
, relief_bound
))
1748 img
->relief
= XINT (relief
);
1749 img
->hmargin
+= eabs (img
->relief
);
1750 img
->vmargin
+= eabs (img
->relief
);
1753 if (! img
->background_valid
)
1755 bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
1759 = x_alloc_image_color (f
, img
, bg
,
1760 FRAME_BACKGROUND_PIXEL (f
));
1761 img
->background_valid
= 1;
1765 /* Do image transformations and compute masks, unless we
1766 don't have the image yet. */
1767 if (!EQ (*img
->type
->type
, Qpostscript
))
1768 postprocess_image (f
, img
);
1774 /* We're using IMG, so set its timestamp to `now'. */
1775 img
->timestamp
= current_emacs_time ();
1777 /* Value is the image id. */
1782 /* Cache image IMG in the image cache of frame F. */
1785 cache_image (struct frame
*f
, struct image
*img
)
1787 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1790 /* Find a free slot in c->images. */
1791 for (i
= 0; i
< c
->used
; ++i
)
1792 if (c
->images
[i
] == NULL
)
1795 /* If no free slot found, maybe enlarge c->images. */
1796 if (i
== c
->used
&& c
->used
== c
->size
)
1797 c
->images
= xpalloc (c
->images
, &c
->size
, 1, -1, sizeof *c
->images
);
1799 /* Add IMG to c->images, and assign IMG an id. */
1805 /* Add IMG to the cache's hash table. */
1806 i
= img
->hash
% IMAGE_CACHE_BUCKETS_SIZE
;
1807 img
->next
= c
->buckets
[i
];
1809 img
->next
->prev
= img
;
1811 c
->buckets
[i
] = img
;
1815 /* Call FN on every image in the image cache of frame F. Used to mark
1816 Lisp Objects in the image cache. */
1818 /* Mark Lisp objects in image IMG. */
1821 mark_image (struct image
*img
)
1823 mark_object (img
->spec
);
1824 mark_object (img
->dependencies
);
1826 if (!NILP (img
->lisp_data
))
1827 mark_object (img
->lisp_data
);
1832 mark_image_cache (struct image_cache
*c
)
1837 for (i
= 0; i
< c
->used
; ++i
)
1839 mark_image (c
->images
[i
]);
1845 /***********************************************************************
1846 X / NS / W32 support code
1847 ***********************************************************************/
1851 /* Macro for defining functions that will be loaded from image DLLs. */
1852 #define DEF_IMGLIB_FN(rettype,func,args) static rettype (FAR CDECL *fn_##func)args
1854 /* Macro for loading those image functions from the library. */
1855 #define LOAD_IMGLIB_FN(lib,func) { \
1856 fn_##func = (void *) GetProcAddress (lib, #func); \
1857 if (!fn_##func) return 0; \
1860 #endif /* WINDOWSNT */
1862 /* Return true if XIMG's size WIDTH x HEIGHT doesn't break the
1864 WIDTH and HEIGHT must both be positive.
1865 If XIMG is null, assume it is a bitmap. */
1867 x_check_image_size (XImagePtr ximg
, int width
, int height
)
1869 #ifdef HAVE_X_WINDOWS
1870 /* Respect Xlib's limits: it cannot deal with images that have more
1871 than INT_MAX (and/or UINT_MAX) bytes. And respect Emacs's limits
1872 of PTRDIFF_MAX (and/or SIZE_MAX) bytes for any object. */
1875 XLIB_BYTES_MAX
= min (INT_MAX
, UINT_MAX
),
1876 X_IMAGE_BYTES_MAX
= min (XLIB_BYTES_MAX
, min (PTRDIFF_MAX
, SIZE_MAX
))
1879 int bitmap_pad
, depth
, bytes_per_line
;
1882 bitmap_pad
= ximg
->bitmap_pad
;
1883 depth
= ximg
->depth
;
1884 bytes_per_line
= ximg
->bytes_per_line
;
1890 bytes_per_line
= (width
>> 3) + ((width
& 7) != 0);
1892 return (width
<= (INT_MAX
- (bitmap_pad
- 1)) / depth
1893 && height
<= X_IMAGE_BYTES_MAX
/ bytes_per_line
);
1895 /* FIXME: Implement this check for the HAVE_NS and HAVE_NTGUI cases.
1896 For now, assume that every image size is allowed on these systems. */
1901 /* Create an XImage and a pixmap of size WIDTH x HEIGHT for use on
1902 frame F. Set *XIMG and *PIXMAP to the XImage and Pixmap created.
1903 Set (*XIMG)->data to a raster of WIDTH x HEIGHT pixels allocated
1904 via xmalloc. Print error messages via image_error if an error
1905 occurs. Value is true if successful.
1907 On W32, a DEPTH of zero signifies a 24 bit image, otherwise DEPTH
1908 should indicate the bit depth of the image. */
1911 x_create_x_image_and_pixmap (struct frame
*f
, int width
, int height
, int depth
,
1912 XImagePtr
*ximg
, Pixmap
*pixmap
)
1914 #ifdef HAVE_X_WINDOWS
1915 Display
*display
= FRAME_X_DISPLAY (f
);
1916 Window window
= FRAME_X_WINDOW (f
);
1917 Screen
*screen
= FRAME_X_SCREEN (f
);
1919 eassert (input_blocked_p ());
1922 depth
= DefaultDepthOfScreen (screen
);
1923 *ximg
= XCreateImage (display
, DefaultVisualOfScreen (screen
),
1924 depth
, ZPixmap
, 0, NULL
, width
, height
,
1925 depth
> 16 ? 32 : depth
> 8 ? 16 : 8, 0);
1928 image_error ("Unable to allocate X image", Qnil
, Qnil
);
1932 if (! x_check_image_size (*ximg
, width
, height
))
1934 x_destroy_x_image (*ximg
);
1936 image_error ("Image too large (%dx%d)",
1937 make_number (width
), make_number (height
));
1941 /* Allocate image raster. */
1942 (*ximg
)->data
= xmalloc ((*ximg
)->bytes_per_line
* height
);
1944 /* Allocate a pixmap of the same size. */
1945 *pixmap
= XCreatePixmap (display
, window
, width
, height
, depth
);
1946 if (*pixmap
== NO_PIXMAP
)
1948 x_destroy_x_image (*ximg
);
1950 image_error ("Unable to create X pixmap", Qnil
, Qnil
);
1955 #endif /* HAVE_X_WINDOWS */
1959 BITMAPINFOHEADER
*header
;
1961 int scanline_width_bits
;
1963 int palette_colors
= 0;
1968 if (depth
!= 1 && depth
!= 4 && depth
!= 8
1969 && depth
!= 16 && depth
!= 24 && depth
!= 32)
1971 image_error ("Invalid image bit depth specified", Qnil
, Qnil
);
1975 scanline_width_bits
= width
* depth
;
1976 remainder
= scanline_width_bits
% 32;
1979 scanline_width_bits
+= 32 - remainder
;
1981 /* Bitmaps with a depth less than 16 need a palette. */
1982 /* BITMAPINFO structure already contains the first RGBQUAD. */
1984 palette_colors
= 1 << (depth
- 1);
1986 *ximg
= xmalloc (sizeof (XImage
) + palette_colors
* sizeof (RGBQUAD
));
1988 header
= &(*ximg
)->info
.bmiHeader
;
1989 memset (&(*ximg
)->info
, 0, sizeof (BITMAPINFO
));
1990 header
->biSize
= sizeof (*header
);
1991 header
->biWidth
= width
;
1992 header
->biHeight
= -height
; /* negative indicates a top-down bitmap. */
1993 header
->biPlanes
= 1;
1994 header
->biBitCount
= depth
;
1995 header
->biCompression
= BI_RGB
;
1996 header
->biClrUsed
= palette_colors
;
1998 /* TODO: fill in palette. */
2001 (*ximg
)->info
.bmiColors
[0].rgbBlue
= 0;
2002 (*ximg
)->info
.bmiColors
[0].rgbGreen
= 0;
2003 (*ximg
)->info
.bmiColors
[0].rgbRed
= 0;
2004 (*ximg
)->info
.bmiColors
[0].rgbReserved
= 0;
2005 (*ximg
)->info
.bmiColors
[1].rgbBlue
= 255;
2006 (*ximg
)->info
.bmiColors
[1].rgbGreen
= 255;
2007 (*ximg
)->info
.bmiColors
[1].rgbRed
= 255;
2008 (*ximg
)->info
.bmiColors
[1].rgbReserved
= 0;
2011 hdc
= get_frame_dc (f
);
2013 /* Create a DIBSection and raster array for the bitmap,
2014 and store its handle in *pixmap. */
2015 *pixmap
= CreateDIBSection (hdc
, &((*ximg
)->info
),
2016 (depth
< 16) ? DIB_PAL_COLORS
: DIB_RGB_COLORS
,
2017 /* casting avoids a GCC warning */
2018 (void **)&((*ximg
)->data
), NULL
, 0);
2020 /* Realize display palette and garbage all frames. */
2021 release_frame_dc (f
, hdc
);
2023 if (*pixmap
== NULL
)
2025 DWORD err
= GetLastError ();
2026 Lisp_Object errcode
;
2027 /* All system errors are < 10000, so the following is safe. */
2028 XSETINT (errcode
, err
);
2029 image_error ("Unable to create bitmap, error code %d", errcode
, Qnil
);
2030 x_destroy_x_image (*ximg
);
2036 #endif /* HAVE_NTGUI */
2039 *pixmap
= ns_image_for_XPM (width
, height
, depth
);
2043 image_error ("Unable to allocate NSImage for XPM pixmap", Qnil
, Qnil
);
2052 /* Destroy XImage XIMG. Free XIMG->data. */
2055 x_destroy_x_image (XImagePtr ximg
)
2057 eassert (input_blocked_p ());
2060 #ifdef HAVE_X_WINDOWS
2063 XDestroyImage (ximg
);
2064 #endif /* HAVE_X_WINDOWS */
2066 /* Data will be freed by DestroyObject. */
2069 #endif /* HAVE_NTGUI */
2071 ns_release_object (ximg
);
2072 #endif /* HAVE_NS */
2077 /* Put XImage XIMG into pixmap PIXMAP on frame F. WIDTH and HEIGHT
2078 are width and height of both the image and pixmap. */
2081 x_put_x_image (struct frame
*f
, XImagePtr ximg
, Pixmap pixmap
, int width
, int height
)
2083 #ifdef HAVE_X_WINDOWS
2086 eassert (input_blocked_p ());
2087 gc
= XCreateGC (FRAME_X_DISPLAY (f
), pixmap
, 0, NULL
);
2088 XPutImage (FRAME_X_DISPLAY (f
), pixmap
, gc
, ximg
, 0, 0, 0, 0, width
, height
);
2089 XFreeGC (FRAME_X_DISPLAY (f
), gc
);
2090 #endif /* HAVE_X_WINDOWS */
2093 #if 0 /* I don't think this is necessary looking at where it is used. */
2094 HDC hdc
= get_frame_dc (f
);
2095 SetDIBits (hdc
, pixmap
, 0, height
, ximg
->data
, &(ximg
->info
), DIB_RGB_COLORS
);
2096 release_frame_dc (f
, hdc
);
2098 #endif /* HAVE_NTGUI */
2101 eassert (ximg
== pixmap
);
2102 ns_retain_object (ximg
);
2106 /* Thin wrapper for x_create_x_image_and_pixmap, so that it matches
2107 with image_put_x_image. */
2110 image_create_x_image_and_pixmap (struct frame
*f
, struct image
*img
,
2111 int width
, int height
, int depth
,
2112 XImagePtr
*ximg
, bool mask_p
)
2114 eassert ((!mask_p
? img
->pixmap
: img
->mask
) == NO_PIXMAP
);
2116 return x_create_x_image_and_pixmap (f
, width
, height
, depth
, ximg
,
2117 !mask_p
? &img
->pixmap
: &img
->mask
);
2120 /* Put X image XIMG into image IMG on frame F, as a mask if and only
2121 if MASK_P. On X, this simply records XIMG on a member of IMG, so
2122 it can be put into the pixmap afterwards via image_sync_to_pixmaps.
2123 On the other platforms, it puts XIMG into the pixmap, then frees
2124 the X image and its buffer. */
2127 image_put_x_image (struct frame
*f
, struct image
*img
, XImagePtr ximg
,
2130 #ifdef HAVE_X_WINDOWS
2133 eassert (img
->ximg
== NULL
);
2138 eassert (img
->mask_img
== NULL
);
2139 img
->mask_img
= ximg
;
2142 x_put_x_image (f
, ximg
, !mask_p
? img
->pixmap
: img
->mask
,
2143 img
->width
, img
->height
);
2144 x_destroy_x_image (ximg
);
2148 #ifdef HAVE_X_WINDOWS
2149 /* Put the X images recorded in IMG on frame F into pixmaps, then free
2150 the X images and their buffers. */
2153 image_sync_to_pixmaps (struct frame
*f
, struct image
*img
)
2157 x_put_x_image (f
, img
->ximg
, img
->pixmap
, img
->width
, img
->height
);
2158 x_destroy_x_image (img
->ximg
);
2163 x_put_x_image (f
, img
->mask_img
, img
->mask
, img
->width
, img
->height
);
2164 x_destroy_x_image (img
->mask_img
);
2165 img
->mask_img
= NULL
;
2171 /* Create a memory device context for IMG on frame F. It stores the
2172 currently selected GDI object into *PREV for future restoration by
2173 image_unget_x_image_or_dc. */
2175 static XImagePtr_or_DC
2176 image_get_x_image_or_dc (struct frame
*f
, struct image
*img
, bool mask_p
,
2179 HDC frame_dc
= get_frame_dc (f
);
2180 XImagePtr_or_DC ximg
= CreateCompatibleDC (frame_dc
);
2182 release_frame_dc (f
, frame_dc
);
2183 *prev
= SelectObject (ximg
, !mask_p
? img
->pixmap
: img
->mask
);
2189 image_unget_x_image_or_dc (struct image
*img
, bool mask_p
,
2190 XImagePtr_or_DC ximg
, HGDIOBJ prev
)
2192 SelectObject (ximg
, prev
);
2195 #else /* !HAVE_NTGUI */
2196 /* Get the X image for IMG on frame F. The resulting X image data
2197 should be treated as read-only at least on X. */
2200 image_get_x_image (struct frame
*f
, struct image
*img
, bool mask_p
)
2202 #ifdef HAVE_X_WINDOWS
2203 XImagePtr ximg_in_img
= !mask_p
? img
->ximg
: img
->mask_img
;
2208 return XGetImage (FRAME_X_DISPLAY (f
), !mask_p
? img
->pixmap
: img
->mask
,
2209 0, 0, img
->width
, img
->height
, ~0, ZPixmap
);
2210 #elif defined (HAVE_NS)
2211 XImagePtr pixmap
= !mask_p
? img
->pixmap
: img
->mask
;
2213 ns_retain_object (pixmap
);
2219 image_unget_x_image (struct image
*img
, bool mask_p
, XImagePtr ximg
)
2221 #ifdef HAVE_X_WINDOWS
2222 XImagePtr ximg_in_img
= !mask_p
? img
->ximg
: img
->mask_img
;
2225 eassert (ximg
== ximg_in_img
);
2227 XDestroyImage (ximg
);
2228 #elif defined (HAVE_NS)
2229 ns_release_object (ximg
);
2232 #endif /* !HAVE_NTGUI */
2235 /***********************************************************************
2237 ***********************************************************************/
2239 /* Find image file FILE. Look in data-directory/images, then
2240 x-bitmap-file-path. Value is the encoded full name of the file
2241 found, or nil if not found. */
2244 x_find_image_file (Lisp_Object file
)
2246 Lisp_Object file_found
, search_path
;
2249 /* TODO I think this should use something like image-load-path
2250 instead. Unfortunately, that can contain non-string elements. */
2251 search_path
= Fcons (Fexpand_file_name (build_string ("images"),
2253 Vx_bitmap_file_path
);
2255 /* Try to find FILE in data-directory/images, then x-bitmap-file-path. */
2256 fd
= openp (search_path
, file
, Qnil
, &file_found
, Qnil
);
2262 file_found
= ENCODE_FILE (file_found
);
2270 /* Read FILE into memory. Value is a pointer to a buffer allocated
2271 with xmalloc holding FILE's contents. Value is null if an error
2272 occurred. *SIZE is set to the size of the file. */
2274 static unsigned char *
2275 slurp_file (char *file
, ptrdiff_t *size
)
2277 FILE *fp
= fopen (file
, "rb");
2278 unsigned char *buf
= NULL
;
2281 if (fp
&& fstat (fileno (fp
), &st
) == 0
2282 && 0 <= st
.st_size
&& st
.st_size
<= min (PTRDIFF_MAX
, SIZE_MAX
)
2283 && (buf
= xmalloc (st
.st_size
),
2284 fread (buf
, 1, st
.st_size
, fp
) == st
.st_size
))
2305 /***********************************************************************
2307 ***********************************************************************/
2309 static bool xbm_load (struct frame
*f
, struct image
*img
);
2310 static bool xbm_image_p (Lisp_Object object
);
2311 static bool xbm_file_p (Lisp_Object
);
2314 /* Indices of image specification fields in xbm_format, below. */
2316 enum xbm_keyword_index
2334 /* Vector of image_keyword structures describing the format
2335 of valid XBM image specifications. */
2337 static const struct image_keyword xbm_format
[XBM_LAST
] =
2339 {":type", IMAGE_SYMBOL_VALUE
, 1},
2340 {":file", IMAGE_STRING_VALUE
, 0},
2341 {":width", IMAGE_POSITIVE_INTEGER_VALUE
, 0},
2342 {":height", IMAGE_POSITIVE_INTEGER_VALUE
, 0},
2343 {":data", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
2344 {":foreground", IMAGE_STRING_OR_NIL_VALUE
, 0},
2345 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0},
2346 {":ascent", IMAGE_ASCENT_VALUE
, 0},
2347 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
2348 {":relief", IMAGE_INTEGER_VALUE
, 0},
2349 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
2350 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
2351 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0}
2354 /* Structure describing the image type XBM. */
2356 static struct image_type xbm_type
=
2366 /* Tokens returned from xbm_scan. */
2375 /* Return true if OBJECT is a valid XBM-type image specification.
2376 A valid specification is a list starting with the symbol `image'
2377 The rest of the list is a property list which must contain an
2380 If the specification specifies a file to load, it must contain
2381 an entry `:file FILENAME' where FILENAME is a string.
2383 If the specification is for a bitmap loaded from memory it must
2384 contain `:width WIDTH', `:height HEIGHT', and `:data DATA', where
2385 WIDTH and HEIGHT are integers > 0. DATA may be:
2387 1. a string large enough to hold the bitmap data, i.e. it must
2388 have a size >= (WIDTH + 7) / 8 * HEIGHT
2390 2. a bool-vector of size >= WIDTH * HEIGHT
2392 3. a vector of strings or bool-vectors, one for each line of the
2395 4. a string containing an in-memory XBM file. WIDTH and HEIGHT
2396 may not be specified in this case because they are defined in the
2399 Both the file and data forms may contain the additional entries
2400 `:background COLOR' and `:foreground COLOR'. If not present,
2401 foreground and background of the frame on which the image is
2402 displayed is used. */
2405 xbm_image_p (Lisp_Object object
)
2407 struct image_keyword kw
[XBM_LAST
];
2409 memcpy (kw
, xbm_format
, sizeof kw
);
2410 if (!parse_image_spec (object
, kw
, XBM_LAST
, Qxbm
))
2413 eassert (EQ (kw
[XBM_TYPE
].value
, Qxbm
));
2415 if (kw
[XBM_FILE
].count
)
2417 if (kw
[XBM_WIDTH
].count
|| kw
[XBM_HEIGHT
].count
|| kw
[XBM_DATA
].count
)
2420 else if (kw
[XBM_DATA
].count
&& xbm_file_p (kw
[XBM_DATA
].value
))
2422 /* In-memory XBM file. */
2423 if (kw
[XBM_WIDTH
].count
|| kw
[XBM_HEIGHT
].count
|| kw
[XBM_FILE
].count
)
2431 /* Entries for `:width', `:height' and `:data' must be present. */
2432 if (!kw
[XBM_WIDTH
].count
2433 || !kw
[XBM_HEIGHT
].count
2434 || !kw
[XBM_DATA
].count
)
2437 data
= kw
[XBM_DATA
].value
;
2438 width
= XFASTINT (kw
[XBM_WIDTH
].value
);
2439 height
= XFASTINT (kw
[XBM_HEIGHT
].value
);
2441 /* Check type of data, and width and height against contents of
2447 /* Number of elements of the vector must be >= height. */
2448 if (ASIZE (data
) < height
)
2451 /* Each string or bool-vector in data must be large enough
2452 for one line of the image. */
2453 for (i
= 0; i
< height
; ++i
)
2455 Lisp_Object elt
= AREF (data
, i
);
2460 < (width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
)
2463 else if (BOOL_VECTOR_P (elt
))
2465 if (XBOOL_VECTOR (elt
)->size
< width
)
2472 else if (STRINGP (data
))
2475 < (width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
* height
)
2478 else if (BOOL_VECTOR_P (data
))
2480 if (XBOOL_VECTOR (data
)->size
/ height
< width
)
2491 /* Scan a bitmap file. FP is the stream to read from. Value is
2492 either an enumerator from enum xbm_token, or a character for a
2493 single-character token, or 0 at end of file. If scanning an
2494 identifier, store the lexeme of the identifier in SVAL. If
2495 scanning a number, store its value in *IVAL. */
2498 xbm_scan (unsigned char **s
, unsigned char *end
, char *sval
, int *ival
)
2504 /* Skip white space. */
2505 while (*s
< end
&& (c
= *(*s
)++, c_isspace (c
)))
2510 else if (c_isdigit (c
))
2512 int value
= 0, digit
;
2514 if (c
== '0' && *s
< end
)
2517 if (c
== 'x' || c
== 'X')
2524 else if (c
>= 'a' && c
<= 'f')
2525 digit
= c
- 'a' + 10;
2526 else if (c
>= 'A' && c
<= 'F')
2527 digit
= c
- 'A' + 10;
2530 value
= 16 * value
+ digit
;
2533 else if (c_isdigit (c
))
2537 && (c
= *(*s
)++, c_isdigit (c
)))
2538 value
= 8 * value
+ c
- '0';
2545 && (c
= *(*s
)++, c_isdigit (c
)))
2546 value
= 10 * value
+ c
- '0';
2554 else if (c_isalpha (c
) || c
== '_')
2558 && (c
= *(*s
)++, (c_isalnum (c
) || c
== '_')))
2565 else if (c
== '/' && **s
== '*')
2567 /* C-style comment. */
2569 while (**s
&& (**s
!= '*' || *(*s
+ 1) != '/'))
2583 /* Create a Windows bitmap from X bitmap data. */
2585 w32_create_pixmap_from_bitmap_data (int width
, int height
, char *data
)
2587 static unsigned char swap_nibble
[16]
2588 = { 0x0, 0x8, 0x4, 0xc, /* 0000 1000 0100 1100 */
2589 0x2, 0xa, 0x6, 0xe, /* 0010 1010 0110 1110 */
2590 0x1, 0x9, 0x5, 0xd, /* 0001 1001 0101 1101 */
2591 0x3, 0xb, 0x7, 0xf }; /* 0011 1011 0111 1111 */
2593 unsigned char *bits
, *p
;
2596 w1
= (width
+ 7) / 8; /* nb of 8bits elt in X bitmap */
2597 w2
= ((width
+ 15) / 16) * 2; /* nb of 16bits elt in W32 bitmap */
2598 bits
= alloca (height
* w2
);
2599 memset (bits
, 0, height
* w2
);
2600 for (i
= 0; i
< height
; i
++)
2603 for (j
= 0; j
< w1
; j
++)
2605 /* Bitswap XBM bytes to match how Windows does things. */
2606 unsigned char c
= *data
++;
2607 *p
++ = (unsigned char)((swap_nibble
[c
& 0xf] << 4)
2608 | (swap_nibble
[(c
>>4) & 0xf]));
2611 bmp
= CreateBitmap (width
, height
, 1, 1, (char *) bits
);
2617 convert_mono_to_color_image (struct frame
*f
, struct image
*img
,
2618 COLORREF foreground
, COLORREF background
)
2620 HDC hdc
, old_img_dc
, new_img_dc
;
2621 HGDIOBJ old_prev
, new_prev
;
2624 hdc
= get_frame_dc (f
);
2625 old_img_dc
= CreateCompatibleDC (hdc
);
2626 new_img_dc
= CreateCompatibleDC (hdc
);
2627 new_pixmap
= CreateCompatibleBitmap (hdc
, img
->width
, img
->height
);
2628 release_frame_dc (f
, hdc
);
2629 old_prev
= SelectObject (old_img_dc
, img
->pixmap
);
2630 new_prev
= SelectObject (new_img_dc
, new_pixmap
);
2631 /* Windows convention for mono bitmaps is black = background,
2632 white = foreground. */
2633 SetTextColor (new_img_dc
, background
);
2634 SetBkColor (new_img_dc
, foreground
);
2636 BitBlt (new_img_dc
, 0, 0, img
->width
, img
->height
, old_img_dc
,
2639 SelectObject (old_img_dc
, old_prev
);
2640 SelectObject (new_img_dc
, new_prev
);
2641 DeleteDC (old_img_dc
);
2642 DeleteDC (new_img_dc
);
2643 DeleteObject (img
->pixmap
);
2644 if (new_pixmap
== 0)
2645 fprintf (stderr
, "Failed to convert image to color.\n");
2647 img
->pixmap
= new_pixmap
;
2650 #define XBM_BIT_SHUFFLE(b) (~(b))
2654 #define XBM_BIT_SHUFFLE(b) (b)
2656 #endif /* HAVE_NTGUI */
2660 Create_Pixmap_From_Bitmap_Data (struct frame
*f
, struct image
*img
, char *data
,
2661 RGB_PIXEL_COLOR fg
, RGB_PIXEL_COLOR bg
,
2662 bool non_default_colors
)
2666 = w32_create_pixmap_from_bitmap_data (img
->width
, img
->height
, data
);
2668 /* If colors were specified, transfer the bitmap to a color one. */
2669 if (non_default_colors
)
2670 convert_mono_to_color_image (f
, img
, fg
, bg
);
2672 #elif defined (HAVE_NS)
2673 img
->pixmap
= ns_image_from_XBM (data
, img
->width
, img
->height
);
2677 (x_check_image_size (0, img
->width
, img
->height
)
2678 ? XCreatePixmapFromBitmapData (FRAME_X_DISPLAY (f
),
2681 img
->width
, img
->height
,
2683 DefaultDepthOfScreen (FRAME_X_SCREEN (f
)))
2685 #endif /* !HAVE_NTGUI && !HAVE_NS */
2690 /* Replacement for XReadBitmapFileData which isn't available under old
2691 X versions. CONTENTS is a pointer to a buffer to parse; END is the
2692 buffer's end. Set *WIDTH and *HEIGHT to the width and height of
2693 the image. Return in *DATA the bitmap data allocated with xmalloc.
2694 Value is true if successful. DATA null means just test if
2695 CONTENTS looks like an in-memory XBM file. If INHIBIT_IMAGE_ERROR,
2696 inhibit the call to image_error when the image size is invalid (the
2697 bitmap remains unread). */
2700 xbm_read_bitmap_data (struct frame
*f
, unsigned char *contents
, unsigned char *end
,
2701 int *width
, int *height
, char **data
,
2702 bool inhibit_image_error
)
2704 unsigned char *s
= contents
;
2705 char buffer
[BUFSIZ
];
2708 int bytes_per_line
, i
, nbytes
;
2714 LA1 = xbm_scan (&s, end, buffer, &value)
2716 #define expect(TOKEN) \
2717 if (LA1 != (TOKEN)) \
2722 #define expect_ident(IDENT) \
2723 if (LA1 == XBM_TK_IDENT && strcmp (buffer, (IDENT)) == 0) \
2728 *width
= *height
= -1;
2731 LA1
= xbm_scan (&s
, end
, buffer
, &value
);
2733 /* Parse defines for width, height and hot-spots. */
2737 expect_ident ("define");
2738 expect (XBM_TK_IDENT
);
2740 if (LA1
== XBM_TK_NUMBER
)
2742 char *q
= strrchr (buffer
, '_');
2743 q
= q
? q
+ 1 : buffer
;
2744 if (strcmp (q
, "width") == 0)
2746 else if (strcmp (q
, "height") == 0)
2749 expect (XBM_TK_NUMBER
);
2752 if (!check_image_size (f
, *width
, *height
))
2754 if (!inhibit_image_error
)
2755 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
2758 else if (data
== NULL
)
2761 /* Parse bits. Must start with `static'. */
2762 expect_ident ("static");
2763 if (LA1
== XBM_TK_IDENT
)
2765 if (strcmp (buffer
, "unsigned") == 0)
2768 expect_ident ("char");
2770 else if (strcmp (buffer
, "short") == 0)
2774 if (*width
% 16 && *width
% 16 < 9)
2777 else if (strcmp (buffer
, "char") == 0)
2785 expect (XBM_TK_IDENT
);
2791 if (! x_check_image_size (0, *width
, *height
))
2793 if (!inhibit_image_error
)
2794 image_error ("Image too large (%dx%d)",
2795 make_number (*width
), make_number (*height
));
2798 bytes_per_line
= (*width
+ 7) / 8 + padding_p
;
2799 nbytes
= bytes_per_line
* *height
;
2800 p
= *data
= xmalloc (nbytes
);
2804 for (i
= 0; i
< nbytes
; i
+= 2)
2807 expect (XBM_TK_NUMBER
);
2809 *p
++ = XBM_BIT_SHUFFLE (val
);
2810 if (!padding_p
|| ((i
+ 2) % bytes_per_line
))
2811 *p
++ = XBM_BIT_SHUFFLE (value
>> 8);
2813 if (LA1
== ',' || LA1
== '}')
2821 for (i
= 0; i
< nbytes
; ++i
)
2824 expect (XBM_TK_NUMBER
);
2826 *p
++ = XBM_BIT_SHUFFLE (val
);
2828 if (LA1
== ',' || LA1
== '}')
2853 /* Load XBM image IMG which will be displayed on frame F from buffer
2854 CONTENTS. END is the end of the buffer. Value is true if
2858 xbm_load_image (struct frame
*f
, struct image
*img
, unsigned char *contents
,
2865 rc
= xbm_read_bitmap_data (f
, contents
, end
, &img
->width
, &img
->height
,
2869 unsigned long foreground
= FRAME_FOREGROUND_PIXEL (f
);
2870 unsigned long background
= FRAME_BACKGROUND_PIXEL (f
);
2871 bool non_default_colors
= 0;
2874 eassert (img
->width
> 0 && img
->height
> 0);
2876 /* Get foreground and background colors, maybe allocate colors. */
2877 value
= image_spec_value (img
->spec
, QCforeground
, NULL
);
2880 foreground
= x_alloc_image_color (f
, img
, value
, foreground
);
2881 non_default_colors
= 1;
2883 value
= image_spec_value (img
->spec
, QCbackground
, NULL
);
2886 background
= x_alloc_image_color (f
, img
, value
, background
);
2887 img
->background
= background
;
2888 img
->background_valid
= 1;
2889 non_default_colors
= 1;
2892 Create_Pixmap_From_Bitmap_Data (f
, img
, data
,
2893 foreground
, background
,
2894 non_default_colors
);
2897 if (img
->pixmap
== NO_PIXMAP
)
2899 x_clear_image (f
, img
);
2900 image_error ("Unable to create X pixmap for `%s'", img
->spec
, Qnil
);
2906 image_error ("Error loading XBM image `%s'", img
->spec
, Qnil
);
2912 /* Value is true if DATA looks like an in-memory XBM file. */
2915 xbm_file_p (Lisp_Object data
)
2918 return (STRINGP (data
)
2919 && xbm_read_bitmap_data (NULL
, SDATA (data
),
2920 (SDATA (data
) + SBYTES (data
)),
2925 /* Fill image IMG which is used on frame F with pixmap data. Value is
2926 true if successful. */
2929 xbm_load (struct frame
*f
, struct image
*img
)
2932 Lisp_Object file_name
;
2934 eassert (xbm_image_p (img
->spec
));
2936 /* If IMG->spec specifies a file name, create a non-file spec from it. */
2937 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
2938 if (STRINGP (file_name
))
2941 unsigned char *contents
;
2944 file
= x_find_image_file (file_name
);
2945 if (!STRINGP (file
))
2947 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
2951 contents
= slurp_file (SSDATA (file
), &size
);
2952 if (contents
== NULL
)
2954 image_error ("Error loading XBM image `%s'", img
->spec
, Qnil
);
2958 success_p
= xbm_load_image (f
, img
, contents
, contents
+ size
);
2963 struct image_keyword fmt
[XBM_LAST
];
2965 unsigned long foreground
= FRAME_FOREGROUND_PIXEL (f
);
2966 unsigned long background
= FRAME_BACKGROUND_PIXEL (f
);
2967 bool non_default_colors
= 0;
2970 bool in_memory_file_p
= 0;
2972 /* See if data looks like an in-memory XBM file. */
2973 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
2974 in_memory_file_p
= xbm_file_p (data
);
2976 /* Parse the image specification. */
2977 memcpy (fmt
, xbm_format
, sizeof fmt
);
2978 parsed_p
= parse_image_spec (img
->spec
, fmt
, XBM_LAST
, Qxbm
);
2981 /* Get specified width, and height. */
2982 if (!in_memory_file_p
)
2984 img
->width
= XFASTINT (fmt
[XBM_WIDTH
].value
);
2985 img
->height
= XFASTINT (fmt
[XBM_HEIGHT
].value
);
2986 eassert (img
->width
> 0 && img
->height
> 0);
2987 if (!check_image_size (f
, img
->width
, img
->height
))
2989 image_error ("Invalid image size (see `max-image-size')",
2995 /* Get foreground and background colors, maybe allocate colors. */
2996 if (fmt
[XBM_FOREGROUND
].count
2997 && STRINGP (fmt
[XBM_FOREGROUND
].value
))
2999 foreground
= x_alloc_image_color (f
, img
, fmt
[XBM_FOREGROUND
].value
,
3001 non_default_colors
= 1;
3004 if (fmt
[XBM_BACKGROUND
].count
3005 && STRINGP (fmt
[XBM_BACKGROUND
].value
))
3007 background
= x_alloc_image_color (f
, img
, fmt
[XBM_BACKGROUND
].value
,
3009 non_default_colors
= 1;
3012 if (in_memory_file_p
)
3013 success_p
= xbm_load_image (f
, img
, SDATA (data
),
3022 int nbytes
= (img
->width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
;
3024 p
= bits
= alloca (nbytes
* img
->height
);
3025 for (i
= 0; i
< img
->height
; ++i
, p
+= nbytes
)
3027 Lisp_Object line
= AREF (data
, i
);
3029 memcpy (p
, SDATA (line
), nbytes
);
3031 memcpy (p
, XBOOL_VECTOR (line
)->data
, nbytes
);
3034 else if (STRINGP (data
))
3035 bits
= SSDATA (data
);
3037 bits
= (char *) XBOOL_VECTOR (data
)->data
;
3043 /* Windows mono bitmaps are reversed compared with X. */
3044 invertedBits
= bits
;
3045 nbytes
= (img
->width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
3047 bits
= alloca (nbytes
);
3048 for (i
= 0; i
< nbytes
; i
++)
3049 bits
[i
] = XBM_BIT_SHUFFLE (invertedBits
[i
]);
3052 /* Create the pixmap. */
3054 if (x_check_image_size (0, img
->width
, img
->height
))
3055 Create_Pixmap_From_Bitmap_Data (f
, img
, bits
,
3056 foreground
, background
,
3057 non_default_colors
);
3059 img
->pixmap
= NO_PIXMAP
;
3065 image_error ("Unable to create pixmap for XBM image `%s'",
3067 x_clear_image (f
, img
);
3077 /***********************************************************************
3079 ***********************************************************************/
3081 #if defined (HAVE_XPM) || defined (HAVE_NS)
3083 static bool xpm_image_p (Lisp_Object object
);
3084 static bool xpm_load (struct frame
*f
, struct image
*img
);
3086 #endif /* HAVE_XPM || HAVE_NS */
3090 /* Indicate to xpm.h that we don't have Xlib. */
3092 /* simx.h in xpm defines XColor and XImage differently than Emacs. */
3093 /* It also defines Display the same way as Emacs, but gcc 3.3 still barfs. */
3094 #define XColor xpm_XColor
3095 #define XImage xpm_XImage
3096 #define Display xpm_Display
3097 #define PIXEL_ALREADY_TYPEDEFED
3098 #include "X11/xpm.h"
3103 #undef PIXEL_ALREADY_TYPEDEFED
3105 #include "X11/xpm.h"
3106 #endif /* HAVE_NTGUI */
3107 #endif /* HAVE_XPM */
3109 #if defined (HAVE_XPM) || defined (HAVE_NS)
3110 /* The symbol `xpm' identifying XPM-format images. */
3112 static Lisp_Object Qxpm
;
3114 /* Indices of image specification fields in xpm_format, below. */
3116 enum xpm_keyword_index
3132 /* Vector of image_keyword structures describing the format
3133 of valid XPM image specifications. */
3135 static const struct image_keyword xpm_format
[XPM_LAST
] =
3137 {":type", IMAGE_SYMBOL_VALUE
, 1},
3138 {":file", IMAGE_STRING_VALUE
, 0},
3139 {":data", IMAGE_STRING_VALUE
, 0},
3140 {":ascent", IMAGE_ASCENT_VALUE
, 0},
3141 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
3142 {":relief", IMAGE_INTEGER_VALUE
, 0},
3143 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3144 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3145 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3146 {":color-symbols", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3147 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
3150 #if defined HAVE_NTGUI && defined WINDOWSNT
3151 static bool init_xpm_functions (void);
3153 #define init_xpm_functions NULL
3156 /* Structure describing the image type XPM. */
3158 static struct image_type xpm_type
=
3168 #ifdef HAVE_X_WINDOWS
3170 /* Define ALLOC_XPM_COLORS if we can use Emacs' own color allocation
3171 functions for allocating image colors. Our own functions handle
3172 color allocation failures more gracefully than the ones on the XPM
3175 #if defined XpmAllocColor && defined XpmFreeColors && defined XpmColorClosure
3176 #define ALLOC_XPM_COLORS
3178 #endif /* HAVE_X_WINDOWS */
3180 #ifdef ALLOC_XPM_COLORS
3182 static struct xpm_cached_color
*xpm_cache_color (struct frame
*, char *,
3185 /* An entry in a hash table used to cache color definitions of named
3186 colors. This cache is necessary to speed up XPM image loading in
3187 case we do color allocations ourselves. Without it, we would need
3188 a call to XParseColor per pixel in the image. */
3190 struct xpm_cached_color
3192 /* Next in collision chain. */
3193 struct xpm_cached_color
*next
;
3195 /* Color definition (RGB and pixel color). */
3199 char name
[FLEXIBLE_ARRAY_MEMBER
];
3202 /* The hash table used for the color cache, and its bucket vector
3205 #define XPM_COLOR_CACHE_BUCKETS 1001
3206 static struct xpm_cached_color
**xpm_color_cache
;
3208 /* Initialize the color cache. */
3211 xpm_init_color_cache (struct frame
*f
, XpmAttributes
*attrs
)
3213 size_t nbytes
= XPM_COLOR_CACHE_BUCKETS
* sizeof *xpm_color_cache
;
3214 xpm_color_cache
= xzalloc (nbytes
);
3215 init_color_table ();
3217 if (attrs
->valuemask
& XpmColorSymbols
)
3222 for (i
= 0; i
< attrs
->numsymbols
; ++i
)
3223 if (XParseColor (FRAME_X_DISPLAY (f
), FRAME_X_COLORMAP (f
),
3224 attrs
->colorsymbols
[i
].value
, &color
))
3226 color
.pixel
= lookup_rgb_color (f
, color
.red
, color
.green
,
3228 xpm_cache_color (f
, attrs
->colorsymbols
[i
].name
, &color
, -1);
3233 /* Free the color cache. */
3236 xpm_free_color_cache (void)
3238 struct xpm_cached_color
*p
, *next
;
3241 for (i
= 0; i
< XPM_COLOR_CACHE_BUCKETS
; ++i
)
3242 for (p
= xpm_color_cache
[i
]; p
; p
= next
)
3248 xfree (xpm_color_cache
);
3249 xpm_color_cache
= NULL
;
3250 free_color_table ();
3253 /* Return the bucket index for color named COLOR_NAME in the color
3257 xpm_color_bucket (char *color_name
)
3259 EMACS_UINT hash
= hash_string (color_name
, strlen (color_name
));
3260 return hash
% XPM_COLOR_CACHE_BUCKETS
;
3264 /* On frame F, cache values COLOR for color with name COLOR_NAME.
3265 BUCKET, if >= 0, is a precomputed bucket index. Value is the cache
3268 static struct xpm_cached_color
*
3269 xpm_cache_color (struct frame
*f
, char *color_name
, XColor
*color
, int bucket
)
3272 struct xpm_cached_color
*p
;
3275 bucket
= xpm_color_bucket (color_name
);
3277 nbytes
= offsetof (struct xpm_cached_color
, name
) + strlen (color_name
) + 1;
3278 p
= xmalloc (nbytes
);
3279 strcpy (p
->name
, color_name
);
3281 p
->next
= xpm_color_cache
[bucket
];
3282 xpm_color_cache
[bucket
] = p
;
3286 /* Look up color COLOR_NAME for frame F in the color cache. If found,
3287 return the cached definition in *COLOR. Otherwise, make a new
3288 entry in the cache and allocate the color. Value is false if color
3289 allocation failed. */
3292 xpm_lookup_color (struct frame
*f
, char *color_name
, XColor
*color
)
3294 struct xpm_cached_color
*p
;
3295 int h
= xpm_color_bucket (color_name
);
3297 for (p
= xpm_color_cache
[h
]; p
; p
= p
->next
)
3298 if (strcmp (p
->name
, color_name
) == 0)
3303 else if (XParseColor (FRAME_X_DISPLAY (f
), FRAME_X_COLORMAP (f
),
3306 color
->pixel
= lookup_rgb_color (f
, color
->red
, color
->green
,
3308 p
= xpm_cache_color (f
, color_name
, color
, h
);
3310 /* You get `opaque' at least from ImageMagick converting pbm to xpm
3311 with transparency, and it's useful. */
3312 else if (strcmp ("opaque", color_name
) == 0)
3314 memset (color
, 0, sizeof (XColor
)); /* Is this necessary/correct? */
3315 color
->pixel
= FRAME_FOREGROUND_PIXEL (f
);
3316 p
= xpm_cache_color (f
, color_name
, color
, h
);
3323 /* Callback for allocating color COLOR_NAME. Called from the XPM lib.
3324 CLOSURE is a pointer to the frame on which we allocate the
3325 color. Return in *COLOR the allocated color. Value is non-zero
3329 xpm_alloc_color (Display
*dpy
, Colormap cmap
, char *color_name
, XColor
*color
,
3332 return xpm_lookup_color ((struct frame
*) closure
, color_name
, color
);
3336 /* Callback for freeing NPIXELS colors contained in PIXELS. CLOSURE
3337 is a pointer to the frame on which we allocate the color. Value is
3338 non-zero if successful. */
3341 xpm_free_colors (Display
*dpy
, Colormap cmap
, Pixel
*pixels
, int npixels
, void *closure
)
3346 #endif /* ALLOC_XPM_COLORS */
3351 /* XPM library details. */
3353 DEF_IMGLIB_FN (void, XpmFreeAttributes
, (XpmAttributes
*));
3354 DEF_IMGLIB_FN (int, XpmCreateImageFromBuffer
, (Display
*, char *, xpm_XImage
**,
3355 xpm_XImage
**, XpmAttributes
*));
3356 DEF_IMGLIB_FN (int, XpmReadFileToImage
, (Display
*, char *, xpm_XImage
**,
3357 xpm_XImage
**, XpmAttributes
*));
3358 DEF_IMGLIB_FN (void, XImageFree
, (xpm_XImage
*));
3361 init_xpm_functions (void)
3365 if (!(library
= w32_delayed_load (Qxpm
)))
3368 LOAD_IMGLIB_FN (library
, XpmFreeAttributes
);
3369 LOAD_IMGLIB_FN (library
, XpmCreateImageFromBuffer
);
3370 LOAD_IMGLIB_FN (library
, XpmReadFileToImage
);
3371 LOAD_IMGLIB_FN (library
, XImageFree
);
3375 #endif /* WINDOWSNT */
3377 #if defined HAVE_NTGUI && !defined WINDOWSNT
3378 /* Glue for code below */
3379 #define fn_XpmReadFileToImage XpmReadFileToImage
3380 #define fn_XpmCreateImageFromBuffer XpmCreateImageFromBuffer
3381 #define fn_XImageFree XImageFree
3382 #define fn_XpmFreeAttributes XpmFreeAttributes
3383 #endif /* HAVE_NTGUI && !WINDOWSNT */
3385 /* Value is true if COLOR_SYMBOLS is a valid color symbols list
3386 for XPM images. Such a list must consist of conses whose car and
3390 xpm_valid_color_symbols_p (Lisp_Object color_symbols
)
3392 while (CONSP (color_symbols
))
3394 Lisp_Object sym
= XCAR (color_symbols
);
3396 || !STRINGP (XCAR (sym
))
3397 || !STRINGP (XCDR (sym
)))
3399 color_symbols
= XCDR (color_symbols
);
3402 return NILP (color_symbols
);
3406 /* Value is true if OBJECT is a valid XPM image specification. */
3409 xpm_image_p (Lisp_Object object
)
3411 struct image_keyword fmt
[XPM_LAST
];
3412 memcpy (fmt
, xpm_format
, sizeof fmt
);
3413 return (parse_image_spec (object
, fmt
, XPM_LAST
, Qxpm
)
3414 /* Either `:file' or `:data' must be present. */
3415 && fmt
[XPM_FILE
].count
+ fmt
[XPM_DATA
].count
== 1
3416 /* Either no `:color-symbols' or it's a list of conses
3417 whose car and cdr are strings. */
3418 && (fmt
[XPM_COLOR_SYMBOLS
].count
== 0
3419 || xpm_valid_color_symbols_p (fmt
[XPM_COLOR_SYMBOLS
].value
)));
3422 #endif /* HAVE_XPM || HAVE_NS */
3424 #if defined HAVE_XPM && defined HAVE_X_WINDOWS && !defined USE_GTK
3426 x_create_bitmap_from_xpm_data (struct frame
*f
, const char **bits
)
3428 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
3431 XpmAttributes attrs
;
3432 Pixmap bitmap
, mask
;
3434 memset (&attrs
, 0, sizeof attrs
);
3436 attrs
.visual
= FRAME_X_VISUAL (f
);
3437 attrs
.colormap
= FRAME_X_COLORMAP (f
);
3438 attrs
.valuemask
|= XpmVisual
;
3439 attrs
.valuemask
|= XpmColormap
;
3441 rc
= XpmCreatePixmapFromData (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
3442 (char **) bits
, &bitmap
, &mask
, &attrs
);
3443 if (rc
!= XpmSuccess
)
3445 XpmFreeAttributes (&attrs
);
3449 id
= x_allocate_bitmap_record (f
);
3450 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
3451 dpyinfo
->bitmaps
[id
- 1].have_mask
= 1;
3452 dpyinfo
->bitmaps
[id
- 1].mask
= mask
;
3453 dpyinfo
->bitmaps
[id
- 1].file
= NULL
;
3454 dpyinfo
->bitmaps
[id
- 1].height
= attrs
.height
;
3455 dpyinfo
->bitmaps
[id
- 1].width
= attrs
.width
;
3456 dpyinfo
->bitmaps
[id
- 1].depth
= attrs
.depth
;
3457 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
3459 XpmFreeAttributes (&attrs
);
3462 #endif /* defined (HAVE_XPM) && defined (HAVE_X_WINDOWS) */
3464 /* Load image IMG which will be displayed on frame F. Value is
3465 true if successful. */
3470 xpm_load (struct frame
*f
, struct image
*img
)
3473 XpmAttributes attrs
;
3474 Lisp_Object specified_file
, color_symbols
;
3477 xpm_XImage
* xpm_image
= NULL
, * xpm_mask
= NULL
;
3478 #endif /* HAVE_NTGUI */
3480 /* Configure the XPM lib. Use the visual of frame F. Allocate
3481 close colors. Return colors allocated. */
3482 memset (&attrs
, 0, sizeof attrs
);
3485 attrs
.visual
= FRAME_X_VISUAL (f
);
3486 attrs
.colormap
= FRAME_X_COLORMAP (f
);
3487 attrs
.valuemask
|= XpmVisual
;
3488 attrs
.valuemask
|= XpmColormap
;
3489 #endif /* HAVE_NTGUI */
3491 #ifdef ALLOC_XPM_COLORS
3492 /* Allocate colors with our own functions which handle
3493 failing color allocation more gracefully. */
3494 attrs
.color_closure
= f
;
3495 attrs
.alloc_color
= xpm_alloc_color
;
3496 attrs
.free_colors
= xpm_free_colors
;
3497 attrs
.valuemask
|= XpmAllocColor
| XpmFreeColors
| XpmColorClosure
;
3498 #else /* not ALLOC_XPM_COLORS */
3499 /* Let the XPM lib allocate colors. */
3500 attrs
.valuemask
|= XpmReturnAllocPixels
;
3501 #ifdef XpmAllocCloseColors
3502 attrs
.alloc_close_colors
= 1;
3503 attrs
.valuemask
|= XpmAllocCloseColors
;
3504 #else /* not XpmAllocCloseColors */
3505 attrs
.closeness
= 600;
3506 attrs
.valuemask
|= XpmCloseness
;
3507 #endif /* not XpmAllocCloseColors */
3508 #endif /* ALLOC_XPM_COLORS */
3510 /* If image specification contains symbolic color definitions, add
3511 these to `attrs'. */
3512 color_symbols
= image_spec_value (img
->spec
, QCcolor_symbols
, NULL
);
3513 if (CONSP (color_symbols
))
3516 XpmColorSymbol
*xpm_syms
;
3519 attrs
.valuemask
|= XpmColorSymbols
;
3521 /* Count number of symbols. */
3522 attrs
.numsymbols
= 0;
3523 for (tail
= color_symbols
; CONSP (tail
); tail
= XCDR (tail
))
3526 /* Allocate an XpmColorSymbol array. */
3527 size
= attrs
.numsymbols
* sizeof *xpm_syms
;
3528 xpm_syms
= alloca (size
);
3529 memset (xpm_syms
, 0, size
);
3530 attrs
.colorsymbols
= xpm_syms
;
3532 /* Fill the color symbol array. */
3533 for (tail
= color_symbols
, i
= 0;
3535 ++i
, tail
= XCDR (tail
))
3539 char *empty_string
= (char *) "";
3541 if (!CONSP (XCAR (tail
)))
3543 xpm_syms
[i
].name
= empty_string
;
3544 xpm_syms
[i
].value
= empty_string
;
3547 name
= XCAR (XCAR (tail
));
3548 color
= XCDR (XCAR (tail
));
3551 xpm_syms
[i
].name
= alloca (SCHARS (name
) + 1);
3552 strcpy (xpm_syms
[i
].name
, SSDATA (name
));
3555 xpm_syms
[i
].name
= empty_string
;
3556 if (STRINGP (color
))
3558 xpm_syms
[i
].value
= alloca (SCHARS (color
) + 1);
3559 strcpy (xpm_syms
[i
].value
, SSDATA (color
));
3562 xpm_syms
[i
].value
= empty_string
;
3566 /* Create a pixmap for the image, either from a file, or from a
3567 string buffer containing data in the same format as an XPM file. */
3568 #ifdef ALLOC_XPM_COLORS
3569 xpm_init_color_cache (f
, &attrs
);
3572 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
3576 HDC frame_dc
= get_frame_dc (f
);
3577 hdc
= CreateCompatibleDC (frame_dc
);
3578 release_frame_dc (f
, frame_dc
);
3580 #endif /* HAVE_NTGUI */
3582 if (STRINGP (specified_file
))
3584 Lisp_Object file
= x_find_image_file (specified_file
);
3585 if (!STRINGP (file
))
3587 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
3588 #ifdef ALLOC_XPM_COLORS
3589 xpm_free_color_cache ();
3595 /* XpmReadFileToPixmap is not available in the Windows port of
3596 libxpm. But XpmReadFileToImage almost does what we want. */
3597 rc
= fn_XpmReadFileToImage (&hdc
, SDATA (file
),
3598 &xpm_image
, &xpm_mask
,
3601 rc
= XpmReadFileToImage (FRAME_X_DISPLAY (f
), SSDATA (file
),
3602 &img
->ximg
, &img
->mask_img
,
3604 #endif /* HAVE_NTGUI */
3608 Lisp_Object buffer
= image_spec_value (img
->spec
, QCdata
, NULL
);
3609 if (!STRINGP (buffer
))
3611 image_error ("Invalid image data `%s'", buffer
, Qnil
);
3612 #ifdef ALLOC_XPM_COLORS
3613 xpm_free_color_cache ();
3618 /* XpmCreatePixmapFromBuffer is not available in the Windows port
3619 of libxpm. But XpmCreateImageFromBuffer almost does what we want. */
3620 rc
= fn_XpmCreateImageFromBuffer (&hdc
, SDATA (buffer
),
3621 &xpm_image
, &xpm_mask
,
3624 rc
= XpmCreateImageFromBuffer (FRAME_X_DISPLAY (f
), SSDATA (buffer
),
3625 &img
->ximg
, &img
->mask_img
,
3627 #endif /* HAVE_NTGUI */
3630 #ifdef HAVE_X_WINDOWS
3631 if (rc
== XpmSuccess
)
3633 img
->pixmap
= XCreatePixmap (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
3634 img
->ximg
->width
, img
->ximg
->height
,
3636 if (img
->pixmap
== NO_PIXMAP
)
3638 x_clear_image (f
, img
);
3641 else if (img
->mask_img
)
3643 img
->mask
= XCreatePixmap (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
3644 img
->mask_img
->width
,
3645 img
->mask_img
->height
,
3646 img
->mask_img
->depth
);
3647 if (img
->mask
== NO_PIXMAP
)
3649 x_clear_image (f
, img
);
3656 if (rc
== XpmSuccess
)
3658 #if defined (COLOR_TABLE_SUPPORT) && defined (ALLOC_XPM_COLORS)
3659 img
->colors
= colors_in_color_table (&img
->ncolors
);
3660 #else /* not ALLOC_XPM_COLORS */
3664 /* W32 XPM uses XImage to wrap what W32 Emacs calls a Pixmap,
3665 plus some duplicate attributes. */
3666 if (xpm_image
&& xpm_image
->bitmap
)
3668 img
->pixmap
= xpm_image
->bitmap
;
3669 /* XImageFree in libXpm frees XImage struct without destroying
3670 the bitmap, which is what we want. */
3671 fn_XImageFree (xpm_image
);
3673 if (xpm_mask
&& xpm_mask
->bitmap
)
3675 /* The mask appears to be inverted compared with what we expect.
3676 TODO: invert our expectations. See other places where we
3677 have to invert bits because our idea of masks is backwards. */
3679 old_obj
= SelectObject (hdc
, xpm_mask
->bitmap
);
3681 PatBlt (hdc
, 0, 0, xpm_mask
->width
, xpm_mask
->height
, DSTINVERT
);
3682 SelectObject (hdc
, old_obj
);
3684 img
->mask
= xpm_mask
->bitmap
;
3685 fn_XImageFree (xpm_mask
);
3690 #endif /* HAVE_NTGUI */
3692 /* Remember allocated colors. */
3693 img
->colors
= xnmalloc (attrs
.nalloc_pixels
, sizeof *img
->colors
);
3694 img
->ncolors
= attrs
.nalloc_pixels
;
3695 for (i
= 0; i
< attrs
.nalloc_pixels
; ++i
)
3697 img
->colors
[i
] = attrs
.alloc_pixels
[i
];
3698 #ifdef DEBUG_X_COLORS
3699 register_color (img
->colors
[i
]);
3702 #endif /* not ALLOC_XPM_COLORS */
3704 img
->width
= attrs
.width
;
3705 img
->height
= attrs
.height
;
3706 eassert (img
->width
> 0 && img
->height
> 0);
3708 /* The call to XpmFreeAttributes below frees attrs.alloc_pixels. */
3710 fn_XpmFreeAttributes (&attrs
);
3712 XpmFreeAttributes (&attrs
);
3713 #endif /* HAVE_NTGUI */
3715 #ifdef HAVE_X_WINDOWS
3716 /* Maybe fill in the background field while we have ximg handy. */
3717 IMAGE_BACKGROUND (img
, f
, img
->ximg
);
3719 /* Fill in the background_transparent field while we have the
3721 image_background_transparent (img
, f
, img
->mask_img
);
3728 #endif /* HAVE_NTGUI */
3733 image_error ("Error opening XPM file (%s)", img
->spec
, Qnil
);
3736 case XpmFileInvalid
:
3737 image_error ("Invalid XPM file (%s)", img
->spec
, Qnil
);
3741 image_error ("Out of memory (%s)", img
->spec
, Qnil
);
3744 case XpmColorFailed
:
3745 image_error ("Color allocation error (%s)", img
->spec
, Qnil
);
3749 image_error ("Unknown error (%s)", img
->spec
, Qnil
);
3754 #ifdef ALLOC_XPM_COLORS
3755 xpm_free_color_cache ();
3757 return rc
== XpmSuccess
;
3760 #endif /* HAVE_XPM */
3762 #if defined (HAVE_NS) && !defined (HAVE_XPM)
3764 /* XPM support functions for NS where libxpm is not available.
3765 Only XPM version 3 (without any extensions) is supported. */
3767 static void xpm_put_color_table_v (Lisp_Object
, const unsigned char *,
3769 static Lisp_Object
xpm_get_color_table_v (Lisp_Object
,
3770 const unsigned char *, int);
3771 static void xpm_put_color_table_h (Lisp_Object
, const unsigned char *,
3773 static Lisp_Object
xpm_get_color_table_h (Lisp_Object
,
3774 const unsigned char *, int);
3776 /* Tokens returned from xpm_scan. */
3785 /* Scan an XPM data and return a character (< 256) or a token defined
3786 by enum xpm_token above. *S and END are the start (inclusive) and
3787 the end (exclusive) addresses of the data, respectively. Advance
3788 *S while scanning. If token is either XPM_TK_IDENT or
3789 XPM_TK_STRING, *BEG and *LEN are set to the start address and the
3790 length of the corresponding token, respectively. */
3793 xpm_scan (const unsigned char **s
,
3794 const unsigned char *end
,
3795 const unsigned char **beg
,
3802 /* Skip white-space. */
3803 while (*s
< end
&& (c
= *(*s
)++, c_isspace (c
)))
3806 /* gnus-pointer.xpm uses '-' in its identifier.
3807 sb-dir-plus.xpm uses '+' in its identifier. */
3808 if (c_isalpha (c
) || c
== '_' || c
== '-' || c
== '+')
3812 && (c
= **s
, c_isalnum (c
)
3813 || c
== '_' || c
== '-' || c
== '+'))
3816 return XPM_TK_IDENT
;
3821 while (*s
< end
&& **s
!= '"')
3826 return XPM_TK_STRING
;
3830 if (*s
< end
&& **s
== '*')
3832 /* C-style comment. */
3836 while (*s
< end
&& *(*s
)++ != '*')
3839 while (*s
< end
&& **s
!= '/');
3853 /* Functions for color table lookup in XPM data. A key is a string
3854 specifying the color of each pixel in XPM data. A value is either
3855 an integer that specifies a pixel color, Qt that specifies
3856 transparency, or Qnil for the unspecified color. If the length of
3857 the key string is one, a vector is used as a table. Otherwise, a
3858 hash table is used. */
3861 xpm_make_color_table_v (void (**put_func
) (Lisp_Object
,
3862 const unsigned char *,
3865 Lisp_Object (**get_func
) (Lisp_Object
,
3866 const unsigned char *,
3869 *put_func
= xpm_put_color_table_v
;
3870 *get_func
= xpm_get_color_table_v
;
3871 return Fmake_vector (make_number (256), Qnil
);
3875 xpm_put_color_table_v (Lisp_Object color_table
,
3876 const unsigned char *chars_start
,
3880 ASET (color_table
, *chars_start
, color
);
3884 xpm_get_color_table_v (Lisp_Object color_table
,
3885 const unsigned char *chars_start
,
3888 return AREF (color_table
, *chars_start
);
3892 xpm_make_color_table_h (void (**put_func
) (Lisp_Object
,
3893 const unsigned char *,
3896 Lisp_Object (**get_func
) (Lisp_Object
,
3897 const unsigned char *,
3900 *put_func
= xpm_put_color_table_h
;
3901 *get_func
= xpm_get_color_table_h
;
3902 return make_hash_table (hashtest_equal
, make_number (DEFAULT_HASH_SIZE
),
3903 make_float (DEFAULT_REHASH_SIZE
),
3904 make_float (DEFAULT_REHASH_THRESHOLD
),
3909 xpm_put_color_table_h (Lisp_Object color_table
,
3910 const unsigned char *chars_start
,
3914 struct Lisp_Hash_Table
*table
= XHASH_TABLE (color_table
);
3915 EMACS_UINT hash_code
;
3916 Lisp_Object chars
= make_unibyte_string (chars_start
, chars_len
);
3918 hash_lookup (table
, chars
, &hash_code
);
3919 hash_put (table
, chars
, color
, hash_code
);
3923 xpm_get_color_table_h (Lisp_Object color_table
,
3924 const unsigned char *chars_start
,
3927 struct Lisp_Hash_Table
*table
= XHASH_TABLE (color_table
);
3929 hash_lookup (table
, make_unibyte_string (chars_start
, chars_len
), NULL
);
3931 return i
>= 0 ? HASH_VALUE (table
, i
) : Qnil
;
3934 enum xpm_color_key
{
3942 static const char xpm_color_key_strings
[][4] = {"s", "m", "g4", "g", "c"};
3945 xpm_str_to_color_key (const char *s
)
3950 i
< sizeof xpm_color_key_strings
/ sizeof xpm_color_key_strings
[0];
3952 if (strcmp (xpm_color_key_strings
[i
], s
) == 0)
3958 xpm_load_image (struct frame
*f
,
3960 const unsigned char *contents
,
3961 const unsigned char *end
)
3963 const unsigned char *s
= contents
, *beg
, *str
;
3964 unsigned char buffer
[BUFSIZ
];
3965 int width
, height
, x
, y
;
3966 int num_colors
, chars_per_pixel
;
3969 void (*put_color_table
) (Lisp_Object
, const unsigned char *, int, Lisp_Object
);
3970 Lisp_Object (*get_color_table
) (Lisp_Object
, const unsigned char *, int);
3971 Lisp_Object frame
, color_symbols
, color_table
;
3974 XImagePtr ximg
= NULL
, mask_img
= NULL
;
3977 LA1 = xpm_scan (&s, end, &beg, &len)
3979 #define expect(TOKEN) \
3980 if (LA1 != (TOKEN)) \
3985 #define expect_ident(IDENT) \
3986 if (LA1 == XPM_TK_IDENT \
3987 && strlen ((IDENT)) == len && memcmp ((IDENT), beg, len) == 0) \
3992 if (!(end
- s
>= 9 && memcmp (s
, "/* XPM */", 9) == 0))
3996 expect_ident ("static");
3997 expect_ident ("char");
3999 expect (XPM_TK_IDENT
);
4004 expect (XPM_TK_STRING
);
4007 memcpy (buffer
, beg
, len
);
4009 if (sscanf (buffer
, "%d %d %d %d", &width
, &height
,
4010 &num_colors
, &chars_per_pixel
) != 4
4011 || width
<= 0 || height
<= 0
4012 || num_colors
<= 0 || chars_per_pixel
<= 0)
4015 if (!check_image_size (f
, width
, height
))
4017 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
4021 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, 0, &ximg
, 0)
4023 || !image_create_x_image_and_pixmap (f
, img
, width
, height
, 1,
4028 image_error ("Image too large", Qnil
, Qnil
);
4034 XSETFRAME (frame
, f
);
4035 if (!NILP (Fxw_display_color_p (frame
)))
4036 best_key
= XPM_COLOR_KEY_C
;
4037 else if (!NILP (Fx_display_grayscale_p (frame
)))
4038 best_key
= (XFASTINT (Fx_display_planes (frame
)) > 2
4039 ? XPM_COLOR_KEY_G
: XPM_COLOR_KEY_G4
);
4041 best_key
= XPM_COLOR_KEY_M
;
4043 color_symbols
= image_spec_value (img
->spec
, QCcolor_symbols
, NULL
);
4044 if (chars_per_pixel
== 1)
4045 color_table
= xpm_make_color_table_v (&put_color_table
,
4048 color_table
= xpm_make_color_table_h (&put_color_table
,
4051 while (num_colors
-- > 0)
4053 char *color
, *max_color
;
4054 int key
, next_key
, max_key
= 0;
4055 Lisp_Object symbol_color
= Qnil
, color_val
;
4058 expect (XPM_TK_STRING
);
4059 if (len
<= chars_per_pixel
|| len
>= BUFSIZ
+ chars_per_pixel
)
4061 memcpy (buffer
, beg
+ chars_per_pixel
, len
- chars_per_pixel
);
4062 buffer
[len
- chars_per_pixel
] = '\0';
4064 str
= strtok (buffer
, " \t");
4067 key
= xpm_str_to_color_key (str
);
4072 color
= strtok (NULL
, " \t");
4076 while ((str
= strtok (NULL
, " \t")) != NULL
)
4078 next_key
= xpm_str_to_color_key (str
);
4081 color
[strlen (color
)] = ' ';
4084 if (key
== XPM_COLOR_KEY_S
)
4086 if (NILP (symbol_color
))
4087 symbol_color
= build_string (color
);
4089 else if (max_key
< key
&& key
<= best_key
)
4099 if (!NILP (color_symbols
) && !NILP (symbol_color
))
4101 Lisp_Object specified_color
= Fassoc (symbol_color
, color_symbols
);
4103 if (CONSP (specified_color
) && STRINGP (XCDR (specified_color
)))
4105 if (xstrcasecmp (SSDATA (XCDR (specified_color
)), "None") == 0)
4107 else if (x_defined_color (f
, SSDATA (XCDR (specified_color
)),
4109 color_val
= make_number (cdef
.pixel
);
4112 if (NILP (color_val
) && max_key
> 0)
4114 if (xstrcasecmp (max_color
, "None") == 0)
4116 else if (x_defined_color (f
, max_color
, &cdef
, 0))
4117 color_val
= make_number (cdef
.pixel
);
4119 if (!NILP (color_val
))
4120 (*put_color_table
) (color_table
, beg
, chars_per_pixel
, color_val
);
4125 for (y
= 0; y
< height
; y
++)
4127 expect (XPM_TK_STRING
);
4129 if (len
< width
* chars_per_pixel
)
4131 for (x
= 0; x
< width
; x
++, str
+= chars_per_pixel
)
4133 Lisp_Object color_val
=
4134 (*get_color_table
) (color_table
, str
, chars_per_pixel
);
4136 XPutPixel (ximg
, x
, y
,
4137 (INTEGERP (color_val
) ? XINT (color_val
)
4138 : FRAME_FOREGROUND_PIXEL (f
)));
4140 XPutPixel (mask_img
, x
, y
,
4141 (!EQ (color_val
, Qt
) ? PIX_MASK_DRAW
4142 : (have_mask
= 1, PIX_MASK_RETAIN
)));
4144 if (EQ (color_val
, Qt
))
4145 ns_set_alpha (ximg
, x
, y
, 0);
4153 img
->height
= height
;
4155 /* Maybe fill in the background field while we have ximg handy. */
4156 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
4157 IMAGE_BACKGROUND (img
, f
, ximg
);
4159 image_put_x_image (f
, img
, ximg
, 0);
4163 /* Fill in the background_transparent field while we have the
4165 image_background_transparent (img
, f
, mask_img
);
4167 image_put_x_image (f
, img
, mask_img
, 1);
4171 x_destroy_x_image (mask_img
);
4172 x_clear_image_1 (f
, img
, CLEAR_IMAGE_MASK
);
4178 image_error ("Invalid XPM file (%s)", img
->spec
, Qnil
);
4179 x_destroy_x_image (ximg
);
4180 x_destroy_x_image (mask_img
);
4181 x_clear_image (f
, img
);
4190 xpm_load (struct frame
*f
,
4194 Lisp_Object file_name
;
4196 /* If IMG->spec specifies a file name, create a non-file spec from it. */
4197 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
4198 if (STRINGP (file_name
))
4201 unsigned char *contents
;
4204 file
= x_find_image_file (file_name
);
4205 if (!STRINGP (file
))
4207 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
4211 contents
= slurp_file (SSDATA (file
), &size
);
4212 if (contents
== NULL
)
4214 image_error ("Error loading XPM image `%s'", img
->spec
, Qnil
);
4218 success_p
= xpm_load_image (f
, img
, contents
, contents
+ size
);
4225 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
4226 if (!STRINGP (data
))
4228 image_error ("Invalid image data `%s'", data
, Qnil
);
4231 success_p
= xpm_load_image (f
, img
, SDATA (data
),
4232 SDATA (data
) + SBYTES (data
));
4238 #endif /* HAVE_NS && !HAVE_XPM */
4242 /***********************************************************************
4244 ***********************************************************************/
4246 #ifdef COLOR_TABLE_SUPPORT
4248 /* An entry in the color table mapping an RGB color to a pixel color. */
4253 unsigned long pixel
;
4255 /* Next in color table collision list. */
4256 struct ct_color
*next
;
4259 /* The bucket vector size to use. Must be prime. */
4263 /* Value is a hash of the RGB color given by R, G, and B. */
4265 #define CT_HASH_RGB(R, G, B) (((R) << 16) ^ ((G) << 8) ^ (B))
4267 /* The color hash table. */
4269 static struct ct_color
**ct_table
;
4271 /* Number of entries in the color table. */
4273 static int ct_colors_allocated
;
4276 ct_colors_allocated_max
=
4278 min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof (unsigned long))
4281 /* Initialize the color table. */
4284 init_color_table (void)
4286 int size
= CT_SIZE
* sizeof (*ct_table
);
4287 ct_table
= xzalloc (size
);
4288 ct_colors_allocated
= 0;
4292 /* Free memory associated with the color table. */
4295 free_color_table (void)
4298 struct ct_color
*p
, *next
;
4300 for (i
= 0; i
< CT_SIZE
; ++i
)
4301 for (p
= ct_table
[i
]; p
; p
= next
)
4312 /* Value is a pixel color for RGB color R, G, B on frame F. If an
4313 entry for that color already is in the color table, return the
4314 pixel color of that entry. Otherwise, allocate a new color for R,
4315 G, B, and make an entry in the color table. */
4317 static unsigned long
4318 lookup_rgb_color (struct frame
*f
, int r
, int g
, int b
)
4320 unsigned hash
= CT_HASH_RGB (r
, g
, b
);
4321 int i
= hash
% CT_SIZE
;
4323 Display_Info
*dpyinfo
;
4325 /* Handle TrueColor visuals specially, which improves performance by
4326 two orders of magnitude. Freeing colors on TrueColor visuals is
4327 a nop, and pixel colors specify RGB values directly. See also
4328 the Xlib spec, chapter 3.1. */
4329 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
4330 if (dpyinfo
->red_bits
> 0)
4332 unsigned long pr
, pg
, pb
;
4334 /* Apply gamma-correction like normal color allocation does. */
4338 color
.red
= r
, color
.green
= g
, color
.blue
= b
;
4339 gamma_correct (f
, &color
);
4340 r
= color
.red
, g
= color
.green
, b
= color
.blue
;
4343 /* Scale down RGB values to the visual's bits per RGB, and shift
4344 them to the right position in the pixel color. Note that the
4345 original RGB values are 16-bit values, as usual in X. */
4346 pr
= (r
>> (16 - dpyinfo
->red_bits
)) << dpyinfo
->red_offset
;
4347 pg
= (g
>> (16 - dpyinfo
->green_bits
)) << dpyinfo
->green_offset
;
4348 pb
= (b
>> (16 - dpyinfo
->blue_bits
)) << dpyinfo
->blue_offset
;
4350 /* Assemble the pixel color. */
4351 return pr
| pg
| pb
;
4354 for (p
= ct_table
[i
]; p
; p
= p
->next
)
4355 if (p
->r
== r
&& p
->g
== g
&& p
->b
== b
)
4361 #ifdef HAVE_X_WINDOWS
4369 if (ct_colors_allocated_max
<= ct_colors_allocated
)
4370 return FRAME_FOREGROUND_PIXEL (f
);
4372 #ifdef HAVE_X_WINDOWS
4377 cmap
= FRAME_X_COLORMAP (f
);
4378 rc
= x_alloc_nearest_color (f
, cmap
, &color
);
4381 ++ct_colors_allocated
;
4382 p
= xmalloc (sizeof *p
);
4386 p
->pixel
= color
.pixel
;
4387 p
->next
= ct_table
[i
];
4391 return FRAME_FOREGROUND_PIXEL (f
);
4395 color
= PALETTERGB (r
, g
, b
);
4397 color
= RGB_TO_ULONG (r
, g
, b
);
4398 #endif /* HAVE_NTGUI */
4399 ++ct_colors_allocated
;
4400 p
= xmalloc (sizeof *p
);
4405 p
->next
= ct_table
[i
];
4407 #endif /* HAVE_X_WINDOWS */
4415 /* Look up pixel color PIXEL which is used on frame F in the color
4416 table. If not already present, allocate it. Value is PIXEL. */
4418 static unsigned long
4419 lookup_pixel_color (struct frame
*f
, unsigned long pixel
)
4421 int i
= pixel
% CT_SIZE
;
4424 for (p
= ct_table
[i
]; p
; p
= p
->next
)
4425 if (p
->pixel
== pixel
)
4434 if (ct_colors_allocated_max
<= ct_colors_allocated
)
4435 return FRAME_FOREGROUND_PIXEL (f
);
4437 #ifdef HAVE_X_WINDOWS
4438 cmap
= FRAME_X_COLORMAP (f
);
4439 color
.pixel
= pixel
;
4440 x_query_color (f
, &color
);
4441 rc
= x_alloc_nearest_color (f
, cmap
, &color
);
4444 cmap
= DefaultColormapOfScreen (FRAME_X_SCREEN (f
));
4445 color
.pixel
= pixel
;
4446 XQueryColor (NULL
, cmap
, &color
);
4447 rc
= x_alloc_nearest_color (f
, cmap
, &color
);
4449 #endif /* HAVE_X_WINDOWS */
4453 ++ct_colors_allocated
;
4455 p
= xmalloc (sizeof *p
);
4460 p
->next
= ct_table
[i
];
4464 return FRAME_FOREGROUND_PIXEL (f
);
4470 /* Value is a vector of all pixel colors contained in the color table,
4471 allocated via xmalloc. Set *N to the number of colors. */
4473 static unsigned long *
4474 colors_in_color_table (int *n
)
4478 unsigned long *colors
;
4480 if (ct_colors_allocated
== 0)
4487 colors
= xmalloc (ct_colors_allocated
* sizeof *colors
);
4488 *n
= ct_colors_allocated
;
4490 for (i
= j
= 0; i
< CT_SIZE
; ++i
)
4491 for (p
= ct_table
[i
]; p
; p
= p
->next
)
4492 colors
[j
++] = p
->pixel
;
4498 #else /* COLOR_TABLE_SUPPORT */
4500 static unsigned long
4501 lookup_rgb_color (struct frame
*f
, int r
, int g
, int b
)
4503 unsigned long pixel
;
4506 pixel
= PALETTERGB (r
>> 8, g
>> 8, b
>> 8);
4507 #endif /* HAVE_NTGUI */
4510 pixel
= RGB_TO_ULONG (r
>> 8, g
>> 8, b
>> 8);
4511 #endif /* HAVE_NS */
4516 init_color_table (void)
4519 #endif /* COLOR_TABLE_SUPPORT */
4522 /***********************************************************************
4524 ***********************************************************************/
4526 /* Edge detection matrices for different edge-detection
4529 static int emboss_matrix
[9] = {
4531 2, -1, 0, /* y - 1 */
4533 0, 1, -2 /* y + 1 */
4536 static int laplace_matrix
[9] = {
4538 1, 0, 0, /* y - 1 */
4540 0, 0, -1 /* y + 1 */
4543 /* Value is the intensity of the color whose red/green/blue values
4546 #define COLOR_INTENSITY(R, G, B) ((2 * (R) + 3 * (G) + (B)) / 6)
4549 /* On frame F, return an array of XColor structures describing image
4550 IMG->pixmap. Each XColor structure has its pixel color set. RGB_P
4551 means also fill the red/green/blue members of the XColor
4552 structures. Value is a pointer to the array of XColors structures,
4553 allocated with xmalloc; it must be freed by the caller. */
4556 x_to_xcolors (struct frame
*f
, struct image
*img
, bool rgb_p
)
4560 XImagePtr_or_DC ximg
;
4563 #endif /* HAVE_NTGUI */
4565 if (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *colors
/ img
->width
< img
->height
)
4566 memory_full (SIZE_MAX
);
4567 colors
= xmalloc (sizeof *colors
* img
->width
* img
->height
);
4569 /* Get the X image or create a memory device context for IMG. */
4570 ximg
= image_get_x_image_or_dc (f
, img
, 0, &prev
);
4572 /* Fill the `pixel' members of the XColor array. I wished there
4573 were an easy and portable way to circumvent XGetPixel. */
4575 for (y
= 0; y
< img
->height
; ++y
)
4577 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI)
4579 for (x
= 0; x
< img
->width
; ++x
, ++p
)
4580 p
->pixel
= GET_PIXEL (ximg
, x
, y
);
4582 x_query_colors (f
, row
, img
->width
);
4586 for (x
= 0; x
< img
->width
; ++x
, ++p
)
4588 /* W32_TODO: palette support needed here? */
4589 p
->pixel
= GET_PIXEL (ximg
, x
, y
);
4592 p
->red
= RED16_FROM_ULONG (p
->pixel
);
4593 p
->green
= GREEN16_FROM_ULONG (p
->pixel
);
4594 p
->blue
= BLUE16_FROM_ULONG (p
->pixel
);
4597 #endif /* HAVE_X_WINDOWS */
4600 image_unget_x_image_or_dc (img
, 0, ximg
, prev
);
4607 /* Put a pixel of COLOR at position X, Y in XIMG. XIMG must have been
4608 created with CreateDIBSection, with the pointer to the bit values
4609 stored in ximg->data. */
4612 XPutPixel (XImagePtr ximg
, int x
, int y
, COLORREF color
)
4614 int width
= ximg
->info
.bmiHeader
.biWidth
;
4615 unsigned char * pixel
;
4617 /* True color images. */
4618 if (ximg
->info
.bmiHeader
.biBitCount
== 24)
4620 int rowbytes
= width
* 3;
4621 /* Ensure scanlines are aligned on 4 byte boundaries. */
4623 rowbytes
+= 4 - (rowbytes
% 4);
4625 pixel
= ximg
->data
+ y
* rowbytes
+ x
* 3;
4626 /* Windows bitmaps are in BGR order. */
4627 *pixel
= GetBValue (color
);
4628 *(pixel
+ 1) = GetGValue (color
);
4629 *(pixel
+ 2) = GetRValue (color
);
4631 /* Monochrome images. */
4632 else if (ximg
->info
.bmiHeader
.biBitCount
== 1)
4634 int rowbytes
= width
/ 8;
4635 /* Ensure scanlines are aligned on 4 byte boundaries. */
4637 rowbytes
+= 4 - (rowbytes
% 4);
4638 pixel
= ximg
->data
+ y
* rowbytes
+ x
/ 8;
4639 /* Filter out palette info. */
4640 if (color
& 0x00ffffff)
4641 *pixel
= *pixel
| (1 << x
% 8);
4643 *pixel
= *pixel
& ~(1 << x
% 8);
4646 image_error ("XPutPixel: palette image not supported", Qnil
, Qnil
);
4649 #endif /* HAVE_NTGUI */
4651 /* Create IMG->pixmap from an array COLORS of XColor structures, whose
4652 RGB members are set. F is the frame on which this all happens.
4653 COLORS will be freed; an existing IMG->pixmap will be freed, too. */
4656 x_from_xcolors (struct frame
*f
, struct image
*img
, XColor
*colors
)
4659 XImagePtr oimg
= NULL
;
4662 init_color_table ();
4664 x_clear_image_1 (f
, img
, CLEAR_IMAGE_PIXMAP
| CLEAR_IMAGE_COLORS
);
4665 image_create_x_image_and_pixmap (f
, img
, img
->width
, img
->height
, 0,
4668 for (y
= 0; y
< img
->height
; ++y
)
4669 for (x
= 0; x
< img
->width
; ++x
, ++p
)
4671 unsigned long pixel
;
4672 pixel
= lookup_rgb_color (f
, p
->red
, p
->green
, p
->blue
);
4673 XPutPixel (oimg
, x
, y
, pixel
);
4678 image_put_x_image (f
, img
, oimg
, 0);
4679 #ifdef COLOR_TABLE_SUPPORT
4680 img
->colors
= colors_in_color_table (&img
->ncolors
);
4681 free_color_table ();
4682 #endif /* COLOR_TABLE_SUPPORT */
4686 /* On frame F, perform edge-detection on image IMG.
4688 MATRIX is a nine-element array specifying the transformation
4689 matrix. See emboss_matrix for an example.
4691 COLOR_ADJUST is a color adjustment added to each pixel of the
4695 x_detect_edges (struct frame
*f
, struct image
*img
, int *matrix
, int color_adjust
)
4697 XColor
*colors
= x_to_xcolors (f
, img
, 1);
4701 for (i
= sum
= 0; i
< 9; ++i
)
4702 sum
+= eabs (matrix
[i
]);
4704 #define COLOR(A, X, Y) ((A) + (Y) * img->width + (X))
4706 if (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *new / img
->width
< img
->height
)
4707 memory_full (SIZE_MAX
);
4708 new = xmalloc (sizeof *new * img
->width
* img
->height
);
4710 for (y
= 0; y
< img
->height
; ++y
)
4712 p
= COLOR (new, 0, y
);
4713 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4714 p
= COLOR (new, img
->width
- 1, y
);
4715 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4718 for (x
= 1; x
< img
->width
- 1; ++x
)
4720 p
= COLOR (new, x
, 0);
4721 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4722 p
= COLOR (new, x
, img
->height
- 1);
4723 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4726 for (y
= 1; y
< img
->height
- 1; ++y
)
4728 p
= COLOR (new, 1, y
);
4730 for (x
= 1; x
< img
->width
- 1; ++x
, ++p
)
4732 int r
, g
, b
, yy
, xx
;
4735 for (yy
= y
- 1; yy
< y
+ 2; ++yy
)
4736 for (xx
= x
- 1; xx
< x
+ 2; ++xx
, ++i
)
4739 XColor
*t
= COLOR (colors
, xx
, yy
);
4740 r
+= matrix
[i
] * t
->red
;
4741 g
+= matrix
[i
] * t
->green
;
4742 b
+= matrix
[i
] * t
->blue
;
4745 r
= (r
/ sum
+ color_adjust
) & 0xffff;
4746 g
= (g
/ sum
+ color_adjust
) & 0xffff;
4747 b
= (b
/ sum
+ color_adjust
) & 0xffff;
4748 p
->red
= p
->green
= p
->blue
= COLOR_INTENSITY (r
, g
, b
);
4753 x_from_xcolors (f
, img
, new);
4759 /* Perform the pre-defined `emboss' edge-detection on image IMG
4763 x_emboss (struct frame
*f
, struct image
*img
)
4765 x_detect_edges (f
, img
, emboss_matrix
, 0xffff / 2);
4769 /* Transform image IMG which is used on frame F with a Laplace
4770 edge-detection algorithm. The result is an image that can be used
4771 to draw disabled buttons, for example. */
4774 x_laplace (struct frame
*f
, struct image
*img
)
4776 x_detect_edges (f
, img
, laplace_matrix
, 45000);
4780 /* Perform edge-detection on image IMG on frame F, with specified
4781 transformation matrix MATRIX and color-adjustment COLOR_ADJUST.
4783 MATRIX must be either
4785 - a list of at least 9 numbers in row-major form
4786 - a vector of at least 9 numbers
4788 COLOR_ADJUST nil means use a default; otherwise it must be a
4792 x_edge_detection (struct frame
*f
, struct image
*img
, Lisp_Object matrix
,
4793 Lisp_Object color_adjust
)
4801 i
< 9 && CONSP (matrix
) && NUMBERP (XCAR (matrix
));
4802 ++i
, matrix
= XCDR (matrix
))
4803 trans
[i
] = XFLOATINT (XCAR (matrix
));
4805 else if (VECTORP (matrix
) && ASIZE (matrix
) >= 9)
4807 for (i
= 0; i
< 9 && NUMBERP (AREF (matrix
, i
)); ++i
)
4808 trans
[i
] = XFLOATINT (AREF (matrix
, i
));
4811 if (NILP (color_adjust
))
4812 color_adjust
= make_number (0xffff / 2);
4814 if (i
== 9 && NUMBERP (color_adjust
))
4815 x_detect_edges (f
, img
, trans
, XFLOATINT (color_adjust
));
4819 /* Transform image IMG on frame F so that it looks disabled. */
4822 x_disable_image (struct frame
*f
, struct image
*img
)
4824 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
4826 int n_planes
= dpyinfo
->n_planes
* dpyinfo
->n_cbits
;
4828 int n_planes
= dpyinfo
->n_planes
;
4829 #endif /* HAVE_NTGUI */
4833 /* Color (or grayscale). Convert to gray, and equalize. Just
4834 drawing such images with a stipple can look very odd, so
4835 we're using this method instead. */
4836 XColor
*colors
= x_to_xcolors (f
, img
, 1);
4838 const int h
= 15000;
4839 const int l
= 30000;
4841 for (p
= colors
, end
= colors
+ img
->width
* img
->height
;
4845 int i
= COLOR_INTENSITY (p
->red
, p
->green
, p
->blue
);
4846 int i2
= (0xffff - h
- l
) * i
/ 0xffff + l
;
4847 p
->red
= p
->green
= p
->blue
= i2
;
4850 x_from_xcolors (f
, img
, colors
);
4853 /* Draw a cross over the disabled image, if we must or if we
4855 if (n_planes
< 2 || cross_disabled_images
)
4858 #ifndef HAVE_NS /* TODO: NS support, however this not needed for toolbars */
4860 #define MaskForeground(f) WHITE_PIX_DEFAULT (f)
4862 Display
*dpy
= FRAME_X_DISPLAY (f
);
4865 image_sync_to_pixmaps (f
, img
);
4866 gc
= XCreateGC (dpy
, img
->pixmap
, 0, NULL
);
4867 XSetForeground (dpy
, gc
, BLACK_PIX_DEFAULT (f
));
4868 XDrawLine (dpy
, img
->pixmap
, gc
, 0, 0,
4869 img
->width
- 1, img
->height
- 1);
4870 XDrawLine (dpy
, img
->pixmap
, gc
, 0, img
->height
- 1,
4876 gc
= XCreateGC (dpy
, img
->mask
, 0, NULL
);
4877 XSetForeground (dpy
, gc
, MaskForeground (f
));
4878 XDrawLine (dpy
, img
->mask
, gc
, 0, 0,
4879 img
->width
- 1, img
->height
- 1);
4880 XDrawLine (dpy
, img
->mask
, gc
, 0, img
->height
- 1,
4884 #endif /* !HAVE_NS */
4889 hdc
= get_frame_dc (f
);
4890 bmpdc
= CreateCompatibleDC (hdc
);
4891 release_frame_dc (f
, hdc
);
4893 prev
= SelectObject (bmpdc
, img
->pixmap
);
4895 SetTextColor (bmpdc
, BLACK_PIX_DEFAULT (f
));
4896 MoveToEx (bmpdc
, 0, 0, NULL
);
4897 LineTo (bmpdc
, img
->width
- 1, img
->height
- 1);
4898 MoveToEx (bmpdc
, 0, img
->height
- 1, NULL
);
4899 LineTo (bmpdc
, img
->width
- 1, 0);
4903 SelectObject (bmpdc
, img
->mask
);
4904 SetTextColor (bmpdc
, WHITE_PIX_DEFAULT (f
));
4905 MoveToEx (bmpdc
, 0, 0, NULL
);
4906 LineTo (bmpdc
, img
->width
- 1, img
->height
- 1);
4907 MoveToEx (bmpdc
, 0, img
->height
- 1, NULL
);
4908 LineTo (bmpdc
, img
->width
- 1, 0);
4910 SelectObject (bmpdc
, prev
);
4912 #endif /* HAVE_NTGUI */
4917 /* Build a mask for image IMG which is used on frame F. FILE is the
4918 name of an image file, for error messages. HOW determines how to
4919 determine the background color of IMG. If it is a list '(R G B)',
4920 with R, G, and B being integers >= 0, take that as the color of the
4921 background. Otherwise, determine the background color of IMG
4925 x_build_heuristic_mask (struct frame
*f
, struct image
*img
, Lisp_Object how
)
4927 XImagePtr_or_DC ximg
;
4934 #endif /* HAVE_NTGUI */
4936 bool rc
, use_img_background
;
4937 unsigned long bg
= 0;
4940 x_clear_image_1 (f
, img
, CLEAR_IMAGE_MASK
);
4944 /* Create an image and pixmap serving as mask. */
4945 rc
= image_create_x_image_and_pixmap (f
, img
, img
->width
, img
->height
, 1,
4949 #endif /* !HAVE_NS */
4951 /* Create the bit array serving as mask. */
4952 row_width
= (img
->width
+ 7) / 8;
4953 mask_img
= xzalloc (row_width
* img
->height
);
4954 #endif /* HAVE_NTGUI */
4956 /* Get the X image or create a memory device context for IMG. */
4957 ximg
= image_get_x_image_or_dc (f
, img
, 0, &prev
);
4959 /* Determine the background color of ximg. If HOW is `(R G B)'
4960 take that as color. Otherwise, use the image's background color. */
4961 use_img_background
= 1;
4967 for (i
= 0; i
< 3 && CONSP (how
) && NATNUMP (XCAR (how
)); ++i
)
4969 rgb
[i
] = XFASTINT (XCAR (how
)) & 0xffff;
4973 if (i
== 3 && NILP (how
))
4975 char color_name
[30];
4976 sprintf (color_name
, "#%04x%04x%04x", rgb
[0], rgb
[1], rgb
[2]);
4979 0x00ffffff & /* Filter out palette info. */
4980 #endif /* HAVE_NTGUI */
4981 x_alloc_image_color (f
, img
, build_string (color_name
), 0));
4982 use_img_background
= 0;
4986 if (use_img_background
)
4987 bg
= four_corners_best (ximg
, img
->corners
, img
->width
, img
->height
);
4989 /* Set all bits in mask_img to 1 whose color in ximg is different
4990 from the background color bg. */
4992 for (y
= 0; y
< img
->height
; ++y
)
4993 for (x
= 0; x
< img
->width
; ++x
)
4995 XPutPixel (mask_img
, x
, y
, (XGetPixel (ximg
, x
, y
) != bg
4996 ? PIX_MASK_DRAW
: PIX_MASK_RETAIN
));
4998 if (XGetPixel (ximg
, x
, y
) == bg
)
4999 ns_set_alpha (ximg
, x
, y
, 0);
5000 #endif /* HAVE_NS */
5002 /* Fill in the background_transparent field while we have the mask handy. */
5003 image_background_transparent (img
, f
, mask_img
);
5005 /* Put mask_img into the image. */
5006 image_put_x_image (f
, img
, mask_img
, 1);
5007 #endif /* !HAVE_NS */
5009 for (y
= 0; y
< img
->height
; ++y
)
5010 for (x
= 0; x
< img
->width
; ++x
)
5012 COLORREF p
= GetPixel (ximg
, x
, y
);
5014 mask_img
[y
* row_width
+ x
/ 8] |= 1 << (x
% 8);
5017 /* Create the mask image. */
5018 img
->mask
= w32_create_pixmap_from_bitmap_data (img
->width
, img
->height
,
5020 /* Fill in the background_transparent field while we have the mask handy. */
5021 SelectObject (ximg
, img
->mask
);
5022 image_background_transparent (img
, f
, ximg
);
5024 /* Was: x_destroy_x_image ((XImagePtr )mask_img); which seems bogus ++kfs */
5026 #endif /* HAVE_NTGUI */
5028 image_unget_x_image_or_dc (img
, 0, ximg
, prev
);
5032 /***********************************************************************
5033 PBM (mono, gray, color)
5034 ***********************************************************************/
5036 static bool pbm_image_p (Lisp_Object object
);
5037 static bool pbm_load (struct frame
*f
, struct image
*img
);
5039 /* The symbol `pbm' identifying images of this type. */
5041 static Lisp_Object Qpbm
;
5043 /* Indices of image specification fields in gs_format, below. */
5045 enum pbm_keyword_index
5061 /* Vector of image_keyword structures describing the format
5062 of valid user-defined image specifications. */
5064 static const struct image_keyword pbm_format
[PBM_LAST
] =
5066 {":type", IMAGE_SYMBOL_VALUE
, 1},
5067 {":file", IMAGE_STRING_VALUE
, 0},
5068 {":data", IMAGE_STRING_VALUE
, 0},
5069 {":ascent", IMAGE_ASCENT_VALUE
, 0},
5070 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
5071 {":relief", IMAGE_INTEGER_VALUE
, 0},
5072 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5073 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5074 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5075 {":foreground", IMAGE_STRING_OR_NIL_VALUE
, 0},
5076 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
5079 /* Structure describing the image type `pbm'. */
5081 static struct image_type pbm_type
=
5092 /* Return true if OBJECT is a valid PBM image specification. */
5095 pbm_image_p (Lisp_Object object
)
5097 struct image_keyword fmt
[PBM_LAST
];
5099 memcpy (fmt
, pbm_format
, sizeof fmt
);
5101 if (!parse_image_spec (object
, fmt
, PBM_LAST
, Qpbm
))
5104 /* Must specify either :data or :file. */
5105 return fmt
[PBM_DATA
].count
+ fmt
[PBM_FILE
].count
== 1;
5109 /* Scan a decimal number from *S and return it. Advance *S while
5110 reading the number. END is the end of the string. Value is -1 at
5114 pbm_scan_number (unsigned char **s
, unsigned char *end
)
5116 int c
= 0, val
= -1;
5120 /* Skip white-space. */
5121 while (*s
< end
&& (c
= *(*s
)++, c_isspace (c
)))
5126 /* Skip comment to end of line. */
5127 while (*s
< end
&& (c
= *(*s
)++, c
!= '\n'))
5130 else if (c_isdigit (c
))
5132 /* Read decimal number. */
5134 while (*s
< end
&& (c
= *(*s
)++, c_isdigit (c
)))
5135 val
= 10 * val
+ c
- '0';
5146 /* Load PBM image IMG for use on frame F. */
5149 pbm_load (struct frame
*f
, struct image
*img
)
5153 int width
, height
, max_color_idx
= 0;
5155 Lisp_Object file
, specified_file
;
5156 enum {PBM_MONO
, PBM_GRAY
, PBM_COLOR
} type
;
5157 unsigned char *contents
= NULL
;
5158 unsigned char *end
, *p
;
5161 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
5163 if (STRINGP (specified_file
))
5165 file
= x_find_image_file (specified_file
);
5166 if (!STRINGP (file
))
5168 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
5172 contents
= slurp_file (SSDATA (file
), &size
);
5173 if (contents
== NULL
)
5175 image_error ("Error reading `%s'", file
, Qnil
);
5180 end
= contents
+ size
;
5185 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
5186 if (!STRINGP (data
))
5188 image_error ("Invalid image data `%s'", data
, Qnil
);
5192 end
= p
+ SBYTES (data
);
5195 /* Check magic number. */
5196 if (end
- p
< 2 || *p
++ != 'P')
5198 image_error ("Not a PBM image: `%s'", img
->spec
, Qnil
);
5207 raw_p
= 0, type
= PBM_MONO
;
5211 raw_p
= 0, type
= PBM_GRAY
;
5215 raw_p
= 0, type
= PBM_COLOR
;
5219 raw_p
= 1, type
= PBM_MONO
;
5223 raw_p
= 1, type
= PBM_GRAY
;
5227 raw_p
= 1, type
= PBM_COLOR
;
5231 image_error ("Not a PBM image: `%s'", img
->spec
, Qnil
);
5235 /* Read width, height, maximum color-component. Characters
5236 starting with `#' up to the end of a line are ignored. */
5237 width
= pbm_scan_number (&p
, end
);
5238 height
= pbm_scan_number (&p
, end
);
5240 if (type
!= PBM_MONO
)
5242 max_color_idx
= pbm_scan_number (&p
, end
);
5243 if (max_color_idx
> 65535 || max_color_idx
< 0)
5245 image_error ("Unsupported maximum PBM color value", Qnil
, Qnil
);
5250 if (!check_image_size (f
, width
, height
))
5252 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
5256 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, 0, &ximg
, 0))
5259 /* Initialize the color hash table. */
5260 init_color_table ();
5262 if (type
== PBM_MONO
)
5265 struct image_keyword fmt
[PBM_LAST
];
5266 unsigned long fg
= FRAME_FOREGROUND_PIXEL (f
);
5267 unsigned long bg
= FRAME_BACKGROUND_PIXEL (f
);
5269 /* Parse the image specification. */
5270 memcpy (fmt
, pbm_format
, sizeof fmt
);
5271 parse_image_spec (img
->spec
, fmt
, PBM_LAST
, Qpbm
);
5273 /* Get foreground and background colors, maybe allocate colors. */
5274 if (fmt
[PBM_FOREGROUND
].count
5275 && STRINGP (fmt
[PBM_FOREGROUND
].value
))
5276 fg
= x_alloc_image_color (f
, img
, fmt
[PBM_FOREGROUND
].value
, fg
);
5277 if (fmt
[PBM_BACKGROUND
].count
5278 && STRINGP (fmt
[PBM_BACKGROUND
].value
))
5280 bg
= x_alloc_image_color (f
, img
, fmt
[PBM_BACKGROUND
].value
, bg
);
5281 img
->background
= bg
;
5282 img
->background_valid
= 1;
5285 for (y
= 0; y
< height
; ++y
)
5286 for (x
= 0; x
< width
; ++x
)
5294 x_destroy_x_image (ximg
);
5295 x_clear_image (f
, img
);
5296 image_error ("Invalid image size in image `%s'",
5306 g
= pbm_scan_number (&p
, end
);
5308 XPutPixel (ximg
, x
, y
, g
? fg
: bg
);
5313 int expected_size
= height
* width
;
5314 if (max_color_idx
> 255)
5316 if (type
== PBM_COLOR
)
5319 if (raw_p
&& p
+ expected_size
> end
)
5321 x_destroy_x_image (ximg
);
5322 x_clear_image (f
, img
);
5323 image_error ("Invalid image size in image `%s'",
5328 for (y
= 0; y
< height
; ++y
)
5329 for (x
= 0; x
< width
; ++x
)
5333 if (type
== PBM_GRAY
&& raw_p
)
5336 if (max_color_idx
> 255)
5337 r
= g
= b
= r
* 256 + *p
++;
5339 else if (type
== PBM_GRAY
)
5340 r
= g
= b
= pbm_scan_number (&p
, end
);
5344 if (max_color_idx
> 255)
5347 if (max_color_idx
> 255)
5350 if (max_color_idx
> 255)
5355 r
= pbm_scan_number (&p
, end
);
5356 g
= pbm_scan_number (&p
, end
);
5357 b
= pbm_scan_number (&p
, end
);
5360 if (r
< 0 || g
< 0 || b
< 0)
5362 x_destroy_x_image (ximg
);
5363 image_error ("Invalid pixel value in image `%s'",
5368 /* RGB values are now in the range 0..max_color_idx.
5369 Scale this to the range 0..0xffff supported by X. */
5370 r
= (double) r
* 65535 / max_color_idx
;
5371 g
= (double) g
* 65535 / max_color_idx
;
5372 b
= (double) b
* 65535 / max_color_idx
;
5373 XPutPixel (ximg
, x
, y
, lookup_rgb_color (f
, r
, g
, b
));
5377 #ifdef COLOR_TABLE_SUPPORT
5378 /* Store in IMG->colors the colors allocated for the image, and
5379 free the color table. */
5380 img
->colors
= colors_in_color_table (&img
->ncolors
);
5381 free_color_table ();
5382 #endif /* COLOR_TABLE_SUPPORT */
5385 img
->height
= height
;
5387 /* Maybe fill in the background field while we have ximg handy. */
5389 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
5390 /* Casting avoids a GCC warning. */
5391 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
5393 /* Put ximg into the image. */
5394 image_put_x_image (f
, img
, ximg
, 0);
5396 /* X and W32 versions did it here, MAC version above. ++kfs
5398 img->height = height; */
5405 /***********************************************************************
5407 ***********************************************************************/
5409 #if defined (HAVE_PNG) || defined (HAVE_NS)
5411 /* Function prototypes. */
5413 static bool png_image_p (Lisp_Object object
);
5414 static bool png_load (struct frame
*f
, struct image
*img
);
5416 /* The symbol `png' identifying images of this type. */
5418 static Lisp_Object Qpng
;
5420 /* Indices of image specification fields in png_format, below. */
5422 enum png_keyword_index
5437 /* Vector of image_keyword structures describing the format
5438 of valid user-defined image specifications. */
5440 static const struct image_keyword png_format
[PNG_LAST
] =
5442 {":type", IMAGE_SYMBOL_VALUE
, 1},
5443 {":data", IMAGE_STRING_VALUE
, 0},
5444 {":file", IMAGE_STRING_VALUE
, 0},
5445 {":ascent", IMAGE_ASCENT_VALUE
, 0},
5446 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
5447 {":relief", IMAGE_INTEGER_VALUE
, 0},
5448 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5449 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5450 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5451 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
5454 #if defined HAVE_NTGUI && defined WINDOWSNT
5455 static bool init_png_functions (void);
5457 #define init_png_functions NULL
5460 /* Structure describing the image type `png'. */
5462 static struct image_type png_type
=
5472 /* Return true if OBJECT is a valid PNG image specification. */
5475 png_image_p (Lisp_Object object
)
5477 struct image_keyword fmt
[PNG_LAST
];
5478 memcpy (fmt
, png_format
, sizeof fmt
);
5480 if (!parse_image_spec (object
, fmt
, PNG_LAST
, Qpng
))
5483 /* Must specify either the :data or :file keyword. */
5484 return fmt
[PNG_FILE
].count
+ fmt
[PNG_DATA
].count
== 1;
5487 #endif /* HAVE_PNG || HAVE_NS */
5493 /* PNG library details. */
5495 DEF_IMGLIB_FN (png_voidp
, png_get_io_ptr
, (png_structp
));
5496 DEF_IMGLIB_FN (int, png_sig_cmp
, (png_bytep
, png_size_t
, png_size_t
));
5497 DEF_IMGLIB_FN (png_structp
, png_create_read_struct
, (png_const_charp
, png_voidp
,
5498 png_error_ptr
, png_error_ptr
));
5499 DEF_IMGLIB_FN (png_infop
, png_create_info_struct
, (png_structp
));
5500 DEF_IMGLIB_FN (void, png_destroy_read_struct
, (png_structpp
, png_infopp
, png_infopp
));
5501 DEF_IMGLIB_FN (void, png_set_read_fn
, (png_structp
, png_voidp
, png_rw_ptr
));
5502 DEF_IMGLIB_FN (void, png_set_sig_bytes
, (png_structp
, int));
5503 DEF_IMGLIB_FN (void, png_read_info
, (png_structp
, png_infop
));
5504 DEF_IMGLIB_FN (png_uint_32
, png_get_IHDR
, (png_structp
, png_infop
,
5505 png_uint_32
*, png_uint_32
*,
5506 int *, int *, int *, int *, int *));
5507 DEF_IMGLIB_FN (png_uint_32
, png_get_valid
, (png_structp
, png_infop
, png_uint_32
));
5508 DEF_IMGLIB_FN (void, png_set_strip_16
, (png_structp
));
5509 DEF_IMGLIB_FN (void, png_set_expand
, (png_structp
));
5510 DEF_IMGLIB_FN (void, png_set_gray_to_rgb
, (png_structp
));
5511 DEF_IMGLIB_FN (void, png_set_background
, (png_structp
, png_color_16p
,
5513 DEF_IMGLIB_FN (png_uint_32
, png_get_bKGD
, (png_structp
, png_infop
, png_color_16p
*));
5514 DEF_IMGLIB_FN (void, png_read_update_info
, (png_structp
, png_infop
));
5515 DEF_IMGLIB_FN (png_byte
, png_get_channels
, (png_structp
, png_infop
));
5516 DEF_IMGLIB_FN (png_size_t
, png_get_rowbytes
, (png_structp
, png_infop
));
5517 DEF_IMGLIB_FN (void, png_read_image
, (png_structp
, png_bytepp
));
5518 DEF_IMGLIB_FN (void, png_read_end
, (png_structp
, png_infop
));
5519 DEF_IMGLIB_FN (void, png_error
, (png_structp
, png_const_charp
));
5521 #if (PNG_LIBPNG_VER >= 10500)
5522 DEF_IMGLIB_FN (void, png_longjmp
, (png_structp
, int));
5523 DEF_IMGLIB_FN (jmp_buf *, png_set_longjmp_fn
, (png_structp
, png_longjmp_ptr
, size_t));
5524 #endif /* libpng version >= 1.5 */
5527 init_png_functions (void)
5531 if (!(library
= w32_delayed_load (Qpng
)))
5534 LOAD_IMGLIB_FN (library
, png_get_io_ptr
);
5535 LOAD_IMGLIB_FN (library
, png_sig_cmp
);
5536 LOAD_IMGLIB_FN (library
, png_create_read_struct
);
5537 LOAD_IMGLIB_FN (library
, png_create_info_struct
);
5538 LOAD_IMGLIB_FN (library
, png_destroy_read_struct
);
5539 LOAD_IMGLIB_FN (library
, png_set_read_fn
);
5540 LOAD_IMGLIB_FN (library
, png_set_sig_bytes
);
5541 LOAD_IMGLIB_FN (library
, png_read_info
);
5542 LOAD_IMGLIB_FN (library
, png_get_IHDR
);
5543 LOAD_IMGLIB_FN (library
, png_get_valid
);
5544 LOAD_IMGLIB_FN (library
, png_set_strip_16
);
5545 LOAD_IMGLIB_FN (library
, png_set_expand
);
5546 LOAD_IMGLIB_FN (library
, png_set_gray_to_rgb
);
5547 LOAD_IMGLIB_FN (library
, png_set_background
);
5548 LOAD_IMGLIB_FN (library
, png_get_bKGD
);
5549 LOAD_IMGLIB_FN (library
, png_read_update_info
);
5550 LOAD_IMGLIB_FN (library
, png_get_channels
);
5551 LOAD_IMGLIB_FN (library
, png_get_rowbytes
);
5552 LOAD_IMGLIB_FN (library
, png_read_image
);
5553 LOAD_IMGLIB_FN (library
, png_read_end
);
5554 LOAD_IMGLIB_FN (library
, png_error
);
5556 #if (PNG_LIBPNG_VER >= 10500)
5557 LOAD_IMGLIB_FN (library
, png_longjmp
);
5558 LOAD_IMGLIB_FN (library
, png_set_longjmp_fn
);
5559 #endif /* libpng version >= 1.5 */
5565 #define fn_png_get_io_ptr png_get_io_ptr
5566 #define fn_png_sig_cmp png_sig_cmp
5567 #define fn_png_create_read_struct png_create_read_struct
5568 #define fn_png_create_info_struct png_create_info_struct
5569 #define fn_png_destroy_read_struct png_destroy_read_struct
5570 #define fn_png_set_read_fn png_set_read_fn
5571 #define fn_png_set_sig_bytes png_set_sig_bytes
5572 #define fn_png_read_info png_read_info
5573 #define fn_png_get_IHDR png_get_IHDR
5574 #define fn_png_get_valid png_get_valid
5575 #define fn_png_set_strip_16 png_set_strip_16
5576 #define fn_png_set_expand png_set_expand
5577 #define fn_png_set_gray_to_rgb png_set_gray_to_rgb
5578 #define fn_png_set_background png_set_background
5579 #define fn_png_get_bKGD png_get_bKGD
5580 #define fn_png_read_update_info png_read_update_info
5581 #define fn_png_get_channels png_get_channels
5582 #define fn_png_get_rowbytes png_get_rowbytes
5583 #define fn_png_read_image png_read_image
5584 #define fn_png_read_end png_read_end
5585 #define fn_png_error png_error
5587 #if (PNG_LIBPNG_VER >= 10500)
5588 #define fn_png_longjmp png_longjmp
5589 #define fn_png_set_longjmp_fn png_set_longjmp_fn
5590 #endif /* libpng version >= 1.5 */
5592 #endif /* WINDOWSNT */
5594 /* Possibly inefficient/inexact substitutes for _setjmp and _longjmp.
5595 Do not use sys_setjmp, as PNG supports only jmp_buf. The _longjmp
5596 substitute may munge the signal mask, but that should be OK here.
5597 MinGW (MS-Windows) uses _setjmp and defines setjmp to _setjmp in
5598 the system header setjmp.h; don't mess up that. */
5599 #ifndef HAVE__SETJMP
5600 # define _setjmp(j) setjmp (j)
5601 # define _longjmp longjmp
5604 #if (PNG_LIBPNG_VER < 10500)
5605 #define PNG_LONGJMP(ptr) (_longjmp ((ptr)->jmpbuf, 1))
5606 #define PNG_JMPBUF(ptr) ((ptr)->jmpbuf)
5608 /* In libpng version 1.5, the jmpbuf member is hidden. (Bug#7908) */
5609 #define PNG_LONGJMP(ptr) (fn_png_longjmp ((ptr), 1))
5610 #define PNG_JMPBUF(ptr) \
5611 (*fn_png_set_longjmp_fn ((ptr), _longjmp, sizeof (jmp_buf)))
5614 /* Error and warning handlers installed when the PNG library
5617 static _Noreturn
void
5618 my_png_error (png_struct
*png_ptr
, const char *msg
)
5620 eassert (png_ptr
!= NULL
);
5621 /* Avoid compiler warning about deprecated direct access to
5622 png_ptr's fields in libpng versions 1.4.x. */
5623 image_error ("PNG error: %s", build_string (msg
), Qnil
);
5624 PNG_LONGJMP (png_ptr
);
5629 my_png_warning (png_struct
*png_ptr
, const char *msg
)
5631 eassert (png_ptr
!= NULL
);
5632 image_error ("PNG warning: %s", build_string (msg
), Qnil
);
5635 /* Memory source for PNG decoding. */
5637 struct png_memory_storage
5639 unsigned char *bytes
; /* The data */
5640 ptrdiff_t len
; /* How big is it? */
5641 ptrdiff_t index
; /* Where are we? */
5645 /* Function set as reader function when reading PNG image from memory.
5646 PNG_PTR is a pointer to the PNG control structure. Copy LENGTH
5647 bytes from the input to DATA. */
5650 png_read_from_memory (png_structp png_ptr
, png_bytep data
, png_size_t length
)
5652 struct png_memory_storage
*tbr
5653 = (struct png_memory_storage
*) fn_png_get_io_ptr (png_ptr
);
5655 if (length
> tbr
->len
- tbr
->index
)
5656 fn_png_error (png_ptr
, "Read error");
5658 memcpy (data
, tbr
->bytes
+ tbr
->index
, length
);
5659 tbr
->index
= tbr
->index
+ length
;
5663 /* Function set as reader function when reading PNG image from a file.
5664 PNG_PTR is a pointer to the PNG control structure. Copy LENGTH
5665 bytes from the input to DATA. */
5668 png_read_from_file (png_structp png_ptr
, png_bytep data
, png_size_t length
)
5670 FILE *fp
= (FILE *) fn_png_get_io_ptr (png_ptr
);
5672 if (fread (data
, 1, length
, fp
) < length
)
5673 fn_png_error (png_ptr
, "Read error");
5677 /* Load PNG image IMG for use on frame F. Value is true if
5680 struct png_load_context
5682 /* These are members so that longjmp doesn't munge local variables. */
5683 png_struct
*png_ptr
;
5692 png_load_body (struct frame
*f
, struct image
*img
, struct png_load_context
*c
)
5694 Lisp_Object file
, specified_file
;
5695 Lisp_Object specified_data
;
5698 XImagePtr ximg
, mask_img
= NULL
;
5699 png_struct
*png_ptr
;
5700 png_info
*info_ptr
= NULL
, *end_info
= NULL
;
5703 png_byte
*pixels
= NULL
;
5704 png_byte
**rows
= NULL
;
5705 png_uint_32 width
, height
;
5706 int bit_depth
, color_type
, interlace_type
;
5708 png_uint_32 row_bytes
;
5710 struct png_memory_storage tbr
; /* Data to be read */
5712 /* Find out what file to load. */
5713 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
5714 specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
5716 if (NILP (specified_data
))
5718 file
= x_find_image_file (specified_file
);
5719 if (!STRINGP (file
))
5721 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
5725 /* Open the image file. */
5726 fp
= fopen (SSDATA (file
), "rb");
5729 image_error ("Cannot open image file `%s'", file
, Qnil
);
5733 /* Check PNG signature. */
5734 if (fread (sig
, 1, sizeof sig
, fp
) != sizeof sig
5735 || fn_png_sig_cmp (sig
, 0, sizeof sig
))
5737 image_error ("Not a PNG file: `%s'", file
, Qnil
);
5744 if (!STRINGP (specified_data
))
5746 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
5750 /* Read from memory. */
5751 tbr
.bytes
= SDATA (specified_data
);
5752 tbr
.len
= SBYTES (specified_data
);
5755 /* Check PNG signature. */
5756 if (tbr
.len
< sizeof sig
5757 || fn_png_sig_cmp (tbr
.bytes
, 0, sizeof sig
))
5759 image_error ("Not a PNG image: `%s'", img
->spec
, Qnil
);
5763 /* Need to skip past the signature. */
5764 tbr
.bytes
+= sizeof (sig
);
5767 /* Initialize read and info structs for PNG lib. */
5768 png_ptr
= fn_png_create_read_struct (PNG_LIBPNG_VER_STRING
,
5773 info_ptr
= fn_png_create_info_struct (png_ptr
);
5774 end_info
= fn_png_create_info_struct (png_ptr
);
5777 c
->png_ptr
= png_ptr
;
5778 c
->info_ptr
= info_ptr
;
5779 c
->end_info
= end_info
;
5784 if (! (info_ptr
&& end_info
))
5786 fn_png_destroy_read_struct (&c
->png_ptr
, &c
->info_ptr
, &c
->end_info
);
5791 if (fp
) fclose (fp
);
5795 /* Set error jump-back. We come back here when the PNG library
5796 detects an error. */
5797 if (_setjmp (PNG_JMPBUF (png_ptr
)))
5801 fn_png_destroy_read_struct (&c
->png_ptr
, &c
->info_ptr
, &c
->end_info
);
5809 /* Silence a bogus diagnostic; see GCC bug 54561. */
5810 IF_LINT (fp
= c
->fp
);
5812 /* Read image info. */
5813 if (!NILP (specified_data
))
5814 fn_png_set_read_fn (png_ptr
, (void *) &tbr
, png_read_from_memory
);
5816 fn_png_set_read_fn (png_ptr
, (void *) fp
, png_read_from_file
);
5818 fn_png_set_sig_bytes (png_ptr
, sizeof sig
);
5819 fn_png_read_info (png_ptr
, info_ptr
);
5820 fn_png_get_IHDR (png_ptr
, info_ptr
, &width
, &height
, &bit_depth
, &color_type
,
5821 &interlace_type
, NULL
, NULL
);
5823 if (! (width
<= INT_MAX
&& height
<= INT_MAX
5824 && check_image_size (f
, width
, height
)))
5826 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
5830 /* Create the X image and pixmap now, so that the work below can be
5831 omitted if the image is too large for X. */
5832 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, 0, &ximg
, 0))
5835 /* If image contains simply transparency data, we prefer to
5836 construct a clipping mask. */
5837 if (fn_png_get_valid (png_ptr
, info_ptr
, PNG_INFO_tRNS
))
5842 /* This function is easier to write if we only have to handle
5843 one data format: RGB or RGBA with 8 bits per channel. Let's
5844 transform other formats into that format. */
5846 /* Strip more than 8 bits per channel. */
5847 if (bit_depth
== 16)
5848 fn_png_set_strip_16 (png_ptr
);
5850 /* Expand data to 24 bit RGB, or 8 bit grayscale, with alpha channel
5852 fn_png_set_expand (png_ptr
);
5854 /* Convert grayscale images to RGB. */
5855 if (color_type
== PNG_COLOR_TYPE_GRAY
5856 || color_type
== PNG_COLOR_TYPE_GRAY_ALPHA
)
5857 fn_png_set_gray_to_rgb (png_ptr
);
5859 /* Handle alpha channel by combining the image with a background
5860 color. Do this only if a real alpha channel is supplied. For
5861 simple transparency, we prefer a clipping mask. */
5864 /* png_color_16 *image_bg; */
5865 Lisp_Object specified_bg
5866 = image_spec_value (img
->spec
, QCbackground
, NULL
);
5867 int shift
= (bit_depth
== 16) ? 0 : 8;
5869 if (STRINGP (specified_bg
))
5870 /* The user specified `:background', use that. */
5873 if (x_defined_color (f
, SSDATA (specified_bg
), &color
, 0))
5875 png_color_16 user_bg
;
5877 memset (&user_bg
, 0, sizeof user_bg
);
5878 user_bg
.red
= color
.red
>> shift
;
5879 user_bg
.green
= color
.green
>> shift
;
5880 user_bg
.blue
= color
.blue
>> shift
;
5882 fn_png_set_background (png_ptr
, &user_bg
,
5883 PNG_BACKGROUND_GAMMA_SCREEN
, 0, 1.0);
5888 /* We use the current frame background, ignoring any default
5889 background color set by the image. */
5890 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI)
5892 png_color_16 frame_background
;
5894 color
.pixel
= FRAME_BACKGROUND_PIXEL (f
);
5895 x_query_color (f
, &color
);
5897 memset (&frame_background
, 0, sizeof frame_background
);
5898 frame_background
.red
= color
.red
>> shift
;
5899 frame_background
.green
= color
.green
>> shift
;
5900 frame_background
.blue
= color
.blue
>> shift
;
5901 #endif /* HAVE_X_WINDOWS */
5903 fn_png_set_background (png_ptr
, &frame_background
,
5904 PNG_BACKGROUND_GAMMA_SCREEN
, 0, 1.0);
5908 /* Update info structure. */
5909 fn_png_read_update_info (png_ptr
, info_ptr
);
5911 /* Get number of channels. Valid values are 1 for grayscale images
5912 and images with a palette, 2 for grayscale images with transparency
5913 information (alpha channel), 3 for RGB images, and 4 for RGB
5914 images with alpha channel, i.e. RGBA. If conversions above were
5915 sufficient we should only have 3 or 4 channels here. */
5916 channels
= fn_png_get_channels (png_ptr
, info_ptr
);
5917 eassert (channels
== 3 || channels
== 4);
5919 /* Number of bytes needed for one row of the image. */
5920 row_bytes
= fn_png_get_rowbytes (png_ptr
, info_ptr
);
5922 /* Allocate memory for the image. */
5923 if (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *rows
< height
5924 || min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *pixels
/ height
< row_bytes
)
5925 memory_full (SIZE_MAX
);
5926 c
->pixels
= pixels
= xmalloc (sizeof *pixels
* row_bytes
* height
);
5927 c
->rows
= rows
= xmalloc (height
* sizeof *rows
);
5928 for (i
= 0; i
< height
; ++i
)
5929 rows
[i
] = pixels
+ i
* row_bytes
;
5931 /* Read the entire image. */
5932 fn_png_read_image (png_ptr
, rows
);
5933 fn_png_read_end (png_ptr
, info_ptr
);
5940 /* Create an image and pixmap serving as mask if the PNG image
5941 contains an alpha channel. */
5944 && !image_create_x_image_and_pixmap (f
, img
, width
, height
, 1,
5947 x_destroy_x_image (ximg
);
5948 x_clear_image_1 (f
, img
, CLEAR_IMAGE_PIXMAP
);
5952 /* Fill the X image and mask from PNG data. */
5953 init_color_table ();
5955 for (y
= 0; y
< height
; ++y
)
5957 png_byte
*p
= rows
[y
];
5959 for (x
= 0; x
< width
; ++x
)
5966 XPutPixel (ximg
, x
, y
, lookup_rgb_color (f
, r
, g
, b
));
5967 /* An alpha channel, aka mask channel, associates variable
5968 transparency with an image. Where other image formats
5969 support binary transparency---fully transparent or fully
5970 opaque---PNG allows up to 254 levels of partial transparency.
5971 The PNG library implements partial transparency by combining
5972 the image with a specified background color.
5974 I'm not sure how to handle this here nicely: because the
5975 background on which the image is displayed may change, for
5976 real alpha channel support, it would be necessary to create
5977 a new image for each possible background.
5979 What I'm doing now is that a mask is created if we have
5980 boolean transparency information. Otherwise I'm using
5981 the frame's background color to combine the image with. */
5986 XPutPixel (mask_img
, x
, y
, *p
> 0 ? PIX_MASK_DRAW
: PIX_MASK_RETAIN
);
5992 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
5993 /* Set IMG's background color from the PNG image, unless the user
5997 if (fn_png_get_bKGD (png_ptr
, info_ptr
, &bg
))
5999 img
->background
= lookup_rgb_color (f
, bg
->red
, bg
->green
, bg
->blue
);
6000 img
->background_valid
= 1;
6004 #ifdef COLOR_TABLE_SUPPORT
6005 /* Remember colors allocated for this image. */
6006 img
->colors
= colors_in_color_table (&img
->ncolors
);
6007 free_color_table ();
6008 #endif /* COLOR_TABLE_SUPPORT */
6011 fn_png_destroy_read_struct (&c
->png_ptr
, &c
->info_ptr
, &c
->end_info
);
6016 img
->height
= height
;
6018 /* Maybe fill in the background field while we have ximg handy.
6019 Casting avoids a GCC warning. */
6020 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
6022 /* Put ximg into the image. */
6023 image_put_x_image (f
, img
, ximg
, 0);
6025 /* Same for the mask. */
6028 /* Fill in the background_transparent field while we have the
6029 mask handy. Casting avoids a GCC warning. */
6030 image_background_transparent (img
, f
, (XImagePtr_or_DC
)mask_img
);
6032 image_put_x_image (f
, img
, mask_img
, 1);
6039 png_load (struct frame
*f
, struct image
*img
)
6041 struct png_load_context c
;
6042 return png_load_body (f
, img
, &c
);
6045 #else /* HAVE_PNG */
6049 png_load (struct frame
*f
, struct image
*img
)
6051 return ns_load_image (f
, img
,
6052 image_spec_value (img
->spec
, QCfile
, NULL
),
6053 image_spec_value (img
->spec
, QCdata
, NULL
));
6055 #endif /* HAVE_NS */
6058 #endif /* !HAVE_PNG */
6062 /***********************************************************************
6064 ***********************************************************************/
6066 #if defined (HAVE_JPEG) || defined (HAVE_NS)
6068 static bool jpeg_image_p (Lisp_Object object
);
6069 static bool jpeg_load (struct frame
*f
, struct image
*img
);
6071 /* The symbol `jpeg' identifying images of this type. */
6073 static Lisp_Object Qjpeg
;
6075 /* Indices of image specification fields in gs_format, below. */
6077 enum jpeg_keyword_index
6086 JPEG_HEURISTIC_MASK
,
6092 /* Vector of image_keyword structures describing the format
6093 of valid user-defined image specifications. */
6095 static const struct image_keyword jpeg_format
[JPEG_LAST
] =
6097 {":type", IMAGE_SYMBOL_VALUE
, 1},
6098 {":data", IMAGE_STRING_VALUE
, 0},
6099 {":file", IMAGE_STRING_VALUE
, 0},
6100 {":ascent", IMAGE_ASCENT_VALUE
, 0},
6101 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
6102 {":relief", IMAGE_INTEGER_VALUE
, 0},
6103 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6104 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6105 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6106 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
6109 #if defined HAVE_NTGUI && defined WINDOWSNT
6110 static bool init_jpeg_functions (void);
6112 #define init_jpeg_functions NULL
6115 /* Structure describing the image type `jpeg'. */
6117 static struct image_type jpeg_type
=
6123 init_jpeg_functions
,
6127 /* Return true if OBJECT is a valid JPEG image specification. */
6130 jpeg_image_p (Lisp_Object object
)
6132 struct image_keyword fmt
[JPEG_LAST
];
6134 memcpy (fmt
, jpeg_format
, sizeof fmt
);
6136 if (!parse_image_spec (object
, fmt
, JPEG_LAST
, Qjpeg
))
6139 /* Must specify either the :data or :file keyword. */
6140 return fmt
[JPEG_FILE
].count
+ fmt
[JPEG_DATA
].count
== 1;
6143 #endif /* HAVE_JPEG || HAVE_NS */
6147 /* Work around a warning about HAVE_STDLIB_H being redefined in
6149 #ifdef HAVE_STDLIB_H
6150 #undef HAVE_STDLIB_H
6151 #endif /* HAVE_STLIB_H */
6153 #if defined (HAVE_NTGUI) && !defined (__WIN32__)
6154 /* In older releases of the jpeg library, jpeglib.h will define boolean
6155 differently depending on __WIN32__, so make sure it is defined. */
6159 /* rpcndr.h (via windows.h) and jpeglib.h both define boolean types.
6160 Some versions of jpeglib try to detect whether rpcndr.h is loaded,
6161 using the Windows boolean type instead of the jpeglib boolean type
6162 if so. Cygwin jpeglib, however, doesn't try to detect whether its
6163 headers are included along with windows.h, so under Cygwin, jpeglib
6164 attempts to define a conflicting boolean type. Worse, forcing
6165 Cygwin jpeglib headers to use the Windows boolean type doesn't work
6166 because it created an ABI incompatibility between the
6167 already-compiled jpeg library and the header interface definition.
6169 The best we can do is to define jpeglib's boolean type to a
6170 different name. This name, jpeg_boolean, remains in effect through
6171 the rest of image.c.
6173 #if defined CYGWIN && defined HAVE_NTGUI
6174 #define boolean jpeg_boolean
6176 #include <jpeglib.h>
6181 /* JPEG library details. */
6182 DEF_IMGLIB_FN (void, jpeg_CreateDecompress
, (j_decompress_ptr
, int, size_t));
6183 DEF_IMGLIB_FN (boolean
, jpeg_start_decompress
, (j_decompress_ptr
));
6184 DEF_IMGLIB_FN (boolean
, jpeg_finish_decompress
, (j_decompress_ptr
));
6185 DEF_IMGLIB_FN (void, jpeg_destroy_decompress
, (j_decompress_ptr
));
6186 DEF_IMGLIB_FN (int, jpeg_read_header
, (j_decompress_ptr
, boolean
));
6187 DEF_IMGLIB_FN (JDIMENSION
, jpeg_read_scanlines
, (j_decompress_ptr
, JSAMPARRAY
, JDIMENSION
));
6188 DEF_IMGLIB_FN (struct jpeg_error_mgr
*, jpeg_std_error
, (struct jpeg_error_mgr
*));
6189 DEF_IMGLIB_FN (boolean
, jpeg_resync_to_restart
, (j_decompress_ptr
, int));
6192 init_jpeg_functions (void)
6196 if (!(library
= w32_delayed_load (Qjpeg
)))
6199 LOAD_IMGLIB_FN (library
, jpeg_finish_decompress
);
6200 LOAD_IMGLIB_FN (library
, jpeg_read_scanlines
);
6201 LOAD_IMGLIB_FN (library
, jpeg_start_decompress
);
6202 LOAD_IMGLIB_FN (library
, jpeg_read_header
);
6203 LOAD_IMGLIB_FN (library
, jpeg_CreateDecompress
);
6204 LOAD_IMGLIB_FN (library
, jpeg_destroy_decompress
);
6205 LOAD_IMGLIB_FN (library
, jpeg_std_error
);
6206 LOAD_IMGLIB_FN (library
, jpeg_resync_to_restart
);
6210 /* Wrapper since we can't directly assign the function pointer
6211 to another function pointer that was declared more completely easily. */
6213 jpeg_resync_to_restart_wrapper (j_decompress_ptr cinfo
, int desired
)
6215 return fn_jpeg_resync_to_restart (cinfo
, desired
);
6220 #define fn_jpeg_CreateDecompress(a,b,c) jpeg_create_decompress (a)
6221 #define fn_jpeg_start_decompress jpeg_start_decompress
6222 #define fn_jpeg_finish_decompress jpeg_finish_decompress
6223 #define fn_jpeg_destroy_decompress jpeg_destroy_decompress
6224 #define fn_jpeg_read_header jpeg_read_header
6225 #define fn_jpeg_read_scanlines jpeg_read_scanlines
6226 #define fn_jpeg_std_error jpeg_std_error
6227 #define jpeg_resync_to_restart_wrapper jpeg_resync_to_restart
6229 #endif /* WINDOWSNT */
6231 struct my_jpeg_error_mgr
6233 struct jpeg_error_mgr pub
;
6234 sys_jmp_buf setjmp_buffer
;
6236 /* The remaining members are so that longjmp doesn't munge local
6238 struct jpeg_decompress_struct cinfo
;
6242 MY_JPEG_INVALID_IMAGE_SIZE
,
6243 MY_JPEG_CANNOT_CREATE_X
6251 static _Noreturn
void
6252 my_error_exit (j_common_ptr cinfo
)
6254 struct my_jpeg_error_mgr
*mgr
= (struct my_jpeg_error_mgr
*) cinfo
->err
;
6255 mgr
->failure_code
= MY_JPEG_ERROR_EXIT
;
6256 sys_longjmp (mgr
->setjmp_buffer
, 1);
6260 /* Init source method for JPEG data source manager. Called by
6261 jpeg_read_header() before any data is actually read. See
6262 libjpeg.doc from the JPEG lib distribution. */
6265 our_common_init_source (j_decompress_ptr cinfo
)
6270 /* Method to terminate data source. Called by
6271 jpeg_finish_decompress() after all data has been processed. */
6274 our_common_term_source (j_decompress_ptr cinfo
)
6279 /* Fill input buffer method for JPEG data source manager. Called
6280 whenever more data is needed. We read the whole image in one step,
6281 so this only adds a fake end of input marker at the end. */
6283 static JOCTET our_memory_buffer
[2];
6286 our_memory_fill_input_buffer (j_decompress_ptr cinfo
)
6288 /* Insert a fake EOI marker. */
6289 struct jpeg_source_mgr
*src
= cinfo
->src
;
6291 our_memory_buffer
[0] = (JOCTET
) 0xFF;
6292 our_memory_buffer
[1] = (JOCTET
) JPEG_EOI
;
6294 src
->next_input_byte
= our_memory_buffer
;
6295 src
->bytes_in_buffer
= 2;
6300 /* Method to skip over NUM_BYTES bytes in the image data. CINFO->src
6301 is the JPEG data source manager. */
6304 our_memory_skip_input_data (j_decompress_ptr cinfo
, long int num_bytes
)
6306 struct jpeg_source_mgr
*src
= (struct jpeg_source_mgr
*) cinfo
->src
;
6310 if (num_bytes
> src
->bytes_in_buffer
)
6311 ERREXIT (cinfo
, JERR_INPUT_EOF
);
6313 src
->bytes_in_buffer
-= num_bytes
;
6314 src
->next_input_byte
+= num_bytes
;
6319 /* Set up the JPEG lib for reading an image from DATA which contains
6320 LEN bytes. CINFO is the decompression info structure created for
6321 reading the image. */
6324 jpeg_memory_src (j_decompress_ptr cinfo
, JOCTET
*data
, ptrdiff_t len
)
6326 struct jpeg_source_mgr
*src
;
6328 if (cinfo
->src
== NULL
)
6330 /* First time for this JPEG object? */
6331 cinfo
->src
= (struct jpeg_source_mgr
*)
6332 (*cinfo
->mem
->alloc_small
) ((j_common_ptr
) cinfo
, JPOOL_PERMANENT
,
6333 sizeof (struct jpeg_source_mgr
));
6334 src
= (struct jpeg_source_mgr
*) cinfo
->src
;
6335 src
->next_input_byte
= data
;
6338 src
= (struct jpeg_source_mgr
*) cinfo
->src
;
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
;
6432 if (cinfo
->src
!= NULL
)
6433 src
= (struct jpeg_stdio_mgr
*) cinfo
->src
;
6436 /* First time for this JPEG object? */
6437 cinfo
->src
= (struct jpeg_source_mgr
*)
6438 (*cinfo
->mem
->alloc_small
) ((j_common_ptr
) cinfo
, JPOOL_PERMANENT
,
6439 sizeof (struct jpeg_stdio_mgr
));
6440 src
= (struct jpeg_stdio_mgr
*) cinfo
->src
;
6441 src
->buffer
= (JOCTET
*)
6442 (*cinfo
->mem
->alloc_small
) ((j_common_ptr
) cinfo
, JPOOL_PERMANENT
,
6443 JPEG_STDIO_BUFFER_SIZE
);
6448 src
->mgr
.init_source
= our_common_init_source
;
6449 src
->mgr
.fill_input_buffer
= our_stdio_fill_input_buffer
;
6450 src
->mgr
.skip_input_data
= our_stdio_skip_input_data
;
6451 src
->mgr
.resync_to_restart
= jpeg_resync_to_restart_wrapper
; /* Use default method. */
6452 src
->mgr
.term_source
= our_common_term_source
;
6453 src
->mgr
.bytes_in_buffer
= 0;
6454 src
->mgr
.next_input_byte
= NULL
;
6458 /* Load image IMG for use on frame F. Patterned after example.c
6459 from the JPEG lib. */
6462 jpeg_load_body (struct frame
*f
, struct image
*img
,
6463 struct my_jpeg_error_mgr
*mgr
)
6465 Lisp_Object file
, specified_file
;
6466 Lisp_Object specified_data
;
6469 int row_stride
, x
, y
;
6470 XImagePtr ximg
= NULL
;
6471 unsigned long *colors
;
6474 /* Open the JPEG file. */
6475 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
6476 specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
6478 if (NILP (specified_data
))
6480 file
= x_find_image_file (specified_file
);
6481 if (!STRINGP (file
))
6483 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
6487 fp
= fopen (SSDATA (file
), "rb");
6490 image_error ("Cannot open `%s'", file
, Qnil
);
6494 else if (!STRINGP (specified_data
))
6496 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
6500 IF_LINT (mgr
->fp
= fp
);
6502 /* Customize libjpeg's error handling to call my_error_exit when an
6503 error is detected. This function will perform a longjmp. */
6504 mgr
->cinfo
.err
= fn_jpeg_std_error (&mgr
->pub
);
6505 mgr
->pub
.error_exit
= my_error_exit
;
6506 if (sys_setjmp (mgr
->setjmp_buffer
))
6508 switch (mgr
->failure_code
)
6510 case MY_JPEG_ERROR_EXIT
:
6512 char buf
[JMSG_LENGTH_MAX
];
6513 mgr
->cinfo
.err
->format_message ((j_common_ptr
) &mgr
->cinfo
, buf
);
6514 image_error ("Error reading JPEG image `%s': %s", img
->spec
,
6515 build_string (buf
));
6519 case MY_JPEG_INVALID_IMAGE_SIZE
:
6520 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
6523 case MY_JPEG_CANNOT_CREATE_X
:
6527 /* Close the input file and destroy the JPEG object. */
6530 fn_jpeg_destroy_decompress (&mgr
->cinfo
);
6532 /* If we already have an XImage, free that. */
6533 x_destroy_x_image (ximg
);
6535 /* Free pixmap and colors. */
6536 x_clear_image (f
, img
);
6540 /* Silence a bogus diagnostic; see GCC bug 54561. */
6541 IF_LINT (fp
= mgr
->fp
);
6543 /* Create the JPEG decompression object. Let it read from fp.
6544 Read the JPEG image header. */
6545 fn_jpeg_CreateDecompress (&mgr
->cinfo
, JPEG_LIB_VERSION
, sizeof *&mgr
->cinfo
);
6547 if (NILP (specified_data
))
6548 jpeg_file_src (&mgr
->cinfo
, fp
);
6550 jpeg_memory_src (&mgr
->cinfo
, SDATA (specified_data
),
6551 SBYTES (specified_data
));
6553 fn_jpeg_read_header (&mgr
->cinfo
, 1);
6555 /* Customize decompression so that color quantization will be used.
6556 Start decompression. */
6557 mgr
->cinfo
.quantize_colors
= 1;
6558 fn_jpeg_start_decompress (&mgr
->cinfo
);
6559 width
= img
->width
= mgr
->cinfo
.output_width
;
6560 height
= img
->height
= mgr
->cinfo
.output_height
;
6562 if (!check_image_size (f
, width
, height
))
6564 mgr
->failure_code
= MY_JPEG_INVALID_IMAGE_SIZE
;
6565 sys_longjmp (mgr
->setjmp_buffer
, 1);
6568 /* Create X image and pixmap. */
6569 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, 0, &ximg
, 0))
6571 mgr
->failure_code
= MY_JPEG_CANNOT_CREATE_X
;
6572 sys_longjmp (mgr
->setjmp_buffer
, 1);
6575 /* Allocate colors. When color quantization is used,
6576 mgr->cinfo.actual_number_of_colors has been set with the number of
6577 colors generated, and mgr->cinfo.colormap is a two-dimensional array
6578 of color indices in the range 0..mgr->cinfo.actual_number_of_colors.
6579 No more than 255 colors will be generated. */
6583 if (mgr
->cinfo
.out_color_components
> 2)
6584 ir
= 0, ig
= 1, ib
= 2;
6585 else if (mgr
->cinfo
.out_color_components
> 1)
6586 ir
= 0, ig
= 1, ib
= 0;
6588 ir
= 0, ig
= 0, ib
= 0;
6590 /* Use the color table mechanism because it handles colors that
6591 cannot be allocated nicely. Such colors will be replaced with
6592 a default color, and we don't have to care about which colors
6593 can be freed safely, and which can't. */
6594 init_color_table ();
6595 colors
= alloca (mgr
->cinfo
.actual_number_of_colors
* sizeof *colors
);
6597 for (i
= 0; i
< mgr
->cinfo
.actual_number_of_colors
; ++i
)
6599 /* Multiply RGB values with 255 because X expects RGB values
6600 in the range 0..0xffff. */
6601 int r
= mgr
->cinfo
.colormap
[ir
][i
] << 8;
6602 int g
= mgr
->cinfo
.colormap
[ig
][i
] << 8;
6603 int b
= mgr
->cinfo
.colormap
[ib
][i
] << 8;
6604 colors
[i
] = lookup_rgb_color (f
, r
, g
, b
);
6607 #ifdef COLOR_TABLE_SUPPORT
6608 /* Remember those colors actually allocated. */
6609 img
->colors
= colors_in_color_table (&img
->ncolors
);
6610 free_color_table ();
6611 #endif /* COLOR_TABLE_SUPPORT */
6615 row_stride
= width
* mgr
->cinfo
.output_components
;
6616 buffer
= mgr
->cinfo
.mem
->alloc_sarray ((j_common_ptr
) &mgr
->cinfo
,
6617 JPOOL_IMAGE
, row_stride
, 1);
6618 for (y
= 0; y
< height
; ++y
)
6620 fn_jpeg_read_scanlines (&mgr
->cinfo
, buffer
, 1);
6621 for (x
= 0; x
< mgr
->cinfo
.output_width
; ++x
)
6622 XPutPixel (ximg
, x
, y
, colors
[buffer
[0][x
]]);
6626 fn_jpeg_finish_decompress (&mgr
->cinfo
);
6627 fn_jpeg_destroy_decompress (&mgr
->cinfo
);
6631 /* Maybe fill in the background field while we have ximg handy. */
6632 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
6633 /* Casting avoids a GCC warning. */
6634 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
6636 /* Put ximg into the image. */
6637 image_put_x_image (f
, img
, ximg
, 0);
6642 jpeg_load (struct frame
*f
, struct image
*img
)
6644 struct my_jpeg_error_mgr mgr
;
6645 return jpeg_load_body (f
, img
, &mgr
);
6648 #else /* HAVE_JPEG */
6652 jpeg_load (struct frame
*f
, struct image
*img
)
6654 return ns_load_image (f
, img
,
6655 image_spec_value (img
->spec
, QCfile
, NULL
),
6656 image_spec_value (img
->spec
, QCdata
, NULL
));
6658 #endif /* HAVE_NS */
6660 #endif /* !HAVE_JPEG */
6664 /***********************************************************************
6666 ***********************************************************************/
6668 #if defined (HAVE_TIFF) || defined (HAVE_NS)
6670 static bool tiff_image_p (Lisp_Object object
);
6671 static bool tiff_load (struct frame
*f
, struct image
*img
);
6673 /* The symbol `tiff' identifying images of this type. */
6675 static Lisp_Object Qtiff
;
6677 /* Indices of image specification fields in tiff_format, below. */
6679 enum tiff_keyword_index
6688 TIFF_HEURISTIC_MASK
,
6695 /* Vector of image_keyword structures describing the format
6696 of valid user-defined image specifications. */
6698 static const struct image_keyword tiff_format
[TIFF_LAST
] =
6700 {":type", IMAGE_SYMBOL_VALUE
, 1},
6701 {":data", IMAGE_STRING_VALUE
, 0},
6702 {":file", IMAGE_STRING_VALUE
, 0},
6703 {":ascent", IMAGE_ASCENT_VALUE
, 0},
6704 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
6705 {":relief", IMAGE_INTEGER_VALUE
, 0},
6706 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6707 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6708 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6709 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0},
6710 {":index", IMAGE_NON_NEGATIVE_INTEGER_VALUE
, 0}
6713 #if defined HAVE_NTGUI && defined WINDOWSNT
6714 static bool init_tiff_functions (void);
6716 #define init_tiff_functions NULL
6719 /* Structure describing the image type `tiff'. */
6721 static struct image_type tiff_type
=
6727 init_tiff_functions
,
6731 /* Return true if OBJECT is a valid TIFF image specification. */
6734 tiff_image_p (Lisp_Object object
)
6736 struct image_keyword fmt
[TIFF_LAST
];
6737 memcpy (fmt
, tiff_format
, sizeof fmt
);
6739 if (!parse_image_spec (object
, fmt
, TIFF_LAST
, Qtiff
))
6742 /* Must specify either the :data or :file keyword. */
6743 return fmt
[TIFF_FILE
].count
+ fmt
[TIFF_DATA
].count
== 1;
6746 #endif /* HAVE_TIFF || HAVE_NS */
6754 /* TIFF library details. */
6755 DEF_IMGLIB_FN (TIFFErrorHandler
, TIFFSetErrorHandler
, (TIFFErrorHandler
));
6756 DEF_IMGLIB_FN (TIFFErrorHandler
, TIFFSetWarningHandler
, (TIFFErrorHandler
));
6757 DEF_IMGLIB_FN (TIFF
*, TIFFOpen
, (const char *, const char *));
6758 DEF_IMGLIB_FN (TIFF
*, TIFFClientOpen
, (const char *, const char *, thandle_t
,
6759 TIFFReadWriteProc
, TIFFReadWriteProc
,
6760 TIFFSeekProc
, TIFFCloseProc
, TIFFSizeProc
,
6761 TIFFMapFileProc
, TIFFUnmapFileProc
));
6762 DEF_IMGLIB_FN (int, TIFFGetField
, (TIFF
*, ttag_t
, ...));
6763 DEF_IMGLIB_FN (int, TIFFReadRGBAImage
, (TIFF
*, uint32
, uint32
, uint32
*, int));
6764 DEF_IMGLIB_FN (void, TIFFClose
, (TIFF
*));
6765 DEF_IMGLIB_FN (int, TIFFSetDirectory
, (TIFF
*, tdir_t
));
6768 init_tiff_functions (void)
6772 if (!(library
= w32_delayed_load (Qtiff
)))
6775 LOAD_IMGLIB_FN (library
, TIFFSetErrorHandler
);
6776 LOAD_IMGLIB_FN (library
, TIFFSetWarningHandler
);
6777 LOAD_IMGLIB_FN (library
, TIFFOpen
);
6778 LOAD_IMGLIB_FN (library
, TIFFClientOpen
);
6779 LOAD_IMGLIB_FN (library
, TIFFGetField
);
6780 LOAD_IMGLIB_FN (library
, TIFFReadRGBAImage
);
6781 LOAD_IMGLIB_FN (library
, TIFFClose
);
6782 LOAD_IMGLIB_FN (library
, TIFFSetDirectory
);
6788 #define fn_TIFFSetErrorHandler TIFFSetErrorHandler
6789 #define fn_TIFFSetWarningHandler TIFFSetWarningHandler
6790 #define fn_TIFFOpen TIFFOpen
6791 #define fn_TIFFClientOpen TIFFClientOpen
6792 #define fn_TIFFGetField TIFFGetField
6793 #define fn_TIFFReadRGBAImage TIFFReadRGBAImage
6794 #define fn_TIFFClose TIFFClose
6795 #define fn_TIFFSetDirectory TIFFSetDirectory
6796 #endif /* WINDOWSNT */
6799 /* Reading from a memory buffer for TIFF images Based on the PNG
6800 memory source, but we have to provide a lot of extra functions.
6803 We really only need to implement read and seek, but I am not
6804 convinced that the TIFF library is smart enough not to destroy
6805 itself if we only hand it the function pointers we need to
6810 unsigned char *bytes
;
6817 tiff_read_from_memory (thandle_t data
, tdata_t buf
, tsize_t size
)
6819 tiff_memory_source
*src
= (tiff_memory_source
*) data
;
6821 size
= min (size
, src
->len
- src
->index
);
6822 memcpy (buf
, src
->bytes
+ src
->index
, size
);
6828 tiff_write_from_memory (thandle_t data
, tdata_t buf
, tsize_t size
)
6834 tiff_seek_in_memory (thandle_t data
, toff_t off
, int whence
)
6836 tiff_memory_source
*src
= (tiff_memory_source
*) data
;
6841 case SEEK_SET
: /* Go from beginning of source. */
6845 case SEEK_END
: /* Go from end of source. */
6846 idx
= src
->len
+ off
;
6849 case SEEK_CUR
: /* Go from current position. */
6850 idx
= src
->index
+ off
;
6853 default: /* Invalid `whence'. */
6857 if (idx
> src
->len
|| idx
< 0)
6865 tiff_close_memory (thandle_t data
)
6872 tiff_mmap_memory (thandle_t data
, tdata_t
*pbase
, toff_t
*psize
)
6874 /* It is already _IN_ memory. */
6879 tiff_unmap_memory (thandle_t data
, tdata_t base
, toff_t size
)
6881 /* We don't need to do this. */
6885 tiff_size_of_memory (thandle_t data
)
6887 return ((tiff_memory_source
*) data
)->len
;
6890 /* GCC 3.x on x86 Windows targets has a bug that triggers an internal
6891 compiler error compiling tiff_handler, see Bugzilla bug #17406
6892 (http://gcc.gnu.org/bugzilla/show_bug.cgi?id=17406). Declaring
6893 this function as external works around that problem. */
6894 #if defined (__MINGW32__) && __GNUC__ == 3
6895 # define MINGW_STATIC
6897 # define MINGW_STATIC static
6901 tiff_handler (const char *, const char *, const char *, va_list)
6902 ATTRIBUTE_FORMAT_PRINTF (3, 0);
6904 tiff_handler (const char *log_format
, const char *title
,
6905 const char *format
, va_list ap
)
6907 /* doprnt is not suitable here, as TIFF handlers are called from
6908 libtiff and are passed arbitrary printf directives. Instead, use
6909 vsnprintf, taking care to be portable to nonstandard environments
6910 where vsnprintf returns -1 on buffer overflow. Since it's just a
6911 log entry, it's OK to truncate it. */
6913 int len
= vsnprintf (buf
, sizeof buf
, format
, ap
);
6914 add_to_log (log_format
, build_string (title
),
6915 make_string (buf
, max (0, min (len
, sizeof buf
- 1))));
6919 static void tiff_error_handler (const char *, const char *, va_list)
6920 ATTRIBUTE_FORMAT_PRINTF (2, 0);
6922 tiff_error_handler (const char *title
, const char *format
, va_list ap
)
6924 tiff_handler ("TIFF error: %s %s", title
, format
, ap
);
6928 static void tiff_warning_handler (const char *, const char *, va_list)
6929 ATTRIBUTE_FORMAT_PRINTF (2, 0);
6931 tiff_warning_handler (const char *title
, const char *format
, va_list ap
)
6933 tiff_handler ("TIFF warning: %s %s", title
, format
, ap
);
6937 /* Load TIFF image IMG for use on frame F. Value is true if
6941 tiff_load (struct frame
*f
, struct image
*img
)
6943 Lisp_Object file
, specified_file
;
6944 Lisp_Object specified_data
;
6946 int width
, height
, x
, y
, count
;
6950 tiff_memory_source memsrc
;
6953 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
6954 specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
6956 fn_TIFFSetErrorHandler ((TIFFErrorHandler
) tiff_error_handler
);
6957 fn_TIFFSetWarningHandler ((TIFFErrorHandler
) tiff_warning_handler
);
6959 if (NILP (specified_data
))
6961 /* Read from a file */
6962 file
= x_find_image_file (specified_file
);
6963 if (!STRINGP (file
))
6965 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
6969 /* Try to open the image file. */
6970 tiff
= fn_TIFFOpen (SSDATA (file
), "r");
6973 image_error ("Cannot open `%s'", file
, Qnil
);
6979 if (!STRINGP (specified_data
))
6981 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
6985 /* Memory source! */
6986 memsrc
.bytes
= SDATA (specified_data
);
6987 memsrc
.len
= SBYTES (specified_data
);
6990 tiff
= fn_TIFFClientOpen ("memory_source", "r", (thandle_t
)&memsrc
,
6991 tiff_read_from_memory
,
6992 tiff_write_from_memory
,
6993 tiff_seek_in_memory
,
6995 tiff_size_of_memory
,
7001 image_error ("Cannot open memory source for `%s'", img
->spec
, Qnil
);
7006 image
= image_spec_value (img
->spec
, QCindex
, NULL
);
7007 if (INTEGERP (image
))
7009 EMACS_INT ino
= XFASTINT (image
);
7010 if (! (TYPE_MINIMUM (tdir_t
) <= ino
&& ino
<= TYPE_MAXIMUM (tdir_t
)
7011 && fn_TIFFSetDirectory (tiff
, ino
)))
7013 image_error ("Invalid image number `%s' in image `%s'",
7015 fn_TIFFClose (tiff
);
7020 /* Get width and height of the image, and allocate a raster buffer
7021 of width x height 32-bit values. */
7022 fn_TIFFGetField (tiff
, TIFFTAG_IMAGEWIDTH
, &width
);
7023 fn_TIFFGetField (tiff
, TIFFTAG_IMAGELENGTH
, &height
);
7025 if (!check_image_size (f
, width
, height
))
7027 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
7028 fn_TIFFClose (tiff
);
7032 /* Create the X image and pixmap. */
7033 if (! (height
<= min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *buf
/ width
7034 && image_create_x_image_and_pixmap (f
, img
, width
, height
, 0,
7037 fn_TIFFClose (tiff
);
7041 buf
= xmalloc (sizeof *buf
* width
* height
);
7043 rc
= fn_TIFFReadRGBAImage (tiff
, width
, height
, buf
, 0);
7045 /* Count the number of images in the file. */
7046 for (count
= 1; fn_TIFFSetDirectory (tiff
, count
); count
++)
7050 img
->lisp_data
= Fcons (Qcount
,
7051 Fcons (make_number (count
),
7054 fn_TIFFClose (tiff
);
7057 image_error ("Error reading TIFF image `%s'", img
->spec
, Qnil
);
7062 /* Initialize the color table. */
7063 init_color_table ();
7065 /* Process the pixel raster. Origin is in the lower-left corner. */
7066 for (y
= 0; y
< height
; ++y
)
7068 uint32
*row
= buf
+ y
* width
;
7070 for (x
= 0; x
< width
; ++x
)
7072 uint32 abgr
= row
[x
];
7073 int r
= TIFFGetR (abgr
) << 8;
7074 int g
= TIFFGetG (abgr
) << 8;
7075 int b
= TIFFGetB (abgr
) << 8;
7076 XPutPixel (ximg
, x
, height
- 1 - y
, lookup_rgb_color (f
, r
, g
, b
));
7080 #ifdef COLOR_TABLE_SUPPORT
7081 /* Remember the colors allocated for the image. Free the color table. */
7082 img
->colors
= colors_in_color_table (&img
->ncolors
);
7083 free_color_table ();
7084 #endif /* COLOR_TABLE_SUPPORT */
7087 img
->height
= height
;
7089 /* Maybe fill in the background field while we have ximg handy. */
7090 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
7091 /* Casting avoids a GCC warning on W32. */
7092 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
7094 /* Put ximg into the image. */
7095 image_put_x_image (f
, img
, ximg
, 0);
7101 #else /* HAVE_TIFF */
7105 tiff_load (struct frame
*f
, struct image
*img
)
7107 return ns_load_image (f
, img
,
7108 image_spec_value (img
->spec
, QCfile
, NULL
),
7109 image_spec_value (img
->spec
, QCdata
, NULL
));
7111 #endif /* HAVE_NS */
7113 #endif /* !HAVE_TIFF */
7117 /***********************************************************************
7119 ***********************************************************************/
7121 #if defined (HAVE_GIF) || defined (HAVE_NS)
7123 static bool gif_image_p (Lisp_Object object
);
7124 static bool gif_load (struct frame
*f
, struct image
*img
);
7125 static void gif_clear_image (struct frame
*f
, struct image
*img
);
7127 /* The symbol `gif' identifying images of this type. */
7129 static Lisp_Object Qgif
;
7131 /* Indices of image specification fields in gif_format, below. */
7133 enum gif_keyword_index
7149 /* Vector of image_keyword structures describing the format
7150 of valid user-defined image specifications. */
7152 static const struct image_keyword gif_format
[GIF_LAST
] =
7154 {":type", IMAGE_SYMBOL_VALUE
, 1},
7155 {":data", IMAGE_STRING_VALUE
, 0},
7156 {":file", IMAGE_STRING_VALUE
, 0},
7157 {":ascent", IMAGE_ASCENT_VALUE
, 0},
7158 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
7159 {":relief", IMAGE_INTEGER_VALUE
, 0},
7160 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7161 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7162 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7163 {":index", IMAGE_NON_NEGATIVE_INTEGER_VALUE
, 0},
7164 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
7167 #if defined HAVE_NTGUI && defined WINDOWSNT
7168 static bool init_gif_functions (void);
7170 #define init_gif_functions NULL
7173 /* Structure describing the image type `gif'. */
7175 static struct image_type gif_type
=
7185 /* Free X resources of GIF image IMG which is used on frame F. */
7188 gif_clear_image (struct frame
*f
, struct image
*img
)
7190 img
->lisp_data
= Qnil
;
7191 x_clear_image (f
, img
);
7194 /* Return true if OBJECT is a valid GIF image specification. */
7197 gif_image_p (Lisp_Object object
)
7199 struct image_keyword fmt
[GIF_LAST
];
7200 memcpy (fmt
, gif_format
, sizeof fmt
);
7202 if (!parse_image_spec (object
, fmt
, GIF_LAST
, Qgif
))
7205 /* Must specify either the :data or :file keyword. */
7206 return fmt
[GIF_FILE
].count
+ fmt
[GIF_DATA
].count
== 1;
7209 #endif /* HAVE_GIF */
7213 #if defined (HAVE_NTGUI)
7214 /* winuser.h might define DrawText to DrawTextA or DrawTextW.
7215 Undefine before redefining to avoid a preprocessor warning. */
7219 /* avoid conflict with QuickdrawText.h */
7220 #define DrawText gif_DrawText
7221 #include <gif_lib.h>
7224 #else /* HAVE_NTGUI */
7226 #include <gif_lib.h>
7228 #endif /* HAVE_NTGUI */
7233 /* GIF library details. */
7234 DEF_IMGLIB_FN (int, DGifCloseFile
, (GifFileType
*));
7235 DEF_IMGLIB_FN (int, DGifSlurp
, (GifFileType
*));
7236 DEF_IMGLIB_FN (GifFileType
*, DGifOpen
, (void *, InputFunc
));
7237 DEF_IMGLIB_FN (GifFileType
*, DGifOpenFileName
, (const char *));
7240 init_gif_functions (void)
7244 if (!(library
= w32_delayed_load (Qgif
)))
7247 LOAD_IMGLIB_FN (library
, DGifCloseFile
);
7248 LOAD_IMGLIB_FN (library
, DGifSlurp
);
7249 LOAD_IMGLIB_FN (library
, DGifOpen
);
7250 LOAD_IMGLIB_FN (library
, DGifOpenFileName
);
7256 #define fn_DGifCloseFile DGifCloseFile
7257 #define fn_DGifSlurp DGifSlurp
7258 #define fn_DGifOpen DGifOpen
7259 #define fn_DGifOpenFileName DGifOpenFileName
7261 #endif /* WINDOWSNT */
7263 /* Reading a GIF image from memory
7264 Based on the PNG memory stuff to a certain extent. */
7268 unsigned char *bytes
;
7274 /* Make the current memory source available to gif_read_from_memory.
7275 It's done this way because not all versions of libungif support
7276 a UserData field in the GifFileType structure. */
7277 static gif_memory_source
*current_gif_memory_src
;
7280 gif_read_from_memory (GifFileType
*file
, GifByteType
*buf
, int len
)
7282 gif_memory_source
*src
= current_gif_memory_src
;
7284 if (len
> src
->len
- src
->index
)
7287 memcpy (buf
, src
->bytes
+ src
->index
, len
);
7293 /* Load GIF image IMG for use on frame F. Value is true if
7296 static const int interlace_start
[] = {0, 4, 2, 1};
7297 static const int interlace_increment
[] = {8, 8, 4, 2};
7299 #define GIF_LOCAL_DESCRIPTOR_EXTENSION 249
7302 gif_load (struct frame
*f
, struct image
*img
)
7305 int rc
, width
, height
, x
, y
, i
, j
;
7307 ColorMapObject
*gif_color_map
;
7308 unsigned long pixel_colors
[256];
7310 gif_memory_source memsrc
;
7311 Lisp_Object specified_bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
7312 Lisp_Object specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
7313 Lisp_Object specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
7314 unsigned long bgcolor
= 0;
7317 if (NILP (specified_data
))
7319 file
= x_find_image_file (specified_file
);
7320 if (!STRINGP (file
))
7322 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
7326 /* Open the GIF file. */
7327 gif
= fn_DGifOpenFileName (SSDATA (file
));
7330 image_error ("Cannot open `%s'", file
, Qnil
);
7336 if (!STRINGP (specified_data
))
7338 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
7342 /* Read from memory! */
7343 current_gif_memory_src
= &memsrc
;
7344 memsrc
.bytes
= SDATA (specified_data
);
7345 memsrc
.len
= SBYTES (specified_data
);
7348 gif
= fn_DGifOpen (&memsrc
, gif_read_from_memory
);
7351 image_error ("Cannot open memory source `%s'", img
->spec
, Qnil
);
7356 /* Before reading entire contents, check the declared image size. */
7357 if (!check_image_size (f
, gif
->SWidth
, gif
->SHeight
))
7359 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
7360 fn_DGifCloseFile (gif
);
7364 /* Read entire contents. */
7365 rc
= fn_DGifSlurp (gif
);
7366 if (rc
== GIF_ERROR
|| gif
->ImageCount
<= 0)
7368 image_error ("Error reading `%s'", img
->spec
, Qnil
);
7369 fn_DGifCloseFile (gif
);
7373 /* Which sub-image are we to display? */
7375 Lisp_Object image_number
= image_spec_value (img
->spec
, QCindex
, NULL
);
7376 idx
= INTEGERP (image_number
) ? XFASTINT (image_number
) : 0;
7377 if (idx
< 0 || idx
>= gif
->ImageCount
)
7379 image_error ("Invalid image number `%s' in image `%s'",
7380 image_number
, img
->spec
);
7381 fn_DGifCloseFile (gif
);
7386 width
= img
->width
= gif
->SWidth
;
7387 height
= img
->height
= gif
->SHeight
;
7389 img
->corners
[TOP_CORNER
] = gif
->SavedImages
[0].ImageDesc
.Top
;
7390 img
->corners
[LEFT_CORNER
] = gif
->SavedImages
[0].ImageDesc
.Left
;
7391 img
->corners
[BOT_CORNER
]
7392 = img
->corners
[TOP_CORNER
] + gif
->SavedImages
[0].ImageDesc
.Height
;
7393 img
->corners
[RIGHT_CORNER
]
7394 = img
->corners
[LEFT_CORNER
] + gif
->SavedImages
[0].ImageDesc
.Width
;
7396 if (!check_image_size (f
, width
, height
))
7398 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
7399 fn_DGifCloseFile (gif
);
7403 /* Check that the selected subimages fit. It's not clear whether
7404 the GIF spec requires this, but Emacs can crash if they don't fit. */
7405 for (j
= 0; j
<= idx
; ++j
)
7407 struct SavedImage
*subimage
= gif
->SavedImages
+ j
;
7408 int subimg_width
= subimage
->ImageDesc
.Width
;
7409 int subimg_height
= subimage
->ImageDesc
.Height
;
7410 int subimg_top
= subimage
->ImageDesc
.Top
;
7411 int subimg_left
= subimage
->ImageDesc
.Left
;
7412 if (! (0 <= subimg_width
&& 0 <= subimg_height
7413 && 0 <= subimg_top
&& subimg_top
<= height
- subimg_height
7414 && 0 <= subimg_left
&& subimg_left
<= width
- subimg_width
))
7416 image_error ("Subimage does not fit in image", Qnil
, Qnil
);
7417 fn_DGifCloseFile (gif
);
7422 /* Create the X image and pixmap. */
7423 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, 0, &ximg
, 0))
7425 fn_DGifCloseFile (gif
);
7429 /* Clear the part of the screen image not covered by the image.
7430 Full animated GIF support requires more here (see the gif89 spec,
7431 disposal methods). Let's simply assume that the part not covered
7432 by a sub-image is in the frame's background color. */
7433 for (y
= 0; y
< img
->corners
[TOP_CORNER
]; ++y
)
7434 for (x
= 0; x
< width
; ++x
)
7435 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7437 for (y
= img
->corners
[BOT_CORNER
]; y
< height
; ++y
)
7438 for (x
= 0; x
< width
; ++x
)
7439 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7441 for (y
= img
->corners
[TOP_CORNER
]; y
< img
->corners
[BOT_CORNER
]; ++y
)
7443 for (x
= 0; x
< img
->corners
[LEFT_CORNER
]; ++x
)
7444 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7445 for (x
= img
->corners
[RIGHT_CORNER
]; x
< width
; ++x
)
7446 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7449 /* Read the GIF image into the X image. */
7451 /* FIXME: With the current implementation, loading an animated gif
7452 is quadratic in the number of animation frames, since each frame
7453 is a separate struct image. We must provide a way for a single
7454 gif_load call to construct and save all animation frames. */
7456 init_color_table ();
7457 if (STRINGP (specified_bg
))
7458 bgcolor
= x_alloc_image_color (f
, img
, specified_bg
,
7459 FRAME_BACKGROUND_PIXEL (f
));
7460 for (j
= 0; j
<= idx
; ++j
)
7462 /* We use a local variable `raster' here because RasterBits is a
7463 char *, which invites problems with bytes >= 0x80. */
7464 struct SavedImage
*subimage
= gif
->SavedImages
+ j
;
7465 unsigned char *raster
= (unsigned char *) subimage
->RasterBits
;
7466 int transparency_color_index
= -1;
7468 int subimg_width
= subimage
->ImageDesc
.Width
;
7469 int subimg_height
= subimage
->ImageDesc
.Height
;
7470 int subimg_top
= subimage
->ImageDesc
.Top
;
7471 int subimg_left
= subimage
->ImageDesc
.Left
;
7473 /* Find the Graphic Control Extension block for this sub-image.
7474 Extract the disposal method and transparency color. */
7475 for (i
= 0; i
< subimage
->ExtensionBlockCount
; i
++)
7477 ExtensionBlock
*extblock
= subimage
->ExtensionBlocks
+ i
;
7479 if ((extblock
->Function
== GIF_LOCAL_DESCRIPTOR_EXTENSION
)
7480 && extblock
->ByteCount
== 4
7481 && extblock
->Bytes
[0] & 1)
7483 /* From gif89a spec: 1 = "keep in place", 2 = "restore
7484 to background". Treat any other value like 2. */
7485 disposal
= (extblock
->Bytes
[0] >> 2) & 7;
7486 transparency_color_index
= (unsigned char) extblock
->Bytes
[3];
7491 /* We can't "keep in place" the first subimage. */
7495 /* For disposal == 0, the spec says "No disposal specified. The
7496 decoder is not required to take any action." In practice, it
7497 seems we need to treat this like "keep in place", see e.g.
7498 http://upload.wikimedia.org/wikipedia/commons/3/37/Clock.gif */
7502 /* Allocate subimage colors. */
7503 memset (pixel_colors
, 0, sizeof pixel_colors
);
7504 gif_color_map
= subimage
->ImageDesc
.ColorMap
;
7506 gif_color_map
= gif
->SColorMap
;
7509 for (i
= 0; i
< gif_color_map
->ColorCount
; ++i
)
7511 if (transparency_color_index
== i
)
7512 pixel_colors
[i
] = STRINGP (specified_bg
)
7513 ? bgcolor
: FRAME_BACKGROUND_PIXEL (f
);
7516 int r
= gif_color_map
->Colors
[i
].Red
<< 8;
7517 int g
= gif_color_map
->Colors
[i
].Green
<< 8;
7518 int b
= gif_color_map
->Colors
[i
].Blue
<< 8;
7519 pixel_colors
[i
] = lookup_rgb_color (f
, r
, g
, b
);
7523 /* Apply the pixel values. */
7524 if (gif
->SavedImages
[j
].ImageDesc
.Interlace
)
7528 for (y
= 0, row
= interlace_start
[0], pass
= 0;
7530 y
++, row
+= interlace_increment
[pass
])
7532 while (subimg_height
<= row
)
7534 lint_assume (pass
< 3);
7535 row
= interlace_start
[++pass
];
7538 for (x
= 0; x
< subimg_width
; x
++)
7540 int c
= raster
[y
* subimg_width
+ x
];
7541 if (transparency_color_index
!= c
|| disposal
!= 1)
7542 XPutPixel (ximg
, x
+ subimg_left
, row
+ subimg_top
,
7549 for (y
= 0; y
< subimg_height
; ++y
)
7550 for (x
= 0; x
< subimg_width
; ++x
)
7552 int c
= raster
[y
* subimg_width
+ x
];
7553 if (transparency_color_index
!= c
|| disposal
!= 1)
7554 XPutPixel (ximg
, x
+ subimg_left
, y
+ subimg_top
,
7560 #ifdef COLOR_TABLE_SUPPORT
7561 img
->colors
= colors_in_color_table (&img
->ncolors
);
7562 free_color_table ();
7563 #endif /* COLOR_TABLE_SUPPORT */
7565 /* Save GIF image extension data for `image-metadata'.
7566 Format is (count IMAGES extension-data (FUNCTION "BYTES" ...)). */
7567 img
->lisp_data
= Qnil
;
7568 if (gif
->SavedImages
[idx
].ExtensionBlockCount
> 0)
7571 ExtensionBlock
*ext
= gif
->SavedImages
[idx
].ExtensionBlocks
;
7572 for (i
= 0; i
< gif
->SavedImages
[idx
].ExtensionBlockCount
; i
++, ext
++)
7573 /* Append (... FUNCTION "BYTES") */
7576 = Fcons (make_number (ext
->Function
),
7577 Fcons (make_unibyte_string (ext
->Bytes
, ext
->ByteCount
),
7579 if (ext
->Function
== GIF_LOCAL_DESCRIPTOR_EXTENSION
7580 && ext
->ByteCount
== 4)
7582 delay
= ext
->Bytes
[2] << CHAR_BIT
;
7583 delay
|= ext
->Bytes
[1];
7586 img
->lisp_data
= Fcons (Qextension_data
,
7587 Fcons (img
->lisp_data
, Qnil
));
7591 Fcons (make_float (delay
/ 100.0),
7595 if (gif
->ImageCount
> 1)
7596 img
->lisp_data
= Fcons (Qcount
,
7597 Fcons (make_number (gif
->ImageCount
),
7600 fn_DGifCloseFile (gif
);
7602 /* Maybe fill in the background field while we have ximg handy. */
7603 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
7604 /* Casting avoids a GCC warning. */
7605 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
7607 /* Put ximg into the image. */
7608 image_put_x_image (f
, img
, ximg
, 0);
7613 #else /* !HAVE_GIF */
7617 gif_load (struct frame
*f
, struct image
*img
)
7619 return ns_load_image (f
, img
,
7620 image_spec_value (img
->spec
, QCfile
, NULL
),
7621 image_spec_value (img
->spec
, QCdata
, NULL
));
7623 #endif /* HAVE_NS */
7625 #endif /* HAVE_GIF */
7628 #ifdef HAVE_IMAGEMAGICK
7630 /***********************************************************************
7632 ***********************************************************************/
7634 /* Scale an image size by returning SIZE / DIVISOR * MULTIPLIER,
7635 safely rounded and clipped to int range. */
7638 scale_image_size (int size
, size_t divisor
, size_t multiplier
)
7643 double scaled
= s
* multiplier
/ divisor
+ 0.5;
7644 if (scaled
< INT_MAX
)
7650 /* Compute the desired size of an image with native size WIDTH x HEIGHT.
7651 Use SPEC to deduce the size. Store the desired size into
7652 *D_WIDTH x *D_HEIGHT. Store -1 x -1 if the native size is OK. */
7654 compute_image_size (size_t width
, size_t height
,
7656 int *d_width
, int *d_height
)
7659 int desired_width
, desired_height
;
7661 /* If width and/or height is set in the display spec assume we want
7662 to scale to those values. If either h or w is unspecified, the
7663 unspecified should be calculated from the specified to preserve
7665 value
= image_spec_value (spec
, QCwidth
, NULL
);
7666 desired_width
= NATNUMP (value
) ? min (XFASTINT (value
), INT_MAX
) : -1;
7667 value
= image_spec_value (spec
, QCheight
, NULL
);
7668 desired_height
= NATNUMP (value
) ? min (XFASTINT (value
), INT_MAX
) : -1;
7670 if (desired_width
== -1)
7672 value
= image_spec_value (spec
, QCmax_width
, NULL
);
7673 if (NATNUMP (value
))
7675 int max_width
= min (XFASTINT (value
), INT_MAX
);
7676 if (max_width
< width
)
7678 /* The image is wider than :max-width. */
7679 desired_width
= max_width
;
7680 if (desired_height
== -1)
7682 desired_height
= scale_image_size (desired_width
,
7684 value
= image_spec_value (spec
, QCmax_height
, NULL
);
7685 if (NATNUMP (value
))
7687 int max_height
= min (XFASTINT (value
), INT_MAX
);
7688 if (max_height
< desired_height
)
7690 desired_height
= max_height
;
7691 desired_width
= scale_image_size (desired_height
,
7700 if (desired_height
== -1)
7702 value
= image_spec_value (spec
, QCmax_height
, NULL
);
7703 if (NATNUMP (value
))
7705 int max_height
= min (XFASTINT (value
), INT_MAX
);
7706 if (max_height
< height
)
7707 desired_height
= max_height
;
7711 if (desired_width
!= -1 && desired_height
== -1)
7712 /* w known, calculate h. */
7713 desired_height
= scale_image_size (desired_width
, width
, height
);
7715 if (desired_width
== -1 && desired_height
!= -1)
7716 /* h known, calculate w. */
7717 desired_width
= scale_image_size (desired_height
, height
, width
);
7719 *d_width
= desired_width
;
7720 *d_height
= desired_height
;
7723 static Lisp_Object Qimagemagick
;
7725 static bool imagemagick_image_p (Lisp_Object
);
7726 static bool imagemagick_load (struct frame
*, struct image
*);
7727 static void imagemagick_clear_image (struct frame
*, struct image
*);
7729 /* Indices of image specification fields in imagemagick_format. */
7731 enum imagemagick_keyword_index
7739 IMAGEMAGICK_ALGORITHM
,
7740 IMAGEMAGICK_HEURISTIC_MASK
,
7742 IMAGEMAGICK_BACKGROUND
,
7745 IMAGEMAGICK_MAX_HEIGHT
,
7746 IMAGEMAGICK_MAX_WIDTH
,
7747 IMAGEMAGICK_ROTATION
,
7752 /* Vector of image_keyword structures describing the format
7753 of valid user-defined image specifications. */
7755 static struct image_keyword imagemagick_format
[IMAGEMAGICK_LAST
] =
7757 {":type", IMAGE_SYMBOL_VALUE
, 1},
7758 {":data", IMAGE_STRING_VALUE
, 0},
7759 {":file", IMAGE_STRING_VALUE
, 0},
7760 {":ascent", IMAGE_ASCENT_VALUE
, 0},
7761 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
7762 {":relief", IMAGE_INTEGER_VALUE
, 0},
7763 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7764 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7765 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7766 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0},
7767 {":height", IMAGE_INTEGER_VALUE
, 0},
7768 {":width", IMAGE_INTEGER_VALUE
, 0},
7769 {":max-height", IMAGE_INTEGER_VALUE
, 0},
7770 {":max-width", IMAGE_INTEGER_VALUE
, 0},
7771 {":rotation", IMAGE_NUMBER_VALUE
, 0},
7772 {":crop", IMAGE_DONT_CHECK_VALUE_TYPE
, 0}
7775 #if defined HAVE_NTGUI && defined WINDOWSNT
7776 static bool init_imagemagick_functions (void);
7778 #define init_imagemagick_functions NULL
7781 /* Structure describing the image type for any image handled via
7784 static struct image_type imagemagick_type
=
7787 imagemagick_image_p
,
7789 imagemagick_clear_image
,
7790 init_imagemagick_functions
,
7794 /* Free X resources of imagemagick image IMG which is used on frame F. */
7797 imagemagick_clear_image (struct frame
*f
,
7800 x_clear_image (f
, img
);
7803 /* Return true if OBJECT is a valid IMAGEMAGICK image specification. Do
7804 this by calling parse_image_spec and supplying the keywords that
7805 identify the IMAGEMAGICK format. */
7808 imagemagick_image_p (Lisp_Object object
)
7810 struct image_keyword fmt
[IMAGEMAGICK_LAST
];
7811 memcpy (fmt
, imagemagick_format
, sizeof fmt
);
7813 if (!parse_image_spec (object
, fmt
, IMAGEMAGICK_LAST
, Qimagemagick
))
7816 /* Must specify either the :data or :file keyword. */
7817 return fmt
[IMAGEMAGICK_FILE
].count
+ fmt
[IMAGEMAGICK_DATA
].count
== 1;
7820 /* The GIF library also defines DrawRectangle, but its never used in Emacs.
7821 Therefore rename the function so it doesn't collide with ImageMagick. */
7822 #define DrawRectangle DrawRectangleGif
7823 #include <wand/MagickWand.h>
7825 /* ImageMagick 6.5.3 through 6.6.5 hid PixelGetMagickColor for some reason.
7826 Emacs seems to work fine with the hidden version, so unhide it. */
7827 #include <magick/version.h>
7828 #if 0x653 <= MagickLibVersion && MagickLibVersion <= 0x665
7829 extern WandExport
void PixelGetMagickColor (const PixelWand
*,
7830 MagickPixelPacket
*);
7833 /* Log ImageMagick error message.
7834 Useful when a ImageMagick function returns the status `MagickFalse'. */
7837 imagemagick_error (MagickWand
*wand
)
7840 ExceptionType severity
;
7842 description
= MagickGetException (wand
, &severity
);
7843 image_error ("ImageMagick error: %s",
7844 build_string (description
),
7846 description
= (char *) MagickRelinquishMemory (description
);
7849 /* Helper function for imagemagick_load, which does the actual loading
7850 given contents and size, apart from frame and image structures,
7851 passed from imagemagick_load. Uses librimagemagick to do most of
7852 the image processing.
7854 F is a pointer to the Emacs frame; IMG to the image structure to
7855 prepare; CONTENTS is the string containing the IMAGEMAGICK data to
7856 be parsed; SIZE is the number of bytes of data; and FILENAME is
7857 either the file name or the image data.
7859 Return true if successful. */
7862 imagemagick_load_image (struct frame
*f
, struct image
*img
,
7863 unsigned char *contents
, unsigned int size
,
7866 size_t width
, height
;
7867 MagickBooleanType status
;
7870 MagickWand
*image_wand
;
7871 MagickWand
*ping_wand
;
7872 PixelIterator
*iterator
;
7873 PixelWand
**pixels
, *bg_wand
= NULL
;
7874 MagickPixelPacket pixel
;
7879 int desired_width
, desired_height
;
7883 /* Handle image index for image types who can contain more than one image.
7884 Interface :index is same as for GIF. First we "ping" the image to see how
7885 many sub-images it contains. Pinging is faster than loading the image to
7886 find out things about it. */
7888 /* Initialize the imagemagick environment. */
7889 MagickWandGenesis ();
7890 image
= image_spec_value (img
->spec
, QCindex
, NULL
);
7891 ino
= INTEGERP (image
) ? XFASTINT (image
) : 0;
7892 ping_wand
= NewMagickWand ();
7893 /* MagickSetResolution (ping_wand, 2, 2); (Bug#10112) */
7896 ? MagickPingImage (ping_wand
, filename
)
7897 : MagickPingImageBlob (ping_wand
, contents
, size
);
7899 if (status
== MagickFalse
)
7901 imagemagick_error (ping_wand
);
7902 DestroyMagickWand (ping_wand
);
7906 if (ino
< 0 || ino
>= MagickGetNumberImages (ping_wand
))
7908 image_error ("Invalid image number `%s' in image `%s'",
7910 DestroyMagickWand (ping_wand
);
7914 if (MagickGetNumberImages (ping_wand
) > 1)
7917 Fcons (make_number (MagickGetNumberImages (ping_wand
)),
7920 DestroyMagickWand (ping_wand
);
7922 /* Now we know how many images are inside the file. If it's not a
7923 bundle, the number is one. Load the image data. */
7925 image_wand
= NewMagickWand ();
7928 ? MagickReadImage (image_wand
, filename
)
7929 : MagickReadImageBlob (image_wand
, contents
, size
))
7932 imagemagick_error (image_wand
);
7933 goto imagemagick_error
;
7936 /* Retrieve the frame's background color, for use later. */
7939 Lisp_Object specified_bg
;
7941 specified_bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
7942 if (!STRINGP (specified_bg
)
7943 || !x_defined_color (f
, SSDATA (specified_bg
), &bgcolor
, 0))
7946 bgcolor
.pixel
= FRAME_BACKGROUND_PIXEL (f
);
7947 x_query_color (f
, &bgcolor
);
7949 ns_query_color (FRAME_BACKGROUND_COLOR (f
), &bgcolor
, 1);
7953 bg_wand
= NewPixelWand ();
7954 PixelSetRed (bg_wand
, (double) bgcolor
.red
/ 65535);
7955 PixelSetGreen (bg_wand
, (double) bgcolor
.green
/ 65535);
7956 PixelSetBlue (bg_wand
, (double) bgcolor
.blue
/ 65535);
7959 compute_image_size (MagickGetImageWidth (image_wand
),
7960 MagickGetImageHeight (image_wand
),
7961 img
->spec
, &desired_width
, &desired_height
);
7963 if (desired_width
!= -1 && desired_height
!= -1)
7965 status
= MagickScaleImage (image_wand
, desired_width
, desired_height
);
7966 if (status
== MagickFalse
)
7968 image_error ("Imagemagick scale failed", Qnil
, Qnil
);
7969 imagemagick_error (image_wand
);
7970 goto imagemagick_error
;
7974 /* crop behaves similar to image slicing in Emacs but is more memory
7976 crop
= image_spec_value (img
->spec
, QCcrop
, NULL
);
7978 if (CONSP (crop
) && TYPE_RANGED_INTEGERP (size_t, XCAR (crop
)))
7980 /* After some testing, it seems MagickCropImage is the fastest crop
7981 function in ImageMagick. This crop function seems to do less copying
7982 than the alternatives, but it still reads the entire image into memory
7983 before cropping, which is apparently difficult to avoid when using
7985 size_t crop_width
= XINT (XCAR (crop
));
7987 if (CONSP (crop
) && TYPE_RANGED_INTEGERP (size_t, XCAR (crop
)))
7989 size_t crop_height
= XINT (XCAR (crop
));
7991 if (CONSP (crop
) && TYPE_RANGED_INTEGERP (ssize_t
, XCAR (crop
)))
7993 ssize_t crop_x
= XINT (XCAR (crop
));
7995 if (CONSP (crop
) && TYPE_RANGED_INTEGERP (ssize_t
, XCAR (crop
)))
7997 ssize_t crop_y
= XINT (XCAR (crop
));
7998 MagickCropImage (image_wand
, crop_width
, crop_height
,
8005 /* Furthermore :rotation. we need background color and angle for
8008 TODO background handling for rotation specified_bg =
8009 image_spec_value (img->spec, QCbackground, NULL); if (!STRINGP
8011 value
= image_spec_value (img
->spec
, QCrotation
, NULL
);
8014 rotation
= extract_float (value
);
8015 status
= MagickRotateImage (image_wand
, bg_wand
, rotation
);
8016 if (status
== MagickFalse
)
8018 image_error ("Imagemagick image rotate failed", Qnil
, Qnil
);
8019 imagemagick_error (image_wand
);
8020 goto imagemagick_error
;
8024 /* Set the canvas background color to the frame or specified
8025 background, and flatten the image. Note: as of ImageMagick
8026 6.6.0, SVG image transparency is not handled properly
8027 (e.g. etc/images/splash.svg shows a white background always). */
8029 MagickWand
*new_wand
;
8030 MagickSetImageBackgroundColor (image_wand
, bg_wand
);
8031 #ifdef HAVE_MAGICKMERGEIMAGELAYERS
8032 new_wand
= MagickMergeImageLayers (image_wand
, MergeLayer
);
8034 new_wand
= MagickFlattenImages (image_wand
);
8036 DestroyMagickWand (image_wand
);
8037 image_wand
= new_wand
;
8040 /* Finally we are done manipulating the image. Figure out the
8041 resulting width/height and transfer ownership to Emacs. */
8042 height
= MagickGetImageHeight (image_wand
);
8043 width
= MagickGetImageWidth (image_wand
);
8045 if (! (width
<= INT_MAX
&& height
<= INT_MAX
8046 && check_image_size (f
, width
, height
)))
8048 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
8049 goto imagemagick_error
;
8052 /* We can now get a valid pixel buffer from the imagemagick file, if all
8055 init_color_table ();
8057 #ifdef HAVE_MAGICKEXPORTIMAGEPIXELS
8058 if (imagemagick_render_type
!= 0)
8060 /* Magicexportimage is normally faster than pixelpushing. This
8061 method is also well tested. Some aspects of this method are
8062 ad-hoc and needs to be more researched. */
8063 int imagedepth
= 24; /*MagickGetImageDepth(image_wand);*/
8064 const char *exportdepth
= imagedepth
<= 8 ? "I" : "BGRP"; /*"RGBP";*/
8065 /* Try to create a x pixmap to hold the imagemagick pixmap. */
8066 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, imagedepth
,
8069 #ifdef COLOR_TABLE_SUPPORT
8070 free_color_table ();
8072 image_error ("Imagemagick X bitmap allocation failure", Qnil
, Qnil
);
8073 goto imagemagick_error
;
8076 /* Oddly, the below code doesn't seem to work:*/
8077 /* switch(ximg->bitmap_unit){ */
8079 /* pixelwidth=CharPixel; */
8082 /* pixelwidth=ShortPixel; */
8085 /* pixelwidth=LongPixel; */
8089 Here im just guessing the format of the bitmap.
8090 happens to work fine for:
8093 seems about 3 times as fast as pixel pushing(not carefully measured)
8095 pixelwidth
= CharPixel
; /*??? TODO figure out*/
8096 MagickExportImagePixels (image_wand
, 0, 0, width
, height
,
8097 exportdepth
, pixelwidth
, ximg
->data
);
8100 #endif /* HAVE_MAGICKEXPORTIMAGEPIXELS */
8102 size_t image_height
;
8104 /* Try to create a x pixmap to hold the imagemagick pixmap. */
8105 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, 0,
8108 #ifdef COLOR_TABLE_SUPPORT
8109 free_color_table ();
8111 image_error ("Imagemagick X bitmap allocation failure", Qnil
, Qnil
);
8112 goto imagemagick_error
;
8115 /* Copy imagemagick image to x with primitive yet robust pixel
8116 pusher loop. This has been tested a lot with many different
8119 /* Copy pixels from the imagemagick image structure to the x image map. */
8120 iterator
= NewPixelIterator (image_wand
);
8121 if (iterator
== (PixelIterator
*) NULL
)
8123 #ifdef COLOR_TABLE_SUPPORT
8124 free_color_table ();
8126 x_destroy_x_image (ximg
);
8127 image_error ("Imagemagick pixel iterator creation failed",
8129 goto imagemagick_error
;
8132 image_height
= MagickGetImageHeight (image_wand
);
8133 for (y
= 0; y
< image_height
; y
++)
8135 pixels
= PixelGetNextIteratorRow (iterator
, &width
);
8136 if (pixels
== (PixelWand
**) NULL
)
8138 for (x
= 0; x
< (long) width
; x
++)
8140 PixelGetMagickColor (pixels
[x
], &pixel
);
8141 XPutPixel (ximg
, x
, y
,
8142 lookup_rgb_color (f
,
8148 DestroyPixelIterator (iterator
);
8151 #ifdef COLOR_TABLE_SUPPORT
8152 /* Remember colors allocated for this image. */
8153 img
->colors
= colors_in_color_table (&img
->ncolors
);
8154 free_color_table ();
8155 #endif /* COLOR_TABLE_SUPPORT */
8158 img
->height
= height
;
8160 /* Put ximg into the image. */
8161 image_put_x_image (f
, img
, ximg
, 0);
8163 /* Final cleanup. image_wand should be the only resource left. */
8164 DestroyMagickWand (image_wand
);
8165 if (bg_wand
) DestroyPixelWand (bg_wand
);
8167 /* `MagickWandTerminus' terminates the imagemagick environment. */
8168 MagickWandTerminus ();
8173 DestroyMagickWand (image_wand
);
8174 if (bg_wand
) DestroyPixelWand (bg_wand
);
8176 MagickWandTerminus ();
8177 /* TODO more cleanup. */
8178 image_error ("Error parsing IMAGEMAGICK image `%s'", img
->spec
, Qnil
);
8183 /* Load IMAGEMAGICK image IMG for use on frame F. Value is true if
8184 successful. this function will go into the imagemagick_type structure, and
8185 the prototype thus needs to be compatible with that structure. */
8188 imagemagick_load (struct frame
*f
, struct image
*img
)
8191 Lisp_Object file_name
;
8193 /* If IMG->spec specifies a file name, create a non-file spec from it. */
8194 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
8195 if (STRINGP (file_name
))
8199 file
= x_find_image_file (file_name
);
8200 if (!STRINGP (file
))
8202 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
8205 success_p
= imagemagick_load_image (f
, img
, 0, 0, SSDATA (file
));
8207 /* Else its not a file, its a lisp object. Load the image from a
8208 lisp object rather than a file. */
8213 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
8214 if (!STRINGP (data
))
8216 image_error ("Invalid image data `%s'", data
, Qnil
);
8219 success_p
= imagemagick_load_image (f
, img
, SDATA (data
),
8220 SBYTES (data
), NULL
);
8226 DEFUN ("imagemagick-types", Fimagemagick_types
, Simagemagick_types
, 0, 0, 0,
8227 doc
: /* Return a list of image types supported by ImageMagick.
8228 Each entry in this list is a symbol named after an ImageMagick format
8229 tag. See the ImageMagick manual for a list of ImageMagick formats and
8230 their descriptions (http://www.imagemagick.org/script/formats.php).
8231 You can also try the shell command: `identify -list format'.
8233 Note that ImageMagick recognizes many file-types that Emacs does not
8234 recognize as images, such as C. See `imagemagick-types-enable'
8235 and `imagemagick-types-inhibit'. */)
8238 Lisp_Object typelist
= Qnil
;
8243 Lisp_Object Qimagemagicktype
;
8245 GetExceptionInfo(&ex
);
8246 imtypes
= GetMagickList ("*", &numf
, &ex
);
8247 DestroyExceptionInfo(&ex
);
8249 for (i
= 0; i
< numf
; i
++)
8251 Qimagemagicktype
= intern (imtypes
[i
]);
8252 typelist
= Fcons (Qimagemagicktype
, typelist
);
8254 return Fnreverse (typelist
);
8257 #endif /* defined (HAVE_IMAGEMAGICK) */
8261 /***********************************************************************
8263 ***********************************************************************/
8265 #if defined (HAVE_RSVG)
8267 /* Function prototypes. */
8269 static bool svg_image_p (Lisp_Object object
);
8270 static bool svg_load (struct frame
*f
, struct image
*img
);
8272 static bool svg_load_image (struct frame
*, struct image
*,
8273 unsigned char *, ptrdiff_t);
8275 /* The symbol `svg' identifying images of this type. */
8277 static Lisp_Object Qsvg
;
8279 /* Indices of image specification fields in svg_format, below. */
8281 enum svg_keyword_index
8296 /* Vector of image_keyword structures describing the format
8297 of valid user-defined image specifications. */
8299 static const struct image_keyword svg_format
[SVG_LAST
] =
8301 {":type", IMAGE_SYMBOL_VALUE
, 1},
8302 {":data", IMAGE_STRING_VALUE
, 0},
8303 {":file", IMAGE_STRING_VALUE
, 0},
8304 {":ascent", IMAGE_ASCENT_VALUE
, 0},
8305 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
8306 {":relief", IMAGE_INTEGER_VALUE
, 0},
8307 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8308 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8309 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8310 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
8313 #if defined HAVE_NTGUI && defined WINDOWSNT
8314 static bool init_svg_functions (void);
8316 #define init_svg_functions NULL
8319 /* Structure describing the image type `svg'. Its the same type of
8320 structure defined for all image formats, handled by emacs image
8321 functions. See struct image_type in dispextern.h. */
8323 static struct image_type svg_type
=
8334 /* Return true if OBJECT is a valid SVG image specification. Do
8335 this by calling parse_image_spec and supplying the keywords that
8336 identify the SVG format. */
8339 svg_image_p (Lisp_Object object
)
8341 struct image_keyword fmt
[SVG_LAST
];
8342 memcpy (fmt
, svg_format
, sizeof fmt
);
8344 if (!parse_image_spec (object
, fmt
, SVG_LAST
, Qsvg
))
8347 /* Must specify either the :data or :file keyword. */
8348 return fmt
[SVG_FILE
].count
+ fmt
[SVG_DATA
].count
== 1;
8351 #include <librsvg/rsvg.h>
8355 /* SVG library functions. */
8356 DEF_IMGLIB_FN (RsvgHandle
*, rsvg_handle_new
, (void));
8357 DEF_IMGLIB_FN (void, rsvg_handle_get_dimensions
, (RsvgHandle
*, RsvgDimensionData
*));
8358 DEF_IMGLIB_FN (gboolean
, rsvg_handle_write
, (RsvgHandle
*, const guchar
*, gsize
, GError
**));
8359 DEF_IMGLIB_FN (gboolean
, rsvg_handle_close
, (RsvgHandle
*, GError
**));
8360 DEF_IMGLIB_FN (GdkPixbuf
*, rsvg_handle_get_pixbuf
, (RsvgHandle
*));
8361 DEF_IMGLIB_FN (void *, rsvg_handle_set_size_callback
, (RsvgHandle
*, RsvgSizeFunc
, gpointer
, GDestroyNotify
));
8363 DEF_IMGLIB_FN (int, gdk_pixbuf_get_width
, (const GdkPixbuf
*));
8364 DEF_IMGLIB_FN (int, gdk_pixbuf_get_height
, (const GdkPixbuf
*));
8365 DEF_IMGLIB_FN (guchar
*, gdk_pixbuf_get_pixels
, (const GdkPixbuf
*));
8366 DEF_IMGLIB_FN (int, gdk_pixbuf_get_rowstride
, (const GdkPixbuf
*));
8367 DEF_IMGLIB_FN (GdkColorspace
, gdk_pixbuf_get_colorspace
, (const GdkPixbuf
*));
8368 DEF_IMGLIB_FN (int, gdk_pixbuf_get_n_channels
, (const GdkPixbuf
*));
8369 DEF_IMGLIB_FN (gboolean
, gdk_pixbuf_get_has_alpha
, (const GdkPixbuf
*));
8370 DEF_IMGLIB_FN (int, gdk_pixbuf_get_bits_per_sample
, (const GdkPixbuf
*));
8372 DEF_IMGLIB_FN (void, g_type_init
, (void));
8373 DEF_IMGLIB_FN (void, g_object_unref
, (gpointer
));
8374 DEF_IMGLIB_FN (void, g_error_free
, (GError
*));
8376 Lisp_Object Qgdk_pixbuf
, Qglib
, Qgobject
;
8379 init_svg_functions (void)
8381 HMODULE library
, gdklib
, glib
, gobject
;
8383 if (!(glib
= w32_delayed_load (Qglib
))
8384 || !(gobject
= w32_delayed_load (Qgobject
))
8385 || !(gdklib
= w32_delayed_load (Qgdk_pixbuf
))
8386 || !(library
= w32_delayed_load (Qsvg
)))
8389 LOAD_IMGLIB_FN (library
, rsvg_handle_new
);
8390 LOAD_IMGLIB_FN (library
, rsvg_handle_get_dimensions
);
8391 LOAD_IMGLIB_FN (library
, rsvg_handle_write
);
8392 LOAD_IMGLIB_FN (library
, rsvg_handle_close
);
8393 LOAD_IMGLIB_FN (library
, rsvg_handle_get_pixbuf
);
8395 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_width
);
8396 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_height
);
8397 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_pixels
);
8398 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_rowstride
);
8399 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_colorspace
);
8400 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_n_channels
);
8401 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_has_alpha
);
8402 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_bits_per_sample
);
8404 LOAD_IMGLIB_FN (gobject
, g_type_init
);
8405 LOAD_IMGLIB_FN (gobject
, g_object_unref
);
8406 LOAD_IMGLIB_FN (glib
, g_error_free
);
8412 /* The following aliases for library functions allow dynamic loading
8413 to be used on some platforms. */
8414 #define fn_rsvg_handle_new rsvg_handle_new
8415 #define fn_rsvg_handle_get_dimensions rsvg_handle_get_dimensions
8416 #define fn_rsvg_handle_write rsvg_handle_write
8417 #define fn_rsvg_handle_close rsvg_handle_close
8418 #define fn_rsvg_handle_get_pixbuf rsvg_handle_get_pixbuf
8420 #define fn_gdk_pixbuf_get_width gdk_pixbuf_get_width
8421 #define fn_gdk_pixbuf_get_height gdk_pixbuf_get_height
8422 #define fn_gdk_pixbuf_get_pixels gdk_pixbuf_get_pixels
8423 #define fn_gdk_pixbuf_get_rowstride gdk_pixbuf_get_rowstride
8424 #define fn_gdk_pixbuf_get_colorspace gdk_pixbuf_get_colorspace
8425 #define fn_gdk_pixbuf_get_n_channels gdk_pixbuf_get_n_channels
8426 #define fn_gdk_pixbuf_get_has_alpha gdk_pixbuf_get_has_alpha
8427 #define fn_gdk_pixbuf_get_bits_per_sample gdk_pixbuf_get_bits_per_sample
8429 #define fn_g_type_init g_type_init
8430 #define fn_g_object_unref g_object_unref
8431 #define fn_g_error_free g_error_free
8432 #endif /* !WINDOWSNT */
8434 /* Load SVG image IMG for use on frame F. Value is true if
8438 svg_load (struct frame
*f
, struct image
*img
)
8441 Lisp_Object file_name
;
8443 /* If IMG->spec specifies a file name, create a non-file spec from it. */
8444 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
8445 if (STRINGP (file_name
))
8448 unsigned char *contents
;
8451 file
= x_find_image_file (file_name
);
8452 if (!STRINGP (file
))
8454 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
8458 /* Read the entire file into memory. */
8459 contents
= slurp_file (SSDATA (file
), &size
);
8460 if (contents
== NULL
)
8462 image_error ("Error loading SVG image `%s'", img
->spec
, Qnil
);
8465 /* If the file was slurped into memory properly, parse it. */
8466 success_p
= svg_load_image (f
, img
, contents
, size
);
8469 /* Else its not a file, its a lisp object. Load the image from a
8470 lisp object rather than a file. */
8475 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
8476 if (!STRINGP (data
))
8478 image_error ("Invalid image data `%s'", data
, Qnil
);
8481 success_p
= svg_load_image (f
, img
, SDATA (data
), SBYTES (data
));
8487 /* svg_load_image is a helper function for svg_load, which does the
8488 actual loading given contents and size, apart from frame and image
8489 structures, passed from svg_load.
8491 Uses librsvg to do most of the image processing.
8493 Returns true when successful. */
8495 svg_load_image (struct frame
*f
, /* Pointer to emacs frame structure. */
8496 struct image
*img
, /* Pointer to emacs image structure. */
8497 unsigned char *contents
, /* String containing the SVG XML data to be parsed. */
8498 ptrdiff_t size
) /* Size of data in bytes. */
8500 RsvgHandle
*rsvg_handle
;
8501 RsvgDimensionData dimension_data
;
8506 const guint8
*pixels
;
8509 Lisp_Object specified_bg
;
8514 /* g_type_init is a glib function that must be called prior to using
8515 gnome type library functions. */
8517 /* Make a handle to a new rsvg object. */
8518 rsvg_handle
= fn_rsvg_handle_new ();
8520 /* Parse the contents argument and fill in the rsvg_handle. */
8521 fn_rsvg_handle_write (rsvg_handle
, contents
, size
, &err
);
8522 if (err
) goto rsvg_error
;
8524 /* The parsing is complete, rsvg_handle is ready to used, close it
8525 for further writes. */
8526 fn_rsvg_handle_close (rsvg_handle
, &err
);
8527 if (err
) goto rsvg_error
;
8529 fn_rsvg_handle_get_dimensions (rsvg_handle
, &dimension_data
);
8530 if (! check_image_size (f
, dimension_data
.width
, dimension_data
.height
))
8532 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
8536 /* We can now get a valid pixel buffer from the svg file, if all
8538 pixbuf
= fn_rsvg_handle_get_pixbuf (rsvg_handle
);
8539 if (!pixbuf
) goto rsvg_error
;
8540 fn_g_object_unref (rsvg_handle
);
8542 /* Extract some meta data from the svg handle. */
8543 width
= fn_gdk_pixbuf_get_width (pixbuf
);
8544 height
= fn_gdk_pixbuf_get_height (pixbuf
);
8545 pixels
= fn_gdk_pixbuf_get_pixels (pixbuf
);
8546 rowstride
= fn_gdk_pixbuf_get_rowstride (pixbuf
);
8548 /* Validate the svg meta data. */
8549 eassert (fn_gdk_pixbuf_get_colorspace (pixbuf
) == GDK_COLORSPACE_RGB
);
8550 eassert (fn_gdk_pixbuf_get_n_channels (pixbuf
) == 4);
8551 eassert (fn_gdk_pixbuf_get_has_alpha (pixbuf
));
8552 eassert (fn_gdk_pixbuf_get_bits_per_sample (pixbuf
) == 8);
8554 /* Try to create a x pixmap to hold the svg pixmap. */
8555 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, 0, &ximg
, 0))
8557 fn_g_object_unref (pixbuf
);
8561 init_color_table ();
8563 /* Handle alpha channel by combining the image with a background
8565 specified_bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
8566 if (!STRINGP (specified_bg
)
8567 || !x_defined_color (f
, SSDATA (specified_bg
), &background
, 0))
8570 background
.pixel
= FRAME_BACKGROUND_PIXEL (f
);
8571 x_query_color (f
, &background
);
8573 ns_query_color (FRAME_BACKGROUND_COLOR (f
), &background
, 1);
8577 /* SVG pixmaps specify transparency in the last byte, so right
8578 shift 8 bits to get rid of it, since emacs doesn't support
8580 background
.red
>>= 8;
8581 background
.green
>>= 8;
8582 background
.blue
>>= 8;
8584 /* This loop handles opacity values, since Emacs assumes
8585 non-transparent images. Each pixel must be "flattened" by
8586 calculating the resulting color, given the transparency of the
8587 pixel, and the image background color. */
8588 for (y
= 0; y
< height
; ++y
)
8590 for (x
= 0; x
< width
; ++x
)
8600 opacity
= *pixels
++;
8602 red
= ((red
* opacity
)
8603 + (background
.red
* ((1 << 8) - opacity
)));
8604 green
= ((green
* opacity
)
8605 + (background
.green
* ((1 << 8) - opacity
)));
8606 blue
= ((blue
* opacity
)
8607 + (background
.blue
* ((1 << 8) - opacity
)));
8609 XPutPixel (ximg
, x
, y
, lookup_rgb_color (f
, red
, green
, blue
));
8612 pixels
+= rowstride
- 4 * width
;
8615 #ifdef COLOR_TABLE_SUPPORT
8616 /* Remember colors allocated for this image. */
8617 img
->colors
= colors_in_color_table (&img
->ncolors
);
8618 free_color_table ();
8619 #endif /* COLOR_TABLE_SUPPORT */
8621 fn_g_object_unref (pixbuf
);
8624 img
->height
= height
;
8626 /* Maybe fill in the background field while we have ximg handy.
8627 Casting avoids a GCC warning. */
8628 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
8630 /* Put ximg into the image. */
8631 image_put_x_image (f
, img
, ximg
, 0);
8636 fn_g_object_unref (rsvg_handle
);
8637 /* FIXME: Use error->message so the user knows what is the actual
8638 problem with the image. */
8639 image_error ("Error parsing SVG image `%s'", img
->spec
, Qnil
);
8640 fn_g_error_free (err
);
8644 #endif /* defined (HAVE_RSVG) */
8649 /***********************************************************************
8651 ***********************************************************************/
8653 #ifdef HAVE_X_WINDOWS
8654 #define HAVE_GHOSTSCRIPT 1
8655 #endif /* HAVE_X_WINDOWS */
8657 #ifdef HAVE_GHOSTSCRIPT
8659 static bool gs_image_p (Lisp_Object object
);
8660 static bool gs_load (struct frame
*f
, struct image
*img
);
8661 static void gs_clear_image (struct frame
*f
, struct image
*img
);
8663 /* Keyword symbols. */
8665 static Lisp_Object QCloader
, QCbounding_box
, QCpt_width
, QCpt_height
;
8667 /* Indices of image specification fields in gs_format, below. */
8669 enum gs_keyword_index
8687 /* Vector of image_keyword structures describing the format
8688 of valid user-defined image specifications. */
8690 static const struct image_keyword gs_format
[GS_LAST
] =
8692 {":type", IMAGE_SYMBOL_VALUE
, 1},
8693 {":pt-width", IMAGE_POSITIVE_INTEGER_VALUE
, 1},
8694 {":pt-height", IMAGE_POSITIVE_INTEGER_VALUE
, 1},
8695 {":file", IMAGE_STRING_VALUE
, 1},
8696 {":loader", IMAGE_FUNCTION_VALUE
, 0},
8697 {":bounding-box", IMAGE_DONT_CHECK_VALUE_TYPE
, 1},
8698 {":ascent", IMAGE_ASCENT_VALUE
, 0},
8699 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
8700 {":relief", IMAGE_INTEGER_VALUE
, 0},
8701 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8702 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8703 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8704 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
8707 /* Structure describing the image type `ghostscript'. */
8709 static struct image_type gs_type
=
8720 /* Free X resources of Ghostscript image IMG which is used on frame F. */
8723 gs_clear_image (struct frame
*f
, struct image
*img
)
8725 x_clear_image (f
, img
);
8729 /* Return true if OBJECT is a valid Ghostscript image
8733 gs_image_p (Lisp_Object object
)
8735 struct image_keyword fmt
[GS_LAST
];
8739 memcpy (fmt
, gs_format
, sizeof fmt
);
8741 if (!parse_image_spec (object
, fmt
, GS_LAST
, Qpostscript
))
8744 /* Bounding box must be a list or vector containing 4 integers. */
8745 tem
= fmt
[GS_BOUNDING_BOX
].value
;
8748 for (i
= 0; i
< 4; ++i
, tem
= XCDR (tem
))
8749 if (!CONSP (tem
) || !INTEGERP (XCAR (tem
)))
8754 else if (VECTORP (tem
))
8756 if (ASIZE (tem
) != 4)
8758 for (i
= 0; i
< 4; ++i
)
8759 if (!INTEGERP (AREF (tem
, i
)))
8769 /* Load Ghostscript image IMG for use on frame F. Value is true
8773 gs_load (struct frame
*f
, struct image
*img
)
8775 uprintmax_t printnum1
, printnum2
;
8776 char buffer
[sizeof " " + INT_STRLEN_BOUND (printmax_t
)];
8777 Lisp_Object window_and_pixmap_id
= Qnil
, loader
, pt_height
, pt_width
;
8779 double in_width
, in_height
;
8780 Lisp_Object pixel_colors
= Qnil
;
8782 /* Compute pixel size of pixmap needed from the given size in the
8783 image specification. Sizes in the specification are in pt. 1 pt
8784 = 1/72 in, xdpi and ydpi are stored in the frame's X display
8786 pt_width
= image_spec_value (img
->spec
, QCpt_width
, NULL
);
8787 in_width
= INTEGERP (pt_width
) ? XFASTINT (pt_width
) / 72.0 : 0;
8788 in_width
*= FRAME_RES_X (f
);
8789 pt_height
= image_spec_value (img
->spec
, QCpt_height
, NULL
);
8790 in_height
= INTEGERP (pt_height
) ? XFASTINT (pt_height
) / 72.0 : 0;
8791 in_height
*= FRAME_RES_Y (f
);
8793 if (! (in_width
<= INT_MAX
&& in_height
<= INT_MAX
8794 && check_image_size (f
, in_width
, in_height
)))
8796 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
8799 img
->width
= in_width
;
8800 img
->height
= in_height
;
8802 /* Create the pixmap. */
8803 eassert (img
->pixmap
== NO_PIXMAP
);
8805 if (x_check_image_size (0, img
->width
, img
->height
))
8807 /* Only W32 version did BLOCK_INPUT here. ++kfs */
8809 img
->pixmap
= XCreatePixmap (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
8810 img
->width
, img
->height
,
8811 DefaultDepthOfScreen (FRAME_X_SCREEN (f
)));
8817 image_error ("Unable to create pixmap for `%s'", img
->spec
, Qnil
);
8821 /* Call the loader to fill the pixmap. It returns a process object
8822 if successful. We do not record_unwind_protect here because
8823 other places in redisplay like calling window scroll functions
8824 don't either. Let the Lisp loader use `unwind-protect' instead. */
8825 printnum1
= FRAME_X_WINDOW (f
);
8826 printnum2
= img
->pixmap
;
8827 window_and_pixmap_id
8828 = make_formatted_string (buffer
, "%"pMu
" %"pMu
, printnum1
, printnum2
);
8830 printnum1
= FRAME_FOREGROUND_PIXEL (f
);
8831 printnum2
= FRAME_BACKGROUND_PIXEL (f
);
8833 = make_formatted_string (buffer
, "%"pMu
" %"pMu
, printnum1
, printnum2
);
8835 XSETFRAME (frame
, f
);
8836 loader
= image_spec_value (img
->spec
, QCloader
, NULL
);
8838 loader
= intern ("gs-load-image");
8840 img
->lisp_data
= call6 (loader
, frame
, img
->spec
,
8841 make_number (img
->width
),
8842 make_number (img
->height
),
8843 window_and_pixmap_id
,
8845 return PROCESSP (img
->lisp_data
);
8849 /* Kill the Ghostscript process that was started to fill PIXMAP on
8850 frame F. Called from XTread_socket when receiving an event
8851 telling Emacs that Ghostscript has finished drawing. */
8854 x_kill_gs_process (Pixmap pixmap
, struct frame
*f
)
8856 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
8861 /* Find the image containing PIXMAP. */
8862 for (i
= 0; i
< c
->used
; ++i
)
8863 if (c
->images
[i
]->pixmap
== pixmap
)
8866 /* Should someone in between have cleared the image cache, for
8867 instance, give up. */
8871 /* Kill the GS process. We should have found PIXMAP in the image
8872 cache and its image should contain a process object. */
8874 eassert (PROCESSP (img
->lisp_data
));
8875 Fkill_process (img
->lisp_data
, Qnil
);
8876 img
->lisp_data
= Qnil
;
8878 #if defined (HAVE_X_WINDOWS)
8880 /* On displays with a mutable colormap, figure out the colors
8881 allocated for the image by looking at the pixels of an XImage for
8883 class = FRAME_X_VISUAL (f
)->class;
8884 if (class != StaticColor
&& class != StaticGray
&& class != TrueColor
)
8890 /* Try to get an XImage for img->pixmep. */
8891 ximg
= XGetImage (FRAME_X_DISPLAY (f
), img
->pixmap
,
8892 0, 0, img
->width
, img
->height
, ~0, ZPixmap
);
8897 /* Initialize the color table. */
8898 init_color_table ();
8900 /* For each pixel of the image, look its color up in the
8901 color table. After having done so, the color table will
8902 contain an entry for each color used by the image. */
8903 for (y
= 0; y
< img
->height
; ++y
)
8904 for (x
= 0; x
< img
->width
; ++x
)
8906 unsigned long pixel
= XGetPixel (ximg
, x
, y
);
8907 lookup_pixel_color (f
, pixel
);
8910 /* Record colors in the image. Free color table and XImage. */
8911 #ifdef COLOR_TABLE_SUPPORT
8912 img
->colors
= colors_in_color_table (&img
->ncolors
);
8913 free_color_table ();
8915 XDestroyImage (ximg
);
8917 #if 0 /* This doesn't seem to be the case. If we free the colors
8918 here, we get a BadAccess later in x_clear_image when
8919 freeing the colors. */
8920 /* We have allocated colors once, but Ghostscript has also
8921 allocated colors on behalf of us. So, to get the
8922 reference counts right, free them once. */
8924 x_free_colors (f
, img
->colors
, img
->ncolors
);
8928 image_error ("Cannot get X image of `%s'; colors will not be freed",
8933 #endif /* HAVE_X_WINDOWS */
8935 /* Now that we have the pixmap, compute mask and transform the
8936 image if requested. */
8938 postprocess_image (f
, img
);
8942 #endif /* HAVE_GHOSTSCRIPT */
8945 /***********************************************************************
8947 ***********************************************************************/
8951 DEFUN ("imagep", Fimagep
, Simagep
, 1, 1, 0,
8952 doc
: /* Value is non-nil if SPEC is a valid image specification. */)
8955 return valid_image_p (spec
) ? Qt
: Qnil
;
8959 DEFUN ("lookup-image", Flookup_image
, Slookup_image
, 1, 1, 0, "")
8964 if (valid_image_p (spec
))
8965 id
= lookup_image (SELECTED_FRAME (), spec
);
8968 return make_number (id
);
8971 #endif /* GLYPH_DEBUG */
8974 /***********************************************************************
8976 ***********************************************************************/
8978 DEFUN ("init-image-library", Finit_image_library
, Sinit_image_library
, 1, 1, 0,
8979 doc
: /* Initialize image library implementing image type TYPE.
8980 Return non-nil if TYPE is a supported image type.
8982 If image libraries are loaded dynamically (currently only the case on
8983 MS-Windows), load the library for TYPE if it is not yet loaded, using
8984 the library file(s) specified by `dynamic-library-alist'. */)
8987 return lookup_image_type (type
) ? Qt
: Qnil
;
8990 /* Look up image type TYPE, and return a pointer to its image_type
8991 structure. Return 0 if TYPE is not a known image type. */
8993 static struct image_type
*
8994 lookup_image_type (Lisp_Object type
)
8996 /* Types pbm and xbm are built-in and always available. */
8997 if (EQ (type
, Qpbm
))
8998 return define_image_type (&pbm_type
);
9000 if (EQ (type
, Qxbm
))
9001 return define_image_type (&xbm_type
);
9003 #if defined (HAVE_XPM) || defined (HAVE_NS)
9004 if (EQ (type
, Qxpm
))
9005 return define_image_type (&xpm_type
);
9008 #if defined (HAVE_JPEG) || defined (HAVE_NS)
9009 if (EQ (type
, Qjpeg
))
9010 return define_image_type (&jpeg_type
);
9013 #if defined (HAVE_TIFF) || defined (HAVE_NS)
9014 if (EQ (type
, Qtiff
))
9015 return define_image_type (&tiff_type
);
9018 #if defined (HAVE_GIF) || defined (HAVE_NS)
9019 if (EQ (type
, Qgif
))
9020 return define_image_type (&gif_type
);
9023 #if defined (HAVE_PNG) || defined (HAVE_NS)
9024 if (EQ (type
, Qpng
))
9025 return define_image_type (&png_type
);
9028 #if defined (HAVE_RSVG)
9029 if (EQ (type
, Qsvg
))
9030 return define_image_type (&svg_type
);
9033 #if defined (HAVE_IMAGEMAGICK)
9034 if (EQ (type
, Qimagemagick
))
9035 return define_image_type (&imagemagick_type
);
9038 #ifdef HAVE_GHOSTSCRIPT
9039 if (EQ (type
, Qpostscript
))
9040 return define_image_type (&gs_type
);
9046 /* Reset image_types before dumping.
9047 Called from Fdump_emacs. */
9050 reset_image_types (void)
9054 struct image_type
*next
= image_types
->next
;
9055 xfree (image_types
);
9061 syms_of_image (void)
9063 /* Initialize this only once; it will be reset before dumping. */
9066 /* Must be defined now because we're going to update it below, while
9067 defining the supported image types. */
9068 DEFVAR_LISP ("image-types", Vimage_types
,
9069 doc
: /* List of potentially supported image types.
9070 Each element of the list is a symbol for an image type, like 'jpeg or 'png.
9071 To check whether it is really supported, use `image-type-available-p'. */);
9072 Vimage_types
= Qnil
;
9074 DEFVAR_LISP ("max-image-size", Vmax_image_size
,
9075 doc
: /* Maximum size of images.
9076 Emacs will not load an image into memory if its pixel width or
9077 pixel height exceeds this limit.
9079 If the value is an integer, it directly specifies the maximum
9080 image height and width, measured in pixels. If it is a floating
9081 point number, it specifies the maximum image height and width
9082 as a ratio to the frame height and width. If the value is
9083 non-numeric, there is no explicit limit on the size of images. */);
9084 Vmax_image_size
= make_float (MAX_IMAGE_SIZE
);
9086 DEFSYM (Qcount
, "count");
9087 DEFSYM (Qextension_data
, "extension-data");
9088 DEFSYM (Qdelay
, "delay");
9090 DEFSYM (QCascent
, ":ascent");
9091 DEFSYM (QCmargin
, ":margin");
9092 DEFSYM (QCrelief
, ":relief");
9093 DEFSYM (QCconversion
, ":conversion");
9094 DEFSYM (QCcolor_symbols
, ":color-symbols");
9095 DEFSYM (QCheuristic_mask
, ":heuristic-mask");
9096 DEFSYM (QCindex
, ":index");
9097 DEFSYM (QCgeometry
, ":geometry");
9098 DEFSYM (QCcrop
, ":crop");
9099 DEFSYM (QCrotation
, ":rotation");
9100 DEFSYM (QCmatrix
, ":matrix");
9101 DEFSYM (QCcolor_adjustment
, ":color-adjustment");
9102 DEFSYM (QCmask
, ":mask");
9104 DEFSYM (Qlaplace
, "laplace");
9105 DEFSYM (Qemboss
, "emboss");
9106 DEFSYM (Qedge_detection
, "edge-detection");
9107 DEFSYM (Qheuristic
, "heuristic");
9109 DEFSYM (Qpostscript
, "postscript");
9110 DEFSYM (QCmax_width
, ":max-width");
9111 DEFSYM (QCmax_height
, ":max-height");
9112 #ifdef HAVE_GHOSTSCRIPT
9113 ADD_IMAGE_TYPE (Qpostscript
);
9114 DEFSYM (QCloader
, ":loader");
9115 DEFSYM (QCbounding_box
, ":bounding-box");
9116 DEFSYM (QCpt_width
, ":pt-width");
9117 DEFSYM (QCpt_height
, ":pt-height");
9118 #endif /* HAVE_GHOSTSCRIPT */
9121 DEFSYM (Qlibpng_version
, "libpng-version");
9122 Fset (Qlibpng_version
,
9124 make_number (PNG_LIBPNG_VER
)
9131 DEFSYM (Qpbm
, "pbm");
9132 ADD_IMAGE_TYPE (Qpbm
);
9134 DEFSYM (Qxbm
, "xbm");
9135 ADD_IMAGE_TYPE (Qxbm
);
9137 #if defined (HAVE_XPM) || defined (HAVE_NS)
9138 DEFSYM (Qxpm
, "xpm");
9139 ADD_IMAGE_TYPE (Qxpm
);
9142 #if defined (HAVE_JPEG) || defined (HAVE_NS)
9143 DEFSYM (Qjpeg
, "jpeg");
9144 ADD_IMAGE_TYPE (Qjpeg
);
9147 #if defined (HAVE_TIFF) || defined (HAVE_NS)
9148 DEFSYM (Qtiff
, "tiff");
9149 ADD_IMAGE_TYPE (Qtiff
);
9152 #if defined (HAVE_GIF) || defined (HAVE_NS)
9153 DEFSYM (Qgif
, "gif");
9154 ADD_IMAGE_TYPE (Qgif
);
9157 #if defined (HAVE_PNG) || defined (HAVE_NS)
9158 DEFSYM (Qpng
, "png");
9159 ADD_IMAGE_TYPE (Qpng
);
9162 #if defined (HAVE_IMAGEMAGICK)
9163 DEFSYM (Qimagemagick
, "imagemagick");
9164 ADD_IMAGE_TYPE (Qimagemagick
);
9167 #if defined (HAVE_RSVG)
9168 DEFSYM (Qsvg
, "svg");
9169 ADD_IMAGE_TYPE (Qsvg
);
9171 /* Other libraries used directly by svg code. */
9172 DEFSYM (Qgdk_pixbuf
, "gdk-pixbuf");
9173 DEFSYM (Qglib
, "glib");
9174 DEFSYM (Qgobject
, "gobject");
9175 #endif /* HAVE_NTGUI */
9176 #endif /* HAVE_RSVG */
9178 defsubr (&Sinit_image_library
);
9179 #ifdef HAVE_IMAGEMAGICK
9180 defsubr (&Simagemagick_types
);
9182 defsubr (&Sclear_image_cache
);
9183 defsubr (&Simage_flush
);
9184 defsubr (&Simage_size
);
9185 defsubr (&Simage_mask_p
);
9186 defsubr (&Simage_metadata
);
9190 defsubr (&Slookup_image
);
9193 DEFVAR_BOOL ("cross-disabled-images", cross_disabled_images
,
9194 doc
: /* Non-nil means always draw a cross over disabled images.
9195 Disabled images are those having a `:conversion disabled' property.
9196 A cross is always drawn on black & white displays. */);
9197 cross_disabled_images
= 0;
9199 DEFVAR_LISP ("x-bitmap-file-path", Vx_bitmap_file_path
,
9200 doc
: /* List of directories to search for window system bitmap files. */);
9201 Vx_bitmap_file_path
= decode_env_path ((char *) 0, PATH_BITMAPS
);
9203 DEFVAR_LISP ("image-cache-eviction-delay", Vimage_cache_eviction_delay
,
9204 doc
: /* Maximum time after which images are removed from the cache.
9205 When an image has not been displayed this many seconds, Emacs
9206 automatically removes it from the image cache. If the cache contains
9207 a large number of images, the actual eviction time may be shorter.
9208 The value can also be nil, meaning the cache is never cleared.
9210 The function `clear-image-cache' disregards this variable. */);
9211 Vimage_cache_eviction_delay
= make_number (300);
9212 #ifdef HAVE_IMAGEMAGICK
9213 DEFVAR_INT ("imagemagick-render-type", imagemagick_render_type
,
9214 doc
: /* Integer indicating which ImageMagick rendering method to use.
9216 0 -- the default method (pixel pushing)
9217 1 -- a newer method ("MagickExportImagePixels") that may perform
9218 better (speed etc) in some cases, but has not been as thoroughly
9219 tested with Emacs as the default method. This method requires
9220 ImageMagick version 6.4.6 (approximately) or later.
9222 /* MagickExportImagePixels is in 6.4.6-9, but not 6.4.4-10. */
9223 imagemagick_render_type
= 0;