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 #define gst_debug_add_log_function(func,data,notify) \
 419 G_STMT_START{                                        \
 420   if (func == gst_debug_log_default) {               \
 421     gst_debug_add_log_function(NULL,data,notify);    \
 422   } else {                                           \
 423     gst_debug_add_log_function(func,data,notify);    \
 424   }                                                  \
 425 }G_STMT_END
 426
 427 #define gst_debug_remove_log_function(func)   \
 428     (func == gst_debug_log_default) ?         \
 429         gst_debug_remove_log_function(NULL) : \
 430         gst_debug_remove_log_function(func)
 431
 432 /**
 433  * GST_DEBUG_CATEGORY:
 434  * @cat: the category
 435  *
 436  * Defines a GstDebugCategory variable.
 437  * This macro expands to nothing if debugging is disabled.
 438  */
 439 #define GST_DEBUG_CATEGORY(cat) GstDebugCategory *cat = NULL
 440 /**
 441  * GST_DEBUG_CATEGORY_EXTERN:
 442  * @cat: the category
 443  *
 444  * Declares a GstDebugCategory variable as extern. Use in header files.
 445  * This macro expands to nothing if debugging is disabled.
 446  */
 447 #define GST_DEBUG_CATEGORY_EXTERN(cat) extern GstDebugCategory *cat
 448
 449 /**
 450  * GST_DEBUG_CATEGORY_STATIC:
 451  * @cat: the category
 452  *
 453  * Defines a static GstDebugCategory variable.
 454  * This macro expands to nothing if debugging is disabled.
 455  */
 456 #define GST_DEBUG_CATEGORY_STATIC(cat) static GstDebugCategory *cat = NULL
 457
 458 /**
 459  * GST_DEBUG_CATEGORY_INIT:
 460  * @cat: the category to initialize.
 461  * @name: the name of the category.
 462  * @color: the colors to use for a color representation or 0 for no color.
 463  * @description: optional description of the category.
 464  *
 465  * Initializes a new #GstDebugCategory with the given properties and set to
 466  * the default threshold.
 467  *
 468  * <note>
 469  * <para>
 470  * This macro expands to nothing if debugging is disabled.
 471  * </para>
 472  * <para>
 473  * When naming your category, please follow the following conventions to ensure
 474  * that the pattern matching for categories works as expected. It is not
 475  * earth-shattering if you don't follow these conventions, but it would be nice
 476  * for everyone.
 477  * </para>
 478  * <para>
 479  * If you define a category for a plugin or a feature of it, name the category
 480  * like the feature. So if you wanted to write a "filesrc" element, you would
 481  * name the category "filesrc". Use lowercase letters only.
 482  * If you define more than one category for the same element, append an
 483  * underscore and an identifier to your categories, like this: "filesrc_cache"
 484  * </para>
 485  * <para>
 486  * If you create a library or an application using debugging categories, use a
 487  * common prefix followed by an underscore for all your categories. GStreamer
 488  * uses the GST prefix so GStreamer categories look like "GST_STATES". Be sure
 489  * to include uppercase letters.
 490  * </para>
 491  * </note>
 492  */
 493 #define GST_DEBUG_CATEGORY_INIT(cat,name,color,description) G_STMT_START{\
 494   if (cat == NULL)                                                      \
 495     cat = _gst_debug_category_new (name,color,description);             \
 496 }G_STMT_END
 497
 498 /**
 499  * GST_DEBUG_CATEGORY_GET:
 500  * @cat: the category to initialize.
 501  * @name: log category name
 502  *
 503  * Looks up an existing #GstDebugCategory by its @name and sets @cat. If the
 504  * category is not found, but GST_CAT_DEFAULT is defined, that is assigned to
 505  * @cat. Otherwise @cat will be %NULL.
 506  *
 507  * |[<!-- language="C" -->
 508  * GST_DEBUG_CATEGORY_STATIC (gst_myplugin_debug);
 509  * #define GST_CAT_DEFAULT gst_myplugin_debug
 510  * GST_DEBUG_CATEGORY_STATIC (GST_CAT_PERFORMANCE);
 511  * ...
 512  * GST_DEBUG_CATEGORY_INIT (gst_myplugin_debug, "myplugin", 0, "nice element");
 513  * GST_DEBUG_CATEGORY_GET (GST_CAT_PERFORMANCE, "GST_PERFORMANCE");
 514  * ]|
 515  */
 516 #ifdef GST_CAT_DEFAULT
 517 #define GST_DEBUG_CATEGORY_GET(cat,name)  G_STMT_START{\
 518   cat = _gst_debug_get_category (name);                 \
 519   if (!cat) {                                           \
 520     cat = GST_CAT_DEFAULT;                              \
 521   }                                                     \
 522 }G_STMT_END
 523 #else
 524 #define GST_DEBUG_CATEGORY_GET(cat,name)  G_STMT_START{\
 525   cat = _gst_debug_get_category (name);                 \
 526 }G_STMT_END
 527 #endif
 528
 529 /**
 530  * GST_CAT_DEFAULT:
 531  *
 532  * Default gstreamer core debug log category. Please define your own.
 533  */
 534 GST_EXPORT GstDebugCategory *   GST_CAT_DEFAULT;
 535 /* this symbol may not be used */
 536 GST_EXPORT gboolean                     _gst_debug_enabled;
 537
 538 /* the min debug level, used for quickly discarding debug
 539  * messages that fall under the threshold. */
 540 GST_EXPORT GstDebugLevel            _gst_debug_min;
 541
 542 /**
 543  * GST_CAT_LEVEL_LOG:
 544  * @cat: category to use
 545  * @level: the severity of the message
 546  * @object: (allow-none): the #GObject the message belongs to or %NULL if none
 547  * @...: A printf-style message to output
 548  *
 549  * Outputs a debugging message. This is the most general macro for outputting
 550  * debugging messages. You will probably want to use one of the ones described
 551  * below.
 552  */
 553 #ifdef G_HAVE_ISO_VARARGS
 554 #define GST_CAT_LEVEL_LOG(cat,level,object,...) G_STMT_START{           \
 555   if (G_UNLIKELY (level <= GST_LEVEL_MAX && level <= _gst_debug_min)) {                                         \
 556     gst_debug_log ((cat), (level), __FILE__, GST_FUNCTION, __LINE__,    \
 557         (GObject *) (object), __VA_ARGS__);                             \
 558   }                                                                     \
 559 }G_STMT_END
 560 #else /* G_HAVE_GNUC_VARARGS */
 561 #ifdef G_HAVE_GNUC_VARARGS
 562 #define GST_CAT_LEVEL_LOG(cat,level,object,args...) G_STMT_START{       \
 563   if (G_UNLIKELY (level <= GST_LEVEL_MAX && level <= _gst_debug_min)) {                                         \
 564     gst_debug_log ((cat), (level), __FILE__, GST_FUNCTION, __LINE__,    \
 565         (GObject *) (object), ##args );                                 \
 566   }                                                                     \
 567 }G_STMT_END
 568 #else /* no variadic macros, use inline */
 569 static inline void
 570 GST_CAT_LEVEL_LOG_valist (GstDebugCategory * cat,
 571     GstDebugLevel level, gpointer object, const char *format, va_list varargs)
 572 {
 573   if (G_UNLIKELY (level <= GST_LEVEL_MAX && level <= _gst_debug_min)) {
 574     gst_debug_log_valist (cat, level, "", "", 0, (GObject *) object, format,
 575         varargs);
 576   }
 577 }
 578
 579 static inline void
 580 GST_CAT_LEVEL_LOG (GstDebugCategory * cat, GstDebugLevel level,
 581     gpointer object, const char *format, ...)
 582 {
 583   va_list varargs;
 584
 585   va_start (varargs, format);
 586   GST_CAT_LEVEL_LOG_valist (cat, level, object, format, varargs);
 587   va_end (varargs);
 588 }
 589 #endif
 590 #endif /* G_HAVE_ISO_VARARGS */
 591
 592 /* This one doesn't have varargs in the macro, so it's different than all the
 593  * other macros and hence in a separate block right here. Docs chunks are
 594  * with the other doc chunks below though. */
 595 #define __GST_CAT_MEMDUMP_LOG(cat,object,msg,data,length) G_STMT_START{       \
 596     if (G_UNLIKELY (GST_LEVEL_MEMDUMP <= GST_LEVEL_MAX &&                     \
 597                     GST_LEVEL_MEMDUMP <= _gst_debug_min)) {                   \
 598     _gst_debug_dump_mem ((cat), __FILE__, GST_FUNCTION, __LINE__,             \
 599         (GObject *) (object), (msg), (data), (length));                       \
 600   }                                                                           \
 601 }G_STMT_END
 602
 603 #define GST_CAT_MEMDUMP_OBJECT(cat,obj,msg,data,length)  \
 604     __GST_CAT_MEMDUMP_LOG(cat,obj,msg,data,length)
 605 #define GST_CAT_MEMDUMP(cat,msg,data,length)             \
 606     __GST_CAT_MEMDUMP_LOG(cat,NULL,msg,data,length)
 607 #define GST_MEMDUMP_OBJECT(obj,msg,data,length)          \
 608     __GST_CAT_MEMDUMP_LOG(GST_CAT_DEFAULT,obj,msg,data,length)
 609 #define GST_MEMDUMP(msg,data,length)                     \
 610     __GST_CAT_MEMDUMP_LOG(GST_CAT_DEFAULT,NULL,msg,data,length)
 611
 612 /**
 613  * GST_CAT_ERROR_OBJECT:
 614  * @cat: category to use
 615  * @obj: the #GObject the message belongs to
 616  * @...: printf-style message to output
 617  *
 618  * Output an error message belonging to the given object in the given category.
 619  */
 620 /**
 621  * GST_CAT_WARNING_OBJECT:
 622  * @cat: category to use
 623  * @obj: the #GObject the message belongs to
 624  * @...: printf-style message to output
 625  *
 626  * Output a warning message belonging to the given object in the given category.
 627  */
 628 /**
 629  * GST_CAT_INFO_OBJECT:
 630  * @cat: category to use
 631  * @obj: the #GObject the message belongs to
 632  * @...: printf-style message to output
 633  *
 634  * Output an informational message belonging to the given object in the given
 635  * category.
 636  */
 637 /**
 638  * GST_CAT_DEBUG_OBJECT:
 639  * @cat: category to use
 640  * @obj: the #GObject the message belongs to
 641  * @...: printf-style message to output
 642  *
 643  * Output an debugging message belonging to the given object in the given category.
 644  */
 645 /**
 646  * GST_CAT_LOG_OBJECT:
 647  * @cat: category to use
 648  * @obj: the #GObject the message belongs to
 649  * @...: printf-style message to output
 650  *
 651  * Output an logging message belonging to the given object in the given category.
 652  */
 653 /**
 654  * GST_CAT_FIXME_OBJECT:
 655  * @cat: category to use
 656  * @obj: the #GObject the message belongs to
 657  * @...: printf-style message to output
 658  *
 659  * Output a fixme message belonging to the given object in the given category.
 660  */
 661 /**
 662  * GST_CAT_TRACE_OBJECT:
 663  * @cat: category to use
 664  * @obj: the #GObject the message belongs to
 665  * @...: printf-style message to output
 666  *
 667  * Output a tracing message belonging to the given object in the given
 668  * category.
 669  */
 670 /**
 671  * GST_CAT_MEMDUMP_OBJECT:
 672  * @cat: category to use
 673  * @obj: the #GObject the message belongs to
 674  * @msg: message string to log with the data
 675  * @data: pointer to the data to output
 676  * @length: length of the data to output
 677  *
 678  * Output a hexdump of @data relating to the given object in the given
 679  * category.
 680  */
 681
 682
 683 /**
 684  * GST_CAT_ERROR:
 685  * @cat: category to use
 686  * @...: printf-style message to output
 687  *
 688  * Output an error message in the given category.
 689  */
 690 /**
 691  * GST_CAT_WARNING:
 692  * @cat: category to use
 693  * @...: printf-style message to output
 694  *
 695  * Output an warning message in the given category.
 696  */
 697 /**
 698  * GST_CAT_INFO:
 699  * @cat: category to use
 700  * @...: printf-style message to output
 701  *
 702  * Output an informational message in the given category.
 703  */
 704 /**
 705  * GST_CAT_DEBUG:
 706  * @cat: category to use
 707  * @...: printf-style message to output
 708  *
 709  * Output an debugging message in the given category.
 710  */
 711 /**
 712  * GST_CAT_LOG:
 713  * @cat: category to use
 714  * @...: printf-style message to output
 715  *
 716  * Output an logging message in the given category.
 717  */
 718 /**
 719  * GST_CAT_FIXME:
 720  * @cat: category to use
 721  * @...: printf-style message to output
 722  *
 723  * Output an fixme message in the given category.
 724  */
 725 /**
 726  * GST_CAT_TRACE:
 727  * @cat: category to use
 728  * @...: printf-style message to output
 729  *
 730  * Output a tracing message in the given category.
 731  */
 732 /**
 733  * GST_CAT_MEMDUMP:
 734  * @cat: category to use
 735  * @msg: message string to log with the data
 736  * @data: pointer to the data to output
 737  * @length: length of the data to output
 738  *
 739  * Output a hexdump of @data in the given category.
 740  */
 741
 742
 743 /**
 744  * GST_ERROR_OBJECT:
 745  * @obj: the #GObject the message belongs to
 746  * @...: printf-style message to output
 747  *
 748  * Output an error message belonging to the given object in the default category.
 749  */
 750 /**
 751  * GST_WARNING_OBJECT:
 752  * @obj: the #GObject the message belongs to
 753  * @...: printf-style message to output
 754  *
 755  * Output a warning message belonging to the given object in the default category.
 756  */
 757 /**
 758  * GST_INFO_OBJECT:
 759  * @obj: the #GObject the message belongs to
 760  * @...: printf-style message to output
 761  *
 762  * Output an informational message belonging to the given object in the default
 763  * category.
 764  */
 765 /**
 766  * GST_DEBUG_OBJECT:
 767  * @obj: the #GObject the message belongs to
 768  * @...: printf-style message to output
 769  *
 770  * Output a debugging message belonging to the given object in the default
 771  * category.
 772  */
 773 /**
 774  * GST_LOG_OBJECT:
 775  * @obj: the #GObject the message belongs to
 776  * @...: printf-style message to output
 777  *
 778  * Output a logging message belonging to the given object in the default category.
 779  */
 780 /**
 781  * GST_FIXME_OBJECT:
 782  * @obj: the #GObject the message belongs to
 783  * @...: printf-style message to output
 784  *
 785  * Output a fixme message belonging to the given object in the default category.
 786  */
 787 /**
 788  * GST_TRACE_OBJECT:
 789  * @obj: the #GObject the message belongs to
 790  * @...: printf-style message to output
 791  *
 792  * Output a tracing message belonging to the given object in the default category.
 793  */
 794 /**
 795  * GST_MEMDUMP_OBJECT:
 796  * @obj: the #GObject the message belongs to
 797  * @msg: message string to log with the data
 798  * @data: pointer to the data to output
 799  * @length: length of the data to output
 800  *
 801  * Output a logging message belonging to the given object in the default category.
 802  */
 803
 804
 805 /**
 806  * GST_ERROR:
 807  * @...: printf-style message to output
 808  *
 809  * Output an error message in the default category.
 810  */
 811 /**
 812  * GST_WARNING:
 813  * @...: printf-style message to output
 814  *
 815  * Output a warning message in the default category.
 816  */
 817 /**
 818  * GST_INFO:
 819  * @...: printf-style message to output
 820  *
 821  * Output an informational message in the default category.
 822  */
 823 /**
 824  * GST_DEBUG:
 825  * @...: printf-style message to output
 826  *
 827  * Output a debugging message in the default category.
 828  */
 829 /**
 830  * GST_LOG:
 831  * @...: printf-style message to output
 832  *
 833  * Output a logging message in the default category.
 834  */
 835 /**
 836  * GST_FIXME:
 837  * @...: printf-style message to output
 838  *
 839  * Output a fixme message in the default category.
 840  */
 841 /**
 842  * GST_TRACE:
 843  * @...: printf-style message to output
 844  *
 845  * Output a tracing message in the default category.
 846  */
 847 /**
 848  * GST_MEMDUMP:
 849  * @msg: message string to log with the data
 850  * @data: pointer to the data to output
 851  * @length: length of the data to output
 852  *
 853  * Output a hexdump of @data.
 854  */
 855
 856 #ifdef G_HAVE_ISO_VARARGS
 857
 858 #define GST_CAT_ERROR_OBJECT(cat,obj,...)       GST_CAT_LEVEL_LOG (cat, GST_LEVEL_ERROR,   obj,  __VA_ARGS__)
 859 #define GST_CAT_WARNING_OBJECT(cat,obj,...)     GST_CAT_LEVEL_LOG (cat, GST_LEVEL_WARNING, obj,  __VA_ARGS__)
 860 #define GST_CAT_INFO_OBJECT(cat,obj,...)        GST_CAT_LEVEL_LOG (cat, GST_LEVEL_INFO,    obj,  __VA_ARGS__)
 861 #define GST_CAT_DEBUG_OBJECT(cat,obj,...)       GST_CAT_LEVEL_LOG (cat, GST_LEVEL_DEBUG,   obj,  __VA_ARGS__)
 862 #define GST_CAT_LOG_OBJECT(cat,obj,...)         GST_CAT_LEVEL_LOG (cat, GST_LEVEL_LOG,     obj,  __VA_ARGS__)
 863 #define GST_CAT_FIXME_OBJECT(cat,obj,...)       GST_CAT_LEVEL_LOG (cat, GST_LEVEL_FIXME,   obj,  __VA_ARGS__)
 864 #define GST_CAT_TRACE_OBJECT(cat,obj,...)       GST_CAT_LEVEL_LOG (cat, GST_LEVEL_TRACE,   obj,  __VA_ARGS__)
 865
 866 #define GST_CAT_ERROR(cat,...)                  GST_CAT_LEVEL_LOG (cat, GST_LEVEL_ERROR,   NULL, __VA_ARGS__)
 867 #define GST_CAT_WARNING(cat,...)                GST_CAT_LEVEL_LOG (cat, GST_LEVEL_WARNING, NULL, __VA_ARGS__)
 868 #define GST_CAT_INFO(cat,...)                   GST_CAT_LEVEL_LOG (cat, GST_LEVEL_INFO,    NULL, __VA_ARGS__)
 869 #define GST_CAT_DEBUG(cat,...)                  GST_CAT_LEVEL_LOG (cat, GST_LEVEL_DEBUG,   NULL, __VA_ARGS__)
 870 #define GST_CAT_LOG(cat,...)                    GST_CAT_LEVEL_LOG (cat, GST_LEVEL_LOG,     NULL, __VA_ARGS__)
 871 #define GST_CAT_FIXME(cat,...)                  GST_CAT_LEVEL_LOG (cat, GST_LEVEL_FIXME,   NULL, __VA_ARGS__)
 872 #define GST_CAT_TRACE(cat,...)          GST_CAT_LEVEL_LOG (cat, GST_LEVEL_TRACE,   NULL, __VA_ARGS__)
 873
 874 #define GST_ERROR_OBJECT(obj,...)       GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_ERROR,   obj,  __VA_ARGS__)
 875 #define GST_WARNING_OBJECT(obj,...)     GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_WARNING, obj,  __VA_ARGS__)
 876 #define GST_INFO_OBJECT(obj,...)        GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_INFO,    obj,  __VA_ARGS__)
 877 #define GST_DEBUG_OBJECT(obj,...)       GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_DEBUG,   obj,  __VA_ARGS__)
 878 #define GST_LOG_OBJECT(obj,...)         GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_LOG,     obj,  __VA_ARGS__)
 879 #define GST_FIXME_OBJECT(obj,...)       GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_FIXME,   obj,  __VA_ARGS__)
 880 #define GST_TRACE_OBJECT(obj,...)       GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_TRACE,   obj,  __VA_ARGS__)
 881
 882 #define GST_ERROR(...)                  GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_ERROR,   NULL, __VA_ARGS__)
 883 #define GST_WARNING(...)                GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_WARNING, NULL, __VA_ARGS__)
 884 #define GST_INFO(...)                   GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_INFO,    NULL, __VA_ARGS__)
 885 #define GST_DEBUG(...)                  GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_DEBUG,   NULL, __VA_ARGS__)
 886 #define GST_LOG(...)                    GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_LOG,     NULL, __VA_ARGS__)
 887 #define GST_FIXME(...)                  GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_FIXME,   NULL, __VA_ARGS__)
 888 #define GST_TRACE(...)          GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_TRACE,   NULL, __VA_ARGS__)
 889
 890 #else
 891 #ifdef G_HAVE_GNUC_VARARGS
 892
 893 #define GST_CAT_ERROR_OBJECT(cat,obj,args...)   GST_CAT_LEVEL_LOG (cat, GST_LEVEL_ERROR,   obj,  ##args )
 894 #define GST_CAT_WARNING_OBJECT(cat,obj,args...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_WARNING, obj,  ##args )
 895 #define GST_CAT_INFO_OBJECT(cat,obj,args...)    GST_CAT_LEVEL_LOG (cat, GST_LEVEL_INFO,    obj,  ##args )
 896 #define GST_CAT_DEBUG_OBJECT(cat,obj,args...)   GST_CAT_LEVEL_LOG (cat, GST_LEVEL_DEBUG,   obj,  ##args )
 897 #define GST_CAT_LOG_OBJECT(cat,obj,args...)     GST_CAT_LEVEL_LOG (cat, GST_LEVEL_LOG,     obj,  ##args )
 898 #define GST_CAT_FIXME_OBJECT(cat,obj,args...)   GST_CAT_LEVEL_LOG (cat, GST_LEVEL_FIXME,   obj,  ##args )
 899 #define GST_CAT_TRACE_OBJECT(cat,obj,args...)   GST_CAT_LEVEL_LOG (cat, GST_LEVEL_TRACE,   obj,  ##args )
 900
 901 #define GST_CAT_ERROR(cat,args...)              GST_CAT_LEVEL_LOG (cat, GST_LEVEL_ERROR,   NULL, ##args )
 902 #define GST_CAT_WARNING(cat,args...)            GST_CAT_LEVEL_LOG (cat, GST_LEVEL_WARNING, NULL, ##args )
 903 #define GST_CAT_INFO(cat,args...)               GST_CAT_LEVEL_LOG (cat, GST_LEVEL_INFO,    NULL, ##args )
 904 #define GST_CAT_DEBUG(cat,args...)              GST_CAT_LEVEL_LOG (cat, GST_LEVEL_DEBUG,   NULL, ##args )
 905 #define GST_CAT_LOG(cat,args...)                GST_CAT_LEVEL_LOG (cat, GST_LEVEL_LOG,     NULL, ##args )
 906 #define GST_CAT_FIXME(cat,args...)              GST_CAT_LEVEL_LOG (cat, GST_LEVEL_FIXME,   NULL, ##args )
 907 #define GST_CAT_TRACE(cat,args...)              GST_CAT_LEVEL_LOG (cat, GST_LEVEL_TRACE,   NULL, ##args )
 908
 909 #define GST_ERROR_OBJECT(obj,args...)   GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_ERROR,   obj,  ##args )
 910 #define GST_WARNING_OBJECT(obj,args...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_WARNING, obj,  ##args )
 911 #define GST_INFO_OBJECT(obj,args...)    GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_INFO,    obj,  ##args )
 912 #define GST_DEBUG_OBJECT(obj,args...)   GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_DEBUG,   obj,  ##args )
 913 #define GST_LOG_OBJECT(obj,args...)     GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_LOG,     obj,  ##args )
 914 #define GST_FIXME_OBJECT(obj,args...)   GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_FIXME,   obj,  ##args )
 915 #define GST_TRACE_OBJECT(obj,args...)   GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_TRACE,   obj,  ##args )
 916
 917 #define GST_ERROR(args...)              GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_ERROR,   NULL, ##args )
 918 #define GST_WARNING(args...)            GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_WARNING, NULL, ##args )
 919 #define GST_INFO(args...)               GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_INFO,    NULL, ##args )
 920 #define GST_DEBUG(args...)              GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_DEBUG,   NULL, ##args )
 921 #define GST_LOG(args...)                GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_LOG,     NULL, ##args )
 922 #define GST_FIXME(args...)              GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_FIXME,   NULL, ##args )
 923 #define GST_TRACE(args...)              GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_TRACE,   NULL, ##args )
 924
 925 #else
 926 /* no variadic macros, use inline */
 927 static inline void
 928 GST_CAT_ERROR_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
 929     ...)
 930 {
 931   va_list varargs;
 932
 933   va_start (varargs, format);
 934   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_ERROR, obj, format, varargs);
 935   va_end (varargs);
 936 }
 937
 938 static inline void
 939 GST_CAT_WARNING_OBJECT (GstDebugCategory * cat, gpointer obj,
 940     const char *format, ...)
 941 {
 942   va_list varargs;
 943
 944   va_start (varargs, format);
 945   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_WARNING, obj, format, varargs);
 946   va_end (varargs);
 947 }
 948
 949 static inline void
 950 GST_CAT_INFO_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
 951     ...)
 952 {
 953   va_list varargs;
 954
 955   va_start (varargs, format);
 956   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_INFO, obj, format, varargs);
 957   va_end (varargs);
 958 }
 959
 960 static inline void
 961 GST_CAT_DEBUG_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
 962     ...)
 963 {
 964   va_list varargs;
 965
 966   va_start (varargs, format);
 967   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_DEBUG, obj, format, varargs);
 968   va_end (varargs);
 969 }
 970
 971 static inline void
 972 GST_CAT_LOG_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
 973     ...)
 974 {
 975   va_list varargs;
 976
 977   va_start (varargs, format);
 978   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_LOG, obj, format, varargs);
 979   va_end (varargs);
 980 }
 981
 982 static inline void
 983 GST_CAT_FIXME_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
 984     ...)
 985 {
 986   va_list varargs;
 987
 988   va_start (varargs, format);
 989   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_FIXME, obj, format, varargs);
 990   va_end (varargs);
 991 }
 992
 993 static inline void
 994 GST_CAT_TRACE_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
 995     ...)
 996 {
 997   va_list varargs;
 998
 999   va_start (varargs, format);
1000   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_TRACE, obj, format, varargs);
1001   va_end (varargs);
1002 }
1003
1004 static inline void
1005 GST_CAT_ERROR (GstDebugCategory * cat, const char *format, ...)
1006 {
1007   va_list varargs;
1008
1009   va_start (varargs, format);
1010   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_ERROR, NULL, format, varargs);
1011   va_end (varargs);
1012 }
1013
1014 static inline void
1015 GST_CAT_WARNING (GstDebugCategory * cat, const char *format, ...)
1016 {
1017   va_list varargs;
1018
1019   va_start (varargs, format);
1020   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_WARNING, NULL, format, varargs);
1021   va_end (varargs);
1022 }
1023
1024 static inline void
1025 GST_CAT_INFO (GstDebugCategory * cat, const char *format, ...)
1026 {
1027   va_list varargs;
1028
1029   va_start (varargs, format);
1030   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_INFO, NULL, format, varargs);
1031   va_end (varargs);
1032 }
1033
1034 static inline void
1035 GST_CAT_DEBUG (GstDebugCategory * cat, const char *format, ...)
1036 {
1037   va_list varargs;
1038
1039   va_start (varargs, format);
1040   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_DEBUG, NULL, format, varargs);
1041   va_end (varargs);
1042 }
1043
1044 static inline void
1045 GST_CAT_LOG (GstDebugCategory * cat, const char *format, ...)
1046 {
1047   va_list varargs;
1048
1049   va_start (varargs, format);
1050   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_LOG, NULL, format, varargs);
1051   va_end (varargs);
1052 }
1053
1054 static inline void
1055 GST_CAT_FIXME (GstDebugCategory * cat, const char *format, ...)
1056 {
1057   va_list varargs;
1058
1059   va_start (varargs, format);
1060   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_FIXME, NULL, format, varargs);
1061   va_end (varargs);
1062 }
1063
1064 static inline void
1065 GST_CAT_TRACE (GstDebugCategory * cat, const char *format, ...)
1066 {
1067   va_list varargs;
1068
1069   va_start (varargs, format);
1070   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_TRACE, NULL, format, varargs);
1071   va_end (varargs);
1072 }
1073
1074 static inline void
1075 GST_ERROR_OBJECT (gpointer obj, const char *format, ...)
1076 {
1077   va_list varargs;
1078
1079   va_start (varargs, format);
1080   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_ERROR, obj, format,
1081       varargs);
1082   va_end (varargs);
1083 }
1084
1085 static inline void
1086 GST_WARNING_OBJECT (gpointer obj, const char *format, ...)
1087 {
1088   va_list varargs;
1089
1090   va_start (varargs, format);
1091   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_WARNING, obj, format,
1092       varargs);
1093   va_end (varargs);
1094 }
1095
1096 static inline void
1097 GST_INFO_OBJECT (gpointer obj, const char *format, ...)
1098 {
1099   va_list varargs;
1100
1101   va_start (varargs, format);
1102   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_INFO, obj, format,
1103       varargs);
1104   va_end (varargs);
1105 }
1106
1107 static inline void
1108 GST_DEBUG_OBJECT (gpointer obj, const char *format, ...)
1109 {
1110   va_list varargs;
1111
1112   va_start (varargs, format);
1113   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_DEBUG, obj, format,
1114       varargs);
1115   va_end (varargs);
1116 }
1117
1118 static inline void
1119 GST_LOG_OBJECT (gpointer obj, const char *format, ...)
1120 {
1121   va_list varargs;
1122
1123   va_start (varargs, format);
1124   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_LOG, obj, format,
1125       varargs);
1126   va_end (varargs);
1127 }
1128
1129 static inline void
1130 GST_FIXME_OBJECT (gpointer obj, const char *format, ...)
1131 {
1132   va_list varargs;
1133
1134   va_start (varargs, format);
1135   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_FIXME, obj, format,
1136       varargs);
1137   va_end (varargs);
1138 }
1139
1140 static inline void
1141 GST_TRACE_OBJECT (gpointer obj, const char *format, ...)
1142 {
1143   va_list varargs;
1144
1145   va_start (varargs, format);
1146   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_TRACE, obj, format,
1147       varargs);
1148   va_end (varargs);
1149 }
1150
1151 static inline void
1152 GST_ERROR (const char *format, ...)
1153 {
1154   va_list varargs;
1155
1156   va_start (varargs, format);
1157   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_ERROR, NULL, format,
1158       varargs);
1159   va_end (varargs);
1160 }
1161
1162 static inline void
1163 GST_WARNING (const char *format, ...)
1164 {
1165   va_list varargs;
1166
1167   va_start (varargs, format);
1168   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_WARNING, NULL, format,
1169       varargs);
1170   va_end (varargs);
1171 }
1172
1173 static inline void
1174 GST_INFO (const char *format, ...)
1175 {
1176   va_list varargs;
1177
1178   va_start (varargs, format);
1179   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_INFO, NULL, format,
1180       varargs);
1181   va_end (varargs);
1182 }
1183
1184 static inline void
1185 GST_DEBUG (const char *format, ...)
1186 {
1187   va_list varargs;
1188
1189   va_start (varargs, format);
1190   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_DEBUG, NULL, format,
1191       varargs);
1192   va_end (varargs);
1193 }
1194
1195 static inline void
1196 GST_LOG (const char *format, ...)
1197 {
1198   va_list varargs;
1199
1200   va_start (varargs, format);
1201   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_LOG, NULL,
1202       format, varargs);
1203   va_end (varargs);
1204 }
1205
1206 static inline void
1207 GST_FIXME (const char *format, ...)
1208 {
1209   va_list varargs;
1210
1211   va_start (varargs, format);
1212   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_FIXME, NULL, format,
1213       varargs);
1214   va_end (varargs);
1215 }
1216
1217 static inline void
1218 GST_TRACE (const char *format, ...)
1219 {
1220   va_list varargs;
1221
1222   va_start (varargs, format);
1223   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_TRACE, NULL, format,
1224       varargs);
1225   va_end (varargs);
1226 }
1227 #endif
1228 #endif
1229
1230
1231 /********** function pointer stuff **********/
1232
1233 /**
1234  * GST_DEBUG_REGISTER_FUNCPTR:
1235  * @ptr: pointer to the function to register
1236  *
1237  * Register a pointer to a function with its name, so it can later be used by
1238  * GST_DEBUG_FUNCPTR_NAME().
1239  *
1240  * Use this variant of #GST_DEBUG_FUNCPTR if you do not need to use @ptr.
1241  */
1242 #define GST_DEBUG_REGISTER_FUNCPTR(ptr) \
1243   _gst_debug_register_funcptr((GstDebugFuncPtr)(ptr), #ptr)
1244 /**
1245  * GST_DEBUG_FUNCPTR:
1246  * @ptr: pointer to the function to register
1247  *
1248  * Register a pointer to a function with its name, so it can later be used by
1249  * GST_DEBUG_FUNCPTR_NAME().
1250  *
1251  * Returns: the value passed to @ptr.
1252  */
1253 #define GST_DEBUG_FUNCPTR(ptr) \
1254   (_gst_debug_register_funcptr((GstDebugFuncPtr)(ptr), #ptr) , ptr)
1255
1256 /**
1257  * GST_DEBUG_FUNCPTR_NAME:
1258  * @ptr: address of the function of which to look up the name
1259  *
1260  * Retrieves the name of the function, if it was previously registered with
1261  * GST_DEBUG_FUNCPTR(). If not, it returns a description of the pointer.
1262  *
1263  * This macro returns a constant string which must not be modified or
1264  * freed by the caller.
1265  */
1266 #define GST_DEBUG_FUNCPTR_NAME(ptr) \
1267   _gst_debug_nameof_funcptr((GstDebugFuncPtr)ptr)
1268
1269
1270 #else /* GST_DISABLE_GST_DEBUG */
1271
1272
1273 #ifndef GST_INFO_C
1274
1275 #if defined(__GNUC__) && __GNUC__ >= 3
1276 #  pragma GCC poison gst_debug_log
1277 #  pragma GCC poison gst_debug_log_valist
1278 #  pragma GCC poison _gst_debug_category_new
1279 #endif
1280
1281 #define _gst_debug_min GST_LEVEL_NONE
1282
1283 #define gst_debug_set_default_threshold(level)          G_STMT_START{ }G_STMT_END
1284 #define gst_debug_get_default_threshold()               (GST_LEVEL_NONE)
1285
1286 #define gst_debug_level_get_name(level)                         ("NONE")
1287 #define gst_debug_message_get(message)                          ("")
1288 #define gst_debug_add_log_function(func,data,notify)    G_STMT_START{ }G_STMT_END
1289 #define gst_debug_set_active(active)                    G_STMT_START{ }G_STMT_END
1290 #define gst_debug_is_active()                           (FALSE)
1291 #define gst_debug_set_colored(colored)                  G_STMT_START{ }G_STMT_END
1292 #define gst_debug_set_color_mode(mode)                  G_STMT_START{ }G_STMT_END
1293 #define gst_debug_set_color_mode_from_string(mode)      G_STMT_START{ }G_STMT_END
1294 #define gst_debug_is_colored()                          (FALSE)
1295 #define gst_debug_get_color_mode()                      (GST_DEBUG_COLOR_MODE_OFF)
1296 #define gst_debug_set_default_threshold(level)          G_STMT_START{ }G_STMT_END
1297 #define gst_debug_get_default_threshold()               (GST_LEVEL_NONE)
1298 #define gst_debug_set_threshold_for_name(name,level)    G_STMT_START{ }G_STMT_END
1299 #define gst_debug_unset_threshold_for_name(name)        G_STMT_START{ }G_STMT_END
1300
1301 /* we are using dummy function prototypes here to eat ';' as these macros are
1302  * used outside of functions */
1303 #define GST_DEBUG_CATEGORY(var)                         void _gst_debug_dummy_##var (void)
1304 #define GST_DEBUG_CATEGORY_EXTERN(var)                  void _gst_debug_dummy_extern_##var (void)
1305 #define GST_DEBUG_CATEGORY_STATIC(var)                  void _gst_debug_dummy_static_##var (void)
1306
1307 #define GST_DEBUG_CATEGORY_INIT(var,name,color,desc)    G_STMT_START{ }G_STMT_END
1308 #define GST_DEBUG_CATEGORY_GET(var,name)                G_STMT_START{ }G_STMT_END
1309 #define gst_debug_category_free(category)               G_STMT_START{ }G_STMT_END
1310 #define gst_debug_category_set_threshold(category,level) G_STMT_START{ }G_STMT_END
1311 #define gst_debug_category_reset_threshold(category)    G_STMT_START{ }G_STMT_END
1312 #define gst_debug_category_get_threshold(category)      (GST_LEVEL_NONE)
1313 #define gst_debug_category_get_name(cat)                ("")
1314 #define gst_debug_category_get_color(cat)               (0)
1315 #define gst_debug_category_get_description(cat)         ("")
1316 #define gst_debug_get_all_categories()                  (NULL)
1317 #define gst_debug_construct_term_color(colorinfo)       (g_strdup ("00"))
1318 #define gst_debug_construct_win_color(colorinfo)        (0)
1319
1320 #endif /* !GST_INFO_C */
1321
1322 #ifdef G_HAVE_ISO_VARARGS
1323
1324 #define GST_CAT_LEVEL_LOG(cat,level,...)                G_STMT_START{ }G_STMT_END
1325
1326 #define GST_CAT_ERROR_OBJECT(...)                       G_STMT_START{ }G_STMT_END
1327 #define GST_CAT_WARNING_OBJECT(...)                     G_STMT_START{ }G_STMT_END
1328 #define GST_CAT_INFO_OBJECT(...)                        G_STMT_START{ }G_STMT_END
1329 #define GST_CAT_DEBUG_OBJECT(...)                       G_STMT_START{ }G_STMT_END
1330 #define GST_CAT_LOG_OBJECT(...)                         G_STMT_START{ }G_STMT_END
1331 #define GST_CAT_FIXME_OBJECT(...)                       G_STMT_START{ }G_STMT_END
1332 #define GST_CAT_TRACE_OBJECT(...)                       G_STMT_START{ }G_STMT_END
1333
1334 #define GST_CAT_ERROR(...)                              G_STMT_START{ }G_STMT_END
1335 #define GST_CAT_WARNING(...)                            G_STMT_START{ }G_STMT_END
1336 #define GST_CAT_INFO(...)                               G_STMT_START{ }G_STMT_END
1337 #define GST_CAT_DEBUG(...)                              G_STMT_START{ }G_STMT_END
1338 #define GST_CAT_LOG(...)                                G_STMT_START{ }G_STMT_END
1339 #define GST_CAT_FIXME(...)                              G_STMT_START{ }G_STMT_END
1340 #define GST_CAT_TRACE(...)                              G_STMT_START{ }G_STMT_END
1341
1342 #define GST_ERROR_OBJECT(...)                           G_STMT_START{ }G_STMT_END
1343 #define GST_WARNING_OBJECT(...)                         G_STMT_START{ }G_STMT_END
1344 #define GST_INFO_OBJECT(...)                            G_STMT_START{ }G_STMT_END
1345 #define GST_DEBUG_OBJECT(...)                           G_STMT_START{ }G_STMT_END
1346 #define GST_LOG_OBJECT(...)                             G_STMT_START{ }G_STMT_END
1347 #define GST_FIXME_OBJECT(...)                           G_STMT_START{ }G_STMT_END
1348 #define GST_TRACE_OBJECT(...)                           G_STMT_START{ }G_STMT_END
1349
1350 #define GST_ERROR(...)                                  G_STMT_START{ }G_STMT_END
1351 #define GST_WARNING(...)                                G_STMT_START{ }G_STMT_END
1352 #define GST_INFO(...)                                   G_STMT_START{ }G_STMT_END
1353 #define GST_DEBUG(...)                                  G_STMT_START{ }G_STMT_END
1354 #define GST_LOG(...)                                    G_STMT_START{ }G_STMT_END
1355 #define GST_FIXME(...)                                  G_STMT_START{ }G_STMT_END
1356 #define GST_TRACE(...)                                  G_STMT_START{ }G_STMT_END
1357
1358 #else /* !G_HAVE_ISO_VARARGS */
1359 #ifdef G_HAVE_GNUC_VARARGS
1360
1361 #define GST_CAT_LEVEL_LOG(cat,level,args...)            G_STMT_START{ }G_STMT_END
1362
1363 #define GST_CAT_ERROR_OBJECT(args...)                   G_STMT_START{ }G_STMT_END
1364 #define GST_CAT_WARNING_OBJECT(args...)                 G_STMT_START{ }G_STMT_END
1365 #define GST_CAT_INFO_OBJECT(args...)                    G_STMT_START{ }G_STMT_END
1366 #define GST_CAT_DEBUG_OBJECT(args...)                   G_STMT_START{ }G_STMT_END
1367 #define GST_CAT_LOG_OBJECT(args...)                     G_STMT_START{ }G_STMT_END
1368 #define GST_CAT_FIXME_OBJECT(args...)                   G_STMT_START{ }G_STMT_END
1369 #define GST_CAT_TRACE_OBJECT(args...)                   G_STMT_START{ }G_STMT_END
1370
1371 #define GST_CAT_ERROR(args...)                          G_STMT_START{ }G_STMT_END
1372 #define GST_CAT_WARNING(args...)                        G_STMT_START{ }G_STMT_END
1373 #define GST_CAT_INFO(args...)                           G_STMT_START{ }G_STMT_END
1374 #define GST_CAT_DEBUG(args...)                          G_STMT_START{ }G_STMT_END
1375 #define GST_CAT_LOG(args...)                            G_STMT_START{ }G_STMT_END
1376 #define GST_CAT_FIXME(args...)                          G_STMT_START{ }G_STMT_END
1377 #define GST_CAT_TRACE(args...)                          G_STMT_START{ }G_STMT_END
1378
1379 #define GST_ERROR_OBJECT(args...)                       G_STMT_START{ }G_STMT_END
1380 #define GST_WARNING_OBJECT(args...)                     G_STMT_START{ }G_STMT_END
1381 #define GST_INFO_OBJECT(args...)                        G_STMT_START{ }G_STMT_END
1382 #define GST_DEBUG_OBJECT(args...)                       G_STMT_START{ }G_STMT_END
1383 #define GST_LOG_OBJECT(args...)                         G_STMT_START{ }G_STMT_END
1384 #define GST_FIXME_OBJECT(args...)                       G_STMT_START{ }G_STMT_END
1385 #define GST_TRACE_OBJECT(args...)                       G_STMT_START{ }G_STMT_END
1386
1387 #define GST_ERROR(args...)                              G_STMT_START{ }G_STMT_END
1388 #define GST_WARNING(args...)                            G_STMT_START{ }G_STMT_END
1389 #define GST_INFO(args...)                               G_STMT_START{ }G_STMT_END
1390 #define GST_DEBUG(args...)                              G_STMT_START{ }G_STMT_END
1391 #define GST_LOG(args...)                                G_STMT_START{ }G_STMT_END
1392 #define GST_FIXME(args...)                              G_STMT_START{ }G_STMT_END
1393 #define GST_TRACE(args...)                              G_STMT_START{ }G_STMT_END
1394
1395 #else /* !G_HAVE_GNUC_VARARGS */
1396 static inline void
1397 GST_CAT_LEVEL_LOG_valist (GstDebugCategory * cat,
1398     GstDebugLevel level, gpointer object, const char *format, va_list varargs)
1399 {
1400 }
1401
1402 static inline void
1403 GST_CAT_ERROR_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
1404     ...)
1405 {
1406 }
1407
1408 static inline void
1409 GST_CAT_WARNING_OBJECT (GstDebugCategory * cat, gpointer obj,
1410     const char *format, ...)
1411 {
1412 }
1413
1414 static inline void
1415 GST_CAT_INFO_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
1416     ...)
1417 {
1418 }
1419
1420 static inline void
1421 GST_CAT_DEBUG_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
1422     ...)
1423 {
1424 }
1425
1426 static inline void
1427 GST_CAT_LOG_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
1428     ...)
1429 {
1430 }
1431
1432 static inline void
1433 GST_CAT_FIXME_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
1434     ...)
1435 {
1436 }
1437
1438 static inline void
1439 GST_CAT_TRACE_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
1440     ...)
1441 {
1442 }
1443
1444 static inline void
1445 GST_CAT_ERROR (GstDebugCategory * cat, const char *format, ...)
1446 {
1447 }
1448
1449 static inline void
1450 GST_CAT_WARNING (GstDebugCategory * cat, const char *format, ...)
1451 {
1452 }
1453
1454 static inline void
1455 GST_CAT_INFO (GstDebugCategory * cat, const char *format, ...)
1456 {
1457 }
1458
1459 static inline void
1460 GST_CAT_DEBUG (GstDebugCategory * cat, const char *format, ...)
1461 {
1462 }
1463
1464 static inline void
1465 GST_CAT_LOG (GstDebugCategory * cat, const char *format, ...)
1466 {
1467 }
1468
1469 static inline void
1470 GST_CAT_FIXME (GstDebugCategory * cat, const char *format, ...)
1471 {
1472 }
1473
1474 static inline void
1475 GST_CAT_TRACE (GstDebugCategory * cat, const char *format, ...)
1476 {
1477 }
1478
1479 static inline void
1480 GST_ERROR_OBJECT (gpointer obj, const char *format, ...)
1481 {
1482 }
1483
1484 static inline void
1485 GST_WARNING_OBJECT (gpointer obj, const char *format, ...)
1486 {
1487 }
1488
1489 static inline void
1490 GST_INFO_OBJECT (gpointer obj, const char *format, ...)
1491 {
1492 }
1493
1494 static inline void
1495 GST_DEBUG_OBJECT (gpointer obj, const char *format, ...)
1496 {
1497 }
1498
1499 static inline void
1500 GST_LOG_OBJECT (gpointer obj, const char *format, ...)
1501 {
1502 }
1503
1504 static inline void
1505 GST_FIXME_OBJECT (gpointer obj, const char *format, ...)
1506 {
1507 }
1508
1509 static inline void
1510 GST_TRACE_OBJECT (gpointer obj, const char *format, ...)
1511 {
1512 }
1513
1514 static inline void
1515 GST_ERROR (const char *format, ...)
1516 {
1517 }
1518
1519 static inline void
1520 GST_WARNING (const char *format, ...)
1521 {
1522 }
1523
1524 static inline void
1525 GST_INFO (const char *format, ...)
1526 {
1527 }
1528
1529 static inline void
1530 GST_DEBUG (const char *format, ...)
1531 {
1532 }
1533
1534 static inline void
1535 GST_LOG (const char *format, ...)
1536 {
1537 }
1538
1539 static inline void
1540 GST_FIXME (const char *format, ...)
1541 {
1542 }
1543
1544 static inline void
1545 GST_TRACE (const char *format, ...)
1546 {
1547 }
1548
1549 #endif /* G_HAVE_GNUC_VARARGS */
1550 #endif /* G_HAVE_ISO_VARARGS */
1551
1552 #define GST_DEBUG_REGISTER_FUNCPTR(ptr) G_STMT_START{ }G_STMT_END
1553 #define GST_DEBUG_FUNCPTR(ptr) (ptr)
1554 #define GST_DEBUG_FUNCPTR_NAME(ptr) (g_strdup_printf ("%p", ptr))
1555
1556 #define GST_CAT_MEMDUMP_OBJECT(cat,obj,msg,data,length) G_STMT_START{ }G_STMT_END
1557 #define GST_CAT_MEMDUMP(cat,msg,data,length)            G_STMT_START{ }G_STMT_END
1558 #define GST_MEMDUMP_OBJECT(obj,msg,data,length)         G_STMT_START{ }G_STMT_END
1559 #define GST_MEMDUMP(msg,data,length)                    G_STMT_START{ }G_STMT_END
1560
1561 #endif /* GST_DISABLE_GST_DEBUG */
1562
1563
1564 void gst_debug_print_stack_trace (void);
1565
1566 G_END_DECLS
1567
1568 #endif /* __GSTINFO_H__ */