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

3
;; Copyright (C) 1998-2012  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 103 104
(defcustom image-load-path
  (list (file-name-as-directory (expand-file-name "images" data-directory))
        'data-directory 'load-path)
105
  "List of locations in which to search for image files.
106 107 108 109
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
110 111 112
value is used as a list of directories to search."
  :type '(repeat (choice directory variable))
  :initialize 'custom-initialize-delay)
113

114

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

118
It searches for IMAGE in `image-load-path' (excluding
119 120 121 122
\"`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\".
123

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

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

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

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

    (let* ((load-path (image-load-path-for-library \"mh-e\" \"mh-logo.xpm\"))
141 142 143
           (image-load-path (cons (car load-path)
                                  (when (boundp 'image-load-path)
                                    image-load-path))))
144
      (mh-tool-bar-folder-buttons-init))"
145 146
  (unless library (error "No library specified"))
  (unless image   (error "No image specified"))
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
  (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'.
170
    (cond
171 172 173 174 175 176
     ;; 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))
177 178 179 180 181 182 183 184 185
     ;; 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.
186 187 188
         d2ei (file-name-as-directory
               (expand-file-name
                (concat (file-name-directory library-name) "../../etc/images")))
189
         ;; Go down 1 level.
190 191 192
         d1ei (file-name-as-directory
               (expand-file-name
                (concat (file-name-directory library-name) "../etc/images"))))
193 194 195 196
        (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)))))
197 198 199
     ;; Use Emacs' image directory.
     (image-directory-load-path
      (setq image-directory image-directory-load-path))
200 201
     (no-error
      (message "Could not find image %s for library %s" image library))
202 203 204
     (t
      (error "Could not find image %s for library %s" image library)))

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

209

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


