emacs: lisp/tumme.el comparison

comparison lisp/tumme.el @ 68815:3e8cc27a9bcf

Remove todo item about Thumbnail Managing Standard. (tumme) <defgroup>: Change :group to `multimedia'. (tumme-thumbnail-storage): Add choice `standard' for Thumbnail Managing Standard. (tumme-cmd-create-thumbnail-options): Use %w and %h instead of %s. Fix dostring. (tumme-cmd-create-temp-image-options): Use %w and %h instead of %x and %y. Fix docstring. (tumme-cmd-pngnq-program, tumme-cmd-pngcrush-program) (tumme-cmd-create-standard-thumbnail-command): New user options. (tumme-thumb-size): Set default to 128 if tumme-thumbnail-storage is `standard'. Fix docstring. (tumme-thumb-width, tumme-thumb-height): New user options. (tumme-external-viewer): Try to find various viewers. (tumme-get-thumbnail-image): Use `create-image' instead of constructing the `image' structure. (tumme-insert-thumbnail): Use `png' if tumme-thumbnail-storage is `standard'. (tumme-thumb-name): Add file name generation for standard storage. Simplify code for other storages. (tumme-thumb-name): Use width %w and height %h instead of size %s. Add modification time %m and thumbnail-nq8 %q. Use `tumme-cmd-create-standard-thumbnail-command' if tumme-thumbnail-storage is `standard'. (tumme-dired-insert-marked-thumbs): New autoload command. (tumme-dired-after-readin-hook): New function. (tumme-line-up-dynamic): Use `tumme-thumb-width' instead of `tumme-thumb-size'. (tumme-display-image): Replace size-x %x and size-y %y with width %w and height %h.

author	Juri Linkov <juri@jurta.org>
date	Sun, 12 Feb 2006 17:44:30 +0000
parents	268f839373ee
children	207844891bb3

comparison

equal deleted inserted replaced

-:fe9073ac802e
+:3e8cc27a9bcf
 ;;
 ;;
 ;; TODO
 ;; ====
 ;;
