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

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

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

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

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

102
(defvar image-format-suffixes
103 104 105
  '((image/x-icon "ico"))
  "Alist of MIME Content-Type headers to file name suffixes.
This is used as a hint by the ImageMagick library when detecting
106
image types.  If `create-image' is called with a :format
107 108 109
matching found in this alist, the ImageMagick library will be
told that the data would have this suffix if saved to a file.")

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

Subdirectories are not automatically included in the search."
121 122
  :type '(repeat (choice directory variable))
  :initialize 'custom-initialize-delay)
123

124

125
(defun image-load-path-for-library (library image &optional path no-error)
126
  "Return a suitable search path for images used by LIBRARY.
127

128
It searches for IMAGE in `image-load-path' (excluding
129 130 131 132
\"`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\".
133

134 135
Then this function returns a list of directories which contains
first the directory in which IMAGE was found, followed by the
136
value of `load-path'.  If PATH is given, it is used instead of
137
`load-path'.
138

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

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

147 148
    ;; Shush compiler.
    (defvar image-load-path)
149 150

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

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

215 216 217 218
    ;; Return an augmented `path' or `load-path'.
    (nconc (list image-directory)
           (delete image-directory (copy-sequence (or path load-path))))))

219

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


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


301 302 303 304 305
;;;###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."
306 307 308 309 310 311 312 313
  (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)
314
	 (image-type-from-buffer))))
315 316 317 318 319 320 321


;;;###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."
322
  (let (type first)
323 324 325 326 327 328 329
    (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))))))))
330

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

352

353 354 355 356
(if (fboundp 'image-metadata)           ; eg not --without-x
    (define-obsolete-function-alias 'image-extension-data
      'image-metadata' "24.1"))

357 358 359
(define-obsolete-variable-alias
    'image-library-alist
    'dynamic-library-alist "24.1")
360

361 362 363 364 365
;;;###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)
366
       (init-image-library type)))
367 368


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


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


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


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


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

516

Gerd Moellmann's avatar
Gerd Moellmann committed
517 518 519 520 521 522 523 524 525 526 527 528

