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

3 4
;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003,
;;   2004, 2005 Free Software Foundation, Inc.
Pavel Janík's avatar
Pavel Janík committed
5 6

;; Maintainer: FSF
Dave Love's avatar
Dave Love committed
7
;; Keywords: multimedia
Gerd Moellmann's avatar
Gerd Moellmann committed
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; 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
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
23 24
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Gerd Moellmann's avatar
Gerd Moellmann committed
25 26 27 28 29

;;; Commentary:

;;; Code:

Miles Bader's avatar
Miles Bader committed
30 31 32 33 34 35

(defgroup image ()
  "Image support."
  :group 'multimedia)


36
(defconst image-type-header-regexps
37
  '(("\\`/[\t\n\r ]*\\*.*XPM.\\*/" . xpm)
38 39 40
    ("\\`P[1-6]" . pbm)
    ("\\`GIF8" . gif)
    ("\\`\211PNG\r\n" . png)
41
    ("\\`[\t\n\r ]*#define" . xbm)
42
    ("\\`\\(MM\0\\*\\|II\\*\0\\)" . tiff)
43
    ("\\`[\t\n\r ]*%!PS" . postscript)
44
    ("\\`\xff\xd8" . (image-jpeg-p . jpeg)))
Gerd Moellmann's avatar
Gerd Moellmann committed
45 46
  "Alist of (REGEXP . IMAGE-TYPE) pairs used to auto-detect image types.
When the first bytes of an image file match REGEXP, it is assumed to
47 48 49
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
50
a non-nil value, TYPE is the image's type.")
51

52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
(defconst image-type-file-name-regexps
  '(("\\.png\\'" . png)
    ("\\.gif\\'" . gif)
    ("\\.jpe?g\\'" . jpeg)
    ("\\.bmp\\'" . bmp)
    ("\\.xpm\\'" . xpm)
    ("\\.pbm\\'" . pbm)
    ("\\.xbm\\'" . xbm)
    ("\\.ps\\'" . postscript)
    ("\\.tiff?\\'" . tiff))
  "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.")


67 68
(defvar image-load-path
  (list (file-name-as-directory (expand-file-name "images" data-directory))
69
	'data-directory 'load-path)
70
  "List of locations in which to search for image files.
71 72 73 74 75
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
value is used as a list of directories to search.")
76

77
(defun image-jpeg-p (data)
78 79
  "Value is non-nil if DATA, a string, consists of JFIF image data.
We accept the tag Exif because that is the same format."
80 81 82 83 84 85 86 87 88 89
  (when (string-match "\\`\xff\xd8" data)
    (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)
90 91 92
			   (aref data (+ i 2))))
		(code (aref data i)))
	    (when (and (>= code #xe0) (<= code #xef))
93
	      ;; APP0 LEN1 LEN2 "JFIF\0"
94
	      (throw 'jfif
95 96
		     (string-match "JFIF\\|Exif"
				   (substring data i (min (+ i nbytes) len)))))
97
	    (setq i (+ i 1 nbytes))))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
98 99 100


