image.el 12.7 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)


Gerd Moellmann's avatar
Gerd Moellmann committed
36
(defconst image-type-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

(defun image-jpeg-p (data)
53 54
  "Value is non-nil if DATA, a string, consists of JFIF image data.
We accept the tag Exif because that is the same format."
55 56 57 58 59 60 61 62 63 64
  (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)
65 66 67
			   (aref data (+ i 2))))
		(code (aref data i)))
	    (when (and (>= code #xe0) (<= code #xef))
68
	      ;; APP0 LEN1 LEN2 "JFIF\0"
69
	      (throw 'jfif
70 71
		     (string-match "JFIF\\|Exif"
				   (substring data i (min (+ i nbytes) len)))))
72
	    (setq i (+ i 1 nbytes))))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
73 74 75


;;;###autoload
76 77 78
(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
79
be determined."
80
  (let ((types image-type-regexps)
Gerd Moellmann's avatar
Gerd Moellmann committed
81 82 83 84
	type)
    (while (and types (null type))
      (let ((regexp (car (car types)))
	    (image-type (cdr (car types))))
85 86 87 88 89
	(when (or (and (symbolp image-type)
		       (string-match regexp data))
		  (and (consp image-type)
		       (funcall (car image-type) data)
		       (setq image-type (cdr image-type))))
Gerd Moellmann's avatar
Gerd Moellmann committed
90 91 92 93 94
	  (setq type image-type))
	(setq types (cdr types))))
    type))


95 96 97 98 99 100 101 102 103
;;;###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."
  (unless (file-name-directory file)
    (setq file (expand-file-name file data-directory)))
  (setq file (expand-file-name file))
  (let ((header (with-temp-buffer
104
		  (set-buffer-multibyte nil)
105 106 107 108 109
		  (insert-file-contents-literally file nil 0 256)
		  (buffer-string))))
    (image-type-from-data header)))


