gst/gstdebugutils.c

   1 /* GStreamer
   2  * Copyright (C) 2007 Stefan Kost <ensonic@users.sf.net>
   3  *
   4  * gstdebugutils.c: debugging and analysis utillities
   5  *
   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.
  10  *
  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.
  15  *
  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.
  20  */
  21 /* TODO:
  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
  25  *
  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
  32  *     doing the layout
  33  *   - we could add the caps to the pad itself, then we should use one line per
  34  *     caps (simple caps = one line)
  35  */
  36
  37 #include "gst_private.h"
  38 #include "gstdebugutils.h"
  39
  40 #ifndef GST_DISABLE_GST_DEBUG
  41
  42 #include <stdlib.h>
  43 #include <stdio.h>
  44 #include <string.h>
  45 #include <errno.h>
  46
  47 #include "gstinfo.h"
  48 #include "gstbin.h"
  49 #include "gstobject.h"
  50 #include "gstghostpad.h"
  51 #include "gstpad.h"
  52 #include "gstutils.h"
  53 #include "gstvalue.h"
  54
  55 /*** PIPELINE GRAPHS **********************************************************/
  56
  57 const gchar *priv_gst_dump_dot_dir;     /* NULL *//* set from gst.c */
  58
  59 const gchar spaces[] = {
  60   "                                "    /* 32 */
  61       "                                "        /* 64 */
  62       "                                "        /* 96 */
  63       "                                "        /* 128 */
  64 };
  65
  66 extern GstClockTime _priv_gst_info_start_time;
  67
  68 static gchar *
  69 debug_dump_make_object_name (GstObject * element)
  70 {
  71   return g_strcanon (g_strdup_printf ("%s_%p", GST_OBJECT_NAME (element),
  72           element), G_CSET_A_2_Z G_CSET_a_2_z G_CSET_DIGITS "_", '_');
  73 }
  74
  75 static gchar *
  76 debug_dump_get_element_state (GstElement * element)
  77 {
  78   gchar *state_name = NULL;
  79   const gchar *state_icons = "~0-=>";
  80   GstState state = 0, pending = 0;
  81
  82   gst_element_get_state (element, &state, &pending, 0);
  83   if (pending == GST_STATE_VOID_PENDING) {
  84     state_name = g_strdup_printf ("\\n[%c]", state_icons[state]);
  85   } else {
  86     state_name = g_strdup_printf ("\\n[%c] -> [%c]", state_icons[state],
  87         state_icons[pending]);
  88   }
  89   return state_name;
  90 }
  91
  92 static gchar *
  93 debug_dump_get_element_params (GstElement * element)
  94 {
  95   gchar *param_name = NULL;
  96   GParamSpec **properties, *property;
  97   GValue value = { 0, };
  98   guint i, number_of_properties;
  99   gchar *tmp, *value_str;
 100
 101   /* get paramspecs and show non-default properties */
 102   properties =
 103       g_object_class_list_properties (G_OBJECT_CLASS (GST_ELEMENT_GET_CLASS
 104           (element)), &number_of_properties);
 105   if (properties) {
 106     for (i = 0; i < number_of_properties; i++) {
 107       property = properties[i];
 108
 109       /* ski some properties */
 110       if (!(property->flags & G_PARAM_READABLE))
 111         continue;
 112       if (!strcmp (property->name, "name"))
 113         continue;
 114
 115       g_value_init (&value, property->value_type);
 116       g_object_get_property (G_OBJECT (element), property->name, &value);
 117       if (!(g_param_value_defaults (property, &value))) {
 118         tmp = g_strdup_value_contents (&value);
 119         value_str = g_strescape (tmp, NULL);
 120         g_free (tmp);
 121         if (param_name) {
 122           tmp = param_name;
 123           param_name = g_strdup_printf ("%s\\n%s=%s",
 124               tmp, property->name, value_str);
 125           g_free (tmp);
 126         } else {
 127           param_name = g_strdup_printf ("\\n%s=%s", property->name, value_str);
 128         }
 129         g_free (value_str);
 130       }
 131       g_value_unset (&value);
 132     }
 133     g_free (properties);
 134   }
 135   return param_name;
 136 }
 137
 138 static void
 139 debug_dump_pad (GstPad * pad, const gchar * color_name,
 140     const gchar * element_name, GstDebugGraphDetails details, FILE * out,
 141     const gint indent)
 142 {
 143   GstPadTemplate *pad_templ;
 144   GstPadPresence presence;
 145   gchar *pad_name;
 146   const gchar *style_name;
 147   const gchar *spc = &spaces[MAX (sizeof (spaces) - (1 + indent * 2), 0)];
 148
 149   pad_name = debug_dump_make_object_name (GST_OBJECT (pad));
 150
 151   /* pad availability */
 152   style_name = "filled,solid";
 153   if ((pad_templ = gst_pad_get_pad_template (pad))) {
 154     presence = GST_PAD_TEMPLATE_PRESENCE (pad_templ);
 155     if (presence == GST_PAD_SOMETIMES) {
 156       style_name = "filled,dotted";
 157     } else if (presence == GST_PAD_REQUEST) {
 158       style_name = "filled,dashed";
 159     }
 160   }
 161   if (details & GST_DEBUG_GRAPH_SHOW_STATES) {
 162     gchar pad_flags[6];
 163     const gchar *activation_mode = "-><";
 164
 165     /* check if pad flags */
 166     pad_flags[0] = GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_BLOCKED) ? 'B' : 'b';
 167     pad_flags[1] = GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLUSHING) ? 'F' : 'f';
 168     pad_flags[2] = GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_IN_GETCAPS) ? 'G' : 'g';
 169     pad_flags[3] = GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_IN_SETCAPS) ? 'S' : 's';
 170     pad_flags[4] = GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_BLOCKING) ? 'B' : 'b';
 171     pad_flags[5] = '\0';
 172
 173     fprintf (out,
 174         "%s  %s_%s [color=black, fillcolor=\"%s\", label=\"%s\\n[%c][%s]\", height=\"0.2\", style=\"%s\"];\n",
 175         spc, element_name, pad_name, color_name, GST_OBJECT_NAME (pad),
 176         activation_mode[pad->mode], pad_flags, style_name);
 177   } else {
 178     fprintf (out,
 179         "%s  %s_%s [color=black, fillcolor=\"%s\", label=\"%s\", height=\"0.2\", style=\"%s\"];\n",
 180         spc, element_name, pad_name, color_name, GST_OBJECT_NAME (pad),
 181         style_name);
 182   }
 183
 184   g_free (pad_name);
 185 }
 186
 187 static void
 188 debug_dump_element_pad (GstPad * pad, GstElement * element,
 189     GstDebugGraphDetails details, FILE * out, const gint indent)
 190 {
 191   GstElement *target_element;
 192   GstPad *target_pad, *tmp_pad;
 193   GstPadDirection dir;
 194   gchar *element_name;
 195   gchar *target_element_name;
 196   const gchar *color_name;
 197
 198   dir = gst_pad_get_direction (pad);
 199   element_name = debug_dump_make_object_name (GST_OBJECT (element));
 200   if (GST_IS_GHOST_PAD (pad)) {
 201     color_name =
 202         (dir == GST_PAD_SRC) ? "#ffdddd" : ((dir ==
 203             GST_PAD_SINK) ? "#ddddff" : "#ffffff");
 204     /* output target-pad so that it belongs to this element */
 205     if ((tmp_pad = gst_ghost_pad_get_target (GST_GHOST_PAD (pad)))) {
 206       if ((target_pad = gst_pad_get_peer (tmp_pad))) {
 207         if ((target_element = gst_pad_get_parent_element (target_pad))) {
 208           target_element_name =
 209               debug_dump_make_object_name (GST_OBJECT (target_element));
 210         } else {
 211           target_element_name = g_strdup ("");
 212         }
 213         debug_dump_pad (target_pad, color_name, target_element_name, details,
 214             out, indent);
 215         g_free (target_element_name);
 216         if (target_element)
 217           gst_object_unref (target_element);
 218         gst_object_unref (target_pad);
 219       }
 220       gst_object_unref (tmp_pad);
 221     }
 222   } else {
 223     color_name =
 224         (dir == GST_PAD_SRC) ? "#ffaaaa" : ((dir ==
 225             GST_PAD_SINK) ? "#aaaaff" : "#cccccc");
 226   }
 227   /* pads */
 228   debug_dump_pad (pad, color_name, element_name, details, out, indent);
 229   g_free (element_name);
 230 }
 231
 232 static gboolean
 233 string_append_field (GQuark field, const GValue * value, gpointer ptr)
 234 {
 235   GString *str = (GString *) ptr;
 236   gchar *value_str = gst_value_serialize (value);
 237
 238   /* some enums can become really long */
 239   if (strlen (value_str) > 25) {
 240     gint pos = 24;
 241
 242     /* truncate */
 243     value_str[25] = '\0';
 244
 245     /* mirror any brackets */
 246     if (value_str[0] == '<')
 247       value_str[pos--] = '>';
 248     if (value_str[0] == '[')
 249       value_str[pos--] = ']';
 250     if (value_str[0] == '(')
 251       value_str[pos--] = ')';
 252     if (value_str[0] == '{')
 253       value_str[pos--] = '}';
 254     if (pos != 24)
 255       value_str[pos--] = ' ';
 256     /* elippsize */
 257     value_str[pos--] = '.';
 258     value_str[pos--] = '.';
 259     value_str[pos--] = '.';
 260   }
 261   g_string_append_printf (str, "  %18s: %s\\l", g_quark_to_string (field),
 262       value_str);
 263
 264   g_free (value_str);
 265   return TRUE;
 266 }
 267
 268 static gchar *
 269 debug_dump_describe_caps (GstCaps * caps, GstDebugGraphDetails details)
 270 {
 271   gchar *media = NULL;
 272
 273   if (details & GST_DEBUG_GRAPH_SHOW_CAPS_DETAILS) {
 274
 275     if (gst_caps_is_any (caps) || gst_caps_is_empty (caps)) {
 276       media = gst_caps_to_string (caps);
 277
 278     } else {
 279       GString *str = NULL;
 280       guint i;
 281       guint slen = 0;
 282
 283       for (i = 0; i < gst_caps_get_size (caps); i++) {
 284         slen += 25 +
 285             STRUCTURE_ESTIMATED_STRING_LEN (gst_caps_get_structure (caps, i));
 286       }
 287
 288       str = g_string_sized_new (slen);
 289       for (i = 0; i < gst_caps_get_size (caps); i++) {
 290         GstStructure *structure = gst_caps_get_structure (caps, i);
 291
 292         g_string_append (str, gst_structure_get_name (structure));
 293         g_string_append (str, "\\l");
 294
 295         gst_structure_foreach (structure, string_append_field, (gpointer) str);
 296       }
 297
 298       media = g_string_free (str, FALSE);
 299     }
 300
 301   } else {
 302     if (GST_CAPS_IS_SIMPLE (caps))
 303       media =
 304           g_strdup (gst_structure_get_name (gst_caps_get_structure (caps, 0)));
 305     else
 306       media = g_strdup ("*");
 307   }
 308   return media;
 309 }
 310
 311 static void
 312 debug_dump_element_pad_link (GstPad * pad, GstElement * element,
 313     GstDebugGraphDetails details, FILE * out, const gint indent)
 314 {
 315   GstElement *peer_element, *target_element;
 316   GstPad *peer_pad, *target_pad, *tmp_pad;
 317   GstCaps *caps, *peer_caps;
 318   gchar *media = NULL;
 319   gchar *media_src = NULL, *media_sink = NULL;
 320   gchar *pad_name, *element_name;
 321   gchar *peer_pad_name, *peer_element_name;
 322   gchar *target_pad_name, *target_element_name;
 323   const gchar *spc = &spaces[MAX (sizeof (spaces) - (1 + indent * 2), 0)];
 324
 325   if ((peer_pad = gst_pad_get_peer (pad))) {
 326     if ((details & GST_DEBUG_GRAPH_SHOW_MEDIA_TYPE) ||
 327         (details & GST_DEBUG_GRAPH_SHOW_CAPS_DETAILS)
 328         ) {
 329       caps = gst_pad_get_negotiated_caps (pad);
 330       if (!caps)
 331         caps = gst_caps_copy (gst_pad_get_pad_template_caps (pad));
 332       peer_caps = gst_pad_get_negotiated_caps (peer_pad);
 333       if (!peer_caps)
 334         peer_caps = gst_caps_copy (gst_pad_get_pad_template_caps (peer_pad));
 335
 336       media = debug_dump_describe_caps (caps, details);
 337       /* check if peer caps are different */
 338       if (peer_caps && !gst_caps_is_equal (caps, peer_caps)) {
 339         gchar *tmp;
 340
 341         tmp = debug_dump_describe_caps (peer_caps, details);
 342         if (gst_pad_get_direction (pad) == GST_PAD_SRC) {
 343           media_src = media;
 344           media_sink = tmp;
 345         } else {
 346           media_src = tmp;
 347           media_sink = media;
 348         }
 349         media = NULL;
 350       }
 351       gst_caps_unref (peer_caps);
 352       gst_caps_unref (caps);
 353     }
 354
 355     pad_name = debug_dump_make_object_name (GST_OBJECT (pad));
 356     if (element) {
 357       element_name = debug_dump_make_object_name (GST_OBJECT (element));
 358     } else {
 359       element_name = g_strdup ("");
 360     }
 361     peer_pad_name = debug_dump_make_object_name (GST_OBJECT (peer_pad));
 362     if ((peer_element = gst_pad_get_parent_element (peer_pad))) {
 363       peer_element_name =
 364           debug_dump_make_object_name (GST_OBJECT (peer_element));
 365     } else {
 366       peer_element_name = g_strdup ("");
 367     }
 368
 369     if (GST_IS_GHOST_PAD (pad)) {
 370       if ((tmp_pad = gst_ghost_pad_get_target (GST_GHOST_PAD (pad)))) {
 371         if ((target_pad = gst_pad_get_peer (tmp_pad))) {
 372           target_pad_name =
 373               debug_dump_make_object_name (GST_OBJECT (target_pad));
 374           if ((target_element = gst_pad_get_parent_element (target_pad))) {
 375             target_element_name =
 376                 debug_dump_make_object_name (GST_OBJECT (target_element));
 377           } else {
 378             target_element_name = g_strdup ("");
 379           }
 380           /* src ghostpad relationship */
 381           fprintf (out, "%s%s_%s -> %s_%s [style=dashed, minlen=0]\n", spc,
 382               target_element_name, target_pad_name, element_name, pad_name);
 383
 384           g_free (target_pad_name);
 385           g_free (target_element_name);
 386           if (target_element)
 387             gst_object_unref (target_element);
 388           gst_object_unref (target_pad);
 389         }
 390         gst_object_unref (tmp_pad);
 391       }
 392     }
 393     if (GST_IS_GHOST_PAD (peer_pad)) {
 394       if ((tmp_pad = gst_ghost_pad_get_target (GST_GHOST_PAD (peer_pad)))) {
 395         if ((target_pad = gst_pad_get_peer (tmp_pad))) {
 396           target_pad_name =
 397               debug_dump_make_object_name (GST_OBJECT (target_pad));
 398           if ((target_element = gst_pad_get_parent_element (target_pad))) {
 399             target_element_name =
 400                 debug_dump_make_object_name (GST_OBJECT (target_element));
 401           } else {
 402             target_element_name = g_strdup ("");
 403           }
 404           /* sink ghostpad relationship */
 405           fprintf (out, "%s%s_%s -> %s_%s [style=dashed, minlen=0]\n", spc,
 406               peer_element_name, peer_pad_name,
 407               target_element_name, target_pad_name);
 408           /* FIXME: we are missing links from the proxy pad
 409            * theoretically we need to:
 410            * pad=gst_object_ref(target_pad);
 411            * goto line 280: if ((peer_pad = gst_pad_get_peer (pad)))
 412            * as this would be ugly we need to refactor ...
 413            */
 414           debug_dump_element_pad_link (target_pad, target_element, details, out,
 415               indent);
 416           g_free (target_pad_name);
 417           g_free (target_element_name);
 418           if (target_element)
 419             gst_object_unref (target_element);
 420           gst_object_unref (target_pad);
 421         }
 422         gst_object_unref (tmp_pad);
 423       }
 424     }
 425
 426     /* pad link */
 427     if (media) {
 428       fprintf (out, "%s%s_%s -> %s_%s [label=\"%s\"]\n", spc,
 429           element_name, pad_name, peer_element_name, peer_pad_name, media);
 430       g_free (media);
 431     } else if (media_src && media_sink) {
 432       /* dot has some issues with placement of head and taillabels,
 433        * we need an empty label to make space */
 434       fprintf (out, "%s%s_%s -> %s_%s [labeldistance=\"10\", labelangle=\"0\", "
 435           "label=\"                                                  \", "
 436           "headlabel=\"%s\", taillabel=\"%s\"]\n",
 437           spc, element_name, pad_name, peer_element_name, peer_pad_name,
 438           media_src, media_sink);
 439       g_free (media_src);
 440       g_free (media_sink);
 441     } else {
 442       fprintf (out, "%s%s_%s -> %s_%s\n", spc,
 443           element_name, pad_name, peer_element_name, peer_pad_name);
 444     }
 445
 446     g_free (pad_name);
 447     g_free (element_name);
 448     g_free (peer_pad_name);
 449     g_free (peer_element_name);
 450     if (peer_element)
 451       gst_object_unref (peer_element);
 452     gst_object_unref (peer_pad);
 453   }
 454 }
 455
 456 /*
 457  * debug_dump_element:
 458  * @bin: the bin that should be analyzed
 459  * @out: file to write to
 460  * @indent: level of graph indentation
 461  *
 462  * Helper for _gst_debug_bin_to_dot_file() to recursively dump a pipeline.
 463  */
 464 static void
 465 debug_dump_element (GstBin * bin, GstDebugGraphDetails details, FILE * out,
 466     const gint indent)
 467 {
 468   GstIterator *element_iter, *pad_iter;
 469   gboolean elements_done, pads_done;
 470   GstElement *element;
 471   GstPad *pad;
 472   GstPadDirection dir;
 473   guint src_pads, sink_pads;
 474   gchar *element_name;
 475   gchar *state_name = NULL;
 476   gchar *param_name = NULL;
 477   const gchar *spc = &spaces[MAX (sizeof (spaces) - (1 + indent * 2), 0)];
 478
 479   element_iter = gst_bin_iterate_elements (bin);
 480   elements_done = FALSE;
 481   while (!elements_done) {
 482     switch (gst_iterator_next (element_iter, (gpointer) & element)) {
 483       case GST_ITERATOR_OK:
 484         element_name = debug_dump_make_object_name (GST_OBJECT (element));
 485
 486         if (details & GST_DEBUG_GRAPH_SHOW_STATES) {
 487           state_name = debug_dump_get_element_state (GST_ELEMENT (element));
 488         }
 489         if (details & GST_DEBUG_GRAPH_SHOW_NON_DEFAULT_PARAMS) {
 490           param_name = debug_dump_get_element_params (GST_ELEMENT (element));
 491         }
 492         /* elements */
 493         fprintf (out, "%ssubgraph cluster_%s {\n", spc, element_name);
 494         fprintf (out, "%s  fontname=\"Bitstream Vera Sans\";\n", spc);
 495         fprintf (out, "%s  fontsize=\"8\";\n", spc);
 496         fprintf (out, "%s  style=filled;\n", spc);
 497         fprintf (out, "%s  color=black;\n\n", spc);
 498         fprintf (out, "%s  label=\"%s\\n%s%s%s\";\n", spc,
 499             G_OBJECT_TYPE_NAME (element), GST_OBJECT_NAME (element),
 500             (state_name ? state_name : ""), (param_name ? param_name : "")
 501             );
 502         if (state_name) {
 503           g_free (state_name);
 504           state_name = NULL;
 505         }
 506         if (param_name) {
 507           g_free (param_name);
 508           param_name = NULL;
 509         }
 510         g_free (element_name);
 511
 512         src_pads = sink_pads = 0;
 513         if ((pad_iter = gst_element_iterate_pads (element))) {
 514           pads_done = FALSE;
 515           while (!pads_done) {
 516             switch (gst_iterator_next (pad_iter, (gpointer) & pad)) {
 517               case GST_ITERATOR_OK:
 518                 debug_dump_element_pad (pad, element, details, out, indent);
 519                 dir = gst_pad_get_direction (pad);
 520                 if (dir == GST_PAD_SRC)
 521                   src_pads++;
 522                 else if (dir == GST_PAD_SINK)
 523                   sink_pads++;
 524                 gst_object_unref (pad);
 525                 break;
 526               case GST_ITERATOR_RESYNC:
 527                 gst_iterator_resync (pad_iter);
 528                 break;
 529               case GST_ITERATOR_ERROR:
 530               case GST_ITERATOR_DONE:
 531                 pads_done = TRUE;
 532                 break;
 533             }
 534           }
 535           gst_iterator_free (pad_iter);
 536         }
 537         if (GST_IS_BIN (element)) {
 538           fprintf (out, "%s  fillcolor=\"#ffffff\";\n", spc);
 539           /* recurse */
 540           debug_dump_element (GST_BIN (element), details, out, indent + 1);
 541         } else {
 542           if (src_pads && !sink_pads)
 543             fprintf (out, "%s  fillcolor=\"#ffaaaa\";\n", spc);
 544           else if (!src_pads && sink_pads)
 545             fprintf (out, "%s  fillcolor=\"#aaaaff\";\n", spc);
 546           else if (src_pads && sink_pads)
 547             fprintf (out, "%s  fillcolor=\"#aaffaa\";\n", spc);
 548           else
 549             fprintf (out, "%s  fillcolor=\"#ffffff\";\n", spc);
 550         }
 551         fprintf (out, "%s}\n\n", spc);
 552         if ((pad_iter = gst_element_iterate_pads (element))) {
 553           pads_done = FALSE;
 554           while (!pads_done) {
 555             switch (gst_iterator_next (pad_iter, (gpointer) & pad)) {
 556               case GST_ITERATOR_OK:
 557                 if (gst_pad_is_linked (pad)
 558                     && gst_pad_get_direction (pad) == GST_PAD_SRC) {
 559                   debug_dump_element_pad_link (pad, element, details, out,
 560                       indent);
 561                 }
 562                 gst_object_unref (pad);
 563                 break;
 564               case GST_ITERATOR_RESYNC:
 565                 gst_iterator_resync (pad_iter);
 566                 break;
 567               case GST_ITERATOR_ERROR:
 568               case GST_ITERATOR_DONE:
 569                 pads_done = TRUE;
 570                 break;
 571             }
 572           }
 573           gst_iterator_free (pad_iter);
 574         }
 575         gst_object_unref (element);
 576         break;
 577       case GST_ITERATOR_RESYNC:
 578         gst_iterator_resync (element_iter);
 579         break;
 580       case GST_ITERATOR_ERROR:
 581       case GST_ITERATOR_DONE:
 582         elements_done = TRUE;
 583         break;
 584     }
 585   }
 586   gst_iterator_free (element_iter);
 587 }
 588
 589 /*
 590  * _gst_debug_bin_to_dot_file:
 591  * @bin: the top-level pipeline that should be analyzed
 592  * @file_name: output base filename (e.g. "myplayer")
 593  *
 594  * To aid debugging applications one can use this method to write out the whole
 595  * network of gstreamer elements that form the pipeline into an dot file.
 596  * This file can be processed with graphviz to get an image.
 597  * <informalexample><programlisting>
 598  *  dot -Tpng -oimage.png graph_lowlevel.dot
 599  * </programlisting></informalexample>
 600  */
 601 void
 602 _gst_debug_bin_to_dot_file (GstBin * bin, GstDebugGraphDetails details,
 603     const gchar * file_name)
 604 {
 605   gchar *full_file_name = NULL;
 606   FILE *out;
 607
 608   g_return_if_fail (GST_IS_BIN (bin));
 609
 610   if (G_LIKELY (priv_gst_dump_dot_dir == NULL))
 611     return;
 612
 613   if (!file_name) {
 614     file_name = g_get_application_name ();
 615     if (!file_name)
 616       file_name = "unnamed";
 617   }
 618
 619   full_file_name = g_strdup_printf ("%s" G_DIR_SEPARATOR_S "%s.dot",
 620       priv_gst_dump_dot_dir, file_name);
 621
 622   if ((out = fopen (full_file_name, "wb"))) {
 623     gchar *state_name = NULL;
 624     gchar *param_name = NULL;
 625
 626     if (details & GST_DEBUG_GRAPH_SHOW_STATES) {
 627       state_name = debug_dump_get_element_state (GST_ELEMENT (bin));
 628     }
 629     if (details & GST_DEBUG_GRAPH_SHOW_NON_DEFAULT_PARAMS) {
 630       param_name = debug_dump_get_element_params (GST_ELEMENT (bin));
 631     }
 632
 633     /* write header */
 634     fprintf (out,
 635         "digraph pipeline {\n"
 636         "  rankdir=LR;\n"
 637         "  fontname=\"sans\";\n"
 638         "  fontsize=\"10\";\n"
 639         "  labelloc=t;\n"
 640         "  nodesep=.1;\n"
 641         "  ranksep=.2;\n"
 642         "  label=\"<%s>\\n%s%s%s\";\n"
 643         "  node [style=filled, shape=box, fontsize=\"9\", fontname=\"sans\", margin=\"0.0,0.0\"];\n"
 644         "  edge [labelfontsize=\"6\", fontsize=\"9\", fontname=\"monospace\"];\n"
 645         "\n", G_OBJECT_TYPE_NAME (bin), GST_OBJECT_NAME (bin),
 646         (state_name ? state_name : ""), (param_name ? param_name : "")
 647         );
 648     if (state_name)
 649       g_free (state_name);
 650     if (param_name)
 651       g_free (param_name);
 652
 653     debug_dump_element (bin, details, out, 1);
 654
 655     /* write footer */
 656     fprintf (out, "}\n");
 657     fclose (out);
 658     GST_INFO ("wrote bin graph to : '%s'", full_file_name);
 659   } else {
 660     GST_WARNING ("Failed to open file '%s' for writing: %s", full_file_name,
 661         g_strerror (errno));
 662   }
 663   g_free (full_file_name);
 664 }
 665
 666 /*
 667  * _gst_debug_bin_to_dot_file_with_ts:
 668  * @bin: the top-level pipeline that should be analyzed
 669  * @file_name: output base filename (e.g. "myplayer")
 670  *
 671  * This works like _gst_debug_bin_to_dot_file(), but adds the current timestamp
 672  * to the filename, so that it can be used to take multiple snapshots.
 673  */
 674 void
 675 _gst_debug_bin_to_dot_file_with_ts (GstBin * bin, GstDebugGraphDetails details,
 676     const gchar * file_name)
 677 {
 678   gchar *ts_file_name = NULL;
 679   GstClockTime elapsed;
 680
 681   g_return_if_fail (GST_IS_BIN (bin));
 682
 683   if (!file_name) {
 684     file_name = g_get_application_name ();
 685     if (!file_name)
 686       file_name = "unnamed";
 687   }
 688
 689   /* add timestamp */
 690   elapsed = GST_CLOCK_DIFF (_priv_gst_info_start_time,
 691       gst_util_get_timestamp ());
 692
 693   /* we don't use GST_TIME_FORMAT as such filenames would fail on some
 694    * filesystems like fat */
 695   ts_file_name =
 696       g_strdup_printf ("%u.%02u.%02u.%09u-%s", GST_TIME_ARGS (elapsed),
 697       file_name);
 698
 699   _gst_debug_bin_to_dot_file (bin, details, ts_file_name);
 700   g_free (ts_file_name);
 701 }
 702 #else /* !GST_DISABLE_GST_DEBUG */
 703 #ifndef GST_REMOVE_DISABLED
 704 void
 705 _gst_debug_bin_to_dot_file (GstBin * bin, GstDebugGraphDetails details,
 706     const gchar * file_name)
 707 {
 708 }
 709
 710 void
 711 _gst_debug_bin_to_dot_file_with_ts (GstBin * bin, GstDebugGraphDetails details,
 712     const gchar * file_name)
 713 {
 714 }
 715 #endif /* GST_REMOVE_DISABLED */
 716 #endif /* GST_DISABLE_GST_DEBUG */