1 /* Functions for image support on window system.
3 Copyright (C) 1989, 1992-2013 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
25 #if defined HAVE_LIBPNG_PNG_H
26 # include <libpng/png.h>
36 /* This makes the fields of a Display accessible, in Xlib header files. */
38 #define XLIB_ILLEGAL_ACCESS
43 #include "dispextern.h"
44 #include "blockinput.h"
47 #include "character.h"
49 #include "termhooks.h"
52 #ifdef HAVE_SYS_STAT_H
54 #endif /* HAVE_SYS_STAT_H */
56 #ifdef HAVE_SYS_TYPES_H
57 #include <sys/types.h>
58 #endif /* HAVE_SYS_TYPES_H */
60 #ifdef HAVE_WINDOW_SYSTEM
62 #endif /* HAVE_WINDOW_SYSTEM */
65 #define COLOR_TABLE_SUPPORT 1
67 typedef struct x_bitmap_record Bitmap_Record
;
68 #define GET_PIXEL(ximg, x, y) XGetPixel (ximg, x, y)
69 #define NO_PIXMAP None
71 #define PIX_MASK_RETAIN 0
72 #define PIX_MASK_DRAW 1
73 #endif /* HAVE_X_WINDOWS */
77 /* We need (or want) w32.h only when we're _not_ compiling for Cygwin. */
82 /* W32_TODO : Color tables on W32. */
83 #undef COLOR_TABLE_SUPPORT
85 typedef struct w32_bitmap_record Bitmap_Record
;
86 #define GET_PIXEL(ximg, x, y) GetPixel (ximg, x, y)
89 #define PIX_MASK_RETAIN 0
90 #define PIX_MASK_DRAW 1
92 #define x_defined_color w32_defined_color
93 #define DefaultDepthOfScreen(screen) (one_w32_display_info.n_cbits)
95 /* Version of libpng that we were compiled with, or -1 if no PNG
96 support was compiled in. This is tested by w32-win.el to correctly
97 set up the alist used to search for PNG libraries. */
98 Lisp_Object Qlibpng_version
;
99 #endif /* HAVE_NTGUI */
102 #undef COLOR_TABLE_SUPPORT
104 typedef struct ns_bitmap_record Bitmap_Record
;
106 #define GET_PIXEL(ximg, x, y) XGetPixel (ximg, x, y)
109 #define PIX_MASK_RETAIN 0
110 #define PIX_MASK_DRAW 1
112 #define x_defined_color(f, name, color_def, alloc) \
113 ns_defined_color (f, name, color_def, alloc, 0)
114 #define DefaultDepthOfScreen(screen) x_display_list->n_planes
118 /* The symbol `postscript' identifying images of this type. */
120 static Lisp_Object Qpostscript
;
122 static void x_disable_image (struct frame
*, struct image
*);
123 static void x_edge_detection (struct frame
*, struct image
*, Lisp_Object
,
126 static void init_color_table (void);
127 static unsigned long lookup_rgb_color (struct frame
*f
, int r
, int g
, int b
);
128 #ifdef COLOR_TABLE_SUPPORT
129 static void free_color_table (void);
130 static unsigned long *colors_in_color_table (int *n
);
133 static Lisp_Object QCmax_width
, QCmax_height
;
135 /* Code to deal with bitmaps. Bitmaps are referenced by their bitmap
136 id, which is just an int that this section returns. Bitmaps are
137 reference counted so they can be shared among frames.
139 Bitmap indices are guaranteed to be > 0, so a negative number can
140 be used to indicate no bitmap.
142 If you use x_create_bitmap_from_data, then you must keep track of
143 the bitmaps yourself. That is, creating a bitmap from the same
144 data more than once will not be caught. */
147 /* Use with images created by ns_image_for_XPM. */
149 XGetPixel (XImagePtr ximage
, int x
, int y
)
151 return ns_get_pixel (ximage
, x
, y
);
154 /* Use with images created by ns_image_for_XPM; alpha set to 1;
155 pixel is assumed to be in RGB form. */
157 XPutPixel (XImagePtr ximage
, int x
, int y
, unsigned long pixel
)
159 ns_put_pixel (ximage
, x
, y
, pixel
);
164 /* Functions to access the contents of a bitmap, given an id. */
167 x_bitmap_height (struct frame
*f
, ptrdiff_t id
)
169 return FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].height
;
173 x_bitmap_width (struct frame
*f
, ptrdiff_t id
)
175 return FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].width
;
178 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI)
180 x_bitmap_pixmap (struct frame
*f
, ptrdiff_t id
)
182 /* HAVE_NTGUI needs the explicit cast here. */
183 return (ptrdiff_t) FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].pixmap
;
187 #ifdef HAVE_X_WINDOWS
189 x_bitmap_mask (struct frame
*f
, ptrdiff_t id
)
191 return FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].mask
;
195 /* Allocate a new bitmap record. Returns index of new record. */
198 x_allocate_bitmap_record (struct frame
*f
)
200 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
203 if (dpyinfo
->bitmaps_last
< dpyinfo
->bitmaps_size
)
204 return ++dpyinfo
->bitmaps_last
;
206 for (i
= 0; i
< dpyinfo
->bitmaps_size
; ++i
)
207 if (dpyinfo
->bitmaps
[i
].refcount
== 0)
211 xpalloc (dpyinfo
->bitmaps
, &dpyinfo
->bitmaps_size
,
212 10, -1, sizeof *dpyinfo
->bitmaps
);
213 return ++dpyinfo
->bitmaps_last
;
216 /* Add one reference to the reference count of the bitmap with id ID. */
219 x_reference_bitmap (struct frame
*f
, ptrdiff_t id
)
221 ++FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].refcount
;
224 /* Create a bitmap for frame F from a HEIGHT x WIDTH array of bits at BITS. */
227 x_create_bitmap_from_data (struct frame
*f
, char *bits
, unsigned int width
, unsigned int height
)
229 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
232 #ifdef HAVE_X_WINDOWS
234 bitmap
= XCreateBitmapFromData (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
235 bits
, width
, height
);
238 #endif /* HAVE_X_WINDOWS */
242 bitmap
= CreateBitmap (width
, height
,
243 FRAME_X_DISPLAY_INFO (XFRAME (frame
))->n_planes
,
244 FRAME_X_DISPLAY_INFO (XFRAME (frame
))->n_cbits
,
248 #endif /* HAVE_NTGUI */
251 void *bitmap
= ns_image_from_XBM (bits
, width
, height
);
256 id
= x_allocate_bitmap_record (f
);
259 dpyinfo
->bitmaps
[id
- 1].img
= bitmap
;
260 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
263 dpyinfo
->bitmaps
[id
- 1].file
= NULL
;
264 dpyinfo
->bitmaps
[id
- 1].height
= height
;
265 dpyinfo
->bitmaps
[id
- 1].width
= width
;
266 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
268 #ifdef HAVE_X_WINDOWS
269 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
270 dpyinfo
->bitmaps
[id
- 1].have_mask
= 0;
271 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
272 #endif /* HAVE_X_WINDOWS */
275 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
276 dpyinfo
->bitmaps
[id
- 1].hinst
= NULL
;
277 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
278 #endif /* HAVE_NTGUI */
283 /* Create bitmap from file FILE for frame F. */
286 x_create_bitmap_from_file (struct frame
*f
, Lisp_Object file
)
288 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
291 return -1; /* W32_TODO : bitmap support */
292 #endif /* HAVE_NTGUI */
296 void *bitmap
= ns_image_from_file (file
);
302 id
= x_allocate_bitmap_record (f
);
303 dpyinfo
->bitmaps
[id
- 1].img
= bitmap
;
304 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
305 dpyinfo
->bitmaps
[id
- 1].file
= xmalloc (SBYTES (file
) + 1);
306 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
307 dpyinfo
->bitmaps
[id
- 1].height
= ns_image_width (bitmap
);
308 dpyinfo
->bitmaps
[id
- 1].width
= ns_image_height (bitmap
);
309 strcpy (dpyinfo
->bitmaps
[id
- 1].file
, SSDATA (file
));
313 #ifdef HAVE_X_WINDOWS
314 unsigned int width
, height
;
316 int xhot
, yhot
, result
;
321 /* Look for an existing bitmap with the same name. */
322 for (id
= 0; id
< dpyinfo
->bitmaps_last
; ++id
)
324 if (dpyinfo
->bitmaps
[id
].refcount
325 && dpyinfo
->bitmaps
[id
].file
326 && !strcmp (dpyinfo
->bitmaps
[id
].file
, SSDATA (file
)))
328 ++dpyinfo
->bitmaps
[id
].refcount
;
333 /* Search bitmap-file-path for the file, if appropriate. */
334 if (openp (Vx_bitmap_file_path
, file
, Qnil
, &found
, make_number (R_OK
)) < 0)
337 filename
= SSDATA (found
);
339 result
= XReadBitmapFile (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
340 filename
, &width
, &height
, &bitmap
, &xhot
, &yhot
);
341 if (result
!= BitmapSuccess
)
344 id
= x_allocate_bitmap_record (f
);
345 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
346 dpyinfo
->bitmaps
[id
- 1].have_mask
= 0;
347 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
348 dpyinfo
->bitmaps
[id
- 1].file
= xmalloc (SBYTES (file
) + 1);
349 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
350 dpyinfo
->bitmaps
[id
- 1].height
= height
;
351 dpyinfo
->bitmaps
[id
- 1].width
= width
;
352 strcpy (dpyinfo
->bitmaps
[id
- 1].file
, SSDATA (file
));
355 #endif /* HAVE_X_WINDOWS */
361 free_bitmap_record (Display_Info
*dpyinfo
, Bitmap_Record
*bm
)
363 #ifdef HAVE_X_WINDOWS
364 XFreePixmap (dpyinfo
->display
, bm
->pixmap
);
366 XFreePixmap (dpyinfo
->display
, bm
->mask
);
367 #endif /* HAVE_X_WINDOWS */
370 DeleteObject (bm
->pixmap
);
371 #endif /* HAVE_NTGUI */
374 ns_release_object (bm
->img
);
384 /* Remove reference to bitmap with id number ID. */
387 x_destroy_bitmap (struct frame
*f
, ptrdiff_t id
)
389 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
393 Bitmap_Record
*bm
= &dpyinfo
->bitmaps
[id
- 1];
395 if (--bm
->refcount
== 0)
398 free_bitmap_record (dpyinfo
, bm
);
404 /* Free all the bitmaps for the display specified by DPYINFO. */
407 x_destroy_all_bitmaps (Display_Info
*dpyinfo
)
410 Bitmap_Record
*bm
= dpyinfo
->bitmaps
;
412 for (i
= 0; i
< dpyinfo
->bitmaps_last
; i
++, bm
++)
413 if (bm
->refcount
> 0)
414 free_bitmap_record (dpyinfo
, bm
);
416 dpyinfo
->bitmaps_last
= 0;
419 static bool x_create_x_image_and_pixmap (struct frame
*, int, int, int,
420 XImagePtr
*, Pixmap
*);
421 static void x_destroy_x_image (XImagePtr ximg
);
424 static XImagePtr_or_DC
image_get_x_image_or_dc (struct frame
*, struct image
*,
426 static void image_unget_x_image_or_dc (struct image
*, bool, XImagePtr_or_DC
,
429 static XImagePtr
image_get_x_image (struct frame
*, struct image
*, bool);
430 static void image_unget_x_image (struct image
*, bool, XImagePtr
);
431 #define image_get_x_image_or_dc(f, img, mask_p, dummy) \
432 image_get_x_image (f, img, mask_p)
433 #define image_unget_x_image_or_dc(img, mask_p, ximg, dummy) \
434 image_unget_x_image (img, mask_p, ximg)
437 #ifdef HAVE_X_WINDOWS
439 static void image_sync_to_pixmaps (struct frame
*, struct image
*);
441 /* Useful functions defined in the section
442 `Image type independent image structures' below. */
444 static unsigned long four_corners_best (XImagePtr ximg
,
447 unsigned long height
);
450 /* Create a mask of a bitmap. Note is this not a perfect mask.
451 It's nicer with some borders in this context */
454 x_create_bitmap_mask (struct frame
*f
, ptrdiff_t id
)
457 XImagePtr ximg
, mask_img
;
458 unsigned long width
, height
;
461 unsigned long x
, y
, xp
, xm
, yp
, ym
;
464 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
469 pixmap
= x_bitmap_pixmap (f
, id
);
470 width
= x_bitmap_width (f
, id
);
471 height
= x_bitmap_height (f
, id
);
474 ximg
= XGetImage (FRAME_X_DISPLAY (f
), pixmap
, 0, 0, width
, height
,
483 result
= x_create_x_image_and_pixmap (f
, width
, height
, 1, &mask_img
, &mask
);
488 XDestroyImage (ximg
);
492 bg
= four_corners_best (ximg
, NULL
, width
, height
);
494 for (y
= 0; y
< ximg
->height
; ++y
)
496 for (x
= 0; x
< ximg
->width
; ++x
)
498 xp
= x
!= ximg
->width
- 1 ? x
+ 1 : 0;
499 xm
= x
!= 0 ? x
- 1 : ximg
->width
- 1;
500 yp
= y
!= ximg
->height
- 1 ? y
+ 1 : 0;
501 ym
= y
!= 0 ? y
- 1 : ximg
->height
- 1;
502 if (XGetPixel (ximg
, x
, y
) == bg
503 && XGetPixel (ximg
, x
, yp
) == bg
504 && XGetPixel (ximg
, x
, ym
) == bg
505 && XGetPixel (ximg
, xp
, y
) == bg
506 && XGetPixel (ximg
, xp
, yp
) == bg
507 && XGetPixel (ximg
, xp
, ym
) == bg
508 && XGetPixel (ximg
, xm
, y
) == bg
509 && XGetPixel (ximg
, xm
, yp
) == bg
510 && XGetPixel (ximg
, xm
, ym
) == bg
)
511 XPutPixel (mask_img
, x
, y
, 0);
513 XPutPixel (mask_img
, x
, y
, 1);
517 eassert (input_blocked_p ());
518 gc
= XCreateGC (FRAME_X_DISPLAY (f
), mask
, 0, NULL
);
519 XPutImage (FRAME_X_DISPLAY (f
), mask
, gc
, mask_img
, 0, 0, 0, 0,
521 XFreeGC (FRAME_X_DISPLAY (f
), gc
);
523 dpyinfo
->bitmaps
[id
- 1].have_mask
= 1;
524 dpyinfo
->bitmaps
[id
- 1].mask
= mask
;
526 XDestroyImage (ximg
);
527 x_destroy_x_image (mask_img
);
530 #endif /* HAVE_X_WINDOWS */
533 /***********************************************************************
535 ***********************************************************************/
537 /* List of supported image types. Use define_image_type to add new
538 types. Use lookup_image_type to find a type for a given symbol. */
540 static struct image_type
*image_types
;
542 /* The symbol `xbm' which is used as the type symbol for XBM images. */
544 static Lisp_Object Qxbm
;
548 Lisp_Object QCascent
, QCmargin
, QCrelief
;
549 Lisp_Object QCconversion
;
550 static Lisp_Object QCheuristic_mask
;
551 static Lisp_Object QCcolor_symbols
;
552 static Lisp_Object QCindex
, QCmatrix
, QCcolor_adjustment
, QCmask
, QCgeometry
;
553 static Lisp_Object QCcrop
, QCrotation
;
554 static Lisp_Object QCcontent_type
;
558 static Lisp_Object Qcount
, Qextension_data
, Qdelay
;
559 static Lisp_Object Qlaplace
, Qemboss
, Qedge_detection
, Qheuristic
;
561 /* Forward function prototypes. */
563 static struct image_type
*lookup_image_type (Lisp_Object
);
564 static void x_laplace (struct frame
*, struct image
*);
565 static void x_emboss (struct frame
*, struct image
*);
566 static void x_build_heuristic_mask (struct frame
*, struct image
*,
569 extern Lisp_Object Vlibrary_cache
;
570 #define CACHE_IMAGE_TYPE(type, status) \
571 do { Vlibrary_cache = Fcons (Fcons (type, status), Vlibrary_cache); } while (0)
573 #define CACHE_IMAGE_TYPE(type, status)
576 #define ADD_IMAGE_TYPE(type) \
577 do { Vimage_types = Fcons (type, Vimage_types); } while (0)
579 /* Define a new image type from TYPE. This adds a copy of TYPE to
580 image_types and caches the loading status of TYPE. */
582 static struct image_type
*
583 define_image_type (struct image_type
*type
)
585 struct image_type
*p
= NULL
;
586 Lisp_Object target_type
= *type
->type
;
591 for (p
= image_types
; p
; p
= p
->next
)
592 if (EQ (*p
->type
, target_type
))
597 #if defined HAVE_NTGUI && defined WINDOWSNT
598 /* If we failed to load the library before, don't try again. */
599 Lisp_Object tested
= Fassq (target_type
, Vlibrary_cache
);
600 if (CONSP (tested
) && NILP (XCDR (tested
)))
605 type_valid
= type
->init ();
606 CACHE_IMAGE_TYPE (target_type
, type_valid
? Qt
: Qnil
);
612 /* Make a copy of TYPE to avoid a bus error in a dumped Emacs.
613 The initialized data segment is read-only. */
614 p
= xmalloc (sizeof *p
);
616 p
->next
= image_types
;
626 /* Value is true if OBJECT is a valid Lisp image specification. A
627 valid image specification is a list whose car is the symbol
628 `image', and whose rest is a property list. The property list must
629 contain a value for key `:type'. That value must be the name of a
630 supported image type. The rest of the property list depends on the
634 valid_image_p (Lisp_Object object
)
642 for (tem
= XCDR (object
); CONSP (tem
); tem
= XCDR (tem
))
643 if (EQ (XCAR (tem
), QCtype
))
646 if (CONSP (tem
) && SYMBOLP (XCAR (tem
)))
648 struct image_type
*type
;
649 type
= lookup_image_type (XCAR (tem
));
651 valid_p
= type
->valid_p (object
);
662 /* Log error message with format string FORMAT and argument ARG.
663 Signaling an error, e.g. when an image cannot be loaded, is not a
664 good idea because this would interrupt redisplay, and the error
665 message display would lead to another redisplay. This function
666 therefore simply displays a message. */
669 image_error (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
671 add_to_log (format
, arg1
, arg2
);
676 /***********************************************************************
678 ***********************************************************************/
680 enum image_value_type
682 IMAGE_DONT_CHECK_VALUE_TYPE
,
684 IMAGE_STRING_OR_NIL_VALUE
,
686 IMAGE_POSITIVE_INTEGER_VALUE
,
687 IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
,
688 IMAGE_NON_NEGATIVE_INTEGER_VALUE
,
691 IMAGE_FUNCTION_VALUE
,
696 /* Structure used when parsing image specifications. */
700 /* Name of keyword. */
703 /* The type of value allowed. */
704 enum image_value_type type
;
706 /* True means key must be present. */
709 /* Used to recognize duplicate keywords in a property list. */
712 /* The value that was found. */
717 /* Parse image spec SPEC according to KEYWORDS. A valid image spec
718 has the format (image KEYWORD VALUE ...). One of the keyword/
719 value pairs must be `:type TYPE'. KEYWORDS is a vector of
720 image_keywords structures of size NKEYWORDS describing other
721 allowed keyword/value pairs. Value is true if SPEC is valid. */
724 parse_image_spec (Lisp_Object spec
, struct image_keyword
*keywords
,
725 int nkeywords
, Lisp_Object type
)
734 while (CONSP (plist
))
736 Lisp_Object key
, value
;
738 /* First element of a pair must be a symbol. */
740 plist
= XCDR (plist
);
744 /* There must follow a value. */
747 value
= XCAR (plist
);
748 plist
= XCDR (plist
);
750 /* Find key in KEYWORDS. Error if not found. */
751 for (i
= 0; i
< nkeywords
; ++i
)
752 if (strcmp (keywords
[i
].name
, SSDATA (SYMBOL_NAME (key
))) == 0)
758 /* Record that we recognized the keyword. If a keywords
759 was found more than once, it's an error. */
760 keywords
[i
].value
= value
;
761 if (keywords
[i
].count
> 1)
765 /* Check type of value against allowed type. */
766 switch (keywords
[i
].type
)
768 case IMAGE_STRING_VALUE
:
769 if (!STRINGP (value
))
773 case IMAGE_STRING_OR_NIL_VALUE
:
774 if (!STRINGP (value
) && !NILP (value
))
778 case IMAGE_SYMBOL_VALUE
:
779 if (!SYMBOLP (value
))
783 case IMAGE_POSITIVE_INTEGER_VALUE
:
784 if (! RANGED_INTEGERP (1, value
, INT_MAX
))
788 case IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
:
789 if (RANGED_INTEGERP (0, value
, INT_MAX
))
792 && RANGED_INTEGERP (0, XCAR (value
), INT_MAX
)
793 && RANGED_INTEGERP (0, XCDR (value
), INT_MAX
))
797 case IMAGE_ASCENT_VALUE
:
798 if (SYMBOLP (value
) && EQ (value
, Qcenter
))
800 else if (RANGED_INTEGERP (0, value
, 100))
804 case IMAGE_NON_NEGATIVE_INTEGER_VALUE
:
805 /* Unlike the other integer-related cases, this one does not
806 verify that VALUE fits in 'int'. This is because callers
808 if (!INTEGERP (value
) || XINT (value
) < 0)
812 case IMAGE_DONT_CHECK_VALUE_TYPE
:
815 case IMAGE_FUNCTION_VALUE
:
816 value
= indirect_function (value
);
817 if (!NILP (Ffunctionp (value
)))
821 case IMAGE_NUMBER_VALUE
:
822 if (!INTEGERP (value
) && !FLOATP (value
))
826 case IMAGE_INTEGER_VALUE
:
827 if (! TYPE_RANGED_INTEGERP (int, value
))
831 case IMAGE_BOOL_VALUE
:
832 if (!NILP (value
) && !EQ (value
, Qt
))
841 if (EQ (key
, QCtype
) && !EQ (type
, value
))
845 /* Check that all mandatory fields are present. */
846 for (i
= 0; i
< nkeywords
; ++i
)
847 if (keywords
[i
].mandatory_p
&& keywords
[i
].count
== 0)
854 /* Return the value of KEY in image specification SPEC. Value is nil
855 if KEY is not present in SPEC. Set *FOUND depending on whether KEY
856 was found in SPEC. */
859 image_spec_value (Lisp_Object spec
, Lisp_Object key
, bool *found
)
863 eassert (valid_image_p (spec
));
865 for (tail
= XCDR (spec
);
866 CONSP (tail
) && CONSP (XCDR (tail
));
867 tail
= XCDR (XCDR (tail
)))
869 if (EQ (XCAR (tail
), key
))
873 return XCAR (XCDR (tail
));
883 DEFUN ("image-size", Fimage_size
, Simage_size
, 1, 3, 0,
884 doc
: /* Return the size of image SPEC as pair (WIDTH . HEIGHT).
885 PIXELS non-nil means return the size in pixels, otherwise return the
886 size in canonical character units.
887 FRAME is the frame on which the image will be displayed. FRAME nil
888 or omitted means use the selected frame. */)
889 (Lisp_Object spec
, Lisp_Object pixels
, Lisp_Object frame
)
894 if (valid_image_p (spec
))
896 struct frame
*f
= decode_window_system_frame (frame
);
897 ptrdiff_t id
= lookup_image (f
, spec
);
898 struct image
*img
= IMAGE_FROM_ID (f
, id
);
899 int width
= img
->width
+ 2 * img
->hmargin
;
900 int height
= img
->height
+ 2 * img
->vmargin
;
903 size
= Fcons (make_float ((double) width
/ FRAME_COLUMN_WIDTH (f
)),
904 make_float ((double) height
/ FRAME_LINE_HEIGHT (f
)));
906 size
= Fcons (make_number (width
), make_number (height
));
909 error ("Invalid image specification");
915 DEFUN ("image-mask-p", Fimage_mask_p
, Simage_mask_p
, 1, 2, 0,
916 doc
: /* Return t if image SPEC has a mask bitmap.
917 FRAME is the frame on which the image will be displayed. FRAME nil
918 or omitted means use the selected frame. */)
919 (Lisp_Object spec
, Lisp_Object frame
)
924 if (valid_image_p (spec
))
926 struct frame
*f
= decode_window_system_frame (frame
);
927 ptrdiff_t id
= lookup_image (f
, spec
);
928 struct image
*img
= IMAGE_FROM_ID (f
, id
);
933 error ("Invalid image specification");
938 DEFUN ("image-metadata", Fimage_metadata
, Simage_metadata
, 1, 2, 0,
939 doc
: /* Return metadata for image SPEC.
940 FRAME is the frame on which the image will be displayed. FRAME nil
941 or omitted means use the selected frame. */)
942 (Lisp_Object spec
, Lisp_Object frame
)
947 if (valid_image_p (spec
))
949 struct frame
*f
= decode_window_system_frame (frame
);
950 ptrdiff_t id
= lookup_image (f
, spec
);
951 struct image
*img
= IMAGE_FROM_ID (f
, id
);
952 ext
= img
->lisp_data
;
959 /***********************************************************************
960 Image type independent image structures
961 ***********************************************************************/
963 #define MAX_IMAGE_SIZE 10.0
964 /* Allocate and return a new image structure for image specification
965 SPEC. SPEC has a hash value of HASH. */
967 static struct image
*
968 make_image (Lisp_Object spec
, EMACS_UINT hash
)
970 struct image
*img
= xzalloc (sizeof *img
);
971 Lisp_Object file
= image_spec_value (spec
, QCfile
, NULL
);
973 eassert (valid_image_p (spec
));
974 img
->dependencies
= NILP (file
) ? Qnil
: list1 (file
);
975 img
->type
= lookup_image_type (image_spec_value (spec
, QCtype
, NULL
));
976 eassert (img
->type
!= NULL
);
978 img
->lisp_data
= Qnil
;
979 img
->ascent
= DEFAULT_IMAGE_ASCENT
;
981 img
->corners
[BOT_CORNER
] = -1; /* Full image */
986 /* Free image IMG which was used on frame F, including its resources. */
989 free_image (struct frame
*f
, struct image
*img
)
993 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
995 /* Remove IMG from the hash table of its cache. */
997 img
->prev
->next
= img
->next
;
999 c
->buckets
[img
->hash
% IMAGE_CACHE_BUCKETS_SIZE
] = img
->next
;
1002 img
->next
->prev
= img
->prev
;
1004 c
->images
[img
->id
] = NULL
;
1006 /* Free resources, then free IMG. */
1007 img
->type
->free (f
, img
);
1012 /* Return true if the given widths and heights are valid for display. */
1015 check_image_size (struct frame
*f
, int width
, int height
)
1019 if (width
<= 0 || height
<= 0)
1022 if (INTEGERP (Vmax_image_size
))
1023 return (width
<= XINT (Vmax_image_size
)
1024 && height
<= XINT (Vmax_image_size
));
1025 else if (FLOATP (Vmax_image_size
))
1029 w
= FRAME_PIXEL_WIDTH (f
);
1030 h
= FRAME_PIXEL_HEIGHT (f
);
1033 w
= h
= 1024; /* Arbitrary size for unknown frame. */
1034 return (width
<= XFLOAT_DATA (Vmax_image_size
) * w
1035 && height
<= XFLOAT_DATA (Vmax_image_size
) * h
);
1041 /* Prepare image IMG for display on frame F. Must be called before
1042 drawing an image. */
1045 prepare_image_for_display (struct frame
*f
, struct image
*img
)
1047 /* We're about to display IMG, so set its timestamp to `now'. */
1048 img
->timestamp
= current_emacs_time ();
1050 /* If IMG doesn't have a pixmap yet, load it now, using the image
1051 type dependent loader function. */
1052 if (img
->pixmap
== NO_PIXMAP
&& !img
->load_failed_p
)
1053 img
->load_failed_p
= ! img
->type
->load (f
, img
);
1055 #ifdef HAVE_X_WINDOWS
1056 if (!img
->load_failed_p
)
1059 image_sync_to_pixmaps (f
, img
);
1066 /* Value is the number of pixels for the ascent of image IMG when
1067 drawn in face FACE. */
1070 image_ascent (struct image
*img
, struct face
*face
, struct glyph_slice
*slice
)
1075 if (slice
->height
== img
->height
)
1076 height
= img
->height
+ img
->vmargin
;
1077 else if (slice
->y
== 0)
1078 height
= slice
->height
+ img
->vmargin
;
1080 height
= slice
->height
;
1082 if (img
->ascent
== CENTERED_IMAGE_ASCENT
)
1087 /* W32 specific version. Why?. ++kfs */
1088 ascent
= height
/ 2 - (FONT_DESCENT (face
->font
)
1089 - FONT_BASE (face
->font
)) / 2;
1091 /* This expression is arranged so that if the image can't be
1092 exactly centered, it will be moved slightly up. This is
1093 because a typical font is `top-heavy' (due to the presence
1094 uppercase letters), so the image placement should err towards
1095 being top-heavy too. It also just generally looks better. */
1096 ascent
= (height
+ FONT_BASE (face
->font
)
1097 - FONT_DESCENT (face
->font
) + 1) / 2;
1098 #endif /* HAVE_NTGUI */
1101 ascent
= height
/ 2;
1104 ascent
= height
* (img
->ascent
/ 100.0);
1110 /* Image background colors. */
1112 /* Find the "best" corner color of a bitmap.
1113 On W32, XIMG is assumed to a device context with the bitmap selected. */
1115 static RGB_PIXEL_COLOR
1116 four_corners_best (XImagePtr_or_DC ximg
, int *corners
,
1117 unsigned long width
, unsigned long height
)
1119 RGB_PIXEL_COLOR corner_pixels
[4], best
IF_LINT (= 0);
1122 if (corners
&& corners
[BOT_CORNER
] >= 0)
1124 /* Get the colors at the corner_pixels of ximg. */
1125 corner_pixels
[0] = GET_PIXEL (ximg
, corners
[LEFT_CORNER
], corners
[TOP_CORNER
]);
1126 corner_pixels
[1] = GET_PIXEL (ximg
, corners
[RIGHT_CORNER
] - 1, corners
[TOP_CORNER
]);
1127 corner_pixels
[2] = GET_PIXEL (ximg
, corners
[RIGHT_CORNER
] - 1, corners
[BOT_CORNER
] - 1);
1128 corner_pixels
[3] = GET_PIXEL (ximg
, corners
[LEFT_CORNER
], corners
[BOT_CORNER
] - 1);
1132 /* Get the colors at the corner_pixels of ximg. */
1133 corner_pixels
[0] = GET_PIXEL (ximg
, 0, 0);
1134 corner_pixels
[1] = GET_PIXEL (ximg
, width
- 1, 0);
1135 corner_pixels
[2] = GET_PIXEL (ximg
, width
- 1, height
- 1);
1136 corner_pixels
[3] = GET_PIXEL (ximg
, 0, height
- 1);
1138 /* Choose the most frequently found color as background. */
1139 for (i
= best_count
= 0; i
< 4; ++i
)
1143 for (j
= n
= 0; j
< 4; ++j
)
1144 if (corner_pixels
[i
] == corner_pixels
[j
])
1148 best
= corner_pixels
[i
], best_count
= n
;
1154 /* Portability macros */
1158 #define Free_Pixmap(display, pixmap) \
1159 DeleteObject (pixmap)
1161 #elif defined (HAVE_NS)
1163 #define Free_Pixmap(display, pixmap) \
1164 ns_release_object (pixmap)
1168 #define Free_Pixmap(display, pixmap) \
1169 XFreePixmap (display, pixmap)
1171 #endif /* !HAVE_NTGUI && !HAVE_NS */
1174 /* Return the `background' field of IMG. If IMG doesn't have one yet,
1175 it is guessed heuristically. If non-zero, XIMG is an existing
1176 XImage object (or device context with the image selected on W32) to
1177 use for the heuristic. */
1180 image_background (struct image
*img
, struct frame
*f
, XImagePtr_or_DC ximg
)
1182 if (! img
->background_valid
)
1183 /* IMG doesn't have a background yet, try to guess a reasonable value. */
1185 bool free_ximg
= !ximg
;
1188 #endif /* HAVE_NTGUI */
1191 ximg
= image_get_x_image_or_dc (f
, img
, 0, &prev
);
1193 img
->background
= four_corners_best (ximg
, img
->corners
, img
->width
, img
->height
);
1196 image_unget_x_image_or_dc (img
, 0, ximg
, prev
);
1198 img
->background_valid
= 1;
1201 return img
->background
;
1204 /* Return the `background_transparent' field of IMG. If IMG doesn't
1205 have one yet, it is guessed heuristically. If non-zero, MASK is an
1206 existing XImage object to use for the heuristic. */
1209 image_background_transparent (struct image
*img
, struct frame
*f
, XImagePtr_or_DC mask
)
1211 if (! img
->background_transparent_valid
)
1212 /* IMG doesn't have a background yet, try to guess a reasonable value. */
1216 bool free_mask
= !mask
;
1219 #endif /* HAVE_NTGUI */
1222 mask
= image_get_x_image_or_dc (f
, img
, 1, &prev
);
1224 img
->background_transparent
1225 = (four_corners_best (mask
, img
->corners
, img
->width
, img
->height
) == PIX_MASK_RETAIN
);
1228 image_unget_x_image_or_dc (img
, 1, mask
, prev
);
1231 img
->background_transparent
= 0;
1233 img
->background_transparent_valid
= 1;
1236 return img
->background_transparent
;
1240 /***********************************************************************
1241 Helper functions for X image types
1242 ***********************************************************************/
1244 /* Clear X resources of image IMG on frame F according to FLAGS.
1245 FLAGS is bitwise-or of the following masks:
1246 CLEAR_IMAGE_PIXMAP free the pixmap if any.
1247 CLEAR_IMAGE_MASK means clear the mask pixmap if any.
1248 CLEAR_IMAGE_COLORS means free colors allocated for the image, if
1251 #define CLEAR_IMAGE_PIXMAP (1 << 0)
1252 #define CLEAR_IMAGE_MASK (1 << 1)
1253 #define CLEAR_IMAGE_COLORS (1 << 2)
1256 x_clear_image_1 (struct frame
*f
, struct image
*img
, int flags
)
1258 if (flags
& CLEAR_IMAGE_PIXMAP
)
1262 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->pixmap
);
1263 img
->pixmap
= NO_PIXMAP
;
1264 /* NOTE (HAVE_NS): background color is NOT an indexed color! */
1265 img
->background_valid
= 0;
1267 #ifdef HAVE_X_WINDOWS
1270 x_destroy_x_image (img
->ximg
);
1272 img
->background_valid
= 0;
1277 if (flags
& CLEAR_IMAGE_MASK
)
1281 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->mask
);
1282 img
->mask
= NO_PIXMAP
;
1283 img
->background_transparent_valid
= 0;
1285 #ifdef HAVE_X_WINDOWS
1288 x_destroy_x_image (img
->mask_img
);
1289 img
->mask_img
= NULL
;
1290 img
->background_transparent_valid
= 0;
1295 if ((flags
& CLEAR_IMAGE_COLORS
) && img
->ncolors
)
1297 /* W32_TODO: color table support. */
1298 #ifdef HAVE_X_WINDOWS
1299 x_free_colors (f
, img
->colors
, img
->ncolors
);
1300 #endif /* HAVE_X_WINDOWS */
1301 xfree (img
->colors
);
1308 /* Free X resources of image IMG which is used on frame F. */
1311 x_clear_image (struct frame
*f
, struct image
*img
)
1314 x_clear_image_1 (f
, img
,
1315 CLEAR_IMAGE_PIXMAP
| CLEAR_IMAGE_MASK
| CLEAR_IMAGE_COLORS
);
1320 /* Allocate color COLOR_NAME for image IMG on frame F. If color
1321 cannot be allocated, use DFLT. Add a newly allocated color to
1322 IMG->colors, so that it can be freed again. Value is the pixel
1325 static unsigned long
1326 x_alloc_image_color (struct frame
*f
, struct image
*img
, Lisp_Object color_name
,
1330 unsigned long result
;
1332 eassert (STRINGP (color_name
));
1334 if (x_defined_color (f
, SSDATA (color_name
), &color
, 1)
1335 && img
->ncolors
< min (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *img
->colors
,
1338 /* This isn't called frequently so we get away with simply
1339 reallocating the color vector to the needed size, here. */
1340 ptrdiff_t ncolors
= img
->ncolors
+ 1;
1341 img
->colors
= xrealloc (img
->colors
, ncolors
* sizeof *img
->colors
);
1342 img
->colors
[ncolors
- 1] = color
.pixel
;
1343 img
->ncolors
= ncolors
;
1344 result
= color
.pixel
;
1354 /***********************************************************************
1356 ***********************************************************************/
1358 static void cache_image (struct frame
*f
, struct image
*img
);
1360 /* Return a new, initialized image cache that is allocated from the
1361 heap. Call free_image_cache to free an image cache. */
1363 struct image_cache
*
1364 make_image_cache (void)
1366 struct image_cache
*c
= xzalloc (sizeof *c
);
1370 c
->images
= xmalloc (size
* sizeof *c
->images
);
1372 size
= IMAGE_CACHE_BUCKETS_SIZE
* sizeof *c
->buckets
;
1373 c
->buckets
= xzalloc (size
);
1378 /* Find an image matching SPEC in the cache, and return it. If no
1379 image is found, return NULL. */
1380 static struct image
*
1381 search_image_cache (struct frame
*f
, Lisp_Object spec
, EMACS_UINT hash
)
1384 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1385 int i
= hash
% IMAGE_CACHE_BUCKETS_SIZE
;
1387 if (!c
) return NULL
;
1389 /* If the image spec does not specify a background color, the cached
1390 image must have the same background color as the current frame.
1391 The foreground color must also match, for the sake of monochrome
1394 In fact, we could ignore the foreground color matching condition
1395 for color images, or if the image spec specifies :foreground;
1396 similarly we could ignore the background color matching condition
1397 for formats that don't use transparency (such as jpeg), or if the
1398 image spec specifies :background. However, the extra memory
1399 usage is probably negligible in practice, so we don't bother. */
1401 for (img
= c
->buckets
[i
]; img
; img
= img
->next
)
1402 if (img
->hash
== hash
1403 && !NILP (Fequal (img
->spec
, spec
))
1404 && img
->frame_foreground
== FRAME_FOREGROUND_PIXEL (f
)
1405 && img
->frame_background
== FRAME_BACKGROUND_PIXEL (f
))
1411 /* Search frame F for an image with spec SPEC, and free it. */
1414 uncache_image (struct frame
*f
, Lisp_Object spec
)
1416 struct image
*img
= search_image_cache (f
, spec
, sxhash (spec
, 0));
1419 free_image (f
, img
);
1420 /* As display glyphs may still be referring to the image ID, we
1421 must garbage the frame (Bug#6426). */
1422 SET_FRAME_GARBAGED (f
);
1427 /* Free image cache of frame F. Be aware that X frames share images
1431 free_image_cache (struct frame
*f
)
1433 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1438 /* Cache should not be referenced by any frame when freed. */
1439 eassert (c
->refcount
== 0);
1441 for (i
= 0; i
< c
->used
; ++i
)
1442 free_image (f
, c
->images
[i
]);
1446 FRAME_IMAGE_CACHE (f
) = NULL
;
1451 /* Clear image cache of frame F. FILTER=t means free all images.
1452 FILTER=nil means clear only images that haven't been
1453 displayed for some time.
1454 Else, only free the images which have FILTER in their `dependencies'.
1455 Should be called from time to time to reduce the number of loaded images.
1456 If image-cache-eviction-delay is non-nil, this frees images in the cache
1457 which weren't displayed for at least that many seconds. */
1460 clear_image_cache (struct frame
*f
, Lisp_Object filter
)
1462 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1466 ptrdiff_t i
, nfreed
= 0;
1468 /* Block input so that we won't be interrupted by a SIGIO
1469 while being in an inconsistent state. */
1474 /* Filter image cache. */
1475 for (i
= 0; i
< c
->used
; ++i
)
1477 struct image
*img
= c
->images
[i
];
1478 if (img
&& (EQ (Qt
, filter
)
1479 || !NILP (Fmember (filter
, img
->dependencies
))))
1481 free_image (f
, img
);
1486 else if (INTEGERP (Vimage_cache_eviction_delay
))
1488 /* Free cache based on timestamp. */
1491 ptrdiff_t nimages
= 0;
1493 for (i
= 0; i
< c
->used
; ++i
)
1497 /* If the number of cached images has grown unusually large,
1498 decrease the cache eviction delay (Bug#6230). */
1499 delay
= XINT (Vimage_cache_eviction_delay
);
1501 delay
= 1600 * delay
/ nimages
/ nimages
;
1502 delay
= max (delay
, 1);
1504 t
= current_emacs_time ();
1505 old
= sub_emacs_time (t
, EMACS_TIME_FROM_DOUBLE (delay
));
1507 for (i
= 0; i
< c
->used
; ++i
)
1509 struct image
*img
= c
->images
[i
];
1510 if (img
&& EMACS_TIME_LT (img
->timestamp
, old
))
1512 free_image (f
, img
);
1518 /* We may be clearing the image cache because, for example,
1519 Emacs was iconified for a longer period of time. In that
1520 case, current matrices may still contain references to
1521 images freed above. So, clear these matrices. */
1524 Lisp_Object tail
, frame
;
1526 FOR_EACH_FRAME (tail
, frame
)
1528 struct frame
*fr
= XFRAME (frame
);
1529 if (FRAME_IMAGE_CACHE (fr
) == c
)
1530 clear_current_matrices (fr
);
1533 ++windows_or_buffers_changed
;
1541 clear_image_caches (Lisp_Object filter
)
1543 /* FIXME: We want to do
1544 * struct terminal *t;
1545 * for (t = terminal_list; t; t = t->next_terminal)
1546 * clear_image_cache (t, filter); */
1547 Lisp_Object tail
, frame
;
1548 FOR_EACH_FRAME (tail
, frame
)
1549 if (FRAME_WINDOW_P (XFRAME (frame
)))
1550 clear_image_cache (XFRAME (frame
), filter
);
1553 DEFUN ("clear-image-cache", Fclear_image_cache
, Sclear_image_cache
,
1555 doc
: /* Clear the image cache.
1556 FILTER nil or a frame means clear all images in the selected frame.
1557 FILTER t means clear the image caches of all frames.
1558 Anything else, means only clear those images which refer to FILTER,
1559 which is then usually a filename. */)
1560 (Lisp_Object filter
)
1562 if (!(EQ (filter
, Qnil
) || FRAMEP (filter
)))
1563 clear_image_caches (filter
);
1565 clear_image_cache (decode_window_system_frame (filter
), Qt
);
1571 DEFUN ("image-flush", Fimage_flush
, Simage_flush
,
1573 doc
: /* Flush the image with specification SPEC on frame FRAME.
1574 This removes the image from the Emacs image cache. If SPEC specifies
1575 an image file, the next redisplay of this image will read from the
1576 current contents of that file.
1578 FRAME nil or omitted means use the selected frame.
1579 FRAME t means refresh the image on all frames. */)
1580 (Lisp_Object spec
, Lisp_Object frame
)
1582 if (!valid_image_p (spec
))
1583 error ("Invalid image specification");
1588 FOR_EACH_FRAME (tail
, frame
)
1590 struct frame
*f
= XFRAME (frame
);
1591 if (FRAME_WINDOW_P (f
))
1592 uncache_image (f
, spec
);
1596 uncache_image (decode_window_system_frame (frame
), spec
);
1602 /* Compute masks and transform image IMG on frame F, as specified
1603 by the image's specification, */
1606 postprocess_image (struct frame
*f
, struct image
*img
)
1608 /* Manipulation of the image's mask. */
1611 Lisp_Object conversion
, spec
;
1616 /* `:heuristic-mask t'
1618 means build a mask heuristically.
1619 `:heuristic-mask (R G B)'
1620 `:mask (heuristic (R G B))'
1621 means build a mask from color (R G B) in the
1624 means remove a mask, if any. */
1626 mask
= image_spec_value (spec
, QCheuristic_mask
, NULL
);
1628 x_build_heuristic_mask (f
, img
, mask
);
1633 mask
= image_spec_value (spec
, QCmask
, &found_p
);
1635 if (EQ (mask
, Qheuristic
))
1636 x_build_heuristic_mask (f
, img
, Qt
);
1637 else if (CONSP (mask
)
1638 && EQ (XCAR (mask
), Qheuristic
))
1640 if (CONSP (XCDR (mask
)))
1641 x_build_heuristic_mask (f
, img
, XCAR (XCDR (mask
)));
1643 x_build_heuristic_mask (f
, img
, XCDR (mask
));
1645 else if (NILP (mask
) && found_p
&& img
->mask
)
1646 x_clear_image_1 (f
, img
, CLEAR_IMAGE_MASK
);
1650 /* Should we apply an image transformation algorithm? */
1651 conversion
= image_spec_value (spec
, QCconversion
, NULL
);
1652 if (EQ (conversion
, Qdisabled
))
1653 x_disable_image (f
, img
);
1654 else if (EQ (conversion
, Qlaplace
))
1656 else if (EQ (conversion
, Qemboss
))
1658 else if (CONSP (conversion
)
1659 && EQ (XCAR (conversion
), Qedge_detection
))
1662 tem
= XCDR (conversion
);
1664 x_edge_detection (f
, img
,
1665 Fplist_get (tem
, QCmatrix
),
1666 Fplist_get (tem
, QCcolor_adjustment
));
1672 /* Return the id of image with Lisp specification SPEC on frame F.
1673 SPEC must be a valid Lisp image specification (see valid_image_p). */
1676 lookup_image (struct frame
*f
, Lisp_Object spec
)
1681 /* F must be a window-system frame, and SPEC must be a valid image
1683 eassert (FRAME_WINDOW_P (f
));
1684 eassert (valid_image_p (spec
));
1686 /* Look up SPEC in the hash table of the image cache. */
1687 hash
= sxhash (spec
, 0);
1688 img
= search_image_cache (f
, spec
, hash
);
1689 if (img
&& img
->load_failed_p
)
1691 free_image (f
, img
);
1695 /* If not found, create a new image and cache it. */
1699 img
= make_image (spec
, hash
);
1700 cache_image (f
, img
);
1701 img
->load_failed_p
= ! img
->type
->load (f
, img
);
1702 img
->frame_foreground
= FRAME_FOREGROUND_PIXEL (f
);
1703 img
->frame_background
= FRAME_BACKGROUND_PIXEL (f
);
1705 /* If we can't load the image, and we don't have a width and
1706 height, use some arbitrary width and height so that we can
1707 draw a rectangle for it. */
1708 if (img
->load_failed_p
)
1712 value
= image_spec_value (spec
, QCwidth
, NULL
);
1713 img
->width
= (INTEGERP (value
)
1714 ? XFASTINT (value
) : DEFAULT_IMAGE_WIDTH
);
1715 value
= image_spec_value (spec
, QCheight
, NULL
);
1716 img
->height
= (INTEGERP (value
)
1717 ? XFASTINT (value
) : DEFAULT_IMAGE_HEIGHT
);
1721 /* Handle image type independent image attributes
1722 `:ascent ASCENT', `:margin MARGIN', `:relief RELIEF',
1723 `:background COLOR'. */
1724 Lisp_Object ascent
, margin
, relief
, bg
;
1727 ascent
= image_spec_value (spec
, QCascent
, NULL
);
1728 if (INTEGERP (ascent
))
1729 img
->ascent
= XFASTINT (ascent
);
1730 else if (EQ (ascent
, Qcenter
))
1731 img
->ascent
= CENTERED_IMAGE_ASCENT
;
1733 margin
= image_spec_value (spec
, QCmargin
, NULL
);
1734 if (INTEGERP (margin
))
1735 img
->vmargin
= img
->hmargin
= XFASTINT (margin
);
1736 else if (CONSP (margin
))
1738 img
->hmargin
= XFASTINT (XCAR (margin
));
1739 img
->vmargin
= XFASTINT (XCDR (margin
));
1742 relief
= image_spec_value (spec
, QCrelief
, NULL
);
1743 relief_bound
= INT_MAX
- max (img
->hmargin
, img
->vmargin
);
1744 if (RANGED_INTEGERP (- relief_bound
, relief
, relief_bound
))
1746 img
->relief
= XINT (relief
);
1747 img
->hmargin
+= eabs (img
->relief
);
1748 img
->vmargin
+= eabs (img
->relief
);
1751 if (! img
->background_valid
)
1753 bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
1757 = x_alloc_image_color (f
, img
, bg
,
1758 FRAME_BACKGROUND_PIXEL (f
));
1759 img
->background_valid
= 1;
1763 /* Do image transformations and compute masks, unless we
1764 don't have the image yet. */
1765 if (!EQ (*img
->type
->type
, Qpostscript
))
1766 postprocess_image (f
, img
);
1772 /* We're using IMG, so set its timestamp to `now'. */
1773 img
->timestamp
= current_emacs_time ();
1775 /* Value is the image id. */
1780 /* Cache image IMG in the image cache of frame F. */
1783 cache_image (struct frame
*f
, struct image
*img
)
1785 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1788 /* Find a free slot in c->images. */
1789 for (i
= 0; i
< c
->used
; ++i
)
1790 if (c
->images
[i
] == NULL
)
1793 /* If no free slot found, maybe enlarge c->images. */
1794 if (i
== c
->used
&& c
->used
== c
->size
)
1795 c
->images
= xpalloc (c
->images
, &c
->size
, 1, -1, sizeof *c
->images
);
1797 /* Add IMG to c->images, and assign IMG an id. */
1803 /* Add IMG to the cache's hash table. */
1804 i
= img
->hash
% IMAGE_CACHE_BUCKETS_SIZE
;
1805 img
->next
= c
->buckets
[i
];
1807 img
->next
->prev
= img
;
1809 c
->buckets
[i
] = img
;
1813 /* Call FN on every image in the image cache of frame F. Used to mark
1814 Lisp Objects in the image cache. */
1816 /* Mark Lisp objects in image IMG. */
1819 mark_image (struct image
*img
)
1821 mark_object (img
->spec
);
1822 mark_object (img
->dependencies
);
1824 if (!NILP (img
->lisp_data
))
1825 mark_object (img
->lisp_data
);
1830 mark_image_cache (struct image_cache
*c
)
1835 for (i
= 0; i
< c
->used
; ++i
)
1837 mark_image (c
->images
[i
]);
1843 /***********************************************************************
1844 X / NS / W32 support code
1845 ***********************************************************************/
1849 /* Macro for defining functions that will be loaded from image DLLs. */
1850 #define DEF_IMGLIB_FN(rettype,func,args) static rettype (FAR CDECL *fn_##func)args
1852 /* Macro for loading those image functions from the library. */
1853 #define LOAD_IMGLIB_FN(lib,func) { \
1854 fn_##func = (void *) GetProcAddress (lib, #func); \
1855 if (!fn_##func) return 0; \
1858 #endif /* WINDOWSNT */
1860 /* Return true if XIMG's size WIDTH x HEIGHT doesn't break the
1862 WIDTH and HEIGHT must both be positive.
1863 If XIMG is null, assume it is a bitmap. */
1865 x_check_image_size (XImagePtr ximg
, int width
, int height
)
1867 #ifdef HAVE_X_WINDOWS
1868 /* Respect Xlib's limits: it cannot deal with images that have more
1869 than INT_MAX (and/or UINT_MAX) bytes. And respect Emacs's limits
1870 of PTRDIFF_MAX (and/or SIZE_MAX) bytes for any object. */
1873 XLIB_BYTES_MAX
= min (INT_MAX
, UINT_MAX
),
1874 X_IMAGE_BYTES_MAX
= min (XLIB_BYTES_MAX
, min (PTRDIFF_MAX
, SIZE_MAX
))
1877 int bitmap_pad
, depth
, bytes_per_line
;
1880 bitmap_pad
= ximg
->bitmap_pad
;
1881 depth
= ximg
->depth
;
1882 bytes_per_line
= ximg
->bytes_per_line
;
1888 bytes_per_line
= (width
>> 3) + ((width
& 7) != 0);
1890 return (width
<= (INT_MAX
- (bitmap_pad
- 1)) / depth
1891 && height
<= X_IMAGE_BYTES_MAX
/ bytes_per_line
);
1893 /* FIXME: Implement this check for the HAVE_NS and HAVE_NTGUI cases.
1894 For now, assume that every image size is allowed on these systems. */
1899 /* Create an XImage and a pixmap of size WIDTH x HEIGHT for use on
1900 frame F. Set *XIMG and *PIXMAP to the XImage and Pixmap created.
1901 Set (*XIMG)->data to a raster of WIDTH x HEIGHT pixels allocated
1902 via xmalloc. Print error messages via image_error if an error
1903 occurs. Value is true if successful.
1905 On W32, a DEPTH of zero signifies a 24 bit image, otherwise DEPTH
1906 should indicate the bit depth of the image. */
1909 x_create_x_image_and_pixmap (struct frame
*f
, int width
, int height
, int depth
,
1910 XImagePtr
*ximg
, Pixmap
*pixmap
)
1912 #ifdef HAVE_X_WINDOWS
1913 Display
*display
= FRAME_X_DISPLAY (f
);
1914 Window window
= FRAME_X_WINDOW (f
);
1915 Screen
*screen
= FRAME_X_SCREEN (f
);
1917 eassert (input_blocked_p ());
1920 depth
= DefaultDepthOfScreen (screen
);
1921 *ximg
= XCreateImage (display
, DefaultVisualOfScreen (screen
),
1922 depth
, ZPixmap
, 0, NULL
, width
, height
,
1923 depth
> 16 ? 32 : depth
> 8 ? 16 : 8, 0);
1926 image_error ("Unable to allocate X image", Qnil
, Qnil
);
1930 if (! x_check_image_size (*ximg
, width
, height
))
1932 x_destroy_x_image (*ximg
);
1934 image_error ("Image too large (%dx%d)",
1935 make_number (width
), make_number (height
));
1939 /* Allocate image raster. */
1940 (*ximg
)->data
= xmalloc ((*ximg
)->bytes_per_line
* height
);
1942 /* Allocate a pixmap of the same size. */
1943 *pixmap
= XCreatePixmap (display
, window
, width
, height
, depth
);
1944 if (*pixmap
== NO_PIXMAP
)
1946 x_destroy_x_image (*ximg
);
1948 image_error ("Unable to create X pixmap", Qnil
, Qnil
);
1953 #endif /* HAVE_X_WINDOWS */
1957 BITMAPINFOHEADER
*header
;
1959 int scanline_width_bits
;
1961 int palette_colors
= 0;
1966 if (depth
!= 1 && depth
!= 4 && depth
!= 8
1967 && depth
!= 16 && depth
!= 24 && depth
!= 32)
1969 image_error ("Invalid image bit depth specified", Qnil
, Qnil
);
1973 scanline_width_bits
= width
* depth
;
1974 remainder
= scanline_width_bits
% 32;
1977 scanline_width_bits
+= 32 - remainder
;
1979 /* Bitmaps with a depth less than 16 need a palette. */
1980 /* BITMAPINFO structure already contains the first RGBQUAD. */
1982 palette_colors
= 1 << (depth
- 1);
1984 *ximg
= xmalloc (sizeof (XImage
) + palette_colors
* sizeof (RGBQUAD
));
1986 header
= &(*ximg
)->info
.bmiHeader
;
1987 memset (&(*ximg
)->info
, 0, sizeof (BITMAPINFO
));
1988 header
->biSize
= sizeof (*header
);
1989 header
->biWidth
= width
;
1990 header
->biHeight
= -height
; /* negative indicates a top-down bitmap. */
1991 header
->biPlanes
= 1;
1992 header
->biBitCount
= depth
;
1993 header
->biCompression
= BI_RGB
;
1994 header
->biClrUsed
= palette_colors
;
1996 /* TODO: fill in palette. */
1999 (*ximg
)->info
.bmiColors
[0].rgbBlue
= 0;
2000 (*ximg
)->info
.bmiColors
[0].rgbGreen
= 0;
2001 (*ximg
)->info
.bmiColors
[0].rgbRed
= 0;
2002 (*ximg
)->info
.bmiColors
[0].rgbReserved
= 0;
2003 (*ximg
)->info
.bmiColors
[1].rgbBlue
= 255;
2004 (*ximg
)->info
.bmiColors
[1].rgbGreen
= 255;
2005 (*ximg
)->info
.bmiColors
[1].rgbRed
= 255;
2006 (*ximg
)->info
.bmiColors
[1].rgbReserved
= 0;
2009 hdc
= get_frame_dc (f
);
2011 /* Create a DIBSection and raster array for the bitmap,
2012 and store its handle in *pixmap. */
2013 *pixmap
= CreateDIBSection (hdc
, &((*ximg
)->info
),
2014 (depth
< 16) ? DIB_PAL_COLORS
: DIB_RGB_COLORS
,
2015 /* casting avoids a GCC warning */
2016 (void **)&((*ximg
)->data
), NULL
, 0);
2018 /* Realize display palette and garbage all frames. */
2019 release_frame_dc (f
, hdc
);
2021 if (*pixmap
== NULL
)
2023 DWORD err
= GetLastError ();
2024 Lisp_Object errcode
;
2025 /* All system errors are < 10000, so the following is safe. */
2026 XSETINT (errcode
, err
);
2027 image_error ("Unable to create bitmap, error code %d", errcode
, Qnil
);
2028 x_destroy_x_image (*ximg
);
2034 #endif /* HAVE_NTGUI */
2037 *pixmap
= ns_image_for_XPM (width
, height
, depth
);
2041 image_error ("Unable to allocate NSImage for XPM pixmap", Qnil
, Qnil
);
2050 /* Destroy XImage XIMG. Free XIMG->data. */
2053 x_destroy_x_image (XImagePtr ximg
)
2055 eassert (input_blocked_p ());
2058 #ifdef HAVE_X_WINDOWS
2061 XDestroyImage (ximg
);
2062 #endif /* HAVE_X_WINDOWS */
2064 /* Data will be freed by DestroyObject. */
2067 #endif /* HAVE_NTGUI */
2069 ns_release_object (ximg
);
2070 #endif /* HAVE_NS */
2075 /* Put XImage XIMG into pixmap PIXMAP on frame F. WIDTH and HEIGHT
2076 are width and height of both the image and pixmap. */
2079 x_put_x_image (struct frame
*f
, XImagePtr ximg
, Pixmap pixmap
, int width
, int height
)
2081 #ifdef HAVE_X_WINDOWS
2084 eassert (input_blocked_p ());
2085 gc
= XCreateGC (FRAME_X_DISPLAY (f
), pixmap
, 0, NULL
);
2086 XPutImage (FRAME_X_DISPLAY (f
), pixmap
, gc
, ximg
, 0, 0, 0, 0, width
, height
);
2087 XFreeGC (FRAME_X_DISPLAY (f
), gc
);
2088 #endif /* HAVE_X_WINDOWS */
2091 #if 0 /* I don't think this is necessary looking at where it is used. */
2092 HDC hdc
= get_frame_dc (f
);
2093 SetDIBits (hdc
, pixmap
, 0, height
, ximg
->data
, &(ximg
->info
), DIB_RGB_COLORS
);
2094 release_frame_dc (f
, hdc
);
2096 #endif /* HAVE_NTGUI */
2099 eassert (ximg
== pixmap
);
2100 ns_retain_object (ximg
);
2104 /* Thin wrapper for x_create_x_image_and_pixmap, so that it matches
2105 with image_put_x_image. */
2108 image_create_x_image_and_pixmap (struct frame
*f
, struct image
*img
,
2109 int width
, int height
, int depth
,
2110 XImagePtr
*ximg
, bool mask_p
)
2112 eassert ((!mask_p
? img
->pixmap
: img
->mask
) == NO_PIXMAP
);
2114 return x_create_x_image_and_pixmap (f
, width
, height
, depth
, ximg
,
2115 !mask_p
? &img
->pixmap
: &img
->mask
);
2118 /* Put X image XIMG into image IMG on frame F, as a mask if and only
2119 if MASK_P. On X, this simply records XIMG on a member of IMG, so
2120 it can be put into the pixmap afterwards via image_sync_to_pixmaps.
2121 On the other platforms, it puts XIMG into the pixmap, then frees
2122 the X image and its buffer. */
2125 image_put_x_image (struct frame
*f
, struct image
*img
, XImagePtr ximg
,
2128 #ifdef HAVE_X_WINDOWS
2131 eassert (img
->ximg
== NULL
);
2136 eassert (img
->mask_img
== NULL
);
2137 img
->mask_img
= ximg
;
2140 x_put_x_image (f
, ximg
, !mask_p
? img
->pixmap
: img
->mask
,
2141 img
->width
, img
->height
);
2142 x_destroy_x_image (ximg
);
2146 #ifdef HAVE_X_WINDOWS
2147 /* Put the X images recorded in IMG on frame F into pixmaps, then free
2148 the X images and their buffers. */
2151 image_sync_to_pixmaps (struct frame
*f
, struct image
*img
)
2155 x_put_x_image (f
, img
->ximg
, img
->pixmap
, img
->width
, img
->height
);
2156 x_destroy_x_image (img
->ximg
);
2161 x_put_x_image (f
, img
->mask_img
, img
->mask
, img
->width
, img
->height
);
2162 x_destroy_x_image (img
->mask_img
);
2163 img
->mask_img
= NULL
;
2169 /* Create a memory device context for IMG on frame F. It stores the
2170 currently selected GDI object into *PREV for future restoration by
2171 image_unget_x_image_or_dc. */
2173 static XImagePtr_or_DC
2174 image_get_x_image_or_dc (struct frame
*f
, struct image
*img
, bool mask_p
,
2177 HDC frame_dc
= get_frame_dc (f
);
2178 XImagePtr_or_DC ximg
= CreateCompatibleDC (frame_dc
);
2180 release_frame_dc (f
, frame_dc
);
2181 *prev
= SelectObject (ximg
, !mask_p
? img
->pixmap
: img
->mask
);
2187 image_unget_x_image_or_dc (struct image
*img
, bool mask_p
,
2188 XImagePtr_or_DC ximg
, HGDIOBJ prev
)
2190 SelectObject (ximg
, prev
);
2193 #else /* !HAVE_NTGUI */
2194 /* Get the X image for IMG on frame F. The resulting X image data
2195 should be treated as read-only at least on X. */
2198 image_get_x_image (struct frame
*f
, struct image
*img
, bool mask_p
)
2200 #ifdef HAVE_X_WINDOWS
2201 XImagePtr ximg_in_img
= !mask_p
? img
->ximg
: img
->mask_img
;
2206 return XGetImage (FRAME_X_DISPLAY (f
), !mask_p
? img
->pixmap
: img
->mask
,
2207 0, 0, img
->width
, img
->height
, ~0, ZPixmap
);
2208 #elif defined (HAVE_NS)
2209 XImagePtr pixmap
= !mask_p
? img
->pixmap
: img
->mask
;
2211 ns_retain_object (pixmap
);
2217 image_unget_x_image (struct image
*img
, bool mask_p
, XImagePtr ximg
)
2219 #ifdef HAVE_X_WINDOWS
2220 XImagePtr ximg_in_img
= !mask_p
? img
->ximg
: img
->mask_img
;
2223 eassert (ximg
== ximg_in_img
);
2225 XDestroyImage (ximg
);
2226 #elif defined (HAVE_NS)
2227 ns_release_object (ximg
);
2230 #endif /* !HAVE_NTGUI */
2233 /***********************************************************************
2235 ***********************************************************************/
2237 /* Find image file FILE. Look in data-directory/images, then
2238 x-bitmap-file-path. Value is the encoded full name of the file
2239 found, or nil if not found. */
2242 x_find_image_file (Lisp_Object file
)
2244 Lisp_Object file_found
, search_path
;
2247 /* TODO I think this should use something like image-load-path
2248 instead. Unfortunately, that can contain non-string elements. */
2249 search_path
= Fcons (Fexpand_file_name (build_string ("images"),
2251 Vx_bitmap_file_path
);
2253 /* Try to find FILE in data-directory/images, then x-bitmap-file-path. */
2254 fd
= openp (search_path
, file
, Qnil
, &file_found
, Qnil
);
2260 file_found
= ENCODE_FILE (file_found
);
2269 /* Read FILE into memory. Value is a pointer to a buffer allocated
2270 with xmalloc holding FILE's contents. Value is null if an error
2271 occurred. *SIZE is set to the size of the file. */
2273 static unsigned char *
2274 slurp_file (char *file
, ptrdiff_t *size
)
2276 FILE *fp
= emacs_fopen (file
, "rb");
2277 unsigned char *buf
= NULL
;
2282 ptrdiff_t count
= SPECPDL_INDEX ();
2283 record_unwind_protect_ptr (fclose_unwind
, fp
);
2285 if (fstat (fileno (fp
), &st
) == 0
2286 && 0 <= st
.st_size
&& st
.st_size
< min (PTRDIFF_MAX
, SIZE_MAX
))
2288 /* Report an error if we read past the purported EOF.
2289 This can happen if the file grows as we read it. */
2290 ptrdiff_t buflen
= st
.st_size
;
2291 buf
= xmalloc (buflen
+ 1);
2292 if (fread (buf
, 1, buflen
+ 1, fp
) == buflen
)
2301 unbind_to (count
, Qnil
);
2309 /***********************************************************************
2311 ***********************************************************************/
2313 static bool xbm_load (struct frame
*f
, struct image
*img
);
2314 static bool xbm_image_p (Lisp_Object object
);
2315 static bool xbm_file_p (Lisp_Object
);
2318 /* Indices of image specification fields in xbm_format, below. */
2320 enum xbm_keyword_index
2338 /* Vector of image_keyword structures describing the format
2339 of valid XBM image specifications. */
2341 static const struct image_keyword xbm_format
[XBM_LAST
] =
2343 {":type", IMAGE_SYMBOL_VALUE
, 1},
2344 {":file", IMAGE_STRING_VALUE
, 0},
2345 {":width", IMAGE_POSITIVE_INTEGER_VALUE
, 0},
2346 {":height", IMAGE_POSITIVE_INTEGER_VALUE
, 0},
2347 {":data", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
2348 {":foreground", IMAGE_STRING_OR_NIL_VALUE
, 0},
2349 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0},
2350 {":ascent", IMAGE_ASCENT_VALUE
, 0},
2351 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
2352 {":relief", IMAGE_INTEGER_VALUE
, 0},
2353 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
2354 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
2355 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0}
2358 /* Structure describing the image type XBM. */
2360 static struct image_type xbm_type
=
2370 /* Tokens returned from xbm_scan. */
2379 /* Return true if OBJECT is a valid XBM-type image specification.
2380 A valid specification is a list starting with the symbol `image'
2381 The rest of the list is a property list which must contain an
2384 If the specification specifies a file to load, it must contain
2385 an entry `:file FILENAME' where FILENAME is a string.
2387 If the specification is for a bitmap loaded from memory it must
2388 contain `:width WIDTH', `:height HEIGHT', and `:data DATA', where
2389 WIDTH and HEIGHT are integers > 0. DATA may be:
2391 1. a string large enough to hold the bitmap data, i.e. it must
2392 have a size >= (WIDTH + 7) / 8 * HEIGHT
2394 2. a bool-vector of size >= WIDTH * HEIGHT
2396 3. a vector of strings or bool-vectors, one for each line of the
2399 4. a string containing an in-memory XBM file. WIDTH and HEIGHT
2400 may not be specified in this case because they are defined in the
2403 Both the file and data forms may contain the additional entries
2404 `:background COLOR' and `:foreground COLOR'. If not present,
2405 foreground and background of the frame on which the image is
2406 displayed is used. */
2409 xbm_image_p (Lisp_Object object
)
2411 struct image_keyword kw
[XBM_LAST
];
2413 memcpy (kw
, xbm_format
, sizeof kw
);
2414 if (!parse_image_spec (object
, kw
, XBM_LAST
, Qxbm
))
2417 eassert (EQ (kw
[XBM_TYPE
].value
, Qxbm
));
2419 if (kw
[XBM_FILE
].count
)
2421 if (kw
[XBM_WIDTH
].count
|| kw
[XBM_HEIGHT
].count
|| kw
[XBM_DATA
].count
)
2424 else if (kw
[XBM_DATA
].count
&& xbm_file_p (kw
[XBM_DATA
].value
))
2426 /* In-memory XBM file. */
2427 if (kw
[XBM_WIDTH
].count
|| kw
[XBM_HEIGHT
].count
|| kw
[XBM_FILE
].count
)
2435 /* Entries for `:width', `:height' and `:data' must be present. */
2436 if (!kw
[XBM_WIDTH
].count
2437 || !kw
[XBM_HEIGHT
].count
2438 || !kw
[XBM_DATA
].count
)
2441 data
= kw
[XBM_DATA
].value
;
2442 width
= XFASTINT (kw
[XBM_WIDTH
].value
);
2443 height
= XFASTINT (kw
[XBM_HEIGHT
].value
);
2445 /* Check type of data, and width and height against contents of
2451 /* Number of elements of the vector must be >= height. */
2452 if (ASIZE (data
) < height
)
2455 /* Each string or bool-vector in data must be large enough
2456 for one line of the image. */
2457 for (i
= 0; i
< height
; ++i
)
2459 Lisp_Object elt
= AREF (data
, i
);
2464 < (width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
)
2467 else if (BOOL_VECTOR_P (elt
))
2469 if (XBOOL_VECTOR (elt
)->size
< width
)
2476 else if (STRINGP (data
))
2479 < (width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
* height
)
2482 else if (BOOL_VECTOR_P (data
))
2484 if (XBOOL_VECTOR (data
)->size
/ height
< width
)
2495 /* Scan a bitmap file. FP is the stream to read from. Value is
2496 either an enumerator from enum xbm_token, or a character for a
2497 single-character token, or 0 at end of file. If scanning an
2498 identifier, store the lexeme of the identifier in SVAL. If
2499 scanning a number, store its value in *IVAL. */
2502 xbm_scan (unsigned char **s
, unsigned char *end
, char *sval
, int *ival
)
2508 /* Skip white space. */
2509 while (*s
< end
&& (c
= *(*s
)++, c_isspace (c
)))
2514 else if (c_isdigit (c
))
2516 int value
= 0, digit
;
2518 if (c
== '0' && *s
< end
)
2521 if (c
== 'x' || c
== 'X')
2528 else if (c
>= 'a' && c
<= 'f')
2529 digit
= c
- 'a' + 10;
2530 else if (c
>= 'A' && c
<= 'F')
2531 digit
= c
- 'A' + 10;
2534 value
= 16 * value
+ digit
;
2537 else if (c_isdigit (c
))
2541 && (c
= *(*s
)++, c_isdigit (c
)))
2542 value
= 8 * value
+ c
- '0';
2549 && (c
= *(*s
)++, c_isdigit (c
)))
2550 value
= 10 * value
+ c
- '0';
2558 else if (c_isalpha (c
) || c
== '_')
2562 && (c
= *(*s
)++, (c_isalnum (c
) || c
== '_')))
2569 else if (c
== '/' && **s
== '*')
2571 /* C-style comment. */
2573 while (**s
&& (**s
!= '*' || *(*s
+ 1) != '/'))
2587 /* Create a Windows bitmap from X bitmap data. */
2589 w32_create_pixmap_from_bitmap_data (int width
, int height
, char *data
)
2591 static unsigned char swap_nibble
[16]
2592 = { 0x0, 0x8, 0x4, 0xc, /* 0000 1000 0100 1100 */
2593 0x2, 0xa, 0x6, 0xe, /* 0010 1010 0110 1110 */
2594 0x1, 0x9, 0x5, 0xd, /* 0001 1001 0101 1101 */
2595 0x3, 0xb, 0x7, 0xf }; /* 0011 1011 0111 1111 */
2597 unsigned char *bits
, *p
;
2600 w1
= (width
+ 7) / 8; /* nb of 8bits elt in X bitmap */
2601 w2
= ((width
+ 15) / 16) * 2; /* nb of 16bits elt in W32 bitmap */
2602 bits
= alloca (height
* w2
);
2603 memset (bits
, 0, height
* w2
);
2604 for (i
= 0; i
< height
; i
++)
2607 for (j
= 0; j
< w1
; j
++)
2609 /* Bitswap XBM bytes to match how Windows does things. */
2610 unsigned char c
= *data
++;
2611 *p
++ = (unsigned char)((swap_nibble
[c
& 0xf] << 4)
2612 | (swap_nibble
[(c
>>4) & 0xf]));
2615 bmp
= CreateBitmap (width
, height
, 1, 1, (char *) bits
);
2621 convert_mono_to_color_image (struct frame
*f
, struct image
*img
,
2622 COLORREF foreground
, COLORREF background
)
2624 HDC hdc
, old_img_dc
, new_img_dc
;
2625 HGDIOBJ old_prev
, new_prev
;
2628 hdc
= get_frame_dc (f
);
2629 old_img_dc
= CreateCompatibleDC (hdc
);
2630 new_img_dc
= CreateCompatibleDC (hdc
);
2631 new_pixmap
= CreateCompatibleBitmap (hdc
, img
->width
, img
->height
);
2632 release_frame_dc (f
, hdc
);
2633 old_prev
= SelectObject (old_img_dc
, img
->pixmap
);
2634 new_prev
= SelectObject (new_img_dc
, new_pixmap
);
2635 /* Windows convention for mono bitmaps is black = background,
2636 white = foreground. */
2637 SetTextColor (new_img_dc
, background
);
2638 SetBkColor (new_img_dc
, foreground
);
2640 BitBlt (new_img_dc
, 0, 0, img
->width
, img
->height
, old_img_dc
,
2643 SelectObject (old_img_dc
, old_prev
);
2644 SelectObject (new_img_dc
, new_prev
);
2645 DeleteDC (old_img_dc
);
2646 DeleteDC (new_img_dc
);
2647 DeleteObject (img
->pixmap
);
2648 if (new_pixmap
== 0)
2649 fprintf (stderr
, "Failed to convert image to color.\n");
2651 img
->pixmap
= new_pixmap
;
2654 #define XBM_BIT_SHUFFLE(b) (~(b))
2658 #define XBM_BIT_SHUFFLE(b) (b)
2660 #endif /* HAVE_NTGUI */
2664 Create_Pixmap_From_Bitmap_Data (struct frame
*f
, struct image
*img
, char *data
,
2665 RGB_PIXEL_COLOR fg
, RGB_PIXEL_COLOR bg
,
2666 bool non_default_colors
)
2670 = w32_create_pixmap_from_bitmap_data (img
->width
, img
->height
, data
);
2672 /* If colors were specified, transfer the bitmap to a color one. */
2673 if (non_default_colors
)
2674 convert_mono_to_color_image (f
, img
, fg
, bg
);
2676 #elif defined (HAVE_NS)
2677 img
->pixmap
= ns_image_from_XBM (data
, img
->width
, img
->height
);
2681 (x_check_image_size (0, img
->width
, img
->height
)
2682 ? XCreatePixmapFromBitmapData (FRAME_X_DISPLAY (f
),
2685 img
->width
, img
->height
,
2687 DefaultDepthOfScreen (FRAME_X_SCREEN (f
)))
2689 #endif /* !HAVE_NTGUI && !HAVE_NS */
2694 /* Replacement for XReadBitmapFileData which isn't available under old
2695 X versions. CONTENTS is a pointer to a buffer to parse; END is the
2696 buffer's end. Set *WIDTH and *HEIGHT to the width and height of
2697 the image. Return in *DATA the bitmap data allocated with xmalloc.
2698 Value is true if successful. DATA null means just test if
2699 CONTENTS looks like an in-memory XBM file. If INHIBIT_IMAGE_ERROR,
2700 inhibit the call to image_error when the image size is invalid (the
2701 bitmap remains unread). */
2704 xbm_read_bitmap_data (struct frame
*f
, unsigned char *contents
, unsigned char *end
,
2705 int *width
, int *height
, char **data
,
2706 bool inhibit_image_error
)
2708 unsigned char *s
= contents
;
2709 char buffer
[BUFSIZ
];
2712 int bytes_per_line
, i
, nbytes
;
2718 LA1 = xbm_scan (&s, end, buffer, &value)
2720 #define expect(TOKEN) \
2721 if (LA1 != (TOKEN)) \
2726 #define expect_ident(IDENT) \
2727 if (LA1 == XBM_TK_IDENT && strcmp (buffer, (IDENT)) == 0) \
2732 *width
= *height
= -1;
2735 LA1
= xbm_scan (&s
, end
, buffer
, &value
);
2737 /* Parse defines for width, height and hot-spots. */
2741 expect_ident ("define");
2742 expect (XBM_TK_IDENT
);
2744 if (LA1
== XBM_TK_NUMBER
)
2746 char *q
= strrchr (buffer
, '_');
2747 q
= q
? q
+ 1 : buffer
;
2748 if (strcmp (q
, "width") == 0)
2750 else if (strcmp (q
, "height") == 0)
2753 expect (XBM_TK_NUMBER
);
2756 if (!check_image_size (f
, *width
, *height
))
2758 if (!inhibit_image_error
)
2759 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
2762 else if (data
== NULL
)
2765 /* Parse bits. Must start with `static'. */
2766 expect_ident ("static");
2767 if (LA1
== XBM_TK_IDENT
)
2769 if (strcmp (buffer
, "unsigned") == 0)
2772 expect_ident ("char");
2774 else if (strcmp (buffer
, "short") == 0)
2778 if (*width
% 16 && *width
% 16 < 9)
2781 else if (strcmp (buffer
, "char") == 0)
2789 expect (XBM_TK_IDENT
);
2795 if (! x_check_image_size (0, *width
, *height
))
2797 if (!inhibit_image_error
)
2798 image_error ("Image too large (%dx%d)",
2799 make_number (*width
), make_number (*height
));
2802 bytes_per_line
= (*width
+ 7) / 8 + padding_p
;
2803 nbytes
= bytes_per_line
* *height
;
2804 p
= *data
= xmalloc (nbytes
);
2808 for (i
= 0; i
< nbytes
; i
+= 2)
2811 expect (XBM_TK_NUMBER
);
2813 *p
++ = XBM_BIT_SHUFFLE (val
);
2814 if (!padding_p
|| ((i
+ 2) % bytes_per_line
))
2815 *p
++ = XBM_BIT_SHUFFLE (value
>> 8);
2817 if (LA1
== ',' || LA1
== '}')
2825 for (i
= 0; i
< nbytes
; ++i
)
2828 expect (XBM_TK_NUMBER
);
2830 *p
++ = XBM_BIT_SHUFFLE (val
);
2832 if (LA1
== ',' || LA1
== '}')
2857 /* Load XBM image IMG which will be displayed on frame F from buffer
2858 CONTENTS. END is the end of the buffer. Value is true if
2862 xbm_load_image (struct frame
*f
, struct image
*img
, unsigned char *contents
,
2869 rc
= xbm_read_bitmap_data (f
, contents
, end
, &img
->width
, &img
->height
,
2873 unsigned long foreground
= FRAME_FOREGROUND_PIXEL (f
);
2874 unsigned long background
= FRAME_BACKGROUND_PIXEL (f
);
2875 bool non_default_colors
= 0;
2878 eassert (img
->width
> 0 && img
->height
> 0);
2880 /* Get foreground and background colors, maybe allocate colors. */
2881 value
= image_spec_value (img
->spec
, QCforeground
, NULL
);
2884 foreground
= x_alloc_image_color (f
, img
, value
, foreground
);
2885 non_default_colors
= 1;
2887 value
= image_spec_value (img
->spec
, QCbackground
, NULL
);
2890 background
= x_alloc_image_color (f
, img
, value
, background
);
2891 img
->background
= background
;
2892 img
->background_valid
= 1;
2893 non_default_colors
= 1;
2896 Create_Pixmap_From_Bitmap_Data (f
, img
, data
,
2897 foreground
, background
,
2898 non_default_colors
);
2901 if (img
->pixmap
== NO_PIXMAP
)
2903 x_clear_image (f
, img
);
2904 image_error ("Unable to create X pixmap for `%s'", img
->spec
, Qnil
);
2910 image_error ("Error loading XBM image `%s'", img
->spec
, Qnil
);
2916 /* Value is true if DATA looks like an in-memory XBM file. */
2919 xbm_file_p (Lisp_Object data
)
2922 return (STRINGP (data
)
2923 && xbm_read_bitmap_data (NULL
, SDATA (data
),
2924 (SDATA (data
) + SBYTES (data
)),
2929 /* Fill image IMG which is used on frame F with pixmap data. Value is
2930 true if successful. */
2933 xbm_load (struct frame
*f
, struct image
*img
)
2936 Lisp_Object file_name
;
2938 eassert (xbm_image_p (img
->spec
));
2940 /* If IMG->spec specifies a file name, create a non-file spec from it. */
2941 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
2942 if (STRINGP (file_name
))
2945 unsigned char *contents
;
2948 file
= x_find_image_file (file_name
);
2949 if (!STRINGP (file
))
2951 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
2955 contents
= slurp_file (SSDATA (file
), &size
);
2956 if (contents
== NULL
)
2958 image_error ("Error loading XBM image `%s'", img
->spec
, Qnil
);
2962 success_p
= xbm_load_image (f
, img
, contents
, contents
+ size
);
2967 struct image_keyword fmt
[XBM_LAST
];
2969 unsigned long foreground
= FRAME_FOREGROUND_PIXEL (f
);
2970 unsigned long background
= FRAME_BACKGROUND_PIXEL (f
);
2971 bool non_default_colors
= 0;
2974 bool in_memory_file_p
= 0;
2976 /* See if data looks like an in-memory XBM file. */
2977 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
2978 in_memory_file_p
= xbm_file_p (data
);
2980 /* Parse the image specification. */
2981 memcpy (fmt
, xbm_format
, sizeof fmt
);
2982 parsed_p
= parse_image_spec (img
->spec
, fmt
, XBM_LAST
, Qxbm
);
2985 /* Get specified width, and height. */
2986 if (!in_memory_file_p
)
2988 img
->width
= XFASTINT (fmt
[XBM_WIDTH
].value
);
2989 img
->height
= XFASTINT (fmt
[XBM_HEIGHT
].value
);
2990 eassert (img
->width
> 0 && img
->height
> 0);
2991 if (!check_image_size (f
, img
->width
, img
->height
))
2993 image_error ("Invalid image size (see `max-image-size')",
2999 /* Get foreground and background colors, maybe allocate colors. */
3000 if (fmt
[XBM_FOREGROUND
].count
3001 && STRINGP (fmt
[XBM_FOREGROUND
].value
))
3003 foreground
= x_alloc_image_color (f
, img
, fmt
[XBM_FOREGROUND
].value
,
3005 non_default_colors
= 1;
3008 if (fmt
[XBM_BACKGROUND
].count
3009 && STRINGP (fmt
[XBM_BACKGROUND
].value
))
3011 background
= x_alloc_image_color (f
, img
, fmt
[XBM_BACKGROUND
].value
,
3013 non_default_colors
= 1;
3016 if (in_memory_file_p
)
3017 success_p
= xbm_load_image (f
, img
, SDATA (data
),
3026 int nbytes
= (img
->width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
;
3028 p
= bits
= alloca (nbytes
* img
->height
);
3029 for (i
= 0; i
< img
->height
; ++i
, p
+= nbytes
)
3031 Lisp_Object line
= AREF (data
, i
);
3033 memcpy (p
, SDATA (line
), nbytes
);
3035 memcpy (p
, XBOOL_VECTOR (line
)->data
, nbytes
);
3038 else if (STRINGP (data
))
3039 bits
= SSDATA (data
);
3041 bits
= (char *) XBOOL_VECTOR (data
)->data
;
3047 /* Windows mono bitmaps are reversed compared with X. */
3048 invertedBits
= bits
;
3049 nbytes
= (img
->width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
3051 bits
= alloca (nbytes
);
3052 for (i
= 0; i
< nbytes
; i
++)
3053 bits
[i
] = XBM_BIT_SHUFFLE (invertedBits
[i
]);
3056 /* Create the pixmap. */
3058 if (x_check_image_size (0, img
->width
, img
->height
))
3059 Create_Pixmap_From_Bitmap_Data (f
, img
, bits
,
3060 foreground
, background
,
3061 non_default_colors
);
3063 img
->pixmap
= NO_PIXMAP
;
3069 image_error ("Unable to create pixmap for XBM image `%s'",
3071 x_clear_image (f
, img
);
3081 /***********************************************************************
3083 ***********************************************************************/
3085 #if defined (HAVE_XPM) || defined (HAVE_NS)
3087 static bool xpm_image_p (Lisp_Object object
);
3088 static bool xpm_load (struct frame
*f
, struct image
*img
);
3090 #endif /* HAVE_XPM || HAVE_NS */
3094 /* Indicate to xpm.h that we don't have Xlib. */
3096 /* simx.h in xpm defines XColor and XImage differently than Emacs. */
3097 /* It also defines Display the same way as Emacs, but gcc 3.3 still barfs. */
3098 #define XColor xpm_XColor
3099 #define XImage xpm_XImage
3100 #define Display xpm_Display
3101 #define PIXEL_ALREADY_TYPEDEFED
3102 #include "X11/xpm.h"
3107 #undef PIXEL_ALREADY_TYPEDEFED
3109 #include "X11/xpm.h"
3110 #endif /* HAVE_NTGUI */
3111 #endif /* HAVE_XPM */
3113 #if defined (HAVE_XPM) || defined (HAVE_NS)
3114 /* The symbol `xpm' identifying XPM-format images. */
3116 static Lisp_Object Qxpm
;
3118 /* Indices of image specification fields in xpm_format, below. */
3120 enum xpm_keyword_index
3136 /* Vector of image_keyword structures describing the format
3137 of valid XPM image specifications. */
3139 static const struct image_keyword xpm_format
[XPM_LAST
] =
3141 {":type", IMAGE_SYMBOL_VALUE
, 1},
3142 {":file", IMAGE_STRING_VALUE
, 0},
3143 {":data", IMAGE_STRING_VALUE
, 0},
3144 {":ascent", IMAGE_ASCENT_VALUE
, 0},
3145 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
3146 {":relief", IMAGE_INTEGER_VALUE
, 0},
3147 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3148 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3149 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3150 {":color-symbols", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3151 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
3154 #if defined HAVE_NTGUI && defined WINDOWSNT
3155 static bool init_xpm_functions (void);
3157 #define init_xpm_functions NULL
3160 /* Structure describing the image type XPM. */
3162 static struct image_type xpm_type
=
3172 #ifdef HAVE_X_WINDOWS
3174 /* Define ALLOC_XPM_COLORS if we can use Emacs' own color allocation
3175 functions for allocating image colors. Our own functions handle
3176 color allocation failures more gracefully than the ones on the XPM
3179 #if defined XpmAllocColor && defined XpmFreeColors && defined XpmColorClosure
3180 #define ALLOC_XPM_COLORS
3182 #endif /* HAVE_X_WINDOWS */
3184 #ifdef ALLOC_XPM_COLORS
3186 static struct xpm_cached_color
*xpm_cache_color (struct frame
*, char *,
3189 /* An entry in a hash table used to cache color definitions of named
3190 colors. This cache is necessary to speed up XPM image loading in
3191 case we do color allocations ourselves. Without it, we would need
3192 a call to XParseColor per pixel in the image. */
3194 struct xpm_cached_color
3196 /* Next in collision chain. */
3197 struct xpm_cached_color
*next
;
3199 /* Color definition (RGB and pixel color). */
3203 char name
[FLEXIBLE_ARRAY_MEMBER
];
3206 /* The hash table used for the color cache, and its bucket vector
3209 #define XPM_COLOR_CACHE_BUCKETS 1001
3210 static struct xpm_cached_color
**xpm_color_cache
;
3212 /* Initialize the color cache. */
3215 xpm_init_color_cache (struct frame
*f
, XpmAttributes
*attrs
)
3217 size_t nbytes
= XPM_COLOR_CACHE_BUCKETS
* sizeof *xpm_color_cache
;
3218 xpm_color_cache
= xzalloc (nbytes
);
3219 init_color_table ();
3221 if (attrs
->valuemask
& XpmColorSymbols
)
3226 for (i
= 0; i
< attrs
->numsymbols
; ++i
)
3227 if (XParseColor (FRAME_X_DISPLAY (f
), FRAME_X_COLORMAP (f
),
3228 attrs
->colorsymbols
[i
].value
, &color
))
3230 color
.pixel
= lookup_rgb_color (f
, color
.red
, color
.green
,
3232 xpm_cache_color (f
, attrs
->colorsymbols
[i
].name
, &color
, -1);
3237 /* Free the color cache. */
3240 xpm_free_color_cache (void)
3242 struct xpm_cached_color
*p
, *next
;
3245 for (i
= 0; i
< XPM_COLOR_CACHE_BUCKETS
; ++i
)
3246 for (p
= xpm_color_cache
[i
]; p
; p
= next
)
3252 xfree (xpm_color_cache
);
3253 xpm_color_cache
= NULL
;
3254 free_color_table ();
3257 /* Return the bucket index for color named COLOR_NAME in the color
3261 xpm_color_bucket (char *color_name
)
3263 EMACS_UINT hash
= hash_string (color_name
, strlen (color_name
));
3264 return hash
% XPM_COLOR_CACHE_BUCKETS
;
3268 /* On frame F, cache values COLOR for color with name COLOR_NAME.
3269 BUCKET, if >= 0, is a precomputed bucket index. Value is the cache
3272 static struct xpm_cached_color
*
3273 xpm_cache_color (struct frame
*f
, char *color_name
, XColor
*color
, int bucket
)
3276 struct xpm_cached_color
*p
;
3279 bucket
= xpm_color_bucket (color_name
);
3281 nbytes
= offsetof (struct xpm_cached_color
, name
) + strlen (color_name
) + 1;
3282 p
= xmalloc (nbytes
);
3283 strcpy (p
->name
, color_name
);
3285 p
->next
= xpm_color_cache
[bucket
];
3286 xpm_color_cache
[bucket
] = p
;
3290 /* Look up color COLOR_NAME for frame F in the color cache. If found,
3291 return the cached definition in *COLOR. Otherwise, make a new
3292 entry in the cache and allocate the color. Value is false if color
3293 allocation failed. */
3296 xpm_lookup_color (struct frame
*f
, char *color_name
, XColor
*color
)
3298 struct xpm_cached_color
*p
;
3299 int h
= xpm_color_bucket (color_name
);
3301 for (p
= xpm_color_cache
[h
]; p
; p
= p
->next
)
3302 if (strcmp (p
->name
, color_name
) == 0)
3307 else if (XParseColor (FRAME_X_DISPLAY (f
), FRAME_X_COLORMAP (f
),
3310 color
->pixel
= lookup_rgb_color (f
, color
->red
, color
->green
,
3312 p
= xpm_cache_color (f
, color_name
, color
, h
);
3314 /* You get `opaque' at least from ImageMagick converting pbm to xpm
3315 with transparency, and it's useful. */
3316 else if (strcmp ("opaque", color_name
) == 0)
3318 memset (color
, 0, sizeof (XColor
)); /* Is this necessary/correct? */
3319 color
->pixel
= FRAME_FOREGROUND_PIXEL (f
);
3320 p
= xpm_cache_color (f
, color_name
, color
, h
);
3327 /* Callback for allocating color COLOR_NAME. Called from the XPM lib.
3328 CLOSURE is a pointer to the frame on which we allocate the
3329 color. Return in *COLOR the allocated color. Value is non-zero
3333 xpm_alloc_color (Display
*dpy
, Colormap cmap
, char *color_name
, XColor
*color
,
3336 return xpm_lookup_color (closure
, color_name
, color
);
3340 /* Callback for freeing NPIXELS colors contained in PIXELS. CLOSURE
3341 is a pointer to the frame on which we allocate the color. Value is
3342 non-zero if successful. */
3345 xpm_free_colors (Display
*dpy
, Colormap cmap
, Pixel
*pixels
, int npixels
, void *closure
)
3350 #endif /* ALLOC_XPM_COLORS */
3355 /* XPM library details. */
3357 DEF_IMGLIB_FN (void, XpmFreeAttributes
, (XpmAttributes
*));
3358 DEF_IMGLIB_FN (int, XpmCreateImageFromBuffer
, (Display
*, char *, xpm_XImage
**,
3359 xpm_XImage
**, XpmAttributes
*));
3360 DEF_IMGLIB_FN (int, XpmReadFileToImage
, (Display
*, char *, xpm_XImage
**,
3361 xpm_XImage
**, XpmAttributes
*));
3362 DEF_IMGLIB_FN (void, XImageFree
, (xpm_XImage
*));
3365 init_xpm_functions (void)
3369 if (!(library
= w32_delayed_load (Qxpm
)))
3372 LOAD_IMGLIB_FN (library
, XpmFreeAttributes
);
3373 LOAD_IMGLIB_FN (library
, XpmCreateImageFromBuffer
);
3374 LOAD_IMGLIB_FN (library
, XpmReadFileToImage
);
3375 LOAD_IMGLIB_FN (library
, XImageFree
);
3379 #endif /* WINDOWSNT */
3381 #if defined HAVE_NTGUI && !defined WINDOWSNT
3382 /* Glue for code below */
3383 #define fn_XpmReadFileToImage XpmReadFileToImage
3384 #define fn_XpmCreateImageFromBuffer XpmCreateImageFromBuffer
3385 #define fn_XImageFree XImageFree
3386 #define fn_XpmFreeAttributes XpmFreeAttributes
3387 #endif /* HAVE_NTGUI && !WINDOWSNT */
3389 /* Value is true if COLOR_SYMBOLS is a valid color symbols list
3390 for XPM images. Such a list must consist of conses whose car and
3394 xpm_valid_color_symbols_p (Lisp_Object color_symbols
)
3396 while (CONSP (color_symbols
))
3398 Lisp_Object sym
= XCAR (color_symbols
);
3400 || !STRINGP (XCAR (sym
))
3401 || !STRINGP (XCDR (sym
)))
3403 color_symbols
= XCDR (color_symbols
);
3406 return NILP (color_symbols
);
3410 /* Value is true if OBJECT is a valid XPM image specification. */
3413 xpm_image_p (Lisp_Object object
)
3415 struct image_keyword fmt
[XPM_LAST
];
3416 memcpy (fmt
, xpm_format
, sizeof fmt
);
3417 return (parse_image_spec (object
, fmt
, XPM_LAST
, Qxpm
)
3418 /* Either `:file' or `:data' must be present. */
3419 && fmt
[XPM_FILE
].count
+ fmt
[XPM_DATA
].count
== 1
3420 /* Either no `:color-symbols' or it's a list of conses
3421 whose car and cdr are strings. */
3422 && (fmt
[XPM_COLOR_SYMBOLS
].count
== 0
3423 || xpm_valid_color_symbols_p (fmt
[XPM_COLOR_SYMBOLS
].value
)));
3426 #endif /* HAVE_XPM || HAVE_NS */
3428 #if defined HAVE_XPM && defined HAVE_X_WINDOWS && !defined USE_GTK
3430 x_create_bitmap_from_xpm_data (struct frame
*f
, const char **bits
)
3432 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
3435 XpmAttributes attrs
;
3436 Pixmap bitmap
, mask
;
3438 memset (&attrs
, 0, sizeof attrs
);
3440 attrs
.visual
= FRAME_X_VISUAL (f
);
3441 attrs
.colormap
= FRAME_X_COLORMAP (f
);
3442 attrs
.valuemask
|= XpmVisual
;
3443 attrs
.valuemask
|= XpmColormap
;
3445 rc
= XpmCreatePixmapFromData (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
3446 (char **) bits
, &bitmap
, &mask
, &attrs
);
3447 if (rc
!= XpmSuccess
)
3449 XpmFreeAttributes (&attrs
);
3453 id
= x_allocate_bitmap_record (f
);
3454 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
3455 dpyinfo
->bitmaps
[id
- 1].have_mask
= 1;
3456 dpyinfo
->bitmaps
[id
- 1].mask
= mask
;
3457 dpyinfo
->bitmaps
[id
- 1].file
= NULL
;
3458 dpyinfo
->bitmaps
[id
- 1].height
= attrs
.height
;
3459 dpyinfo
->bitmaps
[id
- 1].width
= attrs
.width
;
3460 dpyinfo
->bitmaps
[id
- 1].depth
= attrs
.depth
;
3461 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
3463 XpmFreeAttributes (&attrs
);
3466 #endif /* defined (HAVE_XPM) && defined (HAVE_X_WINDOWS) */
3468 /* Load image IMG which will be displayed on frame F. Value is
3469 true if successful. */
3474 xpm_load (struct frame
*f
, struct image
*img
)
3477 XpmAttributes attrs
;
3478 Lisp_Object specified_file
, color_symbols
;
3481 xpm_XImage
* xpm_image
= NULL
, * xpm_mask
= NULL
;
3482 #endif /* HAVE_NTGUI */
3484 /* Configure the XPM lib. Use the visual of frame F. Allocate
3485 close colors. Return colors allocated. */
3486 memset (&attrs
, 0, sizeof attrs
);
3489 attrs
.visual
= FRAME_X_VISUAL (f
);
3490 attrs
.colormap
= FRAME_X_COLORMAP (f
);
3491 attrs
.valuemask
|= XpmVisual
;
3492 attrs
.valuemask
|= XpmColormap
;
3493 #endif /* HAVE_NTGUI */
3495 #ifdef ALLOC_XPM_COLORS
3496 /* Allocate colors with our own functions which handle
3497 failing color allocation more gracefully. */
3498 attrs
.color_closure
= f
;
3499 attrs
.alloc_color
= xpm_alloc_color
;
3500 attrs
.free_colors
= xpm_free_colors
;
3501 attrs
.valuemask
|= XpmAllocColor
| XpmFreeColors
| XpmColorClosure
;
3502 #else /* not ALLOC_XPM_COLORS */
3503 /* Let the XPM lib allocate colors. */
3504 attrs
.valuemask
|= XpmReturnAllocPixels
;
3505 #ifdef XpmAllocCloseColors
3506 attrs
.alloc_close_colors
= 1;
3507 attrs
.valuemask
|= XpmAllocCloseColors
;
3508 #else /* not XpmAllocCloseColors */
3509 attrs
.closeness
= 600;
3510 attrs
.valuemask
|= XpmCloseness
;
3511 #endif /* not XpmAllocCloseColors */
3512 #endif /* ALLOC_XPM_COLORS */
3514 /* If image specification contains symbolic color definitions, add
3515 these to `attrs'. */
3516 color_symbols
= image_spec_value (img
->spec
, QCcolor_symbols
, NULL
);
3517 if (CONSP (color_symbols
))
3520 XpmColorSymbol
*xpm_syms
;
3523 attrs
.valuemask
|= XpmColorSymbols
;
3525 /* Count number of symbols. */
3526 attrs
.numsymbols
= 0;
3527 for (tail
= color_symbols
; CONSP (tail
); tail
= XCDR (tail
))
3530 /* Allocate an XpmColorSymbol array. */
3531 size
= attrs
.numsymbols
* sizeof *xpm_syms
;
3532 xpm_syms
= alloca (size
);
3533 memset (xpm_syms
, 0, size
);
3534 attrs
.colorsymbols
= xpm_syms
;
3536 /* Fill the color symbol array. */
3537 for (tail
= color_symbols
, i
= 0;
3539 ++i
, tail
= XCDR (tail
))
3543 char *empty_string
= (char *) "";
3545 if (!CONSP (XCAR (tail
)))
3547 xpm_syms
[i
].name
= empty_string
;
3548 xpm_syms
[i
].value
= empty_string
;
3551 name
= XCAR (XCAR (tail
));
3552 color
= XCDR (XCAR (tail
));
3555 xpm_syms
[i
].name
= alloca (SCHARS (name
) + 1);
3556 strcpy (xpm_syms
[i
].name
, SSDATA (name
));
3559 xpm_syms
[i
].name
= empty_string
;
3560 if (STRINGP (color
))
3562 xpm_syms
[i
].value
= alloca (SCHARS (color
) + 1);
3563 strcpy (xpm_syms
[i
].value
, SSDATA (color
));
3566 xpm_syms
[i
].value
= empty_string
;
3570 /* Create a pixmap for the image, either from a file, or from a
3571 string buffer containing data in the same format as an XPM file. */
3572 #ifdef ALLOC_XPM_COLORS
3573 xpm_init_color_cache (f
, &attrs
);
3576 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
3580 HDC frame_dc
= get_frame_dc (f
);
3581 hdc
= CreateCompatibleDC (frame_dc
);
3582 release_frame_dc (f
, frame_dc
);
3584 #endif /* HAVE_NTGUI */
3586 if (STRINGP (specified_file
))
3588 Lisp_Object file
= x_find_image_file (specified_file
);
3589 if (!STRINGP (file
))
3591 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
3592 #ifdef ALLOC_XPM_COLORS
3593 xpm_free_color_cache ();
3599 /* XpmReadFileToPixmap is not available in the Windows port of
3600 libxpm. But XpmReadFileToImage almost does what we want. */
3601 rc
= fn_XpmReadFileToImage (&hdc
, SDATA (file
),
3602 &xpm_image
, &xpm_mask
,
3605 rc
= XpmReadFileToImage (FRAME_X_DISPLAY (f
), SSDATA (file
),
3606 &img
->ximg
, &img
->mask_img
,
3608 #endif /* HAVE_NTGUI */
3612 Lisp_Object buffer
= image_spec_value (img
->spec
, QCdata
, NULL
);
3613 if (!STRINGP (buffer
))
3615 image_error ("Invalid image data `%s'", buffer
, Qnil
);
3616 #ifdef ALLOC_XPM_COLORS
3617 xpm_free_color_cache ();
3622 /* XpmCreatePixmapFromBuffer is not available in the Windows port
3623 of libxpm. But XpmCreateImageFromBuffer almost does what we want. */
3624 rc
= fn_XpmCreateImageFromBuffer (&hdc
, SDATA (buffer
),
3625 &xpm_image
, &xpm_mask
,
3628 rc
= XpmCreateImageFromBuffer (FRAME_X_DISPLAY (f
), SSDATA (buffer
),
3629 &img
->ximg
, &img
->mask_img
,
3631 #endif /* HAVE_NTGUI */
3634 #ifdef HAVE_X_WINDOWS
3635 if (rc
== XpmSuccess
)
3637 img
->pixmap
= XCreatePixmap (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
3638 img
->ximg
->width
, img
->ximg
->height
,
3640 if (img
->pixmap
== NO_PIXMAP
)
3642 x_clear_image (f
, img
);
3645 else if (img
->mask_img
)
3647 img
->mask
= XCreatePixmap (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
3648 img
->mask_img
->width
,
3649 img
->mask_img
->height
,
3650 img
->mask_img
->depth
);
3651 if (img
->mask
== NO_PIXMAP
)
3653 x_clear_image (f
, img
);
3660 if (rc
== XpmSuccess
)
3662 #if defined (COLOR_TABLE_SUPPORT) && defined (ALLOC_XPM_COLORS)
3663 img
->colors
= colors_in_color_table (&img
->ncolors
);
3664 #else /* not ALLOC_XPM_COLORS */
3668 /* W32 XPM uses XImage to wrap what W32 Emacs calls a Pixmap,
3669 plus some duplicate attributes. */
3670 if (xpm_image
&& xpm_image
->bitmap
)
3672 img
->pixmap
= xpm_image
->bitmap
;
3673 /* XImageFree in libXpm frees XImage struct without destroying
3674 the bitmap, which is what we want. */
3675 fn_XImageFree (xpm_image
);
3677 if (xpm_mask
&& xpm_mask
->bitmap
)
3679 /* The mask appears to be inverted compared with what we expect.
3680 TODO: invert our expectations. See other places where we
3681 have to invert bits because our idea of masks is backwards. */
3683 old_obj
= SelectObject (hdc
, xpm_mask
->bitmap
);
3685 PatBlt (hdc
, 0, 0, xpm_mask
->width
, xpm_mask
->height
, DSTINVERT
);
3686 SelectObject (hdc
, old_obj
);
3688 img
->mask
= xpm_mask
->bitmap
;
3689 fn_XImageFree (xpm_mask
);
3694 #endif /* HAVE_NTGUI */
3696 /* Remember allocated colors. */
3697 img
->colors
= xnmalloc (attrs
.nalloc_pixels
, sizeof *img
->colors
);
3698 img
->ncolors
= attrs
.nalloc_pixels
;
3699 for (i
= 0; i
< attrs
.nalloc_pixels
; ++i
)
3701 img
->colors
[i
] = attrs
.alloc_pixels
[i
];
3702 #ifdef DEBUG_X_COLORS
3703 register_color (img
->colors
[i
]);
3706 #endif /* not ALLOC_XPM_COLORS */
3708 img
->width
= attrs
.width
;
3709 img
->height
= attrs
.height
;
3710 eassert (img
->width
> 0 && img
->height
> 0);
3712 /* The call to XpmFreeAttributes below frees attrs.alloc_pixels. */
3714 fn_XpmFreeAttributes (&attrs
);
3716 XpmFreeAttributes (&attrs
);
3717 #endif /* HAVE_NTGUI */
3719 #ifdef HAVE_X_WINDOWS
3720 /* Maybe fill in the background field while we have ximg handy. */
3721 IMAGE_BACKGROUND (img
, f
, img
->ximg
);
3723 /* Fill in the background_transparent field while we have the
3725 image_background_transparent (img
, f
, img
->mask_img
);
3732 #endif /* HAVE_NTGUI */
3737 image_error ("Error opening XPM file (%s)", img
->spec
, Qnil
);
3740 case XpmFileInvalid
:
3741 image_error ("Invalid XPM file (%s)", img
->spec
, Qnil
);
3745 image_error ("Out of memory (%s)", img
->spec
, Qnil
);
3748 case XpmColorFailed
:
3749 image_error ("Color allocation error (%s)", img
->spec
, Qnil
);
3753 image_error ("Unknown error (%s)", img
->spec
, Qnil
);
3758 #ifdef ALLOC_XPM_COLORS
3759 xpm_free_color_cache ();
3761 return rc
== XpmSuccess
;
3764 #endif /* HAVE_XPM */
3766 #if defined (HAVE_NS) && !defined (HAVE_XPM)
3768 /* XPM support functions for NS where libxpm is not available.
3769 Only XPM version 3 (without any extensions) is supported. */
3771 static void xpm_put_color_table_v (Lisp_Object
, const unsigned char *,
3773 static Lisp_Object
xpm_get_color_table_v (Lisp_Object
,
3774 const unsigned char *, int);
3775 static void xpm_put_color_table_h (Lisp_Object
, const unsigned char *,
3777 static Lisp_Object
xpm_get_color_table_h (Lisp_Object
,
3778 const unsigned char *, int);
3780 /* Tokens returned from xpm_scan. */
3789 /* Scan an XPM data and return a character (< 256) or a token defined
3790 by enum xpm_token above. *S and END are the start (inclusive) and
3791 the end (exclusive) addresses of the data, respectively. Advance
3792 *S while scanning. If token is either XPM_TK_IDENT or
3793 XPM_TK_STRING, *BEG and *LEN are set to the start address and the
3794 length of the corresponding token, respectively. */
3797 xpm_scan (const unsigned char **s
,
3798 const unsigned char *end
,
3799 const unsigned char **beg
,
3806 /* Skip white-space. */
3807 while (*s
< end
&& (c
= *(*s
)++, c_isspace (c
)))
3810 /* gnus-pointer.xpm uses '-' in its identifier.
3811 sb-dir-plus.xpm uses '+' in its identifier. */
3812 if (c_isalpha (c
) || c
== '_' || c
== '-' || c
== '+')
3816 && (c
= **s
, c_isalnum (c
)
3817 || c
== '_' || c
== '-' || c
== '+'))
3820 return XPM_TK_IDENT
;
3825 while (*s
< end
&& **s
!= '"')
3830 return XPM_TK_STRING
;
3834 if (*s
< end
&& **s
== '*')
3836 /* C-style comment. */
3840 while (*s
< end
&& *(*s
)++ != '*')
3843 while (*s
< end
&& **s
!= '/');
3857 /* Functions for color table lookup in XPM data. A key is a string
3858 specifying the color of each pixel in XPM data. A value is either
3859 an integer that specifies a pixel color, Qt that specifies
3860 transparency, or Qnil for the unspecified color. If the length of
3861 the key string is one, a vector is used as a table. Otherwise, a
3862 hash table is used. */
3865 xpm_make_color_table_v (void (**put_func
) (Lisp_Object
,
3866 const unsigned char *,
3869 Lisp_Object (**get_func
) (Lisp_Object
,
3870 const unsigned char *,
3873 *put_func
= xpm_put_color_table_v
;
3874 *get_func
= xpm_get_color_table_v
;
3875 return Fmake_vector (make_number (256), Qnil
);
3879 xpm_put_color_table_v (Lisp_Object color_table
,
3880 const unsigned char *chars_start
,
3884 ASET (color_table
, *chars_start
, color
);
3888 xpm_get_color_table_v (Lisp_Object color_table
,
3889 const unsigned char *chars_start
,
3892 return AREF (color_table
, *chars_start
);
3896 xpm_make_color_table_h (void (**put_func
) (Lisp_Object
,
3897 const unsigned char *,
3900 Lisp_Object (**get_func
) (Lisp_Object
,
3901 const unsigned char *,
3904 *put_func
= xpm_put_color_table_h
;
3905 *get_func
= xpm_get_color_table_h
;
3906 return make_hash_table (hashtest_equal
, make_number (DEFAULT_HASH_SIZE
),
3907 make_float (DEFAULT_REHASH_SIZE
),
3908 make_float (DEFAULT_REHASH_THRESHOLD
),
3913 xpm_put_color_table_h (Lisp_Object color_table
,
3914 const unsigned char *chars_start
,
3918 struct Lisp_Hash_Table
*table
= XHASH_TABLE (color_table
);
3919 EMACS_UINT hash_code
;
3920 Lisp_Object chars
= make_unibyte_string (chars_start
, chars_len
);
3922 hash_lookup (table
, chars
, &hash_code
);
3923 hash_put (table
, chars
, color
, hash_code
);
3927 xpm_get_color_table_h (Lisp_Object color_table
,
3928 const unsigned char *chars_start
,
3931 struct Lisp_Hash_Table
*table
= XHASH_TABLE (color_table
);
3933 hash_lookup (table
, make_unibyte_string (chars_start
, chars_len
), NULL
);
3935 return i
>= 0 ? HASH_VALUE (table
, i
) : Qnil
;
3938 enum xpm_color_key
{
3946 static const char xpm_color_key_strings
[][4] = {"s", "m", "g4", "g", "c"};
3949 xpm_str_to_color_key (const char *s
)
3954 i
< sizeof xpm_color_key_strings
/ sizeof xpm_color_key_strings
[0];
3956 if (strcmp (xpm_color_key_strings
[i
], s
) == 0)
3962 xpm_load_image (struct frame
*f
,
3964 const unsigned char *contents
,
3965 const unsigned char *end
)
3967 const unsigned char *s
= contents
, *beg
, *str
;
3968 unsigned char buffer
[BUFSIZ
];
3969 int width
, height
, x
, y
;
3970 int num_colors
, chars_per_pixel
;
3973 void (*put_color_table
) (Lisp_Object
, const unsigned char *, int, Lisp_Object
);
3974 Lisp_Object (*get_color_table
) (Lisp_Object
, const unsigned char *, int);
3975 Lisp_Object frame
, color_symbols
, color_table
;
3978 XImagePtr ximg
= NULL
, mask_img
= NULL
;
3981 LA1 = xpm_scan (&s, end, &beg, &len)
3983 #define expect(TOKEN) \
3984 if (LA1 != (TOKEN)) \
3989 #define expect_ident(IDENT) \
3990 if (LA1 == XPM_TK_IDENT \
3991 && strlen ((IDENT)) == len && memcmp ((IDENT), beg, len) == 0) \
3996 if (!(end
- s
>= 9 && memcmp (s
, "/* XPM */", 9) == 0))
4000 expect_ident ("static");
4001 expect_ident ("char");
4003 expect (XPM_TK_IDENT
);
4008 expect (XPM_TK_STRING
);
4011 memcpy (buffer
, beg
, len
);
4013 if (sscanf (buffer
, "%d %d %d %d", &width
, &height
,
4014 &num_colors
, &chars_per_pixel
) != 4
4015 || width
<= 0 || height
<= 0
4016 || num_colors
<= 0 || chars_per_pixel
<= 0)
4019 if (!check_image_size (f
, width
, height
))
4021 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
4025 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, 0, &ximg
, 0)
4027 || !image_create_x_image_and_pixmap (f
, img
, width
, height
, 1,
4032 image_error ("Image too large", Qnil
, Qnil
);
4038 XSETFRAME (frame
, f
);
4039 if (!NILP (Fxw_display_color_p (frame
)))
4040 best_key
= XPM_COLOR_KEY_C
;
4041 else if (!NILP (Fx_display_grayscale_p (frame
)))
4042 best_key
= (XFASTINT (Fx_display_planes (frame
)) > 2
4043 ? XPM_COLOR_KEY_G
: XPM_COLOR_KEY_G4
);
4045 best_key
= XPM_COLOR_KEY_M
;
4047 color_symbols
= image_spec_value (img
->spec
, QCcolor_symbols
, NULL
);
4048 if (chars_per_pixel
== 1)
4049 color_table
= xpm_make_color_table_v (&put_color_table
,
4052 color_table
= xpm_make_color_table_h (&put_color_table
,
4055 while (num_colors
-- > 0)
4057 char *color
, *max_color
;
4058 int key
, next_key
, max_key
= 0;
4059 Lisp_Object symbol_color
= Qnil
, color_val
;
4062 expect (XPM_TK_STRING
);
4063 if (len
<= chars_per_pixel
|| len
>= BUFSIZ
+ chars_per_pixel
)
4065 memcpy (buffer
, beg
+ chars_per_pixel
, len
- chars_per_pixel
);
4066 buffer
[len
- chars_per_pixel
] = '\0';
4068 str
= strtok (buffer
, " \t");
4071 key
= xpm_str_to_color_key (str
);
4076 color
= strtok (NULL
, " \t");
4080 while ((str
= strtok (NULL
, " \t")) != NULL
)
4082 next_key
= xpm_str_to_color_key (str
);
4085 color
[strlen (color
)] = ' ';
4088 if (key
== XPM_COLOR_KEY_S
)
4090 if (NILP (symbol_color
))
4091 symbol_color
= build_string (color
);
4093 else if (max_key
< key
&& key
<= best_key
)
4103 if (!NILP (color_symbols
) && !NILP (symbol_color
))
4105 Lisp_Object specified_color
= Fassoc (symbol_color
, color_symbols
);
4107 if (CONSP (specified_color
) && STRINGP (XCDR (specified_color
)))
4109 if (xstrcasecmp (SSDATA (XCDR (specified_color
)), "None") == 0)
4111 else if (x_defined_color (f
, SSDATA (XCDR (specified_color
)),
4113 color_val
= make_number (cdef
.pixel
);
4116 if (NILP (color_val
) && max_key
> 0)
4118 if (xstrcasecmp (max_color
, "None") == 0)
4120 else if (x_defined_color (f
, max_color
, &cdef
, 0))
4121 color_val
= make_number (cdef
.pixel
);
4123 if (!NILP (color_val
))
4124 (*put_color_table
) (color_table
, beg
, chars_per_pixel
, color_val
);
4129 for (y
= 0; y
< height
; y
++)
4131 expect (XPM_TK_STRING
);
4133 if (len
< width
* chars_per_pixel
)
4135 for (x
= 0; x
< width
; x
++, str
+= chars_per_pixel
)
4137 Lisp_Object color_val
=
4138 (*get_color_table
) (color_table
, str
, chars_per_pixel
);
4140 XPutPixel (ximg
, x
, y
,
4141 (INTEGERP (color_val
) ? XINT (color_val
)
4142 : FRAME_FOREGROUND_PIXEL (f
)));
4144 XPutPixel (mask_img
, x
, y
,
4145 (!EQ (color_val
, Qt
) ? PIX_MASK_DRAW
4146 : (have_mask
= 1, PIX_MASK_RETAIN
)));
4148 if (EQ (color_val
, Qt
))
4149 ns_set_alpha (ximg
, x
, y
, 0);
4157 img
->height
= height
;
4159 /* Maybe fill in the background field while we have ximg handy. */
4160 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
4161 IMAGE_BACKGROUND (img
, f
, ximg
);
4163 image_put_x_image (f
, img
, ximg
, 0);
4167 /* Fill in the background_transparent field while we have the
4169 image_background_transparent (img
, f
, mask_img
);
4171 image_put_x_image (f
, img
, mask_img
, 1);
4175 x_destroy_x_image (mask_img
);
4176 x_clear_image_1 (f
, img
, CLEAR_IMAGE_MASK
);
4182 image_error ("Invalid XPM file (%s)", img
->spec
, Qnil
);
4183 x_destroy_x_image (ximg
);
4184 x_destroy_x_image (mask_img
);
4185 x_clear_image (f
, img
);
4194 xpm_load (struct frame
*f
,
4198 Lisp_Object file_name
;
4200 /* If IMG->spec specifies a file name, create a non-file spec from it. */
4201 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
4202 if (STRINGP (file_name
))
4205 unsigned char *contents
;
4208 file
= x_find_image_file (file_name
);
4209 if (!STRINGP (file
))
4211 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
4215 contents
= slurp_file (SSDATA (file
), &size
);
4216 if (contents
== NULL
)
4218 image_error ("Error loading XPM image `%s'", img
->spec
, Qnil
);
4222 success_p
= xpm_load_image (f
, img
, contents
, contents
+ size
);
4229 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
4230 if (!STRINGP (data
))
4232 image_error ("Invalid image data `%s'", data
, Qnil
);
4235 success_p
= xpm_load_image (f
, img
, SDATA (data
),
4236 SDATA (data
) + SBYTES (data
));
4242 #endif /* HAVE_NS && !HAVE_XPM */
4246 /***********************************************************************
4248 ***********************************************************************/
4250 #ifdef COLOR_TABLE_SUPPORT
4252 /* An entry in the color table mapping an RGB color to a pixel color. */
4257 unsigned long pixel
;
4259 /* Next in color table collision list. */
4260 struct ct_color
*next
;
4263 /* The bucket vector size to use. Must be prime. */
4267 /* Value is a hash of the RGB color given by R, G, and B. */
4269 #define CT_HASH_RGB(R, G, B) (((R) << 16) ^ ((G) << 8) ^ (B))
4271 /* The color hash table. */
4273 static struct ct_color
**ct_table
;
4275 /* Number of entries in the color table. */
4277 static int ct_colors_allocated
;
4280 ct_colors_allocated_max
=
4282 min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof (unsigned long))
4285 /* Initialize the color table. */
4288 init_color_table (void)
4290 int size
= CT_SIZE
* sizeof (*ct_table
);
4291 ct_table
= xzalloc (size
);
4292 ct_colors_allocated
= 0;
4296 /* Free memory associated with the color table. */
4299 free_color_table (void)
4302 struct ct_color
*p
, *next
;
4304 for (i
= 0; i
< CT_SIZE
; ++i
)
4305 for (p
= ct_table
[i
]; p
; p
= next
)
4316 /* Value is a pixel color for RGB color R, G, B on frame F. If an
4317 entry for that color already is in the color table, return the
4318 pixel color of that entry. Otherwise, allocate a new color for R,
4319 G, B, and make an entry in the color table. */
4321 static unsigned long
4322 lookup_rgb_color (struct frame
*f
, int r
, int g
, int b
)
4324 unsigned hash
= CT_HASH_RGB (r
, g
, b
);
4325 int i
= hash
% CT_SIZE
;
4327 Display_Info
*dpyinfo
;
4329 /* Handle TrueColor visuals specially, which improves performance by
4330 two orders of magnitude. Freeing colors on TrueColor visuals is
4331 a nop, and pixel colors specify RGB values directly. See also
4332 the Xlib spec, chapter 3.1. */
4333 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
4334 if (dpyinfo
->red_bits
> 0)
4336 unsigned long pr
, pg
, pb
;
4338 /* Apply gamma-correction like normal color allocation does. */
4342 color
.red
= r
, color
.green
= g
, color
.blue
= b
;
4343 gamma_correct (f
, &color
);
4344 r
= color
.red
, g
= color
.green
, b
= color
.blue
;
4347 /* Scale down RGB values to the visual's bits per RGB, and shift
4348 them to the right position in the pixel color. Note that the
4349 original RGB values are 16-bit values, as usual in X. */
4350 pr
= (r
>> (16 - dpyinfo
->red_bits
)) << dpyinfo
->red_offset
;
4351 pg
= (g
>> (16 - dpyinfo
->green_bits
)) << dpyinfo
->green_offset
;
4352 pb
= (b
>> (16 - dpyinfo
->blue_bits
)) << dpyinfo
->blue_offset
;
4354 /* Assemble the pixel color. */
4355 return pr
| pg
| pb
;
4358 for (p
= ct_table
[i
]; p
; p
= p
->next
)
4359 if (p
->r
== r
&& p
->g
== g
&& p
->b
== b
)
4365 #ifdef HAVE_X_WINDOWS
4373 if (ct_colors_allocated_max
<= ct_colors_allocated
)
4374 return FRAME_FOREGROUND_PIXEL (f
);
4376 #ifdef HAVE_X_WINDOWS
4381 cmap
= FRAME_X_COLORMAP (f
);
4382 rc
= x_alloc_nearest_color (f
, cmap
, &color
);
4385 ++ct_colors_allocated
;
4386 p
= xmalloc (sizeof *p
);
4390 p
->pixel
= color
.pixel
;
4391 p
->next
= ct_table
[i
];
4395 return FRAME_FOREGROUND_PIXEL (f
);
4399 color
= PALETTERGB (r
, g
, b
);
4401 color
= RGB_TO_ULONG (r
, g
, b
);
4402 #endif /* HAVE_NTGUI */
4403 ++ct_colors_allocated
;
4404 p
= xmalloc (sizeof *p
);
4409 p
->next
= ct_table
[i
];
4411 #endif /* HAVE_X_WINDOWS */
4419 /* Look up pixel color PIXEL which is used on frame F in the color
4420 table. If not already present, allocate it. Value is PIXEL. */
4422 static unsigned long
4423 lookup_pixel_color (struct frame
*f
, unsigned long pixel
)
4425 int i
= pixel
% CT_SIZE
;
4428 for (p
= ct_table
[i
]; p
; p
= p
->next
)
4429 if (p
->pixel
== pixel
)
4438 if (ct_colors_allocated_max
<= ct_colors_allocated
)
4439 return FRAME_FOREGROUND_PIXEL (f
);
4441 #ifdef HAVE_X_WINDOWS
4442 cmap
= FRAME_X_COLORMAP (f
);
4443 color
.pixel
= pixel
;
4444 x_query_color (f
, &color
);
4445 rc
= x_alloc_nearest_color (f
, cmap
, &color
);
4448 cmap
= DefaultColormapOfScreen (FRAME_X_SCREEN (f
));
4449 color
.pixel
= pixel
;
4450 XQueryColor (NULL
, cmap
, &color
);
4451 rc
= x_alloc_nearest_color (f
, cmap
, &color
);
4453 #endif /* HAVE_X_WINDOWS */
4457 ++ct_colors_allocated
;
4459 p
= xmalloc (sizeof *p
);
4464 p
->next
= ct_table
[i
];
4468 return FRAME_FOREGROUND_PIXEL (f
);
4474 /* Value is a vector of all pixel colors contained in the color table,
4475 allocated via xmalloc. Set *N to the number of colors. */
4477 static unsigned long *
4478 colors_in_color_table (int *n
)
4482 unsigned long *colors
;
4484 if (ct_colors_allocated
== 0)
4491 colors
= xmalloc (ct_colors_allocated
* sizeof *colors
);
4492 *n
= ct_colors_allocated
;
4494 for (i
= j
= 0; i
< CT_SIZE
; ++i
)
4495 for (p
= ct_table
[i
]; p
; p
= p
->next
)
4496 colors
[j
++] = p
->pixel
;
4502 #else /* COLOR_TABLE_SUPPORT */
4504 static unsigned long
4505 lookup_rgb_color (struct frame
*f
, int r
, int g
, int b
)
4507 unsigned long pixel
;
4510 pixel
= PALETTERGB (r
>> 8, g
>> 8, b
>> 8);
4511 #endif /* HAVE_NTGUI */
4514 pixel
= RGB_TO_ULONG (r
>> 8, g
>> 8, b
>> 8);
4515 #endif /* HAVE_NS */
4520 init_color_table (void)
4523 #endif /* COLOR_TABLE_SUPPORT */
4526 /***********************************************************************
4528 ***********************************************************************/
4530 /* Edge detection matrices for different edge-detection
4533 static int emboss_matrix
[9] = {
4535 2, -1, 0, /* y - 1 */
4537 0, 1, -2 /* y + 1 */
4540 static int laplace_matrix
[9] = {
4542 1, 0, 0, /* y - 1 */
4544 0, 0, -1 /* y + 1 */
4547 /* Value is the intensity of the color whose red/green/blue values
4550 #define COLOR_INTENSITY(R, G, B) ((2 * (R) + 3 * (G) + (B)) / 6)
4553 /* On frame F, return an array of XColor structures describing image
4554 IMG->pixmap. Each XColor structure has its pixel color set. RGB_P
4555 means also fill the red/green/blue members of the XColor
4556 structures. Value is a pointer to the array of XColors structures,
4557 allocated with xmalloc; it must be freed by the caller. */
4560 x_to_xcolors (struct frame
*f
, struct image
*img
, bool rgb_p
)
4564 XImagePtr_or_DC ximg
;
4567 #endif /* HAVE_NTGUI */
4569 if (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *colors
/ img
->width
< img
->height
)
4570 memory_full (SIZE_MAX
);
4571 colors
= xmalloc (sizeof *colors
* img
->width
* img
->height
);
4573 /* Get the X image or create a memory device context for IMG. */
4574 ximg
= image_get_x_image_or_dc (f
, img
, 0, &prev
);
4576 /* Fill the `pixel' members of the XColor array. I wished there
4577 were an easy and portable way to circumvent XGetPixel. */
4579 for (y
= 0; y
< img
->height
; ++y
)
4581 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI)
4583 for (x
= 0; x
< img
->width
; ++x
, ++p
)
4584 p
->pixel
= GET_PIXEL (ximg
, x
, y
);
4586 x_query_colors (f
, row
, img
->width
);
4590 for (x
= 0; x
< img
->width
; ++x
, ++p
)
4592 /* W32_TODO: palette support needed here? */
4593 p
->pixel
= GET_PIXEL (ximg
, x
, y
);
4596 p
->red
= RED16_FROM_ULONG (p
->pixel
);
4597 p
->green
= GREEN16_FROM_ULONG (p
->pixel
);
4598 p
->blue
= BLUE16_FROM_ULONG (p
->pixel
);
4601 #endif /* HAVE_X_WINDOWS */
4604 image_unget_x_image_or_dc (img
, 0, ximg
, prev
);
4611 /* Put a pixel of COLOR at position X, Y in XIMG. XIMG must have been
4612 created with CreateDIBSection, with the pointer to the bit values
4613 stored in ximg->data. */
4616 XPutPixel (XImagePtr ximg
, int x
, int y
, COLORREF color
)
4618 int width
= ximg
->info
.bmiHeader
.biWidth
;
4619 unsigned char * pixel
;
4621 /* True color images. */
4622 if (ximg
->info
.bmiHeader
.biBitCount
== 24)
4624 int rowbytes
= width
* 3;
4625 /* Ensure scanlines are aligned on 4 byte boundaries. */
4627 rowbytes
+= 4 - (rowbytes
% 4);
4629 pixel
= ximg
->data
+ y
* rowbytes
+ x
* 3;
4630 /* Windows bitmaps are in BGR order. */
4631 *pixel
= GetBValue (color
);
4632 *(pixel
+ 1) = GetGValue (color
);
4633 *(pixel
+ 2) = GetRValue (color
);
4635 /* Monochrome images. */
4636 else if (ximg
->info
.bmiHeader
.biBitCount
== 1)
4638 int rowbytes
= width
/ 8;
4639 /* Ensure scanlines are aligned on 4 byte boundaries. */
4641 rowbytes
+= 4 - (rowbytes
% 4);
4642 pixel
= ximg
->data
+ y
* rowbytes
+ x
/ 8;
4643 /* Filter out palette info. */
4644 if (color
& 0x00ffffff)
4645 *pixel
= *pixel
| (1 << x
% 8);
4647 *pixel
= *pixel
& ~(1 << x
% 8);
4650 image_error ("XPutPixel: palette image not supported", Qnil
, Qnil
);
4653 #endif /* HAVE_NTGUI */
4655 /* Create IMG->pixmap from an array COLORS of XColor structures, whose
4656 RGB members are set. F is the frame on which this all happens.
4657 COLORS will be freed; an existing IMG->pixmap will be freed, too. */
4660 x_from_xcolors (struct frame
*f
, struct image
*img
, XColor
*colors
)
4663 XImagePtr oimg
= NULL
;
4666 init_color_table ();
4668 x_clear_image_1 (f
, img
, CLEAR_IMAGE_PIXMAP
| CLEAR_IMAGE_COLORS
);
4669 image_create_x_image_and_pixmap (f
, img
, img
->width
, img
->height
, 0,
4672 for (y
= 0; y
< img
->height
; ++y
)
4673 for (x
= 0; x
< img
->width
; ++x
, ++p
)
4675 unsigned long pixel
;
4676 pixel
= lookup_rgb_color (f
, p
->red
, p
->green
, p
->blue
);
4677 XPutPixel (oimg
, x
, y
, pixel
);
4682 image_put_x_image (f
, img
, oimg
, 0);
4683 #ifdef COLOR_TABLE_SUPPORT
4684 img
->colors
= colors_in_color_table (&img
->ncolors
);
4685 free_color_table ();
4686 #endif /* COLOR_TABLE_SUPPORT */
4690 /* On frame F, perform edge-detection on image IMG.
4692 MATRIX is a nine-element array specifying the transformation
4693 matrix. See emboss_matrix for an example.
4695 COLOR_ADJUST is a color adjustment added to each pixel of the
4699 x_detect_edges (struct frame
*f
, struct image
*img
, int *matrix
, int color_adjust
)
4701 XColor
*colors
= x_to_xcolors (f
, img
, 1);
4705 for (i
= sum
= 0; i
< 9; ++i
)
4706 sum
+= eabs (matrix
[i
]);
4708 #define COLOR(A, X, Y) ((A) + (Y) * img->width + (X))
4710 if (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *new / img
->width
< img
->height
)
4711 memory_full (SIZE_MAX
);
4712 new = xmalloc (sizeof *new * img
->width
* img
->height
);
4714 for (y
= 0; y
< img
->height
; ++y
)
4716 p
= COLOR (new, 0, y
);
4717 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4718 p
= COLOR (new, img
->width
- 1, y
);
4719 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4722 for (x
= 1; x
< img
->width
- 1; ++x
)
4724 p
= COLOR (new, x
, 0);
4725 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4726 p
= COLOR (new, x
, img
->height
- 1);
4727 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4730 for (y
= 1; y
< img
->height
- 1; ++y
)
4732 p
= COLOR (new, 1, y
);
4734 for (x
= 1; x
< img
->width
- 1; ++x
, ++p
)
4736 int r
, g
, b
, yy
, xx
;
4739 for (yy
= y
- 1; yy
< y
+ 2; ++yy
)
4740 for (xx
= x
- 1; xx
< x
+ 2; ++xx
, ++i
)
4743 XColor
*t
= COLOR (colors
, xx
, yy
);
4744 r
+= matrix
[i
] * t
->red
;
4745 g
+= matrix
[i
] * t
->green
;
4746 b
+= matrix
[i
] * t
->blue
;
4749 r
= (r
/ sum
+ color_adjust
) & 0xffff;
4750 g
= (g
/ sum
+ color_adjust
) & 0xffff;
4751 b
= (b
/ sum
+ color_adjust
) & 0xffff;
4752 p
->red
= p
->green
= p
->blue
= COLOR_INTENSITY (r
, g
, b
);
4757 x_from_xcolors (f
, img
, new);
4763 /* Perform the pre-defined `emboss' edge-detection on image IMG
4767 x_emboss (struct frame
*f
, struct image
*img
)
4769 x_detect_edges (f
, img
, emboss_matrix
, 0xffff / 2);
4773 /* Transform image IMG which is used on frame F with a Laplace
4774 edge-detection algorithm. The result is an image that can be used
4775 to draw disabled buttons, for example. */
4778 x_laplace (struct frame
*f
, struct image
*img
)
4780 x_detect_edges (f
, img
, laplace_matrix
, 45000);
4784 /* Perform edge-detection on image IMG on frame F, with specified
4785 transformation matrix MATRIX and color-adjustment COLOR_ADJUST.
4787 MATRIX must be either
4789 - a list of at least 9 numbers in row-major form
4790 - a vector of at least 9 numbers
4792 COLOR_ADJUST nil means use a default; otherwise it must be a
4796 x_edge_detection (struct frame
*f
, struct image
*img
, Lisp_Object matrix
,
4797 Lisp_Object color_adjust
)
4805 i
< 9 && CONSP (matrix
) && NUMBERP (XCAR (matrix
));
4806 ++i
, matrix
= XCDR (matrix
))
4807 trans
[i
] = XFLOATINT (XCAR (matrix
));
4809 else if (VECTORP (matrix
) && ASIZE (matrix
) >= 9)
4811 for (i
= 0; i
< 9 && NUMBERP (AREF (matrix
, i
)); ++i
)
4812 trans
[i
] = XFLOATINT (AREF (matrix
, i
));
4815 if (NILP (color_adjust
))
4816 color_adjust
= make_number (0xffff / 2);
4818 if (i
== 9 && NUMBERP (color_adjust
))
4819 x_detect_edges (f
, img
, trans
, XFLOATINT (color_adjust
));
4823 /* Transform image IMG on frame F so that it looks disabled. */
4826 x_disable_image (struct frame
*f
, struct image
*img
)
4828 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
4830 int n_planes
= dpyinfo
->n_planes
* dpyinfo
->n_cbits
;
4832 int n_planes
= dpyinfo
->n_planes
;
4833 #endif /* HAVE_NTGUI */
4837 /* Color (or grayscale). Convert to gray, and equalize. Just
4838 drawing such images with a stipple can look very odd, so
4839 we're using this method instead. */
4840 XColor
*colors
= x_to_xcolors (f
, img
, 1);
4842 const int h
= 15000;
4843 const int l
= 30000;
4845 for (p
= colors
, end
= colors
+ img
->width
* img
->height
;
4849 int i
= COLOR_INTENSITY (p
->red
, p
->green
, p
->blue
);
4850 int i2
= (0xffff - h
- l
) * i
/ 0xffff + l
;
4851 p
->red
= p
->green
= p
->blue
= i2
;
4854 x_from_xcolors (f
, img
, colors
);
4857 /* Draw a cross over the disabled image, if we must or if we
4859 if (n_planes
< 2 || cross_disabled_images
)
4862 #ifndef HAVE_NS /* TODO: NS support, however this not needed for toolbars */
4864 #define MaskForeground(f) WHITE_PIX_DEFAULT (f)
4866 Display
*dpy
= FRAME_X_DISPLAY (f
);
4869 image_sync_to_pixmaps (f
, img
);
4870 gc
= XCreateGC (dpy
, img
->pixmap
, 0, NULL
);
4871 XSetForeground (dpy
, gc
, BLACK_PIX_DEFAULT (f
));
4872 XDrawLine (dpy
, img
->pixmap
, gc
, 0, 0,
4873 img
->width
- 1, img
->height
- 1);
4874 XDrawLine (dpy
, img
->pixmap
, gc
, 0, img
->height
- 1,
4880 gc
= XCreateGC (dpy
, img
->mask
, 0, NULL
);
4881 XSetForeground (dpy
, gc
, MaskForeground (f
));
4882 XDrawLine (dpy
, img
->mask
, gc
, 0, 0,
4883 img
->width
- 1, img
->height
- 1);
4884 XDrawLine (dpy
, img
->mask
, gc
, 0, img
->height
- 1,
4888 #endif /* !HAVE_NS */
4893 hdc
= get_frame_dc (f
);
4894 bmpdc
= CreateCompatibleDC (hdc
);
4895 release_frame_dc (f
, hdc
);
4897 prev
= SelectObject (bmpdc
, img
->pixmap
);
4899 SetTextColor (bmpdc
, BLACK_PIX_DEFAULT (f
));
4900 MoveToEx (bmpdc
, 0, 0, NULL
);
4901 LineTo (bmpdc
, img
->width
- 1, img
->height
- 1);
4902 MoveToEx (bmpdc
, 0, img
->height
- 1, NULL
);
4903 LineTo (bmpdc
, img
->width
- 1, 0);
4907 SelectObject (bmpdc
, img
->mask
);
4908 SetTextColor (bmpdc
, WHITE_PIX_DEFAULT (f
));
4909 MoveToEx (bmpdc
, 0, 0, NULL
);
4910 LineTo (bmpdc
, img
->width
- 1, img
->height
- 1);
4911 MoveToEx (bmpdc
, 0, img
->height
- 1, NULL
);
4912 LineTo (bmpdc
, img
->width
- 1, 0);
4914 SelectObject (bmpdc
, prev
);
4916 #endif /* HAVE_NTGUI */
4921 /* Build a mask for image IMG which is used on frame F. FILE is the
4922 name of an image file, for error messages. HOW determines how to
4923 determine the background color of IMG. If it is a list '(R G B)',
4924 with R, G, and B being integers >= 0, take that as the color of the
4925 background. Otherwise, determine the background color of IMG
4929 x_build_heuristic_mask (struct frame
*f
, struct image
*img
, Lisp_Object how
)
4931 XImagePtr_or_DC ximg
;
4938 #endif /* HAVE_NTGUI */
4940 bool rc
, use_img_background
;
4941 unsigned long bg
= 0;
4944 x_clear_image_1 (f
, img
, CLEAR_IMAGE_MASK
);
4948 /* Create an image and pixmap serving as mask. */
4949 rc
= image_create_x_image_and_pixmap (f
, img
, img
->width
, img
->height
, 1,
4953 #endif /* !HAVE_NS */
4955 /* Create the bit array serving as mask. */
4956 row_width
= (img
->width
+ 7) / 8;
4957 mask_img
= xzalloc (row_width
* img
->height
);
4958 #endif /* HAVE_NTGUI */
4960 /* Get the X image or create a memory device context for IMG. */
4961 ximg
= image_get_x_image_or_dc (f
, img
, 0, &prev
);
4963 /* Determine the background color of ximg. If HOW is `(R G B)'
4964 take that as color. Otherwise, use the image's background color. */
4965 use_img_background
= 1;
4971 for (i
= 0; i
< 3 && CONSP (how
) && NATNUMP (XCAR (how
)); ++i
)
4973 rgb
[i
] = XFASTINT (XCAR (how
)) & 0xffff;
4977 if (i
== 3 && NILP (how
))
4979 char color_name
[30];
4980 sprintf (color_name
, "#%04x%04x%04x", rgb
[0], rgb
[1], rgb
[2]);
4983 0x00ffffff & /* Filter out palette info. */
4984 #endif /* HAVE_NTGUI */
4985 x_alloc_image_color (f
, img
, build_string (color_name
), 0));
4986 use_img_background
= 0;
4990 if (use_img_background
)
4991 bg
= four_corners_best (ximg
, img
->corners
, img
->width
, img
->height
);
4993 /* Set all bits in mask_img to 1 whose color in ximg is different
4994 from the background color bg. */
4996 for (y
= 0; y
< img
->height
; ++y
)
4997 for (x
= 0; x
< img
->width
; ++x
)
4999 XPutPixel (mask_img
, x
, y
, (XGetPixel (ximg
, x
, y
) != bg
5000 ? PIX_MASK_DRAW
: PIX_MASK_RETAIN
));
5002 if (XGetPixel (ximg
, x
, y
) == bg
)
5003 ns_set_alpha (ximg
, x
, y
, 0);
5004 #endif /* HAVE_NS */
5006 /* Fill in the background_transparent field while we have the mask handy. */
5007 image_background_transparent (img
, f
, mask_img
);
5009 /* Put mask_img into the image. */
5010 image_put_x_image (f
, img
, mask_img
, 1);
5011 #endif /* !HAVE_NS */
5013 for (y
= 0; y
< img
->height
; ++y
)
5014 for (x
= 0; x
< img
->width
; ++x
)
5016 COLORREF p
= GetPixel (ximg
, x
, y
);
5018 mask_img
[y
* row_width
+ x
/ 8] |= 1 << (x
% 8);
5021 /* Create the mask image. */
5022 img
->mask
= w32_create_pixmap_from_bitmap_data (img
->width
, img
->height
,
5024 /* Fill in the background_transparent field while we have the mask handy. */
5025 SelectObject (ximg
, img
->mask
);
5026 image_background_transparent (img
, f
, ximg
);
5028 /* Was: x_destroy_x_image ((XImagePtr )mask_img); which seems bogus ++kfs */
5030 #endif /* HAVE_NTGUI */
5032 image_unget_x_image_or_dc (img
, 0, ximg
, prev
);
5036 /***********************************************************************
5037 PBM (mono, gray, color)
5038 ***********************************************************************/
5040 static bool pbm_image_p (Lisp_Object object
);
5041 static bool pbm_load (struct frame
*f
, struct image
*img
);
5043 /* The symbol `pbm' identifying images of this type. */
5045 static Lisp_Object Qpbm
;
5047 /* Indices of image specification fields in gs_format, below. */
5049 enum pbm_keyword_index
5065 /* Vector of image_keyword structures describing the format
5066 of valid user-defined image specifications. */
5068 static const struct image_keyword pbm_format
[PBM_LAST
] =
5070 {":type", IMAGE_SYMBOL_VALUE
, 1},
5071 {":file", IMAGE_STRING_VALUE
, 0},
5072 {":data", IMAGE_STRING_VALUE
, 0},
5073 {":ascent", IMAGE_ASCENT_VALUE
, 0},
5074 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
5075 {":relief", IMAGE_INTEGER_VALUE
, 0},
5076 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5077 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5078 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5079 {":foreground", IMAGE_STRING_OR_NIL_VALUE
, 0},
5080 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
5083 /* Structure describing the image type `pbm'. */
5085 static struct image_type pbm_type
=
5096 /* Return true if OBJECT is a valid PBM image specification. */
5099 pbm_image_p (Lisp_Object object
)
5101 struct image_keyword fmt
[PBM_LAST
];
5103 memcpy (fmt
, pbm_format
, sizeof fmt
);
5105 if (!parse_image_spec (object
, fmt
, PBM_LAST
, Qpbm
))
5108 /* Must specify either :data or :file. */
5109 return fmt
[PBM_DATA
].count
+ fmt
[PBM_FILE
].count
== 1;
5113 /* Scan a decimal number from *S and return it. Advance *S while
5114 reading the number. END is the end of the string. Value is -1 at
5118 pbm_scan_number (unsigned char **s
, unsigned char *end
)
5120 int c
= 0, val
= -1;
5124 /* Skip white-space. */
5125 while (*s
< end
&& (c
= *(*s
)++, c_isspace (c
)))
5130 /* Skip comment to end of line. */
5131 while (*s
< end
&& (c
= *(*s
)++, c
!= '\n'))
5134 else if (c_isdigit (c
))
5136 /* Read decimal number. */
5138 while (*s
< end
&& (c
= *(*s
)++, c_isdigit (c
)))
5139 val
= 10 * val
+ c
- '0';
5150 /* Load PBM image IMG for use on frame F. */
5153 pbm_load (struct frame
*f
, struct image
*img
)
5157 int width
, height
, max_color_idx
= 0;
5159 Lisp_Object file
, specified_file
;
5160 enum {PBM_MONO
, PBM_GRAY
, PBM_COLOR
} type
;
5161 unsigned char *contents
= NULL
;
5162 unsigned char *end
, *p
;
5165 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
5167 if (STRINGP (specified_file
))
5169 file
= x_find_image_file (specified_file
);
5170 if (!STRINGP (file
))
5172 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
5176 contents
= slurp_file (SSDATA (file
), &size
);
5177 if (contents
== NULL
)
5179 image_error ("Error reading `%s'", file
, Qnil
);
5184 end
= contents
+ size
;
5189 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
5190 if (!STRINGP (data
))
5192 image_error ("Invalid image data `%s'", data
, Qnil
);
5196 end
= p
+ SBYTES (data
);
5199 /* Check magic number. */
5200 if (end
- p
< 2 || *p
++ != 'P')
5202 image_error ("Not a PBM image: `%s'", img
->spec
, Qnil
);
5211 raw_p
= 0, type
= PBM_MONO
;
5215 raw_p
= 0, type
= PBM_GRAY
;
5219 raw_p
= 0, type
= PBM_COLOR
;
5223 raw_p
= 1, type
= PBM_MONO
;
5227 raw_p
= 1, type
= PBM_GRAY
;
5231 raw_p
= 1, type
= PBM_COLOR
;
5235 image_error ("Not a PBM image: `%s'", img
->spec
, Qnil
);
5239 /* Read width, height, maximum color-component. Characters
5240 starting with `#' up to the end of a line are ignored. */
5241 width
= pbm_scan_number (&p
, end
);
5242 height
= pbm_scan_number (&p
, end
);
5244 if (type
!= PBM_MONO
)
5246 max_color_idx
= pbm_scan_number (&p
, end
);
5247 if (max_color_idx
> 65535 || max_color_idx
< 0)
5249 image_error ("Unsupported maximum PBM color value", Qnil
, Qnil
);
5254 if (!check_image_size (f
, width
, height
))
5256 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
5260 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, 0, &ximg
, 0))
5263 /* Initialize the color hash table. */
5264 init_color_table ();
5266 if (type
== PBM_MONO
)
5269 struct image_keyword fmt
[PBM_LAST
];
5270 unsigned long fg
= FRAME_FOREGROUND_PIXEL (f
);
5271 unsigned long bg
= FRAME_BACKGROUND_PIXEL (f
);
5273 /* Parse the image specification. */
5274 memcpy (fmt
, pbm_format
, sizeof fmt
);
5275 parse_image_spec (img
->spec
, fmt
, PBM_LAST
, Qpbm
);
5277 /* Get foreground and background colors, maybe allocate colors. */
5278 if (fmt
[PBM_FOREGROUND
].count
5279 && STRINGP (fmt
[PBM_FOREGROUND
].value
))
5280 fg
= x_alloc_image_color (f
, img
, fmt
[PBM_FOREGROUND
].value
, fg
);
5281 if (fmt
[PBM_BACKGROUND
].count
5282 && STRINGP (fmt
[PBM_BACKGROUND
].value
))
5284 bg
= x_alloc_image_color (f
, img
, fmt
[PBM_BACKGROUND
].value
, bg
);
5285 img
->background
= bg
;
5286 img
->background_valid
= 1;
5289 for (y
= 0; y
< height
; ++y
)
5290 for (x
= 0; x
< width
; ++x
)
5298 x_destroy_x_image (ximg
);
5299 x_clear_image (f
, img
);
5300 image_error ("Invalid image size in image `%s'",
5310 g
= pbm_scan_number (&p
, end
);
5312 XPutPixel (ximg
, x
, y
, g
? fg
: bg
);
5317 int expected_size
= height
* width
;
5318 if (max_color_idx
> 255)
5320 if (type
== PBM_COLOR
)
5323 if (raw_p
&& p
+ expected_size
> end
)
5325 x_destroy_x_image (ximg
);
5326 x_clear_image (f
, img
);
5327 image_error ("Invalid image size in image `%s'",
5332 for (y
= 0; y
< height
; ++y
)
5333 for (x
= 0; x
< width
; ++x
)
5337 if (type
== PBM_GRAY
&& raw_p
)
5340 if (max_color_idx
> 255)
5341 r
= g
= b
= r
* 256 + *p
++;
5343 else if (type
== PBM_GRAY
)
5344 r
= g
= b
= pbm_scan_number (&p
, end
);
5348 if (max_color_idx
> 255)
5351 if (max_color_idx
> 255)
5354 if (max_color_idx
> 255)
5359 r
= pbm_scan_number (&p
, end
);
5360 g
= pbm_scan_number (&p
, end
);
5361 b
= pbm_scan_number (&p
, end
);
5364 if (r
< 0 || g
< 0 || b
< 0)
5366 x_destroy_x_image (ximg
);
5367 image_error ("Invalid pixel value in image `%s'",
5372 /* RGB values are now in the range 0..max_color_idx.
5373 Scale this to the range 0..0xffff supported by X. */
5374 r
= (double) r
* 65535 / max_color_idx
;
5375 g
= (double) g
* 65535 / max_color_idx
;
5376 b
= (double) b
* 65535 / max_color_idx
;
5377 XPutPixel (ximg
, x
, y
, lookup_rgb_color (f
, r
, g
, b
));
5381 #ifdef COLOR_TABLE_SUPPORT
5382 /* Store in IMG->colors the colors allocated for the image, and
5383 free the color table. */
5384 img
->colors
= colors_in_color_table (&img
->ncolors
);
5385 free_color_table ();
5386 #endif /* COLOR_TABLE_SUPPORT */
5389 img
->height
= height
;
5391 /* Maybe fill in the background field while we have ximg handy. */
5393 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
5394 /* Casting avoids a GCC warning. */
5395 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
5397 /* Put ximg into the image. */
5398 image_put_x_image (f
, img
, ximg
, 0);
5400 /* X and W32 versions did it here, MAC version above. ++kfs
5402 img->height = height; */
5409 /***********************************************************************
5411 ***********************************************************************/
5413 #if defined (HAVE_PNG) || defined (HAVE_NS)
5415 /* Function prototypes. */
5417 static bool png_image_p (Lisp_Object object
);
5418 static bool png_load (struct frame
*f
, struct image
*img
);
5420 /* The symbol `png' identifying images of this type. */
5422 static Lisp_Object Qpng
;
5424 /* Indices of image specification fields in png_format, below. */
5426 enum png_keyword_index
5441 /* Vector of image_keyword structures describing the format
5442 of valid user-defined image specifications. */
5444 static const struct image_keyword png_format
[PNG_LAST
] =
5446 {":type", IMAGE_SYMBOL_VALUE
, 1},
5447 {":data", IMAGE_STRING_VALUE
, 0},
5448 {":file", IMAGE_STRING_VALUE
, 0},
5449 {":ascent", IMAGE_ASCENT_VALUE
, 0},
5450 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
5451 {":relief", IMAGE_INTEGER_VALUE
, 0},
5452 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5453 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5454 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5455 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
5458 #if defined HAVE_NTGUI && defined WINDOWSNT
5459 static bool init_png_functions (void);
5461 #define init_png_functions NULL
5464 /* Structure describing the image type `png'. */
5466 static struct image_type png_type
=
5476 /* Return true if OBJECT is a valid PNG image specification. */
5479 png_image_p (Lisp_Object object
)
5481 struct image_keyword fmt
[PNG_LAST
];
5482 memcpy (fmt
, png_format
, sizeof fmt
);
5484 if (!parse_image_spec (object
, fmt
, PNG_LAST
, Qpng
))
5487 /* Must specify either the :data or :file keyword. */
5488 return fmt
[PNG_FILE
].count
+ fmt
[PNG_DATA
].count
== 1;
5491 #endif /* HAVE_PNG || HAVE_NS */
5497 /* PNG library details. */
5499 DEF_IMGLIB_FN (png_voidp
, png_get_io_ptr
, (png_structp
));
5500 DEF_IMGLIB_FN (int, png_sig_cmp
, (png_bytep
, png_size_t
, png_size_t
));
5501 DEF_IMGLIB_FN (png_structp
, png_create_read_struct
, (png_const_charp
, png_voidp
,
5502 png_error_ptr
, png_error_ptr
));
5503 DEF_IMGLIB_FN (png_infop
, png_create_info_struct
, (png_structp
));
5504 DEF_IMGLIB_FN (void, png_destroy_read_struct
, (png_structpp
, png_infopp
, png_infopp
));
5505 DEF_IMGLIB_FN (void, png_set_read_fn
, (png_structp
, png_voidp
, png_rw_ptr
));
5506 DEF_IMGLIB_FN (void, png_set_sig_bytes
, (png_structp
, int));
5507 DEF_IMGLIB_FN (void, png_read_info
, (png_structp
, png_infop
));
5508 DEF_IMGLIB_FN (png_uint_32
, png_get_IHDR
, (png_structp
, png_infop
,
5509 png_uint_32
*, png_uint_32
*,
5510 int *, int *, int *, int *, int *));
5511 DEF_IMGLIB_FN (png_uint_32
, png_get_valid
, (png_structp
, png_infop
, png_uint_32
));
5512 DEF_IMGLIB_FN (void, png_set_strip_16
, (png_structp
));
5513 DEF_IMGLIB_FN (void, png_set_expand
, (png_structp
));
5514 DEF_IMGLIB_FN (void, png_set_gray_to_rgb
, (png_structp
));
5515 DEF_IMGLIB_FN (void, png_set_background
, (png_structp
, png_color_16p
,
5517 DEF_IMGLIB_FN (png_uint_32
, png_get_bKGD
, (png_structp
, png_infop
, png_color_16p
*));
5518 DEF_IMGLIB_FN (void, png_read_update_info
, (png_structp
, png_infop
));
5519 DEF_IMGLIB_FN (png_byte
, png_get_channels
, (png_structp
, png_infop
));
5520 DEF_IMGLIB_FN (png_size_t
, png_get_rowbytes
, (png_structp
, png_infop
));
5521 DEF_IMGLIB_FN (void, png_read_image
, (png_structp
, png_bytepp
));
5522 DEF_IMGLIB_FN (void, png_read_end
, (png_structp
, png_infop
));
5523 DEF_IMGLIB_FN (void, png_error
, (png_structp
, png_const_charp
));
5525 #if (PNG_LIBPNG_VER >= 10500)
5526 DEF_IMGLIB_FN (void, png_longjmp
, (png_structp
, int));
5527 DEF_IMGLIB_FN (jmp_buf *, png_set_longjmp_fn
, (png_structp
, png_longjmp_ptr
, size_t));
5528 #endif /* libpng version >= 1.5 */
5531 init_png_functions (void)
5535 if (!(library
= w32_delayed_load (Qpng
)))
5538 LOAD_IMGLIB_FN (library
, png_get_io_ptr
);
5539 LOAD_IMGLIB_FN (library
, png_sig_cmp
);
5540 LOAD_IMGLIB_FN (library
, png_create_read_struct
);
5541 LOAD_IMGLIB_FN (library
, png_create_info_struct
);
5542 LOAD_IMGLIB_FN (library
, png_destroy_read_struct
);
5543 LOAD_IMGLIB_FN (library
, png_set_read_fn
);
5544 LOAD_IMGLIB_FN (library
, png_set_sig_bytes
);
5545 LOAD_IMGLIB_FN (library
, png_read_info
);
5546 LOAD_IMGLIB_FN (library
, png_get_IHDR
);
5547 LOAD_IMGLIB_FN (library
, png_get_valid
);
5548 LOAD_IMGLIB_FN (library
, png_set_strip_16
);
5549 LOAD_IMGLIB_FN (library
, png_set_expand
);
5550 LOAD_IMGLIB_FN (library
, png_set_gray_to_rgb
);
5551 LOAD_IMGLIB_FN (library
, png_set_background
);
5552 LOAD_IMGLIB_FN (library
, png_get_bKGD
);
5553 LOAD_IMGLIB_FN (library
, png_read_update_info
);
5554 LOAD_IMGLIB_FN (library
, png_get_channels
);
5555 LOAD_IMGLIB_FN (library
, png_get_rowbytes
);
5556 LOAD_IMGLIB_FN (library
, png_read_image
);
5557 LOAD_IMGLIB_FN (library
, png_read_end
);
5558 LOAD_IMGLIB_FN (library
, png_error
);
5560 #if (PNG_LIBPNG_VER >= 10500)
5561 LOAD_IMGLIB_FN (library
, png_longjmp
);
5562 LOAD_IMGLIB_FN (library
, png_set_longjmp_fn
);
5563 #endif /* libpng version >= 1.5 */
5569 #define fn_png_get_io_ptr png_get_io_ptr
5570 #define fn_png_sig_cmp png_sig_cmp
5571 #define fn_png_create_read_struct png_create_read_struct
5572 #define fn_png_create_info_struct png_create_info_struct
5573 #define fn_png_destroy_read_struct png_destroy_read_struct
5574 #define fn_png_set_read_fn png_set_read_fn
5575 #define fn_png_set_sig_bytes png_set_sig_bytes
5576 #define fn_png_read_info png_read_info
5577 #define fn_png_get_IHDR png_get_IHDR
5578 #define fn_png_get_valid png_get_valid
5579 #define fn_png_set_strip_16 png_set_strip_16
5580 #define fn_png_set_expand png_set_expand
5581 #define fn_png_set_gray_to_rgb png_set_gray_to_rgb
5582 #define fn_png_set_background png_set_background
5583 #define fn_png_get_bKGD png_get_bKGD
5584 #define fn_png_read_update_info png_read_update_info
5585 #define fn_png_get_channels png_get_channels
5586 #define fn_png_get_rowbytes png_get_rowbytes
5587 #define fn_png_read_image png_read_image
5588 #define fn_png_read_end png_read_end
5589 #define fn_png_error png_error
5591 #if (PNG_LIBPNG_VER >= 10500)
5592 #define fn_png_longjmp png_longjmp
5593 #define fn_png_set_longjmp_fn png_set_longjmp_fn
5594 #endif /* libpng version >= 1.5 */
5596 #endif /* WINDOWSNT */
5598 /* Possibly inefficient/inexact substitutes for _setjmp and _longjmp.
5599 Do not use sys_setjmp, as PNG supports only jmp_buf. The _longjmp
5600 substitute may munge the signal mask, but that should be OK here.
5601 MinGW (MS-Windows) uses _setjmp and defines setjmp to _setjmp in
5602 the system header setjmp.h; don't mess up that. */
5603 #ifndef HAVE__SETJMP
5604 # define _setjmp(j) setjmp (j)
5605 # define _longjmp longjmp
5608 #if (PNG_LIBPNG_VER < 10500)
5609 #define PNG_LONGJMP(ptr) (_longjmp ((ptr)->jmpbuf, 1))
5610 #define PNG_JMPBUF(ptr) ((ptr)->jmpbuf)
5612 /* In libpng version 1.5, the jmpbuf member is hidden. (Bug#7908) */
5613 #define PNG_LONGJMP(ptr) (fn_png_longjmp ((ptr), 1))
5614 #define PNG_JMPBUF(ptr) \
5615 (*fn_png_set_longjmp_fn ((ptr), _longjmp, sizeof (jmp_buf)))
5618 /* Error and warning handlers installed when the PNG library
5621 static _Noreturn
void
5622 my_png_error (png_struct
*png_ptr
, const char *msg
)
5624 eassert (png_ptr
!= NULL
);
5625 /* Avoid compiler warning about deprecated direct access to
5626 png_ptr's fields in libpng versions 1.4.x. */
5627 image_error ("PNG error: %s", build_string (msg
), Qnil
);
5628 PNG_LONGJMP (png_ptr
);
5633 my_png_warning (png_struct
*png_ptr
, const char *msg
)
5635 eassert (png_ptr
!= NULL
);
5636 image_error ("PNG warning: %s", build_string (msg
), Qnil
);
5639 /* Memory source for PNG decoding. */
5641 struct png_memory_storage
5643 unsigned char *bytes
; /* The data */
5644 ptrdiff_t len
; /* How big is it? */
5645 ptrdiff_t index
; /* Where are we? */
5649 /* Function set as reader function when reading PNG image from memory.
5650 PNG_PTR is a pointer to the PNG control structure. Copy LENGTH
5651 bytes from the input to DATA. */
5654 png_read_from_memory (png_structp png_ptr
, png_bytep data
, png_size_t length
)
5656 struct png_memory_storage
*tbr
= fn_png_get_io_ptr (png_ptr
);
5658 if (length
> tbr
->len
- tbr
->index
)
5659 fn_png_error (png_ptr
, "Read error");
5661 memcpy (data
, tbr
->bytes
+ tbr
->index
, length
);
5662 tbr
->index
= tbr
->index
+ length
;
5666 /* Function set as reader function when reading PNG image from a file.
5667 PNG_PTR is a pointer to the PNG control structure. Copy LENGTH
5668 bytes from the input to DATA. */
5671 png_read_from_file (png_structp png_ptr
, png_bytep data
, png_size_t length
)
5673 FILE *fp
= fn_png_get_io_ptr (png_ptr
);
5675 if (fread (data
, 1, length
, fp
) < length
)
5676 fn_png_error (png_ptr
, "Read error");
5680 /* Load PNG image IMG for use on frame F. Value is true if
5683 struct png_load_context
5685 /* These are members so that longjmp doesn't munge local variables. */
5686 png_struct
*png_ptr
;
5695 png_load_body (struct frame
*f
, struct image
*img
, struct png_load_context
*c
)
5697 Lisp_Object file
, specified_file
;
5698 Lisp_Object specified_data
;
5701 XImagePtr ximg
, mask_img
= NULL
;
5702 png_struct
*png_ptr
;
5703 png_info
*info_ptr
= NULL
, *end_info
= NULL
;
5706 png_byte
*pixels
= NULL
;
5707 png_byte
**rows
= NULL
;
5708 png_uint_32 width
, height
;
5709 int bit_depth
, color_type
, interlace_type
;
5711 png_uint_32 row_bytes
;
5713 struct png_memory_storage tbr
; /* Data to be read */
5715 /* Find out what file to load. */
5716 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
5717 specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
5719 if (NILP (specified_data
))
5721 file
= x_find_image_file (specified_file
);
5722 if (!STRINGP (file
))
5724 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
5728 /* Open the image file. */
5729 fp
= emacs_fopen (SSDATA (file
), "rb");
5732 image_error ("Cannot open image file `%s'", file
, Qnil
);
5736 /* Check PNG signature. */
5737 if (fread (sig
, 1, sizeof sig
, fp
) != sizeof sig
5738 || fn_png_sig_cmp (sig
, 0, sizeof sig
))
5741 image_error ("Not a PNG file: `%s'", file
, Qnil
);
5747 if (!STRINGP (specified_data
))
5749 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
5753 /* Read from memory. */
5754 tbr
.bytes
= SDATA (specified_data
);
5755 tbr
.len
= SBYTES (specified_data
);
5758 /* Check PNG signature. */
5759 if (tbr
.len
< sizeof sig
5760 || fn_png_sig_cmp (tbr
.bytes
, 0, sizeof sig
))
5762 image_error ("Not a PNG image: `%s'", img
->spec
, Qnil
);
5766 /* Need to skip past the signature. */
5767 tbr
.bytes
+= sizeof (sig
);
5770 /* Initialize read and info structs for PNG lib. */
5771 png_ptr
= fn_png_create_read_struct (PNG_LIBPNG_VER_STRING
,
5776 info_ptr
= fn_png_create_info_struct (png_ptr
);
5777 end_info
= fn_png_create_info_struct (png_ptr
);
5780 c
->png_ptr
= png_ptr
;
5781 c
->info_ptr
= info_ptr
;
5782 c
->end_info
= end_info
;
5787 if (! (info_ptr
&& end_info
))
5789 fn_png_destroy_read_struct (&c
->png_ptr
, &c
->info_ptr
, &c
->end_info
);
5794 if (fp
) fclose (fp
);
5798 /* Set error jump-back. We come back here when the PNG library
5799 detects an error. */
5800 if (_setjmp (PNG_JMPBUF (png_ptr
)))
5804 fn_png_destroy_read_struct (&c
->png_ptr
, &c
->info_ptr
, &c
->end_info
);
5812 /* Silence a bogus diagnostic; see GCC bug 54561. */
5813 IF_LINT (fp
= c
->fp
);
5815 /* Read image info. */
5816 if (!NILP (specified_data
))
5817 fn_png_set_read_fn (png_ptr
, &tbr
, png_read_from_memory
);
5819 fn_png_set_read_fn (png_ptr
, fp
, png_read_from_file
);
5821 fn_png_set_sig_bytes (png_ptr
, sizeof sig
);
5822 fn_png_read_info (png_ptr
, info_ptr
);
5823 fn_png_get_IHDR (png_ptr
, info_ptr
, &width
, &height
, &bit_depth
, &color_type
,
5824 &interlace_type
, NULL
, NULL
);
5826 if (! (width
<= INT_MAX
&& height
<= INT_MAX
5827 && check_image_size (f
, width
, height
)))
5829 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
5833 /* Create the X image and pixmap now, so that the work below can be
5834 omitted if the image is too large for X. */
5835 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, 0, &ximg
, 0))
5838 /* If image contains simply transparency data, we prefer to
5839 construct a clipping mask. */
5840 if (fn_png_get_valid (png_ptr
, info_ptr
, PNG_INFO_tRNS
))
5845 /* This function is easier to write if we only have to handle
5846 one data format: RGB or RGBA with 8 bits per channel. Let's
5847 transform other formats into that format. */
5849 /* Strip more than 8 bits per channel. */
5850 if (bit_depth
== 16)
5851 fn_png_set_strip_16 (png_ptr
);
5853 /* Expand data to 24 bit RGB, or 8 bit grayscale, with alpha channel
5855 fn_png_set_expand (png_ptr
);
5857 /* Convert grayscale images to RGB. */
5858 if (color_type
== PNG_COLOR_TYPE_GRAY
5859 || color_type
== PNG_COLOR_TYPE_GRAY_ALPHA
)
5860 fn_png_set_gray_to_rgb (png_ptr
);
5862 /* Handle alpha channel by combining the image with a background
5863 color. Do this only if a real alpha channel is supplied. For
5864 simple transparency, we prefer a clipping mask. */
5867 /* png_color_16 *image_bg; */
5868 Lisp_Object specified_bg
5869 = image_spec_value (img
->spec
, QCbackground
, NULL
);
5870 int shift
= (bit_depth
== 16) ? 0 : 8;
5872 if (STRINGP (specified_bg
))
5873 /* The user specified `:background', use that. */
5876 if (x_defined_color (f
, SSDATA (specified_bg
), &color
, 0))
5878 png_color_16 user_bg
;
5880 memset (&user_bg
, 0, sizeof user_bg
);
5881 user_bg
.red
= color
.red
>> shift
;
5882 user_bg
.green
= color
.green
>> shift
;
5883 user_bg
.blue
= color
.blue
>> shift
;
5885 fn_png_set_background (png_ptr
, &user_bg
,
5886 PNG_BACKGROUND_GAMMA_SCREEN
, 0, 1.0);
5891 /* We use the current frame background, ignoring any default
5892 background color set by the image. */
5893 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI)
5895 png_color_16 frame_background
;
5897 color
.pixel
= FRAME_BACKGROUND_PIXEL (f
);
5898 x_query_color (f
, &color
);
5900 memset (&frame_background
, 0, sizeof frame_background
);
5901 frame_background
.red
= color
.red
>> shift
;
5902 frame_background
.green
= color
.green
>> shift
;
5903 frame_background
.blue
= color
.blue
>> shift
;
5904 #endif /* HAVE_X_WINDOWS */
5906 fn_png_set_background (png_ptr
, &frame_background
,
5907 PNG_BACKGROUND_GAMMA_SCREEN
, 0, 1.0);
5911 /* Update info structure. */
5912 fn_png_read_update_info (png_ptr
, info_ptr
);
5914 /* Get number of channels. Valid values are 1 for grayscale images
5915 and images with a palette, 2 for grayscale images with transparency
5916 information (alpha channel), 3 for RGB images, and 4 for RGB
5917 images with alpha channel, i.e. RGBA. If conversions above were
5918 sufficient we should only have 3 or 4 channels here. */
5919 channels
= fn_png_get_channels (png_ptr
, info_ptr
);
5920 eassert (channels
== 3 || channels
== 4);
5922 /* Number of bytes needed for one row of the image. */
5923 row_bytes
= fn_png_get_rowbytes (png_ptr
, info_ptr
);
5925 /* Allocate memory for the image. */
5926 if (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *rows
< height
5927 || min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *pixels
/ height
< row_bytes
)
5928 memory_full (SIZE_MAX
);
5929 c
->pixels
= pixels
= xmalloc (sizeof *pixels
* row_bytes
* height
);
5930 c
->rows
= rows
= xmalloc (height
* sizeof *rows
);
5931 for (i
= 0; i
< height
; ++i
)
5932 rows
[i
] = pixels
+ i
* row_bytes
;
5934 /* Read the entire image. */
5935 fn_png_read_image (png_ptr
, rows
);
5936 fn_png_read_end (png_ptr
, info_ptr
);
5943 /* Create an image and pixmap serving as mask if the PNG image
5944 contains an alpha channel. */
5947 && !image_create_x_image_and_pixmap (f
, img
, width
, height
, 1,
5950 x_destroy_x_image (ximg
);
5951 x_clear_image_1 (f
, img
, CLEAR_IMAGE_PIXMAP
);
5955 /* Fill the X image and mask from PNG data. */
5956 init_color_table ();
5958 for (y
= 0; y
< height
; ++y
)
5960 png_byte
*p
= rows
[y
];
5962 for (x
= 0; x
< width
; ++x
)
5969 XPutPixel (ximg
, x
, y
, lookup_rgb_color (f
, r
, g
, b
));
5970 /* An alpha channel, aka mask channel, associates variable
5971 transparency with an image. Where other image formats
5972 support binary transparency---fully transparent or fully
5973 opaque---PNG allows up to 254 levels of partial transparency.
5974 The PNG library implements partial transparency by combining
5975 the image with a specified background color.
5977 I'm not sure how to handle this here nicely: because the
5978 background on which the image is displayed may change, for
5979 real alpha channel support, it would be necessary to create
5980 a new image for each possible background.
5982 What I'm doing now is that a mask is created if we have
5983 boolean transparency information. Otherwise I'm using
5984 the frame's background color to combine the image with. */
5989 XPutPixel (mask_img
, x
, y
, *p
> 0 ? PIX_MASK_DRAW
: PIX_MASK_RETAIN
);
5995 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
5996 /* Set IMG's background color from the PNG image, unless the user
6000 if (fn_png_get_bKGD (png_ptr
, info_ptr
, &bg
))
6002 img
->background
= lookup_rgb_color (f
, bg
->red
, bg
->green
, bg
->blue
);
6003 img
->background_valid
= 1;
6007 #ifdef COLOR_TABLE_SUPPORT
6008 /* Remember colors allocated for this image. */
6009 img
->colors
= colors_in_color_table (&img
->ncolors
);
6010 free_color_table ();
6011 #endif /* COLOR_TABLE_SUPPORT */
6014 fn_png_destroy_read_struct (&c
->png_ptr
, &c
->info_ptr
, &c
->end_info
);
6019 img
->height
= height
;
6021 /* Maybe fill in the background field while we have ximg handy.
6022 Casting avoids a GCC warning. */
6023 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
6025 /* Put ximg into the image. */
6026 image_put_x_image (f
, img
, ximg
, 0);
6028 /* Same for the mask. */
6031 /* Fill in the background_transparent field while we have the
6032 mask handy. Casting avoids a GCC warning. */
6033 image_background_transparent (img
, f
, (XImagePtr_or_DC
)mask_img
);
6035 image_put_x_image (f
, img
, mask_img
, 1);
6042 png_load (struct frame
*f
, struct image
*img
)
6044 struct png_load_context c
;
6045 return png_load_body (f
, img
, &c
);
6048 #else /* HAVE_PNG */
6052 png_load (struct frame
*f
, struct image
*img
)
6054 return ns_load_image (f
, img
,
6055 image_spec_value (img
->spec
, QCfile
, NULL
),
6056 image_spec_value (img
->spec
, QCdata
, NULL
));
6058 #endif /* HAVE_NS */
6061 #endif /* !HAVE_PNG */
6065 /***********************************************************************
6067 ***********************************************************************/
6069 #if defined (HAVE_JPEG) || defined (HAVE_NS)
6071 static bool jpeg_image_p (Lisp_Object object
);
6072 static bool jpeg_load (struct frame
*f
, struct image
*img
);
6074 /* The symbol `jpeg' identifying images of this type. */
6076 static Lisp_Object Qjpeg
;
6078 /* Indices of image specification fields in gs_format, below. */
6080 enum jpeg_keyword_index
6089 JPEG_HEURISTIC_MASK
,
6095 /* Vector of image_keyword structures describing the format
6096 of valid user-defined image specifications. */
6098 static const struct image_keyword jpeg_format
[JPEG_LAST
] =
6100 {":type", IMAGE_SYMBOL_VALUE
, 1},
6101 {":data", IMAGE_STRING_VALUE
, 0},
6102 {":file", IMAGE_STRING_VALUE
, 0},
6103 {":ascent", IMAGE_ASCENT_VALUE
, 0},
6104 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
6105 {":relief", IMAGE_INTEGER_VALUE
, 0},
6106 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6107 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6108 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6109 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
6112 #if defined HAVE_NTGUI && defined WINDOWSNT
6113 static bool init_jpeg_functions (void);
6115 #define init_jpeg_functions NULL
6118 /* Structure describing the image type `jpeg'. */
6120 static struct image_type jpeg_type
=
6126 init_jpeg_functions
,
6130 /* Return true if OBJECT is a valid JPEG image specification. */
6133 jpeg_image_p (Lisp_Object object
)
6135 struct image_keyword fmt
[JPEG_LAST
];
6137 memcpy (fmt
, jpeg_format
, sizeof fmt
);
6139 if (!parse_image_spec (object
, fmt
, JPEG_LAST
, Qjpeg
))
6142 /* Must specify either the :data or :file keyword. */
6143 return fmt
[JPEG_FILE
].count
+ fmt
[JPEG_DATA
].count
== 1;
6146 #endif /* HAVE_JPEG || HAVE_NS */
6150 /* Work around a warning about HAVE_STDLIB_H being redefined in
6152 #ifdef HAVE_STDLIB_H
6153 #undef HAVE_STDLIB_H
6154 #endif /* HAVE_STLIB_H */
6156 #if defined (HAVE_NTGUI) && !defined (__WIN32__)
6157 /* In older releases of the jpeg library, jpeglib.h will define boolean
6158 differently depending on __WIN32__, so make sure it is defined. */
6162 /* rpcndr.h (via windows.h) and jpeglib.h both define boolean types.
6163 Some versions of jpeglib try to detect whether rpcndr.h is loaded,
6164 using the Windows boolean type instead of the jpeglib boolean type
6165 if so. Cygwin jpeglib, however, doesn't try to detect whether its
6166 headers are included along with windows.h, so under Cygwin, jpeglib
6167 attempts to define a conflicting boolean type. Worse, forcing
6168 Cygwin jpeglib headers to use the Windows boolean type doesn't work
6169 because it created an ABI incompatibility between the
6170 already-compiled jpeg library and the header interface definition.
6172 The best we can do is to define jpeglib's boolean type to a
6173 different name. This name, jpeg_boolean, remains in effect through
6174 the rest of image.c.
6176 #if defined CYGWIN && defined HAVE_NTGUI
6177 #define boolean jpeg_boolean
6179 #include <jpeglib.h>
6184 /* JPEG library details. */
6185 DEF_IMGLIB_FN (void, jpeg_CreateDecompress
, (j_decompress_ptr
, int, size_t));
6186 DEF_IMGLIB_FN (boolean
, jpeg_start_decompress
, (j_decompress_ptr
));
6187 DEF_IMGLIB_FN (boolean
, jpeg_finish_decompress
, (j_decompress_ptr
));
6188 DEF_IMGLIB_FN (void, jpeg_destroy_decompress
, (j_decompress_ptr
));
6189 DEF_IMGLIB_FN (int, jpeg_read_header
, (j_decompress_ptr
, boolean
));
6190 DEF_IMGLIB_FN (JDIMENSION
, jpeg_read_scanlines
, (j_decompress_ptr
, JSAMPARRAY
, JDIMENSION
));
6191 DEF_IMGLIB_FN (struct jpeg_error_mgr
*, jpeg_std_error
, (struct jpeg_error_mgr
*));
6192 DEF_IMGLIB_FN (boolean
, jpeg_resync_to_restart
, (j_decompress_ptr
, int));
6195 init_jpeg_functions (void)
6199 if (!(library
= w32_delayed_load (Qjpeg
)))
6202 LOAD_IMGLIB_FN (library
, jpeg_finish_decompress
);
6203 LOAD_IMGLIB_FN (library
, jpeg_read_scanlines
);
6204 LOAD_IMGLIB_FN (library
, jpeg_start_decompress
);
6205 LOAD_IMGLIB_FN (library
, jpeg_read_header
);
6206 LOAD_IMGLIB_FN (library
, jpeg_CreateDecompress
);
6207 LOAD_IMGLIB_FN (library
, jpeg_destroy_decompress
);
6208 LOAD_IMGLIB_FN (library
, jpeg_std_error
);
6209 LOAD_IMGLIB_FN (library
, jpeg_resync_to_restart
);
6213 /* Wrapper since we can't directly assign the function pointer
6214 to another function pointer that was declared more completely easily. */
6216 jpeg_resync_to_restart_wrapper (j_decompress_ptr cinfo
, int desired
)
6218 return fn_jpeg_resync_to_restart (cinfo
, desired
);
6223 #define fn_jpeg_CreateDecompress(a,b,c) jpeg_create_decompress (a)
6224 #define fn_jpeg_start_decompress jpeg_start_decompress
6225 #define fn_jpeg_finish_decompress jpeg_finish_decompress
6226 #define fn_jpeg_destroy_decompress jpeg_destroy_decompress
6227 #define fn_jpeg_read_header jpeg_read_header
6228 #define fn_jpeg_read_scanlines jpeg_read_scanlines
6229 #define fn_jpeg_std_error jpeg_std_error
6230 #define jpeg_resync_to_restart_wrapper jpeg_resync_to_restart
6232 #endif /* WINDOWSNT */
6234 struct my_jpeg_error_mgr
6236 struct jpeg_error_mgr pub
;
6237 sys_jmp_buf setjmp_buffer
;
6239 /* The remaining members are so that longjmp doesn't munge local
6241 struct jpeg_decompress_struct cinfo
;
6245 MY_JPEG_INVALID_IMAGE_SIZE
,
6246 MY_JPEG_CANNOT_CREATE_X
6254 static _Noreturn
void
6255 my_error_exit (j_common_ptr cinfo
)
6257 struct my_jpeg_error_mgr
*mgr
= (struct my_jpeg_error_mgr
*) cinfo
->err
;
6258 mgr
->failure_code
= MY_JPEG_ERROR_EXIT
;
6259 sys_longjmp (mgr
->setjmp_buffer
, 1);
6263 /* Init source method for JPEG data source manager. Called by
6264 jpeg_read_header() before any data is actually read. See
6265 libjpeg.doc from the JPEG lib distribution. */
6268 our_common_init_source (j_decompress_ptr cinfo
)
6273 /* Method to terminate data source. Called by
6274 jpeg_finish_decompress() after all data has been processed. */
6277 our_common_term_source (j_decompress_ptr cinfo
)
6282 /* Fill input buffer method for JPEG data source manager. Called
6283 whenever more data is needed. We read the whole image in one step,
6284 so this only adds a fake end of input marker at the end. */
6286 static JOCTET our_memory_buffer
[2];
6289 our_memory_fill_input_buffer (j_decompress_ptr cinfo
)
6291 /* Insert a fake EOI marker. */
6292 struct jpeg_source_mgr
*src
= cinfo
->src
;
6294 our_memory_buffer
[0] = (JOCTET
) 0xFF;
6295 our_memory_buffer
[1] = (JOCTET
) JPEG_EOI
;
6297 src
->next_input_byte
= our_memory_buffer
;
6298 src
->bytes_in_buffer
= 2;
6303 /* Method to skip over NUM_BYTES bytes in the image data. CINFO->src
6304 is the JPEG data source manager. */
6307 our_memory_skip_input_data (j_decompress_ptr cinfo
, long int num_bytes
)
6309 struct jpeg_source_mgr
*src
= cinfo
->src
;
6313 if (num_bytes
> src
->bytes_in_buffer
)
6314 ERREXIT (cinfo
, JERR_INPUT_EOF
);
6316 src
->bytes_in_buffer
-= num_bytes
;
6317 src
->next_input_byte
+= num_bytes
;
6322 /* Set up the JPEG lib for reading an image from DATA which contains
6323 LEN bytes. CINFO is the decompression info structure created for
6324 reading the image. */
6327 jpeg_memory_src (j_decompress_ptr cinfo
, JOCTET
*data
, ptrdiff_t len
)
6329 struct jpeg_source_mgr
*src
= cinfo
->src
;
6333 /* First time for this JPEG object? */
6334 src
= cinfo
->mem
->alloc_small ((j_common_ptr
) cinfo
,
6335 JPOOL_PERMANENT
, sizeof *src
);
6337 src
->next_input_byte
= data
;
6340 src
->init_source
= our_common_init_source
;
6341 src
->fill_input_buffer
= our_memory_fill_input_buffer
;
6342 src
->skip_input_data
= our_memory_skip_input_data
;
6343 src
->resync_to_restart
= jpeg_resync_to_restart_wrapper
; /* Use default method. */
6344 src
->term_source
= our_common_term_source
;
6345 src
->bytes_in_buffer
= len
;
6346 src
->next_input_byte
= data
;
6350 struct jpeg_stdio_mgr
6352 struct jpeg_source_mgr mgr
;
6359 /* Size of buffer to read JPEG from file.
6360 Not too big, as we want to use alloc_small. */
6361 #define JPEG_STDIO_BUFFER_SIZE 8192
6364 /* Fill input buffer method for JPEG data source manager. Called
6365 whenever more data is needed. The data is read from a FILE *. */
6368 our_stdio_fill_input_buffer (j_decompress_ptr cinfo
)
6370 struct jpeg_stdio_mgr
*src
;
6372 src
= (struct jpeg_stdio_mgr
*) cinfo
->src
;
6377 bytes
= fread (src
->buffer
, 1, JPEG_STDIO_BUFFER_SIZE
, src
->file
);
6379 src
->mgr
.bytes_in_buffer
= bytes
;
6382 WARNMS (cinfo
, JWRN_JPEG_EOF
);
6384 src
->buffer
[0] = (JOCTET
) 0xFF;
6385 src
->buffer
[1] = (JOCTET
) JPEG_EOI
;
6386 src
->mgr
.bytes_in_buffer
= 2;
6388 src
->mgr
.next_input_byte
= src
->buffer
;
6395 /* Method to skip over NUM_BYTES bytes in the image data. CINFO->src
6396 is the JPEG data source manager. */
6399 our_stdio_skip_input_data (j_decompress_ptr cinfo
, long int num_bytes
)
6401 struct jpeg_stdio_mgr
*src
;
6402 src
= (struct jpeg_stdio_mgr
*) cinfo
->src
;
6404 while (num_bytes
> 0 && !src
->finished
)
6406 if (num_bytes
<= src
->mgr
.bytes_in_buffer
)
6408 src
->mgr
.bytes_in_buffer
-= num_bytes
;
6409 src
->mgr
.next_input_byte
+= num_bytes
;
6414 num_bytes
-= src
->mgr
.bytes_in_buffer
;
6415 src
->mgr
.bytes_in_buffer
= 0;
6416 src
->mgr
.next_input_byte
= NULL
;
6418 our_stdio_fill_input_buffer (cinfo
);
6424 /* Set up the JPEG lib for reading an image from a FILE *.
6425 CINFO is the decompression info structure created for
6426 reading the image. */
6429 jpeg_file_src (j_decompress_ptr cinfo
, FILE *fp
)
6431 struct jpeg_stdio_mgr
*src
= (struct jpeg_stdio_mgr
*) cinfo
->src
;
6435 /* First time for this JPEG object? */
6436 src
= cinfo
->mem
->alloc_small ((j_common_ptr
) cinfo
,
6437 JPOOL_PERMANENT
, sizeof *src
);
6438 cinfo
->src
= (struct jpeg_source_mgr
*) src
;
6439 src
->buffer
= cinfo
->mem
->alloc_small ((j_common_ptr
) cinfo
,
6441 JPEG_STDIO_BUFFER_SIZE
);
6446 src
->mgr
.init_source
= our_common_init_source
;
6447 src
->mgr
.fill_input_buffer
= our_stdio_fill_input_buffer
;
6448 src
->mgr
.skip_input_data
= our_stdio_skip_input_data
;
6449 src
->mgr
.resync_to_restart
= jpeg_resync_to_restart_wrapper
; /* Use default method. */
6450 src
->mgr
.term_source
= our_common_term_source
;
6451 src
->mgr
.bytes_in_buffer
= 0;
6452 src
->mgr
.next_input_byte
= NULL
;
6456 /* Load image IMG for use on frame F. Patterned after example.c
6457 from the JPEG lib. */
6460 jpeg_load_body (struct frame
*f
, struct image
*img
,
6461 struct my_jpeg_error_mgr
*mgr
)
6463 Lisp_Object file
, specified_file
;
6464 Lisp_Object specified_data
;
6467 int row_stride
, x
, y
;
6468 XImagePtr ximg
= NULL
;
6469 unsigned long *colors
;
6472 /* Open the JPEG file. */
6473 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
6474 specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
6476 if (NILP (specified_data
))
6478 file
= x_find_image_file (specified_file
);
6479 if (!STRINGP (file
))
6481 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
6485 fp
= emacs_fopen (SSDATA (file
), "rb");
6488 image_error ("Cannot open `%s'", file
, Qnil
);
6492 else if (!STRINGP (specified_data
))
6494 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
6498 IF_LINT (mgr
->fp
= fp
);
6500 /* Customize libjpeg's error handling to call my_error_exit when an
6501 error is detected. This function will perform a longjmp. */
6502 mgr
->cinfo
.err
= fn_jpeg_std_error (&mgr
->pub
);
6503 mgr
->pub
.error_exit
= my_error_exit
;
6504 if (sys_setjmp (mgr
->setjmp_buffer
))
6506 switch (mgr
->failure_code
)
6508 case MY_JPEG_ERROR_EXIT
:
6510 char buf
[JMSG_LENGTH_MAX
];
6511 mgr
->cinfo
.err
->format_message ((j_common_ptr
) &mgr
->cinfo
, buf
);
6512 image_error ("Error reading JPEG image `%s': %s", img
->spec
,
6513 build_string (buf
));
6517 case MY_JPEG_INVALID_IMAGE_SIZE
:
6518 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
6521 case MY_JPEG_CANNOT_CREATE_X
:
6525 /* Close the input file and destroy the JPEG object. */
6528 fn_jpeg_destroy_decompress (&mgr
->cinfo
);
6530 /* If we already have an XImage, free that. */
6531 x_destroy_x_image (ximg
);
6533 /* Free pixmap and colors. */
6534 x_clear_image (f
, img
);
6538 /* Silence a bogus diagnostic; see GCC bug 54561. */
6539 IF_LINT (fp
= mgr
->fp
);
6541 /* Create the JPEG decompression object. Let it read from fp.
6542 Read the JPEG image header. */
6543 fn_jpeg_CreateDecompress (&mgr
->cinfo
, JPEG_LIB_VERSION
, sizeof *&mgr
->cinfo
);
6545 if (NILP (specified_data
))
6546 jpeg_file_src (&mgr
->cinfo
, fp
);
6548 jpeg_memory_src (&mgr
->cinfo
, SDATA (specified_data
),
6549 SBYTES (specified_data
));
6551 fn_jpeg_read_header (&mgr
->cinfo
, 1);
6553 /* Customize decompression so that color quantization will be used.
6554 Start decompression. */
6555 mgr
->cinfo
.quantize_colors
= 1;
6556 fn_jpeg_start_decompress (&mgr
->cinfo
);
6557 width
= img
->width
= mgr
->cinfo
.output_width
;
6558 height
= img
->height
= mgr
->cinfo
.output_height
;
6560 if (!check_image_size (f
, width
, height
))
6562 mgr
->failure_code
= MY_JPEG_INVALID_IMAGE_SIZE
;
6563 sys_longjmp (mgr
->setjmp_buffer
, 1);
6566 /* Create X image and pixmap. */
6567 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, 0, &ximg
, 0))
6569 mgr
->failure_code
= MY_JPEG_CANNOT_CREATE_X
;
6570 sys_longjmp (mgr
->setjmp_buffer
, 1);
6573 /* Allocate colors. When color quantization is used,
6574 mgr->cinfo.actual_number_of_colors has been set with the number of
6575 colors generated, and mgr->cinfo.colormap is a two-dimensional array
6576 of color indices in the range 0..mgr->cinfo.actual_number_of_colors.
6577 No more than 255 colors will be generated. */
6581 if (mgr
->cinfo
.out_color_components
> 2)
6582 ir
= 0, ig
= 1, ib
= 2;
6583 else if (mgr
->cinfo
.out_color_components
> 1)
6584 ir
= 0, ig
= 1, ib
= 0;
6586 ir
= 0, ig
= 0, ib
= 0;
6588 /* Use the color table mechanism because it handles colors that
6589 cannot be allocated nicely. Such colors will be replaced with
6590 a default color, and we don't have to care about which colors
6591 can be freed safely, and which can't. */
6592 init_color_table ();
6593 colors
= alloca (mgr
->cinfo
.actual_number_of_colors
* sizeof *colors
);
6595 for (i
= 0; i
< mgr
->cinfo
.actual_number_of_colors
; ++i
)
6597 /* Multiply RGB values with 255 because X expects RGB values
6598 in the range 0..0xffff. */
6599 int r
= mgr
->cinfo
.colormap
[ir
][i
] << 8;
6600 int g
= mgr
->cinfo
.colormap
[ig
][i
] << 8;
6601 int b
= mgr
->cinfo
.colormap
[ib
][i
] << 8;
6602 colors
[i
] = lookup_rgb_color (f
, r
, g
, b
);
6605 #ifdef COLOR_TABLE_SUPPORT
6606 /* Remember those colors actually allocated. */
6607 img
->colors
= colors_in_color_table (&img
->ncolors
);
6608 free_color_table ();
6609 #endif /* COLOR_TABLE_SUPPORT */
6613 row_stride
= width
* mgr
->cinfo
.output_components
;
6614 buffer
= mgr
->cinfo
.mem
->alloc_sarray ((j_common_ptr
) &mgr
->cinfo
,
6615 JPOOL_IMAGE
, row_stride
, 1);
6616 for (y
= 0; y
< height
; ++y
)
6618 fn_jpeg_read_scanlines (&mgr
->cinfo
, buffer
, 1);
6619 for (x
= 0; x
< mgr
->cinfo
.output_width
; ++x
)
6620 XPutPixel (ximg
, x
, y
, colors
[buffer
[0][x
]]);
6624 fn_jpeg_finish_decompress (&mgr
->cinfo
);
6625 fn_jpeg_destroy_decompress (&mgr
->cinfo
);
6629 /* Maybe fill in the background field while we have ximg handy. */
6630 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
6631 /* Casting avoids a GCC warning. */
6632 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
6634 /* Put ximg into the image. */
6635 image_put_x_image (f
, img
, ximg
, 0);
6640 jpeg_load (struct frame
*f
, struct image
*img
)
6642 struct my_jpeg_error_mgr mgr
;
6643 return jpeg_load_body (f
, img
, &mgr
);
6646 #else /* HAVE_JPEG */
6650 jpeg_load (struct frame
*f
, struct image
*img
)
6652 return ns_load_image (f
, img
,
6653 image_spec_value (img
->spec
, QCfile
, NULL
),
6654 image_spec_value (img
->spec
, QCdata
, NULL
));
6656 #endif /* HAVE_NS */
6658 #endif /* !HAVE_JPEG */
6662 /***********************************************************************
6664 ***********************************************************************/
6666 #if defined (HAVE_TIFF) || defined (HAVE_NS)
6668 static bool tiff_image_p (Lisp_Object object
);
6669 static bool tiff_load (struct frame
*f
, struct image
*img
);
6671 /* The symbol `tiff' identifying images of this type. */
6673 static Lisp_Object Qtiff
;
6675 /* Indices of image specification fields in tiff_format, below. */
6677 enum tiff_keyword_index
6686 TIFF_HEURISTIC_MASK
,
6693 /* Vector of image_keyword structures describing the format
6694 of valid user-defined image specifications. */
6696 static const struct image_keyword tiff_format
[TIFF_LAST
] =
6698 {":type", IMAGE_SYMBOL_VALUE
, 1},
6699 {":data", IMAGE_STRING_VALUE
, 0},
6700 {":file", IMAGE_STRING_VALUE
, 0},
6701 {":ascent", IMAGE_ASCENT_VALUE
, 0},
6702 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
6703 {":relief", IMAGE_INTEGER_VALUE
, 0},
6704 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6705 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6706 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6707 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0},
6708 {":index", IMAGE_NON_NEGATIVE_INTEGER_VALUE
, 0}
6711 #if defined HAVE_NTGUI && defined WINDOWSNT
6712 static bool init_tiff_functions (void);
6714 #define init_tiff_functions NULL
6717 /* Structure describing the image type `tiff'. */
6719 static struct image_type tiff_type
=
6725 init_tiff_functions
,
6729 /* Return true if OBJECT is a valid TIFF image specification. */
6732 tiff_image_p (Lisp_Object object
)
6734 struct image_keyword fmt
[TIFF_LAST
];
6735 memcpy (fmt
, tiff_format
, sizeof fmt
);
6737 if (!parse_image_spec (object
, fmt
, TIFF_LAST
, Qtiff
))
6740 /* Must specify either the :data or :file keyword. */
6741 return fmt
[TIFF_FILE
].count
+ fmt
[TIFF_DATA
].count
== 1;
6744 #endif /* HAVE_TIFF || HAVE_NS */
6752 /* TIFF library details. */
6753 DEF_IMGLIB_FN (TIFFErrorHandler
, TIFFSetErrorHandler
, (TIFFErrorHandler
));
6754 DEF_IMGLIB_FN (TIFFErrorHandler
, TIFFSetWarningHandler
, (TIFFErrorHandler
));
6755 DEF_IMGLIB_FN (TIFF
*, TIFFOpen
, (const char *, const char *));
6756 DEF_IMGLIB_FN (TIFF
*, TIFFClientOpen
, (const char *, const char *, thandle_t
,
6757 TIFFReadWriteProc
, TIFFReadWriteProc
,
6758 TIFFSeekProc
, TIFFCloseProc
, TIFFSizeProc
,
6759 TIFFMapFileProc
, TIFFUnmapFileProc
));
6760 DEF_IMGLIB_FN (int, TIFFGetField
, (TIFF
*, ttag_t
, ...));
6761 DEF_IMGLIB_FN (int, TIFFReadRGBAImage
, (TIFF
*, uint32
, uint32
, uint32
*, int));
6762 DEF_IMGLIB_FN (void, TIFFClose
, (TIFF
*));
6763 DEF_IMGLIB_FN (int, TIFFSetDirectory
, (TIFF
*, tdir_t
));
6766 init_tiff_functions (void)
6770 if (!(library
= w32_delayed_load (Qtiff
)))
6773 LOAD_IMGLIB_FN (library
, TIFFSetErrorHandler
);
6774 LOAD_IMGLIB_FN (library
, TIFFSetWarningHandler
);
6775 LOAD_IMGLIB_FN (library
, TIFFOpen
);
6776 LOAD_IMGLIB_FN (library
, TIFFClientOpen
);
6777 LOAD_IMGLIB_FN (library
, TIFFGetField
);
6778 LOAD_IMGLIB_FN (library
, TIFFReadRGBAImage
);
6779 LOAD_IMGLIB_FN (library
, TIFFClose
);
6780 LOAD_IMGLIB_FN (library
, TIFFSetDirectory
);
6786 #define fn_TIFFSetErrorHandler TIFFSetErrorHandler
6787 #define fn_TIFFSetWarningHandler TIFFSetWarningHandler
6788 #define fn_TIFFOpen TIFFOpen
6789 #define fn_TIFFClientOpen TIFFClientOpen
6790 #define fn_TIFFGetField TIFFGetField
6791 #define fn_TIFFReadRGBAImage TIFFReadRGBAImage
6792 #define fn_TIFFClose TIFFClose
6793 #define fn_TIFFSetDirectory TIFFSetDirectory
6794 #endif /* WINDOWSNT */
6797 /* Reading from a memory buffer for TIFF images Based on the PNG
6798 memory source, but we have to provide a lot of extra functions.
6801 We really only need to implement read and seek, but I am not
6802 convinced that the TIFF library is smart enough not to destroy
6803 itself if we only hand it the function pointers we need to
6808 unsigned char *bytes
;
6815 tiff_read_from_memory (thandle_t data
, tdata_t buf
, tsize_t size
)
6817 tiff_memory_source
*src
= (tiff_memory_source
*) data
;
6819 size
= min (size
, src
->len
- src
->index
);
6820 memcpy (buf
, src
->bytes
+ src
->index
, size
);
6826 tiff_write_from_memory (thandle_t data
, tdata_t buf
, tsize_t size
)
6832 tiff_seek_in_memory (thandle_t data
, toff_t off
, int whence
)
6834 tiff_memory_source
*src
= (tiff_memory_source
*) data
;
6839 case SEEK_SET
: /* Go from beginning of source. */
6843 case SEEK_END
: /* Go from end of source. */
6844 idx
= src
->len
+ off
;
6847 case SEEK_CUR
: /* Go from current position. */
6848 idx
= src
->index
+ off
;
6851 default: /* Invalid `whence'. */
6855 if (idx
> src
->len
|| idx
< 0)
6863 tiff_close_memory (thandle_t data
)
6870 tiff_mmap_memory (thandle_t data
, tdata_t
*pbase
, toff_t
*psize
)
6872 /* It is already _IN_ memory. */
6877 tiff_unmap_memory (thandle_t data
, tdata_t base
, toff_t size
)
6879 /* We don't need to do this. */
6883 tiff_size_of_memory (thandle_t data
)
6885 return ((tiff_memory_source
*) data
)->len
;
6888 /* GCC 3.x on x86 Windows targets has a bug that triggers an internal
6889 compiler error compiling tiff_handler, see Bugzilla bug #17406
6890 (http://gcc.gnu.org/bugzilla/show_bug.cgi?id=17406). Declaring
6891 this function as external works around that problem. */
6892 #if defined (__MINGW32__) && __GNUC__ == 3
6893 # define MINGW_STATIC
6895 # define MINGW_STATIC static
6899 tiff_handler (const char *, const char *, const char *, va_list)
6900 ATTRIBUTE_FORMAT_PRINTF (3, 0);
6902 tiff_handler (const char *log_format
, const char *title
,
6903 const char *format
, va_list ap
)
6905 /* doprnt is not suitable here, as TIFF handlers are called from
6906 libtiff and are passed arbitrary printf directives. Instead, use
6907 vsnprintf, taking care to be portable to nonstandard environments
6908 where vsnprintf returns -1 on buffer overflow. Since it's just a
6909 log entry, it's OK to truncate it. */
6911 int len
= vsnprintf (buf
, sizeof buf
, format
, ap
);
6912 add_to_log (log_format
, build_string (title
),
6913 make_string (buf
, max (0, min (len
, sizeof buf
- 1))));
6917 static void tiff_error_handler (const char *, const char *, va_list)
6918 ATTRIBUTE_FORMAT_PRINTF (2, 0);
6920 tiff_error_handler (const char *title
, const char *format
, va_list ap
)
6922 tiff_handler ("TIFF error: %s %s", title
, format
, ap
);
6926 static void tiff_warning_handler (const char *, const char *, va_list)
6927 ATTRIBUTE_FORMAT_PRINTF (2, 0);
6929 tiff_warning_handler (const char *title
, const char *format
, va_list ap
)
6931 tiff_handler ("TIFF warning: %s %s", title
, format
, ap
);
6935 /* Load TIFF image IMG for use on frame F. Value is true if
6939 tiff_load (struct frame
*f
, struct image
*img
)
6941 Lisp_Object file
, specified_file
;
6942 Lisp_Object specified_data
;
6944 int width
, height
, x
, y
, count
;
6948 tiff_memory_source memsrc
;
6951 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
6952 specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
6954 fn_TIFFSetErrorHandler ((TIFFErrorHandler
) tiff_error_handler
);
6955 fn_TIFFSetWarningHandler ((TIFFErrorHandler
) tiff_warning_handler
);
6957 if (NILP (specified_data
))
6959 /* Read from a file */
6960 file
= x_find_image_file (specified_file
);
6961 if (!STRINGP (file
))
6963 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
6967 /* Try to open the image file. */
6968 tiff
= fn_TIFFOpen (SSDATA (file
), "r");
6971 image_error ("Cannot open `%s'", file
, Qnil
);
6977 if (!STRINGP (specified_data
))
6979 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
6983 /* Memory source! */
6984 memsrc
.bytes
= SDATA (specified_data
);
6985 memsrc
.len
= SBYTES (specified_data
);
6988 tiff
= fn_TIFFClientOpen ("memory_source", "r", (thandle_t
)&memsrc
,
6989 tiff_read_from_memory
,
6990 tiff_write_from_memory
,
6991 tiff_seek_in_memory
,
6993 tiff_size_of_memory
,
6999 image_error ("Cannot open memory source for `%s'", img
->spec
, Qnil
);
7004 image
= image_spec_value (img
->spec
, QCindex
, NULL
);
7005 if (INTEGERP (image
))
7007 EMACS_INT ino
= XFASTINT (image
);
7008 if (! (TYPE_MINIMUM (tdir_t
) <= ino
&& ino
<= TYPE_MAXIMUM (tdir_t
)
7009 && fn_TIFFSetDirectory (tiff
, ino
)))
7011 image_error ("Invalid image number `%s' in image `%s'",
7013 fn_TIFFClose (tiff
);
7018 /* Get width and height of the image, and allocate a raster buffer
7019 of width x height 32-bit values. */
7020 fn_TIFFGetField (tiff
, TIFFTAG_IMAGEWIDTH
, &width
);
7021 fn_TIFFGetField (tiff
, TIFFTAG_IMAGELENGTH
, &height
);
7023 if (!check_image_size (f
, width
, height
))
7025 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
7026 fn_TIFFClose (tiff
);
7030 /* Create the X image and pixmap. */
7031 if (! (height
<= min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *buf
/ width
7032 && image_create_x_image_and_pixmap (f
, img
, width
, height
, 0,
7035 fn_TIFFClose (tiff
);
7039 buf
= xmalloc (sizeof *buf
* width
* height
);
7041 rc
= fn_TIFFReadRGBAImage (tiff
, width
, height
, buf
, 0);
7043 /* Count the number of images in the file. */
7044 for (count
= 1; fn_TIFFSetDirectory (tiff
, count
); count
++)
7048 img
->lisp_data
= Fcons (Qcount
,
7049 Fcons (make_number (count
),
7052 fn_TIFFClose (tiff
);
7055 image_error ("Error reading TIFF image `%s'", img
->spec
, Qnil
);
7060 /* Initialize the color table. */
7061 init_color_table ();
7063 /* Process the pixel raster. Origin is in the lower-left corner. */
7064 for (y
= 0; y
< height
; ++y
)
7066 uint32
*row
= buf
+ y
* width
;
7068 for (x
= 0; x
< width
; ++x
)
7070 uint32 abgr
= row
[x
];
7071 int r
= TIFFGetR (abgr
) << 8;
7072 int g
= TIFFGetG (abgr
) << 8;
7073 int b
= TIFFGetB (abgr
) << 8;
7074 XPutPixel (ximg
, x
, height
- 1 - y
, lookup_rgb_color (f
, r
, g
, b
));
7078 #ifdef COLOR_TABLE_SUPPORT
7079 /* Remember the colors allocated for the image. Free the color table. */
7080 img
->colors
= colors_in_color_table (&img
->ncolors
);
7081 free_color_table ();
7082 #endif /* COLOR_TABLE_SUPPORT */
7085 img
->height
= height
;
7087 /* Maybe fill in the background field while we have ximg handy. */
7088 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
7089 /* Casting avoids a GCC warning on W32. */
7090 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
7092 /* Put ximg into the image. */
7093 image_put_x_image (f
, img
, ximg
, 0);
7099 #else /* HAVE_TIFF */
7103 tiff_load (struct frame
*f
, struct image
*img
)
7105 return ns_load_image (f
, img
,
7106 image_spec_value (img
->spec
, QCfile
, NULL
),
7107 image_spec_value (img
->spec
, QCdata
, NULL
));
7109 #endif /* HAVE_NS */
7111 #endif /* !HAVE_TIFF */
7115 /***********************************************************************
7117 ***********************************************************************/
7119 #if defined (HAVE_GIF) || defined (HAVE_NS)
7121 static bool gif_image_p (Lisp_Object object
);
7122 static bool gif_load (struct frame
*f
, struct image
*img
);
7123 static void gif_clear_image (struct frame
*f
, struct image
*img
);
7125 /* The symbol `gif' identifying images of this type. */
7127 static Lisp_Object Qgif
;
7129 /* Indices of image specification fields in gif_format, below. */
7131 enum gif_keyword_index
7147 /* Vector of image_keyword structures describing the format
7148 of valid user-defined image specifications. */
7150 static const struct image_keyword gif_format
[GIF_LAST
] =
7152 {":type", IMAGE_SYMBOL_VALUE
, 1},
7153 {":data", IMAGE_STRING_VALUE
, 0},
7154 {":file", IMAGE_STRING_VALUE
, 0},
7155 {":ascent", IMAGE_ASCENT_VALUE
, 0},
7156 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
7157 {":relief", IMAGE_INTEGER_VALUE
, 0},
7158 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7159 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7160 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7161 {":index", IMAGE_NON_NEGATIVE_INTEGER_VALUE
, 0},
7162 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
7165 #if defined HAVE_NTGUI && defined WINDOWSNT
7166 static bool init_gif_functions (void);
7168 #define init_gif_functions NULL
7171 /* Structure describing the image type `gif'. */
7173 static struct image_type gif_type
=
7183 /* Free X resources of GIF image IMG which is used on frame F. */
7186 gif_clear_image (struct frame
*f
, struct image
*img
)
7188 img
->lisp_data
= Qnil
;
7189 x_clear_image (f
, img
);
7192 /* Return true if OBJECT is a valid GIF image specification. */
7195 gif_image_p (Lisp_Object object
)
7197 struct image_keyword fmt
[GIF_LAST
];
7198 memcpy (fmt
, gif_format
, sizeof fmt
);
7200 if (!parse_image_spec (object
, fmt
, GIF_LAST
, Qgif
))
7203 /* Must specify either the :data or :file keyword. */
7204 return fmt
[GIF_FILE
].count
+ fmt
[GIF_DATA
].count
== 1;
7207 #endif /* HAVE_GIF */
7211 #if defined (HAVE_NTGUI)
7212 /* winuser.h might define DrawText to DrawTextA or DrawTextW.
7213 Undefine before redefining to avoid a preprocessor warning. */
7217 /* avoid conflict with QuickdrawText.h */
7218 #define DrawText gif_DrawText
7219 #include <gif_lib.h>
7222 #else /* HAVE_NTGUI */
7224 #include <gif_lib.h>
7226 #endif /* HAVE_NTGUI */
7231 /* GIF library details. */
7232 DEF_IMGLIB_FN (int, DGifCloseFile
, (GifFileType
*));
7233 DEF_IMGLIB_FN (int, DGifSlurp
, (GifFileType
*));
7234 DEF_IMGLIB_FN (GifFileType
*, DGifOpen
, (void *, InputFunc
));
7235 DEF_IMGLIB_FN (GifFileType
*, DGifOpenFileName
, (const char *));
7238 init_gif_functions (void)
7242 if (!(library
= w32_delayed_load (Qgif
)))
7245 LOAD_IMGLIB_FN (library
, DGifCloseFile
);
7246 LOAD_IMGLIB_FN (library
, DGifSlurp
);
7247 LOAD_IMGLIB_FN (library
, DGifOpen
);
7248 LOAD_IMGLIB_FN (library
, DGifOpenFileName
);
7254 #define fn_DGifCloseFile DGifCloseFile
7255 #define fn_DGifSlurp DGifSlurp
7256 #define fn_DGifOpen DGifOpen
7257 #define fn_DGifOpenFileName DGifOpenFileName
7259 #endif /* WINDOWSNT */
7261 /* Reading a GIF image from memory
7262 Based on the PNG memory stuff to a certain extent. */
7266 unsigned char *bytes
;
7272 /* Make the current memory source available to gif_read_from_memory.
7273 It's done this way because not all versions of libungif support
7274 a UserData field in the GifFileType structure. */
7275 static gif_memory_source
*current_gif_memory_src
;
7278 gif_read_from_memory (GifFileType
*file
, GifByteType
*buf
, int len
)
7280 gif_memory_source
*src
= current_gif_memory_src
;
7282 if (len
> src
->len
- src
->index
)
7285 memcpy (buf
, src
->bytes
+ src
->index
, len
);
7291 /* Load GIF image IMG for use on frame F. Value is true if
7294 static const int interlace_start
[] = {0, 4, 2, 1};
7295 static const int interlace_increment
[] = {8, 8, 4, 2};
7297 #define GIF_LOCAL_DESCRIPTOR_EXTENSION 249
7300 gif_load (struct frame
*f
, struct image
*img
)
7303 int rc
, width
, height
, x
, y
, i
, j
;
7305 ColorMapObject
*gif_color_map
;
7306 unsigned long pixel_colors
[256];
7308 gif_memory_source memsrc
;
7309 Lisp_Object specified_bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
7310 Lisp_Object specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
7311 Lisp_Object specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
7312 unsigned long bgcolor
= 0;
7315 if (NILP (specified_data
))
7317 file
= x_find_image_file (specified_file
);
7318 if (!STRINGP (file
))
7320 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
7324 /* Open the GIF file. */
7325 gif
= fn_DGifOpenFileName (SSDATA (file
));
7328 image_error ("Cannot open `%s'", file
, Qnil
);
7334 if (!STRINGP (specified_data
))
7336 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
7340 /* Read from memory! */
7341 current_gif_memory_src
= &memsrc
;
7342 memsrc
.bytes
= SDATA (specified_data
);
7343 memsrc
.len
= SBYTES (specified_data
);
7346 gif
= fn_DGifOpen (&memsrc
, gif_read_from_memory
);
7349 image_error ("Cannot open memory source `%s'", img
->spec
, Qnil
);
7354 /* Before reading entire contents, check the declared image size. */
7355 if (!check_image_size (f
, gif
->SWidth
, gif
->SHeight
))
7357 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
7358 fn_DGifCloseFile (gif
);
7362 /* Read entire contents. */
7363 rc
= fn_DGifSlurp (gif
);
7364 if (rc
== GIF_ERROR
|| gif
->ImageCount
<= 0)
7366 image_error ("Error reading `%s'", img
->spec
, Qnil
);
7367 fn_DGifCloseFile (gif
);
7371 /* Which sub-image are we to display? */
7373 Lisp_Object image_number
= image_spec_value (img
->spec
, QCindex
, NULL
);
7374 idx
= INTEGERP (image_number
) ? XFASTINT (image_number
) : 0;
7375 if (idx
< 0 || idx
>= gif
->ImageCount
)
7377 image_error ("Invalid image number `%s' in image `%s'",
7378 image_number
, img
->spec
);
7379 fn_DGifCloseFile (gif
);
7384 width
= img
->width
= gif
->SWidth
;
7385 height
= img
->height
= gif
->SHeight
;
7387 img
->corners
[TOP_CORNER
] = gif
->SavedImages
[0].ImageDesc
.Top
;
7388 img
->corners
[LEFT_CORNER
] = gif
->SavedImages
[0].ImageDesc
.Left
;
7389 img
->corners
[BOT_CORNER
]
7390 = img
->corners
[TOP_CORNER
] + gif
->SavedImages
[0].ImageDesc
.Height
;
7391 img
->corners
[RIGHT_CORNER
]
7392 = img
->corners
[LEFT_CORNER
] + gif
->SavedImages
[0].ImageDesc
.Width
;
7394 if (!check_image_size (f
, width
, height
))
7396 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
7397 fn_DGifCloseFile (gif
);
7401 /* Check that the selected subimages fit. It's not clear whether
7402 the GIF spec requires this, but Emacs can crash if they don't fit. */
7403 for (j
= 0; j
<= idx
; ++j
)
7405 struct SavedImage
*subimage
= gif
->SavedImages
+ j
;
7406 int subimg_width
= subimage
->ImageDesc
.Width
;
7407 int subimg_height
= subimage
->ImageDesc
.Height
;
7408 int subimg_top
= subimage
->ImageDesc
.Top
;
7409 int subimg_left
= subimage
->ImageDesc
.Left
;
7410 if (! (0 <= subimg_width
&& 0 <= subimg_height
7411 && 0 <= subimg_top
&& subimg_top
<= height
- subimg_height
7412 && 0 <= subimg_left
&& subimg_left
<= width
- subimg_width
))
7414 image_error ("Subimage does not fit in image", Qnil
, Qnil
);
7415 fn_DGifCloseFile (gif
);
7420 /* Create the X image and pixmap. */
7421 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, 0, &ximg
, 0))
7423 fn_DGifCloseFile (gif
);
7427 /* Clear the part of the screen image not covered by the image.
7428 Full animated GIF support requires more here (see the gif89 spec,
7429 disposal methods). Let's simply assume that the part not covered
7430 by a sub-image is in the frame's background color. */
7431 for (y
= 0; y
< img
->corners
[TOP_CORNER
]; ++y
)
7432 for (x
= 0; x
< width
; ++x
)
7433 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7435 for (y
= img
->corners
[BOT_CORNER
]; y
< height
; ++y
)
7436 for (x
= 0; x
< width
; ++x
)
7437 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7439 for (y
= img
->corners
[TOP_CORNER
]; y
< img
->corners
[BOT_CORNER
]; ++y
)
7441 for (x
= 0; x
< img
->corners
[LEFT_CORNER
]; ++x
)
7442 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7443 for (x
= img
->corners
[RIGHT_CORNER
]; x
< width
; ++x
)
7444 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7447 /* Read the GIF image into the X image. */
7449 /* FIXME: With the current implementation, loading an animated gif
7450 is quadratic in the number of animation frames, since each frame
7451 is a separate struct image. We must provide a way for a single
7452 gif_load call to construct and save all animation frames. */
7454 init_color_table ();
7455 if (STRINGP (specified_bg
))
7456 bgcolor
= x_alloc_image_color (f
, img
, specified_bg
,
7457 FRAME_BACKGROUND_PIXEL (f
));
7458 for (j
= 0; j
<= idx
; ++j
)
7460 /* We use a local variable `raster' here because RasterBits is a
7461 char *, which invites problems with bytes >= 0x80. */
7462 struct SavedImage
*subimage
= gif
->SavedImages
+ j
;
7463 unsigned char *raster
= (unsigned char *) subimage
->RasterBits
;
7464 int transparency_color_index
= -1;
7466 int subimg_width
= subimage
->ImageDesc
.Width
;
7467 int subimg_height
= subimage
->ImageDesc
.Height
;
7468 int subimg_top
= subimage
->ImageDesc
.Top
;
7469 int subimg_left
= subimage
->ImageDesc
.Left
;
7471 /* Find the Graphic Control Extension block for this sub-image.
7472 Extract the disposal method and transparency color. */
7473 for (i
= 0; i
< subimage
->ExtensionBlockCount
; i
++)
7475 ExtensionBlock
*extblock
= subimage
->ExtensionBlocks
+ i
;
7477 if ((extblock
->Function
== GIF_LOCAL_DESCRIPTOR_EXTENSION
)
7478 && extblock
->ByteCount
== 4
7479 && extblock
->Bytes
[0] & 1)
7481 /* From gif89a spec: 1 = "keep in place", 2 = "restore
7482 to background". Treat any other value like 2. */
7483 disposal
= (extblock
->Bytes
[0] >> 2) & 7;
7484 transparency_color_index
= (unsigned char) extblock
->Bytes
[3];
7489 /* We can't "keep in place" the first subimage. */
7493 /* For disposal == 0, the spec says "No disposal specified. The
7494 decoder is not required to take any action." In practice, it
7495 seems we need to treat this like "keep in place", see e.g.
7496 http://upload.wikimedia.org/wikipedia/commons/3/37/Clock.gif */
7500 /* Allocate subimage colors. */
7501 memset (pixel_colors
, 0, sizeof pixel_colors
);
7502 gif_color_map
= subimage
->ImageDesc
.ColorMap
;
7504 gif_color_map
= gif
->SColorMap
;
7507 for (i
= 0; i
< gif_color_map
->ColorCount
; ++i
)
7509 if (transparency_color_index
== i
)
7510 pixel_colors
[i
] = STRINGP (specified_bg
)
7511 ? bgcolor
: FRAME_BACKGROUND_PIXEL (f
);
7514 int r
= gif_color_map
->Colors
[i
].Red
<< 8;
7515 int g
= gif_color_map
->Colors
[i
].Green
<< 8;
7516 int b
= gif_color_map
->Colors
[i
].Blue
<< 8;
7517 pixel_colors
[i
] = lookup_rgb_color (f
, r
, g
, b
);
7521 /* Apply the pixel values. */
7522 if (gif
->SavedImages
[j
].ImageDesc
.Interlace
)
7526 for (y
= 0, row
= interlace_start
[0], pass
= 0;
7528 y
++, row
+= interlace_increment
[pass
])
7530 while (subimg_height
<= row
)
7532 lint_assume (pass
< 3);
7533 row
= interlace_start
[++pass
];
7536 for (x
= 0; x
< subimg_width
; x
++)
7538 int c
= raster
[y
* subimg_width
+ x
];
7539 if (transparency_color_index
!= c
|| disposal
!= 1)
7540 XPutPixel (ximg
, x
+ subimg_left
, row
+ subimg_top
,
7547 for (y
= 0; y
< subimg_height
; ++y
)
7548 for (x
= 0; x
< subimg_width
; ++x
)
7550 int c
= raster
[y
* subimg_width
+ x
];
7551 if (transparency_color_index
!= c
|| disposal
!= 1)
7552 XPutPixel (ximg
, x
+ subimg_left
, y
+ subimg_top
,
7558 #ifdef COLOR_TABLE_SUPPORT
7559 img
->colors
= colors_in_color_table (&img
->ncolors
);
7560 free_color_table ();
7561 #endif /* COLOR_TABLE_SUPPORT */
7563 /* Save GIF image extension data for `image-metadata'.
7564 Format is (count IMAGES extension-data (FUNCTION "BYTES" ...)). */
7565 img
->lisp_data
= Qnil
;
7566 if (gif
->SavedImages
[idx
].ExtensionBlockCount
> 0)
7569 ExtensionBlock
*ext
= gif
->SavedImages
[idx
].ExtensionBlocks
;
7570 for (i
= 0; i
< gif
->SavedImages
[idx
].ExtensionBlockCount
; i
++, ext
++)
7571 /* Append (... FUNCTION "BYTES") */
7574 = Fcons (make_number (ext
->Function
),
7575 Fcons (make_unibyte_string (ext
->Bytes
, ext
->ByteCount
),
7577 if (ext
->Function
== GIF_LOCAL_DESCRIPTOR_EXTENSION
7578 && ext
->ByteCount
== 4)
7580 delay
= ext
->Bytes
[2] << CHAR_BIT
;
7581 delay
|= ext
->Bytes
[1];
7584 img
->lisp_data
= list2 (Qextension_data
, img
->lisp_data
);
7588 Fcons (make_float (delay
/ 100.0),
7592 if (gif
->ImageCount
> 1)
7593 img
->lisp_data
= Fcons (Qcount
,
7594 Fcons (make_number (gif
->ImageCount
),
7597 fn_DGifCloseFile (gif
);
7599 /* Maybe fill in the background field while we have ximg handy. */
7600 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
7601 /* Casting avoids a GCC warning. */
7602 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
7604 /* Put ximg into the image. */
7605 image_put_x_image (f
, img
, ximg
, 0);
7610 #else /* !HAVE_GIF */
7614 gif_load (struct frame
*f
, struct image
*img
)
7616 return ns_load_image (f
, img
,
7617 image_spec_value (img
->spec
, QCfile
, NULL
),
7618 image_spec_value (img
->spec
, QCdata
, NULL
));
7620 #endif /* HAVE_NS */
7622 #endif /* HAVE_GIF */
7625 #ifdef HAVE_IMAGEMAGICK
7627 /***********************************************************************
7629 ***********************************************************************/
7631 /* Scale an image size by returning SIZE / DIVISOR * MULTIPLIER,
7632 safely rounded and clipped to int range. */
7635 scale_image_size (int size
, size_t divisor
, size_t multiplier
)
7640 double scaled
= s
* multiplier
/ divisor
+ 0.5;
7641 if (scaled
< INT_MAX
)
7647 /* Compute the desired size of an image with native size WIDTH x HEIGHT.
7648 Use SPEC to deduce the size. Store the desired size into
7649 *D_WIDTH x *D_HEIGHT. Store -1 x -1 if the native size is OK. */
7651 compute_image_size (size_t width
, size_t height
,
7653 int *d_width
, int *d_height
)
7656 int desired_width
, desired_height
;
7658 /* If width and/or height is set in the display spec assume we want
7659 to scale to those values. If either h or w is unspecified, the
7660 unspecified should be calculated from the specified to preserve
7662 value
= image_spec_value (spec
, QCwidth
, NULL
);
7663 desired_width
= NATNUMP (value
) ? min (XFASTINT (value
), INT_MAX
) : -1;
7664 value
= image_spec_value (spec
, QCheight
, NULL
);
7665 desired_height
= NATNUMP (value
) ? min (XFASTINT (value
), INT_MAX
) : -1;
7667 if (desired_width
== -1)
7669 value
= image_spec_value (spec
, QCmax_width
, NULL
);
7670 if (NATNUMP (value
))
7672 int max_width
= min (XFASTINT (value
), INT_MAX
);
7673 if (max_width
< width
)
7675 /* The image is wider than :max-width. */
7676 desired_width
= max_width
;
7677 if (desired_height
== -1)
7679 desired_height
= scale_image_size (desired_width
,
7681 value
= image_spec_value (spec
, QCmax_height
, NULL
);
7682 if (NATNUMP (value
))
7684 int max_height
= min (XFASTINT (value
), INT_MAX
);
7685 if (max_height
< desired_height
)
7687 desired_height
= max_height
;
7688 desired_width
= scale_image_size (desired_height
,
7697 if (desired_height
== -1)
7699 value
= image_spec_value (spec
, QCmax_height
, NULL
);
7700 if (NATNUMP (value
))
7702 int max_height
= min (XFASTINT (value
), INT_MAX
);
7703 if (max_height
< height
)
7704 desired_height
= max_height
;
7708 if (desired_width
!= -1 && desired_height
== -1)
7709 /* w known, calculate h. */
7710 desired_height
= scale_image_size (desired_width
, width
, height
);
7712 if (desired_width
== -1 && desired_height
!= -1)
7713 /* h known, calculate w. */
7714 desired_width
= scale_image_size (desired_height
, height
, width
);
7716 *d_width
= desired_width
;
7717 *d_height
= desired_height
;
7720 static Lisp_Object Qimagemagick
;
7722 static bool imagemagick_image_p (Lisp_Object
);
7723 static bool imagemagick_load (struct frame
*, struct image
*);
7724 static void imagemagick_clear_image (struct frame
*, struct image
*);
7726 /* Indices of image specification fields in imagemagick_format. */
7728 enum imagemagick_keyword_index
7736 IMAGEMAGICK_ALGORITHM
,
7737 IMAGEMAGICK_HEURISTIC_MASK
,
7739 IMAGEMAGICK_BACKGROUND
,
7742 IMAGEMAGICK_MAX_HEIGHT
,
7743 IMAGEMAGICK_MAX_WIDTH
,
7744 IMAGEMAGICK_CONTENT_TYPE
,
7745 IMAGEMAGICK_ROTATION
,
7750 /* Vector of image_keyword structures describing the format
7751 of valid user-defined image specifications. */
7753 static struct image_keyword imagemagick_format
[IMAGEMAGICK_LAST
] =
7755 {":type", IMAGE_SYMBOL_VALUE
, 1},
7756 {":data", IMAGE_STRING_VALUE
, 0},
7757 {":file", IMAGE_STRING_VALUE
, 0},
7758 {":ascent", IMAGE_ASCENT_VALUE
, 0},
7759 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
7760 {":relief", IMAGE_INTEGER_VALUE
, 0},
7761 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7762 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7763 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7764 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0},
7765 {":height", IMAGE_INTEGER_VALUE
, 0},
7766 {":width", IMAGE_INTEGER_VALUE
, 0},
7767 {":max-height", IMAGE_INTEGER_VALUE
, 0},
7768 {":max-width", IMAGE_INTEGER_VALUE
, 0},
7769 {":content-type", IMAGE_SYMBOL_VALUE
, 0},
7770 {":rotation", IMAGE_NUMBER_VALUE
, 0},
7771 {":crop", IMAGE_DONT_CHECK_VALUE_TYPE
, 0}
7774 #if defined HAVE_NTGUI && defined WINDOWSNT
7775 static bool init_imagemagick_functions (void);
7777 #define init_imagemagick_functions NULL
7780 /* Structure describing the image type for any image handled via
7783 static struct image_type imagemagick_type
=
7786 imagemagick_image_p
,
7788 imagemagick_clear_image
,
7789 init_imagemagick_functions
,
7793 /* Free X resources of imagemagick image IMG which is used on frame F. */
7796 imagemagick_clear_image (struct frame
*f
,
7799 x_clear_image (f
, img
);
7802 /* Return true if OBJECT is a valid IMAGEMAGICK image specification. Do
7803 this by calling parse_image_spec and supplying the keywords that
7804 identify the IMAGEMAGICK format. */
7807 imagemagick_image_p (Lisp_Object object
)
7809 struct image_keyword fmt
[IMAGEMAGICK_LAST
];
7810 memcpy (fmt
, imagemagick_format
, sizeof fmt
);
7812 if (!parse_image_spec (object
, fmt
, IMAGEMAGICK_LAST
, Qimagemagick
))
7815 /* Must specify either the :data or :file keyword. */
7816 return fmt
[IMAGEMAGICK_FILE
].count
+ fmt
[IMAGEMAGICK_DATA
].count
== 1;
7819 /* The GIF library also defines DrawRectangle, but its never used in Emacs.
7820 Therefore rename the function so it doesn't collide with ImageMagick. */
7821 #define DrawRectangle DrawRectangleGif
7822 #include <wand/MagickWand.h>
7824 /* ImageMagick 6.5.3 through 6.6.5 hid PixelGetMagickColor for some reason.
7825 Emacs seems to work fine with the hidden version, so unhide it. */
7826 #include <magick/version.h>
7827 #if 0x653 <= MagickLibVersion && MagickLibVersion <= 0x665
7828 extern WandExport
void PixelGetMagickColor (const PixelWand
*,
7829 MagickPixelPacket
*);
7832 /* Log ImageMagick error message.
7833 Useful when a ImageMagick function returns the status `MagickFalse'. */
7836 imagemagick_error (MagickWand
*wand
)
7839 ExceptionType severity
;
7841 description
= MagickGetException (wand
, &severity
);
7842 image_error ("ImageMagick error: %s",
7843 build_string (description
),
7845 description
= (char *) MagickRelinquishMemory (description
);
7848 /* Possibly give ImageMagick some extra help to determine the image
7849 type by supplying a "dummy" filename based on the Content-Type. */
7852 imagemagick_filename_hint (Lisp_Object spec
)
7854 Lisp_Object content_type
= image_spec_value (spec
, QCcontent_type
, NULL
);
7855 Lisp_Object symbol
= intern ("image-content-type-suffixes");
7857 char *name
, *prefix
= "/tmp/foo.";
7859 if (NILP (Fboundp (symbol
)))
7862 val
= Fassq (content_type
, Fsymbol_value (symbol
));
7871 if (! STRINGP (val
))
7874 name
= xmalloc (strlen (prefix
) + SBYTES (val
) + 1);
7875 strcpy(name
, prefix
);
7876 strcat(name
, SDATA (val
));
7880 /* Helper function for imagemagick_load, which does the actual loading
7881 given contents and size, apart from frame and image structures,
7882 passed from imagemagick_load. Uses librimagemagick to do most of
7883 the image processing.
7885 F is a pointer to the Emacs frame; IMG to the image structure to
7886 prepare; CONTENTS is the string containing the IMAGEMAGICK data to
7887 be parsed; SIZE is the number of bytes of data; and FILENAME is
7888 either the file name or the image data.
7890 Return true if successful. */
7893 imagemagick_load_image (struct frame
*f
, struct image
*img
,
7894 unsigned char *contents
, unsigned int size
,
7897 size_t width
, height
;
7898 MagickBooleanType status
;
7901 MagickWand
*image_wand
;
7902 MagickWand
*ping_wand
;
7903 PixelIterator
*iterator
;
7904 PixelWand
**pixels
, *bg_wand
= NULL
;
7905 MagickPixelPacket pixel
;
7910 int desired_width
, desired_height
;
7913 char *filename_hint
= NULL
;
7915 /* Handle image index for image types who can contain more than one image.
7916 Interface :index is same as for GIF. First we "ping" the image to see how
7917 many sub-images it contains. Pinging is faster than loading the image to
7918 find out things about it. */
7920 /* Initialize the imagemagick environment. */
7921 MagickWandGenesis ();
7922 image
= image_spec_value (img
->spec
, QCindex
, NULL
);
7923 ino
= INTEGERP (image
) ? XFASTINT (image
) : 0;
7924 ping_wand
= NewMagickWand ();
7925 /* MagickSetResolution (ping_wand, 2, 2); (Bug#10112) */
7928 filename_hint
= imagemagick_filename_hint (img
->spec
);
7931 MagickSetFilename (ping_wand
, filename_hint
);
7934 ? MagickPingImage (ping_wand
, filename
)
7935 : MagickPingImageBlob (ping_wand
, contents
, size
);
7937 if (status
== MagickFalse
)
7939 imagemagick_error (ping_wand
);
7940 DestroyMagickWand (ping_wand
);
7944 if (ino
< 0 || ino
>= MagickGetNumberImages (ping_wand
))
7946 image_error ("Invalid image number `%s' in image `%s'",
7948 DestroyMagickWand (ping_wand
);
7952 if (MagickGetNumberImages (ping_wand
) > 1)
7955 Fcons (make_number (MagickGetNumberImages (ping_wand
)),
7958 DestroyMagickWand (ping_wand
);
7960 /* Now we know how many images are inside the file. If it's not a
7961 bundle, the number is one. Load the image data. */
7963 image_wand
= NewMagickWand ();
7966 MagickSetFilename (image_wand
, filename_hint
);
7969 ? MagickReadImage (image_wand
, filename
)
7970 : MagickReadImageBlob (image_wand
, contents
, size
))
7973 imagemagick_error (image_wand
);
7974 goto imagemagick_error
;
7977 /* Retrieve the frame's background color, for use later. */
7980 Lisp_Object specified_bg
;
7982 specified_bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
7983 if (!STRINGP (specified_bg
)
7984 || !x_defined_color (f
, SSDATA (specified_bg
), &bgcolor
, 0))
7987 bgcolor
.pixel
= FRAME_BACKGROUND_PIXEL (f
);
7988 x_query_color (f
, &bgcolor
);
7990 ns_query_color (FRAME_BACKGROUND_COLOR (f
), &bgcolor
, 1);
7994 bg_wand
= NewPixelWand ();
7995 PixelSetRed (bg_wand
, (double) bgcolor
.red
/ 65535);
7996 PixelSetGreen (bg_wand
, (double) bgcolor
.green
/ 65535);
7997 PixelSetBlue (bg_wand
, (double) bgcolor
.blue
/ 65535);
8000 compute_image_size (MagickGetImageWidth (image_wand
),
8001 MagickGetImageHeight (image_wand
),
8002 img
->spec
, &desired_width
, &desired_height
);
8004 if (desired_width
!= -1 && desired_height
!= -1)
8006 status
= MagickScaleImage (image_wand
, desired_width
, desired_height
);
8007 if (status
== MagickFalse
)
8009 image_error ("Imagemagick scale failed", Qnil
, Qnil
);
8010 imagemagick_error (image_wand
);
8011 goto imagemagick_error
;
8015 /* crop behaves similar to image slicing in Emacs but is more memory
8017 crop
= image_spec_value (img
->spec
, QCcrop
, NULL
);
8019 if (CONSP (crop
) && TYPE_RANGED_INTEGERP (size_t, XCAR (crop
)))
8021 /* After some testing, it seems MagickCropImage is the fastest crop
8022 function in ImageMagick. This crop function seems to do less copying
8023 than the alternatives, but it still reads the entire image into memory
8024 before cropping, which is apparently difficult to avoid when using
8026 size_t crop_width
= XINT (XCAR (crop
));
8028 if (CONSP (crop
) && TYPE_RANGED_INTEGERP (size_t, XCAR (crop
)))
8030 size_t crop_height
= XINT (XCAR (crop
));
8032 if (CONSP (crop
) && TYPE_RANGED_INTEGERP (ssize_t
, XCAR (crop
)))
8034 ssize_t crop_x
= XINT (XCAR (crop
));
8036 if (CONSP (crop
) && TYPE_RANGED_INTEGERP (ssize_t
, XCAR (crop
)))
8038 ssize_t crop_y
= XINT (XCAR (crop
));
8039 MagickCropImage (image_wand
, crop_width
, crop_height
,
8046 /* Furthermore :rotation. we need background color and angle for
8049 TODO background handling for rotation specified_bg =
8050 image_spec_value (img->spec, QCbackground, NULL); if (!STRINGP
8052 value
= image_spec_value (img
->spec
, QCrotation
, NULL
);
8055 rotation
= extract_float (value
);
8056 status
= MagickRotateImage (image_wand
, bg_wand
, rotation
);
8057 if (status
== MagickFalse
)
8059 image_error ("Imagemagick image rotate failed", Qnil
, Qnil
);
8060 imagemagick_error (image_wand
);
8061 goto imagemagick_error
;
8065 /* Set the canvas background color to the frame or specified
8066 background, and flatten the image. Note: as of ImageMagick
8067 6.6.0, SVG image transparency is not handled properly
8068 (e.g. etc/images/splash.svg shows a white background always). */
8070 MagickWand
*new_wand
;
8071 MagickSetImageBackgroundColor (image_wand
, bg_wand
);
8072 #ifdef HAVE_MAGICKMERGEIMAGELAYERS
8073 new_wand
= MagickMergeImageLayers (image_wand
, MergeLayer
);
8075 new_wand
= MagickFlattenImages (image_wand
);
8077 DestroyMagickWand (image_wand
);
8078 image_wand
= new_wand
;
8081 /* Finally we are done manipulating the image. Figure out the
8082 resulting width/height and transfer ownership to Emacs. */
8083 height
= MagickGetImageHeight (image_wand
);
8084 width
= MagickGetImageWidth (image_wand
);
8086 if (! (width
<= INT_MAX
&& height
<= INT_MAX
8087 && check_image_size (f
, width
, height
)))
8089 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
8090 goto imagemagick_error
;
8093 /* We can now get a valid pixel buffer from the imagemagick file, if all
8096 init_color_table ();
8098 #if defined (HAVE_MAGICKEXPORTIMAGEPIXELS) && ! defined (HAVE_NS)
8099 if (imagemagick_render_type
!= 0)
8101 /* Magicexportimage is normally faster than pixelpushing. This
8102 method is also well tested. Some aspects of this method are
8103 ad-hoc and needs to be more researched. */
8104 int imagedepth
= 24; /*MagickGetImageDepth(image_wand);*/
8105 const char *exportdepth
= imagedepth
<= 8 ? "I" : "BGRP"; /*"RGBP";*/
8106 /* Try to create a x pixmap to hold the imagemagick pixmap. */
8107 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, imagedepth
,
8110 #ifdef COLOR_TABLE_SUPPORT
8111 free_color_table ();
8113 image_error ("Imagemagick X bitmap allocation failure", Qnil
, Qnil
);
8114 goto imagemagick_error
;
8117 /* Oddly, the below code doesn't seem to work:*/
8118 /* switch(ximg->bitmap_unit){ */
8120 /* pixelwidth=CharPixel; */
8123 /* pixelwidth=ShortPixel; */
8126 /* pixelwidth=LongPixel; */
8130 Here im just guessing the format of the bitmap.
8131 happens to work fine for:
8134 seems about 3 times as fast as pixel pushing(not carefully measured)
8136 pixelwidth
= CharPixel
; /*??? TODO figure out*/
8137 MagickExportImagePixels (image_wand
, 0, 0, width
, height
,
8138 exportdepth
, pixelwidth
, ximg
->data
);
8141 #endif /* HAVE_MAGICKEXPORTIMAGEPIXELS */
8143 size_t image_height
;
8145 /* Try to create a x pixmap to hold the imagemagick pixmap. */
8146 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, 0,
8149 #ifdef COLOR_TABLE_SUPPORT
8150 free_color_table ();
8152 image_error ("Imagemagick X bitmap allocation failure", Qnil
, Qnil
);
8153 goto imagemagick_error
;
8156 /* Copy imagemagick image to x with primitive yet robust pixel
8157 pusher loop. This has been tested a lot with many different
8160 /* Copy pixels from the imagemagick image structure to the x image map. */
8161 iterator
= NewPixelIterator (image_wand
);
8164 #ifdef COLOR_TABLE_SUPPORT
8165 free_color_table ();
8167 x_destroy_x_image (ximg
);
8168 image_error ("Imagemagick pixel iterator creation failed",
8170 goto imagemagick_error
;
8173 image_height
= MagickGetImageHeight (image_wand
);
8174 for (y
= 0; y
< image_height
; y
++)
8176 pixels
= PixelGetNextIteratorRow (iterator
, &width
);
8179 for (x
= 0; x
< (long) width
; x
++)
8181 PixelGetMagickColor (pixels
[x
], &pixel
);
8182 XPutPixel (ximg
, x
, y
,
8183 lookup_rgb_color (f
,
8189 DestroyPixelIterator (iterator
);
8192 #ifdef COLOR_TABLE_SUPPORT
8193 /* Remember colors allocated for this image. */
8194 img
->colors
= colors_in_color_table (&img
->ncolors
);
8195 free_color_table ();
8196 #endif /* COLOR_TABLE_SUPPORT */
8199 img
->height
= height
;
8201 /* Put ximg into the image. */
8202 image_put_x_image (f
, img
, ximg
, 0);
8204 /* Final cleanup. image_wand should be the only resource left. */
8205 DestroyMagickWand (image_wand
);
8206 if (bg_wand
) DestroyPixelWand (bg_wand
);
8208 /* `MagickWandTerminus' terminates the imagemagick environment. */
8209 MagickWandTerminus ();
8212 free (filename_hint
);
8217 DestroyMagickWand (image_wand
);
8218 if (bg_wand
) DestroyPixelWand (bg_wand
);
8220 free (filename_hint
);
8222 MagickWandTerminus ();
8223 /* TODO more cleanup. */
8224 image_error ("Error parsing IMAGEMAGICK image `%s'", img
->spec
, Qnil
);
8229 /* Load IMAGEMAGICK image IMG for use on frame F. Value is true if
8230 successful. this function will go into the imagemagick_type structure, and
8231 the prototype thus needs to be compatible with that structure. */
8234 imagemagick_load (struct frame
*f
, struct image
*img
)
8237 Lisp_Object file_name
;
8239 /* If IMG->spec specifies a file name, create a non-file spec from it. */
8240 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
8241 if (STRINGP (file_name
))
8245 file
= x_find_image_file (file_name
);
8246 if (!STRINGP (file
))
8248 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
8251 success_p
= imagemagick_load_image (f
, img
, 0, 0, SSDATA (file
));
8253 /* Else its not a file, its a lisp object. Load the image from a
8254 lisp object rather than a file. */
8259 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
8260 if (!STRINGP (data
))
8262 image_error ("Invalid image data `%s'", data
, Qnil
);
8265 success_p
= imagemagick_load_image (f
, img
, SDATA (data
),
8266 SBYTES (data
), NULL
);
8272 DEFUN ("imagemagick-types", Fimagemagick_types
, Simagemagick_types
, 0, 0, 0,
8273 doc
: /* Return a list of image types supported by ImageMagick.
8274 Each entry in this list is a symbol named after an ImageMagick format
8275 tag. See the ImageMagick manual for a list of ImageMagick formats and
8276 their descriptions (http://www.imagemagick.org/script/formats.php).
8277 You can also try the shell command: `identify -list format'.
8279 Note that ImageMagick recognizes many file-types that Emacs does not
8280 recognize as images, such as C. See `imagemagick-types-enable'
8281 and `imagemagick-types-inhibit'. */)
8284 Lisp_Object typelist
= Qnil
;
8289 Lisp_Object Qimagemagicktype
;
8291 GetExceptionInfo(&ex
);
8292 imtypes
= GetMagickList ("*", &numf
, &ex
);
8293 DestroyExceptionInfo(&ex
);
8295 for (i
= 0; i
< numf
; i
++)
8297 Qimagemagicktype
= intern (imtypes
[i
]);
8298 typelist
= Fcons (Qimagemagicktype
, typelist
);
8300 return Fnreverse (typelist
);
8303 #endif /* defined (HAVE_IMAGEMAGICK) */
8307 /***********************************************************************
8309 ***********************************************************************/
8311 #if defined (HAVE_RSVG)
8313 /* Function prototypes. */
8315 static bool svg_image_p (Lisp_Object object
);
8316 static bool svg_load (struct frame
*f
, struct image
*img
);
8318 static bool svg_load_image (struct frame
*, struct image
*,
8319 unsigned char *, ptrdiff_t);
8321 /* The symbol `svg' identifying images of this type. */
8323 static Lisp_Object Qsvg
;
8325 /* Indices of image specification fields in svg_format, below. */
8327 enum svg_keyword_index
8342 /* Vector of image_keyword structures describing the format
8343 of valid user-defined image specifications. */
8345 static const struct image_keyword svg_format
[SVG_LAST
] =
8347 {":type", IMAGE_SYMBOL_VALUE
, 1},
8348 {":data", IMAGE_STRING_VALUE
, 0},
8349 {":file", IMAGE_STRING_VALUE
, 0},
8350 {":ascent", IMAGE_ASCENT_VALUE
, 0},
8351 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
8352 {":relief", IMAGE_INTEGER_VALUE
, 0},
8353 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8354 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8355 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8356 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
8359 #if defined HAVE_NTGUI && defined WINDOWSNT
8360 static bool init_svg_functions (void);
8362 #define init_svg_functions NULL
8365 /* Structure describing the image type `svg'. Its the same type of
8366 structure defined for all image formats, handled by emacs image
8367 functions. See struct image_type in dispextern.h. */
8369 static struct image_type svg_type
=
8380 /* Return true if OBJECT is a valid SVG image specification. Do
8381 this by calling parse_image_spec and supplying the keywords that
8382 identify the SVG format. */
8385 svg_image_p (Lisp_Object object
)
8387 struct image_keyword fmt
[SVG_LAST
];
8388 memcpy (fmt
, svg_format
, sizeof fmt
);
8390 if (!parse_image_spec (object
, fmt
, SVG_LAST
, Qsvg
))
8393 /* Must specify either the :data or :file keyword. */
8394 return fmt
[SVG_FILE
].count
+ fmt
[SVG_DATA
].count
== 1;
8397 #include <librsvg/rsvg.h>
8401 /* SVG library functions. */
8402 DEF_IMGLIB_FN (RsvgHandle
*, rsvg_handle_new
, (void));
8403 DEF_IMGLIB_FN (void, rsvg_handle_get_dimensions
, (RsvgHandle
*, RsvgDimensionData
*));
8404 DEF_IMGLIB_FN (gboolean
, rsvg_handle_write
, (RsvgHandle
*, const guchar
*, gsize
, GError
**));
8405 DEF_IMGLIB_FN (gboolean
, rsvg_handle_close
, (RsvgHandle
*, GError
**));
8406 DEF_IMGLIB_FN (GdkPixbuf
*, rsvg_handle_get_pixbuf
, (RsvgHandle
*));
8407 DEF_IMGLIB_FN (void *, rsvg_handle_set_size_callback
, (RsvgHandle
*, RsvgSizeFunc
, gpointer
, GDestroyNotify
));
8409 DEF_IMGLIB_FN (int, gdk_pixbuf_get_width
, (const GdkPixbuf
*));
8410 DEF_IMGLIB_FN (int, gdk_pixbuf_get_height
, (const GdkPixbuf
*));
8411 DEF_IMGLIB_FN (guchar
*, gdk_pixbuf_get_pixels
, (const GdkPixbuf
*));
8412 DEF_IMGLIB_FN (int, gdk_pixbuf_get_rowstride
, (const GdkPixbuf
*));
8413 DEF_IMGLIB_FN (GdkColorspace
, gdk_pixbuf_get_colorspace
, (const GdkPixbuf
*));
8414 DEF_IMGLIB_FN (int, gdk_pixbuf_get_n_channels
, (const GdkPixbuf
*));
8415 DEF_IMGLIB_FN (gboolean
, gdk_pixbuf_get_has_alpha
, (const GdkPixbuf
*));
8416 DEF_IMGLIB_FN (int, gdk_pixbuf_get_bits_per_sample
, (const GdkPixbuf
*));
8418 DEF_IMGLIB_FN (void, g_type_init
, (void));
8419 DEF_IMGLIB_FN (void, g_object_unref
, (gpointer
));
8420 DEF_IMGLIB_FN (void, g_error_free
, (GError
*));
8422 Lisp_Object Qgdk_pixbuf
, Qglib
, Qgobject
;
8425 init_svg_functions (void)
8427 HMODULE library
, gdklib
, glib
, gobject
;
8429 if (!(glib
= w32_delayed_load (Qglib
))
8430 || !(gobject
= w32_delayed_load (Qgobject
))
8431 || !(gdklib
= w32_delayed_load (Qgdk_pixbuf
))
8432 || !(library
= w32_delayed_load (Qsvg
)))
8435 LOAD_IMGLIB_FN (library
, rsvg_handle_new
);
8436 LOAD_IMGLIB_FN (library
, rsvg_handle_get_dimensions
);
8437 LOAD_IMGLIB_FN (library
, rsvg_handle_write
);
8438 LOAD_IMGLIB_FN (library
, rsvg_handle_close
);
8439 LOAD_IMGLIB_FN (library
, rsvg_handle_get_pixbuf
);
8441 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_width
);
8442 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_height
);
8443 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_pixels
);
8444 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_rowstride
);
8445 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_colorspace
);
8446 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_n_channels
);
8447 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_has_alpha
);
8448 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_bits_per_sample
);
8450 LOAD_IMGLIB_FN (gobject
, g_type_init
);
8451 LOAD_IMGLIB_FN (gobject
, g_object_unref
);
8452 LOAD_IMGLIB_FN (glib
, g_error_free
);
8458 /* The following aliases for library functions allow dynamic loading
8459 to be used on some platforms. */
8460 #define fn_rsvg_handle_new rsvg_handle_new
8461 #define fn_rsvg_handle_get_dimensions rsvg_handle_get_dimensions
8462 #define fn_rsvg_handle_write rsvg_handle_write
8463 #define fn_rsvg_handle_close rsvg_handle_close
8464 #define fn_rsvg_handle_get_pixbuf rsvg_handle_get_pixbuf
8466 #define fn_gdk_pixbuf_get_width gdk_pixbuf_get_width
8467 #define fn_gdk_pixbuf_get_height gdk_pixbuf_get_height
8468 #define fn_gdk_pixbuf_get_pixels gdk_pixbuf_get_pixels
8469 #define fn_gdk_pixbuf_get_rowstride gdk_pixbuf_get_rowstride
8470 #define fn_gdk_pixbuf_get_colorspace gdk_pixbuf_get_colorspace
8471 #define fn_gdk_pixbuf_get_n_channels gdk_pixbuf_get_n_channels
8472 #define fn_gdk_pixbuf_get_has_alpha gdk_pixbuf_get_has_alpha
8473 #define fn_gdk_pixbuf_get_bits_per_sample gdk_pixbuf_get_bits_per_sample
8475 #define fn_g_type_init g_type_init
8476 #define fn_g_object_unref g_object_unref
8477 #define fn_g_error_free g_error_free
8478 #endif /* !WINDOWSNT */
8480 /* Load SVG image IMG for use on frame F. Value is true if
8484 svg_load (struct frame
*f
, struct image
*img
)
8487 Lisp_Object file_name
;
8489 /* If IMG->spec specifies a file name, create a non-file spec from it. */
8490 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
8491 if (STRINGP (file_name
))
8494 unsigned char *contents
;
8497 file
= x_find_image_file (file_name
);
8498 if (!STRINGP (file
))
8500 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
8504 /* Read the entire file into memory. */
8505 contents
= slurp_file (SSDATA (file
), &size
);
8506 if (contents
== NULL
)
8508 image_error ("Error loading SVG image `%s'", img
->spec
, Qnil
);
8511 /* If the file was slurped into memory properly, parse it. */
8512 success_p
= svg_load_image (f
, img
, contents
, size
);
8515 /* Else its not a file, its a lisp object. Load the image from a
8516 lisp object rather than a file. */
8521 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
8522 if (!STRINGP (data
))
8524 image_error ("Invalid image data `%s'", data
, Qnil
);
8527 success_p
= svg_load_image (f
, img
, SDATA (data
), SBYTES (data
));
8533 /* svg_load_image is a helper function for svg_load, which does the
8534 actual loading given contents and size, apart from frame and image
8535 structures, passed from svg_load.
8537 Uses librsvg to do most of the image processing.
8539 Returns true when successful. */
8541 svg_load_image (struct frame
*f
, /* Pointer to emacs frame structure. */
8542 struct image
*img
, /* Pointer to emacs image structure. */
8543 unsigned char *contents
, /* String containing the SVG XML data to be parsed. */
8544 ptrdiff_t size
) /* Size of data in bytes. */
8546 RsvgHandle
*rsvg_handle
;
8547 RsvgDimensionData dimension_data
;
8552 const guint8
*pixels
;
8555 Lisp_Object specified_bg
;
8560 /* g_type_init is a glib function that must be called prior to using
8561 gnome type library functions. */
8563 /* Make a handle to a new rsvg object. */
8564 rsvg_handle
= fn_rsvg_handle_new ();
8566 /* Parse the contents argument and fill in the rsvg_handle. */
8567 fn_rsvg_handle_write (rsvg_handle
, contents
, size
, &err
);
8568 if (err
) goto rsvg_error
;
8570 /* The parsing is complete, rsvg_handle is ready to used, close it
8571 for further writes. */
8572 fn_rsvg_handle_close (rsvg_handle
, &err
);
8573 if (err
) goto rsvg_error
;
8575 fn_rsvg_handle_get_dimensions (rsvg_handle
, &dimension_data
);
8576 if (! check_image_size (f
, dimension_data
.width
, dimension_data
.height
))
8578 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
8582 /* We can now get a valid pixel buffer from the svg file, if all
8584 pixbuf
= fn_rsvg_handle_get_pixbuf (rsvg_handle
);
8585 if (!pixbuf
) goto rsvg_error
;
8586 fn_g_object_unref (rsvg_handle
);
8588 /* Extract some meta data from the svg handle. */
8589 width
= fn_gdk_pixbuf_get_width (pixbuf
);
8590 height
= fn_gdk_pixbuf_get_height (pixbuf
);
8591 pixels
= fn_gdk_pixbuf_get_pixels (pixbuf
);
8592 rowstride
= fn_gdk_pixbuf_get_rowstride (pixbuf
);
8594 /* Validate the svg meta data. */
8595 eassert (fn_gdk_pixbuf_get_colorspace (pixbuf
) == GDK_COLORSPACE_RGB
);
8596 eassert (fn_gdk_pixbuf_get_n_channels (pixbuf
) == 4);
8597 eassert (fn_gdk_pixbuf_get_has_alpha (pixbuf
));
8598 eassert (fn_gdk_pixbuf_get_bits_per_sample (pixbuf
) == 8);
8600 /* Try to create a x pixmap to hold the svg pixmap. */
8601 if (!image_create_x_image_and_pixmap (f
, img
, width
, height
, 0, &ximg
, 0))
8603 fn_g_object_unref (pixbuf
);
8607 init_color_table ();
8609 /* Handle alpha channel by combining the image with a background
8611 specified_bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
8612 if (!STRINGP (specified_bg
)
8613 || !x_defined_color (f
, SSDATA (specified_bg
), &background
, 0))
8616 background
.pixel
= FRAME_BACKGROUND_PIXEL (f
);
8617 x_query_color (f
, &background
);
8619 ns_query_color (FRAME_BACKGROUND_COLOR (f
), &background
, 1);
8623 /* SVG pixmaps specify transparency in the last byte, so right
8624 shift 8 bits to get rid of it, since emacs doesn't support
8626 background
.red
>>= 8;
8627 background
.green
>>= 8;
8628 background
.blue
>>= 8;
8630 /* This loop handles opacity values, since Emacs assumes
8631 non-transparent images. Each pixel must be "flattened" by
8632 calculating the resulting color, given the transparency of the
8633 pixel, and the image background color. */
8634 for (y
= 0; y
< height
; ++y
)
8636 for (x
= 0; x
< width
; ++x
)
8646 opacity
= *pixels
++;
8648 red
= ((red
* opacity
)
8649 + (background
.red
* ((1 << 8) - opacity
)));
8650 green
= ((green
* opacity
)
8651 + (background
.green
* ((1 << 8) - opacity
)));
8652 blue
= ((blue
* opacity
)
8653 + (background
.blue
* ((1 << 8) - opacity
)));
8655 XPutPixel (ximg
, x
, y
, lookup_rgb_color (f
, red
, green
, blue
));
8658 pixels
+= rowstride
- 4 * width
;
8661 #ifdef COLOR_TABLE_SUPPORT
8662 /* Remember colors allocated for this image. */
8663 img
->colors
= colors_in_color_table (&img
->ncolors
);
8664 free_color_table ();
8665 #endif /* COLOR_TABLE_SUPPORT */
8667 fn_g_object_unref (pixbuf
);
8670 img
->height
= height
;
8672 /* Maybe fill in the background field while we have ximg handy.
8673 Casting avoids a GCC warning. */
8674 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
8676 /* Put ximg into the image. */
8677 image_put_x_image (f
, img
, ximg
, 0);
8682 fn_g_object_unref (rsvg_handle
);
8683 /* FIXME: Use error->message so the user knows what is the actual
8684 problem with the image. */
8685 image_error ("Error parsing SVG image `%s'", img
->spec
, Qnil
);
8686 fn_g_error_free (err
);
8690 #endif /* defined (HAVE_RSVG) */
8695 /***********************************************************************
8697 ***********************************************************************/
8699 #ifdef HAVE_X_WINDOWS
8700 #define HAVE_GHOSTSCRIPT 1
8701 #endif /* HAVE_X_WINDOWS */
8703 #ifdef HAVE_GHOSTSCRIPT
8705 static bool gs_image_p (Lisp_Object object
);
8706 static bool gs_load (struct frame
*f
, struct image
*img
);
8707 static void gs_clear_image (struct frame
*f
, struct image
*img
);
8709 /* Keyword symbols. */
8711 static Lisp_Object QCloader
, QCbounding_box
, QCpt_width
, QCpt_height
;
8713 /* Indices of image specification fields in gs_format, below. */
8715 enum gs_keyword_index
8733 /* Vector of image_keyword structures describing the format
8734 of valid user-defined image specifications. */
8736 static const struct image_keyword gs_format
[GS_LAST
] =
8738 {":type", IMAGE_SYMBOL_VALUE
, 1},
8739 {":pt-width", IMAGE_POSITIVE_INTEGER_VALUE
, 1},
8740 {":pt-height", IMAGE_POSITIVE_INTEGER_VALUE
, 1},
8741 {":file", IMAGE_STRING_VALUE
, 1},
8742 {":loader", IMAGE_FUNCTION_VALUE
, 0},
8743 {":bounding-box", IMAGE_DONT_CHECK_VALUE_TYPE
, 1},
8744 {":ascent", IMAGE_ASCENT_VALUE
, 0},
8745 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
8746 {":relief", IMAGE_INTEGER_VALUE
, 0},
8747 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8748 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8749 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8750 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
8753 /* Structure describing the image type `ghostscript'. */
8755 static struct image_type gs_type
=
8766 /* Free X resources of Ghostscript image IMG which is used on frame F. */
8769 gs_clear_image (struct frame
*f
, struct image
*img
)
8771 x_clear_image (f
, img
);
8775 /* Return true if OBJECT is a valid Ghostscript image
8779 gs_image_p (Lisp_Object object
)
8781 struct image_keyword fmt
[GS_LAST
];
8785 memcpy (fmt
, gs_format
, sizeof fmt
);
8787 if (!parse_image_spec (object
, fmt
, GS_LAST
, Qpostscript
))
8790 /* Bounding box must be a list or vector containing 4 integers. */
8791 tem
= fmt
[GS_BOUNDING_BOX
].value
;
8794 for (i
= 0; i
< 4; ++i
, tem
= XCDR (tem
))
8795 if (!CONSP (tem
) || !INTEGERP (XCAR (tem
)))
8800 else if (VECTORP (tem
))
8802 if (ASIZE (tem
) != 4)
8804 for (i
= 0; i
< 4; ++i
)
8805 if (!INTEGERP (AREF (tem
, i
)))
8815 /* Load Ghostscript image IMG for use on frame F. Value is true
8819 gs_load (struct frame
*f
, struct image
*img
)
8821 uprintmax_t printnum1
, printnum2
;
8822 char buffer
[sizeof " " + INT_STRLEN_BOUND (printmax_t
)];
8823 Lisp_Object window_and_pixmap_id
= Qnil
, loader
, pt_height
, pt_width
;
8825 double in_width
, in_height
;
8826 Lisp_Object pixel_colors
= Qnil
;
8828 /* Compute pixel size of pixmap needed from the given size in the
8829 image specification. Sizes in the specification are in pt. 1 pt
8830 = 1/72 in, xdpi and ydpi are stored in the frame's X display
8832 pt_width
= image_spec_value (img
->spec
, QCpt_width
, NULL
);
8833 in_width
= INTEGERP (pt_width
) ? XFASTINT (pt_width
) / 72.0 : 0;
8834 in_width
*= FRAME_RES_X (f
);
8835 pt_height
= image_spec_value (img
->spec
, QCpt_height
, NULL
);
8836 in_height
= INTEGERP (pt_height
) ? XFASTINT (pt_height
) / 72.0 : 0;
8837 in_height
*= FRAME_RES_Y (f
);
8839 if (! (in_width
<= INT_MAX
&& in_height
<= INT_MAX
8840 && check_image_size (f
, in_width
, in_height
)))
8842 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
8845 img
->width
= in_width
;
8846 img
->height
= in_height
;
8848 /* Create the pixmap. */
8849 eassert (img
->pixmap
== NO_PIXMAP
);
8851 if (x_check_image_size (0, img
->width
, img
->height
))
8853 /* Only W32 version did BLOCK_INPUT here. ++kfs */
8855 img
->pixmap
= XCreatePixmap (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
8856 img
->width
, img
->height
,
8857 DefaultDepthOfScreen (FRAME_X_SCREEN (f
)));
8863 image_error ("Unable to create pixmap for `%s'", img
->spec
, Qnil
);
8867 /* Call the loader to fill the pixmap. It returns a process object
8868 if successful. We do not record_unwind_protect here because
8869 other places in redisplay like calling window scroll functions
8870 don't either. Let the Lisp loader use `unwind-protect' instead. */
8871 printnum1
= FRAME_X_WINDOW (f
);
8872 printnum2
= img
->pixmap
;
8873 window_and_pixmap_id
8874 = make_formatted_string (buffer
, "%"pMu
" %"pMu
, printnum1
, printnum2
);
8876 printnum1
= FRAME_FOREGROUND_PIXEL (f
);
8877 printnum2
= FRAME_BACKGROUND_PIXEL (f
);
8879 = make_formatted_string (buffer
, "%"pMu
" %"pMu
, printnum1
, printnum2
);
8881 XSETFRAME (frame
, f
);
8882 loader
= image_spec_value (img
->spec
, QCloader
, NULL
);
8884 loader
= intern ("gs-load-image");
8886 img
->lisp_data
= call6 (loader
, frame
, img
->spec
,
8887 make_number (img
->width
),
8888 make_number (img
->height
),
8889 window_and_pixmap_id
,
8891 return PROCESSP (img
->lisp_data
);
8895 /* Kill the Ghostscript process that was started to fill PIXMAP on
8896 frame F. Called from XTread_socket when receiving an event
8897 telling Emacs that Ghostscript has finished drawing. */
8900 x_kill_gs_process (Pixmap pixmap
, struct frame
*f
)
8902 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
8907 /* Find the image containing PIXMAP. */
8908 for (i
= 0; i
< c
->used
; ++i
)
8909 if (c
->images
[i
]->pixmap
== pixmap
)
8912 /* Should someone in between have cleared the image cache, for
8913 instance, give up. */
8917 /* Kill the GS process. We should have found PIXMAP in the image
8918 cache and its image should contain a process object. */
8920 eassert (PROCESSP (img
->lisp_data
));
8921 Fkill_process (img
->lisp_data
, Qnil
);
8922 img
->lisp_data
= Qnil
;
8924 #if defined (HAVE_X_WINDOWS)
8926 /* On displays with a mutable colormap, figure out the colors
8927 allocated for the image by looking at the pixels of an XImage for
8929 class = FRAME_X_VISUAL (f
)->class;
8930 if (class != StaticColor
&& class != StaticGray
&& class != TrueColor
)
8936 /* Try to get an XImage for img->pixmep. */
8937 ximg
= XGetImage (FRAME_X_DISPLAY (f
), img
->pixmap
,
8938 0, 0, img
->width
, img
->height
, ~0, ZPixmap
);
8943 /* Initialize the color table. */
8944 init_color_table ();
8946 /* For each pixel of the image, look its color up in the
8947 color table. After having done so, the color table will
8948 contain an entry for each color used by the image. */
8949 for (y
= 0; y
< img
->height
; ++y
)
8950 for (x
= 0; x
< img
->width
; ++x
)
8952 unsigned long pixel
= XGetPixel (ximg
, x
, y
);
8953 lookup_pixel_color (f
, pixel
);
8956 /* Record colors in the image. Free color table and XImage. */
8957 #ifdef COLOR_TABLE_SUPPORT
8958 img
->colors
= colors_in_color_table (&img
->ncolors
);
8959 free_color_table ();
8961 XDestroyImage (ximg
);
8963 #if 0 /* This doesn't seem to be the case. If we free the colors
8964 here, we get a BadAccess later in x_clear_image when
8965 freeing the colors. */
8966 /* We have allocated colors once, but Ghostscript has also
8967 allocated colors on behalf of us. So, to get the
8968 reference counts right, free them once. */
8970 x_free_colors (f
, img
->colors
, img
->ncolors
);
8974 image_error ("Cannot get X image of `%s'; colors will not be freed",
8979 #endif /* HAVE_X_WINDOWS */
8981 /* Now that we have the pixmap, compute mask and transform the
8982 image if requested. */
8984 postprocess_image (f
, img
);
8988 #endif /* HAVE_GHOSTSCRIPT */
8991 /***********************************************************************
8993 ***********************************************************************/
8997 DEFUN ("imagep", Fimagep
, Simagep
, 1, 1, 0,
8998 doc
: /* Value is non-nil if SPEC is a valid image specification. */)
9001 return valid_image_p (spec
) ? Qt
: Qnil
;
9005 DEFUN ("lookup-image", Flookup_image
, Slookup_image
, 1, 1, 0, "")
9010 if (valid_image_p (spec
))
9011 id
= lookup_image (SELECTED_FRAME (), spec
);
9014 return make_number (id
);
9017 #endif /* GLYPH_DEBUG */
9020 /***********************************************************************
9022 ***********************************************************************/
9024 DEFUN ("init-image-library", Finit_image_library
, Sinit_image_library
, 1, 1, 0,
9025 doc
: /* Initialize image library implementing image type TYPE.
9026 Return non-nil if TYPE is a supported image type.
9028 If image libraries are loaded dynamically (currently only the case on
9029 MS-Windows), load the library for TYPE if it is not yet loaded, using
9030 the library file(s) specified by `dynamic-library-alist'. */)
9033 return lookup_image_type (type
) ? Qt
: Qnil
;
9036 /* Look up image type TYPE, and return a pointer to its image_type
9037 structure. Return 0 if TYPE is not a known image type. */
9039 static struct image_type
*
9040 lookup_image_type (Lisp_Object type
)
9042 /* Types pbm and xbm are built-in and always available. */
9043 if (EQ (type
, Qpbm
))
9044 return define_image_type (&pbm_type
);
9046 if (EQ (type
, Qxbm
))
9047 return define_image_type (&xbm_type
);
9049 #if defined (HAVE_XPM) || defined (HAVE_NS)
9050 if (EQ (type
, Qxpm
))
9051 return define_image_type (&xpm_type
);
9054 #if defined (HAVE_JPEG) || defined (HAVE_NS)
9055 if (EQ (type
, Qjpeg
))
9056 return define_image_type (&jpeg_type
);
9059 #if defined (HAVE_TIFF) || defined (HAVE_NS)
9060 if (EQ (type
, Qtiff
))
9061 return define_image_type (&tiff_type
);
9064 #if defined (HAVE_GIF) || defined (HAVE_NS)
9065 if (EQ (type
, Qgif
))
9066 return define_image_type (&gif_type
);
9069 #if defined (HAVE_PNG) || defined (HAVE_NS)
9070 if (EQ (type
, Qpng
))
9071 return define_image_type (&png_type
);
9074 #if defined (HAVE_RSVG)
9075 if (EQ (type
, Qsvg
))
9076 return define_image_type (&svg_type
);
9079 #if defined (HAVE_IMAGEMAGICK)
9080 if (EQ (type
, Qimagemagick
))
9081 return define_image_type (&imagemagick_type
);
9084 #ifdef HAVE_GHOSTSCRIPT
9085 if (EQ (type
, Qpostscript
))
9086 return define_image_type (&gs_type
);
9092 /* Reset image_types before dumping.
9093 Called from Fdump_emacs. */
9096 reset_image_types (void)
9100 struct image_type
*next
= image_types
->next
;
9101 xfree (image_types
);
9107 syms_of_image (void)
9109 /* Initialize this only once; it will be reset before dumping. */
9112 /* Must be defined now because we're going to update it below, while
9113 defining the supported image types. */
9114 DEFVAR_LISP ("image-types", Vimage_types
,
9115 doc
: /* List of potentially supported image types.
9116 Each element of the list is a symbol for an image type, like 'jpeg or 'png.
9117 To check whether it is really supported, use `image-type-available-p'. */);
9118 Vimage_types
= Qnil
;
9120 DEFVAR_LISP ("max-image-size", Vmax_image_size
,
9121 doc
: /* Maximum size of images.
9122 Emacs will not load an image into memory if its pixel width or
9123 pixel height exceeds this limit.
9125 If the value is an integer, it directly specifies the maximum
9126 image height and width, measured in pixels. If it is a floating
9127 point number, it specifies the maximum image height and width
9128 as a ratio to the frame height and width. If the value is
9129 non-numeric, there is no explicit limit on the size of images. */);
9130 Vmax_image_size
= make_float (MAX_IMAGE_SIZE
);
9132 DEFSYM (Qcount
, "count");
9133 DEFSYM (Qextension_data
, "extension-data");
9134 DEFSYM (Qdelay
, "delay");
9136 DEFSYM (QCascent
, ":ascent");
9137 DEFSYM (QCmargin
, ":margin");
9138 DEFSYM (QCrelief
, ":relief");
9139 DEFSYM (QCconversion
, ":conversion");
9140 DEFSYM (QCcolor_symbols
, ":color-symbols");
9141 DEFSYM (QCheuristic_mask
, ":heuristic-mask");
9142 DEFSYM (QCindex
, ":index");
9143 DEFSYM (QCgeometry
, ":geometry");
9144 DEFSYM (QCcrop
, ":crop");
9145 DEFSYM (QCrotation
, ":rotation");
9146 DEFSYM (QCmatrix
, ":matrix");
9147 DEFSYM (QCcolor_adjustment
, ":color-adjustment");
9148 DEFSYM (QCmask
, ":mask");
9150 DEFSYM (Qlaplace
, "laplace");
9151 DEFSYM (Qemboss
, "emboss");
9152 DEFSYM (Qedge_detection
, "edge-detection");
9153 DEFSYM (Qheuristic
, "heuristic");
9155 DEFSYM (Qpostscript
, "postscript");
9156 DEFSYM (QCmax_width
, ":max-width");
9157 DEFSYM (QCmax_height
, ":max-height");
9158 DEFSYM (QCcontent_type
, ":content-type");
9159 #ifdef HAVE_GHOSTSCRIPT
9160 ADD_IMAGE_TYPE (Qpostscript
);
9161 DEFSYM (QCloader
, ":loader");
9162 DEFSYM (QCbounding_box
, ":bounding-box");
9163 DEFSYM (QCpt_width
, ":pt-width");
9164 DEFSYM (QCpt_height
, ":pt-height");
9165 #endif /* HAVE_GHOSTSCRIPT */
9168 DEFSYM (Qlibpng_version
, "libpng-version");
9169 Fset (Qlibpng_version
,
9171 make_number (PNG_LIBPNG_VER
)
9178 DEFSYM (Qpbm
, "pbm");
9179 ADD_IMAGE_TYPE (Qpbm
);
9181 DEFSYM (Qxbm
, "xbm");
9182 ADD_IMAGE_TYPE (Qxbm
);
9184 #if defined (HAVE_XPM) || defined (HAVE_NS)
9185 DEFSYM (Qxpm
, "xpm");
9186 ADD_IMAGE_TYPE (Qxpm
);
9189 #if defined (HAVE_JPEG) || defined (HAVE_NS)
9190 DEFSYM (Qjpeg
, "jpeg");
9191 ADD_IMAGE_TYPE (Qjpeg
);
9194 #if defined (HAVE_TIFF) || defined (HAVE_NS)
9195 DEFSYM (Qtiff
, "tiff");
9196 ADD_IMAGE_TYPE (Qtiff
);
9199 #if defined (HAVE_GIF) || defined (HAVE_NS)
9200 DEFSYM (Qgif
, "gif");
9201 ADD_IMAGE_TYPE (Qgif
);
9204 #if defined (HAVE_PNG) || defined (HAVE_NS)
9205 DEFSYM (Qpng
, "png");
9206 ADD_IMAGE_TYPE (Qpng
);
9209 #if defined (HAVE_IMAGEMAGICK)
9210 DEFSYM (Qimagemagick
, "imagemagick");
9211 ADD_IMAGE_TYPE (Qimagemagick
);
9214 #if defined (HAVE_RSVG)
9215 DEFSYM (Qsvg
, "svg");
9216 ADD_IMAGE_TYPE (Qsvg
);
9218 /* Other libraries used directly by svg code. */
9219 DEFSYM (Qgdk_pixbuf
, "gdk-pixbuf");
9220 DEFSYM (Qglib
, "glib");
9221 DEFSYM (Qgobject
, "gobject");
9222 #endif /* HAVE_NTGUI */
9223 #endif /* HAVE_RSVG */
9225 defsubr (&Sinit_image_library
);
9226 #ifdef HAVE_IMAGEMAGICK
9227 defsubr (&Simagemagick_types
);
9229 defsubr (&Sclear_image_cache
);
9230 defsubr (&Simage_flush
);
9231 defsubr (&Simage_size
);
9232 defsubr (&Simage_mask_p
);
9233 defsubr (&Simage_metadata
);
9237 defsubr (&Slookup_image
);
9240 DEFVAR_BOOL ("cross-disabled-images", cross_disabled_images
,
9241 doc
: /* Non-nil means always draw a cross over disabled images.
9242 Disabled images are those having a `:conversion disabled' property.
9243 A cross is always drawn on black & white displays. */);
9244 cross_disabled_images
= 0;
9246 DEFVAR_LISP ("x-bitmap-file-path", Vx_bitmap_file_path
,
9247 doc
: /* List of directories to search for window system bitmap files. */);
9248 Vx_bitmap_file_path
= decode_env_path (0, PATH_BITMAPS
);
9250 DEFVAR_LISP ("image-cache-eviction-delay", Vimage_cache_eviction_delay
,
9251 doc
: /* Maximum time after which images are removed from the cache.
9252 When an image has not been displayed this many seconds, Emacs
9253 automatically removes it from the image cache. If the cache contains
9254 a large number of images, the actual eviction time may be shorter.
9255 The value can also be nil, meaning the cache is never cleared.
9257 The function `clear-image-cache' disregards this variable. */);
9258 Vimage_cache_eviction_delay
= make_number (300);
9259 #ifdef HAVE_IMAGEMAGICK
9260 DEFVAR_INT ("imagemagick-render-type", imagemagick_render_type
,
9261 doc
: /* Integer indicating which ImageMagick rendering method to use.
9263 0 -- the default method (pixel pushing)
9264 1 -- a newer method ("MagickExportImagePixels") that may perform
9265 better (speed etc) in some cases, but has not been as thoroughly
9266 tested with Emacs as the default method. This method requires
9267 ImageMagick version 6.4.6 (approximately) or later.
9269 /* MagickExportImagePixels is in 6.4.6-9, but not 6.4.4-10. */
9270 imagemagick_render_type
= 0;