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 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]\\(?:\
38 39 40
\\(?:\\(?:#[^\r\n]*[\r\n]\\)?[[:space:]]\\)+\
\\(?:\\(?:#[^\r\n]*[\r\n]\\)?[0-9]\\)+\
\\)\\{2\\}" . pbm)
41
    ("\\`GIF8[79]a" . gif)
42
    ("\\`\x89PNG\r\n\x1a\n" . png)
43 44 45 46 47
    ("\\`[\t\n\r ]*#define \\([a-z0-9_]+\\)_width [0-9]+\n\
#define \\1_height [0-9]+\n\\(\
#define \\1_x_hot [0-9]+\n\
#define \\1_y_hot [0-9]+\n\\)?\
static \\(unsigned \\)?char \\1_bits" . xbm)
48 49
    ("\\`\\(?:MM\0\\*\\|II\\*\0\\)" . tiff)
    ("\\`[\t\n\r ]*%!PS" . postscript)
50
    ("\\`\xff\xd8" . jpeg)    ; used to be (image-jpeg-p . jpeg)
51 52 53 54 55 56 57 58
    (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
	     (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
	(concat "\\(?:<\\?xml[ \t\r\n]+[^>]*>\\)?[ \t\r\n]*<"
		comment-re "*"
		"\\(?:!DOCTYPE[ \t\r\n]+[^>]*>[ \t\r\n]*<[ \t\r\n]*" comment-re "*\\)?"
		"[Ss][Vv][Gg]"))
     . svg)
    )
59
  "Alist of (REGEXP . IMAGE-TYPE) pairs used to auto-detect image types.
Gerd Moellmann's avatar
Gerd Moellmann committed
60
When the first bytes of an image file match REGEXP, it is assumed to
61 62 63 64
be of image type IMAGE-TYPE if IMAGE-TYPE is a symbol.  If not a symbol,
IMAGE-TYPE must be a pair (PREDICATE . TYPE).  PREDICATE is called
with one argument, a string containing the image data.  If PREDICATE returns
a non-nil value, TYPE is the image's type.")
65

66
(defvar image-type-file-name-regexps
67 68 69 70 71 72 73 74
  '(("\\.png\\'" . png)
    ("\\.gif\\'" . gif)
    ("\\.jpe?g\\'" . jpeg)
    ("\\.bmp\\'" . bmp)
    ("\\.xpm\\'" . xpm)
    ("\\.pbm\\'" . pbm)
    ("\\.xbm\\'" . xbm)
    ("\\.ps\\'" . postscript)
75 76 77
    ("\\.tiff?\\'" . tiff)
    ("\\.svgz?\\'" . svg)
    )
78 79 80 81
  "Alist of (REGEXP . IMAGE-TYPE) pairs used to identify image files.
When the name of an image file match REGEXP, it is assumed to
be of image type IMAGE-TYPE.")

82 83 84
;; We rely on `auto-mode-alist' to detect xbm and xpm files, instead
;; of content autodetection.  Their contents are just C code, so it is
;; easy to generate false matches.
85 86
(defvar image-type-auto-detectable
  '((pbm . t)
87
    (xbm . nil)
88 89 90
    (bmp . maybe)
    (gif . maybe)
    (png . maybe)
91
    (xpm . nil)
92 93
    (jpeg . maybe)
    (tiff . maybe)
94
    (svg . maybe)
95 96 97 98 99 100 101 102 103
    (postscript . nil))
  "Alist of (IMAGE-TYPE . AUTODETECT) pairs used to auto-detect image files.
\(See `image-type-auto-detected-p').

AUTODETECT can be
 - t      always auto-detect.
 - nil    never auto-detect.
 - maybe  auto-detect only if the image type is available
	    (see `image-type-available-p').")
104

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

115 116 117
(defcustom image-load-path
  (list (file-name-as-directory (expand-file-name "images" data-directory))
        'data-directory 'load-path)
118
  "List of locations in which to search for image files.
119 120 121 122
If an element is a string, it defines a directory to search.
If an element is a variable symbol whose value is a string, that
value defines a directory to search.
If an element is a variable symbol whose value is a list, the
123 124 125
value is used as a list of directories to search.

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

129 130 131 132 133 134 135 136 137 138 139 140
(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")
141

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

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

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

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

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

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

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

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

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

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

245

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


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


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


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

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

378

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

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

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


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


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

438
(defun image--set-property (image property value)
439
  "Set PROPERTY in IMAGE to VALUE.
440
Internal use only."
441 442 443 444 445 446 447 448 449 450
  (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))
451
  value)
452

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

462 463 464 465 466 467 468 469 470 471 472 473 474 475
(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
476 477

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


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


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

587

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

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

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

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

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

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

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


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

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

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

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

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

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

Glenn Morris's avatar
Glenn Morris committed
717
;; "Destructively"?
718 719 720 721 722 723 724 725
(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."
726
  (let ((animation (image-multi-frame-p image))
727 728
	timer)
    (when animation
729 730
      (if (setq timer (image-animate-timer image))
	  (cancel-timer timer))
731
      (plist-put (cdr image) :animate-buffer (current-buffer))
732 733 734
      (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
735 736 737 738 739 740 741 742

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

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

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

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

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


823
(defvar imagemagick-types-inhibit)
824
(defvar imagemagick-enabled-types)
825 826 827 828

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

849 850 851 852
(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'.")
853 854

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

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

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

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

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

898 899 900
If you change this without using customize, you must call
`imagemagick-register-types' afterwards.

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

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

929 930
The value of `imagemagick-enabled-types' may also be t, meaning
to enable all types that ImageMagick supports.
931 932 933

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

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

(imagemagick-register-types)

953 954 955 956 957
(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")
958 959 960
  (image--change-size (if n
                          (1+ (/ n 10))
                        1.2)))
961 962 963 964 965 966

(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")
967 968 969
  (image--change-size (if n
                          (- 1 (/ n 10))
                        0.8)))
970

971 972 973 974 975 976 977
(defun image--get-image ()
  (let ((image (or (get-text-property (point) 'display)
                   ;; `put-image' uses overlays, so find an image in
                   ;; the overlays.
                   (seq-find (lambda (overlay)
                               (overlay-get overlay 'display))
                             (overlays-at (point))))))
978 979 980
    (when (or (not (consp image))
              (not (eq (car image) 'image)))
      (error "No image under point"))
981 982 983 984 985 986 987
    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)
988
    (plist-put (cdr image) :type 'imagemagick)
989 990
    image))

991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
(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)))
1015

1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039
(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
1040 1041
(provide 'image)

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