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., 51 Franklin St, Fifth Floor,
19 * Boston, MA 02110-1301, 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 extern const gchar *priv_gst_dump_dot_dir; /* NULL *//* set from gst.c */
59 #define PARAM_MAX_LENGTH 80
61 const gchar spaces[] = {
68 #define MAKE_INDENT(indent) \
69 &spaces[MAX (sizeof (spaces) - (1 + (indent) * 2), 0)]
72 debug_dump_make_object_name (GstObject * obj)
74 return g_strcanon (g_strdup_printf ("%s_%p", GST_OBJECT_NAME (obj), obj),
75 G_CSET_A_2_Z G_CSET_a_2_z G_CSET_DIGITS "_", '_');
79 debug_dump_get_element_state (GstElement * element)
81 gchar *state_name = NULL;
82 const gchar *state_icons = "~0-=>";
83 GstState state = GST_STATE_VOID_PENDING, pending = GST_STATE_VOID_PENDING;
85 gst_element_get_state (element, &state, &pending, 0);
86 if (pending == GST_STATE_VOID_PENDING) {
87 gboolean is_locked = gst_element_is_locked_state (element);
88 state_name = g_strdup_printf ("\\n[%c]%s", state_icons[state],
89 (is_locked ? "(locked)" : ""));
91 state_name = g_strdup_printf ("\\n[%c] -> [%c]", state_icons[state],
92 state_icons[pending]);
98 debug_dump_get_object_params (GObject * object,
99 GstDebugGraphDetails details, const char *const *ignored_propnames)
101 gchar *param_name = NULL;
102 GParamSpec **properties, *property;
103 GValue value = { 0, };
104 guint i, number_of_properties;
105 gchar *tmp, *value_str;
106 const gchar *ellipses;
108 /* get paramspecs and show non-default properties */
110 g_object_class_list_properties (G_OBJECT_GET_CLASS (object),
111 &number_of_properties);
113 for (i = 0; i < number_of_properties; i++) {
115 gboolean ignore = FALSE;
116 property = properties[i];
118 /* skip some properties */
119 if (!(property->flags & G_PARAM_READABLE))
121 if (!strcmp (property->name, "name"))
124 if (ignored_propnames)
125 for (j = 0; ignored_propnames[j]; j++)
126 if (!g_strcmp0 (ignored_propnames[j], property->name))
132 g_value_init (&value, property->value_type);
133 g_object_get_property (G_OBJECT (object), property->name, &value);
134 if (!(g_param_value_defaults (property, &value))) {
135 /* we need to serialise enums and flags ourselves to make sure the
136 * enum/flag nick is used and not the enum/flag name, which would be the
137 * C header enum/flag for public enums/flags, but for element-specific
138 * enums/flags we abuse the name field for the property description,
139 * and we don't want to print that in the dot file. The nick will
140 * always work, and it's also shorter. */
141 if (G_VALUE_HOLDS_ENUM (&value)) {
142 GEnumClass *e_class = g_type_class_ref (G_VALUE_TYPE (&value));
146 e_val = g_value_get_enum (&value);
147 for (idx = 0; idx < e_class->n_values; ++idx) {
148 if (e_class->values[idx].value == e_val) {
149 tmp = g_strdup (e_class->values[idx].value_nick);
154 g_value_unset (&value);
157 } else if (G_VALUE_HOLDS_FLAGS (&value)) {
158 GFlagsClass *f_class = g_type_class_ref (G_VALUE_TYPE (&value));
159 GFlagsValue *vals = f_class->values;
161 guint idx, flags_left;
163 s = g_string_new (NULL);
165 /* we assume the values are sorted from lowest to highest value */
166 flags_left = g_value_get_flags (&value);
167 idx = f_class->n_values;
170 if (vals[idx].value != 0
171 && (flags_left & vals[idx].value) == vals[idx].value) {
173 g_string_prepend_c (s, '+');
174 g_string_prepend (s, vals[idx].value_nick);
175 flags_left -= vals[idx].value;
182 g_string_assign (s, "(none)");
184 tmp = g_string_free (s, FALSE);
186 tmp = g_strdup_value_contents (&value);
188 value_str = g_strescape (tmp, NULL);
191 /* too long, ellipsize */
192 if (!(details & GST_DEBUG_GRAPH_SHOW_FULL_PARAMS) &&
193 strlen (value_str) > PARAM_MAX_LENGTH)
203 if (details & GST_DEBUG_GRAPH_SHOW_FULL_PARAMS) {
204 param_name = g_strdup_printf ("%s\\n%s=%s", tmp, property->name,
207 param_name = g_strdup_printf ("%s\\n%s=%."
208 G_STRINGIFY (PARAM_MAX_LENGTH) "s%s", tmp, property->name,
209 value_str, ellipses);
217 g_value_unset (&value);
225 debug_dump_pad (GstPad * pad, const gchar * color_name,
226 const gchar * element_name, GstDebugGraphDetails details, GString * str,
229 GstPadTemplate *pad_templ;
230 GstPadPresence presence;
231 gchar *pad_name, *param_name = NULL;
232 const gchar *style_name;
233 static const char *const ignore_propnames[] =
234 { "parent", "direction", "template",
237 const gchar *spc = MAKE_INDENT (indent);
239 pad_name = debug_dump_make_object_name (GST_OBJECT (pad));
241 /* pad availability */
242 style_name = "filled,solid";
243 if ((pad_templ = gst_pad_get_pad_template (pad))) {
244 presence = GST_PAD_TEMPLATE_PRESENCE (pad_templ);
245 gst_object_unref (pad_templ);
246 if (presence == GST_PAD_SOMETIMES) {
247 style_name = "filled,dotted";
248 } else if (presence == GST_PAD_REQUEST) {
249 style_name = "filled,dashed";
254 debug_dump_get_object_params (G_OBJECT (pad), details, ignore_propnames);
255 if (details & GST_DEBUG_GRAPH_SHOW_STATES) {
257 const gchar *activation_mode = "-><";
258 const gchar *task_mode = "";
261 GST_OBJECT_LOCK (pad);
262 task = GST_PAD_TASK (pad);
264 switch (gst_task_get_state (task)) {
265 case GST_TASK_STARTED:
268 case GST_TASK_PAUSED:
272 /* Invalid task state, ignoring */
276 GST_OBJECT_UNLOCK (pad);
278 /* check if pad flags */
280 GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_BLOCKED) ? 'B' : 'b';
282 GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_FLUSHING) ? 'F' : 'f';
284 GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_BLOCKING) ? 'B' : 'b';
287 g_string_append_printf (str,
288 "%s %s_%s [color=black, fillcolor=\"%s\", label=\"%s%s\\n[%c][%s]%s\", height=\"0.2\", style=\"%s\"];\n",
289 spc, element_name, pad_name, color_name, GST_OBJECT_NAME (pad),
290 (param_name ? param_name : ""),
291 activation_mode[pad->mode], pad_flags, task_mode, style_name);
293 g_string_append_printf (str,
294 "%s %s_%s [color=black, fillcolor=\"%s\", label=\"%s%s\", height=\"0.2\", style=\"%s\"];\n",
295 spc, element_name, pad_name, color_name, GST_OBJECT_NAME (pad),
296 (param_name ? param_name : ""), style_name);
304 debug_dump_element_pad (GstPad * pad, GstElement * element,
305 GstDebugGraphDetails details, GString * str, const gint indent)
307 GstElement *target_element;
308 GstPad *target_pad, *tmp_pad;
311 gchar *target_element_name;
312 const gchar *color_name;
314 dir = gst_pad_get_direction (pad);
315 element_name = debug_dump_make_object_name (GST_OBJECT (element));
316 if (GST_IS_GHOST_PAD (pad)) {
318 (dir == GST_PAD_SRC) ? "#ffdddd" : ((dir ==
319 GST_PAD_SINK) ? "#ddddff" : "#ffffff");
320 /* output target-pad so that it belongs to this element */
321 if ((tmp_pad = gst_ghost_pad_get_target (GST_GHOST_PAD (pad)))) {
322 if ((target_pad = gst_pad_get_peer (tmp_pad))) {
323 gchar *pad_name, *target_pad_name;
324 const gchar *spc = MAKE_INDENT (indent);
326 if ((target_element = gst_pad_get_parent_element (target_pad))) {
327 target_element_name =
328 debug_dump_make_object_name (GST_OBJECT (target_element));
330 target_element_name = g_strdup ("");
332 debug_dump_pad (target_pad, color_name, target_element_name, details,
334 /* src ghostpad relationship */
335 pad_name = debug_dump_make_object_name (GST_OBJECT (pad));
336 target_pad_name = debug_dump_make_object_name (GST_OBJECT (target_pad));
337 if (dir == GST_PAD_SRC) {
338 g_string_append_printf (str,
339 "%s%s_%s -> %s_%s [style=dashed, minlen=0]\n", spc,
340 target_element_name, target_pad_name, element_name, pad_name);
342 g_string_append_printf (str,
343 "%s%s_%s -> %s_%s [style=dashed, minlen=0]\n", spc,
344 element_name, pad_name, target_element_name, target_pad_name);
346 g_free (target_pad_name);
347 g_free (target_element_name);
349 gst_object_unref (target_element);
350 gst_object_unref (target_pad);
353 gst_object_unref (tmp_pad);
357 (dir == GST_PAD_SRC) ? "#ffaaaa" : ((dir ==
358 GST_PAD_SINK) ? "#aaaaff" : "#cccccc");
361 debug_dump_pad (pad, color_name, element_name, details, str, indent);
362 g_free (element_name);
366 string_append_field (GQuark field, const GValue * value, gpointer ptr)
368 GString *str = (GString *) ptr;
369 gchar *value_str = gst_value_serialize (value);
370 gchar *esc_value_str;
372 if (value_str == NULL) {
373 g_string_append_printf (str, " %18s: NULL\\l", g_quark_to_string (field));
377 /* some enums can become really long */
378 if (strlen (value_str) > 25) {
382 value_str[25] = '\0';
384 /* mirror any brackets and quotes */
385 if (value_str[0] == '<')
386 value_str[pos--] = '>';
387 if (value_str[0] == '[')
388 value_str[pos--] = ']';
389 if (value_str[0] == '(')
390 value_str[pos--] = ')';
391 if (value_str[0] == '{')
392 value_str[pos--] = '}';
393 if (value_str[0] == '"')
394 value_str[pos--] = '"';
396 value_str[pos--] = ' ';
398 value_str[pos--] = '.';
399 value_str[pos--] = '.';
400 value_str[pos--] = '.';
402 esc_value_str = g_strescape (value_str, NULL);
404 g_string_append_printf (str, " %18s: %s\\l", g_quark_to_string (field),
408 g_free (esc_value_str);
413 debug_dump_describe_caps (GstCaps * caps, GstDebugGraphDetails details)
417 if (details & GST_DEBUG_GRAPH_SHOW_CAPS_DETAILS) {
419 if (gst_caps_is_any (caps) || gst_caps_is_empty (caps)) {
420 media = gst_caps_to_string (caps);
427 for (i = 0; i < gst_caps_get_size (caps); i++) {
429 STRUCTURE_ESTIMATED_STRING_LEN (gst_caps_get_structure (caps, i));
432 str = g_string_sized_new (slen);
433 for (i = 0; i < gst_caps_get_size (caps); i++) {
434 GstCapsFeatures *features = __gst_caps_get_features_unchecked (caps, i);
435 GstStructure *structure = gst_caps_get_structure (caps, i);
437 g_string_append (str, gst_structure_get_name (structure));
439 if (features && (gst_caps_features_is_any (features)
440 || !gst_caps_features_is_equal (features,
441 GST_CAPS_FEATURES_MEMORY_SYSTEM_MEMORY))) {
442 g_string_append_c (str, '(');
443 priv_gst_caps_features_append_to_gstring (features, str);
444 g_string_append_c (str, ')');
446 g_string_append (str, "\\l");
448 gst_structure_foreach (structure, string_append_field, (gpointer) str);
451 media = g_string_free (str, FALSE);
455 if (GST_CAPS_IS_SIMPLE (caps))
457 g_strdup (gst_structure_get_name (gst_caps_get_structure (caps, 0)));
459 media = g_strdup ("*");
465 debug_dump_element_pad_link (GstPad * pad, GstElement * element,
466 GstDebugGraphDetails details, GString * str, const gint indent)
468 GstElement *peer_element;
470 GstCaps *caps, *peer_caps;
472 gchar *media_src = NULL, *media_sink = NULL;
473 gchar *pad_name, *element_name;
474 gchar *peer_pad_name, *peer_element_name;
475 const gchar *spc = MAKE_INDENT (indent);
477 if ((peer_pad = gst_pad_get_peer (pad))) {
478 if ((details & GST_DEBUG_GRAPH_SHOW_MEDIA_TYPE) ||
479 (details & GST_DEBUG_GRAPH_SHOW_CAPS_DETAILS)
481 caps = gst_pad_get_current_caps (pad);
483 caps = gst_pad_get_pad_template_caps (pad);
484 peer_caps = gst_pad_get_current_caps (peer_pad);
486 peer_caps = gst_pad_get_pad_template_caps (peer_pad);
488 media = debug_dump_describe_caps (caps, details);
489 /* check if peer caps are different */
490 if (peer_caps && !gst_caps_is_equal (caps, peer_caps)) {
493 tmp = debug_dump_describe_caps (peer_caps, details);
494 if (gst_pad_get_direction (pad) == GST_PAD_SRC) {
503 gst_caps_unref (peer_caps);
504 gst_caps_unref (caps);
507 pad_name = debug_dump_make_object_name (GST_OBJECT (pad));
509 element_name = debug_dump_make_object_name (GST_OBJECT (element));
511 element_name = g_strdup ("");
513 peer_pad_name = debug_dump_make_object_name (GST_OBJECT (peer_pad));
514 if ((peer_element = gst_pad_get_parent_element (peer_pad))) {
516 debug_dump_make_object_name (GST_OBJECT (peer_element));
518 peer_element_name = g_strdup ("");
523 g_string_append_printf (str, "%s%s_%s -> %s_%s [label=\"%s\"]\n", spc,
524 element_name, pad_name, peer_element_name, peer_pad_name, media);
526 } else if (media_src && media_sink) {
527 /* dot has some issues with placement of head and taillabels,
528 * we need an empty label to make space */
529 g_string_append_printf (str,
530 "%s%s_%s -> %s_%s [labeldistance=\"10\", labelangle=\"0\", "
532 "taillabel=\"%s\", headlabel=\"%s\"]\n",
533 spc, element_name, pad_name, peer_element_name, peer_pad_name,
534 media_src, media_sink);
538 g_string_append_printf (str, "%s%s_%s -> %s_%s\n", spc,
539 element_name, pad_name, peer_element_name, peer_pad_name);
543 g_free (element_name);
544 g_free (peer_pad_name);
545 g_free (peer_element_name);
547 gst_object_unref (peer_element);
548 gst_object_unref (peer_pad);
553 debug_dump_element_pads (GstIterator * pad_iter, GstPad * pad,
554 GstElement * element, GstDebugGraphDetails details, GString * str,
555 const gint indent, guint * num_pads, gchar * cluster_name,
556 gchar ** first_pad_name)
558 GValue item = { 0, };
560 const gchar *spc = MAKE_INDENT (indent);
564 switch (gst_iterator_next (pad_iter, &item)) {
565 case GST_ITERATOR_OK:
566 pad = g_value_get_object (&item);
568 g_string_append_printf (str, "%ssubgraph cluster_%s {\n", spc,
570 g_string_append_printf (str, "%s label=\"\";\n", spc);
571 g_string_append_printf (str, "%s style=\"invis\";\n", spc);
572 (*first_pad_name) = debug_dump_make_object_name (GST_OBJECT (pad));
574 debug_dump_element_pad (pad, element, details, str, indent);
576 g_value_reset (&item);
578 case GST_ITERATOR_RESYNC:
579 gst_iterator_resync (pad_iter);
581 case GST_ITERATOR_ERROR:
582 case GST_ITERATOR_DONE:
588 g_string_append_printf (str, "%s}\n\n", spc);
593 * debug_dump_element:
594 * @bin: the bin that should be analyzed
595 * @out: file to write to
596 * @indent: level of graph indentation
598 * Helper for gst_debug_bin_to_dot_file() to recursively dump a pipeline.
601 debug_dump_element (GstBin * bin, GstDebugGraphDetails details,
602 GString * str, const gint indent)
604 GstIterator *element_iter, *pad_iter;
605 gboolean elements_done, pads_done;
606 GValue item = { 0, };
607 GValue item2 = { 0, };
610 guint src_pads, sink_pads;
611 gchar *src_pad_name = NULL, *sink_pad_name = NULL;
613 gchar *state_name = NULL;
614 gchar *param_name = NULL;
615 const gchar *spc = MAKE_INDENT (indent);
617 element_iter = gst_bin_iterate_elements (bin);
618 elements_done = FALSE;
619 while (!elements_done) {
620 switch (gst_iterator_next (element_iter, &item)) {
621 case GST_ITERATOR_OK:
622 element = g_value_get_object (&item);
623 element_name = debug_dump_make_object_name (GST_OBJECT (element));
625 if (details & GST_DEBUG_GRAPH_SHOW_STATES) {
626 state_name = debug_dump_get_element_state (GST_ELEMENT (element));
628 if (details & GST_DEBUG_GRAPH_SHOW_NON_DEFAULT_PARAMS) {
629 param_name = debug_dump_get_object_params (G_OBJECT (element),
633 g_string_append_printf (str, "%ssubgraph cluster_%s {\n", spc,
635 g_string_append_printf (str, "%s fontname=\"Bitstream Vera Sans\";\n",
637 g_string_append_printf (str, "%s fontsize=\"8\";\n", spc);
638 g_string_append_printf (str, "%s style=\"filled,rounded\";\n", spc);
639 g_string_append_printf (str, "%s color=black;\n", spc);
640 g_string_append_printf (str, "%s label=\"%s\\n%s%s%s\";\n", spc,
641 G_OBJECT_TYPE_NAME (element), GST_OBJECT_NAME (element),
642 (state_name ? state_name : ""), (param_name ? param_name : "")
653 src_pads = sink_pads = 0;
654 if ((pad_iter = gst_element_iterate_sink_pads (element))) {
655 gchar *cluster_name = g_strdup_printf ("%s_sink", element_name);
656 debug_dump_element_pads (pad_iter, pad, element, details, str,
657 indent + 1, &sink_pads, cluster_name, &sink_pad_name);
658 g_free (cluster_name);
659 gst_iterator_free (pad_iter);
661 if ((pad_iter = gst_element_iterate_src_pads (element))) {
662 gchar *cluster_name = g_strdup_printf ("%s_src", element_name);
663 debug_dump_element_pads (pad_iter, pad, element, details, str,
664 indent + 1, &src_pads, cluster_name, &src_pad_name);
665 g_free (cluster_name);
666 gst_iterator_free (pad_iter);
668 if (sink_pads && src_pads) {
669 /* add invisible link from first sink to first src pad */
670 g_string_append_printf (str,
671 "%s %s_%s -> %s_%s [style=\"invis\"];\n",
672 spc, element_name, sink_pad_name, element_name, src_pad_name);
674 g_free (sink_pad_name);
675 g_free (src_pad_name);
676 g_free (element_name);
677 sink_pad_name = src_pad_name = NULL;
678 if (GST_IS_BIN (element)) {
679 g_string_append_printf (str, "%s fillcolor=\"#ffffff\";\n", spc);
681 debug_dump_element (GST_BIN (element), details, str, indent + 1);
683 if (src_pads && !sink_pads)
684 g_string_append_printf (str, "%s fillcolor=\"#ffaaaa\";\n", spc);
685 else if (!src_pads && sink_pads)
686 g_string_append_printf (str, "%s fillcolor=\"#aaaaff\";\n", spc);
687 else if (src_pads && sink_pads)
688 g_string_append_printf (str, "%s fillcolor=\"#aaffaa\";\n", spc);
690 g_string_append_printf (str, "%s fillcolor=\"#ffffff\";\n", spc);
692 g_string_append_printf (str, "%s}\n\n", spc);
693 if ((pad_iter = gst_element_iterate_pads (element))) {
696 switch (gst_iterator_next (pad_iter, &item2)) {
697 case GST_ITERATOR_OK:
698 pad = g_value_get_object (&item2);
699 if (gst_pad_is_linked (pad)) {
700 if (gst_pad_get_direction (pad) == GST_PAD_SRC) {
701 debug_dump_element_pad_link (pad, element, details, str,
704 GstPad *peer_pad = gst_pad_get_peer (pad);
707 if (!GST_IS_GHOST_PAD (peer_pad)
708 && GST_IS_PROXY_PAD (peer_pad)) {
709 debug_dump_element_pad_link (peer_pad, NULL, details,
712 gst_object_unref (peer_pad);
716 g_value_reset (&item2);
718 case GST_ITERATOR_RESYNC:
719 gst_iterator_resync (pad_iter);
721 case GST_ITERATOR_ERROR:
722 case GST_ITERATOR_DONE:
727 g_value_unset (&item2);
728 gst_iterator_free (pad_iter);
730 g_value_reset (&item);
732 case GST_ITERATOR_RESYNC:
733 gst_iterator_resync (element_iter);
735 case GST_ITERATOR_ERROR:
736 case GST_ITERATOR_DONE:
737 elements_done = TRUE;
742 g_value_unset (&item);
743 gst_iterator_free (element_iter);
747 debug_dump_header (GstBin * bin, GstDebugGraphDetails details, GString * str)
749 gchar *state_name = NULL;
750 gchar *param_name = NULL;
752 if (details & GST_DEBUG_GRAPH_SHOW_STATES) {
753 state_name = debug_dump_get_element_state (GST_ELEMENT (bin));
755 if (details & GST_DEBUG_GRAPH_SHOW_NON_DEFAULT_PARAMS) {
756 param_name = debug_dump_get_object_params (G_OBJECT (bin), details, NULL);
760 g_string_append_printf (str,
761 "digraph pipeline {\n"
763 " fontname=\"sans\";\n"
764 " fontsize=\"10\";\n"
768 " label=\"<%s>\\n%s%s%s\";\n"
769 " node [style=\"filled,rounded\", shape=box, fontsize=\"9\", fontname=\"sans\", margin=\"0.0,0.0\"];\n"
770 " edge [labelfontsize=\"6\", fontsize=\"9\", fontname=\"monospace\"];\n"
774 " margin=\"0.05,0.05\",\n"
775 " style=\"filled\",\n"
776 " label=\"Legend\\lElement-States: [~] void-pending, [0] null, [-] ready, [=] paused, [>] playing\\lPad-Activation: [-] none, [>] push, [<] pull\\lPad-Flags: [b]locked, [f]lushing, [b]locking; upper-case is set\\lPad-Task: [T] has started task, [t] has paused task\\l\",\n"
778 "\n", G_OBJECT_TYPE_NAME (bin), GST_OBJECT_NAME (bin),
779 (state_name ? state_name : ""), (param_name ? param_name : "")
789 debug_dump_footer (GString * str)
791 g_string_append_printf (str, "}\n");
795 * gst_debug_bin_to_dot_data:
796 * @bin: the top-level pipeline that should be analyzed
798 * To aid debugging applications one can use this method to obtain the whole
799 * network of gstreamer elements that form the pipeline into an dot file.
800 * This data can be processed with graphviz to get an image.
802 * Returns: (transfer full): a string containing the pipeline in graphviz
806 gst_debug_bin_to_dot_data (GstBin * bin, GstDebugGraphDetails details)
810 g_return_val_if_fail (GST_IS_BIN (bin), NULL);
812 str = g_string_new (NULL);
814 debug_dump_header (bin, details, str);
815 debug_dump_element (bin, details, str, 1);
816 debug_dump_footer (str);
818 return g_string_free (str, FALSE);
822 * gst_debug_bin_to_dot_file:
823 * @bin: the top-level pipeline that should be analyzed
824 * @file_name: output base filename (e.g. "myplayer")
826 * To aid debugging applications one can use this method to write out the whole
827 * network of gstreamer elements that form the pipeline into an dot file.
828 * This file can be processed with graphviz to get an image.
829 * <informalexample><programlisting>
830 * dot -Tpng -oimage.png graph_lowlevel.dot
831 * </programlisting></informalexample>
834 gst_debug_bin_to_dot_file (GstBin * bin, GstDebugGraphDetails details,
835 const gchar * file_name)
837 gchar *full_file_name = NULL;
840 g_return_if_fail (GST_IS_BIN (bin));
842 if (G_LIKELY (priv_gst_dump_dot_dir == NULL))
846 file_name = g_get_application_name ();
848 file_name = "unnamed";
851 full_file_name = g_strdup_printf ("%s" G_DIR_SEPARATOR_S "%s.dot",
852 priv_gst_dump_dot_dir, file_name);
854 if ((out = fopen (full_file_name, "wb"))) {
857 buf = gst_debug_bin_to_dot_data (bin, details);
863 GST_INFO ("wrote bin graph to : '%s'", full_file_name);
865 GST_WARNING ("Failed to open file '%s' for writing: %s", full_file_name,
868 g_free (full_file_name);
872 * gst_debug_bin_to_dot_file_with_ts:
873 * @bin: the top-level pipeline that should be analyzed
874 * @file_name: output base filename (e.g. "myplayer")
876 * This works like gst_debug_bin_to_dot_file(), but adds the current timestamp
877 * to the filename, so that it can be used to take multiple snapshots.
880 gst_debug_bin_to_dot_file_with_ts (GstBin * bin,
881 GstDebugGraphDetails details, const gchar * file_name)
883 gchar *ts_file_name = NULL;
884 GstClockTime elapsed;
886 g_return_if_fail (GST_IS_BIN (bin));
889 file_name = g_get_application_name ();
891 file_name = "unnamed";
895 elapsed = GST_CLOCK_DIFF (_priv_gst_start_time, gst_util_get_timestamp ());
897 /* we don't use GST_TIME_FORMAT as such filenames would fail on some
898 * filesystems like fat */
900 g_strdup_printf ("%u.%02u.%02u.%09u-%s", GST_TIME_ARGS (elapsed),
903 gst_debug_bin_to_dot_file (bin, details, ts_file_name);
904 g_free (ts_file_name);
906 #else /* !GST_DISABLE_GST_DEBUG */
907 #ifndef GST_REMOVE_DISABLED
909 gst_debug_bin_to_dot_file (GstBin * bin, GstDebugGraphDetails details,
910 const gchar * file_name)
915 gst_debug_bin_to_dot_file_with_ts (GstBin * bin, GstDebugGraphDetails details,
916 const gchar * file_name)
919 #endif /* GST_REMOVE_DISABLED */
920 #endif /* GST_DISABLE_GST_DEBUG */