1 /* Functions for image support on window system.
3 Copyright (C) 1989, 1992-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
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 RGB_PIXEL_COLOR unsigned long
73 #define PIX_MASK_RETAIN 0
74 #define PIX_MASK_DRAW 1
75 #endif /* HAVE_X_WINDOWS */
79 /* W32_TODO : Color tables on W32. */
80 #undef COLOR_TABLE_SUPPORT
82 typedef struct w32_bitmap_record Bitmap_Record
;
83 #define GET_PIXEL(ximg, x, y) GetPixel (ximg, x, y)
86 #define RGB_PIXEL_COLOR COLORREF
88 #define PIX_MASK_RETAIN 0
89 #define PIX_MASK_DRAW 1
91 #define x_defined_color w32_defined_color
92 #define DefaultDepthOfScreen(screen) (one_w32_display_info.n_cbits)
94 /* Version of libpng that we were compiled with, or -1 if no PNG
95 support was compiled in. This is tested by w32-win.el to correctly
96 set up the alist used to search for PNG libraries. */
97 Lisp_Object Qlibpng_version
;
98 #endif /* HAVE_NTGUI */
101 #undef COLOR_TABLE_SUPPORT
103 typedef struct ns_bitmap_record Bitmap_Record
;
105 #define GET_PIXEL(ximg, x, y) XGetPixel (ximg, x, y)
108 #define RGB_PIXEL_COLOR unsigned long
111 #define PIX_MASK_RETAIN 0
112 #define PIX_MASK_DRAW 1
114 #define x_defined_color(f, name, color_def, alloc) \
115 ns_defined_color (f, name, color_def, alloc, 0)
116 #define DefaultDepthOfScreen(screen) x_display_list->n_planes
120 /* The symbol `postscript' identifying images of this type. */
122 static Lisp_Object Qpostscript
;
124 static void x_disable_image (struct frame
*, struct image
*);
125 static void x_edge_detection (struct frame
*, struct image
*, Lisp_Object
,
128 static void init_color_table (void);
129 static unsigned long lookup_rgb_color (struct frame
*f
, int r
, int g
, int b
);
130 #ifdef COLOR_TABLE_SUPPORT
131 static void free_color_table (void);
132 static unsigned long *colors_in_color_table (int *n
);
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. */
148 XGetImage (Display
*display
, Pixmap pixmap
, int x
, int y
,
149 unsigned int width
, unsigned int height
,
150 unsigned long plane_mask
, int format
)
152 /* TODO: not sure what this function is supposed to do.. */
153 ns_retain_object (pixmap
);
157 /* use with imgs created by ns_image_for_XPM */
159 XGetPixel (XImagePtr ximage
, int x
, int y
)
161 return ns_get_pixel (ximage
, x
, y
);
164 /* use with imgs created by ns_image_for_XPM; alpha set to 1;
165 pixel is assumed to be in form RGB */
167 XPutPixel (XImagePtr ximage
, int x
, int y
, unsigned long pixel
)
169 ns_put_pixel (ximage
, x
, y
, pixel
);
174 /* Functions to access the contents of a bitmap, given an id. */
177 x_bitmap_height (FRAME_PTR f
, ptrdiff_t id
)
179 return FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].height
;
183 x_bitmap_width (FRAME_PTR f
, ptrdiff_t id
)
185 return FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].width
;
188 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI)
190 x_bitmap_pixmap (FRAME_PTR f
, ptrdiff_t id
)
192 /* HAVE_NTGUI needs the explicit cast here. */
193 return (int) FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].pixmap
;
197 #ifdef HAVE_X_WINDOWS
199 x_bitmap_mask (FRAME_PTR f
, ptrdiff_t id
)
201 return FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].mask
;
205 /* Allocate a new bitmap record. Returns index of new record. */
208 x_allocate_bitmap_record (FRAME_PTR f
)
210 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
213 if (dpyinfo
->bitmaps_last
< dpyinfo
->bitmaps_size
)
214 return ++dpyinfo
->bitmaps_last
;
216 for (i
= 0; i
< dpyinfo
->bitmaps_size
; ++i
)
217 if (dpyinfo
->bitmaps
[i
].refcount
== 0)
221 xpalloc (dpyinfo
->bitmaps
, &dpyinfo
->bitmaps_size
,
222 10, -1, sizeof *dpyinfo
->bitmaps
);
223 return ++dpyinfo
->bitmaps_last
;
226 /* Add one reference to the reference count of the bitmap with id ID. */
229 x_reference_bitmap (FRAME_PTR f
, ptrdiff_t id
)
231 ++FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].refcount
;
234 /* Create a bitmap for frame F from a HEIGHT x WIDTH array of bits at BITS. */
237 x_create_bitmap_from_data (struct frame
*f
, char *bits
, unsigned int width
, unsigned int height
)
239 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
242 #ifdef HAVE_X_WINDOWS
244 bitmap
= XCreateBitmapFromData (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
245 bits
, width
, height
);
248 #endif /* HAVE_X_WINDOWS */
252 bitmap
= CreateBitmap (width
, height
,
253 FRAME_X_DISPLAY_INFO (XFRAME (frame
))->n_planes
,
254 FRAME_X_DISPLAY_INFO (XFRAME (frame
))->n_cbits
,
258 #endif /* HAVE_NTGUI */
261 void *bitmap
= ns_image_from_XBM (bits
, width
, height
);
266 id
= x_allocate_bitmap_record (f
);
269 dpyinfo
->bitmaps
[id
- 1].img
= bitmap
;
270 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
273 dpyinfo
->bitmaps
[id
- 1].file
= NULL
;
274 dpyinfo
->bitmaps
[id
- 1].height
= height
;
275 dpyinfo
->bitmaps
[id
- 1].width
= width
;
276 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
278 #ifdef HAVE_X_WINDOWS
279 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
280 dpyinfo
->bitmaps
[id
- 1].have_mask
= 0;
281 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
282 #endif /* HAVE_X_WINDOWS */
285 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
286 dpyinfo
->bitmaps
[id
- 1].hinst
= NULL
;
287 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
288 #endif /* HAVE_NTGUI */
293 /* Create bitmap from file FILE for frame F. */
296 x_create_bitmap_from_file (struct frame
*f
, Lisp_Object file
)
298 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
301 return -1; /* W32_TODO : bitmap support */
302 #endif /* HAVE_NTGUI */
306 void *bitmap
= ns_image_from_file (file
);
312 id
= x_allocate_bitmap_record (f
);
313 dpyinfo
->bitmaps
[id
- 1].img
= bitmap
;
314 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
315 dpyinfo
->bitmaps
[id
- 1].file
= xmalloc (SBYTES (file
) + 1);
316 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
317 dpyinfo
->bitmaps
[id
- 1].height
= ns_image_width (bitmap
);
318 dpyinfo
->bitmaps
[id
- 1].width
= ns_image_height (bitmap
);
319 strcpy (dpyinfo
->bitmaps
[id
- 1].file
, SSDATA (file
));
323 #ifdef HAVE_X_WINDOWS
324 unsigned int width
, height
;
326 int xhot
, yhot
, result
;
332 /* Look for an existing bitmap with the same name. */
333 for (id
= 0; id
< dpyinfo
->bitmaps_last
; ++id
)
335 if (dpyinfo
->bitmaps
[id
].refcount
336 && dpyinfo
->bitmaps
[id
].file
337 && !strcmp (dpyinfo
->bitmaps
[id
].file
, SSDATA (file
)))
339 ++dpyinfo
->bitmaps
[id
].refcount
;
344 /* Search bitmap-file-path for the file, if appropriate. */
345 fd
= openp (Vx_bitmap_file_path
, file
, Qnil
, &found
, Qnil
);
350 filename
= SSDATA (found
);
352 result
= XReadBitmapFile (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
353 filename
, &width
, &height
, &bitmap
, &xhot
, &yhot
);
354 if (result
!= BitmapSuccess
)
357 id
= x_allocate_bitmap_record (f
);
358 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
359 dpyinfo
->bitmaps
[id
- 1].have_mask
= 0;
360 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
361 dpyinfo
->bitmaps
[id
- 1].file
= xmalloc (SBYTES (file
) + 1);
362 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
363 dpyinfo
->bitmaps
[id
- 1].height
= height
;
364 dpyinfo
->bitmaps
[id
- 1].width
= width
;
365 strcpy (dpyinfo
->bitmaps
[id
- 1].file
, SSDATA (file
));
368 #endif /* HAVE_X_WINDOWS */
374 free_bitmap_record (Display_Info
*dpyinfo
, Bitmap_Record
*bm
)
376 #ifdef HAVE_X_WINDOWS
377 XFreePixmap (dpyinfo
->display
, bm
->pixmap
);
379 XFreePixmap (dpyinfo
->display
, bm
->mask
);
380 #endif /* HAVE_X_WINDOWS */
383 DeleteObject (bm
->pixmap
);
384 #endif /* HAVE_NTGUI */
387 ns_release_object (bm
->img
);
397 /* Remove reference to bitmap with id number ID. */
400 x_destroy_bitmap (FRAME_PTR f
, ptrdiff_t id
)
402 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
406 Bitmap_Record
*bm
= &dpyinfo
->bitmaps
[id
- 1];
408 if (--bm
->refcount
== 0)
411 free_bitmap_record (dpyinfo
, bm
);
417 /* Free all the bitmaps for the display specified by DPYINFO. */
420 x_destroy_all_bitmaps (Display_Info
*dpyinfo
)
423 Bitmap_Record
*bm
= dpyinfo
->bitmaps
;
425 for (i
= 0; i
< dpyinfo
->bitmaps_last
; i
++, bm
++)
426 if (bm
->refcount
> 0)
427 free_bitmap_record (dpyinfo
, bm
);
429 dpyinfo
->bitmaps_last
= 0;
433 #ifdef HAVE_X_WINDOWS
435 /* Useful functions defined in the section
436 `Image type independent image structures' below. */
438 static unsigned long four_corners_best (XImagePtr ximg
,
441 unsigned long height
);
443 static int x_create_x_image_and_pixmap (struct frame
*f
, int width
, int height
,
444 int depth
, XImagePtr
*ximg
,
447 static void x_destroy_x_image (XImagePtr ximg
);
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 (interrupt_input_blocked
);
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
);
532 #endif /* HAVE_X_WINDOWS */
535 /***********************************************************************
537 ***********************************************************************/
539 /* List of supported image types. Use define_image_type to add new
540 types. Use lookup_image_type to find a type for a given symbol. */
542 static struct image_type
*image_types
;
544 /* The symbol `xbm' which is used as the type symbol for XBM images. */
546 static Lisp_Object Qxbm
;
550 Lisp_Object QCascent
, QCmargin
, QCrelief
;
551 Lisp_Object QCconversion
;
552 static Lisp_Object QCheuristic_mask
;
553 static Lisp_Object QCcolor_symbols
;
554 static Lisp_Object QCindex
, QCmatrix
, QCcolor_adjustment
, QCmask
, QCgeometry
;
555 static Lisp_Object QCcrop
, QCrotation
;
559 static Lisp_Object Qcount
, Qextension_data
, Qdelay
;
560 static Lisp_Object Qlaplace
, Qemboss
, Qedge_detection
, Qheuristic
;
562 /* Function prototypes. */
564 static Lisp_Object
define_image_type (struct image_type
*type
, int loaded
);
565 static struct image_type
*lookup_image_type (Lisp_Object symbol
);
566 static void image_error (const char *format
, Lisp_Object
, Lisp_Object
);
567 static void x_laplace (struct frame
*, struct image
*);
568 static void x_emboss (struct frame
*, struct image
*);
569 static int x_build_heuristic_mask (struct frame
*, struct image
*,
572 #define CACHE_IMAGE_TYPE(type, status) \
573 do { Vlibrary_cache = Fcons (Fcons (type, status), Vlibrary_cache); } while (0)
575 #define CACHE_IMAGE_TYPE(type, status)
578 #define ADD_IMAGE_TYPE(type) \
579 do { Vimage_types = Fcons (type, Vimage_types); } while (0)
581 /* Define a new image type from TYPE. This adds a copy of TYPE to
582 image_types and caches the loading status of TYPE. */
585 define_image_type (struct image_type
*type
, int loaded
)
593 /* Make a copy of TYPE to avoid a bus error in a dumped Emacs.
594 The initialized data segment is read-only. */
595 struct image_type
*p
= xmalloc (sizeof *p
);
597 p
->next
= image_types
;
602 CACHE_IMAGE_TYPE (*type
->type
, success
);
607 /* Look up image type SYMBOL, and return a pointer to its image_type
608 structure. Value is null if SYMBOL is not a known image type. */
610 static inline struct image_type
*
611 lookup_image_type (Lisp_Object symbol
)
613 struct image_type
*type
;
615 /* We must initialize the image-type if it hasn't been already. */
616 if (NILP (Finit_image_library (symbol
, Vdynamic_library_alist
)))
617 return 0; /* unimplemented */
619 for (type
= image_types
; type
; type
= type
->next
)
620 if (EQ (symbol
, *type
->type
))
627 /* Value is non-zero if OBJECT is a valid Lisp image specification. A
628 valid image specification is a list whose car is the symbol
629 `image', and whose rest is a property list. The property list must
630 contain a value for key `:type'. That value must be the name of a
631 supported image type. The rest of the property list depends on the
635 valid_image_p (Lisp_Object object
)
643 for (tem
= XCDR (object
); CONSP (tem
); tem
= XCDR (tem
))
644 if (EQ (XCAR (tem
), QCtype
))
647 if (CONSP (tem
) && SYMBOLP (XCAR (tem
)))
649 struct image_type
*type
;
650 type
= lookup_image_type (XCAR (tem
));
652 valid_p
= type
->valid_p (object
);
663 /* Log error message with format string FORMAT and argument ARG.
664 Signaling an error, e.g. when an image cannot be loaded, is not a
665 good idea because this would interrupt redisplay, and the error
666 message display would lead to another redisplay. This function
667 therefore simply displays a message. */
670 image_error (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
672 add_to_log (format
, arg1
, arg2
);
677 /***********************************************************************
679 ***********************************************************************/
681 enum image_value_type
683 IMAGE_DONT_CHECK_VALUE_TYPE
,
685 IMAGE_STRING_OR_NIL_VALUE
,
687 IMAGE_POSITIVE_INTEGER_VALUE
,
688 IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
,
689 IMAGE_NON_NEGATIVE_INTEGER_VALUE
,
692 IMAGE_FUNCTION_VALUE
,
697 /* Structure used when parsing image specifications. */
701 /* Name of keyword. */
704 /* The type of value allowed. */
705 enum image_value_type type
;
707 /* Non-zero means key must be present. */
710 /* Used to recognize duplicate keywords in a property list. */
713 /* The value that was found. */
718 static int parse_image_spec (Lisp_Object
, struct image_keyword
*,
720 static Lisp_Object
image_spec_value (Lisp_Object
, Lisp_Object
, int *);
723 /* Parse image spec SPEC according to KEYWORDS. A valid image spec
724 has the format (image KEYWORD VALUE ...). One of the keyword/
725 value pairs must be `:type TYPE'. KEYWORDS is a vector of
726 image_keywords structures of size NKEYWORDS describing other
727 allowed keyword/value pairs. Value is non-zero if SPEC is valid. */
730 parse_image_spec (Lisp_Object spec
, struct image_keyword
*keywords
,
731 int nkeywords
, Lisp_Object type
)
740 while (CONSP (plist
))
742 Lisp_Object key
, value
;
744 /* First element of a pair must be a symbol. */
746 plist
= XCDR (plist
);
750 /* There must follow a value. */
753 value
= XCAR (plist
);
754 plist
= XCDR (plist
);
756 /* Find key in KEYWORDS. Error if not found. */
757 for (i
= 0; i
< nkeywords
; ++i
)
758 if (strcmp (keywords
[i
].name
, SSDATA (SYMBOL_NAME (key
))) == 0)
764 /* Record that we recognized the keyword. If a keywords
765 was found more than once, it's an error. */
766 keywords
[i
].value
= value
;
767 if (keywords
[i
].count
> 1)
771 /* Check type of value against allowed type. */
772 switch (keywords
[i
].type
)
774 case IMAGE_STRING_VALUE
:
775 if (!STRINGP (value
))
779 case IMAGE_STRING_OR_NIL_VALUE
:
780 if (!STRINGP (value
) && !NILP (value
))
784 case IMAGE_SYMBOL_VALUE
:
785 if (!SYMBOLP (value
))
789 case IMAGE_POSITIVE_INTEGER_VALUE
:
790 if (! RANGED_INTEGERP (1, value
, INT_MAX
))
794 case IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
:
795 if (RANGED_INTEGERP (0, value
, INT_MAX
))
798 && RANGED_INTEGERP (0, XCAR (value
), INT_MAX
)
799 && RANGED_INTEGERP (0, XCDR (value
), INT_MAX
))
803 case IMAGE_ASCENT_VALUE
:
804 if (SYMBOLP (value
) && EQ (value
, Qcenter
))
806 else if (RANGED_INTEGERP (0, value
, 100))
810 case IMAGE_NON_NEGATIVE_INTEGER_VALUE
:
811 /* Unlike the other integer-related cases, this one does not
812 verify that VALUE fits in 'int'. This is because callers
814 if (!INTEGERP (value
) || XINT (value
) < 0)
818 case IMAGE_DONT_CHECK_VALUE_TYPE
:
821 case IMAGE_FUNCTION_VALUE
:
822 value
= indirect_function (value
);
823 if (!NILP (Ffunctionp (value
)))
827 case IMAGE_NUMBER_VALUE
:
828 if (!INTEGERP (value
) && !FLOATP (value
))
832 case IMAGE_INTEGER_VALUE
:
833 if (! TYPE_RANGED_INTEGERP (int, value
))
837 case IMAGE_BOOL_VALUE
:
838 if (!NILP (value
) && !EQ (value
, Qt
))
847 if (EQ (key
, QCtype
) && !EQ (type
, value
))
851 /* Check that all mandatory fields are present. */
852 for (i
= 0; i
< nkeywords
; ++i
)
853 if (keywords
[i
].mandatory_p
&& keywords
[i
].count
== 0)
860 /* Return the value of KEY in image specification SPEC. Value is nil
861 if KEY is not present in SPEC. if FOUND is not null, set *FOUND
862 to 1 if KEY was found in SPEC, set it to 0 otherwise. */
865 image_spec_value (Lisp_Object spec
, Lisp_Object key
, int *found
)
869 eassert (valid_image_p (spec
));
871 for (tail
= XCDR (spec
);
872 CONSP (tail
) && CONSP (XCDR (tail
));
873 tail
= XCDR (XCDR (tail
)))
875 if (EQ (XCAR (tail
), key
))
879 return XCAR (XCDR (tail
));
889 DEFUN ("image-size", Fimage_size
, Simage_size
, 1, 3, 0,
890 doc
: /* Return the size of image SPEC as pair (WIDTH . HEIGHT).
891 PIXELS non-nil means return the size in pixels, otherwise return the
892 size in canonical character units.
893 FRAME is the frame on which the image will be displayed. FRAME nil
894 or omitted means use the selected frame. */)
895 (Lisp_Object spec
, Lisp_Object pixels
, Lisp_Object frame
)
900 if (valid_image_p (spec
))
902 struct frame
*f
= check_x_frame (frame
);
903 ptrdiff_t id
= lookup_image (f
, spec
);
904 struct image
*img
= IMAGE_FROM_ID (f
, id
);
905 int width
= img
->width
+ 2 * img
->hmargin
;
906 int height
= img
->height
+ 2 * img
->vmargin
;
909 size
= Fcons (make_float ((double) width
/ FRAME_COLUMN_WIDTH (f
)),
910 make_float ((double) height
/ FRAME_LINE_HEIGHT (f
)));
912 size
= Fcons (make_number (width
), make_number (height
));
915 error ("Invalid image specification");
921 DEFUN ("image-mask-p", Fimage_mask_p
, Simage_mask_p
, 1, 2, 0,
922 doc
: /* Return t if image SPEC has a mask bitmap.
923 FRAME is the frame on which the image will be displayed. FRAME nil
924 or omitted means use the selected frame. */)
925 (Lisp_Object spec
, Lisp_Object frame
)
930 if (valid_image_p (spec
))
932 struct frame
*f
= check_x_frame (frame
);
933 ptrdiff_t id
= lookup_image (f
, spec
);
934 struct image
*img
= IMAGE_FROM_ID (f
, id
);
939 error ("Invalid image specification");
944 DEFUN ("image-metadata", Fimage_metadata
, Simage_metadata
, 1, 2, 0,
945 doc
: /* Return metadata for image SPEC.
946 FRAME is the frame on which the image will be displayed. FRAME nil
947 or omitted means use the selected frame. */)
948 (Lisp_Object spec
, Lisp_Object frame
)
953 if (valid_image_p (spec
))
955 struct frame
*f
= check_x_frame (frame
);
956 ptrdiff_t id
= lookup_image (f
, spec
);
957 struct image
*img
= IMAGE_FROM_ID (f
, id
);
958 ext
= img
->lisp_data
;
965 /***********************************************************************
966 Image type independent image structures
967 ***********************************************************************/
969 static void free_image (struct frame
*f
, struct image
*img
);
971 #define MAX_IMAGE_SIZE 10.0
972 /* Allocate and return a new image structure for image specification
973 SPEC. SPEC has a hash value of HASH. */
975 static struct image
*
976 make_image (Lisp_Object spec
, EMACS_UINT hash
)
978 struct image
*img
= xzalloc (sizeof *img
);
979 Lisp_Object file
= image_spec_value (spec
, QCfile
, NULL
);
981 eassert (valid_image_p (spec
));
982 img
->dependencies
= NILP (file
) ? Qnil
: list1 (file
);
983 img
->type
= lookup_image_type (image_spec_value (spec
, QCtype
, NULL
));
984 eassert (img
->type
!= NULL
);
986 img
->lisp_data
= Qnil
;
987 img
->ascent
= DEFAULT_IMAGE_ASCENT
;
989 img
->corners
[BOT_CORNER
] = -1; /* Full image */
994 /* Free image IMG which was used on frame F, including its resources. */
997 free_image (struct frame
*f
, struct image
*img
)
1001 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1003 /* Remove IMG from the hash table of its cache. */
1005 img
->prev
->next
= img
->next
;
1007 c
->buckets
[img
->hash
% IMAGE_CACHE_BUCKETS_SIZE
] = img
->next
;
1010 img
->next
->prev
= img
->prev
;
1012 c
->images
[img
->id
] = NULL
;
1014 /* Free resources, then free IMG. */
1015 img
->type
->free (f
, img
);
1020 /* Return 1 if the given widths and heights are valid for display;
1021 otherwise, return 0. */
1024 check_image_size (struct frame
*f
, int width
, int height
)
1028 if (width
<= 0 || height
<= 0)
1031 if (INTEGERP (Vmax_image_size
))
1032 return (width
<= XINT (Vmax_image_size
)
1033 && height
<= XINT (Vmax_image_size
));
1034 else if (FLOATP (Vmax_image_size
))
1038 w
= FRAME_PIXEL_WIDTH (f
);
1039 h
= FRAME_PIXEL_HEIGHT (f
);
1042 w
= h
= 1024; /* Arbitrary size for unknown frame. */
1043 return (width
<= XFLOAT_DATA (Vmax_image_size
) * w
1044 && height
<= XFLOAT_DATA (Vmax_image_size
) * h
);
1050 /* Prepare image IMG for display on frame F. Must be called before
1051 drawing an image. */
1054 prepare_image_for_display (struct frame
*f
, struct image
*img
)
1056 /* We're about to display IMG, so set its timestamp to `now'. */
1057 img
->timestamp
= current_emacs_time ();
1059 /* If IMG doesn't have a pixmap yet, load it now, using the image
1060 type dependent loader function. */
1061 if (img
->pixmap
== NO_PIXMAP
&& !img
->load_failed_p
)
1062 img
->load_failed_p
= img
->type
->load (f
, img
) == 0;
1067 /* Value is the number of pixels for the ascent of image IMG when
1068 drawn in face FACE. */
1071 image_ascent (struct image
*img
, struct face
*face
, struct glyph_slice
*slice
)
1076 if (slice
->height
== img
->height
)
1077 height
= img
->height
+ img
->vmargin
;
1078 else if (slice
->y
== 0)
1079 height
= slice
->height
+ img
->vmargin
;
1081 height
= slice
->height
;
1083 if (img
->ascent
== CENTERED_IMAGE_ASCENT
)
1088 /* W32 specific version. Why?. ++kfs */
1089 ascent
= height
/ 2 - (FONT_DESCENT (face
->font
)
1090 - FONT_BASE (face
->font
)) / 2;
1092 /* This expression is arranged so that if the image can't be
1093 exactly centered, it will be moved slightly up. This is
1094 because a typical font is `top-heavy' (due to the presence
1095 uppercase letters), so the image placement should err towards
1096 being top-heavy too. It also just generally looks better. */
1097 ascent
= (height
+ FONT_BASE (face
->font
)
1098 - FONT_DESCENT (face
->font
) + 1) / 2;
1099 #endif /* HAVE_NTGUI */
1102 ascent
= height
/ 2;
1105 ascent
= height
* (img
->ascent
/ 100.0);
1111 /* Image background colors. */
1113 /* Find the "best" corner color of a bitmap.
1114 On W32, XIMG is assumed to a device context with the bitmap selected. */
1116 static RGB_PIXEL_COLOR
1117 four_corners_best (XImagePtr_or_DC ximg
, int *corners
,
1118 unsigned long width
, unsigned long height
)
1120 RGB_PIXEL_COLOR corner_pixels
[4], best
IF_LINT (= 0);
1123 if (corners
&& corners
[BOT_CORNER
] >= 0)
1125 /* Get the colors at the corner_pixels of ximg. */
1126 corner_pixels
[0] = GET_PIXEL (ximg
, corners
[LEFT_CORNER
], corners
[TOP_CORNER
]);
1127 corner_pixels
[1] = GET_PIXEL (ximg
, corners
[RIGHT_CORNER
] - 1, corners
[TOP_CORNER
]);
1128 corner_pixels
[2] = GET_PIXEL (ximg
, corners
[RIGHT_CORNER
] - 1, corners
[BOT_CORNER
] - 1);
1129 corner_pixels
[3] = GET_PIXEL (ximg
, corners
[LEFT_CORNER
], corners
[BOT_CORNER
] - 1);
1133 /* Get the colors at the corner_pixels of ximg. */
1134 corner_pixels
[0] = GET_PIXEL (ximg
, 0, 0);
1135 corner_pixels
[1] = GET_PIXEL (ximg
, width
- 1, 0);
1136 corner_pixels
[2] = GET_PIXEL (ximg
, width
- 1, height
- 1);
1137 corner_pixels
[3] = GET_PIXEL (ximg
, 0, height
- 1);
1139 /* Choose the most frequently found color as background. */
1140 for (i
= best_count
= 0; i
< 4; ++i
)
1144 for (j
= n
= 0; j
< 4; ++j
)
1145 if (corner_pixels
[i
] == corner_pixels
[j
])
1149 best
= corner_pixels
[i
], best_count
= n
;
1155 /* Portability macros */
1159 #define Destroy_Image(img_dc, prev) \
1160 do { SelectObject (img_dc, prev); DeleteDC (img_dc); } while (0)
1162 #define Free_Pixmap(display, pixmap) \
1163 DeleteObject (pixmap)
1165 #elif defined (HAVE_NS)
1167 #define Destroy_Image(ximg, dummy) \
1168 ns_release_object (ximg)
1170 #define Free_Pixmap(display, pixmap) \
1171 ns_release_object (pixmap)
1175 #define Destroy_Image(ximg, dummy) \
1176 XDestroyImage (ximg)
1178 #define Free_Pixmap(display, pixmap) \
1179 XFreePixmap (display, pixmap)
1181 #endif /* !HAVE_NTGUI && !HAVE_NS */
1184 /* Return the `background' field of IMG. If IMG doesn't have one yet,
1185 it is guessed heuristically. If non-zero, XIMG is an existing
1186 XImage object (or device context with the image selected on W32) to
1187 use for the heuristic. */
1190 image_background (struct image
*img
, struct frame
*f
, XImagePtr_or_DC ximg
)
1192 if (! img
->background_valid
)
1193 /* IMG doesn't have a background yet, try to guess a reasonable value. */
1195 int free_ximg
= !ximg
;
1198 #endif /* HAVE_NTGUI */
1203 ximg
= XGetImage (FRAME_X_DISPLAY (f
), img
->pixmap
,
1204 0, 0, img
->width
, img
->height
, ~0, ZPixmap
);
1206 HDC frame_dc
= get_frame_dc (f
);
1207 ximg
= CreateCompatibleDC (frame_dc
);
1208 release_frame_dc (f
, frame_dc
);
1209 prev
= SelectObject (ximg
, img
->pixmap
);
1210 #endif /* !HAVE_NTGUI */
1213 img
->background
= four_corners_best (ximg
, img
->corners
, img
->width
, img
->height
);
1216 Destroy_Image (ximg
, prev
);
1218 img
->background_valid
= 1;
1221 return img
->background
;
1224 /* Return the `background_transparent' field of IMG. If IMG doesn't
1225 have one yet, it is guessed heuristically. If non-zero, MASK is an
1226 existing XImage object to use for the heuristic. */
1229 image_background_transparent (struct image
*img
, struct frame
*f
, XImagePtr_or_DC mask
)
1231 if (! img
->background_transparent_valid
)
1232 /* IMG doesn't have a background yet, try to guess a reasonable value. */
1236 int free_mask
= !mask
;
1239 #endif /* HAVE_NTGUI */
1244 mask
= XGetImage (FRAME_X_DISPLAY (f
), img
->mask
,
1245 0, 0, img
->width
, img
->height
, ~0, ZPixmap
);
1247 HDC frame_dc
= get_frame_dc (f
);
1248 mask
= CreateCompatibleDC (frame_dc
);
1249 release_frame_dc (f
, frame_dc
);
1250 prev
= SelectObject (mask
, img
->mask
);
1251 #endif /* HAVE_NTGUI */
1254 img
->background_transparent
1255 = (four_corners_best (mask
, img
->corners
, img
->width
, img
->height
) == PIX_MASK_RETAIN
);
1258 Destroy_Image (mask
, prev
);
1261 img
->background_transparent
= 0;
1263 img
->background_transparent_valid
= 1;
1266 return img
->background_transparent
;
1270 /***********************************************************************
1271 Helper functions for X image types
1272 ***********************************************************************/
1274 static void x_clear_image_1 (struct frame
*, struct image
*, int,
1276 static void x_clear_image (struct frame
*f
, struct image
*img
);
1277 static unsigned long x_alloc_image_color (struct frame
*f
,
1279 Lisp_Object color_name
,
1280 unsigned long dflt
);
1283 /* Clear X resources of image IMG on frame F. PIXMAP_P non-zero means
1284 free the pixmap if any. MASK_P non-zero means clear the mask
1285 pixmap if any. COLORS_P non-zero means free colors allocated for
1286 the image, if any. */
1289 x_clear_image_1 (struct frame
*f
, struct image
*img
, int pixmap_p
, int mask_p
,
1292 if (pixmap_p
&& img
->pixmap
)
1294 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->pixmap
);
1295 img
->pixmap
= NO_PIXMAP
;
1296 /* NOTE (HAVE_NS): background color is NOT an indexed color! */
1297 img
->background_valid
= 0;
1300 if (mask_p
&& img
->mask
)
1302 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->mask
);
1303 img
->mask
= NO_PIXMAP
;
1304 img
->background_transparent_valid
= 0;
1307 if (colors_p
&& img
->ncolors
)
1309 /* W32_TODO: color table support. */
1310 #ifdef HAVE_X_WINDOWS
1311 x_free_colors (f
, img
->colors
, img
->ncolors
);
1312 #endif /* HAVE_X_WINDOWS */
1313 xfree (img
->colors
);
1320 /* Free X resources of image IMG which is used on frame F. */
1323 x_clear_image (struct frame
*f
, struct image
*img
)
1326 x_clear_image_1 (f
, img
, 1, 1, 1);
1331 /* Allocate color COLOR_NAME for image IMG on frame F. If color
1332 cannot be allocated, use DFLT. Add a newly allocated color to
1333 IMG->colors, so that it can be freed again. Value is the pixel
1336 static unsigned long
1337 x_alloc_image_color (struct frame
*f
, struct image
*img
, Lisp_Object color_name
,
1341 unsigned long result
;
1343 eassert (STRINGP (color_name
));
1345 if (x_defined_color (f
, SSDATA (color_name
), &color
, 1)
1346 && img
->ncolors
< min (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *img
->colors
,
1349 /* This isn't called frequently so we get away with simply
1350 reallocating the color vector to the needed size, here. */
1351 ptrdiff_t ncolors
= img
->ncolors
+ 1;
1352 img
->colors
= xrealloc (img
->colors
, ncolors
* sizeof *img
->colors
);
1353 img
->colors
[ncolors
- 1] = color
.pixel
;
1354 img
->ncolors
= ncolors
;
1355 result
= color
.pixel
;
1365 /***********************************************************************
1367 ***********************************************************************/
1369 static void cache_image (struct frame
*f
, struct image
*img
);
1370 static void postprocess_image (struct frame
*, struct image
*);
1372 /* Return a new, initialized image cache that is allocated from the
1373 heap. Call free_image_cache to free an image cache. */
1375 struct image_cache
*
1376 make_image_cache (void)
1378 struct image_cache
*c
= xzalloc (sizeof *c
);
1382 c
->images
= xmalloc (size
* sizeof *c
->images
);
1384 size
= IMAGE_CACHE_BUCKETS_SIZE
* sizeof *c
->buckets
;
1385 c
->buckets
= xzalloc (size
);
1390 /* Find an image matching SPEC in the cache, and return it. If no
1391 image is found, return NULL. */
1392 static struct image
*
1393 search_image_cache (struct frame
*f
, Lisp_Object spec
, EMACS_UINT hash
)
1396 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1397 int i
= hash
% IMAGE_CACHE_BUCKETS_SIZE
;
1399 if (!c
) return NULL
;
1401 /* If the image spec does not specify a background color, the cached
1402 image must have the same background color as the current frame.
1403 The foreground color must also match, for the sake of monochrome
1406 In fact, we could ignore the foreground color matching condition
1407 for color images, or if the image spec specifies :foreground;
1408 similarly we could ignore the background color matching condition
1409 for formats that don't use transparency (such as jpeg), or if the
1410 image spec specifies :background. However, the extra memory
1411 usage is probably negligible in practice, so we don't bother. */
1413 for (img
= c
->buckets
[i
]; img
; img
= img
->next
)
1414 if (img
->hash
== hash
1415 && !NILP (Fequal (img
->spec
, spec
))
1416 && img
->frame_foreground
== FRAME_FOREGROUND_PIXEL (f
)
1417 && img
->frame_background
== FRAME_BACKGROUND_PIXEL (f
))
1423 /* Search frame F for an image with spec SPEC, and free it. */
1426 uncache_image (struct frame
*f
, Lisp_Object spec
)
1428 struct image
*img
= search_image_cache (f
, spec
, sxhash (spec
, 0));
1431 free_image (f
, img
);
1432 /* As display glyphs may still be referring to the image ID, we
1433 must garbage the frame (Bug#6426). */
1434 SET_FRAME_GARBAGED (f
);
1439 /* Free image cache of frame F. Be aware that X frames share images
1443 free_image_cache (struct frame
*f
)
1445 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1450 /* Cache should not be referenced by any frame when freed. */
1451 eassert (c
->refcount
== 0);
1453 for (i
= 0; i
< c
->used
; ++i
)
1454 free_image (f
, c
->images
[i
]);
1458 FRAME_IMAGE_CACHE (f
) = NULL
;
1463 /* Clear image cache of frame F. FILTER=t means free all images.
1464 FILTER=nil means clear only images that haven't been
1465 displayed for some time.
1466 Else, only free the images which have FILTER in their `dependencies'.
1467 Should be called from time to time to reduce the number of loaded images.
1468 If image-cache-eviction-delay is non-nil, this frees images in the cache
1469 which weren't displayed for at least that many seconds. */
1472 clear_image_cache (struct frame
*f
, Lisp_Object filter
)
1474 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1478 ptrdiff_t i
, nfreed
= 0;
1480 /* Block input so that we won't be interrupted by a SIGIO
1481 while being in an inconsistent state. */
1486 /* Filter image cache. */
1487 for (i
= 0; i
< c
->used
; ++i
)
1489 struct image
*img
= c
->images
[i
];
1490 if (img
&& (EQ (Qt
, filter
)
1491 || !NILP (Fmember (filter
, img
->dependencies
))))
1493 free_image (f
, img
);
1498 else if (INTEGERP (Vimage_cache_eviction_delay
))
1500 /* Free cache based on timestamp. */
1503 ptrdiff_t nimages
= 0;
1505 for (i
= 0; i
< c
->used
; ++i
)
1509 /* If the number of cached images has grown unusually large,
1510 decrease the cache eviction delay (Bug#6230). */
1511 delay
= XINT (Vimage_cache_eviction_delay
);
1513 delay
= 1600 * delay
/ nimages
/ nimages
;
1514 delay
= max (delay
, 1);
1516 t
= current_emacs_time ();
1517 old
= sub_emacs_time (t
, EMACS_TIME_FROM_DOUBLE (delay
));
1519 for (i
= 0; i
< c
->used
; ++i
)
1521 struct image
*img
= c
->images
[i
];
1522 if (img
&& EMACS_TIME_LT (img
->timestamp
, old
))
1524 free_image (f
, img
);
1530 /* We may be clearing the image cache because, for example,
1531 Emacs was iconified for a longer period of time. In that
1532 case, current matrices may still contain references to
1533 images freed above. So, clear these matrices. */
1536 Lisp_Object tail
, frame
;
1538 FOR_EACH_FRAME (tail
, frame
)
1540 struct frame
*fr
= XFRAME (frame
);
1541 if (FRAME_IMAGE_CACHE (fr
) == c
)
1542 clear_current_matrices (fr
);
1545 ++windows_or_buffers_changed
;
1553 clear_image_caches (Lisp_Object filter
)
1555 /* FIXME: We want to do
1556 * struct terminal *t;
1557 * for (t = terminal_list; t; t = t->next_terminal)
1558 * clear_image_cache (t, filter); */
1559 Lisp_Object tail
, frame
;
1560 FOR_EACH_FRAME (tail
, frame
)
1561 if (FRAME_WINDOW_P (XFRAME (frame
)))
1562 clear_image_cache (XFRAME (frame
), filter
);
1565 DEFUN ("clear-image-cache", Fclear_image_cache
, Sclear_image_cache
,
1567 doc
: /* Clear the image cache.
1568 FILTER nil or a frame means clear all images in the selected frame.
1569 FILTER t means clear the image caches of all frames.
1570 Anything else, means only clear those images which refer to FILTER,
1571 which is then usually a filename. */)
1572 (Lisp_Object filter
)
1574 if (!(EQ (filter
, Qnil
) || FRAMEP (filter
)))
1575 clear_image_caches (filter
);
1577 clear_image_cache (check_x_frame (filter
), Qt
);
1583 DEFUN ("image-flush", Fimage_flush
, Simage_flush
,
1585 doc
: /* Fush the image with specification SPEC on frame FRAME.
1586 This removes the image from the Emacs image cache. If SPEC specifies
1587 an image file, the next redisplay of this image will read from the
1588 current contents of that file.
1590 FRAME nil or omitted means use the selected frame.
1591 FRAME t means refresh the image on all frames. */)
1592 (Lisp_Object spec
, Lisp_Object frame
)
1594 if (!valid_image_p (spec
))
1595 error ("Invalid image specification");
1600 FOR_EACH_FRAME (tail
, frame
)
1602 struct frame
*f
= XFRAME (frame
);
1603 if (FRAME_WINDOW_P (f
))
1604 uncache_image (f
, spec
);
1608 uncache_image (check_x_frame (frame
), spec
);
1614 /* Compute masks and transform image IMG on frame F, as specified
1615 by the image's specification, */
1618 postprocess_image (struct frame
*f
, struct image
*img
)
1620 /* Manipulation of the image's mask. */
1623 Lisp_Object conversion
, spec
;
1628 /* `:heuristic-mask t'
1630 means build a mask heuristically.
1631 `:heuristic-mask (R G B)'
1632 `:mask (heuristic (R G B))'
1633 means build a mask from color (R G B) in the
1636 means remove a mask, if any. */
1638 mask
= image_spec_value (spec
, QCheuristic_mask
, NULL
);
1640 x_build_heuristic_mask (f
, img
, mask
);
1645 mask
= image_spec_value (spec
, QCmask
, &found_p
);
1647 if (EQ (mask
, Qheuristic
))
1648 x_build_heuristic_mask (f
, img
, Qt
);
1649 else if (CONSP (mask
)
1650 && EQ (XCAR (mask
), Qheuristic
))
1652 if (CONSP (XCDR (mask
)))
1653 x_build_heuristic_mask (f
, img
, XCAR (XCDR (mask
)));
1655 x_build_heuristic_mask (f
, img
, XCDR (mask
));
1657 else if (NILP (mask
) && found_p
&& img
->mask
)
1659 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->mask
);
1660 img
->mask
= NO_PIXMAP
;
1665 /* Should we apply an image transformation algorithm? */
1666 conversion
= image_spec_value (spec
, QCconversion
, NULL
);
1667 if (EQ (conversion
, Qdisabled
))
1668 x_disable_image (f
, img
);
1669 else if (EQ (conversion
, Qlaplace
))
1671 else if (EQ (conversion
, Qemboss
))
1673 else if (CONSP (conversion
)
1674 && EQ (XCAR (conversion
), Qedge_detection
))
1677 tem
= XCDR (conversion
);
1679 x_edge_detection (f
, img
,
1680 Fplist_get (tem
, QCmatrix
),
1681 Fplist_get (tem
, QCcolor_adjustment
));
1687 /* Return the id of image with Lisp specification SPEC on frame F.
1688 SPEC must be a valid Lisp image specification (see valid_image_p). */
1691 lookup_image (struct frame
*f
, Lisp_Object spec
)
1696 /* F must be a window-system frame, and SPEC must be a valid image
1698 eassert (FRAME_WINDOW_P (f
));
1699 eassert (valid_image_p (spec
));
1701 /* Look up SPEC in the hash table of the image cache. */
1702 hash
= sxhash (spec
, 0);
1703 img
= search_image_cache (f
, spec
, hash
);
1704 if (img
&& img
->load_failed_p
)
1706 free_image (f
, img
);
1710 /* If not found, create a new image and cache it. */
1714 img
= make_image (spec
, hash
);
1715 cache_image (f
, img
);
1716 img
->load_failed_p
= img
->type
->load (f
, img
) == 0;
1717 img
->frame_foreground
= FRAME_FOREGROUND_PIXEL (f
);
1718 img
->frame_background
= FRAME_BACKGROUND_PIXEL (f
);
1720 /* If we can't load the image, and we don't have a width and
1721 height, use some arbitrary width and height so that we can
1722 draw a rectangle for it. */
1723 if (img
->load_failed_p
)
1727 value
= image_spec_value (spec
, QCwidth
, NULL
);
1728 img
->width
= (INTEGERP (value
)
1729 ? XFASTINT (value
) : DEFAULT_IMAGE_WIDTH
);
1730 value
= image_spec_value (spec
, QCheight
, NULL
);
1731 img
->height
= (INTEGERP (value
)
1732 ? XFASTINT (value
) : DEFAULT_IMAGE_HEIGHT
);
1736 /* Handle image type independent image attributes
1737 `:ascent ASCENT', `:margin MARGIN', `:relief RELIEF',
1738 `:background COLOR'. */
1739 Lisp_Object ascent
, margin
, relief
, bg
;
1742 ascent
= image_spec_value (spec
, QCascent
, NULL
);
1743 if (INTEGERP (ascent
))
1744 img
->ascent
= XFASTINT (ascent
);
1745 else if (EQ (ascent
, Qcenter
))
1746 img
->ascent
= CENTERED_IMAGE_ASCENT
;
1748 margin
= image_spec_value (spec
, QCmargin
, NULL
);
1749 if (INTEGERP (margin
))
1750 img
->vmargin
= img
->hmargin
= XFASTINT (margin
);
1751 else if (CONSP (margin
))
1753 img
->hmargin
= XFASTINT (XCAR (margin
));
1754 img
->vmargin
= XFASTINT (XCDR (margin
));
1757 relief
= image_spec_value (spec
, QCrelief
, NULL
);
1758 relief_bound
= INT_MAX
- max (img
->hmargin
, img
->vmargin
);
1759 if (RANGED_INTEGERP (- relief_bound
, relief
, relief_bound
))
1761 img
->relief
= XINT (relief
);
1762 img
->hmargin
+= eabs (img
->relief
);
1763 img
->vmargin
+= eabs (img
->relief
);
1766 if (! img
->background_valid
)
1768 bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
1772 = x_alloc_image_color (f
, img
, bg
,
1773 FRAME_BACKGROUND_PIXEL (f
));
1774 img
->background_valid
= 1;
1778 /* Do image transformations and compute masks, unless we
1779 don't have the image yet. */
1780 if (!EQ (*img
->type
->type
, Qpostscript
))
1781 postprocess_image (f
, img
);
1787 /* We're using IMG, so set its timestamp to `now'. */
1788 img
->timestamp
= current_emacs_time ();
1790 /* Value is the image id. */
1795 /* Cache image IMG in the image cache of frame F. */
1798 cache_image (struct frame
*f
, struct image
*img
)
1800 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1803 /* Find a free slot in c->images. */
1804 for (i
= 0; i
< c
->used
; ++i
)
1805 if (c
->images
[i
] == NULL
)
1808 /* If no free slot found, maybe enlarge c->images. */
1809 if (i
== c
->used
&& c
->used
== c
->size
)
1810 c
->images
= xpalloc (c
->images
, &c
->size
, 1, -1, sizeof *c
->images
);
1812 /* Add IMG to c->images, and assign IMG an id. */
1818 /* Add IMG to the cache's hash table. */
1819 i
= img
->hash
% IMAGE_CACHE_BUCKETS_SIZE
;
1820 img
->next
= c
->buckets
[i
];
1822 img
->next
->prev
= img
;
1824 c
->buckets
[i
] = img
;
1828 /* Call FN on every image in the image cache of frame F. Used to mark
1829 Lisp Objects in the image cache. */
1831 /* Mark Lisp objects in image IMG. */
1834 mark_image (struct image
*img
)
1836 mark_object (img
->spec
);
1837 mark_object (img
->dependencies
);
1839 if (!NILP (img
->lisp_data
))
1840 mark_object (img
->lisp_data
);
1845 mark_image_cache (struct image_cache
*c
)
1850 for (i
= 0; i
< c
->used
; ++i
)
1852 mark_image (c
->images
[i
]);
1858 /***********************************************************************
1859 X / NS / W32 support code
1860 ***********************************************************************/
1864 /* Macro for defining functions that will be loaded from image DLLs. */
1865 #define DEF_IMGLIB_FN(rettype,func,args) static rettype (FAR CDECL *fn_##func)args
1867 /* Macro for loading those image functions from the library. */
1868 #define LOAD_IMGLIB_FN(lib,func) { \
1869 fn_##func = (void *) GetProcAddress (lib, #func); \
1870 if (!fn_##func) return 0; \
1873 #endif /* HAVE_NTGUI */
1875 static int x_create_x_image_and_pixmap (struct frame
*, int, int, int,
1876 XImagePtr
*, Pixmap
*);
1877 static void x_destroy_x_image (XImagePtr
);
1878 static void x_put_x_image (struct frame
*, XImagePtr
, Pixmap
, int, int);
1880 /* Return nonzero if XIMG's size WIDTH x HEIGHT doesn't break the
1882 WIDTH and HEIGHT must both be positive.
1883 If XIMG is null, assume it is a bitmap. */
1885 x_check_image_size (XImagePtr ximg
, int width
, int height
)
1887 #ifdef HAVE_X_WINDOWS
1888 /* Respect Xlib's limits: it cannot deal with images that have more
1889 than INT_MAX (and/or UINT_MAX) bytes. And respect Emacs's limits
1890 of PTRDIFF_MAX (and/or SIZE_MAX) bytes for any object. */
1893 XLIB_BYTES_MAX
= min (INT_MAX
, UINT_MAX
),
1894 X_IMAGE_BYTES_MAX
= min (XLIB_BYTES_MAX
, min (PTRDIFF_MAX
, SIZE_MAX
))
1897 int bitmap_pad
, depth
, bytes_per_line
;
1900 bitmap_pad
= ximg
->bitmap_pad
;
1901 depth
= ximg
->depth
;
1902 bytes_per_line
= ximg
->bytes_per_line
;
1908 bytes_per_line
= (width
>> 3) + ((width
& 7) != 0);
1910 return (width
<= (INT_MAX
- (bitmap_pad
- 1)) / depth
1911 && height
<= X_IMAGE_BYTES_MAX
/ bytes_per_line
);
1913 /* FIXME: Implement this check for the HAVE_NS and HAVE_NTGUI cases.
1914 For now, assume that every image size is allowed on these systems. */
1919 /* Create an XImage and a pixmap of size WIDTH x HEIGHT for use on
1920 frame F. Set *XIMG and *PIXMAP to the XImage and Pixmap created.
1921 Set (*XIMG)->data to a raster of WIDTH x HEIGHT pixels allocated
1922 via xmalloc. Print error messages via image_error if an error
1923 occurs. Value is non-zero if successful.
1925 On W32, a DEPTH of zero signifies a 24 bit image, otherwise DEPTH
1926 should indicate the bit depth of the image. */
1929 x_create_x_image_and_pixmap (struct frame
*f
, int width
, int height
, int depth
,
1930 XImagePtr
*ximg
, Pixmap
*pixmap
)
1932 #ifdef HAVE_X_WINDOWS
1933 Display
*display
= FRAME_X_DISPLAY (f
);
1934 Window window
= FRAME_X_WINDOW (f
);
1935 Screen
*screen
= FRAME_X_SCREEN (f
);
1937 eassert (interrupt_input_blocked
);
1940 depth
= DefaultDepthOfScreen (screen
);
1941 *ximg
= XCreateImage (display
, DefaultVisualOfScreen (screen
),
1942 depth
, ZPixmap
, 0, NULL
, width
, height
,
1943 depth
> 16 ? 32 : depth
> 8 ? 16 : 8, 0);
1946 image_error ("Unable to allocate X image", Qnil
, Qnil
);
1950 if (! x_check_image_size (*ximg
, width
, height
))
1952 x_destroy_x_image (*ximg
);
1954 image_error ("Image too large (%dx%d)",
1955 make_number (width
), make_number (height
));
1959 /* Allocate image raster. */
1960 (*ximg
)->data
= xmalloc ((*ximg
)->bytes_per_line
* height
);
1962 /* Allocate a pixmap of the same size. */
1963 *pixmap
= XCreatePixmap (display
, window
, width
, height
, depth
);
1964 if (*pixmap
== NO_PIXMAP
)
1966 x_destroy_x_image (*ximg
);
1968 image_error ("Unable to create X pixmap", Qnil
, Qnil
);
1973 #endif /* HAVE_X_WINDOWS */
1977 BITMAPINFOHEADER
*header
;
1979 int scanline_width_bits
;
1981 int palette_colors
= 0;
1986 if (depth
!= 1 && depth
!= 4 && depth
!= 8
1987 && depth
!= 16 && depth
!= 24 && depth
!= 32)
1989 image_error ("Invalid image bit depth specified", Qnil
, Qnil
);
1993 scanline_width_bits
= width
* depth
;
1994 remainder
= scanline_width_bits
% 32;
1997 scanline_width_bits
+= 32 - remainder
;
1999 /* Bitmaps with a depth less than 16 need a palette. */
2000 /* BITMAPINFO structure already contains the first RGBQUAD. */
2002 palette_colors
= 1 << (depth
- 1);
2004 *ximg
= xmalloc (sizeof (XImage
) + palette_colors
* sizeof (RGBQUAD
));
2006 header
= &(*ximg
)->info
.bmiHeader
;
2007 memset (&(*ximg
)->info
, 0, sizeof (BITMAPINFO
));
2008 header
->biSize
= sizeof (*header
);
2009 header
->biWidth
= width
;
2010 header
->biHeight
= -height
; /* negative indicates a top-down bitmap. */
2011 header
->biPlanes
= 1;
2012 header
->biBitCount
= depth
;
2013 header
->biCompression
= BI_RGB
;
2014 header
->biClrUsed
= palette_colors
;
2016 /* TODO: fill in palette. */
2019 (*ximg
)->info
.bmiColors
[0].rgbBlue
= 0;
2020 (*ximg
)->info
.bmiColors
[0].rgbGreen
= 0;
2021 (*ximg
)->info
.bmiColors
[0].rgbRed
= 0;
2022 (*ximg
)->info
.bmiColors
[0].rgbReserved
= 0;
2023 (*ximg
)->info
.bmiColors
[1].rgbBlue
= 255;
2024 (*ximg
)->info
.bmiColors
[1].rgbGreen
= 255;
2025 (*ximg
)->info
.bmiColors
[1].rgbRed
= 255;
2026 (*ximg
)->info
.bmiColors
[1].rgbReserved
= 0;
2029 hdc
= get_frame_dc (f
);
2031 /* Create a DIBSection and raster array for the bitmap,
2032 and store its handle in *pixmap. */
2033 *pixmap
= CreateDIBSection (hdc
, &((*ximg
)->info
),
2034 (depth
< 16) ? DIB_PAL_COLORS
: DIB_RGB_COLORS
,
2035 /* casting avoids a GCC warning */
2036 (void **)&((*ximg
)->data
), NULL
, 0);
2038 /* Realize display palette and garbage all frames. */
2039 release_frame_dc (f
, hdc
);
2041 if (*pixmap
== NULL
)
2043 DWORD err
= GetLastError ();
2044 Lisp_Object errcode
;
2045 /* All system errors are < 10000, so the following is safe. */
2046 XSETINT (errcode
, err
);
2047 image_error ("Unable to create bitmap, error code %d", errcode
, Qnil
);
2048 x_destroy_x_image (*ximg
);
2054 #endif /* HAVE_NTGUI */
2057 *pixmap
= ns_image_for_XPM (width
, height
, depth
);
2061 image_error ("Unable to allocate NSImage for XPM pixmap", Qnil
, Qnil
);
2070 /* Destroy XImage XIMG. Free XIMG->data. */
2073 x_destroy_x_image (XImagePtr ximg
)
2075 eassert (interrupt_input_blocked
);
2078 #ifdef HAVE_X_WINDOWS
2081 XDestroyImage (ximg
);
2082 #endif /* HAVE_X_WINDOWS */
2084 /* Data will be freed by DestroyObject. */
2087 #endif /* HAVE_NTGUI */
2089 ns_release_object (ximg
);
2090 #endif /* HAVE_NS */
2095 /* Put XImage XIMG into pixmap PIXMAP on frame F. WIDTH and HEIGHT
2096 are width and height of both the image and pixmap. */
2099 x_put_x_image (struct frame
*f
, XImagePtr ximg
, Pixmap pixmap
, int width
, int height
)
2101 #ifdef HAVE_X_WINDOWS
2104 eassert (interrupt_input_blocked
);
2105 gc
= XCreateGC (FRAME_X_DISPLAY (f
), pixmap
, 0, NULL
);
2106 XPutImage (FRAME_X_DISPLAY (f
), pixmap
, gc
, ximg
, 0, 0, 0, 0, width
, height
);
2107 XFreeGC (FRAME_X_DISPLAY (f
), gc
);
2108 #endif /* HAVE_X_WINDOWS */
2111 #if 0 /* I don't think this is necessary looking at where it is used. */
2112 HDC hdc
= get_frame_dc (f
);
2113 SetDIBits (hdc
, pixmap
, 0, height
, ximg
->data
, &(ximg
->info
), DIB_RGB_COLORS
);
2114 release_frame_dc (f
, hdc
);
2116 #endif /* HAVE_NTGUI */
2119 eassert (ximg
== pixmap
);
2120 ns_retain_object (ximg
);
2125 /***********************************************************************
2127 ***********************************************************************/
2129 /* Find image file FILE. Look in data-directory/images, then
2130 x-bitmap-file-path. Value is the encoded full name of the file
2131 found, or nil if not found. */
2134 x_find_image_file (Lisp_Object file
)
2136 Lisp_Object file_found
, search_path
;
2139 /* TODO I think this should use something like image-load-path
2140 instead. Unfortunately, that can contain non-string elements. */
2141 search_path
= Fcons (Fexpand_file_name (build_string ("images"),
2143 Vx_bitmap_file_path
);
2145 /* Try to find FILE in data-directory/images, then x-bitmap-file-path. */
2146 fd
= openp (search_path
, file
, Qnil
, &file_found
, Qnil
);
2152 file_found
= ENCODE_FILE (file_found
);
2160 /* Read FILE into memory. Value is a pointer to a buffer allocated
2161 with xmalloc holding FILE's contents. Value is null if an error
2162 occurred. *SIZE is set to the size of the file. */
2164 static unsigned char *
2165 slurp_file (char *file
, ptrdiff_t *size
)
2168 unsigned char *buf
= NULL
;
2171 if (stat (file
, &st
) == 0
2172 && (fp
= fopen (file
, "rb")) != NULL
2173 && 0 <= st
.st_size
&& st
.st_size
<= min (PTRDIFF_MAX
, SIZE_MAX
)
2174 && (buf
= xmalloc (st
.st_size
),
2175 fread (buf
, 1, st
.st_size
, fp
) == st
.st_size
))
2196 /***********************************************************************
2198 ***********************************************************************/
2200 static int xbm_scan (unsigned char **, unsigned char *, char *, int *);
2201 static int xbm_load (struct frame
*f
, struct image
*img
);
2202 static int xbm_load_image (struct frame
*f
, struct image
*img
,
2203 unsigned char *, unsigned char *);
2204 static int xbm_image_p (Lisp_Object object
);
2205 static int xbm_read_bitmap_data (struct frame
*f
,
2206 unsigned char *, unsigned char *,
2207 int *, int *, char **, int);
2208 static int xbm_file_p (Lisp_Object
);
2211 /* Indices of image specification fields in xbm_format, below. */
2213 enum xbm_keyword_index
2231 /* Vector of image_keyword structures describing the format
2232 of valid XBM image specifications. */
2234 static const struct image_keyword xbm_format
[XBM_LAST
] =
2236 {":type", IMAGE_SYMBOL_VALUE
, 1},
2237 {":file", IMAGE_STRING_VALUE
, 0},
2238 {":width", IMAGE_POSITIVE_INTEGER_VALUE
, 0},
2239 {":height", IMAGE_POSITIVE_INTEGER_VALUE
, 0},
2240 {":data", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
2241 {":foreground", IMAGE_STRING_OR_NIL_VALUE
, 0},
2242 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0},
2243 {":ascent", IMAGE_ASCENT_VALUE
, 0},
2244 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
2245 {":relief", IMAGE_INTEGER_VALUE
, 0},
2246 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
2247 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
2248 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0}
2251 /* Structure describing the image type XBM. */
2253 static struct image_type xbm_type
=
2262 /* Tokens returned from xbm_scan. */
2271 /* Return non-zero if OBJECT is a valid XBM-type image specification.
2272 A valid specification is a list starting with the symbol `image'
2273 The rest of the list is a property list which must contain an
2276 If the specification specifies a file to load, it must contain
2277 an entry `:file FILENAME' where FILENAME is a string.
2279 If the specification is for a bitmap loaded from memory it must
2280 contain `:width WIDTH', `:height HEIGHT', and `:data DATA', where
2281 WIDTH and HEIGHT are integers > 0. DATA may be:
2283 1. a string large enough to hold the bitmap data, i.e. it must
2284 have a size >= (WIDTH + 7) / 8 * HEIGHT
2286 2. a bool-vector of size >= WIDTH * HEIGHT
2288 3. a vector of strings or bool-vectors, one for each line of the
2291 4. a string containing an in-memory XBM file. WIDTH and HEIGHT
2292 may not be specified in this case because they are defined in the
2295 Both the file and data forms may contain the additional entries
2296 `:background COLOR' and `:foreground COLOR'. If not present,
2297 foreground and background of the frame on which the image is
2298 displayed is used. */
2301 xbm_image_p (Lisp_Object object
)
2303 struct image_keyword kw
[XBM_LAST
];
2305 memcpy (kw
, xbm_format
, sizeof kw
);
2306 if (!parse_image_spec (object
, kw
, XBM_LAST
, Qxbm
))
2309 eassert (EQ (kw
[XBM_TYPE
].value
, Qxbm
));
2311 if (kw
[XBM_FILE
].count
)
2313 if (kw
[XBM_WIDTH
].count
|| kw
[XBM_HEIGHT
].count
|| kw
[XBM_DATA
].count
)
2316 else if (kw
[XBM_DATA
].count
&& xbm_file_p (kw
[XBM_DATA
].value
))
2318 /* In-memory XBM file. */
2319 if (kw
[XBM_WIDTH
].count
|| kw
[XBM_HEIGHT
].count
|| kw
[XBM_FILE
].count
)
2327 /* Entries for `:width', `:height' and `:data' must be present. */
2328 if (!kw
[XBM_WIDTH
].count
2329 || !kw
[XBM_HEIGHT
].count
2330 || !kw
[XBM_DATA
].count
)
2333 data
= kw
[XBM_DATA
].value
;
2334 width
= XFASTINT (kw
[XBM_WIDTH
].value
);
2335 height
= XFASTINT (kw
[XBM_HEIGHT
].value
);
2337 /* Check type of data, and width and height against contents of
2343 /* Number of elements of the vector must be >= height. */
2344 if (ASIZE (data
) < height
)
2347 /* Each string or bool-vector in data must be large enough
2348 for one line of the image. */
2349 for (i
= 0; i
< height
; ++i
)
2351 Lisp_Object elt
= AREF (data
, i
);
2356 < (width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
)
2359 else if (BOOL_VECTOR_P (elt
))
2361 if (XBOOL_VECTOR (elt
)->size
< width
)
2368 else if (STRINGP (data
))
2371 < (width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
* height
)
2374 else if (BOOL_VECTOR_P (data
))
2376 if (XBOOL_VECTOR (data
)->size
/ height
< width
)
2387 /* Scan a bitmap file. FP is the stream to read from. Value is
2388 either an enumerator from enum xbm_token, or a character for a
2389 single-character token, or 0 at end of file. If scanning an
2390 identifier, store the lexeme of the identifier in SVAL. If
2391 scanning a number, store its value in *IVAL. */
2394 xbm_scan (unsigned char **s
, unsigned char *end
, char *sval
, int *ival
)
2400 /* Skip white space. */
2401 while (*s
< end
&& (c
= *(*s
)++, c_isspace (c
)))
2406 else if (c_isdigit (c
))
2408 int value
= 0, digit
;
2410 if (c
== '0' && *s
< end
)
2413 if (c
== 'x' || c
== 'X')
2420 else if (c
>= 'a' && c
<= 'f')
2421 digit
= c
- 'a' + 10;
2422 else if (c
>= 'A' && c
<= 'F')
2423 digit
= c
- 'A' + 10;
2426 value
= 16 * value
+ digit
;
2429 else if (c_isdigit (c
))
2433 && (c
= *(*s
)++, c_isdigit (c
)))
2434 value
= 8 * value
+ c
- '0';
2441 && (c
= *(*s
)++, c_isdigit (c
)))
2442 value
= 10 * value
+ c
- '0';
2450 else if (c_isalpha (c
) || c
== '_')
2454 && (c
= *(*s
)++, (c_isalnum (c
) || c
== '_')))
2461 else if (c
== '/' && **s
== '*')
2463 /* C-style comment. */
2465 while (**s
&& (**s
!= '*' || *(*s
+ 1) != '/'))
2479 /* Create a Windows bitmap from X bitmap data. */
2481 w32_create_pixmap_from_bitmap_data (int width
, int height
, char *data
)
2483 static unsigned char swap_nibble
[16]
2484 = { 0x0, 0x8, 0x4, 0xc, /* 0000 1000 0100 1100 */
2485 0x2, 0xa, 0x6, 0xe, /* 0010 1010 0110 1110 */
2486 0x1, 0x9, 0x5, 0xd, /* 0001 1001 0101 1101 */
2487 0x3, 0xb, 0x7, 0xf }; /* 0011 1011 0111 1111 */
2489 unsigned char *bits
, *p
;
2492 w1
= (width
+ 7) / 8; /* nb of 8bits elt in X bitmap */
2493 w2
= ((width
+ 15) / 16) * 2; /* nb of 16bits elt in W32 bitmap */
2494 bits
= alloca (height
* w2
);
2495 memset (bits
, 0, height
* w2
);
2496 for (i
= 0; i
< height
; i
++)
2499 for (j
= 0; j
< w1
; j
++)
2501 /* Bitswap XBM bytes to match how Windows does things. */
2502 unsigned char c
= *data
++;
2503 *p
++ = (unsigned char)((swap_nibble
[c
& 0xf] << 4)
2504 | (swap_nibble
[(c
>>4) & 0xf]));
2507 bmp
= CreateBitmap (width
, height
, 1, 1, (char *) bits
);
2513 convert_mono_to_color_image (struct frame
*f
, struct image
*img
,
2514 COLORREF foreground
, COLORREF background
)
2516 HDC hdc
, old_img_dc
, new_img_dc
;
2517 HGDIOBJ old_prev
, new_prev
;
2520 hdc
= get_frame_dc (f
);
2521 old_img_dc
= CreateCompatibleDC (hdc
);
2522 new_img_dc
= CreateCompatibleDC (hdc
);
2523 new_pixmap
= CreateCompatibleBitmap (hdc
, img
->width
, img
->height
);
2524 release_frame_dc (f
, hdc
);
2525 old_prev
= SelectObject (old_img_dc
, img
->pixmap
);
2526 new_prev
= SelectObject (new_img_dc
, new_pixmap
);
2527 /* Windows convention for mono bitmaps is black = background,
2528 white = foreground. */
2529 SetTextColor (new_img_dc
, background
);
2530 SetBkColor (new_img_dc
, foreground
);
2532 BitBlt (new_img_dc
, 0, 0, img
->width
, img
->height
, old_img_dc
,
2535 SelectObject (old_img_dc
, old_prev
);
2536 SelectObject (new_img_dc
, new_prev
);
2537 DeleteDC (old_img_dc
);
2538 DeleteDC (new_img_dc
);
2539 DeleteObject (img
->pixmap
);
2540 if (new_pixmap
== 0)
2541 fprintf (stderr
, "Failed to convert image to color.\n");
2543 img
->pixmap
= new_pixmap
;
2546 #define XBM_BIT_SHUFFLE(b) (~(b))
2550 #define XBM_BIT_SHUFFLE(b) (b)
2552 #endif /* HAVE_NTGUI */
2556 Create_Pixmap_From_Bitmap_Data (struct frame
*f
, struct image
*img
, char *data
,
2557 RGB_PIXEL_COLOR fg
, RGB_PIXEL_COLOR bg
,
2558 int non_default_colors
)
2562 = w32_create_pixmap_from_bitmap_data (img
->width
, img
->height
, data
);
2564 /* If colors were specified, transfer the bitmap to a color one. */
2565 if (non_default_colors
)
2566 convert_mono_to_color_image (f
, img
, fg
, bg
);
2568 #elif defined (HAVE_NS)
2569 img
->pixmap
= ns_image_from_XBM (data
, img
->width
, img
->height
);
2573 (x_check_image_size (0, img
->width
, img
->height
)
2574 ? XCreatePixmapFromBitmapData (FRAME_X_DISPLAY (f
),
2577 img
->width
, img
->height
,
2579 DefaultDepthOfScreen (FRAME_X_SCREEN (f
)))
2581 #endif /* !HAVE_NTGUI && !HAVE_NS */
2586 /* Replacement for XReadBitmapFileData which isn't available under old
2587 X versions. CONTENTS is a pointer to a buffer to parse; END is the
2588 buffer's end. Set *WIDTH and *HEIGHT to the width and height of
2589 the image. Return in *DATA the bitmap data allocated with xmalloc.
2590 Value is non-zero if successful. DATA null means just test if
2591 CONTENTS looks like an in-memory XBM file. If INHIBIT_IMAGE_ERROR
2592 is non-zero, inhibit the call to image_error when the image size is
2593 invalid (the bitmap remains unread). */
2596 xbm_read_bitmap_data (struct frame
*f
, unsigned char *contents
, unsigned char *end
,
2597 int *width
, int *height
, char **data
,
2598 int inhibit_image_error
)
2600 unsigned char *s
= contents
;
2601 char buffer
[BUFSIZ
];
2604 int bytes_per_line
, i
, nbytes
;
2610 LA1 = xbm_scan (&s, end, buffer, &value)
2612 #define expect(TOKEN) \
2613 if (LA1 != (TOKEN)) \
2618 #define expect_ident(IDENT) \
2619 if (LA1 == XBM_TK_IDENT && strcmp (buffer, (IDENT)) == 0) \
2624 *width
= *height
= -1;
2627 LA1
= xbm_scan (&s
, end
, buffer
, &value
);
2629 /* Parse defines for width, height and hot-spots. */
2633 expect_ident ("define");
2634 expect (XBM_TK_IDENT
);
2636 if (LA1
== XBM_TK_NUMBER
)
2638 char *q
= strrchr (buffer
, '_');
2639 q
= q
? q
+ 1 : buffer
;
2640 if (strcmp (q
, "width") == 0)
2642 else if (strcmp (q
, "height") == 0)
2645 expect (XBM_TK_NUMBER
);
2648 if (!check_image_size (f
, *width
, *height
))
2650 if (!inhibit_image_error
)
2651 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
2654 else if (data
== NULL
)
2657 /* Parse bits. Must start with `static'. */
2658 expect_ident ("static");
2659 if (LA1
== XBM_TK_IDENT
)
2661 if (strcmp (buffer
, "unsigned") == 0)
2664 expect_ident ("char");
2666 else if (strcmp (buffer
, "short") == 0)
2670 if (*width
% 16 && *width
% 16 < 9)
2673 else if (strcmp (buffer
, "char") == 0)
2681 expect (XBM_TK_IDENT
);
2687 if (! x_check_image_size (0, *width
, *height
))
2689 if (!inhibit_image_error
)
2690 image_error ("Image too large (%dx%d)",
2691 make_number (*width
), make_number (*height
));
2694 bytes_per_line
= (*width
+ 7) / 8 + padding_p
;
2695 nbytes
= bytes_per_line
* *height
;
2696 p
= *data
= xmalloc (nbytes
);
2700 for (i
= 0; i
< nbytes
; i
+= 2)
2703 expect (XBM_TK_NUMBER
);
2705 *p
++ = XBM_BIT_SHUFFLE (val
);
2706 if (!padding_p
|| ((i
+ 2) % bytes_per_line
))
2707 *p
++ = XBM_BIT_SHUFFLE (value
>> 8);
2709 if (LA1
== ',' || LA1
== '}')
2717 for (i
= 0; i
< nbytes
; ++i
)
2720 expect (XBM_TK_NUMBER
);
2722 *p
++ = XBM_BIT_SHUFFLE (val
);
2724 if (LA1
== ',' || LA1
== '}')
2749 /* Load XBM image IMG which will be displayed on frame F from buffer
2750 CONTENTS. END is the end of the buffer. Value is non-zero if
2754 xbm_load_image (struct frame
*f
, struct image
*img
, unsigned char *contents
,
2761 rc
= xbm_read_bitmap_data (f
, contents
, end
, &img
->width
, &img
->height
,
2765 unsigned long foreground
= FRAME_FOREGROUND_PIXEL (f
);
2766 unsigned long background
= FRAME_BACKGROUND_PIXEL (f
);
2767 int non_default_colors
= 0;
2770 eassert (img
->width
> 0 && img
->height
> 0);
2772 /* Get foreground and background colors, maybe allocate colors. */
2773 value
= image_spec_value (img
->spec
, QCforeground
, NULL
);
2776 foreground
= x_alloc_image_color (f
, img
, value
, foreground
);
2777 non_default_colors
= 1;
2779 value
= image_spec_value (img
->spec
, QCbackground
, NULL
);
2782 background
= x_alloc_image_color (f
, img
, value
, background
);
2783 img
->background
= background
;
2784 img
->background_valid
= 1;
2785 non_default_colors
= 1;
2788 Create_Pixmap_From_Bitmap_Data (f
, img
, data
,
2789 foreground
, background
,
2790 non_default_colors
);
2793 if (img
->pixmap
== NO_PIXMAP
)
2795 x_clear_image (f
, img
);
2796 image_error ("Unable to create X pixmap for `%s'", img
->spec
, Qnil
);
2802 image_error ("Error loading XBM image `%s'", img
->spec
, Qnil
);
2808 /* Value is non-zero if DATA looks like an in-memory XBM file. */
2811 xbm_file_p (Lisp_Object data
)
2814 return (STRINGP (data
)
2815 && xbm_read_bitmap_data (NULL
, SDATA (data
),
2816 (SDATA (data
) + SBYTES (data
)),
2821 /* Fill image IMG which is used on frame F with pixmap data. Value is
2822 non-zero if successful. */
2825 xbm_load (struct frame
*f
, struct image
*img
)
2828 Lisp_Object file_name
;
2830 eassert (xbm_image_p (img
->spec
));
2832 /* If IMG->spec specifies a file name, create a non-file spec from it. */
2833 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
2834 if (STRINGP (file_name
))
2837 unsigned char *contents
;
2840 file
= x_find_image_file (file_name
);
2841 if (!STRINGP (file
))
2843 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
2847 contents
= slurp_file (SSDATA (file
), &size
);
2848 if (contents
== NULL
)
2850 image_error ("Error loading XBM image `%s'", img
->spec
, Qnil
);
2854 success_p
= xbm_load_image (f
, img
, contents
, contents
+ size
);
2859 struct image_keyword fmt
[XBM_LAST
];
2861 unsigned long foreground
= FRAME_FOREGROUND_PIXEL (f
);
2862 unsigned long background
= FRAME_BACKGROUND_PIXEL (f
);
2863 int non_default_colors
= 0;
2866 int in_memory_file_p
= 0;
2868 /* See if data looks like an in-memory XBM file. */
2869 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
2870 in_memory_file_p
= xbm_file_p (data
);
2872 /* Parse the image specification. */
2873 memcpy (fmt
, xbm_format
, sizeof fmt
);
2874 parsed_p
= parse_image_spec (img
->spec
, fmt
, XBM_LAST
, Qxbm
);
2878 /* Get specified width, and height. */
2879 if (!in_memory_file_p
)
2881 img
->width
= XFASTINT (fmt
[XBM_WIDTH
].value
);
2882 img
->height
= XFASTINT (fmt
[XBM_HEIGHT
].value
);
2883 eassert (img
->width
> 0 && img
->height
> 0);
2884 if (!check_image_size (f
, img
->width
, img
->height
))
2886 image_error ("Invalid image size (see `max-image-size')",
2892 /* Get foreground and background colors, maybe allocate colors. */
2893 if (fmt
[XBM_FOREGROUND
].count
2894 && STRINGP (fmt
[XBM_FOREGROUND
].value
))
2896 foreground
= x_alloc_image_color (f
, img
, fmt
[XBM_FOREGROUND
].value
,
2898 non_default_colors
= 1;
2901 if (fmt
[XBM_BACKGROUND
].count
2902 && STRINGP (fmt
[XBM_BACKGROUND
].value
))
2904 background
= x_alloc_image_color (f
, img
, fmt
[XBM_BACKGROUND
].value
,
2906 non_default_colors
= 1;
2909 if (in_memory_file_p
)
2910 success_p
= xbm_load_image (f
, img
, SDATA (data
),
2919 int nbytes
= (img
->width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
;
2921 p
= bits
= alloca (nbytes
* img
->height
);
2922 for (i
= 0; i
< img
->height
; ++i
, p
+= nbytes
)
2924 Lisp_Object line
= AREF (data
, i
);
2926 memcpy (p
, SDATA (line
), nbytes
);
2928 memcpy (p
, XBOOL_VECTOR (line
)->data
, nbytes
);
2931 else if (STRINGP (data
))
2932 bits
= SSDATA (data
);
2934 bits
= (char *) XBOOL_VECTOR (data
)->data
;
2940 /* Windows mono bitmaps are reversed compared with X. */
2941 invertedBits
= bits
;
2942 nbytes
= (img
->width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
2944 bits
= alloca (nbytes
);
2945 for (i
= 0; i
< nbytes
; i
++)
2946 bits
[i
] = XBM_BIT_SHUFFLE (invertedBits
[i
]);
2949 /* Create the pixmap. */
2951 if (x_check_image_size (0, img
->width
, img
->height
))
2952 Create_Pixmap_From_Bitmap_Data (f
, img
, bits
,
2953 foreground
, background
,
2954 non_default_colors
);
2956 img
->pixmap
= NO_PIXMAP
;
2962 image_error ("Unable to create pixmap for XBM image `%s'",
2964 x_clear_image (f
, img
);
2974 /***********************************************************************
2976 ***********************************************************************/
2978 #if defined (HAVE_XPM) || defined (HAVE_NS)
2980 static int xpm_image_p (Lisp_Object object
);
2981 static int xpm_load (struct frame
*f
, struct image
*img
);
2982 static int xpm_valid_color_symbols_p (Lisp_Object
);
2984 #endif /* HAVE_XPM || HAVE_NS */
2988 /* Indicate to xpm.h that we don't have Xlib. */
2990 /* simx.h in xpm defines XColor and XImage differently than Emacs. */
2991 /* It also defines Display the same way as Emacs, but gcc 3.3 still barfs. */
2992 #define XColor xpm_XColor
2993 #define XImage xpm_XImage
2994 #define Display xpm_Display
2995 #define PIXEL_ALREADY_TYPEDEFED
2996 #include "X11/xpm.h"
3001 #undef PIXEL_ALREADY_TYPEDEFED
3003 #include "X11/xpm.h"
3004 #endif /* HAVE_NTGUI */
3005 #endif /* HAVE_XPM */
3007 #if defined (HAVE_XPM) || defined (HAVE_NS)
3008 /* The symbol `xpm' identifying XPM-format images. */
3010 static Lisp_Object Qxpm
;
3012 /* Indices of image specification fields in xpm_format, below. */
3014 enum xpm_keyword_index
3030 /* Vector of image_keyword structures describing the format
3031 of valid XPM image specifications. */
3033 static const struct image_keyword xpm_format
[XPM_LAST
] =
3035 {":type", IMAGE_SYMBOL_VALUE
, 1},
3036 {":file", IMAGE_STRING_VALUE
, 0},
3037 {":data", IMAGE_STRING_VALUE
, 0},
3038 {":ascent", IMAGE_ASCENT_VALUE
, 0},
3039 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
3040 {":relief", IMAGE_INTEGER_VALUE
, 0},
3041 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3042 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3043 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3044 {":color-symbols", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3045 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
3048 /* Structure describing the image type XPM. */
3050 static struct image_type xpm_type
=
3059 #ifdef HAVE_X_WINDOWS
3061 /* Define ALLOC_XPM_COLORS if we can use Emacs' own color allocation
3062 functions for allocating image colors. Our own functions handle
3063 color allocation failures more gracefully than the ones on the XPM
3066 #if defined XpmAllocColor && defined XpmFreeColors && defined XpmColorClosure
3067 #define ALLOC_XPM_COLORS
3069 #endif /* HAVE_X_WINDOWS */
3071 #ifdef ALLOC_XPM_COLORS
3073 static void xpm_init_color_cache (struct frame
*, XpmAttributes
*);
3074 static void xpm_free_color_cache (void);
3075 static int xpm_lookup_color (struct frame
*, char *, XColor
*);
3076 static int xpm_color_bucket (char *);
3077 static struct xpm_cached_color
*xpm_cache_color (struct frame
*, char *,
3080 /* An entry in a hash table used to cache color definitions of named
3081 colors. This cache is necessary to speed up XPM image loading in
3082 case we do color allocations ourselves. Without it, we would need
3083 a call to XParseColor per pixel in the image. */
3085 struct xpm_cached_color
3087 /* Next in collision chain. */
3088 struct xpm_cached_color
*next
;
3090 /* Color definition (RGB and pixel color). */
3097 /* The hash table used for the color cache, and its bucket vector
3100 #define XPM_COLOR_CACHE_BUCKETS 1001
3101 static struct xpm_cached_color
**xpm_color_cache
;
3103 /* Initialize the color cache. */
3106 xpm_init_color_cache (struct frame
*f
, XpmAttributes
*attrs
)
3108 size_t nbytes
= XPM_COLOR_CACHE_BUCKETS
* sizeof *xpm_color_cache
;
3109 xpm_color_cache
= xzalloc (nbytes
);
3110 init_color_table ();
3112 if (attrs
->valuemask
& XpmColorSymbols
)
3117 for (i
= 0; i
< attrs
->numsymbols
; ++i
)
3118 if (XParseColor (FRAME_X_DISPLAY (f
), FRAME_X_COLORMAP (f
),
3119 attrs
->colorsymbols
[i
].value
, &color
))
3121 color
.pixel
= lookup_rgb_color (f
, color
.red
, color
.green
,
3123 xpm_cache_color (f
, attrs
->colorsymbols
[i
].name
, &color
, -1);
3128 /* Free the color cache. */
3131 xpm_free_color_cache (void)
3133 struct xpm_cached_color
*p
, *next
;
3136 for (i
= 0; i
< XPM_COLOR_CACHE_BUCKETS
; ++i
)
3137 for (p
= xpm_color_cache
[i
]; p
; p
= next
)
3143 xfree (xpm_color_cache
);
3144 xpm_color_cache
= NULL
;
3145 free_color_table ();
3148 /* Return the bucket index for color named COLOR_NAME in the color
3152 xpm_color_bucket (char *color_name
)
3154 EMACS_UINT hash
= hash_string (color_name
, strlen (color_name
));
3155 return hash
% XPM_COLOR_CACHE_BUCKETS
;
3159 /* On frame F, cache values COLOR for color with name COLOR_NAME.
3160 BUCKET, if >= 0, is a precomputed bucket index. Value is the cache
3163 static struct xpm_cached_color
*
3164 xpm_cache_color (struct frame
*f
, char *color_name
, XColor
*color
, int bucket
)
3167 struct xpm_cached_color
*p
;
3170 bucket
= xpm_color_bucket (color_name
);
3172 nbytes
= offsetof (struct xpm_cached_color
, name
) + strlen (color_name
) + 1;
3173 p
= xmalloc (nbytes
);
3174 strcpy (p
->name
, color_name
);
3176 p
->next
= xpm_color_cache
[bucket
];
3177 xpm_color_cache
[bucket
] = p
;
3181 /* Look up color COLOR_NAME for frame F in the color cache. If found,
3182 return the cached definition in *COLOR. Otherwise, make a new
3183 entry in the cache and allocate the color. Value is zero if color
3184 allocation failed. */
3187 xpm_lookup_color (struct frame
*f
, char *color_name
, XColor
*color
)
3189 struct xpm_cached_color
*p
;
3190 int h
= xpm_color_bucket (color_name
);
3192 for (p
= xpm_color_cache
[h
]; p
; p
= p
->next
)
3193 if (strcmp (p
->name
, color_name
) == 0)
3198 else if (XParseColor (FRAME_X_DISPLAY (f
), FRAME_X_COLORMAP (f
),
3201 color
->pixel
= lookup_rgb_color (f
, color
->red
, color
->green
,
3203 p
= xpm_cache_color (f
, color_name
, color
, h
);
3205 /* You get `opaque' at least from ImageMagick converting pbm to xpm
3206 with transparency, and it's useful. */
3207 else if (strcmp ("opaque", color_name
) == 0)
3209 memset (color
, 0, sizeof (XColor
)); /* Is this necessary/correct? */
3210 color
->pixel
= FRAME_FOREGROUND_PIXEL (f
);
3211 p
= xpm_cache_color (f
, color_name
, color
, h
);
3218 /* Callback for allocating color COLOR_NAME. Called from the XPM lib.
3219 CLOSURE is a pointer to the frame on which we allocate the
3220 color. Return in *COLOR the allocated color. Value is non-zero
3224 xpm_alloc_color (Display
*dpy
, Colormap cmap
, char *color_name
, XColor
*color
,
3227 return xpm_lookup_color ((struct frame
*) closure
, color_name
, color
);
3231 /* Callback for freeing NPIXELS colors contained in PIXELS. CLOSURE
3232 is a pointer to the frame on which we allocate the color. Value is
3233 non-zero if successful. */
3236 xpm_free_colors (Display
*dpy
, Colormap cmap
, Pixel
*pixels
, int npixels
, void *closure
)
3241 #endif /* ALLOC_XPM_COLORS */
3246 /* XPM library details. */
3248 DEF_IMGLIB_FN (void, XpmFreeAttributes
, (XpmAttributes
*));
3249 DEF_IMGLIB_FN (int, XpmCreateImageFromBuffer
, (Display
*, char *, xpm_XImage
**,
3250 xpm_XImage
**, XpmAttributes
*));
3251 DEF_IMGLIB_FN (int, XpmReadFileToImage
, (Display
*, char *, xpm_XImage
**,
3252 xpm_XImage
**, XpmAttributes
*));
3253 DEF_IMGLIB_FN (void, XImageFree
, (xpm_XImage
*));
3256 init_xpm_functions (Lisp_Object libraries
)
3260 if (!(library
= w32_delayed_load (libraries
, Qxpm
)))
3263 LOAD_IMGLIB_FN (library
, XpmFreeAttributes
);
3264 LOAD_IMGLIB_FN (library
, XpmCreateImageFromBuffer
);
3265 LOAD_IMGLIB_FN (library
, XpmReadFileToImage
);
3266 LOAD_IMGLIB_FN (library
, XImageFree
);
3270 #endif /* HAVE_NTGUI */
3273 /* Value is non-zero if COLOR_SYMBOLS is a valid color symbols list
3274 for XPM images. Such a list must consist of conses whose car and
3278 xpm_valid_color_symbols_p (Lisp_Object color_symbols
)
3280 while (CONSP (color_symbols
))
3282 Lisp_Object sym
= XCAR (color_symbols
);
3284 || !STRINGP (XCAR (sym
))
3285 || !STRINGP (XCDR (sym
)))
3287 color_symbols
= XCDR (color_symbols
);
3290 return NILP (color_symbols
);
3294 /* Value is non-zero if OBJECT is a valid XPM image specification. */
3297 xpm_image_p (Lisp_Object object
)
3299 struct image_keyword fmt
[XPM_LAST
];
3300 memcpy (fmt
, xpm_format
, sizeof fmt
);
3301 return (parse_image_spec (object
, fmt
, XPM_LAST
, Qxpm
)
3302 /* Either `:file' or `:data' must be present. */
3303 && fmt
[XPM_FILE
].count
+ fmt
[XPM_DATA
].count
== 1
3304 /* Either no `:color-symbols' or it's a list of conses
3305 whose car and cdr are strings. */
3306 && (fmt
[XPM_COLOR_SYMBOLS
].count
== 0
3307 || xpm_valid_color_symbols_p (fmt
[XPM_COLOR_SYMBOLS
].value
)));
3310 #endif /* HAVE_XPM || HAVE_NS */
3312 #if defined HAVE_XPM && defined HAVE_X_WINDOWS && !defined USE_GTK
3314 x_create_bitmap_from_xpm_data (struct frame
*f
, const char **bits
)
3316 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
3319 XpmAttributes attrs
;
3320 Pixmap bitmap
, mask
;
3322 memset (&attrs
, 0, sizeof attrs
);
3324 attrs
.visual
= FRAME_X_VISUAL (f
);
3325 attrs
.colormap
= FRAME_X_COLORMAP (f
);
3326 attrs
.valuemask
|= XpmVisual
;
3327 attrs
.valuemask
|= XpmColormap
;
3329 rc
= XpmCreatePixmapFromData (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
3330 (char **) bits
, &bitmap
, &mask
, &attrs
);
3331 if (rc
!= XpmSuccess
)
3333 XpmFreeAttributes (&attrs
);
3337 id
= x_allocate_bitmap_record (f
);
3338 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
3339 dpyinfo
->bitmaps
[id
- 1].have_mask
= 1;
3340 dpyinfo
->bitmaps
[id
- 1].mask
= mask
;
3341 dpyinfo
->bitmaps
[id
- 1].file
= NULL
;
3342 dpyinfo
->bitmaps
[id
- 1].height
= attrs
.height
;
3343 dpyinfo
->bitmaps
[id
- 1].width
= attrs
.width
;
3344 dpyinfo
->bitmaps
[id
- 1].depth
= attrs
.depth
;
3345 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
3347 XpmFreeAttributes (&attrs
);
3350 #endif /* defined (HAVE_XPM) && defined (HAVE_X_WINDOWS) */
3352 /* Load image IMG which will be displayed on frame F. Value is
3353 non-zero if successful. */
3358 xpm_load (struct frame
*f
, struct image
*img
)
3361 XpmAttributes attrs
;
3362 Lisp_Object specified_file
, color_symbols
;
3365 xpm_XImage
* xpm_image
= NULL
, * xpm_mask
= NULL
;
3366 #endif /* HAVE_NTGUI */
3368 /* Configure the XPM lib. Use the visual of frame F. Allocate
3369 close colors. Return colors allocated. */
3370 memset (&attrs
, 0, sizeof attrs
);
3373 attrs
.visual
= FRAME_X_VISUAL (f
);
3374 attrs
.colormap
= FRAME_X_COLORMAP (f
);
3375 attrs
.valuemask
|= XpmVisual
;
3376 attrs
.valuemask
|= XpmColormap
;
3377 #endif /* HAVE_NTGUI */
3379 #ifdef ALLOC_XPM_COLORS
3380 /* Allocate colors with our own functions which handle
3381 failing color allocation more gracefully. */
3382 attrs
.color_closure
= f
;
3383 attrs
.alloc_color
= xpm_alloc_color
;
3384 attrs
.free_colors
= xpm_free_colors
;
3385 attrs
.valuemask
|= XpmAllocColor
| XpmFreeColors
| XpmColorClosure
;
3386 #else /* not ALLOC_XPM_COLORS */
3387 /* Let the XPM lib allocate colors. */
3388 attrs
.valuemask
|= XpmReturnAllocPixels
;
3389 #ifdef XpmAllocCloseColors
3390 attrs
.alloc_close_colors
= 1;
3391 attrs
.valuemask
|= XpmAllocCloseColors
;
3392 #else /* not XpmAllocCloseColors */
3393 attrs
.closeness
= 600;
3394 attrs
.valuemask
|= XpmCloseness
;
3395 #endif /* not XpmAllocCloseColors */
3396 #endif /* ALLOC_XPM_COLORS */
3398 /* If image specification contains symbolic color definitions, add
3399 these to `attrs'. */
3400 color_symbols
= image_spec_value (img
->spec
, QCcolor_symbols
, NULL
);
3401 if (CONSP (color_symbols
))
3404 XpmColorSymbol
*xpm_syms
;
3407 attrs
.valuemask
|= XpmColorSymbols
;
3409 /* Count number of symbols. */
3410 attrs
.numsymbols
= 0;
3411 for (tail
= color_symbols
; CONSP (tail
); tail
= XCDR (tail
))
3414 /* Allocate an XpmColorSymbol array. */
3415 size
= attrs
.numsymbols
* sizeof *xpm_syms
;
3416 xpm_syms
= alloca (size
);
3417 memset (xpm_syms
, 0, size
);
3418 attrs
.colorsymbols
= xpm_syms
;
3420 /* Fill the color symbol array. */
3421 for (tail
= color_symbols
, i
= 0;
3423 ++i
, tail
= XCDR (tail
))
3427 char *empty_string
= (char *) "";
3429 if (!CONSP (XCAR (tail
)))
3431 xpm_syms
[i
].name
= empty_string
;
3432 xpm_syms
[i
].value
= empty_string
;
3435 name
= XCAR (XCAR (tail
));
3436 color
= XCDR (XCAR (tail
));
3439 xpm_syms
[i
].name
= alloca (SCHARS (name
) + 1);
3440 strcpy (xpm_syms
[i
].name
, SSDATA (name
));
3443 xpm_syms
[i
].name
= empty_string
;
3444 if (STRINGP (color
))
3446 xpm_syms
[i
].value
= alloca (SCHARS (color
) + 1);
3447 strcpy (xpm_syms
[i
].value
, SSDATA (color
));
3450 xpm_syms
[i
].value
= empty_string
;
3454 /* Create a pixmap for the image, either from a file, or from a
3455 string buffer containing data in the same format as an XPM file. */
3456 #ifdef ALLOC_XPM_COLORS
3457 xpm_init_color_cache (f
, &attrs
);
3460 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
3464 HDC frame_dc
= get_frame_dc (f
);
3465 hdc
= CreateCompatibleDC (frame_dc
);
3466 release_frame_dc (f
, frame_dc
);
3468 #endif /* HAVE_NTGUI */
3470 if (STRINGP (specified_file
))
3472 Lisp_Object file
= x_find_image_file (specified_file
);
3473 if (!STRINGP (file
))
3475 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
3476 #ifdef ALLOC_XPM_COLORS
3477 xpm_free_color_cache ();
3483 /* XpmReadFileToPixmap is not available in the Windows port of
3484 libxpm. But XpmReadFileToImage almost does what we want. */
3485 rc
= fn_XpmReadFileToImage (&hdc
, SDATA (file
),
3486 &xpm_image
, &xpm_mask
,
3489 rc
= XpmReadFileToPixmap (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
3490 SSDATA (file
), &img
->pixmap
, &img
->mask
,
3492 #endif /* HAVE_NTGUI */
3496 Lisp_Object buffer
= image_spec_value (img
->spec
, QCdata
, NULL
);
3497 if (!STRINGP (buffer
))
3499 image_error ("Invalid image data `%s'", buffer
, Qnil
);
3500 #ifdef ALLOC_XPM_COLORS
3501 xpm_free_color_cache ();
3506 /* XpmCreatePixmapFromBuffer is not available in the Windows port
3507 of libxpm. But XpmCreateImageFromBuffer almost does what we want. */
3508 rc
= fn_XpmCreateImageFromBuffer (&hdc
, SDATA (buffer
),
3509 &xpm_image
, &xpm_mask
,
3512 rc
= XpmCreatePixmapFromBuffer (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
3514 &img
->pixmap
, &img
->mask
,
3516 #endif /* HAVE_NTGUI */
3519 if (rc
== XpmSuccess
)
3521 #if defined (COLOR_TABLE_SUPPORT) && defined (ALLOC_XPM_COLORS)
3522 img
->colors
= colors_in_color_table (&img
->ncolors
);
3523 #else /* not ALLOC_XPM_COLORS */
3527 /* W32 XPM uses XImage to wrap what W32 Emacs calls a Pixmap,
3528 plus some duplicate attributes. */
3529 if (xpm_image
&& xpm_image
->bitmap
)
3531 img
->pixmap
= xpm_image
->bitmap
;
3532 /* XImageFree in libXpm frees XImage struct without destroying
3533 the bitmap, which is what we want. */
3534 fn_XImageFree (xpm_image
);
3536 if (xpm_mask
&& xpm_mask
->bitmap
)
3538 /* The mask appears to be inverted compared with what we expect.
3539 TODO: invert our expectations. See other places where we
3540 have to invert bits because our idea of masks is backwards. */
3542 old_obj
= SelectObject (hdc
, xpm_mask
->bitmap
);
3544 PatBlt (hdc
, 0, 0, xpm_mask
->width
, xpm_mask
->height
, DSTINVERT
);
3545 SelectObject (hdc
, old_obj
);
3547 img
->mask
= xpm_mask
->bitmap
;
3548 fn_XImageFree (xpm_mask
);
3553 #endif /* HAVE_NTGUI */
3555 /* Remember allocated colors. */
3556 img
->colors
= xnmalloc (attrs
.nalloc_pixels
, sizeof *img
->colors
);
3557 img
->ncolors
= attrs
.nalloc_pixels
;
3558 for (i
= 0; i
< attrs
.nalloc_pixels
; ++i
)
3560 img
->colors
[i
] = attrs
.alloc_pixels
[i
];
3561 #ifdef DEBUG_X_COLORS
3562 register_color (img
->colors
[i
]);
3565 #endif /* not ALLOC_XPM_COLORS */
3567 img
->width
= attrs
.width
;
3568 img
->height
= attrs
.height
;
3569 eassert (img
->width
> 0 && img
->height
> 0);
3571 /* The call to XpmFreeAttributes below frees attrs.alloc_pixels. */
3573 fn_XpmFreeAttributes (&attrs
);
3575 XpmFreeAttributes (&attrs
);
3576 #endif /* HAVE_NTGUI */
3582 #endif /* HAVE_NTGUI */
3587 image_error ("Error opening XPM file (%s)", img
->spec
, Qnil
);
3590 case XpmFileInvalid
:
3591 image_error ("Invalid XPM file (%s)", img
->spec
, Qnil
);
3595 image_error ("Out of memory (%s)", img
->spec
, Qnil
);
3598 case XpmColorFailed
:
3599 image_error ("Color allocation error (%s)", img
->spec
, Qnil
);
3603 image_error ("Unknown error (%s)", img
->spec
, Qnil
);
3608 #ifdef ALLOC_XPM_COLORS
3609 xpm_free_color_cache ();
3611 return rc
== XpmSuccess
;
3614 #endif /* HAVE_XPM */
3616 #if defined (HAVE_NS) && !defined (HAVE_XPM)
3618 /* XPM support functions for NS where libxpm is not available.
3619 Only XPM version 3 (without any extensions) is supported. */
3621 static void xpm_put_color_table_v (Lisp_Object
, const unsigned char *,
3623 static Lisp_Object
xpm_get_color_table_v (Lisp_Object
,
3624 const unsigned char *, int);
3625 static void xpm_put_color_table_h (Lisp_Object
, const unsigned char *,
3627 static Lisp_Object
xpm_get_color_table_h (Lisp_Object
,
3628 const unsigned char *, int);
3630 /* Tokens returned from xpm_scan. */
3639 /* Scan an XPM data and return a character (< 256) or a token defined
3640 by enum xpm_token above. *S and END are the start (inclusive) and
3641 the end (exclusive) addresses of the data, respectively. Advance
3642 *S while scanning. If token is either XPM_TK_IDENT or
3643 XPM_TK_STRING, *BEG and *LEN are set to the start address and the
3644 length of the corresponding token, respectively. */
3647 xpm_scan (const unsigned char **s
,
3648 const unsigned char *end
,
3649 const unsigned char **beg
,
3656 /* Skip white-space. */
3657 while (*s
< end
&& (c
= *(*s
)++, c_isspace (c
)))
3660 /* gnus-pointer.xpm uses '-' in its identifier.
3661 sb-dir-plus.xpm uses '+' in its identifier. */
3662 if (c_isalpha (c
) || c
== '_' || c
== '-' || c
== '+')
3666 && (c
= **s
, c_isalnum (c
)
3667 || c
== '_' || c
== '-' || c
== '+'))
3670 return XPM_TK_IDENT
;
3675 while (*s
< end
&& **s
!= '"')
3680 return XPM_TK_STRING
;
3684 if (*s
< end
&& **s
== '*')
3686 /* C-style comment. */
3690 while (*s
< end
&& *(*s
)++ != '*')
3693 while (*s
< end
&& **s
!= '/');
3707 /* Functions for color table lookup in XPM data. A key is a string
3708 specifying the color of each pixel in XPM data. A value is either
3709 an integer that specifies a pixel color, Qt that specifies
3710 transparency, or Qnil for the unspecified color. If the length of
3711 the key string is one, a vector is used as a table. Otherwise, a
3712 hash table is used. */
3715 xpm_make_color_table_v (void (**put_func
) (Lisp_Object
,
3716 const unsigned char *,
3719 Lisp_Object (**get_func
) (Lisp_Object
,
3720 const unsigned char *,
3723 *put_func
= xpm_put_color_table_v
;
3724 *get_func
= xpm_get_color_table_v
;
3725 return Fmake_vector (make_number (256), Qnil
);
3729 xpm_put_color_table_v (Lisp_Object color_table
,
3730 const unsigned char *chars_start
,
3734 ASET (color_table
, *chars_start
, color
);
3738 xpm_get_color_table_v (Lisp_Object color_table
,
3739 const unsigned char *chars_start
,
3742 return AREF (color_table
, *chars_start
);
3746 xpm_make_color_table_h (void (**put_func
) (Lisp_Object
,
3747 const unsigned char *,
3750 Lisp_Object (**get_func
) (Lisp_Object
,
3751 const unsigned char *,
3754 *put_func
= xpm_put_color_table_h
;
3755 *get_func
= xpm_get_color_table_h
;
3756 return make_hash_table (Qequal
, make_number (DEFAULT_HASH_SIZE
),
3757 make_float (DEFAULT_REHASH_SIZE
),
3758 make_float (DEFAULT_REHASH_THRESHOLD
),
3763 xpm_put_color_table_h (Lisp_Object color_table
,
3764 const unsigned char *chars_start
,
3768 struct Lisp_Hash_Table
*table
= XHASH_TABLE (color_table
);
3769 EMACS_UINT hash_code
;
3770 Lisp_Object chars
= make_unibyte_string (chars_start
, chars_len
);
3772 hash_lookup (table
, chars
, &hash_code
);
3773 hash_put (table
, chars
, color
, hash_code
);
3777 xpm_get_color_table_h (Lisp_Object color_table
,
3778 const unsigned char *chars_start
,
3781 struct Lisp_Hash_Table
*table
= XHASH_TABLE (color_table
);
3783 hash_lookup (table
, make_unibyte_string (chars_start
, chars_len
), NULL
);
3785 return i
>= 0 ? HASH_VALUE (table
, i
) : Qnil
;
3788 enum xpm_color_key
{
3796 static const char xpm_color_key_strings
[][4] = {"s", "m", "g4", "g", "c"};
3799 xpm_str_to_color_key (const char *s
)
3804 i
< sizeof xpm_color_key_strings
/ sizeof xpm_color_key_strings
[0];
3806 if (strcmp (xpm_color_key_strings
[i
], s
) == 0)
3812 xpm_load_image (struct frame
*f
,
3814 const unsigned char *contents
,
3815 const unsigned char *end
)
3817 const unsigned char *s
= contents
, *beg
, *str
;
3818 unsigned char buffer
[BUFSIZ
];
3819 int width
, height
, x
, y
;
3820 int num_colors
, chars_per_pixel
;
3823 void (*put_color_table
) (Lisp_Object
, const unsigned char *, int, Lisp_Object
);
3824 Lisp_Object (*get_color_table
) (Lisp_Object
, const unsigned char *, int);
3825 Lisp_Object frame
, color_symbols
, color_table
;
3826 int best_key
, have_mask
= 0;
3827 XImagePtr ximg
= NULL
, mask_img
= NULL
;
3830 LA1 = xpm_scan (&s, end, &beg, &len)
3832 #define expect(TOKEN) \
3833 if (LA1 != (TOKEN)) \
3838 #define expect_ident(IDENT) \
3839 if (LA1 == XPM_TK_IDENT \
3840 && strlen ((IDENT)) == len && memcmp ((IDENT), beg, len) == 0) \
3845 if (!(end
- s
>= 9 && memcmp (s
, "/* XPM */", 9) == 0))
3849 expect_ident ("static");
3850 expect_ident ("char");
3852 expect (XPM_TK_IDENT
);
3857 expect (XPM_TK_STRING
);
3860 memcpy (buffer
, beg
, len
);
3862 if (sscanf (buffer
, "%d %d %d %d", &width
, &height
,
3863 &num_colors
, &chars_per_pixel
) != 4
3864 || width
<= 0 || height
<= 0
3865 || num_colors
<= 0 || chars_per_pixel
<= 0)
3868 if (!check_image_size (f
, width
, height
))
3870 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
3874 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0,
3875 &ximg
, &img
->pixmap
)
3877 || !x_create_x_image_and_pixmap (f
, width
, height
, 1,
3878 &mask_img
, &img
->mask
)
3882 image_error ("Image too large", Qnil
, Qnil
);
3888 XSETFRAME (frame
, f
);
3889 if (!NILP (Fxw_display_color_p (frame
)))
3890 best_key
= XPM_COLOR_KEY_C
;
3891 else if (!NILP (Fx_display_grayscale_p (frame
)))
3892 best_key
= (XFASTINT (Fx_display_planes (frame
)) > 2
3893 ? XPM_COLOR_KEY_G
: XPM_COLOR_KEY_G4
);
3895 best_key
= XPM_COLOR_KEY_M
;
3897 color_symbols
= image_spec_value (img
->spec
, QCcolor_symbols
, NULL
);
3898 if (chars_per_pixel
== 1)
3899 color_table
= xpm_make_color_table_v (&put_color_table
,
3902 color_table
= xpm_make_color_table_h (&put_color_table
,
3905 while (num_colors
-- > 0)
3907 char *color
, *max_color
;
3908 int key
, next_key
, max_key
= 0;
3909 Lisp_Object symbol_color
= Qnil
, color_val
;
3912 expect (XPM_TK_STRING
);
3913 if (len
<= chars_per_pixel
|| len
>= BUFSIZ
+ chars_per_pixel
)
3915 memcpy (buffer
, beg
+ chars_per_pixel
, len
- chars_per_pixel
);
3916 buffer
[len
- chars_per_pixel
] = '\0';
3918 str
= strtok (buffer
, " \t");
3921 key
= xpm_str_to_color_key (str
);
3926 color
= strtok (NULL
, " \t");
3930 while ((str
= strtok (NULL
, " \t")) != NULL
)
3932 next_key
= xpm_str_to_color_key (str
);
3935 color
[strlen (color
)] = ' ';
3938 if (key
== XPM_COLOR_KEY_S
)
3940 if (NILP (symbol_color
))
3941 symbol_color
= build_string (color
);
3943 else if (max_key
< key
&& key
<= best_key
)
3953 if (!NILP (color_symbols
) && !NILP (symbol_color
))
3955 Lisp_Object specified_color
= Fassoc (symbol_color
, color_symbols
);
3957 if (CONSP (specified_color
) && STRINGP (XCDR (specified_color
)))
3959 if (xstrcasecmp (SSDATA (XCDR (specified_color
)), "None") == 0)
3961 else if (x_defined_color (f
, SSDATA (XCDR (specified_color
)),
3963 color_val
= make_number (cdef
.pixel
);
3966 if (NILP (color_val
) && max_key
> 0)
3968 if (xstrcasecmp (max_color
, "None") == 0)
3970 else if (x_defined_color (f
, max_color
, &cdef
, 0))
3971 color_val
= make_number (cdef
.pixel
);
3973 if (!NILP (color_val
))
3974 (*put_color_table
) (color_table
, beg
, chars_per_pixel
, color_val
);
3979 for (y
= 0; y
< height
; y
++)
3981 expect (XPM_TK_STRING
);
3983 if (len
< width
* chars_per_pixel
)
3985 for (x
= 0; x
< width
; x
++, str
+= chars_per_pixel
)
3987 Lisp_Object color_val
=
3988 (*get_color_table
) (color_table
, str
, chars_per_pixel
);
3990 XPutPixel (ximg
, x
, y
,
3991 (INTEGERP (color_val
) ? XINT (color_val
)
3992 : FRAME_FOREGROUND_PIXEL (f
)));
3994 XPutPixel (mask_img
, x
, y
,
3995 (!EQ (color_val
, Qt
) ? PIX_MASK_DRAW
3996 : (have_mask
= 1, PIX_MASK_RETAIN
)));
3998 if (EQ (color_val
, Qt
))
3999 ns_set_alpha (ximg
, x
, y
, 0);
4007 img
->height
= height
;
4009 /* Maybe fill in the background field while we have ximg handy. */
4010 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
4011 IMAGE_BACKGROUND (img
, f
, ximg
);
4013 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
4014 x_destroy_x_image (ximg
);
4018 /* Fill in the background_transparent field while we have the
4020 image_background_transparent (img
, f
, mask_img
);
4022 x_put_x_image (f
, mask_img
, img
->mask
, width
, height
);
4023 x_destroy_x_image (mask_img
);
4027 x_destroy_x_image (mask_img
);
4028 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->mask
);
4029 img
->mask
= NO_PIXMAP
;
4035 image_error ("Invalid XPM file (%s)", img
->spec
, Qnil
);
4036 x_destroy_x_image (ximg
);
4037 x_destroy_x_image (mask_img
);
4038 x_clear_image (f
, img
);
4047 xpm_load (struct frame
*f
,
4051 Lisp_Object file_name
;
4053 /* If IMG->spec specifies a file name, create a non-file spec from it. */
4054 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
4055 if (STRINGP (file_name
))
4058 unsigned char *contents
;
4061 file
= x_find_image_file (file_name
);
4062 if (!STRINGP (file
))
4064 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
4068 contents
= slurp_file (SSDATA (file
), &size
);
4069 if (contents
== NULL
)
4071 image_error ("Error loading XPM image `%s'", img
->spec
, Qnil
);
4075 success_p
= xpm_load_image (f
, img
, contents
, contents
+ size
);
4082 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
4083 if (!STRINGP (data
))
4085 image_error ("Invalid image data `%s'", data
, Qnil
);
4088 success_p
= xpm_load_image (f
, img
, SDATA (data
),
4089 SDATA (data
) + SBYTES (data
));
4095 #endif /* HAVE_NS && !HAVE_XPM */
4099 /***********************************************************************
4101 ***********************************************************************/
4103 #ifdef COLOR_TABLE_SUPPORT
4105 /* An entry in the color table mapping an RGB color to a pixel color. */
4110 unsigned long pixel
;
4112 /* Next in color table collision list. */
4113 struct ct_color
*next
;
4116 /* The bucket vector size to use. Must be prime. */
4120 /* Value is a hash of the RGB color given by R, G, and B. */
4122 #define CT_HASH_RGB(R, G, B) (((R) << 16) ^ ((G) << 8) ^ (B))
4124 /* The color hash table. */
4126 static struct ct_color
**ct_table
;
4128 /* Number of entries in the color table. */
4130 static int ct_colors_allocated
;
4133 ct_colors_allocated_max
=
4135 min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof (unsigned long))
4138 /* Initialize the color table. */
4141 init_color_table (void)
4143 int size
= CT_SIZE
* sizeof (*ct_table
);
4144 ct_table
= xzalloc (size
);
4145 ct_colors_allocated
= 0;
4149 /* Free memory associated with the color table. */
4152 free_color_table (void)
4155 struct ct_color
*p
, *next
;
4157 for (i
= 0; i
< CT_SIZE
; ++i
)
4158 for (p
= ct_table
[i
]; p
; p
= next
)
4169 /* Value is a pixel color for RGB color R, G, B on frame F. If an
4170 entry for that color already is in the color table, return the
4171 pixel color of that entry. Otherwise, allocate a new color for R,
4172 G, B, and make an entry in the color table. */
4174 static unsigned long
4175 lookup_rgb_color (struct frame
*f
, int r
, int g
, int b
)
4177 unsigned hash
= CT_HASH_RGB (r
, g
, b
);
4178 int i
= hash
% CT_SIZE
;
4180 Display_Info
*dpyinfo
;
4182 /* Handle TrueColor visuals specially, which improves performance by
4183 two orders of magnitude. Freeing colors on TrueColor visuals is
4184 a nop, and pixel colors specify RGB values directly. See also
4185 the Xlib spec, chapter 3.1. */
4186 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
4187 if (dpyinfo
->red_bits
> 0)
4189 unsigned long pr
, pg
, pb
;
4191 /* Apply gamma-correction like normal color allocation does. */
4195 color
.red
= r
, color
.green
= g
, color
.blue
= b
;
4196 gamma_correct (f
, &color
);
4197 r
= color
.red
, g
= color
.green
, b
= color
.blue
;
4200 /* Scale down RGB values to the visual's bits per RGB, and shift
4201 them to the right position in the pixel color. Note that the
4202 original RGB values are 16-bit values, as usual in X. */
4203 pr
= (r
>> (16 - dpyinfo
->red_bits
)) << dpyinfo
->red_offset
;
4204 pg
= (g
>> (16 - dpyinfo
->green_bits
)) << dpyinfo
->green_offset
;
4205 pb
= (b
>> (16 - dpyinfo
->blue_bits
)) << dpyinfo
->blue_offset
;
4207 /* Assemble the pixel color. */
4208 return pr
| pg
| pb
;
4211 for (p
= ct_table
[i
]; p
; p
= p
->next
)
4212 if (p
->r
== r
&& p
->g
== g
&& p
->b
== b
)
4218 #ifdef HAVE_X_WINDOWS
4226 if (ct_colors_allocated_max
<= ct_colors_allocated
)
4227 return FRAME_FOREGROUND_PIXEL (f
);
4229 #ifdef HAVE_X_WINDOWS
4234 cmap
= FRAME_X_COLORMAP (f
);
4235 rc
= x_alloc_nearest_color (f
, cmap
, &color
);
4238 ++ct_colors_allocated
;
4239 p
= xmalloc (sizeof *p
);
4243 p
->pixel
= color
.pixel
;
4244 p
->next
= ct_table
[i
];
4248 return FRAME_FOREGROUND_PIXEL (f
);
4252 color
= PALETTERGB (r
, g
, b
);
4254 color
= RGB_TO_ULONG (r
, g
, b
);
4255 #endif /* HAVE_NTGUI */
4256 ++ct_colors_allocated
;
4257 p
= xmalloc (sizeof *p
);
4262 p
->next
= ct_table
[i
];
4264 #endif /* HAVE_X_WINDOWS */
4272 /* Look up pixel color PIXEL which is used on frame F in the color
4273 table. If not already present, allocate it. Value is PIXEL. */
4275 static unsigned long
4276 lookup_pixel_color (struct frame
*f
, unsigned long pixel
)
4278 int i
= pixel
% CT_SIZE
;
4281 for (p
= ct_table
[i
]; p
; p
= p
->next
)
4282 if (p
->pixel
== pixel
)
4291 if (ct_colors_allocated_max
<= ct_colors_allocated
)
4292 return FRAME_FOREGROUND_PIXEL (f
);
4294 #ifdef HAVE_X_WINDOWS
4295 cmap
= FRAME_X_COLORMAP (f
);
4296 color
.pixel
= pixel
;
4297 x_query_color (f
, &color
);
4298 rc
= x_alloc_nearest_color (f
, cmap
, &color
);
4301 cmap
= DefaultColormapOfScreen (FRAME_X_SCREEN (f
));
4302 color
.pixel
= pixel
;
4303 XQueryColor (NULL
, cmap
, &color
);
4304 rc
= x_alloc_nearest_color (f
, cmap
, &color
);
4306 #endif /* HAVE_X_WINDOWS */
4310 ++ct_colors_allocated
;
4312 p
= xmalloc (sizeof *p
);
4317 p
->next
= ct_table
[i
];
4321 return FRAME_FOREGROUND_PIXEL (f
);
4327 /* Value is a vector of all pixel colors contained in the color table,
4328 allocated via xmalloc. Set *N to the number of colors. */
4330 static unsigned long *
4331 colors_in_color_table (int *n
)
4335 unsigned long *colors
;
4337 if (ct_colors_allocated
== 0)
4344 colors
= xmalloc (ct_colors_allocated
* sizeof *colors
);
4345 *n
= ct_colors_allocated
;
4347 for (i
= j
= 0; i
< CT_SIZE
; ++i
)
4348 for (p
= ct_table
[i
]; p
; p
= p
->next
)
4349 colors
[j
++] = p
->pixel
;
4355 #else /* COLOR_TABLE_SUPPORT */
4357 static unsigned long
4358 lookup_rgb_color (struct frame
*f
, int r
, int g
, int b
)
4360 unsigned long pixel
;
4363 pixel
= PALETTERGB (r
>> 8, g
>> 8, b
>> 8);
4364 #endif /* HAVE_NTGUI */
4367 pixel
= RGB_TO_ULONG (r
>> 8, g
>> 8, b
>> 8);
4368 #endif /* HAVE_NS */
4373 init_color_table (void)
4376 #endif /* COLOR_TABLE_SUPPORT */
4379 /***********************************************************************
4381 ***********************************************************************/
4383 static XColor
*x_to_xcolors (struct frame
*, struct image
*, int);
4384 static void x_from_xcolors (struct frame
*, struct image
*, XColor
*);
4385 static void x_detect_edges (struct frame
*, struct image
*, int[9], int);
4388 static void XPutPixel (XImagePtr
, int, int, COLORREF
);
4389 #endif /* HAVE_NTGUI */
4391 /* Edge detection matrices for different edge-detection
4394 static int emboss_matrix
[9] = {
4396 2, -1, 0, /* y - 1 */
4398 0, 1, -2 /* y + 1 */
4401 static int laplace_matrix
[9] = {
4403 1, 0, 0, /* y - 1 */
4405 0, 0, -1 /* y + 1 */
4408 /* Value is the intensity of the color whose red/green/blue values
4411 #define COLOR_INTENSITY(R, G, B) ((2 * (R) + 3 * (G) + (B)) / 6)
4414 /* On frame F, return an array of XColor structures describing image
4415 IMG->pixmap. Each XColor structure has its pixel color set. RGB_P
4416 non-zero means also fill the red/green/blue members of the XColor
4417 structures. Value is a pointer to the array of XColors structures,
4418 allocated with xmalloc; it must be freed by the caller. */
4421 x_to_xcolors (struct frame
*f
, struct image
*img
, int rgb_p
)
4425 XImagePtr_or_DC ximg
;
4429 #endif /* HAVE_NTGUI */
4431 if (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *colors
/ img
->width
< img
->height
)
4432 memory_full (SIZE_MAX
);
4433 colors
= xmalloc (sizeof *colors
* img
->width
* img
->height
);
4436 /* Get the X image IMG->pixmap. */
4437 ximg
= XGetImage (FRAME_X_DISPLAY (f
), img
->pixmap
,
4438 0, 0, img
->width
, img
->height
, ~0, ZPixmap
);
4440 /* Load the image into a memory device context. */
4441 hdc
= get_frame_dc (f
);
4442 ximg
= CreateCompatibleDC (hdc
);
4443 release_frame_dc (f
, hdc
);
4444 prev
= SelectObject (ximg
, img
->pixmap
);
4445 #endif /* HAVE_NTGUI */
4447 /* Fill the `pixel' members of the XColor array. I wished there
4448 were an easy and portable way to circumvent XGetPixel. */
4450 for (y
= 0; y
< img
->height
; ++y
)
4452 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI)
4454 for (x
= 0; x
< img
->width
; ++x
, ++p
)
4455 p
->pixel
= GET_PIXEL (ximg
, x
, y
);
4457 x_query_colors (f
, row
, img
->width
);
4461 for (x
= 0; x
< img
->width
; ++x
, ++p
)
4463 /* W32_TODO: palette support needed here? */
4464 p
->pixel
= GET_PIXEL (ximg
, x
, y
);
4467 p
->red
= RED16_FROM_ULONG (p
->pixel
);
4468 p
->green
= GREEN16_FROM_ULONG (p
->pixel
);
4469 p
->blue
= BLUE16_FROM_ULONG (p
->pixel
);
4472 #endif /* HAVE_X_WINDOWS */
4475 Destroy_Image (ximg
, prev
);
4482 /* Put a pixel of COLOR at position X, Y in XIMG. XIMG must have been
4483 created with CreateDIBSection, with the pointer to the bit values
4484 stored in ximg->data. */
4487 XPutPixel (XImagePtr ximg
, int x
, int y
, COLORREF color
)
4489 int width
= ximg
->info
.bmiHeader
.biWidth
;
4490 unsigned char * pixel
;
4492 /* True color images. */
4493 if (ximg
->info
.bmiHeader
.biBitCount
== 24)
4495 int rowbytes
= width
* 3;
4496 /* Ensure scanlines are aligned on 4 byte boundaries. */
4498 rowbytes
+= 4 - (rowbytes
% 4);
4500 pixel
= ximg
->data
+ y
* rowbytes
+ x
* 3;
4501 /* Windows bitmaps are in BGR order. */
4502 *pixel
= GetBValue (color
);
4503 *(pixel
+ 1) = GetGValue (color
);
4504 *(pixel
+ 2) = GetRValue (color
);
4506 /* Monochrome images. */
4507 else if (ximg
->info
.bmiHeader
.biBitCount
== 1)
4509 int rowbytes
= width
/ 8;
4510 /* Ensure scanlines are aligned on 4 byte boundaries. */
4512 rowbytes
+= 4 - (rowbytes
% 4);
4513 pixel
= ximg
->data
+ y
* rowbytes
+ x
/ 8;
4514 /* Filter out palette info. */
4515 if (color
& 0x00ffffff)
4516 *pixel
= *pixel
| (1 << x
% 8);
4518 *pixel
= *pixel
& ~(1 << x
% 8);
4521 image_error ("XPutPixel: palette image not supported", Qnil
, Qnil
);
4524 #endif /* HAVE_NTGUI */
4526 /* Create IMG->pixmap from an array COLORS of XColor structures, whose
4527 RGB members are set. F is the frame on which this all happens.
4528 COLORS will be freed; an existing IMG->pixmap will be freed, too. */
4531 x_from_xcolors (struct frame
*f
, struct image
*img
, XColor
*colors
)
4534 XImagePtr oimg
= NULL
;
4538 init_color_table ();
4540 x_create_x_image_and_pixmap (f
, img
->width
, img
->height
, 0,
4543 for (y
= 0; y
< img
->height
; ++y
)
4544 for (x
= 0; x
< img
->width
; ++x
, ++p
)
4546 unsigned long pixel
;
4547 pixel
= lookup_rgb_color (f
, p
->red
, p
->green
, p
->blue
);
4548 XPutPixel (oimg
, x
, y
, pixel
);
4552 x_clear_image_1 (f
, img
, 1, 0, 1);
4554 x_put_x_image (f
, oimg
, pixmap
, img
->width
, img
->height
);
4555 x_destroy_x_image (oimg
);
4556 img
->pixmap
= pixmap
;
4557 #ifdef COLOR_TABLE_SUPPORT
4558 img
->colors
= colors_in_color_table (&img
->ncolors
);
4559 free_color_table ();
4560 #endif /* COLOR_TABLE_SUPPORT */
4564 /* On frame F, perform edge-detection on image IMG.
4566 MATRIX is a nine-element array specifying the transformation
4567 matrix. See emboss_matrix for an example.
4569 COLOR_ADJUST is a color adjustment added to each pixel of the
4573 x_detect_edges (struct frame
*f
, struct image
*img
, int *matrix
, int color_adjust
)
4575 XColor
*colors
= x_to_xcolors (f
, img
, 1);
4579 for (i
= sum
= 0; i
< 9; ++i
)
4580 sum
+= eabs (matrix
[i
]);
4582 #define COLOR(A, X, Y) ((A) + (Y) * img->width + (X))
4584 if (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *new / img
->width
< img
->height
)
4585 memory_full (SIZE_MAX
);
4586 new = xmalloc (sizeof *new * img
->width
* img
->height
);
4588 for (y
= 0; y
< img
->height
; ++y
)
4590 p
= COLOR (new, 0, y
);
4591 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4592 p
= COLOR (new, img
->width
- 1, y
);
4593 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4596 for (x
= 1; x
< img
->width
- 1; ++x
)
4598 p
= COLOR (new, x
, 0);
4599 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4600 p
= COLOR (new, x
, img
->height
- 1);
4601 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4604 for (y
= 1; y
< img
->height
- 1; ++y
)
4606 p
= COLOR (new, 1, y
);
4608 for (x
= 1; x
< img
->width
- 1; ++x
, ++p
)
4610 int r
, g
, b
, yy
, xx
;
4613 for (yy
= y
- 1; yy
< y
+ 2; ++yy
)
4614 for (xx
= x
- 1; xx
< x
+ 2; ++xx
, ++i
)
4617 XColor
*t
= COLOR (colors
, xx
, yy
);
4618 r
+= matrix
[i
] * t
->red
;
4619 g
+= matrix
[i
] * t
->green
;
4620 b
+= matrix
[i
] * t
->blue
;
4623 r
= (r
/ sum
+ color_adjust
) & 0xffff;
4624 g
= (g
/ sum
+ color_adjust
) & 0xffff;
4625 b
= (b
/ sum
+ color_adjust
) & 0xffff;
4626 p
->red
= p
->green
= p
->blue
= COLOR_INTENSITY (r
, g
, b
);
4631 x_from_xcolors (f
, img
, new);
4637 /* Perform the pre-defined `emboss' edge-detection on image IMG
4641 x_emboss (struct frame
*f
, struct image
*img
)
4643 x_detect_edges (f
, img
, emboss_matrix
, 0xffff / 2);
4647 /* Transform image IMG which is used on frame F with a Laplace
4648 edge-detection algorithm. The result is an image that can be used
4649 to draw disabled buttons, for example. */
4652 x_laplace (struct frame
*f
, struct image
*img
)
4654 x_detect_edges (f
, img
, laplace_matrix
, 45000);
4658 /* Perform edge-detection on image IMG on frame F, with specified
4659 transformation matrix MATRIX and color-adjustment COLOR_ADJUST.
4661 MATRIX must be either
4663 - a list of at least 9 numbers in row-major form
4664 - a vector of at least 9 numbers
4666 COLOR_ADJUST nil means use a default; otherwise it must be a
4670 x_edge_detection (struct frame
*f
, struct image
*img
, Lisp_Object matrix
,
4671 Lisp_Object color_adjust
)
4679 i
< 9 && CONSP (matrix
) && NUMBERP (XCAR (matrix
));
4680 ++i
, matrix
= XCDR (matrix
))
4681 trans
[i
] = XFLOATINT (XCAR (matrix
));
4683 else if (VECTORP (matrix
) && ASIZE (matrix
) >= 9)
4685 for (i
= 0; i
< 9 && NUMBERP (AREF (matrix
, i
)); ++i
)
4686 trans
[i
] = XFLOATINT (AREF (matrix
, i
));
4689 if (NILP (color_adjust
))
4690 color_adjust
= make_number (0xffff / 2);
4692 if (i
== 9 && NUMBERP (color_adjust
))
4693 x_detect_edges (f
, img
, trans
, XFLOATINT (color_adjust
));
4697 /* Transform image IMG on frame F so that it looks disabled. */
4700 x_disable_image (struct frame
*f
, struct image
*img
)
4702 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
4704 int n_planes
= dpyinfo
->n_planes
* dpyinfo
->n_cbits
;
4706 int n_planes
= dpyinfo
->n_planes
;
4707 #endif /* HAVE_NTGUI */
4711 /* Color (or grayscale). Convert to gray, and equalize. Just
4712 drawing such images with a stipple can look very odd, so
4713 we're using this method instead. */
4714 XColor
*colors
= x_to_xcolors (f
, img
, 1);
4716 const int h
= 15000;
4717 const int l
= 30000;
4719 for (p
= colors
, end
= colors
+ img
->width
* img
->height
;
4723 int i
= COLOR_INTENSITY (p
->red
, p
->green
, p
->blue
);
4724 int i2
= (0xffff - h
- l
) * i
/ 0xffff + l
;
4725 p
->red
= p
->green
= p
->blue
= i2
;
4728 x_from_xcolors (f
, img
, colors
);
4731 /* Draw a cross over the disabled image, if we must or if we
4733 if (n_planes
< 2 || cross_disabled_images
)
4736 #ifndef HAVE_NS /* TODO: NS support, however this not needed for toolbars */
4738 #define MaskForeground(f) WHITE_PIX_DEFAULT (f)
4740 Display
*dpy
= FRAME_X_DISPLAY (f
);
4741 GC gc
= XCreateGC (dpy
, img
->pixmap
, 0, NULL
);
4742 XSetForeground (dpy
, gc
, BLACK_PIX_DEFAULT (f
));
4743 XDrawLine (dpy
, img
->pixmap
, gc
, 0, 0,
4744 img
->width
- 1, img
->height
- 1);
4745 XDrawLine (dpy
, img
->pixmap
, gc
, 0, img
->height
- 1,
4751 gc
= XCreateGC (dpy
, img
->mask
, 0, NULL
);
4752 XSetForeground (dpy
, gc
, MaskForeground (f
));
4753 XDrawLine (dpy
, img
->mask
, gc
, 0, 0,
4754 img
->width
- 1, img
->height
- 1);
4755 XDrawLine (dpy
, img
->mask
, gc
, 0, img
->height
- 1,
4759 #endif /* !HAVE_NS */
4764 hdc
= get_frame_dc (f
);
4765 bmpdc
= CreateCompatibleDC (hdc
);
4766 release_frame_dc (f
, hdc
);
4768 prev
= SelectObject (bmpdc
, img
->pixmap
);
4770 SetTextColor (bmpdc
, BLACK_PIX_DEFAULT (f
));
4771 MoveToEx (bmpdc
, 0, 0, NULL
);
4772 LineTo (bmpdc
, img
->width
- 1, img
->height
- 1);
4773 MoveToEx (bmpdc
, 0, img
->height
- 1, NULL
);
4774 LineTo (bmpdc
, img
->width
- 1, 0);
4778 SelectObject (bmpdc
, img
->mask
);
4779 SetTextColor (bmpdc
, WHITE_PIX_DEFAULT (f
));
4780 MoveToEx (bmpdc
, 0, 0, NULL
);
4781 LineTo (bmpdc
, img
->width
- 1, img
->height
- 1);
4782 MoveToEx (bmpdc
, 0, img
->height
- 1, NULL
);
4783 LineTo (bmpdc
, img
->width
- 1, 0);
4785 SelectObject (bmpdc
, prev
);
4787 #endif /* HAVE_NTGUI */
4792 /* Build a mask for image IMG which is used on frame F. FILE is the
4793 name of an image file, for error messages. HOW determines how to
4794 determine the background color of IMG. If it is a list '(R G B)',
4795 with R, G, and B being integers >= 0, take that as the color of the
4796 background. Otherwise, determine the background color of IMG
4797 heuristically. Value is non-zero if successful. */
4800 x_build_heuristic_mask (struct frame
*f
, struct image
*img
, Lisp_Object how
)
4802 XImagePtr_or_DC ximg
;
4810 #endif /* HAVE_NTGUI */
4811 int x
, y
, rc
, use_img_background
;
4812 unsigned long bg
= 0;
4816 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->mask
);
4817 img
->mask
= NO_PIXMAP
;
4818 img
->background_transparent_valid
= 0;
4823 /* Create an image and pixmap serving as mask. */
4824 rc
= x_create_x_image_and_pixmap (f
, img
->width
, img
->height
, 1,
4825 &mask_img
, &img
->mask
);
4828 #endif /* !HAVE_NS */
4830 /* Get the X image of IMG->pixmap. */
4831 ximg
= XGetImage (FRAME_X_DISPLAY (f
), img
->pixmap
, 0, 0,
4832 img
->width
, img
->height
,
4835 /* Create the bit array serving as mask. */
4836 row_width
= (img
->width
+ 7) / 8;
4837 mask_img
= xzalloc (row_width
* img
->height
);
4839 /* Create a memory device context for IMG->pixmap. */
4840 frame_dc
= get_frame_dc (f
);
4841 ximg
= CreateCompatibleDC (frame_dc
);
4842 release_frame_dc (f
, frame_dc
);
4843 prev
= SelectObject (ximg
, img
->pixmap
);
4844 #endif /* HAVE_NTGUI */
4846 /* Determine the background color of ximg. If HOW is `(R G B)'
4847 take that as color. Otherwise, use the image's background color. */
4848 use_img_background
= 1;
4854 for (i
= 0; i
< 3 && CONSP (how
) && NATNUMP (XCAR (how
)); ++i
)
4856 rgb
[i
] = XFASTINT (XCAR (how
)) & 0xffff;
4860 if (i
== 3 && NILP (how
))
4862 char color_name
[30];
4863 sprintf (color_name
, "#%04x%04x%04x", rgb
[0], rgb
[1], rgb
[2]);
4866 0x00ffffff & /* Filter out palette info. */
4867 #endif /* HAVE_NTGUI */
4868 x_alloc_image_color (f
, img
, build_string (color_name
), 0));
4869 use_img_background
= 0;
4873 if (use_img_background
)
4874 bg
= four_corners_best (ximg
, img
->corners
, img
->width
, img
->height
);
4876 /* Set all bits in mask_img to 1 whose color in ximg is different
4877 from the background color bg. */
4879 for (y
= 0; y
< img
->height
; ++y
)
4880 for (x
= 0; x
< img
->width
; ++x
)
4882 XPutPixel (mask_img
, x
, y
, (XGetPixel (ximg
, x
, y
) != bg
4883 ? PIX_MASK_DRAW
: PIX_MASK_RETAIN
));
4885 if (XGetPixel (ximg
, x
, y
) == bg
)
4886 ns_set_alpha (ximg
, x
, y
, 0);
4887 #endif /* HAVE_NS */
4889 /* Fill in the background_transparent field while we have the mask handy. */
4890 image_background_transparent (img
, f
, mask_img
);
4892 /* Put mask_img into img->mask. */
4893 x_put_x_image (f
, mask_img
, img
->mask
, img
->width
, img
->height
);
4894 x_destroy_x_image (mask_img
);
4895 #endif /* !HAVE_NS */
4897 for (y
= 0; y
< img
->height
; ++y
)
4898 for (x
= 0; x
< img
->width
; ++x
)
4900 COLORREF p
= GetPixel (ximg
, x
, y
);
4902 mask_img
[y
* row_width
+ x
/ 8] |= 1 << (x
% 8);
4905 /* Create the mask image. */
4906 img
->mask
= w32_create_pixmap_from_bitmap_data (img
->width
, img
->height
,
4908 /* Fill in the background_transparent field while we have the mask handy. */
4909 SelectObject (ximg
, img
->mask
);
4910 image_background_transparent (img
, f
, ximg
);
4912 /* Was: x_destroy_x_image ((XImagePtr )mask_img); which seems bogus ++kfs */
4914 #endif /* HAVE_NTGUI */
4916 Destroy_Image (ximg
, prev
);
4922 /***********************************************************************
4923 PBM (mono, gray, color)
4924 ***********************************************************************/
4926 static int pbm_image_p (Lisp_Object object
);
4927 static int pbm_load (struct frame
*f
, struct image
*img
);
4928 static int pbm_scan_number (unsigned char **, unsigned char *);
4930 /* The symbol `pbm' identifying images of this type. */
4932 static Lisp_Object Qpbm
;
4934 /* Indices of image specification fields in gs_format, below. */
4936 enum pbm_keyword_index
4952 /* Vector of image_keyword structures describing the format
4953 of valid user-defined image specifications. */
4955 static const struct image_keyword pbm_format
[PBM_LAST
] =
4957 {":type", IMAGE_SYMBOL_VALUE
, 1},
4958 {":file", IMAGE_STRING_VALUE
, 0},
4959 {":data", IMAGE_STRING_VALUE
, 0},
4960 {":ascent", IMAGE_ASCENT_VALUE
, 0},
4961 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
4962 {":relief", IMAGE_INTEGER_VALUE
, 0},
4963 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
4964 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
4965 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
4966 {":foreground", IMAGE_STRING_OR_NIL_VALUE
, 0},
4967 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
4970 /* Structure describing the image type `pbm'. */
4972 static struct image_type pbm_type
=
4982 /* Return non-zero if OBJECT is a valid PBM image specification. */
4985 pbm_image_p (Lisp_Object object
)
4987 struct image_keyword fmt
[PBM_LAST
];
4989 memcpy (fmt
, pbm_format
, sizeof fmt
);
4991 if (!parse_image_spec (object
, fmt
, PBM_LAST
, Qpbm
))
4994 /* Must specify either :data or :file. */
4995 return fmt
[PBM_DATA
].count
+ fmt
[PBM_FILE
].count
== 1;
4999 /* Scan a decimal number from *S and return it. Advance *S while
5000 reading the number. END is the end of the string. Value is -1 at
5004 pbm_scan_number (unsigned char **s
, unsigned char *end
)
5006 int c
= 0, val
= -1;
5010 /* Skip white-space. */
5011 while (*s
< end
&& (c
= *(*s
)++, c_isspace (c
)))
5016 /* Skip comment to end of line. */
5017 while (*s
< end
&& (c
= *(*s
)++, c
!= '\n'))
5020 else if (c_isdigit (c
))
5022 /* Read decimal number. */
5024 while (*s
< end
&& (c
= *(*s
)++, c_isdigit (c
)))
5025 val
= 10 * val
+ c
- '0';
5037 #if 0 /* Unused. ++kfs */
5039 /* Read FILE into memory. Value is a pointer to a buffer allocated
5040 with xmalloc holding FILE's contents. Value is null if an error
5041 occurred. *SIZE is set to the size of the file. */
5044 pbm_read_file (Lisp_Object file
, int *size
)
5050 if (stat (SDATA (file
), &st
) == 0
5051 && (fp
= fopen (SDATA (file
), "rb")) != NULL
5052 && 0 <= st
.st_size
&& st
.st_size
<= min (PTRDIFF_MAX
, SIZE_MAX
)
5053 && (buf
= xmalloc (st
.st_size
),
5054 fread (buf
, 1, st
.st_size
, fp
) == st
.st_size
))
5073 #endif /* HAVE_NTGUI */
5075 /* Load PBM image IMG for use on frame F. */
5078 pbm_load (struct frame
*f
, struct image
*img
)
5081 int width
, height
, max_color_idx
= 0;
5083 Lisp_Object file
, specified_file
;
5084 enum {PBM_MONO
, PBM_GRAY
, PBM_COLOR
} type
;
5085 unsigned char *contents
= NULL
;
5086 unsigned char *end
, *p
;
5089 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
5091 if (STRINGP (specified_file
))
5093 file
= x_find_image_file (specified_file
);
5094 if (!STRINGP (file
))
5096 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
5100 contents
= slurp_file (SSDATA (file
), &size
);
5101 if (contents
== NULL
)
5103 image_error ("Error reading `%s'", file
, Qnil
);
5108 end
= contents
+ size
;
5113 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
5114 if (!STRINGP (data
))
5116 image_error ("Invalid image data `%s'", data
, Qnil
);
5120 end
= p
+ SBYTES (data
);
5123 /* Check magic number. */
5124 if (end
- p
< 2 || *p
++ != 'P')
5126 image_error ("Not a PBM image: `%s'", img
->spec
, Qnil
);
5135 raw_p
= 0, type
= PBM_MONO
;
5139 raw_p
= 0, type
= PBM_GRAY
;
5143 raw_p
= 0, type
= PBM_COLOR
;
5147 raw_p
= 1, type
= PBM_MONO
;
5151 raw_p
= 1, type
= PBM_GRAY
;
5155 raw_p
= 1, type
= PBM_COLOR
;
5159 image_error ("Not a PBM image: `%s'", img
->spec
, Qnil
);
5163 /* Read width, height, maximum color-component. Characters
5164 starting with `#' up to the end of a line are ignored. */
5165 width
= pbm_scan_number (&p
, end
);
5166 height
= pbm_scan_number (&p
, end
);
5168 if (type
!= PBM_MONO
)
5170 max_color_idx
= pbm_scan_number (&p
, end
);
5171 if (max_color_idx
> 65535 || max_color_idx
< 0)
5173 image_error ("Unsupported maximum PBM color value", Qnil
, Qnil
);
5178 if (!check_image_size (f
, width
, height
))
5180 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
5184 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0,
5185 &ximg
, &img
->pixmap
))
5188 /* Initialize the color hash table. */
5189 init_color_table ();
5191 if (type
== PBM_MONO
)
5194 struct image_keyword fmt
[PBM_LAST
];
5195 unsigned long fg
= FRAME_FOREGROUND_PIXEL (f
);
5196 unsigned long bg
= FRAME_BACKGROUND_PIXEL (f
);
5198 /* Parse the image specification. */
5199 memcpy (fmt
, pbm_format
, sizeof fmt
);
5200 parse_image_spec (img
->spec
, fmt
, PBM_LAST
, Qpbm
);
5202 /* Get foreground and background colors, maybe allocate colors. */
5203 if (fmt
[PBM_FOREGROUND
].count
5204 && STRINGP (fmt
[PBM_FOREGROUND
].value
))
5205 fg
= x_alloc_image_color (f
, img
, fmt
[PBM_FOREGROUND
].value
, fg
);
5206 if (fmt
[PBM_BACKGROUND
].count
5207 && STRINGP (fmt
[PBM_BACKGROUND
].value
))
5209 bg
= x_alloc_image_color (f
, img
, fmt
[PBM_BACKGROUND
].value
, bg
);
5210 img
->background
= bg
;
5211 img
->background_valid
= 1;
5214 for (y
= 0; y
< height
; ++y
)
5215 for (x
= 0; x
< width
; ++x
)
5223 x_destroy_x_image (ximg
);
5224 x_clear_image (f
, img
);
5225 image_error ("Invalid image size in image `%s'",
5235 g
= pbm_scan_number (&p
, end
);
5237 XPutPixel (ximg
, x
, y
, g
? fg
: bg
);
5242 int expected_size
= height
* width
;
5243 if (max_color_idx
> 255)
5245 if (type
== PBM_COLOR
)
5248 if (raw_p
&& p
+ expected_size
> end
)
5250 x_destroy_x_image (ximg
);
5251 x_clear_image (f
, img
);
5252 image_error ("Invalid image size in image `%s'",
5257 for (y
= 0; y
< height
; ++y
)
5258 for (x
= 0; x
< width
; ++x
)
5262 if (type
== PBM_GRAY
&& raw_p
)
5265 if (max_color_idx
> 255)
5266 r
= g
= b
= r
* 256 + *p
++;
5268 else if (type
== PBM_GRAY
)
5269 r
= g
= b
= pbm_scan_number (&p
, end
);
5273 if (max_color_idx
> 255)
5276 if (max_color_idx
> 255)
5279 if (max_color_idx
> 255)
5284 r
= pbm_scan_number (&p
, end
);
5285 g
= pbm_scan_number (&p
, end
);
5286 b
= pbm_scan_number (&p
, end
);
5289 if (r
< 0 || g
< 0 || b
< 0)
5291 x_destroy_x_image (ximg
);
5292 image_error ("Invalid pixel value in image `%s'",
5297 /* RGB values are now in the range 0..max_color_idx.
5298 Scale this to the range 0..0xffff supported by X. */
5299 r
= (double) r
* 65535 / max_color_idx
;
5300 g
= (double) g
* 65535 / max_color_idx
;
5301 b
= (double) b
* 65535 / max_color_idx
;
5302 XPutPixel (ximg
, x
, y
, lookup_rgb_color (f
, r
, g
, b
));
5306 #ifdef COLOR_TABLE_SUPPORT
5307 /* Store in IMG->colors the colors allocated for the image, and
5308 free the color table. */
5309 img
->colors
= colors_in_color_table (&img
->ncolors
);
5310 free_color_table ();
5311 #endif /* COLOR_TABLE_SUPPORT */
5314 img
->height
= height
;
5316 /* Maybe fill in the background field while we have ximg handy. */
5318 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
5319 /* Casting avoids a GCC warning. */
5320 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
5322 /* Put the image into a pixmap. */
5323 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
5324 x_destroy_x_image (ximg
);
5326 /* X and W32 versions did it here, MAC version above. ++kfs
5328 img->height = height; */
5335 /***********************************************************************
5337 ***********************************************************************/
5339 #if defined (HAVE_PNG) || defined (HAVE_NS)
5341 /* Function prototypes. */
5343 static int png_image_p (Lisp_Object object
);
5344 static int png_load (struct frame
*f
, struct image
*img
);
5346 /* The symbol `png' identifying images of this type. */
5348 static Lisp_Object Qpng
;
5350 /* Indices of image specification fields in png_format, below. */
5352 enum png_keyword_index
5367 /* Vector of image_keyword structures describing the format
5368 of valid user-defined image specifications. */
5370 static const struct image_keyword png_format
[PNG_LAST
] =
5372 {":type", IMAGE_SYMBOL_VALUE
, 1},
5373 {":data", IMAGE_STRING_VALUE
, 0},
5374 {":file", IMAGE_STRING_VALUE
, 0},
5375 {":ascent", IMAGE_ASCENT_VALUE
, 0},
5376 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
5377 {":relief", IMAGE_INTEGER_VALUE
, 0},
5378 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5379 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5380 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5381 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
5384 /* Structure describing the image type `png'. */
5386 static struct image_type png_type
=
5395 /* Return non-zero if OBJECT is a valid PNG image specification. */
5398 png_image_p (Lisp_Object object
)
5400 struct image_keyword fmt
[PNG_LAST
];
5401 memcpy (fmt
, png_format
, sizeof fmt
);
5403 if (!parse_image_spec (object
, fmt
, PNG_LAST
, Qpng
))
5406 /* Must specify either the :data or :file keyword. */
5407 return fmt
[PNG_FILE
].count
+ fmt
[PNG_DATA
].count
== 1;
5410 #endif /* HAVE_PNG || HAVE_NS */
5416 /* PNG library details. */
5418 DEF_IMGLIB_FN (png_voidp
, png_get_io_ptr
, (png_structp
));
5419 DEF_IMGLIB_FN (int, png_sig_cmp
, (png_bytep
, png_size_t
, png_size_t
));
5420 DEF_IMGLIB_FN (png_structp
, png_create_read_struct
, (png_const_charp
, png_voidp
,
5421 png_error_ptr
, png_error_ptr
));
5422 DEF_IMGLIB_FN (png_infop
, png_create_info_struct
, (png_structp
));
5423 DEF_IMGLIB_FN (void, png_destroy_read_struct
, (png_structpp
, png_infopp
, png_infopp
));
5424 DEF_IMGLIB_FN (void, png_set_read_fn
, (png_structp
, png_voidp
, png_rw_ptr
));
5425 DEF_IMGLIB_FN (void, png_set_sig_bytes
, (png_structp
, int));
5426 DEF_IMGLIB_FN (void, png_read_info
, (png_structp
, png_infop
));
5427 DEF_IMGLIB_FN (png_uint_32
, png_get_IHDR
, (png_structp
, png_infop
,
5428 png_uint_32
*, png_uint_32
*,
5429 int *, int *, int *, int *, int *));
5430 DEF_IMGLIB_FN (png_uint_32
, png_get_valid
, (png_structp
, png_infop
, png_uint_32
));
5431 DEF_IMGLIB_FN (void, png_set_strip_16
, (png_structp
));
5432 DEF_IMGLIB_FN (void, png_set_expand
, (png_structp
));
5433 DEF_IMGLIB_FN (void, png_set_gray_to_rgb
, (png_structp
));
5434 DEF_IMGLIB_FN (void, png_set_background
, (png_structp
, png_color_16p
,
5436 DEF_IMGLIB_FN (png_uint_32
, png_get_bKGD
, (png_structp
, png_infop
, png_color_16p
*));
5437 DEF_IMGLIB_FN (void, png_read_update_info
, (png_structp
, png_infop
));
5438 DEF_IMGLIB_FN (png_byte
, png_get_channels
, (png_structp
, png_infop
));
5439 DEF_IMGLIB_FN (png_size_t
, png_get_rowbytes
, (png_structp
, png_infop
));
5440 DEF_IMGLIB_FN (void, png_read_image
, (png_structp
, png_bytepp
));
5441 DEF_IMGLIB_FN (void, png_read_end
, (png_structp
, png_infop
));
5442 DEF_IMGLIB_FN (void, png_error
, (png_structp
, png_const_charp
));
5444 #if (PNG_LIBPNG_VER >= 10500)
5445 DEF_IMGLIB_FN (void, png_longjmp
, (png_structp
, int));
5446 DEF_IMGLIB_FN (jmp_buf *, png_set_longjmp_fn
, (png_structp
, png_longjmp_ptr
, size_t));
5447 #endif /* libpng version >= 1.5 */
5450 init_png_functions (Lisp_Object libraries
)
5454 if (!(library
= w32_delayed_load (libraries
, Qpng
)))
5457 LOAD_IMGLIB_FN (library
, png_get_io_ptr
);
5458 LOAD_IMGLIB_FN (library
, png_sig_cmp
);
5459 LOAD_IMGLIB_FN (library
, png_create_read_struct
);
5460 LOAD_IMGLIB_FN (library
, png_create_info_struct
);
5461 LOAD_IMGLIB_FN (library
, png_destroy_read_struct
);
5462 LOAD_IMGLIB_FN (library
, png_set_read_fn
);
5463 LOAD_IMGLIB_FN (library
, png_set_sig_bytes
);
5464 LOAD_IMGLIB_FN (library
, png_read_info
);
5465 LOAD_IMGLIB_FN (library
, png_get_IHDR
);
5466 LOAD_IMGLIB_FN (library
, png_get_valid
);
5467 LOAD_IMGLIB_FN (library
, png_set_strip_16
);
5468 LOAD_IMGLIB_FN (library
, png_set_expand
);
5469 LOAD_IMGLIB_FN (library
, png_set_gray_to_rgb
);
5470 LOAD_IMGLIB_FN (library
, png_set_background
);
5471 LOAD_IMGLIB_FN (library
, png_get_bKGD
);
5472 LOAD_IMGLIB_FN (library
, png_read_update_info
);
5473 LOAD_IMGLIB_FN (library
, png_get_channels
);
5474 LOAD_IMGLIB_FN (library
, png_get_rowbytes
);
5475 LOAD_IMGLIB_FN (library
, png_read_image
);
5476 LOAD_IMGLIB_FN (library
, png_read_end
);
5477 LOAD_IMGLIB_FN (library
, png_error
);
5479 #if (PNG_LIBPNG_VER >= 10500)
5480 LOAD_IMGLIB_FN (library
, png_longjmp
);
5481 LOAD_IMGLIB_FN (library
, png_set_longjmp_fn
);
5482 #endif /* libpng version >= 1.5 */
5488 #define fn_png_get_io_ptr png_get_io_ptr
5489 #define fn_png_sig_cmp png_sig_cmp
5490 #define fn_png_create_read_struct png_create_read_struct
5491 #define fn_png_create_info_struct png_create_info_struct
5492 #define fn_png_destroy_read_struct png_destroy_read_struct
5493 #define fn_png_set_read_fn png_set_read_fn
5494 #define fn_png_set_sig_bytes png_set_sig_bytes
5495 #define fn_png_read_info png_read_info
5496 #define fn_png_get_IHDR png_get_IHDR
5497 #define fn_png_get_valid png_get_valid
5498 #define fn_png_set_strip_16 png_set_strip_16
5499 #define fn_png_set_expand png_set_expand
5500 #define fn_png_set_gray_to_rgb png_set_gray_to_rgb
5501 #define fn_png_set_background png_set_background
5502 #define fn_png_get_bKGD png_get_bKGD
5503 #define fn_png_read_update_info png_read_update_info
5504 #define fn_png_get_channels png_get_channels
5505 #define fn_png_get_rowbytes png_get_rowbytes
5506 #define fn_png_read_image png_read_image
5507 #define fn_png_read_end png_read_end
5508 #define fn_png_error png_error
5510 #if (PNG_LIBPNG_VER >= 10500)
5511 #define fn_png_longjmp png_longjmp
5512 #define fn_png_set_longjmp_fn png_set_longjmp_fn
5513 #endif /* libpng version >= 1.5 */
5515 #endif /* HAVE_NTGUI */
5517 /* Possibly inefficient/inexact substitutes for _setjmp and _longjmp.
5518 Do not use sys_setjmp, as PNG supports only jmp_buf. The _longjmp
5519 substitute may munge the signal mask, but that should be OK here. */
5520 #ifndef HAVE__SETJMP
5521 # define _setjmp(j) setjmp (j)
5522 # define _longjmp longjmp
5525 #if (PNG_LIBPNG_VER < 10500)
5526 #define PNG_LONGJMP(ptr) (_longjmp ((ptr)->jmpbuf, 1))
5527 #define PNG_JMPBUF(ptr) ((ptr)->jmpbuf)
5529 /* In libpng version 1.5, the jmpbuf member is hidden. (Bug#7908) */
5530 #define PNG_LONGJMP(ptr) (fn_png_longjmp ((ptr), 1))
5531 #define PNG_JMPBUF(ptr) \
5532 (*fn_png_set_longjmp_fn ((ptr), _longjmp, sizeof (jmp_buf)))
5535 /* Error and warning handlers installed when the PNG library
5538 static _Noreturn
void
5539 my_png_error (png_struct
*png_ptr
, const char *msg
)
5541 eassert (png_ptr
!= NULL
);
5542 /* Avoid compiler warning about deprecated direct access to
5543 png_ptr's fields in libpng versions 1.4.x. */
5544 image_error ("PNG error: %s", build_string (msg
), Qnil
);
5545 PNG_LONGJMP (png_ptr
);
5550 my_png_warning (png_struct
*png_ptr
, const char *msg
)
5552 eassert (png_ptr
!= NULL
);
5553 image_error ("PNG warning: %s", build_string (msg
), Qnil
);
5556 /* Memory source for PNG decoding. */
5558 struct png_memory_storage
5560 unsigned char *bytes
; /* The data */
5561 ptrdiff_t len
; /* How big is it? */
5562 ptrdiff_t index
; /* Where are we? */
5566 /* Function set as reader function when reading PNG image from memory.
5567 PNG_PTR is a pointer to the PNG control structure. Copy LENGTH
5568 bytes from the input to DATA. */
5571 png_read_from_memory (png_structp png_ptr
, png_bytep data
, png_size_t length
)
5573 struct png_memory_storage
*tbr
5574 = (struct png_memory_storage
*) fn_png_get_io_ptr (png_ptr
);
5576 if (length
> tbr
->len
- tbr
->index
)
5577 fn_png_error (png_ptr
, "Read error");
5579 memcpy (data
, tbr
->bytes
+ tbr
->index
, length
);
5580 tbr
->index
= tbr
->index
+ length
;
5584 /* Function set as reader function when reading PNG image from a file.
5585 PNG_PTR is a pointer to the PNG control structure. Copy LENGTH
5586 bytes from the input to DATA. */
5589 png_read_from_file (png_structp png_ptr
, png_bytep data
, png_size_t length
)
5591 FILE *fp
= (FILE *) fn_png_get_io_ptr (png_ptr
);
5593 if (fread (data
, 1, length
, fp
) < length
)
5594 fn_png_error (png_ptr
, "Read error");
5598 /* Load PNG image IMG for use on frame F. Value is non-zero if
5601 struct png_load_context
5603 /* These are members so that longjmp doesn't munge local variables. */
5604 png_struct
*png_ptr
;
5613 png_load_body (struct frame
*f
, struct image
*img
, struct png_load_context
*c
)
5615 Lisp_Object file
, specified_file
;
5616 Lisp_Object specified_data
;
5619 XImagePtr ximg
, mask_img
= NULL
;
5620 png_struct
*png_ptr
;
5621 png_info
*info_ptr
= NULL
, *end_info
= NULL
;
5624 png_byte
*pixels
= NULL
;
5625 png_byte
**rows
= NULL
;
5626 png_uint_32 width
, height
;
5627 int bit_depth
, color_type
, interlace_type
;
5629 png_uint_32 row_bytes
;
5631 struct png_memory_storage tbr
; /* Data to be read */
5633 /* Find out what file to load. */
5634 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
5635 specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
5637 if (NILP (specified_data
))
5639 file
= x_find_image_file (specified_file
);
5640 if (!STRINGP (file
))
5642 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
5646 /* Open the image file. */
5647 fp
= fopen (SSDATA (file
), "rb");
5650 image_error ("Cannot open image file `%s'", file
, Qnil
);
5654 /* Check PNG signature. */
5655 if (fread (sig
, 1, sizeof sig
, fp
) != sizeof sig
5656 || fn_png_sig_cmp (sig
, 0, sizeof sig
))
5658 image_error ("Not a PNG file: `%s'", file
, Qnil
);
5665 if (!STRINGP (specified_data
))
5667 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
5671 /* Read from memory. */
5672 tbr
.bytes
= SDATA (specified_data
);
5673 tbr
.len
= SBYTES (specified_data
);
5676 /* Check PNG signature. */
5677 if (tbr
.len
< sizeof sig
5678 || fn_png_sig_cmp (tbr
.bytes
, 0, sizeof sig
))
5680 image_error ("Not a PNG image: `%s'", img
->spec
, Qnil
);
5684 /* Need to skip past the signature. */
5685 tbr
.bytes
+= sizeof (sig
);
5688 /* Initialize read and info structs for PNG lib. */
5689 png_ptr
= fn_png_create_read_struct (PNG_LIBPNG_VER_STRING
,
5694 info_ptr
= fn_png_create_info_struct (png_ptr
);
5695 end_info
= fn_png_create_info_struct (png_ptr
);
5698 c
->png_ptr
= png_ptr
;
5699 c
->info_ptr
= info_ptr
;
5700 c
->end_info
= end_info
;
5705 if (! (info_ptr
&& end_info
))
5707 fn_png_destroy_read_struct (&c
->png_ptr
, &c
->info_ptr
, &c
->end_info
);
5712 if (fp
) fclose (fp
);
5716 /* Set error jump-back. We come back here when the PNG library
5717 detects an error. */
5718 if (_setjmp (PNG_JMPBUF (png_ptr
)))
5722 fn_png_destroy_read_struct (&c
->png_ptr
, &c
->info_ptr
, &c
->end_info
);
5730 /* Silence a bogus diagnostic; see GCC bug 54561. */
5731 IF_LINT (fp
= c
->fp
);
5733 /* Read image info. */
5734 if (!NILP (specified_data
))
5735 fn_png_set_read_fn (png_ptr
, (void *) &tbr
, png_read_from_memory
);
5737 fn_png_set_read_fn (png_ptr
, (void *) fp
, png_read_from_file
);
5739 fn_png_set_sig_bytes (png_ptr
, sizeof sig
);
5740 fn_png_read_info (png_ptr
, info_ptr
);
5741 fn_png_get_IHDR (png_ptr
, info_ptr
, &width
, &height
, &bit_depth
, &color_type
,
5742 &interlace_type
, NULL
, NULL
);
5744 if (! (width
<= INT_MAX
&& height
<= INT_MAX
5745 && check_image_size (f
, width
, height
)))
5747 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
5751 /* Create the X image and pixmap now, so that the work below can be
5752 omitted if the image is too large for X. */
5753 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0, &ximg
,
5757 /* If image contains simply transparency data, we prefer to
5758 construct a clipping mask. */
5759 if (fn_png_get_valid (png_ptr
, info_ptr
, PNG_INFO_tRNS
))
5764 /* This function is easier to write if we only have to handle
5765 one data format: RGB or RGBA with 8 bits per channel. Let's
5766 transform other formats into that format. */
5768 /* Strip more than 8 bits per channel. */
5769 if (bit_depth
== 16)
5770 fn_png_set_strip_16 (png_ptr
);
5772 /* Expand data to 24 bit RGB, or 8 bit grayscale, with alpha channel
5774 fn_png_set_expand (png_ptr
);
5776 /* Convert grayscale images to RGB. */
5777 if (color_type
== PNG_COLOR_TYPE_GRAY
5778 || color_type
== PNG_COLOR_TYPE_GRAY_ALPHA
)
5779 fn_png_set_gray_to_rgb (png_ptr
);
5781 /* Handle alpha channel by combining the image with a background
5782 color. Do this only if a real alpha channel is supplied. For
5783 simple transparency, we prefer a clipping mask. */
5786 /* png_color_16 *image_bg; */
5787 Lisp_Object specified_bg
5788 = image_spec_value (img
->spec
, QCbackground
, NULL
);
5789 int shift
= (bit_depth
== 16) ? 0 : 8;
5791 if (STRINGP (specified_bg
))
5792 /* The user specified `:background', use that. */
5795 if (x_defined_color (f
, SSDATA (specified_bg
), &color
, 0))
5797 png_color_16 user_bg
;
5799 memset (&user_bg
, 0, sizeof user_bg
);
5800 user_bg
.red
= color
.red
>> shift
;
5801 user_bg
.green
= color
.green
>> shift
;
5802 user_bg
.blue
= color
.blue
>> shift
;
5804 fn_png_set_background (png_ptr
, &user_bg
,
5805 PNG_BACKGROUND_GAMMA_SCREEN
, 0, 1.0);
5810 /* We use the current frame background, ignoring any default
5811 background color set by the image. */
5812 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI)
5814 png_color_16 frame_background
;
5816 color
.pixel
= FRAME_BACKGROUND_PIXEL (f
);
5817 x_query_color (f
, &color
);
5819 memset (&frame_background
, 0, sizeof frame_background
);
5820 frame_background
.red
= color
.red
>> shift
;
5821 frame_background
.green
= color
.green
>> shift
;
5822 frame_background
.blue
= color
.blue
>> shift
;
5823 #endif /* HAVE_X_WINDOWS */
5825 fn_png_set_background (png_ptr
, &frame_background
,
5826 PNG_BACKGROUND_GAMMA_SCREEN
, 0, 1.0);
5830 /* Update info structure. */
5831 fn_png_read_update_info (png_ptr
, info_ptr
);
5833 /* Get number of channels. Valid values are 1 for grayscale images
5834 and images with a palette, 2 for grayscale images with transparency
5835 information (alpha channel), 3 for RGB images, and 4 for RGB
5836 images with alpha channel, i.e. RGBA. If conversions above were
5837 sufficient we should only have 3 or 4 channels here. */
5838 channels
= fn_png_get_channels (png_ptr
, info_ptr
);
5839 eassert (channels
== 3 || channels
== 4);
5841 /* Number of bytes needed for one row of the image. */
5842 row_bytes
= fn_png_get_rowbytes (png_ptr
, info_ptr
);
5844 /* Allocate memory for the image. */
5845 if (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *rows
< height
5846 || min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *pixels
/ height
< row_bytes
)
5847 memory_full (SIZE_MAX
);
5848 c
->pixels
= pixels
= xmalloc (sizeof *pixels
* row_bytes
* height
);
5849 c
->rows
= rows
= xmalloc (height
* sizeof *rows
);
5850 for (i
= 0; i
< height
; ++i
)
5851 rows
[i
] = pixels
+ i
* row_bytes
;
5853 /* Read the entire image. */
5854 fn_png_read_image (png_ptr
, rows
);
5855 fn_png_read_end (png_ptr
, info_ptr
);
5862 /* Create an image and pixmap serving as mask if the PNG image
5863 contains an alpha channel. */
5866 && !x_create_x_image_and_pixmap (f
, width
, height
, 1,
5867 &mask_img
, &img
->mask
))
5869 x_destroy_x_image (ximg
);
5870 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->pixmap
);
5871 img
->pixmap
= NO_PIXMAP
;
5875 /* Fill the X image and mask from PNG data. */
5876 init_color_table ();
5878 for (y
= 0; y
< height
; ++y
)
5880 png_byte
*p
= rows
[y
];
5882 for (x
= 0; x
< width
; ++x
)
5889 XPutPixel (ximg
, x
, y
, lookup_rgb_color (f
, r
, g
, b
));
5890 /* An alpha channel, aka mask channel, associates variable
5891 transparency with an image. Where other image formats
5892 support binary transparency---fully transparent or fully
5893 opaque---PNG allows up to 254 levels of partial transparency.
5894 The PNG library implements partial transparency by combining
5895 the image with a specified background color.
5897 I'm not sure how to handle this here nicely: because the
5898 background on which the image is displayed may change, for
5899 real alpha channel support, it would be necessary to create
5900 a new image for each possible background.
5902 What I'm doing now is that a mask is created if we have
5903 boolean transparency information. Otherwise I'm using
5904 the frame's background color to combine the image with. */
5909 XPutPixel (mask_img
, x
, y
, *p
> 0 ? PIX_MASK_DRAW
: PIX_MASK_RETAIN
);
5915 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
5916 /* Set IMG's background color from the PNG image, unless the user
5920 if (fn_png_get_bKGD (png_ptr
, info_ptr
, &bg
))
5922 img
->background
= lookup_rgb_color (f
, bg
->red
, bg
->green
, bg
->blue
);
5923 img
->background_valid
= 1;
5927 #ifdef COLOR_TABLE_SUPPORT
5928 /* Remember colors allocated for this image. */
5929 img
->colors
= colors_in_color_table (&img
->ncolors
);
5930 free_color_table ();
5931 #endif /* COLOR_TABLE_SUPPORT */
5934 fn_png_destroy_read_struct (&c
->png_ptr
, &c
->info_ptr
, &c
->end_info
);
5939 img
->height
= height
;
5941 /* Maybe fill in the background field while we have ximg handy.
5942 Casting avoids a GCC warning. */
5943 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
5945 /* Put the image into the pixmap, then free the X image and its buffer. */
5946 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
5947 x_destroy_x_image (ximg
);
5949 /* Same for the mask. */
5952 /* Fill in the background_transparent field while we have the
5953 mask handy. Casting avoids a GCC warning. */
5954 image_background_transparent (img
, f
, (XImagePtr_or_DC
)mask_img
);
5956 x_put_x_image (f
, mask_img
, img
->mask
, img
->width
, img
->height
);
5957 x_destroy_x_image (mask_img
);
5964 png_load (struct frame
*f
, struct image
*img
)
5966 struct png_load_context c
;
5967 return png_load_body (f
, img
, &c
);
5970 #else /* HAVE_PNG */
5974 png_load (struct frame
*f
, struct image
*img
)
5976 return ns_load_image (f
, img
,
5977 image_spec_value (img
->spec
, QCfile
, NULL
),
5978 image_spec_value (img
->spec
, QCdata
, NULL
));
5980 #endif /* HAVE_NS */
5983 #endif /* !HAVE_PNG */
5987 /***********************************************************************
5989 ***********************************************************************/
5991 #if defined (HAVE_JPEG) || defined (HAVE_NS)
5993 static int jpeg_image_p (Lisp_Object object
);
5994 static int jpeg_load (struct frame
*f
, struct image
*img
);
5996 /* The symbol `jpeg' identifying images of this type. */
5998 static Lisp_Object Qjpeg
;
6000 /* Indices of image specification fields in gs_format, below. */
6002 enum jpeg_keyword_index
6011 JPEG_HEURISTIC_MASK
,
6017 /* Vector of image_keyword structures describing the format
6018 of valid user-defined image specifications. */
6020 static const struct image_keyword jpeg_format
[JPEG_LAST
] =
6022 {":type", IMAGE_SYMBOL_VALUE
, 1},
6023 {":data", IMAGE_STRING_VALUE
, 0},
6024 {":file", IMAGE_STRING_VALUE
, 0},
6025 {":ascent", IMAGE_ASCENT_VALUE
, 0},
6026 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
6027 {":relief", IMAGE_INTEGER_VALUE
, 0},
6028 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6029 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6030 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6031 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
6034 /* Structure describing the image type `jpeg'. */
6036 static struct image_type jpeg_type
=
6045 /* Return non-zero if OBJECT is a valid JPEG image specification. */
6048 jpeg_image_p (Lisp_Object object
)
6050 struct image_keyword fmt
[JPEG_LAST
];
6052 memcpy (fmt
, jpeg_format
, sizeof fmt
);
6054 if (!parse_image_spec (object
, fmt
, JPEG_LAST
, Qjpeg
))
6057 /* Must specify either the :data or :file keyword. */
6058 return fmt
[JPEG_FILE
].count
+ fmt
[JPEG_DATA
].count
== 1;
6061 #endif /* HAVE_JPEG || HAVE_NS */
6065 /* Work around a warning about HAVE_STDLIB_H being redefined in
6067 #ifdef HAVE_STDLIB_H
6068 #undef HAVE_STDLIB_H
6069 #endif /* HAVE_STLIB_H */
6071 #if defined (HAVE_NTGUI) && !defined (__WIN32__)
6072 /* In older releases of the jpeg library, jpeglib.h will define boolean
6073 differently depending on __WIN32__, so make sure it is defined. */
6077 #include <jpeglib.h>
6080 #ifdef HAVE_STLIB_H_1
6081 #define HAVE_STDLIB_H 1
6086 /* JPEG library details. */
6087 DEF_IMGLIB_FN (void, jpeg_CreateDecompress
, (j_decompress_ptr
, int, size_t));
6088 DEF_IMGLIB_FN (boolean
, jpeg_start_decompress
, (j_decompress_ptr
));
6089 DEF_IMGLIB_FN (boolean
, jpeg_finish_decompress
, (j_decompress_ptr
));
6090 DEF_IMGLIB_FN (void, jpeg_destroy_decompress
, (j_decompress_ptr
));
6091 DEF_IMGLIB_FN (int, jpeg_read_header
, (j_decompress_ptr
, boolean
));
6092 DEF_IMGLIB_FN (JDIMENSION
, jpeg_read_scanlines
, (j_decompress_ptr
, JSAMPARRAY
, JDIMENSION
));
6093 DEF_IMGLIB_FN (struct jpeg_error_mgr
*, jpeg_std_error
, (struct jpeg_error_mgr
*));
6094 DEF_IMGLIB_FN (boolean
, jpeg_resync_to_restart
, (j_decompress_ptr
, int));
6097 init_jpeg_functions (Lisp_Object libraries
)
6101 if (!(library
= w32_delayed_load (libraries
, Qjpeg
)))
6104 LOAD_IMGLIB_FN (library
, jpeg_finish_decompress
);
6105 LOAD_IMGLIB_FN (library
, jpeg_read_scanlines
);
6106 LOAD_IMGLIB_FN (library
, jpeg_start_decompress
);
6107 LOAD_IMGLIB_FN (library
, jpeg_read_header
);
6108 LOAD_IMGLIB_FN (library
, jpeg_CreateDecompress
);
6109 LOAD_IMGLIB_FN (library
, jpeg_destroy_decompress
);
6110 LOAD_IMGLIB_FN (library
, jpeg_std_error
);
6111 LOAD_IMGLIB_FN (library
, jpeg_resync_to_restart
);
6115 /* Wrapper since we can't directly assign the function pointer
6116 to another function pointer that was declared more completely easily. */
6118 jpeg_resync_to_restart_wrapper (j_decompress_ptr cinfo
, int desired
)
6120 return fn_jpeg_resync_to_restart (cinfo
, desired
);
6125 #define fn_jpeg_CreateDecompress(a,b,c) jpeg_create_decompress (a)
6126 #define fn_jpeg_start_decompress jpeg_start_decompress
6127 #define fn_jpeg_finish_decompress jpeg_finish_decompress
6128 #define fn_jpeg_destroy_decompress jpeg_destroy_decompress
6129 #define fn_jpeg_read_header jpeg_read_header
6130 #define fn_jpeg_read_scanlines jpeg_read_scanlines
6131 #define fn_jpeg_std_error jpeg_std_error
6132 #define jpeg_resync_to_restart_wrapper jpeg_resync_to_restart
6134 #endif /* HAVE_NTGUI */
6136 struct my_jpeg_error_mgr
6138 struct jpeg_error_mgr pub
;
6139 sys_jmp_buf setjmp_buffer
;
6141 /* The remaining members are so that longjmp doesn't munge local
6143 struct jpeg_decompress_struct cinfo
;
6147 MY_JPEG_INVALID_IMAGE_SIZE
,
6148 MY_JPEG_CANNOT_CREATE_X
6156 static _Noreturn
void
6157 my_error_exit (j_common_ptr cinfo
)
6159 struct my_jpeg_error_mgr
*mgr
= (struct my_jpeg_error_mgr
*) cinfo
->err
;
6160 mgr
->failure_code
= MY_JPEG_ERROR_EXIT
;
6161 sys_longjmp (mgr
->setjmp_buffer
, 1);
6165 /* Init source method for JPEG data source manager. Called by
6166 jpeg_read_header() before any data is actually read. See
6167 libjpeg.doc from the JPEG lib distribution. */
6170 our_common_init_source (j_decompress_ptr cinfo
)
6175 /* Method to terminate data source. Called by
6176 jpeg_finish_decompress() after all data has been processed. */
6179 our_common_term_source (j_decompress_ptr cinfo
)
6184 /* Fill input buffer method for JPEG data source manager. Called
6185 whenever more data is needed. We read the whole image in one step,
6186 so this only adds a fake end of input marker at the end. */
6188 static JOCTET our_memory_buffer
[2];
6191 our_memory_fill_input_buffer (j_decompress_ptr cinfo
)
6193 /* Insert a fake EOI marker. */
6194 struct jpeg_source_mgr
*src
= cinfo
->src
;
6196 our_memory_buffer
[0] = (JOCTET
) 0xFF;
6197 our_memory_buffer
[1] = (JOCTET
) JPEG_EOI
;
6199 src
->next_input_byte
= our_memory_buffer
;
6200 src
->bytes_in_buffer
= 2;
6205 /* Method to skip over NUM_BYTES bytes in the image data. CINFO->src
6206 is the JPEG data source manager. */
6209 our_memory_skip_input_data (j_decompress_ptr cinfo
, long int num_bytes
)
6211 struct jpeg_source_mgr
*src
= (struct jpeg_source_mgr
*) cinfo
->src
;
6215 if (num_bytes
> src
->bytes_in_buffer
)
6216 ERREXIT (cinfo
, JERR_INPUT_EOF
);
6218 src
->bytes_in_buffer
-= num_bytes
;
6219 src
->next_input_byte
+= num_bytes
;
6224 /* Set up the JPEG lib for reading an image from DATA which contains
6225 LEN bytes. CINFO is the decompression info structure created for
6226 reading the image. */
6229 jpeg_memory_src (j_decompress_ptr cinfo
, JOCTET
*data
, ptrdiff_t len
)
6231 struct jpeg_source_mgr
*src
;
6233 if (cinfo
->src
== NULL
)
6235 /* First time for this JPEG object? */
6236 cinfo
->src
= (struct jpeg_source_mgr
*)
6237 (*cinfo
->mem
->alloc_small
) ((j_common_ptr
) cinfo
, JPOOL_PERMANENT
,
6238 sizeof (struct jpeg_source_mgr
));
6239 src
= (struct jpeg_source_mgr
*) cinfo
->src
;
6240 src
->next_input_byte
= data
;
6243 src
= (struct jpeg_source_mgr
*) cinfo
->src
;
6244 src
->init_source
= our_common_init_source
;
6245 src
->fill_input_buffer
= our_memory_fill_input_buffer
;
6246 src
->skip_input_data
= our_memory_skip_input_data
;
6247 src
->resync_to_restart
= jpeg_resync_to_restart_wrapper
; /* Use default method. */
6248 src
->term_source
= our_common_term_source
;
6249 src
->bytes_in_buffer
= len
;
6250 src
->next_input_byte
= data
;
6254 struct jpeg_stdio_mgr
6256 struct jpeg_source_mgr mgr
;
6263 /* Size of buffer to read JPEG from file.
6264 Not too big, as we want to use alloc_small. */
6265 #define JPEG_STDIO_BUFFER_SIZE 8192
6268 /* Fill input buffer method for JPEG data source manager. Called
6269 whenever more data is needed. The data is read from a FILE *. */
6272 our_stdio_fill_input_buffer (j_decompress_ptr cinfo
)
6274 struct jpeg_stdio_mgr
*src
;
6276 src
= (struct jpeg_stdio_mgr
*) cinfo
->src
;
6281 bytes
= fread (src
->buffer
, 1, JPEG_STDIO_BUFFER_SIZE
, src
->file
);
6283 src
->mgr
.bytes_in_buffer
= bytes
;
6286 WARNMS (cinfo
, JWRN_JPEG_EOF
);
6288 src
->buffer
[0] = (JOCTET
) 0xFF;
6289 src
->buffer
[1] = (JOCTET
) JPEG_EOI
;
6290 src
->mgr
.bytes_in_buffer
= 2;
6292 src
->mgr
.next_input_byte
= src
->buffer
;
6299 /* Method to skip over NUM_BYTES bytes in the image data. CINFO->src
6300 is the JPEG data source manager. */
6303 our_stdio_skip_input_data (j_decompress_ptr cinfo
, long int num_bytes
)
6305 struct jpeg_stdio_mgr
*src
;
6306 src
= (struct jpeg_stdio_mgr
*) cinfo
->src
;
6308 while (num_bytes
> 0 && !src
->finished
)
6310 if (num_bytes
<= src
->mgr
.bytes_in_buffer
)
6312 src
->mgr
.bytes_in_buffer
-= num_bytes
;
6313 src
->mgr
.next_input_byte
+= num_bytes
;
6318 num_bytes
-= src
->mgr
.bytes_in_buffer
;
6319 src
->mgr
.bytes_in_buffer
= 0;
6320 src
->mgr
.next_input_byte
= NULL
;
6322 our_stdio_fill_input_buffer (cinfo
);
6328 /* Set up the JPEG lib for reading an image from a FILE *.
6329 CINFO is the decompression info structure created for
6330 reading the image. */
6333 jpeg_file_src (j_decompress_ptr cinfo
, FILE *fp
)
6335 struct jpeg_stdio_mgr
*src
;
6337 if (cinfo
->src
!= NULL
)
6338 src
= (struct jpeg_stdio_mgr
*) cinfo
->src
;
6341 /* First time for this JPEG object? */
6342 cinfo
->src
= (struct jpeg_source_mgr
*)
6343 (*cinfo
->mem
->alloc_small
) ((j_common_ptr
) cinfo
, JPOOL_PERMANENT
,
6344 sizeof (struct jpeg_stdio_mgr
));
6345 src
= (struct jpeg_stdio_mgr
*) cinfo
->src
;
6346 src
->buffer
= (JOCTET
*)
6347 (*cinfo
->mem
->alloc_small
) ((j_common_ptr
) cinfo
, JPOOL_PERMANENT
,
6348 JPEG_STDIO_BUFFER_SIZE
);
6353 src
->mgr
.init_source
= our_common_init_source
;
6354 src
->mgr
.fill_input_buffer
= our_stdio_fill_input_buffer
;
6355 src
->mgr
.skip_input_data
= our_stdio_skip_input_data
;
6356 src
->mgr
.resync_to_restart
= jpeg_resync_to_restart_wrapper
; /* Use default method. */
6357 src
->mgr
.term_source
= our_common_term_source
;
6358 src
->mgr
.bytes_in_buffer
= 0;
6359 src
->mgr
.next_input_byte
= NULL
;
6363 /* Load image IMG for use on frame F. Patterned after example.c
6364 from the JPEG lib. */
6367 jpeg_load_body (struct frame
*f
, struct image
*img
,
6368 struct my_jpeg_error_mgr
*mgr
)
6370 Lisp_Object file
, specified_file
;
6371 Lisp_Object specified_data
;
6374 int row_stride
, x
, y
;
6375 XImagePtr ximg
= NULL
;
6376 unsigned long *colors
;
6379 /* Open the JPEG file. */
6380 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
6381 specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
6383 if (NILP (specified_data
))
6385 file
= x_find_image_file (specified_file
);
6386 if (!STRINGP (file
))
6388 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
6392 fp
= fopen (SSDATA (file
), "rb");
6395 image_error ("Cannot open `%s'", file
, Qnil
);
6399 else if (!STRINGP (specified_data
))
6401 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
6405 IF_LINT (mgr
->fp
= fp
);
6407 /* Customize libjpeg's error handling to call my_error_exit when an
6408 error is detected. This function will perform a longjmp. */
6409 mgr
->cinfo
.err
= fn_jpeg_std_error (&mgr
->pub
);
6410 mgr
->pub
.error_exit
= my_error_exit
;
6411 if (sys_setjmp (mgr
->setjmp_buffer
))
6413 switch (mgr
->failure_code
)
6415 case MY_JPEG_ERROR_EXIT
:
6417 char buf
[JMSG_LENGTH_MAX
];
6418 mgr
->cinfo
.err
->format_message ((j_common_ptr
) &mgr
->cinfo
, buf
);
6419 image_error ("Error reading JPEG image `%s': %s", img
->spec
,
6420 build_string (buf
));
6424 case MY_JPEG_INVALID_IMAGE_SIZE
:
6425 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
6428 case MY_JPEG_CANNOT_CREATE_X
:
6432 /* Close the input file and destroy the JPEG object. */
6435 fn_jpeg_destroy_decompress (&mgr
->cinfo
);
6437 /* If we already have an XImage, free that. */
6438 x_destroy_x_image (ximg
);
6440 /* Free pixmap and colors. */
6441 x_clear_image (f
, img
);
6445 /* Silence a bogus diagnostic; see GCC bug 54561. */
6446 IF_LINT (fp
= mgr
->fp
);
6448 /* Create the JPEG decompression object. Let it read from fp.
6449 Read the JPEG image header. */
6450 fn_jpeg_CreateDecompress (&mgr
->cinfo
, JPEG_LIB_VERSION
, sizeof *&mgr
->cinfo
);
6452 if (NILP (specified_data
))
6453 jpeg_file_src (&mgr
->cinfo
, fp
);
6455 jpeg_memory_src (&mgr
->cinfo
, SDATA (specified_data
),
6456 SBYTES (specified_data
));
6458 fn_jpeg_read_header (&mgr
->cinfo
, 1);
6460 /* Customize decompression so that color quantization will be used.
6461 Start decompression. */
6462 mgr
->cinfo
.quantize_colors
= 1;
6463 fn_jpeg_start_decompress (&mgr
->cinfo
);
6464 width
= img
->width
= mgr
->cinfo
.output_width
;
6465 height
= img
->height
= mgr
->cinfo
.output_height
;
6467 if (!check_image_size (f
, width
, height
))
6469 mgr
->failure_code
= MY_JPEG_INVALID_IMAGE_SIZE
;
6470 sys_longjmp (mgr
->setjmp_buffer
, 1);
6473 /* Create X image and pixmap. */
6474 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0, &ximg
, &img
->pixmap
))
6476 mgr
->failure_code
= MY_JPEG_CANNOT_CREATE_X
;
6477 sys_longjmp (mgr
->setjmp_buffer
, 1);
6480 /* Allocate colors. When color quantization is used,
6481 mgr->cinfo.actual_number_of_colors has been set with the number of
6482 colors generated, and mgr->cinfo.colormap is a two-dimensional array
6483 of color indices in the range 0..mgr->cinfo.actual_number_of_colors.
6484 No more than 255 colors will be generated. */
6488 if (mgr
->cinfo
.out_color_components
> 2)
6489 ir
= 0, ig
= 1, ib
= 2;
6490 else if (mgr
->cinfo
.out_color_components
> 1)
6491 ir
= 0, ig
= 1, ib
= 0;
6493 ir
= 0, ig
= 0, ib
= 0;
6495 /* Use the color table mechanism because it handles colors that
6496 cannot be allocated nicely. Such colors will be replaced with
6497 a default color, and we don't have to care about which colors
6498 can be freed safely, and which can't. */
6499 init_color_table ();
6500 colors
= alloca (mgr
->cinfo
.actual_number_of_colors
* sizeof *colors
);
6502 for (i
= 0; i
< mgr
->cinfo
.actual_number_of_colors
; ++i
)
6504 /* Multiply RGB values with 255 because X expects RGB values
6505 in the range 0..0xffff. */
6506 int r
= mgr
->cinfo
.colormap
[ir
][i
] << 8;
6507 int g
= mgr
->cinfo
.colormap
[ig
][i
] << 8;
6508 int b
= mgr
->cinfo
.colormap
[ib
][i
] << 8;
6509 colors
[i
] = lookup_rgb_color (f
, r
, g
, b
);
6512 #ifdef COLOR_TABLE_SUPPORT
6513 /* Remember those colors actually allocated. */
6514 img
->colors
= colors_in_color_table (&img
->ncolors
);
6515 free_color_table ();
6516 #endif /* COLOR_TABLE_SUPPORT */
6520 row_stride
= width
* mgr
->cinfo
.output_components
;
6521 buffer
= mgr
->cinfo
.mem
->alloc_sarray ((j_common_ptr
) &mgr
->cinfo
,
6522 JPOOL_IMAGE
, row_stride
, 1);
6523 for (y
= 0; y
< height
; ++y
)
6525 fn_jpeg_read_scanlines (&mgr
->cinfo
, buffer
, 1);
6526 for (x
= 0; x
< mgr
->cinfo
.output_width
; ++x
)
6527 XPutPixel (ximg
, x
, y
, colors
[buffer
[0][x
]]);
6531 fn_jpeg_finish_decompress (&mgr
->cinfo
);
6532 fn_jpeg_destroy_decompress (&mgr
->cinfo
);
6536 /* Maybe fill in the background field while we have ximg handy. */
6537 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
6538 /* Casting avoids a GCC warning. */
6539 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
6541 /* Put the image into the pixmap. */
6542 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
6543 x_destroy_x_image (ximg
);
6548 jpeg_load (struct frame
*f
, struct image
*img
)
6550 struct my_jpeg_error_mgr mgr
;
6551 return jpeg_load_body (f
, img
, &mgr
);
6554 #else /* HAVE_JPEG */
6558 jpeg_load (struct frame
*f
, struct image
*img
)
6560 return ns_load_image (f
, img
,
6561 image_spec_value (img
->spec
, QCfile
, NULL
),
6562 image_spec_value (img
->spec
, QCdata
, NULL
));
6564 #endif /* HAVE_NS */
6566 #endif /* !HAVE_JPEG */
6570 /***********************************************************************
6572 ***********************************************************************/
6574 #if defined (HAVE_TIFF) || defined (HAVE_NS)
6576 static int tiff_image_p (Lisp_Object object
);
6577 static int tiff_load (struct frame
*f
, struct image
*img
);
6579 /* The symbol `tiff' identifying images of this type. */
6581 static Lisp_Object Qtiff
;
6583 /* Indices of image specification fields in tiff_format, below. */
6585 enum tiff_keyword_index
6594 TIFF_HEURISTIC_MASK
,
6601 /* Vector of image_keyword structures describing the format
6602 of valid user-defined image specifications. */
6604 static const struct image_keyword tiff_format
[TIFF_LAST
] =
6606 {":type", IMAGE_SYMBOL_VALUE
, 1},
6607 {":data", IMAGE_STRING_VALUE
, 0},
6608 {":file", IMAGE_STRING_VALUE
, 0},
6609 {":ascent", IMAGE_ASCENT_VALUE
, 0},
6610 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
6611 {":relief", IMAGE_INTEGER_VALUE
, 0},
6612 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6613 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6614 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6615 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0},
6616 {":index", IMAGE_NON_NEGATIVE_INTEGER_VALUE
, 0}
6619 /* Structure describing the image type `tiff'. */
6621 static struct image_type tiff_type
=
6630 /* Return non-zero if OBJECT is a valid TIFF image specification. */
6633 tiff_image_p (Lisp_Object object
)
6635 struct image_keyword fmt
[TIFF_LAST
];
6636 memcpy (fmt
, tiff_format
, sizeof fmt
);
6638 if (!parse_image_spec (object
, fmt
, TIFF_LAST
, Qtiff
))
6641 /* Must specify either the :data or :file keyword. */
6642 return fmt
[TIFF_FILE
].count
+ fmt
[TIFF_DATA
].count
== 1;
6645 #endif /* HAVE_TIFF || HAVE_NS */
6653 /* TIFF library details. */
6654 DEF_IMGLIB_FN (TIFFErrorHandler
, TIFFSetErrorHandler
, (TIFFErrorHandler
));
6655 DEF_IMGLIB_FN (TIFFErrorHandler
, TIFFSetWarningHandler
, (TIFFErrorHandler
));
6656 DEF_IMGLIB_FN (TIFF
*, TIFFOpen
, (const char *, const char *));
6657 DEF_IMGLIB_FN (TIFF
*, TIFFClientOpen
, (const char *, const char *, thandle_t
,
6658 TIFFReadWriteProc
, TIFFReadWriteProc
,
6659 TIFFSeekProc
, TIFFCloseProc
, TIFFSizeProc
,
6660 TIFFMapFileProc
, TIFFUnmapFileProc
));
6661 DEF_IMGLIB_FN (int, TIFFGetField
, (TIFF
*, ttag_t
, ...));
6662 DEF_IMGLIB_FN (int, TIFFReadRGBAImage
, (TIFF
*, uint32
, uint32
, uint32
*, int));
6663 DEF_IMGLIB_FN (void, TIFFClose
, (TIFF
*));
6664 DEF_IMGLIB_FN (int, TIFFSetDirectory
, (TIFF
*, tdir_t
));
6667 init_tiff_functions (Lisp_Object libraries
)
6671 if (!(library
= w32_delayed_load (libraries
, Qtiff
)))
6674 LOAD_IMGLIB_FN (library
, TIFFSetErrorHandler
);
6675 LOAD_IMGLIB_FN (library
, TIFFSetWarningHandler
);
6676 LOAD_IMGLIB_FN (library
, TIFFOpen
);
6677 LOAD_IMGLIB_FN (library
, TIFFClientOpen
);
6678 LOAD_IMGLIB_FN (library
, TIFFGetField
);
6679 LOAD_IMGLIB_FN (library
, TIFFReadRGBAImage
);
6680 LOAD_IMGLIB_FN (library
, TIFFClose
);
6681 LOAD_IMGLIB_FN (library
, TIFFSetDirectory
);
6687 #define fn_TIFFSetErrorHandler TIFFSetErrorHandler
6688 #define fn_TIFFSetWarningHandler TIFFSetWarningHandler
6689 #define fn_TIFFOpen TIFFOpen
6690 #define fn_TIFFClientOpen TIFFClientOpen
6691 #define fn_TIFFGetField TIFFGetField
6692 #define fn_TIFFReadRGBAImage TIFFReadRGBAImage
6693 #define fn_TIFFClose TIFFClose
6694 #define fn_TIFFSetDirectory TIFFSetDirectory
6695 #endif /* HAVE_NTGUI */
6698 /* Reading from a memory buffer for TIFF images Based on the PNG
6699 memory source, but we have to provide a lot of extra functions.
6702 We really only need to implement read and seek, but I am not
6703 convinced that the TIFF library is smart enough not to destroy
6704 itself if we only hand it the function pointers we need to
6709 unsigned char *bytes
;
6716 tiff_read_from_memory (thandle_t data
, tdata_t buf
, tsize_t size
)
6718 tiff_memory_source
*src
= (tiff_memory_source
*) data
;
6720 size
= min (size
, src
->len
- src
->index
);
6721 memcpy (buf
, src
->bytes
+ src
->index
, size
);
6727 tiff_write_from_memory (thandle_t data
, tdata_t buf
, tsize_t size
)
6733 tiff_seek_in_memory (thandle_t data
, toff_t off
, int whence
)
6735 tiff_memory_source
*src
= (tiff_memory_source
*) data
;
6740 case SEEK_SET
: /* Go from beginning of source. */
6744 case SEEK_END
: /* Go from end of source. */
6745 idx
= src
->len
+ off
;
6748 case SEEK_CUR
: /* Go from current position. */
6749 idx
= src
->index
+ off
;
6752 default: /* Invalid `whence'. */
6756 if (idx
> src
->len
|| idx
< 0)
6764 tiff_close_memory (thandle_t data
)
6771 tiff_mmap_memory (thandle_t data
, tdata_t
*pbase
, toff_t
*psize
)
6773 /* It is already _IN_ memory. */
6778 tiff_unmap_memory (thandle_t data
, tdata_t base
, toff_t size
)
6780 /* We don't need to do this. */
6784 tiff_size_of_memory (thandle_t data
)
6786 return ((tiff_memory_source
*) data
)->len
;
6789 /* GCC 3.x on x86 Windows targets has a bug that triggers an internal
6790 compiler error compiling tiff_handler, see Bugzilla bug #17406
6791 (http://gcc.gnu.org/bugzilla/show_bug.cgi?id=17406). Declaring
6792 this function as external works around that problem. */
6793 #if defined (__MINGW32__) && __GNUC__ == 3
6794 # define MINGW_STATIC
6796 # define MINGW_STATIC static
6800 tiff_handler (const char *, const char *, const char *, va_list)
6801 ATTRIBUTE_FORMAT_PRINTF (3, 0);
6803 tiff_handler (const char *log_format
, const char *title
,
6804 const char *format
, va_list ap
)
6806 /* doprnt is not suitable here, as TIFF handlers are called from
6807 libtiff and are passed arbitrary printf directives. Instead, use
6808 vsnprintf, taking care to be portable to nonstandard environments
6809 where vsnprintf returns -1 on buffer overflow. Since it's just a
6810 log entry, it's OK to truncate it. */
6812 int len
= vsnprintf (buf
, sizeof buf
, format
, ap
);
6813 add_to_log (log_format
, build_string (title
),
6814 make_string (buf
, max (0, min (len
, sizeof buf
- 1))));
6818 static void tiff_error_handler (const char *, const char *, va_list)
6819 ATTRIBUTE_FORMAT_PRINTF (2, 0);
6821 tiff_error_handler (const char *title
, const char *format
, va_list ap
)
6823 tiff_handler ("TIFF error: %s %s", title
, format
, ap
);
6827 static void tiff_warning_handler (const char *, const char *, va_list)
6828 ATTRIBUTE_FORMAT_PRINTF (2, 0);
6830 tiff_warning_handler (const char *title
, const char *format
, va_list ap
)
6832 tiff_handler ("TIFF warning: %s %s", title
, format
, ap
);
6836 /* Load TIFF image IMG for use on frame F. Value is non-zero if
6840 tiff_load (struct frame
*f
, struct image
*img
)
6842 Lisp_Object file
, specified_file
;
6843 Lisp_Object specified_data
;
6845 int width
, height
, x
, y
, count
;
6849 tiff_memory_source memsrc
;
6852 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
6853 specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
6855 fn_TIFFSetErrorHandler ((TIFFErrorHandler
) tiff_error_handler
);
6856 fn_TIFFSetWarningHandler ((TIFFErrorHandler
) tiff_warning_handler
);
6858 if (NILP (specified_data
))
6860 /* Read from a file */
6861 file
= x_find_image_file (specified_file
);
6862 if (!STRINGP (file
))
6864 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
6868 /* Try to open the image file. */
6869 tiff
= fn_TIFFOpen (SSDATA (file
), "r");
6872 image_error ("Cannot open `%s'", file
, Qnil
);
6878 if (!STRINGP (specified_data
))
6880 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
6884 /* Memory source! */
6885 memsrc
.bytes
= SDATA (specified_data
);
6886 memsrc
.len
= SBYTES (specified_data
);
6889 tiff
= fn_TIFFClientOpen ("memory_source", "r", (thandle_t
)&memsrc
,
6890 tiff_read_from_memory
,
6891 tiff_write_from_memory
,
6892 tiff_seek_in_memory
,
6894 tiff_size_of_memory
,
6900 image_error ("Cannot open memory source for `%s'", img
->spec
, Qnil
);
6905 image
= image_spec_value (img
->spec
, QCindex
, NULL
);
6906 if (INTEGERP (image
))
6908 EMACS_INT ino
= XFASTINT (image
);
6909 if (! (TYPE_MINIMUM (tdir_t
) <= ino
&& ino
<= TYPE_MAXIMUM (tdir_t
)
6910 && fn_TIFFSetDirectory (tiff
, ino
)))
6912 image_error ("Invalid image number `%s' in image `%s'",
6914 fn_TIFFClose (tiff
);
6919 /* Get width and height of the image, and allocate a raster buffer
6920 of width x height 32-bit values. */
6921 fn_TIFFGetField (tiff
, TIFFTAG_IMAGEWIDTH
, &width
);
6922 fn_TIFFGetField (tiff
, TIFFTAG_IMAGELENGTH
, &height
);
6924 if (!check_image_size (f
, width
, height
))
6926 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
6927 fn_TIFFClose (tiff
);
6931 /* Create the X image and pixmap. */
6932 if (! (height
<= min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *buf
/ width
6933 && x_create_x_image_and_pixmap (f
, width
, height
, 0,
6934 &ximg
, &img
->pixmap
)))
6936 fn_TIFFClose (tiff
);
6940 buf
= xmalloc (sizeof *buf
* width
* height
);
6942 rc
= fn_TIFFReadRGBAImage (tiff
, width
, height
, buf
, 0);
6944 /* Count the number of images in the file. */
6945 for (count
= 1; fn_TIFFSetDirectory (tiff
, count
); count
++)
6949 img
->lisp_data
= Fcons (Qcount
,
6950 Fcons (make_number (count
),
6953 fn_TIFFClose (tiff
);
6956 image_error ("Error reading TIFF image `%s'", img
->spec
, Qnil
);
6961 /* Initialize the color table. */
6962 init_color_table ();
6964 /* Process the pixel raster. Origin is in the lower-left corner. */
6965 for (y
= 0; y
< height
; ++y
)
6967 uint32
*row
= buf
+ y
* width
;
6969 for (x
= 0; x
< width
; ++x
)
6971 uint32 abgr
= row
[x
];
6972 int r
= TIFFGetR (abgr
) << 8;
6973 int g
= TIFFGetG (abgr
) << 8;
6974 int b
= TIFFGetB (abgr
) << 8;
6975 XPutPixel (ximg
, x
, height
- 1 - y
, lookup_rgb_color (f
, r
, g
, b
));
6979 #ifdef COLOR_TABLE_SUPPORT
6980 /* Remember the colors allocated for the image. Free the color table. */
6981 img
->colors
= colors_in_color_table (&img
->ncolors
);
6982 free_color_table ();
6983 #endif /* COLOR_TABLE_SUPPORT */
6986 img
->height
= height
;
6988 /* Maybe fill in the background field while we have ximg handy. */
6989 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
6990 /* Casting avoids a GCC warning on W32. */
6991 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
6993 /* Put the image into the pixmap, then free the X image and its buffer. */
6994 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
6995 x_destroy_x_image (ximg
);
7001 #else /* HAVE_TIFF */
7005 tiff_load (struct frame
*f
, struct image
*img
)
7007 return ns_load_image (f
, img
,
7008 image_spec_value (img
->spec
, QCfile
, NULL
),
7009 image_spec_value (img
->spec
, QCdata
, NULL
));
7011 #endif /* HAVE_NS */
7013 #endif /* !HAVE_TIFF */
7017 /***********************************************************************
7019 ***********************************************************************/
7021 #if defined (HAVE_GIF) || defined (HAVE_NS)
7023 static int gif_image_p (Lisp_Object object
);
7024 static int gif_load (struct frame
*f
, struct image
*img
);
7025 static void gif_clear_image (struct frame
*f
, struct image
*img
);
7027 /* The symbol `gif' identifying images of this type. */
7029 static Lisp_Object Qgif
;
7031 /* Indices of image specification fields in gif_format, below. */
7033 enum gif_keyword_index
7049 /* Vector of image_keyword structures describing the format
7050 of valid user-defined image specifications. */
7052 static const struct image_keyword gif_format
[GIF_LAST
] =
7054 {":type", IMAGE_SYMBOL_VALUE
, 1},
7055 {":data", IMAGE_STRING_VALUE
, 0},
7056 {":file", IMAGE_STRING_VALUE
, 0},
7057 {":ascent", IMAGE_ASCENT_VALUE
, 0},
7058 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
7059 {":relief", IMAGE_INTEGER_VALUE
, 0},
7060 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7061 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7062 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7063 {":index", IMAGE_NON_NEGATIVE_INTEGER_VALUE
, 0},
7064 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
7067 /* Structure describing the image type `gif'. */
7069 static struct image_type gif_type
=
7078 /* Free X resources of GIF image IMG which is used on frame F. */
7081 gif_clear_image (struct frame
*f
, struct image
*img
)
7083 img
->lisp_data
= Qnil
;
7084 x_clear_image (f
, img
);
7087 /* Return non-zero if OBJECT is a valid GIF image specification. */
7090 gif_image_p (Lisp_Object object
)
7092 struct image_keyword fmt
[GIF_LAST
];
7093 memcpy (fmt
, gif_format
, sizeof fmt
);
7095 if (!parse_image_spec (object
, fmt
, GIF_LAST
, Qgif
))
7098 /* Must specify either the :data or :file keyword. */
7099 return fmt
[GIF_FILE
].count
+ fmt
[GIF_DATA
].count
== 1;
7102 #endif /* HAVE_GIF */
7106 #if defined (HAVE_NTGUI)
7107 /* winuser.h might define DrawText to DrawTextA or DrawTextW.
7108 Undefine before redefining to avoid a preprocessor warning. */
7112 /* avoid conflict with QuickdrawText.h */
7113 #define DrawText gif_DrawText
7114 #include <gif_lib.h>
7117 #else /* HAVE_NTGUI */
7119 #include <gif_lib.h>
7121 #endif /* HAVE_NTGUI */
7126 /* GIF library details. */
7127 DEF_IMGLIB_FN (int, DGifCloseFile
, (GifFileType
*));
7128 DEF_IMGLIB_FN (int, DGifSlurp
, (GifFileType
*));
7129 DEF_IMGLIB_FN (GifFileType
*, DGifOpen
, (void *, InputFunc
));
7130 DEF_IMGLIB_FN (GifFileType
*, DGifOpenFileName
, (const char *));
7133 init_gif_functions (Lisp_Object libraries
)
7137 if (!(library
= w32_delayed_load (libraries
, Qgif
)))
7140 LOAD_IMGLIB_FN (library
, DGifCloseFile
);
7141 LOAD_IMGLIB_FN (library
, DGifSlurp
);
7142 LOAD_IMGLIB_FN (library
, DGifOpen
);
7143 LOAD_IMGLIB_FN (library
, DGifOpenFileName
);
7149 #define fn_DGifCloseFile DGifCloseFile
7150 #define fn_DGifSlurp DGifSlurp
7151 #define fn_DGifOpen DGifOpen
7152 #define fn_DGifOpenFileName DGifOpenFileName
7154 #endif /* HAVE_NTGUI */
7156 /* Reading a GIF image from memory
7157 Based on the PNG memory stuff to a certain extent. */
7161 unsigned char *bytes
;
7167 /* Make the current memory source available to gif_read_from_memory.
7168 It's done this way because not all versions of libungif support
7169 a UserData field in the GifFileType structure. */
7170 static gif_memory_source
*current_gif_memory_src
;
7173 gif_read_from_memory (GifFileType
*file
, GifByteType
*buf
, int len
)
7175 gif_memory_source
*src
= current_gif_memory_src
;
7177 if (len
> src
->len
- src
->index
)
7180 memcpy (buf
, src
->bytes
+ src
->index
, len
);
7186 /* Load GIF image IMG for use on frame F. Value is non-zero if
7189 static const int interlace_start
[] = {0, 4, 2, 1};
7190 static const int interlace_increment
[] = {8, 8, 4, 2};
7192 #define GIF_LOCAL_DESCRIPTOR_EXTENSION 249
7195 gif_load (struct frame
*f
, struct image
*img
)
7198 int rc
, width
, height
, x
, y
, i
, j
;
7200 ColorMapObject
*gif_color_map
;
7201 unsigned long pixel_colors
[256];
7203 gif_memory_source memsrc
;
7204 Lisp_Object specified_bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
7205 Lisp_Object specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
7206 Lisp_Object specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
7207 unsigned long bgcolor
= 0;
7210 if (NILP (specified_data
))
7212 file
= x_find_image_file (specified_file
);
7213 if (!STRINGP (file
))
7215 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
7219 /* Open the GIF file. */
7220 gif
= fn_DGifOpenFileName (SSDATA (file
));
7223 image_error ("Cannot open `%s'", file
, Qnil
);
7229 if (!STRINGP (specified_data
))
7231 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
7235 /* Read from memory! */
7236 current_gif_memory_src
= &memsrc
;
7237 memsrc
.bytes
= SDATA (specified_data
);
7238 memsrc
.len
= SBYTES (specified_data
);
7241 gif
= fn_DGifOpen (&memsrc
, gif_read_from_memory
);
7244 image_error ("Cannot open memory source `%s'", img
->spec
, Qnil
);
7249 /* Before reading entire contents, check the declared image size. */
7250 if (!check_image_size (f
, gif
->SWidth
, gif
->SHeight
))
7252 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
7253 fn_DGifCloseFile (gif
);
7257 /* Read entire contents. */
7258 rc
= fn_DGifSlurp (gif
);
7259 if (rc
== GIF_ERROR
|| gif
->ImageCount
<= 0)
7261 image_error ("Error reading `%s'", img
->spec
, Qnil
);
7262 fn_DGifCloseFile (gif
);
7266 /* Which sub-image are we to display? */
7268 Lisp_Object image_number
= image_spec_value (img
->spec
, QCindex
, NULL
);
7269 idx
= INTEGERP (image_number
) ? XFASTINT (image_number
) : 0;
7270 if (idx
< 0 || idx
>= gif
->ImageCount
)
7272 image_error ("Invalid image number `%s' in image `%s'",
7273 image_number
, img
->spec
);
7274 fn_DGifCloseFile (gif
);
7279 width
= img
->width
= gif
->SWidth
;
7280 height
= img
->height
= gif
->SHeight
;
7282 img
->corners
[TOP_CORNER
] = gif
->SavedImages
[0].ImageDesc
.Top
;
7283 img
->corners
[LEFT_CORNER
] = gif
->SavedImages
[0].ImageDesc
.Left
;
7284 img
->corners
[BOT_CORNER
]
7285 = img
->corners
[TOP_CORNER
] + gif
->SavedImages
[0].ImageDesc
.Height
;
7286 img
->corners
[RIGHT_CORNER
]
7287 = img
->corners
[LEFT_CORNER
] + gif
->SavedImages
[0].ImageDesc
.Width
;
7289 if (!check_image_size (f
, width
, height
))
7291 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
7292 fn_DGifCloseFile (gif
);
7296 /* Create the X image and pixmap. */
7297 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0, &ximg
, &img
->pixmap
))
7299 fn_DGifCloseFile (gif
);
7303 /* Clear the part of the screen image not covered by the image.
7304 Full animated GIF support requires more here (see the gif89 spec,
7305 disposal methods). Let's simply assume that the part not covered
7306 by a sub-image is in the frame's background color. */
7307 for (y
= 0; y
< img
->corners
[TOP_CORNER
]; ++y
)
7308 for (x
= 0; x
< width
; ++x
)
7309 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7311 for (y
= img
->corners
[BOT_CORNER
]; y
< height
; ++y
)
7312 for (x
= 0; x
< width
; ++x
)
7313 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7315 for (y
= img
->corners
[TOP_CORNER
]; y
< img
->corners
[BOT_CORNER
]; ++y
)
7317 for (x
= 0; x
< img
->corners
[LEFT_CORNER
]; ++x
)
7318 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7319 for (x
= img
->corners
[RIGHT_CORNER
]; x
< width
; ++x
)
7320 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7323 /* Read the GIF image into the X image. */
7325 /* FIXME: With the current implementation, loading an animated gif
7326 is quadratic in the number of animation frames, since each frame
7327 is a separate struct image. We must provide a way for a single
7328 gif_load call to construct and save all animation frames. */
7330 init_color_table ();
7331 if (STRINGP (specified_bg
))
7332 bgcolor
= x_alloc_image_color (f
, img
, specified_bg
,
7333 FRAME_BACKGROUND_PIXEL (f
));
7334 for (j
= 0; j
<= idx
; ++j
)
7336 /* We use a local variable `raster' here because RasterBits is a
7337 char *, which invites problems with bytes >= 0x80. */
7338 struct SavedImage
*subimage
= gif
->SavedImages
+ j
;
7339 unsigned char *raster
= (unsigned char *) subimage
->RasterBits
;
7340 int transparency_color_index
= -1;
7342 int subimg_width
= subimage
->ImageDesc
.Width
;
7343 int subimg_height
= subimage
->ImageDesc
.Height
;
7344 int subimg_top
= subimage
->ImageDesc
.Top
;
7345 int subimg_left
= subimage
->ImageDesc
.Left
;
7347 /* Find the Graphic Control Extension block for this sub-image.
7348 Extract the disposal method and transparency color. */
7349 for (i
= 0; i
< subimage
->ExtensionBlockCount
; i
++)
7351 ExtensionBlock
*extblock
= subimage
->ExtensionBlocks
+ i
;
7353 if ((extblock
->Function
== GIF_LOCAL_DESCRIPTOR_EXTENSION
)
7354 && extblock
->ByteCount
== 4
7355 && extblock
->Bytes
[0] & 1)
7357 /* From gif89a spec: 1 = "keep in place", 2 = "restore
7358 to background". Treat any other value like 2. */
7359 disposal
= (extblock
->Bytes
[0] >> 2) & 7;
7360 transparency_color_index
= (unsigned char) extblock
->Bytes
[3];
7365 /* We can't "keep in place" the first subimage. */
7369 /* For disposal == 0, the spec says "No disposal specified. The
7370 decoder is not required to take any action." In practice, it
7371 seems we need to treat this like "keep in place", see e.g.
7372 http://upload.wikimedia.org/wikipedia/commons/3/37/Clock.gif */
7376 /* Allocate subimage colors. */
7377 memset (pixel_colors
, 0, sizeof pixel_colors
);
7378 gif_color_map
= subimage
->ImageDesc
.ColorMap
;
7380 gif_color_map
= gif
->SColorMap
;
7383 for (i
= 0; i
< gif_color_map
->ColorCount
; ++i
)
7385 if (transparency_color_index
== i
)
7386 pixel_colors
[i
] = STRINGP (specified_bg
)
7387 ? bgcolor
: FRAME_BACKGROUND_PIXEL (f
);
7390 int r
= gif_color_map
->Colors
[i
].Red
<< 8;
7391 int g
= gif_color_map
->Colors
[i
].Green
<< 8;
7392 int b
= gif_color_map
->Colors
[i
].Blue
<< 8;
7393 pixel_colors
[i
] = lookup_rgb_color (f
, r
, g
, b
);
7397 /* Apply the pixel values. */
7398 if (gif
->SavedImages
[j
].ImageDesc
.Interlace
)
7402 for (y
= 0, row
= interlace_start
[0], pass
= 0;
7404 y
++, row
+= interlace_increment
[pass
])
7406 if (row
>= subimg_height
)
7408 row
= interlace_start
[++pass
];
7409 while (row
>= subimg_height
)
7410 row
= interlace_start
[++pass
];
7413 for (x
= 0; x
< subimg_width
; x
++)
7415 int c
= raster
[y
* subimg_width
+ x
];
7416 if (transparency_color_index
!= c
|| disposal
!= 1)
7417 XPutPixel (ximg
, x
+ subimg_left
, row
+ subimg_top
,
7424 for (y
= 0; y
< subimg_height
; ++y
)
7425 for (x
= 0; x
< subimg_width
; ++x
)
7427 int c
= raster
[y
* subimg_width
+ x
];
7428 if (transparency_color_index
!= c
|| disposal
!= 1)
7429 XPutPixel (ximg
, x
+ subimg_left
, y
+ subimg_top
,
7435 #ifdef COLOR_TABLE_SUPPORT
7436 img
->colors
= colors_in_color_table (&img
->ncolors
);
7437 free_color_table ();
7438 #endif /* COLOR_TABLE_SUPPORT */
7440 /* Save GIF image extension data for `image-metadata'.
7441 Format is (count IMAGES extension-data (FUNCTION "BYTES" ...)). */
7442 img
->lisp_data
= Qnil
;
7443 if (gif
->SavedImages
[idx
].ExtensionBlockCount
> 0)
7446 ExtensionBlock
*ext
= gif
->SavedImages
[idx
].ExtensionBlocks
;
7447 for (i
= 0; i
< gif
->SavedImages
[idx
].ExtensionBlockCount
; i
++, ext
++)
7448 /* Append (... FUNCTION "BYTES") */
7451 = Fcons (make_number (ext
->Function
),
7452 Fcons (make_unibyte_string (ext
->Bytes
, ext
->ByteCount
),
7454 if (ext
->Function
== GIF_LOCAL_DESCRIPTOR_EXTENSION
7455 && ext
->ByteCount
== 4)
7457 delay
= ext
->Bytes
[2] << CHAR_BIT
;
7458 delay
|= ext
->Bytes
[1];
7461 img
->lisp_data
= Fcons (Qextension_data
,
7462 Fcons (img
->lisp_data
, Qnil
));
7466 Fcons (make_float (delay
/ 100.0),
7470 if (gif
->ImageCount
> 1)
7471 img
->lisp_data
= Fcons (Qcount
,
7472 Fcons (make_number (gif
->ImageCount
),
7475 fn_DGifCloseFile (gif
);
7477 /* Maybe fill in the background field while we have ximg handy. */
7478 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
7479 /* Casting avoids a GCC warning. */
7480 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
7482 /* Put the image into the pixmap, then free the X image and its buffer. */
7483 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
7484 x_destroy_x_image (ximg
);
7489 #else /* !HAVE_GIF */
7493 gif_load (struct frame
*f
, struct image
*img
)
7495 return ns_load_image (f
, img
,
7496 image_spec_value (img
->spec
, QCfile
, NULL
),
7497 image_spec_value (img
->spec
, QCdata
, NULL
));
7499 #endif /* HAVE_NS */
7501 #endif /* HAVE_GIF */
7504 /***********************************************************************
7506 ***********************************************************************/
7507 #if defined (HAVE_IMAGEMAGICK)
7509 static Lisp_Object Qimagemagick
;
7511 static int imagemagick_image_p (Lisp_Object
);
7512 static int imagemagick_load (struct frame
*, struct image
*);
7513 static void imagemagick_clear_image (struct frame
*, struct image
*);
7515 /* Indices of image specification fields in imagemagick_format. */
7517 enum imagemagick_keyword_index
7525 IMAGEMAGICK_ALGORITHM
,
7526 IMAGEMAGICK_HEURISTIC_MASK
,
7528 IMAGEMAGICK_BACKGROUND
,
7531 IMAGEMAGICK_ROTATION
,
7536 /* Vector of image_keyword structures describing the format
7537 of valid user-defined image specifications. */
7539 static struct image_keyword imagemagick_format
[IMAGEMAGICK_LAST
] =
7541 {":type", IMAGE_SYMBOL_VALUE
, 1},
7542 {":data", IMAGE_STRING_VALUE
, 0},
7543 {":file", IMAGE_STRING_VALUE
, 0},
7544 {":ascent", IMAGE_ASCENT_VALUE
, 0},
7545 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
7546 {":relief", IMAGE_INTEGER_VALUE
, 0},
7547 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7548 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7549 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7550 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0},
7551 {":height", IMAGE_INTEGER_VALUE
, 0},
7552 {":width", IMAGE_INTEGER_VALUE
, 0},
7553 {":rotation", IMAGE_NUMBER_VALUE
, 0},
7554 {":crop", IMAGE_DONT_CHECK_VALUE_TYPE
, 0}
7557 /* Structure describing the image type for any image handled via
7560 static struct image_type imagemagick_type
=
7563 imagemagick_image_p
,
7565 imagemagick_clear_image
,
7569 /* Free X resources of imagemagick image IMG which is used on frame F. */
7572 imagemagick_clear_image (struct frame
*f
,
7575 x_clear_image (f
, img
);
7578 /* Return non-zero if OBJECT is a valid IMAGEMAGICK image specification. Do
7579 this by calling parse_image_spec and supplying the keywords that
7580 identify the IMAGEMAGICK format. */
7583 imagemagick_image_p (Lisp_Object object
)
7585 struct image_keyword fmt
[IMAGEMAGICK_LAST
];
7586 memcpy (fmt
, imagemagick_format
, sizeof fmt
);
7588 if (!parse_image_spec (object
, fmt
, IMAGEMAGICK_LAST
, Qimagemagick
))
7591 /* Must specify either the :data or :file keyword. */
7592 return fmt
[IMAGEMAGICK_FILE
].count
+ fmt
[IMAGEMAGICK_DATA
].count
== 1;
7595 /* The GIF library also defines DrawRectangle, but its never used in Emacs.
7596 Therefore rename the function so it doesn't collide with ImageMagick. */
7597 #define DrawRectangle DrawRectangleGif
7598 #include <wand/MagickWand.h>
7600 /* ImageMagick 6.5.3 through 6.6.5 hid PixelGetMagickColor for some reason.
7601 Emacs seems to work fine with the hidden version, so unhide it. */
7602 #include <magick/version.h>
7603 #if 0x653 <= MagickLibVersion && MagickLibVersion <= 0x665
7604 extern WandExport
void PixelGetMagickColor (const PixelWand
*,
7605 MagickPixelPacket
*);
7608 /* Log ImageMagick error message.
7609 Useful when a ImageMagick function returns the status `MagickFalse'. */
7612 imagemagick_error (MagickWand
*wand
)
7615 ExceptionType severity
;
7617 description
= MagickGetException (wand
, &severity
);
7618 image_error ("ImageMagick error: %s",
7619 build_string (description
),
7621 description
= (char *) MagickRelinquishMemory (description
);
7624 /* Helper function for imagemagick_load, which does the actual loading
7625 given contents and size, apart from frame and image structures,
7626 passed from imagemagick_load. Uses librimagemagick to do most of
7627 the image processing.
7629 F is a pointer to the Emacs frame; IMG to the image structure to
7630 prepare; CONTENTS is the string containing the IMAGEMAGICK data to
7631 be parsed; SIZE is the number of bytes of data; and FILENAME is
7632 either the file name or the image data.
7634 Return non-zero if successful. */
7637 imagemagick_load_image (struct frame
*f
, struct image
*img
,
7638 unsigned char *contents
, unsigned int size
,
7641 size_t width
, height
;
7642 MagickBooleanType status
;
7645 MagickWand
*image_wand
;
7646 MagickWand
*ping_wand
;
7647 PixelIterator
*iterator
;
7648 PixelWand
**pixels
, *bg_wand
= NULL
;
7649 MagickPixelPacket pixel
;
7654 int desired_width
, desired_height
;
7658 /* Handle image index for image types who can contain more than one image.
7659 Interface :index is same as for GIF. First we "ping" the image to see how
7660 many sub-images it contains. Pinging is faster than loading the image to
7661 find out things about it. */
7663 /* Initialize the imagemagick environment. */
7664 MagickWandGenesis ();
7665 image
= image_spec_value (img
->spec
, QCindex
, NULL
);
7666 ino
= INTEGERP (image
) ? XFASTINT (image
) : 0;
7667 ping_wand
= NewMagickWand ();
7668 /* MagickSetResolution (ping_wand, 2, 2); (Bug#10112) */
7671 ? MagickPingImage (ping_wand
, filename
)
7672 : MagickPingImageBlob (ping_wand
, contents
, size
);
7674 if (status
== MagickFalse
)
7676 imagemagick_error (ping_wand
);
7677 DestroyMagickWand (ping_wand
);
7681 if (ino
< 0 || ino
>= MagickGetNumberImages (ping_wand
))
7683 image_error ("Invalid image number `%s' in image `%s'",
7685 DestroyMagickWand (ping_wand
);
7689 if (MagickGetNumberImages (ping_wand
) > 1)
7692 Fcons (make_number (MagickGetNumberImages (ping_wand
)),
7695 DestroyMagickWand (ping_wand
);
7697 /* Now we know how many images are inside the file. If it's not a
7698 bundle, the number is one. Load the image data. */
7700 image_wand
= NewMagickWand ();
7703 ? MagickReadImage (image_wand
, filename
)
7704 : MagickReadImageBlob (image_wand
, contents
, size
))
7707 imagemagick_error (image_wand
);
7708 goto imagemagick_error
;
7711 /* Retrieve the frame's background color, for use later. */
7714 Lisp_Object specified_bg
;
7716 specified_bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
7717 if (!STRINGP (specified_bg
)
7718 || !x_defined_color (f
, SSDATA (specified_bg
), &bgcolor
, 0))
7721 bgcolor
.pixel
= FRAME_BACKGROUND_PIXEL (f
);
7722 x_query_color (f
, &bgcolor
);
7724 ns_query_color (FRAME_BACKGROUND_COLOR (f
), &bgcolor
, 1);
7728 bg_wand
= NewPixelWand ();
7729 PixelSetRed (bg_wand
, (double) bgcolor
.red
/ 65535);
7730 PixelSetGreen (bg_wand
, (double) bgcolor
.green
/ 65535);
7731 PixelSetBlue (bg_wand
, (double) bgcolor
.blue
/ 65535);
7734 /* If width and/or height is set in the display spec assume we want
7735 to scale to those values. If either h or w is unspecified, the
7736 unspecified should be calculated from the specified to preserve
7738 value
= image_spec_value (img
->spec
, QCwidth
, NULL
);
7739 desired_width
= (INTEGERP (value
) ? XFASTINT (value
) : -1);
7740 value
= image_spec_value (img
->spec
, QCheight
, NULL
);
7741 desired_height
= (INTEGERP (value
) ? XFASTINT (value
) : -1);
7743 height
= MagickGetImageHeight (image_wand
);
7744 width
= MagickGetImageWidth (image_wand
);
7746 if (desired_width
!= -1 && desired_height
== -1)
7747 /* w known, calculate h. */
7748 desired_height
= (double) desired_width
/ width
* height
;
7749 if (desired_width
== -1 && desired_height
!= -1)
7750 /* h known, calculate w. */
7751 desired_width
= (double) desired_height
/ height
* width
;
7752 if (desired_width
!= -1 && desired_height
!= -1)
7754 status
= MagickScaleImage (image_wand
, desired_width
, desired_height
);
7755 if (status
== MagickFalse
)
7757 image_error ("Imagemagick scale failed", Qnil
, Qnil
);
7758 imagemagick_error (image_wand
);
7759 goto imagemagick_error
;
7763 /* crop behaves similar to image slicing in Emacs but is more memory
7765 crop
= image_spec_value (img
->spec
, QCcrop
, NULL
);
7767 if (CONSP (crop
) && TYPE_RANGED_INTEGERP (size_t, XCAR (crop
)))
7769 /* After some testing, it seems MagickCropImage is the fastest crop
7770 function in ImageMagick. This crop function seems to do less copying
7771 than the alternatives, but it still reads the entire image into memory
7772 before cropping, which is apparently difficult to avoid when using
7774 size_t crop_width
= XINT (XCAR (crop
));
7776 if (CONSP (crop
) && TYPE_RANGED_INTEGERP (size_t, XCAR (crop
)))
7778 size_t crop_height
= XINT (XCAR (crop
));
7780 if (CONSP (crop
) && TYPE_RANGED_INTEGERP (ssize_t
, XCAR (crop
)))
7782 ssize_t crop_x
= XINT (XCAR (crop
));
7784 if (CONSP (crop
) && TYPE_RANGED_INTEGERP (ssize_t
, XCAR (crop
)))
7786 ssize_t crop_y
= XINT (XCAR (crop
));
7787 MagickCropImage (image_wand
, crop_width
, crop_height
,
7794 /* Furthermore :rotation. we need background color and angle for
7797 TODO background handling for rotation specified_bg =
7798 image_spec_value (img->spec, QCbackground, NULL); if (!STRINGP
7800 value
= image_spec_value (img
->spec
, QCrotation
, NULL
);
7803 rotation
= extract_float (value
);
7804 status
= MagickRotateImage (image_wand
, bg_wand
, rotation
);
7805 if (status
== MagickFalse
)
7807 image_error ("Imagemagick image rotate failed", Qnil
, Qnil
);
7808 imagemagick_error (image_wand
);
7809 goto imagemagick_error
;
7813 /* Finally we are done manipulating the image. Figure out the
7814 resulting width/height and transfer ownership to Emacs. */
7815 height
= MagickGetImageHeight (image_wand
);
7816 width
= MagickGetImageWidth (image_wand
);
7818 /* Set the canvas background color to the frame or specified
7819 background, and flatten the image. Note: as of ImageMagick
7820 6.6.0, SVG image transparency is not handled properly
7821 (e.g. etc/images/splash.svg shows a white background always). */
7823 MagickWand
*new_wand
;
7824 MagickSetImageBackgroundColor (image_wand
, bg_wand
);
7825 #ifdef HAVE_MAGICKMERGEIMAGELAYERS
7826 new_wand
= MagickMergeImageLayers (image_wand
, MergeLayer
);
7828 new_wand
= MagickFlattenImages (image_wand
);
7830 DestroyMagickWand (image_wand
);
7831 image_wand
= new_wand
;
7834 if (! (width
<= INT_MAX
&& height
<= INT_MAX
7835 && check_image_size (f
, width
, height
)))
7837 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
7838 goto imagemagick_error
;
7841 /* We can now get a valid pixel buffer from the imagemagick file, if all
7844 init_color_table ();
7846 #ifdef HAVE_MAGICKEXPORTIMAGEPIXELS
7847 if (imagemagick_render_type
!= 0)
7849 /* Magicexportimage is normally faster than pixelpushing. This
7850 method is also well tested. Some aspects of this method are
7851 ad-hoc and needs to be more researched. */
7852 int imagedepth
= 24; /*MagickGetImageDepth(image_wand);*/
7853 const char *exportdepth
= imagedepth
<= 8 ? "I" : "BGRP"; /*"RGBP";*/
7854 /* Try to create a x pixmap to hold the imagemagick pixmap. */
7855 if (!x_create_x_image_and_pixmap (f
, width
, height
, imagedepth
,
7856 &ximg
, &img
->pixmap
))
7858 #ifdef COLOR_TABLE_SUPPORT
7859 free_color_table ();
7861 image_error ("Imagemagick X bitmap allocation failure", Qnil
, Qnil
);
7862 goto imagemagick_error
;
7865 /* Oddly, the below code doesn't seem to work:*/
7866 /* switch(ximg->bitmap_unit){ */
7868 /* pixelwidth=CharPixel; */
7871 /* pixelwidth=ShortPixel; */
7874 /* pixelwidth=LongPixel; */
7878 Here im just guessing the format of the bitmap.
7879 happens to work fine for:
7882 seems about 3 times as fast as pixel pushing(not carefully measured)
7884 pixelwidth
= CharPixel
; /*??? TODO figure out*/
7885 MagickExportImagePixels (image_wand
, 0, 0, width
, height
,
7886 exportdepth
, pixelwidth
, ximg
->data
);
7889 #endif /* HAVE_MAGICKEXPORTIMAGEPIXELS */
7891 size_t image_height
;
7893 /* Try to create a x pixmap to hold the imagemagick pixmap. */
7894 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0,
7895 &ximg
, &img
->pixmap
))
7897 #ifdef COLOR_TABLE_SUPPORT
7898 free_color_table ();
7900 image_error ("Imagemagick X bitmap allocation failure", Qnil
, Qnil
);
7901 goto imagemagick_error
;
7904 /* Copy imagemagick image to x with primitive yet robust pixel
7905 pusher loop. This has been tested a lot with many different
7908 /* Copy pixels from the imagemagick image structure to the x image map. */
7909 iterator
= NewPixelIterator (image_wand
);
7910 if (iterator
== (PixelIterator
*) NULL
)
7912 #ifdef COLOR_TABLE_SUPPORT
7913 free_color_table ();
7915 x_destroy_x_image (ximg
);
7916 image_error ("Imagemagick pixel iterator creation failed",
7918 goto imagemagick_error
;
7921 image_height
= MagickGetImageHeight (image_wand
);
7922 for (y
= 0; y
< image_height
; y
++)
7924 pixels
= PixelGetNextIteratorRow (iterator
, &width
);
7925 if (pixels
== (PixelWand
**) NULL
)
7927 for (x
= 0; x
< (long) width
; x
++)
7929 PixelGetMagickColor (pixels
[x
], &pixel
);
7930 XPutPixel (ximg
, x
, y
,
7931 lookup_rgb_color (f
,
7937 DestroyPixelIterator (iterator
);
7940 #ifdef COLOR_TABLE_SUPPORT
7941 /* Remember colors allocated for this image. */
7942 img
->colors
= colors_in_color_table (&img
->ncolors
);
7943 free_color_table ();
7944 #endif /* COLOR_TABLE_SUPPORT */
7947 img
->height
= height
;
7949 /* Put the image into the pixmap, then free the X image and its
7951 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
7952 x_destroy_x_image (ximg
);
7954 /* Final cleanup. image_wand should be the only resource left. */
7955 DestroyMagickWand (image_wand
);
7956 if (bg_wand
) DestroyPixelWand (bg_wand
);
7958 /* `MagickWandTerminus' terminates the imagemagick environment. */
7959 MagickWandTerminus ();
7964 DestroyMagickWand (image_wand
);
7965 if (bg_wand
) DestroyPixelWand (bg_wand
);
7967 MagickWandTerminus ();
7968 /* TODO more cleanup. */
7969 image_error ("Error parsing IMAGEMAGICK image `%s'", img
->spec
, Qnil
);
7974 /* Load IMAGEMAGICK image IMG for use on frame F. Value is non-zero if
7975 successful. this function will go into the imagemagick_type structure, and
7976 the prototype thus needs to be compatible with that structure. */
7979 imagemagick_load (struct frame
*f
, struct image
*img
)
7982 Lisp_Object file_name
;
7984 /* If IMG->spec specifies a file name, create a non-file spec from it. */
7985 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
7986 if (STRINGP (file_name
))
7990 file
= x_find_image_file (file_name
);
7991 if (!STRINGP (file
))
7993 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
7996 success_p
= imagemagick_load_image (f
, img
, 0, 0, SSDATA (file
));
7998 /* Else its not a file, its a lisp object. Load the image from a
7999 lisp object rather than a file. */
8004 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
8005 if (!STRINGP (data
))
8007 image_error ("Invalid image data `%s'", data
, Qnil
);
8010 success_p
= imagemagick_load_image (f
, img
, SDATA (data
),
8011 SBYTES (data
), NULL
);
8017 DEFUN ("imagemagick-types", Fimagemagick_types
, Simagemagick_types
, 0, 0, 0,
8018 doc
: /* Return a list of image types supported by ImageMagick.
8019 Each entry in this list is a symbol named after an ImageMagick format
8020 tag. See the ImageMagick manual for a list of ImageMagick formats and
8021 their descriptions (http://www.imagemagick.org/script/formats.php).
8022 You can also try the shell command: `identify -list format'.
8024 Note that ImageMagick recognizes many file-types that Emacs does not
8025 recognize as images, such as C. See `imagemagick-types-enable'
8026 and `imagemagick-types-inhibit'. */)
8029 Lisp_Object typelist
= Qnil
;
8034 Lisp_Object Qimagemagicktype
;
8036 GetExceptionInfo(&ex
);
8037 imtypes
= GetMagickList ("*", &numf
, &ex
);
8038 DestroyExceptionInfo(&ex
);
8040 for (i
= 0; i
< numf
; i
++)
8042 Qimagemagicktype
= intern (imtypes
[i
]);
8043 typelist
= Fcons (Qimagemagicktype
, typelist
);
8045 return Fnreverse (typelist
);
8048 #endif /* defined (HAVE_IMAGEMAGICK) */
8052 /***********************************************************************
8054 ***********************************************************************/
8056 #if defined (HAVE_RSVG)
8058 /* Function prototypes. */
8060 static int svg_image_p (Lisp_Object object
);
8061 static int svg_load (struct frame
*f
, struct image
*img
);
8063 static int svg_load_image (struct frame
*, struct image
*,
8064 unsigned char *, ptrdiff_t);
8066 /* The symbol `svg' identifying images of this type. */
8068 static Lisp_Object Qsvg
;
8070 /* Indices of image specification fields in svg_format, below. */
8072 enum svg_keyword_index
8087 /* Vector of image_keyword structures describing the format
8088 of valid user-defined image specifications. */
8090 static const struct image_keyword svg_format
[SVG_LAST
] =
8092 {":type", IMAGE_SYMBOL_VALUE
, 1},
8093 {":data", IMAGE_STRING_VALUE
, 0},
8094 {":file", IMAGE_STRING_VALUE
, 0},
8095 {":ascent", IMAGE_ASCENT_VALUE
, 0},
8096 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
8097 {":relief", IMAGE_INTEGER_VALUE
, 0},
8098 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8099 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8100 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8101 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
8104 /* Structure describing the image type `svg'. Its the same type of
8105 structure defined for all image formats, handled by emacs image
8106 functions. See struct image_type in dispextern.h. */
8108 static struct image_type svg_type
=
8110 /* An identifier showing that this is an image structure for the SVG format. */
8112 /* Handle to a function that can be used to identify a SVG file. */
8114 /* Handle to function used to load a SVG file. */
8116 /* Handle to function to free sresources for SVG. */
8118 /* An internal field to link to the next image type in a list of
8119 image types, will be filled in when registering the format. */
8124 /* Return non-zero if OBJECT is a valid SVG image specification. Do
8125 this by calling parse_image_spec and supplying the keywords that
8126 identify the SVG format. */
8129 svg_image_p (Lisp_Object object
)
8131 struct image_keyword fmt
[SVG_LAST
];
8132 memcpy (fmt
, svg_format
, sizeof fmt
);
8134 if (!parse_image_spec (object
, fmt
, SVG_LAST
, Qsvg
))
8137 /* Must specify either the :data or :file keyword. */
8138 return fmt
[SVG_FILE
].count
+ fmt
[SVG_DATA
].count
== 1;
8141 #include <librsvg/rsvg.h>
8145 /* SVG library functions. */
8146 DEF_IMGLIB_FN (RsvgHandle
*, rsvg_handle_new
);
8147 DEF_IMGLIB_FN (void, rsvg_handle_get_dimensions
);
8148 DEF_IMGLIB_FN (gboolean
, rsvg_handle_write
);
8149 DEF_IMGLIB_FN (gboolean
, rsvg_handle_close
);
8150 DEF_IMGLIB_FN (GdkPixbuf
*, rsvg_handle_get_pixbuf
);
8152 DEF_IMGLIB_FN (int, gdk_pixbuf_get_width
);
8153 DEF_IMGLIB_FN (int, gdk_pixbuf_get_height
);
8154 DEF_IMGLIB_FN (guchar
*, gdk_pixbuf_get_pixels
);
8155 DEF_IMGLIB_FN (int, gdk_pixbuf_get_rowstride
);
8156 DEF_IMGLIB_FN (GdkColorspace
, gdk_pixbuf_get_colorspace
);
8157 DEF_IMGLIB_FN (int, gdk_pixbuf_get_n_channels
);
8158 DEF_IMGLIB_FN (gboolean
, gdk_pixbuf_get_has_alpha
);
8159 DEF_IMGLIB_FN (int, gdk_pixbuf_get_bits_per_sample
);
8161 DEF_IMGLIB_FN (void, g_type_init
);
8162 DEF_IMGLIB_FN (void, g_object_unref
);
8163 DEF_IMGLIB_FN (void, g_error_free
);
8165 Lisp_Object Qgdk_pixbuf
, Qglib
, Qgobject
;
8168 init_svg_functions (Lisp_Object libraries
)
8170 HMODULE library
, gdklib
, glib
, gobject
;
8172 if (!(glib
= w32_delayed_load (libraries
, Qglib
))
8173 || !(gobject
= w32_delayed_load (libraries
, Qgobject
))
8174 || !(gdklib
= w32_delayed_load (libraries
, Qgdk_pixbuf
))
8175 || !(library
= w32_delayed_load (libraries
, Qsvg
)))
8178 LOAD_IMGLIB_FN (library
, rsvg_handle_new
);
8179 LOAD_IMGLIB_FN (library
, rsvg_handle_get_dimensions
);
8180 LOAD_IMGLIB_FN (library
, rsvg_handle_write
);
8181 LOAD_IMGLIB_FN (library
, rsvg_handle_close
);
8182 LOAD_IMGLIB_FN (library
, rsvg_handle_get_pixbuf
);
8184 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_width
);
8185 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_height
);
8186 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_pixels
);
8187 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_rowstride
);
8188 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_colorspace
);
8189 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_n_channels
);
8190 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_has_alpha
);
8191 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_bits_per_sample
);
8193 LOAD_IMGLIB_FN (gobject
, g_type_init
);
8194 LOAD_IMGLIB_FN (gobject
, g_object_unref
);
8195 LOAD_IMGLIB_FN (glib
, g_error_free
);
8201 /* The following aliases for library functions allow dynamic loading
8202 to be used on some platforms. */
8203 #define fn_rsvg_handle_new rsvg_handle_new
8204 #define fn_rsvg_handle_get_dimensions rsvg_handle_get_dimensions
8205 #define fn_rsvg_handle_write rsvg_handle_write
8206 #define fn_rsvg_handle_close rsvg_handle_close
8207 #define fn_rsvg_handle_get_pixbuf rsvg_handle_get_pixbuf
8209 #define fn_gdk_pixbuf_get_width gdk_pixbuf_get_width
8210 #define fn_gdk_pixbuf_get_height gdk_pixbuf_get_height
8211 #define fn_gdk_pixbuf_get_pixels gdk_pixbuf_get_pixels
8212 #define fn_gdk_pixbuf_get_rowstride gdk_pixbuf_get_rowstride
8213 #define fn_gdk_pixbuf_get_colorspace gdk_pixbuf_get_colorspace
8214 #define fn_gdk_pixbuf_get_n_channels gdk_pixbuf_get_n_channels
8215 #define fn_gdk_pixbuf_get_has_alpha gdk_pixbuf_get_has_alpha
8216 #define fn_gdk_pixbuf_get_bits_per_sample gdk_pixbuf_get_bits_per_sample
8218 #define fn_g_type_init g_type_init
8219 #define fn_g_object_unref g_object_unref
8220 #define fn_g_error_free g_error_free
8221 #endif /* !HAVE_NTGUI */
8223 /* Load SVG image IMG for use on frame F. Value is non-zero if
8224 successful. this function will go into the svg_type structure, and
8225 the prototype thus needs to be compatible with that structure. */
8228 svg_load (struct frame
*f
, struct image
*img
)
8231 Lisp_Object file_name
;
8233 /* If IMG->spec specifies a file name, create a non-file spec from it. */
8234 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
8235 if (STRINGP (file_name
))
8238 unsigned char *contents
;
8241 file
= x_find_image_file (file_name
);
8242 if (!STRINGP (file
))
8244 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
8248 /* Read the entire file into memory. */
8249 contents
= slurp_file (SSDATA (file
), &size
);
8250 if (contents
== NULL
)
8252 image_error ("Error loading SVG image `%s'", img
->spec
, Qnil
);
8255 /* If the file was slurped into memory properly, parse it. */
8256 success_p
= svg_load_image (f
, img
, contents
, size
);
8259 /* Else its not a file, its a lisp object. Load the image from a
8260 lisp object rather than a file. */
8265 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
8266 if (!STRINGP (data
))
8268 image_error ("Invalid image data `%s'", data
, Qnil
);
8271 success_p
= svg_load_image (f
, img
, SDATA (data
), SBYTES (data
));
8277 /* svg_load_image is a helper function for svg_load, which does the
8278 actual loading given contents and size, apart from frame and image
8279 structures, passed from svg_load.
8281 Uses librsvg to do most of the image processing.
8283 Returns non-zero when successful. */
8285 svg_load_image (struct frame
*f
, /* Pointer to emacs frame structure. */
8286 struct image
*img
, /* Pointer to emacs image structure. */
8287 unsigned char *contents
, /* String containing the SVG XML data to be parsed. */
8288 ptrdiff_t size
) /* Size of data in bytes. */
8290 RsvgHandle
*rsvg_handle
;
8291 RsvgDimensionData dimension_data
;
8296 const guint8
*pixels
;
8299 Lisp_Object specified_bg
;
8304 /* g_type_init is a glib function that must be called prior to using
8305 gnome type library functions. */
8307 /* Make a handle to a new rsvg object. */
8308 rsvg_handle
= fn_rsvg_handle_new ();
8310 /* Parse the contents argument and fill in the rsvg_handle. */
8311 fn_rsvg_handle_write (rsvg_handle
, contents
, size
, &err
);
8312 if (err
) goto rsvg_error
;
8314 /* The parsing is complete, rsvg_handle is ready to used, close it
8315 for further writes. */
8316 fn_rsvg_handle_close (rsvg_handle
, &err
);
8317 if (err
) goto rsvg_error
;
8319 fn_rsvg_handle_get_dimensions (rsvg_handle
, &dimension_data
);
8320 if (! check_image_size (f
, dimension_data
.width
, dimension_data
.height
))
8322 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
8326 /* We can now get a valid pixel buffer from the svg file, if all
8328 pixbuf
= fn_rsvg_handle_get_pixbuf (rsvg_handle
);
8329 if (!pixbuf
) goto rsvg_error
;
8330 fn_g_object_unref (rsvg_handle
);
8332 /* Extract some meta data from the svg handle. */
8333 width
= fn_gdk_pixbuf_get_width (pixbuf
);
8334 height
= fn_gdk_pixbuf_get_height (pixbuf
);
8335 pixels
= fn_gdk_pixbuf_get_pixels (pixbuf
);
8336 rowstride
= fn_gdk_pixbuf_get_rowstride (pixbuf
);
8338 /* Validate the svg meta data. */
8339 eassert (fn_gdk_pixbuf_get_colorspace (pixbuf
) == GDK_COLORSPACE_RGB
);
8340 eassert (fn_gdk_pixbuf_get_n_channels (pixbuf
) == 4);
8341 eassert (fn_gdk_pixbuf_get_has_alpha (pixbuf
));
8342 eassert (fn_gdk_pixbuf_get_bits_per_sample (pixbuf
) == 8);
8344 /* Try to create a x pixmap to hold the svg pixmap. */
8345 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0, &ximg
, &img
->pixmap
))
8347 fn_g_object_unref (pixbuf
);
8351 init_color_table ();
8353 /* Handle alpha channel by combining the image with a background
8355 specified_bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
8356 if (!STRINGP (specified_bg
)
8357 || !x_defined_color (f
, SSDATA (specified_bg
), &background
, 0))
8360 background
.pixel
= FRAME_BACKGROUND_PIXEL (f
);
8361 x_query_color (f
, &background
);
8363 ns_query_color (FRAME_BACKGROUND_COLOR (f
), &background
, 1);
8367 /* SVG pixmaps specify transparency in the last byte, so right
8368 shift 8 bits to get rid of it, since emacs doesn't support
8370 background
.red
>>= 8;
8371 background
.green
>>= 8;
8372 background
.blue
>>= 8;
8374 /* This loop handles opacity values, since Emacs assumes
8375 non-transparent images. Each pixel must be "flattened" by
8376 calculating the resulting color, given the transparency of the
8377 pixel, and the image background color. */
8378 for (y
= 0; y
< height
; ++y
)
8380 for (x
= 0; x
< width
; ++x
)
8390 opacity
= *pixels
++;
8392 red
= ((red
* opacity
)
8393 + (background
.red
* ((1 << 8) - opacity
)));
8394 green
= ((green
* opacity
)
8395 + (background
.green
* ((1 << 8) - opacity
)));
8396 blue
= ((blue
* opacity
)
8397 + (background
.blue
* ((1 << 8) - opacity
)));
8399 XPutPixel (ximg
, x
, y
, lookup_rgb_color (f
, red
, green
, blue
));
8402 pixels
+= rowstride
- 4 * width
;
8405 #ifdef COLOR_TABLE_SUPPORT
8406 /* Remember colors allocated for this image. */
8407 img
->colors
= colors_in_color_table (&img
->ncolors
);
8408 free_color_table ();
8409 #endif /* COLOR_TABLE_SUPPORT */
8411 fn_g_object_unref (pixbuf
);
8414 img
->height
= height
;
8416 /* Maybe fill in the background field while we have ximg handy.
8417 Casting avoids a GCC warning. */
8418 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
8420 /* Put the image into the pixmap, then free the X image and its
8422 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
8423 x_destroy_x_image (ximg
);
8428 fn_g_object_unref (rsvg_handle
);
8429 /* FIXME: Use error->message so the user knows what is the actual
8430 problem with the image. */
8431 image_error ("Error parsing SVG image `%s'", img
->spec
, Qnil
);
8432 fn_g_error_free (err
);
8436 #endif /* defined (HAVE_RSVG) */
8441 /***********************************************************************
8443 ***********************************************************************/
8445 #ifdef HAVE_X_WINDOWS
8446 #define HAVE_GHOSTSCRIPT 1
8447 #endif /* HAVE_X_WINDOWS */
8449 #ifdef HAVE_GHOSTSCRIPT
8451 static int gs_image_p (Lisp_Object object
);
8452 static int gs_load (struct frame
*f
, struct image
*img
);
8453 static void gs_clear_image (struct frame
*f
, struct image
*img
);
8455 /* Keyword symbols. */
8457 static Lisp_Object QCloader
, QCbounding_box
, QCpt_width
, QCpt_height
;
8459 /* Indices of image specification fields in gs_format, below. */
8461 enum gs_keyword_index
8479 /* Vector of image_keyword structures describing the format
8480 of valid user-defined image specifications. */
8482 static const struct image_keyword gs_format
[GS_LAST
] =
8484 {":type", IMAGE_SYMBOL_VALUE
, 1},
8485 {":pt-width", IMAGE_POSITIVE_INTEGER_VALUE
, 1},
8486 {":pt-height", IMAGE_POSITIVE_INTEGER_VALUE
, 1},
8487 {":file", IMAGE_STRING_VALUE
, 1},
8488 {":loader", IMAGE_FUNCTION_VALUE
, 0},
8489 {":bounding-box", IMAGE_DONT_CHECK_VALUE_TYPE
, 1},
8490 {":ascent", IMAGE_ASCENT_VALUE
, 0},
8491 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
8492 {":relief", IMAGE_INTEGER_VALUE
, 0},
8493 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8494 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8495 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8496 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
8499 /* Structure describing the image type `ghostscript'. */
8501 static struct image_type gs_type
=
8511 /* Free X resources of Ghostscript image IMG which is used on frame F. */
8514 gs_clear_image (struct frame
*f
, struct image
*img
)
8516 x_clear_image (f
, img
);
8520 /* Return non-zero if OBJECT is a valid Ghostscript image
8524 gs_image_p (Lisp_Object object
)
8526 struct image_keyword fmt
[GS_LAST
];
8530 memcpy (fmt
, gs_format
, sizeof fmt
);
8532 if (!parse_image_spec (object
, fmt
, GS_LAST
, Qpostscript
))
8535 /* Bounding box must be a list or vector containing 4 integers. */
8536 tem
= fmt
[GS_BOUNDING_BOX
].value
;
8539 for (i
= 0; i
< 4; ++i
, tem
= XCDR (tem
))
8540 if (!CONSP (tem
) || !INTEGERP (XCAR (tem
)))
8545 else if (VECTORP (tem
))
8547 if (ASIZE (tem
) != 4)
8549 for (i
= 0; i
< 4; ++i
)
8550 if (!INTEGERP (AREF (tem
, i
)))
8560 /* Load Ghostscript image IMG for use on frame F. Value is non-zero
8564 gs_load (struct frame
*f
, struct image
*img
)
8566 uprintmax_t printnum1
, printnum2
;
8567 char buffer
[sizeof " " + INT_STRLEN_BOUND (printmax_t
)];
8568 Lisp_Object window_and_pixmap_id
= Qnil
, loader
, pt_height
, pt_width
;
8570 double in_width
, in_height
;
8571 Lisp_Object pixel_colors
= Qnil
;
8573 /* Compute pixel size of pixmap needed from the given size in the
8574 image specification. Sizes in the specification are in pt. 1 pt
8575 = 1/72 in, xdpi and ydpi are stored in the frame's X display
8577 pt_width
= image_spec_value (img
->spec
, QCpt_width
, NULL
);
8578 in_width
= INTEGERP (pt_width
) ? XFASTINT (pt_width
) / 72.0 : 0;
8579 in_width
*= FRAME_X_DISPLAY_INFO (f
)->resx
;
8580 pt_height
= image_spec_value (img
->spec
, QCpt_height
, NULL
);
8581 in_height
= INTEGERP (pt_height
) ? XFASTINT (pt_height
) / 72.0 : 0;
8582 in_height
*= FRAME_X_DISPLAY_INFO (f
)->resy
;
8584 if (! (in_width
<= INT_MAX
&& in_height
<= INT_MAX
8585 && check_image_size (f
, in_width
, in_height
)))
8587 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
8590 img
->width
= in_width
;
8591 img
->height
= in_height
;
8593 /* Create the pixmap. */
8594 eassert (img
->pixmap
== NO_PIXMAP
);
8596 if (x_check_image_size (0, img
->width
, img
->height
))
8598 /* Only W32 version did BLOCK_INPUT here. ++kfs */
8600 img
->pixmap
= XCreatePixmap (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
8601 img
->width
, img
->height
,
8602 DefaultDepthOfScreen (FRAME_X_SCREEN (f
)));
8608 image_error ("Unable to create pixmap for `%s'", img
->spec
, Qnil
);
8612 /* Call the loader to fill the pixmap. It returns a process object
8613 if successful. We do not record_unwind_protect here because
8614 other places in redisplay like calling window scroll functions
8615 don't either. Let the Lisp loader use `unwind-protect' instead. */
8616 printnum1
= FRAME_X_WINDOW (f
);
8617 printnum2
= img
->pixmap
;
8618 window_and_pixmap_id
8619 = make_formatted_string (buffer
, "%"pMu
" %"pMu
, printnum1
, printnum2
);
8621 printnum1
= FRAME_FOREGROUND_PIXEL (f
);
8622 printnum2
= FRAME_BACKGROUND_PIXEL (f
);
8624 = make_formatted_string (buffer
, "%"pMu
" %"pMu
, printnum1
, printnum2
);
8626 XSETFRAME (frame
, f
);
8627 loader
= image_spec_value (img
->spec
, QCloader
, NULL
);
8629 loader
= intern ("gs-load-image");
8631 img
->lisp_data
= call6 (loader
, frame
, img
->spec
,
8632 make_number (img
->width
),
8633 make_number (img
->height
),
8634 window_and_pixmap_id
,
8636 return PROCESSP (img
->lisp_data
);
8640 /* Kill the Ghostscript process that was started to fill PIXMAP on
8641 frame F. Called from XTread_socket when receiving an event
8642 telling Emacs that Ghostscript has finished drawing. */
8645 x_kill_gs_process (Pixmap pixmap
, struct frame
*f
)
8647 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
8652 /* Find the image containing PIXMAP. */
8653 for (i
= 0; i
< c
->used
; ++i
)
8654 if (c
->images
[i
]->pixmap
== pixmap
)
8657 /* Should someone in between have cleared the image cache, for
8658 instance, give up. */
8662 /* Kill the GS process. We should have found PIXMAP in the image
8663 cache and its image should contain a process object. */
8665 eassert (PROCESSP (img
->lisp_data
));
8666 Fkill_process (img
->lisp_data
, Qnil
);
8667 img
->lisp_data
= Qnil
;
8669 #if defined (HAVE_X_WINDOWS)
8671 /* On displays with a mutable colormap, figure out the colors
8672 allocated for the image by looking at the pixels of an XImage for
8674 class = FRAME_X_VISUAL (f
)->class;
8675 if (class != StaticColor
&& class != StaticGray
&& class != TrueColor
)
8681 /* Try to get an XImage for img->pixmep. */
8682 ximg
= XGetImage (FRAME_X_DISPLAY (f
), img
->pixmap
,
8683 0, 0, img
->width
, img
->height
, ~0, ZPixmap
);
8688 /* Initialize the color table. */
8689 init_color_table ();
8691 /* For each pixel of the image, look its color up in the
8692 color table. After having done so, the color table will
8693 contain an entry for each color used by the image. */
8694 for (y
= 0; y
< img
->height
; ++y
)
8695 for (x
= 0; x
< img
->width
; ++x
)
8697 unsigned long pixel
= XGetPixel (ximg
, x
, y
);
8698 lookup_pixel_color (f
, pixel
);
8701 /* Record colors in the image. Free color table and XImage. */
8702 #ifdef COLOR_TABLE_SUPPORT
8703 img
->colors
= colors_in_color_table (&img
->ncolors
);
8704 free_color_table ();
8706 XDestroyImage (ximg
);
8708 #if 0 /* This doesn't seem to be the case. If we free the colors
8709 here, we get a BadAccess later in x_clear_image when
8710 freeing the colors. */
8711 /* We have allocated colors once, but Ghostscript has also
8712 allocated colors on behalf of us. So, to get the
8713 reference counts right, free them once. */
8715 x_free_colors (f
, img
->colors
, img
->ncolors
);
8719 image_error ("Cannot get X image of `%s'; colors will not be freed",
8724 #endif /* HAVE_X_WINDOWS */
8726 /* Now that we have the pixmap, compute mask and transform the
8727 image if requested. */
8729 postprocess_image (f
, img
);
8733 #endif /* HAVE_GHOSTSCRIPT */
8736 /***********************************************************************
8738 ***********************************************************************/
8742 DEFUN ("imagep", Fimagep
, Simagep
, 1, 1, 0,
8743 doc
: /* Value is non-nil if SPEC is a valid image specification. */)
8746 return valid_image_p (spec
) ? Qt
: Qnil
;
8750 DEFUN ("lookup-image", Flookup_image
, Slookup_image
, 1, 1, 0, "")
8755 if (valid_image_p (spec
))
8756 id
= lookup_image (SELECTED_FRAME (), spec
);
8759 return make_number (id
);
8762 #endif /* GLYPH_DEBUG */
8765 /***********************************************************************
8767 ***********************************************************************/
8770 /* Image types that rely on external libraries are loaded dynamically
8771 if the library is available. */
8772 #define CHECK_LIB_AVAILABLE(image_type, init_lib_fn, libraries) \
8773 define_image_type (image_type, init_lib_fn (libraries))
8775 #define CHECK_LIB_AVAILABLE(image_type, init_lib_fn, libraries) \
8776 define_image_type (image_type, 1)
8777 #endif /* HAVE_NTGUI */
8779 DEFUN ("init-image-library", Finit_image_library
, Sinit_image_library
, 2, 2, 0,
8780 doc
: /* Initialize image library implementing image type TYPE.
8781 Return non-nil if TYPE is a supported image type.
8783 Image types pbm and xbm are prebuilt; other types are loaded here.
8784 Libraries to load are specified in alist LIBRARIES (usually, the value
8785 of `dynamic-library-alist', which see). */)
8786 (Lisp_Object type
, Lisp_Object libraries
)
8789 /* Don't try to reload the library. */
8790 Lisp_Object tested
= Fassq (type
, Vlibrary_cache
);
8792 return XCDR (tested
);
8795 /* Types pbm and xbm are built-in and always available. */
8796 if (EQ (type
, Qpbm
) || EQ (type
, Qxbm
))
8799 #if defined (HAVE_XPM) || defined (HAVE_NS)
8800 if (EQ (type
, Qxpm
))
8801 return CHECK_LIB_AVAILABLE (&xpm_type
, init_xpm_functions
, libraries
);
8804 #if defined (HAVE_JPEG) || defined (HAVE_NS)
8805 if (EQ (type
, Qjpeg
))
8806 return CHECK_LIB_AVAILABLE (&jpeg_type
, init_jpeg_functions
, libraries
);
8809 #if defined (HAVE_TIFF) || defined (HAVE_NS)
8810 if (EQ (type
, Qtiff
))
8811 return CHECK_LIB_AVAILABLE (&tiff_type
, init_tiff_functions
, libraries
);
8814 #if defined (HAVE_GIF) || defined (HAVE_NS)
8815 if (EQ (type
, Qgif
))
8816 return CHECK_LIB_AVAILABLE (&gif_type
, init_gif_functions
, libraries
);
8819 #if defined (HAVE_PNG) || defined (HAVE_NS)
8820 if (EQ (type
, Qpng
))
8821 return CHECK_LIB_AVAILABLE (&png_type
, init_png_functions
, libraries
);
8824 #if defined (HAVE_RSVG)
8825 if (EQ (type
, Qsvg
))
8826 return CHECK_LIB_AVAILABLE (&svg_type
, init_svg_functions
, libraries
);
8829 #if defined (HAVE_IMAGEMAGICK)
8830 if (EQ (type
, Qimagemagick
))
8831 return CHECK_LIB_AVAILABLE (&imagemagick_type
, init_imagemagick_functions
,
8835 #ifdef HAVE_GHOSTSCRIPT
8836 if (EQ (type
, Qpostscript
))
8837 return CHECK_LIB_AVAILABLE (&gs_type
, init_gs_functions
, libraries
);
8840 /* If the type is not recognized, avoid testing it ever again. */
8841 CACHE_IMAGE_TYPE (type
, Qnil
);
8846 syms_of_image (void)
8848 /* Initialize this only once, since that's what we do with Vimage_types
8849 and they are supposed to be in sync. Initializing here gives correct
8850 operation on GNU/Linux of calling dump-emacs after loading some images. */
8853 /* Must be defined now because we're going to update it below, while
8854 defining the supported image types. */
8855 DEFVAR_LISP ("image-types", Vimage_types
,
8856 doc
: /* List of potentially supported image types.
8857 Each element of the list is a symbol for an image type, like 'jpeg or 'png.
8858 To check whether it is really supported, use `image-type-available-p'. */);
8859 Vimage_types
= Qnil
;
8861 DEFVAR_LISP ("max-image-size", Vmax_image_size
,
8862 doc
: /* Maximum size of images.
8863 Emacs will not load an image into memory if its pixel width or
8864 pixel height exceeds this limit.
8866 If the value is an integer, it directly specifies the maximum
8867 image height and width, measured in pixels. If it is a floating
8868 point number, it specifies the maximum image height and width
8869 as a ratio to the frame height and width. If the value is
8870 non-numeric, there is no explicit limit on the size of images. */);
8871 Vmax_image_size
= make_float (MAX_IMAGE_SIZE
);
8873 DEFSYM (Qpbm
, "pbm");
8874 ADD_IMAGE_TYPE (Qpbm
);
8876 DEFSYM (Qxbm
, "xbm");
8877 ADD_IMAGE_TYPE (Qxbm
);
8879 define_image_type (&xbm_type
, 1);
8880 define_image_type (&pbm_type
, 1);
8882 DEFSYM (Qcount
, "count");
8883 DEFSYM (Qextension_data
, "extension-data");
8884 DEFSYM (Qdelay
, "delay");
8886 DEFSYM (QCascent
, ":ascent");
8887 DEFSYM (QCmargin
, ":margin");
8888 DEFSYM (QCrelief
, ":relief");
8889 DEFSYM (QCconversion
, ":conversion");
8890 DEFSYM (QCcolor_symbols
, ":color-symbols");
8891 DEFSYM (QCheuristic_mask
, ":heuristic-mask");
8892 DEFSYM (QCindex
, ":index");
8893 DEFSYM (QCgeometry
, ":geometry");
8894 DEFSYM (QCcrop
, ":crop");
8895 DEFSYM (QCrotation
, ":rotation");
8896 DEFSYM (QCmatrix
, ":matrix");
8897 DEFSYM (QCcolor_adjustment
, ":color-adjustment");
8898 DEFSYM (QCmask
, ":mask");
8900 DEFSYM (Qlaplace
, "laplace");
8901 DEFSYM (Qemboss
, "emboss");
8902 DEFSYM (Qedge_detection
, "edge-detection");
8903 DEFSYM (Qheuristic
, "heuristic");
8905 DEFSYM (Qpostscript
, "postscript");
8906 #ifdef HAVE_GHOSTSCRIPT
8907 ADD_IMAGE_TYPE (Qpostscript
);
8908 DEFSYM (QCloader
, ":loader");
8909 DEFSYM (QCbounding_box
, ":bounding-box");
8910 DEFSYM (QCpt_width
, ":pt-width");
8911 DEFSYM (QCpt_height
, ":pt-height");
8912 #endif /* HAVE_GHOSTSCRIPT */
8915 DEFSYM (Qlibpng_version
, "libpng-version");
8916 Fset (Qlibpng_version
,
8918 make_number (PNG_LIBPNG_VER
)
8925 #if defined (HAVE_XPM) || defined (HAVE_NS)
8926 DEFSYM (Qxpm
, "xpm");
8927 ADD_IMAGE_TYPE (Qxpm
);
8930 #if defined (HAVE_JPEG) || defined (HAVE_NS)
8931 DEFSYM (Qjpeg
, "jpeg");
8932 ADD_IMAGE_TYPE (Qjpeg
);
8935 #if defined (HAVE_TIFF) || defined (HAVE_NS)
8936 DEFSYM (Qtiff
, "tiff");
8937 ADD_IMAGE_TYPE (Qtiff
);
8940 #if defined (HAVE_GIF) || defined (HAVE_NS)
8941 DEFSYM (Qgif
, "gif");
8942 ADD_IMAGE_TYPE (Qgif
);
8945 #if defined (HAVE_PNG) || defined (HAVE_NS)
8946 DEFSYM (Qpng
, "png");
8947 ADD_IMAGE_TYPE (Qpng
);
8950 #if defined (HAVE_IMAGEMAGICK)
8951 DEFSYM (Qimagemagick
, "imagemagick");
8952 ADD_IMAGE_TYPE (Qimagemagick
);
8955 #if defined (HAVE_RSVG)
8956 DEFSYM (Qsvg
, "svg");
8957 ADD_IMAGE_TYPE (Qsvg
);
8959 /* Other libraries used directly by svg code. */
8960 DEFSYM (Qgdk_pixbuf
, "gdk-pixbuf");
8961 DEFSYM (Qglib
, "glib");
8962 DEFSYM (Qgobject
, "gobject");
8963 #endif /* HAVE_NTGUI */
8964 #endif /* HAVE_RSVG */
8966 defsubr (&Sinit_image_library
);
8967 #ifdef HAVE_IMAGEMAGICK
8968 defsubr (&Simagemagick_types
);
8970 defsubr (&Sclear_image_cache
);
8971 defsubr (&Simage_flush
);
8972 defsubr (&Simage_size
);
8973 defsubr (&Simage_mask_p
);
8974 defsubr (&Simage_metadata
);
8978 defsubr (&Slookup_image
);
8981 DEFVAR_BOOL ("cross-disabled-images", cross_disabled_images
,
8982 doc
: /* Non-nil means always draw a cross over disabled images.
8983 Disabled images are those having a `:conversion disabled' property.
8984 A cross is always drawn on black & white displays. */);
8985 cross_disabled_images
= 0;
8987 DEFVAR_LISP ("x-bitmap-file-path", Vx_bitmap_file_path
,
8988 doc
: /* List of directories to search for window system bitmap files. */);
8989 Vx_bitmap_file_path
= decode_env_path ((char *) 0, PATH_BITMAPS
);
8991 DEFVAR_LISP ("image-cache-eviction-delay", Vimage_cache_eviction_delay
,
8992 doc
: /* Maximum time after which images are removed from the cache.
8993 When an image has not been displayed this many seconds, Emacs
8994 automatically removes it from the image cache. If the cache contains
8995 a large number of images, the actual eviction time may be shorter.
8996 The value can also be nil, meaning the cache is never cleared.
8998 The function `clear-image-cache' disregards this variable. */);
8999 Vimage_cache_eviction_delay
= make_number (300);
9000 #ifdef HAVE_IMAGEMAGICK
9001 DEFVAR_INT ("imagemagick-render-type", imagemagick_render_type
,
9002 doc
: /* Integer indicating which ImageMagick rendering method to use.
9004 0 -- the default method (pixel pushing)
9005 1 -- a newer method ("MagickExportImagePixels") that may perform
9006 better (speed etc) in some cases, but has not been as thoroughly
9007 tested with Emacs as the default method. This method requires
9008 ImageMagick version 6.4.6 (approximately) or later.
9010 /* MagickExportImagePixels is in 6.4.6-9, but not 6.4.4-10. */
9011 imagemagick_render_type
= 0;