nixos/pipewire: add configPackages options #282377

hcsch · 2024-01-20T17:00:53Z

Description of changes

Added configPackages options to both services.pipewire and services.pipewire.wireplumber. Packages specified in these options have their relevant files (e.g. share/pipewire/pipewire.conf.d/*) combined in store path generated by pkgs.buildEnv and linked to /etc/.
Pipewire extraConfig options also get added to this store path in the appropriate locations.

Added extraLv2Packages options to the options of both services for packages providing lv2 plugins required by filter chains the user set up in their pipewire/wireplumber config files. These get added to the LV2_PATH of the service they were specified for. In addition, packages in configPackages can specify passthru.requiredLv2Packages to have them included in the path as well.

In the case of wireplumber, added config and lv2 packages get added for pipewire as well, since config packages for wireplumber are likely to have config files for pipewire as well.

For now my main use case for this is asahi-audio (my setup for that is not yet clean enough to upstream), but I'm sure that as time goes on, other packages will pop up to configure filter chains or similar things. With these options, adding them to nixpkgs should be easy and using them should be easy for users as well.

Things done

I've tested these changes locally with my yet to be upstreamed asahi-audio package and the config files are put in the right places, and lv2 packages are found by wireplumber/pipewire. The existing nixos default config files for pipewire are also present.

Add a 👍 reaction to pull requests you find important.

hcsch · 2024-01-20T17:02:13Z

Should I document the attribute in passthru somewhere for discoverabiltiy? If so, where is the most appropriate place for that?

nixos-discourse · 2024-01-20T17:03:26Z

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/asahi-audio-on-nixos-lv2-path-management/38569/4

hcsch · 2024-01-20T17:12:37Z

Forgot some mentions of the not yet upstreamed asahi-audio package in the option descriptions/examples. Those have been removed with the force-push

hcsch · 2024-01-20T17:24:36Z

@tpwrules If I'm right, you set up asahi-audio for https://github.com/tpwrules/nixos-apple-silicon. I'd be happy to hear if this looks useful to you :)

tpwrules · 2024-01-20T19:02:00Z

@K900 we had discussed something along these lines on Matrix, what do you think? I don't have any opinion yet.

hcsch · 2024-02-01T06:17:46Z

I moved some definitions around in the pipewire module to make the git diff a bit more readable. Adding a let ... in in the config definition and having to change the indentation accordingly kinda made the diff a bit messy. Hopefully this way it's nicer to review

Edit: Accidentally duplicated some systemd service settings while rebasing. Fixed that again just now

K900 · 2024-02-08T07:14:12Z

Do we really need separate options for LV2 plugins on Wireplumber and Pipewire? I'm not even sure if both need to be aware of it.

hcsch · 2024-02-09T12:22:46Z

You're totally right. I think I just got a bit confused about what requires what to work when I wrote this. I was getting some errors in wireplumber about not being able to find the lv2 plugins, or something along those lines, but all docs (that I found) described this as a feature of pipewire, not wireplumber. And I kinda remember getting some errors from pipewire too, but that might've been due to other issue earlier when I was writing these changes, when I was having some other issues as well.
Anyways, I've taken out the LV2 config options / environment variables from the pipewire module and tested the setup again on my nixos (with nixpkgs at nixos-unstable) and it seemed to worked just fine.

nixos/modules/services/desktops/pipewire/wireplumber.nix

K900

Overall looks pretty good

nixos/modules/services/desktops/pipewire/pipewire.nix

nixos/modules/services/desktops/pipewire/wireplumber.nix

In docs PipeWire and WirePlumber should be capitalized as in this sentence.

K900 · 2024-02-26T06:12:11Z

OK let's send it.

Follow-up NixOS#282377. Some packages may want to load LV2 plugins directly from PipeWire config instead, so add another option to accomodate those.

Follow-up to NixOS#282377. NixOS#282377 broke `environment.etc."wireplumber<...>"`, however WirePlumber did not yet have `extraConfig` style options for configuring it ergonomically outside of `environment.etc`. This has caused issues for people who had custom config files for WirePlumber, as having to create a config package just to edit some settings is not as ergonomic or discoverable as with a proper `extraConfig` style option. This commit fixes this issue by adding three new options: * `extraConfig` for WirePlumber 0.5 `.conf` files. The option takes Nix attrsets, converts them into JSON and places them in `/etc/wireplumber/wireplumber.conf.d`. Here rules for ALSA and Bluetooth devices, stream settings, log-levels and the like can be set. * `extraScripts` for lua scripts to be referenced by configuration files. These get put in `/etc/wireplumber/scripts`.

Follow-up to NixOS#282377. NixOS#282377 broke `environment.etc."wireplumber<...>"`, however WirePlumber did not yet have `extraConfig` style options for configuring it ergonomically outside of `environment.etc`. This has caused issues for people who had custom config files for WirePlumber, as having to create a config package just to edit some settings is not as ergonomic or discoverable as with a proper `extraConfig` style option. This commit fixes this issue by adding the `extraConfig` option for additional config file and the `extraScripts` option for additional scripts to be used by config files. With WirePlumber 0.5 it is possible to supply config files and scripts via the `XDG_DATA_DIRS` variable to the WirePlumber daemon. This is how the new options and with this change also the `configPackages` option expose their files to the daemon. This way `environment.etc."wireplumber"` works again for user configuration and breakage of old configs from 23.11 to 24.05 should be limited to those caused by the change in the config format from WirePlumber 0.4 to 0.5.

github-actions bot added 6.topic: nixos 8.has: module (update) labels Jan 20, 2024

hcsch force-pushed the pipewire-wireplumber-config-packages branch from 1aeaa88 to 9c00064 Compare January 20, 2024 17:11

ofborg bot added 10.rebuild-darwin: 0 10.rebuild-linux: 1-10 labels Jan 20, 2024

hcsch force-pushed the pipewire-wireplumber-config-packages branch from 9c00064 to 3675056 Compare February 1, 2024 06:15

hcsch force-pushed the pipewire-wireplumber-config-packages branch from 3675056 to 09d611f Compare February 1, 2024 06:20

hcsch force-pushed the pipewire-wireplumber-config-packages branch from 09d611f to d461252 Compare February 9, 2024 11:42

K900 reviewed Feb 22, 2024

View reviewed changes

nixos/modules/services/desktops/pipewire/wireplumber.nix Outdated Show resolved Hide resolved

K900 approved these changes Feb 22, 2024

View reviewed changes

hcsch force-pushed the pipewire-wireplumber-config-packages branch from d461252 to f7d5fe6 Compare February 23, 2024 06:58

K900 reviewed Feb 23, 2024

View reviewed changes

nixos/modules/services/desktops/pipewire/pipewire.nix Outdated Show resolved Hide resolved

K900 reviewed Feb 23, 2024

View reviewed changes

nixos/modules/services/desktops/pipewire/wireplumber.nix Outdated Show resolved Hide resolved

K900 reviewed Feb 23, 2024

View reviewed changes

nixos/modules/services/desktops/pipewire/wireplumber.nix Outdated Show resolved Hide resolved

hcsch added 4 commits February 23, 2024 08:57

nixos/pipewire: Fix capitalization

992582f

In docs PipeWire and WirePlumber should be capitalized as in this sentence.

nixos/pipewire: add config packages option

054bba5

nixos/wireplumber: add config packages option

5bf2637

nixos/wireplumber: add required lv2 plugins to service path

e722c56

hcsch force-pushed the pipewire-wireplumber-config-packages branch from f7d5fe6 to e722c56 Compare February 23, 2024 07:59

K900 merged commit 92b9d11 into NixOS:master Feb 26, 2024
20 checks passed

K900 added a commit to K900/nixpkgs that referenced this pull request Feb 26, 2024

nixos/pipewire: add LV2 plugins option

eb74747

Follow-up NixOS#282377. Some packages may want to load LV2 plugins directly from PipeWire config instead, so add another option to accomodate those.

mjjs mentioned this pull request Mar 22, 2024

Pipewire not applying extra config after upgrade #298158

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

nixos/pipewire: add configPackages options #282377

nixos/pipewire: add configPackages options #282377

hcsch commented Jan 20, 2024

hcsch commented Jan 20, 2024

nixos-discourse commented Jan 20, 2024

hcsch commented Jan 20, 2024 •

edited

hcsch commented Jan 20, 2024

tpwrules commented Jan 20, 2024

hcsch commented Feb 1, 2024 •

edited

K900 commented Feb 8, 2024

hcsch commented Feb 9, 2024

K900 left a comment

K900 commented Feb 26, 2024

nixos/pipewire: add configPackages options #282377

nixos/pipewire: add configPackages options #282377

Conversation

hcsch commented Jan 20, 2024

Description of changes

Things done

hcsch commented Jan 20, 2024

nixos-discourse commented Jan 20, 2024

hcsch commented Jan 20, 2024 • edited

hcsch commented Jan 20, 2024

tpwrules commented Jan 20, 2024

hcsch commented Feb 1, 2024 • edited

K900 commented Feb 8, 2024

hcsch commented Feb 9, 2024

K900 left a comment

Choose a reason for hiding this comment

K900 commented Feb 26, 2024

hcsch commented Jan 20, 2024 •

edited

hcsch commented Feb 1, 2024 •

edited