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

3
;; Copyright (C) 1998, 99, 2000, 01, 04 Free Software Foundation, Inc.
Pavel Janík's avatar
Pavel Janík committed
4 5

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

;; 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
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.

;;; Commentary:

;;; Code:

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

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


Gerd Moellmann's avatar
Gerd Moellmann committed
35
(defconst image-type-regexps
36
  '(("\\`/[\t\n\r ]*\\*.*XPM.\\*/" . xpm)
37 38 39
    ("\\`P[1-6]" . pbm)
    ("\\`GIF8" . gif)
    ("\\`\211PNG\r\n" . png)
40
    ("\\`[\t\n\r ]*#define" . xbm)
41
    ("\\`\\(MM\0\\*\\|II\\*\0\\)" . tiff)
42
    ("\\`[\t\n\r ]*%!PS" . postscript)
43
    ("\\`\xff\xd8" . (image-jpeg-p . jpeg)))
Gerd Moellmann's avatar
Gerd Moellmann committed
44 45
  "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
46 47 48
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
49
a non-nil value, TYPE is the image's type.")
50

51 52 53 54 55 56
;;;###autoload
(defvar image-library-alist nil
  "Alist of image types vs external libraries needed to display them.

Each element is a list (IMAGE-TYPE LIBRARY...), where the car is a symbol
representing a supported image type, and the rest are strings giving
57 58 59 60 61 62
alternate filenames for the corresponding external libraries.

Emacs tries to load the libraries in the order they appear on the
list; if none is loaded, the running session of Emacs won't
support the image type.  Types 'pbm and 'xbm don't need to be
listed; they're always supported.")
63
;;;###autoload (put 'image-library-alist 'risky-local-variable t)
64 65

(defun image-jpeg-p (data)
66 67
  "Value is non-nil if DATA, a string, consists of JFIF image data.
We accept the tag Exif because that is the same format."
68 69 70 71 72 73 74 75 76 77
  (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)
78 79 80
			   (aref data (+ i 2))))
		(code (aref data i)))
	    (when (and (>= code #xe0) (<= code #xef))
81
	      ;; APP0 LEN1 LEN2 "JFIF\0"
82
	      (throw 'jfif
83 84
		     (string-match "JFIF\\|Exif"
				   (substring data i (min (+ i nbytes) len)))))
85
	    (setq i (+ i 1 nbytes))))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
86 87 88


;;;###autoload
89 90 91
(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
92
be determined."
93
  (let ((types image-type-regexps)
Gerd Moellmann's avatar
Gerd Moellmann committed
94 95 96 97
	type)
    (while (and types (null type))
      (let ((regexp (car (car types)))
	    (image-type (cdr (car types))))
98 99 100 101 102
	(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
103 104 105 106 107
	  (setq type image-type))
	(setq types (cdr types))))
    type))


108 109 110 111 112 113 114 115 116
;;;###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
117
		  (set-buffer-multibyte nil)
118 119 120 121 122
		  (insert-file-contents-literally file nil 0 256)
		  (buffer-string))))
    (image-type-from-data header)))


Gerd Moellmann's avatar
Gerd Moellmann committed
123 124 125 126
;;;###autoload
(defun image-type-available-p (type)
  "Value is non-nil if image type TYPE is available.
Image types are symbols like `xbm' or `jpeg'."
127 128
  (and (fboundp 'init-image-library)
       (init-image-library type image-library-alist)))
Gerd Moellmann's avatar
Gerd Moellmann committed
129 130

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


;;;###autoload
166
(defun put-image (image pos &optional string area)
167
  "Put image IMAGE in front of POS in the current buffer.
Gerd Moellmann's avatar
Gerd Moellmann committed
168
IMAGE must be an image created with `create-image' or `defimage'.
169 170
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
171
image.  STRING is defaulted if you omit it.
Gerd Moellmann's avatar
Gerd Moellmann committed
172 173 174 175
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'
176
means display it in the right marginal area."
177
  (unless string (setq string "x"))
178
  (let ((buffer (current-buffer)))
179
    (unless (eq (car-safe image) 'image)
180 181 182
      (error "Not an image: %s" image))
    (unless (or (null area) (memq area '(left-margin right-margin)))
      (error "Invalid area %s" area))
183
    (setq string (copy-sequence string))
184
    (let ((overlay (make-overlay pos pos buffer))
185 186
	  (prop (if (null area) image (list (list 'margin area) image))))
      (put-text-property 0 (length string) 'display prop string)
187 188
      (overlay-put overlay 'put-image t)
      (overlay-put overlay 'before-string string))))
Gerd Moellmann's avatar
Gerd Moellmann committed
189 190 191


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


(defun insert-sliced-image (image &optional string area rows cols)
231 232 233 234 235 236 237 238 239
  "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."
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
  (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))
266
      (insert (propertize "\n" 'line-height 0)))))
267

268

Gerd Moellmann's avatar
Gerd Moellmann committed
269 270 271 272 273 274 275 276 277 278 279 280

;;;###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)
281 282
	  (delete-overlay overlay)))
      (setq overlays (cdr overlays)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
283 284 285


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

289
SPECS is a list of image specifications.
Gerd Moellmann's avatar
Gerd Moellmann committed
290 291 292

Each image specification in SPECS is a property list.  The contents of
a specification are image type dependent.  All specifications must at
293 294 295
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
296 297 298 299 300 301
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
302 303 304 305
  (let (image)
    (while (and specs (null image))
      (let* ((spec (car specs))
	     (type (plist-get spec :type))
306
	     (data (plist-get spec :data))
307 308
	     (file (plist-get spec :file))
	     found)
309 310
	(when (image-type-available-p type)
	  (cond ((stringp file)
311 312 313 314 315 316 317
		 (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
318 319 320 321 322
		     (let ((try-file (expand-file-name file data-directory)))
		       (if (file-readable-p try-file)
			   (setq found try-file))))
		   (if found
		       (setq image
323 324
			     (cons 'image (plist-put (copy-sequence spec)
						     :file found))))))
325
		((not (null data))
326 327
		 (setq image (cons 'image spec)))))
	(setq specs (cdr specs))))
Gerd Moellmann's avatar
Gerd Moellmann committed
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
    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
352 353 354 355


(provide 'image)

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