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: #gstreamer-gstconfig, #gstreamer-Gst 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.
55 * GST_DEBUG_CATEGORY_STATIC (my_category); // define category (statically)
56 * &hash;define GST_CAT_DEFAULT my_category // set as default
59 * After that you only need to initialize the category.
62 * GST_DEBUG_CATEGORY_INIT (my_category, "my category",
63 * 0, "This is my very own");
66 * Initialization must be done before the category is used first.
68 * in their plugin_init function, libraries and applications should do that
69 * during their initialization.
71 * The whole debugging subsystem can be disabled at build time with passing the
72 * --disable-gst-debug switch to configure. If this is done, every function,
73 * macro and even structs described in this file evaluate to default values or
75 * So don't take addresses of these functions or use other tricks.
76 * If you must do that for some reason, there is still an option.
78 * subsystem was compiled out, #GST_DISABLE_GST_DEBUG is defined in
80 * so you can check that before doing your trick.
81 * Disabling the debugging subsystem will give you a slight (read: unnoticeable)
82 * speed increase and will reduce the size of your compiled code. The GStreamer
83 * library itself becomes around 10% smaller.
85 * Please note that there are naming conventions for the names of debugging
86 * categories. These are explained at GST_DEBUG_CATEGORY_INIT().
90 #include "gst_private.h"
93 #undef gst_debug_remove_log_function
94 #undef gst_debug_add_log_function
96 #ifndef GST_DISABLE_GST_DEBUG
101 #include <stdio.h> /* fprintf */
102 #include <glib/gstdio.h>
105 # include <unistd.h> /* getpid on UNIX */
107 #ifdef HAVE_PROCESS_H
108 # include <process.h> /* getpid on win32 */
110 #include <string.h> /* G_VA_COPY */
112 # define WIN32_LEAN_AND_MEAN /* prevents from including too many things */
113 # include <windows.h> /* GetStdHandle, windows console */
116 #include "gst_private.h"
117 #include "gstutils.h"
118 #include "gstquark.h"
119 #include "gstsegment.h"
120 #include "gstvalue.h"
121 #include "gstcapsfeatures.h"
123 #ifdef HAVE_VALGRIND_VALGRIND_H
124 # include <valgrind/valgrind.h>
126 #include <glib/gprintf.h> /* g_sprintf */
128 /* our own printf implementation with custom extensions to %p for caps etc. */
129 #include "printf/printf.h"
130 #include "printf/printf-extension.h"
132 static char *gst_info_printf_pointer_extension_func (const char *format,
135 #endif /* !GST_DISABLE_GST_DEBUG */
137 extern gboolean gst_is_initialized (void);
139 /* we want these symbols exported even if debug is disabled, to maintain
140 * ABI compatibility. Unless GST_REMOVE_DISABLED is defined. */
141 #if !defined(GST_DISABLE_GST_DEBUG) || !defined(GST_REMOVE_DISABLED)
143 /* disabled by default, as soon as some threshold is set > NONE,
144 * it becomes enabled. */
145 gboolean _gst_debug_enabled = FALSE;
146 GstDebugLevel _gst_debug_min = GST_LEVEL_NONE;
148 GstDebugCategory *GST_CAT_DEFAULT = NULL;
150 GstDebugCategory *GST_CAT_GST_INIT = NULL;
151 GstDebugCategory *GST_CAT_MEMORY = NULL;
152 GstDebugCategory *GST_CAT_PARENTAGE = NULL;
153 GstDebugCategory *GST_CAT_STATES = NULL;
154 GstDebugCategory *GST_CAT_SCHEDULING = NULL;
156 GstDebugCategory *GST_CAT_BUFFER = NULL;
157 GstDebugCategory *GST_CAT_BUFFER_LIST = NULL;
158 GstDebugCategory *GST_CAT_BUS = NULL;
159 GstDebugCategory *GST_CAT_CAPS = NULL;
160 GstDebugCategory *GST_CAT_CLOCK = NULL;
161 GstDebugCategory *GST_CAT_ELEMENT_PADS = NULL;
162 GstDebugCategory *GST_CAT_PADS = NULL;
163 GstDebugCategory *GST_CAT_PERFORMANCE = NULL;
164 GstDebugCategory *GST_CAT_PIPELINE = NULL;
165 GstDebugCategory *GST_CAT_PLUGIN_LOADING = NULL;
166 GstDebugCategory *GST_CAT_PLUGIN_INFO = NULL;
167 GstDebugCategory *GST_CAT_PROPERTIES = NULL;
168 GstDebugCategory *GST_CAT_NEGOTIATION = NULL;
169 GstDebugCategory *GST_CAT_REFCOUNTING = NULL;
170 GstDebugCategory *GST_CAT_ERROR_SYSTEM = NULL;
171 GstDebugCategory *GST_CAT_EVENT = NULL;
172 GstDebugCategory *GST_CAT_MESSAGE = NULL;
173 GstDebugCategory *GST_CAT_PARAMS = NULL;
174 GstDebugCategory *GST_CAT_CALL_TRACE = NULL;
175 GstDebugCategory *GST_CAT_SIGNAL = NULL;
176 GstDebugCategory *GST_CAT_PROBE = NULL;
177 GstDebugCategory *GST_CAT_REGISTRY = NULL;
178 GstDebugCategory *GST_CAT_QOS = NULL;
179 GstDebugCategory *_priv_GST_CAT_POLL = NULL;
180 GstDebugCategory *GST_CAT_META = NULL;
181 GstDebugCategory *GST_CAT_LOCKING = NULL;
182 GstDebugCategory *GST_CAT_CONTEXT = NULL;
185 #endif /* !defined(GST_DISABLE_GST_DEBUG) || !defined(GST_REMOVE_DISABLED) */
187 #ifndef GST_DISABLE_GST_DEBUG
189 /* underscore is to prevent conflict with GST_CAT_DEBUG define */
190 GST_DEBUG_CATEGORY_STATIC (_GST_CAT_DEBUG);
192 /* time of initialization, so we get useful debugging output times
193 * FIXME: we use this in gstdebugutils.c, what about a function + macro to
194 * get the running time: GST_DEBUG_RUNNING_TIME
196 GstClockTime _priv_gst_info_start_time;
200 #include <rld_interface.h>
201 typedef struct DL_INFO
203 const char *dli_fname;
205 const char *dli_sname;
209 long dli_reserved[4];
213 #define _RLD_DLADDR 14
214 int dladdr (void *address, Dl_info * dl);
217 dladdr (void *address, Dl_info * dl)
221 v = _rld_new_interface (_RLD_DLADDR, address, dl);
227 static void gst_debug_reset_threshold (gpointer category, gpointer unused);
228 static void gst_debug_reset_all_thresholds (void);
230 struct _GstDebugMessage
237 /* list of all name/level pairs from --gst-debug and GST_DEBUG */
238 static GMutex __level_name_mutex;
239 static GSList *__level_name = NULL;
247 /* list of all categories */
248 static GMutex __cat_mutex;
249 static GSList *__categories = NULL;
251 /* all registered debug handlers */
256 GDestroyNotify notify;
259 static GMutex __log_func_mutex;
260 static GSList *__log_functions = NULL;
262 #define PRETTY_TAGS_DEFAULT TRUE
263 static gboolean pretty_tags = PRETTY_TAGS_DEFAULT;
265 static volatile gint G_GNUC_MAY_ALIAS __default_level = GST_LEVEL_DEFAULT;
266 static volatile gint G_GNUC_MAY_ALIAS __use_color = GST_DEBUG_COLOR_MODE_ON;
268 static FILE *log_file;
270 /* FIXME: export this? */
272 _priv_gst_in_valgrind (void)
280 in_valgrind = GST_VG_UNCHECKED;
282 if (in_valgrind == GST_VG_UNCHECKED) {
283 #ifdef HAVE_VALGRIND_VALGRIND_H
284 if (RUNNING_ON_VALGRIND) {
285 GST_CAT_INFO (GST_CAT_GST_INIT, "we're running inside valgrind");
286 printf ("GStreamer has detected that it is running inside valgrind.\n");
287 printf ("It might now take different code paths to ease debugging.\n");
288 printf ("Of course, this may also lead to different bugs.\n");
289 in_valgrind = GST_VG_INSIDE;
291 GST_CAT_LOG (GST_CAT_GST_INIT, "not doing extra valgrind stuff");
292 in_valgrind = GST_VG_NO_VALGRIND;
295 in_valgrind = GST_VG_NO_VALGRIND;
297 g_assert (in_valgrind == GST_VG_NO_VALGRIND ||
298 in_valgrind == GST_VG_INSIDE);
300 return (in_valgrind == GST_VG_INSIDE);
303 /* Initialize the debugging system */
305 _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, NULL, 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);
399 /* print out the valgrind message if we're in valgrind */
400 _priv_gst_in_valgrind ();
402 env = g_getenv ("GST_DEBUG_OPTIONS");
404 if (strstr (env, "full_tags") || strstr (env, "full-tags"))
406 else if (strstr (env, "pretty_tags") || strstr (env, "pretty-tags"))
411 /* we can't do this further above, because we initialize the GST_CAT_DEFAULT struct */
412 #define GST_CAT_DEFAULT _GST_CAT_DEBUG
416 * @category: category to log
417 * @level: level of the message is in
418 * @file: the file that emitted the message, usually the __FILE__ identifier
419 * @function: the function that emitted the message
420 * @line: the line from that the message was emitted, usually __LINE__
421 * @object: (transfer none) (allow-none): the object this message relates to,
423 * @format: a printf style format string
424 * @...: optional arguments for the format
426 * Logs the given message using the currently registered debugging handlers.
429 gst_debug_log (GstDebugCategory * category, GstDebugLevel level,
430 const gchar * file, const gchar * function, gint line,
431 GObject * object, const gchar * format, ...)
435 va_start (var_args, format);
436 gst_debug_log_valist (category, level, file, function, line, object, format,
442 /* based on g_basename(), which we can't use because it was deprecated */
443 static inline const gchar *
444 gst_path_basename (const gchar * file_name)
446 register const gchar *base;
448 base = strrchr (file_name, G_DIR_SEPARATOR);
451 const gchar *q = strrchr (file_name, '/');
452 if (base == NULL || (q != NULL && q > base))
459 if (g_ascii_isalpha (file_name[0]) && file_name[1] == ':')
460 return file_name + 2;
467 * gst_debug_log_valist:
468 * @category: category to log
469 * @level: level of the message is in
470 * @file: the file that emitted the message, usually the __FILE__ identifier
471 * @function: the function that emitted the message
472 * @line: the line from that the message was emitted, usually __LINE__
473 * @object: (transfer none) (allow-none): the object this message relates to,
475 * @format: a printf style format string
476 * @args: optional arguments for the format
478 * Logs the given message using the currently registered debugging handlers.
481 gst_debug_log_valist (GstDebugCategory * category, GstDebugLevel level,
482 const gchar * file, const gchar * function, gint line,
483 GObject * object, const gchar * format, va_list args)
485 GstDebugMessage message;
489 g_return_if_fail (category != NULL);
490 g_return_if_fail (file != NULL);
491 g_return_if_fail (function != NULL);
492 g_return_if_fail (format != NULL);
494 /* The predefined macro __FILE__ is always the exact path given to the
495 * compiler with MSVC, which may or may not be the basename. We work
496 * around it at runtime to improve the readability. */
498 file = gst_path_basename (file);
501 message.message = NULL;
502 message.format = format;
503 G_VA_COPY (message.arguments, args);
505 handler = __log_functions;
507 entry = handler->data;
508 handler = g_slist_next (handler);
509 entry->func (category, level, file, function, line, object, &message,
512 g_free (message.message);
513 va_end (message.arguments);
517 * gst_debug_message_get:
518 * @message: a debug message
520 * Gets the string representation of a #GstDebugMessage. This function is used
521 * in debug handlers to extract the message.
523 * Returns: the string representation of a #GstDebugMessage.
526 gst_debug_message_get (GstDebugMessage * message)
528 if (message->message == NULL) {
531 len = __gst_vasprintf (&message->message, message->format,
535 message->message = NULL;
537 return message->message;
540 #define MAX_BUFFER_DUMP_STRING_LEN 100
542 /* structure_to_pretty_string:
543 * @str: a serialized #GstStructure
545 * If the serialized structure contains large buffers such as images the hex
546 * representation of those buffers will be shortened so that the string remains
549 * Returns: the filtered string
552 prettify_structure_string (gchar * str)
554 gchar *pos = str, *end;
556 while ((pos = strstr (pos, "(buffer)"))) {
559 pos += strlen ("(buffer)");
560 for (end = pos; *end != '\0' && *end != ';' && *end != ' '; ++end)
562 if (count > MAX_BUFFER_DUMP_STRING_LEN) {
563 memcpy (pos + MAX_BUFFER_DUMP_STRING_LEN - 6, "..", 2);
564 memcpy (pos + MAX_BUFFER_DUMP_STRING_LEN - 4, pos + count - 4, 4);
565 g_memmove (pos + MAX_BUFFER_DUMP_STRING_LEN, pos + count,
566 strlen (pos + count) + 1);
567 pos += MAX_BUFFER_DUMP_STRING_LEN;
574 static inline gchar *
575 gst_info_structure_to_string (const GstStructure * s)
578 gchar *str = gst_structure_to_string (s);;
579 if (G_UNLIKELY (pretty_tags && s->name == GST_QUARK (TAGLIST)))
580 return prettify_structure_string (str);
587 static inline gchar *
588 gst_info_describe_buffer (GstBuffer * buffer)
590 return g_strdup_printf ("buffer: %p, pts %" GST_TIME_FORMAT ", dts %"
591 GST_TIME_FORMAT ", dur %" GST_TIME_FORMAT ", size %" G_GSIZE_FORMAT
592 ", offset %" G_GUINT64_FORMAT ", offset_end %" G_GUINT64_FORMAT
593 ", flags 0x%x", buffer, GST_TIME_ARGS (GST_BUFFER_PTS (buffer)),
594 GST_TIME_ARGS (GST_BUFFER_DTS (buffer)),
595 GST_TIME_ARGS (GST_BUFFER_DURATION (buffer)),
596 gst_buffer_get_size (buffer), GST_BUFFER_OFFSET (buffer),
597 GST_BUFFER_OFFSET_END (buffer), GST_BUFFER_FLAGS (buffer));
600 static inline gchar *
601 gst_info_describe_event (GstEvent * event)
605 s = gst_info_structure_to_string (gst_event_get_structure (event));
606 ret = g_strdup_printf ("%s event: %p, time %" GST_TIME_FORMAT
607 ", seq-num %d, %s", GST_EVENT_TYPE_NAME (event), event,
608 GST_TIME_ARGS (GST_EVENT_TIMESTAMP (event)), GST_EVENT_SEQNUM (event),
614 static inline gchar *
615 gst_info_describe_message (GstMessage * message)
619 s = gst_info_structure_to_string (gst_message_get_structure (message));
620 ret = g_strdup_printf ("%s message: %p, time %" GST_TIME_FORMAT
621 ", seq-num %d, element '%s', %s", GST_MESSAGE_TYPE_NAME (message),
622 message, GST_TIME_ARGS (GST_MESSAGE_TIMESTAMP (message)),
623 GST_MESSAGE_SEQNUM (message),
624 ((message->src) ? GST_ELEMENT_NAME (message->src) : "(NULL)"),
630 static inline gchar *
631 gst_info_describe_query (GstQuery * query)
635 s = gst_info_structure_to_string (gst_query_get_structure (query));
636 ret = g_strdup_printf ("%s query: %p, %s", GST_QUERY_TYPE_NAME (query),
637 query, (s ? s : "(NULL)"));
643 gst_debug_print_object (gpointer ptr)
645 GObject *object = (GObject *) ptr;
648 /* This is a cute trick to detect unmapped memory, but is unportable,
649 * slow, screws around with madvise, and not actually that useful. */
653 ret = madvise ((void *) ((unsigned long) ptr & (~0xfff)), 4096, 0);
654 if (ret == -1 && errno == ENOMEM) {
655 buffer = g_strdup_printf ("%p (unmapped memory)", ptr);
660 /* nicely printed object */
661 if (object == NULL) {
662 return g_strdup ("(NULL)");
664 if (*(GType *) ptr == GST_TYPE_CAPS) {
665 return gst_caps_to_string ((const GstCaps *) ptr);
667 if (*(GType *) ptr == GST_TYPE_STRUCTURE) {
668 return gst_info_structure_to_string ((const GstStructure *) ptr);
670 if (*(GType *) ptr == GST_TYPE_CAPS_FEATURES) {
671 return gst_caps_features_to_string ((const GstCapsFeatures *) ptr);
673 if (*(GType *) ptr == GST_TYPE_TAG_LIST) {
674 gchar *str = gst_tag_list_to_string ((GstTagList *) ptr);
675 if (G_UNLIKELY (pretty_tags))
676 return prettify_structure_string (str);
680 if (*(GType *) ptr == GST_TYPE_DATE_TIME) {
681 return __gst_date_time_serialize ((GstDateTime *) ptr, TRUE);
683 if (GST_IS_BUFFER (ptr)) {
684 return gst_info_describe_buffer (GST_BUFFER_CAST (ptr));
687 if (*(guint32 *) ptr == 0xffffffff) {
688 return g_strdup_printf ("<poisoned@%p>", ptr);
691 if (GST_IS_PAD (object) && GST_OBJECT_NAME (object)) {
692 return g_strdup_printf ("<%s:%s>", GST_DEBUG_PAD_NAME (object));
694 if (GST_IS_OBJECT (object) && GST_OBJECT_NAME (object)) {
695 return g_strdup_printf ("<%s>", GST_OBJECT_NAME (object));
697 if (G_IS_OBJECT (object)) {
698 return g_strdup_printf ("<%s@%p>", G_OBJECT_TYPE_NAME (object), object);
700 if (GST_IS_MESSAGE (object)) {
701 return gst_info_describe_message (GST_MESSAGE_CAST (object));
703 if (GST_IS_QUERY (object)) {
704 return gst_info_describe_query (GST_QUERY_CAST (object));
706 if (GST_IS_EVENT (object)) {
707 return gst_info_describe_event (GST_EVENT_CAST (object));
709 if (GST_IS_CONTEXT (object)) {
710 GstContext *context = GST_CONTEXT_CAST (object);
712 const GstStructure *structure;
714 structure = gst_context_get_structure (context);
717 s = gst_info_structure_to_string (structure);
719 s = g_strdup ("(NULL)");
722 ret = g_strdup_printf ("context '%s'", s);
727 return g_strdup_printf ("%p", ptr);
731 gst_debug_print_segment (gpointer ptr)
733 GstSegment *segment = (GstSegment *) ptr;
735 /* nicely printed segment */
736 if (segment == NULL) {
737 return g_strdup ("(NULL)");
740 switch (segment->format) {
741 case GST_FORMAT_UNDEFINED:{
742 return g_strdup_printf ("UNDEFINED segment");
744 case GST_FORMAT_TIME:{
745 return g_strdup_printf ("time segment start=%" GST_TIME_FORMAT
746 ", stop=%" GST_TIME_FORMAT ", rate=%f, applied_rate=%f"
747 ", flags=0x%02x, time=%" GST_TIME_FORMAT ", base=%" GST_TIME_FORMAT
748 ", position %" GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT,
749 GST_TIME_ARGS (segment->start), GST_TIME_ARGS (segment->stop),
750 segment->rate, segment->applied_rate, (guint) segment->flags,
751 GST_TIME_ARGS (segment->time), GST_TIME_ARGS (segment->base),
752 GST_TIME_ARGS (segment->position), GST_TIME_ARGS (segment->duration));
755 const gchar *format_name;
757 format_name = gst_format_get_name (segment->format);
758 if (G_UNLIKELY (format_name == NULL))
759 format_name = "(UNKNOWN FORMAT)";
760 return g_strdup_printf ("%s segment start=%" G_GINT64_FORMAT
761 ", stop=%" G_GINT64_FORMAT ", rate=%f, applied_rate=%f"
762 ", flags=0x%02x, time=%" G_GINT64_FORMAT ", base=%" G_GINT64_FORMAT
763 ", position %" G_GINT64_FORMAT ", duration %" G_GINT64_FORMAT,
764 format_name, segment->start, segment->stop, segment->rate,
765 segment->applied_rate, (guint) segment->flags,
766 segment->time, segment->base, segment->position, segment->duration);
772 gst_info_printf_pointer_extension_func (const char *format, void *ptr)
776 if (format[0] == 'p' && format[1] == '\a') {
778 case 'A': /* GST_PTR_FORMAT */
779 s = gst_debug_print_object (ptr);
781 case 'B': /* GST_SEGMENT_FORMAT */
782 s = gst_debug_print_segment (ptr);
785 /* must have been compiled against a newer version with an extension
786 * we don't known about yet - just ignore and fallback to %p below */
791 s = g_strdup_printf ("%p", ptr);
797 * gst_debug_construct_term_color:
798 * @colorinfo: the color info
800 * Constructs a string that can be used for getting the desired color in color
802 * You need to free the string after use.
804 * Returns: (transfer full) (type gchar*): a string containing the color
808 gst_debug_construct_term_color (guint colorinfo)
812 color = g_string_new ("\033[00");
814 if (colorinfo & GST_DEBUG_BOLD) {
815 g_string_append_len (color, ";01", 3);
817 if (colorinfo & GST_DEBUG_UNDERLINE) {
818 g_string_append_len (color, ";04", 3);
820 if (colorinfo & GST_DEBUG_FG_MASK) {
821 g_string_append_printf (color, ";3%1d", colorinfo & GST_DEBUG_FG_MASK);
823 if (colorinfo & GST_DEBUG_BG_MASK) {
824 g_string_append_printf (color, ";4%1d",
825 (colorinfo & GST_DEBUG_BG_MASK) >> 4);
827 g_string_append_c (color, 'm');
829 return g_string_free (color, FALSE);
833 * gst_debug_construct_win_color:
834 * @colorinfo: the color info
836 * Constructs an integer that can be used for getting the desired color in
837 * windows' terminals (cmd.exe). As there is no mean to underline, we simply
838 * ignore this attribute.
840 * This function returns 0 on non-windows machines.
842 * Returns: an integer containing the color definition
845 gst_debug_construct_win_color (guint colorinfo)
849 static const guchar ansi_to_win_fg[8] = {
851 FOREGROUND_RED, /* red */
852 FOREGROUND_GREEN, /* green */
853 FOREGROUND_RED | FOREGROUND_GREEN, /* yellow */
854 FOREGROUND_BLUE, /* blue */
855 FOREGROUND_RED | FOREGROUND_BLUE, /* magenta */
856 FOREGROUND_GREEN | FOREGROUND_BLUE, /* cyan */
857 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE /* white */
859 static const guchar ansi_to_win_bg[8] = {
863 BACKGROUND_RED | BACKGROUND_GREEN,
865 BACKGROUND_RED | BACKGROUND_BLUE,
866 BACKGROUND_GREEN | FOREGROUND_BLUE,
867 BACKGROUND_RED | BACKGROUND_GREEN | BACKGROUND_BLUE
870 /* we draw black as white, as cmd.exe can only have black bg */
871 if ((colorinfo & (GST_DEBUG_FG_MASK | GST_DEBUG_BG_MASK)) == 0) {
872 color = ansi_to_win_fg[7];
874 if (colorinfo & GST_DEBUG_UNDERLINE) {
875 color |= BACKGROUND_INTENSITY;
877 if (colorinfo & GST_DEBUG_BOLD) {
878 color |= FOREGROUND_INTENSITY;
880 if (colorinfo & GST_DEBUG_FG_MASK) {
881 color |= ansi_to_win_fg[colorinfo & GST_DEBUG_FG_MASK];
883 if (colorinfo & GST_DEBUG_BG_MASK) {
884 color |= ansi_to_win_bg[(colorinfo & GST_DEBUG_BG_MASK) >> 4];
890 /* width of %p varies depending on actual value of pointer, which can make
891 * output unevenly aligned if multiple threads are involved, hence the %14p
892 * (should really be %18p, but %14p seems a good compromise between too many
893 * white spaces and likely unalignment on my system) */
894 #if defined (GLIB_SIZEOF_VOID_P) && GLIB_SIZEOF_VOID_P == 8
895 #define PTR_FMT "%14p"
897 #define PTR_FMT "%10p"
899 #define PID_FMT "%5d"
900 #define CAT_FMT "%20s %s:%d:%s:%s"
903 static const guchar levelcolormap_w32[GST_LEVEL_COUNT] = {
905 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE,
906 /* GST_LEVEL_ERROR */
907 FOREGROUND_RED | FOREGROUND_INTENSITY,
908 /* GST_LEVEL_WARNING */
909 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_INTENSITY,
911 FOREGROUND_GREEN | FOREGROUND_INTENSITY,
912 /* GST_LEVEL_DEBUG */
913 FOREGROUND_GREEN | FOREGROUND_BLUE,
915 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE,
916 /* GST_LEVEL_FIXME */
917 FOREGROUND_RED | FOREGROUND_GREEN,
918 /* GST_LEVEL_TRACE */
919 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE,
920 /* placeholder for log level 8 */
922 /* GST_LEVEL_MEMDUMP */
923 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE
926 static const guchar available_colors[] = {
927 FOREGROUND_RED, FOREGROUND_GREEN, FOREGROUND_RED | FOREGROUND_GREEN,
928 FOREGROUND_BLUE, FOREGROUND_RED | FOREGROUND_BLUE,
929 FOREGROUND_GREEN | FOREGROUND_BLUE,
931 #endif /* G_OS_WIN32 */
932 static const gchar *levelcolormap[GST_LEVEL_COUNT] = {
933 "\033[37m", /* GST_LEVEL_NONE */
934 "\033[31;01m", /* GST_LEVEL_ERROR */
935 "\033[33;01m", /* GST_LEVEL_WARNING */
936 "\033[32;01m", /* GST_LEVEL_INFO */
937 "\033[36m", /* GST_LEVEL_DEBUG */
938 "\033[37m", /* GST_LEVEL_LOG */
939 "\033[33;01m", /* GST_LEVEL_FIXME */
940 "\033[37m", /* GST_LEVEL_TRACE */
941 "\033[37m", /* placeholder for log level 8 */
942 "\033[37m" /* GST_LEVEL_MEMDUMP */
946 * gst_debug_log_default:
947 * @category: category to log
948 * @level: level of the message
949 * @file: the file that emitted the message, usually the __FILE__ identifier
950 * @function: the function that emitted the message
951 * @line: the line from that the message was emitted, usually __LINE__
952 * @message: the actual message
953 * @object: (transfer none) (allow-none): the object this message relates to,
955 * @unused: an unused variable, reserved for some user_data.
957 * The default logging handler used by GStreamer. Logging functions get called
958 * whenever a macro like GST_DEBUG or similar is used. This function outputs the
959 * message and additional info to stderr (or the log file specified via the
960 * GST_DEBUG_FILE environment variable).
962 * You can add other handlers by using gst_debug_add_log_function().
963 * And you can remove this handler by calling
964 * gst_debug_remove_log_function(gst_debug_log_default);
967 gst_debug_log_default (GstDebugCategory * category, GstDebugLevel level,
968 const gchar * file, const gchar * function, gint line,
969 GObject * object, GstDebugMessage * message, gpointer unused)
972 GstClockTime elapsed;
974 GstDebugColorMode color_mode;
976 if (level > gst_debug_category_get_threshold (category))
980 color_mode = gst_debug_get_color_mode ();
983 obj = gst_debug_print_object (object);
988 elapsed = GST_CLOCK_DIFF (_priv_gst_info_start_time,
989 gst_util_get_timestamp ());
991 if (color_mode != GST_DEBUG_COLOR_MODE_OFF) {
993 /* We take a lock to keep colors and content together.
994 * Maybe there is a better way but for now this will do the right
996 static GMutex win_print_mutex;
997 g_mutex_lock (&win_print_mutex);
998 if (color_mode == GST_DEBUG_COLOR_MODE_UNIX) {
1000 /* colors, non-windows */
1001 gchar *color = NULL;
1004 const gchar *levelcolor;
1006 color = gst_debug_construct_term_color (gst_debug_category_get_color
1009 g_sprintf (pidcolor, "\033[3%1dm", pid % 6 + 31);
1010 levelcolor = levelcolormap[level];
1012 #define PRINT_FMT " %s"PID_FMT"%s "PTR_FMT" %s%s%s %s"CAT_FMT"%s %s\n"
1013 fprintf (log_file, "%" GST_TIME_FORMAT PRINT_FMT, GST_TIME_ARGS (elapsed),
1014 pidcolor, pid, clear, g_thread_self (), levelcolor,
1015 gst_debug_level_get_name (level), clear, color,
1016 gst_debug_category_get_name (category), file, line, function, obj,
1017 clear, gst_debug_message_get (message));
1023 /* colors, windows. */
1024 const gint clear = FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE;
1025 #define SET_COLOR(c) G_STMT_START { \
1026 if (log_file == stderr) \
1027 SetConsoleTextAttribute (GetStdHandle (STD_ERROR_HANDLE), (c)); \
1030 fprintf (log_file, "%" GST_TIME_FORMAT " ", GST_TIME_ARGS (elapsed));
1033 SET_COLOR (available_colors[pid % G_N_ELEMENTS (available_colors)]);
1034 fprintf (log_file, PID_FMT, pid);
1038 fprintf (log_file, " " PTR_FMT " ", g_thread_self ());
1041 SET_COLOR (levelcolormap_w32[level]);
1042 fprintf (log_file, "%s ", gst_debug_level_get_name (level));
1045 SET_COLOR (gst_debug_construct_win_color (gst_debug_category_get_color
1047 fprintf (log_file, CAT_FMT, gst_debug_category_get_name (category),
1048 file, line, function, obj);
1052 fprintf (log_file, " %s\n", gst_debug_message_get (message));
1055 g_mutex_unlock (&win_print_mutex);
1058 /* no color, all platforms */
1059 #define PRINT_FMT " "PID_FMT" "PTR_FMT" %s "CAT_FMT" %s\n"
1060 fprintf (log_file, "%" GST_TIME_FORMAT PRINT_FMT, GST_TIME_ARGS (elapsed),
1061 pid, g_thread_self (), gst_debug_level_get_name (level),
1062 gst_debug_category_get_name (category), file, line, function, obj,
1063 gst_debug_message_get (message));
1072 * gst_debug_level_get_name:
1073 * @level: the level to get the name for
1075 * Get the string representation of a debugging level
1080 gst_debug_level_get_name (GstDebugLevel level)
1083 case GST_LEVEL_NONE:
1085 case GST_LEVEL_ERROR:
1087 case GST_LEVEL_WARNING:
1089 case GST_LEVEL_INFO:
1091 case GST_LEVEL_DEBUG:
1095 case GST_LEVEL_FIXME:
1097 case GST_LEVEL_TRACE:
1099 case GST_LEVEL_MEMDUMP:
1102 g_warning ("invalid level specified for gst_debug_level_get_name");
1108 * gst_debug_add_log_function:
1109 * @func: the function to use
1110 * @user_data: user data
1111 * @notify: called when @user_data is not used anymore
1113 * Adds the logging function to the list of logging functions.
1114 * Be sure to use #G_GNUC_NO_INSTRUMENT on that function, it is needed.
1117 gst_debug_add_log_function (GstLogFunction func, gpointer user_data,
1118 GDestroyNotify notify)
1120 LogFuncEntry *entry;
1124 func = gst_debug_log_default;
1126 entry = g_slice_new (LogFuncEntry);
1128 entry->user_data = user_data;
1129 entry->notify = notify;
1130 /* FIXME: we leak the old list here - other threads might access it right now
1131 * in gst_debug_logv. Another solution is to lock the mutex in gst_debug_logv,
1132 * but that is waaay costly.
1133 * It'd probably be clever to use some kind of RCU here, but I don't know
1134 * anything about that.
1136 g_mutex_lock (&__log_func_mutex);
1137 list = g_slist_copy (__log_functions);
1138 __log_functions = g_slist_prepend (list, entry);
1139 g_mutex_unlock (&__log_func_mutex);
1141 if (gst_is_initialized ())
1142 GST_DEBUG ("prepended log function %p (user data %p) to log functions",
1147 gst_debug_compare_log_function_by_func (gconstpointer entry, gconstpointer func)
1149 gpointer entryfunc = (gpointer) (((LogFuncEntry *) entry)->func);
1151 return (entryfunc < func) ? -1 : (entryfunc > func) ? 1 : 0;
1155 gst_debug_compare_log_function_by_data (gconstpointer entry, gconstpointer data)
1157 gpointer entrydata = ((LogFuncEntry *) entry)->user_data;
1159 return (entrydata < data) ? -1 : (entrydata > data) ? 1 : 0;
1163 gst_debug_remove_with_compare_func (GCompareFunc func, gpointer data)
1166 GSList *new, *cleanup = NULL;
1169 g_mutex_lock (&__log_func_mutex);
1170 new = __log_functions;
1172 while ((found = g_slist_find_custom (new, data, func))) {
1173 if (new == __log_functions) {
1174 /* make a copy when we have the first hit, so that we modify the copy and
1175 * make that the new list later */
1176 new = g_slist_copy (new);
1179 cleanup = g_slist_prepend (cleanup, found->data);
1180 new = g_slist_delete_link (new, found);
1183 /* FIXME: We leak the old list here. See _add_log_function for why. */
1184 __log_functions = new;
1185 g_mutex_unlock (&__log_func_mutex);
1188 LogFuncEntry *entry = cleanup->data;
1191 entry->notify (entry->user_data);
1193 g_slice_free (LogFuncEntry, entry);
1194 cleanup = g_slist_delete_link (cleanup, cleanup);
1200 * gst_debug_remove_log_function:
1201 * @func: (scope call): the log function to remove
1203 * Removes all registered instances of the given logging functions.
1205 * Returns: How many instances of the function were removed
1208 gst_debug_remove_log_function (GstLogFunction func)
1213 func = gst_debug_log_default;
1216 gst_debug_remove_with_compare_func
1217 (gst_debug_compare_log_function_by_func, (gpointer) func);
1218 if (gst_is_initialized ())
1219 GST_DEBUG ("removed log function %p %d times from log function list", func,
1226 * gst_debug_remove_log_function_by_data:
1227 * @data: user data of the log function to remove
1229 * Removes all registered instances of log functions with the given user data.
1231 * Returns: How many instances of the function were removed
1234 gst_debug_remove_log_function_by_data (gpointer data)
1239 gst_debug_remove_with_compare_func
1240 (gst_debug_compare_log_function_by_data, data);
1242 if (gst_is_initialized ())
1244 ("removed %d log functions with user data %p from log function list",
1251 * gst_debug_set_colored:
1252 * @colored: Whether to use colored output or not
1254 * Sets or unsets the use of coloured debugging output.
1255 * Same as gst_debug_set_color_mode () with the argument being
1256 * being GST_DEBUG_COLOR_MODE_ON or GST_DEBUG_COLOR_MODE_OFF.
1258 * This function may be called before gst_init().
1261 gst_debug_set_colored (gboolean colored)
1263 GstDebugColorMode new_mode;
1264 new_mode = colored ? GST_DEBUG_COLOR_MODE_ON : GST_DEBUG_COLOR_MODE_OFF;
1265 g_atomic_int_set (&__use_color, (gint) new_mode);
1269 * gst_debug_set_color_mode:
1270 * @mode: The coloring mode for debug output. See @GstDebugColorMode.
1272 * Changes the coloring mode for debug output.
1274 * This function may be called before gst_init().
1279 gst_debug_set_color_mode (GstDebugColorMode mode)
1281 g_atomic_int_set (&__use_color, mode);
1285 * gst_debug_set_color_mode_from_string:
1286 * @mode: The coloring mode for debug output. One of the following:
1287 * "on", "auto", "off", "disable", "unix".
1289 * Changes the coloring mode for debug output.
1291 * This function may be called before gst_init().
1296 gst_debug_set_color_mode_from_string (const gchar * mode)
1298 if ((strcmp (mode, "on") == 0) || (strcmp (mode, "auto") == 0))
1299 gst_debug_set_color_mode (GST_DEBUG_COLOR_MODE_ON);
1300 else if ((strcmp (mode, "off") == 0) || (strcmp (mode, "disable") == 0))
1301 gst_debug_set_color_mode (GST_DEBUG_COLOR_MODE_OFF);
1302 else if (strcmp (mode, "unix") == 0)
1303 gst_debug_set_color_mode (GST_DEBUG_COLOR_MODE_UNIX);
1307 * gst_debug_is_colored:
1309 * Checks if the debugging output should be colored.
1311 * Returns: TRUE, if the debug output should be colored.
1314 gst_debug_is_colored (void)
1316 GstDebugColorMode mode = g_atomic_int_get (&__use_color);
1317 return (mode == GST_DEBUG_COLOR_MODE_UNIX || mode == GST_DEBUG_COLOR_MODE_ON);
1321 * gst_debug_get_color_mode:
1323 * Changes the coloring mode for debug output.
1325 * Returns: see @GstDebugColorMode for possible values.
1330 gst_debug_get_color_mode (void)
1332 return g_atomic_int_get (&__use_color);
1336 * gst_debug_set_active:
1337 * @active: Whether to use debugging output or not
1339 * If activated, debugging messages are sent to the debugging
1341 * It makes sense to deactivate it for speed issues.
1342 * <note><para>This function is not threadsafe. It makes sense to only call it
1343 * during initialization.</para></note>
1346 gst_debug_set_active (gboolean active)
1348 _gst_debug_enabled = active;
1350 _gst_debug_min = GST_LEVEL_COUNT;
1352 _gst_debug_min = GST_LEVEL_NONE;
1356 * gst_debug_is_active:
1358 * Checks if debugging output is activated.
1360 * Returns: TRUE, if debugging is activated
1363 gst_debug_is_active (void)
1365 return _gst_debug_enabled;
1369 * gst_debug_set_default_threshold:
1370 * @level: level to set
1372 * Sets the default threshold to the given level and updates all categories to
1373 * use this threshold.
1375 * This function may be called before gst_init().
1378 gst_debug_set_default_threshold (GstDebugLevel level)
1380 g_atomic_int_set (&__default_level, level);
1381 gst_debug_reset_all_thresholds ();
1385 * gst_debug_get_default_threshold:
1387 * Returns the default threshold that is used for new categories.
1389 * Returns: the default threshold level
1392 gst_debug_get_default_threshold (void)
1394 return (GstDebugLevel) g_atomic_int_get (&__default_level);
1398 gst_debug_reset_threshold (gpointer category, gpointer unused)
1400 GstDebugCategory *cat = (GstDebugCategory *) category;
1403 g_mutex_lock (&__level_name_mutex);
1404 walk = __level_name;
1406 LevelNameEntry *entry = walk->data;
1408 walk = g_slist_next (walk);
1409 if (g_pattern_match_string (entry->pat, cat->name)) {
1410 if (gst_is_initialized ())
1411 GST_LOG ("category %s matches pattern %p - gets set to level %d",
1412 cat->name, entry->pat, entry->level);
1413 gst_debug_category_set_threshold (cat, entry->level);
1417 gst_debug_category_set_threshold (cat, gst_debug_get_default_threshold ());
1420 g_mutex_unlock (&__level_name_mutex);
1424 gst_debug_reset_all_thresholds (void)
1426 g_mutex_lock (&__cat_mutex);
1427 g_slist_foreach (__categories, gst_debug_reset_threshold, NULL);
1428 g_mutex_unlock (&__cat_mutex);
1432 for_each_threshold_by_entry (gpointer data, gpointer user_data)
1434 GstDebugCategory *cat = (GstDebugCategory *) data;
1435 LevelNameEntry *entry = (LevelNameEntry *) user_data;
1437 if (g_pattern_match_string (entry->pat, cat->name)) {
1438 if (gst_is_initialized ())
1439 GST_LOG ("category %s matches pattern %p - gets set to level %d",
1440 cat->name, entry->pat, entry->level);
1441 gst_debug_category_set_threshold (cat, entry->level);
1446 * gst_debug_set_threshold_for_name:
1447 * @name: name of the categories to set
1448 * @level: level to set them to
1450 * Sets all categories which match the given glob style pattern to the given
1454 gst_debug_set_threshold_for_name (const gchar * name, GstDebugLevel level)
1457 LevelNameEntry *entry;
1459 g_return_if_fail (name != NULL);
1461 pat = g_pattern_spec_new (name);
1462 entry = g_slice_new (LevelNameEntry);
1464 entry->level = level;
1465 g_mutex_lock (&__level_name_mutex);
1466 __level_name = g_slist_prepend (__level_name, entry);
1467 g_mutex_unlock (&__level_name_mutex);
1468 g_mutex_lock (&__cat_mutex);
1469 g_slist_foreach (__categories, for_each_threshold_by_entry, entry);
1470 g_mutex_unlock (&__cat_mutex);
1474 * gst_debug_unset_threshold_for_name:
1475 * @name: name of the categories to set
1477 * Resets all categories with the given name back to the default level.
1480 gst_debug_unset_threshold_for_name (const gchar * name)
1485 g_return_if_fail (name != NULL);
1487 pat = g_pattern_spec_new (name);
1488 g_mutex_lock (&__level_name_mutex);
1489 walk = __level_name;
1490 /* improve this if you want, it's mighty slow */
1492 LevelNameEntry *entry = walk->data;
1494 if (g_pattern_spec_equal (entry->pat, pat)) {
1495 __level_name = g_slist_remove_link (__level_name, walk);
1496 g_pattern_spec_free (entry->pat);
1497 g_slice_free (LevelNameEntry, entry);
1498 g_slist_free_1 (walk);
1499 walk = __level_name;
1502 g_mutex_unlock (&__level_name_mutex);
1503 g_pattern_spec_free (pat);
1504 gst_debug_reset_all_thresholds ();
1508 _gst_debug_category_new (const gchar * name, guint color,
1509 const gchar * description)
1511 GstDebugCategory *cat;
1513 g_return_val_if_fail (name != NULL, NULL);
1515 cat = g_slice_new (GstDebugCategory);
1516 cat->name = g_strdup (name);
1518 if (description != NULL) {
1519 cat->description = g_strdup (description);
1521 cat->description = g_strdup ("no description");
1523 g_atomic_int_set (&cat->threshold, 0);
1524 gst_debug_reset_threshold (cat, NULL);
1526 /* add to category list */
1527 g_mutex_lock (&__cat_mutex);
1528 __categories = g_slist_prepend (__categories, cat);
1529 g_mutex_unlock (&__cat_mutex);
1535 * gst_debug_category_free:
1536 * @category: #GstDebugCategory to free.
1538 * Removes and frees the category and all associated resources.
1541 gst_debug_category_free (GstDebugCategory * category)
1543 if (category == NULL)
1546 /* remove from category list */
1547 g_mutex_lock (&__cat_mutex);
1548 __categories = g_slist_remove (__categories, category);
1549 g_mutex_unlock (&__cat_mutex);
1551 g_free ((gpointer) category->name);
1552 g_free ((gpointer) category->description);
1553 g_slice_free (GstDebugCategory, category);
1557 * gst_debug_category_set_threshold:
1558 * @category: a #GstDebugCategory to set threshold of.
1559 * @level: the #GstDebugLevel threshold to set.
1561 * Sets the threshold of the category to the given level. Debug information will
1562 * only be output if the threshold is lower or equal to the level of the
1563 * debugging message.
1565 * Do not use this function in production code, because other functions may
1566 * change the threshold of categories as side effect. It is however a nice
1567 * function to use when debugging (even from gdb).
1571 gst_debug_category_set_threshold (GstDebugCategory * category,
1572 GstDebugLevel level)
1574 g_return_if_fail (category != NULL);
1576 if (level > _gst_debug_min) {
1577 _gst_debug_enabled = TRUE;
1578 _gst_debug_min = level;
1581 g_atomic_int_set (&category->threshold, level);
1585 * gst_debug_category_reset_threshold:
1586 * @category: a #GstDebugCategory to reset threshold of.
1588 * Resets the threshold of the category to the default level. Debug information
1589 * will only be output if the threshold is lower or equal to the level of the
1590 * debugging message.
1591 * Use this function to set the threshold back to where it was after using
1592 * gst_debug_category_set_threshold().
1595 gst_debug_category_reset_threshold (GstDebugCategory * category)
1597 gst_debug_reset_threshold (category, NULL);
1601 * gst_debug_category_get_threshold:
1602 * @category: a #GstDebugCategory to get threshold of.
1604 * Returns the threshold of a #GstDebugCategory.
1606 * Returns: the #GstDebugLevel that is used as threshold.
1609 gst_debug_category_get_threshold (GstDebugCategory * category)
1611 return (GstDebugLevel) g_atomic_int_get (&category->threshold);
1615 * gst_debug_category_get_name:
1616 * @category: a #GstDebugCategory to get name of.
1618 * Returns the name of a debug category.
1620 * Returns: the name of the category.
1623 gst_debug_category_get_name (GstDebugCategory * category)
1625 return category->name;
1629 * gst_debug_category_get_color:
1630 * @category: a #GstDebugCategory to get the color of.
1632 * Returns the color of a debug category used when printing output in this
1635 * Returns: the color of the category.
1638 gst_debug_category_get_color (GstDebugCategory * category)
1640 return category->color;
1644 * gst_debug_category_get_description:
1645 * @category: a #GstDebugCategory to get the description of.
1647 * Returns the description of a debug category.
1649 * Returns: the description of the category.
1652 gst_debug_category_get_description (GstDebugCategory * category)
1654 return category->description;
1658 * gst_debug_get_all_categories:
1660 * Returns a snapshot of a all categories that are currently in use . This list
1661 * may change anytime.
1662 * The caller has to free the list after use.
1664 * Returns: (transfer container) (element-type Gst.DebugCategory): the list of
1668 gst_debug_get_all_categories (void)
1672 g_mutex_lock (&__cat_mutex);
1673 ret = g_slist_copy (__categories);
1674 g_mutex_unlock (&__cat_mutex);
1680 _gst_debug_get_category (const gchar * name)
1682 GstDebugCategory *ret = NULL;
1685 for (node = __categories; node; node = g_slist_next (node)) {
1686 ret = (GstDebugCategory *) node->data;
1687 if (!strcmp (name, ret->name)) {
1695 parse_debug_category (gchar * str, const gchar ** category)
1700 /* works in place */
1703 if (str[0] != '\0') {
1712 parse_debug_level (gchar * str, GstDebugLevel * level)
1717 /* works in place */
1720 if (g_ascii_isdigit (str[0])) {
1723 l = strtoul (str, &endptr, 10);
1724 if (endptr > str && endptr[0] == 0) {
1725 *level = (GstDebugLevel) l;
1729 } else if (strcmp (str, "ERROR") == 0) {
1730 *level = GST_LEVEL_ERROR;
1731 } else if (strncmp (str, "WARN", 4) == 0) {
1732 *level = GST_LEVEL_WARNING;
1733 } else if (strcmp (str, "FIXME") == 0) {
1734 *level = GST_LEVEL_FIXME;
1735 } else if (strcmp (str, "INFO") == 0) {
1736 *level = GST_LEVEL_INFO;
1737 } else if (strcmp (str, "DEBUG") == 0) {
1738 *level = GST_LEVEL_DEBUG;
1739 } else if (strcmp (str, "LOG") == 0) {
1740 *level = GST_LEVEL_LOG;
1741 } else if (strcmp (str, "TRACE") == 0) {
1742 *level = GST_LEVEL_TRACE;
1743 } else if (strcmp (str, "MEMDUMP") == 0) {
1744 *level = GST_LEVEL_MEMDUMP;
1752 * gst_debug_set_threshold_from_string:
1753 * @list: comma-separated list of "category:level" pairs to be used
1754 * as debug logging levels
1755 * @reset: %TRUE to clear all previously-set debug levels before setting
1757 * %FALSE if adding the threshold described by @list to the one already set.
1759 * Sets the debug logging wanted in the same form as with the GST_DEBUG
1760 * environment variable. You can use wildcards such as '*', but note that
1761 * the order matters when you use wild cards, e.g. "foosrc:6,*src:3,*:2" sets
1762 * everything to log level 2.
1767 gst_debug_set_threshold_from_string (const gchar * list, gboolean reset)
1775 gst_debug_set_default_threshold (0);
1777 split = g_strsplit (list, ",", 0);
1779 for (walk = split; *walk; walk++) {
1780 if (strchr (*walk, ':')) {
1781 gchar **values = g_strsplit (*walk, ":", 2);
1783 if (values[0] && values[1]) {
1784 GstDebugLevel level;
1785 const gchar *category;
1787 if (parse_debug_category (values[0], &category)
1788 && parse_debug_level (values[1], &level))
1789 gst_debug_set_threshold_for_name (category, level);
1792 g_strfreev (values);
1794 GstDebugLevel level;
1796 if (parse_debug_level (*walk, &level))
1797 gst_debug_set_default_threshold (level);
1804 /*** FUNCTION POINTERS ********************************************************/
1806 static GHashTable *__gst_function_pointers; /* NULL */
1807 static GMutex __dbg_functions_mutex;
1809 /* This function MUST NOT return NULL */
1811 _gst_debug_nameof_funcptr (GstDebugFuncPtr func)
1819 if (G_UNLIKELY (func == NULL))
1822 g_mutex_lock (&__dbg_functions_mutex);
1823 if (G_LIKELY (__gst_function_pointers)) {
1824 ptrname = g_hash_table_lookup (__gst_function_pointers, (gpointer) func);
1825 g_mutex_unlock (&__dbg_functions_mutex);
1826 if (G_LIKELY (ptrname))
1829 g_mutex_unlock (&__dbg_functions_mutex);
1831 /* we need to create an entry in the hash table for this one so we don't leak
1834 if (dladdr ((gpointer) func, &dl_info) && dl_info.dli_sname) {
1835 gchar *name = g_strdup (dl_info.dli_sname);
1837 _gst_debug_register_funcptr (func, name);
1842 gchar *name = g_strdup_printf ("%p", (gpointer) func);
1844 _gst_debug_register_funcptr (func, name);
1850 _gst_debug_register_funcptr (GstDebugFuncPtr func, const gchar * ptrname)
1852 gpointer ptr = (gpointer) func;
1854 g_mutex_lock (&__dbg_functions_mutex);
1856 if (!__gst_function_pointers)
1857 __gst_function_pointers = g_hash_table_new (g_direct_hash, g_direct_equal);
1858 if (!g_hash_table_lookup (__gst_function_pointers, ptr))
1859 g_hash_table_insert (__gst_function_pointers, ptr, (gpointer) ptrname);
1861 g_mutex_unlock (&__dbg_functions_mutex);
1865 gst_info_dump_mem_line (gchar * linebuf, gsize linebuf_size,
1866 const guint8 * mem, gsize mem_offset, gsize mem_size)
1868 gchar hexstr[50], ascstr[18], digitstr[4];
1880 while (i < mem_size) {
1881 ascstr[i] = (g_ascii_isprint (mem[i])) ? mem[i] : '.';
1882 g_snprintf (digitstr, sizeof (digitstr), "%02x ", mem[i]);
1883 g_strlcat (hexstr, digitstr, sizeof (hexstr));
1889 g_snprintf (linebuf, linebuf_size, "%08x: %-48.48s %-16.16s",
1890 (guint) mem_offset, hexstr, ascstr);
1894 _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
1895 const gchar * func, gint line, GObject * obj, const gchar * msg,
1896 const guint8 * data, guint length)
1900 gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "--------"
1901 "-------------------------------------------------------------------");
1903 if (msg != NULL && *msg != '\0') {
1904 gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "%s", msg);
1907 while (off < length) {
1910 /* gst_info_dump_mem_line will process 16 bytes at most */
1911 gst_info_dump_mem_line (buf, sizeof (buf), data, off, length - off);
1912 gst_debug_log (cat, GST_LEVEL_MEMDUMP, file, func, line, obj, "%s", buf);
1916 gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "--------"
1917 "-------------------------------------------------------------------");
1920 #else /* !GST_DISABLE_GST_DEBUG */
1921 #ifndef GST_REMOVE_DISABLED
1924 _gst_debug_category_new (const gchar * name, guint color,
1925 const gchar * description)
1931 _gst_debug_register_funcptr (GstDebugFuncPtr func, const gchar * ptrname)
1935 /* This function MUST NOT return NULL */
1937 _gst_debug_nameof_funcptr (GstDebugFuncPtr func)
1943 gst_debug_log (GstDebugCategory * category, GstDebugLevel level,
1944 const gchar * file, const gchar * function, gint line,
1945 GObject * object, const gchar * format, ...)
1950 gst_debug_log_valist (GstDebugCategory * category, GstDebugLevel level,
1951 const gchar * file, const gchar * function, gint line,
1952 GObject * object, const gchar * format, va_list args)
1957 gst_debug_message_get (GstDebugMessage * message)
1963 gst_debug_log_default (GstDebugCategory * category, GstDebugLevel level,
1964 const gchar * file, const gchar * function, gint line,
1965 GObject * object, GstDebugMessage * message, gpointer unused)
1970 gst_debug_level_get_name (GstDebugLevel level)
1976 gst_debug_add_log_function (GstLogFunction func, gpointer user_data,
1977 GDestroyNotify notify)
1982 gst_debug_remove_log_function (GstLogFunction func)
1988 gst_debug_remove_log_function_by_data (gpointer data)
1994 gst_debug_set_active (gboolean active)
1999 gst_debug_is_active (void)
2005 gst_debug_set_colored (gboolean colored)
2010 gst_debug_set_color_mode (GstDebugColorMode mode)
2015 gst_debug_set_color_mode_from_string (const gchar * str)
2020 gst_debug_is_colored (void)
2026 gst_debug_get_color_mode (void)
2028 return GST_DEBUG_COLOR_MODE_OFF;
2032 gst_debug_set_threshold_from_string (const gchar * list, gboolean reset)
2037 gst_debug_set_default_threshold (GstDebugLevel level)
2042 gst_debug_get_default_threshold (void)
2044 return GST_LEVEL_NONE;
2048 gst_debug_set_threshold_for_name (const gchar * name, GstDebugLevel level)
2053 gst_debug_unset_threshold_for_name (const gchar * name)
2058 gst_debug_category_free (GstDebugCategory * category)
2063 gst_debug_category_set_threshold (GstDebugCategory * category,
2064 GstDebugLevel level)
2069 gst_debug_category_reset_threshold (GstDebugCategory * category)
2074 gst_debug_category_get_threshold (GstDebugCategory * category)
2076 return GST_LEVEL_NONE;
2080 gst_debug_category_get_name (GstDebugCategory * category)
2086 gst_debug_category_get_color (GstDebugCategory * category)
2092 gst_debug_category_get_description (GstDebugCategory * category)
2098 gst_debug_get_all_categories (void)
2104 _gst_debug_get_category (const gchar * name)
2110 gst_debug_construct_term_color (guint colorinfo)
2112 return g_strdup ("00");
2116 gst_debug_construct_win_color (guint colorinfo)
2122 _priv_gst_in_valgrind (void)
2128 _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
2129 const gchar * func, gint line, GObject * obj, const gchar * msg,
2130 const guint8 * data, guint length)
2133 #endif /* GST_REMOVE_DISABLED */
2134 #endif /* GST_DISABLE_GST_DEBUG */
2136 /* Need this for _gst_element_error_printf even if GST_REMOVE_DISABLED is set:
2137 * fallback function that cleans up the format string and replaces all pointer
2138 * extension formats with plain %p. */
2139 #ifdef GST_DISABLE_GST_DEBUG
2140 #include <glib/gprintf.h>
2142 __gst_info_fallback_vasprintf (char **result, char const *format, va_list args)
2144 gchar *clean_format, *c;
2150 clean_format = g_strdup (format);
2152 while ((c = strstr (c, "%p\a"))) {
2153 if (c[3] < 'A' || c[3] > 'Z') {
2157 len = strlen (c + 4);
2158 g_memmove (c + 2, c + 4, len + 1);
2161 while ((c = strstr (clean_format, "%P"))) /* old GST_PTR_FORMAT */
2163 while ((c = strstr (clean_format, "%Q"))) /* old GST_SEGMENT_FORMAT */
2166 len = g_vasprintf (result, clean_format, args);
2168 g_free (clean_format);
2170 if (*result == NULL)
2177 #ifdef GST_ENABLE_FUNC_INSTRUMENTATION
2178 /* FIXME make this thread specific */
2179 static GSList *stack_trace = NULL;
2182 __cyg_profile_func_enter (void *this_fn, void *call_site)
2183 G_GNUC_NO_INSTRUMENT;
2184 void __cyg_profile_func_enter (void *this_fn, void *call_site)
2186 gchar *name = _gst_debug_nameof_funcptr (this_fn);
2187 gchar *site = _gst_debug_nameof_funcptr (call_site);
2189 GST_CAT_DEBUG (GST_CAT_CALL_TRACE, "entering function %s from %s", name,
2192 g_slist_prepend (stack_trace, g_strdup_printf ("%8p in %s from %p (%s)",
2193 this_fn, name, call_site, site));
2200 __cyg_profile_func_exit (void *this_fn, void *call_site)
2201 G_GNUC_NO_INSTRUMENT;
2202 void __cyg_profile_func_exit (void *this_fn, void *call_site)
2204 gchar *name = _gst_debug_nameof_funcptr (this_fn);
2206 GST_CAT_DEBUG (GST_CAT_CALL_TRACE, "leaving function %s", name);
2207 g_free (stack_trace->data);
2208 stack_trace = g_slist_delete_link (stack_trace, stack_trace);
2214 * gst_debug_print_stack_trace:
2216 * If GST_ENABLE_FUNC_INSTRUMENTATION is defined a stacktrace is available for
2217 * gstreamer code, which can be printed with this function.
2220 gst_debug_print_stack_trace (void)
2222 GSList *walk = stack_trace;
2226 walk = g_slist_next (walk);
2229 gchar *name = (gchar *) walk->data;
2231 g_print ("#%-2d %s\n", count++, name);
2233 walk = g_slist_next (walk);
2238 gst_debug_print_stack_trace (void)
2240 /* nothing because it's compiled out */
2243 #endif /* GST_ENABLE_FUNC_INSTRUMENTATION */