PulseAudio is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published
- by the Free Software Foundation; either version 2 of the License,
+ by the Free Software Foundation; either version 2.1 of the License,
or (at your option) any later version.
PulseAudio is distributed in the hope that it will be useful, but
#include <sys/types.h>
#include <stdio.h>
#include <stdlib.h>
-#include <ctype.h>
-#include <gdbm.h>
+#include <pulse/gccmacro.h>
#include <pulse/xmalloc.h>
-#include <pulse/volume.h>
#include <pulse/timeval.h>
-#include <pulse/util.h>
+#include <pulse/rtclock.h>
#include <pulsecore/core-error.h>
#include <pulsecore/module.h>
#include <pulsecore/core-subscribe.h>
#include <pulsecore/card.h>
#include <pulsecore/namereg.h>
+#include <pulsecore/database.h>
+#include <pulsecore/tagstruct.h>
#include "module-card-restore-symdef.h"
PA_MODULE_AUTHOR("Lennart Poettering");
PA_MODULE_DESCRIPTION("Automatically restore profile of cards");
PA_MODULE_VERSION(PACKAGE_VERSION);
-PA_MODULE_LOAD_ONCE(TRUE);
+PA_MODULE_LOAD_ONCE(true);
-#define SAVE_INTERVAL 10
+#define SAVE_INTERVAL (10 * PA_USEC_PER_SEC)
static const char* const valid_modargs[] = {
NULL
struct userdata {
pa_core *core;
pa_module *module;
- pa_subscription *subscription;
pa_hook_slot *card_new_hook_slot;
+ pa_hook_slot *card_put_hook_slot;
+ pa_hook_slot *card_profile_changed_hook_slot;
+ pa_hook_slot *card_profile_added_hook_slot;
+ pa_hook_slot *port_offset_hook_slot;
pa_time_event *save_time_event;
- GDBM_FILE gdbm_file;
+ pa_database *database;
+ bool hooks_connected;
};
-#define ENTRY_VERSION 1
+#define ENTRY_VERSION 2
-struct entry PA_GCC_PACKED {
+struct port_info {
+ char *name;
+ int64_t offset;
+};
+
+struct entry {
uint8_t version;
- char profile[PA_NAME_MAX];
+ char *profile;
+ pa_hashmap *ports; /* Port name -> struct port_info */
};
-static void save_time_callback(pa_mainloop_api*a, pa_time_event* e, const struct timeval *tv, void *userdata) {
+static void save_time_callback(pa_mainloop_api*a, pa_time_event* e, const struct timeval *t, void *userdata) {
struct userdata *u = userdata;
pa_assert(a);
pa_assert(e);
- pa_assert(tv);
pa_assert(u);
pa_assert(e == u->save_time_event);
u->core->mainloop->time_free(u->save_time_event);
u->save_time_event = NULL;
- gdbm_sync(u->gdbm_file);
+ pa_database_sync(u->database);
pa_log_info("Synced.");
}
-static struct entry* read_entry(struct userdata *u, const char *name) {
- datum key, data;
+static void trigger_save(struct userdata *u) {
+ if (u->save_time_event)
+ return;
+
+ u->save_time_event = pa_core_rttime_new(u->core, pa_rtclock_now() + SAVE_INTERVAL, save_time_callback, u);
+}
+
+static void port_info_free(struct port_info *p_info) {
+ pa_assert(p_info);
+
+ pa_xfree(p_info->name);
+ pa_xfree(p_info);
+}
+
+static struct entry* entry_new(void) {
+ struct entry *r = pa_xnew0(struct entry, 1);
+ r->version = ENTRY_VERSION;
+ r->ports = pa_hashmap_new_full(pa_idxset_string_hash_func, pa_idxset_string_compare_func, NULL, (pa_free_cb_t) port_info_free);
+ return r;
+}
+
+static struct port_info *port_info_new(pa_device_port *port) {
+ struct port_info *p_info;
+
+ if (port) {
+ p_info = pa_xnew(struct port_info, 1);
+ p_info->name = pa_xstrdup(port->name);
+ p_info->offset = port->latency_offset;
+ } else
+ p_info = pa_xnew0(struct port_info, 1);
+
+ return p_info;
+}
+
+static void entry_free(struct entry* e) {
+ pa_assert(e);
+
+ pa_xfree(e->profile);
+ pa_hashmap_free(e->ports);
+
+ pa_xfree(e);
+}
+
+static struct entry *entry_from_card(pa_card *card) {
+ struct port_info *p_info;
+ struct entry *entry;
+ pa_device_port *port;
+ void *state;
+
+ pa_assert(card);
+
+ entry = entry_new();
+ if (card->save_profile)
+ entry->profile = pa_xstrdup(card->active_profile->name);
+
+ PA_HASHMAP_FOREACH(port, card->ports, state) {
+ p_info = port_info_new(port);
+ pa_assert_se(pa_hashmap_put(entry->ports, p_info->name, p_info) >= 0);
+ }
+
+ return entry;
+}
+
+static bool entrys_equal(struct entry *a, struct entry *b) {
+ struct port_info *Ap_info, *Bp_info;
+ void *state;
+
+ pa_assert(a);
+ pa_assert(b);
+
+ if (!pa_streq(a->profile, b->profile) ||
+ pa_hashmap_size(a->ports) != pa_hashmap_size(b->ports))
+ return false;
+
+ PA_HASHMAP_FOREACH(Ap_info, a->ports, state) {
+ if ((Bp_info = pa_hashmap_get(b->ports, Ap_info->name))) {
+ if (Ap_info->offset != Bp_info->offset)
+ return false;
+ } else
+ return false;
+ }
+
+ return true;
+}
+
+static bool entry_write(struct userdata *u, const char *name, const struct entry *e) {
+ pa_tagstruct *t;
+ pa_datum key, data;
+ bool r;
+ void *state;
+ struct port_info *p_info;
+
+ pa_assert(u);
+ pa_assert(name);
+ pa_assert(e);
+
+ t = pa_tagstruct_new(NULL, 0);
+ pa_tagstruct_putu8(t, e->version);
+ pa_tagstruct_puts(t, e->profile);
+ pa_tagstruct_putu32(t, pa_hashmap_size(e->ports));
+
+ PA_HASHMAP_FOREACH(p_info, e->ports, state) {
+ pa_tagstruct_puts(t, p_info->name);
+ pa_tagstruct_puts64(t, p_info->offset);
+ }
+
+ key.data = (char *) name;
+ key.size = strlen(name);
+
+ data.data = (void*)pa_tagstruct_data(t, &data.size);
+
+ r = (pa_database_set(u->database, &key, &data, true) == 0);
+
+ pa_tagstruct_free(t);
+
+ return r;
+}
+
+#ifdef ENABLE_LEGACY_DATABASE_ENTRY_FORMAT
+
+#define LEGACY_ENTRY_VERSION 1
+static struct entry* legacy_entry_read(struct userdata *u, pa_datum *data) {
+ struct legacy_entry {
+ uint8_t version;
+ char profile[PA_NAME_MAX];
+ } PA_GCC_PACKED ;
+ struct legacy_entry *le;
struct entry *e;
+ pa_assert(u);
+ pa_assert(data);
+
+ if (data->size != sizeof(struct legacy_entry)) {
+ pa_log_debug("Size does not match.");
+ return NULL;
+ }
+
+ le = (struct legacy_entry*)data->data;
+
+ if (le->version != LEGACY_ENTRY_VERSION) {
+ pa_log_debug("Version mismatch.");
+ return NULL;
+ }
+
+ if (!memchr(le->profile, 0, sizeof(le->profile))) {
+ pa_log_warn("Profile has missing NUL byte.");
+ return NULL;
+ }
+
+ e = entry_new();
+ e->profile = pa_xstrdup(le->profile);
+ return e;
+}
+#endif
+
+static struct entry* entry_read(struct userdata *u, const char *name) {
+ pa_datum key, data;
+ struct entry *e = NULL;
+ pa_tagstruct *t = NULL;
+ const char* profile;
+
pa_assert(u);
pa_assert(name);
- key.dptr = (char*) name;
- key.dsize = (int) strlen(name);
+ key.data = (char*) name;
+ key.size = strlen(name);
- data = gdbm_fetch(u->gdbm_file, key);
+ pa_zero(data);
- if (!data.dptr)
+ if (!pa_database_get(u->database, &key, &data))
goto fail;
- if (data.dsize != sizeof(struct entry)) {
- pa_log_debug("Database contains entry for card %s of wrong size %lu != %lu. Probably due to upgrade, ignoring.", name, (unsigned long) data.dsize, (unsigned long) sizeof(struct entry));
+ t = pa_tagstruct_new(data.data, data.size);
+ e = entry_new();
+
+ if (pa_tagstruct_getu8(t, &e->version) < 0 ||
+ e->version > ENTRY_VERSION ||
+ pa_tagstruct_gets(t, &profile) < 0) {
+
goto fail;
}
- e = (struct entry*) data.dptr;
+ if (!profile)
+ profile = "";
- if (e->version != ENTRY_VERSION) {
- pa_log_debug("Version of database entry for card %s doesn't match our version. Probably due to upgrade, ignoring.", name);
- goto fail;
+ e->profile = pa_xstrdup(profile);
+
+ if (e->version >= 2) {
+ uint32_t port_count = 0;
+ const char *port_name = NULL;
+ int64_t port_offset = 0;
+ struct port_info *p_info;
+ unsigned i;
+
+ if (pa_tagstruct_getu32(t, &port_count) < 0)
+ goto fail;
+
+ for (i = 0; i < port_count; i++) {
+ if (pa_tagstruct_gets(t, &port_name) < 0 ||
+ !port_name ||
+ pa_hashmap_get(e->ports, port_name) ||
+ pa_tagstruct_gets64(t, &port_offset) < 0)
+ goto fail;
+
+ p_info = port_info_new(NULL);
+ p_info->name = pa_xstrdup(port_name);
+ p_info->offset = port_offset;
+
+ pa_assert_se(pa_hashmap_put(e->ports, p_info->name, p_info) >= 0);
+ }
}
- if (!memchr(e->profile, 0, sizeof(e->profile))) {
- pa_log_warn("Database contains entry for card %s with missing NUL byte in profile name", name);
+ if (!pa_tagstruct_eof(t))
goto fail;
- }
+
+ pa_tagstruct_free(t);
+ pa_datum_free(&data);
return e;
fail:
- pa_xfree(data.dptr);
+ pa_log_debug("Database contains invalid data for key: %s (probably pre-v1.0 data)", name);
+
+ if (e)
+ entry_free(e);
+ if (t)
+ pa_tagstruct_free(t);
+
+#ifdef ENABLE_LEGACY_DATABASE_ENTRY_FORMAT
+ pa_log_debug("Attempting to load legacy (pre-v1.0) data for key: %s", name);
+ if ((e = legacy_entry_read(u, &data))) {
+ pa_log_debug("Success. Saving new format for key: %s", name);
+ if (entry_write(u, name, e))
+ trigger_save(u);
+ pa_datum_free(&data);
+ return e;
+ } else
+ pa_log_debug("Unable to load legacy (pre-v1.0) data for key: %s. Ignoring.", name);
+#endif
+
+ pa_datum_free(&data);
return NULL;
}
-static void trigger_save(struct userdata *u) {
- struct timeval tv;
+static void show_full_info(pa_card *card) {
+ pa_assert(card);
- if (u->save_time_event)
- return;
+ if (card->save_profile)
+ pa_log_info("Storing profile and port latency offsets for card %s.", card->name);
+ else
+ pa_log_info("Storing port latency offsets for card %s.", card->name);
+}
+
+static pa_hook_result_t card_put_hook_callback(pa_core *c, pa_card *card, struct userdata *u) {
+ struct entry *entry, *old;
+
+ pa_assert(card);
+
+ entry = entry_from_card(card);
+
+ if ((old = entry_read(u, card->name))) {
+ if (!card->save_profile)
+ entry->profile = pa_xstrdup(old->profile);
+ if (entrys_equal(entry, old))
+ goto finish;
+ }
- pa_gettimeofday(&tv);
- tv.tv_sec += SAVE_INTERVAL;
- u->save_time_event = u->core->mainloop->time_new(u->core->mainloop, &tv, save_time_callback, u);
+ show_full_info(card);
+
+ if (entry_write(u, card->name, entry))
+ trigger_save(u);
+
+finish:
+ entry_free(entry);
+ if (old)
+ entry_free(old);
+
+ return PA_HOOK_OK;
}
-static void subscribe_callback(pa_core *c, pa_subscription_event_type_t t, uint32_t idx, void *userdata) {
- struct userdata *u = userdata;
- struct entry entry, *old;
- datum key, data;
- pa_card *card;
+static pa_hook_result_t card_profile_changed_callback(pa_core *c, pa_card *card, struct userdata *u) {
+ struct entry *entry;
- pa_assert(c);
- pa_assert(u);
+ pa_assert(card);
- if (t != (PA_SUBSCRIPTION_EVENT_CARD|PA_SUBSCRIPTION_EVENT_NEW) &&
- t != (PA_SUBSCRIPTION_EVENT_CARD|PA_SUBSCRIPTION_EVENT_CHANGE))
- return;
+ if (!card->save_profile)
+ return PA_HOOK_OK;
- memset(&entry, 0, sizeof(entry));
- entry.version = ENTRY_VERSION;
+ if ((entry = entry_read(u, card->name))) {
+ entry->profile = pa_xstrdup(card->active_profile->name);
+ pa_log_info("Storing card profile for card %s.", card->name);
+ } else {
+ entry = entry_from_card(card);
+ show_full_info(card);
+ }
- if (!(card = pa_idxset_get_by_index(c->cards, idx)))
- return;
+ if (entry_write(u, card->name, entry))
+ trigger_save(u);
+
+ entry_free(entry);
+ return PA_HOOK_OK;
+}
- pa_strlcpy(entry.profile, card->active_profile ? card->active_profile->name : "", sizeof(entry.profile));
+static pa_hook_result_t card_profile_added_callback(pa_core *c, pa_card_profile *profile, struct userdata *u) {
+ struct entry *entry;
- if ((old = read_entry(u, card->name))) {
+ pa_assert(profile);
- if (strncmp(old->profile, entry.profile, sizeof(entry.profile)) == 0) {
- pa_xfree(old);
- return;
- }
+ if (!(entry = entry_read(u, profile->card->name)))
+ return PA_HOOK_OK;
- pa_xfree(old);
+ if (pa_safe_streq(entry->profile, profile->name)) {
+ if (pa_card_set_profile(profile->card, profile->name, true) >= 0)
+ pa_log_info("Restored profile '%s' for card %s.", profile->name, profile->card->name);
}
- key.dptr = card->name;
- key.dsize = (int) strlen(card->name);
+ entry_free(entry);
+
+ return PA_HOOK_OK;
+}
+
+static pa_hook_result_t port_offset_change_callback(pa_core *c, pa_device_port *port, struct userdata *u) {
+ struct entry *entry;
+ pa_card *card;
+
+ pa_assert(port);
+ card = port->card;
- data.dptr = (void*) &entry;
- data.dsize = sizeof(entry);
+ if ((entry = entry_read(u, card->name))) {
+ struct port_info *p_info;
- pa_log_info("Storing profile for card %s.", card->name);
+ if ((p_info = pa_hashmap_get(entry->ports, port->name)))
+ p_info->offset = port->latency_offset;
+ else {
+ p_info = port_info_new(port);
+ pa_assert_se(pa_hashmap_put(entry->ports, p_info->name, p_info) >= 0);
+ }
+
+ pa_log_info("Storing latency offset for port %s on card %s.", port->name, card->name);
+
+ } else {
+ entry_from_card(card);
+ show_full_info(card);
+ }
- gdbm_store(u->gdbm_file, key, data, GDBM_REPLACE);
+ if (entry_write(u, card->name, entry))
+ trigger_save(u);
- trigger_save(u);
+ entry_free(entry);
+ return PA_HOOK_OK;
}
static pa_hook_result_t card_new_hook_callback(pa_core *c, pa_card_new_data *new_data, struct userdata *u) {
struct entry *e;
+ void *state;
+ pa_device_port *p;
+ struct port_info *p_info;
pa_assert(new_data);
- if ((e = read_entry(u, new_data->name)) && e->profile) {
+ if (!(e = entry_read(u, new_data->name)))
+ return PA_HOOK_OK;
+ if (e->profile[0]) {
if (!new_data->active_profile) {
pa_card_new_data_set_profile(new_data, e->profile);
- pa_log_info("Restoring profile for card %s.", new_data->name);
+ pa_log_info("Restored profile '%s' for card %s.", new_data->active_profile, new_data->name);
+ new_data->save_profile = true;
+
} else
pa_log_debug("Not restoring profile for card %s, because already set.", new_data->name);
-
- pa_xfree(e);
}
+ /* Always restore the latency offsets because their
+ * initial value is always 0 */
+
+ pa_log_info("Restoring port latency offsets for card %s.", new_data->name);
+
+ PA_HASHMAP_FOREACH(p_info, e->ports, state)
+ if ((p = pa_hashmap_get(new_data->ports, p_info->name)))
+ p->latency_offset = p_info->offset;
+
+ entry_free(e);
+
return PA_HOOK_OK;
}
int pa__init(pa_module*m) {
pa_modargs *ma = NULL;
struct userdata *u;
- char *fname, *fn;
- pa_card *card;
- uint32_t idx;
- int gdbm_cache_size;
+ char *fname;
pa_assert(m);
goto fail;
}
- m->userdata = u = pa_xnew(struct userdata, 1);
+ m->userdata = u = pa_xnew0(struct userdata, 1);
u->core = m->core;
u->module = m;
- u->save_time_event = NULL;
- u->gdbm_file = NULL;
-
- u->subscription = pa_subscription_new(m->core, PA_SUBSCRIPTION_MASK_CARD, subscribe_callback, u);
u->card_new_hook_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_CARD_NEW], PA_HOOK_EARLY, (pa_hook_cb_t) card_new_hook_callback, u);
+ u->card_put_hook_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_CARD_PUT], PA_HOOK_NORMAL, (pa_hook_cb_t) card_put_hook_callback, u);
+ u->card_profile_changed_hook_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_CARD_PROFILE_CHANGED], PA_HOOK_NORMAL, (pa_hook_cb_t) card_profile_changed_callback, u);
+ u->card_profile_added_hook_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_CARD_PROFILE_ADDED], PA_HOOK_NORMAL, (pa_hook_cb_t) card_profile_added_callback, u);
+ u->port_offset_hook_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_PORT_LATENCY_OFFSET_CHANGED], PA_HOOK_NORMAL, (pa_hook_cb_t) port_offset_change_callback, u);
+ u->hooks_connected = true;
- /* We include the host identifier in the file name because gdbm
- * files are CPU dependant, and we don't want things to go wrong
- * if we are on a multiarch system. */
-
- fn = pa_sprintf_malloc("card-database."CANONICAL_HOST".gdbm");
- fname = pa_state_path(fn, TRUE);
- pa_xfree(fn);
-
- if (!fname)
+ if (!(fname = pa_state_path("card-database", true)))
goto fail;
- if (!(u->gdbm_file = gdbm_open(fname, 0, GDBM_WRCREAT|GDBM_NOLOCK, 0600, NULL))) {
- pa_log("Failed to open volume database '%s': %s", fname, gdbm_strerror(gdbm_errno));
+ if (!(u->database = pa_database_open(fname, true))) {
+ pa_log("Failed to open volume database '%s': %s", fname, pa_cstrerror(errno));
pa_xfree(fname);
goto fail;
}
- /* By default the cache of gdbm is rather large, let's reduce it a bit to save memory */
- gdbm_cache_size = 10;
- gdbm_setopt(u->gdbm_file, GDBM_CACHESIZE, &gdbm_cache_size, sizeof(gdbm_cache_size));
-
- pa_log_info("Sucessfully opened database file '%s'.", fname);
+ pa_log_info("Successfully opened database file '%s'.", fname);
pa_xfree(fname);
- for (card = pa_idxset_first(m->core->cards, &idx); card; card = pa_idxset_next(m->core->cards, &idx))
- subscribe_callback(m->core, PA_SUBSCRIPTION_EVENT_CARD|PA_SUBSCRIPTION_EVENT_NEW, card->index, u);
-
pa_modargs_free(ma);
return 0;
if (ma)
pa_modargs_free(ma);
- return -1;
+ return -1;
}
void pa__done(pa_module*m) {
if (!(u = m->userdata))
return;
- if (u->subscription)
- pa_subscription_free(u->subscription);
-
- if (u->card_new_hook_slot)
+ if (u->hooks_connected) {
pa_hook_slot_free(u->card_new_hook_slot);
+ pa_hook_slot_free(u->card_put_hook_slot);
+ pa_hook_slot_free(u->card_profile_changed_hook_slot);
+ pa_hook_slot_free(u->card_profile_added_hook_slot);
+ pa_hook_slot_free(u->port_offset_hook_slot);
+ }
if (u->save_time_event)
u->core->mainloop->time_free(u->save_time_event);
- if (u->gdbm_file)
- gdbm_close(u->gdbm_file);
+ if (u->database)
+ pa_database_close(u->database);
pa_xfree(u);
}