X-Git-Url: https://code.delx.au/pulseaudio/blobdiff_plain/e7b65d310d006dcff49d6c378bb501862683852b..ef4ae785aa1d4d67b5df1c9414f6c1a144bc3460:/src/modules/module-stream-restore.c diff --git a/src/modules/module-stream-restore.c b/src/modules/module-stream-restore.c index 22659df5..38d6aac6 100644 --- a/src/modules/module-stream-restore.c +++ b/src/modules/module-stream-restore.c @@ -51,6 +51,7 @@ #include #include #include +#include #ifdef HAVE_DBUS #include @@ -62,23 +63,30 @@ PA_MODULE_AUTHOR("Lennart Poettering"); PA_MODULE_DESCRIPTION("Automatically restore the volume/mute/device state of streams"); PA_MODULE_VERSION(PACKAGE_VERSION); -PA_MODULE_LOAD_ONCE(TRUE); +PA_MODULE_LOAD_ONCE(true); PA_MODULE_USAGE( "restore_device= " "restore_volume= " "restore_muted= " "on_hotplug= " - "on_rescue="); + "on_rescue= " + "fallback_table="); #define SAVE_INTERVAL (10 * PA_USEC_PER_SEC) #define IDENTIFICATION_PROPERTY "module-stream-restore.id" +#define DEFAULT_FALLBACK_FILE PA_DEFAULT_CONFIG_DIR"/stream-restore.table" +#define DEFAULT_FALLBACK_FILE_USER "stream-restore.table" + +#define WHITESPACE "\n\r \t" + static const char* const valid_modargs[] = { "restore_device", "restore_volume", "restore_muted", "on_hotplug", "on_rescue", + "fallback_table", NULL }; @@ -99,11 +107,11 @@ struct userdata { pa_time_event *save_time_event; pa_database* database; - pa_bool_t restore_device:1; - pa_bool_t restore_volume:1; - pa_bool_t restore_muted:1; - pa_bool_t on_hotplug:1; - pa_bool_t on_rescue:1; + bool restore_device:1; + bool restore_volume:1; + bool restore_muted:1; + bool on_hotplug:1; + bool on_rescue:1; pa_native_protocol *protocol; pa_idxset *subscribed; @@ -119,8 +127,8 @@ struct userdata { struct entry { uint8_t version; - pa_bool_t muted_valid, volume_valid, device_valid, card_valid; - pa_bool_t muted; + bool muted_valid, volume_valid, device_valid, card_valid; + bool muted; pa_channel_map channel_map; pa_cvolume volume; char* device; @@ -136,11 +144,10 @@ enum { SUBCOMMAND_EVENT }; - static struct entry* entry_new(void); static void entry_free(struct entry *e); static struct entry *entry_read(struct userdata *u, const char *name); -static pa_bool_t entry_write(struct userdata *u, const char *name, const struct entry *e, pa_bool_t replace); +static bool entry_write(struct userdata *u, const char *name, const struct entry *e, bool replace); static struct entry* entry_copy(const struct entry *e); static void entry_apply(struct userdata *u, const char *name, struct entry *e); static void trigger_save(struct userdata *u); @@ -222,11 +229,12 @@ enum entry_method_handler_index { ENTRY_METHOD_HANDLER_MAX }; -static pa_dbus_arg_info add_entry_args[] = { { "name", "s", "in" }, - { "device", "s", "in" }, - { "volume", "a(uu)", "in" }, - { "mute", "b", "in" }, - { "entry", "o", "out" } }; +static pa_dbus_arg_info add_entry_args[] = { { "name", "s", "in" }, + { "device", "s", "in" }, + { "volume", "a(uu)", "in" }, + { "mute", "b", "in" }, + { "apply_immediately", "b", "in" }, + { "entry", "o", "out" } }; static pa_dbus_arg_info get_entry_by_name_args[] = { { "name", "s", "in" }, { "entry", "o", "out" } }; static pa_dbus_method_handler method_handlers[METHOD_HANDLER_MAX] = { @@ -625,14 +633,14 @@ static void handle_add_entry(DBusConnection *conn, DBusMessage *msg, void *userd } if ((dbus_entry = pa_hashmap_get(u->dbus_entries, name))) { - pa_bool_t mute_updated = FALSE; - pa_bool_t volume_updated = FALSE; - pa_bool_t device_updated = FALSE; + bool mute_updated = false; + bool volume_updated = false; + bool device_updated = false; pa_assert_se(e = entry_read(u, name)); mute_updated = e->muted != muted; e->muted = muted; - e->muted_valid = TRUE; + e->muted_valid = true; volume_updated = (e->volume_valid != !!map.channels) || !pa_cvolume_equal(&e->volume, &vol); e->volume = vol; @@ -656,7 +664,7 @@ static void handle_add_entry(DBusConnection *conn, DBusMessage *msg, void *userd pa_assert_se(pa_hashmap_put(u->dbus_entries, dbus_entry->entry_name, dbus_entry) == 0); e = entry_new(); - e->muted_valid = TRUE; + e->muted_valid = true; e->volume_valid = !!map.channels; e->device_valid = !!device[0]; e->muted = muted; @@ -667,7 +675,7 @@ static void handle_add_entry(DBusConnection *conn, DBusMessage *msg, void *userd send_new_entry_signal(dbus_entry); } - pa_assert_se(entry_write(u, name, e, TRUE)); + pa_assert_se(entry_write(u, name, e, true)); if (apply_immediately) entry_apply(u, name, e); @@ -740,7 +748,7 @@ static void handle_entry_set_device(DBusConnection *conn, DBusMessage *msg, DBus struct dbus_entry *de = userdata; const char *device; struct entry *e; - pa_bool_t updated; + bool updated; pa_assert(conn); pa_assert(msg); @@ -758,7 +766,7 @@ static void handle_entry_set_device(DBusConnection *conn, DBusMessage *msg, DBus e->device = pa_xstrdup(device); e->device_valid = !!device[0]; - pa_assert_se(entry_write(de->userdata, de->entry_name, e, TRUE)); + pa_assert_se(entry_write(de->userdata, de->entry_name, e, true)); entry_apply(de->userdata, de->entry_name, e); send_device_updated_signal(de, e); @@ -797,7 +805,7 @@ static void handle_entry_set_volume(DBusConnection *conn, DBusMessage *msg, DBus pa_channel_map map; pa_cvolume vol; struct entry *e = NULL; - pa_bool_t updated = FALSE; + bool updated = false; pa_assert(conn); pa_assert(msg); @@ -816,7 +824,7 @@ static void handle_entry_set_volume(DBusConnection *conn, DBusMessage *msg, DBus e->channel_map = map; e->volume_valid = !!map.channels; - pa_assert_se(entry_write(de->userdata, de->entry_name, e, TRUE)); + pa_assert_se(entry_write(de->userdata, de->entry_name, e, true)); entry_apply(de->userdata, de->entry_name, e); send_volume_updated_signal(de, e); @@ -850,7 +858,7 @@ static void handle_entry_set_mute(DBusConnection *conn, DBusMessage *msg, DBusMe struct dbus_entry *de = userdata; dbus_bool_t mute; struct entry *e; - pa_bool_t updated; + bool updated; pa_assert(conn); pa_assert(msg); @@ -865,9 +873,9 @@ static void handle_entry_set_mute(DBusConnection *conn, DBusMessage *msg, DBusMe if (updated) { e->muted = mute; - e->muted_valid = TRUE; + e->muted_valid = true; - pa_assert_se(entry_write(de->userdata, de->entry_name, e, TRUE)); + pa_assert_se(entry_write(de->userdata, de->entry_name, e, true)); entry_apply(de->userdata, de->entry_name, e); send_mute_updated_signal(de, e); @@ -941,8 +949,7 @@ static void handle_entry_remove(DBusConnection *conn, DBusMessage *msg, void *us send_entry_removed_signal(de); trigger_save(de->userdata); - pa_assert_se(pa_hashmap_remove(de->userdata->dbus_entries, de->entry_name)); - dbus_entry_free(de); + pa_assert_se(pa_hashmap_remove_and_free(de->userdata->dbus_entries, de->entry_name) >= 0); pa_dbus_send_empty_reply(conn, msg); } @@ -964,31 +971,6 @@ static void save_time_callback(pa_mainloop_api*a, pa_time_event* e, const struct pa_log_info("Synced."); } -static char *get_name(pa_proplist *p, const char *prefix) { - const char *r; - char *t; - - if (!p) - return NULL; - - if ((r = pa_proplist_gets(p, IDENTIFICATION_PROPERTY))) - return pa_xstrdup(r); - - if ((r = pa_proplist_gets(p, PA_PROP_MEDIA_ROLE))) - t = pa_sprintf_malloc("%s-by-media-role:%s", prefix, r); - else if ((r = pa_proplist_gets(p, PA_PROP_APPLICATION_ID))) - t = pa_sprintf_malloc("%s-by-application-id:%s", prefix, r); - else if ((r = pa_proplist_gets(p, PA_PROP_APPLICATION_NAME))) - t = pa_sprintf_malloc("%s-by-application-name:%s", prefix, r); - else if ((r = pa_proplist_gets(p, PA_PROP_MEDIA_NAME))) - t = pa_sprintf_malloc("%s-by-media-name:%s", prefix, r); - else - t = pa_sprintf_malloc("%s-fallback:%s", prefix, r); - - pa_proplist_sets(p, IDENTIFICATION_PROPERTY, t); - return t; -} - static struct entry* entry_new(void) { struct entry *r = pa_xnew0(struct entry, 1); r->version = ENTRY_VERSION; @@ -1003,10 +985,10 @@ static void entry_free(struct entry* e) { pa_xfree(e); } -static pa_bool_t entry_write(struct userdata *u, const char *name, const struct entry *e, pa_bool_t replace) { +static bool entry_write(struct userdata *u, const char *name, const struct entry *e, bool replace) { pa_tagstruct *t; pa_datum key, data; - pa_bool_t r; + bool r; pa_assert(u); pa_assert(name); @@ -1039,42 +1021,73 @@ static pa_bool_t entry_write(struct userdata *u, const char *name, const struct #ifdef ENABLE_LEGACY_DATABASE_ENTRY_FORMAT #define LEGACY_ENTRY_VERSION 3 -static struct entry* legacy_entry_read(struct userdata *u, pa_datum *data) { +static struct entry *legacy_entry_read(struct userdata *u, const char *name) { struct legacy_entry { uint8_t version; - pa_bool_t muted_valid:1, volume_valid:1, device_valid:1, card_valid:1; - pa_bool_t muted:1; + bool muted_valid:1, volume_valid:1, device_valid:1, card_valid:1; + bool muted:1; pa_channel_map channel_map; pa_cvolume volume; char device[PA_NAME_MAX]; char card[PA_NAME_MAX]; } PA_GCC_PACKED; + + pa_datum key; + pa_datum data; struct legacy_entry *le; struct entry *e; pa_assert(u); - pa_assert(data); + pa_assert(name); + + key.data = (char *) name; + key.size = strlen(name); + + pa_zero(data); - if (data->size != sizeof(struct legacy_entry)) { + if (!pa_database_get(u->database, &key, &data)) + goto fail; + + if (data.size != sizeof(struct legacy_entry)) { pa_log_debug("Size does not match."); - return NULL; + goto fail; } - le = (struct legacy_entry*)data->data; + le = (struct legacy_entry *) data.data; if (le->version != LEGACY_ENTRY_VERSION) { pa_log_debug("Version mismatch."); - return NULL; + goto fail; } if (!memchr(le->device, 0, sizeof(le->device))) { pa_log_warn("Device has missing NUL byte."); - return NULL; + goto fail; } if (!memchr(le->card, 0, sizeof(le->card))) { pa_log_warn("Card has missing NUL byte."); - return NULL; + goto fail; + } + + if (le->device_valid && !pa_namereg_is_valid_name(le->device)) { + pa_log_warn("Invalid device name stored in database for legacy stream"); + goto fail; + } + + if (le->card_valid && !pa_namereg_is_valid_name(le->card)) { + pa_log_warn("Invalid card name stored in database for legacy stream"); + goto fail; + } + + if (le->volume_valid && !pa_channel_map_valid(&le->channel_map)) { + pa_log_warn("Invalid channel map stored in database for legacy stream"); + goto fail; + } + + if (le->volume_valid && (!pa_cvolume_valid(&le->volume) || !pa_cvolume_compatible_with_channel_map(&le->volume, &le->channel_map))) { + pa_log_warn("Invalid volume stored in database for legacy stream"); + goto fail; } e = entry_new(); @@ -1088,6 +1101,11 @@ static struct entry* legacy_entry_read(struct userdata *u, pa_datum *data) { e->card_valid = le->card_valid; e->card = pa_xstrdup(le->card); return e; + +fail: + pa_datum_free(&data); + + return NULL; } #endif @@ -1158,26 +1176,11 @@ static struct entry *entry_read(struct userdata *u, const char *name) { return e; fail: - - 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, TRUE)) - 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; } @@ -1197,7 +1200,7 @@ static void trigger_save(struct userdata *u) { pa_native_connection *c; uint32_t idx; - 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); @@ -1216,7 +1219,7 @@ static void trigger_save(struct userdata *u) { 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_cvolume t; pa_assert(a); @@ -1224,22 +1227,22 @@ static pa_bool_t entries_equal(const struct entry *a, const struct entry *b) { if (a->device_valid != b->device_valid || (a->device_valid && !pa_streq(a->device, b->device))) - return FALSE; + return false; if (a->card_valid != b->card_valid || (a->card_valid && !pa_streq(a->card, b->card))) - return FALSE; + return false; if (a->muted_valid != b->muted_valid || (a->muted_valid && (a->muted != b->muted))) - return FALSE; + 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 false; - return TRUE; + return true; } static void subscribe_callback(pa_core *c, pa_subscription_event_type_t t, uint32_t idx, void *userdata) { @@ -1249,10 +1252,10 @@ static void subscribe_callback(pa_core *c, pa_subscription_event_type_t t, uint3 /* These are only used when D-Bus is enabled, but in order to reduce ifdef * clutter these are defined here unconditionally. */ - pa_bool_t created_new_entry = TRUE; - pa_bool_t device_updated = FALSE; - pa_bool_t volume_updated = FALSE; - pa_bool_t mute_updated = FALSE; + bool created_new_entry = true; + bool device_updated = false; + bool volume_updated = false; + bool mute_updated = false; #ifdef HAVE_DBUS struct dbus_entry *de = NULL; @@ -1273,12 +1276,12 @@ static void subscribe_callback(pa_core *c, pa_subscription_event_type_t t, uint3 if (!(sink_input = pa_idxset_get_by_index(c->sink_inputs, idx))) return; - if (!(name = get_name(sink_input->proplist, "sink-input"))) + if (!(name = pa_proplist_get_stream_group(sink_input->proplist, "sink-input", IDENTIFICATION_PROPERTY))) return; if ((old = entry_read(u, name))) { entry = entry_copy(old); - created_new_entry = FALSE; + created_new_entry = false; } else entry = entry_new(); @@ -1286,8 +1289,8 @@ static void subscribe_callback(pa_core *c, pa_subscription_event_type_t t, uint3 pa_assert(sink_input->volume_writable); entry->channel_map = sink_input->channel_map; - pa_sink_input_get_volume(sink_input, &entry->volume, FALSE); - entry->volume_valid = TRUE; + pa_sink_input_get_volume(sink_input, &entry->volume, false); + entry->volume_valid = true; volume_updated = !created_new_entry && (!old->volume_valid @@ -1296,8 +1299,8 @@ static void subscribe_callback(pa_core *c, pa_subscription_event_type_t t, uint3 } if (sink_input->save_muted) { - entry->muted = pa_sink_input_get_mute(sink_input); - entry->muted_valid = TRUE; + entry->muted = sink_input->muted; + entry->muted_valid = true; mute_updated = !created_new_entry && (!old->muted_valid || entry->muted != old->muted); } @@ -1305,13 +1308,13 @@ static void subscribe_callback(pa_core *c, pa_subscription_event_type_t t, uint3 if (sink_input->save_sink) { pa_xfree(entry->device); entry->device = pa_xstrdup(sink_input->sink->name); - entry->device_valid = TRUE; + entry->device_valid = true; device_updated = !created_new_entry && (!old->device_valid || !pa_streq(entry->device, old->device)); if (sink_input->sink->card) { pa_xfree(entry->card); entry->card = pa_xstrdup(sink_input->sink->card->name); - entry->card_valid = TRUE; + entry->card_valid = true; } } @@ -1323,12 +1326,12 @@ static void subscribe_callback(pa_core *c, pa_subscription_event_type_t t, uint3 if (!(source_output = pa_idxset_get_by_index(c->source_outputs, idx))) return; - if (!(name = get_name(source_output->proplist, "source-output"))) + if (!(name = pa_proplist_get_stream_group(source_output->proplist, "source-output", IDENTIFICATION_PROPERTY))) return; if ((old = entry_read(u, name))) { entry = entry_copy(old); - created_new_entry = FALSE; + created_new_entry = false; } else entry = entry_new(); @@ -1336,8 +1339,8 @@ static void subscribe_callback(pa_core *c, pa_subscription_event_type_t t, uint3 pa_assert(source_output->volume_writable); entry->channel_map = source_output->channel_map; - pa_source_output_get_volume(source_output, &entry->volume, FALSE); - entry->volume_valid = TRUE; + pa_source_output_get_volume(source_output, &entry->volume, false); + entry->volume_valid = true; volume_updated = !created_new_entry && (!old->volume_valid @@ -1346,8 +1349,8 @@ static void subscribe_callback(pa_core *c, pa_subscription_event_type_t t, uint3 } if (source_output->save_muted) { - entry->muted = pa_source_output_get_mute(source_output); - entry->muted_valid = TRUE; + entry->muted = source_output->muted; + entry->muted_valid = true; mute_updated = !created_new_entry && (!old->muted_valid || entry->muted != old->muted); } @@ -1355,14 +1358,14 @@ static void subscribe_callback(pa_core *c, pa_subscription_event_type_t t, uint3 if (source_output->save_source) { pa_xfree(entry->device); entry->device = pa_xstrdup(source_output->source->name); - entry->device_valid = TRUE; + entry->device_valid = true; device_updated = !created_new_entry && (!old->device_valid || !pa_streq(entry->device, old->device)); if (source_output->source->card) { pa_xfree(entry->card); entry->card = pa_xstrdup(source_output->source->card->name); - entry->card_valid = TRUE; + entry->card_valid = true; } } } @@ -1383,7 +1386,7 @@ static void subscribe_callback(pa_core *c, pa_subscription_event_type_t t, uint3 pa_log_info("Storing volume/mute/device for stream %s.", name); - if (entry_write(u, name, entry, TRUE)) + if (entry_write(u, name, entry, true)) trigger_save(u); #ifdef HAVE_DBUS @@ -1416,7 +1419,7 @@ static pa_hook_result_t sink_input_new_hook_callback(pa_core *c, pa_sink_input_n pa_assert(u); pa_assert(u->restore_device); - if (!(name = get_name(new_data->proplist, "sink-input"))) + if (!(name = pa_proplist_get_stream_group(new_data->proplist, "sink-input", IDENTIFICATION_PROPERTY))) return PA_HOOK_OK; if (new_data->sink) @@ -1438,7 +1441,7 @@ static pa_hook_result_t sink_input_new_hook_callback(pa_core *c, pa_sink_input_n same time, in which case we want to make sure we don't interfere with that */ if (s && PA_SINK_IS_LINKED(pa_sink_get_state(s))) - if (pa_sink_input_new_data_set_sink(new_data, s, TRUE)) + if (pa_sink_input_new_data_set_sink(new_data, s, true)) pa_log_info("Restoring device for stream %s.", name); entry_free(e); @@ -1458,7 +1461,7 @@ static pa_hook_result_t sink_input_fixate_hook_callback(pa_core *c, pa_sink_inpu pa_assert(u); pa_assert(u->restore_volume || u->restore_muted); - if (!(name = get_name(new_data->proplist, "sink-input"))) + if (!(name = pa_proplist_get_stream_group(new_data->proplist, "sink-input", IDENTIFICATION_PROPERTY))) return PA_HOOK_OK; if ((e = entry_read(u, name))) { @@ -1477,8 +1480,8 @@ static pa_hook_result_t sink_input_fixate_hook_callback(pa_core *c, pa_sink_inpu pa_cvolume_remap(&v, &e->channel_map, &new_data->channel_map); pa_sink_input_new_data_set_volume(new_data, &v); - new_data->volume_is_absolute = FALSE; - new_data->save_volume = TRUE; + new_data->volume_is_absolute = false; + new_data->save_volume = true; } } @@ -1487,7 +1490,7 @@ static pa_hook_result_t sink_input_fixate_hook_callback(pa_core *c, pa_sink_inpu if (!new_data->muted_is_set) { pa_log_info("Restoring mute state for sink input %s.", name); pa_sink_input_new_data_set_muted(new_data, e->muted); - new_data->save_muted = TRUE; + new_data->save_muted = true; } else pa_log_debug("Not restoring mute state for sink input %s, because already set.", name); } @@ -1512,7 +1515,7 @@ static pa_hook_result_t source_output_new_hook_callback(pa_core *c, pa_source_ou if (new_data->direct_on_input) return PA_HOOK_OK; - if (!(name = get_name(new_data->proplist, "source-output"))) + if (!(name = pa_proplist_get_stream_group(new_data->proplist, "source-output", IDENTIFICATION_PROPERTY))) return PA_HOOK_OK; if (new_data->source) @@ -1535,7 +1538,7 @@ static pa_hook_result_t source_output_new_hook_callback(pa_core *c, pa_source_ou interfere with that */ if (s && PA_SOURCE_IS_LINKED(pa_source_get_state(s))) { pa_log_info("Restoring device for stream %s.", name); - pa_source_output_new_data_set_source(new_data, s, TRUE); + pa_source_output_new_data_set_source(new_data, s, true); } entry_free(e); @@ -1555,7 +1558,7 @@ static pa_hook_result_t source_output_fixate_hook_callback(pa_core *c, pa_source pa_assert(u); pa_assert(u->restore_volume || u->restore_muted); - if (!(name = get_name(new_data->proplist, "source-output"))) + if (!(name = pa_proplist_get_stream_group(new_data->proplist, "source-output", IDENTIFICATION_PROPERTY))) return PA_HOOK_OK; if ((e = entry_read(u, name))) { @@ -1574,8 +1577,8 @@ static pa_hook_result_t source_output_fixate_hook_callback(pa_core *c, pa_source pa_cvolume_remap(&v, &e->channel_map, &new_data->channel_map); pa_source_output_new_data_set_volume(new_data, &v); - new_data->volume_is_absolute = FALSE; - new_data->save_volume = TRUE; + new_data->volume_is_absolute = false; + new_data->save_volume = true; } } @@ -1584,7 +1587,7 @@ static pa_hook_result_t source_output_fixate_hook_callback(pa_core *c, pa_source if (!new_data->muted_is_set) { pa_log_info("Restoring mute state for source output %s.", name); pa_source_output_new_data_set_muted(new_data, e->muted); - new_data->save_muted = TRUE; + new_data->save_muted = true; } else pa_log_debug("Not restoring mute state for source output %s, because already set.", name); } @@ -1627,12 +1630,12 @@ static pa_hook_result_t sink_put_hook_callback(pa_core *c, pa_sink *sink, struct if (!PA_SINK_INPUT_IS_LINKED(pa_sink_input_get_state(si))) continue; - if (!(name = get_name(si->proplist, "sink-input"))) + if (!(name = pa_proplist_get_stream_group(si->proplist, "sink-input", IDENTIFICATION_PROPERTY))) continue; if ((e = entry_read(u, name))) { if (e->device_valid && pa_streq(e->device, sink->name)) - pa_sink_input_move_to(si, sink, TRUE); + pa_sink_input_move_to(si, sink, true); entry_free(e); } @@ -1675,12 +1678,12 @@ static pa_hook_result_t source_put_hook_callback(pa_core *c, pa_source *source, if (!PA_SOURCE_OUTPUT_IS_LINKED(pa_source_output_get_state(so))) continue; - if (!(name = get_name(so->proplist, "source-output"))) + if (!(name = pa_proplist_get_stream_group(so->proplist, "source-output", IDENTIFICATION_PROPERTY))) continue; if ((e = entry_read(u, name))) { if (e->device_valid && pa_streq(e->device, source->name)) - pa_source_output_move_to(so, source, TRUE); + pa_source_output_move_to(so, source, true); entry_free(e); } @@ -1711,7 +1714,7 @@ static pa_hook_result_t sink_unlink_hook_callback(pa_core *c, pa_sink *sink, str if (!si->sink) continue; - if (!(name = get_name(si->proplist, "sink-input"))) + if (!(name = pa_proplist_get_stream_group(si->proplist, "sink-input", IDENTIFICATION_PROPERTY))) continue; if ((e = entry_read(u, name))) { @@ -1722,7 +1725,7 @@ static pa_hook_result_t sink_unlink_hook_callback(pa_core *c, pa_sink *sink, str if ((d = pa_namereg_get(c, e->device, PA_NAMEREG_SINK)) && d != sink && PA_SINK_IS_LINKED(pa_sink_get_state(d))) - pa_sink_input_move_to(si, d, TRUE); + pa_sink_input_move_to(si, d, true); } entry_free(e); @@ -1757,7 +1760,7 @@ static pa_hook_result_t source_unlink_hook_callback(pa_core *c, pa_source *sourc if (!so->source) continue; - if (!(name = get_name(so->proplist, "source-output"))) + if (!(name = pa_proplist_get_stream_group(so->proplist, "source-output", IDENTIFICATION_PROPERTY))) continue; if ((e = entry_read(u, name))) { @@ -1768,7 +1771,7 @@ static pa_hook_result_t source_unlink_hook_callback(pa_core *c, pa_source *sourc if ((d = pa_namereg_get(c, e->device, PA_NAMEREG_SOURCE)) && d != source && PA_SOURCE_IS_LINKED(pa_source_get_state(d))) - pa_source_output_move_to(so, d, TRUE); + pa_source_output_move_to(so, d, true); } entry_free(e); @@ -1780,7 +1783,88 @@ static pa_hook_result_t source_unlink_hook_callback(pa_core *c, pa_source *sourc return PA_HOOK_OK; } -#define EXT_VERSION 1 +static int fill_db(struct userdata *u, const char *filename) { + FILE *f; + int n = 0; + int ret = -1; + char *fn = NULL; + + pa_assert(u); + + if (filename) + f = fopen(fn = pa_xstrdup(filename), "r"); + else + f = pa_open_config_file(DEFAULT_FALLBACK_FILE, DEFAULT_FALLBACK_FILE_USER, NULL, &fn); + + if (!f) { + if (filename) + pa_log("Failed to open %s: %s", filename, pa_cstrerror(errno)); + else + ret = 0; + + goto finish; + } + + while (!feof(f)) { + char ln[256]; + char *d, *v; + double db; + + if (!fgets(ln, sizeof(ln), f)) + break; + + n++; + + pa_strip_nl(ln); + + if (!*ln || ln[0] == '#' || ln[0] == ';') + continue; + + d = ln+strcspn(ln, WHITESPACE); + v = d+strspn(d, WHITESPACE); + + if (!*v) { + pa_log("[%s:%u] failed to parse line - too few words", fn, n); + goto finish; + } + + *d = 0; + if (pa_atod(v, &db) >= 0) { + if (db <= 0.0) { + pa_datum key, data; + struct entry e; + + pa_zero(e); + e.version = ENTRY_VERSION; + e.volume_valid = true; + pa_cvolume_set(&e.volume, 1, pa_sw_volume_from_dB(db)); + pa_channel_map_init_mono(&e.channel_map); + + key.data = (void *) ln; + key.size = strlen(ln); + + data.data = (void *) &e; + data.size = sizeof(e); + + if (pa_database_set(u->database, &key, &data, false) == 0) + pa_log_debug("Setting %s to %0.2f dB.", ln, db); + } else + pa_log_warn("[%s:%u] Positive dB values are not allowed, not setting entry %s.", fn, n, ln); + } else + pa_log_warn("[%s:%u] Couldn't parse '%s' as a double, not setting entry %s.", fn, n, v, ln); + } + + trigger_save(u); + ret = 0; + +finish: + if (f) + fclose(f); + + pa_xfree(fn); + + return ret; +} static void entry_apply(struct userdata *u, const char *name, struct entry *e) { pa_sink_input *si; @@ -1795,7 +1879,7 @@ static void entry_apply(struct userdata *u, const char *name, struct entry *e) { char *n; pa_sink *s; - if (!(n = get_name(si->proplist, "sink-input"))) + if (!(n = pa_proplist_get_stream_group(si->proplist, "sink-input", IDENTIFICATION_PROPERTY))) continue; if (!pa_streq(name, n)) { @@ -1810,12 +1894,12 @@ static void entry_apply(struct userdata *u, const char *name, struct entry *e) { v = e->volume; pa_log_info("Restoring volume for sink input %s.", name); pa_cvolume_remap(&v, &e->channel_map, &si->channel_map); - pa_sink_input_set_volume(si, &v, TRUE, FALSE); + pa_sink_input_set_volume(si, &v, true, false); } if (u->restore_muted && e->muted_valid) { pa_log_info("Restoring mute state for sink input %s.", name); - pa_sink_input_set_mute(si, e->muted, TRUE); + pa_sink_input_set_mute(si, e->muted, true); } if (u->restore_device) { @@ -1825,16 +1909,16 @@ static void entry_apply(struct userdata *u, const char *name, struct entry *e) { /* If the device is not valid we should make sure the save flag is cleared as the user may have specifically removed the sink element from the rule. */ - si->save_sink = FALSE; + si->save_sink = false; /* This is cheating a bit. The sink input itself has not changed - but the rules governing it's routing have, so we fire this event + but the rules governing its routing have, so we fire this event such that other routing modules (e.g. module-device-manager) will pick up the change and reapply their routing */ pa_subscription_post(si->core, PA_SUBSCRIPTION_EVENT_SINK_INPUT|PA_SUBSCRIPTION_EVENT_CHANGE, si->index); } } else if ((s = pa_namereg_get(u->core, e->device, PA_NAMEREG_SINK))) { pa_log_info("Restoring device for stream %s.", name); - pa_sink_input_move_to(si, s, TRUE); + pa_sink_input_move_to(si, s, true); } } } @@ -1843,7 +1927,7 @@ static void entry_apply(struct userdata *u, const char *name, struct entry *e) { char *n; pa_source *s; - if (!(n = get_name(so->proplist, "source-output"))) + if (!(n = pa_proplist_get_stream_group(so->proplist, "source-output", IDENTIFICATION_PROPERTY))) continue; if (!pa_streq(name, n)) { @@ -1858,12 +1942,12 @@ static void entry_apply(struct userdata *u, const char *name, struct entry *e) { v = e->volume; pa_log_info("Restoring volume for source output %s.", name); pa_cvolume_remap(&v, &e->channel_map, &so->channel_map); - pa_source_output_set_volume(so, &v, TRUE, FALSE); + pa_source_output_set_volume(so, &v, true, false); } if (u->restore_muted && e->muted_valid) { pa_log_info("Restoring mute state for source output %s.", name); - pa_source_output_set_mute(so, e->muted, TRUE); + pa_source_output_set_mute(so, e->muted, true); } if (u->restore_device) { @@ -1873,16 +1957,16 @@ static void entry_apply(struct userdata *u, const char *name, struct entry *e) { /* If the device is not valid we should make sure the save flag is cleared as the user may have specifically removed the source element from the rule. */ - so->save_source = FALSE; + so->save_source = false; /* This is cheating a bit. The source output itself has not changed - but the rules governing it's routing have, so we fire this event + but the rules governing its routing have, so we fire this event such that other routing modules (e.g. module-device-manager) will pick up the change and reapply their routing */ pa_subscription_post(so->core, PA_SUBSCRIPTION_EVENT_SOURCE_OUTPUT|PA_SUBSCRIPTION_EVENT_CHANGE, so->index); } } else if ((s = pa_namereg_get(u->core, e->device, PA_NAMEREG_SOURCE))) { pa_log_info("Restoring device for stream %s.", name); - pa_source_output_move_to(so, s, TRUE); + pa_source_output_move_to(so, s, true); } } } @@ -1891,7 +1975,7 @@ static void entry_apply(struct userdata *u, const char *name, struct entry *e) { #ifdef DEBUG_VOLUME PA_GCC_UNUSED static void stream_restore_dump_database(struct userdata *u) { pa_datum key; - pa_bool_t done; + bool done; done = !pa_database_first(u->database, &key, NULL); @@ -1910,7 +1994,9 @@ PA_GCC_UNUSED static void stream_restore_dump_database(struct userdata *u) { pa_log("name=%s", name); pa_log("device=%s %s", e->device, pa_yes_no(e->device_valid)); pa_log("channel_map=%s", pa_channel_map_snprint(t, sizeof(t), &e->channel_map)); - pa_log("volume=%s %s", pa_cvolume_snprint(t, sizeof(t), &e->volume), pa_yes_no(e->volume_valid)); + pa_log("volume=%s %s", + pa_cvolume_snprint_verbose(t, sizeof(t), &e->volume, &e->channel_map, true), + pa_yes_no(e->volume_valid)); pa_log("mute=%s %s", pa_yes_no(e->muted), pa_yes_no(e->volume_valid)); entry_free(e); } @@ -1922,6 +2008,8 @@ PA_GCC_UNUSED static void stream_restore_dump_database(struct userdata *u) { } #endif +#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) { struct userdata *u; uint32_t command; @@ -1952,7 +2040,7 @@ static int extension_cb(pa_native_protocol *p, pa_module *m, pa_native_connectio case SUBCOMMAND_READ: { pa_datum key; - pa_bool_t done; + bool done; if (!pa_tagstruct_eof(t)) goto fail; @@ -1977,7 +2065,7 @@ static int extension_cb(pa_native_protocol *p, pa_module *m, pa_native_connectio pa_tagstruct_put_channel_map(reply, e->volume_valid ? &e->channel_map : pa_channel_map_init(&cm)); pa_tagstruct_put_cvolume(reply, e->volume_valid ? &e->volume : pa_cvolume_init(&r)); pa_tagstruct_puts(reply, e->device_valid ? e->device : NULL); - pa_tagstruct_put_boolean(reply, e->muted_valid ? e->muted : FALSE); + pa_tagstruct_put_boolean(reply, e->muted_valid ? e->muted : false); entry_free(e); } @@ -1992,7 +2080,7 @@ static int extension_cb(pa_native_protocol *p, pa_module *m, pa_native_connectio case SUBCOMMAND_WRITE: { uint32_t mode; - pa_bool_t apply_immediately = FALSE; + bool apply_immediately = false; if (pa_tagstruct_getu32(t, &mode) < 0 || pa_tagstruct_get_boolean(t, &apply_immediately) < 0) @@ -2010,7 +2098,7 @@ static int extension_cb(pa_native_protocol *p, pa_module *m, pa_native_connectio PA_HASHMAP_FOREACH(de, u->dbus_entries, state) { send_entry_removed_signal(de); - dbus_entry_free(pa_hashmap_remove(u->dbus_entries, de->entry_name)); + pa_hashmap_remove_and_free(u->dbus_entries, de->entry_name); } #endif pa_database_clear(u->database); @@ -2018,7 +2106,7 @@ static int extension_cb(pa_native_protocol *p, pa_module *m, pa_native_connectio while (!pa_tagstruct_eof(t)) { const char *name, *device; - pa_bool_t muted; + bool muted; struct entry *entry; #ifdef HAVE_DBUS struct entry *old; @@ -2030,8 +2118,10 @@ static int extension_cb(pa_native_protocol *p, pa_module *m, pa_native_connectio pa_tagstruct_get_channel_map(t, &entry->channel_map) || pa_tagstruct_get_cvolume(t, &entry->volume) < 0 || pa_tagstruct_gets(t, &device) < 0 || - pa_tagstruct_get_boolean(t, &muted) < 0) + pa_tagstruct_get_boolean(t, &muted) < 0) { + entry_free(entry); goto fail; + } if (!name || !*name) { entry_free(entry); @@ -2047,7 +2137,7 @@ static int extension_cb(pa_native_protocol *p, pa_module *m, pa_native_connectio } entry->muted = muted; - entry->muted_valid = TRUE; + entry->muted_valid = true; entry->device = pa_xstrdup(device); entry->device_valid = device && !!entry->device[0]; @@ -2122,7 +2212,7 @@ static int extension_cb(pa_native_protocol *p, pa_module *m, pa_native_connectio #ifdef HAVE_DBUS if ((de = pa_hashmap_get(u->dbus_entries, name))) { send_entry_removed_signal(de); - dbus_entry_free(pa_hashmap_remove(u->dbus_entries, name)); + pa_hashmap_remove_and_free(u->dbus_entries, name); } #endif @@ -2138,7 +2228,7 @@ static int extension_cb(pa_native_protocol *p, pa_module *m, pa_native_connectio case SUBCOMMAND_SUBSCRIBE: { - pa_bool_t enabled; + bool enabled; if (pa_tagstruct_get_boolean(t, &enabled) < 0 || !pa_tagstruct_eof(t)) @@ -2176,6 +2266,101 @@ static pa_hook_result_t connection_unlink_hook_cb(pa_native_protocol *p, pa_nati return PA_HOOK_OK; } +static void clean_up_db(struct userdata *u) { + struct clean_up_item { + PA_LLIST_FIELDS(struct clean_up_item); + char *entry_name; + struct entry *entry; + }; + + PA_LLIST_HEAD(struct clean_up_item, to_be_removed); +#ifdef ENABLE_LEGACY_DATABASE_ENTRY_FORMAT + PA_LLIST_HEAD(struct clean_up_item, to_be_converted); +#endif + bool done = false; + pa_datum key; + struct clean_up_item *item = NULL; + struct clean_up_item *next = NULL; + + pa_assert(u); + + /* It would be convenient to remove or replace the entries in the database + * in the same loop that iterates through the database, but modifying the + * database is not supported while iterating through it. That's why we + * collect the entries that need to be removed or replaced to these + * lists. */ + PA_LLIST_HEAD_INIT(struct clean_up_item, to_be_removed); +#ifdef ENABLE_LEGACY_DATABASE_ENTRY_FORMAT + PA_LLIST_HEAD_INIT(struct clean_up_item, to_be_converted); +#endif + + done = !pa_database_first(u->database, &key, NULL); + while (!done) { + pa_datum next_key; + char *entry_name = NULL; + struct entry *e = NULL; + + entry_name = pa_xstrndup(key.data, key.size); + + /* Use entry_read() to check whether this entry is valid. */ + if (!(e = entry_read(u, entry_name))) { + item = pa_xnew0(struct clean_up_item, 1); + PA_LLIST_INIT(struct clean_up_item, item); + item->entry_name = entry_name; + +#ifdef ENABLE_LEGACY_DATABASE_ENTRY_FORMAT + /* entry_read() failed, but what about legacy_entry_read()? */ + if (!(e = legacy_entry_read(u, entry_name))) + /* Not a legacy entry either, let's remove this. */ + PA_LLIST_PREPEND(struct clean_up_item, to_be_removed, item); + else { + /* Yay, it's valid after all! Now let's convert the entry to the current format. */ + item->entry = e; + PA_LLIST_PREPEND(struct clean_up_item, to_be_converted, item); + } +#else + /* Invalid entry, let's remove this. */ + PA_LLIST_PREPEND(struct clean_up_item, to_be_removed, item); +#endif + } else { + pa_xfree(entry_name); + entry_free(e); + } + + done = !pa_database_next(u->database, &key, &next_key, NULL); + pa_datum_free(&key); + key = next_key; + } + + PA_LLIST_FOREACH_SAFE(item, next, to_be_removed) { + key.data = item->entry_name; + key.size = strlen(item->entry_name); + + pa_log_debug("Removing an invalid entry: %s", item->entry_name); + + pa_assert_se(pa_database_unset(u->database, &key) >= 0); + trigger_save(u); + + PA_LLIST_REMOVE(struct clean_up_item, to_be_removed, item); + pa_xfree(item->entry_name); + pa_xfree(item); + } + +#ifdef ENABLE_LEGACY_DATABASE_ENTRY_FORMAT + PA_LLIST_FOREACH_SAFE(item, next, to_be_converted) { + pa_log_debug("Upgrading a legacy entry to the current format: %s", item->entry_name); + + pa_assert_se(entry_write(u, item->entry_name, item->entry, true) >= 0); + trigger_save(u); + + PA_LLIST_REMOVE(struct clean_up_item, to_be_converted, item); + pa_xfree(item->entry_name); + entry_free(item->entry); + pa_xfree(item); + } +#endif +} + int pa__init(pa_module*m) { pa_modargs *ma = NULL; struct userdata *u; @@ -2183,10 +2368,10 @@ int pa__init(pa_module*m) { pa_sink_input *si; pa_source_output *so; uint32_t idx; - pa_bool_t restore_device = TRUE, restore_volume = TRUE, restore_muted = TRUE, on_hotplug = TRUE, on_rescue = TRUE; + bool restore_device = true, restore_volume = true, restore_muted = true, on_hotplug = true, on_rescue = true; #ifdef HAVE_DBUS pa_datum key; - pa_bool_t done; + bool done; #endif pa_assert(m); @@ -2248,10 +2433,10 @@ int pa__init(pa_module*m) { u->source_output_fixate_hook_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SOURCE_OUTPUT_FIXATE], PA_HOOK_EARLY, (pa_hook_cb_t) source_output_fixate_hook_callback, u); } - if (!(fname = pa_state_path("stream-volumes", TRUE))) + if (!(fname = pa_state_path("stream-volumes", 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; @@ -2260,9 +2445,14 @@ int pa__init(pa_module*m) { pa_log_info("Successfully opened database file '%s'.", fname); pa_xfree(fname); + clean_up_db(u); + + if (fill_db(u, pa_modargs_get_value(ma, "fallback_table", NULL)) < 0) + goto fail; + #ifdef HAVE_DBUS u->dbus_protocol = pa_dbus_protocol_get(u->core); - u->dbus_entries = pa_hashmap_new(pa_idxset_string_hash_func, pa_idxset_string_compare_func); + u->dbus_entries = pa_hashmap_new_full(pa_idxset_string_hash_func, pa_idxset_string_compare_func, NULL, (pa_free_cb_t) dbus_entry_free); pa_assert_se(pa_dbus_protocol_add_interface(u->dbus_protocol, OBJECT_PATH, &stream_restore_interface_info, u) >= 0); pa_assert_se(pa_dbus_protocol_register_extension(u->dbus_protocol, INTERFACE_STREAM_RESTORE) >= 0); @@ -2273,22 +2463,14 @@ int pa__init(pa_module*m) { pa_datum next_key; char *name; struct dbus_entry *de; - struct entry *e; - - done = !pa_database_next(u->database, &key, &next_key, NULL); name = pa_xstrndup(key.data, key.size); - pa_datum_free(&key); - - /* Use entry_read() for checking that the entry is valid. */ - if ((e = entry_read(u, name))) { - de = dbus_entry_new(u, name); - pa_assert_se(pa_hashmap_put(u->dbus_entries, de->entry_name, de) == 0); - entry_free(e); - } - + de = dbus_entry_new(u, name); + pa_assert_se(pa_hashmap_put(u->dbus_entries, de->entry_name, de) == 0); pa_xfree(name); + done = !pa_database_next(u->database, &key, &next_key, NULL); + pa_datum_free(&key); key = next_key; } #endif @@ -2311,16 +2493,6 @@ fail: return -1; } -#ifdef HAVE_DBUS -static void free_dbus_entry_cb(void *p, void *userdata) { - struct dbus_entry *de = p; - - pa_assert(de); - - dbus_entry_free(de); -} -#endif - void pa__done(pa_module*m) { struct userdata* u; @@ -2336,7 +2508,7 @@ void pa__done(pa_module*m) { pa_assert_se(pa_dbus_protocol_unregister_extension(u->dbus_protocol, INTERFACE_STREAM_RESTORE) >= 0); pa_assert_se(pa_dbus_protocol_remove_interface(u->dbus_protocol, OBJECT_PATH, stream_restore_interface_info.name) >= 0); - pa_hashmap_free(u->dbus_entries, free_dbus_entry_cb, NULL); + pa_hashmap_free(u->dbus_entries); pa_dbus_protocol_unref(u->dbus_protocol); } @@ -2379,7 +2551,7 @@ void pa__done(pa_module*m) { } if (u->subscribed) - pa_idxset_free(u->subscribed, NULL, NULL); + pa_idxset_free(u->subscribed, NULL); pa_xfree(u); }