2 This file is part of PulseAudio.
4 Copyright 2006 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>
34 #include <pulse/xmalloc.h>
35 #include <pulse/volume.h>
36 #include <pulse/timeval.h>
38 #include <pulsecore/core-error.h>
39 #include <pulsecore/module.h>
40 #include <pulsecore/core-util.h>
41 #include <pulsecore/modargs.h>
42 #include <pulsecore/log.h>
43 #include <pulsecore/core-subscribe.h>
44 #include <pulsecore/sink-input.h>
45 #include <pulsecore/source-output.h>
46 #include <pulsecore/namereg.h>
48 #include "module-volume-restore-symdef.h"
50 PA_MODULE_AUTHOR("Lennart Poettering");
51 PA_MODULE_DESCRIPTION("Automatically restore the volume and the devices of streams");
52 PA_MODULE_VERSION(PACKAGE_VERSION
);
53 PA_MODULE_LOAD_ONCE(TRUE
);
56 "restore_device=<Restore the device for each stream?> "
57 "restore_volume=<Restore the volume for each stream?>"
60 #define WHITESPACE "\n\r \t"
61 #define DEFAULT_VOLUME_TABLE_FILE "volume-restore.table"
62 #define SAVE_INTERVAL 10
64 static const char* const valid_modargs
[] = {
73 pa_bool_t volume_is_set
;
81 pa_subscription
*subscription
;
83 *sink_input_new_hook_slot
,
84 *sink_input_fixate_hook_slot
,
85 *source_output_new_hook_slot
;
88 pa_time_event
*save_time_event
;
91 static pa_cvolume
* parse_volume(const char *s
, pa_cvolume
*v
) {
102 k
= strtol(s
, &p
, 0);
103 if (k
<= 0 || k
> (long) PA_CHANNELS_MAX
)
106 v
->channels
= (uint8_t) k
;
108 for (i
= 0; i
< v
->channels
; i
++) {
109 p
+= strspn(p
, WHITESPACE
);
114 k
= strtol(p
, &p
, 0);
116 if (k
< (long) PA_VOLUME_MUTED
)
119 v
->values
[i
] = (pa_volume_t
) k
;
128 static int load_rules(struct userdata
*u
) {
132 char buf_name
[256], buf_volume
[256], buf_sink
[256], buf_source
[256];
135 if (!(f
= fopen(u
->table_file
, "r"))) {
136 if (errno
== ENOENT
) {
137 pa_log_info("Starting with empty ruleset.");
140 pa_log("Failed to open file '%s': %s", u
->table_file
, pa_cstrerror(errno
));
145 pa_lock_fd(fileno(f
), 1);
152 if (!fgets(ln
, sizeof(buf_name
), f
))
162 if (ln
== buf_name
) {
167 if (ln
== buf_volume
) {
172 if (ln
== buf_sink
) {
177 pa_assert(ln
== buf_source
);
180 if (!parse_volume(buf_volume
, &v
)) {
181 pa_log("parse failure in %s:%u, stopping parsing", u
->table_file
, n
);
191 if (pa_hashmap_get(u
->hashmap
, buf_name
)) {
192 pa_log("double entry in %s:%u, ignoring", u
->table_file
, n
);
196 rule
= pa_xnew(struct rule
, 1);
197 rule
->name
= pa_xstrdup(buf_name
);
198 if ((rule
->volume_is_set
= v_is_set
))
200 rule
->sink
= buf_sink
[0] ? pa_xstrdup(buf_sink
) : NULL
;
201 rule
->source
= buf_source
[0] ? pa_xstrdup(buf_source
) : NULL
;
203 pa_hashmap_put(u
->hashmap
, rule
->name
, rule
);
206 if (ln
!= buf_name
) {
207 pa_log("invalid number of lines in %s.", u
->table_file
);
215 pa_lock_fd(fileno(f
), 0);
222 static int save_rules(struct userdata
*u
) {
231 pa_log_info("Saving rules...");
233 if (!(f
= fopen(u
->table_file
, "w"))) {
234 pa_log("Failed to open file '%s': %s", u
->table_file
, pa_cstrerror(errno
));
238 pa_lock_fd(fileno(f
), 1);
240 while ((rule
= pa_hashmap_iterate(u
->hashmap
, &state
, NULL
))) {
243 fprintf(f
, "%s\n", rule
->name
);
245 if (rule
->volume_is_set
) {
246 fprintf(f
, "%u", rule
->volume
.channels
);
248 for (i
= 0; i
< rule
->volume
.channels
; i
++)
249 fprintf(f
, " %u", rule
->volume
.values
[i
]);
252 fprintf(f
, "\n%s\n%s\n",
253 rule
->sink
? rule
->sink
: "",
254 rule
->source
? rule
->source
: "");
259 pa_log_debug("Successfully saved rules...");
263 pa_lock_fd(fileno(f
), 0);
270 static char* client_name(pa_client
*c
) {
273 if (!pa_proplist_gets(c
->proplist
, PA_PROP_APPLICATION_NAME
) || !c
->driver
)
276 t
= pa_sprintf_malloc("%s$%s", c
->driver
, pa_proplist_gets(c
->proplist
, PA_PROP_APPLICATION_NAME
));
277 t
[strcspn(t
, "\n\r#")] = 0;
284 if ((e
= strrchr(t
, '('))) {
285 char *k
= e
+ 1 + strspn(e
+ 1, "0123456789-");
287 /* Dirty trick: truncate all trailing parens with numbers in
288 * between, since they are usually used to identify multiple
289 * sessions of the same application, which is something we
290 * explicitly don't want. Besides other stuff this makes xmms
291 * with esound work properly for us. */
293 if (*k
== ')' && *(k
+1) == 0)
300 static void save_time_callback(pa_mainloop_api
*a
, pa_time_event
* e
, const struct timeval
*tv
, void *userdata
) {
301 struct userdata
*u
= userdata
;
308 pa_assert(e
== u
->save_time_event
);
309 u
->core
->mainloop
->time_free(u
->save_time_event
);
310 u
->save_time_event
= NULL
;
315 static void subscribe_callback(pa_core
*c
, pa_subscription_event_type_t t
, uint32_t idx
, void *userdata
) {
316 struct userdata
*u
= userdata
;
317 pa_sink_input
*si
= NULL
;
318 pa_source_output
*so
= NULL
;
325 if (t
!= (PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_NEW
) &&
326 t
!= (PA_SUBSCRIPTION_EVENT_SINK_INPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
) &&
327 t
!= (PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT
|PA_SUBSCRIPTION_EVENT_NEW
) &&
328 t
!= (PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT
|PA_SUBSCRIPTION_EVENT_CHANGE
))
331 if ((t
& PA_SUBSCRIPTION_EVENT_FACILITY_MASK
) == PA_SUBSCRIPTION_EVENT_SINK_INPUT
) {
332 if (!(si
= pa_idxset_get_by_index(c
->sink_inputs
, idx
)))
335 if (!si
->client
|| !(name
= client_name(si
->client
)))
338 pa_assert((t
& PA_SUBSCRIPTION_EVENT_FACILITY_MASK
) == PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT
);
340 if (!(so
= pa_idxset_get_by_index(c
->source_outputs
, idx
)))
343 if (!so
->client
|| !(name
= client_name(so
->client
)))
347 if ((r
= pa_hashmap_get(u
->hashmap
, name
))) {
352 if (!r
->volume_is_set
|| !pa_cvolume_equal(pa_sink_input_get_volume(si
), &r
->volume
)) {
353 pa_log_info("Saving volume for <%s>", r
->name
);
354 r
->volume
= *pa_sink_input_get_volume(si
);
355 r
->volume_is_set
= TRUE
;
359 if (!r
->sink
|| strcmp(si
->sink
->name
, r
->sink
) != 0) {
360 pa_log_info("Saving sink for <%s>", r
->name
);
362 r
->sink
= pa_xstrdup(si
->sink
->name
);
368 if (!r
->source
|| strcmp(so
->source
->name
, r
->source
) != 0) {
369 pa_log_info("Saving source for <%s>", r
->name
);
371 r
->source
= pa_xstrdup(so
->source
->name
);
377 pa_log_info("Creating new entry for <%s>", name
);
379 r
= pa_xnew(struct rule
, 1);
383 r
->volume
= *pa_sink_input_get_volume(si
);
384 r
->volume_is_set
= TRUE
;
385 r
->sink
= pa_xstrdup(si
->sink
->name
);
389 r
->volume_is_set
= FALSE
;
391 r
->source
= pa_xstrdup(so
->source
->name
);
394 pa_hashmap_put(u
->hashmap
, r
->name
, r
);
398 if (u
->modified
&& !u
->save_time_event
) {
400 pa_gettimeofday(&tv
);
401 tv
.tv_sec
+= SAVE_INTERVAL
;
402 u
->save_time_event
= u
->core
->mainloop
->time_new(u
->core
->mainloop
, &tv
, save_time_callback
, u
);
406 static pa_hook_result_t
sink_input_new_hook_callback(pa_core
*c
, pa_sink_input_new_data
*data
, struct userdata
*u
) {
412 /* In the NEW hook we only adjust the device. Adjusting the volume
413 * is left for the FIXATE hook */
415 if (!data
->client
|| !(name
= client_name(data
->client
)))
418 if ((r
= pa_hashmap_get(u
->hashmap
, name
))) {
419 if (!data
->sink
&& r
->sink
) {
420 if ((data
->sink
= pa_namereg_get(c
, r
->sink
, PA_NAMEREG_SINK
)))
421 pa_log_info("Restoring sink for <%s>", r
->name
);
430 static pa_hook_result_t
sink_input_fixate_hook_callback(pa_core
*c
, pa_sink_input_new_data
*data
, struct userdata
*u
) {
436 /* In the FIXATE hook we only adjust the volum. Adjusting the device
437 * is left for the NEW hook */
439 if (!data
->client
|| !(name
= client_name(data
->client
)))
442 if ((r
= pa_hashmap_get(u
->hashmap
, name
))) {
444 if (r
->volume_is_set
&& data
->sample_spec
.channels
== r
->volume
.channels
) {
445 pa_log_info("Restoring volume for <%s>", r
->name
);
446 pa_sink_input_new_data_set_virtual_volume(data
, &r
->volume
);
455 static pa_hook_result_t
source_output_new_hook_callback(pa_core
*c
, pa_source_output_new_data
*data
, struct userdata
*u
) {
461 if (!data
->client
|| !(name
= client_name(data
->client
)))
464 if ((r
= pa_hashmap_get(u
->hashmap
, name
))) {
465 if (!data
->source
&& r
->source
) {
466 if ((data
->source
= pa_namereg_get(c
, r
->source
, PA_NAMEREG_SOURCE
)))
467 pa_log_info("Restoring source for <%s>", r
->name
);
474 int pa__init(pa_module
*m
) {
475 pa_modargs
*ma
= NULL
;
477 pa_bool_t restore_device
= TRUE
, restore_volume
= TRUE
;
481 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
482 pa_log("Failed to parse module arguments");
486 u
= pa_xnew(struct userdata
, 1);
488 u
->hashmap
= pa_hashmap_new(pa_idxset_string_hash_func
, pa_idxset_string_compare_func
);
490 u
->subscription
= NULL
;
491 u
->sink_input_new_hook_slot
= u
->sink_input_fixate_hook_slot
= u
->source_output_new_hook_slot
= NULL
;
492 u
->save_time_event
= NULL
;
496 if (!(u
->table_file
= pa_state_path(pa_modargs_get_value(ma
, "table", DEFAULT_VOLUME_TABLE_FILE
), TRUE
)))
499 if (pa_modargs_get_value_boolean(ma
, "restore_device", &restore_device
) < 0 ||
500 pa_modargs_get_value_boolean(ma
, "restore_volume", &restore_volume
) < 0) {
501 pa_log("restore_volume= and restore_device= expect boolean arguments");
505 if (!(restore_device
|| restore_volume
)) {
506 pa_log("Both restrong the volume and restoring the device are disabled. There's no point in using this module at all then, failing.");
510 if (load_rules(u
) < 0)
513 u
->subscription
= pa_subscription_new(m
->core
, PA_SUBSCRIPTION_MASK_SINK_INPUT
|PA_SUBSCRIPTION_MASK_SOURCE_OUTPUT
, subscribe_callback
, u
);
515 if (restore_device
) {
516 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
);
517 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
);
521 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
);
534 static void free_func(void *p
, void *userdata
) {
544 void pa__done(pa_module
*m
) {
549 if (!(u
= m
->userdata
))
553 pa_subscription_free(u
->subscription
);
555 if (u
->sink_input_new_hook_slot
)
556 pa_hook_slot_free(u
->sink_input_new_hook_slot
);
557 if (u
->sink_input_fixate_hook_slot
)
558 pa_hook_slot_free(u
->sink_input_fixate_hook_slot
);
559 if (u
->source_output_new_hook_slot
)
560 pa_hook_slot_free(u
->source_output_new_hook_slot
);
564 pa_hashmap_free(u
->hashmap
, free_func
, NULL
);
567 if (u
->save_time_event
)
568 u
->core
->mainloop
->time_free(u
->save_time_event
);
570 pa_xfree(u
->table_file
);