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.1 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>
34 #include <pulse/xmalloc.h>
35 #include <pulse/volume.h>
36 #include <pulse/timeval.h>
37 #include <pulse/util.h>
38 #include <pulse/rtclock.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>
49 #include <pulsecore/database.h>
51 #include "module-device-restore-symdef.h"
53 PA_MODULE_AUTHOR("Lennart Poettering");
54 PA_MODULE_DESCRIPTION("Automatically restore the volume/mute state of devices");
55 PA_MODULE_VERSION(PACKAGE_VERSION
);
56 PA_MODULE_LOAD_ONCE(TRUE
);
58 "restore_port=<Save/restore port?> "
59 "restore_volume=<Save/restore volumes?> "
60 "restore_muted=<Save/restore muted states?>");
62 #define SAVE_INTERVAL (10 * PA_USEC_PER_SEC)
64 static const char* const valid_modargs
[] = {
74 pa_subscription
*subscription
;
77 *sink_fixate_hook_slot
,
78 *source_new_hook_slot
,
79 *source_fixate_hook_slot
;
80 pa_time_event
*save_time_event
;
81 pa_database
*database
;
83 pa_bool_t restore_volume
:1;
84 pa_bool_t restore_muted
:1;
85 pa_bool_t restore_port
:1;
88 #define ENTRY_VERSION 2
92 pa_bool_t muted_valid
:1, volume_valid
:1, port_valid
:1;
94 pa_channel_map channel_map
;
96 char port
[PA_NAME_MAX
];
99 static void save_time_callback(pa_mainloop_api
*a
, pa_time_event
* e
, const struct timeval
*t
, void *userdata
) {
100 struct userdata
*u
= userdata
;
106 pa_assert(e
== u
->save_time_event
);
107 u
->core
->mainloop
->time_free(u
->save_time_event
);
108 u
->save_time_event
= NULL
;
110 pa_database_sync(u
->database
);
111 pa_log_info("Synced.");
114 static struct entry
* read_entry(struct userdata
*u
, const char *name
) {
121 key
.data
= (char*) name
;
122 key
.size
= strlen(name
);
126 if (!pa_database_get(u
->database
, &key
, &data
))
129 if (data
.size
!= sizeof(struct entry
)) {
130 pa_log_debug("Database contains entry for device %s of wrong size %lu != %lu. Probably due to upgrade, ignoring.", name
, (unsigned long) data
.size
, (unsigned long) sizeof(struct entry
));
134 e
= (struct entry
*) data
.data
;
136 if (e
->version
!= ENTRY_VERSION
) {
137 pa_log_debug("Version of database entry for device %s doesn't match our version. Probably due to upgrade, ignoring.", name
);
141 if (!memchr(e
->port
, 0, sizeof(e
->port
))) {
142 pa_log_warn("Database contains entry for device %s with missing NUL byte in port name", name
);
146 if (e
->volume_valid
&& !pa_channel_map_valid(&e
->channel_map
)) {
147 pa_log_warn("Invalid channel map stored in database for device %s", name
);
151 if (e
->volume_valid
&& (!pa_cvolume_valid(&e
->volume
) || !pa_cvolume_compatible_with_channel_map(&e
->volume
, &e
->channel_map
))) {
152 pa_log_warn("Volume and channel map don't match in database entry for device %s", name
);
160 pa_datum_free(&data
);
164 static void trigger_save(struct userdata
*u
) {
165 if (u
->save_time_event
)
168 u
->save_time_event
= pa_core_rttime_new(u
->core
, pa_rtclock_now() + SAVE_INTERVAL
, save_time_callback
, u
);
171 static pa_bool_t
entries_equal(const struct entry
*a
, const struct entry
*b
) {
174 if (a
->port_valid
!= b
->port_valid
||
175 (a
->port_valid
&& strncmp(a
->port
, b
->port
, sizeof(a
->port
))))
178 if (a
->muted_valid
!= b
->muted_valid
||
179 (a
->muted_valid
&& (a
->muted
!= b
->muted
)))
183 if (a
->volume_valid
!= b
->volume_valid
||
184 (a
->volume_valid
&& !pa_cvolume_equal(pa_cvolume_remap(&t
, &b
->channel_map
, &a
->channel_map
), &a
->volume
)))
190 static void subscribe_callback(pa_core
*c
, pa_subscription_event_type_t t
, uint32_t idx
, void *userdata
) {
191 struct userdata
*u
= userdata
;
192 struct entry entry
, *old
;
199 if (t
!= (PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_NEW
) &&
200 t
!= (PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_CHANGE
) &&
201 t
!= (PA_SUBSCRIPTION_EVENT_SOURCE
|PA_SUBSCRIPTION_EVENT_NEW
) &&
202 t
!= (PA_SUBSCRIPTION_EVENT_SOURCE
|PA_SUBSCRIPTION_EVENT_CHANGE
))
206 entry
.version
= ENTRY_VERSION
;
208 if ((t
& PA_SUBSCRIPTION_EVENT_FACILITY_MASK
) == PA_SUBSCRIPTION_EVENT_SINK
) {
211 if (!(sink
= pa_idxset_get_by_index(c
->sinks
, idx
)))
214 name
= pa_sprintf_malloc("sink:%s", sink
->name
);
216 if ((old
= read_entry(u
, name
)))
219 if (sink
->save_volume
) {
220 entry
.channel_map
= sink
->channel_map
;
221 entry
.volume
= *pa_sink_get_volume(sink
, FALSE
);
222 entry
.volume_valid
= TRUE
;
225 if (sink
->save_muted
) {
226 entry
.muted
= pa_sink_get_mute(sink
, FALSE
);
227 entry
.muted_valid
= TRUE
;
230 if (sink
->save_port
) {
231 pa_strlcpy(entry
.port
, sink
->active_port
? sink
->active_port
->name
: "", sizeof(entry
.port
));
232 entry
.port_valid
= TRUE
;
238 pa_assert((t
& PA_SUBSCRIPTION_EVENT_FACILITY_MASK
) == PA_SUBSCRIPTION_EVENT_SOURCE
);
240 if (!(source
= pa_idxset_get_by_index(c
->sources
, idx
)))
243 name
= pa_sprintf_malloc("source:%s", source
->name
);
245 if ((old
= read_entry(u
, name
)))
248 if (source
->save_volume
) {
249 entry
.channel_map
= source
->channel_map
;
250 entry
.volume
= *pa_source_get_volume(source
, FALSE
);
251 entry
.volume_valid
= TRUE
;
254 if (source
->save_muted
) {
255 entry
.muted
= pa_source_get_mute(source
, FALSE
);
256 entry
.muted_valid
= TRUE
;
259 if (source
->save_port
) {
260 pa_strlcpy(entry
.port
, source
->active_port
? source
->active_port
->name
: "", sizeof(entry
.port
));
261 entry
.port_valid
= TRUE
;
267 if (entries_equal(old
, &entry
)) {
277 key
.size
= strlen(name
);
280 data
.size
= sizeof(entry
);
282 pa_log_info("Storing volume/mute/port for device %s.", name
);
284 pa_database_set(u
->database
, &key
, &data
, TRUE
);
291 static pa_hook_result_t
sink_new_hook_callback(pa_core
*c
, pa_sink_new_data
*new_data
, struct userdata
*u
) {
298 pa_assert(u
->restore_port
);
300 name
= pa_sprintf_malloc("sink:%s", new_data
->name
);
302 if ((e
= read_entry(u
, name
))) {
305 if (!new_data
->active_port
) {
306 pa_log_info("Restoring port for sink %s.", name
);
307 pa_sink_new_data_set_port(new_data
, e
->port
);
308 new_data
->save_port
= TRUE
;
310 pa_log_debug("Not restoring port for sink %s, because already set.", name
);
321 static pa_hook_result_t
sink_fixate_hook_callback(pa_core
*c
, pa_sink_new_data
*new_data
, struct userdata
*u
) {
328 pa_assert(u
->restore_volume
|| u
->restore_muted
);
330 name
= pa_sprintf_malloc("sink:%s", new_data
->name
);
332 if ((e
= read_entry(u
, name
))) {
334 if (u
->restore_volume
&& e
->volume_valid
) {
336 if (!new_data
->volume_is_set
) {
339 pa_log_info("Restoring volume for sink %s.", new_data
->name
);
342 pa_cvolume_remap(&v
, &e
->channel_map
, &new_data
->channel_map
);
343 pa_sink_new_data_set_volume(new_data
, &v
);
345 new_data
->save_volume
= TRUE
;
347 pa_log_debug("Not restoring volume for sink %s, because already set.", new_data
->name
);
350 if (u
->restore_muted
&& e
->muted_valid
) {
352 if (!new_data
->muted_is_set
) {
353 pa_log_info("Restoring mute state for sink %s.", new_data
->name
);
354 pa_sink_new_data_set_muted(new_data
, e
->muted
);
355 new_data
->save_muted
= TRUE
;
357 pa_log_debug("Not restoring mute state for sink %s, because already set.", new_data
->name
);
368 static pa_hook_result_t
source_new_hook_callback(pa_core
*c
, pa_source_new_data
*new_data
, struct userdata
*u
) {
375 pa_assert(u
->restore_port
);
377 name
= pa_sprintf_malloc("source:%s", new_data
->name
);
379 if ((e
= read_entry(u
, name
))) {
382 if (!new_data
->active_port
) {
383 pa_log_info("Restoring port for source %s.", name
);
384 pa_source_new_data_set_port(new_data
, e
->port
);
385 new_data
->save_port
= TRUE
;
387 pa_log_debug("Not restoring port for source %s, because already set.", name
);
398 static pa_hook_result_t
source_fixate_hook_callback(pa_core
*c
, pa_source_new_data
*new_data
, struct userdata
*u
) {
405 pa_assert(u
->restore_volume
|| u
->restore_muted
);
407 name
= pa_sprintf_malloc("source:%s", new_data
->name
);
409 if ((e
= read_entry(u
, name
))) {
411 if (u
->restore_volume
&& e
->volume_valid
) {
413 if (!new_data
->volume_is_set
) {
416 pa_log_info("Restoring volume for source %s.", new_data
->name
);
419 pa_cvolume_remap(&v
, &e
->channel_map
, &new_data
->channel_map
);
420 pa_source_new_data_set_volume(new_data
, &v
);
422 new_data
->save_volume
= TRUE
;
424 pa_log_debug("Not restoring volume for source %s, because already set.", new_data
->name
);
427 if (u
->restore_muted
&& e
->muted_valid
) {
429 if (!new_data
->muted_is_set
) {
430 pa_log_info("Restoring mute state for source %s.", new_data
->name
);
431 pa_source_new_data_set_muted(new_data
, e
->muted
);
432 new_data
->save_muted
= TRUE
;
434 pa_log_debug("Not restoring mute state for source %s, because already set.", new_data
->name
);
445 int pa__init(pa_module
*m
) {
446 pa_modargs
*ma
= NULL
;
452 pa_bool_t restore_volume
= TRUE
, restore_muted
= TRUE
, restore_port
= TRUE
;
456 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
457 pa_log("Failed to parse module arguments");
461 if (pa_modargs_get_value_boolean(ma
, "restore_volume", &restore_volume
) < 0 ||
462 pa_modargs_get_value_boolean(ma
, "restore_muted", &restore_muted
) < 0 ||
463 pa_modargs_get_value_boolean(ma
, "restore_port", &restore_port
) < 0) {
464 pa_log("restore_port=, restore_volume= and restore_muted= expect boolean arguments");
468 if (!restore_muted
&& !restore_volume
&& !restore_port
)
469 pa_log_warn("Neither restoring volume, nor restoring muted, nor restoring port enabled!");
471 m
->userdata
= u
= pa_xnew0(struct userdata
, 1);
474 u
->restore_volume
= restore_volume
;
475 u
->restore_muted
= restore_muted
;
476 u
->restore_port
= restore_port
;
478 u
->subscription
= pa_subscription_new(m
->core
, PA_SUBSCRIPTION_MASK_SINK
|PA_SUBSCRIPTION_MASK_SOURCE
, subscribe_callback
, u
);
481 u
->sink_new_hook_slot
= pa_hook_connect(&m
->core
->hooks
[PA_CORE_HOOK_SINK_NEW
], PA_HOOK_EARLY
, (pa_hook_cb_t
) sink_new_hook_callback
, u
);
482 u
->source_new_hook_slot
= pa_hook_connect(&m
->core
->hooks
[PA_CORE_HOOK_SOURCE_NEW
], PA_HOOK_EARLY
, (pa_hook_cb_t
) source_new_hook_callback
, u
);
485 if (restore_muted
|| restore_volume
) {
486 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
);
487 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
);
490 if (!(fname
= pa_state_path("device-volumes", TRUE
)))
493 if (!(u
->database
= pa_database_open(fname
, TRUE
))) {
494 pa_log("Failed to open volume database '%s': %s", fname
, pa_cstrerror(errno
));
499 pa_log_info("Sucessfully opened database file '%s'.", fname
);
502 for (sink
= pa_idxset_first(m
->core
->sinks
, &idx
); sink
; sink
= pa_idxset_next(m
->core
->sinks
, &idx
))
503 subscribe_callback(m
->core
, PA_SUBSCRIPTION_EVENT_SINK
|PA_SUBSCRIPTION_EVENT_NEW
, sink
->index
, u
);
505 for (source
= pa_idxset_first(m
->core
->sources
, &idx
); source
; source
= pa_idxset_next(m
->core
->sources
, &idx
))
506 subscribe_callback(m
->core
, PA_SUBSCRIPTION_EVENT_SOURCE
|PA_SUBSCRIPTION_EVENT_NEW
, source
->index
, u
);
520 void pa__done(pa_module
*m
) {
525 if (!(u
= m
->userdata
))
529 pa_subscription_free(u
->subscription
);
531 if (u
->sink_fixate_hook_slot
)
532 pa_hook_slot_free(u
->sink_fixate_hook_slot
);
533 if (u
->source_fixate_hook_slot
)
534 pa_hook_slot_free(u
->source_fixate_hook_slot
);
535 if (u
->sink_new_hook_slot
)
536 pa_hook_slot_free(u
->sink_new_hook_slot
);
537 if (u
->source_new_hook_slot
)
538 pa_hook_slot_free(u
->source_new_hook_slot
);
540 if (u
->save_time_event
)
541 u
->core
->mainloop
->time_free(u
->save_time_event
);
544 pa_database_close(u
->database
);