Packman Build Service PMBS

pipewire-aptx.changes Changed

pipewire-aptx.spec Changed

pipewire-0.3.85.tar.gz/doc/api-tree.dox Deleted

@@ -1,123 +0,0 @@
-/**
-
-\defgroup api_pw_core Core API
-\brief PipeWire Core API
-\{
-\addtogroup pw_pipewire
-\addtogroup pw_main_loop
-\addtogroup pw_context
-\addtogroup pw_client
-\addtogroup pw_core
-\addtogroup pw_device
-\addtogroup pw_factory
-\addtogroup pw_link
-\addtogroup pw_loop
-\addtogroup pw_module
-\addtogroup pw_node
-\addtogroup pw_permission
-\addtogroup pw_port
-\addtogroup pw_proxy
-\addtogroup pw_registry
-\addtogroup pw_type
-\addtogroup pw_keys
-\}
-
-\defgroup api_pw_impl Implementation API
-\brief PipeWire Object Implementation API
-\{
-\addtogroup pw_impl_client
-\addtogroup pw_impl_core
-\addtogroup pw_impl_device
-\addtogroup pw_impl_factory
-\addtogroup pw_impl_link
-\addtogroup pw_impl_metadata
-\addtogroup pw_impl_module
-\addtogroup pw_impl_node
-\addtogroup pw_impl_port
-\addtogroup pw_buffers
-\addtogroup pw_control
-\addtogroup pw_data_loop
-\addtogroup pw_global
-\addtogroup pw_protocol
-\addtogroup pw_resource
-\addtogroup pw_thread_loop
-\addtogroup pw_work_queue
-\}
-
-\defgroup api_pw_util Utilities
-\brief PipeWire Utilities
-\{
-\addtogroup pw_array
-\addtogroup pw_conf
-\addtogroup pw_gettext
-\addtogroup pw_log
-\addtogroup pw_map
-\addtogroup pw_memblock
-\addtogroup pw_properties
-\addtogroup pw_thread
-\addtogroup pw_utils
-\}
-
-\defgroup api_pw_ext Extensions
-\brief PipeWire Extensions
-\{
-\addtogroup pw_client_node
-\addtogroup pw_metadata
-\addtogroup pw_profiler
-\addtogroup pw_protocol_native
-\addtogroup pw_session_manager
-\}
-
-\defgroup api_spa SPA
-\brief Simple Plugin API
-\{
-\addtogroup spa_buffer
-\addtogroup spa_control
-\addtogroup spa_debug
-\addtogroup spa_device
-\addtogroup spa_graph
-\addtogroup spa_node
-\addtogroup spa_param
-\addtogroup spa_pod
-\defgroup spa_utils Utilities
-Utility data structures, macros, etc.
-\{
-\addtogroup spa_ansi
-\addtogroup spa_utils_defs
-\addtogroup spa_dict
-\addtogroup spa_list
-\addtogroup spa_hooks
-\addtogroup spa_interfaces
-\addtogroup spa_json
-\addtogroup spa_json_pod
-\addtogroup spa_keys
-\addtogroup spa_names
-\addtogroup spa_result
-\addtogroup spa_ringbuffer
-\addtogroup spa_string
-\addtogroup spa_types
-\}
-\defgroup spa_support Support
-Support interfaces provided by host
-\{
-\addtogroup spa_cpu
-\addtogroup spa_dbus
-\addtogroup spa_i18n
-\addtogroup spa_log
-\addtogroup spa_loop
-\addtogroup spa_handle
-\addtogroup spa_plugin_loader
-\addtogroup spa_system
-\addtogroup spa_thread
-\}
-\}
-
-\defgroup pw_stream Stream
-\{
-\}
-
-\defgroup pw_filter Filter
-\{
-\}
-
-*/

pipewire-0.3.85.tar.gz/doc/api.dox Deleted

@@ -1,89 +0,0 @@
-/** \page page_api PipeWire API
-
-The PipeWire API consists of several parts:
-
-- The \ref pw_stream for a convenient way to send and receive data streams from/to PipeWire.
-
-- The \ref pw_filter for a convenient way to implement processing filters.
-
-- The \ref api_pw_core to access a PipeWire instance. This API is used
-by all clients that need to communicate with the \ref page_daemon and provides
-the necessary structs to interface with the daemon.
-
-- The \ref api_pw_impl is primarily used by the \ref page_daemon itself but also by the
-\ref page_session_manager and modules/extensions that need to build objects in
-the graph.
-
-- The \ref api_pw_util containing various utility functions and structures.
-
-- The \ref api_pw_ext for interfacing with certain extension modules.
-
-The APIs work through proxy objects, so that calling a method on an object
-invokes that same method on the remote side. Marshalling and de-marshalling is
-handled transparently by the \ref page_module_protocol_native.
-The below graph illustrates this approach:
-
-\dot
-digraph API {
-  compound=true;
-  node shape="box";
-  rankdir="RL";
-
-  subgraph cluster_daemon {
-       rankdir="TB";
-       label="PipeWire daemon";
-       style="dashed";
-
-       impl_core label="Core Impl. Object";
-       impl_device label="Device Impl. Object";
-       impl_node label="Node Impl. Object";
-  }
-
-  subgraph cluster_client {
-       rankdir="TB";
-       label="PipeWire client";
-       style="dashed";
-
-       obj_core label="Core Object";
-       obj_device label="Device Object";
-       obj_node label="Node Object";
-  }
-
-  obj_core -> impl_core;
-  obj_device -> impl_device;
-  obj_node -> impl_node;
-
-}
-\enddot
-
-It is common for clients to use both the \ref api_pw_core and the \ref api_pw_impl
-and both APIs are provided by the same library.
-
-- \subpage page_client_impl
-- \subpage page_proxy
-- \subpage page_streams
-- \subpage page_thread_loop
-
-
-\addtogroup api_pw_core Core API
-
-The Core API to access a PipeWire instance. This API is used by all
-clients to communicate with the \ref page_daemon.
-
-If you are familiar with Wayland implementation, the Core API is
-roughly equivalent to libwayland-client.
-
-See: \ref page_api
-
-
-\addtogroup api_pw_impl Implementation API
-
-The implementation API provides the tools to build new objects and
-modules.
-
-If you are familiar with Wayland implementation, the Implementation API is
-roughly equivalent to libwayland-server.
-
-See: \ref page_api
-
-*/

pipewire-0.3.85.tar.gz/doc/index.dox Deleted

@@ -1,55 +0,0 @@
-/** \mainpage PipeWire
-
-PipeWire is low-level multimedia framework that provides:
-
-- Graph based processing.
-- Support for out-of-process processing graphs with minimal overhead.
-- Flexible and extensible media format negotiation and buffer allocation.
-- Hard real-time capable plugins.
-- Very low-latency for both audio and video processing.
-
-See \ref page_overview for an overview of PipeWire and \ref page_design
-for the design principles guiding PipeWire.
-
-# Components
-
-PipeWire ships with the following components:
-
-- A \ref page_daemon that implements the IPC and graph processing.
-- An example \ref page_session_manager that manages objects in the \ref page_daemon.
-- A set of \ref page_tools to introspect and use the \ref page_daemon.
-- A \ref page_library to develop PipeWire applications and plugins (\ref
-  page_tutorial "tutorial").
-- The \ref page_spa used by both the \ref page_daemon and in the \ref
-  page_library.
-
-# API Documentation
-
-See \ref page_api.
-
-# More Documentation
-
-See our Wiki(https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/home) for
-More information on how to configure and use PipeWire.
-
-# Resources
-
-- PipeWire and AGL(https://wiki.automotivelinux.org/_media/pipewire_agl_20181206.pdf)
-- LAC 2020 Paper(https://lac2020.sciencesconf.org/307881/document)
-- PipeWire Under The Hood(https://venam.nixers.net/blog/unix/2021/06/23/pipewire-under-the-hood.html)
-- PipeWire: The Linux audio/video bus (LWN)(https://lwn.net/Articles/847412)
-- PipeWire Wikipedia(https://en.wikipedia.org/wiki/PipeWire)
-- Bluetooth, PipeWire and Whatsapp calls(https://gjhenrique.com/pipewire.html)
-- Intoduction to PipeWire(https://bootlin.com/blog/an-introduction-to-pipewire/)
-- A custom PipeWire node(https://bootlin.com/blog/a-custom-pipewire-node/)
-
-
-\page page_overview
-\page page_pipewire
-\page page_tools
-\page page_pipewire_modules
-\page page_api
-\page page_spa
-\page page_tutorial
-
-*/

pipewire-0.3.85.tar.gz/doc/input-filter.sh Deleted

pipewire-0.3.85.tar.gz/doc/manpage.dox.in Deleted

pipewire-0.3.85.tar.gz/doc/pipewire-architecture.dox Deleted

pipewire-0.3.85.tar.gz/doc/pipewire-modules.dox Deleted

@@ -1,94 +0,0 @@
-/** \page page_pipewire_modules PipeWire Modules
-
-A PipeWire module is effectively a PipeWire client in an `.so` file that
-shares the \ref pw_context with the loading entity. Usually modules are
-loaded when they are listed in the configuration files. For example the
-default configuration file loads several modules:
-
-```
-context.modules = 
-    ...
-    # The native communication protocol.
-    {   name = libpipewire-module-protocol-native }
-
-    # 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 }
-    ...
-
-```
-The matching libraries are:
-```
-$ ls -1 /usr/lib64/pipewire-0.3/libpipewire-module*
-...
-/usr/lib64/pipewire-0.3/libpipewire-module-metadata.so
-/usr/lib64/pipewire-0.3/libpipewire-module-profiler.so
-/usr/lib64/pipewire-0.3/libpipewire-module-protocol-native.so
-/usr/lib64/pipewire-0.3/libpipewire-module-spa-device-factory.so
-...
-```
-
-A module's entry point is the `pipewire__module_init` function, see \ref
-PIPEWIRE_SYMBOL_MODULE_INIT.
-
-\code
-int pipewire__module_init(struct pw_impl_module *module, const char *args).`
-\endcode
-
-See the \ref page_module_example_sink and \ref page_module_example_source
-modules for a general oveview of how modules look like.
-
-List of known modules:
-
-- \subpage page_module_access
-- \subpage page_module_adapter
-- \subpage page_module_avb
-- \subpage page_module_client_device
-- \subpage page_module_client_node
-- \subpage page_module_combine_stream
-- \subpage page_module_echo_cancel
-- \subpage page_module_example_filter
-- \subpage page_module_example_sink
-- \subpage page_module_example_source
-- \subpage page_module_fallback_sink
-- \subpage page_module_ffado_driver
-- \subpage page_module_filter_chain
-- \subpage page_module_jackdbus_detect
-- \subpage page_module_jack_tunnel
-- \subpage page_module_link_factory
-- \subpage page_module_loopback
-- \subpage page_module_metadata
-- \subpage page_module_netjack2_driver
-- \subpage page_module_netjack2_manager
-- \subpage page_module_pipe_tunnel
-- \subpage page_module_portal
-- \subpage page_module_profiler
-- \subpage page_module_protocol_native
-- \subpage page_module_protocol_pulse
-- \subpage page_module_protocol_simple
-- \subpage page_module_pulse_tunnel
-- \subpage page_module_raop_sink
-- \subpage page_module_raop_discover
-- \subpage page_module_roc_sink
-- \subpage page_module_roc_source
-- \subpage page_module_rtp_sap
-- \subpage page_module_rtp_sink
-- \subpage page_module_rtp_source
-- \subpage page_module_rtp_session
-- \subpage page_module_rt
-- \subpage page_module_session_manager
-- \subpage page_module_vban_recv
-- \subpage page_module_vban_send
-- \subpage page_module_x11_bell
-- \subpage page_module_zeroconf_discover
-
-*/

pipewire-0.3.85.tar.gz/doc/pipewire-portal.dox Deleted

@@ -1,215 +0,0 @@
-/** \page page_portal Portal Access Control
-
-This document explains how clients from the portal are handled.
-
-The portal is a DBus service that exposes interfaces to
-request access to the PipeWire daemon to perform a certain set of
-functions. The PipeWire daemon runs outside the sandbox, the portal is a way
-for clients inside the sandbox to connect to and use PipeWire.
-
-The PipeWire socket is not exposed in the sandbox. Instead, The portal
-connects to PipeWire on behalf of the client, informing PipeWire that this
-client is a portal-managed client. PipeWire can detect and enforce
-extra permission checks on the portal managed clients.
-
-Once such portal is the camera
-portal(https://flatpak.github.io/xdg-desktop-portal/portal-docs.html#gdbus-org.freedesktop.portal.Camera)
-that provides a PipeWire session to stream video from a camera.
-
-
-# Use Cases
-
-## New Portal Managed Clients Need Device Permissions Configured
-
-When a new client is detected, the available objects need to be
-scanned and permissions configured for each of them.
-
-Only the devices belonging to the media_roles given by the
-portal are considered.
-
-## New Devices Need To Be Made Visible To Portal Managed Clients
-
-Newly created objects are made visible to a client when the client
-is allowed to interact with it.
-
-Only the devices belonging to the media_roles given by the
-portal are considered.
-
-## Permissions For A Device Need To Be Revoked
-
-The session manager listens to changes in the permissions of devices
-and will remove the client permissions accordingly.
-
-Usually this is implemented by listening to the permission store
-DBus object. The desktop environment might provide a configuration panel
-where these permissions can be managed.
-
-
-# Design
-
-## The Portal
-
-A sandboxed client cannot connect to PipeWire directly. Instead, it connects
-to the sandbox side of the portal which then connects the PipeWire daemon to
-configure the session. The portal then hands the file descriptor of the
-PipeWire connection to the client and the client can use this file descriptor
-to interface with the PipeWire session directly.
-
-When the portal connects, it will set the following properties on the
-client object:
-
-- `"pipewire.access.portal.is_portal" = true` for the connection of the
-  portal itself (as opposed to a client managed by the portal).
-- `"pipewire.access.portal.app_id"` the application ID(https://docs.flatpak.org/en/latest/conventions.html#application-ids) of the client.
-- `"pipewire.access.portal.media_roles"` media roles of the client.
-  Currently only `"Camera"` is defined.
-
-Before returning the connection to a client, the portal configures
-minimal permissions on the client. No objects are initially visible. It is
-the task of the \ref page_session_manager to make the objects in the graph
-visible, depending on the client's `media_roles` (see also \ref
-PW_KEY_MEDIA_ROLE).
-
-## The PipeWire Portal Module
-
-The PipeWire daemon uses the \ref page_module_portal to find the PID of the
-processes that owns the DBus name `org.freedesktop.portal.Desktop`
-(see the XDG Desktop Portal(https://github.com/flatpak/xdg-desktop-portal)).
-
-Client connections from this PID are tagged as \ref PW_KEY_ACCESS
-`"portal"` (see \ref page_module_access). It will also set ALL permissions for
-this client so that it can resume.
-
-\dot
-digraph pw {
-  compound=true;
-  node shape="box";
-  rankdir="TB";
-
-  dbus label="org.freedesktop.portal.Desktop";
-
-  portal_access label="PipeWire (mod: Portal Access)";
-  portal label="xdg-desktop-portal";
-
-  dbus -> portal_access arrowhead="dot";
-  dbus -> portal arrowhead="dot";
-
-  portal_access -> portal label="pipewire.access = portal";
-
-  { rank="same"; portal_access; portal}
-}
-\enddot
-
-## The Client
-
-A client can ask the portal for a connection to the PipeWire daemon.
-
-\dot
-digraph pw {
-  compound=true;
-  node shape="box";
-  rankdir="LR";
-
-  pw label="PipeWire";
-  portal label="xdg-desktop-portal";
-  client label="client";
-
-  client -> portal;
-  portal -> pw label="portal.is_portal=true", arrowhead="none"
-
-  {rank="min"; pw};
-  {rank="max"; client};
-}
-\enddot
-
-The portal maintains an (unrestricted) connection to the PipeWire daemon with
-`"pipewire.access.portal.is_portal" = true` to identify the nodes the client
-needs access to. It then creates a new restricted connection for the client,
-tagged with additional information.
-
-\dot
-digraph pw {
-  compound=true;
-  node shape="box";
-  rankdir="LR";
-
-  pw label="PipeWire";
-  portal label="xdg-desktop-portal";
-  client label="client";
-
-  client -> portal arrowhead="none";
-  portal -> pw label="portal.is_portal=true", arrowhead="none"
-  portal -> pw label="portal.app_id = $appid"
-
-  {rank="min"; pw};
-  {rank="max"; client};
-}
-\enddot
-
-The file descriptor for this restricted connection is passed back to the
-client which can now make use of the resources it has been permitted to
-access.
-
-\dot
-digraph pw {
-  compound=true;
-  node shape="box";
-  rankdir="LR";
-
-  pw label="PipeWire";
-  portal label="xdg-desktop-portal";
-  client label="client";
-
-  portal -> pw label="portal.is_portal=true", arrowhead="none"
-
-  pw->client label="restricted connection";
-
-  {rank="min"; pw};
-  {rank="max"; client};
-}
-\enddot
-
-## The Session Manager
-
-The session manager listens for new clients to appear. It will use the
-\ref PW_KEY_ACCESS property to find portal connections. For client connections
-from the portal the session manager checks the requested `media_roles` and
-enables or disables access to the respective PipeWire objects.
-It might have to consult a database to decide what is allowed, for example the
-org.freedesktop.impl.portal.PermissionStore(https://flatpak.github.io/xdg-desktop-portal/portal-docs.html#gdbus-org.freedesktop.impl.portal.PermissionStore).
-
-\dot
-strict digraph pw {
-  compound=true;
-  node shape="box";
-  rankdir="LR";
-
-  portal label="xdg-desktop-portal";
-  client label="client";
-
-
-  subgraph {
-	  rankdir="TB";
-	  permissions label="PermissionStore";
-
-	  sm->permissions;
-
-	  sm label="Session Manager";
-	  pw label="PipeWire";
-	  sm -> pw headlabel="allow $media.roles";

pipewire-0.3.85.tar.gz/doc/pipewire-protocol.dox Deleted

@@ -1,1573 +0,0 @@
-/** \page page_native_protocol Native Protocol
-
-PipeWire has a pluggable client/server IPC protocol.
-
-The reference implementation uses unix sockets and is implemented in
-\ref page_module_protocol_native.
-
-We document the messages here.
-
-# Message header
-
-Each message on the unix socket contains a 16 bytes header and a
-variable length payload size:
-
-```
-    0                   1                   2                   3
-    0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |                     Id                                        |
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |    opcode     |                   size                        |
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |                         seq                                   |
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |                         n_fds                                 |
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |                     payload POD                               |
-   .                                                               .
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-   |                     optional footer POD                       |
-   .                                                               .
-   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-```
-
-
-These are four uint32 words to be read in native endianness.
-
-- Id: the message id this is the destination resource/proxy id
-- opcode: the opcode on the resource/proxy interface
-- size: the size of the payload and optional footer of the message
-- seq: an increasing sequence number for each message
-- n_fds: number of file descriptors in this message.
-
-The sender should send along with each message the fds that belong to
-the message. If there are more than the maximum number of fds in the
-message than can fit in one message, the message is split into multiple
-parts.
-
-A receiver needs to first read the header to know the size of the
-complete message. After collecting the complete message, it can start
-processing it.
-
-The payload is a single POD see \ref page_spa_pod for details.
-
-After the payload, there is an optional footer POD object.
-
-# Making a connection
-
-First a connection is made to a unix domain socket. By default, the socket is
-named as "pipewire-0" and searched in the following directories:
-
- - getenv("PIPEWIRE_RUNTIME_DIR")
- - getenv("XDG_RUNTIME_DIR")
- - getenv("USERPROFILE")
-
-
-The client opens the socket and allocates a Core proxy with id 0 and a Client
-proxy with id 1. The proxy is nothing more than a way to identify the remote
-objects with an id. Usually they also contain the type and version of the
-remote object and some helpers (interfaces) to dispatch messages.
-
-The server will allocate a new Core resource with id 0. Resources are the
-counterpart of client proxies and also typically contain extra information
-and helpers (interfaces) to dispatch messages.
-
-The client sends the Core::Hello message on the socket to start the
-communication.
-
-The server binds the client resource with id 1 to the client. This means
-that the client object on the server will now have a resource with a
-client side proxy associated with it.
-
-When the client sends a message for a certain proxy, the server side
-resource with the same id for the client is found and the message is
-dispatched to the object associated with the resource.
-
-Similarly when a server sends a message on a resource, the client will
-find the proxy with the same id and dispatch the message to it's
-associated object.
-
-The client then sends client properties to the server.
-
-```
-   client                                    server
-     |---------------------------------------->|
-     |            open socket                  |
-     |                                         |
-     |---------------------------------------->|
-     |            Core::Hello(version)         |
-     |                                         |
-     |---------------------------------------->|
-     |       Client::UpdateProperties          |
-     .                                         .
-```
-
-This completes the setup of the client. The newly connected client will
-appear in the registry at this point.
-
-# Core proxy/resource
-
-The core is always the object with Id 0.
-
-## Core Methods (Id 0)
-
-### Core::Hello (Opcode 1)
-
-The first message sent by a client is the Hello message and contains the
-version number of the client.
-
-```
-   Struct(
-      Int: version
-   )
-```
-
-The version is 3.
-
-### Core::Sync (Opcode 2)
-
-The Sync message will result in a Done event from the server. When the Done
-event is received, the client can be sure that all operations before the Sync
-method have been completed.
-
-```
-   Struct(
-      Int: id
-      Int: seq
-   )
-```
-
-- id: the id will be returned in the Done event.
-- seq: is usually generated automatically and will be returned in the Done event.
-
-### Core::Pong (Opcode 3)
-
-Is sent from the client to the server when the server emits the Ping event.
-The id and seq should be copied from the Ping event.
-
-```
-   Struct(
-      Int: id
-      Int: seq
-   )
-```
-
-### Core::Error (Opcode 4)
-
-An error occured in an object on the client.
-
-```
-   Struct(
-      Int: id
-      Int: seq
-      Int: res
-      String: message
-   )
-```
-
-- id: The id of the proxy that is in error.
-- seq: a seq number from the failing request (if any)
-- res: a negative errno style error code
-- message: an error message
-
-### Core::GetRegistry (Opcode 5)
-
-A client requests to bind to the registry object and list the available objects
-on the server.
-
-Like with all bindings, first the client allocates a new proxy id and puts this
-as the new_id field. Methods and Events can then be sent and received on the 
-new_id (in the message Id field).
-
-```
-   Struct(
-      Int: version
-      Int: new_id
-   )
-```
-- version: the version of the registry interface used on the client
-- new_id: the id of the new proxy with the registry interface
-
-After this method, the server will start sending Registry::Global events
-to the proxy with new_id.
-
-```
-   client                                    server
-     |                                         |
-     | new proxy(new_id)                       |
-     |---------------------------------------->|  new resource(new_id)

pipewire-0.3.85.tar.gz/doc/pipewire-scheduling.dox Deleted

@@ -1,193 +0,0 @@
-/** \page page_scheduling Graph Scheduling
-
-This document tries to explain how the PipeWire graph is scheduled.
-
-Graph are constructed from linked nodes together with their ports. This
-results in a dependency graph between nodes. Special care is taken for
-loopback links so that the graph remains a directed graph.
-
-
-# Nodes
-
-Nodes are objects with 0 or more input and output ports.
-
-Each node also has:
-
-- an eventfd to signal the node that it can start processing
-- an activation record that lives in shared memory with memfd.
-
-```
-   eventfd
-  +-^---------+
-  |           |
- in          out
-  |           |
-  +-v---------+
-    activation {
-      status:OK,        // bitmask of NEED_DATA, HAVE_DATA or OK
-      pending:0,	// number of unsatisfied dependencies to be able to run
-      required:0        // number of dependencies with other nodes
-    }
-```
-
-The activation record has the following information:
-
- - processing state and pending dependencies. As long as there are pending dependencies
-   the node can not be processed. This is the only relevant information for actually
-   scheduling the graph and is shown in the above illustration.
- - Current status of the node and profiling info (TRIGGERED, AWAKE, FINISHED, timestamps
-   when the node changed state).
- - Timing information, mostly for drivers when the processing started, the time, duration
-   and rate (quantum) etc..
- - Information about repositions (seek) and timebase owners.
-
-
-# Links
-
-When two nodes are linked together, the output node becomes a dependency for the input
-node. This means the input node can only start processing when the output node is finished.
-
-This dependency is reflected in the required counter in the activation record. In below
-illustration, B's required field is incremented with 1. The pending field is set to the
-required field when the graph is started. Node A will keep a list of all targets (B) that it
-is a dependency of.
-
-This dependency update is only performed when the link is ready (negotiated) and the nodes
-are ready to schedule (runnable).
-
-
-```
-   eventfd                                eventfd
-  +-^---------+                          +-^---------+
-  |           |        link              |           |
- in     A    out ---------------------> in     B    out
-  |           |                          |           |
-  +-v---------+                          +-v---------+
-    activation {       target              activation {
-      status:OK,  -------------------->      status:OK,
-      pending:0,                             pending:1,
-      required:0                             required:1
-    }                                      }
-```
-
-Multiple links between A and B will only result in 1 target link between A and B.
-
-
-# Drivers
-
-The graph can only run if there is a driver node that is in some way linked to an
-active node.
-
-The driver is special because it will have to initiate the processing in the graph. It
-will use a timer or some sort of interrupt from hardware to start the cycle.
-
-Any node can also be a candidate for a driver (when the node.driver property is true).
-PipeWire will select the node with the highest priority.driver property as the driver.
-
-Nodes will be assigned to the driver node they will be scheduled with. Each node holds
-a reference to the driver and increments the required field of the driver.
-
-When a node is ready to be scheduled, the driver adds the node to its list of targets
-and increments the required field.
-
-
-```
-   eventfd                                eventfd
-  +-^---------+                          +-^---------+
-  |           |        link              |           |
- in     A    out ---------------------> in     B    out
-  |           |                          |           |
-  +-v---------+                          +-v---------+
-    activation {       target              activation {
-      status:OK,  -------------------->      status:OK,
-      pending:0,                             pending:0,
-      required:1                             required:2
-    }                                      }
-      |    ^                         ^
-      |    |                        /   /
-      |    |                       /   /
-      |    |                      /   /
-      |    |                     /   /
-      |    |                    /   /
-      v    |     /-------------/   /
-    activation {                  /
-      status:OK, V---------------/
-      pending:0,
-      required:2
-    }
-  +-^---------+
-  |           |
-  |   driver  |
-  |           |
-  +-v---------+
-   eventfd
-```
-
-As seen in the illustration above, the driver holds a link to each node it needs to
-schedule and each node holds a link to the driver. Some nodes hold a link to other
-nodes.
-
-It is possible that the driver is the same as a node in the graph (for example node A)
-but conceptually, the links above are still valid.
-
-The driver will then start processing the graph by emitting the ready signal. PipeWire
-will then:
-
- - Check the previous cycle. Did it complete? Mark xrun on unfinished nodes.
- - Perform reposition requests if any, timebase changes, etc..
- - The pending counter of each follower node is set to the required field.
- - It then loops over all targets of the driver and atomically decrements the required
-   field of the activation record. When the required field is 0, the eventfd is signaled
-   and the node can be scheduled.
-
-In our example above, Node A and B will have their pending state decremented. Node A
-will be 0 and will be triggered first (node B has 2 pending dependencies to start with and
-will not be triggered yet). The driver itself also has 2 dependencies left and will not
-be triggered (complete) yet.
-
-## Scheduling node A
-
-When the eventfd is signaled on a node, we say the node is triggered and it will be able
-to process data. It consumes the input on the input ports and produces more data on the
-output ports.
-
-After processing, node A goes through the list of targets and decrements each pending
-field (node A has a reference to B and the driver).
-
-In our above example, the driver is decremented (from 2 to 1) but is not yet triggered.
-node B is decremented (from 1 to 0) and is triggered by writing to the eventfd.
-
-## Scheduling node B
-
-Node B is scheduled and processes the input from node A. It then goes through the list of
-targets and decrements the pending fields.  It decrements the pending field of the
-driver (from 1 to 0) and triggers the driver.
-
-## Scheduling the driver
-
-The graph always completes after the driver is triggered and scheduled. All required
-fields from all the nodes in the target list of the driver are now 0.
-
-The driver calculates some stats about cpu time etc.
-
-# Remote nodes.
-
-For remote nodes, the eventfd and the activation is transfered from the server
-to the client.
-
-This means that writing to the remote client eventfd will wake the client directly
-without going to the server first.
-
-All remote clients also get the activation and eventfd of the peer and driver they
-are linked to and can directly trigger peers and drivers without going to the
-server first.
-
-## Remote driver nodes.
-
-Remote drivers start the graph cycle directly without going to the server first.
-
-After they complete (and only when the profiler is active), they will trigger an
-extra eventfd to signal the server that the graph completed. This is used by the
-server to generate the profiler info.
-
-*/

pipewire-0.3.85.tar.gz/doc/pipewire-tools.dox.in Deleted

pipewire-0.3.85.tar.gz/doc/pipewire.dox Deleted

pipewire-0.3.85.tar.gz/doc/tutorial.dox Deleted

pipewire-0.3.85.tar.gz/man Deleted

pipewire-0.3.85.tar.gz/man/meson.build Deleted

@@ -1,45 +0,0 @@
-manpage_conf = configuration_data()
-manpage_conf.set('PACKAGE_NAME', meson.project_name())
-manpage_conf.set('PACKAGE_VERSION', meson.project_version())
-manpage_conf.set('PACKAGE_URL', 'https://pipewire.org')
-manpage_conf.set('PACKAGE_BUGREPORT', 'https://gitlab.freedesktop.org/pipewire/pipewire/issues')
-manpage_conf.set('PIPEWIRE_CONFIG_DIR', pipewire_configdir)
-manpage_conf.set('PIPEWIRE_CONFDATADIR', pipewire_confdatadir)
-
-manpages = 
-  'pipewire.1.rst.in',
-  'pipewire-pulse.1.rst.in',
-  'pipewire.conf.5.rst.in',
-  'pw-cat.1.rst.in',
-  'pw-cli.1.rst.in',
-  'pw-config.1.rst.in',
-  'pw-dot.1.rst.in',
-  'pw-link.1.rst.in',
-  'pw-metadata.1.rst.in',
-  'pw-mididump.1.rst.in',
-  'pw-mon.1.rst.in',
-  'pw-profiler.1.rst.in',
-  'pw-top.1.rst.in',
-
-
-if get_option('pipewire-jack').allowed()
-  manpages += 'pw-jack.1.rst.in'
-endif
-
-if not generate_manpages
-  subdir_done()
-endif
-
-foreach m : manpages
-  file = m.split('.rst.in').get(0)
-  rst = configure_file(input : m,
-                       output : file + '.rst',
-                       configuration : manpage_conf)
-  section = file.split('.').get(-1)
-  custom_target(file + '.target',
-                output : file,
-                input : rst,
-                command : rst2man, '@INPUT@', '@OUTPUT@',
-                install : true,
-                install_dir : get_option('mandir') / 'man' + section)
-endforeach

pipewire-0.3.85.tar.gz/man/pipewire-pulse.1.rst.in Deleted

pipewire-0.3.85.tar.gz/man/pipewire.1.rst.in Deleted

pipewire-0.3.85.tar.gz/man/pipewire.conf.5.rst.in Deleted

