From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp12.migadu.com ([2001:41d0:303:e224::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms8.migadu.com with LMTPS id gOziFEHeUGWPOQAAauVa8A:P1 (envelope-from ) for ; Sun, 12 Nov 2023 15:16:33 +0100 Received: from aspmx1.migadu.com ([2001:41d0:303:e224::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp12.migadu.com with LMTPS id gOziFEHeUGWPOQAAauVa8A (envelope-from ) for ; Sun, 12 Nov 2023 15:16:33 +0100 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id D980A5C590 for ; Sun, 12 Nov 2023 15:16:32 +0100 (CET) Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=ultrarare.space header.s=dkim header.b=TvHjSc5B; dmarc=pass (policy=none) header.from=gnu.org; spf=pass (aspmx1.migadu.com: domain of "guix-patches-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-patches-bounces+larch=yhetil.org@gnu.org" ARC-Seal: i=1; s=key1; d=yhetil.org; t=1699798593; a=rsa-sha256; cv=none; b=bg3PHdwOXtVejIj+nsvxtu6lrU7EikRLg7JkoH6xZttlONptYCdHqEdDwr2hSpxcRwhJuE E9Pj+dxuFiOZXYRlQpL6twpf+naJEpiwOx7NMLdxtSUr0Nio8mnmuY+FkVx4ZJuQ1ca9OD P72p4kjkUOU9SF6ZD+lM5sPwvHfYBK911m4Xx56yeqpsP70/DcLjaBF/MFYkPfZowtCU3W qI9MDotDy4qBMORhqKY8eMUwuMbWxrQ2g5wCVvqEwBlVCi/gL1qMrZm7PkxgnH30tWIAvD ld9lQuTvbwbsnTq9O2d5B1dYOQJFHtCawrVZeo9/LsyGeJ8wVYZ1rRXxHTYtLw== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=ultrarare.space header.s=dkim header.b=TvHjSc5B; dmarc=pass (policy=none) header.from=gnu.org; spf=pass (aspmx1.migadu.com: domain of "guix-patches-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-patches-bounces+larch=yhetil.org@gnu.org" ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1699798593; h=from:from:sender:sender:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding:resent-cc: resent-from:resent-sender:resent-message-id:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=r3F8mug0clAR9C1vq2xkk0NEdEdTKD3H3Ndmnrn7b4M=; b=AflUj8awHox45HOLpir6729/L7dWGEYGbNs2FRGmJKk1VJX63URgJSkl6hdEVF+B53uHRl ESJJL3deMdF0CbkV1uIvGXJusaAnBJ83aYEQaNNcGWqoRh0Fh3JKnAl9Vhmw9hIJVdx3JW 8Wu1tuUBs8nzIZgnkkCjGvcGOzztv994W0MYORz6fGjR1UqOD0w0Ax72dujCsK6dGbjn3w 04R5+qmIBLw9IrWB6WvZYOIEgNiWmWRQvC0ewKMzHPXqDMmK5dsvSHHrBXmsgOEDeV70ak wbmBE93McFV63kz2RbHmiNKHYuz96Yv0xU9rSm3iIjipzdOvEZWHoeANy4CHNg== Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1r2BGB-0001zh-Mw; Sun, 12 Nov 2023 09:16:23 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1r2BG9-0001zU-Sm for guix-patches@gnu.org; Sun, 12 Nov 2023 09:16:21 -0500 Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1r2BG8-0001TO-RW; Sun, 12 Nov 2023 09:16:20 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1r2BGn-0006qD-Ll; Sun, 12 Nov 2023 09:17:01 -0500 X-Loop: help-debbugs@gnu.org Subject: [bug#63863] [PATCH v5 1/1] gnu: home: Add support for home-pipewire-service Resent-From: Hilton Chain Original-Sender: "Debbugs-submit" Resent-CC: ludo@gnu.org, andrew@trop.in, guix-patches@gnu.org Resent-Date: Sun, 12 Nov 2023 14:17:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 63863 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: Brian Cully Cc: 63863@debbugs.gnu.org, Ludovic =?UTF-8?Q?Court=C3=A8s?= , Andrew Tropin X-Debbugs-Original-Xcc: Ludovic =?UTF-8?Q?Court=C3=A8s?= , Andrew Tropin Received: via spool by 63863-submit@debbugs.gnu.org id=B63863.169979859626242 (code B ref 63863); Sun, 12 Nov 2023 14:17:01 +0000 Received: (at 63863) by debbugs.gnu.org; 12 Nov 2023 14:16:36 +0000 Received: from localhost ([127.0.0.1]:55247 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1r2BGN-0006pB-QO for submit@debbugs.gnu.org; Sun, 12 Nov 2023 09:16:36 -0500 Received: from mail.boiledscript.com ([144.168.59.46]:53332) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1r2BGK-0006p0-Ti for 63863@debbugs.gnu.org; Sun, 12 Nov 2023 09:16:34 -0500 Date: Sun, 12 Nov 2023 22:14:20 +0800 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ultrarare.space; s=dkim; t=1699798357; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=r3F8mug0clAR9C1vq2xkk0NEdEdTKD3H3Ndmnrn7b4M=; b=TvHjSc5BhrW8mu0aA1f18My7EPy+uk8NiLPxqfK57exJDFSIaTn9DWOUHhNEouWZGcc+nD i+djoIfpHYxqQmxxd8bc+9e+vLAvPxBdGnmO+ucuSoqSYOlpzECtWuss2vyB56imZoEhQ7 8edVIsoCIbjB9bZrIPoN5T/seTTBeIinZUFgPuG8/z4/5k+pfDgXaiHS23++5fer6ymtUY 4qyqJrY9D5JHqNjqZzmFy9j+cDDhceSWoj214piRGmN89CNuUfZ/roSFrQSiFapaQUoWk7 iEfZ8Izy6rHQdUmdybSNMZP+Usq/gpav8u2LtYdGeRo/bhkYQQaFLbpbpWRcaw== Message-ID: <87y1f383er.wl-hako@ultrarare.space> In-Reply-To: <1023a7ef7f4612d8f7c08c2a4f9a39591263c284.1688301546.git.bjc@spork.org> References: <1023a7ef7f4612d8f7c08c2a4f9a39591263c284.1688301546.git.bjc@spork.org> MIME-Version: 1.0 Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: quoted-printable X-Spamd-Bar: / X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-to: Hilton Chain X-ACL-Warn: , Hilton Chain via Guix-patches From: Hilton Chain via Guix-patches via Errors-To: guix-patches-bounces+larch=yhetil.org@gnu.org Sender: guix-patches-bounces+larch=yhetil.org@gnu.org X-Migadu-Flow: FLOW_IN X-Migadu-Country: US X-Migadu-Queue-Id: D980A5C590 X-Migadu-Scanner: mx12.migadu.com X-Migadu-Spam-Score: -6.60 X-Spam-Score: -6.60 X-TUID: qXm5et7pZigf Hi Brian, Tested the patch in my setup, it works well :) (Some comments are in and after the quote.) On Sun, 02 Jul 2023 20:39:41 +0800, Brian Cully via Guix-patches via wrote: > > This adds a set of home shepherd services which will start the required > services for a functional pipewire setup. > > * gnu/home/services/sound.scm (home-pipewire-shepherd-service), > (home-pipewire-pulse-shepherd-service), (home-wireplumber-shepherd-servic= e), > (home-pipewire-shepherd-services) > (home-pipewire-asoundrc), (home-pipewire-xdg-configuration): new procedur= es. > (home-pipewire-service-type): new service type. > (home-pipewire-configuration): new struct. > (home-pipewire-disable-pulseaudio-auto-start): new variable. > * doc/guix.texi (Sound Home Services): document it. > --- > doc/guix.texi | 73 +++++++++++++++++++++++ > gnu/home/services/sound.scm | 115 +++++++++++++++++++++++++++++++++++- > 2 files changed, 187 insertions(+), 1 deletion(-) > > diff --git a/doc/guix.texi b/doc/guix.texi > index 853396f776..7a6b7ebc3a 100644 > --- a/doc/guix.texi > +++ b/doc/guix.texi > @@ -116,6 +116,7 @@ > Copyright @copyright{} 2023 Karl Hallsby@* > Copyright @copyright{} 2023 Nathaniel Nicandro@* > Copyright @copyright{} 2023 Tanguy Le Carrour@* > +Copyright @copyright{} 2023 Brian Cully@* > > Permission is granted to copy, distribute and/or modify this document > under the terms of the GNU Free Documentation License, Version 1.3 or > @@ -43742,6 +43743,7 @@ Sound Home Services > > @cindex PulseAudio, home service > @cindex RTP, for PulseAudio > +@subsubheading PulseAudio RTP Streaming Services > > The following services dynamically reconfigure the > @uref{https://pulseaudio.org,PulseAudio sound server}: they let you > @@ -43829,6 +43831,77 @@ Sound Home Services > This is the multicast address used by default by the two services above. > @end defvar > > +@cindex PipeWire, home service > +@subsubheading PipeWire Home Service > + > +@uref{https://pipewire.org, PipeWire} provides a low-latency, > +graph-based audio and video processing service. In addition to its > +native protocol, it can also be used as a replacement for both JACK and > +PulseAudio. > + > +While PipeWire provides the media processing and API, it does not, > +directly, know about devices such as sound cards, nor how you might want > +to connect applications, hardware, and media processing filters. > +Instead, PipeWire relies on a @dfn{session manager} to specify all these > +relationships. While you may use any session manager you wish, for most > +people the @url{https://pipewire.pages.freedesktop.org/wireplumber/, > +WirePlumber} session manager, a reference implementation provided by the > +PipeWire project itself, suffices, and that is the one > +@code{home-pipewire-service-type} uses. > + > +PipeWire can be used as a replacement for PulseAudio by setting > +@code{enable-pulseaudio?} to @code{#t} in > +@code{home-pipewire-configuration}, so that existing PulseAudio clients > +may use it without any further configuration. > + > +In addition, JACK clients may connect to PipeWire by using the > +@command{pw-jack} program, which comes with PipeWire. Simply prefix the > +command with @command{pw-jack} when you run it, and audio data should go > +through PipeWire: > + > +@example > +pw-jack mpv -ao=3Djack sound-file.wav > +@end example > + > +For more information on PulseAudio emulation, see > +@uref{https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/Config-Pu= lseAudio}, > +for JACK, see > +@uref{https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/Config-JA= CK}. > + > +As PipeWire does not use @code{dbus} to start its services on demand > +(as PulseAudio does), @code{home-pipewire-service-type} uses Shepherd > +to start services when logged in, provisioning the @code{pipewire}, > +@code{wireplumber}, and, if configured, @code{pipewire-pulseaudio} > +services. @xref{Shepherd Home Service}. > + > +@defvar home-pipewire-service-type > +This provides the service definition for @command{pipewire}, which will > +run on login. Its value is a @code{home-pipewire-configuration} object. > + > +To start the service, add it to the @code{service} field of your > +@code{home-environment}, such as: > + > +@lisp > +(service home-pipewire-service-type) > +@end lisp > +@end defvar > + > +@deftp {Data Type} home-pipewire-configuration > +Available @code{home-pipewire-configuration} fields are: > + > +@table @asis > +@item @code{pipewire} (default: @code{pipewire}) (type: file-like) > +The PipeWire package to use. > + > +@item @code{wireplumber} (default: @code{wireplumber}) (type: file-like) > +The WirePlumber package to use. > + > +@item @code{enable-pulseaudio?} (default: @code{#t}) (type: boolean) > +When true, enable PipeWire's PulseAudio emulation support, allowing > +PulseAudio clients to use PipeWire transparently. > +@end table > +@end deftp > + > @node Mail Home Services > @subsection Mail Home Services > > diff --git a/gnu/home/services/sound.scm b/gnu/home/services/sound.scm > index 22c1a99250..5463255e8c 100644 > --- a/gnu/home/services/sound.scm > +++ b/gnu/home/services/sound.scm > @@ -1,5 +1,6 @@ > ;;; GNU Guix --- Functional package management for GNU > ;;; Copyright =A9 2023 Ludovic Court=E8s > +;;; Copyright =A9 2023 Brian Cully > ;;; > ;;; This file is part of GNU Guix. > ;;; > @@ -19,13 +20,125 @@ > (define-module (gnu home services sound) > #:use-module (gnu home services) > #:use-module (gnu home services shepherd) > + #:use-module (gnu home services xdg) > + #:use-module (gnu packages linux) > + #:use-module (gnu services configuration) > #:use-module (guix records) > #:use-module (guix gexp) > #:use-module (srfi srfi-1) > #:use-module (ice-9 match) > #:export (home-pulseaudio-rtp-sink-service-type > home-pulseaudio-rtp-source-service-type > - %pulseaudio-rtp-multicast-address)) > + %pulseaudio-rtp-multicast-address > + > + home-pipewire-configuration > + home-pipewire-service-type)) > + > +=0C > +;;; > +;;; PipeWire support. > +;;; > + > +(define-configuration/no-serialization home-pipewire-configuration > + (pipewire > + (file-like pipewire) > + "The PipeWire package to use.") > + (wireplumber > + (file-like wireplumber) > + "The WirePlumber package to use.") > + (enable-pulseaudio? > + (boolean #t) > + "When true, enable PipeWire's PulseAudio emulation support, allowing > +PulseAudio clients to use PipeWire transparently.")) > + > +(define (home-pipewire-shepherd-service config) > + (shepherd-service > + (documentation "PipeWire media processing.") > + (provision '(pipewire)) > + (requirement '(dbus)) > + (start #~(make-forkexec-constructor > + (list #$(file-append > + (home-pipewire-configuration-pipewire config) > + "/bin/pipewire")))) > + (stop #~(make-kill-destructor)))) > + > +(define (home-pipewire-pulseaudio-shepherd-service config) > + (shepherd-service > + (documentation "Drop-in PulseAudio replacement service for PipeWire.") > + (provision '(pipewire-pulseaudio)) > + (requirement '(pipewire)) > + (start #~(make-forkexec-constructor > + (list #$(file-append > + (home-pipewire-configuration-pipewire config) > + "/bin/pipewire-pulse")))) > + (stop #~(make-kill-destructor)))) > + > +(define (home-wireplumber-shepherd-service config) > + (shepherd-service > + (documentation "WirePlumber session management for PipeWire.") > + (provision '(wireplumber)) > + (requirement '(pipewire)) > + (start #~(make-forkexec-constructor > + (list #$(file-append > + (home-pipewire-configuration-wireplumber config) > + "/bin/wireplumber")))) > + (stop #~(make-kill-destructor)))) > + > +(define (home-pipewire-shepherd-services config) > + (cons* (home-pipewire-shepherd-service config) > + (home-wireplumber-shepherd-service config) > + (if (home-pipewire-configuration-enable-pulseaudio? config) > + (list (home-pipewire-pulseaudio-shepherd-service config)) > + '()))) > + > +(define (home-pipewire-asoundrc config) > + (mixed-text-file > + "asoundrc" > + #~(string-append > + "<" > + #$(file-append > + (home-pipewire-configuration-pipewire config) > + "/share/alsa/alsa.conf.d/50-pipewire.conf") > + ">\n" > + "<" > + #$(file-append > + (home-pipewire-configuration-pipewire config) > + "/share/alsa/alsa.conf.d/99-pipewire-default.conf") > + ">\n" > + "pcm_type.pipewire {\n" > + " lib \"" > + #$(file-append > + (home-pipewire-configuration-pipewire config) > + "/lib/alsa-lib/libasound_module_pcm_pipewire.so") > + "\"\n}\n" > + "ctl_type.pipewire {\n" > + " lib \"" > + #$(file-append > + (home-pipewire-configuration-pipewire config) > + "/lib/alsa-lib/libasound_module_ctl_pipewire.so") > + "\"\n}\n"))) I'd prefer the following: --8<---------------cut here---------------start------------->8--- (define (home-pipewire-asoundrc config) (match-record config (pipewire) (mixed-text-file "asoundrc" "<" pipewire "/share/alsa/alsa.conf.d/50-pipewire.conf>\n" "<" pipewire "/share/alsa/alsa.conf.d/99-pipewire-default.conf>\n" "pcm_type.pipewire {\n" " lib \"" pipewire "/lib/alsa-lib/libasound_module_pcm_pipewire.so\"\= n" "}\n" "ctl_type.pipewire {\n" " lib \"" pipewire "/lib/alsa-lib/libasound_module_ctl_pipewire.so\"\= n" "}\n"))) --8<---------------cut here---------------end--------------->8--- or: --8<---------------cut here---------------start------------->8--- (define (home-pipewire-asoundrc config) (match-record config (pipewire) (mixed-text-file "asoundrc" #~(begin (use-modules (ice-9 format)) (format #f "~ <~a/share/alsa/alsa.conf.d/50-pipewire.conf> <~@*~a/share/alsa/alsa.conf.d/99-pipewire-default.conf> pcm_type.pipewire { lib \"~@*~a/lib/alsa-lib/libasound_module_pcm_pipewire.so\" } ctl_type.pipewire { lib \"~@*~a/lib/alsa-lib/libasound_module_ctl_pipewire.so\" }~%" #$pipewire))))) --8<---------------cut here---------------end--------------->8--- > + > +(define home-pipewire-disable-pulseaudio-auto-start > + (plain-file "client.conf" "autospawn =3D no")) > + > +(define (home-pipewire-xdg-configuration config) > + (cons* `("alsa/asoundrc" ,(home-pipewire-asoundrc config)) > + (if (home-pipewire-configuration-enable-pulseaudio? config) > + `(("pulse/client.conf" > + ,home-pipewire-disable-pulseaudio-auto-start)) > + '()))) > + > +(define home-pipewire-service-type > + (service-type > + (name 'pipewire) > + (extensions > + (list (service-extension home-shepherd-service-type > + home-pipewire-shepherd-services) > + (service-extension home-xdg-configuration-files-service-type > + home-pipewire-xdg-configuration))) > + (description > + "Start essential PipeWire services.") > + (default-value (home-pipewire-configuration)))) > > =0C > ;;; > -- > 2.40.1 One thing to note: the wireplumber package is built with elogind integratio= n, so it fails to start when elogind is not present: --8<---------------cut here---------------start------------->8--- [wireplumber] failed to start systemd logind monitor: -2 (No such file or d= irectory) --8<---------------cut here---------------end--------------->8--- I think we can add a wireplumber variant built with "-Delogind=3Ddisabled" = and maybe mention it in the documentation. Thanks