Debian Codegraph @

modules/module-default-nodes-api.c

raw
1 /* WirePlumber
2 *
3 * Copyright © 2021 Collabora Ltd.
4 * @author George Kiagiadakis <[email protected]>
5 *
6 * SPDX-License-Identifier: MIT
7 */
8
9 #include <wp/wp.h>
10 #include <spa/utils/defs.h>
11 #include <pipewire/keys.h>
12
13 WP_DEFINE_LOCAL_LOG_TOPIC ("m-default-nodes-api")
14
15 /*
16 * Module Provides the APIs to query the default device nodes. Module looks at
17 * the default metadata to know the default devices.
18 */
19
20 enum {
21 AUDIO_SINK,
22 AUDIO_SOURCE,
23 VIDEO_SOURCE,
24 N_DEFAULT_NODES
25 };
26
27 static const gchar * DEFAULT_KEY[N_DEFAULT_NODES] = {
28 [AUDIO_SINK] = "default.audio.sink",
29 [AUDIO_SOURCE] = "default.audio.source",
30 [VIDEO_SOURCE] = "default.video.source",
31 };
32
33 static const gchar * NODE_TYPE_STR[N_DEFAULT_NODES] = {
34 [AUDIO_SINK] = "Audio/Sink",
35 [AUDIO_SOURCE] = "Audio/Source",
36 [VIDEO_SOURCE] = "Video/Source",
37 };
38
39 static const gchar * DEFAULT_CONFIG_KEY[N_DEFAULT_NODES] = {
40 [AUDIO_SINK] = "default.configured.audio.sink",
41 [AUDIO_SOURCE] = "default.configured.audio.source",
42 [VIDEO_SOURCE] = "default.configured.video.source",
43 };
44
45
46 typedef struct _WpDefaultNode WpDefaultNode;
47 struct _WpDefaultNode
48 {
49 gchar *value;
50 gchar *config_value;
51 };
52
53 struct _WpDefaultNodesApi
54 {
55 WpPlugin parent;
56
57 WpDefaultNode defaults[N_DEFAULT_NODES];
58 WpObjectManager *om;
59 };
60
61 enum {
62 ACTION_GET_DEFAULT_NODE,
63 ACTION_GET_DEFAULT_CONFIGURED_NODE_NAME,
64 ACTION_SET_DEFAULT_CONFIGURED_NODE_NAME,
65 SIGNAL_CHANGED,
66 N_SIGNALS
67 };
68
69 static guint signals[N_SIGNALS] = {0};
70
71 G_DECLARE_FINAL_TYPE (WpDefaultNodesApi, wp_default_nodes_api,
72 WP, DEFAULT_NODES_API, WpPlugin)
73 G_DEFINE_TYPE (WpDefaultNodesApi, wp_default_nodes_api, WP_TYPE_PLUGIN)
74
75 static void
76 wp_default_nodes_api_init (WpDefaultNodesApi * self)
77 {
78 }
79
80 static void
81 sync_changed_notification (WpCore * core, GAsyncResult * res,
82 WpDefaultNodesApi * self)
83 {
84 g_autoptr (GError) error = NULL;
85 if (!wp_core_sync_finish (core, res, &error)) {
86 wp_warning_object (self, "core sync error: %s", error->message);
87 return;
88 }
89
90 g_signal_emit (self, signals[SIGNAL_CHANGED], 0);
91 return;
92 }
93
94 static void
95 schedule_changed_notification (WpDefaultNodesApi *self)
96 {
97 g_autoptr (WpCore) core = wp_object_get_core (WP_OBJECT (self));
98 g_return_if_fail (core);
99 wp_core_sync_closure (core, NULL, g_cclosure_new_object (
100 G_CALLBACK (sync_changed_notification), G_OBJECT (self)));
101 }
102
103 static void
104 on_metadata_changed (WpMetadata *m, guint32 subject,
105 const gchar *key, const gchar *type, const gchar *value, gpointer d)
106 {
107 WpDefaultNodesApi * self = WP_DEFAULT_NODES_API (d);
108 gchar *new_value = NULL;
109
110 if (subject != 0)
111 return;
112
113 for (gint i = 0; i < N_DEFAULT_NODES; i++) {
114 if (!g_strcmp0 (key, DEFAULT_KEY[i])) {
115
116 if (value && !g_strcmp0 (type, "Spa:String:JSON")) {
117 g_autoptr (WpSpaJson) json = wp_spa_json_new_wrap_string (value);
118 wp_spa_json_object_get (json, "name", "s", &new_value, NULL);
119 }
120
121 wp_debug_object (m, "'%s' changed from '%s' -> '%s'", key,
122 self->defaults[i].value, new_value);
123
124 g_clear_pointer (&self->defaults[i].value, g_free);
125 self->defaults[i].value = new_value;
126
127 schedule_changed_notification (self);
128 break;
129 } else if (!g_strcmp0 (key, DEFAULT_CONFIG_KEY[i])) {
130
131 if (value && !g_strcmp0 (type, "Spa:String:JSON")) {
132 g_autoptr (WpSpaJson) json = wp_spa_json_new_wrap_string (value);
133 wp_spa_json_object_get (json, "name", "s", &new_value, NULL);
134 }
135
136 wp_debug_object (m, "'%s' changed from '%s' -> '%s'", key,
137 self->defaults[i].config_value, new_value);
138
139 g_clear_pointer (&self->defaults[i].config_value, g_free);
140 self->defaults[i].config_value = new_value;
141
142 break;
143 }
144 }
145 }
146
147 static void
148 on_metadata_added (WpObjectManager *om, WpObject *obj, WpDefaultNodesApi * self)
149 {
150 if (WP_IS_METADATA (obj)) {
151 g_autoptr (WpIterator) it = wp_metadata_new_iterator (WP_METADATA (obj), 0);
152 g_auto (GValue) val = G_VALUE_INIT;
153
154 for (; wp_iterator_next (it, &val); g_value_unset (&val)) {
155 WpMetadataItem *mi = g_value_get_boxed (&val);
156 guint32 subject = wp_metadata_item_get_subject (mi);
157 const gchar *key = wp_metadata_item_get_key (mi);
158 const gchar *type = wp_metadata_item_get_value_type (mi);
159 const gchar *value = wp_metadata_item_get_value (mi);
160 on_metadata_changed (WP_METADATA (obj), subject, key, type, value, self);
161 }
162
163 g_signal_connect_object (obj, "changed",
164 G_CALLBACK (on_metadata_changed), self, 0);
165 }
166 }
167
168 static void
169 on_om_installed (WpObjectManager * om, WpDefaultNodesApi * self)
170 {
171 wp_object_update_features (WP_OBJECT (self), WP_PLUGIN_FEATURE_ENABLED, 0);
172 }
173
174 static void
175 wp_default_nodes_api_enable (WpPlugin * plugin, WpTransition * transition)
176 {
177 WpDefaultNodesApi * self = WP_DEFAULT_NODES_API (plugin);
178 g_autoptr (WpCore) core = wp_object_get_core (WP_OBJECT (plugin));
179 g_return_if_fail (core);
180
181 /* Create the metadata object manager */
182 self->om = wp_object_manager_new ();
183 wp_object_manager_add_interest (self->om, WP_TYPE_METADATA,
184 WP_CONSTRAINT_TYPE_PW_GLOBAL_PROPERTY, "metadata.name", "=s", "default",
185 NULL);
186 wp_object_manager_add_interest (self->om, WP_TYPE_NODE, NULL);
187 wp_object_manager_request_object_features (self->om,
188 WP_TYPE_METADATA, WP_OBJECT_FEATURES_ALL);
189 wp_object_manager_request_object_features (self->om,
190 WP_TYPE_NODE, WP_PIPEWIRE_OBJECT_FEATURES_MINIMAL);
191 g_signal_connect_object (self->om, "object-added",
192 G_CALLBACK (on_metadata_added), self, 0);
193 g_signal_connect_object (self->om, "installed",
194 G_CALLBACK (on_om_installed), self, 0);
195 wp_core_install_object_manager (core, self->om);
196 }
197
198 static void
199 wp_default_nodes_api_disable (WpPlugin * plugin)
200 {
201 WpDefaultNodesApi * self = WP_DEFAULT_NODES_API (plugin);
202
203 for (guint i = 0; i < N_DEFAULT_NODES; i++) {
204 g_clear_pointer (&self->defaults[i].value, g_free);
205 g_clear_pointer (&self->defaults[i].config_value, g_free);
206 }
207 g_clear_object (&self->om);
208 }
209
210 static guint
211 wp_default_nodes_api_get_default_node (WpDefaultNodesApi * self,
212 const gchar * media_class)
213 {
214 gint node_t = -1;
215 for (gint i = 0; i < N_DEFAULT_NODES; i++) {
216 if (!g_strcmp0 (media_class, NODE_TYPE_STR[i])) {
217 node_t = i;
218 break;
219 }
220 }
221
222 if (node_t != -1 && self->defaults[node_t].value) {
223 g_autoptr (WpIterator) it = NULL;
224 g_auto (GValue) val = G_VALUE_INIT;
225 it = wp_object_manager_new_filtered_iterator (self->om,
226 WP_TYPE_NODE,
227 WP_CONSTRAINT_TYPE_PW_PROPERTY,
228 PW_KEY_NODE_NAME, "=s", self->defaults[node_t].value,
229 NULL);
230 for (; wp_iterator_next (it, &val); g_value_unset (&val)) {
231 WpNode *node = g_value_get_object (&val);
232 const gchar *mc = wp_pipewire_object_get_property (
233 WP_PIPEWIRE_OBJECT (node), PW_KEY_MEDIA_CLASS);
234 if (!g_str_has_prefix (mc, "Stream/"))
235 return wp_proxy_get_bound_id (WP_PROXY (node));
236 }
237 }
238 return SPA_ID_INVALID;
239 }
240
241 static gchar *
242 wp_default_nodes_api_get_default_configured_node_name (WpDefaultNodesApi * self,
243 const gchar * media_class)
244 {
245 for (gint i = 0; i < N_DEFAULT_NODES; i++)
246 if (!g_strcmp0 (media_class, NODE_TYPE_STR[i]) &&
247 self->defaults[i].config_value)
248 return g_strdup (self->defaults[i].config_value);
249
250 return NULL;
251 }
252
253 static gboolean
254 wp_default_nodes_api_set_default_configured_node_name (WpDefaultNodesApi * self,
255 const gchar * media_class, const gchar * name)
256 {
257 g_autoptr (WpMetadata) m = wp_object_manager_lookup (self->om,
258 WP_TYPE_METADATA, NULL);
259 if (!m)
260 return FALSE;
261
262 for (gint i = 0; i < N_DEFAULT_NODES; i++) {
263 if (!g_strcmp0 (media_class, NODE_TYPE_STR[i])) {
264 if (name) {
265 g_autofree gchar *v = g_strdup_printf ("{ \"name\": \"%s\" }", name);
266 wp_metadata_set (m, 0, DEFAULT_CONFIG_KEY[i], "Spa:String:JSON", v);
267 } else {
268 wp_metadata_set (m, 0, DEFAULT_CONFIG_KEY[i], NULL, NULL);
269 }
270 return TRUE;
271 }
272 }
273
274 return FALSE;
275 }
276
277 static void
278 wp_default_nodes_api_class_init (WpDefaultNodesApiClass * klass)
279 {
280 WpPluginClass *plugin_class = (WpPluginClass *) klass;
281
282 plugin_class->enable = wp_default_nodes_api_enable;
283 plugin_class->disable = wp_default_nodes_api_disable;
284
285 signals[ACTION_GET_DEFAULT_NODE] = g_signal_new_class_handler (
286 "get-default-node", G_TYPE_FROM_CLASS (klass),
287 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
288 (GCallback) wp_default_nodes_api_get_default_node,
289 NULL, NULL, NULL,
290 G_TYPE_UINT, 1, G_TYPE_STRING);
291
292 signals[ACTION_GET_DEFAULT_CONFIGURED_NODE_NAME] = g_signal_new_class_handler (
293 "get-default-configured-node-name", G_TYPE_FROM_CLASS (klass),
294 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
295 (GCallback) wp_default_nodes_api_get_default_configured_node_name,
296 NULL, NULL, NULL,
297 G_TYPE_STRING, 1, G_TYPE_STRING);
298
299 signals[ACTION_SET_DEFAULT_CONFIGURED_NODE_NAME] = g_signal_new_class_handler (
300 "set-default-configured-node-name", G_TYPE_FROM_CLASS (klass),
301 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
302 (GCallback) wp_default_nodes_api_set_default_configured_node_name,
303 NULL, NULL, NULL,
304 G_TYPE_BOOLEAN, 2, G_TYPE_STRING, G_TYPE_STRING);
305
306 signals[SIGNAL_CHANGED] = g_signal_new (
307 "changed", G_TYPE_FROM_CLASS (klass),
308 G_SIGNAL_RUN_LAST, 0, NULL, NULL, NULL, G_TYPE_NONE, 0);
309 }
310
311 WP_PLUGIN_EXPORT GObject *
312 wireplumber__module_init (WpCore * core, WpSpaJson * args, GError ** error)
313 {
314 return G_OBJECT (g_object_new (wp_default_nodes_api_get_type (),
315 "name", "default-nodes-api",
316 "core", core,
317 NULL));
318 }