#include <sys/types.h>
#include <stdio.h>
#include <stdlib.h>
-#include <ctype.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>
PA_MODULE_AUTHOR("Colin Guthrie");
PA_MODULE_DESCRIPTION("Keep track of devices (and their descriptions) both past and present and prioritise by role");
PA_MODULE_VERSION(PACKAGE_VERSION);
-PA_MODULE_LOAD_ONCE(TRUE);
+PA_MODULE_LOAD_ONCE(true);
PA_MODULE_USAGE(
"do_routing=<Automatically route streams based on a priority list (unique per-role)?> "
"on_hotplug=<When new device becomes available, recheck streams?> "
pa_native_protocol *protocol;
pa_idxset *subscribed;
- pa_bool_t on_hotplug;
- pa_bool_t on_rescue;
- pa_bool_t do_routing;
+ bool on_hotplug;
+ bool on_rescue;
+ bool do_routing;
role_indexes_t preferred_sinks;
role_indexes_t preferred_sources;
};
-#define ENTRY_VERSION 2
+#define ENTRY_VERSION 1
struct entry {
uint8_t version;
char *description;
- pa_bool_t user_set_description;
+ bool user_set_description;
char *icon;
role_indexes_t priority;
};
SUBCOMMAND_EVENT
};
+/* Forward declarations */
+#ifdef DUMP_DATABASE
+static void dump_database(struct userdata *);
+#endif
+static void notify_subscribers(struct 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(u);
+
+ pa_assert(e == u->save_time_event);
+ u->core->mainloop->time_free(u->save_time_event);
+ u->save_time_event = NULL;
+
+ pa_database_sync(u->database);
+ pa_log_info("Synced.");
+
+#ifdef DUMP_DATABASE
+ dump_database(u);
+#endif
+}
+
+static void trigger_save(struct userdata *u) {
+
+ pa_assert(u);
+
+ notify_subscribers(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 struct entry* entry_new(void) {
struct entry *r = pa_xnew0(struct entry, 1);
pa_xfree(e->description);
pa_xfree(e->icon);
+ pa_xfree(e);
}
+static bool entry_write(struct userdata *u, const char *name, const struct entry *e) {
+ pa_tagstruct *t;
+ pa_datum key, data;
+ bool r;
+
+ 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->description);
+ pa_tagstruct_put_boolean(t, e->user_set_description);
+ pa_tagstruct_puts(t, e->icon);
+ for (uint8_t i=0; i<ROLE_MAX; ++i)
+ pa_tagstruct_putu32(t, e->priority[i]);
+
+ 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 description[PA_NAME_MAX];
+ bool user_set_description;
+ char icon[PA_NAME_MAX];
+ role_indexes_t priority;
+ } 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->description, 0, sizeof(le->description))) {
+ pa_log_warn("Description has missing NUL byte.");
+ return NULL;
+ }
+
+ if (!le->description[0]) {
+ pa_log_warn("Description is empty.");
+ return NULL;
+ }
+
+ if (!memchr(le->icon, 0, sizeof(le->icon))) {
+ pa_log_warn("Icon has missing NUL byte.");
+ return NULL;
+ }
+
+ e = entry_new();
+ e->description = pa_xstrdup(le->description);
+ e->icon = pa_xstrdup(le->icon);
+ return e;
+}
+#endif
+
static struct entry* entry_read(struct userdata *u, const char *name) {
pa_datum key, data;
struct entry *e = NULL;
goto fail;
}
+ if (e->user_set_description && !description) {
+ pa_log("Entry has user_set_description set, but the description is NULL.");
+ goto fail;
+ }
+
+ if (e->user_set_description && !*description) {
+ pa_log("Entry has user_set_description set, but the description is empty.");
+ goto fail;
+ }
+
e->description = pa_xstrdup(description);
e->icon = pa_xstrdup(icon);
entry_free(e);
if (t)
pa_tagstruct_free(t);
- pa_datum_free(&data);
- return NULL;
-}
-
-static pa_bool_t entry_write(struct userdata *u, const char *name, const struct entry *e) {
- pa_tagstruct *t;
- pa_datum key, data;
- pa_bool_t r;
-
- 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->description);
- pa_tagstruct_put_boolean(t, e->user_set_description);
- pa_tagstruct_puts(t, e->icon);
- for (uint8_t i=0; i<ROLE_MAX; ++i)
- pa_tagstruct_putu32(t, e->priority[i]);
-
- 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);
+#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
- return r;
+ pa_datum_free(&data);
+ return NULL;
}
#ifdef DUMP_DATABASE
-static void dump_database_helper(struct userdata *u, uint32_t role_index, const char* human, pa_bool_t sink_mode) {
+static void dump_database_helper(struct userdata *u, uint32_t role_index, const char* human, bool sink_mode) {
pa_assert(u);
pa_assert(human);
static void dump_database(struct userdata *u) {
pa_datum key;
- pa_bool_t done;
+ bool done;
pa_assert(u);
strncpy(name, role_names[role], len);
for (int i = len+1; i < 12; ++i) name[i] = ' ';
name[len] = ':'; name[0] -= 32; name[12] = '\0';
- dump_database_helper(u, role, name, TRUE);
+ dump_database_helper(u, role, name, true);
}
pa_log_debug(" Sources:");
strncpy(name, role_names[role], len);
for (int i = len+1; i < 12; ++i) name[i] = ' ';
name[len] = ':'; name[0] -= 32; name[12] = '\0';
- dump_database_helper(u, role, name, FALSE);
+ dump_database_helper(u, role, name, false);
}
}
}
#endif
-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(u);
-
- pa_assert(e == u->save_time_event);
- u->core->mainloop->time_free(u->save_time_event);
- u->save_time_event = NULL;
-
- pa_database_sync(u->database);
- pa_log_info("Synced.");
-
-#ifdef DUMP_DATABASE
- dump_database(u);
-#endif
-}
-
static void notify_subscribers(struct userdata *u) {
pa_native_connection *c;
pa_assert(u);
- for (c = pa_idxset_first(u->subscribed, &idx); c; c = pa_idxset_next(u->subscribed, &idx)) {
+ PA_IDXSET_FOREACH(c, u->subscribed, idx) {
pa_tagstruct *t;
t = pa_tagstruct_new(NULL, 0);
}
}
-static void trigger_save(struct userdata *u) {
-
- pa_assert(u);
-
- notify_subscribers(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) {
+static bool entries_equal(const struct entry *a, const struct entry *b) {
pa_assert(a);
pa_assert(b);
if (!pa_streq(a->description, b->description)
|| a->user_set_description != b->user_set_description
|| !pa_streq(a->icon, b->icon))
- return FALSE;
+ return false;
for (int i=0; i < NUM_ROLES; ++i)
if (a->priority[i] != b->priority[i])
- return FALSE;
+ return false;
- return TRUE;
+ return true;
}
static char *get_name(const char *key, const char *prefix) {
entry->description = pa_xstrdup(old->description);
entry->icon = pa_xstrdup(old->icon);
} else {
- /* This is a new device, so make sure we write it's priority list correctly */
+ /* This is a new device, so make sure we write its priority list correctly */
role_indexes_t max_priority;
pa_datum key;
- pa_bool_t done;
+ bool done;
pa_zero(max_priority);
done = !pa_database_first(u->database, &key, NULL);
for (uint32_t i = 0; i < NUM_ROLES; ++i) {
entry->priority[i] = max_priority[i] + 1;
}
- entry->user_set_description = FALSE;
+ entry->user_set_description = false;
}
return old;
pa_assert(role);
for (uint32_t i = ROLE_NONE; i < NUM_ROLES; ++i)
- if (strcmp(role, role_names[i]) == 0)
+ if (pa_streq(role, role_names[i]))
return i;
return PA_INVALID_INDEX;
static void update_highest_priority_device_indexes(struct userdata *u, const char *prefix, void *ignore_device) {
role_indexes_t *indexes, highest_priority_available;
pa_datum key;
- pa_bool_t done, sink_mode;
+ bool done, sink_mode;
pa_assert(u);
pa_assert(prefix);
- sink_mode = (strcmp(prefix, "sink:") == 0);
+ sink_mode = pa_streq(prefix, "sink:");
if (sink_mode)
indexes = &u->preferred_sinks;
struct entry *e;
name = pa_xstrndup(key.data, key.size);
- device_name = get_name(name, prefix);
+ pa_assert_se(device_name = get_name(name, prefix));
if ((e = entry_read(u, name))) {
for (uint32_t i = 0; i < NUM_ROLES; ++i) {
/* We've found a device with a higher priority than that we've currently got,
so see if it is currently available or not and update our list */
uint32_t idx;
- pa_bool_t found = FALSE;
+ bool found = false;
if (sink_mode) {
pa_sink *sink;
PA_IDXSET_FOREACH(sink, u->core->sinks, idx) {
if ((pa_sink*) ignore_device == sink)
continue;
- if (strcmp(sink->name, device_name) == 0) {
- found = TRUE;
+ if (!PA_SINK_IS_LINKED(sink->state))
+ continue;
+ if (pa_streq(sink->name, device_name)) {
+ found = true;
idx = sink->index; /* Is this needed? */
break;
}
PA_IDXSET_FOREACH(source, u->core->sources, idx) {
if ((pa_source*) ignore_device == source)
continue;
- if (strcmp(source->name, device_name) == 0) {
- found = TRUE;
+ if (!PA_SOURCE_IS_LINKED(source->state))
+ continue;
+ if (pa_streq(source->name, device_name)) {
+ found = true;
idx = source->index; /* Is this needed? */
break;
}
}
}
-
static void route_sink_input(struct userdata *u, pa_sink_input *si) {
const char *role;
uint32_t role_index, device_index;
return;
if (si->sink != sink)
- pa_sink_input_move_to(si, sink, FALSE);
+ pa_sink_input_move_to(si, sink, false);
}
static pa_hook_result_t route_sink_inputs(struct userdata *u, pa_sink *ignore_sink) {
return;
if (so->source != source)
- pa_source_output_move_to(so, source, FALSE);
+ pa_source_output_move_to(so, source, false);
}
static pa_hook_result_t route_source_outputs(struct userdata *u, pa_source* ignore_source) {
t != (PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE))
return;
- entry = entry_new();
-
if ((t & PA_SUBSCRIPTION_EVENT_FACILITY_MASK) == PA_SUBSCRIPTION_EVENT_SINK_INPUT) {
pa_sink_input *si;
if (!(sink = pa_idxset_get_by_index(c->sinks, idx)))
return;
+ entry = entry_new();
name = pa_sprintf_malloc("sink:%s", sink->name);
old = load_or_initialize_entry(u, entry, name, "sink:");
if (source->monitor_of)
return;
+ entry = entry_new();
name = pa_sprintf_malloc("source:%s", source->name);
old = load_or_initialize_entry(u, entry, name, "source:");
pa_xfree(entry->icon);
entry->icon = pa_xstrdup(pa_proplist_gets(source->proplist, PA_PROP_DEVICE_ICON_NAME));
+ } else {
+ pa_assert_not_reached();
}
pa_assert(name);
name = pa_sprintf_malloc("sink:%s", new_data->name);
if ((e = entry_read(u, name))) {
- if (e->user_set_description && strncmp(e->description, pa_proplist_gets(new_data->proplist, PA_PROP_DEVICE_DESCRIPTION), sizeof(e->description)) != 0) {
+ if (e->user_set_description && !pa_safe_streq(e->description, pa_proplist_gets(new_data->proplist, PA_PROP_DEVICE_DESCRIPTION))) {
pa_log_info("Restoring description for sink %s.", new_data->name);
pa_proplist_sets(new_data->proplist, PA_PROP_DEVICE_DESCRIPTION, e->description);
}
name = pa_sprintf_malloc("source:%s", new_data->name);
if ((e = entry_read(u, name))) {
- if (e->user_set_description && strncmp(e->description, pa_proplist_gets(new_data->proplist, PA_PROP_DEVICE_DESCRIPTION), sizeof(e->description)) != 0) {
+ if (e->user_set_description && !pa_safe_streq(e->description, pa_proplist_gets(new_data->proplist, PA_PROP_DEVICE_DESCRIPTION))) {
/* NB, We cannot detect if we are a monitor here... this could mess things up a bit... */
pa_log_info("Restoring description for source %s.", new_data->name);
pa_proplist_sets(new_data->proplist, PA_PROP_DEVICE_DESCRIPTION, e->description);
pa_sink *sink;
if ((sink = pa_idxset_get_by_index(u->core->sinks, device_index))) {
- if (!pa_sink_input_new_data_set_sink(new_data, sink, FALSE))
+ if (!pa_sink_input_new_data_set_sink(new_data, sink, false))
pa_log_debug("Not restoring device for stream because no supported format was found");
}
}
pa_source *source;
if ((source = pa_idxset_get_by_index(u->core->sources, device_index)))
- if (!pa_source_output_new_data_set_source(new_data, source, FALSE))
+ if (!pa_source_output_new_data_set_source(new_data, source, false))
pa_log_debug("Not restoring device for stream because no supported format was found");
}
}
return PA_HOOK_OK;
}
-
static pa_hook_result_t sink_put_hook_callback(pa_core *c, PA_GCC_UNUSED pa_sink *sink, struct userdata *u) {
pa_assert(c);
pa_assert(u);
return route_source_outputs(u, source);
}
-
static void apply_entry(struct userdata *u, const char *name, struct entry *e) {
uint32_t idx;
char *n;
}
}
-
#define EXT_VERSION 1
static int extension_cb(pa_native_protocol *p, pa_module *m, pa_native_connection *c, uint32_t tag, pa_tagstruct *t) {
case SUBCOMMAND_READ: {
pa_datum key;
- pa_bool_t done;
+ bool done;
if (!pa_tagstruct_eof(t))
goto fail;
if ((device_name = get_name(name, "sink:"))) {
pa_sink* s;
PA_IDXSET_FOREACH(s, u->core->sinks, idx) {
- if (strcmp(s->name, device_name) == 0) {
+ if (pa_streq(s->name, device_name)) {
found_index = s->index;
break;
}
} else if ((device_name = get_name(name, "source:"))) {
pa_source* s;
PA_IDXSET_FOREACH(s, u->core->sources, idx) {
- if (strcmp(s->name, device_name) == 0) {
+ if (pa_streq(s->name, device_name)) {
found_index = s->index;
break;
}
if ((e = entry_read(u, device))) {
pa_xfree(e->description);
e->description = pa_xstrdup(description);
- e->user_set_description = TRUE;
+ e->user_set_description = true;
if (entry_write(u, (char *)device, e)) {
apply_entry(u, device, e);
case SUBCOMMAND_ROLE_DEVICE_PRIORITY_ROUTING: {
- pa_bool_t enable;
+ bool enable;
if (pa_tagstruct_get_boolean(t, &enable) < 0)
goto fail;
struct entry *e;
uint32_t role_index, n_devices;
pa_datum key;
- pa_bool_t done, sink_mode = TRUE;
+ bool done, sink_mode = true;
struct device_t { uint32_t prio; char *device; };
struct device_t *device;
struct device_t **devices;
uint32_t i, idx, offset;
pa_hashmap *h;
/*void *state;*/
- pa_bool_t first;
+ bool first;
if (pa_tagstruct_gets(t, &role) < 0 ||
pa_tagstruct_getu32(t, &n_devices) < 0 ||
/* Cycle through the devices given and make sure they exist */
h = pa_hashmap_new(pa_idxset_string_hash_func, pa_idxset_string_compare_func);
- first = TRUE;
+ first = true;
idx = 0;
for (i = 0; i < n_devices; ++i) {
const char *s;
pa_xfree(device);
}
- pa_hashmap_free(h, NULL, NULL);
+ pa_hashmap_free(h);
pa_log_error("Protocol error on reorder");
goto fail;
}
pa_xfree(device);
}
- pa_hashmap_free(h, NULL, NULL);
- pa_log_error("Client specified an unknown device in it's reorder list.");
+ pa_hashmap_free(h);
+ pa_log_error("Client specified an unknown device in its reorder list.");
goto fail;
}
entry_free(e);
if (first) {
- first = FALSE;
+ first = false;
sink_mode = (0 == strncmp("sink:", s, 5));
} else if ((sink_mode && 0 != strncmp("sink:", s, 5)) || (!sink_mode && 0 != strncmp("source:", s, 7))) {
while ((device = pa_hashmap_steal_first(h))) {
pa_xfree(device);
}
- pa_hashmap_free(h, NULL, NULL);
+ pa_hashmap_free(h);
pa_log_error("Attempted to reorder mixed devices (sinks and sources)");
goto fail;
}
- /* Add the device to our hashmap. If it's alredy in it, free it now and carry on */
+ /* Add the device to our hashmap. If it's already in it, free it now and carry on */
device = pa_xnew(struct device_t, 1);
device->device = pa_xstrdup(s);
if (pa_hashmap_put(h, device->device, device) == 0) {
}*/
/* Now cycle through our list and add all the devices.
- This has the effect of addign in any in our DB,
+ This has the effect of adding in any in our DB,
not specified in the device list (and thus will be
tacked on at the end) */
offset = idx;
if ((sink_mode && 0 == strncmp("sink:", device->device, 5))
|| (!sink_mode && 0 == strncmp("source:", device->device, 7))) {
- /* Add the device to our hashmap. If it's alredy in it, free it now and carry on */
+ /* Add the device to our hashmap. If it's already in it, free it now and carry on */
if (pa_hashmap_put(h, device->device, device) == 0
&& (e = entry_read(u, device->device))) {
- /* We add offset on to the existing priorirty so that when we order, the
+ /* We add offset on to the existing priority so that when we order, the
existing entries are always lower priority than the new ones. */
device->prio = (offset + e->priority[role_index]);
pa_xfree(e);
while ((device = pa_hashmap_steal_first(h))) {
devices[idx++] = device;
}
- pa_hashmap_free(h, NULL, NULL);
+ pa_hashmap_free(h);
/* Simple bubble sort */
for (i = 0; i < n_devices; ++i) {
/* Go through in order and write the new entry and cleanup our own list */
idx = 1;
- first = TRUE;
+ first = true;
for (i = 0; i < n_devices; ++i) {
if ((e = entry_read(u, devices[i]->device))) {
if (e->priority[role_index] == idx)
e->priority[role_index] = idx;
if (entry_write(u, (char *) devices[i]->device, e)) {
- first = FALSE;
+ first = false;
idx++;
}
}
pa_xfree(devices[i]);
}
+ pa_xfree(devices);
+
if (!first) {
trigger_save(u);
case SUBCOMMAND_SUBSCRIBE: {
- pa_bool_t enabled;
+ bool enabled;
if (pa_tagstruct_get_boolean(t, &enabled) < 0 ||
!pa_tagstruct_eof(t))
pa_sink *sink;
pa_source *source;
uint32_t idx;
- pa_bool_t do_routing = FALSE, on_hotplug = TRUE, on_rescue = TRUE;
+ bool do_routing = false, on_hotplug = true, on_rescue = true;
uint32_t total_devices;
pa_assert(m);
u->source_unlink_hook_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SOURCE_UNLINK], PA_HOOK_LATE+5, (pa_hook_cb_t) source_unlink_hook_callback, u);
}
- if (!(fname = pa_state_path("device-manager", TRUE)))
+ if (!(fname = pa_state_path("device-manager", true)))
goto fail;
- if (!(u->database = pa_database_open(fname, TRUE))) {
+ 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;
for (uint32_t j = 0; j < i; ++j)
subscribe_callback(m->core, PA_SUBSCRIPTION_EVENT_SINK|PA_SUBSCRIPTION_EVENT_NEW, p_i[j].index, u);
-
/* We cycle over all the available sources so that they are added to our database if they are not in it yet */
i = 0;
PA_IDXSET_FOREACH(source, m->core->sources, idx) {
}
if (u->subscribed)
- pa_idxset_free(u->subscribed, NULL, NULL);
+ pa_idxset_free(u->subscribed, NULL);
pa_xfree(u);
}