]> code.delx.au - pulseaudio/blob - src/modules/module-device-restore.c
don't restore mute/volume when already set
[pulseaudio] / src / modules / module-device-restore.c
1 /***
2 This file is part of PulseAudio.
3
4 Copyright 2006-2008 Lennart Poettering
5
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.
10
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.
15
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
19 USA.
20 ***/
21
22 #ifdef HAVE_CONFIG_H
23 #include <config.h>
24 #endif
25
26 #include <unistd.h>
27 #include <string.h>
28 #include <errno.h>
29 #include <sys/types.h>
30 #include <stdio.h>
31 #include <stdlib.h>
32 #include <ctype.h>
33 #include <gdbm.h>
34
35 #include <pulse/xmalloc.h>
36 #include <pulse/volume.h>
37 #include <pulse/timeval.h>
38 #include <pulse/util.h>
39
40 #include <pulsecore/core-error.h>
41 #include <pulsecore/module.h>
42 #include <pulsecore/core-util.h>
43 #include <pulsecore/modargs.h>
44 #include <pulsecore/log.h>
45 #include <pulsecore/core-subscribe.h>
46 #include <pulsecore/sink-input.h>
47 #include <pulsecore/source-output.h>
48 #include <pulsecore/namereg.h>
49
50 #include "module-device-restore-symdef.h"
51
52 PA_MODULE_AUTHOR("Lennart Poettering");
53 PA_MODULE_DESCRIPTION("Automatically restore the volume/mute state of devices");
54 PA_MODULE_VERSION(PACKAGE_VERSION);
55 PA_MODULE_LOAD_ONCE(TRUE);
56
57 #define SAVE_INTERVAL 10
58
59 static const char* const valid_modargs[] = {
60 "restore_volume",
61 "restore_muted",
62 NULL
63 };
64
65 struct userdata {
66 pa_core *core;
67 pa_module *module;
68 pa_subscription *subscription;
69 pa_hook_slot
70 *sink_fixate_hook_slot,
71 *source_fixate_hook_slot;
72 pa_time_event *save_time_event;
73 GDBM_FILE gdbm_file;
74
75 pa_bool_t restore_volume:1;
76 pa_bool_t restore_muted:1;
77 };
78
79 struct entry {
80 pa_channel_map channel_map;
81 pa_cvolume volume;
82 pa_bool_t muted:1;
83 };
84
85 static void save_time_callback(pa_mainloop_api*a, pa_time_event* e, const struct timeval *tv, void *userdata) {
86 struct userdata *u = userdata;
87
88 pa_assert(a);
89 pa_assert(e);
90 pa_assert(tv);
91 pa_assert(u);
92
93 pa_assert(e == u->save_time_event);
94 u->core->mainloop->time_free(u->save_time_event);
95 u->save_time_event = NULL;
96
97 gdbm_sync(u->gdbm_file);
98 pa_log_info("Synced.");
99 }
100
101 static struct entry* read_entry(struct userdata *u, const char *name) {
102 datum key, data;
103 struct entry *e;
104
105 pa_assert(u);
106 pa_assert(name);
107
108 key.dptr = (char*) name;
109 key.dsize = (int) strlen(name);
110
111 data = gdbm_fetch(u->gdbm_file, key);
112
113 if (!data.dptr)
114 goto fail;
115
116 if (data.dsize != sizeof(struct entry)) {
117 pa_log_warn("Database contains entry for device %s of wrong size %lu != %lu", name, (unsigned long) data.dsize, (unsigned long) sizeof(struct entry));
118 goto fail;
119 }
120
121 e = (struct entry*) data.dptr;
122
123 if (!(pa_cvolume_valid(&e->volume))) {
124 pa_log_warn("Invalid volume stored in database for device %s", name);
125 goto fail;
126 }
127
128 if (!(pa_channel_map_valid(&e->channel_map))) {
129 pa_log_warn("Invalid channel map stored in database for device %s", name);
130 goto fail;
131 }
132
133 if (e->volume.channels != e->channel_map.channels) {
134 pa_log_warn("Volume and channel map don't match in database entry for device %s", name);
135 goto fail;
136 }
137
138 return e;
139
140 fail:
141
142 pa_xfree(data.dptr);
143 return NULL;
144 }
145
146 static void trigger_save(struct userdata *u) {
147 struct timeval tv;
148
149 if (u->save_time_event)
150 return;
151
152 pa_gettimeofday(&tv);
153 tv.tv_sec += SAVE_INTERVAL;
154 u->save_time_event = u->core->mainloop->time_new(u->core->mainloop, &tv, save_time_callback, u);
155 }
156
157 static void subscribe_callback(pa_core *c, pa_subscription_event_type_t t, uint32_t idx, void *userdata) {
158 struct userdata *u = userdata;
159 struct entry entry, *old;
160 char *name;
161 datum key, data;
162
163 pa_assert(c);
164 pa_assert(u);
165
166 if (t != (PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_NEW) &&
167 t != (PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_CHANGE) &&
168 t != (PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_NEW) &&
169 t != (PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE))
170 return;
171
172 memset(&entry, 0, sizeof(entry));
173
174 if ((t & PA_SUBSCRIPTION_EVENT_FACILITY_MASK) == PA_SUBSCRIPTION_EVENT_SINK) {
175 pa_sink *sink;
176
177 if (!(sink = pa_idxset_get_by_index(c->sinks, idx)))
178 return;
179
180 name = pa_sprintf_malloc("sink:%s", sink->name);
181 entry.channel_map = sink->channel_map;
182 entry.volume = *pa_sink_get_volume(sink, FALSE);
183 entry.muted = pa_sink_get_mute(sink, FALSE);
184
185 } else {
186 pa_source *source;
187
188 pa_assert((t & PA_SUBSCRIPTION_EVENT_FACILITY_MASK) == PA_SUBSCRIPTION_EVENT_SOURCE);
189
190 if (!(source = pa_idxset_get_by_index(c->sources, idx)))
191 return;
192
193 name = pa_sprintf_malloc("source:%s", source->name);
194 entry.channel_map = source->channel_map;
195 entry.volume = *pa_source_get_volume(source, FALSE);
196 entry.muted = pa_source_get_mute(source, FALSE);
197 }
198
199 if ((old = read_entry(u, name))) {
200
201 if (pa_cvolume_equal(pa_cvolume_remap(&old->volume, &old->channel_map, &entry.channel_map), &entry.volume) &&
202 !old->muted == !entry.muted) {
203
204 pa_xfree(old);
205 pa_xfree(name);
206 return;
207 }
208
209 pa_xfree(old);
210 }
211
212 key.dptr = name;
213 key.dsize = (int) strlen(name);
214
215 data.dptr = (void*) &entry;
216 data.dsize = sizeof(entry);
217
218 pa_log_info("Storing volume/mute for device %s.", name);
219
220 gdbm_store(u->gdbm_file, key, data, GDBM_REPLACE);
221
222 pa_xfree(name);
223
224 trigger_save(u);
225 }
226
227 static pa_hook_result_t sink_fixate_hook_callback(pa_core *c, pa_sink_new_data *new_data, struct userdata *u) {
228 char *name;
229 struct entry *e;
230
231 pa_assert(new_data);
232
233 name = pa_sprintf_malloc("sink:%s", new_data->name);
234
235 if ((e = read_entry(u, name))) {
236
237 if (u->restore_volume) {
238
239 if (!new_data->volume_is_set) {
240 pa_log_info("Restoring volume for sink %s.", new_data->name);
241 pa_sink_new_data_set_volume(new_data, pa_cvolume_remap(&e->volume, &e->channel_map, &new_data->channel_map));
242 } else
243 pa_log_debug("Not restoring volume for sink %s, because already set.", new_data->name);
244
245 }
246
247 if (u->restore_muted) {
248
249 if (!new_data->muted_is_set) {
250 pa_log_info("Restoring mute state for sink %s.", new_data->name);
251 pa_sink_new_data_set_muted(new_data, e->muted);
252 } else
253 pa_log_debug("Not restoring mute state for sink %s, because already set.", new_data->name);
254 }
255
256 pa_xfree(e);
257 }
258
259 pa_xfree(name);
260
261 return PA_HOOK_OK;
262 }
263
264 static pa_hook_result_t source_fixate_hook_callback(pa_core *c, pa_source_new_data *new_data, struct userdata *u) {
265 char *name;
266 struct entry *e;
267
268 pa_assert(new_data);
269
270 name = pa_sprintf_malloc("source:%s", new_data->name);
271
272 if ((e = read_entry(u, name))) {
273
274 if (u->restore_volume) {
275
276 if (!new_data->volume_is_set) {
277 pa_log_info("Restoring volume for source %s.", new_data->name);
278 pa_source_new_data_set_volume(new_data, pa_cvolume_remap(&e->volume, &e->channel_map, &new_data->channel_map));
279 } else
280 pa_log_debug("Not restoring volume for source %s, because already set.", new_data->name);
281 }
282
283 if (u->restore_muted) {
284
285 if (!new_data->muted_is_set) {
286 pa_log_info("Restoring mute state for source %s.", new_data->name);
287 pa_source_new_data_set_muted(new_data, e->muted);
288 } else
289 pa_log_debug("Not restoring mute state for source %s, because already set.", new_data->name);
290 }
291
292 pa_xfree(e);
293 }
294
295 pa_xfree(name);
296
297 return PA_HOOK_OK;
298 }
299
300 int pa__init(pa_module*m) {
301 pa_modargs *ma = NULL;
302 struct userdata *u;
303 char *fname, *fn;
304 pa_sink *sink;
305 pa_source *source;
306 uint32_t idx;
307 pa_bool_t restore_volume = TRUE, restore_muted = TRUE;
308 int gdbm_cache_size;
309
310 pa_assert(m);
311
312 if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
313 pa_log("Failed to parse module arguments");
314 goto fail;
315 }
316
317 if (pa_modargs_get_value_boolean(ma, "restore_volume", &restore_volume) < 0 ||
318 pa_modargs_get_value_boolean(ma, "restore_muted", &restore_muted) < 0) {
319 pa_log("restore_volume= and restore_muted= expect boolean arguments");
320 goto fail;
321 }
322
323 if (!restore_muted && !restore_volume)
324 pa_log_warn("Neither restoring volume nor restoring muted enabled!");
325
326 m->userdata = u = pa_xnew(struct userdata, 1);
327 u->core = m->core;
328 u->module = m;
329 u->save_time_event = NULL;
330 u->restore_volume = restore_volume;
331 u->restore_muted = restore_muted;
332 u->gdbm_file = NULL;
333
334 u->subscription = pa_subscription_new(m->core, PA_SUBSCRIPTION_MASK_SINK|PA_SUBSCRIPTION_MASK_SOURCE, subscribe_callback, u);
335
336 if (restore_muted || restore_volume) {
337 u->sink_fixate_hook_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_FIXATE], PA_HOOK_EARLY, (pa_hook_cb_t) sink_fixate_hook_callback, u);
338 u->source_fixate_hook_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SOURCE_FIXATE], PA_HOOK_EARLY, (pa_hook_cb_t) source_fixate_hook_callback, u);
339 }
340
341 /* We include the host identifier in the file name because gdbm
342 * files are CPU dependant, and we don't want things to go wrong
343 * if we are on a multiarch system. */
344
345 fn = pa_sprintf_malloc("device-volumes."CANONICAL_HOST".gdbm");
346 fname = pa_state_path(fn, TRUE);
347 pa_xfree(fn);
348
349 if (!fname)
350 goto fail;
351
352 if (!(u->gdbm_file = gdbm_open(fname, 0, GDBM_WRCREAT|GDBM_NOLOCK, 0600, NULL))) {
353 pa_log("Failed to open volume database '%s': %s", fname, gdbm_strerror(gdbm_errno));
354 pa_xfree(fname);
355 goto fail;
356 }
357
358 /* By default the cache of gdbm is rather large, let's reduce it a bit to save memory */
359 gdbm_cache_size = 10;
360 gdbm_setopt(u->gdbm_file, GDBM_CACHESIZE, &gdbm_cache_size, sizeof(gdbm_cache_size));
361
362 pa_log_info("Sucessfully opened database file '%s'.", fname);
363 pa_xfree(fname);
364
365 for (sink = pa_idxset_first(m->core->sinks, &idx); sink; sink = pa_idxset_next(m->core->sinks, &idx))
366 subscribe_callback(m->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_NEW, sink->index, u);
367
368 for (source = pa_idxset_first(m->core->sources, &idx); source; source = pa_idxset_next(m->core->sources, &idx))
369 subscribe_callback(m->core, PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_NEW, source->index, u);
370
371 pa_modargs_free(ma);
372 return 0;
373
374 fail:
375 pa__done(m);
376
377 if (ma)
378 pa_modargs_free(ma);
379
380 return -1;
381 }
382
383 void pa__done(pa_module*m) {
384 struct userdata* u;
385
386 pa_assert(m);
387
388 if (!(u = m->userdata))
389 return;
390
391 if (u->subscription)
392 pa_subscription_free(u->subscription);
393
394 if (u->sink_fixate_hook_slot)
395 pa_hook_slot_free(u->sink_fixate_hook_slot);
396 if (u->source_fixate_hook_slot)
397 pa_hook_slot_free(u->source_fixate_hook_slot);
398
399 if (u->save_time_event)
400 u->core->mainloop->time_free(u->save_time_event);
401
402 if (u->gdbm_file)
403 gdbm_close(u->gdbm_file);
404
405 pa_xfree(u);
406 }