src/modules/module-stream-restore.c

   1 /***
   2   This file is part of PulseAudio.
   3
   4   Copyright 2008 Lennart Poettering
   5
   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.
  10
  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.
  15
  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
  19   USA.
  20 ***/
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include <config.h>
  24 #endif
  25
  26 #include <unistd.h>
  27 #include <string.h>
  28 #include <errno.h>
  29 #include <sys/types.h>
  30 #include <stdio.h>
  31 #include <stdlib.h>
  32 #include <ctype.h>
  33 #include <gdbm.h>
  34
  35 #include <pulse/xmalloc.h>
  36 #include <pulse/volume.h>
  37 #include <pulse/timeval.h>
  38 #include <pulse/util.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 #include <pulsecore/protocol-native.h>
  50 #include <pulsecore/pstream.h>
  51 #include <pulsecore/pstream-util.h>
  52
  53 #include "module-stream-restore-symdef.h"
  54
  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);
  59 PA_MODULE_USAGE(
  60         "restore_device=<Save/restore sinks/sources?> "
  61         "restore_volume=<Save/restore volumes?> "
  62         "restore_muted=<Save/restore muted states?>");
  63
  64 #define SAVE_INTERVAL 10
  65 #define IDENTIFICATION_PROPERTY "module-stream-restore.id"
  66
  67 static const char* const valid_modargs[] = {
  68     "restore_device",
  69     "restore_volume",
  70     "restore_muted",
  71     NULL
  72 };
  73
  74 struct userdata {
  75     pa_core *core;
  76     pa_module *module;
  77     pa_subscription *subscription;
  78     pa_hook_slot
  79         *sink_input_new_hook_slot,
  80         *sink_input_fixate_hook_slot,
  81         *source_output_new_hook_slot,
  82         *connection_unlink_hook_slot;
  83     pa_time_event *save_time_event;
  84     GDBM_FILE gdbm_file;
  85
  86     pa_bool_t restore_device:1;
  87     pa_bool_t restore_volume:1;
  88     pa_bool_t restore_muted:1;
  89
  90     pa_native_protocol *protocol;
  91     pa_idxset *subscribed;
  92 };
  93
  94 #define ENTRY_VERSION 1
  95
  96 struct entry {
  97     uint8_t version;
  98     pa_bool_t muted_valid:1, relative_volume_valid:1, absolute_volume_valid:1, device_valid:1;
  99     pa_bool_t muted:1;
 100     pa_channel_map channel_map;
 101     pa_cvolume relative_volume;
 102     pa_cvolume absolute_volume;
 103     char device[PA_NAME_MAX];
 104 } PA_GCC_PACKED;
 105
 106 enum {
 107     SUBCOMMAND_TEST,
 108     SUBCOMMAND_READ,
 109     SUBCOMMAND_WRITE,
 110     SUBCOMMAND_DELETE,
 111     SUBCOMMAND_SUBSCRIBE,
 112     SUBCOMMAND_EVENT
 113 };
 114
 115 static void save_time_callback(pa_mainloop_api*a, pa_time_event* e, const struct timeval *tv, void *userdata) {
 116     struct userdata *u = userdata;
 117
 118     pa_assert(a);
 119     pa_assert(e);
 120     pa_assert(tv);
 121     pa_assert(u);
 122
 123     pa_assert(e == u->save_time_event);
 124     u->core->mainloop->time_free(u->save_time_event);
 125     u->save_time_event = NULL;
 126
 127     gdbm_sync(u->gdbm_file);
 128     pa_log_info("Synced.");
 129 }
 130
 131 static char *get_name(pa_proplist *p, const char *prefix) {
 132     const char *r;
 133     char *t;
 134
 135     if (!p)
 136         return NULL;
 137
 138     if ((r = pa_proplist_gets(p, IDENTIFICATION_PROPERTY)))
 139         return pa_xstrdup(r);
 140
 141     if ((r = pa_proplist_gets(p, PA_PROP_MEDIA_ROLE)))
 142         t = pa_sprintf_malloc("%s-by-media-role:%s", prefix, r);
 143     else if ((r = pa_proplist_gets(p, PA_PROP_APPLICATION_ID)))
 144         t = pa_sprintf_malloc("%s-by-application-id:%s", prefix, r);
 145     else if ((r = pa_proplist_gets(p, PA_PROP_APPLICATION_NAME)))
 146         t = pa_sprintf_malloc("%s-by-application-name:%s", prefix, r);
 147     else if ((r = pa_proplist_gets(p, PA_PROP_MEDIA_NAME)))
 148         t = pa_sprintf_malloc("%s-by-media-name:%s", prefix, r);
 149     else
 150         t = pa_sprintf_malloc("%s-fallback:%s", prefix, r);
 151
 152     pa_proplist_sets(p, IDENTIFICATION_PROPERTY, t);
 153     return t;
 154 }
 155
 156 static struct entry* read_entry(struct userdata *u, const char *name) {
 157     datum key, data;
 158     struct entry *e;
 159
 160     pa_assert(u);
 161     pa_assert(name);
 162
 163     key.dptr = (char*) name;
 164     key.dsize = (int) strlen(name);
 165
 166     data = gdbm_fetch(u->gdbm_file, key);
 167
 168     if (!data.dptr)
 169         goto fail;
 170
 171     if (data.dsize != sizeof(struct entry)) {
 172         /* This is probably just a database upgrade, hence let's not
 173          * consider this more than a debug message */
 174         pa_log_debug("Database contains entry for stream %s of wrong size %lu != %lu. Probably due to uprade, ignoring.", name, (unsigned long) data.dsize, (unsigned long) sizeof(struct entry));
 175         goto fail;
 176     }
 177
 178     e = (struct entry*) data.dptr;
 179
 180     if (e->version != ENTRY_VERSION) {
 181         pa_log_debug("Version of database entry for stream %s doesn't match our version. Probably due to upgrade, ignoring.", name);
 182         goto fail;
 183     }
 184
 185     if (!memchr(e->device, 0, sizeof(e->device))) {
 186         pa_log_warn("Database contains entry for stream %s with missing NUL byte in device name", name);
 187         goto fail;
 188     }
 189
 190     if (e->device_valid && !pa_namereg_is_valid_name(e->device)) {
 191         pa_log_warn("Invalid device name stored in database for stream %s", name);
 192         goto fail;
 193     }
 194
 195     if ((e->relative_volume_valid || e->absolute_volume_valid) && !pa_channel_map_valid(&e->channel_map)) {
 196         pa_log_warn("Invalid channel map stored in database for stream %s", name);
 197         goto fail;
 198     }
 199
 200     if ((e->relative_volume_valid && (!pa_cvolume_valid(&e->relative_volume) || e->relative_volume.channels != e->channel_map.channels)) ||
 201         (e->absolute_volume_valid && (!pa_cvolume_valid(&e->absolute_volume) || e->absolute_volume.channels != e->channel_map.channels))) {
 202         pa_log_warn("Invalid volume stored in database for stream %s", name);
 203         goto fail;
 204     }
 205
 206     return e;
 207
 208 fail:
 209
 210     pa_xfree(data.dptr);
 211     return NULL;
 212 }
 213
 214 static void trigger_save(struct userdata *u) {
 215     struct timeval tv;
 216     pa_native_connection *c;
 217     uint32_t idx;
 218
 219     for (c = pa_idxset_first(u->subscribed, &idx); c; c = pa_idxset_next(u->subscribed, &idx)) {
 220         pa_tagstruct *t;
 221
 222         t = pa_tagstruct_new(NULL, 0);
 223         pa_tagstruct_putu32(t, PA_COMMAND_EXTENSION);
 224         pa_tagstruct_putu32(t, 0);
 225         pa_tagstruct_putu32(t, u->module->index);
 226         pa_tagstruct_puts(t, u->module->name);
 227         pa_tagstruct_putu32(t, SUBCOMMAND_EVENT);
 228
 229         pa_pstream_send_tagstruct(pa_native_connection_get_pstream(c), t);
 230     }
 231
 232     if (u->save_time_event)
 233         return;
 234
 235     pa_gettimeofday(&tv);
 236     tv.tv_sec += SAVE_INTERVAL;
 237     u->save_time_event = u->core->mainloop->time_new(u->core->mainloop, &tv, save_time_callback, u);
 238 }
 239
 240 static pa_bool_t entries_equal(const struct entry *a, const struct entry *b) {
 241     pa_cvolume t;
 242
 243     pa_assert(a);
 244     pa_assert(b);
 245
 246     if (a->device_valid != b->device_valid ||
 247         (a->device_valid && strncmp(a->device, b->device, sizeof(a->device))))
 248         return FALSE;
 249
 250     if (a->muted_valid != b->muted_valid ||
 251         (a->muted_valid && (a->muted != b->muted)))
 252         return FALSE;
 253
 254     t = b->relative_volume;
 255     if (a->relative_volume_valid != b->relative_volume_valid ||
 256         (a->relative_volume_valid && !pa_cvolume_equal(pa_cvolume_remap(&t, &b->channel_map, &a->channel_map), &a->relative_volume)))
 257         return FALSE;
 258
 259     t = b->absolute_volume;
 260     if (a->absolute_volume_valid != b->absolute_volume_valid ||
 261         (a->absolute_volume_valid && !pa_cvolume_equal(pa_cvolume_remap(&t, &b->channel_map, &a->channel_map), &a->absolute_volume)))
 262         return FALSE;
 263
 264     return TRUE;
 265 }
 266
 267 static void subscribe_callback(pa_core *c, pa_subscription_event_type_t t, uint32_t idx, void *userdata) {
 268     struct userdata *u = userdata;
 269     struct entry entry, *old;
 270     char *name;
 271     datum key, data;
 272
 273     pa_assert(c);
 274     pa_assert(u);
 275
 276     if (t != (PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_NEW) &&
 277         t != (PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE) &&
 278         t != (PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_NEW) &&
 279         t != (PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE))
 280         return;
 281
 282     memset(&entry, 0, sizeof(entry));
 283     entry.version = ENTRY_VERSION;
 284
 285     if ((t & PA_SUBSCRIPTION_EVENT_FACILITY_MASK) == PA_SUBSCRIPTION_EVENT_SINK_INPUT) {
 286         pa_sink_input *sink_input;
 287
 288         if (!(sink_input = pa_idxset_get_by_index(c->sink_inputs, idx)))
 289             return;
 290
 291         if (!(name = get_name(sink_input->proplist, "sink-input")))
 292             return;
 293
 294         entry.channel_map = sink_input->channel_map;
 295
 296         pa_sink_input_get_relative_volume(sink_input, &entry.relative_volume);
 297         entry.relative_volume_valid = sink_input->save_volume;
 298
 299         if (sink_input->sink->flags & PA_SINK_FLAT_VOLUME) {
 300             entry.absolute_volume = *pa_sink_input_get_volume(sink_input);
 301             entry.absolute_volume_valid = sink_input->save_volume;
 302         } else
 303             entry.absolute_volume_valid = FALSE;
 304
 305         entry.muted = pa_sink_input_get_mute(sink_input);
 306         entry.muted_valid = sink_input->save_muted;
 307
 308         pa_strlcpy(entry.device, sink_input->sink->name, sizeof(entry.device));
 309         entry.device_valid = sink_input->save_sink;
 310
 311     } else {
 312         pa_source_output *source_output;
 313
 314         pa_assert((t & PA_SUBSCRIPTION_EVENT_FACILITY_MASK) == PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT);
 315
 316         if (!(source_output = pa_idxset_get_by_index(c->source_outputs, idx)))
 317             return;
 318
 319         if (!(name = get_name(source_output->proplist, "source-output")))
 320             return;
 321
 322         entry.channel_map = source_output->channel_map;
 323
 324         pa_strlcpy(entry.device, source_output->source->name, sizeof(entry.device));
 325         entry.device_valid = source_output->save_source;
 326     }
 327
 328     if ((old = read_entry(u, name))) {
 329
 330         if (entries_equal(old, &entry)) {
 331             pa_xfree(old);
 332             pa_xfree(name);
 333             return;
 334         }
 335
 336         pa_xfree(old);
 337     }
 338
 339     key.dptr = name;
 340     key.dsize = (int) strlen(name);
 341
 342     data.dptr = (void*) &entry;
 343     data.dsize = sizeof(entry);
 344
 345     pa_log_info("Storing volume/mute/device for stream %s.", name);
 346
 347     gdbm_store(u->gdbm_file, key, data, GDBM_REPLACE);
 348
 349     pa_xfree(name);
 350
 351     trigger_save(u);
 352 }
 353
 354 static pa_hook_result_t sink_input_new_hook_callback(pa_core *c, pa_sink_input_new_data *new_data, struct userdata *u) {
 355     char *name;
 356     struct entry *e;
 357
 358     pa_assert(new_data);
 359
 360     if (!u->restore_device)
 361         return PA_HOOK_OK;
 362
 363     if (!(name = get_name(new_data->proplist, "sink-input")))
 364         return PA_HOOK_OK;
 365
 366     if ((e = read_entry(u, name))) {
 367         pa_sink *s;
 368
 369         if (e->device_valid) {
 370
 371             if ((s = pa_namereg_get(c, e->device, PA_NAMEREG_SINK))) {
 372                 if (!new_data->sink) {
 373                     pa_log_info("Restoring device for stream %s.", name);
 374                     new_data->sink = s;
 375                     new_data->save_sink = TRUE;
 376                 } else
 377                     pa_log_info("Not restore device for stream %s, because already set.", name);
 378             }
 379         }
 380
 381         pa_xfree(e);
 382     }
 383
 384     pa_xfree(name);
 385
 386     return PA_HOOK_OK;
 387 }
 388
 389 static pa_hook_result_t sink_input_fixate_hook_callback(pa_core *c, pa_sink_input_new_data *new_data, struct userdata *u) {
 390     char *name;
 391     struct entry *e;
 392
 393     pa_assert(new_data);
 394
 395     if (!u->restore_volume && !u->restore_muted)
 396         return PA_HOOK_OK;
 397
 398     if (!(name = get_name(new_data->proplist, "sink-input")))
 399         return PA_HOOK_OK;
 400
 401     if ((e = read_entry(u, name))) {
 402
 403         if (u->restore_volume) {
 404
 405             if (!new_data->volume_is_set) {
 406                 pa_cvolume v;
 407                 pa_cvolume_init(&v);
 408
 409                 if (new_data->sink->flags & PA_SINK_FLAT_VOLUME) {
 410
 411                     /* We don't check for e->device_valid here because
 412                     that bit marks whether it is a good choice for
 413                     restoring, not just if the data is filled in. */
 414                     if (e->absolute_volume_valid &&
 415                         (e->device[0] == 0 || pa_streq(new_data->sink->name, e->device))) {
 416
 417                         v = e->absolute_volume;
 418                         new_data->volume_is_absolute = TRUE;
 419                     } else if (e->relative_volume_valid) {
 420                         v = e->relative_volume;
 421                         new_data->volume_is_absolute = FALSE;
 422                     }
 423
 424                 } else if (e->relative_volume_valid) {
 425                     v = e->relative_volume;
 426                     new_data->volume_is_absolute = FALSE;
 427                 }
 428
 429                 if (v.channels > 0) {
 430                     pa_log_info("Restoring volume for sink input %s.", name);
 431                     pa_sink_input_new_data_set_volume(new_data, pa_cvolume_remap(&v, &e->channel_map, &new_data->channel_map));
 432                     new_data->save_volume = TRUE;
 433                 }
 434             } else
 435                 pa_log_debug("Not restoring volume for sink input %s, because already set.", name);
 436         }
 437
 438         if (u->restore_muted && e->muted_valid) {
 439             if (!new_data->muted_is_set) {
 440                 pa_log_info("Restoring mute state for sink input %s.", name);
 441                 pa_sink_input_new_data_set_muted(new_data, e->muted);
 442                 new_data->save_muted = TRUE;
 443             } else
 444                 pa_log_debug("Not restoring mute state for sink input %s, because already set.", name);
 445         }
 446
 447         pa_xfree(e);
 448     }
 449
 450     pa_xfree(name);
 451
 452     return PA_HOOK_OK;
 453 }
 454
 455 static pa_hook_result_t source_output_new_hook_callback(pa_core *c, pa_source_output_new_data *new_data, struct userdata *u) {
 456     char *name;
 457     struct entry *e;
 458
 459     pa_assert(new_data);
 460
 461     if (!u->restore_device)
 462         return PA_HOOK_OK;
 463
 464     if (new_data->direct_on_input)
 465         return PA_HOOK_OK;
 466
 467     if (!(name = get_name(new_data->proplist, "source-output")))
 468         return PA_HOOK_OK;
 469
 470     if ((e = read_entry(u, name))) {
 471         pa_source *s;
 472
 473         if (e->device_valid) {
 474             if ((s = pa_namereg_get(c, e->device, PA_NAMEREG_SOURCE))) {
 475                 if (!new_data->source) {
 476                     pa_log_info("Restoring device for stream %s.", name);
 477                     new_data->source = s;
 478                     new_data->save_source = TRUE;
 479                 } else
 480                     pa_log_info("Not restoring device for stream %s, because already set", name);
 481             }
 482         }
 483
 484         pa_xfree(e);
 485     }
 486
 487     pa_xfree(name);
 488
 489     return PA_HOOK_OK;
 490 }
 491
 492 #define EXT_VERSION 1
 493
 494 static void clear_db(struct userdata *u) {
 495     datum key;
 496
 497     pa_assert(u);
 498
 499     key = gdbm_firstkey(u->gdbm_file);
 500     while (key.dptr) {
 501         datum next_key;
 502         next_key = gdbm_nextkey(u->gdbm_file, key);
 503
 504         gdbm_delete(u->gdbm_file, key);
 505         pa_xfree(key.dptr);
 506
 507         key = next_key;
 508     }
 509
 510     gdbm_reorganize(u->gdbm_file);
 511 }
 512
 513 static void apply_entry(struct userdata *u, const char *name, struct entry *e) {
 514     pa_sink_input *si;
 515     pa_source_output *so;
 516     uint32_t idx;
 517
 518     pa_assert(u);
 519     pa_assert(name);
 520     pa_assert(e);
 521
 522     for (si = pa_idxset_first(u->core->sink_inputs, &idx); si; si = pa_idxset_next(u->core->sink_inputs, &idx)) {
 523         char *n;
 524         pa_sink *s;
 525
 526         if (!(n = get_name(si->proplist, "sink-input")))
 527             continue;
 528
 529         if (!pa_streq(name, n)) {
 530             pa_xfree(n);
 531             continue;
 532         }
 533         pa_xfree(n);
 534
 535         if (u->restore_volume) {
 536             pa_cvolume v;
 537             pa_cvolume_init(&v);
 538
 539             if (si->sink->flags & PA_SINK_FLAT_VOLUME) {
 540
 541                 if (e->absolute_volume_valid &&
 542                     (e->device[0] == 0 || pa_streq(e->device, si->sink->name)))
 543                     v = e->absolute_volume;
 544                 else if (e->relative_volume_valid) {
 545                     pa_cvolume t = *pa_sink_get_volume(si->sink, FALSE);
 546                     pa_sw_cvolume_multiply(&v, &e->relative_volume, pa_cvolume_remap(&t, &si->sink->channel_map, &e->channel_map));
 547                 }
 548             } else if (e->relative_volume_valid)
 549                 v = e->relative_volume;
 550
 551             if (v.channels > 0) {
 552                 pa_log_info("Restoring volume for sink input %s.", name);
 553                 pa_sink_input_set_volume(si, pa_cvolume_remap(&v, &e->channel_map, &si->channel_map), TRUE);
 554             }
 555         }
 556
 557         if (u->restore_muted &&
 558             e->muted_valid) {
 559             pa_log_info("Restoring mute state for sink input %s.", name);
 560             pa_sink_input_set_mute(si, e->muted, TRUE);
 561         }
 562
 563         if (u->restore_device &&
 564             e->device_valid &&
 565             (s = pa_namereg_get(u->core, e->device, PA_NAMEREG_SINK))) {
 566
 567             pa_log_info("Restoring device for stream %s.", name);
 568             pa_sink_input_move_to(si, s, TRUE);
 569         }
 570     }
 571
 572     for (so = pa_idxset_first(u->core->source_outputs, &idx); so; so = pa_idxset_next(u->core->source_outputs, &idx)) {
 573         char *n;
 574         pa_source *s;
 575
 576         if (!(n = get_name(so->proplist, "source-output")))
 577             continue;
 578
 579         if (!pa_streq(name, n)) {
 580             pa_xfree(n);
 581             continue;
 582         }
 583         pa_xfree(n);
 584
 585         if (u->restore_device &&
 586             e->device_valid &&
 587             (s = pa_namereg_get(u->core, e->device, PA_NAMEREG_SOURCE))) {
 588
 589             pa_log_info("Restoring device for stream %s.", name);
 590             pa_source_output_move_to(so, s, TRUE);
 591         }
 592     }
 593 }
 594
 595 #if 0
 596 static void dump_database(struct userdata *u) {
 597     datum key;
 598
 599     key = gdbm_firstkey(u->gdbm_file);
 600     while (key.dptr) {
 601         datum next_key;
 602         struct entry *e;
 603         char *name;
 604
 605         next_key = gdbm_nextkey(u->gdbm_file, key);
 606
 607         name = pa_xstrndup(key.dptr, key.dsize);
 608         pa_xfree(key.dptr);
 609
 610         if ((e = read_entry(u, name))) {
 611             char t[256];
 612             pa_log("name=%s", name);
 613             pa_log("device=%s", e->device);
 614             pa_log("channel_map=%s", pa_channel_map_snprint(t, sizeof(t), &e->channel_map));
 615             pa_log("volume=%s", pa_cvolume_snprint(t, sizeof(t), &e->volume));
 616             pa_log("mute=%s", pa_yes_no(e->muted));
 617             pa_xfree(e);
 618         }
 619
 620         pa_xfree(name);
 621
 622         key = next_key;
 623     }
 624 }
 625 #endif
 626
 627 static int extension_cb(pa_native_protocol *p, pa_module *m, pa_native_connection *c, uint32_t tag, pa_tagstruct *t) {
 628     struct userdata *u;
 629     uint32_t command;
 630     pa_tagstruct *reply = NULL;
 631
 632     pa_assert(p);
 633     pa_assert(m);
 634     pa_assert(c);
 635     pa_assert(t);
 636
 637     u = m->userdata;
 638
 639     if (pa_tagstruct_getu32(t, &command) < 0)
 640         goto fail;
 641
 642     reply = pa_tagstruct_new(NULL, 0);
 643     pa_tagstruct_putu32(reply, PA_COMMAND_REPLY);
 644     pa_tagstruct_putu32(reply, tag);
 645
 646     switch (command) {
 647         case SUBCOMMAND_TEST: {
 648             if (!pa_tagstruct_eof(t))
 649                 goto fail;
 650
 651             pa_tagstruct_putu32(reply, EXT_VERSION);
 652             break;
 653         }
 654
 655         case SUBCOMMAND_READ: {
 656             datum key;
 657
 658             if (!pa_tagstruct_eof(t))
 659                 goto fail;
 660
 661             key = gdbm_firstkey(u->gdbm_file);
 662             while (key.dptr) {
 663                 datum next_key;
 664                 struct entry *e;
 665                 char *name;
 666
 667                 next_key = gdbm_nextkey(u->gdbm_file, key);
 668
 669                 name = pa_xstrndup(key.dptr, (size_t) key.dsize);
 670                 pa_xfree(key.dptr);
 671
 672                 if ((e = read_entry(u, name))) {
 673                     pa_cvolume r;
 674                     pa_channel_map cm;
 675
 676                     pa_tagstruct_puts(reply, name);
 677                     pa_tagstruct_put_channel_map(reply, (e->relative_volume_valid || e->absolute_volume_valid) ? &e->channel_map : pa_channel_map_init(&cm));
 678                     pa_tagstruct_put_cvolume(reply, e->absolute_volume_valid ? &e->absolute_volume : (e->relative_volume_valid ? &e->relative_volume : pa_cvolume_init(&r)));
 679                     pa_tagstruct_puts(reply, e->device_valid ? e->device : NULL);
 680                     pa_tagstruct_put_boolean(reply, e->muted_valid ? e->muted : FALSE);
 681
 682                     pa_xfree(e);
 683                 }
 684
 685                 pa_xfree(name);
 686
 687                 key = next_key;
 688             }
 689
 690             break;
 691         }
 692
 693         case SUBCOMMAND_WRITE: {
 694             uint32_t mode;
 695             pa_bool_t apply_immediately = FALSE;
 696
 697             if (pa_tagstruct_getu32(t, &mode) < 0 ||
 698                 pa_tagstruct_get_boolean(t, &apply_immediately) < 0)
 699                 goto fail;
 700
 701             if (mode != PA_UPDATE_MERGE &&
 702                 mode != PA_UPDATE_REPLACE &&
 703                 mode != PA_UPDATE_SET)
 704                 goto fail;
 705
 706             if (mode == PA_UPDATE_SET)
 707                 clear_db(u);
 708
 709             while (!pa_tagstruct_eof(t)) {
 710                 const char *name, *device;
 711                 pa_bool_t muted;
 712                 struct entry entry;
 713                 datum key, data;
 714                 int k;
 715
 716                 memset(&entry, 0, sizeof(entry));
 717                 entry.version = ENTRY_VERSION;
 718
 719                 if (pa_tagstruct_gets(t, &name) < 0 ||
 720                     pa_tagstruct_get_channel_map(t, &entry.channel_map) ||
 721                     pa_tagstruct_get_cvolume(t, &entry.absolute_volume) < 0 ||
 722                     pa_tagstruct_gets(t, &device) < 0 ||
 723                     pa_tagstruct_get_boolean(t, &muted) < 0)
 724                     goto fail;
 725
 726                 if (!name || !*name)
 727                     goto fail;
 728
 729                 entry.relative_volume = entry.absolute_volume;
 730                 entry.absolute_volume_valid = entry.relative_volume_valid = entry.relative_volume.channels > 0;
 731
 732                 if (entry.relative_volume_valid)
 733                     if (!pa_cvolume_compatible_with_channel_map(&entry.relative_volume, &entry.channel_map))
 734                         goto fail;
 735
 736                 entry.muted = muted;
 737                 entry.muted_valid = TRUE;
 738
 739                 if (device)
 740                     pa_strlcpy(entry.device, device, sizeof(entry.device));
 741                 entry.device_valid = !!entry.device[0];
 742
 743                 if (entry.device_valid &&
 744                     !pa_namereg_is_valid_name(entry.device))
 745                     goto fail;
 746
 747                 key.dptr = (void*) name;
 748                 key.dsize = (int) strlen(name);
 749
 750                 data.dptr = (void*) &entry;
 751                 data.dsize = sizeof(entry);
 752
 753                 if ((k = gdbm_store(u->gdbm_file, key, data, mode == PA_UPDATE_REPLACE ? GDBM_REPLACE : GDBM_INSERT)) == 0)
 754                     if (apply_immediately)
 755                         apply_entry(u, name, &entry);
 756             }
 757
 758             trigger_save(u);
 759
 760             break;
 761         }
 762
 763         case SUBCOMMAND_DELETE:
 764
 765             while (!pa_tagstruct_eof(t)) {
 766                 const char *name;
 767                 datum key;
 768
 769                 if (pa_tagstruct_gets(t, &name) < 0)
 770                     goto fail;
 771
 772                 key.dptr = (void*) name;
 773                 key.dsize = (int) strlen(name);
 774
 775                 gdbm_delete(u->gdbm_file, key);
 776             }
 777
 778             trigger_save(u);
 779
 780             break;
 781
 782         case SUBCOMMAND_SUBSCRIBE: {
 783
 784             pa_bool_t enabled;
 785
 786             if (pa_tagstruct_get_boolean(t, &enabled) < 0 ||
 787                 !pa_tagstruct_eof(t))
 788                 goto fail;
 789
 790             if (enabled)
 791                 pa_idxset_put(u->subscribed, c, NULL);
 792             else
 793                 pa_idxset_remove_by_data(u->subscribed, c, NULL);
 794
 795             break;
 796         }
 797
 798         default:
 799             goto fail;
 800     }
 801
 802     pa_pstream_send_tagstruct(pa_native_connection_get_pstream(c), reply);
 803     return 0;
 804
 805 fail:
 806
 807     if (reply)
 808         pa_tagstruct_free(reply);
 809
 810     return -1;
 811 }
 812
 813 static pa_hook_result_t connection_unlink_hook_cb(pa_native_protocol *p, pa_native_connection *c, struct userdata *u) {
 814     pa_assert(p);
 815     pa_assert(c);
 816     pa_assert(u);
 817
 818     pa_idxset_remove_by_data(u->subscribed, c, NULL);
 819     return PA_HOOK_OK;
 820 }
 821
 822 int pa__init(pa_module*m) {
 823     pa_modargs *ma = NULL;
 824     struct userdata *u;
 825     char *fname, *fn;
 826     pa_sink_input *si;
 827     pa_source_output *so;
 828     uint32_t idx;
 829     pa_bool_t restore_device = TRUE, restore_volume = TRUE, restore_muted = TRUE;
 830     int gdbm_cache_size;
 831
 832     pa_assert(m);
 833
 834     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 835         pa_log("Failed to parse module arguments");
 836         goto fail;
 837     }
 838
 839     if (pa_modargs_get_value_boolean(ma, "restore_device", &restore_device) < 0 ||
 840         pa_modargs_get_value_boolean(ma, "restore_volume", &restore_volume) < 0 ||
 841         pa_modargs_get_value_boolean(ma, "restore_muted", &restore_muted) < 0) {
 842         pa_log("restore_device=, restore_volume= and restore_muted= expect boolean arguments");
 843         goto fail;
 844     }
 845
 846     if (!restore_muted && !restore_volume && !restore_device)
 847         pa_log_warn("Neither restoring volume, nor restoring muted, nor restoring device enabled!");
 848
 849     m->userdata = u = pa_xnew(struct userdata, 1);
 850     u->core = m->core;
 851     u->module = m;
 852     u->save_time_event = NULL;
 853     u->restore_device = restore_device;
 854     u->restore_volume = restore_volume;
 855     u->restore_muted = restore_muted;
 856     u->gdbm_file = NULL;
 857     u->subscribed = pa_idxset_new(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func);
 858
 859     u->protocol = pa_native_protocol_get(m->core);
 860     pa_native_protocol_install_ext(u->protocol, m, extension_cb);
 861
 862     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);
 863
 864     u->subscription = pa_subscription_new(m->core, PA_SUBSCRIPTION_MASK_SINK_INPUT|PA_SUBSCRIPTION_MASK_SOURCE_OUTPUT, subscribe_callback, u);
 865
 866     if (restore_device) {
 867         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);
 868         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);
 869     }
 870
 871     if (restore_volume || restore_muted)
 872         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);
 873
 874     /* We include the host identifier in the file name because gdbm
 875      * files are CPU dependant, and we don't want things to go wrong
 876      * if we are on a multiarch system. */
 877
 878     fn = pa_sprintf_malloc("stream-volumes."CANONICAL_HOST".gdbm");
 879     fname = pa_state_path(fn, TRUE);
 880     pa_xfree(fn);
 881
 882     if (!fname)
 883         goto fail;
 884
 885     if (!(u->gdbm_file = gdbm_open(fname, 0, GDBM_WRCREAT|GDBM_NOLOCK, 0600, NULL))) {
 886         pa_log("Failed to open volume database '%s': %s", fname, gdbm_strerror(gdbm_errno));
 887         pa_xfree(fname);
 888         goto fail;
 889     }
 890
 891     /* By default the cache of gdbm is rather large, let's reduce it a bit to save memory */
 892     gdbm_cache_size = 10;
 893     gdbm_setopt(u->gdbm_file, GDBM_CACHESIZE, &gdbm_cache_size, sizeof(gdbm_cache_size));
 894
 895     pa_log_info("Sucessfully opened database file '%s'.", fname);
 896     pa_xfree(fname);
 897
 898     for (si = pa_idxset_first(m->core->sink_inputs, &idx); si; si = pa_idxset_next(m->core->sink_inputs, &idx))
 899         subscribe_callback(m->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_NEW, si->index, u);
 900
 901     for (so = pa_idxset_first(m->core->source_outputs, &idx); so; so = pa_idxset_next(m->core->source_outputs, &idx))
 902         subscribe_callback(m->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_NEW, so->index, u);
 903
 904     pa_modargs_free(ma);
 905     return 0;
 906
 907 fail:
 908     pa__done(m);
 909
 910     if (ma)
 911         pa_modargs_free(ma);
 912
 913     return  -1;
 914 }
 915
 916 void pa__done(pa_module*m) {
 917     struct userdata* u;
 918
 919     pa_assert(m);
 920
 921     if (!(u = m->userdata))
 922         return;
 923
 924     if (u->subscription)
 925         pa_subscription_free(u->subscription);
 926
 927     if (u->sink_input_new_hook_slot)
 928         pa_hook_slot_free(u->sink_input_new_hook_slot);
 929     if (u->sink_input_fixate_hook_slot)
 930         pa_hook_slot_free(u->sink_input_fixate_hook_slot);
 931     if (u->source_output_new_hook_slot)
 932         pa_hook_slot_free(u->source_output_new_hook_slot);
 933
 934     if (u->connection_unlink_hook_slot)
 935         pa_hook_slot_free(u->connection_unlink_hook_slot);
 936
 937     if (u->save_time_event)
 938         u->core->mainloop->time_free(u->save_time_event);
 939
 940     if (u->gdbm_file)
 941         gdbm_close(u->gdbm_file);
 942
 943     if (u->protocol) {
 944         pa_native_protocol_remove_ext(u->protocol, m);
 945         pa_native_protocol_unref(u->protocol);
 946     }
 947
 948     if (u->subscribed)
 949         pa_idxset_free(u->subscribed, NULL, NULL);
 950
 951     pa_xfree(u);
 952 }