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  * edge [ minlen=0 ];
  24  *   does not create spacial dependency
  25  * node [ margin="0.02,0.01" ];
  26  *   space surrounding the label
  27  */
  28
  29 #include "gst_private.h"
  30 #include "gstdebugutils.h"
  31
  32 #ifndef GST_DISABLE_GST_DEBUG
  33
  34 #include <stdlib.h>
  35 #include <stdio.h>
  36 #include <string.h>
  37 #include <errno.h>
  38
  39 #include "gstinfo.h"
  40 #include "gstbin.h"
  41 #include "gstobject.h"
  42 #include "gstghostpad.h"
  43 #include "gstpad.h"
  44 #include "gstutils.h"
  45
  46 /*** PIPELINE GRAPHS **********************************************************/
  47
  48 const gchar *priv_gst_dump_dot_dir;     /* NULL *//* set from gst.c */
  49
  50 extern GstClockTime _priv_gst_info_start_time;
  51
  52 static gchar *
  53 debug_dump_make_object_name (GstObject * element)
  54 {
  55   return g_strcanon (g_strdup_printf ("%s_%p", GST_OBJECT_NAME (element),
  56           element), G_CSET_A_2_Z G_CSET_a_2_z G_CSET_DIGITS "_", '_');
  57 }
  58
  59 static gchar *
  60 debug_dump_get_element_state (GstElement * element)
  61 {
  62   gchar *state_name = NULL;
  63   const gchar *state_icons = "~0-=>";
  64   GstState state = 0, pending = 0;
  65
  66   gst_element_get_state (element, &state, &pending, 0);
  67   if (pending == GST_STATE_VOID_PENDING) {
  68     state_name = g_strdup_printf ("\\n[%c]", state_icons[state]);
  69   } else {
  70     state_name = g_strdup_printf ("\\n[%c]->[%c]", state_icons[state],
  71         state_icons[pending]);
  72   }
  73   return state_name;
  74 }
  75
  76 static gchar *
  77 debug_dump_get_element_params (GstElement * element)
  78 {
  79   gchar *param_name = NULL;
  80   GParamSpec **properties, *property;
  81   GValue value = { 0, };
  82   guint i, number_of_properties;
  83   gchar *tmp, *value_str;
  84
  85   /* get paramspecs and show non-default properties */
  86   properties =
  87       g_object_class_list_properties (G_OBJECT_CLASS (GST_ELEMENT_GET_CLASS
  88           (element)), &number_of_properties);
  89   if (properties) {
  90     for (i = 0; i < number_of_properties; i++) {
  91       property = properties[i];
  92
  93       /* ski some properties */
  94       if (!(property->flags & G_PARAM_READABLE))
  95         continue;
  96       if (!strcmp (property->name, "name"))
  97         continue;
  98
  99       g_value_init (&value, property->value_type);
 100       g_object_get_property (G_OBJECT (element), property->name, &value);
 101       if (!(g_param_value_defaults (property, &value))) {
 102         tmp = g_strdup_value_contents (&value);
 103         value_str = g_strescape (tmp, NULL);
 104         g_free (tmp);
 105         if (param_name) {
 106           tmp = param_name;
 107           param_name = g_strdup_printf ("%s\\n%s=%s",
 108               tmp, property->name, value_str);
 109           g_free (tmp);
 110         } else {
 111           param_name = g_strdup_printf ("\\n%s=%s", property->name, value_str);
 112         }
 113         g_free (value_str);
 114       }
 115       g_value_unset (&value);
 116     }
 117     g_free (properties);
 118   }
 119   return param_name;
 120 }
 121
 122 static void
 123 debug_dump_element_pad (GstPad * pad, GstElement * element,
 124     GstDebugGraphDetails details, FILE * out, const gint indent)
 125 {
 126   GstElement *target_element;
 127   GstPad *target_pad, *tmp_pad;
 128   GstPadDirection dir;
 129   guint src_pads, sink_pads;
 130   gchar *pad_name, *element_name;
 131   gchar *target_pad_name, *target_element_name;
 132   gchar *color_name;
 133   gchar *spc = NULL;
 134
 135   spc = g_malloc (1 + indent * 2);
 136   memset (spc, 32, indent * 2);
 137   spc[indent * 2] = '\0';
 138
 139   dir = gst_pad_get_direction (pad);
 140   pad_name = debug_dump_make_object_name (GST_OBJECT (pad));
 141   element_name = debug_dump_make_object_name (GST_OBJECT (element));
 142   if (GST_IS_GHOST_PAD (pad)) {
 143     color_name =
 144         (dir == GST_PAD_SRC) ? "#ffdddd" : ((dir ==
 145             GST_PAD_SINK) ? "#ddddff" : "#ffffff");
 146     /* output target-pad so that it belongs to this element */
 147     if ((tmp_pad = gst_ghost_pad_get_target (GST_GHOST_PAD (pad)))) {
 148       if ((target_pad = gst_pad_get_peer (tmp_pad))) {
 149         target_pad_name = debug_dump_make_object_name (GST_OBJECT (target_pad));
 150         if ((target_element = gst_pad_get_parent_element (target_pad))) {
 151           target_element_name =
 152               debug_dump_make_object_name (GST_OBJECT (target_element));
 153         } else {
 154           target_element_name = "";
 155         }
 156         fprintf (out,
 157             "%s  %s_%s [color=black, fillcolor=\"%s\", label=\"%s\"];\n",
 158             spc, target_element_name, target_pad_name, color_name,
 159             GST_OBJECT_NAME (target_pad));
 160         g_free (target_pad_name);
 161         if (target_element) {
 162           g_free (target_element_name);
 163           gst_object_unref (target_element);
 164         }
 165         gst_object_unref (target_pad);
 166       }
 167       gst_object_unref (tmp_pad);
 168     }
 169   } else {
 170     color_name =
 171         (dir == GST_PAD_SRC) ? "#ffaaaa" : ((dir ==
 172             GST_PAD_SINK) ? "#aaaaff" : "#cccccc");
 173   }
 174   /* pads */
 175   fprintf (out,
 176       "%s  %s_%s [color=black, fillcolor=\"%s\", label=\"%s\"];\n",
 177       spc, element_name, pad_name, color_name, GST_OBJECT_NAME (pad));
 178
 179   if (dir == GST_PAD_SRC)
 180     src_pads++;
 181   else if (dir == GST_PAD_SINK)
 182     sink_pads++;
 183   g_free (pad_name);
 184   g_free (element_name);
 185
 186 }
 187
 188 static void
 189 debug_dump_element_pad_link (GstPad * pad, GstElement * element,
 190     GstDebugGraphDetails details, FILE * out, const gint indent)
 191 {
 192   GstElement *peer_element, *target_element;
 193   GstPad *peer_pad, *target_pad, *tmp_pad;
 194   GstCaps *caps;
 195   GstStructure *structure;
 196   gboolean free_caps, free_media;
 197   gchar *media = NULL;
 198   gchar *pad_name, *element_name;
 199   gchar *peer_pad_name, *peer_element_name;
 200   gchar *target_pad_name, *target_element_name;
 201   gchar *spc = NULL;
 202
 203   spc = g_malloc (1 + indent * 2);
 204   memset (spc, 32, indent * 2);
 205   spc[indent * 2] = '\0';
 206
 207   if ((peer_pad = gst_pad_get_peer (pad))) {
 208     free_media = FALSE;
 209     if ((details & GST_DEBUG_GRAPH_SHOW_MEDIA_TYPE) ||
 210         (details & GST_DEBUG_GRAPH_SHOW_CAPS_DETAILS)
 211         ) {
 212       if ((caps = gst_pad_get_negotiated_caps (pad))) {
 213         free_caps = TRUE;
 214       } else {
 215         free_caps = FALSE;
 216         if (!(caps = (GstCaps *)
 217                 gst_pad_get_pad_template_caps (pad))) {
 218           /* this should not happen */
 219           media = "?";
 220         }
 221       }
 222       if (caps) {
 223         if (details & GST_DEBUG_GRAPH_SHOW_CAPS_DETAILS) {
 224           gchar *tmp = g_strdelimit (gst_caps_to_string (caps), ",",
 225               '\n');
 226
 227           media = g_strescape (tmp, NULL);
 228           free_media = TRUE;
 229           g_free (tmp);
 230         } else {
 231           if (GST_CAPS_IS_SIMPLE (caps)) {
 232             structure = gst_caps_get_structure (caps, 0);
 233             media = (gchar *) gst_structure_get_name (structure);
 234           } else
 235             media = "*";
 236         }
 237         if (free_caps) {
 238           gst_caps_unref (caps);
 239         }
 240       }
 241     }
 242
 243     pad_name = debug_dump_make_object_name (GST_OBJECT (pad));
 244     if (element) {
 245       element_name = debug_dump_make_object_name (GST_OBJECT (element));
 246     } else {
 247       element_name = "";
 248     }
 249     peer_pad_name = debug_dump_make_object_name (GST_OBJECT (peer_pad));
 250     if ((peer_element = gst_pad_get_parent_element (peer_pad))) {
 251       peer_element_name =
 252           debug_dump_make_object_name (GST_OBJECT (peer_element));
 253     } else {
 254       peer_element_name = "";
 255     }
 256
 257     if (GST_IS_GHOST_PAD (pad)) {
 258       if ((tmp_pad = gst_ghost_pad_get_target (GST_GHOST_PAD (pad)))) {
 259         if ((target_pad = gst_pad_get_peer (tmp_pad))) {
 260           target_pad_name =
 261               debug_dump_make_object_name (GST_OBJECT (target_pad));
 262           if ((target_element = gst_pad_get_parent_element (target_pad))) {
 263             target_element_name =
 264                 debug_dump_make_object_name (GST_OBJECT (target_element));
 265           } else {
 266             target_element_name = "";
 267           }
 268           /* src ghostpad relationship */
 269           fprintf (out, "%s%s_%s -> %s_%s [style=dashed]\n", spc,
 270               target_element_name, target_pad_name, element_name, pad_name);
 271
 272           g_free (target_pad_name);
 273           if (target_element) {
 274             g_free (target_element_name);
 275             gst_object_unref (target_element);
 276           }
 277           gst_object_unref (target_pad);
 278         }
 279         gst_object_unref (tmp_pad);
 280       }
 281     }
 282     if (GST_IS_GHOST_PAD (peer_pad)) {
 283       if ((tmp_pad = gst_ghost_pad_get_target (GST_GHOST_PAD (peer_pad)))) {
 284         if ((target_pad = gst_pad_get_peer (tmp_pad))) {
 285           target_pad_name =
 286               debug_dump_make_object_name (GST_OBJECT (target_pad));
 287           if ((target_element = gst_pad_get_parent_element (target_pad))) {
 288             target_element_name =
 289                 debug_dump_make_object_name (GST_OBJECT (target_element));
 290           } else {
 291             target_element_name = "";
 292           }
 293           /* sink ghostpad relationship */
 294           fprintf (out, "%s%s_%s -> %s_%s [style=dashed]\n", spc,
 295               peer_element_name, peer_pad_name,
 296               target_element_name, target_pad_name);
 297           /* FIXME: we are missing links from the proxy pad
 298            * theoretically we need to:
 299            * pad=gst_object_ref(target_pad);
 300            * goto line 280: if ((peer_pad = gst_pad_get_peer (pad)))
 301            * as this would e ugly we need to refactor ...
 302            */
 303           debug_dump_element_pad_link (target_pad, target_element, details, out,
 304               indent);
 305           g_free (target_pad_name);
 306           if (target_element) {
 307             g_free (target_element_name);
 308             gst_object_unref (target_element);
 309           }
 310           gst_object_unref (target_pad);
 311         }
 312         gst_object_unref (tmp_pad);
 313       }
 314     }
 315
 316     /* pad link */
 317     if (media) {
 318       fprintf (out, "%s%s_%s -> %s_%s [label=\"%s\"]\n", spc,
 319           element_name, pad_name, peer_element_name, peer_pad_name, media);
 320       if (free_media) {
 321         g_free (media);
 322       }
 323     } else {
 324       fprintf (out, "%s%s_%s -> %s_%s\n", spc,
 325           element_name, pad_name, peer_element_name, peer_pad_name);
 326     }
 327
 328     g_free (pad_name);
 329     if (element) {
 330       g_free (element_name);
 331     }
 332     g_free (peer_pad_name);
 333     if (peer_element) {
 334       g_free (peer_element_name);
 335       gst_object_unref (peer_element);
 336     }
 337     gst_object_unref (peer_pad);
 338   }
 339 }
 340
 341 /*
 342  * debug_dump_element:
 343  * @bin: the bin that should be analyzed
 344  * @out: file to write to
 345  * @indent: level of graph indentation
 346  *
 347  * Helper for _gst_debug_bin_to_dot_file() to recursively dump a pipeline.
 348  */
 349 static void
 350 debug_dump_element (GstBin * bin, GstDebugGraphDetails details, FILE * out,
 351     const gint indent)
 352 {
 353   GstIterator *element_iter, *pad_iter;
 354   gboolean elements_done, pads_done;
 355   GstElement *element;
 356   GstPad *pad;
 357   GstPadDirection dir;
 358   guint src_pads, sink_pads;
 359   gchar *element_name;
 360   gchar *state_name = NULL;
 361   gchar *param_name = NULL;
 362   gchar *spc = NULL;
 363
 364   spc = g_malloc (1 + indent * 2);
 365   memset (spc, 32, indent * 2);
 366   spc[indent * 2] = '\0';
 367
 368   element_iter = gst_bin_iterate_elements (bin);
 369   elements_done = FALSE;
 370   while (!elements_done) {
 371     switch (gst_iterator_next (element_iter, (gpointer) & element)) {
 372       case GST_ITERATOR_OK:
 373         element_name = debug_dump_make_object_name (GST_OBJECT (element));
 374
 375         if (details & GST_DEBUG_GRAPH_SHOW_STATES) {
 376           state_name = debug_dump_get_element_state (GST_ELEMENT (element));
 377         }
 378         if (details & GST_DEBUG_GRAPH_SHOW_NON_DEFAULT_PARAMS) {
 379           param_name = debug_dump_get_element_params (GST_ELEMENT (element));
 380         }
 381         /* elements */
 382         fprintf (out, "%ssubgraph cluster_%s {\n", spc, element_name);
 383         fprintf (out, "%s  fontname=\"Bitstream Vera Sans\";\n", spc);
 384         fprintf (out, "%s  fontsize=\"8\";\n", spc);
 385         fprintf (out, "%s  style=filled;\n", spc);
 386         fprintf (out, "%s  color=black;\n\n", spc);
 387         fprintf (out, "%s  label=\"<%s>\\n%s%s%s\";\n", spc,
 388             G_OBJECT_TYPE_NAME (element), GST_OBJECT_NAME (element),
 389             (state_name ? state_name : ""), (param_name ? param_name : "")
 390             );
 391         if (state_name) {
 392           g_free (state_name);
 393           state_name = NULL;
 394         }
 395         if (param_name) {
 396           g_free (param_name);
 397           param_name = NULL;
 398         }
 399         g_free (element_name);
 400
 401         src_pads = sink_pads = 0;
 402         if ((pad_iter = gst_element_iterate_pads (element))) {
 403           pads_done = FALSE;
 404           while (!pads_done) {
 405             switch (gst_iterator_next (pad_iter, (gpointer) & pad)) {
 406               case GST_ITERATOR_OK:
 407                 debug_dump_element_pad (pad, element, details, out, indent);
 408                 dir = gst_pad_get_direction (pad);
 409                 if (dir == GST_PAD_SRC)
 410                   src_pads++;
 411                 else if (dir == GST_PAD_SINK)
 412                   sink_pads++;
 413                 gst_object_unref (pad);
 414                 break;
 415               case GST_ITERATOR_RESYNC:
 416                 gst_iterator_resync (pad_iter);
 417                 break;
 418               case GST_ITERATOR_ERROR:
 419               case GST_ITERATOR_DONE:
 420                 pads_done = TRUE;
 421                 break;
 422             }
 423           }
 424           gst_iterator_free (pad_iter);
 425         }
 426         if (GST_IS_BIN (element)) {
 427           fprintf (out, "%s  fillcolor=\"#ffffff\";\n", spc);
 428           /* recurse */
 429           debug_dump_element (GST_BIN (element), details, out, indent + 1);
 430         } else {
 431           if (src_pads && !sink_pads)
 432             fprintf (out, "%s  fillcolor=\"#ffaaaa\";\n", spc);
 433           else if (!src_pads && sink_pads)
 434             fprintf (out, "%s  fillcolor=\"#aaaaff\";\n", spc);
 435           else if (src_pads && sink_pads)
 436             fprintf (out, "%s  fillcolor=\"#aaffaa\";\n", spc);
 437           else
 438             fprintf (out, "%s  fillcolor=\"#ffffff\";\n", spc);
 439         }
 440         fprintf (out, "%s}\n\n", spc);
 441         if ((pad_iter = gst_element_iterate_pads (element))) {
 442           pads_done = FALSE;
 443           while (!pads_done) {
 444             switch (gst_iterator_next (pad_iter, (gpointer) & pad)) {
 445               case GST_ITERATOR_OK:
 446                 if (gst_pad_is_linked (pad)
 447                     && gst_pad_get_direction (pad) == GST_PAD_SRC) {
 448                   debug_dump_element_pad_link (pad, element, details, out,
 449                       indent);
 450                 }
 451                 gst_object_unref (pad);
 452                 break;
 453               case GST_ITERATOR_RESYNC:
 454                 gst_iterator_resync (pad_iter);
 455                 break;
 456               case GST_ITERATOR_ERROR:
 457               case GST_ITERATOR_DONE:
 458                 pads_done = TRUE;
 459                 break;
 460             }
 461           }
 462           gst_iterator_free (pad_iter);
 463         }
 464         gst_object_unref (element);
 465         break;
 466       case GST_ITERATOR_RESYNC:
 467         gst_iterator_resync (element_iter);
 468         break;
 469       case GST_ITERATOR_ERROR:
 470       case GST_ITERATOR_DONE:
 471         elements_done = TRUE;
 472         break;
 473     }
 474   }
 475   gst_iterator_free (element_iter);
 476   g_free (spc);
 477 }
 478
 479 /*
 480  * _gst_debug_bin_to_dot_file:
 481  * @bin: the top-level pipeline that should be analyzed
 482  * @file_name: output base filename (e.g. "myplayer")
 483  *
 484  * To aid debugging applications one can use this method to write out the whole
 485  * network of gstreamer elements that form the pipeline into an dot file.
 486  * This file can be processed with graphviz to get an image.
 487  * <informalexample><programlisting>
 488  *  dot -Tpng -oimage.png graph_lowlevel.dot
 489  * </programlisting></informalexample>
 490  */
 491 void
 492 _gst_debug_bin_to_dot_file (GstBin * bin, GstDebugGraphDetails details,
 493     const gchar * file_name)
 494 {
 495   gchar *full_file_name = NULL;
 496   FILE *out;
 497
 498   g_return_if_fail (GST_IS_BIN (bin));
 499
 500   if (G_LIKELY (priv_gst_dump_dot_dir == NULL))
 501     return;
 502
 503   if (!file_name) {
 504     file_name = g_get_application_name ();
 505     if (!file_name)
 506       file_name = "unnamed";
 507   }
 508
 509   full_file_name = g_strdup_printf ("%s" G_DIR_SEPARATOR_S "%s.dot",
 510       priv_gst_dump_dot_dir, file_name);
 511
 512   if ((out = fopen (full_file_name, "wb"))) {
 513     gchar *state_name = NULL;
 514     gchar *param_name = NULL;
 515
 516     if (details & GST_DEBUG_GRAPH_SHOW_STATES) {
 517       state_name = debug_dump_get_element_state (GST_ELEMENT (bin));
 518     }
 519     if (details & GST_DEBUG_GRAPH_SHOW_NON_DEFAULT_PARAMS) {
 520       param_name = debug_dump_get_element_params (GST_ELEMENT (bin));
 521     }
 522
 523     /* write header */
 524     fprintf (out,
 525         "digraph pipeline {\n"
 526         "  rankdir=LR;\n"
 527         "  fontname=\"Bitstream Vera Sans\";\n"
 528         "  fontsize=\"8\";\n"
 529         "  labelloc=t;\n"
 530         "  nodesep=.1;\n"
 531         "  ranksep=.2;\n"
 532         "  label=\"<%s>\\n%s%s%s\";\n"
 533         "  node [style=filled, shape=box, fontsize=\"7\", fontname=\"Bitstream Vera Sans\"];\n"
 534         "  edge [labelfontsize=\"7\", fontsize=\"7\", labelfontname=\"Bitstream Vera Sans\", fontname=\"Bitstream Vera Sans\"];\n"
 535         "\n", G_OBJECT_TYPE_NAME (bin), GST_OBJECT_NAME (bin),
 536         (state_name ? state_name : ""), (param_name ? param_name : "")
 537         );
 538     if (state_name)
 539       g_free (state_name);
 540     if (param_name)
 541       g_free (param_name);
 542
 543     debug_dump_element (bin, details, out, 1);
 544
 545     /* write footer */
 546     fprintf (out, "}\n");
 547     fclose (out);
 548     GST_INFO ("wrote bin graph to : '%s'", full_file_name);
 549   } else {
 550     GST_WARNING ("Failed to open file '%s' for writing: %s", full_file_name,
 551         g_strerror (errno));
 552   }
 553   g_free (full_file_name);
 554 }
 555
 556 /*
 557  * _gst_debug_bin_to_dot_file_with_ts:
 558  * @bin: the top-level pipeline that should be analyzed
 559  * @file_name: output base filename (e.g. "myplayer")
 560  *
 561  * This works like _gst_debug_bin_to_dot_file(), but adds the current timestamp
 562  * to the filename, so that it can be used to take multiple snapshots.
 563  */
 564 void
 565 _gst_debug_bin_to_dot_file_with_ts (GstBin * bin, GstDebugGraphDetails details,
 566     const gchar * file_name)
 567 {
 568   gchar *ts_file_name = NULL;
 569   GstClockTime elapsed;
 570
 571   g_return_if_fail (GST_IS_BIN (bin));
 572
 573   if (!file_name) {
 574     file_name = g_get_application_name ();
 575     if (!file_name)
 576       file_name = "unnamed";
 577   }
 578
 579   /* add timestamp */
 580   elapsed = GST_CLOCK_DIFF (_priv_gst_info_start_time,
 581       gst_util_get_timestamp ());
 582   ts_file_name =
 583       g_strdup_printf ("%" GST_TIME_FORMAT "-%s", GST_TIME_ARGS (elapsed),
 584       file_name);
 585
 586   _gst_debug_bin_to_dot_file (bin, details, ts_file_name);
 587   g_free (ts_file_name);
 588 }
 589
 590 #endif /* GST_DISABLE_GST_DEBUG */