/***
This file is part of PulseAudio.
- Copyright 2006 Lennart Poettering
+ Copyright 2006-2008 Lennart Poettering
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 <stdio.h>
#include <stdlib.h>
#include <ctype.h>
-#include <gdbm.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/sink-input.h>
#include <pulsecore/source-output.h>
#include <pulsecore/namereg.h>
+#include <pulsecore/database.h>
#include "module-device-restore-symdef.h"
PA_MODULE_DESCRIPTION("Automatically restore the volume/mute state of devices");
PA_MODULE_VERSION(PACKAGE_VERSION);
PA_MODULE_LOAD_ONCE(TRUE);
+PA_MODULE_USAGE(
+ "restore_port=<Save/restore port?> "
+ "restore_volume=<Save/restore volumes?> "
+ "restore_muted=<Save/restore muted states?>");
-#define SAVE_INTERVAL 10
+#define SAVE_INTERVAL (10 * PA_USEC_PER_SEC)
static const char* const valid_modargs[] = {
- NULL,
+ "restore_volume",
+ "restore_muted",
+ "restore_port",
+ NULL
};
struct userdata {
pa_core *core;
+ pa_module *module;
pa_subscription *subscription;
- pa_hook_slot *sink_fixate_hook_slot, *source_fixate_hook_slot;
+ pa_hook_slot
+ *sink_new_hook_slot,
+ *sink_fixate_hook_slot,
+ *source_new_hook_slot,
+ *source_fixate_hook_slot;
pa_time_event *save_time_event;
- GDBM_FILE gdbm_file;
+ pa_database *database;
+
+ pa_bool_t restore_volume:1;
+ pa_bool_t restore_muted:1;
+ pa_bool_t restore_port:1;
};
+#define ENTRY_VERSION 2
+
struct entry {
+ uint8_t version;
+ pa_bool_t muted_valid:1, volume_valid:1, port_valid:1;
+ pa_bool_t muted:1;
+ pa_channel_map channel_map;
pa_cvolume volume;
- int muted;
-};
+ char port[PA_NAME_MAX];
+} PA_GCC_PACKED;
-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) {
+ pa_datum key, data;
+ struct entry *e;
+
+ pa_assert(u);
+ pa_assert(name);
+
+ key.data = (char*) name;
+ key.size = strlen(name);
+
+ pa_zero(data);
+
+ if (!pa_database_get(u->database, &key, &data))
+ goto fail;
+
+ if (data.size != sizeof(struct entry)) {
+ pa_log_debug("Database contains entry for device %s of wrong size %lu != %lu. Probably due to upgrade, ignoring.", name, (unsigned long) data.size, (unsigned long) sizeof(struct entry));
+ goto fail;
+ }
+
+ e = (struct entry*) data.data;
+
+ if (e->version != ENTRY_VERSION) {
+ pa_log_debug("Version of database entry for device %s doesn't match our version. Probably due to upgrade, ignoring.", name);
+ goto fail;
+ }
+
+ if (!memchr(e->port, 0, sizeof(e->port))) {
+ pa_log_warn("Database contains entry for device %s with missing NUL byte in port name", name);
+ goto fail;
+ }
+
+ if (e->volume_valid && !pa_channel_map_valid(&e->channel_map)) {
+ pa_log_warn("Invalid channel map stored in database for device %s", name);
+ goto fail;
+ }
+
+ if (e->volume_valid && (!pa_cvolume_valid(&e->volume) || !pa_cvolume_compatible_with_channel_map(&e->volume, &e->channel_map))) {
+ pa_log_warn("Volume and channel map don't match in database entry for device %s", name);
+ goto fail;
+ }
+
+ return e;
+
+fail:
+
+ pa_datum_free(&data);
+ return NULL;
+}
+
+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 pa_bool_t entries_equal(const struct entry *a, const struct entry *b) {
+ pa_cvolume t;
+
+ if (a->port_valid != b->port_valid ||
+ (a->port_valid && strncmp(a->port, b->port, sizeof(a->port))))
+ return FALSE;
+
+ if (a->muted_valid != b->muted_valid ||
+ (a->muted_valid && (a->muted != b->muted)))
+ return FALSE;
+
+ t = b->volume;
+ if (a->volume_valid != b->volume_valid ||
+ (a->volume_valid && !pa_cvolume_equal(pa_cvolume_remap(&t, &b->channel_map, &a->channel_map), &a->volume)))
+ return FALSE;
+
+ return TRUE;
+}
+
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;
+ struct entry entry, *old;
char *name;
- datum key, data;
+ pa_datum key, data;
pa_assert(c);
pa_assert(u);
t != (PA_SUBSCRIPTION_EVENT_SOURCE|PA_SUBSCRIPTION_EVENT_CHANGE))
return;
+ pa_zero(entry);
+ entry.version = ENTRY_VERSION;
+
if ((t & PA_SUBSCRIPTION_EVENT_FACILITY_MASK) == PA_SUBSCRIPTION_EVENT_SINK) {
pa_sink *sink;
return;
name = pa_sprintf_malloc("sink:%s", sink->name);
- entry.volume = *pa_sink_get_volume(sink);
- entry.muted = pa_sink_get_mute(sink);
+
+ if ((old = read_entry(u, name)))
+ entry = *old;
+
+ if (sink->save_volume) {
+ entry.channel_map = sink->channel_map;
+ entry.volume = *pa_sink_get_volume(sink, FALSE);
+ entry.volume_valid = TRUE;
+ }
+
+ if (sink->save_muted) {
+ entry.muted = pa_sink_get_mute(sink, FALSE);
+ entry.muted_valid = TRUE;
+ }
+
+ if (sink->save_port) {
+ pa_strlcpy(entry.port, sink->active_port ? sink->active_port->name : "", sizeof(entry.port));
+ entry.port_valid = TRUE;
+ }
} else {
pa_source *source;
return;
name = pa_sprintf_malloc("source:%s", source->name);
- entry.volume = *pa_source_get_volume(source);
- entry.muted = pa_source_get_mute(source);
+
+ if ((old = read_entry(u, name)))
+ entry = *old;
+
+ if (source->save_volume) {
+ entry.channel_map = source->channel_map;
+ entry.volume = *pa_source_get_volume(source, FALSE);
+ entry.volume_valid = TRUE;
+ }
+
+ if (source->save_muted) {
+ entry.muted = pa_source_get_mute(source, FALSE);
+ entry.muted_valid = TRUE;
+ }
+
+ if (source->save_port) {
+ pa_strlcpy(entry.port, source->active_port ? source->active_port->name : "", sizeof(entry.port));
+ entry.port_valid = TRUE;
+ }
}
- key.dptr = name;
- key.dsize = strlen(name);
+ if (old) {
- data = gdbm_fetch(u->gdbm_file, key);
+ if (entries_equal(old, &entry)) {
+ pa_xfree(old);
+ pa_xfree(name);
+ return;
+ }
- if (data.dptr) {
+ pa_xfree(old);
+ }
- if (data.dsize == sizeof(struct entry)) {
- struct entry *old = (struct entry*) data.dptr;
+ key.data = name;
+ key.size = strlen(name);
- if (pa_cvolume_valid(&old->volume)) {
+ data.data = &entry;
+ data.size = sizeof(entry);
- if (pa_cvolume_equal(&old->volume, &entry.volume) &&
- !old->muted == !entry.muted) {
+ pa_log_info("Storing volume/mute/port for device %s.", name);
- pa_xfree(data.dptr);
- pa_xfree(name);
- return;
- }
- } else
- pa_log_warn("Invalid volume stored in database for device %s", name);
+ pa_database_set(u->database, &key, &data, TRUE);
- } else
- pa_log_warn("Database contains entry for device %s of wrong size %lu != %lu", name, (unsigned long) data.dsize, (unsigned long) sizeof(struct entry));
+ pa_xfree(name);
- pa_xfree(data.dptr);
- }
+ trigger_save(u);
+}
- data.dptr = (void*) &entry;
- data.dsize = sizeof(entry);
+static pa_hook_result_t sink_new_hook_callback(pa_core *c, pa_sink_new_data *new_data, struct userdata *u) {
+ char *name;
+ struct entry *e;
- pa_log_info("Storing volume/mute for device %s.", name);
+ pa_assert(c);
+ pa_assert(new_data);
+ pa_assert(u);
+ pa_assert(u->restore_port);
- gdbm_store(u->gdbm_file, key, data, GDBM_REPLACE);
+ name = pa_sprintf_malloc("sink:%s", new_data->name);
+
+ if ((e = read_entry(u, name))) {
- if (!u->save_time_event) {
- struct timeval tv;
- 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);
+ if (e->port_valid) {
+ if (!new_data->active_port) {
+ pa_log_info("Restoring port for sink %s.", name);
+ pa_sink_new_data_set_port(new_data, e->port);
+ new_data->save_port = TRUE;
+ } else
+ pa_log_debug("Not restoring port for sink %s, because already set.", name);
+ }
+
+ pa_xfree(e);
}
pa_xfree(name);
+
+ return PA_HOOK_OK;
}
-static struct entry* read_entry(struct userdata *u, char *name) {
- datum key, data;
+static pa_hook_result_t sink_fixate_hook_callback(pa_core *c, pa_sink_new_data *new_data, struct userdata *u) {
+ char *name;
struct entry *e;
+ pa_assert(c);
+ pa_assert(new_data);
pa_assert(u);
- pa_assert(name);
+ pa_assert(u->restore_volume || u->restore_muted);
- key.dptr = name;
- key.dsize = strlen(name);
+ name = pa_sprintf_malloc("sink:%s", new_data->name);
- data = gdbm_fetch(u->gdbm_file, key);
+ if ((e = read_entry(u, name))) {
- if (!data.dptr)
- goto fail;
+ if (u->restore_volume && e->volume_valid) {
- if (data.dsize != sizeof(struct entry)) {
- pa_log_warn("Database contains entry for device %s of wrong size %lu != %lu", name, (unsigned long) data.dsize, (unsigned long) sizeof(struct entry));
- goto fail;
- }
+ if (!new_data->volume_is_set) {
+ pa_cvolume v;
- e = (struct entry*) data.dptr;
+ pa_log_info("Restoring volume for sink %s.", new_data->name);
- if (!(pa_cvolume_valid(&e->volume))) {
- pa_log_warn("Invalid volume stored in database for device %s", name);
- goto fail;
- }
+ v = e->volume;
+ pa_cvolume_remap(&v, &e->channel_map, &new_data->channel_map);
+ pa_sink_new_data_set_volume(new_data, &v);
- return e;
+ new_data->save_volume = TRUE;
+ } else
+ pa_log_debug("Not restoring volume for sink %s, because already set.", new_data->name);
+ }
-fail:
+ if (u->restore_muted && e->muted_valid) {
- pa_xfree(data.dptr);
- return NULL;
-}
+ if (!new_data->muted_is_set) {
+ pa_log_info("Restoring mute state for sink %s.", new_data->name);
+ pa_sink_new_data_set_muted(new_data, e->muted);
+ new_data->save_muted = TRUE;
+ } else
+ pa_log_debug("Not restoring mute state for sink %s, because already set.", new_data->name);
+ }
+ pa_xfree(e);
+ }
-static pa_hook_result_t sink_fixate_hook_callback(pa_core *c, pa_sink_new_data *new_data, struct userdata *u) {
+ pa_xfree(name);
+
+ return PA_HOOK_OK;
+}
+
+static pa_hook_result_t source_new_hook_callback(pa_core *c, pa_source_new_data *new_data, struct userdata *u) {
char *name;
struct entry *e;
+ pa_assert(c);
pa_assert(new_data);
+ pa_assert(u);
+ pa_assert(u->restore_port);
- name = pa_sprintf_malloc("sink:%s", new_data->name);
+ name = pa_sprintf_malloc("source:%s", new_data->name);
if ((e = read_entry(u, name))) {
- if (e->volume.channels == new_data->sample_spec.channels) {
- pa_log_info("Restoring volume for sink %s.", new_data->name);
- pa_sink_new_data_set_volume(new_data, &e->volume);
+ if (e->port_valid) {
+ if (!new_data->active_port) {
+ pa_log_info("Restoring port for source %s.", name);
+ pa_source_new_data_set_port(new_data, e->port);
+ new_data->save_port = TRUE;
+ } else
+ pa_log_debug("Not restoring port for source %s, because already set.", name);
}
- pa_log_info("Restoring mute state for sink %s.", new_data->name);
- pa_sink_new_data_set_muted(new_data, e->muted);
pa_xfree(e);
}
char *name;
struct entry *e;
+ pa_assert(c);
pa_assert(new_data);
+ pa_assert(u);
+ pa_assert(u->restore_volume || u->restore_muted);
name = pa_sprintf_malloc("source:%s", new_data->name);
if ((e = read_entry(u, name))) {
- if (e->volume.channels == new_data->sample_spec.channels) {
- pa_log_info("Restoring volume for source %s.", new_data->name);
- pa_source_new_data_set_volume(new_data, &e->volume);
+ if (u->restore_volume && e->volume_valid) {
+
+ if (!new_data->volume_is_set) {
+ pa_cvolume v;
+
+ pa_log_info("Restoring volume for source %s.", new_data->name);
+
+ v = e->volume;
+ pa_cvolume_remap(&v, &e->channel_map, &new_data->channel_map);
+ pa_source_new_data_set_volume(new_data, &v);
+
+ new_data->save_volume = TRUE;
+ } else
+ pa_log_debug("Not restoring volume for source %s, because already set.", new_data->name);
+ }
+
+ if (u->restore_muted && e->muted_valid) {
+
+ if (!new_data->muted_is_set) {
+ pa_log_info("Restoring mute state for source %s.", new_data->name);
+ pa_source_new_data_set_muted(new_data, e->muted);
+ new_data->save_muted = TRUE;
+ } else
+ pa_log_debug("Not restoring mute state for source %s, because already set.", new_data->name);
}
- pa_log_info("Restoring mute state for source %s.", new_data->name);
- pa_source_new_data_set_muted(new_data, e->muted);
pa_xfree(e);
}
int pa__init(pa_module*m) {
pa_modargs *ma = NULL;
struct userdata *u;
- char *fname, *fn;
- char hn[256];
+ char *fname;
pa_sink *sink;
pa_source *source;
uint32_t idx;
+ pa_bool_t restore_volume = TRUE, restore_muted = TRUE, restore_port = TRUE;
pa_assert(m);
goto fail;
}
- u = pa_xnew(struct userdata, 1);
- u->core = m->core;
- u->save_time_event = NULL;
+ if (pa_modargs_get_value_boolean(ma, "restore_volume", &restore_volume) < 0 ||
+ pa_modargs_get_value_boolean(ma, "restore_muted", &restore_muted) < 0 ||
+ pa_modargs_get_value_boolean(ma, "restore_port", &restore_port) < 0) {
+ pa_log("restore_port=, restore_volume= and restore_muted= expect boolean arguments");
+ goto fail;
+ }
- u->subscription = pa_subscription_new(m->core, PA_SUBSCRIPTION_MASK_SINK|PA_SUBSCRIPTION_MASK_SOURCE, subscribe_callback, u);
+ if (!restore_muted && !restore_volume && !restore_port)
+ pa_log_warn("Neither restoring volume, nor restoring muted, nor restoring port enabled!");
- u->sink_fixate_hook_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_FIXATE], PA_HOOK_EARLY, (pa_hook_cb_t) sink_fixate_hook_callback, u);
- u->source_fixate_hook_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SOURCE_FIXATE], PA_HOOK_EARLY, (pa_hook_cb_t) source_fixate_hook_callback, u);
+ m->userdata = u = pa_xnew0(struct userdata, 1);
+ u->core = m->core;
+ u->module = m;
+ u->restore_volume = restore_volume;
+ u->restore_muted = restore_muted;
+ u->restore_port = restore_port;
- m->userdata = u;
+ u->subscription = pa_subscription_new(m->core, PA_SUBSCRIPTION_MASK_SINK|PA_SUBSCRIPTION_MASK_SOURCE, subscribe_callback, u);
- if (!pa_get_host_name(hn, sizeof(hn)))
- goto fail;
+ if (restore_port) {
+ u->sink_new_hook_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_NEW], PA_HOOK_EARLY, (pa_hook_cb_t) sink_new_hook_callback, u);
+ u->source_new_hook_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SOURCE_NEW], PA_HOOK_EARLY, (pa_hook_cb_t) source_new_hook_callback, u);
+ }
- fn = pa_sprintf_malloc("device-volumes.%s.gdbm", hn);
- fname = pa_state_path(fn);
- pa_xfree(fn);
+ if (restore_muted || restore_volume) {
+ u->sink_fixate_hook_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_FIXATE], PA_HOOK_EARLY, (pa_hook_cb_t) sink_fixate_hook_callback, u);
+ u->source_fixate_hook_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SOURCE_FIXATE], PA_HOOK_EARLY, (pa_hook_cb_t) source_fixate_hook_callback, u);
+ }
- if (!fname)
+ if (!(fname = pa_state_path("device-volumes", TRUE)))
goto fail;
- if (!(u->gdbm_file = gdbm_open(fname, 0, GDBM_WRCREAT, 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;
}
pa_hook_slot_free(u->sink_fixate_hook_slot);
if (u->source_fixate_hook_slot)
pa_hook_slot_free(u->source_fixate_hook_slot);
+ if (u->sink_new_hook_slot)
+ pa_hook_slot_free(u->sink_new_hook_slot);
+ if (u->source_new_hook_slot)
+ pa_hook_slot_free(u->source_new_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);
}