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 0.11: 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 | GST_PARAM_CONTROLLABLE | \
249 GST_PARAM_MUTABLE_PLAYING | GST_PARAM_MUTABLE_PAUSED | \
250 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 & GST_PARAM_CONTROLLABLE) {
294 g_print (", %s", _("controllable"));
297 if (param->flags & GST_PARAM_MUTABLE_PLAYING) {
298 g_print (", %s", _("changeable in NULL, READY, PAUSED or PLAYING state"));
299 } else if (param->flags & GST_PARAM_MUTABLE_PAUSED) {
300 g_print (", %s", _("changeable only in NULL, READY or PAUSED state"));
301 } else if (param->flags & GST_PARAM_MUTABLE_READY) {
302 g_print (", %s", _("changeable only in NULL or READY state"));
304 if (param->flags & ~KNOWN_PARAM_FLAGS) {
305 g_print ("%s0x%0x", (first_flag) ? "" : ", ",
306 param->flags & ~KNOWN_PARAM_FLAGS);
310 switch (G_VALUE_TYPE (&value)) {
313 const char *string_val = g_value_get_string (&value);
315 n_print ("%-23.23s String. ", "");
317 if (string_val == NULL)
318 g_print ("Default: null");
320 g_print ("Default: \"%s\"", string_val);
325 gboolean bool_val = g_value_get_boolean (&value);
327 n_print ("%-23.23s Boolean. ", "");
329 g_print ("Default: %s", bool_val ? "true" : "false");
334 GParamSpecULong *pulong = G_PARAM_SPEC_ULONG (param);
336 n_print ("%-23.23s Unsigned Long. ", "");
337 g_print ("Range: %lu - %lu Default: %lu ",
338 pulong->minimum, pulong->maximum, g_value_get_ulong (&value));
340 GST_ERROR ("%s: property '%s' of type ulong: consider changing to "
341 "uint/uint64", GST_OBJECT_NAME (element),
342 g_param_spec_get_name (param));
347 GParamSpecLong *plong = G_PARAM_SPEC_LONG (param);
349 n_print ("%-23.23s Long. ", "");
350 g_print ("Range: %ld - %ld Default: %ld ",
351 plong->minimum, plong->maximum, g_value_get_long (&value));
353 GST_ERROR ("%s: property '%s' of type long: consider changing to "
354 "int/int64", GST_OBJECT_NAME (element),
355 g_param_spec_get_name (param));
360 GParamSpecUInt *puint = G_PARAM_SPEC_UINT (param);
362 n_print ("%-23.23s Unsigned Integer. ", "");
363 g_print ("Range: %u - %u Default: %u ",
364 puint->minimum, puint->maximum, g_value_get_uint (&value));
369 GParamSpecInt *pint = G_PARAM_SPEC_INT (param);
371 n_print ("%-23.23s Integer. ", "");
372 g_print ("Range: %d - %d Default: %d ",
373 pint->minimum, pint->maximum, g_value_get_int (&value));
378 GParamSpecUInt64 *puint64 = G_PARAM_SPEC_UINT64 (param);
380 n_print ("%-23.23s Unsigned Integer64. ", "");
381 g_print ("Range: %" G_GUINT64_FORMAT " - %" G_GUINT64_FORMAT
382 " Default: %" G_GUINT64_FORMAT " ",
383 puint64->minimum, puint64->maximum, g_value_get_uint64 (&value));
388 GParamSpecInt64 *pint64 = G_PARAM_SPEC_INT64 (param);
390 n_print ("%-23.23s Integer64. ", "");
391 g_print ("Range: %" G_GINT64_FORMAT " - %" G_GINT64_FORMAT
392 " Default: %" G_GINT64_FORMAT " ",
393 pint64->minimum, pint64->maximum, g_value_get_int64 (&value));
398 GParamSpecFloat *pfloat = G_PARAM_SPEC_FLOAT (param);
400 n_print ("%-23.23s Float. ", "");
401 g_print ("Range: %15.7g - %15.7g Default: %15.7g ",
402 pfloat->minimum, pfloat->maximum, g_value_get_float (&value));
407 GParamSpecDouble *pdouble = G_PARAM_SPEC_DOUBLE (param);
409 n_print ("%-23.23s Double. ", "");
410 g_print ("Range: %15.7g - %15.7g Default: %15.7g ",
411 pdouble->minimum, pdouble->maximum, g_value_get_double (&value));
416 GST_ERROR ("%s: property '%s' of type char: consider changing to "
417 "int/string", GST_OBJECT_NAME (element),
418 g_param_spec_get_name (param));
421 if (param->value_type == GST_TYPE_CAPS) {
422 const GstCaps *caps = gst_value_get_caps (&value);
425 n_print ("%-23.23s Caps (NULL)", "");
427 print_caps (caps, " ");
429 } else if (G_IS_PARAM_SPEC_ENUM (param)) {
433 const gchar *value_nick = "";
435 values = G_ENUM_CLASS (g_type_class_ref (param->value_type))->values;
436 enum_value = g_value_get_enum (&value);
438 while (values[j].value_name) {
439 if (values[j].value == enum_value)
440 value_nick = values[j].value_nick;
444 n_print ("%-23.23s Enum \"%s\" Default: %d, \"%s\"", "",
445 g_type_name (G_VALUE_TYPE (&value)), enum_value, value_nick);
448 while (values[j].value_name) {
451 g_print ("%s", _name);
452 g_print ("%-23.23s (%d): %-16s - %s", "",
453 values[j].value, values[j].value_nick, values[j].value_name);
456 /* g_type_class_unref (ec); */
457 } else if (G_IS_PARAM_SPEC_FLAGS (param)) {
458 GParamSpecFlags *pflags = G_PARAM_SPEC_FLAGS (param);
462 vals = pflags->flags_class->values;
464 cur = flags_to_string (vals, g_value_get_flags (&value));
466 n_print ("%-23.23s Flags \"%s\" Default: 0x%08x, \"%s\"", "",
467 g_type_name (G_VALUE_TYPE (&value)),
468 g_value_get_flags (&value), cur);
470 while (vals[0].value_name) {
473 g_print ("%s", _name);
474 g_print ("%-23.23s (0x%08x): %-16s - %s", "",
475 vals[0].value, vals[0].value_nick, vals[0].value_name);
480 } else if (G_IS_PARAM_SPEC_OBJECT (param)) {
481 n_print ("%-23.23s Object of type \"%s\"", "",
482 g_type_name (param->value_type));
483 } else if (G_IS_PARAM_SPEC_BOXED (param)) {
484 n_print ("%-23.23s Boxed pointer of type \"%s\"", "",
485 g_type_name (param->value_type));
486 } else if (G_IS_PARAM_SPEC_POINTER (param)) {
487 if (param->value_type != G_TYPE_POINTER) {
488 n_print ("%-23.23s Pointer of type \"%s\".", "",
489 g_type_name (param->value_type));
491 n_print ("%-23.23s Pointer.", "");
493 } else if (param->value_type == G_TYPE_VALUE_ARRAY) {
494 GParamSpecValueArray *pvarray = G_PARAM_SPEC_VALUE_ARRAY (param);
496 if (pvarray->element_spec) {
497 n_print ("%-23.23s Array of GValues of type \"%s\"", "",
498 g_type_name (pvarray->element_spec->value_type));
500 n_print ("%-23.23s Array of GValues", "");
502 } else if (GST_IS_PARAM_SPEC_FRACTION (param)) {
503 GstParamSpecFraction *pfraction = GST_PARAM_SPEC_FRACTION (param);
505 n_print ("%-23.23s Fraction. ", "");
507 g_print ("Range: %d/%d - %d/%d Default: %d/%d ",
508 pfraction->min_num, pfraction->min_den,
509 pfraction->max_num, pfraction->max_den,
510 gst_value_get_fraction_numerator (&value),
511 gst_value_get_fraction_denominator (&value));
513 n_print ("%-23.23s Unknown type %ld \"%s\"", "",
514 (glong) param->value_type, g_type_name (param->value_type));
519 g_print (" Write only\n");
523 g_value_reset (&value);
525 if (num_properties == 0)
528 g_free (property_specs);
532 print_pad_templates_info (GstElement * element, GstElementFactory * factory)
534 GstElementClass *gstelement_class;
536 GstStaticPadTemplate *padtemplate;
538 n_print ("Pad Templates:\n");
539 if (gst_element_factory_get_num_pad_templates (factory) == 0) {
544 gstelement_class = GST_ELEMENT_CLASS (G_OBJECT_GET_CLASS (element));
546 pads = gst_element_factory_get_static_pad_templates (factory);
548 padtemplate = (GstStaticPadTemplate *) (pads->data);
549 pads = g_list_next (pads);
551 if (padtemplate->direction == GST_PAD_SRC)
552 n_print (" SRC template: '%s'\n", padtemplate->name_template);
553 else if (padtemplate->direction == GST_PAD_SINK)
554 n_print (" SINK template: '%s'\n", padtemplate->name_template);
556 n_print (" UNKNOWN!!! template: '%s'\n", padtemplate->name_template);
558 if (padtemplate->presence == GST_PAD_ALWAYS)
559 n_print (" Availability: Always\n");
560 else if (padtemplate->presence == GST_PAD_SOMETIMES)
561 n_print (" Availability: Sometimes\n");
562 else if (padtemplate->presence == GST_PAD_REQUEST) {
563 n_print (" Availability: On request\n");
564 n_print (" Has request_new_pad() function: %s\n",
565 GST_DEBUG_FUNCPTR_NAME (gstelement_class->request_new_pad));
567 n_print (" Availability: UNKNOWN!!!\n");
569 if (padtemplate->static_caps.string) {
570 n_print (" Capabilities:\n");
571 print_caps (gst_static_caps_get (&padtemplate->static_caps), " ");
579 print_element_flag_info (GstElement * element)
581 gboolean have_flags = FALSE;
584 n_print ("Element Flags:\n");
587 n_print (" no flags set\n");
589 if (GST_IS_BIN (element)) {
591 n_print ("Bin Flags:\n");
593 n_print (" no flags set\n");
598 print_implementation_info (GstElement * element)
600 GstElementClass *gstelement_class;
602 gstelement_class = GST_ELEMENT_CLASS (G_OBJECT_GET_CLASS (element));
605 n_print ("Element Implementation:\n");
607 n_print (" Has change_state() function: %s\n",
608 GST_DEBUG_FUNCPTR_NAME (gstelement_class->change_state));
612 print_clocking_info (GstElement * element)
614 gboolean requires_clock, provides_clock;
617 GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_REQUIRE_CLOCK);
619 GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_PROVIDE_CLOCK);
621 if (!requires_clock && !provides_clock) {
623 n_print ("Element has no clocking capabilities.");
628 n_print ("Clocking Interaction:\n");
629 if (requires_clock) {
630 n_print (" element requires a clock\n");
633 if (provides_clock) {
636 clock = gst_element_get_clock (element);
638 n_print (" element provides a clock: %s\n", GST_OBJECT_NAME (clock));
639 gst_object_unref (clock);
641 n_print (" element is supposed to provide a clock but returned NULL\n");
646 print_uri_handler_info (GstElement * element)
648 if (GST_IS_URI_HANDLER (element)) {
649 const gchar *const *uri_protocols;
650 const gchar *uri_type;
652 if (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element)) == GST_URI_SRC)
654 else if (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element)) ==
658 uri_type = "unknown";
660 uri_protocols = gst_uri_handler_get_protocols (GST_URI_HANDLER (element));
663 n_print ("URI handling capabilities:\n");
664 n_print (" Element can act as %s.\n", uri_type);
666 if (uri_protocols && *uri_protocols) {
667 n_print (" Supported URI protocols:\n");
668 for (; *uri_protocols != NULL; uri_protocols++)
669 n_print (" %s\n", *uri_protocols);
671 n_print (" No supported URI protocols\n");
674 n_print ("Element has no URI handling capabilities.\n");
679 print_pad_info (GstElement * element)
687 if (!element->numpads) {
692 pads = element->pads;
697 pad = GST_PAD (pads->data);
698 pads = g_list_next (pads);
700 name = gst_pad_get_name (pad);
701 if (gst_pad_get_direction (pad) == GST_PAD_SRC)
702 g_print (" SRC: '%s'", name);
703 else if (gst_pad_get_direction (pad) == GST_PAD_SINK)
704 g_print (" SINK: '%s'", name);
706 g_print (" UNKNOWN!!!: '%s'", name);
712 n_print (" Implementation:\n");
714 n_print (" Has chainfunc(): %s\n",
715 GST_DEBUG_FUNCPTR_NAME (pad->chainfunc));
716 if (pad->getrangefunc)
717 n_print (" Has getrangefunc(): %s\n",
718 GST_DEBUG_FUNCPTR_NAME (pad->getrangefunc));
719 if (pad->eventfunc != gst_pad_event_default)
720 n_print (" Has custom eventfunc(): %s\n",
721 GST_DEBUG_FUNCPTR_NAME (pad->eventfunc));
722 if (pad->queryfunc != gst_pad_query_default)
723 n_print (" Has custom queryfunc(): %s\n",
724 GST_DEBUG_FUNCPTR_NAME (pad->queryfunc));
726 if (pad->iterintlinkfunc != gst_pad_iterate_internal_links_default)
727 n_print (" Has custom iterintlinkfunc(): %s\n",
728 GST_DEBUG_FUNCPTR_NAME (pad->iterintlinkfunc));
730 if (pad->padtemplate)
731 n_print (" Pad Template: '%s'\n", pad->padtemplate->name_template);
733 caps = gst_pad_get_current_caps (pad);
735 n_print (" Capabilities:\n");
736 print_caps (caps, " ");
737 gst_caps_unref (caps);
743 has_sometimes_template (GstElement * element)
745 GstElementClass *klass = GST_ELEMENT_GET_CLASS (element);
748 for (l = klass->padtemplates; l != NULL; l = l->next) {
749 if (GST_PAD_TEMPLATE (l->data)->presence == GST_PAD_SOMETIMES)
757 print_signal_info (GstElement * element)
759 /* Signals/Actions Block */
763 GSignalQuery *query = NULL;
765 GSList *found_signals, *l;
767 for (k = 0; k < 2; k++) {
768 found_signals = NULL;
770 /* For elements that have sometimes pads, also list a few useful GstElement
771 * signals. Put these first, so element-specific ones come later. */
772 if (k == 0 && has_sometimes_template (element)) {
773 query = g_new0 (GSignalQuery, 1);
774 g_signal_query (g_signal_lookup ("pad-added", GST_TYPE_ELEMENT), query);
775 found_signals = g_slist_append (found_signals, query);
776 query = g_new0 (GSignalQuery, 1);
777 g_signal_query (g_signal_lookup ("pad-removed", GST_TYPE_ELEMENT), query);
778 found_signals = g_slist_append (found_signals, query);
779 query = g_new0 (GSignalQuery, 1);
780 g_signal_query (g_signal_lookup ("no-more-pads", GST_TYPE_ELEMENT),
782 found_signals = g_slist_append (found_signals, query);
785 for (type = G_OBJECT_TYPE (element); type; type = g_type_parent (type)) {
786 if (type == GST_TYPE_ELEMENT || type == GST_TYPE_OBJECT)
789 if (type == GST_TYPE_BIN && G_OBJECT_TYPE (element) != GST_TYPE_BIN)
792 signals = g_signal_list_ids (type, &nsignals);
793 for (i = 0; i < nsignals; i++) {
794 query = g_new0 (GSignalQuery, 1);
795 g_signal_query (signals[i], query);
797 if ((k == 0 && !(query->signal_flags & G_SIGNAL_ACTION)) ||
798 (k == 1 && (query->signal_flags & G_SIGNAL_ACTION)))
799 found_signals = g_slist_append (found_signals, query);
810 n_print ("Element Signals:\n");
812 n_print ("Element Actions:\n");
817 for (l = found_signals; l; l = l->next) {
822 query = (GSignalQuery *) l->data;
823 indent_len = strlen (query->signal_name) +
824 strlen (g_type_name (query->return_type)) + 24;
827 if (query->return_type == G_TYPE_POINTER) {
829 } else if (G_TYPE_FUNDAMENTAL (query->return_type) == G_TYPE_POINTER
830 || G_TYPE_IS_BOXED (query->return_type)
831 || G_TYPE_IS_OBJECT (query->return_type)) {
838 indent = g_new0 (gchar, indent_len + 1);
839 memset (indent, ' ', indent_len);
841 n_print (" \"%s\" : %s %suser_function (%s* object",
842 query->signal_name, g_type_name (query->return_type), pmark,
845 for (j = 0; j < query->n_params; j++) {
847 if (G_TYPE_IS_FUNDAMENTAL (query->param_types[j])) {
848 n_print ("%s%s arg%d", indent,
849 g_type_name (query->param_types[j]), j);
850 } else if (G_TYPE_IS_ENUM (query->param_types[j])) {
851 n_print ("%s%s arg%d", indent,
852 g_type_name (query->param_types[j]), j);
854 n_print ("%s%s* arg%d", indent,
855 g_type_name (query->param_types[j]), j);
861 n_print ("%sgpointer user_data);\n", indent);
869 g_slist_foreach (found_signals, (GFunc) g_free, NULL);
870 g_slist_free (found_signals);
876 print_children_info (GstElement * element)
880 if (!GST_IS_BIN (element))
883 children = (GList *) GST_BIN (element)->children;
886 n_print ("Children:\n");
890 n_print (" %s\n", GST_ELEMENT_NAME (GST_ELEMENT (children->data)));
891 children = g_list_next (children);
896 print_blacklist (void)
898 GList *plugins, *cur;
901 g_print ("%s\n", _("Blacklisted files:"));
903 plugins = gst_registry_get_plugin_list (gst_registry_get ());
904 for (cur = plugins; cur != NULL; cur = g_list_next (cur)) {
905 GstPlugin *plugin = (GstPlugin *) (cur->data);
906 if (GST_OBJECT_FLAG_IS_SET (plugin, GST_PLUGIN_FLAG_BLACKLISTED)) {
907 g_print (" %s\n", gst_plugin_get_name (plugin));
913 g_print (_("Total count: "));
914 g_print (ngettext ("%d blacklisted file", "%d blacklisted files", count),
917 gst_plugin_list_free (plugins);
921 print_element_list (gboolean print_all)
923 int plugincount = 0, featurecount = 0, blacklistcount = 0;
924 GList *plugins, *orig_plugins;
926 orig_plugins = plugins = gst_registry_get_plugin_list (gst_registry_get ());
928 GList *features, *orig_features;
931 plugin = (GstPlugin *) (plugins->data);
932 plugins = g_list_next (plugins);
935 if (GST_OBJECT_FLAG_IS_SET (plugin, GST_PLUGIN_FLAG_BLACKLISTED)) {
940 orig_features = features =
941 gst_registry_get_feature_list_by_plugin (gst_registry_get (),
942 gst_plugin_get_name (plugin));
944 GstPluginFeature *feature;
946 if (G_UNLIKELY (features->data == NULL))
948 feature = GST_PLUGIN_FEATURE (features->data);
951 if (GST_IS_ELEMENT_FACTORY (feature)) {
952 GstElementFactory *factory;
954 factory = GST_ELEMENT_FACTORY (feature);
956 print_element_info (factory, TRUE);
958 g_print ("%s: %s: %s\n", gst_plugin_get_name (plugin),
959 GST_OBJECT_NAME (factory),
960 gst_element_factory_get_metadata (factory,
961 GST_ELEMENT_METADATA_LONGNAME));
962 } else if (GST_IS_TYPE_FIND_FACTORY (feature)) {
963 GstTypeFindFactory *factory;
964 const gchar *const *extensions;
966 factory = GST_TYPE_FIND_FACTORY (feature);
968 g_print ("%s: %s: ", gst_plugin_get_name (plugin),
969 gst_plugin_feature_get_name (feature));
971 extensions = gst_type_find_factory_get_extensions (factory);
972 if (extensions != NULL) {
975 while (extensions[i]) {
977 g_print ("%s%s", i > 0 ? ", " : "", extensions[i]);
984 g_print ("no extensions\n");
988 n_print ("%s: %s (%s)\n", gst_plugin_get_name (plugin),
989 GST_OBJECT_NAME (feature), g_type_name (G_OBJECT_TYPE (feature)));
993 features = g_list_next (features);
996 gst_plugin_feature_list_free (orig_features);
999 gst_plugin_list_free (orig_plugins);
1002 g_print (_("Total count: "));
1003 g_print (ngettext ("%d plugin", "%d plugins", plugincount), plugincount);
1004 if (blacklistcount) {
1006 g_print (ngettext ("%d blacklist entry", "%d blacklist entries",
1007 blacklistcount), blacklistcount);
1008 g_print (" not shown)");
1011 g_print (ngettext ("%d feature", "%d features", featurecount), featurecount);
1016 print_all_uri_handlers (void)
1018 GList *plugins, *p, *features, *f;
1020 plugins = gst_registry_get_plugin_list (gst_registry_get ());
1022 for (p = plugins; p; p = p->next) {
1023 GstPlugin *plugin = (GstPlugin *) (p->data);
1026 gst_registry_get_feature_list_by_plugin (gst_registry_get (),
1027 gst_plugin_get_name (plugin));
1029 for (f = features; f; f = f->next) {
1030 GstPluginFeature *feature = GST_PLUGIN_FEATURE (f->data);
1032 if (GST_IS_ELEMENT_FACTORY (feature)) {
1033 GstElementFactory *factory;
1034 GstElement *element;
1036 factory = GST_ELEMENT_FACTORY (gst_plugin_feature_load (feature));
1038 g_print ("element plugin %s couldn't be loaded\n",
1039 gst_plugin_get_name (plugin));
1043 element = gst_element_factory_create (factory, NULL);
1045 g_print ("couldn't construct element for %s for some reason\n",
1046 GST_OBJECT_NAME (factory));
1047 gst_object_unref (factory);
1051 if (GST_IS_URI_HANDLER (element)) {
1052 const gchar *const *uri_protocols;
1056 switch (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element))) {
1069 gst_uri_handler_get_protocols (GST_URI_HANDLER (element));
1070 joined = g_strjoinv (", ", (gchar **) uri_protocols);
1072 g_print ("%s (%s, rank %u): %s\n",
1073 gst_plugin_feature_get_name (GST_PLUGIN_FEATURE (factory)), dir,
1074 gst_plugin_feature_get_rank (GST_PLUGIN_FEATURE (factory)),
1080 gst_object_unref (element);
1081 gst_object_unref (factory);
1085 gst_plugin_feature_list_free (features);
1088 gst_plugin_list_free (plugins);
1092 print_plugin_info (GstPlugin * plugin)
1094 const gchar *release_date = gst_plugin_get_release_date_string (plugin);
1095 const gchar *filename = gst_plugin_get_filename (plugin);
1097 n_print ("Plugin Details:\n");
1098 n_print (" %-25s%s\n", "Name", gst_plugin_get_name (plugin));
1099 n_print (" %-25s%s\n", "Description", gst_plugin_get_description (plugin));
1100 n_print (" %-25s%s\n", "Filename", (filename != NULL) ? filename : "(null)");
1101 n_print (" %-25s%s\n", "Version", gst_plugin_get_version (plugin));
1102 n_print (" %-25s%s\n", "License", gst_plugin_get_license (plugin));
1103 n_print (" %-25s%s\n", "Source module", gst_plugin_get_source (plugin));
1105 if (release_date != NULL) {
1106 const gchar *tz = "(UTC)";
1109 /* may be: YYYY-MM-DD or YYYY-MM-DDTHH:MMZ */
1110 /* YYYY-MM-DDTHH:MMZ => YYYY-MM-DD HH:MM (UTC) */
1111 str = g_strdup (release_date);
1112 sep = strstr (str, "T");
1115 sep = strstr (sep + 1, "Z");
1121 n_print (" %-25s%s%s\n", "Source release date", str, tz);
1124 n_print (" %-25s%s\n", "Binary package", gst_plugin_get_package (plugin));
1125 n_print (" %-25s%s\n", "Origin URL", gst_plugin_get_origin (plugin));
1130 print_plugin_features (GstPlugin * plugin)
1132 GList *features, *origlist;
1133 gint num_features = 0;
1134 gint num_elements = 0;
1135 gint num_typefinders = 0;
1138 origlist = features =
1139 gst_registry_get_feature_list_by_plugin (gst_registry_get (),
1140 gst_plugin_get_name (plugin));
1143 GstPluginFeature *feature;
1145 feature = GST_PLUGIN_FEATURE (features->data);
1147 if (GST_IS_ELEMENT_FACTORY (feature)) {
1148 GstElementFactory *factory;
1150 factory = GST_ELEMENT_FACTORY (feature);
1151 n_print (" %s: %s\n", GST_OBJECT_NAME (factory),
1152 gst_element_factory_get_metadata (factory,
1153 GST_ELEMENT_METADATA_LONGNAME));
1155 } else if (GST_IS_TYPE_FIND_FACTORY (feature)) {
1156 GstTypeFindFactory *factory;
1157 const gchar *const *extensions;
1159 factory = GST_TYPE_FIND_FACTORY (feature);
1160 extensions = gst_type_find_factory_get_extensions (factory);
1164 g_print (" %s: %s: ", gst_plugin_get_name (plugin),
1165 gst_plugin_feature_get_name (feature));
1166 while (extensions[i]) {
1167 g_print ("%s%s", i > 0 ? ", " : "", extensions[i]);
1172 g_print (" %s: %s: no extensions\n", gst_plugin_get_name (plugin),
1173 gst_plugin_feature_get_name (feature));
1176 } else if (feature) {
1177 n_print (" %s (%s)\n", gst_object_get_name (GST_OBJECT (feature)),
1178 g_type_name (G_OBJECT_TYPE (feature)));
1182 features = g_list_next (features);
1185 gst_plugin_feature_list_free (origlist);
1188 n_print (" %d features:\n", num_features);
1189 if (num_elements > 0)
1190 n_print (" +-- %d elements\n", num_elements);
1191 if (num_typefinders > 0)
1192 n_print (" +-- %d typefinders\n", num_typefinders);
1194 n_print (" +-- %d other objects\n", num_other);
1200 print_element_features (const gchar * element_name)
1202 GstPluginFeature *feature;
1204 /* FIXME implement other pretty print function for these */
1205 feature = gst_registry_find_feature (gst_registry_get (), element_name,
1206 GST_TYPE_TYPE_FIND_FACTORY);
1208 n_print ("%s: a typefind function\n", element_name);
1216 print_element_info (GstElementFactory * factory, gboolean print_names)
1218 GstElement *element;
1223 GST_ELEMENT_FACTORY (gst_plugin_feature_load (GST_PLUGIN_FEATURE
1227 g_print ("element plugin couldn't be loaded\n");
1231 element = gst_element_factory_create (factory, NULL);
1233 gst_object_unref (factory);
1234 g_print ("couldn't construct element for some reason\n");
1239 _name = g_strdup_printf ("%s: ", GST_OBJECT_NAME (factory));
1243 print_factory_details_info (factory);
1245 plugin = gst_plugin_feature_get_plugin (GST_PLUGIN_FEATURE (factory));
1247 print_plugin_info (plugin);
1248 gst_object_unref (plugin);
1251 print_hierarchy (G_OBJECT_TYPE (element), 0, &maxlevel);
1252 print_interfaces (G_OBJECT_TYPE (element));
1254 print_pad_templates_info (element, factory);
1255 print_element_flag_info (element);
1256 print_implementation_info (element);
1257 print_clocking_info (element);
1258 print_uri_handler_info (element);
1259 print_pad_info (element);
1260 print_element_properties_info (element);
1261 print_signal_info (element);
1262 print_children_info (element);
1264 gst_object_unref (element);
1265 gst_object_unref (factory);
1273 print_plugin_automatic_install_info_codecs (GstElementFactory * factory)
1275 GstPadDirection direction;
1276 const gchar *type_name;
1278 const GList *static_templates, *l;
1279 GstCaps *caps = NULL;
1283 gst_element_factory_get_metadata (factory, GST_ELEMENT_METADATA_KLASS);
1284 g_return_if_fail (klass != NULL);
1286 if (strstr (klass, "Demuxer") ||
1287 strstr (klass, "Decoder") ||
1288 strstr (klass, "Depay") || strstr (klass, "Parser")) {
1289 type_name = "decoder";
1290 direction = GST_PAD_SINK;
1291 } else if (strstr (klass, "Muxer") ||
1292 strstr (klass, "Encoder") || strstr (klass, "Pay")) {
1293 type_name = "encoder";
1294 direction = GST_PAD_SRC;
1299 /* decoder/demuxer sink pads should always be static and there should only
1300 * be one, the same applies to encoders/muxers and source pads */
1301 static_templates = gst_element_factory_get_static_pad_templates (factory);
1302 for (l = static_templates; l != NULL; l = l->next) {
1303 GstStaticPadTemplate *tmpl = NULL;
1305 tmpl = (GstStaticPadTemplate *) l->data;
1306 if (tmpl->direction == direction) {
1307 caps = gst_static_pad_template_get_caps (tmpl);
1313 g_printerr ("Couldn't find static pad template for %s '%s'\n",
1314 type_name, GST_OBJECT_NAME (factory));
1318 caps = gst_caps_make_writable (caps);
1319 num = gst_caps_get_size (caps);
1320 for (i = 0; i < num; ++i) {
1324 s = gst_caps_get_structure (caps, i);
1325 /* remove fields that are almost always just MIN-MAX of some sort
1326 * in order to make the caps look less messy */
1327 gst_structure_remove_field (s, "pixel-aspect-ratio");
1328 gst_structure_remove_field (s, "framerate");
1329 gst_structure_remove_field (s, "channels");
1330 gst_structure_remove_field (s, "width");
1331 gst_structure_remove_field (s, "height");
1332 gst_structure_remove_field (s, "rate");
1333 gst_structure_remove_field (s, "depth");
1334 gst_structure_remove_field (s, "clock-rate");
1335 s_str = gst_structure_to_string (s);
1336 g_print ("%s-%s\n", type_name, s_str);
1339 gst_caps_unref (caps);
1343 print_plugin_automatic_install_info_protocols (GstElementFactory * factory)
1345 const gchar *const *protocols;
1347 protocols = gst_element_factory_get_uri_protocols (factory);
1348 if (protocols != NULL && *protocols != NULL) {
1349 switch (gst_element_factory_get_uri_type (factory)) {
1351 while (*protocols != NULL) {
1352 g_print ("urisink-%s\n", *protocols);
1357 while (*protocols != NULL) {
1358 g_print ("urisource-%s\n", *protocols);
1369 print_plugin_automatic_install_info (GstPlugin * plugin)
1371 GList *features, *l;
1373 /* not interested in typefind factories, only element factories */
1374 features = gst_registry_get_feature_list (gst_registry_get (),
1375 GST_TYPE_ELEMENT_FACTORY);
1377 for (l = features; l != NULL; l = l->next) {
1378 GstPluginFeature *feature;
1379 GstPlugin *feature_plugin;
1381 feature = GST_PLUGIN_FEATURE (l->data);
1383 /* only interested in the ones that are in the plugin we just loaded */
1384 feature_plugin = gst_plugin_feature_get_plugin (feature);
1385 if (feature_plugin == plugin) {
1386 GstElementFactory *factory;
1388 g_print ("element-%s\n", gst_plugin_feature_get_name (feature));
1390 factory = GST_ELEMENT_FACTORY (feature);
1391 print_plugin_automatic_install_info_protocols (factory);
1392 print_plugin_automatic_install_info_codecs (factory);
1395 gst_object_unref (feature_plugin);
1398 g_list_foreach (features, (GFunc) gst_object_unref, NULL);
1399 g_list_free (features);
1403 print_all_plugin_automatic_install_info (void)
1405 GList *plugins, *orig_plugins;
1407 orig_plugins = plugins = gst_registry_get_plugin_list (gst_registry_get ());
1411 plugin = (GstPlugin *) (plugins->data);
1412 plugins = g_list_next (plugins);
1414 print_plugin_automatic_install_info (plugin);
1416 gst_plugin_list_free (orig_plugins);
1420 main (int argc, char *argv[])
1422 gboolean print_all = FALSE;
1423 gboolean do_print_blacklist = FALSE;
1424 gboolean plugin_name = FALSE;
1425 gboolean print_aii = FALSE;
1426 gboolean uri_handlers = FALSE;
1427 gboolean check_exists = FALSE;
1428 gchar *min_version = NULL;
1429 guint minver_maj = GST_VERSION_MAJOR;
1430 guint minver_min = GST_VERSION_MINOR;
1431 guint minver_micro = 0;
1432 #ifndef GST_DISABLE_OPTION_PARSING
1433 GOptionEntry options[] = {
1434 {"print-all", 'a', 0, G_OPTION_ARG_NONE, &print_all,
1435 N_("Print all elements"), NULL},
1436 {"print-blacklist", 'b', 0, G_OPTION_ARG_NONE, &do_print_blacklist,
1437 N_("Print list of blacklisted files"), NULL},
1438 {"print-plugin-auto-install-info", '\0', 0, G_OPTION_ARG_NONE, &print_aii,
1439 N_("Print a machine-parsable list of features the specified plugin "
1440 "or all plugins provide.\n "
1441 "Useful in connection with external automatic plugin "
1442 "installation mechanisms"), NULL},
1443 {"plugin", '\0', 0, G_OPTION_ARG_NONE, &plugin_name,
1444 N_("List the plugin contents"), NULL},
1445 {"exists", '\0', 0, G_OPTION_ARG_NONE, &check_exists,
1446 N_("Check if the specified element or plugin exists"), NULL},
1447 {"atleast-version", '\0', 0, G_OPTION_ARG_STRING, &min_version,
1449 ("When checking if an element or plugin exists, also check that its "
1450 "version is at least the version specified"), NULL},
1451 {"uri-handlers", 'u', 0, G_OPTION_ARG_NONE, &uri_handlers,
1453 ("Print supported URI schemes, with the elements that implement them"),
1455 GST_TOOLS_GOPTION_VERSION,
1458 GOptionContext *ctx;
1462 setlocale (LC_ALL, "");
1465 bindtextdomain (GETTEXT_PACKAGE, LOCALEDIR);
1466 bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
1467 textdomain (GETTEXT_PACKAGE);
1470 g_set_prgname ("gst-inspect-" GST_API_VERSION);
1472 #ifndef GST_DISABLE_OPTION_PARSING
1473 ctx = g_option_context_new ("[ELEMENT-NAME | PLUGIN-NAME]");
1474 g_option_context_add_main_entries (ctx, options, GETTEXT_PACKAGE);
1475 g_option_context_add_group (ctx, gst_init_get_option_group ());
1476 if (!g_option_context_parse (ctx, &argc, &argv, &err)) {
1477 g_printerr ("Error initializing: %s\n", err->message);
1480 g_option_context_free (ctx);
1482 gst_init (&argc, &argv);
1485 gst_tools_print_version ();
1487 if (print_all && argc > 1) {
1488 g_printerr ("-a requires no extra arguments\n");
1492 if (uri_handlers && argc > 1) {
1493 g_printerr ("-u requires no extra arguments\n");
1497 /* --atleast-version implies --exists */
1498 if (min_version != NULL) {
1499 if (sscanf (min_version, "%u.%u.%u", &minver_maj, &minver_min,
1500 &minver_micro) < 2) {
1501 g_printerr ("Can't parse version '%s' passed to --atleast-version\n",
1505 check_exists = TRUE;
1512 g_printerr ("--exists requires an extra command line argument\n");
1516 GstPluginFeature *feature;
1518 feature = gst_registry_lookup_feature (gst_registry_get (), argv[1]);
1519 if (feature != NULL && gst_plugin_feature_check_version (feature,
1520 minver_maj, minver_min, minver_micro)) {
1526 /* FIXME: support checking for plugins too */
1527 g_printerr ("Checking for plugins is not supported yet\n");
1534 /* if no arguments, print out list of elements */
1536 print_all_uri_handlers ();
1537 } else if (argc == 1 || print_all) {
1538 if (do_print_blacklist)
1542 print_all_plugin_automatic_install_info ();
1544 print_element_list (print_all);
1547 /* else we try to get a factory */
1548 GstElementFactory *factory;
1550 const char *arg = argv[argc - 1];
1554 factory = gst_element_factory_find (arg);
1556 /* if there's a factory, print out the info */
1558 retval = print_element_info (factory, print_all);
1559 gst_object_unref (factory);
1561 retval = print_element_features (arg);
1567 /* otherwise check if it's a plugin */
1569 plugin = gst_registry_find_plugin (gst_registry_get (), arg);
1571 /* if there is such a plugin, print out info */
1574 print_plugin_automatic_install_info (plugin);
1576 print_plugin_info (plugin);
1577 print_plugin_features (plugin);
1580 GError *error = NULL;
1582 if (g_file_test (arg, G_FILE_TEST_EXISTS)) {
1583 plugin = gst_plugin_load_file (arg, &error);
1587 print_plugin_automatic_install_info (plugin);
1589 print_plugin_info (plugin);
1590 print_plugin_features (plugin);
1593 g_printerr (_("Could not load plugin file: %s\n"), error->message);
1594 g_error_free (error);
1598 g_printerr (_("No such element or plugin '%s'\n"), arg);