public inbox for gentoo-commits@lists.gentoo.org
 help / color / mirror / Atom feed
* [gentoo-commits] repo/gentoo:master commit in: media-video/pipewire/files/0.3.80/, media-video/pipewire/
@ 2023-09-15  4:33 Sam James
  0 siblings, 0 replies; only message in thread
From: Sam James @ 2023-09-15  4:33 UTC (permalink / raw
  To: gentoo-commits

commit:     2a1c7e22db6217616c18b145754e7ce7b4b0ff73
Author:     Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Fri Sep 15 04:21:05 2023 +0000
Commit:     Sam James <sam <AT> gentoo <DOT> org>
CommitDate: Fri Sep 15 04:33:09 2023 +0000
URL:        https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=2a1c7e22

media-video/pipewire: add 0.3.80

Note that this includes an extra backported patch to work with older webrtc
for now, although it's somewhat automagic based on if you have the (masked)
SLOT=1 installed for media-libs/webrtc-audio-processing.

Bug: https://bugs.gentoo.org/913693
Signed-off-by: Sam James <sam <AT> gentoo.org>

 media-video/pipewire/Manifest                      |   1 +
 .../0001-aes-support-both-webrtc-versions.patch    | 233 ++++++++++
 media-video/pipewire/pipewire-0.3.80.ebuild        | 475 +++++++++++++++++++++
 3 files changed, 709 insertions(+)

diff --git a/media-video/pipewire/Manifest b/media-video/pipewire/Manifest
index 49e8bcc2eabb..2b9157523e57 100644
--- a/media-video/pipewire/Manifest
+++ b/media-video/pipewire/Manifest
@@ -2,3 +2,4 @@ DIST pipewire-0.3.75.tar.bz2 1629466 BLAKE2B e69dbb93ebe50f037bc602aa86733c8ba9c
 DIST pipewire-0.3.77.tar.bz2 1643767 BLAKE2B 3a2df9cdedf77d5b4927e115ddd7da0d1eecc85322ce7995a49945d41cc83b9a543c1382ad304bdb549f67ac444f7bca6871248654fb4d2e21b25eb55411940c SHA512 422c8504f608d6845b94351a336ab528f51195551418d0d245064972ed784817cacafc6afaad74eb0e0ea80474a9da33ef6917c1f60d3f8f45d70c54971f0760
 DIST pipewire-0.3.78.tar.bz2 1643536 BLAKE2B 44e04486850b0c68cea42ef911eaffae4c22bdedeff0783c119409d2e8d528c165f1f46f0a0e8b63e1c46cf8535b52b79291b54dd61496c6275c6e41f9d71edd SHA512 2fe0113eaaba1ffe67d20cf10b9ee927cb2bfc7c2663937b131f479d35ca6af43b5659cf8a16db849ecc5881e47a56507e775aad06e9765a3ab8ec354636f8eb
 DIST pipewire-0.3.79.tar.bz2 1647590 BLAKE2B dd7c88219310c77fd5b64cbfa4ab8130d81c47ff3a35c03ecfd260bc1e7e24fb108b5100bdbc977e3cd8e74ccfe90c11310b195e804a7fe04a64e1d1637c7233 SHA512 5853d4d9d0c21265e0fc0fd68369530d76ae63bad1aa28f6eaa4a0f76e5c939ffc0dee2d81fdf0526da3473f69bddcdb77938597ad004abe04c842d798409b1d
+DIST pipewire-0.3.80.tar.bz2 1655137 BLAKE2B cf55e01b6fff29e7ef1f40e9a8f28788b9f538380232821b334359844b33b12b913375ae14e4589d7ae9cd26d22bc841d8103d41c7eb3ea1a9f0c1db1abc6507 SHA512 77e26b6cbefc091ea703b53d147accbd9495f97ba57618a21366b0747074de3ed1060c03e91362f5cf9dc5c256da6d541eccaff8de306b369730400c7b7f46b2

diff --git a/media-video/pipewire/files/0.3.80/0001-aes-support-both-webrtc-versions.patch b/media-video/pipewire/files/0.3.80/0001-aes-support-both-webrtc-versions.patch
new file mode 100644
index 000000000000..f2afdde4f4be
--- /dev/null
+++ b/media-video/pipewire/files/0.3.80/0001-aes-support-both-webrtc-versions.patch
@@ -0,0 +1,233 @@
+https://bugs.gentoo.org/913693
+https://gitlab.freedesktop.org/pipewire/pipewire/-/commit/1f1c308c9766312e684f0b53fc2d1422c7414d31
+
+From 1f1c308c9766312e684f0b53fc2d1422c7414d31 Mon Sep 17 00:00:00 2001
+From: Wim Taymans <wtaymans@redhat.com>
+Date: Thu, 14 Sep 2023 15:35:40 +0200
+Subject: [PATCH] aec: support both webrtc versions
+
+Version 1 does not seem to be packaged in many distros and so they would
+need to revert the patch or disable AEC. Enabling both allows for things
+to move forwards gracefully.
+--- a/meson.build
++++ b/meson.build
+@@ -377,9 +377,17 @@ cdata.set('HAVE_GSTREAMER_DEVICE_PROVIDER', get_option('gstreamer-device-provide
+ 
+ webrtc_dep = dependency('webrtc-audio-processing-1',
+   version : ['>= 1.2' ],
+-  required : get_option('echo-cancel-webrtc'))
+-summary({'WebRTC Echo Canceling': webrtc_dep.found()}, bool_yn: true, section: 'Misc dependencies')
+-cdata.set('HAVE_WEBRTC', webrtc_dep.found())
++  required : false)
++cdata.set('HAVE_WEBRTC1', webrtc_dep.found())
++if webrtc_dep.found()
++  summary({'WebRTC Echo Canceling >= 1.2': webrtc_dep.found()}, bool_yn: true, section: 'Misc dependencies')
++else
++  webrtc_dep = dependency('webrtc-audio-processing',
++    version : ['>= 0.2', '< 1.0'],
++    required : get_option('echo-cancel-webrtc'))
++  cdata.set('HAVE_WEBRTC', webrtc_dep.found())
++  summary({'WebRTC Echo Canceling < 1.0': webrtc_dep.found()}, bool_yn: true, section: 'Misc dependencies')
++endif
+ 
+ # On FreeBSD and MidnightBSD, epoll-shim library is required for eventfd() and timerfd()
+ epoll_shim_dep = (host_machine.system() == 'freebsd' or host_machine.system() == 'midnightbsd'
+--- a/spa/plugins/aec/aec-webrtc.cpp
++++ b/spa/plugins/aec/aec-webrtc.cpp
+@@ -3,6 +3,8 @@
+ /* SPDX-FileCopyrightText: Copyright © 2021 Arun Raghavan <arun@asymptotic.io> */
+ /* SPDX-License-Identifier: MIT */
+ 
++#include "config.h"
++
+ #include <memory>
+ #include <utility>
+ 
+@@ -13,7 +15,13 @@
+ #include <spa/utils/json.h>
+ #include <spa/support/plugin.h>
+ 
++#ifdef HAVE_WEBRTC
++#include <webrtc/modules/audio_processing/include/audio_processing.h>
++#include <webrtc/modules/interface/module_common_types.h>
++#include <webrtc/system_wrappers/include/trace.h>
++#else
+ #include <modules/audio_processing/include/audio_processing.h>
++#endif
+ 
+ struct impl_data {
+ 	struct spa_handle handle;
+@@ -39,6 +47,54 @@ static bool webrtc_get_spa_bool(const struct spa_dict *args, const char *key, bo
+ 	return default_value;
+ }
+ 
++#ifdef HAVE_WEBRTC
++/* [ f0 f1 f2 ] */
++static int parse_point(struct spa_json *it, float (&f)[3])
++{
++	struct spa_json arr;
++	int i, res;
++
++	if (spa_json_enter_array(it, &arr) <= 0)
++		return -EINVAL;
++
++	for (i = 0; i < 3; i++) {
++		if ((res = spa_json_get_float(&arr, &f[i])) <= 0)
++			return -EINVAL;
++	}
++	return 0;
++}
++
++/* [ point1 point2 ... ] */
++static int parse_mic_geometry(struct impl_data *impl, const char *mic_geometry,
++		std::vector<webrtc::Point>& geometry)
++{
++	int res;
++	size_t i;
++	struct spa_json it[2];
++
++	spa_json_init(&it[0], mic_geometry, strlen(mic_geometry));
++	if (spa_json_enter_array(&it[0], &it[1]) <= 0) {
++		spa_log_error(impl->log, "Error: webrtc.mic-geometry expects an array");
++		return -EINVAL;
++	}
++
++	for (i = 0; i < geometry.size(); i++) {
++		float f[3];
++
++		if ((res = parse_point(&it[1], f)) < 0) {
++			spa_log_error(impl->log, "Error: can't parse webrtc.mic-geometry points: %d", res);
++			return res;
++		}
++
++		spa_log_info(impl->log, "mic %zd position: (%g %g %g)", i, f[0], f[1], f[2]);
++		geometry[i].c[0] = f[0];
++		geometry[i].c[1] = f[1];
++		geometry[i].c[2] = f[2];
++	}
++	return 0;
++}
++#endif
++
+ static int webrtc_init2(void *object, const struct spa_dict *args,
+ 		struct spa_audio_info_raw *rec_info, struct spa_audio_info_raw *out_info,
+ 		struct spa_audio_info_raw *play_info)
+@@ -48,9 +104,18 @@ static int webrtc_init2(void *object, const struct spa_dict *args,
+ 
+ 	bool high_pass_filter = webrtc_get_spa_bool(args, "webrtc.high_pass_filter", true);
+ 	bool noise_suppression = webrtc_get_spa_bool(args, "webrtc.noise_suppression", true);
+-	bool transient_suppression = webrtc_get_spa_bool(args, "webrtc.transient_suppression", true);
+ 	bool voice_detection = webrtc_get_spa_bool(args, "webrtc.voice_detection", true);
+-
++#ifdef HAVE_WEBRTC
++	bool extended_filter = webrtc_get_spa_bool(args, "webrtc.extended_filter", true);
++	bool delay_agnostic = webrtc_get_spa_bool(args, "webrtc.delay_agnostic", true);
++	// Disable experimental flags by default
++	bool experimental_agc = webrtc_get_spa_bool(args, "webrtc.experimental_agc", false);
++	bool experimental_ns = webrtc_get_spa_bool(args, "webrtc.experimental_ns", false);
++
++	bool beamforming = webrtc_get_spa_bool(args, "webrtc.beamforming", false);
++#else
++	bool transient_suppression = webrtc_get_spa_bool(args, "webrtc.transient_suppression", true);
++#endif
+ 	// Note: AGC seems to mess up with Agnostic Delay Detection, especially with speech,
+ 	// result in very poor performance, disable by default
+ 	bool gain_control = webrtc_get_spa_bool(args, "webrtc.gain_control", false);
+@@ -59,6 +124,51 @@ static int webrtc_init2(void *object, const struct spa_dict *args,
+ 	// This filter will modify playback buffer (when calling ProcessReverseStream), but now
+ 	// playback buffer modifications are discarded.
+ 
++#ifdef HAVE_WEBRTC
++	webrtc::Config config;
++	config.Set<webrtc::ExtendedFilter>(new webrtc::ExtendedFilter(extended_filter));
++	config.Set<webrtc::DelayAgnostic>(new webrtc::DelayAgnostic(delay_agnostic));
++	config.Set<webrtc::ExperimentalAgc>(new webrtc::ExperimentalAgc(experimental_agc));
++	config.Set<webrtc::ExperimentalNs>(new webrtc::ExperimentalNs(experimental_ns));
++
++	if (beamforming) {
++		std::vector<webrtc::Point> geometry(rec_info->channels);
++		const char *mic_geometry, *target_direction;
++
++		/* The beamformer gives a single mono channel */
++		out_info->channels = 1;
++		out_info->position[0] = SPA_AUDIO_CHANNEL_MONO;
++
++		if ((mic_geometry = spa_dict_lookup(args, "webrtc.mic-geometry")) == NULL) {
++			spa_log_error(impl->log, "Error: webrtc.beamforming requires webrtc.mic-geometry");
++			return -EINVAL;
++		}
++
++		if ((res = parse_mic_geometry(impl, mic_geometry, geometry)) < 0)
++			return res;
++
++		if ((target_direction = spa_dict_lookup(args, "webrtc.target-direction")) != NULL) {
++			webrtc::SphericalPointf direction(0.0f, 0.0f, 0.0f);
++			struct spa_json it;
++			float f[3];
++
++			spa_json_init(&it, target_direction, strlen(target_direction));
++			if (parse_point(&it, f) < 0) {
++				spa_log_error(impl->log, "Error: can't parse target-direction %s",
++						target_direction);
++				return -EINVAL;
++			}
++
++			direction.s[0] = f[0];
++			direction.s[1] = f[1];
++			direction.s[2] = f[2];
++
++			config.Set<webrtc::Beamforming>(new webrtc::Beamforming(true, geometry, direction));
++		} else {
++			config.Set<webrtc::Beamforming>(new webrtc::Beamforming(true, geometry));
++		}
++	}
++#else
+ 	webrtc::AudioProcessing::Config config;
+ 	config.echo_canceller.enabled = true;
+ 	// FIXME: Example code enables both gain controllers, but that seems sus
+@@ -73,6 +183,7 @@ static int webrtc_init2(void *object, const struct spa_dict *args,
+ 	// FIXME: expose pre/postamp gain
+ 	config.transient_suppression.enabled = transient_suppression;
+ 	config.voice_detection.enabled = voice_detection;
++#endif
+ 
+ 	webrtc::ProcessingConfig pconfig = {{
+ 		webrtc::StreamConfig(rec_info->rate, rec_info->channels, false), /* input stream */
+@@ -81,15 +192,35 @@ static int webrtc_init2(void *object, const struct spa_dict *args,
+ 		webrtc::StreamConfig(play_info->rate, play_info->channels, false), /* reverse output stream */
+ 	}};
+ 
++#ifdef HAVE_WEBRTC
++	auto apm = std::unique_ptr<webrtc::AudioProcessing>(webrtc::AudioProcessing::Create(config));
++#else
+ 	auto apm = std::unique_ptr<webrtc::AudioProcessing>(webrtc::AudioProcessingBuilder().Create());
+ 
+ 	apm->ApplyConfig(config);
++#endif
+ 
+ 	if ((res = apm->Initialize(pconfig)) != webrtc::AudioProcessing::kNoError) {
+ 		spa_log_error(impl->log, "Error initialising webrtc audio processing module: %d", res);
+ 		return -EINVAL;
+ 	}
+ 
++#ifdef HAVE_WEBRTC
++	apm->high_pass_filter()->Enable(high_pass_filter);
++	// Always disable drift compensation since PipeWire will already do
++	// drift compensation on all sinks and sources linked to this echo-canceler
++	apm->echo_cancellation()->enable_drift_compensation(false);
++	apm->echo_cancellation()->Enable(true);
++	// TODO: wire up supression levels to args
++	apm->echo_cancellation()->set_suppression_level(webrtc::EchoCancellation::kHighSuppression);
++	apm->noise_suppression()->set_level(webrtc::NoiseSuppression::kHigh);
++	apm->noise_suppression()->Enable(noise_suppression);
++	apm->voice_detection()->Enable(voice_detection);
++	// TODO: wire up AGC parameters to args
++	apm->gain_control()->set_analog_level_limits(0, 255);
++	apm->gain_control()->set_mode(webrtc::GainControl::kAdaptiveDigital);
++	apm->gain_control()->Enable(gain_control);
++#endif
+ 	impl->apm = std::move(apm);
+ 	impl->rec_info = *rec_info;
+ 	impl->out_info = *out_info;
+-- 
+GitLab

diff --git a/media-video/pipewire/pipewire-0.3.80.ebuild b/media-video/pipewire/pipewire-0.3.80.ebuild
new file mode 100644
index 000000000000..7a471fb632bf
--- /dev/null
+++ b/media-video/pipewire/pipewire-0.3.80.ebuild
@@ -0,0 +1,475 @@
+# Copyright 1999-2023 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/pipewire/tree/rawhide.
+#
+# 2. Upstream also sometimes amend release notes for the previous release to mention
+# needed patches, e.g. https://gitlab.freedesktop.org/pipewire/pipewire/-/tags/0.3.55#distros
+#
+# 3. 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.
+
+PYTHON_COMPAT=( python3_{10..12} )
+
+inherit flag-o-matic meson-multilib optfeature prefix python-any-r1 systemd tmpfiles udev
+
+if [[ ${PV} == 9999 ]]; then
+	EGIT_REPO_URI="https://gitlab.freedesktop.org/${PN}/${PN}.git"
+	inherit git-r3
+else
+	if [[ ${PV} == *_p* ]] ; then
+		MY_COMMIT=""
+		SRC_URI="https://gitlab.freedesktop.org/pipewire/pipewire/-/archive/${MY_COMMIT}/pipewire-${MY_COMMIT}.tar.bz2 -> ${P}.tar.bz2"
+		S="${WORKDIR}"/${PN}-${MY_COMMIT}
+	else
+		SRC_URI="https://gitlab.freedesktop.org/${PN}/${PN}/-/archive/${PV}/${P}.tar.bz2"
+	fi
+
+	KEYWORDS="~amd64 ~arm ~arm64 ~loong ~ppc ~ppc64 ~riscv ~sparc ~x86"
+fi
+
+DESCRIPTION="Multimedia processing graphs"
+HOMEPAGE="https://pipewire.org/"
+
+LICENSE="MIT LGPL-2.1+ GPL-2"
+# ABI was broken in 0.3.42 for https://gitlab.freedesktop.org/pipewire/wireplumber/-/issues/49
+SLOT="0/0.4"
+IUSE="bluetooth dbus doc echo-cancel extra ffmpeg flatpak gstreamer gsettings ieee1394 jack-client jack-sdk liblc3 lv2"
+IUSE+=" modemmanager pipewire-alsa readline roc sound-server ssl system-service systemd test v4l X zeroconf"
+
+# 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)!
+
+# - TODO: There should be "sound-server? ( || ( alsa bluetooth ) )" here, but ALSA is always enabled
+# - TODO: Pulseaudio alsa plugin performs runtime check that pulseaudio server connection will work
+#   which provides adequate guarantee that alsa-lib will be able to provide audio services.
+#   If that works, pulseaudio defaults are loaded into alsa-lib runtime replacing default PCM and CTL.
+#   When pipewire-alsa will be able to perform similar check, pipewire-alsa can be enabled unconditionally.
+# - ffmpeg is only used for pw-cat. We don't build the spa plugin which receives barely any activity.
+REQUIRED_USE="
+	ffmpeg? ( extra )
+	bluetooth? ( dbus )
+	jack-sdk? ( !jack-client )
+	modemmanager? ( bluetooth )
+	system-service? ( systemd )
+	!sound-server? ( !pipewire-alsa )
+	jack-client? ( dbus )
+"
+
+RESTRICT="!test? ( test )"
+
+BDEPEND="
+	>=dev-util/meson-0.59
+	virtual/pkgconfig
+	${PYTHON_DEPS}
+	$(python_gen_any_dep 'dev-python/docutils[${PYTHON_USEDEP}]')
+	dbus? ( dev-util/gdbus-codegen )
+	doc? (
+		app-doc/doxygen
+		media-gfx/graphviz
+	)
+"
+# While udev could technically be optional, it's needed for a numebr of options,
+# and not really worth it, bug #877769.
+RDEPEND="
+	acct-group/audio
+	acct-group/pipewire
+	media-libs/alsa-lib
+	sys-libs/ncurses:=[unicode(+)]
+	virtual/libintl[${MULTILIB_USEDEP}]
+	virtual/libudev[${MULTILIB_USEDEP}]
+	bluetooth? (
+		dev-libs/glib
+		media-libs/fdk-aac
+		media-libs/libldac
+		media-libs/libfreeaptx
+		media-libs/opus
+		media-libs/sbc
+		>=net-wireless/bluez-4.101:=
+		virtual/libusb:1
+	)
+	dbus? ( sys-apps/dbus[${MULTILIB_USEDEP}] )
+	echo-cancel? ( media-libs/webrtc-audio-processing:0 )
+	extra? ( >=media-libs/libsndfile-1.0.20 )
+	ffmpeg? ( media-video/ffmpeg:= )
+	flatpak? ( dev-libs/glib )
+	gstreamer? (
+		>=dev-libs/glib-2.32.0:2
+		>=media-libs/gstreamer-1.10.0:1.0
+		media-libs/gst-plugins-base:1.0
+	)
+	gsettings? ( >=dev-libs/glib-2.26.0:2 )
+	ieee1394? ( media-libs/libffado[${MULTILIB_USEDEP}] )
+	jack-client? ( >=media-sound/jack2-1.9.10:2[dbus] )
+	jack-sdk? (
+		!media-sound/jack-audio-connection-kit
+		!media-sound/jack2
+	)
+	liblc3? ( media-sound/liblc3 )
+	lv2? ( media-libs/lilv )
+	modemmanager? ( >=net-misc/modemmanager-1.10.0 )
+	pipewire-alsa? ( >=media-libs/alsa-lib-1.1.7[${MULTILIB_USEDEP}] )
+	sound-server? ( !media-sound/pulseaudio-daemon )
+	roc? ( media-libs/roc-toolkit )
+	readline? ( sys-libs/readline:= )
+	ssl? ( dev-libs/openssl:= )
+	systemd? ( sys-apps/systemd )
+	system-service? ( acct-user/pipewire )
+	v4l? ( media-libs/libv4l )
+	X? (
+		media-libs/libcanberra
+		x11-libs/libX11
+		x11-libs/libXfixes
+	)
+	zeroconf? ( net-dns/avahi )
+"
+
+DEPEND="${RDEPEND}"
+
+# TODO: Consider use cases where pipewire is not used for driving audio
+# Doing so with WirePlumber currently involves editing Lua scripts
+PDEPEND=">=media-video/wireplumber-0.4.8-r3"
+
+# 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-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
+)
+
+python_check_deps() {
+	python_has_version "dev-python/docutils[${PYTHON_USEDEP}]"
+}
+
+src_prepare() {
+	default
+
+	# Used for upstream backports
+	[[ -d "${FILESDIR}"/${PV} ]] && eapply "${FILESDIR}"/${PV}
+}
+
+multilib_src_configure() {
+	# https://bugs.gentoo.org/838301
+	filter-flags -fno-semantic-interposition
+
+	local emesonargs=(
+		-Ddocdir="${EPREFIX}"/usr/share/doc/${PF}
+
+		$(meson_feature dbus)
+		$(meson_native_use_feature zeroconf avahi)
+		$(meson_native_use_feature doc docs)
+		$(meson_native_enabled examples) # TODO: Figure out if this is still important now that media-session gone
+		$(meson_native_enabled man)
+		$(meson_feature test tests)
+		-Dinstalled_tests=disabled # Matches upstream; Gentoo never installs tests
+		$(meson_feature ieee1394 libffado)
+		$(meson_native_use_feature gstreamer)
+		$(meson_native_use_feature gstreamer gstreamer-device-provider)
+		$(meson_native_use_feature gsettings)
+		$(meson_native_use_feature systemd)
+
+		$(meson_native_use_feature system-service systemd-system-service)
+		-Dsystemd-system-unit-dir="$(systemd_get_systemunitdir)"
+		-Dsystemd-user-unit-dir="$(systemd_get_userunitdir)"
+
+		$(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 (NOTE: media-session is gone so IUSE=alsa/spa_alsa/alsa-backend might be possible)
+		-Dcompress-offload=disabled # TODO: tinycompress unpackaged
+		-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)
+		# https://gitlab.freedesktop.org/pipewire/pipewire/-/merge_requests/1379
+		$(meson_native_use_feature modemmanager bluez5-backend-native-mm)
+		$(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)
+		$(meson_native_use_feature bluetooth opus)
+		$(meson_native_use_feature bluetooth bluez5-codec-opus)
+		$(meson_native_use_feature bluetooth libusb) # At least for now only used by bluez5 native (quirk detection of adapters)
+		$(meson_native_use_feature echo-cancel echo-cancel-webrtc) #807889
+		-Dcontrol=enabled # Matches upstream
+		-Daudiotestsrc=enabled # Matches upstream
+		-Dffmpeg=disabled # Disabled by upstream and no major developments to spa/plugins/ffmpeg/ since May 2020
+		$(meson_native_use_feature ffmpeg pw-cat-ffmpeg)
+		$(meson_native_use_feature flatpak)
+		-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_use 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
+		-Dbluez5-codec-lc3plus=disabled # unpackaged
+		$(meson_native_use_feature liblc3 bluez5-codec-lc3)
+		$(meson_native_use_feature lv2)
+		$(meson_native_use_feature v4l v4l2)
+		-Dlibcamera=disabled # libcamera is not in Portage tree
+		$(meson_native_use_feature roc)
+		$(meson_native_use_feature readline)
+		$(meson_native_use_feature ssl raop)
+		-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)
+		-Dlibmysofa=disabled # libmysofa is unpackaged
+		$(meson_native_use_feature extra sndfile) # Enables libsndfile dependent code (currently only pw-cat)
+		-Dsession-managers="[]" # All available session managers are now their own projects, so there's nothing to build
+
+		# We still have <5.16 kernels packaged in Gentoo and 6.1 (LTS) only
+		# just became stable, with 5.15 being the previous LTS. Many people
+		# are still on it.
+		-Dpam-defaults-install=true
+
+		# Just for bell sounds in X11 right now.
+		$(meson_native_use_feature X x11)
+		$(meson_native_use_feature X x11-xfixes)
+		$(meson_native_use_feature X libcanberra)
+	)
+
+	meson_src_configure
+}
+
+multilib_src_test() {
+	meson_src_test --timeout-multiplier 10
+}
+
+multilib_src_install() {
+	# Our custom DOCS do not exist in multilib source directory
+	DOCS= meson_src_install
+}
+
+multilib_src_install_all() {
+	einstalldocs
+
+	if use pipewire-alsa; then
+		dodir /etc/alsa/conf.d
+
+		# Install pipewire conf loader hook
+		insinto /usr/share/alsa/alsa.conf.d
+		doins "${FILESDIR}"/99-pipewire-default-hook.conf
+		eprefixify "${ED}"/usr/share/alsa/alsa.conf.d/99-pipewire-default-hook.conf
+
+		# These will break if someone has /etc that is a symbolic 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-hook.conf /etc/alsa/conf.d/99-pipewire-default-hook.conf
+	fi
+
+	# Enable required wireplumber alsa and bluez monitors
+	if use sound-server; then
+		dodir /etc/wireplumber/main.lua.d
+		echo "alsa_monitor.enabled = true" > "${ED}"/etc/wireplumber/main.lua.d/89-gentoo-sound-server-enable-alsa-monitor.lua || die
+
+		dodir /etc/wireplumber/bluetooth.lua.d
+		echo "bluez_monitor.enabled = true" > "${ED}"/etc/wireplumber/bluetooth.lua.d/89-gentoo-sound-server-enable-bluez-monitor.lua || die
+	fi
+
+	if use system-service; then
+		newtmpfiles - pipewire.conf <<-EOF || die
+			d /run/pipewire 0755 pipewire pipewire - -
+		EOF
+	fi
+
+	if ! use systemd; then
+		insinto /etc/xdg/autostart
+		newins "${FILESDIR}"/pipewire.desktop-r2 pipewire.desktop
+
+		exeinto /usr/bin
+		newexe "${FILESDIR}"/gentoo-pipewire-launcher.in-r3 gentoo-pipewire-launcher
+
+		doman "${FILESDIR}"/gentoo-pipewire-launcher.1
+
+		# Disable pipewire-pulse if sound-server is disabled.
+		if ! use sound-server ; then
+			sed -i -s '/pipewire -c pipewire-pulse.conf/s/^/#/' "${ED}"/usr/bin/gentoo-pipewire-launcher || die
+		fi
+
+		eprefixify "${ED}"/usr/bin/gentoo-pipewire-launcher
+	fi
+}
+
+pkg_postrm() {
+	udev_reload
+}
+
+pkg_preinst() {
+	HAD_SOUND_SERVER=0
+	HAD_SYSTEM_SERVICE=0
+
+	if has_version "media-video/pipewire[sound-server(-)]" ; then
+		HAD_SOUND_SERVER=1
+	fi
+
+	if has_version "media-video/pipewire[system-service(-)]" ; then
+		HAD_SYSTEM_SERVICE=1
+	fi
+}
+
+pkg_postinst() {
+	udev_reload
+
+	use system-service && tmpfiles_process pipewire.conf
+
+	local ver
+	for ver in ${REPLACING_VERSIONS} ; do
+		if has_version kde-plasma/kwin[screencast] || has_version x11-wm/mutter[screencast] ; then
+			# https://bugs.gentoo.org/908490
+			# https://gitlab.freedesktop.org/pipewire/pipewire/-/issues/3243
+			ewarn "Please restart KWin/Mutter after upgrading PipeWire."
+			ewarn "Screencasting may not work until you do."
+		fi
+
+		if ver_test ${ver} -le 0.3.66-r1 ; then
+			elog ">=pipewire-0.3.66 uses the 'pipewire' group to manage permissions"
+			elog "and limits needed to function smoothly:"
+			elog
+			elog "1. Please make sure your user is in the 'pipewire' group for"
+			elog "the best experience with realtime scheduling (PAM limits behavior)!"
+			elog "You can add your account with:"
+			elog " usermod -aG pipewire <youruser>"
+			elog
+			elog "2. For the best experience with fast user switching, it is recommended"
+			elog "that you remove your user from the 'audio' group unless you rely on the"
+			elog "audio group for device access control or ACLs.:"
+			elog " usermod -rG audio <youruser>"
+			elog
+
+			if ! use jack-sdk ; then
+				elog
+				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
+				ewarn
+				ewarn "PipeWire daemon startup has been moved to a launcher script!"
+				ewarn "Make sure that ${EROOT}/etc/pipewire/pipewire.conf either does not exist or no"
+				ewarn "longer is set to start a session manager or PulseAudio compatibility daemon (all"
+				ewarn "lines similar to '{ path = /usr/bin/pipewire*' should be commented out)"
+				ewarn
+				ewarn "Those manually starting /usr/bin/pipewire via .xinitrc or similar _must_ from"
+				ewarn "now on start ${EROOT}/usr/bin/gentoo-pipewire-launcher instead! It is highly"
+				ewarn "advised that a D-Bus user session is set up before starting the script."
+				ewarn
+			fi
+
+			if use sound-server && ( has_version 'media-sound/pulseaudio[daemon]' || has_version 'media-sound/pulseaudio-daemon' ) ; then
+				elog
+				elog "This ebuild auto-enables PulseAudio replacement. Because of that, users"
+				elog "are recommended to edit pulseaudio client configuration files:"
+				elog "${EROOT}/etc/pulse/client.conf and ${EROOT}/etc/pulse/client.conf.d/enable-autospawn.conf"
+				elog "if it exists, and disable autospawning 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}/usr/bin/gentoo-pipewire-launcher by commenting out the relevant"
+				elog "command:"
+				elog
+				elog "#${EROOT}/usr/bin/pipewire -c pipewire-pulse.conf &"
+				elog
+			fi
+
+			if has_version 'net-misc/ofono' ; then
+				ewarn "Native backend has become default. Please disable oFono via:"
+				if systemd_is_booted ; then
+					ewarn "systemctl disable ofono"
+				else
+					ewarn "rc-update delete ofono"
+				fi
+			fi
+		fi
+	done
+
+	if [[ ${HAD_SOUND_SERVER} -eq 0 || -z ${REPLACING_VERSIONS} ]] ; then
+		# TODO: We could drop most of this if we set up systemd presets?
+		# They're worth looking into because right now, the out-of-the-box experience
+		# is automatic on OpenRC, while it needs manual intervention on systemd.
+		if use sound-server && use systemd ; then
+			elog
+			elog "When switching from PulseAudio, you may need to disable PulseAudio:"
+			elog
+			elog "  systemctl --user disable pulseaudio.service pulseaudio.socket"
+			elog
+			elog "To use PipeWire, the user units must be manually enabled"
+			elog "by running this command as each user you use for desktop activities:"
+			elog
+			elog "  systemctl --user enable pipewire.socket pipewire-pulse.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 WirePlumber"
+			elog "for relevant users:"
+			elog
+			elog "  systemctl --user disable pipewire-media-session.service"
+			elog "  systemctl --user --force enable wireplumber.service"
+			elog
+			elog "Root user may replace --user with --global to change system default"
+			elog "configuration for all of the above commands."
+			elog
+		fi
+
+		if ! use sound-server ; then
+			ewarn
+			ewarn "USE=sound-server is disabled! If you want PipeWire to provide"
+			ewarn "your sound, please enable it. See the wiki at"
+			ewarn "https://wiki.gentoo.org/wiki/PipeWire#Replacing_PulseAudio"
+			ewarn "for more details."
+			ewarn
+		fi
+	fi
+
+	if use system-service && [[ ${HAD_SYSTEM_SERVICE} -eq 0 || -z ${REPLACING_VERSIONS} ]] ; then
+		ewarn
+		ewarn "You have enabled the system-service USE flag, which installs"
+		ewarn "the system-wide systemd units that enable PipeWire 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 the"
+		ewarn "box, and you are on your own with configuration."
+		ewarn
+	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 via D-Bus" sys-auth/rtkit
+
+	if use sound-server && ! use pipewire-alsa; then
+		optfeature "ALSA plugin to use PulseAudio interface for output" "media-plugins/alsa-plugins[pulseaudio]"
+	fi
+}


^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2023-09-15  4:33 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-09-15  4:33 [gentoo-commits] repo/gentoo:master commit in: media-video/pipewire/files/0.3.80/, media-video/pipewire/ Sam James

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox