[neon/backports-focal/pipewire/Neon/release-lts] debian: Install brief documentation of how to experiment with Pipewire for audio

[Simon McVittie]

Git commit a70b91c2a4af80c085c192a8642ecd5988d2b1a7 by Simon McVittie.
Committed on 29/01/2021 at 14:05.
Pushed by sitter into branch 'Neon/release-lts'.

Install brief documentation of how to experiment with Pipewire for audio

There should eventually be a pipewire-pulse package that sets up the
PulseAudio replacement automatically, and perhaps a pipewire-jack
package that does the equivalent for the JACK libraries, but these
are rather new and don't seem to be ready for general use in Debian 11.

A  +53   -0    debian/pipewire-audio-client-libraries.README.Debian
M  +2    -0    debian/pipewire-audio-client-libraries.links

https://invent.kde.org/neon/backports-focal/pipewire/commit/a70b91c2a4af80c085c192a8642ecd5988d2b1a7

diff --git a/debian/pipewire-audio-client-libraries.README.Debian b/debian/pipewire-audio-client-libraries.README.Debian
new file mode 100644
index 00000000..8d2ed251
--- /dev/null
+++ b/debian/pipewire-audio-client-libraries.README.Debian
@@ -0,0 +1,53 @@
+Using pipewire for audio
+========================
+
+pipewire in Debian is primarily intended to be used for video
+(screen sharing and remote desktop, particularly in GNOME and KDE Wayland
+sessions). However, it can also be used for audio.
+
+This is not a supported scenario for Debian 11, and is considered
+experimental.
+
+Using pipewire as a substitute for PulseAudio
+---------------------------------------------
+
+This version of pipewire can be configured to act as a per-user
+audio service, replacing PulseAudio.
+
+This is not a supported scenario for Debian 11, and is considered
+experimental.
+
+To enable this:
+
+* create an empty file /etc/pipewire/media-session.d/with-pulseaudio
+
+* copy /usr/share/doc/pipewire/examples/systemd/user/pipewire-pulse.*
+  into /etc/systemd/user/
+
+* log out and back in
+
+Using pipewire as the default ALSA output device
+------------------------------------------------
+
+ALSA clients can be configured to output via pipewire instead of
+PulseAudio or directly to ALSA.
+
+To enable this:
+
+* create an empty file /etc/pipewire/media-session.d/with-alsa
+
+* copy /usr/share/doc/pipewire/examples/alsa.conf.d/99-pipewire-default.conf
+  into /etc/alsa/conf.d/
+
+Using pipewire as a substitute for JACK
+---------------------------------------
+
+JACK clients can be configured to output via pipewire instead of JACK.
+
+To enable this:
+
+* create an empty file /etc/pipewire/media-session.d/with-jack
+
+* either run JACK clients using the pw-jack(1) wrapper, or copy
+  /usr/share/doc/pipewire/examples/ld.so.conf.d/pipewire-jack-*.conf
+  into /etc/ld.so.conf.d/ and run ldconfig as root.
diff --git a/debian/pipewire-audio-client-libraries.links b/debian/pipewire-audio-client-libraries.links
index 57066174..a90c61d2 100644
--- a/debian/pipewire-audio-client-libraries.links
+++ b/debian/pipewire-audio-client-libraries.links
@@ -1 +1,3 @@
 usr/share/alsa/alsa.conf.d/50-pipewire.conf etc/alsa/conf.d/50-pipewire.conf
+usr/share/doc/pipewire-audio-client-libraries/README.Debian usr/share/doc/pipewire/examples/README.audio
+usr/share/doc/pipewire/examples usr/share/doc/pipewire-audio-client-libraries/examples