4 This file is part of PulseAudio.
6 Copyright 2006 Lennart Poettering
8 PulseAudio is free software; you can redistribute it and/or modify
9 it under the terms of the GNU Lesser General Public License as published
10 by the Free Software Foundation; either version 2 of the License,
11 or (at your option) any later version.
13 PulseAudio is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU Lesser General Public License
19 along with PulseAudio; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
32 #include <sys/types.h>
37 #include <pulse/xmalloc.h>
39 #include <pulsecore/core-error.h>
40 #include <pulsecore/module.h>
41 #include <pulsecore/core-util.h>
42 #include <pulsecore/modargs.h>
43 #include <pulsecore/log.h>
44 #include <pulsecore/core-subscribe.h>
45 #include <pulsecore/sink-input.h>
46 #include <pulsecore/source-output.h>
47 #include <pulsecore/core-util.h>
48 #include <pulsecore/namereg.h>
49 #include <pulse/volume.h>
51 #include "module-volume-restore-symdef.h"
53 PA_MODULE_AUTHOR("Lennart Poettering")
54 PA_MODULE_DESCRIPTION("Automatically restore the volume and the devices of streams")
55 PA_MODULE_USAGE("table=<filename>")
56 PA_MODULE_VERSION(PACKAGE_VERSION)
58 #define WHITESPACE "\n\r \t"
60 #define DEFAULT_VOLUME_TABLE_FILE "volume-restore.table"
62 static const char* const valid_modargs[] = {
77 pa_subscription *subscription;
78 pa_hook_slot *sink_input_hook_slot, *source_output_hook_slot;
83 static pa_cvolume* parse_volume(const char *s, pa_cvolume *v) {
95 if (k <= 0 || k > PA_CHANNELS_MAX)
98 v->channels = (unsigned) k;
100 for (i = 0; i < v->channels; i++) {
101 p += strspn(p, WHITESPACE);
106 k = strtol(p, &p, 0);
108 if (k < PA_VOLUME_MUTED)
111 v->values[i] = (pa_volume_t) k;
120 static int load_rules(struct userdata *u) {
124 char buf_name[256], buf_volume[256], buf_sink[256], buf_source[256];
128 fopen(u->table_file, "r") :
129 pa_open_config_file(NULL, DEFAULT_VOLUME_TABLE_FILE, NULL, &u->table_file, "r");
132 if (errno == ENOENT) {
133 pa_log_info("starting with empty ruleset.");
136 pa_log("failed to open file '%s': %s", u->table_file, pa_cstrerror(errno));
141 pa_lock_fd(fileno(f), 1);
148 if (!fgets(ln, sizeof(buf_name), f))
158 if (ln == buf_name) {
163 if (ln == buf_volume) {
168 if (ln == buf_sink) {
173 assert(ln == buf_source);
176 if (!parse_volume(buf_volume, &v)) {
177 pa_log("parse failure in %s:%u, stopping parsing", u->table_file, n);
187 if (pa_hashmap_get(u->hashmap, buf_name)) {
188 pa_log("double entry in %s:%u, ignoring", u->table_file, n);
192 rule = pa_xnew(struct rule, 1);
193 rule->name = pa_xstrdup(buf_name);
194 if ((rule->volume_is_set = v_is_set))
196 rule->sink = buf_sink[0] ? pa_xstrdup(buf_sink) : NULL;
197 rule->source = buf_source[0] ? pa_xstrdup(buf_source) : NULL;
199 pa_hashmap_put(u->hashmap, rule->name, rule);
202 if (ln != buf_name) {
203 pa_log("invalid number of lines in %s.", u->table_file);
211 pa_lock_fd(fileno(f), 0);
218 static int save_rules(struct userdata *u) {
225 fopen(u->table_file, "w") :
226 pa_open_config_file(NULL, DEFAULT_VOLUME_TABLE_FILE, NULL, &u->table_file, "w");
229 pa_log("failed to open file '%s': %s", u->table_file, pa_cstrerror(errno));
233 pa_lock_fd(fileno(f), 1);
235 while ((rule = pa_hashmap_iterate(u->hashmap, &state, NULL))) {
238 fprintf(f, "%s\n", rule->name);
240 if (rule->volume_is_set) {
241 fprintf(f, "%u", rule->volume.channels);
243 for (i = 0; i < rule->volume.channels; i++)
244 fprintf(f, " %u", rule->volume.values[i]);
247 fprintf(f, "\n%s\n%s\n",
248 rule->sink ? rule->sink : "",
249 rule->source ? rule->source : "");
256 pa_lock_fd(fileno(f), 0);
263 static char* client_name(pa_client *c) {
266 if (!c->name || !c->driver)
269 t = pa_sprintf_malloc("%s$%s", c->driver, c->name);
270 t[strcspn(t, "\n\r#")] = 0;
277 if ((e = strrchr(t, '('))) {
278 char *k = e + 1 + strspn(e + 1, "0123456789-");
280 /* Dirty trick: truncate all trailing parens with numbers in
281 * between, since they are usually used to identify multiple
282 * sessions of the same application, which is something we
283 * explicitly don't want. Besides other stuff this makes xmms
284 * with esound work properly for us. */
286 if (*k == ')' && *(k+1) == 0)
293 static void subscribe_callback(pa_core *c, pa_subscription_event_type_t t, uint32_t idx, void *userdata) {
294 struct userdata *u = userdata;
295 pa_sink_input *si = NULL;
296 pa_source_output *so = NULL;
303 if (t != (PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_NEW) &&
304 t != (PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE) &&
305 t != (PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_NEW) &&
306 t != (PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE))
309 if ((t & PA_SUBSCRIPTION_EVENT_FACILITY_MASK) == PA_SUBSCRIPTION_EVENT_SINK_INPUT) {
310 if (!(si = pa_idxset_get_by_index(c->sink_inputs, idx)))
313 if (!si->client || !(name = client_name(si->client)))
316 assert((t & PA_SUBSCRIPTION_EVENT_FACILITY_MASK) == PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT);
318 if (!(so = pa_idxset_get_by_index(c->source_outputs, idx)))
321 if (!so->client || !(name = client_name(so->client)))
325 if ((r = pa_hashmap_get(u->hashmap, name))) {
330 if (!r->volume_is_set || !pa_cvolume_equal(pa_sink_input_get_volume(si), &r->volume)) {
331 pa_log_info("Saving volume for <%s>", r->name);
332 r->volume = *pa_sink_input_get_volume(si);
333 r->volume_is_set = 1;
337 if (!r->sink || strcmp(si->sink->name, r->sink) != 0) {
338 pa_log_info("Saving sink for <%s>", r->name);
340 r->sink = pa_xstrdup(si->sink->name);
346 if (!r->source || strcmp(so->source->name, r->source) != 0) {
347 pa_log_info("Saving source for <%s>", r->name);
349 r->source = pa_xstrdup(so->source->name);
355 pa_log_info("Creating new entry for <%s>", name);
357 r = pa_xnew(struct rule, 1);
361 r->volume = *pa_sink_input_get_volume(si);
362 r->volume_is_set = 1;
363 r->sink = pa_xstrdup(si->sink->name);
367 r->volume_is_set = 0;
369 r->source = pa_xstrdup(so->source->name);
372 pa_hashmap_put(u->hashmap, r->name, r);
377 static pa_hook_result_t sink_input_hook_callback(pa_core *c, pa_sink_input_new_data *data, struct userdata *u) {
383 if (!data->client || !(name = client_name(data->client)))
386 if ((r = pa_hashmap_get(u->hashmap, name))) {
388 if (r->volume_is_set && data->sample_spec.channels == r->volume.channels) {
389 pa_log_info("Restoring volume for <%s>", r->name);
390 pa_sink_input_new_data_set_volume(data, &r->volume);
393 if (!data->sink && r->sink) {
394 if ((data->sink = pa_namereg_get(c, r->sink, PA_NAMEREG_SINK, 1)))
395 pa_log_info("Restoring sink for <%s>", r->name);
402 static pa_hook_result_t source_output_hook_callback(pa_core *c, pa_source_output_new_data *data, struct userdata *u) {
408 if (!data->client || !(name = client_name(data->client)))
411 if ((r = pa_hashmap_get(u->hashmap, name))) {
412 if (!data->source && r->source) {
413 if ((data->source = pa_namereg_get(c, r->source, PA_NAMEREG_SOURCE, 1)))
414 pa_log_info("Restoring source for <%s>", r->name);
421 int pa__init(pa_core *c, pa_module*m) {
422 pa_modargs *ma = NULL;
428 if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
429 pa_log("Failed to parse module arguments");
433 u = pa_xnew(struct userdata, 1);
434 u->hashmap = pa_hashmap_new(pa_idxset_string_hash_func, pa_idxset_string_compare_func);
435 u->subscription = NULL;
436 u->table_file = pa_xstrdup(pa_modargs_get_value(ma, "table", NULL));
441 if (load_rules(u) < 0)
444 u->subscription = pa_subscription_new(c, PA_SUBSCRIPTION_MASK_SINK_INPUT|PA_SUBSCRIPTION_MASK_SOURCE_OUTPUT, subscribe_callback, u);
445 u->sink_input_hook_slot = pa_hook_connect(&c->hook_sink_input_new, (pa_hook_cb_t) sink_input_hook_callback, u);
446 u->source_output_hook_slot = pa_hook_connect(&c->hook_source_output_new, (pa_hook_cb_t) source_output_hook_callback, u);
460 static void free_func(void *p, void *userdata) {
470 void pa__done(pa_core *c, pa_module*m) {
476 if (!(u = m->userdata))
480 pa_subscription_free(u->subscription);
482 if (u->sink_input_hook_slot)
483 pa_hook_slot_free(u->sink_input_hook_slot);
484 if (u->source_output_hook_slot)
485 pa_hook_slot_free(u->source_output_hook_slot);
492 pa_hashmap_free(u->hashmap, free_func, NULL);
495 pa_xfree(u->table_file);