Audio server utils module (New) #2131
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #2131 +/- ##
==========================================
+ Coverage 53.81% 54.35% +0.54%
==========================================
Files 406 408 +2
Lines 43288 43847 +559
Branches 7997 8075 +78
==========================================
+ Hits 23296 23834 +538
- Misses 19179 19195 +16
- Partials 813 818 +5
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
p-gentili
changed the title
p-gentili
force-pushed
the
audio-utils
branch
2 times, most recently
from
9f11017 to
93e736d
Compare
p-gentili
changed the title
p-gentili
force-pushed
the
audio-utils
branch
from
c428002 to
533afc7
Compare
Hook25
requested changes
Dec 15, 2025
Collaborator
Hook25
left a comment
Hook25
left a comment
There was a problem hiding this comment.
This is ok, consider adding a bit more end 2 end tests.
checkbox-support/checkbox_support/helpers/tests/test_audio_server_utils.py
Show resolved
Hide resolved
checkbox-support/checkbox_support/helpers/audio_server_utils.py
Outdated
Show resolved
Hide resolved
checkbox-support/checkbox_support/helpers/tests/test_audio_server_utils.py
Show resolved
Hide resolved
Introduces a unified interface for working with PulseAudio and PipeWire audio servers without requiring deep knowledge of either system. Features: - AudioServerUtils factory that auto-detects the running audio server - PipewireUtils: Full support for PipeWire's device/profile/node hierarchy - PulseaudioUtils: Support for PulseAudio sink/source management - Node abstraction representing audio sinks and sources - Methods to list, iterate, set default, and control volume of audio nodes - CLI interface for listing and interactively selecting audio nodes The iterator pattern (iter_sinks/iter_sources) automatically activates profiles before yielding nodes, making them immediately usable.
Comprehensive test coverage for the audio_server_utils module: - NodeTests: Basic Node class instantiation - AudioServerUtilsTests: Factory pattern and server detection - PipewireUtilsTests: PipeWire-specific functionality including pw-dump parsing, device/profile/node handling, and volume control - PulseaudioUtilsTests: PulseAudio-specific functionality including pactl parsing, sink/source management, and volume control Signed-off-by: Paolo Gentili <paolo.gentili@canonical.com>
Signed-off-by: Paolo Gentili <paolo.gentili@canonical.com>
Signed-off-by: Paolo Gentili <paolo.gentili@canonical.com>
Signed-off-by: Paolo Gentili <paolo.gentili@canonical.com>
p-gentili
force-pushed
the
audio-utils
branch
from
533afc7 to
920fc1a
Compare
Hook25
approved these changes
Jan 12, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces a new utility module in checkbox support to scan and control sources and sinks using both Pipewire and Pulseaudio in a transparent way.
The
mainfunctions explains a bit how to use it, but in general:It's non trivial to control nodes outside of the iteration, especially with Pipewire: Nodes are ephemeral, and there's no identifier that is guaranteed to survive after changing device profile.
Resolved issues
N/A
Documentation
N/A
Tests
Run it as a script, and check if the sink on your machine changes.
NB: there are sinks that are available but not actually usable: your settings panel might not update the displayed value in this case.