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