feat(sound): redesign with separate device profiles page #1500

mmstick · 2025-10-20T14:18:35Z

Closes #1325
Closes pop-os/cosmic-osd#158
Closes pop-os/cosmic-epoch#655
Closes pop-os/cosmic-epoch#787
Closes pop-os/cosmic-epoch#946
Closes pop-os/cosmic-epoch#1001
Closes pop-os/cosmic-epoch#568
Closes pop-os/cosmic-epoch#1368

Device profiles have been moved into a new Device Profiles sub-page for selecting profiles per device
- Set with wpctl set-profile {{device-id}} {profile-index}} instead of pactl
Setting the default sink (output) and source (input) now operates independently
- Set with wpctl set-default {{node-id}}
All of our devices now have stable node object and device IDs from pipewire-rs
- Enables using wpctl for setting card profiles, default sinks/sources, volume, and mute
- Significant performance and stability improvements
- Wireplumber state no longer gets corrupted
Fixed early return on debounced volume events dropping pipewire and pulse events
Update pipewire-rs to version 0.9
Most of our dependency on libpulse has been eliminated
- It is only used for getting and setting volume, volume balance, and watching default sink/source changes

jacobgkau

First, there's an overflow/sizing issue with the drop-down box on the Device Profiles page. By default, I had no profile selected (not even "Off"), which seems impossible. In that state, most of the drop-down items flowed out of the end of the window:

It seems like longer labels being selected allowed the drop-down to display more of its contents:

Separate issue, but after I selected "Off" as my profile, the device disappeared from the list, making it impossible to turn on again. The point of the "Off" option is to still show the device in the list while it's disabled, so that shouldn't happen.

mmstick · 2025-10-20T17:28:46Z

What's the output of pw-dump on this system? This is what I see on a system with a Realtek card, Radeon HDMI audio, and a USB-C sound card.

mmstick · 2025-10-21T14:42:23Z

Fixed the devices on the device profiles page disappearing when setting their profile to off. Which also fixes the device briefly disappearing when the device's nodes are replaced.

jacobgkau

On the same machine as yesterday, I still had one of the devices not have any profile visibly selected at first, which shouldn't be possible:

Here is pw-dump from that system: pw-dump-oryp8.txt

If I set the device to "Off", it initially shows itself as "Off", but if I reboot, I end up in the same state as shown above (it boots up set to nothing instead of showing as set to "Off".)

jacobgkau · 2025-10-21T17:28:14Z

I'm still also seeing menu items getting cut off at the edge of the window. Is that a libcosmic bug? Dropdown menus in other COSMIC apps seem to be able to run out the side of the window.

mmstick · 2025-10-21T17:31:42Z

It's a different dropdown widget. I will switch to it

mmstick · 2025-10-21T18:07:57Z

The index of the selected profile on that Built-in Audio device should be fixed now

jacobgkau · 2025-10-21T20:21:32Z

On 8688b54 and oryp8, the profile of Built-in Audio keeps defaulting to Digital Surround 5.1 (IEC958/AC3) Output. I think this corresponds to the S/PDIF output, but attempting to change the volume does nothing. Going directly to Digital Stereo (IEC958) Output doesn't work, but if I choose Off, then I can go to Digital Stereo (IEC958) Output to get sound out of the S/PDIF port (the Digital Surround option then gives distorted audio if I select that again).

If I just boot (defaulting to Digital Surround 5.1 (IEC958/AC3) Output) and change directly to one of the Analog Stereo options, that also doesn't work (changing the volume doesn't work & there's no sound). Again, I have to select Off first, then go back to Analog Stereo for it to work.

I know some of this might be audio card weirdness that's outside the scope of COSMIC Settings, but does any of this sound like a COSMIC Settings thing? The two distinct problems are the default/last selected profile not being saved between sessions, and not being able to switch from the default to one of the others successfully without first selecting Off (or possibly just sound not working at all until it's turned Off).

jacobgkau · 2025-10-21T21:11:07Z

