media-video/wireplumber: backport autoswitch fix

We might now have a stable candidate.

Bug: https://bugs.gentoo.org/936967
Bug: https://gitlab.freedesktop.org/pipewire/wireplumber/-/issues/715
Signed-off-by: Sam James <sam@gentoo.org>

2 files changed, 196 insertions, 0 deletions

diff --git a/media-video/wireplumber/files/wireplumber-0.5.6-bluetooth-only-autoswitch.patch b/media-video/wireplumber/files/wireplumber-0.5.6-bluetooth-only-autoswitch.patch
new file mode 100644
index 000000000000..779a4d4f21bf
--- /dev/null
+++ b/media-video/wireplumber/files/wireplumber-0.5.6-bluetooth-only-autoswitch.patch
@@ -0,0 +1,64 @@
+https://gitlab.freedesktop.org/pipewire/wireplumber/-/issues/715
+https://gitlab.freedesktop.org/pipewire/wireplumber/-/merge_requests/669
+https://gitlab.freedesktop.org/pipewire/wireplumber/-/commit/b68a6794cd5c3702a2144be60c41a9ca982c416b
+
+From b68a6794cd5c3702a2144be60c41a9ca982c416b Mon Sep 17 00:00:00 2001
+From: Pauli Virtanen <pav@iki.fi>
+Date: Sun, 8 Sep 2024 20:22:41 +0300
+Subject: [PATCH] autoswitch-bluetooth-profile: switch only Bluetooth devices
+
+Handle only devices associated with Bluetooth loopback nodes.
+
+Make sure the node.link-group iteration cannot get stuck if there is a
+loop in the link graph.
+--- a/src/scripts/device/autoswitch-bluetooth-profile.lua
++++ b/src/scripts/device/autoswitch-bluetooth-profile.lua
+@@ -301,13 +301,14 @@ end
+ 
+ -- We consider a Stream of interest if it is linked to a bluetooth loopback
+ -- source filter
+-local function checkStreamStatus (stream, node_om)
++local function checkStreamStatus (stream, node_om, visited_link_groups)
+   -- check if the stream is linked to a bluetooth loopback source
+   local stream_id = tonumber(stream["bound-id"])
+   local peer_id = lutils.getNodePeerId (stream_id)
+   if peer_id ~= nil then
+     local bt_node = node_om:lookup {
+-        Constraint { "bound-id", "=", peer_id, type = "gobject" }
++        Constraint { "bound-id", "=", peer_id, type = "gobject" },
++        Constraint { "bluez5.loopback", "=", "true", type = "pw" }
+     }
+     if bt_node ~= nil then
+       local dev_id = bt_node.properties["device.id"]
+@@ -325,18 +326,27 @@ local function checkStreamStatus (stream, node_om)
+     else
+       -- Check if it is linked to a filter main node, and recursively advance if so
+       local filter_main_node = node_om:lookup {
+-        Constraint { "bound-id", "=", peer_id, type = "gobject" }
++        Constraint { "bound-id", "=", peer_id, type = "gobject" },
++        Constraint { "node.link-group", "+", type = "pw" }
+       }
+       if filter_main_node ~= nil then
+         -- Now check all stream nodes for this filter
+         local filter_link_group = filter_main_node.properties ["node.link-group"]
++        if visited_link_groups == nil then
++          visited_link_groups = {}
++        end
++        if visited_link_groups [filter_link_group] then
++          return nil
++        else
++          visited_link_groups [filter_link_group] = true
++        end
+         for filter_stream_node in node_om:iterate {
+             Constraint { "media.class", "matches", "Stream/Input/Audio", type = "pw-global" },
+             Constraint { "stream.monitor", "!", "true", type = "pw" },
+             Constraint { "bluez5.loopback", "!", "true", type = "pw" },
+             Constraint { "node.link-group", "=", filter_link_group, type = "pw" }
+           } do
+-          local dev_id = checkStreamStatus (filter_stream_node, node_om)
++          local dev_id = checkStreamStatus (filter_stream_node, node_om, visited_link_groups)
+           if dev_id ~= nil then
+             return dev_id
+           end
+-- 
+GitLab
diff --git a/media-video/wireplumber/wireplumber-0.5.6-r1.ebuild b/media-video/wireplumber/wireplumber-0.5.6-r1.ebuild
new file mode 100644
index 000000000000..a5d10f865805
--- /dev/null
+++ b/media-video/wireplumber/wireplumber-0.5.6-r1.ebuild
@@ -0,0 +1,132 @@
+# Copyright 1999-2024 Gentoo Authors
+# Distributed under the terms of the GNU General Public License v2
+
+EAPI=8
+
+# 1. Please regularly check (even at the point of bumping) Fedora's packaging
+# for needed backports at https://src.fedoraproject.org/rpms/wireplumber/tree/rawhide
+#
+# 2. Keep an eye on git master (for both PipeWire and WirePlumber) as things
+# continue to move quickly. It's not uncommon for fixes to be made shortly
+# after releases.
+
+LUA_COMPAT=( lua5-{3,4} )
+
+inherit lua-single meson systemd
+
+DESCRIPTION="Replacement for pipewire-media-session"
+HOMEPAGE="https://gitlab.freedesktop.org/pipewire/wireplumber"
+
+if [[ ${PV} == 9999 ]]; then
+	EGIT_REPO_URI="https://gitlab.freedesktop.org/pipewire/${PN}.git"
+	EGIT_BRANCH="master"
+	inherit git-r3
+else
+	SRC_URI="https://gitlab.freedesktop.org/pipewire/${PN}/-/archive/${PV}/${P}.tar.bz2"
+	KEYWORDS="~amd64 ~arm ~arm64 ~loong ~mips ~ppc ~ppc64 ~riscv ~sparc ~x86"
+fi
+
+LICENSE="MIT"
+SLOT="0/0.5"
+IUSE="elogind system-service systemd test"
+
+REQUIRED_USE="
+	${LUA_REQUIRED_USE}
+	?? ( elogind systemd )
+	system-service? ( systemd )
+"
+
+RESTRICT="!test? ( test )"
+
+# introspection? ( dev-libs/gobject-introspection ) is valid but likely only used for doc building
+BDEPEND="
+	dev-libs/glib
+	dev-util/gdbus-codegen
+	dev-util/glib-utils
+	sys-devel/gettext
+	test? ( sys-apps/dbus )
+"
+DEPEND="
+	${LUA_DEPS}
+	>=dev-libs/glib-2.68
+	>=media-video/pipewire-1.0.5-r1:=
+	virtual/libintl
+	elogind? ( sys-auth/elogind )
+	systemd? ( sys-apps/systemd )
+"
+RDEPEND="
+	${DEPEND}
+	system-service? (
+		acct-user/pipewire
+		acct-group/pipewire
+	)
+"
+
+DOCS=( {NEWS,README}.rst )
+
+PATCHES=(
+	# Defer enabling sound server parts to media-video/pipewire
+	# TODO: Soon, we should be able to migrate to just a dropin at
+	# /usr/share. See https://gitlab.freedesktop.org/pipewire/wireplumber/-/issues/652#note_2399735.
+	"${FILESDIR}"/${PN}-0.5.6-config-disable-sound-server-parts.patch
+
+	"${FILESDIR}"/${P}-bluetooth-only-autoswitch.patch
+)
+
+src_configure() {
+	local emesonargs=(
+		-Ddaemon=true
+		-Dtools=true
+		-Dmodules=true
+		# Ebuild not wired up yet (Sphinx, Doxygen?)
+		-Ddoc=disabled
+		# Only used for Sphinx doc generation
+		-Dintrospection=disabled
+		-Dsystem-lua=true
+		-Dsystem-lua-version=$(ver_cut 1-2 $(lua_get_version))
+		$(meson_feature elogind)
+		$(meson_feature systemd)
+		$(meson_use system-service systemd-system-service)
+		$(meson_use systemd systemd-user-service)
+		-Dsystemd-system-unit-dir=$(systemd_get_systemunitdir)
+		-Dsystemd-user-unit-dir=$(systemd_get_userunitdir)
+		$(meson_use test tests)
+		$(meson_use test dbus-tests)
+	)
+
+	meson_src_configure
+}
+
+src_install() {
+	meson_src_install
+
+	mv "${ED}"/usr/share/doc/wireplumber/* "${ED}"/usr/share/doc/${PF} || die
+	rmdir "${ED}"/usr/share/doc/wireplumber || die
+}
+
+pkg_postinst() {
+	if systemd_is_booted ; then
+		ewarn "pipewire-media-session.service is no longer installed. You must switch"
+		ewarn "to wireplumber.service user unit before your next logout/reboot:"
+		ewarn "systemctl --user disable pipewire-media-session.service"
+		ewarn "systemctl --user --force enable wireplumber.service"
+	else
+		ewarn "Switch to WirePlumber will happen the next time gentoo-pipewire-launcher"
+		ewarn "is started (a replacement for directly calling pipewire binary)."
+		ewarn
+		ewarn "Please ensure that ${EROOT}/etc/pipewire/pipewire.conf either does not exist"
+		ewarn "or, if it does exist, that any reference to"
+		ewarn "${EROOT}/usr/bin/pipewire-media-session is commented out (begins with a #)."
+	fi
+
+	if use system-service; then
+		ewarn
+		ewarn "WARNING: you have enabled the system-service USE flag, which installs"
+		ewarn "the system-wide systemd units that enable WirePlumber to run as a system"
+		ewarn "service. This is more than likely NOT what you want. You are strongly"
+		ewarn "advised not to enable this mode and instead stick with systemd user"
+		ewarn "units. The default configuration files will likely not work out of"
+		ewarn "box, and you are on your own with configuration."
+		ewarn
+	fi
+}