src/modules/module-volume-restore.c

   1 /* $Id$ */
   2
   3 /***
   4   This file is part of PulseAudio.
   5
   6   Copyright 2006 Lennart Poettering
   7
   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.
  12
  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.
  17
  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
  21   USA.
  22 ***/
  23
  24 #ifdef HAVE_CONFIG_H
  25 #include <config.h>
  26 #endif
  27
  28 #include <unistd.h>
  29 #include <string.h>
  30 #include <errno.h>
  31 #include <sys/types.h>
  32 #include <stdio.h>
  33 #include <stdlib.h>
  34 #include <ctype.h>
  35
  36 #include <pulse/xmalloc.h>
  37 #include <pulse/volume.h>
  38 #include <pulse/timeval.h>
  39
  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
  50 #include "module-volume-restore-symdef.h"
  51
  52 PA_MODULE_AUTHOR("Lennart Poettering");
  53 PA_MODULE_DESCRIPTION("Automatically restore the volume and the devices of streams");
  54 PA_MODULE_VERSION(PACKAGE_VERSION);
  55 PA_MODULE_LOAD_ONCE(TRUE);
  56 PA_MODULE_USAGE(
  57         "table=<filename> "
  58         "restore_device=<Restore the device for each stream?> "
  59         "restore_volume=<Restore the volume for each stream?>"
  60 );
  61
  62 #define WHITESPACE "\n\r \t"
  63 #define DEFAULT_VOLUME_TABLE_FILE "volume-restore.table"
  64 #define SAVE_INTERVAL 10
  65
  66 static const char* const valid_modargs[] = {
  67     "table",
  68     "restore_device",
  69     "restore_volume",
  70     NULL,
  71 };
  72
  73 struct rule {
  74     char* name;
  75     pa_bool_t volume_is_set;
  76     pa_cvolume volume;
  77     char *sink, *source;
  78 };
  79
  80 struct userdata {
  81     pa_core *core;
  82     pa_hashmap *hashmap;
  83     pa_subscription *subscription;
  84     pa_hook_slot
  85         *sink_input_new_hook_slot,
  86         *sink_input_fixate_hook_slot,
  87         *source_output_new_hook_slot;
  88     pa_bool_t modified;
  89     char *table_file;
  90     pa_time_event *save_time_event;
  91 };
  92
  93 static pa_cvolume* parse_volume(const char *s, pa_cvolume *v) {
  94     char *p;
  95     long k;
  96     unsigned i;
  97
  98     pa_assert(s);
  99     pa_assert(v);
 100
 101     if (!isdigit(*s))
 102         return NULL;
 103
 104     k = strtol(s, &p, 0);
 105     if (k <= 0 || k > PA_CHANNELS_MAX)
 106         return NULL;
 107
 108     v->channels = (unsigned) k;
 109
 110     for (i = 0; i < v->channels; i++) {
 111         p += strspn(p, WHITESPACE);
 112
 113         if (!isdigit(*p))
 114             return NULL;
 115
 116         k = strtol(p, &p, 0);
 117
 118         if (k < (long) PA_VOLUME_MUTED)
 119             return NULL;
 120
 121         v->values[i] = (pa_volume_t) k;
 122     }
 123
 124     if (*p != 0)
 125         return NULL;
 126
 127     return v;
 128 }
 129
 130 static int load_rules(struct userdata *u) {
 131     FILE *f;
 132     int n = 0;
 133     int ret = -1;
 134     char buf_name[256], buf_volume[256], buf_sink[256], buf_source[256];
 135     char *ln = buf_name;
 136
 137     if (!(f = fopen(u->table_file, "r"))) {
 138         if (errno == ENOENT) {
 139             pa_log_info("Starting with empty ruleset.");
 140             ret = 0;
 141         } else
 142             pa_log("Failed to open file '%s': %s", u->table_file, pa_cstrerror(errno));
 143
 144         goto finish;
 145     }
 146
 147     pa_lock_fd(fileno(f), 1);
 148
 149     while (!feof(f)) {
 150         struct rule *rule;
 151         pa_cvolume v;
 152         pa_bool_t v_is_set;
 153
 154         if (!fgets(ln, sizeof(buf_name), f))
 155             break;
 156
 157         n++;
 158
 159         pa_strip_nl(ln);
 160
 161         if (ln[0] == '#')
 162             continue;
 163
 164         if (ln == buf_name) {
 165             ln = buf_volume;
 166             continue;
 167         }
 168
 169         if (ln == buf_volume) {
 170             ln = buf_sink;
 171             continue;
 172         }
 173
 174         if (ln == buf_sink) {
 175             ln = buf_source;
 176             continue;
 177         }
 178
 179         pa_assert(ln == buf_source);
 180
 181         if (buf_volume[0]) {
 182             if (!parse_volume(buf_volume, &v)) {
 183                 pa_log("parse failure in %s:%u, stopping parsing", u->table_file, n);
 184                 goto finish;
 185             }
 186
 187             v_is_set = TRUE;
 188         } else
 189             v_is_set = FALSE;
 190
 191         ln = buf_name;
 192
 193         if (pa_hashmap_get(u->hashmap, buf_name)) {
 194             pa_log("double entry in %s:%u, ignoring", u->table_file, n);
 195             continue;
 196         }
 197
 198         rule = pa_xnew(struct rule, 1);
 199         rule->name = pa_xstrdup(buf_name);
 200         if ((rule->volume_is_set = v_is_set))
 201             rule->volume = v;
 202         rule->sink = buf_sink[0] ? pa_xstrdup(buf_sink) : NULL;
 203         rule->source = buf_source[0] ? pa_xstrdup(buf_source) : NULL;
 204
 205         pa_hashmap_put(u->hashmap, rule->name, rule);
 206     }
 207
 208     if (ln != buf_name) {
 209         pa_log("invalid number of lines in %s.", u->table_file);
 210         goto finish;
 211     }
 212
 213     ret = 0;
 214
 215 finish:
 216     if (f) {
 217         pa_lock_fd(fileno(f), 0);
 218         fclose(f);
 219     }
 220
 221     return ret;
 222 }
 223
 224 static int save_rules(struct userdata *u) {
 225     FILE *f;
 226     int ret = -1;
 227     void *state = NULL;
 228     struct rule *rule;
 229
 230     if (!u->modified)
 231         return 0;
 232
 233     pa_log_info("Saving rules...");
 234
 235     if (!(f = fopen(u->table_file, "w"))) {
 236         pa_log("Failed to open file '%s': %s", u->table_file, pa_cstrerror(errno));
 237         goto finish;
 238     }
 239
 240     pa_lock_fd(fileno(f), 1);
 241
 242     while ((rule = pa_hashmap_iterate(u->hashmap, &state, NULL))) {
 243         unsigned i;
 244
 245         fprintf(f, "%s\n", rule->name);
 246
 247         if (rule->volume_is_set) {
 248             fprintf(f, "%u", rule->volume.channels);
 249
 250             for (i = 0; i < rule->volume.channels; i++)
 251                 fprintf(f, " %u", rule->volume.values[i]);
 252         }
 253
 254         fprintf(f, "\n%s\n%s\n",
 255                 rule->sink ? rule->sink : "",
 256                 rule->source ? rule->source : "");
 257     }
 258
 259     ret = 0;
 260     u->modified = FALSE;
 261     pa_log_debug("Successfully saved rules...");
 262
 263 finish:
 264     if (f) {
 265         pa_lock_fd(fileno(f), 0);
 266         fclose(f);
 267     }
 268
 269     return ret;
 270 }
 271
 272 static char* client_name(pa_client *c) {
 273     char *t, *e;
 274
 275     if (!pa_proplist_gets(c->proplist, PA_PROP_APPLICATION_NAME) || !c->driver)
 276         return NULL;
 277
 278     t = pa_sprintf_malloc("%s$%s", c->driver, pa_proplist_gets(c->proplist, PA_PROP_APPLICATION_NAME));
 279     t[strcspn(t, "\n\r#")] = 0;
 280
 281     if (!*t) {
 282         pa_xfree(t);
 283         return NULL;
 284     }
 285
 286     if ((e = strrchr(t, '('))) {
 287         char *k = e + 1 + strspn(e + 1, "0123456789-");
 288
 289         /* Dirty trick: truncate all trailing parens with numbers in
 290          * between, since they are usually used to identify multiple
 291          * sessions of the same application, which is something we
 292          * explicitly don't want. Besides other stuff this makes xmms
 293          * with esound work properly for us. */
 294
 295         if (*k == ')' && *(k+1) == 0)
 296             *e = 0;
 297     }
 298
 299     return t;
 300 }
 301
 302 static void save_time_callback(pa_mainloop_api*a, pa_time_event* e, const struct timeval *tv, void *userdata) {
 303     struct userdata *u = userdata;
 304
 305     pa_assert(a);
 306     pa_assert(e);
 307     pa_assert(tv);
 308     pa_assert(u);
 309
 310     pa_assert(e == u->save_time_event);
 311     u->core->mainloop->time_free(u->save_time_event);
 312     u->save_time_event = NULL;
 313
 314     save_rules(u);
 315 }
 316
 317 static void subscribe_callback(pa_core *c, pa_subscription_event_type_t t, uint32_t idx, void *userdata) {
 318     struct userdata *u =  userdata;
 319     pa_sink_input *si = NULL;
 320     pa_source_output *so = NULL;
 321     struct rule *r;
 322     char *name;
 323
 324     pa_assert(c);
 325     pa_assert(u);
 326
 327     if (t != (PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_NEW) &&
 328         t != (PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE) &&
 329         t != (PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_NEW) &&
 330         t != (PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE))
 331         return;
 332
 333     if ((t & PA_SUBSCRIPTION_EVENT_FACILITY_MASK) == PA_SUBSCRIPTION_EVENT_SINK_INPUT) {
 334         if (!(si = pa_idxset_get_by_index(c->sink_inputs, idx)))
 335             return;
 336
 337         if (!si->client || !(name = client_name(si->client)))
 338             return;
 339     } else {
 340         pa_assert((t & PA_SUBSCRIPTION_EVENT_FACILITY_MASK) == PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT);
 341
 342         if (!(so = pa_idxset_get_by_index(c->source_outputs, idx)))
 343             return;
 344
 345         if (!so->client || !(name = client_name(so->client)))
 346             return;
 347     }
 348
 349     if ((r = pa_hashmap_get(u->hashmap, name))) {
 350         pa_xfree(name);
 351
 352         if (si) {
 353
 354             if (!r->volume_is_set || !pa_cvolume_equal(pa_sink_input_get_volume(si), &r->volume)) {
 355                 pa_log_info("Saving volume for <%s>", r->name);
 356                 r->volume = *pa_sink_input_get_volume(si);
 357                 r->volume_is_set = TRUE;
 358                 u->modified = TRUE;
 359             }
 360
 361             if (!r->sink || strcmp(si->sink->name, r->sink) != 0) {
 362                 pa_log_info("Saving sink for <%s>", r->name);
 363                 pa_xfree(r->sink);
 364                 r->sink = pa_xstrdup(si->sink->name);
 365                 u->modified = TRUE;
 366             }
 367         } else {
 368             pa_assert(so);
 369
 370             if (!r->source || strcmp(so->source->name, r->source) != 0) {
 371                 pa_log_info("Saving source for <%s>", r->name);
 372                 pa_xfree(r->source);
 373                 r->source = pa_xstrdup(so->source->name);
 374                 u->modified = TRUE;
 375             }
 376         }
 377
 378     } else {
 379         pa_log_info("Creating new entry for <%s>", name);
 380
 381         r = pa_xnew(struct rule, 1);
 382         r->name = name;
 383
 384         if (si) {
 385             r->volume = *pa_sink_input_get_volume(si);
 386             r->volume_is_set = TRUE;
 387             r->sink = pa_xstrdup(si->sink->name);
 388             r->source = NULL;
 389         } else {
 390             pa_assert(so);
 391             r->volume_is_set = FALSE;
 392             r->sink = NULL;
 393             r->source = pa_xstrdup(so->source->name);
 394         }
 395
 396         pa_hashmap_put(u->hashmap, r->name, r);
 397         u->modified = TRUE;
 398     }
 399
 400     if (u->modified && !u->save_time_event) {
 401         struct timeval tv;
 402         pa_gettimeofday(&tv);
 403         tv.tv_sec += SAVE_INTERVAL;
 404         u->save_time_event = u->core->mainloop->time_new(u->core->mainloop, &tv, save_time_callback, u);
 405     }
 406 }
 407
 408 static pa_hook_result_t sink_input_new_hook_callback(pa_core *c, pa_sink_input_new_data *data, struct userdata *u) {
 409     struct rule *r;
 410     char *name;
 411
 412     pa_assert(data);
 413
 414     /* In the NEW hook we only adjust the device. Adjusting the volume
 415      * is left for the FIXATE hook */
 416
 417     if (!data->client || !(name = client_name(data->client)))
 418         return PA_HOOK_OK;
 419
 420     if ((r = pa_hashmap_get(u->hashmap, name))) {
 421         if (!data->sink && r->sink) {
 422             if ((data->sink = pa_namereg_get(c, r->sink, PA_NAMEREG_SINK, 1)))
 423                 pa_log_info("Restoring sink for <%s>", r->name);
 424         }
 425     }
 426
 427     pa_xfree(name);
 428
 429     return PA_HOOK_OK;
 430 }
 431
 432 static pa_hook_result_t sink_input_fixate_hook_callback(pa_core *c, pa_sink_input_new_data *data, struct userdata *u) {
 433     struct rule *r;
 434     char *name;
 435
 436     pa_assert(data);
 437
 438     /* In the FIXATE hook we only adjust the volum. Adjusting the device
 439      * is left for the NEW hook */
 440
 441     if (!data->client || !(name = client_name(data->client)))
 442         return PA_HOOK_OK;
 443
 444     if ((r = pa_hashmap_get(u->hashmap, name))) {
 445
 446         if (r->volume_is_set && data->sample_spec.channels == r->volume.channels) {
 447             pa_log_info("Restoring volume for <%s>", r->name);
 448             pa_sink_input_new_data_set_volume(data, &r->volume);
 449         }
 450     }
 451
 452     pa_xfree(name);
 453
 454     return PA_HOOK_OK;
 455 }
 456
 457 static pa_hook_result_t source_output_new_hook_callback(pa_core *c, pa_source_output_new_data *data, struct userdata *u) {
 458     struct rule *r;
 459     char *name;
 460
 461     pa_assert(data);
 462
 463     if (!data->client || !(name = client_name(data->client)))
 464         return PA_HOOK_OK;
 465
 466     if ((r = pa_hashmap_get(u->hashmap, name))) {
 467         if (!data->source && r->source) {
 468             if ((data->source = pa_namereg_get(c, r->source, PA_NAMEREG_SOURCE, 1)))
 469                 pa_log_info("Restoring source for <%s>", r->name);
 470         }
 471     }
 472
 473     return PA_HOOK_OK;
 474 }
 475
 476 int pa__init(pa_module*m) {
 477     pa_modargs *ma = NULL;
 478     struct userdata *u;
 479     pa_bool_t restore_device = TRUE, restore_volume = TRUE;
 480
 481     pa_assert(m);
 482
 483     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 484         pa_log("Failed to parse module arguments");
 485         goto fail;
 486     }
 487
 488     u = pa_xnew(struct userdata, 1);
 489     u->core = m->core;
 490     u->hashmap = pa_hashmap_new(pa_idxset_string_hash_func, pa_idxset_string_compare_func);
 491     u->table_file = pa_runtime_path(pa_modargs_get_value(ma, "table", DEFAULT_VOLUME_TABLE_FILE));
 492     u->modified = FALSE;
 493     u->subscription = NULL;
 494     u->sink_input_new_hook_slot = u->sink_input_fixate_hook_slot = u->source_output_new_hook_slot = NULL;
 495     u->save_time_event = NULL;
 496
 497     m->userdata = u;
 498
 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");
 502         goto fail;
 503     }
 504
 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.");
 507         goto fail;
 508     }
 509
 510     if (load_rules(u) < 0)
 511         goto fail;
 512
 513     u->subscription = pa_subscription_new(m->core, PA_SUBSCRIPTION_MASK_SINK_INPUT|PA_SUBSCRIPTION_MASK_SOURCE_OUTPUT, subscribe_callback, u);
 514
 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_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_cb_t) source_output_new_hook_callback, u);
 518     }
 519
 520     if (restore_volume)
 521         u->sink_input_fixate_hook_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_INPUT_FIXATE], (pa_hook_cb_t) sink_input_fixate_hook_callback, u);
 522
 523     pa_modargs_free(ma);
 524     return 0;
 525
 526 fail:
 527     pa__done(m);
 528     if (ma)
 529         pa_modargs_free(ma);
 530
 531     return  -1;
 532 }
 533
 534 static void free_func(void *p, void *userdata) {
 535     struct rule *r = p;
 536     pa_assert(r);
 537
 538     pa_xfree(r->name);
 539     pa_xfree(r->sink);
 540     pa_xfree(r->source);
 541     pa_xfree(r);
 542 }
 543
 544 void pa__done(pa_module*m) {
 545     struct userdata* u;
 546
 547     pa_assert(m);
 548
 549     if (!(u = m->userdata))
 550         return;
 551
 552     if (u->subscription)
 553         pa_subscription_free(u->subscription);
 554
 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);
 561
 562     if (u->hashmap) {
 563         save_rules(u);
 564         pa_hashmap_free(u->hashmap, free_func, NULL);
 565     }
 566
 567     if (u->save_time_event)
 568         u->core->mainloop->time_free(u->save_time_event);
 569
 570     pa_xfree(u->table_file);
 571     pa_xfree(u);
 572 }