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"
45 #define DEFAULT_LESS_OPTS "FXR"
47 gboolean colored_output = TRUE;
51 /* Escape values for colors */
52 #define BLUE "\033[34m"
53 #define BRBLUE "\033[94m"
54 #define BRCYAN "\033[96m"
55 #define BRMAGENTA "\033[95m"
56 #define BRYELLOW "\033[33m"
57 #define CYAN "\033[36m"
58 #define GREEN "\033[32m"
59 #define MAGENTA "\033[35m"
60 #define YELLOW "\033[33m"
63 #define RESET_COLOR (colored_output? "\033[0m": "")
64 #define HEADING_COLOR (colored_output? BRYELLOW : "")
65 #define PROP_NAME_COLOR (colored_output? BRBLUE : "")
66 #define PROP_VALUE_COLOR (colored_output? RESET_COLOR: "")
67 #define PROP_ATTR_NAME_COLOR (colored_output? BRYELLOW : "")
68 #define PROP_ATTR_VALUE_COLOR (colored_output? CYAN: "")
69 /* FIXME: find a good color that works on both dark & light bg. */
70 #define DESC_COLOR (colored_output? RESET_COLOR: "")
72 /* Datatype-related colors */
73 #define DATATYPE_COLOR (colored_output? GREEN : "")
74 #define CHILD_LINK_COLOR (colored_output? BRMAGENTA : "")
77 #define FIELD_NAME_COLOR (colored_output? CYAN: "")
78 #define FIELD_VALUE_COLOR (colored_output? BRBLUE : "")
79 #define CAPS_TYPE_COLOR (colored_output? YELLOW : "")
80 #define STRUCT_NAME_COLOR (colored_output? YELLOW : "")
81 #define CAPS_FEATURE_COLOR (colored_output? GREEN : "")
83 /* Plugin listing colors */
84 #define PLUGIN_NAME_COLOR (colored_output? BRBLUE : "")
85 #define ELEMENT_NAME_COLOR (colored_output? GREEN : "")
86 /* FIXME: find a good color that works on both dark & light bg. */
87 #define ELEMENT_DETAIL_COLOR (colored_output? RESET_COLOR : "")
88 #define PLUGIN_FEATURE_COLOR (colored_output? BRBLUE: "")
90 /* Feature listing colors */
91 #define FEATURE_NAME_COLOR (colored_output? GREEN : "")
92 #define FEATURE_DIR_COLOR (colored_output? BRMAGENTA : "")
93 #define FEATURE_RANK_COLOR (colored_output? CYAN : "")
94 #define FEATURE_PROTO_COLOR (colored_output? BRYELLOW : "")
96 static char *_name = NULL;
97 static int indent = 0;
99 static int print_element_info (GstPluginFeature * feature,
100 gboolean print_names);
101 static int print_typefind_info (GstPluginFeature * feature,
102 gboolean print_names);
103 static int print_tracer_info (GstPluginFeature * feature, gboolean print_names);
105 #define push_indent() push_indent_n(1)
106 #define pop_indent() push_indent_n(-1)
107 #define pop_indent_n(n) push_indent_n(-n)
110 push_indent_n (int n)
112 g_assert (n > 0 || indent > 0);
121 n_print (const char *format, ...)
127 g_print ("%s", _name);
129 for (i = 0; i < indent; ++i)
132 va_start (args, format);
133 g_vprintf (format, args);
138 print_field (GQuark field, const GValue * value, gpointer pfx)
140 gchar *str = gst_value_serialize (value);
142 n_print ("%s %s%15s%s: %s%s%s\n",
143 (gchar *) pfx, FIELD_NAME_COLOR, g_quark_to_string (field), RESET_COLOR,
144 FIELD_VALUE_COLOR, str, RESET_COLOR);
150 print_caps (const GstCaps * caps, const gchar * pfx)
154 g_return_if_fail (caps != NULL);
156 if (gst_caps_is_any (caps)) {
157 n_print ("%s%sANY%s\n", CAPS_TYPE_COLOR, pfx, RESET_COLOR);
160 if (gst_caps_is_empty (caps)) {
161 n_print ("%s%sEMPTY%s\n", CAPS_TYPE_COLOR, pfx, RESET_COLOR);
165 for (i = 0; i < gst_caps_get_size (caps); i++) {
166 GstStructure *structure = gst_caps_get_structure (caps, i);
167 GstCapsFeatures *features = gst_caps_get_features (caps, i);
169 if (features && (gst_caps_features_is_any (features) ||
170 !gst_caps_features_is_equal (features,
171 GST_CAPS_FEATURES_MEMORY_SYSTEM_MEMORY))) {
172 gchar *features_string = gst_caps_features_to_string (features);
174 n_print ("%s%s%s%s(%s%s%s)\n", pfx, STRUCT_NAME_COLOR,
175 gst_structure_get_name (structure), RESET_COLOR,
176 CAPS_FEATURE_COLOR, features_string, RESET_COLOR);
177 g_free (features_string);
179 n_print ("%s%s%s%s\n", pfx, STRUCT_NAME_COLOR,
180 gst_structure_get_name (structure), RESET_COLOR);
182 gst_structure_foreach (structure, print_field, (gpointer) pfx);
187 get_rank_name (char *s, gint rank)
189 static const int ranks[4] = {
190 GST_RANK_NONE, GST_RANK_MARGINAL, GST_RANK_SECONDARY, GST_RANK_PRIMARY
192 static const char *rank_names[4] = { "none", "marginal", "secondary",
199 for (i = 0; i < 4; i++) {
200 if (rank == ranks[i])
201 return rank_names[i];
202 if (abs (rank - ranks[i]) < abs (rank - ranks[best_i])) {
207 sprintf (s, "%s %c %d", rank_names[best_i],
208 (rank - ranks[best_i] > 0) ? '+' : '-', abs (ranks[best_i] - rank));
214 print_factory_details_info (GstElementFactory * factory)
220 rank = gst_plugin_feature_get_rank (GST_PLUGIN_FEATURE (factory));
221 n_print ("%sFactory Details:%s\n", HEADING_COLOR, RESET_COLOR);
224 n_print ("%s%-25s%s%s (%d)%s\n", PROP_NAME_COLOR, "Rank", PROP_VALUE_COLOR,
225 get_rank_name (s, rank), rank, RESET_COLOR);
227 keys = gst_element_factory_get_metadata_keys (factory);
229 for (k = keys; *k != NULL; ++k) {
233 val = gst_element_factory_get_metadata (factory, key);
234 key[0] = g_ascii_toupper (key[0]);
235 n_print ("%s%-25s%s%s%s\n", PROP_NAME_COLOR, key, PROP_VALUE_COLOR, val,
245 print_hierarchy (GType type, gint level, gint * maxlevel)
250 parent = g_type_parent (type);
252 *maxlevel = *maxlevel + 1;
256 print_hierarchy (parent, level, maxlevel);
259 g_print ("%s%s%s", DATATYPE_COLOR, _name, RESET_COLOR);
261 for (i = 1; i < *maxlevel - level; i++)
263 if (*maxlevel - level)
264 g_print (" %s+----%s", CHILD_LINK_COLOR, RESET_COLOR);
266 g_print ("%s%s%s\n", DATATYPE_COLOR, g_type_name (type), RESET_COLOR);
273 print_interfaces (GType type)
276 GType *iface, *ifaces = g_type_interfaces (type, &n_ifaces);
280 n_print (_("%sImplemented Interfaces%s:\n"), HEADING_COLOR, RESET_COLOR);
284 n_print ("%s%s%s\n", DATATYPE_COLOR, g_type_name (*iface), RESET_COLOR);
295 flags_to_string (GFlagsValue * vals, guint flags)
300 /* first look for an exact match and count the number of values */
301 for (i = 0; vals[i].value_name != NULL; ++i) {
302 if (vals[i].value == flags)
303 return g_strdup (vals[i].value_nick);
306 s = g_string_new (NULL);
308 /* we assume the values are sorted from lowest to highest value */
312 if (vals[i].value != 0 && (flags_left & vals[i].value) == vals[i].value) {
314 g_string_append_c (s, '+');
315 g_string_append (s, vals[i].value_nick);
316 flags_left -= vals[i].value;
323 g_string_assign (s, "(none)");
325 return g_string_free (s, FALSE);
328 #define KNOWN_PARAM_FLAGS \
329 (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY | \
330 G_PARAM_LAX_VALIDATION | G_PARAM_STATIC_STRINGS | \
331 G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_DEPRECATED | \
332 GST_PARAM_CONTROLLABLE | GST_PARAM_MUTABLE_PLAYING | \
333 GST_PARAM_MUTABLE_PAUSED | GST_PARAM_MUTABLE_READY)
336 sort_gparamspecs (GParamSpec ** a, GParamSpec ** b)
338 return g_strcmp0 (g_param_spec_get_name (*a), g_param_spec_get_name (*b));
341 /* obj will be NULL if we're printing properties of pad template pads */
343 print_object_properties_info (GObject * obj, GObjectClass * obj_class,
346 GParamSpec **property_specs;
347 guint num_properties, i;
351 property_specs = g_object_class_list_properties (obj_class, &num_properties);
352 g_qsort_with_data (property_specs, num_properties, sizeof (gpointer),
353 (GCompareDataFunc) sort_gparamspecs, NULL);
355 n_print ("%s%s%s:\n", HEADING_COLOR, desc, RESET_COLOR);
359 for (i = 0; i < num_properties; i++) {
360 GValue value = { 0, };
361 GParamSpec *param = property_specs[i];
362 GType owner_type = param->owner_type;
364 /* We're printing pad properties */
365 if (obj == NULL && (owner_type == G_TYPE_OBJECT
366 || owner_type == GST_TYPE_OBJECT || owner_type == GST_TYPE_PAD))
369 g_value_init (&value, param->value_type);
371 n_print ("%s%-20s%s: %s%s%s\n", PROP_NAME_COLOR,
372 g_param_spec_get_name (param), RESET_COLOR, PROP_VALUE_COLOR,
373 g_param_spec_get_blurb (param), RESET_COLOR);
378 n_print ("%sflags%s: ", PROP_ATTR_NAME_COLOR, RESET_COLOR);
379 readable = ! !(param->flags & G_PARAM_READABLE);
380 if (readable && obj != NULL) {
381 g_object_get_property (obj, param->name, &value);
383 /* if we can't read the property value, assume it's set to the default
384 * (which might not be entirely true for sub-classes, but that's an
385 * unlikely corner-case anyway) */
386 g_param_value_set_default (param, &value);
389 g_print ("%s%s%s%s", (first_flag) ? "" : ", ", PROP_ATTR_VALUE_COLOR,
390 _("readable"), RESET_COLOR);
393 if (param->flags & G_PARAM_WRITABLE) {
394 g_print ("%s%s%s%s", (first_flag) ? "" : ", ", PROP_ATTR_VALUE_COLOR,
395 _("writable"), RESET_COLOR);
398 if (param->flags & G_PARAM_DEPRECATED) {
399 g_print ("%s%s%s%s", (first_flag) ? "" : ", ", PROP_ATTR_VALUE_COLOR,
400 _("deprecated"), RESET_COLOR);
403 if (param->flags & GST_PARAM_CONTROLLABLE) {
404 g_print (", %s%s%s", PROP_ATTR_VALUE_COLOR, _("controllable"),
408 if (param->flags & GST_PARAM_MUTABLE_PLAYING) {
409 g_print (", %s%s%s", PROP_ATTR_VALUE_COLOR,
410 _("changeable in NULL, READY, PAUSED or PLAYING state"), RESET_COLOR);
411 } else if (param->flags & GST_PARAM_MUTABLE_PAUSED) {
412 g_print (", %s%s%s", PROP_ATTR_VALUE_COLOR,
413 _("changeable only in NULL, READY or PAUSED state"), RESET_COLOR);
414 } else if (param->flags & GST_PARAM_MUTABLE_READY) {
415 g_print (", %s%s%s", PROP_ATTR_VALUE_COLOR,
416 _("changeable only in NULL or READY state"), RESET_COLOR);
418 if (param->flags & ~KNOWN_PARAM_FLAGS) {
419 g_print ("%s0x%s%0x%s", (first_flag) ? "" : ", ", PROP_ATTR_VALUE_COLOR,
420 param->flags & ~KNOWN_PARAM_FLAGS, RESET_COLOR);
424 switch (G_VALUE_TYPE (&value)) {
427 const char *string_val = g_value_get_string (&value);
429 n_print ("%sString%s. ", DATATYPE_COLOR, RESET_COLOR);
431 if (string_val == NULL)
432 g_print ("%sDefault%s: %snull%s", PROP_ATTR_NAME_COLOR, RESET_COLOR,
433 PROP_ATTR_VALUE_COLOR, RESET_COLOR);
435 g_print ("%sDefault%s: %s\"%s\"%s", PROP_ATTR_NAME_COLOR, RESET_COLOR,
436 PROP_ATTR_VALUE_COLOR, string_val, RESET_COLOR);
441 gboolean bool_val = g_value_get_boolean (&value);
443 n_print ("%sBoolean%s. %sDefault%s: %s%s%s", DATATYPE_COLOR,
444 RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
445 PROP_ATTR_VALUE_COLOR, bool_val ? "true" : "false", RESET_COLOR);
450 GParamSpecULong *pulong = G_PARAM_SPEC_ULONG (param);
453 ("%sUnsigned Long%s. %sRange%s: %s%lu - %lu%s %sDefault%s: %s%lu%s ",
454 DATATYPE_COLOR, RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
455 PROP_ATTR_VALUE_COLOR, pulong->minimum, pulong->maximum,
456 RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
457 PROP_ATTR_VALUE_COLOR, g_value_get_ulong (&value), RESET_COLOR);
459 GST_ERROR ("%s: property '%s' of type ulong: consider changing to "
460 "uint/uint64", G_OBJECT_CLASS_NAME (obj_class),
461 g_param_spec_get_name (param));
466 GParamSpecLong *plong = G_PARAM_SPEC_LONG (param);
468 n_print ("%sLong%s. %sRange%s: %s%ld - %ld%s %sDefault%s: %s%ld%s ",
469 DATATYPE_COLOR, RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
470 PROP_ATTR_VALUE_COLOR, plong->minimum, plong->maximum, RESET_COLOR,
471 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
472 g_value_get_long (&value), RESET_COLOR);
474 GST_ERROR ("%s: property '%s' of type long: consider changing to "
475 "int/int64", G_OBJECT_CLASS_NAME (obj_class),
476 g_param_spec_get_name (param));
481 GParamSpecUInt *puint = G_PARAM_SPEC_UINT (param);
484 ("%sUnsigned Integer%s. %sRange%s: %s%u - %u%s %sDefault%s: %s%u%s ",
485 DATATYPE_COLOR, RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
486 PROP_ATTR_VALUE_COLOR, puint->minimum, puint->maximum, RESET_COLOR,
487 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
488 g_value_get_uint (&value), RESET_COLOR);
493 GParamSpecInt *pint = G_PARAM_SPEC_INT (param);
495 n_print ("%sInteger%s. %sRange%s: %s%d - %d%s %sDefault%s: %s%d%s ",
496 DATATYPE_COLOR, RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
497 PROP_ATTR_VALUE_COLOR, pint->minimum, pint->maximum, RESET_COLOR,
498 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
499 g_value_get_int (&value), RESET_COLOR);
504 GParamSpecUInt64 *puint64 = G_PARAM_SPEC_UINT64 (param);
506 n_print ("%sUnsigned Integer64%s. %sRange%s: %s%" G_GUINT64_FORMAT " - "
507 "%" G_GUINT64_FORMAT "%s %sDefault%s: %s%" G_GUINT64_FORMAT "%s ",
508 DATATYPE_COLOR, RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
509 PROP_ATTR_VALUE_COLOR, puint64->minimum, puint64->maximum,
510 RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
511 PROP_ATTR_VALUE_COLOR, g_value_get_uint64 (&value), RESET_COLOR);
516 GParamSpecInt64 *pint64 = G_PARAM_SPEC_INT64 (param);
518 n_print ("%sInteger64%s. %sRange%s: %s%" G_GINT64_FORMAT " - %"
519 G_GINT64_FORMAT "%s %sDefault%s: %s%" G_GINT64_FORMAT "%s ",
520 DATATYPE_COLOR, RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
521 PROP_ATTR_VALUE_COLOR, pint64->minimum, pint64->maximum,
522 RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
523 PROP_ATTR_VALUE_COLOR, g_value_get_int64 (&value), RESET_COLOR);
528 GParamSpecFloat *pfloat = G_PARAM_SPEC_FLOAT (param);
530 n_print ("%sFloat%s. %sRange%s: %s%15.7g - %15.7g%s "
531 "%sDefault%s: %s%15.7g%s ", DATATYPE_COLOR, RESET_COLOR,
532 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
533 pfloat->minimum, pfloat->maximum, RESET_COLOR, PROP_ATTR_NAME_COLOR,
534 RESET_COLOR, PROP_ATTR_VALUE_COLOR, g_value_get_float (&value),
540 GParamSpecDouble *pdouble = G_PARAM_SPEC_DOUBLE (param);
542 n_print ("%sDouble%s. %sRange%s: %s%15.7g - %15.7g%s "
543 "%sDefault%s: %s%15.7g%s ", DATATYPE_COLOR, RESET_COLOR,
544 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
545 pdouble->minimum, pdouble->maximum, RESET_COLOR,
546 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
547 g_value_get_double (&value), RESET_COLOR);
552 GST_ERROR ("%s: property '%s' of type char: consider changing to "
553 "int/string", G_OBJECT_CLASS_NAME (obj_class),
554 g_param_spec_get_name (param));
557 if (param->value_type == GST_TYPE_CAPS) {
558 const GstCaps *caps = gst_value_get_caps (&value);
561 n_print ("%sCaps%s (NULL)", DATATYPE_COLOR, RESET_COLOR);
563 print_caps (caps, " ");
565 } else if (G_IS_PARAM_SPEC_ENUM (param)) {
569 const gchar *value_nick = "";
571 values = G_ENUM_CLASS (g_type_class_ref (param->value_type))->values;
572 enum_value = g_value_get_enum (&value);
574 while (values[j].value_name) {
575 if (values[j].value == enum_value)
576 value_nick = values[j].value_nick;
580 n_print ("%sEnum \"%s\"%s %sDefault%s: %s%d, \"%s\"%s",
581 DATATYPE_COLOR, g_type_name (G_VALUE_TYPE (&value)), RESET_COLOR,
582 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
583 enum_value, value_nick, RESET_COLOR);
586 while (values[j].value_name) {
588 n_print (" %s(%d)%s: %s%-16s%s - %s%s%s",
589 PROP_ATTR_NAME_COLOR, values[j].value, RESET_COLOR,
590 PROP_ATTR_VALUE_COLOR, values[j].value_nick, RESET_COLOR,
591 DESC_COLOR, values[j].value_name, RESET_COLOR);
594 /* g_type_class_unref (ec); */
595 } else if (G_IS_PARAM_SPEC_FLAGS (param)) {
596 GParamSpecFlags *pflags = G_PARAM_SPEC_FLAGS (param);
600 vals = pflags->flags_class->values;
602 cur = flags_to_string (vals, g_value_get_flags (&value));
604 n_print ("%sFlags \"%s\"%s %sDefault%s: %s0x%08x, \"%s\"%s",
605 DATATYPE_COLOR, g_type_name (G_VALUE_TYPE (&value)), RESET_COLOR,
606 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
607 g_value_get_flags (&value), cur, RESET_COLOR);
609 while (vals[0].value_name) {
611 n_print (" %s(0x%08x)%s: %s%-16s%s - %s%s%s",
612 PROP_ATTR_NAME_COLOR, vals[0].value, RESET_COLOR,
613 PROP_ATTR_VALUE_COLOR, vals[0].value_nick, RESET_COLOR,
614 DESC_COLOR, vals[0].value_name, RESET_COLOR);
619 } else if (G_IS_PARAM_SPEC_OBJECT (param)) {
620 n_print ("%sObject of type%s %s\"%s\"%s", PROP_VALUE_COLOR,
621 RESET_COLOR, DATATYPE_COLOR,
622 g_type_name (param->value_type), RESET_COLOR);
623 } else if (G_IS_PARAM_SPEC_BOXED (param)) {
624 n_print ("%sBoxed pointer of type%s %s\"%s\"%s", PROP_VALUE_COLOR,
625 RESET_COLOR, DATATYPE_COLOR,
626 g_type_name (param->value_type), RESET_COLOR);
627 if (param->value_type == GST_TYPE_STRUCTURE) {
628 const GstStructure *s = gst_value_get_structure (&value);
630 gst_structure_foreach (s, print_field,
633 } else if (G_IS_PARAM_SPEC_POINTER (param)) {
634 if (param->value_type != G_TYPE_POINTER) {
635 n_print ("%sPointer of type%s %s\"%s\"%s.", PROP_VALUE_COLOR,
636 RESET_COLOR, DATATYPE_COLOR, g_type_name (param->value_type),
639 n_print ("%sPointer.%s", PROP_VALUE_COLOR, RESET_COLOR);
641 } else if (param->value_type == G_TYPE_VALUE_ARRAY) {
642 GParamSpecValueArray *pvarray = G_PARAM_SPEC_VALUE_ARRAY (param);
644 if (pvarray->element_spec) {
645 n_print ("%sArray of GValues of type%s %s\"%s\"%s",
646 PROP_VALUE_COLOR, RESET_COLOR, DATATYPE_COLOR,
647 g_type_name (pvarray->element_spec->value_type), RESET_COLOR);
649 n_print ("%sArray of GValues%s", PROP_VALUE_COLOR, RESET_COLOR);
651 } else if (GST_IS_PARAM_SPEC_FRACTION (param)) {
652 GstParamSpecFraction *pfraction = GST_PARAM_SPEC_FRACTION (param);
654 n_print ("%sFraction%s. %sRange%s: %s%d/%d - %d/%d%s "
655 "%sDefault%s: %s%d/%d%s ", DATATYPE_COLOR, RESET_COLOR,
656 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
657 pfraction->min_num, pfraction->min_den, pfraction->max_num,
658 pfraction->max_den, RESET_COLOR, PROP_ATTR_NAME_COLOR,
659 RESET_COLOR, PROP_ATTR_VALUE_COLOR,
660 gst_value_get_fraction_numerator (&value),
661 gst_value_get_fraction_denominator (&value), RESET_COLOR);
662 } else if (param->value_type == GST_TYPE_ARRAY) {
663 GstParamSpecArray *parray = GST_PARAM_SPEC_ARRAY_LIST (param);
665 if (parray->element_spec) {
666 n_print ("%sGstValueArray of GValues of type%s %s\"%s\"%s",
667 PROP_VALUE_COLOR, RESET_COLOR, DATATYPE_COLOR,
668 g_type_name (parray->element_spec->value_type), RESET_COLOR);
670 n_print ("%sGstValueArray of GValues%s", PROP_VALUE_COLOR,
674 n_print ("%sUnknown type %ld%s %s\"%s\"%s", PROP_VALUE_COLOR,
675 (glong) param->value_type, RESET_COLOR, DATATYPE_COLOR,
676 g_type_name (param->value_type), RESET_COLOR);
681 g_print (" %sWrite only%s\n", PROP_VALUE_COLOR, RESET_COLOR);
687 g_value_reset (&value);
689 if (num_properties == 0)
690 n_print ("%snone%s\n", PROP_VALUE_COLOR, RESET_COLOR);
694 g_free (property_specs);
698 print_element_properties_info (GstElement * element)
701 print_object_properties_info (G_OBJECT (element),
702 G_OBJECT_GET_CLASS (element), "Element Properties");
706 print_pad_templates_info (GstElement * element, GstElementFactory * factory)
709 GstStaticPadTemplate *padtemplate;
710 GstPadTemplate *tmpl;
712 n_print ("%sPad Templates%s:\n", HEADING_COLOR, RESET_COLOR);
716 if (gst_element_factory_get_num_pad_templates (factory) == 0) {
717 n_print ("%snone%s\n", PROP_VALUE_COLOR, RESET_COLOR);
721 pads = gst_element_factory_get_static_pad_templates (factory);
723 padtemplate = (GstStaticPadTemplate *) (pads->data);
724 pads = g_list_next (pads);
726 if (padtemplate->direction == GST_PAD_SRC)
727 n_print ("%sSRC template%s: %s'%s'%s\n", PROP_NAME_COLOR, RESET_COLOR,
728 PROP_VALUE_COLOR, padtemplate->name_template, RESET_COLOR);
729 else if (padtemplate->direction == GST_PAD_SINK)
730 n_print ("%sSINK template%s: %s'%s'%s\n", PROP_NAME_COLOR, RESET_COLOR,
731 PROP_VALUE_COLOR, padtemplate->name_template, RESET_COLOR);
733 n_print ("%sUNKNOWN template%s: %s'%s'%s\n", PROP_NAME_COLOR, RESET_COLOR,
734 PROP_VALUE_COLOR, padtemplate->name_template, RESET_COLOR);
738 if (padtemplate->presence == GST_PAD_ALWAYS)
739 n_print ("%sAvailability%s: %sAlways%s\n", PROP_NAME_COLOR, RESET_COLOR,
740 PROP_VALUE_COLOR, RESET_COLOR);
741 else if (padtemplate->presence == GST_PAD_SOMETIMES)
742 n_print ("%sAvailability%s: %sSometimes%s\n", PROP_NAME_COLOR,
743 RESET_COLOR, PROP_VALUE_COLOR, RESET_COLOR);
744 else if (padtemplate->presence == GST_PAD_REQUEST) {
745 n_print ("%sAvailability%s: %sOn request%s\n", PROP_NAME_COLOR,
746 RESET_COLOR, PROP_VALUE_COLOR, RESET_COLOR);
748 n_print ("%sAvailability%s: %sUNKNOWN%s\n", PROP_NAME_COLOR, RESET_COLOR,
749 PROP_VALUE_COLOR, RESET_COLOR);
751 if (padtemplate->static_caps.string) {
752 GstCaps *caps = gst_static_caps_get (&padtemplate->static_caps);
754 n_print ("%sCapabilities%s:\n", PROP_NAME_COLOR, RESET_COLOR);
757 print_caps (caps, ""); // FIXME
760 gst_caps_unref (caps);
763 tmpl = gst_element_class_get_pad_template (GST_ELEMENT_GET_CLASS (element),
764 padtemplate->name_template);
766 GType pad_type = GST_PAD_TEMPLATE_GTYPE (tmpl);
768 if (pad_type != G_TYPE_NONE && pad_type != GST_TYPE_PAD) {
771 pad_klass = g_type_class_ref (pad_type);
772 n_print ("%sType%s: %s%s%s\n", PROP_NAME_COLOR, RESET_COLOR,
773 DATATYPE_COLOR, g_type_name (pad_type), RESET_COLOR);
774 print_object_properties_info (NULL, pad_klass, "Pad Properties");
775 g_type_class_unref (pad_klass);
790 print_clocking_info (GstElement * element)
792 gboolean requires_clock, provides_clock;
795 GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_REQUIRE_CLOCK);
797 GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_PROVIDE_CLOCK);
799 if (!requires_clock && !provides_clock) {
801 n_print ("%sElement has no clocking capabilities.%s\n", DESC_COLOR,
807 n_print ("%sClocking Interaction%s:\n", PROP_NAME_COLOR, RESET_COLOR);
811 if (requires_clock) {
812 n_print ("%selement requires a clock%s\n", PROP_VALUE_COLOR, RESET_COLOR);
815 if (provides_clock) {
818 clock = gst_element_get_clock (element);
820 n_print ("%selement provides a clock%s: %s%s%s\n", PROP_VALUE_COLOR,
821 RESET_COLOR, DATATYPE_COLOR, GST_OBJECT_NAME (clock), RESET_COLOR);
822 gst_object_unref (clock);
824 n_print ("%selement is supposed to provide a clock but returned NULL%s\n",
825 PROP_VALUE_COLOR, RESET_COLOR);
832 print_uri_handler_info (GstElement * element)
834 if (GST_IS_URI_HANDLER (element)) {
835 const gchar *const *uri_protocols;
836 const gchar *uri_type;
838 if (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element)) == GST_URI_SRC)
840 else if (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element)) ==
844 uri_type = "unknown";
846 uri_protocols = gst_uri_handler_get_protocols (GST_URI_HANDLER (element));
849 n_print ("%sURI handling capabilities:%s\n", HEADING_COLOR, RESET_COLOR);
853 n_print ("%sElement can act as %s.%s\n", DESC_COLOR, uri_type, RESET_COLOR);
855 if (uri_protocols && *uri_protocols) {
856 n_print ("%sSupported URI protocols%s:\n", DESC_COLOR, RESET_COLOR);
858 for (; *uri_protocols != NULL; uri_protocols++)
859 n_print ("%s%s%s\n", PROP_ATTR_VALUE_COLOR, *uri_protocols,
863 n_print ("%sNo supported URI protocols%s\n", PROP_VALUE_COLOR,
869 n_print ("%sElement has no URI handling capabilities.%s\n", DESC_COLOR,
875 print_pad_info (GstElement * element)
881 n_print ("%sPads:%s\n", HEADING_COLOR, RESET_COLOR);
885 if (!element->numpads) {
886 n_print ("%snone%s\n", PROP_VALUE_COLOR, RESET_COLOR);
890 pads = element->pads;
895 pad = GST_PAD (pads->data);
896 pads = g_list_next (pads);
898 name = gst_pad_get_name (pad);
899 if (gst_pad_get_direction (pad) == GST_PAD_SRC)
900 n_print ("%sSRC%s: %s'%s'%s\n", PROP_NAME_COLOR, RESET_COLOR,
901 PROP_VALUE_COLOR, name, RESET_COLOR);
902 else if (gst_pad_get_direction (pad) == GST_PAD_SINK)
903 n_print ("%sSINK%s: %s'%s'%s\n", PROP_NAME_COLOR, RESET_COLOR,
904 PROP_VALUE_COLOR, name, RESET_COLOR);
906 n_print ("%sUNKNOWN%s: %s'%s'%s\n", PROP_NAME_COLOR, RESET_COLOR,
907 PROP_VALUE_COLOR, name, RESET_COLOR);
911 if (pad->padtemplate) {
913 n_print ("%sPad Template%s: %s'%s'%s\n", PROP_NAME_COLOR, RESET_COLOR,
914 PROP_VALUE_COLOR, pad->padtemplate->name_template, RESET_COLOR);
918 caps = gst_pad_get_current_caps (pad);
920 n_print ("%sCapabilities:%s\n", PROP_NAME_COLOR, RESET_COLOR);
922 print_caps (caps, ""); // FIXME
924 gst_caps_unref (caps);
933 has_sometimes_template (GstElement * element)
935 GstElementClass *klass = GST_ELEMENT_GET_CLASS (element);
938 for (l = klass->padtemplates; l != NULL; l = l->next) {
939 if (GST_PAD_TEMPLATE (l->data)->presence == GST_PAD_SOMETIMES)
947 gtype_needs_ptr_marker (GType type)
949 if (type == G_TYPE_POINTER)
952 if (G_TYPE_FUNDAMENTAL (type) == G_TYPE_POINTER || G_TYPE_IS_BOXED (type)
953 || G_TYPE_IS_OBJECT (type))
960 print_signal_info (GstElement * element)
962 /* Signals/Actions Block */
966 GSignalQuery *query = NULL;
968 GSList *found_signals, *l;
970 for (k = 0; k < 2; k++) {
971 found_signals = NULL;
973 /* For elements that have sometimes pads, also list a few useful GstElement
974 * signals. Put these first, so element-specific ones come later. */
975 if (k == 0 && has_sometimes_template (element)) {
976 query = g_new0 (GSignalQuery, 1);
977 g_signal_query (g_signal_lookup ("pad-added", GST_TYPE_ELEMENT), query);
978 found_signals = g_slist_append (found_signals, query);
979 query = g_new0 (GSignalQuery, 1);
980 g_signal_query (g_signal_lookup ("pad-removed", GST_TYPE_ELEMENT), query);
981 found_signals = g_slist_append (found_signals, query);
982 query = g_new0 (GSignalQuery, 1);
983 g_signal_query (g_signal_lookup ("no-more-pads", GST_TYPE_ELEMENT),
985 found_signals = g_slist_append (found_signals, query);
988 for (type = G_OBJECT_TYPE (element); type; type = g_type_parent (type)) {
989 if (type == GST_TYPE_ELEMENT || type == GST_TYPE_OBJECT)
992 if (type == GST_TYPE_BIN && G_OBJECT_TYPE (element) != GST_TYPE_BIN)
995 signals = g_signal_list_ids (type, &nsignals);
996 for (i = 0; i < nsignals; i++) {
997 query = g_new0 (GSignalQuery, 1);
998 g_signal_query (signals[i], query);
1000 if ((k == 0 && !(query->signal_flags & G_SIGNAL_ACTION)) ||
1001 (k == 1 && (query->signal_flags & G_SIGNAL_ACTION)))
1002 found_signals = g_slist_append (found_signals, query);
1010 if (found_signals) {
1013 n_print ("%sElement Signals%s:\n", HEADING_COLOR, RESET_COLOR);
1015 n_print ("%sElement Actions%s:\n", HEADING_COLOR, RESET_COLOR);
1020 for (l = found_signals; l; l = l->next) {
1025 query = (GSignalQuery *) l->data;
1026 indent_len = strlen (query->signal_name) +
1027 strlen (g_type_name (query->return_type)) + 24;
1029 if (gtype_needs_ptr_marker (query->return_type)) {
1036 indent = g_new0 (gchar, indent_len + 1);
1037 memset (indent, ' ', indent_len);
1039 n_print (" %s\"%s\"%s : %s%s%s%suser_function%s (%s%s%s* object%s",
1040 PROP_NAME_COLOR, query->signal_name, RESET_COLOR,
1041 DATATYPE_COLOR, g_type_name (query->return_type), PROP_VALUE_COLOR,
1042 pmark, RESET_COLOR, DATATYPE_COLOR, g_type_name (type),
1043 PROP_VALUE_COLOR, RESET_COLOR);
1045 for (j = 0; j < query->n_params; j++) {
1046 const gchar *type_name, *asterisk;
1048 type_name = g_type_name (query->param_types[j]);
1049 asterisk = gtype_needs_ptr_marker (query->param_types[j]) ? "*" : "";
1052 n_print ("%s%s%s%s%s arg%d%s", indent, DATATYPE_COLOR, type_name,
1053 PROP_VALUE_COLOR, asterisk, j, RESET_COLOR);
1058 n_print ("%s%sgpointer %suser_data%s);\n", indent, DATATYPE_COLOR,
1059 PROP_VALUE_COLOR, RESET_COLOR);
1066 if (found_signals) {
1067 g_slist_foreach (found_signals, (GFunc) g_free, NULL);
1068 g_slist_free (found_signals);
1074 print_children_info (GstElement * element)
1078 if (!GST_IS_BIN (element))
1081 children = (GList *) GST_BIN (element)->children;
1084 n_print ("%sChildren%s:\n", HEADING_COLOR, RESET_COLOR);
1088 n_print (" %s%s%s\n", DATATYPE_COLOR,
1089 GST_ELEMENT_NAME (GST_ELEMENT (children->data)), RESET_COLOR);
1090 children = g_list_next (children);
1095 print_preset_list (GstElement * element)
1097 gchar **presets, **preset;
1099 if (!GST_IS_PRESET (element))
1102 presets = gst_preset_get_preset_names (GST_PRESET (element));
1103 if (presets && *presets) {
1105 n_print ("%sPresets%s:\n", HEADING_COLOR, RESET_COLOR);
1106 for (preset = presets; *preset; preset++) {
1107 n_print (" \"%s\"\n", *preset);
1109 g_strfreev (presets);
1114 print_blacklist (void)
1116 GList *plugins, *cur;
1119 g_print ("%s%s%s\n", HEADING_COLOR, _("Blacklisted files:"), RESET_COLOR);
1121 plugins = gst_registry_get_plugin_list (gst_registry_get ());
1122 for (cur = plugins; cur != NULL; cur = g_list_next (cur)) {
1123 GstPlugin *plugin = (GstPlugin *) (cur->data);
1124 if (GST_OBJECT_FLAG_IS_SET (plugin, GST_PLUGIN_FLAG_BLACKLISTED)) {
1125 g_print (" %s\n", gst_plugin_get_name (plugin));
1131 g_print (_("%sTotal count%s: %s"), PROP_NAME_COLOR, RESET_COLOR,
1133 g_print (ngettext ("%d blacklisted file", "%d blacklisted files", count),
1135 g_print ("%s\n", RESET_COLOR);
1136 gst_plugin_list_free (plugins);
1140 print_typefind_extensions (const gchar * const *extensions, const gchar * color)
1144 while (extensions[i]) {
1145 g_print ("%s%s%s%s", i > 0 ? ", " : "", color, extensions[i], RESET_COLOR);
1151 print_element_list (gboolean print_all, gchar * ftypes)
1153 int plugincount = 0, featurecount = 0, blacklistcount = 0;
1154 GList *plugins, *orig_plugins;
1155 gchar **types = NULL;
1160 types = g_strsplit (ftypes, "/", -1);
1161 for (i = 0; types[i]; i++)
1162 *types[i] = g_ascii_toupper (*types[i]);
1166 orig_plugins = plugins = gst_registry_get_plugin_list (gst_registry_get ());
1168 GList *features, *orig_features;
1171 plugin = (GstPlugin *) (plugins->data);
1172 plugins = g_list_next (plugins);
1175 if (GST_OBJECT_FLAG_IS_SET (plugin, GST_PLUGIN_FLAG_BLACKLISTED)) {
1180 orig_features = features =
1181 gst_registry_get_feature_list_by_plugin (gst_registry_get (),
1182 gst_plugin_get_name (plugin));
1184 GstPluginFeature *feature;
1186 if (G_UNLIKELY (features->data == NULL))
1188 feature = GST_PLUGIN_FEATURE (features->data);
1191 if (GST_IS_ELEMENT_FACTORY (feature)) {
1193 GstElementFactory *factory;
1195 factory = GST_ELEMENT_FACTORY (feature);
1198 gboolean all_found = TRUE;
1201 gst_element_factory_get_metadata (factory,
1202 GST_ELEMENT_METADATA_KLASS);
1203 for (i = 0; types[i]; i++) {
1204 if (!strstr (klass, types[i])) {
1214 print_element_info (feature, TRUE);
1216 g_print ("%s%s%s: %s%s%s: %s%s%s\n", PLUGIN_NAME_COLOR,
1217 gst_plugin_get_name (plugin), RESET_COLOR, ELEMENT_NAME_COLOR,
1218 GST_OBJECT_NAME (factory), RESET_COLOR, ELEMENT_DETAIL_COLOR,
1219 gst_element_factory_get_metadata (factory,
1220 GST_ELEMENT_METADATA_LONGNAME), RESET_COLOR);
1221 } else if (GST_IS_TYPE_FIND_FACTORY (feature)) {
1222 GstTypeFindFactory *factory;
1223 const gchar *const *extensions;
1227 factory = GST_TYPE_FIND_FACTORY (feature);
1229 g_print ("%s%s%s: %s%s%s: ", PLUGIN_NAME_COLOR,
1230 gst_plugin_get_name (plugin), RESET_COLOR, ELEMENT_NAME_COLOR,
1231 gst_plugin_feature_get_name (feature), RESET_COLOR);
1233 extensions = gst_type_find_factory_get_extensions (factory);
1234 if (extensions != NULL) {
1236 print_typefind_extensions (extensions, ELEMENT_DETAIL_COLOR);
1241 g_print ("%sno extensions%s\n", ELEMENT_DETAIL_COLOR, RESET_COLOR);
1247 n_print ("%s%s%s: %s%s%s (%s%s%s)\n", PLUGIN_NAME_COLOR,
1248 gst_plugin_get_name (plugin), RESET_COLOR, ELEMENT_NAME_COLOR,
1249 GST_OBJECT_NAME (feature), RESET_COLOR, ELEMENT_DETAIL_COLOR,
1250 g_type_name (G_OBJECT_TYPE (feature)), RESET_COLOR);
1254 features = g_list_next (features);
1257 gst_plugin_feature_list_free (orig_features);
1260 gst_plugin_list_free (orig_plugins);
1264 g_print (_("%sTotal count%s: %s"), PROP_NAME_COLOR, RESET_COLOR,
1266 g_print (ngettext ("%d plugin", "%d plugins", plugincount), plugincount);
1267 if (blacklistcount) {
1269 g_print (ngettext ("%d blacklist entry", "%d blacklist entries",
1270 blacklistcount), blacklistcount);
1271 g_print (" not shown)");
1273 g_print ("%s, %s", RESET_COLOR, PROP_VALUE_COLOR);
1274 g_print (ngettext ("%d feature", "%d features", featurecount), featurecount);
1275 g_print ("%s\n", RESET_COLOR);
1279 print_all_uri_handlers (void)
1281 GList *plugins, *p, *features, *f;
1283 plugins = gst_registry_get_plugin_list (gst_registry_get ());
1285 for (p = plugins; p; p = p->next) {
1286 GstPlugin *plugin = (GstPlugin *) (p->data);
1289 gst_registry_get_feature_list_by_plugin (gst_registry_get (),
1290 gst_plugin_get_name (plugin));
1292 for (f = features; f; f = f->next) {
1293 GstPluginFeature *feature = GST_PLUGIN_FEATURE (f->data);
1295 if (GST_IS_ELEMENT_FACTORY (feature)) {
1296 GstElementFactory *factory;
1297 GstElement *element;
1299 factory = GST_ELEMENT_FACTORY (gst_plugin_feature_load (feature));
1301 g_print ("element plugin %s couldn't be loaded\n",
1302 gst_plugin_get_name (plugin));
1306 element = gst_element_factory_create (factory, NULL);
1308 g_print ("couldn't construct element for %s for some reason\n",
1309 GST_OBJECT_NAME (factory));
1310 gst_object_unref (factory);
1314 if (GST_IS_URI_HANDLER (element)) {
1315 const gchar *const *uri_protocols;
1316 const gchar *const *protocol;
1319 switch (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element))) {
1331 g_print ("%s%s%s (%s%s%s, %srank %u%s): ",
1333 gst_plugin_feature_get_name (GST_PLUGIN_FEATURE (factory)),
1334 RESET_COLOR, FEATURE_DIR_COLOR, dir, RESET_COLOR,
1336 gst_plugin_feature_get_rank (GST_PLUGIN_FEATURE (factory)),
1340 gst_uri_handler_get_protocols (GST_URI_HANDLER (element));
1341 for (protocol = uri_protocols; *protocol != NULL; protocol++) {
1342 if (protocol != uri_protocols)
1344 g_print ("%s%s%s", FEATURE_PROTO_COLOR, *protocol, RESET_COLOR);
1349 gst_object_unref (element);
1350 gst_object_unref (factory);
1354 gst_plugin_feature_list_free (features);
1357 gst_plugin_list_free (plugins);
1361 print_plugin_info (GstPlugin * plugin)
1363 const gchar *release_date = gst_plugin_get_release_date_string (plugin);
1364 const gchar *filename = gst_plugin_get_filename (plugin);
1366 n_print ("%sPlugin Details%s:\n", HEADING_COLOR, RESET_COLOR);
1370 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "Name", RESET_COLOR,
1371 PROP_VALUE_COLOR, gst_plugin_get_name (plugin), RESET_COLOR);
1372 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "Description", RESET_COLOR,
1373 PROP_VALUE_COLOR, gst_plugin_get_description (plugin), RESET_COLOR);
1374 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "Filename", RESET_COLOR,
1375 PROP_VALUE_COLOR, (filename != NULL) ? filename : "(null)", RESET_COLOR);
1376 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "Version", RESET_COLOR,
1377 PROP_VALUE_COLOR, gst_plugin_get_version (plugin), RESET_COLOR);
1378 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "License", RESET_COLOR,
1379 PROP_VALUE_COLOR, gst_plugin_get_license (plugin), RESET_COLOR);
1380 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "Source module", RESET_COLOR,
1381 PROP_VALUE_COLOR, gst_plugin_get_source (plugin), RESET_COLOR);
1383 if (release_date != NULL) {
1384 const gchar *tz = "(UTC)";
1387 /* may be: YYYY-MM-DD or YYYY-MM-DDTHH:MMZ */
1388 /* YYYY-MM-DDTHH:MMZ => YYYY-MM-DD HH:MM (UTC) */
1389 str = g_strdup (release_date);
1390 sep = strstr (str, "T");
1393 sep = strstr (sep + 1, "Z");
1399 n_print ("%s%-25s%s%s%s%s%s\n", PROP_NAME_COLOR, "Source release date",
1400 RESET_COLOR, PROP_VALUE_COLOR, str, tz, RESET_COLOR);
1403 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "Binary package", RESET_COLOR,
1404 PROP_VALUE_COLOR, gst_plugin_get_package (plugin), RESET_COLOR);
1405 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "Origin URL", RESET_COLOR,
1406 PROP_VALUE_COLOR, gst_plugin_get_origin (plugin), RESET_COLOR);
1414 print_plugin_features (GstPlugin * plugin)
1416 GList *features, *origlist;
1417 gint num_features = 0;
1418 gint num_elements = 0;
1419 gint num_tracers = 0;
1420 gint num_typefinders = 0;
1421 gint num_devproviders = 0;
1424 origlist = features =
1425 gst_registry_get_feature_list_by_plugin (gst_registry_get (),
1426 gst_plugin_get_name (plugin));
1429 GstPluginFeature *feature;
1431 feature = GST_PLUGIN_FEATURE (features->data);
1433 if (GST_IS_ELEMENT_FACTORY (feature)) {
1434 GstElementFactory *factory;
1436 factory = GST_ELEMENT_FACTORY (feature);
1437 n_print (" %s%s%s: %s%s%s\n", ELEMENT_NAME_COLOR,
1438 GST_OBJECT_NAME (factory), RESET_COLOR, ELEMENT_DETAIL_COLOR,
1439 gst_element_factory_get_metadata (factory,
1440 GST_ELEMENT_METADATA_LONGNAME), RESET_COLOR);
1442 } else if (GST_IS_TYPE_FIND_FACTORY (feature)) {
1443 GstTypeFindFactory *factory;
1444 const gchar *const *extensions;
1446 factory = GST_TYPE_FIND_FACTORY (feature);
1447 extensions = gst_type_find_factory_get_extensions (factory);
1449 g_print (" %s%s%s: ", ELEMENT_NAME_COLOR,
1450 gst_plugin_feature_get_name (feature), RESET_COLOR);
1451 print_typefind_extensions (extensions, ELEMENT_DETAIL_COLOR);
1454 g_print (" %s%s%s: %sno extensions%s\n", ELEMENT_NAME_COLOR,
1455 gst_plugin_feature_get_name (feature), RESET_COLOR,
1456 ELEMENT_DETAIL_COLOR, RESET_COLOR);
1459 } else if (GST_IS_DEVICE_PROVIDER_FACTORY (feature)) {
1460 GstDeviceProviderFactory *factory;
1462 factory = GST_DEVICE_PROVIDER_FACTORY (feature);
1463 n_print (" %s%s%s: %s%s%s\n", ELEMENT_NAME_COLOR,
1464 GST_OBJECT_NAME (factory), RESET_COLOR, ELEMENT_DETAIL_COLOR,
1465 gst_device_provider_factory_get_metadata (factory,
1466 GST_ELEMENT_METADATA_LONGNAME), RESET_COLOR);
1468 } else if (GST_IS_TRACER_FACTORY (feature)) {
1469 n_print (" %s%s%s (%s%s%s)\n", ELEMENT_NAME_COLOR,
1470 gst_object_get_name (GST_OBJECT (feature)), RESET_COLOR,
1471 DATATYPE_COLOR, g_type_name (G_OBJECT_TYPE (feature)), RESET_COLOR);
1473 } else if (feature) {
1474 n_print (" %s%s%s (%s%s%s)\n", ELEMENT_NAME_COLOR,
1475 gst_object_get_name (GST_OBJECT (feature)), RESET_COLOR,
1476 DATATYPE_COLOR, g_type_name (G_OBJECT_TYPE (feature)), RESET_COLOR);
1480 features = g_list_next (features);
1483 gst_plugin_feature_list_free (origlist);
1486 n_print (" %s%d features%s:\n", HEADING_COLOR, num_features, RESET_COLOR);
1487 if (num_elements > 0)
1488 n_print (" %s+--%s %s%d elements%s\n", CHILD_LINK_COLOR, RESET_COLOR,
1489 PLUGIN_FEATURE_COLOR, num_elements, RESET_COLOR);
1490 if (num_typefinders > 0)
1491 n_print (" %s+--%s %s%d typefinders%s\n", CHILD_LINK_COLOR, RESET_COLOR,
1492 PLUGIN_FEATURE_COLOR, num_typefinders, RESET_COLOR);
1493 if (num_devproviders > 0)
1494 n_print (" %s+--%s %s%d device providers%s\n", CHILD_LINK_COLOR,
1495 RESET_COLOR, PLUGIN_FEATURE_COLOR, num_devproviders, RESET_COLOR);
1496 if (num_tracers > 0)
1497 n_print (" %s+--%s %s%d tracers%s\n", CHILD_LINK_COLOR, RESET_COLOR,
1498 PLUGIN_FEATURE_COLOR, num_tracers, RESET_COLOR);
1500 n_print (" %s+--%s %s%d other objects%s\n", CHILD_LINK_COLOR, RESET_COLOR,
1501 PLUGIN_FEATURE_COLOR, num_other, RESET_COLOR);
1507 print_feature_info (const gchar * feature_name, gboolean print_all)
1509 GstPluginFeature *feature;
1510 GstRegistry *registry = gst_registry_get ();
1513 if ((feature = gst_registry_find_feature (registry, feature_name,
1514 GST_TYPE_ELEMENT_FACTORY))) {
1515 ret = print_element_info (feature, print_all);
1518 if ((feature = gst_registry_find_feature (registry, feature_name,
1519 GST_TYPE_TYPE_FIND_FACTORY))) {
1520 ret = print_typefind_info (feature, print_all);
1523 if ((feature = gst_registry_find_feature (registry, feature_name,
1524 GST_TYPE_TRACER_FACTORY))) {
1525 ret = print_tracer_info (feature, print_all);
1529 /* TODO: handle DEVICE_PROVIDER_FACTORY */
1534 gst_object_unref (feature);
1539 print_element_info (GstPluginFeature * feature, gboolean print_names)
1541 GstElementFactory *factory;
1542 GstElement *element;
1546 factory = GST_ELEMENT_FACTORY (gst_plugin_feature_load (feature));
1548 g_print ("%selement plugin couldn't be loaded%s\n", DESC_COLOR,
1553 element = gst_element_factory_create (factory, NULL);
1555 gst_object_unref (factory);
1556 g_print ("%scouldn't construct element for some reason%s\n", DESC_COLOR,
1563 g_strdup_printf ("%s%s%s: ", DATATYPE_COLOR, GST_OBJECT_NAME (factory),
1568 print_factory_details_info (factory);
1570 plugin = gst_plugin_feature_get_plugin (GST_PLUGIN_FEATURE (factory));
1572 print_plugin_info (plugin);
1573 gst_object_unref (plugin);
1576 print_hierarchy (G_OBJECT_TYPE (element), 0, &maxlevel);
1577 print_interfaces (G_OBJECT_TYPE (element));
1579 print_pad_templates_info (element, factory);
1580 print_clocking_info (element);
1581 print_uri_handler_info (element);
1582 print_pad_info (element);
1583 print_element_properties_info (element);
1584 print_signal_info (element);
1585 print_children_info (element);
1586 print_preset_list (element);
1588 gst_object_unref (element);
1589 gst_object_unref (factory);
1595 print_typefind_info (GstPluginFeature * feature, gboolean print_names)
1597 GstTypeFindFactory *factory;
1602 const gchar *const *extensions;
1604 factory = GST_TYPE_FIND_FACTORY (gst_plugin_feature_load (feature));
1606 g_print ("%stypefind plugin couldn't be loaded%s\n", DESC_COLOR,
1613 g_strdup_printf ("%s%s%s: ", DATATYPE_COLOR, GST_OBJECT_NAME (factory),
1618 n_print ("%sFactory Details%s:\n", HEADING_COLOR, RESET_COLOR);
1619 rank = gst_plugin_feature_get_rank (feature);
1620 n_print (" %s%-25s%s%s (%d)%s\n", PROP_NAME_COLOR, "Rank", PROP_VALUE_COLOR,
1621 get_rank_name (s, rank), rank, RESET_COLOR);
1622 n_print (" %s%-25s%s%s%s\n", PROP_NAME_COLOR, "Name", PROP_VALUE_COLOR,
1623 GST_OBJECT_NAME (factory), RESET_COLOR);
1624 caps = gst_type_find_factory_get_caps (factory);
1626 gchar *caps_str = gst_caps_to_string (factory->caps);
1628 n_print (" %s%-25s%s%s%s\n", PROP_NAME_COLOR, "Caps", PROP_VALUE_COLOR,
1629 caps_str, RESET_COLOR);
1632 extensions = gst_type_find_factory_get_extensions (factory);
1634 n_print (" %s%-25s%s", PROP_NAME_COLOR, "Extensions", RESET_COLOR);
1635 print_typefind_extensions (extensions, PROP_VALUE_COLOR);
1640 plugin = gst_plugin_feature_get_plugin (GST_PLUGIN_FEATURE (factory));
1642 print_plugin_info (plugin);
1643 gst_object_unref (plugin);
1646 gst_object_unref (factory);
1652 print_tracer_info (GstPluginFeature * feature, gboolean print_names)
1654 GstTracerFactory *factory;
1659 factory = GST_TRACER_FACTORY (gst_plugin_feature_load (feature));
1661 g_print ("%stracer plugin couldn't be loaded%s\n", DESC_COLOR, RESET_COLOR);
1665 tracer = (GstTracer *) g_object_new (factory->type, NULL);
1667 gst_object_unref (factory);
1668 g_print ("%scouldn't construct tracer for some reason%s\n", DESC_COLOR,
1675 g_strdup_printf ("%s%s%s: ", DATATYPE_COLOR, GST_OBJECT_NAME (factory),
1680 n_print ("%sFactory Details%s:\n", HEADING_COLOR, RESET_COLOR);
1681 n_print (" %s%-25s%s%s%s\n", PROP_NAME_COLOR, "Name", PROP_VALUE_COLOR,
1682 GST_OBJECT_NAME (factory), RESET_COLOR);
1685 plugin = gst_plugin_feature_get_plugin (GST_PLUGIN_FEATURE (factory));
1687 print_plugin_info (plugin);
1688 gst_object_unref (plugin);
1691 print_hierarchy (G_OBJECT_TYPE (tracer), 0, &maxlevel);
1692 print_interfaces (G_OBJECT_TYPE (tracer));
1694 /* TODO: list what hooks it registers
1695 * - the data is available in gsttracerutils, we need to iterate the
1696 * _priv_tracers hashtable for each probe and then check the list of hooks
1697 * for each probe whether hook->tracer == tracer :/
1700 /* TODO: list what records it emits
1701 * - in class_init tracers can create GstTracerRecord instances
1702 * - those only get logged right now and there is no association with the
1703 * tracer that created them
1704 * - we'd need to add them to GstTracerFactory
1705 * gst_tracer_class_add_record (klass, record);
1706 * - needs work in gstregistrychunks to (de)serialize specs
1707 * - gst_tracer_register() would need to iterate the list of records and
1708 * copy the record->spec into the factory
1711 gst_object_unref (tracer);
1712 gst_object_unref (factory);
1717 /* NOTE: Not coloring output from automatic install functions, as their output
1718 * is meant for machines, not humans.
1721 print_plugin_automatic_install_info_codecs (GstElementFactory * factory)
1723 GstPadDirection direction;
1724 const gchar *type_name;
1726 const GList *static_templates, *l;
1727 GstCaps *caps = NULL;
1731 gst_element_factory_get_metadata (factory, GST_ELEMENT_METADATA_KLASS);
1732 g_return_if_fail (klass != NULL);
1734 if (strstr (klass, "Demuxer") ||
1735 strstr (klass, "Decoder") ||
1736 strstr (klass, "Depay") || strstr (klass, "Parser")) {
1737 type_name = "decoder";
1738 direction = GST_PAD_SINK;
1739 } else if (strstr (klass, "Muxer") ||
1740 strstr (klass, "Encoder") || strstr (klass, "Pay")) {
1741 type_name = "encoder";
1742 direction = GST_PAD_SRC;
1747 /* decoder/demuxer sink pads should always be static and there should only
1748 * be one, the same applies to encoders/muxers and source pads */
1749 static_templates = gst_element_factory_get_static_pad_templates (factory);
1750 for (l = static_templates; l != NULL; l = l->next) {
1751 GstStaticPadTemplate *tmpl = NULL;
1753 tmpl = (GstStaticPadTemplate *) l->data;
1754 if (tmpl->direction == direction) {
1755 caps = gst_static_pad_template_get_caps (tmpl);
1761 g_printerr ("Couldn't find static pad template for %s '%s'\n",
1762 type_name, GST_OBJECT_NAME (factory));
1766 caps = gst_caps_make_writable (caps);
1767 num = gst_caps_get_size (caps);
1768 for (i = 0; i < num; ++i) {
1772 s = gst_caps_get_structure (caps, i);
1773 /* remove fields that are almost always just MIN-MAX of some sort
1774 * in order to make the caps look less messy */
1775 gst_structure_remove_field (s, "pixel-aspect-ratio");
1776 gst_structure_remove_field (s, "framerate");
1777 gst_structure_remove_field (s, "channels");
1778 gst_structure_remove_field (s, "width");
1779 gst_structure_remove_field (s, "height");
1780 gst_structure_remove_field (s, "rate");
1781 gst_structure_remove_field (s, "depth");
1782 gst_structure_remove_field (s, "clock-rate");
1783 s_str = gst_structure_to_string (s);
1784 g_print ("%s-%s\n", type_name, s_str);
1787 gst_caps_unref (caps);
1791 print_plugin_automatic_install_info_protocols (GstElementFactory * factory)
1793 const gchar *const *protocols;
1795 protocols = gst_element_factory_get_uri_protocols (factory);
1796 if (protocols != NULL && *protocols != NULL) {
1797 switch (gst_element_factory_get_uri_type (factory)) {
1799 while (*protocols != NULL) {
1800 g_print ("urisink-%s\n", *protocols);
1805 while (*protocols != NULL) {
1806 g_print ("urisource-%s\n", *protocols);
1817 print_plugin_automatic_install_info (GstPlugin * plugin)
1819 GList *features, *l;
1821 /* not interested in typefind factories, only element factories */
1822 features = gst_registry_get_feature_list (gst_registry_get (),
1823 GST_TYPE_ELEMENT_FACTORY);
1825 for (l = features; l != NULL; l = l->next) {
1826 GstPluginFeature *feature;
1827 GstPlugin *feature_plugin;
1829 feature = GST_PLUGIN_FEATURE (l->data);
1831 /* only interested in the ones that are in the plugin we just loaded */
1832 feature_plugin = gst_plugin_feature_get_plugin (feature);
1833 if (feature_plugin == plugin) {
1834 GstElementFactory *factory;
1836 g_print ("element-%s\n", gst_plugin_feature_get_name (feature));
1838 factory = GST_ELEMENT_FACTORY (feature);
1839 print_plugin_automatic_install_info_protocols (factory);
1840 print_plugin_automatic_install_info_codecs (factory);
1843 gst_object_unref (feature_plugin);
1846 g_list_foreach (features, (GFunc) gst_object_unref, NULL);
1847 g_list_free (features);
1851 print_all_plugin_automatic_install_info (void)
1853 GList *plugins, *orig_plugins;
1855 orig_plugins = plugins = gst_registry_get_plugin_list (gst_registry_get ());
1859 plugin = (GstPlugin *) (plugins->data);
1860 plugins = g_list_next (plugins);
1862 print_plugin_automatic_install_info (plugin);
1864 gst_plugin_list_free (orig_plugins);
1869 redirect_stdout (void)
1874 if (pipe (pipefd) == -1) {
1875 g_printerr (_("Error creating pipe: %s\n"), g_strerror (errno));
1880 if (child_id == -1) {
1881 g_printerr (_("Error forking: %s\n"), g_strerror (errno));
1885 if (child_id == 0) {
1890 pager = g_getenv ("PAGER");
1892 pager = DEFAULT_PAGER;
1893 argv = g_strsplit (pager, " ", 0);
1895 /* Make sure less will show colors, cat and more always show colors */
1896 g_setenv ("LESS", DEFAULT_LESS_OPTS, FALSE);
1900 dup2 (pipefd[0], STDIN_FILENO);
1903 ret = execvp (argv[0], argv);
1906 /* No less? Let's just dump everything to stdout then */
1912 if ((ret = read (STDIN_FILENO, buffer, sizeof (buffer))) == -1) {
1913 if (errno == EINTR || errno == EAGAIN) {
1917 g_printerr (_("Error reading from console: %s\n"),
1918 g_strerror (errno));
1923 bytes_written = write (STDOUT_FILENO, buffer, ret);
1924 } while (bytes_written == -1 && (errno == EINTR || errno == EAGAIN));
1926 if (bytes_written < 0) {
1927 g_printerr (_("Error writing to console: %s\n"), g_strerror (errno));
1936 dup2 (pipefd[1], STDOUT_FILENO);
1937 if (isatty (STDERR_FILENO))
1938 dup2 (pipefd[1], STDERR_FILENO);
1940 close (STDIN_FILENO);
1946 main (int argc, char *argv[])
1948 gboolean print_all = FALSE;
1949 gboolean do_print_blacklist = FALSE;
1950 gboolean plugin_name = FALSE;
1951 gboolean print_aii = FALSE;
1952 gboolean uri_handlers = FALSE;
1953 gboolean check_exists = FALSE;
1954 gchar *min_version = NULL;
1955 guint minver_maj = GST_VERSION_MAJOR;
1956 guint minver_min = GST_VERSION_MINOR;
1957 guint minver_micro = 0;
1958 gchar *types = NULL;
1959 const gchar *no_colors;
1960 #ifndef GST_DISABLE_OPTION_PARSING
1961 GOptionEntry options[] = {
1962 {"print-all", 'a', 0, G_OPTION_ARG_NONE, &print_all,
1963 N_("Print all elements"), NULL},
1964 {"print-blacklist", 'b', 0, G_OPTION_ARG_NONE, &do_print_blacklist,
1965 N_("Print list of blacklisted files"), NULL},
1966 {"print-plugin-auto-install-info", '\0', 0, G_OPTION_ARG_NONE, &print_aii,
1967 N_("Print a machine-parsable list of features the specified plugin "
1968 "or all plugins provide.\n "
1969 "Useful in connection with external automatic plugin "
1970 "installation mechanisms"), NULL},
1971 {"plugin", '\0', 0, G_OPTION_ARG_NONE, &plugin_name,
1972 N_("List the plugin contents"), NULL},
1973 {"types", 't', 0, G_OPTION_ARG_STRING, &types,
1974 N_("A slashes ('/') separated list of types of elements (also known "
1975 "as klass) to list. (unordered)"), NULL},
1976 {"exists", '\0', 0, G_OPTION_ARG_NONE, &check_exists,
1977 N_("Check if the specified element or plugin exists"), NULL},
1978 {"atleast-version", '\0', 0, G_OPTION_ARG_STRING, &min_version,
1980 ("When checking if an element or plugin exists, also check that its "
1981 "version is at least the version specified"), NULL},
1982 {"uri-handlers", 'u', 0, G_OPTION_ARG_NONE, &uri_handlers,
1984 ("Print supported URI schemes, with the elements that implement them"),
1986 {"no-colors", '\0', G_OPTION_FLAG_REVERSE, G_OPTION_ARG_NONE,
1989 ("Disable colors in output. You can also achieve the same by setting"
1990 "'GST_INSPECT_NO_COLORS' environment variable to any value."),
1992 GST_TOOLS_GOPTION_VERSION,
1995 GOptionContext *ctx;
1999 setlocale (LC_ALL, "");
2002 bindtextdomain (GETTEXT_PACKAGE, LOCALEDIR);
2003 bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
2004 textdomain (GETTEXT_PACKAGE);
2007 /* avoid glib warnings when inspecting deprecated properties */
2008 g_setenv ("G_ENABLE_DIAGNOSTIC", "0", FALSE);
2010 g_set_prgname ("gst-inspect-" GST_API_VERSION);
2012 #ifndef GST_DISABLE_OPTION_PARSING
2013 ctx = g_option_context_new ("[ELEMENT-NAME | PLUGIN-NAME]");
2014 g_option_context_add_main_entries (ctx, options, GETTEXT_PACKAGE);
2015 g_option_context_add_group (ctx, gst_init_get_option_group ());
2016 if (!g_option_context_parse (ctx, &argc, &argv, &err)) {
2017 g_printerr ("Error initializing: %s\n", err->message);
2018 g_clear_error (&err);
2019 g_option_context_free (ctx);
2022 g_option_context_free (ctx);
2024 gst_init (&argc, &argv);
2027 no_colors = g_getenv ("GST_INSPECT_NO_COLORS");
2028 /* We only support truecolor */
2029 colored_output &= (no_colors == NULL);
2032 if (isatty (STDOUT_FILENO)) {
2035 colored_output = FALSE;
2039 gst_tools_print_version ();
2041 if (print_all && argc > 1) {
2042 g_printerr ("-a requires no extra arguments\n");
2046 if (uri_handlers && argc > 1) {
2047 g_printerr ("-u requires no extra arguments\n");
2051 /* --atleast-version implies --exists */
2052 if (min_version != NULL) {
2053 if (sscanf (min_version, "%u.%u.%u", &minver_maj, &minver_min,
2054 &minver_micro) < 2) {
2055 g_printerr ("Can't parse version '%s' passed to --atleast-version\n",
2059 check_exists = TRUE;
2066 g_printerr ("--exists requires an extra command line argument\n");
2070 GstPluginFeature *feature;
2072 feature = gst_registry_lookup_feature (gst_registry_get (), argv[1]);
2073 if (feature != NULL && gst_plugin_feature_check_version (feature,
2074 minver_maj, minver_min, minver_micro)) {
2081 gst_object_unref (feature);
2083 /* FIXME: support checking for plugins too */
2084 g_printerr ("Checking for plugins is not supported yet\n");
2091 /* if no arguments, print out list of elements */
2093 print_all_uri_handlers ();
2094 } else if (argc == 1 || print_all) {
2095 if (do_print_blacklist)
2099 print_all_plugin_automatic_install_info ();
2101 print_element_list (print_all, types);
2104 /* else we try to get a factory */
2105 const char *arg = argv[argc - 1];
2109 retval = print_feature_info (arg, print_all);
2112 /* otherwise check if it's a plugin */
2114 GstPlugin *plugin = gst_registry_find_plugin (gst_registry_get (), arg);
2116 /* if there is such a plugin, print out info */
2119 print_plugin_automatic_install_info (plugin);
2121 print_plugin_info (plugin);
2122 print_plugin_features (plugin);
2125 GError *error = NULL;
2127 if (g_file_test (arg, G_FILE_TEST_EXISTS)) {
2128 plugin = gst_plugin_load_file (arg, &error);
2132 print_plugin_automatic_install_info (plugin);
2134 print_plugin_info (plugin);
2135 print_plugin_features (plugin);
2138 g_printerr (_("Could not load plugin file: %s\n"), error->message);
2139 g_clear_error (&error);
2143 g_printerr (_("No such element or plugin '%s'\n"), arg);
2153 /* So that the pipe we create in redirect_stdout() is closed */
2154 close (STDOUT_FILENO);
2155 close (STDERR_FILENO);