<h1 align="center"> <img src="https://user-images.githubusercontent.com/45159366/142936394-b546784e-231a-4391-9dd8-c686e5a7eee9.png"> <br /> PipeWire Guide </h1> <a href="https://github.com/mikeroyal?tab=followers"> <img alt="followers" title="Follow me on Github for Updates" src="https://custom-icon-badges.demolab.com/github/followers/mikeroyal?color=236ad3&labelColor=1155ba&style=for-the-badge&logo=person-add&label=Follow&logoColor=white"/></a>

A guide covering PipeWire including the applications and tools that will make you a better and more efficient with your PipeWire. PipeWire is default in Fedora (34 or later), Debian 12, LMDE 6, Ubuntu (22.10 or later), Pop!_OS 22.04, and openSUSE Tumbleweed.

Note: You can easily convert this markdown file to a PDF in VSCode using this handy extension Markdown PDF.

<p align="center"> <img src="https://user-images.githubusercontent.com/45159366/144766375-c90533df-e0d6-4893-9131-465fe54e236d.png"> <br /> </p>

Table of Contents

1. Getting Started with PipeWire

   • YouTube Tutorials
   • Developer Resources
   • PipeWire Tools
   • Audio Tools & Libraries to use with PipeWire
     • DAW/Sequencers
     • System utilities - Plugin hosts & adapters
     • System utilities - Network streaming/broadcasting
     • Audio Transcoding
   • Installing PipeWire for Debian
   • Installing PipeWire for Ubuntu
   • Installing PipeWire on openSUSE
   • Installing PipeWire on Arch Linux
   • Setting up OBS Studio
     • Useful OBS Studio 3rd party Plugins & Themes

2. Wayland Development

Getting Started with PipeWire

Back to the Top

PipeWire is a server and user space API to deal with multimedia pipelines.It provides a low-latency, graph based processing engine on top of audio and video devices that can be used to support the use cases currently handled by both pulseaudio and JACK. PipeWire was designed with a powerful security model that makes interacting with audio and video devices from containerized applications easy. Nodes in the graph can be implemented as separate processes, communicating with sockets and exchanging multimedia content using fd passing. PipeWire was created by Wim Taymans, Principal Engineer at Red Hat and co-creator of the GStreamer multimedia framework.

Key features of PipeWire include:

• Capture and playback of audio and video with minimal latency.
• Real-time Multimedia processing on audio and video.
• Multiprocess architecture to let applications share multimedia content.
• Seamless support for PulseAudio, JACK, ALSA and GStreamer applications.

YouTube Tutorials

Back to the Top

Developer Resources

Back to the Top

• How Audio is implemented with PipeWire

• PipeWire API

  • Client Implementation
  • Proxy
  • Streams
  • Thread Loop

• PipeWire Design

• PipeWire Library

• DMA-BUF sharing

• PipeWire Daemon

• PipeWire Tools

• PipeWire Session Manager

• PipeWire Modules

• PipeWire - ArchWiki

• PipeWire - Debian Wiki

• PipeWire - Ubuntu Wiki

• PipeWire - openSUSE Wiki

• PipeWire - Void Linux Handbook

• PipeWire - Gentoo Wiki

• PipeWire - NixOS Wiki

• Virtual Devices - PipeWire Wiki

• WirePlumber Documentation

• Linux Audio Foundation

• Linux Audio Wiki - All apps

• LV2 Plugins list

• Wine-VST

• JACK Audio Wiki

<p align="center"> <img src="https://user-images.githubusercontent.com/45159366/142779615-d631251b-a2d6-48b4-8194-7985604a8563.png"> <br /> </p>

How WirePlumber, the PipeWire session manager works. Source: Collabora

PipeWire Tools

Back to the Top

WirePlumber is a modular session / policy manager for PipeWire and a GObject-based high-level library that wraps PipeWire’s API, providing convenience for writing the daemon’s modules as well as external tools for managing PipeWire. The WirePlumber daemon implements the session & policy management service. It follows a modular design, having plugins that implement the actual management functionality.

Core API is used by all clients that need to communicate with the PipeWire Daemon and provides the necessary structs to interface with the daemon.

Implementation API is primarily used by the PipeWire Daemon itself but also by the PipeWire Session Manager and modules/extensions that need to build objects in the graph.

SPA (Simple Plugin API) is an extensible API to implement all kinds of plugins.

PipeWire-rs is a Rust bindings for pipewire and SPA libraries.

Audio Tools & Libraries to use with PipeWire

Back to the Top

EasyEffects is an applicaton that provides a limiter, compressor, convolver, equalizer and auto volume and many other plugins for PipeWire applications.

<p align="center"> <img src="https://user-images.githubusercontent.com/45159366/169711136-70c5cdb5-3275-4857-9072-44bdf1041bd2.png"> <br /> </p>

Helvum is a GTK-based patchbay for pipewire, inspired by the JACK tool Catia.

<p align="center"> <img src="https://user-images.githubusercontent