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 (param->flags & G_PARAM_WRITABLE) {
336 g_print ("%s%s", (first_flag) ? "" : ", ", _("writable"));
339 if (param->flags & GST_PARAM_CONTROLLABLE) {
340 g_print (", %s", _("controllable"));
343 if (param->flags & GST_PARAM_MUTABLE_PLAYING) {
344 g_print (", %s", _("changeable in NULL, READY, PAUSED or PLAYING state"));
345 } else if (param->flags & GST_PARAM_MUTABLE_PAUSED) {
346 g_print (", %s", _("changeable only in NULL, READY or PAUSED state"));
347 } else if (param->flags & GST_PARAM_MUTABLE_READY) {
348 g_print (", %s", _("changeable only in NULL or READY state"));
350 if (param->flags & ~KNOWN_PARAM_FLAGS) {
351 g_print ("%s0x%0x", (first_flag) ? "" : ", ",
352 param->flags & ~KNOWN_PARAM_FLAGS);
356 switch (G_VALUE_TYPE (&value)) {
359 GParamSpecString *pstring = G_PARAM_SPEC_STRING (param);
361 n_print ("%-23.23s String. ", "");
363 if (pstring->default_value == NULL)
364 g_print ("Default: null ");
366 g_print ("Default: \"%s\" ", pstring->default_value);
369 const char *string_val = g_value_get_string (&value);
371 if (string_val == NULL)
372 g_print ("Current: null");
374 g_print ("Current: \"%s\"", string_val);
380 GParamSpecBoolean *pboolean = G_PARAM_SPEC_BOOLEAN (param);
382 n_print ("%-23.23s Boolean. ", "");
383 g_print ("Default: %s ", (pboolean->default_value ? "true" : "false"));
385 g_print ("Current: %s",
386 (g_value_get_boolean (&value) ? "true" : "false"));
391 GParamSpecULong *pulong = G_PARAM_SPEC_ULONG (param);
393 n_print ("%-23.23s Unsigned Long. ", "");
394 g_print ("Range: %lu - %lu Default: %lu ",
395 pulong->minimum, pulong->maximum, pulong->default_value);
397 g_print ("Current: %lu", g_value_get_ulong (&value));
402 GParamSpecLong *plong = G_PARAM_SPEC_LONG (param);
404 n_print ("%-23.23s Long. ", "");
405 g_print ("Range: %ld - %ld Default: %ld ",
406 plong->minimum, plong->maximum, plong->default_value);
408 g_print ("Current: %ld", g_value_get_long (&value));
413 GParamSpecUInt *puint = G_PARAM_SPEC_UINT (param);
415 n_print ("%-23.23s Unsigned Integer. ", "");
416 g_print ("Range: %u - %u Default: %u ",
417 puint->minimum, puint->maximum, puint->default_value);
419 g_print ("Current: %u", g_value_get_uint (&value));
424 GParamSpecInt *pint = G_PARAM_SPEC_INT (param);
426 n_print ("%-23.23s Integer. ", "");
427 g_print ("Range: %d - %d Default: %d ",
428 pint->minimum, pint->maximum, pint->default_value);
430 g_print ("Current: %d", g_value_get_int (&value));
435 GParamSpecUInt64 *puint64 = G_PARAM_SPEC_UINT64 (param);
437 n_print ("%-23.23s Unsigned Integer64. ", "");
438 g_print ("Range: %" G_GUINT64_FORMAT " - %" G_GUINT64_FORMAT
439 " Default: %" G_GUINT64_FORMAT " ",
440 puint64->minimum, puint64->maximum, puint64->default_value);
442 g_print ("Current: %" G_GUINT64_FORMAT, g_value_get_uint64 (&value));
447 GParamSpecInt64 *pint64 = G_PARAM_SPEC_INT64 (param);
449 n_print ("%-23.23s Integer64. ", "");
450 g_print ("Range: %" G_GINT64_FORMAT " - %" G_GINT64_FORMAT
451 " Default: %" G_GINT64_FORMAT " ",
452 pint64->minimum, pint64->maximum, pint64->default_value);
454 g_print ("Current: %" G_GINT64_FORMAT, g_value_get_int64 (&value));
459 GParamSpecFloat *pfloat = G_PARAM_SPEC_FLOAT (param);
461 n_print ("%-23.23s Float. ", "");
462 g_print ("Range: %15.7g - %15.7g Default: %15.7g ",
463 pfloat->minimum, pfloat->maximum, pfloat->default_value);
465 g_print ("Current: %15.7g", g_value_get_float (&value));
470 GParamSpecDouble *pdouble = G_PARAM_SPEC_DOUBLE (param);
472 n_print ("%-23.23s Double. ", "");
473 g_print ("Range: %15.7g - %15.7g Default: %15.7g ",
474 pdouble->minimum, pdouble->maximum, pdouble->default_value);
476 g_print ("Current: %15.7g", g_value_get_double (&value));
480 if (param->value_type == GST_TYPE_CAPS) {
481 const GstCaps *caps = gst_value_get_caps (&value);
484 n_print ("%-23.23s Caps (NULL)", "");
486 print_caps (caps, " ");
488 } else if (G_IS_PARAM_SPEC_ENUM (param)) {
489 GParamSpecEnum *penum = G_PARAM_SPEC_ENUM (param);
493 const gchar *def_val_nick = "", *cur_val_nick = "";
495 values = G_ENUM_CLASS (g_type_class_ref (param->value_type))->values;
496 enum_value = g_value_get_enum (&value);
498 while (values[j].value_name) {
499 if (values[j].value == enum_value)
500 cur_val_nick = values[j].value_nick;
501 if (values[j].value == penum->default_value)
502 def_val_nick = values[j].value_nick;
507 ("%-23.23s Enum \"%s\" Default: %d, \"%s\" Current: %d, \"%s\"",
508 "", g_type_name (G_VALUE_TYPE (&value)), penum->default_value,
509 def_val_nick, enum_value, cur_val_nick);
512 while (values[j].value_name) {
515 g_print ("%s", _name);
516 g_print ("%-23.23s (%d): %-16s - %s", "",
517 values[j].value, values[j].value_nick, values[j].value_name);
520 /* g_type_class_unref (ec); */
521 } else if (G_IS_PARAM_SPEC_FLAGS (param)) {
522 GParamSpecFlags *pflags = G_PARAM_SPEC_FLAGS (param);
526 vals = pflags->flags_class->values;
528 cur = flags_to_string (vals, g_value_get_flags (&value));
529 def = flags_to_string (vals, pflags->default_value);
532 ("%-23.23s Flags \"%s\" Default: 0x%08x, \"%s\" Current: 0x%08x, \"%s\"",
533 "", g_type_name (G_VALUE_TYPE (&value)), pflags->default_value,
534 def, g_value_get_flags (&value), cur);
536 while (vals[0].value_name) {
539 g_print ("%s", _name);
540 g_print ("%-23.23s (0x%08x): %-16s - %s", "",
541 vals[0].value, vals[0].value_nick, vals[0].value_name);
547 } else if (G_IS_PARAM_SPEC_OBJECT (param)) {
548 n_print ("%-23.23s Object of type \"%s\"", "",
549 g_type_name (param->value_type));
550 } else if (G_IS_PARAM_SPEC_BOXED (param)) {
551 n_print ("%-23.23s Boxed pointer of type \"%s\"", "",
552 g_type_name (param->value_type));
553 } else if (G_IS_PARAM_SPEC_POINTER (param)) {
554 if (param->value_type != G_TYPE_POINTER) {
555 n_print ("%-23.23s Pointer of type \"%s\".", "",
556 g_type_name (param->value_type));
558 n_print ("%-23.23s Pointer.", "");
560 } else if (param->value_type == G_TYPE_VALUE_ARRAY) {
561 GParamSpecValueArray *pvarray = G_PARAM_SPEC_VALUE_ARRAY (param);
563 if (pvarray->element_spec) {
564 n_print ("%-23.23s Array of GValues of type \"%s\"", "",
565 g_type_name (pvarray->element_spec->value_type));
567 n_print ("%-23.23s Array of GValues", "");
569 } else if (GST_IS_PARAM_SPEC_FRACTION (param)) {
570 GstParamSpecFraction *pfraction = GST_PARAM_SPEC_FRACTION (param);
572 n_print ("%-23.23s Fraction. ", "");
574 g_print ("Range: %d/%d - %d/%d Default: %d/%d ",
575 pfraction->min_num, pfraction->min_den,
576 pfraction->max_num, pfraction->max_den,
577 pfraction->def_num, pfraction->def_den);
579 g_print ("Current: %d/%d",
580 gst_value_get_fraction_numerator (&value),
581 gst_value_get_fraction_denominator (&value));
584 n_print ("%-23.23s Unknown type %ld \"%s\"", "", param->value_type,
585 g_type_name (param->value_type));
590 g_print (" Write only\n");
594 g_value_reset (&value);
596 if (num_properties == 0)
599 g_free (property_specs);
603 print_pad_templates_info (GstElement * element, GstElementFactory * factory)
605 GstElementClass *gstelement_class;
607 GstStaticPadTemplate *padtemplate;
609 n_print ("Pad Templates:\n");
610 if (!factory->numpadtemplates) {
615 gstelement_class = GST_ELEMENT_CLASS (G_OBJECT_GET_CLASS (element));
617 pads = factory->staticpadtemplates;
619 padtemplate = (GstStaticPadTemplate *) (pads->data);
620 pads = g_list_next (pads);
622 if (padtemplate->direction == GST_PAD_SRC)
623 n_print (" SRC template: '%s'\n", padtemplate->name_template);
624 else if (padtemplate->direction == GST_PAD_SINK)
625 n_print (" SINK template: '%s'\n", padtemplate->name_template);
627 n_print (" UNKNOWN!!! template: '%s'\n", padtemplate->name_template);
629 if (padtemplate->presence == GST_PAD_ALWAYS)
630 n_print (" Availability: Always\n");
631 else if (padtemplate->presence == GST_PAD_SOMETIMES)
632 n_print (" Availability: Sometimes\n");
633 else if (padtemplate->presence == GST_PAD_REQUEST) {
634 n_print (" Availability: On request\n");
635 n_print (" Has request_new_pad() function: %s\n",
636 GST_DEBUG_FUNCPTR_NAME (gstelement_class->request_new_pad));
638 n_print (" Availability: UNKNOWN!!!\n");
640 if (padtemplate->static_caps.string) {
641 n_print (" Capabilities:\n");
642 print_caps (gst_static_caps_get (&padtemplate->static_caps), " ");
650 print_element_flag_info (GstElement * element)
652 gboolean have_flags = FALSE;
655 n_print ("Element Flags:\n");
658 n_print (" no flags set\n");
660 if (GST_IS_BIN (element)) {
662 n_print ("Bin Flags:\n");
664 n_print (" no flags set\n");
669 print_implementation_info (GstElement * element)
671 GstElementClass *gstelement_class;
673 gstelement_class = GST_ELEMENT_CLASS (G_OBJECT_GET_CLASS (element));
676 n_print ("Element Implementation:\n");
678 n_print (" Has change_state() function: %s\n",
679 GST_DEBUG_FUNCPTR_NAME (gstelement_class->change_state));
683 print_clocking_info (GstElement * element)
685 if (!gst_element_requires_clock (element) &&
686 !(gst_element_provides_clock (element) &&
687 gst_element_get_clock (element))) {
689 n_print ("Element has no clocking capabilities.");
694 n_print ("Clocking Interaction:\n");
695 if (gst_element_requires_clock (element)) {
696 n_print (" element requires a clock\n");
699 if (gst_element_provides_clock (element)) {
702 clock = gst_element_get_clock (element);
704 n_print (" element provides a clock: %s\n", GST_OBJECT_NAME (clock));
706 n_print (" element is supposed to provide a clock but returned NULL\n");
711 print_index_info (GstElement * element)
713 if (gst_element_is_indexable (element)) {
715 n_print ("Indexing capabilities:\n");
716 n_print (" element can do indexing\n");
719 n_print ("Element has no indexing capabilities.\n");
724 print_uri_handler_info (GstElement * element)
726 if (GST_IS_URI_HANDLER (element)) {
727 const gchar *uri_type;
728 gchar **uri_protocols;
730 if (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element)) == GST_URI_SRC)
732 else if (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element)) ==
736 uri_type = "unknown";
738 uri_protocols = gst_uri_handler_get_protocols (GST_URI_HANDLER (element));
741 n_print ("URI handling capabilities:\n");
742 n_print (" Element can act as %s.\n", uri_type);
744 if (uri_protocols && *uri_protocols) {
745 n_print (" Supported URI protocols:\n");
746 for (; *uri_protocols != NULL; uri_protocols++)
747 n_print (" %s\n", *uri_protocols);
749 n_print (" No supported URI protocols\n");
752 n_print ("Element has no URI handling capabilities.\n");
757 print_pad_info (GstElement * element)
765 if (!element->numpads) {
770 pads = element->pads;
775 pad = GST_PAD (pads->data);
776 pads = g_list_next (pads);
780 name = gst_pad_get_name (pad);
781 if (gst_pad_get_direction (pad) == GST_PAD_SRC)
782 g_print (" SRC: '%s'", name);
783 else if (gst_pad_get_direction (pad) == GST_PAD_SINK)
784 g_print (" SINK: '%s'", name);
786 g_print (" UNKNOWN!!!: '%s'", name);
792 n_print (" Implementation:\n");
794 n_print (" Has chainfunc(): %s\n",
795 GST_DEBUG_FUNCPTR_NAME (pad->chainfunc));
796 if (pad->getrangefunc)
797 n_print (" Has getrangefunc(): %s\n",
798 GST_DEBUG_FUNCPTR_NAME (pad->getrangefunc));
799 if (pad->eventfunc != gst_pad_event_default)
800 n_print (" Has custom eventfunc(): %s\n",
801 GST_DEBUG_FUNCPTR_NAME (pad->eventfunc));
802 if (pad->queryfunc != gst_pad_query_default)
803 n_print (" Has custom queryfunc(): %s\n",
804 GST_DEBUG_FUNCPTR_NAME (pad->queryfunc));
806 if (pad->iterintlinkfunc != gst_pad_iterate_internal_links_default)
807 n_print (" Has custom iterintlinkfunc(): %s\n",
808 GST_DEBUG_FUNCPTR_NAME (pad->iterintlinkfunc));
810 if (pad->getcapsfunc)
811 n_print (" Has getcapsfunc(): %s\n",
812 GST_DEBUG_FUNCPTR_NAME (pad->getcapsfunc));
813 /* gst_pad_acceptcaps_default is static :/ */
814 if (pad->acceptcapsfunc)
815 n_print (" Has acceptcapsfunc(): %s\n",
816 GST_DEBUG_FUNCPTR_NAME (pad->acceptcapsfunc));
817 if (pad->fixatecapsfunc)
818 n_print (" Has fixatecapsfunc(): %s\n",
819 GST_DEBUG_FUNCPTR_NAME (pad->fixatecapsfunc));
822 if (pad->padtemplate)
823 n_print (" Pad Template: '%s'\n", pad->padtemplate->name_template);
825 caps = gst_pad_get_current_caps (pad);
827 n_print (" Capabilities:\n");
828 print_caps (caps, " ");
829 gst_caps_unref (caps);
835 has_sometimes_template (GstElement * element)
837 GstElementClass *klass = GST_ELEMENT_GET_CLASS (element);
840 for (l = klass->padtemplates; l != NULL; l = l->next) {
841 if (GST_PAD_TEMPLATE (l->data)->presence == GST_PAD_SOMETIMES)
849 print_signal_info (GstElement * element)
851 /* Signals/Actions Block */
855 GSignalQuery *query = NULL;
857 GSList *found_signals, *l;
859 for (k = 0; k < 2; k++) {
860 found_signals = NULL;
862 /* For elements that have sometimes pads, also list a few useful GstElement
863 * signals. Put these first, so element-specific ones come later. */
864 if (k == 0 && has_sometimes_template (element)) {
865 query = g_new0 (GSignalQuery, 1);
866 g_signal_query (g_signal_lookup ("pad-added", GST_TYPE_ELEMENT), query);
867 found_signals = g_slist_append (found_signals, query);
868 query = g_new0 (GSignalQuery, 1);
869 g_signal_query (g_signal_lookup ("pad-removed", GST_TYPE_ELEMENT), query);
870 found_signals = g_slist_append (found_signals, query);
871 query = g_new0 (GSignalQuery, 1);
872 g_signal_query (g_signal_lookup ("no-more-pads", GST_TYPE_ELEMENT),
874 found_signals = g_slist_append (found_signals, query);
877 for (type = G_OBJECT_TYPE (element); type; type = g_type_parent (type)) {
878 if (type == GST_TYPE_ELEMENT || type == GST_TYPE_OBJECT)
881 if (type == GST_TYPE_BIN && G_OBJECT_TYPE (element) != GST_TYPE_BIN)
884 signals = g_signal_list_ids (type, &nsignals);
885 for (i = 0; i < nsignals; i++) {
886 query = g_new0 (GSignalQuery, 1);
887 g_signal_query (signals[i], query);
889 if ((k == 0 && !(query->signal_flags & G_SIGNAL_ACTION)) ||
890 (k == 1 && (query->signal_flags & G_SIGNAL_ACTION)))
891 found_signals = g_slist_append (found_signals, query);
902 n_print ("Element Signals:\n");
904 n_print ("Element Actions:\n");
909 for (l = found_signals; l; l = l->next) {
913 query = (GSignalQuery *) l->data;
914 indent_len = strlen (query->signal_name) +
915 strlen (g_type_name (query->return_type)) + 24;
917 indent = g_new0 (gchar, indent_len + 1);
918 memset (indent, ' ', indent_len);
920 n_print (" \"%s\" : %s user_function (%s* object",
922 g_type_name (query->return_type), g_type_name (type));
924 for (j = 0; j < query->n_params; j++) {
926 g_print ("%s", _name);
927 if (G_TYPE_IS_FUNDAMENTAL (query->param_types[j])) {
928 g_print (",\n%s%s arg%d", indent,
929 g_type_name (query->param_types[j]), j);
930 } else if (G_TYPE_IS_ENUM (query->param_types[j])) {
931 g_print (",\n%s%s arg%d", indent,
932 g_type_name (query->param_types[j]), j);
934 g_print (",\n%s%s* arg%d", indent,
935 g_type_name (query->param_types[j]), j);
941 g_print ("%s", _name);
942 g_print (",\n%sgpointer user_data);\n", indent);
950 g_slist_foreach (found_signals, (GFunc) g_free, NULL);
951 g_slist_free (found_signals);
957 print_children_info (GstElement * element)
961 if (!GST_IS_BIN (element))
964 children = (GList *) GST_BIN (element)->children;
967 g_print ("Children:\n");
971 n_print (" %s\n", GST_ELEMENT_NAME (GST_ELEMENT (children->data)));
972 children = g_list_next (children);
977 print_blacklist (void)
979 GList *plugins, *cur;
982 g_print ("%s\n", _("Blacklisted files:"));
984 plugins = gst_default_registry_get_plugin_list ();
985 for (cur = plugins; cur != NULL; cur = g_list_next (cur)) {
986 GstPlugin *plugin = (GstPlugin *) (cur->data);
987 if (plugin->flags & GST_PLUGIN_FLAG_BLACKLISTED) {
988 g_print (" %s\n", plugin->desc.name);
994 g_print (_("Total count: "));
995 g_print (ngettext ("%d blacklisted file", "%d blacklisted files", count),
998 gst_plugin_list_free (plugins);
1002 print_element_list (gboolean print_all)
1004 int plugincount = 0, featurecount = 0, blacklistcount = 0;
1005 GList *plugins, *orig_plugins;
1007 orig_plugins = plugins = gst_default_registry_get_plugin_list ();
1009 GList *features, *orig_features;
1012 plugin = (GstPlugin *) (plugins->data);
1013 plugins = g_list_next (plugins);
1016 if (plugin->flags & GST_PLUGIN_FLAG_BLACKLISTED) {
1021 orig_features = features =
1022 gst_registry_get_feature_list_by_plugin (gst_registry_get_default (),
1025 GstPluginFeature *feature;
1027 if (G_UNLIKELY (features->data == NULL))
1029 feature = GST_PLUGIN_FEATURE (features->data);
1032 if (GST_IS_ELEMENT_FACTORY (feature)) {
1033 GstElementFactory *factory;
1035 factory = GST_ELEMENT_FACTORY (feature);
1037 print_element_info (factory, TRUE);
1039 g_print ("%s: %s: %s\n", plugin->desc.name,
1040 GST_OBJECT_NAME (factory),
1041 gst_element_factory_get_longname (factory));
1042 } else if (GST_IS_INDEX_FACTORY (feature)) {
1043 GstIndexFactory *factory;
1045 factory = GST_INDEX_FACTORY (feature);
1047 g_print ("%s: %s: %s\n", plugin->desc.name,
1048 GST_OBJECT_NAME (factory), factory->longdesc);
1049 } else if (GST_IS_TYPE_FIND_FACTORY (feature)) {
1050 GstTypeFindFactory *factory;
1052 factory = GST_TYPE_FIND_FACTORY (feature);
1054 g_print ("%s: %s: ", plugin->desc.name,
1055 gst_plugin_feature_get_name (feature));
1056 if (factory->extensions) {
1059 while (factory->extensions[i]) {
1061 g_print ("%s%s", i > 0 ? ", " : "", factory->extensions[i]);
1068 g_print ("no extensions\n");
1072 n_print ("%s: %s (%s)\n", plugin->desc.name,
1073 GST_OBJECT_NAME (feature), g_type_name (G_OBJECT_TYPE (feature)));
1077 features = g_list_next (features);
1080 gst_plugin_feature_list_free (orig_features);
1083 gst_plugin_list_free (orig_plugins);
1086 g_print (_("Total count: "));
1087 g_print (ngettext ("%d plugin", "%d plugins", plugincount), plugincount);
1088 if (blacklistcount) {
1090 g_print (ngettext ("%d blacklist entry", "%d blacklist entries",
1091 blacklistcount), blacklistcount);
1092 g_print (" not shown)");
1095 g_print (ngettext ("%d feature", "%d features", featurecount), featurecount);
1100 print_all_uri_handlers (void)
1102 GList *plugins, *p, *features, *f;
1104 plugins = gst_default_registry_get_plugin_list ();
1106 for (p = plugins; p; p = p->next) {
1107 GstPlugin *plugin = (GstPlugin *) (p->data);
1110 gst_registry_get_feature_list_by_plugin (gst_registry_get_default (),
1113 for (f = features; f; f = f->next) {
1114 GstPluginFeature *feature = GST_PLUGIN_FEATURE (f->data);
1116 if (GST_IS_ELEMENT_FACTORY (feature)) {
1117 GstElementFactory *factory;
1118 GstElement *element;
1120 factory = GST_ELEMENT_FACTORY (gst_plugin_feature_load (feature));
1122 g_print ("element plugin %s couldn't be loaded\n", plugin->desc.name);
1126 element = gst_element_factory_create (factory, NULL);
1128 g_print ("couldn't construct element for %s for some reason\n",
1129 GST_OBJECT_NAME (factory));
1130 gst_object_unref (factory);
1134 if (GST_IS_URI_HANDLER (element)) {
1136 gchar **uri_protocols, *joined;
1138 switch (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element))) {
1151 gst_uri_handler_get_protocols (GST_URI_HANDLER (element));
1152 joined = g_strjoinv (", ", uri_protocols);
1154 g_print ("%s (%s, rank %u): %s\n",
1155 gst_plugin_feature_get_name (GST_PLUGIN_FEATURE (factory)), dir,
1156 gst_plugin_feature_get_rank (GST_PLUGIN_FEATURE (factory)),
1162 gst_object_unref (element);
1163 gst_object_unref (factory);
1167 gst_plugin_feature_list_free (features);
1170 gst_plugin_list_free (plugins);
1174 print_plugin_info (GstPlugin * plugin)
1176 n_print ("Plugin Details:\n");
1177 n_print (" Name:\t\t\t%s\n", plugin->desc.name);
1178 n_print (" Description:\t\t%s\n", plugin->desc.description);
1179 n_print (" Filename:\t\t%s\n",
1180 plugin->filename ? plugin->filename : "(null)");
1181 n_print (" Version:\t\t%s\n", plugin->desc.version);
1182 n_print (" License:\t\t%s\n", plugin->desc.license);
1183 n_print (" Source module:\t%s\n", plugin->desc.source);
1184 if (plugin->desc.release_datetime != NULL) {
1185 const gchar *tz = "(UTC)";
1188 /* may be: YYYY-MM-DD or YYYY-MM-DDTHH:MMZ */
1189 /* YYYY-MM-DDTHH:MMZ => YYYY-MM-DD HH:MM (UTC) */
1190 str = g_strdup (plugin->desc.release_datetime);
1191 sep = strstr (str, "T");
1194 sep = strstr (sep + 1, "Z");
1200 n_print (" Source release date:\t%s%s\n", str, tz);
1203 n_print (" Binary package:\t%s\n", plugin->desc.package);
1204 n_print (" Origin URL:\t\t%s\n", plugin->desc.origin);
1209 print_plugin_features (GstPlugin * plugin)
1211 GList *features, *origlist;
1212 gint num_features = 0;
1213 gint num_elements = 0;
1214 gint num_typefinders = 0;
1215 gint num_indexes = 0;
1218 origlist = features =
1219 gst_registry_get_feature_list_by_plugin (gst_registry_get_default (),
1223 GstPluginFeature *feature;
1225 feature = GST_PLUGIN_FEATURE (features->data);
1227 if (GST_IS_ELEMENT_FACTORY (feature)) {
1228 GstElementFactory *factory;
1230 factory = GST_ELEMENT_FACTORY (feature);
1231 n_print (" %s: %s\n", GST_OBJECT_NAME (factory),
1232 gst_element_factory_get_longname (factory));
1234 } else if (GST_IS_INDEX_FACTORY (feature)) {
1235 GstIndexFactory *factory;
1237 factory = GST_INDEX_FACTORY (feature);
1238 n_print (" %s: %s\n", GST_OBJECT_NAME (factory), factory->longdesc);
1240 } else if (GST_IS_TYPE_FIND_FACTORY (feature)) {
1241 GstTypeFindFactory *factory;
1243 factory = GST_TYPE_FIND_FACTORY (feature);
1244 if (factory->extensions) {
1247 g_print ("%s: %s: ", plugin->desc.name,
1248 gst_plugin_feature_get_name (feature));
1249 while (factory->extensions[i]) {
1250 g_print ("%s%s", i > 0 ? ", " : "", factory->extensions[i]);
1255 g_print ("%s: %s: no extensions\n", plugin->desc.name,
1256 gst_plugin_feature_get_name (feature));
1259 } else if (feature) {
1260 n_print (" %s (%s)\n", gst_object_get_name (GST_OBJECT (feature)),
1261 g_type_name (G_OBJECT_TYPE (feature)));
1265 features = g_list_next (features);
1268 gst_plugin_feature_list_free (origlist);
1271 n_print (" %d features:\n", num_features);
1272 if (num_elements > 0)
1273 n_print (" +-- %d elements\n", num_elements);
1274 if (num_typefinders > 0)
1275 n_print (" +-- %d typefinders\n", num_typefinders);
1276 if (num_indexes > 0)
1277 n_print (" +-- %d indexes\n", num_indexes);
1279 n_print (" +-- %d other objects\n", num_other);
1285 print_element_features (const gchar * element_name)
1287 GstPluginFeature *feature;
1289 /* FIXME implement other pretty print function for these */
1290 feature = gst_default_registry_find_feature (element_name,
1291 GST_TYPE_INDEX_FACTORY);
1293 n_print ("%s: an index\n", element_name);
1296 feature = gst_default_registry_find_feature (element_name,
1297 GST_TYPE_TYPE_FIND_FACTORY);
1299 n_print ("%s: a typefind function\n", element_name);
1307 print_element_info (GstElementFactory * factory, gboolean print_names)
1309 GstElement *element;
1313 GST_ELEMENT_FACTORY (gst_plugin_feature_load (GST_PLUGIN_FEATURE
1317 g_print ("element plugin couldn't be loaded\n");
1321 element = gst_element_factory_create (factory, NULL);
1323 g_print ("couldn't construct element for some reason\n");
1328 _name = g_strdup_printf ("%s: ", GST_OBJECT_NAME (factory));
1332 print_factory_details_info (factory);
1333 if (GST_PLUGIN_FEATURE (factory)->plugin_name) {
1336 plugin = gst_registry_find_plugin (gst_registry_get_default (),
1337 GST_PLUGIN_FEATURE (factory)->plugin_name);
1339 print_plugin_info (plugin);
1343 print_hierarchy (G_OBJECT_TYPE (element), 0, &maxlevel);
1344 print_interfaces (G_OBJECT_TYPE (element));
1346 print_pad_templates_info (element, factory);
1347 print_element_flag_info (element);
1348 print_implementation_info (element);
1349 print_clocking_info (element);
1350 print_index_info (element);
1351 print_uri_handler_info (element);
1352 print_pad_info (element);
1353 print_element_properties_info (element);
1354 print_signal_info (element);
1355 print_children_info (element);
1357 gst_object_unref (element);
1358 gst_object_unref (factory);
1366 print_plugin_automatic_install_info_codecs (GstElementFactory * factory)
1368 GstPadDirection direction;
1369 const gchar *type_name;
1371 const GList *static_templates, *l;
1372 GstCaps *caps = NULL;
1375 klass = gst_element_factory_get_klass (factory);
1376 g_return_if_fail (klass != NULL);
1378 if (strstr (klass, "Demuxer") ||
1379 strstr (klass, "Decoder") ||
1380 strstr (klass, "Depay") || strstr (klass, "Parser")) {
1381 type_name = "decoder";
1382 direction = GST_PAD_SINK;
1383 } else if (strstr (klass, "Muxer") ||
1384 strstr (klass, "Encoder") || strstr (klass, "Pay")) {
1385 type_name = "encoder";
1386 direction = GST_PAD_SRC;
1391 /* decoder/demuxer sink pads should always be static and there should only
1392 * be one, the same applies to encoders/muxers and source pads */
1393 static_templates = gst_element_factory_get_static_pad_templates (factory);
1394 for (l = static_templates; l != NULL; l = l->next) {
1395 GstStaticPadTemplate *tmpl = NULL;
1397 tmpl = (GstStaticPadTemplate *) l->data;
1398 if (tmpl->direction == direction) {
1399 caps = gst_static_pad_template_get_caps (tmpl);
1405 g_printerr ("Couldn't find static pad template for %s '%s'\n",
1406 type_name, GST_OBJECT_NAME (factory));
1410 caps = gst_caps_make_writable (caps);
1411 num = gst_caps_get_size (caps);
1412 for (i = 0; i < num; ++i) {
1416 s = gst_caps_get_structure (caps, i);
1417 /* remove fields that are almost always just MIN-MAX of some sort
1418 * in order to make the caps look less messy */
1419 gst_structure_remove_field (s, "pixel-aspect-ratio");
1420 gst_structure_remove_field (s, "framerate");
1421 gst_structure_remove_field (s, "channels");
1422 gst_structure_remove_field (s, "width");
1423 gst_structure_remove_field (s, "height");
1424 gst_structure_remove_field (s, "rate");
1425 gst_structure_remove_field (s, "depth");
1426 gst_structure_remove_field (s, "clock-rate");
1427 s_str = gst_structure_to_string (s);
1428 g_print ("%s-%s\n", type_name, s_str);
1431 gst_caps_unref (caps);
1435 print_plugin_automatic_install_info_protocols (GstElementFactory * factory)
1437 gchar **protocols, **p;
1439 protocols = gst_element_factory_get_uri_protocols (factory);
1440 if (protocols != NULL && *protocols != NULL) {
1441 switch (gst_element_factory_get_uri_type (factory)) {
1443 for (p = protocols; *p != NULL; ++p)
1444 g_print ("urisink-%s\n", *p);
1447 for (p = protocols; *p != NULL; ++p)
1448 g_print ("urisource-%s\n", *p);
1453 g_strfreev (protocols);
1458 print_plugin_automatic_install_info (GstPlugin * plugin)
1460 const gchar *plugin_name;
1461 GList *features, *l;
1463 plugin_name = gst_plugin_get_name (plugin);
1465 /* not interested in typefind factories, only element factories */
1466 features = gst_registry_get_feature_list (gst_registry_get_default (),
1467 GST_TYPE_ELEMENT_FACTORY);
1469 for (l = features; l != NULL; l = l->next) {
1470 GstPluginFeature *feature;
1472 feature = GST_PLUGIN_FEATURE (l->data);
1474 /* only interested in the ones that are in the plugin we just loaded */
1475 if (g_str_equal (plugin_name, feature->plugin_name)) {
1476 GstElementFactory *factory;
1478 g_print ("element-%s\n", gst_plugin_feature_get_name (feature));
1480 factory = GST_ELEMENT_FACTORY (feature);
1481 print_plugin_automatic_install_info_protocols (factory);
1482 print_plugin_automatic_install_info_codecs (factory);
1486 g_list_foreach (features, (GFunc) gst_object_unref, NULL);
1487 g_list_free (features);
1491 print_all_plugin_automatic_install_info (void)
1493 GList *plugins, *orig_plugins;
1495 orig_plugins = plugins = gst_default_registry_get_plugin_list ();
1499 plugin = (GstPlugin *) (plugins->data);
1500 plugins = g_list_next (plugins);
1502 print_plugin_automatic_install_info (plugin);
1504 gst_plugin_list_free (orig_plugins);
1508 main (int argc, char *argv[])
1510 gboolean print_all = FALSE;
1511 gboolean do_print_blacklist = FALSE;
1512 gboolean plugin_name = FALSE;
1513 gboolean print_aii = FALSE;
1514 gboolean uri_handlers = FALSE;
1515 #ifndef GST_DISABLE_OPTION_PARSING
1516 GOptionEntry options[] = {
1517 {"print-all", 'a', 0, G_OPTION_ARG_NONE, &print_all,
1518 N_("Print all elements"), NULL},
1519 {"print-blacklist", 'b', 0, G_OPTION_ARG_NONE, &do_print_blacklist,
1520 N_("Print list of blacklisted files"), NULL},
1521 {"print-plugin-auto-install-info", '\0', 0, G_OPTION_ARG_NONE, &print_aii,
1522 N_("Print a machine-parsable list of features the specified plugin "
1523 "or all plugins provide.\n "
1524 "Useful in connection with external automatic plugin "
1525 "installation mechanisms"), NULL},
1526 {"plugin", '\0', 0, G_OPTION_ARG_NONE, &plugin_name,
1527 N_("List the plugin contents"), NULL},
1528 {"uri-handlers", 'u', 0, G_OPTION_ARG_NONE, &uri_handlers,
1530 ("Print supported URI schemes, with the elements that implement them"),
1532 GST_TOOLS_GOPTION_VERSION,
1535 GOptionContext *ctx;
1540 bindtextdomain (GETTEXT_PACKAGE, LOCALEDIR);
1541 bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
1542 textdomain (GETTEXT_PACKAGE);
1545 g_thread_init (NULL);
1547 gst_tools_set_prgname ("gst-inspect");
1549 #ifndef GST_DISABLE_OPTION_PARSING
1550 ctx = g_option_context_new ("[ELEMENT-NAME | PLUGIN-NAME]");
1551 g_option_context_add_main_entries (ctx, options, GETTEXT_PACKAGE);
1552 g_option_context_add_group (ctx, gst_init_get_option_group ());
1553 if (!g_option_context_parse (ctx, &argc, &argv, &err)) {
1554 g_print ("Error initializing: %s\n", err->message);
1557 g_option_context_free (ctx);
1559 gst_init (&argc, &argv);
1562 gst_tools_print_version ("gst-inspect");
1564 if (print_all && argc > 1) {
1565 g_print ("-a requires no extra arguments\n");
1569 if (uri_handlers && argc > 1) {
1570 g_print ("-u requires no extra arguments\n");
1574 /* if no arguments, print out list of elements */
1576 print_all_uri_handlers ();
1577 } else if (argc == 1 || print_all) {
1578 if (do_print_blacklist)
1582 print_all_plugin_automatic_install_info ();
1584 print_element_list (print_all);
1587 /* else we try to get a factory */
1588 GstElementFactory *factory;
1590 const char *arg = argv[argc - 1];
1594 factory = gst_element_factory_find (arg);
1596 /* if there's a factory, print out the info */
1598 retval = print_element_info (factory, print_all);
1599 gst_object_unref (factory);
1601 retval = print_element_features (arg);
1607 /* otherwise check if it's a plugin */
1609 plugin = gst_default_registry_find_plugin (arg);
1611 /* if there is such a plugin, print out info */
1614 print_plugin_automatic_install_info (plugin);
1616 print_plugin_info (plugin);
1617 print_plugin_features (plugin);
1620 GError *error = NULL;
1622 if (g_file_test (arg, G_FILE_TEST_EXISTS)) {
1623 plugin = gst_plugin_load_file (arg, &error);
1627 print_plugin_automatic_install_info (plugin);
1629 print_plugin_info (plugin);
1630 print_plugin_features (plugin);
1633 g_print (_("Could not load plugin file: %s\n"), error->message);
1634 g_error_free (error);
1638 g_print (_("No such element or plugin '%s'\n"), arg);