media-video/pipewire: Add to fix https://bugs.gentoo.org/785076 (alsa-plugins)

Signed-off-by: Martin Väth <martin@mvath.de>

8 files changed, 384 insertions, 0 deletions

diff --git a/media-video/pipewire/Manifest b/media-video/pipewire/Manifest
new file mode 100644
index 00000000..f9fd7cea
--- /dev/null
+++ b/media-video/pipewire/Manifest
@@ -0,0 +1 @@
+DIST pipewire-0.3.32.tar.gz 1604622 BLAKE2B cab83a17a2b27f710e1377a2ad2ad7003053ef3e8b55423362f0b428e22d52c2ce564da00aab71cc93262d4cb21f239fffea195d05937fdf3489dc540b77d58d SHA512 8a7fe26a78071fdd8d4c9e2d9bf3791af8e0cb53b976b45d39dcab4ad08196808f416911fb1b366cc85e3fa80592ec79c4e4556bb3a390f4a10229b4bf9893f7
diff --git a/media-video/pipewire/files/pipewire-0.3.25-enable-failed-mlock-warning.patch b/media-video/pipewire/files/pipewire-0.3.25-enable-failed-mlock-warning.patch
new file mode 100644
index 00000000..bdb43fe5
--- /dev/null
+++ b/media-video/pipewire/files/pipewire-0.3.25-enable-failed-mlock-warning.patch
@@ -0,0 +1,12 @@
+diff --git a/src/daemon/pipewire.conf.in b/src/daemon/pipewire.conf.in
+--- a/src/daemon/pipewire.conf.in
++++ b/src/daemon/pipewire.conf.in
+@@ -6,7 +6,7 @@ context.properties = {
+     #support.dbus                          = true
+     #link.max-buffers                      = 64
+     link.max-buffers                       = 16                       # version < 3 clients can't handle more
+-    #mem.warn-mlock                        = false
++    mem.warn-mlock                         = true                     # Gentoo should have good RLIMITs now
+     #mem.allow-mlock                       = true
+     #mem.mlock-all                         = false
+     #clock.power-of-two-quantum            = true
diff --git a/media-video/pipewire/files/pipewire-0.3.31-non-systemd-integration.patch b/media-video/pipewire/files/pipewire-0.3.31-non-systemd-integration.patch
new file mode 100644
index 00000000..ccc89f13
--- /dev/null
+++ b/media-video/pipewire/files/pipewire-0.3.31-non-systemd-integration.patch
@@ -0,0 +1,17 @@
+--- a/src/daemon/pipewire.conf.in	2021-06-30 22:22:09.520402459 +0200
++++ b/src/daemon/pipewire.conf.in	2021-06-30 22:22:30.620404999 +0200
+@@ -234,12 +234,12 @@
+     # but it is better to start it as a systemd service.
+     # Run the session manager with -h for options.
+     #
+-    @comment@{ path = "@session_manager_path@"  args = "@session_manager_args@" }
++    { path = "@session_manager_path@"  args = "@session_manager_args@" }
+     #
+     # You can optionally start the pulseaudio-server here as well
+     # but it is better to start it as a systemd service.
+     # It can be interesting to start another daemon here that listens
+     # on another address with the -a option (eg. -a tcp:4713).
+     #
+-    @comment@{ path = "@pipewire_path@" args = "-c pipewire-pulse.conf" }
++    { path = "@pipewire_path@" args = "-c pipewire-pulse.conf" }
+ ]
diff --git a/media-video/pipewire/files/pipewire-0.3.31-revert-openaptx-restriction.patch b/media-video/pipewire/files/pipewire-0.3.31-revert-openaptx-restriction.patch
new file mode 100644
index 00000000..d8496bc5
--- /dev/null
+++ b/media-video/pipewire/files/pipewire-0.3.31-revert-openaptx-restriction.patch
@@ -0,0 +1,30 @@
+From 3449214466c4dac866ec9f47ecc573efaf4505bb Mon Sep 17 00:00:00 2001
+From: Thomas Deutschmann <whissi@gentoo.org>
+Date: Fri, 21 May 2021 10:32:52 +0200
+Subject: [PATCH] Revert "openaptx: Blacklist >= 0.2.1 due to license change"
+
+This reverts commit d08b6fac6bec0d334ee9fc785d551a67832f95fe.
+
+Doesn't apply to us.
+
+Bug: https://bugs.gentoo.org/785634
+---
+ spa/meson.build | 2 +-
+ 1 file changed, 1 insertion(+), 1 deletion(-)
+
+diff --git a/spa/meson.build b/spa/meson.build
+index e13802e94..885b25405 100644
+--- a/spa/meson.build
++++ b/spa/meson.build
+@@ -28,7 +28,7 @@ if not get_option('spa-plugins').disabled()
+     summary({'LDAC': ldac_dep.found()}, bool_yn: true, section: 'Bluetooth audio codecs')
+     ldac_abr_dep = dependency('ldacBT-abr', required : get_option('bluez5-codec-ldac'))
+     summary({'LDAC ABR': ldac_abr_dep.found()}, bool_yn: true, section: 'Bluetooth audio codecs')
+-    aptx_dep = dependency('libopenaptx', version : '< 0.2.1', required : get_option('bluez5-codec-aptx'))
++    aptx_dep = dependency('libopenaptx', required : get_option('bluez5-codec-aptx'))
+     summary({'aptX': aptx_dep.found()}, bool_yn: true, section: 'Bluetooth audio codecs')
+     fdk_aac_dep = dependency('fdk-aac', required : get_option('bluez5-codec-aac'))
+     summary({'AAC': fdk_aac_dep.found()}, bool_yn: true, section: 'Bluetooth audio codecs')
+-- 
+2.32.0
+
diff --git a/media-video/pipewire/files/pipewire-launcher.sh b/media-video/pipewire/files/pipewire-launcher.sh
new file mode 100644
index 00000000..ecff3e7e
--- /dev/null
+++ b/media-video/pipewire/files/pipewire-launcher.sh
@@ -0,0 +1,6 @@
+#!/bin/sh
+
+# We need to kill any existing pipewire instance to restore sound
+pkill -u "${USER}" -x pipewire 1>/dev/null 2>&1
+
+exec /usr/bin/pipewire
diff --git a/media-video/pipewire/files/pipewire.desktop b/media-video/pipewire/files/pipewire.desktop
new file mode 100644
index 00000000..d3786e74
--- /dev/null
+++ b/media-video/pipewire/files/pipewire.desktop
@@ -0,0 +1,12 @@
+[Desktop Entry]
+Version=1.0
+Name[de]=PipeWire Mediensystem
+Name=PipeWire Media System
+Comment[de]=Das PipeWire Mediensystem starten
+Comment=Start the PipeWire Media System
+Exec=/usr/libexec/pipewire-launcher
+Terminal=false
+Type=Application
+X-GNOME-HiddenUnderSystemd=true
+X-KDE-HiddenUnderSystemd=true
+X-systemd-skip=true
diff --git a/media-video/pipewire/metadata.xml b/media-video/pipewire/metadata.xml
new file mode 100644
index 00000000..f36452d6
--- /dev/null
+++ b/media-video/pipewire/metadata.xml
@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd">
+<pkgmetadata>
+	<maintainer type="project">
+		<email>gnome@gentoo.org</email>
+		<name>Gentoo GNOME Desktop</name>
+	</maintainer>
+	<maintainer type="person">
+		<email>asturm@gentoo.org</email>
+		<name>Andreas Sturmlechner</name>
+	</maintainer>
+	<maintainer type="person">
+		<email>whissi@gentoo.org</email>
+		<name>Thomas Deutschmann</name>
+	</maintainer>
+	<upstream>
+		<bugs-to>https://gitlab.freedesktop.org/pipewire/pipewire/-/issues</bugs-to>
+		<changelog>https://gitlab.freedesktop.org/pipewire/pipewire/-/releases</changelog>
+		<doc>https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/home</doc>
+	</upstream>
+	<use>
+		<flag name="aac">AAC over Bluetooth (iPhone compatible headphones)</flag>
+		<flag name="alsa">Whether to depend on pulseaudio plugin for alsa when not using pipewire-alsa</flag>
+		<flag name="aptx">aptX (HD) over Bluetooth (many Android compatible headphones)</flag>
+		<flag name="extra">Build pw-cat/pw-play/pw-record</flag>
+		<flag name="ffmpeg">Builds an unsupported SPA (file a Gentoo bug if you need this)</flag>
+		<flag name="jack">Enable SPA JACK plugin and emulation to be able to run JACK applications on top of PipeWire</flag>
+		<flag name="jack-client">Install a plugin for running PipeWire as a JACK client</flag>
+		<flag name="jack-sdk">Use PipeWire as JACK replacement</flag>
+		<flag name="ldac">LDAC over Bluetooth (primarily Sony headphones)</flag>
+		<flag name="pipewire-alsa">Replace PulseAudio's ALSA plugin with PipeWire's plugin</flag>
+		<flag name="vulkan">Uses Vulkan compute shaders to provide a CGI video source</flag>
+	</use>
+</pkgmetadata>
diff --git a/media-video/pipewire/pipewire-0.3.32.ebuild b/media-video/pipewire/pipewire-0.3.32.ebuild
new file mode 100644
index 00000000..4da2d2a5
--- /dev/null
+++ b/media-video/pipewire/pipewire-0.3.32.ebuild
@@ -0,0 +1,272 @@
+# Copyright 1999-2021 Gentoo Authors
+# Distributed under the terms of the GNU General Public License v2
+
+EAPI="7"
+
+PYTHON_COMPAT=( python3_{7..10} )
+
+inherit meson-multilib optfeature python-any-r1 udev
+
+if [[ ${PV} == 9999 ]]; then
+	EGIT_REPO_URI="https://gitlab.freedesktop.org/${PN}/${PN}.git"
+	inherit git-r3
+else
+	SRC_URI="https://gitlab.freedesktop.org/${PN}/${PN}/-/archive/${PV}/${P}.tar.gz"
+	KEYWORDS="amd64 arm arm64 ~ppc ~ppc64 x86"
+fi
+
+DESCRIPTION="Multimedia processing graphs"
+HOMEPAGE="https://pipewire.org/"
+
+LICENSE="MIT LGPL-2.1+ GPL-2"
+SLOT="0/0.3"
+IUSE="alsa bluetooth doc extra gstreamer jack-client jack-sdk pipewire-alsa systemd test v4l"
+
+# Once replacing system JACK libraries is possible, it's likely that
+# jack-client IUSE will need blocking to avoid users accidentally
+# configuring their systems to send PW sink output to the emulated
+# JACK's sink - doing so is likely to yield no audio, cause a CPU
+# cycles consuming loop (and may even cause GUI crashes)!
+
+REQUIRED_USE="jack-sdk? ( !jack-client )"
+
+RESTRICT="!test? ( test )"
+
+BDEPEND="
+	app-doc/xmltoman
+	virtual/pkgconfig
+	${PYTHON_DEPS}
+	doc? (
+		app-doc/doxygen
+		media-gfx/graphviz
+	)
+"
+RDEPEND="
+	acct-group/audio
+	media-libs/alsa-lib
+	sys-apps/dbus[${MULTILIB_USEDEP}]
+	sys-libs/ncurses:=[unicode(+)]
+	virtual/libintl[${MULTILIB_USEDEP}]
+	virtual/libudev[${MULTILIB_USEDEP}]
+	bluetooth? (
+		media-libs/fdk-aac
+		media-libs/libldac
+		media-libs/libopenaptx
+		media-libs/sbc
+		>=net-wireless/bluez-4.101:=
+	)
+	extra? (
+		>=media-libs/libsndfile-1.0.20
+	)
+	gstreamer? (
+		>=dev-libs/glib-2.32.0:2
+		>=media-libs/gstreamer-1.10.0:1.0
+		media-libs/gst-plugins-base:1.0
+	)
+	jack-client? ( >=media-sound/jack2-1.9.10:2[dbus] )
+	jack-sdk? (
+		!media-sound/jack-audio-connection-kit
+		!media-sound/jack2
+	)
+	pipewire-alsa? (
+		>=media-libs/alsa-lib-1.1.7[${MULTILIB_USEDEP}]
+		|| (
+			media-plugins/alsa-plugins[-pulseaudio]
+			!media-plugins/alsa-plugins
+		)
+	)
+	!pipewire-alsa? ( alsa? ( media-plugins/alsa-plugins[${MULTILIB_USEDEP},pulseaudio] ) )
+	systemd? ( sys-apps/systemd )
+	v4l? ( media-libs/libv4l )
+"
+
+DEPEND="${RDEPEND}"
+
+# Present RDEPEND that are currently always disabled due to the PW
+# code using them being required to be disabled by Gentoo guidelines
+# (i.e. developer binaries not meant for users) and unready code
+#	media-video/ffmpeg:=
+#	media-libs/libsdl2
+#	>=media-libs/vulkan-loader-1.1.69
+#
+# Ditto for DEPEND
+#	>=dev-util/vulkan-headers-1.1.69
+
+DOCS=( {README,INSTALL}.md NEWS )
+
+PATCHES=(
+	"${FILESDIR}"/${PN}-0.3.25-enable-failed-mlock-warning.patch
+	"${FILESDIR}"/${PN}-0.3.31-revert-openaptx-restriction.patch
+)
+
+# limitsdfile related code taken from =sys-auth/realtime-base-0.1
+# with changes as necessary.
+limitsdfile=40-${PN}.conf
+
+src_prepare() {
+	default
+
+	if ! use systemd; then
+		# This can be applied non-conditionally but would make for a
+		# significantly worse user experience on systemd then.
+		eapply "${FILESDIR}"/${PN}-0.3.31-non-systemd-integration.patch
+	fi
+
+	einfo "Generating ${limitsdfile}"
+	cat > ${limitsdfile} <<- EOF || die
+		# Start of ${limitsdfile} from ${P}
+
+		@audio	-	memlock 256
+
+		# End of ${limitsdfile} from ${P}
+	EOF
+}
+
+multilib_src_configure() {
+	local emesonargs=(
+		-Ddocdir="${EPREFIX}"/usr/share/doc/${PF}
+		$(meson_native_use_feature doc docs)
+		$(meson_native_enabled examples) # Disabling this implicitly disables -Dmedia-session
+		$(meson_native_enabled media-session)
+		$(meson_native_enabled man)
+		$(meson_feature test tests)
+		-Dinstalled_tests=disabled # Matches upstream; Gentoo never installs tests
+		$(meson_native_use_feature gstreamer)
+		$(meson_native_use_feature gstreamer gstreamer-device-provider)
+		$(meson_native_use_feature systemd)
+		-Dsystemd-system-service=disabled # Matches upstream
+		$(meson_native_use_feature systemd systemd-user-service)
+		$(meson_feature pipewire-alsa) # Allows integrating ALSA apps into PW graph
+		-Dspa-plugins=enabled
+		-Dalsa=enabled # Allows using kernel ALSA for sound I/O (-Dmedia-session depends on this)
+		-Daudiomixer=enabled # Matches upstream
+		-Daudioconvert=enabled # Matches upstream
+		$(meson_native_use_feature bluetooth bluez5)
+		$(meson_native_use_feature bluetooth bluez5-backend-hsp-native)
+		$(meson_native_use_feature bluetooth bluez5-backend-hfp-native)
+		$(meson_native_use_feature bluetooth bluez5-backend-ofono)
+		$(meson_native_use_feature bluetooth bluez5-backend-hsphfpd)
+		$(meson_native_use_feature bluetooth bluez5-codec-aac)
+		$(meson_native_use_feature bluetooth bluez5-codec-aptx)
+		$(meson_native_use_feature bluetooth bluez5-codec-ldac)
+		-Dcontrol=enabled # Matches upstream
+		-Daudiotestsrc=enabled # Matches upstream
+		-Dffmpeg=disabled # Disabled by upstream and no major developments to spa/plugins/ffmpeg/ since May 2020
+		-Dpipewire-jack=enabled # Allows integrating JACK apps into PW graph
+		$(meson_native_use_feature jack-client jack) # Allows PW to act as a JACK client
+		$(meson_feature jack-sdk jack-devel)
+		$(usex jack-sdk "-Dlibjack-path=${EPREFIX}/usr/$(get_libdir)" '')
+		-Dsupport=enabled # Miscellaneous/common plugins, such as null sink
+		-Devl=disabled # Matches upstream
+		-Dtest=disabled # fakesink and fakesource plugins
+		$(meson_native_use_feature v4l v4l2)
+		-Dlibcamera=disabled # libcamera is not in Portage tree
+		-Dvideoconvert=enabled # Matches upstream
+		-Dvideotestsrc=enabled # Matches upstream
+		-Dvolume=enabled # Matches upstream
+		-Dvulkan=disabled # Uses pre-compiled Vulkan compute shader to provide a CGI video source (dev thing; disabled by upstream)
+		$(meson_native_use_feature extra pw-cat)
+		-Dudev=enabled
+		-Dudevrulesdir="${EPREFIX}$(get_udevdir)/rules.d"
+		-Dsdl2=disabled # Controls SDL2 dependent code (currently only examples when -Dinstalled_tests=enabled which we never install)
+		$(meson_native_use_feature extra sndfile) # Enables libsndfile dependent code (currently only pw-cat)
+	)
+
+	meson_src_configure
+}
+
+multilib_src_install() {
+	# Our customs DOCS do not exist in multilib source directory
+	DOCS= meson_src_install
+}
+
+multilib_src_install_all() {
+	einstalldocs
+
+	insinto /etc/security/limits.d
+	doins ${limitsdfile}
+
+	if use pipewire-alsa; then
+		dodir /etc/alsa/conf.d
+		# These will break if someone has /etc that is a symbol link to a subfolder! See #724222
+		# And the current dosym8 -r implementation is likely affected by the same issue, too.
+		dosym ../../../usr/share/alsa/alsa.conf.d/50-pipewire.conf /etc/alsa/conf.d/50-pipewire.conf
+		dosym ../../../usr/share/alsa/alsa.conf.d/99-pipewire-default.conf /etc/alsa/conf.d/99-pipewire-default.conf
+	fi
+
+	if ! use systemd; then
+		insinto /etc/xdg/autostart
+		newins "${FILESDIR}"/pipewire.desktop pipewire.desktop
+
+		exeinto /usr/libexec
+		newexe "${FILESDIR}"/pipewire-launcher.sh pipewire-launcher
+	fi
+}
+
+pkg_postinst() {
+	elog "It is recommended to raise RLIMIT_MEMLOCK to 256 for users"
+	elog "using PipeWire. Do it either manually or add yourself"
+	elog "to the 'audio' group:"
+	elog
+	elog "  usermod -aG audio <youruser>"
+	elog
+
+	if ! use jack-sdk; then
+		elog "JACK emulation is incomplete and not all programs will work. PipeWire's"
+		elog "alternative libraries have been installed to a non-default location."
+		elog "To use them, put pw-jack <application> before every JACK application."
+		elog "When using pw-jack, do not run jackd/jackdbus. However, a virtual/jack"
+		elog "provider is still needed to compile the JACK applications themselves."
+		elog
+	fi
+
+	if use systemd; then
+		elog "To use PipeWire for audio, the user units must be manually enabled:"
+		elog
+		elog "  systemctl --user enable pipewire.socket pipewire-pulse.socket"
+		elog
+		elog "When switching from PulseAudio, do not forget to disable PulseAudio:"
+		elog
+		elog "  systemctl --user disable pulseaudio.service pulseaudio.socket"
+		elog
+		elog "A reboot is recommended to avoid interferences from still running"
+		elog "PulseAudio daemon."
+		elog
+		elog "Both, new users and those upgrading, need to enable pipewire-media-session:"
+		elog
+		elog "  systemctl --user enable pipewire-media-session.service"
+		elog
+	else
+		elog "This ebuild auto-enables PulseAudio replacement. Because of that, users"
+		elog "are recommended to edit: ${EROOT}/etc/pulse/client.conf and disable "
+		elog "autospawn'ing of the original daemon by setting:"
+		elog
+		elog "  autospawn = no"
+		elog
+		elog "Please note that the semicolon (;) must _NOT_ be at the beginning of the line!"
+		elog
+		elog "Alternatively, if replacing PulseAudio daemon is not desired, edit"
+		elog "${EROOT}/etc/pipewire/pipewire.conf by commenting out the relevant"
+		elog "command near the end of the file:"
+		elog
+		elog "#\"/usr/bin/pipewire\" = { args = \"-c pipewire-pulse.conf\" }"
+		elog
+		elog "NOTE:"
+		elog "Starting with PipeWire-0.3.30, package is no longer installing config"
+		elog "into ${EROOT}/etc/pipewire by default. In case you need to change"
+		elog "config, please start by copying default config from ${EROOT}/usr/share/pipewire"
+		elog "and just override sections you want to change."
+	fi
+
+	elog "For latest tips and tricks, troubleshooting information and documentation"
+	elog "in general, please refer to https://wiki.gentoo.org/wiki/PipeWire"
+	elog
+
+	optfeature_header "The following can be installed for optional runtime features:"
+	optfeature "restricted realtime capabilities vai D-Bus" sys-auth/rtkit
+	# Once hsphfpd lands in tree, both it and ofono will need to be checked for presence here!
+	if use bluetooth; then
+		optfeature "better BT headset support (daemon startup required)" net-misc/ofono
+		#optfeature "an oFono alternative (not packaged)" foo-bar/hsphfpd
+	fi
+}