Fix typo in previous comment.
[bpt/emacs.git] / src / image.c
CommitLineData
4ef0d4d0 1/* Functions for image support on window system.
73b0cd50 2 Copyright (C) 1989, 1992-2011 Free Software Foundation, Inc.
4ef0d4d0
KS
3
4This file is part of GNU Emacs.
5
9ec0b715 6GNU Emacs is free software: you can redistribute it and/or modify
4ef0d4d0 7it under the terms of the GNU General Public License as published by
9ec0b715
GM
8the Free Software Foundation, either version 3 of the License, or
9(at your option) any later version.
4ef0d4d0
KS
10
11GNU Emacs is distributed in the hope that it will be useful,
12but WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14GNU General Public License for more details.
15
16You should have received a copy of the GNU General Public License
9ec0b715 17along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
4ef0d4d0
KS
18
19#include <config.h>
4ef0d4d0
KS
20#include <stdio.h>
21#include <math.h>
be8c4ce4 22#include <ctype.h>
4ef0d4d0 23#include <unistd.h>
4ef0d4d0 24
d7306fe6
DN
25#ifdef HAVE_PNG
26#if defined HAVE_LIBPNG_PNG_H
27# include <libpng/png.h>
28#else
29# include <png.h>
30#endif
285d07e2 31#endif
d7306fe6 32
c3417a74
DN
33#include <setjmp.h>
34
4ef0d4d0
KS
35/* This makes the fields of a Display accessible, in Xlib header files. */
36
37#define XLIB_ILLEGAL_ACCESS
38
39#include "lisp.h"
40#include "frame.h"
41#include "window.h"
42#include "dispextern.h"
43#include "blockinput.h"
44#include "systime.h"
45#include <epaths.h>
3dcc8b84 46#include "character.h"
022af124 47#include "coding.h"
6087292e 48#include "termhooks.h"
3dcc8b84 49#include "font.h"
4ef0d4d0
KS
50
51#ifdef HAVE_X_WINDOWS
52#include "xterm.h"
53#include <sys/types.h>
54#include <sys/stat.h>
55
56#define COLOR_TABLE_SUPPORT 1
57
58typedef struct x_bitmap_record Bitmap_Record;
4ef0d4d0
KS
59#define GET_PIXEL(ximg, x, y) XGetPixel(ximg, x, y)
60#define NO_PIXMAP None
4ef0d4d0
KS
61
62#define RGB_PIXEL_COLOR unsigned long
63
9ecf6403
YM
64#define PIX_MASK_RETAIN 0
65#define PIX_MASK_DRAW 1
4ef0d4d0
KS
66#endif /* HAVE_X_WINDOWS */
67
68
69#ifdef HAVE_NTGUI
70#include "w32term.h"
71
72/* W32_TODO : Color tables on W32. */
73#undef COLOR_TABLE_SUPPORT
74
75typedef struct w32_bitmap_record Bitmap_Record;
4ef0d4d0
KS
76#define GET_PIXEL(ximg, x, y) GetPixel(ximg, x, y)
77#define NO_PIXMAP 0
4ef0d4d0
KS
78
79#define RGB_PIXEL_COLOR COLORREF
80
9ecf6403
YM
81#define PIX_MASK_RETAIN 0
82#define PIX_MASK_DRAW 1
4ef0d4d0
KS
83
84#define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
85#define x_defined_color w32_defined_color
86#define DefaultDepthOfScreen(screen) (one_w32_display_info.n_cbits)
8b7d0a16
JR
87
88/* Functions from w32term.c that depend on XColor (so can't go in w32term.h
89 without modifying lots of files). */
90extern void x_query_colors (struct frame *f, XColor *colors, int ncolors);
91extern void x_query_color (struct frame *f, XColor *color);
5be1c984
EZ
92
93/* Version of libpng that we were compiled with, or -1 if no PNG
94 support was compiled in. This is tested by w32-win.el to correctly
95 set up the alist used to search for PNG libraries. */
96Lisp_Object Qlibpng_version;
4ef0d4d0
KS
97#endif /* HAVE_NTGUI */
98
edfda783
AR
99#ifdef HAVE_NS
100#include "nsterm.h"
101#include <sys/types.h>
102#include <sys/stat.h>
103
104#undef COLOR_TABLE_SUPPORT
105
106typedef struct ns_bitmap_record Bitmap_Record;
107
108#define GET_PIXEL(ximg, x, y) XGetPixel(ximg, x, y)
109#define NO_PIXMAP 0
110
111#define RGB_PIXEL_COLOR unsigned long
112#define ZPixmap 0
113
114#define PIX_MASK_RETAIN 0
115#define PIX_MASK_DRAW 1
116
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
9e50ff0c 121#define DefaultDepthOfScreen(screen) x_display_list->n_planes
edfda783
AR
122#endif /* HAVE_NS */
123
124
97ec208f
DN
125/* The symbol `postscript' identifying images of this type. */
126
955cbe7b 127static Lisp_Object Qpostscript;
4ef0d4d0 128
f57e2426
J
129static void x_disable_image (struct frame *, struct image *);
130static void x_edge_detection (struct frame *, struct image *, Lisp_Object,
131 Lisp_Object);
4ef0d4d0 132
f57e2426
J
133static void init_color_table (void);
134static unsigned long lookup_rgb_color (struct frame *f, int r, int g, int b);
4ef0d4d0 135#ifdef COLOR_TABLE_SUPPORT
f57e2426
J
136static void free_color_table (void);
137static unsigned long *colors_in_color_table (int *n);
138static unsigned long lookup_pixel_color (struct frame *f, unsigned long p);
4ef0d4d0 139#endif
16a97296 140INFUN (Finit_image_library, 2);
4ef0d4d0
KS
141
142/* Code to deal with bitmaps. Bitmaps are referenced by their bitmap
143 id, which is just an int that this section returns. Bitmaps are
144 reference counted so they can be shared among frames.
145
146 Bitmap indices are guaranteed to be > 0, so a negative number can
147 be used to indicate no bitmap.
148
149 If you use x_create_bitmap_from_data, then you must keep track of
150 the bitmaps yourself. That is, creating a bitmap from the same
151 data more than once will not be caught. */
152
edfda783
AR
153#ifdef HAVE_NS
154XImagePtr
155XGetImage (Display *display, Pixmap pixmap, int x, int y,
156 unsigned int width, unsigned int height,
157 unsigned long plane_mask, int format)
158{
6fb5f7da 159 /* TODO: not sure what this function is supposed to do.. */
ed3751c8 160 ns_retain_object (pixmap);
edfda783
AR
161 return pixmap;
162}
163
164/* use with imgs created by ns_image_for_XPM */
165unsigned long
166XGetPixel (XImagePtr ximage, int x, int y)
167{
ed3751c8 168 return ns_get_pixel (ximage, x, y);
edfda783
AR
169}
170
171/* use with imgs created by ns_image_for_XPM; alpha set to 1;
172 pixel is assumed to be in form RGB */
173void
174XPutPixel (XImagePtr ximage, int x, int y, unsigned long pixel)
175{
ed3751c8 176 ns_put_pixel (ximage, x, y, pixel);
edfda783
AR
177}
178#endif /* HAVE_NS */
179
4ef0d4d0
KS
180
181/* Functions to access the contents of a bitmap, given an id. */
182
183int
d3da34e0 184x_bitmap_height (FRAME_PTR f, int id)
4ef0d4d0
KS
185{
186 return FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].height;
187}
188
189int
d3da34e0 190x_bitmap_width (FRAME_PTR f, int id)
4ef0d4d0
KS
191{
192 return FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].width;
193}
194
195#if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI)
196int
d3da34e0 197x_bitmap_pixmap (FRAME_PTR f, int id)
4ef0d4d0
KS
198{
199 return (int) FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].pixmap;
200}
201#endif
202
203#ifdef HAVE_X_WINDOWS
204int
d3da34e0 205x_bitmap_mask (FRAME_PTR f, int id)
4ef0d4d0
KS
206{
207 return FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].mask;
208}
209#endif
210
211/* Allocate a new bitmap record. Returns index of new record. */
212
213static int
d3da34e0 214x_allocate_bitmap_record (FRAME_PTR f)
4ef0d4d0
KS
215{
216 Display_Info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
217 int i;
218
219 if (dpyinfo->bitmaps == NULL)
220 {
221 dpyinfo->bitmaps_size = 10;
222 dpyinfo->bitmaps
223 = (Bitmap_Record *) xmalloc (dpyinfo->bitmaps_size * sizeof (Bitmap_Record));
224 dpyinfo->bitmaps_last = 1;
225 return 1;
226 }
227
228 if (dpyinfo->bitmaps_last < dpyinfo->bitmaps_size)
229 return ++dpyinfo->bitmaps_last;
230
231 for (i = 0; i < dpyinfo->bitmaps_size; ++i)
232 if (dpyinfo->bitmaps[i].refcount == 0)
233 return i + 1;
234
235 dpyinfo->bitmaps_size *= 2;
236 dpyinfo->bitmaps
237 = (Bitmap_Record *) xrealloc (dpyinfo->bitmaps,
238 dpyinfo->bitmaps_size * sizeof (Bitmap_Record));
239 return ++dpyinfo->bitmaps_last;
240}
241
242/* Add one reference to the reference count of the bitmap with id ID. */
243
244void
d3da34e0 245x_reference_bitmap (FRAME_PTR f, int id)
4ef0d4d0
KS
246{
247 ++FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].refcount;
248}
249
250/* Create a bitmap for frame F from a HEIGHT x WIDTH array of bits at BITS. */
251
252int
d3da34e0 253x_create_bitmap_from_data (struct frame *f, char *bits, unsigned int width, unsigned int height)
4ef0d4d0
KS
254{
255 Display_Info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
256 int id;
257
258#ifdef HAVE_X_WINDOWS
259 Pixmap bitmap;
260 bitmap = XCreateBitmapFromData (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
261 bits, width, height);
262 if (! bitmap)
263 return -1;
264#endif /* HAVE_X_WINDOWS */
265
266#ifdef HAVE_NTGUI
267 Pixmap bitmap;
268 bitmap = CreateBitmap (width, height,
269 FRAME_X_DISPLAY_INFO (XFRAME (frame))->n_planes,
270 FRAME_X_DISPLAY_INFO (XFRAME (frame))->n_cbits,
271 bits);
272 if (! bitmap)
273 return -1;
274#endif /* HAVE_NTGUI */
275
edfda783 276#ifdef HAVE_NS
ed3751c8 277 void *bitmap = ns_image_from_XBM (bits, width, height);
edfda783
AR
278 if (!bitmap)
279 return -1;
280#endif
281
4ef0d4d0 282 id = x_allocate_bitmap_record (f);
4ef0d4d0 283
edfda783
AR
284#ifdef HAVE_NS
285 dpyinfo->bitmaps[id - 1].img = bitmap;
286 dpyinfo->bitmaps[id - 1].depth = 1;
287#endif
288
4ef0d4d0
KS
289 dpyinfo->bitmaps[id - 1].file = NULL;
290 dpyinfo->bitmaps[id - 1].height = height;
291 dpyinfo->bitmaps[id - 1].width = width;
292 dpyinfo->bitmaps[id - 1].refcount = 1;
293
294#ifdef HAVE_X_WINDOWS
295 dpyinfo->bitmaps[id - 1].pixmap = bitmap;
296 dpyinfo->bitmaps[id - 1].have_mask = 0;
297 dpyinfo->bitmaps[id - 1].depth = 1;
298#endif /* HAVE_X_WINDOWS */
299
300#ifdef HAVE_NTGUI
301 dpyinfo->bitmaps[id - 1].pixmap = bitmap;
302 dpyinfo->bitmaps[id - 1].hinst = NULL;
303 dpyinfo->bitmaps[id - 1].depth = 1;
304#endif /* HAVE_NTGUI */
305
306 return id;
307}
308
309/* Create bitmap from file FILE for frame F. */
310
311int
d3da34e0 312x_create_bitmap_from_file (struct frame *f, Lisp_Object file)
4ef0d4d0 313{
edfda783
AR
314 Display_Info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
315
4ef0d4d0
KS
316#ifdef HAVE_NTGUI
317 return -1; /* W32_TODO : bitmap support */
318#endif /* HAVE_NTGUI */
319
edfda783
AR
320#ifdef HAVE_NS
321 int id;
ed3751c8 322 void *bitmap = ns_image_from_file (file);
edfda783
AR
323
324 if (!bitmap)
325 return -1;
326
327
328 id = x_allocate_bitmap_record (f);
329 dpyinfo->bitmaps[id - 1].img = bitmap;
330 dpyinfo->bitmaps[id - 1].refcount = 1;
331 dpyinfo->bitmaps[id - 1].file = (char *) xmalloc (SBYTES (file) + 1);
332 dpyinfo->bitmaps[id - 1].depth = 1;
ed3751c8
JB
333 dpyinfo->bitmaps[id - 1].height = ns_image_width (bitmap);
334 dpyinfo->bitmaps[id - 1].width = ns_image_height (bitmap);
edfda783
AR
335 strcpy (dpyinfo->bitmaps[id - 1].file, SDATA (file));
336 return id;
337#endif
338
4ef0d4d0 339#ifdef HAVE_X_WINDOWS
4ef0d4d0
KS
340 unsigned int width, height;
341 Pixmap bitmap;
342 int xhot, yhot, result, id;
343 Lisp_Object found;
344 int fd;
345 char *filename;
346
347 /* Look for an existing bitmap with the same name. */
348 for (id = 0; id < dpyinfo->bitmaps_last; ++id)
349 {
350 if (dpyinfo->bitmaps[id].refcount
351 && dpyinfo->bitmaps[id].file
51b59d79 352 && !strcmp (dpyinfo->bitmaps[id].file, SSDATA (file)))
4ef0d4d0
KS
353 {
354 ++dpyinfo->bitmaps[id].refcount;
355 return id + 1;
356 }
357 }
358
359 /* Search bitmap-file-path for the file, if appropriate. */
360 fd = openp (Vx_bitmap_file_path, file, Qnil, &found, Qnil);
361 if (fd < 0)
362 return -1;
363 emacs_close (fd);
364
51b59d79 365 filename = SSDATA (found);
4ef0d4d0
KS
366
367 result = XReadBitmapFile (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
368 filename, &width, &height, &bitmap, &xhot, &yhot);
369 if (result != BitmapSuccess)
370 return -1;
371
372 id = x_allocate_bitmap_record (f);
373 dpyinfo->bitmaps[id - 1].pixmap = bitmap;
374 dpyinfo->bitmaps[id - 1].have_mask = 0;
375 dpyinfo->bitmaps[id - 1].refcount = 1;
376 dpyinfo->bitmaps[id - 1].file = (char *) xmalloc (SBYTES (file) + 1);
377 dpyinfo->bitmaps[id - 1].depth = 1;
378 dpyinfo->bitmaps[id - 1].height = height;
379 dpyinfo->bitmaps[id - 1].width = width;
42a5b22f 380 strcpy (dpyinfo->bitmaps[id - 1].file, SSDATA (file));
4ef0d4d0
KS
381
382 return id;
383#endif /* HAVE_X_WINDOWS */
384}
385
386/* Free bitmap B. */
387
388static void
d3da34e0 389free_bitmap_record (Display_Info *dpyinfo, Bitmap_Record *bm)
4ef0d4d0
KS
390{
391#ifdef HAVE_X_WINDOWS
392 XFreePixmap (dpyinfo->display, bm->pixmap);
393 if (bm->have_mask)
394 XFreePixmap (dpyinfo->display, bm->mask);
395#endif /* HAVE_X_WINDOWS */
396
397#ifdef HAVE_NTGUI
398 DeleteObject (bm->pixmap);
399#endif /* HAVE_NTGUI */
400
edfda783 401#ifdef HAVE_NS
ed3751c8 402 ns_release_object (bm->img);
edfda783
AR
403#endif
404
4ef0d4d0
KS
405 if (bm->file)
406 {
407 xfree (bm->file);
408 bm->file = NULL;
409 }
410}
411
412/* Remove reference to bitmap with id number ID. */
413
414void
d3da34e0 415x_destroy_bitmap (FRAME_PTR f, int id)
4ef0d4d0
KS
416{
417 Display_Info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
418
419 if (id > 0)
420 {
421 Bitmap_Record *bm = &dpyinfo->bitmaps[id - 1];
422
423 if (--bm->refcount == 0)
424 {
425 BLOCK_INPUT;
65342ae3 426 free_bitmap_record (dpyinfo, bm);
4ef0d4d0
KS
427 UNBLOCK_INPUT;
428 }
429 }
430}
431
432/* Free all the bitmaps for the display specified by DPYINFO. */
433
434void
d3da34e0 435x_destroy_all_bitmaps (Display_Info *dpyinfo)
4ef0d4d0
KS
436{
437 int i;
438 Bitmap_Record *bm = dpyinfo->bitmaps;
439
440 for (i = 0; i < dpyinfo->bitmaps_last; i++, bm++)
441 if (bm->refcount > 0)
65342ae3 442 free_bitmap_record (dpyinfo, bm);
4ef0d4d0
KS
443
444 dpyinfo->bitmaps_last = 0;
445}
446
447
448#ifdef HAVE_X_WINDOWS
449
450/* Useful functions defined in the section
451 `Image type independent image structures' below. */
452
f57e2426
J
453static unsigned long four_corners_best (XImagePtr ximg,
454 int *corners,
455 unsigned long width,
456 unsigned long height);
4ef0d4d0 457
f57e2426
J
458static int x_create_x_image_and_pixmap (struct frame *f, int width, int height,
459 int depth, XImagePtr *ximg,
460 Pixmap *pixmap);
4ef0d4d0 461
f57e2426 462static void x_destroy_x_image (XImagePtr ximg);
4ef0d4d0
KS
463
464
465/* Create a mask of a bitmap. Note is this not a perfect mask.
466 It's nicer with some borders in this context */
467
468int
d3da34e0 469x_create_bitmap_mask (struct frame *f, int id)
4ef0d4d0
KS
470{
471 Pixmap pixmap, mask;
472 XImagePtr ximg, mask_img;
473 unsigned long width, height;
474 int result;
475 unsigned long bg;
476 unsigned long x, y, xp, xm, yp, ym;
477 GC gc;
478
479 Display_Info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
480
481 if (!(id > 0))
482 return -1;
483
484 pixmap = x_bitmap_pixmap (f, id);
485 width = x_bitmap_width (f, id);
486 height = x_bitmap_height (f, id);
487
488 BLOCK_INPUT;
489 ximg = XGetImage (FRAME_X_DISPLAY (f), pixmap, 0, 0, width, height,
490 ~0, ZPixmap);
491
492 if (!ximg)
493 {
494 UNBLOCK_INPUT;
495 return -1;
496 }
497
498 result = x_create_x_image_and_pixmap (f, width, height, 1, &mask_img, &mask);
499
500 UNBLOCK_INPUT;
501 if (!result)
502 {
503 XDestroyImage (ximg);
504 return -1;
505 }
506
6ac3c7bb 507 bg = four_corners_best (ximg, NULL, width, height);
4ef0d4d0
KS
508
509 for (y = 0; y < ximg->height; ++y)
510 {
511 for (x = 0; x < ximg->width; ++x)
512 {
513 xp = x != ximg->width - 1 ? x + 1 : 0;
514 xm = x != 0 ? x - 1 : ximg->width - 1;
515 yp = y != ximg->height - 1 ? y + 1 : 0;
516 ym = y != 0 ? y - 1 : ximg->height - 1;
517 if (XGetPixel (ximg, x, y) == bg
518 && XGetPixel (ximg, x, yp) == bg
519 && XGetPixel (ximg, x, ym) == bg
520 && XGetPixel (ximg, xp, y) == bg
521 && XGetPixel (ximg, xp, yp) == bg
522 && XGetPixel (ximg, xp, ym) == bg
523 && XGetPixel (ximg, xm, y) == bg
524 && XGetPixel (ximg, xm, yp) == bg
525 && XGetPixel (ximg, xm, ym) == bg)
526 XPutPixel (mask_img, x, y, 0);
527 else
528 XPutPixel (mask_img, x, y, 1);
529 }
530 }
531
532 xassert (interrupt_input_blocked);
533 gc = XCreateGC (FRAME_X_DISPLAY (f), mask, 0, NULL);
534 XPutImage (FRAME_X_DISPLAY (f), mask, gc, mask_img, 0, 0, 0, 0,
535 width, height);
536 XFreeGC (FRAME_X_DISPLAY (f), gc);
537
538 dpyinfo->bitmaps[id - 1].have_mask = 1;
539 dpyinfo->bitmaps[id - 1].mask = mask;
540
541 XDestroyImage (ximg);
542 x_destroy_x_image (mask_img);
543
544 return 0;
545}
546
547#endif /* HAVE_X_WINDOWS */
548
549
550/***********************************************************************
551 Image types
552 ***********************************************************************/
553
4ef0d4d0
KS
554/* List of supported image types. Use define_image_type to add new
555 types. Use lookup_image_type to find a type for a given symbol. */
556
557static struct image_type *image_types;
558
0855eb52
JB
559/* Cache for delayed-loading image types. */
560
561static Lisp_Object Vimage_type_cache;
562
4ef0d4d0
KS
563/* The symbol `xbm' which is used as the type symbol for XBM images. */
564
955cbe7b 565static Lisp_Object Qxbm;
4ef0d4d0
KS
566
567/* Keywords. */
568
955cbe7b
PE
569Lisp_Object QCascent, QCmargin, QCrelief;
570static Lisp_Object Qcount, Qextension_data;
571Lisp_Object QCconversion;
572static Lisp_Object QCheuristic_mask;
573static Lisp_Object QCcolor_symbols;
574static Lisp_Object QCindex, QCmatrix, QCcolor_adjustment, QCmask, QCgeometry;
575static Lisp_Object QCcrop, QCrotation;
4ef0d4d0
KS
576
577/* Other symbols. */
578
955cbe7b 579static Lisp_Object Qlaplace, Qemboss, Qedge_detection, Qheuristic;
4ef0d4d0 580
4ef0d4d0
KS
581/* Function prototypes. */
582
f57e2426
J
583static Lisp_Object define_image_type (struct image_type *type, int loaded);
584static struct image_type *lookup_image_type (Lisp_Object symbol);
675e2c69 585static void image_error (const char *format, Lisp_Object, Lisp_Object);
f57e2426
J
586static void x_laplace (struct frame *, struct image *);
587static void x_emboss (struct frame *, struct image *);
588static int x_build_heuristic_mask (struct frame *, struct image *,
589 Lisp_Object);
4ef0d4d0 590
0855eb52
JB
591#define CACHE_IMAGE_TYPE(type, status) \
592 do { Vimage_type_cache = Fcons (Fcons (type, status), Vimage_type_cache); } while (0)
593
594#define ADD_IMAGE_TYPE(type) \
595 do { Vimage_types = Fcons (type, Vimage_types); } while (0)
4ef0d4d0
KS
596
597/* Define a new image type from TYPE. This adds a copy of TYPE to
0855eb52 598 image_types and caches the loading status of TYPE. */
4ef0d4d0 599
0855eb52 600static Lisp_Object
d3da34e0 601define_image_type (struct image_type *type, int loaded)
4ef0d4d0 602{
0855eb52
JB
603 Lisp_Object success;
604
605 if (!loaded)
606 success = Qnil;
607 else
608 {
609 /* Make a copy of TYPE to avoid a bus error in a dumped Emacs.
610 The initialized data segment is read-only. */
611 struct image_type *p = (struct image_type *) xmalloc (sizeof *p);
72af86bd 612 memcpy (p, type, sizeof *p);
0855eb52
JB
613 p->next = image_types;
614 image_types = p;
615 success = Qt;
616 }
617
adac86db 618 CACHE_IMAGE_TYPE (*type->type, success);
0855eb52 619 return success;
4ef0d4d0
KS
620}
621
622
623/* Look up image type SYMBOL, and return a pointer to its image_type
624 structure. Value is null if SYMBOL is not a known image type. */
625
626static INLINE struct image_type *
d3da34e0 627lookup_image_type (Lisp_Object symbol)
4ef0d4d0
KS
628{
629 struct image_type *type;
630
803aac3e 631 /* We must initialize the image-type if it hasn't been already. */
2e288d54 632 if (NILP (Finit_image_library (symbol, Vdynamic_library_alist)))
803aac3e
MB
633 return 0; /* unimplemented */
634
4ef0d4d0
KS
635 for (type = image_types; type; type = type->next)
636 if (EQ (symbol, *type->type))
637 break;
638
639 return type;
640}
641
642
643/* Value is non-zero if OBJECT is a valid Lisp image specification. A
644 valid image specification is a list whose car is the symbol
645 `image', and whose rest is a property list. The property list must
646 contain a value for key `:type'. That value must be the name of a
647 supported image type. The rest of the property list depends on the
648 image type. */
649
650int
d3da34e0 651valid_image_p (Lisp_Object object)
4ef0d4d0
KS
652{
653 int valid_p = 0;
654
655 if (IMAGEP (object))
656 {
657 Lisp_Object tem;
658
659 for (tem = XCDR (object); CONSP (tem); tem = XCDR (tem))
660 if (EQ (XCAR (tem), QCtype))
661 {
662 tem = XCDR (tem);
663 if (CONSP (tem) && SYMBOLP (XCAR (tem)))
664 {
665 struct image_type *type;
666 type = lookup_image_type (XCAR (tem));
667 if (type)
668 valid_p = type->valid_p (object);
669 }
670
671 break;
672 }
673 }
674
675 return valid_p;
676}
677
678
679/* Log error message with format string FORMAT and argument ARG.
680 Signaling an error, e.g. when an image cannot be loaded, is not a
681 good idea because this would interrupt redisplay, and the error
682 message display would lead to another redisplay. This function
683 therefore simply displays a message. */
684
685static void
675e2c69 686image_error (const char *format, Lisp_Object arg1, Lisp_Object arg2)
4ef0d4d0
KS
687{
688 add_to_log (format, arg1, arg2);
689}
690
691
692\f
693/***********************************************************************
694 Image specifications
695 ***********************************************************************/
696
697enum image_value_type
698{
699 IMAGE_DONT_CHECK_VALUE_TYPE,
700 IMAGE_STRING_VALUE,
701 IMAGE_STRING_OR_NIL_VALUE,
702 IMAGE_SYMBOL_VALUE,
703 IMAGE_POSITIVE_INTEGER_VALUE,
704 IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR,
705 IMAGE_NON_NEGATIVE_INTEGER_VALUE,
706 IMAGE_ASCENT_VALUE,
707 IMAGE_INTEGER_VALUE,
708 IMAGE_FUNCTION_VALUE,
709 IMAGE_NUMBER_VALUE,
710 IMAGE_BOOL_VALUE
711};
712
713/* Structure used when parsing image specifications. */
714
715struct image_keyword
716{
717 /* Name of keyword. */
675e2c69 718 const char *name;
4ef0d4d0
KS
719
720 /* The type of value allowed. */
721 enum image_value_type type;
722
723 /* Non-zero means key must be present. */
724 int mandatory_p;
725
726 /* Used to recognize duplicate keywords in a property list. */
727 int count;
728
729 /* The value that was found. */
730 Lisp_Object value;
731};
732
733
f57e2426
J
734static int parse_image_spec (Lisp_Object, struct image_keyword *,
735 int, Lisp_Object);
736static Lisp_Object image_spec_value (Lisp_Object, Lisp_Object, int *);
4ef0d4d0
KS
737
738
739/* Parse image spec SPEC according to KEYWORDS. A valid image spec
740 has the format (image KEYWORD VALUE ...). One of the keyword/
741 value pairs must be `:type TYPE'. KEYWORDS is a vector of
742 image_keywords structures of size NKEYWORDS describing other
743 allowed keyword/value pairs. Value is non-zero if SPEC is valid. */
744
745static int
d3da34e0
JB
746parse_image_spec (Lisp_Object spec, struct image_keyword *keywords,
747 int nkeywords, Lisp_Object type)
4ef0d4d0
KS
748{
749 int i;
750 Lisp_Object plist;
751
752 if (!IMAGEP (spec))
753 return 0;
754
755 plist = XCDR (spec);
756 while (CONSP (plist))
757 {
758 Lisp_Object key, value;
759
760 /* First element of a pair must be a symbol. */
761 key = XCAR (plist);
762 plist = XCDR (plist);
763 if (!SYMBOLP (key))
764 return 0;
765
766 /* There must follow a value. */
767 if (!CONSP (plist))
768 return 0;
769 value = XCAR (plist);
770 plist = XCDR (plist);
771
772 /* Find key in KEYWORDS. Error if not found. */
773 for (i = 0; i < nkeywords; ++i)
42a5b22f 774 if (strcmp (keywords[i].name, SSDATA (SYMBOL_NAME (key))) == 0)
4ef0d4d0
KS
775 break;
776
777 if (i == nkeywords)
778 continue;
779
780 /* Record that we recognized the keyword. If a keywords
781 was found more than once, it's an error. */
782 keywords[i].value = value;
783 ++keywords[i].count;
784
785 if (keywords[i].count > 1)
786 return 0;
787
788 /* Check type of value against allowed type. */
789 switch (keywords[i].type)
790 {
791 case IMAGE_STRING_VALUE:
792 if (!STRINGP (value))
793 return 0;
794 break;
795
796 case IMAGE_STRING_OR_NIL_VALUE:
797 if (!STRINGP (value) && !NILP (value))
798 return 0;
799 break;
800
801 case IMAGE_SYMBOL_VALUE:
802 if (!SYMBOLP (value))
803 return 0;
804 break;
805
806 case IMAGE_POSITIVE_INTEGER_VALUE:
807 if (!INTEGERP (value) || XINT (value) <= 0)
808 return 0;
809 break;
810
811 case IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR:
812 if (INTEGERP (value) && XINT (value) >= 0)
813 break;
814 if (CONSP (value)
815 && INTEGERP (XCAR (value)) && INTEGERP (XCDR (value))
816 && XINT (XCAR (value)) >= 0 && XINT (XCDR (value)) >= 0)
817 break;
818 return 0;
819
820 case IMAGE_ASCENT_VALUE:
821 if (SYMBOLP (value) && EQ (value, Qcenter))
822 break;
823 else if (INTEGERP (value)
824 && XINT (value) >= 0
825 && XINT (value) <= 100)
826 break;
827 return 0;
828
829 case IMAGE_NON_NEGATIVE_INTEGER_VALUE:
830 if (!INTEGERP (value) || XINT (value) < 0)
831 return 0;
832 break;
833
834 case IMAGE_DONT_CHECK_VALUE_TYPE:
835 break;
836
837 case IMAGE_FUNCTION_VALUE:
838 value = indirect_function (value);
ca105506 839 if (!NILP (Ffunctionp (value)))
4ef0d4d0
KS
840 break;
841 return 0;
842
843 case IMAGE_NUMBER_VALUE:
844 if (!INTEGERP (value) && !FLOATP (value))
845 return 0;
846 break;
847
848 case IMAGE_INTEGER_VALUE:
849 if (!INTEGERP (value))
850 return 0;
851 break;
852
853 case IMAGE_BOOL_VALUE:
854 if (!NILP (value) && !EQ (value, Qt))
855 return 0;
856 break;
857
858 default:
859 abort ();
860 break;
861 }
862
863 if (EQ (key, QCtype) && !EQ (type, value))
864 return 0;
865 }
866
867 /* Check that all mandatory fields are present. */
868 for (i = 0; i < nkeywords; ++i)
869 if (keywords[i].mandatory_p && keywords[i].count == 0)
870 return 0;
871
872 return NILP (plist);
873}
874
875
876/* Return the value of KEY in image specification SPEC. Value is nil
877 if KEY is not present in SPEC. if FOUND is not null, set *FOUND
878 to 1 if KEY was found in SPEC, set it to 0 otherwise. */
879
880static Lisp_Object
d3da34e0 881image_spec_value (Lisp_Object spec, Lisp_Object key, int *found)
4ef0d4d0
KS
882{
883 Lisp_Object tail;
884
885 xassert (valid_image_p (spec));
886
887 for (tail = XCDR (spec);
888 CONSP (tail) && CONSP (XCDR (tail));
889 tail = XCDR (XCDR (tail)))
890 {
891 if (EQ (XCAR (tail), key))
892 {
893 if (found)
894 *found = 1;
895 return XCAR (XCDR (tail));
896 }
897 }
898
899 if (found)
900 *found = 0;
901 return Qnil;
902}
903
904
905DEFUN ("image-size", Fimage_size, Simage_size, 1, 3, 0,
906 doc: /* Return the size of image SPEC as pair (WIDTH . HEIGHT).
907PIXELS non-nil means return the size in pixels, otherwise return the
908size in canonical character units.
909FRAME is the frame on which the image will be displayed. FRAME nil
910or omitted means use the selected frame. */)
5842a27b 911 (Lisp_Object spec, Lisp_Object pixels, Lisp_Object frame)
4ef0d4d0
KS
912{
913 Lisp_Object size;
914
915 size = Qnil;
916 if (valid_image_p (spec))
917 {
918 struct frame *f = check_x_frame (frame);
919 int id = lookup_image (f, spec);
920 struct image *img = IMAGE_FROM_ID (f, id);
921 int width = img->width + 2 * img->hmargin;
922 int height = img->height + 2 * img->vmargin;
923
924 if (NILP (pixels))
925 size = Fcons (make_float ((double) width / FRAME_COLUMN_WIDTH (f)),
926 make_float ((double) height / FRAME_LINE_HEIGHT (f)));
927 else
928 size = Fcons (make_number (width), make_number (height));
929 }
930 else
931 error ("Invalid image specification");
932
933 return size;
934}
935
936
937DEFUN ("image-mask-p", Fimage_mask_p, Simage_mask_p, 1, 2, 0,
938 doc: /* Return t if image SPEC has a mask bitmap.
939FRAME is the frame on which the image will be displayed. FRAME nil
940or omitted means use the selected frame. */)
5842a27b 941 (Lisp_Object spec, Lisp_Object frame)
4ef0d4d0
KS
942{
943 Lisp_Object mask;
944
945 mask = Qnil;
946 if (valid_image_p (spec))
947 {
948 struct frame *f = check_x_frame (frame);
949 int id = lookup_image (f, spec);
950 struct image *img = IMAGE_FROM_ID (f, id);
951 if (img->mask)
952 mask = Qt;
953 }
954 else
955 error ("Invalid image specification");
956
957 return mask;
958}
959
1546c559
JL
960DEFUN ("image-metadata", Fimage_metadata, Simage_metadata, 1, 2, 0,
961 doc: /* Return metadata for image SPEC.
6ac3c7bb
KS
962FRAME is the frame on which the image will be displayed. FRAME nil
963or omitted means use the selected frame. */)
5842a27b 964 (Lisp_Object spec, Lisp_Object frame)
6ac3c7bb
KS
965{
966 Lisp_Object ext;
967
968 ext = Qnil;
969 if (valid_image_p (spec))
970 {
971 struct frame *f = check_x_frame (frame);
972 int id = lookup_image (f, spec);
973 struct image *img = IMAGE_FROM_ID (f, id);
974 ext = img->data.lisp_val;
975 }
976
977 return ext;
978}
979
4ef0d4d0
KS
980\f
981/***********************************************************************
982 Image type independent image structures
983 ***********************************************************************/
984
f57e2426
J
985static struct image *make_image (Lisp_Object spec, unsigned hash);
986static void free_image (struct frame *f, struct image *img);
987static int check_image_size (struct frame *f, int width, int height);
4ef0d4d0 988
f1f25b99 989#define MAX_IMAGE_SIZE 6.0
4ef0d4d0
KS
990/* Allocate and return a new image structure for image specification
991 SPEC. SPEC has a hash value of HASH. */
992
993static struct image *
d3da34e0 994make_image (Lisp_Object spec, unsigned int hash)
4ef0d4d0
KS
995{
996 struct image *img = (struct image *) xmalloc (sizeof *img);
a2bc5bdd 997 Lisp_Object file = image_spec_value (spec, QCfile, NULL);
4ef0d4d0
KS
998
999 xassert (valid_image_p (spec));
72af86bd 1000 memset (img, 0, sizeof *img);
a2bc5bdd 1001 img->dependencies = NILP (file) ? Qnil : list1 (file);
4ef0d4d0
KS
1002 img->type = lookup_image_type (image_spec_value (spec, QCtype, NULL));
1003 xassert (img->type != NULL);
1004 img->spec = spec;
1005 img->data.lisp_val = Qnil;
1006 img->ascent = DEFAULT_IMAGE_ASCENT;
1007 img->hash = hash;
6ac3c7bb 1008 img->corners[BOT_CORNER] = -1; /* Full image */
4ef0d4d0
KS
1009 return img;
1010}
1011
1012
1013/* Free image IMG which was used on frame F, including its resources. */
1014
1015static void
d3da34e0 1016free_image (struct frame *f, struct image *img)
4ef0d4d0
KS
1017{
1018 if (img)
1019 {
354884c4 1020 struct image_cache *c = FRAME_IMAGE_CACHE (f);
4ef0d4d0
KS
1021
1022 /* Remove IMG from the hash table of its cache. */
1023 if (img->prev)
1024 img->prev->next = img->next;
1025 else
1026 c->buckets[img->hash % IMAGE_CACHE_BUCKETS_SIZE] = img->next;
1027
1028 if (img->next)
1029 img->next->prev = img->prev;
1030
1031 c->images[img->id] = NULL;
1032
1033 /* Free resources, then free IMG. */
1034 img->type->free (f, img);
1035 xfree (img);
1036 }
1037}
1038
f1f25b99
CY
1039/* Return 1 if the given widths and heights are valid for display;
1040 otherwise, return 0. */
1041
1042int
d3da34e0 1043check_image_size (struct frame *f, int width, int height)
f1f25b99 1044{
7df4765a 1045 int w, h;
f1f25b99 1046
7df4765a 1047 if (width <= 0 || height <= 0)
f1f25b99
CY
1048 return 0;
1049
7df4765a
KS
1050 if (INTEGERP (Vmax_image_size))
1051 w = h = XINT (Vmax_image_size);
1052 else if (FLOATP (Vmax_image_size))
1053 {
1054 if (f != NULL)
1055 {
1056 w = FRAME_PIXEL_WIDTH (f);
1057 h = FRAME_PIXEL_HEIGHT (f);
1058 }
1059 else
1060 w = h = 1024; /* Arbitrary size for unknown frame. */
1061 w = (int) (XFLOAT_DATA (Vmax_image_size) * w);
1062 h = (int) (XFLOAT_DATA (Vmax_image_size) * h);
1063 }
1064 else
1065 return 1;
1066
1067 return (width <= w && height <= h);
f1f25b99 1068}
4ef0d4d0
KS
1069
1070/* Prepare image IMG for display on frame F. Must be called before
1071 drawing an image. */
1072
1073void
d3da34e0 1074prepare_image_for_display (struct frame *f, struct image *img)
4ef0d4d0
KS
1075{
1076 EMACS_TIME t;
1077
1078 /* We're about to display IMG, so set its timestamp to `now'. */
1079 EMACS_GET_TIME (t);
1080 img->timestamp = EMACS_SECS (t);
1081
1082 /* If IMG doesn't have a pixmap yet, load it now, using the image
1083 type dependent loader function. */
1084 if (img->pixmap == NO_PIXMAP && !img->load_failed_p)
1085 img->load_failed_p = img->type->load (f, img) == 0;
c7fea325 1086
4ef0d4d0
KS
1087}
1088
1089
1090/* Value is the number of pixels for the ascent of image IMG when
1091 drawn in face FACE. */
1092
1093int
d3da34e0 1094image_ascent (struct image *img, struct face *face, struct glyph_slice *slice)
4ef0d4d0 1095{
1938bc36 1096 int height;
4ef0d4d0
KS
1097 int ascent;
1098
1938bc36
KS
1099 if (slice->height == img->height)
1100 height = img->height + img->vmargin;
1101 else if (slice->y == 0)
1102 height = slice->height + img->vmargin;
1103 else
1104 height = slice->height;
1105
4ef0d4d0
KS
1106 if (img->ascent == CENTERED_IMAGE_ASCENT)
1107 {
1108 if (face->font)
1109 {
1110#ifdef HAVE_NTGUI
1111 /* W32 specific version. Why?. ++kfs */
5fc9fdeb
JR
1112 ascent = height / 2 - (FONT_DESCENT (face->font)
1113 - FONT_BASE (face->font)) / 2;
4ef0d4d0
KS
1114#else
1115 /* This expression is arranged so that if the image can't be
1116 exactly centered, it will be moved slightly up. This is
1117 because a typical font is `top-heavy' (due to the presence
1118 uppercase letters), so the image placement should err towards
1119 being top-heavy too. It also just generally looks better. */
edfda783
AR
1120 ascent = (height + FONT_BASE(face->font)
1121 - FONT_DESCENT(face->font) + 1) / 2;
4ef0d4d0
KS
1122#endif /* HAVE_NTGUI */
1123 }
1124 else
1125 ascent = height / 2;
1126 }
1127 else
1128 ascent = (int) (height * img->ascent / 100.0);
1129
1130 return ascent;
1131}
1132
1133\f
1134/* Image background colors. */
1135
1136/* Find the "best" corner color of a bitmap.
1137 On W32, XIMG is assumed to a device context with the bitmap selected. */
1138
1139static RGB_PIXEL_COLOR
d3da34e0
JB
1140four_corners_best (XImagePtr_or_DC ximg, int *corners,
1141 unsigned long width, unsigned long height)
4ef0d4d0 1142{
f0c77cd1 1143 RGB_PIXEL_COLOR corner_pixels[4], best IF_LINT (= 0);
4ef0d4d0
KS
1144 int i, best_count;
1145
6ac3c7bb
KS
1146 if (corners && corners[BOT_CORNER] >= 0)
1147 {
1148 /* Get the colors at the corner_pixels of ximg. */
1149 corner_pixels[0] = GET_PIXEL (ximg, corners[LEFT_CORNER], corners[TOP_CORNER]);
1150 corner_pixels[1] = GET_PIXEL (ximg, corners[RIGHT_CORNER] - 1, corners[TOP_CORNER]);
1151 corner_pixels[2] = GET_PIXEL (ximg, corners[RIGHT_CORNER] - 1, corners[BOT_CORNER] - 1);
1152 corner_pixels[3] = GET_PIXEL (ximg, corners[LEFT_CORNER], corners[BOT_CORNER] - 1);
1153 }
1154 else
1155 {
1156 /* Get the colors at the corner_pixels of ximg. */
1157 corner_pixels[0] = GET_PIXEL (ximg, 0, 0);
1158 corner_pixels[1] = GET_PIXEL (ximg, width - 1, 0);
1159 corner_pixels[2] = GET_PIXEL (ximg, width - 1, height - 1);
1160 corner_pixels[3] = GET_PIXEL (ximg, 0, height - 1);
1161 }
4ef0d4d0
KS
1162 /* Choose the most frequently found color as background. */
1163 for (i = best_count = 0; i < 4; ++i)
1164 {
1165 int j, n;
1166
1167 for (j = n = 0; j < 4; ++j)
6ac3c7bb 1168 if (corner_pixels[i] == corner_pixels[j])
4ef0d4d0
KS
1169 ++n;
1170
1171 if (n > best_count)
6ac3c7bb 1172 best = corner_pixels[i], best_count = n;
4ef0d4d0
KS
1173 }
1174
1175 return best;
1176}
1177
1178/* Portability macros */
1179
1180#ifdef HAVE_NTGUI
1181
1182#define Destroy_Image(img_dc, prev) \
1183 do { SelectObject (img_dc, prev); DeleteDC (img_dc); } while (0)
1184
1185#define Free_Pixmap(display, pixmap) \
1186 DeleteObject (pixmap)
1187
edfda783
AR
1188#elif defined (HAVE_NS)
1189
1190#define Destroy_Image(ximg, dummy) \
ed3751c8 1191 ns_release_object (ximg)
edfda783
AR
1192
1193#define Free_Pixmap(display, pixmap) \
ed3751c8 1194 ns_release_object (pixmap)
edfda783 1195
4ef0d4d0
KS
1196#else
1197
1198#define Destroy_Image(ximg, dummy) \
1199 XDestroyImage (ximg)
1200
1201#define Free_Pixmap(display, pixmap) \
1202 XFreePixmap (display, pixmap)
1203
edfda783 1204#endif /* !HAVE_NTGUI && !HAVE_NS */
4ef0d4d0
KS
1205
1206
1207/* Return the `background' field of IMG. If IMG doesn't have one yet,
1208 it is guessed heuristically. If non-zero, XIMG is an existing
1209 XImage object (or device context with the image selected on W32) to
1f026899 1210 use for the heuristic. */
4ef0d4d0
KS
1211
1212RGB_PIXEL_COLOR
d3da34e0 1213image_background (struct image *img, struct frame *f, XImagePtr_or_DC ximg)
4ef0d4d0
KS
1214{
1215 if (! img->background_valid)
1216 /* IMG doesn't have a background yet, try to guess a reasonable value. */
1217 {
1218 int free_ximg = !ximg;
1219#ifdef HAVE_NTGUI
1220 HGDIOBJ prev;
1221#endif /* HAVE_NTGUI */
1222
1223 if (free_ximg)
1224 {
1225#ifndef HAVE_NTGUI
1226 ximg = XGetImage (FRAME_X_DISPLAY (f), img->pixmap,
1227 0, 0, img->width, img->height, ~0, ZPixmap);
1228#else
1229 HDC frame_dc = get_frame_dc (f);
1230 ximg = CreateCompatibleDC (frame_dc);
1231 release_frame_dc (f, frame_dc);
1232 prev = SelectObject (ximg, img->pixmap);
1233#endif /* !HAVE_NTGUI */
1234 }
1235
6ac3c7bb 1236 img->background = four_corners_best (ximg, img->corners, img->width, img->height);
4ef0d4d0
KS
1237
1238 if (free_ximg)
1239 Destroy_Image (ximg, prev);
1f026899 1240
4ef0d4d0
KS
1241 img->background_valid = 1;
1242 }
1243
1244 return img->background;
1245}
1246
1247/* Return the `background_transparent' field of IMG. If IMG doesn't
1248 have one yet, it is guessed heuristically. If non-zero, MASK is an
1249 existing XImage object to use for the heuristic. */
1250
1251int
d3da34e0 1252image_background_transparent (struct image *img, struct frame *f, XImagePtr_or_DC mask)
4ef0d4d0
KS
1253{
1254 if (! img->background_transparent_valid)
1255 /* IMG doesn't have a background yet, try to guess a reasonable value. */
1256 {
1257 if (img->mask)
1258 {
1259 int free_mask = !mask;
1260#ifdef HAVE_NTGUI
1261 HGDIOBJ prev;
1262#endif /* HAVE_NTGUI */
1263
1264 if (free_mask)
1265 {
1266#ifndef HAVE_NTGUI
1267 mask = XGetImage (FRAME_X_DISPLAY (f), img->mask,
1268 0, 0, img->width, img->height, ~0, ZPixmap);
1269#else
1270 HDC frame_dc = get_frame_dc (f);
1271 mask = CreateCompatibleDC (frame_dc);
1272 release_frame_dc (f, frame_dc);
1273 prev = SelectObject (mask, img->mask);
1274#endif /* HAVE_NTGUI */
1275 }
1276
1277 img->background_transparent
6ac3c7bb 1278 = (four_corners_best (mask, img->corners, img->width, img->height) == PIX_MASK_RETAIN);
4ef0d4d0
KS
1279
1280 if (free_mask)
1281 Destroy_Image (mask, prev);
1282 }
1283 else
1284 img->background_transparent = 0;
1285
1286 img->background_transparent_valid = 1;
1287 }
1288
1289 return img->background_transparent;
1290}
1291
1292\f
1293/***********************************************************************
1294 Helper functions for X image types
1295 ***********************************************************************/
1296
f57e2426
J
1297static void x_clear_image_1 (struct frame *, struct image *, int,
1298 int, int);
1299static void x_clear_image (struct frame *f, struct image *img);
1300static unsigned long x_alloc_image_color (struct frame *f,
1301 struct image *img,
1302 Lisp_Object color_name,
1303 unsigned long dflt);
4ef0d4d0
KS
1304
1305
1306/* Clear X resources of image IMG on frame F. PIXMAP_P non-zero means
1307 free the pixmap if any. MASK_P non-zero means clear the mask
1308 pixmap if any. COLORS_P non-zero means free colors allocated for
1309 the image, if any. */
1310
1311static void
d3da34e0
JB
1312x_clear_image_1 (struct frame *f, struct image *img, int pixmap_p, int mask_p,
1313 int colors_p)
4ef0d4d0
KS
1314{
1315 if (pixmap_p && img->pixmap)
1316 {
1317 Free_Pixmap (FRAME_X_DISPLAY (f), img->pixmap);
1318 img->pixmap = NO_PIXMAP;
5a06864f 1319 /* NOTE (HAVE_NS): background color is NOT an indexed color! */
4ef0d4d0
KS
1320 img->background_valid = 0;
1321 }
1322
1323 if (mask_p && img->mask)
1324 {
1325 Free_Pixmap (FRAME_X_DISPLAY (f), img->mask);
1326 img->mask = NO_PIXMAP;
1327 img->background_transparent_valid = 0;
1328 }
1329
1330 if (colors_p && img->ncolors)
1331 {
4ef0d4d0
KS
1332 /* W32_TODO: color table support. */
1333#ifdef HAVE_X_WINDOWS
1334 x_free_colors (f, img->colors, img->ncolors);
1335#endif /* HAVE_X_WINDOWS */
1336 xfree (img->colors);
1337 img->colors = NULL;
1338 img->ncolors = 0;
1339 }
c7fea325 1340
4ef0d4d0
KS
1341}
1342
1343/* Free X resources of image IMG which is used on frame F. */
1344
1345static void
d3da34e0 1346x_clear_image (struct frame *f, struct image *img)
4ef0d4d0
KS
1347{
1348 BLOCK_INPUT;
1349 x_clear_image_1 (f, img, 1, 1, 1);
1350 UNBLOCK_INPUT;
1351}
1352
1353
1354/* Allocate color COLOR_NAME for image IMG on frame F. If color
1355 cannot be allocated, use DFLT. Add a newly allocated color to
1356 IMG->colors, so that it can be freed again. Value is the pixel
1357 color. */
1358
1359static unsigned long
d3da34e0
JB
1360x_alloc_image_color (struct frame *f, struct image *img, Lisp_Object color_name,
1361 unsigned long dflt)
4ef0d4d0
KS
1362{
1363 XColor color;
1364 unsigned long result;
1365
1366 xassert (STRINGP (color_name));
1367
42a5b22f 1368 if (x_defined_color (f, SSDATA (color_name), &color, 1))
4ef0d4d0
KS
1369 {
1370 /* This isn't called frequently so we get away with simply
1371 reallocating the color vector to the needed size, here. */
1372 ++img->ncolors;
1373 img->colors =
1374 (unsigned long *) xrealloc (img->colors,
1375 img->ncolors * sizeof *img->colors);
1376 img->colors[img->ncolors - 1] = color.pixel;
1377 result = color.pixel;
1378 }
1379 else
1380 result = dflt;
1381
1382 return result;
1383}
1384
1385
1386\f
1387/***********************************************************************
1388 Image Cache
1389 ***********************************************************************/
1390
f57e2426
J
1391static struct image *search_image_cache (struct frame *, Lisp_Object, unsigned);
1392static void cache_image (struct frame *f, struct image *img);
1393static void postprocess_image (struct frame *, struct image *);
4ef0d4d0
KS
1394
1395/* Return a new, initialized image cache that is allocated from the
1396 heap. Call free_image_cache to free an image cache. */
1397
1398struct image_cache *
d3da34e0 1399make_image_cache (void)
4ef0d4d0
KS
1400{
1401 struct image_cache *c = (struct image_cache *) xmalloc (sizeof *c);
1402 int size;
1403
72af86bd 1404 memset (c, 0, sizeof *c);
4ef0d4d0
KS
1405 c->size = 50;
1406 c->images = (struct image **) xmalloc (c->size * sizeof *c->images);
1407 size = IMAGE_CACHE_BUCKETS_SIZE * sizeof *c->buckets;
1408 c->buckets = (struct image **) xmalloc (size);
72af86bd 1409 memset (c->buckets, 0, size);
4ef0d4d0
KS
1410 return c;
1411}
1412
1413
d3c35d17
CY
1414/* Find an image matching SPEC in the cache, and return it. If no
1415 image is found, return NULL. */
1416static struct image *
d3da34e0 1417search_image_cache (struct frame *f, Lisp_Object spec, unsigned int hash)
483e7ae0 1418{
91be6b66 1419 struct image *img;
354884c4 1420 struct image_cache *c = FRAME_IMAGE_CACHE (f);
483e7ae0
CY
1421 int i = hash % IMAGE_CACHE_BUCKETS_SIZE;
1422
8198352b
CY
1423 if (!c) return NULL;
1424
d3c35d17
CY
1425 /* If the image spec does not specify a background color, the cached
1426 image must have the same background color as the current frame.
cf26ebe8
CY
1427 The foreground color must also match, for the sake of monochrome
1428 images.
1429
1430 In fact, we could ignore the foreground color matching condition
1431 for color images, or if the image spec specifies :foreground;
1432 similarly we could ignore the background color matching condition
1433 for formats that don't use transparency (such as jpeg), or if the
1434 image spec specifies :background. However, the extra memory
1435 usage is probably negligible in practice, so we don't bother. */
d3c35d17 1436
483e7ae0 1437 for (img = c->buckets[i]; img; img = img->next)
d3c35d17
CY
1438 if (img->hash == hash
1439 && !NILP (Fequal (img->spec, spec))
c5b8e0ea
YM
1440 && img->frame_foreground == FRAME_FOREGROUND_PIXEL (f)
1441 && img->frame_background == FRAME_BACKGROUND_PIXEL (f))
d3c35d17
CY
1442 break;
1443 return img;
1444}
1445
1446
1447/* Search frame F for an image with spec SPEC, and free it. */
1448
1449static void
d3da34e0 1450uncache_image (struct frame *f, Lisp_Object spec)
d3c35d17
CY
1451{
1452 struct image *img = search_image_cache (f, spec, sxhash (spec, 0));
1453 if (img)
be3faa80
CY
1454 {
1455 free_image (f, img);
1456 /* As display glyphs may still be referring to the image ID, we
1457 must garbage the frame (Bug#6426). */
1458 SET_FRAME_GARBAGED (f);
1459 }
483e7ae0
CY
1460}
1461
1462
4ef0d4d0
KS
1463/* Free image cache of frame F. Be aware that X frames share images
1464 caches. */
1465
1466void
d3da34e0 1467free_image_cache (struct frame *f)
4ef0d4d0 1468{
354884c4 1469 struct image_cache *c = FRAME_IMAGE_CACHE (f);
4ef0d4d0
KS
1470 if (c)
1471 {
1472 int i;
1473
1474 /* Cache should not be referenced by any frame when freed. */
1475 xassert (c->refcount == 0);
1476
1477 for (i = 0; i < c->used; ++i)
1478 free_image (f, c->images[i]);
1479 xfree (c->images);
1480 xfree (c->buckets);
1481 xfree (c);
354884c4 1482 FRAME_IMAGE_CACHE (f) = NULL;
4ef0d4d0
KS
1483 }
1484}
1485
1486
a2bc5bdd
SM
1487/* Clear image cache of frame F. FILTER=t means free all images.
1488 FILTER=nil means clear only images that haven't been
1489 displayed for some time.
1490 Else, only free the images which have FILTER in their `dependencies'.
1491 Should be called from time to time to reduce the number of loaded images.
1492 If image-cache-eviction-delay is non-nil, this frees images in the cache
1493 which weren't displayed for at least that many seconds. */
4ef0d4d0 1494
ce0ad53d 1495static void
a2bc5bdd 1496clear_image_cache (struct frame *f, Lisp_Object filter)
4ef0d4d0 1497{
354884c4 1498 struct image_cache *c = FRAME_IMAGE_CACHE (f);
4ef0d4d0 1499
98fe5161 1500 if (c)
4ef0d4d0 1501 {
98fe5161 1502 int i, nfreed = 0;
4ef0d4d0
KS
1503
1504 /* Block input so that we won't be interrupted by a SIGIO
1505 while being in an inconsistent state. */
1506 BLOCK_INPUT;
1507
98fe5161
CY
1508 if (!NILP (filter))
1509 {
1510 /* Filter image cache. */
1511 for (i = 0; i < c->used; ++i)
1512 {
1513 struct image *img = c->images[i];
1514 if (img && (EQ (Qt, filter)
1515 || !NILP (Fmember (filter, img->dependencies))))
1516 {
1517 free_image (f, img);
1518 ++nfreed;
1519 }
1520 }
1521 }
1522 else if (INTEGERP (Vimage_cache_eviction_delay))
4ef0d4d0 1523 {
98fe5161
CY
1524 /* Free cache based on timestamp. */
1525 EMACS_TIME t;
1526 unsigned long old;
1527 int delay, nimages = 0;
1528
1529 for (i = 0; i < c->used; ++i)
1530 if (c->images[i])
1531 nimages++;
1532
1533 /* If the number of cached images has grown unusually large,
1534 decrease the cache eviction delay (Bug#6230). */
1535 delay = XFASTINT (Vimage_cache_eviction_delay);
1536 if (nimages > 40)
1537 delay = max (1, 1600 * delay / (nimages*nimages));
1538
1539 EMACS_GET_TIME (t);
1540 old = EMACS_SECS (t) - delay;
1541
1542 for (i = 0; i < c->used; ++i)
4ef0d4d0 1543 {
98fe5161
CY
1544 struct image *img = c->images[i];
1545 if (img && img->timestamp < old)
1546 {
1547 free_image (f, img);
1548 ++nfreed;
1549 }
4ef0d4d0
KS
1550 }
1551 }
1552
1553 /* We may be clearing the image cache because, for example,
1554 Emacs was iconified for a longer period of time. In that
1555 case, current matrices may still contain references to
1556 images freed above. So, clear these matrices. */
1557 if (nfreed)
1558 {
1559 Lisp_Object tail, frame;
1560
1561 FOR_EACH_FRAME (tail, frame)
1562 {
6ae141d6
PE
1563 struct frame *fr = XFRAME (frame);
1564 if (FRAME_IMAGE_CACHE (fr) == c)
1565 clear_current_matrices (fr);
4ef0d4d0
KS
1566 }
1567
1568 ++windows_or_buffers_changed;
1569 }
1570
1571 UNBLOCK_INPUT;
1572 }
1573}
1574
354884c4 1575void
a2bc5bdd 1576clear_image_caches (Lisp_Object filter)
354884c4
SM
1577{
1578 /* FIXME: We want to do
1579 * struct terminal *t;
1580 * for (t = terminal_list; t; t = t->next_terminal)
1581 * clear_image_cache (t, filter); */
1582 Lisp_Object tail, frame;
1583 FOR_EACH_FRAME (tail, frame)
1584 if (FRAME_WINDOW_P (XFRAME (frame)))
a2bc5bdd 1585 clear_image_cache (XFRAME (frame), filter);
354884c4 1586}
4ef0d4d0
KS
1587
1588DEFUN ("clear-image-cache", Fclear_image_cache, Sclear_image_cache,
1589 0, 1, 0,
a2bc5bdd
SM
1590 doc: /* Clear the image cache.
1591FILTER nil or a frame means clear all images in the selected frame.
1592FILTER t means clear the image caches of all frames.
1593Anything else, means only clear those images which refer to FILTER,
1594which is then usually a filename. */)
5842a27b 1595 (Lisp_Object filter)
4ef0d4d0 1596{
a2bc5bdd
SM
1597 if (!(EQ (filter, Qnil) || FRAMEP (filter)))
1598 clear_image_caches (filter);
4ef0d4d0 1599 else
a2bc5bdd 1600 clear_image_cache (check_x_frame (filter), Qt);
4ef0d4d0
KS
1601
1602 return Qnil;
1603}
1604
1605
110683ad 1606DEFUN ("image-flush", Fimage_flush, Simage_flush,
483e7ae0 1607 1, 2, 0,
110683ad
CY
1608 doc: /* Fush the image with specification SPEC on frame FRAME.
1609This removes the image from the Emacs image cache. If SPEC specifies
1610an image file, the next redisplay of this image will read from the
1611current contents of that file.
1612
483e7ae0
CY
1613FRAME nil or omitted means use the selected frame.
1614FRAME t means refresh the image on all frames. */)
5842a27b 1615 (Lisp_Object spec, Lisp_Object frame)
483e7ae0
CY
1616{
1617 if (!valid_image_p (spec))
1618 error ("Invalid image specification");
1619
1620 if (EQ (frame, Qt))
1621 {
1622 Lisp_Object tail;
1623 FOR_EACH_FRAME (tail, frame)
1624 {
1625 struct frame *f = XFRAME (frame);
1626 if (FRAME_WINDOW_P (f))
1627 uncache_image (f, spec);
1628 }
1629 }
1630 else
1631 uncache_image (check_x_frame (frame), spec);
1632
1633 return Qnil;
1634}
1635
1636
4ef0d4d0
KS
1637/* Compute masks and transform image IMG on frame F, as specified
1638 by the image's specification, */
1639
1640static void
d3da34e0 1641postprocess_image (struct frame *f, struct image *img)
4ef0d4d0
KS
1642{
1643 /* Manipulation of the image's mask. */
1644 if (img->pixmap)
1645 {
1646 Lisp_Object conversion, spec;
1647 Lisp_Object mask;
1648
1649 spec = img->spec;
1650
1651 /* `:heuristic-mask t'
1652 `:mask heuristic'
1653 means build a mask heuristically.
1654 `:heuristic-mask (R G B)'
1655 `:mask (heuristic (R G B))'
1656 means build a mask from color (R G B) in the
1657 image.
1658 `:mask nil'
1659 means remove a mask, if any. */
1660
1661 mask = image_spec_value (spec, QCheuristic_mask, NULL);
1662 if (!NILP (mask))
1663 x_build_heuristic_mask (f, img, mask);
1664 else
1665 {
1666 int found_p;
1667
1668 mask = image_spec_value (spec, QCmask, &found_p);
1669
1670 if (EQ (mask, Qheuristic))
1671 x_build_heuristic_mask (f, img, Qt);
1672 else if (CONSP (mask)
1673 && EQ (XCAR (mask), Qheuristic))
1674 {
1675 if (CONSP (XCDR (mask)))
1676 x_build_heuristic_mask (f, img, XCAR (XCDR (mask)));
1677 else
1678 x_build_heuristic_mask (f, img, XCDR (mask));
1679 }
1680 else if (NILP (mask) && found_p && img->mask)
1681 {
1682 Free_Pixmap (FRAME_X_DISPLAY (f), img->mask);
1683 img->mask = NO_PIXMAP;
1684 }
1685 }
1686
1687
1688 /* Should we apply an image transformation algorithm? */
1689 conversion = image_spec_value (spec, QCconversion, NULL);
1690 if (EQ (conversion, Qdisabled))
1691 x_disable_image (f, img);
1692 else if (EQ (conversion, Qlaplace))
1693 x_laplace (f, img);
1694 else if (EQ (conversion, Qemboss))
1695 x_emboss (f, img);
1696 else if (CONSP (conversion)
1697 && EQ (XCAR (conversion), Qedge_detection))
1698 {
1699 Lisp_Object tem;
1700 tem = XCDR (conversion);
1701 if (CONSP (tem))
1702 x_edge_detection (f, img,
1703 Fplist_get (tem, QCmatrix),
1704 Fplist_get (tem, QCcolor_adjustment));
1705 }
1706 }
1707}
1708
1709
1710/* Return the id of image with Lisp specification SPEC on frame F.
1711 SPEC must be a valid Lisp image specification (see valid_image_p). */
1712
1713int
d3da34e0 1714lookup_image (struct frame *f, Lisp_Object spec)
4ef0d4d0 1715{
4ef0d4d0 1716 struct image *img;
4ef0d4d0 1717 unsigned hash;
4ef0d4d0
KS
1718 EMACS_TIME now;
1719
1720 /* F must be a window-system frame, and SPEC must be a valid image
1721 specification. */
1722 xassert (FRAME_WINDOW_P (f));
1723 xassert (valid_image_p (spec));
1724
4ef0d4d0
KS
1725 /* Look up SPEC in the hash table of the image cache. */
1726 hash = sxhash (spec, 0);
d3c35d17 1727 img = search_image_cache (f, spec, hash);
f1f25b99
CY
1728 if (img && img->load_failed_p)
1729 {
1730 free_image (f, img);
1731 img = NULL;
1732 }
1733
4ef0d4d0
KS
1734 /* If not found, create a new image and cache it. */
1735 if (img == NULL)
1736 {
4ef0d4d0
KS
1737 BLOCK_INPUT;
1738 img = make_image (spec, hash);
1739 cache_image (f, img);
1740 img->load_failed_p = img->type->load (f, img) == 0;
c5b8e0ea
YM
1741 img->frame_foreground = FRAME_FOREGROUND_PIXEL (f);
1742 img->frame_background = FRAME_BACKGROUND_PIXEL (f);
4ef0d4d0
KS
1743
1744 /* If we can't load the image, and we don't have a width and
1745 height, use some arbitrary width and height so that we can
1746 draw a rectangle for it. */
1747 if (img->load_failed_p)
1748 {
1749 Lisp_Object value;
1750
1751 value = image_spec_value (spec, QCwidth, NULL);
1752 img->width = (INTEGERP (value)
1753 ? XFASTINT (value) : DEFAULT_IMAGE_WIDTH);
1754 value = image_spec_value (spec, QCheight, NULL);
1755 img->height = (INTEGERP (value)
1756 ? XFASTINT (value) : DEFAULT_IMAGE_HEIGHT);
1757 }
1758 else
1759 {
1760 /* Handle image type independent image attributes
1761 `:ascent ASCENT', `:margin MARGIN', `:relief RELIEF',
1762 `:background COLOR'. */
1763 Lisp_Object ascent, margin, relief, bg;
1764
1765 ascent = image_spec_value (spec, QCascent, NULL);
1766 if (INTEGERP (ascent))
1767 img->ascent = XFASTINT (ascent);
1768 else if (EQ (ascent, Qcenter))
1769 img->ascent = CENTERED_IMAGE_ASCENT;
1770
1771 margin = image_spec_value (spec, QCmargin, NULL);
1772 if (INTEGERP (margin) && XINT (margin) >= 0)
1773 img->vmargin = img->hmargin = XFASTINT (margin);
1774 else if (CONSP (margin) && INTEGERP (XCAR (margin))
1775 && INTEGERP (XCDR (margin)))
1776 {
1777 if (XINT (XCAR (margin)) > 0)
1778 img->hmargin = XFASTINT (XCAR (margin));
1779 if (XINT (XCDR (margin)) > 0)
1780 img->vmargin = XFASTINT (XCDR (margin));
1781 }
1782
1783 relief = image_spec_value (spec, QCrelief, NULL);
1784 if (INTEGERP (relief))
1785 {
1786 img->relief = XINT (relief);
1ea40aa2
EZ
1787 img->hmargin += eabs (img->relief);
1788 img->vmargin += eabs (img->relief);
4ef0d4d0
KS
1789 }
1790
1791 if (! img->background_valid)
1792 {
1793 bg = image_spec_value (img->spec, QCbackground, NULL);
1794 if (!NILP (bg))
1795 {
1796 img->background
1797 = x_alloc_image_color (f, img, bg,
1798 FRAME_BACKGROUND_PIXEL (f));
1799 img->background_valid = 1;
1800 }
1801 }
1802
1803 /* Do image transformations and compute masks, unless we
1804 don't have the image yet. */
1805 if (!EQ (*img->type->type, Qpostscript))
1806 postprocess_image (f, img);
1807 }
1808
1809 UNBLOCK_INPUT;
1810 }
1811
1812 /* We're using IMG, so set its timestamp to `now'. */
1813 EMACS_GET_TIME (now);
1814 img->timestamp = EMACS_SECS (now);
1815
4ef0d4d0
KS
1816 /* Value is the image id. */
1817 return img->id;
1818}
1819
1820
1821/* Cache image IMG in the image cache of frame F. */
1822
1823static void
d3da34e0 1824cache_image (struct frame *f, struct image *img)
4ef0d4d0 1825{
354884c4 1826 struct image_cache *c = FRAME_IMAGE_CACHE (f);
4ef0d4d0
KS
1827 int i;
1828
1829 /* Find a free slot in c->images. */
1830 for (i = 0; i < c->used; ++i)
1831 if (c->images[i] == NULL)
1832 break;
1833
1834 /* If no free slot found, maybe enlarge c->images. */
1835 if (i == c->used && c->used == c->size)
1836 {
1837 c->size *= 2;
1838 c->images = (struct image **) xrealloc (c->images,
1839 c->size * sizeof *c->images);
1840 }
1841
1842 /* Add IMG to c->images, and assign IMG an id. */
1843 c->images[i] = img;
1844 img->id = i;
1845 if (i == c->used)
1846 ++c->used;
1847
1848 /* Add IMG to the cache's hash table. */
1849 i = img->hash % IMAGE_CACHE_BUCKETS_SIZE;
1850 img->next = c->buckets[i];
1851 if (img->next)
1852 img->next->prev = img;
1853 img->prev = NULL;
1854 c->buckets[i] = img;
1855}
1856
1857
1858/* Call FN on every image in the image cache of frame F. Used to mark
1859 Lisp Objects in the image cache. */
1860
354884c4
SM
1861/* Mark Lisp objects in image IMG. */
1862
1863static void
d3da34e0 1864mark_image (struct image *img)
354884c4
SM
1865{
1866 mark_object (img->spec);
a2bc5bdd 1867 mark_object (img->dependencies);
354884c4
SM
1868
1869 if (!NILP (img->data.lisp_val))
1870 mark_object (img->data.lisp_val);
1871}
1872
1873
4ef0d4d0 1874void
354884c4 1875mark_image_cache (struct image_cache *c)
4ef0d4d0 1876{
354884c4 1877 if (c)
4ef0d4d0 1878 {
354884c4
SM
1879 int i;
1880 for (i = 0; i < c->used; ++i)
1881 if (c->images[i])
1882 mark_image (c->images[i]);
4ef0d4d0
KS
1883 }
1884}
1885
1886
1887\f
1888/***********************************************************************
9e2a2647 1889 X / NS / W32 support code
4ef0d4d0
KS
1890 ***********************************************************************/
1891
1892#ifdef HAVE_NTGUI
1893
1894/* Macro for defining functions that will be loaded from image DLLs. */
14beddf4 1895#define DEF_IMGLIB_FN(rettype,func,args) rettype (FAR CDECL *fn_##func)args
4ef0d4d0
KS
1896
1897/* Macro for loading those image functions from the library. */
1898#define LOAD_IMGLIB_FN(lib,func) { \
1899 fn_##func = (void *) GetProcAddress (lib, #func); \
1900 if (!fn_##func) return 0; \
1901 }
1902
0855eb52 1903/* Load a DLL implementing an image type.
2e288d54
JB
1904 The argument LIBRARIES is usually the variable
1905 `dynamic-library-alist', which associates a symbol, identifying
1906 an external DLL library, to a list of possible filenames.
0855eb52 1907 The function returns NULL if no library could be loaded for
2e288d54 1908 the given symbol, or if the library was previously loaded;
0855eb52
JB
1909 else the handle of the DLL. */
1910static HMODULE
1911w32_delayed_load (Lisp_Object libraries, Lisp_Object type)
1912{
1913 HMODULE library = NULL;
1914
1915 if (CONSP (libraries) && NILP (Fassq (type, Vimage_type_cache)))
1916 {
1917 Lisp_Object dlls = Fassq (type, libraries);
1918
1919 if (CONSP (dlls))
1920 for (dlls = XCDR (dlls); CONSP (dlls); dlls = XCDR (dlls))
1921 {
1922 CHECK_STRING_CAR (dlls);
1923 if (library = LoadLibrary (SDATA (XCAR (dlls))))
1924 break;
1925 }
1926 }
1927
1928 return library;
1929}
1930
4ef0d4d0
KS
1931#endif /* HAVE_NTGUI */
1932
f57e2426
J
1933static int x_create_x_image_and_pixmap (struct frame *, int, int, int,
1934 XImagePtr *, Pixmap *);
1935static void x_destroy_x_image (XImagePtr);
1936static void x_put_x_image (struct frame *, XImagePtr, Pixmap, int, int);
4ef0d4d0
KS
1937
1938
1939/* Create an XImage and a pixmap of size WIDTH x HEIGHT for use on
1940 frame F. Set *XIMG and *PIXMAP to the XImage and Pixmap created.
1941 Set (*XIMG)->data to a raster of WIDTH x HEIGHT pixels allocated
1942 via xmalloc. Print error messages via image_error if an error
1943 occurs. Value is non-zero if successful.
1944
1945 On W32, a DEPTH of zero signifies a 24 bit image, otherwise DEPTH
1946 should indicate the bit depth of the image. */
1947
1948static int
d3da34e0
JB
1949x_create_x_image_and_pixmap (struct frame *f, int width, int height, int depth,
1950 XImagePtr *ximg, Pixmap *pixmap)
4ef0d4d0
KS
1951{
1952#ifdef HAVE_X_WINDOWS
1953 Display *display = FRAME_X_DISPLAY (f);
1954 Window window = FRAME_X_WINDOW (f);
1955 Screen *screen = FRAME_X_SCREEN (f);
1956
1957 xassert (interrupt_input_blocked);
1958
1959 if (depth <= 0)
1960 depth = DefaultDepthOfScreen (screen);
1961 *ximg = XCreateImage (display, DefaultVisualOfScreen (screen),
1962 depth, ZPixmap, 0, NULL, width, height,
1963 depth > 16 ? 32 : depth > 8 ? 16 : 8, 0);
1964 if (*ximg == NULL)
1965 {
1966 image_error ("Unable to allocate X image", Qnil, Qnil);
1967 return 0;
1968 }
1969
1970 /* Allocate image raster. */
1971 (*ximg)->data = (char *) xmalloc ((*ximg)->bytes_per_line * height);
1972
1973 /* Allocate a pixmap of the same size. */
1974 *pixmap = XCreatePixmap (display, window, width, height, depth);
1975 if (*pixmap == NO_PIXMAP)
1976 {
1977 x_destroy_x_image (*ximg);
1978 *ximg = NULL;
1979 image_error ("Unable to create X pixmap", Qnil, Qnil);
1980 return 0;
1981 }
1982
1983 return 1;
1984#endif /* HAVE_X_WINDOWS */
1985
1986#ifdef HAVE_NTGUI
1987
1988 BITMAPINFOHEADER *header;
1989 HDC hdc;
1990 int scanline_width_bits;
1991 int remainder;
1992 int palette_colors = 0;
1993
1994 if (depth == 0)
1995 depth = 24;
1996
1997 if (depth != 1 && depth != 4 && depth != 8
1998 && depth != 16 && depth != 24 && depth != 32)
1999 {
2000 image_error ("Invalid image bit depth specified", Qnil, Qnil);
2001 return 0;
2002 }
2003
2004 scanline_width_bits = width * depth;
2005 remainder = scanline_width_bits % 32;
2006
2007 if (remainder)
2008 scanline_width_bits += 32 - remainder;
2009
2010 /* Bitmaps with a depth less than 16 need a palette. */
2011 /* BITMAPINFO structure already contains the first RGBQUAD. */
2012 if (depth < 16)
2013 palette_colors = 1 << depth - 1;
2014
2015 *ximg = xmalloc (sizeof (XImage) + palette_colors * sizeof (RGBQUAD));
2016 if (*ximg == NULL)
2017 {
2018 image_error ("Unable to allocate memory for XImage", Qnil, Qnil);
2019 return 0;
2020 }
2021
72af86bd
AS
2022 header = &(*ximg)->info.bmiHeader;
2023 memset (&(*ximg)->info, 0, sizeof (BITMAPINFO));
4ef0d4d0
KS
2024 header->biSize = sizeof (*header);
2025 header->biWidth = width;
2026 header->biHeight = -height; /* negative indicates a top-down bitmap. */
2027 header->biPlanes = 1;
2028 header->biBitCount = depth;
2029 header->biCompression = BI_RGB;
2030 header->biClrUsed = palette_colors;
2031
2032 /* TODO: fill in palette. */
2033 if (depth == 1)
2034 {
2035 (*ximg)->info.bmiColors[0].rgbBlue = 0;
2036 (*ximg)->info.bmiColors[0].rgbGreen = 0;
2037 (*ximg)->info.bmiColors[0].rgbRed = 0;
2038 (*ximg)->info.bmiColors[0].rgbReserved = 0;
2039 (*ximg)->info.bmiColors[1].rgbBlue = 255;
2040 (*ximg)->info.bmiColors[1].rgbGreen = 255;
2041 (*ximg)->info.bmiColors[1].rgbRed = 255;
2042 (*ximg)->info.bmiColors[1].rgbReserved = 0;
2043 }
2044
2045 hdc = get_frame_dc (f);
2046
2047 /* Create a DIBSection and raster array for the bitmap,
2048 and store its handle in *pixmap. */
2049 *pixmap = CreateDIBSection (hdc, &((*ximg)->info),
2050 (depth < 16) ? DIB_PAL_COLORS : DIB_RGB_COLORS,
2e09fef1
EZ
2051 /* casting avoids a GCC warning */
2052 (void **)&((*ximg)->data), NULL, 0);
4ef0d4d0
KS
2053
2054 /* Realize display palette and garbage all frames. */
2055 release_frame_dc (f, hdc);
2056
2057 if (*pixmap == NULL)
2058 {
5fc9fdeb 2059 DWORD err = GetLastError ();
4ef0d4d0
KS
2060 Lisp_Object errcode;
2061 /* All system errors are < 10000, so the following is safe. */
2062 XSETINT (errcode, (int) err);
2063 image_error ("Unable to create bitmap, error code %d", errcode, Qnil);
2064 x_destroy_x_image (*ximg);
2065 return 0;
2066 }
2067
2068 return 1;
2069
2070#endif /* HAVE_NTGUI */
2071
edfda783 2072#ifdef HAVE_NS
ed3751c8 2073 *pixmap = ns_image_for_XPM (width, height, depth);
edfda783
AR
2074 if (*pixmap == 0)
2075 {
2076 *ximg = NULL;
2077 image_error ("Unable to allocate NSImage for XPM pixmap", Qnil, Qnil);
2078 return 0;
2079 }
2080 *ximg = *pixmap;
2081 return 1;
2082#endif
4ef0d4d0
KS
2083}
2084
2085
2086/* Destroy XImage XIMG. Free XIMG->data. */
2087
2088static void
d3da34e0 2089x_destroy_x_image (XImagePtr ximg)
4ef0d4d0
KS
2090{
2091 xassert (interrupt_input_blocked);
2092 if (ximg)
2093 {
2094#ifdef HAVE_X_WINDOWS
2095 xfree (ximg->data);
2096 ximg->data = NULL;
2097 XDestroyImage (ximg);
2098#endif /* HAVE_X_WINDOWS */
2099#ifdef HAVE_NTGUI
2100 /* Data will be freed by DestroyObject. */
2101 ximg->data = NULL;
2102 xfree (ximg);
2103#endif /* HAVE_NTGUI */
edfda783 2104#ifdef HAVE_NS
ed3751c8 2105 ns_release_object (ximg);
edfda783 2106#endif /* HAVE_NS */
4ef0d4d0
KS
2107 }
2108}
2109
2110
2111/* Put XImage XIMG into pixmap PIXMAP on frame F. WIDTH and HEIGHT
2112 are width and height of both the image and pixmap. */
2113
2114static void
d3da34e0 2115x_put_x_image (struct frame *f, XImagePtr ximg, Pixmap pixmap, int width, int height)
4ef0d4d0
KS
2116{
2117#ifdef HAVE_X_WINDOWS
2118 GC gc;
2119
2120 xassert (interrupt_input_blocked);
2121 gc = XCreateGC (FRAME_X_DISPLAY (f), pixmap, 0, NULL);
2122 XPutImage (FRAME_X_DISPLAY (f), pixmap, gc, ximg, 0, 0, 0, 0, width, height);
2123 XFreeGC (FRAME_X_DISPLAY (f), gc);
2124#endif /* HAVE_X_WINDOWS */
2125
2126#ifdef HAVE_NTGUI
2127#if 0 /* I don't think this is necessary looking at where it is used. */
2128 HDC hdc = get_frame_dc (f);
2129 SetDIBits (hdc, pixmap, 0, height, ximg->data, &(ximg->info), DIB_RGB_COLORS);
2130 release_frame_dc (f, hdc);
2131#endif
2132#endif /* HAVE_NTGUI */
2133
edfda783
AR
2134#ifdef HAVE_NS
2135 xassert (ximg == pixmap);
ed3751c8 2136 ns_retain_object (ximg);
edfda783 2137#endif
4ef0d4d0
KS
2138}
2139
2140\f
2141/***********************************************************************
2142 File Handling
2143 ***********************************************************************/
2144
f57e2426 2145static unsigned char *slurp_file (char *, int *);
4ef0d4d0
KS
2146
2147
6678dc11 2148/* Find image file FILE. Look in data-directory/images, then
022af124
KH
2149 x-bitmap-file-path. Value is the encoded full name of the file
2150 found, or nil if not found. */
4ef0d4d0 2151
c640aa9b 2152Lisp_Object
d3da34e0 2153x_find_image_file (Lisp_Object file)
4ef0d4d0
KS
2154{
2155 Lisp_Object file_found, search_path;
4ef0d4d0
KS
2156 int fd;
2157
6678dc11
GM
2158 /* TODO I think this should use something like image-load-path
2159 instead. Unfortunately, that can contain non-string elements. */
2160 search_path = Fcons (Fexpand_file_name (build_string ("images"),
2161 Vdata_directory),
2162 Vx_bitmap_file_path);
4ef0d4d0 2163
050b82f6 2164 /* Try to find FILE in data-directory/images, then x-bitmap-file-path. */
4ef0d4d0
KS
2165 fd = openp (search_path, file, Qnil, &file_found, Qnil);
2166
2167 if (fd == -1)
2168 file_found = Qnil;
2169 else
022af124
KH
2170 {
2171 file_found = ENCODE_FILE (file_found);
2172 close (fd);
2173 }
4ef0d4d0 2174
4ef0d4d0
KS
2175 return file_found;
2176}
2177
2178
2179/* Read FILE into memory. Value is a pointer to a buffer allocated
2180 with xmalloc holding FILE's contents. Value is null if an error
2181 occurred. *SIZE is set to the size of the file. */
2182
2183static unsigned char *
d3da34e0 2184slurp_file (char *file, int *size)
4ef0d4d0
KS
2185{
2186 FILE *fp = NULL;
2187 unsigned char *buf = NULL;
2188 struct stat st;
2189
2190 if (stat (file, &st) == 0
2191 && (fp = fopen (file, "rb")) != NULL
fa8459a3 2192 && (buf = (unsigned char *) xmalloc (st.st_size),
4ef0d4d0
KS
2193 fread (buf, 1, st.st_size, fp) == st.st_size))
2194 {
2195 *size = st.st_size;
2196 fclose (fp);
2197 }
2198 else
2199 {
2200 if (fp)
2201 fclose (fp);
2202 if (buf)
2203 {
2204 xfree (buf);
2205 buf = NULL;
2206 }
2207 }
2208
2209 return buf;
2210}
2211
2212
2213\f
4ef0d4d0
KS
2214/***********************************************************************
2215 XBM images
2216 ***********************************************************************/
2217
f57e2426
J
2218static int xbm_scan (unsigned char **, unsigned char *, char *, int *);
2219static int xbm_load (struct frame *f, struct image *img);
2220static int xbm_load_image (struct frame *f, struct image *img,
2221 unsigned char *, unsigned char *);
2222static int xbm_image_p (Lisp_Object object);
2223static int xbm_read_bitmap_data (struct frame *f,
2224 unsigned char *, unsigned char *,
b8dc29e9 2225 int *, int *, char **, int);
f57e2426 2226static int xbm_file_p (Lisp_Object);
4ef0d4d0
KS
2227
2228
2229/* Indices of image specification fields in xbm_format, below. */
2230
2231enum xbm_keyword_index
2232{
2233 XBM_TYPE,
2234 XBM_FILE,
2235 XBM_WIDTH,
2236 XBM_HEIGHT,
2237 XBM_DATA,
2238 XBM_FOREGROUND,
2239 XBM_BACKGROUND,
2240 XBM_ASCENT,
2241 XBM_MARGIN,
2242 XBM_RELIEF,
2243 XBM_ALGORITHM,
2244 XBM_HEURISTIC_MASK,
2245 XBM_MASK,
2246 XBM_LAST
2247};
2248
2249/* Vector of image_keyword structures describing the format
2250 of valid XBM image specifications. */
2251
91433552 2252static const struct image_keyword xbm_format[XBM_LAST] =
4ef0d4d0
KS
2253{
2254 {":type", IMAGE_SYMBOL_VALUE, 1},
2255 {":file", IMAGE_STRING_VALUE, 0},
2256 {":width", IMAGE_POSITIVE_INTEGER_VALUE, 0},
2257 {":height", IMAGE_POSITIVE_INTEGER_VALUE, 0},
2258 {":data", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
2259 {":foreground", IMAGE_STRING_OR_NIL_VALUE, 0},
2260 {":background", IMAGE_STRING_OR_NIL_VALUE, 0},
2261 {":ascent", IMAGE_ASCENT_VALUE, 0},
2262 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
2263 {":relief", IMAGE_INTEGER_VALUE, 0},
2264 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
2265 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
2266 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
2267};
2268
2269/* Structure describing the image type XBM. */
2270
2271static struct image_type xbm_type =
2272{
2273 &Qxbm,
2274 xbm_image_p,
2275 xbm_load,
2276 x_clear_image,
2277 NULL
2278};
2279
2280/* Tokens returned from xbm_scan. */
2281
2282enum xbm_token
2283{
2284 XBM_TK_IDENT = 256,
2285 XBM_TK_NUMBER
2286};
2287
2288
2289/* Return non-zero if OBJECT is a valid XBM-type image specification.
2290 A valid specification is a list starting with the symbol `image'
2291 The rest of the list is a property list which must contain an
2292 entry `:type xbm..
2293
2294 If the specification specifies a file to load, it must contain
2295 an entry `:file FILENAME' where FILENAME is a string.
2296
2297 If the specification is for a bitmap loaded from memory it must
2298 contain `:width WIDTH', `:height HEIGHT', and `:data DATA', where
2299 WIDTH and HEIGHT are integers > 0. DATA may be:
2300
2301 1. a string large enough to hold the bitmap data, i.e. it must
2302 have a size >= (WIDTH + 7) / 8 * HEIGHT
2303
2304 2. a bool-vector of size >= WIDTH * HEIGHT
2305
2306 3. a vector of strings or bool-vectors, one for each line of the
2307 bitmap.
2308
bbe6f2aa 2309 4. a string containing an in-memory XBM file. WIDTH and HEIGHT
4ef0d4d0
KS
2310 may not be specified in this case because they are defined in the
2311 XBM file.
2312
2313 Both the file and data forms may contain the additional entries
2314 `:background COLOR' and `:foreground COLOR'. If not present,
2315 foreground and background of the frame on which the image is
2316 displayed is used. */
2317
2318static int
d3da34e0 2319xbm_image_p (Lisp_Object object)
4ef0d4d0
KS
2320{
2321 struct image_keyword kw[XBM_LAST];
2322
72af86bd 2323 memcpy (kw, xbm_format, sizeof kw);
4ef0d4d0
KS
2324 if (!parse_image_spec (object, kw, XBM_LAST, Qxbm))
2325 return 0;
2326
2327 xassert (EQ (kw[XBM_TYPE].value, Qxbm));
2328
2329 if (kw[XBM_FILE].count)
2330 {
2331 if (kw[XBM_WIDTH].count || kw[XBM_HEIGHT].count || kw[XBM_DATA].count)
2332 return 0;
2333 }
2334 else if (kw[XBM_DATA].count && xbm_file_p (kw[XBM_DATA].value))
2335 {
2336 /* In-memory XBM file. */
2337 if (kw[XBM_WIDTH].count || kw[XBM_HEIGHT].count || kw[XBM_FILE].count)
2338 return 0;
2339 }
2340 else
2341 {
2342 Lisp_Object data;
2343 int width, height;
2344
2345 /* Entries for `:width', `:height' and `:data' must be present. */
2346 if (!kw[XBM_WIDTH].count
2347 || !kw[XBM_HEIGHT].count
2348 || !kw[XBM_DATA].count)
2349 return 0;
2350
2351 data = kw[XBM_DATA].value;
2352 width = XFASTINT (kw[XBM_WIDTH].value);
2353 height = XFASTINT (kw[XBM_HEIGHT].value);
2354
2355 /* Check type of data, and width and height against contents of
2356 data. */
2357 if (VECTORP (data))
2358 {
2359 int i;
2360
2361 /* Number of elements of the vector must be >= height. */
2362 if (XVECTOR (data)->size < height)
2363 return 0;
2364
2365 /* Each string or bool-vector in data must be large enough
2366 for one line of the image. */
2367 for (i = 0; i < height; ++i)
2368 {
2369 Lisp_Object elt = XVECTOR (data)->contents[i];
2370
2371 if (STRINGP (elt))
2372 {
2373 if (SCHARS (elt)
2374 < (width + BITS_PER_CHAR - 1) / BITS_PER_CHAR)
2375 return 0;
2376 }
2377 else if (BOOL_VECTOR_P (elt))
2378 {
2379 if (XBOOL_VECTOR (elt)->size < width)
2380 return 0;
2381 }
2382 else
2383 return 0;
2384 }
2385 }
2386 else if (STRINGP (data))
2387 {
2388 if (SCHARS (data)
2389 < (width + BITS_PER_CHAR - 1) / BITS_PER_CHAR * height)
2390 return 0;
2391 }
2392 else if (BOOL_VECTOR_P (data))
2393 {
2394 if (XBOOL_VECTOR (data)->size < width * height)
2395 return 0;
2396 }
2397 else
2398 return 0;
2399 }
2400
2401 return 1;
2402}
2403
2404
2405/* Scan a bitmap file. FP is the stream to read from. Value is
2406 either an enumerator from enum xbm_token, or a character for a
2407 single-character token, or 0 at end of file. If scanning an
2408 identifier, store the lexeme of the identifier in SVAL. If
2409 scanning a number, store its value in *IVAL. */
2410
2411static int
d3da34e0 2412xbm_scan (unsigned char **s, unsigned char *end, char *sval, int *ival)
4ef0d4d0
KS
2413{
2414 unsigned int c;
2415
2416 loop:
2417
2418 /* Skip white space. */
2419 while (*s < end && (c = *(*s)++, isspace (c)))
2420 ;
2421
2422 if (*s >= end)
2423 c = 0;
2424 else if (isdigit (c))
2425 {
2426 int value = 0, digit;
2427
2428 if (c == '0' && *s < end)
2429 {
2430 c = *(*s)++;
2431 if (c == 'x' || c == 'X')
2432 {
2433 while (*s < end)
2434 {
2435 c = *(*s)++;
2436 if (isdigit (c))
2437 digit = c - '0';
2438 else if (c >= 'a' && c <= 'f')
2439 digit = c - 'a' + 10;
2440 else if (c >= 'A' && c <= 'F')
2441 digit = c - 'A' + 10;
2442 else
2443 break;
2444 value = 16 * value + digit;
2445 }
2446 }
2447 else if (isdigit (c))
2448 {
2449 value = c - '0';
2450 while (*s < end
2451 && (c = *(*s)++, isdigit (c)))
2452 value = 8 * value + c - '0';
2453 }
2454 }
2455 else
2456 {
2457 value = c - '0';
2458 while (*s < end
2459 && (c = *(*s)++, isdigit (c)))
2460 value = 10 * value + c - '0';
2461 }
2462
2463 if (*s < end)
2464 *s = *s - 1;
2465 *ival = value;
2466 c = XBM_TK_NUMBER;
2467 }
2468 else if (isalpha (c) || c == '_')
2469 {
2470 *sval++ = c;
2471 while (*s < end
2472 && (c = *(*s)++, (isalnum (c) || c == '_')))
2473 *sval++ = c;
2474 *sval = 0;
2475 if (*s < end)
2476 *s = *s - 1;
2477 c = XBM_TK_IDENT;
2478 }
2479 else if (c == '/' && **s == '*')
2480 {
2481 /* C-style comment. */
2482 ++*s;
2483 while (**s && (**s != '*' || *(*s + 1) != '/'))
2484 ++*s;
2485 if (**s)
2486 {
2487 *s += 2;
2488 goto loop;
2489 }
2490 }
2491
2492 return c;
2493}
2494
2495#ifdef HAVE_NTGUI
2496
2497/* Create a Windows bitmap from X bitmap data. */
2498static HBITMAP
2499w32_create_pixmap_from_bitmap_data (int width, int height, char *data)
2500{
2501 static unsigned char swap_nibble[16]
2502 = { 0x0, 0x8, 0x4, 0xc, /* 0000 1000 0100 1100 */
2503 0x2, 0xa, 0x6, 0xe, /* 0010 1010 0110 1110 */
2504 0x1, 0x9, 0x5, 0xd, /* 0001 1001 0101 1101 */
2505 0x3, 0xb, 0x7, 0xf }; /* 0011 1011 0111 1111 */
2506 int i, j, w1, w2;
2507 unsigned char *bits, *p;
2508 HBITMAP bmp;
2509
2510 w1 = (width + 7) / 8; /* nb of 8bits elt in X bitmap */
2511 w2 = ((width + 15) / 16) * 2; /* nb of 16bits elt in W32 bitmap */
2512 bits = (unsigned char *) alloca (height * w2);
72af86bd 2513 memset (bits, 0, height * w2);
4ef0d4d0
KS
2514 for (i = 0; i < height; i++)
2515 {
2516 p = bits + i*w2;
2517 for (j = 0; j < w1; j++)
2518 {
2519 /* Bitswap XBM bytes to match how Windows does things. */
2520 unsigned char c = *data++;
2521 *p++ = (unsigned char)((swap_nibble[c & 0xf] << 4)
2522 | (swap_nibble[(c>>4) & 0xf]));
2523 }
2524 }
2525 bmp = CreateBitmap (width, height, 1, 1, (char *) bits);
2526
2527 return bmp;
2528}
2529
3046a84b 2530static void
7c3320d8
JB
2531convert_mono_to_color_image (struct frame *f, struct image *img,
2532 COLORREF foreground, COLORREF background)
4ef0d4d0
KS
2533{
2534 HDC hdc, old_img_dc, new_img_dc;
2535 HGDIOBJ old_prev, new_prev;
2536 HBITMAP new_pixmap;
2537
2538 hdc = get_frame_dc (f);
2539 old_img_dc = CreateCompatibleDC (hdc);
2540 new_img_dc = CreateCompatibleDC (hdc);
2541 new_pixmap = CreateCompatibleBitmap (hdc, img->width, img->height);
2542 release_frame_dc (f, hdc);
2543 old_prev = SelectObject (old_img_dc, img->pixmap);
2544 new_prev = SelectObject (new_img_dc, new_pixmap);
44b1dc2e
JR
2545 /* Windows convention for mono bitmaps is black = background,
2546 white = foreground. */
2386b1f1
JR
2547 SetTextColor (new_img_dc, background);
2548 SetBkColor (new_img_dc, foreground);
4ef0d4d0
KS
2549
2550 BitBlt (new_img_dc, 0, 0, img->width, img->height, old_img_dc,
2551 0, 0, SRCCOPY);
2552
2553 SelectObject (old_img_dc, old_prev);
2554 SelectObject (new_img_dc, new_prev);
2555 DeleteDC (old_img_dc);
2556 DeleteDC (new_img_dc);
2557 DeleteObject (img->pixmap);
2558 if (new_pixmap == 0)
2559 fprintf (stderr, "Failed to convert image to color.\n");
2560 else
2561 img->pixmap = new_pixmap;
2562}
2563
2564#define XBM_BIT_SHUFFLE(b) (~(b))
2565
2566#else
2567
2568#define XBM_BIT_SHUFFLE(b) (b)
2569
2570#endif /* HAVE_NTGUI */
2571
2572
2573static void
d3da34e0
JB
2574Create_Pixmap_From_Bitmap_Data (struct frame *f, struct image *img, char *data,
2575 RGB_PIXEL_COLOR fg, RGB_PIXEL_COLOR bg,
2576 int non_default_colors)
4ef0d4d0
KS
2577{
2578#ifdef HAVE_NTGUI
2579 img->pixmap
2580 = w32_create_pixmap_from_bitmap_data (img->width, img->height, data);
2581
2582 /* If colors were specified, transfer the bitmap to a color one. */
2583 if (non_default_colors)
2584 convert_mono_to_color_image (f, img, fg, bg);
edfda783
AR
2585
2586#elif defined (HAVE_NS)
ed3751c8 2587 img->pixmap = ns_image_from_XBM (data, img->width, img->height);
edfda783 2588
4ef0d4d0
KS
2589#else
2590 img->pixmap
2591 = XCreatePixmapFromBitmapData (FRAME_X_DISPLAY (f),
2592 FRAME_X_WINDOW (f),
2593 data,
2594 img->width, img->height,
2595 fg, bg,
2596 DefaultDepthOfScreen (FRAME_X_SCREEN (f)));
edfda783 2597#endif /* !HAVE_NTGUI && !HAVE_NS */
4ef0d4d0
KS
2598}
2599
2600
2601
2602/* Replacement for XReadBitmapFileData which isn't available under old
2603 X versions. CONTENTS is a pointer to a buffer to parse; END is the
2604 buffer's end. Set *WIDTH and *HEIGHT to the width and height of
2605 the image. Return in *DATA the bitmap data allocated with xmalloc.
2606 Value is non-zero if successful. DATA null means just test if
ce959360
CY
2607 CONTENTS looks like an in-memory XBM file. If INHIBIT_IMAGE_ERROR
2608 is non-zero, inhibit the call to image_error when the image size is
2609 invalid (the bitmap remains unread). */
4ef0d4d0
KS
2610
2611static int
d3da34e0 2612xbm_read_bitmap_data (struct frame *f, unsigned char *contents, unsigned char *end,
b8dc29e9 2613 int *width, int *height, char **data,
d3da34e0 2614 int inhibit_image_error)
4ef0d4d0
KS
2615{
2616 unsigned char *s = contents;
2617 char buffer[BUFSIZ];
2618 int padding_p = 0;
2619 int v10 = 0;
2620 int bytes_per_line, i, nbytes;
b8dc29e9 2621 char *p;
4ef0d4d0
KS
2622 int value;
2623 int LA1;
2624
2625#define match() \
2626 LA1 = xbm_scan (&s, end, buffer, &value)
2627
2628#define expect(TOKEN) \
2629 if (LA1 != (TOKEN)) \
2630 goto failure; \
2631 else \
2632 match ()
2633
2634#define expect_ident(IDENT) \
2635 if (LA1 == XBM_TK_IDENT && strcmp (buffer, (IDENT)) == 0) \
2636 match (); \
2637 else \
2638 goto failure
2639
2640 *width = *height = -1;
2641 if (data)
2642 *data = NULL;
2643 LA1 = xbm_scan (&s, end, buffer, &value);
2644
2645 /* Parse defines for width, height and hot-spots. */
2646 while (LA1 == '#')
2647 {
2648 match ();
2649 expect_ident ("define");
2650 expect (XBM_TK_IDENT);
2651
431feaf6 2652 if (LA1 == XBM_TK_NUMBER)
4ef0d4d0 2653 {
6ae141d6
PE
2654 char *q = strrchr (buffer, '_');
2655 q = q ? q + 1 : buffer;
2656 if (strcmp (q, "width") == 0)
4ef0d4d0 2657 *width = value;
6ae141d6 2658 else if (strcmp (q, "height") == 0)
4ef0d4d0
KS
2659 *height = value;
2660 }
2661 expect (XBM_TK_NUMBER);
2662 }
2663
f1f25b99 2664 if (!check_image_size (f, *width, *height))
10ea2b82 2665 {
ce959360
CY
2666 if (!inhibit_image_error)
2667 image_error ("Invalid image size (see `max-image-size')", Qnil, Qnil);
10ea2b82
JR
2668 goto failure;
2669 }
4ef0d4d0
KS
2670 else if (data == NULL)
2671 goto success;
2672
2673 /* Parse bits. Must start with `static'. */
2674 expect_ident ("static");
2675 if (LA1 == XBM_TK_IDENT)
2676 {
2677 if (strcmp (buffer, "unsigned") == 0)
2678 {
2679 match ();
2680 expect_ident ("char");
2681 }
2682 else if (strcmp (buffer, "short") == 0)
2683 {
2684 match ();
2685 v10 = 1;
2686 if (*width % 16 && *width % 16 < 9)
2687 padding_p = 1;
2688 }
2689 else if (strcmp (buffer, "char") == 0)
2690 match ();
2691 else
2692 goto failure;
2693 }
2694 else
2695 goto failure;
2696
2697 expect (XBM_TK_IDENT);
2698 expect ('[');
2699 expect (']');
2700 expect ('=');
2701 expect ('{');
2702
2703 bytes_per_line = (*width + 7) / 8 + padding_p;
2704 nbytes = bytes_per_line * *height;
b8dc29e9 2705 p = *data = (char *) xmalloc (nbytes);
4ef0d4d0
KS
2706
2707 if (v10)
2708 {
2709 for (i = 0; i < nbytes; i += 2)
2710 {
2711 int val = value;
2712 expect (XBM_TK_NUMBER);
2713
2714 *p++ = XBM_BIT_SHUFFLE (val);
2715 if (!padding_p || ((i + 2) % bytes_per_line))
2716 *p++ = XBM_BIT_SHUFFLE (value >> 8);
2717
2718 if (LA1 == ',' || LA1 == '}')
2719 match ();
2720 else
2721 goto failure;
2722 }
2723 }
2724 else
2725 {
2726 for (i = 0; i < nbytes; ++i)
2727 {
2728 int val = value;
2729 expect (XBM_TK_NUMBER);
2730
2731 *p++ = XBM_BIT_SHUFFLE (val);
2732
2733 if (LA1 == ',' || LA1 == '}')
2734 match ();
2735 else
2736 goto failure;
2737 }
2738 }
2739
2740 success:
2741 return 1;
2742
2743 failure:
2744
2745 if (data && *data)
2746 {
2747 xfree (*data);
2748 *data = NULL;
2749 }
2750 return 0;
2751
2752#undef match
2753#undef expect
2754#undef expect_ident
2755}
2756
2757
2758/* Load XBM image IMG which will be displayed on frame F from buffer
2759 CONTENTS. END is the end of the buffer. Value is non-zero if
2760 successful. */
2761
2762static int
d3da34e0
JB
2763xbm_load_image (struct frame *f, struct image *img, unsigned char *contents,
2764 unsigned char *end)
4ef0d4d0
KS
2765{
2766 int rc;
b8dc29e9 2767 char *data;
4ef0d4d0
KS
2768 int success_p = 0;
2769
ce959360
CY
2770 rc = xbm_read_bitmap_data (f, contents, end, &img->width, &img->height,
2771 &data, 0);
4ef0d4d0
KS
2772 if (rc)
2773 {
2774 unsigned long foreground = FRAME_FOREGROUND_PIXEL (f);
2775 unsigned long background = FRAME_BACKGROUND_PIXEL (f);
2776 int non_default_colors = 0;
2777 Lisp_Object value;
2778
2779 xassert (img->width > 0 && img->height > 0);
2780
2781 /* Get foreground and background colors, maybe allocate colors. */
2782 value = image_spec_value (img->spec, QCforeground, NULL);
2783 if (!NILP (value))
2784 {
2785 foreground = x_alloc_image_color (f, img, value, foreground);
2786 non_default_colors = 1;
2787 }
2788 value = image_spec_value (img->spec, QCbackground, NULL);
2789 if (!NILP (value))
2790 {
2791 background = x_alloc_image_color (f, img, value, background);
2792 img->background = background;
2793 img->background_valid = 1;
2794 non_default_colors = 1;
2795 }
2796
1f026899 2797 Create_Pixmap_From_Bitmap_Data (f, img, data,
4ef0d4d0
KS
2798 foreground, background,
2799 non_default_colors);
2800 xfree (data);
2801
2802 if (img->pixmap == NO_PIXMAP)
2803 {
2804 x_clear_image (f, img);
2805 image_error ("Unable to create X pixmap for `%s'", img->spec, Qnil);
2806 }
2807 else
2808 success_p = 1;
2809 }
2810 else
2811 image_error ("Error loading XBM image `%s'", img->spec, Qnil);
2812
2813 return success_p;
2814}
2815
2816
2817/* Value is non-zero if DATA looks like an in-memory XBM file. */
2818
2819static int
d3da34e0 2820xbm_file_p (Lisp_Object data)
4ef0d4d0
KS
2821{
2822 int w, h;
2823 return (STRINGP (data)
f1f25b99 2824 && xbm_read_bitmap_data (NULL, SDATA (data),
ce959360
CY
2825 (SDATA (data) + SBYTES (data)),
2826 &w, &h, NULL, 1));
4ef0d4d0
KS
2827}
2828
2829
2830/* Fill image IMG which is used on frame F with pixmap data. Value is
2831 non-zero if successful. */
2832
2833static int
d3da34e0 2834xbm_load (struct frame *f, struct image *img)
4ef0d4d0
KS
2835{
2836 int success_p = 0;
2837 Lisp_Object file_name;
2838
2839 xassert (xbm_image_p (img->spec));
2840
2841 /* If IMG->spec specifies a file name, create a non-file spec from it. */
2842 file_name = image_spec_value (img->spec, QCfile, NULL);
2843 if (STRINGP (file_name))
2844 {
2845 Lisp_Object file;
2846 unsigned char *contents;
2847 int size;
4ef0d4d0
KS
2848
2849 file = x_find_image_file (file_name);
4ef0d4d0
KS
2850 if (!STRINGP (file))
2851 {
2852 image_error ("Cannot find image file `%s'", file_name, Qnil);
4ef0d4d0
KS
2853 return 0;
2854 }
2855
42a5b22f 2856 contents = slurp_file (SSDATA (file), &size);
4ef0d4d0
KS
2857 if (contents == NULL)
2858 {
2859 image_error ("Error loading XBM image `%s'", img->spec, Qnil);
4ef0d4d0
KS
2860 return 0;
2861 }
2862
2863 success_p = xbm_load_image (f, img, contents, contents + size);
4ef0d4d0
KS
2864 }
2865 else
2866 {
2867 struct image_keyword fmt[XBM_LAST];
2868 Lisp_Object data;
2869 unsigned long foreground = FRAME_FOREGROUND_PIXEL (f);
2870 unsigned long background = FRAME_BACKGROUND_PIXEL (f);
2871 int non_default_colors = 0;
2872 char *bits;
2873 int parsed_p;
2874 int in_memory_file_p = 0;
2875
2876 /* See if data looks like an in-memory XBM file. */
2877 data = image_spec_value (img->spec, QCdata, NULL);
2878 in_memory_file_p = xbm_file_p (data);
2879
2880 /* Parse the image specification. */
72af86bd 2881 memcpy (fmt, xbm_format, sizeof fmt);
4ef0d4d0 2882 parsed_p = parse_image_spec (img->spec, fmt, XBM_LAST, Qxbm);
35fa624f 2883 (void) parsed_p;
4ef0d4d0
KS
2884 xassert (parsed_p);
2885
2886 /* Get specified width, and height. */
2887 if (!in_memory_file_p)
2888 {
2889 img->width = XFASTINT (fmt[XBM_WIDTH].value);
2890 img->height = XFASTINT (fmt[XBM_HEIGHT].value);
2891 xassert (img->width > 0 && img->height > 0);
2892 }
2893
2894 /* Get foreground and background colors, maybe allocate colors. */
2895 if (fmt[XBM_FOREGROUND].count
2896 && STRINGP (fmt[XBM_FOREGROUND].value))
2897 {
2898 foreground = x_alloc_image_color (f, img, fmt[XBM_FOREGROUND].value,
2899 foreground);
2900 non_default_colors = 1;
2901 }
2902
2903 if (fmt[XBM_BACKGROUND].count
2904 && STRINGP (fmt[XBM_BACKGROUND].value))
2905 {
2906 background = x_alloc_image_color (f, img, fmt[XBM_BACKGROUND].value,
2907 background);
2908 non_default_colors = 1;
2909 }
2910
2911 if (in_memory_file_p)
2912 success_p = xbm_load_image (f, img, SDATA (data),
2913 (SDATA (data)
2914 + SBYTES (data)));
2915 else
2916 {
2917 if (VECTORP (data))
2918 {
2919 int i;
2920 char *p;
2921 int nbytes = (img->width + BITS_PER_CHAR - 1) / BITS_PER_CHAR;
2922
2923 p = bits = (char *) alloca (nbytes * img->height);
2924 for (i = 0; i < img->height; ++i, p += nbytes)
2925 {
2926 Lisp_Object line = XVECTOR (data)->contents[i];
2927 if (STRINGP (line))
72af86bd 2928 memcpy (p, SDATA (line), nbytes);
4ef0d4d0 2929 else
72af86bd 2930 memcpy (p, XBOOL_VECTOR (line)->data, nbytes);
4ef0d4d0
KS
2931 }
2932 }
2933 else if (STRINGP (data))
42a5b22f 2934 bits = SSDATA (data);
4ef0d4d0 2935 else
b8dc29e9 2936 bits = (char *) XBOOL_VECTOR (data)->data;
4ef0d4d0 2937
44b1dc2e
JR
2938#ifdef WINDOWSNT
2939 {
2940 char *invertedBits;
2941 int nbytes, i;
2942 /* Windows mono bitmaps are reversed compared with X. */
2943 invertedBits = bits;
285d07e2 2944 nbytes = (img->width + BITS_PER_CHAR - 1) / BITS_PER_CHAR
44b1dc2e 2945 * img->height;
ed3751c8 2946 bits = (char *) alloca (nbytes);
44b1dc2e
JR
2947 for (i = 0; i < nbytes; i++)
2948 bits[i] = XBM_BIT_SHUFFLE (invertedBits[i]);
2949 }
2950#endif
4ef0d4d0
KS
2951 /* Create the pixmap. */
2952
2953 Create_Pixmap_From_Bitmap_Data (f, img, bits,
2954 foreground, background,
2955 non_default_colors);
2956 if (img->pixmap)
2957 success_p = 1;
2958 else
2959 {
2960 image_error ("Unable to create pixmap for XBM image `%s'",
2961 img->spec, Qnil);
2962 x_clear_image (f, img);
2963 }
2964 }
2965 }
2966
2967 return success_p;
2968}
2969
2970
2971\f
2972/***********************************************************************
2973 XPM images
2974 ***********************************************************************/
2975
9e2a2647 2976#if defined (HAVE_XPM) || defined (HAVE_NS)
4ef0d4d0 2977
f57e2426
J
2978static int xpm_image_p (Lisp_Object object);
2979static int xpm_load (struct frame *f, struct image *img);
2980static int xpm_valid_color_symbols_p (Lisp_Object);
4ef0d4d0 2981
9e2a2647 2982#endif /* HAVE_XPM || HAVE_NS */
ea1aaa6f
ST
2983
2984#ifdef HAVE_XPM
4ef0d4d0
KS
2985#ifdef HAVE_NTGUI
2986/* Indicate to xpm.h that we don't have Xlib. */
2987#define FOR_MSW
2988/* simx.h in xpm defines XColor and XImage differently than Emacs. */
279d3293 2989/* It also defines Display the same way as Emacs, but gcc 3.3 still barfs. */
4ef0d4d0
KS
2990#define XColor xpm_XColor
2991#define XImage xpm_XImage
279d3293 2992#define Display xpm_Display
4ef0d4d0
KS
2993#define PIXEL_ALREADY_TYPEDEFED
2994#include "X11/xpm.h"
2995#undef FOR_MSW
2996#undef XColor
2997#undef XImage
279d3293 2998#undef Display
4ef0d4d0
KS
2999#undef PIXEL_ALREADY_TYPEDEFED
3000#else
3001#include "X11/xpm.h"
3002#endif /* HAVE_NTGUI */
ea1aaa6f 3003#endif /* HAVE_XPM */
4ef0d4d0 3004
9e2a2647 3005#if defined (HAVE_XPM) || defined (HAVE_NS)
4ef0d4d0
KS
3006/* The symbol `xpm' identifying XPM-format images. */
3007
955cbe7b 3008static Lisp_Object Qxpm;
4ef0d4d0
KS
3009
3010/* Indices of image specification fields in xpm_format, below. */
3011
3012enum xpm_keyword_index
3013{
3014 XPM_TYPE,
3015 XPM_FILE,
3016 XPM_DATA,
3017 XPM_ASCENT,
3018 XPM_MARGIN,
3019 XPM_RELIEF,
3020 XPM_ALGORITHM,
3021 XPM_HEURISTIC_MASK,
3022 XPM_MASK,
3023 XPM_COLOR_SYMBOLS,
3024 XPM_BACKGROUND,
3025 XPM_LAST
3026};
3027
3028/* Vector of image_keyword structures describing the format
3029 of valid XPM image specifications. */
3030
91433552 3031static const struct image_keyword xpm_format[XPM_LAST] =
4ef0d4d0
KS
3032{
3033 {":type", IMAGE_SYMBOL_VALUE, 1},
3034 {":file", IMAGE_STRING_VALUE, 0},
3035 {":data", IMAGE_STRING_VALUE, 0},
3036 {":ascent", IMAGE_ASCENT_VALUE, 0},
3037 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
3038 {":relief", IMAGE_INTEGER_VALUE, 0},
3039 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
3040 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
3041 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
3042 {":color-symbols", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
3043 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
3044};
3045
3046/* Structure describing the image type XPM. */
3047
3048static struct image_type xpm_type =
3049{
3050 &Qxpm,
3051 xpm_image_p,
3052 xpm_load,
3053 x_clear_image,
3054 NULL
3055};
3056
3057#ifdef HAVE_X_WINDOWS
3058
3059/* Define ALLOC_XPM_COLORS if we can use Emacs' own color allocation
3060 functions for allocating image colors. Our own functions handle
3061 color allocation failures more gracefully than the ones on the XPM
3062 lib. */
3063
3064#if defined XpmAllocColor && defined XpmFreeColors && defined XpmColorClosure
3065#define ALLOC_XPM_COLORS
3066#endif
3067#endif /* HAVE_X_WINDOWS */
3068
3069#ifdef ALLOC_XPM_COLORS
3070
f57e2426
J
3071static void xpm_init_color_cache (struct frame *, XpmAttributes *);
3072static void xpm_free_color_cache (void);
3073static int xpm_lookup_color (struct frame *, char *, XColor *);
3074static int xpm_color_bucket (char *);
3075static struct xpm_cached_color *xpm_cache_color (struct frame *, char *,
3076 XColor *, int);
4ef0d4d0
KS
3077
3078/* An entry in a hash table used to cache color definitions of named
3079 colors. This cache is necessary to speed up XPM image loading in
3080 case we do color allocations ourselves. Without it, we would need
3081 a call to XParseColor per pixel in the image. */
3082
3083struct xpm_cached_color
3084{
3085 /* Next in collision chain. */
3086 struct xpm_cached_color *next;
3087
3088 /* Color definition (RGB and pixel color). */
3089 XColor color;
3090
3091 /* Color name. */
3092 char name[1];
3093};
3094
3095/* The hash table used for the color cache, and its bucket vector
3096 size. */
3097
3098#define XPM_COLOR_CACHE_BUCKETS 1001
cd44d2eb 3099static struct xpm_cached_color **xpm_color_cache;
4ef0d4d0
KS
3100
3101/* Initialize the color cache. */
3102
3103static void
d3da34e0 3104xpm_init_color_cache (struct frame *f, XpmAttributes *attrs)
4ef0d4d0
KS
3105{
3106 size_t nbytes = XPM_COLOR_CACHE_BUCKETS * sizeof *xpm_color_cache;
3107 xpm_color_cache = (struct xpm_cached_color **) xmalloc (nbytes);
3108 memset (xpm_color_cache, 0, nbytes);
3109 init_color_table ();
3110
3111 if (attrs->valuemask & XpmColorSymbols)
3112 {
3113 int i;
3114 XColor color;
3115
3116 for (i = 0; i < attrs->numsymbols; ++i)
3117 if (XParseColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
3118 attrs->colorsymbols[i].value, &color))
3119 {
3120 color.pixel = lookup_rgb_color (f, color.red, color.green,
3121 color.blue);
3122 xpm_cache_color (f, attrs->colorsymbols[i].name, &color, -1);
3123 }
3124 }
3125}
3126
3127/* Free the color cache. */
3128
3129static void
d3da34e0 3130xpm_free_color_cache (void)
4ef0d4d0
KS
3131{
3132 struct xpm_cached_color *p, *next;
3133 int i;
3134
3135 for (i = 0; i < XPM_COLOR_CACHE_BUCKETS; ++i)
3136 for (p = xpm_color_cache[i]; p; p = next)
3137 {
3138 next = p->next;
3139 xfree (p);
3140 }
3141
3142 xfree (xpm_color_cache);
3143 xpm_color_cache = NULL;
3144 free_color_table ();
3145}
3146
3147/* Return the bucket index for color named COLOR_NAME in the color
3148 cache. */
3149
3150static int
d3da34e0 3151xpm_color_bucket (char *color_name)
4ef0d4d0
KS
3152{
3153 unsigned h = 0;
3154 char *s;
3155
3156 for (s = color_name; *s; ++s)
3157 h = (h << 2) ^ *s;
3158 return h %= XPM_COLOR_CACHE_BUCKETS;
3159}
3160
3161
3162/* On frame F, cache values COLOR for color with name COLOR_NAME.
3163 BUCKET, if >= 0, is a precomputed bucket index. Value is the cache
3164 entry added. */
3165
3166static struct xpm_cached_color *
d3da34e0 3167xpm_cache_color (struct frame *f, char *color_name, XColor *color, int bucket)
4ef0d4d0
KS
3168{
3169 size_t nbytes;
3170 struct xpm_cached_color *p;
3171
3172 if (bucket < 0)
3173 bucket = xpm_color_bucket (color_name);
3174
3175 nbytes = sizeof *p + strlen (color_name);
3176 p = (struct xpm_cached_color *) xmalloc (nbytes);
3177 strcpy (p->name, color_name);
3178 p->color = *color;
3179 p->next = xpm_color_cache[bucket];
3180 xpm_color_cache[bucket] = p;
3181 return p;
3182}
3183
3184/* Look up color COLOR_NAME for frame F in the color cache. If found,
3185 return the cached definition in *COLOR. Otherwise, make a new
3186 entry in the cache and allocate the color. Value is zero if color
3187 allocation failed. */
3188
3189static int
d3da34e0 3190xpm_lookup_color (struct frame *f, char *color_name, XColor *color)
4ef0d4d0
KS
3191{
3192 struct xpm_cached_color *p;
3193 int h = xpm_color_bucket (color_name);
3194
3195 for (p = xpm_color_cache[h]; p; p = p->next)
3196 if (strcmp (p->name, color_name) == 0)
3197 break;
3198
3199 if (p != NULL)
3200 *color = p->color;
3201 else if (XParseColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
3202 color_name, color))
3203 {
3204 color->pixel = lookup_rgb_color (f, color->red, color->green,
3205 color->blue);
3206 p = xpm_cache_color (f, color_name, color, h);
3207 }
3208 /* You get `opaque' at least from ImageMagick converting pbm to xpm
3209 with transparency, and it's useful. */
3210 else if (strcmp ("opaque", color_name) == 0)
3211 {
72af86bd 3212 memset (color, 0, sizeof (XColor)); /* Is this necessary/correct? */
4ef0d4d0
KS
3213 color->pixel = FRAME_FOREGROUND_PIXEL (f);
3214 p = xpm_cache_color (f, color_name, color, h);
3215 }
3216
3217 return p != NULL;
3218}
3219
3220
3221/* Callback for allocating color COLOR_NAME. Called from the XPM lib.
3222 CLOSURE is a pointer to the frame on which we allocate the
3223 color. Return in *COLOR the allocated color. Value is non-zero
3224 if successful. */
3225
3226static int
d3da34e0
JB
3227xpm_alloc_color (Display *dpy, Colormap cmap, char *color_name, XColor *color,
3228 void *closure)
4ef0d4d0
KS
3229{
3230 return xpm_lookup_color ((struct frame *) closure, color_name, color);
3231}
3232
3233
3234/* Callback for freeing NPIXELS colors contained in PIXELS. CLOSURE
3235 is a pointer to the frame on which we allocate the color. Value is
3236 non-zero if successful. */
3237
3238static int
d3da34e0 3239xpm_free_colors (Display *dpy, Colormap cmap, Pixel *pixels, int npixels, void *closure)
4ef0d4d0
KS
3240{
3241 return 1;
3242}
3243
3244#endif /* ALLOC_XPM_COLORS */
3245
3246
3247#ifdef HAVE_NTGUI
3248
3249/* XPM library details. */
3250
14beddf4
CY
3251DEF_IMGLIB_FN (void, XpmFreeAttributes, (XpmAttributes *));
3252DEF_IMGLIB_FN (int, XpmCreateImageFromBuffer, (Display *, char *, xpm_XImage **,
850690cc 3253 xpm_XImage **, XpmAttributes *));
14beddf4 3254DEF_IMGLIB_FN (int, XpmReadFileToImage, (Display *, char *, xpm_XImage **,
850690cc 3255 xpm_XImage **, XpmAttributes *));
14beddf4 3256DEF_IMGLIB_FN (void, XImageFree, (xpm_XImage *));
4ef0d4d0 3257
4ef0d4d0 3258static int
0855eb52 3259init_xpm_functions (Lisp_Object libraries)
4ef0d4d0
KS
3260{
3261 HMODULE library;
3262
0855eb52 3263 if (!(library = w32_delayed_load (libraries, Qxpm)))
4ef0d4d0
KS
3264 return 0;
3265
3266 LOAD_IMGLIB_FN (library, XpmFreeAttributes);
3267 LOAD_IMGLIB_FN (library, XpmCreateImageFromBuffer);
3268 LOAD_IMGLIB_FN (library, XpmReadFileToImage);
3269 LOAD_IMGLIB_FN (library, XImageFree);
3270 return 1;
3271}
3272
3273#endif /* HAVE_NTGUI */
3274
3275
3276/* Value is non-zero if COLOR_SYMBOLS is a valid color symbols list
3277 for XPM images. Such a list must consist of conses whose car and
3278 cdr are strings. */
3279
3280static int
d3da34e0 3281xpm_valid_color_symbols_p (Lisp_Object color_symbols)
4ef0d4d0
KS
3282{
3283 while (CONSP (color_symbols))
3284 {
3285 Lisp_Object sym = XCAR (color_symbols);
3286 if (!CONSP (sym)
3287 || !STRINGP (XCAR (sym))
3288 || !STRINGP (XCDR (sym)))
3289 break;
3290 color_symbols = XCDR (color_symbols);
3291 }
3292
3293 return NILP (color_symbols);
3294}
3295
3296
3297/* Value is non-zero if OBJECT is a valid XPM image specification. */
3298
3299static int
d3da34e0 3300xpm_image_p (Lisp_Object object)
4ef0d4d0
KS
3301{
3302 struct image_keyword fmt[XPM_LAST];
72af86bd 3303 memcpy (fmt, xpm_format, sizeof fmt);
4ef0d4d0
KS
3304 return (parse_image_spec (object, fmt, XPM_LAST, Qxpm)
3305 /* Either `:file' or `:data' must be present. */
3306 && fmt[XPM_FILE].count + fmt[XPM_DATA].count == 1
3307 /* Either no `:color-symbols' or it's a list of conses
3308 whose car and cdr are strings. */
3309 && (fmt[XPM_COLOR_SYMBOLS].count == 0
3310 || xpm_valid_color_symbols_p (fmt[XPM_COLOR_SYMBOLS].value)));
3311}
3312
9e2a2647 3313#endif /* HAVE_XPM || HAVE_NS */
4ef0d4d0 3314
cd44d2eb 3315#if defined HAVE_XPM && defined HAVE_X_WINDOWS && !defined USE_GTK
786a43d6 3316int
ef1b0ba7 3317x_create_bitmap_from_xpm_data (struct frame *f, const char **bits)
786a43d6
CY
3318{
3319 Display_Info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
3320 int id, rc;
3321 XpmAttributes attrs;
3322 Pixmap bitmap, mask;
3323
72af86bd 3324 memset (&attrs, 0, sizeof attrs);
786a43d6 3325
54188d8f
CY
3326 attrs.visual = FRAME_X_VISUAL (f);
3327 attrs.colormap = FRAME_X_COLORMAP (f);
3328 attrs.valuemask |= XpmVisual;
3329 attrs.valuemask |= XpmColormap;
3330
786a43d6 3331 rc = XpmCreatePixmapFromData (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
f77fabaf 3332 (char **) bits, &bitmap, &mask, &attrs);
786a43d6 3333 if (rc != XpmSuccess)
fe45ad15
CY
3334 {
3335 XpmFreeAttributes (&attrs);
3336 return -1;
3337 }
786a43d6
CY
3338
3339 id = x_allocate_bitmap_record (f);
786a43d6
CY
3340 dpyinfo->bitmaps[id - 1].pixmap = bitmap;
3341 dpyinfo->bitmaps[id - 1].have_mask = 1;
3342 dpyinfo->bitmaps[id - 1].mask = mask;
3343 dpyinfo->bitmaps[id - 1].file = NULL;
3344 dpyinfo->bitmaps[id - 1].height = attrs.height;
3345 dpyinfo->bitmaps[id - 1].width = attrs.width;
3346 dpyinfo->bitmaps[id - 1].depth = attrs.depth;
3347 dpyinfo->bitmaps[id - 1].refcount = 1;
3348
3349 XpmFreeAttributes (&attrs);
3350 return id;
3351}
0d876a14 3352#endif /* defined (HAVE_XPM) && defined (HAVE_X_WINDOWS) */
786a43d6 3353
4ef0d4d0
KS
3354/* Load image IMG which will be displayed on frame F. Value is
3355 non-zero if successful. */
3356
ea1aaa6f
ST
3357#ifdef HAVE_XPM
3358
4ef0d4d0 3359static int
d3da34e0 3360xpm_load (struct frame *f, struct image *img)
4ef0d4d0
KS
3361{
3362 int rc;
3363 XpmAttributes attrs;
3364 Lisp_Object specified_file, color_symbols;
3365#ifdef HAVE_NTGUI
3366 HDC hdc;
3367 xpm_XImage * xpm_image = NULL, * xpm_mask = NULL;
3368#endif /* HAVE_NTGUI */
3369
3370 /* Configure the XPM lib. Use the visual of frame F. Allocate
3371 close colors. Return colors allocated. */
72af86bd 3372 memset (&attrs, 0, sizeof attrs);
4ef0d4d0
KS
3373
3374#ifndef HAVE_NTGUI
3375 attrs.visual = FRAME_X_VISUAL (f);
3376 attrs.colormap = FRAME_X_COLORMAP (f);
3377 attrs.valuemask |= XpmVisual;
3378 attrs.valuemask |= XpmColormap;
3379#endif /* HAVE_NTGUI */
3380
3381#ifdef ALLOC_XPM_COLORS
3382 /* Allocate colors with our own functions which handle
3383 failing color allocation more gracefully. */
3384 attrs.color_closure = f;
3385 attrs.alloc_color = xpm_alloc_color;
3386 attrs.free_colors = xpm_free_colors;
3387 attrs.valuemask |= XpmAllocColor | XpmFreeColors | XpmColorClosure;
3388#else /* not ALLOC_XPM_COLORS */
3389 /* Let the XPM lib allocate colors. */
3390 attrs.valuemask |= XpmReturnAllocPixels;
3391#ifdef XpmAllocCloseColors
3392 attrs.alloc_close_colors = 1;
3393 attrs.valuemask |= XpmAllocCloseColors;
3394#else /* not XpmAllocCloseColors */
3395 attrs.closeness = 600;
3396 attrs.valuemask |= XpmCloseness;
3397#endif /* not XpmAllocCloseColors */
3398#endif /* ALLOC_XPM_COLORS */
3399
3400 /* If image specification contains symbolic color definitions, add
3401 these to `attrs'. */
3402 color_symbols = image_spec_value (img->spec, QCcolor_symbols, NULL);
3403 if (CONSP (color_symbols))
3404 {
3405 Lisp_Object tail;
3406 XpmColorSymbol *xpm_syms;
3407 int i, size;
3408
3409 attrs.valuemask |= XpmColorSymbols;
3410
3411 /* Count number of symbols. */
3412 attrs.numsymbols = 0;
3413 for (tail = color_symbols; CONSP (tail); tail = XCDR (tail))
3414 ++attrs.numsymbols;
3415
3416 /* Allocate an XpmColorSymbol array. */
3417 size = attrs.numsymbols * sizeof *xpm_syms;
3418 xpm_syms = (XpmColorSymbol *) alloca (size);
72af86bd 3419 memset (xpm_syms, 0, size);
4ef0d4d0
KS
3420 attrs.colorsymbols = xpm_syms;
3421
3422 /* Fill the color symbol array. */
3423 for (tail = color_symbols, i = 0;
3424 CONSP (tail);
3425 ++i, tail = XCDR (tail))
3426 {
7574650a
AS
3427 Lisp_Object name;
3428 Lisp_Object color;
e22cffbc 3429 char *empty_string = (char *) "";
7574650a
AS
3430
3431 if (!CONSP (XCAR (tail)))
3432 {
e22cffbc
PE
3433 xpm_syms[i].name = empty_string;
3434 xpm_syms[i].value = empty_string;
7574650a
AS
3435 continue;
3436 }
3437 name = XCAR (XCAR (tail));
3438 color = XCDR (XCAR (tail));
3439 if (STRINGP (name))
3440 {
3441 xpm_syms[i].name = (char *) alloca (SCHARS (name) + 1);
42a5b22f 3442 strcpy (xpm_syms[i].name, SSDATA (name));
7574650a
AS
3443 }
3444 else
e22cffbc 3445 xpm_syms[i].name = empty_string;
7574650a
AS
3446 if (STRINGP (color))
3447 {
3448 xpm_syms[i].value = (char *) alloca (SCHARS (color) + 1);
42a5b22f 3449 strcpy (xpm_syms[i].value, SSDATA (color));
7574650a
AS
3450 }
3451 else
e22cffbc 3452 xpm_syms[i].value = empty_string;
4ef0d4d0
KS
3453 }
3454 }
3455
3456 /* Create a pixmap for the image, either from a file, or from a
3457 string buffer containing data in the same format as an XPM file. */
3458#ifdef ALLOC_XPM_COLORS
3459 xpm_init_color_cache (f, &attrs);
3460#endif
3461
3462 specified_file = image_spec_value (img->spec, QCfile, NULL);
3463
3464#ifdef HAVE_NTGUI
3465 {
3466 HDC frame_dc = get_frame_dc (f);
3467 hdc = CreateCompatibleDC (frame_dc);
3468 release_frame_dc (f, frame_dc);
3469 }
3470#endif /* HAVE_NTGUI */
3471
3472 if (STRINGP (specified_file))
3473 {
3474 Lisp_Object file = x_find_image_file (specified_file);
3475 if (!STRINGP (file))
3476 {
3477 image_error ("Cannot find image file `%s'", specified_file, Qnil);
7574650a
AS
3478#ifdef ALLOC_XPM_COLORS
3479 xpm_free_color_cache ();
3480#endif
4ef0d4d0
KS
3481 return 0;
3482 }
3483
3484#ifdef HAVE_NTGUI
3485 /* XpmReadFileToPixmap is not available in the Windows port of
3486 libxpm. But XpmReadFileToImage almost does what we want. */
3487 rc = fn_XpmReadFileToImage (&hdc, SDATA (file),
3488 &xpm_image, &xpm_mask,
3489 &attrs);
3490#else
3491 rc = XpmReadFileToPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
42a5b22f 3492 SSDATA (file), &img->pixmap, &img->mask,
4ef0d4d0
KS
3493 &attrs);
3494#endif /* HAVE_NTGUI */
3495 }
3496 else
3497 {
3498 Lisp_Object buffer = image_spec_value (img->spec, QCdata, NULL);
7574650a
AS
3499 if (!STRINGP (buffer))
3500 {
3501 image_error ("Invalid image data `%s'", buffer, Qnil);
3502#ifdef ALLOC_XPM_COLORS
3503 xpm_free_color_cache ();
3504#endif
3505 return 0;
3506 }
4ef0d4d0
KS
3507#ifdef HAVE_NTGUI
3508 /* XpmCreatePixmapFromBuffer is not available in the Windows port
3509 of libxpm. But XpmCreateImageFromBuffer almost does what we want. */
3510 rc = fn_XpmCreateImageFromBuffer (&hdc, SDATA (buffer),
3511 &xpm_image, &xpm_mask,
3512 &attrs);
3513#else
3514 rc = XpmCreatePixmapFromBuffer (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
42a5b22f 3515 SSDATA (buffer),
4ef0d4d0
KS
3516 &img->pixmap, &img->mask,
3517 &attrs);
3518#endif /* HAVE_NTGUI */
3519 }
3520
3521 if (rc == XpmSuccess)
3522 {
3523#if defined (COLOR_TABLE_SUPPORT) && defined (ALLOC_XPM_COLORS)
3524 img->colors = colors_in_color_table (&img->ncolors);
3525#else /* not ALLOC_XPM_COLORS */
3526 int i;
3527
3528#ifdef HAVE_NTGUI
3529 /* W32 XPM uses XImage to wrap what W32 Emacs calls a Pixmap,
3530 plus some duplicate attributes. */
3531 if (xpm_image && xpm_image->bitmap)
3532 {
3533 img->pixmap = xpm_image->bitmap;
3534 /* XImageFree in libXpm frees XImage struct without destroying
3535 the bitmap, which is what we want. */
3536 fn_XImageFree (xpm_image);
3537 }
3538 if (xpm_mask && xpm_mask->bitmap)
3539 {
3540 /* The mask appears to be inverted compared with what we expect.
3541 TODO: invert our expectations. See other places where we
3542 have to invert bits because our idea of masks is backwards. */
3543 HGDIOBJ old_obj;
3544 old_obj = SelectObject (hdc, xpm_mask->bitmap);
3545
3546 PatBlt (hdc, 0, 0, xpm_mask->width, xpm_mask->height, DSTINVERT);
3547 SelectObject (hdc, old_obj);
3548
3549 img->mask = xpm_mask->bitmap;
3550 fn_XImageFree (xpm_mask);
3551 DeleteDC (hdc);
3552 }
3553
3554 DeleteDC (hdc);
3555#endif /* HAVE_NTGUI */
3556
3557 /* Remember allocated colors. */
3558 img->ncolors = attrs.nalloc_pixels;
3559 img->colors = (unsigned long *) xmalloc (img->ncolors
3560 * sizeof *img->colors);
3561 for (i = 0; i < attrs.nalloc_pixels; ++i)
3562 {
3563 img->colors[i] = attrs.alloc_pixels[i];
3564#ifdef DEBUG_X_COLORS
3565 register_color (img->colors[i]);
3566#endif
3567 }
3568#endif /* not ALLOC_XPM_COLORS */
3569
3570 img->width = attrs.width;
3571 img->height = attrs.height;
3572 xassert (img->width > 0 && img->height > 0);
3573
3574 /* The call to XpmFreeAttributes below frees attrs.alloc_pixels. */
3575#ifdef HAVE_NTGUI
3576 fn_XpmFreeAttributes (&attrs);
3577#else
3578 XpmFreeAttributes (&attrs);
3579#endif /* HAVE_NTGUI */
3580 }
3581 else
3582 {
3583#ifdef HAVE_NTGUI
3584 DeleteDC (hdc);
3585#endif /* HAVE_NTGUI */
3586
3587 switch (rc)
3588 {
3589 case XpmOpenFailed:
3590 image_error ("Error opening XPM file (%s)", img->spec, Qnil);
3591 break;
3592
3593 case XpmFileInvalid:
3594 image_error ("Invalid XPM file (%s)", img->spec, Qnil);
3595 break;
3596
3597 case XpmNoMemory:
3598 image_error ("Out of memory (%s)", img->spec, Qnil);
3599 break;
3600
3601 case XpmColorFailed:
3602 image_error ("Color allocation error (%s)", img->spec, Qnil);
3603 break;
3604
3605 default:
3606 image_error ("Unknown error (%s)", img->spec, Qnil);
3607 break;
3608 }
3609 }
3610
3611#ifdef ALLOC_XPM_COLORS
3612 xpm_free_color_cache ();
3613#endif
3614 return rc == XpmSuccess;
3615}
3616
3617#endif /* HAVE_XPM */
3618
9e2a2647 3619#if defined (HAVE_NS) && !defined (HAVE_XPM)
ea1aaa6f 3620
9e2a2647 3621/* XPM support functions for NS where libxpm is not available.
ea1aaa6f
ST
3622 Only XPM version 3 (without any extensions) is supported. */
3623
f57e2426
J
3624static int xpm_scan (const unsigned char **, const unsigned char *,
3625 const unsigned char **, int *);
ea1aaa6f 3626static Lisp_Object xpm_make_color_table_v
f57e2426
J
3627 (void (**) (Lisp_Object, const unsigned char *, int, Lisp_Object),
3628 Lisp_Object (**) (Lisp_Object, const unsigned char *, int));
3629static void xpm_put_color_table_v (Lisp_Object, const unsigned char *,
3630 int, Lisp_Object);
3631static Lisp_Object xpm_get_color_table_v (Lisp_Object,
3632 const unsigned char *, int);
ea1aaa6f 3633static Lisp_Object xpm_make_color_table_h
f57e2426
J
3634 (void (**) (Lisp_Object, const unsigned char *, int, Lisp_Object),
3635 Lisp_Object (**) (Lisp_Object, const unsigned char *, int));
3636static void xpm_put_color_table_h (Lisp_Object, const unsigned char *,
3637 int, Lisp_Object);
3638static Lisp_Object xpm_get_color_table_h (Lisp_Object,
3639 const unsigned char *, int);
3640static int xpm_str_to_color_key (const char *);
3641static int xpm_load_image (struct frame *, struct image *,
3642 const unsigned char *, const unsigned char *);
ea1aaa6f
ST
3643
3644/* Tokens returned from xpm_scan. */
3645
3646enum xpm_token
3647{
3648 XPM_TK_IDENT = 256,
3649 XPM_TK_STRING,
3650 XPM_TK_EOF
3651};
3652
3653/* Scan an XPM data and return a character (< 256) or a token defined
3654 by enum xpm_token above. *S and END are the start (inclusive) and
3655 the end (exclusive) addresses of the data, respectively. Advance
3656 *S while scanning. If token is either XPM_TK_IDENT or
3657 XPM_TK_STRING, *BEG and *LEN are set to the start address and the
3658 length of the corresponding token, respectively. */
3659
3660static int
3d608a86
J
3661xpm_scan (const unsigned char **s,
3662 const unsigned char *end,
3663 const unsigned char **beg,
3664 int *len)
ea1aaa6f
ST
3665{
3666 int c;
3667
3668 while (*s < end)
3669 {
3670 /* Skip white-space. */
3671 while (*s < end && (c = *(*s)++, isspace (c)))
9ecf6403 3672 ;
ea1aaa6f
ST
3673
3674 /* gnus-pointer.xpm uses '-' in its identifier.
9ecf6403 3675 sb-dir-plus.xpm uses '+' in its identifier. */
ea1aaa6f 3676 if (isalpha (c) || c == '_' || c == '-' || c == '+')
9ecf6403
YM
3677 {
3678 *beg = *s - 1;
2ff0845e
YM
3679 while (*s < end
3680 && (c = **s, isalnum (c) || c == '_' || c == '-' || c == '+'))
9ecf6403
YM
3681 ++*s;
3682 *len = *s - *beg;
3683 return XPM_TK_IDENT;
3684 }
ea1aaa6f 3685 else if (c == '"')
9ecf6403
YM
3686 {
3687 *beg = *s;
3688 while (*s < end && **s != '"')
3689 ++*s;
3690 *len = *s - *beg;
3691 if (*s < end)
3692 ++*s;
3693 return XPM_TK_STRING;
3694 }
ea1aaa6f 3695 else if (c == '/')
9ecf6403
YM
3696 {
3697 if (*s < end && **s == '*')
3698 {
3699 /* C-style comment. */
3700 ++*s;
3701 do
3702 {
3703 while (*s < end && *(*s)++ != '*')
3704 ;
3705 }
3706 while (*s < end && **s != '/');
3707 if (*s < end)
3708 ++*s;
3709 }
3710 else
3711 return c;
3712 }
ea1aaa6f 3713 else
9ecf6403 3714 return c;
ea1aaa6f
ST
3715 }
3716
3717 return XPM_TK_EOF;
3718}
3719
bbe6f2aa 3720/* Functions for color table lookup in XPM data. A key is a string
ea1aaa6f
ST
3721 specifying the color of each pixel in XPM data. A value is either
3722 an integer that specifies a pixel color, Qt that specifies
3723 transparency, or Qnil for the unspecified color. If the length of
3724 the key string is one, a vector is used as a table. Otherwise, a
3725 hash table is used. */
3726
3727static Lisp_Object
3d608a86
J
3728xpm_make_color_table_v (void (**put_func) (Lisp_Object,
3729 const unsigned char *,
3730 int,
3731 Lisp_Object),
3732 Lisp_Object (**get_func) (Lisp_Object,
3733 const unsigned char *,
3734 int))
ea1aaa6f
ST
3735{
3736 *put_func = xpm_put_color_table_v;
3737 *get_func = xpm_get_color_table_v;
3738 return Fmake_vector (make_number (256), Qnil);
3739}
3740
3741static void
3d608a86
J
3742xpm_put_color_table_v (Lisp_Object color_table,
3743 const unsigned char *chars_start,
3744 int chars_len,
3745 Lisp_Object color)
ea1aaa6f
ST
3746{
3747 XVECTOR (color_table)->contents[*chars_start] = color;
3748}
3749
3750static Lisp_Object
3d608a86
J
3751xpm_get_color_table_v (Lisp_Object color_table,
3752 const unsigned char *chars_start,
3753 int chars_len)
ea1aaa6f
ST
3754{
3755 return XVECTOR (color_table)->contents[*chars_start];
3756}
3757
3758static Lisp_Object
3d608a86
J
3759xpm_make_color_table_h (void (**put_func) (Lisp_Object,
3760 const unsigned char *,
3761 int,
3762 Lisp_Object),
3763 Lisp_Object (**get_func) (Lisp_Object,
3764 const unsigned char *,
3765 int))
ea1aaa6f
ST
3766{
3767 *put_func = xpm_put_color_table_h;
3768 *get_func = xpm_get_color_table_h;
3769 return make_hash_table (Qequal, make_number (DEFAULT_HASH_SIZE),
9ecf6403
YM
3770 make_float (DEFAULT_REHASH_SIZE),
3771 make_float (DEFAULT_REHASH_THRESHOLD),
3772 Qnil, Qnil, Qnil);
ea1aaa6f
ST
3773}
3774
3775static void
3d608a86
J
3776xpm_put_color_table_h (Lisp_Object color_table,
3777 const unsigned char *chars_start,
3778 int chars_len,
3779 Lisp_Object color)
ea1aaa6f
ST
3780{
3781 struct Lisp_Hash_Table *table = XHASH_TABLE (color_table);
3782 unsigned hash_code;
3783 Lisp_Object chars = make_unibyte_string (chars_start, chars_len);
3784
3785 hash_lookup (table, chars, &hash_code);
3786 hash_put (table, chars, color, hash_code);
3787}
3788
3789static Lisp_Object
3d608a86
J
3790xpm_get_color_table_h (Lisp_Object color_table,
3791 const unsigned char *chars_start,
3792 int chars_len)
ea1aaa6f
ST
3793{
3794 struct Lisp_Hash_Table *table = XHASH_TABLE (color_table);
3795 int i = hash_lookup (table, make_unibyte_string (chars_start, chars_len),
9ecf6403 3796 NULL);
ea1aaa6f
ST
3797
3798 return i >= 0 ? HASH_VALUE (table, i) : Qnil;
3799}
3800
3801enum xpm_color_key {
3802 XPM_COLOR_KEY_S,
3803 XPM_COLOR_KEY_M,
3804 XPM_COLOR_KEY_G4,
3805 XPM_COLOR_KEY_G,
3806 XPM_COLOR_KEY_C
3807};
3808
46accb8f 3809static const char xpm_color_key_strings[][4] = {"s", "m", "g4", "g", "c"};
ea1aaa6f
ST
3810
3811static int
3d608a86 3812xpm_str_to_color_key (const char *s)
ea1aaa6f
ST
3813{
3814 int i;
3815
3816 for (i = 0;
3817 i < sizeof xpm_color_key_strings / sizeof xpm_color_key_strings[0];
3818 i++)
3819 if (strcmp (xpm_color_key_strings[i], s) == 0)
3820 return i;
3821 return -1;
3822}
3823
3824static int
3d608a86
J
3825xpm_load_image (struct frame *f,
3826 struct image *img,
3827 const unsigned char *contents,
3828 const unsigned char *end)
ea1aaa6f 3829{
46accb8f 3830 const unsigned char *s = contents, *beg, *str;
ea1aaa6f
ST
3831 unsigned char buffer[BUFSIZ];
3832 int width, height, x, y;
3833 int num_colors, chars_per_pixel;
3834 int len, LA1;
46accb8f
YM
3835 void (*put_color_table) (Lisp_Object, const unsigned char *, int, Lisp_Object);
3836 Lisp_Object (*get_color_table) (Lisp_Object, const unsigned char *, int);
ea1aaa6f
ST
3837 Lisp_Object frame, color_symbols, color_table;
3838 int best_key, have_mask = 0;
3839 XImagePtr ximg = NULL, mask_img = NULL;
3840
3841#define match() \
3842 LA1 = xpm_scan (&s, end, &beg, &len)
3843
9ecf6403
YM
3844#define expect(TOKEN) \
3845 if (LA1 != (TOKEN)) \
3846 goto failure; \
3847 else \
ea1aaa6f
ST
3848 match ()
3849
9ecf6403 3850#define expect_ident(IDENT) \
ea1aaa6f 3851 if (LA1 == XPM_TK_IDENT \
9ecf6403
YM
3852 && strlen ((IDENT)) == len && memcmp ((IDENT), beg, len) == 0) \
3853 match (); \
3854 else \
ea1aaa6f
ST
3855 goto failure
3856
3857 if (!(end - s >= 9 && memcmp (s, "/* XPM */", 9) == 0))
3858 goto failure;
3859 s += 9;
ed3751c8 3860 match ();
ea1aaa6f
ST
3861 expect_ident ("static");
3862 expect_ident ("char");
3863 expect ('*');
3864 expect (XPM_TK_IDENT);
3865 expect ('[');
3866 expect (']');
3867 expect ('=');
3868 expect ('{');
3869 expect (XPM_TK_STRING);
3870 if (len >= BUFSIZ)
3871 goto failure;
3872 memcpy (buffer, beg, len);
3873 buffer[len] = '\0';
3874 if (sscanf (buffer, "%d %d %d %d", &width, &height,
9ecf6403 3875 &num_colors, &chars_per_pixel) != 4
ea1aaa6f
ST
3876 || width <= 0 || height <= 0
3877 || num_colors <= 0 || chars_per_pixel <= 0)
3878 goto failure;
de297941
YM
3879
3880 if (!check_image_size (f, width, height))
3881 {
10ea2b82 3882 image_error ("Invalid image size (see `max-image-size')", Qnil, Qnil);
de297941
YM
3883 goto failure;
3884 }
3885
ea1aaa6f
ST
3886 expect (',');
3887
3888 XSETFRAME (frame, f);
3889 if (!NILP (Fxw_display_color_p (frame)))
3890 best_key = XPM_COLOR_KEY_C;
3891 else if (!NILP (Fx_display_grayscale_p (frame)))
3892 best_key = (XFASTINT (Fx_display_planes (frame)) > 2
9ecf6403 3893 ? XPM_COLOR_KEY_G : XPM_COLOR_KEY_G4);
ea1aaa6f
ST
3894 else
3895 best_key = XPM_COLOR_KEY_M;
3896
3897 color_symbols = image_spec_value (img->spec, QCcolor_symbols, NULL);
3898 if (chars_per_pixel == 1)
3899 color_table = xpm_make_color_table_v (&put_color_table,
9ecf6403 3900 &get_color_table);
ea1aaa6f
ST
3901 else
3902 color_table = xpm_make_color_table_h (&put_color_table,
9ecf6403 3903 &get_color_table);
ea1aaa6f
ST
3904
3905 while (num_colors-- > 0)
3906 {
25a48bd0 3907 char *color, *max_color;
ea1aaa6f
ST
3908 int key, next_key, max_key = 0;
3909 Lisp_Object symbol_color = Qnil, color_val;
3910 XColor cdef;
3911
3912 expect (XPM_TK_STRING);
3913 if (len <= chars_per_pixel || len >= BUFSIZ + chars_per_pixel)
9ecf6403 3914 goto failure;
ea1aaa6f
ST
3915 memcpy (buffer, beg + chars_per_pixel, len - chars_per_pixel);
3916 buffer[len - chars_per_pixel] = '\0';
3917
3918 str = strtok (buffer, " \t");
3919 if (str == NULL)
9ecf6403 3920 goto failure;
ea1aaa6f
ST
3921 key = xpm_str_to_color_key (str);
3922 if (key < 0)
9ecf6403 3923 goto failure;
ea1aaa6f 3924 do
9ecf6403
YM
3925 {
3926 color = strtok (NULL, " \t");
3927 if (color == NULL)
3928 goto failure;
ea1aaa6f 3929
9db94f82 3930 while ((str = strtok (NULL, " \t")) != NULL)
9ecf6403
YM
3931 {
3932 next_key = xpm_str_to_color_key (str);
3933 if (next_key >= 0)
3934 break;
3935 color[strlen (color)] = ' ';
3936 }
ea1aaa6f 3937
9ecf6403
YM
3938 if (key == XPM_COLOR_KEY_S)
3939 {
3940 if (NILP (symbol_color))
3941 symbol_color = build_string (color);
3942 }
3943 else if (max_key < key && key <= best_key)
3944 {
3945 max_key = key;
3946 max_color = color;
3947 }
3948 key = next_key;
3949 }
ea1aaa6f
ST
3950 while (str);
3951
3952 color_val = Qnil;
3953 if (!NILP (color_symbols) && !NILP (symbol_color))
9ecf6403
YM
3954 {
3955 Lisp_Object specified_color = Fassoc (symbol_color, color_symbols);
3956
3957 if (CONSP (specified_color) && STRINGP (XCDR (specified_color)))
9db94f82 3958 {
25a48bd0 3959 if (xstrcasecmp (SSDATA (XCDR (specified_color)), "None") == 0)
9db94f82
YM
3960 color_val = Qt;
3961 else if (x_defined_color (f, SDATA (XCDR (specified_color)),
3962 &cdef, 0))
3963 color_val = make_number (cdef.pixel);
3964 }
9ecf6403 3965 }
ea1aaa6f 3966 if (NILP (color_val) && max_key > 0)
9db94f82 3967 {
05131107 3968 if (xstrcasecmp (max_color, "None") == 0)
9db94f82
YM
3969 color_val = Qt;
3970 else if (x_defined_color (f, max_color, &cdef, 0))
3971 color_val = make_number (cdef.pixel);
3972 }
ea1aaa6f 3973 if (!NILP (color_val))
9ecf6403 3974 (*put_color_table) (color_table, beg, chars_per_pixel, color_val);
ea1aaa6f
ST
3975
3976 expect (',');
3977 }
3978
3979 if (!x_create_x_image_and_pixmap (f, width, height, 0,
9ecf6403 3980 &ximg, &img->pixmap)
edfda783 3981#ifndef HAVE_NS
ea1aaa6f 3982 || !x_create_x_image_and_pixmap (f, width, height, 1,
edfda783
AR
3983 &mask_img, &img->mask)
3984#endif
3985 )
ea1aaa6f
ST
3986 {
3987 image_error ("Out of memory (%s)", img->spec, Qnil);
3988 goto error;
3989 }
3990
3991 for (y = 0; y < height; y++)
3992 {
3993 expect (XPM_TK_STRING);
3994 str = beg;
3995 if (len < width * chars_per_pixel)
9ecf6403 3996 goto failure;
ea1aaa6f 3997 for (x = 0; x < width; x++, str += chars_per_pixel)
9ecf6403
YM
3998 {
3999 Lisp_Object color_val =
4000 (*get_color_table) (color_table, str, chars_per_pixel);
4001
4002 XPutPixel (ximg, x, y,
4003 (INTEGERP (color_val) ? XINT (color_val)
4004 : FRAME_FOREGROUND_PIXEL (f)));
edfda783 4005#ifndef HAVE_NS
9ecf6403
YM
4006 XPutPixel (mask_img, x, y,
4007 (!EQ (color_val, Qt) ? PIX_MASK_DRAW
4008 : (have_mask = 1, PIX_MASK_RETAIN)));
edfda783 4009#else
ed3751c8
JB
4010 if (EQ (color_val, Qt))
4011 ns_set_alpha (ximg, x, y, 0);
edfda783 4012#endif
9ecf6403 4013 }
ea1aaa6f 4014 if (y + 1 < height)
9ecf6403 4015 expect (',');
ea1aaa6f
ST
4016 }
4017
4018 img->width = width;
4019 img->height = height;
4020
0b8ac842
YM
4021 /* Maybe fill in the background field while we have ximg handy. */
4022 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
4023 IMAGE_BACKGROUND (img, f, ximg);
4024
ea1aaa6f
ST
4025 x_put_x_image (f, ximg, img->pixmap, width, height);
4026 x_destroy_x_image (ximg);
edfda783 4027#ifndef HAVE_NS
ea1aaa6f
ST
4028 if (have_mask)
4029 {
9ecf6403
YM
4030 /* Fill in the background_transparent field while we have the
4031 mask handy. */
4032 image_background_transparent (img, f, mask_img);
4033
ea1aaa6f
ST
4034 x_put_x_image (f, mask_img, img->mask, width, height);
4035 x_destroy_x_image (mask_img);
4036 }
4037 else
4038 {
4039 x_destroy_x_image (mask_img);
4040 Free_Pixmap (FRAME_X_DISPLAY (f), img->mask);
4041 img->mask = NO_PIXMAP;
4042 }
edfda783 4043#endif
ea1aaa6f
ST
4044 return 1;
4045
4046 failure:
4047 image_error ("Invalid XPM file (%s)", img->spec, Qnil);
4048 error:
4049 x_destroy_x_image (ximg);
4050 x_destroy_x_image (mask_img);
4051 x_clear_image (f, img);
4052 return 0;
4053
4054#undef match
4055#undef expect
4056#undef expect_ident
4057}
4058
4059static int
3d608a86
J
4060xpm_load (struct frame *f,
4061 struct image *img)
ea1aaa6f
ST
4062{
4063 int success_p = 0;
4064 Lisp_Object file_name;
4065
4066 /* If IMG->spec specifies a file name, create a non-file spec from it. */
4067 file_name = image_spec_value (img->spec, QCfile, NULL);
4068 if (STRINGP (file_name))
4069 {
4070 Lisp_Object file;
4071 unsigned char *contents;
4072 int size;
ea1aaa6f
ST
4073
4074 file = x_find_image_file (file_name);
ea1aaa6f 4075 if (!STRINGP (file))
9ecf6403
YM
4076 {
4077 image_error ("Cannot find image file `%s'", file_name, Qnil);
9ecf6403
YM
4078 return 0;
4079 }
ea1aaa6f
ST
4080
4081 contents = slurp_file (SDATA (file), &size);
4082 if (contents == NULL)
9ecf6403
YM
4083 {
4084 image_error ("Error loading XPM image `%s'", img->spec, Qnil);
9ecf6403
YM
4085 return 0;
4086 }
ea1aaa6f
ST
4087
4088 success_p = xpm_load_image (f, img, contents, contents + size);
4089 xfree (contents);
ea1aaa6f
ST
4090 }
4091 else
4092 {
4093 Lisp_Object data;
4094
4095 data = image_spec_value (img->spec, QCdata, NULL);
7574650a
AS
4096 if (!STRINGP (data))
4097 {
4098 image_error ("Invalid image data `%s'", data, Qnil);
4099 return 0;
4100 }
ea1aaa6f 4101 success_p = xpm_load_image (f, img, SDATA (data),
9ecf6403 4102 SDATA (data) + SBYTES (data));
ea1aaa6f
ST
4103 }
4104
4105 return success_p;
4106}
4107
9e2a2647 4108#endif /* HAVE_NS && !HAVE_XPM */
b0da69a7 4109
ea1aaa6f 4110
4ef0d4d0
KS
4111\f
4112/***********************************************************************
4113 Color table
4114 ***********************************************************************/
4115
4116#ifdef COLOR_TABLE_SUPPORT
4117
4118/* An entry in the color table mapping an RGB color to a pixel color. */
4119
4120struct ct_color
4121{
4122 int r, g, b;
4123 unsigned long pixel;
4124
4125 /* Next in color table collision list. */
4126 struct ct_color *next;
4127};
4128
4129/* The bucket vector size to use. Must be prime. */
4130
4131#define CT_SIZE 101
4132
4133/* Value is a hash of the RGB color given by R, G, and B. */
4134
4135#define CT_HASH_RGB(R, G, B) (((R) << 16) ^ ((G) << 8) ^ (B))
4136
4137/* The color hash table. */
4138
cd44d2eb 4139static struct ct_color **ct_table;
4ef0d4d0
KS
4140
4141/* Number of entries in the color table. */
4142
cd44d2eb 4143static int ct_colors_allocated;
4ef0d4d0
KS
4144
4145/* Initialize the color table. */
4146
4147static void
d3da34e0 4148init_color_table (void)
4ef0d4d0
KS
4149{
4150 int size = CT_SIZE * sizeof (*ct_table);
4151 ct_table = (struct ct_color **) xmalloc (size);
72af86bd 4152 memset (ct_table, 0, size);
4ef0d4d0
KS
4153 ct_colors_allocated = 0;
4154}
4155
4156
4157/* Free memory associated with the color table. */
4158
4159static void
d3da34e0 4160free_color_table (void)
4ef0d4d0
KS
4161{
4162 int i;
4163 struct ct_color *p, *next;
4164
4165 for (i = 0; i < CT_SIZE; ++i)
4166 for (p = ct_table[i]; p; p = next)
4167 {
4168 next = p->next;
4169 xfree (p);
4170 }
4171
4172 xfree (ct_table);
4173 ct_table = NULL;
4174}
4175
4176
4177/* Value is a pixel color for RGB color R, G, B on frame F. If an
4178 entry for that color already is in the color table, return the
4179 pixel color of that entry. Otherwise, allocate a new color for R,
4180 G, B, and make an entry in the color table. */
4181
4182static unsigned long
d3da34e0 4183lookup_rgb_color (struct frame *f, int r, int g, int b)
4ef0d4d0
KS
4184{
4185 unsigned hash = CT_HASH_RGB (r, g, b);
4186 int i = hash % CT_SIZE;
4187 struct ct_color *p;
4188 Display_Info *dpyinfo;
4189
4190 /* Handle TrueColor visuals specially, which improves performance by
4191 two orders of magnitude. Freeing colors on TrueColor visuals is
4192 a nop, and pixel colors specify RGB values directly. See also
4193 the Xlib spec, chapter 3.1. */
4194 dpyinfo = FRAME_X_DISPLAY_INFO (f);
4195 if (dpyinfo->red_bits > 0)
4196 {
4197 unsigned long pr, pg, pb;
4198
4199 /* Apply gamma-correction like normal color allocation does. */
4200 if (f->gamma)
4201 {
4202 XColor color;
4203 color.red = r, color.green = g, color.blue = b;
4204 gamma_correct (f, &color);
4205 r = color.red, g = color.green, b = color.blue;
4206 }
4207
4208 /* Scale down RGB values to the visual's bits per RGB, and shift
4209 them to the right position in the pixel color. Note that the
4210 original RGB values are 16-bit values, as usual in X. */
4211 pr = (r >> (16 - dpyinfo->red_bits)) << dpyinfo->red_offset;
4212 pg = (g >> (16 - dpyinfo->green_bits)) << dpyinfo->green_offset;
4213 pb = (b >> (16 - dpyinfo->blue_bits)) << dpyinfo->blue_offset;
4214
4215 /* Assemble the pixel color. */
4216 return pr | pg | pb;
4217 }
1f026899 4218
4ef0d4d0
KS
4219 for (p = ct_table[i]; p; p = p->next)
4220 if (p->r == r && p->g == g && p->b == b)
4221 break;
4222
4223 if (p == NULL)
4224 {
4225
4226#ifdef HAVE_X_WINDOWS
4227 XColor color;
4228 Colormap cmap;
4229 int rc;
4230
4231 color.red = r;
4232 color.green = g;
4233 color.blue = b;
4234
4235 cmap = FRAME_X_COLORMAP (f);
4236 rc = x_alloc_nearest_color (f, cmap, &color);
4237 if (rc)
4238 {
4239 ++ct_colors_allocated;
4240 p = (struct ct_color *) xmalloc (sizeof *p);
4241 p->r = r;
4242 p->g = g;
4243 p->b = b;
4244 p->pixel = color.pixel;
4245 p->next = ct_table[i];
4246 ct_table[i] = p;
4247 }
4248 else
4249 return FRAME_FOREGROUND_PIXEL (f);
4250
4251#else
4252 COLORREF color;
4253#ifdef HAVE_NTGUI
4254 color = PALETTERGB (r, g, b);
4255#else
4256 color = RGB_TO_ULONG (r, g, b);
4257#endif /* HAVE_NTGUI */
4258 ++ct_colors_allocated;
4259 p = (struct ct_color *) xmalloc (sizeof *p);
4260 p->r = r;
4261 p->g = g;
4262 p->b = b;
4263 p->pixel = color;
4264 p->next = ct_table[i];
4265 ct_table[i] = p;
4266#endif /* HAVE_X_WINDOWS */
4267
4268 }
4269
4270 return p->pixel;
4271}
4272
4273
4274/* Look up pixel color PIXEL which is used on frame F in the color
4275 table. If not already present, allocate it. Value is PIXEL. */
4276
4277static unsigned long
d3da34e0 4278lookup_pixel_color (struct frame *f, unsigned long pixel)
4ef0d4d0
KS
4279{
4280 int i = pixel % CT_SIZE;
4281 struct ct_color *p;
4282
4283 for (p = ct_table[i]; p; p = p->next)
4284 if (p->pixel == pixel)
4285 break;
4286
4287 if (p == NULL)
4288 {
4289 XColor color;
4290 Colormap cmap;
4291 int rc;
4292
4293#ifdef HAVE_X_WINDOWS
4294 cmap = FRAME_X_COLORMAP (f);
4295 color.pixel = pixel;
4296 x_query_color (f, &color);
4297 rc = x_alloc_nearest_color (f, cmap, &color);
4298#else
4299 BLOCK_INPUT;
4300 cmap = DefaultColormapOfScreen (FRAME_X_SCREEN (f));
4301 color.pixel = pixel;
4302 XQueryColor (NULL, cmap, &color);
4303 rc = x_alloc_nearest_color (f, cmap, &color);
4304 UNBLOCK_INPUT;
4305#endif /* HAVE_X_WINDOWS */
4306
4307 if (rc)
4308 {
4309 ++ct_colors_allocated;
4310
4311 p = (struct ct_color *) xmalloc (sizeof *p);
4312 p->r = color.red;
4313 p->g = color.green;
4314 p->b = color.blue;
4315 p->pixel = pixel;
4316 p->next = ct_table[i];
4317 ct_table[i] = p;
4318 }
4319 else
4320 return FRAME_FOREGROUND_PIXEL (f);
4321 }
4322 return p->pixel;
4323}
4324
4325
4326/* Value is a vector of all pixel colors contained in the color table,
4327 allocated via xmalloc. Set *N to the number of colors. */
4328
4329static unsigned long *
d3da34e0 4330colors_in_color_table (int *n)
4ef0d4d0
KS
4331{
4332 int i, j;
4333 struct ct_color *p;
4334 unsigned long *colors;
4335
4336 if (ct_colors_allocated == 0)
4337 {
4338 *n = 0;
4339 colors = NULL;
4340 }
4341 else
4342 {
4343 colors = (unsigned long *) xmalloc (ct_colors_allocated
4344 * sizeof *colors);
4345 *n = ct_colors_allocated;
4346
4347 for (i = j = 0; i < CT_SIZE; ++i)
4348 for (p = ct_table[i]; p; p = p->next)
4349 colors[j++] = p->pixel;
4350 }
4351
4352 return colors;
4353}
4354
4355#else /* COLOR_TABLE_SUPPORT */
4356
4357static unsigned long
7c3320d8 4358lookup_rgb_color (struct frame *f, int r, int g, int b)
4ef0d4d0
KS
4359{
4360 unsigned long pixel;
4361
4ef0d4d0
KS
4362#ifdef HAVE_NTGUI
4363 pixel = PALETTERGB (r >> 8, g >> 8, b >> 8);
4364#endif /* HAVE_NTGUI */
4365
edfda783
AR
4366#ifdef HAVE_NS
4367 pixel = RGB_TO_ULONG (r >> 8, g >> 8, b >> 8);
4368#endif /* HAVE_NS */
4ef0d4d0
KS
4369 return pixel;
4370}
4371
4372static void
7c3320d8 4373init_color_table (void)
4ef0d4d0
KS
4374{
4375}
4376#endif /* COLOR_TABLE_SUPPORT */
4377
4378\f
4379/***********************************************************************
4380 Algorithms
4381 ***********************************************************************/
4382
f57e2426
J
4383static XColor *x_to_xcolors (struct frame *, struct image *, int);
4384static void x_from_xcolors (struct frame *, struct image *, XColor *);
4385static void x_detect_edges (struct frame *, struct image *, int[9], int);
4ef0d4d0
KS
4386
4387#ifdef HAVE_NTGUI
4388static void XPutPixel (XImagePtr , int, int, COLORREF);
4389#endif /* HAVE_NTGUI */
4390
4ef0d4d0
KS
4391/* Edge detection matrices for different edge-detection
4392 strategies. */
4393
4394static int emboss_matrix[9] = {
4395 /* x - 1 x x + 1 */
4396 2, -1, 0, /* y - 1 */
4397 -1, 0, 1, /* y */
4398 0, 1, -2 /* y + 1 */
4399};
4400
4401static int laplace_matrix[9] = {
4402 /* x - 1 x x + 1 */
4403 1, 0, 0, /* y - 1 */
4404 0, 0, 0, /* y */
4405 0, 0, -1 /* y + 1 */
4406};
4407
4408/* Value is the intensity of the color whose red/green/blue values
4409 are R, G, and B. */
4410
4411#define COLOR_INTENSITY(R, G, B) ((2 * (R) + 3 * (G) + (B)) / 6)
4412
4413
4414/* On frame F, return an array of XColor structures describing image
4415 IMG->pixmap. Each XColor structure has its pixel color set. RGB_P
4416 non-zero means also fill the red/green/blue members of the XColor
4417 structures. Value is a pointer to the array of XColors structures,
4418 allocated with xmalloc; it must be freed by the caller. */
4419
4420static XColor *
d3da34e0 4421x_to_xcolors (struct frame *f, struct image *img, int rgb_p)
4ef0d4d0
KS
4422{
4423 int x, y;
4424 XColor *colors, *p;
4425 XImagePtr_or_DC ximg;
4426#ifdef HAVE_NTGUI
4427 HDC hdc;
4428 HGDIOBJ prev;
4429#endif /* HAVE_NTGUI */
4430
4431 colors = (XColor *) xmalloc (img->width * img->height * sizeof *colors);
4432
4433#ifndef HAVE_NTGUI
4434 /* Get the X image IMG->pixmap. */
4435 ximg = XGetImage (FRAME_X_DISPLAY (f), img->pixmap,
4436 0, 0, img->width, img->height, ~0, ZPixmap);
4437#else
4438 /* Load the image into a memory device context. */
4439 hdc = get_frame_dc (f);
4440 ximg = CreateCompatibleDC (hdc);
4441 release_frame_dc (f, hdc);
4442 prev = SelectObject (ximg, img->pixmap);
4443#endif /* HAVE_NTGUI */
4444
4445 /* Fill the `pixel' members of the XColor array. I wished there
4446 were an easy and portable way to circumvent XGetPixel. */
4447 p = colors;
4448 for (y = 0; y < img->height; ++y)
4449 {
4450 XColor *row = p;
4451
8b7d0a16 4452#if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI)
4ef0d4d0 4453 for (x = 0; x < img->width; ++x, ++p)
8b7d0a16 4454 p->pixel = GET_PIXEL (ximg, x, y);
4ef0d4d0
KS
4455 if (rgb_p)
4456 x_query_colors (f, row, img->width);
4457
4458#else
4459
4460 for (x = 0; x < img->width; ++x, ++p)
4461 {
4462 /* W32_TODO: palette support needed here? */
4463 p->pixel = GET_PIXEL (ximg, x, y);
4464 if (rgb_p)
4465 {
4ef0d4d0
KS
4466 p->red = RED16_FROM_ULONG (p->pixel);
4467 p->green = GREEN16_FROM_ULONG (p->pixel);
4468 p->blue = BLUE16_FROM_ULONG (p->pixel);
4ef0d4d0
KS
4469 }
4470 }
4471#endif /* HAVE_X_WINDOWS */
4472 }
4473
4474 Destroy_Image (ximg, prev);
4475
4476 return colors;
4477}
4478
4479#ifdef HAVE_NTGUI
4480
4481/* Put a pixel of COLOR at position X, Y in XIMG. XIMG must have been
4482 created with CreateDIBSection, with the pointer to the bit values
4483 stored in ximg->data. */
4484
3046a84b 4485static void
7c3320d8 4486XPutPixel (XImagePtr ximg, int x, int y, COLORREF color)
4ef0d4d0
KS
4487{
4488 int width = ximg->info.bmiHeader.biWidth;
4ef0d4d0
KS
4489 unsigned char * pixel;
4490
4491 /* True color images. */
4492 if (ximg->info.bmiHeader.biBitCount == 24)
4493 {
4494 int rowbytes = width * 3;
4495 /* Ensure scanlines are aligned on 4 byte boundaries. */
4496 if (rowbytes % 4)
4497 rowbytes += 4 - (rowbytes % 4);
4498
4499 pixel = ximg->data + y * rowbytes + x * 3;
4500 /* Windows bitmaps are in BGR order. */
4501 *pixel = GetBValue (color);
4502 *(pixel + 1) = GetGValue (color);
4503 *(pixel + 2) = GetRValue (color);
4504 }
4505 /* Monochrome images. */
4506 else if (ximg->info.bmiHeader.biBitCount == 1)
4507 {
4508 int rowbytes = width / 8;
4509 /* Ensure scanlines are aligned on 4 byte boundaries. */
4510 if (rowbytes % 4)
4511 rowbytes += 4 - (rowbytes % 4);
4512 pixel = ximg->data + y * rowbytes + x / 8;
4513 /* Filter out palette info. */
4514 if (color & 0x00ffffff)
4515 *pixel = *pixel | (1 << x % 8);
4516 else
4517 *pixel = *pixel & ~(1 << x % 8);
4518 }
4519 else
4520 image_error ("XPutPixel: palette image not supported", Qnil, Qnil);
4521}
4522
4523#endif /* HAVE_NTGUI */
4524
4525/* Create IMG->pixmap from an array COLORS of XColor structures, whose
4526 RGB members are set. F is the frame on which this all happens.
4527 COLORS will be freed; an existing IMG->pixmap will be freed, too. */
4528
4529static void
d3da34e0 4530x_from_xcolors (struct frame *f, struct image *img, XColor *colors)
4ef0d4d0
KS
4531{
4532 int x, y;
edfda783 4533 XImagePtr oimg = NULL;
9d7112ed 4534 Pixmap pixmap;
4ef0d4d0
KS
4535 XColor *p;
4536
4537 init_color_table ();
4538
4539 x_create_x_image_and_pixmap (f, img->width, img->height, 0,
4540 &oimg, &pixmap);
4541 p = colors;
4542 for (y = 0; y < img->height; ++y)
4543 for (x = 0; x < img->width; ++x, ++p)
4544 {
4545 unsigned long pixel;
4546 pixel = lookup_rgb_color (f, p->red, p->green, p->blue);
4547 XPutPixel (oimg, x, y, pixel);
4548 }
4549
4550 xfree (colors);
4551 x_clear_image_1 (f, img, 1, 0, 1);
4552
4553 x_put_x_image (f, oimg, pixmap, img->width, img->height);
4554 x_destroy_x_image (oimg);
4555 img->pixmap = pixmap;
4556#ifdef COLOR_TABLE_SUPPORT
4557 img->colors = colors_in_color_table (&img->ncolors);
4558 free_color_table ();
4559#endif /* COLOR_TABLE_SUPPORT */
4560}
4561
4562
4563/* On frame F, perform edge-detection on image IMG.
4564
4565 MATRIX is a nine-element array specifying the transformation
4566 matrix. See emboss_matrix for an example.
4567
4568 COLOR_ADJUST is a color adjustment added to each pixel of the
4569 outgoing image. */
4570
4571static void
d3da34e0 4572x_detect_edges (struct frame *f, struct image *img, int *matrix, int color_adjust)
4ef0d4d0
KS
4573{
4574 XColor *colors = x_to_xcolors (f, img, 1);
4575 XColor *new, *p;
4576 int x, y, i, sum;
4577
4578 for (i = sum = 0; i < 9; ++i)
1ea40aa2 4579 sum += eabs (matrix[i]);
4ef0d4d0
KS
4580
4581#define COLOR(A, X, Y) ((A) + (Y) * img->width + (X))
4582
4583 new = (XColor *) xmalloc (img->width * img->height * sizeof *new);
4584
4585 for (y = 0; y < img->height; ++y)
4586 {
4587 p = COLOR (new, 0, y);
4588 p->red = p->green = p->blue = 0xffff/2;
4589 p = COLOR (new, img->width - 1, y);
4590 p->red = p->green = p->blue = 0xffff/2;
4591 }
4592
4593 for (x = 1; x < img->width - 1; ++x)
4594 {
4595 p = COLOR (new, x, 0);
4596 p->red = p->green = p->blue = 0xffff/2;
4597 p = COLOR (new, x, img->height - 1);
4598 p->red = p->green = p->blue = 0xffff/2;
4599 }
4600
4601 for (y = 1; y < img->height - 1; ++y)
4602 {
4603 p = COLOR (new, 1, y);
4604
4605 for (x = 1; x < img->width - 1; ++x, ++p)
4606 {
6ae141d6 4607 int r, g, b, yy, xx;
4ef0d4d0
KS
4608
4609 r = g = b = i = 0;
6ae141d6
PE
4610 for (yy = y - 1; yy < y + 2; ++yy)
4611 for (xx = x - 1; xx < x + 2; ++xx, ++i)
4ef0d4d0
KS
4612 if (matrix[i])
4613 {
6ae141d6 4614 XColor *t = COLOR (colors, xx, yy);
4ef0d4d0
KS
4615 r += matrix[i] * t->red;
4616 g += matrix[i] * t->green;
4617 b += matrix[i] * t->blue;
4618 }
4619
4620 r = (r / sum + color_adjust) & 0xffff;
4621 g = (g / sum + color_adjust) & 0xffff;
4622 b = (b / sum + color_adjust) & 0xffff;
4623 p->red = p->green = p->blue = COLOR_INTENSITY (r, g, b);
4624 }
4625 }
4626
4627 xfree (colors);
4628 x_from_xcolors (f, img, new);
4629
4630#undef COLOR
4631}
4632
4633
4634/* Perform the pre-defined `emboss' edge-detection on image IMG
4635 on frame F. */
4636
4637static void
d3da34e0 4638x_emboss (struct frame *f, struct image *img)
4ef0d4d0
KS
4639{
4640 x_detect_edges (f, img, emboss_matrix, 0xffff / 2);
4641}
4642
4643
4644/* Transform image IMG which is used on frame F with a Laplace
4645 edge-detection algorithm. The result is an image that can be used
4646 to draw disabled buttons, for example. */
4647
4648static void
d3da34e0 4649x_laplace (struct frame *f, struct image *img)
4ef0d4d0
KS
4650{
4651 x_detect_edges (f, img, laplace_matrix, 45000);
4652}
4653
4654
4655/* Perform edge-detection on image IMG on frame F, with specified
4656 transformation matrix MATRIX and color-adjustment COLOR_ADJUST.
4657
4658 MATRIX must be either
4659
4660 - a list of at least 9 numbers in row-major form
4661 - a vector of at least 9 numbers
4662
4663 COLOR_ADJUST nil means use a default; otherwise it must be a
4664 number. */
4665
4666static void
d3da34e0
JB
4667x_edge_detection (struct frame *f, struct image *img, Lisp_Object matrix,
4668 Lisp_Object color_adjust)
4ef0d4d0
KS
4669{
4670 int i = 0;
4671 int trans[9];
4672
4673 if (CONSP (matrix))
4674 {
4675 for (i = 0;
4676 i < 9 && CONSP (matrix) && NUMBERP (XCAR (matrix));
4677 ++i, matrix = XCDR (matrix))
4678 trans[i] = XFLOATINT (XCAR (matrix));
4679 }
4680 else if (VECTORP (matrix) && ASIZE (matrix) >= 9)
4681 {
4682 for (i = 0; i < 9 && NUMBERP (AREF (matrix, i)); ++i)
4683 trans[i] = XFLOATINT (AREF (matrix, i));
4684 }
4685
4686 if (NILP (color_adjust))
4687 color_adjust = make_number (0xffff / 2);
4688
4689 if (i == 9 && NUMBERP (color_adjust))
77a765fd 4690 x_detect_edges (f, img, trans, XFLOATINT (color_adjust));
4ef0d4d0
KS
4691}
4692
4693
4694/* Transform image IMG on frame F so that it looks disabled. */
4695
4696static void
d3da34e0 4697x_disable_image (struct frame *f, struct image *img)
4ef0d4d0
KS
4698{
4699 Display_Info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
4700#ifdef HAVE_NTGUI
4701 int n_planes = dpyinfo->n_planes * dpyinfo->n_cbits;
4702#else
4703 int n_planes = dpyinfo->n_planes;
4704#endif /* HAVE_NTGUI */
4705
4706 if (n_planes >= 2)
4707 {
4708 /* Color (or grayscale). Convert to gray, and equalize. Just
4709 drawing such images with a stipple can look very odd, so
4710 we're using this method instead. */
4711 XColor *colors = x_to_xcolors (f, img, 1);
4712 XColor *p, *end;
4713 const int h = 15000;
4714 const int l = 30000;
4715
4716 for (p = colors, end = colors + img->width * img->height;
4717 p < end;
4718 ++p)
4719 {
4720 int i = COLOR_INTENSITY (p->red, p->green, p->blue);
4721 int i2 = (0xffff - h - l) * i / 0xffff + l;
4722 p->red = p->green = p->blue = i2;
4723 }
4724
4725 x_from_xcolors (f, img, colors);
4726 }
4727
4728 /* Draw a cross over the disabled image, if we must or if we
4729 should. */
4730 if (n_planes < 2 || cross_disabled_images)
4731 {
4732#ifndef HAVE_NTGUI
4733 Display *dpy = FRAME_X_DISPLAY (f);
4734 GC gc;
4735
5afa3a81 4736#ifndef HAVE_NS /* TODO: NS support, however this not needed for toolbars */
edfda783 4737
4ef0d4d0 4738#define MaskForeground(f) WHITE_PIX_DEFAULT (f)
4ef0d4d0 4739
ae8279db 4740 gc = XCreateGC (dpy, img->pixmap, 0, NULL);
4ef0d4d0
KS
4741 XSetForeground (dpy, gc, BLACK_PIX_DEFAULT (f));
4742 XDrawLine (dpy, img->pixmap, gc, 0, 0,
4743 img->width - 1, img->height - 1);
4744 XDrawLine (dpy, img->pixmap, gc, 0, img->height - 1,
4745 img->width - 1, 0);
4746 XFreeGC (dpy, gc);
4747
4748 if (img->mask)
4749 {
ae8279db 4750 gc = XCreateGC (dpy, img->mask, 0, NULL);
4ef0d4d0
KS
4751 XSetForeground (dpy, gc, MaskForeground (f));
4752 XDrawLine (dpy, img->mask, gc, 0, 0,
4753 img->width - 1, img->height - 1);
4754 XDrawLine (dpy, img->mask, gc, 0, img->height - 1,
4755 img->width - 1, 0);
4756 XFreeGC (dpy, gc);
4757 }
edfda783 4758#endif /* !HAVE_NS */
4ef0d4d0
KS
4759#else
4760 HDC hdc, bmpdc;
4761 HGDIOBJ prev;
4762
4763 hdc = get_frame_dc (f);
4764 bmpdc = CreateCompatibleDC (hdc);
4765 release_frame_dc (f, hdc);
4766
4767 prev = SelectObject (bmpdc, img->pixmap);
4768
4769 SetTextColor (bmpdc, BLACK_PIX_DEFAULT (f));
4770 MoveToEx (bmpdc, 0, 0, NULL);
4771 LineTo (bmpdc, img->width - 1, img->height - 1);
4772 MoveToEx (bmpdc, 0, img->height - 1, NULL);
4773 LineTo (bmpdc, img->width - 1, 0);
4774
4775 if (img->mask)
4776 {
4777 SelectObject (bmpdc, img->mask);
4778 SetTextColor (bmpdc, WHITE_PIX_DEFAULT (f));
4779 MoveToEx (bmpdc, 0, 0, NULL);
4780 LineTo (bmpdc, img->width - 1, img->height - 1);
4781 MoveToEx (bmpdc, 0, img->height - 1, NULL);
4782 LineTo (bmpdc, img->width - 1, 0);
4783 }
4784 SelectObject (bmpdc, prev);
4785 DeleteDC (bmpdc);
4786#endif /* HAVE_NTGUI */
4787 }
4788}
4789
4790
4791/* Build a mask for image IMG which is used on frame F. FILE is the
4792 name of an image file, for error messages. HOW determines how to
4793 determine the background color of IMG. If it is a list '(R G B)',
4794 with R, G, and B being integers >= 0, take that as the color of the
4795 background. Otherwise, determine the background color of IMG
4796 heuristically. Value is non-zero if successful. */
4797
4798static int
d3da34e0 4799x_build_heuristic_mask (struct frame *f, struct image *img, Lisp_Object how)
4ef0d4d0
KS
4800{
4801 XImagePtr_or_DC ximg;
4802#ifndef HAVE_NTGUI
4803 XImagePtr mask_img;
4804#else
4805 HDC frame_dc;
4806 HGDIOBJ prev;
4807 char *mask_img;
4808 int row_width;
4809#endif /* HAVE_NTGUI */
4810 int x, y, rc, use_img_background;
4811 unsigned long bg = 0;
4812
4813 if (img->mask)
4814 {
4815 Free_Pixmap (FRAME_X_DISPLAY (f), img->mask);
4816 img->mask = NO_PIXMAP;
4817 img->background_transparent_valid = 0;
4818 }
4819
4820#ifndef HAVE_NTGUI
edfda783 4821#ifndef HAVE_NS
4ef0d4d0
KS
4822 /* Create an image and pixmap serving as mask. */
4823 rc = x_create_x_image_and_pixmap (f, img->width, img->height, 1,
4824 &mask_img, &img->mask);
4825 if (!rc)
4826 return 0;
edfda783 4827#endif /* !HAVE_NS */
4ef0d4d0
KS
4828
4829 /* Get the X image of IMG->pixmap. */
4830 ximg = XGetImage (FRAME_X_DISPLAY (f), img->pixmap, 0, 0,
4831 img->width, img->height,
4832 ~0, ZPixmap);
4833#else
4834 /* Create the bit array serving as mask. */
4835 row_width = (img->width + 7) / 8;
4836 mask_img = xmalloc (row_width * img->height);
72af86bd 4837 memset (mask_img, 0, row_width * img->height);
4ef0d4d0
KS
4838
4839 /* Create a memory device context for IMG->pixmap. */
4840 frame_dc = get_frame_dc (f);
4841 ximg = CreateCompatibleDC (frame_dc);
4842 release_frame_dc (f, frame_dc);
4843 prev = SelectObject (ximg, img->pixmap);
4844#endif /* HAVE_NTGUI */
4845
4846 /* Determine the background color of ximg. If HOW is `(R G B)'
4847 take that as color. Otherwise, use the image's background color. */
4848 use_img_background = 1;
4849
4850 if (CONSP (how))
4851 {
4852 int rgb[3], i;
4853
4854 for (i = 0; i < 3 && CONSP (how) && NATNUMP (XCAR (how)); ++i)
4855 {
4856 rgb[i] = XFASTINT (XCAR (how)) & 0xffff;
4857 how = XCDR (how);
4858 }
4859
4860 if (i == 3 && NILP (how))
4861 {
4862 char color_name[30];
4863 sprintf (color_name, "#%04x%04x%04x", rgb[0], rgb[1], rgb[2]);
4864 bg = (
4865#ifdef HAVE_NTGUI
4866 0x00ffffff & /* Filter out palette info. */
4867#endif /* HAVE_NTGUI */
4868 x_alloc_image_color (f, img, build_string (color_name), 0));
4869 use_img_background = 0;
4870 }
4871 }
4872
4873 if (use_img_background)
6ac3c7bb 4874 bg = four_corners_best (ximg, img->corners, img->width, img->height);
4ef0d4d0
KS
4875
4876 /* Set all bits in mask_img to 1 whose color in ximg is different
4877 from the background color bg. */
4878#ifndef HAVE_NTGUI
4879 for (y = 0; y < img->height; ++y)
4880 for (x = 0; x < img->width; ++x)
edfda783 4881#ifndef HAVE_NS
4ef0d4d0 4882 XPutPixel (mask_img, x, y, (XGetPixel (ximg, x, y) != bg
9ecf6403 4883 ? PIX_MASK_DRAW : PIX_MASK_RETAIN));
edfda783
AR
4884#else
4885 if (XGetPixel (ximg, x, y) == bg)
ed3751c8 4886 ns_set_alpha (ximg, x, y, 0);
edfda783
AR
4887#endif /* HAVE_NS */
4888#ifndef HAVE_NS
4ef0d4d0
KS
4889 /* Fill in the background_transparent field while we have the mask handy. */
4890 image_background_transparent (img, f, mask_img);
4891
4892 /* Put mask_img into img->mask. */
4893 x_put_x_image (f, mask_img, img->mask, img->width, img->height);
4894 x_destroy_x_image (mask_img);
edfda783 4895#endif /* !HAVE_NS */
4ef0d4d0
KS
4896#else
4897 for (y = 0; y < img->height; ++y)
4898 for (x = 0; x < img->width; ++x)
4899 {
4900 COLORREF p = GetPixel (ximg, x, y);
4901 if (p != bg)
4902 mask_img[y * row_width + x / 8] |= 1 << (x % 8);
4903 }
4904
4905 /* Create the mask image. */
4906 img->mask = w32_create_pixmap_from_bitmap_data (img->width, img->height,
4907 mask_img);
4908 /* Fill in the background_transparent field while we have the mask handy. */
4909 SelectObject (ximg, img->mask);
4910 image_background_transparent (img, f, ximg);
4911
4912 /* Was: x_destroy_x_image ((XImagePtr )mask_img); which seems bogus ++kfs */
4913 xfree (mask_img);
4914#endif /* HAVE_NTGUI */
4915
4916 Destroy_Image (ximg, prev);
4917
4918 return 1;
4919}
4920
4921\f
4922/***********************************************************************
4923 PBM (mono, gray, color)
4924 ***********************************************************************/
4925
f57e2426
J
4926static int pbm_image_p (Lisp_Object object);
4927static int pbm_load (struct frame *f, struct image *img);
4928static int pbm_scan_number (unsigned char **, unsigned char *);
4ef0d4d0
KS
4929
4930/* The symbol `pbm' identifying images of this type. */
4931
955cbe7b 4932static Lisp_Object Qpbm;
4ef0d4d0
KS
4933
4934/* Indices of image specification fields in gs_format, below. */
4935
4936enum pbm_keyword_index
4937{
4938 PBM_TYPE,
4939 PBM_FILE,
4940 PBM_DATA,
4941 PBM_ASCENT,
4942 PBM_MARGIN,
4943 PBM_RELIEF,
4944 PBM_ALGORITHM,
4945 PBM_HEURISTIC_MASK,
4946 PBM_MASK,
4947 PBM_FOREGROUND,
4948 PBM_BACKGROUND,
4949 PBM_LAST
4950};
4951
4952/* Vector of image_keyword structures describing the format
4953 of valid user-defined image specifications. */
4954
91433552 4955static const struct image_keyword pbm_format[PBM_LAST] =
4ef0d4d0
KS
4956{
4957 {":type", IMAGE_SYMBOL_VALUE, 1},
4958 {":file", IMAGE_STRING_VALUE, 0},
4959 {":data", IMAGE_STRING_VALUE, 0},
4960 {":ascent", IMAGE_ASCENT_VALUE, 0},
4961 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
4962 {":relief", IMAGE_INTEGER_VALUE, 0},
4963 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
4964 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
4965 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
4966 {":foreground", IMAGE_STRING_OR_NIL_VALUE, 0},
4967 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
4968};
4969
4970/* Structure describing the image type `pbm'. */
4971
4972static struct image_type pbm_type =
4973{
4974 &Qpbm,
4975 pbm_image_p,
4976 pbm_load,
4977 x_clear_image,
4978 NULL
4979};
4980
4981
4982/* Return non-zero if OBJECT is a valid PBM image specification. */
4983
4984static int
d3da34e0 4985pbm_image_p (Lisp_Object object)
4ef0d4d0
KS
4986{
4987 struct image_keyword fmt[PBM_LAST];
4988
72af86bd 4989 memcpy (fmt, pbm_format, sizeof fmt);
4ef0d4d0
KS
4990
4991 if (!parse_image_spec (object, fmt, PBM_LAST, Qpbm))
4992 return 0;
4993
4994 /* Must specify either :data or :file. */
4995 return fmt[PBM_DATA].count + fmt[PBM_FILE].count == 1;
4996}
4997
4998
4999/* Scan a decimal number from *S and return it. Advance *S while
5000 reading the number. END is the end of the string. Value is -1 at
5001 end of input. */
5002
5003static int
d3da34e0 5004pbm_scan_number (unsigned char **s, unsigned char *end)
4ef0d4d0
KS
5005{
5006 int c = 0, val = -1;
5007
5008 while (*s < end)
5009 {
5010 /* Skip white-space. */
5011 while (*s < end && (c = *(*s)++, isspace (c)))
5012 ;
5013
5014 if (c == '#')
5015 {
5016 /* Skip comment to end of line. */
5017 while (*s < end && (c = *(*s)++, c != '\n'))
5018 ;
5019 }
5020 else if (isdigit (c))
5021 {
5022 /* Read decimal number. */
5023 val = c - '0';
5024 while (*s < end && (c = *(*s)++, isdigit (c)))
5025 val = 10 * val + c - '0';
5026 break;
5027 }
5028 else
5029 break;
5030 }
5031
5032 return val;
5033}
5034
5035
5036#ifdef HAVE_NTGUI
5037#if 0 /* Unused. ++kfs */
5038
5039/* Read FILE into memory. Value is a pointer to a buffer allocated
5040 with xmalloc holding FILE's contents. Value is null if an error
5041 occurred. *SIZE is set to the size of the file. */
5042
5043static char *
5044pbm_read_file (file, size)
5045 Lisp_Object file;
5046 int *size;
5047{
5048 FILE *fp = NULL;
5049 char *buf = NULL;
5050 struct stat st;
5051
5052 if (stat (SDATA (file), &st) == 0
5053 && (fp = fopen (SDATA (file), "rb")) != NULL
5054 && (buf = (char *) xmalloc (st.st_size),
5055 fread (buf, 1, st.st_size, fp) == st.st_size))
5056 {
5057 *size = st.st_size;
5058 fclose (fp);
5059 }
5060 else
5061 {
5062 if (fp)
5063 fclose (fp);
5064 if (buf)
5065 {
5066 xfree (buf);
5067 buf = NULL;
5068 }
5069 }
5070
5071 return buf;
5072}
5073#endif
5074#endif /* HAVE_NTGUI */
5075
5076/* Load PBM image IMG for use on frame F. */
5077
5078static int
d3da34e0 5079pbm_load (struct frame *f, struct image *img)
4ef0d4d0
KS
5080{
5081 int raw_p, x, y;
5082 int width, height, max_color_idx = 0;
5083 XImagePtr ximg;
5084 Lisp_Object file, specified_file;
5085 enum {PBM_MONO, PBM_GRAY, PBM_COLOR} type;
4ef0d4d0
KS
5086 unsigned char *contents = NULL;
5087 unsigned char *end, *p;
5088 int size;
5089
5090 specified_file = image_spec_value (img->spec, QCfile, NULL);
4ef0d4d0
KS
5091
5092 if (STRINGP (specified_file))
5093 {
5094 file = x_find_image_file (specified_file);
5095 if (!STRINGP (file))
5096 {
5097 image_error ("Cannot find image file `%s'", specified_file, Qnil);
4ef0d4d0
KS
5098 return 0;
5099 }
5100
42a5b22f 5101 contents = slurp_file (SSDATA (file), &size);
4ef0d4d0
KS
5102 if (contents == NULL)
5103 {
5104 image_error ("Error reading `%s'", file, Qnil);
4ef0d4d0
KS
5105 return 0;
5106 }
5107
5108 p = contents;
5109 end = contents + size;
5110 }
5111 else
5112 {
5113 Lisp_Object data;
5114 data = image_spec_value (img->spec, QCdata, NULL);
7574650a
AS
5115 if (!STRINGP (data))
5116 {
5117 image_error ("Invalid image data `%s'", data, Qnil);
5118 return 0;
5119 }
4ef0d4d0
KS
5120 p = SDATA (data);
5121 end = p + SBYTES (data);
5122 }
5123
5124 /* Check magic number. */
5125 if (end - p < 2 || *p++ != 'P')
5126 {
5127 image_error ("Not a PBM image: `%s'", img->spec, Qnil);
5128 error:
5129 xfree (contents);
4ef0d4d0
KS
5130 return 0;
5131 }
5132
5133 switch (*p++)
5134 {
5135 case '1':
5136 raw_p = 0, type = PBM_MONO;
5137 break;
5138
5139 case '2':
5140 raw_p = 0, type = PBM_GRAY;
5141 break;
5142
5143 case '3':
5144 raw_p = 0, type = PBM_COLOR;
5145 break;
5146
5147 case '4':
5148 raw_p = 1, type = PBM_MONO;
5149 break;
5150
5151 case '5':
5152 raw_p = 1, type = PBM_GRAY;
5153 break;
5154
5155 case '6':
5156 raw_p = 1, type = PBM_COLOR;
5157 break;
5158
5159 default:
5160 image_error ("Not a PBM image: `%s'", img->spec, Qnil);
5161 goto error;
5162 }
5163
5164 /* Read width, height, maximum color-component. Characters
5165 starting with `#' up to the end of a line are ignored. */
5166 width = pbm_scan_number (&p, end);
5167 height = pbm_scan_number (&p, end);
5168
5169 if (type != PBM_MONO)
5170 {
5171 max_color_idx = pbm_scan_number (&p, end);
b9c89e11
JR
5172 if (max_color_idx > 65535 || max_color_idx < 0)
5173 {
5174 image_error ("Unsupported maximum PBM color value", Qnil, Qnil);
5175 goto error;
5176 }
4ef0d4d0
KS
5177 }
5178
b9c89e11
JR
5179 if (!check_image_size (f, width, height))
5180 {
10ea2b82 5181 image_error ("Invalid image size (see `max-image-size')", Qnil, Qnil);
b9c89e11
JR
5182 goto error;
5183 }
4ef0d4d0
KS
5184
5185 if (!x_create_x_image_and_pixmap (f, width, height, 0,
5186 &ximg, &img->pixmap))
5187 goto error;
5188
5189 /* Initialize the color hash table. */
5190 init_color_table ();
5191
5192 if (type == PBM_MONO)
5193 {
5194 int c = 0, g;
5195 struct image_keyword fmt[PBM_LAST];
5196 unsigned long fg = FRAME_FOREGROUND_PIXEL (f);
5197 unsigned long bg = FRAME_BACKGROUND_PIXEL (f);
5198
5199 /* Parse the image specification. */
72af86bd 5200 memcpy (fmt, pbm_format, sizeof fmt);
4ef0d4d0
KS
5201 parse_image_spec (img->spec, fmt, PBM_LAST, Qpbm);
5202
5203 /* Get foreground and background colors, maybe allocate colors. */
5204 if (fmt[PBM_FOREGROUND].count
5205 && STRINGP (fmt[PBM_FOREGROUND].value))
5206 fg = x_alloc_image_color (f, img, fmt[PBM_FOREGROUND].value, fg);
5207 if (fmt[PBM_BACKGROUND].count
5208 && STRINGP (fmt[PBM_BACKGROUND].value))
5209 {
5210 bg = x_alloc_image_color (f, img, fmt[PBM_BACKGROUND].value, bg);
5211 img->background = bg;
5212 img->background_valid = 1;
5213 }
5214
5215 for (y = 0; y < height; ++y)
5216 for (x = 0; x < width; ++x)
5217 {
5218 if (raw_p)
5219 {
5220 if ((x & 7) == 0)
c295e710
CY
5221 {
5222 if (p >= end)
5223 {
5224 x_destroy_x_image (ximg);
5225 x_clear_image (f, img);
5226 image_error ("Invalid image size in image `%s'",
5227 img->spec, Qnil);
5228 goto error;
5229 }
5230 c = *p++;
5231 }
4ef0d4d0
KS
5232 g = c & 0x80;
5233 c <<= 1;
5234 }
5235 else
5236 g = pbm_scan_number (&p, end);
5237
5238 XPutPixel (ximg, x, y, g ? fg : bg);
5239 }
5240 }
5241 else
5242 {
b9c89e11
JR
5243 int expected_size = height * width;
5244 if (max_color_idx > 255)
5245 expected_size *= 2;
5246 if (type == PBM_COLOR)
5247 expected_size *= 3;
5248
5249 if (raw_p && p + expected_size > end)
39e653ea
CY
5250 {
5251 x_destroy_x_image (ximg);
fb0b0862 5252 x_clear_image (f, img);
39e653ea
CY
5253 image_error ("Invalid image size in image `%s'",
5254 img->spec, Qnil);
5255 goto error;
5256 }
5257
4ef0d4d0
KS
5258 for (y = 0; y < height; ++y)
5259 for (x = 0; x < width; ++x)
5260 {
5261 int r, g, b;
5262
b9c89e11
JR
5263 if (type == PBM_GRAY && raw_p)
5264 {
5265 r = g = b = *p++;
5266 if (max_color_idx > 255)
5267 r = g = b = r * 256 + *p++;
5268 }
5269 else if (type == PBM_GRAY)
5270 r = g = b = pbm_scan_number (&p, end);
4ef0d4d0
KS
5271 else if (raw_p)
5272 {
5273 r = *p++;
b9c89e11
JR
5274 if (max_color_idx > 255)
5275 r = r * 256 + *p++;
4ef0d4d0 5276 g = *p++;
b9c89e11
JR
5277 if (max_color_idx > 255)
5278 g = g * 256 + *p++;
4ef0d4d0 5279 b = *p++;
b9c89e11
JR
5280 if (max_color_idx > 255)
5281 b = b * 256 + *p++;
4ef0d4d0
KS
5282 }
5283 else
5284 {
5285 r = pbm_scan_number (&p, end);
5286 g = pbm_scan_number (&p, end);
5287 b = pbm_scan_number (&p, end);
5288 }
5289
5290 if (r < 0 || g < 0 || b < 0)
5291 {
5292 x_destroy_x_image (ximg);
5293 image_error ("Invalid pixel value in image `%s'",
5294 img->spec, Qnil);
5295 goto error;
5296 }
5297
5298 /* RGB values are now in the range 0..max_color_idx.
5299 Scale this to the range 0..0xffff supported by X. */
5300 r = (double) r * 65535 / max_color_idx;
5301 g = (double) g * 65535 / max_color_idx;
5302 b = (double) b * 65535 / max_color_idx;
5303 XPutPixel (ximg, x, y, lookup_rgb_color (f, r, g, b));
5304 }
5305 }
5306
5307#ifdef COLOR_TABLE_SUPPORT
5308 /* Store in IMG->colors the colors allocated for the image, and
5309 free the color table. */
5310 img->colors = colors_in_color_table (&img->ncolors);
5311 free_color_table ();
5312#endif /* COLOR_TABLE_SUPPORT */
5313
5314 img->width = width;
5315 img->height = height;
5316
5317 /* Maybe fill in the background field while we have ximg handy. */
5318
5319 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
2e09fef1
EZ
5320 /* Casting avoids a GCC warning. */
5321 IMAGE_BACKGROUND (img, f, (XImagePtr_or_DC)ximg);
4ef0d4d0
KS
5322
5323 /* Put the image into a pixmap. */
5324 x_put_x_image (f, ximg, img->pixmap, width, height);
5325 x_destroy_x_image (ximg);
5326
5327 /* X and W32 versions did it here, MAC version above. ++kfs
1f026899 5328 img->width = width;
4ef0d4d0
KS
5329 img->height = height; */
5330
4ef0d4d0
KS
5331 xfree (contents);
5332 return 1;
5333}
5334
5335\f
5336/***********************************************************************
5337 PNG
5338 ***********************************************************************/
5339
9e2a2647 5340#if defined (HAVE_PNG) || defined (HAVE_NS)
4ef0d4d0
KS
5341
5342/* Function prototypes. */
5343
f57e2426
J
5344static int png_image_p (Lisp_Object object);
5345static int png_load (struct frame *f, struct image *img);
4ef0d4d0
KS
5346
5347/* The symbol `png' identifying images of this type. */
5348
955cbe7b 5349static Lisp_Object Qpng;
4ef0d4d0
KS
5350
5351/* Indices of image specification fields in png_format, below. */
5352
5353enum png_keyword_index
5354{
5355 PNG_TYPE,
5356 PNG_DATA,
5357 PNG_FILE,
5358 PNG_ASCENT,
5359 PNG_MARGIN,
5360 PNG_RELIEF,
5361 PNG_ALGORITHM,
5362 PNG_HEURISTIC_MASK,
5363 PNG_MASK,
5364 PNG_BACKGROUND,
5365 PNG_LAST
5366};
5367
5368/* Vector of image_keyword structures describing the format
5369 of valid user-defined image specifications. */
5370
91433552 5371static const struct image_keyword png_format[PNG_LAST] =
4ef0d4d0
KS
5372{
5373 {":type", IMAGE_SYMBOL_VALUE, 1},
5374 {":data", IMAGE_STRING_VALUE, 0},
5375 {":file", IMAGE_STRING_VALUE, 0},
5376 {":ascent", IMAGE_ASCENT_VALUE, 0},
5377 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
5378 {":relief", IMAGE_INTEGER_VALUE, 0},
5379 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
5380 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
5381 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
5382 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
5383};
5384
5385/* Structure describing the image type `png'. */
5386
5387static struct image_type png_type =
5388{
5389 &Qpng,
5390 png_image_p,
5391 png_load,
5392 x_clear_image,
5393 NULL
5394};
5395
5396/* Return non-zero if OBJECT is a valid PNG image specification. */
5397
5398static int
d3da34e0 5399png_image_p (Lisp_Object object)
4ef0d4d0
KS
5400{
5401 struct image_keyword fmt[PNG_LAST];
72af86bd 5402 memcpy (fmt, png_format, sizeof fmt);
4ef0d4d0
KS
5403
5404 if (!parse_image_spec (object, fmt, PNG_LAST, Qpng))
5405 return 0;
5406
5407 /* Must specify either the :data or :file keyword. */
5408 return fmt[PNG_FILE].count + fmt[PNG_DATA].count == 1;
5409}
5410
9e2a2647 5411#endif /* HAVE_PNG || HAVE_NS */
4ef0d4d0
KS
5412
5413
5414#ifdef HAVE_PNG
5415
4ef0d4d0
KS
5416#ifdef HAVE_NTGUI
5417/* PNG library details. */
5418
14beddf4
CY
5419DEF_IMGLIB_FN (png_voidp, png_get_io_ptr, (png_structp));
5420DEF_IMGLIB_FN (int, png_sig_cmp, (png_bytep, png_size_t, png_size_t));
5421DEF_IMGLIB_FN (png_structp, png_create_read_struct, (png_const_charp, png_voidp,
5422 png_error_ptr, png_error_ptr));
5423DEF_IMGLIB_FN (png_infop, png_create_info_struct, (png_structp));
5424DEF_IMGLIB_FN (void, png_destroy_read_struct, (png_structpp, png_infopp, png_infopp));
5425DEF_IMGLIB_FN (void, png_set_read_fn, (png_structp, png_voidp, png_rw_ptr));
5426DEF_IMGLIB_FN (void, png_set_sig_bytes, (png_structp, int));
5427DEF_IMGLIB_FN (void, png_read_info, (png_structp, png_infop));
5428DEF_IMGLIB_FN (png_uint_32, png_get_IHDR, (png_structp, png_infop,
850690cc
JB
5429 png_uint_32 *, png_uint_32 *,
5430 int *, int *, int *, int *, int *));
14beddf4
CY
5431DEF_IMGLIB_FN (png_uint_32, png_get_valid, (png_structp, png_infop, png_uint_32));
5432DEF_IMGLIB_FN (void, png_set_strip_16, (png_structp));
5433DEF_IMGLIB_FN (void, png_set_expand, (png_structp));
5434DEF_IMGLIB_FN (void, png_set_gray_to_rgb, (png_structp));
5435DEF_IMGLIB_FN (void, png_set_background, (png_structp, png_color_16p,
850690cc 5436 int, int, double));
14beddf4
CY
5437DEF_IMGLIB_FN (png_uint_32, png_get_bKGD, (png_structp, png_infop, png_color_16p *));
5438DEF_IMGLIB_FN (void, png_read_update_info, (png_structp, png_infop));
5439DEF_IMGLIB_FN (png_byte, png_get_channels, (png_structp, png_infop));
5440DEF_IMGLIB_FN (png_size_t, png_get_rowbytes, (png_structp, png_infop));
5441DEF_IMGLIB_FN (void, png_read_image, (png_structp, png_bytepp));
5442DEF_IMGLIB_FN (void, png_read_end, (png_structp, png_infop));
5443DEF_IMGLIB_FN (void, png_error, (png_structp, png_const_charp));
4ef0d4d0 5444
7f9c5df9 5445#if (PNG_LIBPNG_VER >= 10500)
14beddf4
CY
5446DEF_IMGLIB_FN (void, png_longjmp, (png_structp, int));
5447DEF_IMGLIB_FN (jmp_buf *, png_set_longjmp_fn, (png_structp, png_longjmp_ptr, size_t));
7f9c5df9 5448#endif /* libpng version >= 1.5 */
4ef0d4d0
KS
5449
5450static int
0855eb52 5451init_png_functions (Lisp_Object libraries)
4ef0d4d0
KS
5452{
5453 HMODULE library;
5454
4ef0d4d0 5455 /* Try loading libpng under probable names. */
0855eb52 5456 if (!(library = w32_delayed_load (libraries, Qpng)))
4ef0d4d0
KS
5457 return 0;
5458
5459 LOAD_IMGLIB_FN (library, png_get_io_ptr);
285d07e2 5460 LOAD_IMGLIB_FN (library, png_sig_cmp);
4ef0d4d0
KS
5461 LOAD_IMGLIB_FN (library, png_create_read_struct);
5462 LOAD_IMGLIB_FN (library, png_create_info_struct);
5463 LOAD_IMGLIB_FN (library, png_destroy_read_struct);
5464 LOAD_IMGLIB_FN (library, png_set_read_fn);
4ef0d4d0
KS
5465 LOAD_IMGLIB_FN (library, png_set_sig_bytes);
5466 LOAD_IMGLIB_FN (library, png_read_info);
5467 LOAD_IMGLIB_FN (library, png_get_IHDR);
5468 LOAD_IMGLIB_FN (library, png_get_valid);
5469 LOAD_IMGLIB_FN (library, png_set_strip_16);
5470 LOAD_IMGLIB_FN (library, png_set_expand);
5471 LOAD_IMGLIB_FN (library, png_set_gray_to_rgb);
5472 LOAD_IMGLIB_FN (library, png_set_background);
5473 LOAD_IMGLIB_FN (library, png_get_bKGD);
5474 LOAD_IMGLIB_FN (library, png_read_update_info);
5475 LOAD_IMGLIB_FN (library, png_get_channels);
5476 LOAD_IMGLIB_FN (library, png_get_rowbytes);
5477 LOAD_IMGLIB_FN (library, png_read_image);
5478 LOAD_IMGLIB_FN (library, png_read_end);
5479 LOAD_IMGLIB_FN (library, png_error);
7f9c5df9
CY
5480
5481#if (PNG_LIBPNG_VER >= 10500)
5482 LOAD_IMGLIB_FN (library, png_longjmp);
5483 LOAD_IMGLIB_FN (library, png_set_longjmp_fn);
5484#endif /* libpng version >= 1.5 */
5485
4ef0d4d0
KS
5486 return 1;
5487}
5488#else
5489
5490#define fn_png_get_io_ptr png_get_io_ptr
285d07e2 5491#define fn_png_sig_cmp png_sig_cmp
4ef0d4d0
KS
5492#define fn_png_create_read_struct png_create_read_struct
5493#define fn_png_create_info_struct png_create_info_struct
5494#define fn_png_destroy_read_struct png_destroy_read_struct
5495#define fn_png_set_read_fn png_set_read_fn
4ef0d4d0
KS
5496#define fn_png_set_sig_bytes png_set_sig_bytes
5497#define fn_png_read_info png_read_info
5498#define fn_png_get_IHDR png_get_IHDR
5499#define fn_png_get_valid png_get_valid
5500#define fn_png_set_strip_16 png_set_strip_16
5501#define fn_png_set_expand png_set_expand
5502#define fn_png_set_gray_to_rgb png_set_gray_to_rgb
5503#define fn_png_set_background png_set_background
5504#define fn_png_get_bKGD png_get_bKGD
5505#define fn_png_read_update_info png_read_update_info
5506#define fn_png_get_channels png_get_channels
5507#define fn_png_get_rowbytes png_get_rowbytes
5508#define fn_png_read_image png_read_image
5509#define fn_png_read_end png_read_end
5510#define fn_png_error png_error
5511
7f9c5df9
CY
5512#if (PNG_LIBPNG_VER >= 10500)
5513#define fn_png_longjmp png_longjmp
5514#define fn_png_set_longjmp_fn png_set_longjmp_fn
5515#endif /* libpng version >= 1.5 */
5516
4ef0d4d0
KS
5517#endif /* HAVE_NTGUI */
5518
7f9c5df9
CY
5519
5520#if (PNG_LIBPNG_VER < 10500)
c2e79cb4 5521#define PNG_LONGJMP(ptr) (longjmp ((ptr)->jmpbuf, 1))
7f9c5df9
CY
5522#define PNG_JMPBUF(ptr) ((ptr)->jmpbuf)
5523#else
df61c790 5524/* In libpng version 1.5, the jmpbuf member is hidden. (Bug#7908) */
c2e79cb4 5525#define PNG_LONGJMP(ptr) (fn_png_longjmp ((ptr), 1))
7f9c5df9 5526#define PNG_JMPBUF(ptr) \
df61c790 5527 (*fn_png_set_longjmp_fn((ptr), longjmp, sizeof (jmp_buf)))
7f9c5df9
CY
5528#endif
5529
4ef0d4d0
KS
5530/* Error and warning handlers installed when the PNG library
5531 is initialized. */
5532
ec6cf4c6 5533static void my_png_error (png_struct *, const char *) NO_RETURN;
4ef0d4d0 5534static void
d3da34e0 5535my_png_error (png_struct *png_ptr, const char *msg)
4ef0d4d0
KS
5536{
5537 xassert (png_ptr != NULL);
5be1c984
EZ
5538 /* Avoid compiler warning about deprecated direct access to
5539 png_ptr's fields in libpng versions 1.4.x. */
4ef0d4d0 5540 image_error ("PNG error: %s", build_string (msg), Qnil);
7f9c5df9 5541 PNG_LONGJMP (png_ptr);
4ef0d4d0
KS
5542}
5543
5544
5545static void
d3da34e0 5546my_png_warning (png_struct *png_ptr, const char *msg)
4ef0d4d0
KS
5547{
5548 xassert (png_ptr != NULL);
5549 image_error ("PNG warning: %s", build_string (msg), Qnil);
5550}
5551
5552/* Memory source for PNG decoding. */
5553
5554struct png_memory_storage
5555{
5556 unsigned char *bytes; /* The data */
5557 size_t len; /* How big is it? */
5558 int index; /* Where are we? */
5559};
5560
5561
5562/* Function set as reader function when reading PNG image from memory.
5563 PNG_PTR is a pointer to the PNG control structure. Copy LENGTH
5564 bytes from the input to DATA. */
5565
5566static void
d3da34e0 5567png_read_from_memory (png_structp png_ptr, png_bytep data, png_size_t length)
4ef0d4d0
KS
5568{
5569 struct png_memory_storage *tbr
5570 = (struct png_memory_storage *) fn_png_get_io_ptr (png_ptr);
5571
5572 if (length > tbr->len - tbr->index)
5573 fn_png_error (png_ptr, "Read error");
5574
72af86bd 5575 memcpy (data, tbr->bytes + tbr->index, length);
4ef0d4d0
KS
5576 tbr->index = tbr->index + length;
5577}
5578
b0da69a7 5579
9a22a004
JB
5580/* Function set as reader function when reading PNG image from a file.
5581 PNG_PTR is a pointer to the PNG control structure. Copy LENGTH
5582 bytes from the input to DATA. */
5583
5584static void
d3da34e0 5585png_read_from_file (png_structp png_ptr, png_bytep data, png_size_t length)
9a22a004
JB
5586{
5587 FILE *fp = (FILE *) fn_png_get_io_ptr (png_ptr);
5588
5589 if (fread (data, 1, length, fp) < length)
5590 fn_png_error (png_ptr, "Read error");
5591}
5592
5593
4ef0d4d0
KS
5594/* Load PNG image IMG for use on frame F. Value is non-zero if
5595 successful. */
5596
5597static int
d3da34e0 5598png_load (struct frame *f, struct image *img)
4ef0d4d0
KS
5599{
5600 Lisp_Object file, specified_file;
5601 Lisp_Object specified_data;
5602 int x, y, i;
5603 XImagePtr ximg, mask_img = NULL;
4ef0d4d0
KS
5604 png_struct *png_ptr = NULL;
5605 png_info *info_ptr = NULL, *end_info = NULL;
5606 FILE *volatile fp = NULL;
5607 png_byte sig[8];
5608 png_byte * volatile pixels = NULL;
5609 png_byte ** volatile rows = NULL;
5610 png_uint_32 width, height;
5611 int bit_depth, color_type, interlace_type;
5612 png_byte channels;
5613 png_uint_32 row_bytes;
5614 int transparent_p;
4ef0d4d0
KS
5615 struct png_memory_storage tbr; /* Data to be read */
5616
5617 /* Find out what file to load. */
5618 specified_file = image_spec_value (img->spec, QCfile, NULL);
5619 specified_data = image_spec_value (img->spec, QCdata, NULL);
4ef0d4d0
KS
5620
5621 if (NILP (specified_data))
5622 {
5623 file = x_find_image_file (specified_file);
5624 if (!STRINGP (file))
5625 {
5626 image_error ("Cannot find image file `%s'", specified_file, Qnil);
4ef0d4d0
KS
5627 return 0;
5628 }
5629
5630 /* Open the image file. */
42a5b22f 5631 fp = fopen (SSDATA (file), "rb");
4ef0d4d0
KS
5632 if (!fp)
5633 {
5634 image_error ("Cannot open image file `%s'", file, Qnil);
4ef0d4d0
KS
5635 return 0;
5636 }
5637
5638 /* Check PNG signature. */
5639 if (fread (sig, 1, sizeof sig, fp) != sizeof sig
285d07e2 5640 || fn_png_sig_cmp (sig, 0, sizeof sig))
4ef0d4d0
KS
5641 {
5642 image_error ("Not a PNG file: `%s'", file, Qnil);
4ef0d4d0
KS
5643 fclose (fp);
5644 return 0;
5645 }
5646 }
5647 else
5648 {
7574650a
AS
5649 if (!STRINGP (specified_data))
5650 {
5651 image_error ("Invalid image data `%s'", specified_data, Qnil);
5652 return 0;
5653 }
5654
4ef0d4d0
KS
5655 /* Read from memory. */
5656 tbr.bytes = SDATA (specified_data);
5657 tbr.len = SBYTES (specified_data);
5658 tbr.index = 0;
5659
5660 /* Check PNG signature. */
5661 if (tbr.len < sizeof sig
285d07e2 5662 || fn_png_sig_cmp (tbr.bytes, 0, sizeof sig))
4ef0d4d0
KS
5663 {
5664 image_error ("Not a PNG image: `%s'", img->spec, Qnil);
4ef0d4d0
KS
5665 return 0;
5666 }
5667
5668 /* Need to skip past the signature. */
5669 tbr.bytes += sizeof (sig);
5670 }
5671
df61c790
AS
5672 /* Initialize read and info structs for PNG lib. */
5673 png_ptr = fn_png_create_read_struct (PNG_LIBPNG_VER_STRING,
5674 NULL, my_png_error,
5675 my_png_warning);
4ef0d4d0
KS
5676 if (!png_ptr)
5677 {
5678 if (fp) fclose (fp);
4ef0d4d0
KS
5679 return 0;
5680 }
5681
df61c790 5682 info_ptr = fn_png_create_info_struct (png_ptr);
4ef0d4d0
KS
5683 if (!info_ptr)
5684 {
5685 fn_png_destroy_read_struct (&png_ptr, NULL, NULL);
5686 if (fp) fclose (fp);
4ef0d4d0
KS
5687 return 0;
5688 }
5689
df61c790 5690 end_info = fn_png_create_info_struct (png_ptr);
4ef0d4d0
KS
5691 if (!end_info)
5692 {
5693 fn_png_destroy_read_struct (&png_ptr, &info_ptr, NULL);
5694 if (fp) fclose (fp);
4ef0d4d0
KS
5695 return 0;
5696 }
5697
5698 /* Set error jump-back. We come back here when the PNG library
5699 detects an error. */
7f9c5df9 5700 if (setjmp (PNG_JMPBUF (png_ptr)))
4ef0d4d0
KS
5701 {
5702 error:
5703 if (png_ptr)
5704 fn_png_destroy_read_struct (&png_ptr, &info_ptr, &end_info);
5705 xfree (pixels);
5706 xfree (rows);
5707 if (fp) fclose (fp);
4ef0d4d0
KS
5708 return 0;
5709 }
5710
5711 /* Read image info. */
5712 if (!NILP (specified_data))
5713 fn_png_set_read_fn (png_ptr, (void *) &tbr, png_read_from_memory);
5714 else
9a22a004 5715 fn_png_set_read_fn (png_ptr, (void *) fp, png_read_from_file);
4ef0d4d0
KS
5716
5717 fn_png_set_sig_bytes (png_ptr, sizeof sig);
5718 fn_png_read_info (png_ptr, info_ptr);
5719 fn_png_get_IHDR (png_ptr, info_ptr, &width, &height, &bit_depth, &color_type,
5720 &interlace_type, NULL, NULL);
5721
f1f25b99 5722 if (!check_image_size (f, width, height))
10ea2b82
JR
5723 {
5724 image_error ("Invalid image size (see `max-image-size')", Qnil, Qnil);
5725 goto error;
5726 }
4ef0d4d0
KS
5727 /* If image contains simply transparency data, we prefer to
5728 construct a clipping mask. */
5729 if (fn_png_get_valid (png_ptr, info_ptr, PNG_INFO_tRNS))
5730 transparent_p = 1;
5731 else
5732 transparent_p = 0;
5733
5734 /* This function is easier to write if we only have to handle
5735 one data format: RGB or RGBA with 8 bits per channel. Let's
5736 transform other formats into that format. */
5737
5738 /* Strip more than 8 bits per channel. */
5739 if (bit_depth == 16)
5740 fn_png_set_strip_16 (png_ptr);
5741
5742 /* Expand data to 24 bit RGB, or 8 bit grayscale, with alpha channel
5743 if available. */
5744 fn_png_set_expand (png_ptr);
5745
5746 /* Convert grayscale images to RGB. */
5747 if (color_type == PNG_COLOR_TYPE_GRAY
5748 || color_type == PNG_COLOR_TYPE_GRAY_ALPHA)
5749 fn_png_set_gray_to_rgb (png_ptr);
5750
4ef0d4d0
KS
5751 /* Handle alpha channel by combining the image with a background
5752 color. Do this only if a real alpha channel is supplied. For
5753 simple transparency, we prefer a clipping mask. */
5754 if (!transparent_p)
5755 {
917ac1a9 5756 /* png_color_16 *image_bg; */
4ef0d4d0
KS
5757 Lisp_Object specified_bg
5758 = image_spec_value (img->spec, QCbackground, NULL);
c4f13f44 5759 int shift = (bit_depth == 16) ? 0 : 8;
4ef0d4d0
KS
5760
5761 if (STRINGP (specified_bg))
5762 /* The user specified `:background', use that. */
5763 {
4ef0d4d0 5764 XColor color;
42a5b22f 5765 if (x_defined_color (f, SSDATA (specified_bg), &color, 0))
4ef0d4d0
KS
5766 {
5767 png_color_16 user_bg;
5768
72af86bd 5769 memset (&user_bg, 0, sizeof user_bg);
c4f13f44
CY
5770 user_bg.red = color.red >> shift;
5771 user_bg.green = color.green >> shift;
5772 user_bg.blue = color.blue >> shift;
4ef0d4d0
KS
5773
5774 fn_png_set_background (png_ptr, &user_bg,
5775 PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
5776 }
5777 }
4ef0d4d0
KS
5778 else
5779 {
c4f13f44
CY
5780 /* We use the current frame background, ignoring any default
5781 background color set by the image. */
8b7d0a16 5782#if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI)
4ef0d4d0
KS
5783 XColor color;
5784 png_color_16 frame_background;
5785
5786 color.pixel = FRAME_BACKGROUND_PIXEL (f);
5787 x_query_color (f, &color);
5788
72af86bd 5789 memset (&frame_background, 0, sizeof frame_background);
c4f13f44
CY
5790 frame_background.red = color.red >> shift;
5791 frame_background.green = color.green >> shift;
5792 frame_background.blue = color.blue >> shift;
4ef0d4d0
KS
5793#endif /* HAVE_X_WINDOWS */
5794
4ef0d4d0
KS
5795 fn_png_set_background (png_ptr, &frame_background,
5796 PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
5797 }
5798 }
5799
5800 /* Update info structure. */
5801 fn_png_read_update_info (png_ptr, info_ptr);
5802
5803 /* Get number of channels. Valid values are 1 for grayscale images
5804 and images with a palette, 2 for grayscale images with transparency
5805 information (alpha channel), 3 for RGB images, and 4 for RGB
5806 images with alpha channel, i.e. RGBA. If conversions above were
5807 sufficient we should only have 3 or 4 channels here. */
5808 channels = fn_png_get_channels (png_ptr, info_ptr);
5809 xassert (channels == 3 || channels == 4);
5810
5811 /* Number of bytes needed for one row of the image. */
5812 row_bytes = fn_png_get_rowbytes (png_ptr, info_ptr);
5813
5814 /* Allocate memory for the image. */
5815 pixels = (png_byte *) xmalloc (row_bytes * height * sizeof *pixels);
5816 rows = (png_byte **) xmalloc (height * sizeof *rows);
5817 for (i = 0; i < height; ++i)
5818 rows[i] = pixels + i * row_bytes;
5819
5820 /* Read the entire image. */
5821 fn_png_read_image (png_ptr, rows);
5822 fn_png_read_end (png_ptr, info_ptr);
5823 if (fp)
5824 {
5825 fclose (fp);
5826 fp = NULL;
5827 }
5828
5829 /* Create the X image and pixmap. */
5830 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg,
5831 &img->pixmap))
5832 goto error;
5833
5834 /* Create an image and pixmap serving as mask if the PNG image
5835 contains an alpha channel. */
5836 if (channels == 4
5837 && !transparent_p
5838 && !x_create_x_image_and_pixmap (f, width, height, 1,
5839 &mask_img, &img->mask))
5840 {
5841 x_destroy_x_image (ximg);
5842 Free_Pixmap (FRAME_X_DISPLAY (f), img->pixmap);
5843 img->pixmap = NO_PIXMAP;
5844 goto error;
5845 }
5846
5847 /* Fill the X image and mask from PNG data. */
5848 init_color_table ();
5849
5850 for (y = 0; y < height; ++y)
5851 {
5852 png_byte *p = rows[y];
5853
5854 for (x = 0; x < width; ++x)
5855 {
5856 unsigned r, g, b;
5857
5858 r = *p++ << 8;
5859 g = *p++ << 8;
5860 b = *p++ << 8;
5861 XPutPixel (ximg, x, y, lookup_rgb_color (f, r, g, b));
5862 /* An alpha channel, aka mask channel, associates variable
5863 transparency with an image. Where other image formats
5864 support binary transparency---fully transparent or fully
5865 opaque---PNG allows up to 254 levels of partial transparency.
5866 The PNG library implements partial transparency by combining
5867 the image with a specified background color.
5868
5869 I'm not sure how to handle this here nicely: because the
5870 background on which the image is displayed may change, for
5871 real alpha channel support, it would be necessary to create
5872 a new image for each possible background.
5873
5874 What I'm doing now is that a mask is created if we have
5875 boolean transparency information. Otherwise I'm using
5876 the frame's background color to combine the image with. */
5877
5878 if (channels == 4)
5879 {
5880 if (mask_img)
9ecf6403 5881 XPutPixel (mask_img, x, y, *p > 0 ? PIX_MASK_DRAW : PIX_MASK_RETAIN);
4ef0d4d0
KS
5882 ++p;
5883 }
5884 }
5885 }
5886
5887 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
5888 /* Set IMG's background color from the PNG image, unless the user
5889 overrode it. */
5890 {
5891 png_color_16 *bg;
5892 if (fn_png_get_bKGD (png_ptr, info_ptr, &bg))
5893 {
5894 img->background = lookup_rgb_color (f, bg->red, bg->green, bg->blue);
5895 img->background_valid = 1;
5896 }
5897 }
5898
5899#ifdef COLOR_TABLE_SUPPORT
5900 /* Remember colors allocated for this image. */
5901 img->colors = colors_in_color_table (&img->ncolors);
5902 free_color_table ();
5903#endif /* COLOR_TABLE_SUPPORT */
5904
5905 /* Clean up. */
5906 fn_png_destroy_read_struct (&png_ptr, &info_ptr, &end_info);
5907 xfree (rows);
5908 xfree (pixels);
5909
5910 img->width = width;
5911 img->height = height;
5912
2e09fef1
EZ
5913 /* Maybe fill in the background field while we have ximg handy.
5914 Casting avoids a GCC warning. */
5915 IMAGE_BACKGROUND (img, f, (XImagePtr_or_DC)ximg);
4ef0d4d0
KS
5916
5917 /* Put the image into the pixmap, then free the X image and its buffer. */
5918 x_put_x_image (f, ximg, img->pixmap, width, height);
5919 x_destroy_x_image (ximg);
5920
5921 /* Same for the mask. */
5922 if (mask_img)
5923 {
2e09fef1
EZ
5924 /* Fill in the background_transparent field while we have the
5925 mask handy. Casting avoids a GCC warning. */
5926 image_background_transparent (img, f, (XImagePtr_or_DC)mask_img);
4ef0d4d0
KS
5927
5928 x_put_x_image (f, mask_img, img->mask, img->width, img->height);
5929 x_destroy_x_image (mask_img);
5930 }
5931
4ef0d4d0
KS
5932 return 1;
5933}
5934
5935#else /* HAVE_PNG */
5936
edfda783
AR
5937#ifdef HAVE_NS
5938static int
5939png_load (struct frame *f, struct image *img)
5940{
5941 return ns_load_image(f, img,
5942 image_spec_value (img->spec, QCfile, NULL),
5943 image_spec_value (img->spec, QCdata, NULL));
5944}
5945#endif /* HAVE_NS */
5946
5947
4ef0d4d0
KS
5948#endif /* !HAVE_PNG */
5949
5950
5951\f
5952/***********************************************************************
5953 JPEG
5954 ***********************************************************************/
5955
9e2a2647 5956#if defined (HAVE_JPEG) || defined (HAVE_NS)
4ef0d4d0 5957
f57e2426
J
5958static int jpeg_image_p (Lisp_Object object);
5959static int jpeg_load (struct frame *f, struct image *img);
4ef0d4d0
KS
5960
5961/* The symbol `jpeg' identifying images of this type. */
5962
955cbe7b 5963static Lisp_Object Qjpeg;
4ef0d4d0
KS
5964
5965/* Indices of image specification fields in gs_format, below. */
5966
5967enum jpeg_keyword_index
5968{
5969 JPEG_TYPE,
5970 JPEG_DATA,
5971 JPEG_FILE,
5972 JPEG_ASCENT,
5973 JPEG_MARGIN,
5974 JPEG_RELIEF,
5975 JPEG_ALGORITHM,
5976 JPEG_HEURISTIC_MASK,
5977 JPEG_MASK,
5978 JPEG_BACKGROUND,
5979 JPEG_LAST
5980};
5981
5982/* Vector of image_keyword structures describing the format
5983 of valid user-defined image specifications. */
5984
91433552 5985static const struct image_keyword jpeg_format[JPEG_LAST] =
4ef0d4d0
KS
5986{
5987 {":type", IMAGE_SYMBOL_VALUE, 1},
5988 {":data", IMAGE_STRING_VALUE, 0},
5989 {":file", IMAGE_STRING_VALUE, 0},
5990 {":ascent", IMAGE_ASCENT_VALUE, 0},
5991 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
5992 {":relief", IMAGE_INTEGER_VALUE, 0},
5993 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
5994 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
5995 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
5996 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
5997};
5998
5999/* Structure describing the image type `jpeg'. */
6000
6001static struct image_type jpeg_type =
6002{
6003 &Qjpeg,
6004 jpeg_image_p,
6005 jpeg_load,
6006 x_clear_image,
6007 NULL
6008};
6009
6010/* Return non-zero if OBJECT is a valid JPEG image specification. */
6011
6012static int
d3da34e0 6013jpeg_image_p (Lisp_Object object)
4ef0d4d0
KS
6014{
6015 struct image_keyword fmt[JPEG_LAST];
6016
72af86bd 6017 memcpy (fmt, jpeg_format, sizeof fmt);
4ef0d4d0
KS
6018
6019 if (!parse_image_spec (object, fmt, JPEG_LAST, Qjpeg))
6020 return 0;
6021
6022 /* Must specify either the :data or :file keyword. */
6023 return fmt[JPEG_FILE].count + fmt[JPEG_DATA].count == 1;
6024}
6025
9e2a2647 6026#endif /* HAVE_JPEG || HAVE_NS */
4ef0d4d0
KS
6027
6028#ifdef HAVE_JPEG
6029
6030/* Work around a warning about HAVE_STDLIB_H being redefined in
6031 jconfig.h. */
6032#ifdef HAVE_STDLIB_H
4ef0d4d0
KS
6033#undef HAVE_STDLIB_H
6034#endif /* HAVE_STLIB_H */
6035
66354420 6036#if defined (HAVE_NTGUI) && !defined (__WIN32__)
28893db2
JB
6037/* In older releases of the jpeg library, jpeglib.h will define boolean
6038 differently depending on __WIN32__, so make sure it is defined. */
66354420
JR
6039#define __WIN32__ 1
6040#endif
6041
4ef0d4d0
KS
6042#include <jpeglib.h>
6043#include <jerror.h>
4ef0d4d0
KS
6044
6045#ifdef HAVE_STLIB_H_1
6046#define HAVE_STDLIB_H 1
6047#endif
6048
6049#ifdef HAVE_NTGUI
6050
6051/* JPEG library details. */
14beddf4
CY
6052DEF_IMGLIB_FN (void, jpeg_CreateDecompress, (j_decompress_ptr, int, size_t));
6053DEF_IMGLIB_FN (boolean, jpeg_start_decompress, (j_decompress_ptr));
6054DEF_IMGLIB_FN (boolean, jpeg_finish_decompress, (j_decompress_ptr));
6055DEF_IMGLIB_FN (void, jpeg_destroy_decompress, (j_decompress_ptr));
6056DEF_IMGLIB_FN (int, jpeg_read_header, (j_decompress_ptr, boolean));
6057DEF_IMGLIB_FN (JDIMENSION, jpeg_read_scanlines, (j_decompress_ptr, JSAMPARRAY, JDIMENSION));
6058DEF_IMGLIB_FN (struct jpeg_error_mgr *, jpeg_std_error, (struct jpeg_error_mgr *));
6059DEF_IMGLIB_FN (boolean, jpeg_resync_to_restart, (j_decompress_ptr, int));
4ef0d4d0
KS
6060
6061static int
0855eb52 6062init_jpeg_functions (Lisp_Object libraries)
4ef0d4d0
KS
6063{
6064 HMODULE library;
6065
0855eb52 6066 if (!(library = w32_delayed_load (libraries, Qjpeg)))
4ef0d4d0
KS
6067 return 0;
6068
6069 LOAD_IMGLIB_FN (library, jpeg_finish_decompress);
6070 LOAD_IMGLIB_FN (library, jpeg_read_scanlines);
6071 LOAD_IMGLIB_FN (library, jpeg_start_decompress);
6072 LOAD_IMGLIB_FN (library, jpeg_read_header);
4ef0d4d0
KS
6073 LOAD_IMGLIB_FN (library, jpeg_CreateDecompress);
6074 LOAD_IMGLIB_FN (library, jpeg_destroy_decompress);
6075 LOAD_IMGLIB_FN (library, jpeg_std_error);
6076 LOAD_IMGLIB_FN (library, jpeg_resync_to_restart);
6077 return 1;
6078}
6079
6080/* Wrapper since we can't directly assign the function pointer
6081 to another function pointer that was declared more completely easily. */
6082static boolean
7c3320d8 6083jpeg_resync_to_restart_wrapper (j_decompress_ptr cinfo, int desired)
4ef0d4d0
KS
6084{
6085 return fn_jpeg_resync_to_restart (cinfo, desired);
6086}
6087
6088#else
6089
6090#define fn_jpeg_CreateDecompress(a,b,c) jpeg_create_decompress(a)
6091#define fn_jpeg_start_decompress jpeg_start_decompress
6092#define fn_jpeg_finish_decompress jpeg_finish_decompress
6093#define fn_jpeg_destroy_decompress jpeg_destroy_decompress
6094#define fn_jpeg_read_header jpeg_read_header
6095#define fn_jpeg_read_scanlines jpeg_read_scanlines
4ef0d4d0
KS
6096#define fn_jpeg_std_error jpeg_std_error
6097#define jpeg_resync_to_restart_wrapper jpeg_resync_to_restart
6098
6099#endif /* HAVE_NTGUI */
6100
6101struct my_jpeg_error_mgr
6102{
6103 struct jpeg_error_mgr pub;
6104 jmp_buf setjmp_buffer;
6105};
6106
6107
ec6cf4c6 6108static void my_error_exit (j_common_ptr) NO_RETURN;
4ef0d4d0 6109static void
d3da34e0 6110my_error_exit (j_common_ptr cinfo)
4ef0d4d0
KS
6111{
6112 struct my_jpeg_error_mgr *mgr = (struct my_jpeg_error_mgr *) cinfo->err;
6113 longjmp (mgr->setjmp_buffer, 1);
6114}
6115
6116
6117/* Init source method for JPEG data source manager. Called by
6118 jpeg_read_header() before any data is actually read. See
6119 libjpeg.doc from the JPEG lib distribution. */
6120
6121static void
d3da34e0 6122our_common_init_source (j_decompress_ptr cinfo)
b25a72ab
JB
6123{
6124}
6125
6126
6127/* Method to terminate data source. Called by
6128 jpeg_finish_decompress() after all data has been processed. */
6129
6130static void
d3da34e0 6131our_common_term_source (j_decompress_ptr cinfo)
4ef0d4d0
KS
6132{
6133}
6134
6135
6136/* Fill input buffer method for JPEG data source manager. Called
6137 whenever more data is needed. We read the whole image in one step,
6138 so this only adds a fake end of input marker at the end. */
6139
5a1539f3 6140static JOCTET our_memory_buffer[2];
aca946f3 6141
4ef0d4d0 6142static boolean
d3da34e0 6143our_memory_fill_input_buffer (j_decompress_ptr cinfo)
4ef0d4d0
KS
6144{
6145 /* Insert a fake EOI marker. */
6146 struct jpeg_source_mgr *src = cinfo->src;
4ef0d4d0 6147
5a1539f3
MB
6148 our_memory_buffer[0] = (JOCTET) 0xFF;
6149 our_memory_buffer[1] = (JOCTET) JPEG_EOI;
4ef0d4d0 6150
5a1539f3 6151 src->next_input_byte = our_memory_buffer;
4ef0d4d0 6152 src->bytes_in_buffer = 2;
e0e30823 6153 return 1;
4ef0d4d0
KS
6154}
6155
6156
6157/* Method to skip over NUM_BYTES bytes in the image data. CINFO->src
6158 is the JPEG data source manager. */
6159
6160static void
d3da34e0 6161our_memory_skip_input_data (j_decompress_ptr cinfo, long int num_bytes)
4ef0d4d0
KS
6162{
6163 struct jpeg_source_mgr *src = (struct jpeg_source_mgr *) cinfo->src;
6164
6165 if (src)
6166 {
6167 if (num_bytes > src->bytes_in_buffer)
6168 ERREXIT (cinfo, JERR_INPUT_EOF);
6169
6170 src->bytes_in_buffer -= num_bytes;
6171 src->next_input_byte += num_bytes;
6172 }
6173}
6174
6175
4ef0d4d0
KS
6176/* Set up the JPEG lib for reading an image from DATA which contains
6177 LEN bytes. CINFO is the decompression info structure created for
6178 reading the image. */
6179
6180static void
d3da34e0 6181jpeg_memory_src (j_decompress_ptr cinfo, JOCTET *data, unsigned int len)
4ef0d4d0
KS
6182{
6183 struct jpeg_source_mgr *src;
6184
6185 if (cinfo->src == NULL)
6186 {
6187 /* First time for this JPEG object? */
6188 cinfo->src = (struct jpeg_source_mgr *)
6189 (*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_PERMANENT,
6190 sizeof (struct jpeg_source_mgr));
6191 src = (struct jpeg_source_mgr *) cinfo->src;
6192 src->next_input_byte = data;
6193 }
6194
6195 src = (struct jpeg_source_mgr *) cinfo->src;
b25a72ab
JB
6196 src->init_source = our_common_init_source;
6197 src->fill_input_buffer = our_memory_fill_input_buffer;
6198 src->skip_input_data = our_memory_skip_input_data;
4ef0d4d0 6199 src->resync_to_restart = jpeg_resync_to_restart_wrapper; /* Use default method. */
b25a72ab 6200 src->term_source = our_common_term_source;
4ef0d4d0
KS
6201 src->bytes_in_buffer = len;
6202 src->next_input_byte = data;
6203}
6204
6205
b25a72ab
JB
6206struct jpeg_stdio_mgr
6207{
6208 struct jpeg_source_mgr mgr;
6209 boolean finished;
6210 FILE *file;
6211 JOCTET *buffer;
6212};
6213
6214
6215/* Size of buffer to read JPEG from file.
6216 Not too big, as we want to use alloc_small. */
6217#define JPEG_STDIO_BUFFER_SIZE 8192
6218
6219
6220/* Fill input buffer method for JPEG data source manager. Called
6221 whenever more data is needed. The data is read from a FILE *. */
6222
6223static boolean
d3da34e0 6224our_stdio_fill_input_buffer (j_decompress_ptr cinfo)
b25a72ab
JB
6225{
6226 struct jpeg_stdio_mgr *src;
6227
6228 src = (struct jpeg_stdio_mgr *) cinfo->src;
6229 if (!src->finished)
6230 {
6231 size_t bytes;
6232
6233 bytes = fread (src->buffer, 1, JPEG_STDIO_BUFFER_SIZE, src->file);
6234 if (bytes > 0)
6235 src->mgr.bytes_in_buffer = bytes;
6236 else
6237 {
6238 WARNMS (cinfo, JWRN_JPEG_EOF);
6239 src->finished = 1;
6240 src->buffer[0] = (JOCTET) 0xFF;
6241 src->buffer[1] = (JOCTET) JPEG_EOI;
6242 src->mgr.bytes_in_buffer = 2;
6243 }
6244 src->mgr.next_input_byte = src->buffer;
6245 }
6246
6247 return 1;
6248}
6249
6250
6251/* Method to skip over NUM_BYTES bytes in the image data. CINFO->src
6252 is the JPEG data source manager. */
6253
6254static void
d3da34e0 6255our_stdio_skip_input_data (j_decompress_ptr cinfo, long int num_bytes)
b25a72ab
JB
6256{
6257 struct jpeg_stdio_mgr *src;
6258 src = (struct jpeg_stdio_mgr *) cinfo->src;
6259
6260 while (num_bytes > 0 && !src->finished)
6261 {
6262 if (num_bytes <= src->mgr.bytes_in_buffer)
6263 {
6264 src->mgr.bytes_in_buffer -= num_bytes;
6265 src->mgr.next_input_byte += num_bytes;
6266 break;
6267 }
6268 else
6269 {
6270 num_bytes -= src->mgr.bytes_in_buffer;
6271 src->mgr.bytes_in_buffer = 0;
6272 src->mgr.next_input_byte = NULL;
6273
6274 our_stdio_fill_input_buffer (cinfo);
6275 }
6276 }
6277}
6278
6279
6280/* Set up the JPEG lib for reading an image from a FILE *.
6281 CINFO is the decompression info structure created for
6282 reading the image. */
6283
6284static void
d3da34e0 6285jpeg_file_src (j_decompress_ptr cinfo, FILE *fp)
b25a72ab
JB
6286{
6287 struct jpeg_stdio_mgr *src;
6288
6289 if (cinfo->src != NULL)
6290 src = (struct jpeg_stdio_mgr *) cinfo->src;
6291 else
6292 {
6293 /* First time for this JPEG object? */
6294 cinfo->src = (struct jpeg_source_mgr *)
6295 (*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_PERMANENT,
6296 sizeof (struct jpeg_stdio_mgr));
6297 src = (struct jpeg_stdio_mgr *) cinfo->src;
6298 src->buffer = (JOCTET *)
6299 (*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_PERMANENT,
6300 JPEG_STDIO_BUFFER_SIZE);
6301 }
6302
6303 src->file = fp;
6304 src->finished = 0;
6305 src->mgr.init_source = our_common_init_source;
6306 src->mgr.fill_input_buffer = our_stdio_fill_input_buffer;
6307 src->mgr.skip_input_data = our_stdio_skip_input_data;
6308 src->mgr.resync_to_restart = jpeg_resync_to_restart_wrapper; /* Use default method. */
6309 src->mgr.term_source = our_common_term_source;
6310 src->mgr.bytes_in_buffer = 0;
6311 src->mgr.next_input_byte = NULL;
6312}
6313
6314
4ef0d4d0
KS
6315/* Load image IMG for use on frame F. Patterned after example.c
6316 from the JPEG lib. */
6317
6318static int
d3da34e0 6319jpeg_load (struct frame *f, struct image *img)
4ef0d4d0
KS
6320{
6321 struct jpeg_decompress_struct cinfo;
6322 struct my_jpeg_error_mgr mgr;
6323 Lisp_Object file, specified_file;
6324 Lisp_Object specified_data;
6325 FILE * volatile fp = NULL;
6326 JSAMPARRAY buffer;
6327 int row_stride, x, y;
6328 XImagePtr ximg = NULL;
6329 int rc;
6330 unsigned long *colors;
6331 int width, height;
4ef0d4d0
KS
6332
6333 /* Open the JPEG file. */
6334 specified_file = image_spec_value (img->spec, QCfile, NULL);
6335 specified_data = image_spec_value (img->spec, QCdata, NULL);
4ef0d4d0
KS
6336
6337 if (NILP (specified_data))
6338 {
6339 file = x_find_image_file (specified_file);
6340 if (!STRINGP (file))
6341 {
6342 image_error ("Cannot find image file `%s'", specified_file, Qnil);
4ef0d4d0
KS
6343 return 0;
6344 }
6345
42a5b22f 6346 fp = fopen (SSDATA (file), "rb");
4ef0d4d0
KS
6347 if (fp == NULL)
6348 {
6349 image_error ("Cannot open `%s'", file, Qnil);
4ef0d4d0
KS
6350 return 0;
6351 }
6352 }
7574650a
AS
6353 else if (!STRINGP (specified_data))
6354 {
6355 image_error ("Invalid image data `%s'", specified_data, Qnil);
6356 return 0;
6357 }
4ef0d4d0
KS
6358
6359 /* Customize libjpeg's error handling to call my_error_exit when an
df61c790
AS
6360 error is detected. This function will perform a longjmp. */
6361 cinfo.err = fn_jpeg_std_error (&mgr.pub);
4ef0d4d0
KS
6362 mgr.pub.error_exit = my_error_exit;
6363
6364 if ((rc = setjmp (mgr.setjmp_buffer)) != 0)
6365 {
6366 if (rc == 1)
6367 {
6368 /* Called from my_error_exit. Display a JPEG error. */
6ae141d6
PE
6369 char buf[JMSG_LENGTH_MAX];
6370 cinfo.err->format_message ((j_common_ptr) &cinfo, buf);
4ef0d4d0 6371 image_error ("Error reading JPEG image `%s': %s", img->spec,
6ae141d6 6372 build_string (buf));
4ef0d4d0
KS
6373 }
6374
6375 /* Close the input file and destroy the JPEG object. */
6376 if (fp)
6377 fclose ((FILE *) fp);
6378 fn_jpeg_destroy_decompress (&cinfo);
6379
6380 /* If we already have an XImage, free that. */
6381 x_destroy_x_image (ximg);
6382
6383 /* Free pixmap and colors. */
6384 x_clear_image (f, img);
4ef0d4d0
KS
6385 return 0;
6386 }
6387
6388 /* Create the JPEG decompression object. Let it read from fp.
6389 Read the JPEG image header. */
6390 fn_jpeg_CreateDecompress (&cinfo, JPEG_LIB_VERSION, sizeof (cinfo));
6391
6392 if (NILP (specified_data))
b25a72ab 6393 jpeg_file_src (&cinfo, (FILE *) fp);
4ef0d4d0
KS
6394 else
6395 jpeg_memory_src (&cinfo, SDATA (specified_data),
6396 SBYTES (specified_data));
6397
e0e30823 6398 fn_jpeg_read_header (&cinfo, 1);
4ef0d4d0
KS
6399
6400 /* Customize decompression so that color quantization will be used.
6401 Start decompression. */
e0e30823 6402 cinfo.quantize_colors = 1;
4ef0d4d0
KS
6403 fn_jpeg_start_decompress (&cinfo);
6404 width = img->width = cinfo.output_width;
6405 height = img->height = cinfo.output_height;
6406
f1f25b99
CY
6407 if (!check_image_size (f, width, height))
6408 {
10ea2b82 6409 image_error ("Invalid image size (see `max-image-size')", Qnil, Qnil);
f1f25b99
CY
6410 longjmp (mgr.setjmp_buffer, 2);
6411 }
6412
4ef0d4d0
KS
6413 /* Create X image and pixmap. */
6414 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
6415 longjmp (mgr.setjmp_buffer, 2);
6416
6417 /* Allocate colors. When color quantization is used,
6418 cinfo.actual_number_of_colors has been set with the number of
6419 colors generated, and cinfo.colormap is a two-dimensional array
6420 of color indices in the range 0..cinfo.actual_number_of_colors.
6421 No more than 255 colors will be generated. */
6422 {
6423 int i, ir, ig, ib;
6424
6425 if (cinfo.out_color_components > 2)
6426 ir = 0, ig = 1, ib = 2;
6427 else if (cinfo.out_color_components > 1)
6428 ir = 0, ig = 1, ib = 0;
6429 else
6430 ir = 0, ig = 0, ib = 0;
6431
6432 /* Use the color table mechanism because it handles colors that
6433 cannot be allocated nicely. Such colors will be replaced with
6434 a default color, and we don't have to care about which colors
6435 can be freed safely, and which can't. */
6436 init_color_table ();
6437 colors = (unsigned long *) alloca (cinfo.actual_number_of_colors
6438 * sizeof *colors);
6439
6440 for (i = 0; i < cinfo.actual_number_of_colors; ++i)
6441 {
6442 /* Multiply RGB values with 255 because X expects RGB values
6443 in the range 0..0xffff. */
6444 int r = cinfo.colormap[ir][i] << 8;
6445 int g = cinfo.colormap[ig][i] << 8;
6446 int b = cinfo.colormap[ib][i] << 8;
6447 colors[i] = lookup_rgb_color (f, r, g, b);
6448 }
6449
6450#ifdef COLOR_TABLE_SUPPORT
6451 /* Remember those colors actually allocated. */
6452 img->colors = colors_in_color_table (&img->ncolors);
6453 free_color_table ();
6454#endif /* COLOR_TABLE_SUPPORT */
6455 }
6456
6457 /* Read pixels. */
6458 row_stride = width * cinfo.output_components;
6459 buffer = cinfo.mem->alloc_sarray ((j_common_ptr) &cinfo, JPOOL_IMAGE,
6460 row_stride, 1);
6461 for (y = 0; y < height; ++y)
6462 {
6463 fn_jpeg_read_scanlines (&cinfo, buffer, 1);
6464 for (x = 0; x < cinfo.output_width; ++x)
6465 XPutPixel (ximg, x, y, colors[buffer[0][x]]);
6466 }
6467
6468 /* Clean up. */
6469 fn_jpeg_finish_decompress (&cinfo);
6470 fn_jpeg_destroy_decompress (&cinfo);
6471 if (fp)
6472 fclose ((FILE *) fp);
6473
6474 /* Maybe fill in the background field while we have ximg handy. */
6475 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
2e09fef1
EZ
6476 /* Casting avoids a GCC warning. */
6477 IMAGE_BACKGROUND (img, f, (XImagePtr_or_DC)ximg);
4ef0d4d0
KS
6478
6479 /* Put the image into the pixmap. */
6480 x_put_x_image (f, ximg, img->pixmap, width, height);
6481 x_destroy_x_image (ximg);
4ef0d4d0
KS
6482 return 1;
6483}
6484
6485#else /* HAVE_JPEG */
6486
edfda783
AR
6487#ifdef HAVE_NS
6488static int
6489jpeg_load (struct frame *f, struct image *img)
6490{
ed3751c8
JB
6491 return ns_load_image (f, img,
6492 image_spec_value (img->spec, QCfile, NULL),
6493 image_spec_value (img->spec, QCdata, NULL));
edfda783
AR
6494}
6495#endif /* HAVE_NS */
6496
4ef0d4d0
KS
6497#endif /* !HAVE_JPEG */
6498
6499
6500\f
6501/***********************************************************************
6502 TIFF
6503 ***********************************************************************/
6504
9e2a2647 6505#if defined (HAVE_TIFF) || defined (HAVE_NS)
4ef0d4d0 6506
f57e2426
J
6507static int tiff_image_p (Lisp_Object object);
6508static int tiff_load (struct frame *f, struct image *img);
4ef0d4d0
KS
6509
6510/* The symbol `tiff' identifying images of this type. */
6511
955cbe7b 6512static Lisp_Object Qtiff;
4ef0d4d0
KS
6513
6514/* Indices of image specification fields in tiff_format, below. */
6515
6516enum tiff_keyword_index
6517{
6518 TIFF_TYPE,
6519 TIFF_DATA,
6520 TIFF_FILE,
6521 TIFF_ASCENT,
6522 TIFF_MARGIN,
6523 TIFF_RELIEF,
6524 TIFF_ALGORITHM,
6525 TIFF_HEURISTIC_MASK,
6526 TIFF_MASK,
6527 TIFF_BACKGROUND,
58279503 6528 TIFF_INDEX,
4ef0d4d0
KS
6529 TIFF_LAST
6530};
6531
6532/* Vector of image_keyword structures describing the format
6533 of valid user-defined image specifications. */
6534
91433552 6535static const struct image_keyword tiff_format[TIFF_LAST] =
4ef0d4d0
KS
6536{
6537 {":type", IMAGE_SYMBOL_VALUE, 1},
6538 {":data", IMAGE_STRING_VALUE, 0},
6539 {":file", IMAGE_STRING_VALUE, 0},
6540 {":ascent", IMAGE_ASCENT_VALUE, 0},
6541 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
6542 {":relief", IMAGE_INTEGER_VALUE, 0},
6543 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6544 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6545 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
58279503
JR
6546 {":background", IMAGE_STRING_OR_NIL_VALUE, 0},
6547 {":index", IMAGE_NON_NEGATIVE_INTEGER_VALUE, 0}
4ef0d4d0
KS
6548};
6549
6550/* Structure describing the image type `tiff'. */
6551
6552static struct image_type tiff_type =
6553{
6554 &Qtiff,
6555 tiff_image_p,
6556 tiff_load,
6557 x_clear_image,
6558 NULL
6559};
6560
6561/* Return non-zero if OBJECT is a valid TIFF image specification. */
6562
6563static int
d3da34e0 6564tiff_image_p (Lisp_Object object)
4ef0d4d0
KS
6565{
6566 struct image_keyword fmt[TIFF_LAST];
72af86bd 6567 memcpy (fmt, tiff_format, sizeof fmt);
4ef0d4d0
KS
6568
6569 if (!parse_image_spec (object, fmt, TIFF_LAST, Qtiff))
6570 return 0;
6571
6572 /* Must specify either the :data or :file keyword. */
6573 return fmt[TIFF_FILE].count + fmt[TIFF_DATA].count == 1;
6574}
6575
9e2a2647 6576#endif /* HAVE_TIFF || HAVE_NS */
4ef0d4d0
KS
6577
6578#ifdef HAVE_TIFF
6579
6580#include <tiffio.h>
6581
6582#ifdef HAVE_NTGUI
6583
6584/* TIFF library details. */
14beddf4
CY
6585DEF_IMGLIB_FN (TIFFErrorHandler, TIFFSetErrorHandler, (TIFFErrorHandler));
6586DEF_IMGLIB_FN (TIFFErrorHandler, TIFFSetWarningHandler, (TIFFErrorHandler));
6587DEF_IMGLIB_FN (TIFF *, TIFFOpen, (const char *, const char *));
6588DEF_IMGLIB_FN (TIFF *, TIFFClientOpen, (const char *, const char *, thandle_t,
850690cc
JB
6589 TIFFReadWriteProc, TIFFReadWriteProc,
6590 TIFFSeekProc, TIFFCloseProc, TIFFSizeProc,
6591 TIFFMapFileProc, TIFFUnmapFileProc));
14beddf4
CY
6592DEF_IMGLIB_FN (int, TIFFGetField, (TIFF *, ttag_t, ...));
6593DEF_IMGLIB_FN (int, TIFFReadRGBAImage, (TIFF *, uint32, uint32, uint32 *, int));
6594DEF_IMGLIB_FN (void, TIFFClose, (TIFF *));
6595DEF_IMGLIB_FN (int, TIFFSetDirectory, (TIFF *, tdir_t));
4ef0d4d0
KS
6596
6597static int
0855eb52 6598init_tiff_functions (Lisp_Object libraries)
4ef0d4d0
KS
6599{
6600 HMODULE library;
6601
0855eb52 6602 if (!(library = w32_delayed_load (libraries, Qtiff)))
4ef0d4d0
KS
6603 return 0;
6604
6605 LOAD_IMGLIB_FN (library, TIFFSetErrorHandler);
6606 LOAD_IMGLIB_FN (library, TIFFSetWarningHandler);
6607 LOAD_IMGLIB_FN (library, TIFFOpen);
6608 LOAD_IMGLIB_FN (library, TIFFClientOpen);
6609 LOAD_IMGLIB_FN (library, TIFFGetField);
6610 LOAD_IMGLIB_FN (library, TIFFReadRGBAImage);
6611 LOAD_IMGLIB_FN (library, TIFFClose);
58279503 6612 LOAD_IMGLIB_FN (library, TIFFSetDirectory);
4ef0d4d0
KS
6613 return 1;
6614}
6615
6616#else
6617
6618#define fn_TIFFSetErrorHandler TIFFSetErrorHandler
6619#define fn_TIFFSetWarningHandler TIFFSetWarningHandler
6620#define fn_TIFFOpen TIFFOpen
6621#define fn_TIFFClientOpen TIFFClientOpen
6622#define fn_TIFFGetField TIFFGetField
6623#define fn_TIFFReadRGBAImage TIFFReadRGBAImage
6624#define fn_TIFFClose TIFFClose
58279503 6625#define fn_TIFFSetDirectory TIFFSetDirectory
4ef0d4d0
KS
6626#endif /* HAVE_NTGUI */
6627
6628
6629/* Reading from a memory buffer for TIFF images Based on the PNG
6630 memory source, but we have to provide a lot of extra functions.
6631 Blah.
6632
6633 We really only need to implement read and seek, but I am not
6634 convinced that the TIFF library is smart enough not to destroy
6635 itself if we only hand it the function pointers we need to
6636 override. */
6637
6638typedef struct
6639{
6640 unsigned char *bytes;
6641 size_t len;
6642 int index;
6643}
6644tiff_memory_source;
6645
6646static size_t
d3da34e0 6647tiff_read_from_memory (thandle_t data, tdata_t buf, tsize_t size)
4ef0d4d0
KS
6648{
6649 tiff_memory_source *src = (tiff_memory_source *) data;
6650
6651 if (size > src->len - src->index)
6652 return (size_t) -1;
72af86bd 6653 memcpy (buf, src->bytes + src->index, size);
4ef0d4d0
KS
6654 src->index += size;
6655 return size;
6656}
6657
6658static size_t
d3da34e0 6659tiff_write_from_memory (thandle_t data, tdata_t buf, tsize_t size)
4ef0d4d0
KS
6660{
6661 return (size_t) -1;
6662}
6663
6664static toff_t
d3da34e0 6665tiff_seek_in_memory (thandle_t data, toff_t off, int whence)
4ef0d4d0
KS
6666{
6667 tiff_memory_source *src = (tiff_memory_source *) data;
6668 int idx;
6669
6670 switch (whence)
6671 {
6672 case SEEK_SET: /* Go from beginning of source. */
6673 idx = off;
6674 break;
6675
6676 case SEEK_END: /* Go from end of source. */
6677 idx = src->len + off;
6678 break;
6679
6680 case SEEK_CUR: /* Go from current position. */
6681 idx = src->index + off;
6682 break;
6683
6684 default: /* Invalid `whence'. */
6685 return -1;
6686 }
6687
6688 if (idx > src->len || idx < 0)
6689 return -1;
6690
6691 src->index = idx;
6692 return src->index;
6693}
6694
6695static int
d3da34e0 6696tiff_close_memory (thandle_t data)
4ef0d4d0
KS
6697{
6698 /* NOOP */
6699 return 0;
6700}
6701
6702static int
d3da34e0 6703tiff_mmap_memory (thandle_t data, tdata_t *pbase, toff_t *psize)
4ef0d4d0
KS
6704{
6705 /* It is already _IN_ memory. */
6706 return 0;
6707}
6708
6709static void
d3da34e0 6710tiff_unmap_memory (thandle_t data, tdata_t base, toff_t size)
4ef0d4d0
KS
6711{
6712 /* We don't need to do this. */
6713}
6714
6715static toff_t
d3da34e0 6716tiff_size_of_memory (thandle_t data)
4ef0d4d0
KS
6717{
6718 return ((tiff_memory_source *) data)->len;
6719}
6720
6721
5e2d4a30
PE
6722static void tiff_error_handler (const char *, const char *, va_list)
6723 ATTRIBUTE_FORMAT_PRINTF (2, 0);
4ef0d4d0 6724static void
d3da34e0 6725tiff_error_handler (const char *title, const char *format, va_list ap)
4ef0d4d0
KS
6726{
6727 char buf[512];
6728 int len;
6729
6730 len = sprintf (buf, "TIFF error: %s ", title);
6731 vsprintf (buf + len, format, ap);
6732 add_to_log (buf, Qnil, Qnil);
6733}
6734
6735
5e2d4a30
PE
6736static void tiff_warning_handler (const char *, const char *, va_list)
6737 ATTRIBUTE_FORMAT_PRINTF (2, 0);
4ef0d4d0 6738static void
d3da34e0 6739tiff_warning_handler (const char *title, const char *format, va_list ap)
4ef0d4d0
KS
6740{
6741 char buf[512];
6742 int len;
6743
6744 len = sprintf (buf, "TIFF warning: %s ", title);
6745 vsprintf (buf + len, format, ap);
6746 add_to_log (buf, Qnil, Qnil);
6747}
6748
6749
6750/* Load TIFF image IMG for use on frame F. Value is non-zero if
6751 successful. */
6752
6753static int
d3da34e0 6754tiff_load (struct frame *f, struct image *img)
4ef0d4d0
KS
6755{
6756 Lisp_Object file, specified_file;
6757 Lisp_Object specified_data;
6758 TIFF *tiff;
58279503 6759 int width, height, x, y, count;
4ef0d4d0 6760 uint32 *buf;
03d0a109 6761 int rc;
4ef0d4d0 6762 XImagePtr ximg;
4ef0d4d0 6763 tiff_memory_source memsrc;
58279503 6764 Lisp_Object image;
4ef0d4d0
KS
6765
6766 specified_file = image_spec_value (img->spec, QCfile, NULL);
6767 specified_data = image_spec_value (img->spec, QCdata, NULL);
4ef0d4d0 6768
5e2d4a30
PE
6769 fn_TIFFSetErrorHandler ((TIFFErrorHandler) tiff_error_handler);
6770 fn_TIFFSetWarningHandler ((TIFFErrorHandler) tiff_warning_handler);
4ef0d4d0
KS
6771
6772 if (NILP (specified_data))
6773 {
6774 /* Read from a file */
6775 file = x_find_image_file (specified_file);
6776 if (!STRINGP (file))
6777 {
6778 image_error ("Cannot find image file `%s'", specified_file, Qnil);
4ef0d4d0
KS
6779 return 0;
6780 }
6781
df61c790 6782 /* Try to open the image file. */
b19beacc 6783 tiff = fn_TIFFOpen (SSDATA (file), "r");
4ef0d4d0
KS
6784 if (tiff == NULL)
6785 {
6786 image_error ("Cannot open `%s'", file, Qnil);
4ef0d4d0
KS
6787 return 0;
6788 }
6789 }
6790 else
6791 {
7574650a
AS
6792 if (!STRINGP (specified_data))
6793 {
6794 image_error ("Invalid image data `%s'", specified_data, Qnil);
6795 return 0;
6796 }
6797
4ef0d4d0
KS
6798 /* Memory source! */
6799 memsrc.bytes = SDATA (specified_data);
6800 memsrc.len = SBYTES (specified_data);
6801 memsrc.index = 0;
6802
3082f617 6803 tiff = fn_TIFFClientOpen ("memory_source", "r", (thandle_t)&memsrc,
df61c790
AS
6804 (TIFFReadWriteProc) tiff_read_from_memory,
6805 (TIFFReadWriteProc) tiff_write_from_memory,
6806 tiff_seek_in_memory,
6807 tiff_close_memory,
6808 tiff_size_of_memory,
6809 tiff_mmap_memory,
6810 tiff_unmap_memory);
4ef0d4d0
KS
6811
6812 if (!tiff)
6813 {
6814 image_error ("Cannot open memory source for `%s'", img->spec, Qnil);
4ef0d4d0
KS
6815 return 0;
6816 }
6817 }
6818
58279503
JR
6819 image = image_spec_value (img->spec, QCindex, NULL);
6820 if (INTEGERP (image))
6821 {
6822 int ino = XFASTINT (image);
6823 if (!fn_TIFFSetDirectory (tiff, ino))
6824 {
6825 image_error ("Invalid image number `%s' in image `%s'",
6826 image, img->spec);
6827 fn_TIFFClose (tiff);
58279503
JR
6828 return 0;
6829 }
6830 }
6831
4ef0d4d0
KS
6832 /* Get width and height of the image, and allocate a raster buffer
6833 of width x height 32-bit values. */
6834 fn_TIFFGetField (tiff, TIFFTAG_IMAGEWIDTH, &width);
6835 fn_TIFFGetField (tiff, TIFFTAG_IMAGELENGTH, &height);
f1f25b99
CY
6836
6837 if (!check_image_size (f, width, height))
6838 {
10ea2b82 6839 image_error ("Invalid image size (see `max-image-size')", Qnil, Qnil);
58279503 6840 fn_TIFFClose (tiff);
f1f25b99
CY
6841 return 0;
6842 }
6843
4ef0d4d0
KS
6844 buf = (uint32 *) xmalloc (width * height * sizeof *buf);
6845
6846 rc = fn_TIFFReadRGBAImage (tiff, width, height, buf, 0);
58279503
JR
6847
6848 /* Count the number of images in the file. */
03d0a109
PE
6849 for (count = 1; fn_TIFFSetDirectory (tiff, count); count++)
6850 continue;
58279503
JR
6851
6852 if (count > 1)
6853 img->data.lisp_val = Fcons (Qcount,
6854 Fcons (make_number (count),
6855 img->data.lisp_val));
6856
4ef0d4d0
KS
6857 fn_TIFFClose (tiff);
6858 if (!rc)
6859 {
6860 image_error ("Error reading TIFF image `%s'", img->spec, Qnil);
6861 xfree (buf);
4ef0d4d0
KS
6862 return 0;
6863 }
6864
6865 /* Create the X image and pixmap. */
6866 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
6867 {
6868 xfree (buf);
4ef0d4d0
KS
6869 return 0;
6870 }
6871
6872 /* Initialize the color table. */
6873 init_color_table ();
6874
6875 /* Process the pixel raster. Origin is in the lower-left corner. */
6876 for (y = 0; y < height; ++y)
6877 {
6878 uint32 *row = buf + y * width;
6879
6880 for (x = 0; x < width; ++x)
6881 {
6882 uint32 abgr = row[x];
6883 int r = TIFFGetR (abgr) << 8;
6884 int g = TIFFGetG (abgr) << 8;
6885 int b = TIFFGetB (abgr) << 8;
6886 XPutPixel (ximg, x, height - 1 - y, lookup_rgb_color (f, r, g, b));
6887 }
6888 }
6889
6890#ifdef COLOR_TABLE_SUPPORT
6891 /* Remember the colors allocated for the image. Free the color table. */
6892 img->colors = colors_in_color_table (&img->ncolors);
6893 free_color_table ();
6894#endif /* COLOR_TABLE_SUPPORT */
6895
6896 img->width = width;
6897 img->height = height;
6898
6899 /* Maybe fill in the background field while we have ximg handy. */
6900 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
2e09fef1
EZ
6901 /* Casting avoids a GCC warning on W32. */
6902 IMAGE_BACKGROUND (img, f, (XImagePtr_or_DC)ximg);
4ef0d4d0
KS
6903
6904 /* Put the image into the pixmap, then free the X image and its buffer. */
6905 x_put_x_image (f, ximg, img->pixmap, width, height);
6906 x_destroy_x_image (ximg);
6907 xfree (buf);
6908
4ef0d4d0
KS
6909 return 1;
6910}
6911
6912#else /* HAVE_TIFF */
6913
edfda783
AR
6914#ifdef HAVE_NS
6915static int
6916tiff_load (struct frame *f, struct image *img)
6917{
ed3751c8
JB
6918 return ns_load_image (f, img,
6919 image_spec_value (img->spec, QCfile, NULL),
6920 image_spec_value (img->spec, QCdata, NULL));
edfda783
AR
6921}
6922#endif /* HAVE_NS */
6923
4ef0d4d0
KS
6924#endif /* !HAVE_TIFF */
6925
6926
6927\f
6928/***********************************************************************
6929 GIF
6930 ***********************************************************************/
6931
9e2a2647 6932#if defined (HAVE_GIF) || defined (HAVE_NS)
4ef0d4d0 6933
f57e2426
J
6934static int gif_image_p (Lisp_Object object);
6935static int gif_load (struct frame *f, struct image *img);
6936static void gif_clear_image (struct frame *f, struct image *img);
4ef0d4d0
KS
6937
6938/* The symbol `gif' identifying images of this type. */
6939
955cbe7b 6940static Lisp_Object Qgif;
4ef0d4d0
KS
6941
6942/* Indices of image specification fields in gif_format, below. */
6943
6944enum gif_keyword_index
6945{
6946 GIF_TYPE,
6947 GIF_DATA,
6948 GIF_FILE,
6949 GIF_ASCENT,
6950 GIF_MARGIN,
6951 GIF_RELIEF,
6952 GIF_ALGORITHM,
6953 GIF_HEURISTIC_MASK,
6954 GIF_MASK,
6955 GIF_IMAGE,
6956 GIF_BACKGROUND,
6957 GIF_LAST
6958};
6959
6960/* Vector of image_keyword structures describing the format
6961 of valid user-defined image specifications. */
6962
91433552 6963static const struct image_keyword gif_format[GIF_LAST] =
4ef0d4d0
KS
6964{
6965 {":type", IMAGE_SYMBOL_VALUE, 1},
6966 {":data", IMAGE_STRING_VALUE, 0},
6967 {":file", IMAGE_STRING_VALUE, 0},
6968 {":ascent", IMAGE_ASCENT_VALUE, 0},
6969 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
6970 {":relief", IMAGE_INTEGER_VALUE, 0},
6971 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6972 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6973 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
58279503 6974 {":index", IMAGE_NON_NEGATIVE_INTEGER_VALUE, 0},
4ef0d4d0
KS
6975 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
6976};
6977
6978/* Structure describing the image type `gif'. */
6979
6980static struct image_type gif_type =
6981{
6982 &Qgif,
6983 gif_image_p,
6984 gif_load,
6ac3c7bb 6985 gif_clear_image,
4ef0d4d0
KS
6986 NULL
6987};
6988
6ac3c7bb
KS
6989/* Free X resources of GIF image IMG which is used on frame F. */
6990
6991static void
d3da34e0 6992gif_clear_image (struct frame *f, struct image *img)
6ac3c7bb 6993{
1546c559 6994 /* IMG->data.ptr_val may contain metadata with extension data. */
6ac3c7bb
KS
6995 img->data.lisp_val = Qnil;
6996 x_clear_image (f, img);
6997}
6998
4ef0d4d0
KS
6999/* Return non-zero if OBJECT is a valid GIF image specification. */
7000
7001static int
d3da34e0 7002gif_image_p (Lisp_Object object)
4ef0d4d0
KS
7003{
7004 struct image_keyword fmt[GIF_LAST];
72af86bd 7005 memcpy (fmt, gif_format, sizeof fmt);
4ef0d4d0
KS
7006
7007 if (!parse_image_spec (object, fmt, GIF_LAST, Qgif))
7008 return 0;
7009
7010 /* Must specify either the :data or :file keyword. */
7011 return fmt[GIF_FILE].count + fmt[GIF_DATA].count == 1;
7012}
7013
9e2a2647 7014#endif /* HAVE_GIF */
4ef0d4d0
KS
7015
7016#ifdef HAVE_GIF
7017
9e2a2647 7018#if defined (HAVE_NTGUI)
2e09fef1
EZ
7019/* winuser.h might define DrawText to DrawTextA or DrawTextW.
7020 Undefine before redefining to avoid a preprocessor warning. */
7021#ifdef DrawText
7022#undef DrawText
7023#endif
4ef0d4d0
KS
7024/* avoid conflict with QuickdrawText.h */
7025#define DrawText gif_DrawText
7026#include <gif_lib.h>
7027#undef DrawText
7028
9e2a2647 7029#else /* HAVE_NTGUI */
4ef0d4d0
KS
7030
7031#include <gif_lib.h>
7032
9e2a2647 7033#endif /* HAVE_NTGUI */
4ef0d4d0
KS
7034
7035
7036#ifdef HAVE_NTGUI
7037
7038/* GIF library details. */
14beddf4
CY
7039DEF_IMGLIB_FN (int, DGifCloseFile, (GifFileType *));
7040DEF_IMGLIB_FN (int, DGifSlurp, (GifFileType *));
7041DEF_IMGLIB_FN (GifFileType *, DGifOpen, (void *, InputFunc));
7042DEF_IMGLIB_FN (GifFileType *, DGifOpenFileName, (const char *));
4ef0d4d0
KS
7043
7044static int
0855eb52 7045init_gif_functions (Lisp_Object libraries)
4ef0d4d0
KS
7046{
7047 HMODULE library;
7048
0855eb52 7049 if (!(library = w32_delayed_load (libraries, Qgif)))
4ef0d4d0
KS
7050 return 0;
7051
7052 LOAD_IMGLIB_FN (library, DGifCloseFile);
7053 LOAD_IMGLIB_FN (library, DGifSlurp);
7054 LOAD_IMGLIB_FN (library, DGifOpen);
7055 LOAD_IMGLIB_FN (library, DGifOpenFileName);
7056 return 1;
7057}
7058
7059#else
7060
7061#define fn_DGifCloseFile DGifCloseFile
7062#define fn_DGifSlurp DGifSlurp
7063#define fn_DGifOpen DGifOpen
7064#define fn_DGifOpenFileName DGifOpenFileName
7065
7066#endif /* HAVE_NTGUI */
7067
7068/* Reading a GIF image from memory
7069 Based on the PNG memory stuff to a certain extent. */
7070
7071typedef struct
7072{
7073 unsigned char *bytes;
7074 size_t len;
7075 int index;
7076}
7077gif_memory_source;
7078
7079/* Make the current memory source available to gif_read_from_memory.
7080 It's done this way because not all versions of libungif support
7081 a UserData field in the GifFileType structure. */
7082static gif_memory_source *current_gif_memory_src;
7083
7084static int
d3da34e0 7085gif_read_from_memory (GifFileType *file, GifByteType *buf, int len)
4ef0d4d0
KS
7086{
7087 gif_memory_source *src = current_gif_memory_src;
7088
7089 if (len > src->len - src->index)
7090 return -1;
7091
72af86bd 7092 memcpy (buf, src->bytes + src->index, len);
4ef0d4d0
KS
7093 src->index += len;
7094 return len;
7095}
7096
7097
7098/* Load GIF image IMG for use on frame F. Value is non-zero if
7099 successful. */
7100
91433552
DN
7101static const int interlace_start[] = {0, 4, 2, 1};
7102static const int interlace_increment[] = {8, 8, 4, 2};
aca946f3 7103
17c0c952
JD
7104#define GIF_LOCAL_DESCRIPTOR_EXTENSION 249
7105
4ef0d4d0 7106static int
d3da34e0 7107gif_load (struct frame *f, struct image *img)
4ef0d4d0
KS
7108{
7109 Lisp_Object file, specified_file;
7110 Lisp_Object specified_data;
7111 int rc, width, height, x, y, i;
f0c77cd1 7112 boolean transparent_p = 0;
4ef0d4d0
KS
7113 XImagePtr ximg;
7114 ColorMapObject *gif_color_map;
7115 unsigned long pixel_colors[256];
7116 GifFileType *gif;
4ef0d4d0 7117 Lisp_Object image;
6ac3c7bb 7118 int ino, image_height, image_width;
4ef0d4d0
KS
7119 gif_memory_source memsrc;
7120 unsigned char *raster;
f0c77cd1 7121 unsigned int transparency_color_index IF_LINT (= 0);
4ef0d4d0
KS
7122
7123 specified_file = image_spec_value (img->spec, QCfile, NULL);
7124 specified_data = image_spec_value (img->spec, QCdata, NULL);
4ef0d4d0
KS
7125
7126 if (NILP (specified_data))
7127 {
7128 file = x_find_image_file (specified_file);
7129 if (!STRINGP (file))
7130 {
7131 image_error ("Cannot find image file `%s'", specified_file, Qnil);
4ef0d4d0
KS
7132 return 0;
7133 }
7134
df61c790 7135 /* Open the GIF file. */
2037898d 7136 gif = fn_DGifOpenFileName (SSDATA (file));
4ef0d4d0
KS
7137 if (gif == NULL)
7138 {
7139 image_error ("Cannot open `%s'", file, Qnil);
4ef0d4d0
KS
7140 return 0;
7141 }
7142 }
7143 else
7144 {
7574650a
AS
7145 if (!STRINGP (specified_data))
7146 {
7147 image_error ("Invalid image data `%s'", specified_data, Qnil);
7148 return 0;
7149 }
7150
4ef0d4d0
KS
7151 /* Read from memory! */
7152 current_gif_memory_src = &memsrc;
7153 memsrc.bytes = SDATA (specified_data);
7154 memsrc.len = SBYTES (specified_data);
7155 memsrc.index = 0;
7156
df61c790 7157 gif = fn_DGifOpen (&memsrc, gif_read_from_memory);
4ef0d4d0
KS
7158 if (!gif)
7159 {
7160 image_error ("Cannot open memory source `%s'", img->spec, Qnil);
4ef0d4d0
KS
7161 return 0;
7162 }
7163 }
7164
f1f25b99
CY
7165 /* Before reading entire contents, check the declared image size. */
7166 if (!check_image_size (f, gif->SWidth, gif->SHeight))
7167 {
10ea2b82 7168 image_error ("Invalid image size (see `max-image-size')", Qnil, Qnil);
f1f25b99 7169 fn_DGifCloseFile (gif);
f1f25b99
CY
7170 return 0;
7171 }
7172
4ef0d4d0
KS
7173 /* Read entire contents. */
7174 rc = fn_DGifSlurp (gif);
7175 if (rc == GIF_ERROR)
7176 {
7177 image_error ("Error reading `%s'", img->spec, Qnil);
7178 fn_DGifCloseFile (gif);
4ef0d4d0
KS
7179 return 0;
7180 }
7181
7182 image = image_spec_value (img->spec, QCindex, NULL);
7183 ino = INTEGERP (image) ? XFASTINT (image) : 0;
7184 if (ino >= gif->ImageCount)
7185 {
7186 image_error ("Invalid image number `%s' in image `%s'",
7187 image, img->spec);
7188 fn_DGifCloseFile (gif);
4ef0d4d0
KS
7189 return 0;
7190 }
7191
17c0c952
JD
7192 for (i = 0; i < gif->SavedImages[ino].ExtensionBlockCount; i++)
7193 if ((gif->SavedImages[ino].ExtensionBlocks[i].Function
7194 == GIF_LOCAL_DESCRIPTOR_EXTENSION)
7195 && gif->SavedImages[ino].ExtensionBlocks[i].ByteCount == 4
7196 /* Transparency enabled? */
7197 && gif->SavedImages[ino].ExtensionBlocks[i].Bytes[0] & 1)
7198 {
7199 transparent_p = 1;
7200 transparency_color_index
7201 = (unsigned char) gif->SavedImages[ino].ExtensionBlocks[i].Bytes[3];
7202 }
7203
6ac3c7bb
KS
7204 img->corners[TOP_CORNER] = gif->SavedImages[ino].ImageDesc.Top;
7205 img->corners[LEFT_CORNER] = gif->SavedImages[ino].ImageDesc.Left;
0f4aca46 7206 image_height = gif->SavedImages[ino].ImageDesc.Height;
6ac3c7bb
KS
7207 img->corners[BOT_CORNER] = img->corners[TOP_CORNER] + image_height;
7208 image_width = gif->SavedImages[ino].ImageDesc.Width;
7209 img->corners[RIGHT_CORNER] = img->corners[LEFT_CORNER] + image_width;
0f4aca46
KS
7210
7211 width = img->width = max (gif->SWidth,
7212 max (gif->Image.Left + gif->Image.Width,
6ac3c7bb 7213 img->corners[RIGHT_CORNER]));
0f4aca46
KS
7214 height = img->height = max (gif->SHeight,
7215 max (gif->Image.Top + gif->Image.Height,
6ac3c7bb 7216 img->corners[BOT_CORNER]));
4ef0d4d0 7217
f1f25b99
CY
7218 if (!check_image_size (f, width, height))
7219 {
10ea2b82 7220 image_error ("Invalid image size (see `max-image-size')", Qnil, Qnil);
f1f25b99 7221 fn_DGifCloseFile (gif);
f1f25b99
CY
7222 return 0;
7223 }
7224
4ef0d4d0
KS
7225 /* Create the X image and pixmap. */
7226 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
7227 {
7228 fn_DGifCloseFile (gif);
4ef0d4d0
KS
7229 return 0;
7230 }
7231
7232 /* Allocate colors. */
7233 gif_color_map = gif->SavedImages[ino].ImageDesc.ColorMap;
7234 if (!gif_color_map)
7235 gif_color_map = gif->SColorMap;
7236 init_color_table ();
72af86bd 7237 memset (pixel_colors, 0, sizeof pixel_colors);
4ef0d4d0 7238
1ab2cd43
TTN
7239 if (gif_color_map)
7240 for (i = 0; i < gif_color_map->ColorCount; ++i)
7241 {
17c0c952
JD
7242 if (transparent_p && transparency_color_index == i)
7243 {
7244 Lisp_Object specified_bg
7245 = image_spec_value (img->spec, QCbackground, NULL);
7246 pixel_colors[i] = STRINGP (specified_bg)
7247 ? x_alloc_image_color (f, img, specified_bg,
7248 FRAME_BACKGROUND_PIXEL (f))
7249 : FRAME_BACKGROUND_PIXEL (f);
7250 }
7251 else
7252 {
7253 int r = gif_color_map->Colors[i].Red << 8;
7254 int g = gif_color_map->Colors[i].Green << 8;
7255 int b = gif_color_map->Colors[i].Blue << 8;
7256 pixel_colors[i] = lookup_rgb_color (f, r, g, b);
7257 }
1ab2cd43 7258 }
4ef0d4d0
KS
7259
7260#ifdef COLOR_TABLE_SUPPORT
7261 img->colors = colors_in_color_table (&img->ncolors);
7262 free_color_table ();
7263#endif /* COLOR_TABLE_SUPPORT */
7264
7265 /* Clear the part of the screen image that are not covered by
7266 the image from the GIF file. Full animated GIF support
7267 requires more than can be done here (see the gif89 spec,
7268 disposal methods). Let's simply assume that the part
7269 not covered by a sub-image is in the frame's background color. */
6ac3c7bb 7270 for (y = 0; y < img->corners[TOP_CORNER]; ++y)
4ef0d4d0
KS
7271 for (x = 0; x < width; ++x)
7272 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
7273
6ac3c7bb 7274 for (y = img->corners[BOT_CORNER]; y < height; ++y)
4ef0d4d0
KS
7275 for (x = 0; x < width; ++x)
7276 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
7277
6ac3c7bb 7278 for (y = img->corners[TOP_CORNER]; y < img->corners[BOT_CORNER]; ++y)
4ef0d4d0 7279 {
6ac3c7bb 7280 for (x = 0; x < img->corners[LEFT_CORNER]; ++x)
4ef0d4d0 7281 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
6ac3c7bb 7282 for (x = img->corners[RIGHT_CORNER]; x < width; ++x)
4ef0d4d0
KS
7283 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
7284 }
7285
7286 /* Read the GIF image into the X image. We use a local variable
7287 `raster' here because RasterBits below is a char *, and invites
7288 problems with bytes >= 0x80. */
7289 raster = (unsigned char *) gif->SavedImages[ino].RasterBits;
7290
7291 if (gif->SavedImages[ino].ImageDesc.Interlace)
7292 {
4ef0d4d0
KS
7293 int pass;
7294 int row = interlace_start[0];
7295
7296 pass = 0;
7297
7298 for (y = 0; y < image_height; y++)
7299 {
7300 if (row >= image_height)
7301 {
7302 row = interlace_start[++pass];
7303 while (row >= image_height)
7304 row = interlace_start[++pass];
7305 }
7306
7307 for (x = 0; x < image_width; x++)
7308 {
6ae141d6 7309 int c = raster[(y * image_width) + x];
6ac3c7bb 7310 XPutPixel (ximg, x + img->corners[LEFT_CORNER],
6ae141d6 7311 row + img->corners[TOP_CORNER], pixel_colors[c]);
4ef0d4d0
KS
7312 }
7313
7314 row += interlace_increment[pass];
7315 }
7316 }
7317 else
7318 {
7319 for (y = 0; y < image_height; ++y)
7320 for (x = 0; x < image_width; ++x)
7321 {
6ae141d6 7322 int c = raster[y * image_width + x];
6ac3c7bb 7323 XPutPixel (ximg, x + img->corners[LEFT_CORNER],
6ae141d6 7324 y + img->corners[TOP_CORNER], pixel_colors[c]);
4ef0d4d0
KS
7325 }
7326 }
7327
1546c559
JL
7328 /* Save GIF image extension data for `image-metadata'.
7329 Format is (count IMAGES extension-data (FUNCTION "BYTES" ...)). */
6ac3c7bb
KS
7330 img->data.lisp_val = Qnil;
7331 if (gif->SavedImages[ino].ExtensionBlockCount > 0)
7332 {
7333 ExtensionBlock *ext = gif->SavedImages[ino].ExtensionBlocks;
7334 for (i = 0; i < gif->SavedImages[ino].ExtensionBlockCount; i++, ext++)
7335 /* Append (... FUNCTION "BYTES") */
7336 img->data.lisp_val = Fcons (make_unibyte_string (ext->Bytes, ext->ByteCount),
7337 Fcons (make_number (ext->Function),
7338 img->data.lisp_val));
1546c559
JL
7339 img->data.lisp_val = Fcons (Qextension_data,
7340 Fcons (Fnreverse (img->data.lisp_val),
7341 Qnil));
6ac3c7bb
KS
7342 }
7343 if (gif->ImageCount > 1)
7344 img->data.lisp_val = Fcons (Qcount,
7345 Fcons (make_number (gif->ImageCount),
7346 img->data.lisp_val));
7347
4ef0d4d0
KS
7348 fn_DGifCloseFile (gif);
7349
7350 /* Maybe fill in the background field while we have ximg handy. */
7351 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
2e09fef1
EZ
7352 /* Casting avoids a GCC warning. */
7353 IMAGE_BACKGROUND (img, f, (XImagePtr_or_DC)ximg);
4ef0d4d0
KS
7354
7355 /* Put the image into the pixmap, then free the X image and its buffer. */
7356 x_put_x_image (f, ximg, img->pixmap, width, height);
7357 x_destroy_x_image (ximg);
7358
4ef0d4d0
KS
7359 return 1;
7360}
7361
2e09fef1 7362#else /* !HAVE_GIF */
4ef0d4d0 7363
edfda783
AR
7364#ifdef HAVE_NS
7365static int
7366gif_load (struct frame *f, struct image *img)
7367{
ed3751c8
JB
7368 return ns_load_image (f, img,
7369 image_spec_value (img->spec, QCfile, NULL),
7370 image_spec_value (img->spec, QCdata, NULL));
edfda783
AR
7371}
7372#endif /* HAVE_NS */
7373
4ef0d4d0
KS
7374#endif /* HAVE_GIF */
7375
7376
3de25479 7377/***********************************************************************
a32d4040 7378 ImageMagick
4917006b 7379***********************************************************************/
3de25479 7380#if defined (HAVE_IMAGEMAGICK)
3de25479 7381
3de25479 7382Lisp_Object Qimagemagick;
a32d4040
CY
7383
7384/* Indices of image specification fields in imagemagick_format. */
3de25479
JV
7385
7386enum imagemagick_keyword_index
4917006b
JV
7387 {
7388 IMAGEMAGICK_TYPE,
7389 IMAGEMAGICK_DATA,
7390 IMAGEMAGICK_FILE,
7391 IMAGEMAGICK_ASCENT,
7392 IMAGEMAGICK_MARGIN,
7393 IMAGEMAGICK_RELIEF,
7394 IMAGEMAGICK_ALGORITHM,
7395 IMAGEMAGICK_HEURISTIC_MASK,
7396 IMAGEMAGICK_MASK,
7397 IMAGEMAGICK_BACKGROUND,
c7f514b5
JV
7398 IMAGEMAGICK_HEIGHT,
7399 IMAGEMAGICK_WIDTH,
7400 IMAGEMAGICK_ROTATION,
7401 IMAGEMAGICK_CROP,
4917006b
JV
7402 IMAGEMAGICK_LAST
7403 };
3de25479
JV
7404
7405/* Vector of image_keyword structures describing the format
7406 of valid user-defined image specifications. */
7407
7408static struct image_keyword imagemagick_format[IMAGEMAGICK_LAST] =
4917006b
JV
7409 {
7410 {":type", IMAGE_SYMBOL_VALUE, 1},
7411 {":data", IMAGE_STRING_VALUE, 0},
7412 {":file", IMAGE_STRING_VALUE, 0},
7413 {":ascent", IMAGE_ASCENT_VALUE, 0},
7414 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
7415 {":relief", IMAGE_INTEGER_VALUE, 0},
7416 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7417 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7418 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
c7f514b5 7419 {":background", IMAGE_STRING_OR_NIL_VALUE, 0},
7574650a
AS
7420 {":height", IMAGE_INTEGER_VALUE, 0},
7421 {":width", IMAGE_INTEGER_VALUE, 0},
7422 {":rotation", IMAGE_NUMBER_VALUE, 0},
c7f514b5 7423 {":crop", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
4917006b 7424 };
a32d4040 7425
3de25479
JV
7426/* Free X resources of imagemagick image IMG which is used on frame F. */
7427
7428static void
4917006b
JV
7429imagemagick_clear_image (struct frame *f,
7430 struct image *img)
3de25479 7431{
3de25479
JV
7432 x_clear_image (f, img);
7433}
7434
3de25479
JV
7435/* Return non-zero if OBJECT is a valid IMAGEMAGICK image specification. Do
7436 this by calling parse_image_spec and supplying the keywords that
7437 identify the IMAGEMAGICK format. */
7438
7439static int
4917006b 7440imagemagick_image_p (Lisp_Object object)
3de25479
JV
7441{
7442 struct image_keyword fmt[IMAGEMAGICK_LAST];
dbfe4532 7443 memcpy (fmt, imagemagick_format, sizeof fmt);
3de25479
JV
7444
7445 if (!parse_image_spec (object, fmt, IMAGEMAGICK_LAST, Qimagemagick))
7446 return 0;
7447
7448 /* Must specify either the :data or :file keyword. */
7449 return fmt[IMAGEMAGICK_FILE].count + fmt[IMAGEMAGICK_DATA].count == 1;
7450}
7451
7452/* The GIF library also defines DrawRectangle, but its never used in Emacs.
7453 Therefore rename the function so it doesnt collide with ImageMagick. */
7454#define DrawRectangle DrawRectangleGif
7455#include <wand/MagickWand.h>
7456
d2a2d277
JV
7457/* imagemagick_load_image is a helper function for imagemagick_load,
7458 which does the actual loading given contents and size, apart from
7459 frame and image structures, passed from imagemagick_load.
3de25479
JV
7460
7461 Uses librimagemagick to do most of the image processing.
7462
a32d4040 7463 Return non-zero if successful.
3de25479
JV
7464*/
7465
7466static int
d2a2d277
JV
7467imagemagick_load_image (/* Pointer to emacs frame structure. */
7468 struct frame *f,
7469 /* Pointer to emacs image structure. */
7574650a 7470 struct image *img,
d2a2d277
JV
7471 /* String containing the IMAGEMAGICK data to
7472 be parsed. */
7473 unsigned char *contents,
7474 /* Size of data in bytes. */
7475 unsigned int size,
7476 /* Filename, either pass filename or
7477 contents/size. */
7478 unsigned char *filename)
3de25479 7479{
b7d187f8
AS
7480 unsigned long width;
7481 unsigned long height;
3de25479
JV
7482
7483 MagickBooleanType
7484 status;
7485
7486 XImagePtr ximg;
7487 Lisp_Object specified_bg;
7488 XColor background;
7489 int x;
7490 int y;
7491
7492 MagickWand *image_wand;
7574650a 7493 MagickWand *ping_wand;
3de25479
JV
7494 PixelIterator *iterator;
7495 PixelWand **pixels;
7496 MagickPixelPacket pixel;
4917006b 7497 Lisp_Object image;
7574650a 7498 Lisp_Object value;
4917006b
JV
7499 Lisp_Object crop, geometry;
7500 long ino;
7501 int desired_width, desired_height;
7502 double rotation;
7503 int imagemagick_rendermethod;
7574650a 7504 int pixelwidth;
f3700365
JV
7505 ImageInfo *image_info;
7506 ExceptionInfo *exception;
7507 Image * im_image;
3de25479 7508
7574650a 7509
a32d4040
CY
7510 /* Handle image index for image types who can contain more than one image.
7511 Interface :index is same as for GIF. First we "ping" the image to see how
7512 many sub-images it contains. Pinging is faster than loading the image to
7513 find out things about it. */
f853f599 7514
a32d4040 7515 /* Initialize the imagemagick environment. */
f853f599 7516 MagickWandGenesis ();
3de25479
JV
7517 image = image_spec_value (img->spec, QCindex, NULL);
7518 ino = INTEGERP (image) ? XFASTINT (image) : 0;
7574650a
AS
7519 ping_wand = NewMagickWand ();
7520 MagickSetResolution (ping_wand, 2, 2);
f3700365
JV
7521 if (filename != NULL)
7522 {
7574650a 7523 status = MagickPingImage (ping_wand, filename);
f3700365
JV
7524 }
7525 else
7526 {
7574650a
AS
7527 status = MagickPingImageBlob (ping_wand, contents, size);
7528 }
7529
7530 if (ino >= MagickGetNumberImages (ping_wand))
7531 {
7532 image_error ("Invalid image number `%s' in image `%s'",
7533 image, img->spec);
7534 DestroyMagickWand (ping_wand);
7535 return 0;
f3700365 7536 }
431dab04 7537
f3700365 7538 if (MagickGetNumberImages(ping_wand) > 1)
d2a2d277
JV
7539 img->data.lisp_val =
7540 Fcons (Qcount,
7574650a 7541 Fcons (make_number (MagickGetNumberImages (ping_wand)),
d2a2d277 7542 img->data.lisp_val));
f3700365
JV
7543
7544 DestroyMagickWand (ping_wand);
f853f599 7545
f3700365 7546 /* Now, after pinging, we know how many images are inside the
a32d4040 7547 file. If it's not a bundle, the number is one. */
f3700365
JV
7548
7549 if (filename != NULL)
7550 {
7574650a
AS
7551 image_info = CloneImageInfo ((ImageInfo *) NULL);
7552 (void) strcpy (image_info->filename, filename);
7553 image_info->number_scenes = 1;
7554 image_info->scene = ino;
7555 exception = AcquireExceptionInfo ();
f3700365 7556
7574650a 7557 im_image = ReadImage (image_info, exception);
466cbae9 7558 DestroyExceptionInfo (exception);
f3700365 7559
466cbae9
AS
7560 if (im_image != NULL)
7561 {
7562 image_wand = NewMagickWandFromImage (im_image);
f853f599 7563 DestroyImage(im_image);
466cbae9
AS
7564 status = MagickTrue;
7565 }
7566 else
7567 status = MagickFalse;
f3700365 7568 }
3de25479 7569 else
f3700365 7570 {
7574650a
AS
7571 image_wand = NewMagickWand ();
7572 status = MagickReadImageBlob (image_wand, contents, size);
f3700365 7573 }
f853f599 7574
f3700365
JV
7575 if (status == MagickFalse) goto imagemagick_error;
7576
d2a2d277 7577 /* If width and/or height is set in the display spec assume we want
a32d4040 7578 to scale to those values. If either h or w is unspecified, the
f3700365 7579 unspecified should be calculated from the specified to preserve
549a73b9 7580 aspect ratio. */
3de25479 7581
3de25479
JV
7582 value = image_spec_value (img->spec, QCwidth, NULL);
7583 desired_width = (INTEGERP (value) ? XFASTINT (value) : -1);
7584 value = image_spec_value (img->spec, QCheight, NULL);
7585 desired_height = (INTEGERP (value) ? XFASTINT (value) : -1);
c7f514b5 7586
bdf6a35d
JV
7587 height = MagickGetImageHeight (image_wand);
7588 width = MagickGetImageWidth (image_wand);
7589
a32d4040
CY
7590 if (desired_width != -1 && desired_height == -1)
7591 /* w known, calculate h. */
7592 desired_height = (double) desired_width / width * height;
7593 if (desired_width == -1 && desired_height != -1)
7594 /* h known, calculate w. */
7595 desired_width = (double) desired_height / height * width;
7596 if (desired_width != -1 && desired_height != -1)
4917006b 7597 {
7574650a
AS
7598 status = MagickScaleImage (image_wand, desired_width, desired_height);
7599 if (status == MagickFalse)
7600 {
7601 image_error ("Imagemagick scale failed", Qnil, Qnil);
7602 goto imagemagick_error;
7603 }
3de25479 7604 }
3de25479 7605
f3700365 7606 /* crop behaves similar to image slicing in Emacs but is more memory
7574650a
AS
7607 efficient. */
7608 crop = image_spec_value (img->spec, QCcrop, NULL);
7609
7610 if (CONSP (crop) && INTEGERP (XCAR (crop)))
7611 {
a32d4040
CY
7612 /* After some testing, it seems MagickCropImage is the fastest crop
7613 function in ImageMagick. This crop function seems to do less copying
7614 than the alternatives, but it still reads the entire image into memory
7615 before croping, which is aparently difficult to avoid when using
7616 imagemagick. */
7574650a
AS
7617 int w, h, x, y;
7618 w = XFASTINT (XCAR (crop));
7619 crop = XCDR (crop);
7620 if (CONSP (crop) && INTEGERP (XCAR (crop)))
7621 {
7622 h = XFASTINT (XCAR (crop));
7623 crop = XCDR (crop);
7624 if (CONSP (crop) && INTEGERP (XCAR (crop)))
7625 {
7626 x = XFASTINT (XCAR (crop));
7627 crop = XCDR (crop);
7628 if (CONSP (crop) && INTEGERP (XCAR (crop)))
7629 {
7630 y = XFASTINT (XCAR (crop));
7631 MagickCropImage (image_wand, w, h, x, y);
7632 }
7633 }
7634 }
7635 }
7636
d2a2d277
JV
7637 /* Furthermore :rotation. we need background color and angle for
7638 rotation. */
3de25479 7639 /*
d2a2d277
JV
7640 TODO background handling for rotation specified_bg =
7641 image_spec_value (img->spec, QCbackground, NULL); if (!STRINGP
549a73b9 7642 (specified_bg). */
4917006b
JV
7643 value = image_spec_value (img->spec, QCrotation, NULL);
7644 if (FLOATP (value))
7645 {
7574650a 7646 PixelWand* background = NewPixelWand ();
3de25479 7647 PixelSetColor (background, "#ffffff");/*TODO remove hardcode*/
7574650a 7648
3de25479 7649 rotation = extract_float (value);
7574650a 7650
4917006b 7651 status = MagickRotateImage (image_wand, background, rotation);
3de25479 7652 DestroyPixelWand (background);
4917006b
JV
7653 if (status == MagickFalse)
7654 {
7655 image_error ("Imagemagick image rotate failed", Qnil, Qnil);
7656 goto imagemagick_error;
7657 }
3de25479 7658 }
7574650a 7659
c7f514b5 7660 /* Finaly we are done manipulating the image, figure out resulting
549a73b9 7661 width, height, and then transfer ownerwship to Emacs. */
4917006b
JV
7662 height = MagickGetImageHeight (image_wand);
7663 width = MagickGetImageWidth (image_wand);
7574650a 7664
3de25479
JV
7665 if (! check_image_size (f, width, height))
7666 {
7667 image_error ("Invalid image size (see `max-image-size')", Qnil, Qnil);
7668 goto imagemagick_error;
7669 }
7574650a 7670
3de25479
JV
7671 /* We can now get a valid pixel buffer from the imagemagick file, if all
7672 went ok. */
3de25479
JV
7673
7674 init_color_table ();
d2a2d277
JV
7675 imagemagick_rendermethod = (INTEGERP (Vimagemagick_render_type)
7676 ? XFASTINT (Vimagemagick_render_type) : 0);
4917006b
JV
7677 if (imagemagick_rendermethod == 0)
7678 {
7679 /* Try to create a x pixmap to hold the imagemagick pixmap. */
d2a2d277
JV
7680 if (!x_create_x_image_and_pixmap (f, width, height, 0,
7681 &ximg, &img->pixmap))
4917006b 7682 {
466cbae9
AS
7683#ifdef COLOR_TABLE_SUPPORT
7684 free_color_table ();
7685#endif
4917006b
JV
7686 image_error("Imagemagick X bitmap allocation failure", Qnil, Qnil);
7687 goto imagemagick_error;
7688 }
7574650a 7689
4917006b
JV
7690 /* Copy imagegmagick image to x with primitive yet robust pixel
7691 pusher loop. This has been tested a lot with many different
549a73b9 7692 images. */
7574650a 7693
4917006b
JV
7694 /* Copy pixels from the imagemagick image structure to the x image map. */
7695 iterator = NewPixelIterator (image_wand);
7574650a 7696 if (iterator == (PixelIterator *) NULL)
4917006b 7697 {
466cbae9
AS
7698#ifdef COLOR_TABLE_SUPPORT
7699 free_color_table ();
7700#endif
7701 x_destroy_x_image (ximg);
d2a2d277
JV
7702 image_error ("Imagemagick pixel iterator creation failed",
7703 Qnil, Qnil);
3de25479 7704 goto imagemagick_error;
4917006b
JV
7705 }
7706
7574650a 7707 for (y = 0; y < (long) MagickGetImageHeight (image_wand); y++)
4917006b
JV
7708 {
7709 pixels = PixelGetNextIteratorRow (iterator, &width);
7574650a 7710 if (pixels == (PixelWand **) NULL)
4917006b
JV
7711 break;
7712 for (x = 0; x < (long) width; x++)
7713 {
7714 PixelGetMagickColor (pixels[x], &pixel);
d2a2d277
JV
7715 XPutPixel (ximg, x, y,
7716 lookup_rgb_color (f,
7717 pixel.red,
7718 pixel.green,
7719 pixel.blue));
4917006b
JV
7720 }
7721 }
7722 DestroyPixelIterator (iterator);
3de25479
JV
7723 }
7724
4917006b
JV
7725 if (imagemagick_rendermethod == 1)
7726 {
3234a340
JV
7727 /* Magicexportimage is normaly faster than pixelpushing. This
7728 method is also well tested. Some aspects of this method are
7729 ad-hoc and needs to be more researched. */
4917006b
JV
7730 int imagedepth = 24;/*MagickGetImageDepth(image_wand);*/
7731 char* exportdepth = imagedepth <= 8 ? "I" : "BGRP";/*"RGBP";*/
7732 /* Try to create a x pixmap to hold the imagemagick pixmap. */
d2a2d277 7733 if (!x_create_x_image_and_pixmap (f, width, height, imagedepth,
7574650a
AS
7734 &ximg, &img->pixmap))
7735 {
466cbae9
AS
7736#ifdef COLOR_TABLE_SUPPORT
7737 free_color_table ();
7738#endif
7574650a
AS
7739 image_error("Imagemagick X bitmap allocation failure", Qnil, Qnil);
7740 goto imagemagick_error;
7741 }
7742
3de25479 7743
4917006b
JV
7744 /* Oddly, the below code doesnt seem to work:*/
7745 /* switch(ximg->bitmap_unit){ */
7746 /* case 8: */
7747 /* pixelwidth=CharPixel; */
7748 /* break; */
7749 /* case 16: */
7750 /* pixelwidth=ShortPixel; */
7751 /* break; */
7752 /* case 32: */
7753 /* pixelwidth=LongPixel; */
7754 /* break; */
7755 /* } */
7756 /*
7757 Here im just guessing the format of the bitmap.
7758 happens to work fine for:
7759 - bw djvu images
7760 on rgb display.
7761 seems about 3 times as fast as pixel pushing(not carefully measured)
4917006b
JV
7762 */
7763 pixelwidth = CharPixel;/*??? TODO figure out*/
7574650a
AS
7764#ifdef HAVE_MAGICKEXPORTIMAGEPIXELS
7765 MagickExportImagePixels (image_wand,
7766 0, 0,
7767 width, height,
7768 exportdepth,
7769 pixelwidth,
7770 /*&(img->pixmap));*/
7771 ximg->data);
431dab04 7772#else
7574650a
AS
7773 image_error ("You dont have MagickExportImagePixels, upgrade ImageMagick!",
7774 Qnil, Qnil);
7775#endif
4917006b 7776 }
7574650a 7777
3ed42149 7778
3de25479
JV
7779#ifdef COLOR_TABLE_SUPPORT
7780 /* Remember colors allocated for this image. */
7781 img->colors = colors_in_color_table (&img->ncolors);
7782 free_color_table ();
7783#endif /* COLOR_TABLE_SUPPORT */
7784
7785
7786 img->width = width;
7787 img->height = height;
7788
3de25479
JV
7789 /* Put the image into the pixmap, then free the X image and its
7790 buffer. */
7791 x_put_x_image (f, ximg, img->pixmap, width, height);
3de25479
JV
7792 x_destroy_x_image (ximg);
7793
7794
f3700365 7795 /* Final cleanup. image_wand should be the only resource left. */
3de25479 7796 DestroyMagickWand (image_wand);
03d32f1b 7797 /* `MagickWandTerminus' terminates the imagemagick environment. */
f853f599 7798 MagickWandTerminus ();
3de25479
JV
7799
7800 return 1;
7801
7802 imagemagick_error:
466cbae9 7803 DestroyMagickWand (image_wand);
f853f599 7804 MagickWandTerminus ();
3de25479
JV
7805 /* TODO more cleanup. */
7806 image_error ("Error parsing IMAGEMAGICK image `%s'", img->spec, Qnil);
3de25479
JV
7807 return 0;
7808}
7809
4917006b
JV
7810
7811/* Load IMAGEMAGICK image IMG for use on frame F. Value is non-zero if
7812 successful. this function will go into the imagemagick_type structure, and
7813 the prototype thus needs to be compatible with that structure. */
7814
7815static int
7816imagemagick_load (struct frame *f,
7817 struct image *img)
7818{
7819 int success_p = 0;
7820 Lisp_Object file_name;
7821
7822 /* If IMG->spec specifies a file name, create a non-file spec from it. */
7823 file_name = image_spec_value (img->spec, QCfile, NULL);
7824 if (STRINGP (file_name))
7825 {
7826 Lisp_Object file;
4917006b
JV
7827
7828 file = x_find_image_file (file_name);
4917006b
JV
7829 if (!STRINGP (file))
7830 {
7831 image_error ("Cannot find image file `%s'", file_name, Qnil);
4917006b
JV
7832 return 0;
7833 }
7574650a 7834 success_p = imagemagick_load_image (f, img, 0, 0, SDATA (file));
4917006b
JV
7835 }
7836 /* Else its not a file, its a lisp object. Load the image from a
7837 lisp object rather than a file. */
7838 else
7839 {
7840 Lisp_Object data;
7841
7842 data = image_spec_value (img->spec, QCdata, NULL);
7574650a
AS
7843 if (!STRINGP (data))
7844 {
7845 image_error ("Invalid image data `%s'", data, Qnil);
7846 return 0;
7847 }
d2a2d277
JV
7848 success_p = imagemagick_load_image (f, img, SDATA (data),
7849 SBYTES (data), NULL);
4917006b
JV
7850 }
7851
7852 return success_p;
7853}
7854
d2a2d277
JV
7855/* Structure describing the image type `imagemagick'. Its the same
7856 type of structure defined for all image formats, handled by Emacs
7857 image functions. See struct image_type in dispextern.h. */
4917006b
JV
7858
7859static struct image_type imagemagick_type =
7860 {
d2a2d277
JV
7861 /* An identifier showing that this is an image structure for the
7862 IMAGEMAGICK format. */
4917006b 7863 &Qimagemagick,
d2a2d277
JV
7864 /* Handle to a function that can be used to identify a IMAGEMAGICK
7865 file. */
4917006b
JV
7866 imagemagick_image_p,
7867 /* Handle to function used to load a IMAGEMAGICK file. */
7868 imagemagick_load,
7869 /* Handle to function to free resources for IMAGEMAGICK. */
7870 imagemagick_clear_image,
7871 /* An internal field to link to the next image type in a list of
7872 image types, will be filled in when registering the format. */
7873 NULL
7874 };
7875
7876
a7ca3326 7877DEFUN ("imagemagick-types", Fimagemagick_types, Simagemagick_types, 0, 0, 0,
a32d4040
CY
7878 doc: /* Return the image types supported by ImageMagick.
7879Note that ImageMagick recognizes many file-types that Emacs does not recognize
7880as images, such as .c. */)
a8101f66 7881 (void)
3de25479
JV
7882{
7883 Lisp_Object typelist = Qnil;
b7d187f8 7884 unsigned long numf;
3de25479 7885 ExceptionInfo ex;
7574650a 7886 char **imtypes = GetMagickList ("*", &numf, &ex);
3de25479
JV
7887 int i;
7888 Lisp_Object Qimagemagicktype;
4917006b
JV
7889 for (i = 0; i < numf; i++)
7890 {
7891 Qimagemagicktype = intern (imtypes[i]);
f3700365
JV
7892 typelist = Fcons (Qimagemagicktype, typelist);
7893 }
7894 return typelist;
3de25479 7895}
7574650a 7896
3de25479
JV
7897#endif /* defined (HAVE_IMAGEMAGICK) */
7898
7899
4ef0d4d0 7900\f
4ab27a43
GM
7901/***********************************************************************
7902 SVG
7903 ***********************************************************************/
7904
7905#if defined (HAVE_RSVG)
7906
7907/* Function prototypes. */
7908
f57e2426
J
7909static int svg_image_p (Lisp_Object object);
7910static int svg_load (struct frame *f, struct image *img);
4ab27a43 7911
f57e2426
J
7912static int svg_load_image (struct frame *, struct image *,
7913 unsigned char *, unsigned int);
4ab27a43
GM
7914
7915/* The symbol `svg' identifying images of this type. */
7916
7917Lisp_Object Qsvg;
7918
7919/* Indices of image specification fields in svg_format, below. */
7920
7921enum svg_keyword_index
7922{
7923 SVG_TYPE,
7924 SVG_DATA,
7925 SVG_FILE,
7926 SVG_ASCENT,
7927 SVG_MARGIN,
7928 SVG_RELIEF,
7929 SVG_ALGORITHM,
7930 SVG_HEURISTIC_MASK,
7931 SVG_MASK,
7932 SVG_BACKGROUND,
7933 SVG_LAST
7934};
7935
7936/* Vector of image_keyword structures describing the format
7937 of valid user-defined image specifications. */
7938
91433552 7939static const struct image_keyword svg_format[SVG_LAST] =
4ab27a43
GM
7940{
7941 {":type", IMAGE_SYMBOL_VALUE, 1},
7942 {":data", IMAGE_STRING_VALUE, 0},
7943 {":file", IMAGE_STRING_VALUE, 0},
7944 {":ascent", IMAGE_ASCENT_VALUE, 0},
7945 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
7946 {":relief", IMAGE_INTEGER_VALUE, 0},
7947 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7948 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7949 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7950 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
7951};
7952
7953/* Structure describing the image type `svg'. Its the same type of
7954 structure defined for all image formats, handled by emacs image
7955 functions. See struct image_type in dispextern.h. */
7956
7957static struct image_type svg_type =
7958{
7959 /* An identifier showing that this is an image structure for the SVG format. */
7960 &Qsvg,
7961 /* Handle to a function that can be used to identify a SVG file. */
7962 svg_image_p,
7963 /* Handle to function used to load a SVG file. */
7964 svg_load,
7965 /* Handle to function to free sresources for SVG. */
7966 x_clear_image,
7967 /* An internal field to link to the next image type in a list of
7968 image types, will be filled in when registering the format. */
c21e6151 7969 NULL
4ab27a43
GM
7970};
7971
7972
7973/* Return non-zero if OBJECT is a valid SVG image specification. Do
7974 this by calling parse_image_spec and supplying the keywords that
7975 identify the SVG format. */
7976
7977static int
d3da34e0 7978svg_image_p (Lisp_Object object)
4ab27a43
GM
7979{
7980 struct image_keyword fmt[SVG_LAST];
72af86bd 7981 memcpy (fmt, svg_format, sizeof fmt);
4ab27a43
GM
7982
7983 if (!parse_image_spec (object, fmt, SVG_LAST, Qsvg))
7984 return 0;
7985
7986 /* Must specify either the :data or :file keyword. */
7987 return fmt[SVG_FILE].count + fmt[SVG_DATA].count == 1;
7988}
7989
7990#include <librsvg/rsvg.h>
7991
5fc9fdeb
JR
7992#ifdef HAVE_NTGUI
7993
7994/* SVG library functions. */
df61c790
AS
7995DEF_IMGLIB_FN (RsvgHandle *, rsvg_handle_new);
7996DEF_IMGLIB_FN (void, rsvg_handle_get_dimensions);
7997DEF_IMGLIB_FN (gboolean, rsvg_handle_write);
7998DEF_IMGLIB_FN (gboolean, rsvg_handle_close);
7999DEF_IMGLIB_FN (GdkPixbuf *, rsvg_handle_get_pixbuf);
8000DEF_IMGLIB_FN (void, rsvg_handle_free);
8001
8002DEF_IMGLIB_FN (int, gdk_pixbuf_get_width);
8003DEF_IMGLIB_FN (int, gdk_pixbuf_get_height);
8004DEF_IMGLIB_FN (guchar *, gdk_pixbuf_get_pixels);
8005DEF_IMGLIB_FN (int, gdk_pixbuf_get_rowstride);
8006DEF_IMGLIB_FN (GdkColorspace, gdk_pixbuf_get_colorspace);
8007DEF_IMGLIB_FN (int, gdk_pixbuf_get_n_channels);
8008DEF_IMGLIB_FN (gboolean, gdk_pixbuf_get_has_alpha);
8009DEF_IMGLIB_FN (int, gdk_pixbuf_get_bits_per_sample);
8010
8011DEF_IMGLIB_FN (void, g_type_init);
8012DEF_IMGLIB_FN (void, g_object_unref);
8013DEF_IMGLIB_FN (void, g_error_free);
5fc9fdeb 8014
df23bf08 8015Lisp_Object Qgdk_pixbuf, Qglib, Qgobject;
5fc9fdeb
JR
8016
8017static int
8018init_svg_functions (Lisp_Object libraries)
8019{
df23bf08 8020 HMODULE library, gdklib, glib, gobject;
5fc9fdeb
JR
8021
8022 if (!(glib = w32_delayed_load (libraries, Qglib))
df23bf08 8023 || !(gobject = w32_delayed_load (libraries, Qgobject))
5fc9fdeb
JR
8024 || !(gdklib = w32_delayed_load (libraries, Qgdk_pixbuf))
8025 || !(library = w32_delayed_load (libraries, Qsvg)))
8026 return 0;
8027
8028 LOAD_IMGLIB_FN (library, rsvg_handle_new);
e025c9c2 8029 LOAD_IMGLIB_FN (library, rsvg_handle_get_dimensions);
5fc9fdeb
JR
8030 LOAD_IMGLIB_FN (library, rsvg_handle_write);
8031 LOAD_IMGLIB_FN (library, rsvg_handle_close);
8032 LOAD_IMGLIB_FN (library, rsvg_handle_get_pixbuf);
8033 LOAD_IMGLIB_FN (library, rsvg_handle_free);
8034
8035 LOAD_IMGLIB_FN (gdklib, gdk_pixbuf_get_width);
8036 LOAD_IMGLIB_FN (gdklib, gdk_pixbuf_get_height);
8037 LOAD_IMGLIB_FN (gdklib, gdk_pixbuf_get_pixels);
8038 LOAD_IMGLIB_FN (gdklib, gdk_pixbuf_get_rowstride);
8039 LOAD_IMGLIB_FN (gdklib, gdk_pixbuf_get_colorspace);
8040 LOAD_IMGLIB_FN (gdklib, gdk_pixbuf_get_n_channels);
8041 LOAD_IMGLIB_FN (gdklib, gdk_pixbuf_get_has_alpha);
8042 LOAD_IMGLIB_FN (gdklib, gdk_pixbuf_get_bits_per_sample);
8043
df23bf08
JR
8044 LOAD_IMGLIB_FN (gobject, g_type_init);
8045 LOAD_IMGLIB_FN (gobject, g_object_unref);
5fc9fdeb 8046 LOAD_IMGLIB_FN (glib, g_error_free);
df23bf08 8047
5fc9fdeb
JR
8048 return 1;
8049}
4ab27a43 8050
5fc9fdeb
JR
8051#else
8052/* The following aliases for library functions allow dynamic loading
8053 to be used on some platforms. */
4ab27a43 8054#define fn_rsvg_handle_new rsvg_handle_new
e025c9c2 8055#define fn_rsvg_handle_get_dimensions rsvg_handle_get_dimensions
4ab27a43
GM
8056#define fn_rsvg_handle_write rsvg_handle_write
8057#define fn_rsvg_handle_close rsvg_handle_close
8058#define fn_rsvg_handle_get_pixbuf rsvg_handle_get_pixbuf
8059#define fn_rsvg_handle_free rsvg_handle_free
8060
5fc9fdeb
JR
8061#define fn_gdk_pixbuf_get_width gdk_pixbuf_get_width
8062#define fn_gdk_pixbuf_get_height gdk_pixbuf_get_height
8063#define fn_gdk_pixbuf_get_pixels gdk_pixbuf_get_pixels
8064#define fn_gdk_pixbuf_get_rowstride gdk_pixbuf_get_rowstride
8065#define fn_gdk_pixbuf_get_colorspace gdk_pixbuf_get_colorspace
8066#define fn_gdk_pixbuf_get_n_channels gdk_pixbuf_get_n_channels
8067#define fn_gdk_pixbuf_get_has_alpha gdk_pixbuf_get_has_alpha
4ab27a43
GM
8068#define fn_gdk_pixbuf_get_bits_per_sample gdk_pixbuf_get_bits_per_sample
8069
5fc9fdeb
JR
8070#define fn_g_type_init g_type_init
8071#define fn_g_object_unref g_object_unref
8072#define fn_g_error_free g_error_free
8073#endif /* !HAVE_NTGUI */
4ab27a43
GM
8074
8075/* Load SVG image IMG for use on frame F. Value is non-zero if
8076 successful. this function will go into the svg_type structure, and
8077 the prototype thus needs to be compatible with that structure. */
8078
8079static int
d3da34e0 8080svg_load (struct frame *f, struct image *img)
4ab27a43
GM
8081{
8082 int success_p = 0;
8083 Lisp_Object file_name;
8084
8085 /* If IMG->spec specifies a file name, create a non-file spec from it. */
8086 file_name = image_spec_value (img->spec, QCfile, NULL);
8087 if (STRINGP (file_name))
8088 {
8089 Lisp_Object file;
8090 unsigned char *contents;
8091 int size;
4ab27a43
GM
8092
8093 file = x_find_image_file (file_name);
4ab27a43 8094 if (!STRINGP (file))
c21e6151
YM
8095 {
8096 image_error ("Cannot find image file `%s'", file_name, Qnil);
c21e6151
YM
8097 return 0;
8098 }
8099
4ab27a43
GM
8100 /* Read the entire file into memory. */
8101 contents = slurp_file (SDATA (file), &size);
8102 if (contents == NULL)
c21e6151
YM
8103 {
8104 image_error ("Error loading SVG image `%s'", img->spec, Qnil);
c21e6151
YM
8105 return 0;
8106 }
4ab27a43 8107 /* If the file was slurped into memory properly, parse it. */
c21e6151 8108 success_p = svg_load_image (f, img, contents, size);
4ab27a43 8109 xfree (contents);
4ab27a43
GM
8110 }
8111 /* Else its not a file, its a lisp object. Load the image from a
8112 lisp object rather than a file. */
8113 else
8114 {
8115 Lisp_Object data;
8116
8117 data = image_spec_value (img->spec, QCdata, NULL);
7574650a
AS
8118 if (!STRINGP (data))
8119 {
8120 image_error ("Invalid image data `%s'", data, Qnil);
8121 return 0;
8122 }
4ab27a43
GM
8123 success_p = svg_load_image (f, img, SDATA (data), SBYTES (data));
8124 }
8125
8126 return success_p;
8127}
8128
bbe6f2aa
JB
8129/* svg_load_image is a helper function for svg_load, which does the
8130 actual loading given contents and size, apart from frame and image
8131 structures, passed from svg_load.
4ab27a43 8132
bbe6f2aa 8133 Uses librsvg to do most of the image processing.
c21e6151 8134
bbe6f2aa 8135 Returns non-zero when successful. */
4ab27a43 8136static int
d3da34e0
JB
8137svg_load_image (struct frame *f, /* Pointer to emacs frame structure. */
8138 struct image *img, /* Pointer to emacs image structure. */
8139 unsigned char *contents, /* String containing the SVG XML data to be parsed. */
8140 unsigned int size) /* Size of data in bytes. */
4ab27a43
GM
8141{
8142 RsvgHandle *rsvg_handle;
e025c9c2 8143 RsvgDimensionData dimension_data;
4ab27a43
GM
8144 GError *error = NULL;
8145 GdkPixbuf *pixbuf;
8146 int width;
8147 int height;
8148 const guint8 *pixels;
8149 int rowstride;
8150 XImagePtr ximg;
c21e6151 8151 Lisp_Object specified_bg;
4ab27a43
GM
8152 XColor background;
8153 int x;
8154 int y;
8155
8156 /* g_type_init is a glib function that must be called prior to using
8157 gnome type library functions. */
5fc9fdeb 8158 fn_g_type_init ();
4ab27a43 8159 /* Make a handle to a new rsvg object. */
df61c790 8160 rsvg_handle = fn_rsvg_handle_new ();
4ab27a43
GM
8161
8162 /* Parse the contents argument and fill in the rsvg_handle. */
8163 fn_rsvg_handle_write (rsvg_handle, contents, size, &error);
e025c9c2 8164 if (error) goto rsvg_error;
4ab27a43
GM
8165
8166 /* The parsing is complete, rsvg_handle is ready to used, close it
8167 for further writes. */
8168 fn_rsvg_handle_close (rsvg_handle, &error);
e025c9c2
CY
8169 if (error) goto rsvg_error;
8170
8171 fn_rsvg_handle_get_dimensions (rsvg_handle, &dimension_data);
8172 if (! check_image_size (f, dimension_data.width, dimension_data.height))
10ea2b82
JR
8173 {
8174 image_error ("Invalid image size (see `max-image-size')", Qnil, Qnil);
8175 goto rsvg_error;
8176 }
b2996e57 8177
4ab27a43
GM
8178 /* We can now get a valid pixel buffer from the svg file, if all
8179 went ok. */
df61c790 8180 pixbuf = fn_rsvg_handle_get_pixbuf (rsvg_handle);
e025c9c2
CY
8181 if (!pixbuf) goto rsvg_error;
8182 fn_g_object_unref (rsvg_handle);
4ab27a43
GM
8183
8184 /* Extract some meta data from the svg handle. */
8185 width = fn_gdk_pixbuf_get_width (pixbuf);
8186 height = fn_gdk_pixbuf_get_height (pixbuf);
df61c790 8187 pixels = fn_gdk_pixbuf_get_pixels (pixbuf);
4ab27a43
GM
8188 rowstride = fn_gdk_pixbuf_get_rowstride (pixbuf);
8189
8190 /* Validate the svg meta data. */
8191 eassert (fn_gdk_pixbuf_get_colorspace (pixbuf) == GDK_COLORSPACE_RGB);
8192 eassert (fn_gdk_pixbuf_get_n_channels (pixbuf) == 4);
8193 eassert (fn_gdk_pixbuf_get_has_alpha (pixbuf));
8194 eassert (fn_gdk_pixbuf_get_bits_per_sample (pixbuf) == 8);
8195
8196 /* Try to create a x pixmap to hold the svg pixmap. */
c21e6151
YM
8197 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
8198 {
5fc9fdeb 8199 fn_g_object_unref (pixbuf);
c21e6151
YM
8200 return 0;
8201 }
4ab27a43
GM
8202
8203 init_color_table ();
8204
c21e6151
YM
8205 /* Handle alpha channel by combining the image with a background
8206 color. */
8207 specified_bg = image_spec_value (img->spec, QCbackground, NULL);
8d3c4e79
CY
8208 if (!STRINGP (specified_bg)
8209 || !x_defined_color (f, SDATA (specified_bg), &background, 0))
c21e6151 8210 {
d7e008d0 8211#ifndef HAVE_NS
c21e6151
YM
8212 background.pixel = FRAME_BACKGROUND_PIXEL (f);
8213 x_query_color (f, &background);
d7e008d0 8214#else
ed3751c8 8215 ns_query_color (FRAME_BACKGROUND_COLOR (f), &background, 1);
d7e008d0 8216#endif
c21e6151 8217 }
4ab27a43 8218
8d3c4e79
CY
8219 /* SVG pixmaps specify transparency in the last byte, so right
8220 shift 8 bits to get rid of it, since emacs doesn't support
8221 transparency. */
8222 background.red >>= 8;
8223 background.green >>= 8;
8224 background.blue >>= 8;
8225
4ab27a43
GM
8226 /* This loop handles opacity values, since Emacs assumes
8227 non-transparent images. Each pixel must be "flattened" by
bbe6f2aa
JB
8228 calculating the resulting color, given the transparency of the
8229 pixel, and the image background color. */
4ab27a43
GM
8230 for (y = 0; y < height; ++y)
8231 {
8232 for (x = 0; x < width; ++x)
8233 {
8234 unsigned red;
8235 unsigned green;
8236 unsigned blue;
8237 unsigned opacity;
8238
8239 red = *pixels++;
8240 green = *pixels++;
8241 blue = *pixels++;
8242 opacity = *pixels++;
8243
8244 red = ((red * opacity)
8245 + (background.red * ((1 << 8) - opacity)));
8246 green = ((green * opacity)
8247 + (background.green * ((1 << 8) - opacity)));
8248 blue = ((blue * opacity)
8249 + (background.blue * ((1 << 8) - opacity)));
8250
8251 XPutPixel (ximg, x, y, lookup_rgb_color (f, red, green, blue));
8252 }
8253
8254 pixels += rowstride - 4 * width;
8255 }
8256
8257#ifdef COLOR_TABLE_SUPPORT
8258 /* Remember colors allocated for this image. */
8259 img->colors = colors_in_color_table (&img->ncolors);
8260 free_color_table ();
8261#endif /* COLOR_TABLE_SUPPORT */
8262
5fc9fdeb 8263 fn_g_object_unref (pixbuf);
4ab27a43 8264
c21e6151
YM
8265 img->width = width;
8266 img->height = height;
8267
8268 /* Maybe fill in the background field while we have ximg handy.
8269 Casting avoids a GCC warning. */
8270 IMAGE_BACKGROUND (img, f, (XImagePtr_or_DC)ximg);
8271
4ab27a43
GM
8272 /* Put the image into the pixmap, then free the X image and its
8273 buffer. */
8274 x_put_x_image (f, ximg, img->pixmap, width, height);
8275 x_destroy_x_image (ximg);
8276
4ab27a43
GM
8277 return 1;
8278
8279 rsvg_error:
e025c9c2 8280 fn_g_object_unref (rsvg_handle);
4ab27a43
GM
8281 /* FIXME: Use error->message so the user knows what is the actual
8282 problem with the image. */
8283 image_error ("Error parsing SVG image `%s'", img->spec, Qnil);
5fc9fdeb 8284 fn_g_error_free (error);
4ab27a43
GM
8285 return 0;
8286}
8287
8288#endif /* defined (HAVE_RSVG) */
8289
8290
8291
4ef0d4d0
KS
8292\f
8293/***********************************************************************
8294 Ghostscript
8295 ***********************************************************************/
8296
8297#ifdef HAVE_X_WINDOWS
8298#define HAVE_GHOSTSCRIPT 1
8299#endif /* HAVE_X_WINDOWS */
8300
4ef0d4d0
KS
8301#ifdef HAVE_GHOSTSCRIPT
8302
f57e2426
J
8303static int gs_image_p (Lisp_Object object);
8304static int gs_load (struct frame *f, struct image *img);
8305static void gs_clear_image (struct frame *f, struct image *img);
4ef0d4d0
KS
8306
8307/* Keyword symbols. */
8308
955cbe7b 8309static Lisp_Object QCloader, QCbounding_box, QCpt_width, QCpt_height;
4ef0d4d0
KS
8310
8311/* Indices of image specification fields in gs_format, below. */
8312
8313enum gs_keyword_index
8314{
8315 GS_TYPE,
8316 GS_PT_WIDTH,
8317 GS_PT_HEIGHT,
8318 GS_FILE,
8319 GS_LOADER,
8320 GS_BOUNDING_BOX,
8321 GS_ASCENT,
8322 GS_MARGIN,
8323 GS_RELIEF,
8324 GS_ALGORITHM,
8325 GS_HEURISTIC_MASK,
8326 GS_MASK,
8327 GS_BACKGROUND,
8328 GS_LAST
8329};
8330
8331/* Vector of image_keyword structures describing the format
8332 of valid user-defined image specifications. */
8333
91433552 8334static const struct image_keyword gs_format[GS_LAST] =
4ef0d4d0
KS
8335{
8336 {":type", IMAGE_SYMBOL_VALUE, 1},
8337 {":pt-width", IMAGE_POSITIVE_INTEGER_VALUE, 1},
8338 {":pt-height", IMAGE_POSITIVE_INTEGER_VALUE, 1},
8339 {":file", IMAGE_STRING_VALUE, 1},
8340 {":loader", IMAGE_FUNCTION_VALUE, 0},
8341 {":bounding-box", IMAGE_DONT_CHECK_VALUE_TYPE, 1},
8342 {":ascent", IMAGE_ASCENT_VALUE, 0},
8343 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
8344 {":relief", IMAGE_INTEGER_VALUE, 0},
8345 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8346 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8347 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8348 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
8349};
8350
8351/* Structure describing the image type `ghostscript'. */
8352
8353static struct image_type gs_type =
8354{
8355 &Qpostscript,
8356 gs_image_p,
8357 gs_load,
8358 gs_clear_image,
8359 NULL
8360};
8361
8362
8363/* Free X resources of Ghostscript image IMG which is used on frame F. */
8364
8365static void
d3da34e0 8366gs_clear_image (struct frame *f, struct image *img)
4ef0d4d0
KS
8367{
8368 /* IMG->data.ptr_val may contain a recorded colormap. */
8369 xfree (img->data.ptr_val);
8370 x_clear_image (f, img);
8371}
8372
8373
8374/* Return non-zero if OBJECT is a valid Ghostscript image
8375 specification. */
8376
8377static int
d3da34e0 8378gs_image_p (Lisp_Object object)
4ef0d4d0
KS
8379{
8380 struct image_keyword fmt[GS_LAST];
8381 Lisp_Object tem;
8382 int i;
8383
72af86bd 8384 memcpy (fmt, gs_format, sizeof fmt);
4ef0d4d0
KS
8385
8386 if (!parse_image_spec (object, fmt, GS_LAST, Qpostscript))
8387 return 0;
8388
8389 /* Bounding box must be a list or vector containing 4 integers. */
8390 tem = fmt[GS_BOUNDING_BOX].value;
8391 if (CONSP (tem))
8392 {
8393 for (i = 0; i < 4; ++i, tem = XCDR (tem))
8394 if (!CONSP (tem) || !INTEGERP (XCAR (tem)))
8395 return 0;
8396 if (!NILP (tem))
8397 return 0;
8398 }
8399 else if (VECTORP (tem))
8400 {
8401 if (XVECTOR (tem)->size != 4)
8402 return 0;
8403 for (i = 0; i < 4; ++i)
8404 if (!INTEGERP (XVECTOR (tem)->contents[i]))
8405 return 0;
8406 }
8407 else
8408 return 0;
8409
8410 return 1;
8411}
8412
8413
8414/* Load Ghostscript image IMG for use on frame F. Value is non-zero
8415 if successful. */
8416
8417static int
d3da34e0 8418gs_load (struct frame *f, struct image *img)
4ef0d4d0
KS
8419{
8420 char buffer[100];
8421 Lisp_Object window_and_pixmap_id = Qnil, loader, pt_height, pt_width;
4ef0d4d0
KS
8422 Lisp_Object frame;
8423 double in_width, in_height;
8424 Lisp_Object pixel_colors = Qnil;
8425
8426 /* Compute pixel size of pixmap needed from the given size in the
8427 image specification. Sizes in the specification are in pt. 1 pt
8428 = 1/72 in, xdpi and ydpi are stored in the frame's X display
8429 info. */
8430 pt_width = image_spec_value (img->spec, QCpt_width, NULL);
7574650a 8431 in_width = INTEGERP (pt_width) ? XFASTINT (pt_width) / 72.0 : 0;
4ef0d4d0
KS
8432 img->width = in_width * FRAME_X_DISPLAY_INFO (f)->resx;
8433 pt_height = image_spec_value (img->spec, QCpt_height, NULL);
7574650a 8434 in_height = INTEGERP (pt_height) ? XFASTINT (pt_height) / 72.0 : 0;
4ef0d4d0
KS
8435 img->height = in_height * FRAME_X_DISPLAY_INFO (f)->resy;
8436
f1f25b99
CY
8437 if (!check_image_size (f, img->width, img->height))
8438 {
10ea2b82 8439 image_error ("Invalid image size (see `max-image-size')", Qnil, Qnil);
f1f25b99
CY
8440 return 0;
8441 }
8442
4ef0d4d0
KS
8443 /* Create the pixmap. */
8444 xassert (img->pixmap == NO_PIXMAP);
8445
8446 /* Only W32 version did BLOCK_INPUT here. ++kfs */
8447 BLOCK_INPUT;
8448 img->pixmap = XCreatePixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
8449 img->width, img->height,
8450 DefaultDepthOfScreen (FRAME_X_SCREEN (f)));
8451 UNBLOCK_INPUT;
8452
8453 if (!img->pixmap)
8454 {
8455 image_error ("Unable to create pixmap for `%s'", img->spec, Qnil);
8456 return 0;
8457 }
8458
8459 /* Call the loader to fill the pixmap. It returns a process object
8460 if successful. We do not record_unwind_protect here because
8461 other places in redisplay like calling window scroll functions
8462 don't either. Let the Lisp loader use `unwind-protect' instead. */
4ef0d4d0
KS
8463 sprintf (buffer, "%lu %lu",
8464 (unsigned long) FRAME_X_WINDOW (f),
8465 (unsigned long) img->pixmap);
8466 window_and_pixmap_id = build_string (buffer);
8467
8468 sprintf (buffer, "%lu %lu",
8469 FRAME_FOREGROUND_PIXEL (f),
8470 FRAME_BACKGROUND_PIXEL (f));
8471 pixel_colors = build_string (buffer);
8472
8473 XSETFRAME (frame, f);
8474 loader = image_spec_value (img->spec, QCloader, NULL);
8475 if (NILP (loader))
8476 loader = intern ("gs-load-image");
8477
8478 img->data.lisp_val = call6 (loader, frame, img->spec,
8479 make_number (img->width),
8480 make_number (img->height),
8481 window_and_pixmap_id,
8482 pixel_colors);
4ef0d4d0
KS
8483 return PROCESSP (img->data.lisp_val);
8484}
8485
8486
8487/* Kill the Ghostscript process that was started to fill PIXMAP on
8488 frame F. Called from XTread_socket when receiving an event
8489 telling Emacs that Ghostscript has finished drawing. */
8490
8491void
d3da34e0 8492x_kill_gs_process (Pixmap pixmap, struct frame *f)
4ef0d4d0 8493{
354884c4 8494 struct image_cache *c = FRAME_IMAGE_CACHE (f);
4ef0d4d0
KS
8495 int class, i;
8496 struct image *img;
8497
8498 /* Find the image containing PIXMAP. */
8499 for (i = 0; i < c->used; ++i)
8500 if (c->images[i]->pixmap == pixmap)
8501 break;
8502
8503 /* Should someone in between have cleared the image cache, for
8504 instance, give up. */
8505 if (i == c->used)
8506 return;
8507
8508 /* Kill the GS process. We should have found PIXMAP in the image
8509 cache and its image should contain a process object. */
8510 img = c->images[i];
8511 xassert (PROCESSP (img->data.lisp_val));
8512 Fkill_process (img->data.lisp_val, Qnil);
8513 img->data.lisp_val = Qnil;
8514
8515#if defined (HAVE_X_WINDOWS)
8516
8517 /* On displays with a mutable colormap, figure out the colors
8518 allocated for the image by looking at the pixels of an XImage for
8519 img->pixmap. */
8520 class = FRAME_X_VISUAL (f)->class;
8521 if (class != StaticColor && class != StaticGray && class != TrueColor)
8522 {
8523 XImagePtr ximg;
8524
8525 BLOCK_INPUT;
8526
8527 /* Try to get an XImage for img->pixmep. */
8528 ximg = XGetImage (FRAME_X_DISPLAY (f), img->pixmap,
8529 0, 0, img->width, img->height, ~0, ZPixmap);
8530 if (ximg)
8531 {
8532 int x, y;
8533
8534 /* Initialize the color table. */
8535 init_color_table ();
8536
8537 /* For each pixel of the image, look its color up in the
8538 color table. After having done so, the color table will
8539 contain an entry for each color used by the image. */
8540 for (y = 0; y < img->height; ++y)
8541 for (x = 0; x < img->width; ++x)
8542 {
8543 unsigned long pixel = XGetPixel (ximg, x, y);
8544 lookup_pixel_color (f, pixel);
8545 }
8546
8547 /* Record colors in the image. Free color table and XImage. */
8548#ifdef COLOR_TABLE_SUPPORT
8549 img->colors = colors_in_color_table (&img->ncolors);
8550 free_color_table ();
8551#endif
8552 XDestroyImage (ximg);
8553
8554#if 0 /* This doesn't seem to be the case. If we free the colors
8555 here, we get a BadAccess later in x_clear_image when
8556 freeing the colors. */
8557 /* We have allocated colors once, but Ghostscript has also
8558 allocated colors on behalf of us. So, to get the
8559 reference counts right, free them once. */
8560 if (img->ncolors)
8561 x_free_colors (f, img->colors, img->ncolors);
8562#endif
8563 }
8564 else
8565 image_error ("Cannot get X image of `%s'; colors will not be freed",
8566 img->spec, Qnil);
8567
8568 UNBLOCK_INPUT;
8569 }
8570#endif /* HAVE_X_WINDOWS */
8571
8572 /* Now that we have the pixmap, compute mask and transform the
8573 image if requested. */
8574 BLOCK_INPUT;
8575 postprocess_image (f, img);
8576 UNBLOCK_INPUT;
8577}
8578
8579#endif /* HAVE_GHOSTSCRIPT */
8580
8581\f
8582/***********************************************************************
8583 Tests
8584 ***********************************************************************/
8585
8586#if GLYPH_DEBUG
8587
a7ca3326 8588DEFUN ("imagep", Fimagep, Simagep, 1, 1, 0,
4ef0d4d0 8589 doc: /* Value is non-nil if SPEC is a valid image specification. */)
5842a27b 8590 (Lisp_Object spec)
4ef0d4d0
KS
8591{
8592 return valid_image_p (spec) ? Qt : Qnil;
8593}
8594
8595
a7ca3326 8596DEFUN ("lookup-image", Flookup_image, Slookup_image, 1, 1, 0, "")
5842a27b 8597 (Lisp_Object spec)
4ef0d4d0
KS
8598{
8599 int id = -1;
8600
8601 if (valid_image_p (spec))
8602 id = lookup_image (SELECTED_FRAME (), spec);
8603
8604 debug_print (spec);
8605 return make_number (id);
8606}
8607
8608#endif /* GLYPH_DEBUG != 0 */
8609
8610
8611/***********************************************************************
8612 Initialization
8613 ***********************************************************************/
8614
0855eb52
JB
8615#ifdef HAVE_NTGUI
8616/* Image types that rely on external libraries are loaded dynamically
8617 if the library is available. */
adac86db 8618#define CHECK_LIB_AVAILABLE(image_type, init_lib_fn, libraries) \
0855eb52
JB
8619 define_image_type (image_type, init_lib_fn (libraries))
8620#else
adac86db 8621#define CHECK_LIB_AVAILABLE(image_type, init_lib_fn, libraries) \
e0e30823 8622 define_image_type (image_type, 1)
0855eb52
JB
8623#endif /* HAVE_NTGUI */
8624
8625DEFUN ("init-image-library", Finit_image_library, Sinit_image_library, 2, 2, 0,
8626 doc: /* Initialize image library implementing image type TYPE.
8627Return non-nil if TYPE is a supported image type.
8628
8629Image types pbm and xbm are prebuilt; other types are loaded here.
8630Libraries to load are specified in alist LIBRARIES (usually, the value
2e288d54 8631of `dynamic-library-alist', which see). */)
5842a27b 8632 (Lisp_Object type, Lisp_Object libraries)
0855eb52
JB
8633{
8634 Lisp_Object tested;
8635
8636 /* Don't try to reload the library. */
8637 tested = Fassq (type, Vimage_type_cache);
8638 if (CONSP (tested))
8639 return XCDR (tested);
8640
9e2a2647 8641#if defined (HAVE_XPM) || defined (HAVE_NS)
0855eb52 8642 if (EQ (type, Qxpm))
adac86db 8643 return CHECK_LIB_AVAILABLE (&xpm_type, init_xpm_functions, libraries);
0855eb52
JB
8644#endif
8645
9e2a2647 8646#if defined (HAVE_JPEG) || defined (HAVE_NS)
0855eb52 8647 if (EQ (type, Qjpeg))
adac86db 8648 return CHECK_LIB_AVAILABLE (&jpeg_type, init_jpeg_functions, libraries);
0855eb52
JB
8649#endif
8650
9e2a2647 8651#if defined (HAVE_TIFF) || defined (HAVE_NS)
0855eb52 8652 if (EQ (type, Qtiff))
adac86db 8653 return CHECK_LIB_AVAILABLE (&tiff_type, init_tiff_functions, libraries);
0855eb52
JB
8654#endif
8655
9e2a2647 8656#if defined (HAVE_GIF) || defined (HAVE_NS)
0855eb52 8657 if (EQ (type, Qgif))
adac86db 8658 return CHECK_LIB_AVAILABLE (&gif_type, init_gif_functions, libraries);
0855eb52
JB
8659#endif
8660
9e2a2647 8661#if defined (HAVE_PNG) || defined (HAVE_NS)
0855eb52 8662 if (EQ (type, Qpng))
adac86db 8663 return CHECK_LIB_AVAILABLE (&png_type, init_png_functions, libraries);
0855eb52
JB
8664#endif
8665
4ab27a43
GM
8666#if defined (HAVE_RSVG)
8667 if (EQ (type, Qsvg))
8668 return CHECK_LIB_AVAILABLE (&svg_type, init_svg_functions, libraries);
8669#endif
c21e6151 8670
3de25479 8671#if defined (HAVE_IMAGEMAGICK)
7574650a
AS
8672 if (EQ (type, Qimagemagick))
8673 {
7574650a
AS
8674 return CHECK_LIB_AVAILABLE (&imagemagick_type, init_imagemagick_functions,
8675 libraries);
8676 }
3de25479
JV
8677#endif
8678
0855eb52
JB
8679#ifdef HAVE_GHOSTSCRIPT
8680 if (EQ (type, Qpostscript))
adac86db 8681 return CHECK_LIB_AVAILABLE (&gs_type, init_gs_functions, libraries);
0855eb52
JB
8682#endif
8683
8684 /* If the type is not recognized, avoid testing it ever again. */
adac86db 8685 CACHE_IMAGE_TYPE (type, Qnil);
0855eb52
JB
8686 return Qnil;
8687}
8688
4ef0d4d0 8689void
d3da34e0 8690syms_of_image (void)
4ef0d4d0 8691{
6e6fc3fd
RS
8692 /* Initialize this only once, since that's what we do with Vimage_types
8693 and they are supposed to be in sync. Initializing here gives correct
8694 operation on GNU/Linux of calling dump-emacs after loading some images. */
8695 image_types = NULL;
8696
0855eb52
JB
8697 /* Must be defined now becase we're going to update it below, while
8698 defining the supported image types. */
29208e82 8699 DEFVAR_LISP ("image-types", Vimage_types,
0855eb52 8700 doc: /* List of potentially supported image types.
bbe6f2aa 8701Each element of the list is a symbol for an image type, like 'jpeg or 'png.
0855eb52
JB
8702To check whether it is really supported, use `image-type-available-p'. */);
8703 Vimage_types = Qnil;
8704
29208e82 8705 DEFVAR_LISP ("max-image-size", Vmax_image_size,
7df4765a
KS
8706 doc: /* Maximum size of images.
8707Emacs will not load an image into memory if its pixel width or
8708pixel height exceeds this limit.
8709
8710If the value is an integer, it directly specifies the maximum
8711image height and width, measured in pixels. If it is a floating
8712point number, it specifies the maximum image height and width
8713as a ratio to the frame height and width. If the value is
8714non-numeric, there is no explicit limit on the size of images. */);
f1f25b99
CY
8715 Vmax_image_size = make_float (MAX_IMAGE_SIZE);
8716
0855eb52
JB
8717 Vimage_type_cache = Qnil;
8718 staticpro (&Vimage_type_cache);
8719
d67b4f80 8720 Qpbm = intern_c_string ("pbm");
7c4e3a32 8721 staticpro (&Qpbm);
5fc9fdeb 8722 ADD_IMAGE_TYPE (Qpbm);
7c4e3a32 8723
d67b4f80 8724 Qxbm = intern_c_string ("xbm");
7c4e3a32 8725 staticpro (&Qxbm);
5fc9fdeb 8726 ADD_IMAGE_TYPE (Qxbm);
7c4e3a32
RS
8727
8728 define_image_type (&xbm_type, 1);
8729 define_image_type (&pbm_type, 1);
8730
d67b4f80 8731 Qcount = intern_c_string ("count");
e047f448 8732 staticpro (&Qcount);
1546c559
JL
8733 Qextension_data = intern_c_string ("extension-data");
8734 staticpro (&Qextension_data);
e047f448 8735
d67b4f80 8736 QCascent = intern_c_string (":ascent");
4ef0d4d0 8737 staticpro (&QCascent);
d67b4f80 8738 QCmargin = intern_c_string (":margin");
4ef0d4d0 8739 staticpro (&QCmargin);
d67b4f80 8740 QCrelief = intern_c_string (":relief");
4ef0d4d0 8741 staticpro (&QCrelief);
d67b4f80 8742 QCconversion = intern_c_string (":conversion");
4ef0d4d0 8743 staticpro (&QCconversion);
d67b4f80 8744 QCcolor_symbols = intern_c_string (":color-symbols");
4ef0d4d0 8745 staticpro (&QCcolor_symbols);
d67b4f80 8746 QCheuristic_mask = intern_c_string (":heuristic-mask");
4ef0d4d0 8747 staticpro (&QCheuristic_mask);
d67b4f80 8748 QCindex = intern_c_string (":index");
4ef0d4d0 8749 staticpro (&QCindex);
088dcc3e 8750 QCgeometry = intern_c_string (":geometry");
3de25479 8751 staticpro (&QCgeometry);
088dcc3e 8752 QCcrop = intern_c_string (":crop");
3de25479 8753 staticpro (&QCcrop);
088dcc3e 8754 QCrotation = intern_c_string (":rotation");
3de25479 8755 staticpro (&QCrotation);
d67b4f80 8756 QCmatrix = intern_c_string (":matrix");
4ef0d4d0 8757 staticpro (&QCmatrix);
d67b4f80 8758 QCcolor_adjustment = intern_c_string (":color-adjustment");
4ef0d4d0 8759 staticpro (&QCcolor_adjustment);
d67b4f80 8760 QCmask = intern_c_string (":mask");
4ef0d4d0
KS
8761 staticpro (&QCmask);
8762
d67b4f80 8763 Qlaplace = intern_c_string ("laplace");
4ef0d4d0 8764 staticpro (&Qlaplace);
d67b4f80 8765 Qemboss = intern_c_string ("emboss");
4ef0d4d0 8766 staticpro (&Qemboss);
d67b4f80 8767 Qedge_detection = intern_c_string ("edge-detection");
4ef0d4d0 8768 staticpro (&Qedge_detection);
d67b4f80 8769 Qheuristic = intern_c_string ("heuristic");
4ef0d4d0 8770 staticpro (&Qheuristic);
4ef0d4d0 8771
d67b4f80 8772 Qpostscript = intern_c_string ("postscript");
4ef0d4d0
KS
8773 staticpro (&Qpostscript);
8774#ifdef HAVE_GHOSTSCRIPT
5fc9fdeb 8775 ADD_IMAGE_TYPE (Qpostscript);
d67b4f80 8776 QCloader = intern_c_string (":loader");
4ef0d4d0 8777 staticpro (&QCloader);
d67b4f80 8778 QCbounding_box = intern_c_string (":bounding-box");
4ef0d4d0 8779 staticpro (&QCbounding_box);
d67b4f80 8780 QCpt_width = intern_c_string (":pt-width");
4ef0d4d0 8781 staticpro (&QCpt_width);
d67b4f80 8782 QCpt_height = intern_c_string (":pt-height");
4ef0d4d0
KS
8783 staticpro (&QCpt_height);
8784#endif /* HAVE_GHOSTSCRIPT */
8785
5be1c984
EZ
8786#ifdef HAVE_NTGUI
8787 Qlibpng_version = intern_c_string ("libpng-version");
8788 staticpro (&Qlibpng_version);
0514b4be 8789 Fset (Qlibpng_version,
5be1c984 8790#if HAVE_PNG
0514b4be 8791 make_number (PNG_LIBPNG_VER)
5be1c984 8792#else
0514b4be 8793 make_number (-1)
5be1c984 8794#endif
0514b4be 8795 );
5be1c984
EZ
8796#endif
8797
9e2a2647 8798#if defined (HAVE_XPM) || defined (HAVE_NS)
d67b4f80 8799 Qxpm = intern_c_string ("xpm");
4ef0d4d0 8800 staticpro (&Qxpm);
5fc9fdeb 8801 ADD_IMAGE_TYPE (Qxpm);
4ef0d4d0
KS
8802#endif
8803
9e2a2647 8804#if defined (HAVE_JPEG) || defined (HAVE_NS)
d67b4f80 8805 Qjpeg = intern_c_string ("jpeg");
4ef0d4d0 8806 staticpro (&Qjpeg);
5fc9fdeb 8807 ADD_IMAGE_TYPE (Qjpeg);
4ef0d4d0
KS
8808#endif
8809
9e2a2647 8810#if defined (HAVE_TIFF) || defined (HAVE_NS)
d67b4f80 8811 Qtiff = intern_c_string ("tiff");
4ef0d4d0 8812 staticpro (&Qtiff);
5fc9fdeb 8813 ADD_IMAGE_TYPE (Qtiff);
4ef0d4d0
KS
8814#endif
8815
9e2a2647 8816#if defined (HAVE_GIF) || defined (HAVE_NS)
d67b4f80 8817 Qgif = intern_c_string ("gif");
4ef0d4d0 8818 staticpro (&Qgif);
5fc9fdeb 8819 ADD_IMAGE_TYPE (Qgif);
4ef0d4d0
KS
8820#endif
8821
9e2a2647 8822#if defined (HAVE_PNG) || defined (HAVE_NS)
d67b4f80 8823 Qpng = intern_c_string ("png");
4ef0d4d0 8824 staticpro (&Qpng);
5fc9fdeb 8825 ADD_IMAGE_TYPE (Qpng);
4ef0d4d0
KS
8826#endif
8827
3de25479 8828#if defined (HAVE_IMAGEMAGICK)
088dcc3e 8829 Qimagemagick = intern_c_string ("imagemagick");
3de25479
JV
8830 staticpro (&Qimagemagick);
8831 ADD_IMAGE_TYPE (Qimagemagick);
8832#endif
7574650a 8833
4ab27a43 8834#if defined (HAVE_RSVG)
d67b4f80 8835 Qsvg = intern_c_string ("svg");
4ab27a43 8836 staticpro (&Qsvg);
5fc9fdeb
JR
8837 ADD_IMAGE_TYPE (Qsvg);
8838#ifdef HAVE_NTGUI
df23bf08 8839 /* Other libraries used directly by svg code. */
d67b4f80 8840 Qgdk_pixbuf = intern_c_string ("gdk-pixbuf");
5fc9fdeb 8841 staticpro (&Qgdk_pixbuf);
d67b4f80 8842 Qglib = intern_c_string ("glib");
5fc9fdeb 8843 staticpro (&Qglib);
d67b4f80 8844 Qgobject = intern_c_string ("gobject");
df23bf08 8845 staticpro (&Qgobject);
5fc9fdeb
JR
8846#endif /* HAVE_NTGUI */
8847#endif /* HAVE_RSVG */
4ab27a43 8848
0855eb52 8849 defsubr (&Sinit_image_library);
7574650a 8850#ifdef HAVE_IMAGEMAGICK
3de25479 8851 defsubr (&Simagemagick_types);
7574650a 8852#endif
4ef0d4d0 8853 defsubr (&Sclear_image_cache);
110683ad 8854 defsubr (&Simage_flush);
4ef0d4d0
KS
8855 defsubr (&Simage_size);
8856 defsubr (&Simage_mask_p);
1546c559 8857 defsubr (&Simage_metadata);
4ef0d4d0
KS
8858
8859#if GLYPH_DEBUG
8860 defsubr (&Simagep);
8861 defsubr (&Slookup_image);
8862#endif
8863
29208e82 8864 DEFVAR_BOOL ("cross-disabled-images", cross_disabled_images,
4ef0d4d0 8865 doc: /* Non-nil means always draw a cross over disabled images.
3046a84b 8866Disabled images are those having a `:conversion disabled' property.
4ef0d4d0
KS
8867A cross is always drawn on black & white displays. */);
8868 cross_disabled_images = 0;
8869
29208e82 8870 DEFVAR_LISP ("x-bitmap-file-path", Vx_bitmap_file_path,
4ef0d4d0
KS
8871 doc: /* List of directories to search for window system bitmap files. */);
8872 Vx_bitmap_file_path = decode_env_path ((char *) 0, PATH_BITMAPS);
8873
29208e82 8874 DEFVAR_LISP ("image-cache-eviction-delay", Vimage_cache_eviction_delay,
98fe5161
CY
8875 doc: /* Maximum time after which images are removed from the cache.
8876When an image has not been displayed this many seconds, Emacs
8877automatically removes it from the image cache. If the cache contains
8878a large number of images, the actual eviction time may be shorter.
8879The value can also be nil, meaning the cache is never cleared.
8880
8881The function `clear-image-cache' disregards this variable. */);
8882 Vimage_cache_eviction_delay = make_number (300);
7574650a 8883#ifdef HAVE_IMAGEMAGICK
29208e82 8884 DEFVAR_LISP ("imagemagick-render-type", Vimagemagick_render_type,
4917006b 8885 doc: /* Choose between ImageMagick render methods. */);
7574650a 8886#endif
4ef0d4d0 8887
4ef0d4d0
KS
8888}
8889
4ef0d4d0 8890void
d3da34e0 8891init_image (void)
4ef0d4d0 8892{
4ef0d4d0 8893}