docs/gst/tmpl/gstinfo.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GstInfo
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 info/debugging/error handling
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 gstinfo.c contains a number of debuggins subsystems.
  10 </para>
  11
  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>
  16
  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
  21 subsystem.
  22 </para>
  23
  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.
  27 </para>
  28
  29 <!-- ##### SECTION See_Also ##### -->
  30 <para>
  31
  32 </para>
  33
  34 <!-- ##### FUNCTION gst_get_category_name ##### -->
  35 <para>
  36
  37 </para>
  38
  39 @category:
  40 @Returns:
  41
  42
  43 <!-- ##### FUNCTION gst_info_get_categories ##### -->
  44 <para>
  45
  46 </para>
  47
  48 @Returns:
  49
  50
  51 <!-- ##### FUNCTION gst_info_set_categories ##### -->
  52 <para>
  53
  54 </para>
  55
  56 @categories:
  57
  58
  59 <!-- ##### FUNCTION gst_info_enable_category ##### -->
  60 <para>
  61
  62 </para>
  63
  64 @category:
  65
  66
  67 <!-- ##### FUNCTION gst_info_disable_category ##### -->
  68 <para>
  69
  70 </para>
  71
  72 @category:
  73
  74
  75 <!-- ##### FUNCTION gst_default_info_handler ##### -->
  76 <para>
  77
  78 </para>
  79
  80 @category:
  81 @incore:
  82 @file:
  83 @function:
  84 @line:
  85 @debug_string:
  86 @element:
  87 @string:
  88
  89
  90 <!-- ##### MACRO GST_INFO_ENABLED ##### -->
  91 <para>
  92 When defined, INFO printouts are compiled into the library.
  93 </para>
  94
  95
  96
  97 <!-- ##### MACRO GST_INFO ##### -->
  98 <para>
  99 Print out any information usable at run-time by application developers.
 100 </para>
 101
 102 @cat: the GST_CAT_... category for the information
 103 @format: printf-style format string
 104 @args...: printf arguments
 105
 106
 107 <!-- ##### MACRO GST_INFO_ELEMENT ##### -->
 108 <para>
 109 Print out information like #GST_INFO, but with an element pointer to clarify things.
 110 </para>
 111
 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
 116
 117
 118 <!-- ##### FUNCTION gst_debug_get_categories ##### -->
 119 <para>
 120
 121 </para>
 122
 123 @Returns:
 124
 125
 126 <!-- ##### FUNCTION gst_debug_set_categories ##### -->
 127 <para>
 128
 129 </para>
 130
 131 @categories:
 132
 133
 134 <!-- ##### FUNCTION gst_debug_enable_category ##### -->
 135 <para>
 136
 137 </para>
 138
 139 @category:
 140
 141
 142 <!-- ##### FUNCTION gst_debug_disable_category ##### -->
 143 <para>
 144
 145 </para>
 146
 147 @category:
 148
 149
 150 <!-- ##### MACRO GST_DEBUG_ENTER ##### -->
 151 <para>
 152 Called at the beginning of a function, it simply prints out a DEBUG string of "entering"
 153 in addition to the given string.
 154 </para>
 155
 156 @format: printf-style format string
 157 @args...: printf arguments
 158
 159
 160 <!-- ##### MACRO GST_DEBUG_LEAVE ##### -->
 161 <para>
 162 Called at the end of a function, it simply prints out a DEBUG string of "leaving"
 163 in addition to the given string.
 164 </para>
 165
 166 @format: printf-stype format string
 167 @args...: printf arguments
 168
 169
 170 <!-- ##### MACRO GST_DEBUG ##### -->
 171 <para>
 172 Print out debugging information.
 173 </para>
 174
 175 @cat: the GST_CAT_... the debug falls within
 176 @format: printf-style format string
 177 @args...: printf arguments
 178
 179
 180 <!-- ##### MACRO GST_DEBUG_FUNCPTR ##### -->
 181 <para>
 182 Add a function to the global function pointer table used for debugging.
 183 </para>
 184
 185 @ptr: The pointer to add to the function table.
 186
 187
 188 <!-- ##### MACRO GST_DEBUG_FUNCPTR_NAME ##### -->
 189 <para>
 190 Get the name of the given function pointer by looking up its name in the global
 191 function table.
 192 </para>
 193
 194 @ptr: The pointer to look up.
 195
 196
 197 <!-- ##### MACRO GST_DEBUG_PAD_NAME ##### -->
 198 <para>
 199 Print out debugging statements for a pad.
 200 </para>
 201
 202 @pad: The pad to debug.
 203
 204
 205 <!-- ##### MACRO GST_DEBUG_THREAD_ARGS ##### -->
 206 <para>
 207 Part of the colorized debug functions for threads
 208 </para>
 209
 210 @id: The thread id.
 211
 212
 213 <!-- ##### MACRO GST_DEBUG_THREAD_FORMAT ##### -->
 214 <para>
 215 Part of the colorized debug functions for threads
 216 </para>
 217
 218
 219
 220 <!-- ##### MACRO GST_DEBUG_ELEMENT ##### -->
 221 <para>
 222 Print out usefull debugging info of an element.
 223 </para>
 224
 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.
 229
 230
 231 <!-- ##### MACRO GST_ERROR ##### -->
 232 <para>
 233 Print out an error condition and abort the application.
 234 </para>
 235
 236 @element: the #GstElement in question
 237 @format: printf-style format string
 238 @args...: printf arguments
 239
 240
 241 <!-- ##### MACRO GST_ERROR_OBJECT ##### -->
 242 <para>
 243 Print out an error condition and abort the application.
 244 </para>
 245
 246 @element: the #GstElement in question
 247 @object: pointer to a 'contributing' object
 248 @format: printf-style format string
 249 @args...: printf arguments
 250
 251
 252 <!-- ##### USER_FUNCTION GstDebugHandler ##### -->
 253 <para>
 254
 255 </para>
 256
 257 @category:
 258 @core:
 259 @file:
 260 @function:
 261 @line:
 262 @debug_string:
 263 @element:
 264 @string:
 265
 266
 267 <!-- ##### FUNCTION gst_default_debug_handler ##### -->
 268 <para>
 269
 270 </para>
 271
 272 @category:
 273 @incore:
 274 @file:
 275 @function:
 276 @line:
 277 @debug_string:
 278 @element:
 279 @string:
 280
 281
 282 <!-- ##### FUNCTION gst_default_error_handler ##### -->
 283 <para>
 284
 285 </para>
 286
 287 @file:
 288 @function:
 289 @line:
 290 @debug_string:
 291 @element:
 292 @object:
 293 @string:
 294
 295
 296 <!-- ##### USER_FUNCTION GstInfoHandler ##### -->
 297 <para>
 298
 299 </para>
 300
 301 @category:
 302 @incore:
 303 @file:
 304 @function:
 305 @line:
 306 @debug_string:
 307 @element:
 308 @string:
 309
 310
 311 <!-- ##### USER_FUNCTION GstErrorHandler ##### -->
 312 <para>
 313
 314 </para>
 315
 316 @file:
 317 @function:
 318 @line:
 319 @debug_string:
 320 @element:
 321 @object:
 322 @string:
 323
 324