image.el 39.2 KB
Newer Older
1
;;; image.el --- image API  -*- lexical-binding:t -*-
Gerd Moellmann's avatar
Gerd Moellmann committed
2

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 1998-2019 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 <https://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
(defgroup image ()
  "Image support."
  :group 'multimedia)

32
(declare-function image-flush "image.c" (spec &optional frame))
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]\\(?:\
38 39
\\(?:\\(?:#[^\r\n]*[\r\n]\\)*[[:space:]]\\)+\
\\(?:\\(?:#[^\r\n]*[\r\n]\\)*[0-9]\\)+\
40
\\)\\{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-rgb "rgb") (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
The images for icons shown in the tool bar are also looked up
in these locations.

122 123 124 125
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
126 127 128
value is used as a list of directories to search.

Subdirectories are not automatically included in the search."
129
  :type '(repeat (choice directory variable))
130
  :initialize #'custom-initialize-delay)
131

132 133 134 135 136 137 138 139 140 141
(defcustom image-scaling-factor 'auto
  "When displaying images, apply this scaling factor before displaying.
This is not supported for all image types, and is mostly useful
when you have a high-resolution monitor.
The value is either a floating point number (where numbers higher
than 1 means to increase the size and lower means to shrink the
size), or the symbol `auto', which will compute a scaling factor
based on the font pixel size."
  :type '(choice number
                 (const :tag "Automatically compute" auto))
142
  :version "26.1")
143

144 145
;; Map put into text properties on images.
(defvar image-map
Lars Ingebrigtsen's avatar
Lars Ingebrigtsen committed
146
  (let ((map (make-sparse-keymap)))
147 148 149 150 151 152
    (define-key map "-" 'image-decrease-size)
    (define-key map "+" 'image-increase-size)
    (define-key map "r" 'image-rotate)
    (define-key map "o" 'image-save)
    map))

153
(defun image-load-path-for-library (library image &optional path no-error)
154
  "Return a suitable search path for images used by LIBRARY.
155

156
It searches for IMAGE in `image-load-path' (excluding
157 158 159 160
\"`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\".
161

162 163
Then this function returns a list of directories which contains
first the directory in which IMAGE was found, followed by the
164
value of `load-path'.  If PATH is given, it is used instead of
165
`load-path'.
166

167
If NO-ERROR is non-nil and a suitable path can't be found, don't
168
signal an error.  Instead, return a list of directories as before,
169
except that nil appears in place of the image directory.
170 171 172 173 174

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

175 176
    ;; Shush compiler.
    (defvar image-load-path)
177 178

    (let* ((load-path (image-load-path-for-library \"mh-e\" \"mh-logo.xpm\"))
179
           (image-load-path (cons (car load-path)
180
                                  (when (boundp \\='image-load-path)
181
                                    image-load-path))))
182
      (mh-tool-bar-folder-buttons-init))"
183 184
  (unless library (error "No library specified"))
  (unless image   (error "No image specified"))
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
  (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))

204
    ;; If `image-directory-load-path' isn't Emacs's image directory,
205 206 207
    ;; it's probably a user preference, so use it. Then use a
    ;; relative setting if possible; otherwise, use
    ;; `image-directory-load-path'.
208
    (cond
209 210 211 212 213 214
     ;; 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))
215 216 217 218 219 220 221 222 223
     ;; 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.
224 225 226
         d2ei (file-name-as-directory
               (expand-file-name
                (concat (file-name-directory library-name) "../../etc/images")))
227
         ;; Go down 1 level.
228 229 230
         d1ei (file-name-as-directory
               (expand-file-name
                (concat (file-name-directory library-name) "../etc/images"))))
231 232 233 234
        (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)))))
235
     ;; Use Emacs's image directory.
236 237
     (image-directory-load-path
      (setq image-directory image-directory-load-path))
238 239
     (no-error
      (message "Could not find image %s for library %s" image library))
240 241 242
     (t
      (error "Could not find image %s for library %s" image library)))

243 244 245 246
    ;; Return an augmented `path' or `load-path'.
    (nconc (list image-directory)
           (delete image-directory (copy-sequence (or path load-path))))))

