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;
41 static int print_element_info (GstPluginFeature * feature,
42 gboolean print_names);
43 static int print_typefind_info (GstPluginFeature * feature,
44 gboolean print_names);
45 static int print_tracer_info (GstPluginFeature * feature, gboolean print_names);
51 n_print (const char *format, ...)
56 g_print ("%s", _name);
58 va_start (args, format);
59 g_vprintf (format, args);
64 print_field (GQuark field, const GValue * value, gpointer pfx)
66 gchar *str = gst_value_serialize (value);
68 n_print ("%s %15s: %s\n", (gchar *) pfx, g_quark_to_string (field), str);
74 print_caps (const GstCaps * caps, const gchar * pfx)
78 g_return_if_fail (caps != NULL);
80 if (gst_caps_is_any (caps)) {
81 n_print ("%sANY\n", pfx);
84 if (gst_caps_is_empty (caps)) {
85 n_print ("%sEMPTY\n", pfx);
89 for (i = 0; i < gst_caps_get_size (caps); i++) {
90 GstStructure *structure = gst_caps_get_structure (caps, i);
91 GstCapsFeatures *features = gst_caps_get_features (caps, i);
93 if (features && (gst_caps_features_is_any (features) ||
94 !gst_caps_features_is_equal (features,
95 GST_CAPS_FEATURES_MEMORY_SYSTEM_MEMORY))) {
96 gchar *features_string = gst_caps_features_to_string (features);
98 n_print ("%s%s(%s)\n", pfx, gst_structure_get_name (structure),
100 g_free (features_string);
102 n_print ("%s%s\n", pfx, gst_structure_get_name (structure));
104 gst_structure_foreach (structure, print_field, (gpointer) pfx);
109 get_rank_name (char *s, gint rank)
111 static const int ranks[4] = {
112 GST_RANK_NONE, GST_RANK_MARGINAL, GST_RANK_SECONDARY, GST_RANK_PRIMARY
114 static const char *rank_names[4] = { "none", "marginal", "secondary",
121 for (i = 0; i < 4; i++) {
122 if (rank == ranks[i])
123 return rank_names[i];
124 if (abs (rank - ranks[i]) < abs (rank - ranks[best_i])) {
129 sprintf (s, "%s %c %d", rank_names[best_i],
130 (rank - ranks[best_i] > 0) ? '+' : '-', abs (ranks[best_i] - rank));
136 print_factory_details_info (GstElementFactory * factory)
142 rank = gst_plugin_feature_get_rank (GST_PLUGIN_FEATURE (factory));
143 n_print ("Factory Details:\n");
144 n_print (" %-25s%s (%d)\n", "Rank", get_rank_name (s, rank), rank);
146 keys = gst_element_factory_get_metadata_keys (factory);
148 for (k = keys; *k != NULL; ++k) {
152 val = gst_element_factory_get_metadata (factory, key);
153 key[0] = g_ascii_toupper (key[0]);
154 n_print (" %-25s%s\n", key, val);
162 print_hierarchy (GType type, gint level, gint * maxlevel)
167 parent = g_type_parent (type);
169 *maxlevel = *maxlevel + 1;
173 print_hierarchy (parent, level, maxlevel);
176 g_print ("%s", _name);
178 for (i = 1; i < *maxlevel - level; i++)
180 if (*maxlevel - level)
183 g_print ("%s\n", g_type_name (type));
190 print_interfaces (GType type)
193 GType *iface, *ifaces = g_type_interfaces (type, &n_ifaces);
198 g_print ("%s", _name);
199 g_print (_("Implemented Interfaces:\n"));
203 g_print ("%s", _name);
204 g_print (" %s\n", g_type_name (*iface));
208 g_print ("%s", _name);
216 flags_to_string (GFlagsValue * vals, guint flags)
221 /* first look for an exact match and count the number of values */
222 for (i = 0; vals[i].value_name != NULL; ++i) {
223 if (vals[i].value == flags)
224 return g_strdup (vals[i].value_nick);
227 s = g_string_new (NULL);
229 /* we assume the values are sorted from lowest to highest value */
233 if (vals[i].value != 0 && (flags_left & vals[i].value) == vals[i].value) {
235 g_string_append_c (s, '+');
236 g_string_append (s, vals[i].value_nick);
237 flags_left -= vals[i].value;
244 g_string_assign (s, "(none)");
246 return g_string_free (s, FALSE);
249 #define KNOWN_PARAM_FLAGS \
250 (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY | \
251 G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS | \
252 G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_DEPRECATED | \
253 GST_PARAM_CONTROLLABLE | GST_PARAM_MUTABLE_PLAYING | \
254 GST_PARAM_MUTABLE_PAUSED | GST_PARAM_MUTABLE_READY)
257 print_element_properties_info (GstElement * element)
259 GParamSpec **property_specs;
260 guint num_properties, i;
264 property_specs = g_object_class_list_properties
265 (G_OBJECT_GET_CLASS (element), &num_properties);
267 n_print ("Element Properties:\n");
269 for (i = 0; i < num_properties; i++) {
270 GValue value = { 0, };
271 GParamSpec *param = property_specs[i];
275 g_value_init (&value, param->value_type);
277 n_print (" %-20s: %s\n", g_param_spec_get_name (param),
278 g_param_spec_get_blurb (param));
281 n_print ("%-23.23s flags: ", "");
282 if (param->flags & G_PARAM_READABLE) {
283 g_object_get_property (G_OBJECT (element), param->name, &value);
285 g_print ("%s%s", (first_flag) ? "" : ", ", _("readable"));
288 /* if we can't read the property value, assume it's set to the default
289 * (which might not be entirely true for sub-classes, but that's an
290 * unlikely corner-case anyway) */
291 g_param_value_set_default (param, &value);
293 if (param->flags & G_PARAM_WRITABLE) {
294 g_print ("%s%s", (first_flag) ? "" : ", ", _("writable"));
297 if (param->flags & G_PARAM_DEPRECATED) {
298 g_print ("%s%s", (first_flag) ? "" : ", ", _("deprecated"));
301 if (param->flags & GST_PARAM_CONTROLLABLE) {
302 g_print (", %s", _("controllable"));
305 if (param->flags & GST_PARAM_MUTABLE_PLAYING) {
306 g_print (", %s", _("changeable in NULL, READY, PAUSED or PLAYING state"));
307 } else if (param->flags & GST_PARAM_MUTABLE_PAUSED) {
308 g_print (", %s", _("changeable only in NULL, READY or PAUSED state"));
309 } else if (param->flags & GST_PARAM_MUTABLE_READY) {
310 g_print (", %s", _("changeable only in NULL or READY state"));
312 if (param->flags & ~KNOWN_PARAM_FLAGS) {
313 g_print ("%s0x%0x", (first_flag) ? "" : ", ",
314 param->flags & ~KNOWN_PARAM_FLAGS);
318 switch (G_VALUE_TYPE (&value)) {
321 const char *string_val = g_value_get_string (&value);
323 n_print ("%-23.23s String. ", "");
325 if (string_val == NULL)
326 g_print ("Default: null");
328 g_print ("Default: \"%s\"", string_val);
333 gboolean bool_val = g_value_get_boolean (&value);
335 n_print ("%-23.23s Boolean. ", "");
337 g_print ("Default: %s", bool_val ? "true" : "false");
342 GParamSpecULong *pulong = G_PARAM_SPEC_ULONG (param);
344 n_print ("%-23.23s Unsigned Long. ", "");
345 g_print ("Range: %lu - %lu Default: %lu ",
346 pulong->minimum, pulong->maximum, g_value_get_ulong (&value));
348 GST_ERROR ("%s: property '%s' of type ulong: consider changing to "
349 "uint/uint64", GST_OBJECT_NAME (element),
350 g_param_spec_get_name (param));
355 GParamSpecLong *plong = G_PARAM_SPEC_LONG (param);
357 n_print ("%-23.23s Long. ", "");
358 g_print ("Range: %ld - %ld Default: %ld ",
359 plong->minimum, plong->maximum, g_value_get_long (&value));
361 GST_ERROR ("%s: property '%s' of type long: consider changing to "
362 "int/int64", GST_OBJECT_NAME (element),
363 g_param_spec_get_name (param));
368 GParamSpecUInt *puint = G_PARAM_SPEC_UINT (param);
370 n_print ("%-23.23s Unsigned Integer. ", "");
371 g_print ("Range: %u - %u Default: %u ",
372 puint->minimum, puint->maximum, g_value_get_uint (&value));
377 GParamSpecInt *pint = G_PARAM_SPEC_INT (param);
379 n_print ("%-23.23s Integer. ", "");
380 g_print ("Range: %d - %d Default: %d ",
381 pint->minimum, pint->maximum, g_value_get_int (&value));
386 GParamSpecUInt64 *puint64 = G_PARAM_SPEC_UINT64 (param);
388 n_print ("%-23.23s Unsigned Integer64. ", "");
389 g_print ("Range: %" G_GUINT64_FORMAT " - %" G_GUINT64_FORMAT
390 " Default: %" G_GUINT64_FORMAT " ",
391 puint64->minimum, puint64->maximum, g_value_get_uint64 (&value));
396 GParamSpecInt64 *pint64 = G_PARAM_SPEC_INT64 (param);
398 n_print ("%-23.23s Integer64. ", "");
399 g_print ("Range: %" G_GINT64_FORMAT " - %" G_GINT64_FORMAT
400 " Default: %" G_GINT64_FORMAT " ",
401 pint64->minimum, pint64->maximum, g_value_get_int64 (&value));
406 GParamSpecFloat *pfloat = G_PARAM_SPEC_FLOAT (param);
408 n_print ("%-23.23s Float. ", "");
409 g_print ("Range: %15.7g - %15.7g Default: %15.7g ",
410 pfloat->minimum, pfloat->maximum, g_value_get_float (&value));
415 GParamSpecDouble *pdouble = G_PARAM_SPEC_DOUBLE (param);
417 n_print ("%-23.23s Double. ", "");
418 g_print ("Range: %15.7g - %15.7g Default: %15.7g ",
419 pdouble->minimum, pdouble->maximum, g_value_get_double (&value));
424 GST_ERROR ("%s: property '%s' of type char: consider changing to "
425 "int/string", GST_OBJECT_NAME (element),
426 g_param_spec_get_name (param));
429 if (param->value_type == GST_TYPE_CAPS) {
430 const GstCaps *caps = gst_value_get_caps (&value);
433 n_print ("%-23.23s Caps (NULL)", "");
435 print_caps (caps, " ");
437 } else if (G_IS_PARAM_SPEC_ENUM (param)) {
441 const gchar *value_nick = "";
443 values = G_ENUM_CLASS (g_type_class_ref (param->value_type))->values;
444 enum_value = g_value_get_enum (&value);
446 while (values[j].value_name) {
447 if (values[j].value == enum_value)
448 value_nick = values[j].value_nick;
452 n_print ("%-23.23s Enum \"%s\" Default: %d, \"%s\"", "",
453 g_type_name (G_VALUE_TYPE (&value)), enum_value, value_nick);
456 while (values[j].value_name) {
459 g_print ("%s", _name);
460 g_print ("%-23.23s (%d): %-16s - %s", "",
461 values[j].value, values[j].value_nick, values[j].value_name);
464 /* g_type_class_unref (ec); */
465 } else if (G_IS_PARAM_SPEC_FLAGS (param)) {
466 GParamSpecFlags *pflags = G_PARAM_SPEC_FLAGS (param);
470 vals = pflags->flags_class->values;
472 cur = flags_to_string (vals, g_value_get_flags (&value));
474 n_print ("%-23.23s Flags \"%s\" Default: 0x%08x, \"%s\"", "",
475 g_type_name (G_VALUE_TYPE (&value)),
476 g_value_get_flags (&value), cur);
478 while (vals[0].value_name) {
481 g_print ("%s", _name);
482 g_print ("%-23.23s (0x%08x): %-16s - %s", "",
483 vals[0].value, vals[0].value_nick, vals[0].value_name);
488 } else if (G_IS_PARAM_SPEC_OBJECT (param)) {
489 n_print ("%-23.23s Object of type \"%s\"", "",
490 g_type_name (param->value_type));
491 } else if (G_IS_PARAM_SPEC_BOXED (param)) {
492 n_print ("%-23.23s Boxed pointer of type \"%s\"", "",
493 g_type_name (param->value_type));
494 if (param->value_type == GST_TYPE_STRUCTURE) {
495 const GstStructure *s = gst_value_get_structure (&value);
497 gst_structure_foreach (s, print_field,
500 } else if (G_IS_PARAM_SPEC_POINTER (param)) {
501 if (param->value_type != G_TYPE_POINTER) {
502 n_print ("%-23.23s Pointer of type \"%s\".", "",
503 g_type_name (param->value_type));
505 n_print ("%-23.23s Pointer.", "");
507 } else if (param->value_type == G_TYPE_VALUE_ARRAY) {
508 GParamSpecValueArray *pvarray = G_PARAM_SPEC_VALUE_ARRAY (param);
510 if (pvarray->element_spec) {
511 n_print ("%-23.23s Array of GValues of type \"%s\"", "",
512 g_type_name (pvarray->element_spec->value_type));
514 n_print ("%-23.23s Array of GValues", "");
516 } else if (GST_IS_PARAM_SPEC_FRACTION (param)) {
517 GstParamSpecFraction *pfraction = GST_PARAM_SPEC_FRACTION (param);
519 n_print ("%-23.23s Fraction. ", "");
521 g_print ("Range: %d/%d - %d/%d Default: %d/%d ",
522 pfraction->min_num, pfraction->min_den,
523 pfraction->max_num, pfraction->max_den,
524 gst_value_get_fraction_numerator (&value),
525 gst_value_get_fraction_denominator (&value));
526 } else if (param->value_type == GST_TYPE_ARRAY) {
527 GstParamSpecArray *parray = GST_PARAM_SPEC_ARRAY_LIST (param);
529 if (parray->element_spec) {
530 n_print ("%-23.23s GstValueArray of GValues of type \"%s\"", "",
531 g_type_name (parray->element_spec->value_type));
533 n_print ("%-23.23s GstValueArray of GValues", "");
536 n_print ("%-23.23s Unknown type %ld \"%s\"", "",
537 (glong) param->value_type, g_type_name (param->value_type));
542 g_print (" Write only\n");
546 g_value_reset (&value);
548 if (num_properties == 0)
551 g_free (property_specs);
555 print_pad_templates_info (GstElement * element, GstElementFactory * factory)
558 GstStaticPadTemplate *padtemplate;
560 n_print ("Pad Templates:\n");
561 if (gst_element_factory_get_num_pad_templates (factory) == 0) {
566 pads = gst_element_factory_get_static_pad_templates (factory);
568 padtemplate = (GstStaticPadTemplate *) (pads->data);
569 pads = g_list_next (pads);
571 if (padtemplate->direction == GST_PAD_SRC)
572 n_print (" SRC template: '%s'\n", padtemplate->name_template);
573 else if (padtemplate->direction == GST_PAD_SINK)
574 n_print (" SINK template: '%s'\n", padtemplate->name_template);
576 n_print (" UNKNOWN!!! template: '%s'\n", padtemplate->name_template);
578 if (padtemplate->presence == GST_PAD_ALWAYS)
579 n_print (" Availability: Always\n");
580 else if (padtemplate->presence == GST_PAD_SOMETIMES)
581 n_print (" Availability: Sometimes\n");
582 else if (padtemplate->presence == GST_PAD_REQUEST) {
583 n_print (" Availability: On request\n");
585 n_print (" Availability: UNKNOWN!!!\n");
587 if (padtemplate->static_caps.string) {
588 GstCaps *caps = gst_static_caps_get (&padtemplate->static_caps);
590 n_print (" Capabilities:\n");
591 print_caps (caps, " ");
592 gst_caps_unref (caps);
601 print_element_flag_info (GstElement * element)
603 gboolean have_flags = FALSE;
606 n_print ("Element Flags:\n");
609 n_print (" no flags set\n");
611 if (GST_IS_BIN (element)) {
613 n_print ("Bin Flags:\n");
615 n_print (" no flags set\n");
620 print_clocking_info (GstElement * element)
622 gboolean requires_clock, provides_clock;
625 GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_REQUIRE_CLOCK);
627 GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_PROVIDE_CLOCK);
629 if (!requires_clock && !provides_clock) {
631 n_print ("Element has no clocking capabilities.\n");
636 n_print ("Clocking Interaction:\n");
637 if (requires_clock) {
638 n_print (" element requires a clock\n");
641 if (provides_clock) {
644 clock = gst_element_get_clock (element);
646 n_print (" element provides a clock: %s\n", GST_OBJECT_NAME (clock));
647 gst_object_unref (clock);
649 n_print (" element is supposed to provide a clock but returned NULL\n");
654 print_uri_handler_info (GstElement * element)
656 if (GST_IS_URI_HANDLER (element)) {
657 const gchar *const *uri_protocols;
658 const gchar *uri_type;
660 if (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element)) == GST_URI_SRC)
662 else if (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element)) ==
666 uri_type = "unknown";
668 uri_protocols = gst_uri_handler_get_protocols (GST_URI_HANDLER (element));
671 n_print ("URI handling capabilities:\n");
672 n_print (" Element can act as %s.\n", uri_type);
674 if (uri_protocols && *uri_protocols) {
675 n_print (" Supported URI protocols:\n");
676 for (; *uri_protocols != NULL; uri_protocols++)
677 n_print (" %s\n", *uri_protocols);
679 n_print (" No supported URI protocols\n");
682 n_print ("Element has no URI handling capabilities.\n");
687 print_pad_info (GstElement * element)
695 if (!element->numpads) {
700 pads = element->pads;
705 pad = GST_PAD (pads->data);
706 pads = g_list_next (pads);
708 name = gst_pad_get_name (pad);
709 if (gst_pad_get_direction (pad) == GST_PAD_SRC)
710 n_print (" SRC: '%s'\n", name);
711 else if (gst_pad_get_direction (pad) == GST_PAD_SINK)
712 n_print (" SINK: '%s'\n", name);
714 n_print (" UNKNOWN!!!: '%s'\n", name);
718 if (pad->padtemplate)
719 n_print (" Pad Template: '%s'\n", pad->padtemplate->name_template);
721 caps = gst_pad_get_current_caps (pad);
723 n_print (" Capabilities:\n");
724 print_caps (caps, " ");
725 gst_caps_unref (caps);
731 has_sometimes_template (GstElement * element)
733 GstElementClass *klass = GST_ELEMENT_GET_CLASS (element);
736 for (l = klass->padtemplates; l != NULL; l = l->next) {
737 if (GST_PAD_TEMPLATE (l->data)->presence == GST_PAD_SOMETIMES)
745 gtype_needs_ptr_marker (GType type)
747 if (type == G_TYPE_POINTER)
750 if (G_TYPE_FUNDAMENTAL (type) == G_TYPE_POINTER || G_TYPE_IS_BOXED (type)
751 || G_TYPE_IS_OBJECT (type))
758 print_signal_info (GstElement * element)
760 /* Signals/Actions Block */
764 GSignalQuery *query = NULL;
766 GSList *found_signals, *l;
768 for (k = 0; k < 2; k++) {
769 found_signals = NULL;
771 /* For elements that have sometimes pads, also list a few useful GstElement
772 * signals. Put these first, so element-specific ones come later. */
773 if (k == 0 && has_sometimes_template (element)) {
774 query = g_new0 (GSignalQuery, 1);
775 g_signal_query (g_signal_lookup ("pad-added", GST_TYPE_ELEMENT), query);
776 found_signals = g_slist_append (found_signals, query);
777 query = g_new0 (GSignalQuery, 1);
778 g_signal_query (g_signal_lookup ("pad-removed", GST_TYPE_ELEMENT), query);
779 found_signals = g_slist_append (found_signals, query);
780 query = g_new0 (GSignalQuery, 1);
781 g_signal_query (g_signal_lookup ("no-more-pads", GST_TYPE_ELEMENT),
783 found_signals = g_slist_append (found_signals, query);
786 for (type = G_OBJECT_TYPE (element); type; type = g_type_parent (type)) {
787 if (type == GST_TYPE_ELEMENT || type == GST_TYPE_OBJECT)
790 if (type == GST_TYPE_BIN && G_OBJECT_TYPE (element) != GST_TYPE_BIN)
793 signals = g_signal_list_ids (type, &nsignals);
794 for (i = 0; i < nsignals; i++) {
795 query = g_new0 (GSignalQuery, 1);
796 g_signal_query (signals[i], query);
798 if ((k == 0 && !(query->signal_flags & G_SIGNAL_ACTION)) ||
799 (k == 1 && (query->signal_flags & G_SIGNAL_ACTION)))
800 found_signals = g_slist_append (found_signals, query);
811 n_print ("Element Signals:\n");
813 n_print ("Element Actions:\n");
818 for (l = found_signals; l; l = l->next) {
823 query = (GSignalQuery *) l->data;
824 indent_len = strlen (query->signal_name) +
825 strlen (g_type_name (query->return_type)) + 24;
827 if (gtype_needs_ptr_marker (query->return_type)) {
834 indent = g_new0 (gchar, indent_len + 1);
835 memset (indent, ' ', indent_len);
837 n_print (" \"%s\" : %s %suser_function (%s* object",
838 query->signal_name, g_type_name (query->return_type), pmark,
841 for (j = 0; j < query->n_params; j++) {
842 const gchar *type_name, *asterisk;
844 type_name = g_type_name (query->param_types[j]);
845 asterisk = gtype_needs_ptr_marker (query->param_types[j]) ? "*" : "";
848 n_print ("%s%s%s arg%d", indent, type_name, asterisk, j);
853 n_print ("%sgpointer user_data);\n", indent);
861 g_slist_foreach (found_signals, (GFunc) g_free, NULL);
862 g_slist_free (found_signals);
868 print_children_info (GstElement * element)
872 if (!GST_IS_BIN (element))
875 children = (GList *) GST_BIN (element)->children;
878 n_print ("Children:\n");
882 n_print (" %s\n", GST_ELEMENT_NAME (GST_ELEMENT (children->data)));
883 children = g_list_next (children);
888 print_preset_list (GstElement * element)
890 gchar **presets, **preset;
892 if (!GST_IS_PRESET (element))
895 presets = gst_preset_get_preset_names (GST_PRESET (element));
896 if (presets && *presets) {
898 n_print ("Presets:\n");
899 for (preset = presets; *preset; preset++) {
900 n_print (" \"%s\"\n", *preset);
902 g_strfreev (presets);
907 print_blacklist (void)
909 GList *plugins, *cur;
912 g_print ("%s\n", _("Blacklisted files:"));
914 plugins = gst_registry_get_plugin_list (gst_registry_get ());
915 for (cur = plugins; cur != NULL; cur = g_list_next (cur)) {
916 GstPlugin *plugin = (GstPlugin *) (cur->data);
917 if (GST_OBJECT_FLAG_IS_SET (plugin, GST_PLUGIN_FLAG_BLACKLISTED)) {
918 g_print (" %s\n", gst_plugin_get_name (plugin));
924 g_print (_("Total count: "));
925 g_print (ngettext ("%d blacklisted file", "%d blacklisted files", count),
928 gst_plugin_list_free (plugins);
932 print_typefind_extensions (const gchar * const *extensions)
936 while (extensions[i]) {
937 g_print ("%s%s", i > 0 ? ", " : "", extensions[i]);
943 print_element_list (gboolean print_all, gchar * ftypes)
945 int plugincount = 0, featurecount = 0, blacklistcount = 0;
946 GList *plugins, *orig_plugins;
947 gchar **types = NULL;
952 types = g_strsplit (ftypes, "/", -1);
953 for (i = 0; types[i]; i++)
954 *types[i] = g_ascii_toupper (*types[i]);
958 orig_plugins = plugins = gst_registry_get_plugin_list (gst_registry_get ());
960 GList *features, *orig_features;
963 plugin = (GstPlugin *) (plugins->data);
964 plugins = g_list_next (plugins);
967 if (GST_OBJECT_FLAG_IS_SET (plugin, GST_PLUGIN_FLAG_BLACKLISTED)) {
972 orig_features = features =
973 gst_registry_get_feature_list_by_plugin (gst_registry_get (),
974 gst_plugin_get_name (plugin));
976 GstPluginFeature *feature;
978 if (G_UNLIKELY (features->data == NULL))
980 feature = GST_PLUGIN_FEATURE (features->data);
983 if (GST_IS_ELEMENT_FACTORY (feature)) {
985 GstElementFactory *factory;
987 factory = GST_ELEMENT_FACTORY (feature);
990 gboolean all_found = TRUE;
993 gst_element_factory_get_metadata (factory,
994 GST_ELEMENT_METADATA_KLASS);
995 for (i = 0; types[i]; i++) {
996 if (!strstr (klass, types[i])) {
1006 print_element_info (feature, TRUE);
1008 g_print ("%s: %s: %s\n", gst_plugin_get_name (plugin),
1009 GST_OBJECT_NAME (factory),
1010 gst_element_factory_get_metadata (factory,
1011 GST_ELEMENT_METADATA_LONGNAME));
1012 } else if (GST_IS_TYPE_FIND_FACTORY (feature)) {
1013 GstTypeFindFactory *factory;
1014 const gchar *const *extensions;
1018 factory = GST_TYPE_FIND_FACTORY (feature);
1020 g_print ("%s: %s: ", gst_plugin_get_name (plugin),
1021 gst_plugin_feature_get_name (feature));
1023 extensions = gst_type_find_factory_get_extensions (factory);
1024 if (extensions != NULL) {
1026 print_typefind_extensions (extensions);
1031 g_print ("no extensions\n");
1037 n_print ("%s: %s (%s)\n", gst_plugin_get_name (plugin),
1038 GST_OBJECT_NAME (feature), g_type_name (G_OBJECT_TYPE (feature)));
1042 features = g_list_next (features);
1045 gst_plugin_feature_list_free (orig_features);
1048 gst_plugin_list_free (orig_plugins);
1052 g_print (_("Total count: "));
1053 g_print (ngettext ("%d plugin", "%d plugins", plugincount), plugincount);
1054 if (blacklistcount) {
1056 g_print (ngettext ("%d blacklist entry", "%d blacklist entries",
1057 blacklistcount), blacklistcount);
1058 g_print (" not shown)");
1061 g_print (ngettext ("%d feature", "%d features", featurecount), featurecount);
1066 print_all_uri_handlers (void)
1068 GList *plugins, *p, *features, *f;
1070 plugins = gst_registry_get_plugin_list (gst_registry_get ());
1072 for (p = plugins; p; p = p->next) {
1073 GstPlugin *plugin = (GstPlugin *) (p->data);
1076 gst_registry_get_feature_list_by_plugin (gst_registry_get (),
1077 gst_plugin_get_name (plugin));
1079 for (f = features; f; f = f->next) {
1080 GstPluginFeature *feature = GST_PLUGIN_FEATURE (f->data);
1082 if (GST_IS_ELEMENT_FACTORY (feature)) {
1083 GstElementFactory *factory;
1084 GstElement *element;
1086 factory = GST_ELEMENT_FACTORY (gst_plugin_feature_load (feature));
1088 g_print ("element plugin %s couldn't be loaded\n",
1089 gst_plugin_get_name (plugin));
1093 element = gst_element_factory_create (factory, NULL);
1095 g_print ("couldn't construct element for %s for some reason\n",
1096 GST_OBJECT_NAME (factory));
1097 gst_object_unref (factory);
1101 if (GST_IS_URI_HANDLER (element)) {
1102 const gchar *const *uri_protocols;
1106 switch (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element))) {
1119 gst_uri_handler_get_protocols (GST_URI_HANDLER (element));
1120 joined = g_strjoinv (", ", (gchar **) uri_protocols);
1122 g_print ("%s (%s, rank %u): %s\n",
1123 gst_plugin_feature_get_name (GST_PLUGIN_FEATURE (factory)), dir,
1124 gst_plugin_feature_get_rank (GST_PLUGIN_FEATURE (factory)),
1130 gst_object_unref (element);
1131 gst_object_unref (factory);
1135 gst_plugin_feature_list_free (features);
1138 gst_plugin_list_free (plugins);
1142 print_plugin_info (GstPlugin * plugin)
1144 const gchar *release_date = gst_plugin_get_release_date_string (plugin);
1145 const gchar *filename = gst_plugin_get_filename (plugin);
1147 n_print ("Plugin Details:\n");
1148 n_print (" %-25s%s\n", "Name", gst_plugin_get_name (plugin));
1149 n_print (" %-25s%s\n", "Description", gst_plugin_get_description (plugin));
1150 n_print (" %-25s%s\n", "Filename", (filename != NULL) ? filename : "(null)");
1151 n_print (" %-25s%s\n", "Version", gst_plugin_get_version (plugin));
1152 n_print (" %-25s%s\n", "License", gst_plugin_get_license (plugin));
1153 n_print (" %-25s%s\n", "Source module", gst_plugin_get_source (plugin));
1155 if (release_date != NULL) {
1156 const gchar *tz = "(UTC)";
1159 /* may be: YYYY-MM-DD or YYYY-MM-DDTHH:MMZ */
1160 /* YYYY-MM-DDTHH:MMZ => YYYY-MM-DD HH:MM (UTC) */
1161 str = g_strdup (release_date);
1162 sep = strstr (str, "T");
1165 sep = strstr (sep + 1, "Z");
1171 n_print (" %-25s%s%s\n", "Source release date", str, tz);
1174 n_print (" %-25s%s\n", "Binary package", gst_plugin_get_package (plugin));
1175 n_print (" %-25s%s\n", "Origin URL", gst_plugin_get_origin (plugin));
1180 print_plugin_features (GstPlugin * plugin)
1182 GList *features, *origlist;
1183 gint num_features = 0;
1184 gint num_elements = 0;
1185 gint num_tracers = 0;
1186 gint num_typefinders = 0;
1187 gint num_devproviders = 0;
1190 origlist = features =
1191 gst_registry_get_feature_list_by_plugin (gst_registry_get (),
1192 gst_plugin_get_name (plugin));
1195 GstPluginFeature *feature;
1197 feature = GST_PLUGIN_FEATURE (features->data);
1199 if (GST_IS_ELEMENT_FACTORY (feature)) {
1200 GstElementFactory *factory;
1202 factory = GST_ELEMENT_FACTORY (feature);
1203 n_print (" %s: %s\n", GST_OBJECT_NAME (factory),
1204 gst_element_factory_get_metadata (factory,
1205 GST_ELEMENT_METADATA_LONGNAME));
1207 } else if (GST_IS_TYPE_FIND_FACTORY (feature)) {
1208 GstTypeFindFactory *factory;
1209 const gchar *const *extensions;
1211 factory = GST_TYPE_FIND_FACTORY (feature);
1212 extensions = gst_type_find_factory_get_extensions (factory);
1216 g_print (" %s: %s: ", gst_plugin_get_name (plugin),
1217 gst_plugin_feature_get_name (feature));
1218 while (extensions[i]) {
1219 g_print ("%s%s", i > 0 ? ", " : "", extensions[i]);
1224 g_print (" %s: %s: no extensions\n", gst_plugin_get_name (plugin),
1225 gst_plugin_feature_get_name (feature));
1228 } else if (GST_IS_DEVICE_PROVIDER_FACTORY (feature)) {
1229 GstDeviceProviderFactory *factory;
1231 factory = GST_DEVICE_PROVIDER_FACTORY (feature);
1232 n_print (" %s: %s\n", GST_OBJECT_NAME (factory),
1233 gst_device_provider_factory_get_metadata (factory,
1234 GST_ELEMENT_METADATA_LONGNAME));
1236 } else if (GST_IS_TRACER_FACTORY (feature)) {
1237 n_print (" %s (%s)\n", gst_object_get_name (GST_OBJECT (feature)),
1238 g_type_name (G_OBJECT_TYPE (feature)));
1240 } else if (feature) {
1241 n_print (" %s (%s)\n", gst_object_get_name (GST_OBJECT (feature)),
1242 g_type_name (G_OBJECT_TYPE (feature)));
1246 features = g_list_next (features);
1249 gst_plugin_feature_list_free (origlist);
1252 n_print (" %d features:\n", num_features);
1253 if (num_elements > 0)
1254 n_print (" +-- %d elements\n", num_elements);
1255 if (num_typefinders > 0)
1256 n_print (" +-- %d typefinders\n", num_typefinders);
1257 if (num_devproviders > 0)
1258 n_print (" +-- %d device providers\n", num_devproviders);
1259 if (num_tracers > 0)
1260 n_print (" +-- %d tracers\n", num_tracers);
1262 n_print (" +-- %d other objects\n", num_other);
1268 print_feature_info (const gchar * feature_name, gboolean print_all)
1270 GstPluginFeature *feature;
1271 GstRegistry *registry = gst_registry_get ();
1274 if ((feature = gst_registry_find_feature (registry, feature_name,
1275 GST_TYPE_ELEMENT_FACTORY))) {
1276 ret = print_element_info (feature, print_all);
1279 if ((feature = gst_registry_find_feature (registry, feature_name,
1280 GST_TYPE_TYPE_FIND_FACTORY))) {
1281 ret = print_typefind_info (feature, print_all);
1284 if ((feature = gst_registry_find_feature (registry, feature_name,
1285 GST_TYPE_TRACER_FACTORY))) {
1286 ret = print_tracer_info (feature, print_all);
1290 /* TODO: handle DEVICE_PROVIDER_FACTORY */
1295 gst_object_unref (feature);
1300 print_element_info (GstPluginFeature * feature, gboolean print_names)
1302 GstElementFactory *factory;
1303 GstElement *element;
1307 factory = GST_ELEMENT_FACTORY (gst_plugin_feature_load (feature));
1309 g_print ("element plugin couldn't be loaded\n");
1313 element = gst_element_factory_create (factory, NULL);
1315 gst_object_unref (factory);
1316 g_print ("couldn't construct element for some reason\n");
1321 _name = g_strdup_printf ("%s: ", GST_OBJECT_NAME (factory));
1325 print_factory_details_info (factory);
1327 plugin = gst_plugin_feature_get_plugin (GST_PLUGIN_FEATURE (factory));
1329 print_plugin_info (plugin);
1330 gst_object_unref (plugin);
1333 print_hierarchy (G_OBJECT_TYPE (element), 0, &maxlevel);
1334 print_interfaces (G_OBJECT_TYPE (element));
1336 print_pad_templates_info (element, factory);
1337 print_element_flag_info (element);
1338 print_clocking_info (element);
1339 print_uri_handler_info (element);
1340 print_pad_info (element);
1341 print_element_properties_info (element);
1342 print_signal_info (element);
1343 print_children_info (element);
1344 print_preset_list (element);
1346 gst_object_unref (element);
1347 gst_object_unref (factory);
1353 print_typefind_info (GstPluginFeature * feature, gboolean print_names)
1355 GstTypeFindFactory *factory;
1360 const gchar *const *extensions;
1362 factory = GST_TYPE_FIND_FACTORY (gst_plugin_feature_load (feature));
1364 g_print ("typefind plugin couldn't be loaded\n");
1369 _name = g_strdup_printf ("%s: ", GST_OBJECT_NAME (factory));
1373 n_print ("Factory Details:\n");
1374 rank = gst_plugin_feature_get_rank (feature);
1375 n_print (" %-25s%s (%d)\n", "Rank", get_rank_name (s, rank), rank);
1376 n_print (" %-25s%s\n", "Name", GST_OBJECT_NAME (factory));
1377 caps = gst_type_find_factory_get_caps (factory);
1379 gchar *caps_str = gst_caps_to_string (factory->caps);
1381 n_print (" %-25s%s\n", "Caps", caps_str);
1384 extensions = gst_type_find_factory_get_extensions (factory);
1386 n_print (" %-25s", "Extensions");
1387 print_typefind_extensions (extensions);
1392 plugin = gst_plugin_feature_get_plugin (GST_PLUGIN_FEATURE (factory));
1394 print_plugin_info (plugin);
1395 gst_object_unref (plugin);
1398 gst_object_unref (factory);
1404 print_tracer_info (GstPluginFeature * feature, gboolean print_names)
1406 GstTracerFactory *factory;
1411 factory = GST_TRACER_FACTORY (gst_plugin_feature_load (feature));
1413 g_print ("tracer plugin couldn't be loaded\n");
1417 tracer = (GstTracer *) g_object_new (factory->type, NULL);
1419 gst_object_unref (factory);
1420 g_print ("couldn't construct tracer for some reason\n");
1425 _name = g_strdup_printf ("%s: ", GST_OBJECT_NAME (factory));
1429 n_print ("Factory Details:\n");
1430 n_print (" %-25s%s\n", "Name", GST_OBJECT_NAME (factory));
1433 plugin = gst_plugin_feature_get_plugin (GST_PLUGIN_FEATURE (factory));
1435 print_plugin_info (plugin);
1436 gst_object_unref (plugin);
1439 print_hierarchy (G_OBJECT_TYPE (tracer), 0, &maxlevel);
1440 print_interfaces (G_OBJECT_TYPE (tracer));
1442 /* TODO: list what hooks it registers
1443 * - the data is available in gsttracerutils, we need to iterate the
1444 * _priv_tracers hashtable for each probe and then check the list of hooks
1445 * for each probe whether hook->tracer == tracer :/
1448 /* TODO: list what records it emits
1449 * - in class_init tracers can create GstTracerRecord instances
1450 * - those only get logged right now and there is no association with the
1451 * tracer that created them
1452 * - we'd need to add them to GstTracerFactory
1453 * gst_tracer_class_add_record (klass, record);
1454 * - needs work in gstregistrychunks.
1457 gst_object_unref (tracer);
1458 gst_object_unref (factory);
1464 print_plugin_automatic_install_info_codecs (GstElementFactory * factory)
1466 GstPadDirection direction;
1467 const gchar *type_name;
1469 const GList *static_templates, *l;
1470 GstCaps *caps = NULL;
1474 gst_element_factory_get_metadata (factory, GST_ELEMENT_METADATA_KLASS);
1475 g_return_if_fail (klass != NULL);
1477 if (strstr (klass, "Demuxer") ||
1478 strstr (klass, "Decoder") ||
1479 strstr (klass, "Depay") || strstr (klass, "Parser")) {
1480 type_name = "decoder";
1481 direction = GST_PAD_SINK;
1482 } else if (strstr (klass, "Muxer") ||
1483 strstr (klass, "Encoder") || strstr (klass, "Pay")) {
1484 type_name = "encoder";
1485 direction = GST_PAD_SRC;
1490 /* decoder/demuxer sink pads should always be static and there should only
1491 * be one, the same applies to encoders/muxers and source pads */
1492 static_templates = gst_element_factory_get_static_pad_templates (factory);
1493 for (l = static_templates; l != NULL; l = l->next) {
1494 GstStaticPadTemplate *tmpl = NULL;
1496 tmpl = (GstStaticPadTemplate *) l->data;
1497 if (tmpl->direction == direction) {
1498 caps = gst_static_pad_template_get_caps (tmpl);
1504 g_printerr ("Couldn't find static pad template for %s '%s'\n",
1505 type_name, GST_OBJECT_NAME (factory));
1509 caps = gst_caps_make_writable (caps);
1510 num = gst_caps_get_size (caps);
1511 for (i = 0; i < num; ++i) {
1515 s = gst_caps_get_structure (caps, i);
1516 /* remove fields that are almost always just MIN-MAX of some sort
1517 * in order to make the caps look less messy */
1518 gst_structure_remove_field (s, "pixel-aspect-ratio");
1519 gst_structure_remove_field (s, "framerate");
1520 gst_structure_remove_field (s, "channels");
1521 gst_structure_remove_field (s, "width");
1522 gst_structure_remove_field (s, "height");
1523 gst_structure_remove_field (s, "rate");
1524 gst_structure_remove_field (s, "depth");
1525 gst_structure_remove_field (s, "clock-rate");
1526 s_str = gst_structure_to_string (s);
1527 g_print ("%s-%s\n", type_name, s_str);
1530 gst_caps_unref (caps);
1534 print_plugin_automatic_install_info_protocols (GstElementFactory * factory)
1536 const gchar *const *protocols;
1538 protocols = gst_element_factory_get_uri_protocols (factory);
1539 if (protocols != NULL && *protocols != NULL) {
1540 switch (gst_element_factory_get_uri_type (factory)) {
1542 while (*protocols != NULL) {
1543 g_print ("urisink-%s\n", *protocols);
1548 while (*protocols != NULL) {
1549 g_print ("urisource-%s\n", *protocols);
1560 print_plugin_automatic_install_info (GstPlugin * plugin)
1562 GList *features, *l;
1564 /* not interested in typefind factories, only element factories */
1565 features = gst_registry_get_feature_list (gst_registry_get (),
1566 GST_TYPE_ELEMENT_FACTORY);
1568 for (l = features; l != NULL; l = l->next) {
1569 GstPluginFeature *feature;
1570 GstPlugin *feature_plugin;
1572 feature = GST_PLUGIN_FEATURE (l->data);
1574 /* only interested in the ones that are in the plugin we just loaded */
1575 feature_plugin = gst_plugin_feature_get_plugin (feature);
1576 if (feature_plugin == plugin) {
1577 GstElementFactory *factory;
1579 g_print ("element-%s\n", gst_plugin_feature_get_name (feature));
1581 factory = GST_ELEMENT_FACTORY (feature);
1582 print_plugin_automatic_install_info_protocols (factory);
1583 print_plugin_automatic_install_info_codecs (factory);
1586 gst_object_unref (feature_plugin);
1589 g_list_foreach (features, (GFunc) gst_object_unref, NULL);
1590 g_list_free (features);
1594 print_all_plugin_automatic_install_info (void)
1596 GList *plugins, *orig_plugins;
1598 orig_plugins = plugins = gst_registry_get_plugin_list (gst_registry_get ());
1602 plugin = (GstPlugin *) (plugins->data);
1603 plugins = g_list_next (plugins);
1605 print_plugin_automatic_install_info (plugin);
1607 gst_plugin_list_free (orig_plugins);
1611 main (int argc, char *argv[])
1613 gboolean print_all = FALSE;
1614 gboolean do_print_blacklist = FALSE;
1615 gboolean plugin_name = FALSE;
1616 gboolean print_aii = FALSE;
1617 gboolean uri_handlers = FALSE;
1618 gboolean check_exists = FALSE;
1619 gchar *min_version = NULL;
1620 guint minver_maj = GST_VERSION_MAJOR;
1621 guint minver_min = GST_VERSION_MINOR;
1622 guint minver_micro = 0;
1623 gchar *types = NULL;
1624 #ifndef GST_DISABLE_OPTION_PARSING
1625 GOptionEntry options[] = {
1626 {"print-all", 'a', 0, G_OPTION_ARG_NONE, &print_all,
1627 N_("Print all elements"), NULL},
1628 {"print-blacklist", 'b', 0, G_OPTION_ARG_NONE, &do_print_blacklist,
1629 N_("Print list of blacklisted files"), NULL},
1630 {"print-plugin-auto-install-info", '\0', 0, G_OPTION_ARG_NONE, &print_aii,
1631 N_("Print a machine-parsable list of features the specified plugin "
1632 "or all plugins provide.\n "
1633 "Useful in connection with external automatic plugin "
1634 "installation mechanisms"), NULL},
1635 {"plugin", '\0', 0, G_OPTION_ARG_NONE, &plugin_name,
1636 N_("List the plugin contents"), NULL},
1637 {"types", 't', 0, G_OPTION_ARG_STRING, &types,
1638 N_("A slashes ('/') separated list of types of elements (also known "
1639 "as klass) to list. (unordered)"), NULL},
1640 {"exists", '\0', 0, G_OPTION_ARG_NONE, &check_exists,
1641 N_("Check if the specified element or plugin exists"), NULL},
1642 {"atleast-version", '\0', 0, G_OPTION_ARG_STRING, &min_version,
1644 ("When checking if an element or plugin exists, also check that its "
1645 "version is at least the version specified"), NULL},
1646 {"uri-handlers", 'u', 0, G_OPTION_ARG_NONE, &uri_handlers,
1648 ("Print supported URI schemes, with the elements that implement them"),
1650 GST_TOOLS_GOPTION_VERSION,
1653 GOptionContext *ctx;
1657 setlocale (LC_ALL, "");
1660 bindtextdomain (GETTEXT_PACKAGE, LOCALEDIR);
1661 bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
1662 textdomain (GETTEXT_PACKAGE);
1665 /* avoid glib warnings when inspecting deprecated properties */
1666 g_setenv ("G_ENABLE_DIAGNOSTIC", "0", FALSE);
1668 g_set_prgname ("gst-inspect-" GST_API_VERSION);
1670 #ifndef GST_DISABLE_OPTION_PARSING
1671 ctx = g_option_context_new ("[ELEMENT-NAME | PLUGIN-NAME]");
1672 g_option_context_add_main_entries (ctx, options, GETTEXT_PACKAGE);
1673 g_option_context_add_group (ctx, gst_init_get_option_group ());
1674 if (!g_option_context_parse (ctx, &argc, &argv, &err)) {
1675 g_printerr ("Error initializing: %s\n", err->message);
1676 g_clear_error (&err);
1677 g_option_context_free (ctx);
1680 g_option_context_free (ctx);
1682 gst_init (&argc, &argv);
1685 gst_tools_print_version ();
1687 if (print_all && argc > 1) {
1688 g_printerr ("-a requires no extra arguments\n");
1692 if (uri_handlers && argc > 1) {
1693 g_printerr ("-u requires no extra arguments\n");
1697 /* --atleast-version implies --exists */
1698 if (min_version != NULL) {
1699 if (sscanf (min_version, "%u.%u.%u", &minver_maj, &minver_min,
1700 &minver_micro) < 2) {
1701 g_printerr ("Can't parse version '%s' passed to --atleast-version\n",
1705 check_exists = TRUE;
1712 g_printerr ("--exists requires an extra command line argument\n");
1716 GstPluginFeature *feature;
1718 feature = gst_registry_lookup_feature (gst_registry_get (), argv[1]);
1719 if (feature != NULL && gst_plugin_feature_check_version (feature,
1720 minver_maj, minver_min, minver_micro)) {
1727 gst_object_unref (feature);
1729 /* FIXME: support checking for plugins too */
1730 g_printerr ("Checking for plugins is not supported yet\n");
1737 /* if no arguments, print out list of elements */
1739 print_all_uri_handlers ();
1740 } else if (argc == 1 || print_all) {
1741 if (do_print_blacklist)
1745 print_all_plugin_automatic_install_info ();
1747 print_element_list (print_all, types);
1750 /* else we try to get a factory */
1751 const char *arg = argv[argc - 1];
1755 retval = print_feature_info (arg, print_all);
1758 /* otherwise check if it's a plugin */
1760 GstPlugin *plugin = gst_registry_find_plugin (gst_registry_get (), arg);
1762 /* if there is such a plugin, print out info */
1765 print_plugin_automatic_install_info (plugin);
1767 print_plugin_info (plugin);
1768 print_plugin_features (plugin);
1771 GError *error = NULL;
1773 if (g_file_test (arg, G_FILE_TEST_EXISTS)) {
1774 plugin = gst_plugin_load_file (arg, &error);
1778 print_plugin_automatic_install_info (plugin);
1780 print_plugin_info (plugin);
1781 print_plugin_features (plugin);
1784 g_printerr (_("Could not load plugin file: %s\n"), error->message);
1785 g_clear_error (&error);
1789 g_printerr (_("No such element or plugin '%s'\n"), arg);