mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-11-23 06:59:58 -05:00
Add access.socket option, which sets PW_KEY_ACCESS based only on which socket the client connected from. Remove the executable-based permissions and all old options. Add access.legacy=true option that enables the old default behavior. The legacy mode cannot be used together with the socket-based access. Emit warnings if any of the removed old options have been set. Set pipewire.sec.flatpak=true for Flatpak applications. The socket-based access ignores PW_KEY_CLIENT_ACCESS and the Flatpak status when setting PW_KEY_ACCESS. Dealing with them becomes responsibility of the session manager (or equivalent) which processes the permission rules. Make the default access.socket value compatible with the module-protocol-native default two-socket configuration. However, if neither access.socket or access.legacy is specified, we will for now use the legacy mode for backward compatibility.
315 lines
12 KiB
Text
315 lines
12 KiB
Text
# Daemon config file for PipeWire version @VERSION@ #
|
|
#
|
|
# Copy and edit this file in @PIPEWIRE_CONFIG_DIR@ for system-wide changes
|
|
# or in ~/.config/pipewire for local changes.
|
|
#
|
|
# It is also possible to place a file with an updated section in
|
|
# @PIPEWIRE_CONFIG_DIR@/pipewire.conf.d/ for system-wide changes or in
|
|
# ~/.config/pipewire/pipewire.conf.d/ for local changes.
|
|
#
|
|
|
|
context.properties = {
|
|
## Configure properties in the system.
|
|
#library.name.system = support/libspa-support
|
|
#context.data-loop.library.name.system = support/libspa-support
|
|
#support.dbus = true
|
|
#link.max-buffers = 64
|
|
link.max-buffers = 16 # version < 3 clients can't handle more
|
|
#mem.warn-mlock = false
|
|
#mem.allow-mlock = true
|
|
#mem.mlock-all = false
|
|
#clock.power-of-two-quantum = true
|
|
#log.level = 2
|
|
#cpu.zero.denormals = false
|
|
|
|
core.daemon = true # listening for socket connections
|
|
core.name = pipewire-0 # core name and socket name
|
|
|
|
## Properties for the DSP configuration.
|
|
#default.clock.rate = 48000
|
|
#default.clock.allowed-rates = [ 48000 ]
|
|
#default.clock.quantum = 1024
|
|
#default.clock.min-quantum = 32
|
|
#default.clock.max-quantum = 2048
|
|
#default.clock.quantum-limit = 8192
|
|
#default.video.width = 640
|
|
#default.video.height = 480
|
|
#default.video.rate.num = 25
|
|
#default.video.rate.denom = 1
|
|
#
|
|
#settings.check-quantum = false
|
|
#settings.check-rate = false
|
|
#
|
|
# These overrides are only applied when running in a vm.
|
|
vm.overrides = {
|
|
default.clock.min-quantum = 1024
|
|
}
|
|
|
|
# keys checked below to disable module loading
|
|
module.x11.bell = true
|
|
# enables autoloading of access module, when disabled an alternative
|
|
# access module needs to be loaded.
|
|
module.access = true
|
|
# enables autoloading of module-jackdbus-detect
|
|
module.jackdbus-detect = true
|
|
}
|
|
|
|
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
|
|
avb.* = avb/libspa-avb
|
|
api.alsa.* = alsa/libspa-alsa
|
|
api.v4l2.* = v4l2/libspa-v4l2
|
|
api.libcamera.* = libcamera/libspa-libcamera
|
|
api.bluez5.* = bluez5/libspa-bluez5
|
|
api.vulkan.* = vulkan/libspa-vulkan
|
|
api.jack.* = jack/libspa-jack
|
|
support.* = support/libspa-support
|
|
#videotestsrc = videotestsrc/libspa-videotestsrc
|
|
#audiotestsrc = audiotestsrc/libspa-audiotestsrc
|
|
}
|
|
|
|
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.
|
|
# If condition is given, the module is loaded only when the context
|
|
# properties all match the match rules.
|
|
#
|
|
|
|
# Uses realtime scheduling to boost the audio thread priorities. This uses
|
|
# RTKit if the user doesn't have permission to use regular realtime
|
|
# scheduling.
|
|
{ name = libpipewire-module-rt
|
|
args = {
|
|
nice.level = -11
|
|
#rt.prio = 88
|
|
#rt.time.soft = -1
|
|
#rt.time.hard = -1
|
|
}
|
|
flags = [ ifexists nofail ]
|
|
}
|
|
|
|
# The native communication protocol.
|
|
{ name = libpipewire-module-protocol-native
|
|
args = {
|
|
# List of server Unix sockets, and optionally permissions
|
|
#sockets = [ { name = "pipewire-0" }, { name = "pipewire-0-manager" } ]
|
|
}
|
|
}
|
|
|
|
# The profile module. Allows application to access profiler
|
|
# and performance data. It provides an interface that is used
|
|
# by pw-top and pw-profiler.
|
|
{ name = libpipewire-module-profiler }
|
|
|
|
# Allows applications to create metadata objects. It creates
|
|
# a factory for Metadata objects.
|
|
{ name = libpipewire-module-metadata }
|
|
|
|
# Creates a factory for making devices that run in the
|
|
# context of the PipeWire server.
|
|
{ name = libpipewire-module-spa-device-factory }
|
|
|
|
# Creates a factory for making nodes that run in the
|
|
# context of the PipeWire server.
|
|
{ name = libpipewire-module-spa-node-factory }
|
|
|
|
# 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 }
|
|
|
|
# The portal module monitors the PID of the portal process
|
|
# and tags connections with the same PID as portal
|
|
# connections.
|
|
{ name = libpipewire-module-portal
|
|
flags = [ ifexists nofail ]
|
|
}
|
|
|
|
# The access module can perform access checks and block
|
|
# new clients.
|
|
{ name = libpipewire-module-access
|
|
args = {
|
|
# Socket-specific access permissions
|
|
#access.socket = { pipewire-0 = "default", pipewire-0-manager = "unrestricted" }
|
|
|
|
# Deprecated legacy mode (not socket-based),
|
|
# for now enabled by default if access.socket is not specified
|
|
#access.legacy = true
|
|
}
|
|
condition = [ { module.access = true } ]
|
|
}
|
|
|
|
# Makes a factory for wrapping nodes in an adapter with a
|
|
# converter and resampler.
|
|
{ name = libpipewire-module-adapter }
|
|
|
|
# Makes a factory for creating links between ports.
|
|
{ name = libpipewire-module-link-factory }
|
|
|
|
# Provides factories to make session manager objects.
|
|
{ name = libpipewire-module-session-manager }
|
|
|
|
# Use libcanberra to play X11 Bell
|
|
{ name = libpipewire-module-x11-bell
|
|
args = {
|
|
#sink.name = "@DEFAULT_SINK@"
|
|
#sample.name = "bell-window-system"
|
|
#x11.display = null
|
|
#x11.xauthority = null
|
|
}
|
|
flags = [ ifexists nofail ]
|
|
condition = [ { module.x11.bell = true } ]
|
|
}
|
|
{ name = libpipewire-module-jackdbus-detect
|
|
args {
|
|
#jack.library = libjack.so.0
|
|
#jack.server = null
|
|
#jack.client-name = PipeWire
|
|
#jack.connect = true
|
|
#tunnel.mode = duplex # source|sink|duplex
|
|
source.props = {
|
|
#audio.channels = 2
|
|
#midi.ports = 1
|
|
#audio.position = [ FL FR ]
|
|
# extra sink properties
|
|
}
|
|
sink.props = {
|
|
#audio.channels = 2
|
|
#midi.ports = 1
|
|
#audio.position = [ FL FR ]
|
|
# extra sink properties
|
|
}
|
|
}
|
|
flags = [ ifexists nofail ]
|
|
condition = [ { module.jackdbus-detect = true } ]
|
|
}
|
|
]
|
|
|
|
context.objects = [
|
|
#{ factory = <factory-name>
|
|
# ( args = { <key> = <value> ... } )
|
|
# ( flags = [ ( nofail ) ] )
|
|
# ( condition = [ { <key> = <value> ... } ... ] )
|
|
#}
|
|
#
|
|
# Creates an object from a PipeWire factory with the given parameters.
|
|
# If nofail is given, errors are ignored (and no object is created).
|
|
# If condition is given, the object is created only when the context properties
|
|
# all match the match rules.
|
|
#
|
|
#{ factory = spa-node-factory args = { factory.name = videotestsrc node.name = videotestsrc node.description = videotestsrc Spa:Pod:Object:Param:Props:patternType = 1 } }
|
|
#{ factory = spa-device-factory args = { factory.name = api.jack.device foo=bar } flags = [ nofail ] }
|
|
#{ factory = spa-device-factory args = { factory.name = api.alsa.enum.udev } }
|
|
#{ factory = spa-node-factory args = { factory.name = api.alsa.seq.bridge node.name = Internal-MIDI-Bridge } }
|
|
#{ factory = adapter args = { factory.name = audiotestsrc node.name = my-test node.description = audiotestsrc } }
|
|
#{ factory = spa-node-factory args = { factory.name = api.vulkan.compute.source node.name = my-compute-source } }
|
|
|
|
# A default dummy driver. This handles nodes marked with the "node.always-driver"
|
|
# property when no other driver is currently active. JACK clients need this.
|
|
{ factory = spa-node-factory
|
|
args = {
|
|
factory.name = support.node.driver
|
|
node.name = Dummy-Driver
|
|
node.group = pipewire.dummy
|
|
priority.driver = 20000
|
|
#clock.id = monotonic # realtime | tai | monotonic-raw | boottime
|
|
#clock.name = "clock.system.monotonic"
|
|
}
|
|
}
|
|
{ factory = spa-node-factory
|
|
args = {
|
|
factory.name = support.node.driver
|
|
node.name = Freewheel-Driver
|
|
priority.driver = 19000
|
|
node.group = pipewire.freewheel
|
|
node.freewheel = true
|
|
}
|
|
}
|
|
|
|
# This creates a new Source node. It will have input ports
|
|
# that you can link, to provide audio for this source.
|
|
#{ factory = adapter
|
|
# args = {
|
|
# factory.name = support.null-audio-sink
|
|
# node.name = "my-mic"
|
|
# node.description = "Microphone"
|
|
# media.class = "Audio/Source/Virtual"
|
|
# audio.position = "FL,FR"
|
|
# }
|
|
#}
|
|
|
|
# This creates a single PCM source device for the given
|
|
# alsa device path hw:0. You can change source to sink
|
|
# to make a sink in the same way.
|
|
#{ factory = adapter
|
|
# args = {
|
|
# factory.name = api.alsa.pcm.source
|
|
# node.name = "alsa-source"
|
|
# node.description = "PCM Source"
|
|
# media.class = "Audio/Source"
|
|
# api.alsa.path = "hw:0"
|
|
# api.alsa.period-size = 1024
|
|
# api.alsa.headroom = 0
|
|
# api.alsa.disable-mmap = false
|
|
# api.alsa.disable-batch = false
|
|
# audio.format = "S16LE"
|
|
# audio.rate = 48000
|
|
# audio.channels = 2
|
|
# audio.position = "FL,FR"
|
|
# }
|
|
#}
|
|
|
|
# Use the metadata factory to create metadata and some default values.
|
|
#{ factory = metadata
|
|
# args = {
|
|
# metadata.name = my-metadata
|
|
# metadata.values = [
|
|
# { key = default.audio.sink value = { name = somesink } }
|
|
# { key = default.audio.source value = { name = somesource } }
|
|
# ]
|
|
# }
|
|
#}
|
|
]
|
|
|
|
context.exec = [
|
|
#{ path = <program-name>
|
|
# ( args = "<arguments>" )
|
|
# ( condition = [ { <key> = <value> ... } ... ] )
|
|
#}
|
|
#
|
|
# Execute the given program with arguments.
|
|
# If condition is given, the program is executed only when the context
|
|
# properties all match the match rules.
|
|
#
|
|
# You can optionally start the session manager here,
|
|
# but it is better to start it as a systemd service.
|
|
# Run the session manager with -h for options.
|
|
#
|
|
@sm_comment@{ path = "@session_manager_path@" args = "@session_manager_args@"
|
|
@sm_comment@ condition = [ { exec.session-manager = null } { exec.session-manager = true } ] }
|
|
#
|
|
# 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).
|
|
#
|
|
@pulse_comment@{ path = "@pipewire_path@" args = "-c pipewire-pulse.conf"
|
|
@pulse_comment@ condition = [ { exec.pipewire-pulse = null } { exec.pipewire-pulse = true } ] }
|
|
]
|