* bug#74200: [PATCH] Add song viewer to 'mpc'
@ 2024-11-04 3:26 john muhl
2024-11-04 3:29 ` john muhl
0 siblings, 1 reply; 8+ messages in thread
From: john muhl @ 2024-11-04 3:26 UTC (permalink / raw)
To: 74200; +Cc: monnier
Tags: patch
This adds a mpc-describe-song command which brings up a buffer
full of information about the selected song.
^ permalink raw reply [flat|nested] 8+ messages in thread
* bug#74200: [PATCH] Add song viewer to 'mpc'
2024-11-04 3:26 bug#74200: [PATCH] Add song viewer to 'mpc' john muhl
@ 2024-11-04 3:29 ` john muhl
2024-11-04 12:46 ` Eli Zaretskii
0 siblings, 1 reply; 8+ messages in thread
From: john muhl @ 2024-11-04 3:29 UTC (permalink / raw)
To: 74200; +Cc: monnier
[-- Attachment #1: 0001-Add-song-viewer-to-mpc-Bug-74200.patch --]
[-- Type: text/x-patch, Size: 8664 bytes --]
From 861491d591a4e03bf4d4ceff001fd5036c0afef7 Mon Sep 17 00:00:00 2001
From: john muhl <jm@pub.pink>
Date: Sat, 19 Oct 2024 18:25:41 -0500
Subject: [PATCH] Add song viewer to 'mpc' (Bug#74200)
* lisp/mpc.el (mpc-describe-song): New command.
(mpc-mode-map): Bind "i" to 'mpc-describe-song'.
(mpc-mode-menu): Add menu item.
(mpc-secs-to-time): Ensure secs argument is an integer.
(mpc-song-viewer-empty, mpc-song-viewer-tag):
(mpc-song-viewer-value): New face.
(mpc-song-viewer-tags): New option.
(mpc-song-viewer-tagtypes): New constant.
---
etc/NEWS | 7 ++++
lisp/mpc.el | 106 +++++++++++++++++++++++++++++++++++++++++++++++++++-
2 files changed, 111 insertions(+), 2 deletions(-)
diff --git a/etc/NEWS b/etc/NEWS
index f8e17da0592..e9466f7f9f3 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -619,6 +619,13 @@ When non-nil, MPC will crossfade between songs for the specified number
of seconds. Crossfading can be toggled using the command
'mpc-toggle-crossfade' or from the MPC menu.
+*** New command 'mpc-describe-song'.
+This command displays information about the currently playing song or
+song at point in the MPC-Songs buffer. The list of tags to display can
+be customized using the new user option 'mpc-song-viewer-tags' and the
+appearance of the list with the new faces 'mpc-song-viewer-tag',
+'mpc-song-viewer-value', and 'mpc-song-viewer-empty'.
+
** VC
---
diff --git a/lisp/mpc.el b/lisp/mpc.el
index 0a43b09c11d..7b3737aa57f 100644
--- a/lisp/mpc.el
+++ b/lisp/mpc.el
@@ -63,7 +63,7 @@
;; e.g. filename regexp -> compilation flag
;; - window/buffer management.
;; - menubar, tooltips, ...
-;; - add mpc-describe-song, mpc-describe-album, ...
+;; - add mpc-describe-album, ...
;; - add import/export commands (especially export to an MP3 player).
;; - add a real notion of album (as opposed to just album-name):
;; if all songs with same album-name have same artist -> it's an album
@@ -95,6 +95,8 @@
(require 'notifications)
+(require 'vtable)
+
(defgroup mpc ()
"Client for the Music Player Daemon (mpd)."
:prefix "mpc-"
@@ -978,11 +980,15 @@ mpc-cover-image-re
:version "28.1")
(defun mpc-secs-to-time (secs)
+ "Convert SECS from a string, integer or float value to a time string."
;; We could use `format-seconds', but it doesn't seem worth the trouble
;; because we'd still need to check (>= secs (* 60 100)) since the special
;; %z only allows us to drop the large units for small values but
;; not to drop the small units for large values.
(if (stringp secs) (setq secs (string-to-number secs)))
+ ;; Ensure secs is an integer. The Time tag has been deprecated by MPD
+ ;; and its replacement (the duration tag) includes fractional seconds.
+ (if (floatp secs) (setq secs (round secs)))
(if (>= secs (* 60 100)) ;More than 100 minutes.
(format "%dh%02d" ;"%d:%02d:%02d"
(/ secs 3600) (% (/ secs 60) 60)) ;; (% secs 60)
@@ -1180,7 +1186,8 @@ mpc-mode-map
">" #'mpc-next
"<" #'mpc-prev
"g" #'mpc-seek-current
- "o" #'mpc-goto-playing-song)
+ "o" #'mpc-goto-playing-song
+ "i" #'mpc-describe-song)
(easy-menu-define mpc-mode-menu mpc-mode-map
"Menu for MPC mode."
@@ -1189,6 +1196,7 @@ mpc-mode-menu
["Next Track" mpc-next] ;FIXME: Add ⇥ there?
["Previous Track" mpc-prev] ;FIXME: Add ⇤ there?
["Seek Within Track" mpc-seek-current]
+ ["Song Details" mpc-describe-song]
"--"
["Repeat Playlist" mpc-toggle-repeat :style toggle
:selected (member '(repeat . "1") mpc-status)]
@@ -2862,6 +2870,100 @@ mpc-notifications-notify
:app-icon icon
:replaces-id mpc--notifications-id))))
+;;; Song Viewer ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+
+(defface mpc-song-viewer-value
+ '((t (:inherit vtable)))
+ "Face for tag values in the MPC song viewer.")
+
+(defface mpc-song-viewer-tag
+ '((t (:inherit (mpc-song-viewer-value bold))))
+ "Face for tag types in the MPC song viewer.")
+
+(defface mpc-song-viewer-empty
+ '((t (:inherit (mpc-song-viewer-value italic shadow))))
+ "Face for empty tag values in the MPC song viewer.")
+
+(defconst mpc-song-viewer-tagtypes
+ (sort (append '("Bitrate" "Duration" "File" "Format") (mpc-cmd-tagtypes)))
+ "Tag types available for use in `mpc-song-viewer-tags'.")
+
+(defcustom mpc-song-viewer-tags
+ '("Title" "Artist" "Album" "Performer" "Composer"
+ "Date" "Duration" "Disc" "Track" "Genre" "File")
+ "The list of tags to display with `mpc-describe-song'.
+
+See `mpc-song-viewer-tagtypes' for a list of available tags."
+ :version "31.1"
+ :type '(repeat string))
+
+(defun mpc-describe-song (&optional file)
+ "Show details of the selected song or FILE in the MPC song viewer.
+
+If there is no song at point then information about the currently
+playing song is displayed."
+ (interactive
+ ;; Handle being called from the context menu. In that case you want
+ ;; to see details for the song you clicked on to invoke the menu not
+ ;; whatever `point' happens to be on at that time.
+ (list (when-let* ((event last-nonmenu-event)
+ ((listp event))
+ (position (nth 1 (event-start event))))
+ (get-text-property position 'mpc-file))))
+ (let ((tags (or (when (and file (stringp file))
+ (mpc-proc-cmd-to-alist (list "search" "file" file)))
+ (when-let* (((string= (buffer-name) "*MPC-Songs*"))
+ (file (get-text-property (point) 'mpc-file)))
+ (mpc-proc-cmd-to-alist (list "search" "file" file)))
+ (when (assoc 'file mpc-status) mpc-status)))
+ (buffer "*MPC Song Viewer*"))
+ (when tags
+ (with-current-buffer (get-buffer-create buffer)
+ (special-mode)
+ (visual-line-mode)
+ (let ((buffer-read-only nil))
+ (erase-buffer)
+ (make-vtable
+ :columns '(( :name "Tag"
+ :align right
+ :min-width 3
+ :displayer
+ (lambda (tag &rest _)
+ (propertize tag 'face 'mpc-song-viewer-tag)))
+ ( :name "Value"
+ :align left
+ :min-width 5
+ :displayer
+ (lambda (value &rest _)
+ (if (and value (not (string-blank-p value)))
+ (propertize value 'face 'mpc-song-viewer-value)
+ (propertize "empty" 'face 'mpc-song-viewer-empty)))))
+ :objects (mapcar
+ (lambda (tag)
+ (pcase tag
+ ("Bitrate"
+ (list tag (let ((bitrate (alist-get 'bitrate tags)))
+ (when bitrate
+ (format "%s kpbs" bitrate)))))
+ ("Duration" (list tag (mpc-secs-to-time
+ (alist-get 'duration tags))))
+ ("File" (list tag (alist-get 'file tags)))
+ ;; Concatenate all the values of tags which may
+ ;; occur multiple times.
+ ((or "Composer" "Genre" "Performer")
+ (list tag (mapconcat
+ (lambda (val) (cdr val))
+ (seq-filter
+ (lambda (val) (eq (car val) (intern tag)))
+ tags)
+ "; ")))
+ (_ (list tag (alist-get (intern tag) tags)))))
+ mpc-song-viewer-tags))
+ (goto-char (point-min))))
+ (select-window (display-buffer buffer '((display-buffer-reuse-window
+ display-buffer-same-window)
+ (reusable-frames . t)))))))
+
;;; Toplevel ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defcustom mpc-frame-alist '((name . "MPC") (tool-bar-lines . 1)
--
2.46.2
[-- Attachment #2: Type: text/plain, Size: 163 bytes --]
john muhl <jm@pub.pink> writes:
> Tags: patch
>
> This adds a mpc-describe-song command which brings up a buffer
> full of information about the selected song.
^ permalink raw reply related [flat|nested] 8+ messages in thread
* bug#74200: [PATCH] Add song viewer to 'mpc'
2024-11-04 3:29 ` john muhl
@ 2024-11-04 12:46 ` Eli Zaretskii
2024-11-04 13:25 ` john muhl
0 siblings, 1 reply; 8+ messages in thread
From: Eli Zaretskii @ 2024-11-04 12:46 UTC (permalink / raw)
To: john muhl; +Cc: monnier, 74200
> Cc: monnier@iro.umontreal.ca
> From: john muhl <jm@pub.pink>
> Date: Sun, 03 Nov 2024 21:29:53 -0600
>
> >From 861491d591a4e03bf4d4ceff001fd5036c0afef7 Mon Sep 17 00:00:00 2001
> From: john muhl <jm@pub.pink>
> Date: Sat, 19 Oct 2024 18:25:41 -0500
> Subject: [PATCH] Add song viewer to 'mpc' (Bug#74200)
>
> * lisp/mpc.el (mpc-describe-song): New command.
> (mpc-mode-map): Bind "i" to 'mpc-describe-song'.
> (mpc-mode-menu): Add menu item.
> (mpc-secs-to-time): Ensure secs argument is an integer.
> (mpc-song-viewer-empty, mpc-song-viewer-tag):
> (mpc-song-viewer-value): New face.
> (mpc-song-viewer-tags): New option.
> (mpc-song-viewer-tagtypes): New constant.
> ---
> etc/NEWS | 7 ++++
> lisp/mpc.el | 106 +++++++++++++++++++++++++++++++++++++++++++++++++++-
> 2 files changed, 111 insertions(+), 2 deletions(-)
Thanks, a few minor comments.
> --- a/etc/NEWS
> +++ b/etc/NEWS
> @@ -619,6 +619,13 @@ When non-nil, MPC will crossfade between songs for the specified number
> of seconds. Crossfading can be toggled using the command
> 'mpc-toggle-crossfade' or from the MPC menu.
>
> +*** New command 'mpc-describe-song'.
> +This command displays information about the currently playing song or
> +song at point in the MPC-Songs buffer. The list of tags to display can
> +be customized using the new user option 'mpc-song-viewer-tags' and the
> +appearance of the list with the new faces 'mpc-song-viewer-tag',
> +'mpc-song-viewer-value', and 'mpc-song-viewer-empty'.
This entry should be marked with "---", as we don't intend to document
this in any manual.
> +(defcustom mpc-song-viewer-tags
> + '("Title" "Artist" "Album" "Performer" "Composer"
> + "Date" "Duration" "Disc" "Track" "Genre" "File")
> + "The list of tags to display with `mpc-describe-song'.
Each new defcustom should have a :version tag.
^ permalink raw reply [flat|nested] 8+ messages in thread
* bug#74200: [PATCH] Add song viewer to 'mpc'
2024-11-04 12:46 ` Eli Zaretskii
@ 2024-11-04 13:25 ` john muhl
2024-11-08 19:20 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
0 siblings, 1 reply; 8+ messages in thread
From: john muhl @ 2024-11-04 13:25 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: monnier, 74200
[-- Attachment #1: Type: text/plain, Size: 1230 bytes --]
Eli Zaretskii <eliz@gnu.org> writes:
>> --- a/etc/NEWS
>> +++ b/etc/NEWS
>> @@ -619,6 +619,13 @@ When non-nil, MPC will crossfade between songs
>> for the specified number
>> of seconds. Crossfading can be toggled using the command
>> 'mpc-toggle-crossfade' or from the MPC menu.
>>
>> +*** New command 'mpc-describe-song'.
>> +This command displays information about the currently playing song or
>> +song at point in the MPC-Songs buffer. The list of tags to display can
>> +be customized using the new user option 'mpc-song-viewer-tags' and the
>> +appearance of the list with the new faces 'mpc-song-viewer-tag',
>> +'mpc-song-viewer-value', and 'mpc-song-viewer-empty'.
>
> This entry should be marked with "---", as we don't intend to document
> this in any manual.
Fixed. Added one to previous entry too which slipped through
unnoticed.
>> +(defcustom mpc-song-viewer-tags
>> + '("Title" "Artist" "Album" "Performer" "Composer"
>> + "Date" "Duration" "Disc" "Track" "Genre" "File")
>> + "The list of tags to display with `mpc-describe-song'.
>
> Each new defcustom should have a :version tag.
Hmm. Not sure how that got lost in transmission but hopefully it
makes it through this time.
Thanks for looking.
[-- Attachment #2: 0001-Add-song-viewer-to-mpc-Bug-74200.patch --]
[-- Type: text/x-patch, Size: 8877 bytes --]
From 38add009b751900332f4ba9006ef62dcae472e69 Mon Sep 17 00:00:00 2001
From: john muhl <jm@pub.pink>
Date: Sat, 19 Oct 2024 18:25:41 -0500
Subject: [PATCH] Add song viewer to 'mpc' (Bug#74200)
* lisp/mpc.el (mpc-describe-song): New command.
(mpc-mode-map): Bind "i" to 'mpc-describe-song'.
(mpc-mode-menu): Add menu item.
(mpc-secs-to-time): Ensure secs argument is an integer.
(mpc-song-viewer-empty, mpc-song-viewer-tag):
(mpc-song-viewer-value): New face.
(mpc-song-viewer-tags): New option.
(mpc-song-viewer-tagtypes): New constant.
---
etc/NEWS | 9 +++++
lisp/mpc.el | 106 +++++++++++++++++++++++++++++++++++++++++++++++++++-
2 files changed, 113 insertions(+), 2 deletions(-)
diff --git a/etc/NEWS b/etc/NEWS
index f8e17da0592..852006e3dde 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -614,11 +614,20 @@ a desktop notification when the song changes, using
customized using the new user options 'mpc-notifications-title' and
'mpc-notifications-body'.
+---
*** New user option 'mpc-crossfade-time'.
When non-nil, MPC will crossfade between songs for the specified number
of seconds. Crossfading can be toggled using the command
'mpc-toggle-crossfade' or from the MPC menu.
+---
+*** New command 'mpc-describe-song'.
+This command displays information about the currently playing song or
+song at point in the MPC-Songs buffer. The list of tags to display can
+be customized using the new user option 'mpc-song-viewer-tags' and the
+appearance of the list with the new faces 'mpc-song-viewer-tag',
+'mpc-song-viewer-value', and 'mpc-song-viewer-empty'.
+
** VC
---
diff --git a/lisp/mpc.el b/lisp/mpc.el
index 0a43b09c11d..7b3737aa57f 100644
--- a/lisp/mpc.el
+++ b/lisp/mpc.el
@@ -63,7 +63,7 @@
;; e.g. filename regexp -> compilation flag
;; - window/buffer management.
;; - menubar, tooltips, ...
-;; - add mpc-describe-song, mpc-describe-album, ...
+;; - add mpc-describe-album, ...
;; - add import/export commands (especially export to an MP3 player).
;; - add a real notion of album (as opposed to just album-name):
;; if all songs with same album-name have same artist -> it's an album
@@ -95,6 +95,8 @@
(require 'notifications)
+(require 'vtable)
+
(defgroup mpc ()
"Client for the Music Player Daemon (mpd)."
:prefix "mpc-"
@@ -978,11 +980,15 @@ mpc-cover-image-re
:version "28.1")
(defun mpc-secs-to-time (secs)
+ "Convert SECS from a string, integer or float value to a time string."
;; We could use `format-seconds', but it doesn't seem worth the trouble
;; because we'd still need to check (>= secs (* 60 100)) since the special
;; %z only allows us to drop the large units for small values but
;; not to drop the small units for large values.
(if (stringp secs) (setq secs (string-to-number secs)))
+ ;; Ensure secs is an integer. The Time tag has been deprecated by MPD
+ ;; and its replacement (the duration tag) includes fractional seconds.
+ (if (floatp secs) (setq secs (round secs)))
(if (>= secs (* 60 100)) ;More than 100 minutes.
(format "%dh%02d" ;"%d:%02d:%02d"
(/ secs 3600) (% (/ secs 60) 60)) ;; (% secs 60)
@@ -1180,7 +1186,8 @@ mpc-mode-map
">" #'mpc-next
"<" #'mpc-prev
"g" #'mpc-seek-current
- "o" #'mpc-goto-playing-song)
+ "o" #'mpc-goto-playing-song
+ "i" #'mpc-describe-song)
(easy-menu-define mpc-mode-menu mpc-mode-map
"Menu for MPC mode."
@@ -1189,6 +1196,7 @@ mpc-mode-menu
["Next Track" mpc-next] ;FIXME: Add ⇥ there?
["Previous Track" mpc-prev] ;FIXME: Add ⇤ there?
["Seek Within Track" mpc-seek-current]
+ ["Song Details" mpc-describe-song]
"--"
["Repeat Playlist" mpc-toggle-repeat :style toggle
:selected (member '(repeat . "1") mpc-status)]
@@ -2862,6 +2870,100 @@ mpc-notifications-notify
:app-icon icon
:replaces-id mpc--notifications-id))))
+;;; Song Viewer ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+
+(defface mpc-song-viewer-value
+ '((t (:inherit vtable)))
+ "Face for tag values in the MPC song viewer.")
+
+(defface mpc-song-viewer-tag
+ '((t (:inherit (mpc-song-viewer-value bold))))
+ "Face for tag types in the MPC song viewer.")
+
+(defface mpc-song-viewer-empty
+ '((t (:inherit (mpc-song-viewer-value italic shadow))))
+ "Face for empty tag values in the MPC song viewer.")
+
+(defconst mpc-song-viewer-tagtypes
+ (sort (append '("Bitrate" "Duration" "File" "Format") (mpc-cmd-tagtypes)))
+ "Tag types available for use in `mpc-song-viewer-tags'.")
+
+(defcustom mpc-song-viewer-tags
+ '("Title" "Artist" "Album" "Performer" "Composer"
+ "Date" "Duration" "Disc" "Track" "Genre" "File")
+ "The list of tags to display with `mpc-describe-song'.
+
+See `mpc-song-viewer-tagtypes' for a list of available tags."
+ :version "31.1"
+ :type '(repeat string))
+
+(defun mpc-describe-song (&optional file)
+ "Show details of the selected song or FILE in the MPC song viewer.
+
+If there is no song at point then information about the currently
+playing song is displayed."
+ (interactive
+ ;; Handle being called from the context menu. In that case you want
+ ;; to see details for the song you clicked on to invoke the menu not
+ ;; whatever `point' happens to be on at that time.
+ (list (when-let* ((event last-nonmenu-event)
+ ((listp event))
+ (position (nth 1 (event-start event))))
+ (get-text-property position 'mpc-file))))
+ (let ((tags (or (when (and file (stringp file))
+ (mpc-proc-cmd-to-alist (list "search" "file" file)))
+ (when-let* (((string= (buffer-name) "*MPC-Songs*"))
+ (file (get-text-property (point) 'mpc-file)))
+ (mpc-proc-cmd-to-alist (list "search" "file" file)))
+ (when (assoc 'file mpc-status) mpc-status)))
+ (buffer "*MPC Song Viewer*"))
+ (when tags
+ (with-current-buffer (get-buffer-create buffer)
+ (special-mode)
+ (visual-line-mode)
+ (let ((buffer-read-only nil))
+ (erase-buffer)
+ (make-vtable
+ :columns '(( :name "Tag"
+ :align right
+ :min-width 3
+ :displayer
+ (lambda (tag &rest _)
+ (propertize tag 'face 'mpc-song-viewer-tag)))
+ ( :name "Value"
+ :align left
+ :min-width 5
+ :displayer
+ (lambda (value &rest _)
+ (if (and value (not (string-blank-p value)))
+ (propertize value 'face 'mpc-song-viewer-value)
+ (propertize "empty" 'face 'mpc-song-viewer-empty)))))
+ :objects (mapcar
+ (lambda (tag)
+ (pcase tag
+ ("Bitrate"
+ (list tag (let ((bitrate (alist-get 'bitrate tags)))
+ (when bitrate
+ (format "%s kpbs" bitrate)))))
+ ("Duration" (list tag (mpc-secs-to-time
+ (alist-get 'duration tags))))
+ ("File" (list tag (alist-get 'file tags)))
+ ;; Concatenate all the values of tags which may
+ ;; occur multiple times.
+ ((or "Composer" "Genre" "Performer")
+ (list tag (mapconcat
+ (lambda (val) (cdr val))
+ (seq-filter
+ (lambda (val) (eq (car val) (intern tag)))
+ tags)
+ "; ")))
+ (_ (list tag (alist-get (intern tag) tags)))))
+ mpc-song-viewer-tags))
+ (goto-char (point-min))))
+ (select-window (display-buffer buffer '((display-buffer-reuse-window
+ display-buffer-same-window)
+ (reusable-frames . t)))))))
+
;;; Toplevel ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defcustom mpc-frame-alist '((name . "MPC") (tool-bar-lines . 1)
--
2.46.2
^ permalink raw reply related [flat|nested] 8+ messages in thread
* bug#74200: [PATCH] Add song viewer to 'mpc'
2024-11-04 13:25 ` john muhl
@ 2024-11-08 19:20 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-11-13 1:01 ` john muhl
0 siblings, 1 reply; 8+ messages in thread
From: Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2024-11-08 19:20 UTC (permalink / raw)
To: john muhl; +Cc: Eli Zaretskii, 74200
> + "i" #'mpc-describe-song)
What about using "d" (i.e. the "describe" mnemonic instead of the "info"
mnemonic)?
> +(defconst mpc-song-viewer-tagtypes
> + (sort (append '("Bitrate" "Duration" "File" "Format") (mpc-cmd-tagtypes)))
> + "Tag types available for use in `mpc-song-viewer-tags'.")
Hmm... running `mpc-cmd-tagtypes` when we load the file seems risky: we
may not know the `mpc-host` yet, or any other thing may go wrong.
> +(defun mpc-describe-song (&optional file)
Any reason we can't make the argument mandatory?
> + (when tags
> + (with-current-buffer (get-buffer-create buffer)
> + (special-mode)
> + (visual-line-mode)
> + (let ((buffer-read-only nil))
This should bind `inhibit-read-only` instead.
> + (select-window (display-buffer buffer '((display-buffer-reuse-window
> + display-buffer-same-window)
> + (reusable-frames . t)))))))
Why use `select-window + display-buffer` instead of `pop-to-buffer`?
Stefan
^ permalink raw reply [flat|nested] 8+ messages in thread
* bug#74200: [PATCH] Add song viewer to 'mpc'
2024-11-08 19:20 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2024-11-13 1:01 ` john muhl
2024-11-14 15:45 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
0 siblings, 1 reply; 8+ messages in thread
From: john muhl @ 2024-11-13 1:01 UTC (permalink / raw)
To: Stefan Monnier; +Cc: Eli Zaretskii, 74200
[-- Attachment #1: Type: text/plain, Size: 1409 bytes --]
Stefan Monnier <monnier@iro.umontreal.ca> writes:
>> + "i" #'mpc-describe-song)
>
> What about using "d" (i.e. the "describe" mnemonic instead of the "info"
> mnemonic)?
Done.
>> +(defconst mpc-song-viewer-tagtypes
>> + (sort (append '("Bitrate" "Duration" "File" "Format") (mpc-cmd-tagtypes)))
>> + "Tag types available for use in `mpc-song-viewer-tags'.")
>
> Hmm... running `mpc-cmd-tagtypes` when we load the file seems risky: we
> may not know the `mpc-host` yet, or any other thing may go wrong.
Right you are. The tags are always the same anyway so I put a note
in the docstring and got rid of the risky constant.
>> +(defun mpc-describe-song (&optional file)
>
> Any reason we can't make the argument mandatory?
Nope.
>> + (when tags
>> + (with-current-buffer (get-buffer-create buffer)
>> + (special-mode)
>> + (visual-line-mode)
>> + (let ((buffer-read-only nil))
>
> This should bind `inhibit-read-only` instead.
Fixed.
>> + (select-window (display-buffer buffer '((display-buffer-reuse-window
>> + display-buffer-same-window)
>> + (reusable-frames . t)))))))
>
> Why use `select-window + display-buffer` instead of `pop-to-buffer`?
Elsewhere I was told not to use pop-to-buffer in new code and I
believe everything anyone tells me.
[-- Attachment #2: 0001-Add-song-viewer-to-mpc-Bug-74200.patch --]
[-- Type: text/x-patch, Size: 8705 bytes --]
From 28a1710f4f40b9de88719ea6ffa1893913195e11 Mon Sep 17 00:00:00 2001
From: john muhl <jm@pub.pink>
Date: Sat, 19 Oct 2024 18:25:41 -0500
Subject: [PATCH] Add song viewer to 'mpc' (Bug#74200)
* lisp/mpc.el (mpc-describe-song): New command.
(mpc-mode-map): Bind "d" to 'mpc-describe-song'.
(mpc-mode-menu): Add menu item.
(mpc-secs-to-time): Ensure secs argument is an integer.
(mpc-song-viewer-empty, mpc-song-viewer-tag):
(mpc-song-viewer-value): New face.
(mpc-song-viewer-tags): New option.
---
etc/NEWS | 9 +++++
lisp/mpc.el | 104 +++++++++++++++++++++++++++++++++++++++++++++++++++-
2 files changed, 111 insertions(+), 2 deletions(-)
diff --git a/etc/NEWS b/etc/NEWS
index 0a08527b2e5..9beec8d1770 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -654,11 +654,20 @@ a desktop notification when the song changes, using
customized using the new user options 'mpc-notifications-title' and
'mpc-notifications-body'.
+---
*** New user option 'mpc-crossfade-time'.
When non-nil, MPC will crossfade between songs for the specified number
of seconds. Crossfading can be toggled using the command
'mpc-toggle-crossfade' or from the MPC menu.
+---
+*** New command 'mpc-describe-song'.
+This command displays information about the currently playing song or
+song at point in the MPC-Songs buffer. The list of tags to display can
+be customized using the new user option 'mpc-song-viewer-tags' and the
+appearance of the list with the new faces 'mpc-song-viewer-tag',
+'mpc-song-viewer-value', and 'mpc-song-viewer-empty'.
+
** VC
---
diff --git a/lisp/mpc.el b/lisp/mpc.el
index 0a43b09c11d..a0ecb21e454 100644
--- a/lisp/mpc.el
+++ b/lisp/mpc.el
@@ -63,7 +63,7 @@
;; e.g. filename regexp -> compilation flag
;; - window/buffer management.
;; - menubar, tooltips, ...
-;; - add mpc-describe-song, mpc-describe-album, ...
+;; - add mpc-describe-album, ...
;; - add import/export commands (especially export to an MP3 player).
;; - add a real notion of album (as opposed to just album-name):
;; if all songs with same album-name have same artist -> it's an album
@@ -95,6 +95,8 @@
(require 'notifications)
+(require 'vtable)
+
(defgroup mpc ()
"Client for the Music Player Daemon (mpd)."
:prefix "mpc-"
@@ -978,11 +980,15 @@ mpc-cover-image-re
:version "28.1")
(defun mpc-secs-to-time (secs)
+ "Convert SECS from a string, integer or float value to a time string."
;; We could use `format-seconds', but it doesn't seem worth the trouble
;; because we'd still need to check (>= secs (* 60 100)) since the special
;; %z only allows us to drop the large units for small values but
;; not to drop the small units for large values.
(if (stringp secs) (setq secs (string-to-number secs)))
+ ;; Ensure secs is an integer. The Time tag has been deprecated by MPD
+ ;; and its replacement (the duration tag) includes fractional seconds.
+ (if (floatp secs) (setq secs (round secs)))
(if (>= secs (* 60 100)) ;More than 100 minutes.
(format "%dh%02d" ;"%d:%02d:%02d"
(/ secs 3600) (% (/ secs 60) 60)) ;; (% secs 60)
@@ -1180,7 +1186,8 @@ mpc-mode-map
">" #'mpc-next
"<" #'mpc-prev
"g" #'mpc-seek-current
- "o" #'mpc-goto-playing-song)
+ "o" #'mpc-goto-playing-song
+ "d" #'mpc-describe-song)
(easy-menu-define mpc-mode-menu mpc-mode-map
"Menu for MPC mode."
@@ -1189,6 +1196,7 @@ mpc-mode-menu
["Next Track" mpc-next] ;FIXME: Add ⇥ there?
["Previous Track" mpc-prev] ;FIXME: Add ⇤ there?
["Seek Within Track" mpc-seek-current]
+ ["Song Details" mpc-describe-song]
"--"
["Repeat Playlist" mpc-toggle-repeat :style toggle
:selected (member '(repeat . "1") mpc-status)]
@@ -2862,6 +2870,98 @@ mpc-notifications-notify
:app-icon icon
:replaces-id mpc--notifications-id))))
+;;; Song Viewer ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+
+(defface mpc-song-viewer-value
+ '((t (:inherit vtable)))
+ "Face for tag values in the MPC song viewer.")
+
+(defface mpc-song-viewer-tag
+ '((t (:inherit (mpc-song-viewer-value bold))))
+ "Face for tag types in the MPC song viewer.")
+
+(defface mpc-song-viewer-empty
+ '((t (:inherit (mpc-song-viewer-value italic shadow))))
+ "Face for empty tag values in the MPC song viewer.")
+
+(defcustom mpc-song-viewer-tags
+ '("Title" "Artist" "Album" "Performer" "Composer"
+ "Date" "Duration" "Disc" "Track" "Genre" "File")
+ "The list of tags to display with `mpc-describe-song'.
+
+The list of supported tags are available by evaluating
+`mpc-cmd-tagtypes'. In addition to the standard MPD tags: Bitrate,
+Duration, File, and Format are also supported."
+ :version "31.1"
+ :type '(repeat string))
+
+(defun mpc-describe-song (file)
+ "Show details of the selected song or FILE in the MPC song viewer.
+
+If there is no song at point then information about the currently
+playing song is displayed."
+ (interactive
+ ;; Handle being called from the context menu. In that case you want
+ ;; to see details for the song you clicked on to invoke the menu not
+ ;; whatever `point' happens to be on at that time.
+ (list (when-let* ((event last-nonmenu-event)
+ ((listp event))
+ (position (nth 1 (event-start event))))
+ (get-text-property position 'mpc-file))))
+ (let ((tags (or (when (and file (stringp file))
+ (mpc-proc-cmd-to-alist (list "search" "file" file)))
+ (when-let* (((string= (buffer-name) "*MPC-Songs*"))
+ (file (get-text-property (point) 'mpc-file)))
+ (mpc-proc-cmd-to-alist (list "search" "file" file)))
+ (when (assoc 'file mpc-status) mpc-status)))
+ (buffer "*MPC Song Viewer*"))
+ (when tags
+ (with-current-buffer (get-buffer-create buffer)
+ (special-mode)
+ (visual-line-mode)
+ (let ((inhibit-read-only t))
+ (erase-buffer)
+ (make-vtable
+ :columns '(( :name "Tag"
+ :align right
+ :min-width 3
+ :displayer
+ (lambda (tag &rest _)
+ (propertize tag 'face 'mpc-song-viewer-tag)))
+ ( :name "Value"
+ :align left
+ :min-width 5
+ :displayer
+ (lambda (value &rest _)
+ (if (and value (not (string-blank-p value)))
+ (propertize value 'face 'mpc-song-viewer-value)
+ (propertize "empty" 'face 'mpc-song-viewer-empty)))))
+ :objects (mapcar
+ (lambda (tag)
+ (pcase tag
+ ("Bitrate"
+ (list tag (let ((bitrate (alist-get 'bitrate tags)))
+ (when bitrate
+ (format "%s kpbs" bitrate)))))
+ ("Duration" (list tag (mpc-secs-to-time
+ (alist-get 'duration tags))))
+ ("File" (list tag (alist-get 'file tags)))
+ ;; Concatenate all the values of tags which may
+ ;; occur multiple times.
+ ((or "Composer" "Genre" "Performer")
+ (list tag (mapconcat
+ (lambda (val) (cdr val))
+ (seq-filter
+ (lambda (val) (eq (car val) (intern tag)))
+ tags)
+ "; ")))
+ (_ (list tag (alist-get (intern tag) tags)))))
+ mpc-song-viewer-tags))
+ (goto-char (point-min))))
+ (pop-to-buffer buffer '((display-buffer-reuse-window
+ display-buffer-same-window)
+ (reusable-frames . t))))))
+
;;; Toplevel ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defcustom mpc-frame-alist '((name . "MPC") (tool-bar-lines . 1)
--
2.47.0
^ permalink raw reply related [flat|nested] 8+ messages in thread
* bug#74200: [PATCH] Add song viewer to 'mpc'
2024-11-13 1:01 ` john muhl
@ 2024-11-14 15:45 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-11-14 17:08 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
0 siblings, 1 reply; 8+ messages in thread
From: Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2024-11-14 15:45 UTC (permalink / raw)
To: john muhl; +Cc: Eli Zaretskii, 74200
>>> + (select-window (display-buffer buffer '((display-buffer-reuse-window
>>> + display-buffer-same-window)
>>> + (reusable-frames . t)))))))
>>
>> Why use `select-window + display-buffer` instead of `pop-to-buffer`?
>
> Elsewhere I was told not to use pop-to-buffer in new code and I
> believe everything anyone tells me.
Really? AFAIK the one function in that family that's shunned is
`switch-to-buffer` (because its intention is unclear: sometimes it
means "change the content of this window (to that buffer)" and sometimes
it means "display this buffer (in the selected window)"),
Anyway, thanks, installed into `master`.
Stefan
^ permalink raw reply [flat|nested] 8+ messages in thread
* bug#74200: [PATCH] Add song viewer to 'mpc'
2024-11-14 15:45 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2024-11-14 17:08 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
0 siblings, 0 replies; 8+ messages in thread
From: Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2024-11-14 17:08 UTC (permalink / raw)
To: 74200-done
> Anyway, thanks, installed into `master`.
Closing,
Stefan
^ permalink raw reply [flat|nested] 8+ messages in thread
end of thread, other threads:[~2024-11-14 17:08 UTC | newest]
Thread overview: 8+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-11-04 3:26 bug#74200: [PATCH] Add song viewer to 'mpc' john muhl
2024-11-04 3:29 ` john muhl
2024-11-04 12:46 ` Eli Zaretskii
2024-11-04 13:25 ` john muhl
2024-11-08 19:20 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-11-13 1:01 ` john muhl
2024-11-14 15:45 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-11-14 17:08 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.