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