1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
/* GStreamer
* Copyright (C) 2007 Stefan Kost <ensonic@users.sf.net>
*
* gstdebugutils.h: debugging and analysis utilities
*
* 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().
*/
/* FIXME: For GST_DEBUG_GRAPH_SHOW_VERBOSE ~0 -> 0xffffffff see
* https://bugzilla.gnome.org/show_bug.cgi?id=732633
*/
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 = (gint) (0xffffffff)
} 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 a dot file.
* This file can be processed with graphviz to get an image, like this:
*
* ``` shell
* 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 the environment variable `GST_DEBUG_DUMP_DOT_DIR`
* is set to a basepath (e.g. `/tmp`), and the GStreamer debugging subsystem is
* enabled (i.e., no use of `./configure --disable-gst-debug`)
*
* [xdot]: https://pypi.org/project/xdot/
*/
#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__ */
|