;;;###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)
529 530
	  (delete-overlay overlay)))
      (setq overlays (cdr overlays)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
531

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

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

560
SPECS is a list of image specifications.
Gerd Moellmann's avatar
Gerd Moellmann committed
561 562 563

Each image specification in SPECS is a property list.  The contents of
a specification are image type dependent.  All specifications must at
564 565 566
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
567 568 569 570 571
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.

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


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

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

Kim F. Storm's avatar
Kim F. Storm committed
617 618

;;; Animated image API
Gerd Moellmann's avatar
Gerd Moellmann committed
619

620 621 622 623
(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.")

624 625 626 627 628 629
(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'."
630 631 632 633 634 635 636 637
  (when (fboundp 'image-metadata)
    (let* ((metadata (image-metadata image))
	   (images (plist-get metadata 'count))
	   (delay (plist-get metadata 'delay)))
      (when (and images (> images 1))
	(if (or (not (numberp delay)) (< delay 0))
	    (setq delay image-default-frame-delay))
	(cons images delay)))))
638

639 640 641 642 643 644
(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
645

Glenn Morris's avatar
Glenn Morris committed
646
;; "Destructively"?
647 648 649 650 651 652 653 654
(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."
655
  (let ((animation (image-multi-frame-p image))
656 657
	timer)
    (when animation
658 659
      (if (setq timer (image-animate-timer image))
	  (cancel-timer timer))
660 661 662
      (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
663 664 665 666 667 668 669 670

(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))
671 672
      (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
673 674 675 676
	  (setq tail nil)
	(setq timer nil)))
    timer))

677 678 679
(defconst image-minimum-frame-delay 0.01
  "Minimum interval in seconds between frames of an animated image.")

680 681 682
(defun image-current-frame (image)
  "The current frame number of IMAGE, indexed from 0."
  (or (plist-get (cdr image) :index) 0))
683

684
(defun image-show-frame (image n &optional nocheck)
685 686 687 688 689
  "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)
690
      (setq n (min n (1- (car (image-multi-frame-p image)))))))
691 692 693
  (plist-put (cdr image) :index n)
  (force-window-update))

694 695 696 697 698 699 700 701 702 703 704 705 706
(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
707
;; FIXME? The delay may not be the same for different sub-images,
708
;; hence we need to call image-multi-frame-p to return it.
Glenn Morris's avatar
Glenn Morris committed
709 710
;; But it also returns count, so why do we bother passing that as an
;; argument?
711
(defun image-animate-timeout (image n count time-elapsed limit)
Chong Yidong's avatar
Chong Yidong committed
712 713 714 715 716
  "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.
717
LIMIT determines when to stop.  If t, loop forever.  If nil, stop
Chong Yidong's avatar
Chong Yidong committed
718
 after displaying the last animation frame.  Otherwise, stop
Glenn Morris's avatar
Glenn Morris committed
719
 after LIMIT seconds have elapsed.
720 721 722 723
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."
724
  (image-show-frame image n t)
725 726
  (let* ((speed (image-animate-get-speed image))
	 (time (float-time))
727
	 (animation (image-multi-frame-p image))
728 729
	 ;; Subtract off the time we took to load the image from the
	 ;; stated delay time.
730 731
	 (delay (max (+ (* (or (cdr animation) image-default-frame-delay)
			   (/ 1 (abs speed)))
732
			time (- (float-time)))
733
		     image-minimum-frame-delay))
734
	 done)
735 736 737 738 739 740 741
    (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)))
Chong Yidong's avatar
Chong Yidong committed
742
    (setq time-elapsed (+ delay time-elapsed))
743 744
    (if (numberp limit)
	(setq done (>= time-elapsed limit)))
Chong Yidong's avatar
Chong Yidong committed
745 746
    (unless done
      (run-with-timer delay nil 'image-animate-timeout
747
		      image n count time-elapsed limit))))
Kim F. Storm's avatar
Kim F. Storm committed
748 749


750
(defvar imagemagick-types-inhibit)
751
(defvar imagemagick-enabled-types)
752 753 754 755

(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
756
that match `imagemagick-enabled-types' and do not match
757 758
`imagemagick-types-inhibit'."
  (when (fboundp 'imagemagick-types)
759
    (cond ((null imagemagick-enabled-types) nil)
760 761 762 763 764 765
	  ((eq imagemagick-types-inhibit t) nil)
	  (t
	   (delq nil
		 (mapcar
		  (lambda (type)
		    (unless (memq type imagemagick-types-inhibit)
766
		      (if (eq imagemagick-enabled-types t) type
767
			(catch 'found
768
			  (dolist (enable imagemagick-enabled-types nil)
769 770 771 772 773
			    (if (cond ((symbolp enable) (eq enable type))
				      ((stringp enable)
				       (string-match enable
						     (symbol-name type))))
				(throw 'found type)))))))
774 775
		  (imagemagick-types)))))))

776 777 778 779
(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'.")
780 781

;;;###autoload
Joakim Verona's avatar
Joakim Verona committed
782
(defun imagemagick-register-types ()
783
  "Register file types that can be handled by ImageMagick.
784
This function is called at startup, after loading the init file.
785
It registers the ImageMagick types returned by `imagemagick-filter-types'.
786 787 788 789 790

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'.
791

792
If Emacs is compiled without ImageMagick support, this does nothing."
793
  (when (fboundp 'imagemagick-types)
794 795 796
    (let* ((types (mapcar (lambda (type) (downcase (symbol-name type)))
			  (imagemagick-filter-types)))
	   (re (if types (concat "\\." (regexp-opt types) "\\'")))
797 798 799 800 801 802 803 804 805 806 807 808 809
	   (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)
810 811 812 813
	  ;; 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)))
814 815
      (setq imagemagick--file-regexp re))))

816 817
(defcustom imagemagick-types-inhibit
  '(C HTML HTM INFO M TXT PDF)
818
  "List of ImageMagick types that should never be treated as images.
819
This should be a list of symbols, each of which should be one of
820
the ImageMagick types listed by `imagemagick-types'.  The listed
821 822 823 824
image types are not registered by `imagemagick-register-types'.

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

825 826 827
If you change this without using customize, you must call
`imagemagick-register-types' afterwards.

828 829 830 831 832
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))
833
  :initialize 'custom-initialize-default
834 835 836
  :set (lambda (symbol value)
	 (set-default symbol value)
	 (imagemagick-register-types))
837
  :version "24.3"
838
  :group 'image)
839

840
(defcustom imagemagick-enabled-types
841
  '(3FR ART ARW AVS BMP BMP2 BMP3 CAL CALS CMYK CMYKA CR2 CRW
842 843 844 845 846 847 848 849
    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)
850
  "List of ImageMagick types to treat as images.
851 852 853 854
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.
855

856 857
The value of `imagemagick-enabled-types' may also be t, meaning
to enable all types that ImageMagick supports.
858 859 860

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

861
If you change this without using customize, you must call
862 863 864 865 866 867 868 869 870 871 872 873 874
`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))
875
  :version "24.3"
876 877 878 879
  :group 'image)

(imagemagick-register-types)

Gerd Moellmann's avatar
Gerd Moellmann committed
880 881
(provide 'image)

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