2 This file is part of PulseAudio.
4 Copyright 2006-2008 Lennart Poettering
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
29 #include <sys/types.h>
35 #include <pulse/xmalloc.h>
36 #include <pulse/volume.h>
37 #include <pulse/timeval.h>
38 #include <pulse/util.h>
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>
50 #include "module-device-restore-symdef.h"
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
);
57 #define SAVE_INTERVAL 10
59 static const char* const valid_modargs
[] = {
68 pa_subscription
*subscription
;
70 *sink_fixate_hook_slot
,
71 *source_fixate_hook_slot
;
72 pa_time_event
*save_time_event
;
75 pa_bool_t restore_volume
:1;
76 pa_bool_t restore_muted
:1;
80 pa_channel_map channel_map
;
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
;
93 pa_assert(e
== u
->save_time_event
);
94 u
->core
->mainloop
->time_free(u
->save_time_event
);
95 u
->save_time_event
= NULL
;
97 gdbm_sync(u
->gdbm_file
);
98 pa_log_info("Synced.");
101 static struct entry
* read_entry(struct userdata
*u
, char *name
) {
109 key
.dsize
= (int) strlen(name
);
111 data
= gdbm_fetch(u
->gdbm_file
, key
);
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
));
121 e
= (struct entry
*) data
.dptr
;
123 if (!(pa_cvolume_valid(&e
->volume
))) {
124 pa_log_warn("Invalid volume stored in database for device %s", name
);
128 if (!(pa_channel_map_valid(&e
->channel_map
))) {
129 pa_log_warn("Invalid channel map stored in database for device %s", name
);
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
);
146 static void trigger_save(struct userdata
*u
) {
149 if (u
->save_time_event
)
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
);
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
;
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
))
172 memset(&entry
, 0, sizeof(entry
));
174 if ((t
& PA_SUBSCRIPTION_EVENT_FACILITY_MASK
) == PA_SUBSCRIPTION_EVENT_SINK
) {
177 if (!(sink
= pa_idxset_get_by_index(c
->sinks
, idx
)))
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
);
188 pa_assert((t
& PA_SUBSCRIPTION_EVENT_FACILITY_MASK
) == PA_SUBSCRIPTION_EVENT_SOURCE
);
190 if (!(source
= pa_idxset_get_by_index(c
->sources
, idx
)))
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
);
199 if ((old
= read_entry(u
, name
))) {
201 if (pa_cvolume_equal(pa_cvolume_remap(&old
->volume
, &old
->channel_map
, &entry
.channel_map
), &entry
.volume
) &&
202 !old
->muted
== !entry
.muted
) {
213 key
.dsize
= (int) strlen(name
);
215 data
.dptr
= (void*) &entry
;
216 data
.dsize
= sizeof(entry
);
218 pa_log_info("Storing volume/mute for device %s.", name
);
220 gdbm_store(u
->gdbm_file
, key
, data
, GDBM_REPLACE
);
227 static pa_hook_result_t
sink_fixate_hook_callback(pa_core
*c
, pa_sink_new_data
*new_data
, struct userdata
*u
) {
233 name
= pa_sprintf_malloc("sink:%s", new_data
->name
);
235 if ((e
= read_entry(u
, name
))) {
237 if (u
->restore_volume
) {
238 pa_log_info("Restoring volume for sink %s.", new_data
->name
);
239 pa_sink_new_data_set_volume(new_data
, pa_cvolume_remap(&e
->volume
, &e
->channel_map
, &new_data
->channel_map
));
242 if (u
->restore_muted
) {
243 pa_log_info("Restoring mute state for sink %s.", new_data
->name
);
244 pa_sink_new_data_set_muted(new_data
, e
->muted
);
255 static pa_hook_result_t
source_fixate_hook_callback(pa_core
*c
, pa_source_new_data
*new_data
, struct userdata
*u
) {
261 name
= pa_sprintf_malloc("source:%s", new_data
->name
);
263 if ((e
= read_entry(u
, name
))) {
265 if (u
->restore_volume
) {
266 pa_log_info("Restoring volume for source %s.", new_data
->name
);
267 pa_source_new_data_set_volume(new_data
, pa_cvolume_remap(&e
->volume
, &e
->channel_map
, &new_data
->channel_map
));
270 if (u
->restore_muted
) {
271 pa_log_info("Restoring mute state for source %s.", new_data
->name
);
272 pa_source_new_data_set_muted(new_data
, e
->muted
);
283 int pa__init(pa_module
*m
) {
284 pa_modargs
*ma
= NULL
;
290 pa_bool_t restore_volume
= TRUE
, restore_muted
= TRUE
;
295 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
296 pa_log("Failed to parse module arguments");
300 if (pa_modargs_get_value_boolean(ma
, "restore_volume", &restore_volume
) < 0 ||
301 pa_modargs_get_value_boolean(ma
, "restore_muted", &restore_muted
) < 0) {
302 pa_log("restore_volume= and restore_muted= expect boolean arguments");
306 if (!restore_muted
&& !restore_volume
)
307 pa_log_warn("Neither restoring volume nor restoring muted enabled!");
309 m
->userdata
= u
= pa_xnew(struct userdata
, 1);
312 u
->save_time_event
= NULL
;
313 u
->restore_volume
= restore_volume
;
314 u
->restore_muted
= restore_muted
;
317 u
->subscription
= pa_subscription_new(m
->core
, PA_SUBSCRIPTION_MASK_SINK
|PA_SUBSCRIPTION_MASK_SOURCE
, subscribe_callback
, u
);
319 if (restore_muted
|| restore_volume
) {
320 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
);
321 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
);
324 /* We include the host identifier in the file name because gdbm
325 * files are CPU dependant, and we don't want things to go wrong
326 * if we are on a multiarch system. */
328 fn
= pa_sprintf_malloc("device-volumes."CANONICAL_HOST
".gdbm");
329 fname
= pa_state_path(fn
, TRUE
);
335 if (!(u
->gdbm_file
= gdbm_open(fname
, 0, GDBM_WRCREAT
|GDBM_NOLOCK
, 0600, NULL
))) {
336 pa_log("Failed to open volume database '%s': %s", fname
, gdbm_strerror(gdbm_errno
));
341 /* By default the cache of gdbm is rather large, let's reduce it a bit to save memory */
342 gdbm_cache_size
= 10;
343 gdbm_setopt(u
->gdbm_file
, GDBM_CACHESIZE
, &gdbm_cache_size
, sizeof(gdbm_cache_size
));
345 pa_log_info("Sucessfully opened database file '%s'.", fname
);
348 for (sink
= pa_idxset_first(m
->core
->sinks
, &idx
); sink
; sink
= pa_idxset_next(m
->core
->sinks
, &idx
))
349 subscribe_callback(m
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_NEW
, sink
->index
, u
);
351 for (source
= pa_idxset_first(m
->core
->sources
, &idx
); source
; source
= pa_idxset_next(m
->core
->sources
, &idx
))
352 subscribe_callback(m
->core
, PA_SUBSCRIPTION_EVENT_SOURCE
|PA_SUBSCRIPTION_EVENT_NEW
, source
->index
, u
);
366 void pa__done(pa_module
*m
) {
371 if (!(u
= m
->userdata
))
375 pa_subscription_free(u
->subscription
);
377 if (u
->sink_fixate_hook_slot
)
378 pa_hook_slot_free(u
->sink_fixate_hook_slot
);
379 if (u
->source_fixate_hook_slot
)
380 pa_hook_slot_free(u
->source_fixate_hook_slot
);
382 if (u
->save_time_event
)
383 u
->core
->mainloop
->time_free(u
->save_time_event
);
386 gdbm_close(u
->gdbm_file
);