/* GStreamer

 * Copyright (C) 2007 Stefan Kost <ensonic@users.sf.net>

 *

 * gstdebugutils.h: debugging and analysis utillities

 *

 * This library is free software; you can redistribute it and/or

 * modify it under the terms of the GNU Library General Public

 * License as published by the Free Software Foundation; either

 * version 2 of the License, or (at your option) any later version.

 *

 * This library is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

 * Library General Public License for more details.

 *

 * You should have received a copy of the GNU Library General Public

 * License along with this library; if not, write to the

 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,

 * Boston, MA 02110-1301, USA.

 */

#ifndef __GSTDEBUGUTILS_H__

#define __GSTDEBUGUTILS_H__

#include <glib.h>

#include <glib-object.h>

#include <gst/gstconfig.h>

#include <gst/gstbin.h>

G_BEGIN_DECLS

/**

 * GstDebugGraphDetails:

 * @GST_DEBUG_GRAPH_SHOW_MEDIA_TYPE: show caps-name on edges

 * @GST_DEBUG_GRAPH_SHOW_CAPS_DETAILS: show caps-details on edges

 * @GST_DEBUG_GRAPH_SHOW_NON_DEFAULT_PARAMS: show modified parameters on

 *                                           elements

 * @GST_DEBUG_GRAPH_SHOW_STATES: show element states

 * @GST_DEBUG_GRAPH_SHOW_FULL_PARAMS: show full element parameter values even

 *                                    if they are very long

 * @GST_DEBUG_GRAPH_SHOW_ALL: show all the typical details that one might want

 * @GST_DEBUG_GRAPH_SHOW_VERBOSE: show all details regardless of how large or

 *                                verbose they make the resulting output

 *

 * Available details for pipeline graphs produced by GST_DEBUG_BIN_TO_DOT_FILE()

 * and GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS().

 */

typedef enum {

  GST_DEBUG_GRAPH_SHOW_MEDIA_TYPE         = (1<<0),

  GST_DEBUG_GRAPH_SHOW_CAPS_DETAILS       = (1<<1),

  GST_DEBUG_GRAPH_SHOW_NON_DEFAULT_PARAMS = (1<<2),

  GST_DEBUG_GRAPH_SHOW_STATES             = (1<<3),

  GST_DEBUG_GRAPH_SHOW_FULL_PARAMS        = (1<<4),

  GST_DEBUG_GRAPH_SHOW_ALL                = ((1<<4)-1),

  GST_DEBUG_GRAPH_SHOW_VERBOSE            = (-1)

} GstDebugGraphDetails;

/********** pipeline graphs **********/

GST_API

gchar * gst_debug_bin_to_dot_data (GstBin *bin, GstDebugGraphDetails details);

GST_API

void gst_debug_bin_to_dot_file (GstBin *bin, GstDebugGraphDetails details, const gchar *file_name);

GST_API

void gst_debug_bin_to_dot_file_with_ts (GstBin *bin, GstDebugGraphDetails details, const gchar *file_name);

#ifndef GST_DISABLE_GST_DEBUG

/**

 * GST_DEBUG_BIN_TO_DOT_FILE:

 * @bin: the top-level pipeline that should be analyzed

 * @details: details to show in the graph, e.g. #GST_DEBUG_GRAPH_SHOW_ALL or

 *    one or more other #GstDebugGraphDetails flags.

 * @file_name: output base filename (e.g. "myplayer")

 *

 * To aid debugging applications one can use this method to write out the whole

 * network of gstreamer elements that form the pipeline into an dot file.

 * This file can be processed with graphviz to get an image, like this:

 * |[

 *  dot -Tpng -oimage.png graph_lowlevel.dot

 * ]|

 * There is also a utility called xdot which allows you to view the dot file

 * directly without converting it first.

 *

 * The macro is only active if gstreamer is configured with

 * "--gst-enable-gst-debug" and the environment variable

 * GST_DEBUG_DUMP_DOT_DIR is set to a basepath (e.g. /tmp).

 */

#define GST_DEBUG_BIN_TO_DOT_FILE(bin, details, file_name) gst_debug_bin_to_dot_file (bin, details, file_name)

/**

 * GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS:

 * @bin: the top-level pipeline that should be analyzed

 * @details: details to show in the graph, e.g. #GST_DEBUG_GRAPH_SHOW_ALL or

 *    one or more other #GstDebugGraphDetails flags.

 * @file_name: output base filename (e.g. "myplayer")

 *

 * This works like GST_DEBUG_BIN_TO_DOT_FILE(), but adds the current timestamp

 * to the filename, so that it can be used to take multiple snapshots.

 */

#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)

#else /* GST_DISABLE_GST_DEBUG */

#define GST_DEBUG_BIN_TO_DOT_FILE(bin, details, file_name)

#define GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS(bin, details, file_name)

#endif /* GST_DISABLE_GST_DEBUG */

G_END_DECLS

#endif /* __GSTDEBUGUTILS_H__ */