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., 59 Temple Place - Suite 330,
22 * Boston, MA 02111-1307, 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 #ifdef HAVE_PRINTF_EXTENSION
104 #include <stdio.h> /* fprintf */
105 #include <glib/gstdio.h>
108 # include <unistd.h> /* getpid on UNIX */
110 #ifdef HAVE_PROCESS_H
111 # include <process.h> /* getpid on win32 */
113 #include <string.h> /* G_VA_COPY */
115 # define WIN32_LEAN_AND_MEAN /* prevents from including too many things */
116 # include <windows.h> /* GetStdHandle, windows console */
119 #include "gst_private.h"
120 #include "gstutils.h"
121 #include "gstquark.h"
122 #include "gstsegment.h"
123 #ifdef HAVE_VALGRIND_VALGRIND_H
124 # include <valgrind/valgrind.h>
126 #include <glib/gprintf.h> /* g_sprintf */
128 #endif /* !GST_DISABLE_GST_DEBUG */
130 /* we want these symbols exported even if debug is disabled, to maintain
131 * ABI compatibility. Unless GST_REMOVE_DISABLED is defined. */
132 #if !defined(GST_DISABLE_GST_DEBUG) || !defined(GST_REMOVE_DISABLED)
134 /* disabled by default, as soon as some threshold is set > NONE,
135 * it becomes enabled. */
136 gboolean __gst_debug_enabled = FALSE;
137 GstDebugLevel __gst_debug_min = GST_LEVEL_NONE;
139 GstDebugCategory *GST_CAT_DEFAULT = NULL;
141 GstDebugCategory *GST_CAT_GST_INIT = NULL;
142 GstDebugCategory *GST_CAT_AUTOPLUG = NULL;
143 GstDebugCategory *GST_CAT_AUTOPLUG_ATTEMPT = NULL;
144 GstDebugCategory *GST_CAT_PARENTAGE = NULL;
145 GstDebugCategory *GST_CAT_STATES = NULL;
146 GstDebugCategory *GST_CAT_SCHEDULING = NULL;
148 GstDebugCategory *GST_CAT_BUFFER = NULL;
149 GstDebugCategory *GST_CAT_BUFFER_LIST = NULL;
150 GstDebugCategory *GST_CAT_BUS = NULL;
151 GstDebugCategory *GST_CAT_CAPS = NULL;
152 GstDebugCategory *GST_CAT_CLOCK = NULL;
153 GstDebugCategory *GST_CAT_ELEMENT_PADS = NULL;
154 GstDebugCategory *GST_CAT_PADS = NULL;
155 GstDebugCategory *GST_CAT_PERFORMANCE = NULL;
156 GstDebugCategory *GST_CAT_PIPELINE = NULL;
157 GstDebugCategory *GST_CAT_PLUGIN_LOADING = NULL;
158 GstDebugCategory *GST_CAT_PLUGIN_INFO = NULL;
159 GstDebugCategory *GST_CAT_PROPERTIES = NULL;
160 GstDebugCategory *GST_CAT_TYPES = NULL;
161 GstDebugCategory *GST_CAT_XML = NULL;
162 GstDebugCategory *GST_CAT_NEGOTIATION = NULL;
163 GstDebugCategory *GST_CAT_REFCOUNTING = NULL;
164 GstDebugCategory *GST_CAT_ERROR_SYSTEM = NULL;
165 GstDebugCategory *GST_CAT_EVENT = NULL;
166 GstDebugCategory *GST_CAT_MESSAGE = NULL;
167 GstDebugCategory *GST_CAT_PARAMS = NULL;
168 GstDebugCategory *GST_CAT_CALL_TRACE = NULL;
169 GstDebugCategory *GST_CAT_SIGNAL = NULL;
170 GstDebugCategory *GST_CAT_PROBE = NULL;
171 GstDebugCategory *GST_CAT_REGISTRY = NULL;
172 GstDebugCategory *GST_CAT_QOS = NULL;
173 GstDebugCategory *_priv_GST_CAT_POLL = NULL;
176 #endif /* !defined(GST_DISABLE_GST_DEBUG) || !defined(GST_REMOVE_DISABLED) */
178 #ifndef GST_DISABLE_GST_DEBUG
180 /* underscore is to prevent conflict with GST_CAT_DEBUG define */
181 GST_DEBUG_CATEGORY_STATIC (_GST_CAT_DEBUG);
183 /* time of initialization, so we get useful debugging output times
184 * FIXME: we use this in gstdebugutils.c, what about a function + macro to
185 * get the running time: GST_DEBUG_RUNNING_TIME
187 GstClockTime _priv_gst_info_start_time;
191 #include <rld_interface.h>
192 typedef struct DL_INFO
194 const char *dli_fname;
196 const char *dli_sname;
200 long dli_reserved[4];
204 #define _RLD_DLADDR 14
205 int dladdr (void *address, Dl_info * dl);
208 dladdr (void *address, Dl_info * dl)
212 v = _rld_new_interface (_RLD_DLADDR, address, dl);
218 static void gst_debug_reset_threshold (gpointer category, gpointer unused);
219 static void gst_debug_reset_all_thresholds (void);
221 #ifdef HAVE_PRINTF_EXTENSION
222 static int _gst_info_printf_extension_ptr (FILE * stream,
223 const struct printf_info *info, const void *const *args);
224 static int _gst_info_printf_extension_segment (FILE * stream,
225 const struct printf_info *info, const void *const *args);
226 #ifdef HAVE_REGISTER_PRINTF_SPECIFIER
227 static int _gst_info_printf_extension_arginfo (const struct printf_info *info,
228 size_t n, int *argtypes, int *size);
230 static int _gst_info_printf_extension_arginfo (const struct printf_info *info,
231 size_t n, int *argtypes);
235 struct _GstDebugMessage
242 /* list of all name/level pairs from --gst-debug and GST_DEBUG */
243 static GStaticMutex __level_name_mutex = G_STATIC_MUTEX_INIT;
244 static GSList *__level_name = NULL;
252 /* list of all categories */
253 static GStaticMutex __cat_mutex = G_STATIC_MUTEX_INIT;
254 static GSList *__categories = NULL;
256 /* all registered debug handlers */
263 static GStaticMutex __log_func_mutex = G_STATIC_MUTEX_INIT;
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 = 1;
272 static FILE *log_file;
274 /* FIXME: export this? */
276 _priv_gst_in_valgrind (void)
284 in_valgrind = GST_VG_UNCHECKED;
286 if (in_valgrind == GST_VG_UNCHECKED) {
287 #ifdef HAVE_VALGRIND_VALGRIND_H
288 if (RUNNING_ON_VALGRIND) {
289 GST_CAT_INFO (GST_CAT_GST_INIT, "we're running inside valgrind");
290 printf ("GStreamer has detected that it is running inside valgrind.\n");
291 printf ("It might now take different code paths to ease debugging.\n");
292 printf ("Of course, this may also lead to different bugs.\n");
293 in_valgrind = GST_VG_INSIDE;
295 GST_CAT_LOG (GST_CAT_GST_INIT, "not doing extra valgrind stuff");
296 in_valgrind = GST_VG_NO_VALGRIND;
299 in_valgrind = GST_VG_NO_VALGRIND;
301 g_assert (in_valgrind == GST_VG_NO_VALGRIND ||
302 in_valgrind == GST_VG_INSIDE);
304 return (in_valgrind == GST_VG_INSIDE);
310 * Initializes the debugging system.
311 * Normally you don't want to call this, because gst_init() does it for you.
314 _gst_debug_init (void)
318 env = g_getenv ("GST_DEBUG_FILE");
319 if (env != NULL && *env != '\0') {
320 if (strcmp (env, "-") == 0) {
323 log_file = g_fopen (env, "w");
324 if (log_file == NULL) {
325 g_printerr ("Could not open log file '%s' for writing: %s\n", env,
334 /* get time we started for debugging messages */
335 _priv_gst_info_start_time = gst_util_get_timestamp ();
337 #ifdef HAVE_PRINTF_EXTENSION
338 #ifdef HAVE_REGISTER_PRINTF_SPECIFIER
339 register_printf_specifier (GST_PTR_FORMAT[0], _gst_info_printf_extension_ptr,
340 _gst_info_printf_extension_arginfo);
341 register_printf_specifier (GST_SEGMENT_FORMAT[0],
342 _gst_info_printf_extension_segment, _gst_info_printf_extension_arginfo);
344 register_printf_function (GST_PTR_FORMAT[0], _gst_info_printf_extension_ptr,
345 _gst_info_printf_extension_arginfo);
346 register_printf_function (GST_SEGMENT_FORMAT[0],
347 _gst_info_printf_extension_segment, _gst_info_printf_extension_arginfo);
351 /* do NOT use a single debug function before this line has been run */
352 GST_CAT_DEFAULT = _gst_debug_category_new ("default",
353 GST_DEBUG_UNDERLINE, NULL);
354 _GST_CAT_DEBUG = _gst_debug_category_new ("GST_DEBUG",
355 GST_DEBUG_BOLD | GST_DEBUG_FG_YELLOW, "debugging subsystem");
357 gst_debug_add_log_function (gst_debug_log_default, NULL);
359 /* FIXME: add descriptions here */
360 GST_CAT_GST_INIT = _gst_debug_category_new ("GST_INIT",
361 GST_DEBUG_BOLD | GST_DEBUG_FG_RED, NULL);
362 GST_CAT_AUTOPLUG = _gst_debug_category_new ("GST_AUTOPLUG",
363 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
364 GST_CAT_AUTOPLUG_ATTEMPT = _gst_debug_category_new ("GST_AUTOPLUG_ATTEMPT",
365 GST_DEBUG_BOLD | GST_DEBUG_FG_CYAN | GST_DEBUG_BG_BLUE, NULL);
366 GST_CAT_PARENTAGE = _gst_debug_category_new ("GST_PARENTAGE",
367 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
368 GST_CAT_STATES = _gst_debug_category_new ("GST_STATES",
369 GST_DEBUG_BOLD | GST_DEBUG_FG_RED, NULL);
370 GST_CAT_SCHEDULING = _gst_debug_category_new ("GST_SCHEDULING",
371 GST_DEBUG_BOLD | GST_DEBUG_FG_MAGENTA, NULL);
372 GST_CAT_BUFFER = _gst_debug_category_new ("GST_BUFFER",
373 GST_DEBUG_BOLD | GST_DEBUG_BG_GREEN, NULL);
374 GST_CAT_BUFFER_LIST = _gst_debug_category_new ("GST_BUFFER_LIST",
375 GST_DEBUG_BOLD | GST_DEBUG_BG_GREEN, NULL);
376 GST_CAT_BUS = _gst_debug_category_new ("GST_BUS", GST_DEBUG_BG_YELLOW, NULL);
377 GST_CAT_CAPS = _gst_debug_category_new ("GST_CAPS",
378 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
379 GST_CAT_CLOCK = _gst_debug_category_new ("GST_CLOCK",
380 GST_DEBUG_BOLD | GST_DEBUG_FG_YELLOW, NULL);
381 GST_CAT_ELEMENT_PADS = _gst_debug_category_new ("GST_ELEMENT_PADS",
382 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
383 GST_CAT_PADS = _gst_debug_category_new ("GST_PADS",
384 GST_DEBUG_BOLD | GST_DEBUG_FG_RED | GST_DEBUG_BG_RED, NULL);
385 GST_CAT_PERFORMANCE = _gst_debug_category_new ("GST_PERFORMANCE",
386 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
387 GST_CAT_PIPELINE = _gst_debug_category_new ("GST_PIPELINE",
388 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
389 GST_CAT_PLUGIN_LOADING = _gst_debug_category_new ("GST_PLUGIN_LOADING",
390 GST_DEBUG_BOLD | GST_DEBUG_FG_CYAN, NULL);
391 GST_CAT_PLUGIN_INFO = _gst_debug_category_new ("GST_PLUGIN_INFO",
392 GST_DEBUG_BOLD | GST_DEBUG_FG_CYAN, NULL);
393 GST_CAT_PROPERTIES = _gst_debug_category_new ("GST_PROPERTIES",
394 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_BLUE, NULL);
395 GST_CAT_TYPES = _gst_debug_category_new ("GST_TYPES",
396 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
397 GST_CAT_XML = _gst_debug_category_new ("GST_XML",
398 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
399 GST_CAT_NEGOTIATION = _gst_debug_category_new ("GST_NEGOTIATION",
400 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
401 GST_CAT_REFCOUNTING = _gst_debug_category_new ("GST_REFCOUNTING",
402 GST_DEBUG_BOLD | GST_DEBUG_FG_RED | GST_DEBUG_BG_BLUE, NULL);
403 GST_CAT_ERROR_SYSTEM = _gst_debug_category_new ("GST_ERROR_SYSTEM",
404 GST_DEBUG_BOLD | GST_DEBUG_FG_RED | GST_DEBUG_BG_WHITE, NULL);
406 GST_CAT_EVENT = _gst_debug_category_new ("GST_EVENT",
407 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
408 GST_CAT_MESSAGE = _gst_debug_category_new ("GST_MESSAGE",
409 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
410 GST_CAT_PARAMS = _gst_debug_category_new ("GST_PARAMS",
411 GST_DEBUG_BOLD | GST_DEBUG_FG_BLACK | GST_DEBUG_BG_YELLOW, NULL);
412 GST_CAT_CALL_TRACE = _gst_debug_category_new ("GST_CALL_TRACE",
413 GST_DEBUG_BOLD, NULL);
414 GST_CAT_SIGNAL = _gst_debug_category_new ("GST_SIGNAL",
415 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
416 GST_CAT_PROBE = _gst_debug_category_new ("GST_PROBE",
417 GST_DEBUG_BOLD | GST_DEBUG_FG_GREEN, "pad probes");
418 GST_CAT_REGISTRY = _gst_debug_category_new ("GST_REGISTRY", 0, "registry");
419 GST_CAT_QOS = _gst_debug_category_new ("GST_QOS", 0, "QoS");
420 _priv_GST_CAT_POLL = _gst_debug_category_new ("GST_POLL", 0, "poll");
423 /* print out the valgrind message if we're in valgrind */
424 _priv_gst_in_valgrind ();
426 env = g_getenv ("GST_DEBUG_OPTIONS");
428 if (strstr (env, "full_tags") || strstr (env, "full-tags"))
430 else if (strstr (env, "pretty_tags") || strstr (env, "pretty-tags"))
435 /* we can't do this further above, because we initialize the GST_CAT_DEFAULT struct */
436 #define GST_CAT_DEFAULT _GST_CAT_DEBUG
440 * @category: category to log
441 * @level: level of the message is in
442 * @file: the file that emitted the message, usually the __FILE__ identifier
443 * @function: the function that emitted the message
444 * @line: the line from that the message was emitted, usually __LINE__
445 * @object: (transfer none) (allow-none): the object this message relates to,
447 * @format: a printf style format string
448 * @...: optional arguments for the format
450 * Logs the given message using the currently registered debugging handlers.
453 gst_debug_log (GstDebugCategory * category, GstDebugLevel level,
454 const gchar * file, const gchar * function, gint line,
455 GObject * object, const gchar * format, ...)
459 va_start (var_args, format);
460 gst_debug_log_valist (category, level, file, function, line, object, format,
466 /* based on g_basename(), which we can't use because it was deprecated */
467 static inline const gchar *
468 gst_path_basename (const gchar * file_name)
470 register const gchar *base;
472 base = strrchr (file_name, G_DIR_SEPARATOR);
475 const gchar *q = strrchr (file_name, '/');
476 if (base == NULL || (q != NULL && q > base))
483 if (g_ascii_isalpha (file_name[0]) && file_name[1] == ':')
484 return file_name + 2;
491 * gst_debug_log_valist:
492 * @category: category to log
493 * @level: level of the message is in
494 * @file: the file that emitted the message, usually the __FILE__ identifier
495 * @function: the function that emitted the message
496 * @line: the line from that the message was emitted, usually __LINE__
497 * @object: (transfer none) (allow-none): the object this message relates to,
499 * @format: a printf style format string
500 * @args: optional arguments for the format
502 * Logs the given message using the currently registered debugging handlers.
505 gst_debug_log_valist (GstDebugCategory * category, GstDebugLevel level,
506 const gchar * file, const gchar * function, gint line,
507 GObject * object, const gchar * format, va_list args)
509 GstDebugMessage message;
513 g_return_if_fail (category != NULL);
514 g_return_if_fail (file != NULL);
515 g_return_if_fail (function != NULL);
516 g_return_if_fail (format != NULL);
518 /* The predefined macro __FILE__ is always the exact path given to the
519 * compiler with MSVC, which may or may not be the basename. We work
520 * around it at runtime to improve the readability. */
522 file = gst_path_basename (file);
525 message.message = NULL;
526 message.format = format;
527 G_VA_COPY (message.arguments, args);
529 handler = __log_functions;
531 entry = handler->data;
532 handler = g_slist_next (handler);
533 entry->func (category, level, file, function, line, object, &message,
536 g_free (message.message);
537 va_end (message.arguments);
541 * gst_debug_message_get:
542 * @message: a debug message
544 * Gets the string representation of a #GstDebugMessage. This function is used
545 * in debug handlers to extract the message.
547 * Returns: the string representation of a #GstDebugMessage.
550 gst_debug_message_get (GstDebugMessage * message)
552 if (message->message == NULL) {
553 message->message = g_strdup_vprintf (message->format, message->arguments);
555 return message->message;
558 #define MAX_BUFFER_DUMP_STRING_LEN 100
560 /* structure_to_pretty_string:
561 * @structure: a #GstStructure
563 * Converts @structure to a human-readable string representation. Basically
564 * the same as gst_structure_to_string(), but if the structure contains large
565 * buffers such as images the hex representation of those buffers will be
566 * shortened so that the string remains readable.
568 * Returns: a newly-allocated string. g_free() when no longer needed.
571 structure_to_pretty_string (const GstStructure * s)
573 gchar *str, *pos, *end;
575 str = gst_structure_to_string (s);
580 while ((pos = strstr (pos, "(buffer)"))) {
583 pos += strlen ("(buffer)");
584 for (end = pos; *end != '\0' && *end != ';' && *end != ' '; ++end)
586 if (count > MAX_BUFFER_DUMP_STRING_LEN) {
587 memcpy (pos + MAX_BUFFER_DUMP_STRING_LEN - 6, "..", 2);
588 memcpy (pos + MAX_BUFFER_DUMP_STRING_LEN - 4, pos + count - 4, 4);
589 g_memmove (pos + MAX_BUFFER_DUMP_STRING_LEN, pos + count,
590 strlen (pos + count) + 1);
591 pos += MAX_BUFFER_DUMP_STRING_LEN;
598 static inline gchar *
599 gst_info_structure_to_string (GstStructure * s)
601 if (G_UNLIKELY (pretty_tags && s->name == GST_QUARK (TAGLIST)))
602 return structure_to_pretty_string (s);
604 return gst_structure_to_string (s);
608 gst_debug_print_object (gpointer ptr)
610 GObject *object = (GObject *) ptr;
613 /* This is a cute trick to detect unmapped memory, but is unportable,
614 * slow, screws around with madvise, and not actually that useful. */
618 ret = madvise ((void *) ((unsigned long) ptr & (~0xfff)), 4096, 0);
619 if (ret == -1 && errno == ENOMEM) {
620 buffer = g_strdup_printf ("%p (unmapped memory)", ptr);
625 /* nicely printed object */
626 if (object == NULL) {
627 return g_strdup ("(NULL)");
629 if (*(GType *) ptr == GST_TYPE_CAPS) {
630 return gst_caps_to_string ((GstCaps *) ptr);
632 if (*(GType *) ptr == GST_TYPE_STRUCTURE) {
633 return gst_info_structure_to_string ((GstStructure *) ptr);
635 if (GST_IS_BUFFER (ptr)) {
636 GstBuffer *buf = (GstBuffer *) ptr;
639 caps = gst_caps_to_string (GST_BUFFER_CAPS (buf));
641 g_strdup_printf ("%p, data %p, malloc %p, ts %" GST_TIME_FORMAT
642 ", dur %" GST_TIME_FORMAT ", size %u, offset %" G_GUINT64_FORMAT
643 ", offset_end %" G_GUINT64_FORMAT ", caps: %s", buf,
644 GST_BUFFER_DATA (buf), GST_BUFFER_MALLOCDATA (buf),
645 GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buf)),
646 GST_TIME_ARGS (GST_BUFFER_DURATION (buf)), GST_BUFFER_SIZE (buf),
647 GST_BUFFER_OFFSET (buf), GST_BUFFER_OFFSET_END (buf), caps);
653 if (*(guint32 *) ptr == 0xffffffff) {
654 return g_strdup_printf ("<poisoned@%p>", ptr);
657 if (GST_IS_PAD (object) && GST_OBJECT_NAME (object)) {
658 return g_strdup_printf ("<%s:%s>", GST_DEBUG_PAD_NAME (object));
660 if (GST_IS_OBJECT (object) && GST_OBJECT_NAME (object)) {
661 return g_strdup_printf ("<%s>", GST_OBJECT_NAME (object));
663 if (G_IS_OBJECT (object)) {
664 return g_strdup_printf ("<%s@%p>", G_OBJECT_TYPE_NAME (object), object);
666 if (GST_IS_MESSAGE (object)) {
667 GstMessage *msg = GST_MESSAGE_CAST (object);
670 if (msg->structure) {
671 s = gst_info_structure_to_string (msg->structure);
673 s = g_strdup ("(NULL)");
676 ret = g_strdup_printf ("%s message from element '%s': %s",
677 GST_MESSAGE_TYPE_NAME (msg), (msg->src != NULL) ?
678 GST_ELEMENT_NAME (msg->src) : "(NULL)", s);
682 if (GST_IS_QUERY (object)) {
683 GstQuery *query = GST_QUERY_CAST (object);
685 if (query->structure) {
686 return gst_info_structure_to_string (query->structure);
688 const gchar *query_type_name;
690 query_type_name = gst_query_type_get_name (query->type);
691 if (G_LIKELY (query_type_name != NULL)) {
692 return g_strdup_printf ("%s query", query_type_name);
694 return g_strdup_printf ("query of unknown type %d", query->type);
698 if (GST_IS_EVENT (object)) {
699 GstEvent *event = GST_EVENT_CAST (object);
702 if (event->structure) {
703 s = gst_info_structure_to_string (event->structure);
705 s = g_strdup ("(NULL)");
708 ret = g_strdup_printf ("%s event from '%s' at time %"
709 GST_TIME_FORMAT ": %s",
710 GST_EVENT_TYPE_NAME (event), (event->src != NULL) ?
711 GST_OBJECT_NAME (event->src) : "(NULL)",
712 GST_TIME_ARGS (event->timestamp), s);
717 return g_strdup_printf ("%p", ptr);
720 #ifdef HAVE_PRINTF_EXTENSION
723 gst_debug_print_segment (gpointer ptr)
725 GstSegment *segment = (GstSegment *) ptr;
727 /* nicely printed segment */
728 if (segment == NULL) {
729 return g_strdup ("(NULL)");
732 switch (segment->format) {
733 case GST_FORMAT_UNDEFINED:{
734 return g_strdup_printf ("UNDEFINED segment");
736 case GST_FORMAT_TIME:{
737 return g_strdup_printf ("time segment start=%" GST_TIME_FORMAT
738 ", stop=%" GST_TIME_FORMAT ", last_stop=%" GST_TIME_FORMAT
739 ", duration=%" GST_TIME_FORMAT ", rate=%f, applied_rate=%f"
740 ", flags=0x%02x, time=%" GST_TIME_FORMAT ", accum=%" GST_TIME_FORMAT,
741 GST_TIME_ARGS (segment->start), GST_TIME_ARGS (segment->stop),
742 GST_TIME_ARGS (segment->last_stop), GST_TIME_ARGS (segment->duration),
743 segment->rate, segment->applied_rate, (guint) segment->flags,
744 GST_TIME_ARGS (segment->time), GST_TIME_ARGS (segment->accum));
747 const gchar *format_name;
749 format_name = gst_format_get_name (segment->format);
750 if (G_UNLIKELY (format_name == NULL))
751 format_name = "(UNKNOWN FORMAT)";
752 return g_strdup_printf ("%s segment start=%" G_GINT64_FORMAT
753 ", stop=%" G_GINT64_FORMAT ", last_stop=%" G_GINT64_FORMAT
754 ", duration=%" G_GINT64_FORMAT ", rate=%f, applied_rate=%f"
755 ", flags=0x%02x, time=%" GST_TIME_FORMAT ", accum=%" GST_TIME_FORMAT,
756 format_name, segment->start, segment->stop, segment->last_stop,
757 segment->duration, segment->rate, segment->applied_rate,
758 (guint) segment->flags, GST_TIME_ARGS (segment->time),
759 GST_TIME_ARGS (segment->accum));
764 #endif /* HAVE_PRINTF_EXTENSION */
767 * gst_debug_construct_term_color:
768 * @colorinfo: the color info
770 * Constructs a string that can be used for getting the desired color in color
772 * You need to free the string after use.
774 * Returns: (transfer full) (type gchar*): a string containing the color
778 gst_debug_construct_term_color (guint colorinfo)
782 color = g_string_new ("\033[00");
784 if (colorinfo & GST_DEBUG_BOLD) {
785 g_string_append_len (color, ";01", 3);
787 if (colorinfo & GST_DEBUG_UNDERLINE) {
788 g_string_append_len (color, ";04", 3);
790 if (colorinfo & GST_DEBUG_FG_MASK) {
791 g_string_append_printf (color, ";3%1d", colorinfo & GST_DEBUG_FG_MASK);
793 if (colorinfo & GST_DEBUG_BG_MASK) {
794 g_string_append_printf (color, ";4%1d",
795 (colorinfo & GST_DEBUG_BG_MASK) >> 4);
797 g_string_append_c (color, 'm');
799 return g_string_free (color, FALSE);
803 * gst_debug_construct_win_color:
804 * @colorinfo: the color info
806 * Constructs an integer that can be used for getting the desired color in
807 * windows' terminals (cmd.exe). As there is no mean to underline, we simply
808 * ignore this attribute.
810 * This function returns 0 on non-windows machines.
812 * Returns: an integer containing the color definition
817 gst_debug_construct_win_color (guint colorinfo)
821 static const guchar ansi_to_win_fg[8] = {
823 FOREGROUND_RED, /* red */
824 FOREGROUND_GREEN, /* green */
825 FOREGROUND_RED | FOREGROUND_GREEN, /* yellow */
826 FOREGROUND_BLUE, /* blue */
827 FOREGROUND_RED | FOREGROUND_BLUE, /* magenta */
828 FOREGROUND_GREEN | FOREGROUND_BLUE, /* cyan */
829 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE /* white */
831 static const guchar ansi_to_win_bg[8] = {
835 BACKGROUND_RED | BACKGROUND_GREEN,
837 BACKGROUND_RED | BACKGROUND_BLUE,
838 BACKGROUND_GREEN | FOREGROUND_BLUE,
839 BACKGROUND_RED | BACKGROUND_GREEN | BACKGROUND_BLUE
842 /* we draw black as white, as cmd.exe can only have black bg */
843 if (colorinfo == 0) {
844 return ansi_to_win_fg[7];
847 if (colorinfo & GST_DEBUG_BOLD) {
848 color |= FOREGROUND_INTENSITY;
850 if (colorinfo & GST_DEBUG_FG_MASK) {
851 color |= ansi_to_win_fg[colorinfo & GST_DEBUG_FG_MASK];
853 if (colorinfo & GST_DEBUG_BG_MASK) {
854 color |= ansi_to_win_bg[(colorinfo & GST_DEBUG_BG_MASK) >> 4];
860 /* width of %p varies depending on actual value of pointer, which can make
861 * output unevenly aligned if multiple threads are involved, hence the %14p
862 * (should really be %18p, but %14p seems a good compromise between too many
863 * white spaces and likely unalignment on my system) */
864 #if defined (GLIB_SIZEOF_VOID_P) && GLIB_SIZEOF_VOID_P == 8
865 #define PTR_FMT "%14p"
867 #define PTR_FMT "%10p"
869 #define PID_FMT "%5d"
870 #define CAT_FMT "%20s %s:%d:%s:%s"
873 static const guchar levelcolormap[GST_LEVEL_COUNT] = {
875 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE,
876 /* GST_LEVEL_ERROR */
877 FOREGROUND_RED | FOREGROUND_INTENSITY,
878 /* GST_LEVEL_WARNING */
879 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_INTENSITY,
881 FOREGROUND_GREEN | FOREGROUND_INTENSITY,
882 /* GST_LEVEL_DEBUG */
883 FOREGROUND_GREEN | FOREGROUND_BLUE,
885 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE,
886 /* GST_LEVEL_FIXME */
887 FOREGROUND_RED | FOREGROUND_GREEN,
888 /* GST_LEVEL_TRACE */
889 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE,
890 /* placeholder for log level 8 */
892 /* GST_LEVEL_MEMDUMP */
893 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE
896 static const guchar available_colors[] = {
897 FOREGROUND_RED, FOREGROUND_GREEN, FOREGROUND_RED | FOREGROUND_GREEN,
898 FOREGROUND_BLUE, FOREGROUND_RED | FOREGROUND_BLUE,
899 FOREGROUND_GREEN | FOREGROUND_BLUE,
902 static const gchar *levelcolormap[GST_LEVEL_COUNT] = {
903 "\033[37m", /* GST_LEVEL_NONE */
904 "\033[31;01m", /* GST_LEVEL_ERROR */
905 "\033[33;01m", /* GST_LEVEL_WARNING */
906 "\033[32;01m", /* GST_LEVEL_INFO */
907 "\033[36m", /* GST_LEVEL_DEBUG */
908 "\033[37m", /* GST_LEVEL_LOG */
909 "\033[33;01m", /* GST_LEVEL_FIXME */
910 "\033[37m", /* GST_LEVEL_TRACE */
911 "\033[37m", /* placeholder for log level 8 */
912 "\033[37m" /* GST_LEVEL_MEMDUMP */
917 * gst_debug_log_default:
918 * @category: category to log
919 * @level: level of the message
920 * @file: the file that emitted the message, usually the __FILE__ identifier
921 * @function: the function that emitted the message
922 * @line: the line from that the message was emitted, usually __LINE__
923 * @message: the actual message
924 * @object: (transfer none) (allow-none): the object this message relates to,
926 * @unused: an unused variable, reserved for some user_data.
928 * The default logging handler used by GStreamer. Logging functions get called
929 * whenever a macro like GST_DEBUG or similar is used. This function outputs the
930 * message and additional info to stderr (or the log file specified via the
931 * GST_DEBUG_FILE environment variable).
933 * You can add other handlers by using gst_debug_add_log_function().
934 * And you can remove this handler by calling
935 * gst_debug_remove_log_function(gst_debug_log_default);
938 gst_debug_log_default (GstDebugCategory * category, GstDebugLevel level,
939 const gchar * file, const gchar * function, gint line,
940 GObject * object, GstDebugMessage * message, gpointer unused)
943 GstClockTime elapsed;
947 if (level > gst_debug_category_get_threshold (category))
951 is_colored = gst_debug_is_colored ();
954 obj = gst_debug_print_object (object);
959 elapsed = GST_CLOCK_DIFF (_priv_gst_info_start_time,
960 gst_util_get_timestamp ());
964 /* colors, non-windows */
968 const gchar *levelcolor;
970 color = gst_debug_construct_term_color (gst_debug_category_get_color
973 g_sprintf (pidcolor, "\033[3%1dm", pid % 6 + 31);
974 levelcolor = levelcolormap[level];
976 #define PRINT_FMT " %s"PID_FMT"%s "PTR_FMT" %s%s%s %s"CAT_FMT"%s %s\n"
977 fprintf (log_file, "%" GST_TIME_FORMAT PRINT_FMT, GST_TIME_ARGS (elapsed),
978 pidcolor, pid, clear, g_thread_self (), levelcolor,
979 gst_debug_level_get_name (level), clear, color,
980 gst_debug_category_get_name (category), file, line, function, obj,
981 clear, gst_debug_message_get (message));
986 /* colors, windows. We take a lock to keep colors and content together.
987 * Maybe there is a better way but for now this will do the right
989 static GStaticMutex win_print_mutex = G_STATIC_MUTEX_INIT;
990 const gint clear = FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE;
991 #define SET_COLOR(c) G_STMT_START { \
992 if (log_file == stderr) \
993 SetConsoleTextAttribute (GetStdHandle (STD_ERROR_HANDLE), (c)); \
995 g_static_mutex_lock (&win_print_mutex);
997 fprintf (log_file, "%" GST_TIME_FORMAT " ", GST_TIME_ARGS (elapsed));
1000 SET_COLOR (available_colors[pid % G_N_ELEMENTS (available_colors)]);
1001 fprintf (log_file, PID_FMT, pid);
1005 fprintf (log_file, " " PTR_FMT " ", g_thread_self ());
1008 SET_COLOR (levelcolormap[level]);
1009 fprintf (log_file, "%s ", gst_debug_level_get_name (level));
1012 SET_COLOR (gst_debug_construct_win_color (gst_debug_category_get_color
1014 fprintf (log_file, CAT_FMT, gst_debug_category_get_name (category),
1015 file, line, function, obj);
1019 fprintf (log_file, " %s\n", gst_debug_message_get (message));
1021 g_static_mutex_unlock (&win_print_mutex);
1024 /* no color, all platforms */
1025 #define PRINT_FMT " "PID_FMT" "PTR_FMT" %s "CAT_FMT" %s\n"
1026 fprintf (log_file, "%" GST_TIME_FORMAT PRINT_FMT, GST_TIME_ARGS (elapsed),
1027 pid, g_thread_self (), gst_debug_level_get_name (level),
1028 gst_debug_category_get_name (category), file, line, function, obj,
1029 gst_debug_message_get (message));
1038 * gst_debug_level_get_name:
1039 * @level: the level to get the name for
1041 * Get the string representation of a debugging level
1046 gst_debug_level_get_name (GstDebugLevel level)
1049 case GST_LEVEL_NONE:
1051 case GST_LEVEL_ERROR:
1053 case GST_LEVEL_WARNING:
1055 case GST_LEVEL_INFO:
1057 case GST_LEVEL_DEBUG:
1061 case GST_LEVEL_FIXME:
1063 case GST_LEVEL_TRACE:
1065 case GST_LEVEL_MEMDUMP:
1068 g_warning ("invalid level specified for gst_debug_level_get_name");
1074 * gst_debug_add_log_function:
1075 * @func: the function to use
1076 * @data: (closure): user data
1078 * Adds the logging function to the list of logging functions.
1079 * Be sure to use #G_GNUC_NO_INSTRUMENT on that function, it is needed.
1082 gst_debug_add_log_function (GstLogFunction func, gpointer data)
1084 LogFuncEntry *entry;
1088 func = gst_debug_log_default;
1090 entry = g_slice_new (LogFuncEntry);
1092 entry->user_data = data;
1093 /* FIXME: we leak the old list here - other threads might access it right now
1094 * in gst_debug_logv. Another solution is to lock the mutex in gst_debug_logv,
1095 * but that is waaay costly.
1096 * It'd probably be clever to use some kind of RCU here, but I don't know
1097 * anything about that.
1099 g_static_mutex_lock (&__log_func_mutex);
1100 list = g_slist_copy (__log_functions);
1101 __log_functions = g_slist_prepend (list, entry);
1102 g_static_mutex_unlock (&__log_func_mutex);
1104 GST_DEBUG ("prepended log function %p (user data %p) to log functions",
1109 gst_debug_compare_log_function_by_func (gconstpointer entry, gconstpointer func)
1111 gpointer entryfunc = (gpointer) (((LogFuncEntry *) entry)->func);
1113 return (entryfunc < func) ? -1 : (entryfunc > func) ? 1 : 0;
1117 gst_debug_compare_log_function_by_data (gconstpointer entry, gconstpointer data)
1119 gpointer entrydata = ((LogFuncEntry *) entry)->user_data;
1121 return (entrydata < data) ? -1 : (entrydata > data) ? 1 : 0;
1125 gst_debug_remove_with_compare_func (GCompareFunc func, gpointer data)
1131 g_static_mutex_lock (&__log_func_mutex);
1132 new = __log_functions;
1133 while ((found = g_slist_find_custom (new, data, func))) {
1134 if (new == __log_functions) {
1135 /* make a copy when we have the first hit, so that we modify the copy and
1136 * make that the new list later */
1137 new = g_slist_copy (new);
1140 g_slice_free (LogFuncEntry, found->data);
1141 new = g_slist_delete_link (new, found);
1144 /* FIXME: We leak the old list here. See _add_log_function for why. */
1145 __log_functions = new;
1146 g_static_mutex_unlock (&__log_func_mutex);
1152 * gst_debug_remove_log_function:
1153 * @func: the log function to remove
1155 * Removes all registered instances of the given logging functions.
1157 * Returns: How many instances of the function were removed
1160 gst_debug_remove_log_function (GstLogFunction func)
1165 func = gst_debug_log_default;
1168 gst_debug_remove_with_compare_func
1169 (gst_debug_compare_log_function_by_func, (gpointer) func);
1170 GST_DEBUG ("removed log function %p %d times from log function list", func,
1177 * gst_debug_remove_log_function_by_data:
1178 * @data: user data of the log function to remove
1180 * Removes all registered instances of log functions with the given user data.
1182 * Returns: How many instances of the function were removed
1185 gst_debug_remove_log_function_by_data (gpointer data)
1190 gst_debug_remove_with_compare_func
1191 (gst_debug_compare_log_function_by_data, data);
1193 ("removed %d log functions with user data %p from log function list",
1200 * gst_debug_set_colored:
1201 * @colored: Whether to use colored output or not
1203 * Sets or unsets the use of coloured debugging output.
1205 * This function may be called before gst_init().
1208 gst_debug_set_colored (gboolean colored)
1210 g_atomic_int_set (&__use_color, (gint) colored);
1214 * gst_debug_is_colored:
1216 * Checks if the debugging output should be colored.
1218 * Returns: TRUE, if the debug output should be colored.
1221 gst_debug_is_colored (void)
1223 return (gboolean) g_atomic_int_get (&__use_color);
1227 * gst_debug_set_active:
1228 * @active: Whether to use debugging output or not
1230 * If activated, debugging messages are sent to the debugging
1232 * It makes sense to deactivate it for speed issues.
1233 * <note><para>This function is not threadsafe. It makes sense to only call it
1234 * during initialization.</para></note>
1237 gst_debug_set_active (gboolean active)
1239 __gst_debug_enabled = active;
1241 __gst_debug_min = GST_LEVEL_COUNT;
1243 __gst_debug_min = GST_LEVEL_NONE;
1247 * gst_debug_is_active:
1249 * Checks if debugging output is activated.
1251 * Returns: TRUE, if debugging is activated
1254 gst_debug_is_active (void)
1256 return __gst_debug_enabled;
1260 * gst_debug_set_default_threshold:
1261 * @level: level to set
1263 * Sets the default threshold to the given level and updates all categories to
1264 * use this threshold.
1266 * This function may be called before gst_init().
1269 gst_debug_set_default_threshold (GstDebugLevel level)
1271 g_atomic_int_set (&__default_level, level);
1272 gst_debug_reset_all_thresholds ();
1276 * gst_debug_get_default_threshold:
1278 * Returns the default threshold that is used for new categories.
1280 * Returns: the default threshold level
1283 gst_debug_get_default_threshold (void)
1285 return (GstDebugLevel) g_atomic_int_get (&__default_level);
1289 gst_debug_reset_threshold (gpointer category, gpointer unused)
1291 GstDebugCategory *cat = (GstDebugCategory *) category;
1294 g_static_mutex_lock (&__level_name_mutex);
1295 walk = __level_name;
1297 LevelNameEntry *entry = walk->data;
1299 walk = g_slist_next (walk);
1300 if (g_pattern_match_string (entry->pat, cat->name)) {
1301 GST_LOG ("category %s matches pattern %p - gets set to level %d",
1302 cat->name, entry->pat, entry->level);
1303 gst_debug_category_set_threshold (cat, entry->level);
1307 gst_debug_category_set_threshold (cat, gst_debug_get_default_threshold ());
1310 g_static_mutex_unlock (&__level_name_mutex);
1314 gst_debug_reset_all_thresholds (void)
1316 g_static_mutex_lock (&__cat_mutex);
1317 g_slist_foreach (__categories, gst_debug_reset_threshold, NULL);
1318 g_static_mutex_unlock (&__cat_mutex);
1322 for_each_threshold_by_entry (gpointer data, gpointer user_data)
1324 GstDebugCategory *cat = (GstDebugCategory *) data;
1325 LevelNameEntry *entry = (LevelNameEntry *) user_data;
1327 if (g_pattern_match_string (entry->pat, cat->name)) {
1328 GST_LOG ("category %s matches pattern %p - gets set to level %d",
1329 cat->name, entry->pat, entry->level);
1330 gst_debug_category_set_threshold (cat, entry->level);
1335 * gst_debug_set_threshold_for_name:
1336 * @name: name of the categories to set
1337 * @level: level to set them to
1339 * Sets all categories which match the given glob style pattern to the given
1343 gst_debug_set_threshold_for_name (const gchar * name, GstDebugLevel level)
1346 LevelNameEntry *entry;
1348 g_return_if_fail (name != NULL);
1350 pat = g_pattern_spec_new (name);
1351 entry = g_slice_new (LevelNameEntry);
1353 entry->level = level;
1354 g_static_mutex_lock (&__level_name_mutex);
1355 __level_name = g_slist_prepend (__level_name, entry);
1356 g_static_mutex_unlock (&__level_name_mutex);
1357 g_static_mutex_lock (&__cat_mutex);
1358 g_slist_foreach (__categories, for_each_threshold_by_entry, entry);
1359 g_static_mutex_unlock (&__cat_mutex);
1363 * gst_debug_unset_threshold_for_name:
1364 * @name: name of the categories to set
1366 * Resets all categories with the given name back to the default level.
1369 gst_debug_unset_threshold_for_name (const gchar * name)
1374 g_return_if_fail (name != NULL);
1376 pat = g_pattern_spec_new (name);
1377 g_static_mutex_lock (&__level_name_mutex);
1378 walk = __level_name;
1379 /* improve this if you want, it's mighty slow */
1381 LevelNameEntry *entry = walk->data;
1383 if (g_pattern_spec_equal (entry->pat, pat)) {
1384 __level_name = g_slist_remove_link (__level_name, walk);
1385 g_pattern_spec_free (entry->pat);
1386 g_slice_free (LevelNameEntry, entry);
1387 g_slist_free_1 (walk);
1388 walk = __level_name;
1391 g_static_mutex_unlock (&__level_name_mutex);
1392 g_pattern_spec_free (pat);
1393 gst_debug_reset_all_thresholds ();
1397 _gst_debug_category_new (const gchar * name, guint color,
1398 const gchar * description)
1400 GstDebugCategory *cat;
1402 g_return_val_if_fail (name != NULL, NULL);
1404 cat = g_slice_new (GstDebugCategory);
1405 cat->name = g_strdup (name);
1407 if (description != NULL) {
1408 cat->description = g_strdup (description);
1410 cat->description = g_strdup ("no description");
1412 g_atomic_int_set (&cat->threshold, 0);
1413 gst_debug_reset_threshold (cat, NULL);
1415 /* add to category list */
1416 g_static_mutex_lock (&__cat_mutex);
1417 __categories = g_slist_prepend (__categories, cat);
1418 g_static_mutex_unlock (&__cat_mutex);
1424 * gst_debug_category_free:
1425 * @category: #GstDebugCategory to free.
1427 * Removes and frees the category and all associated resources.
1430 gst_debug_category_free (GstDebugCategory * category)
1432 if (category == NULL)
1435 /* remove from category list */
1436 g_static_mutex_lock (&__cat_mutex);
1437 __categories = g_slist_remove (__categories, category);
1438 g_static_mutex_unlock (&__cat_mutex);
1440 g_free ((gpointer) category->name);
1441 g_free ((gpointer) category->description);
1442 g_slice_free (GstDebugCategory, category);
1446 * gst_debug_category_set_threshold:
1447 * @category: a #GstDebugCategory to set threshold of.
1448 * @level: the #GstDebugLevel threshold to set.
1450 * Sets the threshold of the category to the given level. Debug information will
1451 * only be output if the threshold is lower or equal to the level of the
1452 * debugging message.
1454 * Do not use this function in production code, because other functions may
1455 * change the threshold of categories as side effect. It is however a nice
1456 * function to use when debugging (even from gdb).
1460 gst_debug_category_set_threshold (GstDebugCategory * category,
1461 GstDebugLevel level)
1463 g_return_if_fail (category != NULL);
1465 if (level > __gst_debug_min) {
1466 __gst_debug_enabled = TRUE;
1467 __gst_debug_min = level;
1470 g_atomic_int_set (&category->threshold, level);
1474 * gst_debug_category_reset_threshold:
1475 * @category: a #GstDebugCategory to reset threshold of.
1477 * Resets the threshold of the category to the default level. Debug information
1478 * will only be output if the threshold is lower or equal to the level of the
1479 * debugging message.
1480 * Use this function to set the threshold back to where it was after using
1481 * gst_debug_category_set_threshold().
1484 gst_debug_category_reset_threshold (GstDebugCategory * category)
1486 gst_debug_reset_threshold (category, NULL);
1490 * gst_debug_category_get_threshold:
1491 * @category: a #GstDebugCategory to get threshold of.
1493 * Returns the threshold of a #GstDebugCategory.
1495 * Returns: the #GstDebugLevel that is used as threshold.
1498 gst_debug_category_get_threshold (GstDebugCategory * category)
1500 return (GstDebugLevel) g_atomic_int_get (&category->threshold);
1504 * gst_debug_category_get_name:
1505 * @category: a #GstDebugCategory to get name of.
1507 * Returns the name of a debug category.
1509 * Returns: the name of the category.
1512 gst_debug_category_get_name (GstDebugCategory * category)
1514 return category->name;
1518 * gst_debug_category_get_color:
1519 * @category: a #GstDebugCategory to get the color of.
1521 * Returns the color of a debug category used when printing output in this
1524 * Returns: the color of the category.
1527 gst_debug_category_get_color (GstDebugCategory * category)
1529 return category->color;
1533 * gst_debug_category_get_description:
1534 * @category: a #GstDebugCategory to get the description of.
1536 * Returns the description of a debug category.
1538 * Returns: the description of the category.
1541 gst_debug_category_get_description (GstDebugCategory * category)
1543 return category->description;
1547 * gst_debug_get_all_categories:
1549 * Returns a snapshot of a all categories that are currently in use . This list
1550 * may change anytime.
1551 * The caller has to free the list after use.
1553 * Returns: (transfer container) (element-type Gst.DebugCategory): the list of
1557 gst_debug_get_all_categories (void)
1561 g_static_mutex_lock (&__cat_mutex);
1562 ret = g_slist_copy (__categories);
1563 g_static_mutex_unlock (&__cat_mutex);
1569 _gst_debug_get_category (const gchar * name)
1571 GstDebugCategory *ret = NULL;
1574 for (node = __categories; node; node = g_slist_next (node)) {
1575 ret = (GstDebugCategory *) node->data;
1576 if (!strcmp (name, ret->name)) {
1583 /*** FUNCTION POINTERS ********************************************************/
1585 static GHashTable *__gst_function_pointers; /* NULL */
1586 static GStaticMutex __dbg_functions_mutex = G_STATIC_MUTEX_INIT;
1588 /* This function MUST NOT return NULL */
1590 _gst_debug_nameof_funcptr (GstDebugFuncPtr func)
1598 if (G_UNLIKELY (func == NULL))
1601 g_static_mutex_lock (&__dbg_functions_mutex);
1602 if (G_LIKELY (__gst_function_pointers)) {
1603 ptrname = g_hash_table_lookup (__gst_function_pointers, (gpointer) func);
1604 g_static_mutex_unlock (&__dbg_functions_mutex);
1605 if (G_LIKELY (ptrname))
1608 g_static_mutex_unlock (&__dbg_functions_mutex);
1610 /* we need to create an entry in the hash table for this one so we don't leak
1613 if (dladdr ((gpointer) func, &dl_info) && dl_info.dli_sname) {
1614 gchar *name = g_strdup (dl_info.dli_sname);
1616 _gst_debug_register_funcptr (func, name);
1621 gchar *name = g_strdup_printf ("%p", (gpointer) func);
1623 _gst_debug_register_funcptr (func, name);
1629 _gst_debug_register_funcptr (GstDebugFuncPtr func, const gchar * ptrname)
1631 gpointer ptr = (gpointer) func;
1633 g_static_mutex_lock (&__dbg_functions_mutex);
1635 if (!__gst_function_pointers)
1636 __gst_function_pointers = g_hash_table_new (g_direct_hash, g_direct_equal);
1637 if (!g_hash_table_lookup (__gst_function_pointers, ptr))
1638 g_hash_table_insert (__gst_function_pointers, ptr, (gpointer) ptrname);
1640 g_static_mutex_unlock (&__dbg_functions_mutex);
1643 /*** PRINTF EXTENSIONS ********************************************************/
1645 #ifdef HAVE_PRINTF_EXTENSION
1647 _gst_info_printf_extension_ptr (FILE * stream, const struct printf_info *info,
1648 const void *const *args)
1655 ptr = *(void **) args[0];
1657 buffer = gst_debug_print_object (ptr);
1658 len = fprintf (stream, "%*s", (info->left ? -info->width : info->width),
1666 _gst_info_printf_extension_segment (FILE * stream,
1667 const struct printf_info *info, const void *const *args)
1674 ptr = *(void **) args[0];
1676 buffer = gst_debug_print_segment (ptr);
1677 len = fprintf (stream, "%*s", (info->left ? -info->width : info->width),
1684 #ifdef HAVE_REGISTER_PRINTF_SPECIFIER
1686 _gst_info_printf_extension_arginfo (const struct printf_info *info, size_t n,
1687 int *argtypes, int *size)
1690 _gst_info_printf_extension_arginfo (const struct printf_info *info, size_t n,
1695 argtypes[0] = PA_POINTER;
1696 #ifdef HAVE_REGISTER_PRINTF_SPECIFIER
1697 *size = sizeof (gpointer);
1702 #endif /* HAVE_PRINTF_EXTENSION */
1705 gst_info_dump_mem_line (gchar * linebuf, gsize linebuf_size,
1706 const guint8 * mem, gsize mem_offset, gsize mem_size)
1708 gchar hexstr[50], ascstr[18], digitstr[4];
1720 while (i < mem_size) {
1721 ascstr[i] = (g_ascii_isprint (mem[i])) ? mem[i] : '.';
1722 g_snprintf (digitstr, sizeof (digitstr), "%02x ", mem[i]);
1723 g_strlcat (hexstr, digitstr, sizeof (hexstr));
1729 g_snprintf (linebuf, linebuf_size, "%08x: %-48.48s %-16.16s",
1730 (guint) mem_offset, hexstr, ascstr);
1734 _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
1735 const gchar * func, gint line, GObject * obj, const gchar * msg,
1736 const guint8 * data, guint length)
1740 gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "--------"
1741 "-------------------------------------------------------------------");
1743 if (msg != NULL && *msg != '\0') {
1744 gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "%s", msg);
1747 while (off < length) {
1750 /* gst_info_dump_mem_line will process 16 bytes at most */
1751 gst_info_dump_mem_line (buf, sizeof (buf), data, off, length - off);
1752 gst_debug_log (cat, GST_LEVEL_MEMDUMP, file, func, line, obj, "%s", buf);
1756 gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "--------"
1757 "-------------------------------------------------------------------");
1760 #else /* !GST_DISABLE_GST_DEBUG */
1761 #ifndef GST_REMOVE_DISABLED
1764 _gst_debug_category_new (const gchar * name, guint color,
1765 const gchar * description)
1771 _gst_debug_register_funcptr (GstDebugFuncPtr func, const gchar * ptrname)
1775 /* This function MUST NOT return NULL */
1777 _gst_debug_nameof_funcptr (GstDebugFuncPtr func)
1783 gst_debug_log (GstDebugCategory * category, GstDebugLevel level,
1784 const gchar * file, const gchar * function, gint line,
1785 GObject * object, const gchar * format, ...)
1790 gst_debug_log_valist (GstDebugCategory * category, GstDebugLevel level,
1791 const gchar * file, const gchar * function, gint line,
1792 GObject * object, const gchar * format, va_list args)
1797 gst_debug_message_get (GstDebugMessage * message)
1803 gst_debug_log_default (GstDebugCategory * category, GstDebugLevel level,
1804 const gchar * file, const gchar * function, gint line,
1805 GObject * object, GstDebugMessage * message, gpointer unused)
1810 gst_debug_level_get_name (GstDebugLevel level)
1816 gst_debug_add_log_function (GstLogFunction func, gpointer data)
1821 gst_debug_remove_log_function (GstLogFunction func)
1827 gst_debug_remove_log_function_by_data (gpointer data)
1833 gst_debug_set_active (gboolean active)
1838 gst_debug_is_active (void)
1844 gst_debug_set_colored (gboolean colored)
1849 gst_debug_is_colored (void)
1855 gst_debug_set_default_threshold (GstDebugLevel level)
1860 gst_debug_get_default_threshold (void)
1862 return GST_LEVEL_NONE;
1866 gst_debug_set_threshold_for_name (const gchar * name, GstDebugLevel level)
1871 gst_debug_unset_threshold_for_name (const gchar * name)
1876 gst_debug_category_free (GstDebugCategory * category)
1881 gst_debug_category_set_threshold (GstDebugCategory * category,
1882 GstDebugLevel level)
1887 gst_debug_category_reset_threshold (GstDebugCategory * category)
1892 gst_debug_category_get_threshold (GstDebugCategory * category)
1894 return GST_LEVEL_NONE;
1898 gst_debug_category_get_name (GstDebugCategory * category)
1904 gst_debug_category_get_color (GstDebugCategory * category)
1910 gst_debug_category_get_description (GstDebugCategory * category)
1916 gst_debug_get_all_categories (void)
1922 _gst_debug_get_category (const gchar * name)
1928 gst_debug_construct_term_color (guint colorinfo)
1930 return g_strdup ("00");
1934 gst_debug_construct_win_color (guint colorinfo)
1940 _priv_gst_in_valgrind (void)
1946 _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
1947 const gchar * func, gint line, GObject * obj, const gchar * msg,
1948 const guint8 * data, guint length)
1951 #endif /* GST_REMOVE_DISABLED */
1952 #endif /* GST_DISABLE_GST_DEBUG */
1955 #ifdef GST_ENABLE_FUNC_INSTRUMENTATION
1956 /* FIXME make this thread specific */
1957 static GSList *stack_trace = NULL;
1960 __cyg_profile_func_enter (void *this_fn, void *call_site)
1961 G_GNUC_NO_INSTRUMENT;
1962 void __cyg_profile_func_enter (void *this_fn, void *call_site)
1964 gchar *name = _gst_debug_nameof_funcptr (this_fn);
1965 gchar *site = _gst_debug_nameof_funcptr (call_site);
1967 GST_CAT_DEBUG (GST_CAT_CALL_TRACE, "entering function %s from %s", name,
1970 g_slist_prepend (stack_trace, g_strdup_printf ("%8p in %s from %p (%s)",
1971 this_fn, name, call_site, site));
1978 __cyg_profile_func_exit (void *this_fn, void *call_site)
1979 G_GNUC_NO_INSTRUMENT;
1980 void __cyg_profile_func_exit (void *this_fn, void *call_site)
1982 gchar *name = _gst_debug_nameof_funcptr (this_fn);
1984 GST_CAT_DEBUG (GST_CAT_CALL_TRACE, "leaving function %s", name);
1985 g_free (stack_trace->data);
1986 stack_trace = g_slist_delete_link (stack_trace, stack_trace);
1992 * gst_debug_print_stack_trace:
1994 * If GST_ENABLE_FUNC_INSTRUMENTATION is defined a stacktrace is available for
1995 * gstreamer code, which can be printed with this function.
1998 gst_debug_print_stack_trace (void)
2000 GSList *walk = stack_trace;
2004 walk = g_slist_next (walk);
2007 gchar *name = (gchar *) walk->data;
2009 g_print ("#%-2d %s\n", count++, name);
2011 walk = g_slist_next (walk);
2016 gst_debug_print_stack_trace (void)
2018 /* nothing because it's compiled out */
2021 #endif /* GST_ENABLE_FUNC_INSTRUMENTATION */