@@ -1,112 +0,0 @@
-pipewire.conf
-#############
-
---------------------------------------
-The PipeWire server configuration file
---------------------------------------
-
-:Manual section: 5
-:Manual group: File Formats Manual
-
-.. _synopsis:
-
-SYNOPSIS
-========
-
-*$XDG_CONFIG_HOME/pipewire/pipewire.conf*
-
-*@PIPEWIRE_CONFIG_DIR@/pipewire.conf*
-
-*@PIPEWIRE_CONFDATADIR@/pipewire.conf*
-
-*@PIPEWIRE_CONFDATADIR@/pipewire.conf.d/*
-
-*@PIPEWIRE_CONFIG_DIR@/pipewire.conf.d/*
-
-*$XDG_CONFIG_HOME/pipewire/pipewire.conf.d/*
-
-DESCRIPTION
-===========
-
-PipeWire is a service that facilitates sharing of multimedia content
-between devices and applications.
-
-On startup, the daemon reads a main configuration file to configure
-itself. It executes a series of commands listed in the config
-file.
-
-The config files are loaded in the order listed in the SYNOPSIS_.
-The environment variables ``PIPEWIRE_CONFIG_DIR``, ``PIPEWIRE_CONFIG_PREFIX``
-and ``PIPEWIRE_CONFIG_NAME`` can be used to specify an alternative config
-directory, subdirectory and file respectively.
-
-Next to the configuration file can be a directory with the same name as
-the file with a ``.d/`` suffix. All directories in the SYNOPSIS_ directory
-search paths are traversed in the listed order and the contents of the
-``*.conf`` files inside them are appended to the main configuration file
-as overrides. Object sections are merged and array sections are appended.
-
-
-CONFIGURATION FILE FORMAT
-=========================
-
-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:
-
-name = value # simple assignment
-
-name = { key1 = value1 key2 = value2 } # a dictionary with two
-entries
-
-name =  value1 value2  # an array with two entries
-
-name =  { k = v1 } { k = v2 }  # an array of dictionaries
-
-
-The configuration files can be expressed in full JSON syntax but for ease
-of use, a relaxed format may be used where:
-
- * ``:`` to delimit keys and values can be substuted by ``=`` or a space.
- * ``"`` around keys and string can be omitted as long as no special characters are used in the strings.
- * ``,`` to separate objects can be replaced with a whitespace character.
- * ``#`` can be used to start a comment until the line end
-
-
-CONFIGURATION FILE SECTIONS
-===========================
-
-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 of dictionaries. 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 of dictionaries. Each entry in the array is a dictionary containing the *factory* to create an
-  object from and optional extra arguments specific to that factory.
-
-context.exec
-  Array of dictionaries. Each entry in the array is dictionary containing the *path* of a program to
-  execute on startup and optional *args*.
-
-  This array used to contain an entry to start the session manager but this mode
-  of operation has since been demoted to development aid. Avoid starting a
-  session manager in this way in production environment.
-
-AUTHORS
-=======
-
-The PipeWire Developers <@PACKAGE_BUGREPORT@>; PipeWire is available from @PACKAGE_URL@
-
-SEE ALSO
-========
-
-``pipewire(1)``,
-``pw-mon(1)``,

pipewire-0.3.85.tar.gz/man/pw-cat.1.rst.in Deleted

@@ -1,176 +0,0 @@
-pw-cat
-######
-
------------------------------------
-Play and record media with PipeWire
------------------------------------
-
-:Manual section: 1
-:Manual group: General Commands Manual
-
-SYNOPSIS
-========
-
-| **pw-cat** *options* *FILE* \| -
-| **pw-play** *options* *FILE* \| -
-| **pw-record** *options* *FILE* \| -
-| **pw-midiplay** *options* *FILE* \| -
-| **pw-midirecord** *options* *FILE* \| -
-| **pw-dsdplay** *options* *FILE* \| -
-
-DESCRIPTION
-===========
-
-**pw-cat** is a simple tool for playing back or
-capturing raw or encoded media files on a PipeWire
-server. It understands all audio file formats supported by
-``libsndfile`` for PCM capture and playback. When capturing PCM, the filename
-extension is used to guess the file format with the WAV file format as
-the default.
-
-It understands standard MIDI files for playback and recording. This tool
-will not render MIDI files, it will simply make the MIDI events available
-to the graph. You need a MIDI renderer such as qsynth, timidity or a hardware
-MIDI rendered to hear the MIDI.
-
-DSD playback is supported with the DSF file format. This tool will only work
-with native DSD capable hardware and will produce an error when no such
-hardware was found.
-
-When the *FILE* is - input and output will be raw data from STDIN and
-STDOUT respectively.
-
-OPTIONS
-=======
-
--h | --help
-  Show help.
-
---version
-  Show version information.
-
--v | --verbose
-  Verbose operation.
-
--R | --remote=NAME
-  The name the *remote* instance to connect to. If left unspecified,
-  a connection is made to the default PipeWire instance.
-
--p | --playback
-  Playback mode. Read data from the specified file, and play it back. If the tool
-  is called under the name **pw-play** or **pw-midiplay** this is the default.
-
--r | --record
-  Recording mode. Capture data and write it to the specified file. If the tool is
-  called under the name **pw-record** or **pw-midirecord** this is the default.
-
--m | --midi
-  MIDI mode. *FILE* is a MIDI file. If the tool is called under the name
-  **pw-midiplay** or **pw-midirecord** this is the default.
-  Note that this program will *not* render the MIDI events into audible samples,
-  it will simply provide the MIDI events in the graph. You need a separate
-  MIDI renderer such as qsynth, timidity or a hardware renderer to hear the MIDI.
-
--d | --dsd
-  DSD mode. *FILE* is a DSF file. If the tool is called under the name
-  **pw-dsdplay** this is the default.
-  Note that this program will *not* render the DSD audio. You need a DSD capable
-  device to play DSD content or this program will exit with an error.
-
---media-type=VALUE
-  Set the media type property (default Audio/Midi depending on mode).
-  The media type is used by the session manager to select a suitable target
-  to link to.
-
---media-category=VALUE
-  Set the media category property (default Playback/Capture depending on mode).
-  The media type is used by the session manager to select a suitable target
-  to link to.
-
---media-role=VALUE
-  Set the media role property (default Music).
-  The media type is used by the session manager to select a suitable target
-  to link to.
-
---target=VALUE
-  Set a node target (default auto). The value can be:
-
-  auto
-    Automatically select (Default)
-
-  0
-    Don't try to link this node
-
-  <id>
-    The object.serial or the node.name of a target node
-
---latency=VALUE*units*
-  Set the node latency (default 100ms)
-
-  The latency determines the minimum amount of time it takes
-  for a sample to travel from application to device (playback) and
-  from device to application (capture).
-
-  The latency determines the size of the buffers that the
-  application will be able to fill. Lower latency means smaller
-  buffers but higher overhead. Higher latency means larger buffers
-  and lower overhead.
-
-  Units can be **s** for seconds, **ms** for milliseconds,
-  **us** for microseconds, **ns** for nanoseconds.
-  If no units are given, the latency value is samples with the samplerate
-  of the file.
-
--P | --properties=VALUE
-  Set extra stream properties as a JSON object.
-
--q | --quality=VALUE
-  Resampler quality. When the samplerate of the source or
-  destination file does not match the samplerate of the server, the
-  data will be resampled. Higher quality uses more CPU. Values between 0 and 15 are
-  allowed, the default quality is 4.
-
---rate=VALUE
-  The sample rate, default 48000.
-
---channels=VALUE
-  The number of channels, default 2.
-
---channel-map=VALUE
-  The channelmap. Possible values include:
-  **mono**, **stereo**, **surround-21**,
-  **quad**, **surround-22**, **surround-40**,
-  **surround-31**, **surround-41**,
-  **surround-50**, **surround-51**,
-  **surround-51r**, **surround-70**,
-  **surround-71** or a comma separated list of channel names:
-  **FL**, **FR**, **FC**, **LFE**,
-  **SL**, **SR**, **FLC**, **FRC**,
-  **RC**, **RL**, **RR**, **TC**,
-  **TFL**, **TFC**, **TFR**, **TRL**,
-  **TRC**, **TRR**, **RLC**, **RRC**,
-  **FLW**, **FRW**, **LFE2**, **FLH**,
-  **FCH**, **FRH**, **TFLC**, **TFRC**,
-  **TSL**, **TSR**, **LLFR**, **RLFE**,
-  **BC**, **BLC**, **BRC**
-
---format=VALUE
-  The sample format to use. One of:
-  **u8**, **s8**, **s16** (default), **s24**, **s32**,
-  **f32**, **f64**.
-
---volume=VALUE
-  The stream volume, default 1.000.
-  Depending on the locale you have configured, "," or "." may be
-  used as a decimal separator. Check with **locale** command.
-
-AUTHORS
-=======
-
-The PipeWire Developers <@PACKAGE_BUGREPORT@>; PipeWire is available from @PACKAGE_URL@
-
-SEE ALSO
-========
-
-``PipeWire(1)``,
-``pw-mon(1)``,

pipewire-0.3.85.tar.gz/man/pw-cli.1.rst.in Deleted

@@ -1,195 +0,0 @@
-pw-cli
-######
-
------------------------------------
-The PipeWire Command Line Interface
------------------------------------
-
-:Manual section: 1
-:Manual group: General Commands Manual
-
-SYNOPSIS
-========
-
-| **pw-cli** *command*
-
-DESCRIPTION
-===========
-
-Interact with a PipeWire instance.
-
-When a command is given, **pw-cli**
-will execute the command and exit
-
-When no command is given, **pw-cli**
-starts an interactive session with the default PipeWire instance
-*pipewire-0*.
-
-Connections to other, remote instances can be made. The current instance
-name is displayed at the prompt.
-
-Note that **pw-cli** also creates a local PipeWire instance. Some commands
-operate on the current (remote) instance and some on the local instance, such
-as module loading.
-
-Use the 'help' command to list the available commands.
-
-GENERAL COMMANDS
-================
-
-help | h
-  Show a quick help on the commands available. It also lists the aliases
-  for many commands.
-
-quit | q
-  Exit from **pw-cli**
-
-MODULE MANAGEMENT
-=================
-
-| Modules are loaded and unloaded in the local instance, thus the pw-cli
-| binary itself and can add functionality or objects to the local
-| instance. It is not possible in PipeWire to load modules in another
-| instance.
-
-load-module *name* *arguments...*
-  Load a module specified by its name and arguments in the local instance.
-  For most modules it is OK to be loaded more than once.
-
-  This command returns a module variable that can be used
-  to unload the module.
-
-  The locally module is *not* visible in the remote instance. It is not
-  possible in PipeWire to load modules in a remote instance.
-
-unload-module *module-var*
-  Unload a module, specified either by its variable.
-
-OBJECT INTROSPECTION
-====================
-
-list-objects
-  List the objects of the current instance.
-
-  Objects are listed with their *id*, *type* and *version*.
-
-info *id* | *all*
-  Get information about a specific object or *all* objects.
-
-  Requesting info about an object will also notify you of changes.
-
-WORKING WITH REMOTES
-====================
-
-connect *remote-name*
-  Connect to a remote instance and make this the new current
-  instance.
-
-  If no remote name is specified, a connection is made to
-  the default remote instance, usually *pipewire-0*.
-
-  The special remote name called *internal* can be used to connect to
-  the local **pw-cli** PipeWire instance.
-
-  This command returns a remote var that can be used to disconnect or
-  switch remotes.
-
-disconnect *remote-var*
-  Disconnect from a *remote instance*.
-
-  If no remote name is specified, the current instance is disconnected.
-
-list-remotes
-  List all *remote instances*.
-
-switch-remote *remote-var*
-  Make the specified *remote* the current instance.
-
-  If no remote name is specified, the first instance is made current.
-
-NODE MANAGEMENT
-===============
-
-create-node *factory-name* *properties...*
-  Create a node from a factory in the current instance.
-
-  Properties are key=value pairs separated by whitespace.
-
-  This command returns a *node variable*.
-
-export-node *node-id* *remote-var*
-  Export a node from the local instance to the specified instance.
-  When no instance is specified, the node will be exported to the current
-  instance.
-
-DEVICE MANAGEMENT
-=================
-
-create-device *factory-name* *properties...*
-  Create a device from a factory in the current instance.
-
-  Properties are key=value pairs separated by whitespace.
-
-  This command returns a *device variable*.
-
-
-LINK MANAGEMENT
-===============
-
-create-link *node-id* *port-id* *node-id* *port-id* *properties...*
-  Create a link between 2 nodes and ports.
-
-  Port *ids* can be *-1* to automatically select an available port.
-
-  Properties are key=value pairs separated by whitespace.
-
-  This command returns a *link variable*.
-
-GLOBALS MANAGEMENT
-==================
-
-destroy *object-id*
-  Destroy a global object.
-
-
-PARAMETER MANAGEMENT
-====================
-
-enum-params *object-id* *param-id*
-  Enumerate params of an object.
-
-  *param-id* can also be given as the param short name.
-
-set-param *object-id* *param-id* *param-json*
-  Set param of an object.
-
-  *param-id* can also be given as the param short name.
-
-PERMISSION MANAGEMENT
-=====================
-
-permissions *client-id* *object-id* *permission*
-  Set permissions for a client.
-
-  *object-id* can be *-1* to set the default permissions.
-
-get-permissions *client-id*
-  Get permissions of a client.
-
-
-COMMAND MANAGEMENT
-==================
-
-send-command *object-id*
-  Send a command to an object.
-
-AUTHORS
-=======
-
-The PipeWire Developers <@PACKAGE_BUGREPORT@>; PipeWire is available from @PACKAGE_URL@
-
-SEE ALSO
-========
-
-``pipewire(1)``,
-``pw-mon(1)``,

pipewire-0.3.85.tar.gz/man/pw-config.1.rst.in Deleted

@@ -1,110 +0,0 @@
-pw-config
-#########
-
------------------------------
-Debug PipeWire Config parsing
------------------------------
-
-:Manual section: 1
-:Manual group: General Commands Manual
-
-SYNOPSIS
-========
-
-| **pw-config** *options* paths
-
-| **pw-config** *options* list *SECTION*
-
-| **pw-config** *options* merge *SECTION*
-
-DESCRIPTION
-===========
-
-List config paths and config sections and display the parsed
-output.
-
-This tool can be used to get an overview of the config file that will be
-parsed by the PipeWire server and clients.
-
-COMMON OPTIONS
-==============
-
--h | --help
-  Show help.
-
---version
-  Show version information.
-
--n | --name=NAME
-  Config Name (default 'pipewire.conf')
-
--p | --prefix=PREFIX
-  Config Prefix (default '')
-
--L | --no-newline
-  Omit newlines after values
-
--r | --recurse
-  Reformat config sections recursively
-
--N | --no-colors
-  Disable color output
-
--C | --color=WHEN
-  whether to enable color support. WHEN is `never`, `always`, or `auto`
-
-LISTING PATHS
-=============
-
-Specify the paths command. It will display all the config files that will
-be parsed and in what order.
-
-LISTING CONFIG SECTIONS
-=======================
-
-Specify the list command with an optional *SECTION* to list the configuration
-fragments used for *SECTION*. Without a *SECTION*, all sections will be
-listed.
-
-Use the -r options to reformat the sections.
-
-MERGING A CONFIG SECTION
-========================
-
-With the merge option and a *SECTION*, pw-config will merge all config files into
-a merged config section and dump the results. This will be the section used by
-the client or server.
-
-Use the -r options to reformat the sections.
-
-EXAMPLES
-========
-
-**pw-config**
-  List all config files that will be used
-
-**pw-config** -n pipewire-pulse.conf
-  List all config files that will be used by the PipeWire pulseaudio server.
-
-**pw-config** -n pipewire-pulse.conf list
-  List all config sections used by the PipeWire pulseaudio server
-
-**pw-config** -n jack.conf list context.properties
-  List the context.properties fragments used by the JACK clients
-
-**pw-config** -n jack.conf merge context.properties
-  List the merged context.properties used by the JACK clients
-
-**pw-config** -n pipewire.conf -r merge context.modules
-  List the merged context.modules used by the PipeWire server and reformat
-
-AUTHORS
-=======
-
-The PipeWire Developers <@PACKAGE_BUGREPORT@>; PipeWire is available from @PACKAGE_URL@
-
-SEE ALSO
-========
-
-``pipewire(1)``,
-``pw-dump(1)``,

pipewire-0.3.85.tar.gz/man/pw-dot.1.rst.in Deleted

@@ -1,65 +0,0 @@
-pw-dot
-######
-
----------------------------
-The PipeWire dot graph dump
----------------------------
-
-:Manual section: 1
-:Manual group: General Commands Manual
-
-SYNOPSIS
-========
-
-| **pw-dot** *options*
-
-DESCRIPTION
-===========
-
-Create a .dot file of the PipeWire graph.
-
-The .dot file can then be visualized with a tool like **dotty**
-or rendered to a PNG file with ``dot -Tpng pw.dot -o pw.png``.
-
-OPTIONS
-=======
-
--r | --remote=NAME
-  The name the remote instance to connect to. If left unspecified,
-  a connection is made to the default PipeWire instance.
-
--h | --help
-  Show help.
-
---version
-  Show version information.
-
--a | --all
-  Show all object types.
-
--s | --smart
-  Show linked objects only.
-
--d | --detail
-  Show all object properties.
-
--o FILE | --output=FILE
-  Output file name (Default pw.dot). Use - for stdout.
-
--L | --lr
-  Lay the graph from left to right, instead of dot's default top to bottom.
-
--9 | --90
-  Lay the graph using 90-degree angles in edges.
-
-AUTHORS
-=======
-
-The PipeWire Developers <@PACKAGE_BUGREPORT@>; PipeWire is available from @PACKAGE_URL@
-
-SEE ALSO
-========
-
-``pipewire(1)``,
-``pw-cli(1)``,
-``pw-mon(1)``,

pipewire-0.3.85.tar.gz/man/pw-jack.1.rst.in Deleted

@@ -1,65 +0,0 @@
-pw-jack
-#######
-
-----------------------------
-Use PipeWire instead of JACK
-----------------------------
-
-:Manual section: 1
-:Manual group: General Commands Manual
-
-SYNOPSIS
-========
-
-| **pw-jack** *options* *COMMAND* *FILE*
-
-DESCRIPTION
-===========
-
-**pw-jack** modifies the ``LD_LIBRARY_PATH`` environment
-variable so that applications will load PipeWire's reimplementation
-of the JACK client libraries instead of JACK's own
-libraries. This results in JACK clients being redirected to
-PipeWire.
-
-If PipeWire's reimplementation of the JACK client libraries
-has been installed as a system-wide replacement for JACK's
-own libraries, then the whole system already behaves in that way,
-in which case **pw-jack** has no practical effect.
-
-OPTIONS
-=======
-
--h
-  Show help.
-
--r NAME
-  The name of the remote instance to connect to. If left
-  unspecified, a connection is made to the default PipeWire
-  instance.
-
--v
-  Verbose operation.
-
-EXAMPLES
-========
-
-| **pw-jack** sndfile-jackplay /usr/share/sounds/freedesktop/stereo/bell.oga
-
-NOTES
-=====
-
-Using PipeWire for audio is currently considered to be
-experimental.
-
-AUTHORS
-=======
-
-The PipeWire Developers <@PACKAGE_BUGREPORT@>;
-PipeWire is available from @PACKAGE_URL@
-
-SEE ALSO
-========
-
-``pipewire(1)``,
-``jackd(1)``,

pipewire-0.3.85.tar.gz/man/pw-link.1.rst.in Deleted

@@ -1,139 +0,0 @@
-pw-link
-#######
-
--------------------------
-The PipeWire Link Command
--------------------------
-
-:Manual section: 1
-:Manual group: General Commands Manual
-
-SYNOPSIS
-========
-
-| **pw-link** *options* -o|-i|-l *out-pattern* *in-pattern*
-
-| **pw-link** *options* *output* *input*
-
-| **pw-link** *options* -d *output* *input*
-
-| **pw-link** *options* -d *link-id*
-
-DESCRIPTION
-===========
-
-List, create and destroy links between PipeWire ports.
-
-COMMON OPTIONS
-==============
-
--r | --remote=NAME
-  The name the *remote* instance to monitor. If left unspecified,
-  a connection is made to the default PipeWire instance.
-
--h | --help
-  Show help.
-
---version
-  Show version information.
-
-LISTING PORTS AND LINKS
-=======================
-
-Specify one of -o, -i or -l to list the matching optional input and
-output ports and their links.
-
--o | --output
-  List output ports
-
--i | --input
-  List output ports
-
--l | --links
-  List links
-
--m | --monitor
-  Monitor links and ports. **pw-link** will not exit but monitor and
-  print new and destroyed ports or links.
-
--I | --id
-  List IDs. Also list the unique link and port ids.
-
--v | --verbose
-  Verbose port properties. Also list the port-object-path and the port-alias.
-
-CONNECTING PORTS
-================
-
-Without any list option (-i, -o or -l), the given ports will be linked.
-Valid port specifications are:
-
-*port-id*
-  As obtained with the -I option when listing ports.
-
-*node-name:port-name*
-  As obtained when listing ports.
-
-*port-object-path*
-  As obtained from the first alternative name for the port when listing
-  them with the -v option.
-
-*port-alias*
-  As obtained from the second alternative name for the ports when listing
-  them with the -v option.
-
-Extra options when linking can be given:
-
--L | --linger
-  Linger. Will create a link that exists after **pw-link** is destroyed.
-  This is the default behaviour, unless the -m option is given.
-
--P | --passive
-  Passive link. A passive link will keep both nodes it links inactive
-  unless another non-passive link is activating the nodes. You can use this
-  to link a sink to a filter and have them both suspended when nothing else
-  is linked to either of them.
-
--p | --props=PROPS
-  Properties as JSON object. Give extra properties when creaing the link.
-
-DISCONNECTING PORTS
-===================
-
-When the -d option is given, an existing link between port is destroyed.
-
-To disconnect port, a single *link-id*, as obtained when listing links with
-the -I option, or two port specifications can be given. See the connecting
-ports section for valid port specifications.
-
--d | --disconnect
-  Disconnect ports
-
-EXAMPLES
-========
-
-**pw-link** -iol
-  List all port and their links.
-
-**pw-link** -lm
-  List all links and monitor changes until **pw-link** is stopped.
-
-**pw-link** paplay:output_FL alsa_output.pci-0000_00_1b.0.analog-stereo:playback_FL
-  Link the given output port to the input port.
-
-**pw-link** -lI
-  List links and their Id.
-
-**pw-link** -d 89
-  Destroy the link with id 89.
-
-AUTHORS
-=======
-
-The PipeWire Developers <@PACKAGE_BUGREPORT@>; PipeWire is available from @PACKAGE_URL@
-
-SEE ALSO
-========
-
-``pipewire(1)``,
-``pw-cli(1)``,

pipewire-0.3.85.tar.gz/man/pw-metadata.1.rst.in Deleted

@@ -1,82 +0,0 @@
-pw-metadata
-###########
-
----------------------
-The PipeWire metadata
----------------------
-
-:Manual section: 1
-:Manual group: General Commands Manual
-
-SYNOPSIS
-========
-
-| **pw-metadata** *options* *id* *key* *value* *type*    
-
-DESCRIPTION
-===========
-
-Monitor, set and delete metadata on PipeWire objects.
-
-Metadata are key/type/value triplets attached to objects identified
-by *id*. The metadata is shared between all applications
-binding to the same metadata object. When an object is destroyed, all its
-metadata is automatically removed.
-
-When no *value* is given, **pw-metadata** will query and
-log the metadata matching the optional arguments *id*
-and *key*. Without any arguments, all metadata is displayed.
-
-When *value* is given, **pw-metadata** will set the
-metadata for *id* and *key* to *value* and
-an optional *type*.
-
-OPTIONS
-=======
-
--r | --remote=NAME
-  The name the remote instance to use. If left unspecified,
-  a connection is made to the default PipeWire instance.
-
--h | --help
-  Show help.
-
---version
-  Show version information.
-
--l | --list
-  List available metadata objects
-
--m | --monitor
-  Keeps running and log the changes to the metadata.
-
--d | --delete
-  Delete all metadata for *id* or for the specified *key* of object *id*.
-  Without any option, all metadata is removed.
-
--n | --name
-  Metadata name (Default: "default").
-
-EXAMPLES
-========
-
-**pw-metadata**
-  Show metadata in default name.
-
-**pw-metadata** -n settings 0
-  Display settings.
-
-**pw-metadata** -n settings 0 clock.quantum 1024
-  Change clock.quantum to 1024.
-
-AUTHORS
-=======
-
-The PipeWire Developers <@PACKAGE_BUGREPORT@>; PipeWire is available from @PACKAGE_URL@
-
-SEE ALSO
-========
-
-``pipewire(1)``,
-``pw-mon(1)``,
-``pw-cli(1)``,

pipewire-0.3.85.tar.gz/man/pw-mididump.1.rst.in Deleted

pipewire-0.3.85.tar.gz/man/pw-mon.1.rst.in Deleted

pipewire-0.3.85.tar.gz/man/pw-profiler.1.rst.in Deleted

@@ -1,57 +0,0 @@
-pw-profiler
-###########
-
----------------------
-The PipeWire profiler
----------------------
-
-:Manual section: 1
-:Manual group: General Commands Manual
-
-SYNOPSIS
-========
-
-| **pw-profiler** *options*
-
-DESCRIPTION
-===========
-
-Start profiling a PipeWire instance.
-
-If the server has the profiler module loaded, this program will
-connect to it and log the profiler data. Profiler data contains
-times and durations when processing nodes and devices started and
-completed.
-
-When this program is stopped, a set of **gnuplot** files and a script to generate
-SVG files from the .plot files is generated, along with a .html file to
-visualize the profiling results in a browser.
-
-This function uses the same data used by *pw-top*.
-
-OPTIONS
-=======
-
--r | --remote=NAME
-  The name the remote instance to monitor. If left unspecified,
-  a connection is made to the default PipeWire instance.
-
--h | --help
-  Show help.
-
---version
-  Show version information.
-
--o | --output=FILE
-  Profiler output name (default "profiler.log").
-
-AUTHORS
-=======
-
-The PipeWire Developers <@PACKAGE_BUGREPORT@>; PipeWire is available from @PACKAGE_URL@
-
-SEE ALSO
-========
-
-``pipewire(1)``,
-``pw-top(1)``,

pipewire-0.3.85.tar.gz/man/pw-top.1.rst.in Deleted

@@ -1,184 +0,0 @@
-pw-top
-######
-
----------------------------
-The PipeWire process viewer
----------------------------
-
-:Manual section: 1
-:Manual group: General Commands Manual
-
-SYNOPSIS
-========
-
-| **pw-top** *options*
-
-DESCRIPTION
-===========
-
-The *pw-top* program provides a dynamic real-time view of the pipewire
-node and device statistics.
-
-A hierarchical view is shown of Driver nodes and follower nodes. The Driver
-nodes are actively using a timer to schedule dataflow in the followers. The
-followers of a driver node as shown below their driver with a + sign in
-a tree-like representation.
-
-The columns presented are as follows:
-
-S
-  Node status.
-    E = ERROR
-    C = CREATING
-    S = SUSPENDED
-    I = IDLE
-    R = RUNNING
-
-ID
-  The ID of the pipewire node/device, as found in *pw-dump* and *pw-cli*
-
-QUANT
-  The current quantum (for drivers) and the suggested quantum for follower
-  nodes.
-
-  The quantum by itself needs to be divided by the RATE column to calculate
-  the duration of a scheduling period in fractions of a second.
-
-  For a QUANT of 1024 and a RATE of 48000, the duration of one period in the
-  graph is 1024/48000 or 21.3 milliseconds.
-
-  Follower nodes can have a 0 QUANT field, which means that the node does not
-  have a suggestion for the quantum and thus uses what the driver selected.
-
-  The driver will use the lowest quantum of any of the followers. If none of
-  the followers select a quantum, the default quantum in the pipewire configuration
-  file will be used.
-
-  The QUANT on the drivers usually translates directly into the number of audio
-  samples processed per processing cycle of the graph.
-
-  See also https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/FAQ#pipewire-buffering-explained
-
-RATE
-  The current rate (for drivers) and the suggested rate for follower
-  nodes.
-
-  This is the rate at which the *graph* processes data and needs to be combined with
-  the QUANT value to derive the duration of a processing cycle in the graph.
-
-  Some nodes can have a 0 RATE, which means that they don't have any rate
-  suggestion for the graph. Nodes that suggest a rate can make the graph switch
-  rates if the graph is otherwise idle and the new rate is allowed as
-  a possible graph rate (see the pipewire configuration file).
-
-  The RATE on (audio) driver nodes usually also translates directly to the
-  samplerate used by the device. Although some devices might not be able to
-  operate at the given samplerate, in which case resampling will need to be
-  done. The negotiated samplerate with the device and stream can be found in
-  the FORMAT column.
-
-WAIT
-  The waiting time of a node is the elapsed time between when the node
-  is ready to start processing and when it actually started processing.
-
-  For Driver nodes, this is the time between when the node wakes up to
-  start processing the graph and when the driver (and thus also the graph)
-  completes a cycle. The WAIT time for driver is thus the elapsed time
-  processing the graph.
-
-  For follower nodes, it is the time spent between being woken up (when all
-  dependencies of the node are satisfied) and when processing starts. The
-  WAIT time for follower nodes is thus mostly caused by context switching.
-
-  A value of --- means that the node was not signaled.  A value of +++
-  means that the node was signaled but not awake.
-
-BUSY
-  The processing time is started when the node starts processing until it
-  completes and wakes up the next nodes in the graph.
-
-  A value of --- means that the node was not started.  A value of +++
-  means that the node was started but did not complete.
-
-W/Q
-  Ratio of WAIT / QUANT.
-
-  The W/Q time of the driver node is a good measure of the graph
-  load. The running averages of the driver W/Q ratios are used as the DSP
-  load in other (JACK) tools.
-
-  Values of --- and +++ are copied from the WAIT column.
-
-B/Q
-  Ratio of BUSY / QUANT
-
-  This is a good measure of the load of a particular driver or follower
-  node.
-
-  Values of --- and +++ are copied from the BUSY column.
-
-ERR
-  Total of Xruns and Errors
-
-  Xruns for drivers are when the graph did not complete a cycle. This can
-  be because a node in the graph also has an Xrun. It can also be caused when
-  scheduling delays cause a deadline to be missed, causing a hardware
-  Xrun.
-
-  Xruns for followers are incremented when the node started processing but
-  did not complete before the end of the graph cycle deadline.
-
-FORMAT
-  The format used by the driver node or the stream. This is the hardware format
-  negotiated with the device or stream.
-
-  If the stream of driver has a different rate than the graph, resampling will
-  be done.
-
-  For raw audio formats, the layout is <sampleformat> <channels> <samplerate>.
-
-  For IEC958 passthrough audio formats, the layout is IEC958 <codec> <samplerate>.
-
-  For DSD formats, the layout is <dsd-rate> <channels>.
-
-  For Video formats, the layout is <pixelformat> <width>x<height>.
-
-NAME
-  Name assigned to the device/node, as found in *pw-dump* node.name
-
-  Names are prefixed by *+* when they are linked to a driver (entry above with no +)
-
-
-OPTIONS
-=======
-
--h | --help
-  Show help.
-
--b | --batch-mode
-  Run in non-interactive batch mode, similar to top's batch mode.
-
--n | --iterations=NUMBER
-  Exit after NUMBER of batch iterations. Only used in batch mode.
-
--r | --remote=NAME
-  The name the *remote* instance to monitor. If left unspecified,
-  a connection is made to the default PipeWire instance.
-
--V | --version
-  Show version information.
-
-
-AUTHORS
-=======
-
-The PipeWire Developers <@PACKAGE_BUGREPORT@>; PipeWire is available from @PACKAGE_URL@
-
-SEE ALSO
-========
-
-``pipewire(1)``,
-``pw-dump(1)``,
-``pw-cli(1)``,
-``pw-profiler(1)``,
-

pipewire-0.3.85.tar.gz/.gitlab-ci.yml -> pipewire-1.0.0.tar.gz/.gitlab-ci.yml Changed

pipewire-0.3.85.tar.gz/NEWS -> pipewire-1.0.0.tar.gz/NEWS Changed

@@ -1,3 +1,84 @@
+# PipeWire 1.0.0 (2023-11-26)
+
+The PipeWire project is immensely proud to announce the 1.0 release
+of PipeWire.
+
+It is API and ABI compatible with previous 0.3.x releases.
+
+ "PipeWire represents the next evolution of audio handling for Linux, taking
+ the best of both pro-audio (JACK) and desktop audio servers (PulseAudio) and
+ linking them into a single, seamless, powerful new system."
+    - Paul Davis, JACK and Ardour author
+
+ "What exciting times! PipeWire 1.0 is the culmination of 15 years of
+ Linux audio expertise, blending lessons from PulseAudio into a high-performance,
+ flexible, and user-friendly foundation for audio and multimedia on Linux.
+ I'm looking forward to the next decade of progress in the free software
+ consumer and professional audio space!."
+    - Arun Raghavan, PulseAudio developer/maintainer.
+
+ "I'm thrilled to witness the first stable release of PipeWire after five years
+ of collaboration with its remarkable community, pushing the boundaries of
+ multimedia integration in the Linux ecosystem one step further.”
+    - George Kiagiadakis, WirePlumber author
+
+ "From the beginning of the libcamera project, we have always seen
+ PipeWire as the solution to handle desktop and mobile integration and
+ give a seemless multimedia integration to users while providing security
+ features and resource sharing between applications."
+    - Kieran Bingham, libcamera author
+
+Happy Holidays!
+
+
+## Highlights
+  - Fix a memfd/dmabuf leak when uploading buffers while shutting down.
+  - Handle concurrent jack_port_get_buffer() calls because ardour seems to
+    be doing this.
+  - Improve time reporting (less jitter) in ALSA when using IRQ.
+  - Many doc improvements.
+
+## PipeWire
+  - Respect PIPEWIRE_DLCLOSE everywhere, remove pw_in_valgrind().
+  - Remove a warning when a client tries to change ignored properties.
+
+## Modules
+  - Fix a memfd/dmabuf leak when uploading buffers while shutting down.
+  - Fix a potential segfault when copying mix structures. (#3658)
+  - Avoid races in setrlimit in module-rt.
+  - Fix a memory leak in filter-chain.
+  - Set rtp.ptime on senders, not receivers.
+  - The ROC modules were ported to ROC 0.3
+
+## SPA
+  - Improve time reporting (less jitter) in ALSA when using IRQ. (#3657)
+  - Add latency param query in libcamera.
+  - Fix some compiler warnings.
+  - The EVL plugin was updated.
+
+## Bluetooth
+  - LC3 codec and compatibility improvements.
+
+## Pulse server
+  - Fix emission of events when a sink/source state changes. (#3660)
+
+## JACK
+  - Improve transport and time handling. Use unique ids to make consistent
+    snapshots of the current time and transport.
+  - Avoid enumerating port params that we are not going to use.
+  - Optimize buffer reuse.
+  - Handle concurrent jack_port_get_buffer() calls because ardour seems to
+    be doing this. (#3632)
+
+## Docs
+  - Many doc improvements.
+  - Add man pages for pw-dump, pw-loopback, modules, pipewire-pulse.
+  - Manpages are now made with Doxygen.
+  - Add docs for pulse-modules
+
+Older versions:
+
+
 # PipeWire 0.3.85 (2023-11-16)
 
 This is the fifth (and last) 1.0 release candidate that is API and ABI
@@ -53,9 +134,6 @@
 ## Docs
   - Many improvements to the layout and organization.
 
-Older versions:
-
-
 # PipeWire 0.3.84 (2023-11-02)
 
 This is the fourth 1.0 release candidate that is API and ABI compatible

pipewire-0.3.85.tar.gz/doc/Doxyfile.in -> pipewire-1.0.0.tar.gz/doc/Doxyfile.in Changed

pipewire-0.3.85.tar.gz/doc/custom.css -> pipewire-1.0.0.tar.gz/doc/custom.css Changed

pipewire-1.0.0.tar.gz/doc/dox Added

pipewire-1.0.0.tar.gz/doc/dox/api Added

pipewire-1.0.0.tar.gz/doc/dox/api/index.dox Added

@@ -0,0 +1,90 @@
+/** \page page_api PipeWire API
+
+The PipeWire API consists of several parts:
+
+- The \ref pw_stream for a convenient way to send and receive data streams from/to PipeWire.
+
+- The \ref pw_filter for a convenient way to implement processing filters.
+
+- The \ref api_pw_core to access a PipeWire instance. This API is used
+by all clients that need to communicate with the \ref page_daemon and provides
+the necessary structs to interface with the daemon.
+
+- The \ref api_pw_impl is primarily used by the \ref page_daemon itself but also by the
+\ref page_session_manager and modules/extensions that need to build objects in
+the graph.
+
+- The \ref api_pw_util containing various utility functions and structures.
+
+- The \ref api_pw_ext for interfacing with certain extension modules.
+
+The APIs work through proxy objects, so that calling a method on an object
+invokes that same method on the remote side. Marshalling and de-marshalling is
+handled transparently by the \ref page_module_protocol_native.
+The below graph illustrates this approach:
+
+\dot
+digraph API {
+  compound=true;
+  node shape="box";
+  rankdir="RL";
+
+  subgraph cluster_daemon {
+       rankdir="TB";
+       label="PipeWire daemon";
+       style="dashed";
+
+       impl_core label="Core Impl. Object";
+       impl_device label="Device Impl. Object";
+       impl_node label="Node Impl. Object";
+  }
+
+  subgraph cluster_client {
+       rankdir="TB";
+       label="PipeWire client";
+       style="dashed";
+
+       obj_core label="Core Object";
+       obj_device label="Device Object";
+       obj_node label="Node Object";
+  }
+
+  obj_core -> impl_core;
+  obj_device -> impl_device;
+  obj_node -> impl_node;
+
+}
+\enddot
+
+It is common for clients to use both the \ref api_pw_core and the \ref api_pw_impl
+and both APIs are provided by the same library.
+
+- \subpage page_spa
+- \subpage page_client_impl
+- \subpage page_proxy
+- \subpage page_streams
+- \subpage page_thread_loop
+
+
+\addtogroup api_pw_core Core API
+
+The Core API to access a PipeWire instance. This API is used by all
+clients to communicate with the \ref page_daemon.
+
+If you are familiar with Wayland implementation, the Core API is
+roughly equivalent to libwayland-client.
+
+See: \ref page_api
+
+
+\addtogroup api_pw_impl Implementation API
+
+The implementation API provides the tools to build new objects and
+modules.
+
+If you are familiar with Wayland implementation, the Implementation API is
+roughly equivalent to libwayland-server.
+
+See: \ref page_api
+
+*/

pipewire-1.0.0.tar.gz/doc/dox/api/spa-buffer.dox Changed

pipewire-1.0.0.tar.gz/doc/dox/api/spa-design.dox Changed

pipewire-1.0.0.tar.gz/doc/dox/api/spa-index.dox Changed

pipewire-1.0.0.tar.gz/doc/dox/api/spa-plugins.dox Changed

pipewire-1.0.0.tar.gz/doc/dox/api/spa-pod.dox Changed

pipewire-1.0.0.tar.gz/doc/dox/index.dox Added

