mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-29 21:21:12 +00:00
890dd8b468
Original commit message from CVS: * gst/gstdebugutils.h: (GstDebugGraphDetails), (GST_DEBUG_BIN_TO_DOT_FILE): Add missing Since' markers to gtk-doc blurbs.
109 lines
3.8 KiB
C
109 lines
3.8 KiB
C
/* 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., 59 Temple Place - Suite 330,
|
|
* Boston, MA 02111-1307, 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_ALL: show all details
|
|
*
|
|
* Available details for pipeline graphs produced by GST_DEBUG_BIN_TO_DOT_FILE()
|
|
* and GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS().
|
|
*
|
|
* Since: 0.10.15
|
|
*/
|
|
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_ALL = ((1<<4)-1)
|
|
} GstDebugGraphDetails;
|
|
|
|
|
|
#ifndef GST_DISABLE_GST_DEBUG
|
|
|
|
/********** pipeline graphs **********/
|
|
|
|
void _gst_debug_bin_to_dot_file (GstBin *bin, GstDebugGraphDetails details, const gchar *file_name);
|
|
void _gst_debug_bin_to_dot_file_with_ts (GstBin *bin, GstDebugGraphDetails details, const gchar *file_name);
|
|
|
|
/**
|
|
* 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.
|
|
* <informalexample><programlisting>
|
|
* dot -Tpng -oimage.png graph_lowlevel.dot
|
|
* </programlisting></informalexample>
|
|
*
|
|
* 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).
|
|
*
|
|
* Since: 0.10.15
|
|
*/
|
|
#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.
|
|
*
|
|
* Since: 0.10.15
|
|
*/
|
|
#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__ */
|
|
|