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 #ifndef GST_DISABLE_GST_DEBUG
98 #ifdef HAVE_PRINTF_EXTENSION
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 #ifdef HAVE_VALGRIND_VALGRIND_H
121 # include <valgrind/valgrind.h>
123 #include <glib/gprintf.h> /* g_sprintf */
125 #endif /* !GST_DISABLE_GST_DEBUG */
127 /* we want these symbols exported even if debug is disabled, to maintain
128 * ABI compatibility. Unless GST_REMOVE_DISABLED is defined. */
129 #if !defined(GST_DISABLE_GST_DEBUG) || !defined(GST_REMOVE_DISABLED)
131 /* disabled by default, as soon as some threshold is set > NONE,
132 * it becomes enabled. */
133 gboolean __gst_debug_enabled = FALSE;
134 GstDebugLevel __gst_debug_min = GST_LEVEL_NONE;
136 GstDebugCategory *GST_CAT_DEFAULT = NULL;
138 GstDebugCategory *GST_CAT_GST_INIT = NULL;
139 GstDebugCategory *GST_CAT_AUTOPLUG = NULL;
140 GstDebugCategory *GST_CAT_AUTOPLUG_ATTEMPT = NULL;
141 GstDebugCategory *GST_CAT_PARENTAGE = NULL;
142 GstDebugCategory *GST_CAT_STATES = NULL;
143 GstDebugCategory *GST_CAT_SCHEDULING = NULL;
145 GstDebugCategory *GST_CAT_BUFFER = NULL;
146 GstDebugCategory *GST_CAT_BUFFER_LIST = NULL;
147 GstDebugCategory *GST_CAT_BUS = NULL;
148 GstDebugCategory *GST_CAT_CAPS = NULL;
149 GstDebugCategory *GST_CAT_CLOCK = NULL;
150 GstDebugCategory *GST_CAT_ELEMENT_PADS = NULL;
151 GstDebugCategory *GST_CAT_PADS = NULL;
152 GstDebugCategory *GST_CAT_PERFORMANCE = NULL;
153 GstDebugCategory *GST_CAT_PIPELINE = NULL;
154 GstDebugCategory *GST_CAT_PLUGIN_LOADING = NULL;
155 GstDebugCategory *GST_CAT_PLUGIN_INFO = NULL;
156 GstDebugCategory *GST_CAT_PROPERTIES = NULL;
157 GstDebugCategory *GST_CAT_TYPES = NULL;
158 GstDebugCategory *GST_CAT_XML = NULL;
159 GstDebugCategory *GST_CAT_NEGOTIATION = NULL;
160 GstDebugCategory *GST_CAT_REFCOUNTING = NULL;
161 GstDebugCategory *GST_CAT_ERROR_SYSTEM = NULL;
162 GstDebugCategory *GST_CAT_EVENT = NULL;
163 GstDebugCategory *GST_CAT_MESSAGE = NULL;
164 GstDebugCategory *GST_CAT_PARAMS = NULL;
165 GstDebugCategory *GST_CAT_CALL_TRACE = NULL;
166 GstDebugCategory *GST_CAT_SIGNAL = NULL;
167 GstDebugCategory *GST_CAT_PROBE = NULL;
168 GstDebugCategory *GST_CAT_REGISTRY = NULL;
169 GstDebugCategory *GST_CAT_QOS = NULL;
170 GstDebugCategory *_priv_GST_CAT_POLL = NULL;
173 #endif /* !defined(GST_DISABLE_GST_DEBUG) || !defined(GST_REMOVE_DISABLED) */
175 #ifndef GST_DISABLE_GST_DEBUG
177 /* underscore is to prevent conflict with GST_CAT_DEBUG define */
178 GST_DEBUG_CATEGORY_STATIC (_GST_CAT_DEBUG);
180 /* time of initialization, so we get useful debugging output times
181 * FIXME: we use this in gstdebugutils.c, what about a function + macro to
182 * get the running time: GST_DEBUG_RUNNING_TIME
184 GstClockTime _priv_gst_info_start_time;
188 #include <rld_interface.h>
189 typedef struct DL_INFO
191 const char *dli_fname;
193 const char *dli_sname;
197 long dli_reserved[4];
201 #define _RLD_DLADDR 14
202 int dladdr (void *address, Dl_info * dl);
205 dladdr (void *address, Dl_info * dl)
209 v = _rld_new_interface (_RLD_DLADDR, address, dl);
215 static void gst_debug_reset_threshold (gpointer category, gpointer unused);
216 static void gst_debug_reset_all_thresholds (void);
218 #ifdef HAVE_PRINTF_EXTENSION
219 static int _gst_info_printf_extension_ptr (FILE * stream,
220 const struct printf_info *info, const void *const *args);
221 static int _gst_info_printf_extension_segment (FILE * stream,
222 const struct printf_info *info, const void *const *args);
223 #ifdef HAVE_REGISTER_PRINTF_SPECIFIER
224 static int _gst_info_printf_extension_arginfo (const struct printf_info *info,
225 size_t n, int *argtypes, int *size);
227 static int _gst_info_printf_extension_arginfo (const struct printf_info *info,
228 size_t n, int *argtypes);
232 struct _GstDebugMessage
239 /* list of all name/level pairs from --gst-debug and GST_DEBUG */
240 static GStaticMutex __level_name_mutex = G_STATIC_MUTEX_INIT;
241 static GSList *__level_name = NULL;
249 /* list of all categories */
250 static GStaticMutex __cat_mutex = G_STATIC_MUTEX_INIT;
251 static GSList *__categories = NULL;
253 /* all registered debug handlers */
260 static GStaticMutex __log_func_mutex = G_STATIC_MUTEX_INIT;
261 static GSList *__log_functions = NULL;
263 #define PRETTY_TAGS_DEFAULT TRUE
264 static gboolean pretty_tags = PRETTY_TAGS_DEFAULT;
266 static volatile gint G_GNUC_MAY_ALIAS __default_level = GST_LEVEL_DEFAULT;
267 static volatile gint G_GNUC_MAY_ALIAS __use_color = 1;
269 static FILE *log_file;
271 /* FIXME: export this? */
273 _priv_gst_in_valgrind (void)
281 in_valgrind = GST_VG_UNCHECKED;
283 if (in_valgrind == GST_VG_UNCHECKED) {
284 #ifdef HAVE_VALGRIND_VALGRIND_H
285 if (RUNNING_ON_VALGRIND) {
286 GST_CAT_INFO (GST_CAT_GST_INIT, "we're running inside valgrind");
287 printf ("GStreamer has detected that it is running inside valgrind.\n");
288 printf ("It might now take different code paths to ease debugging.\n");
289 printf ("Of course, this may also lead to different bugs.\n");
290 in_valgrind = GST_VG_INSIDE;
292 GST_CAT_LOG (GST_CAT_GST_INIT, "not doing extra valgrind stuff");
293 in_valgrind = GST_VG_NO_VALGRIND;
296 in_valgrind = GST_VG_NO_VALGRIND;
298 g_assert (in_valgrind == GST_VG_NO_VALGRIND ||
299 in_valgrind == GST_VG_INSIDE);
301 return (in_valgrind == GST_VG_INSIDE);
307 * Initializes the debugging system.
308 * Normally you don't want to call this, because gst_init() does it for you.
311 _gst_debug_init (void)
315 env = g_getenv ("GST_DEBUG_FILE");
316 if (env != NULL && *env != '\0') {
317 if (strcmp (env, "-") == 0) {
320 log_file = g_fopen (env, "w");
321 if (log_file == NULL) {
322 g_printerr ("Could not open log file '%s' for writing: %s\n", env,
331 /* get time we started for debugging messages */
332 _priv_gst_info_start_time = gst_util_get_timestamp ();
334 #ifdef HAVE_PRINTF_EXTENSION
335 #ifdef HAVE_REGISTER_PRINTF_SPECIFIER
336 register_printf_specifier (GST_PTR_FORMAT[0], _gst_info_printf_extension_ptr,
337 _gst_info_printf_extension_arginfo);
338 register_printf_specifier (GST_SEGMENT_FORMAT[0],
339 _gst_info_printf_extension_segment, _gst_info_printf_extension_arginfo);
341 register_printf_function (GST_PTR_FORMAT[0], _gst_info_printf_extension_ptr,
342 _gst_info_printf_extension_arginfo);
343 register_printf_function (GST_SEGMENT_FORMAT[0],
344 _gst_info_printf_extension_segment, _gst_info_printf_extension_arginfo);
348 /* do NOT use a single debug function before this line has been run */
349 GST_CAT_DEFAULT = _gst_debug_category_new ("default",
350 GST_DEBUG_UNDERLINE, NULL);
351 _GST_CAT_DEBUG = _gst_debug_category_new ("GST_DEBUG",
352 GST_DEBUG_BOLD | GST_DEBUG_FG_YELLOW, "debugging subsystem");
354 /* we need to use the publicly visible address, so that one could remove it by
355 * the same address */
357 GModule *module = g_module_open (NULL, 0);
360 g_module_symbol (module, "gst_debug_log_default", &ptr);
361 gst_debug_add_log_function (ptr, NULL);
362 g_module_close (module);
365 /* FIXME: add descriptions here */
366 GST_CAT_GST_INIT = _gst_debug_category_new ("GST_INIT",
367 GST_DEBUG_BOLD | GST_DEBUG_FG_RED, NULL);
368 GST_CAT_AUTOPLUG = _gst_debug_category_new ("GST_AUTOPLUG",
369 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
370 GST_CAT_AUTOPLUG_ATTEMPT = _gst_debug_category_new ("GST_AUTOPLUG_ATTEMPT",
371 GST_DEBUG_BOLD | GST_DEBUG_FG_CYAN | GST_DEBUG_BG_BLUE, NULL);
372 GST_CAT_PARENTAGE = _gst_debug_category_new ("GST_PARENTAGE",
373 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
374 GST_CAT_STATES = _gst_debug_category_new ("GST_STATES",
375 GST_DEBUG_BOLD | GST_DEBUG_FG_RED, NULL);
376 GST_CAT_SCHEDULING = _gst_debug_category_new ("GST_SCHEDULING",
377 GST_DEBUG_BOLD | GST_DEBUG_FG_MAGENTA, NULL);
378 GST_CAT_BUFFER = _gst_debug_category_new ("GST_BUFFER",
379 GST_DEBUG_BOLD | GST_DEBUG_BG_GREEN, NULL);
380 GST_CAT_BUFFER_LIST = _gst_debug_category_new ("GST_BUFFER_LIST",
381 GST_DEBUG_BOLD | GST_DEBUG_BG_GREEN, NULL);
382 GST_CAT_BUS = _gst_debug_category_new ("GST_BUS", GST_DEBUG_BG_YELLOW, NULL);
383 GST_CAT_CAPS = _gst_debug_category_new ("GST_CAPS",
384 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
385 GST_CAT_CLOCK = _gst_debug_category_new ("GST_CLOCK",
386 GST_DEBUG_BOLD | GST_DEBUG_FG_YELLOW, NULL);
387 GST_CAT_ELEMENT_PADS = _gst_debug_category_new ("GST_ELEMENT_PADS",
388 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
389 GST_CAT_PADS = _gst_debug_category_new ("GST_PADS",
390 GST_DEBUG_BOLD | GST_DEBUG_FG_RED | GST_DEBUG_BG_RED, NULL);
391 GST_CAT_PERFORMANCE = _gst_debug_category_new ("GST_PERFORMANCE",
392 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
393 GST_CAT_PIPELINE = _gst_debug_category_new ("GST_PIPELINE",
394 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
395 GST_CAT_PLUGIN_LOADING = _gst_debug_category_new ("GST_PLUGIN_LOADING",
396 GST_DEBUG_BOLD | GST_DEBUG_FG_CYAN, NULL);
397 GST_CAT_PLUGIN_INFO = _gst_debug_category_new ("GST_PLUGIN_INFO",
398 GST_DEBUG_BOLD | GST_DEBUG_FG_CYAN, NULL);
399 GST_CAT_PROPERTIES = _gst_debug_category_new ("GST_PROPERTIES",
400 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_BLUE, NULL);
401 GST_CAT_TYPES = _gst_debug_category_new ("GST_TYPES",
402 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
403 GST_CAT_XML = _gst_debug_category_new ("GST_XML",
404 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
405 GST_CAT_NEGOTIATION = _gst_debug_category_new ("GST_NEGOTIATION",
406 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
407 GST_CAT_REFCOUNTING = _gst_debug_category_new ("GST_REFCOUNTING",
408 GST_DEBUG_BOLD | GST_DEBUG_FG_RED | GST_DEBUG_BG_BLUE, NULL);
409 GST_CAT_ERROR_SYSTEM = _gst_debug_category_new ("GST_ERROR_SYSTEM",
410 GST_DEBUG_BOLD | GST_DEBUG_FG_RED | GST_DEBUG_BG_WHITE, NULL);
412 GST_CAT_EVENT = _gst_debug_category_new ("GST_EVENT",
413 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
414 GST_CAT_MESSAGE = _gst_debug_category_new ("GST_MESSAGE",
415 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
416 GST_CAT_PARAMS = _gst_debug_category_new ("GST_PARAMS",
417 GST_DEBUG_BOLD | GST_DEBUG_FG_BLACK | GST_DEBUG_BG_YELLOW, NULL);
418 GST_CAT_CALL_TRACE = _gst_debug_category_new ("GST_CALL_TRACE",
419 GST_DEBUG_BOLD, NULL);
420 GST_CAT_SIGNAL = _gst_debug_category_new ("GST_SIGNAL",
421 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
422 GST_CAT_PROBE = _gst_debug_category_new ("GST_PROBE",
423 GST_DEBUG_BOLD | GST_DEBUG_FG_GREEN, "pad probes");
424 GST_CAT_REGISTRY = _gst_debug_category_new ("GST_REGISTRY", 0, "registry");
425 GST_CAT_QOS = _gst_debug_category_new ("GST_QOS", 0, "QoS");
426 _priv_GST_CAT_POLL = _gst_debug_category_new ("GST_POLL", 0, "poll");
429 /* print out the valgrind message if we're in valgrind */
430 _priv_gst_in_valgrind ();
432 env = g_getenv ("GST_DEBUG_OPTIONS");
434 if (strstr (env, "full_tags") || strstr (env, "full-tags"))
436 else if (strstr (env, "pretty_tags") || strstr (env, "pretty-tags"))
441 /* we can't do this further above, because we initialize the GST_CAT_DEFAULT struct */
442 #define GST_CAT_DEFAULT _GST_CAT_DEBUG
446 * @category: category to log
447 * @level: level of the message is in
448 * @file: the file that emitted the message, usually the __FILE__ identifier
449 * @function: the function that emitted the message
450 * @line: the line from that the message was emitted, usually __LINE__
451 * @object: (transfer none) (allow-none): the object this message relates to,
453 * @format: a printf style format string
454 * @...: optional arguments for the format
456 * Logs the given message using the currently registered debugging handlers.
459 gst_debug_log (GstDebugCategory * category, GstDebugLevel level,
460 const gchar * file, const gchar * function, gint line,
461 GObject * object, const gchar * format, ...)
465 va_start (var_args, format);
466 gst_debug_log_valist (category, level, file, function, line, object, format,
472 * gst_debug_log_valist:
473 * @category: category to log
474 * @level: level of the message is in
475 * @file: the file that emitted the message, usually the __FILE__ identifier
476 * @function: the function that emitted the message
477 * @line: the line from that the message was emitted, usually __LINE__
478 * @object: (transfer none) (allow-none): the object this message relates to,
480 * @format: a printf style format string
481 * @args: optional arguments for the format
483 * Logs the given message using the currently registered debugging handlers.
486 gst_debug_log_valist (GstDebugCategory * category, GstDebugLevel level,
487 const gchar * file, const gchar * function, gint line,
488 GObject * object, const gchar * format, va_list args)
490 GstDebugMessage message;
495 gchar *file_basename;
498 g_return_if_fail (category != NULL);
499 g_return_if_fail (file != NULL);
500 g_return_if_fail (function != NULL);
501 g_return_if_fail (format != NULL);
505 * The predefined macro __FILE__ is always the exact path given to the
506 * compiler with MSVC, which may or may not be the basename. We work
507 * around it at runtime to improve the readability.
509 file = file_basename = g_path_get_basename (file);
512 message.message = NULL;
513 message.format = format;
514 G_VA_COPY (message.arguments, args);
516 handler = __log_functions;
518 entry = handler->data;
519 handler = g_slist_next (handler);
520 entry->func (category, level, file, function, line, object, &message,
523 g_free (message.message);
524 va_end (message.arguments);
527 g_free (file_basename);
532 * gst_debug_message_get:
533 * @message: a debug message
535 * Gets the string representation of a #GstDebugMessage. This function is used
536 * in debug handlers to extract the message.
538 * Returns: the string representation of a #GstDebugMessage.
541 gst_debug_message_get (GstDebugMessage * message)
543 if (message->message == NULL) {
544 message->message = g_strdup_vprintf (message->format, message->arguments);
546 return message->message;
549 #define MAX_BUFFER_DUMP_STRING_LEN 100
551 /* structure_to_pretty_string:
552 * @structure: a #GstStructure
554 * Converts @structure to a human-readable string representation. Basically
555 * the same as gst_structure_to_string(), but if the structure contains large
556 * buffers such as images the hex representation of those buffers will be
557 * shortened so that the string remains readable.
559 * Returns: a newly-allocated string. g_free() when no longer needed.
562 structure_to_pretty_string (const GstStructure * s)
564 gchar *str, *pos, *end;
566 str = gst_structure_to_string (s);
571 while ((pos = strstr (pos, "(buffer)"))) {
574 pos += strlen ("(buffer)");
575 for (end = pos; *end != '\0' && *end != ';' && *end != ' '; ++end)
577 if (count > MAX_BUFFER_DUMP_STRING_LEN) {
578 memcpy (pos + MAX_BUFFER_DUMP_STRING_LEN - 6, "..", 2);
579 memcpy (pos + MAX_BUFFER_DUMP_STRING_LEN - 4, pos + count - 4, 4);
580 g_memmove (pos + MAX_BUFFER_DUMP_STRING_LEN, pos + count,
581 strlen (pos + count) + 1);
582 pos += MAX_BUFFER_DUMP_STRING_LEN;
589 static inline gchar *
590 gst_info_structure_to_string (GstStructure * s)
592 if (G_UNLIKELY (pretty_tags && s->name == GST_QUARK (TAGLIST)))
593 return structure_to_pretty_string (s);
595 return gst_structure_to_string (s);
599 gst_debug_print_object (gpointer ptr)
601 GObject *object = (GObject *) ptr;
604 /* This is a cute trick to detect unmapped memory, but is unportable,
605 * slow, screws around with madvise, and not actually that useful. */
609 ret = madvise ((void *) ((unsigned long) ptr & (~0xfff)), 4096, 0);
610 if (ret == -1 && errno == ENOMEM) {
611 buffer = g_strdup_printf ("%p (unmapped memory)", ptr);
616 /* nicely printed object */
617 if (object == NULL) {
618 return g_strdup ("(NULL)");
620 if (*(GType *) ptr == GST_TYPE_CAPS) {
621 return gst_caps_to_string ((GstCaps *) ptr);
623 if (*(GType *) ptr == GST_TYPE_STRUCTURE) {
624 return gst_info_structure_to_string ((GstStructure *) ptr);
627 if (*(guint32 *) ptr == 0xffffffff) {
628 return g_strdup_printf ("<poisoned@%p>", ptr);
631 if (GST_IS_PAD (object) && GST_OBJECT_NAME (object)) {
632 return g_strdup_printf ("<%s:%s>", GST_DEBUG_PAD_NAME (object));
634 if (GST_IS_OBJECT (object) && GST_OBJECT_NAME (object)) {
635 return g_strdup_printf ("<%s>", GST_OBJECT_NAME (object));
637 if (G_IS_OBJECT (object)) {
638 return g_strdup_printf ("<%s@%p>", G_OBJECT_TYPE_NAME (object), object);
640 if (GST_IS_MESSAGE (object)) {
641 GstMessage *msg = GST_MESSAGE_CAST (object);
644 if (msg->structure) {
645 s = gst_info_structure_to_string (msg->structure);
647 s = g_strdup ("(NULL)");
650 ret = g_strdup_printf ("%s message from element '%s': %s",
651 GST_MESSAGE_TYPE_NAME (msg), (msg->src != NULL) ?
652 GST_ELEMENT_NAME (msg->src) : "(NULL)", s);
656 if (GST_IS_QUERY (object)) {
657 GstQuery *query = GST_QUERY_CAST (object);
659 if (query->structure) {
660 return gst_info_structure_to_string (query->structure);
662 const gchar *query_type_name;
664 query_type_name = gst_query_type_get_name (query->type);
665 if (G_LIKELY (query_type_name != NULL)) {
666 return g_strdup_printf ("%s query", query_type_name);
668 return g_strdup_printf ("query of unknown type %d", query->type);
672 if (GST_IS_EVENT (object)) {
673 GstEvent *event = GST_EVENT_CAST (object);
676 if (event->structure) {
677 s = gst_info_structure_to_string (event->structure);
679 s = g_strdup ("(NULL)");
682 ret = g_strdup_printf ("%s event from '%s' at time %"
683 GST_TIME_FORMAT ": %s",
684 GST_EVENT_TYPE_NAME (event), (event->src != NULL) ?
685 GST_OBJECT_NAME (event->src) : "(NULL)",
686 GST_TIME_ARGS (event->timestamp), s);
691 return g_strdup_printf ("%p", ptr);
694 #ifdef HAVE_PRINTF_EXTENSION
697 gst_debug_print_segment (gpointer ptr)
699 GstSegment *segment = (GstSegment *) ptr;
701 /* nicely printed segment */
702 if (segment == NULL) {
703 return g_strdup ("(NULL)");
706 switch (segment->format) {
707 case GST_FORMAT_UNDEFINED:{
708 return g_strdup_printf ("UNDEFINED segment");
710 case GST_FORMAT_TIME:{
711 return g_strdup_printf ("time segment start=%" GST_TIME_FORMAT
712 ", stop=%" GST_TIME_FORMAT ", last_stop=%" GST_TIME_FORMAT
713 ", duration=%" GST_TIME_FORMAT ", rate=%f, applied_rate=%f"
714 ", flags=0x%02x, time=%" GST_TIME_FORMAT ", accum=%" GST_TIME_FORMAT,
715 GST_TIME_ARGS (segment->start), GST_TIME_ARGS (segment->stop),
716 GST_TIME_ARGS (segment->last_stop), GST_TIME_ARGS (segment->duration),
717 segment->rate, segment->applied_rate, (guint) segment->flags,
718 GST_TIME_ARGS (segment->time), GST_TIME_ARGS (segment->accum));
721 const gchar *format_name;
723 format_name = gst_format_get_name (segment->format);
724 if (G_UNLIKELY (format_name == NULL))
725 format_name = "(UNKNOWN FORMAT)";
726 return g_strdup_printf ("%s segment start=%" G_GINT64_FORMAT
727 ", stop=%" G_GINT64_FORMAT ", last_stop=%" G_GINT64_FORMAT
728 ", duration=%" G_GINT64_FORMAT ", rate=%f, applied_rate=%f"
729 ", flags=0x%02x, time=%" GST_TIME_FORMAT ", accum=%" GST_TIME_FORMAT,
730 format_name, segment->start, segment->stop, segment->last_stop,
731 segment->duration, segment->rate, segment->applied_rate,
732 (guint) segment->flags, GST_TIME_ARGS (segment->time),
733 GST_TIME_ARGS (segment->accum));
738 #endif /* HAVE_PRINTF_EXTENSION */
741 * gst_debug_construct_term_color:
742 * @colorinfo: the color info
744 * Constructs a string that can be used for getting the desired color in color
746 * You need to free the string after use.
748 * Returns: (transfer full) (type gchar*): a string containing the color
752 gst_debug_construct_term_color (guint colorinfo)
756 color = g_string_new ("\033[00");
758 if (colorinfo & GST_DEBUG_BOLD) {
759 g_string_append_len (color, ";01", 3);
761 if (colorinfo & GST_DEBUG_UNDERLINE) {
762 g_string_append_len (color, ";04", 3);
764 if (colorinfo & GST_DEBUG_FG_MASK) {
765 g_string_append_printf (color, ";3%1d", colorinfo & GST_DEBUG_FG_MASK);
767 if (colorinfo & GST_DEBUG_BG_MASK) {
768 g_string_append_printf (color, ";4%1d",
769 (colorinfo & GST_DEBUG_BG_MASK) >> 4);
771 g_string_append_c (color, 'm');
773 return g_string_free (color, FALSE);
777 * gst_debug_construct_win_color:
778 * @colorinfo: the color info
780 * Constructs an integer that can be used for getting the desired color in
781 * windows' terminals (cmd.exe). As there is no mean to underline, we simply
782 * ignore this attribute.
784 * This function returns 0 on non-windows machines.
786 * Returns: an integer containing the color definition
791 gst_debug_construct_win_color (guint colorinfo)
795 static const guchar ansi_to_win_fg[8] = {
797 FOREGROUND_RED, /* red */
798 FOREGROUND_GREEN, /* green */
799 FOREGROUND_RED | FOREGROUND_GREEN, /* yellow */
800 FOREGROUND_BLUE, /* blue */
801 FOREGROUND_RED | FOREGROUND_BLUE, /* magenta */
802 FOREGROUND_GREEN | FOREGROUND_BLUE, /* cyan */
803 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE /* white */
805 static const guchar ansi_to_win_bg[8] = {
809 BACKGROUND_RED | BACKGROUND_GREEN,
811 BACKGROUND_RED | BACKGROUND_BLUE,
812 BACKGROUND_GREEN | FOREGROUND_BLUE,
813 BACKGROUND_RED | BACKGROUND_GREEN | BACKGROUND_BLUE
816 /* we draw black as white, as cmd.exe can only have black bg */
817 if (colorinfo == 0) {
818 return ansi_to_win_fg[7];
821 if (colorinfo & GST_DEBUG_BOLD) {
822 color |= FOREGROUND_INTENSITY;
824 if (colorinfo & GST_DEBUG_FG_MASK) {
825 color |= ansi_to_win_fg[colorinfo & GST_DEBUG_FG_MASK];
827 if (colorinfo & GST_DEBUG_BG_MASK) {
828 color |= ansi_to_win_bg[(colorinfo & GST_DEBUG_BG_MASK) >> 4];
834 /* width of %p varies depending on actual value of pointer, which can make
835 * output unevenly aligned if multiple threads are involved, hence the %14p
836 * (should really be %18p, but %14p seems a good compromise between too many
837 * white spaces and likely unalignment on my system) */
838 #if defined (GLIB_SIZEOF_VOID_P) && GLIB_SIZEOF_VOID_P == 8
839 #define PTR_FMT "%14p"
841 #define PTR_FMT "%10p"
843 #define PID_FMT "%5d"
844 #define CAT_FMT "%20s %s:%d:%s:%s"
847 static const guchar levelcolormap[GST_LEVEL_COUNT] = {
849 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE,
850 /* GST_LEVEL_ERROR */
851 FOREGROUND_RED | FOREGROUND_INTENSITY,
852 /* GST_LEVEL_WARNING */
853 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_INTENSITY,
855 FOREGROUND_GREEN | FOREGROUND_INTENSITY,
856 /* GST_LEVEL_DEBUG */
857 FOREGROUND_GREEN | FOREGROUND_BLUE,
859 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE,
860 /* GST_LEVEL_FIXME */
861 FOREGROUND_RED | FOREGROUND_GREEN,
862 /* GST_LEVEL_TRACE */
863 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE,
864 /* placeholder for log level 8 */
866 /* GST_LEVEL_MEMDUMP */
867 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE
870 static const guchar available_colors[] = {
871 FOREGROUND_RED, FOREGROUND_GREEN, FOREGROUND_RED | FOREGROUND_GREEN,
872 FOREGROUND_BLUE, FOREGROUND_RED | FOREGROUND_BLUE,
873 FOREGROUND_GREEN | FOREGROUND_BLUE,
876 static const gchar *levelcolormap[GST_LEVEL_COUNT] = {
877 "\033[37m", /* GST_LEVEL_NONE */
878 "\033[31;01m", /* GST_LEVEL_ERROR */
879 "\033[33;01m", /* GST_LEVEL_WARNING */
880 "\033[32;01m", /* GST_LEVEL_INFO */
881 "\033[36m", /* GST_LEVEL_DEBUG */
882 "\033[37m", /* GST_LEVEL_LOG */
883 "\033[33;01m", /* GST_LEVEL_FIXME */
884 "\033[37m", /* GST_LEVEL_TRACE */
885 "\033[37m", /* placeholder for log level 8 */
886 "\033[37m" /* GST_LEVEL_MEMDUMP */
891 * gst_debug_log_default:
892 * @category: category to log
893 * @level: level of the message
894 * @file: the file that emitted the message, usually the __FILE__ identifier
895 * @function: the function that emitted the message
896 * @line: the line from that the message was emitted, usually __LINE__
897 * @message: the actual message
898 * @object: (transfer none) (allow-none): the object this message relates to,
900 * @unused: an unused variable, reserved for some user_data.
902 * The default logging handler used by GStreamer. Logging functions get called
903 * whenever a macro like GST_DEBUG or similar is used. This function outputs the
904 * message and additional info to stderr (or the log file specified via the
905 * GST_DEBUG_FILE environment variable).
907 * You can add other handlers by using gst_debug_add_log_function().
908 * And you can remove this handler by calling
909 * gst_debug_remove_log_function(gst_debug_log_default);
912 gst_debug_log_default (GstDebugCategory * category, GstDebugLevel level,
913 const gchar * file, const gchar * function, gint line,
914 GObject * object, GstDebugMessage * message, gpointer unused)
917 GstClockTime elapsed;
921 if (level > gst_debug_category_get_threshold (category))
925 is_colored = gst_debug_is_colored ();
928 obj = gst_debug_print_object (object);
933 elapsed = GST_CLOCK_DIFF (_priv_gst_info_start_time,
934 gst_util_get_timestamp ());
938 /* colors, non-windows */
942 const gchar *levelcolor;
944 color = gst_debug_construct_term_color (gst_debug_category_get_color
947 g_sprintf (pidcolor, "\033[3%1dm", pid % 6 + 31);
948 levelcolor = levelcolormap[level];
950 #define PRINT_FMT " %s"PID_FMT"%s "PTR_FMT" %s%s%s %s"CAT_FMT"%s %s\n"
951 fprintf (log_file, "%" GST_TIME_FORMAT PRINT_FMT, GST_TIME_ARGS (elapsed),
952 pidcolor, pid, clear, g_thread_self (), levelcolor,
953 gst_debug_level_get_name (level), clear, color,
954 gst_debug_category_get_name (category), file, line, function, obj,
955 clear, gst_debug_message_get (message));
960 /* colors, windows. We take a lock to keep colors and content together.
961 * Maybe there is a better way but for now this will do the right
963 static GStaticMutex win_print_mutex = G_STATIC_MUTEX_INIT;
964 const gint clear = FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE;
965 #define SET_COLOR(c) G_STMT_START { \
966 if (log_file == stderr) \
967 SetConsoleTextAttribute (GetStdHandle (STD_ERROR_HANDLE), (c)); \
969 g_static_mutex_lock (&win_print_mutex);
971 fprintf (log_file, "%" GST_TIME_FORMAT " ", GST_TIME_ARGS (elapsed));
974 SET_COLOR (available_colors[pid % G_N_ELEMENTS (available_colors)]);
975 fprintf (log_file, PID_FMT, pid);
979 fprintf (log_file, " " PTR_FMT " ", g_thread_self ());
982 SET_COLOR (levelcolormap[level]);
983 fprintf (log_file, "%s ", gst_debug_level_get_name (level));
986 SET_COLOR (gst_debug_construct_win_color (gst_debug_category_get_color
988 fprintf (log_file, CAT_FMT, gst_debug_category_get_name (category),
989 file, line, function, obj);
993 fprintf (log_file, " %s\n", gst_debug_message_get (message));
995 g_static_mutex_unlock (&win_print_mutex);
998 /* no color, all platforms */
999 #define PRINT_FMT " "PID_FMT" "PTR_FMT" %s "CAT_FMT" %s\n"
1000 fprintf (log_file, "%" GST_TIME_FORMAT PRINT_FMT, GST_TIME_ARGS (elapsed),
1001 pid, g_thread_self (), gst_debug_level_get_name (level),
1002 gst_debug_category_get_name (category), file, line, function, obj,
1003 gst_debug_message_get (message));
1012 * gst_debug_level_get_name:
1013 * @level: the level to get the name for
1015 * Get the string representation of a debugging level
1020 gst_debug_level_get_name (GstDebugLevel level)
1023 case GST_LEVEL_NONE:
1025 case GST_LEVEL_ERROR:
1027 case GST_LEVEL_WARNING:
1029 case GST_LEVEL_INFO:
1031 case GST_LEVEL_DEBUG:
1035 case GST_LEVEL_FIXME:
1037 case GST_LEVEL_TRACE:
1039 case GST_LEVEL_MEMDUMP:
1042 g_warning ("invalid level specified for gst_debug_level_get_name");
1048 * gst_debug_add_log_function:
1049 * @func: the function to use
1050 * @data: (closure): user data
1052 * Adds the logging function to the list of logging functions.
1053 * Be sure to use #G_GNUC_NO_INSTRUMENT on that function, it is needed.
1056 gst_debug_add_log_function (GstLogFunction func, gpointer data)
1058 LogFuncEntry *entry;
1061 g_return_if_fail (func != NULL);
1063 entry = g_slice_new (LogFuncEntry);
1065 entry->user_data = data;
1066 /* FIXME: we leak the old list here - other threads might access it right now
1067 * in gst_debug_logv. Another solution is to lock the mutex in gst_debug_logv,
1068 * but that is waaay costly.
1069 * It'd probably be clever to use some kind of RCU here, but I don't know
1070 * anything about that.
1072 g_static_mutex_lock (&__log_func_mutex);
1073 list = g_slist_copy (__log_functions);
1074 __log_functions = g_slist_prepend (list, entry);
1075 g_static_mutex_unlock (&__log_func_mutex);
1077 GST_DEBUG ("prepended log function %p (user data %p) to log functions",
1082 gst_debug_compare_log_function_by_func (gconstpointer entry, gconstpointer func)
1084 gpointer entryfunc = (gpointer) (((LogFuncEntry *) entry)->func);
1086 return (entryfunc < func) ? -1 : (entryfunc > func) ? 1 : 0;
1090 gst_debug_compare_log_function_by_data (gconstpointer entry, gconstpointer data)
1092 gpointer entrydata = ((LogFuncEntry *) entry)->user_data;
1094 return (entrydata < data) ? -1 : (entrydata > data) ? 1 : 0;
1098 gst_debug_remove_with_compare_func (GCompareFunc func, gpointer data)
1104 g_static_mutex_lock (&__log_func_mutex);
1105 new = __log_functions;
1106 while ((found = g_slist_find_custom (new, data, func))) {
1107 if (new == __log_functions) {
1108 /* make a copy when we have the first hit, so that we modify the copy and
1109 * make that the new list later */
1110 new = g_slist_copy (new);
1113 g_slice_free (LogFuncEntry, found->data);
1114 new = g_slist_delete_link (new, found);
1117 /* FIXME: We leak the old list here. See _add_log_function for why. */
1118 __log_functions = new;
1119 g_static_mutex_unlock (&__log_func_mutex);
1125 * gst_debug_remove_log_function:
1126 * @func: the log function to remove
1128 * Removes all registered instances of the given logging functions.
1130 * Returns: How many instances of the function were removed
1133 gst_debug_remove_log_function (GstLogFunction func)
1137 g_return_val_if_fail (func != NULL, 0);
1140 gst_debug_remove_with_compare_func
1141 (gst_debug_compare_log_function_by_func, (gpointer) func);
1142 GST_DEBUG ("removed log function %p %d times from log function list", func,
1149 * gst_debug_remove_log_function_by_data:
1150 * @data: user data of the log function to remove
1152 * Removes all registered instances of log functions with the given user data.
1154 * Returns: How many instances of the function were removed
1157 gst_debug_remove_log_function_by_data (gpointer data)
1162 gst_debug_remove_with_compare_func
1163 (gst_debug_compare_log_function_by_data, data);
1165 ("removed %d log functions with user data %p from log function list",
1172 * gst_debug_set_colored:
1173 * @colored: Whether to use colored output or not
1175 * Sets or unsets the use of coloured debugging output.
1177 * This function may be called before gst_init().
1180 gst_debug_set_colored (gboolean colored)
1182 g_atomic_int_set (&__use_color, (gint) colored);
1186 * gst_debug_is_colored:
1188 * Checks if the debugging output should be colored.
1190 * Returns: TRUE, if the debug output should be colored.
1193 gst_debug_is_colored (void)
1195 return (gboolean) g_atomic_int_get (&__use_color);
1199 * gst_debug_set_active:
1200 * @active: Whether to use debugging output or not
1202 * If activated, debugging messages are sent to the debugging
1204 * It makes sense to deactivate it for speed issues.
1205 * <note><para>This function is not threadsafe. It makes sense to only call it
1206 * during initialization.</para></note>
1209 gst_debug_set_active (gboolean active)
1211 __gst_debug_enabled = active;
1213 __gst_debug_min = GST_LEVEL_COUNT;
1215 __gst_debug_min = GST_LEVEL_NONE;
1219 * gst_debug_is_active:
1221 * Checks if debugging output is activated.
1223 * Returns: TRUE, if debugging is activated
1226 gst_debug_is_active (void)
1228 return __gst_debug_enabled;
1232 * gst_debug_set_default_threshold:
1233 * @level: level to set
1235 * Sets the default threshold to the given level and updates all categories to
1236 * use this threshold.
1238 * This function may be called before gst_init().
1241 gst_debug_set_default_threshold (GstDebugLevel level)
1243 g_atomic_int_set (&__default_level, level);
1244 gst_debug_reset_all_thresholds ();
1248 * gst_debug_get_default_threshold:
1250 * Returns the default threshold that is used for new categories.
1252 * Returns: the default threshold level
1255 gst_debug_get_default_threshold (void)
1257 return (GstDebugLevel) g_atomic_int_get (&__default_level);
1261 gst_debug_reset_threshold (gpointer category, gpointer unused)
1263 GstDebugCategory *cat = (GstDebugCategory *) category;
1266 g_static_mutex_lock (&__level_name_mutex);
1267 walk = __level_name;
1269 LevelNameEntry *entry = walk->data;
1271 walk = g_slist_next (walk);
1272 if (g_pattern_match_string (entry->pat, cat->name)) {
1273 GST_LOG ("category %s matches pattern %p - gets set to level %d",
1274 cat->name, entry->pat, entry->level);
1275 gst_debug_category_set_threshold (cat, entry->level);
1279 gst_debug_category_set_threshold (cat, gst_debug_get_default_threshold ());
1282 g_static_mutex_unlock (&__level_name_mutex);
1286 gst_debug_reset_all_thresholds (void)
1288 g_static_mutex_lock (&__cat_mutex);
1289 g_slist_foreach (__categories, gst_debug_reset_threshold, NULL);
1290 g_static_mutex_unlock (&__cat_mutex);
1294 for_each_threshold_by_entry (gpointer data, gpointer user_data)
1296 GstDebugCategory *cat = (GstDebugCategory *) data;
1297 LevelNameEntry *entry = (LevelNameEntry *) user_data;
1299 if (g_pattern_match_string (entry->pat, cat->name)) {
1300 GST_LOG ("category %s matches pattern %p - gets set to level %d",
1301 cat->name, entry->pat, entry->level);
1302 gst_debug_category_set_threshold (cat, entry->level);
1307 * gst_debug_set_threshold_for_name:
1308 * @name: name of the categories to set
1309 * @level: level to set them to
1311 * Sets all categories which match the given glob style pattern to the given
1315 gst_debug_set_threshold_for_name (const gchar * name, GstDebugLevel level)
1318 LevelNameEntry *entry;
1320 g_return_if_fail (name != NULL);
1322 pat = g_pattern_spec_new (name);
1323 entry = g_slice_new (LevelNameEntry);
1325 entry->level = level;
1326 g_static_mutex_lock (&__level_name_mutex);
1327 __level_name = g_slist_prepend (__level_name, entry);
1328 g_static_mutex_unlock (&__level_name_mutex);
1329 g_static_mutex_lock (&__cat_mutex);
1330 g_slist_foreach (__categories, for_each_threshold_by_entry, entry);
1331 g_static_mutex_unlock (&__cat_mutex);
1335 * gst_debug_unset_threshold_for_name:
1336 * @name: name of the categories to set
1338 * Resets all categories with the given name back to the default level.
1341 gst_debug_unset_threshold_for_name (const gchar * name)
1346 g_return_if_fail (name != NULL);
1348 pat = g_pattern_spec_new (name);
1349 g_static_mutex_lock (&__level_name_mutex);
1350 walk = __level_name;
1351 /* improve this if you want, it's mighty slow */
1353 LevelNameEntry *entry = walk->data;
1355 if (g_pattern_spec_equal (entry->pat, pat)) {
1356 __level_name = g_slist_remove_link (__level_name, walk);
1357 g_pattern_spec_free (entry->pat);
1358 g_slice_free (LevelNameEntry, entry);
1359 g_slist_free_1 (walk);
1360 walk = __level_name;
1363 g_static_mutex_unlock (&__level_name_mutex);
1364 g_pattern_spec_free (pat);
1365 gst_debug_reset_all_thresholds ();
1369 _gst_debug_category_new (const gchar * name, guint color,
1370 const gchar * description)
1372 GstDebugCategory *cat;
1374 g_return_val_if_fail (name != NULL, NULL);
1376 cat = g_slice_new (GstDebugCategory);
1377 cat->name = g_strdup (name);
1379 if (description != NULL) {
1380 cat->description = g_strdup (description);
1382 cat->description = g_strdup ("no description");
1384 g_atomic_int_set (&cat->threshold, 0);
1385 gst_debug_reset_threshold (cat, NULL);
1387 /* add to category list */
1388 g_static_mutex_lock (&__cat_mutex);
1389 __categories = g_slist_prepend (__categories, cat);
1390 g_static_mutex_unlock (&__cat_mutex);
1396 * gst_debug_category_free:
1397 * @category: #GstDebugCategory to free.
1399 * Removes and frees the category and all associated resources.
1402 gst_debug_category_free (GstDebugCategory * category)
1404 if (category == NULL)
1407 /* remove from category list */
1408 g_static_mutex_lock (&__cat_mutex);
1409 __categories = g_slist_remove (__categories, category);
1410 g_static_mutex_unlock (&__cat_mutex);
1412 g_free ((gpointer) category->name);
1413 g_free ((gpointer) category->description);
1414 g_slice_free (GstDebugCategory, category);
1418 * gst_debug_category_set_threshold:
1419 * @category: a #GstDebugCategory to set threshold of.
1420 * @level: the #GstDebugLevel threshold to set.
1422 * Sets the threshold of the category to the given level. Debug information will
1423 * only be output if the threshold is lower or equal to the level of the
1424 * debugging message.
1426 * Do not use this function in production code, because other functions may
1427 * change the threshold of categories as side effect. It is however a nice
1428 * function to use when debugging (even from gdb).
1432 gst_debug_category_set_threshold (GstDebugCategory * category,
1433 GstDebugLevel level)
1435 g_return_if_fail (category != NULL);
1437 if (level > __gst_debug_min) {
1438 __gst_debug_enabled = TRUE;
1439 __gst_debug_min = level;
1442 g_atomic_int_set (&category->threshold, level);
1446 * gst_debug_category_reset_threshold:
1447 * @category: a #GstDebugCategory to reset threshold of.
1449 * Resets the threshold of the category to the default level. Debug information
1450 * will only be output if the threshold is lower or equal to the level of the
1451 * debugging message.
1452 * Use this function to set the threshold back to where it was after using
1453 * gst_debug_category_set_threshold().
1456 gst_debug_category_reset_threshold (GstDebugCategory * category)
1458 gst_debug_reset_threshold (category, NULL);
1462 * gst_debug_category_get_threshold:
1463 * @category: a #GstDebugCategory to get threshold of.
1465 * Returns the threshold of a #GstDebugCategory.
1467 * Returns: the #GstDebugLevel that is used as threshold.
1470 gst_debug_category_get_threshold (GstDebugCategory * category)
1472 return g_atomic_int_get (&category->threshold);
1476 * gst_debug_category_get_name:
1477 * @category: a #GstDebugCategory to get name of.
1479 * Returns the name of a debug category.
1481 * Returns: the name of the category.
1484 gst_debug_category_get_name (GstDebugCategory * category)
1486 return category->name;
1490 * gst_debug_category_get_color:
1491 * @category: a #GstDebugCategory to get the color of.
1493 * Returns the color of a debug category used when printing output in this
1496 * Returns: the color of the category.
1499 gst_debug_category_get_color (GstDebugCategory * category)
1501 return category->color;
1505 * gst_debug_category_get_description:
1506 * @category: a #GstDebugCategory to get the description of.
1508 * Returns the description of a debug category.
1510 * Returns: the description of the category.
1513 gst_debug_category_get_description (GstDebugCategory * category)
1515 return category->description;
1519 * gst_debug_get_all_categories:
1521 * Returns a snapshot of a all categories that are currently in use . This list
1522 * may change anytime.
1523 * The caller has to free the list after use.
1525 * Returns: (transfer container) (element-type Gst.DebugCategory): the list of
1529 gst_debug_get_all_categories (void)
1533 g_static_mutex_lock (&__cat_mutex);
1534 ret = g_slist_copy (__categories);
1535 g_static_mutex_unlock (&__cat_mutex);
1541 _gst_debug_get_category (const gchar * name)
1543 GstDebugCategory *ret = NULL;
1546 for (node = __categories; node; node = g_slist_next (node)) {
1547 ret = (GstDebugCategory *) node->data;
1548 if (!strcmp (name, ret->name)) {
1555 /*** FUNCTION POINTERS ********************************************************/
1557 static GHashTable *__gst_function_pointers; /* NULL */
1558 static GStaticMutex __dbg_functions_mutex = G_STATIC_MUTEX_INIT;
1560 /* This function MUST NOT return NULL */
1562 _gst_debug_nameof_funcptr (GstDebugFuncPtr func)
1570 if (G_UNLIKELY (func == NULL))
1573 g_static_mutex_lock (&__dbg_functions_mutex);
1574 if (G_LIKELY (__gst_function_pointers)) {
1575 ptrname = g_hash_table_lookup (__gst_function_pointers, (gpointer) func);
1576 g_static_mutex_unlock (&__dbg_functions_mutex);
1577 if (G_LIKELY (ptrname))
1580 g_static_mutex_unlock (&__dbg_functions_mutex);
1582 /* we need to create an entry in the hash table for this one so we don't leak
1585 if (dladdr ((gpointer) func, &dl_info) && dl_info.dli_sname) {
1586 gchar *name = g_strdup (dl_info.dli_sname);
1588 _gst_debug_register_funcptr (func, name);
1593 gchar *name = g_strdup_printf ("%p", (gpointer) func);
1595 _gst_debug_register_funcptr (func, name);
1601 _gst_debug_register_funcptr (GstDebugFuncPtr func, const gchar * ptrname)
1603 gpointer ptr = (gpointer) func;
1605 g_static_mutex_lock (&__dbg_functions_mutex);
1607 if (!__gst_function_pointers)
1608 __gst_function_pointers = g_hash_table_new (g_direct_hash, g_direct_equal);
1609 if (!g_hash_table_lookup (__gst_function_pointers, ptr))
1610 g_hash_table_insert (__gst_function_pointers, ptr, (gpointer) ptrname);
1612 g_static_mutex_unlock (&__dbg_functions_mutex);
1615 /*** PRINTF EXTENSIONS ********************************************************/
1617 #ifdef HAVE_PRINTF_EXTENSION
1619 _gst_info_printf_extension_ptr (FILE * stream, const struct printf_info *info,
1620 const void *const *args)
1627 ptr = *(void **) args[0];
1629 buffer = gst_debug_print_object (ptr);
1630 len = fprintf (stream, "%*s", (info->left ? -info->width : info->width),
1638 _gst_info_printf_extension_segment (FILE * stream,
1639 const struct printf_info *info, const void *const *args)
1646 ptr = *(void **) args[0];
1648 buffer = gst_debug_print_segment (ptr);
1649 len = fprintf (stream, "%*s", (info->left ? -info->width : info->width),
1656 #ifdef HAVE_REGISTER_PRINTF_SPECIFIER
1658 _gst_info_printf_extension_arginfo (const struct printf_info *info, size_t n,
1659 int *argtypes, int *size)
1662 _gst_info_printf_extension_arginfo (const struct printf_info *info, size_t n,
1667 argtypes[0] = PA_POINTER;
1668 #ifdef HAVE_REGISTER_PRINTF_SPECIFIER
1669 *size = sizeof (gpointer);
1674 #endif /* HAVE_PRINTF_EXTENSION */
1677 gst_info_dump_mem_line (gchar * linebuf, gsize linebuf_size,
1678 const guint8 * mem, gsize mem_offset, gsize mem_size)
1680 gchar hexstr[50], ascstr[18], digitstr[4];
1692 while (i < mem_size) {
1693 ascstr[i] = (g_ascii_isprint (mem[i])) ? mem[i] : '.';
1694 g_snprintf (digitstr, sizeof (digitstr), "%02x ", mem[i]);
1695 g_strlcat (hexstr, digitstr, sizeof (hexstr));
1701 g_snprintf (linebuf, linebuf_size, "%08x: %-48.48s %-16.16s",
1702 (guint) mem_offset, hexstr, ascstr);
1706 _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
1707 const gchar * func, gint line, GObject * obj, const gchar * msg,
1708 const guint8 * data, guint length)
1712 gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "--------"
1713 "-------------------------------------------------------------------");
1715 if (msg != NULL && *msg != '\0') {
1716 gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "%s", msg);
1719 while (off < length) {
1722 /* gst_info_dump_mem_line will process 16 bytes at most */
1723 gst_info_dump_mem_line (buf, sizeof (buf), data, off, length - off);
1724 gst_debug_log (cat, GST_LEVEL_MEMDUMP, file, func, line, obj, "%s", buf);
1728 gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "--------"
1729 "-------------------------------------------------------------------");
1732 #else /* !GST_DISABLE_GST_DEBUG */
1733 #ifndef GST_REMOVE_DISABLED
1736 _gst_debug_category_new (const gchar * name, guint color,
1737 const gchar * description)
1743 _gst_debug_register_funcptr (GstDebugFuncPtr func, const gchar * ptrname)
1747 /* This function MUST NOT return NULL */
1749 _gst_debug_nameof_funcptr (GstDebugFuncPtr func)
1755 gst_debug_log (GstDebugCategory * category, GstDebugLevel level,
1756 const gchar * file, const gchar * function, gint line,
1757 GObject * object, const gchar * format, ...)
1762 gst_debug_log_valist (GstDebugCategory * category, GstDebugLevel level,
1763 const gchar * file, const gchar * function, gint line,
1764 GObject * object, const gchar * format, va_list args)
1769 gst_debug_message_get (GstDebugMessage * message)
1775 gst_debug_log_default (GstDebugCategory * category, GstDebugLevel level,
1776 const gchar * file, const gchar * function, gint line,
1777 GObject * object, GstDebugMessage * message, gpointer unused)
1781 G_CONST_RETURN gchar *
1782 gst_debug_level_get_name (GstDebugLevel level)
1788 gst_debug_add_log_function (GstLogFunction func, gpointer data)
1793 gst_debug_remove_log_function (GstLogFunction func)
1799 gst_debug_remove_log_function_by_data (gpointer data)
1805 gst_debug_set_active (gboolean active)
1810 gst_debug_is_active (void)
1816 gst_debug_set_colored (gboolean colored)
1821 gst_debug_is_colored (void)
1827 gst_debug_set_default_threshold (GstDebugLevel level)
1832 gst_debug_get_default_threshold (void)
1834 return GST_LEVEL_NONE;
1838 gst_debug_set_threshold_for_name (const gchar * name, GstDebugLevel level)
1843 gst_debug_unset_threshold_for_name (const gchar * name)
1848 gst_debug_category_free (GstDebugCategory * category)
1853 gst_debug_category_set_threshold (GstDebugCategory * category,
1854 GstDebugLevel level)
1859 gst_debug_category_reset_threshold (GstDebugCategory * category)
1864 gst_debug_category_get_threshold (GstDebugCategory * category)
1866 return GST_LEVEL_NONE;
1869 G_CONST_RETURN gchar *
1870 gst_debug_category_get_name (GstDebugCategory * category)
1876 gst_debug_category_get_color (GstDebugCategory * category)
1881 G_CONST_RETURN gchar *
1882 gst_debug_category_get_description (GstDebugCategory * category)
1888 gst_debug_get_all_categories (void)
1894 _gst_debug_get_category (const gchar * name)
1900 gst_debug_construct_term_color (guint colorinfo)
1902 return g_strdup ("00");
1906 gst_debug_construct_win_color (guint colorinfo)
1912 _priv_gst_in_valgrind (void)
1918 _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
1919 const gchar * func, gint line, GObject * obj, const gchar * msg,
1920 const guint8 * data, guint length)
1923 #endif /* GST_REMOVE_DISABLED */
1924 #endif /* GST_DISABLE_GST_DEBUG */
1927 #ifdef GST_ENABLE_FUNC_INSTRUMENTATION
1928 /* FIXME make this thread specific */
1929 static GSList *stack_trace = NULL;
1932 __cyg_profile_func_enter (void *this_fn, void *call_site)
1933 G_GNUC_NO_INSTRUMENT;
1934 void __cyg_profile_func_enter (void *this_fn, void *call_site)
1936 gchar *name = _gst_debug_nameof_funcptr (this_fn);
1937 gchar *site = _gst_debug_nameof_funcptr (call_site);
1939 GST_CAT_DEBUG (GST_CAT_CALL_TRACE, "entering function %s from %s", name,
1942 g_slist_prepend (stack_trace, g_strdup_printf ("%8p in %s from %p (%s)",
1943 this_fn, name, call_site, site));
1950 __cyg_profile_func_exit (void *this_fn, void *call_site)
1951 G_GNUC_NO_INSTRUMENT;
1952 void __cyg_profile_func_exit (void *this_fn, void *call_site)
1954 gchar *name = _gst_debug_nameof_funcptr (this_fn);
1956 GST_CAT_DEBUG (GST_CAT_CALL_TRACE, "leaving function %s", name);
1957 g_free (stack_trace->data);
1958 stack_trace = g_slist_delete_link (stack_trace, stack_trace);
1964 * gst_debug_print_stack_trace:
1966 * If GST_ENABLE_FUNC_INSTRUMENTATION is defined a stacktrace is available for
1967 * gstreamer code, which can be printed with this function.
1970 gst_debug_print_stack_trace (void)
1972 GSList *walk = stack_trace;
1976 walk = g_slist_next (walk);
1979 gchar *name = (gchar *) walk->data;
1981 g_print ("#%-2d %s\n", count++, name);
1983 walk = g_slist_next (walk);
1988 gst_debug_print_stack_trace (void)
1990 /* nothing because it's compiled out */
1993 #endif /* GST_ENABLE_FUNC_INSTRUMENTATION */