@@ -0,0 +1,46 @@
+/** \mainpage PipeWire
+
+PipeWire is low-level multimedia framework that provides:
+
+- Graph based processing.
+- Support for out-of-process processing graphs with minimal overhead.
+- Flexible and extensible media format negotiation and buffer allocation.
+- Hard real-time capable plugins.
+- Very low-latency for both audio and video processing.
+
+See \ref page_overview for an overview of PipeWire and \ref page_design
+for the design principles guiding PipeWire.
+
+# Components
+
+PipeWire ships with the following components:
+
+- A \ref page_daemon that implements the IPC and graph processing.
+- An example \ref page_session_manager that manages objects in the \ref page_daemon.
+- A set of \ref page_programs to introspect and use the \ref page_daemon.
+- A \ref page_library to develop PipeWire applications and plugins (\ref
+  page_tutorial "tutorial").
+- The \ref page_spa used by both the \ref page_daemon and in the \ref
+  page_library.
+
+# API Documentation
+
+See \ref page_api.
+
+# More Documentation
+
+See our Wiki(https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/home) for
+More information on how to configure and use PipeWire.
+
+# Resources
+
+- PipeWire and AGL(https://wiki.automotivelinux.org/_media/pipewire_agl_20181206.pdf)
+- LAC 2020 Paper(https://lac2020.sciencesconf.org/307881/document)
+- PipeWire Under The Hood(https://venam.nixers.net/blog/unix/2021/06/23/pipewire-under-the-hood.html)
+- PipeWire: The Linux audio/video bus (LWN)(https://lwn.net/Articles/847412)
+- PipeWire Wikipedia(https://en.wikipedia.org/wiki/PipeWire)
+- Bluetooth, PipeWire and Whatsapp calls(https://gjhenrique.com/pipewire.html)
+- Intoduction to PipeWire(https://bootlin.com/blog/an-introduction-to-pipewire/)
+- A custom PipeWire node(https://bootlin.com/blog/a-custom-pipewire-node/)
+
+*/

pipewire-1.0.0.tar.gz/doc/dox/internals Added

pipewire-1.0.0.tar.gz/doc/dox/internals/access.dox Changed

pipewire-1.0.0.tar.gz/doc/dox/internals/audio.dox Changed

pipewire-1.0.0.tar.gz/doc/dox/internals/daemon.dox Changed

pipewire-1.0.0.tar.gz/doc/dox/internals/design.dox Changed

pipewire-1.0.0.tar.gz/doc/dox/internals/dma-buf.dox Changed

pipewire-1.0.0.tar.gz/doc/dox/internals/index.dox Added

pipewire-1.0.0.tar.gz/doc/dox/internals/library.dox Changed

pipewire-1.0.0.tar.gz/doc/dox/internals/midi.dox Changed

pipewire-1.0.0.tar.gz/doc/dox/internals/objects.dox Changed

pipewire-1.0.0.tar.gz/doc/dox/internals/portal.dox Added

@@ -0,0 +1,215 @@
+/** \page page_portal Portal Access Control
+
+This document explains how clients from the portal are handled.
+
+The portal is a DBus service that exposes interfaces to
+request access to the PipeWire daemon to perform a certain set of
+functions. The PipeWire daemon runs outside the sandbox, the portal is a way
+for clients inside the sandbox to connect to and use PipeWire.
+
+The PipeWire socket is not exposed in the sandbox. Instead, The portal
+connects to PipeWire on behalf of the client, informing PipeWire that this
+client is a portal-managed client. PipeWire can detect and enforce
+extra permission checks on the portal managed clients.
+
+Once such portal is the camera
+portal(https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.Camera.html)
+that provides a PipeWire session to stream video from a camera.
+
+
+# Use Cases
+
+## New Portal Managed Clients Need Device Permissions Configured
+
+When a new client is detected, the available objects need to be
+scanned and permissions configured for each of them.
+
+Only the devices belonging to the media_roles given by the
+portal are considered.
+
+## New Devices Need To Be Made Visible To Portal Managed Clients
+
+Newly created objects are made visible to a client when the client
+is allowed to interact with it.
+
+Only the devices belonging to the media_roles given by the
+portal are considered.
+
+## Permissions For A Device Need To Be Revoked
+
+The session manager listens to changes in the permissions of devices
+and will remove the client permissions accordingly.
+
+Usually this is implemented by listening to the permission store
+DBus object. The desktop environment might provide a configuration panel
+where these permissions can be managed.
+
+
+# Design
+
+## The Portal
+
+A sandboxed client cannot connect to PipeWire directly. Instead, it connects
+to the sandbox side of the portal which then connects the PipeWire daemon to
+configure the session. The portal then hands the file descriptor of the
+PipeWire connection to the client and the client can use this file descriptor
+to interface with the PipeWire session directly.
+
+When the portal connects, it will set the following properties on the
+client object:
+
+- `"pipewire.access.portal.is_portal" = true` for the connection of the
+  portal itself (as opposed to a client managed by the portal).
+- `"pipewire.access.portal.app_id"` the application ID(https://docs.flatpak.org/en/latest/conventions.html#application-ids) of the client.
+- `"pipewire.access.portal.media_roles"` media roles of the client.
+  Currently only `"Camera"` is defined.
+
+Before returning the connection to a client, the portal configures
+minimal permissions on the client. No objects are initially visible. It is
+the task of the \ref page_session_manager to make the objects in the graph
+visible, depending on the client's `media_roles` (see also \ref
+PW_KEY_MEDIA_ROLE).
+
+## The PipeWire Portal Module
+
+The PipeWire daemon uses the \ref page_module_portal to find the PID of the
+processes that owns the DBus name `org.freedesktop.portal.Desktop`
+(see the XDG Desktop Portal(https://github.com/flatpak/xdg-desktop-portal)).
+
+Client connections from this PID are tagged as \ref PW_KEY_ACCESS
+`"portal"` (see \ref page_module_access). It will also set ALL permissions for
+this client so that it can resume.
+
+\dot
+digraph pw {
+  compound=true;
+  node shape="box";
+  rankdir="TB";
+
+  dbus label="org.freedesktop.portal.Desktop";
+
+  portal_access label="PipeWire (mod: Portal Access)";
+  portal label="xdg-desktop-portal";
+
+  dbus -> portal_access arrowhead="dot";
+  dbus -> portal arrowhead="dot";
+
+  portal_access -> portal label="pipewire.access = portal";
+
+  { rank="same"; portal_access; portal}
+}
+\enddot
+
+## The Client
+
+A client can ask the portal for a connection to the PipeWire daemon.
+
+\dot
+digraph pw {
+  compound=true;
+  node shape="box";
+  rankdir="LR";
+
+  pw label="PipeWire";
+  portal label="xdg-desktop-portal";
+  client label="client";
+
+  client -> portal;
+  portal -> pw label="portal.is_portal=true", arrowhead="none"
+
+  {rank="min"; pw};
+  {rank="max"; client};
+}
+\enddot
+
+The portal maintains an (unrestricted) connection to the PipeWire daemon with
+`"pipewire.access.portal.is_portal" = true` to identify the nodes the client
+needs access to. It then creates a new restricted connection for the client,
+tagged with additional information.
+
+\dot
+digraph pw {
+  compound=true;
+  node shape="box";
+  rankdir="LR";
+
+  pw label="PipeWire";
+  portal label="xdg-desktop-portal";
+  client label="client";
+
+  client -> portal arrowhead="none";
+  portal -> pw label="portal.is_portal=true", arrowhead="none"
+  portal -> pw label="portal.app_id = $appid"
+
+  {rank="min"; pw};
+  {rank="max"; client};
+}
+\enddot
+
+The file descriptor for this restricted connection is passed back to the
+client which can now make use of the resources it has been permitted to
+access.
+
+\dot
+digraph pw {
+  compound=true;
+  node shape="box";
+  rankdir="LR";
+
+  pw label="PipeWire";
+  portal label="xdg-desktop-portal";
+  client label="client";
+
+  portal -> pw label="portal.is_portal=true", arrowhead="none"
+
+  pw->client label="restricted connection";
+
+  {rank="min"; pw};
+  {rank="max"; client};
+}
+\enddot
+
+## The Session Manager
+
+The session manager listens for new clients to appear. It will use the
+\ref PW_KEY_ACCESS property to find portal connections. For client connections
+from the portal the session manager checks the requested `media_roles` and
+enables or disables access to the respective PipeWire objects.
+It might have to consult a database to decide what is allowed, for example the
+org.freedesktop.impl.portal.PermissionStore(https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.impl.portal.PermissionStore.html).
+
+\dot
+strict digraph pw {
+  compound=true;
+  node shape="box";
+  rankdir="LR";
+
+  portal label="xdg-desktop-portal";
+  client label="client";
+
+
+  subgraph {
+	  rankdir="TB";
+	  permissions label="PermissionStore";
+
+	  sm->permissions;
+
+	  sm label="Session Manager";
+	  pw label="PipeWire";
+	  sm -> pw headlabel="allow $media.roles";

pipewire-1.0.0.tar.gz/doc/dox/internals/protocol.dox Added

@@ -0,0 +1,1691 @@
+/** \page page_native_protocol Native Protocol
+
+PipeWire has a pluggable client/server IPC protocol.
+
+The reference implementation uses unix sockets and is implemented in
+\ref page_module_protocol_native.
+
+We document the messages here.
+
+\tableofcontents
+
+# Message header {#native-protocol-message-header}
+
+Each message on the unix socket contains a 16 bytes header and a
+variable length payload size:
+
+```
+    0                   1                   2                   3
+    0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+   |                     Id                                        |
+   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+   |    opcode     |                   size                        |
+   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+   |                         seq                                   |
+   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+   |                         n_fds                                 |
+   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+   |                     payload POD                               |
+   .                                                               .
+   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+   |                     optional footer POD                       |
+   .                                                               .
+   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+```
+
+
+These are four uint32 words to be read in native endianness.
+
+- Id: the message id this is the destination resource/proxy id
+- opcode: the opcode on the resource/proxy interface
+- size: the size of the payload and optional footer of the message
+- seq: an increasing sequence number for each message
+- n_fds: number of file descriptors in this message.
+
+The sender should send along with each message the fds that belong to
+the message. If there are more than the maximum number of fds in the
+message than can fit in one message, the message is split into multiple
+parts.
+
+A receiver needs to first read the header to know the size of the
+complete message. After collecting the complete message, it can start
+processing it.
+
+The payload is a single POD see \ref page_spa_pod for details.
+
+After the payload, there is an optional footer POD object.
+
+# Making a connection {#native-protocol-making-connection}
+
+First a connection is made to a unix domain socket. By default, the socket is
+named as "pipewire-0" and searched in the following directories:
+
+ - getenv("PIPEWIRE_RUNTIME_DIR")
+ - getenv("XDG_RUNTIME_DIR")
+ - getenv("USERPROFILE")
+
+
+The client opens the socket and allocates a Core proxy with id 0 and a Client
+proxy with id 1. The proxy is nothing more than a way to identify the remote
+objects with an id. Usually they also contain the type and version of the
+remote object and some helpers (interfaces) to dispatch messages.
+
+The server will allocate a new Core resource with id 0. Resources are the
+counterpart of client proxies and also typically contain extra information
+and helpers (interfaces) to dispatch messages.
+
+The client sends the Core::Hello message on the socket to start the
+communication.
+
+The server binds the client resource with id 1 to the client. This means
+that the client object on the server will now have a resource with a
+client side proxy associated with it.
+
+When the client sends a message for a certain proxy, the server side
+resource with the same id for the client is found and the message is
+dispatched to the object associated with the resource.
+
+Similarly when a server sends a message on a resource, the client will
+find the proxy with the same id and dispatch the message to it's
+associated object.
+
+The client then sends client properties to the server.
+
+```
+   client                                    server
+     |---------------------------------------->|
+     |            open socket                  |
+     |                                         |
+     |---------------------------------------->|
+     |            Core::Hello(version)         |
+     |                                         |
+     |---------------------------------------->|
+     |       Client::UpdateProperties          |
+     .                                         .
+```
+
+This completes the setup of the client. The newly connected client will
+appear in the registry at this point.
+
+# Core proxy/resource {#native-protocol-core}
+
+The core is always the object with Id 0.
+
+## Core Methods (Id 0)
+
+### Core::Hello (Opcode 1)
+
+The first message sent by a client is the Hello message and contains the
+version number of the client.
+
+```
+   Struct(
+      Int: version
+   )
+```
+
+The version is 3.
+
+### Core::Sync (Opcode 2)
+
+The Sync message will result in a Done event from the server. When the Done
+event is received, the client can be sure that all operations before the Sync
+method have been completed.
+
+```
+   Struct(
+      Int: id
+      Int: seq
+   )
+```
+
+- id: the id will be returned in the Done event.
+- seq: is usually generated automatically and will be returned in the Done event.
+
+### Core::Pong (Opcode 3)
+
+Is sent from the client to the server when the server emits the Ping event.
+The id and seq should be copied from the Ping event.
+
+```
+   Struct(
+      Int: id
+      Int: seq
+   )
+```
+
+### Core::Error (Opcode 4)
+
+An error occured in an object on the client.
+
+```
+   Struct(
+      Int: id
+      Int: seq
+      Int: res
+      String: message
+   )
+```
+
+- id: The id of the proxy that is in error.
+- seq: a seq number from the failing request (if any)
+- res: a negative errno style error code
+- message: an error message
+
+### Core::GetRegistry (Opcode 5)
+
+A client requests to bind to the registry object and list the available objects
+on the server.
+
+Like with all bindings, first the client allocates a new proxy id and puts this
+as the new_id field. Methods and Events can then be sent and received on the 
+new_id (in the message Id field).
+
+```
+   Struct(
+      Int: version
+      Int: new_id
+   )
+```
+- version: the version of the registry interface used on the client
+- new_id: the id of the new proxy with the registry interface
+
+After this method, the server will start sending Registry::Global events
+to the proxy with new_id.
+
+```
+   client                                    server
+     |                                         |

pipewire-1.0.0.tar.gz/doc/dox/internals/pulseaudio.dox Changed

pipewire-1.0.0.tar.gz/doc/dox/internals/scheduling.dox Added

@@ -0,0 +1,209 @@
+/** \page page_scheduling Graph Scheduling
+
+This document tries to explain how the PipeWire graph is scheduled.
+
+Graph are constructed from linked nodes together with their ports. This
+results in a dependency graph between nodes. Special care is taken for
+loopback links so that the graph remains a directed graph.
+
+# Processing threads
+
+The server (and clients) have two processing threads:
+
+- A main thread that will do all IPC with clients and server and configures the
+  nodes in the graph for processing.
+- A (or more) data processing thread that only does the data processing.
+
+
+The data processing threads are given realtime priority and are designed to
+run with as little overhead as possible. All of the node resources such as
+buffers, io areas and metadata will be set up in shared memory before the
+node is scheduled to run.
+
+This document describes the processing that happens in the data processing
+thread after the main-thread has configured it.
+
+# Nodes
+
+Nodes are objects with 0 or more input and output ports.
+
+Each node also has:
+
+- an eventfd to signal the node that it can start processing
+- an activation record that lives in shared memory with memfd.
+
+```
+   eventfd
+  +-^---------+
+  |           |
+ in          out
+  |           |
+  +-v---------+
+    activation {
+      status:OK,        // bitmask of NEED_DATA, HAVE_DATA or OK
+      pending:0,	// number of unsatisfied dependencies to be able to run
+      required:0        // number of dependencies with other nodes
+    }
+```
+
+The activation record has the following information:
+
+ - processing state and pending dependencies. As long as there are pending dependencies
+   the node can not be processed. This is the only relevant information for actually
+   scheduling the graph and is shown in the above illustration.
+ - Current status of the node and profiling info (TRIGGERED, AWAKE, FINISHED, timestamps
+   when the node changed state).
+ - Timing information, mostly for drivers when the processing started, the time, duration
+   and rate (quantum) etc..
+ - Information about repositions (seek) and timebase owners.
+
+
+# Links
+
+When two nodes are linked together, the output node becomes a dependency for the input
+node. This means the input node can only start processing when the output node is finished.
+
+This dependency is reflected in the required counter in the activation record. In below
+illustration, B's required field is incremented with 1. The pending field is set to the
+required field when the graph is started. Node A will keep a list of all targets (B) that it
+is a dependency of.
+
+This dependency update is only performed when the link is ready (negotiated) and the nodes
+are ready to schedule (runnable).
+
+
+```
+   eventfd                                eventfd
+  +-^---------+                          +-^---------+
+  |           |        link              |           |
+ in     A    out ---------------------> in     B    out
+  |           |                          |           |
+  +-v---------+                          +-v---------+
+    activation {       target              activation {
+      status:OK,  -------------------->      status:OK,
+      pending:0,                             pending:1,
+      required:0                             required:1
+    }                                      }
+```
+
+Multiple links between A and B will only result in 1 target link between A and B.
+
+
+# Drivers
+
+The graph can only run if there is a driver node that is in some way linked to an
+active node.
+
+The driver is special because it will have to initiate the processing in the graph. It
+will use a timer or some sort of interrupt from hardware to start the cycle.
+
+Any node can also be a candidate for a driver (when the node.driver property is true).
+PipeWire will select the node with the highest priority.driver property as the driver.
+
+Nodes will be assigned to the driver node they will be scheduled with. Each node holds
+a reference to the driver and increments the required field of the driver.
+
+When a node is ready to be scheduled, the driver adds the node to its list of targets
+and increments the required field.
+
+
+```
+   eventfd                                eventfd
+  +-^---------+                          +-^---------+
+  |           |        link              |           |
+ in     A    out ---------------------> in     B    out
+  |           |                          |           |
+  +-v---------+                          +-v---------+
+    activation {       target              activation {
+      status:OK,  -------------------->      status:OK,
+      pending:0,                             pending:0,
+      required:1                             required:2
+    }                                      }
+      |    ^                         ^
+      |    |                        /   /
+      |    |                       /   /
+      |    |                      /   /
+      |    |                     /   /
+      |    |                    /   /
+      v    |     /-------------/   /
+    activation {                  /
+      status:OK, V---------------/
+      pending:0,
+      required:2
+    }
+  +-^---------+
+  |           |
+  |   driver  |
+  |           |
+  +-v---------+
+   eventfd
+```
+
+As seen in the illustration above, the driver holds a link to each node it needs to
+schedule and each node holds a link to the driver. Some nodes hold a link to other
+nodes.
+
+It is possible that the driver is the same as a node in the graph (for example node A)
+but conceptually, the links above are still valid.
+
+The driver will then start processing the graph by emitting the ready signal. PipeWire
+will then:
+
+ - Check the previous cycle. Did it complete? Mark xrun on unfinished nodes.
+ - Perform reposition requests if any, timebase changes, etc..
+ - The pending counter of each follower node is set to the required field.
+ - It then loops over all targets of the driver and atomically decrements the required
+   field of the activation record. When the required field is 0, the eventfd is signaled
+   and the node can be scheduled.
+
+In our example above, Node A and B will have their pending state decremented. Node A
+will be 0 and will be triggered first (node B has 2 pending dependencies to start with and
+will not be triggered yet). The driver itself also has 2 dependencies left and will not
+be triggered (complete) yet.
+
+## Scheduling node A
+
+When the eventfd is signaled on a node, we say the node is triggered and it will be able
+to process data. It consumes the input on the input ports and produces more data on the
+output ports.
+
+After processing, node A goes through the list of targets and decrements each pending
+field (node A has a reference to B and the driver).
+
+In our above example, the driver is decremented (from 2 to 1) but is not yet triggered.
+node B is decremented (from 1 to 0) and is triggered by writing to the eventfd.
+
+## Scheduling node B
+
+Node B is scheduled and processes the input from node A. It then goes through the list of
+targets and decrements the pending fields.  It decrements the pending field of the
+driver (from 1 to 0) and triggers the driver.
+
+## Scheduling the driver
+
+The graph always completes after the driver is triggered and scheduled. All required
+fields from all the nodes in the target list of the driver are now 0.
+
+The driver calculates some stats about cpu time etc.
+
+# Remote nodes.
+
+For remote nodes, the eventfd and the activation is transfered from the server
+to the client.
+
+This means that writing to the remote client eventfd will wake the client directly
+without going to the server first.
+
+All remote clients also get the activation and eventfd of the peer and driver they
+are linked to and can directly trigger peers and drivers without going to the
+server first.

pipewire-1.0.0.tar.gz/doc/dox/internals/session-manager.dox Changed

pipewire-1.0.0.tar.gz/doc/dox/modules.dox Added

@@ -0,0 +1,94 @@
+/** \page page_modules Modules
+
+A PipeWire module is effectively a PipeWire client in an `.so` file that
+shares the \ref pw_context with the loading entity. Usually modules are
+loaded when they are listed in the configuration files. For example the
+default configuration file loads several modules:
+
+```
+context.modules = 
+    ...
+    # The native communication protocol.
+    {   name = libpipewire-module-protocol-native }
+
+    # 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 }
+    ...
+
+```
+The matching libraries are:
+```
+$ ls -1 /usr/lib64/pipewire-0.3/libpipewire-module*
+...
+/usr/lib64/pipewire-0.3/libpipewire-module-metadata.so
+/usr/lib64/pipewire-0.3/libpipewire-module-profiler.so
+/usr/lib64/pipewire-0.3/libpipewire-module-protocol-native.so
+/usr/lib64/pipewire-0.3/libpipewire-module-spa-device-factory.so
+...
+```
+
+A module's entry point is the `pipewire__module_init` function, see \ref
+PIPEWIRE_SYMBOL_MODULE_INIT.
+
+\code
+int pipewire__module_init(struct pw_impl_module *module, const char *args).`
+\endcode
+
+See the \ref page_module_example_sink and \ref page_module_example_source
+modules for a general oveview of how modules look like.
+
+List of known modules:
+
+- \subpage page_module_access
+- \subpage page_module_adapter
+- \subpage page_module_avb
+- \subpage page_module_client_device
+- \subpage page_module_client_node
+- \subpage page_module_combine_stream
+- \subpage page_module_echo_cancel
+- \subpage page_module_example_filter
+- \subpage page_module_example_sink
+- \subpage page_module_example_source
+- \subpage page_module_fallback_sink
+- \subpage page_module_ffado_driver
+- \subpage page_module_filter_chain
+- \subpage page_module_jackdbus_detect
+- \subpage page_module_jack_tunnel
+- \subpage page_module_link_factory
+- \subpage page_module_loopback
+- \subpage page_module_metadata
+- \subpage page_module_netjack2_driver
+- \subpage page_module_netjack2_manager
+- \subpage page_module_pipe_tunnel
+- \subpage page_module_portal
+- \subpage page_module_profiler
+- \subpage page_module_protocol_native
+- \subpage page_module_protocol_pulse
+- \subpage page_module_protocol_simple
+- \subpage page_module_pulse_tunnel
+- \subpage page_module_raop_sink
+- \subpage page_module_raop_discover
+- \subpage page_module_roc_sink
+- \subpage page_module_roc_source
+- \subpage page_module_rtp_sap
+- \subpage page_module_rtp_sink
+- \subpage page_module_rtp_source
+- \subpage page_module_rtp_session
+- \subpage page_module_rt
+- \subpage page_module_session_manager
+- \subpage page_module_vban_recv
+- \subpage page_module_vban_send
+- \subpage page_module_x11_bell
+- \subpage page_module_zeroconf_discover
+
+*/

pipewire-1.0.0.tar.gz/doc/dox/overview.dox Changed

pipewire-1.0.0.tar.gz/doc/dox/programs Added

pipewire-1.0.0.tar.gz/doc/dox/programs/index.md Added

pipewire-1.0.0.tar.gz/doc/dox/programs/libpipewire-modules.7.md Added

@@ -0,0 +1,44 @@
+\page page_man_libpipewire-modules_7 libpipewire-modules
+
+PipeWire modules
+
+# DESCRIPTION
+
+A PipeWire module is effectively a PipeWire client running inside
+`pipewire(1)` which can host multiple modules. Usually modules are
+loaded when they are listed in the configuration files. For example the
+default configuration file loads several modules:
+
+    context.modules = 
+        ...
+        # The native communication protocol.
+        {   name = libpipewire-module-protocol-native }
+
+        # 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 }
+        ...
+    
+
+# KNOWN MODULES
+
+$(LIBPIPEWIRE_MODULES)
+
+# AUTHORS
+
+The PipeWire Developers <$(PACKAGE_BUGREPORT)>;
+PipeWire is available from <$(PACKAGE_URL)>
+
+# SEE ALSO
+
+\ref page_man_pipewire_1 "pipewire(1)",
+\ref page_man_pipewire_conf_5 "pipewire.conf(5)"

pipewire-1.0.0.tar.gz/doc/dox/programs/pipewire-pulse-modules.7.md Added

pipewire-1.0.0.tar.gz/doc/dox/programs/pipewire-pulse.1.md Added

pipewire-1.0.0.tar.gz/doc/dox/programs/pipewire-pulse.conf.5.md Added

