tools/gst-device-monitor.c

   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 *
  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
 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 gboolean
 163 print_field (GQuark field, const GValue * value, gpointer unused)
 164 {
 165   gchar *str = gst_value_serialize (value);
 166
 167   g_print (", %s=%s", g_quark_to_string (field), str);
 168   g_free (str);
 169   return TRUE;
 170 }
 171
 172 static void
 173 print_device (GstDevice * device, gboolean modified)
 174 {
 175   gchar *device_class, *str, *name;
 176   GstCaps *caps;
 177   GstStructure *props;
 178   guint i, size = 0;
 179
 180   caps = gst_device_get_caps (device);
 181   if (caps != NULL)
 182     size = gst_caps_get_size (caps);
 183
 184   name = gst_device_get_display_name (device);
 185   device_class = gst_device_get_device_class (device);
 186   props = gst_device_get_properties (device);
 187
 188   g_print ("\nDevice %s:\n\n", modified ? "modified" : "found");
 189   g_print ("\tname  : %s\n", name);
 190   g_print ("\tclass : %s\n", device_class);
 191   for (i = 0; i < size; ++i) {
 192     GstStructure *s = gst_caps_get_structure (caps, i);
 193     GstCapsFeatures *features = gst_caps_get_features (caps, i);
 194
 195     g_print ("\t%s %s", (i == 0) ? "caps  :" : "       ",
 196         gst_structure_get_name (s));
 197     if (features && (gst_caps_features_is_any (features) ||
 198             !gst_caps_features_is_equal (features,
 199                 GST_CAPS_FEATURES_MEMORY_SYSTEM_MEMORY))) {
 200       gchar *features_string = gst_caps_features_to_string (features);
 201
 202       g_print ("(%s)", features_string);
 203       g_free (features_string);
 204     }
 205     gst_structure_foreach (s, print_field, NULL);
 206     g_print ("\n");
 207   }
 208   if (props) {
 209     g_print ("\tproperties:");
 210     gst_structure_foreach (props, print_structure_field, NULL);
 211     gst_structure_free (props);
 212     g_print ("\n");
 213   }
 214   str = get_launch_line (device);
 215   if (gst_device_has_classes (device, "Source"))
 216     g_print ("\tgst-launch-1.0 %s ! ...\n", str);
 217   else if (gst_device_has_classes (device, "Sink"))
 218     g_print ("\tgst-launch-1.0 ... ! %s\n", str);
 219   else if (gst_device_has_classes (device, "CameraSource")) {
 220     g_print ("\tgst-launch-1.0 %s.vfsrc name=camerasrc ! ... "
 221         "camerasrc.vidsrc ! [video/x-h264] ... \n", str);
 222   }
 223
 224   g_free (str);
 225   g_print ("\n");
 226
 227   g_free (name);
 228   g_free (device_class);
 229
 230   if (caps != NULL)
 231     gst_caps_unref (caps);
 232 }
 233
 234 static void
 235 device_removed (GstDevice * device)
 236 {
 237   gchar *name;
 238
 239   name = gst_device_get_display_name (device);
 240
 241   g_print ("Device removed:\n");
 242   g_print ("\tname  : %s\n", name);
 243
 244   g_free (name);
 245 }
 246
 247 static gboolean
 248 bus_msg_handler (GstBus * bus, GstMessage * msg, gpointer user_data)
 249 {
 250   GstDevice *device;
 251
 252   switch (GST_MESSAGE_TYPE (msg)) {
 253     case GST_MESSAGE_DEVICE_ADDED:
 254       gst_message_parse_device_added (msg, &device);
 255       print_device (device, FALSE);
 256       gst_object_unref (device);
 257       break;
 258     case GST_MESSAGE_DEVICE_REMOVED:
 259       gst_message_parse_device_removed (msg, &device);
 260       device_removed (device);
 261       gst_object_unref (device);
 262       break;
 263     case GST_MESSAGE_DEVICE_CHANGED:
 264       gst_message_parse_device_changed (msg, &device, NULL);
 265       print_device (device, TRUE);
 266       gst_object_unref (device);
 267       break;
 268     default:
 269       g_print ("%s message\n", GST_MESSAGE_TYPE_NAME (msg));
 270       break;
 271   }
 272
 273   return TRUE;
 274 }
 275
 276 static gboolean
 277 quit_loop (GMainLoop * loop)
 278 {
 279   g_main_loop_quit (loop);
 280   return G_SOURCE_REMOVE;
 281 }
 282
 283 int
 284 main (int argc, char **argv)
 285 {
 286   gboolean print_version = FALSE;
 287   GError *err = NULL;
 288   gchar **arg, **args = NULL;
 289   gboolean follow = FALSE;
 290   GOptionContext *ctx;
 291   GOptionEntry options[] = {
 292     {"version", 0, 0, G_OPTION_ARG_NONE, &print_version,
 293         N_("Print version information and exit"), NULL},
 294     {"follow", 'f', 0, G_OPTION_ARG_NONE, &follow,
 295         N_("Don't exit after showing the initial device list, but wait "
 296               "for devices to added/removed."), NULL},
 297     {G_OPTION_REMAINING, 0, 0, G_OPTION_ARG_STRING_ARRAY, &args, NULL},
 298     {NULL}
 299   };
 300   GTimer *timer;
 301   DevMonApp app;
 302   GstBus *bus;
 303
 304   setlocale (LC_ALL, "");
 305
 306 #ifdef ENABLE_NLS
 307   bindtextdomain (GETTEXT_PACKAGE, LOCALEDIR);
 308   bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
 309   textdomain (GETTEXT_PACKAGE);
 310 #endif
 311
 312   g_set_prgname ("gst-device-monitor-" GST_API_VERSION);
 313
 314   ctx = g_option_context_new ("[DEVICE_CLASSES[:FILTER_CAPS]] "
 315       "[DEVICE_CLASSES[:FILTER_CAPS]] …");
 316   g_option_context_add_main_entries (ctx, options, GETTEXT_PACKAGE);
 317   g_option_context_add_group (ctx, gst_init_get_option_group ());
 318   if (!g_option_context_parse (ctx, &argc, &argv, &err)) {
 319     g_print ("Error initializing: %s\n", GST_STR_NULL (err->message));
 320     g_option_context_free (ctx);
 321     g_clear_error (&err);
 322     return 1;
 323   }
 324   g_option_context_free (ctx);
 325
 326   GST_DEBUG_CATEGORY_INIT (devmon_debug, "device-monitor", 0,
 327       "gst-device-monitor");
 328
 329   if (print_version) {
 330     gchar *version_str;
 331
 332     version_str = gst_version_string ();
 333     g_print ("%s version %s\n", g_get_prgname (), PACKAGE_VERSION);
 334     g_print ("%s\n", version_str);
 335     g_print ("%s\n", GST_PACKAGE_ORIGIN);
 336     g_free (version_str);
 337
 338     return 0;
 339   }
 340
 341   app.loop = g_main_loop_new (NULL, FALSE);
 342   app.monitor = gst_device_monitor_new ();
 343
 344   bus = gst_device_monitor_get_bus (app.monitor);
 345   app.bus_watch_id = gst_bus_add_watch (bus, bus_msg_handler, &app);
 346   gst_object_unref (bus);
 347
 348   /* process optional remaining arguments in the form
 349    * DEVICE_CLASSES or DEVICE_CLASSES:FILTER_CAPS */
 350   for (arg = args; arg != NULL && *arg != NULL; ++arg) {
 351     gchar **filters = g_strsplit (*arg, ":", -1);
 352     if (filters != NULL && filters[0] != NULL) {
 353       GstCaps *caps = NULL;
 354
 355       if (filters[1] != NULL) {
 356         caps = gst_caps_from_string (filters[1]);
 357         if (caps == NULL)
 358           g_warning ("Couldn't parse device filter caps '%s'", filters[1]);
 359       }
 360       gst_device_monitor_add_filter (app.monitor, filters[0], caps);
 361       if (caps)
 362         gst_caps_unref (caps);
 363       g_strfreev (filters);
 364     }
 365   }
 366   g_strfreev (args);
 367
 368   g_print ("Probing devices...\n\n");
 369
 370   timer = g_timer_new ();
 371
 372   if (!gst_device_monitor_start (app.monitor)) {
 373     g_printerr ("Failed to start device monitor!\n");
 374     return -1;
 375   }
 376
 377   GST_INFO ("Took %.2f seconds", g_timer_elapsed (timer, NULL));
 378
 379   if (!follow) {
 380     /* Consume all the messages pending on the bus and exit */
 381     g_idle_add ((GSourceFunc) quit_loop, app.loop);
 382   } else {
 383     g_print ("Monitoring devices, waiting for devices to be removed or "
 384         "new devices to be added...\n");
 385   }
 386
 387   g_main_loop_run (app.loop);
 388
 389   gst_device_monitor_stop (app.monitor);
 390   gst_object_unref (app.monitor);
 391
 392   g_source_remove (app.bus_watch_id);
 393   g_main_loop_unref (app.loop);
 394   g_timer_destroy (timer);
 395
 396   return 0;
 397 }