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>
6 * gst-inspect.c: tool to inspect the GStreamer registry
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
21 * Boston, MA 02110-1301, USA.
28 /* FIXME 2.0: suppress warnings for deprecated API such as GValueArray
29 * with newer GLib versions (>= 2.31.0) */
30 #define GLIB_DISABLE_DEPRECATION_WARNINGS
33 #include <gst/gst_private.h> /* for internal Factories */
37 #include <glib/gprintf.h>
39 static char *_name = NULL;
40 static int indent = 0;
42 static int print_element_info (GstPluginFeature * feature,
43 gboolean print_names);
44 static int print_typefind_info (GstPluginFeature * feature,
45 gboolean print_names);
46 static int print_tracer_info (GstPluginFeature * feature, gboolean print_names);
48 #define push_indent() push_indent_n(1)
49 #define pop_indent() push_indent_n(-1)
50 #define pop_indent_n(n) push_indent_n(-n)
55 g_assert (n > 0 || indent > 0);
64 n_print (const char *format, ...)
70 g_print ("%s", _name);
72 for (i = 0; i < indent; ++i)
75 va_start (args, format);
76 g_vprintf (format, args);
81 print_field (GQuark field, const GValue * value, gpointer pfx)
83 gchar *str = gst_value_serialize (value);
85 n_print ("%s %15s: %s\n", (gchar *) pfx, g_quark_to_string (field), str);
91 print_caps (const GstCaps * caps, const gchar * pfx)
95 g_return_if_fail (caps != NULL);
97 if (gst_caps_is_any (caps)) {
98 n_print ("%sANY\n", pfx);
101 if (gst_caps_is_empty (caps)) {
102 n_print ("%sEMPTY\n", pfx);
106 for (i = 0; i < gst_caps_get_size (caps); i++) {
107 GstStructure *structure = gst_caps_get_structure (caps, i);
108 GstCapsFeatures *features = gst_caps_get_features (caps, i);
110 if (features && (gst_caps_features_is_any (features) ||
111 !gst_caps_features_is_equal (features,
112 GST_CAPS_FEATURES_MEMORY_SYSTEM_MEMORY))) {
113 gchar *features_string = gst_caps_features_to_string (features);
115 n_print ("%s%s(%s)\n", pfx, gst_structure_get_name (structure),
117 g_free (features_string);
119 n_print ("%s%s\n", pfx, gst_structure_get_name (structure));
121 gst_structure_foreach (structure, print_field, (gpointer) pfx);
126 get_rank_name (char *s, gint rank)
128 static const int ranks[4] = {
129 GST_RANK_NONE, GST_RANK_MARGINAL, GST_RANK_SECONDARY, GST_RANK_PRIMARY
131 static const char *rank_names[4] = { "none", "marginal", "secondary",
138 for (i = 0; i < 4; i++) {
139 if (rank == ranks[i])
140 return rank_names[i];
141 if (abs (rank - ranks[i]) < abs (rank - ranks[best_i])) {
146 sprintf (s, "%s %c %d", rank_names[best_i],
147 (rank - ranks[best_i] > 0) ? '+' : '-', abs (ranks[best_i] - rank));
153 print_factory_details_info (GstElementFactory * factory)
159 rank = gst_plugin_feature_get_rank (GST_PLUGIN_FEATURE (factory));
160 n_print ("Factory Details:\n");
163 n_print ("%-25s%s (%d)\n", "Rank", get_rank_name (s, rank), rank);
165 keys = gst_element_factory_get_metadata_keys (factory);
167 for (k = keys; *k != NULL; ++k) {
171 val = gst_element_factory_get_metadata (factory, key);
172 key[0] = g_ascii_toupper (key[0]);
173 n_print ("%-25s%s\n", key, val);
182 print_hierarchy (GType type, gint level, gint * maxlevel)
187 parent = g_type_parent (type);
189 *maxlevel = *maxlevel + 1;
193 print_hierarchy (parent, level, maxlevel);
196 g_print ("%s", _name);
198 for (i = 1; i < *maxlevel - level; i++)
200 if (*maxlevel - level)
203 g_print ("%s\n", g_type_name (type));
210 print_interfaces (GType type)
213 GType *iface, *ifaces = g_type_interfaces (type, &n_ifaces);
217 n_print (_("Implemented Interfaces:\n"));
221 n_print ("%s\n", g_type_name (*iface));
232 flags_to_string (GFlagsValue * vals, guint flags)
237 /* first look for an exact match and count the number of values */
238 for (i = 0; vals[i].value_name != NULL; ++i) {
239 if (vals[i].value == flags)
240 return g_strdup (vals[i].value_nick);
243 s = g_string_new (NULL);
245 /* we assume the values are sorted from lowest to highest value */
249 if (vals[i].value != 0 && (flags_left & vals[i].value) == vals[i].value) {
251 g_string_append_c (s, '+');
252 g_string_append (s, vals[i].value_nick);
253 flags_left -= vals[i].value;
260 g_string_assign (s, "(none)");
262 return g_string_free (s, FALSE);
265 #define KNOWN_PARAM_FLAGS \
266 (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY | \
267 G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS | \
268 G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_DEPRECATED | \
269 GST_PARAM_CONTROLLABLE | GST_PARAM_MUTABLE_PLAYING | \
270 GST_PARAM_MUTABLE_PAUSED | GST_PARAM_MUTABLE_READY)
273 print_element_properties_info (GstElement * element)
275 GParamSpec **property_specs;
276 guint num_properties, i;
280 property_specs = g_object_class_list_properties
281 (G_OBJECT_GET_CLASS (element), &num_properties);
283 n_print ("Element Properties:\n");
287 for (i = 0; i < num_properties; i++) {
288 GValue value = { 0, };
289 GParamSpec *param = property_specs[i];
293 g_value_init (&value, param->value_type);
295 n_print ("%-20s: %s\n", g_param_spec_get_name (param),
296 g_param_spec_get_blurb (param));
302 if (param->flags & G_PARAM_READABLE) {
303 g_object_get_property (G_OBJECT (element), param->name, &value);
305 g_print ("%s%s", (first_flag) ? "" : ", ", _("readable"));
308 /* if we can't read the property value, assume it's set to the default
309 * (which might not be entirely true for sub-classes, but that's an
310 * unlikely corner-case anyway) */
311 g_param_value_set_default (param, &value);
313 if (param->flags & G_PARAM_WRITABLE) {
314 g_print ("%s%s", (first_flag) ? "" : ", ", _("writable"));
317 if (param->flags & G_PARAM_DEPRECATED) {
318 g_print ("%s%s", (first_flag) ? "" : ", ", _("deprecated"));
321 if (param->flags & GST_PARAM_CONTROLLABLE) {
322 g_print (", %s", _("controllable"));
325 if (param->flags & GST_PARAM_MUTABLE_PLAYING) {
326 g_print (", %s", _("changeable in NULL, READY, PAUSED or PLAYING state"));
327 } else if (param->flags & GST_PARAM_MUTABLE_PAUSED) {
328 g_print (", %s", _("changeable only in NULL, READY or PAUSED state"));
329 } else if (param->flags & GST_PARAM_MUTABLE_READY) {
330 g_print (", %s", _("changeable only in NULL or READY state"));
332 if (param->flags & ~KNOWN_PARAM_FLAGS) {
333 g_print ("%s0x%0x", (first_flag) ? "" : ", ",
334 param->flags & ~KNOWN_PARAM_FLAGS);
338 switch (G_VALUE_TYPE (&value)) {
341 const char *string_val = g_value_get_string (&value);
343 n_print ("String. ");
345 if (string_val == NULL)
346 g_print ("Default: null");
348 g_print ("Default: \"%s\"", string_val);
353 gboolean bool_val = g_value_get_boolean (&value);
355 n_print ("Boolean. Default: %s", bool_val ? "true" : "false");
360 GParamSpecULong *pulong = G_PARAM_SPEC_ULONG (param);
362 n_print ("Unsigned Long. Range: %lu - %lu Default: %lu ",
363 pulong->minimum, pulong->maximum, g_value_get_ulong (&value));
365 GST_ERROR ("%s: property '%s' of type ulong: consider changing to "
366 "uint/uint64", GST_OBJECT_NAME (element),
367 g_param_spec_get_name (param));
372 GParamSpecLong *plong = G_PARAM_SPEC_LONG (param);
374 n_print ("Long. Range: %ld - %ld Default: %ld ",
375 plong->minimum, plong->maximum, g_value_get_long (&value));
377 GST_ERROR ("%s: property '%s' of type long: consider changing to "
378 "int/int64", GST_OBJECT_NAME (element),
379 g_param_spec_get_name (param));
384 GParamSpecUInt *puint = G_PARAM_SPEC_UINT (param);
386 n_print ("Unsigned Integer. Range: %u - %u Default: %u ",
387 puint->minimum, puint->maximum, g_value_get_uint (&value));
392 GParamSpecInt *pint = G_PARAM_SPEC_INT (param);
394 n_print ("Integer. Range: %d - %d Default: %d ",
395 pint->minimum, pint->maximum, g_value_get_int (&value));
400 GParamSpecUInt64 *puint64 = G_PARAM_SPEC_UINT64 (param);
402 n_print ("Unsigned Integer64. Range: %" G_GUINT64_FORMAT " - "
403 "%" G_GUINT64_FORMAT " Default: %" G_GUINT64_FORMAT " ",
404 puint64->minimum, puint64->maximum, g_value_get_uint64 (&value));
409 GParamSpecInt64 *pint64 = G_PARAM_SPEC_INT64 (param);
411 n_print ("Integer64. Range: %" G_GINT64_FORMAT " - %" G_GINT64_FORMAT
412 " Default: %" G_GINT64_FORMAT " ",
413 pint64->minimum, pint64->maximum, g_value_get_int64 (&value));
418 GParamSpecFloat *pfloat = G_PARAM_SPEC_FLOAT (param);
420 n_print ("Float. Range: %15.7g - %15.7g Default: %15.7g ",
421 pfloat->minimum, pfloat->maximum, g_value_get_float (&value));
426 GParamSpecDouble *pdouble = G_PARAM_SPEC_DOUBLE (param);
428 n_print ("Double. Range: %15.7g - %15.7g Default: %15.7g ",
429 pdouble->minimum, pdouble->maximum, g_value_get_double (&value));
434 GST_ERROR ("%s: property '%s' of type char: consider changing to "
435 "int/string", GST_OBJECT_NAME (element),
436 g_param_spec_get_name (param));
439 if (param->value_type == GST_TYPE_CAPS) {
440 const GstCaps *caps = gst_value_get_caps (&value);
443 n_print ("Caps (NULL)");
445 print_caps (caps, " ");
447 } else if (G_IS_PARAM_SPEC_ENUM (param)) {
451 const gchar *value_nick = "";
453 values = G_ENUM_CLASS (g_type_class_ref (param->value_type))->values;
454 enum_value = g_value_get_enum (&value);
456 while (values[j].value_name) {
457 if (values[j].value == enum_value)
458 value_nick = values[j].value_nick;
462 n_print ("Enum \"%s\" Default: %d, \"%s\"",
463 g_type_name (G_VALUE_TYPE (&value)), enum_value, value_nick);
466 while (values[j].value_name) {
468 n_print (" (%d): %-16s - %s",
469 values[j].value, values[j].value_nick, values[j].value_name);
472 /* g_type_class_unref (ec); */
473 } else if (G_IS_PARAM_SPEC_FLAGS (param)) {
474 GParamSpecFlags *pflags = G_PARAM_SPEC_FLAGS (param);
478 vals = pflags->flags_class->values;
480 cur = flags_to_string (vals, g_value_get_flags (&value));
482 n_print ("Flags \"%s\" Default: 0x%08x, \"%s\"",
483 g_type_name (G_VALUE_TYPE (&value)),
484 g_value_get_flags (&value), cur);
486 while (vals[0].value_name) {
488 n_print (" (0x%08x): %-16s - %s",
489 vals[0].value, vals[0].value_nick, vals[0].value_name);
494 } else if (G_IS_PARAM_SPEC_OBJECT (param)) {
495 n_print ("Object of type \"%s\"", g_type_name (param->value_type));
496 } else if (G_IS_PARAM_SPEC_BOXED (param)) {
497 n_print ("Boxed pointer of type \"%s\"",
498 g_type_name (param->value_type));
499 if (param->value_type == GST_TYPE_STRUCTURE) {
500 const GstStructure *s = gst_value_get_structure (&value);
502 gst_structure_foreach (s, print_field,
505 } else if (G_IS_PARAM_SPEC_POINTER (param)) {
506 if (param->value_type != G_TYPE_POINTER) {
507 n_print ("Pointer of type \"%s\".",
508 g_type_name (param->value_type));
510 n_print ("Pointer.");
512 } else if (param->value_type == G_TYPE_VALUE_ARRAY) {
513 GParamSpecValueArray *pvarray = G_PARAM_SPEC_VALUE_ARRAY (param);
515 if (pvarray->element_spec) {
516 n_print ("Array of GValues of type \"%s\"",
517 g_type_name (pvarray->element_spec->value_type));
519 n_print ("Array of GValues");
521 } else if (GST_IS_PARAM_SPEC_FRACTION (param)) {
522 GstParamSpecFraction *pfraction = GST_PARAM_SPEC_FRACTION (param);
524 n_print ("Fraction. Range: %d/%d - %d/%d Default: %d/%d ",
525 pfraction->min_num, pfraction->min_den,
526 pfraction->max_num, pfraction->max_den,
527 gst_value_get_fraction_numerator (&value),
528 gst_value_get_fraction_denominator (&value));
529 } else if (param->value_type == GST_TYPE_ARRAY) {
530 GstParamSpecArray *parray = GST_PARAM_SPEC_ARRAY_LIST (param);
532 if (parray->element_spec) {
533 n_print ("GstValueArray of GValues of type \"%s\"",
534 g_type_name (parray->element_spec->value_type));
536 n_print ("GstValueArray of GValues");
539 n_print ("Unknown type %ld \"%s\"",
540 (glong) param->value_type, g_type_name (param->value_type));
545 g_print (" Write only\n");
551 g_value_reset (&value);
553 if (num_properties == 0)
558 g_free (property_specs);
562 print_pad_templates_info (GstElement * element, GstElementFactory * factory)
565 GstStaticPadTemplate *padtemplate;
567 n_print ("Pad Templates:\n");
571 if (gst_element_factory_get_num_pad_templates (factory) == 0) {
576 pads = gst_element_factory_get_static_pad_templates (factory);
578 padtemplate = (GstStaticPadTemplate *) (pads->data);
579 pads = g_list_next (pads);
581 if (padtemplate->direction == GST_PAD_SRC)
582 n_print ("SRC template: '%s'\n", padtemplate->name_template);
583 else if (padtemplate->direction == GST_PAD_SINK)
584 n_print ("SINK template: '%s'\n", padtemplate->name_template);
586 n_print ("UNKNOWN template: '%s'\n", padtemplate->name_template);
590 if (padtemplate->presence == GST_PAD_ALWAYS)
591 n_print ("Availability: Always\n");
592 else if (padtemplate->presence == GST_PAD_SOMETIMES)
593 n_print ("Availability: Sometimes\n");
594 else if (padtemplate->presence == GST_PAD_REQUEST) {
595 n_print ("Availability: On request\n");
597 n_print ("Availability: UNKNOWN\n");
599 if (padtemplate->static_caps.string) {
600 GstCaps *caps = gst_static_caps_get (&padtemplate->static_caps);
602 n_print ("Capabilities:\n");
605 print_caps (caps, ""); // FIXME
608 gst_caps_unref (caps);
621 /* FIXME: should remove this if there is nothing interesting to print here */
623 print_element_flag_info (GstElement * element)
625 gboolean have_flags = FALSE;
628 n_print ("Element Flags:\n");
633 n_print ("no flags set\n");
637 if (GST_IS_BIN (element)) {
639 n_print ("Bin Flags:\n");
644 n_print (" no flags set\n");
651 print_clocking_info (GstElement * element)
653 gboolean requires_clock, provides_clock;
656 GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_REQUIRE_CLOCK);
658 GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_PROVIDE_CLOCK);
660 if (!requires_clock && !provides_clock) {
662 n_print ("Element has no clocking capabilities.\n");
667 n_print ("Clocking Interaction:\n");
671 if (requires_clock) {
672 n_print ("element requires a clock\n");
675 if (provides_clock) {
678 clock = gst_element_get_clock (element);
680 n_print ("element provides a clock: %s\n", GST_OBJECT_NAME (clock));
681 gst_object_unref (clock);
683 n_print ("element is supposed to provide a clock but returned NULL\n");
690 print_uri_handler_info (GstElement * element)
692 if (GST_IS_URI_HANDLER (element)) {
693 const gchar *const *uri_protocols;
694 const gchar *uri_type;
696 if (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element)) == GST_URI_SRC)
698 else if (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element)) ==
702 uri_type = "unknown";
704 uri_protocols = gst_uri_handler_get_protocols (GST_URI_HANDLER (element));
707 n_print ("URI handling capabilities:\n");
711 n_print ("Element can act as %s.\n", uri_type);
713 if (uri_protocols && *uri_protocols) {
714 n_print ("Supported URI protocols:\n");
716 for (; *uri_protocols != NULL; uri_protocols++)
717 n_print ("%s\n", *uri_protocols);
720 n_print ("No supported URI protocols\n");
725 n_print ("Element has no URI handling capabilities.\n");
730 print_pad_info (GstElement * element)
740 if (!element->numpads) {
745 pads = element->pads;
750 pad = GST_PAD (pads->data);
751 pads = g_list_next (pads);
753 name = gst_pad_get_name (pad);
754 if (gst_pad_get_direction (pad) == GST_PAD_SRC)
755 n_print ("SRC: '%s'\n", name);
756 else if (gst_pad_get_direction (pad) == GST_PAD_SINK)
757 n_print ("SINK: '%s'\n", name);
759 n_print ("UNKNOWN: '%s'\n", name);
763 if (pad->padtemplate) {
765 n_print ("Pad Template: '%s'\n", pad->padtemplate->name_template);
769 caps = gst_pad_get_current_caps (pad);
771 n_print ("Capabilities:\n");
773 print_caps (caps, ""); // FIXME
775 gst_caps_unref (caps);
784 has_sometimes_template (GstElement * element)
786 GstElementClass *klass = GST_ELEMENT_GET_CLASS (element);
789 for (l = klass->padtemplates; l != NULL; l = l->next) {
790 if (GST_PAD_TEMPLATE (l->data)->presence == GST_PAD_SOMETIMES)
798 gtype_needs_ptr_marker (GType type)
800 if (type == G_TYPE_POINTER)
803 if (G_TYPE_FUNDAMENTAL (type) == G_TYPE_POINTER || G_TYPE_IS_BOXED (type)
804 || G_TYPE_IS_OBJECT (type))
811 print_signal_info (GstElement * element)
813 /* Signals/Actions Block */
817 GSignalQuery *query = NULL;
819 GSList *found_signals, *l;
821 for (k = 0; k < 2; k++) {
822 found_signals = NULL;
824 /* For elements that have sometimes pads, also list a few useful GstElement
825 * signals. Put these first, so element-specific ones come later. */
826 if (k == 0 && has_sometimes_template (element)) {
827 query = g_new0 (GSignalQuery, 1);
828 g_signal_query (g_signal_lookup ("pad-added", GST_TYPE_ELEMENT), query);
829 found_signals = g_slist_append (found_signals, query);
830 query = g_new0 (GSignalQuery, 1);
831 g_signal_query (g_signal_lookup ("pad-removed", GST_TYPE_ELEMENT), query);
832 found_signals = g_slist_append (found_signals, query);
833 query = g_new0 (GSignalQuery, 1);
834 g_signal_query (g_signal_lookup ("no-more-pads", GST_TYPE_ELEMENT),
836 found_signals = g_slist_append (found_signals, query);
839 for (type = G_OBJECT_TYPE (element); type; type = g_type_parent (type)) {
840 if (type == GST_TYPE_ELEMENT || type == GST_TYPE_OBJECT)
843 if (type == GST_TYPE_BIN && G_OBJECT_TYPE (element) != GST_TYPE_BIN)
846 signals = g_signal_list_ids (type, &nsignals);
847 for (i = 0; i < nsignals; i++) {
848 query = g_new0 (GSignalQuery, 1);
849 g_signal_query (signals[i], query);
851 if ((k == 0 && !(query->signal_flags & G_SIGNAL_ACTION)) ||
852 (k == 1 && (query->signal_flags & G_SIGNAL_ACTION)))
853 found_signals = g_slist_append (found_signals, query);
864 n_print ("Element Signals:\n");
866 n_print ("Element Actions:\n");
871 for (l = found_signals; l; l = l->next) {
876 query = (GSignalQuery *) l->data;
877 indent_len = strlen (query->signal_name) +
878 strlen (g_type_name (query->return_type)) + 24;
880 if (gtype_needs_ptr_marker (query->return_type)) {
887 indent = g_new0 (gchar, indent_len + 1);
888 memset (indent, ' ', indent_len);
890 n_print (" \"%s\" : %s %suser_function (%s* object",
891 query->signal_name, g_type_name (query->return_type), pmark,
894 for (j = 0; j < query->n_params; j++) {
895 const gchar *type_name, *asterisk;
897 type_name = g_type_name (query->param_types[j]);
898 asterisk = gtype_needs_ptr_marker (query->param_types[j]) ? "*" : "";
901 n_print ("%s%s%s arg%d", indent, type_name, asterisk, j);
906 n_print ("%sgpointer user_data);\n", indent);
914 g_slist_foreach (found_signals, (GFunc) g_free, NULL);
915 g_slist_free (found_signals);
921 print_children_info (GstElement * element)
925 if (!GST_IS_BIN (element))
928 children = (GList *) GST_BIN (element)->children;
931 n_print ("Children:\n");
935 n_print (" %s\n", GST_ELEMENT_NAME (GST_ELEMENT (children->data)));
936 children = g_list_next (children);
941 print_preset_list (GstElement * element)
943 gchar **presets, **preset;
945 if (!GST_IS_PRESET (element))
948 presets = gst_preset_get_preset_names (GST_PRESET (element));
949 if (presets && *presets) {
951 n_print ("Presets:\n");
952 for (preset = presets; *preset; preset++) {
953 n_print (" \"%s\"\n", *preset);
955 g_strfreev (presets);
960 print_blacklist (void)
962 GList *plugins, *cur;
965 g_print ("%s\n", _("Blacklisted files:"));
967 plugins = gst_registry_get_plugin_list (gst_registry_get ());
968 for (cur = plugins; cur != NULL; cur = g_list_next (cur)) {
969 GstPlugin *plugin = (GstPlugin *) (cur->data);
970 if (GST_OBJECT_FLAG_IS_SET (plugin, GST_PLUGIN_FLAG_BLACKLISTED)) {
971 g_print (" %s\n", gst_plugin_get_name (plugin));
977 g_print (_("Total count: "));
978 g_print (ngettext ("%d blacklisted file", "%d blacklisted files", count),
981 gst_plugin_list_free (plugins);
985 print_typefind_extensions (const gchar * const *extensions)
989 while (extensions[i]) {
990 g_print ("%s%s", i > 0 ? ", " : "", extensions[i]);
996 print_element_list (gboolean print_all, gchar * ftypes)
998 int plugincount = 0, featurecount = 0, blacklistcount = 0;
999 GList *plugins, *orig_plugins;
1000 gchar **types = NULL;
1005 types = g_strsplit (ftypes, "/", -1);
1006 for (i = 0; types[i]; i++)
1007 *types[i] = g_ascii_toupper (*types[i]);
1011 orig_plugins = plugins = gst_registry_get_plugin_list (gst_registry_get ());
1013 GList *features, *orig_features;
1016 plugin = (GstPlugin *) (plugins->data);
1017 plugins = g_list_next (plugins);
1020 if (GST_OBJECT_FLAG_IS_SET (plugin, GST_PLUGIN_FLAG_BLACKLISTED)) {
1025 orig_features = features =
1026 gst_registry_get_feature_list_by_plugin (gst_registry_get (),
1027 gst_plugin_get_name (plugin));
1029 GstPluginFeature *feature;
1031 if (G_UNLIKELY (features->data == NULL))
1033 feature = GST_PLUGIN_FEATURE (features->data);
1036 if (GST_IS_ELEMENT_FACTORY (feature)) {
1038 GstElementFactory *factory;
1040 factory = GST_ELEMENT_FACTORY (feature);
1043 gboolean all_found = TRUE;
1046 gst_element_factory_get_metadata (factory,
1047 GST_ELEMENT_METADATA_KLASS);
1048 for (i = 0; types[i]; i++) {
1049 if (!strstr (klass, types[i])) {
1059 print_element_info (feature, TRUE);
1061 g_print ("%s: %s: %s\n", gst_plugin_get_name (plugin),
1062 GST_OBJECT_NAME (factory),
1063 gst_element_factory_get_metadata (factory,
1064 GST_ELEMENT_METADATA_LONGNAME));
1065 } else if (GST_IS_TYPE_FIND_FACTORY (feature)) {
1066 GstTypeFindFactory *factory;
1067 const gchar *const *extensions;
1071 factory = GST_TYPE_FIND_FACTORY (feature);
1073 g_print ("%s: %s: ", gst_plugin_get_name (plugin),
1074 gst_plugin_feature_get_name (feature));
1076 extensions = gst_type_find_factory_get_extensions (factory);
1077 if (extensions != NULL) {
1079 print_typefind_extensions (extensions);
1084 g_print ("no extensions\n");
1090 n_print ("%s: %s (%s)\n", gst_plugin_get_name (plugin),
1091 GST_OBJECT_NAME (feature), g_type_name (G_OBJECT_TYPE (feature)));
1095 features = g_list_next (features);
1098 gst_plugin_feature_list_free (orig_features);
1101 gst_plugin_list_free (orig_plugins);
1105 g_print (_("Total count: "));
1106 g_print (ngettext ("%d plugin", "%d plugins", plugincount), plugincount);
1107 if (blacklistcount) {
1109 g_print (ngettext ("%d blacklist entry", "%d blacklist entries",
1110 blacklistcount), blacklistcount);
1111 g_print (" not shown)");
1114 g_print (ngettext ("%d feature", "%d features", featurecount), featurecount);
1119 print_all_uri_handlers (void)
1121 GList *plugins, *p, *features, *f;
1123 plugins = gst_registry_get_plugin_list (gst_registry_get ());
1125 for (p = plugins; p; p = p->next) {
1126 GstPlugin *plugin = (GstPlugin *) (p->data);
1129 gst_registry_get_feature_list_by_plugin (gst_registry_get (),
1130 gst_plugin_get_name (plugin));
1132 for (f = features; f; f = f->next) {
1133 GstPluginFeature *feature = GST_PLUGIN_FEATURE (f->data);
1135 if (GST_IS_ELEMENT_FACTORY (feature)) {
1136 GstElementFactory *factory;
1137 GstElement *element;
1139 factory = GST_ELEMENT_FACTORY (gst_plugin_feature_load (feature));
1141 g_print ("element plugin %s couldn't be loaded\n",
1142 gst_plugin_get_name (plugin));
1146 element = gst_element_factory_create (factory, NULL);
1148 g_print ("couldn't construct element for %s for some reason\n",
1149 GST_OBJECT_NAME (factory));
1150 gst_object_unref (factory);
1154 if (GST_IS_URI_HANDLER (element)) {
1155 const gchar *const *uri_protocols;
1159 switch (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element))) {
1172 gst_uri_handler_get_protocols (GST_URI_HANDLER (element));
1173 joined = g_strjoinv (", ", (gchar **) uri_protocols);
1175 g_print ("%s (%s, rank %u): %s\n",
1176 gst_plugin_feature_get_name (GST_PLUGIN_FEATURE (factory)), dir,
1177 gst_plugin_feature_get_rank (GST_PLUGIN_FEATURE (factory)),
1183 gst_object_unref (element);
1184 gst_object_unref (factory);
1188 gst_plugin_feature_list_free (features);
1191 gst_plugin_list_free (plugins);
1195 print_plugin_info (GstPlugin * plugin)
1197 const gchar *release_date = gst_plugin_get_release_date_string (plugin);
1198 const gchar *filename = gst_plugin_get_filename (plugin);
1200 n_print ("Plugin Details:\n");
1204 n_print ("%-25s%s\n", "Name", gst_plugin_get_name (plugin));
1205 n_print ("%-25s%s\n", "Description", gst_plugin_get_description (plugin));
1206 n_print ("%-25s%s\n", "Filename", (filename != NULL) ? filename : "(null)");
1207 n_print ("%-25s%s\n", "Version", gst_plugin_get_version (plugin));
1208 n_print ("%-25s%s\n", "License", gst_plugin_get_license (plugin));
1209 n_print ("%-25s%s\n", "Source module", gst_plugin_get_source (plugin));
1211 if (release_date != NULL) {
1212 const gchar *tz = "(UTC)";
1215 /* may be: YYYY-MM-DD or YYYY-MM-DDTHH:MMZ */
1216 /* YYYY-MM-DDTHH:MMZ => YYYY-MM-DD HH:MM (UTC) */
1217 str = g_strdup (release_date);
1218 sep = strstr (str, "T");
1221 sep = strstr (sep + 1, "Z");
1227 n_print ("%-25s%s%s\n", "Source release date", str, tz);
1230 n_print ("%-25s%s\n", "Binary package", gst_plugin_get_package (plugin));
1231 n_print ("%-25s%s\n", "Origin URL", gst_plugin_get_origin (plugin));
1239 print_plugin_features (GstPlugin * plugin)
1241 GList *features, *origlist;
1242 gint num_features = 0;
1243 gint num_elements = 0;
1244 gint num_tracers = 0;
1245 gint num_typefinders = 0;
1246 gint num_devproviders = 0;
1249 origlist = features =
1250 gst_registry_get_feature_list_by_plugin (gst_registry_get (),
1251 gst_plugin_get_name (plugin));
1254 GstPluginFeature *feature;
1256 feature = GST_PLUGIN_FEATURE (features->data);
1258 if (GST_IS_ELEMENT_FACTORY (feature)) {
1259 GstElementFactory *factory;
1261 factory = GST_ELEMENT_FACTORY (feature);
1262 n_print (" %s: %s\n", GST_OBJECT_NAME (factory),
1263 gst_element_factory_get_metadata (factory,
1264 GST_ELEMENT_METADATA_LONGNAME));
1266 } else if (GST_IS_TYPE_FIND_FACTORY (feature)) {
1267 GstTypeFindFactory *factory;
1268 const gchar *const *extensions;
1270 factory = GST_TYPE_FIND_FACTORY (feature);
1271 extensions = gst_type_find_factory_get_extensions (factory);
1275 g_print (" %s: %s: ", gst_plugin_get_name (plugin),
1276 gst_plugin_feature_get_name (feature));
1277 while (extensions[i]) {
1278 g_print ("%s%s", i > 0 ? ", " : "", extensions[i]);
1283 g_print (" %s: %s: no extensions\n", gst_plugin_get_name (plugin),
1284 gst_plugin_feature_get_name (feature));
1287 } else if (GST_IS_DEVICE_PROVIDER_FACTORY (feature)) {
1288 GstDeviceProviderFactory *factory;
1290 factory = GST_DEVICE_PROVIDER_FACTORY (feature);
1291 n_print (" %s: %s\n", GST_OBJECT_NAME (factory),
1292 gst_device_provider_factory_get_metadata (factory,
1293 GST_ELEMENT_METADATA_LONGNAME));
1295 } else if (GST_IS_TRACER_FACTORY (feature)) {
1296 n_print (" %s (%s)\n", gst_object_get_name (GST_OBJECT (feature)),
1297 g_type_name (G_OBJECT_TYPE (feature)));
1299 } else if (feature) {
1300 n_print (" %s (%s)\n", gst_object_get_name (GST_OBJECT (feature)),
1301 g_type_name (G_OBJECT_TYPE (feature)));
1305 features = g_list_next (features);
1308 gst_plugin_feature_list_free (origlist);
1311 n_print (" %d features:\n", num_features);
1312 if (num_elements > 0)
1313 n_print (" +-- %d elements\n", num_elements);
1314 if (num_typefinders > 0)
1315 n_print (" +-- %d typefinders\n", num_typefinders);
1316 if (num_devproviders > 0)
1317 n_print (" +-- %d device providers\n", num_devproviders);
1318 if (num_tracers > 0)
1319 n_print (" +-- %d tracers\n", num_tracers);
1321 n_print (" +-- %d other objects\n", num_other);
1327 print_feature_info (const gchar * feature_name, gboolean print_all)
1329 GstPluginFeature *feature;
1330 GstRegistry *registry = gst_registry_get ();
1333 if ((feature = gst_registry_find_feature (registry, feature_name,
1334 GST_TYPE_ELEMENT_FACTORY))) {
1335 ret = print_element_info (feature, print_all);
1338 if ((feature = gst_registry_find_feature (registry, feature_name,
1339 GST_TYPE_TYPE_FIND_FACTORY))) {
1340 ret = print_typefind_info (feature, print_all);
1343 if ((feature = gst_registry_find_feature (registry, feature_name,
1344 GST_TYPE_TRACER_FACTORY))) {
1345 ret = print_tracer_info (feature, print_all);
1349 /* TODO: handle DEVICE_PROVIDER_FACTORY */
1354 gst_object_unref (feature);
1359 print_element_info (GstPluginFeature * feature, gboolean print_names)
1361 GstElementFactory *factory;
1362 GstElement *element;
1366 factory = GST_ELEMENT_FACTORY (gst_plugin_feature_load (feature));
1368 g_print ("element plugin couldn't be loaded\n");
1372 element = gst_element_factory_create (factory, NULL);
1374 gst_object_unref (factory);
1375 g_print ("couldn't construct element for some reason\n");
1380 _name = g_strdup_printf ("%s: ", GST_OBJECT_NAME (factory));
1384 print_factory_details_info (factory);
1386 plugin = gst_plugin_feature_get_plugin (GST_PLUGIN_FEATURE (factory));
1388 print_plugin_info (plugin);
1389 gst_object_unref (plugin);
1392 print_hierarchy (G_OBJECT_TYPE (element), 0, &maxlevel);
1393 print_interfaces (G_OBJECT_TYPE (element));
1395 print_pad_templates_info (element, factory);
1396 print_element_flag_info (element);
1397 print_clocking_info (element);
1398 print_uri_handler_info (element);
1399 print_pad_info (element);
1400 print_element_properties_info (element);
1401 print_signal_info (element);
1402 print_children_info (element);
1403 print_preset_list (element);
1405 gst_object_unref (element);
1406 gst_object_unref (factory);
1412 print_typefind_info (GstPluginFeature * feature, gboolean print_names)
1414 GstTypeFindFactory *factory;
1419 const gchar *const *extensions;
1421 factory = GST_TYPE_FIND_FACTORY (gst_plugin_feature_load (feature));
1423 g_print ("typefind plugin couldn't be loaded\n");
1428 _name = g_strdup_printf ("%s: ", GST_OBJECT_NAME (factory));
1432 n_print ("Factory Details:\n");
1433 rank = gst_plugin_feature_get_rank (feature);
1434 n_print (" %-25s%s (%d)\n", "Rank", get_rank_name (s, rank), rank);
1435 n_print (" %-25s%s\n", "Name", GST_OBJECT_NAME (factory));
1436 caps = gst_type_find_factory_get_caps (factory);
1438 gchar *caps_str = gst_caps_to_string (factory->caps);
1440 n_print (" %-25s%s\n", "Caps", caps_str);
1443 extensions = gst_type_find_factory_get_extensions (factory);
1445 n_print (" %-25s", "Extensions");
1446 print_typefind_extensions (extensions);
1451 plugin = gst_plugin_feature_get_plugin (GST_PLUGIN_FEATURE (factory));
1453 print_plugin_info (plugin);
1454 gst_object_unref (plugin);
1457 gst_object_unref (factory);
1463 print_tracer_info (GstPluginFeature * feature, gboolean print_names)
1465 GstTracerFactory *factory;
1470 factory = GST_TRACER_FACTORY (gst_plugin_feature_load (feature));
1472 g_print ("tracer plugin couldn't be loaded\n");
1476 tracer = (GstTracer *) g_object_new (factory->type, NULL);
1478 gst_object_unref (factory);
1479 g_print ("couldn't construct tracer for some reason\n");
1484 _name = g_strdup_printf ("%s: ", GST_OBJECT_NAME (factory));
1488 n_print ("Factory Details:\n");
1489 n_print (" %-25s%s\n", "Name", GST_OBJECT_NAME (factory));
1492 plugin = gst_plugin_feature_get_plugin (GST_PLUGIN_FEATURE (factory));
1494 print_plugin_info (plugin);
1495 gst_object_unref (plugin);
1498 print_hierarchy (G_OBJECT_TYPE (tracer), 0, &maxlevel);
1499 print_interfaces (G_OBJECT_TYPE (tracer));
1501 /* TODO: list what hooks it registers
1502 * - the data is available in gsttracerutils, we need to iterate the
1503 * _priv_tracers hashtable for each probe and then check the list of hooks
1504 * for each probe whether hook->tracer == tracer :/
1507 /* TODO: list what records it emits
1508 * - in class_init tracers can create GstTracerRecord instances
1509 * - those only get logged right now and there is no association with the
1510 * tracer that created them
1511 * - we'd need to add them to GstTracerFactory
1512 * gst_tracer_class_add_record (klass, record);
1513 * - needs work in gstregistrychunks.
1516 gst_object_unref (tracer);
1517 gst_object_unref (factory);
1523 print_plugin_automatic_install_info_codecs (GstElementFactory * factory)
1525 GstPadDirection direction;
1526 const gchar *type_name;
1528 const GList *static_templates, *l;
1529 GstCaps *caps = NULL;
1533 gst_element_factory_get_metadata (factory, GST_ELEMENT_METADATA_KLASS);
1534 g_return_if_fail (klass != NULL);
1536 if (strstr (klass, "Demuxer") ||
1537 strstr (klass, "Decoder") ||
1538 strstr (klass, "Depay") || strstr (klass, "Parser")) {
1539 type_name = "decoder";
1540 direction = GST_PAD_SINK;
1541 } else if (strstr (klass, "Muxer") ||
1542 strstr (klass, "Encoder") || strstr (klass, "Pay")) {
1543 type_name = "encoder";
1544 direction = GST_PAD_SRC;
1549 /* decoder/demuxer sink pads should always be static and there should only
1550 * be one, the same applies to encoders/muxers and source pads */
1551 static_templates = gst_element_factory_get_static_pad_templates (factory);
1552 for (l = static_templates; l != NULL; l = l->next) {
1553 GstStaticPadTemplate *tmpl = NULL;
1555 tmpl = (GstStaticPadTemplate *) l->data;
1556 if (tmpl->direction == direction) {
1557 caps = gst_static_pad_template_get_caps (tmpl);
1563 g_printerr ("Couldn't find static pad template for %s '%s'\n",
1564 type_name, GST_OBJECT_NAME (factory));
1568 caps = gst_caps_make_writable (caps);
1569 num = gst_caps_get_size (caps);
1570 for (i = 0; i < num; ++i) {
1574 s = gst_caps_get_structure (caps, i);
1575 /* remove fields that are almost always just MIN-MAX of some sort
1576 * in order to make the caps look less messy */
1577 gst_structure_remove_field (s, "pixel-aspect-ratio");
1578 gst_structure_remove_field (s, "framerate");
1579 gst_structure_remove_field (s, "channels");
1580 gst_structure_remove_field (s, "width");
1581 gst_structure_remove_field (s, "height");
1582 gst_structure_remove_field (s, "rate");
1583 gst_structure_remove_field (s, "depth");
1584 gst_structure_remove_field (s, "clock-rate");
1585 s_str = gst_structure_to_string (s);
1586 g_print ("%s-%s\n", type_name, s_str);
1589 gst_caps_unref (caps);
1593 print_plugin_automatic_install_info_protocols (GstElementFactory * factory)
1595 const gchar *const *protocols;
1597 protocols = gst_element_factory_get_uri_protocols (factory);
1598 if (protocols != NULL && *protocols != NULL) {
1599 switch (gst_element_factory_get_uri_type (factory)) {
1601 while (*protocols != NULL) {
1602 g_print ("urisink-%s\n", *protocols);
1607 while (*protocols != NULL) {
1608 g_print ("urisource-%s\n", *protocols);
1619 print_plugin_automatic_install_info (GstPlugin * plugin)
1621 GList *features, *l;
1623 /* not interested in typefind factories, only element factories */
1624 features = gst_registry_get_feature_list (gst_registry_get (),
1625 GST_TYPE_ELEMENT_FACTORY);
1627 for (l = features; l != NULL; l = l->next) {
1628 GstPluginFeature *feature;
1629 GstPlugin *feature_plugin;
1631 feature = GST_PLUGIN_FEATURE (l->data);
1633 /* only interested in the ones that are in the plugin we just loaded */
1634 feature_plugin = gst_plugin_feature_get_plugin (feature);
1635 if (feature_plugin == plugin) {
1636 GstElementFactory *factory;
1638 g_print ("element-%s\n", gst_plugin_feature_get_name (feature));
1640 factory = GST_ELEMENT_FACTORY (feature);
1641 print_plugin_automatic_install_info_protocols (factory);
1642 print_plugin_automatic_install_info_codecs (factory);
1645 gst_object_unref (feature_plugin);
1648 g_list_foreach (features, (GFunc) gst_object_unref, NULL);
1649 g_list_free (features);
1653 print_all_plugin_automatic_install_info (void)
1655 GList *plugins, *orig_plugins;
1657 orig_plugins = plugins = gst_registry_get_plugin_list (gst_registry_get ());
1661 plugin = (GstPlugin *) (plugins->data);
1662 plugins = g_list_next (plugins);
1664 print_plugin_automatic_install_info (plugin);
1666 gst_plugin_list_free (orig_plugins);
1670 main (int argc, char *argv[])
1672 gboolean print_all = FALSE;
1673 gboolean do_print_blacklist = FALSE;
1674 gboolean plugin_name = FALSE;
1675 gboolean print_aii = FALSE;
1676 gboolean uri_handlers = FALSE;
1677 gboolean check_exists = FALSE;
1678 gchar *min_version = NULL;
1679 guint minver_maj = GST_VERSION_MAJOR;
1680 guint minver_min = GST_VERSION_MINOR;
1681 guint minver_micro = 0;
1682 gchar *types = NULL;
1683 #ifndef GST_DISABLE_OPTION_PARSING
1684 GOptionEntry options[] = {
1685 {"print-all", 'a', 0, G_OPTION_ARG_NONE, &print_all,
1686 N_("Print all elements"), NULL},
1687 {"print-blacklist", 'b', 0, G_OPTION_ARG_NONE, &do_print_blacklist,
1688 N_("Print list of blacklisted files"), NULL},
1689 {"print-plugin-auto-install-info", '\0', 0, G_OPTION_ARG_NONE, &print_aii,
1690 N_("Print a machine-parsable list of features the specified plugin "
1691 "or all plugins provide.\n "
1692 "Useful in connection with external automatic plugin "
1693 "installation mechanisms"), NULL},
1694 {"plugin", '\0', 0, G_OPTION_ARG_NONE, &plugin_name,
1695 N_("List the plugin contents"), NULL},
1696 {"types", 't', 0, G_OPTION_ARG_STRING, &types,
1697 N_("A slashes ('/') separated list of types of elements (also known "
1698 "as klass) to list. (unordered)"), NULL},
1699 {"exists", '\0', 0, G_OPTION_ARG_NONE, &check_exists,
1700 N_("Check if the specified element or plugin exists"), NULL},
1701 {"atleast-version", '\0', 0, G_OPTION_ARG_STRING, &min_version,
1703 ("When checking if an element or plugin exists, also check that its "
1704 "version is at least the version specified"), NULL},
1705 {"uri-handlers", 'u', 0, G_OPTION_ARG_NONE, &uri_handlers,
1707 ("Print supported URI schemes, with the elements that implement them"),
1709 GST_TOOLS_GOPTION_VERSION,
1712 GOptionContext *ctx;
1716 setlocale (LC_ALL, "");
1719 bindtextdomain (GETTEXT_PACKAGE, LOCALEDIR);
1720 bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
1721 textdomain (GETTEXT_PACKAGE);
1724 /* avoid glib warnings when inspecting deprecated properties */
1725 g_setenv ("G_ENABLE_DIAGNOSTIC", "0", FALSE);
1727 g_set_prgname ("gst-inspect-" GST_API_VERSION);
1729 #ifndef GST_DISABLE_OPTION_PARSING
1730 ctx = g_option_context_new ("[ELEMENT-NAME | PLUGIN-NAME]");
1731 g_option_context_add_main_entries (ctx, options, GETTEXT_PACKAGE);
1732 g_option_context_add_group (ctx, gst_init_get_option_group ());
1733 if (!g_option_context_parse (ctx, &argc, &argv, &err)) {
1734 g_printerr ("Error initializing: %s\n", err->message);
1735 g_clear_error (&err);
1736 g_option_context_free (ctx);
1739 g_option_context_free (ctx);
1741 gst_init (&argc, &argv);
1744 gst_tools_print_version ();
1746 if (print_all && argc > 1) {
1747 g_printerr ("-a requires no extra arguments\n");
1751 if (uri_handlers && argc > 1) {
1752 g_printerr ("-u requires no extra arguments\n");
1756 /* --atleast-version implies --exists */
1757 if (min_version != NULL) {
1758 if (sscanf (min_version, "%u.%u.%u", &minver_maj, &minver_min,
1759 &minver_micro) < 2) {
1760 g_printerr ("Can't parse version '%s' passed to --atleast-version\n",
1764 check_exists = TRUE;
1771 g_printerr ("--exists requires an extra command line argument\n");
1775 GstPluginFeature *feature;
1777 feature = gst_registry_lookup_feature (gst_registry_get (), argv[1]);
1778 if (feature != NULL && gst_plugin_feature_check_version (feature,
1779 minver_maj, minver_min, minver_micro)) {
1786 gst_object_unref (feature);
1788 /* FIXME: support checking for plugins too */
1789 g_printerr ("Checking for plugins is not supported yet\n");
1796 /* if no arguments, print out list of elements */
1798 print_all_uri_handlers ();
1799 } else if (argc == 1 || print_all) {
1800 if (do_print_blacklist)
1804 print_all_plugin_automatic_install_info ();
1806 print_element_list (print_all, types);
1809 /* else we try to get a factory */
1810 const char *arg = argv[argc - 1];
1814 retval = print_feature_info (arg, print_all);
1817 /* otherwise check if it's a plugin */
1819 GstPlugin *plugin = gst_registry_find_plugin (gst_registry_get (), arg);
1821 /* if there is such a plugin, print out info */
1824 print_plugin_automatic_install_info (plugin);
1826 print_plugin_info (plugin);
1827 print_plugin_features (plugin);
1830 GError *error = NULL;
1832 if (g_file_test (arg, G_FILE_TEST_EXISTS)) {
1833 plugin = gst_plugin_load_file (arg, &error);
1837 print_plugin_automatic_install_info (plugin);
1839 print_plugin_info (plugin);
1840 print_plugin_features (plugin);
1843 g_printerr (_("Could not load plugin file: %s\n"), error->message);
1844 g_clear_error (&error);
1848 g_printerr (_("No such element or plugin '%s'\n"), arg);