1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
|
;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2018, 2020 Oleg Pykhalov <go.wigust@gmail.com>
;;; Copyright © 2020 Liliana Marie Prikler <liliana.prikler@gmail.com>
;;; Copyright © 2020 Marius Bakke <mbakke@fastmail.com>
;;; Copyright © 2022 Maxim Cournoyer <maxim.cournoyer@gmail.com>
;;;
;;; This file is part of GNU Guix.
;;;
;;; GNU Guix is free software; you can redistribute it and/or modify it
;;; under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 3 of the License, or (at
;;; your option) any later version.
;;;
;;; GNU Guix is distributed in the hope that it will be useful, but
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;;; GNU General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
(define-module (gnu services sound)
#:use-module (gnu services base)
#:use-module (gnu services configuration)
#:use-module (gnu services shepherd)
#:use-module (gnu services)
#:use-module (gnu system pam)
#:use-module (gnu system shadow)
#:use-module (guix diagnostics)
#:use-module (guix gexp)
#:use-module (guix packages)
#:use-module (guix records)
#:use-module (guix store)
#:use-module (guix ui)
#:use-module (gnu packages audio)
#:use-module (gnu packages linux)
#:use-module (gnu packages pulseaudio)
#:use-module (ice-9 match)
#:use-module (srfi srfi-1)
#:export (alsa-configuration
alsa-configuration?
alsa-configuration-alsa-plugins
alsa-configuration-pulseaudio?
alsa-configuration-extra-options
alsa-service-type
pulseaudio-configuration
pulseaudio-configuration?
pulseaudio-configuration-client-conf
pulseaudio-configuration-daemon-conf
pulseaudio-configuration-script-file
pulseaudio-configuration-extra-script-files
pulseaudio-configuration-system-script-file
pulseaudio-service-type
ladspa-configuration
ladspa-configuration?
ladspa-configuration-plugins
ladspa-service-type))
;;; Commentary:
;;;
;;; Sound services.
;;;
;;; Code:
;;;
;;; ALSA
;;;
(define-record-type* <alsa-configuration>
alsa-configuration make-alsa-configuration alsa-configuration?
(alsa-plugins alsa-configuration-alsa-plugins ;file-like
(default alsa-plugins))
(pulseaudio? alsa-configuration-pulseaudio? ;boolean
(default #t))
(extra-options alsa-configuration-extra-options ;string
(default "")))
(define alsa-config-file
;; Return the ALSA configuration file.
(match-lambda
(($ <alsa-configuration> alsa-plugins pulseaudio? extra-options)
(apply mixed-text-file "asound.conf"
`("# Generated by 'alsa-service'.\n\n"
,@(if pulseaudio?
`("# Use PulseAudio by default
pcm_type.pulse {
lib \"" ,#~(string-append #$alsa-plugins:pulseaudio
"/lib/alsa-lib/libasound_module_pcm_pulse.so") "\"
}
ctl_type.pulse {
lib \"" ,#~(string-append #$alsa-plugins:pulseaudio
"/lib/alsa-lib/libasound_module_ctl_pulse.so") "\"
}
pcm.!default {
type pulse
fallback \"sysdefault\"
hint {
show on
description \"Default ALSA Output (currently PulseAudio Sound Server)\"
}
}
ctl.!default {
type pulse
fallback \"sysdefault\"
}\n\n")
'())
,extra-options)))))
(define (alsa-etc-service config)
(list `("asound.conf" ,(alsa-config-file config))))
(define alsa-service-type
(service-type
(name 'alsa)
(extensions
(list (service-extension etc-service-type alsa-etc-service)))
(default-value (alsa-configuration))
(description "Configure low-level Linux sound support, ALSA.")))
;;;
;;; PulseAudio
;;;
(define-record-type* <pulseaudio-configuration>
pulseaudio-configuration make-pulseaudio-configuration
pulseaudio-configuration?
(client-conf pulseaudio-configuration-client-conf
(default '()))
(daemon-conf pulseaudio-configuration-daemon-conf
;; Flat volumes may cause unpleasant experiences to users
;; when applications inadvertently max out the system volume
;; (see e.g. <https://bugs.gnu.org/38172>).
(default '((flat-volumes . no))))
(script-file pulseaudio-configuration-script-file
(default (file-append pulseaudio "/etc/pulse/default.pa")))
(extra-script-files pulseaudio-configuration-extra-script-files
(default '()))
(system-script-file pulseaudio-configuration-system-script-file
(default
(file-append pulseaudio "/etc/pulse/system.pa"))))
(define (pulseaudio-conf-entry arg)
(match arg
((key . value)
(format #f "~a = ~s~%" key value))
((? string? _)
(string-append arg "\n"))))
(define pulseaudio-environment
(match-lambda
(($ <pulseaudio-configuration> client-conf daemon-conf default-script-file)
;; These config files kept at a fixed location, so that the following
;; environment values are stable and do not require the user to reboot to
;; effect their PulseAudio configuration changes.
'(("PULSE_CONFIG" . "/etc/pulse/daemon.conf")
("PULSE_CLIENTCONFIG" . "/etc/pulse/client.conf")))))
(define (extra-script-files->file-union extra-script-files)
"Return a G-exp obtained by processing EXTRA-SCRIPT-FILES with FILE-UNION."
(define (file-like->name file)
(match file
((? local-file?)
(local-file-name file))
((? plain-file?)
(plain-file-name file))
((? computed-file?)
(computed-file-name file))
(_ (leave (G_ "~a is not a local-file, plain-file or \
computed-file object~%") file))))
(define (assert-pulseaudio-script-file-name name)
(unless (string-suffix? ".pa" name)
(leave (G_ "`~a' lacks the required `.pa' file name extension~%") name))
name)
(let ((labels (map (compose assert-pulseaudio-script-file-name
file-like->name)
extra-script-files)))
(file-union "default.pa.d" (zip labels extra-script-files))))
(define (append-include-directive script-file)
"Append an include directive to source scripts under /etc/pulse/default.pa.d."
(computed-file "default.pa"
#~(begin
(use-modules (ice-9 textual-ports))
(define script-text
(call-with-input-file #$script-file get-string-all))
(call-with-output-file #$output
(lambda (port)
(format port (string-append script-text "
### Added by Guix to include scripts specified in extra-script-files.
.nofail
.include /etc/pulse/default.pa.d~%")))))))
(define pulseaudio-etc
(match-lambda
(($ <pulseaudio-configuration> client-conf daemon-conf default-script-file
extra-script-files system-script-file)
`(("pulse"
,(file-union
"pulse"
`(("default.pa"
,(if (null? extra-script-files)
default-script-file
(append-include-directive default-script-file)))
("system.pa" ,system-script-file)
,@(if (null? extra-script-files)
'()
`(("default.pa.d" ,(extra-script-files->file-union
extra-script-files))))
("daemon.conf"
,(apply mixed-text-file "daemon.conf"
"default-script-file = /etc/pulse/default.pa\n"
(map pulseaudio-conf-entry daemon-conf)))
("client.conf"
,(apply mixed-text-file "client.conf"
(map pulseaudio-conf-entry client-conf))))))))))
(define pulseaudio-service-type
(service-type
(name 'pulseaudio)
(extensions
(list (service-extension session-environment-service-type
pulseaudio-environment)
(service-extension etc-service-type pulseaudio-etc)
(service-extension udev-service-type (const (list pulseaudio)))))
(default-value (pulseaudio-configuration))
(description "Configure PulseAudio sound support.")))
;;;
;;; LADSPA
;;;
(define-record-type* <ladspa-configuration>
ladspa-configuration make-ladspa-configuration
ladspa-configuration?
(plugins ladspa-configuration-plugins (default '())))
(define (ladspa-environment config)
;; Define this variable in the global environment such that
;; pulseaudio swh-plugins (and similar LADSPA plugins) work.
`(("LADSPA_PATH" .
(string-join
',(map (lambda (package) (file-append package "/lib/ladspa"))
(ladspa-configuration-plugins config))
":"))))
(define ladspa-service-type
(service-type
(name 'ladspa)
(extensions
(list (service-extension session-environment-service-type
ladspa-environment)))
(default-value (ladspa-configuration))
(description "Configure LADSPA plugins.")))
;;; sound.scm ends here
|