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

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

5
;; Maintainer: emacs-devel@gnu.org
Dave Love's avatar
Dave Love committed
6
;; Keywords: multimedia
7
;; Package: emacs
Gerd Moellmann's avatar
Gerd Moellmann committed
8 9 10

;; This file is part of GNU Emacs.

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

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

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

;;; Commentary:

;;; Code:

Miles Bader's avatar
Miles Bader committed
28 29 30 31
(defgroup image ()
  "Image support."
  :group 'multimedia)

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

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

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

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

104
(defvar image-format-suffixes
105
  '((image/x-icon "ico"))
106
  "An alist associating image types with file name suffixes.
107
This is used as a hint by the ImageMagick library when detecting
108 109 110 111 112
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.")
113

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

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

128 129 130 131 132 133 134 135 136 137 138 139
(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))
  :group 'image
  :version "25.2")
140

141 142
;; Map put into text properties on images.
(defvar image-map
Lars Ingebrigtsen's avatar
Lars Ingebrigtsen committed
143
  (let ((map (make-sparse-keymap)))
144 145 146 147 148 149
    (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))

150
(defun image-load-path-for-library (library image &optional path no-error)
151
  "Return a suitable search path for images used by LIBRARY.
152

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

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

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

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

172 173
    ;; Shush compiler.
    (defvar image-load-path)
174 175

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

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

240 241 242 243
    ;; Return an augmented `path' or `load-path'.
    (nconc (list image-directory)
           (delete image-directory (copy-sequence (or path load-path))))))

244

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


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


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


;;;###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."
347
  (let (type first)
348 349 350 351 352 353 354
    (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))))))))
355

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

377

378 379
(if (fboundp 'image-metadata)           ; eg not --without-x
    (define-obsolete-function-alias 'image-extension-data
380
      'image-metadata "24.1"))
381

382 383 384
(define-obsolete-variable-alias
    'image-library-alist
    'dynamic-library-alist "24.1")
385

386 387 388 389 390
;;;###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)
391
       (init-image-library type)))
392 393


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


410 411 412 413 414 415 416 417 418 419 420 421 422
;;;###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
423 424 425 426 427 428
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.
429
  (setq type (image-type file-or-data type data-p))
Gerd Moellmann's avatar
Gerd Moellmann committed
430
  (when (image-type-available-p type)
431
    (append (list 'image :type type (if data-p :data :file) file-or-data)
432 433 434
            (and (not (plist-get props :scale))
                 (list :scale
                       (image-compute-scaling-factor image-scaling-factor)))
435
	    props)))
Gerd Moellmann's avatar
Gerd Moellmann committed
436

437
(defun image--set-property (image property value)
438
  "Set PROPERTY in IMAGE to VALUE.
439
Internal use only."
440 441 442 443 444 445 446 447 448 449
  (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)
            (setcdr image (cddr image))
          (setq image (cddr image))))
    ;; Just enter the new value.
    (plist-put (cdr image) property value))
450
  value)
451

452 453 454 455 456 457 458
(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))
459 460
  (plist-get (cdr image) property))

