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