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? BLUE: "")
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? BLUE : "")
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? BLUE : "")
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))
370 g_value_init (&value, param->value_type);
372 n_print ("%s%-20s%s: %s%s%s\n", PROP_NAME_COLOR,
373 g_param_spec_get_name (param), RESET_COLOR, PROP_VALUE_COLOR,
374 g_param_spec_get_blurb (param), RESET_COLOR);
379 n_print ("%sflags%s: ", PROP_ATTR_NAME_COLOR, RESET_COLOR);
380 readable = ! !(param->flags & G_PARAM_READABLE);
381 if (readable && obj != NULL) {
382 g_object_get_property (obj, param->name, &value);
384 /* if we can't read the property value, assume it's set to the default
385 * (which might not be entirely true for sub-classes, but that's an
386 * unlikely corner-case anyway) */
387 g_param_value_set_default (param, &value);
390 g_print ("%s%s%s%s", (first_flag) ? "" : ", ", PROP_ATTR_VALUE_COLOR,
391 _("readable"), RESET_COLOR);
394 if (param->flags & G_PARAM_WRITABLE) {
395 g_print ("%s%s%s%s", (first_flag) ? "" : ", ", PROP_ATTR_VALUE_COLOR,
396 _("writable"), RESET_COLOR);
399 if (param->flags & G_PARAM_DEPRECATED) {
400 g_print ("%s%s%s%s", (first_flag) ? "" : ", ", PROP_ATTR_VALUE_COLOR,
401 _("deprecated"), RESET_COLOR);
404 if (param->flags & GST_PARAM_CONTROLLABLE) {
405 g_print (", %s%s%s", PROP_ATTR_VALUE_COLOR, _("controllable"),
409 if (param->flags & GST_PARAM_MUTABLE_PLAYING) {
410 g_print (", %s%s%s", PROP_ATTR_VALUE_COLOR,
411 _("changeable in NULL, READY, PAUSED or PLAYING state"), RESET_COLOR);
412 } else if (param->flags & GST_PARAM_MUTABLE_PAUSED) {
413 g_print (", %s%s%s", PROP_ATTR_VALUE_COLOR,
414 _("changeable only in NULL, READY or PAUSED state"), RESET_COLOR);
415 } else if (param->flags & GST_PARAM_MUTABLE_READY) {
416 g_print (", %s%s%s", PROP_ATTR_VALUE_COLOR,
417 _("changeable only in NULL or READY state"), RESET_COLOR);
419 if (param->flags & ~KNOWN_PARAM_FLAGS) {
420 g_print ("%s0x%s%0x%s", (first_flag) ? "" : ", ", PROP_ATTR_VALUE_COLOR,
421 param->flags & ~KNOWN_PARAM_FLAGS, RESET_COLOR);
425 switch (G_VALUE_TYPE (&value)) {
428 const char *string_val = g_value_get_string (&value);
430 n_print ("%sString%s. ", DATATYPE_COLOR, RESET_COLOR);
432 if (string_val == NULL)
433 g_print ("%sDefault%s: %snull%s", PROP_ATTR_NAME_COLOR, RESET_COLOR,
434 PROP_ATTR_VALUE_COLOR, RESET_COLOR);
436 g_print ("%sDefault%s: %s\"%s\"%s", PROP_ATTR_NAME_COLOR, RESET_COLOR,
437 PROP_ATTR_VALUE_COLOR, string_val, RESET_COLOR);
442 gboolean bool_val = g_value_get_boolean (&value);
444 n_print ("%sBoolean%s. %sDefault%s: %s%s%s", DATATYPE_COLOR,
445 RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
446 PROP_ATTR_VALUE_COLOR, bool_val ? "true" : "false", RESET_COLOR);
451 GParamSpecULong *pulong = G_PARAM_SPEC_ULONG (param);
454 ("%sUnsigned Long%s. %sRange%s: %s%lu - %lu%s %sDefault%s: %s%lu%s ",
455 DATATYPE_COLOR, RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
456 PROP_ATTR_VALUE_COLOR, pulong->minimum, pulong->maximum,
457 RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
458 PROP_ATTR_VALUE_COLOR, g_value_get_ulong (&value), RESET_COLOR);
460 GST_ERROR ("%s: property '%s' of type ulong: consider changing to "
461 "uint/uint64", G_OBJECT_CLASS_NAME (obj_class),
462 g_param_spec_get_name (param));
467 GParamSpecLong *plong = G_PARAM_SPEC_LONG (param);
469 n_print ("%sLong%s. %sRange%s: %s%ld - %ld%s %sDefault%s: %s%ld%s ",
470 DATATYPE_COLOR, RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
471 PROP_ATTR_VALUE_COLOR, plong->minimum, plong->maximum, RESET_COLOR,
472 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
473 g_value_get_long (&value), RESET_COLOR);
475 GST_ERROR ("%s: property '%s' of type long: consider changing to "
476 "int/int64", G_OBJECT_CLASS_NAME (obj_class),
477 g_param_spec_get_name (param));
482 GParamSpecUInt *puint = G_PARAM_SPEC_UINT (param);
485 ("%sUnsigned Integer%s. %sRange%s: %s%u - %u%s %sDefault%s: %s%u%s ",
486 DATATYPE_COLOR, RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
487 PROP_ATTR_VALUE_COLOR, puint->minimum, puint->maximum, RESET_COLOR,
488 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
489 g_value_get_uint (&value), RESET_COLOR);
494 GParamSpecInt *pint = G_PARAM_SPEC_INT (param);
496 n_print ("%sInteger%s. %sRange%s: %s%d - %d%s %sDefault%s: %s%d%s ",
497 DATATYPE_COLOR, RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
498 PROP_ATTR_VALUE_COLOR, pint->minimum, pint->maximum, RESET_COLOR,
499 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
500 g_value_get_int (&value), RESET_COLOR);
505 GParamSpecUInt64 *puint64 = G_PARAM_SPEC_UINT64 (param);
507 n_print ("%sUnsigned Integer64%s. %sRange%s: %s%" G_GUINT64_FORMAT " - "
508 "%" G_GUINT64_FORMAT "%s %sDefault%s: %s%" G_GUINT64_FORMAT "%s ",
509 DATATYPE_COLOR, RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
510 PROP_ATTR_VALUE_COLOR, puint64->minimum, puint64->maximum,
511 RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
512 PROP_ATTR_VALUE_COLOR, g_value_get_uint64 (&value), RESET_COLOR);
517 GParamSpecInt64 *pint64 = G_PARAM_SPEC_INT64 (param);
519 n_print ("%sInteger64%s. %sRange%s: %s%" G_GINT64_FORMAT " - %"
520 G_GINT64_FORMAT "%s %sDefault%s: %s%" G_GINT64_FORMAT "%s ",
521 DATATYPE_COLOR, RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
522 PROP_ATTR_VALUE_COLOR, pint64->minimum, pint64->maximum,
523 RESET_COLOR, PROP_ATTR_NAME_COLOR, RESET_COLOR,
524 PROP_ATTR_VALUE_COLOR, g_value_get_int64 (&value), RESET_COLOR);
529 GParamSpecFloat *pfloat = G_PARAM_SPEC_FLOAT (param);
531 n_print ("%sFloat%s. %sRange%s: %s%15.7g - %15.7g%s "
532 "%sDefault%s: %s%15.7g%s ", DATATYPE_COLOR, RESET_COLOR,
533 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
534 pfloat->minimum, pfloat->maximum, RESET_COLOR, PROP_ATTR_NAME_COLOR,
535 RESET_COLOR, PROP_ATTR_VALUE_COLOR, g_value_get_float (&value),
541 GParamSpecDouble *pdouble = G_PARAM_SPEC_DOUBLE (param);
543 n_print ("%sDouble%s. %sRange%s: %s%15.7g - %15.7g%s "
544 "%sDefault%s: %s%15.7g%s ", DATATYPE_COLOR, RESET_COLOR,
545 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
546 pdouble->minimum, pdouble->maximum, RESET_COLOR,
547 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
548 g_value_get_double (&value), RESET_COLOR);
553 GST_ERROR ("%s: property '%s' of type char: consider changing to "
554 "int/string", G_OBJECT_CLASS_NAME (obj_class),
555 g_param_spec_get_name (param));
558 if (param->value_type == GST_TYPE_CAPS) {
559 const GstCaps *caps = gst_value_get_caps (&value);
562 n_print ("%sCaps%s (NULL)", DATATYPE_COLOR, RESET_COLOR);
564 print_caps (caps, " ");
566 } else if (G_IS_PARAM_SPEC_ENUM (param)) {
570 const gchar *value_nick = "";
572 values = G_ENUM_CLASS (g_type_class_ref (param->value_type))->values;
573 enum_value = g_value_get_enum (&value);
575 while (values[j].value_name) {
576 if (values[j].value == enum_value)
577 value_nick = values[j].value_nick;
581 n_print ("%sEnum \"%s\"%s %sDefault%s: %s%d, \"%s\"%s",
582 DATATYPE_COLOR, g_type_name (G_VALUE_TYPE (&value)), RESET_COLOR,
583 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
584 enum_value, value_nick, RESET_COLOR);
587 while (values[j].value_name) {
589 n_print (" %s(%d)%s: %s%-16s%s - %s%s%s",
590 PROP_ATTR_NAME_COLOR, values[j].value, RESET_COLOR,
591 PROP_ATTR_VALUE_COLOR, values[j].value_nick, RESET_COLOR,
592 DESC_COLOR, values[j].value_name, RESET_COLOR);
595 /* g_type_class_unref (ec); */
596 } else if (G_IS_PARAM_SPEC_FLAGS (param)) {
597 GParamSpecFlags *pflags = G_PARAM_SPEC_FLAGS (param);
601 vals = pflags->flags_class->values;
603 cur = flags_to_string (vals, g_value_get_flags (&value));
605 n_print ("%sFlags \"%s\"%s %sDefault%s: %s0x%08x, \"%s\"%s",
606 DATATYPE_COLOR, g_type_name (G_VALUE_TYPE (&value)), RESET_COLOR,
607 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
608 g_value_get_flags (&value), cur, RESET_COLOR);
610 while (vals[0].value_name) {
612 n_print (" %s(0x%08x)%s: %s%-16s%s - %s%s%s",
613 PROP_ATTR_NAME_COLOR, vals[0].value, RESET_COLOR,
614 PROP_ATTR_VALUE_COLOR, vals[0].value_nick, RESET_COLOR,
615 DESC_COLOR, vals[0].value_name, RESET_COLOR);
620 } else if (G_IS_PARAM_SPEC_OBJECT (param)) {
621 n_print ("%sObject of type%s %s\"%s\"%s", PROP_VALUE_COLOR,
622 RESET_COLOR, DATATYPE_COLOR,
623 g_type_name (param->value_type), RESET_COLOR);
624 } else if (G_IS_PARAM_SPEC_BOXED (param)) {
625 n_print ("%sBoxed pointer of type%s %s\"%s\"%s", PROP_VALUE_COLOR,
626 RESET_COLOR, DATATYPE_COLOR,
627 g_type_name (param->value_type), RESET_COLOR);
628 if (param->value_type == GST_TYPE_STRUCTURE) {
629 const GstStructure *s = gst_value_get_structure (&value);
631 gst_structure_foreach (s, print_field,
634 } else if (G_IS_PARAM_SPEC_POINTER (param)) {
635 if (param->value_type != G_TYPE_POINTER) {
636 n_print ("%sPointer of type%s %s\"%s\"%s.", PROP_VALUE_COLOR,
637 RESET_COLOR, DATATYPE_COLOR, g_type_name (param->value_type),
640 n_print ("%sPointer.%s", PROP_VALUE_COLOR, RESET_COLOR);
642 } else if (param->value_type == G_TYPE_VALUE_ARRAY) {
643 GParamSpecValueArray *pvarray = G_PARAM_SPEC_VALUE_ARRAY (param);
645 if (pvarray->element_spec) {
646 n_print ("%sArray of GValues of type%s %s\"%s\"%s",
647 PROP_VALUE_COLOR, RESET_COLOR, DATATYPE_COLOR,
648 g_type_name (pvarray->element_spec->value_type), RESET_COLOR);
650 n_print ("%sArray of GValues%s", PROP_VALUE_COLOR, RESET_COLOR);
652 } else if (GST_IS_PARAM_SPEC_FRACTION (param)) {
653 GstParamSpecFraction *pfraction = GST_PARAM_SPEC_FRACTION (param);
655 n_print ("%sFraction%s. %sRange%s: %s%d/%d - %d/%d%s "
656 "%sDefault%s: %s%d/%d%s ", DATATYPE_COLOR, RESET_COLOR,
657 PROP_ATTR_NAME_COLOR, RESET_COLOR, PROP_ATTR_VALUE_COLOR,
658 pfraction->min_num, pfraction->min_den, pfraction->max_num,
659 pfraction->max_den, RESET_COLOR, PROP_ATTR_NAME_COLOR,
660 RESET_COLOR, PROP_ATTR_VALUE_COLOR,
661 gst_value_get_fraction_numerator (&value),
662 gst_value_get_fraction_denominator (&value), RESET_COLOR);
663 } else if (param->value_type == GST_TYPE_ARRAY) {
664 GstParamSpecArray *parray = GST_PARAM_SPEC_ARRAY_LIST (param);
666 if (parray->element_spec) {
667 n_print ("%sGstValueArray of GValues of type%s %s\"%s\"%s",
668 PROP_VALUE_COLOR, RESET_COLOR, DATATYPE_COLOR,
669 g_type_name (parray->element_spec->value_type), RESET_COLOR);
671 n_print ("%sGstValueArray of GValues%s", PROP_VALUE_COLOR,
675 n_print ("%sUnknown type %ld%s %s\"%s\"%s", PROP_VALUE_COLOR,
676 (glong) param->value_type, RESET_COLOR, DATATYPE_COLOR,
677 g_type_name (param->value_type), RESET_COLOR);
682 g_print (" %sWrite only%s\n", PROP_VALUE_COLOR, RESET_COLOR);
688 g_value_reset (&value);
690 if (num_properties == 0)
691 n_print ("%snone%s\n", PROP_VALUE_COLOR, RESET_COLOR);
695 g_free (property_specs);
699 print_element_properties_info (GstElement * element)
702 print_object_properties_info (G_OBJECT (element),
703 G_OBJECT_GET_CLASS (element), "Element Properties");
707 print_pad_templates_info (GstElement * element, GstElementFactory * factory)
710 GstStaticPadTemplate *padtemplate;
711 GstPadTemplate *tmpl;
713 n_print ("%sPad Templates%s:\n", HEADING_COLOR, RESET_COLOR);
717 if (gst_element_factory_get_num_pad_templates (factory) == 0) {
718 n_print ("%snone%s\n", PROP_VALUE_COLOR, RESET_COLOR);
722 pads = gst_element_factory_get_static_pad_templates (factory);
724 padtemplate = (GstStaticPadTemplate *) (pads->data);
725 pads = g_list_next (pads);
727 if (padtemplate->direction == GST_PAD_SRC)
728 n_print ("%sSRC template%s: %s'%s'%s\n", PROP_NAME_COLOR, RESET_COLOR,
729 PROP_VALUE_COLOR, padtemplate->name_template, RESET_COLOR);
730 else if (padtemplate->direction == GST_PAD_SINK)
731 n_print ("%sSINK template%s: %s'%s'%s\n", PROP_NAME_COLOR, RESET_COLOR,
732 PROP_VALUE_COLOR, padtemplate->name_template, RESET_COLOR);
734 n_print ("%sUNKNOWN template%s: %s'%s'%s\n", PROP_NAME_COLOR, RESET_COLOR,
735 PROP_VALUE_COLOR, padtemplate->name_template, RESET_COLOR);
739 if (padtemplate->presence == GST_PAD_ALWAYS)
740 n_print ("%sAvailability%s: %sAlways%s\n", PROP_NAME_COLOR, RESET_COLOR,
741 PROP_VALUE_COLOR, RESET_COLOR);
742 else if (padtemplate->presence == GST_PAD_SOMETIMES)
743 n_print ("%sAvailability%s: %sSometimes%s\n", PROP_NAME_COLOR,
744 RESET_COLOR, PROP_VALUE_COLOR, RESET_COLOR);
745 else if (padtemplate->presence == GST_PAD_REQUEST) {
746 n_print ("%sAvailability%s: %sOn request%s\n", PROP_NAME_COLOR,
747 RESET_COLOR, PROP_VALUE_COLOR, RESET_COLOR);
749 n_print ("%sAvailability%s: %sUNKNOWN%s\n", PROP_NAME_COLOR, RESET_COLOR,
750 PROP_VALUE_COLOR, RESET_COLOR);
752 if (padtemplate->static_caps.string) {
753 GstCaps *caps = gst_static_caps_get (&padtemplate->static_caps);
755 n_print ("%sCapabilities%s:\n", PROP_NAME_COLOR, RESET_COLOR);
758 print_caps (caps, ""); // FIXME
761 gst_caps_unref (caps);
764 tmpl = gst_element_class_get_pad_template (GST_ELEMENT_GET_CLASS (element),
765 padtemplate->name_template);
767 GType pad_type = GST_PAD_TEMPLATE_GTYPE (tmpl);
769 if (pad_type != G_TYPE_NONE && pad_type != GST_TYPE_PAD) {
772 pad_klass = g_type_class_ref (pad_type);
773 n_print ("%sType%s: %s%s%s\n", PROP_NAME_COLOR, RESET_COLOR,
774 DATATYPE_COLOR, g_type_name (pad_type), RESET_COLOR);
775 print_object_properties_info (NULL, pad_klass, "Pad Properties");
776 g_type_class_unref (pad_klass);
791 print_clocking_info (GstElement * element)
793 gboolean requires_clock, provides_clock;
796 GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_REQUIRE_CLOCK);
798 GST_OBJECT_FLAG_IS_SET (element, GST_ELEMENT_FLAG_PROVIDE_CLOCK);
800 if (!requires_clock && !provides_clock) {
802 n_print ("%sElement has no clocking capabilities.%s\n", DESC_COLOR,
808 n_print ("%sClocking Interaction%s:\n", PROP_NAME_COLOR, RESET_COLOR);
812 if (requires_clock) {
813 n_print ("%selement requires a clock%s\n", PROP_VALUE_COLOR, RESET_COLOR);
816 if (provides_clock) {
819 clock = gst_element_get_clock (element);
821 n_print ("%selement provides a clock%s: %s%s%s\n", PROP_VALUE_COLOR,
822 RESET_COLOR, DATATYPE_COLOR, GST_OBJECT_NAME (clock), RESET_COLOR);
823 gst_object_unref (clock);
825 n_print ("%selement is supposed to provide a clock but returned NULL%s\n",
826 PROP_VALUE_COLOR, RESET_COLOR);
833 print_uri_handler_info (GstElement * element)
835 if (GST_IS_URI_HANDLER (element)) {
836 const gchar *const *uri_protocols;
837 const gchar *uri_type;
839 if (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element)) == GST_URI_SRC)
841 else if (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element)) ==
845 uri_type = "unknown";
847 uri_protocols = gst_uri_handler_get_protocols (GST_URI_HANDLER (element));
850 n_print ("%sURI handling capabilities:%s\n", PROP_NAME_COLOR, RESET_COLOR);
854 n_print ("%sElement can act as %s.%s\n", PROP_VALUE_COLOR, uri_type,
857 if (uri_protocols && *uri_protocols) {
858 n_print ("%sSupported URI protocols%s:\n", PROP_ATTR_NAME_COLOR,
861 for (; *uri_protocols != NULL; uri_protocols++)
862 n_print ("%s%s%s\n", PROP_ATTR_VALUE_COLOR, *uri_protocols,
866 n_print ("%sNo supported URI protocols%s\n", PROP_VALUE_COLOR,
872 n_print ("%sElement has no URI handling capabilities.%s\n", DESC_COLOR,
878 print_pad_info (GstElement * element)
884 n_print ("%sPads:%s\n", HEADING_COLOR, RESET_COLOR);
888 if (!element->numpads) {
889 n_print ("%snone%s\n", PROP_VALUE_COLOR, RESET_COLOR);
893 pads = element->pads;
898 pad = GST_PAD (pads->data);
899 pads = g_list_next (pads);
901 name = gst_pad_get_name (pad);
902 if (gst_pad_get_direction (pad) == GST_PAD_SRC)
903 n_print ("%sSRC%s: %s'%s'%s\n", PROP_NAME_COLOR, RESET_COLOR,
904 PROP_VALUE_COLOR, name, RESET_COLOR);
905 else if (gst_pad_get_direction (pad) == GST_PAD_SINK)
906 n_print ("%sSINK%s: %s'%s'%s\n", PROP_NAME_COLOR, RESET_COLOR,
907 PROP_VALUE_COLOR, name, RESET_COLOR);
909 n_print ("%sUNKNOWN%s: %s'%s'%s\n", PROP_NAME_COLOR, RESET_COLOR,
910 PROP_VALUE_COLOR, name, RESET_COLOR);
914 if (pad->padtemplate) {
916 n_print ("%sPad Template%s: %s'%s'%s\n", PROP_NAME_COLOR, RESET_COLOR,
917 PROP_VALUE_COLOR, pad->padtemplate->name_template, RESET_COLOR);
921 caps = gst_pad_get_current_caps (pad);
923 n_print ("%sCapabilities:%s\n", PROP_NAME_COLOR, RESET_COLOR);
925 print_caps (caps, ""); // FIXME
927 gst_caps_unref (caps);
936 has_sometimes_template (GstElement * element)
938 GstElementClass *klass = GST_ELEMENT_GET_CLASS (element);
941 for (l = klass->padtemplates; l != NULL; l = l->next) {
942 if (GST_PAD_TEMPLATE (l->data)->presence == GST_PAD_SOMETIMES)
950 gtype_needs_ptr_marker (GType type)
952 if (type == G_TYPE_POINTER)
955 if (G_TYPE_FUNDAMENTAL (type) == G_TYPE_POINTER || G_TYPE_IS_BOXED (type)
956 || G_TYPE_IS_OBJECT (type))
963 print_signal_info (GstElement * element)
965 /* Signals/Actions Block */
969 GSignalQuery *query = NULL;
971 GSList *found_signals, *l;
973 for (k = 0; k < 2; k++) {
974 found_signals = NULL;
976 /* For elements that have sometimes pads, also list a few useful GstElement
977 * signals. Put these first, so element-specific ones come later. */
978 if (k == 0 && has_sometimes_template (element)) {
979 query = g_new0 (GSignalQuery, 1);
980 g_signal_query (g_signal_lookup ("pad-added", 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 ("pad-removed", GST_TYPE_ELEMENT), query);
984 found_signals = g_slist_append (found_signals, query);
985 query = g_new0 (GSignalQuery, 1);
986 g_signal_query (g_signal_lookup ("no-more-pads", GST_TYPE_ELEMENT),
988 found_signals = g_slist_append (found_signals, query);
991 for (type = G_OBJECT_TYPE (element); type; type = g_type_parent (type)) {
992 if (type == GST_TYPE_ELEMENT || type == GST_TYPE_OBJECT)
995 if (type == GST_TYPE_BIN && G_OBJECT_TYPE (element) != GST_TYPE_BIN)
998 signals = g_signal_list_ids (type, &nsignals);
999 for (i = 0; i < nsignals; i++) {
1000 query = g_new0 (GSignalQuery, 1);
1001 g_signal_query (signals[i], query);
1003 if ((k == 0 && !(query->signal_flags & G_SIGNAL_ACTION)) ||
1004 (k == 1 && (query->signal_flags & G_SIGNAL_ACTION)))
1005 found_signals = g_slist_append (found_signals, query);
1013 if (found_signals) {
1016 n_print ("%sElement Signals%s:\n", HEADING_COLOR, RESET_COLOR);
1018 n_print ("%sElement Actions%s:\n", HEADING_COLOR, RESET_COLOR);
1023 for (l = found_signals; l; l = l->next) {
1028 query = (GSignalQuery *) l->data;
1029 indent_len = strlen (query->signal_name) +
1030 strlen (g_type_name (query->return_type)) + 24;
1032 if (gtype_needs_ptr_marker (query->return_type)) {
1039 indent = g_new0 (gchar, indent_len + 1);
1040 memset (indent, ' ', indent_len);
1042 n_print (" %s\"%s\"%s : %s%s%s%suser_function%s (%s%s%s* object%s",
1043 PROP_NAME_COLOR, query->signal_name, RESET_COLOR,
1044 DATATYPE_COLOR, g_type_name (query->return_type), PROP_VALUE_COLOR,
1045 pmark, RESET_COLOR, DATATYPE_COLOR, g_type_name (type),
1046 PROP_VALUE_COLOR, RESET_COLOR);
1048 for (j = 0; j < query->n_params; j++) {
1049 const gchar *type_name, *asterisk;
1051 type_name = g_type_name (query->param_types[j]);
1052 asterisk = gtype_needs_ptr_marker (query->param_types[j]) ? "*" : "";
1055 n_print ("%s%s%s%s%s arg%d%s", indent, DATATYPE_COLOR, type_name,
1056 PROP_VALUE_COLOR, asterisk, j, RESET_COLOR);
1061 n_print ("%s%sgpointer %suser_data%s);\n", indent, DATATYPE_COLOR,
1062 PROP_VALUE_COLOR, RESET_COLOR);
1069 if (found_signals) {
1070 g_slist_foreach (found_signals, (GFunc) g_free, NULL);
1071 g_slist_free (found_signals);
1077 print_children_info (GstElement * element)
1081 if (!GST_IS_BIN (element))
1084 children = (GList *) GST_BIN (element)->children;
1087 n_print ("%sChildren%s:\n", HEADING_COLOR, RESET_COLOR);
1091 n_print (" %s%s%s\n", DATATYPE_COLOR,
1092 GST_ELEMENT_NAME (GST_ELEMENT (children->data)), RESET_COLOR);
1093 children = g_list_next (children);
1098 print_preset_list (GstElement * element)
1100 gchar **presets, **preset;
1102 if (!GST_IS_PRESET (element))
1105 presets = gst_preset_get_preset_names (GST_PRESET (element));
1106 if (presets && *presets) {
1108 n_print ("%sPresets%s:\n", HEADING_COLOR, RESET_COLOR);
1109 for (preset = presets; *preset; preset++) {
1110 n_print (" \"%s\"\n", *preset);
1112 g_strfreev (presets);
1117 print_blacklist (void)
1119 GList *plugins, *cur;
1122 g_print ("%s%s%s\n", HEADING_COLOR, _("Blacklisted files:"), RESET_COLOR);
1124 plugins = gst_registry_get_plugin_list (gst_registry_get ());
1125 for (cur = plugins; cur != NULL; cur = g_list_next (cur)) {
1126 GstPlugin *plugin = (GstPlugin *) (cur->data);
1127 if (GST_OBJECT_FLAG_IS_SET (plugin, GST_PLUGIN_FLAG_BLACKLISTED)) {
1128 g_print (" %s\n", gst_plugin_get_name (plugin));
1134 g_print (_("%sTotal count%s: %s"), PROP_NAME_COLOR, RESET_COLOR,
1136 g_print (ngettext ("%d blacklisted file", "%d blacklisted files", count),
1138 g_print ("%s\n", RESET_COLOR);
1139 gst_plugin_list_free (plugins);
1143 print_typefind_extensions (const gchar * const *extensions, const gchar * color)
1147 while (extensions[i]) {
1148 g_print ("%s%s%s%s", i > 0 ? ", " : "", color, extensions[i], RESET_COLOR);
1154 print_element_list (gboolean print_all, gchar * ftypes)
1156 int plugincount = 0, featurecount = 0, blacklistcount = 0;
1157 GList *plugins, *orig_plugins;
1158 gchar **types = NULL;
1163 types = g_strsplit (ftypes, "/", -1);
1164 for (i = 0; types[i]; i++)
1165 *types[i] = g_ascii_toupper (*types[i]);
1169 orig_plugins = plugins = gst_registry_get_plugin_list (gst_registry_get ());
1171 GList *features, *orig_features;
1174 plugin = (GstPlugin *) (plugins->data);
1175 plugins = g_list_next (plugins);
1178 if (GST_OBJECT_FLAG_IS_SET (plugin, GST_PLUGIN_FLAG_BLACKLISTED)) {
1183 orig_features = features =
1184 gst_registry_get_feature_list_by_plugin (gst_registry_get (),
1185 gst_plugin_get_name (plugin));
1187 GstPluginFeature *feature;
1189 if (G_UNLIKELY (features->data == NULL))
1191 feature = GST_PLUGIN_FEATURE (features->data);
1194 if (GST_IS_ELEMENT_FACTORY (feature)) {
1196 GstElementFactory *factory;
1198 factory = GST_ELEMENT_FACTORY (feature);
1201 gboolean all_found = TRUE;
1204 gst_element_factory_get_metadata (factory,
1205 GST_ELEMENT_METADATA_KLASS);
1206 for (i = 0; types[i]; i++) {
1207 if (!strstr (klass, types[i])) {
1217 print_element_info (feature, TRUE);
1219 g_print ("%s%s%s: %s%s%s: %s%s%s\n", PLUGIN_NAME_COLOR,
1220 gst_plugin_get_name (plugin), RESET_COLOR, ELEMENT_NAME_COLOR,
1221 GST_OBJECT_NAME (factory), RESET_COLOR, ELEMENT_DETAIL_COLOR,
1222 gst_element_factory_get_metadata (factory,
1223 GST_ELEMENT_METADATA_LONGNAME), RESET_COLOR);
1224 } else if (GST_IS_TYPE_FIND_FACTORY (feature)) {
1225 GstTypeFindFactory *factory;
1226 const gchar *const *extensions;
1230 factory = GST_TYPE_FIND_FACTORY (feature);
1232 g_print ("%s%s%s: %s%s%s: ", PLUGIN_NAME_COLOR,
1233 gst_plugin_get_name (plugin), RESET_COLOR, ELEMENT_NAME_COLOR,
1234 gst_plugin_feature_get_name (feature), RESET_COLOR);
1236 extensions = gst_type_find_factory_get_extensions (factory);
1237 if (extensions != NULL) {
1239 print_typefind_extensions (extensions, ELEMENT_DETAIL_COLOR);
1244 g_print ("%sno extensions%s\n", ELEMENT_DETAIL_COLOR, RESET_COLOR);
1250 n_print ("%s%s%s: %s%s%s (%s%s%s)\n", PLUGIN_NAME_COLOR,
1251 gst_plugin_get_name (plugin), RESET_COLOR, ELEMENT_NAME_COLOR,
1252 GST_OBJECT_NAME (feature), RESET_COLOR, ELEMENT_DETAIL_COLOR,
1253 g_type_name (G_OBJECT_TYPE (feature)), RESET_COLOR);
1257 features = g_list_next (features);
1260 gst_plugin_feature_list_free (orig_features);
1263 gst_plugin_list_free (orig_plugins);
1267 g_print (_("%sTotal count%s: %s"), PROP_NAME_COLOR, RESET_COLOR,
1269 g_print (ngettext ("%d plugin", "%d plugins", plugincount), plugincount);
1270 if (blacklistcount) {
1272 g_print (ngettext ("%d blacklist entry", "%d blacklist entries",
1273 blacklistcount), blacklistcount);
1274 g_print (" not shown)");
1276 g_print ("%s, %s", RESET_COLOR, PROP_VALUE_COLOR);
1277 g_print (ngettext ("%d feature", "%d features", featurecount), featurecount);
1278 g_print ("%s\n", RESET_COLOR);
1282 print_all_uri_handlers (void)
1284 GList *plugins, *p, *features, *f;
1286 plugins = gst_registry_get_plugin_list (gst_registry_get ());
1288 for (p = plugins; p; p = p->next) {
1289 GstPlugin *plugin = (GstPlugin *) (p->data);
1292 gst_registry_get_feature_list_by_plugin (gst_registry_get (),
1293 gst_plugin_get_name (plugin));
1295 for (f = features; f; f = f->next) {
1296 GstPluginFeature *feature = GST_PLUGIN_FEATURE (f->data);
1298 if (GST_IS_ELEMENT_FACTORY (feature)) {
1299 GstElementFactory *factory;
1300 GstElement *element;
1302 factory = GST_ELEMENT_FACTORY (gst_plugin_feature_load (feature));
1304 g_print ("element plugin %s couldn't be loaded\n",
1305 gst_plugin_get_name (plugin));
1309 element = gst_element_factory_create (factory, NULL);
1311 g_print ("couldn't construct element for %s for some reason\n",
1312 GST_OBJECT_NAME (factory));
1313 gst_object_unref (factory);
1317 if (GST_IS_URI_HANDLER (element)) {
1318 const gchar *const *uri_protocols;
1319 const gchar *const *protocol;
1322 switch (gst_uri_handler_get_uri_type (GST_URI_HANDLER (element))) {
1334 g_print ("%s%s%s (%s%s%s, %srank %u%s): ",
1336 gst_plugin_feature_get_name (GST_PLUGIN_FEATURE (factory)),
1337 RESET_COLOR, FEATURE_DIR_COLOR, dir, RESET_COLOR,
1339 gst_plugin_feature_get_rank (GST_PLUGIN_FEATURE (factory)),
1343 gst_uri_handler_get_protocols (GST_URI_HANDLER (element));
1344 for (protocol = uri_protocols; *protocol != NULL; protocol++) {
1345 if (protocol != uri_protocols)
1347 g_print ("%s%s%s", FEATURE_PROTO_COLOR, *protocol, RESET_COLOR);
1352 gst_object_unref (element);
1353 gst_object_unref (factory);
1357 gst_plugin_feature_list_free (features);
1360 gst_plugin_list_free (plugins);
1364 print_plugin_info (GstPlugin * plugin)
1366 const gchar *release_date = gst_plugin_get_release_date_string (plugin);
1367 const gchar *filename = gst_plugin_get_filename (plugin);
1369 n_print ("%sPlugin Details%s:\n", HEADING_COLOR, RESET_COLOR);
1373 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "Name", RESET_COLOR,
1374 PROP_VALUE_COLOR, gst_plugin_get_name (plugin), RESET_COLOR);
1375 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "Description", RESET_COLOR,
1376 PROP_VALUE_COLOR, gst_plugin_get_description (plugin), RESET_COLOR);
1377 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "Filename", RESET_COLOR,
1378 PROP_VALUE_COLOR, (filename != NULL) ? filename : "(null)", RESET_COLOR);
1379 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "Version", RESET_COLOR,
1380 PROP_VALUE_COLOR, gst_plugin_get_version (plugin), RESET_COLOR);
1381 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "License", RESET_COLOR,
1382 PROP_VALUE_COLOR, gst_plugin_get_license (plugin), RESET_COLOR);
1383 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "Source module", RESET_COLOR,
1384 PROP_VALUE_COLOR, gst_plugin_get_source (plugin), RESET_COLOR);
1386 if (release_date != NULL) {
1387 const gchar *tz = "(UTC)";
1390 /* may be: YYYY-MM-DD or YYYY-MM-DDTHH:MMZ */
1391 /* YYYY-MM-DDTHH:MMZ => YYYY-MM-DD HH:MM (UTC) */
1392 str = g_strdup (release_date);
1393 sep = strstr (str, "T");
1396 sep = strstr (sep + 1, "Z");
1402 n_print ("%s%-25s%s%s%s%s%s\n", PROP_NAME_COLOR, "Source release date",
1403 RESET_COLOR, PROP_VALUE_COLOR, str, tz, RESET_COLOR);
1406 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "Binary package", RESET_COLOR,
1407 PROP_VALUE_COLOR, gst_plugin_get_package (plugin), RESET_COLOR);
1408 n_print ("%s%-25s%s%s%s%s\n", PROP_NAME_COLOR, "Origin URL", RESET_COLOR,
1409 PROP_VALUE_COLOR, gst_plugin_get_origin (plugin), RESET_COLOR);
1417 print_plugin_features (GstPlugin * plugin)
1419 GList *features, *origlist;
1420 gint num_features = 0;
1421 gint num_elements = 0;
1422 gint num_tracers = 0;
1423 gint num_typefinders = 0;
1424 gint num_devproviders = 0;
1427 origlist = features =
1428 gst_registry_get_feature_list_by_plugin (gst_registry_get (),
1429 gst_plugin_get_name (plugin));
1432 GstPluginFeature *feature;
1434 feature = GST_PLUGIN_FEATURE (features->data);
1436 if (GST_IS_ELEMENT_FACTORY (feature)) {
1437 GstElementFactory *factory;
1439 factory = GST_ELEMENT_FACTORY (feature);
1440 n_print (" %s%s%s: %s%s%s\n", ELEMENT_NAME_COLOR,
1441 GST_OBJECT_NAME (factory), RESET_COLOR, ELEMENT_DETAIL_COLOR,
1442 gst_element_factory_get_metadata (factory,
1443 GST_ELEMENT_METADATA_LONGNAME), RESET_COLOR);
1445 } else if (GST_IS_TYPE_FIND_FACTORY (feature)) {
1446 GstTypeFindFactory *factory;
1447 const gchar *const *extensions;
1449 factory = GST_TYPE_FIND_FACTORY (feature);
1450 extensions = gst_type_find_factory_get_extensions (factory);
1452 g_print (" %s%s%s: ", ELEMENT_NAME_COLOR,
1453 gst_plugin_feature_get_name (feature), RESET_COLOR);
1454 print_typefind_extensions (extensions, ELEMENT_DETAIL_COLOR);
1457 g_print (" %s%s%s: %sno extensions%s\n", ELEMENT_NAME_COLOR,
1458 gst_plugin_feature_get_name (feature), RESET_COLOR,
1459 ELEMENT_DETAIL_COLOR, RESET_COLOR);
1462 } else if (GST_IS_DEVICE_PROVIDER_FACTORY (feature)) {
1463 GstDeviceProviderFactory *factory;
1465 factory = GST_DEVICE_PROVIDER_FACTORY (feature);
1466 n_print (" %s%s%s: %s%s%s\n", ELEMENT_NAME_COLOR,
1467 GST_OBJECT_NAME (factory), RESET_COLOR, ELEMENT_DETAIL_COLOR,
1468 gst_device_provider_factory_get_metadata (factory,
1469 GST_ELEMENT_METADATA_LONGNAME), RESET_COLOR);
1471 } else if (GST_IS_TRACER_FACTORY (feature)) {
1472 n_print (" %s%s%s (%s%s%s)\n", ELEMENT_NAME_COLOR,
1473 gst_object_get_name (GST_OBJECT (feature)), RESET_COLOR,
1474 DATATYPE_COLOR, g_type_name (G_OBJECT_TYPE (feature)), RESET_COLOR);
1476 } else if (feature) {
1477 n_print (" %s%s%s (%s%s%s)\n", ELEMENT_NAME_COLOR,
1478 gst_object_get_name (GST_OBJECT (feature)), RESET_COLOR,
1479 DATATYPE_COLOR, g_type_name (G_OBJECT_TYPE (feature)), RESET_COLOR);
1483 features = g_list_next (features);
1486 gst_plugin_feature_list_free (origlist);
1489 n_print (" %s%d features%s:\n", HEADING_COLOR, num_features, RESET_COLOR);
1490 if (num_elements > 0)
1491 n_print (" %s+--%s %s%d elements%s\n", CHILD_LINK_COLOR, RESET_COLOR,
1492 PLUGIN_FEATURE_COLOR, num_elements, RESET_COLOR);
1493 if (num_typefinders > 0)
1494 n_print (" %s+--%s %s%d typefinders%s\n", CHILD_LINK_COLOR, RESET_COLOR,
1495 PLUGIN_FEATURE_COLOR, num_typefinders, RESET_COLOR);
1496 if (num_devproviders > 0)
1497 n_print (" %s+--%s %s%d device providers%s\n", CHILD_LINK_COLOR,
1498 RESET_COLOR, PLUGIN_FEATURE_COLOR, num_devproviders, RESET_COLOR);
1499 if (num_tracers > 0)
1500 n_print (" %s+--%s %s%d tracers%s\n", CHILD_LINK_COLOR, RESET_COLOR,
1501 PLUGIN_FEATURE_COLOR, num_tracers, RESET_COLOR);
1503 n_print (" %s+--%s %s%d other objects%s\n", CHILD_LINK_COLOR, RESET_COLOR,
1504 PLUGIN_FEATURE_COLOR, num_other, RESET_COLOR);
1510 print_feature_info (const gchar * feature_name, gboolean print_all)
1512 GstPluginFeature *feature;
1513 GstRegistry *registry = gst_registry_get ();
1516 if ((feature = gst_registry_find_feature (registry, feature_name,
1517 GST_TYPE_ELEMENT_FACTORY))) {
1518 ret = print_element_info (feature, print_all);
1521 if ((feature = gst_registry_find_feature (registry, feature_name,
1522 GST_TYPE_TYPE_FIND_FACTORY))) {
1523 ret = print_typefind_info (feature, print_all);
1526 if ((feature = gst_registry_find_feature (registry, feature_name,
1527 GST_TYPE_TRACER_FACTORY))) {
1528 ret = print_tracer_info (feature, print_all);
1532 /* TODO: handle DEVICE_PROVIDER_FACTORY */
1537 gst_object_unref (feature);
1542 print_element_info (GstPluginFeature * feature, gboolean print_names)
1544 GstElementFactory *factory;
1545 GstElement *element;
1549 factory = GST_ELEMENT_FACTORY (gst_plugin_feature_load (feature));
1551 g_print ("%selement plugin couldn't be loaded%s\n", DESC_COLOR,
1556 element = gst_element_factory_create (factory, NULL);
1558 gst_object_unref (factory);
1559 g_print ("%scouldn't construct element for some reason%s\n", DESC_COLOR,
1566 g_strdup_printf ("%s%s%s: ", DATATYPE_COLOR, GST_OBJECT_NAME (factory),
1571 print_factory_details_info (factory);
1573 plugin = gst_plugin_feature_get_plugin (GST_PLUGIN_FEATURE (factory));
1575 print_plugin_info (plugin);
1576 gst_object_unref (plugin);
1579 print_hierarchy (G_OBJECT_TYPE (element), 0, &maxlevel);
1580 print_interfaces (G_OBJECT_TYPE (element));
1582 print_pad_templates_info (element, factory);
1583 print_clocking_info (element);
1584 print_uri_handler_info (element);
1585 print_pad_info (element);
1586 print_element_properties_info (element);
1587 print_signal_info (element);
1588 print_children_info (element);
1589 print_preset_list (element);
1591 gst_object_unref (element);
1592 gst_object_unref (factory);
1598 print_typefind_info (GstPluginFeature * feature, gboolean print_names)
1600 GstTypeFindFactory *factory;
1605 const gchar *const *extensions;
1607 factory = GST_TYPE_FIND_FACTORY (gst_plugin_feature_load (feature));
1609 g_print ("%stypefind plugin couldn't be loaded%s\n", DESC_COLOR,
1616 g_strdup_printf ("%s%s%s: ", DATATYPE_COLOR, GST_OBJECT_NAME (factory),
1621 n_print ("%sFactory Details%s:\n", HEADING_COLOR, RESET_COLOR);
1622 rank = gst_plugin_feature_get_rank (feature);
1623 n_print (" %s%-25s%s%s (%d)%s\n", PROP_NAME_COLOR, "Rank", PROP_VALUE_COLOR,
1624 get_rank_name (s, rank), rank, RESET_COLOR);
1625 n_print (" %s%-25s%s%s%s\n", PROP_NAME_COLOR, "Name", PROP_VALUE_COLOR,
1626 GST_OBJECT_NAME (factory), RESET_COLOR);
1627 caps = gst_type_find_factory_get_caps (factory);
1629 gchar *caps_str = gst_caps_to_string (factory->caps);
1631 n_print (" %s%-25s%s%s%s\n", PROP_NAME_COLOR, "Caps", PROP_VALUE_COLOR,
1632 caps_str, RESET_COLOR);
1635 extensions = gst_type_find_factory_get_extensions (factory);
1637 n_print (" %s%-25s%s", PROP_NAME_COLOR, "Extensions", RESET_COLOR);
1638 print_typefind_extensions (extensions, PROP_VALUE_COLOR);
1643 plugin = gst_plugin_feature_get_plugin (GST_PLUGIN_FEATURE (factory));
1645 print_plugin_info (plugin);
1646 gst_object_unref (plugin);
1649 gst_object_unref (factory);
1655 print_tracer_info (GstPluginFeature * feature, gboolean print_names)
1657 GstTracerFactory *factory;
1662 factory = GST_TRACER_FACTORY (gst_plugin_feature_load (feature));
1664 g_print ("%stracer plugin couldn't be loaded%s\n", DESC_COLOR, RESET_COLOR);
1668 tracer = (GstTracer *) g_object_new (factory->type, NULL);
1670 gst_object_unref (factory);
1671 g_print ("%scouldn't construct tracer for some reason%s\n", DESC_COLOR,
1678 g_strdup_printf ("%s%s%s: ", DATATYPE_COLOR, GST_OBJECT_NAME (factory),
1683 n_print ("%sFactory Details%s:\n", HEADING_COLOR, RESET_COLOR);
1684 n_print (" %s%-25s%s%s%s\n", PROP_NAME_COLOR, "Name", PROP_VALUE_COLOR,
1685 GST_OBJECT_NAME (factory), RESET_COLOR);
1688 plugin = gst_plugin_feature_get_plugin (GST_PLUGIN_FEATURE (factory));
1690 print_plugin_info (plugin);
1691 gst_object_unref (plugin);
1694 print_hierarchy (G_OBJECT_TYPE (tracer), 0, &maxlevel);
1695 print_interfaces (G_OBJECT_TYPE (tracer));
1697 /* TODO: list what hooks it registers
1698 * - the data is available in gsttracerutils, we need to iterate the
1699 * _priv_tracers hashtable for each probe and then check the list of hooks
1700 * for each probe whether hook->tracer == tracer :/
1703 /* TODO: list what records it emits
1704 * - in class_init tracers can create GstTracerRecord instances
1705 * - those only get logged right now and there is no association with the
1706 * tracer that created them
1707 * - we'd need to add them to GstTracerFactory
1708 * gst_tracer_class_add_record (klass, record);
1709 * - needs work in gstregistrychunks to (de)serialize specs
1710 * - gst_tracer_register() would need to iterate the list of records and
1711 * copy the record->spec into the factory
1714 gst_object_unref (tracer);
1715 gst_object_unref (factory);
1720 /* NOTE: Not coloring output from automatic install functions, as their output
1721 * is meant for machines, not humans.
1724 print_plugin_automatic_install_info_codecs (GstElementFactory * factory)
1726 GstPadDirection direction;
1727 const gchar *type_name;
1729 const GList *static_templates, *l;
1730 GstCaps *caps = NULL;
1734 gst_element_factory_get_metadata (factory, GST_ELEMENT_METADATA_KLASS);
1735 g_return_if_fail (klass != NULL);
1737 if (strstr (klass, "Demuxer") ||
1738 strstr (klass, "Decoder") ||
1739 strstr (klass, "Depay") || strstr (klass, "Parser")) {
1740 type_name = "decoder";
1741 direction = GST_PAD_SINK;
1742 } else if (strstr (klass, "Muxer") ||
1743 strstr (klass, "Encoder") || strstr (klass, "Pay")) {
1744 type_name = "encoder";
1745 direction = GST_PAD_SRC;
1750 /* decoder/demuxer sink pads should always be static and there should only
1751 * be one, the same applies to encoders/muxers and source pads */
1752 static_templates = gst_element_factory_get_static_pad_templates (factory);
1753 for (l = static_templates; l != NULL; l = l->next) {
1754 GstStaticPadTemplate *tmpl = NULL;
1756 tmpl = (GstStaticPadTemplate *) l->data;
1757 if (tmpl->direction == direction) {
1758 caps = gst_static_pad_template_get_caps (tmpl);
1764 g_printerr ("Couldn't find static pad template for %s '%s'\n",
1765 type_name, GST_OBJECT_NAME (factory));
1769 caps = gst_caps_make_writable (caps);
1770 num = gst_caps_get_size (caps);
1771 for (i = 0; i < num; ++i) {
1775 s = gst_caps_get_structure (caps, i);
1776 /* remove fields that are almost always just MIN-MAX of some sort
1777 * in order to make the caps look less messy */
1778 gst_structure_remove_field (s, "pixel-aspect-ratio");
1779 gst_structure_remove_field (s, "framerate");
1780 gst_structure_remove_field (s, "channels");
1781 gst_structure_remove_field (s, "width");
1782 gst_structure_remove_field (s, "height");
1783 gst_structure_remove_field (s, "rate");
1784 gst_structure_remove_field (s, "depth");
1785 gst_structure_remove_field (s, "clock-rate");
1786 s_str = gst_structure_to_string (s);
1787 g_print ("%s-%s\n", type_name, s_str);
1790 gst_caps_unref (caps);
1794 print_plugin_automatic_install_info_protocols (GstElementFactory * factory)
1796 const gchar *const *protocols;
1798 protocols = gst_element_factory_get_uri_protocols (factory);
1799 if (protocols != NULL && *protocols != NULL) {
1800 switch (gst_element_factory_get_uri_type (factory)) {
1802 while (*protocols != NULL) {
1803 g_print ("urisink-%s\n", *protocols);
1808 while (*protocols != NULL) {
1809 g_print ("urisource-%s\n", *protocols);
1820 print_plugin_automatic_install_info (GstPlugin * plugin)
1822 GList *features, *l;
1824 /* not interested in typefind factories, only element factories */
1825 features = gst_registry_get_feature_list (gst_registry_get (),
1826 GST_TYPE_ELEMENT_FACTORY);
1828 for (l = features; l != NULL; l = l->next) {
1829 GstPluginFeature *feature;
1830 GstPlugin *feature_plugin;
1832 feature = GST_PLUGIN_FEATURE (l->data);
1834 /* only interested in the ones that are in the plugin we just loaded */
1835 feature_plugin = gst_plugin_feature_get_plugin (feature);
1836 if (feature_plugin == plugin) {
1837 GstElementFactory *factory;
1839 g_print ("element-%s\n", gst_plugin_feature_get_name (feature));
1841 factory = GST_ELEMENT_FACTORY (feature);
1842 print_plugin_automatic_install_info_protocols (factory);
1843 print_plugin_automatic_install_info_codecs (factory);
1846 gst_object_unref (feature_plugin);
1849 g_list_foreach (features, (GFunc) gst_object_unref, NULL);
1850 g_list_free (features);
1854 print_all_plugin_automatic_install_info (void)
1856 GList *plugins, *orig_plugins;
1858 orig_plugins = plugins = gst_registry_get_plugin_list (gst_registry_get ());
1862 plugin = (GstPlugin *) (plugins->data);
1863 plugins = g_list_next (plugins);
1865 print_plugin_automatic_install_info (plugin);
1867 gst_plugin_list_free (orig_plugins);
1872 redirect_stdout (void)
1877 if (pipe (pipefd) == -1) {
1878 g_printerr (_("Error creating pipe: %s\n"), g_strerror (errno));
1883 if (child_id == -1) {
1884 g_printerr (_("Error forking: %s\n"), g_strerror (errno));
1888 if (child_id == 0) {
1893 pager = g_getenv ("PAGER");
1895 pager = DEFAULT_PAGER;
1896 argv = g_strsplit (pager, " ", 0);
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)) {
2037 gst_tools_print_version ();
2039 if (print_all && argc > 1) {
2040 g_printerr ("-a requires no extra arguments\n");
2044 if (uri_handlers && argc > 1) {
2045 g_printerr ("-u requires no extra arguments\n");
2049 /* --atleast-version implies --exists */
2050 if (min_version != NULL) {
2051 if (sscanf (min_version, "%u.%u.%u", &minver_maj, &minver_min,
2052 &minver_micro) < 2) {
2053 g_printerr ("Can't parse version '%s' passed to --atleast-version\n",
2057 check_exists = TRUE;
2064 g_printerr ("--exists requires an extra command line argument\n");
2068 GstPluginFeature *feature;
2070 feature = gst_registry_lookup_feature (gst_registry_get (), argv[1]);
2071 if (feature != NULL && gst_plugin_feature_check_version (feature,
2072 minver_maj, minver_min, minver_micro)) {
2079 gst_object_unref (feature);
2081 /* FIXME: support checking for plugins too */
2082 g_printerr ("Checking for plugins is not supported yet\n");
2089 /* if no arguments, print out list of elements */
2091 print_all_uri_handlers ();
2092 } else if (argc == 1 || print_all) {
2093 if (do_print_blacklist)
2097 print_all_plugin_automatic_install_info ();
2099 print_element_list (print_all, types);
2102 /* else we try to get a factory */
2103 const char *arg = argv[argc - 1];
2107 retval = print_feature_info (arg, print_all);
2110 /* otherwise check if it's a plugin */
2112 GstPlugin *plugin = gst_registry_find_plugin (gst_registry_get (), arg);
2114 /* if there is such a plugin, print out info */
2117 print_plugin_automatic_install_info (plugin);
2119 print_plugin_info (plugin);
2120 print_plugin_features (plugin);
2123 GError *error = NULL;
2125 if (g_file_test (arg, G_FILE_TEST_EXISTS)) {
2126 plugin = gst_plugin_load_file (arg, &error);
2130 print_plugin_automatic_install_info (plugin);
2132 print_plugin_info (plugin);
2133 print_plugin_features (plugin);
2136 g_printerr (_("Could not load plugin file: %s\n"), error->message);
2137 g_clear_error (&error);
2141 g_printerr (_("No such element or plugin '%s'\n"), arg);
2151 /* So that the pipe we create in redirect_stdout() is closed */
2152 close (STDOUT_FILENO);
2153 close (STDERR_FILENO);