1 /* Functions for image support on window system.
2 Copyright (C) 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
3 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
31 #if defined HAVE_LIBPNG_PNG_H
32 # include <libpng/png.h>
40 /* This makes the fields of a Display accessible, in Xlib header files. */
42 #define XLIB_ILLEGAL_ACCESS
47 #include "dispextern.h"
48 #include "blockinput.h"
51 #include "character.h"
53 #include "termhooks.h"
58 #include <sys/types.h>
61 #define COLOR_TABLE_SUPPORT 1
63 typedef struct x_bitmap_record Bitmap_Record
;
64 #define GET_PIXEL(ximg, x, y) XGetPixel(ximg, x, y)
65 #define NO_PIXMAP None
67 #define RGB_PIXEL_COLOR unsigned long
69 #define PIX_MASK_RETAIN 0
70 #define PIX_MASK_DRAW 1
71 #endif /* HAVE_X_WINDOWS */
77 /* W32_TODO : Color tables on W32. */
78 #undef COLOR_TABLE_SUPPORT
80 typedef struct w32_bitmap_record Bitmap_Record
;
81 #define GET_PIXEL(ximg, x, y) GetPixel(ximg, x, y)
84 #define RGB_PIXEL_COLOR COLORREF
86 #define PIX_MASK_RETAIN 0
87 #define PIX_MASK_DRAW 1
89 #define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
90 #define x_defined_color w32_defined_color
91 #define DefaultDepthOfScreen(screen) (one_w32_display_info.n_cbits)
93 /* Functions from w32term.c that depend on XColor (so can't go in w32term.h
94 without modifying lots of files). */
95 extern void x_query_colors (struct frame
*f
, XColor
*colors
, int ncolors
);
96 extern void x_query_color (struct frame
*f
, XColor
*color
);
97 #endif /* HAVE_NTGUI */
101 #include <sys/types.h>
102 #include <sys/stat.h>
104 #undef COLOR_TABLE_SUPPORT
106 typedef struct ns_bitmap_record Bitmap_Record
;
108 #define GET_PIXEL(ximg, x, y) XGetPixel(ximg, x, y)
111 #define RGB_PIXEL_COLOR unsigned long
114 #define PIX_MASK_RETAIN 0
115 #define PIX_MASK_DRAW 1
117 #define FRAME_X_VISUAL FRAME_NS_DISPLAY_INFO(f)->visual
118 #define x_defined_color(f, name, color_def, alloc) \
119 ns_defined_color (f, name, color_def, alloc, 0)
120 #define FRAME_X_SCREEN(f) 0
121 #define DefaultDepthOfScreen(screen) x_display_list->n_planes
125 /* Search path for bitmap files. */
127 Lisp_Object Vx_bitmap_file_path
;
129 /* The symbol `postscript' identifying images of this type. */
131 Lisp_Object Qpostscript
;
133 static void x_disable_image (struct frame
*, struct image
*);
134 static void x_edge_detection (struct frame
*, struct image
*, Lisp_Object
,
137 static void init_color_table (void);
138 static unsigned long lookup_rgb_color (struct frame
*f
, int r
, int g
, int b
);
139 #ifdef COLOR_TABLE_SUPPORT
140 static void free_color_table (void);
141 static unsigned long *colors_in_color_table (int *n
);
142 static unsigned long lookup_pixel_color (struct frame
*f
, unsigned long p
);
145 /* Code to deal with bitmaps. Bitmaps are referenced by their bitmap
146 id, which is just an int that this section returns. Bitmaps are
147 reference counted so they can be shared among frames.
149 Bitmap indices are guaranteed to be > 0, so a negative number can
150 be used to indicate no bitmap.
152 If you use x_create_bitmap_from_data, then you must keep track of
153 the bitmaps yourself. That is, creating a bitmap from the same
154 data more than once will not be caught. */
158 XGetImage (Display
*display
, Pixmap pixmap
, int x
, int y
,
159 unsigned int width
, unsigned int height
,
160 unsigned long plane_mask
, int format
)
162 /* TODO: not sure what this function is supposed to do.. */
163 ns_retain_object (pixmap
);
167 /* use with imgs created by ns_image_for_XPM */
169 XGetPixel (XImagePtr ximage
, int x
, int y
)
171 return ns_get_pixel (ximage
, x
, y
);
174 /* use with imgs created by ns_image_for_XPM; alpha set to 1;
175 pixel is assumed to be in form RGB */
177 XPutPixel (XImagePtr ximage
, int x
, int y
, unsigned long pixel
)
179 ns_put_pixel (ximage
, x
, y
, pixel
);
184 /* Functions to access the contents of a bitmap, given an id. */
187 x_bitmap_height (FRAME_PTR f
, int id
)
189 return FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].height
;
193 x_bitmap_width (FRAME_PTR f
, int id
)
195 return FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].width
;
198 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI)
200 x_bitmap_pixmap (FRAME_PTR f
, int id
)
202 return (int) FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].pixmap
;
206 #ifdef HAVE_X_WINDOWS
208 x_bitmap_mask (FRAME_PTR f
, int id
)
210 return FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].mask
;
214 /* Allocate a new bitmap record. Returns index of new record. */
217 x_allocate_bitmap_record (FRAME_PTR f
)
219 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
222 if (dpyinfo
->bitmaps
== NULL
)
224 dpyinfo
->bitmaps_size
= 10;
226 = (Bitmap_Record
*) xmalloc (dpyinfo
->bitmaps_size
* sizeof (Bitmap_Record
));
227 dpyinfo
->bitmaps_last
= 1;
231 if (dpyinfo
->bitmaps_last
< dpyinfo
->bitmaps_size
)
232 return ++dpyinfo
->bitmaps_last
;
234 for (i
= 0; i
< dpyinfo
->bitmaps_size
; ++i
)
235 if (dpyinfo
->bitmaps
[i
].refcount
== 0)
238 dpyinfo
->bitmaps_size
*= 2;
240 = (Bitmap_Record
*) xrealloc (dpyinfo
->bitmaps
,
241 dpyinfo
->bitmaps_size
* sizeof (Bitmap_Record
));
242 return ++dpyinfo
->bitmaps_last
;
245 /* Add one reference to the reference count of the bitmap with id ID. */
248 x_reference_bitmap (FRAME_PTR f
, int id
)
250 ++FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].refcount
;
253 /* Create a bitmap for frame F from a HEIGHT x WIDTH array of bits at BITS. */
256 x_create_bitmap_from_data (struct frame
*f
, char *bits
, unsigned int width
, unsigned int height
)
258 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
261 #ifdef HAVE_X_WINDOWS
263 bitmap
= XCreateBitmapFromData (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
264 bits
, width
, height
);
267 #endif /* HAVE_X_WINDOWS */
271 bitmap
= CreateBitmap (width
, height
,
272 FRAME_X_DISPLAY_INFO (XFRAME (frame
))->n_planes
,
273 FRAME_X_DISPLAY_INFO (XFRAME (frame
))->n_cbits
,
277 #endif /* HAVE_NTGUI */
280 void *bitmap
= ns_image_from_XBM (bits
, width
, height
);
285 id
= x_allocate_bitmap_record (f
);
288 dpyinfo
->bitmaps
[id
- 1].img
= bitmap
;
289 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
292 dpyinfo
->bitmaps
[id
- 1].file
= NULL
;
293 dpyinfo
->bitmaps
[id
- 1].height
= height
;
294 dpyinfo
->bitmaps
[id
- 1].width
= width
;
295 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
297 #ifdef HAVE_X_WINDOWS
298 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
299 dpyinfo
->bitmaps
[id
- 1].have_mask
= 0;
300 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
301 #endif /* HAVE_X_WINDOWS */
304 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
305 dpyinfo
->bitmaps
[id
- 1].hinst
= NULL
;
306 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
307 #endif /* HAVE_NTGUI */
312 /* Create bitmap from file FILE for frame F. */
315 x_create_bitmap_from_file (struct frame
*f
, Lisp_Object file
)
317 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
320 return -1; /* W32_TODO : bitmap support */
321 #endif /* HAVE_NTGUI */
325 void *bitmap
= ns_image_from_file (file
);
331 id
= x_allocate_bitmap_record (f
);
332 dpyinfo
->bitmaps
[id
- 1].img
= bitmap
;
333 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
334 dpyinfo
->bitmaps
[id
- 1].file
= (char *) xmalloc (SBYTES (file
) + 1);
335 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
336 dpyinfo
->bitmaps
[id
- 1].height
= ns_image_width (bitmap
);
337 dpyinfo
->bitmaps
[id
- 1].width
= ns_image_height (bitmap
);
338 strcpy (dpyinfo
->bitmaps
[id
- 1].file
, SDATA (file
));
342 #ifdef HAVE_X_WINDOWS
343 unsigned int width
, height
;
345 int xhot
, yhot
, result
, id
;
350 /* Look for an existing bitmap with the same name. */
351 for (id
= 0; id
< dpyinfo
->bitmaps_last
; ++id
)
353 if (dpyinfo
->bitmaps
[id
].refcount
354 && dpyinfo
->bitmaps
[id
].file
355 && !strcmp (dpyinfo
->bitmaps
[id
].file
, (char *) SDATA (file
)))
357 ++dpyinfo
->bitmaps
[id
].refcount
;
362 /* Search bitmap-file-path for the file, if appropriate. */
363 fd
= openp (Vx_bitmap_file_path
, file
, Qnil
, &found
, Qnil
);
368 filename
= (char *) SDATA (found
);
370 result
= XReadBitmapFile (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
371 filename
, &width
, &height
, &bitmap
, &xhot
, &yhot
);
372 if (result
!= BitmapSuccess
)
375 id
= x_allocate_bitmap_record (f
);
376 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
377 dpyinfo
->bitmaps
[id
- 1].have_mask
= 0;
378 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
379 dpyinfo
->bitmaps
[id
- 1].file
= (char *) xmalloc (SBYTES (file
) + 1);
380 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
381 dpyinfo
->bitmaps
[id
- 1].height
= height
;
382 dpyinfo
->bitmaps
[id
- 1].width
= width
;
383 strcpy (dpyinfo
->bitmaps
[id
- 1].file
, SDATA (file
));
386 #endif /* HAVE_X_WINDOWS */
392 free_bitmap_record (Display_Info
*dpyinfo
, Bitmap_Record
*bm
)
394 #ifdef HAVE_X_WINDOWS
395 XFreePixmap (dpyinfo
->display
, bm
->pixmap
);
397 XFreePixmap (dpyinfo
->display
, bm
->mask
);
398 #endif /* HAVE_X_WINDOWS */
401 DeleteObject (bm
->pixmap
);
402 #endif /* HAVE_NTGUI */
405 ns_release_object (bm
->img
);
415 /* Remove reference to bitmap with id number ID. */
418 x_destroy_bitmap (FRAME_PTR f
, int id
)
420 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
424 Bitmap_Record
*bm
= &dpyinfo
->bitmaps
[id
- 1];
426 if (--bm
->refcount
== 0)
429 free_bitmap_record (dpyinfo
, bm
);
435 /* Free all the bitmaps for the display specified by DPYINFO. */
438 x_destroy_all_bitmaps (Display_Info
*dpyinfo
)
441 Bitmap_Record
*bm
= dpyinfo
->bitmaps
;
443 for (i
= 0; i
< dpyinfo
->bitmaps_last
; i
++, bm
++)
444 if (bm
->refcount
> 0)
445 free_bitmap_record (dpyinfo
, bm
);
447 dpyinfo
->bitmaps_last
= 0;
451 #ifdef HAVE_X_WINDOWS
453 /* Useful functions defined in the section
454 `Image type independent image structures' below. */
456 static unsigned long four_corners_best (XImagePtr ximg
,
459 unsigned long height
);
461 static int x_create_x_image_and_pixmap (struct frame
*f
, int width
, int height
,
462 int depth
, XImagePtr
*ximg
,
465 static void x_destroy_x_image (XImagePtr ximg
);
468 /* Create a mask of a bitmap. Note is this not a perfect mask.
469 It's nicer with some borders in this context */
472 x_create_bitmap_mask (struct frame
*f
, int id
)
475 XImagePtr ximg
, mask_img
;
476 unsigned long width
, height
;
479 unsigned long x
, y
, xp
, xm
, yp
, ym
;
482 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
487 pixmap
= x_bitmap_pixmap (f
, id
);
488 width
= x_bitmap_width (f
, id
);
489 height
= x_bitmap_height (f
, id
);
492 ximg
= XGetImage (FRAME_X_DISPLAY (f
), pixmap
, 0, 0, width
, height
,
501 result
= x_create_x_image_and_pixmap (f
, width
, height
, 1, &mask_img
, &mask
);
506 XDestroyImage (ximg
);
510 bg
= four_corners_best (ximg
, NULL
, width
, height
);
512 for (y
= 0; y
< ximg
->height
; ++y
)
514 for (x
= 0; x
< ximg
->width
; ++x
)
516 xp
= x
!= ximg
->width
- 1 ? x
+ 1 : 0;
517 xm
= x
!= 0 ? x
- 1 : ximg
->width
- 1;
518 yp
= y
!= ximg
->height
- 1 ? y
+ 1 : 0;
519 ym
= y
!= 0 ? y
- 1 : ximg
->height
- 1;
520 if (XGetPixel (ximg
, x
, y
) == bg
521 && XGetPixel (ximg
, x
, yp
) == bg
522 && XGetPixel (ximg
, x
, ym
) == bg
523 && XGetPixel (ximg
, xp
, y
) == bg
524 && XGetPixel (ximg
, xp
, yp
) == bg
525 && XGetPixel (ximg
, xp
, ym
) == bg
526 && XGetPixel (ximg
, xm
, y
) == bg
527 && XGetPixel (ximg
, xm
, yp
) == bg
528 && XGetPixel (ximg
, xm
, ym
) == bg
)
529 XPutPixel (mask_img
, x
, y
, 0);
531 XPutPixel (mask_img
, x
, y
, 1);
535 xassert (interrupt_input_blocked
);
536 gc
= XCreateGC (FRAME_X_DISPLAY (f
), mask
, 0, NULL
);
537 XPutImage (FRAME_X_DISPLAY (f
), mask
, gc
, mask_img
, 0, 0, 0, 0,
539 XFreeGC (FRAME_X_DISPLAY (f
), gc
);
541 dpyinfo
->bitmaps
[id
- 1].have_mask
= 1;
542 dpyinfo
->bitmaps
[id
- 1].mask
= mask
;
544 XDestroyImage (ximg
);
545 x_destroy_x_image (mask_img
);
550 #endif /* HAVE_X_WINDOWS */
553 /***********************************************************************
555 ***********************************************************************/
557 /* Value is the number of elements of vector VECTOR. */
559 #define DIM(VECTOR) (sizeof (VECTOR) / sizeof *(VECTOR))
561 /* List of supported image types. Use define_image_type to add new
562 types. Use lookup_image_type to find a type for a given symbol. */
564 static struct image_type
*image_types
;
566 /* A list of symbols, one for each supported image type. */
568 Lisp_Object Vimage_types
;
570 /* Cache for delayed-loading image types. */
572 static Lisp_Object Vimage_type_cache
;
574 /* The symbol `xbm' which is used as the type symbol for XBM images. */
580 Lisp_Object QCascent
, QCmargin
, QCrelief
, Qcount
, Qextension_data
;
581 Lisp_Object QCconversion
, QCcolor_symbols
, QCheuristic_mask
;
582 Lisp_Object QCindex
, QCmatrix
, QCcolor_adjustment
, QCmask
, QCgeometry
, QCcrop
, QCrotation
;
586 Lisp_Object Qlaplace
, Qemboss
, Qedge_detection
, Qheuristic
;
588 /* Time in seconds after which images should be removed from the cache
591 Lisp_Object Vimage_cache_eviction_delay
;
593 /* Function prototypes. */
595 static Lisp_Object
define_image_type (struct image_type
*type
, int loaded
);
596 static struct image_type
*lookup_image_type (Lisp_Object symbol
);
597 static void image_error (const char *format
, Lisp_Object
, Lisp_Object
);
598 static void x_laplace (struct frame
*, struct image
*);
599 static void x_emboss (struct frame
*, struct image
*);
600 static int x_build_heuristic_mask (struct frame
*, struct image
*,
603 #define CACHE_IMAGE_TYPE(type, status) \
604 do { Vimage_type_cache = Fcons (Fcons (type, status), Vimage_type_cache); } while (0)
606 #define ADD_IMAGE_TYPE(type) \
607 do { Vimage_types = Fcons (type, Vimage_types); } while (0)
609 /* Define a new image type from TYPE. This adds a copy of TYPE to
610 image_types and caches the loading status of TYPE. */
613 define_image_type (struct image_type
*type
, int loaded
)
621 /* Make a copy of TYPE to avoid a bus error in a dumped Emacs.
622 The initialized data segment is read-only. */
623 struct image_type
*p
= (struct image_type
*) xmalloc (sizeof *p
);
624 memcpy (p
, type
, sizeof *p
);
625 p
->next
= image_types
;
630 CACHE_IMAGE_TYPE (*type
->type
, success
);
635 /* Look up image type SYMBOL, and return a pointer to its image_type
636 structure. Value is null if SYMBOL is not a known image type. */
638 static INLINE
struct image_type
*
639 lookup_image_type (Lisp_Object symbol
)
641 struct image_type
*type
;
643 /* We must initialize the image-type if it hasn't been already. */
644 if (NILP (Finit_image_library (symbol
, Vdynamic_library_alist
)))
645 return 0; /* unimplemented */
647 for (type
= image_types
; type
; type
= type
->next
)
648 if (EQ (symbol
, *type
->type
))
655 /* Value is non-zero if OBJECT is a valid Lisp image specification. A
656 valid image specification is a list whose car is the symbol
657 `image', and whose rest is a property list. The property list must
658 contain a value for key `:type'. That value must be the name of a
659 supported image type. The rest of the property list depends on the
663 valid_image_p (Lisp_Object object
)
671 for (tem
= XCDR (object
); CONSP (tem
); tem
= XCDR (tem
))
672 if (EQ (XCAR (tem
), QCtype
))
675 if (CONSP (tem
) && SYMBOLP (XCAR (tem
)))
677 struct image_type
*type
;
678 type
= lookup_image_type (XCAR (tem
));
680 valid_p
= type
->valid_p (object
);
691 /* Log error message with format string FORMAT and argument ARG.
692 Signaling an error, e.g. when an image cannot be loaded, is not a
693 good idea because this would interrupt redisplay, and the error
694 message display would lead to another redisplay. This function
695 therefore simply displays a message. */
698 image_error (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
700 add_to_log (format
, arg1
, arg2
);
705 /***********************************************************************
707 ***********************************************************************/
709 enum image_value_type
711 IMAGE_DONT_CHECK_VALUE_TYPE
,
713 IMAGE_STRING_OR_NIL_VALUE
,
715 IMAGE_POSITIVE_INTEGER_VALUE
,
716 IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR
,
717 IMAGE_NON_NEGATIVE_INTEGER_VALUE
,
720 IMAGE_FUNCTION_VALUE
,
725 /* Structure used when parsing image specifications. */
729 /* Name of keyword. */
732 /* The type of value allowed. */
733 enum image_value_type type
;
735 /* Non-zero means key must be present. */
738 /* Used to recognize duplicate keywords in a property list. */
741 /* The value that was found. */
746 static int parse_image_spec (Lisp_Object
, struct image_keyword
*,
748 static Lisp_Object
image_spec_value (Lisp_Object
, Lisp_Object
, int *);
751 /* Parse image spec SPEC according to KEYWORDS. A valid image spec
752 has the format (image KEYWORD VALUE ...). One of the keyword/
753 value pairs must be `:type TYPE'. KEYWORDS is a vector of
754 image_keywords structures of size NKEYWORDS describing other
755 allowed keyword/value pairs. Value is non-zero if SPEC is valid. */
758 parse_image_spec (Lisp_Object spec
, struct image_keyword
*keywords
,
759 int nkeywords
, Lisp_Object type
)
768 while (CONSP (plist
))
770 Lisp_Object key
, value
;
772 /* First element of a pair must be a symbol. */
774 plist
= XCDR (plist
);
778 /* There must follow a value. */
781 value
= XCAR (plist
);
782 plist
= XCDR (plist
);
784 /* Find key in KEYWORDS. Error if not found. */
785 for (i
= 0; i
< nkeywords
; ++i
)
786 if (strcmp (keywords
[i
].name
, SDATA (SYMBOL_NAME (key
))) == 0)
792 /* Record that we recognized the keyword. If a keywords
793 was found more than once, it's an error. */
794 keywords
[i
].value
= value
;
797 if (keywords
[i
].count
> 1)
800 /* Check type of value against allowed type. */
801 switch (keywords
[i
].type
)
803 case IMAGE_STRING_VALUE
:
804 if (!STRINGP (value
))
808 case IMAGE_STRING_OR_NIL_VALUE
:
809 if (!STRINGP (value
) && !NILP (value
))
813 case IMAGE_SYMBOL_VALUE
:
814 if (!SYMBOLP (value
))
818 case IMAGE_POSITIVE_INTEGER_VALUE
:
819 if (!INTEGERP (value
) || XINT (value
) <= 0)
823 case IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR
:
824 if (INTEGERP (value
) && XINT (value
) >= 0)
827 && INTEGERP (XCAR (value
)) && INTEGERP (XCDR (value
))
828 && XINT (XCAR (value
)) >= 0 && XINT (XCDR (value
)) >= 0)
832 case IMAGE_ASCENT_VALUE
:
833 if (SYMBOLP (value
) && EQ (value
, Qcenter
))
835 else if (INTEGERP (value
)
837 && XINT (value
) <= 100)
841 case IMAGE_NON_NEGATIVE_INTEGER_VALUE
:
842 if (!INTEGERP (value
) || XINT (value
) < 0)
846 case IMAGE_DONT_CHECK_VALUE_TYPE
:
849 case IMAGE_FUNCTION_VALUE
:
850 value
= indirect_function (value
);
853 || (CONSP (value
) && EQ (XCAR (value
), Qlambda
)))
857 case IMAGE_NUMBER_VALUE
:
858 if (!INTEGERP (value
) && !FLOATP (value
))
862 case IMAGE_INTEGER_VALUE
:
863 if (!INTEGERP (value
))
867 case IMAGE_BOOL_VALUE
:
868 if (!NILP (value
) && !EQ (value
, Qt
))
877 if (EQ (key
, QCtype
) && !EQ (type
, value
))
881 /* Check that all mandatory fields are present. */
882 for (i
= 0; i
< nkeywords
; ++i
)
883 if (keywords
[i
].mandatory_p
&& keywords
[i
].count
== 0)
890 /* Return the value of KEY in image specification SPEC. Value is nil
891 if KEY is not present in SPEC. if FOUND is not null, set *FOUND
892 to 1 if KEY was found in SPEC, set it to 0 otherwise. */
895 image_spec_value (Lisp_Object spec
, Lisp_Object key
, int *found
)
899 xassert (valid_image_p (spec
));
901 for (tail
= XCDR (spec
);
902 CONSP (tail
) && CONSP (XCDR (tail
));
903 tail
= XCDR (XCDR (tail
)))
905 if (EQ (XCAR (tail
), key
))
909 return XCAR (XCDR (tail
));
919 DEFUN ("image-size", Fimage_size
, Simage_size
, 1, 3, 0,
920 doc
: /* Return the size of image SPEC as pair (WIDTH . HEIGHT).
921 PIXELS non-nil means return the size in pixels, otherwise return the
922 size in canonical character units.
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 pixels
, Lisp_Object frame
)
930 if (valid_image_p (spec
))
932 struct frame
*f
= check_x_frame (frame
);
933 int id
= lookup_image (f
, spec
);
934 struct image
*img
= IMAGE_FROM_ID (f
, id
);
935 int width
= img
->width
+ 2 * img
->hmargin
;
936 int height
= img
->height
+ 2 * img
->vmargin
;
939 size
= Fcons (make_float ((double) width
/ FRAME_COLUMN_WIDTH (f
)),
940 make_float ((double) height
/ FRAME_LINE_HEIGHT (f
)));
942 size
= Fcons (make_number (width
), make_number (height
));
945 error ("Invalid image specification");
951 DEFUN ("image-mask-p", Fimage_mask_p
, Simage_mask_p
, 1, 2, 0,
952 doc
: /* Return t if image SPEC has a mask bitmap.
953 FRAME is the frame on which the image will be displayed. FRAME nil
954 or omitted means use the selected frame. */)
955 (Lisp_Object spec
, Lisp_Object frame
)
960 if (valid_image_p (spec
))
962 struct frame
*f
= check_x_frame (frame
);
963 int id
= lookup_image (f
, spec
);
964 struct image
*img
= IMAGE_FROM_ID (f
, id
);
969 error ("Invalid image specification");
974 DEFUN ("image-metadata", Fimage_metadata
, Simage_metadata
, 1, 2, 0,
975 doc
: /* Return metadata for image SPEC.
976 FRAME is the frame on which the image will be displayed. FRAME nil
977 or omitted means use the selected frame. */)
978 (Lisp_Object spec
, Lisp_Object frame
)
983 if (valid_image_p (spec
))
985 struct frame
*f
= check_x_frame (frame
);
986 int id
= lookup_image (f
, spec
);
987 struct image
*img
= IMAGE_FROM_ID (f
, id
);
988 ext
= img
->data
.lisp_val
;
995 /***********************************************************************
996 Image type independent image structures
997 ***********************************************************************/
999 static struct image
*make_image (Lisp_Object spec
, unsigned hash
);
1000 static void free_image (struct frame
*f
, struct image
*img
);
1001 static int check_image_size (struct frame
*f
, int width
, int height
);
1003 #define MAX_IMAGE_SIZE 6.0
1004 Lisp_Object Vmax_image_size
;
1006 /* Allocate and return a new image structure for image specification
1007 SPEC. SPEC has a hash value of HASH. */
1009 static struct image
*
1010 make_image (Lisp_Object spec
, unsigned int hash
)
1012 struct image
*img
= (struct image
*) xmalloc (sizeof *img
);
1013 Lisp_Object file
= image_spec_value (spec
, QCfile
, NULL
);
1015 xassert (valid_image_p (spec
));
1016 memset (img
, 0, sizeof *img
);
1017 img
->dependencies
= NILP (file
) ? Qnil
: list1 (file
);
1018 img
->type
= lookup_image_type (image_spec_value (spec
, QCtype
, NULL
));
1019 xassert (img
->type
!= NULL
);
1021 img
->data
.lisp_val
= Qnil
;
1022 img
->ascent
= DEFAULT_IMAGE_ASCENT
;
1024 img
->corners
[BOT_CORNER
] = -1; /* Full image */
1029 /* Free image IMG which was used on frame F, including its resources. */
1032 free_image (struct frame
*f
, struct image
*img
)
1036 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1038 /* Remove IMG from the hash table of its cache. */
1040 img
->prev
->next
= img
->next
;
1042 c
->buckets
[img
->hash
% IMAGE_CACHE_BUCKETS_SIZE
] = img
->next
;
1045 img
->next
->prev
= img
->prev
;
1047 c
->images
[img
->id
] = NULL
;
1049 /* Free resources, then free IMG. */
1050 img
->type
->free (f
, img
);
1053 /* As display glyphs may still be referring to the image ID, we
1054 must garbage the frame (Bug#6426). */
1055 SET_FRAME_GARBAGED (f
);
1059 /* Return 1 if the given widths and heights are valid for display;
1060 otherwise, return 0. */
1063 check_image_size (struct frame
*f
, int width
, int height
)
1067 if (width
<= 0 || height
<= 0)
1070 if (INTEGERP (Vmax_image_size
))
1071 w
= h
= XINT (Vmax_image_size
);
1072 else if (FLOATP (Vmax_image_size
))
1076 w
= FRAME_PIXEL_WIDTH (f
);
1077 h
= FRAME_PIXEL_HEIGHT (f
);
1080 w
= h
= 1024; /* Arbitrary size for unknown frame. */
1081 w
= (int) (XFLOAT_DATA (Vmax_image_size
) * w
);
1082 h
= (int) (XFLOAT_DATA (Vmax_image_size
) * h
);
1087 return (width
<= w
&& height
<= h
);
1090 /* Prepare image IMG for display on frame F. Must be called before
1091 drawing an image. */
1094 prepare_image_for_display (struct frame
*f
, struct image
*img
)
1098 /* We're about to display IMG, so set its timestamp to `now'. */
1100 img
->timestamp
= EMACS_SECS (t
);
1102 /* If IMG doesn't have a pixmap yet, load it now, using the image
1103 type dependent loader function. */
1104 if (img
->pixmap
== NO_PIXMAP
&& !img
->load_failed_p
)
1105 img
->load_failed_p
= img
->type
->load (f
, img
) == 0;
1110 /* Value is the number of pixels for the ascent of image IMG when
1111 drawn in face FACE. */
1114 image_ascent (struct image
*img
, struct face
*face
, struct glyph_slice
*slice
)
1119 if (slice
->height
== img
->height
)
1120 height
= img
->height
+ img
->vmargin
;
1121 else if (slice
->y
== 0)
1122 height
= slice
->height
+ img
->vmargin
;
1124 height
= slice
->height
;
1126 if (img
->ascent
== CENTERED_IMAGE_ASCENT
)
1131 /* W32 specific version. Why?. ++kfs */
1132 ascent
= height
/ 2 - (FONT_DESCENT (face
->font
)
1133 - FONT_BASE (face
->font
)) / 2;
1135 /* This expression is arranged so that if the image can't be
1136 exactly centered, it will be moved slightly up. This is
1137 because a typical font is `top-heavy' (due to the presence
1138 uppercase letters), so the image placement should err towards
1139 being top-heavy too. It also just generally looks better. */
1140 ascent
= (height
+ FONT_BASE(face
->font
)
1141 - FONT_DESCENT(face
->font
) + 1) / 2;
1142 #endif /* HAVE_NTGUI */
1145 ascent
= height
/ 2;
1148 ascent
= (int) (height
* img
->ascent
/ 100.0);
1154 /* Image background colors. */
1156 /* Find the "best" corner color of a bitmap.
1157 On W32, XIMG is assumed to a device context with the bitmap selected. */
1159 static RGB_PIXEL_COLOR
1160 four_corners_best (XImagePtr_or_DC ximg
, int *corners
,
1161 unsigned long width
, unsigned long height
)
1163 RGB_PIXEL_COLOR corner_pixels
[4], best
;
1166 if (corners
&& corners
[BOT_CORNER
] >= 0)
1168 /* Get the colors at the corner_pixels of ximg. */
1169 corner_pixels
[0] = GET_PIXEL (ximg
, corners
[LEFT_CORNER
], corners
[TOP_CORNER
]);
1170 corner_pixels
[1] = GET_PIXEL (ximg
, corners
[RIGHT_CORNER
] - 1, corners
[TOP_CORNER
]);
1171 corner_pixels
[2] = GET_PIXEL (ximg
, corners
[RIGHT_CORNER
] - 1, corners
[BOT_CORNER
] - 1);
1172 corner_pixels
[3] = GET_PIXEL (ximg
, corners
[LEFT_CORNER
], corners
[BOT_CORNER
] - 1);
1176 /* Get the colors at the corner_pixels of ximg. */
1177 corner_pixels
[0] = GET_PIXEL (ximg
, 0, 0);
1178 corner_pixels
[1] = GET_PIXEL (ximg
, width
- 1, 0);
1179 corner_pixels
[2] = GET_PIXEL (ximg
, width
- 1, height
- 1);
1180 corner_pixels
[3] = GET_PIXEL (ximg
, 0, height
- 1);
1182 /* Choose the most frequently found color as background. */
1183 for (i
= best_count
= 0; i
< 4; ++i
)
1187 for (j
= n
= 0; j
< 4; ++j
)
1188 if (corner_pixels
[i
] == corner_pixels
[j
])
1192 best
= corner_pixels
[i
], best_count
= n
;
1198 /* Portability macros */
1202 #define Destroy_Image(img_dc, prev) \
1203 do { SelectObject (img_dc, prev); DeleteDC (img_dc); } while (0)
1205 #define Free_Pixmap(display, pixmap) \
1206 DeleteObject (pixmap)
1208 #elif defined (HAVE_NS)
1210 #define Destroy_Image(ximg, dummy) \
1211 ns_release_object (ximg)
1213 #define Free_Pixmap(display, pixmap) \
1214 ns_release_object (pixmap)
1218 #define Destroy_Image(ximg, dummy) \
1219 XDestroyImage (ximg)
1221 #define Free_Pixmap(display, pixmap) \
1222 XFreePixmap (display, pixmap)
1224 #endif /* !HAVE_NTGUI && !HAVE_NS */
1227 /* Return the `background' field of IMG. If IMG doesn't have one yet,
1228 it is guessed heuristically. If non-zero, XIMG is an existing
1229 XImage object (or device context with the image selected on W32) to
1230 use for the heuristic. */
1233 image_background (struct image
*img
, struct frame
*f
, XImagePtr_or_DC ximg
)
1235 if (! img
->background_valid
)
1236 /* IMG doesn't have a background yet, try to guess a reasonable value. */
1238 int free_ximg
= !ximg
;
1241 #endif /* HAVE_NTGUI */
1246 ximg
= XGetImage (FRAME_X_DISPLAY (f
), img
->pixmap
,
1247 0, 0, img
->width
, img
->height
, ~0, ZPixmap
);
1249 HDC frame_dc
= get_frame_dc (f
);
1250 ximg
= CreateCompatibleDC (frame_dc
);
1251 release_frame_dc (f
, frame_dc
);
1252 prev
= SelectObject (ximg
, img
->pixmap
);
1253 #endif /* !HAVE_NTGUI */
1256 img
->background
= four_corners_best (ximg
, img
->corners
, img
->width
, img
->height
);
1259 Destroy_Image (ximg
, prev
);
1261 img
->background_valid
= 1;
1264 return img
->background
;
1267 /* Return the `background_transparent' field of IMG. If IMG doesn't
1268 have one yet, it is guessed heuristically. If non-zero, MASK is an
1269 existing XImage object to use for the heuristic. */
1272 image_background_transparent (struct image
*img
, struct frame
*f
, XImagePtr_or_DC mask
)
1274 if (! img
->background_transparent_valid
)
1275 /* IMG doesn't have a background yet, try to guess a reasonable value. */
1279 int free_mask
= !mask
;
1282 #endif /* HAVE_NTGUI */
1287 mask
= XGetImage (FRAME_X_DISPLAY (f
), img
->mask
,
1288 0, 0, img
->width
, img
->height
, ~0, ZPixmap
);
1290 HDC frame_dc
= get_frame_dc (f
);
1291 mask
= CreateCompatibleDC (frame_dc
);
1292 release_frame_dc (f
, frame_dc
);
1293 prev
= SelectObject (mask
, img
->mask
);
1294 #endif /* HAVE_NTGUI */
1297 img
->background_transparent
1298 = (four_corners_best (mask
, img
->corners
, img
->width
, img
->height
) == PIX_MASK_RETAIN
);
1301 Destroy_Image (mask
, prev
);
1304 img
->background_transparent
= 0;
1306 img
->background_transparent_valid
= 1;
1309 return img
->background_transparent
;
1313 /***********************************************************************
1314 Helper functions for X image types
1315 ***********************************************************************/
1317 static void x_clear_image_1 (struct frame
*, struct image
*, int,
1319 static void x_clear_image (struct frame
*f
, struct image
*img
);
1320 static unsigned long x_alloc_image_color (struct frame
*f
,
1322 Lisp_Object color_name
,
1323 unsigned long dflt
);
1326 /* Clear X resources of image IMG on frame F. PIXMAP_P non-zero means
1327 free the pixmap if any. MASK_P non-zero means clear the mask
1328 pixmap if any. COLORS_P non-zero means free colors allocated for
1329 the image, if any. */
1332 x_clear_image_1 (struct frame
*f
, struct image
*img
, int pixmap_p
, int mask_p
,
1335 if (pixmap_p
&& img
->pixmap
)
1337 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->pixmap
);
1338 img
->pixmap
= NO_PIXMAP
;
1339 /* NOTE (HAVE_NS): background color is NOT an indexed color! */
1340 img
->background_valid
= 0;
1343 if (mask_p
&& img
->mask
)
1345 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->mask
);
1346 img
->mask
= NO_PIXMAP
;
1347 img
->background_transparent_valid
= 0;
1350 if (colors_p
&& img
->ncolors
)
1352 /* W32_TODO: color table support. */
1353 #ifdef HAVE_X_WINDOWS
1354 x_free_colors (f
, img
->colors
, img
->ncolors
);
1355 #endif /* HAVE_X_WINDOWS */
1356 xfree (img
->colors
);
1363 /* Free X resources of image IMG which is used on frame F. */
1366 x_clear_image (struct frame
*f
, struct image
*img
)
1369 x_clear_image_1 (f
, img
, 1, 1, 1);
1374 /* Allocate color COLOR_NAME for image IMG on frame F. If color
1375 cannot be allocated, use DFLT. Add a newly allocated color to
1376 IMG->colors, so that it can be freed again. Value is the pixel
1379 static unsigned long
1380 x_alloc_image_color (struct frame
*f
, struct image
*img
, Lisp_Object color_name
,
1384 unsigned long result
;
1386 xassert (STRINGP (color_name
));
1388 if (x_defined_color (f
, SDATA (color_name
), &color
, 1))
1390 /* This isn't called frequently so we get away with simply
1391 reallocating the color vector to the needed size, here. */
1394 (unsigned long *) xrealloc (img
->colors
,
1395 img
->ncolors
* sizeof *img
->colors
);
1396 img
->colors
[img
->ncolors
- 1] = color
.pixel
;
1397 result
= color
.pixel
;
1407 /***********************************************************************
1409 ***********************************************************************/
1411 static struct image
*search_image_cache (struct frame
*, Lisp_Object
, unsigned);
1412 static void cache_image (struct frame
*f
, struct image
*img
);
1413 static void postprocess_image (struct frame
*, struct image
*);
1415 /* Return a new, initialized image cache that is allocated from the
1416 heap. Call free_image_cache to free an image cache. */
1418 struct image_cache
*
1419 make_image_cache (void)
1421 struct image_cache
*c
= (struct image_cache
*) xmalloc (sizeof *c
);
1424 memset (c
, 0, sizeof *c
);
1426 c
->images
= (struct image
**) xmalloc (c
->size
* sizeof *c
->images
);
1427 size
= IMAGE_CACHE_BUCKETS_SIZE
* sizeof *c
->buckets
;
1428 c
->buckets
= (struct image
**) xmalloc (size
);
1429 memset (c
->buckets
, 0, size
);
1434 /* Find an image matching SPEC in the cache, and return it. If no
1435 image is found, return NULL. */
1436 static struct image
*
1437 search_image_cache (struct frame
*f
, Lisp_Object spec
, unsigned int hash
)
1440 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1441 int i
= hash
% IMAGE_CACHE_BUCKETS_SIZE
;
1443 if (!c
) return NULL
;
1445 /* If the image spec does not specify a background color, the cached
1446 image must have the same background color as the current frame.
1447 The foreground color must also match, for the sake of monochrome
1450 In fact, we could ignore the foreground color matching condition
1451 for color images, or if the image spec specifies :foreground;
1452 similarly we could ignore the background color matching condition
1453 for formats that don't use transparency (such as jpeg), or if the
1454 image spec specifies :background. However, the extra memory
1455 usage is probably negligible in practice, so we don't bother. */
1457 for (img
= c
->buckets
[i
]; img
; img
= img
->next
)
1458 if (img
->hash
== hash
1459 && !NILP (Fequal (img
->spec
, spec
))
1460 && img
->frame_foreground
== FRAME_FOREGROUND_PIXEL (f
)
1461 && img
->frame_background
== FRAME_BACKGROUND_PIXEL (f
))
1467 /* Search frame F for an image with spec SPEC, and free it. */
1470 uncache_image (struct frame
*f
, Lisp_Object spec
)
1472 struct image
*img
= search_image_cache (f
, spec
, sxhash (spec
, 0));
1474 free_image (f
, img
);
1478 /* Free image cache of frame F. Be aware that X frames share images
1482 free_image_cache (struct frame
*f
)
1484 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1489 /* Cache should not be referenced by any frame when freed. */
1490 xassert (c
->refcount
== 0);
1492 for (i
= 0; i
< c
->used
; ++i
)
1493 free_image (f
, c
->images
[i
]);
1497 FRAME_IMAGE_CACHE (f
) = NULL
;
1502 /* Clear image cache of frame F. FILTER=t means free all images.
1503 FILTER=nil means clear only images that haven't been
1504 displayed for some time.
1505 Else, only free the images which have FILTER in their `dependencies'.
1506 Should be called from time to time to reduce the number of loaded images.
1507 If image-cache-eviction-delay is non-nil, this frees images in the cache
1508 which weren't displayed for at least that many seconds. */
1511 clear_image_cache (struct frame
*f
, Lisp_Object filter
)
1513 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1519 /* Block input so that we won't be interrupted by a SIGIO
1520 while being in an inconsistent state. */
1525 /* Filter image cache. */
1526 for (i
= 0; i
< c
->used
; ++i
)
1528 struct image
*img
= c
->images
[i
];
1529 if (img
&& (EQ (Qt
, filter
)
1530 || !NILP (Fmember (filter
, img
->dependencies
))))
1532 free_image (f
, img
);
1537 else if (INTEGERP (Vimage_cache_eviction_delay
))
1539 /* Free cache based on timestamp. */
1542 int delay
, nimages
= 0;
1544 for (i
= 0; i
< c
->used
; ++i
)
1548 /* If the number of cached images has grown unusually large,
1549 decrease the cache eviction delay (Bug#6230). */
1550 delay
= XFASTINT (Vimage_cache_eviction_delay
);
1552 delay
= max (1, 1600 * delay
/ (nimages
*nimages
));
1555 old
= EMACS_SECS (t
) - delay
;
1557 for (i
= 0; i
< c
->used
; ++i
)
1559 struct image
*img
= c
->images
[i
];
1560 if (img
&& img
->timestamp
< old
)
1562 free_image (f
, img
);
1568 /* We may be clearing the image cache because, for example,
1569 Emacs was iconified for a longer period of time. In that
1570 case, current matrices may still contain references to
1571 images freed above. So, clear these matrices. */
1574 Lisp_Object tail
, frame
;
1576 FOR_EACH_FRAME (tail
, frame
)
1578 struct frame
*f
= XFRAME (frame
);
1579 if (FRAME_IMAGE_CACHE (f
) == c
)
1580 clear_current_matrices (f
);
1583 ++windows_or_buffers_changed
;
1591 clear_image_caches (Lisp_Object filter
)
1593 /* FIXME: We want to do
1594 * struct terminal *t;
1595 * for (t = terminal_list; t; t = t->next_terminal)
1596 * clear_image_cache (t, filter); */
1597 Lisp_Object tail
, frame
;
1598 FOR_EACH_FRAME (tail
, frame
)
1599 if (FRAME_WINDOW_P (XFRAME (frame
)))
1600 clear_image_cache (XFRAME (frame
), filter
);
1603 DEFUN ("clear-image-cache", Fclear_image_cache
, Sclear_image_cache
,
1605 doc
: /* Clear the image cache.
1606 FILTER nil or a frame means clear all images in the selected frame.
1607 FILTER t means clear the image caches of all frames.
1608 Anything else, means only clear those images which refer to FILTER,
1609 which is then usually a filename. */)
1610 (Lisp_Object filter
)
1612 if (!(EQ (filter
, Qnil
) || FRAMEP (filter
)))
1613 clear_image_caches (filter
);
1615 clear_image_cache (check_x_frame (filter
), Qt
);
1621 DEFUN ("image-flush", Fimage_flush
, Simage_flush
,
1623 doc
: /* Fush the image with specification SPEC on frame FRAME.
1624 This removes the image from the Emacs image cache. If SPEC specifies
1625 an image file, the next redisplay of this image will read from the
1626 current contents of that file.
1628 FRAME nil or omitted means use the selected frame.
1629 FRAME t means refresh the image on all frames. */)
1630 (Lisp_Object spec
, Lisp_Object frame
)
1632 if (!valid_image_p (spec
))
1633 error ("Invalid image specification");
1638 FOR_EACH_FRAME (tail
, frame
)
1640 struct frame
*f
= XFRAME (frame
);
1641 if (FRAME_WINDOW_P (f
))
1642 uncache_image (f
, spec
);
1646 uncache_image (check_x_frame (frame
), spec
);
1652 /* Compute masks and transform image IMG on frame F, as specified
1653 by the image's specification, */
1656 postprocess_image (struct frame
*f
, struct image
*img
)
1658 /* Manipulation of the image's mask. */
1661 Lisp_Object conversion
, spec
;
1666 /* `:heuristic-mask t'
1668 means build a mask heuristically.
1669 `:heuristic-mask (R G B)'
1670 `:mask (heuristic (R G B))'
1671 means build a mask from color (R G B) in the
1674 means remove a mask, if any. */
1676 mask
= image_spec_value (spec
, QCheuristic_mask
, NULL
);
1678 x_build_heuristic_mask (f
, img
, mask
);
1683 mask
= image_spec_value (spec
, QCmask
, &found_p
);
1685 if (EQ (mask
, Qheuristic
))
1686 x_build_heuristic_mask (f
, img
, Qt
);
1687 else if (CONSP (mask
)
1688 && EQ (XCAR (mask
), Qheuristic
))
1690 if (CONSP (XCDR (mask
)))
1691 x_build_heuristic_mask (f
, img
, XCAR (XCDR (mask
)));
1693 x_build_heuristic_mask (f
, img
, XCDR (mask
));
1695 else if (NILP (mask
) && found_p
&& img
->mask
)
1697 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->mask
);
1698 img
->mask
= NO_PIXMAP
;
1703 /* Should we apply an image transformation algorithm? */
1704 conversion
= image_spec_value (spec
, QCconversion
, NULL
);
1705 if (EQ (conversion
, Qdisabled
))
1706 x_disable_image (f
, img
);
1707 else if (EQ (conversion
, Qlaplace
))
1709 else if (EQ (conversion
, Qemboss
))
1711 else if (CONSP (conversion
)
1712 && EQ (XCAR (conversion
), Qedge_detection
))
1715 tem
= XCDR (conversion
);
1717 x_edge_detection (f
, img
,
1718 Fplist_get (tem
, QCmatrix
),
1719 Fplist_get (tem
, QCcolor_adjustment
));
1725 /* Return the id of image with Lisp specification SPEC on frame F.
1726 SPEC must be a valid Lisp image specification (see valid_image_p). */
1729 lookup_image (struct frame
*f
, Lisp_Object spec
)
1731 struct image_cache
*c
;
1736 /* F must be a window-system frame, and SPEC must be a valid image
1738 xassert (FRAME_WINDOW_P (f
));
1739 xassert (valid_image_p (spec
));
1741 c
= FRAME_IMAGE_CACHE (f
);
1743 /* Look up SPEC in the hash table of the image cache. */
1744 hash
= sxhash (spec
, 0);
1745 img
= search_image_cache (f
, spec
, hash
);
1746 if (img
&& img
->load_failed_p
)
1748 free_image (f
, img
);
1752 /* If not found, create a new image and cache it. */
1756 img
= make_image (spec
, hash
);
1757 cache_image (f
, img
);
1758 img
->load_failed_p
= img
->type
->load (f
, img
) == 0;
1759 img
->frame_foreground
= FRAME_FOREGROUND_PIXEL (f
);
1760 img
->frame_background
= FRAME_BACKGROUND_PIXEL (f
);
1762 /* If we can't load the image, and we don't have a width and
1763 height, use some arbitrary width and height so that we can
1764 draw a rectangle for it. */
1765 if (img
->load_failed_p
)
1769 value
= image_spec_value (spec
, QCwidth
, NULL
);
1770 img
->width
= (INTEGERP (value
)
1771 ? XFASTINT (value
) : DEFAULT_IMAGE_WIDTH
);
1772 value
= image_spec_value (spec
, QCheight
, NULL
);
1773 img
->height
= (INTEGERP (value
)
1774 ? XFASTINT (value
) : DEFAULT_IMAGE_HEIGHT
);
1778 /* Handle image type independent image attributes
1779 `:ascent ASCENT', `:margin MARGIN', `:relief RELIEF',
1780 `:background COLOR'. */
1781 Lisp_Object ascent
, margin
, relief
, bg
;
1783 ascent
= image_spec_value (spec
, QCascent
, NULL
);
1784 if (INTEGERP (ascent
))
1785 img
->ascent
= XFASTINT (ascent
);
1786 else if (EQ (ascent
, Qcenter
))
1787 img
->ascent
= CENTERED_IMAGE_ASCENT
;
1789 margin
= image_spec_value (spec
, QCmargin
, NULL
);
1790 if (INTEGERP (margin
) && XINT (margin
) >= 0)
1791 img
->vmargin
= img
->hmargin
= XFASTINT (margin
);
1792 else if (CONSP (margin
) && INTEGERP (XCAR (margin
))
1793 && INTEGERP (XCDR (margin
)))
1795 if (XINT (XCAR (margin
)) > 0)
1796 img
->hmargin
= XFASTINT (XCAR (margin
));
1797 if (XINT (XCDR (margin
)) > 0)
1798 img
->vmargin
= XFASTINT (XCDR (margin
));
1801 relief
= image_spec_value (spec
, QCrelief
, NULL
);
1802 if (INTEGERP (relief
))
1804 img
->relief
= XINT (relief
);
1805 img
->hmargin
+= eabs (img
->relief
);
1806 img
->vmargin
+= eabs (img
->relief
);
1809 if (! img
->background_valid
)
1811 bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
1815 = x_alloc_image_color (f
, img
, bg
,
1816 FRAME_BACKGROUND_PIXEL (f
));
1817 img
->background_valid
= 1;
1821 /* Do image transformations and compute masks, unless we
1822 don't have the image yet. */
1823 if (!EQ (*img
->type
->type
, Qpostscript
))
1824 postprocess_image (f
, img
);
1830 /* We're using IMG, so set its timestamp to `now'. */
1831 EMACS_GET_TIME (now
);
1832 img
->timestamp
= EMACS_SECS (now
);
1834 /* Value is the image id. */
1839 /* Cache image IMG in the image cache of frame F. */
1842 cache_image (struct frame
*f
, struct image
*img
)
1844 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1847 /* Find a free slot in c->images. */
1848 for (i
= 0; i
< c
->used
; ++i
)
1849 if (c
->images
[i
] == NULL
)
1852 /* If no free slot found, maybe enlarge c->images. */
1853 if (i
== c
->used
&& c
->used
== c
->size
)
1856 c
->images
= (struct image
**) xrealloc (c
->images
,
1857 c
->size
* sizeof *c
->images
);
1860 /* Add IMG to c->images, and assign IMG an id. */
1866 /* Add IMG to the cache's hash table. */
1867 i
= img
->hash
% IMAGE_CACHE_BUCKETS_SIZE
;
1868 img
->next
= c
->buckets
[i
];
1870 img
->next
->prev
= img
;
1872 c
->buckets
[i
] = img
;
1876 /* Call FN on every image in the image cache of frame F. Used to mark
1877 Lisp Objects in the image cache. */
1879 /* Mark Lisp objects in image IMG. */
1882 mark_image (struct image
*img
)
1884 mark_object (img
->spec
);
1885 mark_object (img
->dependencies
);
1887 if (!NILP (img
->data
.lisp_val
))
1888 mark_object (img
->data
.lisp_val
);
1893 mark_image_cache (struct image_cache
*c
)
1898 for (i
= 0; i
< c
->used
; ++i
)
1900 mark_image (c
->images
[i
]);
1906 /***********************************************************************
1907 X / NS / W32 support code
1908 ***********************************************************************/
1912 /* Macro for defining functions that will be loaded from image DLLs. */
1913 #define DEF_IMGLIB_FN(func) int (FAR CDECL *fn_##func)()
1915 /* Macro for loading those image functions from the library. */
1916 #define LOAD_IMGLIB_FN(lib,func) { \
1917 fn_##func = (void *) GetProcAddress (lib, #func); \
1918 if (!fn_##func) return 0; \
1921 /* Load a DLL implementing an image type.
1922 The argument LIBRARIES is usually the variable
1923 `dynamic-library-alist', which associates a symbol, identifying
1924 an external DLL library, to a list of possible filenames.
1925 The function returns NULL if no library could be loaded for
1926 the given symbol, or if the library was previously loaded;
1927 else the handle of the DLL. */
1929 w32_delayed_load (Lisp_Object libraries
, Lisp_Object type
)
1931 HMODULE library
= NULL
;
1933 if (CONSP (libraries
) && NILP (Fassq (type
, Vimage_type_cache
)))
1935 Lisp_Object dlls
= Fassq (type
, libraries
);
1938 for (dlls
= XCDR (dlls
); CONSP (dlls
); dlls
= XCDR (dlls
))
1940 CHECK_STRING_CAR (dlls
);
1941 if (library
= LoadLibrary (SDATA (XCAR (dlls
))))
1949 #endif /* HAVE_NTGUI */
1951 static int x_create_x_image_and_pixmap (struct frame
*, int, int, int,
1952 XImagePtr
*, Pixmap
*);
1953 static void x_destroy_x_image (XImagePtr
);
1954 static void x_put_x_image (struct frame
*, XImagePtr
, Pixmap
, int, int);
1957 /* Create an XImage and a pixmap of size WIDTH x HEIGHT for use on
1958 frame F. Set *XIMG and *PIXMAP to the XImage and Pixmap created.
1959 Set (*XIMG)->data to a raster of WIDTH x HEIGHT pixels allocated
1960 via xmalloc. Print error messages via image_error if an error
1961 occurs. Value is non-zero if successful.
1963 On W32, a DEPTH of zero signifies a 24 bit image, otherwise DEPTH
1964 should indicate the bit depth of the image. */
1967 x_create_x_image_and_pixmap (struct frame
*f
, int width
, int height
, int depth
,
1968 XImagePtr
*ximg
, Pixmap
*pixmap
)
1970 #ifdef HAVE_X_WINDOWS
1971 Display
*display
= FRAME_X_DISPLAY (f
);
1972 Window window
= FRAME_X_WINDOW (f
);
1973 Screen
*screen
= FRAME_X_SCREEN (f
);
1975 xassert (interrupt_input_blocked
);
1978 depth
= DefaultDepthOfScreen (screen
);
1979 *ximg
= XCreateImage (display
, DefaultVisualOfScreen (screen
),
1980 depth
, ZPixmap
, 0, NULL
, width
, height
,
1981 depth
> 16 ? 32 : depth
> 8 ? 16 : 8, 0);
1984 image_error ("Unable to allocate X image", Qnil
, Qnil
);
1988 /* Allocate image raster. */
1989 (*ximg
)->data
= (char *) xmalloc ((*ximg
)->bytes_per_line
* height
);
1991 /* Allocate a pixmap of the same size. */
1992 *pixmap
= XCreatePixmap (display
, window
, width
, height
, depth
);
1993 if (*pixmap
== NO_PIXMAP
)
1995 x_destroy_x_image (*ximg
);
1997 image_error ("Unable to create X pixmap", Qnil
, Qnil
);
2002 #endif /* HAVE_X_WINDOWS */
2006 BITMAPINFOHEADER
*header
;
2008 int scanline_width_bits
;
2010 int palette_colors
= 0;
2015 if (depth
!= 1 && depth
!= 4 && depth
!= 8
2016 && depth
!= 16 && depth
!= 24 && depth
!= 32)
2018 image_error ("Invalid image bit depth specified", Qnil
, Qnil
);
2022 scanline_width_bits
= width
* depth
;
2023 remainder
= scanline_width_bits
% 32;
2026 scanline_width_bits
+= 32 - remainder
;
2028 /* Bitmaps with a depth less than 16 need a palette. */
2029 /* BITMAPINFO structure already contains the first RGBQUAD. */
2031 palette_colors
= 1 << depth
- 1;
2033 *ximg
= xmalloc (sizeof (XImage
) + palette_colors
* sizeof (RGBQUAD
));
2036 image_error ("Unable to allocate memory for XImage", Qnil
, Qnil
);
2040 header
= &(*ximg
)->info
.bmiHeader
;
2041 memset (&(*ximg
)->info
, 0, sizeof (BITMAPINFO
));
2042 header
->biSize
= sizeof (*header
);
2043 header
->biWidth
= width
;
2044 header
->biHeight
= -height
; /* negative indicates a top-down bitmap. */
2045 header
->biPlanes
= 1;
2046 header
->biBitCount
= depth
;
2047 header
->biCompression
= BI_RGB
;
2048 header
->biClrUsed
= palette_colors
;
2050 /* TODO: fill in palette. */
2053 (*ximg
)->info
.bmiColors
[0].rgbBlue
= 0;
2054 (*ximg
)->info
.bmiColors
[0].rgbGreen
= 0;
2055 (*ximg
)->info
.bmiColors
[0].rgbRed
= 0;
2056 (*ximg
)->info
.bmiColors
[0].rgbReserved
= 0;
2057 (*ximg
)->info
.bmiColors
[1].rgbBlue
= 255;
2058 (*ximg
)->info
.bmiColors
[1].rgbGreen
= 255;
2059 (*ximg
)->info
.bmiColors
[1].rgbRed
= 255;
2060 (*ximg
)->info
.bmiColors
[1].rgbReserved
= 0;
2063 hdc
= get_frame_dc (f
);
2065 /* Create a DIBSection and raster array for the bitmap,
2066 and store its handle in *pixmap. */
2067 *pixmap
= CreateDIBSection (hdc
, &((*ximg
)->info
),
2068 (depth
< 16) ? DIB_PAL_COLORS
: DIB_RGB_COLORS
,
2069 /* casting avoids a GCC warning */
2070 (void **)&((*ximg
)->data
), NULL
, 0);
2072 /* Realize display palette and garbage all frames. */
2073 release_frame_dc (f
, hdc
);
2075 if (*pixmap
== NULL
)
2077 DWORD err
= GetLastError ();
2078 Lisp_Object errcode
;
2079 /* All system errors are < 10000, so the following is safe. */
2080 XSETINT (errcode
, (int) err
);
2081 image_error ("Unable to create bitmap, error code %d", errcode
, Qnil
);
2082 x_destroy_x_image (*ximg
);
2088 #endif /* HAVE_NTGUI */
2091 *pixmap
= ns_image_for_XPM (width
, height
, depth
);
2095 image_error ("Unable to allocate NSImage for XPM pixmap", Qnil
, Qnil
);
2104 /* Destroy XImage XIMG. Free XIMG->data. */
2107 x_destroy_x_image (XImagePtr ximg
)
2109 xassert (interrupt_input_blocked
);
2112 #ifdef HAVE_X_WINDOWS
2115 XDestroyImage (ximg
);
2116 #endif /* HAVE_X_WINDOWS */
2118 /* Data will be freed by DestroyObject. */
2121 #endif /* HAVE_NTGUI */
2123 ns_release_object (ximg
);
2124 #endif /* HAVE_NS */
2129 /* Put XImage XIMG into pixmap PIXMAP on frame F. WIDTH and HEIGHT
2130 are width and height of both the image and pixmap. */
2133 x_put_x_image (struct frame
*f
, XImagePtr ximg
, Pixmap pixmap
, int width
, int height
)
2135 #ifdef HAVE_X_WINDOWS
2138 xassert (interrupt_input_blocked
);
2139 gc
= XCreateGC (FRAME_X_DISPLAY (f
), pixmap
, 0, NULL
);
2140 XPutImage (FRAME_X_DISPLAY (f
), pixmap
, gc
, ximg
, 0, 0, 0, 0, width
, height
);
2141 XFreeGC (FRAME_X_DISPLAY (f
), gc
);
2142 #endif /* HAVE_X_WINDOWS */
2145 #if 0 /* I don't think this is necessary looking at where it is used. */
2146 HDC hdc
= get_frame_dc (f
);
2147 SetDIBits (hdc
, pixmap
, 0, height
, ximg
->data
, &(ximg
->info
), DIB_RGB_COLORS
);
2148 release_frame_dc (f
, hdc
);
2150 #endif /* HAVE_NTGUI */
2153 xassert (ximg
== pixmap
);
2154 ns_retain_object (ximg
);
2159 /***********************************************************************
2161 ***********************************************************************/
2163 static unsigned char *slurp_file (char *, int *);
2166 /* Find image file FILE. Look in data-directory/images, then
2167 x-bitmap-file-path. Value is the encoded full name of the file
2168 found, or nil if not found. */
2171 x_find_image_file (Lisp_Object file
)
2173 Lisp_Object file_found
, search_path
;
2176 /* TODO I think this should use something like image-load-path
2177 instead. Unfortunately, that can contain non-string elements. */
2178 search_path
= Fcons (Fexpand_file_name (build_string ("images"),
2180 Vx_bitmap_file_path
);
2182 /* Try to find FILE in data-directory/images, then x-bitmap-file-path. */
2183 fd
= openp (search_path
, file
, Qnil
, &file_found
, Qnil
);
2189 file_found
= ENCODE_FILE (file_found
);
2197 /* Read FILE into memory. Value is a pointer to a buffer allocated
2198 with xmalloc holding FILE's contents. Value is null if an error
2199 occurred. *SIZE is set to the size of the file. */
2201 static unsigned char *
2202 slurp_file (char *file
, int *size
)
2205 unsigned char *buf
= NULL
;
2208 if (stat (file
, &st
) == 0
2209 && (fp
= fopen (file
, "rb")) != NULL
2210 && (buf
= (unsigned char *) xmalloc (st
.st_size
),
2211 fread (buf
, 1, st
.st_size
, fp
) == st
.st_size
))
2232 /***********************************************************************
2234 ***********************************************************************/
2236 static int xbm_scan (unsigned char **, unsigned char *, char *, int *);
2237 static int xbm_load (struct frame
*f
, struct image
*img
);
2238 static int xbm_load_image (struct frame
*f
, struct image
*img
,
2239 unsigned char *, unsigned char *);
2240 static int xbm_image_p (Lisp_Object object
);
2241 static int xbm_read_bitmap_data (struct frame
*f
,
2242 unsigned char *, unsigned char *,
2243 int *, int *, unsigned char **, int);
2244 static int xbm_file_p (Lisp_Object
);
2247 /* Indices of image specification fields in xbm_format, below. */
2249 enum xbm_keyword_index
2267 /* Vector of image_keyword structures describing the format
2268 of valid XBM image specifications. */
2270 static const struct image_keyword xbm_format
[XBM_LAST
] =
2272 {":type", IMAGE_SYMBOL_VALUE
, 1},
2273 {":file", IMAGE_STRING_VALUE
, 0},
2274 {":width", IMAGE_POSITIVE_INTEGER_VALUE
, 0},
2275 {":height", IMAGE_POSITIVE_INTEGER_VALUE
, 0},
2276 {":data", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
2277 {":foreground", IMAGE_STRING_OR_NIL_VALUE
, 0},
2278 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0},
2279 {":ascent", IMAGE_ASCENT_VALUE
, 0},
2280 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR
, 0},
2281 {":relief", IMAGE_INTEGER_VALUE
, 0},
2282 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
2283 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
2284 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0}
2287 /* Structure describing the image type XBM. */
2289 static struct image_type xbm_type
=
2298 /* Tokens returned from xbm_scan. */
2307 /* Return non-zero if OBJECT is a valid XBM-type image specification.
2308 A valid specification is a list starting with the symbol `image'
2309 The rest of the list is a property list which must contain an
2312 If the specification specifies a file to load, it must contain
2313 an entry `:file FILENAME' where FILENAME is a string.
2315 If the specification is for a bitmap loaded from memory it must
2316 contain `:width WIDTH', `:height HEIGHT', and `:data DATA', where
2317 WIDTH and HEIGHT are integers > 0. DATA may be:
2319 1. a string large enough to hold the bitmap data, i.e. it must
2320 have a size >= (WIDTH + 7) / 8 * HEIGHT
2322 2. a bool-vector of size >= WIDTH * HEIGHT
2324 3. a vector of strings or bool-vectors, one for each line of the
2327 4. a string containing an in-memory XBM file. WIDTH and HEIGHT
2328 may not be specified in this case because they are defined in the
2331 Both the file and data forms may contain the additional entries
2332 `:background COLOR' and `:foreground COLOR'. If not present,
2333 foreground and background of the frame on which the image is
2334 displayed is used. */
2337 xbm_image_p (Lisp_Object object
)
2339 struct image_keyword kw
[XBM_LAST
];
2341 memcpy (kw
, xbm_format
, sizeof kw
);
2342 if (!parse_image_spec (object
, kw
, XBM_LAST
, Qxbm
))
2345 xassert (EQ (kw
[XBM_TYPE
].value
, Qxbm
));
2347 if (kw
[XBM_FILE
].count
)
2349 if (kw
[XBM_WIDTH
].count
|| kw
[XBM_HEIGHT
].count
|| kw
[XBM_DATA
].count
)
2352 else if (kw
[XBM_DATA
].count
&& xbm_file_p (kw
[XBM_DATA
].value
))
2354 /* In-memory XBM file. */
2355 if (kw
[XBM_WIDTH
].count
|| kw
[XBM_HEIGHT
].count
|| kw
[XBM_FILE
].count
)
2363 /* Entries for `:width', `:height' and `:data' must be present. */
2364 if (!kw
[XBM_WIDTH
].count
2365 || !kw
[XBM_HEIGHT
].count
2366 || !kw
[XBM_DATA
].count
)
2369 data
= kw
[XBM_DATA
].value
;
2370 width
= XFASTINT (kw
[XBM_WIDTH
].value
);
2371 height
= XFASTINT (kw
[XBM_HEIGHT
].value
);
2373 /* Check type of data, and width and height against contents of
2379 /* Number of elements of the vector must be >= height. */
2380 if (XVECTOR (data
)->size
< height
)
2383 /* Each string or bool-vector in data must be large enough
2384 for one line of the image. */
2385 for (i
= 0; i
< height
; ++i
)
2387 Lisp_Object elt
= XVECTOR (data
)->contents
[i
];
2392 < (width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
)
2395 else if (BOOL_VECTOR_P (elt
))
2397 if (XBOOL_VECTOR (elt
)->size
< width
)
2404 else if (STRINGP (data
))
2407 < (width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
* height
)
2410 else if (BOOL_VECTOR_P (data
))
2412 if (XBOOL_VECTOR (data
)->size
< width
* height
)
2423 /* Scan a bitmap file. FP is the stream to read from. Value is
2424 either an enumerator from enum xbm_token, or a character for a
2425 single-character token, or 0 at end of file. If scanning an
2426 identifier, store the lexeme of the identifier in SVAL. If
2427 scanning a number, store its value in *IVAL. */
2430 xbm_scan (unsigned char **s
, unsigned char *end
, char *sval
, int *ival
)
2436 /* Skip white space. */
2437 while (*s
< end
&& (c
= *(*s
)++, isspace (c
)))
2442 else if (isdigit (c
))
2444 int value
= 0, digit
;
2446 if (c
== '0' && *s
< end
)
2449 if (c
== 'x' || c
== 'X')
2456 else if (c
>= 'a' && c
<= 'f')
2457 digit
= c
- 'a' + 10;
2458 else if (c
>= 'A' && c
<= 'F')
2459 digit
= c
- 'A' + 10;
2462 value
= 16 * value
+ digit
;
2465 else if (isdigit (c
))
2469 && (c
= *(*s
)++, isdigit (c
)))
2470 value
= 8 * value
+ c
- '0';
2477 && (c
= *(*s
)++, isdigit (c
)))
2478 value
= 10 * value
+ c
- '0';
2486 else if (isalpha (c
) || c
== '_')
2490 && (c
= *(*s
)++, (isalnum (c
) || c
== '_')))
2497 else if (c
== '/' && **s
== '*')
2499 /* C-style comment. */
2501 while (**s
&& (**s
!= '*' || *(*s
+ 1) != '/'))
2515 /* Create a Windows bitmap from X bitmap data. */
2517 w32_create_pixmap_from_bitmap_data (int width
, int height
, char *data
)
2519 static unsigned char swap_nibble
[16]
2520 = { 0x0, 0x8, 0x4, 0xc, /* 0000 1000 0100 1100 */
2521 0x2, 0xa, 0x6, 0xe, /* 0010 1010 0110 1110 */
2522 0x1, 0x9, 0x5, 0xd, /* 0001 1001 0101 1101 */
2523 0x3, 0xb, 0x7, 0xf }; /* 0011 1011 0111 1111 */
2525 unsigned char *bits
, *p
;
2528 w1
= (width
+ 7) / 8; /* nb of 8bits elt in X bitmap */
2529 w2
= ((width
+ 15) / 16) * 2; /* nb of 16bits elt in W32 bitmap */
2530 bits
= (unsigned char *) alloca (height
* w2
);
2531 memset (bits
, 0, height
* w2
);
2532 for (i
= 0; i
< height
; i
++)
2535 for (j
= 0; j
< w1
; j
++)
2537 /* Bitswap XBM bytes to match how Windows does things. */
2538 unsigned char c
= *data
++;
2539 *p
++ = (unsigned char)((swap_nibble
[c
& 0xf] << 4)
2540 | (swap_nibble
[(c
>>4) & 0xf]));
2543 bmp
= CreateBitmap (width
, height
, 1, 1, (char *) bits
);
2549 convert_mono_to_color_image (struct frame
*f
, struct image
*img
,
2550 COLORREF foreground
, COLORREF background
)
2552 HDC hdc
, old_img_dc
, new_img_dc
;
2553 HGDIOBJ old_prev
, new_prev
;
2556 hdc
= get_frame_dc (f
);
2557 old_img_dc
= CreateCompatibleDC (hdc
);
2558 new_img_dc
= CreateCompatibleDC (hdc
);
2559 new_pixmap
= CreateCompatibleBitmap (hdc
, img
->width
, img
->height
);
2560 release_frame_dc (f
, hdc
);
2561 old_prev
= SelectObject (old_img_dc
, img
->pixmap
);
2562 new_prev
= SelectObject (new_img_dc
, new_pixmap
);
2563 /* Windows convention for mono bitmaps is black = background,
2564 white = foreground. */
2565 SetTextColor (new_img_dc
, background
);
2566 SetBkColor (new_img_dc
, foreground
);
2568 BitBlt (new_img_dc
, 0, 0, img
->width
, img
->height
, old_img_dc
,
2571 SelectObject (old_img_dc
, old_prev
);
2572 SelectObject (new_img_dc
, new_prev
);
2573 DeleteDC (old_img_dc
);
2574 DeleteDC (new_img_dc
);
2575 DeleteObject (img
->pixmap
);
2576 if (new_pixmap
== 0)
2577 fprintf (stderr
, "Failed to convert image to color.\n");
2579 img
->pixmap
= new_pixmap
;
2582 #define XBM_BIT_SHUFFLE(b) (~(b))
2586 #define XBM_BIT_SHUFFLE(b) (b)
2588 #endif /* HAVE_NTGUI */
2592 Create_Pixmap_From_Bitmap_Data (struct frame
*f
, struct image
*img
, char *data
,
2593 RGB_PIXEL_COLOR fg
, RGB_PIXEL_COLOR bg
,
2594 int non_default_colors
)
2598 = w32_create_pixmap_from_bitmap_data (img
->width
, img
->height
, data
);
2600 /* If colors were specified, transfer the bitmap to a color one. */
2601 if (non_default_colors
)
2602 convert_mono_to_color_image (f
, img
, fg
, bg
);
2604 #elif defined (HAVE_NS)
2605 img
->pixmap
= ns_image_from_XBM (data
, img
->width
, img
->height
);
2609 = XCreatePixmapFromBitmapData (FRAME_X_DISPLAY (f
),
2612 img
->width
, img
->height
,
2614 DefaultDepthOfScreen (FRAME_X_SCREEN (f
)));
2615 #endif /* !HAVE_NTGUI && !HAVE_NS */
2620 /* Replacement for XReadBitmapFileData which isn't available under old
2621 X versions. CONTENTS is a pointer to a buffer to parse; END is the
2622 buffer's end. Set *WIDTH and *HEIGHT to the width and height of
2623 the image. Return in *DATA the bitmap data allocated with xmalloc.
2624 Value is non-zero if successful. DATA null means just test if
2625 CONTENTS looks like an in-memory XBM file. If INHIBIT_IMAGE_ERROR
2626 is non-zero, inhibit the call to image_error when the image size is
2627 invalid (the bitmap remains unread). */
2630 xbm_read_bitmap_data (struct frame
*f
, unsigned char *contents
, unsigned char *end
,
2631 int *width
, int *height
, unsigned char **data
,
2632 int inhibit_image_error
)
2634 unsigned char *s
= contents
;
2635 char buffer
[BUFSIZ
];
2638 int bytes_per_line
, i
, nbytes
;
2644 LA1 = xbm_scan (&s, end, buffer, &value)
2646 #define expect(TOKEN) \
2647 if (LA1 != (TOKEN)) \
2652 #define expect_ident(IDENT) \
2653 if (LA1 == XBM_TK_IDENT && strcmp (buffer, (IDENT)) == 0) \
2658 *width
= *height
= -1;
2661 LA1
= xbm_scan (&s
, end
, buffer
, &value
);
2663 /* Parse defines for width, height and hot-spots. */
2667 expect_ident ("define");
2668 expect (XBM_TK_IDENT
);
2670 if (LA1
== XBM_TK_NUMBER
)
2672 char *p
= strrchr (buffer
, '_');
2673 p
= p
? p
+ 1 : buffer
;
2674 if (strcmp (p
, "width") == 0)
2676 else if (strcmp (p
, "height") == 0)
2679 expect (XBM_TK_NUMBER
);
2682 if (!check_image_size (f
, *width
, *height
))
2684 if (!inhibit_image_error
)
2685 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
2688 else if (data
== NULL
)
2691 /* Parse bits. Must start with `static'. */
2692 expect_ident ("static");
2693 if (LA1
== XBM_TK_IDENT
)
2695 if (strcmp (buffer
, "unsigned") == 0)
2698 expect_ident ("char");
2700 else if (strcmp (buffer
, "short") == 0)
2704 if (*width
% 16 && *width
% 16 < 9)
2707 else if (strcmp (buffer
, "char") == 0)
2715 expect (XBM_TK_IDENT
);
2721 bytes_per_line
= (*width
+ 7) / 8 + padding_p
;
2722 nbytes
= bytes_per_line
* *height
;
2723 p
= *data
= (unsigned char *) xmalloc (nbytes
);
2727 for (i
= 0; i
< nbytes
; i
+= 2)
2730 expect (XBM_TK_NUMBER
);
2732 *p
++ = XBM_BIT_SHUFFLE (val
);
2733 if (!padding_p
|| ((i
+ 2) % bytes_per_line
))
2734 *p
++ = XBM_BIT_SHUFFLE (value
>> 8);
2736 if (LA1
== ',' || LA1
== '}')
2744 for (i
= 0; i
< nbytes
; ++i
)
2747 expect (XBM_TK_NUMBER
);
2749 *p
++ = XBM_BIT_SHUFFLE (val
);
2751 if (LA1
== ',' || LA1
== '}')
2776 /* Load XBM image IMG which will be displayed on frame F from buffer
2777 CONTENTS. END is the end of the buffer. Value is non-zero if
2781 xbm_load_image (struct frame
*f
, struct image
*img
, unsigned char *contents
,
2785 unsigned char *data
;
2788 rc
= xbm_read_bitmap_data (f
, contents
, end
, &img
->width
, &img
->height
,
2792 unsigned long foreground
= FRAME_FOREGROUND_PIXEL (f
);
2793 unsigned long background
= FRAME_BACKGROUND_PIXEL (f
);
2794 int non_default_colors
= 0;
2797 xassert (img
->width
> 0 && img
->height
> 0);
2799 /* Get foreground and background colors, maybe allocate colors. */
2800 value
= image_spec_value (img
->spec
, QCforeground
, NULL
);
2803 foreground
= x_alloc_image_color (f
, img
, value
, foreground
);
2804 non_default_colors
= 1;
2806 value
= image_spec_value (img
->spec
, QCbackground
, NULL
);
2809 background
= x_alloc_image_color (f
, img
, value
, background
);
2810 img
->background
= background
;
2811 img
->background_valid
= 1;
2812 non_default_colors
= 1;
2815 Create_Pixmap_From_Bitmap_Data (f
, img
, data
,
2816 foreground
, background
,
2817 non_default_colors
);
2820 if (img
->pixmap
== NO_PIXMAP
)
2822 x_clear_image (f
, img
);
2823 image_error ("Unable to create X pixmap for `%s'", img
->spec
, Qnil
);
2829 image_error ("Error loading XBM image `%s'", img
->spec
, Qnil
);
2835 /* Value is non-zero if DATA looks like an in-memory XBM file. */
2838 xbm_file_p (Lisp_Object data
)
2841 return (STRINGP (data
)
2842 && xbm_read_bitmap_data (NULL
, SDATA (data
),
2843 (SDATA (data
) + SBYTES (data
)),
2848 /* Fill image IMG which is used on frame F with pixmap data. Value is
2849 non-zero if successful. */
2852 xbm_load (struct frame
*f
, struct image
*img
)
2855 Lisp_Object file_name
;
2857 xassert (xbm_image_p (img
->spec
));
2859 /* If IMG->spec specifies a file name, create a non-file spec from it. */
2860 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
2861 if (STRINGP (file_name
))
2864 unsigned char *contents
;
2867 file
= x_find_image_file (file_name
);
2868 if (!STRINGP (file
))
2870 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
2874 contents
= slurp_file (SDATA (file
), &size
);
2875 if (contents
== NULL
)
2877 image_error ("Error loading XBM image `%s'", img
->spec
, Qnil
);
2881 success_p
= xbm_load_image (f
, img
, contents
, contents
+ size
);
2885 struct image_keyword fmt
[XBM_LAST
];
2887 unsigned long foreground
= FRAME_FOREGROUND_PIXEL (f
);
2888 unsigned long background
= FRAME_BACKGROUND_PIXEL (f
);
2889 int non_default_colors
= 0;
2892 int in_memory_file_p
= 0;
2894 /* See if data looks like an in-memory XBM file. */
2895 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
2896 in_memory_file_p
= xbm_file_p (data
);
2898 /* Parse the image specification. */
2899 memcpy (fmt
, xbm_format
, sizeof fmt
);
2900 parsed_p
= parse_image_spec (img
->spec
, fmt
, XBM_LAST
, Qxbm
);
2903 /* Get specified width, and height. */
2904 if (!in_memory_file_p
)
2906 img
->width
= XFASTINT (fmt
[XBM_WIDTH
].value
);
2907 img
->height
= XFASTINT (fmt
[XBM_HEIGHT
].value
);
2908 xassert (img
->width
> 0 && img
->height
> 0);
2911 /* Get foreground and background colors, maybe allocate colors. */
2912 if (fmt
[XBM_FOREGROUND
].count
2913 && STRINGP (fmt
[XBM_FOREGROUND
].value
))
2915 foreground
= x_alloc_image_color (f
, img
, fmt
[XBM_FOREGROUND
].value
,
2917 non_default_colors
= 1;
2920 if (fmt
[XBM_BACKGROUND
].count
2921 && STRINGP (fmt
[XBM_BACKGROUND
].value
))
2923 background
= x_alloc_image_color (f
, img
, fmt
[XBM_BACKGROUND
].value
,
2925 non_default_colors
= 1;
2928 if (in_memory_file_p
)
2929 success_p
= xbm_load_image (f
, img
, SDATA (data
),
2938 int nbytes
= (img
->width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
;
2940 p
= bits
= (char *) alloca (nbytes
* img
->height
);
2941 for (i
= 0; i
< img
->height
; ++i
, p
+= nbytes
)
2943 Lisp_Object line
= XVECTOR (data
)->contents
[i
];
2945 memcpy (p
, SDATA (line
), nbytes
);
2947 memcpy (p
, XBOOL_VECTOR (line
)->data
, nbytes
);
2950 else if (STRINGP (data
))
2951 bits
= SDATA (data
);
2953 bits
= XBOOL_VECTOR (data
)->data
;
2959 /* Windows mono bitmaps are reversed compared with X. */
2960 invertedBits
= bits
;
2961 nbytes
= (img
->width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
2963 bits
= (char *) alloca (nbytes
);
2964 for (i
= 0; i
< nbytes
; i
++)
2965 bits
[i
] = XBM_BIT_SHUFFLE (invertedBits
[i
]);
2968 /* Create the pixmap. */
2970 Create_Pixmap_From_Bitmap_Data (f
, img
, bits
,
2971 foreground
, background
,
2972 non_default_colors
);
2977 image_error ("Unable to create pixmap for XBM image `%s'",
2979 x_clear_image (f
, img
);
2989 /***********************************************************************
2991 ***********************************************************************/
2993 #if defined (HAVE_XPM) || defined (HAVE_NS)
2995 static int xpm_image_p (Lisp_Object object
);
2996 static int xpm_load (struct frame
*f
, struct image
*img
);
2997 static int xpm_valid_color_symbols_p (Lisp_Object
);
2999 #endif /* HAVE_XPM || HAVE_NS */
3003 /* Indicate to xpm.h that we don't have Xlib. */
3005 /* simx.h in xpm defines XColor and XImage differently than Emacs. */
3006 /* It also defines Display the same way as Emacs, but gcc 3.3 still barfs. */
3007 #define XColor xpm_XColor
3008 #define XImage xpm_XImage
3009 #define Display xpm_Display
3010 #define PIXEL_ALREADY_TYPEDEFED
3011 #include "X11/xpm.h"
3016 #undef PIXEL_ALREADY_TYPEDEFED
3018 #include "X11/xpm.h"
3019 #endif /* HAVE_NTGUI */
3020 #endif /* HAVE_XPM */
3022 #if defined (HAVE_XPM) || defined (HAVE_NS)
3023 /* The symbol `xpm' identifying XPM-format images. */
3027 /* Indices of image specification fields in xpm_format, below. */
3029 enum xpm_keyword_index
3045 /* Vector of image_keyword structures describing the format
3046 of valid XPM image specifications. */
3048 static const struct image_keyword xpm_format
[XPM_LAST
] =
3050 {":type", IMAGE_SYMBOL_VALUE
, 1},
3051 {":file", IMAGE_STRING_VALUE
, 0},
3052 {":data", IMAGE_STRING_VALUE
, 0},
3053 {":ascent", IMAGE_ASCENT_VALUE
, 0},
3054 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR
, 0},
3055 {":relief", IMAGE_INTEGER_VALUE
, 0},
3056 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3057 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3058 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3059 {":color-symbols", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3060 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
3063 /* Structure describing the image type XPM. */
3065 static struct image_type xpm_type
=
3074 #ifdef HAVE_X_WINDOWS
3076 /* Define ALLOC_XPM_COLORS if we can use Emacs' own color allocation
3077 functions for allocating image colors. Our own functions handle
3078 color allocation failures more gracefully than the ones on the XPM
3081 #if defined XpmAllocColor && defined XpmFreeColors && defined XpmColorClosure
3082 #define ALLOC_XPM_COLORS
3084 #endif /* HAVE_X_WINDOWS */
3086 #ifdef ALLOC_XPM_COLORS
3088 static void xpm_init_color_cache (struct frame
*, XpmAttributes
*);
3089 static void xpm_free_color_cache (void);
3090 static int xpm_lookup_color (struct frame
*, char *, XColor
*);
3091 static int xpm_color_bucket (char *);
3092 static struct xpm_cached_color
*xpm_cache_color (struct frame
*, char *,
3095 /* An entry in a hash table used to cache color definitions of named
3096 colors. This cache is necessary to speed up XPM image loading in
3097 case we do color allocations ourselves. Without it, we would need
3098 a call to XParseColor per pixel in the image. */
3100 struct xpm_cached_color
3102 /* Next in collision chain. */
3103 struct xpm_cached_color
*next
;
3105 /* Color definition (RGB and pixel color). */
3112 /* The hash table used for the color cache, and its bucket vector
3115 #define XPM_COLOR_CACHE_BUCKETS 1001
3116 struct xpm_cached_color
**xpm_color_cache
;
3118 /* Initialize the color cache. */
3121 xpm_init_color_cache (struct frame
*f
, XpmAttributes
*attrs
)
3123 size_t nbytes
= XPM_COLOR_CACHE_BUCKETS
* sizeof *xpm_color_cache
;
3124 xpm_color_cache
= (struct xpm_cached_color
**) xmalloc (nbytes
);
3125 memset (xpm_color_cache
, 0, nbytes
);
3126 init_color_table ();
3128 if (attrs
->valuemask
& XpmColorSymbols
)
3133 for (i
= 0; i
< attrs
->numsymbols
; ++i
)
3134 if (XParseColor (FRAME_X_DISPLAY (f
), FRAME_X_COLORMAP (f
),
3135 attrs
->colorsymbols
[i
].value
, &color
))
3137 color
.pixel
= lookup_rgb_color (f
, color
.red
, color
.green
,
3139 xpm_cache_color (f
, attrs
->colorsymbols
[i
].name
, &color
, -1);
3144 /* Free the color cache. */
3147 xpm_free_color_cache (void)
3149 struct xpm_cached_color
*p
, *next
;
3152 for (i
= 0; i
< XPM_COLOR_CACHE_BUCKETS
; ++i
)
3153 for (p
= xpm_color_cache
[i
]; p
; p
= next
)
3159 xfree (xpm_color_cache
);
3160 xpm_color_cache
= NULL
;
3161 free_color_table ();
3164 /* Return the bucket index for color named COLOR_NAME in the color
3168 xpm_color_bucket (char *color_name
)
3173 for (s
= color_name
; *s
; ++s
)
3175 return h
%= XPM_COLOR_CACHE_BUCKETS
;
3179 /* On frame F, cache values COLOR for color with name COLOR_NAME.
3180 BUCKET, if >= 0, is a precomputed bucket index. Value is the cache
3183 static struct xpm_cached_color
*
3184 xpm_cache_color (struct frame
*f
, char *color_name
, XColor
*color
, int bucket
)
3187 struct xpm_cached_color
*p
;
3190 bucket
= xpm_color_bucket (color_name
);
3192 nbytes
= sizeof *p
+ strlen (color_name
);
3193 p
= (struct xpm_cached_color
*) xmalloc (nbytes
);
3194 strcpy (p
->name
, color_name
);
3196 p
->next
= xpm_color_cache
[bucket
];
3197 xpm_color_cache
[bucket
] = p
;
3201 /* Look up color COLOR_NAME for frame F in the color cache. If found,
3202 return the cached definition in *COLOR. Otherwise, make a new
3203 entry in the cache and allocate the color. Value is zero if color
3204 allocation failed. */
3207 xpm_lookup_color (struct frame
*f
, char *color_name
, XColor
*color
)
3209 struct xpm_cached_color
*p
;
3210 int h
= xpm_color_bucket (color_name
);
3212 for (p
= xpm_color_cache
[h
]; p
; p
= p
->next
)
3213 if (strcmp (p
->name
, color_name
) == 0)
3218 else if (XParseColor (FRAME_X_DISPLAY (f
), FRAME_X_COLORMAP (f
),
3221 color
->pixel
= lookup_rgb_color (f
, color
->red
, color
->green
,
3223 p
= xpm_cache_color (f
, color_name
, color
, h
);
3225 /* You get `opaque' at least from ImageMagick converting pbm to xpm
3226 with transparency, and it's useful. */
3227 else if (strcmp ("opaque", color_name
) == 0)
3229 memset (color
, 0, sizeof (XColor
)); /* Is this necessary/correct? */
3230 color
->pixel
= FRAME_FOREGROUND_PIXEL (f
);
3231 p
= xpm_cache_color (f
, color_name
, color
, h
);
3238 /* Callback for allocating color COLOR_NAME. Called from the XPM lib.
3239 CLOSURE is a pointer to the frame on which we allocate the
3240 color. Return in *COLOR the allocated color. Value is non-zero
3244 xpm_alloc_color (Display
*dpy
, Colormap cmap
, char *color_name
, XColor
*color
,
3247 return xpm_lookup_color ((struct frame
*) closure
, color_name
, color
);
3251 /* Callback for freeing NPIXELS colors contained in PIXELS. CLOSURE
3252 is a pointer to the frame on which we allocate the color. Value is
3253 non-zero if successful. */
3256 xpm_free_colors (Display
*dpy
, Colormap cmap
, Pixel
*pixels
, int npixels
, void *closure
)
3261 #endif /* ALLOC_XPM_COLORS */
3266 /* XPM library details. */
3268 DEF_IMGLIB_FN (XpmFreeAttributes
);
3269 DEF_IMGLIB_FN (XpmCreateImageFromBuffer
);
3270 DEF_IMGLIB_FN (XpmReadFileToImage
);
3271 DEF_IMGLIB_FN (XImageFree
);
3274 init_xpm_functions (Lisp_Object libraries
)
3278 if (!(library
= w32_delayed_load (libraries
, Qxpm
)))
3281 LOAD_IMGLIB_FN (library
, XpmFreeAttributes
);
3282 LOAD_IMGLIB_FN (library
, XpmCreateImageFromBuffer
);
3283 LOAD_IMGLIB_FN (library
, XpmReadFileToImage
);
3284 LOAD_IMGLIB_FN (library
, XImageFree
);
3288 #endif /* HAVE_NTGUI */
3291 /* Value is non-zero if COLOR_SYMBOLS is a valid color symbols list
3292 for XPM images. Such a list must consist of conses whose car and
3296 xpm_valid_color_symbols_p (Lisp_Object color_symbols
)
3298 while (CONSP (color_symbols
))
3300 Lisp_Object sym
= XCAR (color_symbols
);
3302 || !STRINGP (XCAR (sym
))
3303 || !STRINGP (XCDR (sym
)))
3305 color_symbols
= XCDR (color_symbols
);
3308 return NILP (color_symbols
);
3312 /* Value is non-zero if OBJECT is a valid XPM image specification. */
3315 xpm_image_p (Lisp_Object object
)
3317 struct image_keyword fmt
[XPM_LAST
];
3318 memcpy (fmt
, xpm_format
, sizeof fmt
);
3319 return (parse_image_spec (object
, fmt
, XPM_LAST
, Qxpm
)
3320 /* Either `:file' or `:data' must be present. */
3321 && fmt
[XPM_FILE
].count
+ fmt
[XPM_DATA
].count
== 1
3322 /* Either no `:color-symbols' or it's a list of conses
3323 whose car and cdr are strings. */
3324 && (fmt
[XPM_COLOR_SYMBOLS
].count
== 0
3325 || xpm_valid_color_symbols_p (fmt
[XPM_COLOR_SYMBOLS
].value
)));
3328 #endif /* HAVE_XPM || HAVE_NS */
3330 #if defined (HAVE_XPM) && defined (HAVE_X_WINDOWS)
3332 x_create_bitmap_from_xpm_data (struct frame
*f
, char **bits
)
3334 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
3336 XpmAttributes attrs
;
3337 Pixmap bitmap
, mask
;
3339 memset (&attrs
, 0, sizeof attrs
);
3341 attrs
.visual
= FRAME_X_VISUAL (f
);
3342 attrs
.colormap
= FRAME_X_COLORMAP (f
);
3343 attrs
.valuemask
|= XpmVisual
;
3344 attrs
.valuemask
|= XpmColormap
;
3346 rc
= XpmCreatePixmapFromData (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
3347 bits
, &bitmap
, &mask
, &attrs
);
3348 if (rc
!= XpmSuccess
)
3350 XpmFreeAttributes (&attrs
);
3354 id
= x_allocate_bitmap_record (f
);
3355 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
3356 dpyinfo
->bitmaps
[id
- 1].have_mask
= 1;
3357 dpyinfo
->bitmaps
[id
- 1].mask
= mask
;
3358 dpyinfo
->bitmaps
[id
- 1].file
= NULL
;
3359 dpyinfo
->bitmaps
[id
- 1].height
= attrs
.height
;
3360 dpyinfo
->bitmaps
[id
- 1].width
= attrs
.width
;
3361 dpyinfo
->bitmaps
[id
- 1].depth
= attrs
.depth
;
3362 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
3364 XpmFreeAttributes (&attrs
);
3367 #endif /* defined (HAVE_XPM) && defined (HAVE_X_WINDOWS) */
3369 /* Load image IMG which will be displayed on frame F. Value is
3370 non-zero if successful. */
3375 xpm_load (struct frame
*f
, struct image
*img
)
3378 XpmAttributes attrs
;
3379 Lisp_Object specified_file
, color_symbols
;
3382 xpm_XImage
* xpm_image
= NULL
, * xpm_mask
= NULL
;
3383 #endif /* HAVE_NTGUI */
3385 /* Configure the XPM lib. Use the visual of frame F. Allocate
3386 close colors. Return colors allocated. */
3387 memset (&attrs
, 0, sizeof attrs
);
3390 attrs
.visual
= FRAME_X_VISUAL (f
);
3391 attrs
.colormap
= FRAME_X_COLORMAP (f
);
3392 attrs
.valuemask
|= XpmVisual
;
3393 attrs
.valuemask
|= XpmColormap
;
3394 #endif /* HAVE_NTGUI */
3396 #ifdef ALLOC_XPM_COLORS
3397 /* Allocate colors with our own functions which handle
3398 failing color allocation more gracefully. */
3399 attrs
.color_closure
= f
;
3400 attrs
.alloc_color
= xpm_alloc_color
;
3401 attrs
.free_colors
= xpm_free_colors
;
3402 attrs
.valuemask
|= XpmAllocColor
| XpmFreeColors
| XpmColorClosure
;
3403 #else /* not ALLOC_XPM_COLORS */
3404 /* Let the XPM lib allocate colors. */
3405 attrs
.valuemask
|= XpmReturnAllocPixels
;
3406 #ifdef XpmAllocCloseColors
3407 attrs
.alloc_close_colors
= 1;
3408 attrs
.valuemask
|= XpmAllocCloseColors
;
3409 #else /* not XpmAllocCloseColors */
3410 attrs
.closeness
= 600;
3411 attrs
.valuemask
|= XpmCloseness
;
3412 #endif /* not XpmAllocCloseColors */
3413 #endif /* ALLOC_XPM_COLORS */
3415 /* If image specification contains symbolic color definitions, add
3416 these to `attrs'. */
3417 color_symbols
= image_spec_value (img
->spec
, QCcolor_symbols
, NULL
);
3418 if (CONSP (color_symbols
))
3421 XpmColorSymbol
*xpm_syms
;
3424 attrs
.valuemask
|= XpmColorSymbols
;
3426 /* Count number of symbols. */
3427 attrs
.numsymbols
= 0;
3428 for (tail
= color_symbols
; CONSP (tail
); tail
= XCDR (tail
))
3431 /* Allocate an XpmColorSymbol array. */
3432 size
= attrs
.numsymbols
* sizeof *xpm_syms
;
3433 xpm_syms
= (XpmColorSymbol
*) alloca (size
);
3434 memset (xpm_syms
, 0, size
);
3435 attrs
.colorsymbols
= xpm_syms
;
3437 /* Fill the color symbol array. */
3438 for (tail
= color_symbols
, i
= 0;
3440 ++i
, tail
= XCDR (tail
))
3445 if (!CONSP (XCAR (tail
)))
3447 xpm_syms
[i
].name
= "";
3448 xpm_syms
[i
].value
= "";
3451 name
= XCAR (XCAR (tail
));
3452 color
= XCDR (XCAR (tail
));
3455 xpm_syms
[i
].name
= (char *) alloca (SCHARS (name
) + 1);
3456 strcpy (xpm_syms
[i
].name
, SDATA (name
));
3459 xpm_syms
[i
].name
= "";
3460 if (STRINGP (color
))
3462 xpm_syms
[i
].value
= (char *) alloca (SCHARS (color
) + 1);
3463 strcpy (xpm_syms
[i
].value
, SDATA (color
));
3466 xpm_syms
[i
].value
= "";
3470 /* Create a pixmap for the image, either from a file, or from a
3471 string buffer containing data in the same format as an XPM file. */
3472 #ifdef ALLOC_XPM_COLORS
3473 xpm_init_color_cache (f
, &attrs
);
3476 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
3480 HDC frame_dc
= get_frame_dc (f
);
3481 hdc
= CreateCompatibleDC (frame_dc
);
3482 release_frame_dc (f
, frame_dc
);
3484 #endif /* HAVE_NTGUI */
3486 if (STRINGP (specified_file
))
3488 Lisp_Object file
= x_find_image_file (specified_file
);
3489 if (!STRINGP (file
))
3491 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
3492 #ifdef ALLOC_XPM_COLORS
3493 xpm_free_color_cache ();
3499 /* XpmReadFileToPixmap is not available in the Windows port of
3500 libxpm. But XpmReadFileToImage almost does what we want. */
3501 rc
= fn_XpmReadFileToImage (&hdc
, SDATA (file
),
3502 &xpm_image
, &xpm_mask
,
3505 rc
= XpmReadFileToPixmap (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
3506 SDATA (file
), &img
->pixmap
, &img
->mask
,
3508 #endif /* HAVE_NTGUI */
3512 Lisp_Object buffer
= image_spec_value (img
->spec
, QCdata
, NULL
);
3513 if (!STRINGP (buffer
))
3515 image_error ("Invalid image data `%s'", buffer
, Qnil
);
3516 #ifdef ALLOC_XPM_COLORS
3517 xpm_free_color_cache ();
3522 /* XpmCreatePixmapFromBuffer is not available in the Windows port
3523 of libxpm. But XpmCreateImageFromBuffer almost does what we want. */
3524 rc
= fn_XpmCreateImageFromBuffer (&hdc
, SDATA (buffer
),
3525 &xpm_image
, &xpm_mask
,
3528 rc
= XpmCreatePixmapFromBuffer (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
3530 &img
->pixmap
, &img
->mask
,
3532 #endif /* HAVE_NTGUI */
3535 if (rc
== XpmSuccess
)
3537 #if defined (COLOR_TABLE_SUPPORT) && defined (ALLOC_XPM_COLORS)
3538 img
->colors
= colors_in_color_table (&img
->ncolors
);
3539 #else /* not ALLOC_XPM_COLORS */
3543 /* W32 XPM uses XImage to wrap what W32 Emacs calls a Pixmap,
3544 plus some duplicate attributes. */
3545 if (xpm_image
&& xpm_image
->bitmap
)
3547 img
->pixmap
= xpm_image
->bitmap
;
3548 /* XImageFree in libXpm frees XImage struct without destroying
3549 the bitmap, which is what we want. */
3550 fn_XImageFree (xpm_image
);
3552 if (xpm_mask
&& xpm_mask
->bitmap
)
3554 /* The mask appears to be inverted compared with what we expect.
3555 TODO: invert our expectations. See other places where we
3556 have to invert bits because our idea of masks is backwards. */
3558 old_obj
= SelectObject (hdc
, xpm_mask
->bitmap
);
3560 PatBlt (hdc
, 0, 0, xpm_mask
->width
, xpm_mask
->height
, DSTINVERT
);
3561 SelectObject (hdc
, old_obj
);
3563 img
->mask
= xpm_mask
->bitmap
;
3564 fn_XImageFree (xpm_mask
);
3569 #endif /* HAVE_NTGUI */
3571 /* Remember allocated colors. */
3572 img
->ncolors
= attrs
.nalloc_pixels
;
3573 img
->colors
= (unsigned long *) xmalloc (img
->ncolors
3574 * sizeof *img
->colors
);
3575 for (i
= 0; i
< attrs
.nalloc_pixels
; ++i
)
3577 img
->colors
[i
] = attrs
.alloc_pixels
[i
];
3578 #ifdef DEBUG_X_COLORS
3579 register_color (img
->colors
[i
]);
3582 #endif /* not ALLOC_XPM_COLORS */
3584 img
->width
= attrs
.width
;
3585 img
->height
= attrs
.height
;
3586 xassert (img
->width
> 0 && img
->height
> 0);
3588 /* The call to XpmFreeAttributes below frees attrs.alloc_pixels. */
3590 fn_XpmFreeAttributes (&attrs
);
3592 XpmFreeAttributes (&attrs
);
3593 #endif /* HAVE_NTGUI */
3599 #endif /* HAVE_NTGUI */
3604 image_error ("Error opening XPM file (%s)", img
->spec
, Qnil
);
3607 case XpmFileInvalid
:
3608 image_error ("Invalid XPM file (%s)", img
->spec
, Qnil
);
3612 image_error ("Out of memory (%s)", img
->spec
, Qnil
);
3615 case XpmColorFailed
:
3616 image_error ("Color allocation error (%s)", img
->spec
, Qnil
);
3620 image_error ("Unknown error (%s)", img
->spec
, Qnil
);
3625 #ifdef ALLOC_XPM_COLORS
3626 xpm_free_color_cache ();
3628 return rc
== XpmSuccess
;
3631 #endif /* HAVE_XPM */
3633 #if defined (HAVE_NS) && !defined (HAVE_XPM)
3635 /* XPM support functions for NS where libxpm is not available.
3636 Only XPM version 3 (without any extensions) is supported. */
3638 static int xpm_scan (const unsigned char **, const unsigned char *,
3639 const unsigned char **, int *);
3640 static Lisp_Object xpm_make_color_table_v
3641 (void (**) (Lisp_Object
, const unsigned char *, int, Lisp_Object
),
3642 Lisp_Object (**) (Lisp_Object
, const unsigned char *, int));
3643 static void xpm_put_color_table_v (Lisp_Object
, const unsigned char *,
3645 static Lisp_Object
xpm_get_color_table_v (Lisp_Object
,
3646 const unsigned char *, int);
3647 static Lisp_Object xpm_make_color_table_h
3648 (void (**) (Lisp_Object
, const unsigned char *, int, Lisp_Object
),
3649 Lisp_Object (**) (Lisp_Object
, const unsigned char *, int));
3650 static void xpm_put_color_table_h (Lisp_Object
, const unsigned char *,
3652 static Lisp_Object
xpm_get_color_table_h (Lisp_Object
,
3653 const unsigned char *, int);
3654 static int xpm_str_to_color_key (const char *);
3655 static int xpm_load_image (struct frame
*, struct image
*,
3656 const unsigned char *, const unsigned char *);
3658 /* Tokens returned from xpm_scan. */
3667 /* Scan an XPM data and return a character (< 256) or a token defined
3668 by enum xpm_token above. *S and END are the start (inclusive) and
3669 the end (exclusive) addresses of the data, respectively. Advance
3670 *S while scanning. If token is either XPM_TK_IDENT or
3671 XPM_TK_STRING, *BEG and *LEN are set to the start address and the
3672 length of the corresponding token, respectively. */
3675 xpm_scan (const unsigned char **s
,
3676 const unsigned char *end
,
3677 const unsigned char **beg
,
3684 /* Skip white-space. */
3685 while (*s
< end
&& (c
= *(*s
)++, isspace (c
)))
3688 /* gnus-pointer.xpm uses '-' in its identifier.
3689 sb-dir-plus.xpm uses '+' in its identifier. */
3690 if (isalpha (c
) || c
== '_' || c
== '-' || c
== '+')
3694 && (c
= **s
, isalnum (c
) || c
== '_' || c
== '-' || c
== '+'))
3697 return XPM_TK_IDENT
;
3702 while (*s
< end
&& **s
!= '"')
3707 return XPM_TK_STRING
;
3711 if (*s
< end
&& **s
== '*')
3713 /* C-style comment. */
3717 while (*s
< end
&& *(*s
)++ != '*')
3720 while (*s
< end
&& **s
!= '/');
3734 /* Functions for color table lookup in XPM data. A key is a string
3735 specifying the color of each pixel in XPM data. A value is either
3736 an integer that specifies a pixel color, Qt that specifies
3737 transparency, or Qnil for the unspecified color. If the length of
3738 the key string is one, a vector is used as a table. Otherwise, a
3739 hash table is used. */
3742 xpm_make_color_table_v (void (**put_func
) (Lisp_Object
,
3743 const unsigned char *,
3746 Lisp_Object (**get_func
) (Lisp_Object
,
3747 const unsigned char *,
3750 *put_func
= xpm_put_color_table_v
;
3751 *get_func
= xpm_get_color_table_v
;
3752 return Fmake_vector (make_number (256), Qnil
);
3756 xpm_put_color_table_v (Lisp_Object color_table
,
3757 const unsigned char *chars_start
,
3761 XVECTOR (color_table
)->contents
[*chars_start
] = color
;
3765 xpm_get_color_table_v (Lisp_Object color_table
,
3766 const unsigned char *chars_start
,
3769 return XVECTOR (color_table
)->contents
[*chars_start
];
3773 xpm_make_color_table_h (void (**put_func
) (Lisp_Object
,
3774 const unsigned char *,
3777 Lisp_Object (**get_func
) (Lisp_Object
,
3778 const unsigned char *,
3781 *put_func
= xpm_put_color_table_h
;
3782 *get_func
= xpm_get_color_table_h
;
3783 return make_hash_table (Qequal
, make_number (DEFAULT_HASH_SIZE
),
3784 make_float (DEFAULT_REHASH_SIZE
),
3785 make_float (DEFAULT_REHASH_THRESHOLD
),
3790 xpm_put_color_table_h (Lisp_Object color_table
,
3791 const unsigned char *chars_start
,
3795 struct Lisp_Hash_Table
*table
= XHASH_TABLE (color_table
);
3797 Lisp_Object chars
= make_unibyte_string (chars_start
, chars_len
);
3799 hash_lookup (table
, chars
, &hash_code
);
3800 hash_put (table
, chars
, color
, hash_code
);
3804 xpm_get_color_table_h (Lisp_Object color_table
,
3805 const unsigned char *chars_start
,
3808 struct Lisp_Hash_Table
*table
= XHASH_TABLE (color_table
);
3809 int i
= hash_lookup (table
, make_unibyte_string (chars_start
, chars_len
),
3812 return i
>= 0 ? HASH_VALUE (table
, i
) : Qnil
;
3815 enum xpm_color_key
{
3823 static const char xpm_color_key_strings
[][4] = {"s", "m", "g4", "g", "c"};
3826 xpm_str_to_color_key (const char *s
)
3831 i
< sizeof xpm_color_key_strings
/ sizeof xpm_color_key_strings
[0];
3833 if (strcmp (xpm_color_key_strings
[i
], s
) == 0)
3839 xpm_load_image (struct frame
*f
,
3841 const unsigned char *contents
,
3842 const unsigned char *end
)
3844 const unsigned char *s
= contents
, *beg
, *str
;
3845 unsigned char buffer
[BUFSIZ
];
3846 int width
, height
, x
, y
;
3847 int num_colors
, chars_per_pixel
;
3849 void (*put_color_table
) (Lisp_Object
, const unsigned char *, int, Lisp_Object
);
3850 Lisp_Object (*get_color_table
) (Lisp_Object
, const unsigned char *, int);
3851 Lisp_Object frame
, color_symbols
, color_table
;
3852 int best_key
, have_mask
= 0;
3853 XImagePtr ximg
= NULL
, mask_img
= NULL
;
3856 LA1 = xpm_scan (&s, end, &beg, &len)
3858 #define expect(TOKEN) \
3859 if (LA1 != (TOKEN)) \
3864 #define expect_ident(IDENT) \
3865 if (LA1 == XPM_TK_IDENT \
3866 && strlen ((IDENT)) == len && memcmp ((IDENT), beg, len) == 0) \
3871 if (!(end
- s
>= 9 && memcmp (s
, "/* XPM */", 9) == 0))
3875 expect_ident ("static");
3876 expect_ident ("char");
3878 expect (XPM_TK_IDENT
);
3883 expect (XPM_TK_STRING
);
3886 memcpy (buffer
, beg
, len
);
3888 if (sscanf (buffer
, "%d %d %d %d", &width
, &height
,
3889 &num_colors
, &chars_per_pixel
) != 4
3890 || width
<= 0 || height
<= 0
3891 || num_colors
<= 0 || chars_per_pixel
<= 0)
3894 if (!check_image_size (f
, width
, height
))
3896 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
3902 XSETFRAME (frame
, f
);
3903 if (!NILP (Fxw_display_color_p (frame
)))
3904 best_key
= XPM_COLOR_KEY_C
;
3905 else if (!NILP (Fx_display_grayscale_p (frame
)))
3906 best_key
= (XFASTINT (Fx_display_planes (frame
)) > 2
3907 ? XPM_COLOR_KEY_G
: XPM_COLOR_KEY_G4
);
3909 best_key
= XPM_COLOR_KEY_M
;
3911 color_symbols
= image_spec_value (img
->spec
, QCcolor_symbols
, NULL
);
3912 if (chars_per_pixel
== 1)
3913 color_table
= xpm_make_color_table_v (&put_color_table
,
3916 color_table
= xpm_make_color_table_h (&put_color_table
,
3919 while (num_colors
-- > 0)
3921 unsigned char *color
, *max_color
;
3922 int key
, next_key
, max_key
= 0;
3923 Lisp_Object symbol_color
= Qnil
, color_val
;
3926 expect (XPM_TK_STRING
);
3927 if (len
<= chars_per_pixel
|| len
>= BUFSIZ
+ chars_per_pixel
)
3929 memcpy (buffer
, beg
+ chars_per_pixel
, len
- chars_per_pixel
);
3930 buffer
[len
- chars_per_pixel
] = '\0';
3932 str
= strtok (buffer
, " \t");
3935 key
= xpm_str_to_color_key (str
);
3940 color
= strtok (NULL
, " \t");
3944 while ((str
= strtok (NULL
, " \t")) != NULL
)
3946 next_key
= xpm_str_to_color_key (str
);
3949 color
[strlen (color
)] = ' ';
3952 if (key
== XPM_COLOR_KEY_S
)
3954 if (NILP (symbol_color
))
3955 symbol_color
= build_string (color
);
3957 else if (max_key
< key
&& key
<= best_key
)
3967 if (!NILP (color_symbols
) && !NILP (symbol_color
))
3969 Lisp_Object specified_color
= Fassoc (symbol_color
, color_symbols
);
3971 if (CONSP (specified_color
) && STRINGP (XCDR (specified_color
)))
3973 if (xstrcasecmp (SDATA (XCDR (specified_color
)), "None") == 0)
3975 else if (x_defined_color (f
, SDATA (XCDR (specified_color
)),
3977 color_val
= make_number (cdef
.pixel
);
3980 if (NILP (color_val
) && max_key
> 0)
3982 if (xstrcasecmp (max_color
, "None") == 0)
3984 else if (x_defined_color (f
, max_color
, &cdef
, 0))
3985 color_val
= make_number (cdef
.pixel
);
3987 if (!NILP (color_val
))
3988 (*put_color_table
) (color_table
, beg
, chars_per_pixel
, color_val
);
3993 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0,
3994 &ximg
, &img
->pixmap
)
3996 || !x_create_x_image_and_pixmap (f
, width
, height
, 1,
3997 &mask_img
, &img
->mask
)
4001 image_error ("Out of memory (%s)", img
->spec
, Qnil
);
4005 for (y
= 0; y
< height
; y
++)
4007 expect (XPM_TK_STRING
);
4009 if (len
< width
* chars_per_pixel
)
4011 for (x
= 0; x
< width
; x
++, str
+= chars_per_pixel
)
4013 Lisp_Object color_val
=
4014 (*get_color_table
) (color_table
, str
, chars_per_pixel
);
4016 XPutPixel (ximg
, x
, y
,
4017 (INTEGERP (color_val
) ? XINT (color_val
)
4018 : FRAME_FOREGROUND_PIXEL (f
)));
4020 XPutPixel (mask_img
, x
, y
,
4021 (!EQ (color_val
, Qt
) ? PIX_MASK_DRAW
4022 : (have_mask
= 1, PIX_MASK_RETAIN
)));
4024 if (EQ (color_val
, Qt
))
4025 ns_set_alpha (ximg
, x
, y
, 0);
4033 img
->height
= height
;
4035 /* Maybe fill in the background field while we have ximg handy. */
4036 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
4037 IMAGE_BACKGROUND (img
, f
, ximg
);
4039 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
4040 x_destroy_x_image (ximg
);
4044 /* Fill in the background_transparent field while we have the
4046 image_background_transparent (img
, f
, mask_img
);
4048 x_put_x_image (f
, mask_img
, img
->mask
, width
, height
);
4049 x_destroy_x_image (mask_img
);
4053 x_destroy_x_image (mask_img
);
4054 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->mask
);
4055 img
->mask
= NO_PIXMAP
;
4061 image_error ("Invalid XPM file (%s)", img
->spec
, Qnil
);
4063 x_destroy_x_image (ximg
);
4064 x_destroy_x_image (mask_img
);
4065 x_clear_image (f
, img
);
4074 xpm_load (struct frame
*f
,
4078 Lisp_Object file_name
;
4080 /* If IMG->spec specifies a file name, create a non-file spec from it. */
4081 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
4082 if (STRINGP (file_name
))
4085 unsigned char *contents
;
4088 file
= x_find_image_file (file_name
);
4089 if (!STRINGP (file
))
4091 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
4095 contents
= slurp_file (SDATA (file
), &size
);
4096 if (contents
== NULL
)
4098 image_error ("Error loading XPM image `%s'", img
->spec
, Qnil
);
4102 success_p
= xpm_load_image (f
, img
, contents
, contents
+ size
);
4109 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
4110 if (!STRINGP (data
))
4112 image_error ("Invalid image data `%s'", data
, Qnil
);
4115 success_p
= xpm_load_image (f
, img
, SDATA (data
),
4116 SDATA (data
) + SBYTES (data
));
4122 #endif /* HAVE_NS && !HAVE_XPM */
4126 /***********************************************************************
4128 ***********************************************************************/
4130 #ifdef COLOR_TABLE_SUPPORT
4132 /* An entry in the color table mapping an RGB color to a pixel color. */
4137 unsigned long pixel
;
4139 /* Next in color table collision list. */
4140 struct ct_color
*next
;
4143 /* The bucket vector size to use. Must be prime. */
4147 /* Value is a hash of the RGB color given by R, G, and B. */
4149 #define CT_HASH_RGB(R, G, B) (((R) << 16) ^ ((G) << 8) ^ (B))
4151 /* The color hash table. */
4153 struct ct_color
**ct_table
;
4155 /* Number of entries in the color table. */
4157 int ct_colors_allocated
;
4159 /* Initialize the color table. */
4162 init_color_table (void)
4164 int size
= CT_SIZE
* sizeof (*ct_table
);
4165 ct_table
= (struct ct_color
**) xmalloc (size
);
4166 memset (ct_table
, 0, size
);
4167 ct_colors_allocated
= 0;
4171 /* Free memory associated with the color table. */
4174 free_color_table (void)
4177 struct ct_color
*p
, *next
;
4179 for (i
= 0; i
< CT_SIZE
; ++i
)
4180 for (p
= ct_table
[i
]; p
; p
= next
)
4191 /* Value is a pixel color for RGB color R, G, B on frame F. If an
4192 entry for that color already is in the color table, return the
4193 pixel color of that entry. Otherwise, allocate a new color for R,
4194 G, B, and make an entry in the color table. */
4196 static unsigned long
4197 lookup_rgb_color (struct frame
*f
, int r
, int g
, int b
)
4199 unsigned hash
= CT_HASH_RGB (r
, g
, b
);
4200 int i
= hash
% CT_SIZE
;
4202 Display_Info
*dpyinfo
;
4204 /* Handle TrueColor visuals specially, which improves performance by
4205 two orders of magnitude. Freeing colors on TrueColor visuals is
4206 a nop, and pixel colors specify RGB values directly. See also
4207 the Xlib spec, chapter 3.1. */
4208 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
4209 if (dpyinfo
->red_bits
> 0)
4211 unsigned long pr
, pg
, pb
;
4213 /* Apply gamma-correction like normal color allocation does. */
4217 color
.red
= r
, color
.green
= g
, color
.blue
= b
;
4218 gamma_correct (f
, &color
);
4219 r
= color
.red
, g
= color
.green
, b
= color
.blue
;
4222 /* Scale down RGB values to the visual's bits per RGB, and shift
4223 them to the right position in the pixel color. Note that the
4224 original RGB values are 16-bit values, as usual in X. */
4225 pr
= (r
>> (16 - dpyinfo
->red_bits
)) << dpyinfo
->red_offset
;
4226 pg
= (g
>> (16 - dpyinfo
->green_bits
)) << dpyinfo
->green_offset
;
4227 pb
= (b
>> (16 - dpyinfo
->blue_bits
)) << dpyinfo
->blue_offset
;
4229 /* Assemble the pixel color. */
4230 return pr
| pg
| pb
;
4233 for (p
= ct_table
[i
]; p
; p
= p
->next
)
4234 if (p
->r
== r
&& p
->g
== g
&& p
->b
== b
)
4240 #ifdef HAVE_X_WINDOWS
4249 cmap
= FRAME_X_COLORMAP (f
);
4250 rc
= x_alloc_nearest_color (f
, cmap
, &color
);
4253 ++ct_colors_allocated
;
4254 p
= (struct ct_color
*) xmalloc (sizeof *p
);
4258 p
->pixel
= color
.pixel
;
4259 p
->next
= ct_table
[i
];
4263 return FRAME_FOREGROUND_PIXEL (f
);
4268 color
= PALETTERGB (r
, g
, b
);
4270 color
= RGB_TO_ULONG (r
, g
, b
);
4271 #endif /* HAVE_NTGUI */
4272 ++ct_colors_allocated
;
4273 p
= (struct ct_color
*) xmalloc (sizeof *p
);
4278 p
->next
= ct_table
[i
];
4280 #endif /* HAVE_X_WINDOWS */
4288 /* Look up pixel color PIXEL which is used on frame F in the color
4289 table. If not already present, allocate it. Value is PIXEL. */
4291 static unsigned long
4292 lookup_pixel_color (struct frame
*f
, unsigned long pixel
)
4294 int i
= pixel
% CT_SIZE
;
4297 for (p
= ct_table
[i
]; p
; p
= p
->next
)
4298 if (p
->pixel
== pixel
)
4307 #ifdef HAVE_X_WINDOWS
4308 cmap
= FRAME_X_COLORMAP (f
);
4309 color
.pixel
= pixel
;
4310 x_query_color (f
, &color
);
4311 rc
= x_alloc_nearest_color (f
, cmap
, &color
);
4314 cmap
= DefaultColormapOfScreen (FRAME_X_SCREEN (f
));
4315 color
.pixel
= pixel
;
4316 XQueryColor (NULL
, cmap
, &color
);
4317 rc
= x_alloc_nearest_color (f
, cmap
, &color
);
4319 #endif /* HAVE_X_WINDOWS */
4323 ++ct_colors_allocated
;
4325 p
= (struct ct_color
*) xmalloc (sizeof *p
);
4330 p
->next
= ct_table
[i
];
4334 return FRAME_FOREGROUND_PIXEL (f
);
4340 /* Value is a vector of all pixel colors contained in the color table,
4341 allocated via xmalloc. Set *N to the number of colors. */
4343 static unsigned long *
4344 colors_in_color_table (int *n
)
4348 unsigned long *colors
;
4350 if (ct_colors_allocated
== 0)
4357 colors
= (unsigned long *) xmalloc (ct_colors_allocated
4359 *n
= ct_colors_allocated
;
4361 for (i
= j
= 0; i
< CT_SIZE
; ++i
)
4362 for (p
= ct_table
[i
]; p
; p
= p
->next
)
4363 colors
[j
++] = p
->pixel
;
4369 #else /* COLOR_TABLE_SUPPORT */
4371 static unsigned long
4372 lookup_rgb_color (struct frame
*f
, int r
, int g
, int b
)
4374 unsigned long pixel
;
4377 pixel
= PALETTERGB (r
>> 8, g
>> 8, b
>> 8);
4378 #endif /* HAVE_NTGUI */
4381 pixel
= RGB_TO_ULONG (r
>> 8, g
>> 8, b
>> 8);
4382 #endif /* HAVE_NS */
4387 init_color_table (void)
4390 #endif /* COLOR_TABLE_SUPPORT */
4393 /***********************************************************************
4395 ***********************************************************************/
4397 static XColor
*x_to_xcolors (struct frame
*, struct image
*, int);
4398 static void x_from_xcolors (struct frame
*, struct image
*, XColor
*);
4399 static void x_detect_edges (struct frame
*, struct image
*, int[9], int);
4402 static void XPutPixel (XImagePtr
, int, int, COLORREF
);
4403 #endif /* HAVE_NTGUI */
4405 /* Non-zero means draw a cross on images having `:conversion
4408 int cross_disabled_images
;
4410 /* Edge detection matrices for different edge-detection
4413 static int emboss_matrix
[9] = {
4415 2, -1, 0, /* y - 1 */
4417 0, 1, -2 /* y + 1 */
4420 static int laplace_matrix
[9] = {
4422 1, 0, 0, /* y - 1 */
4424 0, 0, -1 /* y + 1 */
4427 /* Value is the intensity of the color whose red/green/blue values
4430 #define COLOR_INTENSITY(R, G, B) ((2 * (R) + 3 * (G) + (B)) / 6)
4433 /* On frame F, return an array of XColor structures describing image
4434 IMG->pixmap. Each XColor structure has its pixel color set. RGB_P
4435 non-zero means also fill the red/green/blue members of the XColor
4436 structures. Value is a pointer to the array of XColors structures,
4437 allocated with xmalloc; it must be freed by the caller. */
4440 x_to_xcolors (struct frame
*f
, struct image
*img
, int rgb_p
)
4444 XImagePtr_or_DC ximg
;
4448 #endif /* HAVE_NTGUI */
4450 colors
= (XColor
*) xmalloc (img
->width
* img
->height
* sizeof *colors
);
4453 /* Get the X image IMG->pixmap. */
4454 ximg
= XGetImage (FRAME_X_DISPLAY (f
), img
->pixmap
,
4455 0, 0, img
->width
, img
->height
, ~0, ZPixmap
);
4457 /* Load the image into a memory device context. */
4458 hdc
= get_frame_dc (f
);
4459 ximg
= CreateCompatibleDC (hdc
);
4460 release_frame_dc (f
, hdc
);
4461 prev
= SelectObject (ximg
, img
->pixmap
);
4462 #endif /* HAVE_NTGUI */
4464 /* Fill the `pixel' members of the XColor array. I wished there
4465 were an easy and portable way to circumvent XGetPixel. */
4467 for (y
= 0; y
< img
->height
; ++y
)
4471 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI)
4472 for (x
= 0; x
< img
->width
; ++x
, ++p
)
4473 p
->pixel
= GET_PIXEL (ximg
, x
, y
);
4475 x_query_colors (f
, row
, img
->width
);
4479 for (x
= 0; x
< img
->width
; ++x
, ++p
)
4481 /* W32_TODO: palette support needed here? */
4482 p
->pixel
= GET_PIXEL (ximg
, x
, y
);
4485 p
->red
= RED16_FROM_ULONG (p
->pixel
);
4486 p
->green
= GREEN16_FROM_ULONG (p
->pixel
);
4487 p
->blue
= BLUE16_FROM_ULONG (p
->pixel
);
4490 #endif /* HAVE_X_WINDOWS */
4493 Destroy_Image (ximg
, prev
);
4500 /* Put a pixel of COLOR at position X, Y in XIMG. XIMG must have been
4501 created with CreateDIBSection, with the pointer to the bit values
4502 stored in ximg->data. */
4505 XPutPixel (XImagePtr ximg
, int x
, int y
, COLORREF color
)
4507 int width
= ximg
->info
.bmiHeader
.biWidth
;
4508 int height
= ximg
->info
.bmiHeader
.biHeight
;
4509 unsigned char * pixel
;
4511 /* True color images. */
4512 if (ximg
->info
.bmiHeader
.biBitCount
== 24)
4514 int rowbytes
= width
* 3;
4515 /* Ensure scanlines are aligned on 4 byte boundaries. */
4517 rowbytes
+= 4 - (rowbytes
% 4);
4519 pixel
= ximg
->data
+ y
* rowbytes
+ x
* 3;
4520 /* Windows bitmaps are in BGR order. */
4521 *pixel
= GetBValue (color
);
4522 *(pixel
+ 1) = GetGValue (color
);
4523 *(pixel
+ 2) = GetRValue (color
);
4525 /* Monochrome images. */
4526 else if (ximg
->info
.bmiHeader
.biBitCount
== 1)
4528 int rowbytes
= width
/ 8;
4529 /* Ensure scanlines are aligned on 4 byte boundaries. */
4531 rowbytes
+= 4 - (rowbytes
% 4);
4532 pixel
= ximg
->data
+ y
* rowbytes
+ x
/ 8;
4533 /* Filter out palette info. */
4534 if (color
& 0x00ffffff)
4535 *pixel
= *pixel
| (1 << x
% 8);
4537 *pixel
= *pixel
& ~(1 << x
% 8);
4540 image_error ("XPutPixel: palette image not supported", Qnil
, Qnil
);
4543 #endif /* HAVE_NTGUI */
4545 /* Create IMG->pixmap from an array COLORS of XColor structures, whose
4546 RGB members are set. F is the frame on which this all happens.
4547 COLORS will be freed; an existing IMG->pixmap will be freed, too. */
4550 x_from_xcolors (struct frame
*f
, struct image
*img
, XColor
*colors
)
4553 XImagePtr oimg
= NULL
;
4557 init_color_table ();
4559 x_create_x_image_and_pixmap (f
, img
->width
, img
->height
, 0,
4562 for (y
= 0; y
< img
->height
; ++y
)
4563 for (x
= 0; x
< img
->width
; ++x
, ++p
)
4565 unsigned long pixel
;
4566 pixel
= lookup_rgb_color (f
, p
->red
, p
->green
, p
->blue
);
4567 XPutPixel (oimg
, x
, y
, pixel
);
4571 x_clear_image_1 (f
, img
, 1, 0, 1);
4573 x_put_x_image (f
, oimg
, pixmap
, img
->width
, img
->height
);
4574 x_destroy_x_image (oimg
);
4575 img
->pixmap
= pixmap
;
4576 #ifdef COLOR_TABLE_SUPPORT
4577 img
->colors
= colors_in_color_table (&img
->ncolors
);
4578 free_color_table ();
4579 #endif /* COLOR_TABLE_SUPPORT */
4583 /* On frame F, perform edge-detection on image IMG.
4585 MATRIX is a nine-element array specifying the transformation
4586 matrix. See emboss_matrix for an example.
4588 COLOR_ADJUST is a color adjustment added to each pixel of the
4592 x_detect_edges (struct frame
*f
, struct image
*img
, int *matrix
, int color_adjust
)
4594 XColor
*colors
= x_to_xcolors (f
, img
, 1);
4598 for (i
= sum
= 0; i
< 9; ++i
)
4599 sum
+= eabs (matrix
[i
]);
4601 #define COLOR(A, X, Y) ((A) + (Y) * img->width + (X))
4603 new = (XColor
*) xmalloc (img
->width
* img
->height
* sizeof *new);
4605 for (y
= 0; y
< img
->height
; ++y
)
4607 p
= COLOR (new, 0, y
);
4608 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4609 p
= COLOR (new, img
->width
- 1, y
);
4610 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4613 for (x
= 1; x
< img
->width
- 1; ++x
)
4615 p
= COLOR (new, x
, 0);
4616 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4617 p
= COLOR (new, x
, img
->height
- 1);
4618 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4621 for (y
= 1; y
< img
->height
- 1; ++y
)
4623 p
= COLOR (new, 1, y
);
4625 for (x
= 1; x
< img
->width
- 1; ++x
, ++p
)
4627 int r
, g
, b
, y1
, x1
;
4630 for (y1
= y
- 1; y1
< y
+ 2; ++y1
)
4631 for (x1
= x
- 1; x1
< x
+ 2; ++x1
, ++i
)
4634 XColor
*t
= COLOR (colors
, x1
, y1
);
4635 r
+= matrix
[i
] * t
->red
;
4636 g
+= matrix
[i
] * t
->green
;
4637 b
+= matrix
[i
] * t
->blue
;
4640 r
= (r
/ sum
+ color_adjust
) & 0xffff;
4641 g
= (g
/ sum
+ color_adjust
) & 0xffff;
4642 b
= (b
/ sum
+ color_adjust
) & 0xffff;
4643 p
->red
= p
->green
= p
->blue
= COLOR_INTENSITY (r
, g
, b
);
4648 x_from_xcolors (f
, img
, new);
4654 /* Perform the pre-defined `emboss' edge-detection on image IMG
4658 x_emboss (struct frame
*f
, struct image
*img
)
4660 x_detect_edges (f
, img
, emboss_matrix
, 0xffff / 2);
4664 /* Transform image IMG which is used on frame F with a Laplace
4665 edge-detection algorithm. The result is an image that can be used
4666 to draw disabled buttons, for example. */
4669 x_laplace (struct frame
*f
, struct image
*img
)
4671 x_detect_edges (f
, img
, laplace_matrix
, 45000);
4675 /* Perform edge-detection on image IMG on frame F, with specified
4676 transformation matrix MATRIX and color-adjustment COLOR_ADJUST.
4678 MATRIX must be either
4680 - a list of at least 9 numbers in row-major form
4681 - a vector of at least 9 numbers
4683 COLOR_ADJUST nil means use a default; otherwise it must be a
4687 x_edge_detection (struct frame
*f
, struct image
*img
, Lisp_Object matrix
,
4688 Lisp_Object color_adjust
)
4696 i
< 9 && CONSP (matrix
) && NUMBERP (XCAR (matrix
));
4697 ++i
, matrix
= XCDR (matrix
))
4698 trans
[i
] = XFLOATINT (XCAR (matrix
));
4700 else if (VECTORP (matrix
) && ASIZE (matrix
) >= 9)
4702 for (i
= 0; i
< 9 && NUMBERP (AREF (matrix
, i
)); ++i
)
4703 trans
[i
] = XFLOATINT (AREF (matrix
, i
));
4706 if (NILP (color_adjust
))
4707 color_adjust
= make_number (0xffff / 2);
4709 if (i
== 9 && NUMBERP (color_adjust
))
4710 x_detect_edges (f
, img
, trans
, (int) XFLOATINT (color_adjust
));
4714 /* Transform image IMG on frame F so that it looks disabled. */
4717 x_disable_image (struct frame
*f
, struct image
*img
)
4719 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
4721 int n_planes
= dpyinfo
->n_planes
* dpyinfo
->n_cbits
;
4723 int n_planes
= dpyinfo
->n_planes
;
4724 #endif /* HAVE_NTGUI */
4728 /* Color (or grayscale). Convert to gray, and equalize. Just
4729 drawing such images with a stipple can look very odd, so
4730 we're using this method instead. */
4731 XColor
*colors
= x_to_xcolors (f
, img
, 1);
4733 const int h
= 15000;
4734 const int l
= 30000;
4736 for (p
= colors
, end
= colors
+ img
->width
* img
->height
;
4740 int i
= COLOR_INTENSITY (p
->red
, p
->green
, p
->blue
);
4741 int i2
= (0xffff - h
- l
) * i
/ 0xffff + l
;
4742 p
->red
= p
->green
= p
->blue
= i2
;
4745 x_from_xcolors (f
, img
, colors
);
4748 /* Draw a cross over the disabled image, if we must or if we
4750 if (n_planes
< 2 || cross_disabled_images
)
4753 Display
*dpy
= FRAME_X_DISPLAY (f
);
4756 #ifndef HAVE_NS /* TODO: NS support, however this not needed for toolbars */
4758 #define MaskForeground(f) WHITE_PIX_DEFAULT (f)
4760 gc
= XCreateGC (dpy
, img
->pixmap
, 0, NULL
);
4761 XSetForeground (dpy
, gc
, BLACK_PIX_DEFAULT (f
));
4762 XDrawLine (dpy
, img
->pixmap
, gc
, 0, 0,
4763 img
->width
- 1, img
->height
- 1);
4764 XDrawLine (dpy
, img
->pixmap
, gc
, 0, img
->height
- 1,
4770 gc
= XCreateGC (dpy
, img
->mask
, 0, NULL
);
4771 XSetForeground (dpy
, gc
, MaskForeground (f
));
4772 XDrawLine (dpy
, img
->mask
, gc
, 0, 0,
4773 img
->width
- 1, img
->height
- 1);
4774 XDrawLine (dpy
, img
->mask
, gc
, 0, img
->height
- 1,
4778 #endif /* !HAVE_NS */
4783 hdc
= get_frame_dc (f
);
4784 bmpdc
= CreateCompatibleDC (hdc
);
4785 release_frame_dc (f
, hdc
);
4787 prev
= SelectObject (bmpdc
, img
->pixmap
);
4789 SetTextColor (bmpdc
, BLACK_PIX_DEFAULT (f
));
4790 MoveToEx (bmpdc
, 0, 0, NULL
);
4791 LineTo (bmpdc
, img
->width
- 1, img
->height
- 1);
4792 MoveToEx (bmpdc
, 0, img
->height
- 1, NULL
);
4793 LineTo (bmpdc
, img
->width
- 1, 0);
4797 SelectObject (bmpdc
, img
->mask
);
4798 SetTextColor (bmpdc
, WHITE_PIX_DEFAULT (f
));
4799 MoveToEx (bmpdc
, 0, 0, NULL
);
4800 LineTo (bmpdc
, img
->width
- 1, img
->height
- 1);
4801 MoveToEx (bmpdc
, 0, img
->height
- 1, NULL
);
4802 LineTo (bmpdc
, img
->width
- 1, 0);
4804 SelectObject (bmpdc
, prev
);
4806 #endif /* HAVE_NTGUI */
4811 /* Build a mask for image IMG which is used on frame F. FILE is the
4812 name of an image file, for error messages. HOW determines how to
4813 determine the background color of IMG. If it is a list '(R G B)',
4814 with R, G, and B being integers >= 0, take that as the color of the
4815 background. Otherwise, determine the background color of IMG
4816 heuristically. Value is non-zero if successful. */
4819 x_build_heuristic_mask (struct frame
*f
, struct image
*img
, Lisp_Object how
)
4821 XImagePtr_or_DC ximg
;
4829 #endif /* HAVE_NTGUI */
4830 int x
, y
, rc
, use_img_background
;
4831 unsigned long bg
= 0;
4835 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->mask
);
4836 img
->mask
= NO_PIXMAP
;
4837 img
->background_transparent_valid
= 0;
4842 /* Create an image and pixmap serving as mask. */
4843 rc
= x_create_x_image_and_pixmap (f
, img
->width
, img
->height
, 1,
4844 &mask_img
, &img
->mask
);
4847 #endif /* !HAVE_NS */
4849 /* Get the X image of IMG->pixmap. */
4850 ximg
= XGetImage (FRAME_X_DISPLAY (f
), img
->pixmap
, 0, 0,
4851 img
->width
, img
->height
,
4854 /* Create the bit array serving as mask. */
4855 row_width
= (img
->width
+ 7) / 8;
4856 mask_img
= xmalloc (row_width
* img
->height
);
4857 memset (mask_img
, 0, row_width
* img
->height
);
4859 /* Create a memory device context for IMG->pixmap. */
4860 frame_dc
= get_frame_dc (f
);
4861 ximg
= CreateCompatibleDC (frame_dc
);
4862 release_frame_dc (f
, frame_dc
);
4863 prev
= SelectObject (ximg
, img
->pixmap
);
4864 #endif /* HAVE_NTGUI */
4866 /* Determine the background color of ximg. If HOW is `(R G B)'
4867 take that as color. Otherwise, use the image's background color. */
4868 use_img_background
= 1;
4874 for (i
= 0; i
< 3 && CONSP (how
) && NATNUMP (XCAR (how
)); ++i
)
4876 rgb
[i
] = XFASTINT (XCAR (how
)) & 0xffff;
4880 if (i
== 3 && NILP (how
))
4882 char color_name
[30];
4883 sprintf (color_name
, "#%04x%04x%04x", rgb
[0], rgb
[1], rgb
[2]);
4886 0x00ffffff & /* Filter out palette info. */
4887 #endif /* HAVE_NTGUI */
4888 x_alloc_image_color (f
, img
, build_string (color_name
), 0));
4889 use_img_background
= 0;
4893 if (use_img_background
)
4894 bg
= four_corners_best (ximg
, img
->corners
, img
->width
, img
->height
);
4896 /* Set all bits in mask_img to 1 whose color in ximg is different
4897 from the background color bg. */
4899 for (y
= 0; y
< img
->height
; ++y
)
4900 for (x
= 0; x
< img
->width
; ++x
)
4902 XPutPixel (mask_img
, x
, y
, (XGetPixel (ximg
, x
, y
) != bg
4903 ? PIX_MASK_DRAW
: PIX_MASK_RETAIN
));
4905 if (XGetPixel (ximg
, x
, y
) == bg
)
4906 ns_set_alpha (ximg
, x
, y
, 0);
4907 #endif /* HAVE_NS */
4909 /* Fill in the background_transparent field while we have the mask handy. */
4910 image_background_transparent (img
, f
, mask_img
);
4912 /* Put mask_img into img->mask. */
4913 x_put_x_image (f
, mask_img
, img
->mask
, img
->width
, img
->height
);
4914 x_destroy_x_image (mask_img
);
4915 #endif /* !HAVE_NS */
4917 for (y
= 0; y
< img
->height
; ++y
)
4918 for (x
= 0; x
< img
->width
; ++x
)
4920 COLORREF p
= GetPixel (ximg
, x
, y
);
4922 mask_img
[y
* row_width
+ x
/ 8] |= 1 << (x
% 8);
4925 /* Create the mask image. */
4926 img
->mask
= w32_create_pixmap_from_bitmap_data (img
->width
, img
->height
,
4928 /* Fill in the background_transparent field while we have the mask handy. */
4929 SelectObject (ximg
, img
->mask
);
4930 image_background_transparent (img
, f
, ximg
);
4932 /* Was: x_destroy_x_image ((XImagePtr )mask_img); which seems bogus ++kfs */
4934 #endif /* HAVE_NTGUI */
4936 Destroy_Image (ximg
, prev
);
4942 /***********************************************************************
4943 PBM (mono, gray, color)
4944 ***********************************************************************/
4946 static int pbm_image_p (Lisp_Object object
);
4947 static int pbm_load (struct frame
*f
, struct image
*img
);
4948 static int pbm_scan_number (unsigned char **, unsigned char *);
4950 /* The symbol `pbm' identifying images of this type. */
4954 /* Indices of image specification fields in gs_format, below. */
4956 enum pbm_keyword_index
4972 /* Vector of image_keyword structures describing the format
4973 of valid user-defined image specifications. */
4975 static const struct image_keyword pbm_format
[PBM_LAST
] =
4977 {":type", IMAGE_SYMBOL_VALUE
, 1},
4978 {":file", IMAGE_STRING_VALUE
, 0},
4979 {":data", IMAGE_STRING_VALUE
, 0},
4980 {":ascent", IMAGE_ASCENT_VALUE
, 0},
4981 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR
, 0},
4982 {":relief", IMAGE_INTEGER_VALUE
, 0},
4983 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
4984 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
4985 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
4986 {":foreground", IMAGE_STRING_OR_NIL_VALUE
, 0},
4987 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
4990 /* Structure describing the image type `pbm'. */
4992 static struct image_type pbm_type
=
5002 /* Return non-zero if OBJECT is a valid PBM image specification. */
5005 pbm_image_p (Lisp_Object object
)
5007 struct image_keyword fmt
[PBM_LAST
];
5009 memcpy (fmt
, pbm_format
, sizeof fmt
);
5011 if (!parse_image_spec (object
, fmt
, PBM_LAST
, Qpbm
))
5014 /* Must specify either :data or :file. */
5015 return fmt
[PBM_DATA
].count
+ fmt
[PBM_FILE
].count
== 1;
5019 /* Scan a decimal number from *S and return it. Advance *S while
5020 reading the number. END is the end of the string. Value is -1 at
5024 pbm_scan_number (unsigned char **s
, unsigned char *end
)
5026 int c
= 0, val
= -1;
5030 /* Skip white-space. */
5031 while (*s
< end
&& (c
= *(*s
)++, isspace (c
)))
5036 /* Skip comment to end of line. */
5037 while (*s
< end
&& (c
= *(*s
)++, c
!= '\n'))
5040 else if (isdigit (c
))
5042 /* Read decimal number. */
5044 while (*s
< end
&& (c
= *(*s
)++, isdigit (c
)))
5045 val
= 10 * val
+ c
- '0';
5057 #if 0 /* Unused. ++kfs */
5059 /* Read FILE into memory. Value is a pointer to a buffer allocated
5060 with xmalloc holding FILE's contents. Value is null if an error
5061 occurred. *SIZE is set to the size of the file. */
5064 pbm_read_file (file
, size
)
5072 if (stat (SDATA (file
), &st
) == 0
5073 && (fp
= fopen (SDATA (file
), "rb")) != NULL
5074 && (buf
= (char *) xmalloc (st
.st_size
),
5075 fread (buf
, 1, st
.st_size
, fp
) == st
.st_size
))
5094 #endif /* HAVE_NTGUI */
5096 /* Load PBM image IMG for use on frame F. */
5099 pbm_load (struct frame
*f
, struct image
*img
)
5102 int width
, height
, max_color_idx
= 0;
5104 Lisp_Object file
, specified_file
;
5105 enum {PBM_MONO
, PBM_GRAY
, PBM_COLOR
} type
;
5106 unsigned char *contents
= NULL
;
5107 unsigned char *end
, *p
;
5110 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
5112 if (STRINGP (specified_file
))
5114 file
= x_find_image_file (specified_file
);
5115 if (!STRINGP (file
))
5117 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
5121 contents
= slurp_file (SDATA (file
), &size
);
5122 if (contents
== NULL
)
5124 image_error ("Error reading `%s'", file
, Qnil
);
5129 end
= contents
+ size
;
5134 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
5135 if (!STRINGP (data
))
5137 image_error ("Invalid image data `%s'", data
, Qnil
);
5141 end
= p
+ SBYTES (data
);
5144 /* Check magic number. */
5145 if (end
- p
< 2 || *p
++ != 'P')
5147 image_error ("Not a PBM image: `%s'", img
->spec
, Qnil
);
5156 raw_p
= 0, type
= PBM_MONO
;
5160 raw_p
= 0, type
= PBM_GRAY
;
5164 raw_p
= 0, type
= PBM_COLOR
;
5168 raw_p
= 1, type
= PBM_MONO
;
5172 raw_p
= 1, type
= PBM_GRAY
;
5176 raw_p
= 1, type
= PBM_COLOR
;
5180 image_error ("Not a PBM image: `%s'", img
->spec
, Qnil
);
5184 /* Read width, height, maximum color-component. Characters
5185 starting with `#' up to the end of a line are ignored. */
5186 width
= pbm_scan_number (&p
, end
);
5187 height
= pbm_scan_number (&p
, end
);
5189 if (type
!= PBM_MONO
)
5191 max_color_idx
= pbm_scan_number (&p
, end
);
5192 if (max_color_idx
> 65535 || max_color_idx
< 0)
5194 image_error ("Unsupported maximum PBM color value", Qnil
, Qnil
);
5199 if (!check_image_size (f
, width
, height
))
5201 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
5205 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0,
5206 &ximg
, &img
->pixmap
))
5209 /* Initialize the color hash table. */
5210 init_color_table ();
5212 if (type
== PBM_MONO
)
5215 struct image_keyword fmt
[PBM_LAST
];
5216 unsigned long fg
= FRAME_FOREGROUND_PIXEL (f
);
5217 unsigned long bg
= FRAME_BACKGROUND_PIXEL (f
);
5219 /* Parse the image specification. */
5220 memcpy (fmt
, pbm_format
, sizeof fmt
);
5221 parse_image_spec (img
->spec
, fmt
, PBM_LAST
, Qpbm
);
5223 /* Get foreground and background colors, maybe allocate colors. */
5224 if (fmt
[PBM_FOREGROUND
].count
5225 && STRINGP (fmt
[PBM_FOREGROUND
].value
))
5226 fg
= x_alloc_image_color (f
, img
, fmt
[PBM_FOREGROUND
].value
, fg
);
5227 if (fmt
[PBM_BACKGROUND
].count
5228 && STRINGP (fmt
[PBM_BACKGROUND
].value
))
5230 bg
= x_alloc_image_color (f
, img
, fmt
[PBM_BACKGROUND
].value
, bg
);
5231 img
->background
= bg
;
5232 img
->background_valid
= 1;
5235 for (y
= 0; y
< height
; ++y
)
5236 for (x
= 0; x
< width
; ++x
)
5244 x_destroy_x_image (ximg
);
5245 x_clear_image (f
, img
);
5246 image_error ("Invalid image size in image `%s'",
5256 g
= pbm_scan_number (&p
, end
);
5258 XPutPixel (ximg
, x
, y
, g
? fg
: bg
);
5263 int expected_size
= height
* width
;
5264 if (max_color_idx
> 255)
5266 if (type
== PBM_COLOR
)
5269 if (raw_p
&& p
+ expected_size
> end
)
5271 x_destroy_x_image (ximg
);
5272 x_clear_image (f
, img
);
5273 image_error ("Invalid image size in image `%s'",
5278 for (y
= 0; y
< height
; ++y
)
5279 for (x
= 0; x
< width
; ++x
)
5283 if (type
== PBM_GRAY
&& raw_p
)
5286 if (max_color_idx
> 255)
5287 r
= g
= b
= r
* 256 + *p
++;
5289 else if (type
== PBM_GRAY
)
5290 r
= g
= b
= pbm_scan_number (&p
, end
);
5294 if (max_color_idx
> 255)
5297 if (max_color_idx
> 255)
5300 if (max_color_idx
> 255)
5305 r
= pbm_scan_number (&p
, end
);
5306 g
= pbm_scan_number (&p
, end
);
5307 b
= pbm_scan_number (&p
, end
);
5310 if (r
< 0 || g
< 0 || b
< 0)
5312 x_destroy_x_image (ximg
);
5313 image_error ("Invalid pixel value in image `%s'",
5318 /* RGB values are now in the range 0..max_color_idx.
5319 Scale this to the range 0..0xffff supported by X. */
5320 r
= (double) r
* 65535 / max_color_idx
;
5321 g
= (double) g
* 65535 / max_color_idx
;
5322 b
= (double) b
* 65535 / max_color_idx
;
5323 XPutPixel (ximg
, x
, y
, lookup_rgb_color (f
, r
, g
, b
));
5327 #ifdef COLOR_TABLE_SUPPORT
5328 /* Store in IMG->colors the colors allocated for the image, and
5329 free the color table. */
5330 img
->colors
= colors_in_color_table (&img
->ncolors
);
5331 free_color_table ();
5332 #endif /* COLOR_TABLE_SUPPORT */
5335 img
->height
= height
;
5337 /* Maybe fill in the background field while we have ximg handy. */
5339 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
5340 /* Casting avoids a GCC warning. */
5341 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
5343 /* Put the image into a pixmap. */
5344 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
5345 x_destroy_x_image (ximg
);
5347 /* X and W32 versions did it here, MAC version above. ++kfs
5349 img->height = height; */
5356 /***********************************************************************
5358 ***********************************************************************/
5360 #if defined (HAVE_PNG) || defined (HAVE_NS)
5362 /* Function prototypes. */
5364 static int png_image_p (Lisp_Object object
);
5365 static int png_load (struct frame
*f
, struct image
*img
);
5367 /* The symbol `png' identifying images of this type. */
5371 /* Indices of image specification fields in png_format, below. */
5373 enum png_keyword_index
5388 /* Vector of image_keyword structures describing the format
5389 of valid user-defined image specifications. */
5391 static const struct image_keyword png_format
[PNG_LAST
] =
5393 {":type", IMAGE_SYMBOL_VALUE
, 1},
5394 {":data", IMAGE_STRING_VALUE
, 0},
5395 {":file", IMAGE_STRING_VALUE
, 0},
5396 {":ascent", IMAGE_ASCENT_VALUE
, 0},
5397 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR
, 0},
5398 {":relief", IMAGE_INTEGER_VALUE
, 0},
5399 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5400 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5401 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5402 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
5405 /* Structure describing the image type `png'. */
5407 static struct image_type png_type
=
5416 /* Return non-zero if OBJECT is a valid PNG image specification. */
5419 png_image_p (Lisp_Object object
)
5421 struct image_keyword fmt
[PNG_LAST
];
5422 memcpy (fmt
, png_format
, sizeof fmt
);
5424 if (!parse_image_spec (object
, fmt
, PNG_LAST
, Qpng
))
5427 /* Must specify either the :data or :file keyword. */
5428 return fmt
[PNG_FILE
].count
+ fmt
[PNG_DATA
].count
== 1;
5431 #endif /* HAVE_PNG || HAVE_NS */
5437 /* PNG library details. */
5439 DEF_IMGLIB_FN (png_get_io_ptr
);
5440 DEF_IMGLIB_FN (png_sig_cmp
);
5441 DEF_IMGLIB_FN (png_create_read_struct
);
5442 DEF_IMGLIB_FN (png_create_info_struct
);
5443 DEF_IMGLIB_FN (png_destroy_read_struct
);
5444 DEF_IMGLIB_FN (png_set_read_fn
);
5445 DEF_IMGLIB_FN (png_set_sig_bytes
);
5446 DEF_IMGLIB_FN (png_read_info
);
5447 DEF_IMGLIB_FN (png_get_IHDR
);
5448 DEF_IMGLIB_FN (png_get_valid
);
5449 DEF_IMGLIB_FN (png_set_strip_16
);
5450 DEF_IMGLIB_FN (png_set_expand
);
5451 DEF_IMGLIB_FN (png_set_gray_to_rgb
);
5452 DEF_IMGLIB_FN (png_set_background
);
5453 DEF_IMGLIB_FN (png_get_bKGD
);
5454 DEF_IMGLIB_FN (png_read_update_info
);
5455 DEF_IMGLIB_FN (png_get_channels
);
5456 DEF_IMGLIB_FN (png_get_rowbytes
);
5457 DEF_IMGLIB_FN (png_read_image
);
5458 DEF_IMGLIB_FN (png_read_end
);
5459 DEF_IMGLIB_FN (png_error
);
5462 init_png_functions (Lisp_Object libraries
)
5466 /* Try loading libpng under probable names. */
5467 if (!(library
= w32_delayed_load (libraries
, Qpng
)))
5470 LOAD_IMGLIB_FN (library
, png_get_io_ptr
);
5471 LOAD_IMGLIB_FN (library
, png_sig_cmp
);
5472 LOAD_IMGLIB_FN (library
, png_create_read_struct
);
5473 LOAD_IMGLIB_FN (library
, png_create_info_struct
);
5474 LOAD_IMGLIB_FN (library
, png_destroy_read_struct
);
5475 LOAD_IMGLIB_FN (library
, png_set_read_fn
);
5476 LOAD_IMGLIB_FN (library
, png_set_sig_bytes
);
5477 LOAD_IMGLIB_FN (library
, png_read_info
);
5478 LOAD_IMGLIB_FN (library
, png_get_IHDR
);
5479 LOAD_IMGLIB_FN (library
, png_get_valid
);
5480 LOAD_IMGLIB_FN (library
, png_set_strip_16
);
5481 LOAD_IMGLIB_FN (library
, png_set_expand
);
5482 LOAD_IMGLIB_FN (library
, png_set_gray_to_rgb
);
5483 LOAD_IMGLIB_FN (library
, png_set_background
);
5484 LOAD_IMGLIB_FN (library
, png_get_bKGD
);
5485 LOAD_IMGLIB_FN (library
, png_read_update_info
);
5486 LOAD_IMGLIB_FN (library
, png_get_channels
);
5487 LOAD_IMGLIB_FN (library
, png_get_rowbytes
);
5488 LOAD_IMGLIB_FN (library
, png_read_image
);
5489 LOAD_IMGLIB_FN (library
, png_read_end
);
5490 LOAD_IMGLIB_FN (library
, png_error
);
5495 #define fn_png_get_io_ptr png_get_io_ptr
5496 #define fn_png_sig_cmp png_sig_cmp
5497 #define fn_png_create_read_struct png_create_read_struct
5498 #define fn_png_create_info_struct png_create_info_struct
5499 #define fn_png_destroy_read_struct png_destroy_read_struct
5500 #define fn_png_set_read_fn png_set_read_fn
5501 #define fn_png_set_sig_bytes png_set_sig_bytes
5502 #define fn_png_read_info png_read_info
5503 #define fn_png_get_IHDR png_get_IHDR
5504 #define fn_png_get_valid png_get_valid
5505 #define fn_png_set_strip_16 png_set_strip_16
5506 #define fn_png_set_expand png_set_expand
5507 #define fn_png_set_gray_to_rgb png_set_gray_to_rgb
5508 #define fn_png_set_background png_set_background
5509 #define fn_png_get_bKGD png_get_bKGD
5510 #define fn_png_read_update_info png_read_update_info
5511 #define fn_png_get_channels png_get_channels
5512 #define fn_png_get_rowbytes png_get_rowbytes
5513 #define fn_png_read_image png_read_image
5514 #define fn_png_read_end png_read_end
5515 #define fn_png_error png_error
5517 #endif /* HAVE_NTGUI */
5519 /* Error and warning handlers installed when the PNG library
5523 my_png_error (png_struct
*png_ptr
, const char *msg
)
5525 xassert (png_ptr
!= NULL
);
5526 image_error ("PNG error: %s", build_string (msg
), Qnil
);
5527 longjmp (png_ptr
->jmpbuf
, 1);
5532 my_png_warning (png_struct
*png_ptr
, const char *msg
)
5534 xassert (png_ptr
!= NULL
);
5535 image_error ("PNG warning: %s", build_string (msg
), Qnil
);
5538 /* Memory source for PNG decoding. */
5540 struct png_memory_storage
5542 unsigned char *bytes
; /* The data */
5543 size_t len
; /* How big is it? */
5544 int index
; /* Where are we? */
5548 /* Function set as reader function when reading PNG image from memory.
5549 PNG_PTR is a pointer to the PNG control structure. Copy LENGTH
5550 bytes from the input to DATA. */
5553 png_read_from_memory (png_structp png_ptr
, png_bytep data
, png_size_t length
)
5555 struct png_memory_storage
*tbr
5556 = (struct png_memory_storage
*) fn_png_get_io_ptr (png_ptr
);
5558 if (length
> tbr
->len
- tbr
->index
)
5559 fn_png_error (png_ptr
, "Read error");
5561 memcpy (data
, tbr
->bytes
+ tbr
->index
, length
);
5562 tbr
->index
= tbr
->index
+ length
;
5566 /* Function set as reader function when reading PNG image from a file.
5567 PNG_PTR is a pointer to the PNG control structure. Copy LENGTH
5568 bytes from the input to DATA. */
5571 png_read_from_file (png_structp png_ptr
, png_bytep data
, png_size_t length
)
5573 FILE *fp
= (FILE *) fn_png_get_io_ptr (png_ptr
);
5575 if (fread (data
, 1, length
, fp
) < length
)
5576 fn_png_error (png_ptr
, "Read error");
5580 /* Load PNG image IMG for use on frame F. Value is non-zero if
5584 png_load (struct frame
*f
, struct image
*img
)
5586 Lisp_Object file
, specified_file
;
5587 Lisp_Object specified_data
;
5589 XImagePtr ximg
, mask_img
= NULL
;
5590 png_struct
*png_ptr
= NULL
;
5591 png_info
*info_ptr
= NULL
, *end_info
= NULL
;
5592 FILE *volatile fp
= NULL
;
5594 png_byte
* volatile pixels
= NULL
;
5595 png_byte
** volatile rows
= NULL
;
5596 png_uint_32 width
, height
;
5597 int bit_depth
, color_type
, interlace_type
;
5599 png_uint_32 row_bytes
;
5601 struct png_memory_storage tbr
; /* Data to be read */
5603 /* Find out what file to load. */
5604 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
5605 specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
5607 if (NILP (specified_data
))
5609 file
= x_find_image_file (specified_file
);
5610 if (!STRINGP (file
))
5612 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
5616 /* Open the image file. */
5617 fp
= fopen (SDATA (file
), "rb");
5620 image_error ("Cannot open image file `%s'", file
, Qnil
);
5624 /* Check PNG signature. */
5625 if (fread (sig
, 1, sizeof sig
, fp
) != sizeof sig
5626 || fn_png_sig_cmp (sig
, 0, sizeof sig
))
5628 image_error ("Not a PNG file: `%s'", file
, Qnil
);
5635 if (!STRINGP (specified_data
))
5637 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
5641 /* Read from memory. */
5642 tbr
.bytes
= SDATA (specified_data
);
5643 tbr
.len
= SBYTES (specified_data
);
5646 /* Check PNG signature. */
5647 if (tbr
.len
< sizeof sig
5648 || fn_png_sig_cmp (tbr
.bytes
, 0, sizeof sig
))
5650 image_error ("Not a PNG image: `%s'", img
->spec
, Qnil
);
5654 /* Need to skip past the signature. */
5655 tbr
.bytes
+= sizeof (sig
);
5658 /* Initialize read and info structs for PNG lib. Casting return
5659 value avoids a GCC warning on W32. */
5660 png_ptr
= (png_structp
)fn_png_create_read_struct (PNG_LIBPNG_VER_STRING
,
5665 if (fp
) fclose (fp
);
5669 /* Casting return value avoids a GCC warning on W32. */
5670 info_ptr
= (png_infop
)fn_png_create_info_struct (png_ptr
);
5673 fn_png_destroy_read_struct (&png_ptr
, NULL
, NULL
);
5674 if (fp
) fclose (fp
);
5678 /* Casting return value avoids a GCC warning on W32. */
5679 end_info
= (png_infop
)fn_png_create_info_struct (png_ptr
);
5682 fn_png_destroy_read_struct (&png_ptr
, &info_ptr
, NULL
);
5683 if (fp
) fclose (fp
);
5687 /* Set error jump-back. We come back here when the PNG library
5688 detects an error. */
5689 if (setjmp (png_ptr
->jmpbuf
))
5693 fn_png_destroy_read_struct (&png_ptr
, &info_ptr
, &end_info
);
5696 if (fp
) fclose (fp
);
5700 /* Read image info. */
5701 if (!NILP (specified_data
))
5702 fn_png_set_read_fn (png_ptr
, (void *) &tbr
, png_read_from_memory
);
5704 fn_png_set_read_fn (png_ptr
, (void *) fp
, png_read_from_file
);
5706 fn_png_set_sig_bytes (png_ptr
, sizeof sig
);
5707 fn_png_read_info (png_ptr
, info_ptr
);
5708 fn_png_get_IHDR (png_ptr
, info_ptr
, &width
, &height
, &bit_depth
, &color_type
,
5709 &interlace_type
, NULL
, NULL
);
5711 if (!check_image_size (f
, width
, height
))
5713 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
5716 /* If image contains simply transparency data, we prefer to
5717 construct a clipping mask. */
5718 if (fn_png_get_valid (png_ptr
, info_ptr
, PNG_INFO_tRNS
))
5723 /* This function is easier to write if we only have to handle
5724 one data format: RGB or RGBA with 8 bits per channel. Let's
5725 transform other formats into that format. */
5727 /* Strip more than 8 bits per channel. */
5728 if (bit_depth
== 16)
5729 fn_png_set_strip_16 (png_ptr
);
5731 /* Expand data to 24 bit RGB, or 8 bit grayscale, with alpha channel
5733 fn_png_set_expand (png_ptr
);
5735 /* Convert grayscale images to RGB. */
5736 if (color_type
== PNG_COLOR_TYPE_GRAY
5737 || color_type
== PNG_COLOR_TYPE_GRAY_ALPHA
)
5738 fn_png_set_gray_to_rgb (png_ptr
);
5740 /* Handle alpha channel by combining the image with a background
5741 color. Do this only if a real alpha channel is supplied. For
5742 simple transparency, we prefer a clipping mask. */
5745 /* png_color_16 *image_bg; */
5746 Lisp_Object specified_bg
5747 = image_spec_value (img
->spec
, QCbackground
, NULL
);
5748 int shift
= (bit_depth
== 16) ? 0 : 8;
5750 if (STRINGP (specified_bg
))
5751 /* The user specified `:background', use that. */
5754 if (x_defined_color (f
, SDATA (specified_bg
), &color
, 0))
5756 png_color_16 user_bg
;
5758 memset (&user_bg
, 0, sizeof user_bg
);
5759 user_bg
.red
= color
.red
>> shift
;
5760 user_bg
.green
= color
.green
>> shift
;
5761 user_bg
.blue
= color
.blue
>> shift
;
5763 fn_png_set_background (png_ptr
, &user_bg
,
5764 PNG_BACKGROUND_GAMMA_SCREEN
, 0, 1.0);
5769 /* We use the current frame background, ignoring any default
5770 background color set by the image. */
5771 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI)
5773 png_color_16 frame_background
;
5775 color
.pixel
= FRAME_BACKGROUND_PIXEL (f
);
5776 x_query_color (f
, &color
);
5778 memset (&frame_background
, 0, sizeof frame_background
);
5779 frame_background
.red
= color
.red
>> shift
;
5780 frame_background
.green
= color
.green
>> shift
;
5781 frame_background
.blue
= color
.blue
>> shift
;
5782 #endif /* HAVE_X_WINDOWS */
5784 fn_png_set_background (png_ptr
, &frame_background
,
5785 PNG_BACKGROUND_GAMMA_SCREEN
, 0, 1.0);
5789 /* Update info structure. */
5790 fn_png_read_update_info (png_ptr
, info_ptr
);
5792 /* Get number of channels. Valid values are 1 for grayscale images
5793 and images with a palette, 2 for grayscale images with transparency
5794 information (alpha channel), 3 for RGB images, and 4 for RGB
5795 images with alpha channel, i.e. RGBA. If conversions above were
5796 sufficient we should only have 3 or 4 channels here. */
5797 channels
= fn_png_get_channels (png_ptr
, info_ptr
);
5798 xassert (channels
== 3 || channels
== 4);
5800 /* Number of bytes needed for one row of the image. */
5801 row_bytes
= fn_png_get_rowbytes (png_ptr
, info_ptr
);
5803 /* Allocate memory for the image. */
5804 pixels
= (png_byte
*) xmalloc (row_bytes
* height
* sizeof *pixels
);
5805 rows
= (png_byte
**) xmalloc (height
* sizeof *rows
);
5806 for (i
= 0; i
< height
; ++i
)
5807 rows
[i
] = pixels
+ i
* row_bytes
;
5809 /* Read the entire image. */
5810 fn_png_read_image (png_ptr
, rows
);
5811 fn_png_read_end (png_ptr
, info_ptr
);
5818 /* Create the X image and pixmap. */
5819 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0, &ximg
,
5823 /* Create an image and pixmap serving as mask if the PNG image
5824 contains an alpha channel. */
5827 && !x_create_x_image_and_pixmap (f
, width
, height
, 1,
5828 &mask_img
, &img
->mask
))
5830 x_destroy_x_image (ximg
);
5831 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->pixmap
);
5832 img
->pixmap
= NO_PIXMAP
;
5836 /* Fill the X image and mask from PNG data. */
5837 init_color_table ();
5839 for (y
= 0; y
< height
; ++y
)
5841 png_byte
*p
= rows
[y
];
5843 for (x
= 0; x
< width
; ++x
)
5850 XPutPixel (ximg
, x
, y
, lookup_rgb_color (f
, r
, g
, b
));
5851 /* An alpha channel, aka mask channel, associates variable
5852 transparency with an image. Where other image formats
5853 support binary transparency---fully transparent or fully
5854 opaque---PNG allows up to 254 levels of partial transparency.
5855 The PNG library implements partial transparency by combining
5856 the image with a specified background color.
5858 I'm not sure how to handle this here nicely: because the
5859 background on which the image is displayed may change, for
5860 real alpha channel support, it would be necessary to create
5861 a new image for each possible background.
5863 What I'm doing now is that a mask is created if we have
5864 boolean transparency information. Otherwise I'm using
5865 the frame's background color to combine the image with. */
5870 XPutPixel (mask_img
, x
, y
, *p
> 0 ? PIX_MASK_DRAW
: PIX_MASK_RETAIN
);
5876 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
5877 /* Set IMG's background color from the PNG image, unless the user
5881 if (fn_png_get_bKGD (png_ptr
, info_ptr
, &bg
))
5883 img
->background
= lookup_rgb_color (f
, bg
->red
, bg
->green
, bg
->blue
);
5884 img
->background_valid
= 1;
5888 #ifdef COLOR_TABLE_SUPPORT
5889 /* Remember colors allocated for this image. */
5890 img
->colors
= colors_in_color_table (&img
->ncolors
);
5891 free_color_table ();
5892 #endif /* COLOR_TABLE_SUPPORT */
5895 fn_png_destroy_read_struct (&png_ptr
, &info_ptr
, &end_info
);
5900 img
->height
= height
;
5902 /* Maybe fill in the background field while we have ximg handy.
5903 Casting avoids a GCC warning. */
5904 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
5906 /* Put the image into the pixmap, then free the X image and its buffer. */
5907 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
5908 x_destroy_x_image (ximg
);
5910 /* Same for the mask. */
5913 /* Fill in the background_transparent field while we have the
5914 mask handy. Casting avoids a GCC warning. */
5915 image_background_transparent (img
, f
, (XImagePtr_or_DC
)mask_img
);
5917 x_put_x_image (f
, mask_img
, img
->mask
, img
->width
, img
->height
);
5918 x_destroy_x_image (mask_img
);
5924 #else /* HAVE_PNG */
5928 png_load (struct frame
*f
, struct image
*img
)
5930 return ns_load_image(f
, img
,
5931 image_spec_value (img
->spec
, QCfile
, NULL
),
5932 image_spec_value (img
->spec
, QCdata
, NULL
));
5934 #endif /* HAVE_NS */
5937 #endif /* !HAVE_PNG */
5941 /***********************************************************************
5943 ***********************************************************************/
5945 #if defined (HAVE_JPEG) || defined (HAVE_NS)
5947 static int jpeg_image_p (Lisp_Object object
);
5948 static int jpeg_load (struct frame
*f
, struct image
*img
);
5950 /* The symbol `jpeg' identifying images of this type. */
5954 /* Indices of image specification fields in gs_format, below. */
5956 enum jpeg_keyword_index
5965 JPEG_HEURISTIC_MASK
,
5971 /* Vector of image_keyword structures describing the format
5972 of valid user-defined image specifications. */
5974 static const struct image_keyword jpeg_format
[JPEG_LAST
] =
5976 {":type", IMAGE_SYMBOL_VALUE
, 1},
5977 {":data", IMAGE_STRING_VALUE
, 0},
5978 {":file", IMAGE_STRING_VALUE
, 0},
5979 {":ascent", IMAGE_ASCENT_VALUE
, 0},
5980 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR
, 0},
5981 {":relief", IMAGE_INTEGER_VALUE
, 0},
5982 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5983 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5984 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5985 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
5988 /* Structure describing the image type `jpeg'. */
5990 static struct image_type jpeg_type
=
5999 /* Return non-zero if OBJECT is a valid JPEG image specification. */
6002 jpeg_image_p (Lisp_Object object
)
6004 struct image_keyword fmt
[JPEG_LAST
];
6006 memcpy (fmt
, jpeg_format
, sizeof fmt
);
6008 if (!parse_image_spec (object
, fmt
, JPEG_LAST
, Qjpeg
))
6011 /* Must specify either the :data or :file keyword. */
6012 return fmt
[JPEG_FILE
].count
+ fmt
[JPEG_DATA
].count
== 1;
6015 #endif /* HAVE_JPEG || HAVE_NS */
6019 /* Work around a warning about HAVE_STDLIB_H being redefined in
6021 #ifdef HAVE_STDLIB_H
6022 #define HAVE_STDLIB_H_1
6023 #undef HAVE_STDLIB_H
6024 #endif /* HAVE_STLIB_H */
6026 #if defined (HAVE_NTGUI) && !defined (__WIN32__)
6027 /* In older releases of the jpeg library, jpeglib.h will define boolean
6028 differently depending on __WIN32__, so make sure it is defined. */
6032 #include <jpeglib.h>
6035 #ifdef HAVE_STLIB_H_1
6036 #define HAVE_STDLIB_H 1
6041 /* JPEG library details. */
6042 DEF_IMGLIB_FN (jpeg_CreateDecompress
);
6043 DEF_IMGLIB_FN (jpeg_start_decompress
);
6044 DEF_IMGLIB_FN (jpeg_finish_decompress
);
6045 DEF_IMGLIB_FN (jpeg_destroy_decompress
);
6046 DEF_IMGLIB_FN (jpeg_read_header
);
6047 DEF_IMGLIB_FN (jpeg_read_scanlines
);
6048 DEF_IMGLIB_FN (jpeg_std_error
);
6049 DEF_IMGLIB_FN (jpeg_resync_to_restart
);
6052 init_jpeg_functions (Lisp_Object libraries
)
6056 if (!(library
= w32_delayed_load (libraries
, Qjpeg
)))
6059 LOAD_IMGLIB_FN (library
, jpeg_finish_decompress
);
6060 LOAD_IMGLIB_FN (library
, jpeg_read_scanlines
);
6061 LOAD_IMGLIB_FN (library
, jpeg_start_decompress
);
6062 LOAD_IMGLIB_FN (library
, jpeg_read_header
);
6063 LOAD_IMGLIB_FN (library
, jpeg_CreateDecompress
);
6064 LOAD_IMGLIB_FN (library
, jpeg_destroy_decompress
);
6065 LOAD_IMGLIB_FN (library
, jpeg_std_error
);
6066 LOAD_IMGLIB_FN (library
, jpeg_resync_to_restart
);
6070 /* Wrapper since we can't directly assign the function pointer
6071 to another function pointer that was declared more completely easily. */
6073 jpeg_resync_to_restart_wrapper (j_decompress_ptr cinfo
, int desired
)
6075 return fn_jpeg_resync_to_restart (cinfo
, desired
);
6080 #define fn_jpeg_CreateDecompress(a,b,c) jpeg_create_decompress(a)
6081 #define fn_jpeg_start_decompress jpeg_start_decompress
6082 #define fn_jpeg_finish_decompress jpeg_finish_decompress
6083 #define fn_jpeg_destroy_decompress jpeg_destroy_decompress
6084 #define fn_jpeg_read_header jpeg_read_header
6085 #define fn_jpeg_read_scanlines jpeg_read_scanlines
6086 #define fn_jpeg_std_error jpeg_std_error
6087 #define jpeg_resync_to_restart_wrapper jpeg_resync_to_restart
6089 #endif /* HAVE_NTGUI */
6091 struct my_jpeg_error_mgr
6093 struct jpeg_error_mgr pub
;
6094 jmp_buf setjmp_buffer
;
6099 my_error_exit (j_common_ptr cinfo
)
6101 struct my_jpeg_error_mgr
*mgr
= (struct my_jpeg_error_mgr
*) cinfo
->err
;
6102 longjmp (mgr
->setjmp_buffer
, 1);
6106 /* Init source method for JPEG data source manager. Called by
6107 jpeg_read_header() before any data is actually read. See
6108 libjpeg.doc from the JPEG lib distribution. */
6111 our_common_init_source (j_decompress_ptr cinfo
)
6116 /* Method to terminate data source. Called by
6117 jpeg_finish_decompress() after all data has been processed. */
6120 our_common_term_source (j_decompress_ptr cinfo
)
6125 /* Fill input buffer method for JPEG data source manager. Called
6126 whenever more data is needed. We read the whole image in one step,
6127 so this only adds a fake end of input marker at the end. */
6129 static JOCTET our_memory_buffer
[2];
6132 our_memory_fill_input_buffer (j_decompress_ptr cinfo
)
6134 /* Insert a fake EOI marker. */
6135 struct jpeg_source_mgr
*src
= cinfo
->src
;
6137 our_memory_buffer
[0] = (JOCTET
) 0xFF;
6138 our_memory_buffer
[1] = (JOCTET
) JPEG_EOI
;
6140 src
->next_input_byte
= our_memory_buffer
;
6141 src
->bytes_in_buffer
= 2;
6146 /* Method to skip over NUM_BYTES bytes in the image data. CINFO->src
6147 is the JPEG data source manager. */
6150 our_memory_skip_input_data (j_decompress_ptr cinfo
, long int num_bytes
)
6152 struct jpeg_source_mgr
*src
= (struct jpeg_source_mgr
*) cinfo
->src
;
6156 if (num_bytes
> src
->bytes_in_buffer
)
6157 ERREXIT (cinfo
, JERR_INPUT_EOF
);
6159 src
->bytes_in_buffer
-= num_bytes
;
6160 src
->next_input_byte
+= num_bytes
;
6165 /* Set up the JPEG lib for reading an image from DATA which contains
6166 LEN bytes. CINFO is the decompression info structure created for
6167 reading the image. */
6170 jpeg_memory_src (j_decompress_ptr cinfo
, JOCTET
*data
, unsigned int len
)
6172 struct jpeg_source_mgr
*src
;
6174 if (cinfo
->src
== NULL
)
6176 /* First time for this JPEG object? */
6177 cinfo
->src
= (struct jpeg_source_mgr
*)
6178 (*cinfo
->mem
->alloc_small
) ((j_common_ptr
) cinfo
, JPOOL_PERMANENT
,
6179 sizeof (struct jpeg_source_mgr
));
6180 src
= (struct jpeg_source_mgr
*) cinfo
->src
;
6181 src
->next_input_byte
= data
;
6184 src
= (struct jpeg_source_mgr
*) cinfo
->src
;
6185 src
->init_source
= our_common_init_source
;
6186 src
->fill_input_buffer
= our_memory_fill_input_buffer
;
6187 src
->skip_input_data
= our_memory_skip_input_data
;
6188 src
->resync_to_restart
= jpeg_resync_to_restart_wrapper
; /* Use default method. */
6189 src
->term_source
= our_common_term_source
;
6190 src
->bytes_in_buffer
= len
;
6191 src
->next_input_byte
= data
;
6195 struct jpeg_stdio_mgr
6197 struct jpeg_source_mgr mgr
;
6204 /* Size of buffer to read JPEG from file.
6205 Not too big, as we want to use alloc_small. */
6206 #define JPEG_STDIO_BUFFER_SIZE 8192
6209 /* Fill input buffer method for JPEG data source manager. Called
6210 whenever more data is needed. The data is read from a FILE *. */
6213 our_stdio_fill_input_buffer (j_decompress_ptr cinfo
)
6215 struct jpeg_stdio_mgr
*src
;
6217 src
= (struct jpeg_stdio_mgr
*) cinfo
->src
;
6222 bytes
= fread (src
->buffer
, 1, JPEG_STDIO_BUFFER_SIZE
, src
->file
);
6224 src
->mgr
.bytes_in_buffer
= bytes
;
6227 WARNMS (cinfo
, JWRN_JPEG_EOF
);
6229 src
->buffer
[0] = (JOCTET
) 0xFF;
6230 src
->buffer
[1] = (JOCTET
) JPEG_EOI
;
6231 src
->mgr
.bytes_in_buffer
= 2;
6233 src
->mgr
.next_input_byte
= src
->buffer
;
6240 /* Method to skip over NUM_BYTES bytes in the image data. CINFO->src
6241 is the JPEG data source manager. */
6244 our_stdio_skip_input_data (j_decompress_ptr cinfo
, long int num_bytes
)
6246 struct jpeg_stdio_mgr
*src
;
6247 src
= (struct jpeg_stdio_mgr
*) cinfo
->src
;
6249 while (num_bytes
> 0 && !src
->finished
)
6251 if (num_bytes
<= src
->mgr
.bytes_in_buffer
)
6253 src
->mgr
.bytes_in_buffer
-= num_bytes
;
6254 src
->mgr
.next_input_byte
+= num_bytes
;
6259 num_bytes
-= src
->mgr
.bytes_in_buffer
;
6260 src
->mgr
.bytes_in_buffer
= 0;
6261 src
->mgr
.next_input_byte
= NULL
;
6263 our_stdio_fill_input_buffer (cinfo
);
6269 /* Set up the JPEG lib for reading an image from a FILE *.
6270 CINFO is the decompression info structure created for
6271 reading the image. */
6274 jpeg_file_src (j_decompress_ptr cinfo
, FILE *fp
)
6276 struct jpeg_stdio_mgr
*src
;
6278 if (cinfo
->src
!= NULL
)
6279 src
= (struct jpeg_stdio_mgr
*) cinfo
->src
;
6282 /* First time for this JPEG object? */
6283 cinfo
->src
= (struct jpeg_source_mgr
*)
6284 (*cinfo
->mem
->alloc_small
) ((j_common_ptr
) cinfo
, JPOOL_PERMANENT
,
6285 sizeof (struct jpeg_stdio_mgr
));
6286 src
= (struct jpeg_stdio_mgr
*) cinfo
->src
;
6287 src
->buffer
= (JOCTET
*)
6288 (*cinfo
->mem
->alloc_small
) ((j_common_ptr
) cinfo
, JPOOL_PERMANENT
,
6289 JPEG_STDIO_BUFFER_SIZE
);
6294 src
->mgr
.init_source
= our_common_init_source
;
6295 src
->mgr
.fill_input_buffer
= our_stdio_fill_input_buffer
;
6296 src
->mgr
.skip_input_data
= our_stdio_skip_input_data
;
6297 src
->mgr
.resync_to_restart
= jpeg_resync_to_restart_wrapper
; /* Use default method. */
6298 src
->mgr
.term_source
= our_common_term_source
;
6299 src
->mgr
.bytes_in_buffer
= 0;
6300 src
->mgr
.next_input_byte
= NULL
;
6304 /* Load image IMG for use on frame F. Patterned after example.c
6305 from the JPEG lib. */
6308 jpeg_load (struct frame
*f
, struct image
*img
)
6310 struct jpeg_decompress_struct cinfo
;
6311 struct my_jpeg_error_mgr mgr
;
6312 Lisp_Object file
, specified_file
;
6313 Lisp_Object specified_data
;
6314 FILE * volatile fp
= NULL
;
6316 int row_stride
, x
, y
;
6317 XImagePtr ximg
= NULL
;
6319 unsigned long *colors
;
6322 /* Open the JPEG file. */
6323 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
6324 specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
6326 if (NILP (specified_data
))
6328 file
= x_find_image_file (specified_file
);
6329 if (!STRINGP (file
))
6331 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
6335 fp
= fopen (SDATA (file
), "rb");
6338 image_error ("Cannot open `%s'", file
, Qnil
);
6342 else if (!STRINGP (specified_data
))
6344 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
6348 /* Customize libjpeg's error handling to call my_error_exit when an
6349 error is detected. This function will perform a longjmp.
6350 Casting return value avoids a GCC warning on W32. */
6351 cinfo
.err
= (struct jpeg_error_mgr
*)fn_jpeg_std_error (&mgr
.pub
);
6352 mgr
.pub
.error_exit
= my_error_exit
;
6354 if ((rc
= setjmp (mgr
.setjmp_buffer
)) != 0)
6358 /* Called from my_error_exit. Display a JPEG error. */
6359 char buffer
[JMSG_LENGTH_MAX
];
6360 cinfo
.err
->format_message ((j_common_ptr
) &cinfo
, buffer
);
6361 image_error ("Error reading JPEG image `%s': %s", img
->spec
,
6362 build_string (buffer
));
6365 /* Close the input file and destroy the JPEG object. */
6367 fclose ((FILE *) fp
);
6368 fn_jpeg_destroy_decompress (&cinfo
);
6370 /* If we already have an XImage, free that. */
6371 x_destroy_x_image (ximg
);
6373 /* Free pixmap and colors. */
6374 x_clear_image (f
, img
);
6378 /* Create the JPEG decompression object. Let it read from fp.
6379 Read the JPEG image header. */
6380 fn_jpeg_CreateDecompress (&cinfo
, JPEG_LIB_VERSION
, sizeof (cinfo
));
6382 if (NILP (specified_data
))
6383 jpeg_file_src (&cinfo
, (FILE *) fp
);
6385 jpeg_memory_src (&cinfo
, SDATA (specified_data
),
6386 SBYTES (specified_data
));
6388 fn_jpeg_read_header (&cinfo
, 1);
6390 /* Customize decompression so that color quantization will be used.
6391 Start decompression. */
6392 cinfo
.quantize_colors
= 1;
6393 fn_jpeg_start_decompress (&cinfo
);
6394 width
= img
->width
= cinfo
.output_width
;
6395 height
= img
->height
= cinfo
.output_height
;
6397 if (!check_image_size (f
, width
, height
))
6399 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
6400 longjmp (mgr
.setjmp_buffer
, 2);
6403 /* Create X image and pixmap. */
6404 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0, &ximg
, &img
->pixmap
))
6405 longjmp (mgr
.setjmp_buffer
, 2);
6407 /* Allocate colors. When color quantization is used,
6408 cinfo.actual_number_of_colors has been set with the number of
6409 colors generated, and cinfo.colormap is a two-dimensional array
6410 of color indices in the range 0..cinfo.actual_number_of_colors.
6411 No more than 255 colors will be generated. */
6415 if (cinfo
.out_color_components
> 2)
6416 ir
= 0, ig
= 1, ib
= 2;
6417 else if (cinfo
.out_color_components
> 1)
6418 ir
= 0, ig
= 1, ib
= 0;
6420 ir
= 0, ig
= 0, ib
= 0;
6422 /* Use the color table mechanism because it handles colors that
6423 cannot be allocated nicely. Such colors will be replaced with
6424 a default color, and we don't have to care about which colors
6425 can be freed safely, and which can't. */
6426 init_color_table ();
6427 colors
= (unsigned long *) alloca (cinfo
.actual_number_of_colors
6430 for (i
= 0; i
< cinfo
.actual_number_of_colors
; ++i
)
6432 /* Multiply RGB values with 255 because X expects RGB values
6433 in the range 0..0xffff. */
6434 int r
= cinfo
.colormap
[ir
][i
] << 8;
6435 int g
= cinfo
.colormap
[ig
][i
] << 8;
6436 int b
= cinfo
.colormap
[ib
][i
] << 8;
6437 colors
[i
] = lookup_rgb_color (f
, r
, g
, b
);
6440 #ifdef COLOR_TABLE_SUPPORT
6441 /* Remember those colors actually allocated. */
6442 img
->colors
= colors_in_color_table (&img
->ncolors
);
6443 free_color_table ();
6444 #endif /* COLOR_TABLE_SUPPORT */
6448 row_stride
= width
* cinfo
.output_components
;
6449 buffer
= cinfo
.mem
->alloc_sarray ((j_common_ptr
) &cinfo
, JPOOL_IMAGE
,
6451 for (y
= 0; y
< height
; ++y
)
6453 fn_jpeg_read_scanlines (&cinfo
, buffer
, 1);
6454 for (x
= 0; x
< cinfo
.output_width
; ++x
)
6455 XPutPixel (ximg
, x
, y
, colors
[buffer
[0][x
]]);
6459 fn_jpeg_finish_decompress (&cinfo
);
6460 fn_jpeg_destroy_decompress (&cinfo
);
6462 fclose ((FILE *) fp
);
6464 /* Maybe fill in the background field while we have ximg handy. */
6465 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
6466 /* Casting avoids a GCC warning. */
6467 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
6469 /* Put the image into the pixmap. */
6470 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
6471 x_destroy_x_image (ximg
);
6475 #else /* HAVE_JPEG */
6479 jpeg_load (struct frame
*f
, struct image
*img
)
6481 return ns_load_image (f
, img
,
6482 image_spec_value (img
->spec
, QCfile
, NULL
),
6483 image_spec_value (img
->spec
, QCdata
, NULL
));
6485 #endif /* HAVE_NS */
6487 #endif /* !HAVE_JPEG */
6491 /***********************************************************************
6493 ***********************************************************************/
6495 #if defined (HAVE_TIFF) || defined (HAVE_NS)
6497 static int tiff_image_p (Lisp_Object object
);
6498 static int tiff_load (struct frame
*f
, struct image
*img
);
6500 /* The symbol `tiff' identifying images of this type. */
6504 /* Indices of image specification fields in tiff_format, below. */
6506 enum tiff_keyword_index
6515 TIFF_HEURISTIC_MASK
,
6522 /* Vector of image_keyword structures describing the format
6523 of valid user-defined image specifications. */
6525 static const struct image_keyword tiff_format
[TIFF_LAST
] =
6527 {":type", IMAGE_SYMBOL_VALUE
, 1},
6528 {":data", IMAGE_STRING_VALUE
, 0},
6529 {":file", IMAGE_STRING_VALUE
, 0},
6530 {":ascent", IMAGE_ASCENT_VALUE
, 0},
6531 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR
, 0},
6532 {":relief", IMAGE_INTEGER_VALUE
, 0},
6533 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6534 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6535 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6536 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0},
6537 {":index", IMAGE_NON_NEGATIVE_INTEGER_VALUE
, 0}
6540 /* Structure describing the image type `tiff'. */
6542 static struct image_type tiff_type
=
6551 /* Return non-zero if OBJECT is a valid TIFF image specification. */
6554 tiff_image_p (Lisp_Object object
)
6556 struct image_keyword fmt
[TIFF_LAST
];
6557 memcpy (fmt
, tiff_format
, sizeof fmt
);
6559 if (!parse_image_spec (object
, fmt
, TIFF_LAST
, Qtiff
))
6562 /* Must specify either the :data or :file keyword. */
6563 return fmt
[TIFF_FILE
].count
+ fmt
[TIFF_DATA
].count
== 1;
6566 #endif /* HAVE_TIFF || HAVE_NS */
6574 /* TIFF library details. */
6575 DEF_IMGLIB_FN (TIFFSetErrorHandler
);
6576 DEF_IMGLIB_FN (TIFFSetWarningHandler
);
6577 DEF_IMGLIB_FN (TIFFOpen
);
6578 DEF_IMGLIB_FN (TIFFClientOpen
);
6579 DEF_IMGLIB_FN (TIFFGetField
);
6580 DEF_IMGLIB_FN (TIFFReadRGBAImage
);
6581 DEF_IMGLIB_FN (TIFFClose
);
6582 DEF_IMGLIB_FN (TIFFSetDirectory
);
6585 init_tiff_functions (Lisp_Object libraries
)
6589 if (!(library
= w32_delayed_load (libraries
, Qtiff
)))
6592 LOAD_IMGLIB_FN (library
, TIFFSetErrorHandler
);
6593 LOAD_IMGLIB_FN (library
, TIFFSetWarningHandler
);
6594 LOAD_IMGLIB_FN (library
, TIFFOpen
);
6595 LOAD_IMGLIB_FN (library
, TIFFClientOpen
);
6596 LOAD_IMGLIB_FN (library
, TIFFGetField
);
6597 LOAD_IMGLIB_FN (library
, TIFFReadRGBAImage
);
6598 LOAD_IMGLIB_FN (library
, TIFFClose
);
6599 LOAD_IMGLIB_FN (library
, TIFFSetDirectory
);
6605 #define fn_TIFFSetErrorHandler TIFFSetErrorHandler
6606 #define fn_TIFFSetWarningHandler TIFFSetWarningHandler
6607 #define fn_TIFFOpen TIFFOpen
6608 #define fn_TIFFClientOpen TIFFClientOpen
6609 #define fn_TIFFGetField TIFFGetField
6610 #define fn_TIFFReadRGBAImage TIFFReadRGBAImage
6611 #define fn_TIFFClose TIFFClose
6612 #define fn_TIFFSetDirectory TIFFSetDirectory
6613 #endif /* HAVE_NTGUI */
6616 /* Reading from a memory buffer for TIFF images Based on the PNG
6617 memory source, but we have to provide a lot of extra functions.
6620 We really only need to implement read and seek, but I am not
6621 convinced that the TIFF library is smart enough not to destroy
6622 itself if we only hand it the function pointers we need to
6627 unsigned char *bytes
;
6634 tiff_read_from_memory (thandle_t data
, tdata_t buf
, tsize_t size
)
6636 tiff_memory_source
*src
= (tiff_memory_source
*) data
;
6638 if (size
> src
->len
- src
->index
)
6640 memcpy (buf
, src
->bytes
+ src
->index
, size
);
6646 tiff_write_from_memory (thandle_t data
, tdata_t buf
, tsize_t size
)
6652 tiff_seek_in_memory (thandle_t data
, toff_t off
, int whence
)
6654 tiff_memory_source
*src
= (tiff_memory_source
*) data
;
6659 case SEEK_SET
: /* Go from beginning of source. */
6663 case SEEK_END
: /* Go from end of source. */
6664 idx
= src
->len
+ off
;
6667 case SEEK_CUR
: /* Go from current position. */
6668 idx
= src
->index
+ off
;
6671 default: /* Invalid `whence'. */
6675 if (idx
> src
->len
|| idx
< 0)
6683 tiff_close_memory (thandle_t data
)
6690 tiff_mmap_memory (thandle_t data
, tdata_t
*pbase
, toff_t
*psize
)
6692 /* It is already _IN_ memory. */
6697 tiff_unmap_memory (thandle_t data
, tdata_t base
, toff_t size
)
6699 /* We don't need to do this. */
6703 tiff_size_of_memory (thandle_t data
)
6705 return ((tiff_memory_source
*) data
)->len
;
6710 tiff_error_handler (const char *title
, const char *format
, va_list ap
)
6715 len
= sprintf (buf
, "TIFF error: %s ", title
);
6716 vsprintf (buf
+ len
, format
, ap
);
6717 add_to_log (buf
, Qnil
, Qnil
);
6722 tiff_warning_handler (const char *title
, const char *format
, va_list ap
)
6727 len
= sprintf (buf
, "TIFF warning: %s ", title
);
6728 vsprintf (buf
+ len
, format
, ap
);
6729 add_to_log (buf
, Qnil
, Qnil
);
6733 /* Load TIFF image IMG for use on frame F. Value is non-zero if
6737 tiff_load (struct frame
*f
, struct image
*img
)
6739 Lisp_Object file
, specified_file
;
6740 Lisp_Object specified_data
;
6742 int width
, height
, x
, y
, count
;
6746 tiff_memory_source memsrc
;
6749 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
6750 specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
6752 fn_TIFFSetErrorHandler (tiff_error_handler
);
6753 fn_TIFFSetWarningHandler (tiff_warning_handler
);
6755 if (NILP (specified_data
))
6757 /* Read from a file */
6758 file
= x_find_image_file (specified_file
);
6759 if (!STRINGP (file
))
6761 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
6765 /* Try to open the image file. Casting return value avoids a
6766 GCC warning on W32. */
6767 tiff
= (TIFF
*)fn_TIFFOpen (SDATA (file
), "r");
6770 image_error ("Cannot open `%s'", file
, Qnil
);
6776 if (!STRINGP (specified_data
))
6778 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
6782 /* Memory source! */
6783 memsrc
.bytes
= SDATA (specified_data
);
6784 memsrc
.len
= SBYTES (specified_data
);
6787 /* Casting return value avoids a GCC warning on W32. */
6788 tiff
= (TIFF
*)fn_TIFFClientOpen ("memory_source", "r", &memsrc
,
6789 (TIFFReadWriteProc
) tiff_read_from_memory
,
6790 (TIFFReadWriteProc
) tiff_write_from_memory
,
6791 tiff_seek_in_memory
,
6793 tiff_size_of_memory
,
6799 image_error ("Cannot open memory source for `%s'", img
->spec
, Qnil
);
6804 image
= image_spec_value (img
->spec
, QCindex
, NULL
);
6805 if (INTEGERP (image
))
6807 int ino
= XFASTINT (image
);
6808 if (!fn_TIFFSetDirectory (tiff
, ino
))
6810 image_error ("Invalid image number `%s' in image `%s'",
6812 fn_TIFFClose (tiff
);
6817 /* Get width and height of the image, and allocate a raster buffer
6818 of width x height 32-bit values. */
6819 fn_TIFFGetField (tiff
, TIFFTAG_IMAGEWIDTH
, &width
);
6820 fn_TIFFGetField (tiff
, TIFFTAG_IMAGELENGTH
, &height
);
6822 if (!check_image_size (f
, width
, height
))
6824 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
6825 fn_TIFFClose (tiff
);
6829 buf
= (uint32
*) xmalloc (width
* height
* sizeof *buf
);
6831 rc
= fn_TIFFReadRGBAImage (tiff
, width
, height
, buf
, 0);
6833 /* Count the number of images in the file. */
6834 for (count
= 1, rc2
= 1; rc2
; count
++)
6835 rc2
= fn_TIFFSetDirectory (tiff
, count
);
6838 img
->data
.lisp_val
= Fcons (Qcount
,
6839 Fcons (make_number (count
),
6840 img
->data
.lisp_val
));
6842 fn_TIFFClose (tiff
);
6845 image_error ("Error reading TIFF image `%s'", img
->spec
, Qnil
);
6850 /* Create the X image and pixmap. */
6851 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0, &ximg
, &img
->pixmap
))
6857 /* Initialize the color table. */
6858 init_color_table ();
6860 /* Process the pixel raster. Origin is in the lower-left corner. */
6861 for (y
= 0; y
< height
; ++y
)
6863 uint32
*row
= buf
+ y
* width
;
6865 for (x
= 0; x
< width
; ++x
)
6867 uint32 abgr
= row
[x
];
6868 int r
= TIFFGetR (abgr
) << 8;
6869 int g
= TIFFGetG (abgr
) << 8;
6870 int b
= TIFFGetB (abgr
) << 8;
6871 XPutPixel (ximg
, x
, height
- 1 - y
, lookup_rgb_color (f
, r
, g
, b
));
6875 #ifdef COLOR_TABLE_SUPPORT
6876 /* Remember the colors allocated for the image. Free the color table. */
6877 img
->colors
= colors_in_color_table (&img
->ncolors
);
6878 free_color_table ();
6879 #endif /* COLOR_TABLE_SUPPORT */
6882 img
->height
= height
;
6884 /* Maybe fill in the background field while we have ximg handy. */
6885 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
6886 /* Casting avoids a GCC warning on W32. */
6887 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
6889 /* Put the image into the pixmap, then free the X image and its buffer. */
6890 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
6891 x_destroy_x_image (ximg
);
6897 #else /* HAVE_TIFF */
6901 tiff_load (struct frame
*f
, struct image
*img
)
6903 return ns_load_image (f
, img
,
6904 image_spec_value (img
->spec
, QCfile
, NULL
),
6905 image_spec_value (img
->spec
, QCdata
, NULL
));
6907 #endif /* HAVE_NS */
6909 #endif /* !HAVE_TIFF */
6913 /***********************************************************************
6915 ***********************************************************************/
6917 #if defined (HAVE_GIF) || defined (HAVE_NS)
6919 static int gif_image_p (Lisp_Object object
);
6920 static int gif_load (struct frame
*f
, struct image
*img
);
6921 static void gif_clear_image (struct frame
*f
, struct image
*img
);
6923 /* The symbol `gif' identifying images of this type. */
6927 /* Indices of image specification fields in gif_format, below. */
6929 enum gif_keyword_index
6945 /* Vector of image_keyword structures describing the format
6946 of valid user-defined image specifications. */
6948 static const struct image_keyword gif_format
[GIF_LAST
] =
6950 {":type", IMAGE_SYMBOL_VALUE
, 1},
6951 {":data", IMAGE_STRING_VALUE
, 0},
6952 {":file", IMAGE_STRING_VALUE
, 0},
6953 {":ascent", IMAGE_ASCENT_VALUE
, 0},
6954 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR
, 0},
6955 {":relief", IMAGE_INTEGER_VALUE
, 0},
6956 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6957 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6958 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6959 {":index", IMAGE_NON_NEGATIVE_INTEGER_VALUE
, 0},
6960 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
6963 /* Structure describing the image type `gif'. */
6965 static struct image_type gif_type
=
6974 /* Free X resources of GIF image IMG which is used on frame F. */
6977 gif_clear_image (struct frame
*f
, struct image
*img
)
6979 /* IMG->data.ptr_val may contain metadata with extension data. */
6980 img
->data
.lisp_val
= Qnil
;
6981 x_clear_image (f
, img
);
6984 /* Return non-zero if OBJECT is a valid GIF image specification. */
6987 gif_image_p (Lisp_Object object
)
6989 struct image_keyword fmt
[GIF_LAST
];
6990 memcpy (fmt
, gif_format
, sizeof fmt
);
6992 if (!parse_image_spec (object
, fmt
, GIF_LAST
, Qgif
))
6995 /* Must specify either the :data or :file keyword. */
6996 return fmt
[GIF_FILE
].count
+ fmt
[GIF_DATA
].count
== 1;
6999 #endif /* HAVE_GIF */
7003 #if defined (HAVE_NTGUI)
7004 /* winuser.h might define DrawText to DrawTextA or DrawTextW.
7005 Undefine before redefining to avoid a preprocessor warning. */
7009 /* avoid conflict with QuickdrawText.h */
7010 #define DrawText gif_DrawText
7011 #include <gif_lib.h>
7014 #else /* HAVE_NTGUI */
7016 #include <gif_lib.h>
7018 #endif /* HAVE_NTGUI */
7023 /* GIF library details. */
7024 DEF_IMGLIB_FN (DGifCloseFile
);
7025 DEF_IMGLIB_FN (DGifSlurp
);
7026 DEF_IMGLIB_FN (DGifOpen
);
7027 DEF_IMGLIB_FN (DGifOpenFileName
);
7030 init_gif_functions (Lisp_Object libraries
)
7034 if (!(library
= w32_delayed_load (libraries
, Qgif
)))
7037 LOAD_IMGLIB_FN (library
, DGifCloseFile
);
7038 LOAD_IMGLIB_FN (library
, DGifSlurp
);
7039 LOAD_IMGLIB_FN (library
, DGifOpen
);
7040 LOAD_IMGLIB_FN (library
, DGifOpenFileName
);
7046 #define fn_DGifCloseFile DGifCloseFile
7047 #define fn_DGifSlurp DGifSlurp
7048 #define fn_DGifOpen DGifOpen
7049 #define fn_DGifOpenFileName DGifOpenFileName
7051 #endif /* HAVE_NTGUI */
7053 /* Reading a GIF image from memory
7054 Based on the PNG memory stuff to a certain extent. */
7058 unsigned char *bytes
;
7064 /* Make the current memory source available to gif_read_from_memory.
7065 It's done this way because not all versions of libungif support
7066 a UserData field in the GifFileType structure. */
7067 static gif_memory_source
*current_gif_memory_src
;
7070 gif_read_from_memory (GifFileType
*file
, GifByteType
*buf
, int len
)
7072 gif_memory_source
*src
= current_gif_memory_src
;
7074 if (len
> src
->len
- src
->index
)
7077 memcpy (buf
, src
->bytes
+ src
->index
, len
);
7083 /* Load GIF image IMG for use on frame F. Value is non-zero if
7086 static const int interlace_start
[] = {0, 4, 2, 1};
7087 static const int interlace_increment
[] = {8, 8, 4, 2};
7090 gif_load (struct frame
*f
, struct image
*img
)
7092 Lisp_Object file
, specified_file
;
7093 Lisp_Object specified_data
;
7094 int rc
, width
, height
, x
, y
, i
;
7096 ColorMapObject
*gif_color_map
;
7097 unsigned long pixel_colors
[256];
7100 int ino
, image_height
, image_width
;
7101 gif_memory_source memsrc
;
7102 unsigned char *raster
;
7104 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
7105 specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
7107 if (NILP (specified_data
))
7109 file
= x_find_image_file (specified_file
);
7110 if (!STRINGP (file
))
7112 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
7116 /* Open the GIF file. Casting return value avoids a GCC warning
7118 gif
= (GifFileType
*)fn_DGifOpenFileName (SDATA (file
));
7121 image_error ("Cannot open `%s'", file
, Qnil
);
7127 if (!STRINGP (specified_data
))
7129 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
7133 /* Read from memory! */
7134 current_gif_memory_src
= &memsrc
;
7135 memsrc
.bytes
= SDATA (specified_data
);
7136 memsrc
.len
= SBYTES (specified_data
);
7139 /* Casting return value avoids a GCC warning on W32. */
7140 gif
= (GifFileType
*) fn_DGifOpen (&memsrc
, gif_read_from_memory
);
7143 image_error ("Cannot open memory source `%s'", img
->spec
, Qnil
);
7148 /* Before reading entire contents, check the declared image size. */
7149 if (!check_image_size (f
, gif
->SWidth
, gif
->SHeight
))
7151 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
7152 fn_DGifCloseFile (gif
);
7156 /* Read entire contents. */
7157 rc
= fn_DGifSlurp (gif
);
7158 if (rc
== GIF_ERROR
)
7160 image_error ("Error reading `%s'", img
->spec
, Qnil
);
7161 fn_DGifCloseFile (gif
);
7165 image
= image_spec_value (img
->spec
, QCindex
, NULL
);
7166 ino
= INTEGERP (image
) ? XFASTINT (image
) : 0;
7167 if (ino
>= gif
->ImageCount
)
7169 image_error ("Invalid image number `%s' in image `%s'",
7171 fn_DGifCloseFile (gif
);
7175 img
->corners
[TOP_CORNER
] = gif
->SavedImages
[ino
].ImageDesc
.Top
;
7176 img
->corners
[LEFT_CORNER
] = gif
->SavedImages
[ino
].ImageDesc
.Left
;
7177 image_height
= gif
->SavedImages
[ino
].ImageDesc
.Height
;
7178 img
->corners
[BOT_CORNER
] = img
->corners
[TOP_CORNER
] + image_height
;
7179 image_width
= gif
->SavedImages
[ino
].ImageDesc
.Width
;
7180 img
->corners
[RIGHT_CORNER
] = img
->corners
[LEFT_CORNER
] + image_width
;
7182 width
= img
->width
= max (gif
->SWidth
,
7183 max (gif
->Image
.Left
+ gif
->Image
.Width
,
7184 img
->corners
[RIGHT_CORNER
]));
7185 height
= img
->height
= max (gif
->SHeight
,
7186 max (gif
->Image
.Top
+ gif
->Image
.Height
,
7187 img
->corners
[BOT_CORNER
]));
7189 if (!check_image_size (f
, width
, height
))
7191 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
7192 fn_DGifCloseFile (gif
);
7196 /* Create the X image and pixmap. */
7197 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0, &ximg
, &img
->pixmap
))
7199 fn_DGifCloseFile (gif
);
7203 /* Allocate colors. */
7204 gif_color_map
= gif
->SavedImages
[ino
].ImageDesc
.ColorMap
;
7206 gif_color_map
= gif
->SColorMap
;
7207 init_color_table ();
7208 memset (pixel_colors
, 0, sizeof pixel_colors
);
7211 for (i
= 0; i
< gif_color_map
->ColorCount
; ++i
)
7213 int r
= gif_color_map
->Colors
[i
].Red
<< 8;
7214 int g
= gif_color_map
->Colors
[i
].Green
<< 8;
7215 int b
= gif_color_map
->Colors
[i
].Blue
<< 8;
7216 pixel_colors
[i
] = lookup_rgb_color (f
, r
, g
, b
);
7219 #ifdef COLOR_TABLE_SUPPORT
7220 img
->colors
= colors_in_color_table (&img
->ncolors
);
7221 free_color_table ();
7222 #endif /* COLOR_TABLE_SUPPORT */
7224 /* Clear the part of the screen image that are not covered by
7225 the image from the GIF file. Full animated GIF support
7226 requires more than can be done here (see the gif89 spec,
7227 disposal methods). Let's simply assume that the part
7228 not covered by a sub-image is in the frame's background color. */
7229 for (y
= 0; y
< img
->corners
[TOP_CORNER
]; ++y
)
7230 for (x
= 0; x
< width
; ++x
)
7231 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7233 for (y
= img
->corners
[BOT_CORNER
]; y
< height
; ++y
)
7234 for (x
= 0; x
< width
; ++x
)
7235 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7237 for (y
= img
->corners
[TOP_CORNER
]; y
< img
->corners
[BOT_CORNER
]; ++y
)
7239 for (x
= 0; x
< img
->corners
[LEFT_CORNER
]; ++x
)
7240 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7241 for (x
= img
->corners
[RIGHT_CORNER
]; x
< width
; ++x
)
7242 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7245 /* Read the GIF image into the X image. We use a local variable
7246 `raster' here because RasterBits below is a char *, and invites
7247 problems with bytes >= 0x80. */
7248 raster
= (unsigned char *) gif
->SavedImages
[ino
].RasterBits
;
7250 if (gif
->SavedImages
[ino
].ImageDesc
.Interlace
)
7253 int row
= interlace_start
[0];
7257 for (y
= 0; y
< image_height
; y
++)
7259 if (row
>= image_height
)
7261 row
= interlace_start
[++pass
];
7262 while (row
>= image_height
)
7263 row
= interlace_start
[++pass
];
7266 for (x
= 0; x
< image_width
; x
++)
7268 int i
= raster
[(y
* image_width
) + x
];
7269 XPutPixel (ximg
, x
+ img
->corners
[LEFT_CORNER
],
7270 row
+ img
->corners
[TOP_CORNER
], pixel_colors
[i
]);
7273 row
+= interlace_increment
[pass
];
7278 for (y
= 0; y
< image_height
; ++y
)
7279 for (x
= 0; x
< image_width
; ++x
)
7281 int i
= raster
[y
* image_width
+ x
];
7282 XPutPixel (ximg
, x
+ img
->corners
[LEFT_CORNER
],
7283 y
+ img
->corners
[TOP_CORNER
], pixel_colors
[i
]);
7287 /* Save GIF image extension data for `image-metadata'.
7288 Format is (count IMAGES extension-data (FUNCTION "BYTES" ...)). */
7289 img
->data
.lisp_val
= Qnil
;
7290 if (gif
->SavedImages
[ino
].ExtensionBlockCount
> 0)
7292 ExtensionBlock
*ext
= gif
->SavedImages
[ino
].ExtensionBlocks
;
7293 for (i
= 0; i
< gif
->SavedImages
[ino
].ExtensionBlockCount
; i
++, ext
++)
7294 /* Append (... FUNCTION "BYTES") */
7295 img
->data
.lisp_val
= Fcons (make_unibyte_string (ext
->Bytes
, ext
->ByteCount
),
7296 Fcons (make_number (ext
->Function
),
7297 img
->data
.lisp_val
));
7298 img
->data
.lisp_val
= Fcons (Qextension_data
,
7299 Fcons (Fnreverse (img
->data
.lisp_val
),
7302 if (gif
->ImageCount
> 1)
7303 img
->data
.lisp_val
= Fcons (Qcount
,
7304 Fcons (make_number (gif
->ImageCount
),
7305 img
->data
.lisp_val
));
7307 fn_DGifCloseFile (gif
);
7309 /* Maybe fill in the background field while we have ximg handy. */
7310 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
7311 /* Casting avoids a GCC warning. */
7312 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
7314 /* Put the image into the pixmap, then free the X image and its buffer. */
7315 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
7316 x_destroy_x_image (ximg
);
7321 #else /* !HAVE_GIF */
7325 gif_load (struct frame
*f
, struct image
*img
)
7327 return ns_load_image (f
, img
,
7328 image_spec_value (img
->spec
, QCfile
, NULL
),
7329 image_spec_value (img
->spec
, QCdata
, NULL
));
7331 #endif /* HAVE_NS */
7333 #endif /* HAVE_GIF */
7336 /***********************************************************************
7338 ***********************************************************************/
7339 #if defined (HAVE_IMAGEMAGICK)
7340 Lisp_Object Vimagemagick_render_type
;
7342 /* The symbol `imagemagick' identifying images of this type. */
7344 Lisp_Object Qimagemagick
;
7345 Lisp_Object Vimagemagick_render_type
;
7347 /* Indices of image specification fields in imagemagick_format, below. */
7349 enum imagemagick_keyword_index
7357 IMAGEMAGICK_ALGORITHM
,
7358 IMAGEMAGICK_HEURISTIC_MASK
,
7360 IMAGEMAGICK_BACKGROUND
,
7363 IMAGEMAGICK_ROTATION
,
7368 /* Vector of image_keyword structures describing the format
7369 of valid user-defined image specifications. */
7371 static struct image_keyword imagemagick_format
[IMAGEMAGICK_LAST
] =
7373 {":type", IMAGE_SYMBOL_VALUE
, 1},
7374 {":data", IMAGE_STRING_VALUE
, 0},
7375 {":file", IMAGE_STRING_VALUE
, 0},
7376 {":ascent", IMAGE_ASCENT_VALUE
, 0},
7377 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR
, 0},
7378 {":relief", IMAGE_INTEGER_VALUE
, 0},
7379 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7380 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7381 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7382 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0},
7383 {":height", IMAGE_INTEGER_VALUE
, 0},
7384 {":width", IMAGE_INTEGER_VALUE
, 0},
7385 {":rotation", IMAGE_NUMBER_VALUE
, 0},
7386 {":crop", IMAGE_DONT_CHECK_VALUE_TYPE
, 0}
7388 /* Free X resources of imagemagick image IMG which is used on frame F. */
7391 imagemagick_clear_image (struct frame
*f
,
7394 x_clear_image (f
, img
);
7399 /* Return non-zero if OBJECT is a valid IMAGEMAGICK image specification. Do
7400 this by calling parse_image_spec and supplying the keywords that
7401 identify the IMAGEMAGICK format. */
7404 imagemagick_image_p (Lisp_Object object
)
7406 struct image_keyword fmt
[IMAGEMAGICK_LAST
];
7407 memcpy (fmt
, imagemagick_format
, sizeof fmt
);
7409 if (!parse_image_spec (object
, fmt
, IMAGEMAGICK_LAST
, Qimagemagick
))
7412 /* Must specify either the :data or :file keyword. */
7413 return fmt
[IMAGEMAGICK_FILE
].count
+ fmt
[IMAGEMAGICK_DATA
].count
== 1;
7416 /* The GIF library also defines DrawRectangle, but its never used in Emacs.
7417 Therefore rename the function so it doesnt collide with ImageMagick. */
7418 #define DrawRectangle DrawRectangleGif
7419 #include <wand/MagickWand.h>
7421 /* imagemagick_load_image is a helper function for imagemagick_load,
7422 which does the actual loading given contents and size, apart from
7423 frame and image structures, passed from imagemagick_load.
7425 Uses librimagemagick to do most of the image processing.
7427 non-zero when successful.
7431 imagemagick_load_image (/* Pointer to emacs frame structure. */
7433 /* Pointer to emacs image structure. */
7435 /* String containing the IMAGEMAGICK data to
7437 unsigned char *contents
,
7438 /* Size of data in bytes. */
7440 /* Filename, either pass filename or
7442 unsigned char *filename
)
7444 unsigned long width
;
7445 unsigned long height
;
7451 Lisp_Object specified_bg
;
7456 MagickWand
*image_wand
;
7457 MagickWand
*ping_wand
;
7458 PixelIterator
*iterator
;
7460 MagickPixelPacket pixel
;
7463 Lisp_Object crop
, geometry
;
7465 int desired_width
, desired_height
;
7467 int imagemagick_rendermethod
;
7469 ImageInfo
*image_info
;
7470 ExceptionInfo
*exception
;
7474 /* Handle image index for image types who can contain more than one
7475 image. Interface :index is same as for GIF. First we "ping" the
7476 image to see how many sub-images it contains. Pinging is faster
7477 than loading the image to find out things about it. */
7478 image
= image_spec_value (img
->spec
, QCindex
, NULL
);
7479 ino
= INTEGERP (image
) ? XFASTINT (image
) : 0;
7480 ping_wand
= NewMagickWand ();
7481 MagickSetResolution (ping_wand
, 2, 2);
7482 if (filename
!= NULL
)
7484 status
= MagickPingImage (ping_wand
, filename
);
7488 status
= MagickPingImageBlob (ping_wand
, contents
, size
);
7491 if (ino
>= MagickGetNumberImages (ping_wand
))
7493 image_error ("Invalid image number `%s' in image `%s'",
7495 DestroyMagickWand (ping_wand
);
7499 if (MagickGetNumberImages(ping_wand
) > 1)
7500 img
->data
.lisp_val
=
7502 Fcons (make_number (MagickGetNumberImages (ping_wand
)),
7503 img
->data
.lisp_val
));
7505 DestroyMagickWand (ping_wand
);
7506 /* Now, after pinging, we know how many images are inside the
7507 file. If its not a bundle, just one. */
7509 if (filename
!= NULL
)
7511 image_info
= CloneImageInfo ((ImageInfo
*) NULL
);
7512 (void) strcpy (image_info
->filename
, filename
);
7513 image_info
->number_scenes
= 1;
7514 image_info
->scene
= ino
;
7515 exception
= AcquireExceptionInfo ();
7517 im_image
= ReadImage (image_info
, exception
);
7518 CatchException (exception
);
7520 image_wand
= NewMagickWandFromImage (im_image
);
7524 image_wand
= NewMagickWand ();
7525 status
= MagickReadImageBlob (image_wand
, contents
, size
);
7527 image_error ("im read failed", Qnil
, Qnil
);
7528 if (status
== MagickFalse
) goto imagemagick_error
;
7530 /* If width and/or height is set in the display spec assume we want
7531 to scale to those values. if either h or w is unspecified, the
7532 unspecified should be calculated from the specified to preserve
7535 value
= image_spec_value (img
->spec
, QCwidth
, NULL
);
7536 desired_width
= (INTEGERP (value
) ? XFASTINT (value
) : -1);
7537 value
= image_spec_value (img
->spec
, QCheight
, NULL
);
7538 desired_height
= (INTEGERP (value
) ? XFASTINT (value
) : -1);
7540 height
= MagickGetImageHeight (image_wand
);
7541 width
= MagickGetImageWidth (image_wand
);
7543 if(desired_width
!= -1 && desired_height
== -1)
7545 /* w known, calculate h. */
7546 desired_height
= (double) desired_width
/ width
* height
;
7548 if(desired_width
== -1 && desired_height
!= -1)
7550 /* h known, calculate w. */
7551 desired_width
= (double) desired_height
/ height
* width
;
7553 if(desired_width
!= -1 && desired_height
!= -1)
7555 status
= MagickScaleImage (image_wand
, desired_width
, desired_height
);
7556 if (status
== MagickFalse
)
7558 image_error ("Imagemagick scale failed", Qnil
, Qnil
);
7559 goto imagemagick_error
;
7564 /* crop behaves similar to image slicing in Emacs but is more memory
7566 crop
= image_spec_value (img
->spec
, QCcrop
, NULL
);
7568 if (CONSP (crop
) && INTEGERP (XCAR (crop
)))
7570 /* After some testing, it seems MagickCropImage is the fastest
7571 crop function in ImageMagick. This crop function seems to do
7572 less copying than the alternatives, but it still reads the
7573 entire image into memory before croping, which is aparently
7574 difficult to avoid when using imagemagick. */
7577 w
= XFASTINT (XCAR (crop
));
7579 if (CONSP (crop
) && INTEGERP (XCAR (crop
)))
7581 h
= XFASTINT (XCAR (crop
));
7583 if (CONSP (crop
) && INTEGERP (XCAR (crop
)))
7585 x
= XFASTINT (XCAR (crop
));
7587 if (CONSP (crop
) && INTEGERP (XCAR (crop
)))
7589 y
= XFASTINT (XCAR (crop
));
7590 MagickCropImage (image_wand
, w
, h
, x
, y
);
7596 /* Furthermore :rotation. we need background color and angle for
7599 TODO background handling for rotation specified_bg =
7600 image_spec_value (img->spec, QCbackground, NULL); if (!STRINGP
7602 value
= image_spec_value (img
->spec
, QCrotation
, NULL
);
7605 PixelWand
* background
= NewPixelWand ();
7606 PixelSetColor (background
, "#ffffff");/*TODO remove hardcode*/
7608 rotation
= extract_float (value
);
7610 status
= MagickRotateImage (image_wand
, background
, rotation
);
7611 DestroyPixelWand (background
);
7612 if (status
== MagickFalse
)
7614 image_error ("Imagemagick image rotate failed", Qnil
, Qnil
);
7615 goto imagemagick_error
;
7619 /* Finaly we are done manipulating the image, figure out resulting
7620 width, height, and then transfer ownerwship to Emacs. */
7621 height
= MagickGetImageHeight (image_wand
);
7622 width
= MagickGetImageWidth (image_wand
);
7623 if (status
== MagickFalse
)
7625 image_error ("Imagemagick image get size failed", Qnil
, Qnil
);
7626 goto imagemagick_error
;
7629 if (! check_image_size (f
, width
, height
))
7631 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
7632 goto imagemagick_error
;
7635 /* We can now get a valid pixel buffer from the imagemagick file, if all
7638 init_color_table ();
7639 imagemagick_rendermethod
= (INTEGERP (Vimagemagick_render_type
)
7640 ? XFASTINT (Vimagemagick_render_type
) : 0);
7641 if (imagemagick_rendermethod
== 0)
7643 /* Try to create a x pixmap to hold the imagemagick pixmap. */
7644 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0,
7645 &ximg
, &img
->pixmap
))
7647 image_error("Imagemagick X bitmap allocation failure", Qnil
, Qnil
);
7648 goto imagemagick_error
;
7651 /* Copy imagegmagick image to x with primitive yet robust pixel
7652 pusher loop. This has been tested a lot with many different
7655 /* Copy pixels from the imagemagick image structure to the x image map. */
7656 iterator
= NewPixelIterator (image_wand
);
7657 if (iterator
== (PixelIterator
*) NULL
)
7659 image_error ("Imagemagick pixel iterator creation failed",
7661 goto imagemagick_error
;
7664 for (y
= 0; y
< (long) MagickGetImageHeight (image_wand
); y
++)
7666 pixels
= PixelGetNextIteratorRow (iterator
, &width
);
7667 if (pixels
== (PixelWand
**) NULL
)
7669 for (x
= 0; x
< (long) width
; x
++)
7671 PixelGetMagickColor (pixels
[x
], &pixel
);
7672 XPutPixel (ximg
, x
, y
,
7673 lookup_rgb_color (f
,
7679 DestroyPixelIterator (iterator
);
7682 if (imagemagick_rendermethod
== 1)
7684 /* Magicexportimage is normaly faster than pixelpushing. This
7685 method is also well tested. Some aspects of this method are
7686 ad-hoc and needs to be more researched. */
7687 int imagedepth
= 24;/*MagickGetImageDepth(image_wand);*/
7688 char* exportdepth
= imagedepth
<= 8 ? "I" : "BGRP";/*"RGBP";*/
7689 /* Try to create a x pixmap to hold the imagemagick pixmap. */
7690 if (!x_create_x_image_and_pixmap (f
, width
, height
, imagedepth
,
7691 &ximg
, &img
->pixmap
))
7693 image_error("Imagemagick X bitmap allocation failure", Qnil
, Qnil
);
7694 goto imagemagick_error
;
7698 /* Oddly, the below code doesnt seem to work:*/
7699 /* switch(ximg->bitmap_unit){ */
7701 /* pixelwidth=CharPixel; */
7704 /* pixelwidth=ShortPixel; */
7707 /* pixelwidth=LongPixel; */
7711 Here im just guessing the format of the bitmap.
7712 happens to work fine for:
7715 seems about 3 times as fast as pixel pushing(not carefully measured)
7717 pixelwidth
= CharPixel
;/*??? TODO figure out*/
7718 #ifdef HAVE_MAGICKEXPORTIMAGEPIXELS
7719 MagickExportImagePixels (image_wand
,
7724 /*&(img->pixmap));*/
7727 image_error ("You dont have MagickExportImagePixels, upgrade ImageMagick!",
7733 #ifdef COLOR_TABLE_SUPPORT
7734 /* Remember colors allocated for this image. */
7735 img
->colors
= colors_in_color_table (&img
->ncolors
);
7736 free_color_table ();
7737 #endif /* COLOR_TABLE_SUPPORT */
7741 img
->height
= height
;
7743 /* Put the image into the pixmap, then free the X image and its
7745 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
7746 x_destroy_x_image (ximg
);
7749 /* Final cleanup. image_wand should be the only resource left. */
7750 DestroyMagickWand (image_wand
);
7755 /* TODO more cleanup. */
7756 image_error ("Error parsing IMAGEMAGICK image `%s'", img
->spec
, Qnil
);
7761 /* Load IMAGEMAGICK image IMG for use on frame F. Value is non-zero if
7762 successful. this function will go into the imagemagick_type structure, and
7763 the prototype thus needs to be compatible with that structure. */
7766 imagemagick_load (struct frame
*f
,
7770 Lisp_Object file_name
;
7772 /* If IMG->spec specifies a file name, create a non-file spec from it. */
7773 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
7774 if (STRINGP (file_name
))
7778 file
= x_find_image_file (file_name
);
7779 if (!STRINGP (file
))
7781 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
7784 success_p
= imagemagick_load_image (f
, img
, 0, 0, SDATA (file
));
7786 /* Else its not a file, its a lisp object. Load the image from a
7787 lisp object rather than a file. */
7792 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
7793 if (!STRINGP (data
))
7795 image_error ("Invalid image data `%s'", data
, Qnil
);
7798 success_p
= imagemagick_load_image (f
, img
, SDATA (data
),
7799 SBYTES (data
), NULL
);
7805 /* Structure describing the image type `imagemagick'. Its the same
7806 type of structure defined for all image formats, handled by Emacs
7807 image functions. See struct image_type in dispextern.h. */
7809 static struct image_type imagemagick_type
=
7811 /* An identifier showing that this is an image structure for the
7812 IMAGEMAGICK format. */
7814 /* Handle to a function that can be used to identify a IMAGEMAGICK
7816 imagemagick_image_p
,
7817 /* Handle to function used to load a IMAGEMAGICK file. */
7819 /* Handle to function to free resources for IMAGEMAGICK. */
7820 imagemagick_clear_image
,
7821 /* An internal field to link to the next image type in a list of
7822 image types, will be filled in when registering the format. */
7829 DEFUN ("imagemagick-types", Fimagemagick_types
, Simagemagick_types
, 0, 0, 0,
7830 doc
: /* Return image file types supported by ImageMagick.
7831 Since ImageMagick recognizes a lot of file-types that clash with Emacs,
7832 such as .c, we want to be able to alter the list at the lisp level. */)
7835 Lisp_Object typelist
= Qnil
;
7838 char **imtypes
= GetMagickList ("*", &numf
, &ex
);
7840 Lisp_Object Qimagemagicktype
;
7841 for (i
= 0; i
< numf
; i
++)
7843 Qimagemagicktype
= intern (imtypes
[i
]);
7844 typelist
= Fcons (Qimagemagicktype
, typelist
);
7849 #endif /* defined (HAVE_IMAGEMAGICK) */
7853 /***********************************************************************
7855 ***********************************************************************/
7857 #if defined (HAVE_RSVG)
7859 /* Function prototypes. */
7861 static int svg_image_p (Lisp_Object object
);
7862 static int svg_load (struct frame
*f
, struct image
*img
);
7864 static int svg_load_image (struct frame
*, struct image
*,
7865 unsigned char *, unsigned int);
7867 /* The symbol `svg' identifying images of this type. */
7871 /* Indices of image specification fields in svg_format, below. */
7873 enum svg_keyword_index
7888 /* Vector of image_keyword structures describing the format
7889 of valid user-defined image specifications. */
7891 static const struct image_keyword svg_format
[SVG_LAST
] =
7893 {":type", IMAGE_SYMBOL_VALUE
, 1},
7894 {":data", IMAGE_STRING_VALUE
, 0},
7895 {":file", IMAGE_STRING_VALUE
, 0},
7896 {":ascent", IMAGE_ASCENT_VALUE
, 0},
7897 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR
, 0},
7898 {":relief", IMAGE_INTEGER_VALUE
, 0},
7899 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7900 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7901 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7902 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
7905 /* Structure describing the image type `svg'. Its the same type of
7906 structure defined for all image formats, handled by emacs image
7907 functions. See struct image_type in dispextern.h. */
7909 static struct image_type svg_type
=
7911 /* An identifier showing that this is an image structure for the SVG format. */
7913 /* Handle to a function that can be used to identify a SVG file. */
7915 /* Handle to function used to load a SVG file. */
7917 /* Handle to function to free sresources for SVG. */
7919 /* An internal field to link to the next image type in a list of
7920 image types, will be filled in when registering the format. */
7925 /* Return non-zero if OBJECT is a valid SVG image specification. Do
7926 this by calling parse_image_spec and supplying the keywords that
7927 identify the SVG format. */
7930 svg_image_p (Lisp_Object object
)
7932 struct image_keyword fmt
[SVG_LAST
];
7933 memcpy (fmt
, svg_format
, sizeof fmt
);
7935 if (!parse_image_spec (object
, fmt
, SVG_LAST
, Qsvg
))
7938 /* Must specify either the :data or :file keyword. */
7939 return fmt
[SVG_FILE
].count
+ fmt
[SVG_DATA
].count
== 1;
7942 #include <librsvg/rsvg.h>
7946 /* SVG library functions. */
7947 DEF_IMGLIB_FN (rsvg_handle_new
);
7948 DEF_IMGLIB_FN (rsvg_handle_get_dimensions
);
7949 DEF_IMGLIB_FN (rsvg_handle_write
);
7950 DEF_IMGLIB_FN (rsvg_handle_close
);
7951 DEF_IMGLIB_FN (rsvg_handle_get_pixbuf
);
7952 DEF_IMGLIB_FN (rsvg_handle_free
);
7954 DEF_IMGLIB_FN (gdk_pixbuf_get_width
);
7955 DEF_IMGLIB_FN (gdk_pixbuf_get_height
);
7956 DEF_IMGLIB_FN (gdk_pixbuf_get_pixels
);
7957 DEF_IMGLIB_FN (gdk_pixbuf_get_rowstride
);
7958 DEF_IMGLIB_FN (gdk_pixbuf_get_colorspace
);
7959 DEF_IMGLIB_FN (gdk_pixbuf_get_n_channels
);
7960 DEF_IMGLIB_FN (gdk_pixbuf_get_has_alpha
);
7961 DEF_IMGLIB_FN (gdk_pixbuf_get_bits_per_sample
);
7963 DEF_IMGLIB_FN (g_type_init
);
7964 DEF_IMGLIB_FN (g_object_unref
);
7965 DEF_IMGLIB_FN (g_error_free
);
7967 Lisp_Object Qgdk_pixbuf
, Qglib
, Qgobject
;
7970 init_svg_functions (Lisp_Object libraries
)
7972 HMODULE library
, gdklib
, glib
, gobject
;
7974 if (!(glib
= w32_delayed_load (libraries
, Qglib
))
7975 || !(gobject
= w32_delayed_load (libraries
, Qgobject
))
7976 || !(gdklib
= w32_delayed_load (libraries
, Qgdk_pixbuf
))
7977 || !(library
= w32_delayed_load (libraries
, Qsvg
)))
7980 LOAD_IMGLIB_FN (library
, rsvg_handle_new
);
7981 LOAD_IMGLIB_FN (library
, rsvg_handle_get_dimensions
);
7982 LOAD_IMGLIB_FN (library
, rsvg_handle_write
);
7983 LOAD_IMGLIB_FN (library
, rsvg_handle_close
);
7984 LOAD_IMGLIB_FN (library
, rsvg_handle_get_pixbuf
);
7985 LOAD_IMGLIB_FN (library
, rsvg_handle_free
);
7987 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_width
);
7988 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_height
);
7989 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_pixels
);
7990 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_rowstride
);
7991 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_colorspace
);
7992 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_n_channels
);
7993 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_has_alpha
);
7994 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_bits_per_sample
);
7996 LOAD_IMGLIB_FN (gobject
, g_type_init
);
7997 LOAD_IMGLIB_FN (gobject
, g_object_unref
);
7998 LOAD_IMGLIB_FN (glib
, g_error_free
);
8004 /* The following aliases for library functions allow dynamic loading
8005 to be used on some platforms. */
8006 #define fn_rsvg_handle_new rsvg_handle_new
8007 #define fn_rsvg_handle_get_dimensions rsvg_handle_get_dimensions
8008 #define fn_rsvg_handle_write rsvg_handle_write
8009 #define fn_rsvg_handle_close rsvg_handle_close
8010 #define fn_rsvg_handle_get_pixbuf rsvg_handle_get_pixbuf
8011 #define fn_rsvg_handle_free rsvg_handle_free
8013 #define fn_gdk_pixbuf_get_width gdk_pixbuf_get_width
8014 #define fn_gdk_pixbuf_get_height gdk_pixbuf_get_height
8015 #define fn_gdk_pixbuf_get_pixels gdk_pixbuf_get_pixels
8016 #define fn_gdk_pixbuf_get_rowstride gdk_pixbuf_get_rowstride
8017 #define fn_gdk_pixbuf_get_colorspace gdk_pixbuf_get_colorspace
8018 #define fn_gdk_pixbuf_get_n_channels gdk_pixbuf_get_n_channels
8019 #define fn_gdk_pixbuf_get_has_alpha gdk_pixbuf_get_has_alpha
8020 #define fn_gdk_pixbuf_get_bits_per_sample gdk_pixbuf_get_bits_per_sample
8022 #define fn_g_type_init g_type_init
8023 #define fn_g_object_unref g_object_unref
8024 #define fn_g_error_free g_error_free
8025 #endif /* !HAVE_NTGUI */
8027 /* Load SVG image IMG for use on frame F. Value is non-zero if
8028 successful. this function will go into the svg_type structure, and
8029 the prototype thus needs to be compatible with that structure. */
8032 svg_load (struct frame
*f
, struct image
*img
)
8035 Lisp_Object file_name
;
8037 /* If IMG->spec specifies a file name, create a non-file spec from it. */
8038 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
8039 if (STRINGP (file_name
))
8042 unsigned char *contents
;
8045 file
= x_find_image_file (file_name
);
8046 if (!STRINGP (file
))
8048 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
8052 /* Read the entire file into memory. */
8053 contents
= slurp_file (SDATA (file
), &size
);
8054 if (contents
== NULL
)
8056 image_error ("Error loading SVG image `%s'", img
->spec
, Qnil
);
8059 /* If the file was slurped into memory properly, parse it. */
8060 success_p
= svg_load_image (f
, img
, contents
, size
);
8063 /* Else its not a file, its a lisp object. Load the image from a
8064 lisp object rather than a file. */
8069 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
8070 if (!STRINGP (data
))
8072 image_error ("Invalid image data `%s'", data
, Qnil
);
8075 success_p
= svg_load_image (f
, img
, SDATA (data
), SBYTES (data
));
8081 /* svg_load_image is a helper function for svg_load, which does the
8082 actual loading given contents and size, apart from frame and image
8083 structures, passed from svg_load.
8085 Uses librsvg to do most of the image processing.
8087 Returns non-zero when successful. */
8089 svg_load_image (struct frame
*f
, /* Pointer to emacs frame structure. */
8090 struct image
*img
, /* Pointer to emacs image structure. */
8091 unsigned char *contents
, /* String containing the SVG XML data to be parsed. */
8092 unsigned int size
) /* Size of data in bytes. */
8094 RsvgHandle
*rsvg_handle
;
8095 RsvgDimensionData dimension_data
;
8096 GError
*error
= NULL
;
8100 const guint8
*pixels
;
8103 Lisp_Object specified_bg
;
8108 /* g_type_init is a glib function that must be called prior to using
8109 gnome type library functions. */
8111 /* Make a handle to a new rsvg object. */
8112 rsvg_handle
= (RsvgHandle
*) fn_rsvg_handle_new ();
8114 /* Parse the contents argument and fill in the rsvg_handle. */
8115 fn_rsvg_handle_write (rsvg_handle
, contents
, size
, &error
);
8116 if (error
) goto rsvg_error
;
8118 /* The parsing is complete, rsvg_handle is ready to used, close it
8119 for further writes. */
8120 fn_rsvg_handle_close (rsvg_handle
, &error
);
8121 if (error
) goto rsvg_error
;
8123 fn_rsvg_handle_get_dimensions (rsvg_handle
, &dimension_data
);
8124 if (! check_image_size (f
, dimension_data
.width
, dimension_data
.height
))
8126 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
8130 /* We can now get a valid pixel buffer from the svg file, if all
8132 pixbuf
= (GdkPixbuf
*) fn_rsvg_handle_get_pixbuf (rsvg_handle
);
8133 if (!pixbuf
) goto rsvg_error
;
8134 fn_g_object_unref (rsvg_handle
);
8136 /* Extract some meta data from the svg handle. */
8137 width
= fn_gdk_pixbuf_get_width (pixbuf
);
8138 height
= fn_gdk_pixbuf_get_height (pixbuf
);
8139 pixels
= (const guint8
*) fn_gdk_pixbuf_get_pixels (pixbuf
);
8140 rowstride
= fn_gdk_pixbuf_get_rowstride (pixbuf
);
8142 /* Validate the svg meta data. */
8143 eassert (fn_gdk_pixbuf_get_colorspace (pixbuf
) == GDK_COLORSPACE_RGB
);
8144 eassert (fn_gdk_pixbuf_get_n_channels (pixbuf
) == 4);
8145 eassert (fn_gdk_pixbuf_get_has_alpha (pixbuf
));
8146 eassert (fn_gdk_pixbuf_get_bits_per_sample (pixbuf
) == 8);
8148 /* Try to create a x pixmap to hold the svg pixmap. */
8149 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0, &ximg
, &img
->pixmap
))
8151 fn_g_object_unref (pixbuf
);
8155 init_color_table ();
8157 /* Handle alpha channel by combining the image with a background
8159 specified_bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
8160 if (!STRINGP (specified_bg
)
8161 || !x_defined_color (f
, SDATA (specified_bg
), &background
, 0))
8164 background
.pixel
= FRAME_BACKGROUND_PIXEL (f
);
8165 x_query_color (f
, &background
);
8167 ns_query_color (FRAME_BACKGROUND_COLOR (f
), &background
, 1);
8171 /* SVG pixmaps specify transparency in the last byte, so right
8172 shift 8 bits to get rid of it, since emacs doesn't support
8174 background
.red
>>= 8;
8175 background
.green
>>= 8;
8176 background
.blue
>>= 8;
8178 /* This loop handles opacity values, since Emacs assumes
8179 non-transparent images. Each pixel must be "flattened" by
8180 calculating the resulting color, given the transparency of the
8181 pixel, and the image background color. */
8182 for (y
= 0; y
< height
; ++y
)
8184 for (x
= 0; x
< width
; ++x
)
8194 opacity
= *pixels
++;
8196 red
= ((red
* opacity
)
8197 + (background
.red
* ((1 << 8) - opacity
)));
8198 green
= ((green
* opacity
)
8199 + (background
.green
* ((1 << 8) - opacity
)));
8200 blue
= ((blue
* opacity
)
8201 + (background
.blue
* ((1 << 8) - opacity
)));
8203 XPutPixel (ximg
, x
, y
, lookup_rgb_color (f
, red
, green
, blue
));
8206 pixels
+= rowstride
- 4 * width
;
8209 #ifdef COLOR_TABLE_SUPPORT
8210 /* Remember colors allocated for this image. */
8211 img
->colors
= colors_in_color_table (&img
->ncolors
);
8212 free_color_table ();
8213 #endif /* COLOR_TABLE_SUPPORT */
8215 fn_g_object_unref (pixbuf
);
8218 img
->height
= height
;
8220 /* Maybe fill in the background field while we have ximg handy.
8221 Casting avoids a GCC warning. */
8222 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
8224 /* Put the image into the pixmap, then free the X image and its
8226 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
8227 x_destroy_x_image (ximg
);
8232 fn_g_object_unref (rsvg_handle
);
8233 /* FIXME: Use error->message so the user knows what is the actual
8234 problem with the image. */
8235 image_error ("Error parsing SVG image `%s'", img
->spec
, Qnil
);
8236 fn_g_error_free (error
);
8240 #endif /* defined (HAVE_RSVG) */
8245 /***********************************************************************
8247 ***********************************************************************/
8249 #ifdef HAVE_X_WINDOWS
8250 #define HAVE_GHOSTSCRIPT 1
8251 #endif /* HAVE_X_WINDOWS */
8253 #ifdef HAVE_GHOSTSCRIPT
8255 static int gs_image_p (Lisp_Object object
);
8256 static int gs_load (struct frame
*f
, struct image
*img
);
8257 static void gs_clear_image (struct frame
*f
, struct image
*img
);
8259 /* Keyword symbols. */
8261 Lisp_Object QCloader
, QCbounding_box
, QCpt_width
, QCpt_height
;
8263 /* Indices of image specification fields in gs_format, below. */
8265 enum gs_keyword_index
8283 /* Vector of image_keyword structures describing the format
8284 of valid user-defined image specifications. */
8286 static const struct image_keyword gs_format
[GS_LAST
] =
8288 {":type", IMAGE_SYMBOL_VALUE
, 1},
8289 {":pt-width", IMAGE_POSITIVE_INTEGER_VALUE
, 1},
8290 {":pt-height", IMAGE_POSITIVE_INTEGER_VALUE
, 1},
8291 {":file", IMAGE_STRING_VALUE
, 1},
8292 {":loader", IMAGE_FUNCTION_VALUE
, 0},
8293 {":bounding-box", IMAGE_DONT_CHECK_VALUE_TYPE
, 1},
8294 {":ascent", IMAGE_ASCENT_VALUE
, 0},
8295 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR
, 0},
8296 {":relief", IMAGE_INTEGER_VALUE
, 0},
8297 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8298 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8299 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8300 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
8303 /* Structure describing the image type `ghostscript'. */
8305 static struct image_type gs_type
=
8315 /* Free X resources of Ghostscript image IMG which is used on frame F. */
8318 gs_clear_image (struct frame
*f
, struct image
*img
)
8320 /* IMG->data.ptr_val may contain a recorded colormap. */
8321 xfree (img
->data
.ptr_val
);
8322 x_clear_image (f
, img
);
8326 /* Return non-zero if OBJECT is a valid Ghostscript image
8330 gs_image_p (Lisp_Object object
)
8332 struct image_keyword fmt
[GS_LAST
];
8336 memcpy (fmt
, gs_format
, sizeof fmt
);
8338 if (!parse_image_spec (object
, fmt
, GS_LAST
, Qpostscript
))
8341 /* Bounding box must be a list or vector containing 4 integers. */
8342 tem
= fmt
[GS_BOUNDING_BOX
].value
;
8345 for (i
= 0; i
< 4; ++i
, tem
= XCDR (tem
))
8346 if (!CONSP (tem
) || !INTEGERP (XCAR (tem
)))
8351 else if (VECTORP (tem
))
8353 if (XVECTOR (tem
)->size
!= 4)
8355 for (i
= 0; i
< 4; ++i
)
8356 if (!INTEGERP (XVECTOR (tem
)->contents
[i
]))
8366 /* Load Ghostscript image IMG for use on frame F. Value is non-zero
8370 gs_load (struct frame
*f
, struct image
*img
)
8373 Lisp_Object window_and_pixmap_id
= Qnil
, loader
, pt_height
, pt_width
;
8375 double in_width
, in_height
;
8376 Lisp_Object pixel_colors
= Qnil
;
8378 /* Compute pixel size of pixmap needed from the given size in the
8379 image specification. Sizes in the specification are in pt. 1 pt
8380 = 1/72 in, xdpi and ydpi are stored in the frame's X display
8382 pt_width
= image_spec_value (img
->spec
, QCpt_width
, NULL
);
8383 in_width
= INTEGERP (pt_width
) ? XFASTINT (pt_width
) / 72.0 : 0;
8384 img
->width
= in_width
* FRAME_X_DISPLAY_INFO (f
)->resx
;
8385 pt_height
= image_spec_value (img
->spec
, QCpt_height
, NULL
);
8386 in_height
= INTEGERP (pt_height
) ? XFASTINT (pt_height
) / 72.0 : 0;
8387 img
->height
= in_height
* FRAME_X_DISPLAY_INFO (f
)->resy
;
8389 if (!check_image_size (f
, img
->width
, img
->height
))
8391 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
8395 /* Create the pixmap. */
8396 xassert (img
->pixmap
== NO_PIXMAP
);
8398 /* Only W32 version did BLOCK_INPUT here. ++kfs */
8400 img
->pixmap
= XCreatePixmap (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
8401 img
->width
, img
->height
,
8402 DefaultDepthOfScreen (FRAME_X_SCREEN (f
)));
8407 image_error ("Unable to create pixmap for `%s'", img
->spec
, Qnil
);
8411 /* Call the loader to fill the pixmap. It returns a process object
8412 if successful. We do not record_unwind_protect here because
8413 other places in redisplay like calling window scroll functions
8414 don't either. Let the Lisp loader use `unwind-protect' instead. */
8415 sprintf (buffer
, "%lu %lu",
8416 (unsigned long) FRAME_X_WINDOW (f
),
8417 (unsigned long) img
->pixmap
);
8418 window_and_pixmap_id
= build_string (buffer
);
8420 sprintf (buffer
, "%lu %lu",
8421 FRAME_FOREGROUND_PIXEL (f
),
8422 FRAME_BACKGROUND_PIXEL (f
));
8423 pixel_colors
= build_string (buffer
);
8425 XSETFRAME (frame
, f
);
8426 loader
= image_spec_value (img
->spec
, QCloader
, NULL
);
8428 loader
= intern ("gs-load-image");
8430 img
->data
.lisp_val
= call6 (loader
, frame
, img
->spec
,
8431 make_number (img
->width
),
8432 make_number (img
->height
),
8433 window_and_pixmap_id
,
8435 return PROCESSP (img
->data
.lisp_val
);
8439 /* Kill the Ghostscript process that was started to fill PIXMAP on
8440 frame F. Called from XTread_socket when receiving an event
8441 telling Emacs that Ghostscript has finished drawing. */
8444 x_kill_gs_process (Pixmap pixmap
, struct frame
*f
)
8446 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
8450 /* Find the image containing PIXMAP. */
8451 for (i
= 0; i
< c
->used
; ++i
)
8452 if (c
->images
[i
]->pixmap
== pixmap
)
8455 /* Should someone in between have cleared the image cache, for
8456 instance, give up. */
8460 /* Kill the GS process. We should have found PIXMAP in the image
8461 cache and its image should contain a process object. */
8463 xassert (PROCESSP (img
->data
.lisp_val
));
8464 Fkill_process (img
->data
.lisp_val
, Qnil
);
8465 img
->data
.lisp_val
= Qnil
;
8467 #if defined (HAVE_X_WINDOWS)
8469 /* On displays with a mutable colormap, figure out the colors
8470 allocated for the image by looking at the pixels of an XImage for
8472 class = FRAME_X_VISUAL (f
)->class;
8473 if (class != StaticColor
&& class != StaticGray
&& class != TrueColor
)
8479 /* Try to get an XImage for img->pixmep. */
8480 ximg
= XGetImage (FRAME_X_DISPLAY (f
), img
->pixmap
,
8481 0, 0, img
->width
, img
->height
, ~0, ZPixmap
);
8486 /* Initialize the color table. */
8487 init_color_table ();
8489 /* For each pixel of the image, look its color up in the
8490 color table. After having done so, the color table will
8491 contain an entry for each color used by the image. */
8492 for (y
= 0; y
< img
->height
; ++y
)
8493 for (x
= 0; x
< img
->width
; ++x
)
8495 unsigned long pixel
= XGetPixel (ximg
, x
, y
);
8496 lookup_pixel_color (f
, pixel
);
8499 /* Record colors in the image. Free color table and XImage. */
8500 #ifdef COLOR_TABLE_SUPPORT
8501 img
->colors
= colors_in_color_table (&img
->ncolors
);
8502 free_color_table ();
8504 XDestroyImage (ximg
);
8506 #if 0 /* This doesn't seem to be the case. If we free the colors
8507 here, we get a BadAccess later in x_clear_image when
8508 freeing the colors. */
8509 /* We have allocated colors once, but Ghostscript has also
8510 allocated colors on behalf of us. So, to get the
8511 reference counts right, free them once. */
8513 x_free_colors (f
, img
->colors
, img
->ncolors
);
8517 image_error ("Cannot get X image of `%s'; colors will not be freed",
8522 #endif /* HAVE_X_WINDOWS */
8524 /* Now that we have the pixmap, compute mask and transform the
8525 image if requested. */
8527 postprocess_image (f
, img
);
8531 #endif /* HAVE_GHOSTSCRIPT */
8534 /***********************************************************************
8536 ***********************************************************************/
8540 DEFUN ("imagep", Fimagep
, Simagep
, 1, 1, 0,
8541 doc
: /* Value is non-nil if SPEC is a valid image specification. */)
8544 return valid_image_p (spec
) ? Qt
: Qnil
;
8548 DEFUN ("lookup-image", Flookup_image
, Slookup_image
, 1, 1, 0, "")
8553 if (valid_image_p (spec
))
8554 id
= lookup_image (SELECTED_FRAME (), spec
);
8557 return make_number (id
);
8560 #endif /* GLYPH_DEBUG != 0 */
8563 /***********************************************************************
8565 ***********************************************************************/
8568 /* Image types that rely on external libraries are loaded dynamically
8569 if the library is available. */
8570 #define CHECK_LIB_AVAILABLE(image_type, init_lib_fn, libraries) \
8571 define_image_type (image_type, init_lib_fn (libraries))
8573 #define CHECK_LIB_AVAILABLE(image_type, init_lib_fn, libraries) \
8574 define_image_type (image_type, 1)
8575 #endif /* HAVE_NTGUI */
8577 DEFUN ("init-image-library", Finit_image_library
, Sinit_image_library
, 2, 2, 0,
8578 doc
: /* Initialize image library implementing image type TYPE.
8579 Return non-nil if TYPE is a supported image type.
8581 Image types pbm and xbm are prebuilt; other types are loaded here.
8582 Libraries to load are specified in alist LIBRARIES (usually, the value
8583 of `dynamic-library-alist', which see). */)
8584 (Lisp_Object type
, Lisp_Object libraries
)
8588 /* Don't try to reload the library. */
8589 tested
= Fassq (type
, Vimage_type_cache
);
8591 return XCDR (tested
);
8593 #if defined (HAVE_XPM) || defined (HAVE_NS)
8594 if (EQ (type
, Qxpm
))
8595 return CHECK_LIB_AVAILABLE (&xpm_type
, init_xpm_functions
, libraries
);
8598 #if defined (HAVE_JPEG) || defined (HAVE_NS)
8599 if (EQ (type
, Qjpeg
))
8600 return CHECK_LIB_AVAILABLE (&jpeg_type
, init_jpeg_functions
, libraries
);
8603 #if defined (HAVE_TIFF) || defined (HAVE_NS)
8604 if (EQ (type
, Qtiff
))
8605 return CHECK_LIB_AVAILABLE (&tiff_type
, init_tiff_functions
, libraries
);
8608 #if defined (HAVE_GIF) || defined (HAVE_NS)
8609 if (EQ (type
, Qgif
))
8610 return CHECK_LIB_AVAILABLE (&gif_type
, init_gif_functions
, libraries
);
8613 #if defined (HAVE_PNG) || defined (HAVE_NS)
8614 if (EQ (type
, Qpng
))
8615 return CHECK_LIB_AVAILABLE (&png_type
, init_png_functions
, libraries
);
8618 #if defined (HAVE_RSVG)
8619 if (EQ (type
, Qsvg
))
8620 return CHECK_LIB_AVAILABLE (&svg_type
, init_svg_functions
, libraries
);
8623 #if defined (HAVE_IMAGEMAGICK)
8624 if (EQ (type
, Qimagemagick
))
8626 /* MagickWandGenesis() initializes the imagemagick library. */
8627 MagickWandGenesis ();
8628 return CHECK_LIB_AVAILABLE (&imagemagick_type
, init_imagemagick_functions
,
8633 #ifdef HAVE_GHOSTSCRIPT
8634 if (EQ (type
, Qpostscript
))
8635 return CHECK_LIB_AVAILABLE (&gs_type
, init_gs_functions
, libraries
);
8638 /* If the type is not recognized, avoid testing it ever again. */
8639 CACHE_IMAGE_TYPE (type
, Qnil
);
8644 syms_of_image (void)
8646 /* Initialize this only once, since that's what we do with Vimage_types
8647 and they are supposed to be in sync. Initializing here gives correct
8648 operation on GNU/Linux of calling dump-emacs after loading some images. */
8651 /* Must be defined now becase we're going to update it below, while
8652 defining the supported image types. */
8653 DEFVAR_LISP ("image-types", &Vimage_types
,
8654 doc
: /* List of potentially supported image types.
8655 Each element of the list is a symbol for an image type, like 'jpeg or 'png.
8656 To check whether it is really supported, use `image-type-available-p'. */);
8657 Vimage_types
= Qnil
;
8659 DEFVAR_LISP ("max-image-size", &Vmax_image_size
,
8660 doc
: /* Maximum size of images.
8661 Emacs will not load an image into memory if its pixel width or
8662 pixel height exceeds this limit.
8664 If the value is an integer, it directly specifies the maximum
8665 image height and width, measured in pixels. If it is a floating
8666 point number, it specifies the maximum image height and width
8667 as a ratio to the frame height and width. If the value is
8668 non-numeric, there is no explicit limit on the size of images. */);
8669 Vmax_image_size
= make_float (MAX_IMAGE_SIZE
);
8671 Vimage_type_cache
= Qnil
;
8672 staticpro (&Vimage_type_cache
);
8674 Qpbm
= intern_c_string ("pbm");
8676 ADD_IMAGE_TYPE (Qpbm
);
8678 Qxbm
= intern_c_string ("xbm");
8680 ADD_IMAGE_TYPE (Qxbm
);
8682 define_image_type (&xbm_type
, 1);
8683 define_image_type (&pbm_type
, 1);
8685 Qcount
= intern_c_string ("count");
8686 staticpro (&Qcount
);
8687 Qextension_data
= intern_c_string ("extension-data");
8688 staticpro (&Qextension_data
);
8690 QCascent
= intern_c_string (":ascent");
8691 staticpro (&QCascent
);
8692 QCmargin
= intern_c_string (":margin");
8693 staticpro (&QCmargin
);
8694 QCrelief
= intern_c_string (":relief");
8695 staticpro (&QCrelief
);
8696 QCconversion
= intern_c_string (":conversion");
8697 staticpro (&QCconversion
);
8698 QCcolor_symbols
= intern_c_string (":color-symbols");
8699 staticpro (&QCcolor_symbols
);
8700 QCheuristic_mask
= intern_c_string (":heuristic-mask");
8701 staticpro (&QCheuristic_mask
);
8702 QCindex
= intern_c_string (":index");
8703 staticpro (&QCindex
);
8704 QCgeometry
= intern_c_string (":geometry");
8705 staticpro (&QCgeometry
);
8706 QCcrop
= intern_c_string (":crop");
8707 staticpro (&QCcrop
);
8708 QCrotation
= intern_c_string (":rotation");
8709 staticpro (&QCrotation
);
8710 QCmatrix
= intern_c_string (":matrix");
8711 staticpro (&QCmatrix
);
8712 QCcolor_adjustment
= intern_c_string (":color-adjustment");
8713 staticpro (&QCcolor_adjustment
);
8714 QCmask
= intern_c_string (":mask");
8715 staticpro (&QCmask
);
8717 Qlaplace
= intern_c_string ("laplace");
8718 staticpro (&Qlaplace
);
8719 Qemboss
= intern_c_string ("emboss");
8720 staticpro (&Qemboss
);
8721 Qedge_detection
= intern_c_string ("edge-detection");
8722 staticpro (&Qedge_detection
);
8723 Qheuristic
= intern_c_string ("heuristic");
8724 staticpro (&Qheuristic
);
8726 Qpostscript
= intern_c_string ("postscript");
8727 staticpro (&Qpostscript
);
8728 #ifdef HAVE_GHOSTSCRIPT
8729 ADD_IMAGE_TYPE (Qpostscript
);
8730 QCloader
= intern_c_string (":loader");
8731 staticpro (&QCloader
);
8732 QCbounding_box
= intern_c_string (":bounding-box");
8733 staticpro (&QCbounding_box
);
8734 QCpt_width
= intern_c_string (":pt-width");
8735 staticpro (&QCpt_width
);
8736 QCpt_height
= intern_c_string (":pt-height");
8737 staticpro (&QCpt_height
);
8738 #endif /* HAVE_GHOSTSCRIPT */
8740 #if defined (HAVE_XPM) || defined (HAVE_NS)
8741 Qxpm
= intern_c_string ("xpm");
8743 ADD_IMAGE_TYPE (Qxpm
);
8746 #if defined (HAVE_JPEG) || defined (HAVE_NS)
8747 Qjpeg
= intern_c_string ("jpeg");
8749 ADD_IMAGE_TYPE (Qjpeg
);
8752 #if defined (HAVE_TIFF) || defined (HAVE_NS)
8753 Qtiff
= intern_c_string ("tiff");
8755 ADD_IMAGE_TYPE (Qtiff
);
8758 #if defined (HAVE_GIF) || defined (HAVE_NS)
8759 Qgif
= intern_c_string ("gif");
8761 ADD_IMAGE_TYPE (Qgif
);
8764 #if defined (HAVE_PNG) || defined (HAVE_NS)
8765 Qpng
= intern_c_string ("png");
8767 ADD_IMAGE_TYPE (Qpng
);
8770 #if defined (HAVE_IMAGEMAGICK)
8771 Qimagemagick
= intern_c_string ("imagemagick");
8772 staticpro (&Qimagemagick
);
8773 ADD_IMAGE_TYPE (Qimagemagick
);
8776 #if defined (HAVE_RSVG)
8777 Qsvg
= intern_c_string ("svg");
8779 ADD_IMAGE_TYPE (Qsvg
);
8781 /* Other libraries used directly by svg code. */
8782 Qgdk_pixbuf
= intern_c_string ("gdk-pixbuf");
8783 staticpro (&Qgdk_pixbuf
);
8784 Qglib
= intern_c_string ("glib");
8786 Qgobject
= intern_c_string ("gobject");
8787 staticpro (&Qgobject
);
8788 #endif /* HAVE_NTGUI */
8789 #endif /* HAVE_RSVG */
8791 defsubr (&Sinit_image_library
);
8792 #ifdef HAVE_IMAGEMAGICK
8793 defsubr (&Simagemagick_types
);
8795 defsubr (&Sclear_image_cache
);
8796 defsubr (&Simage_flush
);
8797 defsubr (&Simage_size
);
8798 defsubr (&Simage_mask_p
);
8799 defsubr (&Simage_metadata
);
8803 defsubr (&Slookup_image
);
8806 DEFVAR_BOOL ("cross-disabled-images", &cross_disabled_images
,
8807 doc
: /* Non-nil means always draw a cross over disabled images.
8808 Disabled images are those having a `:conversion disabled' property.
8809 A cross is always drawn on black & white displays. */);
8810 cross_disabled_images
= 0;
8812 DEFVAR_LISP ("x-bitmap-file-path", &Vx_bitmap_file_path
,
8813 doc
: /* List of directories to search for window system bitmap files. */);
8814 Vx_bitmap_file_path
= decode_env_path ((char *) 0, PATH_BITMAPS
);
8816 DEFVAR_LISP ("image-cache-eviction-delay", &Vimage_cache_eviction_delay
,
8817 doc
: /* Maximum time after which images are removed from the cache.
8818 When an image has not been displayed this many seconds, Emacs
8819 automatically removes it from the image cache. If the cache contains
8820 a large number of images, the actual eviction time may be shorter.
8821 The value can also be nil, meaning the cache is never cleared.
8823 The function `clear-image-cache' disregards this variable. */);
8824 Vimage_cache_eviction_delay
= make_number (300);
8825 #ifdef HAVE_IMAGEMAGICK
8826 DEFVAR_LISP ("imagemagick-render-type", &Vimagemagick_render_type
,
8827 doc
: /* Choose between ImageMagick render methods. */);
8837 /* arch-tag: 123c2a5e-14a8-4c53-ab95-af47d7db49b9
8838 (do not change this comment) */