247

248 249
;; Used to be in image-type-header-regexps, but now not used anywhere
;; (since 2009-08-28).
250
(defun image-jpeg-p (data)
Robert Pluim's avatar
Robert Pluim committed
251
  (declare (obsolete "It is unused inside Emacs and will be removed." "27.1"))
252 253
  "Value is non-nil if DATA, a string, consists of JFIF image data.
We accept the tag Exif because that is the same format."
254 255
  (setq data (ignore-errors (string-to-unibyte data)))
  (when (and data (string-match-p "\\`\xff\xd8" data))
256 257 258 259 260 261 262 263
    (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))
264
	  (let ((nbytes (+ (ash (aref data (+ i 1)) 8)
265 266 267
			   (aref data (+ i 2))))
		(code (aref data i)))
	    (when (and (>= code #xe0) (<= code #xef))
268
	      ;; APP0 LEN1 LEN2 "JFIF\0"
269
	      (throw 'jfif
270 271
		     (string-match-p "JFIF\\|Exif"
				     (substring data i (min (+ i nbytes) len)))))
272
	    (setq i (+ i 1 nbytes))))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
273 274 275


;;;###autoload
276 277 278
(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
279
be determined."
280
  (let ((types image-type-header-regexps)
Gerd Moellmann's avatar
Gerd Moellmann committed
281
	type)
282
    (while types
Gerd Moellmann's avatar
Gerd Moellmann committed
283
      (let ((regexp (car (car types)))
284
	    (image-type (cdr (car types))))
285
	(if (or (and (symbolp image-type)
286
		     (string-match-p regexp data))
287 288 289 290 291 292 293 294 295 296
		(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
297
(defun image-type-from-buffer ()
298
  "Determine the image type from data in the current buffer.
299 300
Value is a symbol specifying the image type or nil if type cannot
be determined."
301 302 303 304 305 306
  (let ((types image-type-header-regexps)
	type
	(opoint (point)))
    (goto-char (point-min))
    (while types
      (let ((regexp (car (car types)))
307
	    (image-type (cdr (car types)))
308 309
	    data)
	(if (or (and (symbolp image-type)
310
		     (looking-at-p regexp))
311 312 313 314 315 316 317 318 319
		(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))))
320
	    (setq type image-type
321 322 323
		  types nil)
	  (setq types (cdr types)))))
    (goto-char opoint)
324
    (and type
325
	 (boundp 'image-types)
326 327
	 (memq type image-types)
	 type)))
Gerd Moellmann's avatar
Gerd Moellmann committed
328 329


330 331 332 333 334
;;;###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."
335 336 337 338 339 340 341 342
  (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)
343
	 (image-type-from-buffer))))
344 345 346 347 348 349 350


;;;###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."
351
  (let (type first (case-fold-search t))
352 353 354 355 356 357 358
    (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))))))))
359

