X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/d2fc7e3d0f6f57f962cbd94df3bf4fd15a37bb68..0f74f7850de124626d556442d22d143d85457816:/lisp/image.el diff --git a/lisp/image.el b/lisp/image.el index 3b90ac46bd..c686262263 100644 --- a/lisp/image.el +++ b/lisp/image.el @@ -389,6 +389,7 @@ IMAGE must be an image created with `create-image' or `defimage'. 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 image. STRING is defaulted if you omit it. +The overlay created will have the `put-image' property set to t. 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 @@ -590,39 +591,40 @@ Example: ;;; Animated image API -(defcustom image-animate-max-time 30 - "Time in seconds to animate images." - :type 'integer - :version "24.1" - :group 'image) - (defconst image-animated-types '(gif) "List of supported animated image types.") -;;;###autoload -(defun create-animated-image (file-or-data &optional type data-p &rest props) - "Create an animated 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. - -Images should not be larger than specified by `max-image-size'." - (setq type (image-type file-or-data type data-p)) - (when (image-type-available-p type) - (let* ((animate (memq type image-animated-types)) - (image - (append (list 'image :type type (if data-p :data :file) file-or-data) - (if animate '(:index 0)) - props))) - (if animate - (image-animate-start image)) - image))) +(defun image-animated-p (image) + "Return non-nil if image can be animated. +Actually, the return value is a cons (NIMAGES . DELAY), where +NIMAGES is the number of sub-images in the animated image and +DELAY is the delay in second until the next sub-image shall be +displayed." + (cond + ((eq (plist-get (cdr image) :type) 'gif) + (let* ((metadata (image-metadata image)) + (images (plist-get metadata 'count)) + (delay (plist-get metadata 'delay))) + (when (and images (> images 1) (numberp delay)) + (if (< delay 0) (setq delay 0.1)) + (cons images delay)))))) + +(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." + (let ((animation (image-animated-p image)) + timer) + (when animation + (if (setq timer (image-animate-timer image)) + (cancel-timer timer)) + (run-with-timer 0.2 nil 'image-animate-timeout + image (or index 0) (car animation) + 0 limit)))) (defun image-animate-timer (image) "Return the animation timer for image IMAGE." @@ -631,98 +633,78 @@ Images should not be larger than specified by `max-image-size'." (while tail (setq timer (car tail) tail (cdr tail)) - (if (and (eq (aref timer 5) #'image-animate-timeout) - (consp (aref timer 6)) - (eq (car (aref timer 6)) image)) + (if (and (eq (aref timer 5) 'image-animate-timeout) + (eq (car-safe (aref timer 6)) image)) (setq tail nil) (setq timer nil))) timer)) -(defun image-animate-start (image &optional max-time) - "Start animation of image IMAGE. -Optional second arg MAX-TIME is number of seconds to animate image, -or t to animate infinitely." - (let ((anim (image-animated-p image)) - timer tmo) - (when anim - (if (setq timer (image-animate-timer image)) - (setcar (nthcdr 3 (aref timer 6)) max-time) - (setq tmo (* (cdr anim) 0.01)) - (setq max-time (or max-time image-animate-max-time)) - (run-with-timer tmo nil #'image-animate-timeout - image 1 (car anim) - (if (numberp max-time) - (- max-time tmo) - max-time)))))) - -(defun image-animate-stop (image) - "Stop animation of image." - (let ((timer (image-animate-timer image))) - (when timer - (cancel-timer timer)))) - -(defun image-animate-timeout (image ino count time-left) - (if (>= ino count) - (setq ino 0)) - (plist-put (cdr image) :index ino) +(defun image-animate-timeout (image n count time-elapsed limit) + "Display animation frame N of IMAGE. +N=0 refers to the initial animation frame. +COUNT is the total number of frames in the animation. +DELAY is the time between animation frames, in seconds. +TIME-ELAPSED is the total time that has elapsed since +`image-animate-start' was called. +LIMIT determines when to stop. If t, loop forever. If nil, stop + after displaying the last animation frame. Otherwise, stop + after LIMIT seconds have elapsed." + (plist-put (cdr image) :index n) (force-window-update) - (let ((anim (image-animated-p image)) tmo) - (when anim - (setq tmo (* (cdr anim) 0.01)) - (unless (and (= ino 0) (numberp time-left) (< time-left tmo)) - (run-with-timer tmo nil #'image-animate-timeout - image (1+ ino) count - (if (numberp time-left) - (- time-left tmo) - time-left)))))) - -(defun image-animated-p (image) - "Return non-nil if image is animated. -Actually, return value is a cons (IMAGES . DELAY) where IMAGES -is the number of sub-images in the animated image, and DELAY -is the delay in 100ths of a second until the next sub-image -shall be displayed." - (cond - ((eq (plist-get (cdr image) :type) 'gif) - (let* ((metadata (image-metadata image)) - (images (plist-get metadata 'count)) - (extdata (plist-get metadata 'extension-data)) - (anim (plist-get extdata #xF9)) - (tmo (and (integerp images) (> images 1) - (stringp anim) (>= (length anim) 4) - (+ (aref anim 1) (* (aref anim 2) 256))))) - (when tmo - (if (eq tmo 0) (setq tmo 10)) - (cons images tmo)))))) + (setq n (1+ n)) + (let* ((time (float-time)) + (animation (image-animated-p image)) + ;; Subtract off the time we took to load the image from the + ;; stated delay time. + (delay (max (+ (cdr animation) time (- (float-time))) + 0.01)) + done) + (if (>= n count) + (if limit + (setq 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)))) (defcustom imagemagick-types-inhibit '(C HTML HTM TXT PDF) - ;; FIXME what are the possible options? - ;; Are these actually file-name extensions? - ;; Why are these upper-case when eg image-types is lower-case? - "Types the ImageMagick loader should not try to handle." - :type '(choice (const :tag "Let ImageMagick handle all the types it can" nil) + "ImageMagick types that Emacs should not use ImageMagick to handle. +This should be a list of symbols, each of which has the same +names as one of the format tags used internally by ImageMagick; +see `imagemagick-types'. Entries in this list are excluded from +being registered by `imagemagick-register-types'. + +If Emacs is compiled without ImageMagick, this variable has no effect." + :type '(choice (const :tag "Let ImageMagick handle all types it can" nil) (repeat symbol)) :version "24.1" :group 'image) ;;;###autoload (defun imagemagick-register-types () - "Register the file types that ImageMagick is able to handle." - (if (fboundp 'imagemagick-types) - (let ((im-types (imagemagick-types))) - (dolist (im-inhibit imagemagick-types-inhibit) - (setq im-types (remove im-inhibit im-types))) - (dolist (im-type im-types) - (let ((extension (downcase (symbol-name im-type)))) - (push - (cons (concat "\\." extension "\\'") 'image-mode) - auto-mode-alist) - (push - (cons (concat "\\." extension "\\'") 'imagemagick) - image-type-file-name-regexps)))) - (error "Emacs was not built with ImageMagick support"))) + "Register file types that can be handled by ImageMagick. +This adds the file types returned by `imagemagick-types' +\(excluding the ones in `imagemagick-types-inhibit') to +`auto-mode-alist' and `image-type-file-name-regexps', so that +Emacs visits them in Image mode. + +If Emacs is compiled without ImageMagick support, do nothing." + (when (fboundp 'imagemagick-types) + (let ((im-types (imagemagick-types))) + (dolist (im-inhibit imagemagick-types-inhibit) + (setq im-types (delq im-inhibit im-types))) + (dolist (im-type im-types) + (let ((extension + (concat "\\." (downcase (symbol-name im-type)) + "\\'"))) + (push (cons extension 'image-mode) auto-mode-alist) + (push (cons extension 'imagemagick) + image-type-file-name-regexps)))))) (provide 'image)