commit 72ed33777c6b6bc797b2b3e11ea127424dd95693 · pyrox.dev/nixpkgs

+159 -24
nixos/modules/services/desktops/pipewire/wireplumber.nix
···

       1
       1
        
       { config, lib, pkgs, ... }:

     

       2
       2
        
       

     

       3
       3
        
       let

     

       4
       4
       -
         inherit (builtins) attrNames concatMap length;

     

       4
       4
       +
         inherit (builtins) concatMap;

     

       5
       5
        
         inherit (lib) maintainers;

     

       6
       6
       -
         inherit (lib.attrsets) attrByPath filterAttrs;

     

       6
       6
       +
         inherit (lib.attrsets) attrByPath mapAttrsToList;

     

       7
       7
        
         inherit (lib.lists) flatten optional;

     

       8
       8
        
         inherit (lib.modules) mkIf;

     

       9
       9
        
         inherit (lib.options) literalExpression mkOption;

     

       10
       10
       -
         inherit (lib.strings) hasPrefix;

     

       11
       11
       -
         inherit (lib.types) bool listOf package;

     

       10
       10
       +
         inherit (lib.strings) concatStringsSep makeSearchPath;

     

       11
       11
       +
         inherit (lib.types) bool listOf attrsOf package lines;

     

       12
       12
       +
         inherit (lib.path) subpath;

     

       12
       13
        
       

     

       13
       14
        
         pwCfg = config.services.pipewire;

     

       14
       15
        
         cfg = pwCfg.wireplumber;

     

       15
       16
        
         pwUsedForAudio = pwCfg.audio.enable;

     

       17
       17
       +
       

     

       18
       18
       +
         json = pkgs.formats.json { };

     

       19
       19
       +
       

     

       20
       20
       +
         configSectionsToConfFile = path: value:

     

       21
       21
       +
           pkgs.writeTextDir

     

       22
       22
       +
             path

     

       23
       23
       +
             (concatStringsSep "\n" (

     

       24
       24
       +
               mapAttrsToList

     

       25
       25
       +
                 (section: content: "${section} = " + (builtins.toJSON content))

     

       26
       26
       +
                 value

     

       27
       27
       +
             ));

     

       28
       28
       +
       

     

       29
       29
       +
         mapConfigToFiles = config:

     

       30
       30
       +
           mapAttrsToList

     

       31
       31
       +
             (name: value: configSectionsToConfFile "share/wireplumber/wireplumber.conf.d/${name}.conf" value)

     

       32
       32
       +
             config;

     

       33
       33
       +
       

     

       34
       34
       +
         mapScriptsToFiles = scripts:

     

       35
       35
       +
           mapAttrsToList

     

       36
       36
       +
             (relativePath: value: pkgs.writeTextDir (subpath.join ["share/wireplumber/scripts" relativePath]) value)

     

       37
       37
       +
             scripts;

     

       16
       38
        
       in

     

       17
       39
        
       {

     

       18
       40
        
         meta.maintainers = [ maintainers.k900 ];

     
···

       33
       55
        
               description = "The WirePlumber derivation to use.";

     

       34
       56
        
             };

     

       35
       57
        
       

     

       58
       58
       +
             extraConfig = mkOption {

     

       59
       59
       +
               # Two layer attrset is necessary before using JSON, because of the whole

     

       60
       60
       +
               # config file not being a JSON object, but a concatenation of JSON objects

     

       61
       61
       +
               # in sections.

     

       62
       62
       +
               type = attrsOf (attrsOf json.type);

     

       63
       63
       +
               default = { };

     

       64
       64
       +
               example = literalExpression ''{

     

       65
       65
       +
                 "log-level-debug" = {

     

       66
       66
       +
                   "context.properties" = {

     

       67
       67
       +
                     # Output Debug log messages as opposed to only the default level (Notice)

     

       68
       68
       +
                     "log.level" = "D";

     

       69
       69
       +
                   };

     

       70
       70
       +
                 };

     

       71
       71
       +
                 "wh-1000xm3-ldac-hq" = {

     

       72
       72
       +
                   "monitor.bluez.rules" = [

     

       73
       73
       +
                     {

     

       74
       74
       +
                       matches = [

     

       75
       75
       +
                         {

     

       76
       76
       +
                           # Match any bluetooth device with ids equal to that of a WH-1000XM3

     

       77
       77
       +
                           "device.name" = "~bluez_card.*";

     

       78
       78
       +
                           "device.product.id" = "0x0cd3";

     

       79
       79
       +
                           "device.vendor.id" = "usb:054c";

     

       80
       80
       +
                         }

     

       81
       81
       +
                       ];

     

       82
       82
       +
                       actions = {

     

       83
       83
       +
                         update-props = {

     

       84
       84
       +
                           # Set quality to high quality instead of the default of auto

     

       85
       85
       +
                           "bluez5.a2dp.ldac.quality" = "hq";

     

       86
       86
       +
                         };

     

       87
       87
       +
                       };

     

       88
       88
       +
                     }

     

       89
       89
       +
                   ];

     

       90
       90
       +
                 };

     

       91
       91
       +
               }'';

     

       92
       92
       +
               description = ''

     

       93
       93
       +
                 Additional configuration for the WirePlumber daemon when run in

     

       94
       94
       +
                 single-instance mode (the default in nixpkgs and currently the only

     

       95
       95
       +
                 supported way to run WirePlumber configured via `extraConfig`).

     

       96
       96
       +
       

     

       97
       97
       +
                 See also:

     

       98
       98
       +
                 - [The configuration file][docs-the-conf-file]

     

       99
       99
       +
                 - [Modifying configuration][docs-modifying-config]

     

       100
       100
       +
                 - [Locations of files][docs-file-locations]

     

       101
       101
       +
                 - and the [configuration section][docs-config-section] of the docs in general

     

       102
       102
       +
       

     

       103
       103
       +
                 Note that WirePlumber (and PipeWire) use dotted attribute names like

     

       104
       104
       +
                 `device.product.id`. These are not nested, but flat objects for WirePlumber/PipeWire,

     

       105
       105
       +
                 so to write these in nix expressions, remember to quote them like `"device.product.id"`.

     

       106
       106
       +
                 Have a look at the example for this.

     

       107
       107
       +
       

     

       108
       108
       +
                 [docs-the-conf-file]: https://pipewire.pages.freedesktop.org/wireplumber/daemon/configuration/conf_file.html

     

       109
       109
       +
                 [docs-modifying-config]: https://pipewire.pages.freedesktop.org/wireplumber/daemon/configuration/modifying_configuration.html

     

       110
       110
       +
                 [docs-file-locations]: https://pipewire.pages.freedesktop.org/wireplumber/daemon/configuration/locations.html

     

       111
       111
       +
                 [docs-config-section]: https://pipewire.pages.freedesktop.org/wireplumber/daemon/configuration.html

     

       112
       112
       +
               '';

     

       113
       113
       +
             };

     

       114
       114
       +
       

     

       115
       115
       +
             extraScripts = mkOption {

     

       116
       116
       +
               type = attrsOf lines;

     

       117
       117
       +
               default = { };

     

       118
       118
       +
               example = {

     

       119
       119
       +
                 "test/hello-world.lua" = ''

     

       120
       120
       +
                   print("Hello, world!")

     

       121
       121
       +
                 '';

     

       122
       122
       +
               };

     

       123
       123
       +
               description = ''

     

       124
       124
       +
                 Additional scripts for WirePlumber to be used by configuration files.

     

       125
       125
       +
       

     

       126
       126
       +
                 Every item in this attrset becomes a separate lua file with the path

     

       127
       127
       +
                 relative to the `scripts` directory specified in the name of the item.

     

       128
       128
       +
                 The scripts get passed to the WirePlumber service via the `XDG_DATA_DIRS`

     

       129
       129
       +
                 variable. Scripts specified here are preferred over those shipped with

     

       130
       130
       +
                 WirePlumber if they occupy the same relative path.

     

       131
       131
       +
       

     

       132
       132
       +
                 For a script to be loaded, it needs to be specified as part of a component,

     

       133
       133
       +
                 and that component needs to be required by an active profile (e.g. `main`).

     

       134
       134
       +
                 Components can be defined in config files either via `extraConfig` or `configPackages`.

     

       135
       135
       +
       

     

       136
       136
       +
                 For the hello-world example, you'd have to add the following `extraConfig`:

     

       137
       137
       +
                 ```nix

     

       138
       138
       +
                   services.pipewire.wireplumber.extraConfig."99-hello-world" = {

     

       139
       139
       +
                     "wireplumber.components" = [

     

       140
       140
       +
                       {

     

       141
       141
       +
                         name = "test/hello-world.lua";

     

       142
       142
       +
                         type = "script/lua";

     

       143
       143
       +
                         provides = "custom.hello-world";

     

       144
       144
       +
                       }

     

       145
       145
       +
                     ];

     

       146
       146
       +
       

     

       147
       147
       +
                     "wireplumber.profiles" = {

     

       148
       148
       +
                       main = {

     

       149
       149
       +
                         "custom.hello-world" = "required";

     

       150
       150
       +
                       };

     

       151
       151
       +
                     };

     

       152
       152
       +
                   };

     

       153
       153
       +
                 ```

     

       154
       154
       +
       

     

       155
       155
       +
                 See also:

     

       156
       156
       +
                 - [Location of scripts][docs-file-locations-scripts]

     

       157
       157
       +
                 - [Components & Profiles][docs-components-profiles]

     

       158
       158
       +
                 - [Migration - Loading custom scripts][docs-migration-loading-custom-scripts]

     

       159
       159
       +
       

     

       160
       160
       +
                 [docs-file-locations-scripts]: https://pipewire.pages.freedesktop.org/wireplumber/daemon/locations.html#location-of-scripts

     

       161
       161
       +
                 [docs-components-profiles]: https://pipewire.pages.freedesktop.org/wireplumber/daemon/configuration/components_and_profiles.html

     

       162
       162
       +
                 [docs-migration-loading-custom-scripts]: https://pipewire.pages.freedesktop.org/wireplumber/daemon/configuration/migration.html#loading-custom-scripts

     

       163
       163
       +
               '';

     

       164
       164
       +
             };

     

       165
       165
       +
       

     

       36
       166
        
             configPackages = mkOption {

     

       37
       167
        
               type = listOf package;

     

       38
       168
        
               default = [ ];

     
···

       57
       187
        
       

     

       58
       188
        
             extraLv2Packages = mkOption {

     

       59
       189
        
               type = listOf package;

     

       60
       60
       -
               default = [];

     

       190
       190
       +
               default = [ ];

     

       61
       191
        
               example = literalExpression "[ pkgs.lsp-plugins ]";

     

       62
       192
        
               description = ''

     

       63
       193
        
                 List of packages that provide LV2 plugins in `lib/lv2` that should

     
···

       96
       226
        
               }

     

       97
       227
        
             '';

     

       98
       228
        
       

     

       229
       229
       +
             extraConfigPkg = pkgs.buildEnv {

     

       230
       230
       +
               name = "wireplumber-extra-config";

     

       231
       231
       +
               paths = mapConfigToFiles cfg.extraConfig;

     

       232
       232
       +
               pathsToLink = [ "/share/wireplumber/wireplumber.conf.d" ];

     

       233
       233
       +
             };

     

       234
       234
       +
       

     

       235
       235
       +
             extraScriptsPkg = pkgs.buildEnv {

     

       236
       236
       +
               name = "wireplumber-extra-scrips";

     

       237
       237
       +
               paths = mapScriptsToFiles cfg.extraScripts;

     

       238
       238
       +
               pathsToLink = [ "/share/wireplumber/scripts" ];

     

       239
       239
       +
             };

     

       240
       240
       +
       

     

       99
       241
        
             configPackages = cfg.configPackages

     

       100
       100
       -
                 ++ optional (!pwUsedForAudio) pwNotForAudioConfigPkg

     

       101
       101
       -
                 ++ optional pwCfg.systemWide systemwideConfigPkg;

     

       242
       242
       +
               ++ [ extraConfigPkg extraScriptsPkg ]

     

       243
       243
       +
               ++ optional (!pwUsedForAudio) pwNotForAudioConfigPkg

     

       244
       244
       +
               ++ optional pwCfg.systemWide systemwideConfigPkg;

     

       102
       245
        
       

     

       103
       246
        
             configs = pkgs.buildEnv {

     

       104
       247
        
               name = "wireplumber-configs";

     
···

       110
       253
        
               (

     

       111
       254
        
                 concatMap

     

       112
       255
        
                   (p:

     

       113
       113
       -
                     attrByPath ["passthru" "requiredLv2Packages"] [] p

     

       256
       256
       +
                     attrByPath [ "passthru" "requiredLv2Packages" ] [ ] p

     

       114
       257
        
                   )

     

       115
       258
        
                   configPackages

     

       116
       259
        
               );

     
···

       127
       270
        
                 assertion = !config.hardware.bluetooth.hsphfpd.enable;

     

       128
       271
        
                 message = "Using WirePlumber conflicts with hsphfpd, as it provides the same functionality. `hardware.bluetooth.hsphfpd.enable` needs be set to false";

     

       129
       272
        
               }

     

       130
       130
       -
               {

     

       131
       131
       -
                 assertion = length

     

       132
       132
       -
                   (attrNames

     

       133
       133
       -
                     (

     

       134
       134
       -
                       filterAttrs

     

       135
       135
       -
                         (name: value:

     

       136
       136
       -
                           hasPrefix "wireplumber/" name || name == "wireplumber"

     

       137
       137
       -
                         )

     

       138
       138
       -
                         config.environment.etc

     

       139
       139
       -
                     )) == 1;

     

       140
       140
       -
                 message = "Using `environment.etc.\"wireplumber<...>\"` directly is no longer supported in 24.05. Use `services.pipewire.wireplumber.configPackages` instead.";

     

       141
       141
       -
               }

     

       142
       273
        
             ];

     

       143
       274
        
       

     

       144
       275
        
             environment.systemPackages = [ cfg.package ];

     

       145
       276
        
       

     

       146
       146
       -
             environment.etc.wireplumber.source = "${configs}/share/wireplumber";

     

       147
       147
       -
       

     

       148
       277
        
             systemd.packages = [ cfg.package ];

     

       149
       278
        
       

     

       150
       279
        
             systemd.services.wireplumber.enable = pwCfg.systemWide;

     
