automate/020_pipewire.sh

302 lines
9.0 KiB
Bash
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

#!/usr/bin/env bash
DEST=${1:-/etc/skel}
PIPEWIRE_HOME=${DEST}/.config/pipewire
WIREPLUMBER_HOME=${DEST}/.config/wireplumber
mkdir -p ${DEST}/.config/pipewire,wireplumber
# https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/home
#
# with-alsa:
# https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/Config-ALSA
: <<'!'
pipewire-audio-client-libraries
pipewire-alsa
pipewire-jack
pipewire-pulse
pipewire-v4l2
pipewire
!
sudo apt install -y \
libfdk-aac2 \
libldacbt-{abr,enc}2 \
libopenaptx0
sudo apt install -y gstreamer1.0-pipewire \
libpipewire-0.3-{0,dev,modules} \
libspa-0.2-{bluetooth,dev,jack,libcamera,modules}
sudo apt install -y \
pipewire-audio-client-libraries \
pipewire \
pipewire-{audio,alsa,jack,v4l2,libcamera} \
wireplumber \
wireplumber-system-services \
coppwr \
xdg-desktop-portal-wlr
## For WirePlumber - pipewire session manager
sudo apt-get install -y wireplumber{,-doc}
## Other management tools - jackd2 will set /etc/security/limits.conf for rt
# if you not using jackd2 you can use the heredoc to set them manually.
sudo apt-get install -y jackd2 qpwgraph vlc-plugin-pipewire libcamera-ipa
conf_print_audio_limits() {
cat <<EOF
# Provided by the jackd package.
#
# Changes to this file will be preserved.
#
# If you want to enable/disable realtime permissions, run
#
# dpkg-reconfigure -p high jackd2
@audio - rtprio 95
@audio - memlock unlimited
#@audio - nice -19
EOF
}
# conf_print_audio_limits | sudo tee /etc/security/limits.d/audio.conf
sudo mkdir -p /etc/pipewire/pipewire.conf.d
sudo mkdir -p /etc/wireplumber/wireplumber.d
sudo cp -a /usr/share/pipewire/* /etc/pipewire
sudo cp -a /usr/share/wireplumber/* /etc/wireplumber
conf_print_pipewire_desktop() {
cat <<-EOF
[Desktop Entry]
Version=1.0
Name=PipeWire Media System
Comment=Start the PipeWire Media System
Exec=/usr/bin/pipewire
Terminal=false
Type=Application
X-GNOME-Autostart-Phase=Initialization
X-KDE-autostart-phase=1
EOF
}
conf_print_pipewire_desktop | sudo tee /etc/xdg/autostart/pipewire.desktop
conf_print_wireplumber_desktop() {
cat <<-EOF
[Desktop Entry]
Version=1.0
Name=WirePlumber PipeWire Media System
Comment=Start the WirePlumber
Exec=/usr/bin/wireplumber
Terminal=false
Type=Application
X-GNOME-Autostart-Phase=Initialization
X-KDE-autostart-phase=1
EOF
}
conf_print_wireplumber_desktop | sudo tee /etc/xdg/autostart/wireplumber.desktop
# User override
mkdir -p ${DEST}/.config/pipewire/pipewire.conf.d
mkdir -p ${DEST}/.config/wireplumber/wireplumber.conf.d
# To customize settings
# (e.g., increase quantum for smoother audio under load), create a drop-in config:
conf_print_quantum() {
cat <<EOF
context.properties = {
default.clock.min-quantum = 128
default.clock.max-quantum = 8192
default.clock.quantum = 2048
}
EOF
}
# conf_print_quantum | tee ${PIPWIRE_HOME}/pipewire.conf.d/choppy-under-load.conf
# /usr/share/pipewire/client-rt.conf /etc/pipewire/client-rt.conf.d/
mkdir -p ${PIPEWIRE_HOME}/client-rt.conf.d/
# Real-time Client config file for PipeWire version "1.0.3" #
#
# Copy and edit this file in /etc/pipewire for system-wide changes
# or in ~/.config/pipewire for local changes.
#
# It is also possible to place a file with an updated section in
# /etc/pipewire/client-rt.conf.d/ for system-wide changes or in
# ~/.config/pipewire/client-rt.conf.d/ for local changes.
#
# context.properties section is a valid and supported configuration block in PipeWire,
# used to set global instance properties like log.level
conf_print_client-rt_context_property() {
cat <<-EOF
context.properties = {
## Configure properties in the system.
#mem.warn-mlock = false
#mem.allow-mlock = true
#mem.mlock-all = false
log.level = 0
#default.clock.quantum-limit = 8192
}
EOF
}
conf_print_client-rt_context_property | sudo tee ${PIPEWIRE_HOME}/client-rt.conf.d/client-rt_context_property.conf >/dev/null
# The context.spa-libs section maps SPA factory name regex patterns to their
# corresponding library names
conf_print_client-rt_context_spa-libs() {
cat <<-EOF
context.spa-libs = {
#<factory-name regex> = <library-name>
#
# Used to find spa factory names. It maps an spa factory name
# regular expression to a library name that should contain
# that factory.
#
audio.convert.* = audioconvert/libspa-audioconvert
support.* = support/libspa-support
}
EOF
}
conf_print_client-rt_context_spa-libs | sudo tee ${PIPEWIRE_HOME}/client-rt.conf.d/client-rt_context_spa-libs.conf >/dev/null
# use of context.modules to load modules like libpipewire-module-rt
conf_print_client-rt_context_modules() {
cat <<-EOF
context.modules = [
#{ name = <module-name>
# ( args = { <key> = <value> ... } )
# ( flags = [ ( ifexists ) ( nofail ) ] )
# ( condition = [ { <key> = <value> ... } ... ] )
#}
#
# Loads a module with the given parameters.
# If ifexists is given, the module is ignored when it is not found.
# If nofail is given, module initialization failures are ignored.
#
# Uses realtime scheduling to boost the audio thread priorities
{ name = libpipewire-module-rt
args = {
#rt.prio = 88
#rt.time.soft = -1
#rt.time.hard = -1
}
flags = [ ifexists nofail ]
}
# The native communication protocol.
{ name = libpipewire-module-protocol-native }
# Allows creating nodes that run in the context of the
# client. Is used by all clients that want to provide
# data to PipeWire.
{ name = libpipewire-module-client-node }
# Allows creating devices that run in the context of the
# client. Is used by the session manager.
{ name = libpipewire-module-client-device }
# Makes a factory for wrapping nodes in an adapter with a
# converter and resampler.
{ name = libpipewire-module-adapter }
# Allows applications to create metadata objects. It creates
# a factory for Metadata objects.
{ name = libpipewire-module-metadata }
# Provides factories to make session manager objects.
{ name = libpipewire-module-session-manager }
]
EOF
}
conf_print_client-rt_context_modules | sudo tee ${PIPEWIRE_HOME}/client-rt.conf.d/client-rt_context_modules.conf >/dev/null
conf_print_client-rt_filter_properties() {
cat <<-EOF
filter.properties = {
#node.latency = 1024/48000
}
EOF
}
conf_print_client-rt_filter_properties | sudo tee ${PIPEWIRE_HOME}/client-rt.conf.d/client-rt_filter_properties.conf >/dev/null
conf_print_client-rt_stream_properties() {
cat <<-EOF
stream.properties = {
#node.latency = 1024/48000
#node.autoconnect = true
#resample.quality = 4
#channelmix.normalize = false
#channelmix.mix-lfe = true
#channelmix.upmix = true
#channelmix.upmix-method = psd # none, simple
#channelmix.lfe-cutoff = 150
#channelmix.fc-cutoff = 12000
#channelmix.rear-delay = 12.0
#channelmix.stereo-widen = 0.0
#channelmix.hilbert-taps = 0
#dither.noise = 0
}
EOF
}
conf_print_client-rt_stream_properties | sudo tee ${PIPEWIRE_HOME}/client-rt.conf.d/client-rt_stream_properties.conf >/dev/null
conf_print_client-rt_stream_rules() {
cat <<-EOF
stream.rules = [
{ matches = [
{
# all keys must match the value. ! negates. ~ starts regex.
#application.name = "pw-cat"
#node.name = "~Google Chrome$"
}
]
actions = {
update-props = {
#node.latency = 512/48000
}
}
}
]
EOF
}
conf_print_client-rt_stream_rules | sudo tee ${PIPEWIRE_HOME}/client-rt.conf.d/client-rt_stream_rules.conf >/dev/null
conf_print_client-rt_alsa_properties() {
cat <<-EOF
alsa.properties = {
#alsa.deny = false
# ALSA params take a single value, an array [] of values
# or a range { min=.. max=... }
#alsa.access = [ MMAP_INTERLEAVED MMAP_NONINTERLEAVED RW_INTERLEAVED RW_NONINTERLEAVED ]
#alsa.format = [ FLOAT S32 S24 S24_3 S16 U8 ]
#alsa.rate = { min=1 max=384000 } # or [ 44100 48000 .. ]
#alsa.channels = { min=1 max=64 } # or [ 2 4 6 .. ]
#alsa.period-bytes = { min=128 max=2097152 } # or [ 128 256 1024 .. ]
#alsa.buffer-bytes = { min=256 max=4194304 } # or [ 256 512 4096 .. ]
#alsa.volume-method = cubic # linear, cubic
}
EOF
}
conf_print_client-rt_alsa_properties | sudo tee ${PIPEWIRE_HOME}/client-rt.conf.d/client-rt_alsa_properties.conf >/dev/null
conf_print_client-rt_alsa_rules() {
cat <<-EOF
# client specific properties
alsa.rules = [
{ matches = [ { application.process.binary = "resolve" } ]
actions = {
update-props = {
alsa.buffer-bytes = 131072
}
}
}
]
EOF
}
conf_print_client-rt_alsa_rules | sudo tee ${PIPEWIRE_HOME}/client-rt.conf.d/client-rt_alsa_rules.conf >/dev/null