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

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 1998-2015 Free Software Foundation, Inc.
Pavel Janík's avatar
Pavel Janík committed
4

5
;; Maintainer: emacs-devel@gnu.org
Dave Love's avatar
Dave Love committed
6
;; Keywords: multimedia
7
;; Package: emacs
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

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

33
(defalias 'image-refresh 'image-flush)
Miles Bader's avatar
Miles Bader committed
34

35
(defconst image-type-header-regexps
36
  `(("\\`/[\t\n\r ]*\\*.*XPM.\\*/" . xpm)
37 38 39 40
    ("\\`P[1-6]\\\(?:\
\\(?:\\(?:#[^\r\n]*[\r\n]\\)?[[:space:]]\\)+\
\\(?:\\(?:#[^\r\n]*[\r\n]\\)?[0-9]\\)+\
\\)\\{2\\}" . pbm)
41
    ("\\`GIF8[79]a" . gif)
42
    ("\\`\x89PNG\r\n\x1a\n" . png)
43 44 45 46 47
    ("\\`[\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)
48 49
    ("\\`\\(?:MM\0\\*\\|II\\*\0\\)" . tiff)
    ("\\`[\t\n\r ]*%!PS" . postscript)
50
    ("\\`\xff\xd8" . jpeg)    ; used to be (image-jpeg-p . jpeg)
51 52 53 54 55 56 57 58
    (,(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)
    )
59
  "Alist of (REGEXP . IMAGE-TYPE) pairs used to auto-detect image types.
Gerd Moellmann's avatar
Gerd Moellmann committed
60
When the first bytes of an image file match REGEXP, it is assumed to
61 62 63 64
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.")
65

66
(defvar image-type-file-name-regexps
67 68 69 70 71 72 73 74
  '(("\\.png\\'" . png)
    ("\\.gif\\'" . gif)
    ("\\.jpe?g\\'" . jpeg)
    ("\\.bmp\\'" . bmp)
    ("\\.xpm\\'" . xpm)
    ("\\.pbm\\'" . pbm)
    ("\\.xbm\\'" . xbm)
    ("\\.ps\\'" . postscript)
75 76 77
    ("\\.tiff?\\'" . tiff)
    ("\\.svgz?\\'" . svg)
    )
78 79 80 81
  "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.")

82 83 84
;; 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.
85 86
(defvar image-type-auto-detectable
  '((pbm . t)
87
    (xbm . nil)
88 89 90
    (bmp . maybe)
    (gif . maybe)
    (png . maybe)
91
    (xpm . nil)
92 93
    (jpeg . maybe)
    (tiff . maybe)
94
    (svg . maybe)
95 96 97 98 99 100 101 102 103
    (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').")
104

105
(defvar image-format-suffixes
106
  '((image/x-icon "ico"))
107
  "An alist associating image types with file name suffixes.
108
This is used as a hint by the ImageMagick library when detecting
109 110 111 112 113
the type of image data (that does not have an associated file name).
Each element has the form (MIME-CONTENT-TYPE EXTENSION).
If `create-image' is called with a :format attribute whose value
equals a content-type found in this list, the ImageMagick library is
told that the data would have the associated suffix if saved to a file.")
114

115 116 117
(defcustom image-load-path
  (list (file-name-as-directory (expand-file-name "images" data-directory))
        'data-directory 'load-path)
118
  "List of locations in which to search for image files.
119 120 121 122
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
123 124 125
value is used as a list of directories to search.

Subdirectories are not automatically included in the search."
126 127
  :type '(repeat (choice directory variable))
  :initialize 'custom-initialize-delay)
128

129

130
(defun image-load-path-for-library (library image &optional path no-error)
131
  "Return a suitable search path for images used by LIBRARY.
132

133
It searches for IMAGE in `image-load-path' (excluding
134 135 136 137
\"`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\".
138

139 140
Then this function returns a list of directories which contains
first the directory in which IMAGE was found, followed by the
141
value of `load-path'.  If PATH is given, it is used instead of
142
`load-path'.
143

144
If NO-ERROR is non-nil and a suitable path can't be found, don't
145
signal an error.  Instead, return a list of directories as before,
146
except that nil appears in place of the image directory.
147 148 149 150 151

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

152 153
    ;; Shush compiler.
    (defvar image-load-path)
154 155

    (let* ((load-path (image-load-path-for-library \"mh-e\" \"mh-logo.xpm\"))
156 157 158
           (image-load-path (cons (car load-path)
                                  (when (boundp 'image-load-path)
                                    image-load-path))))
159
      (mh-tool-bar-folder-buttons-init))"
160 161
  (unless library (error "No library specified"))
  (unless image   (error "No image specified"))
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
  (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))

181
    ;; If `image-directory-load-path' isn't Emacs's image directory,
182 183 184
    ;; it's probably a user preference, so use it. Then use a
    ;; relative setting if possible; otherwise, use
    ;; `image-directory-load-path'.
185
    (cond
186 187 188 189 190 191
     ;; 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))
192 193 194 195 196 197 198 199 200
     ;; 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.
201 202 203
         d2ei (file-name-as-directory
               (expand-file-name
                (concat (file-name-directory library-name) "../../etc/images")))
204
         ;; Go down 1 level.
205 206 207
         d1ei (file-name-as-directory
               (expand-file-name
                (concat (file-name-directory library-name) "../etc/images"))))
208 209 210 211
        (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)))))
