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., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
32 #include <glib/gprintf.h>
34 static char *_name = NULL;
36 static int print_element_info (GstElementFactory * factory,
37 gboolean print_names);
40 n_print (const char *format, ...)
45 g_print ("%s", _name);
47 va_start (args, format);
48 g_vprintf (format, args);
53 print_field (GQuark field, const GValue * value, gpointer pfx)
55 gchar *str = gst_value_serialize (value);
57 n_print ("%s %15s: %s\n", (gchar *) pfx, g_quark_to_string (field), str);
63 print_caps (const GstCaps * caps, const gchar * pfx)
67 g_return_if_fail (caps != NULL);
69 if (gst_caps_is_any (caps)) {
70 n_print ("%sANY\n", pfx);
73 if (gst_caps_is_empty (caps)) {
74 n_print ("%sEMPTY\n", pfx);
78 for (i = 0; i < gst_caps_get_size (caps); i++) {
79 GstStructure *structure = gst_caps_get_structure (caps, i);
81 n_print ("%s%s\n", pfx, gst_structure_get_name (structure));
82 gst_structure_foreach (structure, print_field, (gpointer) pfx);
88 print_formats (const GstFormat * formats)
90 while (formats && *formats) {
91 const GstFormatDefinition *definition;
93 definition = gst_format_get_details (*formats);
95 n_print ("\t\t(%d):\t%s (%s)\n", *formats,
96 definition->nick, definition->description);
98 n_print ("\t\t(%d):\tUnknown format\n", *formats);
105 print_event_masks (const GstEventMask * masks)
110 GFlagsClass *flags_class = NULL;
112 event_type = gst_event_type_get_type ();
113 klass = (GEnumClass *) g_type_class_ref (event_type);
115 while (masks && masks->type) {
117 gint flags = 0, index = 0;
119 switch (masks->type) {
121 flags = masks->flags;
122 event_flags = gst_seek_type_get_type ();
123 flags_class = (GFlagsClass *) g_type_class_ref (event_flags);
129 value = g_enum_get_value (klass, masks->type);
130 g_print ("\t\t%s ", value->value_nick);
136 value = g_flags_get_first_value (flags_class, 1 << index);
139 g_print ("| %s ", value->value_nick);
154 get_rank_name (char *s, gint rank)
156 static const int ranks[4] = {
157 GST_RANK_NONE, GST_RANK_MARGINAL, GST_RANK_SECONDARY, GST_RANK_PRIMARY
159 static const char *rank_names[4] = { "none", "marginal", "secondary",
166 for (i = 0; i < 4; i++) {
167 if (rank == ranks[i])
168 return rank_names[i];
169 if (abs (rank - ranks[i]) < abs (rank - ranks[best_i])) {
174 sprintf (s, "%s %c %d", rank_names[best_i],
175 (rank - ranks[best_i] > 0) ? '+' : '-', abs (ranks[best_i] - rank));
181 print_factory_details_metadata (GQuark field_id, const GValue * value,
184 gchar *val = g_strdup_value_contents (value);
185 gchar *key = g_strdup (g_quark_to_string (field_id));
187 key[0] = g_ascii_toupper (key[0]);
188 n_print (" %s:\t\t%s\n", key, val);
195 print_factory_details_info (GstElementFactory * factory)
199 n_print ("Factory Details:\n");
200 n_print (" Rank:\t\t%s (%d)\n",
201 get_rank_name (s, GST_PLUGIN_FEATURE (factory)->rank),
202 GST_PLUGIN_FEATURE (factory)->rank);
203 gst_structure_foreach ((GstStructure *) factory->metadata,
204 print_factory_details_metadata, NULL);
209 print_hierarchy (GType type, gint level, gint * maxlevel)
214 parent = g_type_parent (type);
216 *maxlevel = *maxlevel + 1;
220 print_hierarchy (parent, level, maxlevel);
223 g_print ("%s", _name);
225 for (i = 1; i < *maxlevel - level; i++)
227 if (*maxlevel - level)
230 g_print ("%s\n", g_type_name (type));
237 print_interfaces (GType type)
240 GType *iface, *ifaces = g_type_interfaces (type, &n_ifaces);
245 g_print ("%s", _name);
246 g_print (_("Implemented Interfaces:\n"));
250 g_print ("%s", _name);
251 g_print (" %s\n", g_type_name (*iface));
255 g_print ("%s", _name);
263 flags_to_string (GFlagsValue * vals, guint flags)
268 /* first look for an exact match and count the number of values */
269 for (i = 0; vals[i].value_name != NULL; ++i) {
270 if (vals[i].value == flags)
271 return g_strdup (vals[i].value_nick);
274 s = g_string_new (NULL);
276 /* we assume the values are sorted from lowest to highest value */
280 if (vals[i].value != 0 && (flags_left & vals[i].value) == vals[i].value) {
282 g_string_append_c (s, '+');
283 g_string_append (s, vals[i].value_nick);
284 flags_left -= vals[i].value;
291 g_string_assign (s, "(none)");
293 return g_string_free (s, FALSE);
296 #define KNOWN_PARAM_FLAGS \
297 (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY | \
298 G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS | \
299 G_PARAM_READABLE | G_PARAM_WRITABLE | GST_PARAM_CONTROLLABLE | \
300 GST_PARAM_MUTABLE_PLAYING | GST_PARAM_MUTABLE_PAUSED | \
301 GST_PARAM_MUTABLE_READY)
304 print_element_properties_info (GstElement * element)
306 GParamSpec **property_specs;
307 guint num_properties, i;
311 property_specs = g_object_class_list_properties
312 (G_OBJECT_GET_CLASS (element), &num_properties);
314 n_print ("Element Properties:\n");
316 for (i = 0; i < num_properties; i++) {
317 GValue value = { 0, };
318 GParamSpec *param = property_specs[i];
322 g_value_init (&value, param->value_type);
324 n_print (" %-20s: %s\n", g_param_spec_get_name (param),
325 g_param_spec_get_blurb (param));
328 n_print ("%-23.23s flags: ", "");
329 if (param->flags & G_PARAM_READABLE) {
330 g_object_get_property (G_OBJECT (element), param->name, &value);
332 g_print ("%s%s", (first_flag) ? "" : ", ", _("readable"));
335 /* if we can't read the property value, assume it's set to the default
336 * (which might not be entirely true for sub-classes, but that's an
337 * unlikely corner-case anyway) */
338 g_param_value_set_default (param, &value);
340 if (param->flags & G_PARAM_WRITABLE) {
341 g_print ("%s%s", (first_flag) ? "" : ", ", _("writable"));
344 if (param->flags & GST_PARAM_CONTROLLABLE) {
345 g_print (", %s", _("controllable"));
348 if (param->flags & GST_PARAM_MUTABLE_PLAYING) {
349 g_print (", %s", _("changeable in NULL, READY, PAUSED or PLAYING state"));
350 } else if (param->flags & GST_PARAM_MUTABLE_PAUSED) {
351 g_print (", %s", _("changeable only in NULL, READY or PAUSED state"));
352 } else if (param->flags & GST_PARAM_MUTABLE_READY) {
353 g_print (", %s", _("changeable only in NULL or READY state"));
355 if (param->flags & ~KNOWN_PARAM_FLAGS) {
356 g_print ("%s0x%0x", (first_flag) ? "" : ", ",
357 param->flags & ~KNOWN_PARAM_FLAGS);
361 switch (G_VALUE_TYPE (&value)) {
364 const char *string_val = g_value_get_string (&value);
366 n_print ("%-23.23s String. ", "");
368 if (string_val == NULL)
369 g_print ("Default: null");
371 g_print ("Default: \"%s\"", string_val);
376 gboolean bool_val = g_value_get_boolean (&value);
378 n_print ("%-23.23s Boolean. ", "");
380 g_print ("Default: %s", bool_val ? "true" : "false");
385 GParamSpecULong *pulong = G_PARAM_SPEC_ULONG (param);
387 n_print ("%-23.23s Unsigned Long. ", "");
388 g_print ("Range: %lu - %lu Default: %lu ",
389 pulong->minimum, pulong->maximum, g_value_get_ulong (&value));
394 GParamSpecLong *plong = G_PARAM_SPEC_LONG (param);
396 n_print ("%-23.23s Long. ", "");
397 g_print ("Range: %ld - %ld Default: %ld ",
398 plong->minimum, plong->maximum, g_value_get_long (&value));
403 GParamSpecUInt *puint = G_PARAM_SPEC_UINT (param);
405 n_print ("%-23.23s Unsigned Integer. ", "");
406 g_print ("Range: %u - %u Default: %u ",
407 puint->minimum, puint->maximum, g_value_get_uint (&value));
412 GParamSpecInt *pint = G_PARAM_SPEC_INT (param);
414 n_print ("%-23.23s Integer. ", "");
415 g_print ("Range: %d - %d Default: %d ",
416 pint->minimum, pint->maximum, g_value_get_int (&value));
421 GParamSpecUInt64 *puint64 = G_PARAM_SPEC_UINT64 (param);
423 n_print ("%-23.23s Unsigned Integer64. ", "");
424 g_print ("Range: %" G_GUINT64_FORMAT " - %" G_GUINT64_FORMAT
425 " Default: %" G_GUINT64_FORMAT " ",
426 puint64->minimum, puint64->maximum, g_value_get_uint64 (&value));
431 GParamSpecInt64 *pint64 = G_PARAM_SPEC_INT64 (param);
433 n_print ("%-23.23s Integer64. ", "");
434 g_print ("Range: %" G_GINT64_FORMAT " - %" G_GINT64_FORMAT
435 " Default: %" G_GINT64_FORMAT " ",
436 pint64->minimum, pint64->maximum, g_value_get_int64 (&value));
441 GParamSpecFloat *pfloat = G_PARAM_SPEC_FLOAT (param);
443 n_print ("%-23.23s Float. ", "");
444 g_print ("Range: %15.7g - %15.7g Default: %15.7g ",
445 pfloat->minimum, pfloat->maximum, g_value_get_float (&value));
450 GParamSpecDouble *pdouble = G_PARAM_SPEC_DOUBLE (param);
452 n_print ("%-23.23s Double. ", "");
453 g_print ("Range: %15.7g - %15.7g Default: %15.7g ",
454 pdouble->minimum, pdouble->maximum, g_value_get_double (&value));
458 if (param->value_type == GST_TYPE_CAPS) {
459 const GstCaps *caps = gst_value_get_caps (&value);
462 n_print ("%-23.23s Caps (NULL)", "");
464 print_caps (caps, " ");
466 } else if (G_IS_PARAM_SPEC_ENUM (param)) {
470 const gchar *value_nick = "";
472 values = G_ENUM_CLASS (g_type_class_ref (param->value_type))->values;
473 enum_value = g_value_get_enum (&value);
475 while (values[j].value_name) {
476 if (values[j].value == enum_value)
477 value_nick = values[j].value_nick;
481 n_print ("%-23.23s Enum \"%s\" Default: %d, \"%s\"", "",
482 g_type_name (G_VALUE_TYPE (&value)), enum_value, value_nick);
485 while (values[j].value_name) {
488 g_print ("%s", _name);
489 g_print ("%-23.23s (%d): %-16s - %s", "",
490 values[j].value, values[j].value_nick, values[j].value_name);
493 /* g_type_class_unref (ec); */
494 } else if (G_IS_PARAM_SPEC_FLAGS (param)) {
495 GParamSpecFlags *pflags = G_PARAM_SPEC_FLAGS (param);
499 vals = pflags->flags_class->values;
501 cur = flags_to_string (vals, g_value_get_flags (&value));
503 n_print ("%-23.23s Flags \"%s\" Default: 0x%08x, \"%s\"", "",
504 g_type_name (G_VALUE_TYPE (&value)),
505 g_value_get_flags (&value), cur);
507 while (vals[0].value_name) {
510 g_print ("%s", _name);
511 g_print ("%-23.23s (0x%08x): %-16s - %s", "",
512 vals[0].value, vals[0].value_nick, vals[0].value_name);
517 } else if (G_IS_PARAM_SPEC_OBJECT (param)) {
518 n_print ("%-23.23s Object of type \"%s\"", "",
519 g_type_name (param->value_type));
520 } else if (G_IS_PARAM_SPEC_BOXED (param)) {
521 n_print ("%-23.23s Boxed pointer of type \"%s\"", "",
522 g_type_name (param->value_type));
523 } else if (G_IS_PARAM_SPEC_POINTER (param)) {
524 if (param->value_type != G_TYPE_POINTER) {
525 n_print ("%-23.23s Pointer of type \"%s\".", "",
526 g_type_name (param->value_type));
528 n_print ("%-23.23s Pointer.", "");
530 } else if (param->value_type == G_TYPE_VALUE_ARRAY) {
531 GParamSpecValueArray *pvarray = G_PARAM_SPEC_VALUE_ARRAY (param);
533 if (pvarray->element_spec) {
534 n_print ("%-23.23s Array of GValues of type \"%s\"", "",
535 g_type_name (pvarray->element_spec->value_type));
537 n_print ("%-23.23s Array of GValues", "");
539 } else if (GST_IS_PARAM_SPEC_FRACTION (param)) {
540 GstParamSpecFraction *pfraction = GST_PARAM_SPEC_FRACTION (param);
542 n_print ("%-23.23s Fraction. ", "");
544 g_print ("Range: %d/%d - %d/%d Default: %d/%d ",
545 pfraction->min_num, pfraction->min_den,
546 pfraction->max_num, pfraction->max_den,
547 gst_value_get_fraction_numerator (&value),
548 gst_value_get_fraction_denominator (&value));
550 n_print ("%-23.23s Unknown type %ld \"%s\"", "", param->value_type,
551 g_type_name (param->value_type));
556 g_print (" Write only\n");
560 g_value_reset (&value);
562 if (num_properties == 0)
565 g_free (property_specs);
569 print_pad_templates_info (GstElement * element, GstElementFactory * factory)
571 GstElementClass *gstelement_class;
573 GstStaticPadTemplate *padtemplate;
575 n_print ("Pad Templates:\n");
576 if (!factory->numpadtemplates) {
581 gstelement_class = GST_ELEMENT_CLASS (G_OBJECT_GET_CLASS (element));
583 pads = factory->staticpadtemplates;
585 padtemplate = (GstStaticPadTemplate *) (pads->data);
586 pads = g_list_next (pads);
588 if (padtemplate->direction == GST_PAD_SRC)
589 n_print (" SRC template: '%s'\n", padtemplate->name_template);
590 else if (padtemplate->direction == GST_PAD_SINK)
591 n_print (" SINK template: '%s'\n", padtemplate->name_template);
593 n_print (" UNKNOWN!!! template: '%s'\n", padtemplate->name_template);
595 if (padtemplate->presence == GST_PAD_ALWAYS)
596 n_print (" Availability: Always\n");
597 else if (padtemplate->presence == GST_PAD_SOMETIMES)
598 n_print (" Availability: Sometimes\n");
599 else if (padtemplate->presence == GST_PAD_REQUEST) {
600 n_print (" Availability: On request\n");
601 n_print (" Has request_new_pad() function: %s\n",
602 GST_DEBUG_FUNCPTR_NAME (gstelement_class->request_new_pad));
604 n_print (" Availability: UNKNOWN!!!\n");
606 if (padtemplate->static_caps.string) {
607 n_print (" Capabilities:\n");
608 print_caps (gst_static_caps_get (&padtemplate->static_caps), " ");
616 print_element_flag_info (GstElement * element)
618 gboolean have_flags = FALSE;
621 n_print ("Element Flags:\n");
624 n_print (" no flags set\n");
626 if (GST_IS_BIN (element)) {
628 n_print ("Bin Flags:\n");
630 n_print (" no flags set\n");
635 print_implementation_info (GstElement * element)
637 GstElementClass *gstelement_class;
639 gstelement_class = GST_ELEMENT_CLASS (G_OBJECT_GET_CLASS (element));
642 n_print ("Element Implementation:\n");
644 n_print (" Has change_state() function: %s\n",
645 GST_DEBUG_FUNCPTR_NAME (gstelement_class->change_state));
649 print_clocking_info (GstElement * element)
651 if (!gst_element_requires_clock (element) &&
652 !(gst_element_provides_clock (element) &&
653 gst_element_get_clock (element))) {
655 n_print ("Element has no clocking capabilities.");
660 n_print ("Clocking Interaction:\n");
661 if (gst_element_requires_clock (element)) {
662 n_print (" element requires a clock\n");
665 if (gst_element_provides_clock (element)) {
668 clock = gst_element_get_clock (element);
670 n_print (" element provides a clock: %s\n", GST_OBJECT_NAME (clock));
672 n_print (" element is supposed to provide a clock but returned NULL\n");
677 print_index_info (GstElement * element)
679 if (gst_element_is_indexable (element)) {
681 n_print ("Indexing capabilities:\n");
682 n_print (" element can do indexing\n");
685 n_print ("Element has no indexing capabilities.\n");
690 print_uri_handler_info (GstElement * element)
692 if (GST_IS_URI_HANDLER (element)) {
693 const gchar *uri_type;
694 gchar **uri_protocols;
696 if (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element)) == GST_URI_SRC)
698 else if (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element)) ==
702 uri_type = "unknown";
704 uri_protocols = gst_uri_handler_get_protocols (GST_URI_HANDLER (element));
707 n_print ("URI handling capabilities:\n");
708 n_print (" Element can act as %s.\n", uri_type);
710 if (uri_protocols && *uri_protocols) {
711 n_print (" Supported URI protocols:\n");
712 for (; *uri_protocols != NULL; uri_protocols++)
713 n_print (" %s\n", *uri_protocols);
715 n_print (" No supported URI protocols\n");
718 n_print ("Element has no URI handling capabilities.\n");
723 print_pad_info (GstElement * element)
731 if (!element->numpads) {
736 pads = element->pads;
741 pad = GST_PAD (pads->data);
742 pads = g_list_next (pads);
746 name = gst_pad_get_name (pad);
747 if (gst_pad_get_direction (pad) == GST_PAD_SRC)
748 g_print (" SRC: '%s'", name);
749 else if (gst_pad_get_direction (pad) == GST_PAD_SINK)
750 g_print (" SINK: '%s'", name);
752 g_print (" UNKNOWN!!!: '%s'", name);
758 n_print (" Implementation:\n");
760 n_print (" Has chainfunc(): %s\n",
761 GST_DEBUG_FUNCPTR_NAME (pad->chainfunc));
762 if (pad->getrangefunc)
763 n_print (" Has getrangefunc(): %s\n",
764 GST_DEBUG_FUNCPTR_NAME (pad->getrangefunc));
765 if (pad->eventfunc != gst_pad_event_default)
766 n_print (" Has custom eventfunc(): %s\n",
767 GST_DEBUG_FUNCPTR_NAME (pad->eventfunc));
768 if (pad->queryfunc != gst_pad_query_default)
769 n_print (" Has custom queryfunc(): %s\n",
770 GST_DEBUG_FUNCPTR_NAME (pad->queryfunc));
772 if (pad->iterintlinkfunc != gst_pad_iterate_internal_links_default)
773 n_print (" Has custom iterintlinkfunc(): %s\n",
774 GST_DEBUG_FUNCPTR_NAME (pad->iterintlinkfunc));
776 if (pad->getcapsfunc)
777 n_print (" Has getcapsfunc(): %s\n",
778 GST_DEBUG_FUNCPTR_NAME (pad->getcapsfunc));
780 if (pad->padtemplate)
781 n_print (" Pad Template: '%s'\n", pad->padtemplate->name_template);
783 caps = gst_pad_get_current_caps (pad);
785 n_print (" Capabilities:\n");
786 print_caps (caps, " ");
787 gst_caps_unref (caps);
793 has_sometimes_template (GstElement * element)
795 GstElementClass *klass = GST_ELEMENT_GET_CLASS (element);
798 for (l = klass->padtemplates; l != NULL; l = l->next) {
799 if (GST_PAD_TEMPLATE (l->data)->presence == GST_PAD_SOMETIMES)
807 print_signal_info (GstElement * element)
809 /* Signals/Actions Block */
813 GSignalQuery *query = NULL;
815 GSList *found_signals, *l;
817 for (k = 0; k < 2; k++) {
818 found_signals = NULL;
820 /* For elements that have sometimes pads, also list a few useful GstElement
821 * signals. Put these first, so element-specific ones come later. */
822 if (k == 0 && has_sometimes_template (element)) {
823 query = g_new0 (GSignalQuery, 1);
824 g_signal_query (g_signal_lookup ("pad-added", GST_TYPE_ELEMENT), query);
825 found_signals = g_slist_append (found_signals, query);
826 query = g_new0 (GSignalQuery, 1);
827 g_signal_query (g_signal_lookup ("pad-removed", GST_TYPE_ELEMENT), query);
828 found_signals = g_slist_append (found_signals, query);
829 query = g_new0 (GSignalQuery, 1);
830 g_signal_query (g_signal_lookup ("no-more-pads", GST_TYPE_ELEMENT),
832 found_signals = g_slist_append (found_signals, query);
835 for (type = G_OBJECT_TYPE (element); type; type = g_type_parent (type)) {
836 if (type == GST_TYPE_ELEMENT || type == GST_TYPE_OBJECT)
839 if (type == GST_TYPE_BIN && G_OBJECT_TYPE (element) != GST_TYPE_BIN)
842 signals = g_signal_list_ids (type, &nsignals);
843 for (i = 0; i < nsignals; i++) {
844 query = g_new0 (GSignalQuery, 1);
845 g_signal_query (signals[i], query);
847 if ((k == 0 && !(query->signal_flags & G_SIGNAL_ACTION)) ||
848 (k == 1 && (query->signal_flags & G_SIGNAL_ACTION)))
849 found_signals = g_slist_append (found_signals, query);
860 n_print ("Element Signals:\n");
862 n_print ("Element Actions:\n");
867 for (l = found_signals; l; l = l->next) {
871 query = (GSignalQuery *) l->data;
872 indent_len = strlen (query->signal_name) +
873 strlen (g_type_name (query->return_type)) + 24;
875 indent = g_new0 (gchar, indent_len + 1);
876 memset (indent, ' ', indent_len);
878 n_print (" \"%s\" : %s user_function (%s* object",
880 g_type_name (query->return_type), g_type_name (type));
882 for (j = 0; j < query->n_params; j++) {
884 g_print ("%s", _name);
885 if (G_TYPE_IS_FUNDAMENTAL (query->param_types[j])) {
886 g_print (",\n%s%s arg%d", indent,
887 g_type_name (query->param_types[j]), j);
888 } else if (G_TYPE_IS_ENUM (query->param_types[j])) {
889 g_print (",\n%s%s arg%d", indent,
890 g_type_name (query->param_types[j]), j);
892 g_print (",\n%s%s* arg%d", indent,
893 g_type_name (query->param_types[j]), j);
899 g_print ("%s", _name);
900 g_print (",\n%sgpointer user_data);\n", indent);
908 g_slist_foreach (found_signals, (GFunc) g_free, NULL);
909 g_slist_free (found_signals);
915 print_children_info (GstElement * element)
919 if (!GST_IS_BIN (element))
922 children = (GList *) GST_BIN (element)->children;
925 g_print ("Children:\n");
929 n_print (" %s\n", GST_ELEMENT_NAME (GST_ELEMENT (children->data)));
930 children = g_list_next (children);
935 print_blacklist (void)
937 GList *plugins, *cur;
940 g_print ("%s\n", _("Blacklisted files:"));
942 plugins = gst_default_registry_get_plugin_list ();
943 for (cur = plugins; cur != NULL; cur = g_list_next (cur)) {
944 GstPlugin *plugin = (GstPlugin *) (cur->data);
945 if (plugin->flags & GST_PLUGIN_FLAG_BLACKLISTED) {
946 g_print (" %s\n", plugin->desc.name);
952 g_print (_("Total count: "));
953 g_print (ngettext ("%d blacklisted file", "%d blacklisted files", count),
956 gst_plugin_list_free (plugins);
960 print_element_list (gboolean print_all)
962 int plugincount = 0, featurecount = 0, blacklistcount = 0;
963 GList *plugins, *orig_plugins;
965 orig_plugins = plugins = gst_default_registry_get_plugin_list ();
967 GList *features, *orig_features;
970 plugin = (GstPlugin *) (plugins->data);
971 plugins = g_list_next (plugins);
974 if (plugin->flags & GST_PLUGIN_FLAG_BLACKLISTED) {
979 orig_features = features =
980 gst_registry_get_feature_list_by_plugin (gst_registry_get_default (),
983 GstPluginFeature *feature;
985 if (G_UNLIKELY (features->data == NULL))
987 feature = GST_PLUGIN_FEATURE (features->data);
990 if (GST_IS_ELEMENT_FACTORY (feature)) {
991 GstElementFactory *factory;
993 factory = GST_ELEMENT_FACTORY (feature);
995 print_element_info (factory, TRUE);
997 g_print ("%s: %s: %s\n", plugin->desc.name,
998 GST_OBJECT_NAME (factory),
999 gst_element_factory_get_longname (factory));
1000 } else if (GST_IS_INDEX_FACTORY (feature)) {
1001 GstIndexFactory *factory;
1003 factory = GST_INDEX_FACTORY (feature);
1005 g_print ("%s: %s: %s\n", plugin->desc.name,
1006 GST_OBJECT_NAME (factory), factory->longdesc);
1007 } else if (GST_IS_TYPE_FIND_FACTORY (feature)) {
1008 GstTypeFindFactory *factory;
1010 factory = GST_TYPE_FIND_FACTORY (feature);
1012 g_print ("%s: %s: ", plugin->desc.name,
1013 gst_plugin_feature_get_name (feature));
1014 if (factory->extensions) {
1017 while (factory->extensions[i]) {
1019 g_print ("%s%s", i > 0 ? ", " : "", factory->extensions[i]);
1026 g_print ("no extensions\n");
1030 n_print ("%s: %s (%s)\n", plugin->desc.name,
1031 GST_OBJECT_NAME (feature), g_type_name (G_OBJECT_TYPE (feature)));
1035 features = g_list_next (features);
1038 gst_plugin_feature_list_free (orig_features);
1041 gst_plugin_list_free (orig_plugins);
1044 g_print (_("Total count: "));
1045 g_print (ngettext ("%d plugin", "%d plugins", plugincount), plugincount);
1046 if (blacklistcount) {
1048 g_print (ngettext ("%d blacklist entry", "%d blacklist entries",
1049 blacklistcount), blacklistcount);
1050 g_print (" not shown)");
1053 g_print (ngettext ("%d feature", "%d features", featurecount), featurecount);
1058 print_all_uri_handlers (void)
1060 GList *plugins, *p, *features, *f;
1062 plugins = gst_default_registry_get_plugin_list ();
1064 for (p = plugins; p; p = p->next) {
1065 GstPlugin *plugin = (GstPlugin *) (p->data);
1068 gst_registry_get_feature_list_by_plugin (gst_registry_get_default (),
1071 for (f = features; f; f = f->next) {
1072 GstPluginFeature *feature = GST_PLUGIN_FEATURE (f->data);
1074 if (GST_IS_ELEMENT_FACTORY (feature)) {
1075 GstElementFactory *factory;
1076 GstElement *element;
1078 factory = GST_ELEMENT_FACTORY (gst_plugin_feature_load (feature));
1080 g_print ("element plugin %s couldn't be loaded\n", plugin->desc.name);
1084 element = gst_element_factory_create (factory, NULL);
1086 g_print ("couldn't construct element for %s for some reason\n",
1087 GST_OBJECT_NAME (factory));
1088 gst_object_unref (factory);
1092 if (GST_IS_URI_HANDLER (element)) {
1094 gchar **uri_protocols, *joined;
1096 switch (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element))) {
1109 gst_uri_handler_get_protocols (GST_URI_HANDLER (element));
1110 joined = g_strjoinv (", ", uri_protocols);
1112 g_print ("%s (%s, rank %u): %s\n",
1113 gst_plugin_feature_get_name (GST_PLUGIN_FEATURE (factory)), dir,
1114 gst_plugin_feature_get_rank (GST_PLUGIN_FEATURE (factory)),
1120 gst_object_unref (element);
1121 gst_object_unref (factory);
1125 gst_plugin_feature_list_free (features);
1128 gst_plugin_list_free (plugins);
1132 print_plugin_info (GstPlugin * plugin)
1134 n_print ("Plugin Details:\n");
1135 n_print (" Name:\t\t\t%s\n", plugin->desc.name);
1136 n_print (" Description:\t\t%s\n", plugin->desc.description);
1137 n_print (" Filename:\t\t%s\n",
1138 plugin->filename ? plugin->filename : "(null)");
1139 n_print (" Version:\t\t%s\n", plugin->desc.version);
1140 n_print (" License:\t\t%s\n", plugin->desc.license);
1141 n_print (" Source module:\t%s\n", plugin->desc.source);
1142 if (plugin->desc.release_datetime != NULL) {
1143 const gchar *tz = "(UTC)";
1146 /* may be: YYYY-MM-DD or YYYY-MM-DDTHH:MMZ */
1147 /* YYYY-MM-DDTHH:MMZ => YYYY-MM-DD HH:MM (UTC) */
1148 str = g_strdup (plugin->desc.release_datetime);
1149 sep = strstr (str, "T");
1152 sep = strstr (sep + 1, "Z");
1158 n_print (" Source release date:\t%s%s\n", str, tz);
1161 n_print (" Binary package:\t%s\n", plugin->desc.package);
1162 n_print (" Origin URL:\t\t%s\n", plugin->desc.origin);
1167 print_plugin_features (GstPlugin * plugin)
1169 GList *features, *origlist;
1170 gint num_features = 0;
1171 gint num_elements = 0;
1172 gint num_typefinders = 0;
1173 gint num_indexes = 0;
1176 origlist = features =
1177 gst_registry_get_feature_list_by_plugin (gst_registry_get_default (),
1181 GstPluginFeature *feature;
1183 feature = GST_PLUGIN_FEATURE (features->data);
1185 if (GST_IS_ELEMENT_FACTORY (feature)) {
1186 GstElementFactory *factory;
1188 factory = GST_ELEMENT_FACTORY (feature);
1189 n_print (" %s: %s\n", GST_OBJECT_NAME (factory),
1190 gst_element_factory_get_longname (factory));
1192 } else if (GST_IS_INDEX_FACTORY (feature)) {
1193 GstIndexFactory *factory;
1195 factory = GST_INDEX_FACTORY (feature);
1196 n_print (" %s: %s\n", GST_OBJECT_NAME (factory), factory->longdesc);
1198 } else if (GST_IS_TYPE_FIND_FACTORY (feature)) {
1199 GstTypeFindFactory *factory;
1201 factory = GST_TYPE_FIND_FACTORY (feature);
1202 if (factory->extensions) {
1205 g_print ("%s: %s: ", plugin->desc.name,
1206 gst_plugin_feature_get_name (feature));
1207 while (factory->extensions[i]) {
1208 g_print ("%s%s", i > 0 ? ", " : "", factory->extensions[i]);
1213 g_print ("%s: %s: no extensions\n", plugin->desc.name,
1214 gst_plugin_feature_get_name (feature));
1217 } else if (feature) {
1218 n_print (" %s (%s)\n", gst_object_get_name (GST_OBJECT (feature)),
1219 g_type_name (G_OBJECT_TYPE (feature)));
1223 features = g_list_next (features);
1226 gst_plugin_feature_list_free (origlist);
1229 n_print (" %d features:\n", num_features);
1230 if (num_elements > 0)
1231 n_print (" +-- %d elements\n", num_elements);
1232 if (num_typefinders > 0)
1233 n_print (" +-- %d typefinders\n", num_typefinders);
1234 if (num_indexes > 0)
1235 n_print (" +-- %d indexes\n", num_indexes);
1237 n_print (" +-- %d other objects\n", num_other);
1243 print_element_features (const gchar * element_name)
1245 GstPluginFeature *feature;
1247 /* FIXME implement other pretty print function for these */
1248 feature = gst_default_registry_find_feature (element_name,
1249 GST_TYPE_INDEX_FACTORY);
1251 n_print ("%s: an index\n", element_name);
1254 feature = gst_default_registry_find_feature (element_name,
1255 GST_TYPE_TYPE_FIND_FACTORY);
1257 n_print ("%s: a typefind function\n", element_name);
1265 print_element_info (GstElementFactory * factory, gboolean print_names)
1267 GstElement *element;
1271 GST_ELEMENT_FACTORY (gst_plugin_feature_load (GST_PLUGIN_FEATURE
1275 g_print ("element plugin couldn't be loaded\n");
1279 element = gst_element_factory_create (factory, NULL);
1281 g_print ("couldn't construct element for some reason\n");
1286 _name = g_strdup_printf ("%s: ", GST_OBJECT_NAME (factory));
1290 print_factory_details_info (factory);
1291 if (GST_PLUGIN_FEATURE (factory)->plugin_name) {
1294 plugin = gst_registry_find_plugin (gst_registry_get_default (),
1295 GST_PLUGIN_FEATURE (factory)->plugin_name);
1297 print_plugin_info (plugin);
1301 print_hierarchy (G_OBJECT_TYPE (element), 0, &maxlevel);
1302 print_interfaces (G_OBJECT_TYPE (element));
1304 print_pad_templates_info (element, factory);
1305 print_element_flag_info (element);
1306 print_implementation_info (element);
1307 print_clocking_info (element);
1308 print_index_info (element);
1309 print_uri_handler_info (element);
1310 print_pad_info (element);
1311 print_element_properties_info (element);
1312 print_signal_info (element);
1313 print_children_info (element);
1315 gst_object_unref (element);
1316 gst_object_unref (factory);
1324 print_plugin_automatic_install_info_codecs (GstElementFactory * factory)
1326 GstPadDirection direction;
1327 const gchar *type_name;
1329 const GList *static_templates, *l;
1330 GstCaps *caps = NULL;
1333 klass = gst_element_factory_get_klass (factory);
1334 g_return_if_fail (klass != NULL);
1336 if (strstr (klass, "Demuxer") ||
1337 strstr (klass, "Decoder") ||
1338 strstr (klass, "Depay") || strstr (klass, "Parser")) {
1339 type_name = "decoder";
1340 direction = GST_PAD_SINK;
1341 } else if (strstr (klass, "Muxer") ||
1342 strstr (klass, "Encoder") || strstr (klass, "Pay")) {
1343 type_name = "encoder";
1344 direction = GST_PAD_SRC;
1349 /* decoder/demuxer sink pads should always be static and there should only
1350 * be one, the same applies to encoders/muxers and source pads */
1351 static_templates = gst_element_factory_get_static_pad_templates (factory);
1352 for (l = static_templates; l != NULL; l = l->next) {
1353 GstStaticPadTemplate *tmpl = NULL;
1355 tmpl = (GstStaticPadTemplate *) l->data;
1356 if (tmpl->direction == direction) {
1357 caps = gst_static_pad_template_get_caps (tmpl);
1363 g_printerr ("Couldn't find static pad template for %s '%s'\n",
1364 type_name, GST_OBJECT_NAME (factory));
1368 caps = gst_caps_make_writable (caps);
1369 num = gst_caps_get_size (caps);
1370 for (i = 0; i < num; ++i) {
1374 s = gst_caps_get_structure (caps, i);
1375 /* remove fields that are almost always just MIN-MAX of some sort
1376 * in order to make the caps look less messy */
1377 gst_structure_remove_field (s, "pixel-aspect-ratio");
1378 gst_structure_remove_field (s, "framerate");
1379 gst_structure_remove_field (s, "channels");
1380 gst_structure_remove_field (s, "width");
1381 gst_structure_remove_field (s, "height");
1382 gst_structure_remove_field (s, "rate");
1383 gst_structure_remove_field (s, "depth");
1384 gst_structure_remove_field (s, "clock-rate");
1385 s_str = gst_structure_to_string (s);
1386 g_print ("%s-%s\n", type_name, s_str);
1389 gst_caps_unref (caps);
1393 print_plugin_automatic_install_info_protocols (GstElementFactory * factory)
1395 gchar **protocols, **p;
1397 protocols = gst_element_factory_get_uri_protocols (factory);
1398 if (protocols != NULL && *protocols != NULL) {
1399 switch (gst_element_factory_get_uri_type (factory)) {
1401 for (p = protocols; *p != NULL; ++p)
1402 g_print ("urisink-%s\n", *p);
1405 for (p = protocols; *p != NULL; ++p)
1406 g_print ("urisource-%s\n", *p);
1411 g_strfreev (protocols);
1416 print_plugin_automatic_install_info (GstPlugin * plugin)
1418 const gchar *plugin_name;
1419 GList *features, *l;
1421 plugin_name = gst_plugin_get_name (plugin);
1423 /* not interested in typefind factories, only element factories */
1424 features = gst_registry_get_feature_list (gst_registry_get_default (),
1425 GST_TYPE_ELEMENT_FACTORY);
1427 for (l = features; l != NULL; l = l->next) {
1428 GstPluginFeature *feature;
1430 feature = GST_PLUGIN_FEATURE (l->data);
1432 /* only interested in the ones that are in the plugin we just loaded */
1433 if (g_str_equal (plugin_name, feature->plugin_name)) {
1434 GstElementFactory *factory;
1436 g_print ("element-%s\n", gst_plugin_feature_get_name (feature));
1438 factory = GST_ELEMENT_FACTORY (feature);
1439 print_plugin_automatic_install_info_protocols (factory);
1440 print_plugin_automatic_install_info_codecs (factory);
1444 g_list_foreach (features, (GFunc) gst_object_unref, NULL);
1445 g_list_free (features);
1449 print_all_plugin_automatic_install_info (void)
1451 GList *plugins, *orig_plugins;
1453 orig_plugins = plugins = gst_default_registry_get_plugin_list ();
1457 plugin = (GstPlugin *) (plugins->data);
1458 plugins = g_list_next (plugins);
1460 print_plugin_automatic_install_info (plugin);
1462 gst_plugin_list_free (orig_plugins);
1466 main (int argc, char *argv[])
1468 gboolean print_all = FALSE;
1469 gboolean do_print_blacklist = FALSE;
1470 gboolean plugin_name = FALSE;
1471 gboolean print_aii = FALSE;
1472 gboolean uri_handlers = FALSE;
1473 #ifndef GST_DISABLE_OPTION_PARSING
1474 GOptionEntry options[] = {
1475 {"print-all", 'a', 0, G_OPTION_ARG_NONE, &print_all,
1476 N_("Print all elements"), NULL},
1477 {"print-blacklist", 'b', 0, G_OPTION_ARG_NONE, &do_print_blacklist,
1478 N_("Print list of blacklisted files"), NULL},
1479 {"print-plugin-auto-install-info", '\0', 0, G_OPTION_ARG_NONE, &print_aii,
1480 N_("Print a machine-parsable list of features the specified plugin "
1481 "or all plugins provide.\n "
1482 "Useful in connection with external automatic plugin "
1483 "installation mechanisms"), NULL},
1484 {"plugin", '\0', 0, G_OPTION_ARG_NONE, &plugin_name,
1485 N_("List the plugin contents"), NULL},
1486 {"uri-handlers", 'u', 0, G_OPTION_ARG_NONE, &uri_handlers,
1488 ("Print supported URI schemes, with the elements that implement them"),
1490 GST_TOOLS_GOPTION_VERSION,
1493 GOptionContext *ctx;
1498 bindtextdomain (GETTEXT_PACKAGE, LOCALEDIR);
1499 bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
1500 textdomain (GETTEXT_PACKAGE);
1503 g_thread_init (NULL);
1505 gst_tools_set_prgname ("gst-inspect");
1507 #ifndef GST_DISABLE_OPTION_PARSING
1508 ctx = g_option_context_new ("[ELEMENT-NAME | PLUGIN-NAME]");
1509 g_option_context_add_main_entries (ctx, options, GETTEXT_PACKAGE);
1510 g_option_context_add_group (ctx, gst_init_get_option_group ());
1511 if (!g_option_context_parse (ctx, &argc, &argv, &err)) {
1512 g_print ("Error initializing: %s\n", err->message);
1515 g_option_context_free (ctx);
1517 gst_init (&argc, &argv);
1520 gst_tools_print_version ("gst-inspect");
1522 if (print_all && argc > 1) {
1523 g_print ("-a requires no extra arguments\n");
1527 if (uri_handlers && argc > 1) {
1528 g_print ("-u requires no extra arguments\n");
1532 /* if no arguments, print out list of elements */
1534 print_all_uri_handlers ();
1535 } else if (argc == 1 || print_all) {
1536 if (do_print_blacklist)
1540 print_all_plugin_automatic_install_info ();
1542 print_element_list (print_all);
1545 /* else we try to get a factory */
1546 GstElementFactory *factory;
1548 const char *arg = argv[argc - 1];
1552 factory = gst_element_factory_find (arg);
1554 /* if there's a factory, print out the info */
1556 retval = print_element_info (factory, print_all);
1557 gst_object_unref (factory);
1559 retval = print_element_features (arg);
1565 /* otherwise check if it's a plugin */
1567 plugin = gst_default_registry_find_plugin (arg);
1569 /* if there is such a plugin, print out info */
1572 print_plugin_automatic_install_info (plugin);
1574 print_plugin_info (plugin);
1575 print_plugin_features (plugin);
1578 GError *error = NULL;
1580 if (g_file_test (arg, G_FILE_TEST_EXISTS)) {
1581 plugin = gst_plugin_load_file (arg, &error);
1585 print_plugin_automatic_install_info (plugin);
1587 print_plugin_info (plugin);
1588 print_plugin_features (plugin);
1591 g_print (_("Could not load plugin file: %s\n"), error->message);
1592 g_error_free (error);
1596 g_print (_("No such element or plugin '%s'\n"), arg);