gst/gstdebugutils.h

   1 /* GStreamer
   2  * Copyright (C) 2007 Stefan Kost <ensonic@users.sf.net>
   3  *
   4  * gstdebugutils.h: 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., 51 Franklin St, Fifth Floor,
  19  * Boston, MA 02110-1301, USA.
  20  */
  21
  22 #ifndef __GSTDEBUGUTILS_H__
  23 #define __GSTDEBUGUTILS_H__
  24
  25 #include <glib.h>
  26 #include <glib-object.h>
  27 #include <gst/gstconfig.h>
  28 #include <gst/gstbin.h>
  29
  30 G_BEGIN_DECLS
  31
  32 /**
  33  * GstDebugGraphDetails:
  34  * @GST_DEBUG_GRAPH_SHOW_MEDIA_TYPE: show caps-name on edges
  35  * @GST_DEBUG_GRAPH_SHOW_CAPS_DETAILS: show caps-details on edges
  36  * @GST_DEBUG_GRAPH_SHOW_NON_DEFAULT_PARAMS: show modified parameters on
  37  *                                           elements
  38  * @GST_DEBUG_GRAPH_SHOW_STATES: show element states
  39  * @GST_DEBUG_GRAPH_SHOW_FULL_PARAMS: show full element parameter values even
  40  *                                    if they are very long
  41  * @GST_DEBUG_GRAPH_SHOW_ALL: show all the typical details that one might want
  42  * @GST_DEBUG_GRAPH_SHOW_VERBOSE: show all details regardless of how large or
  43  *                                verbose they make the resulting output
  44  *
  45  * Available details for pipeline graphs produced by GST_DEBUG_BIN_TO_DOT_FILE()
  46  * and GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS().
  47  */
  48 typedef enum {
  49   GST_DEBUG_GRAPH_SHOW_MEDIA_TYPE         = (1<<0),
  50   GST_DEBUG_GRAPH_SHOW_CAPS_DETAILS       = (1<<1),
  51   GST_DEBUG_GRAPH_SHOW_NON_DEFAULT_PARAMS = (1<<2),
  52   GST_DEBUG_GRAPH_SHOW_STATES             = (1<<3),
  53   GST_DEBUG_GRAPH_SHOW_FULL_PARAMS        = (1<<4),
  54   GST_DEBUG_GRAPH_SHOW_ALL                = ((1<<4)-1),
  55   GST_DEBUG_GRAPH_SHOW_VERBOSE            = (-1)
  56 } GstDebugGraphDetails;
  57
  58
  59 /********** pipeline graphs **********/
  60
  61 GST_API
  62 gchar * gst_debug_bin_to_dot_data (GstBin *bin, GstDebugGraphDetails details);
  63
  64 GST_API
  65 void gst_debug_bin_to_dot_file (GstBin *bin, GstDebugGraphDetails details, const gchar *file_name);
  66
  67 GST_API
  68 void gst_debug_bin_to_dot_file_with_ts (GstBin *bin, GstDebugGraphDetails details, const gchar *file_name);
  69
  70 #ifndef GST_DISABLE_GST_DEBUG
  71
  72 /**
  73  * GST_DEBUG_BIN_TO_DOT_FILE:
  74  * @bin: the top-level pipeline that should be analyzed
  75  * @details: details to show in the graph, e.g. #GST_DEBUG_GRAPH_SHOW_ALL or
  76  *    one or more other #GstDebugGraphDetails flags.
  77  * @file_name: output base filename (e.g. "myplayer")
  78  *
  79  * To aid debugging applications one can use this method to write out the whole
  80  * network of gstreamer elements that form the pipeline into an dot file.
  81  * This file can be processed with graphviz to get an image, like this:
  82  * |[
  83  *  dot -Tpng -oimage.png graph_lowlevel.dot
  84  * ]|
  85  * There is also a utility called xdot which allows you to view the dot file
  86  * directly without converting it first.
  87  *
  88  * The macro is only active if gstreamer is configured with
  89  * &quot;--gst-enable-gst-debug&quot; and the environment variable
  90  * GST_DEBUG_DUMP_DOT_DIR is set to a basepath (e.g. /tmp).
  91  */
  92 #define GST_DEBUG_BIN_TO_DOT_FILE(bin, details, file_name) gst_debug_bin_to_dot_file (bin, details, file_name)
  93
  94 /**
  95  * GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS:
  96  * @bin: the top-level pipeline that should be analyzed
  97  * @details: details to show in the graph, e.g. #GST_DEBUG_GRAPH_SHOW_ALL or
  98  *    one or more other #GstDebugGraphDetails flags.
  99  * @file_name: output base filename (e.g. "myplayer")
 100  *
 101  * This works like GST_DEBUG_BIN_TO_DOT_FILE(), but adds the current timestamp
 102  * to the filename, so that it can be used to take multiple snapshots.
 103  */
 104 #define GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS(bin, details, file_name) gst_debug_bin_to_dot_file_with_ts (bin, details, file_name)
 105
 106
 107 #else /* GST_DISABLE_GST_DEBUG */
 108
 109
 110 #define GST_DEBUG_BIN_TO_DOT_FILE(bin, details, file_name)
 111 #define GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS(bin, details, file_name)
 112
 113 #endif /* GST_DISABLE_GST_DEBUG */
 114
 115 G_END_DECLS
 116
 117 #endif /* __GSTDEBUGUTILS_H__ */
 118