From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp12.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms9.migadu.com with LMTPS id AkZBGkBwoWTJFQAASxT56A (envelope-from ) for ; Sun, 02 Jul 2023 14:40:32 +0200 Received: from aspmx1.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp12.migadu.com with LMTPS id CPweGUBwoWTKtQAAauVa8A (envelope-from ) for ; Sun, 02 Jul 2023 14:40:32 +0200 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 2664638916 for ; Sun, 2 Jul 2023 14:40:32 +0200 (CEST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qFwN4-0001mS-4d; Sun, 02 Jul 2023 08:40:06 -0400 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 1qFwN0-0001lT-Qe for guix-patches@gnu.org; Sun, 02 Jul 2023 08:40:02 -0400 Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1qFwN0-0004jV-GY for guix-patches@gnu.org; Sun, 02 Jul 2023 08:40:02 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1qFwN0-0002AP-BF for guix-patches@gnu.org; Sun, 02 Jul 2023 08:40:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#63863] [PATCH v5 1/1] gnu: home: Add support for home-pipewire-service Resent-From: Brian Cully Original-Sender: "Debbugs-submit" Resent-CC: , guix-patches@gnu.org Resent-Date: Sun, 02 Jul 2023 12:40:02 +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: 63863@debbugs.gnu.org Cc: Brian Cully , ( , Andrew Tropin , Ludovic =?UTF-8?Q?Court=C3=A8s?= X-Debbugs-Original-Xcc: ( , Andrew Tropin , Ludovic =?UTF-8?Q?Court=C3=A8s?= Received: via spool by 63863-submit@debbugs.gnu.org id=B63863.16883015958304 (code B ref 63863); Sun, 02 Jul 2023 12:40:02 +0000 Received: (at 63863) by debbugs.gnu.org; 2 Jul 2023 12:39:55 +0000 Received: from localhost ([127.0.0.1]:59488 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qFwMs-00029r-Ge for submit@debbugs.gnu.org; Sun, 02 Jul 2023 08:39:55 -0400 Received: from coleridge.kublai.com ([166.84.7.167]:58149 helo=mail.spork.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qFwMo-00029W-SC for 63863@debbugs.gnu.org; Sun, 02 Jul 2023 08:39:53 -0400 Received: from psyduck.jhoto.kublai.com (ool-18b8e9e7.dyn.optonline.net [24.184.233.231]) by mail.spork.org (Postfix) with ESMTPSA id A50151381; Sun, 2 Jul 2023 08:39:50 -0400 (EDT) DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=spork.org; s=dkim; t=1688301590; bh=7mo0HbtJWjnle9cXVaB+20+/jHExQIHLDTjcfdbOyKs=; h=From:To:Cc:Subject:Date:In-Reply-To:References; b=twqduBPfCZP3S6c8bDvQOOBqkGJYPDcDnbEVbad36kM04DYuVwLAIUQJSNn+QGPjC Sr4pMZ0CUJmPnCGWzC8O/zs2O4Uc+WLHrX2cwmfJNWIoovWA0gnLzB4Nv1RptDAczP FZ1rI4omJ5fs7JhTyjjEoMHqVHSUfuTdSi9dpzgs= Date: Sun, 2 Jul 2023 08:39:41 -0400 Message-Id: <1023a7ef7f4612d8f7c08c2a4f9a39591263c284.1688301546.git.bjc@spork.org> X-Mailer: git-send-email 2.40.1 In-Reply-To: References: MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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: Brian Cully X-ACL-Warn: , Brian Cully via Guix-patches From: Brian Cully 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-Country: US X-Migadu-Flow: FLOW_IN ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1688301632; 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=M+yKzgWnw2SWixl32Hm/94/SyLYRYpsbdw98+UXGexM=; b=HKtl7b+MSBchWszGlMp7aNIzJQgdD8dlBpImnno3+wRRgGqDXslckXxMsqbbdoVHDuS+5a KUSqgTzigVO+YX+FosJmDIKzEM5GT9mi7mzgxF+K0xDlD5EbaZ1fVtA+lSGfpZGv4CHljN B+vjhIOVoxlLq/ttbZ3KjC/5Kvgt3KtZOnWvy5mzUjEf2LUZ4jxXL9zlDr/TSFxAEI3iNb LcGR6zcTwWlC8+Ggn0XpIha0E+HEqx6oyL0k4v9LIWeb6A4kNp2cBbouD+LH1ZwKoThU8V YJjcIYIs9lzwtxRlbwSPB7wxON5VYbmrd2hnNJRgyVWWjXCN/Xy6r3qvnjEwEg== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=spork.org header.s=dkim header.b=twqduBPf; 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=1688301632; a=rsa-sha256; cv=none; b=sDnRk4qhR59jbKrNwg1AdYZ4Ce9JcTCzA2OYnOGfhQM8ki5zfJxhMIJtmwzcKADgZcLyNG fCjZWvsF9TjHUighzNEGR3z63Tnis/frlDfO5vv6G6XVa8H6/197m5xRfff7n06nH9nfoY LrYZt02Gi38ROso79cch1JG2+0eO0MZi89qggaOtzCZFiAM+vs0ScDkVG6Ts7wcHn3xMt6 XjMAAxbz9iQJFgLiT6mpqWXFMaieRRqJsc4ZS02x8T0o3wpTWDqbos4nwQ1AeRWYiyJfvl ToDoxjgkgUMO9dYrYW30h+tflnUQmWzU0FJbbLSA/iFHC2s8usZuZVyOLuGtJQ== X-Migadu-Scanner: scn1.migadu.com X-Migadu-Spam-Score: -2.25 Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=spork.org header.s=dkim header.b=twqduBPf; 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" X-Migadu-Queue-Id: 2664638916 X-Spam-Score: -2.25 X-TUID: pc7GzcN/5DB9 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-service), (home-pipewire-shepherd-services) (home-pipewire-asoundrc), (home-pipewire-xdg-configuration): new procedures. (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=jack sound-file.wav +@end example + +For more information on PulseAudio emulation, see +@uref{https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/Config-PulseAudio}, +for JACK, see +@uref{https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/Config-JACK}. + +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 © 2023 Ludovic Courtès +;;; Copyright © 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)) + + +;;; +;;; 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"))) + +(define home-pipewire-disable-pulseaudio-auto-start + (plain-file "client.conf" "autospawn = 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)))) ;;; -- 2.40.1