Gerd Moellmann's avatar
Gerd Moellmann committed
360
;;;###autoload
361
(defun image-type (source &optional type data-p)
362
  "Determine and return image type.
363
SOURCE is an image file name or image data.
Gerd Moellmann's avatar
Gerd Moellmann committed
364
Optional TYPE is a symbol describing the image type.  If TYPE is omitted
365
or nil, try to determine the image type from its first few bytes
366
of image data.  If that doesn't work, and SOURCE is a file name,
367
use its file extension as image type.
368 369
Optional DATA-P non-nil means SOURCE is a string containing image data."
  (when (and (not data-p) (not (stringp source)))
370
    (error "Invalid image file name `%s'" source))
371
  (unless type
372 373 374 375 376
    (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")))
377
  (or (memq type (and (boundp 'image-types) image-types))
378
      (error "Invalid image type `%s'" type))
379 380
  type)

381

382 383
(if (fboundp 'image-metadata)           ; eg not --without-x
    (define-obsolete-function-alias 'image-extension-data
384
      'image-metadata "24.1"))
385

386 387 388
(define-obsolete-variable-alias
    'image-library-alist
    'dynamic-library-alist "24.1")
389

390 391 392 393 394
;;;###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)
395
       (init-image-library type)))
396 397


398 399
;;;###autoload
(defun image-type-auto-detected-p ()
400
  "Return t if the current buffer contains an auto-detectable image.
401 402 403 404
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',
405 406 407
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."
408 409
  (let* ((type (image-type-from-buffer))
	 (auto (and type (cdr (assq type image-type-auto-detectable)))))
410
    (and auto
411
	 (or (eq auto t) (image-type-available-p type)))))
412 413


414 415 416 417
;;;###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.
418

419 420 421 422
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.
423

424
Optional DATA-P non-nil means FILE-OR-DATA is a string containing image data.
425

426
Optional PROPS are additional image attributes to assign to the image,
427 428 429 430 431
like, e.g. `:mask MASK'.  If the property `:scale' is not given and the
display has a high resolution (more exactly, when the average width of a
character in the default font is more than 10 pixels), the image is
automatically scaled up in proportion to the default font.

432 433
Value is the image created, or nil if images of type TYPE are not supported.

Glenn Morris's avatar
Glenn Morris committed
434 435 436 437 438 439
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.
440
  (setq type (image-type file-or-data type data-p))
Gerd Moellmann's avatar
Gerd Moellmann committed
441
  (when (image-type-available-p type)
442
    (append (list 'image :type type (if data-p :data :file) file-or-data)
443 444 445
            (and (not (plist-get props :scale))
                 (list :scale
                       (image-compute-scaling-factor image-scaling-factor)))
446
	    props)))
Gerd Moellmann's avatar
Gerd Moellmann committed
447

448
(defun image--set-property (image property value)
449
  "Set PROPERTY in IMAGE to VALUE.
450
Internal use only."
451 452 453 454 455 456
  (if (null value)
      (while (cdr image)
        ;; IMAGE starts with the symbol `image', and the rest is a
        ;; plist.  Decouple plist entries where the key matches
        ;; the property.
        (if (eq (cadr image) property)
457
            (setcdr image (cdddr image))
458 459
          (setq image (cddr image))))
    ;; Just enter the new value.
460
    (setcdr image (plist-put (cdr image) property value)))
461
  value)
462

463 464 465 466 467 468 469
(defun image-property (image property)
  "Return the value of PROPERTY in IMAGE.
Properties can be set with

  (setf (image-property IMAGE PROPERTY) VALUE)
If VALUE is nil, PROPERTY is removed from IMAGE."
  (declare (gv-setter image--set-property))
470 471
  (plist-get (cdr image) property))

472 473
(defun image-compute-scaling-factor (scaling)
  (cond
474 475
   ((numberp scaling) scaling)
   ((eq scaling 'auto)
476 477 478 479 480 481 482 483
    (let ((width (/ (float (window-width nil t)) (window-width))))
      ;; If we assume that a typical character is 10 pixels in width,
      ;; then we should scale all images according to how wide they
      ;; are.  But don't scale images down.
      (if (< width 10)
          1
        (/ (float width) 10))))
   (t
484
    (error "Invalid scaling factor %s" scaling))))
Gerd Moellmann's avatar
Gerd Moellmann committed
485 486

;;;###autoload
487
(defun put-image (image pos &optional string area)
488
  "Put image IMAGE in front of POS in the current buffer.
Gerd Moellmann's avatar
Gerd Moellmann committed
489
IMAGE must be an image created with `create-image' or `defimage'.
490 491
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
492
image.  STRING is defaulted if you omit it.
493
The overlay created will have the `put-image' property set to t.
Gerd Moellmann's avatar
Gerd Moellmann committed
494 495 496 497
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'
498
means display it in the right marginal area."
499
  (unless string (setq string "x"))
500
  (let ((buffer (current-buffer)))
501
    (unless (eq (car-safe image) 'image)
502 503 504
      (error "Not an image: %s" image))
    (unless (or (null area) (memq area '(left-margin right-margin)))
      (error "Invalid area %s" area))
505
    (setq string (copy-sequence string))
506
    (let ((overlay (make-overlay pos pos buffer))
507 508
	  (prop (if (null area) image (list (list 'margin area) image))))
      (put-text-property 0 (length string) 'display prop string)
509
      (overlay-put overlay 'put-image t)
510
      (overlay-put overlay 'before-string string)
511
      (overlay-put overlay 'map image-map)
512
      overlay)))
Gerd Moellmann's avatar
Gerd Moellmann committed
513 514 515


;;;###autoload
516
(defun insert-image (image &optional string area slice)
Gerd Moellmann's avatar
Gerd Moellmann committed
517
  "Insert IMAGE into current buffer at point.
518
IMAGE is displayed by inserting STRING into the current buffer
519
with a `display' property whose value is the image.  STRING
520
defaults to a single space if you omit it.
Gerd Moellmann's avatar
Gerd Moellmann committed
521 522 523
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'
524 525 526 527 528 529
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."
530 531 532
  ;; Use a space as least likely to cause trouble when it's a hidden
  ;; character in the buffer.
  (unless string (setq string " "))
533
  (unless (eq (car-safe image) 'image)
Gerd Moellmann's avatar
Gerd Moellmann committed
534 535 536
    (error "Not an image: %s" image))
  (unless (or (null area) (memq area '(left-margin right-margin)))
    (error "Invalid area %s" area))
537 538 539 540 541 542 543 544 545
  (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))))
546 547 548
  (let ((start (point)))
    (insert string)
    (add-text-properties start (point)
549 550
			 `(display ,(if slice
					(list (cons 'slice slice) image)
551 552 553
				      image)
                                   rear-nonsticky (display)
                                   keymap ,image-map))))
554 555


556
;;;###autoload
557
(defun insert-sliced-image (image &optional string area rows cols)
558 559
  "Insert IMAGE into current buffer at point.
IMAGE is displayed by inserting STRING into the current buffer
560 561
with a `display' property whose value is the image.  The default
STRING is a single space.
562 563 564 565
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.
566
The image is automatically split into ROWS x COLS slices."
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
  (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)
589 590
					 rear-nonsticky (display)
                                         keymap ,image-map))
591 592 593
	  (setq x (+ x dx))))
      (setq x 0.0
	    y (+ y dy))
594
      (insert (propertize "\n" 'line-height t)))))
595

596

Gerd Moellmann's avatar
Gerd Moellmann committed
597 598 599 600 601 602 603 604 605 606 607 608

;;;###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)
609 610
	  (delete-overlay overlay)))
      (setq overlays (cdr overlays)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
611

612 613 614 615
(defun image-search-load-path (file &optional path)
  (unless path
    (setq path image-load-path))
  (let (element found filename)
616
    (while (and (not found) (consp path))
617
      (setq element (car path))
618
      (cond
619
       ((stringp element)
620 621
	(setq found
	      (file-readable-p
622
	       (setq filename (expand-file-name file element)))))
623 624 625 626 627 628
       ((and (symbolp element) (boundp element))
	(setq element (symbol-value element))
	(cond
	 ((stringp element)
	  (setq found
		(file-readable-p
629
		 (setq filename (expand-file-name file element)))))
630
	 ((consp element)
631
	  (if (setq filename (image-search-load-path file element))
632
	      (setq found t))))))
633
      (setq path (cdr path)))
634
    (if found filename)))
Gerd Moellmann's avatar
Gerd Moellmann committed
635 636

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

640
SPECS is a list of image specifications.
Gerd Moellmann's avatar
Gerd Moellmann committed
641 642 643

Each image specification in SPECS is a property list.  The contents of
a specification are image type dependent.  All specifications must at
644 645 646
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
647 648 649 650 651
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.

652 653 654
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
655 656 657 658
  (let (image)
    (while (and specs (null image))
      (let* ((spec (car specs))
	     (type (plist-get spec :type))
659
	     (data (plist-get spec :data))
660 661
	     (file (plist-get spec :file))
	     found)
662 663
	(when (image-type-available-p type)
	  (cond ((stringp file)
664
		 (if (setq found (image-search-load-path file))
665 666 667
		     (setq image
			   (cons 'image (plist-put (copy-sequence spec)
						   :file found)))))
668
		((not (null data))
669 670
		 (setq image (cons 'image spec)))))
	(setq specs (cdr specs))))
Gerd Moellmann's avatar
Gerd Moellmann committed
671 672 673 674 675
    image))


;;;###autoload
(defmacro defimage (symbol specs &optional doc)
676
  "Define SYMBOL as an image, and return SYMBOL.
Gerd Moellmann's avatar
Gerd Moellmann committed
677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693

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

Kim F. Storm's avatar
Kim F. Storm committed
697 698

;;; Animated image API
Gerd Moellmann's avatar
Gerd Moellmann committed
699

700 701 702 703
(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.")

704 705 706 707 708 709
(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'."
710 711 712 713 714
  (when (fboundp 'image-metadata)
    (let* ((metadata (image-metadata image))
	   (images (plist-get metadata 'count))
	   (delay (plist-get metadata 'delay)))
      (when (and images (> images 1))
715 716
	(and delay (or (not (numberp delay)) (< delay 0))
	     (setq delay image-default-frame-delay))
717
	(cons images delay)))))
718

719 720 721 722 723 724
(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
725

Glenn Morris's avatar
Glenn Morris committed
726
;; "Destructively"?
727 728 729 730 731 732 733 734
(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."
735
  (let ((animation (image-multi-frame-p image))
736 737
	timer)
    (when animation
738 739
      (if (setq timer (image-animate-timer image))
	  (cancel-timer timer))
740
      (plist-put (cdr image) :animate-buffer (current-buffer))
741
      (run-with-timer 0.2 nil #'image-animate-timeout
742
		      image (or index 0) (car animation)
743
		      0 limit (+ (float-time) 0.2)))))
Kim F. Storm's avatar
Kim F. Storm committed
744 745 746 747 748 749 750 751

(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))
752
      (if (and (eq (timer--function timer) #'image-animate-timeout)
753
	       (eq (car-safe (timer--args timer)) image))
Kim F. Storm's avatar
Kim F. Storm committed
754 755 756 757
	  (setq tail nil)
	(setq timer nil)))
    timer))

758 759 760
(defconst image-minimum-frame-delay 0.01
  "Minimum interval in seconds between frames of an animated image.")

761 762 763
(defun image-current-frame (image)
  "The current frame number of IMAGE, indexed from 0."
  (or (plist-get (cdr image) :index) 0))
764

765
(defun image-show-frame (image n &optional nocheck)
766 767 768 769 770
  "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)
771
      (setq n (min n (1- (car (image-multi-frame-p image)))))))
772 773 774
  (plist-put (cdr image) :index n)
  (force-window-update))

775 776 777 778 779 780 781 782 783 784 785 786 787
(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
788
;; FIXME? The delay may not be the same for different sub-images,
789
;; hence we need to call image-multi-frame-p to return it.
Glenn Morris's avatar
Glenn Morris committed
790 791
;; But it also returns count, so why do we bother passing that as an
;; argument?
792
(defun image-animate-timeout (image n count time-elapsed limit target-time)
Chong Yidong's avatar
Chong Yidong committed
793 794 795 796 797
  "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.
798
LIMIT determines when to stop.  If t, loop forever.  If nil, stop
Chong Yidong's avatar
Chong Yidong committed
799
 after displaying the last animation frame.  Otherwise, stop
Glenn Morris's avatar
Glenn Morris committed
800
 after LIMIT seconds have elapsed.
801 802 803 804
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."
805 806
  (when (and (buffer-live-p (plist-get (cdr image) :animate-buffer))
             ;; Delayed more than two seconds more than expected.
807
	     (or (time-less-p (time-since target-time) 2)
808 809 810
		 (progn
		   (message "Stopping animation; animation possibly too big")
		   nil)))
811 812
    (image-show-frame image n t)
    (let* ((speed (image-animate-get-speed image))
813
	   (time (current-time))
814
	   (animation (image-multi-frame-p image))
815 816 817 818
	   (time-to-load-image (time-since time))
	   (stated-delay-time (/ (or (cdr animation)
				     image-default-frame-delay)
				 (float (abs speed))))
819 820
	   ;; Subtract off the time we took to load the image from the
	   ;; stated delay time.
821 822
	   (delay (max (float-time (time-subtract stated-delay-time
						  time-to-load-image))
823 824 825 826 827 828 829 830 831 832 833 834 835
		       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
836
	(run-with-timer delay nil #'image-animate-timeout
837 838
			image n count time-elapsed limit
                        (+ (float-time) delay))))))
Kim F. Storm's avatar
Kim F. Storm committed
839 840


841
(defvar imagemagick-types-inhibit)
842
(defvar imagemagick-enabled-types)
843 844 845 846

(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
847
that match `imagemagick-enabled-types' and do not match
848 849
`imagemagick-types-inhibit'."
  (when (fboundp 'imagemagick-types)
850
    (cond ((null imagemagick-enabled-types) nil)
851 852 853 854 855 856
	  ((eq imagemagick-types-inhibit t) nil)
	  (t
	   (delq nil
		 (mapcar
		  (lambda (type)
		    (unless (memq type imagemagick-types-inhibit)
857
		      (if (eq imagemagick-enabled-types t) type
858
			(catch 'found
859
			  (dolist (enable imagemagick-enabled-types nil)
860 861 862 863 864
			    (if (cond ((symbolp enable) (eq enable type))
				      ((stringp enable)
				       (string-match enable
						     (symbol-name type))))
				(throw 'found type)))))))
865 866
		  (imagemagick-types)))))))

867 868 869 870
(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'.")
871 872

;;;###autoload
Joakim Verona's avatar
Joakim Verona committed
873
(defun imagemagick-register-types ()
874
  "Register file types that can be handled by ImageMagick.
875
This function is called at startup, after loading the init file.
876
It registers the ImageMagick types returned by `imagemagick-filter-types'.
877 878 879 880 881

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

883
If Emacs is compiled without ImageMagick support, this does nothing."
884
  (when (fboundp 'imagemagick-types)
885 886 887
    (let* ((types (mapcar (lambda (type) (downcase (symbol-name type)))
			  (imagemagick-filter-types)))
	   (re (if types (concat "\\." (regexp-opt types) "\\'")))
888 889 890 891 892 893 894 895 896 897 898 899 900
	   (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)
901 902 903 904
	  ;; 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)))
905 906
      (setq imagemagick--file-regexp re))))

907 908
(defcustom imagemagick-types-inhibit
  '(C HTML HTM INFO M TXT PDF)
909
  "List of ImageMagick types that should never be treated as images.
910
This should be a list of symbols, each of which should be one of
911
the ImageMagick types listed by `imagemagick-types'.  The listed
912 913 914 915
image types are not registered by `imagemagick-register-types'.

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

916 917 918
If you change this without using customize, you must call
`imagemagick-register-types' afterwards.

919 920 921 922 923
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))
924
  :initialize #'custom-initialize-default
925 926 927
  :set (lambda (symbol value)
	 (set-default symbol value)
	 (imagemagick-register-types))
928
  :version "24.3")
929

930
(defcustom imagemagick-enabled-types
931
  '(3FR ARW AVS BMP BMP2 BMP3 CAL CALS CMYK CMYKA CR2 CRW
932 933 934 935 936 937 938 939
    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)
940
  "List of ImageMagick types to treat as images.
941 942 943 944
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.
945

946 947
The value of `imagemagick-enabled-types' may also be t, meaning
to enable all types that ImageMagick supports.
948 949 950

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

951
If you change this without using customize, you must call
952 953 954 955 956 957 958 959 960
`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"))))
961
  :initialize #'custom-initialize-default
962 963 964
  :set (lambda (symbol value)
	 (set-default symbol value)
	 (imagemagick-register-types))
965
  :version "26.2")                      ; remove ART (bug#22289)
966 967 968

(imagemagick-register-types)

969 970 971 972 973
(defun image-increase-size (n)
  "Increase the image size by a factor of N.
If N is 3, then the image size will be increased by 30%.  The
default is 20%."
  (interactive "P")
974
  (image--change-size (if n
975
                          (1+ (/ n 10.0))