From 4ad6c627a020ab8882f65b0d8134e9de3271a045 Mon Sep 17 00:00:00 2001 From: Wim Taymans Date: Thu, 13 Aug 2020 17:01:47 +0200 Subject: [PATCH] media-session: add module to restore card profile Save card profiles to file and restore. --- src/examples/media-session/default-profile.c | 332 +++++++++++++++++++ src/examples/media-session/media-session.c | 16 +- src/examples/meson.build | 1 + 3 files changed, 347 insertions(+), 2 deletions(-) create mode 100644 src/examples/media-session/default-profile.c diff --git a/src/examples/media-session/default-profile.c b/src/examples/media-session/default-profile.c new file mode 100644 index 000000000..ebdb45f5c --- /dev/null +++ b/src/examples/media-session/default-profile.c @@ -0,0 +1,332 @@ +/* PipeWire + * + * Copyright © 2020 Wim Taymans + * + * Permission is hereby granted, free of charge, to any person obtaining a + * copy of this software and associated documentation files (the "Software"), + * to deal in the Software without restriction, including without limitation + * the rights to use, copy, modify, merge, publish, distribute, sublicense, + * and/or sell copies of the Software, and to permit persons to whom the + * Software is furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice (including the next + * paragraph) shall be included in all copies or substantial portions of the + * Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL + * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + * DEALINGS IN THE SOFTWARE. + */ + +#include +#include +#include +#include +#include +#include +#include + +#include "config.h" + +#include +#include +#include +#include +#include + +#include "pipewire/pipewire.h" +#include "extensions/metadata.h" + +#include "media-session.h" + +#define NAME "default-profile" +#define SESSION_KEY "default-profile" + +#define SAVE_INTERVAL 1 + +struct impl { + struct timespec now; + + struct sm_media_session *session; + struct spa_hook listener; + + struct pw_context *context; + struct spa_source *idle_timeout; + + struct spa_hook meta_listener; + + struct pw_properties *properties; +}; + +struct device { + struct sm_device *obj; + + uint32_t id; + struct impl *impl; + char *name; + + struct spa_hook listener; + + unsigned int restored:1; + + uint32_t active_profile; +}; + +struct find_data { + struct impl *impl; + const char *name; + uint32_t id; +}; + +static void remove_idle_timeout(struct impl *impl) +{ + struct pw_loop *main_loop = pw_context_get_main_loop(impl->context); + int res; + + if (impl->idle_timeout) { + if ((res = sm_media_session_save_state(impl->session, SESSION_KEY, impl->properties)) < 0) + pw_log_error("can't save "SESSION_KEY" state: %s", spa_strerror(res)); + pw_loop_destroy_source(main_loop, impl->idle_timeout); + impl->idle_timeout = NULL; + } +} + +static void idle_timeout(void *data, uint64_t expirations) +{ + struct impl *impl = data; + pw_log_debug(NAME " %p: idle timeout", impl); + remove_idle_timeout(impl); +} + +static void add_idle_timeout(struct impl *impl) +{ + struct timespec value; + struct pw_loop *main_loop = pw_context_get_main_loop(impl->context); + + if (impl->idle_timeout == NULL) + impl->idle_timeout = pw_loop_add_timer(main_loop, idle_timeout, impl); + + value.tv_sec = SAVE_INTERVAL; + value.tv_nsec = 0; + pw_loop_update_timer(main_loop, impl->idle_timeout, &value, NULL, false); +} + +static void session_destroy(void *data) +{ + struct impl *impl = data; + remove_idle_timeout(impl); + spa_hook_remove(&impl->listener); + pw_properties_free(impl->properties); + free(impl); +} + +static const char *find_profile_name(struct device *dev, uint32_t index) +{ + struct sm_param *p; + spa_list_for_each(p, &dev->obj->param_list, link) { + const char *n; + uint32_t id; + + if (p->id != SPA_PARAM_EnumProfile || + spa_pod_parse_object(p->param, + SPA_TYPE_OBJECT_ParamProfile, NULL, + SPA_PARAM_PROFILE_index, SPA_POD_Int(&id), + SPA_PARAM_PROFILE_name, SPA_POD_String(&n)) < 0) { + continue; + } + if (id == index) + return n; + } + return NULL; +} + +static uint32_t find_profile_id(struct device *dev, const char *name) +{ + struct sm_param *p; + spa_list_for_each(p, &dev->obj->param_list, link) { + const char *n; + uint32_t id; + + if (p->id != SPA_PARAM_EnumProfile || + spa_pod_parse_object(p->param, + SPA_TYPE_OBJECT_ParamProfile, NULL, + SPA_PARAM_PROFILE_index, SPA_POD_Int(&id), + SPA_PARAM_PROFILE_name, SPA_POD_String(&n)) < 0) { + continue; + } + if (strcmp(n, name) == 0) + return id; + } + return SPA_ID_INVALID; +} + +static int restore_profile(struct device *dev) +{ + struct impl *impl = dev->impl; + const char *name; + uint32_t index = SPA_ID_INVALID; + + name = pw_properties_get(impl->properties, dev->name); + if (name == NULL) + return -ENOENT; + + pw_log_debug("device %d: find profile '%s'", dev->id, name); + index = find_profile_id(dev, name); + + if (index != SPA_ID_INVALID) { + char buf[1024]; + struct spa_pod_builder b = SPA_POD_BUILDER_INIT(buf, sizeof(buf)); + + pw_log_info("device %d: restore profile '%s' index %d", dev->id, name, index); + pw_device_set_param((struct pw_device*)dev->obj->obj.proxy, + SPA_PARAM_Profile, 0, + spa_pod_builder_add_object(&b, + SPA_TYPE_OBJECT_ParamProfile, SPA_PARAM_Profile, + SPA_PARAM_PROFILE_index, SPA_POD_Int(index))); + dev->active_profile = index; + } + return -ENOENT; +} + +static int handle_profile(struct device *dev, struct sm_param *p) +{ + struct impl *impl = dev->impl; + uint32_t index; + int res; + + if (!dev->restored) { + restore_profile(dev); + dev->restored = true; + } else { + const char *name; + if ((res = spa_pod_parse_object(p->param, + SPA_TYPE_OBJECT_ParamProfile, NULL, + SPA_PARAM_PROFILE_index, SPA_POD_Int(&index))) < 0) { + pw_log_warn("device %d: can't parse profile: %s", dev->id, spa_strerror(res)); + return res; + } + if (dev->active_profile == index) + return 0; + + dev->active_profile = index; + name = find_profile_name(dev, index); + if (name) { + pw_log_debug("device %d: current profile %d %s", dev->id, index, name); + pw_properties_set(impl->properties, dev->name, name); + add_idle_timeout(impl); + } + } + return 0; +} + +static void object_update(void *data) +{ + struct device *dev = data; + struct impl *impl = dev->impl; + + pw_log_debug(NAME" %p: device %p %08x/%08x", impl, dev, + dev->obj->obj.changed, dev->obj->obj.avail); + + if (dev->obj->obj.changed & SM_NODE_CHANGE_MASK_PARAMS) { + struct sm_param *p; + spa_list_for_each(p, &dev->obj->param_list, link) { + if (pw_log_level_enabled(SPA_LOG_LEVEL_DEBUG)) + spa_debug_pod(2, NULL, p->param); + + switch (p->id) { + case SPA_PARAM_EnumProfile: + break; + case SPA_PARAM_Profile: + handle_profile(dev, p); + break; + default: + break; + } + } + } +} + +static const struct sm_object_events object_events = { + SM_VERSION_OBJECT_EVENTS, + .update = object_update +}; + +static void session_create(void *data, struct sm_object *object) +{ + struct impl *impl = data; + struct device *dev; + const char *name; + + if (strcmp(object->type, PW_TYPE_INTERFACE_Device) != 0 || + object->props == NULL || + (name = pw_properties_get(object->props, PW_KEY_DEVICE_NAME)) == NULL) + return; + + pw_log_debug(NAME " %p: add device '%d' %s", impl, object->id, name); + + dev = sm_object_add_data(object, SESSION_KEY, sizeof(struct device)); + dev->obj = (struct sm_device*)object; + dev->id = object->id; + dev->impl = impl; + dev->name = strdup(name); + + dev->obj->obj.mask |= SM_DEVICE_CHANGE_MASK_PARAMS; + sm_object_add_listener(&dev->obj->obj, &dev->listener, &object_events, dev); +} + +static void destroy_device(struct impl *impl, struct device *dev) +{ + free(dev->name); + sm_object_remove_data((struct sm_object*)dev->obj, SESSION_KEY); +} + +static void session_remove(void *data, struct sm_object *object) +{ + struct impl *impl = data; + struct device *dev; + + if (strcmp(object->type, PW_TYPE_INTERFACE_Device) != 0) + return; + + pw_log_debug(NAME " %p: remove device '%d'", impl, object->id); + + if ((dev = sm_object_get_data(object, SESSION_KEY)) != NULL) + destroy_device(impl, dev); +} + +static const struct sm_media_session_events session_events = { + SM_VERSION_MEDIA_SESSION_EVENTS, + .create = session_create, + .remove = session_remove, + .destroy = session_destroy, +}; + +int sm_default_profile_start(struct sm_media_session *session) +{ + struct impl *impl; + int res; + + impl = calloc(1, sizeof(struct impl)); + if (impl == NULL) + return -errno; + + impl->session = session; + impl->context = session->context; + + impl->properties = pw_properties_new(NULL, NULL); + if (impl->properties == NULL) { + free(impl); + return -ENOMEM; + } + + if ((res = sm_media_session_load_state(impl->session, SESSION_KEY, impl->properties)) < 0) + pw_log_info("can't load "SESSION_KEY" state: %s", spa_strerror(res)); + + sm_media_session_add_listener(impl->session, &impl->listener, &session_events, impl); + + return 0; +} diff --git a/src/examples/media-session/media-session.c b/src/examples/media-session/media-session.c index 2302283a0..ebf8f6aa3 100644 --- a/src/examples/media-session/media-session.c +++ b/src/examples/media-session/media-session.c @@ -78,6 +78,7 @@ int sm_access_flatpak_start(struct sm_media_session *sess); int sm_access_portal_start(struct sm_media_session *sess); int sm_metadata_start(struct sm_media_session *sess); int sm_default_nodes_start(struct sm_media_session *sess); +int sm_default_profile_start(struct sm_media_session *sess); int sm_alsa_midi_start(struct sm_media_session *sess); int sm_v4l2_monitor_start(struct sm_media_session *sess); int sm_libcamera_monitor_start(struct sm_media_session *sess); @@ -1792,7 +1793,7 @@ int sm_media_session_load_state(struct sm_media_session *sess, return sfd; if ((fd = openat(sfd, name, O_CLOEXEC | O_RDONLY)) < 0) { - pw_log_error("can't open file %s: %m", name); + pw_log_debug("can't open file %s: %m", name); return -errno; } f = fdopen(fd, "r"); @@ -1989,7 +1990,17 @@ static void do_quit(void *data, int signal_number) pw_main_loop_quit(impl->loop); } -#define DEFAULT_ENABLED "flatpak,portal,metadata,default-nodes,alsa-acp,alsa-seq,v4l2,bluez5,suspend-node,policy-node" +#define DEFAULT_ENABLED "flatpak," \ + "portal," \ + "metadata," \ + "default-nodes," \ + "default-profile," \ + "alsa-acp," \ + "alsa-seq," \ + "v4l2," \ + "bluez5," \ + "suspend-node," \ + "policy-node" #define DEFAULT_DISABLED "" static const struct { @@ -2003,6 +2014,7 @@ static const struct { { "portal", "manage portal permissions", sm_access_portal_start, NULL }, { "metadata", "export metadata API", sm_metadata_start, NULL }, { "default-nodes", "restore default nodes", sm_default_nodes_start, NULL }, + { "default-profile", "restore default profiles", sm_default_profile_start, NULL }, { "alsa-seq", "alsa seq midi support", sm_alsa_midi_start, NULL }, { "alsa-pcm", "alsa pcm udev detection", sm_alsa_monitor_start, NULL }, { "alsa-acp", "alsa card profile udev detection", sm_alsa_monitor_start, "alsa.use-acp=true" }, diff --git a/src/examples/meson.build b/src/examples/meson.build index 6f5d90e8e..8c32ef28f 100644 --- a/src/examples/meson.build +++ b/src/examples/meson.build @@ -75,6 +75,7 @@ if alsa_dep.found() 'media-session/bluez-monitor.c', 'media-session/bluez-endpoint.c', 'media-session/default-nodes.c', + 'media-session/default-profile.c', 'media-session/media-session.c', 'media-session/session-manager.c', 'media-session/metadata.c',