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 * Copyright (C) 2008-2009 Tim-Philipp Müller <tim centricular net>
7 * gstinfo.c: debugging functions
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Library General Public
11 * License as published by the Free Software Foundation; either
12 * version 2 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Library General Public License for more details.
19 * You should have received a copy of the GNU Library General Public
20 * License along with this library; if not, write to the
21 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
22 * Boston, MA 02110-1301, USA.
27 * @short_description: Debugging and logging facilities
28 * @see_also: #gst-running for command line parameters
29 * and environment variables that affect the debugging output.
31 * GStreamer's debugging subsystem is an easy way to get information about what
32 * the application is doing. It is not meant for programming errors. Use GLib
33 * methods (g_warning and friends) for that.
35 * The debugging subsystem works only after GStreamer has been initialized
36 * - for example by calling gst_init().
38 * The debugging subsystem is used to log informational messages while the
39 * application runs. Each messages has some properties attached to it. Among
40 * these properties are the debugging category, the severity (called "level"
41 * here) and an optional #GObject it belongs to. Each of these messages is sent
42 * to all registered debugging handlers, which then handle the messages.
43 * GStreamer attaches a default handler on startup, which outputs requested
46 * Messages are output by using shortcut macros like #GST_DEBUG,
47 * #GST_CAT_ERROR_OBJECT or similar. These all expand to calling gst_debug_log()
48 * with the right parameters.
49 * The only thing a developer will probably want to do is define his own
50 * categories. This is easily done with 3 lines. At the top of your code,
52 * the variables and set the default category.
54 * GST_DEBUG_CATEGORY_STATIC (my_category); // define category (statically)
55 * #define GST_CAT_DEFAULT my_category // set as default
57 * After that you only need to initialize the category.
59 * GST_DEBUG_CATEGORY_INIT (my_category, "my category",
60 * 0, "This is my very own");
62 * Initialization must be done before the category is used first.
64 * in their plugin_init function, libraries and applications should do that
65 * during their initialization.
67 * The whole debugging subsystem can be disabled at build time with passing the
68 * --disable-gst-debug switch to configure. If this is done, every function,
69 * macro and even structs described in this file evaluate to default values or
71 * So don't take addresses of these functions or use other tricks.
72 * If you must do that for some reason, there is still an option.
74 * subsystem was compiled out, #GST_DISABLE_GST_DEBUG is defined in
76 * so you can check that before doing your trick.
77 * Disabling the debugging subsystem will give you a slight (read: unnoticeable)
78 * speed increase and will reduce the size of your compiled code. The GStreamer
79 * library itself becomes around 10% smaller.
81 * Please note that there are naming conventions for the names of debugging
82 * categories. These are explained at GST_DEBUG_CATEGORY_INIT().
86 #include "gst_private.h"
89 #undef gst_debug_remove_log_function
90 #undef gst_debug_add_log_function
92 #ifndef GST_DISABLE_GST_DEBUG
97 #include <stdio.h> /* fprintf */
98 #include <glib/gstdio.h>
101 # include <unistd.h> /* getpid on UNIX */
103 #ifdef HAVE_PROCESS_H
104 # include <process.h> /* getpid on win32 */
106 #include <string.h> /* G_VA_COPY */
108 # define WIN32_LEAN_AND_MEAN /* prevents from including too many things */
109 # include <windows.h> /* GetStdHandle, windows console */
112 #include "gst_private.h"
113 #include "gstutils.h"
114 #include "gstquark.h"
115 #include "gstsegment.h"
116 #include "gstvalue.h"
117 #include "gstcapsfeatures.h"
119 #ifdef HAVE_VALGRIND_VALGRIND_H
120 # include <valgrind/valgrind.h>
122 #include <glib/gprintf.h> /* g_sprintf */
124 /* our own printf implementation with custom extensions to %p for caps etc. */
125 #include "printf/printf.h"
126 #include "printf/printf-extension.h"
128 static char *gst_info_printf_pointer_extension_func (const char *format,
131 #endif /* !GST_DISABLE_GST_DEBUG */
133 extern gboolean gst_is_initialized (void);
135 /* we want these symbols exported even if debug is disabled, to maintain
136 * ABI compatibility. Unless GST_REMOVE_DISABLED is defined. */
137 #if !defined(GST_DISABLE_GST_DEBUG) || !defined(GST_REMOVE_DISABLED)
139 /* disabled by default, as soon as some threshold is set > NONE,
140 * it becomes enabled. */
141 gboolean _gst_debug_enabled = FALSE;
142 GstDebugLevel _gst_debug_min = GST_LEVEL_NONE;
144 GstDebugCategory *GST_CAT_DEFAULT = NULL;
146 GstDebugCategory *GST_CAT_GST_INIT = NULL;
147 GstDebugCategory *GST_CAT_MEMORY = NULL;
148 GstDebugCategory *GST_CAT_PARENTAGE = NULL;
149 GstDebugCategory *GST_CAT_STATES = NULL;
150 GstDebugCategory *GST_CAT_SCHEDULING = NULL;
152 GstDebugCategory *GST_CAT_BUFFER = NULL;
153 GstDebugCategory *GST_CAT_BUFFER_LIST = NULL;
154 GstDebugCategory *GST_CAT_BUS = NULL;
155 GstDebugCategory *GST_CAT_CAPS = NULL;
156 GstDebugCategory *GST_CAT_CLOCK = NULL;
157 GstDebugCategory *GST_CAT_ELEMENT_PADS = NULL;
158 GstDebugCategory *GST_CAT_PADS = NULL;
159 GstDebugCategory *GST_CAT_PERFORMANCE = NULL;
160 GstDebugCategory *GST_CAT_PIPELINE = NULL;
161 GstDebugCategory *GST_CAT_PLUGIN_LOADING = NULL;
162 GstDebugCategory *GST_CAT_PLUGIN_INFO = NULL;
163 GstDebugCategory *GST_CAT_PROPERTIES = NULL;
164 GstDebugCategory *GST_CAT_NEGOTIATION = NULL;
165 GstDebugCategory *GST_CAT_REFCOUNTING = NULL;
166 GstDebugCategory *GST_CAT_ERROR_SYSTEM = NULL;
167 GstDebugCategory *GST_CAT_EVENT = NULL;
168 GstDebugCategory *GST_CAT_MESSAGE = NULL;
169 GstDebugCategory *GST_CAT_PARAMS = NULL;
170 GstDebugCategory *GST_CAT_CALL_TRACE = NULL;
171 GstDebugCategory *GST_CAT_SIGNAL = NULL;
172 GstDebugCategory *GST_CAT_PROBE = NULL;
173 GstDebugCategory *GST_CAT_REGISTRY = NULL;
174 GstDebugCategory *GST_CAT_QOS = NULL;
175 GstDebugCategory *_priv_GST_CAT_POLL = NULL;
176 GstDebugCategory *GST_CAT_META = NULL;
177 GstDebugCategory *GST_CAT_LOCKING = NULL;
178 GstDebugCategory *GST_CAT_CONTEXT = NULL;
179 GstDebugCategory *_priv_GST_CAT_PROTECTION = NULL;
182 #endif /* !defined(GST_DISABLE_GST_DEBUG) || !defined(GST_REMOVE_DISABLED) */
184 #ifndef GST_DISABLE_GST_DEBUG
186 /* underscore is to prevent conflict with GST_CAT_DEBUG define */
187 GST_DEBUG_CATEGORY_STATIC (_GST_CAT_DEBUG);
189 /* time of initialization, so we get useful debugging output times
190 * FIXME: we use this in gstdebugutils.c, what about a function + macro to
191 * get the running time: GST_DEBUG_RUNNING_TIME
193 GstClockTime _priv_gst_info_start_time;
197 #include <rld_interface.h>
198 typedef struct DL_INFO
200 const char *dli_fname;
202 const char *dli_sname;
206 long dli_reserved[4];
210 #define _RLD_DLADDR 14
211 int dladdr (void *address, Dl_info * dl);
214 dladdr (void *address, Dl_info * dl)
218 v = _rld_new_interface (_RLD_DLADDR, address, dl);
224 #if defined(USE_DLOG)
228 static void gst_debug_reset_threshold (gpointer category, gpointer unused);
229 static void gst_debug_reset_all_thresholds (void);
231 struct _GstDebugMessage
238 /* list of all name/level pairs from --gst-debug and GST_DEBUG */
239 static GMutex __level_name_mutex;
240 static GSList *__level_name = NULL;
248 /* list of all categories */
249 static GMutex __cat_mutex;
250 static GSList *__categories = NULL;
252 static GstDebugCategory *_gst_debug_get_category_locked (const gchar * name);
255 /* all registered debug handlers */
260 GDestroyNotify notify;
263 static GMutex __log_func_mutex;
264 static GSList *__log_functions = NULL;
266 #define PRETTY_TAGS_DEFAULT TRUE
267 static gboolean pretty_tags = PRETTY_TAGS_DEFAULT;
269 static volatile gint G_GNUC_MAY_ALIAS __default_level = GST_LEVEL_DEFAULT;
270 static volatile gint G_GNUC_MAY_ALIAS __use_color = GST_DEBUG_COLOR_MODE_ON;
272 /* FIXME: export this? */
274 _priv_gst_in_valgrind (void)
282 in_valgrind = GST_VG_UNCHECKED;
284 if (in_valgrind == GST_VG_UNCHECKED) {
285 #ifdef HAVE_VALGRIND_VALGRIND_H
286 if (RUNNING_ON_VALGRIND) {
287 GST_CAT_INFO (GST_CAT_GST_INIT, "we're running inside valgrind");
288 in_valgrind = GST_VG_INSIDE;
290 GST_CAT_LOG (GST_CAT_GST_INIT, "not doing extra valgrind stuff");
291 in_valgrind = GST_VG_NO_VALGRIND;
294 in_valgrind = GST_VG_NO_VALGRIND;
296 g_assert (in_valgrind == GST_VG_NO_VALGRIND ||
297 in_valgrind == GST_VG_INSIDE);
299 return (in_valgrind == GST_VG_INSIDE);
302 /* Initialize the debugging system */
304 _priv_gst_debug_init (void)
309 env = g_getenv ("GST_DEBUG_FILE");
310 if (env != NULL && *env != '\0') {
311 if (strcmp (env, "-") == 0) {
314 log_file = g_fopen (env, "w");
315 if (log_file == NULL) {
316 g_printerr ("Could not open log file '%s' for writing: %s\n", env,
325 /* get time we started for debugging messages */
326 _priv_gst_info_start_time = gst_util_get_timestamp ();
328 __gst_printf_pointer_extension_set_func
329 (gst_info_printf_pointer_extension_func);
331 /* do NOT use a single debug function before this line has been run */
332 GST_CAT_DEFAULT = _gst_debug_category_new ("default",
333 GST_DEBUG_UNDERLINE, NULL);
334 _GST_CAT_DEBUG = _gst_debug_category_new ("GST_DEBUG",
335 GST_DEBUG_BOLD | GST_DEBUG_FG_YELLOW, "debugging subsystem");
337 gst_debug_add_log_function (gst_debug_log_default, log_file, NULL);
339 /* FIXME: add descriptions here */
340 GST_CAT_GST_INIT = _gst_debug_category_new ("GST_INIT",
341 GST_DEBUG_BOLD | GST_DEBUG_FG_RED, NULL);
342 GST_CAT_MEMORY = _gst_debug_category_new ("GST_MEMORY",
343 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, "memory");
344 GST_CAT_PARENTAGE = _gst_debug_category_new ("GST_PARENTAGE",
345 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
346 GST_CAT_STATES = _gst_debug_category_new ("GST_STATES",
347 GST_DEBUG_BOLD | GST_DEBUG_FG_RED, NULL);
348 GST_CAT_SCHEDULING = _gst_debug_category_new ("GST_SCHEDULING",
349 GST_DEBUG_BOLD | GST_DEBUG_FG_MAGENTA, NULL);
350 GST_CAT_BUFFER = _gst_debug_category_new ("GST_BUFFER",
351 GST_DEBUG_BOLD | GST_DEBUG_BG_GREEN, NULL);
352 GST_CAT_BUFFER_LIST = _gst_debug_category_new ("GST_BUFFER_LIST",
353 GST_DEBUG_BOLD | GST_DEBUG_BG_GREEN, NULL);
354 GST_CAT_BUS = _gst_debug_category_new ("GST_BUS", GST_DEBUG_BG_YELLOW, NULL);
355 GST_CAT_CAPS = _gst_debug_category_new ("GST_CAPS",
356 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
357 GST_CAT_CLOCK = _gst_debug_category_new ("GST_CLOCK",
358 GST_DEBUG_BOLD | GST_DEBUG_FG_YELLOW, NULL);
359 GST_CAT_ELEMENT_PADS = _gst_debug_category_new ("GST_ELEMENT_PADS",
360 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
361 GST_CAT_PADS = _gst_debug_category_new ("GST_PADS",
362 GST_DEBUG_BOLD | GST_DEBUG_FG_RED | GST_DEBUG_BG_RED, NULL);
363 GST_CAT_PERFORMANCE = _gst_debug_category_new ("GST_PERFORMANCE",
364 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
365 GST_CAT_PIPELINE = _gst_debug_category_new ("GST_PIPELINE",
366 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
367 GST_CAT_PLUGIN_LOADING = _gst_debug_category_new ("GST_PLUGIN_LOADING",
368 GST_DEBUG_BOLD | GST_DEBUG_FG_CYAN, NULL);
369 GST_CAT_PLUGIN_INFO = _gst_debug_category_new ("GST_PLUGIN_INFO",
370 GST_DEBUG_BOLD | GST_DEBUG_FG_CYAN, NULL);
371 GST_CAT_PROPERTIES = _gst_debug_category_new ("GST_PROPERTIES",
372 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_BLUE, NULL);
373 GST_CAT_NEGOTIATION = _gst_debug_category_new ("GST_NEGOTIATION",
374 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
375 GST_CAT_REFCOUNTING = _gst_debug_category_new ("GST_REFCOUNTING",
376 GST_DEBUG_BOLD | GST_DEBUG_FG_RED | GST_DEBUG_BG_BLUE, NULL);
377 GST_CAT_ERROR_SYSTEM = _gst_debug_category_new ("GST_ERROR_SYSTEM",
378 GST_DEBUG_BOLD | GST_DEBUG_FG_RED | GST_DEBUG_BG_WHITE, NULL);
380 GST_CAT_EVENT = _gst_debug_category_new ("GST_EVENT",
381 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
382 GST_CAT_MESSAGE = _gst_debug_category_new ("GST_MESSAGE",
383 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
384 GST_CAT_PARAMS = _gst_debug_category_new ("GST_PARAMS",
385 GST_DEBUG_BOLD | GST_DEBUG_FG_BLACK | GST_DEBUG_BG_YELLOW, NULL);
386 GST_CAT_CALL_TRACE = _gst_debug_category_new ("GST_CALL_TRACE",
387 GST_DEBUG_BOLD, NULL);
388 GST_CAT_SIGNAL = _gst_debug_category_new ("GST_SIGNAL",
389 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
390 GST_CAT_PROBE = _gst_debug_category_new ("GST_PROBE",
391 GST_DEBUG_BOLD | GST_DEBUG_FG_GREEN, "pad probes");
392 GST_CAT_REGISTRY = _gst_debug_category_new ("GST_REGISTRY", 0, "registry");
393 GST_CAT_QOS = _gst_debug_category_new ("GST_QOS", 0, "QoS");
394 _priv_GST_CAT_POLL = _gst_debug_category_new ("GST_POLL", 0, "poll");
395 GST_CAT_META = _gst_debug_category_new ("GST_META", 0, "meta");
396 GST_CAT_LOCKING = _gst_debug_category_new ("GST_LOCKING", 0, "locking");
397 GST_CAT_CONTEXT = _gst_debug_category_new ("GST_CONTEXT", 0, NULL);
398 _priv_GST_CAT_PROTECTION =
399 _gst_debug_category_new ("GST_PROTECTION", 0, "protection");
401 /* print out the valgrind message if we're in valgrind */
402 _priv_gst_in_valgrind ();
404 env = g_getenv ("GST_DEBUG_OPTIONS");
406 if (strstr (env, "full_tags") || strstr (env, "full-tags"))
408 else if (strstr (env, "pretty_tags") || strstr (env, "pretty-tags"))
412 if (g_getenv ("GST_DEBUG_NO_COLOR") != NULL)
413 gst_debug_set_color_mode (GST_DEBUG_COLOR_MODE_OFF);
414 env = g_getenv ("GST_DEBUG_COLOR_MODE");
416 gst_debug_set_color_mode_from_string (env);
418 env = g_getenv ("GST_DEBUG");
420 gst_debug_set_threshold_from_string (env, FALSE);
424 /* we can't do this further above, because we initialize the GST_CAT_DEFAULT struct */
425 #define GST_CAT_DEFAULT _GST_CAT_DEBUG
429 * @category: category to log
430 * @level: level of the message is in
431 * @file: the file that emitted the message, usually the __FILE__ identifier
432 * @function: the function that emitted the message
433 * @line: the line from that the message was emitted, usually __LINE__
434 * @object: (transfer none) (allow-none): the object this message relates to,
436 * @format: a printf style format string
437 * @...: optional arguments for the format
439 * Logs the given message using the currently registered debugging handlers.
442 gst_debug_log (GstDebugCategory * category, GstDebugLevel level,
443 const gchar * file, const gchar * function, gint line,
444 GObject * object, const gchar * format, ...)
448 va_start (var_args, format);
449 gst_debug_log_valist (category, level, file, function, line, object, format,
454 /* based on g_basename(), which we can't use because it was deprecated */
455 static inline const gchar *
456 gst_path_basename (const gchar * file_name)
458 register const gchar *base;
460 base = strrchr (file_name, G_DIR_SEPARATOR);
463 const gchar *q = strrchr (file_name, '/');
464 if (base == NULL || (q != NULL && q > base))
471 if (g_ascii_isalpha (file_name[0]) && file_name[1] == ':')
472 return file_name + 2;
478 * gst_debug_log_valist:
479 * @category: category to log
480 * @level: level of the message is in
481 * @file: the file that emitted the message, usually the __FILE__ identifier
482 * @function: the function that emitted the message
483 * @line: the line from that the message was emitted, usually __LINE__
484 * @object: (transfer none) (allow-none): the object this message relates to,
486 * @format: a printf style format string
487 * @args: optional arguments for the format
489 * Logs the given message using the currently registered debugging handlers.
492 gst_debug_log_valist (GstDebugCategory * category, GstDebugLevel level,
493 const gchar * file, const gchar * function, gint line,
494 GObject * object, const gchar * format, va_list args)
496 GstDebugMessage message;
500 g_return_if_fail (category != NULL);
502 if (level > gst_debug_category_get_threshold (category))
505 g_return_if_fail (file != NULL);
506 g_return_if_fail (function != NULL);
507 g_return_if_fail (format != NULL);
509 message.message = NULL;
510 message.format = format;
511 G_VA_COPY (message.arguments, args);
513 handler = __log_functions;
515 entry = handler->data;
516 handler = g_slist_next (handler);
517 entry->func (category, level, file, function, line, object, &message,
520 g_free (message.message);
521 va_end (message.arguments);
525 * gst_debug_message_get:
526 * @message: a debug message
528 * Gets the string representation of a #GstDebugMessage. This function is used
529 * in debug handlers to extract the message.
531 * Returns: the string representation of a #GstDebugMessage.
534 gst_debug_message_get (GstDebugMessage * message)
536 if (message->message == NULL) {
539 len = __gst_vasprintf (&message->message, message->format,
543 message->message = NULL;
545 return message->message;
548 #define MAX_BUFFER_DUMP_STRING_LEN 100
550 /* structure_to_pretty_string:
551 * @str: a serialized #GstStructure
553 * If the serialized structure contains large buffers such as images the hex
554 * representation of those buffers will be shortened so that the string remains
557 * Returns: the filtered string
560 prettify_structure_string (gchar * str)
562 gchar *pos = str, *end;
564 while ((pos = strstr (pos, "(buffer)"))) {
567 pos += strlen ("(buffer)");
568 for (end = pos; *end != '\0' && *end != ';' && *end != ' '; ++end)
570 if (count > MAX_BUFFER_DUMP_STRING_LEN) {
571 memcpy (pos + MAX_BUFFER_DUMP_STRING_LEN - 6, "..", 2);
572 memcpy (pos + MAX_BUFFER_DUMP_STRING_LEN - 4, pos + count - 4, 4);
573 memmove (pos + MAX_BUFFER_DUMP_STRING_LEN, pos + count,
574 strlen (pos + count) + 1);
575 pos += MAX_BUFFER_DUMP_STRING_LEN;
582 static inline gchar *
583 gst_info_structure_to_string (const GstStructure * s)
586 gchar *str = gst_structure_to_string (s);
587 if (G_UNLIKELY (pretty_tags && s->name == GST_QUARK (TAGLIST)))
588 return prettify_structure_string (str);
595 static inline gchar *
596 gst_info_describe_buffer (GstBuffer * buffer)
598 const gchar *offset_str = "none";
599 const gchar *offset_end_str = "none";
600 gchar offset_buf[32], offset_end_buf[32];
602 if (GST_BUFFER_OFFSET_IS_VALID (buffer)) {
603 g_snprintf (offset_buf, sizeof (offset_buf), "%" G_GUINT64_FORMAT,
604 GST_BUFFER_OFFSET (buffer));
605 offset_str = offset_buf;
607 if (GST_BUFFER_OFFSET_END_IS_VALID (buffer)) {
608 g_snprintf (offset_end_buf, sizeof (offset_end_buf), "%" G_GUINT64_FORMAT,
609 GST_BUFFER_OFFSET_END (buffer));
610 offset_end_str = offset_end_buf;
613 return g_strdup_printf ("buffer: %p, pts %" GST_TIME_FORMAT ", dts %"
614 GST_TIME_FORMAT ", dur %" GST_TIME_FORMAT ", size %" G_GSIZE_FORMAT
615 ", offset %s, offset_end %s, flags 0x%x", buffer,
616 GST_TIME_ARGS (GST_BUFFER_PTS (buffer)),
617 GST_TIME_ARGS (GST_BUFFER_DTS (buffer)),
618 GST_TIME_ARGS (GST_BUFFER_DURATION (buffer)),
619 gst_buffer_get_size (buffer), offset_str, offset_end_str,
620 GST_BUFFER_FLAGS (buffer));
623 static inline gchar *
624 gst_info_describe_event (GstEvent * event)
628 s = gst_info_structure_to_string (gst_event_get_structure (event));
629 ret = g_strdup_printf ("%s event: %p, time %" GST_TIME_FORMAT
630 ", seq-num %d, %s", GST_EVENT_TYPE_NAME (event), event,
631 GST_TIME_ARGS (GST_EVENT_TIMESTAMP (event)), GST_EVENT_SEQNUM (event),
637 static inline gchar *
638 gst_info_describe_message (GstMessage * message)
642 s = gst_info_structure_to_string (gst_message_get_structure (message));
643 ret = g_strdup_printf ("%s message: %p, time %" GST_TIME_FORMAT
644 ", seq-num %d, element '%s', %s", GST_MESSAGE_TYPE_NAME (message),
645 message, GST_TIME_ARGS (GST_MESSAGE_TIMESTAMP (message)),
646 GST_MESSAGE_SEQNUM (message),
647 ((message->src) ? GST_ELEMENT_NAME (message->src) : "(NULL)"),
653 static inline gchar *
654 gst_info_describe_query (GstQuery * query)
658 s = gst_info_structure_to_string (gst_query_get_structure (query));
659 ret = g_strdup_printf ("%s query: %p, %s", GST_QUERY_TYPE_NAME (query),
660 query, (s ? s : "(NULL)"));
666 gst_debug_print_object (gpointer ptr)
668 GObject *object = (GObject *) ptr;
671 /* This is a cute trick to detect unmapped memory, but is unportable,
672 * slow, screws around with madvise, and not actually that useful. */
676 ret = madvise ((void *) ((unsigned long) ptr & (~0xfff)), 4096, 0);
677 if (ret == -1 && errno == ENOMEM) {
678 buffer = g_strdup_printf ("%p (unmapped memory)", ptr);
683 /* nicely printed object */
684 if (object == NULL) {
685 return g_strdup ("(NULL)");
687 if (GST_IS_CAPS (ptr)) {
688 return gst_caps_to_string ((const GstCaps *) ptr);
690 if (GST_IS_STRUCTURE (ptr)) {
691 return gst_info_structure_to_string ((const GstStructure *) ptr);
693 if (*(GType *) ptr == GST_TYPE_CAPS_FEATURES) {
694 return gst_caps_features_to_string ((const GstCapsFeatures *) ptr);
696 if (GST_IS_TAG_LIST (ptr)) {
697 gchar *str = gst_tag_list_to_string ((GstTagList *) ptr);
698 if (G_UNLIKELY (pretty_tags))
699 return prettify_structure_string (str);
703 if (*(GType *) ptr == GST_TYPE_DATE_TIME) {
704 return __gst_date_time_serialize ((GstDateTime *) ptr, TRUE);
706 if (GST_IS_BUFFER (ptr)) {
707 return gst_info_describe_buffer (GST_BUFFER_CAST (ptr));
710 if (*(guint32 *) ptr == 0xffffffff) {
711 return g_strdup_printf ("<poisoned@%p>", ptr);
714 if (GST_IS_MESSAGE (object)) {
715 return gst_info_describe_message (GST_MESSAGE_CAST (object));
717 if (GST_IS_QUERY (object)) {
718 return gst_info_describe_query (GST_QUERY_CAST (object));
720 if (GST_IS_EVENT (object)) {
721 return gst_info_describe_event (GST_EVENT_CAST (object));
723 if (GST_IS_CONTEXT (object)) {
724 GstContext *context = GST_CONTEXT_CAST (object);
727 const GstStructure *structure;
729 type = gst_context_get_context_type (context);
730 structure = gst_context_get_structure (context);
732 s = gst_info_structure_to_string (structure);
734 ret = g_strdup_printf ("context '%s'='%s'", type, s);
738 if (GST_IS_PAD (object) && GST_OBJECT_NAME (object)) {
739 return g_strdup_printf ("<%s:%s>", GST_DEBUG_PAD_NAME (object));
741 if (GST_IS_OBJECT (object) && GST_OBJECT_NAME (object)) {
742 return g_strdup_printf ("<%s>", GST_OBJECT_NAME (object));
744 if (G_IS_OBJECT (object)) {
745 return g_strdup_printf ("<%s@%p>", G_OBJECT_TYPE_NAME (object), object);
748 return g_strdup_printf ("%p", ptr);
752 gst_debug_print_segment (gpointer ptr)
754 GstSegment *segment = (GstSegment *) ptr;
756 /* nicely printed segment */
757 if (segment == NULL) {
758 return g_strdup ("(NULL)");
761 switch (segment->format) {
762 case GST_FORMAT_UNDEFINED:{
763 return g_strdup_printf ("UNDEFINED segment");
765 case GST_FORMAT_TIME:{
766 return g_strdup_printf ("time segment start=%" GST_TIME_FORMAT
767 ", offset=%" GST_TIME_FORMAT ", stop=%" GST_TIME_FORMAT
768 ", rate=%f, applied_rate=%f" ", flags=0x%02x, time=%" GST_TIME_FORMAT
769 ", base=%" GST_TIME_FORMAT ", position %" GST_TIME_FORMAT
770 ", duration %" GST_TIME_FORMAT, GST_TIME_ARGS (segment->start),
771 GST_TIME_ARGS (segment->offset), GST_TIME_ARGS (segment->stop),
772 segment->rate, segment->applied_rate, (guint) segment->flags,
773 GST_TIME_ARGS (segment->time), GST_TIME_ARGS (segment->base),
774 GST_TIME_ARGS (segment->position), GST_TIME_ARGS (segment->duration));
777 const gchar *format_name;
779 format_name = gst_format_get_name (segment->format);
780 if (G_UNLIKELY (format_name == NULL))
781 format_name = "(UNKNOWN FORMAT)";
782 return g_strdup_printf ("%s segment start=%" G_GINT64_FORMAT
783 ", offset=%" G_GINT64_FORMAT ", stop=%" G_GINT64_FORMAT
784 ", rate=%f, applied_rate=%f" ", flags=0x%02x, time=%" G_GINT64_FORMAT
785 ", base=%" G_GINT64_FORMAT ", position %" G_GINT64_FORMAT
786 ", duration %" G_GINT64_FORMAT, format_name, segment->start,
787 segment->offset, segment->stop, segment->rate, segment->applied_rate,
788 (guint) segment->flags, segment->time, segment->base,
789 segment->position, segment->duration);
795 gst_info_printf_pointer_extension_func (const char *format, void *ptr)
799 if (format[0] == 'p' && format[1] == '\a') {
801 case 'A': /* GST_PTR_FORMAT */
802 s = gst_debug_print_object (ptr);
804 case 'B': /* GST_SEGMENT_FORMAT */
805 s = gst_debug_print_segment (ptr);
808 /* must have been compiled against a newer version with an extension
809 * we don't known about yet - just ignore and fallback to %p below */
814 s = g_strdup_printf ("%p", ptr);
820 * gst_debug_construct_term_color:
821 * @colorinfo: the color info
823 * Constructs a string that can be used for getting the desired color in color
825 * You need to free the string after use.
827 * Returns: (transfer full) (type gchar*): a string containing the color
831 gst_debug_construct_term_color (guint colorinfo)
835 color = g_string_new ("\033[00");
837 if (colorinfo & GST_DEBUG_BOLD) {
838 g_string_append_len (color, ";01", 3);
840 if (colorinfo & GST_DEBUG_UNDERLINE) {
841 g_string_append_len (color, ";04", 3);
843 if (colorinfo & GST_DEBUG_FG_MASK) {
844 g_string_append_printf (color, ";3%1d", colorinfo & GST_DEBUG_FG_MASK);
846 if (colorinfo & GST_DEBUG_BG_MASK) {
847 g_string_append_printf (color, ";4%1d",
848 (colorinfo & GST_DEBUG_BG_MASK) >> 4);
850 g_string_append_c (color, 'm');
852 return g_string_free (color, FALSE);
856 * gst_debug_construct_win_color:
857 * @colorinfo: the color info
859 * Constructs an integer that can be used for getting the desired color in
860 * windows' terminals (cmd.exe). As there is no mean to underline, we simply
861 * ignore this attribute.
863 * This function returns 0 on non-windows machines.
865 * Returns: an integer containing the color definition
868 gst_debug_construct_win_color (guint colorinfo)
872 static const guchar ansi_to_win_fg[8] = {
874 FOREGROUND_RED, /* red */
875 FOREGROUND_GREEN, /* green */
876 FOREGROUND_RED | FOREGROUND_GREEN, /* yellow */
877 FOREGROUND_BLUE, /* blue */
878 FOREGROUND_RED | FOREGROUND_BLUE, /* magenta */
879 FOREGROUND_GREEN | FOREGROUND_BLUE, /* cyan */
880 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE /* white */
882 static const guchar ansi_to_win_bg[8] = {
886 BACKGROUND_RED | BACKGROUND_GREEN,
888 BACKGROUND_RED | BACKGROUND_BLUE,
889 BACKGROUND_GREEN | FOREGROUND_BLUE,
890 BACKGROUND_RED | BACKGROUND_GREEN | BACKGROUND_BLUE
893 /* we draw black as white, as cmd.exe can only have black bg */
894 if ((colorinfo & (GST_DEBUG_FG_MASK | GST_DEBUG_BG_MASK)) == 0) {
895 color = ansi_to_win_fg[7];
897 if (colorinfo & GST_DEBUG_UNDERLINE) {
898 color |= BACKGROUND_INTENSITY;
900 if (colorinfo & GST_DEBUG_BOLD) {
901 color |= FOREGROUND_INTENSITY;
903 if (colorinfo & GST_DEBUG_FG_MASK) {
904 color |= ansi_to_win_fg[colorinfo & GST_DEBUG_FG_MASK];
906 if (colorinfo & GST_DEBUG_BG_MASK) {
907 color |= ansi_to_win_bg[(colorinfo & GST_DEBUG_BG_MASK) >> 4];
913 /* width of %p varies depending on actual value of pointer, which can make
914 * output unevenly aligned if multiple threads are involved, hence the %14p
915 * (should really be %18p, but %14p seems a good compromise between too many
916 * white spaces and likely unalignment on my system) */
917 #if defined (GLIB_SIZEOF_VOID_P) && GLIB_SIZEOF_VOID_P == 8
918 #define PTR_FMT "%14p"
920 #define PTR_FMT "%10p"
922 #define PID_FMT "%5d"
923 #define CAT_FMT "%20s %s:%d:%s:%s"
926 static const guchar levelcolormap_w32[GST_LEVEL_COUNT] = {
928 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE,
929 /* GST_LEVEL_ERROR */
930 FOREGROUND_RED | FOREGROUND_INTENSITY,
931 /* GST_LEVEL_WARNING */
932 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_INTENSITY,
934 FOREGROUND_GREEN | FOREGROUND_INTENSITY,
935 /* GST_LEVEL_DEBUG */
936 FOREGROUND_GREEN | FOREGROUND_BLUE,
938 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE,
939 /* GST_LEVEL_FIXME */
940 FOREGROUND_RED | FOREGROUND_GREEN,
941 /* GST_LEVEL_TRACE */
942 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE,
943 /* placeholder for log level 8 */
945 /* GST_LEVEL_MEMDUMP */
946 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE
949 static const guchar available_colors[] = {
950 FOREGROUND_RED, FOREGROUND_GREEN, FOREGROUND_RED | FOREGROUND_GREEN,
951 FOREGROUND_BLUE, FOREGROUND_RED | FOREGROUND_BLUE,
952 FOREGROUND_GREEN | FOREGROUND_BLUE,
954 #endif /* G_OS_WIN32 */
955 static const gchar *levelcolormap[GST_LEVEL_COUNT] = {
956 "\033[37m", /* GST_LEVEL_NONE */
957 "\033[31;01m", /* GST_LEVEL_ERROR */
958 "\033[33;01m", /* GST_LEVEL_WARNING */
959 "\033[32;01m", /* GST_LEVEL_INFO */
960 "\033[36m", /* GST_LEVEL_DEBUG */
961 "\033[37m", /* GST_LEVEL_LOG */
962 "\033[33;01m", /* GST_LEVEL_FIXME */
963 "\033[37m", /* GST_LEVEL_TRACE */
964 "\033[37m", /* placeholder for log level 8 */
965 "\033[37m" /* GST_LEVEL_MEMDUMP */
969 * gst_debug_log_default:
970 * @category: category to log
971 * @level: level of the message
972 * @file: the file that emitted the message, usually the __FILE__ identifier
973 * @function: the function that emitted the message
974 * @line: the line from that the message was emitted, usually __LINE__
975 * @message: the actual message
976 * @object: (transfer none) (allow-none): the object this message relates to,
978 * @user_data: the FILE* to log to
980 * The default logging handler used by GStreamer. Logging functions get called
981 * whenever a macro like GST_DEBUG or similar is used. By default this function
982 * is setup to output the message and additional info to stderr (or the log file
983 * specified via the GST_DEBUG_FILE environment variable) as received via
986 * You can add other handlers by using gst_debug_add_log_function().
987 * And you can remove this handler by calling
988 * gst_debug_remove_log_function(gst_debug_log_default);
991 gst_debug_log_default (GstDebugCategory * category, GstDebugLevel level,
992 const gchar * file, const gchar * function, gint line,
993 GObject * object, GstDebugMessage * message, gpointer user_data)
996 GstClockTime elapsed;
998 GstDebugColorMode color_mode;
999 FILE *log_file = user_data ? user_data : stderr;
1002 /* __FILE__ might be a file name or an absolute path or a
1003 * relative path, irrespective of the exact compiler used,
1004 * in which case we want to shorten it to the filename for
1007 if (c == '.' || c == '/' || c == '\\' || (c != '\0' && file[1] == ':')) {
1008 file = gst_path_basename (file);
1012 color_mode = gst_debug_get_color_mode ();
1015 obj = gst_debug_print_object (object);
1020 elapsed = GST_CLOCK_DIFF (_priv_gst_info_start_time,
1021 gst_util_get_timestamp ());
1023 if (color_mode != GST_DEBUG_COLOR_MODE_OFF) {
1025 /* We take a lock to keep colors and content together.
1026 * Maybe there is a better way but for now this will do the right
1028 static GMutex win_print_mutex;
1029 g_mutex_lock (&win_print_mutex);
1030 if (color_mode == GST_DEBUG_COLOR_MODE_UNIX) {
1032 /* colors, non-windows */
1033 gchar *color = NULL;
1036 const gchar *levelcolor;
1038 color = gst_debug_construct_term_color (gst_debug_category_get_color
1041 g_sprintf (pidcolor, "\033[3%1dm", pid % 6 + 31);
1042 levelcolor = levelcolormap[level];
1044 #define PRINT_FMT " %s"PID_FMT"%s "PTR_FMT" %s%s%s %s"CAT_FMT"%s %s\n"
1046 #if defined(USE_DLOG)
1047 SLOG(LOG_WARN, "GST_LOG",
1048 "%" GST_TIME_FORMAT PRINT_FMT, GST_TIME_ARGS (elapsed),
1049 pidcolor, pid, clear, g_thread_self (), levelcolor,
1050 gst_debug_level_get_name (level), clear, color,
1051 gst_debug_category_get_name (category), file, line, function, obj,
1052 clear, gst_debug_message_get (message));
1054 fprintf (log_file, "%" GST_TIME_FORMAT PRINT_FMT, GST_TIME_ARGS (elapsed),
1055 pidcolor, pid, clear, g_thread_self (), levelcolor,
1056 gst_debug_level_get_name (level), clear, color,
1057 gst_debug_category_get_name (category), file, line, function, obj,
1058 clear, gst_debug_message_get (message));
1066 /* colors, windows. */
1067 const gint clear = FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE;
1068 #define SET_COLOR(c) G_STMT_START { \
1069 if (log_file == stderr) \
1070 SetConsoleTextAttribute (GetStdHandle (STD_ERROR_HANDLE), (c)); \
1073 fprintf (log_file, "%" GST_TIME_FORMAT " ", GST_TIME_ARGS (elapsed));
1076 SET_COLOR (available_colors[pid % G_N_ELEMENTS (available_colors)]);
1077 fprintf (log_file, PID_FMT, pid);
1081 fprintf (log_file, " " PTR_FMT " ", g_thread_self ());
1084 SET_COLOR (levelcolormap_w32[level]);
1085 fprintf (log_file, "%s ", gst_debug_level_get_name (level));
1088 SET_COLOR (gst_debug_construct_win_color (gst_debug_category_get_color
1090 fprintf (log_file, CAT_FMT, gst_debug_category_get_name (category),
1091 file, line, function, obj);
1095 fprintf (log_file, " %s\n", gst_debug_message_get (message));
1098 g_mutex_unlock (&win_print_mutex);
1101 /* no color, all platforms */
1102 #define PRINT_FMT " "PID_FMT" "PTR_FMT" %s "CAT_FMT" %s\n"
1104 /* Tizen doesn't care about Win32 */
1105 #if defined(USG_DLOG) && !defined(G_OS_WIN32)
1106 SLOG(LOG_WARN, "GST_LOG",
1107 "%" GST_TIME_FORMAT PRINT_FMT, GST_TIME_ARGS (elapsed),
1108 pid, g_thread_self (), gst_debug_level_get_name (level),
1109 gst_debug_category_get_name (category), file, line, function, obj,
1110 gst_debug_message_get (message));
1112 fprintf (log_file, "%" GST_TIME_FORMAT PRINT_FMT, GST_TIME_ARGS (elapsed),
1113 pid, g_thread_self (), gst_debug_level_get_name (level),
1114 gst_debug_category_get_name (category), file, line, function, obj,
1115 gst_debug_message_get (message));
1127 * gst_debug_level_get_name:
1128 * @level: the level to get the name for
1130 * Get the string representation of a debugging level
1135 gst_debug_level_get_name (GstDebugLevel level)
1138 case GST_LEVEL_NONE:
1140 case GST_LEVEL_ERROR:
1142 case GST_LEVEL_WARNING:
1144 case GST_LEVEL_INFO:
1146 case GST_LEVEL_DEBUG:
1150 case GST_LEVEL_FIXME:
1152 case GST_LEVEL_TRACE:
1154 case GST_LEVEL_MEMDUMP:
1157 g_warning ("invalid level specified for gst_debug_level_get_name");
1163 * gst_debug_add_log_function:
1164 * @func: the function to use
1165 * @user_data: user data
1166 * @notify: called when @user_data is not used anymore
1168 * Adds the logging function to the list of logging functions.
1169 * Be sure to use #G_GNUC_NO_INSTRUMENT on that function, it is needed.
1172 gst_debug_add_log_function (GstLogFunction func, gpointer user_data,
1173 GDestroyNotify notify)
1175 LogFuncEntry *entry;
1179 func = gst_debug_log_default;
1181 entry = g_slice_new (LogFuncEntry);
1183 entry->user_data = user_data;
1184 entry->notify = notify;
1185 /* FIXME: we leak the old list here - other threads might access it right now
1186 * in gst_debug_logv. Another solution is to lock the mutex in gst_debug_logv,
1187 * but that is waaay costly.
1188 * It'd probably be clever to use some kind of RCU here, but I don't know
1189 * anything about that.
1191 g_mutex_lock (&__log_func_mutex);
1192 list = g_slist_copy (__log_functions);
1193 __log_functions = g_slist_prepend (list, entry);
1194 g_mutex_unlock (&__log_func_mutex);
1196 if (gst_is_initialized ())
1197 GST_DEBUG ("prepended log function %p (user data %p) to log functions",
1202 gst_debug_compare_log_function_by_func (gconstpointer entry, gconstpointer func)
1204 gpointer entryfunc = (gpointer) (((LogFuncEntry *) entry)->func);
1206 return (entryfunc < func) ? -1 : (entryfunc > func) ? 1 : 0;
1210 gst_debug_compare_log_function_by_data (gconstpointer entry, gconstpointer data)
1212 gpointer entrydata = ((LogFuncEntry *) entry)->user_data;
1214 return (entrydata < data) ? -1 : (entrydata > data) ? 1 : 0;
1218 gst_debug_remove_with_compare_func (GCompareFunc func, gpointer data)
1221 GSList *new, *cleanup = NULL;
1224 g_mutex_lock (&__log_func_mutex);
1225 new = __log_functions;
1227 while ((found = g_slist_find_custom (new, data, func))) {
1228 if (new == __log_functions) {
1229 /* make a copy when we have the first hit, so that we modify the copy and
1230 * make that the new list later */
1231 new = g_slist_copy (new);
1234 cleanup = g_slist_prepend (cleanup, found->data);
1235 new = g_slist_delete_link (new, found);
1238 /* FIXME: We leak the old list here. See _add_log_function for why. */
1239 __log_functions = new;
1240 g_mutex_unlock (&__log_func_mutex);
1243 LogFuncEntry *entry = cleanup->data;
1246 entry->notify (entry->user_data);
1248 g_slice_free (LogFuncEntry, entry);
1249 cleanup = g_slist_delete_link (cleanup, cleanup);
1255 * gst_debug_remove_log_function:
1256 * @func: (scope call): the log function to remove
1258 * Removes all registered instances of the given logging functions.
1260 * Returns: How many instances of the function were removed
1263 gst_debug_remove_log_function (GstLogFunction func)
1268 func = gst_debug_log_default;
1271 gst_debug_remove_with_compare_func
1272 (gst_debug_compare_log_function_by_func, (gpointer) func);
1273 if (gst_is_initialized ())
1274 GST_DEBUG ("removed log function %p %d times from log function list", func,
1281 * gst_debug_remove_log_function_by_data:
1282 * @data: user data of the log function to remove
1284 * Removes all registered instances of log functions with the given user data.
1286 * Returns: How many instances of the function were removed
1289 gst_debug_remove_log_function_by_data (gpointer data)
1294 gst_debug_remove_with_compare_func
1295 (gst_debug_compare_log_function_by_data, data);
1297 if (gst_is_initialized ())
1299 ("removed %d log functions with user data %p from log function list",
1306 * gst_debug_set_colored:
1307 * @colored: Whether to use colored output or not
1309 * Sets or unsets the use of coloured debugging output.
1310 * Same as gst_debug_set_color_mode () with the argument being
1311 * being GST_DEBUG_COLOR_MODE_ON or GST_DEBUG_COLOR_MODE_OFF.
1313 * This function may be called before gst_init().
1316 gst_debug_set_colored (gboolean colored)
1318 GstDebugColorMode new_mode;
1319 new_mode = colored ? GST_DEBUG_COLOR_MODE_ON : GST_DEBUG_COLOR_MODE_OFF;
1320 g_atomic_int_set (&__use_color, (gint) new_mode);
1324 * gst_debug_set_color_mode:
1325 * @mode: The coloring mode for debug output. See @GstDebugColorMode.
1327 * Changes the coloring mode for debug output.
1329 * This function may be called before gst_init().
1334 gst_debug_set_color_mode (GstDebugColorMode mode)
1336 g_atomic_int_set (&__use_color, mode);
1340 * gst_debug_set_color_mode_from_string:
1341 * @mode: The coloring mode for debug output. One of the following:
1342 * "on", "auto", "off", "disable", "unix".
1344 * Changes the coloring mode for debug output.
1346 * This function may be called before gst_init().
1351 gst_debug_set_color_mode_from_string (const gchar * mode)
1353 if ((strcmp (mode, "on") == 0) || (strcmp (mode, "auto") == 0))
1354 gst_debug_set_color_mode (GST_DEBUG_COLOR_MODE_ON);
1355 else if ((strcmp (mode, "off") == 0) || (strcmp (mode, "disable") == 0))
1356 gst_debug_set_color_mode (GST_DEBUG_COLOR_MODE_OFF);
1357 else if (strcmp (mode, "unix") == 0)
1358 gst_debug_set_color_mode (GST_DEBUG_COLOR_MODE_UNIX);
1362 * gst_debug_is_colored:
1364 * Checks if the debugging output should be colored.
1366 * Returns: %TRUE, if the debug output should be colored.
1369 gst_debug_is_colored (void)
1371 GstDebugColorMode mode = g_atomic_int_get (&__use_color);
1372 return (mode == GST_DEBUG_COLOR_MODE_UNIX || mode == GST_DEBUG_COLOR_MODE_ON);
1376 * gst_debug_get_color_mode:
1378 * Changes the coloring mode for debug output.
1380 * Returns: see @GstDebugColorMode for possible values.
1385 gst_debug_get_color_mode (void)
1387 return g_atomic_int_get (&__use_color);
1391 * gst_debug_set_active:
1392 * @active: Whether to use debugging output or not
1394 * If activated, debugging messages are sent to the debugging
1396 * It makes sense to deactivate it for speed issues.
1397 * <note><para>This function is not threadsafe. It makes sense to only call it
1398 * during initialization.</para></note>
1401 gst_debug_set_active (gboolean active)
1403 _gst_debug_enabled = active;
1405 _gst_debug_min = GST_LEVEL_COUNT;
1407 _gst_debug_min = GST_LEVEL_NONE;
1411 * gst_debug_is_active:
1413 * Checks if debugging output is activated.
1415 * Returns: %TRUE, if debugging is activated
1418 gst_debug_is_active (void)
1420 return _gst_debug_enabled;
1424 * gst_debug_set_default_threshold:
1425 * @level: level to set
1427 * Sets the default threshold to the given level and updates all categories to
1428 * use this threshold.
1430 * This function may be called before gst_init().
1433 gst_debug_set_default_threshold (GstDebugLevel level)
1435 g_atomic_int_set (&__default_level, level);
1436 gst_debug_reset_all_thresholds ();
1440 * gst_debug_get_default_threshold:
1442 * Returns the default threshold that is used for new categories.
1444 * Returns: the default threshold level
1447 gst_debug_get_default_threshold (void)
1449 return (GstDebugLevel) g_atomic_int_get (&__default_level);
1453 gst_debug_reset_threshold (gpointer category, gpointer unused)
1455 GstDebugCategory *cat = (GstDebugCategory *) category;
1458 g_mutex_lock (&__level_name_mutex);
1459 walk = __level_name;
1461 LevelNameEntry *entry = walk->data;
1463 walk = g_slist_next (walk);
1464 if (g_pattern_match_string (entry->pat, cat->name)) {
1465 if (gst_is_initialized ())
1466 GST_LOG ("category %s matches pattern %p - gets set to level %d",
1467 cat->name, entry->pat, entry->level);
1468 gst_debug_category_set_threshold (cat, entry->level);
1472 gst_debug_category_set_threshold (cat, gst_debug_get_default_threshold ());
1475 g_mutex_unlock (&__level_name_mutex);
1479 gst_debug_reset_all_thresholds (void)
1481 g_mutex_lock (&__cat_mutex);
1482 g_slist_foreach (__categories, gst_debug_reset_threshold, NULL);
1483 g_mutex_unlock (&__cat_mutex);
1487 for_each_threshold_by_entry (gpointer data, gpointer user_data)
1489 GstDebugCategory *cat = (GstDebugCategory *) data;
1490 LevelNameEntry *entry = (LevelNameEntry *) user_data;
1492 if (g_pattern_match_string (entry->pat, cat->name)) {
1493 if (gst_is_initialized ())
1494 GST_LOG ("category %s matches pattern %p - gets set to level %d",
1495 cat->name, entry->pat, entry->level);
1496 gst_debug_category_set_threshold (cat, entry->level);
1501 * gst_debug_set_threshold_for_name:
1502 * @name: name of the categories to set
1503 * @level: level to set them to
1505 * Sets all categories which match the given glob style pattern to the given
1509 gst_debug_set_threshold_for_name (const gchar * name, GstDebugLevel level)
1512 LevelNameEntry *entry;
1514 g_return_if_fail (name != NULL);
1516 pat = g_pattern_spec_new (name);
1517 entry = g_slice_new (LevelNameEntry);
1519 entry->level = level;
1520 g_mutex_lock (&__level_name_mutex);
1521 __level_name = g_slist_prepend (__level_name, entry);
1522 g_mutex_unlock (&__level_name_mutex);
1523 g_mutex_lock (&__cat_mutex);
1524 g_slist_foreach (__categories, for_each_threshold_by_entry, entry);
1525 g_mutex_unlock (&__cat_mutex);
1529 * gst_debug_unset_threshold_for_name:
1530 * @name: name of the categories to set
1532 * Resets all categories with the given name back to the default level.
1535 gst_debug_unset_threshold_for_name (const gchar * name)
1540 g_return_if_fail (name != NULL);
1542 pat = g_pattern_spec_new (name);
1543 g_mutex_lock (&__level_name_mutex);
1544 walk = __level_name;
1545 /* improve this if you want, it's mighty slow */
1547 LevelNameEntry *entry = walk->data;
1549 if (g_pattern_spec_equal (entry->pat, pat)) {
1550 __level_name = g_slist_remove_link (__level_name, walk);
1551 g_pattern_spec_free (entry->pat);
1552 g_slice_free (LevelNameEntry, entry);
1553 g_slist_free_1 (walk);
1554 walk = __level_name;
1556 walk = g_slist_next (walk);
1559 g_mutex_unlock (&__level_name_mutex);
1560 g_pattern_spec_free (pat);
1561 gst_debug_reset_all_thresholds ();
1565 _gst_debug_category_new (const gchar * name, guint color,
1566 const gchar * description)
1568 GstDebugCategory *cat, *catfound;
1570 g_return_val_if_fail (name != NULL, NULL);
1572 cat = g_slice_new (GstDebugCategory);
1573 cat->name = g_strdup (name);
1575 if (description != NULL) {
1576 cat->description = g_strdup (description);
1578 cat->description = g_strdup ("no description");
1580 g_atomic_int_set (&cat->threshold, 0);
1581 gst_debug_reset_threshold (cat, NULL);
1583 /* add to category list */
1584 g_mutex_lock (&__cat_mutex);
1585 catfound = _gst_debug_get_category_locked (name);
1587 g_free ((gpointer) cat->name);
1588 g_free ((gpointer) cat->description);
1589 g_slice_free (GstDebugCategory, cat);
1592 __categories = g_slist_prepend (__categories, cat);
1594 g_mutex_unlock (&__cat_mutex);
1600 * gst_debug_category_free:
1601 * @category: #GstDebugCategory to free.
1603 * Removes and frees the category and all associated resources.
1606 gst_debug_category_free (GstDebugCategory * category)
1608 if (category == NULL)
1611 /* remove from category list */
1612 g_mutex_lock (&__cat_mutex);
1613 __categories = g_slist_remove (__categories, category);
1614 g_mutex_unlock (&__cat_mutex);
1616 g_free ((gpointer) category->name);
1617 g_free ((gpointer) category->description);
1618 g_slice_free (GstDebugCategory, category);
1622 * gst_debug_category_set_threshold:
1623 * @category: a #GstDebugCategory to set threshold of.
1624 * @level: the #GstDebugLevel threshold to set.
1626 * Sets the threshold of the category to the given level. Debug information will
1627 * only be output if the threshold is lower or equal to the level of the
1628 * debugging message.
1630 * Do not use this function in production code, because other functions may
1631 * change the threshold of categories as side effect. It is however a nice
1632 * function to use when debugging (even from gdb).
1636 gst_debug_category_set_threshold (GstDebugCategory * category,
1637 GstDebugLevel level)
1639 g_return_if_fail (category != NULL);
1641 if (level > _gst_debug_min) {
1642 _gst_debug_enabled = TRUE;
1643 _gst_debug_min = level;
1646 g_atomic_int_set (&category->threshold, level);
1650 * gst_debug_category_reset_threshold:
1651 * @category: a #GstDebugCategory to reset threshold of.
1653 * Resets the threshold of the category to the default level. Debug information
1654 * will only be output if the threshold is lower or equal to the level of the
1655 * debugging message.
1656 * Use this function to set the threshold back to where it was after using
1657 * gst_debug_category_set_threshold().
1660 gst_debug_category_reset_threshold (GstDebugCategory * category)
1662 gst_debug_reset_threshold (category, NULL);
1666 * gst_debug_category_get_threshold:
1667 * @category: a #GstDebugCategory to get threshold of.
1669 * Returns the threshold of a #GstDebugCategory.
1671 * Returns: the #GstDebugLevel that is used as threshold.
1674 gst_debug_category_get_threshold (GstDebugCategory * category)
1676 return (GstDebugLevel) g_atomic_int_get (&category->threshold);
1680 * gst_debug_category_get_name:
1681 * @category: a #GstDebugCategory to get name of.
1683 * Returns the name of a debug category.
1685 * Returns: the name of the category.
1688 gst_debug_category_get_name (GstDebugCategory * category)
1690 return category->name;
1694 * gst_debug_category_get_color:
1695 * @category: a #GstDebugCategory to get the color of.
1697 * Returns the color of a debug category used when printing output in this
1700 * Returns: the color of the category.
1703 gst_debug_category_get_color (GstDebugCategory * category)
1705 return category->color;
1709 * gst_debug_category_get_description:
1710 * @category: a #GstDebugCategory to get the description of.
1712 * Returns the description of a debug category.
1714 * Returns: the description of the category.
1717 gst_debug_category_get_description (GstDebugCategory * category)
1719 return category->description;
1723 * gst_debug_get_all_categories:
1725 * Returns a snapshot of a all categories that are currently in use . This list
1726 * may change anytime.
1727 * The caller has to free the list after use.
1729 * Returns: (transfer container) (element-type Gst.DebugCategory): the list of
1733 gst_debug_get_all_categories (void)
1737 g_mutex_lock (&__cat_mutex);
1738 ret = g_slist_copy (__categories);
1739 g_mutex_unlock (&__cat_mutex);
1744 static GstDebugCategory *
1745 _gst_debug_get_category_locked (const gchar * name)
1747 GstDebugCategory *ret = NULL;
1750 for (node = __categories; node; node = g_slist_next (node)) {
1751 ret = (GstDebugCategory *) node->data;
1752 if (!strcmp (name, ret->name)) {
1760 _gst_debug_get_category (const gchar * name)
1762 GstDebugCategory *ret;
1764 g_mutex_lock (&__cat_mutex);
1765 ret = _gst_debug_get_category_locked (name);
1766 g_mutex_unlock (&__cat_mutex);
1772 parse_debug_category (gchar * str, const gchar ** category)
1777 /* works in place */
1780 if (str[0] != '\0') {
1789 parse_debug_level (gchar * str, GstDebugLevel * level)
1794 /* works in place */
1797 if (g_ascii_isdigit (str[0])) {
1800 l = strtoul (str, &endptr, 10);
1801 if (endptr > str && endptr[0] == 0) {
1802 *level = (GstDebugLevel) l;
1806 } else if (strcmp (str, "ERROR") == 0) {
1807 *level = GST_LEVEL_ERROR;
1808 } else if (strncmp (str, "WARN", 4) == 0) {
1809 *level = GST_LEVEL_WARNING;
1810 } else if (strcmp (str, "FIXME") == 0) {
1811 *level = GST_LEVEL_FIXME;
1812 } else if (strcmp (str, "INFO") == 0) {
1813 *level = GST_LEVEL_INFO;
1814 } else if (strcmp (str, "DEBUG") == 0) {
1815 *level = GST_LEVEL_DEBUG;
1816 } else if (strcmp (str, "LOG") == 0) {
1817 *level = GST_LEVEL_LOG;
1818 } else if (strcmp (str, "TRACE") == 0) {
1819 *level = GST_LEVEL_TRACE;
1820 } else if (strcmp (str, "MEMDUMP") == 0) {
1821 *level = GST_LEVEL_MEMDUMP;
1829 * gst_debug_set_threshold_from_string:
1830 * @list: comma-separated list of "category:level" pairs to be used
1831 * as debug logging levels
1832 * @reset: %TRUE to clear all previously-set debug levels before setting
1834 * %FALSE if adding the threshold described by @list to the one already set.
1836 * Sets the debug logging wanted in the same form as with the GST_DEBUG
1837 * environment variable. You can use wildcards such as '*', but note that
1838 * the order matters when you use wild cards, e.g. "foosrc:6,*src:3,*:2" sets
1839 * everything to log level 2.
1844 gst_debug_set_threshold_from_string (const gchar * list, gboolean reset)
1852 gst_debug_set_default_threshold (0);
1854 split = g_strsplit (list, ",", 0);
1856 for (walk = split; *walk; walk++) {
1857 if (strchr (*walk, ':')) {
1858 gchar **values = g_strsplit (*walk, ":", 2);
1860 if (values[0] && values[1]) {
1861 GstDebugLevel level;
1862 const gchar *category;
1864 if (parse_debug_category (values[0], &category)
1865 && parse_debug_level (values[1], &level))
1866 gst_debug_set_threshold_for_name (category, level);
1869 g_strfreev (values);
1871 GstDebugLevel level;
1873 if (parse_debug_level (*walk, &level))
1874 gst_debug_set_default_threshold (level);
1881 /*** FUNCTION POINTERS ********************************************************/
1883 static GHashTable *__gst_function_pointers; /* NULL */
1884 static GMutex __dbg_functions_mutex;
1886 /* This function MUST NOT return NULL */
1888 _gst_debug_nameof_funcptr (GstDebugFuncPtr func)
1896 if (G_UNLIKELY (func == NULL))
1899 g_mutex_lock (&__dbg_functions_mutex);
1900 if (G_LIKELY (__gst_function_pointers)) {
1901 ptrname = g_hash_table_lookup (__gst_function_pointers, (gpointer) func);
1902 g_mutex_unlock (&__dbg_functions_mutex);
1903 if (G_LIKELY (ptrname))
1906 g_mutex_unlock (&__dbg_functions_mutex);
1908 /* we need to create an entry in the hash table for this one so we don't leak
1911 if (dladdr ((gpointer) func, &dl_info) && dl_info.dli_sname) {
1912 gchar *name = g_strdup (dl_info.dli_sname);
1914 _gst_debug_register_funcptr (func, name);
1919 gchar *name = g_strdup_printf ("%p", (gpointer) func);
1921 _gst_debug_register_funcptr (func, name);
1927 _gst_debug_register_funcptr (GstDebugFuncPtr func, const gchar * ptrname)
1929 gpointer ptr = (gpointer) func;
1931 g_mutex_lock (&__dbg_functions_mutex);
1933 if (!__gst_function_pointers)
1934 __gst_function_pointers = g_hash_table_new (g_direct_hash, g_direct_equal);
1935 if (!g_hash_table_lookup (__gst_function_pointers, ptr))
1936 g_hash_table_insert (__gst_function_pointers, ptr, (gpointer) ptrname);
1938 g_mutex_unlock (&__dbg_functions_mutex);
1942 gst_info_dump_mem_line (gchar * linebuf, gsize linebuf_size,
1943 const guint8 * mem, gsize mem_offset, gsize mem_size)
1945 gchar hexstr[50], ascstr[18], digitstr[4];
1957 while (i < mem_size) {
1958 ascstr[i] = (g_ascii_isprint (mem[i])) ? mem[i] : '.';
1959 g_snprintf (digitstr, sizeof (digitstr), "%02x ", mem[i]);
1960 g_strlcat (hexstr, digitstr, sizeof (hexstr));
1966 g_snprintf (linebuf, linebuf_size, "%08x: %-48.48s %-16.16s",
1967 (guint) mem_offset, hexstr, ascstr);
1971 _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
1972 const gchar * func, gint line, GObject * obj, const gchar * msg,
1973 const guint8 * data, guint length)
1977 gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "--------"
1978 "-------------------------------------------------------------------");
1980 if (msg != NULL && *msg != '\0') {
1981 gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "%s", msg);
1984 while (off < length) {
1987 /* gst_info_dump_mem_line will process 16 bytes at most */
1988 gst_info_dump_mem_line (buf, sizeof (buf), data, off, length - off);
1989 gst_debug_log (cat, GST_LEVEL_MEMDUMP, file, func, line, obj, "%s", buf);
1993 gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "--------"
1994 "-------------------------------------------------------------------");
1997 #else /* !GST_DISABLE_GST_DEBUG */
1998 #ifndef GST_REMOVE_DISABLED
2001 _gst_debug_category_new (const gchar * name, guint color,
2002 const gchar * description)
2008 _gst_debug_register_funcptr (GstDebugFuncPtr func, const gchar * ptrname)
2012 /* This function MUST NOT return NULL */
2014 _gst_debug_nameof_funcptr (GstDebugFuncPtr func)
2020 gst_debug_log (GstDebugCategory * category, GstDebugLevel level,
2021 const gchar * file, const gchar * function, gint line,
2022 GObject * object, const gchar * format, ...)
2027 gst_debug_log_valist (GstDebugCategory * category, GstDebugLevel level,
2028 const gchar * file, const gchar * function, gint line,
2029 GObject * object, const gchar * format, va_list args)
2034 gst_debug_message_get (GstDebugMessage * message)
2040 gst_debug_log_default (GstDebugCategory * category, GstDebugLevel level,
2041 const gchar * file, const gchar * function, gint line,
2042 GObject * object, GstDebugMessage * message, gpointer unused)
2047 gst_debug_level_get_name (GstDebugLevel level)
2053 gst_debug_add_log_function (GstLogFunction func, gpointer user_data,
2054 GDestroyNotify notify)
2059 gst_debug_remove_log_function (GstLogFunction func)
2065 gst_debug_remove_log_function_by_data (gpointer data)
2071 gst_debug_set_active (gboolean active)
2076 gst_debug_is_active (void)
2082 gst_debug_set_colored (gboolean colored)
2087 gst_debug_set_color_mode (GstDebugColorMode mode)
2092 gst_debug_set_color_mode_from_string (const gchar * str)
2097 gst_debug_is_colored (void)
2103 gst_debug_get_color_mode (void)
2105 return GST_DEBUG_COLOR_MODE_OFF;
2109 gst_debug_set_threshold_from_string (const gchar * list, gboolean reset)
2114 gst_debug_set_default_threshold (GstDebugLevel level)
2119 gst_debug_get_default_threshold (void)
2121 return GST_LEVEL_NONE;
2125 gst_debug_set_threshold_for_name (const gchar * name, GstDebugLevel level)
2130 gst_debug_unset_threshold_for_name (const gchar * name)
2135 gst_debug_category_free (GstDebugCategory * category)
2140 gst_debug_category_set_threshold (GstDebugCategory * category,
2141 GstDebugLevel level)
2146 gst_debug_category_reset_threshold (GstDebugCategory * category)
2151 gst_debug_category_get_threshold (GstDebugCategory * category)
2153 return GST_LEVEL_NONE;
2157 gst_debug_category_get_name (GstDebugCategory * category)
2163 gst_debug_category_get_color (GstDebugCategory * category)
2169 gst_debug_category_get_description (GstDebugCategory * category)
2175 gst_debug_get_all_categories (void)
2181 _gst_debug_get_category (const gchar * name)
2187 gst_debug_construct_term_color (guint colorinfo)
2189 return g_strdup ("00");
2193 gst_debug_construct_win_color (guint colorinfo)
2199 _priv_gst_in_valgrind (void)
2205 _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
2206 const gchar * func, gint line, GObject * obj, const gchar * msg,
2207 const guint8 * data, guint length)
2210 #endif /* GST_REMOVE_DISABLED */
2211 #endif /* GST_DISABLE_GST_DEBUG */
2213 /* Need this for _gst_element_error_printf even if GST_REMOVE_DISABLED is set:
2214 * fallback function that cleans up the format string and replaces all pointer
2215 * extension formats with plain %p. */
2216 #ifdef GST_DISABLE_GST_DEBUG
2217 #include <glib/gprintf.h>
2219 __gst_info_fallback_vasprintf (char **result, char const *format, va_list args)
2221 gchar *clean_format, *c;
2227 clean_format = g_strdup (format);
2229 while ((c = strstr (c, "%p\a"))) {
2230 if (c[3] < 'A' || c[3] > 'Z') {
2234 len = strlen (c + 4);
2235 memmove (c + 2, c + 4, len + 1);
2238 while ((c = strstr (clean_format, "%P"))) /* old GST_PTR_FORMAT */
2240 while ((c = strstr (clean_format, "%Q"))) /* old GST_SEGMENT_FORMAT */
2243 len = g_vasprintf (result, clean_format, args);
2245 g_free (clean_format);
2247 if (*result == NULL)
2254 #ifdef GST_ENABLE_FUNC_INSTRUMENTATION
2255 /* FIXME make this thread specific */
2256 static GSList *stack_trace = NULL;
2259 __cyg_profile_func_enter (void *this_fn, void *call_site)
2260 G_GNUC_NO_INSTRUMENT;
2261 void __cyg_profile_func_enter (void *this_fn, void *call_site)
2263 gchar *name = _gst_debug_nameof_funcptr (this_fn);
2264 gchar *site = _gst_debug_nameof_funcptr (call_site);
2266 GST_CAT_DEBUG (GST_CAT_CALL_TRACE, "entering function %s from %s", name,
2269 g_slist_prepend (stack_trace, g_strdup_printf ("%8p in %s from %p (%s)",
2270 this_fn, name, call_site, site));
2277 __cyg_profile_func_exit (void *this_fn, void *call_site)
2278 G_GNUC_NO_INSTRUMENT;
2279 void __cyg_profile_func_exit (void *this_fn, void *call_site)
2281 gchar *name = _gst_debug_nameof_funcptr (this_fn);
2283 GST_CAT_DEBUG (GST_CAT_CALL_TRACE, "leaving function %s", name);
2284 g_free (stack_trace->data);
2285 stack_trace = g_slist_delete_link (stack_trace, stack_trace);
2291 * gst_debug_print_stack_trace:
2293 * If GST_ENABLE_FUNC_INSTRUMENTATION is defined a stacktrace is available for
2294 * gstreamer code, which can be printed with this function.
2297 gst_debug_print_stack_trace (void)
2299 GSList *walk = stack_trace;
2303 walk = g_slist_next (walk);
2306 gchar *name = (gchar *) walk->data;
2308 g_print ("#%-2d %s\n", count++, name);
2310 walk = g_slist_next (walk);
2315 gst_debug_print_stack_trace (void)
2317 /* nothing because it's compiled out */
2320 #endif /* GST_ENABLE_FUNC_INSTRUMENTATION */