Gerd Moellmann's avatar
Gerd Moellmann committed
110 111
;;;###autoload
(defun image-type-available-p (type)
112
  "Return non-nil if image type TYPE is available.
Gerd Moellmann's avatar
Gerd Moellmann committed
113
Image types are symbols like `xbm' or `jpeg'."
114 115
  (and (fboundp 'init-image-library)
       (init-image-library type image-library-alist)))
Gerd Moellmann's avatar
Gerd Moellmann committed
116 117

;;;###autoload
118 119 120
(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
121
Optional TYPE is a symbol describing the image type.  If TYPE is omitted
122 123
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,
124
use its file extension as image type.
125
Optional DATA-P non-nil means FILE-OR-DATA is a string containing image data.
Gerd Moellmann's avatar
Gerd Moellmann committed
126
Optional PROPS are additional image attributes to assign to the image,
Gerd Moellmann's avatar
Gerd Moellmann committed
127
like, e.g. `:mask MASK'.
Gerd Moellmann's avatar
Gerd Moellmann committed
128
Value is the image created, or nil if images of type TYPE are not supported."
129 130
  (when (and (not data-p) (not (stringp file-or-data)))
    (error "Invalid image file name `%s'" file-or-data))
131 132 133 134 135 136 137 138 139 140 141 142 143 144
  (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
145
  (unless (symbolp type)
146
    (error "Invalid image type `%s'" type))
Gerd Moellmann's avatar
Gerd Moellmann committed
147
  (when (image-type-available-p type)
148 149
    (append (list 'image :type type (if data-p :data :file) file-or-data)
	    props)))
Gerd Moellmann's avatar
Gerd Moellmann committed
150 151 152


;;;###autoload
153
(defun put-image (image pos &optional string area)
154
  "Put image IMAGE in front of POS in the current buffer.
Gerd Moellmann's avatar
Gerd Moellmann committed
155
IMAGE must be an image created with `create-image' or `defimage'.
156 157
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
158
image.  STRING is defaulted if you omit it.
Gerd Moellmann's avatar
Gerd Moellmann committed
159 160 161 162
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'
163
means display it in the right marginal area."
164
  (unless string (setq string "x"))
165
  (let ((buffer (current-buffer)))
166
    (unless (eq (car-safe image) 'image)
167 168 169
      (error "Not an image: %s" image))
    (unless (or (null area) (memq area '(left-margin right-margin)))
      (error "Invalid area %s" area))
170
    (setq string (copy-sequence string))
171
    (let ((overlay (make-overlay pos pos buffer))
172 173
	  (prop (if (null area) image (list (list 'margin area) image))))
      (put-text-property 0 (length string) 'display prop string)
174 175
      (overlay-put overlay 'put-image t)
      (overlay-put overlay 'before-string string))))
Gerd Moellmann's avatar
Gerd Moellmann committed
176 177 178


;;;###autoload
179
(defun insert-image (image &optional string area slice)
Gerd Moellmann's avatar
Gerd Moellmann committed
180
  "Insert IMAGE into current buffer at point.
181
IMAGE is displayed by inserting STRING into the current buffer
182 183
with a `display' property whose value is the image.  STRING is
defaulted if you omit it.
Gerd Moellmann's avatar
Gerd Moellmann committed
184 185 186
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'
187 188 189 190 191 192
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."
193 194 195
  ;; Use a space as least likely to cause trouble when it's a hidden
  ;; character in the buffer.
  (unless string (setq string " "))
196
  (unless (eq (car-safe image) 'image)
Gerd Moellmann's avatar
Gerd Moellmann committed
197 198 199
    (error "Not an image: %s" image))
  (unless (or (null area) (memq area '(left-margin right-margin)))
    (error "Invalid area %s" area))
200 201 202 203 204 205 206 207 208
  (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))))
209 210 211
  (let ((start (point)))
    (insert string)
    (add-text-properties start (point)
212 213 214 215 216
			 `(display ,(if slice
					(list (cons 'slice slice) image)
				      image) rear-nonsticky (display)))))


217
;;;###autoload
218
(defun insert-sliced-image (image &optional string area rows cols)
219 220 221 222 223 224 225 226 227
  "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."
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
  (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))
254
      (insert (propertize "\n" 'line-height t)))))
255

256

Gerd Moellmann's avatar
Gerd Moellmann committed
257 258 259 260 261 262 263 264 265 266 267 268

;;;###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)
269 270
	  (delete-overlay overlay)))
      (setq overlays (cdr overlays)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
271 272 273


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

277
SPECS is a list of image specifications.
Gerd Moellmann's avatar
Gerd Moellmann committed
278 279 280

Each image specification in SPECS is a property list.  The contents of
a specification are image type dependent.  All specifications must at
281 282 283
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
284 285 286 287 288 289
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.

The image is looked for first on `load-path' and then in `data-directory'."
Gerd Moellmann's avatar
Gerd Moellmann committed
290 291 292 293
  (let (image)
    (while (and specs (null image))
      (let* ((spec (car specs))
	     (type (plist-get spec :type))
294
	     (data (plist-get spec :data))
295 296
	     (file (plist-get spec :file))
	     found)
297 298
	(when (image-type-available-p type)
	  (cond ((stringp file)
299 300 301 302 303 304 305
		 (let ((path load-path))
		   (while (and (not found) path)
		     (let ((try-file (expand-file-name file (car path))))
		       (when (file-readable-p try-file)
			 (setq found try-file)))
		     (setq path (cdr path)))
		   (unless found
306 307 308 309 310
		     (let ((try-file (expand-file-name file data-directory)))
		       (if (file-readable-p try-file)
			   (setq found try-file))))
		   (if found
		       (setq image
311 312
			     (cons 'image (plist-put (copy-sequence spec)
						     :file found))))))
313
		((not (null data))
314 315
		 (setq image (cons 'image spec)))))
	(setq specs (cdr specs))))
Gerd Moellmann's avatar
Gerd Moellmann committed
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
    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
340 341 342 343


(provide 'image)

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