image.el 25.8 KB
Newer Older
Gerd Moellmann's avatar
Gerd Moellmann committed
1 2
;;; image.el --- image API

3 4
;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
;;   2007, 2008, 2009, 2010  Free Software Foundation, Inc.
Pavel Janík's avatar
Pavel Janík committed
5 6

;; Maintainer: FSF
Dave Love's avatar
Dave Love committed
7
;; Keywords: multimedia
Gerd Moellmann's avatar
Gerd Moellmann committed
8 9 10

;; This file is part of GNU Emacs.

11
;; GNU Emacs is free software: you can redistribute it and/or modify
Gerd Moellmann's avatar
Gerd Moellmann committed
12
;; it under the terms of the GNU General Public License as published by
13 14
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Gerd Moellmann's avatar
Gerd Moellmann committed
15 16 17 18 19 20 21

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
22
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Gerd Moellmann's avatar
Gerd Moellmann committed
23 24 25 26 27

;;; Commentary:

;;; Code:

Miles Bader's avatar
Miles Bader committed
28 29 30 31 32 33

(defgroup image ()
  "Image support."
  :group 'multimedia)


34
(defconst image-type-header-regexps
35
  `(("\\`/[\t\n\r ]*\\*.*XPM.\\*/" . xpm)
36
    ("\\`P[1-6][[:space:]]+\\(?:#.*[[:space:]]+\\)*[0-9]+[[:space:]]+[0-9]+" . pbm)
37
    ("\\`GIF8[79]a" . gif)
38
    ("\\`\x89PNG\r\n\x1a\n" . png)
39 40 41 42 43
    ("\\`[\t\n\r ]*#define \\([a-z0-9_]+\\)_width [0-9]+\n\
#define \\1_height [0-9]+\n\\(\
#define \\1_x_hot [0-9]+\n\
#define \\1_y_hot [0-9]+\n\\)?\
static \\(unsigned \\)?char \\1_bits" . xbm)
44 45
    ("\\`\\(?:MM\0\\*\\|II\\*\0\\)" . tiff)
    ("\\`[\t\n\r ]*%!PS" . postscript)
46
    ("\\`\xff\xd8" . jpeg)    ; used to be (image-jpeg-p . jpeg)
47 48 49 50 51 52 53 54
    (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
	     (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
	(concat "\\(?:<\\?xml[ \t\r\n]+[^>]*>\\)?[ \t\r\n]*<"
		comment-re "*"
		"\\(?:!DOCTYPE[ \t\r\n]+[^>]*>[ \t\r\n]*<[ \t\r\n]*" comment-re "*\\)?"
		"[Ss][Vv][Gg]"))
     . svg)
    )
55
  "Alist of (REGEXP . IMAGE-TYPE) pairs used to auto-detect image types.
Gerd Moellmann's avatar
Gerd Moellmann committed
56
When the first bytes of an image file match REGEXP, it is assumed to
57 58 59 60
be of image type IMAGE-TYPE if IMAGE-TYPE is a symbol.  If not a symbol,
IMAGE-TYPE must be a pair (PREDICATE . TYPE).  PREDICATE is called
with one argument, a string containing the image data.  If PREDICATE returns
a non-nil value, TYPE is the image's type.")
61

62 63 64 65 66 67 68 69 70
(defconst image-type-file-name-regexps
  '(("\\.png\\'" . png)
    ("\\.gif\\'" . gif)
    ("\\.jpe?g\\'" . jpeg)
    ("\\.bmp\\'" . bmp)
    ("\\.xpm\\'" . xpm)
    ("\\.pbm\\'" . pbm)
    ("\\.xbm\\'" . xbm)
    ("\\.ps\\'" . postscript)
71 72 73
    ("\\.tiff?\\'" . tiff)
    ("\\.svgz?\\'" . svg)
    )
74 75 76 77
  "Alist of (REGEXP . IMAGE-TYPE) pairs used to identify image files.
When the name of an image file match REGEXP, it is assumed to
be of image type IMAGE-TYPE.")

78 79 80
;; We rely on `auto-mode-alist' to detect xbm and xpm files, instead
;; of content autodetection.  Their contents are just C code, so it is
;; easy to generate false matches.
81 82
(defvar image-type-auto-detectable
  '((pbm . t)
83
    (xbm . nil)
84 85 86
    (bmp . maybe)
    (gif . maybe)
    (png . maybe)
87
    (xpm . nil)
88 89
    (jpeg . maybe)
    (tiff . maybe)
90
    (svg . maybe)
91 92 93 94 95 96 97 98 99
    (postscript . nil))
  "Alist of (IMAGE-TYPE . AUTODETECT) pairs used to auto-detect image files.
\(See `image-type-auto-detected-p').

AUTODETECT can be
 - t      always auto-detect.
 - nil    never auto-detect.
 - maybe  auto-detect only if the image type is available
	    (see `image-type-available-p').")
100

101 102 103
(defcustom image-load-path
  (list (file-name-as-directory (expand-file-name "images" data-directory))
        'data-directory 'load-path)
104
  "List of locations in which to search for image files.
105 106 107 108
If an element is a string, it defines a directory to search.
If an element is a variable symbol whose value is a string, that
value defines a directory to search.
If an element is a variable symbol whose value is a list, the
109 110 111
value is used as a list of directories to search."
  :type '(repeat (choice directory variable))
  :initialize 'custom-initialize-delay)
112

113

114
(defun image-load-path-for-library (library image &optional path no-error)
115
  "Return a suitable search path for images used by LIBRARY.
116

117
It searches for IMAGE in `image-load-path' (excluding
118 119 120 121
\"`data-directory'/images\") and `load-path', followed by a path
suitable for LIBRARY, which includes \"../../etc/images\" and
\"../etc/images\" relative to the library file itself, and then
in \"`data-directory'/images\".
122

123 124
Then this function returns a list of directories which contains
first the directory in which IMAGE was found, followed by the
125
value of `load-path'.  If PATH is given, it is used instead of
126
`load-path'.
127

128
If NO-ERROR is non-nil and a suitable path can't be found, don't
129
signal an error.  Instead, return a list of directories as before,
130
except that nil appears in place of the image directory.
131 132 133 134 135

Here is an example that uses a common idiom to provide
compatibility with versions of Emacs that lack the variable
`image-load-path':

136 137
    ;; Shush compiler.
    (defvar image-load-path)
138 139

    (let* ((load-path (image-load-path-for-library \"mh-e\" \"mh-logo.xpm\"))
140 141 142
           (image-load-path (cons (car load-path)
                                  (when (boundp 'image-load-path)
                                    image-load-path))))
143
      (mh-tool-bar-folder-buttons-init))"
144 145
  (unless library (error "No library specified"))
  (unless image   (error "No image specified"))
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
  (let (image-directory image-directory-load-path)
    ;; Check for images in image-load-path or load-path.
    (let ((img image)
          (dir (or
                ;; Images in image-load-path.
                (image-search-load-path image)
                ;; Images in load-path.
                (locate-library image)))
          parent)
      ;; Since the image might be in a nested directory (for
      ;; example, mail/attach.pbm), adjust `image-directory'
      ;; accordingly.
      (when dir
        (setq dir (file-name-directory dir))
        (while (setq parent (file-name-directory img))
          (setq img (directory-file-name parent)
                dir (expand-file-name "../" dir))))
      (setq image-directory-load-path dir))

    ;; If `image-directory-load-path' isn't Emacs' image directory,
    ;; it's probably a user preference, so use it. Then use a
    ;; relative setting if possible; otherwise, use
    ;; `image-directory-load-path'.
169
    (cond
170 171 172 173 174 175
     ;; User-modified image-load-path?
     ((and image-directory-load-path
           (not (equal image-directory-load-path
                       (file-name-as-directory
                        (expand-file-name "images" data-directory)))))
      (setq image-directory image-directory-load-path))
176 177 178 179 180 181 182 183 184
     ;; Try relative setting.
     ((let (library-name d1ei d2ei)
        ;; First, find library in the load-path.
        (setq library-name (locate-library library))
        (if (not library-name)
            (error "Cannot find library %s in load-path" library))
        ;; And then set image-directory relative to that.
        (setq
         ;; Go down 2 levels.
185 186 187
         d2ei (file-name-as-directory
               (expand-file-name
                (concat (file-name-directory library-name) "../../etc/images")))
188
         ;; Go down 1 level.
189 190 191
         d1ei (file-name-as-directory
               (expand-file-name
                (concat (file-name-directory library-name) "../etc/images"))))
192 193 194 195
        (setq image-directory
              ;; Set it to nil if image is not found.
              (cond ((file-exists-p (expand-file-name image d2ei)) d2ei)
                    ((file-exists-p (expand-file-name image d1ei)) d1ei)))))
196 197 198
     ;; Use Emacs' image directory.
     (image-directory-load-path
      (setq image-directory image-directory-load-path))
199 200
     (no-error
      (message "Could not find image %s for library %s" image library))
201 202 203
     (t
      (error "Could not find image %s for library %s" image library)))

204 205 206 207
    ;; Return an augmented `path' or `load-path'.
    (nconc (list image-directory)
           (delete image-directory (copy-sequence (or path load-path))))))

