Specify a parent customization group

pipewire-0-pkg.el

@@ -0,0 +1,2 @@
+(define-package pipewire-0 "1"
+  "Interface to PipeWire.")

pw-access.el

@@ -17,6 +17,8 @@
 ;; You should have received a copy of the GNU General Public License
 ;; along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+;;; Commentary:
+;;
 ;; A generic interface for communication with PipeWire (https://pipewire.org).
 ;; It abstracts communication with PipeWire to be backend independent.
 ;; Only functions from this module may communicate with PipeWire.
@@ -40,9 +42,9 @@ All PipeWire interfaces should derive from this class.")
 (cl-defgeneric pw-access-objects (class)
   "Return all the objects currently reported by PipeWire.
 It is a list of object data.  Each of the elements has a form
-(OBJECT-ID . INFO) where OBJECT-ID is a numeric OBJECT-ID as
+\(OBJECT-ID . INFO) where OBJECT-ID is a numeric OBJECT-ID as
 reported by PipeWire and INFO is an association list of items
-(NAME . VALUE) where NAME is a string item name as reported by
+\(NAME . VALUE) where NAME is a string item name as reported by
 PipeWire and VALUE is the corresponding value.  VALUE is a number for
 object ids, a string otherwise.
 A special entry with `type' symbol as its name contains the PipeWire
@@ -56,7 +58,7 @@ are not supported in this method).
 Object properties may be, unlike object info items, settable.
 
 An assocation list is returned.  Each list element is of the form
-(PROPERTY . VALUE) where PROPERTY is a string name of the given
+\(PROPERTY . VALUE) where PROPERTY is a string name of the given
 property.  VALUE can be:
 
 - \"true\" or \"false\" for boolean values (t and nil are not used to
@@ -79,7 +81,7 @@ DEVICE-ID is a numeric PipeWire Device id (other kinds of PipeWire
 objects are not supported in this method).
 
 The profile is an association list with elements of the form
-(PROPERTY . VALUE), in the same format as properties in
+\(PROPERTY . VALUE), in the same format as properties in
 `pw-access-properties'.")
 
 (cl-defgeneric pw-access-profiles (class device-id)
@@ -100,7 +102,7 @@ from PipeWire.")
 (cl-defgeneric pw-access-defaults (class)
   "Return default sinks and sources.
 An association lists is returned.  Each list element is of the form
-(KEY . NAME) where KEY is a string identifying the given kind of
+\(KEY . NAME) where KEY is a string identifying the given kind of
 default sink or source as reported by PipeWire and NAME is a string
 name of the node assigned to the default.")
 

pw-lib.el

@@ -17,6 +17,8 @@
 ;; You should have received a copy of the GNU General Public License
 ;; along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+;;; Commentary:
+;;
 ;; Backend-independent library to access PipeWire functionality.
 ;; It abstracts data returned from `pw-access' methods and provides
 ;; functions to work with them.
@@ -53,7 +55,7 @@ version, call `pw-lib-refresh' first."
   (let ((objects pw-lib--objects))
     (when type
       (setq objects (cl-remove-if-not
-                     #'(lambda (o) (string= (cdr (assq 'type (cdr o))) type))
+                     (lambda (o) (string= (cdr (assq 'type (cdr o))) type))
                      objects)))
     objects))
 
@@ -146,13 +148,13 @@ Note that PipeWire data is cached, if you need its up-to-date
 version, call `pw-lib-refresh' first."
   (unless pw-lib--defaults
     (let ((defaults (pw-access-defaults pw-lib--accessor))
-          (nodes (mapcar #'(lambda (o)
-                             (cons (pw-lib-object-value o "node.name") (pw-lib-object-id o)))
+          (nodes (mapcar (lambda (o)
+                           (cons (pw-lib-object-value o "node.name") (pw-lib-object-id o)))
                          (pw-lib-objects "Node"))))
       (setq pw-lib--defaults
             (cl-remove-if-not #'cdr
-                              (mapcar #'(lambda (d)
-                                          (cons (car d) (cdr (assoc (cdr d) nodes))))
+                              (mapcar (lambda (d)
+                                        (cons (car d) (cdr (assoc (cdr d) nodes))))
                                       defaults)))))
   pw-lib--defaults)
 
@@ -168,12 +170,12 @@ version, call `pw-lib-refresh' first."
   (or pw-lib--bindings
       (setq pw-lib--bindings
             (apply #'nconc
-                   (mapcar #'(lambda (o)
-                               (let ((o-id (pw-lib-object-id o)))
-                                 (mapcar #'(lambda (p)
-                                             (cons o-id (cdr p)))
-                                         (cl-remove-if-not #'numberp (pw-lib--object-info o)
-                                                           :key #'cdr))))
+                   (mapcar (lambda (o)
+                             (let ((o-id (pw-lib-object-id o)))
+                               (mapcar (lambda (p)
+                                         (cons o-id (cdr p)))
+                                       (cl-remove-if-not #'numberp (pw-lib--object-info o)
+                                                         :key #'cdr))))
                            (pw-lib-objects))))))
 
 (defun pw-lib-children (id &optional type)
@@ -183,10 +185,10 @@ type are returned.
 Note that PipeWire data is cached, if you need its up-to-date
 version, call `pw-lib-refresh' first."
   (let ((children (mapcar #'pw-lib-get-object
-                          (mapcar #'car (cl-remove-if #'(lambda (b) (/= (cdr b) id))
+                          (mapcar #'car (cl-remove-if (lambda (b) (/= (cdr b) id))
                                                       (pw-lib-bindings))))))
     (when type
-      (setq children (cl-remove-if-not #'(lambda (o) (equal (pw-lib-object-type o) type))
+      (setq children (cl-remove-if-not (lambda (o) (equal (pw-lib-object-type o) type))
                                        children)))
     children))
 
@@ -194,9 +196,9 @@ version, call `pw-lib-refresh' first."
   (when node
     (let ((ports (pw-lib-children (pw-lib-object-id node) "Port")))
       (if regexp
-          (cl-delete-if-not #'(lambda (o)
-                                (if-let ((name (pw-lib-object-value o "port.name")))
-                                    (string-match regexp name)))
+          (cl-delete-if-not (lambda (o)
+                              (if-let ((name (pw-lib-object-value o "port.name")))
+                                  (string-match regexp name)))
                             ports)
         ports))))
 

pw-ui.el

@@ -17,6 +17,8 @@
 ;; You should have received a copy of the GNU General Public License
 ;; along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+;;; Commentary:
+;;
 ;; PipeWire user interface based on pw-lib.
 ;; An interactive buffer can be displayed using `M-x pipewire'.
 ;; `pipewire-increase-volume', `pipewire-decrease-volume' and
@@ -26,7 +28,8 @@
 (require 'pw-lib)
 
 (defgroup pipewire ()
-  "PipeWire user interface.")
+  "PipeWire user interface."
+  :group 'multimedia)
 
 (defcustom pipewire-volume-step 5
   "How many percent points to add or subtract when changing volumes."
@@ -66,22 +69,22 @@ The indicator is displayed only on graphical terminals."
   :type '(alist :key-type symbol :value-type sexp)
   :group 'pip-frame)
 
-(defface pipewire-label-face
+(defface pipewire-label
   '((t (:weight bold :overline t)))
   "Face to use for PipeWire node group labels."
   :group 'pipewire)
 
-(defface pipewire-default-object-face
+(defface pipewire-default-object
   '((t (:weight bold)))
   "Face to use for PipeWire default sinks and sources."
   :group 'pipewire)
 
-(defface pipewire-muted-face
+(defface pipewire-muted
   '((t (:strike-through t)))
   "Face to use for muted PipeWire sinks and sources."
   :group 'pipewire)
 
-(defface pipewire-volume-face
+(defface pipewire-volume
   '((t (:inverse-video t)))
   "Face to use for displaying volumes of PipeWire objects."
   :group 'pipewire)
@@ -89,20 +92,20 @@ The indicator is displayed only on graphical terminals."
 (defvar pipewire-buffer "*PipeWire*")
 
 (defun pw-ui--label (label)
-  (propertize (concat label ":") 'face 'pipewire-label-face))
+  (propertize (concat label ":") 'face 'pipewire-label))
 
 (defun pw-ui--object-volume (object)
-  (propertize (pw-lib-volume object) 'face 'pipewire-volume-face))
+  (propertize (pw-lib-volume object) 'face 'pipewire-volume))
 
 (defun pw-ui--object-name (object)
   (let* ((type (pw-lib-object-type object))
          (description-properties (if (equal type "Client")
                                      '("application.name")
                                    (let ((prefix (concat (downcase type) ".")))
-                                     (mapcar #'(lambda (suffix) (concat prefix suffix))
+                                     (mapcar (lambda (suffix) (concat prefix suffix))
                                              '("description" "name"))))))
     (or (cl-find-if #'identity
-                    (mapcar #'(lambda (p) (pw-lib-object-value object p))
+                    (mapcar (lambda (p) (pw-lib-object-value object p))
                             description-properties))
         "")))
 
@@ -112,7 +115,7 @@ The indicator is displayed only on graphical terminals."
          (text (format "%4s: %s" id (pw-ui--object-name object)))
          (profile (when (equal type "Device")
                     (pw-lib-current-profile (pw-lib-object-id object))))
-         (face (if (member id default-ids) 'pipewire-default-object-face 'default))
+         (face (if (member id default-ids) 'pipewire-default-object 'default))
          (media-class (pw-lib-object-value object "media.class")))
     (when media-class
       (setq text (format "%s (%s)" text media-class)))
@@ -120,14 +123,14 @@ The indicator is displayed only on graphical terminals."
       (setq text (format "%s: %s" text profile)))
     (let ((volume-p (member type '("Node" "Port"))))
       (when (and volume-p (pw-lib-muted-p object))
-        (setq face `(:inherit (pipewire-muted-face ,face))))
+        (setq face `(:inherit (pipewire-muted ,face))))
       (let ((label (propertize text 'face face)))
         (when volume-p
           (let ((volume (pw-lib-volume object)))
             (when volume
               (setq label (concat label " "
                                   (propertize (number-to-string volume)
-                                              'face 'pipewire-volume-face))))))
+                                              'face 'pipewire-volume))))))
         label))))
 
 (defun pw-ui--insert-line (line object)
@@ -211,17 +214,18 @@ The indicator is displayed only on graphical terminals."
   (setq pw-ui--osd-timer
         (run-with-timer
          pipewire-osd-timeout nil
-         #'(lambda ()
-             (when pw-ui--osd-frame
-               (ignore-errors (delete-frame pw-ui--osd-frame)))
-             (when pw-ui--osd-buffer
-               (ignore-errors (kill-buffer pw-ui--osd-buffer)))
-             (setq pw-ui--osd-frame nil
-                   pw-ui--osd-timer nil
-                   pw-ui--osd-buffer nil)))))
+         (lambda ()
+           (when pw-ui--osd-frame
+             (ignore-errors (delete-frame pw-ui--osd-frame)))
+           (when pw-ui--osd-buffer
+             (ignore-errors (kill-buffer pw-ui--osd-buffer)))
+           (setq pw-ui--osd-frame nil
+                 pw-ui--osd-timer nil
+                 pw-ui--osd-buffer nil)))))
 
 (defmacro pw-ui--osd (&rest body)
-  (declare (indent defun))
+  (declare (debug (body))
+           (indent defun))
   (let (($string (gensym)))
     `(when (and window-system pipewire-osd-enable)
        (if-let ((,$string (progn ,@body)))
@@ -252,9 +256,12 @@ The indicator is displayed only on graphical terminals."
                             'face `(:background ,pipewire-osd-volume-off-color)))))))
 
 (defun pw-ui--update-muted (object muted-p)
-  (let ((object-name (pw-ui--object-name object))
-        (node-name (pw-ui--object-name (pw-lib-parent-node object))))
-    (pw-ui--update (format "%s in %s %s" object-name node-name (if muted-p "muted" "unmuted")))))
+  (let* ((object-name (pw-ui--object-name object))
+         (parent-node (pw-lib-parent-node object))
+         (node-info (if parent-node
+                       (format " in %s" (pw-ui--object-name parent-node))
+                     "")))
+    (pw-ui--update (format "%s%s %s" object-name node-info (if muted-p "muted" "unmuted")))))
 
 ;;;###autoload
 (defun pipewire-toggle-muted ()
@@ -344,10 +351,10 @@ Otherwise ask for the Node to set as the default Node."
   (let ((object (or (pw-ui--current-object nil '("Device" "Node"))
                     (let* ((default-node-ids (mapcar #'cdr (pw-lib-default-nodes)))
                            (nodes (cl-remove-if
-                                   #'(lambda (n) (member (pw-lib-object-id n) default-node-ids))
+                                   (lambda (n) (member (pw-lib-object-id n) default-node-ids))
                                    (pw-lib-objects "Node")))
-                           (node-mapping (mapcar #'(lambda (n) (cons (pw-ui--object-name n)
-                                                                     (pw-lib-object-id n)))
+                           (node-mapping (mapcar (lambda (n) (cons (pw-ui--object-name n)
+                                                                   (pw-lib-object-id n)))
                                                  nodes))
                            (node-name (completing-read "Default node: " node-mapping nil t)))
                       (pw-lib-get-object (cdr (assoc node-name node-mapping)))))))