gst/gstinfo.*: Add some G_[UN]LIKELY.
[platform/upstream/gstreamer.git] / 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_INFO: Informational messages should be used to keep the developer
46  *  updated about what is happening.
47  *  Examples where this should be used are when a typefind function has
48  *  successfully determined the type of the stream or when an mp3 plugin detects
49  *  the format to be used. ("This file has mono sound.")
50  * @GST_LEVEL_DEBUG: Debugging messages should be used when something common
51  *  happens that is not the expected default behavior.
52  *  An example would be notifications about state changes or receiving/sending of
53  *  events.
54  * @GST_LEVEL_LOG: Log messages are messages that are very common but might be
55  *  useful to know. As a rule of thumb a pipeline that is iterating as expected
56  *  should never output anzthing else but LOG messages.
57  *  Examples for this are referencing/dereferencing of objects or cothread switches.
58  * @GST_LEVEL_COUNT: The number of defined debugging levels.
59  *
60  * The level defines the importance of a debugging message. The more important a
61  * message is, the greater the probability that the debugging system outputs it.
62  */
63 typedef enum {
64   GST_LEVEL_NONE = 0,
65   GST_LEVEL_ERROR,
66   GST_LEVEL_WARNING,
67   GST_LEVEL_INFO,
68   GST_LEVEL_DEBUG,
69   GST_LEVEL_LOG,
70   /* add more */
71   GST_LEVEL_COUNT
72 } GstDebugLevel;
73
74 /**
75  * GST_LEVEL_DEFAULT:
76  *
77  * Defines the default debugging level to be used with GStreamer. It is normally
78  * set to #GST_LEVEL_NONE so nothing get printed.
79  * As it can be configured at compile time, developer builds may chose to
80  * override that though.
81  * You can use this as an argument to gst_debug_set_default_threshold() to
82  * reset the debugging output to default behaviour.
83  */
84 #ifndef GST_LEVEL_DEFAULT
85 #define GST_LEVEL_DEFAULT GST_LEVEL_NONE
86 #endif
87
88 /* defines for format (colors etc)
89  * don't change them around, it uses terminal layout
90  * Terminal color strings:
91  * 00=none 01=bold 04=underscore 05=blink 07=reverse 08=concealed
92  * Text color codes:
93  * 30=black 31=red 32=green 33=yellow 34=blue 35=magenta 36=cyan 37=white
94  * Background color codes:
95  * 40=black 41=red 42=green 43=yellow 44=blue 45=magenta 46=cyan 47=white
96  */
97 /**
98  * GstDebugColorFlags:
99  * @GST_DEBUG_FG_BLACK: Use black as foreground color.
100  * @GST_DEBUG_FG_RED: Use red as foreground color.
101  * @GST_DEBUG_FG_GREEN: Use green as foreground color.
102  * @GST_DEBUG_FG_YELLOW: Use yellow as foreground color.
103  * @GST_DEBUG_FG_BLUE: Use blue as foreground color.
104  * @GST_DEBUG_FG_MAGENTA: Use magenta as foreground color.
105  * @GST_DEBUG_FG_CYAN: Use cyan as foreground color.
106  * @GST_DEBUG_FG_WHITE: Use white as foreground color.
107  * @GST_DEBUG_BG_BLACK: Use black as background color.
108  * @GST_DEBUG_BG_RED: Use red as background color.
109  * @GST_DEBUG_BG_GREEN: Use green as background color.
110  * @GST_DEBUG_BG_YELLOW: Use yellow as background color.
111  * @GST_DEBUG_BG_BLUE: Use blue as background color.
112  * @GST_DEBUG_BG_MAGENTA: Use magenta as background color.
113  * @GST_DEBUG_BG_CYAN: Use cyan as background color.
114  * @GST_DEBUG_BG_WHITE: Use white as background color.
115  * @GST_DEBUG_BOLD: Make the output bold.
116  * @GST_DEBUG_UNDERLINE: Underline the output.
117  *
118  * These are some terminal style flags you can use when creating your
119  * debugging categories to make them stand out in debugging output.
120  */
121 typedef enum {
122   /* colors */
123   GST_DEBUG_FG_BLACK            = 0x0000,
124   GST_DEBUG_FG_RED              = 0x0001,
125   GST_DEBUG_FG_GREEN            = 0x0002,
126   GST_DEBUG_FG_YELLOW           = 0x0003,
127   GST_DEBUG_FG_BLUE             = 0x0004,
128   GST_DEBUG_FG_MAGENTA          = 0x0005,
129   GST_DEBUG_FG_CYAN             = 0x0006,
130   GST_DEBUG_FG_WHITE            = 0x0007,
131   /* background colors */
132   GST_DEBUG_BG_BLACK            = 0x0000,
133   GST_DEBUG_BG_RED              = 0x0010,
134   GST_DEBUG_BG_GREEN            = 0x0020,
135   GST_DEBUG_BG_YELLOW           = 0x0030,
136   GST_DEBUG_BG_BLUE             = 0x0040,
137   GST_DEBUG_BG_MAGENTA          = 0x0050,
138   GST_DEBUG_BG_CYAN             = 0x0060,
139   GST_DEBUG_BG_WHITE            = 0x0070,
140   /* other formats */
141   GST_DEBUG_BOLD                = 0x0100,
142   GST_DEBUG_UNDERLINE           = 0x0200
143 } GstDebugColorFlags;
144
145 #define GST_DEBUG_FG_MASK       (0x000F)
146 #define GST_DEBUG_BG_MASK       (0x00F0)
147 #define GST_DEBUG_FORMAT_MASK   (0xFF00)
148
149 typedef struct _GstDebugCategory GstDebugCategory;
150 /**
151  * GstDebugCategory:
152  *
153  * This is the struct that describes the categories. Once initialized with
154  * #GST_DEBUG_CATEGORY_INIT, its values can't be changed anymore.
155  */
156 struct _GstDebugCategory {
157   /*< private >*/
158   gint                  threshold;
159   guint                 color;          /* see defines above */
160
161   const gchar *         name;
162   const gchar *         description;
163 };
164
165 /********** some convenience macros for debugging **********/
166
167 /**
168  * GST_STR_NULL:
169  * @str: The string to check.
170  *
171  * Macro to use when a string must not be NULL, but may be NULL. If the string
172  * is NULL, "(NULL)" is printed instead.
173  * In GStreamer printf string arguments may not be NULL, because on some
174  * platforms (ie Solaris) the libc crashes in that case. This includes debugging
175  * strings.
176  */
177 #define GST_STR_NULL(str) ((str) ? (str) : "(NULL)")
178
179 /* FIXME, not MT safe */
180 /**
181  * GST_DEBUG_PAD_NAME:
182  * @pad: The pad to debug.
183  *
184  * Evaluates to 2 strings, that describe the pad. Often used in debugging
185  * statements.
186  */
187 #define GST_DEBUG_PAD_NAME(pad) \
188   (pad != NULL) ?  \
189   ((GST_OBJECT_PARENT(pad) != NULL) ? \
190   GST_STR_NULL (GST_OBJECT_NAME (GST_OBJECT_PARENT(pad))) : \
191   "''" ) : "''", \
192   (pad != NULL) ? GST_STR_NULL (GST_OBJECT_NAME (pad)) : "''"
193
194 /**
195  * GST_FUNCTION:
196  *
197  * This macro should evaluate to the name of the current function and be should
198  * be defined when configuring your project, as it is compiler dependant. If it
199  * is not defined, some default value is used. It is used to provide debugging
200  * output with the function name of the message.
201  */
202 #ifndef GST_FUNCTION
203 #if defined (__GNUC__)
204 #  define GST_FUNCTION     ((const char*) (__PRETTY_FUNCTION__))
205 #elif defined (G_HAVE_ISO_VARARGS)
206 #  define GST_FUNCTION     ((const char*) (__func__))
207 #else
208 #  define GST_FUNCTION     ((const char*) ("???"))
209 #endif
210 #endif /* ifndef GST_FUNCTION */
211
212
213 typedef struct _GstDebugMessage GstDebugMessage;
214
215 /**
216  * GstLogFunction:
217  * @category: a #GstDebugCategory
218  * @level: a #GstDebugLevel
219  * @file: file name
220  * @function: function name
221  * @line: line number
222  * @object: a #GObject
223  * @message: the message
224  * @data: user data for the log function
225  *
226  * Function prototype for a logging function that can be registered with
227  * gst_debug_add_log_function().
228  * Use G_GNUC_NO_INSTRUMENT on that function.
229  */
230 typedef void (*GstLogFunction)  (GstDebugCategory *     category,
231                                  GstDebugLevel          level,
232                                  const gchar *          file,
233                                  const gchar *          function,
234                                  gint                   line,
235                                  GObject *              object,
236                                  GstDebugMessage *      message,
237                                  gpointer               data);
238
239 #ifndef GST_DISABLE_GST_DEBUG
240
241 void            _gst_debug_init                 (void);
242
243 /* note we can't use G_GNUC_PRINTF (7, 8) because gcc chokes on %P, which
244  * we use for GST_PTR_FORMAT. */
245 void            gst_debug_log           (GstDebugCategory *     category,
246                                          GstDebugLevel          level,
247                                          const gchar *          file,
248                                          const gchar *          function,
249                                          gint                   line,
250                                          GObject *              object,
251                                          const gchar *          format,
252                                          ...) G_GNUC_NO_INSTRUMENT;
253 void            gst_debug_log_valist    (GstDebugCategory *     category,
254                                          GstDebugLevel          level,
255                                          const gchar *          file,
256                                          const gchar *          function,
257                                          gint                   line,
258                                          GObject *              object,
259                                          const gchar *          format,
260                                          va_list                args) G_GNUC_NO_INSTRUMENT;
261
262 const gchar *   gst_debug_message_get   (GstDebugMessage *      message);
263
264 void            gst_debug_log_default   (GstDebugCategory *     category,
265                                          GstDebugLevel          level,
266                                          const gchar *          file,
267                                          const gchar *          function,
268                                          gint                   line,
269                                          GObject *              object,
270                                          GstDebugMessage *      message,
271                                          gpointer               unused) G_GNUC_NO_INSTRUMENT;
272
273 G_CONST_RETURN gchar *
274                 gst_debug_level_get_name        (GstDebugLevel          level);
275
276 void            gst_debug_add_log_function      (GstLogFunction         func,
277                                                  gpointer data);
278 guint           gst_debug_remove_log_function   (GstLogFunction         func);
279 guint           gst_debug_remove_log_function_by_data (gpointer         data);
280
281 void            gst_debug_set_active            (gboolean active);
282 gboolean        gst_debug_is_active             (void);
283
284 void            gst_debug_set_colored           (gboolean colored);
285 gboolean        gst_debug_is_colored            (void);
286
287 void            gst_debug_set_default_threshold (GstDebugLevel          level);
288 GstDebugLevel   gst_debug_get_default_threshold (void);
289 void            gst_debug_set_threshold_for_name (const gchar *         name,
290                                                  GstDebugLevel          level);
291 void            gst_debug_unset_threshold_for_name (const gchar *       name);
292
293 /**
294  * GST_DEBUG_CATEGORY:
295  * @cat: the category
296  *
297  * Defines a GstDebugCategory variable.
298  * This macro expands to nothing if debugging is disabled.
299  */
300 #define GST_DEBUG_CATEGORY(cat) GstDebugCategory *cat = NULL
301 /**
302  * GST_DEBUG_CATEGORY_EXTERN:
303  * @cat: the category
304  *
305  * Declares a GstDebugCategory variable as extern. Use in header files.
306  * This macro expands to nothing if debugging is disabled.
307  */
308 #define GST_DEBUG_CATEGORY_EXTERN(cat) extern GstDebugCategory *cat
309 /**
310  * GST_DEBUG_CATEGORY_STATIC:
311  * @cat: the category
312  *
313  * Defines a static GstDebugCategory variable.
314  * This macro expands to nothing if debugging is disabled.
315  */
316 #define GST_DEBUG_CATEGORY_STATIC(cat) static GstDebugCategory *cat = NULL
317 /* do not use this function, use the macros below */
318 GstDebugCategory *_gst_debug_category_new       (gchar *        name,
319                                                  guint          color,
320                                                  gchar *        description);
321 /**
322  * GST_DEBUG_CATEGORY_INIT:
323  * @cat: the category to initialize.
324  * @name: the name of the category.
325  * @color: the colors to use for a color representation or 0 for no color.
326  * @description: optional description of the category.
327  *
328  * Initializes a new #GstDebugCategory with the given properties and set to
329  * the default threshold.
330  *
331  * <note>
332  * <para>
333  * This macro expands to nothing if debugging is disabled.
334  * </para>
335  * <para>
336  * When naming your category, please follow the following conventions to ensure
337  * that the pattern matching for categories works as expected. It is not
338  * earth-shattering if you don't follow these conventions, but it would be nice
339  * for everyone.
340  * </para>
341  * <para>
342  * If you define a category for a plugin or a feature of it, name the category
343  * like the feature. So if you wanted to write a "filesrc" element, you would
344  * name the category "filesrc". Use lowercase letters only.
345  * If you define more than one category for the same element, append an
346  * underscore and an identifier to your categories, like this: "filesrc_cache"
347  * </para>
348  * <para>
349  * If you create a library or an application using debugging categories, use a
350  * common prefix followed by an underscore for all your categories. GStreamer
351  * uses the GST prefix so GStreamer categories look like "GST_STATES". Be sure
352  * to include uppercase letters.
353  * </para>
354  * </note>
355  */
356 #define GST_DEBUG_CATEGORY_INIT(cat,name,color,description) G_STMT_START{\
357   if (cat == NULL)                                                      \
358     cat = _gst_debug_category_new (name,color,description);             \
359 }G_STMT_END
360
361 void    gst_debug_category_free         (GstDebugCategory *     category);
362 void    gst_debug_category_set_threshold (GstDebugCategory *    category,
363                                          GstDebugLevel          level);
364 void    gst_debug_category_reset_threshold(GstDebugCategory *   category);
365 GstDebugLevel
366         gst_debug_category_get_threshold (GstDebugCategory *    category);
367 G_CONST_RETURN gchar *
368         gst_debug_category_get_name     (GstDebugCategory *     category);
369 guint   gst_debug_category_get_color    (GstDebugCategory *     category);
370 G_CONST_RETURN gchar *
371         gst_debug_category_get_description (GstDebugCategory *  category);
372 GSList *
373         gst_debug_get_all_categories    (void);
374
375 gchar * gst_debug_construct_term_color  (guint colorinfo);
376
377
378 /**
379  * GST_CAT_DEFAULT:
380  *
381  * Default gstreamer core debug log category. Please define your own.
382  */
383 GST_EXPORT GstDebugCategory *   GST_CAT_DEFAULT;
384 /* this symbol may not be used */
385 extern gboolean                 __gst_debug_enabled;
386
387 /* since 0.10.7, the min debug level, used for quickly discarding debug
388  * messages that fall under the threshold. */
389 extern GstDebugLevel            __gst_debug_min; 
390
391 /**
392  * GST_CAT_LEVEL_LOG:
393  * @cat: category to use
394  * @level: the severity of the message
395  * @object: the #GObject the message belongs to or NULL if none
396  * @...: A printf-style message to output
397  *
398  * Outputs a debugging message. This is the most general macro for outputting
399  * debugging messages. You will probably want to use one of the ones described
400  * below.
401  */
402 #ifdef G_HAVE_ISO_VARARGS
403 #define GST_CAT_LEVEL_LOG(cat,level,object,...) G_STMT_START{           \
404   if (G_UNLIKELY (level <= __gst_debug_min)) {                                          \
405     gst_debug_log ((cat), (level), __FILE__, GST_FUNCTION, __LINE__,    \
406         (GObject *) (object), __VA_ARGS__);                             \
407   }                                                                     \
408 }G_STMT_END
409 #else /* G_HAVE_GNUC_VARARGS */
410 #ifdef G_HAVE_GNUC_VARARGS
411 #define GST_CAT_LEVEL_LOG(cat,level,object,args...) G_STMT_START{       \
412   if (G_UNLIKELY (level <= __gst_debug_min)) {                                          \
413     gst_debug_log ((cat), (level), __FILE__, GST_FUNCTION, __LINE__,    \
414         (GObject *) (object), ##args );                                 \
415   }                                                                     \
416 }G_STMT_END
417 #else /* no variadic macros, use inline */
418 static inline void
419 GST_CAT_LEVEL_LOG_valist (GstDebugCategory * cat,
420     GstDebugLevel level, gpointer object, const char *format, va_list varargs)
421 {
422   gst_debug_log_valist (cat, level, "", "", 0, (GObject *) object, format,
423       varargs);
424 }
425
426 static inline void
427 GST_CAT_LEVEL_LOG (GstDebugCategory * cat, GstDebugLevel level,
428     gpointer object, const char *format, ...)
429 {
430   if (G_UNLIKELY (level <= __gst_debug_min)) {                                          \
431     va_list varargs;
432
433     va_start (varargs, format);
434     GST_CAT_LEVEL_LOG_valist (cat, level, object, format, varargs);
435     va_end (varargs);
436   }
437 }
438 #endif
439 #endif /* G_HAVE_ISO_VARARGS */
440
441 /**
442  * GST_CAT_ERROR_OBJECT:
443  * @cat: category to use
444  * @obj: the #GObject the message belongs to
445  * @...: printf-style message to output
446  *
447  * Output an error message belonging to the given object in the given category.
448  */
449 /**
450  * GST_CAT_WARNING_OBJECT:
451  * @cat: category to use
452  * @obj: the #GObject the message belongs to
453  * @...: printf-style message to output
454  *
455  * Output a warning message belonging to the given object in the given category.
456  */
457 /**
458  * GST_CAT_INFO_OBJECT:
459  * @cat: category to use
460  * @obj: the #GObject the message belongs to
461  * @...: printf-style message to output
462  *
463  * Output an informational message belonging to the given object in the given
464  * category.
465  */
466 /**
467  * GST_CAT_DEBUG_OBJECT:
468  * @cat: category to use
469  * @obj: the #GObject the message belongs to
470  * @...: printf-style message to output
471  *
472  * Output an debugging message belonging to the given object in the given category.
473  */
474 /**
475  * GST_CAT_LOG_OBJECT:
476  * @cat: category to use
477  * @obj: the #GObject the message belongs to
478  * @...: printf-style message to output
479  *
480  * Output an logging message belonging to the given object in the given category.
481  */
482
483
484 /**
485  * GST_CAT_ERROR:
486  * @cat: category to use
487  * @...: printf-style message to output
488  *
489  * Output an error message in the given category.
490  */
491 /**
492  * GST_CAT_WARNING:
493  * @cat: category to use
494  * @...: printf-style message to output
495  *
496  * Output an warning message in the given category.
497  */
498 /**
499  * GST_CAT_INFO:
500  * @cat: category to use
501  * @...: printf-style message to output
502  *
503  * Output an informational message in the given category.
504  */
505 /**
506  * GST_CAT_DEBUG:
507  * @cat: category to use
508  * @...: printf-style message to output
509  *
510  * Output an debugging message in the given category.
511  */
512 /**
513  * GST_CAT_LOG:
514  * @cat: category to use
515  * @...: printf-style message to output
516  *
517  * Output an logging message in the given category.
518  */
519
520
521 /**
522  * GST_ERROR_OBJECT:
523  * @obj: the #GObject the message belongs to
524  * @...: printf-style message to output
525  *
526  * Output an error message belonging to the given object in the default category.
527  */
528 /**
529  * GST_WARNING_OBJECT:
530  * @obj: the #GObject the message belongs to
531  * @...: printf-style message to output
532  *
533  * Output a warning message belonging to the given object in the default category.
534  */
535 /**
536  * GST_INFO_OBJECT:
537  * @obj: the #GObject the message belongs to
538  * @...: printf-style message to output
539  *
540  * Output an informational message belonging to the given object in the default
541  * category.
542  */
543 /**
544  * GST_DEBUG_OBJECT:
545  * @obj: the #GObject the message belongs to
546  * @...: printf-style message to output
547  *
548  * Output a debugging message belonging to the given object in the default
549  * category.
550  */
551 /**
552  * GST_LOG_OBJECT:
553  * @obj: the #GObject the message belongs to
554  * @...: printf-style message to output
555  *
556  * Output a logging message belonging to the given object in the default category.
557  */
558
559
560 /**
561  * GST_ERROR:
562  * @...: printf-style message to output
563  *
564  * Output an error message in the default category.
565  */
566 /**
567  * GST_WARNING:
568  * @...: printf-style message to output
569  *
570  * Output a warning message in the default category.
571  */
572 /**
573  * GST_INFO:
574  * @...: printf-style message to output
575  *
576  * Output an informational message in the default category.
577  */
578 /**
579  * GST_DEBUG:
580  * @...: printf-style message to output
581  *
582  * Output a debugging message in the default category.
583  */
584 /**
585  * GST_LOG:
586  * @...: printf-style message to output
587  *
588  * Output a logging message in the default category.
589  */
590
591 #ifdef G_HAVE_ISO_VARARGS
592
593 #define GST_CAT_ERROR_OBJECT(cat,obj,...)       GST_CAT_LEVEL_LOG (cat, GST_LEVEL_ERROR,   obj,  __VA_ARGS__)
594 #define GST_CAT_WARNING_OBJECT(cat,obj,...)     GST_CAT_LEVEL_LOG (cat, GST_LEVEL_WARNING, obj,  __VA_ARGS__)
595 #define GST_CAT_INFO_OBJECT(cat,obj,...)        GST_CAT_LEVEL_LOG (cat, GST_LEVEL_INFO,    obj,  __VA_ARGS__)
596 #define GST_CAT_DEBUG_OBJECT(cat,obj,...)       GST_CAT_LEVEL_LOG (cat, GST_LEVEL_DEBUG,   obj,  __VA_ARGS__)
597 #define GST_CAT_LOG_OBJECT(cat,obj,...)         GST_CAT_LEVEL_LOG (cat, GST_LEVEL_LOG,     obj,  __VA_ARGS__)
598
599 #define GST_CAT_ERROR(cat,...)                  GST_CAT_LEVEL_LOG (cat, GST_LEVEL_ERROR,   NULL, __VA_ARGS__)
600 #define GST_CAT_WARNING(cat,...)                GST_CAT_LEVEL_LOG (cat, GST_LEVEL_WARNING, NULL, __VA_ARGS__)
601 #define GST_CAT_INFO(cat,...)                   GST_CAT_LEVEL_LOG (cat, GST_LEVEL_INFO,    NULL, __VA_ARGS__)
602 #define GST_CAT_DEBUG(cat,...)                  GST_CAT_LEVEL_LOG (cat, GST_LEVEL_DEBUG,   NULL, __VA_ARGS__)
603 #define GST_CAT_LOG(cat,...)                    GST_CAT_LEVEL_LOG (cat, GST_LEVEL_LOG,     NULL, __VA_ARGS__)
604
605 #define GST_ERROR_OBJECT(obj,...)       GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_ERROR,   obj,  __VA_ARGS__)
606 #define GST_WARNING_OBJECT(obj,...)     GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_WARNING, obj,  __VA_ARGS__)
607 #define GST_INFO_OBJECT(obj,...)        GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_INFO,    obj,  __VA_ARGS__)
608 #define GST_DEBUG_OBJECT(obj,...)       GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_DEBUG,   obj,  __VA_ARGS__)
609 #define GST_LOG_OBJECT(obj,...)         GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_LOG,     obj,  __VA_ARGS__)
610
611 #define GST_ERROR(...)                  GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_ERROR,   NULL, __VA_ARGS__)
612 #define GST_WARNING(...)                GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_WARNING, NULL, __VA_ARGS__)
613 #define GST_INFO(...)                   GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_INFO,    NULL, __VA_ARGS__)
614 #define GST_DEBUG(...)                  GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_DEBUG,   NULL, __VA_ARGS__)
615 #define GST_LOG(...)                    GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_LOG,     NULL, __VA_ARGS__)
616
617 #else
618 #ifdef G_HAVE_GNUC_VARARGS
619
620 #define GST_CAT_ERROR_OBJECT(cat,obj,args...)   GST_CAT_LEVEL_LOG (cat, GST_LEVEL_ERROR,   obj,  ##args )
621 #define GST_CAT_WARNING_OBJECT(cat,obj,args...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_WARNING, obj,  ##args )
622 #define GST_CAT_INFO_OBJECT(cat,obj,args...)    GST_CAT_LEVEL_LOG (cat, GST_LEVEL_INFO,    obj,  ##args )
623 #define GST_CAT_DEBUG_OBJECT(cat,obj,args...)   GST_CAT_LEVEL_LOG (cat, GST_LEVEL_DEBUG,   obj,  ##args )
624 #define GST_CAT_LOG_OBJECT(cat,obj,args...)     GST_CAT_LEVEL_LOG (cat, GST_LEVEL_LOG,     obj,  ##args )
625
626 #define GST_CAT_ERROR(cat,args...)              GST_CAT_LEVEL_LOG (cat, GST_LEVEL_ERROR,   NULL, ##args )
627 #define GST_CAT_WARNING(cat,args...)            GST_CAT_LEVEL_LOG (cat, GST_LEVEL_WARNING, NULL, ##args )
628 #define GST_CAT_INFO(cat,args...)               GST_CAT_LEVEL_LOG (cat, GST_LEVEL_INFO,    NULL, ##args )
629 #define GST_CAT_DEBUG(cat,args...)              GST_CAT_LEVEL_LOG (cat, GST_LEVEL_DEBUG,   NULL, ##args )
630 #define GST_CAT_LOG(cat,args...)                GST_CAT_LEVEL_LOG (cat, GST_LEVEL_LOG,     NULL, ##args )
631
632 #define GST_ERROR_OBJECT(obj,args...)   GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_ERROR,   obj,  ##args )
633 #define GST_WARNING_OBJECT(obj,args...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_WARNING, obj,  ##args )
634 #define GST_INFO_OBJECT(obj,args...)    GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_INFO,    obj,  ##args )
635 #define GST_DEBUG_OBJECT(obj,args...)   GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_DEBUG,   obj,  ##args )
636 #define GST_LOG_OBJECT(obj,args...)     GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_LOG,     obj,  ##args )
637
638 #define GST_ERROR(args...)              GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_ERROR,   NULL, ##args )
639 #define GST_WARNING(args...)            GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_WARNING, NULL, ##args )
640 #define GST_INFO(args...)               GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_INFO,    NULL, ##args )
641 #define GST_DEBUG(args...)              GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_DEBUG,   NULL, ##args )
642 #define GST_LOG(args...)                GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_LOG,     NULL, ##args )
643
644 #else
645 /* no variadic macros, use inline */
646 static inline void
647 GST_CAT_ERROR_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
648     ...)
649 {
650   va_list varargs;
651
652   va_start (varargs, format);
653   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_ERROR, obj, format, varargs);
654   va_end (varargs);
655 }
656
657 static inline void
658 GST_CAT_WARNING_OBJECT (GstDebugCategory * cat, gpointer obj,
659     const char *format, ...)
660 {
661   va_list varargs;
662
663   va_start (varargs, format);
664   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_WARNING, obj, format, varargs);
665   va_end (varargs);
666 }
667
668 static inline void
669 GST_CAT_INFO_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
670     ...)
671 {
672   va_list varargs;
673
674   va_start (varargs, format);
675   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_INFO, obj, format, varargs);
676   va_end (varargs);
677 }
678
679 static inline void
680 GST_CAT_DEBUG_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
681     ...)
682 {
683   va_list varargs;
684
685   va_start (varargs, format);
686   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_DEBUG, obj, format, varargs);
687   va_end (varargs);
688 }
689
690 static inline void
691 GST_CAT_LOG_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
692     ...)
693 {
694   va_list varargs;
695
696   va_start (varargs, format);
697   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_LOG, obj, format, varargs);
698   va_end (varargs);
699 }
700
701 static inline void
702 GST_CAT_ERROR (GstDebugCategory * cat, const char *format, ...)
703 {
704   va_list varargs;
705
706   va_start (varargs, format);
707   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_ERROR, NULL, format, varargs);
708   va_end (varargs);
709 }
710
711 static inline void
712 GST_CAT_WARNING (GstDebugCategory * cat, const char *format, ...)
713 {
714   va_list varargs;
715
716   va_start (varargs, format);
717   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_WARNING, NULL, format, varargs);
718   va_end (varargs);
719 }
720
721 static inline void
722 GST_CAT_INFO (GstDebugCategory * cat, const char *format, ...)
723 {
724   va_list varargs;
725
726   va_start (varargs, format);
727   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_INFO, NULL, format, varargs);
728   va_end (varargs);
729 }
730
731 static inline void
732 GST_CAT_DEBUG (GstDebugCategory * cat, const char *format, ...)
733 {
734   va_list varargs;
735
736   va_start (varargs, format);
737   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_DEBUG, NULL, format, varargs);
738   va_end (varargs);
739 }
740
741 static inline void
742 GST_CAT_LOG (GstDebugCategory * cat, const char *format, ...)
743 {
744   va_list varargs;
745
746   va_start (varargs, format);
747   GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_LOG, NULL, format, varargs);
748   va_end (varargs);
749 }
750
751 static inline void
752 GST_ERROR_OBJECT (gpointer obj, const char *format, ...)
753 {
754   va_list varargs;
755
756   va_start (varargs, format);
757   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_ERROR, obj, format,
758       varargs);
759   va_end (varargs);
760 }
761
762 static inline void
763 GST_WARNING_OBJECT (gpointer obj, const char *format, ...)
764 {
765   va_list varargs;
766
767   va_start (varargs, format);
768   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_WARNING, obj, format,
769       varargs);
770   va_end (varargs);
771 }
772
773 static inline void
774 GST_INFO_OBJECT (gpointer obj, const char *format, ...)
775 {
776   va_list varargs;
777
778   va_start (varargs, format);
779   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_INFO, obj, format,
780       varargs);
781   va_end (varargs);
782 }
783
784 static inline void
785 GST_DEBUG_OBJECT (gpointer obj, const char *format, ...)
786 {
787   va_list varargs;
788
789   va_start (varargs, format);
790   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_DEBUG, obj, format,
791       varargs);
792   va_end (varargs);
793 }
794
795 static inline void
796 GST_LOG_OBJECT (gpointer obj, const char *format, ...)
797 {
798   va_list varargs;
799
800   va_start (varargs, format);
801   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_LOG, obj, format,
802       varargs);
803   va_end (varargs);
804 }
805
806 static inline void
807 GST_ERROR (const char *format, ...)
808 {
809   va_list varargs;
810
811   va_start (varargs, format);
812   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_ERROR, NULL, format,
813       varargs);
814   va_end (varargs);
815 }
816
817 static inline void
818 GST_WARNING (const char *format, ...)
819 {
820   va_list varargs;
821
822   va_start (varargs, format);
823   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_WARNING, NULL, format,
824       varargs);
825   va_end (varargs);
826 }
827
828 static inline void
829 GST_INFO (const char *format, ...)
830 {
831   va_list varargs;
832
833   va_start (varargs, format);
834   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_INFO, NULL, format,
835       varargs);
836   va_end (varargs);
837 }
838
839 static inline void
840 GST_DEBUG (const char *format, ...)
841 {
842   va_list varargs;
843
844   va_start (varargs, format);
845   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_DEBUG, NULL, format,
846       varargs);
847   va_end (varargs);
848 }
849
850 static inline void
851 GST_LOG (const char *format, ...)
852 {
853   va_list varargs;
854
855   va_start (varargs, format);
856   GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_LOG, NULL,
857       format, varargs);
858   va_end (varargs);
859 }
860 #endif
861 #endif
862
863
864 /********** function pointer stuff **********/
865
866 typedef void (* GstDebugFuncPtr)        (void);
867 void    _gst_debug_register_funcptr     (GstDebugFuncPtr        func,
868                                          gchar *                ptrname);
869 G_CONST_RETURN gchar *
870         _gst_debug_nameof_funcptr       (GstDebugFuncPtr        func);
871
872 /**
873  * GST_DEBUG_FUNCPTR:
874  * @ptr: pointer to the function to register
875  *
876  * Register a pointer to a function with its name, so it can later be used by
877  * GST_DEBUG_FUNCPTR_NAME().
878  */
879 #define GST_DEBUG_FUNCPTR(ptr) \
880   (_gst_debug_register_funcptr((GstDebugFuncPtr)(ptr), #ptr) , ptr)
881
882 /**
883  * GST_DEBUG_FUNCPTR_NAME:
884  * @ptr: pointer to the function to look up the name
885  *
886  * Retrieves the name of the function, if it was previously registered with
887  * GST_DEBUG_FUNCPTR(). If not, it returns a description of the pointer.
888  *
889  * Make sure you free the string after use.
890  */
891 #define GST_DEBUG_FUNCPTR_NAME(ptr) \
892   _gst_debug_nameof_funcptr((GstDebugFuncPtr)ptr)
893
894 #else /* GST_DISABLE_GST_DEBUG */
895
896 #if defined(__GNUC__) && __GNUC__ >= 3
897 #  pragma GCC poison gst_debug_log
898 #  pragma GCC poison gst_debug_log_valist
899 #  pragma GCC poison _gst_debug_category_new
900 #endif
901
902 #define _gst_debug_init()                               /* NOP */
903
904 #define gst_debug_set_default_threshold(level)          /* NOP */
905 #define gst_debug_get_default_threshold()               (GST_LEVEL_NONE)
906
907 #define gst_debug_level_get_name(level)                 ("NONE")
908 #define gst_debug_add_log_function(func,data)           /* NOP */
909 guint           gst_debug_remove_log_function   (GstLogFunction         func);
910 guint           gst_debug_remove_log_function_by_data (gpointer         data);
911 #define gst_debug_set_active(active)                    /* NOP */
912 #define gst_debug_is_active()                           (FALSE)
913 #define gst_debug_set_colored(colored)                  /* NOP */
914 #define gst_debug_is_colored()                          (FALSE)
915 #define gst_debug_set_default_threshold(level)          /* NOP */
916 #define gst_debug_get_default_threshold()               (GST_LEVEL_NONE)
917 #define gst_debug_set_threshold_for_name(name,level)    /* NOP */
918 #define gst_debug_unset_threshold_for_name(name)        /* NOP */
919
920 #define GST_DEBUG_CATEGORY(var)                         /* NOP */
921 #define GST_DEBUG_CATEGORY_EXTERN(var)                  /* NOP */
922 #if !defined(G_HAVE_GNUC_VARARGS) && !defined(G_HAVE_ISO_VARARGS)
923 #define GST_DEBUG_CATEGORY_STATIC(var)                  static GstDebugCategory *var = NULL
924 #else
925 #define GST_DEBUG_CATEGORY_STATIC(var)                  /* NOP */
926 #endif
927 #define GST_DEBUG_CATEGORY_INIT(var,name,color,desc)    /* NOP */
928 #define gst_debug_category_free(category)               /* NOP */
929 #define gst_debug_category_set_threshold(category,level) /* NOP */
930 #define gst_debug_category_reset_threshold(category)    /* NOP */
931 #define gst_debug_category_get_threshold(category)      (GST_LEVEL_NONE)
932 #define gst_debug_category_get_name(cat)                ("")
933 #define gst_debug_category_get_color(cat)               (0)
934 #define gst_debug_category_get_description(cat)         ("")
935 #define gst_debug_get_all_categories()                  (NULL)
936 #define gst_debug_construct_term_color(colorinfo)       (g_strdup ("00"))
937
938 #ifdef G_HAVE_ISO_VARARGS
939
940 #define GST_CAT_LEVEL_LOG(cat,level,...)                /* NOP */
941
942 #define GST_CAT_ERROR_OBJECT(...)                       /* NOP */
943 #define GST_CAT_WARNING_OBJECT(...)                     /* NOP */
944 #define GST_CAT_INFO_OBJECT(...)                        /* NOP */
945 #define GST_CAT_DEBUG_OBJECT(...)                       /* NOP */
946 #define GST_CAT_LOG_OBJECT(...)                         /* NOP */
947
948 #define GST_CAT_ERROR(...)                              /* NOP */
949 #define GST_CAT_WARNING(...)                            /* NOP */
950 #define GST_CAT_INFO(...)                               /* NOP */
951 #define GST_CAT_DEBUG(...)                              /* NOP */
952 #define GST_CAT_LOG(...)                                /* NOP */
953
954 #define GST_ERROR_OBJECT(...)                           /* NOP */
955 #define GST_WARNING_OBJECT(...)                         /* NOP */
956 #define GST_INFO_OBJECT(...)                            /* NOP */
957 #define GST_DEBUG_OBJECT(...)                           /* NOP */
958 #define GST_LOG_OBJECT(...)                             /* NOP */
959
960 #define GST_ERROR(...)                                  /* NOP */
961 #define GST_WARNING(...)                                /* NOP */
962 #define GST_INFO(...)                                   /* NOP */
963 #define GST_DEBUG(...)                                  /* NOP */
964 #define GST_LOG(...)                                    /* NOP */
965
966 #else
967 #ifdef G_HAVE_GNUC_VARARGS
968
969 #define GST_CAT_LEVEL_LOG(cat,level,args...)            /* NOP */
970
971 #define GST_CAT_ERROR_OBJECT(args...)                   /* NOP */
972 #define GST_CAT_WARNING_OBJECT(args...)                 /* NOP */
973 #define GST_CAT_INFO_OBJECT(args...)                    /* NOP */
974 #define GST_CAT_DEBUG_OBJECT(args...)                   /* NOP */
975 #define GST_CAT_LOG_OBJECT(args...)                     /* NOP */
976
977 #define GST_CAT_ERROR(args...)                          /* NOP */
978 #define GST_CAT_WARNING(args...)                        /* NOP */
979 #define GST_CAT_INFO(args...)                           /* NOP */
980 #define GST_CAT_DEBUG(args...)                          /* NOP */
981 #define GST_CAT_LOG(args...)                            /* NOP */
982
983 #define GST_ERROR_OBJECT(args...)                       /* NOP */
984 #define GST_WARNING_OBJECT(args...)                     /* NOP */
985 #define GST_INFO_OBJECT(args...)                        /* NOP */
986 #define GST_DEBUG_OBJECT(args...)                       /* NOP */
987 #define GST_LOG_OBJECT(args...)                         /* NOP */
988
989 #define GST_ERROR(args...)                              /* NOP */
990 #define GST_WARNING(args...)                            /* NOP */
991 #define GST_INFO(args...)                               /* NOP */
992 #define GST_DEBUG(args...)                              /* NOP */
993 #define GST_LOG(args...)                                /* NOP */
994
995 #else
996 static inline void
997 GST_CAT_LEVEL_LOG_valist (GstDebugCategory * cat,
998     GstDebugLevel level, gpointer object, const char *format, va_list varargs)
999 {
1000 }
1001
1002 static inline void
1003 GST_CAT_ERROR_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
1004     ...)
1005 {
1006 }
1007
1008 static inline void
1009 GST_CAT_WARNING_OBJECT (GstDebugCategory * cat, gpointer obj,
1010     const char *format, ...)
1011 {
1012 }
1013
1014 static inline void
1015 GST_CAT_INFO_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
1016     ...)
1017 {
1018 }
1019
1020 static inline void
1021 GST_CAT_DEBUG_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
1022     ...)
1023 {
1024 }
1025
1026 static inline void
1027 GST_CAT_LOG_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
1028     ...)
1029 {
1030 }
1031
1032 static inline void
1033 GST_CAT_ERROR (GstDebugCategory * cat, const char *format, ...)
1034 {
1035 }
1036
1037 static inline void
1038 GST_CAT_WARNING (GstDebugCategory * cat, const char *format, ...)
1039 {
1040 }
1041
1042 static inline void
1043 GST_CAT_INFO (GstDebugCategory * cat, const char *format, ...)
1044 {
1045 }
1046
1047 static inline void
1048 GST_CAT_DEBUG (GstDebugCategory * cat, const char *format, ...)
1049 {
1050 }
1051
1052 static inline void
1053 GST_CAT_LOG (GstDebugCategory * cat, const char *format, ...)
1054 {
1055 }
1056
1057 static inline void
1058 GST_ERROR_OBJECT (gpointer obj, const char *format, ...)
1059 {
1060 }
1061
1062 static inline void
1063 GST_WARNING_OBJECT (gpointer obj, const char *format, ...)
1064 {
1065 }
1066
1067 static inline void
1068 GST_INFO_OBJECT (gpointer obj, const char *format, ...)
1069 {
1070 }
1071
1072 static inline void
1073 GST_DEBUG_OBJECT (gpointer obj, const char *format, ...)
1074 {
1075 }
1076
1077 static inline void
1078 GST_LOG_OBJECT (gpointer obj, const char *format, ...)
1079 {
1080 }
1081
1082 static inline void
1083 GST_ERROR (const char *format, ...)
1084 {
1085 }
1086
1087 static inline void
1088 GST_WARNING (const char *format, ...)
1089 {
1090 }
1091
1092 static inline void
1093 GST_INFO (const char *format, ...)
1094 {
1095 }
1096
1097 static inline void
1098 GST_DEBUG (const char *format, ...)
1099 {
1100 }
1101
1102 static inline void
1103 GST_LOG (const char *format, ...)
1104 {
1105 }
1106 #endif
1107 #endif
1108
1109 #define GST_DEBUG_FUNCPTR(ptr) (ptr)
1110 #define GST_DEBUG_FUNCPTR_NAME(ptr) (g_strdup_printf ("%p", ptr))
1111
1112 #endif /* GST_DISABLE_GST_DEBUG */
1113
1114 void gst_debug_print_stack_trace (void);
1115
1116 G_END_DECLS
1117
1118 #endif /* __GSTINFO_H__ */