@@ -0,0 +1,56 @@
+\page page_man_pipewire-pulse_conf_5 pipewire-pulse.conf
+
+The PipeWire Pulseaudio server configuration file
+
+# SYNOPSIS
+
+*$XDG_CONFIG_HOME/pipewire/pipewire-pulse.conf*
+
+*$(PIPEWIRE_CONFIG_DIR)/pipewire-pulse.conf*
+
+*$(PIPEWIRE_CONFDATADIR)/pipewire-pulse.conf*
+
+*$(PIPEWIRE_CONFDATADIR)/pipewire-pulse.conf.d/*
+
+*$(PIPEWIRE_CONFIG_DIR)/pipewire-pulse.conf.d/*
+
+*$XDG_CONFIG_HOME/pipewire/pipewire-pulse.conf.d/*
+
+# DESCRIPTION
+
+Configuration for PipeWire's PulseAudio-compatible daemon.
+
+The configuration file format is the same as for `pipewire.conf(5)`.
+There are additional sections for configuring `pipewire-pulse(1)`
+settings.
+
+# CONFIGURATION FILE SECTIONS
+
+\par pulse.properties
+Dictionary. These properties configure the PipeWire Pulseaudio server
+properties.
+
+\par pulse.cmd
+Array of dictionaries. A set of commands to be executed on startup.
+
+\par pulse.rules
+Array of dictionaries. A set of match rules and actions to apply to
+clients.
+
+See \ref page_module_protocol_pulse "libpipewire-module-protocol-pulse(7)"
+for the detailed description.
+
+In addition, the general PipeWire daemon configuration sections apply,
+see \ref page_man_pipewire_conf_5 "pipewire.conf(5)".
+
+# AUTHORS
+
+The PipeWire Developers <$(PACKAGE_BUGREPORT)>;
+PipeWire is available from <$(PACKAGE_URL)>
+
+# SEE ALSO
+
+\ref page_module_protocol_pulse "libpipewire-module-protocol-pulse(7)",
+\ref page_man_pipewire_conf_5 "pipewire.conf(5)",
+\ref page_man_pipewire-pulse_1 "pipewire-pulse(1)",
+\ref page_man_pipewire-pulse-modules_7 "pipewire-pulse-modules(7)"

pipewire-1.0.0.tar.gz/doc/dox/programs/pipewire.1.md Added

@@ -0,0 +1,44 @@
+\page page_man_pipewire_1 pipewire
+
+The PipeWire media server
+
+# SYNOPSIS
+
+**pipewire** \*options*\
+
+# DESCRIPTION
+
+PipeWire is a service that facilitates sharing of multimedia content
+between devices and applications.
+
+The **pipewire** daemon reads a config file that is further documented
+in \ref page_man_pipewire_conf_5 "pipewire.conf(5)" manual page.
+
+# OPTIONS
+
+\par -h | \--help
+Show help.
+
+\par -v | \--verbose
+Increase the verbosity by one level. This option may be specified
+multiple times.
+
+\par \--version
+Show version information.
+
+\par -c | \--config=FILE
+Load the given config file (Default: pipewire.conf).
+
+# AUTHORS
+
+The PipeWire Developers <$(PACKAGE_BUGREPORT)>;
+PipeWire is available from <$(PACKAGE_URL)>
+
+# SEE ALSO
+
+\ref page_man_pw-top_1 "pw-top(1)",
+\ref page_man_pw-dump_1 "pw-dump(1)",
+\ref page_man_pw-mon_1 "pw-mon(1)",
+\ref page_man_pw-cat_1 "pw-cat(1)",
+\ref page_man_pw-cli_1 "pw-cli(1)",
+\ref page_man_libpipewire-modules_7 "libpipewire-modules(7)"

pipewire-1.0.0.tar.gz/doc/dox/programs/pipewire.conf.5.md Added

@@ -0,0 +1,102 @@
+\page page_man_pipewire_conf_5 pipewire.conf
+
+The PipeWire server configuration file
+
+# SYNOPSIS
+
+*$XDG_CONFIG_HOME/pipewire/pipewire.conf*
+
+*$(PIPEWIRE_CONFIG_DIR)/pipewire.conf*
+
+*$(PIPEWIRE_CONFDATADIR)/pipewire.conf*
+
+*$(PIPEWIRE_CONFDATADIR)/pipewire.conf.d/*
+
+*$(PIPEWIRE_CONFIG_DIR)/pipewire.conf.d/*
+
+*$XDG_CONFIG_HOME/pipewire/pipewire.conf.d/*
+
+# DESCRIPTION
+
+PipeWire is a service that facilitates sharing of multimedia content
+between devices and applications.
+
+On startup, the daemon reads a main configuration file to configure
+itself. It executes a series of commands listed in the config file.
+
+The config files are loaded in the order listed in the
+SYNOPSIS(#synopsis). The environment variables `PIPEWIRE_CONFIG_DIR`,
+`PIPEWIRE_CONFIG_PREFIX` and `PIPEWIRE_CONFIG_NAME` can be used to
+specify an alternative config directory, subdirectory and file
+respectively.
+
+Next to the configuration file can be a directory with the same name as
+the file with a `.d/` suffix. All directories in the
+SYNOPSIS(#synopsis) directory search paths are traversed in the listed
+order and the contents of the `*.conf` files inside them are appended to
+the main configuration file as overrides. Object sections are merged and
+array sections are appended.
+
+# CONFIGURATION FILE FORMAT
+
+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:
+```
+    name = value # simple assignment
+
+    name = { key1 = value1 key2 = value2 } # a dictionary with two entries
+
+    name =  value1 value2  # an array with two entries
+
+    name =  { k = v1 } { k = v2 }  # an array of dictionaries
+```
+
+The configuration files can be expressed in full JSON syntax but for
+ease of use, a relaxed format may be used where:
+
+- `:` to delimit keys and values can be substuted by `=` or a space.
+- <tt>\"</tt> around keys and string can be omitted as long as no special
+  characters are used in the strings.
+- `,` to separate objects can be replaced with a whitespace character.
+- `#` can be used to start a comment until the line end
+
+# CONFIGURATION FILE SECTIONS
+
+\par context.properties
+Dictionary. These properties configure the PipeWire instance.
+
+\par context.spa-libs
+Dictionary. Maps plugin features with globs to a spa library.
+
+\par context.modules
+Array of dictionaries. 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.
+
+\par context.objects
+Array of dictionaries. Each entry in the array is a dictionary
+containing the *factory* to create an object from and optional extra
+arguments specific to that factory.
+
+\par context.exec
+\parblock
+Array of dictionaries. Each entry in the array is dictionary containing
+the *path* of a program to execute on startup and optional *args*.
+
+This array used to contain an entry to start the session manager but
+this mode of operation has since been demoted to development aid. Avoid
+starting a session manager in this way in production environment.
+\endparblock
+
+# AUTHORS
+
+The PipeWire Developers <$(PACKAGE_BUGREPORT)>;
+PipeWire is available from <$(PACKAGE_URL)>
+
+# SEE ALSO
+
+\ref page_man_pipewire_1 "pipewire(1)",
+\ref page_man_pw-mon_1 "pw-mon(1)",
+\ref page_man_libpipewire-modules_7 "libpipewire-modules(7)"

pipewire-1.0.0.tar.gz/doc/dox/programs/pw-cat.1.md Added

@@ -0,0 +1,163 @@
+\page page_man_pw-cat_1 pw-cat
+
+Play and record media with PipeWire
+
+# SYNOPSIS
+
+**pw-cat** \*options*\ \*FILE* \| -\
+
+**pw-play** \*options*\ \*FILE* \| -\
+
+**pw-record** \*options*\ \*FILE* \| -\
+
+**pw-midiplay** \*options*\ \*FILE* \| -\
+
+**pw-midirecord** \*options*\ \*FILE* \| -\
+
+**pw-dsdplay** \*options*\ \*FILE* \| -\
+
+# DESCRIPTION
+
+**pw-cat** is a simple tool for playing back or capturing raw or encoded
+media files on a PipeWire server. It understands all audio file formats
+supported by `libsndfile` for PCM capture and playback. When capturing
+PCM, the filename extension is used to guess the file format with the
+WAV file format as the default.
+
+It understands standard MIDI files for playback and recording. This tool
+will not render MIDI files, it will simply make the MIDI events
+available to the graph. You need a MIDI renderer such as qsynth,
+timidity or a hardware MIDI rendered to hear the MIDI.
+
+DSD playback is supported with the DSF file format. This tool will only
+work with native DSD capable hardware and will produce an error when no
+such hardware was found.
+
+When the *FILE* is - input and output will be raw data from STDIN and
+STDOUT respectively.
+
+# OPTIONS
+
+\par -h | \--help
+Show help.
+
+\par \--version
+Show version information.
+
+\par -v | \--verbose
+Verbose operation.
+
+\par -R | \--remote=NAME
+The name the *remote* instance to connect to. If left unspecified, a
+connection is made to the default PipeWire instance.
+
+\par -p | \--playback
+Playback mode. Read data from the specified file, and play it back. If
+the tool is called under the name **pw-play** or **pw-midiplay** this is
+the default.
+
+\par -r | \--record
+Recording mode. Capture data and write it to the specified file. If the
+tool is called under the name **pw-record** or **pw-midirecord** this is
+the default.
+
+\par -m | \--midi
+MIDI mode. *FILE* is a MIDI file. If the tool is called under the name
+**pw-midiplay** or **pw-midirecord** this is the default. Note that this
+program will *not* render the MIDI events into audible samples, it will
+simply provide the MIDI events in the graph. You need a separate MIDI
+renderer such as qsynth, timidity or a hardware renderer to hear the
+MIDI.
+
+\par -d | \--dsd
+DSD mode. *FILE* is a DSF file. If the tool is called under the name
+**pw-dsdplay** this is the default. Note that this program will *not*
+render the DSD audio. You need a DSD capable device to play DSD content
+or this program will exit with an error.
+
+\par \--media-type=VALUE
+Set the media type property (default Audio/Midi depending on mode). The
+media type is used by the session manager to select a suitable target to
+link to.
+
+\par \--media-category=VALUE
+Set the media category property (default Playback/Capture depending on
+mode). The media type is used by the session manager to select a
+suitable target to link to.
+
+\par \--media-role=VALUE
+Set the media role property (default Music). The media type is used by
+the session manager to select a suitable target to link to.
+
+\par \--target=VALUE
+\parblock
+Set a node target (default auto). The value can be:
+
+- **auto**: Automatically select (Default)
+
+- **0**: Don't try to link this node
+
+- <b>\<id\></b>: The object.serial or the node.name of a target node
+\endparblock
+
+\par \--latency=VALUE\*units*\
+\parblock
+Set the node latency (default 100ms)
+
+The latency determines the minimum amount of time it takes for a sample
+to travel from application to device (playback) and from device to
+application (capture).
+
+The latency determines the size of the buffers that the application will
+be able to fill. Lower latency means smaller buffers but higher
+overhead. Higher latency means larger buffers and lower overhead.
+
+Units can be **s** for seconds, **ms** for milliseconds, **us** for
+microseconds, **ns** for nanoseconds. If no units are given, the latency
+value is samples with the samplerate of the file.
+\endparblock
+
+\par -P | \--properties=VALUE
+Set extra stream properties as a JSON object.
+
+\par -q | \--quality=VALUE
+Resampler quality. When the samplerate of the source or destination file
+does not match the samplerate of the server, the data will be resampled.
+Higher quality uses more CPU. Values between 0 and 15 are allowed, the
+default quality is 4.
+
+\par \--rate=VALUE
+The sample rate, default 48000.
+
+\par \--channels=VALUE
+The number of channels, default 2.
+
+\par \--channel-map=VALUE
+The channelmap. Possible values include: **mono**, **stereo**,
+**surround-21**, **quad**, **surround-22**, **surround-40**,
+**surround-31**, **surround-41**, **surround-50**, **surround-51**,
+**surround-51r**, **surround-70**, **surround-71** or a comma separated
+list of channel names: **FL**, **FR**, **FC**, **LFE**, **SL**, **SR**,
+**FLC**, **FRC**, **RC**, **RL**, **RR**, **TC**, **TFL**, **TFC**,
+**TFR**, **TRL**, **TRC**, **TRR**, **RLC**, **RRC**, **FLW**, **FRW**,
+**LFE2**, **FLH**, **FCH**, **FRH**, **TFLC**, **TFRC**, **TSL**,
+**TSR**, **LLFR**, **RLFE**, **BC**, **BLC**, **BRC**
+
+\par \--format=VALUE
+The sample format to use. One of: **u8**, **s8**, **s16** (default),
+**s24**, **s32**, **f32**, **f64**.
+
+\par \--volume=VALUE
+The stream volume, default 1.000. Depending on the locale you have
+configured, "," or "." may be used as a decimal separator. Check with
+**locale** command.
+
+# AUTHORS
+
+The PipeWire Developers <$(PACKAGE_BUGREPORT)>;
+PipeWire is available from <$(PACKAGE_URL)>
+
+# SEE ALSO
+
+\ref page_man_pipewire_1 "pipewire(1)",
+\ref page_man_pw-mon_1 "pw-mon(1)",

pipewire-1.0.0.tar.gz/doc/dox/programs/pw-cli.1.md Added

@@ -0,0 +1,189 @@
+\page page_man_pw-cli_1 pw-cli
+
+The PipeWire Command Line Interface
+
+# SYNOPSIS
+
+**pw-cli** \*command*\
+
+# DESCRIPTION
+
+Interact with a PipeWire instance.
+
+When a command is given, **pw-cli** will execute the command and exit
+
+When no command is given, **pw-cli** starts an interactive session with
+the default PipeWire instance *pipewire-0*.
+
+Connections to other, remote instances can be made. The current instance
+name is displayed at the prompt.
+
+Note that **pw-cli** also creates a local PipeWire instance. Some
+commands operate on the current (remote) instance and some on the local
+instance, such as module loading.
+
+Use the 'help' command to list the available commands.
+
+# GENERAL COMMANDS
+
+\par help | h
+Show a quick help on the commands available. It also lists the aliases
+for many commands.
+
+\par quit | q
+Exit from **pw-cli**
+
+# MODULE MANAGEMENT
+
+Modules are loaded and unloaded in the local instance, thus the pw-cli
+binary itself and can add functionality or objects to the local
+instance. It is not possible in PipeWire to load modules in another
+instance.
+
+\par load-module *name* \*arguments...*\
+\parblock
+Load a module specified by its name and arguments in the local instance.
+For most modules it is OK to be loaded more than once.
+
+This command returns a module variable that can be used to unload the
+module.
+
+The locally module is *not* visible in the remote instance. It is not
+possible in PipeWire to load modules in a remote instance.
+\endparblock
+
+\par unload-module *module-var*
+Unload a module, specified either by its variable.
+
+# OBJECT INTROSPECTION
+
+\par list-objects
+List the objects of the current instance.
+
+Objects are listed with their *id*, *type* and *version*.
+
+\par info *id* | *all*
+Get information about a specific object or *all* objects.
+
+Requesting info about an object will also notify you of changes.
+
+# WORKING WITH REMOTES
+
+\par connect \*remote-name*\
+\parblock
+Connect to a remote instance and make this the new current instance.
+
+If no remote name is specified, a connection is made to the default
+remote instance, usually *pipewire-0*.
+
+The special remote name called *internal* can be used to connect to the
+local **pw-cli** PipeWire instance.
+
+This command returns a remote var that can be used to disconnect or
+switch remotes.
+\endparblock
+
+\par disconnect \*remote-var*\
+\parblock
+Disconnect from a *remote instance*.
+
+If no remote name is specified, the current instance is disconnected.
+\endparblock
+
+\par list-remotes
+List all *remote instances*.
+
+\par switch-remote \*remote-var*\
+\parblock
+Make the specified *remote* the current instance.
+
+If no remote name is specified, the first instance is made current.
+\endparblock
+
+# NODE MANAGEMENT
+
+\par create-node *factory-name* \*properties...*\
+\parblock
+Create a node from a factory in the current instance.
+
+Properties are key=value pairs separated by whitespace.
+
+This command returns a *node variable*.
+\endparblock
+
+\par export-node *node-id* \*remote-var*\
+Export a node from the local instance to the specified instance. When no
+instance is specified, the node will be exported to the current
+instance.
+
+# DEVICE MANAGEMENT
+
+\par create-device *factory-name* \*properties...*\
+\parblock
+Create a device from a factory in the current instance.
+
+Properties are key=value pairs separated by whitespace.
+
+This command returns a *device variable*.
+\endparblock
+
+# LINK MANAGEMENT
+
+\par create-link *node-id* *port-id* *node-id* *port-id* \*properties...*\
+\parblock
+Create a link between 2 nodes and ports.
+
+Port *ids* can be *-1* to automatically select an available port.
+
+Properties are key=value pairs separated by whitespace.
+
+This command returns a *link variable*.
+\endparblock
+
+# GLOBALS MANAGEMENT
+
+\par destroy *object-id*
+Destroy a global object.
+
+# PARAMETER MANAGEMENT
+
+\par enum-params *object-id* *param-id*
+\parblock
+Enumerate params of an object.
+
+*param-id* can also be given as the param short name.
+\endparblock
+
+\par set-param *object-id* *param-id* *param-json*
+\parblock
+Set param of an object.
+
+*param-id* can also be given as the param short name.
+\endparblock
+
+# PERMISSION MANAGEMENT
+
+\par permissions *client-id* *object-id* *permission*
+\parblock
+Set permissions for a client.
+
+*object-id* can be *-1* to set the default permissions.
+\endparblock
+
+\par get-permissions *client-id*
+Get permissions of a client.
+
+# COMMAND MANAGEMENT
+
+\par send-command *object-id*
+Send a command to an object.
+
+# AUTHORS
+
+The PipeWire Developers <$(PACKAGE_BUGREPORT)>;
+PipeWire is available from <$(PACKAGE_URL)>
+
+# SEE ALSO
+
+\ref page_man_pipewire_1 "pipewire(1)",
+\ref page_man_pw-mon_1 "pw-mon(1)",

pipewire-1.0.0.tar.gz/doc/dox/programs/pw-config.1.md Added

@@ -0,0 +1,97 @@
+\page page_man_pw-config_1 pw-config
+
+Debug PipeWire Config parsing
+
+# SYNOPSIS
+
+**pw-config** \*options*\ paths
+
+**pw-config** \*options*\ list \*SECTION*\
+
+**pw-config** \*options*\ merge *SECTION*
+
+# DESCRIPTION
+
+List config paths and config sections and display the parsed output.
+
+This tool can be used to get an overview of the config file that will be
+parsed by the PipeWire server and clients.
+
+# COMMON OPTIONS
+
+\par -h | \--help
+Show help.
+
+\par \--version
+Show version information.
+
+\par -n | \--name=NAME
+Config Name (default 'pipewire.conf')
+
+\par -p | \--prefix=PREFIX
+Config Prefix (default '')
+
+\par -L | \--no-newline
+Omit newlines after values
+
+\par -r | \--recurse
+Reformat config sections recursively
+
+\par -N | \--no-colors
+Disable color output
+
+\par -C | \-color\=WHEN\
+whether to enable color support. WHEN is
+*never*, *always*, or *auto*
+
+# LISTING PATHS
+
+Specify the paths command. It will display all the config files that
+will be parsed and in what order.
+
+# LISTING CONFIG SECTIONS
+
+Specify the list command with an optional *SECTION* to list the
+configuration fragments used for *SECTION*. Without a *SECTION*, all
+sections will be listed.
+
+Use the -r options to reformat the sections.
+
+# MERGING A CONFIG SECTION
+
+With the merge option and a *SECTION*, pw-config will merge all config
+files into a merged config section and dump the results. This will be
+the section used by the client or server.
+
+Use the -r options to reformat the sections.
+
+# EXAMPLES
+
+\par pw-config
+List all config files that will be used
+
+\par pw-config -n pipewire-pulse.conf
+List all config files that will be used by the PipeWire pulseaudio
+server.
+
+\par pw-config -n pipewire-pulse.conf list
+List all config sections used by the PipeWire pulseaudio server
+
+\par pw-config -n jack.conf list context.properties
+List the context.properties fragments used by the JACK clients
+
+\par pw-config -n jack.conf merge context.properties
+List the merged context.properties used by the JACK clients
+
+\par pw-config -n pipewire.conf -r merge context.modules
+List the merged context.modules used by the PipeWire server and reformat
+
+# AUTHORS
+
+The PipeWire Developers <$(PACKAGE_BUGREPORT)>;
+PipeWire is available from <$(PACKAGE_URL)>
+
+# SEE ALSO
+
+\ref page_man_pipewire_1 "pipewire(1)",
+\ref page_man_pw-dump_1 "pw-dump(1)",

pipewire-1.0.0.tar.gz/doc/dox/programs/pw-dot.1.md Added

@@ -0,0 +1,56 @@
+\page page_man_pw-dot_1 pw-dot
+
+The PipeWire dot graph dump
+
+# SYNOPSIS
+
+**pw-dot** \*options*\
+
+# DESCRIPTION
+
+Create a .dot file of the PipeWire graph.
+
+The .dot file can then be visualized with a tool like **dotty** or
+rendered to a PNG file with `dot -Tpng pw.dot -o pw.png`.
+
+# OPTIONS
+
+\par -r | \--remote=NAME
+The name the remote instance to connect to. If left unspecified, a
+connection is made to the default PipeWire instance.
+
+\par -h | \--help
+Show help.
+
+\par \--version
+Show version information.
+
+\par -a | \--all
+Show all object types.
+
+\par -s | \--smart
+Show linked objects only.
+
+\par -d | \--detail
+Show all object properties.
+
+\par -o FILE | \--output=FILE
+Output file name (Default pw.dot). Use - for stdout.
+
+\par -L | \--lr
+Lay the graph from left to right, instead of dot's default top to
+bottom.
+
+\par -9 | \--90
+Lay the graph using 90-degree angles in edges.
+
+# AUTHORS
+
+The PipeWire Developers <$(PACKAGE_BUGREPORT)>;
+PipeWire is available from <$(PACKAGE_URL)>
+
+# SEE ALSO
+
+\ref page_man_pipewire_1 "pipewire(1)",
+\ref page_man_pw-cli_1 "pw-cli(1)",
+\ref page_man_pw-mon_1 "pw-mon(1)",

pipewire-1.0.0.tar.gz/doc/dox/programs/pw-dump.1.md Added

pipewire-1.0.0.tar.gz/doc/dox/programs/pw-jack.1.md Added

@@ -0,0 +1,45 @@
+\page page_man_pw-jack_1 pw-jack
+
+Use PipeWire instead of JACK
+
+# SYNOPSIS
+
+**pw-jack** \*options*\ *COMMAND* \*FILE*\
+
+# DESCRIPTION
+
+**pw-jack** modifies the `LD_LIBRARY_PATH` environment variable so that
+applications will load PipeWire's reimplementation of the JACK client
+libraries instead of JACK's own libraries. This results in JACK clients
+being redirected to PipeWire.
+
+If PipeWire's reimplementation of the JACK client libraries has been
+installed as a system-wide replacement for JACK's own libraries, then
+the whole system already behaves in that way, in which case **pw-jack**
+has no practical effect.
+
+# OPTIONS
+
+\par -h
+Show help.
+
+\par -r NAME
+The name of the remote instance to connect to. If left unspecified, a
+connection is made to the default PipeWire instance.
+
+\par -v
+Verbose operation.
+
+# EXAMPLES
+
+\par pw-jack sndfile-jackplay /usr/share/sounds/freedesktop/stereo/bell.oga
+
+# AUTHORS
+
+The PipeWire Developers <$(PACKAGE_BUGREPORT)>;
+PipeWire is available from <$(PACKAGE_URL)>
+
+# SEE ALSO
+
+\ref page_man_pipewire_1 "pipewire(1)",
+**jackd(1)**,

pipewire-1.0.0.tar.gz/doc/dox/programs/pw-link.1.md Added

@@ -0,0 +1,135 @@
+\page page_man_pw-link_1 pw-link
+
+The PipeWire Link Command
+
+# SYNOPSIS
+
+**pw-link** \*options*\ -o-l \*out-pattern*\ \*in-pattern*\
+
+**pw-link** \*options*\ *output* *input*
+
+**pw-link** \*options*\ -d *output* *input*
+
+**pw-link** \*options*\ -d *link-id*
+
+# DESCRIPTION
+
+List, create and destroy links between PipeWire ports.
+
+# COMMON OPTIONS
+
+\par -r | \--remote=NAME
+The name the *remote* instance to monitor. If left unspecified, a
+connection is made to the default PipeWire instance.
+
+\par -h | \--help
+Show help.
+
+\par \--version
+Show version information.
+
+# LISTING PORTS AND LINKS
+
+Specify one of -o, -i or -l to list the matching optional input and
+output ports and their links.
+
+\par -o | \--output
+List output ports
+
+\par -i | \--input
+List output ports
+
+\par -l | \--links
+List links
+
+\par -m | \--monitor
+Monitor links and ports. **pw-link** will not exit but monitor and print
+new and destroyed ports or links.
+
+\par -I | \--id
+List IDs. Also list the unique link and port ids.
+
+\par -v | \--verbose
+Verbose port properties. Also list the port-object-path and the
+port-alias.
+
+# CONNECTING PORTS
+
+Without any list option (-i, -o or -l), the given ports will be linked.
+Valid port specifications are:
+
+*port-id*
+
+As obtained with the -I option when listing ports.
+
+*node-name:port-name*
+
+As obtained when listing ports.
+
+*port-object-path*
+
+As obtained from the first alternative name for the port when listing
+them with the -v option.
+
+*port-alias*
+
+As obtained from the second alternative name for the ports when listing
+them with the -v option.
+
+Extra options when linking can be given:
+
+\par -L | \--linger
+Linger. Will create a link that exists after **pw-link** is destroyed.
+This is the default behaviour, unless the -m option is given.
+
+\par -P | \--passive
+Passive link. A passive link will keep both nodes it links inactive
+unless another non-passive link is activating the nodes. You can use
+this to link a sink to a filter and have them both suspended when
+nothing else is linked to either of them.
+
+\par -p | \--props=PROPS
+Properties as JSON object. Give extra properties when creaing the link.
+
+# DISCONNECTING PORTS
+
+When the -d option is given, an existing link between port is destroyed.
+
+To disconnect port, a single *link-id*, as obtained when listing links
+with the -I option, or two port specifications can be given. See the
+connecting ports section for valid port specifications.
+
+\par -d | \--disconnect
+Disconnect ports
+
+# EXAMPLES
+
+**pw-link** -iol
+
+List all port and their links.
+
+**pw-link** -lm
+
+List all links and monitor changes until **pw-link** is stopped.
+
+**pw-link** paplay:output_FL alsa_output.pci-0000_00_1b.0.analog-stereo:playback_FL
+
+Link the given output port to the input port.
+
+**pw-link** -lI
+
+List links and their Id.
+
+**pw-link** -d 89
+
+Destroy the link with id 89.
+
+# AUTHORS
+
+The PipeWire Developers <$(PACKAGE_BUGREPORT)>;
+PipeWire is available from <$(PACKAGE_URL)>
+
+# SEE ALSO
+
+\ref page_man_pipewire_1 "pipewire(1)",
+\ref page_man_pw-cli_1 "pw-cli(1)"

pipewire-1.0.0.tar.gz/doc/dox/programs/pw-loopback.1.md Added

@@ -0,0 +1,67 @@
+\page page_man_pw-loopback_1 pw-loopback
+
+PipeWire loopback client
+
+# SYNOPSIS
+
+**pw-loopback** \*options*\
+
+# DESCRIPTION
+
+The *pw-loopback* program is a PipeWire client that uses the PipeWire
+loopback module to create loopback nodes, with configuration given via
+the command-line options.
+
+# OPTIONS
+
+\par -h | \--help
+Show help.
+
+\par -r | \--remote=NAME
+The name of the *remote* instance to connect to. If left unspecified, a
+connection is made to the default PipeWire instance.
+
+\par -n | \--name=NAME
+Name of the loopback node
+
+\par -g | \--group=NAME
+Name of the loopback node group
+
+\par -c | \--channels=NUMBER
+Number of channels to provide
+
+\par -m | \--channel-map=MAP
+Channel map (default ` FL, FR `)
+
+\par -l | \--latency=LATENCY
+Desired latency in ms
+
+\par -d | \--delay=DELAY
+Added delay in seconds (floating point allowed)
+
+\par -C | \--capture=TARGET
+Target device to capture from
+
+\par -P | \--playback=TARGET
+Target device to play to
+
+\par \--capture-props=PROPS
+Wanted properties of capture node (in JSON)
+
+\par \--playback-props=PROPS
+Wanted properties of capture node (in JSON)
+
+# AUTHORS
+
+The PipeWire Developers <$(PACKAGE_BUGREPORT)>;
+PipeWire is available from <$(PACKAGE_URL)>
+
+# SEE ALSO
+
+\ref page_man_pipewire_1 "pipewire(1)",
+\ref page_man_pw-cat_1 "pw-cat(1)",
+**pactl(1)**
+
+Other ways to create loopback nodes are adding the loopback module in
+the configuration of a PipeWire daemon, or loading the loopback module
+using Pulseaudio commands (`pactl load-module module-loopback ...`).

pipewire-1.0.0.tar.gz/doc/dox/programs/pw-metadata.1.md Added

@@ -0,0 +1,73 @@
+\page page_man_pw-metadata_1 pw-metadata
+
+The PipeWire metadata
+
+# SYNOPSIS
+
+**pw-metadata** \*options*\ \*id* \*key* \*value* \*type* \ \ \ \
+
+# DESCRIPTION
+
+Monitor, set and delete metadata on PipeWire objects.
+
+Metadata are key/type/value triplets attached to objects identified by
+*id*. The metadata is shared between all applications binding to the
+same metadata object. When an object is destroyed, all its metadata is
+automatically removed.
+
+When no *value* is given, **pw-metadata** will query and log the
+metadata matching the optional arguments *id* and *key*. Without any
+arguments, all metadata is displayed.
+
+When *value* is given, **pw-metadata** will set the metadata for *id*
+and *key* to *value* and an optional *type*.
+
+# OPTIONS
+
+\par -r | \--remote=NAME
+The name the remote instance to use. If left unspecified, a connection
+is made to the default PipeWire instance.
+
+\par -h | \--help
+Show help.
+
+\par \--version
+Show version information.
+
+\par -l | \--list
+List available metadata objects
+
+\par -m | \--monitor
+Keeps running and log the changes to the metadata.
+
+\par -d | \--delete
+Delete all metadata for *id* or for the specified *key* of object *id*.
+Without any option, all metadata is removed.
+
+\par -n | \--name
+Metadata name (Default: "default").
+
+# EXAMPLES
+
+**pw-metadata**
+
+Show metadata in default name.
+
+**pw-metadata** -n settings 0
+
+Display settings.
+
+**pw-metadata** -n settings 0 clock.quantum 1024
+
+Change clock.quantum to 1024.
+
+# AUTHORS
+
+The PipeWire Developers <$(PACKAGE_BUGREPORT)>;
+PipeWire is available from <$(PACKAGE_URL)>
+
+# SEE ALSO
+
+\ref page_man_pipewire_1 "pipewire(1)",
+\ref page_man_pw-mon_1 "pw-mon(1)",
+\ref page_man_pw-cli_1 "pw-cli(1)",

pipewire-1.0.0.tar.gz/doc/dox/programs/pw-mididump.1.md Added

pipewire-1.0.0.tar.gz/doc/dox/programs/pw-mon.1.md Added

pipewire-1.0.0.tar.gz/doc/dox/programs/pw-profiler.1.md Added

@@ -0,0 +1,46 @@
+\page page_man_pw-profiler_1 pw-profiler
+
+The PipeWire profiler
+
+# SYNOPSIS
+
+**pw-profiler** \*options*\
+
+# DESCRIPTION
+
+Start profiling a PipeWire instance.
+
+If the server has the profiler module loaded, this program will connect
+to it and log the profiler data. Profiler data contains times and
+durations when processing nodes and devices started and completed.
+
+When this program is stopped, a set of **gnuplot** files and a script to
+generate SVG files from the .plot files is generated, along with a .html
+file to visualize the profiling results in a browser.
+
+This function uses the same data used by *pw-top*.
+
+# OPTIONS
+
+\par -r | \--remote=NAME
+The name the remote instance to monitor. If left unspecified, a
+connection is made to the default PipeWire instance.
+
+\par -h | \--help
+Show help.
+
+\par \--version
+Show version information.
+
+\par -o | \--output=FILE
+Profiler output name (default "profiler.log").
+
+# AUTHORS
+
+The PipeWire Developers <$(PACKAGE_BUGREPORT)>;
+PipeWire is available from <$(PACKAGE_URL)>
+
+# SEE ALSO
+
+\ref page_man_pipewire_1 "pipewire(1)",
+\ref page_man_pw-top_1 "pw-top(1)"

pipewire-1.0.0.tar.gz/doc/dox/programs/pw-top.1.md Added

@@ -0,0 +1,207 @@
+\page page_man_pw-top_1 pw-top
+
+The PipeWire process viewer
+
+# SYNOPSIS
+
+**pw-top** \*options*\
+
+# DESCRIPTION
+
+The *pw-top* program provides a dynamic real-time view of the pipewire
+node and device statistics.
+
+A hierarchical view is shown of Driver nodes and follower nodes. The
+Driver nodes are actively using a timer to schedule dataflow in the
+followers. The followers of a driver node as shown below their driver
+with a + sign in a tree-like representation.
+
+The columns presented are as follows:
+
+\par S
+\parblock
+Node status.
+
+- E = ERROR
+- C = CREATING
+- S = SUSPENDED
+- I = IDLE
+- R = RUNNING
+\endparblock
+
+\par ID
+The ID of the pipewire node/device, as found in *pw-dump* and
+*pw-cli*
+
+\par QUANT
+\parblock
+The current quantum (for drivers) and the suggested quantum for
+follower nodes.
+
+The quantum by itself needs to be divided by the RATE column to
+calculate the duration of a scheduling period in fractions of a
+second.
+
+For a QUANT of 1024 and a RATE of 48000, the duration of one period
+in the graph is 1024/48000 or 21.3 milliseconds.
+
+Follower nodes can have a 0 QUANT field, which means that the node
+does not have a suggestion for the quantum and thus uses what the
+driver selected.
+
+The driver will use the lowest quantum of any of the followers. If
+none of the followers select a quantum, the default quantum in the
+pipewire configuration file will be used.
+
+The QUANT on the drivers usually translates directly into the number
+of audio samples processed per processing cycle of the graph.
+
+See also
+<https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/FAQ#pipewire-buffering-explained>
+\endparblock
+
+\par RATE
+\parblock
+The current rate (for drivers) and the suggested rate for follower
+nodes.
+
+This is the rate at which the *graph* processes data and needs to be
+combined with the QUANT value to derive the duration of a processing
+cycle in the graph.
+
+Some nodes can have a 0 RATE, which means that they don\'t have any
+rate suggestion for the graph. Nodes that suggest a rate can make
+the graph switch rates if the graph is otherwise idle and the new
+rate is allowed as a possible graph rate (see the pipewire
+configuration file).
+
+The RATE on (audio) driver nodes usually also translates directly to
+the samplerate used by the device. Although some devices might not
+be able to operate at the given samplerate, in which case resampling
+will need to be done. The negotiated samplerate with the device and
+stream can be found in the FORMAT column.
+
+\endparblock
+
+\par WAIT
+\parblock
+The waiting time of a node is the elapsed time between when the node
+is ready to start processing and when it actually started
+processing.
+
+For Driver nodes, this is the time between when the node wakes up to
+start processing the graph and when the driver (and thus also the
+graph) completes a cycle. The WAIT time for driver is thus the
+elapsed time processing the graph.
+
+For follower nodes, it is the time spent between being woken up
+(when all dependencies of the node are satisfied) and when
+processing starts. The WAIT time for follower nodes is thus mostly
+caused by context switching.
+
+A value of \-\-- means that the node was not signaled. A value of
++++ means that the node was signaled but not awake.
+\endparblock
+
+\par BUSY
+\parblock
+The processing time is started when the node starts processing until
+it completes and wakes up the next nodes in the graph.
+
+A value of \-\-- means that the node was not started. A value of +++
+means that the node was started but did not complete.
+\endparblock
+
+\par W/Q
+\parblock
+Ratio of WAIT / QUANT.
+
+The W/Q time of the driver node is a good measure of the graph load.
+The running averages of the driver W/Q ratios are used as the DSP
+load in other (JACK) tools.
+
+Values of \-\-- and +++ are copied from the WAIT column.
+
+\endparblock
+
+\par B/Q
+\parblock
+Ratio of BUSY / QUANT
+
+This is a good measure of the load of a particular driver or
+follower node.
+
+Values of \-\-- and +++ are copied from the BUSY column.
+\endparblock
+
+\par ERR
+\parblock
+Total of Xruns and Errors
+
+Xruns for drivers are when the graph did not complete a cycle. This
+can be because a node in the graph also has an Xrun. It can also be
+caused when scheduling delays cause a deadline to be missed, causing
+a hardware Xrun.
+
+Xruns for followers are incremented when the node started processing
+but did not complete before the end of the graph cycle deadline.
+\endparblock
+
+\par FORMAT
+\parblock
+The format used by the driver node or the stream. This is the
+hardware format negotiated with the device or stream.
+
+If the stream of driver has a different rate than the graph,
+resampling will be done.
+
+For raw audio formats, the layout is \<sampleformat\> \<channels\>
+\<samplerate\>.
+
+For IEC958 passthrough audio formats, the layout is IEC958 \<codec\>
+\<samplerate\>.
+
+For DSD formats, the layout is \<dsd-rate\> \<channels\>.
+
+For Video formats, the layout is \<pixelformat\>
+\<width\>x\<height\>.
+\endparblock
+
+\par NAME
+\parblock
+Name assigned to the device/node, as found in *pw-dump* node.name
+
+Names are prefixed by *+* when they are linked to a driver (entry
+above with no +)
+\endparblock
+
+
+# OPTIONS
+
+\par -h | \--help
+Show help.
+
+\par -b | \--batch-mode
+Run in non-interactive batch mode, similar to top\'s batch mode.
+
+\par -n | \--iterations=NUMBER
+Exit after NUMBER of batch iterations. Only used in batch mode.
+
+\par -r | \--remote=NAME
+The name the *remote* instance to monitor. If left unspecified, a
+connection is made to the default PipeWire instance.
+
+\par -V | \--version
+Show version information.
+
+# AUTHORS
+
+The PipeWire Developers <$(PACKAGE_BUGREPORT)>;

pipewire-1.0.0.tar.gz/doc/dox/pulse-modules.dox Added

@@ -0,0 +1,149 @@
+/** \page page_pulse_modules Pulseaudio Modules
+
+PipeWire's Pulseaudio emulation implements several Pulseaudio modules.
+It only supports its own built-in modules, and cannot load external
+modules written for Pulseaudio.
+
+# Loading modules
+
+The built-in modules can be loaded using Pulseaudio client programs,
+for example `pactl load-module <module-name> <module-options>`. They
+can also added to `pipewire-pulse.conf`, typically by a drop-in file
+in `~/.config/pipewire/pipewire-pulse.conf.d/` containing the module
+name and its arguments
+```
+pulse.cmd = 
+    { cmd = "load-module" args = "module-null-sink sink_name=foo" flags =   }
+
+```
+
+To list all modules currently loaded, with their arguments:
+```
+pactl list modules
+```
+
+For a short list of loaded modules:
+```
+pactl list modules short
+```
+
+Modules may be unloaded using either the module-name or index number:
+
+```
+pactl load-module <module-name> <parameters>
+pactl unload-module <module-name|index#>
+```
+
+# Common module options
+
+Most modules that create streams/devices support the following properties:
+
+## sink_name, source_name
+
+Name for the sink (resp. source). Allowed characters in the name are a-z, A-Z, numbers, period (.) and underscore (_). The length must be 1-128 characters.
+
+## format
+
+The sample format. The supported audio formats are:
+
+### PCM
+ - u8: unsigned 8-bit integer
+ - aLaw: A-law encoded 8-bit integer
+ - uLaw: μ-law encoded 8-bit integer
+ - s16le: signed 16-bit little-endian integer
+ - s16be: signed 16-bit big-endian integer
+ - s16, s16ne: native-endian aliases for s16le or s16be
+ - s16re: reverse-endian alias for s16le or s16be
+ - float32le: 32-bit little-endian float
+ - float32be: 32-bit big-endian float
+ - float32, float32ne: native-endian aliases for float32le or float32be
+ - float32re: reverse-endian alias for float32le or float32be
+ - s32le: signed 32-bit little-endian integer
+ - s32be: signed 32-bit big-endian integer
+ - s32, s32ne: native-endian aliases for s32le or s32be
+ - s32re: reverse-endian alias for s32le or s32be
+ - s24le: signed 24-bit little-endian integer (note: ALSA calls this "S24_3LE")
+ - s24be: signed 24-bit big-endian integer (note: ALSA calls this "S24_3BE")
+ - s24, s24ne: native-endian aliases for s24le or s24be
+ - s24re: reverse-endian alias for s24le or s24be
+ - s24-32le: signed 24-bit little-endian integer, packed into a 32-bit integer so that the 8 most significant bits are ignored (note: ALSA calls this "S24_LE")
+ - s24-32be: signed 24-bit big-endian integer, packed into a 32-bit integer so that the 8 most significant bits are ignored (note: ALSA calls this "S24_BE")
+ - s24-32, s24-32ne: native-endian aliases for s24-32le or s24-32be
+ - s24-32re: reverse-endian alias for s24-32le or s24-32be
+
+### Compressed audio formats
+
+Below is a list of all supported compressed formats. The code at the beginning of each line is used whenever a textual identifier for a format is needed (for example in configuration files or on the command line). The formats whose identifier ends with -iec61937 have to be wrapped in IEC 61937 frames, which makes the compressed audio behave more like normal PCM audio.
+
+ - ac3-iec61937: Dolby Digital (DD / AC-3 / A/52)
+ - eac3-iec61937: Dolby Digital Plus (DD+ / E-AC-3)
+ - mpeg-iec61937: MPEG-1 or MPEG-2 Part 3 (not MPEG-2 AAC)
+ - dts-iec61937: DTS
+ - mpeg2-aac-iec61937: MPEG-2 AAC (supported since PulseAudio 4.0)
+ - truehd-iec61937: Dolby TrueHD (added in PulseAudio 13.0, but doesn't work yet in practice)
+ - dtshd-iec61937: DTS-HD Master Audio (added in PulseAudio 13.0, but doesn't work yet in practice)
+ - pcm: PCM (not a compressed format, but listed here, because pcm is one of the recognized encoding identifiers)
+ - any: (special identifier for indicating that any encoding can be used)
+
+
+## rate
+
+The sample rate.
+
+##channels
+
+Number of audio channels.
+
+## channel_map
+
+A channel map. A list of comma-separated channel names. The currently defined channel names are:
+`left`, `right`, `mono`, `center`, `front-left`, `front-right`, `front-center`,
+`rear-center`, `rear-left`, `rear-right`, `lfe`, `subwoofer`, `front-left-of-center`,
+`front-right-of-center`, `side-left`, `side-right`, `aux0`, `aux1` to `aux15`, `top-center`,
+`top-front-left`, `top-front-right`, `top-front-center`, `top-rear-left`, `top-rear-right`,
+`top-rear-center`
+
+## sink_properties, source_properties
+
+Set additional properties of the sink/source. For example, you can set the description directly
+when the module is loaded by setting this parameter.
+
+```
+load-module module-alsa-sink sink_name=headphones sink_properties=device.description=Headphones
+```
+
+# List of known built-in modules:
+
+- \subpage page_pulse_module_alsa_sink
+- \subpage page_pulse_module_alsa_source
+- \subpage page_pulse_module_always_sink
+- \subpage page_pulse_module_combine_sink
+- \subpage page_pulse_module_echo_cancel
+- \subpage page_pulse_module_gsettings
+- \subpage page_pulse_module_jackdbus_detect
+- \subpage page_pulse_module_ladspa_sink
+- \subpage page_pulse_module_ladspa_source
+- \subpage page_pulse_module_loopback
+- \subpage page_pulse_module_native_protocol_tcp
+- \subpage page_pulse_module_null_sink
+- \subpage page_pulse_module_pipe_sink
+- \subpage page_pulse_module_pipe_source
+- \subpage page_pulse_module_raop_discover
+- \subpage page_pulse_module_remap_sink
+- \subpage page_pulse_module_remap_source
+- \subpage page_pulse_module_roc_sink
+- \subpage page_pulse_module_roc_sink_input
+- \subpage page_pulse_module_roc_source
+- \subpage page_pulse_module_rtp_recv
+- \subpage page_pulse_module_rtp_send
+- \subpage page_pulse_module_simple_protocol_tcp
+- \subpage page_pulse_module_switch_on_connect
+- \subpage page_pulse_module_tunnel_sink
+- \subpage page_pulse_module_tunnel_source
+- \subpage page_pulse_module_virtual_sink
+- \subpage page_pulse_module_virtual_source
+- \subpage page_pulse_module_x11_bell
+- \subpage page_pulse_module_zeroconf_discover
+- \subpage page_pulse_module_zeroconf_publish
+
+*/

pipewire-1.0.0.tar.gz/doc/dox/tutorial Added

pipewire-1.0.0.tar.gz/doc/dox/tutorial/index.dox Added

pipewire-1.0.0.tar.gz/doc/dox/tutorial/tutorial1.dox Changed

pipewire-1.0.0.tar.gz/doc/dox/tutorial/tutorial2.dox Changed

pipewire-1.0.0.tar.gz/doc/dox/tutorial/tutorial3.dox Changed

pipewire-1.0.0.tar.gz/doc/dox/tutorial/tutorial4.dox Changed

pipewire-1.0.0.tar.gz/doc/dox/tutorial/tutorial5.dox Changed

pipewire-1.0.0.tar.gz/doc/dox/tutorial/tutorial6.dox Changed

pipewire-1.0.0.tar.gz/doc/examples Added

pipewire-1.0.0.tar.gz/doc/examples/tutorial1.c Changed

pipewire-1.0.0.tar.gz/doc/examples/tutorial2.c Changed

pipewire-1.0.0.tar.gz/doc/examples/tutorial3.c Changed

pipewire-1.0.0.tar.gz/doc/examples/tutorial4.c Changed

pipewire-1.0.0.tar.gz/doc/examples/tutorial5.c Changed

pipewire-1.0.0.tar.gz/doc/examples/tutorial6.c Changed

pipewire-1.0.0.tar.gz/doc/input-filter.py Added

