2021-05-25 09:55:06 +00:00
|
|
|
|
/** \page page_daemon PipeWire Daemon
|
|
|
|
|
|
2021-08-04 04:25:32 +00:00
|
|
|
|
The PipeWire daemon is the central process that manages data exchange between
|
|
|
|
|
devices and clients.
|
|
|
|
|
|
|
|
|
|
Typically general, users run one PipeWire daemon that listens for incoming
|
|
|
|
|
connections and manages devices. Clients (including the \ref
|
|
|
|
|
page_session_manager) are separate processes that talk to the daemon using the
|
|
|
|
|
PipeWire socket (default: `$XDG_RUNTIME_DIR/pipewire-0`). This approach
|
|
|
|
|
provides provides address-space separation between the privileged daemon and
|
|
|
|
|
non-privileged clients.
|
|
|
|
|
|
2021-09-06 00:47:56 +00:00
|
|
|
|
\dot
|
2021-08-04 04:25:32 +00:00
|
|
|
|
digraph pw {
|
|
|
|
|
compound=true;
|
|
|
|
|
node [shape="box"];
|
|
|
|
|
|
|
|
|
|
subgraph cluster_pw {
|
|
|
|
|
rankdir="TB";
|
|
|
|
|
label="PipeWire daemon";
|
|
|
|
|
style="dashed";
|
|
|
|
|
|
|
|
|
|
subgraph cluster_prot_native {
|
|
|
|
|
label="pipewire-module-protocol-native";
|
|
|
|
|
style="solid";
|
|
|
|
|
socket [label="$XDG_RUNTIME_DIR/pipewire-0"];
|
|
|
|
|
mod_impl [label="module implementation"];
|
|
|
|
|
|
|
|
|
|
socket -> mod_impl;
|
|
|
|
|
}
|
|
|
|
|
core [label="PipeWire Core"];
|
|
|
|
|
alsa [label="PipeWire ALSA support"];
|
|
|
|
|
|
|
|
|
|
mod_impl -> core;
|
|
|
|
|
core -> alsa;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
kernel
|
|
|
|
|
|
|
|
|
|
client1 [ label="Media Player" ];
|
|
|
|
|
client2 [ label="Audio Software" ];
|
|
|
|
|
sm [ label="Session Manager", style="dotted" ];
|
|
|
|
|
|
|
|
|
|
client1 -> socket;
|
|
|
|
|
client2 -> socket;
|
|
|
|
|
sm -> socket;
|
|
|
|
|
alsa -> kernel;
|
|
|
|
|
}
|
2021-09-06 00:47:56 +00:00
|
|
|
|
\enddot
|
2021-08-04 04:25:32 +00:00
|
|
|
|
|
|
|
|
|
As shown above, the protocol is handled by the \ref
|
|
|
|
|
page_module_protocol_native. From PipeWire's point-of-view this module is just
|
|
|
|
|
another module.
|
|
|
|
|
|
2021-07-05 05:30:46 +00:00
|
|
|
|
\section sec_config Configuration Files
|
|
|
|
|
|
|
|
|
|
On startup, the daemon reads a configuration file to configure itself.
|
|
|
|
|
It executes a series of commands listed in the config file. The lookup order
|
|
|
|
|
for configuration files are:
|
|
|
|
|
|
|
|
|
|
- `$XDG_CONFIG_HOME/pipewire/pipewire.conf` (usually `$HOME/.config/pipewire/pipewire.conf`)
|
|
|
|
|
- `$sysconfdir/pipewire/pipewire.conf` (usually `/etc/pipewire/pipewire.conf`)
|
|
|
|
|
- `$datadir/pipewire/pipewire.conf` (usually `/usr/share/pipewire/pipewire.conf`)
|
|
|
|
|
|
|
|
|
|
The first configuration file found is loaded, the PipeWire daemon does not
|
|
|
|
|
currently combine configuration files.
|
|
|
|
|
|
|
|
|
|
The environment variables `PIPEWIRE_CONFIG_DIR`, `PIPEWIRE_CONFIG_PREFIX`
|
|
|
|
|
and `PIPEWIRE_CONFIG_NAME` can be used to specify an alternative config
|
|
|
|
|
directory, subdirectory and filename, respectively.
|
|
|
|
|
|
2021-08-04 03:55:12 +00:00
|
|
|
|
\subsection sec_config_format Configuration File Format
|
2021-07-05 05:30:46 +00:00
|
|
|
|
|
2021-08-04 09:45:54 +00:00
|
|
|
|
PipeWire's configuration file format is JSON. In addition to true JSON,
|
|
|
|
|
PipeWire also understands a more compact JSON representation where
|
|
|
|
|
`"` can be omitted around strings, no trailing commas are required and
|
|
|
|
|
`:` or `=` can be used to separate object keys from their values.
|
|
|
|
|
Also, `#` can be used to start a comment until the end of the line.
|
2021-07-05 05:30:46 +00:00
|
|
|
|
|
|
|
|
|
The configuration file format is grouped into sections. A section is
|
|
|
|
|
either a dictionary (`{}`) or an array (`[]`). Dictionary and array entries
|
|
|
|
|
are separated by whitespace and may be simple value assignment, an array or
|
|
|
|
|
a dictionary. For example:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
# A dictionary section
|
|
|
|
|
context.properties = {
|
|
|
|
|
# Keys often have a dot notation
|
|
|
|
|
core.daemon = true
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
# An array section containing three dictionary objects
|
|
|
|
|
context.modules = [
|
|
|
|
|
# a dictionary object with one key assigned to a string
|
|
|
|
|
{ name = libpipewire-module-protocol-native }
|
|
|
|
|
{ name = libpipewire-module-profiler }
|
|
|
|
|
|
|
|
|
|
# a dictionary object with two keys, one assigned to a string
|
|
|
|
|
# the other one to an array of strings
|
|
|
|
|
{ name = libpipewire-module-portal
|
|
|
|
|
flags = [ ifexists nofail ]
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Allowed configuration file sections are:
|
|
|
|
|
|
|
|
|
|
- **context.properties** (dictionary): These properties configure the
|
|
|
|
|
pipewire instance.
|
|
|
|
|
|
|
|
|
|
- **context.spa-libs** (dictionary): Maps plugin features with globs to a
|
|
|
|
|
spa library.
|
|
|
|
|
|
|
|
|
|
- **context.modules** (array): Each entry in the array is a dictionary with
|
|
|
|
|
the name of the module to load, including optional args and flags. Most
|
|
|
|
|
modules support being loaded multiple times.
|
|
|
|
|
|
|
|
|
|
- **context.objects** (array): Each entry in the array is a dictionary con‐
|
|
|
|
|
taining the factory to create an object from and optional extra argu‐
|
|
|
|
|
ments specific to that factory.
|
|
|
|
|
|
|
|
|
|
- **context.exec** (array): Each entry in the array is dictionary containing
|
|
|
|
|
the path of a program to execute on startup and optional args. This ar‐
|
|
|
|
|
ray usually contains an entry to start the session manager.
|
|
|
|
|
|
2021-05-25 09:55:06 +00:00
|
|
|
|
|
|
|
|
|
\section sec_logging Logging
|
|
|
|
|
|
|
|
|
|
The `PIPEWIRE_DEBUG` environment variable can be used to enable
|
2021-09-16 03:43:48 +00:00
|
|
|
|
more debugging. This variable supports one of two formats:
|
2021-05-25 09:55:06 +00:00
|
|
|
|
|
2021-09-16 03:43:48 +00:00
|
|
|
|
- `PIPEWIRE_DEBUG=<level>` where `<level>` is either a numerical log level or it's
|
|
|
|
|
respective key, see below.
|
|
|
|
|
- `PIPEWIRE_DEBUG=<glob1>:<level1>,<glob2>:<level2>,...` where the globs are
|
|
|
|
|
shell-globs to match on log topics and the levels are the respective
|
|
|
|
|
log level to set for that topic. Globs are applied in-order and a matching
|
|
|
|
|
glob overrides an earlier glob for that category. For example,
|
|
|
|
|
`PIPEWIRE_DEBUG=*:E,mod.*:D,mod.foo:X" enables global error messages,
|
|
|
|
|
debugging on all modules but no messages on the foo module.
|
2021-05-25 09:55:06 +00:00
|
|
|
|
|
|
|
|
|
- `<level>` specifies the log level:
|
2021-09-09 22:51:52 +00:00
|
|
|
|
+ `X` or `0`: no logging is enabled
|
|
|
|
|
+ `E` or `1`: Error logging is enabled
|
|
|
|
|
+ `W` or `2`: Warnings are enabled
|
|
|
|
|
+ `I` or `3`: Informational messages are enabled
|
|
|
|
|
+ `D` or `4`: Debug messages are enabled
|
|
|
|
|
+ `T` or `5`: Trace messages are enabled. These messages can be logged
|
2021-05-25 09:55:06 +00:00
|
|
|
|
from the realtime threads.
|
|
|
|
|
|
2021-09-16 03:43:48 +00:00
|
|
|
|
PipeWire uses a "category.topic" naming scheme, with the following categories:
|
|
|
|
|
- `pw.*`: pipewire-internal topics
|
|
|
|
|
- `mod.*`: module topics, for example `mod.foo` would usually refer to the
|
|
|
|
|
"foo" module
|
2021-09-21 08:25:54 +00:00
|
|
|
|
- `ms.*`: media session topics
|
|
|
|
|
- `ms.mod.*`: media session modules, for example `ms.foo` would usually refer
|
|
|
|
|
to the "media-session-foo" module
|
2021-09-16 03:43:48 +00:00
|
|
|
|
- `conn.*`: connection-specific topics such as printing raw messages sent over
|
|
|
|
|
a communication socket. These are in a separate namespace as they are
|
|
|
|
|
usually vastly more verbose than the normal debugging topics.
|
|
|
|
|
This namespace must be explicitly enabled with a `conn.<glob>` glob.
|
2021-05-25 09:55:06 +00:00
|
|
|
|
|
2021-09-28 02:35:06 +00:00
|
|
|
|
|
|
|
|
|
The behavior of the logging can be further controlled with the following
|
|
|
|
|
environment variables:
|
|
|
|
|
- `PIPEWIRE_LOG_SYSTEMD=false`: disable logging to the systemd journal
|
|
|
|
|
- `PIPEWIRE_LOG=<filename>`: redirect the log to the given filename
|
2021-09-27 05:24:01 +00:00
|
|
|
|
- `PIPEWIRE_LOG_LINE=false`: don't log filename, function, and source code line
|
2021-09-28 02:35:06 +00:00
|
|
|
|
|
2021-05-25 09:55:06 +00:00
|
|
|
|
*/
|