461 462 463 464 465 466 467 468 469 470 471 472 473 474
(defun image-compute-scaling-factor (scaling)
  (cond
   ((numberp image-scaling-factor)
    image-scaling-factor)
   ((eq image-scaling-factor 'auto)
    (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
    (error "Invalid scaling factor %s" image-scaling-factor))))
Gerd Moellmann's avatar
Gerd Moellmann committed
475 476

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


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


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

586

Gerd Moellmann's avatar
Gerd Moellmann committed
587 588 589 590 591 592 593 594 595 596 597 598

;;;###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)
599 600
	  (delete-overlay overlay)))
      (setq overlays (cdr overlays)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
601

602 603 604 605
(defun image-search-load-path (file &optional path)
  (unless path
    (setq path image-load-path))
  (let (element found filename)
606
    (while (and (not found) (consp path))
607
      (setq element (car path))
608
      (cond
609
       ((stringp element)
610 611
	(setq found
	      (file-readable-p
612
	       (setq filename (expand-file-name file element)))))
613 614 615 616 617 618
       ((and (symbolp element) (boundp element))
	(setq element (symbol-value element))
	(cond
	 ((stringp element)
	  (setq found
		(file-readable-p
619
		 (setq filename (expand-file-name file element)))))
620
	 ((consp element)
621
	  (if (setq filename (image-search-load-path file element))
622
	      (setq found t))))))
623
      (setq path (cdr path)))
624
    (if found filename)))
Gerd Moellmann's avatar
Gerd Moellmann committed
625 626

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

630
SPECS is a list of image specifications.
Gerd Moellmann's avatar
Gerd Moellmann committed
631 632 633

Each image specification in SPECS is a property list.  The contents of
a specification are image type dependent.  All specifications must at
634 635 636
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
637 638 639 640 641
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.

642 643 644
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
645 646 647 648
  (let (image)
    (while (and specs (null image))
      (let* ((spec (car specs))
	     (type (plist-get spec :type))
649
	     (data (plist-get spec :data))
650 651
	     (file (plist-get spec :file))
	     found)
652 653
	(when (image-type-available-p type)
	  (cond ((stringp file)
654
		 (if (setq found (image-search-load-path file))
655 656 657
		     (setq image
			   (cons 'image (plist-put (copy-sequence spec)
						   :file found)))))
658
		((not (null data))
659 660
		 (setq image (cons 'image spec)))))
	(setq specs (cdr specs))))
Gerd Moellmann's avatar
Gerd Moellmann committed
661 662 663 664 665
    image))


;;;###autoload
(defmacro defimage (symbol specs &optional doc)
666
  "Define SYMBOL as an image, and return SYMBOL.
Gerd Moellmann's avatar
Gerd Moellmann committed
667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683

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

Kim F. Storm's avatar
Kim F. Storm committed
687 688

;;; Animated image API
Gerd Moellmann's avatar
Gerd Moellmann committed
689

690 691 692 693
(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.")

694 695 696 697 698 699
(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'."
700 701 702 703 704
  (when (fboundp 'image-metadata)
    (let* ((metadata (image-metadata image))
	   (images (plist-get metadata 'count))
	   (delay (plist-get metadata 'delay)))
      (when (and images (> images 1))
705 706
	(and delay (or (not (numberp delay)) (< delay 0))
	     (setq delay image-default-frame-delay))
707
	(cons images delay)))))
708

709 710 711 712 713 714
(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
715

Glenn Morris's avatar
Glenn Morris committed
716
;; "Destructively"?
717 718 719 720 721 722 723 724
(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."
725
  (let ((animation (image-multi-frame-p image))
726 727
	timer)
    (when animation
728 729
      (if (setq timer (image-animate-timer image))
	  (cancel-timer timer))
730
      (plist-put (cdr image) :animate-buffer (current-buffer))
731 732
      (run-with-timer 0.2 nil 'image-animate-timeout
		      image (or index 0) (car animation)
733
		      0 limit (+ (float-time) 0.2)))))
Kim F. Storm's avatar
Kim F. Storm committed
734 735 736 737 738 739 740 741

(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))
742 743
      (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
744 745 746 747
	  (setq tail nil)
	(setq timer nil)))
    timer))

748 749 750
(defconst image-minimum-frame-delay 0.01
  "Minimum interval in seconds between frames of an animated image.")

751 752 753
(defun image-current-frame (image)
  "The current frame number of IMAGE, indexed from 0."
  (or (plist-get (cdr image) :index) 0))
754

755
(defun image-show-frame (image n &optional nocheck)
756 757 758 759 760
  "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)
761
      (setq n (min n (1- (car (image-multi-frame-p image)))))))
762 763 764
  (plist-put (cdr image) :index n)
  (force-window-update))

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


827
(defvar imagemagick-types-inhibit)
828
(defvar imagemagick-enabled-types)
829 830 831 832

(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
833
that match `imagemagick-enabled-types' and do not match
834 835
`imagemagick-types-inhibit'."
  (when (fboundp 'imagemagick-types)
836
    (cond ((null imagemagick-enabled-types) nil)
837 838 839 840 841 842
	  ((eq imagemagick-types-inhibit t) nil)
	  (t
	   (delq nil
		 (mapcar
		  (lambda (type)
		    (unless (memq type imagemagick-types-inhibit)
843
		      (if (eq imagemagick-enabled-types t) type
844
			(catch 'found
845
			  (dolist (enable imagemagick-enabled-types nil)
846 847 848 849 850
			    (if (cond ((symbolp enable) (eq enable type))
				      ((stringp enable)
				       (string-match enable
						     (symbol-name type))))
				(throw 'found type)))))))
851 852
		  (imagemagick-types)))))))

853 854 855 856
(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'.")
857 858

;;;###autoload
Joakim Verona's avatar
Joakim Verona committed
859
(defun imagemagick-register-types ()
860
  "Register file types that can be handled by ImageMagick.
861
This function is called at startup, after loading the init file.
862
It registers the ImageMagick types returned by `imagemagick-filter-types'.
863 864 865 866 867

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

869
If Emacs is compiled without ImageMagick support, this does nothing."
870
  (when (fboundp 'imagemagick-types)
871 872 873
    (let* ((types (mapcar (lambda (type) (downcase (symbol-name type)))
			  (imagemagick-filter-types)))
	   (re (if types (concat "\\." (regexp-opt types) "\\'")))
874 875 876 877 878 879 880 881 882 883 884 885 886
	   (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)
887 888 889 890
	  ;; 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)))
891 892
      (setq imagemagick--file-regexp re))))

893 894
(defcustom imagemagick-types-inhibit
  '(C HTML HTM INFO M TXT PDF)
895
  "List of ImageMagick types that should never be treated as images.
896
This should be a list of symbols, each of which should be one of
897
the ImageMagick types listed by `imagemagick-types'.  The listed
898 899 900 901
image types are not registered by `imagemagick-register-types'.

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

902 903 904
If you change this without using customize, you must call
`imagemagick-register-types' afterwards.

905 906 907 908 909
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))
910
  :initialize 'custom-initialize-default
911 912 913
  :set (lambda (symbol value)
	 (set-default symbol value)
	 (imagemagick-register-types))
914
  :version "24.3"
915
  :group 'image)
916

917
(defcustom imagemagick-enabled-types
918
  '(3FR ART ARW AVS BMP BMP2 BMP3 CAL CALS CMYK CMYKA CR2 CRW
919 920 921 922 923 924 925 926
    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)
927
  "List of ImageMagick types to treat as images.
928 929 930 931
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.
932

933 934
The value of `imagemagick-enabled-types' may also be t, meaning
to enable all types that ImageMagick supports.
935 936 937

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

938
If you change this without using customize, you must call
939 940 941 942 943 944 945 946 947 948 949 950 951
`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))
952
  :version "24.3"
953 954 955 956
  :group 'image)

(imagemagick-register-types)

957 958 959 960 961
(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")
962 963 964
  (image--change-size (if n
                          (1+ (/ n 10))
                        1.2)))
965 966 967 968 969 970

(defun image-decrease-size (n)
  "Decrease the image size by a factor of N.
If N is 3, then the image size will be decreased by 30%.  The
default is 20%."
  (interactive "P")
971 972 973
  (image--change-size (if n
                          (- 1 (/ n 10))
                        0.8)))
974

975
(defun image--get-image ()
976
  (let ((image (get-text-property (point) 'display)))
977 978 979
    (when (or (not (consp image))
              (not (eq (car image) 'image)))
      (error "No image under point"))
980 981 982 983 984 985 986
    image))

(defun image--get-imagemagick-and-warn ()
  (unless (fboundp 'imagemagick-types)
    (error "Can't rescale images without ImageMagick support"))
  (let ((image (image--get-image)))
    (image-flush image)
987
    (plist-put (cdr image) :type 'imagemagick)
988 989
    image))

990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
(defun image--change-size (factor)
  (let* ((image (image--get-imagemagick-and-warn))
         (new-image (image--image-without-parameters image))
         (scale (image--current-scaling image new-image)))
    (setcdr image (cdr new-image))
    (plist-put (cdr image) :scale (* scale factor))))

(defun image--image-without-parameters (image)
  (cons (pop image)
        (let ((new nil))
          (while image
            (let ((key (pop image))
                  (val (pop image)))
              (unless (memq key '(:scale :width :height :max-width :max-height))
              (setq new (nconc new (list key val))))))
          new)))

(defun image--current-scaling (image new-image)
  ;; The image may be scaled due to many reasons (:scale, :max-width,
  ;; etc), so find out what the current scaling is based on the
  ;; original image size and the displayed size.
  (let ((image-width (car (image-size new-image t)))
        (display-width (car (image-size image t))))
    (/ (float display-width) image-width)))
1014

1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038
(defun image-rotate ()
  "Rotate the image under point by 90 degrees clockwise."
  (interactive)
  (let ((image (image--get-imagemagick-and-warn)))
    (plist-put (cdr image) :rotation
               (float (+ (or (plist-get (cdr image) :rotation) 0) 90)))))

(defun image-save ()
  "Save the image under point."
  (interactive)
  (let ((image (get-text-property (point) 'display)))
    (when (or (not (consp image))
              (not (eq (car image) 'image)))
      (error "No image under point"))
    (with-temp-buffer
      (let ((file (plist-get (cdr image) :file)))
        (if file
            (if (not (file-exists-p file))
                (error "File %s no longer exists" file)
              (insert-file-contents-literally file))
          (insert (plist-get (cdr image) :data))))
      (write-region (point-min) (point-max)
                    (read-file-name "Write image to file: ")))))

Gerd Moellmann's avatar
Gerd Moellmann committed
1039 1040
(provide 'image)