1 /* GStreamer command line device monitor testing utility
2 * Copyright (C) 2014 Tim-Philipp Müller <tim@centricular.com>
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
13 *
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
17 * Boston, MA 02110-1301, USA.
18 */
19
20 #ifdef HAVE_CONFIG_H
21 #include "config.h"
22 #endif
23
24 #include <locale.h>
25
26 #include <gst/gst.h>
27 #include <gst/gst-i18n-app.h>
28 #include <gst/math-compat.h>
29 #include <stdlib.h>
30 #include <stdio.h>
31 #include <string.h>
32
33 GST_DEBUG_CATEGORY (devmon_debug);
34 #define GST_CAT_DEFAULT devmon_debug
35
36 typedef struct
37 {
38 GMainLoop *loop;
39 GstDeviceMonitor *monitor;
40 guint bus_watch_id;
41 } DevMonApp;
42
43 static gboolean bus_msg_handler (GstBus * bus, GstMessage * msg, gpointer data);
44
45 static gchar *
get_launch_line(GstDevice * device)46 get_launch_line (GstDevice * device)
47 {
48 static const char *const ignored_propnames[] =
49 { "name", "parent", "direction", "template", "caps", NULL };
50 GString *launch_line;
51 GstElement *element;
52 GstElement *pureelement;
53 GParamSpec **properties, *property;
54 GValue value = G_VALUE_INIT;
55 GValue pvalue = G_VALUE_INIT;
56 guint i, number_of_properties;
57 GstElementFactory *factory;
58
59 element = gst_device_create_element (device, NULL);
60
61 if (!element)
62 return NULL;
63
64 factory = gst_element_get_factory (element);
65 if (!factory) {
66 gst_object_unref (element);
67 return NULL;
68 }
69
70 if (!gst_plugin_feature_get_name (factory)) {
71 gst_object_unref (element);
72 return NULL;
73 }
74
75 launch_line = g_string_new (gst_plugin_feature_get_name (factory));
76
77 pureelement = gst_element_factory_create (factory, NULL);
78
79 /* get paramspecs and show non-default properties */
80 properties =
81 g_object_class_list_properties (G_OBJECT_GET_CLASS (element),
82 &number_of_properties);
83 if (properties) {
84 for (i = 0; i < number_of_properties; i++) {
85 gint j;
86 gboolean ignore = FALSE;
87 property = properties[i];
88
89 /* skip some properties */
90 if ((property->flags & G_PARAM_READWRITE) != G_PARAM_READWRITE)
91 continue;
92
93 for (j = 0; ignored_propnames[j]; j++)
94 if (!g_strcmp0 (ignored_propnames[j], property->name))
95 ignore = TRUE;
96
97 if (ignore)
98 continue;
99
100 /* Can't use _param_value_defaults () because sub-classes modify the
101 * values already.
102 */
103
104 g_value_init (&value, property->value_type);
105 g_value_init (&pvalue, property->value_type);
106 g_object_get_property (G_OBJECT (element), property->name, &value);
107 g_object_get_property (G_OBJECT (pureelement), property->name, &pvalue);
108 if (gst_value_compare (&value, &pvalue) != GST_VALUE_EQUAL) {
109 gchar *valuestr = gst_value_serialize (&value);
110
111 if (!valuestr) {
112 GST_WARNING ("Could not serialize property %s:%s",
113 GST_OBJECT_NAME (element), property->name);
114 g_free (valuestr);
115 goto next;
116 }
117
118 g_string_append_printf (launch_line, " %s=%s",
119 property->name, valuestr);
120 g_free (valuestr);
121
122 }
123
124 next:
125 g_value_unset (&value);
126 g_value_unset (&pvalue);
127 }
128 g_free (properties);
129 }
130
131 gst_object_unref (element);
132 gst_object_unref (pureelement);
133
134 return g_string_free (launch_line, FALSE);
135 }
136
137
138 static gboolean
print_structure_field(GQuark field_id,const GValue * value,gpointer user_data)139 print_structure_field (GQuark field_id, const GValue * value,
140 gpointer user_data)
141 {
142 gchar *val;
143
144 if (G_VALUE_HOLDS_UINT (value)) {
145 val = g_strdup_printf ("%u (0x%08x)", g_value_get_uint (value),
146 g_value_get_uint (value));
147 } else {
148 val = gst_value_serialize (value);
149 }
150
151 if (val != NULL)
152 g_print ("\n\t\t%s = %s", g_quark_to_string (field_id), val);
153 else
154 g_print ("\n\t\t%s - could not serialise field of type %s",
155 g_quark_to_string (field_id), G_VALUE_TYPE_NAME (value));
156
157 g_free (val);
158
159 return TRUE;
160 }
161
162 static void
print_device(GstDevice * device,gboolean modified)163 print_device (GstDevice * device, gboolean modified)
164 {
165 gchar *device_class, *str, *name;
166 GstCaps *caps;
167 GstStructure *props;
168 guint i, size = 0;
169
170 caps = gst_device_get_caps (device);
171 if (caps != NULL)
172 size = gst_caps_get_size (caps);
173
174 name = gst_device_get_display_name (device);
175 device_class = gst_device_get_device_class (device);
176 props = gst_device_get_properties (device);
177
178 g_print ("\nDevice %s:\n\n", modified ? "modified" : "found");
179 g_print ("\tname : %s\n", name);
180 g_print ("\tclass : %s\n", device_class);
181 for (i = 0; i < size; ++i) {
182 GstStructure *s = gst_caps_get_structure (caps, i);
183 str = gst_structure_to_string (s);
184 g_print ("\t%s %s\n", (i == 0) ? "caps :" : " ", str);
185 g_free (str);
186 }
187 if (props) {
188 g_print ("\tproperties:");
189 gst_structure_foreach (props, print_structure_field, NULL);
190 gst_structure_free (props);
191 g_print ("\n");
192 }
193 str = get_launch_line (device);
194 if (gst_device_has_classes (device, "Source"))
195 g_print ("\tgst-launch-1.0 %s ! ...\n", str);
196 if (gst_device_has_classes (device, "Sink"))
197 g_print ("\tgst-launch-1.0 ... ! %s\n", str);
198 g_free (str);
199 g_print ("\n");
200
201 g_free (name);
202 g_free (device_class);
203
204 if (caps != NULL)
205 gst_caps_unref (caps);
206 }
207
208 static void
device_removed(GstDevice * device)209 device_removed (GstDevice * device)
210 {
211 gchar *name;
212
213 name = gst_device_get_display_name (device);
214
215 g_print ("Device removed:\n");
216 g_print ("\tname : %s\n", name);
217
218 g_free (name);
219 }
220
221 static gboolean
bus_msg_handler(GstBus * bus,GstMessage * msg,gpointer user_data)222 bus_msg_handler (GstBus * bus, GstMessage * msg, gpointer user_data)
223 {
224 GstDevice *device;
225
226 switch (GST_MESSAGE_TYPE (msg)) {
227 case GST_MESSAGE_DEVICE_ADDED:
228 gst_message_parse_device_added (msg, &device);
229 print_device (device, FALSE);
230 gst_object_unref (device);
231 break;
232 case GST_MESSAGE_DEVICE_REMOVED:
233 gst_message_parse_device_removed (msg, &device);
234 device_removed (device);
235 gst_object_unref (device);
236 break;
237 case GST_MESSAGE_DEVICE_CHANGED:
238 gst_message_parse_device_changed (msg, &device, NULL);
239 print_device (device, TRUE);
240 gst_object_unref (device);
241 break;
242 default:
243 g_print ("%s message\n", GST_MESSAGE_TYPE_NAME (msg));
244 break;
245 }
246
247 return TRUE;
248 }
249
250 int
main(int argc,char ** argv)251 main (int argc, char **argv)
252 {
253 gboolean print_version = FALSE;
254 GError *err = NULL;
255 gchar **arg, **args = NULL;
256 gboolean follow = FALSE;
257 GOptionContext *ctx;
258 GOptionEntry options[] = {
259 {"version", 0, 0, G_OPTION_ARG_NONE, &print_version,
260 N_("Print version information and exit"), NULL},
261 {"follow", 'f', 0, G_OPTION_ARG_NONE, &follow,
262 N_("Don't exit after showing the initial device list, but wait "
263 "for devices to added/removed."), NULL},
264 {G_OPTION_REMAINING, 0, 0, G_OPTION_ARG_STRING_ARRAY, &args, NULL},
265 {NULL}
266 };
267 GTimer *timer;
268 DevMonApp app;
269 GstBus *bus;
270 GList *devices;
271
272 setlocale (LC_ALL, "");
273
274 #ifdef ENABLE_NLS
275 bindtextdomain (GETTEXT_PACKAGE, LOCALEDIR);
276 bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
277 textdomain (GETTEXT_PACKAGE);
278 #endif
279
280 g_set_prgname ("gst-device-monitor-" GST_API_VERSION);
281
282 ctx = g_option_context_new ("[DEVICE_CLASSES[:FILTER_CAPS]] "
283 "[DEVICE_CLASSES[:FILTER_CAPS]] …");
284 g_option_context_add_main_entries (ctx, options, GETTEXT_PACKAGE);
285 g_option_context_add_group (ctx, gst_init_get_option_group ());
286 if (!g_option_context_parse (ctx, &argc, &argv, &err)) {
287 g_print ("Error initializing: %s\n", GST_STR_NULL (err->message));
288 g_option_context_free (ctx);
289 g_clear_error (&err);
290 return 1;
291 }
292 g_option_context_free (ctx);
293
294 GST_DEBUG_CATEGORY_INIT (devmon_debug, "device-monitor", 0,
295 "gst-device-monitor");
296
297 if (print_version) {
298 gchar *version_str;
299
300 version_str = gst_version_string ();
301 g_print ("%s version %s\n", g_get_prgname (), PACKAGE_VERSION);
302 g_print ("%s\n", version_str);
303 g_print ("%s\n", GST_PACKAGE_ORIGIN);
304 g_free (version_str);
305
306 return 0;
307 }
308
309 app.loop = g_main_loop_new (NULL, FALSE);
310 app.monitor = gst_device_monitor_new ();
311
312 bus = gst_device_monitor_get_bus (app.monitor);
313 app.bus_watch_id = gst_bus_add_watch (bus, bus_msg_handler, &app);
314 gst_object_unref (bus);
315
316 /* process optional remaining arguments in the form
317 * DEVICE_CLASSES or DEVICE_CLASSES:FILTER_CAPS */
318 for (arg = args; arg != NULL && *arg != NULL; ++arg) {
319 gchar **filters = g_strsplit (*arg, ":", -1);
320 if (filters != NULL && filters[0] != NULL) {
321 GstCaps *caps = NULL;
322
323 if (filters[1] != NULL) {
324 caps = gst_caps_from_string (filters[1]);
325 if (caps == NULL)
326 g_warning ("Couldn't parse device filter caps '%s'", filters[1]);
327 }
328 gst_device_monitor_add_filter (app.monitor, filters[0], caps);
329 if (caps)
330 gst_caps_unref (caps);
331 g_strfreev (filters);
332 }
333 }
334 g_strfreev (args);
335
336 g_print ("Probing devices...\n\n");
337
338 timer = g_timer_new ();
339
340 if (!gst_device_monitor_start (app.monitor)) {
341 g_printerr ("Failed to start device monitor!\n");
342 return -1;
343 }
344
345 GST_INFO ("Took %.2f seconds", g_timer_elapsed (timer, NULL));
346
347 devices = gst_device_monitor_get_devices (app.monitor);
348 if (devices != NULL) {
349 while (devices != NULL) {
350 GstDevice *device = devices->data;
351
352 print_device (device, FALSE);
353 gst_object_unref (device);
354 devices = g_list_delete_link (devices, devices);
355 }
356 } else {
357 g_print ("No devices found!\n");
358 }
359
360 if (follow) {
361 g_print ("Monitoring devices, waiting for devices to be removed or "
362 "new devices to be added...\n");
363 g_main_loop_run (app.loop);
364 }
365
366 gst_device_monitor_stop (app.monitor);
367 gst_object_unref (app.monitor);
368
369 g_source_remove (app.bus_watch_id);
370 g_main_loop_unref (app.loop);
371 g_timer_destroy (timer);
372
373 return 0;
374 }
375