208

209
(defun image-jpeg-p (data)
210 211
  "Value is non-nil if DATA, a string, consists of JFIF image data.
We accept the tag Exif because that is the same format."
212 213
  (setq data (ignore-errors (string-to-unibyte data)))
  (when (and data (string-match-p "\\`\xff\xd8" data))
214 215 216 217 218 219 220 221 222
    (catch 'jfif
      (let ((len (length data)) (i 2))
	(while (< i len)
	  (when (/= (aref data i) #xff)
	    (throw 'jfif nil))
	  (setq i (1+ i))
	  (when (>= (+ i 2) len)
	    (throw 'jfif nil))
	  (let ((nbytes (+ (lsh (aref data (+ i 1)) 8)
223 224 225
			   (aref data (+ i 2))))
		(code (aref data i)))
	    (when (and (>= code #xe0) (<= code #xef))
226
	      ;; APP0 LEN1 LEN2 "JFIF\0"
227
	      (throw 'jfif
228 229
		     (string-match-p "JFIF\\|Exif"
				     (substring data i (min (+ i nbytes) len)))))
230
	    (setq i (+ i 1 nbytes))))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
231 232 233


;;;###autoload
234 235 236
(defun image-type-from-data (data)
  "Determine the image type from image data DATA.
Value is a symbol specifying the image type or nil if type cannot
Gerd Moellmann's avatar
Gerd Moellmann committed
237
be determined."
238
  (let ((types image-type-header-regexps)
Gerd Moellmann's avatar
Gerd Moellmann committed
239
	type)
240
    (while types
Gerd Moellmann's avatar
Gerd Moellmann committed
241
      (let ((regexp (car (car types)))
242
	    (image-type (cdr (car types))))
243
	(if (or (and (symbolp image-type)
244
		     (string-match-p regexp data))
245 246 247 248 249 250 251 252 253 254
		(and (consp image-type)
		     (funcall (car image-type) data)
		     (setq image-type (cdr image-type))))
	    (setq type image-type
		  types nil)
	  (setq types (cdr types)))))
    type))


;;;###autoload
255
(defun image-type-from-buffer ()
256
  "Determine the image type from data in the current buffer.
257 258
Value is a symbol specifying the image type or nil if type cannot
be determined."
259 260 261 262 263 264
  (let ((types image-type-header-regexps)
	type
	(opoint (point)))
    (goto-char (point-min))
    (while types
      (let ((regexp (car (car types)))
265
	    (image-type (cdr (car types)))
266 267
	    data)
	(if (or (and (symbolp image-type)
268
		     (looking-at-p regexp))
269 270 271 272 273 274 275 276 277
		(and (consp image-type)
		     (funcall (car image-type)
			      (or data
				  (setq data
					(buffer-substring
					 (point-min)
					 (min (point-max)
					      (+ (point-min) 256))))))
		     (setq image-type (cdr image-type))))
278
	    (setq type image-type
279 280 281
		  types nil)
	  (setq types (cdr types)))))
    (goto-char opoint)
Gerd Moellmann's avatar
Gerd Moellmann committed
282 283 284
    type))


285 286 287 288 289
;;;###autoload
(defun image-type-from-file-header (file)
  "Determine the type of image file FILE from its first few bytes.
Value is a symbol specifying the image type, or nil if type cannot
be determined."
290 291 292 293 294 295 296 297
  (unless (or (file-readable-p file)
	      (file-name-absolute-p file))
    (setq file (image-search-load-path file)))
  (and file
       (file-readable-p file)
       (with-temp-buffer
	 (set-buffer-multibyte nil)
	 (insert-file-contents-literally file nil 0 256)
298
	 (image-type-from-buffer))))
299 300 301 302 303 304 305


;;;###autoload
(defun image-type-from-file-name (file)
  "Determine the type of image file FILE from its name.
Value is a symbol specifying the image type, or nil if type cannot
be determined."
306
  (assoc-default file image-type-file-name-regexps 'string-match-p))
307 308


Gerd Moellmann's avatar
Gerd Moellmann committed
309
;;;###autoload
310
(defun image-type (source &optional type data-p)
311
  "Determine and return image type.
312
SOURCE is an image file name or image data.
Gerd Moellmann's avatar
Gerd Moellmann committed
313
Optional TYPE is a symbol describing the image type.  If TYPE is omitted
314
or nil, try to determine the image type from its first few bytes
315
of image data.  If that doesn't work, and SOURCE is a file name,
316
use its file extension as image type.
317 318 319
Optional DATA-P non-nil means SOURCE is a string containing image data."
  (when (and (not data-p) (not (stringp source)))
    (error "Invalid image file name `%s'" source))
320
  (unless type
321 322 323 324 325
    (setq type (if data-p
		   (image-type-from-data source)
		 (or (image-type-from-file-header source)
		     (image-type-from-file-name source))))
    (or type (error "Cannot determine image type")))
326
  (or (memq type (and (boundp 'image-types) image-types))
327
      (error "Invalid image type `%s'" type))
328 329
  type)

330

331 332
(defvar image-library-alist)

333 334 335 336 337 338 339 340
;;;###autoload
(defun image-type-available-p (type)
  "Return non-nil if image type TYPE is available.
Image types are symbols like `xbm' or `jpeg'."
  (and (fboundp 'init-image-library)
       (init-image-library type image-library-alist)))


341 342
;;;###autoload
(defun image-type-auto-detected-p ()
343
  "Return t if the current buffer contains an auto-detectable image.
344 345 346 347
This function is intended to be used from `magic-fallback-mode-alist'.

The buffer is considered to contain an auto-detectable image if
its beginning matches an image type in `image-type-header-regexps',
348 349 350
and that image type is present in `image-type-auto-detectable' with a
non-nil value.  If that value is non-nil, but not t, then the image type
must be available."
351 352
  (let* ((type (image-type-from-buffer))
	 (auto (and type (cdr (assq type image-type-auto-detectable)))))
353
    (and auto
354
	 (or (eq auto t) (image-type-available-p type)))))
355 356


357 358 359 360 361 362 363 364 365 366 367 368 369
;;;###autoload
(defun create-image (file-or-data &optional type data-p &rest props)
  "Create an image.
FILE-OR-DATA is an image file name or image data.
Optional TYPE is a symbol describing the image type.  If TYPE is omitted
or nil, try to determine the image type from its first few bytes
of image data.  If that doesn't work, and FILE-OR-DATA is a file name,
use its file extension as image type.
Optional DATA-P non-nil means FILE-OR-DATA is a string containing image data.
Optional PROPS are additional image attributes to assign to the image,
like, e.g. `:mask MASK'.
Value is the image created, or nil if images of type TYPE are not supported.

Glenn Morris's avatar
Glenn Morris committed
370 371 372 373 374 375
Images should not be larger than specified by `max-image-size'.

Image file names that are not absolute are searched for in the
\"images\" sub-directory of `data-directory' and
`x-bitmap-file-path' (in that order)."
  ;; It is x_find_image_file in image.c that sets the search path.
376
  (setq type (image-type file-or-data type data-p))
Gerd Moellmann's avatar
Gerd Moellmann committed
377
  (when (image-type-available-p type)
378 379
    (append (list 'image :type type (if data-p :data :file) file-or-data)
	    props)))
Gerd Moellmann's avatar
Gerd Moellmann committed
380 381 382


;;;###autoload
383
(defun put-image (image pos &optional string area)
384
  "Put image IMAGE in front of POS in the current buffer.
Gerd Moellmann's avatar
Gerd Moellmann committed
385
IMAGE must be an image created with `create-image' or `defimage'.
386 387
IMAGE is displayed by putting an overlay into the current buffer with a
`before-string' STRING that has a `display' property whose value is the
388
image.  STRING is defaulted if you omit it.
Gerd Moellmann's avatar
Gerd Moellmann committed
389 390 391 392
POS may be an integer or marker.
AREA is where to display the image.  AREA nil or omitted means
display it in the text area, a value of `left-margin' means
display it in the left marginal area, a value of `right-margin'
393
means display it in the right marginal area."
394
  (unless string (setq string "x"))
395
  (let ((buffer (current-buffer)))
396
    (unless (eq (car-safe image) 'image)
397 398 399
      (error "Not an image: %s" image))
    (unless (or (null area) (memq area '(left-margin right-margin)))
      (error "Invalid area %s" area))
400
    (setq string (copy-sequence string))
401
    (let ((overlay (make-overlay pos pos buffer))
402 403
	  (prop (if (null area) image (list (list 'margin area) image))))
      (put-text-property 0 (length string) 'display prop string)
404 405
      (overlay-put overlay 'put-image t)
      (overlay-put overlay 'before-string string))))
Gerd Moellmann's avatar
Gerd Moellmann committed
406 407 408


;;;###autoload
409
(defun insert-image (image &optional string area slice)
Gerd Moellmann's avatar
Gerd Moellmann committed
410
  "Insert IMAGE into current buffer at point.
411
IMAGE is displayed by inserting STRING into the current buffer
412 413
with a `display' property whose value is the image.  STRING is
defaulted if you omit it.
Gerd Moellmann's avatar
Gerd Moellmann committed
414 415 416
AREA is where to display the image.  AREA nil or omitted means
display it in the text area, a value of `left-margin' means
display it in the left marginal area, a value of `right-margin'
417 418 419 420 421 422
means display it in the right marginal area.
SLICE specifies slice of IMAGE to insert.  SLICE nil or omitted
means insert whole image.  SLICE is a list (X Y WIDTH HEIGHT)
specifying the X and Y positions and WIDTH and HEIGHT of image area
to insert.  A float value 0.0 - 1.0 means relative to the width or
height of the image; integer values are taken as pixel values."
423 424 425
  ;; Use a space as least likely to cause trouble when it's a hidden
  ;; character in the buffer.
  (unless string (setq string " "))
426
  (unless (eq (car-safe image) 'image)
Gerd Moellmann's avatar
Gerd Moellmann committed
427 428 429
    (error "Not an image: %s" image))
  (unless (or (null area) (memq area '(left-margin right-margin)))
    (error "Invalid area %s" area))
430 431 432 433 434 435 436 437 438
  (if area
      (setq image (list (list 'margin area) image))
    ;; Cons up a new spec equal but not eq to `image' so that
    ;; inserting it twice in a row (adjacently) displays two copies of
    ;; the image.  Don't try to avoid this by looking at the display
    ;; properties on either side so that we DTRT more often with
    ;; cut-and-paste.  (Yanking killed image text next to another copy
    ;; of it loses anyway.)
    (setq image (cons 'image (cdr image))))
439 440 441
  (let ((start (point)))
    (insert string)
    (add-text-properties start (point)
442 443 444 445 446
			 `(display ,(if slice
					(list (cons 'slice slice) image)
				      image) rear-nonsticky (display)))))


447
;;;###autoload
448
(defun insert-sliced-image (image &optional string area rows cols)
449 450 451 452 453 454 455 456
  "Insert IMAGE into current buffer at point.
IMAGE is displayed by inserting STRING into the current buffer
with a `display' property whose value is the image.  STRING is
defaulted if you omit it.
AREA is where to display the image.  AREA nil or omitted means
display it in the text area, a value of `left-margin' means
display it in the left marginal area, a value of `right-margin'
means display it in the right marginal area.
457
The image is automatically split into ROWS x COLS slices."
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
  (unless string (setq string " "))
  (unless (eq (car-safe image) 'image)
    (error "Not an image: %s" image))
  (unless (or (null area) (memq area '(left-margin right-margin)))
    (error "Invalid area %s" area))
  (if area
      (setq image (list (list 'margin area) image))
    ;; Cons up a new spec equal but not eq to `image' so that
    ;; inserting it twice in a row (adjacently) displays two copies of
    ;; the image.  Don't try to avoid this by looking at the display
    ;; properties on either side so that we DTRT more often with
    ;; cut-and-paste.  (Yanking killed image text next to another copy
    ;; of it loses anyway.)
    (setq image (cons 'image (cdr image))))
  (let ((x 0.0) (dx (/ 1.0001 (or cols 1)))
	 (y 0.0) (dy (/ 1.0001 (or rows 1))))
    (while (< y 1.0)
      (while (< x 1.0)
	(let ((start (point)))
	  (insert string)
	  (add-text-properties start (point)
			       `(display ,(list (list 'slice x y dx dy) image)
					 rear-nonsticky (display)))
	  (setq x (+ x dx))))
      (setq x 0.0
	    y (+ y dy))
484
      (insert (propertize "\n" 'line-height t)))))
485

486

Gerd Moellmann's avatar
Gerd Moellmann committed
487 488 489 490 491 492 493 494 495 496 497 498

;;;###autoload
(defun remove-images (start end &optional buffer)
  "Remove images between START and END in BUFFER.
Remove only images that were put in BUFFER with calls to `put-image'.
BUFFER nil or omitted means use the current buffer."
  (unless buffer
    (setq buffer (current-buffer)))
  (let ((overlays (overlays-in start end)))
    (while overlays
      (let ((overlay (car overlays)))
	(when (overlay-get overlay 'put-image)
499 500
	  (delete-overlay overlay)))
      (setq overlays (cdr overlays)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
501

502 503 504 505
(defun image-search-load-path (file &optional path)
  (unless path
    (setq path image-load-path))
  (let (element found filename)
506
    (while (and (not found) (consp path))
507
      (setq element (car path))
508
      (cond
509
       ((stringp element)
510 511
	(setq found
	      (file-readable-p
512
	       (setq filename (expand-file-name file element)))))
513 514 515 516 517 518
       ((and (symbolp element) (boundp element))
	(setq element (symbol-value element))
	(cond
	 ((stringp element)
	  (setq found
		(file-readable-p
519
		 (setq filename (expand-file-name file element)))))
520
	 ((consp element)
521
	  (if (setq filename (image-search-load-path file element))
522
	      (setq found t))))))
523
      (setq path (cdr path)))
524
    (if found filename)))
Gerd Moellmann's avatar
Gerd Moellmann committed
525 526

;;;###autoload
Gerd Moellmann's avatar
Gerd Moellmann committed
527 528
(defun find-image (specs)
  "Find an image, choosing one of a list of image specifications.
Gerd Moellmann's avatar
Gerd Moellmann committed
529

530
SPECS is a list of image specifications.
Gerd Moellmann's avatar
Gerd Moellmann committed
531 532 533

Each image specification in SPECS is a property list.  The contents of
a specification are image type dependent.  All specifications must at
534 535 536
least contain the properties `:type TYPE' and either `:file FILE' or
`:data DATA', where TYPE is a symbol specifying the image type,
e.g. `xbm', FILE is the file to load the image from, and DATA is a
537 538 539 540 541
string containing the actual image data.  The specification whose TYPE
is supported, and FILE exists, is used to construct the image
specification to be returned.  Return nil if no specification is
satisfied.

542 543 544
The image is looked for in `image-load-path'.

Image files should not be larger than specified by `max-image-size'."
Gerd Moellmann's avatar
Gerd Moellmann committed
545 546 547 548
  (let (image)
    (while (and specs (null image))
      (let* ((spec (car specs))
	     (type (plist-get spec :type))
549
	     (data (plist-get spec :data))
550 551
	     (file (plist-get spec :file))
	     found)
552 553
	(when (image-type-available-p type)
	  (cond ((stringp file)
554
		 (if (setq found (image-search-load-path file))
555 556 557
		     (setq image
			   (cons 'image (plist-put (copy-sequence spec)
						   :file found)))))
558
		((not (null data))
559 560
		 (setq image (cons 'image spec)))))
	(setq specs (cdr specs))))
Gerd Moellmann's avatar
Gerd Moellmann committed
561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583
    image))


;;;###autoload
(defmacro defimage (symbol specs &optional doc)
  "Define SYMBOL as an image.

SPECS is a list of image specifications.  DOC is an optional
documentation string.

Each image specification in SPECS is a property list.  The contents of
a specification are image type dependent.  All specifications must at
least contain the properties `:type TYPE' and either `:file FILE' or
`:data DATA', where TYPE is a symbol specifying the image type,
e.g. `xbm', FILE is the file to load the image from, and DATA is a
string containing the actual image data.  The first image
specification whose TYPE is supported, and FILE exists, is used to
define SYMBOL.

Example:

   (defimage test-image ((:type xpm :file \"~/test1.xpm\")
                         (:type xbm :file \"~/test1.xbm\")))"
584
  (declare (doc-string 3))
Gerd Moellmann's avatar
Gerd Moellmann committed
585
  `(defvar ,symbol (find-image ',specs) ,doc))
Gerd Moellmann's avatar
Gerd Moellmann committed
586

Kim F. Storm's avatar
Kim F. Storm committed
587 588

;;; Animated image API
Gerd Moellmann's avatar
Gerd Moellmann committed
589

Kim F. Storm's avatar
Kim F. Storm committed
590 591 592
(defcustom image-animate-max-time 30
  "Time in seconds to animate images."
  :type 'integer
593
  :version "24.1"
Kim F. Storm's avatar
Kim F. Storm committed
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
  :group 'image)

(defconst image-animated-types '(gif)
  "List of supported animated image types.")

;;;###autoload
(defun create-animated-image (file-or-data &optional type data-p &rest props)
  "Create an animated image.
FILE-OR-DATA is an image file name or image data.
Optional TYPE is a symbol describing the image type.  If TYPE is omitted
or nil, try to determine the image type from its first few bytes
of image data.  If that doesn't work, and FILE-OR-DATA is a file name,
use its file extension as image type.
Optional DATA-P non-nil means FILE-OR-DATA is a string containing image data.
Optional PROPS are additional image attributes to assign to the image,
like, e.g. `:mask MASK'.
Value is the image created, or nil if images of type TYPE are not supported.

Images should not be larger than specified by `max-image-size'."
  (setq type (image-type file-or-data type data-p))
  (when (image-type-available-p type)
    (let* ((animate (memq type image-animated-types))
	   (image
	    (append (list 'image :type type (if data-p :data :file) file-or-data)
		    (if animate '(:index 0 :mask heuristic))
		    props)))
      (if animate
	  (image-animate-start image))
      image)))

(defun image-animate-timer (image)
  "Return the animation timer for image IMAGE."
  ;; See cancel-function-timers
  (let ((tail timer-list) timer)
    (while tail
      (setq timer (car tail)
	    tail (cdr tail))
      (if (and (eq (aref timer 5) #'image-animate-timeout)
	       (consp (aref timer 6))
	       (eq (car (aref timer 6)) image))
	  (setq tail nil)
	(setq timer nil)))
    timer))

(defun image-animate-start (image &optional max-time)
  "Start animation of image IMAGE.
Optional second arg MAX-TIME is number of seconds to animate image,
or t to animate infinitely."
  (let ((anim (image-animated-p image))
	timer tmo)
    (when anim
      (if (setq timer (image-animate-timer image))
	  (setcar (nthcdr 3 (aref timer 6)) max-time)
	(setq tmo (* (cdr anim) 0.01))
	(setq max-time (or max-time image-animate-max-time))
	(run-with-timer tmo nil #'image-animate-timeout
			image 1 (car anim)
			(if (numberp max-time)
			    (- max-time tmo)
			  max-time))))))

(defun image-animate-stop (image)
  "Stop animation of image."
  (let ((timer (image-animate-timer image)))
    (when timer
      (cancel-timer timer))))

(defun image-animate-timeout (image ino count time-left)
  (if (>= ino count)
      (setq ino 0))
  (plist-put (cdr image) :index ino)
  (force-window-update)
  (let ((anim (image-animated-p image)) tmo)
    (when anim
      (setq tmo (* (cdr anim) 0.01))
      (unless (and (= ino 0) (numberp time-left) (< time-left tmo))
	(run-with-timer tmo nil #'image-animate-timeout
			image (1+ ino) count
			(if (numberp time-left)
			    (- time-left tmo)
			  time-left))))))

(defun image-animated-p (image)
  "Return non-nil if image is animated.
Actually, return value is a cons (IMAGES . DELAY) where IMAGES
is the number of sub-images in the animated image, and DELAY
is the delay in 100ths of a second until the next sub-image
shall be displayed."
  (cond
   ((eq (plist-get (cdr image) :type) 'gif)
684 685 686
    (let* ((metadata (image-metadata image))
	   (images (plist-get metadata 'count))
	   (extdata (plist-get metadata 'extension-data))
Kim F. Storm's avatar
Kim F. Storm committed
687 688 689 690 691 692
	   (anim (plist-get extdata #xF9)))
      (and (integerp images) (> images 1)
	   (stringp anim) (>= (length anim) 4)
	   (cons images (+ (aref anim 1) (* (aref anim 2) 256))))))))


693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717
(defconst imagemagick-types-inhibit
  '(C HTML HTM TXT)
  "Types the imagemagic loader should not try to handle.")

;;;###autoload
(defun imagemagic-register-types ()
  "Register file types that imagemagick is able to handle."
  (let ((im-types (imagemagick-types))
        (im-inhibit imagemagick-types-inhibit))
    (while im-inhibit
      (setq im-types (remove (car im-inhibit) im-types))
      (setq im-inhibit (cdr im-inhibit)))
    (while im-types
      (let
	  ((extension (downcase (symbol-name (car im-types)))))
	(push
	 (cons  (concat "\\." extension "\\'") 'image-mode)
	 auto-mode-alist)
	(push
	 (cons  (concat "\\." extension "\\'") 'imagemagick)
	 image-type-file-name-regexps)
	(setq im-types (cdr im-types))))))



Gerd Moellmann's avatar
Gerd Moellmann committed
718 719
(provide 'image)

720
;; arch-tag: 8e76a07b-eb48-4f3e-a7a0-1a7ba9f096b3
Dave Love's avatar
Dave Love committed
721
;;; image.el ends here