2 This file is part of PulseAudio.
4 Copyright 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>
49 #include <pulsecore/protocol-native.h>
50 #include <pulsecore/pstream.h>
51 #include <pulsecore/pstream-util.h>
53 #include "module-stream-restore-symdef.h"
55 PA_MODULE_AUTHOR("Lennart Poettering");
56 PA_MODULE_DESCRIPTION("Automatically restore the volume/mute/device state of streams");
57 PA_MODULE_VERSION(PACKAGE_VERSION
);
58 PA_MODULE_LOAD_ONCE(TRUE
);
60 #define SAVE_INTERVAL 10
62 static const char* const valid_modargs
[] = {
72 pa_subscription
*subscription
;
74 *sink_input_new_hook_slot
,
75 *sink_input_fixate_hook_slot
,
76 *source_output_new_hook_slot
,
77 *connection_unlink_hook_slot
;
78 pa_time_event
*save_time_event
;
81 pa_bool_t restore_device
:1;
82 pa_bool_t restore_volume
:1;
83 pa_bool_t restore_muted
:1;
85 pa_native_protocol
*protocol
;
86 pa_idxset
*subscribed
;
90 char device
[PA_NAME_MAX
];
91 pa_channel_map channel_map
;
102 SUBCOMMAND_SUBSCRIBE
,
106 static void save_time_callback(pa_mainloop_api
*a
, pa_time_event
* e
, const struct timeval
*tv
, void *userdata
) {
107 struct userdata
*u
= userdata
;
114 pa_assert(e
== u
->save_time_event
);
115 u
->core
->mainloop
->time_free(u
->save_time_event
);
116 u
->save_time_event
= NULL
;
118 gdbm_sync(u
->gdbm_file
);
119 pa_log_info("Synced.");
122 static char *get_name(pa_proplist
*p
, const char *prefix
) {
128 if ((r
= pa_proplist_gets(p
, PA_PROP_MEDIA_ROLE
)))
129 return pa_sprintf_malloc("%s-by-media-role:%s", prefix
, r
);
130 else if ((r
= pa_proplist_gets(p
, PA_PROP_APPLICATION_ID
)))
131 return pa_sprintf_malloc("%s-by-application-id:%s", prefix
, r
);
132 else if ((r
= pa_proplist_gets(p
, PA_PROP_APPLICATION_NAME
)))
133 return pa_sprintf_malloc("%s-by-application-name:%s", prefix
, r
);
134 else if ((r
= pa_proplist_gets(p
, PA_PROP_MEDIA_NAME
)))
135 return pa_sprintf_malloc("%s-by-media-name:%s", prefix
, r
);
140 static struct entry
* read_entry(struct userdata
*u
, char *name
) {
148 key
.dsize
= (int) strlen(name
);
150 data
= gdbm_fetch(u
->gdbm_file
, key
);
155 if (data
.dsize
!= sizeof(struct entry
)) {
156 pa_log_warn("Database contains entry for stream %s of wrong size %lu != %lu", name
, (unsigned long) data
.dsize
, (unsigned long) sizeof(struct entry
));
160 e
= (struct entry
*) data
.dptr
;
162 if (!memchr(e
->device
, 0, sizeof(e
->device
))) {
163 pa_log_warn("Database contains entry for stream %s with missing NUL byte in device name", name
);
167 if (!(pa_cvolume_valid(&e
->volume
))) {
168 pa_log_warn("Invalid volume stored in database for stream %s", name
);
172 if (!(pa_channel_map_valid(&e
->channel_map
))) {
173 pa_log_warn("Invalid channel map stored in database for stream %s", name
);
177 if (e
->volume
.channels
!= e
->channel_map
.channels
) {
178 pa_log_warn("Volume and channel map don't match in database entry for stream %s", name
);
190 static void trigger_save(struct userdata
*u
) {
192 pa_native_connection
*c
;
195 for (c
= pa_idxset_first(u
->subscribed
, &idx
); c
; c
= pa_idxset_next(u
->subscribed
, &idx
)) {
198 t
= pa_tagstruct_new(NULL
, 0);
199 pa_tagstruct_putu32(t
, PA_COMMAND_EXTENSION
);
200 pa_tagstruct_putu32(t
, 0);
201 pa_tagstruct_putu32(t
, u
->module
->index
);
202 pa_tagstruct_puts(t
, u
->module
->name
);
203 pa_tagstruct_putu32(t
, SUBCOMMAND_EVENT
);
205 pa_pstream_send_tagstruct(pa_native_connection_get_pstream(c
), t
);
208 if (u
->save_time_event
)
211 pa_gettimeofday(&tv
);
212 tv
.tv_sec
+= SAVE_INTERVAL
;
213 u
->save_time_event
= u
->core
->mainloop
->time_new(u
->core
->mainloop
, &tv
, save_time_callback
, u
);
216 static void subscribe_callback(pa_core
*c
, pa_subscription_event_type_t t
, uint32_t idx
, void *userdata
) {
217 struct userdata
*u
= userdata
;
218 struct entry entry
, *old
;
225 if (t
!= (PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_NEW
) &&
226 t
!= (PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
) &&
227 t
!= (PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT
|PA_SUBSCRIPTION_EVENT_NEW
) &&
228 t
!= (PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
))
231 memset(&entry
, 0, sizeof(entry
));
233 if ((t
& PA_SUBSCRIPTION_EVENT_FACILITY_MASK
) == PA_SUBSCRIPTION_EVENT_SINK_INPUT
) {
234 pa_sink_input
*sink_input
;
236 if (!(sink_input
= pa_idxset_get_by_index(c
->sink_inputs
, idx
)))
239 if (!(name
= get_name(sink_input
->proplist
, "sink-input")))
242 entry
.channel_map
= sink_input
->channel_map
;
243 entry
.volume
= *pa_sink_input_get_volume(sink_input
);
244 entry
.muted
= pa_sink_input_get_mute(sink_input
);
245 pa_strlcpy(entry
.device
, sink_input
->sink
->name
, sizeof(entry
.device
));
248 pa_source_output
*source_output
;
250 pa_assert((t
& PA_SUBSCRIPTION_EVENT_FACILITY_MASK
) == PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT
);
252 if (!(source_output
= pa_idxset_get_by_index(c
->source_outputs
, idx
)))
255 if (!(name
= get_name(source_output
->proplist
, "source-output")))
258 /* The following fields are filled in to make the entry valid
259 * according to read_entry(). They are otherwise useless */
260 entry
.channel_map
= source_output
->channel_map
;
261 pa_cvolume_reset(&entry
.volume
, entry
.channel_map
.channels
);
262 pa_strlcpy(entry
.device
, source_output
->source
->name
, sizeof(entry
.device
));
265 if ((old
= read_entry(u
, name
))) {
267 if (pa_cvolume_equal(pa_cvolume_remap(&old
->volume
, &old
->channel_map
, &entry
.channel_map
), &entry
.volume
) &&
268 !old
->muted
== !entry
.muted
&&
269 strcmp(old
->device
, entry
.device
) == 0) {
280 key
.dsize
= (int) strlen(name
);
282 data
.dptr
= (void*) &entry
;
283 data
.dsize
= sizeof(entry
);
285 pa_log_info("Storing volume/mute/device for stream %s.", name
);
287 gdbm_store(u
->gdbm_file
, key
, data
, GDBM_REPLACE
);
294 static pa_hook_result_t
sink_input_new_hook_callback(pa_core
*c
, pa_sink_input_new_data
*new_data
, struct userdata
*u
) {
300 if (!(name
= get_name(new_data
->proplist
, "sink-input")))
303 if ((e
= read_entry(u
, name
))) {
306 if (u
->restore_device
&&
307 (s
= pa_namereg_get(c
, e
->device
, PA_NAMEREG_SINK
, TRUE
))) {
309 if (!new_data
->sink
) {
310 pa_log_info("Restoring device for stream %s.", name
);
313 pa_log_info("Not restore device for stream %s, because already set.", name
);
324 static pa_hook_result_t
sink_input_fixate_hook_callback(pa_core
*c
, pa_sink_input_new_data
*new_data
, struct userdata
*u
) {
330 if (!(name
= get_name(new_data
->proplist
, "sink-input")))
333 if ((e
= read_entry(u
, name
))) {
335 if (u
->restore_volume
) {
337 if (!new_data
->volume_is_set
) {
338 pa_log_info("Restoring volume for sink input %s.", name
);
339 pa_sink_input_new_data_set_volume(new_data
, pa_cvolume_remap(&e
->volume
, &e
->channel_map
, &new_data
->channel_map
));
341 pa_log_debug("Not restoring volume for sink input %s, because already set.", name
);
344 if (u
->restore_muted
) {
345 if (!new_data
->muted_is_set
) {
346 pa_log_info("Restoring mute state for sink input %s.", name
);
347 pa_sink_input_new_data_set_muted(new_data
, e
->muted
);
349 pa_log_debug("Not restoring mute state for sink input %s, because already set.", name
);
360 static pa_hook_result_t
source_output_new_hook_callback(pa_core
*c
, pa_source_output_new_data
*new_data
, struct userdata
*u
) {
366 if (!(name
= get_name(new_data
->proplist
, "source-output")))
369 if ((e
= read_entry(u
, name
))) {
372 if (u
->restore_device
&&
373 !new_data
->direct_on_input
&&
374 (s
= pa_namereg_get(c
, e
->device
, PA_NAMEREG_SOURCE
, TRUE
))) {
376 if (!new_data
->source
) {
377 pa_log_info("Restoring device for stream %s.", name
);
378 new_data
->source
= s
;
380 pa_log_info("Not restroing device for stream %s, because already set", name
);
391 #define EXT_VERSION 1
393 static void clear_db(struct userdata
*u
) {
398 key
= gdbm_firstkey(u
->gdbm_file
);
401 next_key
= gdbm_nextkey(u
->gdbm_file
, key
);
403 gdbm_delete(u
->gdbm_file
, key
);
409 gdbm_reorganize(u
->gdbm_file
);
412 static void apply_entry(struct userdata
*u
, const char *name
, struct entry
*e
) {
414 pa_source_output
*so
;
421 for (si
= pa_idxset_first(u
->core
->sink_inputs
, &idx
); si
; si
= pa_idxset_next(u
->core
->sink_inputs
, &idx
)) {
425 if (!(n
= get_name(si
->proplist
, "sink-input")))
428 if (strcmp(name
, n
)) {
433 if (u
->restore_volume
) {
434 pa_cvolume v
= e
->volume
;
435 pa_log_info("Restoring volume for sink input %s.", name
);
436 pa_sink_input_set_volume(si
, pa_cvolume_remap(&v
, &e
->channel_map
, &si
->channel_map
));
439 if (u
->restore_muted
) {
440 pa_log_info("Restoring mute state for sink input %s.", name
);
441 pa_sink_input_set_mute(si
, e
->muted
);
444 if (u
->restore_device
&&
445 (s
= pa_namereg_get(u
->core
, e
->device
, PA_NAMEREG_SOURCE
, TRUE
))) {
447 pa_log_info("Restoring device for stream %s.", name
);
448 pa_sink_input_move_to(si
, s
);
452 for (so
= pa_idxset_first(u
->core
->source_outputs
, &idx
); so
; so
= pa_idxset_next(u
->core
->source_outputs
, &idx
)) {
456 if (!(n
= get_name(so
->proplist
, "source-output")))
459 if (strcmp(name
, n
)) {
464 if (u
->restore_device
&&
465 (s
= pa_namereg_get(u
->core
, e
->device
, PA_NAMEREG_SOURCE
, TRUE
))) {
467 pa_log_info("Restoring device for stream %s.", name
);
468 pa_source_output_move_to(so
, s
);
474 static void dump_database(struct userdata
*u
) {
477 key
= gdbm_firstkey(u
->gdbm_file
);
483 next_key
= gdbm_nextkey(u
->gdbm_file
, key
);
485 name
= pa_xstrndup(key
.dptr
, key
.dsize
);
488 if ((e
= read_entry(u
, name
))) {
490 pa_log("name=%s", name
);
491 pa_log("device=%s", e
->device
);
492 pa_log("channel_map=%s", pa_channel_map_snprint(t
, sizeof(t
), &e
->channel_map
));
493 pa_log("volume=%s", pa_cvolume_snprint(t
, sizeof(t
), &e
->volume
));
494 pa_log("mute=%s", pa_yes_no(e
->muted
));
505 static int extension_cb(pa_native_protocol
*p
, pa_module
*m
, pa_native_connection
*c
, uint32_t tag
, pa_tagstruct
*t
) {
508 pa_tagstruct
*reply
= NULL
;
517 if (pa_tagstruct_getu32(t
, &command
) < 0)
520 reply
= pa_tagstruct_new(NULL
, 0);
521 pa_tagstruct_putu32(reply
, PA_COMMAND_REPLY
);
522 pa_tagstruct_putu32(reply
, tag
);
525 case SUBCOMMAND_TEST
: {
526 if (!pa_tagstruct_eof(t
))
529 pa_tagstruct_putu32(reply
, EXT_VERSION
);
533 case SUBCOMMAND_READ
: {
536 if (!pa_tagstruct_eof(t
))
539 key
= gdbm_firstkey(u
->gdbm_file
);
545 next_key
= gdbm_nextkey(u
->gdbm_file
, key
);
547 name
= pa_xstrndup(key
.dptr
, (size_t) key
.dsize
);
550 if ((e
= read_entry(u
, name
))) {
551 pa_tagstruct_puts(reply
, name
);
552 pa_tagstruct_put_channel_map(reply
, &e
->channel_map
);
553 pa_tagstruct_put_cvolume(reply
, &e
->volume
);
554 pa_tagstruct_puts(reply
, e
->device
);
555 pa_tagstruct_put_boolean(reply
, e
->muted
);
568 case SUBCOMMAND_WRITE
: {
570 pa_bool_t apply_immediately
= FALSE
;
572 if (pa_tagstruct_getu32(t
, &mode
) < 0 ||
573 pa_tagstruct_get_boolean(t
, &apply_immediately
) < 0)
576 if (mode
!= PA_UPDATE_MERGE
&&
577 mode
!= PA_UPDATE_REPLACE
&&
578 mode
!= PA_UPDATE_SET
)
581 if (mode
== PA_UPDATE_SET
)
584 while (!pa_tagstruct_eof(t
)) {
585 const char *name
, *device
;
591 memset(&entry
, 0, sizeof(entry
));
593 if (pa_tagstruct_gets(t
, &name
) < 0 ||
594 pa_tagstruct_get_channel_map(t
, &entry
.channel_map
) ||
595 pa_tagstruct_get_cvolume(t
, &entry
.volume
) < 0 ||
596 pa_tagstruct_gets(t
, &device
) < 0 ||
597 pa_tagstruct_get_boolean(t
, &muted
) < 0)
600 if (entry
.channel_map
.channels
!= entry
.volume
.channels
)
604 pa_strlcpy(entry
.device
, device
, sizeof(entry
.device
));
606 key
.dptr
= (void*) name
;
607 key
.dsize
= (int) strlen(name
);
609 data
.dptr
= (void*) &entry
;
610 data
.dsize
= sizeof(entry
);
612 if ((k
= gdbm_store(u
->gdbm_file
, key
, data
, mode
== PA_UPDATE_REPLACE
? GDBM_REPLACE
: GDBM_INSERT
)) == 0)
613 if (apply_immediately
)
614 apply_entry(u
, name
, &entry
);
622 case SUBCOMMAND_DELETE
:
624 while (!pa_tagstruct_eof(t
)) {
628 if (pa_tagstruct_gets(t
, &name
) < 0)
631 key
.dptr
= (void*) name
;
632 key
.dsize
= (int) strlen(name
);
634 gdbm_delete(u
->gdbm_file
, key
);
641 case SUBCOMMAND_SUBSCRIBE
: {
645 if (pa_tagstruct_get_boolean(t
, &enabled
) < 0 ||
646 !pa_tagstruct_eof(t
))
650 pa_idxset_put(u
->subscribed
, c
, NULL
);
652 pa_idxset_remove_by_data(u
->subscribed
, c
, NULL
);
661 pa_pstream_send_tagstruct(pa_native_connection_get_pstream(c
), reply
);
667 pa_tagstruct_free(reply
);
672 static pa_hook_result_t
connection_unlink_hook_cb(pa_native_protocol
*p
, pa_native_connection
*c
, struct userdata
*u
) {
677 pa_idxset_remove_by_data(u
->subscribed
, c
, NULL
);
681 int pa__init(pa_module
*m
) {
682 pa_modargs
*ma
= NULL
;
686 pa_source_output
*so
;
688 pa_bool_t restore_device
= TRUE
, restore_volume
= TRUE
, restore_muted
= TRUE
;
692 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
693 pa_log("Failed to parse module arguments");
697 if (pa_modargs_get_value_boolean(ma
, "restore_device", &restore_device
) < 0 ||
698 pa_modargs_get_value_boolean(ma
, "restore_volume", &restore_volume
) < 0 ||
699 pa_modargs_get_value_boolean(ma
, "restore_muted", &restore_muted
) < 0) {
700 pa_log("restore_device=, restore_volume= and restore_muted= expect boolean arguments");
704 if (!restore_muted
&& !restore_volume
&& !restore_device
)
705 pa_log_warn("Neither restoring volume, nor restoring muted, nor restoring device enabled!");
707 m
->userdata
= u
= pa_xnew(struct userdata
, 1);
710 u
->save_time_event
= NULL
;
711 u
->restore_device
= restore_device
;
712 u
->restore_volume
= restore_volume
;
713 u
->restore_muted
= restore_muted
;
715 u
->subscribed
= pa_idxset_new(pa_idxset_trivial_hash_func
, pa_idxset_trivial_compare_func
);
717 u
->protocol
= pa_native_protocol_get(m
->core
);
718 pa_native_protocol_install_ext(u
->protocol
, m
, extension_cb
);
720 u
->connection_unlink_hook_slot
= pa_hook_connect(&pa_native_protocol_hooks(u
->protocol
)[PA_NATIVE_HOOK_CONNECTION_UNLINK
], PA_HOOK_NORMAL
, (pa_hook_cb_t
) connection_unlink_hook_cb
, u
);
722 u
->subscription
= pa_subscription_new(m
->core
, PA_SUBSCRIPTION_MASK_SINK_INPUT
|PA_SUBSCRIPTION_MASK_SOURCE_OUTPUT
, subscribe_callback
, u
);
724 if (restore_device
) {
725 u
->sink_input_new_hook_slot
= pa_hook_connect(&m
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_NEW
], PA_HOOK_EARLY
, (pa_hook_cb_t
) sink_input_new_hook_callback
, u
);
726 u
->source_output_new_hook_slot
= pa_hook_connect(&m
->core
->hooks
[PA_CORE_HOOK_SOURCE_OUTPUT_NEW
], PA_HOOK_EARLY
, (pa_hook_cb_t
) source_output_new_hook_callback
, u
);
729 if (restore_volume
|| restore_muted
)
730 u
->sink_input_fixate_hook_slot
= pa_hook_connect(&m
->core
->hooks
[PA_CORE_HOOK_SINK_INPUT_FIXATE
], PA_HOOK_EARLY
, (pa_hook_cb_t
) sink_input_fixate_hook_callback
, u
);
732 /* We include the host identifier in the file name because gdbm
733 * files are CPU dependant, and we don't want things to go wrong
734 * if we are on a multiarch system. */
736 fn
= pa_sprintf_malloc("stream-volumes."CANONICAL_HOST
".gdbm");
737 fname
= pa_state_path(fn
, TRUE
);
743 if (!(u
->gdbm_file
= gdbm_open(fname
, 0, GDBM_WRCREAT
, 0600, NULL
))) {
744 pa_log("Failed to open volume database '%s': %s", fname
, gdbm_strerror(gdbm_errno
));
749 pa_log_info("Sucessfully opened database file '%s'.", fname
);
752 for (si
= pa_idxset_first(m
->core
->sink_inputs
, &idx
); si
; si
= pa_idxset_next(m
->core
->sink_inputs
, &idx
))
753 subscribe_callback(m
->core
, PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_NEW
, si
->index
, u
);
755 for (so
= pa_idxset_first(m
->core
->source_outputs
, &idx
); so
; so
= pa_idxset_next(m
->core
->source_outputs
, &idx
))
756 subscribe_callback(m
->core
, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT
|PA_SUBSCRIPTION_EVENT_NEW
, so
->index
, u
);
770 void pa__done(pa_module
*m
) {
775 if (!(u
= m
->userdata
))
779 pa_subscription_free(u
->subscription
);
781 if (u
->sink_input_new_hook_slot
)
782 pa_hook_slot_free(u
->sink_input_new_hook_slot
);
783 if (u
->sink_input_fixate_hook_slot
)
784 pa_hook_slot_free(u
->sink_input_fixate_hook_slot
);
785 if (u
->source_output_new_hook_slot
)
786 pa_hook_slot_free(u
->source_output_new_hook_slot
);
788 if (u
->connection_unlink_hook_slot
)
789 pa_hook_slot_free(u
->connection_unlink_hook_slot
);
791 if (u
->save_time_event
)
792 u
->core
->mainloop
->time_free(u
->save_time_event
);
795 gdbm_close(u
->gdbm_file
);
798 pa_native_protocol_remove_ext(u
->protocol
, m
);
799 pa_native_protocol_unref(u
->protocol
);
803 pa_idxset_free(u
->subscribed
, NULL
, NULL
);