4 This file is part of PulseAudio.
6 PulseAudio is free software; you can redistribute it and/or modify
7 it under the terms of the GNU Lesser General Public License as published
8 by the Free Software Foundation; either version 2 of the License,
9 or (at your option) any later version.
11 PulseAudio is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public License
17 along with PulseAudio; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
30 #include <sys/types.h>
35 #include <pulse/xmalloc.h>
37 #include <pulsecore/core-error.h>
38 #include <pulsecore/module.h>
39 #include <pulsecore/core-util.h>
40 #include <pulsecore/modargs.h>
41 #include <pulsecore/log.h>
42 #include <pulsecore/core-subscribe.h>
43 #include <pulsecore/sink-input.h>
44 #include <pulsecore/core-util.h>
45 #include <pulse/volume.h>
47 #include "module-volume-restore-symdef.h"
49 PA_MODULE_AUTHOR("Lennart Poettering")
50 PA_MODULE_DESCRIPTION("Playback stream automatic volume restore module")
51 PA_MODULE_USAGE("table=<filename>")
52 PA_MODULE_VERSION(PACKAGE_VERSION
)
54 #define WHITESPACE "\n\r \t"
56 #define DEFAULT_VOLUME_TABLE_FILE ".pulse/volume.table"
58 static const char* const valid_modargs
[] = {
70 pa_subscription
*subscription
;
75 static pa_cvolume
* parse_volume(const char *s
, pa_cvolume
*v
) {
87 if (k
<= 0 || k
> PA_CHANNELS_MAX
)
90 v
->channels
= (unsigned) k
;
92 for (i
= 0; i
< v
->channels
; i
++) {
93 p
+= strspn(p
, WHITESPACE
);
100 if (k
< PA_VOLUME_MUTED
)
103 v
->values
[i
] = (pa_volume_t
) k
;
112 static int load_rules(struct userdata
*u
) {
116 char buf_name
[256], buf_volume
[256];
120 fopen(u
->table_file
, "r") :
121 pa_open_config_file(NULL
, DEFAULT_VOLUME_TABLE_FILE
, NULL
, &u
->table_file
, "r");
124 if (errno
== ENOENT
) {
125 pa_log_info(__FILE__
": starting with empty ruleset.");
128 pa_log(__FILE__
": failed to open file '%s': %s", u
->table_file
, pa_cstrerror(errno
));
133 pa_lock_fd(fileno(f
), 1);
139 if (!fgets(ln
, sizeof(buf_name
), f
))
146 if (ln
[0] == '#' || !*ln
)
149 if (ln
== buf_name
) {
154 assert(ln
== buf_volume
);
156 if (!parse_volume(buf_volume
, &v
)) {
157 pa_log(__FILE__
": parse failure in %s:%u, stopping parsing", u
->table_file
, n
);
163 if (pa_hashmap_get(u
->hashmap
, buf_name
)) {
164 pa_log(__FILE__
": double entry in %s:%u, ignoring", u
->table_file
, n
);
168 rule
= pa_xnew(struct rule
, 1);
169 rule
->name
= pa_xstrdup(buf_name
);
172 pa_hashmap_put(u
->hashmap
, rule
->name
, rule
);
175 if (ln
== buf_volume
) {
176 pa_log(__FILE__
": invalid number of lines in %s.", u
->table_file
);
184 pa_lock_fd(fileno(f
), 0);
191 static int save_rules(struct userdata
*u
) {
198 fopen(u
->table_file
, "w") :
199 pa_open_config_file(NULL
, DEFAULT_VOLUME_TABLE_FILE
, NULL
, &u
->table_file
, "w");
202 pa_log(__FILE__
": failed to open file '%s': %s", u
->table_file
, pa_cstrerror(errno
));
206 pa_lock_fd(fileno(f
), 1);
208 while ((rule
= pa_hashmap_iterate(u
->hashmap
, &state
, NULL
))) {
211 fprintf(f
, "%s\n%u", rule
->name
, rule
->volume
.channels
);
213 for (i
= 0; i
< rule
->volume
.channels
; i
++)
214 fprintf(f
, " %u", rule
->volume
.values
[i
]);
223 pa_lock_fd(fileno(f
), 0);
230 static char* client_name(pa_client
*c
) {
233 if (!c
->name
|| !c
->driver
)
236 t
= pa_sprintf_malloc("%s$%s", c
->driver
, c
->name
);
237 t
[strcspn(t
, "\n\r#")] = 0;
242 if ((e
= strrchr(t
, '('))) {
243 char *k
= e
+ 1 + strspn(e
+ 1, "0123456789-");
245 /* Dirty trick: truncate all trailing parens with numbers in
246 * between, since they are usually used to identify multiple
247 * sessions of the same application, which is something we
248 * explicitly don't want. Besides other stuff this makes xmms
249 * with esound work properly for us. */
251 if (*k
== ')' && *(k
+1) == 0)
258 static void callback(pa_core
*c
, pa_subscription_event_type_t t
, uint32_t idx
, void *userdata
) {
259 struct userdata
*u
= userdata
;
267 if (t
!= (PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_NEW
) &&
268 t
!= (PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
))
271 if (!(si
= pa_idxset_get_by_index(c
->sink_inputs
, idx
)))
274 if (!si
->client
|| !(name
= client_name(si
->client
)))
277 if ((r
= pa_hashmap_get(u
->hashmap
, name
))) {
280 if (((t
& PA_SUBSCRIPTION_EVENT_TYPE_MASK
) == PA_SUBSCRIPTION_EVENT_NEW
) && si
->sample_spec
.channels
== r
->volume
.channels
) {
281 pa_log_info(__FILE__
": Restoring volume for <%s>", r
->name
);
282 pa_sink_input_set_volume(si
, &r
->volume
);
283 } else if (!pa_cvolume_equal(pa_sink_input_get_volume(si
), &r
->volume
)) {
284 pa_log_info(__FILE__
": Saving volume for <%s>", r
->name
);
285 r
->volume
= *pa_sink_input_get_volume(si
);
290 pa_log_info(__FILE__
": Creating new entry for <%s>", name
);
292 r
= pa_xnew(struct rule
, 1);
294 r
->volume
= *pa_sink_input_get_volume(si
);
295 pa_hashmap_put(u
->hashmap
, r
->name
, r
);
301 int pa__init(pa_core
*c
, pa_module
*m
) {
302 pa_modargs
*ma
= NULL
;
308 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
309 pa_log(__FILE__
": Failed to parse module arguments");
313 u
= pa_xnew(struct userdata
, 1);
314 u
->hashmap
= pa_hashmap_new(pa_idxset_string_hash_func
, pa_idxset_string_compare_func
);
315 u
->subscription
= NULL
;
316 u
->table_file
= pa_xstrdup(pa_modargs_get_value(ma
, "table", NULL
));
321 if (load_rules(u
) < 0)
324 u
->subscription
= pa_subscription_new(c
, PA_SUBSCRIPTION_MASK_SINK_INPUT
, callback
, u
);
338 static void free_func(void *p
, void *userdata
) {
346 void pa__done(pa_core
*c
, pa_module
*m
) {
352 if (!(u
= m
->userdata
))
356 pa_subscription_free(u
->subscription
);
363 pa_hashmap_free(u
->hashmap
, free_func
, NULL
);
366 pa_xfree(u
->table_file
);