@@ -0,0 +1,53 @@
+#!/usr/bin/env python3
+# -*- mode: python; coding: utf-8; eval: (blacken-mode); -*-
+r"""
+Doxygen input filter that:
+
+- adds \privatesection to all files
+- removes macros
+- parses pulse_module_options and substitutes it into @pulse_module_options@
+
+This is used for .c files, and causes Doxygen to not include
+any symbols from them, unless they also appeared in a header file.
+
+The Pulse module option parsing is used in documentation of Pulseaudio modules.
+"""
+import sys
+import re
+import os
+
+
+def main():
+    fn = sys.argv1
+    with open(fn, "r") as f:
+        text = f.read()
+
+    text = re.sub("#define.*", "", text)
+
+    if "@pulse_module_options@" in text:
+        m = re.search(
+            r"static const char* *const pulse_module_options\s+=\s+(.*?\")\s*;\s*$",
+            text,
+            re.M | re.S,
+        )
+        if m:
+            res = 
+            for line in m.group(1).splitlines():
+                m = re.match(r"\s*\"\s*(a-z0-9_+)\s*=\s*(.*)\"\s*$", line)
+                if m:
+                    name = m.group(1)
+                    value = m.group(2).strip().strip("<>")
+                    res.append(f"- `{name}`: {value}")
+
+            res = "\n * ".join(res)
+            text = text.replace("@pulse_module_options@", res)
+
+    if os.path.basename(fn).startswith("module-") and fn.endswith(".c"):
+        text = re.sub(r"^ \* ##", r" * #", text, flags=re.M)
+
+    print("/** \\privatesection */")
+    print(text)
+
+
+if __name__ == "__main__":
+    main()

pipewire-1.0.0.tar.gz/doc/man-fixup.py Added

@@ -0,0 +1,97 @@
+#!/usr/bin/python3
+# -*- mode: python; coding: utf-8; eval: (blacken-mode); -*-
+r"""
+Fetch right Doxygen man file, replace dummy parts, and fixup nroff
+"""
+import argparse
+import re
+import sys
+from subprocess import call
+from pathlib import Path
+
+
+def main():
+    p = argparse.ArgumentParser(description=__doc__.strip())
+    p.add_argument("htmldir", type=Path)
+    p.add_argument("page")
+    p.add_argument("name")
+    p.add_argument("section")
+    p.add_argument("version")
+    args = p.parse_args()
+
+    page, name, section, version = args.page, args.name, args.section, args.version
+
+    mandir = args.htmldir / ".." / "man" / "man3"
+    fn = mandir / f"{page}.3"
+
+    # Doxygen < 1.9.7 names .md file output differently...
+    if not fn.exists():
+        page2 = page.replace("page_man_", "md_doc_dox_programs_").replace("-", "_")
+        fn = mandir / f"{page2}.3"
+    else:
+        page2 = None
+
+    try:
+        with open(fn, "r") as f:
+            text = f.read()
+    except:
+        print(f"ERROR: man file {fn} missing!", file=sys.stderr)
+        call("ls", "-R", str(args.htmldir / ".." / "man"), stdout=sys.stderr)
+        raise
+
+    text = text.replace(page, name)
+    if page2 is not None:
+        text = text.replace(page2, name)
+
+    # Replace bad nroff header
+    text = re.sub(
+        r"^(\.TH^\n*)\n",
+        rf'.TH "{name}" {section} "{version}" "PipeWire" \\" -*- nroff -*-\n',
+        text,
+    )
+
+    # Fixup name field (can't be done in Doxygen, otherwise HTML looks bac)
+    text = re.sub(
+        rf"^\.SH NAME\s*\n{name} \\- {name}\s*\n\.PP\n *",
+        rf".SH NAME\n{name} \\- ",
+        text,
+        count=1,
+        flags=re.M,
+    )
+
+    # Add DESCRIPTION section if missing and NAME field has extra stuff
+    if not re.search(r"^\.SH DESCRIPTION\s*\n", text):
+        text = re.sub(
+            r"^(.SH NAME\s*\n^\..*\n)\.PP\s*\n(^\.\n +)",
+            r"\1.SH DESCRIPTION\n.PP\n\2",
+            text,
+            count=1,
+            flags=re.M,
+        )
+
+    # Upcase titles
+    def upcase(m):
+        return m.group(0).upper()
+
+    text = re.sub(r"^\.SH .*?$", upcase, text, flags=re.M)
+
+    # Replace PW_KEY_*, SPA_KEY_* by their values
+    def pw_key(m):
+        key = m.group(0)
+        key = key.replace("PW_KEY_", "").lower().replace("_", ".")
+        if key in ("protocol", "access", "client.access") or key.startswith("sec."):
+            return f"pipewire.{key}"
+        return key
+
+    def spa_key(m):
+        key = m.group(0)
+        return key.replace("SPA_KEY_", "").lower().replace("_", ".")
+
+    text = re.sub(r"PW_KEY_A-Z_+", pw_key, text, flags=re.S)
+    text = re.sub(r"SPA_KEY_A-Z_+", spa_key, text, flags=re.S)
+
+    print(text)
+
+
+if __name__ == "__main__":
+    main()

pipewire-0.3.85.tar.gz/doc/meson.build -> pipewire-1.0.0.tar.gz/doc/meson.build Changed

@@ -1,3 +1,5 @@
+fs = import('fs')
+
 doxyfile_conf = configuration_data()
 doxyfile_conf.set('PACKAGE_NAME', meson.project_name())
 doxyfile_conf.set('PACKAGE_VERSION', meson.project_version())
@@ -5,6 +7,14 @@
 doxyfile_conf.set('top_builddir', meson.project_build_root())
 doxyfile_conf.set('output_directory', meson.current_build_dir())
 
+doxygen_env = environment()
+doxygen_env.set('PACKAGE_NAME', meson.project_name())
+doxygen_env.set('PACKAGE_VERSION', meson.project_version())
+doxygen_env.set('PACKAGE_URL', 'https://pipewire.org')
+doxygen_env.set('PACKAGE_BUGREPORT', 'https://gitlab.freedesktop.org/pipewire/pipewire/issues')
+doxygen_env.set('PIPEWIRE_CONFIG_DIR', pipewire_configdir)
+doxygen_env.set('PIPEWIRE_CONFDATADIR', pipewire_confdatadir)
+
 dot_found = find_program('dot', required: false).found()
 summary({'dot (used with doxygen)': dot_found}, bool_yn: true, section: 'Optional programs')
 if dot_found
@@ -14,41 +24,74 @@
 endif
 
 # Note: order here is how doxygen will expose the pages in the sidebar
-# api-tree.dox should be first to determine ordering of Modules.
+# tree.dox should be first to determine the ordering.
 extra_docs = 
-  'api-tree.dox',
-  'index.dox',
-  'overview.dox',
-  'pipewire.dox',
-  'pipewire-design.dox',
-  'pipewire-access.dox',
-  'pipewire-midi.dox',
-  'pipewire-portal.dox',
-  'pipewire-daemon.dox',
-  'pipewire-library.dox',
-  'pipewire-modules.dox',
-  'pipewire-session-manager.dox',
-  'pipewire-objects-design.dox',
-  'pipewire-audio.dox',
-  'pipewire-scheduling.dox',
-  'pipewire-protocol.dox',
-  'tutorial.dox',
-  'tutorial1.dox',
-  'tutorial2.dox',
-  'tutorial3.dox',
-  'tutorial4.dox',
-  'tutorial5.dox',
-  'tutorial6.dox',
-  'api.dox',
-  'spa-index.dox',
-  'spa-plugins.dox',
-  'spa-design.dox',
-  'spa-pod.dox',
-  'spa-buffer.dox',
-  'pulseaudio.dox',
-  'dma-buf.dox',
+  'tree.dox',
+  'dox/index.dox',
+  'dox/overview.dox',
+  'dox/modules.dox',
+  'dox/pulse-modules.dox',
+  'dox/programs/index.md',
+  'dox/internals/index.dox',
+  'dox/internals/design.dox',
+  'dox/internals/access.dox',
+  'dox/internals/midi.dox',
+  'dox/internals/portal.dox',
+  'dox/internals/daemon.dox',
+  'dox/internals/library.dox',
+  'dox/internals/session-manager.dox',
+  'dox/internals/objects.dox',
+  'dox/internals/audio.dox',
+  'dox/internals/scheduling.dox',
+  'dox/internals/protocol.dox',
+  'dox/internals/pulseaudio.dox',
+  'dox/internals/dma-buf.dox',
+  'dox/tutorial/index.dox',
+  'dox/tutorial/tutorial1.dox',
+  'dox/tutorial/tutorial2.dox',
+  'dox/tutorial/tutorial3.dox',
+  'dox/tutorial/tutorial4.dox',
+  'dox/tutorial/tutorial5.dox',
+  'dox/tutorial/tutorial6.dox',
+  'dox/api/index.dox',
+  'dox/api/spa-index.dox',
+  'dox/api/spa-plugins.dox',
+  'dox/api/spa-design.dox',
+  'dox/api/spa-pod.dox',
+  'dox/api/spa-buffer.dox',
 
 
+manpage_docs = 
+  'dox/programs/libpipewire-modules.7.md',
+  'dox/programs/pipewire-pulse-modules.7.md',
+  'dox/programs/pipewire-pulse.1.md',
+  'dox/programs/pipewire-pulse.conf.5.md',
+  'dox/programs/pipewire.1.md',
+  'dox/programs/pipewire.conf.5.md',
+  'dox/programs/pw-cat.1.md',
+  'dox/programs/pw-cli.1.md',
+  'dox/programs/pw-config.1.md',
+  'dox/programs/pw-dot.1.md',
+  'dox/programs/pw-dump.1.md',
+  'dox/programs/pw-jack.1.md',
+  'dox/programs/pw-link.1.md',
+  'dox/programs/pw-loopback.1.md',
+  'dox/programs/pw-metadata.1.md',
+  'dox/programs/pw-mididump.1.md',
+  'dox/programs/pw-mon.1.md',
+  'dox/programs/pw-profiler.1.md',
+  'dox/programs/pw-top.1.md',
+
+
+manpages = 
+
+foreach m : manpage_docs
+  name = fs.stem(fs.name(m))
+  pagepart = name.replace('.', '_')
+  manpages += name, f'page_man_@pagepart@'
+  extra_docs += m
+endforeach
+
 inputs = 
 foreach extra : extra_docs
   inputs += meson.project_source_root() / 'doc' / extra
@@ -68,6 +111,9 @@
 foreach h : module_sources
   inputs += meson.project_source_root() / 'src' / 'modules' / h
 endforeach
+foreach h : pipewire_module_protocol_pulse_sources
+  inputs += meson.project_source_root() / 'src' / 'modules' / h
+endforeach
 input_dirs =  meson.project_source_root() / 'spa' / 'include' / 'spa' 
 
 path_prefixes = 
@@ -116,32 +162,30 @@
 
 input_dirs +=  'doc/examples.dox' 
 
-man_doxygen = 
-man_subpages = 
-foreach m : manpages
-  manconf = configuration_data()
-  pagename = 'page_man_' + m.split('.rst.in').get(0).replace('.', '_').replace('-', '_')
-  filename = m.split('.rst.in').get(0) + '.dox'
-  manconf.set('pagename', pagename)
-  manconf.set('title', m.split('.rst.in').get(0).replace('.1','').replace('.5',''))
-  manconf.set('filename', meson.project_source_root() / 'man' / m)
-  manfile = configure_file(input: 'manpage.dox.in',
-                           output: filename,
-                           configuration: manconf)
-  man_doxygen += manfile
-  man_subpages += '- \subpage ' + pagename
-  input_dirs +=  'doc/' + filename 
+module_manpage_list = 
+foreach m : module_sources
+   name = fs.stem(m)
+   pagepart = name.replace('-', '_')
+   module_manpage_list += f'\\ref page_@pagepart@ "libpipewire-@name@(7)"'
+   manpages += f'libpipewire-@name@.7', f'page_@pagepart@'
 endforeach
 
-pw_tools_dox_conf = configuration_data()
-pw_tools_dox_conf.set('man_subpages', '\n'.join(man_subpages))
-pw_tools_dox = configure_file(input: 'pipewire-tools.dox.in',
-                          output: 'pipewire-tools.dox',
-                          configuration: pw_tools_dox_conf)
-input_dirs +=  'doc/pipewire-tools.dox' 
+doxygen_env.set('LIBPIPEWIRE_MODULES', '<ul><li>' + '</li><li>'.join(module_manpage_list) + '</li></ul>')
+
+pulse_module_manpage_list = 
+foreach m : pipewire_module_protocol_pulse_sources
+  name = fs.stem(fs.name(m))
+  if m.contains('/modules/') and name.startswith('module-')
+    pagepart = name.replace('-', '_')
+    pulse_module_manpage_list += f'\\ref page_pulse_@pagepart@ "pipewire-pulse-@name@(7)"'
+    manpages += f'pipewire-pulse-@name@.7', f'page_pulse_@pagepart@'
+  endif
+endforeach
+
+doxygen_env.set('PIPEWIRE_PULSE_MODULES', '<ul><li>' + '</li><li>'.join(pulse_module_manpage_list) + '</li></ul>')
 
 doxygen_layout = meson.project_source_root() / 'doc' / 'DoxygenLayout.xml'
-doxygen_filter_c = meson.project_source_root() / 'doc' / 'input-filter.sh'
+doxygen_filter_c = meson.project_source_root() / 'doc' / 'input-filter.py'
 doxygen_filter_h = meson.project_source_root() / 'doc' / 'input-filter-h.sh'
 
 doxyfile_conf.set('inputs', ' '.join(inputs + input_dirs))
@@ -161,8 +205,33 @@
 endif
 
 html_target = custom_target('pipewire-docs',
-                            input:  doxyfile, doxygen_layout, examples_dox, pw_tools_dox, doxygen_filter_c, doxygen_filter_h  + inputs + cssfiles + man_doxygen,
+                            input:  doxyfile, doxygen_layout, examples_dox, doxygen_filter_c, doxygen_filter_h  + inputs + cssfiles,
                             output:  'html' ,
                             command:  doxygen, doxyfile ,
-                            install: true,

pipewire-1.0.0.tar.gz/doc/tree.dox Added

@@ -0,0 +1,133 @@
+/**
+
+This determines the ordering of items in Doxygen sidebar.
+
+\defgroup api_pw_core Core API
+\brief PipeWire Core API
+\{
+\addtogroup pw_pipewire
+\addtogroup pw_main_loop
+\addtogroup pw_context
+\addtogroup pw_client
+\addtogroup pw_core
+\addtogroup pw_device
+\addtogroup pw_factory
+\addtogroup pw_link
+\addtogroup pw_loop
+\addtogroup pw_module
+\addtogroup pw_node
+\addtogroup pw_permission
+\addtogroup pw_port
+\addtogroup pw_proxy
+\addtogroup pw_registry
+\addtogroup pw_type
+\addtogroup pw_keys
+\}
+
+\defgroup api_pw_impl Implementation API
+\brief PipeWire Object Implementation API
+\{
+\addtogroup pw_impl_client
+\addtogroup pw_impl_core
+\addtogroup pw_impl_device
+\addtogroup pw_impl_factory
+\addtogroup pw_impl_link
+\addtogroup pw_impl_metadata
+\addtogroup pw_impl_module
+\addtogroup pw_impl_node
+\addtogroup pw_impl_port
+\addtogroup pw_buffers
+\addtogroup pw_control
+\addtogroup pw_data_loop
+\addtogroup pw_global
+\addtogroup pw_protocol
+\addtogroup pw_resource
+\addtogroup pw_thread_loop
+\addtogroup pw_work_queue
+\}
+
+\defgroup api_pw_util Utilities
+\brief PipeWire Utilities
+\{
+\addtogroup pw_array
+\addtogroup pw_conf
+\addtogroup pw_gettext
+\addtogroup pw_log
+\addtogroup pw_map
+\addtogroup pw_memblock
+\addtogroup pw_properties
+\addtogroup pw_thread
+\addtogroup pw_utils
+\}
+
+\defgroup api_pw_ext Extensions
+\brief PipeWire Extensions
+\{
+\addtogroup pw_client_node
+\addtogroup pw_metadata
+\addtogroup pw_profiler
+\addtogroup pw_protocol_native
+\addtogroup pw_session_manager
+\}
+
+\defgroup api_spa SPA
+\brief Simple Plugin API
+\{
+\addtogroup spa_buffer
+\addtogroup spa_control
+\addtogroup spa_debug
+\addtogroup spa_device
+\addtogroup spa_graph
+\addtogroup spa_node
+\addtogroup spa_param
+\addtogroup spa_pod
+\defgroup spa_utils Utilities
+Utility data structures, macros, etc.
+\{
+\addtogroup spa_ansi
+\addtogroup spa_utils_defs
+\addtogroup spa_dict
+\addtogroup spa_list
+\addtogroup spa_hooks
+\addtogroup spa_interfaces
+\addtogroup spa_json
+\addtogroup spa_json_pod
+\addtogroup spa_keys
+\addtogroup spa_names
+\addtogroup spa_result
+\addtogroup spa_ringbuffer
+\addtogroup spa_string
+\addtogroup spa_types
+\}
+\defgroup spa_support Support
+Support interfaces provided by host
+\{
+\addtogroup spa_cpu
+\addtogroup spa_dbus
+\addtogroup spa_i18n
+\addtogroup spa_log
+\addtogroup spa_loop
+\addtogroup spa_handle
+\addtogroup spa_plugin_loader
+\addtogroup spa_system
+\addtogroup spa_thread
+\}
+\}
+
+\defgroup pw_stream Stream
+\{
+\}
+
+\defgroup pw_filter Filter
+\{
+\}
+
+\page page_overview
+\page page_programs
+\page page_modules
+\page page_pulse_modules
+\page page_internals
+\page page_api
+\page page_tutorial
+
+*/

pipewire-0.3.85.tar.gz/meson.build -> pipewire-1.0.0.tar.gz/meson.build Changed

@@ -1,5 +1,5 @@
 project('pipewire', 'c' ,
-  version : '0.3.85',
+  version : '1.0.0',
   license :  'MIT', 'LGPL-2.1-or-later', 'GPL-2.0-only' ,
   meson_version : '>= 0.61.1',
   default_options :  'warning_level=3',
@@ -485,22 +485,21 @@
   subdir('pipewire-alsa/tests')
 endif
 
-generate_manpages = false
-if get_option('man').allowed()
-  rst2man = find_program('rst2man', required: false)
-  if not rst2man.found()
-    rst2man = find_program('rst2man.py', required: get_option('man'))
-  endif
-  if rst2man.found()
-    generate_manpages = true
-  endif
+generate_docs = get_option('man').enabled() or get_option('docs').enabled()
+if get_option('man').allowed() or get_option('docs').allowed()
+  doxygen = find_program('doxygen', required : generate_docs)
+  pymod = import('python')
+  python = pymod.find_installation('python3', required: generate_docs)
+  generate_docs = doxygen.found() and python.found()
 endif
 
-summary({'Manpage generation': generate_manpages}, bool_yn: true)
-subdir('man')
+install_docs = get_option('docs').require(generate_docs).allowed()
+install_man = get_option('man').require(generate_docs).allowed()
+
+summary({'Documentation ': install_docs}, bool_yn: true)
+summary({'Man pages ': install_man}, bool_yn: true)
 
-doxygen = find_program('doxygen', required : get_option('docs'))
-if doxygen.found()
+if generate_docs
   subdir('doc')
 endif

pipewire-0.3.85.tar.gz/meson_options.txt -> pipewire-1.0.0.tar.gz/meson_options.txt Changed

pipewire-0.3.85.tar.gz/pipewire-jack/src/pipewire-jack.c -> pipewire-1.0.0.tar.gz/pipewire-jack/src/pipewire-jack.c Changed

@@ -9,6 +9,7 @@
 #include <sys/mman.h>
 #include <regex.h>
 #include <math.h>
+#include <threads.h>
 
 #include <jack/jack.h>
 #include <jack/intclient.h>
@@ -111,7 +112,7 @@
 static bool mlock_warned = false;
 
 #define MIDI_SCRATCH_FRAMES	8192
-static float midi_scratchMIDI_SCRATCH_FRAMES;
+static thread_local float midi_scratchMIDI_SCRATCH_FRAMES;
 
 
 #define OBJECT_CHUNK		8
@@ -301,6 +302,15 @@
 	char default_audio_source1024;
 };
 
+struct frame_times {
+	uint64_t frames;
+	uint64_t nsec;
+	uint64_t next_nsec;
+	uint32_t buffer_frames;
+	uint32_t sample_rate;
+	double rate_diff;
+};
+
 struct client {
 	char nameJACK_CLIENT_NAME_SIZE+1;
 
@@ -445,6 +455,7 @@
 
 	jack_position_t jack_position;
 	jack_transport_state_t jack_state;
+	struct frame_times jack_times;
 };
 
 #define return_val_if_fail(expr, val)				\
@@ -847,21 +858,6 @@
 	return NULL;
 }
 
-static struct buffer *dequeue_buffer(struct client *c, struct mix *mix)
-{
-	struct buffer *b;
-
-	if (SPA_UNLIKELY(spa_list_is_empty(&mix->queue)))
-		return NULL;
-
-	b = spa_list_first(&mix->queue, struct buffer, link);
-	spa_list_remove(&b->link);
-	SPA_FLAG_SET(b->flags, BUFFER_FLAG_OUT);
-	pw_log_trace_fp("%p: port %p: dequeue buffer %d", c, mix->port, b->id);
-
-	return b;
-}
-
 #if defined (__SSE__)
 #include <xmmintrin.h>
 static void mix_sse(float *dst, float *src, uint32_t n_src, bool aligned, uint32_t n_samples)
@@ -1317,7 +1313,7 @@
 	}
 }
 
-static inline void reuse_buffer(struct client *c, struct mix *mix, uint32_t id)
+static inline void queue_buffer(struct client *c, struct mix *mix, uint32_t id)
 {
 	struct buffer *b;
 
@@ -1330,6 +1326,21 @@
 	}
 }
 
+static inline struct buffer *dequeue_buffer(struct client *c, struct mix *mix)
+{
+	struct buffer *b;
+
+	if (SPA_UNLIKELY(spa_list_is_empty(&mix->queue)))
+		return NULL;
+
+	b = spa_list_first(&mix->queue, struct buffer, link);
+	spa_list_remove(&b->link);
+	SPA_FLAG_SET(b->flags, BUFFER_FLAG_OUT);
+	pw_log_trace_fp("%p: port %p: dequeue buffer %d", c, mix->port, b->id);
+
+	return b;
+}
+
 
 static size_t convert_from_midi(void *midi, void *buffer, size_t size)
 {
@@ -1469,7 +1480,7 @@
 			c, p->object->port.name, p->port_id, frames,
 			mix->n_buffers, mix->io);
 
-	if (SPA_UNLIKELY((io = mix->io) == NULL))
+	if (SPA_UNLIKELY((io = mix->io) == NULL || mix->n_buffers == 0))
 		return NULL;
 
 	if (io->status == SPA_STATUS_HAVE_DATA &&
@@ -1477,21 +1488,26 @@
 		b = &mix->buffersio->buffer_id;
 		d = &b->datas0;
 	} else {
-		if (io->buffer_id < mix->n_buffers) {
-			reuse_buffer(c, mix, io->buffer_id);
-			io->buffer_id = SPA_ID_INVALID;
-		}
-		if (SPA_UNLIKELY((b = dequeue_buffer(c, mix)) == NULL)) {
-			pw_log_warn("port %p: out of buffers", p);
-			return NULL;
+		if (mix->n_buffers == 1) {
+			b = &mix->buffers0;
+		} else {
+			if (io->buffer_id < mix->n_buffers)
+				queue_buffer(c, mix, io->buffer_id);
+			b = dequeue_buffer(c, mix);
+
+			if (SPA_UNLIKELY(b == NULL)) {
+				pw_log_warn("port %p: out of buffers %d", p, mix->n_buffers);
+				io->buffer_id = SPA_ID_INVALID;
+				return NULL;
+			}
 		}
 		d = &b->datas0;
 		d->chunk->offset = 0;
 		d->chunk->size = frames * sizeof(float);
 		d->chunk->stride = stride;
 
-		io->status = SPA_STATUS_HAVE_DATA;
 		io->buffer_id = b->id;
+		io->status = SPA_STATUS_HAVE_DATA;
 	}
 	ptr = d->data;
 	if (buf)
@@ -1520,9 +1536,14 @@
 	{
 		struct buffer *b;
 		ptr = get_buffer_output(p, c->max_frames, 1, &b);
-		if (SPA_LIKELY(ptr != NULL))
+		if (SPA_LIKELY(ptr != NULL)) {
+			/* first build the complete pod in scratch memory, then copy it
+			 * to the target buffer. This makes it possible for multiple threads
+			 * to do this concurrently */
 			b->datas0.chunk->size = convert_from_midi(src,
-					ptr, c->max_frames * sizeof(float));
+					midi_scratch, MIDI_SCRATCH_FRAMES * sizeof(float));
+			memcpy(ptr, midi_scratch, b->datas0.chunk->size);
+		}
 		break;
 	}
 	default:
@@ -1578,38 +1599,38 @@
 
 static inline void debug_position(struct client *c, jack_position_t *p)
 {
-	pw_log_trace("usecs:       %"PRIu64, p->usecs);
-	pw_log_trace("frame_rate:  %u", p->frame_rate);
-	pw_log_trace("frame:       %u", p->frame);
-	pw_log_trace("valid:       %08x", p->valid);
+	pw_log_trace_fp("usecs:       %"PRIu64, p->usecs);
+	pw_log_trace_fp("frame_rate:  %u", p->frame_rate);
+	pw_log_trace_fp("frame:       %u", p->frame);
+	pw_log_trace_fp("valid:       %08x", p->valid);
 
 	if (p->valid & JackPositionBBT) {
-		pw_log_trace("BBT");
-		pw_log_trace(" bar:              %u", p->bar);
-		pw_log_trace(" beat:             %u", p->beat);
-		pw_log_trace(" tick:             %u", p->tick);
-		pw_log_trace(" bar_start_tick:   %f", p->bar_start_tick);
-		pw_log_trace(" beats_per_bar:    %f", p->beats_per_bar);
-		pw_log_trace(" beat_type:        %f", p->beat_type);
-		pw_log_trace(" ticks_per_beat:   %f", p->ticks_per_beat);
-		pw_log_trace(" beats_per_minute: %f", p->beats_per_minute);
+		pw_log_trace_fp("BBT");
+		pw_log_trace_fp(" bar:              %u", p->bar);
+		pw_log_trace_fp(" beat:             %u", p->beat);
+		pw_log_trace_fp(" tick:             %u", p->tick);
+		pw_log_trace_fp(" bar_start_tick:   %f", p->bar_start_tick);
+		pw_log_trace_fp(" beats_per_bar:    %f", p->beats_per_bar);
+		pw_log_trace_fp(" beat_type:        %f", p->beat_type);
+		pw_log_trace_fp(" ticks_per_beat:   %f", p->ticks_per_beat);
+		pw_log_trace_fp(" beats_per_minute: %f", p->beats_per_minute);
 	}
 	if (p->valid & JackPositionTimecode) {
-		pw_log_trace("Timecode:");
-		pw_log_trace(" frame_time:       %f", p->frame_time);
-		pw_log_trace(" next_time:        %f", p->next_time);
+		pw_log_trace_fp("Timecode:");
+		pw_log_trace_fp(" frame_time:       %f", p->frame_time);
+		pw_log_trace_fp(" next_time:        %f", p->next_time);
 	}
 	if (p->valid & JackBBTFrameOffset) {
-		pw_log_trace("BBTFrameOffset:");
-		pw_log_trace(" bbt_offset:       %u", p->bbt_offset);
+		pw_log_trace_fp("BBTFrameOffset:");

pipewire-0.3.85.tar.gz/spa/include/spa/buffer/alloc.h -> pipewire-1.0.0.tar.gz/spa/include/spa/buffer/alloc.h Changed

pipewire-0.3.85.tar.gz/spa/include/spa/graph/graph.h -> pipewire-1.0.0.tar.gz/spa/include/spa/graph/graph.h Changed

pipewire-0.3.85.tar.gz/spa/include/spa/monitor/utils.h -> pipewire-1.0.0.tar.gz/spa/include/spa/monitor/utils.h Changed

pipewire-0.3.85.tar.gz/spa/include/spa/node/utils.h -> pipewire-1.0.0.tar.gz/spa/include/spa/node/utils.h Changed

@@ -24,7 +24,7 @@
 };
 
 static inline void spa_result_func_node_params(void *data,
-		int seq, int res, uint32_t type, const void *result)
+		int seq SPA_UNUSED, int res SPA_UNUSED, uint32_t type SPA_UNUSED, const void *result)
 {
 	struct spa_result_node_params_data *d =
 		(struct spa_result_node_params_data *) data;
@@ -43,8 +43,8 @@
 			struct spa_pod **param,
 			struct spa_pod_builder *builder)
 {
-	struct spa_result_node_params_data data = { builder, };
-	struct spa_hook listener = {{0}};
+	struct spa_result_node_params_data data = { builder, {0}};
+	struct spa_hook listener = {{0}, {0}, 0, 0};
 	static const struct spa_node_events node_events = {
 		.version = SPA_VERSION_NODE_EVENTS,
 		.info = NULL,
@@ -77,8 +77,8 @@
 			struct spa_pod **param,
 			struct spa_pod_builder *builder)
 {
-	struct spa_result_node_params_data data = { builder, };
-	struct spa_hook listener = {{0}};
+	struct spa_result_node_params_data data = { builder, {0}};
+	struct spa_hook listener = {{0}, {0}, 0, 0};
 	static const struct spa_node_events node_events = {
 		.version = SPA_VERSION_NODE_EVENTS,
 		.info = NULL,

pipewire-0.3.85.tar.gz/spa/include/spa/pod/filter.h -> pipewire-1.0.0.tar.gz/spa/include/spa/pod/filter.h Changed

pipewire-0.3.85.tar.gz/spa/include/spa/support/log-impl.h -> pipewire-1.0.0.tar.gz/spa/include/spa/support/log-impl.h Changed

pipewire-0.3.85.tar.gz/spa/include/spa/utils/json.h -> pipewire-1.0.0.tar.gz/spa/include/spa/utils/json.h Changed

pipewire-0.3.85.tar.gz/spa/plugins/alsa/alsa-pcm-sink.c -> pipewire-1.0.0.tar.gz/spa/plugins/alsa/alsa-pcm-sink.c Changed

pipewire-0.3.85.tar.gz/spa/plugins/alsa/alsa-pcm-source.c -> pipewire-1.0.0.tar.gz/spa/plugins/alsa/alsa-pcm-source.c Changed

pipewire-0.3.85.tar.gz/spa/plugins/alsa/alsa-pcm.c -> pipewire-1.0.0.tar.gz/spa/plugins/alsa/alsa-pcm.c Changed

@@ -706,7 +706,7 @@
 		state->ctl_sourcesi.fd = pfdsi.fd;
 		state->ctl_sourcesi.mask = SPA_IO_IN;
 		state->ctl_sourcesi.rmask = 0;
-		spa_loop_add_source(state->data_loop, &state->ctl_sourcesi);
+		spa_loop_add_source(state->main_loop, &state->ctl_sourcesi);
 	}
 
 	for (unsigned int i = 0; i < state->num_bind_ctls; i++) {
@@ -839,7 +839,7 @@
 
 	if (state->ctl) {
 		for (int i = 0; i < state->ctl_n_fds; i++) {
-			spa_loop_remove_source(state->data_loop, &state->ctl_sourcesi);
+			spa_loop_remove_source(state->main_loop, &state->ctl_sourcesi);
 		}
 
 		snd_ctl_close(state->ctl);
@@ -2531,6 +2531,15 @@
 	return 0;
 }
 
+
+static uint64_t get_time_ns(struct state *state)
+{
+	struct timespec now;
+	if (spa_system_clock_gettime(state->data_system, CLOCK_MONOTONIC, &now) < 0)
+		return 0;
+	return SPA_TIMESPEC_TO_NSEC(&now);
+}
+
 static int update_time(struct state *state, uint64_t current_time, snd_pcm_sframes_t delay,
 		snd_pcm_sframes_t target, bool follower)
 {
@@ -2538,8 +2547,15 @@
 	int32_t diff;
 
 	if (state->disable_tsched && !follower) {
-		err = (int64_t)(current_time - state->next_time);
-		err = err / 1e9 * state->rate;
+		uint64_t now = get_time_ns(state);
+
+		if (SPA_UNLIKELY(state->dll.bw == 0.0)) {
+			current_time = now;
+			err = 0.0;
+		} else {
+			err = (int64_t)(now - current_time);
+			err = err / 1e9 * state->rate;
+		}
 	} else {
 		if (state->stream == SND_PCM_STREAM_PLAYBACK)
 			err = delay - target;
@@ -3166,14 +3182,6 @@
 	return 0;
 }
 
-static uint64_t get_time_ns(struct state *state)
-{
-	struct timespec now;
-	if (spa_system_clock_gettime(state->data_system, CLOCK_MONOTONIC, &now) < 0)
-		return 0;
-	return SPA_TIMESPEC_TO_NSEC(&now);
-}
-
 static void alsa_wakeup_event(struct spa_source *source)
 {
 	struct state *state = source->data, *follower;
@@ -3185,8 +3193,6 @@
 		int err;
 		unsigned short revents;
 
-		current_time = get_time_ns(state);
-
 		for (int i = 0; i < state->n_fds; i++) {
 			state->pfdsi.revents = state->sourcei.rmask;
 			/* Reset so that we only handle all our sources' events once */
@@ -3222,8 +3228,8 @@
 				return;
 			}
 		}
-		current_time = state->next_time;
 	}
+	current_time = state->next_time;
 
 	/* first do all the sync */
 	if (state->stream == SND_PCM_STREAM_CAPTURE)

pipewire-0.3.85.tar.gz/spa/plugins/alsa/alsa-pcm.h -> pipewire-1.0.0.tar.gz/spa/plugins/alsa/alsa-pcm.h Changed

pipewire-0.3.85.tar.gz/spa/plugins/bluez5/bap-codec-lc3.c -> pipewire-1.0.0.tar.gz/spa/plugins/bluez5/bap-codec-lc3.c Changed

@@ -14,6 +14,7 @@
 #include <spa/param/audio/format.h>
 #include <spa/param/audio/format-utils.h>
 #include <spa/utils/string.h>
+#include <spa/debug/log.h>
 
 #include <lc3.h>
 
@@ -22,6 +23,11 @@
 
 #define MAX_PACS	64
 
+static struct spa_log *log;
+static struct spa_log_topic log_topic = SPA_LOG_TOPIC(0, "spa.bluez5.codecs.lc3");
+#undef SPA_LOG_TOPIC_DEFAULT
+#define SPA_LOG_TOPIC_DEFAULT &log_topic
+
 struct impl {
 	lc3_encoder_t encLC3_MAX_CHANNELS;
 	lc3_decoder_t decLC3_MAX_CHANNELS;
@@ -38,6 +44,7 @@
 struct pac_data {
 	const uint8_t *data;
 	size_t size;
+	int index;
 	uint32_t locations;
 };
 
@@ -126,7 +133,31 @@
 	return data - caps;
 }
 
-static int parse_bluez_pacs(const uint8_t *data, size_t data_size, struct pac_data pacsMAX_PACS)
+static void debugc_ltv(struct spa_debug_context *debug_ctx, int pac, struct ltv *ltv)
+{
+	switch (ltv->len) {
+	case 0:
+		spa_debugc(debug_ctx, "PAC %d: --", pac);
+		break;
+	case 2:
+		spa_debugc(debug_ctx, "PAC %d: 0x%02x %x", pac, ltv->type, ltv->value0);
+		break;
+	case 3:
+		spa_debugc(debug_ctx, "PAC %d: 0x%02x %x %x", pac, ltv->type, ltv->value0, ltv->value1);
+		break;
+	case 5:
+		spa_debugc(debug_ctx, "PAC %d: 0x%02x %x %x %x %x", pac, ltv->type,
+				ltv->value0, ltv->value1, ltv->value2, ltv->value3);
+		break;
+	default:
+		spa_debugc(debug_ctx, "PAC %d: 0x%02x", pac, ltv->type);
+		spa_debugc_mem(debug_ctx, 7, ltv->value, ltv->len - 1);
+		break;
+	}
+}
+
+static int parse_bluez_pacs(const uint8_t *data, size_t data_size, struct pac_data pacsMAX_PACS,
+		struct spa_debug_context *debug_ctx)
 {
 	/*
 	 * BlueZ capabilites for the same codec may contain multiple
@@ -145,10 +176,11 @@
 				break;
 
 			++pac;
-			pacspac = (struct pac_data){ data + 1, 0 };
+			pacspac = (struct pac_data){ data + 1, 0, pac };
 		} else if (ltv->len >= data_size) {
 			return -EINVAL;
 		} else {
+			debugc_ltv(debug_ctx, pac, ltv);
 			pacspac.size += ltv->len + 1;
 		}
 		data_size -= ltv->len + 1;
@@ -172,13 +204,13 @@
 	return num;
 }
 
-static int select_channels(uint8_t channels, uint32_t locations, uint32_t *mapping)
+static int select_channels(uint8_t channels, uint32_t locations, uint32_t *mapping, unsigned int max_channels)
 {
-	unsigned int i, num;
+	unsigned int i, num = 0;
 
-	if (channels & LC3_CHAN_2)
+	if ((channels & LC3_CHAN_2) && max_channels >= 2)
 		num = 2;
-	else if (channels & LC3_CHAN_1)
+	else if ((channels & LC3_CHAN_1) && max_channels >= 1)
 		num = 1;
 	else
 		return -1;
@@ -202,12 +234,13 @@
 	return 0;
 }
 
-static bool select_config(bap_lc3_t *conf, const struct pac_data *pac)
+static bool select_config(bap_lc3_t *conf, const struct pac_data *pac,	struct spa_debug_context *debug_ctx)
 {
 	const uint8_t *data = pac->data;
 	size_t data_size = pac->size;
 	uint16_t framelen_min = 0, framelen_max = 0;
 	int max_frames = -1;
+	uint8_t channels = 0;
 
 	if (!data_size)
 		return false;
@@ -221,8 +254,10 @@
 	while (data_size > 0) {
 		struct ltv *ltv = (struct ltv *)data;
 
-		if (ltv->len < sizeof(struct ltv) || ltv->len >= data_size)
+		if (ltv->len < sizeof(struct ltv) || ltv->len >= data_size) {
+			spa_debugc(debug_ctx, "invalid LTV data");
 			return false;
+		}
 
 		switch (ltv->type) {
 		case LC3_TYPE_FREQ:
@@ -237,8 +272,10 @@
 					conf->rate = LC3_CONFIG_FREQ_16KHZ;
 				else if (rate & LC3_FREQ_8KHZ)
 					conf->rate = LC3_CONFIG_FREQ_8KHZ;
-				else
+				else {
+					spa_debugc(debug_ctx, "unsupported rate: 0x%04x", rate);
 					return false;
+				}
 			}
 			break;
 		case LC3_TYPE_DUR:
@@ -249,17 +286,16 @@
 					conf->frame_duration = LC3_CONFIG_DURATION_10;
 				else if (duration & LC3_DUR_7_5)
 					conf->frame_duration = LC3_CONFIG_DURATION_7_5;
-				else
+				else {
+					spa_debugc(debug_ctx, "unsupported duration: 0x%02x", duration);
 					return false;
+				}
 			}
 			break;
 		case LC3_TYPE_CHAN:
 			spa_return_val_if_fail(ltv->len == 2, false);
 			{
-				uint8_t channels = ltv->value0;
-
-				if (select_channels(channels, pac->locations, &conf->channels) < 0)
-					return false;
+				channels = ltv->value0;
 			}
 			break;
 		case LC3_TYPE_FRAMELEN:
@@ -272,22 +308,35 @@
 			max_frames = ltv->value0;
 			break;
 		default:
-			return false;
+			spa_debugc(debug_ctx, "unknown LTV type: 0x%02x", ltv->type);
+			break;
 		}
 		data_size -= ltv->len + 1;
 		data += ltv->len + 1;
 	}
 
+	if (select_channels(channels, pac->locations, &conf->channels, max_frames) < 0) {
+		spa_debugc(debug_ctx, "invalid channel configuration: 0x%02x %u",
+				channels, max_frames);
+		return false;
+	}
+
 	/* Default: 1 per channel (BAP v1.0.1 Sec 4.3.1) */
 	if (max_frames < 0)
 		max_frames = get_num_channels(conf->channels);
-	if (max_frames < get_num_channels(conf->channels))
+	if (max_frames < get_num_channels(conf->channels)) {
+		spa_debugc(debug_ctx, "invalid max frames per SDU: %u", max_frames);
 		return false;
+	}
 
-	if (framelen_min < LC3_MIN_FRAME_BYTES || framelen_max > LC3_MAX_FRAME_BYTES)
+	if (framelen_min < LC3_MIN_FRAME_BYTES || framelen_max > LC3_MAX_FRAME_BYTES) {
+		spa_debugc(debug_ctx, "invalid framelen: %u %u", framelen_min, framelen_max);
 		return false;
-	if (conf->frame_duration == 0xFF || !conf->rate)
+	}
+	if (conf->frame_duration == 0xFF || !conf->rate) {
+		spa_debugc(debug_ctx, "no frame duration or rate");
 		return false;
+	}
 
 	/* BAP v1.0.1 Table 5.2; high-reliability */
 	switch (conf->rate) {
@@ -316,7 +365,8 @@
 			conf->framelen = 30;	/* 8_2_2 */
 		break;
 	default:
-			return false;
+		spa_debugc(debug_ctx, "invalid rate");
+		return false;

pipewire-0.3.85.tar.gz/spa/plugins/bluez5/bluez5-dbus.c -> pipewire-1.0.0.tar.gz/spa/plugins/bluez5/bluez5-dbus.c Changed

pipewire-0.3.85.tar.gz/spa/plugins/libcamera/libcamera-source.cpp -> pipewire-1.0.0.tar.gz/spa/plugins/libcamera/libcamera-source.cpp Changed

@@ -26,6 +26,7 @@
 #include <spa/node/keys.h>
 #include <spa/param/video/format-utils.h>
 #include <spa/param/param.h>
+#include <spa/param/latency-utils.h>
 #include <spa/control/control.h>
 #include <spa/pod/filter.h>
 
@@ -96,7 +97,8 @@
 #define PORT_IO		3
 #define PORT_Format	4
 #define PORT_Buffers	5
-#define N_PORT_PARAMS	6
+#define PORT_Latency	6
+#define N_PORT_PARAMS	7
 	struct spa_param_info paramsN_PORT_PARAMS;
 
 	uint32_t fmt_index = 0;
@@ -114,6 +116,7 @@
 		paramsPORT_IO = SPA_PARAM_INFO(SPA_PARAM_IO, SPA_PARAM_INFO_READ);
 		paramsPORT_Format = SPA_PARAM_INFO(SPA_PARAM_Format, SPA_PARAM_INFO_WRITE);
 		paramsPORT_Buffers = SPA_PARAM_INFO(SPA_PARAM_Buffers, 0);
+		paramsPORT_Latency = SPA_PARAM_INFO(SPA_PARAM_Latency, SPA_PARAM_INFO_READ);
 
 		info.flags = SPA_PORT_FLAG_LIVE | SPA_PORT_FLAG_PHYSICAL | SPA_PORT_FLAG_TERMINAL;
 		info.params = params;
@@ -152,6 +155,8 @@
 	struct spa_io_position *position = nullptr;
 	struct spa_io_clock *clock = nullptr;
 
+	struct spa_latency_info latency2;
+
 	std::shared_ptr<CameraManager> manager;
 	std::shared_ptr<Camera> camera;
 
@@ -601,6 +606,15 @@
 			return 0;
 		}
 		break;
+	case SPA_PARAM_Latency:
+		switch (result.index) {
+		case 0: case 1:
+			param = spa_latency_build(&b, id, &impl->latencyresult.index);
+			break;
+		default:
+			return 0;
+		}
+		break;
 	default:
 		return -ENOENT;
 	}
@@ -961,6 +975,9 @@
 	info.flags = SPA_NODE_FLAG_RT;
 	info.params = params;
 	info.n_params = N_NODE_PARAMS;
+
+	latencySPA_DIRECTION_INPUT = SPA_LATENCY_INFO(SPA_DIRECTION_INPUT);
+	latencySPA_DIRECTION_OUTPUT = SPA_LATENCY_INFO(SPA_DIRECTION_OUTPUT);
 }
 
 static size_t

pipewire-0.3.85.tar.gz/spa/plugins/support/evl-system.c -> pipewire-1.0.0.tar.gz/spa/plugins/support/evl-system.c Changed

@@ -11,6 +11,7 @@
 #include <fcntl.h>
 #include <sys/eventfd.h>
 #include <sys/signalfd.h>
+#include <pthread.h>
 
 #include <evl/evl.h>
 #include <evl/timer.h>
@@ -32,6 +33,7 @@
 	int fd;
 	uint32_t events;
 	void *data;
+	unsigned attached:1;
 };
 
 struct impl {
@@ -45,6 +47,7 @@
 
 	uint32_t n_xbuf;
 	int attached;
+	pthread_t thread;
 	int pid;
 };
 
@@ -110,6 +113,21 @@
 	return retval;
 }
 
