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.
28 #include <gst/controller/gstcontroller.h>
34 #include <glib/gprintf.h>
36 static char *_name = NULL;
38 static int print_element_info (GstElementFactory * factory,
39 gboolean print_names);
42 n_print (const char *format, ...)
47 g_print ("%s", _name);
49 va_start (args, format);
50 g_vprintf (format, args);
55 print_field (GQuark field, const GValue * value, gpointer pfx)
57 gchar *str = gst_value_serialize (value);
59 n_print ("%s %15s: %s\n", (gchar *) pfx, g_quark_to_string (field), str);
65 print_caps (const GstCaps * caps, const gchar * pfx)
69 g_return_if_fail (caps != NULL);
71 if (gst_caps_is_any (caps)) {
72 n_print ("%sANY\n", pfx);
75 if (gst_caps_is_empty (caps)) {
76 n_print ("%sEMPTY\n", pfx);
80 for (i = 0; i < gst_caps_get_size (caps); i++) {
81 GstStructure *structure = gst_caps_get_structure (caps, i);
83 n_print ("%s%s\n", pfx, gst_structure_get_name (structure));
84 gst_structure_foreach (structure, print_field, (gpointer) pfx);
90 print_formats (const GstFormat * formats)
92 while (formats && *formats) {
93 const GstFormatDefinition *definition;
95 definition = gst_format_get_details (*formats);
97 n_print ("\t\t(%d):\t%s (%s)\n", *formats,
98 definition->nick, definition->description);
100 n_print ("\t\t(%d):\tUnknown format\n", *formats);
108 print_query_types (const GstQueryType * types)
110 while (types && *types) {
111 const GstQueryTypeDefinition *definition;
113 definition = gst_query_type_get_details (*types);
115 n_print ("\t\t(%d):\t%s (%s)\n", *types,
116 definition->nick, definition->description);
118 n_print ("\t\t(%d):\tUnknown query format\n", *types);
126 print_event_masks (const GstEventMask * masks)
131 GFlagsClass *flags_class = NULL;
133 event_type = gst_event_type_get_type ();
134 klass = (GEnumClass *) g_type_class_ref (event_type);
136 while (masks && masks->type) {
138 gint flags = 0, index = 0;
140 switch (masks->type) {
142 flags = masks->flags;
143 event_flags = gst_seek_type_get_type ();
144 flags_class = (GFlagsClass *) g_type_class_ref (event_flags);
150 value = g_enum_get_value (klass, masks->type);
151 g_print ("\t\t%s ", value->value_nick);
157 value = g_flags_get_first_value (flags_class, 1 << index);
160 g_print ("| %s ", value->value_nick);
175 get_rank_name (char *s, gint rank)
177 static const int ranks[4] = {
178 GST_RANK_NONE, GST_RANK_MARGINAL, GST_RANK_SECONDARY, GST_RANK_PRIMARY
180 static const char *rank_names[4] = { "none", "marginal", "secondary",
187 for (i = 0; i < 4; i++) {
188 if (rank == ranks[i])
189 return rank_names[i];
190 if (abs (rank - ranks[i]) < abs (rank - ranks[best_i])) {
195 sprintf (s, "%s %c %d", rank_names[best_i],
196 (rank - ranks[best_i] > 0) ? '+' : '-', abs (ranks[best_i] - rank));
202 print_factory_details_meta_data (GQuark field_id, const GValue * value,
205 gchar *val = g_strdup_value_contents (value);
206 gchar *key = g_strdup (g_quark_to_string (field_id));
208 key[0] = g_ascii_toupper (key[0]);
209 n_print (" %s:\t\t%s\n", key, val);
216 print_factory_details_info (GstElementFactory * factory)
220 n_print ("Factory Details:\n");
221 n_print (" Long name:\t%s\n", factory->details.longname);
222 n_print (" Class:\t%s\n", factory->details.klass);
223 n_print (" Description:\t%s\n", factory->details.description);
224 n_print (" Author(s):\t%s\n", factory->details.author);
225 n_print (" Rank:\t\t%s (%d)\n",
226 get_rank_name (s, GST_PLUGIN_FEATURE (factory)->rank),
227 GST_PLUGIN_FEATURE (factory)->rank);
228 if (factory->meta_data != NULL) {
229 gst_structure_foreach ((GstStructure *) factory->meta_data,
230 print_factory_details_meta_data, NULL);
236 print_hierarchy (GType type, gint level, gint * maxlevel)
241 parent = g_type_parent (type);
243 *maxlevel = *maxlevel + 1;
247 print_hierarchy (parent, level, maxlevel);
250 g_print ("%s", _name);
252 for (i = 1; i < *maxlevel - level; i++)
254 if (*maxlevel - level)
257 g_print ("%s\n", g_type_name (type));
264 print_interfaces (GType type)
267 GType *iface, *ifaces = g_type_interfaces (type, &n_ifaces);
272 g_print ("%s", _name);
273 g_print (_("Implemented Interfaces:\n"));
277 g_print ("%s", _name);
278 g_print (" %s\n", g_type_name (*iface));
282 g_print ("%s", _name);
290 flags_to_string (GFlagsValue * vals, guint flags)
295 /* first look for an exact match and count the number of values */
296 for (i = 0; vals[i].value_name != NULL; ++i) {
297 if (vals[i].value == flags)
298 return g_strdup (vals[i].value_nick);
301 s = g_string_new (NULL);
303 /* we assume the values are sorted from lowest to highest value */
307 if (vals[i].value != 0 && (flags_left & vals[i].value) == vals[i].value) {
309 g_string_append (s, " | ");
310 g_string_append (s, vals[i].value_nick);
311 flags_left -= vals[i].value;
318 g_string_assign (s, "(none)");
320 return g_string_free (s, FALSE);
323 #define KNOWN_PARAM_FLAGS \
324 (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY | \
325 G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS | \
326 G_PARAM_READABLE | G_PARAM_WRITABLE | GST_PARAM_CONTROLLABLE | \
327 GST_PARAM_MUTABLE_PLAYING | GST_PARAM_MUTABLE_PAUSED | \
328 GST_PARAM_MUTABLE_READY)
331 print_element_properties_info (GstElement * element)
333 GParamSpec **property_specs;
334 guint num_properties, i;
338 property_specs = g_object_class_list_properties
339 (G_OBJECT_GET_CLASS (element), &num_properties);
341 n_print ("Element Properties:\n");
343 for (i = 0; i < num_properties; i++) {
344 GValue value = { 0, };
345 GParamSpec *param = property_specs[i];
349 g_value_init (&value, param->value_type);
351 n_print (" %-20s: %s\n", g_param_spec_get_name (param),
352 g_param_spec_get_blurb (param));
355 n_print ("%-23.23s flags: ", "");
356 if (param->flags & G_PARAM_READABLE) {
357 g_object_get_property (G_OBJECT (element), param->name, &value);
359 g_print ("%s%s", (first_flag) ? "" : ", ", _("readable"));
362 if (param->flags & G_PARAM_WRITABLE) {
363 g_print ("%s%s", (first_flag) ? "" : ", ", _("writable"));
366 if (param->flags & GST_PARAM_CONTROLLABLE) {
367 g_print (", %s", _("controllable"));
370 if (param->flags & GST_PARAM_MUTABLE_PLAYING) {
371 g_print (", %s", _("changeable in NULL, READY, PAUSED or PLAYING state"));
372 } else if (param->flags & GST_PARAM_MUTABLE_PAUSED) {
373 g_print (", %s", _("changeable only in NULL, READY or PAUSED state"));
374 } else if (param->flags & GST_PARAM_MUTABLE_READY) {
375 g_print (", %s", _("changeable only in NULL or READY state"));
377 if (param->flags & ~KNOWN_PARAM_FLAGS) {
378 g_print ("%s0x%0x", (first_flag) ? "" : ", ",
379 param->flags & ~KNOWN_PARAM_FLAGS);
383 switch (G_VALUE_TYPE (&value)) {
386 GParamSpecString *pstring = G_PARAM_SPEC_STRING (param);
388 n_print ("%-23.23s String. ", "");
390 if (pstring->default_value == NULL)
391 g_print ("Default: null ");
393 g_print ("Default: \"%s\" ", pstring->default_value);
396 const char *string_val = g_value_get_string (&value);
398 if (string_val == NULL)
399 g_print ("Current: null");
401 g_print ("Current: \"%s\"", string_val);
407 GParamSpecBoolean *pboolean = G_PARAM_SPEC_BOOLEAN (param);
409 n_print ("%-23.23s Boolean. ", "");
410 g_print ("Default: %s ", (pboolean->default_value ? "true" : "false"));
412 g_print ("Current: %s",
413 (g_value_get_boolean (&value) ? "true" : "false"));
418 GParamSpecULong *pulong = G_PARAM_SPEC_ULONG (param);
420 n_print ("%-23.23s Unsigned Long. ", "");
421 g_print ("Range: %lu - %lu Default: %lu ",
422 pulong->minimum, pulong->maximum, pulong->default_value);
424 g_print ("Current: %lu", g_value_get_ulong (&value));
429 GParamSpecLong *plong = G_PARAM_SPEC_LONG (param);
431 n_print ("%-23.23s Long. ", "");
432 g_print ("Range: %ld - %ld Default: %ld ",
433 plong->minimum, plong->maximum, plong->default_value);
435 g_print ("Current: %ld", g_value_get_long (&value));
440 GParamSpecUInt *puint = G_PARAM_SPEC_UINT (param);
442 n_print ("%-23.23s Unsigned Integer. ", "");
443 g_print ("Range: %u - %u Default: %u ",
444 puint->minimum, puint->maximum, puint->default_value);
446 g_print ("Current: %u", g_value_get_uint (&value));
451 GParamSpecInt *pint = G_PARAM_SPEC_INT (param);
453 n_print ("%-23.23s Integer. ", "");
454 g_print ("Range: %d - %d Default: %d ",
455 pint->minimum, pint->maximum, pint->default_value);
457 g_print ("Current: %d", g_value_get_int (&value));
462 GParamSpecUInt64 *puint64 = G_PARAM_SPEC_UINT64 (param);
464 n_print ("%-23.23s Unsigned Integer64. ", "");
465 g_print ("Range: %" G_GUINT64_FORMAT " - %" G_GUINT64_FORMAT
466 " Default: %" G_GUINT64_FORMAT " ",
467 puint64->minimum, puint64->maximum, puint64->default_value);
469 g_print ("Current: %" G_GUINT64_FORMAT, g_value_get_uint64 (&value));
474 GParamSpecInt64 *pint64 = G_PARAM_SPEC_INT64 (param);
476 n_print ("%-23.23s Integer64. ", "");
477 g_print ("Range: %" G_GINT64_FORMAT " - %" G_GINT64_FORMAT
478 " Default: %" G_GINT64_FORMAT " ",
479 pint64->minimum, pint64->maximum, pint64->default_value);
481 g_print ("Current: %" G_GINT64_FORMAT, g_value_get_int64 (&value));
486 GParamSpecFloat *pfloat = G_PARAM_SPEC_FLOAT (param);
488 n_print ("%-23.23s Float. ", "");
489 g_print ("Range: %15.7g - %15.7g Default: %15.7g ",
490 pfloat->minimum, pfloat->maximum, pfloat->default_value);
492 g_print ("Current: %15.7g", g_value_get_float (&value));
497 GParamSpecDouble *pdouble = G_PARAM_SPEC_DOUBLE (param);
499 n_print ("%-23.23s Double. ", "");
500 g_print ("Range: %15.7g - %15.7g Default: %15.7g ",
501 pdouble->minimum, pdouble->maximum, pdouble->default_value);
503 g_print ("Current: %15.7g", g_value_get_double (&value));
507 if (param->value_type == GST_TYPE_CAPS) {
508 const GstCaps *caps = gst_value_get_caps (&value);
511 n_print ("%-23.23s Caps (NULL)", "");
513 print_caps (caps, " ");
515 } else if (G_IS_PARAM_SPEC_ENUM (param)) {
516 GParamSpecEnum *penum = G_PARAM_SPEC_ENUM (param);
520 const gchar *def_val_nick = "", *cur_val_nick = "";
522 values = G_ENUM_CLASS (g_type_class_ref (param->value_type))->values;
523 enum_value = g_value_get_enum (&value);
525 while (values[j].value_name) {
526 if (values[j].value == enum_value)
527 cur_val_nick = values[j].value_nick;
528 if (values[j].value == penum->default_value)
529 def_val_nick = values[j].value_nick;
534 ("%-23.23s Enum \"%s\" Default: %d, \"%s\" Current: %d, \"%s\"",
535 "", g_type_name (G_VALUE_TYPE (&value)), penum->default_value,
536 def_val_nick, enum_value, cur_val_nick);
539 while (values[j].value_name) {
542 g_print ("%s", _name);
543 g_print ("%-23.23s (%d): %-16s - %s", "",
544 values[j].value, values[j].value_nick, values[j].value_name);
547 /* g_type_class_unref (ec); */
548 } else if (G_IS_PARAM_SPEC_FLAGS (param)) {
549 GParamSpecFlags *pflags = G_PARAM_SPEC_FLAGS (param);
553 vals = pflags->flags_class->values;
555 cur = flags_to_string (vals, g_value_get_flags (&value));
556 def = flags_to_string (vals, pflags->default_value);
559 ("%-23.23s Flags \"%s\" Default: 0x%08x, \"%s\" Current: 0x%08x, \"%s\"",
560 "", g_type_name (G_VALUE_TYPE (&value)), pflags->default_value,
561 def, g_value_get_flags (&value), cur);
563 while (vals[0].value_name) {
566 g_print ("%s", _name);
567 g_print ("%-23.23s (0x%08x): %-16s - %s", "",
568 vals[0].value, vals[0].value_nick, vals[0].value_name);
574 } else if (G_IS_PARAM_SPEC_OBJECT (param)) {
575 n_print ("%-23.23s Object of type \"%s\"", "",
576 g_type_name (param->value_type));
577 } else if (G_IS_PARAM_SPEC_BOXED (param)) {
578 n_print ("%-23.23s Boxed pointer of type \"%s\"", "",
579 g_type_name (param->value_type));
580 } else if (G_IS_PARAM_SPEC_POINTER (param)) {
581 if (param->value_type != G_TYPE_POINTER) {
582 n_print ("%-23.23s Pointer of type \"%s\".", "",
583 g_type_name (param->value_type));
585 n_print ("%-23.23s Pointer.", "");
587 } else if (param->value_type == G_TYPE_VALUE_ARRAY) {
588 GParamSpecValueArray *pvarray = G_PARAM_SPEC_VALUE_ARRAY (param);
590 if (pvarray->element_spec) {
591 n_print ("%-23.23s Array of GValues of type \"%s\"", "",
592 g_type_name (pvarray->element_spec->value_type));
594 n_print ("%-23.23s Array of GValues", "");
596 } else if (GST_IS_PARAM_SPEC_FRACTION (param)) {
597 GstParamSpecFraction *pfraction = GST_PARAM_SPEC_FRACTION (param);
599 n_print ("%-23.23s Fraction. ", "");
601 g_print ("Range: %d/%d - %d/%d Default: %d/%d ",
602 pfraction->min_num, pfraction->min_den,
603 pfraction->max_num, pfraction->max_den,
604 pfraction->def_num, pfraction->def_den);
606 g_print ("Current: %d/%d",
607 gst_value_get_fraction_numerator (&value),
608 gst_value_get_fraction_denominator (&value));
610 } else if (GST_IS_PARAM_SPEC_MINI_OBJECT (param)) {
611 n_print ("%-23.23s MiniObject of type \"%s\"", "",
612 g_type_name (param->value_type));
614 n_print ("%-23.23s Unknown type %ld \"%s\"", "", param->value_type,
615 g_type_name (param->value_type));
620 g_print (" Write only\n");
624 g_value_reset (&value);
626 if (num_properties == 0)
629 g_free (property_specs);
633 print_pad_templates_info (GstElement * element, GstElementFactory * factory)
635 GstElementClass *gstelement_class;
637 GstStaticPadTemplate *padtemplate;
639 n_print ("Pad Templates:\n");
640 if (!factory->numpadtemplates) {
645 gstelement_class = GST_ELEMENT_CLASS (G_OBJECT_GET_CLASS (element));
647 pads = factory->staticpadtemplates;
649 padtemplate = (GstStaticPadTemplate *) (pads->data);
650 pads = g_list_next (pads);
652 if (padtemplate->direction == GST_PAD_SRC)
653 n_print (" SRC template: '%s'\n", padtemplate->name_template);
654 else if (padtemplate->direction == GST_PAD_SINK)
655 n_print (" SINK template: '%s'\n", padtemplate->name_template);
657 n_print (" UNKNOWN!!! template: '%s'\n", padtemplate->name_template);
659 if (padtemplate->presence == GST_PAD_ALWAYS)
660 n_print (" Availability: Always\n");
661 else if (padtemplate->presence == GST_PAD_SOMETIMES)
662 n_print (" Availability: Sometimes\n");
663 else if (padtemplate->presence == GST_PAD_REQUEST) {
664 n_print (" Availability: On request\n");
665 n_print (" Has request_new_pad() function: %s\n",
666 GST_DEBUG_FUNCPTR_NAME (gstelement_class->request_new_pad));
668 n_print (" Availability: UNKNOWN!!!\n");
670 if (padtemplate->static_caps.string) {
671 n_print (" Capabilities:\n");
672 print_caps (gst_static_caps_get (&padtemplate->static_caps), " ");
680 print_element_flag_info (GstElement * element)
682 gboolean have_flags = FALSE;
685 n_print ("Element Flags:\n");
688 n_print (" no flags set\n");
690 if (GST_IS_BIN (element)) {
692 n_print ("Bin Flags:\n");
694 n_print (" no flags set\n");
699 print_implementation_info (GstElement * element)
701 GstObjectClass *gstobject_class;
702 GstElementClass *gstelement_class;
704 gstobject_class = GST_OBJECT_CLASS (G_OBJECT_GET_CLASS (element));
705 gstelement_class = GST_ELEMENT_CLASS (G_OBJECT_GET_CLASS (element));
708 n_print ("Element Implementation:\n");
710 n_print (" Has change_state() function: %s\n",
711 GST_DEBUG_FUNCPTR_NAME (gstelement_class->change_state));
712 #ifndef GST_DISABLE_LOADSAVE
713 n_print (" Has custom save_thyself() function: %s\n",
714 GST_DEBUG_FUNCPTR_NAME (gstobject_class->save_thyself));
715 n_print (" Has custom restore_thyself() function: %s\n",
716 GST_DEBUG_FUNCPTR_NAME (gstobject_class->restore_thyself));
721 print_clocking_info (GstElement * element)
723 if (!gst_element_requires_clock (element) &&
724 !(gst_element_provides_clock (element) &&
725 gst_element_get_clock (element))) {
727 n_print ("Element has no clocking capabilities.");
732 n_print ("Clocking Interaction:\n");
733 if (gst_element_requires_clock (element)) {
734 n_print (" element requires a clock\n");
737 if (gst_element_provides_clock (element)) {
740 clock = gst_element_get_clock (element);
742 n_print (" element provides a clock: %s\n", GST_OBJECT_NAME (clock));
744 n_print (" element is supposed to provide a clock but returned NULL\n");
749 print_index_info (GstElement * element)
751 if (gst_element_is_indexable (element)) {
753 n_print ("Indexing capabilities:\n");
754 n_print (" element can do indexing\n");
757 n_print ("Element has no indexing capabilities.\n");
762 print_uri_handler_info (GstElement * element)
764 if (GST_IS_URI_HANDLER (element)) {
765 const gchar *uri_type;
766 gchar **uri_protocols;
768 if (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element)) == GST_URI_SRC)
770 else if (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element)) ==
774 uri_type = "unknown";
776 uri_protocols = gst_uri_handler_get_protocols (GST_URI_HANDLER (element));
779 n_print ("URI handling capabilities:\n");
780 n_print (" Element can act as %s.\n", uri_type);
782 if (uri_protocols && *uri_protocols) {
783 n_print (" Supported URI protocols:\n");
784 for (; *uri_protocols != NULL; uri_protocols++)
785 n_print (" %s\n", *uri_protocols);
787 n_print (" No supported URI protocols\n");
790 n_print ("Element has no URI handling capabilities.\n");
795 print_pad_info (GstElement * element)
803 if (!element->numpads) {
808 pads = element->pads;
812 pad = GST_PAD (pads->data);
813 pads = g_list_next (pads);
817 name = gst_pad_get_name (pad);
818 if (gst_pad_get_direction (pad) == GST_PAD_SRC)
819 g_print (" SRC: '%s'", name);
820 else if (gst_pad_get_direction (pad) == GST_PAD_SINK)
821 g_print (" SINK: '%s'", name);
823 g_print (" UNKNOWN!!!: '%s'", name);
829 n_print (" Implementation:\n");
831 n_print (" Has chainfunc(): %s\n",
832 GST_DEBUG_FUNCPTR_NAME (pad->chainfunc));
833 if (pad->getrangefunc)
834 n_print (" Has getrangefunc(): %s\n",
835 GST_DEBUG_FUNCPTR_NAME (pad->getrangefunc));
836 if (pad->eventfunc != gst_pad_event_default)
837 n_print (" Has custom eventfunc(): %s\n",
838 GST_DEBUG_FUNCPTR_NAME (pad->eventfunc));
839 if (pad->queryfunc != gst_pad_query_default)
840 n_print (" Has custom queryfunc(): %s\n",
841 GST_DEBUG_FUNCPTR_NAME (pad->queryfunc));
842 if (pad->querytypefunc != gst_pad_get_query_types_default) {
843 const GstQueryType *query_types = gst_pad_get_query_types (pad);
845 n_print (" Provides query types:\n");
846 print_query_types (query_types);
850 if (pad->iterintlinkfunc != gst_pad_iterate_internal_links_default)
851 n_print (" Has custom iterintlinkfunc(): %s\n",
852 GST_DEBUG_FUNCPTR_NAME (pad->iterintlinkfunc));
854 if (pad->bufferallocfunc)
855 n_print (" Has bufferallocfunc(): %s\n",
856 GST_DEBUG_FUNCPTR_NAME (pad->bufferallocfunc));
858 if (pad->getcapsfunc)
859 n_print (" Has getcapsfunc(): %s\n",
860 GST_DEBUG_FUNCPTR_NAME (pad->getcapsfunc));
861 if (pad->setcapsfunc)
862 n_print (" Has setcapsfunc(): %s\n",
863 GST_DEBUG_FUNCPTR_NAME (pad->setcapsfunc));
864 /* gst_pad_acceptcaps_default is static :/ */
865 if (pad->acceptcapsfunc)
866 n_print (" Has acceptcapsfunc(): %s\n",
867 GST_DEBUG_FUNCPTR_NAME (pad->acceptcapsfunc));
868 if (pad->fixatecapsfunc)
869 n_print (" Has fixatecapsfunc(): %s\n",
870 GST_DEBUG_FUNCPTR_NAME (pad->fixatecapsfunc));
873 if (pad->padtemplate)
874 n_print (" Pad Template: '%s'\n", pad->padtemplate->name_template);
877 n_print (" Capabilities:\n");
878 print_caps (pad->caps, " ");
885 compare_signal_names (GSignalQuery * a, GSignalQuery * b)
887 return strcmp (a->signal_name, b->signal_name);
892 print_signal_info (GstElement * element)
894 /* Signals/Actions Block */
898 GSignalQuery *query = NULL;
900 GSList *found_signals, *l;
902 for (k = 0; k < 2; k++) {
903 found_signals = NULL;
904 for (type = G_OBJECT_TYPE (element); type; type = g_type_parent (type)) {
905 if (type == GST_TYPE_ELEMENT || type == GST_TYPE_OBJECT)
908 if (type == GST_TYPE_BIN && G_OBJECT_TYPE (element) != GST_TYPE_BIN)
911 signals = g_signal_list_ids (type, &nsignals);
912 for (i = 0; i < nsignals; i++) {
913 query = g_new0 (GSignalQuery, 1);
914 g_signal_query (signals[i], query);
916 if ((k == 0 && !(query->signal_flags & G_SIGNAL_ACTION)) ||
917 (k == 1 && (query->signal_flags & G_SIGNAL_ACTION)))
918 found_signals = g_slist_append (found_signals, query);
929 n_print ("Element Signals:\n");
931 n_print ("Element Actions:\n");
936 for (l = found_signals; l; l = l->next) {
940 query = (GSignalQuery *) l->data;
941 indent_len = strlen (query->signal_name) +
942 strlen (g_type_name (query->return_type)) + 24;
944 indent = g_new0 (gchar, indent_len + 1);
945 memset (indent, ' ', indent_len);
947 n_print (" \"%s\" : %s user_function (%s* object",
949 g_type_name (query->return_type), g_type_name (type));
951 for (j = 0; j < query->n_params; j++) {
953 g_print ("%s", _name);
954 if (G_TYPE_IS_FUNDAMENTAL (query->param_types[j])) {
955 g_print (",\n%s%s arg%d", indent,
956 g_type_name (query->param_types[j]), j);
957 } else if (G_TYPE_IS_ENUM (query->param_types[j])) {
958 g_print (",\n%s%s arg%d", indent,
959 g_type_name (query->param_types[j]), j);
961 g_print (",\n%s%s* arg%d", indent,
962 g_type_name (query->param_types[j]), j);
968 g_print ("%s", _name);
969 g_print (",\n%sgpointer user_data);\n", indent);
977 g_slist_foreach (found_signals, (GFunc) g_free, NULL);
978 g_slist_free (found_signals);
984 print_children_info (GstElement * element)
988 if (!GST_IS_BIN (element))
991 children = (GList *) GST_BIN (element)->children;
994 g_print ("Children:\n");
998 n_print (" %s\n", GST_ELEMENT_NAME (GST_ELEMENT (children->data)));
999 children = g_list_next (children);
1004 print_blacklist (void)
1006 GList *plugins, *cur;
1009 g_print ("%s\n", _("Blacklisted files:"));
1011 plugins = gst_default_registry_get_plugin_list ();
1012 for (cur = plugins; cur != NULL; cur = g_list_next (cur)) {
1013 GstPlugin *plugin = (GstPlugin *) (cur->data);
1014 if (plugin->flags & GST_PLUGIN_FLAG_BLACKLISTED) {
1015 g_print (" %s\n", plugin->desc.name);
1021 g_print (_("Total count: "));
1022 g_print (ngettext ("%d blacklisted file", "%d blacklisted files", count),
1025 gst_plugin_list_free (plugins);
1029 print_element_list (gboolean print_all)
1031 int plugincount = 0, featurecount = 0, blacklistcount = 0;
1032 GList *plugins, *orig_plugins;
1034 orig_plugins = plugins = gst_default_registry_get_plugin_list ();
1036 GList *features, *orig_features;
1039 plugin = (GstPlugin *) (plugins->data);
1040 plugins = g_list_next (plugins);
1043 if (plugin->flags & GST_PLUGIN_FLAG_BLACKLISTED) {
1048 orig_features = features =
1049 gst_registry_get_feature_list_by_plugin (gst_registry_get_default (),
1052 GstPluginFeature *feature;
1054 if (G_UNLIKELY (features->data == NULL))
1056 feature = GST_PLUGIN_FEATURE (features->data);
1059 if (GST_IS_ELEMENT_FACTORY (feature)) {
1060 GstElementFactory *factory;
1062 factory = GST_ELEMENT_FACTORY (feature);
1064 print_element_info (factory, TRUE);
1066 g_print ("%s: %s: %s\n", plugin->desc.name,
1067 GST_PLUGIN_FEATURE_NAME (factory),
1068 gst_element_factory_get_longname (factory));
1069 } else if (GST_IS_INDEX_FACTORY (feature)) {
1070 GstIndexFactory *factory;
1072 factory = GST_INDEX_FACTORY (feature);
1074 g_print ("%s: %s: %s\n", plugin->desc.name,
1075 GST_PLUGIN_FEATURE_NAME (factory), factory->longdesc);
1076 } else if (GST_IS_TYPE_FIND_FACTORY (feature)) {
1077 GstTypeFindFactory *factory;
1079 factory = GST_TYPE_FIND_FACTORY (feature);
1081 g_print ("%s: %s: ", plugin->desc.name,
1082 gst_plugin_feature_get_name (feature));
1083 if (factory->extensions) {
1086 while (factory->extensions[i]) {
1088 g_print ("%s%s", i > 0 ? ", " : "", factory->extensions[i]);
1095 g_print ("no extensions\n");
1099 n_print ("%s: %s (%s)\n", plugin->desc.name,
1100 GST_PLUGIN_FEATURE_NAME (feature),
1101 g_type_name (G_OBJECT_TYPE (feature)));
1105 features = g_list_next (features);
1108 gst_plugin_feature_list_free (orig_features);
1111 gst_plugin_list_free (orig_plugins);
1114 g_print (_("Total count: "));
1115 g_print (ngettext ("%d plugin", "%d plugins", plugincount), plugincount);
1116 if (blacklistcount) {
1118 g_print (ngettext ("%d blacklist entry", "%d blacklist entries",
1119 blacklistcount), blacklistcount);
1120 g_print (" not shown)");
1123 g_print (ngettext ("%d feature", "%d features", featurecount), featurecount);
1128 print_all_uri_handlers (void)
1130 GList *plugins, *p, *features, *f;
1132 plugins = gst_default_registry_get_plugin_list ();
1134 for (p = plugins; p; p = p->next) {
1135 GstPlugin *plugin = (GstPlugin *) (p->data);
1138 gst_registry_get_feature_list_by_plugin (gst_registry_get_default (),
1141 for (f = features; f; f = f->next) {
1142 GstPluginFeature *feature = GST_PLUGIN_FEATURE (f->data);
1144 if (GST_IS_ELEMENT_FACTORY (feature)) {
1145 GstElementFactory *factory;
1146 GstElement *element;
1148 factory = GST_ELEMENT_FACTORY (gst_plugin_feature_load (feature));
1150 g_print ("element plugin %s couldn't be loaded\n", plugin->desc.name);
1154 element = gst_element_factory_create (factory, NULL);
1156 g_print ("couldn't construct element for %s for some reason\n",
1157 GST_OBJECT_NAME (factory));
1158 gst_object_unref (factory);
1162 if (GST_IS_URI_HANDLER (element)) {
1164 gchar **uri_protocols, *joined;
1166 switch (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element))) {
1179 gst_uri_handler_get_protocols (GST_URI_HANDLER (element));
1180 joined = g_strjoinv (", ", uri_protocols);
1182 g_print ("%s (%s, rank %u): %s\n",
1183 gst_plugin_feature_get_name (GST_PLUGIN_FEATURE (factory)), dir,
1184 gst_plugin_feature_get_rank (GST_PLUGIN_FEATURE (factory)),
1190 gst_object_unref (element);
1191 gst_object_unref (factory);
1195 gst_plugin_feature_list_free (features);
1198 gst_plugin_list_free (plugins);
1202 print_plugin_info (GstPlugin * plugin)
1204 n_print ("Plugin Details:\n");
1205 n_print (" Name:\t\t\t%s\n", plugin->desc.name);
1206 n_print (" Description:\t\t%s\n", plugin->desc.description);
1207 n_print (" Filename:\t\t%s\n",
1208 plugin->filename ? plugin->filename : "(null)");
1209 n_print (" Version:\t\t%s\n", plugin->desc.version);
1210 n_print (" License:\t\t%s\n", plugin->desc.license);
1211 n_print (" Source module:\t%s\n", plugin->desc.source);
1212 if (plugin->desc.release_datetime != NULL) {
1213 const gchar *tz = "(UTC)";
1216 /* may be: YYYY-MM-DD or YYYY-MM-DDTHH:MMZ */
1217 /* YYYY-MM-DDTHH:MMZ => YYYY-MM-DD HH:MM (UTC) */
1218 str = g_strdup (plugin->desc.release_datetime);
1219 sep = strstr (str, "T");
1222 sep = strstr (sep + 1, "Z");
1228 n_print (" Source release date:\t%s%s\n", str, tz);
1231 n_print (" Binary package:\t%s\n", plugin->desc.package);
1232 n_print (" Origin URL:\t\t%s\n", plugin->desc.origin);
1237 print_plugin_features (GstPlugin * plugin)
1240 gint num_features = 0;
1241 gint num_elements = 0;
1242 gint num_typefinders = 0;
1243 gint num_indexes = 0;
1247 gst_registry_get_feature_list_by_plugin (gst_registry_get_default (),
1251 GstPluginFeature *feature;
1253 feature = GST_PLUGIN_FEATURE (features->data);
1255 if (GST_IS_ELEMENT_FACTORY (feature)) {
1256 GstElementFactory *factory;
1258 factory = GST_ELEMENT_FACTORY (feature);
1259 n_print (" %s: %s\n", GST_PLUGIN_FEATURE_NAME (factory),
1260 gst_element_factory_get_longname (factory));
1262 } else if (GST_IS_INDEX_FACTORY (feature)) {
1263 GstIndexFactory *factory;
1265 factory = GST_INDEX_FACTORY (feature);
1266 n_print (" %s: %s\n", GST_OBJECT_NAME (factory), factory->longdesc);
1268 } else if (GST_IS_TYPE_FIND_FACTORY (feature)) {
1269 GstTypeFindFactory *factory;
1271 factory = GST_TYPE_FIND_FACTORY (feature);
1272 if (factory->extensions) {
1275 g_print ("%s: %s: ", plugin->desc.name,
1276 gst_plugin_feature_get_name (feature));
1277 while (factory->extensions[i]) {
1278 g_print ("%s%s", i > 0 ? ", " : "", factory->extensions[i]);
1283 g_print ("%s: %s: no extensions\n", plugin->desc.name,
1284 gst_plugin_feature_get_name (feature));
1287 } else if (feature) {
1288 n_print (" %s (%s)\n", gst_object_get_name (GST_OBJECT (feature)),
1289 g_type_name (G_OBJECT_TYPE (feature)));
1293 features = g_list_next (features);
1296 n_print (" %d features:\n", num_features);
1297 if (num_elements > 0)
1298 n_print (" +-- %d elements\n", num_elements);
1299 if (num_typefinders > 0)
1300 n_print (" +-- %d typefinders\n", num_typefinders);
1301 if (num_indexes > 0)
1302 n_print (" +-- %d indexes\n", num_indexes);
1304 n_print (" +-- %d other objects\n", num_other);
1310 print_element_features (const gchar * element_name)
1312 GstPluginFeature *feature;
1314 /* FIXME implement other pretty print function for these */
1315 feature = gst_default_registry_find_feature (element_name,
1316 GST_TYPE_INDEX_FACTORY);
1318 n_print ("%s: an index\n", element_name);
1321 feature = gst_default_registry_find_feature (element_name,
1322 GST_TYPE_TYPE_FIND_FACTORY);
1324 n_print ("%s: a typefind function\n", element_name);
1332 print_element_info (GstElementFactory * factory, gboolean print_names)
1334 GstElement *element;
1338 GST_ELEMENT_FACTORY (gst_plugin_feature_load (GST_PLUGIN_FEATURE
1342 g_print ("element plugin couldn't be loaded\n");
1346 element = gst_element_factory_create (factory, NULL);
1348 g_print ("couldn't construct element for some reason\n");
1353 _name = g_strdup_printf ("%s: ", GST_PLUGIN_FEATURE (factory)->name);
1357 print_factory_details_info (factory);
1358 if (GST_PLUGIN_FEATURE (factory)->plugin_name) {
1361 plugin = gst_registry_find_plugin (gst_registry_get_default (),
1362 GST_PLUGIN_FEATURE (factory)->plugin_name);
1364 print_plugin_info (plugin);
1368 print_hierarchy (G_OBJECT_TYPE (element), 0, &maxlevel);
1369 print_interfaces (G_OBJECT_TYPE (element));
1371 print_pad_templates_info (element, factory);
1372 print_element_flag_info (element);
1373 print_implementation_info (element);
1374 print_clocking_info (element);
1375 print_index_info (element);
1376 print_uri_handler_info (element);
1377 print_pad_info (element);
1378 print_element_properties_info (element);
1379 print_signal_info (element);
1380 print_children_info (element);
1382 gst_object_unref (element);
1383 gst_object_unref (factory);
1391 print_plugin_automatic_install_info_codecs (GstElementFactory * factory)
1393 GstPadDirection direction;
1394 const gchar *type_name;
1396 const GList *static_templates, *l;
1397 GstCaps *caps = NULL;
1400 klass = gst_element_factory_get_klass (factory);
1401 g_return_if_fail (klass != NULL);
1403 if (strstr (klass, "Demuxer") ||
1404 strstr (klass, "Decoder") ||
1405 strstr (klass, "Depay") || strstr (klass, "Parser")) {
1406 type_name = "decoder";
1407 direction = GST_PAD_SINK;
1408 } else if (strstr (klass, "Muxer") ||
1409 strstr (klass, "Encoder") || strstr (klass, "Pay")) {
1410 type_name = "encoder";
1411 direction = GST_PAD_SRC;
1416 /* decoder/demuxer sink pads should always be static and there should only
1417 * be one, the same applies to encoders/muxers and source pads */
1418 static_templates = gst_element_factory_get_static_pad_templates (factory);
1419 for (l = static_templates; l != NULL; l = l->next) {
1420 GstStaticPadTemplate *tmpl = NULL;
1422 tmpl = (GstStaticPadTemplate *) l->data;
1423 if (tmpl->direction == direction) {
1424 caps = gst_static_pad_template_get_caps (tmpl);
1430 g_printerr ("Couldn't find static pad template for %s '%s'\n",
1431 type_name, GST_PLUGIN_FEATURE_NAME (factory));
1435 caps = gst_caps_make_writable (caps);
1436 num = gst_caps_get_size (caps);
1437 for (i = 0; i < num; ++i) {
1441 s = gst_caps_get_structure (caps, i);
1442 /* remove fields that are almost always just MIN-MAX of some sort
1443 * in order to make the caps look less messy */
1444 gst_structure_remove_field (s, "pixel-aspect-ratio");
1445 gst_structure_remove_field (s, "framerate");
1446 gst_structure_remove_field (s, "channels");
1447 gst_structure_remove_field (s, "width");
1448 gst_structure_remove_field (s, "height");
1449 gst_structure_remove_field (s, "rate");
1450 gst_structure_remove_field (s, "depth");
1451 gst_structure_remove_field (s, "clock-rate");
1452 s_str = gst_structure_to_string (s);
1453 g_print ("%s-%s\n", type_name, s_str);
1456 gst_caps_unref (caps);
1460 print_plugin_automatic_install_info_protocols (GstElementFactory * factory)
1462 gchar **protocols, **p;
1464 protocols = gst_element_factory_get_uri_protocols (factory);
1465 if (protocols != NULL && *protocols != NULL) {
1466 switch (gst_element_factory_get_uri_type (factory)) {
1468 for (p = protocols; *p != NULL; ++p)
1469 g_print ("urisink-%s\n", *p);
1472 for (p = protocols; *p != NULL; ++p)
1473 g_print ("urisource-%s\n", *p);
1478 g_strfreev (protocols);
1483 print_plugin_automatic_install_info (GstPlugin * plugin)
1485 const gchar *plugin_name;
1486 GList *features, *l;
1488 plugin_name = gst_plugin_get_name (plugin);
1490 /* not interested in typefind factories, only element factories */
1491 features = gst_registry_get_feature_list (gst_registry_get_default (),
1492 GST_TYPE_ELEMENT_FACTORY);
1494 for (l = features; l != NULL; l = l->next) {
1495 GstPluginFeature *feature;
1497 feature = GST_PLUGIN_FEATURE (l->data);
1499 /* only interested in the ones that are in the plugin we just loaded */
1500 if (g_str_equal (plugin_name, feature->plugin_name)) {
1501 GstElementFactory *factory;
1503 g_print ("element-%s\n", gst_plugin_feature_get_name (feature));
1505 factory = GST_ELEMENT_FACTORY (feature);
1506 print_plugin_automatic_install_info_protocols (factory);
1507 print_plugin_automatic_install_info_codecs (factory);
1511 g_list_foreach (features, (GFunc) gst_object_unref, NULL);
1512 g_list_free (features);
1516 print_all_plugin_automatic_install_info (void)
1518 GList *plugins, *orig_plugins;
1520 orig_plugins = plugins = gst_default_registry_get_plugin_list ();
1524 plugin = (GstPlugin *) (plugins->data);
1525 plugins = g_list_next (plugins);
1527 print_plugin_automatic_install_info (plugin);
1529 gst_plugin_list_free (orig_plugins);
1533 main (int argc, char *argv[])
1535 gboolean print_all = FALSE;
1536 gboolean do_print_blacklist = FALSE;
1537 gboolean plugin_name = FALSE;
1538 gboolean print_aii = FALSE;
1539 gboolean uri_handlers = FALSE;
1540 #ifndef GST_DISABLE_OPTION_PARSING
1541 GOptionEntry options[] = {
1542 {"print-all", 'a', 0, G_OPTION_ARG_NONE, &print_all,
1543 N_("Print all elements"), NULL},
1544 {"print-blacklist", 'b', 0, G_OPTION_ARG_NONE, &do_print_blacklist,
1545 N_("Print list of blacklisted files"), NULL},
1546 {"print-plugin-auto-install-info", '\0', 0, G_OPTION_ARG_NONE, &print_aii,
1547 N_("Print a machine-parsable list of features the specified plugin "
1548 "or all plugins provide.\n "
1549 "Useful in connection with external automatic plugin "
1550 "installation mechanisms"), NULL},
1551 {"plugin", '\0', 0, G_OPTION_ARG_NONE, &plugin_name,
1552 N_("List the plugin contents"), NULL},
1553 {"uri-handlers", 'u', 0, G_OPTION_ARG_NONE, &uri_handlers,
1555 ("Print supported URI schemes, with the elements that implement them"),
1557 GST_TOOLS_GOPTION_VERSION,
1560 GOptionContext *ctx;
1565 bindtextdomain (GETTEXT_PACKAGE, LOCALEDIR);
1566 bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
1567 textdomain (GETTEXT_PACKAGE);
1570 g_thread_init (NULL);
1572 gst_tools_set_prgname ("gst-inspect");
1574 #ifndef GST_DISABLE_OPTION_PARSING
1575 ctx = g_option_context_new ("[ELEMENT-NAME | PLUGIN-NAME]");
1576 g_option_context_add_main_entries (ctx, options, GETTEXT_PACKAGE);
1577 g_option_context_add_group (ctx, gst_init_get_option_group ());
1578 if (!g_option_context_parse (ctx, &argc, &argv, &err)) {
1579 g_print ("Error initializing: %s\n", err->message);
1582 g_option_context_free (ctx);
1584 gst_init (&argc, &argv);
1587 gst_tools_print_version ("gst-inspect");
1589 if (print_all && argc > 1) {
1590 g_print ("-a requires no extra arguments\n");
1594 if (uri_handlers && argc > 1) {
1595 g_print ("-u requires no extra arguments\n");
1599 /* if no arguments, print out list of elements */
1601 print_all_uri_handlers ();
1602 } else if (argc == 1 || print_all) {
1603 if (do_print_blacklist)
1607 print_all_plugin_automatic_install_info ();
1609 print_element_list (print_all);
1612 /* else we try to get a factory */
1613 GstElementFactory *factory;
1615 const char *arg = argv[argc - 1];
1619 factory = gst_element_factory_find (arg);
1621 /* if there's a factory, print out the info */
1623 retval = print_element_info (factory, print_all);
1624 gst_object_unref (factory);
1626 retval = print_element_features (arg);
1632 /* otherwise check if it's a plugin */
1634 plugin = gst_default_registry_find_plugin (arg);
1636 /* if there is such a plugin, print out info */
1639 print_plugin_automatic_install_info (plugin);
1641 print_plugin_info (plugin);
1642 print_plugin_features (plugin);
1645 GError *error = NULL;
1647 if (g_file_test (arg, G_FILE_TEST_EXISTS)) {
1648 plugin = gst_plugin_load_file (arg, &error);
1652 print_plugin_automatic_install_info (plugin);
1654 print_plugin_info (plugin);
1655 print_plugin_features (plugin);
1658 g_print (_("Could not load plugin file: %s\n"), error->message);
1659 g_error_free (error);
1663 g_print (_("No such element or plugin '%s'\n"), arg);