X-Git-Url: https://code.delx.au/pulseaudio/blobdiff_plain/188c91b514804d48de6257e72640ef8ff8e8e830..77b3ba514cbb00adb89bafa7f48b4430d9764355:/src/modules/module-stream-restore.c diff --git a/src/modules/module-stream-restore.c b/src/modules/module-stream-restore.c index fe7708b3..23f47801 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 @@ -229,11 +230,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] = { @@ -971,31 +973,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; @@ -1046,7 +1023,7 @@ 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; @@ -1056,52 +1033,63 @@ static struct entry* legacy_entry_read(struct userdata *u, pa_datum *data) { 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 (!pa_database_get(u->database, &key, &data)) + goto fail; - if (data->size != sizeof(struct legacy_entry)) { + 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"); - return NULL; + 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"); - return NULL; + 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"); - return NULL; + 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"); - return NULL; + goto fail; } e = entry_new(); @@ -1115,6 +1103,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 @@ -1185,26 +1178,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; } @@ -1224,7 +1202,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); @@ -1300,7 +1278,7 @@ 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))) { @@ -1350,7 +1328,7 @@ 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))) { @@ -1443,7 +1421,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) @@ -1485,7 +1463,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))) { @@ -1539,7 +1517,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) @@ -1582,7 +1560,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))) { @@ -1654,7 +1632,7 @@ 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))) { @@ -1702,7 +1680,7 @@ 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))) { @@ -1738,7 +1716,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))) { @@ -1784,7 +1762,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))) { @@ -1903,7 +1881,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)) { @@ -1951,7 +1929,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)) { @@ -2286,6 +2264,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 + pa_bool_t 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; @@ -2370,6 +2443,8 @@ 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; @@ -2386,22 +2461,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 @@ -2424,16 +2491,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; @@ -2449,7 +2506,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_free_cb_t) dbus_entry_free); pa_dbus_protocol_unref(u->dbus_protocol); } @@ -2492,7 +2549,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); }