2 * Copyright (C) 2007 Stefan Kost <ensonic@users.sf.net>
4 * gstdebugutils.c: debugging and analysis utillities
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
22 * edge [ constraint=false ];
23 * this creates strange graphs ("minlen=0" is better)
24 * try puting src/sink ghostpads for each bin into invisible clusters
26 * for more compact nodes, try
27 * - changing node-shape from box into record
28 * - use labels like : element [ label="{element | <src> src | <sink> sink}"]
29 * - point to record-connectors : element1:src -> element2:sink
30 * - we use head/tail labels for pad-caps right now
31 * - this does not work well, as dot seems to not look at their size when
33 * - we could add the caps to the pad itself, then we should use one line per
34 * caps (simple caps = one line)
37 #include "gst_private.h"
38 #include "gstdebugutils.h"
40 #ifndef GST_DISABLE_GST_DEBUG
49 #include "gstobject.h"
50 #include "gstghostpad.h"
55 /*** PIPELINE GRAPHS **********************************************************/
57 const gchar *priv_gst_dump_dot_dir; /* NULL *//* set from gst.c */
59 const gchar spaces[] = {
66 extern GstClockTime _priv_gst_info_start_time;
69 debug_dump_make_object_name (GstObject * obj)
71 return g_strcanon (g_strdup_printf ("%s_%p", GST_OBJECT_NAME (obj), obj),
72 G_CSET_A_2_Z G_CSET_a_2_z G_CSET_DIGITS "_", '_');
76 debug_dump_get_element_state (GstElement * element)
78 gchar *state_name = NULL;
79 const gchar *state_icons = "~0-=>";
80 GstState state = GST_STATE_VOID_PENDING, pending = GST_STATE_VOID_PENDING;
82 gst_element_get_state (element, &state, &pending, 0);
83 if (pending == GST_STATE_VOID_PENDING) {
84 gboolean is_locked = gst_element_is_locked_state (element);
85 state_name = g_strdup_printf ("\\n[%c]%s", state_icons[state],
86 (is_locked ? "(locked)" : ""));
88 state_name = g_strdup_printf ("\\n[%c] -> [%c]", state_icons[state],
89 state_icons[pending]);
95 debug_dump_get_element_params (GstElement * element)
97 gchar *param_name = NULL;
98 GParamSpec **properties, *property;
99 GValue value = { 0, };
100 guint i, number_of_properties;
101 gchar *tmp, *value_str;
103 /* get paramspecs and show non-default properties */
105 g_object_class_list_properties (G_OBJECT_CLASS (GST_ELEMENT_GET_CLASS
106 (element)), &number_of_properties);
108 for (i = 0; i < number_of_properties; i++) {
109 property = properties[i];
111 /* ski some properties */
112 if (!(property->flags & G_PARAM_READABLE))
114 if (!strcmp (property->name, "name"))
117 g_value_init (&value, property->value_type);
118 g_object_get_property (G_OBJECT (element), property->name, &value);
119 if (!(g_param_value_defaults (property, &value))) {
120 tmp = g_strdup_value_contents (&value);
121 value_str = g_strescape (tmp, NULL);
125 param_name = g_strdup_printf ("%s\\n%s=%s",
126 tmp, property->name, value_str);
129 param_name = g_strdup_printf ("\\n%s=%s", property->name, value_str);
133 g_value_unset (&value);
141 debug_dump_pad (GstPad * pad, const gchar * color_name,
142 const gchar * element_name, GstDebugGraphDetails details, FILE * out,
145 GstPadTemplate *pad_templ;
146 GstPadPresence presence;
148 const gchar *style_name;
149 const gchar *spc = &spaces[MAX (sizeof (spaces) - (1 + indent * 2), 0)];
151 pad_name = debug_dump_make_object_name (GST_OBJECT (pad));
153 /* pad availability */
154 style_name = "filled,solid";
155 if ((pad_templ = gst_pad_get_pad_template (pad))) {
156 presence = GST_PAD_TEMPLATE_PRESENCE (pad_templ);
157 if (presence == GST_PAD_SOMETIMES) {
158 style_name = "filled,dotted";
159 } else if (presence == GST_PAD_REQUEST) {
160 style_name = "filled,dashed";
163 if (details & GST_DEBUG_GRAPH_SHOW_STATES) {
165 const gchar *activation_mode = "-><";
167 /* check if pad flags */
169 GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_BLOCKED) ? 'B' : 'b';
171 GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_FLUSHING) ? 'F' : 'f';
173 GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_BLOCKING) ? 'B' : 'b';
177 "%s %s_%s [color=black, fillcolor=\"%s\", label=\"%s\\n[%c][%s]\", height=\"0.2\", style=\"%s\"];\n",
178 spc, element_name, pad_name, color_name, GST_OBJECT_NAME (pad),
179 activation_mode[pad->mode], pad_flags, style_name);
182 "%s %s_%s [color=black, fillcolor=\"%s\", label=\"%s\", height=\"0.2\", style=\"%s\"];\n",
183 spc, element_name, pad_name, color_name, GST_OBJECT_NAME (pad),
191 debug_dump_element_pad (GstPad * pad, GstElement * element,
192 GstDebugGraphDetails details, FILE * out, const gint indent)
194 GstElement *target_element;
195 GstPad *target_pad, *tmp_pad;
198 gchar *target_element_name;
199 const gchar *color_name;
201 dir = gst_pad_get_direction (pad);
202 element_name = debug_dump_make_object_name (GST_OBJECT (element));
203 if (GST_IS_GHOST_PAD (pad)) {
205 (dir == GST_PAD_SRC) ? "#ffdddd" : ((dir ==
206 GST_PAD_SINK) ? "#ddddff" : "#ffffff");
207 /* output target-pad so that it belongs to this element */
208 if ((tmp_pad = gst_ghost_pad_get_target (GST_GHOST_PAD (pad)))) {
209 if ((target_pad = gst_pad_get_peer (tmp_pad))) {
210 gchar *pad_name, *target_pad_name;
211 const gchar *spc = &spaces[MAX (sizeof (spaces) - (1 + indent * 2), 0)];
213 if ((target_element = gst_pad_get_parent_element (target_pad))) {
214 target_element_name =
215 debug_dump_make_object_name (GST_OBJECT (target_element));
217 target_element_name = g_strdup ("");
219 debug_dump_pad (target_pad, color_name, target_element_name, details,
221 /* src ghostpad relationship */
222 pad_name = debug_dump_make_object_name (GST_OBJECT (pad));
223 target_pad_name = debug_dump_make_object_name (GST_OBJECT (target_pad));
224 if (dir == GST_PAD_SRC) {
225 fprintf (out, "%s%s_%s -> %s_%s [style=dashed, minlen=0]\n", spc,
226 target_element_name, target_pad_name, element_name, pad_name);
228 fprintf (out, "%s%s_%s -> %s_%s [style=dashed, minlen=0]\n", spc,
229 element_name, pad_name, target_element_name, target_pad_name);
231 g_free (target_pad_name);
232 g_free (target_element_name);
234 gst_object_unref (target_element);
235 gst_object_unref (target_pad);
238 gst_object_unref (tmp_pad);
242 (dir == GST_PAD_SRC) ? "#ffaaaa" : ((dir ==
243 GST_PAD_SINK) ? "#aaaaff" : "#cccccc");
246 debug_dump_pad (pad, color_name, element_name, details, out, indent);
247 g_free (element_name);
251 string_append_field (GQuark field, const GValue * value, gpointer ptr)
253 GString *str = (GString *) ptr;
254 gchar *value_str = gst_value_serialize (value);
255 gchar *esc_value_str;
257 /* some enums can become really long */
258 if (strlen (value_str) > 25) {
262 value_str[25] = '\0';
264 /* mirror any brackets and quotes */
265 if (value_str[0] == '<')
266 value_str[pos--] = '>';
267 if (value_str[0] == '[')
268 value_str[pos--] = ']';
269 if (value_str[0] == '(')
270 value_str[pos--] = ')';
271 if (value_str[0] == '{')
272 value_str[pos--] = '}';
273 if (value_str[0] == '"')
274 value_str[pos--] = '"';
276 value_str[pos--] = ' ';
278 value_str[pos--] = '.';
279 value_str[pos--] = '.';
280 value_str[pos--] = '.';
282 esc_value_str = g_strescape (value_str, NULL);
284 g_string_append_printf (str, " %18s: %s\\l", g_quark_to_string (field),
288 g_free (esc_value_str);
293 debug_dump_describe_caps (GstCaps * caps, GstDebugGraphDetails details)
297 if (details & GST_DEBUG_GRAPH_SHOW_CAPS_DETAILS) {
299 if (gst_caps_is_any (caps) || gst_caps_is_empty (caps)) {
300 media = gst_caps_to_string (caps);
307 for (i = 0; i < gst_caps_get_size (caps); i++) {
309 STRUCTURE_ESTIMATED_STRING_LEN (gst_caps_get_structure (caps, i));
312 str = g_string_sized_new (slen);
313 for (i = 0; i < gst_caps_get_size (caps); i++) {
314 GstStructure *structure = gst_caps_get_structure (caps, i);
316 g_string_append (str, gst_structure_get_name (structure));
317 g_string_append (str, "\\l");
319 gst_structure_foreach (structure, string_append_field, (gpointer) str);
322 media = g_string_free (str, FALSE);
326 if (GST_CAPS_IS_SIMPLE (caps))
328 g_strdup (gst_structure_get_name (gst_caps_get_structure (caps, 0)));
330 media = g_strdup ("*");
336 debug_dump_element_pad_link (GstPad * pad, GstElement * element,
337 GstDebugGraphDetails details, FILE * out, const gint indent)
339 GstElement *peer_element;
341 GstCaps *caps, *peer_caps;
343 gchar *media_src = NULL, *media_sink = NULL;
344 gchar *pad_name, *element_name;
345 gchar *peer_pad_name, *peer_element_name;
346 const gchar *spc = &spaces[MAX (sizeof (spaces) - (1 + indent * 2), 0)];
348 if ((peer_pad = gst_pad_get_peer (pad))) {
349 if ((details & GST_DEBUG_GRAPH_SHOW_MEDIA_TYPE) ||
350 (details & GST_DEBUG_GRAPH_SHOW_CAPS_DETAILS)
352 caps = gst_pad_get_current_caps (pad);
354 caps = gst_pad_get_pad_template_caps (pad);
355 peer_caps = gst_pad_get_current_caps (peer_pad);
357 peer_caps = gst_pad_get_pad_template_caps (peer_pad);
359 media = debug_dump_describe_caps (caps, details);
360 /* check if peer caps are different */
361 if (peer_caps && !gst_caps_is_equal (caps, peer_caps)) {
364 tmp = debug_dump_describe_caps (peer_caps, details);
365 if (gst_pad_get_direction (pad) == GST_PAD_SRC) {
374 gst_caps_unref (peer_caps);
375 gst_caps_unref (caps);
378 pad_name = debug_dump_make_object_name (GST_OBJECT (pad));
380 element_name = debug_dump_make_object_name (GST_OBJECT (element));
382 element_name = g_strdup ("");
384 peer_pad_name = debug_dump_make_object_name (GST_OBJECT (peer_pad));
385 if ((peer_element = gst_pad_get_parent_element (peer_pad))) {
387 debug_dump_make_object_name (GST_OBJECT (peer_element));
389 peer_element_name = g_strdup ("");
394 fprintf (out, "%s%s_%s -> %s_%s [label=\"%s\"]\n", spc,
395 element_name, pad_name, peer_element_name, peer_pad_name, media);
397 } else if (media_src && media_sink) {
398 /* dot has some issues with placement of head and taillabels,
399 * we need an empty label to make space */
400 fprintf (out, "%s%s_%s -> %s_%s [labeldistance=\"10\", labelangle=\"0\", "
402 "headlabel=\"%s\", taillabel=\"%s\"]\n",
403 spc, element_name, pad_name, peer_element_name, peer_pad_name,
404 media_src, media_sink);
408 fprintf (out, "%s%s_%s -> %s_%s\n", spc,
409 element_name, pad_name, peer_element_name, peer_pad_name);
413 g_free (element_name);
414 g_free (peer_pad_name);
415 g_free (peer_element_name);
417 gst_object_unref (peer_element);
418 gst_object_unref (peer_pad);
423 debug_dump_element_pads (GstIterator * pad_iter, GstPad * pad,
424 GstElement * element, GstDebugGraphDetails details, FILE * out,
425 const gint indent, guint * src_pads, guint * sink_pads)
427 GValue item = { 0, };
433 switch (gst_iterator_next (pad_iter, &item)) {
434 case GST_ITERATOR_OK:
435 pad = g_value_get_object (&item);
436 debug_dump_element_pad (pad, element, details, out, indent);
437 dir = gst_pad_get_direction (pad);
438 if (dir == GST_PAD_SRC)
440 else if (dir == GST_PAD_SINK)
442 g_value_reset (&item);
444 case GST_ITERATOR_RESYNC:
445 gst_iterator_resync (pad_iter);
447 case GST_ITERATOR_ERROR:
448 case GST_ITERATOR_DONE:
456 * debug_dump_element:
457 * @bin: the bin that should be analyzed
458 * @out: file to write to
459 * @indent: level of graph indentation
461 * Helper for gst_debug_bin_to_dot_file() to recursively dump a pipeline.
464 debug_dump_element (GstBin * bin, GstDebugGraphDetails details, FILE * out,
467 GstIterator *element_iter, *pad_iter;
468 gboolean elements_done, pads_done;
469 GValue item = { 0, };
470 GValue item2 = { 0, };
473 guint src_pads, sink_pads;
475 gchar *state_name = NULL;
476 gchar *param_name = NULL;
477 const gchar *spc = &spaces[MAX (sizeof (spaces) - (1 + indent * 2), 0)];
479 element_iter = gst_bin_iterate_elements (bin);
480 elements_done = FALSE;
481 while (!elements_done) {
482 switch (gst_iterator_next (element_iter, &item)) {
483 case GST_ITERATOR_OK:
484 element = g_value_get_object (&item);
485 element_name = debug_dump_make_object_name (GST_OBJECT (element));
487 if (details & GST_DEBUG_GRAPH_SHOW_STATES) {
488 state_name = debug_dump_get_element_state (GST_ELEMENT (element));
490 if (details & GST_DEBUG_GRAPH_SHOW_NON_DEFAULT_PARAMS) {
491 param_name = debug_dump_get_element_params (GST_ELEMENT (element));
494 fprintf (out, "%ssubgraph cluster_%s {\n", spc, element_name);
495 fprintf (out, "%s fontname=\"Bitstream Vera Sans\";\n", spc);
496 fprintf (out, "%s fontsize=\"8\";\n", spc);
497 fprintf (out, "%s style=filled;\n", spc);
498 fprintf (out, "%s color=black;\n\n", spc);
499 fprintf (out, "%s label=\"%s\\n%s%s%s\";\n", spc,
500 G_OBJECT_TYPE_NAME (element), GST_OBJECT_NAME (element),
501 (state_name ? state_name : ""), (param_name ? param_name : "")
511 g_free (element_name);
513 src_pads = sink_pads = 0;
514 if ((pad_iter = gst_element_iterate_sink_pads (element))) {
515 debug_dump_element_pads (pad_iter, pad, element, details, out, indent,
516 &src_pads, &sink_pads);
517 gst_iterator_free (pad_iter);
519 if ((pad_iter = gst_element_iterate_src_pads (element))) {
520 debug_dump_element_pads (pad_iter, pad, element, details, out, indent,
521 &src_pads, &sink_pads);
522 gst_iterator_free (pad_iter);
524 if (GST_IS_BIN (element)) {
525 fprintf (out, "%s fillcolor=\"#ffffff\";\n", spc);
527 debug_dump_element (GST_BIN (element), details, out, indent + 1);
529 if (src_pads && !sink_pads)
530 fprintf (out, "%s fillcolor=\"#ffaaaa\";\n", spc);
531 else if (!src_pads && sink_pads)
532 fprintf (out, "%s fillcolor=\"#aaaaff\";\n", spc);
533 else if (src_pads && sink_pads)
534 fprintf (out, "%s fillcolor=\"#aaffaa\";\n", spc);
536 fprintf (out, "%s fillcolor=\"#ffffff\";\n", spc);
538 fprintf (out, "%s}\n\n", spc);
539 if ((pad_iter = gst_element_iterate_pads (element))) {
542 switch (gst_iterator_next (pad_iter, &item2)) {
543 case GST_ITERATOR_OK:
544 pad = g_value_get_object (&item2);
545 if (gst_pad_is_linked (pad)) {
546 if (gst_pad_get_direction (pad) == GST_PAD_SRC) {
547 debug_dump_element_pad_link (pad, element, details, out,
550 GstPad *peer_pad = gst_pad_get_peer (pad);
553 if (!GST_IS_GHOST_PAD (peer_pad)
554 && GST_IS_PROXY_PAD (peer_pad)) {
555 debug_dump_element_pad_link (peer_pad, NULL, details,
558 gst_object_unref (peer_pad);
562 g_value_reset (&item2);
564 case GST_ITERATOR_RESYNC:
565 gst_iterator_resync (pad_iter);
567 case GST_ITERATOR_ERROR:
568 case GST_ITERATOR_DONE:
573 g_value_unset (&item2);
574 gst_iterator_free (pad_iter);
576 g_value_reset (&item);
578 case GST_ITERATOR_RESYNC:
579 gst_iterator_resync (element_iter);
581 case GST_ITERATOR_ERROR:
582 case GST_ITERATOR_DONE:
583 elements_done = TRUE;
588 g_value_unset (&item);
589 gst_iterator_free (element_iter);
593 * gst_debug_bin_to_dot_file:
594 * @bin: the top-level pipeline that should be analyzed
595 * @file_name: output base filename (e.g. "myplayer")
597 * To aid debugging applications one can use this method to write out the whole
598 * network of gstreamer elements that form the pipeline into an dot file.
599 * This file can be processed with graphviz to get an image.
600 * <informalexample><programlisting>
601 * dot -Tpng -oimage.png graph_lowlevel.dot
602 * </programlisting></informalexample>
605 gst_debug_bin_to_dot_file (GstBin * bin, GstDebugGraphDetails details,
606 const gchar * file_name)
608 gchar *full_file_name = NULL;
611 g_return_if_fail (GST_IS_BIN (bin));
613 if (G_LIKELY (priv_gst_dump_dot_dir == NULL))
617 file_name = g_get_application_name ();
619 file_name = "unnamed";
622 full_file_name = g_strdup_printf ("%s" G_DIR_SEPARATOR_S "%s.dot",
623 priv_gst_dump_dot_dir, file_name);
625 if ((out = fopen (full_file_name, "wb"))) {
626 gchar *state_name = NULL;
627 gchar *param_name = NULL;
629 if (details & GST_DEBUG_GRAPH_SHOW_STATES) {
630 state_name = debug_dump_get_element_state (GST_ELEMENT (bin));
632 if (details & GST_DEBUG_GRAPH_SHOW_NON_DEFAULT_PARAMS) {
633 param_name = debug_dump_get_element_params (GST_ELEMENT (bin));
638 "digraph pipeline {\n"
640 " fontname=\"sans\";\n"
641 " fontsize=\"10\";\n"
645 " label=\"<%s>\\n%s%s%s\";\n"
646 " node [style=filled, shape=box, fontsize=\"9\", fontname=\"sans\", margin=\"0.0,0.0\"];\n"
647 " edge [labelfontsize=\"6\", fontsize=\"9\", fontname=\"monospace\"];\n"
648 "\n", G_OBJECT_TYPE_NAME (bin), GST_OBJECT_NAME (bin),
649 (state_name ? state_name : ""), (param_name ? param_name : "")
656 debug_dump_element (bin, details, out, 1);
659 fprintf (out, "}\n");
661 GST_INFO ("wrote bin graph to : '%s'", full_file_name);
663 GST_WARNING ("Failed to open file '%s' for writing: %s", full_file_name,
666 g_free (full_file_name);
670 * gst_debug_bin_to_dot_file_with_ts:
671 * @bin: the top-level pipeline that should be analyzed
672 * @file_name: output base filename (e.g. "myplayer")
674 * This works like gst_debug_bin_to_dot_file(), but adds the current timestamp
675 * to the filename, so that it can be used to take multiple snapshots.
678 gst_debug_bin_to_dot_file_with_ts (GstBin * bin,
679 GstDebugGraphDetails details, const gchar * file_name)
681 gchar *ts_file_name = NULL;
682 GstClockTime elapsed;
684 g_return_if_fail (GST_IS_BIN (bin));
687 file_name = g_get_application_name ();
689 file_name = "unnamed";
693 elapsed = GST_CLOCK_DIFF (_priv_gst_info_start_time,
694 gst_util_get_timestamp ());
696 /* we don't use GST_TIME_FORMAT as such filenames would fail on some
697 * filesystems like fat */
699 g_strdup_printf ("%u.%02u.%02u.%09u-%s", GST_TIME_ARGS (elapsed),
702 gst_debug_bin_to_dot_file (bin, details, ts_file_name);
703 g_free (ts_file_name);
705 #else /* !GST_DISABLE_GST_DEBUG */
706 #ifndef GST_REMOVE_DISABLED
708 gst_debug_bin_to_dot_file (GstBin * bin, GstDebugGraphDetails details,
709 const gchar * file_name)
714 gst_debug_bin_to_dot_file_with_ts (GstBin * bin, GstDebugGraphDetails details,
715 const gchar * file_name)
718 #endif /* GST_REMOVE_DISABLED */
719 #endif /* GST_DISABLE_GST_DEBUG */