+static inline struct poll_entry *find_free(struct impl *impl)
+{
+	uint32_t i;
+	for (i = 0; i < impl->n_entries; i++) {
+		struct poll_entry *e = &impl->entriesi;
+		if (e->fd == -1)
+			return e;
+	}
+	if (impl->n_entries == MAX_POLL) {
+		errno = ENOSPC;
+		return NULL;
+	}
+	return &impl->entriesimpl->n_entries++;
+}
+
 static inline struct poll_entry *find_entry(struct impl *impl, int pfd, int fd)
 {
 	uint32_t i;
@@ -121,20 +139,36 @@
 	return NULL;
 }
 
+static int attach_entry(struct impl *impl, struct poll_entry *e)
+{
+	if (!e->attached && e->fd != -1) {
+		int res;
+
+		res = evl_add_pollfd(e->pfd, e->fd, e->events, evl_nil);
+		if (res < 0)
+			return res;
+
+		e->attached = true;
+	}
+	return 0;
+}
+
 static int impl_pollfd_add(void *object, int pfd, int fd, uint32_t events, void *data)
 {
 	struct impl *impl = object;
 	struct poll_entry *e;
+	int res = 0;
 
-	if (impl->n_entries == MAX_POLL)
-		return -ENOSPC;
+	if ((e = find_free(impl)) == NULL)
+		return -errno;
 
-	e = &impl->entriesimpl->n_entries++;
 	e->pfd = pfd;
 	e->fd = fd;
 	e->events = events;
 	e->data = data;
-	return evl_add_pollfd(pfd, fd, e->events, evl_nil);
+	if (impl->attached != 0)
+		attach_entry(impl, e);
+	return res;
 }
 
 static int impl_pollfd_mod(void *object, int pfd, int fd, uint32_t events, void *data)
@@ -162,6 +196,7 @@
 
 	e->pfd = -1;
 	e->fd = -1;
+	e->attached = false;
 	return evl_del_pollfd(pfd, fd);
 }
 
@@ -178,6 +213,12 @@
 		if (res < 0)
 			return res;
 		impl->attached = res;