;;;###autoload
101 102 103
(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
104
be determined."
105
  (let ((types image-type-header-regexps)
Gerd Moellmann's avatar
Gerd Moellmann committed
106
	type)
107
    (while types
Gerd Moellmann's avatar
Gerd Moellmann committed
108 109
      (let ((regexp (car (car types)))
	    (image-type (cdr (car types))))
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
	(if (or (and (symbolp image-type)
		     (string-match regexp data))
		(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
(defun image-type-from-buffer ()
  "Determine the image type from data in the current buffer.
Value is a symbol specifying the image type or nil if type cannot
be determined."
  (let ((types image-type-header-regexps)
	type
	(opoint (point)))
    (goto-char (point-min))
    (while types
      (let ((regexp (car (car types)))
	    (image-type (cdr (car types)))
	    data)
	(if (or (and (symbolp image-type)
		     (looking-at regexp))
		(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))))
	    (setq type image-type
		  types nil)
	  (setq types (cdr types)))))
    (goto-char opoint)
Gerd Moellmann's avatar
Gerd Moellmann committed
149 150 151
    type))


152 153 154 155 156
;;;###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."
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
  (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)
	 (image-type-from-buffer))))


;;;###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."
  (let ((types image-type-file-name-regexps)
	type)
    (while types
      (if (string-match (car (car types)) file)
	  (setq type (cdr (car types))
		types nil)
	(setq types (cdr types))))
    type))
181 182


Gerd Moellmann's avatar
Gerd Moellmann committed
183 184
;;;###autoload
(defun image-type-available-p (type)
185
  "Return non-nil if image type TYPE is available.
Gerd Moellmann's avatar
Gerd Moellmann committed
186
Image types are symbols like `xbm' or `jpeg'."
187 188
  (and (fboundp 'init-image-library)
       (init-image-library type image-library-alist)))
Gerd Moellmann's avatar
Gerd Moellmann committed
189

190

Gerd Moellmann's avatar
Gerd Moellmann committed
191
;;;###autoload
192 193 194
(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.
Gerd Moellmann's avatar
Gerd Moellmann committed
195
Optional TYPE is a symbol describing the image type.  If TYPE is omitted
196 197
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,
198
use its file extension as image type.
199
Optional DATA-P non-nil means FILE-OR-DATA is a string containing image data.
Gerd Moellmann's avatar
Gerd Moellmann committed
200
Optional PROPS are additional image attributes to assign to the image,
Gerd Moellmann's avatar
Gerd Moellmann committed
201
like, e.g. `:mask MASK'.
202 203 204
Value is the image created, or nil if images of type TYPE are not supported.

Images should not be larger than specified by `max-image-size'."
205 206
  (when (and (not data-p) (not (stringp file-or-data)))
    (error "Invalid image file name `%s'" file-or-data))
207 208 209 210 211 212 213 214 215 216 217 218 219 220
  (cond ((null data-p)
	 ;; FILE-OR-DATA is a file name.
	 (unless (or type
		     (setq type (image-type-from-file-header file-or-data)))
	   (let ((extension (file-name-extension file-or-data)))
	     (unless extension
	       (error "Cannot determine image type"))
	     (setq type (intern extension)))))
	(t
	 ;; FILE-OR-DATA contains image data.
	 (unless type
	   (setq type (image-type-from-data file-or-data)))))
  (unless type
    (error "Cannot determine image type"))
Gerd Moellmann's avatar
Gerd Moellmann committed
221
  (unless (symbolp type)
222
    (error "Invalid image type `%s'" type))
Gerd Moellmann's avatar
Gerd Moellmann committed
223
  (when (image-type-available-p type)
224 225
    (append (list 'image :type type (if data-p :data :file) file-or-data)
	    props)))
Gerd Moellmann's avatar
Gerd Moellmann committed
226 227 228


;;;###autoload
229
(defun put-image (image pos &optional string area)
230
  "Put image IMAGE in front of POS in the current buffer.
Gerd Moellmann's avatar
Gerd Moellmann committed
231
IMAGE must be an image created with `create-image' or `defimage'.
232 233
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
234
image.  STRING is defaulted if you omit it.
Gerd Moellmann's avatar
Gerd Moellmann committed
235 236 237 238
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'
239
means display it in the right marginal area."
240
  (unless string (setq string "x"))
241
  (let ((buffer (current-buffer)))
242
    (unless (eq (car-safe image) 'image)
243 244 245
      (error "Not an image: %s" image))
    (unless (or (null area) (memq area '(left-margin right-margin)))
      (error "Invalid area %s" area))
246
    (setq string (copy-sequence string))
247
    (let ((overlay (make-overlay pos pos buffer))
248 249
	  (prop (if (null area) image (list (list 'margin area) image))))
      (put-text-property 0 (length string) 'display prop string)
250 251
      (overlay-put overlay 'put-image t)
      (overlay-put overlay 'before-string string))))
Gerd Moellmann's avatar
Gerd Moellmann committed
252 253 254


;;;###autoload
255
(defun insert-image (image &optional string area slice)
Gerd Moellmann's avatar
Gerd Moellmann committed
256
  "Insert IMAGE into current buffer at point.
257
IMAGE is displayed by inserting STRING into the current buffer
258 259
with a `display' property whose value is the image.  STRING is
defaulted if you omit it.
Gerd Moellmann's avatar
Gerd Moellmann committed
260 261 262
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'
263 264 265 266 267 268
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."
269 270 271
  ;; Use a space as least likely to cause trouble when it's a hidden
  ;; character in the buffer.
  (unless string (setq string " "))
272
  (unless (eq (car-safe image) 'image)
Gerd Moellmann's avatar
Gerd Moellmann committed
273 274 275
    (error "Not an image: %s" image))
  (unless (or (null area) (memq area '(left-margin right-margin)))
    (error "Invalid area %s" area))
276 277 278 279 280 281 282 283 284
  (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))))
285 286 287
  (let ((start (point)))
    (insert string)
    (add-text-properties start (point)
288 289 290 291 292
			 `(display ,(if slice
					(list (cons 'slice slice) image)
				      image) rear-nonsticky (display)))))


293
;;;###autoload
294
(defun insert-sliced-image (image &optional string area rows cols)
295 296 297 298 299 300 301 302 303
  "Insert IMAGE into current buffer at point.
IMAGE is displayed by inserting STRING into the current buffer
with a `display' property whose value is the image.  STRING is
defaulted if you omit it.
AREA is where to display the image.  AREA nil or omitted means
display it in the text area, a value of `left-margin' means
display it in the left marginal area, a value of `right-margin'
means display it in the right marginal area.
The image is automatically split into ROW x COLS slices."
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
  (unless string (setq string " "))
  (unless (eq (car-safe image) 'image)
    (error "Not an image: %s" image))
  (unless (or (null area) (memq area '(left-margin right-margin)))
    (error "Invalid area %s" area))
  (if area
      (setq image (list (list 'margin area) image))
    ;; Cons up a new spec equal but not eq to `image' so that
    ;; inserting it twice in a row (adjacently) displays two copies of
    ;; the image.  Don't try to avoid this by looking at the display
    ;; properties on either side so that we DTRT more often with
    ;; cut-and-paste.  (Yanking killed image text next to another copy
    ;; of it loses anyway.)
    (setq image (cons 'image (cdr image))))
  (let ((x 0.0) (dx (/ 1.0001 (or cols 1)))
	 (y 0.0) (dy (/ 1.0001 (or rows 1))))
    (while (< y 1.0)
      (while (< x 1.0)
	(let ((start (point)))
	  (insert string)
	  (add-text-properties start (point)
			       `(display ,(list (list 'slice x y dx dy) image)
					 rear-nonsticky (display)))
	  (setq x (+ x dx))))
      (setq x 0.0
	    y (+ y dy))
330
      (insert (propertize "\n" 'line-height t)))))
331

332

Gerd Moellmann's avatar
Gerd Moellmann committed
333 334 335 336 337 338 339 340 341 342 343 344

;;;###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)
345 346
	  (delete-overlay overlay)))
      (setq overlays (cdr overlays)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
347

348 349 350 351
(defun image-search-load-path (file &optional path)
  (unless path
    (setq path image-load-path))
  (let (element found filename)
352
    (while (and (not found) (consp path))
353
      (setq element (car path))
354
      (cond
355
       ((stringp element)
356 357
	(setq found
	      (file-readable-p
358
	       (setq filename (expand-file-name file element)))))
359 360 361 362 363 364
       ((and (symbolp element) (boundp element))
	(setq element (symbol-value element))
	(cond
	 ((stringp element)
	  (setq found
		(file-readable-p
365
		 (setq filename (expand-file-name file element)))))
366
	 ((consp element)
367
	  (if (setq filename (image-search-load-path file element))
368
	      (setq found t))))))
369
      (setq path (cdr path)))
370
    (if found filename)))
Gerd Moellmann's avatar
Gerd Moellmann committed
371 372

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

376
SPECS is a list of image specifications.
Gerd Moellmann's avatar
Gerd Moellmann committed
377 378 379

Each image specification in SPECS is a property list.  The contents of
a specification are image type dependent.  All specifications must at
380 381 382
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
383 384 385 386 387
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.

388 389 390
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
391 392 393 394
  (let (image)
    (while (and specs (null image))
      (let* ((spec (car specs))
	     (type (plist-get spec :type))
395
	     (data (plist-get spec :data))
396 397
	     (file (plist-get spec :file))
	     found)
398 399
	(when (image-type-available-p type)
	  (cond ((stringp file)
400
		 (if (setq found (image-search-load-path file))
401 402 403
		     (setq image
			   (cons 'image (plist-put (copy-sequence spec)
						   :file found)))))
404
		((not (null data))
405 406
		 (setq image (cons 'image spec)))))
	(setq specs (cdr specs))))
Gerd Moellmann's avatar
Gerd Moellmann committed
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
    image))


;;;###autoload
(defmacro defimage (symbol specs &optional doc)
  "Define SYMBOL as an image.

SPECS is a list of image specifications.  DOC is an optional
documentation string.

Each image specification in SPECS is a property list.  The contents of
a specification are image type dependent.  All specifications must at
least contain the properties `:type TYPE' and either `:file FILE' or
`:data DATA', where TYPE is a symbol specifying the image type,
e.g. `xbm', FILE is the file to load the image from, and DATA is a
string containing the actual image data.  The first image
specification whose TYPE is supported, and FILE exists, is used to
define SYMBOL.

Example:

   (defimage test-image ((:type xpm :file \"~/test1.xpm\")
                         (:type xbm :file \"~/test1.xbm\")))"
  `(defvar ,symbol (find-image ',specs) ,doc))
Gerd Moellmann's avatar
Gerd Moellmann committed
431 432 433 434


(provide 'image)

Miles Bader's avatar
Miles Bader committed
435
;;; arch-tag: 8e76a07b-eb48-4f3e-a7a0-1a7ba9f096b3
Dave Love's avatar
Dave Love committed
436
;;; image.el ends here