;;;###autoload
235 236 237
(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
238
be determined."
239
  (let ((types image-type-header-regexps)
Gerd Moellmann's avatar
Gerd Moellmann committed
240
	type)
241
    (while types
Gerd Moellmann's avatar
Gerd Moellmann committed
242
      (let ((regexp (car (car types)))
243
	    (image-type (cdr (car types))))
244
	(if (or (and (symbolp image-type)
245
		     (string-match-p regexp data))
246 247 248 249 250 251 252 253 254 255
		(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
256
(defun image-type-from-buffer ()
257
  "Determine the image type from data in the current buffer.
258 259
Value is a symbol specifying the image type or nil if type cannot
be determined."
260 261 262 263 264 265
  (let ((types image-type-header-regexps)
	type
	(opoint (point)))
    (goto-char (point-min))
    (while types
      (let ((regexp (car (car types)))
266
	    (image-type (cdr (car types)))
267 268
	    data)
	(if (or (and (symbolp image-type)
269
		     (looking-at-p regexp))
270 271 272 273 274 275 276 277 278
		(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))))
279
	    (setq type image-type
280 281 282
		  types nil)
	  (setq types (cdr types)))))
    (goto-char opoint)
Gerd Moellmann's avatar
Gerd Moellmann committed
283 284 285
    type))


286 287 288 289 290
;;;###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."
291 292 293 294 295 296 297 298
  (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)
299
	 (image-type-from-buffer))))
300 301 302 303 304 305 306


;;;###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."
307
  (assoc-default file image-type-file-name-regexps 'string-match-p))
308 309


Gerd Moellmann's avatar
Gerd Moellmann committed
310
;;;###autoload
311
(defun image-type (source &optional type data-p)
312
  "Determine and return image type.
313
SOURCE is an image file name or image data.
Gerd Moellmann's avatar
Gerd Moellmann committed
314
Optional TYPE is a symbol describing the image type.  If TYPE is omitted
315
or nil, try to determine the image type from its first few bytes
316
of image data.  If that doesn't work, and SOURCE is a file name,
317
use its file extension as image type.
318 319 320
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))
321
  (unless type
322 323 324 325 326
    (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")))
327
  (or (memq type (and (boundp 'image-types) image-types))
328
      (error "Invalid image type `%s'" type))
329 330
  type)

331

332 333 334 335
(if (fboundp 'image-metadata)           ; eg not --without-x
    (define-obsolete-function-alias 'image-extension-data
      'image-metadata' "24.1"))

336 337 338
(define-obsolete-variable-alias
    'image-library-alist
    'dynamic-library-alist "24.1")
339

340 341 342 343 344
;;;###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)
345
       (init-image-library type dynamic-library-alist)))
346 347


348 349
;;;###autoload
(defun image-type-auto-detected-p ()
350
  "Return t if the current buffer contains an auto-detectable image.
351 352 353 354
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',
355 356 357
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."
358 359
  (let* ((type (image-type-from-buffer))
	 (auto (and type (cdr (assq type image-type-auto-detectable)))))
360
    (and auto
361
	 (or (eq auto t) (image-type-available-p type)))))
362 363


364 365 366 367 368 369 370 371 372 373 374 375 376
;;;###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
377 378 379 380 381 382
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.
383
  (setq type (image-type file-or-data type data-p))
Gerd Moellmann's avatar
Gerd Moellmann committed
384
  (when (image-type-available-p type)
385 386
    (append (list 'image :type type (if data-p :data :file) file-or-data)
	    props)))
Gerd Moellmann's avatar
Gerd Moellmann committed
387 388 389


;;;###autoload
390
(defun put-image (image pos &optional string area)
391
  "Put image IMAGE in front of POS in the current buffer.
Gerd Moellmann's avatar
Gerd Moellmann committed
392
IMAGE must be an image created with `create-image' or `defimage'.
393 394
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
395
image.  STRING is defaulted if you omit it.
396
The overlay created will have the `put-image' property set to t.
Gerd Moellmann's avatar
Gerd Moellmann committed
397 398 399 400
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'
401
means display it in the right marginal area."
402
  (unless string (setq string "x"))
403
  (let ((buffer (current-buffer)))
404
    (unless (eq (car-safe image) 'image)
405 406 407
      (error "Not an image: %s" image))
    (unless (or (null area) (memq area '(left-margin right-margin)))
      (error "Invalid area %s" area))
408
    (setq string (copy-sequence string))
409
    (let ((overlay (make-overlay pos pos buffer))
410 411
	  (prop (if (null area) image (list (list 'margin area) image))))
      (put-text-property 0 (length string) 'display prop string)
412 413
      (overlay-put overlay 'put-image t)
      (overlay-put overlay 'before-string string))))
Gerd Moellmann's avatar
Gerd Moellmann committed
414 415 416


;;;###autoload
417
(defun insert-image (image &optional string area slice)
Gerd Moellmann's avatar
Gerd Moellmann committed
418
  "Insert IMAGE into current buffer at point.
419
IMAGE is displayed by inserting STRING into the current buffer
420 421
with a `display' property whose value is the image.  STRING
defaults to the empty string if you omit it.
Gerd Moellmann's avatar
Gerd Moellmann committed
422 423 424
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'
425 426 427 428 429 430
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."
431 432 433
  ;; Use a space as least likely to cause trouble when it's a hidden
  ;; character in the buffer.
  (unless string (setq string " "))
434
  (unless (eq (car-safe image) 'image)
Gerd Moellmann's avatar
Gerd Moellmann committed
435 436 437
    (error "Not an image: %s" image))
  (unless (or (null area) (memq area '(left-margin right-margin)))
    (error "Invalid area %s" area))
438 439 440 441 442 443 444 445 446
  (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))))
447 448 449
  (let ((start (point)))
    (insert string)
    (add-text-properties start (point)
450 451 452 453 454
			 `(display ,(if slice
					(list (cons 'slice slice) image)
				      image) rear-nonsticky (display)))))


455
;;;###autoload
456
(defun insert-sliced-image (image &optional string area rows cols)
457 458 459 460 461 462 463 464
  "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.
465
The image is automatically split into ROWS x COLS slices."
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
  (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))
492
      (insert (propertize "\n" 'line-height t)))))
493

494

Gerd Moellmann's avatar
Gerd Moellmann committed
495 496 497 498 499 500 501 502 503 504 505 506

;;;###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)
507 508
	  (delete-overlay overlay)))
      (setq overlays (cdr overlays)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
509

510 511 512 513
(defun image-search-load-path (file &optional path)
  (unless path
    (setq path image-load-path))
  (let (element found filename)
514
    (while (and (not found) (consp path))
515
      (setq element (car path))
516
      (cond
517
       ((stringp element)
518 519
	(setq found
	      (file-readable-p
520
	       (setq filename (expand-file-name file element)))))
521 522 523 524 525 526
       ((and (symbolp element) (boundp element))
	(setq element (symbol-value element))
	(cond
	 ((stringp element)
	  (setq found
		(file-readable-p
527
		 (setq filename (expand-file-name file element)))))
528
	 ((consp element)
529
	  (if (setq filename (image-search-load-path file element))
530
	      (setq found t))))))
531
      (setq path (cdr path)))
532
    (if found filename)))
Gerd Moellmann's avatar
Gerd Moellmann committed
533 534

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

538
SPECS is a list of image specifications.
Gerd Moellmann's avatar
Gerd Moellmann committed
539 540 541

Each image specification in SPECS is a property list.  The contents of
a specification are image type dependent.  All specifications must at
542 543 544
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
545 546 547 548 549
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.

550 551 552
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
553 554 555 556
  (let (image)
    (while (and specs (null image))
      (let* ((spec (car specs))
	     (type (plist-get spec :type))
557
	     (data (plist-get spec :data))
558 559
	     (file (plist-get spec :file))
	     found)
560 561
	(when (image-type-available-p type)
	  (cond ((stringp file)
562
		 (if (setq found (image-search-load-path file))
563 564 565
		     (setq image
			   (cons 'image (plist-put (copy-sequence spec)
						   :file found)))))
566
		((not (null data))
567 568
		 (setq image (cons 'image spec)))))
	(setq specs (cdr specs))))
Gerd Moellmann's avatar
Gerd Moellmann committed
569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
    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\")))"
592
  (declare (doc-string 3))
Gerd Moellmann's avatar
Gerd Moellmann committed
593
  `(defvar ,symbol (find-image ',specs) ,doc))
Gerd Moellmann's avatar
Gerd Moellmann committed
594

Kim F. Storm's avatar
Kim F. Storm committed
595 596

;;; Animated image API
Gerd Moellmann's avatar
Gerd Moellmann committed
597

Kim F. Storm's avatar
Kim F. Storm committed
598 599 600
(defconst image-animated-types '(gif)
  "List of supported animated image types.")

601
(defun image-animated-p (image)
Glenn Morris's avatar
Glenn Morris committed
602 603 604 605 606 607 608
  "Return non-nil if IMAGE can be animated.
To be capable of being animated, an image must be of a type
listed in `image-animated-types', and contain more than one
sub-image, with a specified animation delay.  The actual return
value is a cons (NIMAGES . DELAY), where NIMAGES is the number
of sub-images in the animated image and DELAY is the delay in
seconds until the next sub-image should be displayed."
609
  (cond
Glenn Morris's avatar
Glenn Morris committed
610
   ((memq (plist-get (cdr image) :type) image-animated-types)
611 612
    (let* ((metadata (image-metadata image))
	   (images (plist-get metadata 'count))
613 614 615 616
	   (delay (plist-get metadata 'delay)))
      (when (and images (> images 1) (numberp delay))
	(if (< delay 0) (setq delay 0.1))
	(cons images delay))))))
Kim F. Storm's avatar
Kim F. Storm committed
617

Glenn Morris's avatar
Glenn Morris committed
618
;; "Destructively"?
619 620 621 622 623 624 625 626
(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."
627 628 629
  (let ((animation (image-animated-p image))
	timer)
    (when animation
630 631
      (if (setq timer (image-animate-timer image))
	  (cancel-timer timer))
632 633 634
      (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
635 636 637 638 639 640 641 642

(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))
643 644
      (if (and (eq (aref timer 5) 'image-animate-timeout)
	       (eq (car-safe (aref timer 6)) image))
Kim F. Storm's avatar
Kim F. Storm committed
645 646 647 648
	  (setq tail nil)
	(setq timer nil)))
    timer))

Glenn Morris's avatar
Glenn Morris committed
649 650 651 652
;; FIXME? The delay may not be the same for different sub-images,
;; hence we need to call image-animated-p to return it.
;; But it also returns count, so why do we bother passing that as an
;; argument?
653
(defun image-animate-timeout (image n count time-elapsed limit)
Chong Yidong's avatar
Chong Yidong committed
654 655 656 657 658
  "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.
659
LIMIT determines when to stop.  If t, loop forever.  If nil, stop
Chong Yidong's avatar
Chong Yidong committed
660
 after displaying the last animation frame.  Otherwise, stop
Glenn Morris's avatar
Glenn Morris committed
661 662
 after LIMIT seconds have elapsed.
The minimum delay between successive frames is 0.01s."
663 664 665 666 667 668 669 670 671 672
  (plist-put (cdr image) :index n)
  (force-window-update)
  (setq n (1+ n))
  (let* ((time (float-time))
	 (animation (image-animated-p image))
	 ;; Subtract off the time we took to load the image from the
	 ;; stated delay time.
	 (delay (max (+ (cdr animation) time (- (float-time)))
		     0.01))
	 done)
Chong Yidong's avatar
Chong Yidong committed
673
    (if (>= n count)
674
	(if limit
Chong Yidong's avatar
Chong Yidong committed
675 676 677
	    (setq n 0)
	  (setq done t)))
    (setq time-elapsed (+ delay time-elapsed))
678 679
    (if (numberp limit)
	(setq done (>= time-elapsed limit)))
Chong Yidong's avatar
Chong Yidong committed
680 681
    (unless done
      (run-with-timer delay nil 'image-animate-timeout
682
		      image n count time-elapsed limit))))
Kim F. Storm's avatar
Kim F. Storm committed
683 684


685 686
(defcustom imagemagick-types-inhibit
  '(C HTML HTM TXT PDF)
687 688
  "ImageMagick types that Emacs should not use ImageMagick to handle.
This should be a list of symbols, each of which has the same
Glenn Morris's avatar
Glenn Morris committed
689
name as one of the format tags used internally by ImageMagick;
690
see `imagemagick-types'.  Entries in this list are excluded from
691 692
being registered by `imagemagick-register-types', so if you change
this variable you must do so before you call that function.
693 694 695

If Emacs is compiled without ImageMagick, this variable has no effect."
  :type '(choice (const :tag "Let ImageMagick handle all types it can" nil)
Glenn Morris's avatar
Glenn Morris committed
696
		 (repeat symbol))
697 698
  ;; Ideally, would have a :set function that checks if we already did
  ;; imagemagick-register-types, and if so undoes it, then redoes it.
Glenn Morris's avatar
Glenn Morris committed
699 700
  :version "24.1"
  :group 'image)
701 702

;;;###autoload
Joakim Verona's avatar
Joakim Verona committed
703
(defun imagemagick-register-types ()
704 705 706 707 708 709 710 711
  "Register file types that can be handled by ImageMagick.
This adds the file types returned by `imagemagick-types'
\(excluding the ones in `imagemagick-types-inhibit') to
`auto-mode-alist' and `image-type-file-name-regexps', so that
Emacs visits them in Image mode.

If Emacs is compiled without ImageMagick support, do nothing."
  (when (fboundp 'imagemagick-types)
712 713 714 715 716 717 718 719
    (let ((im-types '()))
      (dolist (im-type (imagemagick-types))
        (unless (memq im-type imagemagick-types-inhibit)
          (push (downcase (symbol-name im-type)) im-types)))
      (let ((extension (concat "\\." (regexp-opt im-types) "\\'")))
        (push (cons extension 'image-mode) auto-mode-alist)
        (push (cons extension 'imagemagick)
              image-type-file-name-regexps)))))
720

Gerd Moellmann's avatar
Gerd Moellmann committed
721 722
(provide 'image)

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