212
     ;; Use Emacs's image directory.
213 214
     (image-directory-load-path
      (setq image-directory image-directory-load-path))
215 216
     (no-error
      (message "Could not find image %s for library %s" image library))
217 218 219
     (t
      (error "Could not find image %s for library %s" image library)))

220 221 222 223
    ;; Return an augmented `path' or `load-path'.
    (nconc (list image-directory)
           (delete image-directory (copy-sequence (or path load-path))))))

224

225 226
;; Used to be in image-type-header-regexps, but now not used anywhere
;; (since 2009-08-28).
227
(defun image-jpeg-p (data)
228 229
  "Value is non-nil if DATA, a string, consists of JFIF image data.
We accept the tag Exif because that is the same format."
230 231
  (setq data (ignore-errors (string-to-unibyte data)))
  (when (and data (string-match-p "\\`\xff\xd8" data))
232 233 234 235 236 237 238 239 240
    (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)
241 242 243
			   (aref data (+ i 2))))
		(code (aref data i)))
	    (when (and (>= code #xe0) (<= code #xef))
244
	      ;; APP0 LEN1 LEN2 "JFIF\0"
245
	      (throw 'jfif
246 247
		     (string-match-p "JFIF\\|Exif"
				     (substring data i (min (+ i nbytes) len)))))
248
	    (setq i (+ i 1 nbytes))))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
249 250 251


