2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
4 * 2004 Thomas Vander Stichele <thomas@apestaart.org>
7 * gst-inspect.c: tool to inspect the GStreamer registry
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Library General Public
11 * License as published by the Free Software Foundation; either
12 * version 2 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Library General Public License for more details.
19 * You should have received a copy of the GNU Library General Public
20 * License along with this library; if not, write to the
21 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
22 * Boston, MA 02110-1301, USA.
29 /* FIXME 2.0: suppress warnings for deprecated API such as GValueArray
30 * with newer GLib versions (>= 2.31.0) */
31 #define GLIB_DISABLE_DEPRECATION_WARNINGS
34 #include <gst/gst_private.h> /* for internal Factories */
38 #include <glib/gprintf.h>
41 # include <sys/wait.h>
50 #include <TargetConditionals.h>
53 /* "R" : support color
54 * "X" : do not clear the screen when leaving the pager
55 * "F" : skip the pager if content fit into the screen
57 * Don't forget to update the manpage gst-inspect-1.0.1
58 * after changing this default.
60 #define DEFAULT_LESS_OPTS "RXF"
62 gboolean colored_output = TRUE;
67 SORT_TYPE_NAME, /* default */
70 SortType sort_output = SORT_TYPE_NAME;
73 static const gchar DEFAULT_PAGER[] = "less";
76 GMainLoop *loop = NULL;
80 /* Escape values for colors */
81 #define BLUE "\033[34m"
82 #define BRBLUE "\033[94m"
83 #define BRCYAN "\033[96m"
84 #define BRMAGENTA "\033[95m"
85 #define BRYELLOW "\033[33m"
86 #define CYAN "\033[36m"
87 #define GREEN "\033[32m"
88 #define MAGENTA "\033[35m"
89 #define YELLOW "\033[33m"
92 #define RESET_COLOR (colored_output? "\033[0m": "")
93 #define HEADING_COLOR (colored_output? BRYELLOW : "")
94 #define PROP_NAME_COLOR (colored_output? BRBLUE : "")
95 #define PROP_VALUE_COLOR (colored_output? RESET_COLOR: "")
96 #define PROP_ATTR_NAME_COLOR (colored_output? BRYELLOW : "")
97 #define PROP_ATTR_VALUE_COLOR (colored_output? CYAN: "")
98 /* FIXME: find a good color that works on both dark & light bg. */
99 #define DESC_COLOR (colored_output? RESET_COLOR: "")
101 /* Datatype-related colors */
102 #define DATATYPE_COLOR (colored_output? GREEN : "")
103 #define CHILD_LINK_COLOR (colored_output? BRMAGENTA : "")
106 #define FIELD_NAME_COLOR (colored_output? CYAN: "")
107 #define FIELD_VALUE_COLOR (colored_output? BRBLUE : "")
108 #define CAPS_TYPE_COLOR (colored_output? YELLOW : "")
109 #define STRUCT_NAME_COLOR (colored_output? YELLOW : "")
110 #define CAPS_FEATURE_COLOR (colored_output? GREEN : "")
112 /* Plugin listing colors */
113 #define PLUGIN_NAME_COLOR (colored_output? BRBLUE : "")
114 #define ELEMENT_NAME_COLOR (colored_output? GREEN : "")
115 /* FIXME: find a good color that works on both dark & light bg. */
116 #define ELEMENT_DETAIL_COLOR (colored_output? RESET_COLOR : "")
117 #define PLUGIN_FEATURE_COLOR (colored_output? BRBLUE: "")
119 /* Feature listing colors */
120 #define FEATURE_NAME_COLOR (colored_output? GREEN : "")
121 #define FEATURE_DIR_COLOR (colored_output? BRMAGENTA : "")
122 #define FEATURE_RANK_COLOR (colored_output? CYAN : "")
123 #define FEATURE_PROTO_COLOR (colored_output? BRYELLOW : "")
125 #define GST_DOC_BASE_URL "https://gstreamer.freedesktop.org/documentation"
127 static const gchar *gstreamer_modules[] = {
128 "gstreamer", "gst-plugins-base", "gst-plugins-good", "gst-plugins-ugly",
129 "gst-plugins-bad", "gst-editing-services", "gst-libav", "gst-rtsp-server",
130 "gstreamer-vaapi", NULL
133 static char *_name = NULL;
134 static int indent = 0;
136 static int print_element_info (GstPluginFeature * feature,
137 gboolean print_names);
138 static int print_typefind_info (GstPluginFeature * feature,
139 gboolean print_names);
140 static int print_tracer_info (GstPluginFeature * feature, gboolean print_names);
142 #define push_indent() push_indent_n(1)
143 #define pop_indent() push_indent_n(-1)
144 #define pop_indent_n(n) push_indent_n(-n)
147 push_indent_n (int n)
149 g_assert (n > 0 || indent > 0);
158 n_print (const char *format, ...)
165 g_print ("%s", _name);
167 for (i = 0; i < indent; ++i)
170 va_start (args, format);
171 str = gst_info_strdup_vprintf (format, args);
182 print_field (GQuark field, const GValue * value, gpointer pfx)
184 gchar *str = gst_value_serialize (value);
186 n_print ("%s %s%15s%s: %s%s%s\n",
187 (gchar *) pfx, FIELD_NAME_COLOR, g_quark_to_string (field), RESET_COLOR,
188 FIELD_VALUE_COLOR, str, RESET_COLOR);
194 print_caps (const GstCaps * caps, const gchar * pfx)
198 g_return_if_fail (caps != NULL);
200 if (gst_caps_is_any (caps)) {
201 n_print ("%s%sANY%s\n", CAPS_TYPE_COLOR, pfx, RESET_COLOR);
204 if (gst_caps_is_empty (caps)) {
205 n_print ("%s%sEMPTY%s\n", CAPS_TYPE_COLOR, pfx, RESET_COLOR);
209 for (i = 0; i < gst_caps_get_size (caps); i++) {
210 GstStructure *structure = gst_caps_get_structure (caps, i);
211 GstCapsFeatures *features = gst_caps_get_features (caps, i);
213 if (features && (gst_caps_features_is_any (features) ||
214 !gst_caps_features_is_equal (features,
215 GST_CAPS_FEATURES_MEMORY_SYSTEM_MEMORY))) {
216 gchar *features_string = gst_caps_features_to_string (features);
218 n_print ("%s%s%s%s(%s%s%s)\n", pfx, STRUCT_NAME_COLOR,
219 gst_structure_get_name (structure), RESET_COLOR,
220 CAPS_FEATURE_COLOR, features_string, RESET_COLOR);
221 g_free (features_string);
223 n_print ("%s%s%s%s\n", pfx, STRUCT_NAME_COLOR,
224 gst_structure_get_name (structure), RESET_COLOR);
226 gst_structure_foreach (structure, print_field, (gpointer) pfx);
231 get_rank_name (char *s, gint rank)
233 static const int ranks[4] = {
234 GST_RANK_NONE, GST_RANK_MARGINAL, GST_RANK_SECONDARY, GST_RANK_PRIMARY
236 static const char *rank_names[4] = { "none", "marginal", "secondary",
243 for (i = 0; i < 4; i++) {
244 if (rank == ranks[i])
245 return rank_names[i];
246 if (abs (rank - ranks[i]) < abs (rank - ranks[best_i])) {
251 sprintf (s, "%s %c %d", rank_names[best_i],
252 (rank - ranks[best_i] > 0) ? '+' : '-', abs (ranks[best_i] - rank));
258 print_factory_details_info (GstElementFactory * factory, GstPlugin * plugin)
261 gboolean seen_doc_uri = FALSE;
265 rank = gst_plugin_feature_get_rank (GST_PLUGIN_FEATURE (factory));
266 n_print ("%sFactory Details:%s\n", HEADING_COLOR, RESET_COLOR);
269 n_print ("%s%-25s%s%s (%d)%s\n", PROP_NAME_COLOR, "Rank", PROP_VALUE_COLOR,
270 get_rank_name (s, rank), rank, RESET_COLOR);
272 keys = gst_element_factory_get_metadata_keys (factory);
274 for (k = keys; *k != NULL; ++k) {
278 val = gst_element_factory_get_metadata (factory, key);
279 key[0] = g_ascii_toupper (key[0]);
280 n_print ("%s%-25s%s%s%s\n", PROP_NAME_COLOR, key, PROP_VALUE_COLOR, val,
283 seen_doc_uri || g_str_equal (key, GST_ELEMENT_METADATA_DOC_URI);
288 if (!seen_doc_uri && plugin != NULL &&
289 !gst_element_factory_get_skip_documentation (factory)) {
290 const gchar *module = gst_plugin_get_source (plugin);
291 const gchar *origin = gst_plugin_get_origin (plugin);
293 /* gst-plugins-rs has per-plugin module names so need to check origin there */
294 if (g_strv_contains (gstreamer_modules, module)
295 || (origin != NULL && g_str_has_suffix (origin, "/gst-plugins-rs"))) {
299 gst_registry_get_feature_list_by_plugin (gst_registry_get (),
300 gst_plugin_get_name (plugin));
302 /* if the plugin only has a single feature, plugin page == feature page */
303 if (features != NULL && features->next == NULL) {
304 n_print ("%s%-25s%s%s%s/%s/#%s-page%s\n", PROP_NAME_COLOR,
305 "Documentation", RESET_COLOR, PROP_VALUE_COLOR, GST_DOC_BASE_URL,
306 gst_plugin_get_name (plugin), GST_OBJECT_NAME (factory),
309 n_print ("%s%-25s%s%s%s/%s/%s.html%s\n", PROP_NAME_COLOR,
310 "Documentation", RESET_COLOR, PROP_VALUE_COLOR, GST_DOC_BASE_URL,
311 gst_plugin_get_name (plugin), GST_OBJECT_NAME (factory),
314 gst_plugin_feature_list_free (features);
323 print_hierarchy (GType type, gint level, gint * maxlevel)
328 parent = g_type_parent (type);
330 *maxlevel = *maxlevel + 1;
334 print_hierarchy (parent, level, maxlevel);
337 g_print ("%s%s%s", DATATYPE_COLOR, _name, RESET_COLOR);
339 for (i = 1; i < *maxlevel - level; i++)
341 if (*maxlevel - level)
342 g_print (" %s+----%s", CHILD_LINK_COLOR, RESET_COLOR);
344 g_print ("%s%s%s\n", DATATYPE_COLOR, g_type_name (type), RESET_COLOR);
351 print_interfaces (GType type)
354 GType *iface, *ifaces = g_type_interfaces (type, &n_ifaces);
358 n_print (_("%sImplemented Interfaces%s:\n"), HEADING_COLOR, RESET_COLOR);
362 n_print ("%s%s%s\n", DATATYPE_COLOR, g_type_name (*iface), RESET_COLOR);
373 flags_to_string (GFlagsValue * vals, guint flags)
378 /* first look for an exact match and count the number of values */
379 for (i = 0; vals[i].value_name != NULL; ++i) {
380 if (vals[i].value == flags)
381 return g_strdup (vals[i].value_nick);
384 s = g_string_new (NULL);
386 /* we assume the values are sorted from lowest to highest value */
390 if (vals[i].value != 0 && (flags_left & vals[i].value) == vals[i].value) {
392 g_string_append_c (s, '+');
393 g_string_append (s, vals[i].value_nick);
394 flags_left -= vals[i].value;
401 g_string_assign (s, "(none)");
403 return g_string_free (s, FALSE);
406 #define KNOWN_PARAM_FLAGS \
407 (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY | \
408 G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS | \
409 G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_DEPRECATED | \
410 GST_PARAM_CONTROLLABLE | GST_PARAM_MUTABLE_PLAYING | \
411 GST_PARAM_MUTABLE_PAUSED | GST_PARAM_MUTABLE_READY | \
412 GST_PARAM_CONDITIONALLY_AVAILABLE | GST_PARAM_DOC_SHOW_DEFAULT)
415 sort_gparamspecs (GParamSpec ** a, GParamSpec ** b)
417 return g_strcmp0 (g_param_spec_get_name (*a), g_param_spec_get_name (*b));
420 /* obj will be NULL if we're printing properties of pad template pads */
422 print_object_properties_info (GObject * obj, GObjectClass * obj_class,
425 GParamSpec **property_specs;
426 guint num_properties, i;
430 property_specs = g_object_class_list_properties (obj_class, &num_properties);
431 g_qsort_with_data (property_specs, num_properties, sizeof (gpointer),
432 (GCompareDataFunc) sort_gparamspecs, NULL);
434 n_print ("%s%s%s:\n", HEADING_COLOR, desc, RESET_COLOR);
439 for (i = 0; i < num_properties; i++) {
440 GValue value = { 0, };
441 GParamSpec *param = property_specs[i];
442 GType owner_type = param->owner_type;
444 /* We're printing pad properties */
445 if (obj == NULL && (owner_type == G_TYPE_OBJECT
446 || owner_type == GST_TYPE_OBJECT || owner_type == GST_TYPE_PAD))
449 g_value_init (&value, param->value_type);
451 n_print ("%s%-20s%s: %s%s%s\n", PROP_NAME_COLOR,
452 g_param_spec_get_name (param), RESET_COLOR, PROP_VALUE_COLOR,
453 g_param_spec_get_blurb (param), RESET_COLOR);
458 n_print ("%sflags%s: ", PROP_ATTR_NAME_COLOR, RESET_COLOR);
459 readable = ! !(param->flags & G_PARAM_READABLE);
460 if (readable && obj != NULL) {
461 g_object_get_property (obj, param->name, &value);
463 /* if we can't read the property value, assume it's set to the default
464 * (which might not be entirely true for sub-classes, but that's an
465 * unlikely corner-case anyway) */
466 g_param_value_set_default (param, &value);
469 g_print ("%s%s%s%s", (first_flag) ? "" : ", ", PROP_ATTR_VALUE_COLOR,
470 _("readable"), RESET_COLOR);
473 if (param->flags & G_PARAM_WRITABLE) {
474 g_print ("%s%s%s%s", (first_flag) ? "" : ", ", PROP_ATTR_VALUE_COLOR,
475 _("writable"), RESET_COLOR);
478 if (param->flags & G_PARAM_DEPRECATED) {
479 g_print ("%s%s%s%s", (first_flag) ? "" : ", ", PROP_ATTR_VALUE_COLOR,
480 _("deprecated"), RESET_COLOR);
483 if (param->flags & GST_PARAM_CONTROLLABLE) {
484 g_print (", %s%s%s", PROP_ATTR_VALUE_COLOR, _("controllable"),
488 if (param->flags & GST_PARAM_CONDITIONALLY_AVAILABLE) {
489 g_print (", %s%s%s", PROP_ATTR_VALUE_COLOR, _("conditionally available"),
493 if (param->flags & GST_PARAM_MUTABLE_PLAYING) {
494 g_print (", %s%s%s", PROP_ATTR_VALUE_COLOR,
495 _("changeable in NULL, READY, PAUSED or PLAYING state"), RESET_COLOR);
496 } else if (param->flags & GST_PARAM_MUTABLE_PAUSED) {
497 g_print (", %s%s%s", PROP_ATTR_VALUE_COLOR,
498 _("changeable only in NULL, READY or PAUSED state"), RESET_COLOR);
499 } else if (param->flags & GST_PARAM_MUTABLE_READY) {
500 g_print (", %s%s%s", PROP_ATTR_VALUE_COLOR,
501 _("changeable only in NULL or READY state"), RESET_COLOR);
503 if (param->flags & ~KNOWN_PARAM_FLAGS) {
504 g_print ("%s0x%s%0x%s", (first_flag) ? "" : ", ", PROP_ATTR_VALUE_COLOR,
505 param->flags & ~KNOWN_PARAM_FLAGS, RESET_COLOR);
509 switch (G_VALUE_TYPE (&value)) {
512 const char *string_val = g_value_get_string (&value);
514 n_print ("%sString%s. ", DATATYPE_COLOR, RESET_COLOR);
516 if (string_val == NULL)
517 g_print ("%sDefault%s: %snull%s", PROP_ATTR_NAME_COLOR, RESET_COLOR,
518 PROP_ATTR_VALUE_COLOR, RESET_COLOR);
520 g_print ("%sDefault%s: %s\"%s\"%s", PROP_ATTR_NAME_COLOR, RESET_COLOR,
521 PROP_ATTR_VALUE_COLOR, string_val, RESET_COLOR);
526 gboolean bool_val = g_value_get_boolean (&value);
528 n_print ("%sBoolean%s. %sDefault%s: %s%s%s", DATATYPE_COLOR,
529 RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
530 PROP_ATTR_VALUE_COLOR, bool_val ? "true" : "false", RESET_COLOR);
535 GParamSpecULong *pulong = G_PARAM_SPEC_ULONG (param);
538 ("%sUnsigned Long%s. %sRange%s: %s%lu - %lu%s %sDefault%s: %s%lu%s ",
539 DATATYPE_COLOR, RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
540 PROP_ATTR_VALUE_COLOR, pulong->minimum, pulong->maximum,
541 RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
542 PROP_ATTR_VALUE_COLOR, g_value_get_ulong (&value), RESET_COLOR);
544 GST_ERROR ("%s: property '%s' of type ulong: consider changing to "
545 "uint/uint64", G_OBJECT_CLASS_NAME (obj_class),
546 g_param_spec_get_name (param));
551 GParamSpecLong *plong = G_PARAM_SPEC_LONG (param);
553 n_print ("%sLong%s. %sRange%s: %s%ld - %ld%s %sDefault%s: %s%ld%s ",
554 DATATYPE_COLOR, RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
555 PROP_ATTR_VALUE_COLOR, plong->minimum, plong->maximum, RESET_COLOR,
556 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
557 g_value_get_long (&value), RESET_COLOR);
559 GST_ERROR ("%s: property '%s' of type long: consider changing to "
560 "int/int64", G_OBJECT_CLASS_NAME (obj_class),
561 g_param_spec_get_name (param));
566 GParamSpecUInt *puint = G_PARAM_SPEC_UINT (param);
569 ("%sUnsigned Integer%s. %sRange%s: %s%u - %u%s %sDefault%s: %s%u%s ",
570 DATATYPE_COLOR, RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
571 PROP_ATTR_VALUE_COLOR, puint->minimum, puint->maximum, RESET_COLOR,
572 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
573 g_value_get_uint (&value), RESET_COLOR);
578 GParamSpecInt *pint = G_PARAM_SPEC_INT (param);
580 n_print ("%sInteger%s. %sRange%s: %s%d - %d%s %sDefault%s: %s%d%s ",
581 DATATYPE_COLOR, RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
582 PROP_ATTR_VALUE_COLOR, pint->minimum, pint->maximum, RESET_COLOR,
583 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
584 g_value_get_int (&value), RESET_COLOR);
589 GParamSpecUInt64 *puint64 = G_PARAM_SPEC_UINT64 (param);
591 n_print ("%sUnsigned Integer64%s. %sRange%s: %s%" G_GUINT64_FORMAT " - "
592 "%" G_GUINT64_FORMAT "%s %sDefault%s: %s%" G_GUINT64_FORMAT "%s ",
593 DATATYPE_COLOR, RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
594 PROP_ATTR_VALUE_COLOR, puint64->minimum, puint64->maximum,
595 RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
596 PROP_ATTR_VALUE_COLOR, g_value_get_uint64 (&value), RESET_COLOR);
601 GParamSpecInt64 *pint64 = G_PARAM_SPEC_INT64 (param);
603 n_print ("%sInteger64%s. %sRange%s: %s%" G_GINT64_FORMAT " - %"
604 G_GINT64_FORMAT "%s %sDefault%s: %s%" G_GINT64_FORMAT "%s ",
605 DATATYPE_COLOR, RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
606 PROP_ATTR_VALUE_COLOR, pint64->minimum, pint64->maximum,
607 RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
608 PROP_ATTR_VALUE_COLOR, g_value_get_int64 (&value), RESET_COLOR);
613 GParamSpecFloat *pfloat = G_PARAM_SPEC_FLOAT (param);
615 n_print ("%sFloat%s. %sRange%s: %s%15.7g - %15.7g%s "
616 "%sDefault%s: %s%15.7g%s ", DATATYPE_COLOR, RESET_COLOR,
617 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
618 pfloat->minimum, pfloat->maximum, RESET_COLOR, PROP_ATTR_NAME_COLOR,
619 RESET_COLOR, PROP_ATTR_VALUE_COLOR, g_value_get_float (&value),
625 GParamSpecDouble *pdouble = G_PARAM_SPEC_DOUBLE (param);
627 n_print ("%sDouble%s. %sRange%s: %s%15.7g - %15.7g%s "
628 "%sDefault%s: %s%15.7g%s ", DATATYPE_COLOR, RESET_COLOR,
629 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
630 pdouble->minimum, pdouble->maximum, RESET_COLOR,
631 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
632 g_value_get_double (&value), RESET_COLOR);
637 GST_ERROR ("%s: property '%s' of type char: consider changing to "
638 "int/string", G_OBJECT_CLASS_NAME (obj_class),
639 g_param_spec_get_name (param));
642 if (param->value_type == GST_TYPE_CAPS) {
643 const GstCaps *caps = gst_value_get_caps (&value);
646 n_print ("%sCaps%s (NULL)", DATATYPE_COLOR, RESET_COLOR);
648 print_caps (caps, " ");
650 } else if (G_IS_PARAM_SPEC_ENUM (param)) {
654 const gchar *value_nick = "";
656 values = G_ENUM_CLASS (g_type_class_ref (param->value_type))->values;
657 enum_value = g_value_get_enum (&value);
659 while (values[j].value_name) {
660 if (values[j].value == enum_value)
661 value_nick = values[j].value_nick;
665 n_print ("%sEnum \"%s\"%s %sDefault%s: %s%d, \"%s\"%s",
666 DATATYPE_COLOR, g_type_name (G_VALUE_TYPE (&value)), RESET_COLOR,
667 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
668 enum_value, value_nick, RESET_COLOR);
671 while (values[j].value_name) {
673 n_print (" %s(%d)%s: %s%-16s%s - %s%s%s",
674 PROP_ATTR_NAME_COLOR, values[j].value, RESET_COLOR,
675 PROP_ATTR_VALUE_COLOR, values[j].value_nick, RESET_COLOR,
676 DESC_COLOR, values[j].value_name, RESET_COLOR);
679 /* g_type_class_unref (ec); */
680 } else if (G_IS_PARAM_SPEC_FLAGS (param)) {
681 GParamSpecFlags *pflags = G_PARAM_SPEC_FLAGS (param);
685 vals = pflags->flags_class->values;
687 cur = flags_to_string (vals, g_value_get_flags (&value));
689 n_print ("%sFlags \"%s\"%s %sDefault%s: %s0x%08x, \"%s\"%s",
690 DATATYPE_COLOR, g_type_name (G_VALUE_TYPE (&value)), RESET_COLOR,
691 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
692 g_value_get_flags (&value), cur, RESET_COLOR);
694 while (vals[0].value_name) {
696 n_print (" %s(0x%08x)%s: %s%-16s%s - %s%s%s",
697 PROP_ATTR_NAME_COLOR, vals[0].value, RESET_COLOR,
698 PROP_ATTR_VALUE_COLOR, vals[0].value_nick, RESET_COLOR,
699 DESC_COLOR, vals[0].value_name, RESET_COLOR);
704 } else if (G_IS_PARAM_SPEC_OBJECT (param)) {
705 n_print ("%sObject of type%s %s\"%s\"%s", PROP_VALUE_COLOR,
706 RESET_COLOR, DATATYPE_COLOR,
707 g_type_name (param->value_type), RESET_COLOR);
708 } else if (G_IS_PARAM_SPEC_BOXED (param)) {
709 n_print ("%sBoxed pointer of type%s %s\"%s\"%s", PROP_VALUE_COLOR,
710 RESET_COLOR, DATATYPE_COLOR,
711 g_type_name (param->value_type), RESET_COLOR);
712 if (param->value_type == GST_TYPE_STRUCTURE) {
713 const GstStructure *s = gst_value_get_structure (&value);
716 gst_structure_foreach (s, print_field,
720 } else if (G_IS_PARAM_SPEC_POINTER (param)) {
721 if (param->value_type != G_TYPE_POINTER) {
722 n_print ("%sPointer of type%s %s\"%s\"%s.", PROP_VALUE_COLOR,
723 RESET_COLOR, DATATYPE_COLOR, g_type_name (param->value_type),
726 n_print ("%sPointer.%s", PROP_VALUE_COLOR, RESET_COLOR);
728 } else if (param->value_type == G_TYPE_VALUE_ARRAY) {
729 GParamSpecValueArray *pvarray = G_PARAM_SPEC_VALUE_ARRAY (param);
731 if (pvarray->element_spec) {
732 n_print ("%sArray of GValues of type%s %s\"%s\"%s",
733 PROP_VALUE_COLOR, RESET_COLOR, DATATYPE_COLOR,
734 g_type_name (pvarray->element_spec->value_type), RESET_COLOR);
736 n_print ("%sArray of GValues%s", PROP_VALUE_COLOR, RESET_COLOR);
738 } else if (GST_IS_PARAM_SPEC_FRACTION (param)) {
739 GstParamSpecFraction *pfraction = GST_PARAM_SPEC_FRACTION (param);
741 n_print ("%sFraction%s. %sRange%s: %s%d/%d - %d/%d%s "
742 "%sDefault%s: %s%d/%d%s ", DATATYPE_COLOR, RESET_COLOR,
743 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
744 pfraction->min_num, pfraction->min_den, pfraction->max_num,
745 pfraction->max_den, RESET_COLOR, PROP_ATTR_NAME_COLOR,
746 RESET_COLOR, PROP_ATTR_VALUE_COLOR,
747 gst_value_get_fraction_numerator (&value),
748 gst_value_get_fraction_denominator (&value), RESET_COLOR);
749 } else if (param->value_type == GST_TYPE_ARRAY) {
750 GstParamSpecArray *parray = GST_PARAM_SPEC_ARRAY_LIST (param);
752 if (GST_VALUE_HOLDS_ARRAY (&value)) {
753 gchar *def = gst_value_serialize (&value);
755 n_print ("%sDefault%s: \"%s\"\n", PROP_ATTR_VALUE_COLOR,
761 if (parray->element_spec) {
762 n_print ("%sGstValueArray of GValues of type%s %s\"%s\"%s",
763 PROP_VALUE_COLOR, RESET_COLOR, DATATYPE_COLOR,
764 g_type_name (parray->element_spec->value_type), RESET_COLOR);
766 n_print ("%sGstValueArray of GValues%s", PROP_VALUE_COLOR,
770 n_print ("%sUnknown type %ld%s %s\"%s\"%s", PROP_VALUE_COLOR,
771 (glong) param->value_type, RESET_COLOR, DATATYPE_COLOR,
772 g_type_name (param->value_type), RESET_COLOR);
777 g_print (" %sWrite only%s\n", PROP_VALUE_COLOR, RESET_COLOR);
783 g_value_reset (&value);
787 if (num_properties == 0)
788 n_print ("%snone%s\n", PROP_VALUE_COLOR, RESET_COLOR);
792 g_free (property_specs);
796 print_element_properties_info (GstElement * element)
799 print_object_properties_info (G_OBJECT (element),
800 G_OBJECT_GET_CLASS (element), "Element Properties");
804 gst_static_pad_compare_func (gconstpointer p1, gconstpointer p2)
806 GstStaticPadTemplate *pt1, *pt2;
808 pt1 = (GstStaticPadTemplate *) p1;
809 pt2 = (GstStaticPadTemplate *) p2;
811 return strcmp (pt1->name_template, pt2->name_template);
816 print_pad_templates_info (GstElement * element, GstElementFactory * factory)
819 GstStaticPadTemplate *padtemplate;
820 GstPadTemplate *tmpl;
822 n_print ("%sPad Templates%s:\n", HEADING_COLOR, RESET_COLOR);
826 if (gst_element_factory_get_num_pad_templates (factory) == 0) {
827 n_print ("%snone%s\n", PROP_VALUE_COLOR, RESET_COLOR);
831 pads = g_list_copy ((GList *)
832 gst_element_factory_get_static_pad_templates (factory));
833 pads = g_list_sort (pads, gst_static_pad_compare_func);
835 for (tmp = pads; tmp; tmp = tmp->next) {
836 padtemplate = (GstStaticPadTemplate *) (tmp->data);
838 if (padtemplate->direction == GST_PAD_SRC)
839 n_print ("%sSRC template%s: %s'%s'%s\n", PROP_NAME_COLOR, RESET_COLOR,
840 PROP_VALUE_COLOR, padtemplate->name_template, RESET_COLOR);
841 else if (padtemplate->direction == GST_PAD_SINK)
842 n_print ("%sSINK template%s: %s'%s'%s\n", PROP_NAME_COLOR, RESET_COLOR,
843 PROP_VALUE_COLOR, padtemplate->name_template, RESET_COLOR);
845 n_print ("%sUNKNOWN template%s: %s'%s'%s\n", PROP_NAME_COLOR, RESET_COLOR,
846 PROP_VALUE_COLOR, padtemplate->name_template, RESET_COLOR);
850 if (padtemplate->presence == GST_PAD_ALWAYS)
851 n_print ("%sAvailability%s: %sAlways%s\n", PROP_NAME_COLOR, RESET_COLOR,
852 PROP_VALUE_COLOR, RESET_COLOR);
853 else if (padtemplate->presence == GST_PAD_SOMETIMES)
854 n_print ("%sAvailability%s: %sSometimes%s\n", PROP_NAME_COLOR,
855 RESET_COLOR, PROP_VALUE_COLOR, RESET_COLOR);
856 else if (padtemplate->presence == GST_PAD_REQUEST) {
857 n_print ("%sAvailability%s: %sOn request%s\n", PROP_NAME_COLOR,
858 RESET_COLOR, PROP_VALUE_COLOR, RESET_COLOR);
860 n_print ("%sAvailability%s: %sUNKNOWN%s\n", PROP_NAME_COLOR, RESET_COLOR,
861 PROP_VALUE_COLOR, RESET_COLOR);
863 if (padtemplate->static_caps.string) {
864 GstCaps *caps = gst_static_caps_get (&padtemplate->static_caps);
866 n_print ("%sCapabilities%s:\n", PROP_NAME_COLOR, RESET_COLOR);
869 print_caps (caps, ""); // FIXME
872 gst_caps_unref (caps);
875 tmpl = gst_element_class_get_pad_template (GST_ELEMENT_GET_CLASS (element),
876 padtemplate->name_template);
878 GType pad_type = GST_PAD_TEMPLATE_GTYPE (tmpl);
880 if (pad_type != G_TYPE_NONE && pad_type != GST_TYPE_PAD) {
883 pad_klass = g_type_class_ref (pad_type);
884 n_print ("%sType%s: %s%s%s\n", PROP_NAME_COLOR, RESET_COLOR,
885 DATATYPE_COLOR, g_type_name (pad_type), RESET_COLOR);
886 print_object_properties_info (NULL, pad_klass, "Pad Properties");
887 g_type_class_unref (pad_klass);
902 print_clocking_info (GstElement * element)
904 gboolean requires_clock, provides_clock;
907 GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_REQUIRE_CLOCK);
909 GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_PROVIDE_CLOCK);
911 if (!requires_clock && !provides_clock) {
913 n_print ("%sElement has no clocking capabilities.%s\n", DESC_COLOR,
919 n_print ("%sClocking Interaction%s:\n", PROP_NAME_COLOR, RESET_COLOR);
923 if (requires_clock) {
924 n_print ("%selement requires a clock%s\n", PROP_VALUE_COLOR, RESET_COLOR);
927 if (provides_clock) {
930 clock = gst_element_get_clock (element);
932 n_print ("%selement provides a clock%s: %s%s%s\n", PROP_VALUE_COLOR,
933 RESET_COLOR, DATATYPE_COLOR, GST_OBJECT_NAME (clock), RESET_COLOR);
934 gst_object_unref (clock);
936 n_print ("%selement is supposed to provide a clock but returned NULL%s\n",
937 PROP_VALUE_COLOR, RESET_COLOR);
944 print_uri_handler_info (GstElement * element)
946 if (GST_IS_URI_HANDLER (element)) {
947 const gchar *const *uri_protocols;
948 const gchar *uri_type;
950 if (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element)) == GST_URI_SRC)
952 else if (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element)) ==
956 uri_type = "unknown";
958 uri_protocols = gst_uri_handler_get_protocols (GST_URI_HANDLER (element));
961 n_print ("%sURI handling capabilities:%s\n", HEADING_COLOR, RESET_COLOR);
965 n_print ("%sElement can act as %s.%s\n", DESC_COLOR, uri_type, RESET_COLOR);
967 if (uri_protocols && *uri_protocols) {
968 n_print ("%sSupported URI protocols%s:\n", DESC_COLOR, RESET_COLOR);
970 for (; *uri_protocols != NULL; uri_protocols++)
971 n_print ("%s%s%s\n", PROP_ATTR_VALUE_COLOR, *uri_protocols,
975 n_print ("%sNo supported URI protocols%s\n", PROP_VALUE_COLOR,
981 n_print ("%sElement has no URI handling capabilities.%s\n", DESC_COLOR,
987 print_pad_info (GstElement * element)
993 n_print ("%sPads:%s\n", HEADING_COLOR, RESET_COLOR);
997 if (!element->numpads) {
998 n_print ("%snone%s\n", PROP_VALUE_COLOR, RESET_COLOR);
1002 pads = element->pads;
1007 pad = GST_PAD (pads->data);
1008 pads = g_list_next (pads);
1010 name = gst_pad_get_name (pad);
1011 if (gst_pad_get_direction (pad) == GST_PAD_SRC)
1012 n_print ("%sSRC%s: %s'%s'%s\n", PROP_NAME_COLOR, RESET_COLOR,
1013 PROP_VALUE_COLOR, name, RESET_COLOR);
1014 else if (gst_pad_get_direction (pad) == GST_PAD_SINK)
1015 n_print ("%sSINK%s: %s'%s'%s\n", PROP_NAME_COLOR, RESET_COLOR,
1016 PROP_VALUE_COLOR, name, RESET_COLOR);
1018 n_print ("%sUNKNOWN%s: %s'%s'%s\n", PROP_NAME_COLOR, RESET_COLOR,
1019 PROP_VALUE_COLOR, name, RESET_COLOR);
1023 if (pad->padtemplate) {
1025 n_print ("%sPad Template%s: %s'%s'%s\n", PROP_NAME_COLOR, RESET_COLOR,
1026 PROP_VALUE_COLOR, pad->padtemplate->name_template, RESET_COLOR);
1030 caps = gst_pad_get_current_caps (pad);
1032 n_print ("%sCapabilities:%s\n", PROP_NAME_COLOR, RESET_COLOR);
1034 print_caps (caps, ""); // FIXME
1036 gst_caps_unref (caps);
1045 has_sometimes_template (GstElement * element)
1047 GstElementClass *klass = GST_ELEMENT_GET_CLASS (element);
1050 for (l = klass->padtemplates; l != NULL; l = l->next) {
1051 if (GST_PAD_TEMPLATE (l->data)->presence == GST_PAD_SOMETIMES)
1059 gtype_needs_ptr_marker (GType type)
1061 if (type == G_TYPE_POINTER)
1064 if (G_TYPE_FUNDAMENTAL (type) == G_TYPE_POINTER || G_TYPE_IS_BOXED (type)
1065 || G_TYPE_IS_OBJECT (type))
1072 print_signal_info (GstElement * element)
1074 /* Signals/Actions Block */
1078 GSignalQuery *query = NULL;
1080 GSList *found_signals, *l;
1082 for (k = 0; k < 2; k++) {
1083 found_signals = NULL;
1085 /* For elements that have sometimes pads, also list a few useful GstElement
1086 * signals. Put these first, so element-specific ones come later. */
1087 if (k == 0 && has_sometimes_template (element)) {
1088 query = g_new0 (GSignalQuery, 1);
1089 g_signal_query (g_signal_lookup ("pad-added", GST_TYPE_ELEMENT), query);
1090 found_signals = g_slist_append (found_signals, query);
1091 query = g_new0 (GSignalQuery, 1);
1092 g_signal_query (g_signal_lookup ("pad-removed", GST_TYPE_ELEMENT), query);
1093 found_signals = g_slist_append (found_signals, query);
1094 query = g_new0 (GSignalQuery, 1);
1095 g_signal_query (g_signal_lookup ("no-more-pads", GST_TYPE_ELEMENT),
1097 found_signals = g_slist_append (found_signals, query);
1100 for (type = G_OBJECT_TYPE (element); type; type = g_type_parent (type)) {
1101 if (type == GST_TYPE_ELEMENT || type == GST_TYPE_OBJECT)
1104 if (type == GST_TYPE_BIN && G_OBJECT_TYPE (element) != GST_TYPE_BIN)
1107 signals = g_signal_list_ids (type, &nsignals);
1108 for (i = 0; i < nsignals; i++) {
1109 query = g_new0 (GSignalQuery, 1);
1110 g_signal_query (signals[i], query);
1112 if ((k == 0 && !(query->signal_flags & G_SIGNAL_ACTION)) ||
1113 (k == 1 && (query->signal_flags & G_SIGNAL_ACTION)))
1114 found_signals = g_slist_append (found_signals, query);
1122 if (found_signals) {
1125 n_print ("%sElement Signals%s:\n", HEADING_COLOR, RESET_COLOR);
1127 n_print ("%sElement Actions%s:\n", HEADING_COLOR, RESET_COLOR);
1133 for (l = found_signals; l; l = l->next) {
1138 query = (GSignalQuery *) l->data;
1139 indent_len = strlen (query->signal_name) +
1140 strlen (g_type_name (query->return_type)) + 24;
1142 if (gtype_needs_ptr_marker (query->return_type)) {
1149 indent = g_new0 (gchar, indent_len + 1);
1150 memset (indent, ' ', indent_len);
1152 n_print (" %s\"%s\"%s : %s%s%s%suser_function%s (%s%s%s* object%s",
1153 PROP_NAME_COLOR, query->signal_name, RESET_COLOR,
1154 DATATYPE_COLOR, g_type_name (query->return_type), PROP_VALUE_COLOR,
1155 pmark, RESET_COLOR, DATATYPE_COLOR, g_type_name (type),
1156 PROP_VALUE_COLOR, RESET_COLOR);
1158 for (j = 0; j < query->n_params; j++) {
1159 const gchar *type_name, *asterisk;
1161 type_name = g_type_name (query->param_types[j]);
1162 asterisk = gtype_needs_ptr_marker (query->param_types[j]) ? "*" : "";
1165 n_print ("%s%s%s%s%s arg%d%s", indent, DATATYPE_COLOR, type_name,
1166 PROP_VALUE_COLOR, asterisk, j, RESET_COLOR);
1171 n_print ("%s%sgpointer %suser_data%s);\n", indent, DATATYPE_COLOR,
1172 PROP_VALUE_COLOR, RESET_COLOR);
1180 if (found_signals) {
1181 g_slist_foreach (found_signals, (GFunc) g_free, NULL);
1182 g_slist_free (found_signals);
1188 print_children_info (GstElement * element)
1192 if (!GST_IS_BIN (element))
1195 children = (GList *) GST_BIN (element)->children;
1198 n_print ("%sChildren%s:\n", HEADING_COLOR, RESET_COLOR);
1202 n_print (" %s%s%s\n", DATATYPE_COLOR,
1203 GST_ELEMENT_NAME (GST_ELEMENT (children->data)), RESET_COLOR);
1204 children = g_list_next (children);
1209 print_preset_list (GstElement * element)
1211 gchar **presets, **preset;
1213 if (!GST_IS_PRESET (element))
1216 presets = gst_preset_get_preset_names (GST_PRESET (element));
1217 if (presets && *presets) {
1219 n_print ("%sPresets%s:\n", HEADING_COLOR, RESET_COLOR);
1220 for (preset = presets; *preset; preset++) {
1221 gchar *comment = NULL;
1222 n_print (" \"%s\"", *preset);
1224 if (gst_preset_get_meta (GST_PRESET (element), *preset, "comment",
1225 &comment) && comment)
1226 g_print (": %s", comment);
1230 g_strfreev (presets);
1235 gst_plugin_name_compare_func (gconstpointer p1, gconstpointer p2)
1237 return strcmp (gst_plugin_get_name ((GstPlugin *) p1),
1238 gst_plugin_get_name ((GstPlugin *) p2));
1242 gst_plugin_feature_name_compare_func (gconstpointer p1, gconstpointer p2)
1244 return strcmp (GST_OBJECT_NAME (p1), GST_OBJECT_NAME (p2));
1248 print_blacklist (void)
1250 GList *plugins, *cur;
1253 g_print ("%s%s%s\n", HEADING_COLOR, _("Blacklisted files:"), RESET_COLOR);
1255 plugins = gst_registry_get_plugin_list (gst_registry_get ());
1256 if (sort_output == SORT_TYPE_NAME)
1257 plugins = g_list_sort (plugins, gst_plugin_name_compare_func);
1259 for (cur = plugins; cur != NULL; cur = g_list_next (cur)) {
1260 GstPlugin *plugin = (GstPlugin *) (cur->data);
1261 if (GST_OBJECT_FLAG_IS_SET (plugin, GST_PLUGIN_FLAG_BLACKLISTED)) {
1262 g_print (" %s\n", gst_plugin_get_name (plugin));
1268 g_print (_("%sTotal count%s: %s"), PROP_NAME_COLOR, RESET_COLOR,
1270 g_print (ngettext ("%d blacklisted file", "%d blacklisted files", count),
1272 g_print ("%s\n", RESET_COLOR);
1273 gst_plugin_list_free (plugins);
1277 print_typefind_extensions (const gchar * const *extensions, const gchar * color)
1281 while (extensions[i]) {
1282 g_print ("%s%s%s%s", i > 0 ? ", " : "", color, extensions[i], RESET_COLOR);
1288 print_element_list (gboolean print_all, gchar * ftypes)
1290 int plugincount = 0, featurecount = 0, blacklistcount = 0;
1291 GList *plugins, *orig_plugins;
1292 gchar **types = NULL;
1297 types = g_strsplit (ftypes, "/", -1);
1298 for (i = 0; types[i]; i++)
1299 *types[i] = g_ascii_toupper (*types[i]);
1303 orig_plugins = plugins = gst_registry_get_plugin_list (gst_registry_get ());
1304 if (sort_output == SORT_TYPE_NAME)
1305 plugins = g_list_sort (plugins, gst_plugin_name_compare_func);
1307 GList *features, *orig_features;
1310 plugin = (GstPlugin *) (plugins->data);
1311 plugins = g_list_next (plugins);
1314 if (GST_OBJECT_FLAG_IS_SET (plugin, GST_PLUGIN_FLAG_BLACKLISTED)) {
1319 orig_features = features =
1320 gst_registry_get_feature_list_by_plugin (gst_registry_get (),
1321 gst_plugin_get_name (plugin));
1322 if (sort_output == SORT_TYPE_NAME)
1323 features = g_list_sort (features, gst_plugin_feature_name_compare_func);
1325 GstPluginFeature *feature;
1327 if (G_UNLIKELY (features->data == NULL))
1329 feature = GST_PLUGIN_FEATURE (features->data);
1332 if (GST_IS_ELEMENT_FACTORY (feature)) {
1334 GstElementFactory *factory;
1336 factory = GST_ELEMENT_FACTORY (feature);
1339 gboolean all_found = TRUE;
1342 gst_element_factory_get_metadata (factory,
1343 GST_ELEMENT_METADATA_KLASS);
1344 for (i = 0; types[i]; i++) {
1345 if (!strstr (klass, types[i])) {
1355 print_element_info (feature, TRUE);
1357 g_print ("%s%s%s: %s%s%s: %s%s%s\n", PLUGIN_NAME_COLOR,
1358 gst_plugin_get_name (plugin), RESET_COLOR, ELEMENT_NAME_COLOR,
1359 GST_OBJECT_NAME (factory), RESET_COLOR, ELEMENT_DETAIL_COLOR,
1360 gst_element_factory_get_metadata (factory,
1361 GST_ELEMENT_METADATA_LONGNAME), RESET_COLOR);
1362 } else if (GST_IS_TYPE_FIND_FACTORY (feature)) {
1363 GstTypeFindFactory *factory;
1364 const gchar *const *extensions;
1368 factory = GST_TYPE_FIND_FACTORY (feature);
1370 g_print ("%s%s%s: %s%s%s: ", PLUGIN_NAME_COLOR,
1371 gst_plugin_get_name (plugin), RESET_COLOR, ELEMENT_NAME_COLOR,
1372 gst_plugin_feature_get_name (feature), RESET_COLOR);
1374 extensions = gst_type_find_factory_get_extensions (factory);
1375 if (extensions != NULL) {
1377 print_typefind_extensions (extensions, ELEMENT_DETAIL_COLOR);
1382 g_print ("%sno extensions%s\n", ELEMENT_DETAIL_COLOR, RESET_COLOR);
1388 n_print ("%s%s%s: %s%s%s (%s%s%s)\n", PLUGIN_NAME_COLOR,
1389 gst_plugin_get_name (plugin), RESET_COLOR, ELEMENT_NAME_COLOR,
1390 GST_OBJECT_NAME (feature), RESET_COLOR, ELEMENT_DETAIL_COLOR,
1391 g_type_name (G_OBJECT_TYPE (feature)), RESET_COLOR);
1395 features = g_list_next (features);
1398 gst_plugin_feature_list_free (orig_features);
1401 gst_plugin_list_free (orig_plugins);
1405 g_print (_("%sTotal count%s: %s"), PROP_NAME_COLOR, RESET_COLOR,
1407 g_print (ngettext ("%d plugin", "%d plugins", plugincount), plugincount);
1408 if (blacklistcount) {
1410 g_print (ngettext ("%d blacklist entry", "%d blacklist entries",
1411 blacklistcount), blacklistcount);
1412 g_print (" not shown)");
1414 g_print ("%s, %s", RESET_COLOR, PROP_VALUE_COLOR);
1415 g_print (ngettext ("%d feature", "%d features", featurecount), featurecount);
1416 g_print ("%s\n", RESET_COLOR);
1420 print_all_uri_handlers (void)
1422 GList *plugins, *p, *features, *f;
1424 plugins = gst_registry_get_plugin_list (gst_registry_get ());
1425 if (sort_output == SORT_TYPE_NAME)
1426 plugins = g_list_sort (plugins, gst_plugin_name_compare_func);
1427 for (p = plugins; p; p = p->next) {
1428 GstPlugin *plugin = (GstPlugin *) (p->data);
1431 gst_registry_get_feature_list_by_plugin (gst_registry_get (),
1432 gst_plugin_get_name (plugin));
1433 if (sort_output == SORT_TYPE_NAME)
1434 features = g_list_sort (features, gst_plugin_feature_name_compare_func);
1435 for (f = features; f; f = f->next) {
1436 GstPluginFeature *feature = GST_PLUGIN_FEATURE (f->data);
1438 if (GST_IS_ELEMENT_FACTORY (feature)) {
1439 GstElementFactory *factory;
1440 GstElement *element;
1442 factory = GST_ELEMENT_FACTORY (gst_plugin_feature_load (feature));
1444 g_print ("element plugin %s couldn't be loaded\n",
1445 gst_plugin_get_name (plugin));
1449 element = gst_element_factory_create (factory, NULL);
1451 g_print ("couldn't construct element for %s for some reason\n",
1452 GST_OBJECT_NAME (factory));
1453 gst_object_unref (factory);
1457 if (GST_IS_URI_HANDLER (element)) {
1458 const gchar *const *uri_protocols;
1459 const gchar *const *protocol;
1462 switch (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element))) {
1474 g_print ("%s%s%s (%s%s%s, %srank %u%s): ",
1476 gst_plugin_feature_get_name (GST_PLUGIN_FEATURE (factory)),
1477 RESET_COLOR, FEATURE_DIR_COLOR, dir, RESET_COLOR,
1479 gst_plugin_feature_get_rank (GST_PLUGIN_FEATURE (factory)),
1483 gst_uri_handler_get_protocols (GST_URI_HANDLER (element));
1484 for (protocol = uri_protocols; *protocol != NULL; protocol++) {
1485 if (protocol != uri_protocols)
1487 g_print ("%s%s%s", FEATURE_PROTO_COLOR, *protocol, RESET_COLOR);
1492 gst_object_unref (element);
1493 gst_object_unref (factory);
1497 gst_plugin_feature_list_free (features);
1500 gst_plugin_list_free (plugins);
1504 print_plugin_info (GstPlugin * plugin)
1506 const gchar *plugin_name = gst_plugin_get_name (plugin);
1507 const gchar *release_date = gst_plugin_get_release_date_string (plugin);
1508 const gchar *filename = gst_plugin_get_filename (plugin);
1509 const gchar *module = gst_plugin_get_source (plugin);
1510 const gchar *origin = gst_plugin_get_origin (plugin);
1512 n_print ("%sPlugin Details%s:\n", HEADING_COLOR, RESET_COLOR);
1516 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "Name", RESET_COLOR,
1517 PROP_VALUE_COLOR, plugin_name, RESET_COLOR);
1518 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "Description", RESET_COLOR,
1519 PROP_VALUE_COLOR, gst_plugin_get_description (plugin), RESET_COLOR);
1520 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "Filename", RESET_COLOR,
1521 PROP_VALUE_COLOR, (filename != NULL) ? filename : "(null)", RESET_COLOR);
1522 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "Version", RESET_COLOR,
1523 PROP_VALUE_COLOR, gst_plugin_get_version (plugin), RESET_COLOR);
1524 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "License", RESET_COLOR,
1525 PROP_VALUE_COLOR, gst_plugin_get_license (plugin), RESET_COLOR);
1526 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "Source module", RESET_COLOR,
1527 PROP_VALUE_COLOR, module, RESET_COLOR);
1529 /* gst-plugins-rs has per-plugin module names so need to check origin there */
1530 if (g_strv_contains (gstreamer_modules, module)
1531 || (origin != NULL && g_str_has_suffix (origin, "/gst-plugins-rs"))) {
1532 n_print ("%s%-25s%s%s%s/%s/%s\n", PROP_NAME_COLOR, "Documentation",
1533 RESET_COLOR, PROP_VALUE_COLOR, GST_DOC_BASE_URL, plugin_name,
1537 if (release_date != NULL) {
1538 const gchar *tz = "(UTC)";
1541 /* may be: YYYY-MM-DD or YYYY-MM-DDTHH:MMZ */
1542 /* YYYY-MM-DDTHH:MMZ => YYYY-MM-DD HH:MM (UTC) */
1543 str = g_strdup (release_date);
1544 sep = strstr (str, "T");
1547 sep = strstr (sep + 1, "Z");
1553 n_print ("%s%-25s%s%s%s%s%s\n", PROP_NAME_COLOR, "Source release date",
1554 RESET_COLOR, PROP_VALUE_COLOR, str, tz, RESET_COLOR);
1557 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "Binary package", RESET_COLOR,
1558 PROP_VALUE_COLOR, gst_plugin_get_package (plugin), RESET_COLOR);
1559 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "Origin URL", RESET_COLOR,
1560 PROP_VALUE_COLOR, gst_plugin_get_origin (plugin), RESET_COLOR);
1568 print_plugin_features (GstPlugin * plugin)
1570 GList *features, *origlist;
1571 gint num_features = 0;
1572 gint num_elements = 0;
1573 gint num_tracers = 0;
1574 gint num_typefinders = 0;
1575 gint num_devproviders = 0;
1578 origlist = features =
1579 gst_registry_get_feature_list_by_plugin (gst_registry_get (),
1580 gst_plugin_get_name (plugin));
1581 if (sort_output == SORT_TYPE_NAME)
1582 features = g_list_sort (features, gst_plugin_feature_name_compare_func);
1584 GstPluginFeature *feature;
1586 feature = GST_PLUGIN_FEATURE (features->data);
1588 if (GST_IS_ELEMENT_FACTORY (feature)) {
1589 GstElementFactory *factory;
1591 factory = GST_ELEMENT_FACTORY (feature);
1592 n_print (" %s%s%s: %s%s%s\n", ELEMENT_NAME_COLOR,
1593 GST_OBJECT_NAME (factory), RESET_COLOR, ELEMENT_DETAIL_COLOR,
1594 gst_element_factory_get_metadata (factory,
1595 GST_ELEMENT_METADATA_LONGNAME), RESET_COLOR);
1597 } else if (GST_IS_TYPE_FIND_FACTORY (feature)) {
1598 GstTypeFindFactory *factory;
1599 const gchar *const *extensions;
1601 factory = GST_TYPE_FIND_FACTORY (feature);
1602 extensions = gst_type_find_factory_get_extensions (factory);
1604 g_print (" %s%s%s: ", ELEMENT_NAME_COLOR,
1605 gst_plugin_feature_get_name (feature), RESET_COLOR);
1606 print_typefind_extensions (extensions, ELEMENT_DETAIL_COLOR);
1609 g_print (" %s%s%s: %sno extensions%s\n", ELEMENT_NAME_COLOR,
1610 gst_plugin_feature_get_name (feature), RESET_COLOR,
1611 ELEMENT_DETAIL_COLOR, RESET_COLOR);
1614 } else if (GST_IS_DEVICE_PROVIDER_FACTORY (feature)) {
1615 GstDeviceProviderFactory *factory;
1617 factory = GST_DEVICE_PROVIDER_FACTORY (feature);
1618 n_print (" %s%s%s: %s%s%s\n", ELEMENT_NAME_COLOR,
1619 GST_OBJECT_NAME (factory), RESET_COLOR, ELEMENT_DETAIL_COLOR,
1620 gst_device_provider_factory_get_metadata (factory,
1621 GST_ELEMENT_METADATA_LONGNAME), RESET_COLOR);
1623 } else if (GST_IS_TRACER_FACTORY (feature)) {
1624 n_print (" %s%s%s (%s%s%s)\n", ELEMENT_NAME_COLOR,
1625 gst_object_get_name (GST_OBJECT (feature)), RESET_COLOR,
1626 DATATYPE_COLOR, g_type_name (G_OBJECT_TYPE (feature)), RESET_COLOR);
1628 } else if (feature) {
1629 n_print (" %s%s%s (%s%s%s)\n", ELEMENT_NAME_COLOR,
1630 gst_object_get_name (GST_OBJECT (feature)), RESET_COLOR,
1631 DATATYPE_COLOR, g_type_name (G_OBJECT_TYPE (feature)), RESET_COLOR);
1635 features = g_list_next (features);
1638 gst_plugin_feature_list_free (origlist);
1641 n_print (" %s%d features%s:\n", HEADING_COLOR, num_features, RESET_COLOR);
1642 if (num_elements > 0)
1643 n_print (" %s+--%s %s%d elements%s\n", CHILD_LINK_COLOR, RESET_COLOR,
1644 PLUGIN_FEATURE_COLOR, num_elements, RESET_COLOR);
1645 if (num_typefinders > 0)
1646 n_print (" %s+--%s %s%d typefinders%s\n", CHILD_LINK_COLOR, RESET_COLOR,
1647 PLUGIN_FEATURE_COLOR, num_typefinders, RESET_COLOR);
1648 if (num_devproviders > 0)
1649 n_print (" %s+--%s %s%d device providers%s\n", CHILD_LINK_COLOR,
1650 RESET_COLOR, PLUGIN_FEATURE_COLOR, num_devproviders, RESET_COLOR);
1651 if (num_tracers > 0)
1652 n_print (" %s+--%s %s%d tracers%s\n", CHILD_LINK_COLOR, RESET_COLOR,
1653 PLUGIN_FEATURE_COLOR, num_tracers, RESET_COLOR);
1655 n_print (" %s+--%s %s%d other objects%s\n", CHILD_LINK_COLOR, RESET_COLOR,
1656 PLUGIN_FEATURE_COLOR, num_other, RESET_COLOR);
1662 print_feature_info (const gchar * feature_name, gboolean print_all)
1664 GstPluginFeature *feature;
1665 GstRegistry *registry = gst_registry_get ();
1668 if ((feature = gst_registry_find_feature (registry, feature_name,
1669 GST_TYPE_ELEMENT_FACTORY))) {
1670 ret = print_element_info (feature, print_all);
1673 if ((feature = gst_registry_find_feature (registry, feature_name,
1674 GST_TYPE_TYPE_FIND_FACTORY))) {
1675 ret = print_typefind_info (feature, print_all);
1678 if ((feature = gst_registry_find_feature (registry, feature_name,
1679 GST_TYPE_TRACER_FACTORY))) {
1680 ret = print_tracer_info (feature, print_all);
1684 /* TODO: handle DEVICE_PROVIDER_FACTORY */
1689 gst_object_unref (feature);
1694 print_element_info (GstPluginFeature * feature, gboolean print_names)
1696 GstElementFactory *factory;
1697 GstElement *element;
1701 factory = GST_ELEMENT_FACTORY (gst_plugin_feature_load (feature));
1703 g_print ("%selement plugin couldn't be loaded%s\n", DESC_COLOR,
1708 element = gst_element_factory_create (factory, NULL);
1710 gst_object_unref (factory);
1711 g_print ("%scouldn't construct element for some reason%s\n", DESC_COLOR,
1718 g_strdup_printf ("%s%s%s: ", DATATYPE_COLOR, GST_OBJECT_NAME (factory),
1723 plugin = gst_plugin_feature_get_plugin (GST_PLUGIN_FEATURE (factory));
1725 print_factory_details_info (factory, plugin);
1728 print_plugin_info (plugin);
1729 gst_object_unref (plugin);
1732 print_hierarchy (G_OBJECT_TYPE (element), 0, &maxlevel);
1733 print_interfaces (G_OBJECT_TYPE (element));
1735 print_pad_templates_info (element, factory);
1736 print_clocking_info (element);
1737 print_uri_handler_info (element);
1738 print_pad_info (element);
1739 print_element_properties_info (element);
1740 print_signal_info (element);
1741 print_children_info (element);
1742 print_preset_list (element);
1744 gst_object_unref (element);
1745 gst_object_unref (factory);
1751 print_typefind_info (GstPluginFeature * feature, gboolean print_names)
1753 GstTypeFindFactory *factory;
1758 const gchar *const *extensions;
1760 factory = GST_TYPE_FIND_FACTORY (gst_plugin_feature_load (feature));
1762 g_print ("%stypefind plugin couldn't be loaded%s\n", DESC_COLOR,
1769 g_strdup_printf ("%s%s%s: ", DATATYPE_COLOR, GST_OBJECT_NAME (factory),
1774 n_print ("%sFactory Details%s:\n", HEADING_COLOR, RESET_COLOR);
1775 rank = gst_plugin_feature_get_rank (feature);
1776 n_print (" %s%-25s%s%s (%d)%s\n", PROP_NAME_COLOR, "Rank", PROP_VALUE_COLOR,
1777 get_rank_name (s, rank), rank, RESET_COLOR);
1778 n_print (" %s%-25s%s%s%s\n", PROP_NAME_COLOR, "Name", PROP_VALUE_COLOR,
1779 GST_OBJECT_NAME (factory), RESET_COLOR);
1780 caps = gst_type_find_factory_get_caps (factory);
1782 gchar *caps_str = gst_caps_to_string (factory->caps);
1784 n_print (" %s%-25s%s%s%s\n", PROP_NAME_COLOR, "Caps", PROP_VALUE_COLOR,
1785 caps_str, RESET_COLOR);
1788 extensions = gst_type_find_factory_get_extensions (factory);
1790 n_print (" %s%-25s%s", PROP_NAME_COLOR, "Extensions", RESET_COLOR);
1791 print_typefind_extensions (extensions, PROP_VALUE_COLOR);
1796 plugin = gst_plugin_feature_get_plugin (GST_PLUGIN_FEATURE (factory));
1798 print_plugin_info (plugin);
1799 gst_object_unref (plugin);
1802 gst_object_unref (factory);
1808 print_tracer_info (GstPluginFeature * feature, gboolean print_names)
1810 GstTracerFactory *factory;
1815 factory = GST_TRACER_FACTORY (gst_plugin_feature_load (feature));
1817 g_print ("%stracer plugin couldn't be loaded%s\n", DESC_COLOR, RESET_COLOR);
1821 tracer = (GstTracer *) g_object_new (factory->type, NULL);
1823 gst_object_unref (factory);
1824 g_print ("%scouldn't construct tracer for some reason%s\n", DESC_COLOR,
1831 g_strdup_printf ("%s%s%s: ", DATATYPE_COLOR, GST_OBJECT_NAME (factory),
1836 n_print ("%sFactory Details%s:\n", HEADING_COLOR, RESET_COLOR);
1837 n_print (" %s%-25s%s%s%s\n", PROP_NAME_COLOR, "Name", PROP_VALUE_COLOR,
1838 GST_OBJECT_NAME (factory), RESET_COLOR);
1841 plugin = gst_plugin_feature_get_plugin (GST_PLUGIN_FEATURE (factory));
1843 print_plugin_info (plugin);
1844 gst_object_unref (plugin);
1847 print_hierarchy (G_OBJECT_TYPE (tracer), 0, &maxlevel);
1848 print_interfaces (G_OBJECT_TYPE (tracer));
1850 /* TODO: list what hooks it registers
1851 * - the data is available in gsttracerutils, we need to iterate the
1852 * _priv_tracers hashtable for each probe and then check the list of hooks
1853 * for each probe whether hook->tracer == tracer :/
1856 /* TODO: list what records it emits
1857 * - in class_init tracers can create GstTracerRecord instances
1858 * - those only get logged right now and there is no association with the
1859 * tracer that created them
1860 * - we'd need to add them to GstTracerFactory
1861 * gst_tracer_class_add_record (klass, record);
1862 * - needs work in gstregistrychunks to (de)serialize specs
1863 * - gst_tracer_register() would need to iterate the list of records and
1864 * copy the record->spec into the factory
1867 gst_object_unref (tracer);
1868 gst_object_unref (factory);
1873 /* NOTE: Not coloring output from automatic install functions, as their output
1874 * is meant for machines, not humans.
1877 print_plugin_automatic_install_info_codecs (GstElementFactory * factory)
1879 GstPadDirection direction;
1880 const gchar *type_name;
1882 const GList *static_templates, *l;
1883 GstCaps *caps = NULL;
1887 gst_element_factory_get_metadata (factory, GST_ELEMENT_METADATA_KLASS);
1888 g_return_if_fail (klass != NULL);
1890 if (strstr (klass, "Demuxer") ||
1891 strstr (klass, "Decoder") ||
1892 strstr (klass, "Depay") || strstr (klass, "Parser")) {
1893 type_name = "decoder";
1894 direction = GST_PAD_SINK;
1895 } else if (strstr (klass, "Muxer") ||
1896 strstr (klass, "Encoder") || strstr (klass, "Pay")) {
1897 type_name = "encoder";
1898 direction = GST_PAD_SRC;
1903 /* decoder/demuxer sink pads should always be static and there should only
1904 * be one, the same applies to encoders/muxers and source pads */
1905 static_templates = gst_element_factory_get_static_pad_templates (factory);
1906 for (l = static_templates; l != NULL; l = l->next) {
1907 GstStaticPadTemplate *tmpl = NULL;
1909 tmpl = (GstStaticPadTemplate *) l->data;
1910 if (tmpl->direction == direction) {
1911 caps = gst_static_pad_template_get_caps (tmpl);
1917 g_printerr ("Couldn't find static pad template for %s '%s'\n",
1918 type_name, GST_OBJECT_NAME (factory));
1922 caps = gst_caps_make_writable (caps);
1923 num = gst_caps_get_size (caps);
1924 for (i = 0; i < num; ++i) {
1928 s = gst_caps_get_structure (caps, i);
1929 /* remove fields that are almost always just MIN-MAX of some sort
1930 * in order to make the caps look less messy */
1931 gst_structure_remove_field (s, "pixel-aspect-ratio");
1932 gst_structure_remove_field (s, "framerate");
1933 gst_structure_remove_field (s, "channels");
1934 gst_structure_remove_field (s, "width");
1935 gst_structure_remove_field (s, "height");
1936 gst_structure_remove_field (s, "rate");
1937 gst_structure_remove_field (s, "depth");
1938 gst_structure_remove_field (s, "clock-rate");
1939 s_str = gst_structure_to_string (s);
1940 g_print ("%s-%s\n", type_name, s_str);
1943 gst_caps_unref (caps);
1947 print_plugin_automatic_install_info_protocols (GstElementFactory * factory)
1949 const gchar *const *protocols;
1951 protocols = gst_element_factory_get_uri_protocols (factory);
1952 if (protocols != NULL && *protocols != NULL) {
1953 switch (gst_element_factory_get_uri_type (factory)) {
1955 while (*protocols != NULL) {
1956 g_print ("urisink-%s\n", *protocols);
1961 while (*protocols != NULL) {
1962 g_print ("urisource-%s\n", *protocols);
1973 print_plugin_automatic_install_info (GstPlugin * plugin)
1975 GList *features, *l;
1977 /* not interested in typefind factories, only element factories */
1978 features = gst_registry_get_feature_list (gst_registry_get (),
1979 GST_TYPE_ELEMENT_FACTORY);
1981 for (l = features; l != NULL; l = l->next) {
1982 GstPluginFeature *feature;
1983 GstPlugin *feature_plugin;
1985 feature = GST_PLUGIN_FEATURE (l->data);
1987 /* only interested in the ones that are in the plugin we just loaded */
1988 feature_plugin = gst_plugin_feature_get_plugin (feature);
1989 if (feature_plugin == plugin) {
1990 GstElementFactory *factory;
1992 g_print ("element-%s\n", gst_plugin_feature_get_name (feature));
1994 factory = GST_ELEMENT_FACTORY (feature);
1995 print_plugin_automatic_install_info_protocols (factory);
1996 print_plugin_automatic_install_info_codecs (factory);
1999 gst_object_unref (feature_plugin);
2002 g_list_foreach (features, (GFunc) gst_object_unref, NULL);
2003 g_list_free (features);
2007 print_all_plugin_automatic_install_info (void)
2009 GList *plugins, *orig_plugins;
2011 orig_plugins = plugins = gst_registry_get_plugin_list (gst_registry_get ());
2012 if (sort_output == SORT_TYPE_NAME)
2013 plugins = g_list_sort (plugins, gst_plugin_name_compare_func);
2017 plugin = (GstPlugin *) (plugins->data);
2018 plugins = g_list_next (plugins);
2020 print_plugin_automatic_install_info (plugin);
2022 gst_plugin_list_free (orig_plugins);
2027 redirect_stdout (void)
2029 GError *error = NULL;
2031 const gchar *pager, *less;
2035 pager = g_getenv ("PAGER");
2037 pager = DEFAULT_PAGER;
2039 argv = g_strsplit (pager, " ", 0);
2041 less = g_getenv ("GST_LESS");
2043 less = DEFAULT_LESS_OPTS;
2045 envp = g_get_environ ();
2046 envp = g_environ_setenv (envp, "LESS", less, TRUE);
2048 if (!g_spawn_async_with_pipes (NULL, argv, envp,
2049 G_SPAWN_DO_NOT_REAP_CHILD | G_SPAWN_SEARCH_PATH,
2050 NULL, NULL, &child_pid, &stdin_fd,
2051 /* pass null stdout/stderr to inherit our fds */
2052 NULL, NULL, &error)) {
2053 if (pager != DEFAULT_PAGER) {
2054 g_warning ("g_spawn_async_with_pipes() failed: %s\n",
2055 GST_STR_NULL (error->message));
2059 g_clear_error (&error);
2064 /* redirect our stdout to child stdin */
2065 dup2 (stdin_fd, STDOUT_FILENO);
2066 if (isatty (STDERR_FILENO))
2067 dup2 (stdin_fd, STDERR_FILENO);
2077 child_exit_cb (GPid child_pid, gint status, gpointer user_data)
2079 g_spawn_close_pid (child_pid);
2080 g_main_loop_quit (loop);
2085 _parse_sort_type (const gchar * option_name, const gchar * optarg,
2086 gpointer data, GError ** error)
2088 if (!g_strcmp0 (optarg, "name")) {
2089 sort_output = SORT_TYPE_NAME;
2091 } else if (!g_strcmp0 (optarg, "none")) {
2092 sort_output = SORT_TYPE_NONE;
2100 real_main (int argc, char *argv[])
2102 gboolean print_all = FALSE;
2103 gboolean do_print_blacklist = FALSE;
2104 gboolean plugin_name = FALSE;
2105 gboolean print_aii = FALSE;
2106 gboolean uri_handlers = FALSE;
2107 gboolean check_exists = FALSE;
2108 gboolean color_always = FALSE;
2109 gchar *min_version = NULL;
2110 guint minver_maj = GST_VERSION_MAJOR;
2111 guint minver_min = GST_VERSION_MINOR;
2112 guint minver_micro = 0;
2113 gchar *types = NULL;
2114 const gchar *no_colors;
2116 #ifndef GST_DISABLE_OPTION_PARSING
2117 GOptionEntry options[] = {
2118 {"print-all", 'a', 0, G_OPTION_ARG_NONE, &print_all,
2119 N_("Print all elements"), NULL},
2120 {"print-blacklist", 'b', 0, G_OPTION_ARG_NONE, &do_print_blacklist,
2121 N_("Print list of blacklisted files"), NULL},
2122 {"print-plugin-auto-install-info", '\0', 0, G_OPTION_ARG_NONE, &print_aii,
2123 N_("Print a machine-parsable list of features the specified plugin "
2124 "or all plugins provide.\n "
2125 "Useful in connection with external automatic plugin "
2126 "installation mechanisms"), NULL},
2127 {"plugin", '\0', 0, G_OPTION_ARG_NONE, &plugin_name,
2128 N_("List the plugin contents"), NULL},
2129 {"types", 't', 0, G_OPTION_ARG_STRING, &types,
2130 N_("A slashes ('/') separated list of types of elements (also known "
2131 "as klass) to list. (unordered)"), NULL},
2132 {"exists", '\0', 0, G_OPTION_ARG_NONE, &check_exists,
2133 N_("Check if the specified element or plugin exists"), NULL},
2134 {"atleast-version", '\0', 0, G_OPTION_ARG_STRING, &min_version,
2136 ("When checking if an element or plugin exists, also check that its "
2137 "version is at least the version specified"), NULL},
2138 {"uri-handlers", 'u', 0, G_OPTION_ARG_NONE, &uri_handlers,
2140 ("Print supported URI schemes, with the elements that implement them"),
2142 {"no-colors", '\0', G_OPTION_FLAG_REVERSE, G_OPTION_ARG_NONE,
2145 ("Disable colors in output. You can also achieve the same by setting "
2146 "'GST_INSPECT_NO_COLORS' environment variable to any value."),
2148 {"sort", '\0', G_OPTION_ARG_NONE, G_OPTION_ARG_CALLBACK, &_parse_sort_type,
2149 "Sort plugins and features. Sorting keys: name (default), none.",
2152 {"color", 'C', 0, G_OPTION_ARG_NONE, &color_always,
2153 N_("Color output, even when not sending to a tty."),
2155 GST_TOOLS_GOPTION_VERSION,
2158 GOptionContext *ctx;
2162 setlocale (LC_ALL, "");
2165 bindtextdomain (GETTEXT_PACKAGE, LOCALEDIR);
2166 bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
2167 textdomain (GETTEXT_PACKAGE);
2170 /* avoid glib warnings when inspecting deprecated properties */
2171 g_setenv ("G_ENABLE_DIAGNOSTIC", "0", FALSE);
2173 g_set_prgname ("gst-inspect-" GST_API_VERSION);
2175 #ifndef GST_DISABLE_OPTION_PARSING
2176 ctx = g_option_context_new ("[ELEMENT-NAME | PLUGIN-NAME]");
2177 g_option_context_add_main_entries (ctx, options, GETTEXT_PACKAGE);
2178 g_option_context_add_group (ctx, gst_init_get_option_group ());
2179 #if defined(G_OS_WIN32) && !defined(GST_CHECK_MAIN)
2180 if (!g_option_context_parse_strv (ctx, &argv, &err))
2182 if (!g_option_context_parse (ctx, &argc, &argv, &err))
2185 g_printerr ("Error initializing: %s\n", err->message);
2186 g_clear_error (&err);
2187 g_option_context_free (ctx);
2190 g_option_context_free (ctx);
2192 gst_init (&argc, &argv);
2195 #if defined(G_OS_WIN32) && !defined(GST_CHECK_MAIN)
2196 argc = g_strv_length (argv);
2199 gst_tools_print_version ();
2201 if (print_all && argc > 1) {
2202 g_printerr ("-a requires no extra arguments\n");
2206 if (uri_handlers && argc > 1) {
2207 g_printerr ("-u requires no extra arguments\n");
2211 /* --atleast-version implies --exists */
2212 if (min_version != NULL) {
2213 if (sscanf (min_version, "%u.%u.%u", &minver_maj, &minver_min,
2214 &minver_micro) < 2) {
2215 g_printerr ("Can't parse version '%s' passed to --atleast-version\n",
2217 g_free (min_version);
2220 g_free (min_version);
2221 check_exists = TRUE;
2226 g_printerr ("--exists requires an extra command line argument\n");
2230 GstPluginFeature *feature;
2232 feature = gst_registry_lookup_feature (gst_registry_get (), argv[1]);
2233 if (feature != NULL && gst_plugin_feature_check_version (feature,
2234 minver_maj, minver_min, minver_micro)) {
2241 gst_object_unref (feature);
2243 /* FIXME: support checking for plugins too */
2244 g_printerr ("Checking for plugins is not supported yet\n");
2251 no_colors = g_getenv ("GST_INSPECT_NO_COLORS");
2252 /* We only support truecolor */
2253 colored_output &= (no_colors == NULL);
2256 if (isatty (STDOUT_FILENO)) {
2257 if (redirect_stdout ())
2258 loop = g_main_loop_new (NULL, FALSE);
2260 colored_output = (color_always) ? TRUE : FALSE;
2262 #elif defined(G_OS_WIN32)
2264 /* g_log_writer_supports_color is available since 2.50.0 */
2265 gint fd = _fileno (stdout);
2266 /* On Windows 10, g_log_writer_supports_color will also setup the console
2267 * so that it correctly interprets ANSI VT sequences if it's supported */
2268 if (!_isatty (fd) || !g_log_writer_supports_color (fd))
2269 colored_output = FALSE;
2273 /* if no arguments, print out list of elements */
2275 print_all_uri_handlers ();
2276 } else if (argc == 1 || print_all) {
2277 if (do_print_blacklist)
2281 print_all_plugin_automatic_install_info ();
2283 print_element_list (print_all, types);
2286 /* else we try to get a factory */
2287 const char *arg = argv[argc - 1];
2291 retval = print_feature_info (arg, print_all);
2294 /* otherwise check if it's a plugin */
2296 GstPlugin *plugin = gst_registry_find_plugin (gst_registry_get (), arg);
2298 /* if there is such a plugin, print out info */
2301 print_plugin_automatic_install_info (plugin);
2303 print_plugin_info (plugin);
2304 print_plugin_features (plugin);
2307 GError *error = NULL;
2309 if (g_file_test (arg, G_FILE_TEST_EXISTS)) {
2310 plugin = gst_plugin_load_file (arg, &error);
2314 print_plugin_automatic_install_info (plugin);
2316 print_plugin_info (plugin);
2317 print_plugin_features (plugin);
2320 g_printerr (_("Could not load plugin file: %s\n"), error->message);
2321 g_clear_error (&error);
2326 g_printerr (_("No such element or plugin '%s'\n"), arg);
2340 /* So that the pipe we create in redirect_stdout() is closed */
2341 close (STDOUT_FILENO);
2342 close (STDERR_FILENO);
2343 g_child_watch_add (child_pid, child_exit_cb, NULL);
2344 g_main_loop_run (loop);
2345 g_main_loop_unref (loop);
2353 main (int argc, char *argv[])
2357 /* gstinspect.c calls this function */
2358 #if defined(G_OS_WIN32) && !defined(GST_CHECK_MAIN)
2359 argv = g_win32_get_command_line ();
2362 #if defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE
2363 ret = gst_macos_main ((GstMainFunc) real_main, argc, argv, NULL);
2365 ret = real_main (argc, argv);
2368 #if defined(G_OS_WIN32) && !defined(GST_CHECK_MAIN)