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