;;;###autoload
252 253 254
(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
255
be determined."
256
  (let ((types image-type-header-regexps)
Gerd Moellmann's avatar
Gerd Moellmann committed
257
	type)
258
    (while types
Gerd Moellmann's avatar
Gerd Moellmann committed
259
      (let ((regexp (car (car types)))
260
	    (image-type (cdr (car types))))
261
	(if (or (and (symbolp image-type)
262
		     (string-match-p regexp data))
263 264 265 266 267 268 269 270 271 272
		(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
273
(defun image-type-from-buffer ()
274
  "Determine the image type from data in the current buffer.
275 276
Value is a symbol specifying the image type or nil if type cannot
be determined."
277 278 279 280 281 282
  (let ((types image-type-header-regexps)
	type
	(opoint (point)))
    (goto-char (point-min))
    (while types
      (let ((regexp (car (car types)))
283
	    (image-type (cdr (car types)))
284 285
	    data)
	(if (or (and (symbolp image-type)
286
		     (looking-at-p regexp))
287 288 289 290 291 292 293 294 295
		(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))))
296
	    (setq type image-type
297 298 299
		  types nil)
	  (setq types (cdr types)))))
    (goto-char opoint)
300
    (and type
301
	 (boundp 'image-types)
302 303
	 (memq type image-types)
	 type)))
Gerd Moellmann's avatar
Gerd Moellmann committed
304 305


306 307 308 309 310
;;;###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."
311 312 313 314 315 316 317 318
  (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)
319
	 (image-type-from-buffer))))
320 321 322 323 324 325 326


;;;###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."
327
  (let (type first)
328 329 330 331 332 333 334
    (catch 'found
      (dolist (elem image-type-file-name-regexps first)
	(when (string-match-p (car elem) file)
	  (if (image-type-available-p (setq type (cdr elem)))
	      (throw 'found type)
	    ;; If nothing seems to be supported, return first type that matched.
	    (or first (setq first type))))))))
335

Gerd Moellmann's avatar
Gerd Moellmann committed
336
;;;###autoload
337
(defun image-type (source &optional type data-p)
338
  "Determine and return image type.
339
SOURCE is an image file name or image data.
Gerd Moellmann's avatar
Gerd Moellmann committed
340
Optional TYPE is a symbol describing the image type.  If TYPE is omitted
341
or nil, try to determine the image type from its first few bytes
342
of image data.  If that doesn't work, and SOURCE is a file name,
343
use its file extension as image type.
344 345
Optional DATA-P non-nil means SOURCE is a string containing image data."
  (when (and (not data-p) (not (stringp source)))
346
    (error "Invalid image file name `%s'" source))
347
  (unless type
348 349 350 351 352
    (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")))
353
  (or (memq type (and (boundp 'image-types) image-types))
354
      (error "Invalid image type `%s'" type))
355 356
  type)

357

358 359
(if (fboundp 'image-metadata)           ; eg not --without-x
    (define-obsolete-function-alias 'image-extension-data
360
      'image-metadata "24.1"))
361

362 363 364
(define-obsolete-variable-alias
    'image-library-alist
    'dynamic-library-alist "24.1")
365

366 367 368 369 370
;;;###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)
371
       (init-image-library type)))
372 373


374 375
;;;###autoload
(defun image-type-auto-detected-p ()
376
  "Return t if the current buffer contains an auto-detectable image.
377 378 379 380
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',
381 382 383
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."
384 385
  (let* ((type (image-type-from-buffer))
	 (auto (and type (cdr (assq type image-type-auto-detectable)))))
386
    (and auto
387
	 (or (eq auto t) (image-type-available-p type)))))
388 389


390 391 392 393 394 395 396 397 398 399 400 401 402
;;;###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
403 404 405 406 407 408
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.
409
  (setq type (image-type file-or-data type data-p))
Gerd Moellmann's avatar
Gerd Moellmann committed
410
  (when (image-type-available-p type)
411 412
    (append (list 'image :type type (if data-p :data :file) file-or-data)
	    props)))
Gerd Moellmann's avatar
Gerd Moellmann committed
413 414 415


;;;###autoload
416
(defun put-image (image pos &optional string area)
417
  "Put image IMAGE in front of POS in the current buffer.
Gerd Moellmann's avatar
Gerd Moellmann committed
418
IMAGE must be an image created with `create-image' or `defimage'.
419 420
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
421
image.  STRING is defaulted if you omit it.
422
The overlay created will have the `put-image' property set to t.
Gerd Moellmann's avatar
Gerd Moellmann committed
423 424 425 426
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'
427
means display it in the right marginal area."
428
  (unless string (setq string "x"))
429
  (let ((buffer (current-buffer)))
430
    (unless (eq (car-safe image) 'image)
431 432 433
      (error "Not an image: %s" image))
    (unless (or (null area) (memq area '(left-margin right-margin)))
      (error "Invalid area %s" area))
434
    (setq string (copy-sequence string))
435
    (let ((overlay (make-overlay pos pos buffer))
436 437
	  (prop (if (null area) image (list (list 'margin area) image))))
      (put-text-property 0 (length string) 'display prop string)
438
      (overlay-put overlay 'put-image t)
439 440
      (overlay-put overlay 'before-string string)
      overlay)))
Gerd Moellmann's avatar
Gerd Moellmann committed
441 442 443


;;;###autoload
444
(defun insert-image (image &optional string area slice)
Gerd Moellmann's avatar
Gerd Moellmann committed
445
  "Insert IMAGE into current buffer at point.
446
IMAGE is displayed by inserting STRING into the current buffer
447
with a `display' property whose value is the image.  STRING
448
defaults to a single space if you omit it.
Gerd Moellmann's avatar
Gerd Moellmann committed
449 450 451
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'
452 453 454 455 456 457
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."
458 459 460
  ;; Use a space as least likely to cause trouble when it's a hidden
  ;; character in the buffer.
  (unless string (setq string " "))
461
  (unless (eq (car-safe image) 'image)
Gerd Moellmann's avatar
Gerd Moellmann committed
462 463 464
    (error "Not an image: %s" image))
  (unless (or (null area) (memq area '(left-margin right-margin)))
    (error "Invalid area %s" area))
465 466 467 468 469 470 471 472 473
  (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))))
474 475 476
  (let ((start (point)))
    (insert string)
    (add-text-properties start (point)
477 478 479 480 481
			 `(display ,(if slice
					(list (cons 'slice slice) image)
				      image) rear-nonsticky (display)))))


482
;;;###autoload
483
(defun insert-sliced-image (image &optional string area rows cols)
484 485
  "Insert IMAGE into current buffer at point.
IMAGE is displayed by inserting STRING into the current buffer
486 487
with a `display' property whose value is the image.  The default
STRING is a single space.
488 489 490 491
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.
492
The image is automatically split into ROWS x COLS slices."
493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
  (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))
519
      (insert (propertize "\n" 'line-height t)))))
520

521

Gerd Moellmann's avatar
Gerd Moellmann committed
522 523 524 525 526 527 528 529 530 531 532 533

;;;###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)
534 535
	  (delete-overlay overlay)))
      (setq overlays (cdr overlays)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
536

537 538 539 540
(defun image-search-load-path (file &optional path)
  (unless path
    (setq path image-load-path))
  (let (element found filename)
541
    (while (and (not found) (consp path))
542
      (setq element (car path))
543
      (cond
544
       ((stringp element)
545 546
	(setq found
	      (file-readable-p
547
	       (setq filename (expand-file-name file element)))))
548 549 550 551 552 553
       ((and (symbolp element) (boundp element))
	(setq element (symbol-value element))
	(cond
	 ((stringp element)
	  (setq found
		(file-readable-p
554
		 (setq filename (expand-file-name file element)))))
555
	 ((consp element)
556
	  (if (setq filename (image-search-load-path file element))
557
	      (setq found t))))))
558
      (setq path (cdr path)))
559
    (if found filename)))
Gerd Moellmann's avatar
Gerd Moellmann committed
560 561

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

565
SPECS is a list of image specifications.
Gerd Moellmann's avatar
Gerd Moellmann committed
566 567 568

Each image specification in SPECS is a property list.  The contents of
a specification are image type dependent.  All specifications must at
569 570 571
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
572 573 574 575 576
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.

577 578 579
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
580 581 582 583
  (let (image)
    (while (and specs (null image))
      (let* ((spec (car specs))
	     (type (plist-get spec :type))
584
	     (data (plist-get spec :data))
585 586
	     (file (plist-get spec :file))
	     found)
587 588
	(when (image-type-available-p type)
	  (cond ((stringp file)
589
		 (if (setq found (image-search-load-path file))
590 591 592
		     (setq image
			   (cons 'image (plist-put (copy-sequence spec)
						   :file found)))))
593
		((not (null data))
594 595
		 (setq image (cons 'image spec)))))
	(setq specs (cdr specs))))
Gerd Moellmann's avatar
Gerd Moellmann committed
596 597 598 599 600
    image))


;;;###autoload
(defmacro defimage (symbol specs &optional doc)
601
  "Define SYMBOL as an image, and return SYMBOL.
Gerd Moellmann's avatar
Gerd Moellmann committed
602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618

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\")))"
619
  (declare (doc-string 3))
Gerd Moellmann's avatar
Gerd Moellmann committed
620
  `(defvar ,symbol (find-image ',specs) ,doc))
Gerd Moellmann's avatar
Gerd Moellmann committed
621

Kim F. Storm's avatar
Kim F. Storm committed
622 623

;;; Animated image API
Gerd Moellmann's avatar
Gerd Moellmann committed
624

625 626 627 628
(defvar image-default-frame-delay 0.1
  "Default interval in seconds between frames of a multi-frame image.
Only used if the image does not specify a value.")

629 630 631 632 633 634
(defun image-multi-frame-p (image)
  "Return non-nil if IMAGE contains more than one frame.
The actual return value is a cons (NIMAGES . DELAY), where NIMAGES is
the number of frames (or sub-images) in the image and DELAY is the delay
in seconds that the image specifies between each frame.  DELAY may be nil,
in which case you might want to use `image-default-frame-delay'."
635 636 637 638 639
  (when (fboundp 'image-metadata)
    (let* ((metadata (image-metadata image))
	   (images (plist-get metadata 'count))
	   (delay (plist-get metadata 'delay)))
      (when (and images (> images 1))
640 641
	(and delay (or (not (numberp delay)) (< delay 0))
	     (setq delay image-default-frame-delay))
642
	(cons images delay)))))
643

644 645 646 647 648 649
(defun image-animated-p (image)
  "Like `image-multi-frame-p', but returns nil if no delay is specified."
  (let ((multi (image-multi-frame-p image)))
    (and (cdr multi) multi)))

(make-obsolete 'image-animated-p 'image-multi-frame-p "24.4")
Kim F. Storm's avatar
Kim F. Storm committed
650

Glenn Morris's avatar
Glenn Morris committed
651
;; "Destructively"?
652 653 654 655 656 657 658 659
(defun image-animate (image &optional index limit)
  "Start animating IMAGE.
Animation occurs by destructively altering the IMAGE spec list.

With optional INDEX, begin animating from that animation frame.
LIMIT specifies how long to animate the image.  If omitted or
nil, play the animation until the end.  If t, loop forever.  If a
number, play until that number of seconds has elapsed."
660
  (let ((animation (image-multi-frame-p image))
661 662
	timer)
    (when animation
663 664
      (if (setq timer (image-animate-timer image))
	  (cancel-timer timer))
665
      (plist-put (cdr image) :animate-buffer (current-buffer))
666 667 668
      (run-with-timer 0.2 nil 'image-animate-timeout
		      image (or index 0) (car animation)
		      0 limit))))
Kim F. Storm's avatar
Kim F. Storm committed
669 670 671 672 673 674 675 676

(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))
677 678
      (if (and (eq (timer--function timer) 'image-animate-timeout)
	       (eq (car-safe (timer--args timer)) image))
Kim F. Storm's avatar
Kim F. Storm committed
679 680 681 682
	  (setq tail nil)
	(setq timer nil)))
    timer))

683 684 685
(defconst image-minimum-frame-delay 0.01
  "Minimum interval in seconds between frames of an animated image.")

686 687 688
(defun image-current-frame (image)
  "The current frame number of IMAGE, indexed from 0."
  (or (plist-get (cdr image) :index) 0))
689

690
(defun image-show-frame (image n &optional nocheck)
691 692 693 694 695
  "Show frame N of IMAGE.
Frames are indexed from 0.  Optional argument NOCHECK non-nil means
do not check N is within the range of frames present in the image."
  (unless nocheck
    (if (< n 0) (setq n 0)
696
      (setq n (min n (1- (car (image-multi-frame-p image)))))))
697 698 699
  (plist-put (cdr image) :index n)
  (force-window-update))

700 701 702 703 704 705 706 707 708 709 710 711 712
(defun image-animate-get-speed (image)
  "Return the speed factor for animating IMAGE."
  (or (plist-get (cdr image) :speed) 1))

(defun image-animate-set-speed (image value &optional multiply)
  "Set the speed factor for animating IMAGE to VALUE.
With optional argument MULTIPLY non-nil, treat VALUE as a
multiplication factor for the current value."
  (plist-put (cdr image) :speed
	     (if multiply
		 (* value (image-animate-get-speed image))
	       value)))

Glenn Morris's avatar
Glenn Morris committed
713
;; FIXME? The delay may not be the same for different sub-images,
714
;; hence we need to call image-multi-frame-p to return it.
Glenn Morris's avatar
Glenn Morris committed
715 716
;; But it also returns count, so why do we bother passing that as an
;; argument?
717
(defun image-animate-timeout (image n count time-elapsed limit)
Chong Yidong's avatar
Chong Yidong committed
718 719 720 721 722
  "Display animation frame N of IMAGE.
N=0 refers to the initial animation frame.
COUNT is the total number of frames in the animation.
TIME-ELAPSED is the total time that has elapsed since
`image-animate-start' was called.
723
LIMIT determines when to stop.  If t, loop forever.  If nil, stop
Chong Yidong's avatar
Chong Yidong committed
724
 after displaying the last animation frame.  Otherwise, stop
Glenn Morris's avatar
Glenn Morris committed
725
 after LIMIT seconds have elapsed.
726 727 728 729
The minimum delay between successive frames is `image-minimum-frame-delay'.

If the image has a non-nil :speed property, it acts as a multiplier
for the animation speed.  A negative value means to animate in reverse."
730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754
  (when (buffer-live-p (plist-get (cdr image) :animate-buffer))
    (image-show-frame image n t)
    (let* ((speed (image-animate-get-speed image))
	   (time (float-time))
	   (animation (image-multi-frame-p image))
	   ;; Subtract off the time we took to load the image from the
	   ;; stated delay time.
	   (delay (max (+ (* (or (cdr animation) image-default-frame-delay)
			     (/ 1 (abs speed)))
			  time (- (float-time)))
		       image-minimum-frame-delay))
	   done)
      (setq n (if (< speed 0)
		  (1- n)
		(1+ n)))
      (if limit
	  (cond ((>= n count) (setq n 0))
		((< n 0) (setq n (1- count))))
	(and (or (>= n count) (< n 0)) (setq done t)))
      (setq time-elapsed (+ delay time-elapsed))
      (if (numberp limit)
	  (setq done (>= time-elapsed limit)))
      (unless done
	(run-with-timer delay nil 'image-animate-timeout
			image n count time-elapsed limit)))))
Kim F. Storm's avatar
Kim F. Storm committed
755 756


757
(defvar imagemagick-types-inhibit)
758
(defvar imagemagick-enabled-types)
759 760 761 762

(defun imagemagick-filter-types ()
  "Return a list of the ImageMagick types to be treated as images, or nil.
This is the result of `imagemagick-types', including only elements
763
that match `imagemagick-enabled-types' and do not match
764 765
`imagemagick-types-inhibit'."
  (when (fboundp 'imagemagick-types)
766
    (cond ((null imagemagick-enabled-types) nil)
767 768 769 770 771 772
	  ((eq imagemagick-types-inhibit t) nil)
	  (t
	   (delq nil
		 (mapcar
		  (lambda (type)
		    (unless (memq type imagemagick-types-inhibit)
773
		      (if (eq imagemagick-enabled-types t) type
774
			(catch 'found
775
			  (dolist (enable imagemagick-enabled-types nil)
776 777 778 779 780
			    (if (cond ((symbolp enable) (eq enable type))
				      ((stringp enable)
				       (string-match enable
						     (symbol-name type))))
				(throw 'found type)))))))
781 782
		  (imagemagick-types)))))))

783 784 785 786
(defvar imagemagick--file-regexp nil
  "File extension regexp for ImageMagick files, if any.
This is the extension installed into `auto-mode-alist' and
`image-type-file-name-regexps' by `imagemagick-register-types'.")
787 788

;;;###autoload
Joakim Verona's avatar
Joakim Verona committed
789
(defun imagemagick-register-types ()
790
  "Register file types that can be handled by ImageMagick.
791
This function is called at startup, after loading the init file.
792
It registers the ImageMagick types returned by `imagemagick-filter-types'.
793 794 795 796 797

Registered image types are added to `auto-mode-alist', so that
Emacs visits them in Image mode.  They are also added to
`image-type-file-name-regexps', so that the `image-type' function
recognizes these files as having image type `imagemagick'.
798

799
If Emacs is compiled without ImageMagick support, this does nothing."
800
  (when (fboundp 'imagemagick-types)
801 802 803
    (let* ((types (mapcar (lambda (type) (downcase (symbol-name type)))
			  (imagemagick-filter-types)))
	   (re (if types (concat "\\." (regexp-opt types) "\\'")))
804 805 806 807 808 809 810 811 812 813 814 815 816
	   (ama-elt (car (member (cons imagemagick--file-regexp 'image-mode)
				 auto-mode-alist)))
	   (itfnr-elt (car (member (cons imagemagick--file-regexp 'imagemagick)
				   image-type-file-name-regexps))))
      (if (not re)
	  (setq auto-mode-alist (delete ama-elt auto-mode-alist)
		image-type-file-name-regexps
		(delete itfnr-elt image-type-file-name-regexps))
	(if ama-elt
	    (setcar ama-elt re)
	  (push (cons re 'image-mode) auto-mode-alist))
	(if itfnr-elt
	    (setcar itfnr-elt re)
817 818 819 820
	  ;; Append to `image-type-file-name-regexps', so that we
	  ;; preferentially use specialized image libraries.
	  (add-to-list 'image-type-file-name-regexps
	  	       (cons re 'imagemagick) t)))
821 822
      (setq imagemagick--file-regexp re))))

823 824
(defcustom imagemagick-types-inhibit
  '(C HTML HTM INFO M TXT PDF)
825
  "List of ImageMagick types that should never be treated as images.
826
This should be a list of symbols, each of which should be one of
827
the ImageMagick types listed by `imagemagick-types'.  The listed
828 829 830 831
image types are not registered by `imagemagick-register-types'.

If the value is t, inhibit the use of ImageMagick for images.

832 833 834
If you change this without using customize, you must call
`imagemagick-register-types' afterwards.

835 836 837 838 839
If Emacs is compiled without ImageMagick support, this variable
has no effect."
  :type '(choice (const :tag "Support all ImageMagick types" nil)
		 (const :tag "Disable all ImageMagick types" t)
		 (repeat symbol))
840
  :initialize 'custom-initialize-default
841 842 843
  :set (lambda (symbol value)
	 (set-default symbol value)
	 (imagemagick-register-types))
844
  :version "24.3"
845
  :group 'image)
846

847
(defcustom imagemagick-enabled-types
848
  '(3FR ART ARW AVS BMP BMP2 BMP3 CAL CALS CMYK CMYKA CR2 CRW
849 850 851 852 853 854 855 856
    CUR CUT DCM DCR DCX DDS DJVU DNG DPX EXR FAX FITS GBR GIF
    GIF87 GRB HRZ ICB ICO ICON J2C JNG JP2 JPC JPEG JPG JPX K25
    KDC MIFF MNG MRW MSL MSVG MTV NEF ORF OTB PBM PCD PCDS PCL
    PCT PCX PDB PEF PGM PICT PIX PJPEG PNG PNG24 PNG32 PNG8 PNM
    PPM PSD PTIF PWP RAF RAS RBG RGB RGBA RGBO RLA RLE SCR SCT
    SFW SGI SR2 SRF SUN SVG SVGZ TGA TIFF TIFF64 TILE TIM TTF
    UYVY VDA VICAR VID VIFF VST WBMP WPG X3F XBM XC XCF XPM XV
    XWD YCbCr YCbCrA YUV)
857
  "List of ImageMagick types to treat as images.
858 859 860 861
Each list element should be a string or symbol, representing one
of the image types returned by `imagemagick-types'.  If the
element is a string, it is handled as a regexp that enables all
matching types.
862

863 864
The value of `imagemagick-enabled-types' may also be t, meaning
to enable all types that ImageMagick supports.
865 866 867

The variable `imagemagick-types-inhibit' overrides this variable.

868
If you change this without using customize, you must call
869 870 871 872 873 874 875 876 877 878 879 880 881
`imagemagick-register-types' afterwards.

If Emacs is compiled without ImageMagick support, this variable
has no effect."
  :type '(choice (const :tag "Support all ImageMagick types" t)
		 (const :tag "Disable all ImageMagick types" nil)
		 (repeat :tag "List of types"
			 (choice (symbol :tag "type")
				 (regexp :tag "regexp"))))
  :initialize 'custom-initialize-default
  :set (lambda (symbol value)
	 (set-default symbol value)
	 (imagemagick-register-types))
882
  :version "24.3"
883 884 885 886
  :group 'image)

(imagemagick-register-types)

Gerd Moellmann's avatar
Gerd Moellmann committed
887 888
(provide 'image)

Dave Love's avatar
Dave Love committed
889
;;; image.el ends here