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