/* WirePlumber * * Copyright © 2019-2020 Collabora Ltd. * @author George Kiagiadakis * * SPDX-License-Identifier: MIT */ #include #include #include #include #include #include #include #include WP_DEFINE_LOCAL_LOG_TOPIC ("wpctl") static const gchar *DEFAULT_NODE_MEDIA_CLASSES[] = { "Audio/Sink", "Audio/Source", "Video/Source", }; typedef struct _WpCtl WpCtl; struct _WpCtl { GOptionContext *context; GMainLoop *loop; WpCore *core; WpObjectManager *om; guint pending_plugins; gint exit_code; }; static struct { union { struct { gboolean display_nicknames; gboolean display_names; } status; struct { guint64 id; gboolean show_referenced; gboolean show_associated; } inspect; struct { guint64 id; } set_default; struct { guint64 id; gfloat volume; gdouble limit; gboolean is_pid; gchar type; } set_volume; struct { guint64 id; } get_volume; struct { guint64 id; guint mute; gboolean is_pid; } set_mute; struct { guint64 id; gint index; } set_profile; struct { guint64 id; gint index; } set_route; struct { guint64 id; } clear_default; struct { const gchar *key; const gchar *val; gboolean delete; gboolean save; gboolean reset; } settings; struct { guint64 id; const char *level; } set_log_level; }; } cmdline; G_DEFINE_QUARK (wpctl-error, wpctl_error_domain) static void wp_ctl_clear (WpCtl * self) { g_clear_object (&self->om); g_clear_object (&self->core); g_clear_pointer (&self->loop, g_main_loop_unref); g_clear_pointer (&self->context, g_option_context_free); } G_DEFINE_AUTO_CLEANUP_CLEAR_FUNC (WpCtl, wp_ctl_clear) static void async_quit (WpCore *core, GAsyncResult *res, WpCtl * self) { g_main_loop_quit (self->loop); } #define DEFAULT_AUDIO_SINK_ID ((guint64)1 << 32) #define DEFAULT_AUDIO_SOURCE_ID ((guint64)1 << 33) #define DEFAULT_VIDEO_SOURCE_ID ((guint64)1 << 34) static gboolean parse_id (gboolean allow_def_audio, gboolean allow_def_video, gchar *arg, guint64 *result_id, GError **error) { if (allow_def_audio && (g_strcmp0(arg, "@DEFAULT_SINK@") == 0 || g_strcmp0(arg, "@DEFAULT_AUDIO_SINK@") == 0)) { *result_id = DEFAULT_AUDIO_SINK_ID; } else if (allow_def_audio && (g_strcmp0(arg, "@DEFAULT_SOURCE@") == 0 || g_strcmp0(arg, "@DEFAULT_AUDIO_SOURCE@") == 0)) { *result_id = DEFAULT_AUDIO_SOURCE_ID; } else if (allow_def_video && g_strcmp0(arg, "@DEFAULT_VIDEO_SOURCE@") == 0) { *result_id = DEFAULT_VIDEO_SOURCE_ID; } else { long id = strtol (arg, NULL, 10); if (id <= 0 || id >= G_MAXUINT32) { g_set_error (error, wpctl_error_domain_quark(), 0, "'%s' is not a valid number", arg); return FALSE; } *result_id = id; } return TRUE; } static gboolean translate_id (WpPlugin *def_nodes_api, guint64 id, guint32 *res, GError **error) { gchar *media_class = NULL; if (id == DEFAULT_AUDIO_SINK_ID) { media_class = "Audio/Sink"; } else if (id == DEFAULT_AUDIO_SOURCE_ID) { media_class = "Audio/Source"; } else if (id == DEFAULT_VIDEO_SOURCE_ID) { media_class = "Video/Source"; } else { /* SPA_ID_INVALID is a special case used by some parse_positional() to indicate that no specific ID was given. It needs to be checked because currently SPA_ID_INVALID == G_MAXUINT32. */ if ((id <= 0 || id >= G_MAXUINT32) && id != SPA_ID_INVALID) { g_set_error (error, wpctl_error_domain_quark(), 0, "'%ld' is not a valid ID", id); return FALSE; } *res = (guint32)id; return TRUE; } if (!def_nodes_api) { g_set_error (error, wpctl_error_domain_quark(), 0, "Default nodes API is not loaded\n"); return FALSE; } g_signal_emit_by_name (def_nodes_api, "get-default-node", media_class, res); if (*res <= 0 || *res >= G_MAXUINT32) { g_set_error (error, wpctl_error_domain_quark(), 0, "'%d' is not a valid ID (returned by default-nodes-api)", *res); return FALSE; } return TRUE; } static gboolean run_nodes_by_pid (WpObjectManager *om, guint32 pid, WpIteratorFoldFunc func, gpointer data) { gboolean res = TRUE; g_autoptr (WpIterator) client_it = NULL; g_auto (GValue) client_val = G_VALUE_INIT; client_it = wp_object_manager_new_filtered_iterator (om, WP_TYPE_CLIENT, WP_CONSTRAINT_TYPE_PW_PROPERTY, PW_KEY_APP_PROCESS_ID, "=u", pid, NULL); for (; wp_iterator_next (client_it, &client_val); g_value_unset (&client_val)) { WpPipewireObject *client = g_value_get_object (&client_val); guint32 client_id = wp_proxy_get_bound_id (WP_PROXY (client)); g_autoptr (WpIterator) node_it = NULL; node_it = wp_object_manager_new_filtered_iterator (om, WP_TYPE_NODE, WP_CONSTRAINT_TYPE_PW_PROPERTY, PW_KEY_CLIENT_ID, "=u", client_id, NULL); if (!wp_iterator_fold (node_it, func, NULL, data)) res = FALSE; } return res; } /* status */ static gboolean status_prepare (WpCtl * self, GError ** error) { wp_object_manager_add_interest (self->om, WP_TYPE_CLIENT, NULL); wp_object_manager_add_interest (self->om, WP_TYPE_DEVICE, NULL); wp_object_manager_add_interest (self->om, WP_TYPE_NODE, NULL); wp_object_manager_add_interest (self->om, WP_TYPE_PORT, NULL); wp_object_manager_add_interest (self->om, WP_TYPE_LINK, NULL); wp_object_manager_request_object_features (self->om, WP_TYPE_GLOBAL_PROXY, WP_PIPEWIRE_OBJECT_FEATURES_MINIMAL); wp_object_manager_add_interest (self->om, WP_TYPE_METADATA, NULL); return TRUE; } #define TREE_INDENT_LINE " │ " #define TREE_INDENT_NODE " ├─ " #define TREE_INDENT_END " └─ " #define TREE_INDENT_EMPTY " " struct print_context { WpCtl *self; guint32 default_node; WpPlugin *mixer_api; GHashTable *printed_filters; }; static void print_controls (guint32 id, struct print_context *context) { g_autoptr (GVariant) dict = NULL; if (context->mixer_api) g_signal_emit_by_name (context->mixer_api, "get-volume", id, &dict); if (dict) { gboolean mute = FALSE; gdouble volume = 1.0; if (g_variant_lookup (dict, "mute", "b", &mute) && g_variant_lookup (dict, "volume", "d", &volume)) printf (" [vol: %.2f%s", volume, mute ? " MUTED]" : "]"); } printf ("\n"); } static void print_device (const GValue *item, gpointer data) { WpPipewireObject *obj = g_value_get_object (item); guint32 id = wp_proxy_get_bound_id (WP_PROXY (obj)); const gchar *api = wp_pipewire_object_get_property (obj, PW_KEY_DEVICE_API); const gchar *name = NULL; if (cmdline.status.display_nicknames) name = wp_pipewire_object_get_property (obj, PW_KEY_DEVICE_NICK); else if (cmdline.status.display_names) name = wp_pipewire_object_get_property (obj, PW_KEY_DEVICE_NAME); if (!name) name = wp_pipewire_object_get_property (obj, PW_KEY_DEVICE_DESCRIPTION); printf (TREE_INDENT_LINE " %4u. %-35s [%s]\n", id, name, api); } static void print_dev_node (const GValue *item, gpointer data) { WpPipewireObject *obj = g_value_get_object (item); struct print_context *context = data; guint32 id = wp_proxy_get_bound_id (WP_PROXY (obj)); gboolean is_default = (context->default_node == id); const gchar *name = NULL; if (cmdline.status.display_nicknames) name = wp_pipewire_object_get_property (obj, PW_KEY_NODE_NICK); else if (cmdline.status.display_names) name = wp_pipewire_object_get_property (obj, PW_KEY_NODE_NAME); if (!name) name = wp_pipewire_object_get_property (obj, PW_KEY_NODE_DESCRIPTION); printf (TREE_INDENT_LINE "%c %4u. %-35s", is_default ? '*' : ' ', id, name); print_controls (id, context); } static void print_filter_node (const GValue *item, gpointer data) { struct print_context *context = data; g_autoptr (WpPlugin) def_nodes_api = NULL; WpPipewireObject *obj = g_value_get_object (item); g_autoptr (WpIterator) it = NULL; g_auto (GValue) val = G_VALUE_INIT; const gchar *link_group; /* Skip already printed filters */ link_group = wp_pipewire_object_get_property (obj, PW_KEY_NODE_LINK_GROUP); if (g_hash_table_contains (context->printed_filters, link_group)) return; def_nodes_api = wp_plugin_find (context->self->core, "default-nodes-api"); /* Print all nodes for this link_group */ printf (TREE_INDENT_LINE " - %-60s\n", link_group); it = wp_object_manager_new_filtered_iterator (context->self->om, WP_TYPE_NODE, WP_CONSTRAINT_TYPE_PW_PROPERTY, PW_KEY_NODE_LINK_GROUP, "=s", link_group, NULL); for (; wp_iterator_next (it, &val); g_value_unset (&val)) { WpPipewireObject *node = g_value_get_object (&val); guint32 id = wp_proxy_get_bound_id (WP_PROXY (node)); const gchar *name, *media_class; name = wp_pipewire_object_get_property (node, PW_KEY_NODE_NAME); if (cmdline.status.display_nicknames) name = wp_pipewire_object_get_property (node, PW_KEY_NODE_NICK); else if (cmdline.status.display_names) name = wp_pipewire_object_get_property (node, PW_KEY_NODE_NAME); if (!name) name = wp_pipewire_object_get_property (node, PW_KEY_NODE_DESCRIPTION); media_class = wp_pipewire_object_get_property (node, PW_KEY_MEDIA_CLASS); context->default_node = -1; if (def_nodes_api) g_signal_emit_by_name (def_nodes_api, "get-default-node", media_class, &context->default_node); printf (TREE_INDENT_LINE "%c %4u. %-60s [%s]\n", context->default_node == id ? '*' : ' ', id, name, media_class); } g_clear_pointer (&it, wp_iterator_unref); /* Insert link-group in table to not print them again */ g_hash_table_insert (context->printed_filters, g_strdup (link_group), NULL); } static void print_stream_node (const GValue *item, gpointer data) { WpCtl * self = data; WpPipewireObject *obj = g_value_get_object (item); guint32 id = wp_proxy_get_bound_id (WP_PROXY (obj)); const gchar *name = wp_pipewire_object_get_property (obj, PW_KEY_APP_NAME); if (!name) name = wp_pipewire_object_get_property (obj, PW_KEY_NODE_NAME); printf (TREE_INDENT_EMPTY " %4u. %-60s\n", id, name); g_autoptr (WpIterator) it = wp_object_manager_new_filtered_iterator (self->om, WP_TYPE_PORT, WP_CONSTRAINT_TYPE_PW_PROPERTY, PW_KEY_NODE_ID, "=u", id, NULL); g_auto (GValue) val = G_VALUE_INIT; for (; wp_iterator_next (it, &val); g_value_unset (&val)) { WpPort *port = g_value_get_object (&val); obj = WP_PIPEWIRE_OBJECT (port); id = wp_proxy_get_bound_id (WP_PROXY (obj)); name = wp_pipewire_object_get_property (obj, PW_KEY_PORT_NAME); WpDirection dir = wp_port_get_direction (port); printf (TREE_INDENT_EMPTY " %4u. %-15s", id, name); g_autoptr (WpLink) link = wp_object_manager_lookup (self->om, WP_TYPE_LINK, WP_CONSTRAINT_TYPE_PW_PROPERTY, (dir == WP_DIRECTION_OUTPUT) ? PW_KEY_LINK_OUTPUT_PORT : PW_KEY_LINK_INPUT_PORT, "=u", id, NULL); if (link) { guint32 peer_id = -1; wp_link_get_linked_object_ids(link, NULL, (dir == WP_DIRECTION_INPUT) ? &peer_id : NULL, NULL, (dir == WP_DIRECTION_OUTPUT) ? &peer_id : NULL); g_autoptr (WpPipewireObject) peer = wp_object_manager_lookup ( self->om, WP_TYPE_PORT, WP_CONSTRAINT_TYPE_G_PROPERTY, "bound-id", "=u", peer_id, NULL); name = wp_pipewire_object_get_property (peer, PW_KEY_PORT_ALIAS); g_autoptr (GEnumClass) klass = g_type_class_ref (WP_TYPE_LINK_STATE); GEnumValue *state = g_enum_get_value (klass, wp_link_get_state (link, NULL)); printf (" %c %s\t[%s]\n", (dir == WP_DIRECTION_OUTPUT) ? '>' : '<', name, state->value_nick); } else { printf ("\n"); } } } static void status_run (WpCtl * self) { g_autoptr (WpIterator) it = NULL; g_auto (GValue) val = G_VALUE_INIT; g_autoptr (WpPlugin) def_nodes_api = NULL; struct print_context context = { .self = self }; def_nodes_api = wp_plugin_find (self->core, "default-nodes-api"); context.mixer_api = wp_plugin_find (self->core, "mixer-api"); /* server + clients */ printf ("PipeWire '%s' [%s, %s@%s, cookie:%u]\n", wp_core_get_remote_name (self->core), wp_core_get_remote_version (self->core), wp_core_get_remote_user_name (self->core), wp_core_get_remote_host_name (self->core), wp_core_get_remote_cookie (self->core)); printf (TREE_INDENT_END "Clients:\n"); it = wp_object_manager_new_filtered_iterator (self->om, WP_TYPE_CLIENT, NULL); for (; wp_iterator_next (it, &val); g_value_unset (&val)) { WpProxy *client = g_value_get_object (&val); g_autoptr (WpProperties) properties = wp_pipewire_object_get_properties (WP_PIPEWIRE_OBJECT (client)); printf (TREE_INDENT_EMPTY " %4u. %-35s [%s, %s@%s, pid:%s]\n", wp_proxy_get_bound_id (client), wp_properties_get (properties, PW_KEY_APP_NAME), wp_properties_get (properties, PW_KEY_CORE_VERSION), wp_properties_get (properties, PW_KEY_APP_PROCESS_USER), wp_properties_get (properties, PW_KEY_APP_PROCESS_HOST), wp_properties_get (properties, PW_KEY_APP_PROCESS_ID)); } g_clear_pointer (&it, wp_iterator_unref); printf ("\n"); /* sessions */ const gchar *MEDIA_TYPES[] = { "Audio", "Video" }; for (guint i = 0; i < G_N_ELEMENTS (MEDIA_TYPES); i++) { const gchar *media_type = MEDIA_TYPES[i]; g_autoptr (WpIterator) child_it = NULL; printf ("%s\n", media_type); if (media_type && *media_type != '\0') { gchar media_type_glob[16]; gchar media_class[24]; g_snprintf (media_type_glob, sizeof(media_type_glob), "*%s*", media_type); printf (TREE_INDENT_NODE "Devices:\n"); child_it = wp_object_manager_new_filtered_iterator (self->om, WP_TYPE_DEVICE, WP_CONSTRAINT_TYPE_PW_PROPERTY, PW_KEY_MEDIA_CLASS, "#s", media_type_glob, NULL); wp_iterator_foreach (child_it, print_device, self); g_clear_pointer (&child_it, wp_iterator_unref); printf (TREE_INDENT_LINE "\n"); printf (TREE_INDENT_NODE "Sinks:\n"); g_snprintf (media_class, sizeof(media_class), "%s/Sink", media_type); context.default_node = -1; if (def_nodes_api) g_signal_emit_by_name (def_nodes_api, "get-default-node", media_class, &context.default_node); child_it = wp_object_manager_new_filtered_iterator (self->om, WP_TYPE_NODE, WP_CONSTRAINT_TYPE_PW_PROPERTY, PW_KEY_MEDIA_CLASS, "#s", "*/Sink*", WP_CONSTRAINT_TYPE_PW_PROPERTY, PW_KEY_MEDIA_CLASS, "#s", media_type_glob, WP_CONSTRAINT_TYPE_PW_PROPERTY, PW_KEY_NODE_LINK_GROUP, "-", NULL); wp_iterator_foreach (child_it, print_dev_node, (gpointer) &context); g_clear_pointer (&child_it, wp_iterator_unref); printf (TREE_INDENT_LINE "\n"); printf (TREE_INDENT_NODE "Sources:\n"); g_snprintf (media_class, sizeof(media_class), "%s/Source", media_type); context.default_node = -1; if (def_nodes_api) g_signal_emit_by_name (def_nodes_api, "get-default-node", media_class, &context.default_node); child_it = wp_object_manager_new_filtered_iterator (self->om, WP_TYPE_NODE, WP_CONSTRAINT_TYPE_PW_PROPERTY, PW_KEY_MEDIA_CLASS, "#s", "*/Source*", WP_CONSTRAINT_TYPE_PW_PROPERTY, PW_KEY_MEDIA_CLASS, "#s", media_type_glob, WP_CONSTRAINT_TYPE_PW_PROPERTY, PW_KEY_NODE_LINK_GROUP, "-", NULL); wp_iterator_foreach (child_it, print_dev_node, (gpointer) &context); g_clear_pointer (&child_it, wp_iterator_unref); printf (TREE_INDENT_LINE "\n"); printf (TREE_INDENT_NODE "Filters:\n"); context.printed_filters = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, NULL); child_it = wp_object_manager_new_filtered_iterator (self->om, WP_TYPE_NODE, WP_CONSTRAINT_TYPE_PW_PROPERTY, PW_KEY_MEDIA_CLASS, "#s", media_type_glob, WP_CONSTRAINT_TYPE_PW_PROPERTY, PW_KEY_NODE_LINK_GROUP, "+", NULL); wp_iterator_foreach (child_it, print_filter_node, (gpointer) &context); g_clear_pointer (&child_it, wp_iterator_unref); g_clear_pointer (&context.printed_filters, g_hash_table_unref); printf (TREE_INDENT_LINE "\n"); printf (TREE_INDENT_END "Streams:\n"); child_it = wp_object_manager_new_filtered_iterator (self->om, WP_TYPE_NODE, WP_CONSTRAINT_TYPE_PW_PROPERTY, PW_KEY_MEDIA_CLASS, "#s", "Stream/*", WP_CONSTRAINT_TYPE_PW_PROPERTY, PW_KEY_MEDIA_CLASS, "#s", media_type_glob, WP_CONSTRAINT_TYPE_PW_PROPERTY, PW_KEY_NODE_LINK_GROUP, "-", NULL); wp_iterator_foreach (child_it, print_stream_node, self); g_clear_pointer (&child_it, wp_iterator_unref); } printf ("\n"); } /* Settings */ printf ("Settings\n"); printf (TREE_INDENT_END "Default Configured Devices:\n"); if (def_nodes_api) { for (guint i = 0; i < G_N_ELEMENTS (DEFAULT_NODE_MEDIA_CLASSES); i++) { g_autofree gchar *name = NULL; g_signal_emit_by_name (def_nodes_api, "get-default-configured-node-name", DEFAULT_NODE_MEDIA_CLASSES[i], &name); if (name) printf (TREE_INDENT_EMPTY " %4u. %-12s %s\n", i, DEFAULT_NODE_MEDIA_CLASSES[i], name); } } g_clear_object (&context.mixer_api); g_main_loop_quit (self->loop); } /* get-volume */ static gboolean get_volume_parse_positional (gint argc, gchar ** argv, GError **error) { if (argc < 3) { g_set_error (error, wpctl_error_domain_quark(), 0, "ID is required"); return FALSE; } else { return parse_id (true, false, argv[2], &cmdline.get_volume.id, error); } } static gboolean get_volume_prepare (WpCtl * self, GError ** error) { wp_object_manager_add_interest (self->om, WP_TYPE_NODE, NULL); wp_object_manager_request_object_features (self->om, WP_TYPE_GLOBAL_PROXY, WP_PIPEWIRE_OBJECT_FEATURES_MINIMAL); return TRUE; } static void do_print_volume (WpCtl * self, WpPipewireObject *proxy) { g_autoptr (WpPlugin) mixer_api = wp_plugin_find (self->core, "mixer-api"); GVariant *variant = NULL; gboolean mute = FALSE; gdouble volume = 1.0; guint32 id = wp_proxy_get_bound_id (WP_PROXY (proxy)); g_signal_emit_by_name (mixer_api, "get-volume", id, &variant); if (!variant) { fprintf (stderr, "Node %d does not support volume\n", id); return; } g_variant_lookup (variant, "volume", "d", &volume); g_variant_lookup (variant, "mute", "b", &mute); g_clear_pointer (&variant, g_variant_unref); printf ("Volume: %.2f%s", volume, mute ? " [MUTED]\n" : "\n"); } static void get_volume_run (WpCtl * self) { g_autoptr (WpPlugin) def_nodes_api = NULL; g_autoptr (GError) error = NULL; g_autoptr (WpPipewireObject) proxy = NULL; guint32 id; def_nodes_api = wp_plugin_find (self->core, "default-nodes-api"); if (!translate_id (def_nodes_api, cmdline.get_volume.id, &id, &error)) { fprintf(stderr, "Translate ID error: %s\n\n", error->message); goto out; } proxy = wp_object_manager_lookup (self->om, WP_TYPE_GLOBAL_PROXY, WP_CONSTRAINT_TYPE_G_PROPERTY, "bound-id", "=u", id, NULL); if (!proxy) { fprintf (stderr, "Node '%d' not found\n", id); goto out; } do_print_volume (self, proxy); out: g_main_loop_quit (self->loop); } /* inspect */ static gboolean inspect_parse_positional (gint argc, gchar ** argv, GError **error) { if (argc < 3) { g_set_error (error, wpctl_error_domain_quark(), 0, "ID is required"); return FALSE; } return parse_id (true, true, argv[2], &cmdline.inspect.id, error); } static gboolean inspect_prepare (WpCtl * self, GError ** error) { /* collect all objects */ wp_object_manager_add_interest (self->om, WP_TYPE_GLOBAL_PROXY, NULL); wp_object_manager_request_object_features (self->om, WP_TYPE_GLOBAL_PROXY, WP_PIPEWIRE_OBJECT_FEATURES_MINIMAL); return TRUE; } static inline void inspect_prefix_line (guint nest_level, gboolean node) { for (guint i = 1; i < nest_level; i++) printf (TREE_INDENT_EMPTY TREE_INDENT_LINE); if (nest_level > 0) printf (TREE_INDENT_EMPTY "%s", node ? TREE_INDENT_NODE : TREE_INDENT_LINE); } struct { const gchar *key; const gchar *type; } assoc_keys[] = { { PW_KEY_CLIENT_ID, "Client" }, { PW_KEY_DEVICE_ID, "Device" }, { PW_KEY_LINK_INPUT_NODE, NULL }, { PW_KEY_LINK_INPUT_PORT, NULL }, { PW_KEY_LINK_OUTPUT_NODE, NULL }, { PW_KEY_LINK_OUTPUT_PORT, NULL }, { PW_KEY_LINK_ID, "Link" }, { PW_KEY_NODE_ID, "Node" }, { PW_KEY_PORT_ID, "Port" }, { PW_KEY_SESSION_ID, "Session" }, }; static inline gboolean key_is_object_reference (const gchar *key) { for (guint i = 0; i < G_N_ELEMENTS (assoc_keys); i++) if (!g_strcmp0 (key, assoc_keys[i].key)) return TRUE; return FALSE; } static inline const gchar * get_association_key (WpProxy * proxy) { for (guint i = 0; i < G_N_ELEMENTS (assoc_keys); i++) { if (assoc_keys[i].type && strstr (WP_PROXY_GET_CLASS (proxy)->pw_iface_type, assoc_keys[i].type)) return assoc_keys[i].key; } return NULL; } struct property_item { const gchar *key; const gchar *value; }; static gint property_item_compare (gconstpointer a, gconstpointer b) { return g_strcmp0 ( ((struct property_item *) a)->key, ((struct property_item *) b)->key); } static void inspect_print_object (WpCtl * self, WpProxy * proxy, guint nest_level) { g_autoptr (WpProperties) properties = WP_IS_PIPEWIRE_OBJECT (proxy) ? wp_pipewire_object_get_properties (WP_PIPEWIRE_OBJECT (proxy)) : wp_properties_new_empty (); g_autoptr (WpProperties) global_p = wp_global_proxy_get_global_properties (WP_GLOBAL_PROXY (proxy)); g_autoptr (GArray) array = g_array_new (FALSE, FALSE, sizeof (struct property_item)); /* print basic object info */ inspect_prefix_line (nest_level, TRUE); printf ("id %u, type %s\n", wp_proxy_get_bound_id (proxy), WP_PROXY_GET_CLASS (proxy)->pw_iface_type); /* merge the two property sets */ properties = wp_properties_ensure_unique_owner (properties); wp_properties_add (properties, global_p); wp_properties_set (properties, "object.id", NULL); /* copy key/value pointers to an array for sorting */ { g_autoptr (WpIterator) it = NULL; g_auto (GValue) item = G_VALUE_INIT; for (it = wp_properties_new_iterator (properties); wp_iterator_next (it, &item); g_value_unset (&item)) { WpPropertiesItem *pi = g_value_get_boxed (&item); struct property_item prop_item = { .key = wp_properties_item_get_key (pi), .value = wp_properties_item_get_value (pi), }; g_array_append_val (array, prop_item); } } /* sort */ g_array_sort (array, property_item_compare); /* print */ for (guint i = 0; i < array->len; i++) { struct property_item *prop_item = &g_array_index (array, struct property_item, i); gboolean is_global = (wp_properties_get (global_p, prop_item->key) != NULL); inspect_prefix_line (nest_level, FALSE); printf (" %c %s = \"%s\"\n", is_global ? '*' : ' ', prop_item->key, prop_item->value); /* if the property is referencing an object, print the object */ if (cmdline.inspect.show_referenced && nest_level == 0 && key_is_object_reference (prop_item->key)) { guint32 id = (guint32) strtol (prop_item->value, NULL, 10); g_autoptr (WpProxy) refer_proxy = wp_object_manager_lookup (self->om, WP_TYPE_GLOBAL_PROXY, WP_CONSTRAINT_TYPE_G_PROPERTY, "bound-id", "=u", id, NULL); if (refer_proxy) inspect_print_object (self, refer_proxy, nest_level + 1); } } /* print associated objects */ if (cmdline.inspect.show_associated && nest_level == 0) { const gchar *lookup_key = get_association_key (proxy); if (lookup_key) { g_autoptr (WpIterator) it = wp_object_manager_new_filtered_iterator (self->om, WP_TYPE_PIPEWIRE_OBJECT, WP_CONSTRAINT_TYPE_PW_PROPERTY, lookup_key, "=u", wp_proxy_get_bound_id (proxy), NULL); g_auto (GValue) item = G_VALUE_INIT; inspect_prefix_line (nest_level, TRUE); printf ("associated objects:\n"); for (; wp_iterator_next (it, &item); g_value_unset (&item)) { WpProxy *assoc_proxy = g_value_get_object (&item); inspect_print_object (self, assoc_proxy, nest_level + 1); } } } } static void inspect_run (WpCtl * self) { g_autoptr (WpProxy) proxy = NULL; g_autoptr (WpPlugin) def_nodes_api = wp_plugin_find (self->core, "default-nodes-api"); g_autoptr (GError) error = NULL; guint32 id; if (!translate_id (def_nodes_api, cmdline.inspect.id, &id, &error)) { fprintf(stderr, "Translate ID error: %s\n\n", error->message); goto out_err; } proxy = wp_object_manager_lookup (self->om, WP_TYPE_GLOBAL_PROXY, WP_CONSTRAINT_TYPE_G_PROPERTY, "bound-id", "=u", id, NULL); if (!proxy) { fprintf (stderr, "Object '%d' not found\n", id); goto out_err; } inspect_print_object (self, proxy, 0); out: g_main_loop_quit (self->loop); return; out_err: self->exit_code = 3; goto out; } /* set-default */ static gboolean set_default_parse_positional (gint argc, gchar ** argv, GError **error) { if (argc < 3) { g_set_error (error, wpctl_error_domain_quark(), 0, "ID is required"); return FALSE; } return parse_id (false, false, argv[2], &cmdline.set_default.id, error); } static gboolean set_default_prepare (WpCtl * self, GError ** error) { wp_object_manager_add_interest (self->om, WP_TYPE_NODE, WP_CONSTRAINT_TYPE_PW_GLOBAL_PROPERTY, "object.id", "=u", (guint32) cmdline.set_default.id, NULL); wp_object_manager_request_object_features (self->om, WP_TYPE_NODE, WP_PIPEWIRE_OBJECT_FEATURES_MINIMAL); return TRUE; } static void set_default_run (WpCtl * self) { g_autoptr (WpPlugin) def_nodes_api = NULL; g_autoptr (WpProxy) proxy = NULL; guint32 id; g_autoptr (GError) error = NULL; const gchar *media_class; def_nodes_api = wp_plugin_find (self->core, "default-nodes-api"); if (!def_nodes_api) { fprintf (stderr, "Default nodes API not loaded\n"); goto out; } if (!translate_id (def_nodes_api, cmdline.set_default.id, &id, &error)) { fprintf(stderr, "Translate ID error: %s\n\n", error->message); goto out; } proxy = wp_object_manager_lookup (self->om, WP_TYPE_NODE, NULL); if (!proxy) { fprintf (stderr, "Node '%d' not found\n", id); goto out; } media_class = wp_pipewire_object_get_property (WP_PIPEWIRE_OBJECT (proxy), PW_KEY_MEDIA_CLASS); for (guint i = 0; i < G_N_ELEMENTS (DEFAULT_NODE_MEDIA_CLASSES); i++) { if (!g_strcmp0 (media_class, DEFAULT_NODE_MEDIA_CLASSES[i])) { gboolean res = FALSE; const gchar *name = wp_pipewire_object_get_property ( WP_PIPEWIRE_OBJECT (proxy), PW_KEY_NODE_NAME); if (!name) { fprintf (stderr, "node %u does not have a valid node.name\n", id); goto out; } g_signal_emit_by_name (def_nodes_api, "set-default-configured-node-name", DEFAULT_NODE_MEDIA_CLASSES[i], name, &res); if (!res) { fprintf (stderr, "failed to set default node %u (media.class = %s)\n", id, media_class); goto out; } wp_core_sync (self->core, NULL, (GAsyncReadyCallback) async_quit, self); return; } } fprintf (stderr, "%u is not a device node (media.class = %s)\n", id, media_class); out: self->exit_code = 3; g_main_loop_quit (self->loop); } /* set-volume */ static gboolean set_volume_parse_positional (gint argc, gchar ** argv, GError **error) { g_autoptr (GRegex) regex = NULL; g_autoptr (GMatchInfo) info = NULL; if (argc < 4) { g_set_error_literal (error, wpctl_error_domain_quark(), 0, "ID and VOL[%][-/+] are required"); return FALSE; } regex = g_regex_new ("^(\\d*\\.?\\d*)(%?)([-+]?)$", 0, 0, NULL); if (g_regex_match(regex, argv[3], 0, &info)) { gchar *str = g_match_info_fetch (info, 1); cmdline.set_volume.volume = strtof (str, NULL); cmdline.set_volume.type = 'a'; g_free (str); str = g_match_info_fetch (info, 2); if (g_strcmp0 (str, "%") == 0) cmdline.set_volume.volume /= 100; g_free (str); str = g_match_info_fetch (info, 3); if (g_strcmp0 (str, "-") == 0) { cmdline.set_volume.volume = -(cmdline.set_volume.volume); cmdline.set_volume.type = 's'; } else if (g_strcmp0 (str, "+") == 0) { cmdline.set_volume.type = 's'; } g_free (str); } else { g_set_error (error, wpctl_error_domain_quark(), 0, "Invalid volume argument. See wpctl set-volume --help"); return FALSE; } return parse_id (!cmdline.set_volume.is_pid, false, argv[2], &cmdline.set_volume.id, error); } static gboolean set_volume_prepare (WpCtl * self, GError ** error) { wp_object_manager_add_interest (self->om, WP_TYPE_NODE, NULL); wp_object_manager_add_interest (self->om, WP_TYPE_CLIENT, NULL); wp_object_manager_request_object_features (self->om, WP_TYPE_GLOBAL_PROXY, WP_PIPEWIRE_OBJECT_FEATURES_MINIMAL); return TRUE; } static gboolean do_set_volume (WpCtl * self, WpPipewireObject *proxy) { g_autoptr (WpPlugin) mixer_api = wp_plugin_find (self->core, "mixer-api"); g_auto (GVariantBuilder) b = G_VARIANT_BUILDER_INIT (G_VARIANT_TYPE_VARDICT); GVariant *variant = NULL; gboolean res = FALSE; gdouble curr_volume = 1.0; guint32 id = wp_proxy_get_bound_id (WP_PROXY (proxy)); if (cmdline.set_volume.type == 's') { g_signal_emit_by_name (mixer_api, "get-volume", id, &variant); if (!variant) { fprintf (stderr, "Node %d does not support volume\n", id); g_clear_pointer (&variant, g_variant_unref); return FALSE; } g_variant_lookup (variant, "volume", "d", &curr_volume); g_clear_pointer (&variant, g_variant_unref); cmdline.set_volume.volume = (cmdline.set_volume.volume + curr_volume); } if (cmdline.set_volume.volume < 0) { cmdline.set_volume.volume = 0.0; } if (cmdline.set_volume.limit > 0) { if (cmdline.set_volume.volume > cmdline.set_volume.limit) { cmdline.set_volume.volume = cmdline.set_volume.limit; } } g_variant_builder_add (&b, "{sv}", "volume", g_variant_new_double (cmdline.set_volume.volume)); variant = g_variant_builder_end (&b); g_signal_emit_by_name (mixer_api, "set-volume", id, variant, &res); if (!res) { fprintf (stderr, "Node %d does not support volume\n", id); return FALSE; } return TRUE; } static gboolean do_set_volume_cb (const GValue *node_val, GValue *ret, gpointer data) { WpCtl * self = data; WpPipewireObject *node = g_value_get_object (node_val); return do_set_volume (self, node); } static void set_volume_run (WpCtl * self) { g_autoptr (WpPipewireObject) proxy = NULL; g_autoptr (WpPlugin) def_nodes_api = wp_plugin_find (self->core, "default-nodes-api"); g_autoptr (GError) error = NULL; guint32 id; if (!translate_id (def_nodes_api, cmdline.set_volume.id, &id, &error)) { fprintf(stderr, "Translate ID error: %s\n\n", error->message); goto out; } if (cmdline.set_volume.is_pid) { if (!run_nodes_by_pid (self->om, id, do_set_volume_cb, self)) { fprintf (stderr, "Could not set volume in all nodes with PID '%d'\n", id); goto out; } } else { proxy = wp_object_manager_lookup (self->om, WP_TYPE_GLOBAL_PROXY, WP_CONSTRAINT_TYPE_PW_GLOBAL_PROPERTY, "object.id", "=u", id, NULL); if (!proxy) { fprintf (stderr, "Object '%d' not found\n", id); goto out; } if (!do_set_volume (self, proxy)) goto out; } wp_core_sync (self->core, NULL, (GAsyncReadyCallback) async_quit, self); return; out: self->exit_code = 3; g_main_loop_quit (self->loop); } /* set-mute */ static gboolean set_mute_parse_positional (gint argc, gchar ** argv, GError **error) { if (argc < 4) { g_set_error (error, wpctl_error_domain_quark(), 0, "ID and one of '1', '0' or 'toggle' are required"); return FALSE; } if (!g_strcmp0 (argv[3], "1")) cmdline.set_mute.mute = 1; else if (!g_strcmp0 (argv[3], "0")) cmdline.set_mute.mute = 0; else if (!g_strcmp0 (argv[3], "toggle")) cmdline.set_mute.mute = 2; else { g_set_error (error, wpctl_error_domain_quark(), 0, "'%s' is not a valid mute option", argv[3]); return FALSE; } return parse_id (!cmdline.set_mute.is_pid, false, argv[2], &cmdline.set_mute.id, error); } static gboolean set_mute_prepare (WpCtl * self, GError ** error) { wp_object_manager_add_interest (self->om, WP_TYPE_NODE, NULL); wp_object_manager_add_interest (self->om, WP_TYPE_CLIENT, NULL); wp_object_manager_request_object_features (self->om, WP_TYPE_GLOBAL_PROXY, WP_PIPEWIRE_OBJECT_FEATURES_MINIMAL); return TRUE; } static gboolean do_set_mute (WpCtl * self, WpPipewireObject *proxy) { g_autoptr (WpPlugin) mixer_api = wp_plugin_find (self->core, "mixer-api"); g_auto (GVariantBuilder) b = G_VARIANT_BUILDER_INIT (G_VARIANT_TYPE_VARDICT); GVariant *variant = NULL; gboolean res = FALSE; gboolean mute = FALSE; guint32 id = wp_proxy_get_bound_id (WP_PROXY (proxy)); g_signal_emit_by_name (mixer_api, "get-volume", id, &variant); if (!variant) { fprintf (stderr, "Node %d does not support mute\n", id); return FALSE; } g_variant_lookup (variant, "mute", "b", &mute); g_clear_pointer (&variant, g_variant_unref); if (cmdline.set_mute.mute == 2) mute = !mute; else mute = !!cmdline.set_mute.mute; g_variant_builder_add (&b, "{sv}", "mute", g_variant_new_boolean (mute)); variant = g_variant_builder_end (&b); g_signal_emit_by_name (mixer_api, "set-volume", id, variant, &res); return TRUE; } static gboolean do_set_mute_cb (const GValue *node_val, GValue *ret, gpointer data) { WpCtl * self = data; WpPipewireObject *node = g_value_get_object (node_val); return do_set_mute (self, node); } static void set_mute_run (WpCtl * self) { g_autoptr (WpPipewireObject) proxy = NULL; g_autoptr (WpPlugin) def_nodes_api = wp_plugin_find (self->core, "default-nodes-api"); g_autoptr (GError) error = NULL; guint32 id; if (!translate_id (def_nodes_api, cmdline.set_mute.id, &id, &error)) { fprintf(stderr, "Translate ID error: %s\n\n", error->message); goto out; } if (cmdline.set_mute.is_pid) { if (!run_nodes_by_pid (self->om, id, do_set_mute_cb, self)) { fprintf (stderr, "Could not set mute in all nodes with PID '%d'\n", id); goto out; } } else { proxy = wp_object_manager_lookup (self->om, WP_TYPE_GLOBAL_PROXY, WP_CONSTRAINT_TYPE_PW_GLOBAL_PROPERTY, "object.id", "=u", id, NULL); if (!proxy) { fprintf (stderr, "Object '%d' not found\n", id); goto out; } if (!do_set_mute (self, proxy)) goto out; } wp_core_sync (self->core, NULL, (GAsyncReadyCallback) async_quit, self); return; out: self->exit_code = 3; g_main_loop_quit (self->loop); } /* set-profile */ static gboolean set_profile_parse_positional (gint argc, gchar ** argv, GError **error) { if (argc < 4) { g_set_error (error, wpctl_error_domain_quark(), 0, "ID and INDEX are required"); return FALSE; } cmdline.set_profile.index = atoi (argv[3]); return parse_id (true, true, argv[2], &cmdline.set_profile.id, error); } static gboolean set_profile_prepare (WpCtl * self, GError ** error) { wp_object_manager_add_interest (self->om, WP_TYPE_GLOBAL_PROXY, NULL); wp_object_manager_request_object_features (self->om, WP_TYPE_GLOBAL_PROXY, WP_PIPEWIRE_OBJECT_FEATURES_MINIMAL); return TRUE; } static void set_profile_run (WpCtl * self) { g_autoptr (WpPlugin) def_nodes_api = wp_plugin_find (self->core, "default-nodes-api"); g_autoptr (WpPipewireObject) proxy = NULL; g_autoptr (GError) error = NULL; guint32 node_id; if (!translate_id (def_nodes_api, cmdline.set_profile.id, &node_id, &error)) { fprintf(stderr, "Translate ID error: %s\n\n", error->message); goto out; } proxy = wp_object_manager_lookup (self->om, WP_TYPE_GLOBAL_PROXY, WP_CONSTRAINT_TYPE_PW_GLOBAL_PROPERTY, "object.id", "=u", node_id, NULL); if (!proxy) { fprintf (stderr, "Object '%d' not found\n", node_id); goto out; } wp_pipewire_object_set_param (proxy, "Profile", 0, wp_spa_pod_new_object ( "Spa:Pod:Object:Param:Profile", "Profile", "index", "i", cmdline.set_profile.index, "save", "b", TRUE, NULL)); wp_core_sync (self->core, NULL, (GAsyncReadyCallback) async_quit, self); return; out: self->exit_code = 3; g_main_loop_quit (self->loop); } /* set-route */ static gboolean set_route_parse_positional (gint argc, gchar ** argv, GError **error) { if (argc < 4) { g_set_error (error, wpctl_error_domain_quark(), 0, "ID and INDEX required"); return FALSE; } cmdline.set_route.index = atoi (argv[3]); return parse_id (true, true, argv[2], &cmdline.set_route.id, error); } static gboolean set_route_prepare (WpCtl * self, GError ** error) { wp_object_manager_add_interest (self->om, WP_TYPE_GLOBAL_PROXY, NULL); wp_object_manager_request_object_features (self->om, WP_TYPE_GLOBAL_PROXY, WP_PIPEWIRE_OBJECT_FEATURES_MINIMAL); return TRUE; } static void set_route_run (WpCtl * self) { g_autoptr (WpPlugin) def_nodes_api = wp_plugin_find (self->core, "default-nodes-api"); g_autoptr (WpPipewireObject) proxy = NULL; g_autoptr (WpPipewireObject) device_proxy = NULL; g_autoptr (GError) error = NULL; guint32 node_id; if (!translate_id (def_nodes_api, cmdline.set_route.id, &node_id, &error)) { fprintf(stderr, "Translate ID error: %s\n\n", error->message); goto out; } proxy = wp_object_manager_lookup (self->om, WP_TYPE_GLOBAL_PROXY, WP_CONSTRAINT_TYPE_PW_GLOBAL_PROPERTY, "object.id", "=u", node_id, NULL); if (!proxy) { fprintf (stderr, "Object '%d' not found\n", node_id); goto out; } const char * route_device_str = wp_pipewire_object_get_property(proxy, "card.profile.device"); if (!route_device_str) { fprintf (stderr, "Property 'card.profile.device' not found\n"); goto out; } guint32 route_device = atoi (route_device_str); const char * device_id_str = wp_pipewire_object_get_property (proxy, "device.id"); if (!device_id_str) { fprintf (stderr, "Property 'device.id' not found\n"); goto out; } guint32 device_id = atoi (device_id_str); device_proxy = wp_object_manager_lookup (self->om, WP_TYPE_GLOBAL_PROXY, WP_CONSTRAINT_TYPE_PW_GLOBAL_PROPERTY, "object.id", "=u", device_id, NULL); if (!device_proxy) { fprintf (stderr, "Object '%d' not found\n", device_id); goto out; } wp_pipewire_object_set_param (device_proxy, "Route", 0, wp_spa_pod_new_object ( "Spa:Pod:Object:Param:Route", "Route", "index", "i", cmdline.set_route.index, "device", "i", route_device, NULL)); wp_core_sync (self->core, NULL, (GAsyncReadyCallback) async_quit, self); return; out: self->exit_code = 3; g_main_loop_quit (self->loop); } /* clear-default */ static gboolean clear_default_parse_positional (gint argc, gchar ** argv, GError **error) { if (argc >= 3) { long id = strtol (argv[2], NULL, 10); if (id < 0 || id >= (long)G_N_ELEMENTS (DEFAULT_NODE_MEDIA_CLASSES)) { g_set_error (error, wpctl_error_domain_quark(), 0, "The setting ID value must be between 0 and %ld inclusive", G_N_ELEMENTS (DEFAULT_NODE_MEDIA_CLASSES) - 1); return FALSE; } cmdline.clear_default.id = id; } else { cmdline.clear_default.id = SPA_ID_INVALID; } return TRUE; } static gboolean clear_default_prepare (WpCtl * self, GError ** error) { return TRUE; } static void clear_default_run (WpCtl * self) { g_autoptr (WpPlugin) def_nodes_api = NULL; gboolean res = FALSE; def_nodes_api = wp_plugin_find (self->core, "default-nodes-api"); if (!def_nodes_api) { fprintf (stderr, "Default nodes API not loaded\n"); goto out; } /* clear all defaults if id was not given */ if (cmdline.clear_default.id == SPA_ID_INVALID) { for (guint i = 0; i < G_N_ELEMENTS (DEFAULT_NODE_MEDIA_CLASSES); i++) { g_signal_emit_by_name (def_nodes_api, "set-default-configured-node-name", DEFAULT_NODE_MEDIA_CLASSES[i], NULL, &res); if (!res) { fprintf (stderr, "failed to clear default configured node (%s)\n", DEFAULT_NODE_MEDIA_CLASSES[i]); goto out; } } } else { g_signal_emit_by_name (def_nodes_api, "set-default-configured-node-name", DEFAULT_NODE_MEDIA_CLASSES[cmdline.clear_default.id], NULL, &res); if (!res) { fprintf (stderr, "failed to clear default configured node (%s)\n", DEFAULT_NODE_MEDIA_CLASSES[cmdline.clear_default.id]); goto out; } } wp_core_sync (self->core, NULL, (GAsyncReadyCallback) async_quit, self); return; out: self->exit_code = 3; g_main_loop_quit (self->loop); } /* settings */ static gboolean settings_parse_positional (gint argc, gchar ** argv, GError **error) { cmdline.settings.key = NULL; cmdline.settings.val = NULL; if (argc >= 3) { cmdline.settings.key = argv[2]; if (argc >= 4) cmdline.settings.val = argv[3]; } if (cmdline.settings.delete && cmdline.settings.save) { g_set_error (error, wpctl_error_domain_quark(), 0, "Cannot use --delete and --save flags at the same time"); return FALSE; } if (cmdline.settings.delete && cmdline.settings.reset) { g_set_error (error, wpctl_error_domain_quark(), 0, "Cannot use --delete and --reset flags at the same time"); return FALSE; } if (cmdline.settings.save && cmdline.settings.reset) { g_set_error (error, wpctl_error_domain_quark(), 0, "Cannot use --save and --reset flags at the same time"); return FALSE; } return TRUE; } static gboolean settings_prepare (WpCtl * self, GError ** error) { wp_object_manager_add_interest (self->om, WP_TYPE_METADATA, NULL); wp_object_manager_request_object_features (self->om, WP_TYPE_METADATA, WP_OBJECT_FEATURES_ALL); return TRUE; } static const char * settings_spec_type_to_string (WpSettingsSpecType type) { switch (type) { case WP_SETTINGS_SPEC_TYPE_BOOL: return "Boolean"; case WP_SETTINGS_SPEC_TYPE_INT: return "Integer"; case WP_SETTINGS_SPEC_TYPE_FLOAT: return "Float"; case WP_SETTINGS_SPEC_TYPE_STRING: return "String"; case WP_SETTINGS_SPEC_TYPE_ARRAY: return "Array"; case WP_SETTINGS_SPEC_TYPE_OBJECT: return "Object"; case WP_SETTINGS_SPEC_TYPE_UNKNOWN: default: break; } return "Uknown"; } static void print_setting (WpSettings *s, const gchar *key) { g_autoptr (WpSpaJson) value = NULL; g_autoptr (WpSpaJson) saved = NULL; g_autoptr (WpSettingsSpec) spec = NULL; const gchar *desc; WpSettingsSpecType val_type; g_autoptr (WpSpaJson) def = NULL; g_autoptr (WpSpaJson) min = NULL; g_autoptr (WpSpaJson) max = NULL; value = wp_settings_get (s, key); saved = wp_settings_get_saved (s, key); spec = wp_settings_get_spec (s, key); desc = wp_settings_spec_get_description (spec); val_type = wp_settings_spec_get_value_type (spec); def = wp_settings_spec_get_default_value (spec); min = wp_settings_spec_get_min_value (spec); max = wp_settings_spec_get_max_value (spec); /* print key */ printf ("- Name: %s\n", key); /* print spec */ printf (" Desc: %s\n", desc); printf (" Type: %s\n", settings_spec_type_to_string (val_type)); printf (" Default: %s", wp_spa_json_get_data (def)); if (min && max) printf ("\t[Min: %s, Max: %s]", wp_spa_json_get_data (min), wp_spa_json_get_data (max)); printf ("\n"); printf (" Value: %s", wp_spa_json_get_data (value)); if (saved) printf ("\t[Saved: %s]", wp_spa_json_get_data (saved)); printf ("\n\n"); } static void print_settings (WpSettings *s) { g_autoptr (WpIterator) it = NULL; g_auto (GValue) item = G_VALUE_INIT; printf ("Settings:\n\n"); it = wp_settings_new_iterator (s); while (wp_iterator_next (it, &item)) { WpSettingsItem *si = g_value_get_boxed (&item); const gchar *key = wp_settings_item_get_key (si); print_setting (s, key); g_value_unset (&item); } } static void settings_run (WpCtl * self) { g_autoptr (WpSettings) s = NULL; const gchar *key = cmdline.settings.key, *val = cmdline.settings.val; gboolean delete_flag = cmdline.settings.delete; gboolean save_flag = cmdline.settings.save; gboolean reset_flag = cmdline.settings.reset; s = wp_settings_find (self->core, NULL); if (!s) { printf ("Could not find registered settings\n"); goto out; } /* If no key or value are provided */ if (!key && !val) { if (!delete_flag && !save_flag && !reset_flag) { print_settings (s); } else if (!delete_flag && save_flag && !reset_flag) { wp_settings_save_all (s); fprintf (stderr, "Saved all settings\n"); } else if (delete_flag && !save_flag && !reset_flag) { wp_settings_delete_all (s); fprintf (stderr, "Deleted all saved settings\n"); } else if (!delete_flag && !save_flag && reset_flag) { wp_settings_reset_all (s); fprintf (stderr, "Reset all settings\n"); } else { g_assert_not_reached (); } } /* If key is only provided */ else if (key && !val) { if (!delete_flag && !save_flag && !reset_flag) { g_autoptr (WpSpaJson) value = NULL; value = wp_settings_get (s, key); if (value) { g_autoptr (WpSpaJson) saved = wp_settings_get_saved (s, key); printf ("Value: %s", wp_spa_json_get_data (value)); if (saved) printf (" (Saved: %s)", wp_spa_json_get_data (saved)); printf ("\n"); } else { printf ("Setting '%s' not found\n", key); } } else if (!delete_flag && save_flag && !reset_flag) { if (wp_settings_save (s, key)) printf ("Saved setting '%s' successfully\n", key); else printf ("Setting '%s' not found\n", key); } else if (delete_flag && !save_flag && !reset_flag) { if (wp_settings_delete (s, key)) printf ("Deleted setting '%s' successfully\n", key); else printf ("Setting '%s' not found\n", key); } else if (!delete_flag && !save_flag && reset_flag) { if (wp_settings_reset (s, key)) printf ("Reset setting '%s' successfully\n", key); else printf ("Setting '%s' not found\n", key); } else { g_assert_not_reached (); } } /* If both key and value are provided */ else if (key && val) { if (!delete_flag && !save_flag && !reset_flag) { g_autoptr (WpSpaJson) value = wp_spa_json_new_from_string (val); if (wp_settings_set (s, key, value)) printf ("Updated setting '%s' to: %s\n", key, val); else printf ("Failed to set setting '%s' to: %s\n", key, val); } else if (!delete_flag && save_flag && !reset_flag) { g_autoptr (WpSpaJson) value = wp_spa_json_new_from_string (val); if (wp_settings_set (s, key, value) && wp_settings_save (s, key)) printf ("Updated and saved setting '%s' to: %s\n", key, val); else printf ("Failed to update and save setting '%s' to: %s\n", key, val); } else if (delete_flag && !save_flag && !reset_flag) { if (wp_settings_delete (s, key)) printf ("Deleted setting '%s' successfully\n", key); else printf ("Setting %s not found\n", key); } else if (!delete_flag && !save_flag && reset_flag) { if (wp_settings_reset (s, key)) printf ("Reset setting '%s' successfully\n", key); else printf ("Setting '%s' not found\n", key); } else { g_assert_not_reached (); } } else { g_assert_not_reached (); } wp_core_sync (self->core, NULL, (GAsyncReadyCallback) async_quit, self); return; out: self->exit_code = 3; g_main_loop_quit (self->loop); } /* set-log-level */ static gboolean set_log_level_parse_positional (gint argc, gchar ** argv, GError **error) { if (argc == 4) { if (!spa_atou64 (argv[2], &cmdline.set_log_level.id, 10)) { g_set_error (error, wpctl_error_domain_quark(), 0, "failed to parse client id"); return FALSE; } cmdline.set_log_level.level = argv[3]; } else if (argc == 3) { cmdline.set_log_level.id = SPA_ID_INVALID; cmdline.set_log_level.level = argv[2]; } else { g_set_error (error, wpctl_error_domain_quark(), 0, "wrong number of arguments for set-log-level"); return FALSE; } if (spa_streq(cmdline.set_log_level.level, "-")) cmdline.set_log_level.level = NULL; return TRUE; } static gboolean set_log_level_prepare (WpCtl * self, GError ** error) { wp_object_manager_add_interest (self->om, WP_TYPE_METADATA, WP_CONSTRAINT_TYPE_PW_GLOBAL_PROPERTY, "metadata.name", "=s", "settings", NULL); wp_object_manager_add_interest (self->om, WP_TYPE_CLIENT, WP_CONSTRAINT_TYPE_PW_PROPERTY, "wireplumber.daemon", "+", NULL); wp_object_manager_request_object_features (self->om, WP_TYPE_METADATA, WP_OBJECT_FEATURES_ALL); wp_object_manager_request_object_features (self->om, WP_TYPE_CLIENT, WP_OBJECT_FEATURES_ALL); return TRUE; } static void set_log_level_run (WpCtl * self) { g_autoptr (WpPlugin) def_nodes_api = NULL; g_autoptr (GError) error = NULL; g_autoptr (WpIterator) client_it = NULL; g_auto (GValue) client_val = G_VALUE_INIT; g_autoptr (WpMetadata) settings = wp_object_manager_lookup (self->om, WP_TYPE_METADATA, NULL); if (!settings) { fprintf (stderr, "No settings metadata found\n"); goto out; } if (cmdline.set_log_level.id == SPA_ID_INVALID) client_it = wp_object_manager_new_filtered_iterator (self->om, WP_TYPE_CLIENT, NULL); if (client_it) { for (; wp_iterator_next (client_it, &client_val); g_value_unset (&client_val)) { WpPipewireObject *client = g_value_get_object (&client_val); guint32 client_id = wp_proxy_get_bound_id (WP_PROXY (client)); if (client_id == SPA_ID_INVALID) continue; wp_metadata_set (settings, client_id, "log.level", "", cmdline.set_log_level.level); } } else { wp_metadata_set (settings, cmdline.set_log_level.id, "log.level", "", cmdline.set_log_level.level); } wp_core_sync (self->core, NULL, (GAsyncReadyCallback) async_quit, self); return; out: self->exit_code = 3; g_main_loop_quit (self->loop); } #define N_ENTRIES 4 static const struct subcommand { /* the name to match on the command line */ const gchar *name; /* description of positional arguments, shown in the help message */ const gchar *positional_args; /* short description, shown at the top of the help message */ const gchar *summary; /* long description, shown at the bottom of the help message */ const gchar *description; /* additional cmdline arguments for this subcommand */ const GOptionEntry entries[N_ENTRIES]; /* function to parse positional arguments */ gboolean (*parse_positional) (gint, gchar **, GError **); /* function to prepare the object manager */ gboolean (*prepare) (WpCtl *, GError **); /* function to run after the object manager is installed */ void (*run) (WpCtl *); } subcommands[] = { { .name = "status", .positional_args = "", .summary = "Displays the current state of objects in PipeWire", .description = NULL, .entries = { { "nick", 'k', G_OPTION_FLAG_NONE, G_OPTION_ARG_NONE, &cmdline.status.display_nicknames, "Display device and node nicknames instead of descriptions", NULL }, { "name", 'n', G_OPTION_FLAG_NONE, G_OPTION_ARG_NONE, &cmdline.status.display_names, "Display device and node names instead of descriptions", NULL }, { NULL } }, .parse_positional = NULL, .prepare = status_prepare, .run = status_run, }, { .name = "get-volume", .positional_args = "ID", .summary = "Displays volume information about the specified node in PipeWire", .description = NULL, .entries = { { NULL } }, .parse_positional = get_volume_parse_positional, .prepare = get_volume_prepare, .run = get_volume_run, }, { .name = "inspect", .positional_args = "ID", .summary = "Displays information about the specified object", .description = NULL, .entries = { { "referenced", 'r', G_OPTION_FLAG_NONE, G_OPTION_ARG_NONE, &cmdline.inspect.show_referenced, "Show objects that are referenced in properties", NULL }, { "associated", 'a', G_OPTION_FLAG_NONE, G_OPTION_ARG_NONE, &cmdline.inspect.show_associated, "Show associated objects", NULL }, { NULL } }, .parse_positional = inspect_parse_positional, .prepare = inspect_prepare, .run = inspect_run, }, { .name = "set-default", .positional_args = "ID", .summary = "Sets ID to be the default object of its kind " "(capture/playback) in its session", .description = NULL, .entries = { { NULL } }, .parse_positional = set_default_parse_positional, .prepare = set_default_prepare, .run = set_default_run, }, { .name = "set-volume", .positional_args = "ID VOL[%][-/+]", .summary = "Sets the volume of ID from specified argument. (floating point, 1.0 is 100%)\n" " VOL%[-/+] - Step up/down volume by specified percent (Example: 0.5%+)\n" " VOL[-/+] - Step up/down volume by specified value (Example: 0.5+)\n" " VOL - Set volume as the specified value (Example: 0.5)", .description = NULL, .entries = { { "pid", 'p', G_OPTION_FLAG_NONE, G_OPTION_ARG_NONE, &cmdline.set_volume.is_pid, "Selects all nodes associated to the given PID number", NULL }, { "limit", 'l', G_OPTION_FLAG_NONE, G_OPTION_ARG_DOUBLE, &cmdline.set_volume.limit, "Limits the final volume percentage to below this value. (floating point, 1.0 is 100%)", NULL }, { NULL } }, .parse_positional = set_volume_parse_positional, .prepare = set_volume_prepare, .run = set_volume_run, }, { .name = "set-mute", .positional_args = "ID 1|0|toggle", .summary = "Changes the mute state of ID", .description = NULL, .entries = { { "pid", 'p', G_OPTION_FLAG_NONE, G_OPTION_ARG_NONE, &cmdline.set_mute.is_pid, "Selects all nodes associated to the given PID number", NULL }, { NULL } }, .parse_positional = set_mute_parse_positional, .prepare = set_mute_prepare, .run = set_mute_run, }, { .name = "set-profile", .positional_args = "ID INDEX", .summary = "Sets the profile of ID to INDEX (integer, 0 is 'off')", .description = NULL, .entries = { { NULL } }, .parse_positional = set_profile_parse_positional, .prepare = set_profile_prepare, .run = set_profile_run, }, { .name = "set-route", .positional_args = "ID INDEX", .summary = "Sets the route of ID to INDEX (integer, 0 is 'off')", .description = NULL, .entries = { { NULL } }, .parse_positional = set_route_parse_positional, .prepare = set_route_prepare, .run = set_route_run, }, { .name = "clear-default", .positional_args = "[ID]", .summary = "Clears the default configured node (no ID means 'all')", .description = NULL, .entries = { { NULL } }, .parse_positional = clear_default_parse_positional, .prepare = clear_default_prepare, .run = clear_default_run, }, { .name = "settings", .positional_args = "[KEY] [VAL]", .summary = "Shows, changes or removes settings", .description = NULL, .entries = { { "delete", 'd', G_OPTION_FLAG_NONE, G_OPTION_ARG_NONE, &cmdline.settings.delete, "Deletes the saved setting value (no KEY means 'all')", NULL }, { "save", 's', G_OPTION_FLAG_NONE, G_OPTION_ARG_NONE, &cmdline.settings.save, "Saves the setting value (no KEY means 'all', no VAL means current value)", NULL }, { "reset", 'r', G_OPTION_FLAG_NONE, G_OPTION_ARG_NONE, &cmdline.settings.reset, "Resets the saved setting to its default value", NULL }, { NULL } }, .parse_positional = settings_parse_positional, .prepare = settings_prepare, .run = settings_run, }, { .name = "set-log-level", .positional_args = "[ID] LEVEL", .summary = "Sets the log level of a client (no ID means Wireplumber, 0 means Pipewire server)", .description = NULL, .entries = { { NULL } }, .parse_positional = set_log_level_parse_positional, .prepare = set_log_level_prepare, .run = set_log_level_run, } }; static void on_settings_activated (WpSettings *s, GAsyncResult *res, WpCtl *ctl) { GError *error = NULL; if (!wp_object_activate_finish (WP_OBJECT (s), res, &error)) { fprintf (stderr, "%s\n", error->message); ctl->exit_code = 1; g_main_loop_quit (ctl->loop); return; } wp_core_register_object (ctl->core, g_object_ref (s)); } static void on_plugin_loaded (WpCore * core, GAsyncResult * res, WpCtl *ctl) { GError *error = NULL; if (!wp_core_load_component_finish (core, res, &error)) { fprintf (stderr, "%s\n", error->message); ctl->exit_code = 1; g_main_loop_quit (ctl->loop); return; } if (--ctl->pending_plugins == 0) { g_autoptr (WpPlugin) mixer_api = wp_plugin_find (core, "mixer-api"); g_object_set (mixer_api, "scale", 1 /* cubic */, NULL); wp_core_install_object_manager (ctl->core, ctl->om); } } gint main (gint argc, gchar **argv) { g_auto (WpCtl) ctl = {0}; const struct subcommand *cmd = NULL; g_autoptr (GError) error = NULL; g_autofree gchar *summary = NULL; g_autoptr (WpSettings) settings = NULL; setlocale (LC_ALL, ""); setlocale (LC_NUMERIC, "C"); wp_init (WP_INIT_ALL); ctl.context = g_option_context_new ( "COMMAND [COMMAND_OPTIONS] - WirePlumber Control CLI"); ctl.loop = g_main_loop_new (NULL, FALSE); ctl.core = wp_core_new (NULL, NULL, NULL); ctl.om = wp_object_manager_new (); /* find the subcommand */ if (argc > 1) { for (guint i = 0; i < G_N_ELEMENTS (subcommands); i++) { if (!g_strcmp0 (argv[1], subcommands[i].name)) { cmd = &subcommands[i]; break; } } } /* prepare the subcommand options */ if (cmd) { GOptionGroup *group; /* options */ group = g_option_group_new (cmd->name, NULL, NULL, &ctl, NULL); g_option_group_add_entries (group, cmd->entries); g_option_context_set_main_group (ctl.context, group); /* summary */ summary = g_strdup_printf ("Command: %s %s\n %s", cmd->name, cmd->positional_args, cmd->summary); g_option_context_set_summary (ctl.context, summary); /* description */ if (cmd->description) g_option_context_set_description (ctl.context, cmd->description); } else { /* build the generic summary */ GString *summary_str = g_string_new ("Commands:"); for (guint i = 0; i < G_N_ELEMENTS (subcommands); i++) { g_string_append_printf (summary_str, "\n %s %s", subcommands[i].name, subcommands[i].positional_args); } summary = g_string_free (summary_str, FALSE); g_option_context_set_summary (ctl.context, summary); g_option_context_set_description (ctl.context, "Pass -h after a command " "to see command-specific options\n"); } /* parse options */ if (!g_option_context_parse (ctl.context, &argc, &argv, &error) || (cmd && cmd->parse_positional && !cmd->parse_positional (argc, argv, &error))) { fprintf (stderr, "Error: %s\n\n", error->message); cmd = NULL; } /* no active subcommand, show usage and exit */ if (!cmd) { g_autofree gchar *help = g_option_context_get_help (ctl.context, FALSE, NULL); printf ("%s", help); return 1; } /* prepare the subcommand */ if (!cmd->prepare (&ctl, &error)) { fprintf (stderr, "%s\n", error->message); return 1; } /* load and register settings */ settings = wp_settings_new (ctl.core, NULL); wp_object_activate (WP_OBJECT (settings), WP_OBJECT_FEATURES_ALL, NULL, (GAsyncReadyCallback)on_settings_activated, &ctl); /* load required API modules */ ctl.pending_plugins++; wp_core_load_component (ctl.core, "libwireplumber-module-default-nodes-api", "module", NULL, NULL, NULL, (GAsyncReadyCallback) on_plugin_loaded, &ctl); ctl.pending_plugins++; wp_core_load_component (ctl.core, "libwireplumber-module-mixer-api", "module", NULL, NULL, NULL, (GAsyncReadyCallback) on_plugin_loaded, &ctl); /* connect */ if (!wp_core_connect (ctl.core)) { fprintf (stderr, "Could not connect to PipeWire\n"); return 2; } /* run */ g_signal_connect_swapped (ctl.core, "disconnected", (GCallback) g_main_loop_quit, ctl.loop); g_signal_connect_swapped (ctl.om, "installed", (GCallback) cmd->run, &ctl); g_main_loop_run (ctl.loop); return ctl.exit_code; }