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