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>
7 * gst-inspect.c: tool to inspect the GStreamer registry
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Library General Public
11 * License as published by the Free Software Foundation; either
12 * version 2 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Library General Public License for more details.
19 * You should have received a copy of the GNU Library General Public
20 * License along with this library; if not, write to the
21 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
22 * Boston, MA 02110-1301, USA.
29 /* FIXME 2.0: suppress warnings for deprecated API such as GValueArray
30 * with newer GLib versions (>= 2.31.0) */
31 #define GLIB_DISABLE_DEPRECATION_WARNINGS
34 #include <gst/gst_private.h> /* for internal Factories */
38 #include <glib/gprintf.h>
41 # include <sys/wait.h>
44 #define DEFAULT_PAGER "less -F -X -R"
46 gboolean colored_output = TRUE;
50 /* Escape values for colors */
51 #define BLUE "\033[34m"
52 #define BRBLUE "\033[94m"
53 #define BRCYAN "\033[96m"
54 #define BRMAGENTA "\033[95m"
55 #define BRYELLOW "\033[33m"
56 #define CYAN "\033[36m"
57 #define GREEN "\033[32m"
58 #define MAGENTA "\033[35m"
59 #define YELLOW "\033[33m"
62 #define RESET_COLOR (colored_output? "\033[0m": "")
63 #define HEADING_COLOR (colored_output? BRYELLOW : "")
64 #define PROP_NAME_COLOR (colored_output? BRBLUE : "")
65 #define PROP_VALUE_COLOR (colored_output? RESET_COLOR: "")
66 #define PROP_ATTR_NAME_COLOR (colored_output? BRYELLOW : "")
67 #define PROP_ATTR_VALUE_COLOR (colored_output? CYAN: "")
68 /* FIXME: find a good color that works on both dark & light bg. */
69 #define DESC_COLOR (colored_output? RESET_COLOR: "")
71 /* Datatype-related colors */
72 #define DATATYPE_COLOR (colored_output? GREEN : "")
73 #define CHILD_LINK_COLOR (colored_output? BRMAGENTA : "")
76 #define FIELD_NAME_COLOR (colored_output? CYAN: "")
77 #define FIELD_VALUE_COLOR (colored_output? BRBLUE : "")
78 #define CAPS_TYPE_COLOR (colored_output? YELLOW : "")
79 #define STRUCT_NAME_COLOR (colored_output? YELLOW : "")
80 #define CAPS_FEATURE_COLOR (colored_output? GREEN : "")
82 /* Plugin listing colors */
83 #define PLUGIN_NAME_COLOR (colored_output? BRBLUE : "")
84 #define ELEMENT_NAME_COLOR (colored_output? GREEN : "")
85 /* FIXME: find a good color that works on both dark & light bg. */
86 #define ELEMENT_DETAIL_COLOR (colored_output? RESET_COLOR : "")
87 #define PLUGIN_FEATURE_COLOR (colored_output? BRBLUE: "")
89 /* Feature listing colors */
90 #define FEATURE_NAME_COLOR (colored_output? GREEN : "")
91 #define FEATURE_DIR_COLOR (colored_output? BRMAGENTA : "")
92 #define FEATURE_RANK_COLOR (colored_output? CYAN : "")
93 #define FEATURE_PROTO_COLOR (colored_output? BRYELLOW : "")
95 static char *_name = NULL;
96 static int indent = 0;
98 static int print_element_info (GstPluginFeature * feature,
99 gboolean print_names);
100 static int print_typefind_info (GstPluginFeature * feature,
101 gboolean print_names);
102 static int print_tracer_info (GstPluginFeature * feature, gboolean print_names);
104 #define push_indent() push_indent_n(1)
105 #define pop_indent() push_indent_n(-1)
106 #define pop_indent_n(n) push_indent_n(-n)
109 push_indent_n (int n)
111 g_assert (n > 0 || indent > 0);
120 n_print (const char *format, ...)
126 g_print ("%s", _name);
128 for (i = 0; i < indent; ++i)
131 va_start (args, format);
132 g_vprintf (format, args);
137 print_field (GQuark field, const GValue * value, gpointer pfx)
139 gchar *str = gst_value_serialize (value);
141 n_print ("%s %s%15s%s: %s%s%s\n",
142 (gchar *) pfx, FIELD_NAME_COLOR, g_quark_to_string (field), RESET_COLOR,
143 FIELD_VALUE_COLOR, str, RESET_COLOR);
149 print_caps (const GstCaps * caps, const gchar * pfx)
153 g_return_if_fail (caps != NULL);
155 if (gst_caps_is_any (caps)) {
156 n_print ("%s%sANY%s\n", CAPS_TYPE_COLOR, pfx, RESET_COLOR);
159 if (gst_caps_is_empty (caps)) {
160 n_print ("%s%sEMPTY%s\n", CAPS_TYPE_COLOR, pfx, RESET_COLOR);
164 for (i = 0; i < gst_caps_get_size (caps); i++) {
165 GstStructure *structure = gst_caps_get_structure (caps, i);
166 GstCapsFeatures *features = gst_caps_get_features (caps, i);
168 if (features && (gst_caps_features_is_any (features) ||
169 !gst_caps_features_is_equal (features,
170 GST_CAPS_FEATURES_MEMORY_SYSTEM_MEMORY))) {
171 gchar *features_string = gst_caps_features_to_string (features);
173 n_print ("%s%s%s%s(%s%s%s)\n", pfx, STRUCT_NAME_COLOR,
174 gst_structure_get_name (structure), RESET_COLOR,
175 CAPS_FEATURE_COLOR, features_string, RESET_COLOR);
176 g_free (features_string);
178 n_print ("%s%s%s%s\n", pfx, STRUCT_NAME_COLOR,
179 gst_structure_get_name (structure), RESET_COLOR);
181 gst_structure_foreach (structure, print_field, (gpointer) pfx);
186 get_rank_name (char *s, gint rank)
188 static const int ranks[4] = {
189 GST_RANK_NONE, GST_RANK_MARGINAL, GST_RANK_SECONDARY, GST_RANK_PRIMARY
191 static const char *rank_names[4] = { "none", "marginal", "secondary",
198 for (i = 0; i < 4; i++) {
199 if (rank == ranks[i])
200 return rank_names[i];
201 if (abs (rank - ranks[i]) < abs (rank - ranks[best_i])) {
206 sprintf (s, "%s %c %d", rank_names[best_i],
207 (rank - ranks[best_i] > 0) ? '+' : '-', abs (ranks[best_i] - rank));
213 print_factory_details_info (GstElementFactory * factory)
219 rank = gst_plugin_feature_get_rank (GST_PLUGIN_FEATURE (factory));
220 n_print ("%sFactory Details:%s\n", HEADING_COLOR, RESET_COLOR);
223 n_print ("%s%-25s%s%s (%d)%s\n", PROP_NAME_COLOR, "Rank", PROP_VALUE_COLOR,
224 get_rank_name (s, rank), rank, RESET_COLOR);
226 keys = gst_element_factory_get_metadata_keys (factory);
228 for (k = keys; *k != NULL; ++k) {
232 val = gst_element_factory_get_metadata (factory, key);
233 key[0] = g_ascii_toupper (key[0]);
234 n_print ("%s%-25s%s%s%s\n", PROP_NAME_COLOR, key, PROP_VALUE_COLOR, val,
244 print_hierarchy (GType type, gint level, gint * maxlevel)
249 parent = g_type_parent (type);
251 *maxlevel = *maxlevel + 1;
255 print_hierarchy (parent, level, maxlevel);
258 g_print ("%s%s%s", DATATYPE_COLOR, _name, RESET_COLOR);
260 for (i = 1; i < *maxlevel - level; i++)
262 if (*maxlevel - level)
263 g_print (" %s+----%s", CHILD_LINK_COLOR, RESET_COLOR);
265 g_print ("%s%s%s\n", DATATYPE_COLOR, g_type_name (type), RESET_COLOR);
272 print_interfaces (GType type)
275 GType *iface, *ifaces = g_type_interfaces (type, &n_ifaces);
279 n_print (_("%sImplemented Interfaces%s:\n"), HEADING_COLOR, RESET_COLOR);
283 n_print ("%s%s%s\n", DATATYPE_COLOR, g_type_name (*iface), RESET_COLOR);
294 flags_to_string (GFlagsValue * vals, guint flags)
299 /* first look for an exact match and count the number of values */
300 for (i = 0; vals[i].value_name != NULL; ++i) {
301 if (vals[i].value == flags)
302 return g_strdup (vals[i].value_nick);
305 s = g_string_new (NULL);
307 /* we assume the values are sorted from lowest to highest value */
311 if (vals[i].value != 0 && (flags_left & vals[i].value) == vals[i].value) {
313 g_string_append_c (s, '+');
314 g_string_append (s, vals[i].value_nick);
315 flags_left -= vals[i].value;
322 g_string_assign (s, "(none)");
324 return g_string_free (s, FALSE);
327 #define KNOWN_PARAM_FLAGS \
328 (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY | \
329 G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS | \
330 G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_DEPRECATED | \
331 GST_PARAM_CONTROLLABLE | GST_PARAM_MUTABLE_PLAYING | \
332 GST_PARAM_MUTABLE_PAUSED | GST_PARAM_MUTABLE_READY)
335 sort_gparamspecs (GParamSpec ** a, GParamSpec ** b)
337 return g_strcmp0 (g_param_spec_get_name (*a), g_param_spec_get_name (*b));
340 /* obj will be NULL if we're printing properties of pad template pads */
342 print_object_properties_info (GObject * obj, GObjectClass * obj_class,
345 GParamSpec **property_specs;
346 guint num_properties, i;
350 property_specs = g_object_class_list_properties (obj_class, &num_properties);
351 g_qsort_with_data (property_specs, num_properties, sizeof (gpointer),
352 (GCompareDataFunc) sort_gparamspecs, NULL);
354 n_print ("%s%s%s:\n", HEADING_COLOR, desc, RESET_COLOR);
358 for (i = 0; i < num_properties; i++) {
359 GValue value = { 0, };
360 GParamSpec *param = property_specs[i];
361 GType owner_type = param->owner_type;
363 /* We're printing pad properties */
364 if (obj == NULL && (owner_type == G_TYPE_OBJECT
365 || owner_type == GST_TYPE_OBJECT || owner_type == GST_TYPE_PAD))
368 g_value_init (&value, param->value_type);
370 n_print ("%s%-20s%s: %s%s%s\n", PROP_NAME_COLOR,
371 g_param_spec_get_name (param), RESET_COLOR, PROP_VALUE_COLOR,
372 g_param_spec_get_blurb (param), RESET_COLOR);
377 n_print ("%sflags%s: ", PROP_ATTR_NAME_COLOR, RESET_COLOR);
378 readable = ! !(param->flags & G_PARAM_READABLE);
379 if (readable && obj != NULL) {
380 g_object_get_property (obj, param->name, &value);
382 /* if we can't read the property value, assume it's set to the default
383 * (which might not be entirely true for sub-classes, but that's an
384 * unlikely corner-case anyway) */
385 g_param_value_set_default (param, &value);
388 g_print ("%s%s%s%s", (first_flag) ? "" : ", ", PROP_ATTR_VALUE_COLOR,
389 _("readable"), RESET_COLOR);
392 if (param->flags & G_PARAM_WRITABLE) {
393 g_print ("%s%s%s%s", (first_flag) ? "" : ", ", PROP_ATTR_VALUE_COLOR,
394 _("writable"), RESET_COLOR);
397 if (param->flags & G_PARAM_DEPRECATED) {
398 g_print ("%s%s%s%s", (first_flag) ? "" : ", ", PROP_ATTR_VALUE_COLOR,
399 _("deprecated"), RESET_COLOR);
402 if (param->flags & GST_PARAM_CONTROLLABLE) {
403 g_print (", %s%s%s", PROP_ATTR_VALUE_COLOR, _("controllable"),
407 if (param->flags & GST_PARAM_MUTABLE_PLAYING) {
408 g_print (", %s%s%s", PROP_ATTR_VALUE_COLOR,
409 _("changeable in NULL, READY, PAUSED or PLAYING state"), RESET_COLOR);
410 } else if (param->flags & GST_PARAM_MUTABLE_PAUSED) {
411 g_print (", %s%s%s", PROP_ATTR_VALUE_COLOR,
412 _("changeable only in NULL, READY or PAUSED state"), RESET_COLOR);
413 } else if (param->flags & GST_PARAM_MUTABLE_READY) {
414 g_print (", %s%s%s", PROP_ATTR_VALUE_COLOR,
415 _("changeable only in NULL or READY state"), RESET_COLOR);
417 if (param->flags & ~KNOWN_PARAM_FLAGS) {
418 g_print ("%s0x%s%0x%s", (first_flag) ? "" : ", ", PROP_ATTR_VALUE_COLOR,
419 param->flags & ~KNOWN_PARAM_FLAGS, RESET_COLOR);
423 switch (G_VALUE_TYPE (&value)) {
426 const char *string_val = g_value_get_string (&value);
428 n_print ("%sString%s. ", DATATYPE_COLOR, RESET_COLOR);
430 if (string_val == NULL)
431 g_print ("%sDefault%s: %snull%s", PROP_ATTR_NAME_COLOR, RESET_COLOR,
432 PROP_ATTR_VALUE_COLOR, RESET_COLOR);
434 g_print ("%sDefault%s: %s\"%s\"%s", PROP_ATTR_NAME_COLOR, RESET_COLOR,
435 PROP_ATTR_VALUE_COLOR, string_val, RESET_COLOR);
440 gboolean bool_val = g_value_get_boolean (&value);
442 n_print ("%sBoolean%s. %sDefault%s: %s%s%s", DATATYPE_COLOR,
443 RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
444 PROP_ATTR_VALUE_COLOR, bool_val ? "true" : "false", RESET_COLOR);
449 GParamSpecULong *pulong = G_PARAM_SPEC_ULONG (param);
452 ("%sUnsigned Long%s. %sRange%s: %s%lu - %lu%s %sDefault%s: %s%lu%s ",
453 DATATYPE_COLOR, RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
454 PROP_ATTR_VALUE_COLOR, pulong->minimum, pulong->maximum,
455 RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
456 PROP_ATTR_VALUE_COLOR, g_value_get_ulong (&value), RESET_COLOR);
458 GST_ERROR ("%s: property '%s' of type ulong: consider changing to "
459 "uint/uint64", G_OBJECT_CLASS_NAME (obj_class),
460 g_param_spec_get_name (param));
465 GParamSpecLong *plong = G_PARAM_SPEC_LONG (param);
467 n_print ("%sLong%s. %sRange%s: %s%ld - %ld%s %sDefault%s: %s%ld%s ",
468 DATATYPE_COLOR, RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
469 PROP_ATTR_VALUE_COLOR, plong->minimum, plong->maximum, RESET_COLOR,
470 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
471 g_value_get_long (&value), RESET_COLOR);
473 GST_ERROR ("%s: property '%s' of type long: consider changing to "
474 "int/int64", G_OBJECT_CLASS_NAME (obj_class),
475 g_param_spec_get_name (param));
480 GParamSpecUInt *puint = G_PARAM_SPEC_UINT (param);
483 ("%sUnsigned Integer%s. %sRange%s: %s%u - %u%s %sDefault%s: %s%u%s ",
484 DATATYPE_COLOR, RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
485 PROP_ATTR_VALUE_COLOR, puint->minimum, puint->maximum, RESET_COLOR,
486 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
487 g_value_get_uint (&value), RESET_COLOR);
492 GParamSpecInt *pint = G_PARAM_SPEC_INT (param);
494 n_print ("%sInteger%s. %sRange%s: %s%d - %d%s %sDefault%s: %s%d%s ",
495 DATATYPE_COLOR, RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
496 PROP_ATTR_VALUE_COLOR, pint->minimum, pint->maximum, RESET_COLOR,
497 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
498 g_value_get_int (&value), RESET_COLOR);
503 GParamSpecUInt64 *puint64 = G_PARAM_SPEC_UINT64 (param);
505 n_print ("%sUnsigned Integer64%s. %sRange%s: %s%" G_GUINT64_FORMAT " - "
506 "%" G_GUINT64_FORMAT "%s %sDefault%s: %s%" G_GUINT64_FORMAT "%s ",
507 DATATYPE_COLOR, RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
508 PROP_ATTR_VALUE_COLOR, puint64->minimum, puint64->maximum,
509 RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
510 PROP_ATTR_VALUE_COLOR, g_value_get_uint64 (&value), RESET_COLOR);
515 GParamSpecInt64 *pint64 = G_PARAM_SPEC_INT64 (param);
517 n_print ("%sInteger64%s. %sRange%s: %s%" G_GINT64_FORMAT " - %"
518 G_GINT64_FORMAT "%s %sDefault%s: %s%" G_GINT64_FORMAT "%s ",
519 DATATYPE_COLOR, RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
520 PROP_ATTR_VALUE_COLOR, pint64->minimum, pint64->maximum,
521 RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
522 PROP_ATTR_VALUE_COLOR, g_value_get_int64 (&value), RESET_COLOR);
527 GParamSpecFloat *pfloat = G_PARAM_SPEC_FLOAT (param);
529 n_print ("%sFloat%s. %sRange%s: %s%15.7g - %15.7g%s "
530 "%sDefault%s: %s%15.7g%s ", DATATYPE_COLOR, RESET_COLOR,
531 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
532 pfloat->minimum, pfloat->maximum, RESET_COLOR, PROP_ATTR_NAME_COLOR,
533 RESET_COLOR, PROP_ATTR_VALUE_COLOR, g_value_get_float (&value),
539 GParamSpecDouble *pdouble = G_PARAM_SPEC_DOUBLE (param);
541 n_print ("%sDouble%s. %sRange%s: %s%15.7g - %15.7g%s "
542 "%sDefault%s: %s%15.7g%s ", DATATYPE_COLOR, RESET_COLOR,
543 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
544 pdouble->minimum, pdouble->maximum, RESET_COLOR,
545 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
546 g_value_get_double (&value), RESET_COLOR);
551 GST_ERROR ("%s: property '%s' of type char: consider changing to "
552 "int/string", G_OBJECT_CLASS_NAME (obj_class),
553 g_param_spec_get_name (param));
556 if (param->value_type == GST_TYPE_CAPS) {
557 const GstCaps *caps = gst_value_get_caps (&value);
560 n_print ("%sCaps%s (NULL)", DATATYPE_COLOR, RESET_COLOR);
562 print_caps (caps, " ");
564 } else if (G_IS_PARAM_SPEC_ENUM (param)) {
568 const gchar *value_nick = "";
570 values = G_ENUM_CLASS (g_type_class_ref (param->value_type))->values;
571 enum_value = g_value_get_enum (&value);
573 while (values[j].value_name) {
574 if (values[j].value == enum_value)
575 value_nick = values[j].value_nick;
579 n_print ("%sEnum \"%s\"%s %sDefault%s: %s%d, \"%s\"%s",
580 DATATYPE_COLOR, g_type_name (G_VALUE_TYPE (&value)), RESET_COLOR,
581 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
582 enum_value, value_nick, RESET_COLOR);
585 while (values[j].value_name) {
587 n_print (" %s(%d)%s: %s%-16s%s - %s%s%s",
588 PROP_ATTR_NAME_COLOR, values[j].value, RESET_COLOR,
589 PROP_ATTR_VALUE_COLOR, values[j].value_nick, RESET_COLOR,
590 DESC_COLOR, values[j].value_name, RESET_COLOR);
593 /* g_type_class_unref (ec); */
594 } else if (G_IS_PARAM_SPEC_FLAGS (param)) {
595 GParamSpecFlags *pflags = G_PARAM_SPEC_FLAGS (param);
599 vals = pflags->flags_class->values;
601 cur = flags_to_string (vals, g_value_get_flags (&value));
603 n_print ("%sFlags \"%s\"%s %sDefault%s: %s0x%08x, \"%s\"%s",
604 DATATYPE_COLOR, g_type_name (G_VALUE_TYPE (&value)), RESET_COLOR,
605 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
606 g_value_get_flags (&value), cur, RESET_COLOR);
608 while (vals[0].value_name) {
610 n_print (" %s(0x%08x)%s: %s%-16s%s - %s%s%s",
611 PROP_ATTR_NAME_COLOR, vals[0].value, RESET_COLOR,
612 PROP_ATTR_VALUE_COLOR, vals[0].value_nick, RESET_COLOR,
613 DESC_COLOR, vals[0].value_name, RESET_COLOR);
618 } else if (G_IS_PARAM_SPEC_OBJECT (param)) {
619 n_print ("%sObject of type%s %s\"%s\"%s", PROP_VALUE_COLOR,
620 RESET_COLOR, DATATYPE_COLOR,
621 g_type_name (param->value_type), RESET_COLOR);
622 } else if (G_IS_PARAM_SPEC_BOXED (param)) {
623 n_print ("%sBoxed pointer of type%s %s\"%s\"%s", PROP_VALUE_COLOR,
624 RESET_COLOR, DATATYPE_COLOR,
625 g_type_name (param->value_type), RESET_COLOR);
626 if (param->value_type == GST_TYPE_STRUCTURE) {
627 const GstStructure *s = gst_value_get_structure (&value);
629 gst_structure_foreach (s, print_field,
632 } else if (G_IS_PARAM_SPEC_POINTER (param)) {
633 if (param->value_type != G_TYPE_POINTER) {
634 n_print ("%sPointer of type%s %s\"%s\"%s.", PROP_VALUE_COLOR,
635 RESET_COLOR, DATATYPE_COLOR, g_type_name (param->value_type),
638 n_print ("%sPointer.%s", PROP_VALUE_COLOR, RESET_COLOR);
640 } else if (param->value_type == G_TYPE_VALUE_ARRAY) {
641 GParamSpecValueArray *pvarray = G_PARAM_SPEC_VALUE_ARRAY (param);
643 if (pvarray->element_spec) {
644 n_print ("%sArray of GValues of type%s %s\"%s\"%s",
645 PROP_VALUE_COLOR, RESET_COLOR, DATATYPE_COLOR,
646 g_type_name (pvarray->element_spec->value_type), RESET_COLOR);
648 n_print ("%sArray of GValues%s", PROP_VALUE_COLOR, RESET_COLOR);
650 } else if (GST_IS_PARAM_SPEC_FRACTION (param)) {
651 GstParamSpecFraction *pfraction = GST_PARAM_SPEC_FRACTION (param);
653 n_print ("%sFraction%s. %sRange%s: %s%d/%d - %d/%d%s "
654 "%sDefault%s: %s%d/%d%s ", DATATYPE_COLOR, RESET_COLOR,
655 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
656 pfraction->min_num, pfraction->min_den, pfraction->max_num,
657 pfraction->max_den, RESET_COLOR, PROP_ATTR_NAME_COLOR,
658 RESET_COLOR, PROP_ATTR_VALUE_COLOR,
659 gst_value_get_fraction_numerator (&value),
660 gst_value_get_fraction_denominator (&value), RESET_COLOR);
661 } else if (param->value_type == GST_TYPE_ARRAY) {
662 GstParamSpecArray *parray = GST_PARAM_SPEC_ARRAY_LIST (param);
664 if (parray->element_spec) {
665 n_print ("%sGstValueArray of GValues of type%s %s\"%s\"%s",
666 PROP_VALUE_COLOR, RESET_COLOR, DATATYPE_COLOR,
667 g_type_name (parray->element_spec->value_type), RESET_COLOR);
669 n_print ("%sGstValueArray of GValues%s", PROP_VALUE_COLOR,
673 n_print ("%sUnknown type %ld%s %s\"%s\"%s", PROP_VALUE_COLOR,
674 (glong) param->value_type, RESET_COLOR, DATATYPE_COLOR,
675 g_type_name (param->value_type), RESET_COLOR);
680 g_print (" %sWrite only%s\n", PROP_VALUE_COLOR, RESET_COLOR);
686 g_value_reset (&value);
688 if (num_properties == 0)
689 n_print ("%snone%s\n", PROP_VALUE_COLOR, RESET_COLOR);
693 g_free (property_specs);
697 print_element_properties_info (GstElement * element)
700 print_object_properties_info (G_OBJECT (element),
701 G_OBJECT_GET_CLASS (element), "Element Properties");
705 print_pad_templates_info (GstElement * element, GstElementFactory * factory)
708 GstStaticPadTemplate *padtemplate;
709 GstPadTemplate *tmpl;
711 n_print ("%sPad Templates%s:\n", HEADING_COLOR, RESET_COLOR);
715 if (gst_element_factory_get_num_pad_templates (factory) == 0) {
716 n_print ("%snone%s\n", PROP_VALUE_COLOR, RESET_COLOR);
720 pads = gst_element_factory_get_static_pad_templates (factory);
722 padtemplate = (GstStaticPadTemplate *) (pads->data);
723 pads = g_list_next (pads);
725 if (padtemplate->direction == GST_PAD_SRC)
726 n_print ("%sSRC template%s: %s'%s'%s\n", PROP_NAME_COLOR, RESET_COLOR,
727 PROP_VALUE_COLOR, padtemplate->name_template, RESET_COLOR);
728 else if (padtemplate->direction == GST_PAD_SINK)
729 n_print ("%sSINK template%s: %s'%s'%s\n", PROP_NAME_COLOR, RESET_COLOR,
730 PROP_VALUE_COLOR, padtemplate->name_template, RESET_COLOR);
732 n_print ("%sUNKNOWN template%s: %s'%s'%s\n", PROP_NAME_COLOR, RESET_COLOR,
733 PROP_VALUE_COLOR, padtemplate->name_template, RESET_COLOR);
737 if (padtemplate->presence == GST_PAD_ALWAYS)
738 n_print ("%sAvailability%s: %sAlways%s\n", PROP_NAME_COLOR, RESET_COLOR,
739 PROP_VALUE_COLOR, RESET_COLOR);
740 else if (padtemplate->presence == GST_PAD_SOMETIMES)
741 n_print ("%sAvailability%s: %sSometimes%s\n", PROP_NAME_COLOR,
742 RESET_COLOR, PROP_VALUE_COLOR, RESET_COLOR);
743 else if (padtemplate->presence == GST_PAD_REQUEST) {
744 n_print ("%sAvailability%s: %sOn request%s\n", PROP_NAME_COLOR,
745 RESET_COLOR, PROP_VALUE_COLOR, RESET_COLOR);
747 n_print ("%sAvailability%s: %sUNKNOWN%s\n", PROP_NAME_COLOR, RESET_COLOR,
748 PROP_VALUE_COLOR, RESET_COLOR);
750 if (padtemplate->static_caps.string) {
751 GstCaps *caps = gst_static_caps_get (&padtemplate->static_caps);
753 n_print ("%sCapabilities%s:\n", PROP_NAME_COLOR, RESET_COLOR);
756 print_caps (caps, ""); // FIXME
759 gst_caps_unref (caps);
762 tmpl = gst_element_class_get_pad_template (GST_ELEMENT_GET_CLASS (element),
763 padtemplate->name_template);
765 GType pad_type = GST_PAD_TEMPLATE_GTYPE (tmpl);
767 if (pad_type != G_TYPE_NONE && pad_type != GST_TYPE_PAD) {
770 pad_klass = g_type_class_ref (pad_type);
771 n_print ("%sType%s: %s%s%s\n", PROP_NAME_COLOR, RESET_COLOR,
772 DATATYPE_COLOR, g_type_name (pad_type), RESET_COLOR);
773 print_object_properties_info (NULL, pad_klass, "Pad Properties");
774 g_type_class_unref (pad_klass);
789 print_clocking_info (GstElement * element)
791 gboolean requires_clock, provides_clock;
794 GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_REQUIRE_CLOCK);
796 GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_PROVIDE_CLOCK);
798 if (!requires_clock && !provides_clock) {
800 n_print ("%sElement has no clocking capabilities.%s\n", DESC_COLOR,
806 n_print ("%sClocking Interaction%s:\n", PROP_NAME_COLOR, RESET_COLOR);
810 if (requires_clock) {
811 n_print ("%selement requires a clock%s\n", PROP_VALUE_COLOR, RESET_COLOR);
814 if (provides_clock) {
817 clock = gst_element_get_clock (element);
819 n_print ("%selement provides a clock%s: %s%s%s\n", PROP_VALUE_COLOR,
820 RESET_COLOR, DATATYPE_COLOR, GST_OBJECT_NAME (clock), RESET_COLOR);
821 gst_object_unref (clock);
823 n_print ("%selement is supposed to provide a clock but returned NULL%s\n",
824 PROP_VALUE_COLOR, RESET_COLOR);
831 print_uri_handler_info (GstElement * element)
833 if (GST_IS_URI_HANDLER (element)) {
834 const gchar *const *uri_protocols;
835 const gchar *uri_type;
837 if (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element)) == GST_URI_SRC)
839 else if (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element)) ==
843 uri_type = "unknown";
845 uri_protocols = gst_uri_handler_get_protocols (GST_URI_HANDLER (element));
848 n_print ("%sURI handling capabilities:%s\n", HEADING_COLOR, RESET_COLOR);
852 n_print ("%sElement can act as %s.%s\n", DESC_COLOR, uri_type, RESET_COLOR);
854 if (uri_protocols && *uri_protocols) {
855 n_print ("%sSupported URI protocols%s:\n", DESC_COLOR, RESET_COLOR);
857 for (; *uri_protocols != NULL; uri_protocols++)
858 n_print ("%s%s%s\n", PROP_ATTR_VALUE_COLOR, *uri_protocols,
862 n_print ("%sNo supported URI protocols%s\n", PROP_VALUE_COLOR,
868 n_print ("%sElement has no URI handling capabilities.%s\n", DESC_COLOR,
874 print_pad_info (GstElement * element)
880 n_print ("%sPads:%s\n", HEADING_COLOR, RESET_COLOR);
884 if (!element->numpads) {
885 n_print ("%snone%s\n", PROP_VALUE_COLOR, RESET_COLOR);
889 pads = element->pads;
894 pad = GST_PAD (pads->data);
895 pads = g_list_next (pads);
897 name = gst_pad_get_name (pad);
898 if (gst_pad_get_direction (pad) == GST_PAD_SRC)
899 n_print ("%sSRC%s: %s'%s'%s\n", PROP_NAME_COLOR, RESET_COLOR,
900 PROP_VALUE_COLOR, name, RESET_COLOR);
901 else if (gst_pad_get_direction (pad) == GST_PAD_SINK)
902 n_print ("%sSINK%s: %s'%s'%s\n", PROP_NAME_COLOR, RESET_COLOR,
903 PROP_VALUE_COLOR, name, RESET_COLOR);
905 n_print ("%sUNKNOWN%s: %s'%s'%s\n", PROP_NAME_COLOR, RESET_COLOR,
906 PROP_VALUE_COLOR, name, RESET_COLOR);
910 if (pad->padtemplate) {
912 n_print ("%sPad Template%s: %s'%s'%s\n", PROP_NAME_COLOR, RESET_COLOR,
913 PROP_VALUE_COLOR, pad->padtemplate->name_template, RESET_COLOR);
917 caps = gst_pad_get_current_caps (pad);
919 n_print ("%sCapabilities:%s\n", PROP_NAME_COLOR, RESET_COLOR);
921 print_caps (caps, ""); // FIXME
923 gst_caps_unref (caps);
932 has_sometimes_template (GstElement * element)
934 GstElementClass *klass = GST_ELEMENT_GET_CLASS (element);
937 for (l = klass->padtemplates; l != NULL; l = l->next) {
938 if (GST_PAD_TEMPLATE (l->data)->presence == GST_PAD_SOMETIMES)
946 gtype_needs_ptr_marker (GType type)
948 if (type == G_TYPE_POINTER)
951 if (G_TYPE_FUNDAMENTAL (type) == G_TYPE_POINTER || G_TYPE_IS_BOXED (type)
952 || G_TYPE_IS_OBJECT (type))
959 print_signal_info (GstElement * element)
961 /* Signals/Actions Block */
965 GSignalQuery *query = NULL;
967 GSList *found_signals, *l;
969 for (k = 0; k < 2; k++) {
970 found_signals = NULL;
972 /* For elements that have sometimes pads, also list a few useful GstElement
973 * signals. Put these first, so element-specific ones come later. */
974 if (k == 0 && has_sometimes_template (element)) {
975 query = g_new0 (GSignalQuery, 1);
976 g_signal_query (g_signal_lookup ("pad-added", GST_TYPE_ELEMENT), query);
977 found_signals = g_slist_append (found_signals, query);
978 query = g_new0 (GSignalQuery, 1);
979 g_signal_query (g_signal_lookup ("pad-removed", GST_TYPE_ELEMENT), query);
980 found_signals = g_slist_append (found_signals, query);
981 query = g_new0 (GSignalQuery, 1);
982 g_signal_query (g_signal_lookup ("no-more-pads", GST_TYPE_ELEMENT),
984 found_signals = g_slist_append (found_signals, query);
987 for (type = G_OBJECT_TYPE (element); type; type = g_type_parent (type)) {
988 if (type == GST_TYPE_ELEMENT || type == GST_TYPE_OBJECT)
991 if (type == GST_TYPE_BIN && G_OBJECT_TYPE (element) != GST_TYPE_BIN)
994 signals = g_signal_list_ids (type, &nsignals);
995 for (i = 0; i < nsignals; i++) {
996 query = g_new0 (GSignalQuery, 1);
997 g_signal_query (signals[i], query);
999 if ((k == 0 && !(query->signal_flags & G_SIGNAL_ACTION)) ||
1000 (k == 1 && (query->signal_flags & G_SIGNAL_ACTION)))
1001 found_signals = g_slist_append (found_signals, query);
1009 if (found_signals) {
1012 n_print ("%sElement Signals%s:\n", HEADING_COLOR, RESET_COLOR);
1014 n_print ("%sElement Actions%s:\n", HEADING_COLOR, RESET_COLOR);
1019 for (l = found_signals; l; l = l->next) {
1024 query = (GSignalQuery *) l->data;
1025 indent_len = strlen (query->signal_name) +
1026 strlen (g_type_name (query->return_type)) + 24;
1028 if (gtype_needs_ptr_marker (query->return_type)) {
1035 indent = g_new0 (gchar, indent_len + 1);
1036 memset (indent, ' ', indent_len);
1038 n_print (" %s\"%s\"%s : %s%s%s%suser_function%s (%s%s%s* object%s",
1039 PROP_NAME_COLOR, query->signal_name, RESET_COLOR,
1040 DATATYPE_COLOR, g_type_name (query->return_type), PROP_VALUE_COLOR,
1041 pmark, RESET_COLOR, DATATYPE_COLOR, g_type_name (type),
1042 PROP_VALUE_COLOR, RESET_COLOR);
1044 for (j = 0; j < query->n_params; j++) {
1045 const gchar *type_name, *asterisk;
1047 type_name = g_type_name (query->param_types[j]);
1048 asterisk = gtype_needs_ptr_marker (query->param_types[j]) ? "*" : "";
1051 n_print ("%s%s%s%s%s arg%d%s", indent, DATATYPE_COLOR, type_name,
1052 PROP_VALUE_COLOR, asterisk, j, RESET_COLOR);
1057 n_print ("%s%sgpointer %suser_data%s);\n", indent, DATATYPE_COLOR,
1058 PROP_VALUE_COLOR, RESET_COLOR);
1065 if (found_signals) {
1066 g_slist_foreach (found_signals, (GFunc) g_free, NULL);
1067 g_slist_free (found_signals);
1073 print_children_info (GstElement * element)
1077 if (!GST_IS_BIN (element))
1080 children = (GList *) GST_BIN (element)->children;
1083 n_print ("%sChildren%s:\n", HEADING_COLOR, RESET_COLOR);
1087 n_print (" %s%s%s\n", DATATYPE_COLOR,
1088 GST_ELEMENT_NAME (GST_ELEMENT (children->data)), RESET_COLOR);
1089 children = g_list_next (children);
1094 print_preset_list (GstElement * element)
1096 gchar **presets, **preset;
1098 if (!GST_IS_PRESET (element))
1101 presets = gst_preset_get_preset_names (GST_PRESET (element));
1102 if (presets && *presets) {
1104 n_print ("%sPresets%s:\n", HEADING_COLOR, RESET_COLOR);
1105 for (preset = presets; *preset; preset++) {
1106 n_print (" \"%s\"\n", *preset);
1108 g_strfreev (presets);
1113 print_blacklist (void)
1115 GList *plugins, *cur;
1118 g_print ("%s%s%s\n", HEADING_COLOR, _("Blacklisted files:"), RESET_COLOR);
1120 plugins = gst_registry_get_plugin_list (gst_registry_get ());
1121 for (cur = plugins; cur != NULL; cur = g_list_next (cur)) {
1122 GstPlugin *plugin = (GstPlugin *) (cur->data);
1123 if (GST_OBJECT_FLAG_IS_SET (plugin, GST_PLUGIN_FLAG_BLACKLISTED)) {
1124 g_print (" %s\n", gst_plugin_get_name (plugin));
1130 g_print (_("%sTotal count%s: %s"), PROP_NAME_COLOR, RESET_COLOR,
1132 g_print (ngettext ("%d blacklisted file", "%d blacklisted files", count),
1134 g_print ("%s\n", RESET_COLOR);
1135 gst_plugin_list_free (plugins);
1139 print_typefind_extensions (const gchar * const *extensions, const gchar * color)
1143 while (extensions[i]) {
1144 g_print ("%s%s%s%s", i > 0 ? ", " : "", color, extensions[i], RESET_COLOR);
1150 print_element_list (gboolean print_all, gchar * ftypes)
1152 int plugincount = 0, featurecount = 0, blacklistcount = 0;
1153 GList *plugins, *orig_plugins;
1154 gchar **types = NULL;
1159 types = g_strsplit (ftypes, "/", -1);
1160 for (i = 0; types[i]; i++)
1161 *types[i] = g_ascii_toupper (*types[i]);
1165 orig_plugins = plugins = gst_registry_get_plugin_list (gst_registry_get ());
1167 GList *features, *orig_features;
1170 plugin = (GstPlugin *) (plugins->data);
1171 plugins = g_list_next (plugins);
1174 if (GST_OBJECT_FLAG_IS_SET (plugin, GST_PLUGIN_FLAG_BLACKLISTED)) {
1179 orig_features = features =
1180 gst_registry_get_feature_list_by_plugin (gst_registry_get (),
1181 gst_plugin_get_name (plugin));
1183 GstPluginFeature *feature;
1185 if (G_UNLIKELY (features->data == NULL))
1187 feature = GST_PLUGIN_FEATURE (features->data);
1190 if (GST_IS_ELEMENT_FACTORY (feature)) {
1192 GstElementFactory *factory;
1194 factory = GST_ELEMENT_FACTORY (feature);
1197 gboolean all_found = TRUE;
1200 gst_element_factory_get_metadata (factory,
1201 GST_ELEMENT_METADATA_KLASS);
1202 for (i = 0; types[i]; i++) {
1203 if (!strstr (klass, types[i])) {
1213 print_element_info (feature, TRUE);
1215 g_print ("%s%s%s: %s%s%s: %s%s%s\n", PLUGIN_NAME_COLOR,
1216 gst_plugin_get_name (plugin), RESET_COLOR, ELEMENT_NAME_COLOR,
1217 GST_OBJECT_NAME (factory), RESET_COLOR, ELEMENT_DETAIL_COLOR,
1218 gst_element_factory_get_metadata (factory,
1219 GST_ELEMENT_METADATA_LONGNAME), RESET_COLOR);
1220 } else if (GST_IS_TYPE_FIND_FACTORY (feature)) {
1221 GstTypeFindFactory *factory;
1222 const gchar *const *extensions;
1226 factory = GST_TYPE_FIND_FACTORY (feature);
1228 g_print ("%s%s%s: %s%s%s: ", PLUGIN_NAME_COLOR,
1229 gst_plugin_get_name (plugin), RESET_COLOR, ELEMENT_NAME_COLOR,
1230 gst_plugin_feature_get_name (feature), RESET_COLOR);
1232 extensions = gst_type_find_factory_get_extensions (factory);
1233 if (extensions != NULL) {
1235 print_typefind_extensions (extensions, ELEMENT_DETAIL_COLOR);
1240 g_print ("%sno extensions%s\n", ELEMENT_DETAIL_COLOR, RESET_COLOR);
1246 n_print ("%s%s%s: %s%s%s (%s%s%s)\n", PLUGIN_NAME_COLOR,
1247 gst_plugin_get_name (plugin), RESET_COLOR, ELEMENT_NAME_COLOR,
1248 GST_OBJECT_NAME (feature), RESET_COLOR, ELEMENT_DETAIL_COLOR,
1249 g_type_name (G_OBJECT_TYPE (feature)), RESET_COLOR);
1253 features = g_list_next (features);
1256 gst_plugin_feature_list_free (orig_features);
1259 gst_plugin_list_free (orig_plugins);
1263 g_print (_("%sTotal count%s: %s"), PROP_NAME_COLOR, RESET_COLOR,
1265 g_print (ngettext ("%d plugin", "%d plugins", plugincount), plugincount);
1266 if (blacklistcount) {
1268 g_print (ngettext ("%d blacklist entry", "%d blacklist entries",
1269 blacklistcount), blacklistcount);
1270 g_print (" not shown)");
1272 g_print ("%s, %s", RESET_COLOR, PROP_VALUE_COLOR);
1273 g_print (ngettext ("%d feature", "%d features", featurecount), featurecount);
1274 g_print ("%s\n", RESET_COLOR);
1278 print_all_uri_handlers (void)
1280 GList *plugins, *p, *features, *f;
1282 plugins = gst_registry_get_plugin_list (gst_registry_get ());
1284 for (p = plugins; p; p = p->next) {
1285 GstPlugin *plugin = (GstPlugin *) (p->data);
1288 gst_registry_get_feature_list_by_plugin (gst_registry_get (),
1289 gst_plugin_get_name (plugin));
1291 for (f = features; f; f = f->next) {
1292 GstPluginFeature *feature = GST_PLUGIN_FEATURE (f->data);
1294 if (GST_IS_ELEMENT_FACTORY (feature)) {
1295 GstElementFactory *factory;
1296 GstElement *element;
1298 factory = GST_ELEMENT_FACTORY (gst_plugin_feature_load (feature));
1300 g_print ("element plugin %s couldn't be loaded\n",
1301 gst_plugin_get_name (plugin));
1305 element = gst_element_factory_create (factory, NULL);
1307 g_print ("couldn't construct element for %s for some reason\n",
1308 GST_OBJECT_NAME (factory));
1309 gst_object_unref (factory);
1313 if (GST_IS_URI_HANDLER (element)) {
1314 const gchar *const *uri_protocols;
1315 const gchar *const *protocol;
1318 switch (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element))) {
1330 g_print ("%s%s%s (%s%s%s, %srank %u%s): ",
1332 gst_plugin_feature_get_name (GST_PLUGIN_FEATURE (factory)),
1333 RESET_COLOR, FEATURE_DIR_COLOR, dir, RESET_COLOR,
1335 gst_plugin_feature_get_rank (GST_PLUGIN_FEATURE (factory)),
1339 gst_uri_handler_get_protocols (GST_URI_HANDLER (element));
1340 for (protocol = uri_protocols; *protocol != NULL; protocol++) {
1341 if (protocol != uri_protocols)
1343 g_print ("%s%s%s", FEATURE_PROTO_COLOR, *protocol, RESET_COLOR);
1348 gst_object_unref (element);
1349 gst_object_unref (factory);
1353 gst_plugin_feature_list_free (features);
1356 gst_plugin_list_free (plugins);
1360 print_plugin_info (GstPlugin * plugin)
1362 const gchar *release_date = gst_plugin_get_release_date_string (plugin);
1363 const gchar *filename = gst_plugin_get_filename (plugin);
1365 n_print ("%sPlugin Details%s:\n", HEADING_COLOR, RESET_COLOR);
1369 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "Name", RESET_COLOR,
1370 PROP_VALUE_COLOR, gst_plugin_get_name (plugin), RESET_COLOR);
1371 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "Description", RESET_COLOR,
1372 PROP_VALUE_COLOR, gst_plugin_get_description (plugin), RESET_COLOR);
1373 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "Filename", RESET_COLOR,
1374 PROP_VALUE_COLOR, (filename != NULL) ? filename : "(null)", RESET_COLOR);
1375 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "Version", RESET_COLOR,
1376 PROP_VALUE_COLOR, gst_plugin_get_version (plugin), RESET_COLOR);
1377 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "License", RESET_COLOR,
1378 PROP_VALUE_COLOR, gst_plugin_get_license (plugin), RESET_COLOR);
1379 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "Source module", RESET_COLOR,
1380 PROP_VALUE_COLOR, gst_plugin_get_source (plugin), RESET_COLOR);
1382 if (release_date != NULL) {
1383 const gchar *tz = "(UTC)";
1386 /* may be: YYYY-MM-DD or YYYY-MM-DDTHH:MMZ */
1387 /* YYYY-MM-DDTHH:MMZ => YYYY-MM-DD HH:MM (UTC) */
1388 str = g_strdup (release_date);
1389 sep = strstr (str, "T");
1392 sep = strstr (sep + 1, "Z");
1398 n_print ("%s%-25s%s%s%s%s%s\n", PROP_NAME_COLOR, "Source release date",
1399 RESET_COLOR, PROP_VALUE_COLOR, str, tz, RESET_COLOR);
1402 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "Binary package", RESET_COLOR,
1403 PROP_VALUE_COLOR, gst_plugin_get_package (plugin), RESET_COLOR);
1404 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "Origin URL", RESET_COLOR,
1405 PROP_VALUE_COLOR, gst_plugin_get_origin (plugin), RESET_COLOR);
1413 print_plugin_features (GstPlugin * plugin)
1415 GList *features, *origlist;
1416 gint num_features = 0;
1417 gint num_elements = 0;
1418 gint num_tracers = 0;
1419 gint num_typefinders = 0;
1420 gint num_devproviders = 0;
1423 origlist = features =
1424 gst_registry_get_feature_list_by_plugin (gst_registry_get (),
1425 gst_plugin_get_name (plugin));
1428 GstPluginFeature *feature;
1430 feature = GST_PLUGIN_FEATURE (features->data);
1432 if (GST_IS_ELEMENT_FACTORY (feature)) {
1433 GstElementFactory *factory;
1435 factory = GST_ELEMENT_FACTORY (feature);
1436 n_print (" %s%s%s: %s%s%s\n", ELEMENT_NAME_COLOR,
1437 GST_OBJECT_NAME (factory), RESET_COLOR, ELEMENT_DETAIL_COLOR,
1438 gst_element_factory_get_metadata (factory,
1439 GST_ELEMENT_METADATA_LONGNAME), RESET_COLOR);
1441 } else if (GST_IS_TYPE_FIND_FACTORY (feature)) {
1442 GstTypeFindFactory *factory;
1443 const gchar *const *extensions;
1445 factory = GST_TYPE_FIND_FACTORY (feature);
1446 extensions = gst_type_find_factory_get_extensions (factory);
1448 g_print (" %s%s%s: ", ELEMENT_NAME_COLOR,
1449 gst_plugin_feature_get_name (feature), RESET_COLOR);
1450 print_typefind_extensions (extensions, ELEMENT_DETAIL_COLOR);
1453 g_print (" %s%s%s: %sno extensions%s\n", ELEMENT_NAME_COLOR,
1454 gst_plugin_feature_get_name (feature), RESET_COLOR,
1455 ELEMENT_DETAIL_COLOR, RESET_COLOR);
1458 } else if (GST_IS_DEVICE_PROVIDER_FACTORY (feature)) {
1459 GstDeviceProviderFactory *factory;
1461 factory = GST_DEVICE_PROVIDER_FACTORY (feature);
1462 n_print (" %s%s%s: %s%s%s\n", ELEMENT_NAME_COLOR,
1463 GST_OBJECT_NAME (factory), RESET_COLOR, ELEMENT_DETAIL_COLOR,
1464 gst_device_provider_factory_get_metadata (factory,
1465 GST_ELEMENT_METADATA_LONGNAME), RESET_COLOR);
1467 } else if (GST_IS_TRACER_FACTORY (feature)) {
1468 n_print (" %s%s%s (%s%s%s)\n", ELEMENT_NAME_COLOR,
1469 gst_object_get_name (GST_OBJECT (feature)), RESET_COLOR,
1470 DATATYPE_COLOR, g_type_name (G_OBJECT_TYPE (feature)), RESET_COLOR);
1472 } else if (feature) {
1473 n_print (" %s%s%s (%s%s%s)\n", ELEMENT_NAME_COLOR,
1474 gst_object_get_name (GST_OBJECT (feature)), RESET_COLOR,
1475 DATATYPE_COLOR, g_type_name (G_OBJECT_TYPE (feature)), RESET_COLOR);
1479 features = g_list_next (features);
1482 gst_plugin_feature_list_free (origlist);
1485 n_print (" %s%d features%s:\n", HEADING_COLOR, num_features, RESET_COLOR);
1486 if (num_elements > 0)
1487 n_print (" %s+--%s %s%d elements%s\n", CHILD_LINK_COLOR, RESET_COLOR,
1488 PLUGIN_FEATURE_COLOR, num_elements, RESET_COLOR);
1489 if (num_typefinders > 0)
1490 n_print (" %s+--%s %s%d typefinders%s\n", CHILD_LINK_COLOR, RESET_COLOR,
1491 PLUGIN_FEATURE_COLOR, num_typefinders, RESET_COLOR);
1492 if (num_devproviders > 0)
1493 n_print (" %s+--%s %s%d device providers%s\n", CHILD_LINK_COLOR,
1494 RESET_COLOR, PLUGIN_FEATURE_COLOR, num_devproviders, RESET_COLOR);
1495 if (num_tracers > 0)
1496 n_print (" %s+--%s %s%d tracers%s\n", CHILD_LINK_COLOR, RESET_COLOR,
1497 PLUGIN_FEATURE_COLOR, num_tracers, RESET_COLOR);
1499 n_print (" %s+--%s %s%d other objects%s\n", CHILD_LINK_COLOR, RESET_COLOR,
1500 PLUGIN_FEATURE_COLOR, num_other, RESET_COLOR);
1506 print_feature_info (const gchar * feature_name, gboolean print_all)
1508 GstPluginFeature *feature;
1509 GstRegistry *registry = gst_registry_get ();
1512 if ((feature = gst_registry_find_feature (registry, feature_name,
1513 GST_TYPE_ELEMENT_FACTORY))) {
1514 ret = print_element_info (feature, print_all);
1517 if ((feature = gst_registry_find_feature (registry, feature_name,
1518 GST_TYPE_TYPE_FIND_FACTORY))) {
1519 ret = print_typefind_info (feature, print_all);
1522 if ((feature = gst_registry_find_feature (registry, feature_name,
1523 GST_TYPE_TRACER_FACTORY))) {
1524 ret = print_tracer_info (feature, print_all);
1528 /* TODO: handle DEVICE_PROVIDER_FACTORY */
1533 gst_object_unref (feature);
1538 print_element_info (GstPluginFeature * feature, gboolean print_names)
1540 GstElementFactory *factory;
1541 GstElement *element;
1545 factory = GST_ELEMENT_FACTORY (gst_plugin_feature_load (feature));
1547 g_print ("%selement plugin couldn't be loaded%s\n", DESC_COLOR,
1552 element = gst_element_factory_create (factory, NULL);
1554 gst_object_unref (factory);
1555 g_print ("%scouldn't construct element for some reason%s\n", DESC_COLOR,
1562 g_strdup_printf ("%s%s%s: ", DATATYPE_COLOR, GST_OBJECT_NAME (factory),
1567 print_factory_details_info (factory);
1569 plugin = gst_plugin_feature_get_plugin (GST_PLUGIN_FEATURE (factory));
1571 print_plugin_info (plugin);
1572 gst_object_unref (plugin);
1575 print_hierarchy (G_OBJECT_TYPE (element), 0, &maxlevel);
1576 print_interfaces (G_OBJECT_TYPE (element));
1578 print_pad_templates_info (element, factory);
1579 print_clocking_info (element);
1580 print_uri_handler_info (element);
1581 print_pad_info (element);
1582 print_element_properties_info (element);
1583 print_signal_info (element);
1584 print_children_info (element);
1585 print_preset_list (element);
1587 gst_object_unref (element);
1588 gst_object_unref (factory);
1594 print_typefind_info (GstPluginFeature * feature, gboolean print_names)
1596 GstTypeFindFactory *factory;
1601 const gchar *const *extensions;
1603 factory = GST_TYPE_FIND_FACTORY (gst_plugin_feature_load (feature));
1605 g_print ("%stypefind plugin couldn't be loaded%s\n", DESC_COLOR,
1612 g_strdup_printf ("%s%s%s: ", DATATYPE_COLOR, GST_OBJECT_NAME (factory),
1617 n_print ("%sFactory Details%s:\n", HEADING_COLOR, RESET_COLOR);
1618 rank = gst_plugin_feature_get_rank (feature);
1619 n_print (" %s%-25s%s%s (%d)%s\n", PROP_NAME_COLOR, "Rank", PROP_VALUE_COLOR,
1620 get_rank_name (s, rank), rank, RESET_COLOR);
1621 n_print (" %s%-25s%s%s%s\n", PROP_NAME_COLOR, "Name", PROP_VALUE_COLOR,
1622 GST_OBJECT_NAME (factory), RESET_COLOR);
1623 caps = gst_type_find_factory_get_caps (factory);
1625 gchar *caps_str = gst_caps_to_string (factory->caps);
1627 n_print (" %s%-25s%s%s%s\n", PROP_NAME_COLOR, "Caps", PROP_VALUE_COLOR,
1628 caps_str, RESET_COLOR);
1631 extensions = gst_type_find_factory_get_extensions (factory);
1633 n_print (" %s%-25s%s", PROP_NAME_COLOR, "Extensions", RESET_COLOR);
1634 print_typefind_extensions (extensions, PROP_VALUE_COLOR);
1639 plugin = gst_plugin_feature_get_plugin (GST_PLUGIN_FEATURE (factory));
1641 print_plugin_info (plugin);
1642 gst_object_unref (plugin);
1645 gst_object_unref (factory);
1651 print_tracer_info (GstPluginFeature * feature, gboolean print_names)
1653 GstTracerFactory *factory;
1658 factory = GST_TRACER_FACTORY (gst_plugin_feature_load (feature));
1660 g_print ("%stracer plugin couldn't be loaded%s\n", DESC_COLOR, RESET_COLOR);
1664 tracer = (GstTracer *) g_object_new (factory->type, NULL);
1666 gst_object_unref (factory);
1667 g_print ("%scouldn't construct tracer for some reason%s\n", DESC_COLOR,
1674 g_strdup_printf ("%s%s%s: ", DATATYPE_COLOR, GST_OBJECT_NAME (factory),
1679 n_print ("%sFactory Details%s:\n", HEADING_COLOR, RESET_COLOR);
1680 n_print (" %s%-25s%s%s%s\n", PROP_NAME_COLOR, "Name", PROP_VALUE_COLOR,
1681 GST_OBJECT_NAME (factory), RESET_COLOR);
1684 plugin = gst_plugin_feature_get_plugin (GST_PLUGIN_FEATURE (factory));
1686 print_plugin_info (plugin);
1687 gst_object_unref (plugin);
1690 print_hierarchy (G_OBJECT_TYPE (tracer), 0, &maxlevel);
1691 print_interfaces (G_OBJECT_TYPE (tracer));
1693 /* TODO: list what hooks it registers
1694 * - the data is available in gsttracerutils, we need to iterate the
1695 * _priv_tracers hashtable for each probe and then check the list of hooks
1696 * for each probe whether hook->tracer == tracer :/
1699 /* TODO: list what records it emits
1700 * - in class_init tracers can create GstTracerRecord instances
1701 * - those only get logged right now and there is no association with the
1702 * tracer that created them
1703 * - we'd need to add them to GstTracerFactory
1704 * gst_tracer_class_add_record (klass, record);
1705 * - needs work in gstregistrychunks to (de)serialize specs
1706 * - gst_tracer_register() would need to iterate the list of records and
1707 * copy the record->spec into the factory
1710 gst_object_unref (tracer);
1711 gst_object_unref (factory);
1716 /* NOTE: Not coloring output from automatic install functions, as their output
1717 * is meant for machines, not humans.
1720 print_plugin_automatic_install_info_codecs (GstElementFactory * factory)
1722 GstPadDirection direction;
1723 const gchar *type_name;
1725 const GList *static_templates, *l;
1726 GstCaps *caps = NULL;
1730 gst_element_factory_get_metadata (factory, GST_ELEMENT_METADATA_KLASS);
1731 g_return_if_fail (klass != NULL);
1733 if (strstr (klass, "Demuxer") ||
1734 strstr (klass, "Decoder") ||
1735 strstr (klass, "Depay") || strstr (klass, "Parser")) {
1736 type_name = "decoder";
1737 direction = GST_PAD_SINK;
1738 } else if (strstr (klass, "Muxer") ||
1739 strstr (klass, "Encoder") || strstr (klass, "Pay")) {
1740 type_name = "encoder";
1741 direction = GST_PAD_SRC;
1746 /* decoder/demuxer sink pads should always be static and there should only
1747 * be one, the same applies to encoders/muxers and source pads */
1748 static_templates = gst_element_factory_get_static_pad_templates (factory);
1749 for (l = static_templates; l != NULL; l = l->next) {
1750 GstStaticPadTemplate *tmpl = NULL;
1752 tmpl = (GstStaticPadTemplate *) l->data;
1753 if (tmpl->direction == direction) {
1754 caps = gst_static_pad_template_get_caps (tmpl);
1760 g_printerr ("Couldn't find static pad template for %s '%s'\n",
1761 type_name, GST_OBJECT_NAME (factory));
1765 caps = gst_caps_make_writable (caps);
1766 num = gst_caps_get_size (caps);
1767 for (i = 0; i < num; ++i) {
1771 s = gst_caps_get_structure (caps, i);
1772 /* remove fields that are almost always just MIN-MAX of some sort
1773 * in order to make the caps look less messy */
1774 gst_structure_remove_field (s, "pixel-aspect-ratio");
1775 gst_structure_remove_field (s, "framerate");
1776 gst_structure_remove_field (s, "channels");
1777 gst_structure_remove_field (s, "width");
1778 gst_structure_remove_field (s, "height");
1779 gst_structure_remove_field (s, "rate");
1780 gst_structure_remove_field (s, "depth");
1781 gst_structure_remove_field (s, "clock-rate");
1782 s_str = gst_structure_to_string (s);
1783 g_print ("%s-%s\n", type_name, s_str);
1786 gst_caps_unref (caps);
1790 print_plugin_automatic_install_info_protocols (GstElementFactory * factory)
1792 const gchar *const *protocols;
1794 protocols = gst_element_factory_get_uri_protocols (factory);
1795 if (protocols != NULL && *protocols != NULL) {
1796 switch (gst_element_factory_get_uri_type (factory)) {
1798 while (*protocols != NULL) {
1799 g_print ("urisink-%s\n", *protocols);
1804 while (*protocols != NULL) {
1805 g_print ("urisource-%s\n", *protocols);
1816 print_plugin_automatic_install_info (GstPlugin * plugin)
1818 GList *features, *l;
1820 /* not interested in typefind factories, only element factories */
1821 features = gst_registry_get_feature_list (gst_registry_get (),
1822 GST_TYPE_ELEMENT_FACTORY);
1824 for (l = features; l != NULL; l = l->next) {
1825 GstPluginFeature *feature;
1826 GstPlugin *feature_plugin;
1828 feature = GST_PLUGIN_FEATURE (l->data);
1830 /* only interested in the ones that are in the plugin we just loaded */
1831 feature_plugin = gst_plugin_feature_get_plugin (feature);
1832 if (feature_plugin == plugin) {
1833 GstElementFactory *factory;
1835 g_print ("element-%s\n", gst_plugin_feature_get_name (feature));
1837 factory = GST_ELEMENT_FACTORY (feature);
1838 print_plugin_automatic_install_info_protocols (factory);
1839 print_plugin_automatic_install_info_codecs (factory);
1842 gst_object_unref (feature_plugin);
1845 g_list_foreach (features, (GFunc) gst_object_unref, NULL);
1846 g_list_free (features);
1850 print_all_plugin_automatic_install_info (void)
1852 GList *plugins, *orig_plugins;
1854 orig_plugins = plugins = gst_registry_get_plugin_list (gst_registry_get ());
1858 plugin = (GstPlugin *) (plugins->data);
1859 plugins = g_list_next (plugins);
1861 print_plugin_automatic_install_info (plugin);
1863 gst_plugin_list_free (orig_plugins);
1868 redirect_stdout (void)
1873 if (pipe (pipefd) == -1) {
1874 g_printerr (_("Error creating pipe: %s\n"), g_strerror (errno));
1879 if (child_id == -1) {
1880 g_printerr (_("Error forking: %s\n"), g_strerror (errno));
1884 if (child_id == 0) {
1889 pager = g_getenv ("PAGER");
1891 pager = DEFAULT_PAGER;
1892 argv = g_strsplit (pager, " ", 0);
1896 dup2 (pipefd[0], STDIN_FILENO);
1899 ret = execvp (argv[0], argv);
1902 /* No less? Let's just dump everything to stdout then */
1908 if ((ret = read (STDIN_FILENO, buffer, sizeof (buffer))) == -1) {
1909 if (errno == EINTR || errno == EAGAIN) {
1913 g_printerr (_("Error reading from console: %s\n"),
1914 g_strerror (errno));
1919 bytes_written = write (STDOUT_FILENO, buffer, ret);
1920 } while (bytes_written == -1 && (errno == EINTR || errno == EAGAIN));
1922 if (bytes_written < 0) {
1923 g_printerr (_("Error writing to console: %s\n"), g_strerror (errno));
1932 dup2 (pipefd[1], STDOUT_FILENO);
1933 if (isatty (STDERR_FILENO))
1934 dup2 (pipefd[1], STDERR_FILENO);
1936 close (STDIN_FILENO);
1942 main (int argc, char *argv[])
1944 gboolean print_all = FALSE;
1945 gboolean do_print_blacklist = FALSE;
1946 gboolean plugin_name = FALSE;
1947 gboolean print_aii = FALSE;
1948 gboolean uri_handlers = FALSE;
1949 gboolean check_exists = FALSE;
1950 gchar *min_version = NULL;
1951 guint minver_maj = GST_VERSION_MAJOR;
1952 guint minver_min = GST_VERSION_MINOR;
1953 guint minver_micro = 0;
1954 gchar *types = NULL;
1955 const gchar *no_colors;
1956 #ifndef GST_DISABLE_OPTION_PARSING
1957 GOptionEntry options[] = {
1958 {"print-all", 'a', 0, G_OPTION_ARG_NONE, &print_all,
1959 N_("Print all elements"), NULL},
1960 {"print-blacklist", 'b', 0, G_OPTION_ARG_NONE, &do_print_blacklist,
1961 N_("Print list of blacklisted files"), NULL},
1962 {"print-plugin-auto-install-info", '\0', 0, G_OPTION_ARG_NONE, &print_aii,
1963 N_("Print a machine-parsable list of features the specified plugin "
1964 "or all plugins provide.\n "
1965 "Useful in connection with external automatic plugin "
1966 "installation mechanisms"), NULL},
1967 {"plugin", '\0', 0, G_OPTION_ARG_NONE, &plugin_name,
1968 N_("List the plugin contents"), NULL},
1969 {"types", 't', 0, G_OPTION_ARG_STRING, &types,
1970 N_("A slashes ('/') separated list of types of elements (also known "
1971 "as klass) to list. (unordered)"), NULL},
1972 {"exists", '\0', 0, G_OPTION_ARG_NONE, &check_exists,
1973 N_("Check if the specified element or plugin exists"), NULL},
1974 {"atleast-version", '\0', 0, G_OPTION_ARG_STRING, &min_version,
1976 ("When checking if an element or plugin exists, also check that its "
1977 "version is at least the version specified"), NULL},
1978 {"uri-handlers", 'u', 0, G_OPTION_ARG_NONE, &uri_handlers,
1980 ("Print supported URI schemes, with the elements that implement them"),
1982 {"no-colors", '\0', G_OPTION_FLAG_REVERSE, G_OPTION_ARG_NONE,
1985 ("Disable colors in output. You can also achieve the same by setting"
1986 "'GST_INSPECT_NO_COLORS' environment variable to any value."),
1988 GST_TOOLS_GOPTION_VERSION,
1991 GOptionContext *ctx;
1995 setlocale (LC_ALL, "");
1998 bindtextdomain (GETTEXT_PACKAGE, LOCALEDIR);
1999 bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
2000 textdomain (GETTEXT_PACKAGE);
2003 /* avoid glib warnings when inspecting deprecated properties */
2004 g_setenv ("G_ENABLE_DIAGNOSTIC", "0", FALSE);
2006 g_set_prgname ("gst-inspect-" GST_API_VERSION);
2008 #ifndef GST_DISABLE_OPTION_PARSING
2009 ctx = g_option_context_new ("[ELEMENT-NAME | PLUGIN-NAME]");
2010 g_option_context_add_main_entries (ctx, options, GETTEXT_PACKAGE);
2011 g_option_context_add_group (ctx, gst_init_get_option_group ());
2012 if (!g_option_context_parse (ctx, &argc, &argv, &err)) {
2013 g_printerr ("Error initializing: %s\n", err->message);
2014 g_clear_error (&err);
2015 g_option_context_free (ctx);
2018 g_option_context_free (ctx);
2020 gst_init (&argc, &argv);
2023 no_colors = g_getenv ("GST_INSPECT_NO_COLORS");
2024 /* We only support truecolor */
2025 colored_output &= (no_colors == NULL);
2028 if (isatty (STDOUT_FILENO)) {
2033 gst_tools_print_version ();
2035 if (print_all && argc > 1) {
2036 g_printerr ("-a requires no extra arguments\n");
2040 if (uri_handlers && argc > 1) {
2041 g_printerr ("-u requires no extra arguments\n");
2045 /* --atleast-version implies --exists */
2046 if (min_version != NULL) {
2047 if (sscanf (min_version, "%u.%u.%u", &minver_maj, &minver_min,
2048 &minver_micro) < 2) {
2049 g_printerr ("Can't parse version '%s' passed to --atleast-version\n",
2053 check_exists = TRUE;
2060 g_printerr ("--exists requires an extra command line argument\n");
2064 GstPluginFeature *feature;
2066 feature = gst_registry_lookup_feature (gst_registry_get (), argv[1]);
2067 if (feature != NULL && gst_plugin_feature_check_version (feature,
2068 minver_maj, minver_min, minver_micro)) {
2075 gst_object_unref (feature);
2077 /* FIXME: support checking for plugins too */
2078 g_printerr ("Checking for plugins is not supported yet\n");
2085 /* if no arguments, print out list of elements */
2087 print_all_uri_handlers ();
2088 } else if (argc == 1 || print_all) {
2089 if (do_print_blacklist)
2093 print_all_plugin_automatic_install_info ();
2095 print_element_list (print_all, types);
2098 /* else we try to get a factory */
2099 const char *arg = argv[argc - 1];
2103 retval = print_feature_info (arg, print_all);
2106 /* otherwise check if it's a plugin */
2108 GstPlugin *plugin = gst_registry_find_plugin (gst_registry_get (), arg);
2110 /* if there is such a plugin, print out info */
2113 print_plugin_automatic_install_info (plugin);
2115 print_plugin_info (plugin);
2116 print_plugin_features (plugin);
2119 GError *error = NULL;
2121 if (g_file_test (arg, G_FILE_TEST_EXISTS)) {
2122 plugin = gst_plugin_load_file (arg, &error);
2126 print_plugin_automatic_install_info (plugin);
2128 print_plugin_info (plugin);
2129 print_plugin_features (plugin);
2132 g_printerr (_("Could not load plugin file: %s\n"), error->message);
2133 g_clear_error (&error);
2137 g_printerr (_("No such element or plugin '%s'\n"), arg);
2147 /* So that the pipe we create in redirect_stdout() is closed */
2148 close (STDOUT_FILENO);
2149 close (STDERR_FILENO);