code.delx.au - pulseaudio/blob - 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 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
  60 #define SAVE_INTERVAL 10
  61
  62 static const char* const valid_modargs[] = {
  63     "restore_device",
  64     "restore_volume",
  65     "restore_muted",
  66     NULL
  67 };
  68
  69 struct userdata {
  70     pa_core *core;
  71     pa_module *module;
  72     pa_subscription *subscription;
  73     pa_hook_slot
  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;
  79     GDBM_FILE gdbm_file;
  80
  81     pa_bool_t restore_device:1;
  82     pa_bool_t restore_volume:1;
  83     pa_bool_t restore_muted:1;
  84
  85     pa_native_protocol *protocol;
  86     pa_idxset *subscribed;
  87 };
  88
  89 struct entry {
  90     char device[PA_NAME_MAX];
  91     pa_channel_map channel_map;
  92     pa_cvolume volume;
  93     pa_bool_t muted:1;
  94 };
  95
  96
  97 enum {
  98     SUBCOMMAND_TEST,
  99     SUBCOMMAND_READ,
 100     SUBCOMMAND_WRITE,
 101     SUBCOMMAND_DELETE,
 102     SUBCOMMAND_SUBSCRIBE,
 103     SUBCOMMAND_EVENT
 104 };
 105
 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;
 108
 109     pa_assert(a);
 110     pa_assert(e);
 111     pa_assert(tv);
 112     pa_assert(u);
 113
 114     pa_assert(e == u->save_time_event);
 115     u->core->mainloop->time_free(u->save_time_event);
 116     u->save_time_event = NULL;
 117
 118     gdbm_sync(u->gdbm_file);
 119     pa_log_info("Synced.");
 120 }
 121
 122 static char *get_name(pa_proplist *p, const char *prefix) {
 123     const char *r;
 124
 125     if (!p)
 126         return NULL;
 127
 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);
 136
 137     return NULL;
 138 }
 139
 140 static struct entry* read_entry(struct userdata *u, char *name) {
 141     datum key, data;
 142     struct entry *e;
 143
 144     pa_assert(u);
 145     pa_assert(name);
 146
 147     key.dptr = name;
 148     key.dsize = strlen(name);
 149
 150     data = gdbm_fetch(u->gdbm_file, key);
 151
 152     if (!data.dptr)
 153         goto fail;
 154
 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));
 157         goto fail;
 158     }
 159
 160     e = (struct entry*) data.dptr;
 161
 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);
 164         goto fail;
 165     }
 166
 167     if (!(pa_cvolume_valid(&e->volume))) {
 168         pa_log_warn("Invalid volume stored in database for stream %s", name);
 169         goto fail;
 170     }
 171
 172     if (!(pa_channel_map_valid(&e->channel_map))) {
 173         pa_log_warn("Invalid channel map stored in database for stream %s", name);
 174         goto fail;
 175     }
 176
 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);
 179         goto fail;
 180     }
 181
 182     return e;
 183
 184 fail:
 185
 186     pa_xfree(data.dptr);
 187     return NULL;
 188 }
 189
 190 static void trigger_save(struct userdata *u) {
 191     struct timeval tv;
 192     pa_native_connection *c;
 193     uint32_t idx;
 194
 195     for (c = pa_idxset_first(u->subscribed, &idx); c; c = pa_idxset_next(u->subscribed, &idx)) {
 196         pa_tagstruct *t;
 197
 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);
 204
 205         pa_pstream_send_tagstruct(pa_native_connection_get_pstream(c), t);
 206     }
 207
 208     if (u->save_time_event)
 209         return;
 210
 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);
 214 }
 215
 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;
 219     char *name;
 220     datum key, data;
 221
 222     pa_assert(c);
 223     pa_assert(u);
 224
 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))
 229         return;
 230
 231     memset(&entry, 0, sizeof(entry));
 232
 233     if ((t & PA_SUBSCRIPTION_EVENT_FACILITY_MASK) == PA_SUBSCRIPTION_EVENT_SINK_INPUT) {
 234         pa_sink_input *sink_input;
 235
 236         if (!(sink_input = pa_idxset_get_by_index(c->sink_inputs, idx)))
 237             return;
 238
 239         if (!(name = get_name(sink_input->proplist, "sink-input")))
 240             return;
 241
 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));
 246
 247     } else {
 248         pa_source_output *source_output;
 249
 250         pa_assert((t & PA_SUBSCRIPTION_EVENT_FACILITY_MASK) == PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT);
 251
 252         if (!(source_output = pa_idxset_get_by_index(c->source_outputs, idx)))
 253             return;
 254
 255         if (!(name = get_name(source_output->proplist, "source-output")))
 256             return;
 257
 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));
 263     }
 264
 265     if ((old = read_entry(u, name))) {
 266
 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) {
 270
 271             pa_xfree(old);
 272             pa_xfree(name);
 273             return;
 274         }
 275
 276         pa_xfree(old);
 277     }
 278
 279     key.dptr = name;
 280     key.dsize = strlen(name);
 281
 282     data.dptr = (void*) &entry;
 283     data.dsize = sizeof(entry);
 284
 285     pa_log_info("Storing volume/mute/device for stream %s.", name);
 286
 287     gdbm_store(u->gdbm_file, key, data, GDBM_REPLACE);
 288
 289     pa_xfree(name);
 290
 291     trigger_save(u);
 292 }
 293
 294 static pa_hook_result_t sink_input_new_hook_callback(pa_core *c, pa_sink_input_new_data *new_data, struct userdata *u) {
 295     char *name;
 296     struct entry *e;
 297
 298     pa_assert(new_data);
 299
 300     if (!(name = get_name(new_data->proplist, "sink-input")))
 301         return PA_HOOK_OK;
 302
 303     if ((e = read_entry(u, name))) {
 304         pa_sink *s;
 305
 306         if (u->restore_device &&
 307             (s = pa_namereg_get(c, e->device, PA_NAMEREG_SINK, TRUE))) {
 308
 309             pa_log_info("Restoring device for stream %s.", name);
 310             new_data->sink = s;
 311         }
 312
 313         pa_xfree(e);
 314     }
 315
 316     pa_xfree(name);
 317
 318     return PA_HOOK_OK;
 319 }
 320
 321 static pa_hook_result_t sink_input_fixate_hook_callback(pa_core *c, pa_sink_input_new_data *new_data, struct userdata *u) {
 322     char *name;
 323     struct entry *e;
 324
 325     pa_assert(new_data);
 326
 327     if (!(name = get_name(new_data->proplist, "sink-input")))
 328         return PA_HOOK_OK;
 329
 330     if ((e = read_entry(u, name))) {
 331
 332         if (u->restore_volume) {
 333             pa_log_info("Restoring volume for sink input %s.", name);
 334             pa_sink_input_new_data_set_volume(new_data, pa_cvolume_remap(&e->volume, &e->channel_map, &new_data->channel_map));
 335         }
 336
 337         if (u->restore_muted) {
 338             pa_log_info("Restoring mute state for sink input %s.", name);
 339             pa_sink_input_new_data_set_muted(new_data, e->muted);
 340         }
 341
 342         pa_xfree(e);
 343     }
 344
 345     pa_xfree(name);
 346
 347     return PA_HOOK_OK;
 348 }
 349
 350 static pa_hook_result_t source_output_new_hook_callback(pa_core *c, pa_source_output_new_data *new_data, struct userdata *u) {
 351     char *name;
 352     struct entry *e;
 353
 354     pa_assert(new_data);
 355
 356     if (!(name = get_name(new_data->proplist, "source-output")))
 357         return PA_HOOK_OK;
 358
 359     if ((e = read_entry(u, name))) {
 360         pa_source *s;
 361
 362         if (u->restore_device &&
 363             !new_data->direct_on_input &&
 364             (s = pa_namereg_get(c, e->device, PA_NAMEREG_SOURCE, TRUE))) {
 365
 366             pa_log_info("Restoring device for stream %s.", name);
 367             new_data->source = s;
 368         }
 369
 370         pa_xfree(e);
 371     }
 372
 373     pa_xfree(name);
 374
 375     return PA_HOOK_OK;
 376 }
 377
 378 #define EXT_VERSION 1
 379
 380 static void clear_db(struct userdata *u) {
 381     datum key;
 382
 383     pa_assert(u);
 384
 385     key = gdbm_firstkey(u->gdbm_file);
 386     while (key.dptr) {
 387         datum next_key;
 388         next_key = gdbm_nextkey(u->gdbm_file, key);
 389
 390         gdbm_delete(u->gdbm_file, key);
 391         pa_xfree(key.dptr);
 392
 393         key = next_key;
 394     }
 395
 396     gdbm_reorganize(u->gdbm_file);
 397 }
 398
 399 static void apply_entry(struct userdata *u, const char *name, struct entry *e) {
 400     pa_sink_input *si;
 401     pa_source_output *so;
 402     uint32_t idx;
 403
 404     pa_assert(u);
 405     pa_assert(name);
 406     pa_assert(e);
 407
 408     for (si = pa_idxset_first(u->core->sink_inputs, &idx); si; si = pa_idxset_next(u->core->sink_inputs, &idx)) {
 409         char *n;
 410         pa_sink *s;
 411
 412         if (!(n = get_name(si->proplist, "sink_input")))
 413             continue;
 414
 415         if (strcmp(name, n)) {
 416             pa_xfree(n);
 417             continue;
 418         }
 419
 420         if (u->restore_volume) {
 421             pa_log_info("Restoring volume for sink input %s.", name);
 422             pa_sink_input_set_volume(si, pa_cvolume_remap(&e->volume, &e->channel_map, &si->channel_map));
 423         }
 424
 425         if (u->restore_muted) {
 426             pa_log_info("Restoring mute state for sink input %s.", name);
 427             pa_sink_input_set_mute(si, e->muted);
 428         }
 429
 430         if (u->restore_device &&
 431             (s = pa_namereg_get(u->core, e->device, PA_NAMEREG_SOURCE, TRUE))) {
 432
 433             pa_log_info("Restoring device for stream %s.", name);
 434             pa_sink_input_move_to(si, s);
 435         }
 436     }
 437
 438     for (so = pa_idxset_first(u->core->source_outputs, &idx); so; so = pa_idxset_next(u->core->source_outputs, &idx)) {
 439         char *n;
 440         pa_source *s;
 441
 442         if (!(n = get_name(so->proplist, "source-output")))
 443             continue;
 444
 445         if (strcmp(name, n)) {
 446             pa_xfree(n);
 447             continue;
 448         }
 449
 450         if (u->restore_device &&
 451             (s = pa_namereg_get(u->core, e->device, PA_NAMEREG_SOURCE, TRUE))) {
 452
 453             pa_log_info("Restoring device for stream %s.", name);
 454             pa_source_output_move_to(so, s);
 455         }
 456     }
 457 }
 458
 459 #if 0
 460 static void dump_database(struct userdata *u) {
 461     datum key;
 462
 463     key = gdbm_firstkey(u->gdbm_file);
 464     while (key.dptr) {
 465         datum next_key;
 466         struct entry *e;
 467         char *name;
 468
 469         next_key = gdbm_nextkey(u->gdbm_file, key);
 470
 471         name = pa_xstrndup(key.dptr, key.dsize);
 472         pa_xfree(key.dptr);
 473
 474         if ((e = read_entry(u, name))) {
 475             char t[256];
 476             pa_log("name=%s", name);
 477             pa_log("device=%s", e->device);
 478             pa_log("channel_map=%s", pa_channel_map_snprint(t, sizeof(t), &e->channel_map));
 479             pa_log("volume=%s", pa_cvolume_snprint(t, sizeof(t), &e->volume));
 480             pa_log("mute=%s", pa_yes_no(e->muted));
 481             pa_xfree(e);
 482         }
 483
 484         pa_xfree(name);
 485
 486         key = next_key;
 487     }
 488 }
 489 #endif
 490
 491 static int extension_cb(pa_native_protocol *p, pa_module *m, pa_native_connection *c, uint32_t tag, pa_tagstruct *t) {
 492     struct userdata *u;
 493     uint32_t command;
 494     pa_tagstruct *reply = NULL;
 495
 496     pa_assert(p);
 497     pa_assert(m);
 498     pa_assert(c);
 499     pa_assert(t);
 500
 501     u = m->userdata;
 502
 503     if (pa_tagstruct_getu32(t, &command) < 0)
 504         goto fail;
 505
 506     reply = pa_tagstruct_new(NULL, 0);
 507     pa_tagstruct_putu32(reply, PA_COMMAND_REPLY);
 508     pa_tagstruct_putu32(reply, tag);
 509
 510     switch (command) {
 511         case SUBCOMMAND_TEST: {
 512             if (!pa_tagstruct_eof(t))
 513                 goto fail;
 514
 515             pa_tagstruct_putu32(reply, EXT_VERSION);
 516             break;
 517         }
 518
 519         case SUBCOMMAND_READ: {
 520             datum key;
 521
 522             if (!pa_tagstruct_eof(t))
 523                 goto fail;
 524
 525             key = gdbm_firstkey(u->gdbm_file);
 526             while (key.dptr) {
 527                 datum next_key;
 528                 struct entry *e;
 529                 char *name;
 530
 531                 next_key = gdbm_nextkey(u->gdbm_file, key);
 532
 533                 name = pa_xstrndup(key.dptr, key.dsize);
 534                 pa_xfree(key.dptr);
 535
 536                 if ((e = read_entry(u, name))) {
 537                     pa_tagstruct_puts(reply, name);
 538                     pa_tagstruct_put_channel_map(reply, &e->channel_map);
 539                     pa_tagstruct_put_cvolume(reply, &e->volume);
 540                     pa_tagstruct_puts(reply, e->device);
 541                     pa_tagstruct_put_boolean(reply, e->muted);
 542
 543                     pa_xfree(e);
 544                 }
 545
 546                 pa_xfree(name);
 547
 548                 key = next_key;
 549             }
 550
 551             break;
 552         }
 553
 554         case SUBCOMMAND_WRITE: {
 555             uint32_t mode;
 556             pa_bool_t apply_immediately;
 557
 558             if (pa_tagstruct_getu32(t, &mode) < 0 ||
 559                 pa_tagstruct_get_boolean(t, &apply_immediately) < 0)
 560                 goto fail;
 561
 562             if (mode != PA_UPDATE_MERGE &&
 563                 mode != PA_UPDATE_REPLACE &&
 564                 mode != PA_UPDATE_SET)
 565                 goto fail;
 566
 567             if (mode == PA_UPDATE_SET)
 568                 clear_db(u);
 569
 570             while (!pa_tagstruct_eof(t)) {
 571                 const char *name, *device;
 572                 pa_bool_t muted;
 573                 struct entry entry;
 574                 datum key, data;
 575
 576                 memset(&entry, 0, sizeof(entry));
 577
 578                 if (pa_tagstruct_gets(t, &name) < 0 ||
 579                     pa_tagstruct_get_channel_map(t, &entry.channel_map) ||
 580                     pa_tagstruct_get_cvolume(t, &entry.volume) < 0 ||
 581                     pa_tagstruct_gets(t, &device) < 0 ||
 582                     pa_tagstruct_get_boolean(t, &muted) < 0)
 583                     goto fail;
 584
 585                 if (entry.channel_map.channels != entry.volume.channels)
 586                     goto fail;
 587
 588                 entry.muted = muted;
 589                 pa_strlcpy(entry.device, device, sizeof(entry.device));
 590
 591                 key.dptr = (void*) name;
 592                 key.dsize = strlen(name);
 593
 594                 data.dptr = (void*) &entry;
 595                 data.dsize = sizeof(entry);
 596
 597                 if (gdbm_store(u->gdbm_file, key, data, mode == PA_UPDATE_REPLACE ? GDBM_REPLACE : GDBM_INSERT) == 1)
 598                     if (apply_immediately)
 599                         apply_entry(u, name, &entry);
 600             }
 601
 602             trigger_save(u);
 603
 604             break;
 605         }
 606
 607         case SUBCOMMAND_DELETE:
 608
 609             while (!pa_tagstruct_eof(t)) {
 610                 const char *name;
 611                 datum key;
 612
 613                 if (pa_tagstruct_gets(t, &name) < 0)
 614                     goto fail;
 615
 616                 key.dptr = (void*) name;
 617                 key.dsize = strlen(name);
 618
 619                 gdbm_delete(u->gdbm_file, key);
 620             }
 621
 622             trigger_save(u);
 623
 624             break;
 625
 626         case SUBCOMMAND_SUBSCRIBE: {
 627
 628             pa_bool_t enabled;
 629
 630             if (pa_tagstruct_get_boolean(t, &enabled) < 0 ||
 631                 !pa_tagstruct_eof(t))
 632                 goto fail;
 633
 634             if (enabled)
 635                 pa_idxset_put(u->subscribed, c, NULL);
 636             else
 637                 pa_idxset_remove_by_data(u->subscribed, c, NULL);
 638
 639             break;
 640         }
 641
 642         default:
 643             goto fail;
 644     }
 645
 646     pa_pstream_send_tagstruct(pa_native_connection_get_pstream(c), reply);
 647     return 0;
 648
 649 fail:
 650
 651     if (reply)
 652         pa_tagstruct_free(reply);
 653
 654     return -1;
 655 }
 656
 657 static pa_hook_result_t connection_unlink_hook_cb(pa_native_protocol *p, pa_native_connection *c, struct userdata *u) {
 658     pa_assert(p);
 659     pa_assert(c);
 660     pa_assert(u);
 661
 662     pa_idxset_remove_by_data(u->subscribed, c, NULL);
 663     return PA_HOOK_OK;
 664 }
 665
 666 int pa__init(pa_module*m) {
 667     pa_modargs *ma = NULL;
 668     struct userdata *u;
 669     char *fname, *fn;
 670     pa_sink_input *si;
 671     pa_source_output *so;
 672     uint32_t idx;
 673     pa_bool_t restore_device = TRUE, restore_volume = TRUE, restore_muted = TRUE;
 674
 675     pa_assert(m);
 676
 677     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 678         pa_log("Failed to parse module arguments");
 679         goto fail;
 680     }
 681
 682     if (pa_modargs_get_value_boolean(ma, "restore_device", &restore_device) < 0 ||
 683         pa_modargs_get_value_boolean(ma, "restore_volume", &restore_volume) < 0 ||
 684         pa_modargs_get_value_boolean(ma, "restore_muted", &restore_muted) < 0) {
 685         pa_log("restore_device=, restore_volume= and restore_muted= expect boolean arguments");
 686         goto fail;
 687     }
 688
 689     if (!restore_muted && !restore_volume && !restore_device)
 690         pa_log_warn("Neither restoring volume, nor restoring muted, nor restoring device enabled!");
 691
 692     m->userdata = u = pa_xnew(struct userdata, 1);
 693     u->core = m->core;
 694     u->module = m;
 695     u->save_time_event = NULL;
 696     u->restore_device = restore_device;
 697     u->restore_volume = restore_volume;
 698     u->restore_muted = restore_muted;
 699     u->gdbm_file = NULL;
 700     u->subscribed = pa_idxset_new(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func);
 701
 702     u->protocol = pa_native_protocol_get(m->core);
 703     pa_native_protocol_install_ext(u->protocol, m, extension_cb);
 704
 705     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);
 706
 707     u->subscription = pa_subscription_new(m->core, PA_SUBSCRIPTION_MASK_SINK_INPUT|PA_SUBSCRIPTION_MASK_SOURCE_OUTPUT, subscribe_callback, u);
 708
 709     if (restore_device) {
 710         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);
 711         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);
 712     }
 713
 714     if (restore_volume || restore_muted)
 715         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);
 716
 717     /* We include the host identifier in the file name because gdbm
 718      * files are CPU dependant, and we don't want things to go wrong
 719      * if we are on a multiarch system. */
 720
 721     fn = pa_sprintf_malloc("stream-volumes."CANONICAL_HOST".gdbm");
 722     fname = pa_state_path(fn, TRUE);
 723     pa_xfree(fn);
 724
 725     if (!fname)
 726         goto fail;
 727
 728     if (!(u->gdbm_file = gdbm_open(fname, 0, GDBM_WRCREAT, 0600, NULL))) {
 729         pa_log("Failed to open volume database '%s': %s", fname, gdbm_strerror(gdbm_errno));
 730         pa_xfree(fname);
 731         goto fail;
 732     }
 733
 734     pa_log_info("Sucessfully opened database file '%s'.", fname);
 735     pa_xfree(fname);
 736
 737     for (si = pa_idxset_first(m->core->sink_inputs, &idx); si; si = pa_idxset_next(m->core->sink_inputs, &idx))
 738         subscribe_callback(m->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_NEW, si->index, u);
 739
 740     for (so = pa_idxset_first(m->core->source_outputs, &idx); so; so = pa_idxset_next(m->core->source_outputs, &idx))
 741         subscribe_callback(m->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_NEW, so->index, u);
 742
 743     pa_modargs_free(ma);
 744     return 0;
 745
 746 fail:
 747     pa__done(m);
 748
 749     if (ma)
 750         pa_modargs_free(ma);
 751
 752     return  -1;
 753 }
 754
 755 void pa__done(pa_module*m) {
 756     struct userdata* u;
 757
 758     pa_assert(m);
 759
 760     if (!(u = m->userdata))
 761         return;
 762
 763     if (u->subscription)
 764         pa_subscription_free(u->subscription);
 765
 766     if (u->sink_input_new_hook_slot)
 767         pa_hook_slot_free(u->sink_input_new_hook_slot);
 768     if (u->sink_input_fixate_hook_slot)
 769         pa_hook_slot_free(u->sink_input_fixate_hook_slot);
 770     if (u->source_output_new_hook_slot)
 771         pa_hook_slot_free(u->source_output_new_hook_slot);
 772
 773     if (u->connection_unlink_hook_slot)
 774         pa_hook_slot_free(u->connection_unlink_hook_slot);
 775
 776     if (u->save_time_event)
 777         u->core->mainloop->time_free(u->save_time_event);
 778
 779     if (u->gdbm_file)
 780         gdbm_close(u->gdbm_file);
 781
 782     if (u->protocol) {
 783         pa_native_protocol_remove_ext(u->protocol, m);
 784         pa_native_protocol_unref(u->protocol);
 785     }
 786
 787     if (u->subscribed)
 788         pa_idxset_free(u->subscribed, NULL, NULL);
 789
 790     pa_xfree(u);
 791 }