+		impl->thread = pthread_self();
+
+		for (i = 0; i < (int)impl->n_entries; i++) {
+			struct poll_entry *e = &impl->entriesi;
+			attach_entry(impl, e);
+		}
 	}
 
 	if (timeout == -1) {
@@ -259,12 +300,14 @@
 {
 	struct impl *impl = object;
 	int res, fl;
+	struct evl_flags flg;
 
-	fl = EVL_CLONE_PRIVATE;
+	fl = EVL_CLONE_PUBLIC;
 	if (flags & SPA_FD_NONBLOCK)
 		fl |= EVL_CLONE_NONBLOCK;
 
-	res = evl_create_xbuf(1024, 1024, fl, "xbuf-%d-%p-%d", impl->pid, impl, impl->n_xbuf);
+	res = evl_create_flags(&flg, EVL_CLOCK_MONOTONIC, 0, fl,
+			"flags-%d-%p-%d", impl->pid, impl, impl->n_xbuf);
 	if (res < 0)
 		return res;
 
@@ -275,14 +318,35 @@
 
 static int impl_eventfd_write(void *object, int fd, uint64_t count)
 {
-	if (write(fd, &count, sizeof(uint64_t)) != sizeof(uint64_t))
-		return -errno;
-	return 0;
+	int res;
+	int flags = count;
+	struct impl *impl = object;
+	pthread_t tid = pthread_self();
+
+	if (impl->thread != tid)
+		res = write(fd, &flags, sizeof(flags));
+	else
+		res = oob_write(fd, &flags, sizeof(flags));
+
+	if (res != sizeof(flags))
+		res = -errno;
+	return res;
 }
 
 static int impl_eventfd_read(void *object, int fd, uint64_t *count)
 {
-	if (oob_read(fd, count, sizeof(uint64_t)) != sizeof(uint64_t))
+	int res;
+	int flags;
+	struct impl *impl = object;
+	pthread_t tid = pthread_self();
+
+	if (impl->thread != tid)
+		res = read(fd, &flags, sizeof(flags));
+	else
+		res = oob_read(fd, &flags, sizeof(flags));
+
+	*count = flags;
+	if (res != sizeof(flags))
 		return -errno;
 	return 0;
 }
@@ -400,12 +464,12 @@
 
 	impl->pid = getpid();
 
-	if ((res = evl_attach_self("evl-system-%d-%p", impl->pid, impl)) < 0) {
+	if ((res = evl_init()) < 0) {
 		spa_log_error(impl->log, NAME " %p: init failed: %s", impl, spa_strerror(res));
 		return res;
 	}
 
-	spa_log_debug(impl->log, NAME " %p: initialized", impl);
+	spa_log_info(impl->log, NAME " %p: initialized", impl);
 
 	return 0;
 }

pipewire-0.3.85.tar.gz/src/daemon/meson.build -> pipewire-1.0.0.tar.gz/src/daemon/meson.build Changed

pipewire-0.3.85.tar.gz/src/examples/audio-capture.c -> pipewire-1.0.0.tar.gz/src/examples/audio-capture.c Changed

pipewire-0.3.85.tar.gz/src/modules/meson.build -> pipewire-1.0.0.tar.gz/src/modules/meson.build Changed

pipewire-0.3.85.tar.gz/src/modules/module-access.c -> pipewire-1.0.0.tar.gz/src/modules/module-access.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-adapter.c -> pipewire-1.0.0.tar.gz/src/modules/module-adapter.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-avb.c -> pipewire-1.0.0.tar.gz/src/modules/module-avb.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-client-device.c -> pipewire-1.0.0.tar.gz/src/modules/module-client-device.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-client-node.c -> pipewire-1.0.0.tar.gz/src/modules/module-client-node.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-client-node/client-node.c -> pipewire-1.0.0.tar.gz/src/modules/module-client-node/client-node.c Changed

@@ -49,7 +49,6 @@
 };
 
 struct mix {
-	unsigned int valid:1;
 	uint32_t mix_id;
 	struct port *port;
 	uint32_t peer_id;
@@ -79,7 +78,7 @@
 	unsigned int removed:1;
 	unsigned int destroyed:1;
 
-	struct pw_array mix;
+	struct pw_map mix;
 };
 
 struct impl {
@@ -191,42 +190,62 @@
 
 static struct mix *find_mix(struct port *p, uint32_t mix_id)
 {
-	struct mix *mix;
+	if (mix_id == SPA_ID_INVALID)
+		mix_id = 0;
+	else
+		mix_id++;
+
+	return pw_map_lookup(&p->mix, mix_id);
+}
+
+static struct mix *create_mix(struct port *p, uint32_t mix_id)
+{
+	struct mix *mix = NULL;
 	size_t len;
+	int res;
 
 	if (mix_id == SPA_ID_INVALID)
 		mix_id = 0;
 	else
 		mix_id++;
 
-	len = pw_array_get_len(&p->mix, struct mix);
-	if (mix_id >= len) {
-		size_t need = sizeof(struct mix) * (mix_id + 1 - len);
-		void *ptr = pw_array_add(&p->mix, need);
-		if (ptr == NULL)
-			return NULL;
-		memset(ptr, 0, need);
+	if (pw_map_lookup(&p->mix, mix_id) != NULL) {
+		errno = EEXIST;
+		return NULL;
 	}
-	mix = pw_array_get_unchecked(&p->mix, mix_id, struct mix);
-	return mix;
-}
 
-static void mix_init(struct mix *mix, struct port *p, uint32_t mix_id)
-{
-	mix->valid = true;
+	/* pad map size */
+	for (len = pw_map_get_size(&p->mix); len < mix_id; ++len)
+		if ((res = pw_map_insert_at(&p->mix, len, NULL)) < 0)
+			goto fail;
+
+	mix = calloc(1, sizeof(struct mix));
+	if (mix == NULL)
+		return NULL;
+	if ((res = pw_map_insert_at(&p->mix, mix_id, mix)) < 0)
+		goto fail;
+
 	mix->mix_id = mix_id;
 	mix->port = p;
 	mix->n_buffers = 0;
+	return mix;
+
+fail:
+	free(mix);
+	errno = -res;
+	return NULL;
 }
 
-static struct mix *create_mix(struct impl *impl, struct port *p, uint32_t mix_id)
+static void free_mix(struct port *p, struct mix *mix)
 {
-	struct mix *mix;
+	if (mix == NULL)
+		return;
 
-	if ((mix = find_mix(p, mix_id)) == NULL || mix->valid)
-		return NULL;
-	mix_init(mix, p, mix_id);
-	return mix;
+	/* never realloc so it's safe to call from pw_map_foreach */
+	if (mix->mix_id < pw_map_get_size(&p->mix))
+		pw_map_insert_at(&p->mix, mix->mix_id, NULL);
+
+	free(mix);
 }
 
 static void clear_data(struct impl *impl, struct spa_data *d)
@@ -255,19 +274,21 @@
 	}
 }
 
-static int clear_buffers(struct impl *impl, struct mix *mix)
+static void clear_buffer(struct impl *impl, struct spa_buffer *b)
 {
-	uint32_t i, j;
+	uint32_t i;
+	for (i = 0; i < b->n_datas; i++)
+		clear_data(impl, &b->datasi);
+}
 
+static int clear_buffers(struct impl *impl, struct mix *mix)
+{
+	uint32_t i;
 	for (i = 0; i < mix->n_buffers; i++) {
 		struct buffer *b = &mix->buffersi;
 
 		spa_log_debug(impl->log, "%p: clear buffer %d", impl, i);
-
-		for (j = 0; j < b->buffer.n_datas; j++) {
-			struct spa_data *d = &b->datasj;
-			clear_data(impl, d);
-		}
+		clear_buffer(impl, &b->buffer);
 		pw_memblock_unref(b->mem);
 	}
 	mix->n_buffers = 0;
@@ -278,11 +299,10 @@
 {
 	struct port *port = mix->port;
 
-	if (!mix->valid)
-		return;
 	do_port_use_buffers(impl, port->direction, port->id,
 			mix->mix_id, 0, NULL, 0);
-	mix->valid = false;
+
+	free_mix(port, mix);
 }
 
 static int impl_node_enum_params(void *object, int seq,
@@ -496,21 +516,25 @@
 	}
 }
 
+static int mix_clear_cb(void *item, void *data)
+{
+	if (item)
+		mix_clear(data, item);
+	return 0;
+}
+
 static void
 clear_port(struct impl *impl, struct port *port)
 {
-	struct mix *mix;
-
 	spa_log_debug(impl->log, "%p: clear port %p", impl, port);
 
 	do_update_port(impl, port,
 		       PW_CLIENT_NODE_PORT_UPDATE_PARAMS |
 		       PW_CLIENT_NODE_PORT_UPDATE_INFO, 0, NULL, NULL);
 
-	pw_array_for_each(mix, &port->mix)
-		mix_clear(impl, mix);
-	pw_array_clear(&port->mix);
-	pw_array_init(&port->mix, sizeof(struct mix) * 2);
+	pw_map_for_each(&port->mix, mix_clear_cb, impl);
+	pw_map_clear(&port->mix);
+	pw_map_init(&port->mix, 0, 2);
 
 	pw_map_insert_at(&impl->portsport->direction, port->id, NULL);
 
@@ -604,6 +628,13 @@
 	return found ? 0 : -ENOENT;
 }
 
+static int clear_buffers_cb(void *item, void *data)
+{
+	if (item)
+		clear_buffers(data, item);
+	return 0;
+}
+
 static int
 impl_node_port_set_param(void *object,
 			 enum spa_direction direction, uint32_t port_id,
@@ -612,7 +643,6 @@
 {
 	struct impl *impl = object;
 	struct port *port;
-	struct mix *mix;
 
 	spa_return_val_if_fail(impl != NULL, -EINVAL);
 
@@ -624,10 +654,9 @@
 			direction, port_id,
 			spa_debug_type_find_name(spa_type_param, id), id);

pipewire-0.3.85.tar.gz/src/modules/module-combine-stream.c -> pipewire-1.0.0.tar.gz/src/modules/module-combine-stream.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-echo-cancel.c -> pipewire-1.0.0.tar.gz/src/modules/module-echo-cancel.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-example-filter.c -> pipewire-1.0.0.tar.gz/src/modules/module-example-filter.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-example-sink.c -> pipewire-1.0.0.tar.gz/src/modules/module-example-sink.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-example-source.c -> pipewire-1.0.0.tar.gz/src/modules/module-example-source.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-fallback-sink.c -> pipewire-1.0.0.tar.gz/src/modules/module-fallback-sink.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-ffado-driver.c -> pipewire-1.0.0.tar.gz/src/modules/module-ffado-driver.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-filter-chain.c -> pipewire-1.0.0.tar.gz/src/modules/module-filter-chain.c Changed

@@ -34,7 +34,7 @@
 #define PW_LOG_TOPIC_DEFAULT mod_topic
 
 /**
- * \page page_module_filter_chain PipeWire Module: Filter-Chain
+ * \page page_module_filter_chain Filter-Chain
  *
  * The filter-chain allows you to create an arbitrary processing graph
  * from LADSPA, LV2 and builtin filters. This filter can be made into a
@@ -48,6 +48,10 @@
  * manager can manage the configuration and connection with the sinks and
  * sources automatically.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-filter-chain`
+ *
  * ## Module Options
  *
  * - `node.description`: a human readable name for the filter chain
@@ -2854,6 +2858,9 @@
 	graph_free(&impl->graph);
 	spa_list_consume(pl, &impl->plugin_func_list, link)
 		free_plugin_func(pl);
+
+	free(impl->silence_data);
+	free(impl->discard_data);
 	free(impl);
 }
 
@@ -2974,8 +2981,18 @@
 	impl->quantum_limit = pw_properties_get_uint32(
 			pw_context_get_properties(impl->context),
 			"default.clock.quantum-limit", 8192u);
+
 	impl->silence_data = calloc(impl->quantum_limit, sizeof(float));
+	if (impl->silence_data == NULL) {
+		res = -errno;
+		goto error;
+	}
+
 	impl->discard_data = calloc(impl->quantum_limit, sizeof(float));
+	if (impl->discard_data == NULL) {
+		res = -errno;
+		goto error;
+	}
 
 	cpu_iface = spa_support_find(support, n_support, SPA_TYPE_INTERFACE_CPU);
 	impl->dsp.cpu_flags = cpu_iface ? spa_cpu_get_flags(cpu_iface) : 0;

pipewire-0.3.85.tar.gz/src/modules/module-jack-tunnel.c -> pipewire-1.0.0.tar.gz/src/modules/module-jack-tunnel.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-jackdbus-detect.c -> pipewire-1.0.0.tar.gz/src/modules/module-jackdbus-detect.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-link-factory.c -> pipewire-1.0.0.tar.gz/src/modules/module-link-factory.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-loopback.c -> pipewire-1.0.0.tar.gz/src/modules/module-loopback.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-metadata.c -> pipewire-1.0.0.tar.gz/src/modules/module-metadata.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-netjack2-driver.c -> pipewire-1.0.0.tar.gz/src/modules/module-netjack2-driver.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-netjack2-manager.c -> pipewire-1.0.0.tar.gz/src/modules/module-netjack2-manager.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-pipe-tunnel.c -> pipewire-1.0.0.tar.gz/src/modules/module-pipe-tunnel.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-portal.c -> pipewire-1.0.0.tar.gz/src/modules/module-portal.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-profiler.c -> pipewire-1.0.0.tar.gz/src/modules/module-profiler.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-protocol-native.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-native.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse.c Changed

@@ -18,7 +18,7 @@
 
 #include "module-protocol-pulse/pulse-server.h"
 
-/** \page page_module_protocol_pulse PipeWire Module: Protocol Pulse
+/** \page page_module_protocol_pulse Protocol Pulse
  *
  * This module implements a complete PulseAudio server on top of
  * PipeWire.  This is only the server implementation, client are expected
@@ -33,6 +33,10 @@
  * The pulse server implements a sample cache that is otherwise not
  * available in PipeWire.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-protocol-pulse`
+ *
  * ## Module Options
  *
  * The module arguments can be the contents of the pulse.properties but
@@ -86,7 +90,7 @@
  *\endcode
  *
  * The addresses the server listens on when starting. Uncomment the `tcp:4713` entry to also
- * make the server listen on a tcp socket. This is equivalent to loading `module-native-protocol-tcp`.
+ * make the server listen on a tcp socket. This is equivalent to loading `libpipewire-module-native-protocol-tcp`.
  *
  * There is also a slightly more verbose syntax with more options:
  *

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/collect.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/collect.c Changed

@@ -65,7 +65,7 @@
 	return SPA_ID_INVALID;
 }
 
-bool collect_is_linked(struct pw_manager *m, uint32_t id, enum pw_direction direction)
+static bool collect_is_linked(struct pw_manager *m, uint32_t id, enum pw_direction direction)
 {
 	struct pw_manager_object *o;
 	uint32_t in_node, out_node;
@@ -291,7 +291,7 @@
 }
 
 static void update_device_info(struct pw_manager *manager, struct pw_manager_object *o,
-		enum pw_direction direction, bool monitor, struct defs *defs)
+		enum pw_direction direction, bool monitor, struct defs *defs, bool stream)
 {
 	const char *str;
 	const char *key = monitor ? "device.info.monitor" : "device.info";
@@ -313,6 +313,12 @@
 	}
 	collect_device_info(o, card, &di, monitor, defs);
 
+	di.state = node_state(info->state);
+	/* running sink/source that is not linked is reported as idle */
+	if (!stream && di.state == STATE_RUNNING &&
+	    !collect_is_linked(manager, o->id, pw_direction_reverse(direction)))
+		di.state = STATE_IDLE;
+
 	dev_info = pw_manager_object_get_data(o, key);
 	if (dev_info) {
 		if (memcmp(dev_info, &di, sizeof(di)) != 0) {
@@ -586,16 +592,16 @@
 		struct defs *defs)
 {
 	if (pw_manager_object_is_sink(o)) {
-		update_device_info(manager, o, PW_DIRECTION_OUTPUT, false, defs);
-		update_device_info(manager, o, PW_DIRECTION_OUTPUT, true, defs);
+		update_device_info(manager, o, PW_DIRECTION_OUTPUT, false, defs, false);
+		update_device_info(manager, o, PW_DIRECTION_OUTPUT, true, defs, false);
 	}
 	if (pw_manager_object_is_source(o)) {
-		update_device_info(manager, o, PW_DIRECTION_INPUT, false, defs);
+		update_device_info(manager, o, PW_DIRECTION_INPUT, false, defs, false);
 	}
 	if (pw_manager_object_is_source_output(o)) {
-		update_device_info(manager, o, PW_DIRECTION_INPUT, false, defs);
+		update_device_info(manager, o, PW_DIRECTION_INPUT, false, defs, true);
 	}
 	if (pw_manager_object_is_sink_input(o)) {
-		update_device_info(manager, o, PW_DIRECTION_OUTPUT, false, defs);
+		update_device_info(manager, o, PW_DIRECTION_OUTPUT, false, defs, true);
 	}
 }

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/collect.h -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/collect.h Changed

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-alsa-sink.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-alsa-sink.c Changed

@@ -7,6 +7,43 @@
 #include "../manager.h"
 #include "../module.h"
 
+/** \page page_pulse_module_alsa_sink ALSA Sink
+ *
+ * ## Module Name
+ *
+ * `module-alsa-sink`
+ *
+ * ## Module Options
+ *
+ * @pulse_module_options@
+ */
+
+static const char *const pulse_module_options =
+	"name=<name of the sink, to be prefixed> "
+	"sink_name=<name for the sink> "
+	"sink_properties=<properties for the sink> "
+	"namereg_fail=<when false attempt to synthesise new sink_name if it is already taken> "
+	"device=<ALSA device> "
+	"device_id=<ALSA card index> "
+	"format=<sample format> "
+	"rate=<sample rate> "
+	"alternate_rate=<alternate sample rate> "
+	"channels=<number of channels> "
+	"channel_map=<channel map> "
+	"fragments=<number of fragments> "
+	"fragment_size=<fragment size> "
+	"mmap=<enable memory mapping?> "
+	"tsched=<enable system timer based scheduling mode?> "
+	"tsched_buffer_size=<buffer size when using timer based scheduling> "
+	"tsched_buffer_watermark=<lower fill watermark> "
+	"ignore_dB=<ignore dB information from the device?> "
+	"control=<name of mixer control, or name and index separated by a comma> "
+	"rewind_safeguard=<number of bytes that cannot be rewound> " 
+	"deferred_volume=<Synchronize software and hardware volume changes to avoid momentary jumps?> "
+	"deferred_volume_safety_margin=<usec adjustment depending on volume direction> "
+	"deferred_volume_extra_delay=<usec adjustment to HW volume changes> "
+	"fixed_latency_range=<disable latency range changes on underrun?> ";
+
 #define NAME "alsa-sink"
 
 #define DEFAULT_DEVICE "default"
@@ -131,31 +168,7 @@
 static const struct spa_dict_item module_alsa_sink_info = {
 	{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },
 	{ PW_KEY_MODULE_DESCRIPTION, "An ALSA sink" },
-	{ PW_KEY_MODULE_USAGE,
-		"name=<name of the sink, to be prefixed> "
-		"sink_name=<name for the sink> "
-		"sink_properties=<properties for the sink> "
-		"namereg_fail=<when false attempt to synthesise new sink_name if it is already taken> "
-		"device=<ALSA device> "
-		"device_id=<ALSA card index> "
-		"format=<sample format> "
-		"rate=<sample rate> "
-		"alternate_rate=<alternate sample rate> "
-		"channels=<number of channels> "
-		"channel_map=<channel map> "
-		"fragments=<number of fragments> "
-		"fragment_size=<fragment size> "
-		"mmap=<enable memory mapping?> "
-		"tsched=<enable system timer based scheduling mode?> "
-		"tsched_buffer_size=<buffer size when using timer based scheduling> "
-		"tsched_buffer_watermark=<lower fill watermark> "
-		"ignore_dB=<ignore dB information from the device?> "
-		"control=<name of mixer control, or name and index separated by a comma> "
-		"rewind_safeguard=<number of bytes that cannot be rewound> "
-		"deferred_volume=<Synchronize software and hardware volume changes to avoid momentary jumps?> "
-		"deferred_volume_safety_margin=<usec adjustment depending on volume direction> "
-		"deferred_volume_extra_delay=<usec adjustment to HW volume changes> "
-		"fixed_latency_range=<disable latency range changes on underrun?>" },
+	{ PW_KEY_MODULE_USAGE, pulse_module_options },
 	{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
 };

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-alsa-source.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-alsa-source.c Changed

@@ -7,6 +7,43 @@
 #include "../manager.h"
 #include "../module.h"
 
+/** \page page_pulse_module_alsa_source ALSA Source
+ *
+ * ## Module Name
+ *
+ * `module-alsa-source`
+ *
+ * ## Module Options
+ *
+ * @pulse_module_options@
+ */
+
+static const char *const pulse_module_options =
+		"name=<name of the source, to be prefixed> "
+		"source_name=<name for the source> "
+		"source_properties=<properties for the source> "
+		"namereg_fail=<when false attempt to synthesise new source_name if it is already taken> "
+		"device=<ALSA device> "
+		"device_id=<ALSA card index> "
+		"format=<sample format> "
+		"rate=<sample rate> "
+		"alternate_rate=<alternate sample rate> "
+		"channels=<number of channels> "
+		"channel_map=<channel map> "
+		"fragments=<number of fragments> "
+		"fragment_size=<fragment size> "
+		"mmap=<enable memory mapping?> "
+		"tsched=<enable system timer based scheduling mode?> "
+		"tsched_buffer_size=<buffer size when using timer based scheduling> "
+		"tsched_buffer_watermark=<lower fill watermark> "
+		"ignore_dB=<ignore dB information from the device?> "
+		"control=<name of mixer control, or name and index separated by a comma> "
+		"rewind_safeguard=<number of bytes that cannot be rewound> "
+		"deferred_volume=<Synchronize software and hardware volume changes to avoid momentary jumps?> "
+		"deferred_volume_safety_margin=<usec adjustment depending on volume direction> "
+		"deferred_volume_extra_delay=<usec adjustment to HW volume changes> "
+		"fixed_latency_range=<disable latency range changes on underrun?>";
+
 #define NAME "alsa-source"
 
 #define DEFAULT_DEVICE "default"
@@ -131,31 +168,7 @@
 static const struct spa_dict_item module_alsa_source_info = {
 	{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },
 	{ PW_KEY_MODULE_DESCRIPTION, "An ALSA source" },
-	{ PW_KEY_MODULE_USAGE,
-		"name=<name of the source, to be prefixed> "
-		"source_name=<name for the source> "
-		"source_properties=<properties for the source> "
-		"namereg_fail=<when false attempt to synthesise new source_name if it is already taken> "
-		"device=<ALSA device> "
-		"device_id=<ALSA card index> "
-		"format=<sample format> "
-		"rate=<sample rate> "
-		"alternate_rate=<alternate sample rate> "
-		"channels=<number of channels> "
-		"channel_map=<channel map> "
-		"fragments=<number of fragments> "
-		"fragment_size=<fragment size> "
-		"mmap=<enable memory mapping?> "
-		"tsched=<enable system timer based scheduling mode?> "
-		"tsched_buffer_size=<buffer size when using timer based scheduling> "
-		"tsched_buffer_watermark=<lower fill watermark> "
-		"ignore_dB=<ignore dB information from the device?> "
-		"control=<name of mixer control, or name and index separated by a comma> "
-		"rewind_safeguard=<number of bytes that cannot be rewound> "
-		"deferred_volume=<Synchronize software and hardware volume changes to avoid momentary jumps?> "
-		"deferred_volume_safety_margin=<usec adjustment depending on volume direction> "
-		"deferred_volume_extra_delay=<usec adjustment to HW volume changes> "
-		"fixed_latency_range=<disable latency range changes on underrun?>" },
+	{ PW_KEY_MODULE_USAGE, pulse_module_options },
 	{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
 };

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-always-sink.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-always-sink.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-combine-sink.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-combine-sink.c Changed

@@ -12,6 +12,31 @@
 #include "../manager.h"
 #include "../module.h"
 
+/** \page page_pulse_module_combine_sink Combine Sink
+ *
+ * ## Module Name
+ *
+ * `module-combine-sink`
+ *
+ * ## Module Options
+ *
+ * @pulse_module_options@
+ *
+ * ## See Also
+ *
+ * \ref page_module_combine_stream "libpipewire-module-combine-stream"
+ */
+
+static const char *const pulse_module_options =
+	"sink_name=<name of the sink> "
+	"sink_properties=<properties for the sink> "
+	"sinks=<sinks to combine> "
+	"rate=<sample rate> "
+	"channels=<number of channels> "
+	"channel_map=<channel map> "
+	"remix=<remix channels> "
+	"latency_compensate=<bool> ";
+
 #define NAME "combine-sink"
 
 PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
@@ -24,15 +49,7 @@
 static const struct spa_dict_item module_combine_sink_info = {
 	{ PW_KEY_MODULE_AUTHOR, "Arun Raghavan <arun@asymptotic.io>" },
 	{ PW_KEY_MODULE_DESCRIPTION, "Combine multiple sinks into a single sink" },
-	{ PW_KEY_MODULE_USAGE, "sink_name=<name of the sink> "
-				"sink_properties=<properties for the sink> "
-				/* not a great name, but for backwards compatibility... */
-				"slaves=<sinks to combine> "
-				"rate=<sample rate> "
-				"channels=<number of channels> "
-				"channel_map=<channel map> "
-				"remix=<remix channels> "
-				"latency_compensate=<bool> " },
+	{ PW_KEY_MODULE_USAGE, pulse_module_options },
 	{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
 };
 
@@ -268,8 +285,10 @@
 	if ((str = pw_properties_get(props, "sink_properties")) != NULL)
 		module_args_add_props(combine_props, str);
 
-	if ((str = pw_properties_get(props, "slaves")) != NULL) {
+	if ((str = pw_properties_get(props, "sinks")) != NULL ||
+			(str = pw_properties_get(props, "slaves")) != NULL) {
 		sink_names = pw_split_strv(str, ",", MAX_SINKS, &num_sinks);
+		pw_properties_set(props, "sinks", NULL);
 		pw_properties_set(props, "slaves", NULL);
 	}
 	if ((str = pw_properties_get(props, "remix")) != NULL) {

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-echo-cancel.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-echo-cancel.c Changed

@@ -11,6 +11,45 @@
 #include "../defs.h"
 #include "../module.h"
 
+/** \page page_pulse_module_echo_cancel Echo Cancel
+ *
+ * ## Module Name
+ *
+ * `module-echo-cancel`
+ *
+ * ## Module Options
+ *
+ * @pulse_module_options@
+ *
+ * ## See Also
+ *
+ * \ref page_module_echo_cancel "libpipewire-module-echo-cancel"
+ */
+
+static const char *const pulse_module_options =
+	"source_name=<name for the source> "
+	"source_properties=<properties for the source> "
+	"source_master=<name of source to filter> "
+	"sink_name=<name for the sink> "
+	"sink_properties=<properties for the sink> "
+	"sink_master=<name of sink to filter> "
+	"rate=<sample rate> "
+	"channels=<number of channels> "
+	"channel_map=<channel map> "
+	"aec_method=<implementation to use> "
+	"aec_args=<parameters for the AEC engine> ";
+#if 0
+	/* These are not implemented because they don't
+	 * really make sense in the PipeWire context */
+	"format=<sample format> "
+	"adjust_time=<how often to readjust rates in s> "
+	"adjust_threshold=<how much drift to readjust after in ms> "
+	"autoloaded=<set if this module is being loaded automatically> "
+	"save_aec=<save AEC data in /tmp> "
+	"use_volume_sharing=<yes or no> "
+	"use_master_format=<yes or no> "
+#endif
+
 #define NAME "echo-cancel"
 
 PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
@@ -114,29 +153,7 @@
 static const struct spa_dict_item module_echo_cancel_info = {
 	{ PW_KEY_MODULE_AUTHOR, "Arun Raghavan <arun@asymptotic.io>" },
 	{ PW_KEY_MODULE_DESCRIPTION, "Acoustic echo canceller" },
-	{ PW_KEY_MODULE_USAGE, "source_name=<name for the source> "
-				"source_properties=<properties for the source> "
-				"source_master=<name of source to filter> "
-				"sink_name=<name for the sink> "
-				"sink_properties=<properties for the sink> "
-				"sink_master=<name of sink to filter> "
-				"rate=<sample rate> "
-				"channels=<number of channels> "
-				"channel_map=<channel map> "
-				"aec_method=<implementation to use> "
-				"aec_args=<parameters for the AEC engine> "
-#if 0
-				/* These are not implemented because they don't
-				 * really make sense in the PipeWire context */
-				"format=<sample format> "
-				"adjust_time=<how often to readjust rates in s> "
-				"adjust_threshold=<how much drift to readjust after in ms> "
-				"autoloaded=<set if this module is being loaded automatically> "
-				"save_aec=<save AEC data in /tmp> "
-				"use_volume_sharing=<yes or no> "
-				"use_master_format=<yes or no> "
-#endif
-	},
+	{ PW_KEY_MODULE_USAGE, pulse_module_options },
 	{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
 };

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-gsettings.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-gsettings.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-jackdbus-detect.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-jackdbus-detect.c Changed

@@ -8,6 +8,35 @@
 #include "../defs.h"
 #include "../module.h"
 
+/** \page page_pulse_module_jackdbus_detect JackDBus Detect
+ *
+ * ## Module Name
+ *
+ * `module-jackdbus-detect`
+ *
+ * ## Module Options
+ *
+ * @pulse_module_options@
+ *
+ * ## See Also
+ *
+ * \ref page_module_jackdbus_detect "libpipewire-module-jackdbus-detect"
+ */
+
+static const char *const pulse_module_options =
+	"channels=<number of channels> "
+	"sink_name=<name for the sink> "
+	"sink_properties=<properties for the sink> "
+	"sink_client_name=<jack client name> "
+	"sink_channels=<number of channels> "
+	"sink_channel_map=<channel map> "
+	"source_name=<name for the source> "
+	"source_properties=<properties for the source> "
+	"source_client_name=<jack client name> "
+	"source_channels=<number of channels> "
+	"source_channel_map=<channel map> "
+	"connect=<connect ports?>";
+
 #define NAME "jackdbus-detect"
 
 PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
@@ -93,19 +122,7 @@
 static const struct spa_dict_item module_jackdbus_detect_info = {
 	{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.con>" },
 	{ PW_KEY_MODULE_DESCRIPTION, "Creates a JACK client when jackdbus is started" },
-	{ PW_KEY_MODULE_USAGE,
-		"channels=<number of channels> "
-		"sink_name=<name for the sink> "
-		"sink_properties=<properties for the sink> "
-		"sink_client_name=<jack client name> "
-		"sink_channels=<number of channels> "
-		"sink_channel_map=<channel map> "
-		"source_name=<name for the source> "
-		"source_properties=<properties for the source> "
-		"source_client_name=<jack client name> "
-		"source_channels=<number of channels> "
-		"source_channel_map=<channel map> "
-		"connect=<connect ports?>" },
+	{ PW_KEY_MODULE_USAGE, pulse_module_options },
 	{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
 };

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-ladspa-sink.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-ladspa-sink.c Changed

@@ -11,6 +11,37 @@
 #include "../defs.h"
 #include "../module.h"
 
+/** \page page_pulse_module_ladspa_sink LADSPA Sink
+ *
+ * ## Module Name
+ *
+ * `module-ladspa-sink`
+ *
+ * ## Module Options
+ *
+ * @pulse_module_options@
+ *
+ * ## See Also
+ *
+ * \ref page_module_filter_chain "libpipewire-module-filter-chain"
+ */
+
+static const char *const pulse_module_options =
+	"sink_name=<name for the sink> "
+	"sink_properties=<properties for the sink> "
+	"sink_input_properties=<properties for the sink input> "
+	"master=<name of sink to filter> "
+	"sink_master=<name of sink to filter> "
+	"format=<sample format> "
+	"rate=<sample rate> "
+	"channels=<number of channels> "
+	"channel_map=<input channel map> "
+	"plugin=<ladspa plugin name> "
+	"label=<ladspa plugin label> "
+	"control=<comma separated list of input control values> "
+	"input_ladspaport_map=<comma separated list of input LADSPA port names> "
+	"output_ladspaport_map=<comma separated list of output LADSPA port names> ";
+
 #define NAME "ladspa-sink"
 
 PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
@@ -126,21 +157,7 @@
 static const struct spa_dict_item module_ladspa_sink_info = {
 	{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },
 	{ PW_KEY_MODULE_DESCRIPTION, "Virtual LADSPA sink" },
-	{ PW_KEY_MODULE_USAGE,
-		"sink_name=<name for the sink> "
-		"sink_properties=<properties for the sink> "
-		"sink_input_properties=<properties for the sink input> "
-		"master=<name of sink to filter> "
-		"sink_master=<name of sink to filter> "
-		"format=<sample format> "
-		"rate=<sample rate> "
-		"channels=<number of channels> "
-		"channel_map=<input channel map> "
-		"plugin=<ladspa plugin name> "
-		"label=<ladspa plugin label> "
-		"control=<comma separated list of input control values> "
-		"input_ladspaport_map=<comma separated list of input LADSPA port names> "
-		"output_ladspaport_map=<comma separated list of output LADSPA port names> "},
+	{ PW_KEY_MODULE_USAGE, pulse_module_options },
 	{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
 };

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-ladspa-source.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-ladspa-source.c Changed

@@ -11,6 +11,37 @@
 #include "../defs.h"
 #include "../module.h"
 
+/** \page page_pulse_module_ladspa_source LADSPA Source
+ *
+ * ## Module Name
+ *
+ * `module-ladspa-source`
+ *
+ * ## Module Options
+ *
+ * @pulse_module_options@
+ *
+ * ## See Also
+ *
+ * \ref page_module_filter_chain "libpipewire-module-filter-chain"
+ */
+
+static const char *const pulse_module_options =
+	"source_name=<name for the source> "
+	"source_properties=<properties for the source> "
+	"source_output_properties=<properties for the source output> "
+	"master=<name of source to filter> "
+	"source_master=<name of source to filter> "
+	"format=<sample format> "
+	"rate=<sample rate> "
+	"channels=<number of channels> "
+	"channel_map=<input channel map> "
+	"plugin=<ladspa plugin name> "
+	"label=<ladspa plugin label> "
+	"control=<comma separated list of input control values> "
+	"input_ladspaport_map=<comma separated list of input LADSPA port names> "
+	"output_ladspaport_map=<comma separated list of output LADSPA port names> ";
+
 #define NAME "ladspa-source"
 
 PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
@@ -126,21 +157,7 @@
 static const struct spa_dict_item module_ladspa_source_info = {
 	{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },
 	{ PW_KEY_MODULE_DESCRIPTION, "Virtual LADSPA source" },
-	{ PW_KEY_MODULE_USAGE,
-		"source_name=<name for the source> "
-		"source_properties=<properties for the source> "
-		"source_output_properties=<properties for the source output> "
-		"master=<name of source to filter> "
-		"source_master=<name of source to filter> "
-		"format=<sample format> "
-		"rate=<sample rate> "
-		"channels=<number of channels> "
-		"channel_map=<input channel map> "
-		"plugin=<ladspa plugin name> "
-		"label=<ladspa plugin label> "
-		"control=<comma separated list of input control values> "
-		"input_ladspaport_map=<comma separated list of input LADSPA port names> "
-		"output_ladspaport_map=<comma separated list of output LADSPA port names> "},
+	{ PW_KEY_MODULE_USAGE, pulse_module_options },
 	{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
 };

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-loopback.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-loopback.c Changed

@@ -11,6 +11,34 @@
 #include "../defs.h"
 #include "../module.h"
 
+/** \page page_pulse_module_loopback Loopback
+ *
+ * ## Module Name
+ *
+ * `module-loopback`
+ *
+ * ## Module Options
+ *
+ * @pulse_module_options@
+ *
+ * ## See Also
+ *
+ * \ref page_module_loopback "libpipewire-module-loopback"
+ */
+
+static const char *const pulse_module_options =
+	"source=<source to connect to> "
+	"sink=<sink to connect to> "
+	"latency_msec=<latency in ms> "
+	"rate=<sample rate> "
+	"channels=<number of channels> "
+	"channel_map=<channel map> "
+	"sink_input_properties=<proplist> "
+	"source_output_properties=<proplist> "
+	"source_dont_move=<boolean> "
+	"sink_dont_move=<boolean> "
+	"remix=<remix channels?> ";
+
 #define NAME "loopback"
 
 PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
@@ -99,17 +127,7 @@
 static const struct spa_dict_item module_loopback_info = {
 	{ PW_KEY_MODULE_AUTHOR, "Arun Raghavan <arun@asymptotic.io>" },
 	{ PW_KEY_MODULE_DESCRIPTION, "Loopback from source to sink" },
-	{ PW_KEY_MODULE_USAGE, "source=<source to connect to> "
-				"sink=<sink to connect to> "
-				"latency_msec=<latency in ms> "
-				"rate=<sample rate> "
-				"channels=<number of channels> "
-				"channel_map=<channel map> "
-				"sink_input_properties=<proplist> "
-				"source_output_properties=<proplist> "
-				"source_dont_move=<boolean> "
-				"sink_dont_move=<boolean> "
-				"remix=<remix channels?> " },
+	{ PW_KEY_MODULE_USAGE, pulse_module_options },
 	{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
 };

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-native-protocol-tcp.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-native-protocol-tcp.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-null-sink.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-null-sink.c Changed

@@ -7,6 +7,25 @@
 #include "../manager.h"
 #include "../module.h"
 
+/** \page page_pulse_module_null_sink Null Sink
+ *
+ * ## Module Name
+ *
+ * `module-null-sink`
+ *
+ * ## Module Options
+ *
+ * @pulse_module_options@
+ */
+
+static const char *const pulse_module_options =
+	"sink_name=<name of sink> "
+	"sink_properties=<properties for the sink> "
+	"format=<sample format> "
+	"rate=<sample rate> "
+	"channels=<number of channels> "
+	"channel_map=<channel map>";
+
 #define NAME "null-sink"
 
 PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
@@ -129,12 +148,7 @@
 static const struct spa_dict_item module_null_sink_info = {
 	{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },
 	{ PW_KEY_MODULE_DESCRIPTION, "A NULL sink" },
-	{ PW_KEY_MODULE_USAGE,  "sink_name=<name of sink> "
-				"sink_properties=<properties for the sink> "
-				"format=<sample format> "
-				"rate=<sample rate> "
-				"channels=<number of channels> "
-				"channel_map=<channel map>" },
+	{ PW_KEY_MODULE_USAGE, pulse_module_options },
 	{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
 };

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-pipe-sink.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-pipe-sink.c Changed

@@ -14,6 +14,31 @@
 #include "../defs.h"
 #include "../module.h"
 
+/** \page page_pulse_module_pipe_sink Pipe Sink
+ *
+ * ## Module Name
+ *
+ * `module-pipe-sink`
+ *
+ * ## Module Options
+ *
+ * @pulse_module_options@
+ *
+ * ## See Also
+ *
+ * \ref page_module_pipe_tunnel "libpipewire-module-pipe-tunnel"
+ */
+
+static const char *const pulse_module_options =
+	"file=<name of the FIFO special file to use> "
+	"sink_name=<name for the sink> "
+	"sink_properties=<sink properties> "
+	"format=<sample format> "
+	"rate=<sample rate> "
+	"channels=<number of channels> "
+	"channel_map=<channel map> "
+	"use_system_clock_for_timing=<yes or no> ";
+
 #define NAME "pipe-sink"
 
 PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
@@ -94,14 +119,7 @@
 static const struct spa_dict_item module_pipe_sink_info = {
 	{ PW_KEY_MODULE_AUTHOR, "Sanchayan Maity <sanchayan@asymptotic.io>" },
 	{ PW_KEY_MODULE_DESCRIPTION, "Pipe sink" },
-	{ PW_KEY_MODULE_USAGE, "file=<name of the FIFO special file to use> "
-				"sink_name=<name for the sink> "
-				"sink_properties=<sink properties> "
-				"format=<sample format> "
-				"rate=<sample rate> "
-				"channels=<number of channels> "
-				"channel_map=<channel map> "
-				"use_system_clock_for_timing=<yes or no> " },
+	{ PW_KEY_MODULE_USAGE, pulse_module_options },
 	{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
 };

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-pipe-source.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-pipe-source.c Changed

@@ -14,6 +14,30 @@
 #include "../defs.h"
 #include "../module.h"
 
+/** \page page_pulse_module_pipe_source Pipe Source
+ *
+ * ## Module Name
+ *
+ * `module-pipe-source`
+ *
+ * ## Module Options
+ *
+ * @pulse_module_options@
+ *
+ * ## See Also
+ *
+ * \ref page_module_pipe_tunnel "libpipewire-module-pipe-tunnel"
+ */
+
+static const char *const pulse_module_options =
+	"file=<name of the FIFO special file to use> "
+	"source_name=<name for the source> "
+	"source_properties=<source properties> "
+	"format=<sample format> "
+	"rate=<sample rate> "
+	"channels=<number of channels> "
+	"channel_map=<channel map> ";
+
 #define NAME "pipe-source"
 
 PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
@@ -94,13 +118,7 @@
 static const struct spa_dict_item module_pipe_source_info = {
 	{ PW_KEY_MODULE_AUTHOR, "Sanchayan Maity <sanchayan@asymptotic.io>" },
 	{ PW_KEY_MODULE_DESCRIPTION, "Pipe source" },
-	{ PW_KEY_MODULE_USAGE, "file=<name of the FIFO special file to use> "
-				"source_name=<name for the source> "
-				"source_properties=<source properties> "
-				"format=<sample format> "
-				"rate=<sample rate> "
-				"channels=<number of channels> "
-				"channel_map=<channel map> " },
+	{ PW_KEY_MODULE_USAGE, pulse_module_options },
 	{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
 };

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-raop-discover.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-raop-discover.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-remap-sink.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-remap-sink.c Changed

@@ -10,6 +10,33 @@
 #include "../defs.h"
 #include "../module.h"
 
+/** \page page_pulse_module_remap_sink Remap Sink
+ *
+ * ## Module Name
+ *
+ * `module-remap-sink`
+ *
+ * ## Module Options
+ *
+ * @pulse_module_options@
+ *
+ * ## See Also
+ *
+ * \ref page_module_loopback "libpipewire-module-loopback"
+ */
+
+static const char *const pulse_module_options =
+	"sink_name=<name for the sink> "
+	"sink_properties=<properties for the sink> "
+	"master=<name of sink to remap> "
+	"master_channel_map=<channel map> "
+	"format=<sample format> "
+	"rate=<sample rate> "
+	"channels=<number of channels> "
+	"channel_map=<channel map> "
+	"resample_method=<resampler> "
+	"remix=<remix channels?>";
+
 #define NAME "remap-sink"
 
 PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
@@ -96,16 +123,7 @@
 static const struct spa_dict_item module_remap_sink_info = {
 	{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },
 	{ PW_KEY_MODULE_DESCRIPTION, "Remap sink channels" },
-	{ PW_KEY_MODULE_USAGE, "sink_name=<name for the sink> "
-			"sink_properties=<properties for the sink> "
-			"master=<name of sink to remap> "
-			"master_channel_map=<channel map> "
-			"format=<sample format> "
-			"rate=<sample rate> "
-			"channels=<number of channels> "
-			"channel_map=<channel map> "
-			"resample_method=<resampler> "
-			"remix=<remix channels?>" },
+	{ PW_KEY_MODULE_USAGE, pulse_module_options },
 	{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
 };

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-remap-source.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-remap-source.c Changed

@@ -10,6 +10,33 @@
 #include "../defs.h"
 #include "../module.h"
 
+/** \page page_pulse_module_remap_source Remap Source
+ *
+ * ## Module Name
+ *
+ * `module-remap-source`
+ *
+ * ## Module Options
+ *
+ * @pulse_module_options@
+ *
+ * ## See Also
+ *
+ * \ref page_module_loopback "libpipewire-module-loopback"
+ */
+
+static const char *const pulse_module_options =
+	"source_name=<name for the source> "
+	"source_properties=<properties for the source> "
+	"master=<name of source to filter> "
+	"master_channel_map=<channel map> "
+	"format=<sample format> "
+	"rate=<sample rate> "
+	"channels=<number of channels> "
+	"channel_map=<channel map> "
+	"resample_method=<resampler> "
+	"remix=<remix channels?>";
+
 #define NAME "remap-sink"
 
 PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
@@ -96,16 +123,7 @@
 static const struct spa_dict_item module_remap_source_info = {
 	{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },
 	{ PW_KEY_MODULE_DESCRIPTION, "Remap source channels" },
-	{ PW_KEY_MODULE_USAGE, "source_name=<name for the source> "
-			"source_properties=<properties for the source> "
-			"master=<name of source to filter> "
-			"master_channel_map=<channel map> "
-			"format=<sample format> "
-			"rate=<sample rate> "
-			"channels=<number of channels> "
-			"channel_map=<channel map> "
-			"resample_method=<resampler> "
-			"remix=<remix channels?>" },
+	{ PW_KEY_MODULE_USAGE, pulse_module_options },
 	{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
 };

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-roc-sink-input.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-roc-sink-input.c Changed

@@ -9,7 +9,34 @@
 #include "../defs.h"
 #include "../module.h"
 
-#define NAME "roc-source"
+/** \page page_pulse_module_roc_sink_input ROC Sink Input
+ *
+ * ## Module Name
+ *
+ * `module-roc-sink-input`
+ *
+ * ## Module Options
+ *
+ * @pulse_module_options@
+ *
+ * ## See Also
+ *
+ * \ref page_module_roc_source "libpipewire-module-roc-source"
+ */
+
+static const char *const pulse_module_options =
+	"sink=<name for the sink> "
+	"sink_input_properties=<properties for the sink_input> "
+	"resampler_profile=<empty>|high|medium|low "
+	"fec_code=<empty>|disable|rs8m|ldpc "
+	"sess_latency_msec=<target network latency in milliseconds> "
+	"local_ip=<local receiver ip> "
+	"local_source_port=<local receiver port for source packets> "
+	"local_repair_port=<local receiver port for repair packets> "
+	"local_control_port=<local receiver port for control packets> "
+	;
+
+#define NAME "roc-sink-input"
 
 PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
 #define PW_LOG_TOPIC_DEFAULT mod_topic
@@ -92,14 +119,7 @@
 static const struct spa_dict_item module_roc_sink_input_info = {
 	{ PW_KEY_MODULE_AUTHOR, "Sanchayan Maity <sanchayan@asymptotic.io>" },
 	{ PW_KEY_MODULE_DESCRIPTION, "roc sink-input" },
-	{ PW_KEY_MODULE_USAGE, "sink=<name for the sink> "
-				"sink_input_properties=<properties for the sink_input> "
-				"resampler_profile=<empty>|disable|high|medium|low "
-				"fec_code=<empty>|disable|rs8m|ldpc "
-				"sess_latency_msec=<target network latency in milliseconds> "
-				"local_ip=<local receiver ip> "
-				"local_source_port=<local receiver port for source packets> "
-				"local_repair_port=<local receiver port for repair packets> " },
+	{ PW_KEY_MODULE_USAGE, pulse_module_options },
 	{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
 };
 
@@ -144,6 +164,11 @@
 		pw_properties_set(props, "local_repair_port", NULL);
 	}
 
+	if ((str = pw_properties_get(props, "local_control_port")) != NULL) {
+		pw_properties_set(roc_props, "local.control.port", str);
+		pw_properties_set(props, "local_control_port", NULL);
+	}
+
 	if ((str = pw_properties_get(props, "sess_latency_msec")) != NULL) {
 		pw_properties_set(roc_props, "sess.latency.msec", str);
 		pw_properties_set(props, "sess_latency_msec", NULL);

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-roc-sink.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-roc-sink.c Changed

@@ -9,6 +9,31 @@
 #include "../defs.h"
 #include "../module.h"
 
+/** \page page_pulse_module_roc_sink ROC Sink
+ *
+ * ## Module Name
+ *
+ * `module-roc-sink`
+ *
+ * ## Module Options
+ *
+ * @pulse_module_options@
+ *
+ * ## See Also
+ *
+ * \ref page_module_roc_sink "libpipewire-module-roc-sink"
+ */
+
+static const char *const pulse_module_options =
+	"sink_name=<name for the sink> "
+	"sink_properties=<properties for the sink> "
+	"fec_code=<empty>|disable|rs8m|ldpc "
+	"remote_ip=<remote receiver ip> "
+	"remote_source_port=<remote receiver port for source packets> "
+	"remote_repair_port=<remote receiver port for repair packets> "
+	"remote_control_port=<remote receiver port for control packets> "
+	;
+
 #define NAME "roc-sink"
 
 PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
@@ -96,17 +121,13 @@
 	"remote_ip",
 	"remote_source_port",
 	"remote_repair_port",
+	"remote_control_port",
 	NULL
 };
 static const struct spa_dict_item module_roc_sink_info = {
 	{ PW_KEY_MODULE_AUTHOR, "Sanchayan Maity <sanchayan@asymptotic.io>" },
 	{ PW_KEY_MODULE_DESCRIPTION, "roc sink" },
-	{ PW_KEY_MODULE_USAGE, "sink_name=<name for the sink> "
-				"sink_properties=<properties for the sink> "
-				"fec_code=<empty>|disable|rs8m|ldpc "
-				"remote_ip=<remote receiver ip> "
-				"remote_source_port=<remote receiver port for source packets> "
-				"remote_repair_port=<remote receiver port for repair packets> " },
+	{ PW_KEY_MODULE_USAGE, pulse_module_options },
 	{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
 };
 
@@ -159,6 +180,12 @@
 		pw_properties_set(roc_props, "remote.repair.port", str);
 		pw_properties_set(props, "remote_repair_port", NULL);
 	}
+
+	if ((str = pw_properties_get(props, "remote_control_port")) != NULL) {
+		pw_properties_set(roc_props, "remote.control.port", str);
+		pw_properties_set(props, "remote_control_port", NULL);
+	}
+
 	if ((str = pw_properties_get(props, "fec_code")) != NULL) {
 		pw_properties_set(roc_props, "fec.code", str);
 		pw_properties_set(props, "fec_code", NULL);

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-roc-source.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-roc-source.c Changed

@@ -9,6 +9,33 @@
 #include "../defs.h"
 #include "../module.h"
 
+/** \page page_pulse_module_roc_source ROC Source
+ *
+ * ## Module Name
+ *
+ * `module-roc-source`
+ *
+ * ## Module Options
+ *
+ * @pulse_module_options@
+ *
+ * ## See Also
+ *
+ * \ref page_module_roc_source "libpipewire-module-roc-source"
+ */
+
+static const char *const pulse_module_options =
+	"source_name=<name for the source> "
+	"source_properties=<properties for the source> "
+	"resampler_profile=<empty>|high|medium|low "
+	"fec_code=<empty>|disable|rs8m|ldpc "
+	"sess_latency_msec=<target network latency in milliseconds> "
+	"local_ip=<local receiver ip> "
+	"local_source_port=<local receiver port for source packets> "
+	"local_repair_port=<local receiver port for repair packets> "
+	"local_control_port=<local receiver port for control packets> "
+	;
+
 #define NAME "roc-source"
 
 PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
@@ -98,20 +125,14 @@
 	"local_ip",
 	"local_source_port",
 	"local_repair_port",
+	"local_control_port",
 	NULL
 };
 
 static const struct spa_dict_item module_roc_source_info = {
 	{ PW_KEY_MODULE_AUTHOR, "Sanchayan Maity <sanchayan@asymptotic.io>" },
 	{ PW_KEY_MODULE_DESCRIPTION, "roc source" },
-	{ PW_KEY_MODULE_USAGE, "source_name=<name for the source> "
-				"source_properties=<properties for the source> "
-				"resampler_profile=<empty>|disable|high|medium|low "
-				"fec_code=<empty>|disable|rs8m|ldpc "
-				"sess_latency_msec=<target network latency in milliseconds> "
-				"local_ip=<local receiver ip> "
-				"local_source_port=<local receiver port for source packets> "
-				"local_repair_port=<local receiver port for repair packets> " },
+	{ PW_KEY_MODULE_USAGE, pulse_module_options },
 	{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
 };
 
@@ -161,6 +182,11 @@
 		pw_properties_set(props, "local_repair_port", NULL);
 	}
 
+	if ((str = pw_properties_get(props, "local_control_port")) != NULL) {
+		pw_properties_set(roc_props, "local.control.port", str);
+		pw_properties_set(props, "local_control_port", NULL);
+	}
+
 	if ((str = pw_properties_get(props, "sess_latency_msec")) != NULL) {
 		pw_properties_set(roc_props, "sess.latency.msec", str);
 		pw_properties_set(props, "sess_latency_msec", NULL);

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-rtp-recv.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-rtp-recv.c Changed

@@ -8,6 +8,26 @@
 #include "../defs.h"
 #include "../module.h"
 
+/** \page page_pulse_module_rtp_recv RTP Receiver
+ *
+ * ## Module Name
+ *
+ * `module-rtp-recv`
+ *
+ * ## Module Options
+ *
+ * @pulse_module_options@
+ *
+ * ## See Also
+ *
+ * \ref page_module_rtp_sap "libpipewire-module-rtp-sap"
+ */
+
+static const char *const pulse_module_options =
+	"sink=<name of the sink> "
+	"sap_address=<multicast address to listen on> "
+	"latency_msec=<latency in ms> ";
+
 #define NAME "rtp-recv"
 
 PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
@@ -94,9 +114,7 @@
 static const struct spa_dict_item module_rtp_recv_info = {
 	{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },
 	{ PW_KEY_MODULE_DESCRIPTION, "Receive data from a network via RTP/SAP/SDP" },
-	{ PW_KEY_MODULE_USAGE,	"sink=<name of the sink> "
-				"sap_address=<multicast address to listen on> "
-				"latency_msec=<latency in ms> " },
+	{ PW_KEY_MODULE_USAGE, pulse_module_options },
 	{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
 };

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-rtp-send.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-rtp-send.c Changed

@@ -8,6 +8,36 @@
 #include "../defs.h"
 #include "../module.h"
 
+/** \page page_pulse_module_rtp_send RTP Sender
+ *
+ * ## Module Name
+ *
+ * `module-rtp-send`
+ *
+ * ## Module Options
+ *
+ * @pulse_module_options@
+ *
+ * ## See Also
+ *
+ * \ref page_module_rtp_sink "libpipewire-module-rtp-sink"
+ */
+
+static const char *const pulse_module_options =
+	"source=<name of the source> "
+	"format=<sample format> "
+	"channels=<number of channels> "
+	"rate=<sample rate> "
+	"destination_ip=<destination IP address> "
+	"source_ip=<source IP address> "
+	"port=<port number> "
+	"mtu=<maximum transfer unit> "
+	"loop=<loopback to local host?> "
+	"ttl=<ttl value> "
+	"inhibit_auto_suspend=<always|never|only_with_non_monitor_sources> "
+	"stream_name=<name of the stream> "
+	"enable_opus=<enable OPUS codec>";
+
 #define NAME "rtp-send"
 
 PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
@@ -136,19 +166,7 @@
 static const struct spa_dict_item module_rtp_send_info = {
 	{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },
 	{ PW_KEY_MODULE_DESCRIPTION, "Read data from source and send it to the network via RTP/SAP/SDP" },
-	{ PW_KEY_MODULE_USAGE,	"source=<name of the source> "
-				"format=<sample format> "
-				"channels=<number of channels> "
-				"rate=<sample rate> "
-				"destination_ip=<destination IP address> "
-				"source_ip=<source IP address> "
-				"port=<port number> "
-				"mtu=<maximum transfer unit> "
-				"loop=<loopback to local host?> "
-				"ttl=<ttl value> "
-				"inhibit_auto_suspend=<always|never|only_with_non_monitor_sources> "
-				"stream_name=<name of the stream> "
-				"enable_opus=<enable OPUS codec>" },
+	{ PW_KEY_MODULE_USAGE, pulse_module_options },
 	{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
 };

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-simple-protocol-tcp.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-simple-protocol-tcp.c Changed

@@ -8,6 +8,33 @@
 #include "../defs.h"
 #include "../module.h"
 
+/** \page page_pulse_module_simple_protocol_tcp Simple TCP Protocol
+ *
+ * ## Module Name
+ *
+ * `module-simple-protocol-tcp`
+ *
+ * ## Module Options
+ *
+ * @pulse_module_options@
+ *
+ * ## See Also
+ *
+ * \ref page_module_protocol_simple "libpipewire-module-protocol-simple"
+ */
+
+static const char *const pulse_module_options =
+	"rate=<sample rate> "
+	"format=<sample format> "
+	"channels=<number of channels> "
+	"channel_map=<number of channels> "
+	"sink=<sink to connect to> "
+	"source=<source to connect to> "
+	"playback=<enable playback?> "
+	"record=<enable record?> "
+	"port=<TCP port number> "
+	"listen=<address to listen on>";
+
 #define NAME "simple-protocol-tcp"
 
 PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
@@ -84,16 +111,7 @@
 static const struct spa_dict_item module_simple_protocol_tcp_info = {
 	{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },
 	{ PW_KEY_MODULE_DESCRIPTION, "Simple protocol (TCP sockets)" },
-	{ PW_KEY_MODULE_USAGE, "rate=<sample rate> "
-				"format=<sample format> "
-				"channels=<number of channels> "
-				"channel_map=<number of channels> "
-				"sink=<sink to connect to> "
-				"source=<source to connect to> "
-				"playback=<enable playback?> "
-				"record=<enable record?> "
-				"port=<TCP port number> "
-				"listen=<address to listen on>" },
+	{ PW_KEY_MODULE_USAGE, pulse_module_options },
 	{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
 };

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-switch-on-connect.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-switch-on-connect.c Changed

@@ -15,6 +15,22 @@
 #include "../manager.h"
 #include "../collect.h"
 
+/** \page page_pulse_module_switch_on_connect Switch on Connect
+ *
+ * ## Module Name
+ *
+ * `module-switch-on-connect`
+ *
+ * ## Module Options
+ *
+ * @pulse_module_options@
+ */
+
+static const char *const pulse_module_options =
+	"only_from_unavailable=<boolean, only switch from unavailable ports (not implemented yet)> "
+	"ignore_virtual=<boolean, ignore new virtual sinks and sources, defaults to true> "
+	"blocklist=<regex, ignore matching devices, default=hdmi> ";
+
 #define NAME "switch-on-connect"
 
 PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
@@ -215,9 +231,7 @@
 	  "This module exists for Pulseaudio compatibility, and is useful only when some applications "
 	  "try to manage the default sinks/sources themselves and interfere with PipeWire's builtin "
 	  "default device switching." },
-	{ PW_KEY_MODULE_USAGE, "only_from_unavailable=<boolean, only switch from unavailable ports (not implemented yet)> "
-				"ignore_virtual=<boolean, ignore new virtual sinks and sources, defaults to true> "
-				"blocklist=<regex, ignore matching devices, default=hdmi> " },
+	{ PW_KEY_MODULE_USAGE, pulse_module_options },
 	{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
 };

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-tunnel-sink.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-tunnel-sink.c Changed

@@ -12,6 +12,33 @@
 #include "../defs.h"
 #include "../module.h"
 
+/** \page page_pulse_module_tunnel_sink Tunnel Sink
+ *
+ * ## Module Name
+ *
+ * `module-tunnel-sink`
+ *
+ * ## Module Options
+ *
+ * @pulse_module_options@
+ *
+ * ## See Also
+ *
+ * \ref page_module_pulse_tunnel "libpipewire-module-pulse-tunnel"
+ */
+
+static const char *const pulse_module_options =
+	"server=<address> "
+	"sink=<name of the remote sink> "
+	"sink_name=<name for the local sink> "
+	"sink_properties=<properties for the local sink> "
+	"format=<sample format> "
+	"channels=<number of channels> "
+	"rate=<sample rate> "
+	"channel_map=<channel map> "
+	"latency_msec=<fixed latency in ms> "
+	"cookie=<cookie file path>";
+
 #define NAME "tunnel-sink"
 
 PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
@@ -92,17 +119,7 @@
 static const struct spa_dict_item module_tunnel_sink_info = {
 	{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },
 	{ PW_KEY_MODULE_DESCRIPTION, "Create a network sink which connects to a remote PulseAudio server" },
-	{ PW_KEY_MODULE_USAGE,
-		"server=<address> "
-		"sink=<name of the remote sink> "
-		"sink_name=<name for the local sink> "
-		"sink_properties=<properties for the local sink> "
-		"format=<sample format> "
-		"channels=<number of channels> "
-		"rate=<sample rate> "
-		"channel_map=<channel map> "
-		"latency_msec=<fixed latency in ms> "
-		"cookie=<cookie file path>" },
+	{ PW_KEY_MODULE_USAGE, pulse_module_options },
 	{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
 };

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-tunnel-source.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-tunnel-source.c Changed

@@ -12,6 +12,33 @@
 #include "../defs.h"
 #include "../module.h"
 
+/** \page page_pulse_module_tunnel_source Tunnel Source
+ *
+ * ## Module Name
+ *
+ * `module-tunnel-source`
+ *
+ * ## Module Options
+ *
+ * @pulse_module_options@
+ *
+ * ## See Also
+ *
+ * \ref page_module_pulse_tunnel "libpipewire-module-pulse-tunnel"
+ */
+
+static const char *const pulse_module_options =
+	"server=<address> "
+	"source=<name of the remote source> "
+	"source_name=<name for the local source> "
+	"source_properties=<properties for the local source> "
+	"format=<sample format> "
+	"channels=<number of channels> "
+	"rate=<sample rate> "
+	"channel_map=<channel map> "
+	"latency_msec=<fixed latency in ms> "
+	"cookie=<cookie file path>";
+
 #define NAME "tunnel-source"
 
 PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
@@ -92,17 +119,7 @@
 static const struct spa_dict_item module_tunnel_source_info = {
 	{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },
 	{ PW_KEY_MODULE_DESCRIPTION, "Create a network source which connects to a remote PulseAudio server" },
-	{ PW_KEY_MODULE_USAGE,
-		"server=<address> "
-		"source=<name of the remote source> "
-		"source_name=<name for the local source> "
-		"source_properties=<properties for the local source> "
-		"format=<sample format> "
-		"channels=<number of channels> "
-		"rate=<sample rate> "
-		"channel_map=<channel map> "
-		"latency_msec=<fixed latency in ms> "
-		"cookie=<cookie file path>" },
+	{ PW_KEY_MODULE_USAGE, pulse_module_options },
 	{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
 };

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-virtual-sink.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-virtual-sink.c Changed

@@ -10,6 +10,30 @@
 #include "../defs.h"
 #include "../module.h"
 
+/** \page page_pulse_module_virtual_sink Virtual Sink
+ *
+ * ## Module Name
+ *
+ * `module-virtual-sink`
+ *
+ * ## Module Options
+ *
+ * @pulse_module_options@
+ *
+ * ## See Also
+ *
+ * \ref page_module_loopback "libpipewire-module-loopback"
+ */
+
+static const char *const pulse_module_options =
+	"sink_name=<name for the sink> "
+	"sink_properties=<properties for the sink> "
+	"master=<name of sink to filter> "
+	"channels=<number of channels> "
+	"channel_map=<channel map> "
+	"use_volume_sharing=<yes or no> "
+	"force_flat_volume=<yes or no> ";
+
 #define NAME "virtual-sink"
 
 PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
@@ -98,13 +122,7 @@
 static const struct spa_dict_item module_virtual_sink_info = {
 	{ PW_KEY_MODULE_AUTHOR, "Wim Taymans <wim.taymans@gmail.com>" },
 	{ PW_KEY_MODULE_DESCRIPTION, "Virtual sink" },
-	{ PW_KEY_MODULE_USAGE, "sink_name=<name for the sink> "
-				"sink_properties=<properties for the sink> "
-				"master=<name of sink to filter> "
-				"channels=<number of channels> "
-				"channel_map=<channel map> "
-				"use_volume_sharing=<yes or no> "
-				"force_flat_volume=<yes or no> " },
+	{ PW_KEY_MODULE_USAGE, pulse_module_options },
 	{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
 };

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-virtual-source.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-virtual-source.c Changed

@@ -11,6 +11,31 @@
 #include "../defs.h"
 #include "../module.h"
 
+/** \page page_pulse_module_virtual_source Virtual Source
+ *
+ * ## Module Name
+ *
+ * `module-virtual-source`
+ *
+ * ## Module Options
+ *
+ * @pulse_module_options@
+ *
+ * ## See Also
+ *
+ * \ref page_module_loopback "libpipewire-module-loopback"
+ */
+
+static const char *const pulse_module_options =
+	"source_name=<name for the source> "
+	"source_properties=<properties for the source> "
+	"master=<name of source to filter> "
+	"uplink_sink=<name> (optional)"
+	"channels=<number of channels> "
+	"channel_map=<channel map> "
+	"use_volume_sharing=<yes or no> "
+	"force_flat_volume=<yes or no> ";
+
 #define NAME "virtual-source"
 
 PW_LOG_TOPIC_STATIC(mod_topic, "mod." NAME);
@@ -99,14 +124,7 @@
 static const struct spa_dict_item module_virtual_source_info = {
 	{ PW_KEY_MODULE_AUTHOR, "Arun Raghavan <arun@asymptotic.io>" },
 	{ PW_KEY_MODULE_DESCRIPTION, "Loopback from source to sink" },
-	{ PW_KEY_MODULE_USAGE, "source_name=<name for the source> "
-				"source_properties=<properties for the source> "
-				"master=<name of source to filter> "
-				"uplink_sink=<name> (optional)"
-				"channels=<number of channels> "
-				"channel_map=<channel map> "
-				"use_volume_sharing=<yes or no> "
-				"force_flat_volume=<yes or no> " },
+	{ PW_KEY_MODULE_USAGE, pulse_module_options },
 	{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
 };

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-x11-bell.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-x11-bell.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-zeroconf-discover.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-zeroconf-discover.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/modules/module-zeroconf-publish.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/modules/module-zeroconf-publish.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-protocol-pulse/pulse-server.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-pulse/pulse-server.c Changed

@@ -3770,17 +3770,9 @@
 			TAG_INVALID);
 	}
 	if (client->version >= 15) {
-		bool is_linked = collect_is_linked(manager, o->id, SPA_DIRECTION_INPUT);
-		int state = node_state(info->state);
-
-		/* running with nothing linked is probably the monitor that is
-		 * keeping this sink busy */
-		if (state == STATE_RUNNING && !is_linked)
-			state = STATE_IDLE;
-
 		message_put(m,
 			TAG_VOLUME, dev_info.volume_info.base,	/* base volume */
-			TAG_U32, state,				/* state */
+			TAG_U32, dev_info.state,		/* state */
 			TAG_U32, dev_info.volume_info.steps,	/* n_volume_steps */
 			TAG_U32, card ? card->index : SPA_ID_INVALID,	/* card index */
 			TAG_INVALID);
@@ -3974,17 +3966,9 @@
 			TAG_INVALID);
 	}
 	if (client->version >= 15) {
-		bool is_linked = collect_is_linked(manager, o->id, SPA_DIRECTION_OUTPUT);
-		int state = node_state(info->state);
-
-		/* running with nothing linked is probably the sink that is
-		 * keeping this source busy */
-		if (state == STATE_RUNNING && !is_linked)
-			state = STATE_IDLE;
-
 		message_put(m,
 			TAG_VOLUME, dev_info.volume_info.base,	/* base volume */
-			TAG_U32, state,				/* state */
+			TAG_U32, dev_info.state,		/* state */
 			TAG_U32, dev_info.volume_info.steps,	/* n_volume_steps */
 			TAG_U32, card ? card->index : SPA_ID_INVALID,	/* card index */
 			TAG_INVALID);
@@ -4104,7 +4088,7 @@
 			TAG_INVALID);
 	if (client->version >= 19)
 		message_put(m,
-			TAG_BOOLEAN, info->state != PW_NODE_STATE_RUNNING,		/* corked */
+			TAG_BOOLEAN, dev_info.state != STATE_RUNNING,		/* corked */
 			TAG_INVALID);
 	if (client->version >= 20)
 		message_put(m,
@@ -4178,7 +4162,7 @@
 			TAG_INVALID);
 	if (client->version >= 19)
 		message_put(m,
-			TAG_BOOLEAN, info->state != PW_NODE_STATE_RUNNING,		/* corked */
+			TAG_BOOLEAN, dev_info.state != STATE_RUNNING,		/* corked */
 			TAG_INVALID);
 	if (client->version >= 22) {
 		struct format_info fi;

pipewire-0.3.85.tar.gz/src/modules/module-protocol-simple.c -> pipewire-1.0.0.tar.gz/src/modules/module-protocol-simple.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-pulse-tunnel.c -> pipewire-1.0.0.tar.gz/src/modules/module-pulse-tunnel.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-raop-discover.c -> pipewire-1.0.0.tar.gz/src/modules/module-raop-discover.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-raop-sink.c -> pipewire-1.0.0.tar.gz/src/modules/module-raop-sink.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-roc-sink.c -> pipewire-1.0.0.tar.gz/src/modules/module-roc-sink.c Changed

@@ -19,17 +19,22 @@
 #include <roc/log.h>
 #include <roc/sender.h>
 
+#include <pipewire/cleanup.h>
 #include <pipewire/pipewire.h>
 #include <pipewire/impl.h>
 
 #include "module-roc/common.h"
 
-/** \page page_module_roc_sink PipeWire Module: ROC sink
+/** \page page_module_roc_sink ROC sink
  *
  * The `roc-sink` module creates a PipeWire sink that sends samples to
  * a preconfigured receiver address. One can then connect an audio stream
  * of any running application to that sink or make it the default sink.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-roc-sink`
+ *
  * ## Module Options
  *
  * Options specific to the behavior of this module
@@ -39,6 +44,7 @@
  * - `remote.ip = <str>`: remote receiver ip
  * - `remote.source.port = <str>`: remote receiver TCP/UDP port for source packets
  * - `remote.repair.port = <str>`: remote receiver TCP/UDP port for receiver packets
+ * - `remote.control.port = <str>`: remote receiver TCP/UDP port for control packets
  * - `fec.code = <str>`: Possible values: `disable`, `rs8m`, `ldpc`
  *
  * ## General options
@@ -58,6 +64,7 @@
  *          remote.ip = 192.168.0.244
  *          remote.source.port = 10001
  *          remote.repair.port = 10002
+ *          remote.control.port = 10003
  *          sink.name = "ROC Sink"
  *          sink.props = {
  *             node.name = "roc-sink"
@@ -77,7 +84,6 @@
 struct module_roc_sink_data {
 	struct pw_impl_module *module;
 	struct spa_hook module_listener;
-	struct pw_properties *props;
 	struct pw_context *module_context;
 
 	struct pw_core *core;
@@ -100,6 +106,9 @@
 	char *remote_ip;
 	int remote_source_port;
 	int remote_repair_port;
+
+	roc_endpoint *remote_control_addr;
+	int remote_control_port;
 };
 
 static void stream_destroy(void *d)
@@ -207,17 +216,13 @@
 		pw_core_disconnect(data->core);
 
 	pw_properties_free(data->capture_props);
-	pw_properties_free(data->props);
 
-	if (data->sender)
-		roc_sender_close(data->sender);
-	if (data->context)
-		roc_context_close(data->context);
+	spa_clear_ptr(data->sender, roc_sender_close);
+	spa_clear_ptr(data->context, roc_context_close);
 
-	if (data->remote_source_addr)
-		(void) roc_endpoint_deallocate(data->remote_source_addr);
-	if (data->remote_repair_addr)
-		(void) roc_endpoint_deallocate(data->remote_repair_addr);
+	spa_clear_ptr(data->remote_source_addr, roc_endpoint_deallocate);
+	spa_clear_ptr(data->remote_repair_addr, roc_endpoint_deallocate);
+	spa_clear_ptr(data->remote_control_addr, roc_endpoint_deallocate);
 
 	free(data->remote_ip);
 	free(data);
@@ -255,11 +260,11 @@
 		return -EINVAL;
 	}
 
-	memset(&sender_config, 0, sizeof(sender_config));
+	spa_zero(sender_config);
 
-	sender_config.frame_sample_rate = data->rate;
-	sender_config.frame_channels = ROC_CHANNEL_SET_STEREO;
-	sender_config.frame_encoding = ROC_FRAME_ENCODING_PCM_FLOAT;
+	sender_config.frame_encoding.rate = data->rate;
+	sender_config.frame_encoding.channels = ROC_CHANNEL_LAYOUT_STEREO;
+	sender_config.frame_encoding.format = ROC_FORMAT_PCM_FLOAT32;
 	sender_config.fec_encoding = data->fec_code;
 
 	info.rate = data->rate;
@@ -278,21 +283,7 @@
 		return -EINVAL;
 	}
 
-	switch (data->fec_code) {
-	case ROC_FEC_ENCODING_DEFAULT:
-	case ROC_FEC_ENCODING_RS8M:
-		audio_proto = ROC_PROTO_RTP_RS8M_SOURCE;
-		repair_proto = ROC_PROTO_RS8M_REPAIR;
-		break;
-	case ROC_FEC_ENCODING_LDPC_STAIRCASE:
-		audio_proto = ROC_PROTO_RTP_LDPC_SOURCE;
-		repair_proto = ROC_PROTO_LDPC_REPAIR;
-		break;
-	default:
-		audio_proto = ROC_PROTO_RTP;
-		repair_proto = 0;
-		break;
-	}
+	pw_roc_fec_encoding_to_proto(data->fec_code, &audio_proto, &repair_proto);
 
 	res = pw_roc_create_endpoint(&data->remote_source_addr, audio_proto, data->remote_ip, data->remote_source_port);
 	if (res < 0) {
@@ -320,6 +311,18 @@
 		}
 	}
 
+	res = pw_roc_create_endpoint(&data->remote_control_addr, PW_ROC_DEFAULT_CONTROL_PROTO, data->remote_ip, data->remote_control_port);
+	if (res < 0) {
+		pw_log_error("failed to create control endpoint: %s", spa_strerror(res));
+		return res;
+	}
+
+	if (roc_sender_connect(data->sender, ROC_SLOT_DEFAULT, ROC_INTERFACE_AUDIO_CONTROL,
+				data->remote_control_addr) != 0) {
+		pw_log_error("can't connect roc sender to remote control address");
+		return -EINVAL;
+	}
+
 	data->capture = pw_stream_new(data->core,
 			"roc-sink capture", data->capture_props);
 	data->capture_props = NULL;
@@ -354,6 +357,7 @@
 				"remote.ip=<remote receiver ip> "
 				"( remote.source.port=<remote receiver port for source packets> ) "
 				"( remote.repair.port=<remote receiver port for repair packets> ) "
+				"( remote.control.port=<remote receiver port for control packets> ) "
 				"( sink.props= { key=val ... } ) " },
 	{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
 };
@@ -363,7 +367,7 @@
 {
 	struct pw_context *context = pw_impl_module_get_context(module);
 	struct module_roc_sink_data *data;
-	struct pw_properties *props = NULL, *capture_props = NULL;
+	struct pw_properties *capture_props = NULL;
 	const char *str;
 	int res = 0;
 
@@ -376,13 +380,12 @@
 	if (args == NULL)
 		args = "";
 
-	props = pw_properties_new_string(args);
+	spa_autoptr(pw_properties) props = pw_properties_new_string(args);
 	if (props == NULL) {
 		res = -errno;
 		pw_log_error( "can't create properties: %m");
 		goto out;
 	}
-	data->props = props;
 
 	capture_props = pw_properties_new(NULL, NULL);
 	if (capture_props == NULL) {
@@ -397,7 +400,6 @@
 
 	if ((str = pw_properties_get(props, "sink.name")) != NULL) {
 		pw_properties_set(capture_props, PW_KEY_NODE_NAME, str);
-		pw_properties_set(props, "sink.name", NULL);
 	}
 
 	if ((str = pw_properties_get(props, "sink.props")) != NULL)
@@ -414,13 +416,12 @@
 	if ((str = pw_properties_get(capture_props, PW_KEY_MEDIA_CLASS)) == NULL)
 		pw_properties_set(capture_props, PW_KEY_MEDIA_CLASS, "Audio/Sink");
 
-	data->rate = pw_properties_get_uint32(capture_props, PW_KEY_AUDIO_RATE, data->rate);
+	data->rate = pw_properties_get_uint32(capture_props, PW_KEY_AUDIO_RATE, 0);
 	if (data->rate == 0)
 		data->rate = PW_ROC_DEFAULT_RATE;
 
 	if ((str = pw_properties_get(props, "remote.ip")) != NULL) {
 		data->remote_ip = strdup(str);
-		pw_properties_set(props, "remote.ip", NULL);
 	} else {
 		pw_log_error("Remote IP not specified");
 		res = -EINVAL;
@@ -429,24 +430,28 @@
 
 	if ((str = pw_properties_get(props, "remote.source.port")) != NULL) {
 		data->remote_source_port = pw_properties_parse_int(str);
-		pw_properties_set(props, "remote.source.port", NULL);
 	} else {

pipewire-0.3.85.tar.gz/src/modules/module-roc-source.c -> pipewire-1.0.0.tar.gz/src/modules/module-roc-source.c Changed

@@ -19,17 +19,22 @@
 #include <roc/log.h>
 #include <roc/receiver.h>
 
+#include <pipewire/cleanup.h>
 #include <pipewire/pipewire.h>
 #include <pipewire/impl.h>
 
 #include "module-roc/common.h"
 
-/** \page page_module_roc_source PipeWire Module: ROC source
+/** \page page_module_roc_source ROC source
  *
  * The `roc-source` module creates a PipeWire source that receives samples
  * from ROC sender and passes them to the sink it is connected to. One can
  * then connect it to any audio device.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-roc-source`
+ *
  * ## Module Options
  *
  * Options specific to the behavior of this module
@@ -39,6 +44,7 @@
  * - `local.ip = <str>`: local sender ip
  * - `local.source.port = <str>`: local receiver TCP/UDP port for source packets
  * - `local.repair.port = <str>`: local receiver TCP/UDP port for receiver packets
+ * - `local.control.port = <str>`: local receiver TCP/UDP port for control packets
  * - `sess.latency.msec = <str>`: target network latency in milliseconds
  * - `resampler.profile = <str>`: Possible values: `disable`, `high`,
  *   `medium`, `low`.
@@ -63,6 +69,7 @@
  *          sess.latency.msec = 5000
  *          local.source.port = 10001
  *          local.repair.port = 10002
+ *          local.control.port = 10003
  *          source.name = "ROC Source"
  *          source.props = {
  *             node.name = "roc-source"
@@ -82,7 +89,6 @@
 struct module_roc_source_data {
 	struct pw_impl_module *module;
 	struct spa_hook module_listener;
-	struct pw_properties *props;
 	struct pw_context *module_context;
 
 	struct pw_core *core;
@@ -108,6 +114,9 @@
 	int local_source_port;
 	int local_repair_port;
 	int sess_latency_msec;
+
+	roc_endpoint *local_control_addr;
+	int local_control_port;
 };
 
 static void stream_destroy(void *d)
@@ -216,17 +225,13 @@
 		pw_core_disconnect(data->core);
 
 	pw_properties_free(data->playback_props);
-	pw_properties_free(data->props);
 
-	if (data->receiver)
-		roc_receiver_close(data->receiver);
-	if (data->context)
-		roc_context_close(data->context);
+	spa_clear_ptr(data->receiver, roc_receiver_close);
+	spa_clear_ptr(data->context, roc_context_close);
 
-	if (data->local_source_addr)
-		(void) roc_endpoint_deallocate(data->local_source_addr);
-	if (data->local_repair_addr)
-		(void) roc_endpoint_deallocate(data->local_repair_addr);
+	spa_clear_ptr(data->local_source_addr, roc_endpoint_deallocate);
+	spa_clear_ptr(data->local_repair_addr, roc_endpoint_deallocate);
+	spa_clear_ptr(data->local_control_addr, roc_endpoint_deallocate);
 
 	free(data->local_ip);
 	free(data);
@@ -264,9 +269,10 @@
 	}
 
 	spa_zero(receiver_config);
-	receiver_config.frame_sample_rate = data->rate;
-	receiver_config.frame_channels = ROC_CHANNEL_SET_STEREO;
-	receiver_config.frame_encoding = ROC_FRAME_ENCODING_PCM_FLOAT;
+
+	receiver_config.frame_encoding.rate = data->rate;
+	receiver_config.frame_encoding.channels = ROC_CHANNEL_LAYOUT_STEREO;
+	receiver_config.frame_encoding.format = ROC_FORMAT_PCM_FLOAT32;
 	receiver_config.resampler_profile = data->resampler_profile;
 
 	info.rate = data->rate;
@@ -291,7 +297,7 @@
 	 * See API reference:
 	 * https://roc-streaming.org/toolkit/docs/api/reference.html
 	 */
-	receiver_config.target_latency = (unsigned long long)data->sess_latency_msec * 1000000ULL;
+	receiver_config.target_latency = (unsigned long long)data->sess_latency_msec * SPA_NSEC_PER_MSEC;
 
 	res = roc_receiver_open(data->context, &receiver_config, &data->receiver);
 	if (res) {
@@ -299,21 +305,7 @@
 		return -EINVAL;
 	}
 
-	switch (data->fec_code) {
-	case ROC_FEC_ENCODING_DEFAULT:
-	case ROC_FEC_ENCODING_RS8M:
-		audio_proto = ROC_PROTO_RTP_RS8M_SOURCE;
-		repair_proto = ROC_PROTO_RS8M_REPAIR;
-		break;
-	case ROC_FEC_ENCODING_LDPC_STAIRCASE:
-		audio_proto = ROC_PROTO_RTP_LDPC_SOURCE;
-		repair_proto = ROC_PROTO_LDPC_REPAIR;
-		break;
-	default:
-		audio_proto = ROC_PROTO_RTP;
-		repair_proto = 0;
-		break;
-	}
+	pw_roc_fec_encoding_to_proto(data->fec_code, &audio_proto, &repair_proto);
 
 	res = pw_roc_create_endpoint(&data->local_source_addr, audio_proto, data->local_ip, data->local_source_port);
 	if (res < 0) {
@@ -341,6 +333,18 @@
 		}
 	}
 
+	res = pw_roc_create_endpoint(&data->local_control_addr, PW_ROC_DEFAULT_CONTROL_PROTO, data->local_ip, data->local_control_port);
+	if (res < 0) {
+		pw_log_error("failed to create control endpoint: %s", spa_strerror(res));
+		return res;
+	}
+
+	if (roc_receiver_bind(data->receiver, ROC_SLOT_DEFAULT, ROC_INTERFACE_AUDIO_CONTROL,
+				data->local_control_addr) != 0) {
+		pw_log_error("can't connect roc receiver to local control address");
+		return -EINVAL;
+	}
+
 	data->playback = pw_stream_new(data->core,
 			"roc-source playback", data->playback_props);
 	data->playback_props = NULL;
@@ -378,6 +382,7 @@
 				"( local.ip=<local receiver ip> ) "
 				"( local.source.port=<local receiver port for source packets> ) "
 				"( local.repair.port=<local receiver port for repair packets> ) "
+				"( local.control.port=<local receiver port for control packets> ) "
 				"( source.props= { key=value ... } ) " },
 	{ PW_KEY_MODULE_VERSION, PACKAGE_VERSION },
 };
@@ -387,7 +392,7 @@
 {
 	struct pw_context *context = pw_impl_module_get_context(module);
 	struct module_roc_source_data *data;
-	struct pw_properties *props = NULL, *playback_props = NULL;
+	struct pw_properties *playback_props = NULL;
 	const char *str;
 	int res = 0;
 
@@ -400,13 +405,12 @@
 	if (args == NULL)
 		args = "";
 
-	props = pw_properties_new_string(args);
+	spa_autoptr(pw_properties) props = pw_properties_new_string(args);
 	if (props == NULL) {
 		res = -errno;
 		pw_log_error( "can't create properties: %m");
 		goto out;
 	}
-	data->props = props;
 
 	playback_props = pw_properties_new(NULL, NULL);
 	if (playback_props == NULL) {
@@ -421,7 +425,6 @@
 
 	if ((str = pw_properties_get(props, "source.name")) != NULL) {
 		pw_properties_set(playback_props, PW_KEY_NODE_NAME, str);
-		pw_properties_set(props, "source.name", NULL);
 	}
 
 	if ((str = pw_properties_get(props, "source.props")) != NULL)
@@ -436,34 +439,36 @@
 	if (pw_properties_get(playback_props, PW_KEY_NODE_NETWORK) == NULL)
 		pw_properties_set(playback_props, PW_KEY_NODE_NETWORK, "true");
 
-	data->rate = pw_properties_get_uint32(playback_props, PW_KEY_AUDIO_RATE, data->rate);
+	data->rate = pw_properties_get_uint32(playback_props, PW_KEY_AUDIO_RATE, 0);
 	if (data->rate == 0)
 		data->rate = PW_ROC_DEFAULT_RATE;
 
 	if ((str = pw_properties_get(props, "local.ip")) != NULL) {
 		data->local_ip = strdup(str);
-		pw_properties_set(props, "local.ip", NULL);
 	} else {
 		data->local_ip = strdup(PW_ROC_DEFAULT_IP);

pipewire-0.3.85.tar.gz/src/modules/module-roc/common.h -> pipewire-1.0.0.tar.gz/src/modules/module-roc/common.h Changed

@@ -9,8 +9,10 @@
 #define PW_ROC_DEFAULT_IP "0.0.0.0"
 #define PW_ROC_DEFAULT_SOURCE_PORT 10001
 #define PW_ROC_DEFAULT_REPAIR_PORT 10002
+#define PW_ROC_DEFAULT_CONTROL_PORT 10003
 #define PW_ROC_DEFAULT_SESS_LATENCY 200
 #define PW_ROC_DEFAULT_RATE 44100
+#define PW_ROC_DEFAULT_CONTROL_PROTO ROC_PROTO_RTCP
 
 static inline int pw_roc_parse_fec_encoding(roc_fec_encoding *out, const char *str)
 {
@@ -31,8 +33,6 @@
 {
 	if (!str || !*str)
 		*out = ROC_RESAMPLER_PROFILE_DEFAULT;
-	else if (spa_streq(str, "disable"))
-		*out = ROC_RESAMPLER_PROFILE_DISABLE;
 	else if (spa_streq(str, "high"))
 		*out = ROC_RESAMPLER_PROFILE_HIGH;
 	else if (spa_streq(str, "medium"))
@@ -68,4 +68,23 @@
 	return -EINVAL;
 }
 
+static inline void pw_roc_fec_encoding_to_proto(roc_fec_encoding fec_code, roc_protocol *audio, roc_protocol *repair)
+{
+	switch (fec_code) {
+	case ROC_FEC_ENCODING_DEFAULT:
+	case ROC_FEC_ENCODING_RS8M:
+		*audio = ROC_PROTO_RTP_RS8M_SOURCE;
+		*repair = ROC_PROTO_RS8M_REPAIR;
+		break;
+	case ROC_FEC_ENCODING_LDPC_STAIRCASE:
+		*audio = ROC_PROTO_RTP_LDPC_SOURCE;
+		*repair = ROC_PROTO_LDPC_REPAIR;
+		break;
+	default:
+		*audio = ROC_PROTO_RTP;
+		*repair = 0;
+		break;
+	}
+}
+
 #endif /* MODULE_ROC_COMMON_H */

pipewire-0.3.85.tar.gz/src/modules/module-rt.c -> pipewire-1.0.0.tar.gz/src/modules/module-rt.c Changed

@@ -57,7 +57,7 @@
 #include <dbus/dbus.h>
 #endif
 
-/** \page page_module_rt PipeWire Module: RT
+/** \page page_module_rt RT
  *
  * The `rt` modules can give real-time priorities to processing threads.
  *
@@ -69,6 +69,10 @@
  * up and DBus is available, then this module will fall back to using the Portal
  * Realtime DBus API or RTKit.
  *
+ * ## Module Name
+ *
+ * `libpipewire-module-rt`
+ *
  * ## Module Options
  *
  * - `nice.level`: The nice value set for the application thread. It improves
@@ -226,6 +230,8 @@
 #define RLIMIT_RTTIME 15
 #endif
 
+static pthread_mutex_t rlimit_lock = PTHREAD_MUTEX_INITIALIZER;
+
 static pid_t _gettid(void)
 {
 #if defined(HAVE_GETTID)
@@ -552,11 +558,12 @@
 	struct rlimit old_rlim;
 	struct rlimit no_rlim = { -1, -1 };
 	int try = 0;
+	bool ret = false;
 
 	if (!impl->rlimits_enabled)
-		return false;
+		return ret;
 
-	while (try++ < 2) {
+	while (!ret && try++ < 2) {
 		/* We could check `RLIMIT_RTPRIO`, but the BSDs generally don't have
 		 * that available, and there are also other ways to use realtime
 		 * scheduling without that rlimit being set such as `CAP_SYS_NICE` or
@@ -564,11 +571,11 @@
 		 * just try if setting realtime scheduling works or not. */
 		if ((err = pthread_getschedparam(pthread_self(), &old_policy, &old_sched_params)) != 0) {
 			pw_log_warn("Failed to check RLIMIT_RTPRIO: %s", strerror(err));
-			return false;
+			break;
 		}
 		if ((err = get_rt_priority_range(&min, &max)) < 0) {
 			pw_log_warn("Failed to get priority range: %s", strerror(err));
-			return false;
+			break;
 		}
 		if (try == 2) {
 #ifdef RLIMIT_RTPRIO
@@ -584,7 +591,7 @@
 		}
 		if (max < DEFAULT_RT_PRIO_MIN) {
 			pw_log_info("Priority max (%d) must be at least %d", max, DEFAULT_RT_PRIO_MIN);
-			return false;
+			break;
 		}
 
 		/* If the current scheduling policy has `SCHED_RESET_ON_FORK` set, then
@@ -598,24 +605,29 @@
 		if ((old_policy & PW_SCHED_RESET_ON_FORK) != 0)
 			new_policy |= PW_SCHED_RESET_ON_FORK;
 
-		/* Disable RLIMIT_RTTIME while trying new_policy. */
-		if ((err = getrlimit(RLIMIT_RTTIME, &old_rlim)) < 0)
-			pw_log_debug("getrlimit() failed: %s", spa_strerror(err));
-		if ((err = setrlimit(RLIMIT_RTTIME, &no_rlim)) < 0)
-			pw_log_debug("setrlimit() failed: %s", spa_strerror(err));
-
-		if (pthread_setschedparam(pthread_self(), new_policy, &new_sched_params) == 0) {
+		/* Disable RLIMIT_RTTIME in a thread safe way and hope that the application
+		 * doesn't also set RLIMIT_RTTIME while trying new_policy. */
+		pthread_mutex_lock(&rlimit_lock);
+		if (getrlimit(RLIMIT_RTTIME, &old_rlim) < 0)
+			pw_log_info("getrlimit() failed: %m");
+		if (setrlimit(RLIMIT_RTTIME, &no_rlim) < 0)
+			pw_log_info("setrlimit() failed: %m");
+		if ((err = pthread_setschedparam(pthread_self(), new_policy, &new_sched_params)) == 0) {
 			impl->rt_prio = new_sched_params.sched_priority;
 			pthread_setschedparam(pthread_self(), old_policy, &old_sched_params);
-			if ((err = setrlimit(RLIMIT_RTTIME, &old_rlim)) < 0)
-				pw_log_debug("setrlimit() failed: %s", spa_strerror(err));
-			return true;
-		}
-		if ((err = setrlimit(RLIMIT_RTTIME, &old_rlim)) < 0)
-			pw_log_debug("setrlimit() failed: %s", spa_strerror(err));
+			ret = true;
+		} else
+			pw_log_info("failed to set realtime policy: %s", strerror(err));
+		if (setrlimit(RLIMIT_RTTIME, &old_rlim) < 0)
+			pw_log_info("setrlimit() failed: %m");
+		pthread_mutex_unlock(&rlimit_lock);
 	}
-	pw_log_info("Can't set rt prio to %d: %m (try increasing rlimits)", (int)priority);
-	return false;
+
+	if (ret)
+		pw_log_debug("can set rt prio to %d", (int)priority);
+	else
+		pw_log_info("can't set rt prio to %d (try increasing rlimits)", (int)priority);
+	return ret;
 }
 
 static int sched_set_nice(pid_t pid, int nice_level)
@@ -664,11 +676,13 @@
 {
 	int res = 0;
 
+	pthread_mutex_lock(&rlimit_lock);
 	if (setrlimit(RLIMIT_RTTIME, rlim) < 0)
 		res = -errno;
+	pthread_mutex_unlock(&rlimit_lock);
 
 	if (res < 0)
-		pw_log_debug("setrlimit() failed: %s", spa_strerror(res));
+		pw_log_info("setrlimit() failed: %s", spa_strerror(res));
 	else
 		pw_log_debug("rt.time.soft:%"PRIi64" rt.time.hard:%"PRIi64,
 				(int64_t)rlim->rlim_cur, (int64_t)rlim->rlim_max);

pipewire-0.3.85.tar.gz/src/modules/module-rtp-sap.c -> pipewire-1.0.0.tar.gz/src/modules/module-rtp-sap.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-rtp-session.c -> pipewire-1.0.0.tar.gz/src/modules/module-rtp-session.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-rtp-sink.c -> pipewire-1.0.0.tar.gz/src/modules/module-rtp-sink.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-rtp-source.c -> pipewire-1.0.0.tar.gz/src/modules/module-rtp-source.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-rtp/stream.c -> pipewire-1.0.0.tar.gz/src/modules/module-rtp/stream.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-session-manager.c -> pipewire-1.0.0.tar.gz/src/modules/module-session-manager.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-vban-recv.c -> pipewire-1.0.0.tar.gz/src/modules/module-vban-recv.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-vban-send.c -> pipewire-1.0.0.tar.gz/src/modules/module-vban-send.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-x11-bell.c -> pipewire-1.0.0.tar.gz/src/modules/module-x11-bell.c Changed

pipewire-0.3.85.tar.gz/src/modules/module-zeroconf-discover.c -> pipewire-1.0.0.tar.gz/src/modules/module-zeroconf-discover.c Changed

pipewire-0.3.85.tar.gz/src/pipewire/filter.c -> pipewire-1.0.0.tar.gz/src/pipewire/filter.c Changed

pipewire-0.3.85.tar.gz/src/pipewire/impl-client.c -> pipewire-1.0.0.tar.gz/src/pipewire/impl-client.c Changed

pipewire-0.3.85.tar.gz/src/pipewire/impl-module.c -> pipewire-1.0.0.tar.gz/src/pipewire/impl-module.c Changed

pipewire-0.3.85.tar.gz/src/pipewire/pipewire.c -> pipewire-1.0.0.tar.gz/src/pipewire/pipewire.c Changed

pipewire-0.3.85.tar.gz/src/pipewire/pipewire.h -> pipewire-1.0.0.tar.gz/src/pipewire/pipewire.h Changed

pipewire-0.3.85.tar.gz/src/pipewire/private.h -> pipewire-1.0.0.tar.gz/src/pipewire/private.h Changed

pipewire-0.3.85.tar.gz/src/pipewire/stream.c -> pipewire-1.0.0.tar.gz/src/pipewire/stream.c Changed

Changes of Revision 40