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>
6 * gstinfo.h: debugging functions
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.
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.
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.
28 #include <glib-object.h>
29 #include <gst/gstconfig.h>
32 #define M_PI 3.14159265358979323846
39 * @GST_LEVEL_NONE: No debugging level specified or desired. Used to deactivate
41 * @GST_LEVEL_ERROR: Error messages are to be used only when an error occured
42 * that stops the application from keeping working correctly.
43 * An examples is gst_element_error, which outputs a message with this priority.
44 * It does not mean that the application is terminating as with g_errror.
45 * @GST_LEVEL_WARNING: Warning messages are to inform about abnormal behaviour
46 * that could lead to problems or weird behaviour later on. An example of this
47 * would be clocking issues ("your computer is pretty slow") or broken input
48 * data ("Can't synchronize to stream.")
49 * @GST_LEVEL_INFO: Informational messages should be used to keep the developer
50 * updated about what is happening.
51 * Examples where this should be used are when a typefind function has
52 * successfully determined the type of the stream or when an mp3 plugin detects
53 * the format to be used. ("This file has mono sound.")
54 * @GST_LEVEL_DEBUG: Debugging messages should be used when something common
55 * happens that is not the expected default behavior.
56 * An example would be notifications about state changes or receiving/sending of
58 * @GST_LEVEL_LOG: Log messages are messages that are very common but might be
59 * useful to know. As a rule of thumb a pipeline that is iterating as expected
60 * should never output anzthing else but LOG messages.
61 * Examples for this are referencing/dereferencing of objects or cothread switches.
62 * @GST_LEVEL_COUNT: The number of defined debugging levels.
64 * The level defines the importance of a debugging message. The more important a
65 * message is, the greater the probability that the debugging system outputs it.
81 * Defines the default debugging level to be used with GStreamer. It is normally
82 * set to #GST_LEVEL_NONE so nothing get printed.
83 * As it can be configured at compile time, developer builds may chose to
84 * override that though.
85 * You can use this as an argument to gst_debug_set_default_threshold() to
86 * reset the debugging output to default behaviour.
88 #ifndef GST_LEVEL_DEFAULT
89 #define GST_LEVEL_DEFAULT GST_LEVEL_NONE
92 /* defines for format (colors etc)
93 * don't change them around, it uses terminal layout
94 * Terminal color strings:
95 * 00=none 01=bold 04=underscore 05=blink 07=reverse 08=concealed
97 * 30=black 31=red 32=green 33=yellow 34=blue 35=magenta 36=cyan 37=white
98 * Background color codes:
99 * 40=black 41=red 42=green 43=yellow 44=blue 45=magenta 46=cyan 47=white
102 * GstDebugColorFlags:
103 * @GST_DEBUG_FG_BLACK: Use black as foreground color.
104 * @GST_DEBUG_FG_RED: Use red as foreground color.
105 * @GST_DEBUG_FG_GREEN: Use green as foreground color.
106 * @GST_DEBUG_FG_YELLOW: Use yellow as foreground color.
107 * @GST_DEBUG_FG_BLUE: Use blue as foreground color.
108 * @GST_DEBUG_FG_MAGENTA: Use magenta as foreground color.
109 * @GST_DEBUG_FG_CYAN: Use cyan as foreground color.
110 * @GST_DEBUG_FG_WHITE: Use white as foreground color.
111 * @GST_DEBUG_BG_BLACK: Use black as background color.
112 * @GST_DEBUG_BG_RED: Use red as background color.
113 * @GST_DEBUG_BG_GREEN: Use green as background color.
114 * @GST_DEBUG_BG_YELLOW: Use yellow as background color.
115 * @GST_DEBUG_BG_BLUE: Use blue as background color.
116 * @GST_DEBUG_BG_MAGENTA: Use magenta as background color.
117 * @GST_DEBUG_BG_CYAN: Use cyan as background color.
118 * @GST_DEBUG_BG_WHITE: Use white as background color.
119 * @GST_DEBUG_BOLD: Make the output bold.
120 * @GST_DEBUG_UNDERLINE: Underline the output.
122 * These are some terminal style flags you can use when creating your
123 * debugging categories to make them stand out in debugging output.
127 GST_DEBUG_FG_BLACK = 0x0000,
128 GST_DEBUG_FG_RED = 0x0001,
129 GST_DEBUG_FG_GREEN = 0x0002,
130 GST_DEBUG_FG_YELLOW = 0x0003,
131 GST_DEBUG_FG_BLUE = 0x0004,
132 GST_DEBUG_FG_MAGENTA = 0x0005,
133 GST_DEBUG_FG_CYAN = 0x0006,
134 GST_DEBUG_FG_WHITE = 0x0007,
135 /* background colors */
136 GST_DEBUG_BG_BLACK = 0x0000,
137 GST_DEBUG_BG_RED = 0x0010,
138 GST_DEBUG_BG_GREEN = 0x0020,
139 GST_DEBUG_BG_YELLOW = 0x0030,
140 GST_DEBUG_BG_BLUE = 0x0040,
141 GST_DEBUG_BG_MAGENTA = 0x0050,
142 GST_DEBUG_BG_CYAN = 0x0060,
143 GST_DEBUG_BG_WHITE = 0x0070,
145 GST_DEBUG_BOLD = 0x0100,
146 GST_DEBUG_UNDERLINE = 0x0200
147 } GstDebugColorFlags;
149 #define GST_DEBUG_FG_MASK (0x000F)
150 #define GST_DEBUG_BG_MASK (0x00F0)
151 #define GST_DEBUG_FORMAT_MASK (0xFF00)
153 typedef struct _GstDebugCategory GstDebugCategory;
157 * This is the struct that describes the categories. Once initialized with
158 * #GST_DEBUG_CATEGORY_INIT, its values can't be changed anymore.
160 struct _GstDebugCategory {
163 guint color; /* see defines above */
166 const gchar * description;
169 /********** some convenience macros for debugging **********/
173 * @str: The string to check.
175 * Macro to use when a string must not be NULL, but may be NULL. If the string
176 * is NULL, "(NULL)" is printed instead.
177 * In GStreamer printf string arguments may not be NULL, because on some
178 * platforms (ie Solaris) the libc crashes in that case. This includes debugging
181 #define GST_STR_NULL(str) ((str) ? (str) : "(NULL)")
183 /* FIXME, not MT safe */
185 * GST_DEBUG_PAD_NAME:
186 * @pad: The pad to debug.
188 * Evaluates to 2 strings, that describe the pad. Often used in debugging
191 #define GST_DEBUG_PAD_NAME(pad) \
193 ((GST_OBJECT_PARENT(pad) != NULL) ? \
194 GST_STR_NULL (GST_OBJECT_NAME (GST_OBJECT_PARENT(pad))) : \
196 (pad != NULL) ? GST_STR_NULL (GST_OBJECT_NAME (pad)) : "''"
201 * This macro should evaluate to the name of the current function and be should
202 * be defined when configuring your project, as it is compiler dependant. If it
203 * is not defined, some default value is used. It is used to provide debugging
204 * output with the function name of the message.
206 * Note that this is different from G_STRFUNC as we do not want the full
207 * function signature in C++ code.
210 #if defined (__GNUC__) || (defined (_MSC_VER) && _MSC_VER >= 1300)
211 # define GST_FUNCTION ((const char*) (__FUNCTION__))
212 #elif defined (G_HAVE_ISO_VARARGS)
213 # define GST_FUNCTION ((const char*) (__func__))
215 # define GST_FUNCTION ((const char*) ("???"))
217 #endif /* ifndef GST_FUNCTION */
220 typedef struct _GstDebugMessage GstDebugMessage;
224 * @category: a #GstDebugCategory
225 * @level: a #GstDebugLevel
227 * @function: function name
229 * @object: a #GObject
230 * @message: the message
231 * @data: user data for the log function
233 * Function prototype for a logging function that can be registered with
234 * gst_debug_add_log_function().
235 * Use G_GNUC_NO_INSTRUMENT on that function.
237 typedef void (*GstLogFunction) (GstDebugCategory * category,
240 const gchar * function,
243 GstDebugMessage * message,
246 #ifndef GST_DISABLE_GST_DEBUG
248 /* FIXME 0.11: move this into private headers */
249 void _gst_debug_init (void);
252 #ifdef GST_USING_PRINTF_EXTENSION
254 /* not using G_GNUC_PRINTF, since gcc will choke on GST_PTR_FORMAT being %P */
255 void gst_debug_log (GstDebugCategory * category,
258 const gchar * function,
261 const gchar * format,
262 ...) G_GNUC_NO_INSTRUMENT;
264 #else /* GST_USING_PRINTF_EXTENSION */
266 void gst_debug_log (GstDebugCategory * category,
269 const gchar * function,
272 const gchar * format,
273 ...) G_GNUC_PRINTF (7, 8) G_GNUC_NO_INSTRUMENT;
275 #endif /* GST_USING_PRINTF_EXTENSION */
277 void gst_debug_log_valist (GstDebugCategory * category,
280 const gchar * function,
283 const gchar * format,
284 va_list args) G_GNUC_NO_INSTRUMENT;
286 const gchar * gst_debug_message_get (GstDebugMessage * message);
288 void gst_debug_log_default (GstDebugCategory * category,
291 const gchar * function,
294 GstDebugMessage * message,
295 gpointer unused) G_GNUC_NO_INSTRUMENT;
297 G_CONST_RETURN gchar *
298 gst_debug_level_get_name (GstDebugLevel level);
300 void gst_debug_add_log_function (GstLogFunction func,
302 guint gst_debug_remove_log_function (GstLogFunction func);
303 guint gst_debug_remove_log_function_by_data (gpointer data);
305 void gst_debug_set_active (gboolean active);
306 gboolean gst_debug_is_active (void);
308 void gst_debug_set_colored (gboolean colored);
309 gboolean gst_debug_is_colored (void);
311 void gst_debug_set_default_threshold (GstDebugLevel level);
312 GstDebugLevel gst_debug_get_default_threshold (void);
313 void gst_debug_set_threshold_for_name (const gchar * name,
314 GstDebugLevel level);
315 void gst_debug_unset_threshold_for_name (const gchar * name);
318 * GST_DEBUG_CATEGORY:
321 * Defines a GstDebugCategory variable.
322 * This macro expands to nothing if debugging is disabled.
324 #define GST_DEBUG_CATEGORY(cat) GstDebugCategory *cat = NULL
326 * GST_DEBUG_CATEGORY_EXTERN:
329 * Declares a GstDebugCategory variable as extern. Use in header files.
330 * This macro expands to nothing if debugging is disabled.
332 #define GST_DEBUG_CATEGORY_EXTERN(cat) extern GstDebugCategory *cat
335 * GST_DEBUG_CATEGORY_STATIC:
338 * Defines a static GstDebugCategory variable.
339 * This macro expands to nothing if debugging is disabled.
341 #define GST_DEBUG_CATEGORY_STATIC(cat) static GstDebugCategory *cat = NULL
342 /* do not use this function, use the macros below */
343 GstDebugCategory *_gst_debug_category_new (const gchar * name,
345 const gchar * description);
347 * GST_DEBUG_CATEGORY_INIT:
348 * @cat: the category to initialize.
349 * @name: the name of the category.
350 * @color: the colors to use for a color representation or 0 for no color.
351 * @description: optional description of the category.
353 * Initializes a new #GstDebugCategory with the given properties and set to
354 * the default threshold.
358 * This macro expands to nothing if debugging is disabled.
361 * When naming your category, please follow the following conventions to ensure
362 * that the pattern matching for categories works as expected. It is not
363 * earth-shattering if you don't follow these conventions, but it would be nice
367 * If you define a category for a plugin or a feature of it, name the category
368 * like the feature. So if you wanted to write a "filesrc" element, you would
369 * name the category "filesrc". Use lowercase letters only.
370 * If you define more than one category for the same element, append an
371 * underscore and an identifier to your categories, like this: "filesrc_cache"
374 * If you create a library or an application using debugging categories, use a
375 * common prefix followed by an underscore for all your categories. GStreamer
376 * uses the GST prefix so GStreamer categories look like "GST_STATES". Be sure
377 * to include uppercase letters.
381 #define GST_DEBUG_CATEGORY_INIT(cat,name,color,description) G_STMT_START{\
383 cat = _gst_debug_category_new (name,color,description); \
386 void gst_debug_category_free (GstDebugCategory * category);
387 void gst_debug_category_set_threshold (GstDebugCategory * category,
388 GstDebugLevel level);
389 void gst_debug_category_reset_threshold(GstDebugCategory * category);
391 gst_debug_category_get_threshold (GstDebugCategory * category);
392 G_CONST_RETURN gchar *
393 gst_debug_category_get_name (GstDebugCategory * category);
394 guint gst_debug_category_get_color (GstDebugCategory * category);
395 G_CONST_RETURN gchar *
396 gst_debug_category_get_description (GstDebugCategory * category);
398 gst_debug_get_all_categories (void);
400 gchar * gst_debug_construct_term_color (guint colorinfo);
406 * Default gstreamer core debug log category. Please define your own.
408 GST_EXPORT GstDebugCategory * GST_CAT_DEFAULT;
409 /* this symbol may not be used */
410 extern gboolean __gst_debug_enabled;
412 /* since 0.10.7, the min debug level, used for quickly discarding debug
413 * messages that fall under the threshold. */
414 GST_EXPORT GstDebugLevel __gst_debug_min;
418 * @cat: category to use
419 * @level: the severity of the message
420 * @object: the #GObject the message belongs to or NULL if none
421 * @...: A printf-style message to output
423 * Outputs a debugging message. This is the most general macro for outputting
424 * debugging messages. You will probably want to use one of the ones described
427 #ifdef G_HAVE_ISO_VARARGS
428 #define GST_CAT_LEVEL_LOG(cat,level,object,...) G_STMT_START{ \
429 if (G_UNLIKELY (level <= __gst_debug_min)) { \
430 gst_debug_log ((cat), (level), __FILE__, GST_FUNCTION, __LINE__, \
431 (GObject *) (object), __VA_ARGS__); \
434 #else /* G_HAVE_GNUC_VARARGS */
435 #ifdef G_HAVE_GNUC_VARARGS
436 #define GST_CAT_LEVEL_LOG(cat,level,object,args...) G_STMT_START{ \
437 if (G_UNLIKELY (level <= __gst_debug_min)) { \
438 gst_debug_log ((cat), (level), __FILE__, GST_FUNCTION, __LINE__, \
439 (GObject *) (object), ##args ); \
442 #else /* no variadic macros, use inline */
444 GST_CAT_LEVEL_LOG_valist (GstDebugCategory * cat,
445 GstDebugLevel level, gpointer object, const char *format, va_list varargs)
447 if (G_UNLIKELY (level <= __gst_debug_min)) {
448 gst_debug_log_valist (cat, level, "", "", 0, (GObject *) object, format,
454 GST_CAT_LEVEL_LOG (GstDebugCategory * cat, GstDebugLevel level,
455 gpointer object, const char *format, ...)
459 va_start (varargs, format);
460 GST_CAT_LEVEL_LOG_valist (cat, level, object, format, varargs);
464 #endif /* G_HAVE_ISO_VARARGS */
467 * GST_CAT_ERROR_OBJECT:
468 * @cat: category to use
469 * @obj: the #GObject the message belongs to
470 * @...: printf-style message to output
472 * Output an error message belonging to the given object in the given category.
475 * GST_CAT_WARNING_OBJECT:
476 * @cat: category to use
477 * @obj: the #GObject the message belongs to
478 * @...: printf-style message to output
480 * Output a warning message belonging to the given object in the given category.
483 * GST_CAT_INFO_OBJECT:
484 * @cat: category to use
485 * @obj: the #GObject the message belongs to
486 * @...: printf-style message to output
488 * Output an informational message belonging to the given object in the given
492 * GST_CAT_DEBUG_OBJECT:
493 * @cat: category to use
494 * @obj: the #GObject the message belongs to
495 * @...: printf-style message to output
497 * Output an debugging message belonging to the given object in the given category.
500 * GST_CAT_LOG_OBJECT:
501 * @cat: category to use
502 * @obj: the #GObject the message belongs to
503 * @...: printf-style message to output
505 * Output an logging message belonging to the given object in the given category.
511 * @cat: category to use
512 * @...: printf-style message to output
514 * Output an error message in the given category.
518 * @cat: category to use
519 * @...: printf-style message to output
521 * Output an warning message in the given category.
525 * @cat: category to use
526 * @...: printf-style message to output
528 * Output an informational message in the given category.
532 * @cat: category to use
533 * @...: printf-style message to output
535 * Output an debugging message in the given category.
539 * @cat: category to use
540 * @...: printf-style message to output
542 * Output an logging message in the given category.
548 * @obj: the #GObject the message belongs to
549 * @...: printf-style message to output
551 * Output an error message belonging to the given object in the default category.
554 * GST_WARNING_OBJECT:
555 * @obj: the #GObject the message belongs to
556 * @...: printf-style message to output
558 * Output a warning message belonging to the given object in the default category.
562 * @obj: the #GObject the message belongs to
563 * @...: printf-style message to output
565 * Output an informational message belonging to the given object in the default
570 * @obj: the #GObject the message belongs to
571 * @...: printf-style message to output
573 * Output a debugging message belonging to the given object in the default
578 * @obj: the #GObject the message belongs to
579 * @...: printf-style message to output
581 * Output a logging message belonging to the given object in the default category.
587 * @...: printf-style message to output
589 * Output an error message in the default category.
593 * @...: printf-style message to output
595 * Output a warning message in the default category.
599 * @...: printf-style message to output
601 * Output an informational message in the default category.
605 * @...: printf-style message to output
607 * Output a debugging message in the default category.
611 * @...: printf-style message to output
613 * Output a logging message in the default category.
616 #ifdef G_HAVE_ISO_VARARGS
618 #define GST_CAT_ERROR_OBJECT(cat,obj,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_ERROR, obj, __VA_ARGS__)
619 #define GST_CAT_WARNING_OBJECT(cat,obj,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_WARNING, obj, __VA_ARGS__)
620 #define GST_CAT_INFO_OBJECT(cat,obj,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_INFO, obj, __VA_ARGS__)
621 #define GST_CAT_DEBUG_OBJECT(cat,obj,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_DEBUG, obj, __VA_ARGS__)
622 #define GST_CAT_LOG_OBJECT(cat,obj,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_LOG, obj, __VA_ARGS__)
624 #define GST_CAT_ERROR(cat,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_ERROR, NULL, __VA_ARGS__)
625 #define GST_CAT_WARNING(cat,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_WARNING, NULL, __VA_ARGS__)
626 #define GST_CAT_INFO(cat,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_INFO, NULL, __VA_ARGS__)
627 #define GST_CAT_DEBUG(cat,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_DEBUG, NULL, __VA_ARGS__)
628 #define GST_CAT_LOG(cat,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_LOG, NULL, __VA_ARGS__)
630 #define GST_ERROR_OBJECT(obj,...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_ERROR, obj, __VA_ARGS__)
631 #define GST_WARNING_OBJECT(obj,...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_WARNING, obj, __VA_ARGS__)
632 #define GST_INFO_OBJECT(obj,...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_INFO, obj, __VA_ARGS__)
633 #define GST_DEBUG_OBJECT(obj,...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_DEBUG, obj, __VA_ARGS__)
634 #define GST_LOG_OBJECT(obj,...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_LOG, obj, __VA_ARGS__)
636 #define GST_ERROR(...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_ERROR, NULL, __VA_ARGS__)
637 #define GST_WARNING(...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_WARNING, NULL, __VA_ARGS__)
638 #define GST_INFO(...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_INFO, NULL, __VA_ARGS__)
639 #define GST_DEBUG(...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_DEBUG, NULL, __VA_ARGS__)
640 #define GST_LOG(...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_LOG, NULL, __VA_ARGS__)
643 #ifdef G_HAVE_GNUC_VARARGS
645 #define GST_CAT_ERROR_OBJECT(cat,obj,args...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_ERROR, obj, ##args )
646 #define GST_CAT_WARNING_OBJECT(cat,obj,args...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_WARNING, obj, ##args )
647 #define GST_CAT_INFO_OBJECT(cat,obj,args...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_INFO, obj, ##args )
648 #define GST_CAT_DEBUG_OBJECT(cat,obj,args...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_DEBUG, obj, ##args )
649 #define GST_CAT_LOG_OBJECT(cat,obj,args...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_LOG, obj, ##args )
651 #define GST_CAT_ERROR(cat,args...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_ERROR, NULL, ##args )
652 #define GST_CAT_WARNING(cat,args...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_WARNING, NULL, ##args )
653 #define GST_CAT_INFO(cat,args...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_INFO, NULL, ##args )
654 #define GST_CAT_DEBUG(cat,args...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_DEBUG, NULL, ##args )
655 #define GST_CAT_LOG(cat,args...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_LOG, NULL, ##args )
657 #define GST_ERROR_OBJECT(obj,args...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_ERROR, obj, ##args )
658 #define GST_WARNING_OBJECT(obj,args...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_WARNING, obj, ##args )
659 #define GST_INFO_OBJECT(obj,args...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_INFO, obj, ##args )
660 #define GST_DEBUG_OBJECT(obj,args...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_DEBUG, obj, ##args )
661 #define GST_LOG_OBJECT(obj,args...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_LOG, obj, ##args )
663 #define GST_ERROR(args...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_ERROR, NULL, ##args )
664 #define GST_WARNING(args...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_WARNING, NULL, ##args )
665 #define GST_INFO(args...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_INFO, NULL, ##args )
666 #define GST_DEBUG(args...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_DEBUG, NULL, ##args )
667 #define GST_LOG(args...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_LOG, NULL, ##args )
670 /* no variadic macros, use inline */
672 GST_CAT_ERROR_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
677 va_start (varargs, format);
678 GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_ERROR, obj, format, varargs);
683 GST_CAT_WARNING_OBJECT (GstDebugCategory * cat, gpointer obj,
684 const char *format, ...)
688 va_start (varargs, format);
689 GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_WARNING, obj, format, varargs);
694 GST_CAT_INFO_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
699 va_start (varargs, format);
700 GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_INFO, obj, format, varargs);
705 GST_CAT_DEBUG_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
710 va_start (varargs, format);
711 GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_DEBUG, obj, format, varargs);
716 GST_CAT_LOG_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
721 va_start (varargs, format);
722 GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_LOG, obj, format, varargs);
727 GST_CAT_ERROR (GstDebugCategory * cat, const char *format, ...)
731 va_start (varargs, format);
732 GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_ERROR, NULL, format, varargs);
737 GST_CAT_WARNING (GstDebugCategory * cat, const char *format, ...)
741 va_start (varargs, format);
742 GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_WARNING, NULL, format, varargs);
747 GST_CAT_INFO (GstDebugCategory * cat, const char *format, ...)
751 va_start (varargs, format);
752 GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_INFO, NULL, format, varargs);
757 GST_CAT_DEBUG (GstDebugCategory * cat, const char *format, ...)
761 va_start (varargs, format);
762 GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_DEBUG, NULL, format, varargs);
767 GST_CAT_LOG (GstDebugCategory * cat, const char *format, ...)
771 va_start (varargs, format);
772 GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_LOG, NULL, format, varargs);
777 GST_ERROR_OBJECT (gpointer obj, const char *format, ...)
781 va_start (varargs, format);
782 GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_ERROR, obj, format,
788 GST_WARNING_OBJECT (gpointer obj, const char *format, ...)
792 va_start (varargs, format);
793 GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_WARNING, obj, format,
799 GST_INFO_OBJECT (gpointer obj, const char *format, ...)
803 va_start (varargs, format);
804 GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_INFO, obj, format,
810 GST_DEBUG_OBJECT (gpointer obj, const char *format, ...)
814 va_start (varargs, format);
815 GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_DEBUG, obj, format,
821 GST_LOG_OBJECT (gpointer obj, const char *format, ...)
825 va_start (varargs, format);
826 GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_LOG, obj, format,
832 GST_ERROR (const char *format, ...)
836 va_start (varargs, format);
837 GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_ERROR, NULL, format,
843 GST_WARNING (const char *format, ...)
847 va_start (varargs, format);
848 GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_WARNING, NULL, format,
854 GST_INFO (const char *format, ...)
858 va_start (varargs, format);
859 GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_INFO, NULL, format,
865 GST_DEBUG (const char *format, ...)
869 va_start (varargs, format);
870 GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_DEBUG, NULL, format,
876 GST_LOG (const char *format, ...)
880 va_start (varargs, format);
881 GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_LOG, NULL,
889 /********** function pointer stuff **********/
891 typedef void (* GstDebugFuncPtr) (void);
892 void _gst_debug_register_funcptr (GstDebugFuncPtr func,
893 const gchar * ptrname);
894 G_CONST_RETURN gchar *
895 _gst_debug_nameof_funcptr (GstDebugFuncPtr func);
899 * @ptr: pointer to the function to register
901 * Register a pointer to a function with its name, so it can later be used by
902 * GST_DEBUG_FUNCPTR_NAME().
904 #define GST_DEBUG_FUNCPTR(ptr) \
905 (_gst_debug_register_funcptr((GstDebugFuncPtr)(ptr), #ptr) , ptr)
908 * GST_DEBUG_FUNCPTR_NAME:
909 * @ptr: address of the function of which to look up the name
911 * Retrieves the name of the function, if it was previously registered with
912 * GST_DEBUG_FUNCPTR(). If not, it returns a description of the pointer.
914 * This macro returns a constant string which must not be modified or
915 * freed by the caller.
917 #define GST_DEBUG_FUNCPTR_NAME(ptr) \
918 _gst_debug_nameof_funcptr((GstDebugFuncPtr)ptr)
921 #else /* GST_DISABLE_GST_DEBUG */
924 #if defined(__GNUC__) && __GNUC__ >= 3
925 # pragma GCC poison gst_debug_log
926 # pragma GCC poison gst_debug_log_valist
927 # pragma GCC poison _gst_debug_category_new
930 #define _gst_debug_init() /* NOP */
932 #define gst_debug_set_default_threshold(level) /* NOP */
933 #define gst_debug_get_default_threshold() (GST_LEVEL_NONE)
935 #define gst_debug_level_get_name(level) ("NONE")
936 #define gst_debug_message_get(message) ("NONE")
937 #define gst_debug_add_log_function(func,data) /* NOP */
938 guint gst_debug_remove_log_function (GstLogFunction func);
939 guint gst_debug_remove_log_function_by_data (gpointer data);
940 #define gst_debug_set_active(active) /* NOP */
941 #define gst_debug_is_active() (FALSE)
942 #define gst_debug_set_colored(colored) /* NOP */
943 #define gst_debug_is_colored() (FALSE)
944 #define gst_debug_set_default_threshold(level) /* NOP */
945 #define gst_debug_get_default_threshold() (GST_LEVEL_NONE)
946 #define gst_debug_set_threshold_for_name(name,level) /* NOP */
947 #define gst_debug_unset_threshold_for_name(name) /* NOP */
949 #define GST_DEBUG_CATEGORY(var) /* NOP */
950 #define GST_DEBUG_CATEGORY_EXTERN(var) /* NOP */
951 #if !defined(G_HAVE_GNUC_VARARGS) && !defined(G_HAVE_ISO_VARARGS)
952 #define GST_DEBUG_CATEGORY_STATIC(var) static GstDebugCategory *var = NULL
954 #define GST_DEBUG_CATEGORY_STATIC(var) /* NOP */
956 #define GST_DEBUG_CATEGORY_INIT(var,name,color,desc) /* NOP */
957 #define gst_debug_category_free(category) /* NOP */
958 #define gst_debug_category_set_threshold(category,level) /* NOP */
959 #define gst_debug_category_reset_threshold(category) /* NOP */
960 #define gst_debug_category_get_threshold(category) (GST_LEVEL_NONE)
961 #define gst_debug_category_get_name(cat) ("")
962 #define gst_debug_category_get_color(cat) (0)
963 #define gst_debug_category_get_description(cat) ("")
964 #define gst_debug_get_all_categories() (NULL)
965 #define gst_debug_construct_term_color(colorinfo) (g_strdup ("00"))
967 #ifdef G_HAVE_ISO_VARARGS
969 #define GST_CAT_LEVEL_LOG(cat,level,...) /* NOP */
971 #define GST_CAT_ERROR_OBJECT(...) /* NOP */
972 #define GST_CAT_WARNING_OBJECT(...) /* NOP */
973 #define GST_CAT_INFO_OBJECT(...) /* NOP */
974 #define GST_CAT_DEBUG_OBJECT(...) /* NOP */
975 #define GST_CAT_LOG_OBJECT(...) /* NOP */
977 #define GST_CAT_ERROR(...) /* NOP */
978 #define GST_CAT_WARNING(...) /* NOP */
979 #define GST_CAT_INFO(...) /* NOP */
980 #define GST_CAT_DEBUG(...) /* NOP */
981 #define GST_CAT_LOG(...) /* NOP */
983 #define GST_ERROR_OBJECT(...) /* NOP */
984 #define GST_WARNING_OBJECT(...) /* NOP */
985 #define GST_INFO_OBJECT(...) /* NOP */
986 #define GST_DEBUG_OBJECT(...) /* NOP */
987 #define GST_LOG_OBJECT(...) /* NOP */
989 #define GST_ERROR(...) /* NOP */
990 #define GST_WARNING(...) /* NOP */
991 #define GST_INFO(...) /* NOP */
992 #define GST_DEBUG(...) /* NOP */
993 #define GST_LOG(...) /* NOP */
996 #ifdef G_HAVE_GNUC_VARARGS
998 #define GST_CAT_LEVEL_LOG(cat,level,args...) /* NOP */
1000 #define GST_CAT_ERROR_OBJECT(args...) /* NOP */
1001 #define GST_CAT_WARNING_OBJECT(args...) /* NOP */
1002 #define GST_CAT_INFO_OBJECT(args...) /* NOP */
1003 #define GST_CAT_DEBUG_OBJECT(args...) /* NOP */
1004 #define GST_CAT_LOG_OBJECT(args...) /* NOP */
1006 #define GST_CAT_ERROR(args...) /* NOP */
1007 #define GST_CAT_WARNING(args...) /* NOP */
1008 #define GST_CAT_INFO(args...) /* NOP */
1009 #define GST_CAT_DEBUG(args...) /* NOP */
1010 #define GST_CAT_LOG(args...) /* NOP */
1012 #define GST_ERROR_OBJECT(args...) /* NOP */
1013 #define GST_WARNING_OBJECT(args...) /* NOP */
1014 #define GST_INFO_OBJECT(args...) /* NOP */
1015 #define GST_DEBUG_OBJECT(args...) /* NOP */
1016 #define GST_LOG_OBJECT(args...) /* NOP */
1018 #define GST_ERROR(args...) /* NOP */
1019 #define GST_WARNING(args...) /* NOP */
1020 #define GST_INFO(args...) /* NOP */
1021 #define GST_DEBUG(args...) /* NOP */
1022 #define GST_LOG(args...) /* NOP */
1026 GST_CAT_LEVEL_LOG_valist (GstDebugCategory * cat,
1027 GstDebugLevel level, gpointer object, const char *format, va_list varargs)
1032 GST_CAT_ERROR_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
1038 GST_CAT_WARNING_OBJECT (GstDebugCategory * cat, gpointer obj,
1039 const char *format, ...)
1044 GST_CAT_INFO_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
1050 GST_CAT_DEBUG_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
1056 GST_CAT_LOG_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
1062 GST_CAT_ERROR (GstDebugCategory * cat, const char *format, ...)
1067 GST_CAT_WARNING (GstDebugCategory * cat, const char *format, ...)
1072 GST_CAT_INFO (GstDebugCategory * cat, const char *format, ...)
1077 GST_CAT_DEBUG (GstDebugCategory * cat, const char *format, ...)
1082 GST_CAT_LOG (GstDebugCategory * cat, const char *format, ...)
1087 GST_ERROR_OBJECT (gpointer obj, const char *format, ...)
1092 GST_WARNING_OBJECT (gpointer obj, const char *format, ...)
1097 GST_INFO_OBJECT (gpointer obj, const char *format, ...)
1102 GST_DEBUG_OBJECT (gpointer obj, const char *format, ...)
1107 GST_LOG_OBJECT (gpointer obj, const char *format, ...)
1112 GST_ERROR (const char *format, ...)
1117 GST_WARNING (const char *format, ...)
1122 GST_INFO (const char *format, ...)
1127 GST_DEBUG (const char *format, ...)
1132 GST_LOG (const char *format, ...)
1138 #define GST_DEBUG_FUNCPTR(ptr) (ptr)
1139 #define GST_DEBUG_FUNCPTR_NAME(ptr) (g_strdup_printf ("%p", ptr))
1141 #endif /* GST_DISABLE_GST_DEBUG */
1144 void gst_debug_print_stack_trace (void);
1148 #endif /* __GSTINFO_H__ */