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
36 #include <glib/gprintf.h>
38 static char *_name = NULL;
40 static int print_element_info (GstElementFactory * factory,
41 gboolean print_names);
47 n_print (const char *format, ...)
52 g_print ("%s", _name);
54 va_start (args, format);
55 g_vprintf (format, args);
60 print_field (GQuark field, const GValue * value, gpointer pfx)
62 gchar *str = gst_value_serialize (value);
64 n_print ("%s %15s: %s\n", (gchar *) pfx, g_quark_to_string (field), str);
70 print_caps (const GstCaps * caps, const gchar * pfx)
74 g_return_if_fail (caps != NULL);
76 if (gst_caps_is_any (caps)) {
77 n_print ("%sANY\n", pfx);
80 if (gst_caps_is_empty (caps)) {
81 n_print ("%sEMPTY\n", pfx);
85 for (i = 0; i < gst_caps_get_size (caps); i++) {
86 GstStructure *structure = gst_caps_get_structure (caps, i);
87 GstCapsFeatures *features = gst_caps_get_features (caps, i);
89 if (features && (gst_caps_features_is_any (features) ||
90 !gst_caps_features_is_equal (features,
91 GST_CAPS_FEATURES_MEMORY_SYSTEM_MEMORY))) {
92 gchar *features_string = gst_caps_features_to_string (features);
94 n_print ("%s%s(%s)\n", pfx, gst_structure_get_name (structure),
96 g_free (features_string);
98 n_print ("%s%s\n", pfx, gst_structure_get_name (structure));
100 gst_structure_foreach (structure, print_field, (gpointer) pfx);
105 get_rank_name (char *s, gint rank)
107 static const int ranks[4] = {
108 GST_RANK_NONE, GST_RANK_MARGINAL, GST_RANK_SECONDARY, GST_RANK_PRIMARY
110 static const char *rank_names[4] = { "none", "marginal", "secondary",
117 for (i = 0; i < 4; i++) {
118 if (rank == ranks[i])
119 return rank_names[i];
120 if (abs (rank - ranks[i]) < abs (rank - ranks[best_i])) {
125 sprintf (s, "%s %c %d", rank_names[best_i],
126 (rank - ranks[best_i] > 0) ? '+' : '-', abs (ranks[best_i] - rank));
132 print_factory_details_info (GstElementFactory * factory)
138 rank = gst_plugin_feature_get_rank (GST_PLUGIN_FEATURE (factory));
139 n_print ("Factory Details:\n");
140 n_print (" %-25s%s (%d)\n", "Rank", get_rank_name (s, rank), rank);
142 keys = gst_element_factory_get_metadata_keys (factory);
144 for (k = keys; *k != NULL; ++k) {
148 val = gst_element_factory_get_metadata (factory, key);
149 key[0] = g_ascii_toupper (key[0]);
150 n_print (" %-25s%s\n", key, val);
158 print_hierarchy (GType type, gint level, gint * maxlevel)
163 parent = g_type_parent (type);
165 *maxlevel = *maxlevel + 1;
169 print_hierarchy (parent, level, maxlevel);
172 g_print ("%s", _name);
174 for (i = 1; i < *maxlevel - level; i++)
176 if (*maxlevel - level)
179 g_print ("%s\n", g_type_name (type));
186 print_interfaces (GType type)
189 GType *iface, *ifaces = g_type_interfaces (type, &n_ifaces);
194 g_print ("%s", _name);
195 g_print (_("Implemented Interfaces:\n"));
199 g_print ("%s", _name);
200 g_print (" %s\n", g_type_name (*iface));
204 g_print ("%s", _name);
212 flags_to_string (GFlagsValue * vals, guint flags)
217 /* first look for an exact match and count the number of values */
218 for (i = 0; vals[i].value_name != NULL; ++i) {
219 if (vals[i].value == flags)
220 return g_strdup (vals[i].value_nick);
223 s = g_string_new (NULL);
225 /* we assume the values are sorted from lowest to highest value */
229 if (vals[i].value != 0 && (flags_left & vals[i].value) == vals[i].value) {
231 g_string_append_c (s, '+');
232 g_string_append (s, vals[i].value_nick);
233 flags_left -= vals[i].value;
240 g_string_assign (s, "(none)");
242 return g_string_free (s, FALSE);
245 #define KNOWN_PARAM_FLAGS \
246 (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY | \
247 G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS | \
248 G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_DEPRECATED | \
249 GST_PARAM_CONTROLLABLE | GST_PARAM_MUTABLE_PLAYING | \
250 GST_PARAM_MUTABLE_PAUSED | GST_PARAM_MUTABLE_READY)
253 print_element_properties_info (GstElement * element)
255 GParamSpec **property_specs;
256 guint num_properties, i;
260 property_specs = g_object_class_list_properties
261 (G_OBJECT_GET_CLASS (element), &num_properties);
263 n_print ("Element Properties:\n");
265 for (i = 0; i < num_properties; i++) {
266 GValue value = { 0, };
267 GParamSpec *param = property_specs[i];
271 g_value_init (&value, param->value_type);
273 n_print (" %-20s: %s\n", g_param_spec_get_name (param),
274 g_param_spec_get_blurb (param));
277 n_print ("%-23.23s flags: ", "");
278 if (param->flags & G_PARAM_READABLE) {
279 g_object_get_property (G_OBJECT (element), param->name, &value);
281 g_print ("%s%s", (first_flag) ? "" : ", ", _("readable"));
284 /* if we can't read the property value, assume it's set to the default
285 * (which might not be entirely true for sub-classes, but that's an
286 * unlikely corner-case anyway) */
287 g_param_value_set_default (param, &value);
289 if (param->flags & G_PARAM_WRITABLE) {
290 g_print ("%s%s", (first_flag) ? "" : ", ", _("writable"));
293 if (param->flags & G_PARAM_DEPRECATED) {
294 g_print ("%s%s", (first_flag) ? "" : ", ", _("deprecated"));
297 if (param->flags & GST_PARAM_CONTROLLABLE) {
298 g_print (", %s", _("controllable"));
301 if (param->flags & GST_PARAM_MUTABLE_PLAYING) {
302 g_print (", %s", _("changeable in NULL, READY, PAUSED or PLAYING state"));
303 } else if (param->flags & GST_PARAM_MUTABLE_PAUSED) {
304 g_print (", %s", _("changeable only in NULL, READY or PAUSED state"));
305 } else if (param->flags & GST_PARAM_MUTABLE_READY) {
306 g_print (", %s", _("changeable only in NULL or READY state"));
308 if (param->flags & ~KNOWN_PARAM_FLAGS) {
309 g_print ("%s0x%0x", (first_flag) ? "" : ", ",
310 param->flags & ~KNOWN_PARAM_FLAGS);
314 switch (G_VALUE_TYPE (&value)) {
317 const char *string_val = g_value_get_string (&value);
319 n_print ("%-23.23s String. ", "");
321 if (string_val == NULL)
322 g_print ("Default: null");
324 g_print ("Default: \"%s\"", string_val);
329 gboolean bool_val = g_value_get_boolean (&value);
331 n_print ("%-23.23s Boolean. ", "");
333 g_print ("Default: %s", bool_val ? "true" : "false");
338 GParamSpecULong *pulong = G_PARAM_SPEC_ULONG (param);
340 n_print ("%-23.23s Unsigned Long. ", "");
341 g_print ("Range: %lu - %lu Default: %lu ",
342 pulong->minimum, pulong->maximum, g_value_get_ulong (&value));
344 GST_ERROR ("%s: property '%s' of type ulong: consider changing to "
345 "uint/uint64", GST_OBJECT_NAME (element),
346 g_param_spec_get_name (param));
351 GParamSpecLong *plong = G_PARAM_SPEC_LONG (param);
353 n_print ("%-23.23s Long. ", "");
354 g_print ("Range: %ld - %ld Default: %ld ",
355 plong->minimum, plong->maximum, g_value_get_long (&value));
357 GST_ERROR ("%s: property '%s' of type long: consider changing to "
358 "int/int64", GST_OBJECT_NAME (element),
359 g_param_spec_get_name (param));
364 GParamSpecUInt *puint = G_PARAM_SPEC_UINT (param);
366 n_print ("%-23.23s Unsigned Integer. ", "");
367 g_print ("Range: %u - %u Default: %u ",
368 puint->minimum, puint->maximum, g_value_get_uint (&value));
373 GParamSpecInt *pint = G_PARAM_SPEC_INT (param);
375 n_print ("%-23.23s Integer. ", "");
376 g_print ("Range: %d - %d Default: %d ",
377 pint->minimum, pint->maximum, g_value_get_int (&value));
382 GParamSpecUInt64 *puint64 = G_PARAM_SPEC_UINT64 (param);
384 n_print ("%-23.23s Unsigned Integer64. ", "");
385 g_print ("Range: %" G_GUINT64_FORMAT " - %" G_GUINT64_FORMAT
386 " Default: %" G_GUINT64_FORMAT " ",
387 puint64->minimum, puint64->maximum, g_value_get_uint64 (&value));
392 GParamSpecInt64 *pint64 = G_PARAM_SPEC_INT64 (param);
394 n_print ("%-23.23s Integer64. ", "");
395 g_print ("Range: %" G_GINT64_FORMAT " - %" G_GINT64_FORMAT
396 " Default: %" G_GINT64_FORMAT " ",
397 pint64->minimum, pint64->maximum, g_value_get_int64 (&value));
402 GParamSpecFloat *pfloat = G_PARAM_SPEC_FLOAT (param);
404 n_print ("%-23.23s Float. ", "");
405 g_print ("Range: %15.7g - %15.7g Default: %15.7g ",
406 pfloat->minimum, pfloat->maximum, g_value_get_float (&value));
411 GParamSpecDouble *pdouble = G_PARAM_SPEC_DOUBLE (param);
413 n_print ("%-23.23s Double. ", "");
414 g_print ("Range: %15.7g - %15.7g Default: %15.7g ",
415 pdouble->minimum, pdouble->maximum, g_value_get_double (&value));
420 GST_ERROR ("%s: property '%s' of type char: consider changing to "
421 "int/string", GST_OBJECT_NAME (element),
422 g_param_spec_get_name (param));
425 if (param->value_type == GST_TYPE_CAPS) {
426 const GstCaps *caps = gst_value_get_caps (&value);
429 n_print ("%-23.23s Caps (NULL)", "");
431 print_caps (caps, " ");
433 } else if (G_IS_PARAM_SPEC_ENUM (param)) {
437 const gchar *value_nick = "";
439 values = G_ENUM_CLASS (g_type_class_ref (param->value_type))->values;
440 enum_value = g_value_get_enum (&value);
442 while (values[j].value_name) {
443 if (values[j].value == enum_value)
444 value_nick = values[j].value_nick;
448 n_print ("%-23.23s Enum \"%s\" Default: %d, \"%s\"", "",
449 g_type_name (G_VALUE_TYPE (&value)), enum_value, value_nick);
452 while (values[j].value_name) {
455 g_print ("%s", _name);
456 g_print ("%-23.23s (%d): %-16s - %s", "",
457 values[j].value, values[j].value_nick, values[j].value_name);
460 /* g_type_class_unref (ec); */
461 } else if (G_IS_PARAM_SPEC_FLAGS (param)) {
462 GParamSpecFlags *pflags = G_PARAM_SPEC_FLAGS (param);
466 vals = pflags->flags_class->values;
468 cur = flags_to_string (vals, g_value_get_flags (&value));
470 n_print ("%-23.23s Flags \"%s\" Default: 0x%08x, \"%s\"", "",
471 g_type_name (G_VALUE_TYPE (&value)),
472 g_value_get_flags (&value), cur);
474 while (vals[0].value_name) {
477 g_print ("%s", _name);
478 g_print ("%-23.23s (0x%08x): %-16s - %s", "",
479 vals[0].value, vals[0].value_nick, vals[0].value_name);
484 } else if (G_IS_PARAM_SPEC_OBJECT (param)) {
485 n_print ("%-23.23s Object of type \"%s\"", "",
486 g_type_name (param->value_type));
487 } else if (G_IS_PARAM_SPEC_BOXED (param)) {
488 n_print ("%-23.23s Boxed pointer of type \"%s\"", "",
489 g_type_name (param->value_type));
490 if (param->value_type == GST_TYPE_STRUCTURE) {
491 const GstStructure *s = gst_value_get_structure (&value);
493 gst_structure_foreach (s, print_field,
496 } else if (G_IS_PARAM_SPEC_POINTER (param)) {
497 if (param->value_type != G_TYPE_POINTER) {
498 n_print ("%-23.23s Pointer of type \"%s\".", "",
499 g_type_name (param->value_type));
501 n_print ("%-23.23s Pointer.", "");
503 } else if (param->value_type == G_TYPE_VALUE_ARRAY) {
504 GParamSpecValueArray *pvarray = G_PARAM_SPEC_VALUE_ARRAY (param);
506 if (pvarray->element_spec) {
507 n_print ("%-23.23s Array of GValues of type \"%s\"", "",
508 g_type_name (pvarray->element_spec->value_type));
510 n_print ("%-23.23s Array of GValues", "");
512 } else if (GST_IS_PARAM_SPEC_FRACTION (param)) {
513 GstParamSpecFraction *pfraction = GST_PARAM_SPEC_FRACTION (param);
515 n_print ("%-23.23s Fraction. ", "");
517 g_print ("Range: %d/%d - %d/%d Default: %d/%d ",
518 pfraction->min_num, pfraction->min_den,
519 pfraction->max_num, pfraction->max_den,
520 gst_value_get_fraction_numerator (&value),
521 gst_value_get_fraction_denominator (&value));
522 } else if (param->value_type == GST_TYPE_ARRAY) {
523 GstParamSpecArray *parray = GST_PARAM_SPEC_ARRAY_LIST (param);
525 if (parray->element_spec) {
526 n_print ("%-23.23s GstValueArray of GValues of type \"%s\"", "",
527 g_type_name (parray->element_spec->value_type));
529 n_print ("%-23.23s GstValueArray of GValues", "");
532 n_print ("%-23.23s Unknown type %ld \"%s\"", "",
533 (glong) param->value_type, g_type_name (param->value_type));
538 g_print (" Write only\n");
542 g_value_reset (&value);
544 if (num_properties == 0)
547 g_free (property_specs);
551 print_pad_templates_info (GstElement * element, GstElementFactory * factory)
554 GstStaticPadTemplate *padtemplate;
556 n_print ("Pad Templates:\n");
557 if (gst_element_factory_get_num_pad_templates (factory) == 0) {
562 pads = gst_element_factory_get_static_pad_templates (factory);
564 padtemplate = (GstStaticPadTemplate *) (pads->data);
565 pads = g_list_next (pads);
567 if (padtemplate->direction == GST_PAD_SRC)
568 n_print (" SRC template: '%s'\n", padtemplate->name_template);
569 else if (padtemplate->direction == GST_PAD_SINK)
570 n_print (" SINK template: '%s'\n", padtemplate->name_template);
572 n_print (" UNKNOWN!!! template: '%s'\n", padtemplate->name_template);
574 if (padtemplate->presence == GST_PAD_ALWAYS)
575 n_print (" Availability: Always\n");
576 else if (padtemplate->presence == GST_PAD_SOMETIMES)
577 n_print (" Availability: Sometimes\n");
578 else if (padtemplate->presence == GST_PAD_REQUEST) {
579 n_print (" Availability: On request\n");
581 n_print (" Availability: UNKNOWN!!!\n");
583 if (padtemplate->static_caps.string) {
584 GstCaps *caps = gst_static_caps_get (&padtemplate->static_caps);
586 n_print (" Capabilities:\n");
587 print_caps (caps, " ");
588 gst_caps_unref (caps);
596 print_element_flag_info (GstElement * element)
598 gboolean have_flags = FALSE;
601 n_print ("Element Flags:\n");
604 n_print (" no flags set\n");
606 if (GST_IS_BIN (element)) {
608 n_print ("Bin Flags:\n");
610 n_print (" no flags set\n");
615 print_implementation_info (GstElement * element)
617 GstElementClass *gstelement_class;
619 gstelement_class = GST_ELEMENT_CLASS (G_OBJECT_GET_CLASS (element));
622 n_print ("Element Implementation:\n");
624 n_print (" Has change_state() function: %s\n",
625 GST_DEBUG_FUNCPTR_NAME (gstelement_class->change_state));
629 print_clocking_info (GstElement * element)
631 gboolean requires_clock, provides_clock;
634 GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_REQUIRE_CLOCK);
636 GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_PROVIDE_CLOCK);
638 if (!requires_clock && !provides_clock) {
640 n_print ("Element has no clocking capabilities.\n");
645 n_print ("Clocking Interaction:\n");
646 if (requires_clock) {
647 n_print (" element requires a clock\n");
650 if (provides_clock) {
653 clock = gst_element_get_clock (element);
655 n_print (" element provides a clock: %s\n", GST_OBJECT_NAME (clock));
656 gst_object_unref (clock);
658 n_print (" element is supposed to provide a clock but returned NULL\n");
663 print_uri_handler_info (GstElement * element)
665 if (GST_IS_URI_HANDLER (element)) {
666 const gchar *const *uri_protocols;
667 const gchar *uri_type;
669 if (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element)) == GST_URI_SRC)
671 else if (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element)) ==
675 uri_type = "unknown";
677 uri_protocols = gst_uri_handler_get_protocols (GST_URI_HANDLER (element));
680 n_print ("URI handling capabilities:\n");
681 n_print (" Element can act as %s.\n", uri_type);
683 if (uri_protocols && *uri_protocols) {
684 n_print (" Supported URI protocols:\n");
685 for (; *uri_protocols != NULL; uri_protocols++)
686 n_print (" %s\n", *uri_protocols);
688 n_print (" No supported URI protocols\n");
691 n_print ("Element has no URI handling capabilities.\n");
696 print_pad_info (GstElement * element)
704 if (!element->numpads) {
709 pads = element->pads;
714 pad = GST_PAD (pads->data);
715 pads = g_list_next (pads);
717 name = gst_pad_get_name (pad);
718 if (gst_pad_get_direction (pad) == GST_PAD_SRC)
719 n_print (" SRC: '%s'\n", name);
720 else if (gst_pad_get_direction (pad) == GST_PAD_SINK)
721 n_print (" SINK: '%s'\n", name);
723 n_print (" UNKNOWN!!!: '%s'\n", name);
727 if (pad->padtemplate)
728 n_print (" Pad Template: '%s'\n", pad->padtemplate->name_template);
730 caps = gst_pad_get_current_caps (pad);
732 n_print (" Capabilities:\n");
733 print_caps (caps, " ");
734 gst_caps_unref (caps);
740 has_sometimes_template (GstElement * element)
742 GstElementClass *klass = GST_ELEMENT_GET_CLASS (element);
745 for (l = klass->padtemplates; l != NULL; l = l->next) {
746 if (GST_PAD_TEMPLATE (l->data)->presence == GST_PAD_SOMETIMES)
754 gtype_needs_ptr_marker (GType type)
756 if (type == G_TYPE_POINTER)
759 if (G_TYPE_FUNDAMENTAL (type) == G_TYPE_POINTER || G_TYPE_IS_BOXED (type)
760 || G_TYPE_IS_OBJECT (type))
767 print_signal_info (GstElement * element)
769 /* Signals/Actions Block */
773 GSignalQuery *query = NULL;
775 GSList *found_signals, *l;
777 for (k = 0; k < 2; k++) {
778 found_signals = NULL;
780 /* For elements that have sometimes pads, also list a few useful GstElement
781 * signals. Put these first, so element-specific ones come later. */
782 if (k == 0 && has_sometimes_template (element)) {
783 query = g_new0 (GSignalQuery, 1);
784 g_signal_query (g_signal_lookup ("pad-added", GST_TYPE_ELEMENT), query);
785 found_signals = g_slist_append (found_signals, query);
786 query = g_new0 (GSignalQuery, 1);
787 g_signal_query (g_signal_lookup ("pad-removed", GST_TYPE_ELEMENT), query);
788 found_signals = g_slist_append (found_signals, query);
789 query = g_new0 (GSignalQuery, 1);
790 g_signal_query (g_signal_lookup ("no-more-pads", GST_TYPE_ELEMENT),
792 found_signals = g_slist_append (found_signals, query);
795 for (type = G_OBJECT_TYPE (element); type; type = g_type_parent (type)) {
796 if (type == GST_TYPE_ELEMENT || type == GST_TYPE_OBJECT)
799 if (type == GST_TYPE_BIN && G_OBJECT_TYPE (element) != GST_TYPE_BIN)
802 signals = g_signal_list_ids (type, &nsignals);
803 for (i = 0; i < nsignals; i++) {
804 query = g_new0 (GSignalQuery, 1);
805 g_signal_query (signals[i], query);
807 if ((k == 0 && !(query->signal_flags & G_SIGNAL_ACTION)) ||
808 (k == 1 && (query->signal_flags & G_SIGNAL_ACTION)))
809 found_signals = g_slist_append (found_signals, query);
820 n_print ("Element Signals:\n");
822 n_print ("Element Actions:\n");
827 for (l = found_signals; l; l = l->next) {
832 query = (GSignalQuery *) l->data;
833 indent_len = strlen (query->signal_name) +
834 strlen (g_type_name (query->return_type)) + 24;
836 if (gtype_needs_ptr_marker (query->return_type)) {
843 indent = g_new0 (gchar, indent_len + 1);
844 memset (indent, ' ', indent_len);
846 n_print (" \"%s\" : %s %suser_function (%s* object",
847 query->signal_name, g_type_name (query->return_type), pmark,
850 for (j = 0; j < query->n_params; j++) {
851 const gchar *type_name, *asterisk;
853 type_name = g_type_name (query->param_types[j]);
854 asterisk = gtype_needs_ptr_marker (query->param_types[j]) ? "*" : "";
857 n_print ("%s%s%s arg%d", indent, type_name, asterisk, j);
862 n_print ("%sgpointer user_data);\n", indent);
870 g_slist_foreach (found_signals, (GFunc) g_free, NULL);
871 g_slist_free (found_signals);
877 print_children_info (GstElement * element)
881 if (!GST_IS_BIN (element))
884 children = (GList *) GST_BIN (element)->children;
887 n_print ("Children:\n");
891 n_print (" %s\n", GST_ELEMENT_NAME (GST_ELEMENT (children->data)));
892 children = g_list_next (children);
897 print_preset_list (GstElement * element)
899 gchar **presets, **preset;
901 if (!GST_IS_PRESET (element))
904 presets = gst_preset_get_preset_names (GST_PRESET (element));
905 if (presets && *presets) {
907 n_print ("Presets:\n");
908 for (preset = presets; *preset; preset++) {
909 n_print (" \"%s\"\n", *preset);
911 g_strfreev (presets);
916 print_blacklist (void)
918 GList *plugins, *cur;
921 g_print ("%s\n", _("Blacklisted files:"));
923 plugins = gst_registry_get_plugin_list (gst_registry_get ());
924 for (cur = plugins; cur != NULL; cur = g_list_next (cur)) {
925 GstPlugin *plugin = (GstPlugin *) (cur->data);
926 if (GST_OBJECT_FLAG_IS_SET (plugin, GST_PLUGIN_FLAG_BLACKLISTED)) {
927 g_print (" %s\n", gst_plugin_get_name (plugin));
933 g_print (_("Total count: "));
934 g_print (ngettext ("%d blacklisted file", "%d blacklisted files", count),
937 gst_plugin_list_free (plugins);
941 print_element_list (gboolean print_all, gchar * ftypes)
943 int plugincount = 0, featurecount = 0, blacklistcount = 0;
944 GList *plugins, *orig_plugins;
945 gchar **types = NULL;
950 types = g_strsplit (ftypes, "/", -1);
951 for (i = 0; types[i]; i++)
952 *types[i] = g_ascii_toupper (*types[i]);
957 orig_plugins = plugins = gst_registry_get_plugin_list (gst_registry_get ());
959 GList *features, *orig_features;
962 plugin = (GstPlugin *) (plugins->data);
963 plugins = g_list_next (plugins);
966 if (GST_OBJECT_FLAG_IS_SET (plugin, GST_PLUGIN_FLAG_BLACKLISTED)) {
971 orig_features = features =
972 gst_registry_get_feature_list_by_plugin (gst_registry_get (),
973 gst_plugin_get_name (plugin));
975 GstPluginFeature *feature;
977 if (G_UNLIKELY (features->data == NULL))
979 feature = GST_PLUGIN_FEATURE (features->data);
982 if (GST_IS_ELEMENT_FACTORY (feature)) {
984 GstElementFactory *factory;
986 factory = GST_ELEMENT_FACTORY (feature);
989 gboolean all_found = TRUE;
992 gst_element_factory_get_metadata (factory,
993 GST_ELEMENT_METADATA_KLASS);
994 for (i = 0; types[i]; i++) {
995 if (!strstr (klass, types[i])) {
1005 print_element_info (factory, TRUE);
1007 g_print ("%s: %s: %s\n", gst_plugin_get_name (plugin),
1008 GST_OBJECT_NAME (factory),
1009 gst_element_factory_get_metadata (factory,
1010 GST_ELEMENT_METADATA_LONGNAME));
1011 } else if (GST_IS_TYPE_FIND_FACTORY (feature)) {
1012 GstTypeFindFactory *factory;
1013 const gchar *const *extensions;
1017 factory = GST_TYPE_FIND_FACTORY (feature);
1019 g_print ("%s: %s: ", gst_plugin_get_name (plugin),
1020 gst_plugin_feature_get_name (feature));
1022 extensions = gst_type_find_factory_get_extensions (factory);
1023 if (extensions != NULL) {
1026 while (extensions[i]) {
1028 g_print ("%s%s", i > 0 ? ", " : "", extensions[i]);
1035 g_print ("no extensions\n");
1041 n_print ("%s: %s (%s)\n", gst_plugin_get_name (plugin),
1042 GST_OBJECT_NAME (feature), g_type_name (G_OBJECT_TYPE (feature)));
1046 features = g_list_next (features);
1049 gst_plugin_feature_list_free (orig_features);
1052 gst_plugin_list_free (orig_plugins);
1056 g_print (_("Total count: "));
1057 g_print (ngettext ("%d plugin", "%d plugins", plugincount), plugincount);
1058 if (blacklistcount) {
1060 g_print (ngettext ("%d blacklist entry", "%d blacklist entries",
1061 blacklistcount), blacklistcount);
1062 g_print (" not shown)");
1065 g_print (ngettext ("%d feature", "%d features", featurecount), featurecount);
1070 print_all_uri_handlers (void)
1072 GList *plugins, *p, *features, *f;
1074 plugins = gst_registry_get_plugin_list (gst_registry_get ());
1076 for (p = plugins; p; p = p->next) {
1077 GstPlugin *plugin = (GstPlugin *) (p->data);
1080 gst_registry_get_feature_list_by_plugin (gst_registry_get (),
1081 gst_plugin_get_name (plugin));
1083 for (f = features; f; f = f->next) {
1084 GstPluginFeature *feature = GST_PLUGIN_FEATURE (f->data);
1086 if (GST_IS_ELEMENT_FACTORY (feature)) {
1087 GstElementFactory *factory;
1088 GstElement *element;
1090 factory = GST_ELEMENT_FACTORY (gst_plugin_feature_load (feature));
1092 g_print ("element plugin %s couldn't be loaded\n",
1093 gst_plugin_get_name (plugin));
1097 element = gst_element_factory_create (factory, NULL);
1099 g_print ("couldn't construct element for %s for some reason\n",
1100 GST_OBJECT_NAME (factory));
1101 gst_object_unref (factory);
1105 if (GST_IS_URI_HANDLER (element)) {
1106 const gchar *const *uri_protocols;
1110 switch (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element))) {
1123 gst_uri_handler_get_protocols (GST_URI_HANDLER (element));
1124 joined = g_strjoinv (", ", (gchar **) uri_protocols);
1126 g_print ("%s (%s, rank %u): %s\n",
1127 gst_plugin_feature_get_name (GST_PLUGIN_FEATURE (factory)), dir,
1128 gst_plugin_feature_get_rank (GST_PLUGIN_FEATURE (factory)),
1134 gst_object_unref (element);
1135 gst_object_unref (factory);
1139 gst_plugin_feature_list_free (features);
1142 gst_plugin_list_free (plugins);
1146 print_plugin_info (GstPlugin * plugin)
1148 const gchar *release_date = gst_plugin_get_release_date_string (plugin);
1149 const gchar *filename = gst_plugin_get_filename (plugin);
1151 n_print ("Plugin Details:\n");
1152 n_print (" %-25s%s\n", "Name", gst_plugin_get_name (plugin));
1153 n_print (" %-25s%s\n", "Description", gst_plugin_get_description (plugin));
1154 n_print (" %-25s%s\n", "Filename", (filename != NULL) ? filename : "(null)");
1155 n_print (" %-25s%s\n", "Version", gst_plugin_get_version (plugin));
1156 n_print (" %-25s%s\n", "License", gst_plugin_get_license (plugin));
1157 n_print (" %-25s%s\n", "Source module", gst_plugin_get_source (plugin));
1159 if (release_date != NULL) {
1160 const gchar *tz = "(UTC)";
1163 /* may be: YYYY-MM-DD or YYYY-MM-DDTHH:MMZ */
1164 /* YYYY-MM-DDTHH:MMZ => YYYY-MM-DD HH:MM (UTC) */
1165 str = g_strdup (release_date);
1166 sep = strstr (str, "T");
1169 sep = strstr (sep + 1, "Z");
1175 n_print (" %-25s%s%s\n", "Source release date", str, tz);
1178 n_print (" %-25s%s\n", "Binary package", gst_plugin_get_package (plugin));
1179 n_print (" %-25s%s\n", "Origin URL", gst_plugin_get_origin (plugin));
1184 print_plugin_features (GstPlugin * plugin)
1186 GList *features, *origlist;
1187 gint num_features = 0;
1188 gint num_elements = 0;
1189 gint num_tracers = 0;
1190 gint num_typefinders = 0;
1191 gint num_devproviders = 0;
1194 origlist = features =
1195 gst_registry_get_feature_list_by_plugin (gst_registry_get (),
1196 gst_plugin_get_name (plugin));
1199 GstPluginFeature *feature;
1201 feature = GST_PLUGIN_FEATURE (features->data);
1203 if (GST_IS_ELEMENT_FACTORY (feature)) {
1204 GstElementFactory *factory;
1206 factory = GST_ELEMENT_FACTORY (feature);
1207 n_print (" %s: %s\n", GST_OBJECT_NAME (factory),
1208 gst_element_factory_get_metadata (factory,
1209 GST_ELEMENT_METADATA_LONGNAME));
1211 } else if (GST_IS_TYPE_FIND_FACTORY (feature)) {
1212 GstTypeFindFactory *factory;
1213 const gchar *const *extensions;
1215 factory = GST_TYPE_FIND_FACTORY (feature);
1216 extensions = gst_type_find_factory_get_extensions (factory);
1220 g_print (" %s: %s: ", gst_plugin_get_name (plugin),
1221 gst_plugin_feature_get_name (feature));
1222 while (extensions[i]) {
1223 g_print ("%s%s", i > 0 ? ", " : "", extensions[i]);
1228 g_print (" %s: %s: no extensions\n", gst_plugin_get_name (plugin),
1229 gst_plugin_feature_get_name (feature));
1232 } else if (GST_IS_DEVICE_PROVIDER_FACTORY (feature)) {
1233 GstDeviceProviderFactory *factory;
1235 factory = GST_DEVICE_PROVIDER_FACTORY (feature);
1236 n_print (" %s: %s\n", GST_OBJECT_NAME (factory),
1237 gst_device_provider_factory_get_metadata (factory,
1238 GST_ELEMENT_METADATA_LONGNAME));
1240 } else if (GST_IS_TRACER_FACTORY (feature)) {
1241 n_print (" %s (%s)\n", gst_object_get_name (GST_OBJECT (feature)),
1242 g_type_name (G_OBJECT_TYPE (feature)));
1244 } else if (feature) {
1245 n_print (" %s (%s)\n", gst_object_get_name (GST_OBJECT (feature)),
1246 g_type_name (G_OBJECT_TYPE (feature)));
1250 features = g_list_next (features);
1253 gst_plugin_feature_list_free (origlist);
1256 n_print (" %d features:\n", num_features);
1257 if (num_elements > 0)
1258 n_print (" +-- %d elements\n", num_elements);
1259 if (num_typefinders > 0)
1260 n_print (" +-- %d typefinders\n", num_typefinders);
1261 if (num_devproviders > 0)
1262 n_print (" +-- %d device providers\n", num_devproviders);
1263 if (num_tracers > 0)
1264 n_print (" +-- %d tracers\n", num_tracers);
1266 n_print (" +-- %d other objects\n", num_other);
1272 print_feature_info (const gchar * feature_name, gboolean print_all)
1274 GstPluginFeature *feature;
1275 GstRegistry *registry = gst_registry_get ();
1277 feature = gst_registry_find_feature (registry, feature_name,
1278 GST_TYPE_ELEMENT_FACTORY);
1280 int ret = print_element_info (GST_ELEMENT_FACTORY (feature), print_all);
1281 gst_object_unref (feature);
1284 /* FIXME implement other pretty print function for these */
1285 feature = gst_registry_find_feature (registry, feature_name,
1286 GST_TYPE_TYPE_FIND_FACTORY);
1288 n_print ("%s: a typefind function\n", feature_name);
1289 gst_object_unref (feature);
1292 feature = gst_registry_find_feature (registry, feature_name,
1293 GST_TYPE_TRACER_FACTORY);
1295 n_print ("%s: a tracer module\n", feature_name);
1296 gst_object_unref (feature);
1304 print_element_info (GstElementFactory * factory, gboolean print_names)
1306 GstElement *element;
1311 GST_ELEMENT_FACTORY (gst_plugin_feature_load (GST_PLUGIN_FEATURE
1315 g_print ("element plugin couldn't be loaded\n");
1319 element = gst_element_factory_create (factory, NULL);
1321 gst_object_unref (factory);
1322 g_print ("couldn't construct element for some reason\n");
1327 _name = g_strdup_printf ("%s: ", GST_OBJECT_NAME (factory));
1331 print_factory_details_info (factory);
1333 plugin = gst_plugin_feature_get_plugin (GST_PLUGIN_FEATURE (factory));
1335 print_plugin_info (plugin);
1336 gst_object_unref (plugin);
1339 print_hierarchy (G_OBJECT_TYPE (element), 0, &maxlevel);
1340 print_interfaces (G_OBJECT_TYPE (element));
1342 print_pad_templates_info (element, factory);
1343 print_element_flag_info (element);
1344 print_implementation_info (element);
1345 print_clocking_info (element);
1346 print_uri_handler_info (element);
1347 print_pad_info (element);
1348 print_element_properties_info (element);
1349 print_signal_info (element);
1350 print_children_info (element);
1351 print_preset_list (element);
1353 gst_object_unref (element);
1354 gst_object_unref (factory);
1362 print_plugin_automatic_install_info_codecs (GstElementFactory * factory)
1364 GstPadDirection direction;
1365 const gchar *type_name;
1367 const GList *static_templates, *l;
1368 GstCaps *caps = NULL;
1372 gst_element_factory_get_metadata (factory, GST_ELEMENT_METADATA_KLASS);
1373 g_return_if_fail (klass != NULL);
1375 if (strstr (klass, "Demuxer") ||
1376 strstr (klass, "Decoder") ||
1377 strstr (klass, "Depay") || strstr (klass, "Parser")) {
1378 type_name = "decoder";
1379 direction = GST_PAD_SINK;
1380 } else if (strstr (klass, "Muxer") ||
1381 strstr (klass, "Encoder") || strstr (klass, "Pay")) {
1382 type_name = "encoder";
1383 direction = GST_PAD_SRC;
1388 /* decoder/demuxer sink pads should always be static and there should only
1389 * be one, the same applies to encoders/muxers and source pads */
1390 static_templates = gst_element_factory_get_static_pad_templates (factory);
1391 for (l = static_templates; l != NULL; l = l->next) {
1392 GstStaticPadTemplate *tmpl = NULL;
1394 tmpl = (GstStaticPadTemplate *) l->data;
1395 if (tmpl->direction == direction) {
1396 caps = gst_static_pad_template_get_caps (tmpl);
1402 g_printerr ("Couldn't find static pad template for %s '%s'\n",
1403 type_name, GST_OBJECT_NAME (factory));
1407 caps = gst_caps_make_writable (caps);
1408 num = gst_caps_get_size (caps);
1409 for (i = 0; i < num; ++i) {
1413 s = gst_caps_get_structure (caps, i);
1414 /* remove fields that are almost always just MIN-MAX of some sort
1415 * in order to make the caps look less messy */
1416 gst_structure_remove_field (s, "pixel-aspect-ratio");
1417 gst_structure_remove_field (s, "framerate");
1418 gst_structure_remove_field (s, "channels");
1419 gst_structure_remove_field (s, "width");
1420 gst_structure_remove_field (s, "height");
1421 gst_structure_remove_field (s, "rate");
1422 gst_structure_remove_field (s, "depth");
1423 gst_structure_remove_field (s, "clock-rate");
1424 s_str = gst_structure_to_string (s);
1425 g_print ("%s-%s\n", type_name, s_str);
1428 gst_caps_unref (caps);
1432 print_plugin_automatic_install_info_protocols (GstElementFactory * factory)
1434 const gchar *const *protocols;
1436 protocols = gst_element_factory_get_uri_protocols (factory);
1437 if (protocols != NULL && *protocols != NULL) {
1438 switch (gst_element_factory_get_uri_type (factory)) {
1440 while (*protocols != NULL) {
1441 g_print ("urisink-%s\n", *protocols);
1446 while (*protocols != NULL) {
1447 g_print ("urisource-%s\n", *protocols);
1458 print_plugin_automatic_install_info (GstPlugin * plugin)
1460 GList *features, *l;
1462 /* not interested in typefind factories, only element factories */
1463 features = gst_registry_get_feature_list (gst_registry_get (),
1464 GST_TYPE_ELEMENT_FACTORY);
1466 for (l = features; l != NULL; l = l->next) {
1467 GstPluginFeature *feature;
1468 GstPlugin *feature_plugin;
1470 feature = GST_PLUGIN_FEATURE (l->data);
1472 /* only interested in the ones that are in the plugin we just loaded */
1473 feature_plugin = gst_plugin_feature_get_plugin (feature);
1474 if (feature_plugin == plugin) {
1475 GstElementFactory *factory;
1477 g_print ("element-%s\n", gst_plugin_feature_get_name (feature));
1479 factory = GST_ELEMENT_FACTORY (feature);
1480 print_plugin_automatic_install_info_protocols (factory);
1481 print_plugin_automatic_install_info_codecs (factory);
1484 gst_object_unref (feature_plugin);
1487 g_list_foreach (features, (GFunc) gst_object_unref, NULL);
1488 g_list_free (features);
1492 print_all_plugin_automatic_install_info (void)
1494 GList *plugins, *orig_plugins;
1496 orig_plugins = plugins = gst_registry_get_plugin_list (gst_registry_get ());
1500 plugin = (GstPlugin *) (plugins->data);
1501 plugins = g_list_next (plugins);
1503 print_plugin_automatic_install_info (plugin);
1505 gst_plugin_list_free (orig_plugins);
1509 main (int argc, char *argv[])
1511 gboolean print_all = FALSE;
1512 gboolean do_print_blacklist = FALSE;
1513 gboolean plugin_name = FALSE;
1514 gboolean print_aii = FALSE;
1515 gboolean uri_handlers = FALSE;
1516 gboolean check_exists = FALSE;
1517 gchar *min_version = NULL;
1518 guint minver_maj = GST_VERSION_MAJOR;
1519 guint minver_min = GST_VERSION_MINOR;
1520 guint minver_micro = 0;
1521 gchar *types = NULL;
1522 #ifndef GST_DISABLE_OPTION_PARSING
1523 GOptionEntry options[] = {
1524 {"print-all", 'a', 0, G_OPTION_ARG_NONE, &print_all,
1525 N_("Print all elements"), NULL},
1526 {"print-blacklist", 'b', 0, G_OPTION_ARG_NONE, &do_print_blacklist,
1527 N_("Print list of blacklisted files"), NULL},
1528 {"print-plugin-auto-install-info", '\0', 0, G_OPTION_ARG_NONE, &print_aii,
1529 N_("Print a machine-parsable list of features the specified plugin "
1530 "or all plugins provide.\n "
1531 "Useful in connection with external automatic plugin "
1532 "installation mechanisms"), NULL},
1533 {"plugin", '\0', 0, G_OPTION_ARG_NONE, &plugin_name,
1534 N_("List the plugin contents"), NULL},
1535 {"types", 't', 0, G_OPTION_ARG_STRING, &types,
1536 N_("A slashes ('/') separated list of types of elements (also known "
1537 "as klass) to list. (unordered)"), NULL},
1538 {"exists", '\0', 0, G_OPTION_ARG_NONE, &check_exists,
1539 N_("Check if the specified element or plugin exists"), NULL},
1540 {"atleast-version", '\0', 0, G_OPTION_ARG_STRING, &min_version,
1542 ("When checking if an element or plugin exists, also check that its "
1543 "version is at least the version specified"), NULL},
1544 {"uri-handlers", 'u', 0, G_OPTION_ARG_NONE, &uri_handlers,
1546 ("Print supported URI schemes, with the elements that implement them"),
1548 GST_TOOLS_GOPTION_VERSION,
1551 GOptionContext *ctx;
1555 setlocale (LC_ALL, "");
1558 bindtextdomain (GETTEXT_PACKAGE, LOCALEDIR);
1559 bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
1560 textdomain (GETTEXT_PACKAGE);
1563 /* avoid glib warnings when inspecting deprecated properties */
1564 g_setenv ("G_ENABLE_DIAGNOSTIC", "0", FALSE);
1566 g_set_prgname ("gst-inspect-" GST_API_VERSION);
1568 #ifndef GST_DISABLE_OPTION_PARSING
1569 ctx = g_option_context_new ("[ELEMENT-NAME | PLUGIN-NAME]");
1570 g_option_context_add_main_entries (ctx, options, GETTEXT_PACKAGE);
1571 g_option_context_add_group (ctx, gst_init_get_option_group ());
1572 if (!g_option_context_parse (ctx, &argc, &argv, &err)) {
1573 g_printerr ("Error initializing: %s\n", err->message);
1574 g_clear_error (&err);
1575 g_option_context_free (ctx);
1578 g_option_context_free (ctx);
1580 gst_init (&argc, &argv);
1583 gst_tools_print_version ();
1585 if (print_all && argc > 1) {
1586 g_printerr ("-a requires no extra arguments\n");
1590 if (uri_handlers && argc > 1) {
1591 g_printerr ("-u requires no extra arguments\n");
1595 /* --atleast-version implies --exists */
1596 if (min_version != NULL) {
1597 if (sscanf (min_version, "%u.%u.%u", &minver_maj, &minver_min,
1598 &minver_micro) < 2) {
1599 g_printerr ("Can't parse version '%s' passed to --atleast-version\n",
1603 check_exists = TRUE;
1610 g_printerr ("--exists requires an extra command line argument\n");
1614 GstPluginFeature *feature;
1616 feature = gst_registry_lookup_feature (gst_registry_get (), argv[1]);
1617 if (feature != NULL && gst_plugin_feature_check_version (feature,
1618 minver_maj, minver_min, minver_micro)) {
1625 gst_object_unref (feature);
1627 /* FIXME: support checking for plugins too */
1628 g_printerr ("Checking for plugins is not supported yet\n");
1635 /* if no arguments, print out list of elements */
1637 print_all_uri_handlers ();
1638 } else if (argc == 1 || print_all) {
1639 if (do_print_blacklist)
1643 print_all_plugin_automatic_install_info ();
1645 print_element_list (print_all, types);
1648 /* else we try to get a factory */
1649 const char *arg = argv[argc - 1];
1653 retval = print_feature_info (arg, print_all);
1656 /* otherwise check if it's a plugin */
1658 GstPlugin *plugin = gst_registry_find_plugin (gst_registry_get (), arg);
1660 /* if there is such a plugin, print out info */
1663 print_plugin_automatic_install_info (plugin);
1665 print_plugin_info (plugin);
1666 print_plugin_features (plugin);
1669 GError *error = NULL;
1671 if (g_file_test (arg, G_FILE_TEST_EXISTS)) {
1672 plugin = gst_plugin_load_file (arg, &error);
1676 print_plugin_automatic_install_info (plugin);
1678 print_plugin_info (plugin);
1679 print_plugin_features (plugin);
1682 g_printerr (_("Could not load plugin file: %s\n"), error->message);
1683 g_clear_error (&error);
1687 g_printerr (_("No such element or plugin '%s'\n"), arg);