PipeWire: Difference between revisions
m (→Session Manager: use pkg template.) |
Prabuanand (talk | contribs) |
||
Line 48: | Line 48: | ||
=== Session Manager === | === Session Manager === | ||
PipeWire delegates plumbing work to session manager. | PipeWire delegates plumbing work to session manager i.e {{Pkg|wireplumber}}. It has modular design and supports Lua plugins. | ||
{{Cmd|# apk add | {{Cmd|# apk add wireplumber}} | ||
=== PulseAudio compatibility === | === PulseAudio compatibility === | ||
Install {{Pkg|pipewire-pulse}} package, which provides a daemon so PulseAudio applications could use PipeWire as backend. | Install {{Pkg|pipewire-pulse}} package, which provides a daemon so PulseAudio applications could use PipeWire as backend. This package by itself will install the above {{Pkg|pipewire}} package and {{Pkg|wireplumber}}. | ||
{{Cmd|# apk add pipewire-pulse}} | |||
=== JACK compatibility === | === JACK compatibility === | ||
Install {{Pkg|pipewire-jack}} package, which provides ABI-compatible libraries for JACK applications. | Install {{Pkg|pipewire-jack}} package, which provides ABI-compatible libraries for JACK applications. | ||
{{Cmd|# apk add pipewire-jack}} | |||
=== ALSA support === | === ALSA support === | ||
Install {{Pkg|pipewire-alsa}} package. | Install {{Pkg|pipewire-alsa}} package. | ||
{{Cmd|# apk add pipewire-alsa}} | |||
== Configuration == | == Configuration == |
Revision as of 11:25, 7 September 2024
This material is work-in-progress ... The instructions below have not been thoroughly tested and may break things. |
PipeWire is a multimedia processing engine that aims to improve audio and video handling on Linux.
Prerequisites
Device access
PipeWire needs proper permissions to access devices. If you do not use elogind, your user should be in audio
(to access audio devices) and video
(to access webcam devices) groups:
# addgroup <user> audio # addgroup <user> video
video
group will also grant unrestricted access to video devices, which is often a security issue. See issue #15409 for further details.
See pre-systemd groups for more info. Make sure to re-login for these changes to take effect.
D-Bus
PipeWire optionally requires a running D-Bus system and/or session bus for some of its functionality.
For certain configurations (e.g. only audio playback and recording) D-Bus setup is not necessary. Edit configuration files to disable D-Bus support.
If you start session-wide dbus instance, make sure to start PipeWire in that same session.
Environment
Ensure that XDG_RUNTIME_DIR is configured correctly. If this is not set, pipewire will create a directory in your home folder instead, called ~/pulse, and on attempting to run Pavucontrol or pactl, you will get the following error:
$ pactl list Connection failure: Connection refused pa_context_connect() failed: Connection refused
Under Sway, in order for xdg-desktop-portal-wlr
to work it may also be necessary to set XDG_CURRENT_DESKTOP
and XDG_SESSION_DESKTOP
to sway
Installation
Install the pipewire package.
# apk add pipewire
Session Manager
PipeWire delegates plumbing work to session manager i.e wireplumber. It has modular design and supports Lua plugins.
# apk add wireplumber
PulseAudio compatibility
Install pipewire-pulse package, which provides a daemon so PulseAudio applications could use PipeWire as backend. This package by itself will install the above pipewire package and wireplumber.
# apk add pipewire-pulse
JACK compatibility
Install pipewire-jack package, which provides ABI-compatible libraries for JACK applications.
# apk add pipewire-jack
ALSA support
Install pipewire-alsa package.
# apk add pipewire-alsa
Configuration
PipeWire and WirePlumber store their default configuration in /usr/share/pipewire and /usr/share/wireplumber respectively. If you want to edit the configuration, you need to move it to /etc:
# cp -a /usr/share/pipewire /etc # cp -a /usr/share/wireplumber /etc
Disable D-Bus support
Edit the following configuration parameters:
Contents of /etc/pipewire/pipewire.conf
Contents of /etc/wireplumber/wireplumber.conf
Contents of /etc/wireplumber/bluetooth.lua.d/50-bluez-config.lua
Contents of /etc/wireplumber/main.lua.d/50-alsa-config.lua
Contents of /etc/wireplumber/main.lua.d/50-default-access-config.lua
Realtime scheduling
For realtime scheduling, it is recommended to use rtkit. Add your user to the rtkit
group.
Alternatively, ensure your user has the right ulimit permissions. Since pipewire 0.3.66, you can add yourself to the pipewire
group. You generally need (e.g. in /etc/security/limits.conf):
@pipewire - memlock 4194304 @pipewire - nice -19 @pipewire - rtprio 95
This allows a member of the pipewire group to have the right permissions for PipeWire to use realtime scheduling without rtkit. This same snippet comes with pipewire since 0.3.66, so if you have a PAM login session and add yourself to the pipewire group, you don't have to do anything else.
Note that the above limits.conf will only work if your session is using PAM.
Video
Video should work out-of-the-box with v4l2 devices (e.g. a lot of webcams) and GStreamer applications.
Bluetooth audio
- Enable PulseAudio support as described above
- Install bluetooth service packages:
bluez bluez-openrc pipewire-spa-bluez
- Optional: install GUI manager for bluetooth
blueman
- Enable and start bluetooth service:
rc-update add bluetooth; rc-service bluetooth start
- Restart PipeWire
- Use commandline program
bluetoothctl
or GUI programblueman-manager
to scan and pair bluetooth audio devices. - Use pavucontrol to adjust volume and manually select high definition bluetooth codecs.
Screen sharing on Wayland
You will need the right xdg-desktop-portal backend for your desktop environment. Screen sharing is known to work on:
- GNOME with
xdg-desktop-portal-gtk
- KDE Plasma with
xdg-desktop-portal-kde
and Firefox - Sway with
xdg-desktop-portal-wlr
and Firefox, see Sway for details
Running
superd
to manage pipewire
and its related services.pipewire-launcher
script is provided by Alpine Linux, not by upstream. Please report issues to Alpine Linux maintainers first.Start the PipeWire media server. You'll probably get quite a few errors but just ignore them for now.
$ /usr/libexec/pipewire-launcher
A D-Bus session service must be running unless dbus support is disabled.
Auto launching
You can add /usr/libexec/pipewire-launcher to your ~/.xinitrc.
If you do not use GUI by default and have D-Bus enabled in configuration, add the following stanza to your shell configuration file:
export $(dbus-launch) /usr/libexec/pipewire-launcher
Testing
In a different terminal window check the default output device. I don't yet know how this default can be changed for all applications, so you'd better hope it's right!
WirePlumber
$ wpctl status
pw-cat playback
Test sound is working using an audio file in a format supported by libsndfile
🔓 (e.g. flac, opus, ogg, wav). Use pw-cat
utility from pipewire-tools:
$ pw-cat -p test.flac $ pw-play /usr/share/sounds/alsa/Front_Center.wav
pw-cat recording
If you have a microphone test audio recording is working.
$ pw-cat -r --list-targets $ pw-cat -r recording.flac (Speak for a while then stop it with Ctrl+c) $ pw-cat -p recording.flac
PulseAudio
Test PulseAudio clients using a media player, as most use PulseAudio.
JACK
Use jack_simple_client
from jack-simple-clients:
$ jack_simple_client
You should hear a sustained beep.
Troubleshooting
`wpctl status` shows no targets
First, check whether ALSA knows about your sound card:
aplay -l
If sound devices are found, the issue is with your pipewire configuration. Consider double-checking the instructions above.
Otherwise, your sound card may not be supported in the version of the Linux Kernel you're running. You should search online for fixes relating to your current kernel version and the codec of your sound card. You can find each of these with:
uname -r cat /proc/asound/card0/codec*
Modern devices might require sof-firmware, which is the case if you get sof firmware file is missing
errors in dmesg.
Error acquiring bus address: Cannot autolaunch D-Bus without X11 $DISPLAY
This means D-Bus session bus is not started and GUI is not active (i.e. you are in a tty). Use dbus-run-session
as outlined above. Alternatively, disable D-Bus support.
Ensure that a Session Manager is running.
Play/Pause buttons not working on bluetooth headphones
Check /var/log/messages. If you see something like this:
bluetoothd[3463]: profiles/audio/avctp.c:uinput_create() Can't open input device: No such file or directory (2) bluetoothd[3463]: profiles/audio/avctp.c:init_uinput() AVRCP: failed to init uinput for WH-1000XM5
Then bluez is trying to register the headphones buttons as an input devices, but uinput
is not loaded. Try modprobe uinput
. If this works, see Architecture#Module_Loading for instructions on how to make sure this module is loaded automatically on each startup.
Quick Configuration
You might want to use pavucontrol or pavucontrol-qt to have a simple GUI app for controlling sound, outputs, etc.
PipeWire Graph Qt GUI Interface
qpwgraph is a graph manager dedicated to PipeWire.
XFCE Audio Mixer Plugin
to help the XFCE audio mixer plugin find the volume to control:
doas apk add gst-plugin-pipewire