We're hiring!
*

New graphing tool for PipeWire debugging

Julian Bouzas avatar

Julian Bouzas
December 09, 2019

Share this post:

PipeWire, the new and emerging open source framework that aims to greatly improve the exchange and management of audio and video streams inside a Linux system, has seen a number of improvements and bug fixes over the past year. With many developers now actively contributing to it, PipeWire is maturing quickly and is well on its way to becoming the new standard.

At Collabora, we have been busy helping clients work with PipeWire, notably Automotive Grade Linux who have chosen to adopt PipeWire for its implementation of the low-level platform audio service, replacing previous solutions like 4A, PulseAudio and AudioManager. Assisting early adopters such as AGL has brought us to design and implement new elements within PipeWire, such as the session & policy management component WirePlumber, which George Kiagiadakis presented in October at the GStreamer Conference in Lyon.

In addition to WirePlumber, we are happy to announce that we have now implemented a new tool to simplify and ease the debugging process. Aptly named pipewire-dot, this new tool generates graph using the dot language depicting all the PipeWire objects and links between them.

The main purpose of this tool is to increase developers' productivity when debugging PipeWire, and quickly visualize how all PipeWire objects are connected with each other. Previously, this could only be done by reading long log files, or by parsing the output of the pipewire-monitor tool with a small script. However, these methods were never visual, and always required that developers spend time checking to see if the PipeWire objects were linked correctly when something was not working. Luckily, developers no longer need to do this, and can now visualize all the PipeWire structure and object properties by running the quick and simple pipewire-dot command.

Running the pipewire-dot command essentially creates a pw.dot file in the current directory that has the graph defined using the Graphviz dot description language. Afterwards, the user can easily display the graph using Graphviz tools such as the xdot command to view the graph directly in a window:

    $ xdot pw.dot

Or render a pw.png image using the dot command:

    $ dot -Tpng pw.dot > pw.png

The tool also accepts different flags that can generate different graphs. The default graph will only display the most common Pipewire objects: nodes, ports and links; which is the most common data the users want to check at first. However, more objects and information can be shown if we pass different options:

--all: This will show all pipewire objects in the graph
--smart: This will only show linked pipewire objects
--detail: This will additionally show all the object properties

Here are some usage examples with the generated graph (click on each image to view larger version):

  • $ pipewire-dot && xdot pw.dot

    PipeWire debugging graph example

  • $ pipewire-dot --all && xdot pw.dot

    PipeWire debugging graph example

  • $ pipewire-dot --smart --detail && xdot pw.dot

    PipeWire debugging graph example

Finally, some improvements could be done in the future to display more information in the generated graph. For example, the tool could be improved by displaying the format of the ports when they are configured. The graph can be very big if PipeWire has many clients using it, so another example of improvement could be adding an option to only display objects that use a specific multimedia device.

PipeWire is really shaping up to be the next big thing in managing media streams on Linux systems. With this new feature, and many other improvements developed by the community, we can now use it to build the next generation of products.

If you are interested in finding out more about PipeWire or need help with consulting services on audio/video in 2020, please reach out to us.

Comments (0)


Add a Comment






Allowed tags: <b><i><br>Add a new comment:


Search the newsroom

Latest Blog Posts

Empathy first: Driving growth through people leadership

30/11/2020

This year, the global pandemic has put a strain on us all. Motivation can become hard to maintain, worries can cloud our minds. Now more…

Developing Wayland Color Management and High Dynamic Range

19/11/2020

Wayland is still lacking proper consideration for color management & support for high dynamic range (HDR) imagery. However, a group of renegade…

A summer sprint: bringing near-native performance to Zink

06/11/2020

This week marks two years since the OpenGL implementation on Vulkan was initially announced. Since then, and especially over the past few…

From Panfrost to production, a tale of Open Source graphics

03/11/2020

Since our previous update on Panfrost, the open source stack for Arm's Mali Midgard and Bifrost GPUs, we've focused on taking our driver…

Engaging in an "Open First" remote internship at Collabora

20/10/2020

The concept of a remote internship may raise some doubts, or even red flags, for many students, as would remote jobs for professionals.…

Building GStreamer text rendering and overlays on Windows with gst-build

28/09/2020

GStreamer relies on various 2D font rendering and layout libraries such as Pango and Cairo to generate text for the Pango plugin, which…

Open Since 2005 logo

We use cookies on this website to ensure that you get the best experience. By continuing to use this website you are consenting to the use of these cookies. To find out more please follow this link.

Collabora Ltd © 2005-2020. All rights reserved. Privacy Notice. Sitemap.