gst/gstinfo.h

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *                    2003 Benjamin Otte <in7y118@public.uni-hamburg.de>
   5  *
   6  * gstinfo.h: debugging functions
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  21  * Boston, MA 02110-1301, USA.
  22  */
  23
  24 #ifndef __GSTINFO_H__
  25 #define __GSTINFO_H__
  26
  27 #include <glib.h>
  28 #include <glib-object.h>
  29 #include <gst/gstconfig.h>
  30
  31 G_BEGIN_DECLS
  32
  33 /**
  34  * GstDebugLevel:
  35  * @GST_LEVEL_NONE: No debugging level specified or desired. Used to deactivate
  36  *  debugging output.
  37  * @GST_LEVEL_ERROR: Error messages are to be used only when an error occurred
  38  *  that stops the application from keeping working correctly.
  39  *  An examples is gst_element_error, which outputs a message with this priority.
  40  *  It does not mean that the application is terminating as with g_error.
  41  * @GST_LEVEL_WARNING: Warning messages are to inform about abnormal behaviour
  42  *  that could lead to problems or weird behaviour later on. An example of this
  43  *  would be clocking issues ("your computer is pretty slow") or broken input
  44  *  data ("Can't synchronize to stream.")
  45  * @GST_LEVEL_FIXME: Fixme messages are messages that indicate that something
  46  *  in the executed code path is not fully implemented or handled yet. Note
  47  *  that this does not replace proper error handling in any way, the purpose
  48  *  of this message is to make it easier to spot incomplete/unfinished pieces
  49  *  of code when reading the debug log.
  50  * @GST_LEVEL_INFO: Informational messages should be used to keep the developer
  51  *  updated about what is happening.
  52  *  Examples where this should be used are when a typefind function has
  53  *  successfully determined the type of the stream or when an mp3 plugin detects
  54  *  the format to be used. ("This file has mono sound.")
  55  * @GST_LEVEL_DEBUG: Debugging messages should be used when something common
  56  *  happens that is not the expected default behavior, or something that's
  57  *  useful to know but doesn't happen all the time (ie. per loop iteration or
  58  *  buffer processed or event handled).
  59  *  An example would be notifications about state changes or receiving/sending
  60  *  of events.
  61  * @GST_LEVEL_LOG: Log messages are messages that are very common but might be
  62  *  useful to know. As a rule of thumb a pipeline that is running as expected
  63  *  should never output anything else but LOG messages whilst processing data.
  64  *  Use this log level to log recurring information in chain functions and
  65  *  loop functions, for example.
  66  * @GST_LEVEL_TRACE: Tracing-related messages.
  67  *  Examples for this are referencing/dereferencing of objects.
  68  * @GST_LEVEL_MEMDUMP: memory dump messages are used to log (small) chunks of
  69  *  data as memory dumps in the log. They will be displayed as hexdump with
  70  *  ASCII characters.
  71  * @GST_LEVEL_COUNT: The number of defined debugging levels.
  72  *
  73  * The level defines the importance of a debugging message. The more important a
  74  * message is, the greater the probability that the debugging system outputs it.
  75  */
  76 typedef enum {
  77   GST_LEVEL_NONE = 0,
  78   GST_LEVEL_ERROR = 1,
  79   GST_LEVEL_WARNING = 2,
  80   GST_LEVEL_FIXME = 3,
  81   GST_LEVEL_INFO = 4,
  82   GST_LEVEL_DEBUG = 5,
  83   GST_LEVEL_LOG = 6,
  84   GST_LEVEL_TRACE = 7,
  85   /* add more */
  86   GST_LEVEL_MEMDUMP = 9,
  87   /* add more */
  88   GST_LEVEL_COUNT
  89 } GstDebugLevel;
  90
  91 /**
  92  * GST_LEVEL_DEFAULT:
  93  *
  94  * Defines the default debugging level to be used with GStreamer. It is normally
  95  * set to #GST_LEVEL_NONE so nothing get printed.
  96  * As it can be configured at compile time, developer builds may chose to
  97  * override that though.
  98  * You can use this as an argument to gst_debug_set_default_threshold() to
  99  * reset the debugging output to default behaviour.
 100  */
 101 #ifndef GST_LEVEL_DEFAULT
 102 #define GST_LEVEL_DEFAULT GST_LEVEL_NONE
 103 #endif
 104
 105 /**
 106  * GST_LEVEL_MAX:
 107  *
 108  * Defines the maximum debugging level to be enabled at compilation time. By default
 109  * it is set such that all debugging statements will be enabled.
 110  *
 111  * If you wish to compile GStreamer and plugins with only some debugging statements
 112  * (Such as just warnings and errors), you can define it at compile time to the
 113  * maximum debug level. Any debug statements above that level will be compiled out.
 114  *
 115  * Since: 1.6
 116  */
 117 #ifndef GST_LEVEL_MAX
 118 #define GST_LEVEL_MAX GST_LEVEL_COUNT
 119 #endif
 120
 121 /* defines for format (colors etc)
 122  * don't change them around, it uses terminal layout
 123  * Terminal color strings:
 124  * 00=none 01=bold 04=underscore 05=blink 07=reverse 08=concealed
 125  * Text color codes:
 126  * 30=black 31=red 32=green 33=yellow 34=blue 35=magenta 36=cyan 37=white
 127  * Background color codes:
 128  * 40=black 41=red 42=green 43=yellow 44=blue 45=magenta 46=cyan 47=white
 129  */
 130 /**
 131  * GstDebugColorFlags:
 132  * @GST_DEBUG_FG_BLACK: Use black as foreground color.
 133  * @GST_DEBUG_FG_RED: Use red as foreground color.
 134  * @GST_DEBUG_FG_GREEN: Use green as foreground color.
 135  * @GST_DEBUG_FG_YELLOW: Use yellow as foreground color.
 136  * @GST_DEBUG_FG_BLUE: Use blue as foreground color.
 137  * @GST_DEBUG_FG_MAGENTA: Use magenta as foreground color.
 138  * @GST_DEBUG_FG_CYAN: Use cyan as foreground color.
 139  * @GST_DEBUG_FG_WHITE: Use white as foreground color.
 140  * @GST_DEBUG_BG_BLACK: Use black as background color.
 141  * @GST_DEBUG_BG_RED: Use red as background color.
 142  * @GST_DEBUG_BG_GREEN: Use green as background color.
 143  * @GST_DEBUG_BG_YELLOW: Use yellow as background color.
 144  * @GST_DEBUG_BG_BLUE: Use blue as background color.
 145  * @GST_DEBUG_BG_MAGENTA: Use magenta as background color.
 146  * @GST_DEBUG_BG_CYAN: Use cyan as background color.
 147  * @GST_DEBUG_BG_WHITE: Use white as background color.
 148  * @GST_DEBUG_BOLD: Make the output bold.
 149  * @GST_DEBUG_UNDERLINE: Underline the output.
 150  *
 151  * These are some terminal style flags you can use when creating your
 152  * debugging categories to make them stand out in debugging output.
 153  */
 154 typedef enum {
 155   /* colors */
 156   GST_DEBUG_FG_BLACK            = 0x0000,
 157   GST_DEBUG_FG_RED              = 0x0001,
 158   GST_DEBUG_FG_GREEN            = 0x0002,
 159   GST_DEBUG_FG_YELLOW           = 0x0003,
 160   GST_DEBUG_FG_BLUE             = 0x0004,
 161   GST_DEBUG_FG_MAGENTA          = 0x0005,
 162   GST_DEBUG_FG_CYAN             = 0x0006,
 163   GST_DEBUG_FG_WHITE            = 0x0007,
 164   /* background colors */
 165   GST_DEBUG_BG_BLACK            = 0x0000,
 166   GST_DEBUG_BG_RED              = 0x0010,
 167   GST_DEBUG_BG_GREEN            = 0x0020,
 168   GST_DEBUG_BG_YELLOW           = 0x0030,
 169   GST_DEBUG_BG_BLUE             = 0x0040,
 170   GST_DEBUG_BG_MAGENTA          = 0x0050,
 171   GST_DEBUG_BG_CYAN             = 0x0060,
 172   GST_DEBUG_BG_WHITE            = 0x0070,
 173   /* other formats */
 174   GST_DEBUG_BOLD                = 0x0100,
 175   GST_DEBUG_UNDERLINE           = 0x0200
 176 } GstDebugColorFlags;
 177
 178 /**
 179  * GstDebugColorMode:
 180  * @GST_DEBUG_COLOR_MODE_OFF: Do not use colors in logs.
 181  * @GST_DEBUG_COLOR_MODE_ON: Paint logs in a platform-specific way.
 182  * @GST_DEBUG_COLOR_MODE_UNIX: Paint logs with UNIX terminal color codes
 183  *                             no matter what platform GStreamer is running on.
 184  */
 185 typedef enum {
 186   GST_DEBUG_COLOR_MODE_OFF  = 0,
 187   GST_DEBUG_COLOR_MODE_ON   = 1,
 188   GST_DEBUG_COLOR_MODE_UNIX = 2
 189 } GstDebugColorMode;
 190
 191
 192 #define GST_DEBUG_FG_MASK       (0x000F)
 193 #define GST_DEBUG_BG_MASK       (0x00F0)
 194 #define GST_DEBUG_FORMAT_MASK   (0xFF00)
 195
 196 typedef struct _GstDebugCategory GstDebugCategory;
 197 /**
 198  * GstDebugCategory:
 199  *
 200  * This is the struct that describes the categories. Once initialized with
 201  * #GST_DEBUG_CATEGORY_INIT, its values can't be changed anymore.
 202  */
 203 struct _GstDebugCategory {
 204   /*< private >*/
 205   gint                  threshold;
 206   guint                 color;          /* see defines above */
 207
 208   const gchar *         name;
 209   const gchar *         description;
 210 };
 211
 212 /********** some convenience macros for debugging **********/
 213
 214 /**
 215  * GST_STR_NULL:
 216  * @str: (allow-none): The string to check.
 217  *
 218  * Macro to use when a string must not be %NULL, but may be %NULL. If the string
 219  * is %NULL, "(NULL)" is printed instead.
 220  * In GStreamer printf string arguments may not be %NULL, because on some
 221  * platforms (ie Solaris) the libc crashes in that case. This includes debugging
 222  * strings.
 223  */
 224 #define GST_STR_NULL(str) ((str) ? (str) : "(NULL)")
 225
 226 /* FIXME, not MT safe */
 227 /**
 228  * GST_DEBUG_PAD_NAME:
 229  * @pad: The pad to debug.
 230  *
 231  * Evaluates to 2 strings, that describe the pad. Often used in debugging
 232  * statements.
 233  */
 234 #define GST_DEBUG_PAD_NAME(pad) \
 235   (pad != NULL) ?  \
 236   ((GST_OBJECT_PARENT(pad) != NULL) ? \
 237   GST_STR_NULL (GST_OBJECT_NAME (GST_OBJECT_PARENT(pad))) : \
 238   "''" ) : "''", \
 239   (pad != NULL) ? GST_STR_NULL (GST_OBJECT_NAME (pad)) : "''"
 240
 241 /**
 242  * GST_FUNCTION:
 243  *
 244  * This macro should evaluate to the name of the current function and be should
 245  * be defined when configuring your project, as it is compiler dependant. If it
 246  * is not defined, some default value is used. It is used to provide debugging
 247  * output with the function name of the message.
 248  *
 249  * Note that this is different from G_STRFUNC as we do not want the full
 250  * function signature in C++ code.
 251  */
 252 #ifndef GST_FUNCTION
 253 #if defined (__STDC__) && defined (__STDC_VERSION__) && __STDC_VERSION__ >= 199901L
 254 #  define GST_FUNCTION     ((const char*) (__func__))
 255 #elif defined (__GNUC__) || (defined (_MSC_VER) && _MSC_VER >= 1300)
 256 #  define GST_FUNCTION     ((const char*) (__FUNCTION__))
 257 #else
 258 #  define GST_FUNCTION     ((const char*) ("???"))
 259 #endif
 260 #endif /* ifndef GST_FUNCTION */
 261
 262 /**
 263  * GST_PTR_FORMAT:
 264  *
 265  * printf format type used to debug GStreamer types. You can use this in
 266  * combination with GStreamer's debug logging system as well as the functions
 267  * gst_info_vasprintf(), gst_info_strdup_vprintf() and gst_info_strdup_printf()
 268  * to pretty-print the following types: #GstCaps, #GstStructure,
 269  * #GstCapsFeatures, #GstTagList, #GstDateTime, #GstBuffer, #GstBufferList,
 270  * #GstMessage, #GstEvent, #GstQuery, #GstContext, #GstPad, #GstObject. All
 271  * #GObject types will be printed as typename plus pointer, and everything
 272  * else will simply be printed as pointer address.
 273  *
 274  * This can only be used on types whose size is >= sizeof(gpointer).
 275  */
 276 #define GST_PTR_FORMAT     "p\aA"
 277
 278 /**
 279  * GST_SEGMENT_FORMAT:
 280  *
 281  * printf format type used to debug GStreamer segments. You can use this in
 282  * combination with GStreamer's debug logging system as well as the functions
 283  * gst_info_vasprintf(), gst_info_strdup_vprintf() and gst_info_strdup_printf()
 284  * to pretty-print #GstSegment structures.
 285  * This can only be used on pointers to GstSegment structures.
 286  */
 287 #define GST_SEGMENT_FORMAT "p\aB"
 288
 289 typedef struct _GstDebugMessage GstDebugMessage;
 290
 291 /**
 292  * GstLogFunction:
 293  * @category: a #GstDebugCategory
 294  * @level: a #GstDebugLevel
 295  * @file: file name
 296  * @function: function name
 297  * @line: line number
 298  * @object: a #GObject
 299  * @message: the message
 300  * @user_data: user data for the log function
 301  *
 302  * Function prototype for a logging function that can be registered with
 303  * gst_debug_add_log_function().
 304  * Use G_GNUC_NO_INSTRUMENT on that function.
 305  */
 306 typedef void (*GstLogFunction)  (GstDebugCategory * category,
 307                                  GstDebugLevel      level,
 308                                  const gchar      * file,
 309                                  const gchar      * function,
 310                                  gint               line,
 311                                  GObject          * object,
 312                                  GstDebugMessage  * message,
 313                                  gpointer           user_data);
 314
 315 void                gst_debug_log            (GstDebugCategory * category,
 316                                           GstDebugLevel      level,
 317                                           const gchar      * file,
 318                                           const gchar      * function,
 319                                           gint               line,
 320                                           GObject          * object,
 321                                           const gchar      * format,
 322                                           ...) G_GNUC_PRINTF (7, 8) G_GNUC_NO_INSTRUMENT;
 323
 324 void            gst_debug_log_valist     (GstDebugCategory * category,
 325                                           GstDebugLevel      level,
 326                                           const gchar      * file,
 327                                           const gchar      * function,
 328                                           gint                line,
 329                                           GObject          * object,
 330                                           const gchar      * format,
 331                                           va_list            args) G_GNUC_NO_INSTRUMENT;
 332
 333 /* do not use this function, use the GST_DEBUG_CATEGORY_INIT macro */
 334 GstDebugCategory *_gst_debug_category_new (const gchar * name,
 335                                            guint         color,
 336                                            const gchar * description);
 337 /* do not use this function, use the GST_DEBUG_CATEGORY_GET macro */
 338 GstDebugCategory *_gst_debug_get_category (const gchar *name);
 339
 340
 341 /* do not use this function, use the GST_CAT_MEMDUMP_* macros */
 342 void _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
 343     const gchar * func, gint line, GObject * obj, const gchar * msg,
 344     const guint8 * data, guint length);
 345
 346 /* we define this to avoid a compiler warning regarding a cast from a function
 347  * pointer to a void pointer
 348  * (see https://bugzilla.gnome.org/show_bug.cgi?id=309253)
 349  */
 350 typedef void (* GstDebugFuncPtr)        (void);
 351
 352 /* do no use these functions, use the GST_DEBUG*_FUNCPTR macros */
 353 void    _gst_debug_register_funcptr     (GstDebugFuncPtr        func,
 354                                          const gchar *          ptrname);
 355 const gchar *
 356         _gst_debug_nameof_funcptr       (GstDebugFuncPtr        func) G_GNUC_NO_INSTRUMENT;
 357
 358
 359 const gchar   * gst_debug_message_get    (GstDebugMessage  * message);
 360
 361 void            gst_debug_log_default    (GstDebugCategory * category,
 362                                           GstDebugLevel      level,
 363                                           const gchar      * file,
 364                                           const gchar      * function,
 365                                           gint               line,
 366                                           GObject          * object,
 367                                           GstDebugMessage  * message,
 368                                           gpointer           user_data) G_GNUC_NO_INSTRUMENT;
 369
 370 const gchar *   gst_debug_level_get_name (GstDebugLevel level);
 371
 372 void            gst_debug_add_log_function            (GstLogFunction func,
 373                                                        gpointer       user_data,
 374                                                        GDestroyNotify notify);
 375
 376 guint           gst_debug_remove_log_function         (GstLogFunction func);
 377 guint           gst_debug_remove_log_function_by_data (gpointer       data);
 378
 379 void            gst_debug_set_active  (gboolean active);
 380 gboolean        gst_debug_is_active   (void);
 381
 382 void            gst_debug_set_colored (gboolean colored);
 383 void            gst_debug_set_color_mode   (GstDebugColorMode mode);
 384 void            gst_debug_set_color_mode_from_string (const gchar * mode);
 385 gboolean        gst_debug_is_colored  (void);
 386 GstDebugColorMode gst_debug_get_color_mode (void);
 387
 388 void            gst_debug_set_default_threshold      (GstDebugLevel level);
 389 GstDebugLevel   gst_debug_get_default_threshold      (void);
 390 void            gst_debug_set_threshold_for_name     (const gchar * name,
 391                                                       GstDebugLevel level);
 392 void            gst_debug_set_threshold_from_string  (const gchar * list, gboolean reset);
 393 void            gst_debug_unset_threshold_for_name   (const gchar * name);
 394
 395
 396 void            gst_debug_category_free              (GstDebugCategory *        category);
 397 void                gst_debug_category_set_threshold     (GstDebugCategory *    category,
 398                                                       GstDebugLevel             level);
 399 void            gst_debug_category_reset_threshold   (GstDebugCategory *        category);
 400 GstDebugLevel   gst_debug_category_get_threshold     (GstDebugCategory *        category);
 401 const gchar *   gst_debug_category_get_name          (GstDebugCategory *        category);
 402 guint           gst_debug_category_get_color         (GstDebugCategory *        category);
 403 const gchar *   gst_debug_category_get_description   (GstDebugCategory *        category);
 404 GSList *        gst_debug_get_all_categories    (void);
 405
 406
 407 gchar * gst_debug_construct_term_color (guint colorinfo);
 408 gint    gst_debug_construct_win_color  (guint colorinfo);
 409
 410 gint    gst_info_vasprintf              (gchar ** result,
 411                                          const gchar * format,
 412                                          va_list args) G_GNUC_PRINTF (2, 0);
 413 gchar * gst_info_strdup_vprintf         (const gchar *format, va_list args) G_GNUC_PRINTF (1, 0);
 414 gchar * gst_info_strdup_printf          (const gchar *format, ...) G_GNUC_PRINTF (1, 2);
 415
 416 #ifndef GST_DISABLE_GST_DEBUG
 417
 418 /* cast to void * avoids a warning with gcc 6
 419  * see https://bugzilla.gnome.org/show_bug.cgi?id=764526 */
 420 #define gst_debug_add_log_function(func,data,notify) \
 421 G_STMT_START{                                        \
 422   if (func == (void *) gst_debug_log_default) {               \
 423     gst_debug_add_log_function(NULL,data,notify);    \
 424   } else {                                           \
 425     gst_debug_add_log_function(func,data,notify);    \
 426   }                                                  \
 427 }G_STMT_END
 428
 429 #define gst_debug_remove_log_function(func)   \
 430     (func == (void *) gst_debug_log_default) ?         \
 431         gst_debug_remove_log_function(NULL) : \
 432         gst_debug_remove_log_function(func)
 433
 434 /**
 435  * GST_DEBUG_CATEGORY:
 436  * @cat: the category
 437  *
 438  * Defines a GstDebugCategory variable.
 439  * This macro expands to nothing if debugging is disabled.
 440  */
 441 #define GST_DEBUG_CATEGORY(cat) GstDebugCategory *cat = NULL
 442 /**
 443  * GST_DEBUG_CATEGORY_EXTERN:
 444  * @cat: the category
 445  *
 446  * Declares a GstDebugCategory variable as extern. Use in header files.
 447  * This macro expands to nothing if debugging is disabled.
 448  */
 449 #define GST_DEBUG_CATEGORY_EXTERN(cat) extern GstDebugCategory *cat
 450
 451 /**
 452  * GST_DEBUG_CATEGORY_STATIC:
 453  * @cat: the category
 454  *
 455  * Defines a static GstDebugCategory variable.
 456  * This macro expands to nothing if debugging is disabled.
 457  */
 458 #define GST_DEBUG_CATEGORY_STATIC(cat) static GstDebugCategory *cat = NULL
 459
 460 /**
 461  * GST_DEBUG_CATEGORY_INIT:
 462  * @cat: the category to initialize.
 463  * @name: the name of the category.
 464  * @color: the colors to use for a color representation or 0 for no color.
 465  * @description: optional description of the category.
 466  *
 467  * Initializes a new #GstDebugCategory with the given properties and set to
 468  * the default threshold.
 469  *
 470  * <note>
 471  * <para>
 472  * This macro expands to nothing if debugging is disabled.
 473  * </para>
 474  * <para>
 475  * When naming your category, please follow the following conventions to ensure
 476  * that the pattern matching for categories works as expected. It is not
 477  * earth-shattering if you don't follow these conventions, but it would be nice
 478  * for everyone.
 479  * </para>
 480  * <para>
 481  * If you define a category for a plugin or a feature of it, name the category
 482  * like the feature. So if you wanted to write a "filesrc" element, you would
 483  * name the category "filesrc". Use lowercase letters only.
 484  * If you define more than one category for the same element, append an
 485  * underscore and an identifier to your categories, like this: "filesrc_cache"
 486  * </para>
 487  * <para>
 488  * If you create a library or an application using debugging categories, use a
 489  * common prefix followed by an underscore for all your categories. GStreamer
 490  * uses the GST prefix so GStreamer categories look like "GST_STATES". Be sure
 491  * to include uppercase letters.
 492  * </para>
 493  * </note>
 494  */
 495 #define GST_DEBUG_CATEGORY_INIT(cat,name,color,description) G_STMT_START{\
 496   if (cat == NULL)                                                      \
 497     cat = _gst_debug_category_new (name,color,description);             \
 498 }G_STMT_END
 499
 500 /**
 501  * GST_DEBUG_CATEGORY_GET:
 502  * @cat: the category to initialize.
 503  * @name: log category name
 504  *
 505  * Looks up an existing #GstDebugCategory by its @name and sets @cat. If the
 506  * category is not found, but GST_CAT_DEFAULT is defined, that is assigned to
 507  * @cat. Otherwise @cat will be %NULL.
 508  *
 509  * |[<!-- language="C" -->
 510  * GST_DEBUG_CATEGORY_STATIC (gst_myplugin_debug);
 511  * #define GST_CAT_DEFAULT gst_myplugin_debug
 512  * GST_DEBUG_CATEGORY_STATIC (GST_CAT_PERFORMANCE);
 513  * ...
 514  * GST_DEBUG_CATEGORY_INIT (gst_myplugin_debug, "myplugin", 0, "nice element");
 515  * GST_DEBUG_CATEGORY_GET (GST_CAT_PERFORMANCE, "GST_PERFORMANCE");
 516  * ]|
 517  */
 518 #ifdef GST_CAT_DEFAULT
 519 #define GST_DEBUG_CATEGORY_GET(cat,name)  G_STMT_START{\
 520   cat = _gst_debug_get_category (name);                 \
 521   if (!cat) {                                           \
 522     cat = GST_CAT_DEFAULT;                              \
 523   }                                                     \
 524 }G_STMT_END
 525 #else
 526 #define GST_DEBUG_CATEGORY_GET(cat,name)  G_STMT_START{\
 527   cat = _gst_debug_get_category (name);                 \
 528 }G_STMT_END
 529 #endif
 530
 531 /**
 532  * GST_CAT_DEFAULT:
 533  *
 534  * Default gstreamer core debug log category. Please define your own.
 535  */
 536 GST_EXPORT GstDebugCategory *   GST_CAT_DEFAULT;
 537 /* this symbol may not be used */
 538 GST_EXPORT gboolean                     _gst_debug_enabled;
 539
 540 /* the min debug level, used for quickly discarding debug
 541  * messages that fall under the threshold. */
 542 GST_EXPORT GstDebugLevel            _gst_debug_min;
 543
 544 /**
 545  * GST_CAT_LEVEL_LOG:
 546  * @cat: category to use
 547  * @level: the severity of the message
 548  * @object: (allow-none): the #GObject the message belongs to or %NULL if none
 549  * @...: A printf-style message to output
 550  *
 551  * Outputs a debugging message. This is the most general macro for outputting
 552  * debugging messages. You will probably want to use one of the ones described
 553  * below.
 554  */
 555 #ifdef G_HAVE_ISO_VARARGS
 556 #define GST_CAT_LEVEL_LOG(cat,level,object,...) G_STMT_START{           \
 557   if (G_UNLIKELY (level <= GST_LEVEL_MAX && level <= _gst_debug_min)) {                                         \
 558     gst_debug_log ((cat), (level), __FILE__, GST_FUNCTION, __LINE__,    \
 559         (GObject *) (object), __VA_ARGS__);                             \
 560   }                                                                     \
 561 }G_STMT_END
 562 #else /* G_HAVE_GNUC_VARARGS */
 563 #ifdef G_HAVE_GNUC_VARARGS
 564 #define GST_CAT_LEVEL_LOG(cat,level,object,args...) G_STMT_START{       \
 565   if (G_UNLIKELY (level <= GST_LEVEL_MAX && level <= _gst_debug_min)) {                                         \
 566     gst_debug_log ((cat), (level), __FILE__, GST_FUNCTION, __LINE__,    \
 567         (GObject *) (object), ##args );                                 \
 568   }                                                                     \
 569 }G_STMT_END
 570 #else /* no variadic macros, use inline */
 571 static inline void
 572 GST_CAT_LEVEL_LOG_valist (GstDebugCategory * cat,
 573     GstDebugLevel level, gpointer object, const char *format, va_list varargs)
 574 {
 575   if (G_UNLIKELY (level <= GST_LEVEL_MAX && level <= _gst_debug_min)) {
 576     gst_debug_log_valist (cat, level, "", "", 0, (GObject *) object, format,
 577         varargs);
 578   }
 579 }
 580
 581 static inline void
 582 GST_CAT_LEVEL_LOG (GstDebugCategory * cat, GstDebugLevel level,
 583     gpointer object, const char *format, ...)
 584 {
 585   va_list varargs;
 586
 587   va_start (varargs, format);
 588   GST_CAT_LEVEL_LOG_valist (cat, level, object, format, varargs);
 589   va_end (varargs);
 590 }
 591 #endif
 592 #endif /* G_HAVE_ISO_VARARGS */
 593
 594 /* This one doesn't have varargs in the macro, so it's different than all the
 595  * other macros and hence in a separate block right here. Docs chunks are
 596  * with the other doc chunks below though. */
 597 #define __GST_CAT_MEMDUMP_LOG(cat,object,msg,data,length) G_STMT_START{       \
 598     if (G_UNLIKELY (GST_LEVEL_MEMDUMP <= GST_LEVEL_MAX &&                     \
 599                     GST_LEVEL_MEMDUMP <= _gst_debug_min)) {                   \
 600     _gst_debug_dump_mem ((cat), __FILE__, GST_FUNCTION, __LINE__,             \
 601         (GObject *) (object), (msg), (data), (length));                       \
 602   }                                                                           \
 603 }G_STMT_END
 604
 605 #define GST_CAT_MEMDUMP_OBJECT(cat,obj,msg,data,length)  \
 606     __GST_CAT_MEMDUMP_LOG(cat,obj,msg,data,length)
 607 #define GST_CAT_MEMDUMP(cat,msg,data,length)             \
 608     __GST_CAT_MEMDUMP_LOG(cat,NULL,msg,data,length)
 609 #define GST_MEMDUMP_OBJECT(obj,msg,data,length)          \
 610     __GST_CAT_MEMDUMP_LOG(GST_CAT_DEFAULT,obj,msg,data,length)
 611 #define GST_MEMDUMP(msg,data,length)                     \
 612     __GST_CAT_MEMDUMP_LOG(GST_CAT_DEFAULT,NULL,msg,data,length)
 613
 614 /**
 615  * GST_CAT_ERROR_OBJECT:
 616  * @cat: category to use
 617  * @obj: the #GObject the message belongs to
 618  * @...: printf-style message to output
 619  *
 620  * Output an error message belonging to the given object in the given category.
 621  */
 622 /**
 623  * GST_CAT_WARNING_OBJECT:
 624  * @cat: category to use
 625  * @obj: the #GObject the message belongs to
 626  * @...: printf-style message to output
 627  *
 628  * Output a warning message belonging to the given object in the given category.
 629  */
 630 /**
 631  * GST_CAT_INFO_OBJECT:
 632  * @cat: category to use
 633  * @obj: the #GObject the message belongs to
 634  * @...: printf-style message to output
 635  *
 636  * Output an informational message belonging to the given object in the given
 637  * category.
 638  */
 639 /**
 640  * GST_CAT_DEBUG_OBJECT:
 641  * @cat: category to use
 642  * @obj: the #GObject the message belongs to
 643  * @...: printf-style message to output
 644  *
 645  * Output an debugging message belonging to the given object in the given category.
 646  */
 647 /**
 648  * GST_CAT_LOG_OBJECT:
 649  * @cat: category to use
 650  * @obj: the #GObject the message belongs to
 651  * @...: printf-style message to output
 652  *
 653  * Output an logging message belonging to the given object in the given category.
 654  */
 655 /**
 656  * GST_CAT_FIXME_OBJECT:
 657  * @cat: category to use
 658  * @obj: the #GObject the message belongs to
 659  * @...: printf-style message to output
 660  *
 661  * Output a fixme message belonging to the given object in the given category.
 662  */
 663 /**
 664  * GST_CAT_TRACE_OBJECT:
 665  * @cat: category to use
 666  * @obj: the #GObject the message belongs to
 667  * @...: printf-style message to output
 668  *
 669  * Output a tracing message belonging to the given object in the given
 670  * category.
 671  */
 672 /**
 673  * GST_CAT_MEMDUMP_OBJECT:
 674  * @cat: category to use
 675  * @obj: the #GObject the message belongs to
 676  * @msg: message string to log with the data
 677  * @data: pointer to the data to output
 678  * @length: length of the data to output
 679  *
 680  * Output a hexdump of @data relating to the given object in the given
 681  * category.
 682  */
 683
 684
 685 /**
 686  * GST_CAT_ERROR:
 687  * @cat: category to use
 688  * @...: printf-style message to output
 689  *
 690  * Output an error message in the given category.
 691  */
 692 /**
 693  * GST_CAT_WARNING:
 694  * @cat: category to use
 695  * @...: printf-style message to output
 696  *
 697  * Output an warning message in the given category.
 698  */
 699 /**
 700  * GST_CAT_INFO:
 701  * @cat: category to use
 702  * @...: printf-style message to output
 703  *
 704  * Output an informational message in the given category.
 705  */
 706 /**
 707  * GST_CAT_DEBUG:
 708  * @cat: category to use
 709  * @...: printf-style message to output
 710  *
 711  * Output an debugging message in the given category.
 712  */
 713 /**
 714  * GST_CAT_LOG:
 715  * @cat: category to use
 716  * @...: printf-style message to output
 717  *
 718  * Output an logging message in the given category.
 719  */
 720 /**
 721  * GST_CAT_FIXME:
 722  * @cat: category to use
 723  * @...: printf-style message to output
 724  *
 725  * Output an fixme message in the given category.
 726  */
 727 /**
 728  * GST_CAT_TRACE:
 729  * @cat: category to use
 730  * @...: printf-style message to output
 731  *
 732  * Output a tracing message in the given category.
 733  */
 734 /**
 735  * GST_CAT_MEMDUMP:
 736  * @cat: category to use
 737  * @msg: message string to log with the data
 738  * @data: pointer to the data to output
 739  * @length: length of the data to output
 740  *
 741  * Output a hexdump of @data in the given category.
 742  */
 743
 744
 745 /**
 746  * GST_ERROR_OBJECT:
 747  * @obj: the #GObject the message belongs to
 748  * @...: printf-style message to output
 749  *
 750  * Output an error message belonging to the given object in the default category.
 751  */
 752 /**
 753  * GST_WARNING_OBJECT:
 754  * @obj: the #GObject the message belongs to
 755  * @...: printf-style message to output
 756  *
 757  * Output a warning message belonging to the given object in the default category.
 758  */
 759 /**
 760  * GST_INFO_OBJECT:
 761  * @obj: the #GObject the message belongs to
 762  * @...: printf-style message to output
 763  *
 764  * Output an informational message belonging to the given object in the default
 765  * category.
 766  */
 767 /**
 768  * GST_DEBUG_OBJECT:
 769  * @obj: the #GObject the message belongs to
 770  * @...: printf-style message to output
 771  *
 772  * Output a debugging message belonging to the given object in the default
 773  * category.
 774  */
 775 /**
 776  * GST_LOG_OBJECT:
 777  * @obj: the #GObject the message belongs to
 778  * @...: printf-style message to output
 779  *
 780  * Output a logging message belonging to the given object in the default category.
 781  */
 782 /**
 783  * GST_FIXME_OBJECT:
 784  * @obj: the #GObject the message belongs to
 785  * @...: printf-style message to output
 786  *
 787  * Output a fixme message belonging to the given object in the default category.
 788  */
 789 /**
 790  * GST_TRACE_OBJECT:
 791  * @obj: the #GObject the message belongs to
 792  * @...: printf-style message to output
 793  *
 794  * Output a tracing message belonging to the given object in the default category.
 795  */
 796 /**
 797  * GST_MEMDUMP_OBJECT:
 798  * @obj: the #GObject the message belongs to
 799  * @msg: message string to log with the data
 800  * @data: pointer to the data to output
 801  * @length: length of the data to output
 802  *
 803  * Output a logging message belonging to the given object in the default category.
 804  */
 805
 806
 807 /**
 808  * GST_ERROR:
 809  * @...: printf-style message to output
 810  *
 811  * Output an error message in the default category.
 812  */
 813 /**
 814  * GST_WARNING:
 815  * @...: printf-style message to output
 816  *
 817  * Output a warning message in the default category.
 818  */
 819 /**
 820  * GST_INFO:
 821  * @...: printf-style message to output
 822  *
 823  * Output an informational message in the default category.
 824  */
 825 /**
 826  * GST_DEBUG:
 827  * @...: printf-style message to output
 828  *
 829  * Output a debugging message in the default category.
 830  */
 831 /**
 832  * GST_LOG:
 833  * @...: printf-style message to output
 834  *
 835  * Output a logging message in the default category.
 836  */
 837 /**
 838  * GST_FIXME:
 839  * @...: printf-style message to output
 840  *
 841  * Output a fixme message in the default category.
 842  */
 843 /**
 844  * GST_TRACE:
 845  * @...: printf-style message to output
 846  *
 847  * Output a tracing message in the default category.
 848  */
 849 /**
 850  * GST_MEMDUMP:
 851  * @msg: message string to log with the data
 852  * @data: pointer to the data to output
 853  * @length: length of the data to output
 854  *
 855  * Output a hexdump of @data.
 856  */
 857
 858 #ifdef G_HAVE_ISO_VARARGS
 859
 860 #define GST_CAT_ERROR_OBJECT(cat,obj,...)       GST_CAT_LEVEL_LOG (cat, GST_LEVEL_ERROR,   obj,  __VA_ARGS__)
 861 #define GST_CAT_WARNING_OBJECT(cat,obj,...)     GST_CAT_LEVEL_LOG (cat, GST_LEVEL_WARNING, obj,  __VA_ARGS__)
 862 #define GST_CAT_INFO_OBJECT(cat,obj,...)        GST_CAT_LEVEL_LOG (cat, GST_LEVEL_INFO,    obj,  __VA_ARGS__)
 863 #define GST_CAT_DEBUG_OBJECT(cat,obj,...)       GST_CAT_LEVEL_LOG (cat, GST_LEVEL_DEBUG,   obj,  __VA_ARGS__)
 864 #define GST_CAT_LOG_OBJECT(cat,obj,...)         GST_CAT_LEVEL_LOG (cat, GST_LEVEL_LOG,     obj,  __VA_ARGS__)
 865 #define GST_CAT_FIXME_OBJECT(cat,obj,...)       GST_CAT_LEVEL_LOG (cat, GST_LEVEL_FIXME,   obj,  __VA_ARGS__)
 866 #define GST_CAT_TRACE_OBJECT(cat,obj,...)       GST_CAT_LEVEL_LOG (cat, GST_LEVEL_TRACE,   obj,  __VA_ARGS__)
 867
 868 #define GST_CAT_ERROR(cat,...)                  GST_CAT_LEVEL_LOG (cat, GST_LEVEL_ERROR,   NULL, __VA_ARGS__)
 869 #define GST_CAT_WARNING(cat,...)                GST_CAT_LEVEL_LOG (cat, GST_LEVEL_WARNING, NULL, __VA_ARGS__)
 870 #define GST_CAT_INFO(cat,...)                   GST_CAT_LEVEL_LOG (cat, GST_LEVEL_INFO,    NULL, __VA_ARGS__)
 871 #define GST_CAT_DEBUG(cat,...)                  GST_CAT_LEVEL_LOG (cat, GST_LEVEL_DEBUG,   NULL, __VA_ARGS__)
 872 #define GST_CAT_LOG(cat,...)                    GST_CAT_LEVEL_LOG (cat, GST_LEVEL_LOG,     NULL, __VA_ARGS__)
 873 #define GST_CAT_FIXME(cat,...)                  GST_CAT_LEVEL_LOG (cat, GST_LEVEL_FIXME,   NULL, __VA_ARGS__)
 874 #define GST_CAT_TRACE(cat,...)          GST_CAT_LEVEL_LOG (cat, GST_LEVEL_TRACE,   NULL, __VA_ARGS__)
 875
 876 #define GST_ERROR_OBJECT(obj,...)       GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_ERROR,   obj,  __VA_ARGS__)
 877 #define GST_WARNING_OBJECT(obj,...)     GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_WARNING, obj,  __VA_ARGS__)
 878 #define GST_INFO_OBJECT(obj,...)        GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_INFO,    obj,  __VA_ARGS__)
 879 #define GST_DEBUG_OBJECT(obj,...)       GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_DEBUG,   obj,  __VA_ARGS__)
 880 #define GST_LOG_OBJECT(obj,...)         GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_LOG,     obj,  __VA_ARGS__)
 881 #define GST_FIXME_OBJECT(obj,...)       GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_FIXME,   obj,  __VA_ARGS__)
 882 #define GST_TRACE_OBJECT(obj,...)       GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_TRACE,   obj,  __VA_ARGS__)
 883
 884 #define GST_ERROR(...)                  GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_ERROR,   NULL, __VA_ARGS__)
 885 #define GST_WARNING(...)                GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_WARNING, NULL, __VA_ARGS__)
 886 #define GST_INFO(...)                   GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_INFO,    NULL, __VA_ARGS__)
 887 #define GST_DEBUG(...)                  GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_DEBUG,   NULL, __VA_ARGS__)
 888 #define GST_LOG(...)                    GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_LOG,     NULL, __VA_ARGS__)
 889 #define GST_FIXME(...)                  GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_FIXME,   NULL, __VA_ARGS__)
 890 #define GST_TRACE(...)          GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_TRACE,   NULL, __VA_ARGS__)
 891
 892 #else
 893 #ifdef G_HAVE_GNUC_VARARGS
 894
 895 #define GST_CAT_ERROR_OBJECT(cat,obj,args...)   GST_CAT_LEVEL_LOG (cat, GST_LEVEL_ERROR,   obj,  ##args )
 896 #define GST_CAT_WARNING_OBJECT(cat,obj,args...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_WARNING, obj,  ##args )
 897 #define GST_CAT_INFO_OBJECT(cat,obj,args...)    GST_CAT_LEVEL_LOG (cat, GST_LEVEL_INFO,    obj,  ##args )
 898 #define GST_CAT_DEBUG_OBJECT(cat,obj,args...)   GST_CAT_LEVEL_LOG (cat, GST_LEVEL_DEBUG,   obj,  ##args )
 899 #define GST_CAT_LOG_OBJECT(cat,obj,args...)     GST_CAT_LEVEL_LOG (cat, GST_LEVEL_LOG,     obj,  ##args )
 900 #define GST_CAT_FIXME_OBJECT(cat,obj,args...)   GST_CAT_LEVEL_LOG (cat, GST_LEVEL_FIXME,   obj,  ##args )
 901 #define GST_CAT_TRACE_OBJECT(cat,obj,args...)   GST_CAT_LEVEL_LOG (cat, GST_LEVEL_TRACE,   obj,  ##args )
 902
 903 #define GST_CAT_ERROR(cat,args...)              GST_CAT_LEVEL_LOG (cat, GST_LEVEL_ERROR,   NULL, ##args )
 904 #define GST_CAT_WARNING(cat,args...)            GST_CAT_LEVEL_LOG (cat, GST_LEVEL_WARNING, NULL, ##args )
 905 #define GST_CAT_INFO(cat,args...)               GST_CAT_LEVEL_LOG (cat, GST_LEVEL_INFO,    NULL, ##args )
 906 #define GST_CAT_DEBUG(cat,args...)              GST_CAT_LEVEL_LOG (cat, GST_LEVEL_DEBUG,   NULL, ##args )
 907 #define GST_CAT_LOG(cat,args...)                GST_CAT_LEVEL_LOG (cat, GST_LEVEL_LOG,     NULL, ##args )
 908 #define GST_CAT_FIXME(cat,args...)              GST_CAT_LEVEL_LOG (cat, GST_LEVEL_FIXME,   NULL, ##args )
 909 #define GST_CAT_TRACE(cat,args...)              GST_CAT_LEVEL_LOG (cat, GST_LEVEL_TRACE,   NULL, ##args )
 910
 911 #define GST_ERROR_OBJECT(obj,args...)   GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_ERROR,   obj,  ##args )
 912 #define GST_WARNING_OBJECT(obj,args...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_WARNING, obj,  ##args )
 913 #define GST_INFO_OBJECT(obj,args...)    GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_INFO,    obj,  ##args )
 914 #define GST_DEBUG_OBJECT(obj,args...)   GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_DEBUG,   obj,  ##args )
 915 #define GST_LOG_OBJECT(obj,args...)     GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_LOG,     obj,  ##args )
 916 #define GST_FIXME_OBJECT(obj,args...)   GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_FIXME,   obj,  ##args )
 917 #define GST_TRACE_OBJECT(obj,args...)   GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_TRACE,   obj,  ##args )
 918
 919 #define GST_ERROR(args...)              GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_ERROR,   NULL, ##args )
 920 #define GST_WARNING(args...)            GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_WARNING, NULL, ##args )
 921 #define GST_INFO(args...)               GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_INFO,    NULL, ##args )
 922 #define GST_DEBUG(args...)              GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_DEBUG,   NULL, ##args )
 923 #define GST_LOG(args...)                GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_LOG,     NULL, ##args )
 924 #define GST_FIXME(args...)              GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_FIXME,   NULL, ##args )
 925 #define GST_TRACE(args...)              GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_TRACE,   NULL, ##args )
 926
 927 #else
 928 /* no variadic macros, use inline */
 929 static inline void
 930 GST_CAT_ERROR_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
 931     ...)
 932 {
 933   va_list varargs;
 934
 935   va_start (varargs, format);
 936   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_ERROR, obj, format, varargs);
 937   va_end (varargs);
 938 }
 939
 940 static inline void
 941 GST_CAT_WARNING_OBJECT (GstDebugCategory * cat, gpointer obj,
 942     const char *format, ...)
 943 {
 944   va_list varargs;
 945
 946   va_start (varargs, format);
 947   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_WARNING, obj, format, varargs);
 948   va_end (varargs);
 949 }
 950
 951 static inline void
 952 GST_CAT_INFO_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
 953     ...)
 954 {
 955   va_list varargs;
 956
 957   va_start (varargs, format);
 958   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_INFO, obj, format, varargs);
 959   va_end (varargs);
 960 }
 961
 962 static inline void
 963 GST_CAT_DEBUG_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
 964     ...)
 965 {
 966   va_list varargs;
 967
 968   va_start (varargs, format);
 969   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_DEBUG, obj, format, varargs);
 970   va_end (varargs);
 971 }
 972
 973 static inline void
 974 GST_CAT_LOG_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
 975     ...)
 976 {
 977   va_list varargs;
 978
 979   va_start (varargs, format);
 980   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_LOG, obj, format, varargs);
 981   va_end (varargs);
 982 }
 983
 984 static inline void
 985 GST_CAT_FIXME_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
 986     ...)
 987 {
 988   va_list varargs;
 989
 990   va_start (varargs, format);
 991   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_FIXME, obj, format, varargs);
 992   va_end (varargs);
 993 }
 994
 995 static inline void
 996 GST_CAT_TRACE_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
 997     ...)
 998 {
 999   va_list varargs;
1000
1001   va_start (varargs, format);
1002   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_TRACE, obj, format, varargs);
1003   va_end (varargs);
1004 }
1005
1006 static inline void
1007 GST_CAT_ERROR (GstDebugCategory * cat, const char *format, ...)
1008 {
1009   va_list varargs;
1010
1011   va_start (varargs, format);
1012   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_ERROR, NULL, format, varargs);
1013   va_end (varargs);
1014 }
1015
1016 static inline void
1017 GST_CAT_WARNING (GstDebugCategory * cat, const char *format, ...)
1018 {
1019   va_list varargs;
1020
1021   va_start (varargs, format);
1022   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_WARNING, NULL, format, varargs);
1023   va_end (varargs);
1024 }
1025
1026 static inline void
1027 GST_CAT_INFO (GstDebugCategory * cat, const char *format, ...)
1028 {
1029   va_list varargs;
1030
1031   va_start (varargs, format);
1032   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_INFO, NULL, format, varargs);
1033   va_end (varargs);
1034 }
1035
1036 static inline void
1037 GST_CAT_DEBUG (GstDebugCategory * cat, const char *format, ...)
1038 {
1039   va_list varargs;
1040
1041   va_start (varargs, format);
1042   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_DEBUG, NULL, format, varargs);
1043   va_end (varargs);
1044 }
1045
1046 static inline void
1047 GST_CAT_LOG (GstDebugCategory * cat, const char *format, ...)
1048 {
1049   va_list varargs;
1050
1051   va_start (varargs, format);
1052   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_LOG, NULL, format, varargs);
1053   va_end (varargs);
1054 }
1055
1056 static inline void
1057 GST_CAT_FIXME (GstDebugCategory * cat, const char *format, ...)
1058 {
1059   va_list varargs;
1060
1061   va_start (varargs, format);
1062   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_FIXME, NULL, format, varargs);
1063   va_end (varargs);
1064 }
1065
1066 static inline void
1067 GST_CAT_TRACE (GstDebugCategory * cat, const char *format, ...)
1068 {
1069   va_list varargs;
1070
1071   va_start (varargs, format);
1072   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_TRACE, NULL, format, varargs);
1073   va_end (varargs);
1074 }
1075
1076 static inline void
1077 GST_ERROR_OBJECT (gpointer obj, const char *format, ...)
1078 {
1079   va_list varargs;
1080
1081   va_start (varargs, format);
1082   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_ERROR, obj, format,
1083       varargs);
1084   va_end (varargs);
1085 }
1086
1087 static inline void
1088 GST_WARNING_OBJECT (gpointer obj, const char *format, ...)
1089 {
1090   va_list varargs;
1091
1092   va_start (varargs, format);
1093   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_WARNING, obj, format,
1094       varargs);
1095   va_end (varargs);
1096 }
1097
1098 static inline void
1099 GST_INFO_OBJECT (gpointer obj, const char *format, ...)
1100 {
1101   va_list varargs;
1102
1103   va_start (varargs, format);
1104   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_INFO, obj, format,
1105       varargs);
1106   va_end (varargs);
1107 }
1108
1109 static inline void
1110 GST_DEBUG_OBJECT (gpointer obj, const char *format, ...)
1111 {
1112   va_list varargs;
1113
1114   va_start (varargs, format);
1115   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_DEBUG, obj, format,
1116       varargs);
1117   va_end (varargs);
1118 }
1119
1120 static inline void
1121 GST_LOG_OBJECT (gpointer obj, const char *format, ...)
1122 {
1123   va_list varargs;
1124
1125   va_start (varargs, format);
1126   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_LOG, obj, format,
1127       varargs);
1128   va_end (varargs);
1129 }
1130
1131 static inline void
1132 GST_FIXME_OBJECT (gpointer obj, const char *format, ...)
1133 {
1134   va_list varargs;
1135
1136   va_start (varargs, format);
1137   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_FIXME, obj, format,
1138       varargs);
1139   va_end (varargs);
1140 }
1141
1142 static inline void
1143 GST_TRACE_OBJECT (gpointer obj, const char *format, ...)
1144 {
1145   va_list varargs;
1146
1147   va_start (varargs, format);
1148   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_TRACE, obj, format,
1149       varargs);
1150   va_end (varargs);
1151 }
1152
1153 static inline void
1154 GST_ERROR (const char *format, ...)
1155 {
1156   va_list varargs;
1157
1158   va_start (varargs, format);
1159   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_ERROR, NULL, format,
1160       varargs);
1161   va_end (varargs);
1162 }
1163
1164 static inline void
1165 GST_WARNING (const char *format, ...)
1166 {
1167   va_list varargs;
1168
1169   va_start (varargs, format);
1170   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_WARNING, NULL, format,
1171       varargs);
1172   va_end (varargs);
1173 }
1174
1175 static inline void
1176 GST_INFO (const char *format, ...)
1177 {
1178   va_list varargs;
1179
1180   va_start (varargs, format);
1181   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_INFO, NULL, format,
1182       varargs);
1183   va_end (varargs);
1184 }
1185
1186 static inline void
1187 GST_DEBUG (const char *format, ...)
1188 {
1189   va_list varargs;
1190
1191   va_start (varargs, format);
1192   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_DEBUG, NULL, format,
1193       varargs);
1194   va_end (varargs);
1195 }
1196
1197 static inline void
1198 GST_LOG (const char *format, ...)
1199 {
1200   va_list varargs;
1201
1202   va_start (varargs, format);
1203   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_LOG, NULL,
1204       format, varargs);
1205   va_end (varargs);
1206 }
1207
1208 static inline void
1209 GST_FIXME (const char *format, ...)
1210 {
1211   va_list varargs;
1212
1213   va_start (varargs, format);
1214   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_FIXME, NULL, format,
1215       varargs);
1216   va_end (varargs);
1217 }
1218
1219 static inline void
1220 GST_TRACE (const char *format, ...)
1221 {
1222   va_list varargs;
1223
1224   va_start (varargs, format);
1225   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_TRACE, NULL, format,
1226       varargs);
1227   va_end (varargs);
1228 }
1229 #endif
1230 #endif
1231
1232
1233 /********** function pointer stuff **********/
1234
1235 /**
1236  * GST_DEBUG_REGISTER_FUNCPTR:
1237  * @ptr: pointer to the function to register
1238  *
1239  * Register a pointer to a function with its name, so it can later be used by
1240  * GST_DEBUG_FUNCPTR_NAME().
1241  *
1242  * Use this variant of #GST_DEBUG_FUNCPTR if you do not need to use @ptr.
1243  */
1244 #define GST_DEBUG_REGISTER_FUNCPTR(ptr) \
1245   _gst_debug_register_funcptr((GstDebugFuncPtr)(ptr), #ptr)
1246 /**
1247  * GST_DEBUG_FUNCPTR:
1248  * @ptr: pointer to the function to register
1249  *
1250  * Register a pointer to a function with its name, so it can later be used by
1251  * GST_DEBUG_FUNCPTR_NAME().
1252  *
1253  * Returns: the value passed to @ptr.
1254  */
1255 #define GST_DEBUG_FUNCPTR(ptr) \
1256   (_gst_debug_register_funcptr((GstDebugFuncPtr)(ptr), #ptr) , ptr)
1257
1258 /**
1259  * GST_DEBUG_FUNCPTR_NAME:
1260  * @ptr: address of the function of which to look up the name
1261  *
1262  * Retrieves the name of the function, if it was previously registered with
1263  * GST_DEBUG_FUNCPTR(). If not, it returns a description of the pointer.
1264  *
1265  * This macro returns a constant string which must not be modified or
1266  * freed by the caller.
1267  */
1268 #define GST_DEBUG_FUNCPTR_NAME(ptr) \
1269   _gst_debug_nameof_funcptr((GstDebugFuncPtr)ptr)
1270
1271
1272 #else /* GST_DISABLE_GST_DEBUG */
1273
1274
1275 #ifndef GST_INFO_C
1276
1277 #if defined(__GNUC__) && __GNUC__ >= 3
1278 #  pragma GCC poison gst_debug_log
1279 #  pragma GCC poison gst_debug_log_valist
1280 #  pragma GCC poison _gst_debug_category_new
1281 #endif
1282
1283 #define _gst_debug_min GST_LEVEL_NONE
1284
1285 #define gst_debug_set_default_threshold(level)          G_STMT_START{ }G_STMT_END
1286 #define gst_debug_get_default_threshold()               (GST_LEVEL_NONE)
1287
1288 #define gst_debug_level_get_name(level)                         ("NONE")
1289 #define gst_debug_message_get(message)                          ("")
1290 #define gst_debug_add_log_function(func,data,notify)    G_STMT_START{ }G_STMT_END
1291 #define gst_debug_set_active(active)                    G_STMT_START{ }G_STMT_END
1292 #define gst_debug_is_active()                           (FALSE)
1293 #define gst_debug_set_colored(colored)                  G_STMT_START{ }G_STMT_END
1294 #define gst_debug_set_color_mode(mode)                  G_STMT_START{ }G_STMT_END
1295 #define gst_debug_set_color_mode_from_string(mode)      G_STMT_START{ }G_STMT_END
1296 #define gst_debug_is_colored()                          (FALSE)
1297 #define gst_debug_get_color_mode()                      (GST_DEBUG_COLOR_MODE_OFF)
1298 #define gst_debug_set_default_threshold(level)          G_STMT_START{ }G_STMT_END
1299 #define gst_debug_get_default_threshold()               (GST_LEVEL_NONE)
1300 #define gst_debug_set_threshold_for_name(name,level)    G_STMT_START{ }G_STMT_END
1301 #define gst_debug_unset_threshold_for_name(name)        G_STMT_START{ }G_STMT_END
1302
1303 /* we are using dummy function prototypes here to eat ';' as these macros are
1304  * used outside of functions */
1305 #define GST_DEBUG_CATEGORY(var)                         void _gst_debug_dummy_##var (void)
1306 #define GST_DEBUG_CATEGORY_EXTERN(var)                  void _gst_debug_dummy_extern_##var (void)
1307 #define GST_DEBUG_CATEGORY_STATIC(var)                  void _gst_debug_dummy_static_##var (void)
1308
1309 #define GST_DEBUG_CATEGORY_INIT(var,name,color,desc)    G_STMT_START{ }G_STMT_END
1310 #define GST_DEBUG_CATEGORY_GET(var,name)                G_STMT_START{ }G_STMT_END
1311 #define gst_debug_category_free(category)               G_STMT_START{ }G_STMT_END
1312 #define gst_debug_category_set_threshold(category,level) G_STMT_START{ }G_STMT_END
1313 #define gst_debug_category_reset_threshold(category)    G_STMT_START{ }G_STMT_END
1314 #define gst_debug_category_get_threshold(category)      (GST_LEVEL_NONE)
1315 #define gst_debug_category_get_name(cat)                ("")
1316 #define gst_debug_category_get_color(cat)               (0)
1317 #define gst_debug_category_get_description(cat)         ("")
1318 #define gst_debug_get_all_categories()                  (NULL)
1319 #define gst_debug_construct_term_color(colorinfo)       (g_strdup ("00"))
1320 #define gst_debug_construct_win_color(colorinfo)        (0)
1321
1322 #endif /* !GST_INFO_C */
1323
1324 #ifdef G_HAVE_ISO_VARARGS
1325
1326 #define GST_CAT_LEVEL_LOG(cat,level,...)                G_STMT_START{ }G_STMT_END
1327
1328 #define GST_CAT_ERROR_OBJECT(...)                       G_STMT_START{ }G_STMT_END
1329 #define GST_CAT_WARNING_OBJECT(...)                     G_STMT_START{ }G_STMT_END
1330 #define GST_CAT_INFO_OBJECT(...)                        G_STMT_START{ }G_STMT_END
1331 #define GST_CAT_DEBUG_OBJECT(...)                       G_STMT_START{ }G_STMT_END
1332 #define GST_CAT_LOG_OBJECT(...)                         G_STMT_START{ }G_STMT_END
1333 #define GST_CAT_FIXME_OBJECT(...)                       G_STMT_START{ }G_STMT_END
1334 #define GST_CAT_TRACE_OBJECT(...)                       G_STMT_START{ }G_STMT_END
1335
1336 #define GST_CAT_ERROR(...)                              G_STMT_START{ }G_STMT_END
1337 #define GST_CAT_WARNING(...)                            G_STMT_START{ }G_STMT_END
1338 #define GST_CAT_INFO(...)                               G_STMT_START{ }G_STMT_END
1339 #define GST_CAT_DEBUG(...)                              G_STMT_START{ }G_STMT_END
1340 #define GST_CAT_LOG(...)                                G_STMT_START{ }G_STMT_END
1341 #define GST_CAT_FIXME(...)                              G_STMT_START{ }G_STMT_END
1342 #define GST_CAT_TRACE(...)                              G_STMT_START{ }G_STMT_END
1343
1344 #define GST_ERROR_OBJECT(...)                           G_STMT_START{ }G_STMT_END
1345 #define GST_WARNING_OBJECT(...)                         G_STMT_START{ }G_STMT_END
1346 #define GST_INFO_OBJECT(...)                            G_STMT_START{ }G_STMT_END
1347 #define GST_DEBUG_OBJECT(...)                           G_STMT_START{ }G_STMT_END
1348 #define GST_LOG_OBJECT(...)                             G_STMT_START{ }G_STMT_END
1349 #define GST_FIXME_OBJECT(...)                           G_STMT_START{ }G_STMT_END
1350 #define GST_TRACE_OBJECT(...)                           G_STMT_START{ }G_STMT_END
1351
1352 #define GST_ERROR(...)                                  G_STMT_START{ }G_STMT_END
1353 #define GST_WARNING(...)                                G_STMT_START{ }G_STMT_END
1354 #define GST_INFO(...)                                   G_STMT_START{ }G_STMT_END
1355 #define GST_DEBUG(...)                                  G_STMT_START{ }G_STMT_END
1356 #define GST_LOG(...)                                    G_STMT_START{ }G_STMT_END
1357 #define GST_FIXME(...)                                  G_STMT_START{ }G_STMT_END
1358 #define GST_TRACE(...)                                  G_STMT_START{ }G_STMT_END
1359
1360 #else /* !G_HAVE_ISO_VARARGS */
1361 #ifdef G_HAVE_GNUC_VARARGS
1362
1363 #define GST_CAT_LEVEL_LOG(cat,level,args...)            G_STMT_START{ }G_STMT_END
1364
1365 #define GST_CAT_ERROR_OBJECT(args...)                   G_STMT_START{ }G_STMT_END
1366 #define GST_CAT_WARNING_OBJECT(args...)                 G_STMT_START{ }G_STMT_END
1367 #define GST_CAT_INFO_OBJECT(args...)                    G_STMT_START{ }G_STMT_END
1368 #define GST_CAT_DEBUG_OBJECT(args...)                   G_STMT_START{ }G_STMT_END
1369 #define GST_CAT_LOG_OBJECT(args...)                     G_STMT_START{ }G_STMT_END
1370 #define GST_CAT_FIXME_OBJECT(args...)                   G_STMT_START{ }G_STMT_END
1371 #define GST_CAT_TRACE_OBJECT(args...)                   G_STMT_START{ }G_STMT_END
1372
1373 #define GST_CAT_ERROR(args...)                          G_STMT_START{ }G_STMT_END
1374 #define GST_CAT_WARNING(args...)                        G_STMT_START{ }G_STMT_END
1375 #define GST_CAT_INFO(args...)                           G_STMT_START{ }G_STMT_END
1376 #define GST_CAT_DEBUG(args...)                          G_STMT_START{ }G_STMT_END
1377 #define GST_CAT_LOG(args...)                            G_STMT_START{ }G_STMT_END
1378 #define GST_CAT_FIXME(args...)                          G_STMT_START{ }G_STMT_END
1379 #define GST_CAT_TRACE(args...)                          G_STMT_START{ }G_STMT_END
1380
1381 #define GST_ERROR_OBJECT(args...)                       G_STMT_START{ }G_STMT_END
1382 #define GST_WARNING_OBJECT(args...)                     G_STMT_START{ }G_STMT_END
1383 #define GST_INFO_OBJECT(args...)                        G_STMT_START{ }G_STMT_END
1384 #define GST_DEBUG_OBJECT(args...)                       G_STMT_START{ }G_STMT_END
1385 #define GST_LOG_OBJECT(args...)                         G_STMT_START{ }G_STMT_END
1386 #define GST_FIXME_OBJECT(args...)                       G_STMT_START{ }G_STMT_END
1387 #define GST_TRACE_OBJECT(args...)                       G_STMT_START{ }G_STMT_END
1388
1389 #define GST_ERROR(args...)                              G_STMT_START{ }G_STMT_END
1390 #define GST_WARNING(args...)                            G_STMT_START{ }G_STMT_END
1391 #define GST_INFO(args...)                               G_STMT_START{ }G_STMT_END
1392 #define GST_DEBUG(args...)                              G_STMT_START{ }G_STMT_END
1393 #define GST_LOG(args...)                                G_STMT_START{ }G_STMT_END
1394 #define GST_FIXME(args...)                              G_STMT_START{ }G_STMT_END
1395 #define GST_TRACE(args...)                              G_STMT_START{ }G_STMT_END
1396
1397 #else /* !G_HAVE_GNUC_VARARGS */
1398 static inline void
1399 GST_CAT_LEVEL_LOG_valist (GstDebugCategory * cat,
1400     GstDebugLevel level, gpointer object, const char *format, va_list varargs)
1401 {
1402 }
1403
1404 static inline void
1405 GST_CAT_ERROR_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
1406     ...)
1407 {
1408 }
1409
1410 static inline void
1411 GST_CAT_WARNING_OBJECT (GstDebugCategory * cat, gpointer obj,
1412     const char *format, ...)
1413 {
1414 }
1415
1416 static inline void
1417 GST_CAT_INFO_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
1418     ...)
1419 {
1420 }
1421
1422 static inline void
1423 GST_CAT_DEBUG_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
1424     ...)
1425 {
1426 }
1427
1428 static inline void
1429 GST_CAT_LOG_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
1430     ...)
1431 {
1432 }
1433
1434 static inline void
1435 GST_CAT_FIXME_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
1436     ...)
1437 {
1438 }
1439
1440 static inline void
1441 GST_CAT_TRACE_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
1442     ...)
1443 {
1444 }
1445
1446 static inline void
1447 GST_CAT_ERROR (GstDebugCategory * cat, const char *format, ...)
1448 {
1449 }
1450
1451 static inline void
1452 GST_CAT_WARNING (GstDebugCategory * cat, const char *format, ...)
1453 {
1454 }
1455
1456 static inline void
1457 GST_CAT_INFO (GstDebugCategory * cat, const char *format, ...)
1458 {
1459 }
1460
1461 static inline void
1462 GST_CAT_DEBUG (GstDebugCategory * cat, const char *format, ...)
1463 {
1464 }
1465
1466 static inline void
1467 GST_CAT_LOG (GstDebugCategory * cat, const char *format, ...)
1468 {
1469 }
1470
1471 static inline void
1472 GST_CAT_FIXME (GstDebugCategory * cat, const char *format, ...)
1473 {
1474 }
1475
1476 static inline void
1477 GST_CAT_TRACE (GstDebugCategory * cat, const char *format, ...)
1478 {
1479 }
1480
1481 static inline void
1482 GST_ERROR_OBJECT (gpointer obj, const char *format, ...)
1483 {
1484 }
1485
1486 static inline void
1487 GST_WARNING_OBJECT (gpointer obj, const char *format, ...)
1488 {
1489 }
1490
1491 static inline void
1492 GST_INFO_OBJECT (gpointer obj, const char *format, ...)
1493 {
1494 }
1495
1496 static inline void
1497 GST_DEBUG_OBJECT (gpointer obj, const char *format, ...)
1498 {
1499 }
1500
1501 static inline void
1502 GST_LOG_OBJECT (gpointer obj, const char *format, ...)
1503 {
1504 }
1505
1506 static inline void
1507 GST_FIXME_OBJECT (gpointer obj, const char *format, ...)
1508 {
1509 }
1510
1511 static inline void
1512 GST_TRACE_OBJECT (gpointer obj, const char *format, ...)
1513 {
1514 }
1515
1516 static inline void
1517 GST_ERROR (const char *format, ...)
1518 {
1519 }
1520
1521 static inline void
1522 GST_WARNING (const char *format, ...)
1523 {
1524 }
1525
1526 static inline void
1527 GST_INFO (const char *format, ...)
1528 {
1529 }
1530
1531 static inline void
1532 GST_DEBUG (const char *format, ...)
1533 {
1534 }
1535
1536 static inline void
1537 GST_LOG (const char *format, ...)
1538 {
1539 }
1540
1541 static inline void
1542 GST_FIXME (const char *format, ...)
1543 {
1544 }
1545
1546 static inline void
1547 GST_TRACE (const char *format, ...)
1548 {
1549 }
1550
1551 #endif /* G_HAVE_GNUC_VARARGS */
1552 #endif /* G_HAVE_ISO_VARARGS */
1553
1554 #define GST_DEBUG_REGISTER_FUNCPTR(ptr) G_STMT_START{ }G_STMT_END
1555 #define GST_DEBUG_FUNCPTR(ptr) (ptr)
1556 #define GST_DEBUG_FUNCPTR_NAME(ptr) (g_strdup_printf ("%p", ptr))
1557
1558 #define GST_CAT_MEMDUMP_OBJECT(cat,obj,msg,data,length) G_STMT_START{ }G_STMT_END
1559 #define GST_CAT_MEMDUMP(cat,msg,data,length)            G_STMT_START{ }G_STMT_END
1560 #define GST_MEMDUMP_OBJECT(obj,msg,data,length)         G_STMT_START{ }G_STMT_END
1561 #define GST_MEMDUMP(msg,data,length)                    G_STMT_START{ }G_STMT_END
1562
1563 #endif /* GST_DISABLE_GST_DEBUG */
1564
1565
1566 void gst_debug_print_stack_trace (void);
1567
1568 G_END_DECLS
1569
1570 #endif /* __GSTINFO_H__ */