From @WatchMkr in Mattermost (posting here so it doesn't get lost)-- the design also calls for the device description to be prepended to the profile name when selecting an input/output device (e.g. Speakers - Built-in Audio). The string to be prepended appears to be labeled "description" in pw-dump.

mmstick · 2025-10-22T19:25:07Z

Seems I'll need to add the different routes (ports) to the output/input dropdown lists. Pavucontrol puts those on a separate port dropdown.

jacobgkau · 2025-10-22T22:44:00Z

Not sure if you were ready for me to look at this again yet, but just to corroborate, on f787c83, I'm seeing the Output device as Analog Stereo - Built-in Audio, when it should say Speakers - Built-in Audio. As you noted, it should be the description of the route, not the profile.

The other problems I mentioned before are still occurring.

jacobgkau

35e3127 still has reliability issues on oryp8.

If I set Built-in Audio's profile to Analog Stereo Duplex and then reboot, it defaults to Digital Surround 5.1 (IEC958/AC3) Output again.

If I change the profile to Analog Stereo Duplex, then both Output device and Input device show their only option as Built-in Audio, with no route name/description prepended. Changing the speaker volume with hotkeys doesn't work in this state.

If I change the profile to Analog Stereo Output, then Output device changes to Speakers - Built-in Audio, and the speaker hotkeys work. Alternatively, if I open up an app and start playing audio, then the Output device does not change, but the speaker hotkeys do start working.

mmstick · 2025-10-28T11:11:34Z

What's the output of pw-dump when set to Analog Stereo Duplex? Particularly the Pipewire:Interface:Node associated with it. Changing the profile changes the active route, and a PipeWire:Interface:Node is created from that.

Based on the logic that I have, the most likely problem is that the node failed to parse. The node ID is required to set a default sink/source, and the route won't be added to the device name if a node isn't associated with it.

mmstick · 2025-10-28T11:15:07Z

crates/cosmic-pipewire/src/lib.rs

+                        .info({
+                            let state = Rc::downgrade(&state);
+                            move |info| {
+                                if let Some(node) = Node::from_node(info) {


This is where the node is parsed. This could be wrapped with dbg!(Node::from_node(info)) to check if all nodes are getting parsed.

jacobgkau

Here is pw-dump after booting on 4a14492, defaulting to S/PDIF: oryp8-4a14492-default-spdif.txt
Here is pw-dump after changing the profile to Analog Stereo Duplex: oryp8-4a14492-duplex.txt

On 4a14492, the speaker hotkeys work immediately after changing the profile to Analog Stereo Duplex, but the Output device is only labeled Built-in Audio, while the Input device is labeled Speakers - Built-in Audio.

mmstick · 2025-10-28T18:00:52Z

I think I see the issue

mmstick · 2025-10-29T23:03:57Z

Hoping this fixes the issue you're seeing.

…ects profile

…ice was active

jacobgkau · 2025-11-21T20:25:14Z

After looking at WirePlumber's debug logs, I think Pop!_OS is configured to have WirePlumber handle auto-selecting/remembering device profiles, not the PipeWire daemon itself. (PipeWire has an ALSA option for it, but the docs note it's usually disabled so the session manager can handle it instead.)

I think it's working correctly. But again, on a44fc56, I'm seeing COSMIC Settings not update to reflect the profile change when I unplug HDMI, until I exit and re-enter the Device profiles page. It does update to go from Off to Digital Stereo (HDMI) Output when I plug in; it's only when I unplug that it's not updating to Off until I manually re-enter the page.

jacobgkau · 2025-11-24T21:08:42Z

I'm tearing my hair out trying to test at this point. I'm getting the following crash on this branch very often after trying to reset the config files:

system76@pop-os:~/cosmic-settings$ RUST_BACKTRACE=full COLORBT_SHOW_HIDDEN=1 cosmic-settings
  ERROR  shortcuts custom config error: GetKey("custom", Os { code: 2, kind: NotFound, message: "No such file or directory" })
    at /build/cosmic-settings-eJXdZR/cosmic-settings-0.1.0~1763999493~24.04~6f4c755/vendor/cosmic-settings-config/src/shortcuts/mod.rs:43 on main

  ERROR  Failed to load Panel system config., err: GetKey("padding_overlap", Os { code: 2, kind: NotFound, message: "No such file or directory" })
    at cosmic-settings/src/pages/desktop/panel/mod.rs:90 on main

  ERROR  Error when loading Panel container config., err: GetKey("padding_overlap", Os { code: 2, kind: NotFound, message: "No such file or directory" })
    at cosmic-settings/src/pages/desktop/panel/inner.rs:71 on main

  ERROR  Error when loading Panel container config., err: GetKey("padding_overlap", Os { code: 2, kind: NotFound, message: "No such file or directory" })
    at cosmic-settings/src/pages/desktop/panel/inner.rs:71 on main

  ERROR  Failed to load Dock system config., err: GetKey("padding_overlap", Os { code: 2, kind: NotFound, message: "No such file or directory" })
    at cosmic-settings/src/pages/desktop/dock/mod.rs:139 on main

  ERROR  Error when loading Panel container config., err: GetKey("padding_overlap", Os { code: 2, kind: NotFound, message: "No such file or directory" })
    at cosmic-settings/src/pages/desktop/panel/inner.rs:71 on main

  ERROR  Error when loading Panel container config., err: GetKey("padding_overlap", Os { code: 2, kind: NotFound, message: "No such file or directory" })
    at cosmic-settings/src/pages/desktop/panel/inner.rs:71 on main

  ERROR  shortcuts custom config error: GetKey("custom", Os { code: 2, kind: NotFound, message: "No such file or directory" })
    at /build/cosmic-settings-eJXdZR/cosmic-settings-0.1.0~1763999493~24.04~6f4c755/vendor/cosmic-settings-config/src/shortcuts/mod.rs:43 on main

The application panicked (crashed).
Message:  assertion failed: self.is_char_boundary(idx)
Location: cosmic-settings/src/pages/sound/mod.rs:484

  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ BACKTRACE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
   1: __libc_start_main<unknown>
      at <unknown source file>:<unknown line>

Run with COLORBT_SHOW_HIDDEN=1 environment variable to disable frame filtering.
Aborted (core dumped)
system76@pop-os:~/cosmic-settings$

I don't think any of the ERROR lines are relevant (they also happen on master), but do you know why the assertion failed thing would be happening? I can downgrade to master, Settings opens fine, then I upgrade back to this branch and it won't launch in this state.

jacobgkau · 2025-11-24T21:26:02Z

Just now, I saw Settings start working after I suspended for a while and then resumed. But after removing the config files and rebooting again, it stopped working again.

Here is a more complete output doing a cargo run with the debug log: sound-crash.txt

mmstick · 2025-11-24T21:42:42Z

I think that code isn't needed anymore, so we can remove it.

jacobgkau

That last commit solved the crash I was seeing.

I'm seeing the following occur when the Sound applet is in the panel:

Plug in HDMI for the first time; it gets a profile auto-selected, and that's marked as saved according to pw-cli e ## Profile.
Unplug HDMI; the profile's changed to Off, still marked as saved in pw-cli e ## Profile.
On all subsequent plug-ins of HDMI, the profile stays on Off since it was saved.

After removing the Sound applet from the panel (and resetting WirePlumber's state), the Param:Profile:save parameter remains false, both when plugging in HDMI and getting its auto-selected profile, and unplugging it to go to Off again. When I reset my COSMIC settings to get the Sound applet running again, the broken behavior returns.

This suggests to me that the updated Sound applet (which is pointing towards this branch at this time) is saving the profile when it gets auto-selected. It either needs to not do that on auto-selection (and only save if it's an actual user action-- which can't be done through the Applet, anyway), or at least set Param:Profile:save to false when it's (auto-)set to Off.

mmstick · 2025-11-25T00:08:29Z

The applet is pointing to an older commit, so I'll update it.

mmstick · 2025-11-25T00:11:17Z

The applet PR has been rebased. The current behavior is to only save when manually saving a profile.

jacobgkau

HDMI plug/unplug is working great now. It switches between the default profile & Off as expected by default; if I set a different profile, then it switches between that profile and Off.

I've mostly been testing on laptops, so I'm going to take a quick look on a desktop as well before approving.

jacobgkau

Working as expected on a desktop as well.

mmstick requested review from a team October 20, 2025 14:18

jacobgkau requested changes Oct 20, 2025

View reviewed changes

wash2 previously approved these changes Oct 21, 2025

View reviewed changes

jackpot51 requested a review from jacobgkau October 21, 2025 16:31

jacobgkau requested changes Oct 21, 2025

View reviewed changes

mmstick dismissed wash2’s stale review via 717e099 October 21, 2025 17:48

mmstick force-pushed the sound branch 2 times, most recently from 717e099 to 278f24d Compare October 21, 2025 17:50

wash2 previously approved these changes Oct 21, 2025

View reviewed changes

mmstick dismissed wash2’s stale review via ec419c8 October 21, 2025 17:58

mmstick force-pushed the sound branch from ec419c8 to 3b4d6b8 Compare October 21, 2025 18:07

mmstick requested a review from jacobgkau October 21, 2025 18:08

mmstick force-pushed the sound branch 2 times, most recently from cdbd2a9 to 089d65e Compare October 27, 2025 14:11

jacobgkau reviewed Oct 27, 2025

View reviewed changes

mmstick commented Oct 28, 2025

View reviewed changes

jacobgkau reviewed Oct 28, 2025

View reviewed changes

mmstick added 14 commits November 21, 2025 20:06

feat(sound): auto-select first available profile if device is Off

4ed196c

chore(sound): auto-select profile only when enabled in model

2bdb106

fix(sound): regression in active route not being added to device name

5b24878

refactor(sound): dedupe code to update device route name

274e2a9

fix(sound): update ui profiles after setting profile from UI

c1a5a11

fix(sound): alter where device reselect occurs

dc59469

fix(sound): reuse set_profile method to track last set profiles

609661c

feat(sound): make save property configurable; only save when user sel…

7a02883

…ects profile

fix(sound): remove broken profile auto-select for off devices

7ce2abf

chore: improve RUST_LOG handling

97ad1c2

fix(sound): add logs & remove device / profile auto-select

7a2e297

fix(sound): unset active sink/source if node was removed

5bb27f8

feat(sound): retain sink/source device on saved profile change if dev…

fdbc6c1

…ice was active

feat(sound): retain active sink/source device on external profile change

a44fc56

mmstick force-pushed the sound branch from 84ff320 to a44fc56 Compare November 21, 2025 19:11

fix(sound): add missing call to update profile on active profile change

6f4c755

mmstick force-pushed the sound branch from d9d68f8 to 6f4c755 Compare November 24, 2025 15:51

fix(sound): remove unused wireplumber fix

9f7a579

jacobgkau reviewed Nov 24, 2025

View reviewed changes

jacobgkau reviewed Nov 25, 2025

View reviewed changes

jacobgkau approved these changes Nov 25, 2025

View reviewed changes

wash2 approved these changes Nov 25, 2025

View reviewed changes

mmstick merged commit 2c9f60c into master Nov 25, 2025
13 checks passed

mmstick deleted the sound branch November 25, 2025 20:46

feat(sound): redesign with separate device profiles page #1500

feat(sound): redesign with separate device profiles page #1500

Uh oh!

Conversation

mmstick commented Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jacobgkau left a comment

Choose a reason for hiding this comment

Uh oh!

mmstick commented Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mmstick commented Oct 21, 2025

Uh oh!

jacobgkau left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jacobgkau commented Oct 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mmstick commented Oct 21, 2025

Uh oh!

mmstick commented Oct 21, 2025

Uh oh!

jacobgkau commented Oct 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jacobgkau commented Oct 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mmstick commented Oct 22, 2025

Uh oh!

jacobgkau commented Oct 22, 2025

Uh oh!

jacobgkau left a comment

Choose a reason for hiding this comment

Uh oh!

mmstick commented Oct 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mmstick Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

jacobgkau left a comment

Choose a reason for hiding this comment

Uh oh!

mmstick commented Oct 28, 2025

Uh oh!

mmstick commented Oct 29, 2025

Uh oh!

jacobgkau commented Nov 21, 2025

Uh oh!

jacobgkau commented Nov 24, 2025

Uh oh!

jacobgkau commented Nov 24, 2025

Uh oh!

mmstick commented Nov 24, 2025

Uh oh!

jacobgkau left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mmstick commented Nov 25, 2025

Uh oh!

mmstick commented Nov 25, 2025

Uh oh!

jacobgkau left a comment

Choose a reason for hiding this comment

Uh oh!

jacobgkau left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

mmstick commented Oct 20, 2025 •

edited

Loading

mmstick commented Oct 20, 2025 •

edited

Loading

jacobgkau left a comment •

edited

Loading

jacobgkau commented Oct 21, 2025 •

edited

Loading

jacobgkau commented Oct 21, 2025 •

edited

Loading

jacobgkau commented Oct 21, 2025 •

edited

Loading

mmstick commented Oct 28, 2025 •

edited

Loading

jacobgkau left a comment •

edited

Loading