-;; * Look into supporting the Thumbnail Managing Standard, maybe as a
-;; configurable option.
-;;
 ;; * Support gallery creation when using per-directory thumbnail
 ;; storage.
 ;;
 ;; * Some sort of auto-rotate function based on rotate info in the
 ;; EXIF data.
 (require 'format-spec)
 (defgroup tumme nil
 "Use dired to browse your images as thumbnails, and more."
 :prefix "tumme-"
-:group 'files)
+:group 'multimedia)
 (defcustom tumme-dir "~/.emacs.d/tumme/"
 "*Directory where thumbnail images are stored."
 :type 'string
 :group 'tumme)
 controlled by this variable.  \"Use tumme dir\" means that the
 thumbnails are stored in a central directory.  \"Per directory\"
 means that each thumbnail is stored in a subdirectory called
 \".tumme\" in the same directory where the image file is."
 :type '(choice :tag "How to store thumbnail files"
+(const :tag "Thumbnail Managing Standard" standard)
 (const :tag "Use tumme-dir" use-tumme-dir)
 (const :tag "Per-directory" per-directory))
 :group 'tumme)
 (defcustom tumme-db-file "~/.emacs.d/tumme/.tumme_db"
 Used together with `tumme-cmd-create-thumbnail-options'."
 :type 'string
 :group 'tumme)
 (defcustom tumme-cmd-create-thumbnail-options
-"%p -size %sx%s \"%f\" -resize %sx%s +profile \"*\" jpeg:\"%t\""
+"%p -size %wx%h \"%f\" -resize %wx%h +profile \"*\" jpeg:\"%t\""
 "*Format of command used to create thumbnail image.
 Available options are %p which is replaced by
-`tumme-cmd-create-thumbnail-program', %s which is replaced by
+`tumme-cmd-create-thumbnail-program', %w which is replaced by
-`tumme-thumb-size', %f which is replaced by the file name of the
+`tumme-thumb-width', %h which is replaced by `tumme-thumb-height',
-original image and %t which is replaced by the file name of the
+%f which is replaced by the file name of the original image and %t
-thumbnail file."
+which is replaced by the file name of the thumbnail file."
 :type 'string
 :group 'tumme)
 (defcustom tumme-cmd-create-temp-image-program
 "convert"
 Used together with `tumme-cmd-create-temp-image-options'."
 :type 'string
 :group 'tumme)
 (defcustom tumme-cmd-create-temp-image-options
-"%p -size %xx%y \"%f\" -resize %xx%y +profile \"*\" jpeg:\"%t\""
+"%p -size %wx%h \"%f\" -resize %wx%h +profile \"*\" jpeg:\"%t\""
 "*Format of command used to create temporary image for display window.
 Available options are %p which is replaced by
-`tumme-cmd-create-temp-image-program', %x and %y which is replaced by
+`tumme-cmd-create-temp-image-program', %w and %h which is replaced by
-the calculated max size for x and y in the image display window, %f
+the calculated max size for width and height in the image display window,
-which is replaced by the file name of the original image and %t which
+%f which is replaced by the file name of the original image and %t which
 is replaced by the file name of the temporary file."
+:type 'string
+:group 'tumme)
+(defcustom tumme-cmd-pngnq-program (executable-find "pngnq")
+"*The file name of the `pngnq' program.
+It quantizes colors of PNG images down to 256 colors."
+:type '(choice (const :tag "Not Set" nil) string)
+:group 'tumme)
+(defcustom tumme-cmd-pngcrush-program (executable-find "pngcrush")
+"*The file name of the `pngcrush' program.
+It optimizes the compression of PNG images.  Also it adds PNG textual chunks
+with the information required by the Thumbnail Managing Standard."
+:type '(choice (const :tag "Not Set" nil) string)
+:group 'tumme)
+(defcustom tumme-cmd-create-standard-thumbnail-command
+(concat
+tumme-cmd-create-thumbnail-program " "
+"-size %wx%h \"%f\" "
+(unless (or tumme-cmd-pngcrush-program tumme-cmd-pngnq-program)
+(concat
+"-set \"Thumb::MTime\" \"%m\" "
+"-set \"Thumb::URI\" \"file://%f\" "
+"-set \"Description\" \"Thumbnail of file://%f\" "
+"-set \"Software\" \"" (emacs-version) "\" "))
+"-thumbnail %wx%h png:\"%t\""
+(if tumme-cmd-pngnq-program
+(concat
+" ; " tumme-cmd-pngnq-program " -f \"%t\""
+(unless tumme-cmd-pngcrush-program
+" ; mv %q %t")))
+(if tumme-cmd-pngcrush-program
+(concat
+(unless tumme-cmd-pngcrush-program
+" ; cp %t %q")
+" ; " tumme-cmd-pngcrush-program " -q "
+"-text b \"Description\" \"Thumbnail of file://%f\" "
+"-text b \"Software\" \"" (emacs-version) "\" "
+;; "-text b \"Thumb::Image::Height\" \"%oh\" "
+;; "-text b \"Thumb::Image::Mimetype\" \"%mime\" "
+;; "-text b \"Thumb::Image::Width\" \"%ow\" "
+"-text b \"Thumb::MTime\" \"%m\" "
+;; "-text b \"Thumb::Size\" \"%b\" "
+"-text b \"Thumb::URI\" \"file://%f\" "
+"%q %t"
+" ; rm %q")))
+"*Command to create thumbnails according to the Thumbnail Managing Standard."
 :type 'string
 :group 'tumme)
 (defcustom tumme-cmd-rotate-thumbnail-program
 "mogrify"
 "*List of \"hidden\" tags.
 Used by `tumme-gallery-generate' to leave out \"hidden\" images."
 :type '(repeat string)
 :group 'tumme)
-(defcustom tumme-thumb-size 100
+(defcustom tumme-thumb-size (if (eq 'standard tumme-thumbnail-storage) 128 100)
-"Size of thumbnails, in pixels."
+"Size of thumbnails, in pixels.
+This is the default size for both `tumme-thumb-width' and `tumme-thumb-height'."
+:type 'integer
+:group 'tumme)
+(defcustom tumme-thumb-width tumme-thumb-size
+"Width of thumbnails, in pixels."
+:type 'integer
+:group 'tumme)
+(defcustom tumme-thumb-height tumme-thumb-size
+"Height of thumbnails, in pixels."
 :type 'integer
 :group 'tumme)
 (defcustom tumme-thumb-relief 2
 "*Size of button-like border around thumbnails."
 \(without path) of original image file, %t with the list of tags and %c
 with the comment."
 :type 'string
 :group 'tumme)
-(defcustom tumme-external-viewer "qiv -t"
+(defcustom tumme-external-viewer
+;; TODO: use mailcap, dired-guess-shell-alist-default, dired-view-command-alist
+(cond ((executable-find "display"))
+((executable-find "xli"))
+((executable-find "qiv") "qiv -t"))
 "*Name of external viewer.
 Including parameters.  Used when displaying original image from
 `tumme-thumbnail-mode'."
 :type 'string
 :group 'tumme)
 (let ((thumb-file (tumme-thumb-name file)))
 (unless (and (file-exists-p thumb-file)
 		 (<= (float-time (nth 5 (file-attributes file)))
 		     (float-time (nth 5 (file-attributes thumb-file)))))
 (tumme-create-thumb file thumb-file))
-(list 'image :type 'jpeg :file thumb-file
+(create-image thumb-file)
-	  :relief tumme-thumb-relief :margin tumme-thumb-margin)))
+;;     (list 'image :type 'jpeg
+;;           :file thumb-file
+;; 	  :relief tumme-thumb-relief :margin tumme-thumb-margin)
+))
 (defun tumme-insert-thumbnail (file original-file-name
 associated-dired-buffer)
 "Insert thumbnail image FILE.
 Add text properties ORIGINAL-FILE-NAME and ASSOCIATED-DIRED-BUFFER."
 (let (beg end)
 (setq beg (point))
 (tumme-insert-image file
-'jpeg
+;; TODO: this should depend on the real file type
+(if (eq 'standard tumme-thumbnail-storage)
+'png 'jpeg)
 tumme-thumb-relief
 tumme-thumb-margin)
 (setq end (point))
 (add-text-properties
 beg end
 "Return thumbnail file name for FILE.
 Depending on the value of `tumme-thumbnail-storage', the file
 name will vary.  For central thumbnail file storage, make a
 MD5-hash of the image file's directory name and add that to make
 the thumbnail file name unique.  For per-directory storage, just
-add a subdirectory."
+add a subdirectory.  For standard storage, produce the file name
-(let ((f (expand-file-name file))
+according to the Thumbnail Managing Standard."
-md5-hash)
+(cond ((eq 'standard tumme-thumbnail-storage)
-(format "%s%s%s.thumb.%s"
+(expand-file-name
-(cond ((eq 'use-tumme-dir tumme-thumbnail-storage)
+(concat "~/.thumbnails/normal/"
-;; Is MD5 hashes fast enough? The checksum of a
+(md5 (concat "file://" (expand-file-name file))) ".png")))
-;; thumbnail file name need not be that
+((eq 'use-tumme-dir tumme-thumbnail-storage)
-;; "cryptographically" good so a faster one could
+(let* ((f (expand-file-name file))
-;; be used here.
+(md5-hash
-(setq md5-hash (md5 (file-name-as-directory
+;; Is MD5 hashes fast enough? The checksum of a
-(file-name-directory file))))
+;; thumbnail file name need not be that
-(file-name-as-directory (expand-file-name (tumme-dir))))
+;; "cryptographically" good so a faster one could
-((eq 'per-directory tumme-thumbnail-storage)
+;; be used here.
-(format "%s.tumme/"
+(md5 (file-name-as-directory (file-name-directory f)))))
-(file-name-directory f))))
+(format "%s%s%s.thumb.%s"
-(file-name-sans-extension
+(file-name-as-directory (expand-file-name (tumme-dir)))
-(file-name-nondirectory f))
+(file-name-sans-extension (file-name-nondirectory f))
-(if md5-hash
+(if md5-hash (concat "_" md5-hash) "")
-(concat "_" md5-hash)
+(file-name-extension f))))
-"")
+((eq 'per-directory tumme-thumbnail-storage)
-(file-name-extension f))))
+(let ((f (expand-file-name file)))
+(format "%s%s%s.thumb.%s"
+(format "%s.tumme/" (file-name-directory f))
+(file-name-sans-extension (file-name-nondirectory f))
+(file-name-extension f))))))
 (defun tumme-create-thumb (original-file thumbnail-file)
 "For ORIGINAL-FILE, create thumbnail image named THUMBNAIL-FILE."
-(let* ((size (int-to-string tumme-thumb-size))
+(let* ((width (int-to-string tumme-thumb-width))
+(height (int-to-string tumme-thumb-height))
+(modif-time (format "%.0f" (float-time (nth 5 (file-attributes
+original-file)))))
+(thumbnail-nq8-file (replace-regexp-in-string ".png\\'" "-nq8.png"
+thumbnail-file))
 (command
 (format-spec
-tumme-cmd-create-thumbnail-options
+(if (eq 'standard tumme-thumbnail-storage)
+tumme-cmd-create-standard-thumbnail-command
+tumme-cmd-create-thumbnail-options)
 (list
 (cons ?p tumme-cmd-create-thumbnail-program)
-(cons ?s size)
+(cons ?w width)
+(cons ?h height)
+(cons ?m modif-time)
 (cons ?f original-file)
+(cons ?q thumbnail-nq8-file)
 (cons ?t thumbnail-file))))
 thumbnail-dir)
 (when (not (file-exists-p
 (setq thumbnail-dir (file-name-directory thumbnail-file))))
 (message "Creating thumbnail directory.")
 (make-directory thumbnail-dir))
 (shell-command command nil)))
+;;;###autoload
+(defun tumme-dired-insert-marked-thumbs ()
+"Insert thumbnails before file names of marked files in the dired buffer."
+(interactive)
+(dired-map-over-marks
+(let* ((image-pos (dired-move-to-filename))
+(image-file (dired-get-filename))
+(thumb-file (tumme-get-thumbnail-image image-file))
+overlay)
+;; If image is not already added, then add it.
+(unless (delq nil (mapcar (lambda (o) (overlay-get o 'put-image))
+;; Can't use (overlays-at (point)), BUG?
+(overlays-in (point) (1+ (point)))))
+(put-image thumb-file image-pos)
+(setq overlay (car (delq nil (mapcar (lambda (o) (and (overlay-get o 'put-image) o))
+(overlays-in (point) (1+ (point)))))))
+(overlay-put overlay 'image-file image-file)
+(overlay-put overlay 'thumb-file thumb-file)))
+nil)
+(add-hook 'dired-after-readin-hook 'tumme-dired-after-readin-hook nil t))
+(defun tumme-dired-after-readin-hook ()
+"Relocate existing thumbnail overlays in dired buffer after reverting.
+Move them to their corresponding files if they are still exist.
+Otherwise, delete overlays."
+(mapc (lambda (overlay)
+(when (overlay-get overlay 'put-image)
+(let* ((image-file (overlay-get overlay 'image-file))
+(image-pos (dired-goto-file image-file)))
+(if image-pos
+(move-overlay overlay image-pos image-pos)
+(delete-overlay overlay)))))
+(overlays-in (point-min) (point-max))))
 (defun tumme-next-line-and-display ()
 "Move to next dired line and display thumbnail image."
 (interactive)
 (dired-next-line 1)
 (width (tumme-window-width-pixels (tumme-thumbnail-window)))
 (tumme-thumbs-per-row
 (/ width
 (+ (* 2 tumme-thumb-relief)
 (* 2 tumme-thumb-margin)
-tumme-thumb-size char-width))))
+tumme-thumb-width char-width))))
 (tumme-line-up)))
 (defun tumme-line-up-interactive ()
 "Line up thumbnails interactively.
 Ask user how many thumbnails should be displayed per row."
 systems it should feel snappy enough.
 If optional argument ORIGINAL-SIZE is non-nil, display image in its
 original size."
 (let ((new-file (expand-file-name tumme-temp-image-file))
-size-x size-y command ret)
+width height command ret)
 (setq file (expand-file-name file))
 (if (not original-size)
 (progn
-(setq size-x (tumme-display-window-width))
+(setq width (tumme-display-window-width))
-(setq size-y (tumme-display-window-height))
+(setq height (tumme-display-window-height))
 (setq command
 (format-spec
 tumme-cmd-create-temp-image-options
 (list
 (cons ?p tumme-cmd-create-temp-image-program)
-(cons ?x size-x)
+(cons ?w width)
-(cons ?y size-y)
+(cons ?h height)
 (cons ?f file)
 (cons ?t new-file))))
 (setq ret (shell-command command nil))
 (if (not (= 0 ret))
 (error "Could not resize image")))

Mercurial > emacs

comparison lisp/tumme.el @ 68815:3e8cc27a9bcf