1 <!-- ##### SECTION Title ##### -->
4 <!-- ##### SECTION Short_Description ##### -->
5 info/debugging/error handling
7 <!-- ##### SECTION Long_Description ##### -->
9 gstinfo.c contains a number of debuggins subsystems.
12 <para>The INFO subsystem is used to provide informative printouts to
13 application and plugin developers. These messages can be enabled and
14 disabled via a category system, which is a bitmask enabling you to turn
15 on and off any subset of categories.</para>
17 <para>The DEBUG subsystem is similar, but is intended for core developers
18 and those writing more complex pipelines or filters. It uses the same
19 category system, but must be enabled at configure time else it's not
20 compiled into the library. autogen.sh automatically enables the DEBUG
24 <para>The ERROR subsystem doesn't use categories, but will print out a
25 more verbose message, and attempt to print out a stack trace of the error
26 before aborting the application.
29 <!-- ##### SECTION See_Also ##### -->
34 <!-- ##### FUNCTION gst_get_category_name ##### -->
43 <!-- ##### FUNCTION gst_info_get_categories ##### -->
51 <!-- ##### FUNCTION gst_info_set_categories ##### -->
59 <!-- ##### FUNCTION gst_info_enable_category ##### -->
67 <!-- ##### FUNCTION gst_info_disable_category ##### -->
75 <!-- ##### FUNCTION gst_default_info_handler ##### -->
90 <!-- ##### MACRO GST_INFO_ENABLED ##### -->
92 When defined, INFO printouts are compiled into the library.
97 <!-- ##### MACRO GST_INFO ##### -->
99 Print out any information usable at run-time by application developers.
102 @cat: the GST_CAT_... category for the information
103 @format: printf-style format string
104 @args...: printf arguments
107 <!-- ##### MACRO GST_INFO_ELEMENT ##### -->
109 Print out information like #GST_INFO, but with an element pointer to clarify things.
112 @cat: the GST_CAT_... category for the information
113 @element: pointer to the #GstElement in question
114 @format: printf-style format string
115 @args...: printf arguments
118 <!-- ##### FUNCTION gst_debug_get_categories ##### -->
126 <!-- ##### FUNCTION gst_debug_set_categories ##### -->
134 <!-- ##### FUNCTION gst_debug_enable_category ##### -->
142 <!-- ##### FUNCTION gst_debug_disable_category ##### -->
150 <!-- ##### MACRO GST_DEBUG_ENTER ##### -->
152 Called at the beginning of a function, it simply prints out a DEBUG string of "entering"
153 in addition to the given string.
156 @format: printf-style format string
157 @args...: printf arguments
160 <!-- ##### MACRO GST_DEBUG_LEAVE ##### -->
162 Called at the end of a function, it simply prints out a DEBUG string of "leaving"
163 in addition to the given string.
166 @format: printf-stype format string
167 @args...: printf arguments
170 <!-- ##### MACRO GST_DEBUG ##### -->
172 Print out debugging information.
175 @cat: the GST_CAT_... the debug falls within
176 @format: printf-style format string
177 @args...: printf arguments
180 <!-- ##### MACRO GST_DEBUG_FUNCPTR ##### -->
182 Add a function to the global function pointer table used for debugging.
185 @ptr: The pointer to add to the function table.
188 <!-- ##### MACRO GST_DEBUG_FUNCPTR_NAME ##### -->
190 Get the name of the given function pointer by looking up its name in the global
194 @ptr: The pointer to look up.
197 <!-- ##### MACRO GST_DEBUG_PAD_NAME ##### -->
199 Print out debugging statements for a pad.
202 @pad: The pad to debug.
205 <!-- ##### MACRO GST_DEBUG_THREAD_ARGS ##### -->
207 Part of the colorized debug functions for threads
213 <!-- ##### MACRO GST_DEBUG_THREAD_FORMAT ##### -->
215 Part of the colorized debug functions for threads
220 <!-- ##### MACRO GST_DEBUG_ELEMENT ##### -->
222 Print out usefull debugging info of an element.
225 @cat: The category of this debugging statement.
226 @element: The element to debug.
227 @format: A printf-like string.
228 @args...: The argument for the printf-like string.
231 <!-- ##### MACRO GST_ERROR ##### -->
233 Print out an error condition and abort the application.
236 @element: the #GstElement in question
237 @format: printf-style format string
238 @args...: printf arguments
241 <!-- ##### MACRO GST_ERROR_OBJECT ##### -->
243 Print out an error condition and abort the application.
246 @element: the #GstElement in question
247 @object: pointer to a 'contributing' object
248 @format: printf-style format string
249 @args...: printf arguments
252 <!-- ##### USER_FUNCTION GstDebugHandler ##### -->
267 <!-- ##### FUNCTION gst_default_debug_handler ##### -->
282 <!-- ##### FUNCTION gst_default_error_handler ##### -->
296 <!-- ##### USER_FUNCTION GstInfoHandler ##### -->
311 <!-- ##### USER_FUNCTION GstErrorHandler ##### -->