···

       156
       285
        
             systemd.services.wireplumber.environment = mkIf pwCfg.systemWide {

     

       157
       286
        
               # Force WirePlumber to use system dbus.

     

       158
       287
        
               DBUS_SESSION_BUS_ADDRESS = "unix:path=/run/dbus/system_bus_socket";

     

       288
       288
       +
       

     

       289
       289
       +
               # Make WirePlumber find our config/script files and lv2 plugins required by those

     

       290
       290
       +
               # (but also the configs/scripts shipped with WirePlumber)

     

       291
       291
       +
               XDG_DATA_DIRS = makeSearchPath "share" [ configs cfg.package ];

     

       159
       292
        
               LV2_PATH = "${lv2Plugins}/lib/lv2";

     

       160
       293
        
             };

     

       161
       294
        
       

     

       162
       162
       -
             systemd.user.services.wireplumber.environment.LV2_PATH =

     

       163
       163
       -
               mkIf (!pwCfg.systemWide) "${lv2Plugins}/lib/lv2";

     

       295
       295
       +
             systemd.user.services.wireplumber.environment = mkIf (!pwCfg.systemWide) {

     

       296
       296
       +
               XDG_DATA_DIRS = makeSearchPath "share" [ configs cfg.package ];

     

       297
       297
       +
               LV2_PATH = "${lv2Plugins}/lib/lv2";

     

       298
       298
       +
             };

     

       164
       299
        
           };

     

       165
       300
        
       }