1 /* GStreamer
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>
6 *
7 * gstinfo.c: debugging functions
8 *
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.
13 *
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.
18 *
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.
23 */
25 /**
26 * SECTION:gstinfo
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.
30 *
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.
34 *
35 * The debugging subsystem works only after GStreamer has been initialized
36 * - for example by calling gst_init().
37 *
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
44 * messages to stderr.
45 *
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,
51 * declare
52 * the variables and set the default category.
53 * <informalexample>
54 * <programlisting>
55 * GST_DEBUG_CATEGORY_STATIC (my_category); // define category (statically)
56 * &hash;define GST_CAT_DEFAULT my_category // set as default
57 * </programlisting>
58 * </informalexample>
59 * After that you only need to initialize the category.
60 * <informalexample>
61 * <programlisting>
62 * GST_DEBUG_CATEGORY_INIT (my_category, "my category",
63 * 0, "This is my very own");
64 * </programlisting>
65 * </informalexample>
66 * Initialization must be done before the category is used first.
67 * Plugins do this
68 * in their plugin_init function, libraries and applications should do that
69 * during their initialization.
70 *
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
74 * nothing at all.
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.
77 * If the debugging
78 * subsystem was compiled out, #GST_DISABLE_GST_DEBUG is defined in
79 * <gst/gst.h>,
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.
84 *
85 * Please note that there are naming conventions for the names of debugging
86 * categories. These are explained at GST_DEBUG_CATEGORY_INIT().
87 */
89 #define GST_INFO_C
90 #include "gst_private.h"
91 #include "gstinfo.h"
93 #ifndef GST_DISABLE_GST_DEBUG
95 #ifdef HAVE_DLFCN_H
96 # include <dlfcn.h>
97 #endif
98 #ifdef HAVE_PRINTF_EXTENSION
99 # include <printf.h>
100 #endif
101 #include <stdio.h> /* fprintf */
102 #include <glib/gstdio.h>
103 #include <errno.h>
104 #ifdef HAVE_UNISTD_H
105 # include <unistd.h> /* getpid on UNIX */
106 #endif
107 #ifdef HAVE_PROCESS_H
108 # include <process.h> /* getpid on win32 */
109 #endif
110 #include <string.h> /* G_VA_COPY */
111 #ifdef G_OS_WIN32
112 # define WIN32_LEAN_AND_MEAN /* prevents from including too many things */
113 # include <windows.h> /* GetStdHandle, windows console */
114 #endif
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>
122 #endif
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
183 */
184 GstClockTime _priv_gst_info_start_time;
186 #if 0
187 #if defined __sgi__
188 #include <rld_interface.h>
189 typedef struct DL_INFO
190 {
191 const char *dli_fname;
192 void *dli_fbase;
193 const char *dli_sname;
194 void *dli_saddr;
195 int dli_version;
196 int dli_reserved1;
197 long dli_reserved[4];
198 }
199 Dl_info;
201 #define _RLD_DLADDR 14
202 int dladdr (void *address, Dl_info * dl);
204 int
205 dladdr (void *address, Dl_info * dl)
206 {
207 void *v;
209 v = _rld_new_interface (_RLD_DLADDR, address, dl);
210 return (int) v;
211 }
212 #endif /* __sgi__ */
213 #endif
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);
226 #else
227 static int _gst_info_printf_extension_arginfo (const struct printf_info *info,
228 size_t n, int *argtypes);
229 #endif
230 #endif
232 struct _GstDebugMessage
233 {
234 gchar *message;
235 const gchar *format;
236 va_list arguments;
237 };
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;
242 typedef struct
243 {
244 GPatternSpec *pat;
245 GstDebugLevel level;
246 }
247 LevelNameEntry;
249 /* list of all categories */
250 static GStaticMutex __cat_mutex = G_STATIC_MUTEX_INIT;
251 static GSList *__categories = NULL;
253 /* all registered debug handlers */
254 typedef struct
255 {
256 GstLogFunction func;
257 gpointer user_data;
258 }
259 LogFuncEntry;
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? */
272 gboolean
273 _priv_gst_in_valgrind (void)
274 {
275 static enum
276 {
277 GST_VG_UNCHECKED,
278 GST_VG_NO_VALGRIND,
279 GST_VG_INSIDE
280 }
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;
291 } else {
292 GST_CAT_LOG (GST_CAT_GST_INIT, "not doing extra valgrind stuff");
293 in_valgrind = GST_VG_NO_VALGRIND;
294 }
295 #else
296 in_valgrind = GST_VG_NO_VALGRIND;
297 #endif
298 g_assert (in_valgrind == GST_VG_NO_VALGRIND ||
299 in_valgrind == GST_VG_INSIDE);
300 }
301 return (in_valgrind == GST_VG_INSIDE) ? TRUE : FALSE;
302 }
304 /**
305 * _gst_debug_init:
306 *
307 * Initializes the debugging system.
308 * Normally you don't want to call this, because gst_init() does it for you.
309 */
310 void
311 _gst_debug_init (void)
312 {
313 const gchar *env;
315 env = g_getenv ("GST_DEBUG_FILE");
316 if (env != NULL && *env != '\0') {
317 if (strcmp (env, "-") == 0) {
318 log_file = stdout;
319 } else {
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,
323 g_strerror (errno));
324 log_file = stderr;
325 }
326 }
327 } else {
328 log_file = stderr;
329 }
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);
340 #else
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);
345 #endif
346 #endif
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 gst_debug_add_log_function (gst_debug_log_default, NULL);
356 /* FIXME: add descriptions here */
357 GST_CAT_GST_INIT = _gst_debug_category_new ("GST_INIT",
358 GST_DEBUG_BOLD | GST_DEBUG_FG_RED, NULL);
359 GST_CAT_AUTOPLUG = _gst_debug_category_new ("GST_AUTOPLUG",
360 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
361 GST_CAT_AUTOPLUG_ATTEMPT = _gst_debug_category_new ("GST_AUTOPLUG_ATTEMPT",
362 GST_DEBUG_BOLD | GST_DEBUG_FG_CYAN | GST_DEBUG_BG_BLUE, NULL);
363 GST_CAT_PARENTAGE = _gst_debug_category_new ("GST_PARENTAGE",
364 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
365 GST_CAT_STATES = _gst_debug_category_new ("GST_STATES",
366 GST_DEBUG_BOLD | GST_DEBUG_FG_RED, NULL);
367 GST_CAT_SCHEDULING = _gst_debug_category_new ("GST_SCHEDULING",
368 GST_DEBUG_BOLD | GST_DEBUG_FG_MAGENTA, NULL);
369 GST_CAT_BUFFER = _gst_debug_category_new ("GST_BUFFER",
370 GST_DEBUG_BOLD | GST_DEBUG_BG_GREEN, NULL);
371 GST_CAT_BUFFER_LIST = _gst_debug_category_new ("GST_BUFFER_LIST",
372 GST_DEBUG_BOLD | GST_DEBUG_BG_GREEN, NULL);
373 GST_CAT_BUS = _gst_debug_category_new ("GST_BUS", GST_DEBUG_BG_YELLOW, NULL);
374 GST_CAT_CAPS = _gst_debug_category_new ("GST_CAPS",
375 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
376 GST_CAT_CLOCK = _gst_debug_category_new ("GST_CLOCK",
377 GST_DEBUG_BOLD | GST_DEBUG_FG_YELLOW, NULL);
378 GST_CAT_ELEMENT_PADS = _gst_debug_category_new ("GST_ELEMENT_PADS",
379 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
380 GST_CAT_PADS = _gst_debug_category_new ("GST_PADS",
381 GST_DEBUG_BOLD | GST_DEBUG_FG_RED | GST_DEBUG_BG_RED, NULL);
382 GST_CAT_PERFORMANCE = _gst_debug_category_new ("GST_PERFORMANCE",
383 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
384 GST_CAT_PIPELINE = _gst_debug_category_new ("GST_PIPELINE",
385 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
386 GST_CAT_PLUGIN_LOADING = _gst_debug_category_new ("GST_PLUGIN_LOADING",
387 GST_DEBUG_BOLD | GST_DEBUG_FG_CYAN, NULL);
388 GST_CAT_PLUGIN_INFO = _gst_debug_category_new ("GST_PLUGIN_INFO",
389 GST_DEBUG_BOLD | GST_DEBUG_FG_CYAN, NULL);
390 GST_CAT_PROPERTIES = _gst_debug_category_new ("GST_PROPERTIES",
391 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_BLUE, NULL);
392 GST_CAT_TYPES = _gst_debug_category_new ("GST_TYPES",
393 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
394 GST_CAT_XML = _gst_debug_category_new ("GST_XML",
395 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
396 GST_CAT_NEGOTIATION = _gst_debug_category_new ("GST_NEGOTIATION",
397 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
398 GST_CAT_REFCOUNTING = _gst_debug_category_new ("GST_REFCOUNTING",
399 GST_DEBUG_BOLD | GST_DEBUG_FG_RED | GST_DEBUG_BG_BLUE, NULL);
400 GST_CAT_ERROR_SYSTEM = _gst_debug_category_new ("GST_ERROR_SYSTEM",
401 GST_DEBUG_BOLD | GST_DEBUG_FG_RED | GST_DEBUG_BG_WHITE, NULL);
403 GST_CAT_EVENT = _gst_debug_category_new ("GST_EVENT",
404 GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
405 GST_CAT_MESSAGE = _gst_debug_category_new ("GST_MESSAGE",
406 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
407 GST_CAT_PARAMS = _gst_debug_category_new ("GST_PARAMS",
408 GST_DEBUG_BOLD | GST_DEBUG_FG_BLACK | GST_DEBUG_BG_YELLOW, NULL);
409 GST_CAT_CALL_TRACE = _gst_debug_category_new ("GST_CALL_TRACE",
410 GST_DEBUG_BOLD, NULL);
411 GST_CAT_SIGNAL = _gst_debug_category_new ("GST_SIGNAL",
412 GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
413 GST_CAT_PROBE = _gst_debug_category_new ("GST_PROBE",
414 GST_DEBUG_BOLD | GST_DEBUG_FG_GREEN, "pad probes");
415 GST_CAT_REGISTRY = _gst_debug_category_new ("GST_REGISTRY", 0, "registry");
416 GST_CAT_QOS = _gst_debug_category_new ("GST_QOS", 0, "QoS");
417 _priv_GST_CAT_POLL = _gst_debug_category_new ("GST_POLL", 0, "poll");
420 /* print out the valgrind message if we're in valgrind */
421 _priv_gst_in_valgrind ();
423 env = g_getenv ("GST_DEBUG_OPTIONS");
424 if (env != NULL) {
425 if (strstr (env, "full_tags") || strstr (env, "full-tags"))
426 pretty_tags = FALSE;
427 else if (strstr (env, "pretty_tags") || strstr (env, "pretty-tags"))
428 pretty_tags = TRUE;
429 }
430 }
432 /* we can't do this further above, because we initialize the GST_CAT_DEFAULT struct */
433 #define GST_CAT_DEFAULT _GST_CAT_DEBUG
435 /**
436 * gst_debug_log:
437 * @category: category to log
438 * @level: level of the message is in
439 * @file: the file that emitted the message, usually the __FILE__ identifier
440 * @function: the function that emitted the message
441 * @line: the line from that the message was emitted, usually __LINE__
442 * @object: the object this message relates to or NULL if none
443 * @format: a printf style format string
444 * @...: optional arguments for the format
445 *
446 * Logs the given message using the currently registered debugging handlers.
447 */
448 void
449 gst_debug_log (GstDebugCategory * category, GstDebugLevel level,
450 const gchar * file, const gchar * function, gint line,
451 GObject * object, const gchar * format, ...)
452 {
453 va_list var_args;
455 va_start (var_args, format);
456 gst_debug_log_valist (category, level, file, function, line, object, format,
457 var_args);
458 va_end (var_args);
459 }
461 /**
462 * gst_debug_log_valist:
463 * @category: category to log
464 * @level: level of the message is in
465 * @file: the file that emitted the message, usually the __FILE__ identifier
466 * @function: the function that emitted the message
467 * @line: the line from that the message was emitted, usually __LINE__
468 * @object: the object this message relates to or NULL if none
469 * @format: a printf style format string
470 * @args: optional arguments for the format
471 *
472 * Logs the given message using the currently registered debugging handlers.
473 */
474 void
475 gst_debug_log_valist (GstDebugCategory * category, GstDebugLevel level,
476 const gchar * file, const gchar * function, gint line,
477 GObject * object, const gchar * format, va_list args)
478 {
479 GstDebugMessage message;
480 LogFuncEntry *entry;
481 GSList *handler;
483 #ifdef _MSC_VER
484 gchar *file_basename;
485 #endif
487 g_return_if_fail (category != NULL);
488 g_return_if_fail (file != NULL);
489 g_return_if_fail (function != NULL);
490 g_return_if_fail (format != NULL);
492 #ifdef _MSC_VER
493 /*
494 * The predefined macro __FILE__ is always the exact path given to the
495 * compiler with MSVC, which may or may not be the basename. We work
496 * around it at runtime to improve the readability.
497 */
498 file = file_basename = g_path_get_basename (file);
499 #endif
501 message.message = NULL;
502 message.format = format;
503 G_VA_COPY (message.arguments, args);
505 handler = __log_functions;
506 while (handler) {
507 entry = handler->data;
508 handler = g_slist_next (handler);
509 entry->func (category, level, file, function, line, object, &message,
510 entry->user_data);
511 }
512 g_free (message.message);
513 va_end (message.arguments);
515 #ifdef _MSC_VER
516 g_free (file_basename);
517 #endif
518 }
520 /**
521 * gst_debug_message_get:
522 * @message: a debug message
523 *
524 * Gets the string representation of a #GstDebugMessage. This function is used
525 * in debug handlers to extract the message.
526 *
527 * Returns: the string representation of a #GstDebugMessage.
528 */
529 const gchar *
530 gst_debug_message_get (GstDebugMessage * message)
531 {
532 if (message->message == NULL) {
533 message->message = g_strdup_vprintf (message->format, message->arguments);
534 }
535 return message->message;
536 }
538 #define MAX_BUFFER_DUMP_STRING_LEN 100
540 /* structure_to_pretty_string:
541 * @structure: a #GstStructure
542 *
543 * Converts @structure to a human-readable string representation. Basically
544 * the same as gst_structure_to_string(), but if the structure contains large
545 * buffers such as images the hex representation of those buffers will be
546 * shortened so that the string remains readable.
547 *
548 * Returns: a newly-allocated string. g_free() when no longer needed.
549 */
550 static gchar *
551 structure_to_pretty_string (const GstStructure * s)
552 {
553 gchar *str, *pos, *end;
555 str = gst_structure_to_string (s);
556 if (str == NULL)
557 return NULL;
559 pos = str;
560 while ((pos = strstr (pos, "(buffer)"))) {
561 guint count = 0;
563 pos += strlen ("(buffer)");
564 for (end = pos; *end != '\0' && *end != ';' && *end != ' '; ++end)
565 ++count;
566 if (count > MAX_BUFFER_DUMP_STRING_LEN) {
567 memcpy (pos + MAX_BUFFER_DUMP_STRING_LEN - 6, "..", 2);
568 memcpy (pos + MAX_BUFFER_DUMP_STRING_LEN - 4, pos + count - 4, 4);
569 g_memmove (pos + MAX_BUFFER_DUMP_STRING_LEN, pos + count,
570 strlen (pos + count) + 1);
571 pos += MAX_BUFFER_DUMP_STRING_LEN;
572 }
573 }
575 return str;
576 }
578 static inline gchar *
579 gst_info_structure_to_string (GstStructure * s)
580 {
581 if (G_UNLIKELY (pretty_tags && s->name == GST_QUARK (TAGLIST)))
582 return structure_to_pretty_string (s);
583 else
584 return gst_structure_to_string (s);
585 }
587 static gchar *
588 gst_debug_print_object (gpointer ptr)
589 {
590 GObject *object = (GObject *) ptr;
592 #ifdef unused
593 /* This is a cute trick to detect unmapped memory, but is unportable,
594 * slow, screws around with madvise, and not actually that useful. */
595 {
596 int ret;
598 ret = madvise ((void *) ((unsigned long) ptr & (~0xfff)), 4096, 0);
599 if (ret == -1 && errno == ENOMEM) {
600 buffer = g_strdup_printf ("%p (unmapped memory)", ptr);
601 }
602 }
603 #endif
605 /* nicely printed object */
606 if (object == NULL) {
607 return g_strdup ("(NULL)");
608 }
609 if (*(GType *) ptr == GST_TYPE_CAPS) {
610 return gst_caps_to_string ((GstCaps *) ptr);
611 }
612 if (*(GType *) ptr == GST_TYPE_STRUCTURE) {
613 return gst_info_structure_to_string ((GstStructure *) ptr);
614 }
615 #ifdef USE_POISONING
616 if (*(guint32 *) ptr == 0xffffffff) {
617 return g_strdup_printf ("<poisoned@%p>", ptr);
618 }
619 #endif
620 if (GST_IS_PAD (object) && GST_OBJECT_NAME (object)) {
621 return g_strdup_printf ("<%s:%s>", GST_DEBUG_PAD_NAME (object));
622 }
623 if (GST_IS_OBJECT (object) && GST_OBJECT_NAME (object)) {
624 return g_strdup_printf ("<%s>", GST_OBJECT_NAME (object));
625 }
626 if (G_IS_OBJECT (object)) {
627 return g_strdup_printf ("<%s@%p>", G_OBJECT_TYPE_NAME (object), object);
628 }
629 if (GST_IS_MESSAGE (object)) {
630 GstMessage *msg = GST_MESSAGE_CAST (object);
631 gchar *s, *ret;
633 if (msg->structure) {
634 s = gst_info_structure_to_string (msg->structure);
635 } else {
636 s = g_strdup ("(NULL)");
637 }
639 ret = g_strdup_printf ("%s message from element '%s': %s",
640 GST_MESSAGE_TYPE_NAME (msg), (msg->src != NULL) ?
641 GST_ELEMENT_NAME (msg->src) : "(NULL)", s);
642 g_free (s);
643 return ret;
644 }
645 if (GST_IS_QUERY (object)) {
646 GstQuery *query = GST_QUERY_CAST (object);
648 if (query->structure) {
649 return gst_info_structure_to_string (query->structure);
650 } else {
651 const gchar *query_type_name;
653 query_type_name = gst_query_type_get_name (query->type);
654 if (G_LIKELY (query_type_name != NULL)) {
655 return g_strdup_printf ("%s query", query_type_name);
656 } else {
657 return g_strdup_printf ("query of unknown type %d", query->type);
658 }
659 }
660 }
661 if (GST_IS_EVENT (object)) {
662 GstEvent *event = GST_EVENT_CAST (object);
663 gchar *s, *ret;
665 if (event->structure) {
666 s = gst_info_structure_to_string (event->structure);
667 } else {
668 s = g_strdup ("(NULL)");
669 }
671 ret = g_strdup_printf ("%s event from '%s' at time %"
672 GST_TIME_FORMAT ": %s",
673 GST_EVENT_TYPE_NAME (event), (event->src != NULL) ?
674 GST_OBJECT_NAME (event->src) : "(NULL)",
675 GST_TIME_ARGS (event->timestamp), s);
676 g_free (s);
677 return ret;
678 }
680 return g_strdup_printf ("%p", ptr);
681 }
683 #ifdef HAVE_PRINTF_EXTENSION
685 static gchar *
686 gst_debug_print_segment (gpointer ptr)
687 {
688 GstSegment *segment = (GstSegment *) ptr;
690 /* nicely printed segment */
691 if (segment == NULL) {
692 return g_strdup ("(NULL)");
693 }
695 switch (segment->format) {
696 case GST_FORMAT_UNDEFINED:{
697 return g_strdup_printf ("UNDEFINED segment");
698 }
699 case GST_FORMAT_TIME:{
700 return g_strdup_printf ("time segment start=%" GST_TIME_FORMAT
701 ", stop=%" GST_TIME_FORMAT ", last_stop=%" GST_TIME_FORMAT
702 ", duration=%" GST_TIME_FORMAT ", rate=%f, applied_rate=%f"
703 ", flags=0x%02x, time=%" GST_TIME_FORMAT ", accum=%" GST_TIME_FORMAT,
704 GST_TIME_ARGS (segment->start), GST_TIME_ARGS (segment->stop),
705 GST_TIME_ARGS (segment->last_stop), GST_TIME_ARGS (segment->duration),
706 segment->rate, segment->applied_rate, (guint) segment->flags,
707 GST_TIME_ARGS (segment->time), GST_TIME_ARGS (segment->accum));
708 }
709 default:{
710 const gchar *format_name;
712 format_name = gst_format_get_name (segment->format);
713 if (G_UNLIKELY (format_name == NULL))
714 format_name = "(UNKNOWN FORMAT)";
715 return g_strdup_printf ("%s segment start=%" G_GINT64_FORMAT
716 ", stop=%" G_GINT64_FORMAT ", last_stop=%" G_GINT64_FORMAT
717 ", duration=%" G_GINT64_FORMAT ", rate=%f, applied_rate=%f"
718 ", flags=0x%02x, time=%" GST_TIME_FORMAT ", accum=%" GST_TIME_FORMAT,
719 format_name, segment->start, segment->stop, segment->last_stop,
720 segment->duration, segment->rate, segment->applied_rate,
721 (guint) segment->flags, GST_TIME_ARGS (segment->time),
722 GST_TIME_ARGS (segment->accum));
723 }
724 }
725 }
727 #endif /* HAVE_PRINTF_EXTENSION */
729 /**
730 * gst_debug_construct_term_color:
731 * @colorinfo: the color info
732 *
733 * Constructs a string that can be used for getting the desired color in color
734 * terminals.
735 * You need to free the string after use.
736 *
737 * Returns: a string containing the color definition
738 */
739 gchar *
740 gst_debug_construct_term_color (guint colorinfo)
741 {
742 GString *color;
744 color = g_string_new ("\033[00");
746 if (colorinfo & GST_DEBUG_BOLD) {
747 g_string_append_len (color, ";01", 3);
748 }
749 if (colorinfo & GST_DEBUG_UNDERLINE) {
750 g_string_append_len (color, ";04", 3);
751 }
752 if (colorinfo & GST_DEBUG_FG_MASK) {
753 g_string_append_printf (color, ";3%1d", colorinfo & GST_DEBUG_FG_MASK);
754 }
755 if (colorinfo & GST_DEBUG_BG_MASK) {
756 g_string_append_printf (color, ";4%1d",
757 (colorinfo & GST_DEBUG_BG_MASK) >> 4);
758 }
759 g_string_append_c (color, 'm');
761 return g_string_free (color, FALSE);
762 }
764 /**
765 * gst_debug_construct_win_color:
766 * @colorinfo: the color info
767 *
768 * Constructs an integer that can be used for getting the desired color in
769 * windows' terminals (cmd.exe). As there is no mean to underline, we simply
770 * ignore this attribute.
771 *
772 * This function returns 0 on non-windows machines.
773 *
774 * Returns: an integer containing the color definition
775 *
776 * Since: 0.10.23
777 */
778 gint
779 gst_debug_construct_win_color (guint colorinfo)
780 {
781 gint color = 0;
782 #ifdef G_OS_WIN32
783 static const guchar ansi_to_win_fg[8] = {
784 0, /* black */
785 FOREGROUND_RED, /* red */
786 FOREGROUND_GREEN, /* green */
787 FOREGROUND_RED | FOREGROUND_GREEN, /* yellow */
788 FOREGROUND_BLUE, /* blue */
789 FOREGROUND_RED | FOREGROUND_BLUE, /* magenta */
790 FOREGROUND_GREEN | FOREGROUND_BLUE, /* cyan */
791 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE /* white */
792 };
793 static const guchar ansi_to_win_bg[8] = {
794 0,
795 BACKGROUND_RED,
796 BACKGROUND_GREEN,
797 BACKGROUND_RED | BACKGROUND_GREEN,
798 BACKGROUND_BLUE,
799 BACKGROUND_RED | BACKGROUND_BLUE,
800 BACKGROUND_GREEN | FOREGROUND_BLUE,
801 BACKGROUND_RED | BACKGROUND_GREEN | BACKGROUND_BLUE
802 };
804 /* we draw black as white, as cmd.exe can only have black bg */
805 if (colorinfo == 0) {
806 return ansi_to_win_fg[7];
807 }
809 if (colorinfo & GST_DEBUG_BOLD) {
810 color |= FOREGROUND_INTENSITY;
811 }
812 if (colorinfo & GST_DEBUG_FG_MASK) {
813 color |= ansi_to_win_fg[colorinfo & GST_DEBUG_FG_MASK];
814 }
815 if (colorinfo & GST_DEBUG_BG_MASK) {
816 color |= ansi_to_win_bg[(colorinfo & GST_DEBUG_BG_MASK) >> 4];
817 }
818 #endif
819 return color;
820 }
822 /* width of %p varies depending on actual value of pointer, which can make
823 * output unevenly aligned if multiple threads are involved, hence the %14p
824 * (should really be %18p, but %14p seems a good compromise between too many
825 * white spaces and likely unalignment on my system) */
826 #if defined (GLIB_SIZEOF_VOID_P) && GLIB_SIZEOF_VOID_P == 8
827 #define PTR_FMT "%14p"
828 #else
829 #define PTR_FMT "%10p"
830 #endif
831 #define PID_FMT "%5d"
832 #define CAT_FMT "%20s %s:%d:%s:%s"
834 #ifdef G_OS_WIN32
835 static const guchar levelcolormap[GST_LEVEL_COUNT] = {
836 /* GST_LEVEL_NONE */
837 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE,
838 /* GST_LEVEL_ERROR */
839 FOREGROUND_RED | FOREGROUND_INTENSITY,
840 /* GST_LEVEL_WARNING */
841 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_INTENSITY,
842 /* GST_LEVEL_INFO */
843 FOREGROUND_GREEN | FOREGROUND_INTENSITY,
844 /* GST_LEVEL_DEBUG */
845 FOREGROUND_GREEN | FOREGROUND_BLUE,
846 /* GST_LEVEL_LOG */
847 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE,
848 /* GST_LEVEL_FIXME */
849 FOREGROUND_RED | FOREGROUND_GREEN,
850 /* GST_LEVEL_TRACE */
851 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE,
852 /* placeholder for log level 8 */
853 0,
854 /* GST_LEVEL_MEMDUMP */
855 FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE
856 };
858 static const guchar available_colors[] = {
859 FOREGROUND_RED, FOREGROUND_GREEN, FOREGROUND_RED | FOREGROUND_GREEN,
860 FOREGROUND_BLUE, FOREGROUND_RED | FOREGROUND_BLUE,
861 FOREGROUND_GREEN | FOREGROUND_BLUE,
862 };
863 #else
864 static const gchar *levelcolormap[GST_LEVEL_COUNT] = {
865 "\033[37m", /* GST_LEVEL_NONE */
866 "\033[31;01m", /* GST_LEVEL_ERROR */
867 "\033[33;01m", /* GST_LEVEL_WARNING */
868 "\033[32;01m", /* GST_LEVEL_INFO */
869 "\033[36m", /* GST_LEVEL_DEBUG */
870 "\033[37m", /* GST_LEVEL_LOG */
871 "\033[33;01m", /* GST_LEVEL_FIXME */
872 "\033[37m", /* GST_LEVEL_TRACE */
873 "\033[37m", /* placeholder for log level 8 */
874 "\033[37m" /* GST_LEVEL_MEMDUMP */
875 };
876 #endif
878 /**
879 * gst_debug_log_default:
880 * @category: category to log
881 * @level: level of the message
882 * @file: the file that emitted the message, usually the __FILE__ identifier
883 * @function: the function that emitted the message
884 * @line: the line from that the message was emitted, usually __LINE__
885 * @message: the actual message
886 * @object: the object this message relates to or NULL if none
887 * @unused: an unused variable, reserved for some user_data.
888 *
889 * The default logging handler used by GStreamer. Logging functions get called
890 * whenever a macro like GST_DEBUG or similar is used. This function outputs the
891 * message and additional info to stderr (or the log file specified via the
892 * GST_DEBUG_FILE environment variable).
893 *
894 * You can add other handlers by using gst_debug_add_log_function().
895 * And you can remove this handler by calling
896 * gst_debug_remove_log_function(gst_debug_log_default);
897 */
898 void
899 gst_debug_log_default (GstDebugCategory * category, GstDebugLevel level,
900 const gchar * file, const gchar * function, gint line,
901 GObject * object, GstDebugMessage * message, gpointer unused)
902 {
903 gint pid;
904 GstClockTime elapsed;
905 gchar *obj = NULL;
906 gboolean is_colored;
908 if (level > gst_debug_category_get_threshold (category))
909 return;
911 pid = getpid ();
912 is_colored = gst_debug_is_colored ();
914 if (object) {
915 obj = gst_debug_print_object (object);
916 } else {
917 obj = g_strdup ("");
918 }
920 elapsed = GST_CLOCK_DIFF (_priv_gst_info_start_time,
921 gst_util_get_timestamp ());
923 if (is_colored) {
924 #ifndef G_OS_WIN32
925 /* colors, non-windows */
926 gchar *color = NULL;
927 const gchar *clear;
928 gchar pidcolor[10];
929 const gchar *levelcolor;
931 color = gst_debug_construct_term_color (gst_debug_category_get_color
932 (category));
933 clear = "\033[00m";
934 g_sprintf (pidcolor, "\033[3%1dm", pid % 6 + 31);
935 levelcolor = levelcolormap[level];
937 #define PRINT_FMT " %s"PID_FMT"%s "PTR_FMT" %s%s%s %s"CAT_FMT"%s %s\n"
938 fprintf (log_file, "%" GST_TIME_FORMAT PRINT_FMT, GST_TIME_ARGS (elapsed),
939 pidcolor, pid, clear, g_thread_self (), levelcolor,
940 gst_debug_level_get_name (level), clear, color,
941 gst_debug_category_get_name (category), file, line, function, obj,
942 clear, gst_debug_message_get (message));
943 fflush (log_file);
944 #undef PRINT_FMT
945 g_free (color);
946 #else
947 /* colors, windows. We take a lock to keep colors and content together.
948 * Maybe there is a better way but for now this will do the right
949 * thing. */
950 static GStaticMutex win_print_mutex = G_STATIC_MUTEX_INIT;
951 const gint clear = FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE;
952 #define SET_COLOR(c) G_STMT_START { \
953 if (log_file == stderr) \
954 SetConsoleTextAttribute (GetStdHandle (STD_ERROR_HANDLE), (c)); \
955 } G_STMT_END
956 g_static_mutex_lock (&win_print_mutex);
957 /* timestamp */
958 fprintf (log_file, "%" GST_TIME_FORMAT " ", GST_TIME_ARGS (elapsed));
959 fflush (log_file);
960 /* pid */
961 SET_COLOR (available_colors[pid % G_N_ELEMENTS (available_colors)]);
962 fprintf (log_file, PID_FMT, pid);
963 fflush (log_file);
964 /* thread */
965 SET_COLOR (clear);
966 fprintf (log_file, " " PTR_FMT " ", g_thread_self ());
967 fflush (log_file);
968 /* level */
969 SET_COLOR (levelcolormap[level]);
970 fprintf (log_file, "%s ", gst_debug_level_get_name (level));
971 fflush (log_file);
972 /* category */
973 SET_COLOR (gst_debug_construct_win_color (gst_debug_category_get_color
974 (category)));
975 fprintf (log_file, CAT_FMT, gst_debug_category_get_name (category),
976 file, line, function, obj);
977 fflush (log_file);
978 /* message */
979 SET_COLOR (clear);
980 fprintf (log_file, " %s\n", gst_debug_message_get (message));
981 fflush (log_file);
982 g_static_mutex_unlock (&win_print_mutex);
983 #endif
984 } else {
985 /* no color, all platforms */
986 #define PRINT_FMT " "PID_FMT" "PTR_FMT" %s "CAT_FMT" %s\n"
987 fprintf (log_file, "%" GST_TIME_FORMAT PRINT_FMT, GST_TIME_ARGS (elapsed),
988 pid, g_thread_self (), gst_debug_level_get_name (level),
989 gst_debug_category_get_name (category), file, line, function, obj,
990 gst_debug_message_get (message));
991 fflush (log_file);
992 #undef PRINT_FMT
993 }
995 g_free (obj);
996 }
998 /**
999 * gst_debug_level_get_name:
1000 * @level: the level to get the name for
1001 *
1002 * Get the string representation of a debugging level
1003 *
1004 * Returns: the name
1005 */
1006 const gchar *
1007 gst_debug_level_get_name (GstDebugLevel level)
1008 {
1009 switch (level) {
1010 case GST_LEVEL_NONE:
1011 return "";
1012 case GST_LEVEL_ERROR:
1013 return "ERROR ";
1014 case GST_LEVEL_WARNING:
1015 return "WARN ";
1016 case GST_LEVEL_INFO:
1017 return "INFO ";
1018 case GST_LEVEL_DEBUG:
1019 return "DEBUG ";
1020 case GST_LEVEL_LOG:
1021 return "LOG ";
1022 case GST_LEVEL_FIXME:
1023 return "FIXME ";
1024 case GST_LEVEL_TRACE:
1025 return "TRACE ";
1026 case GST_LEVEL_MEMDUMP:
1027 return "MEMDUMP";
1028 default:
1029 g_warning ("invalid level specified for gst_debug_level_get_name");
1030 return "";
1031 }
1032 }
1034 /**
1035 * gst_debug_add_log_function:
1036 * @func: the function to use
1037 * @data: user data
1038 *
1039 * Adds the logging function to the list of logging functions.
1040 * Be sure to use #G_GNUC_NO_INSTRUMENT on that function, it is needed.
1041 */
1042 void
1043 gst_debug_add_log_function (GstLogFunction func, gpointer data)
1044 {
1045 LogFuncEntry *entry;
1046 GSList *list;
1048 g_return_if_fail (func != NULL);
1050 entry = g_slice_new (LogFuncEntry);
1051 entry->func = func;
1052 entry->user_data = data;
1053 /* FIXME: we leak the old list here - other threads might access it right now
1054 * in gst_debug_logv. Another solution is to lock the mutex in gst_debug_logv,
1055 * but that is waaay costly.
1056 * It'd probably be clever to use some kind of RCU here, but I don't know
1057 * anything about that.
1058 */
1059 g_static_mutex_lock (&__log_func_mutex);
1060 list = g_slist_copy (__log_functions);
1061 __log_functions = g_slist_prepend (list, entry);
1062 g_static_mutex_unlock (&__log_func_mutex);
1064 GST_DEBUG ("prepended log function %p (user data %p) to log functions",
1065 func, data);
1066 }
1068 static gint
1069 gst_debug_compare_log_function_by_func (gconstpointer entry, gconstpointer func)
1070 {
1071 gpointer entryfunc = (gpointer) (((LogFuncEntry *) entry)->func);
1073 return (entryfunc < func) ? -1 : (entryfunc > func) ? 1 : 0;
1074 }
1076 static gint
1077 gst_debug_compare_log_function_by_data (gconstpointer entry, gconstpointer data)
1078 {
1079 gpointer entrydata = ((LogFuncEntry *) entry)->user_data;
1081 return (entrydata < data) ? -1 : (entrydata > data) ? 1 : 0;
1082 }
1084 static guint
1085 gst_debug_remove_with_compare_func (GCompareFunc func, gpointer data)
1086 {
1087 GSList *found;
1088 GSList *new;
1089 guint removals = 0;
1091 g_static_mutex_lock (&__log_func_mutex);
1092 new = __log_functions;
1093 while ((found = g_slist_find_custom (new, data, func))) {
1094 if (new == __log_functions) {
1095 /* make a copy when we have the first hit, so that we modify the copy and
1096 * make that the new list later */
1097 new = g_slist_copy (new);
1098 continue;
1099 }
1100 g_slice_free (LogFuncEntry, found->data);
1101 new = g_slist_delete_link (new, found);
1102 removals++;
1103 }
1104 /* FIXME: We leak the old list here. See _add_log_function for why. */
1105 __log_functions = new;
1106 g_static_mutex_unlock (&__log_func_mutex);
1108 return removals;
1109 }
1111 /**
1112 * gst_debug_remove_log_function:
1113 * @func: the log function to remove
1114 *
1115 * Removes all registered instances of the given logging functions.
1116 *
1117 * Returns: How many instances of the function were removed
1118 */
1119 guint
1120 gst_debug_remove_log_function (GstLogFunction func)
1121 {
1122 guint removals;
1124 g_return_val_if_fail (func != NULL, 0);
1126 removals =
1127 gst_debug_remove_with_compare_func
1128 (gst_debug_compare_log_function_by_func, (gpointer) func);
1129 GST_DEBUG ("removed log function %p %d times from log function list", func,
1130 removals);
1132 return removals;
1133 }
1135 /**
1136 * gst_debug_remove_log_function_by_data:
1137 * @data: user data of the log function to remove
1138 *
1139 * Removes all registered instances of log functions with the given user data.
1140 *
1141 * Returns: How many instances of the function were removed
1142 */
1143 guint
1144 gst_debug_remove_log_function_by_data (gpointer data)
1145 {
1146 guint removals;
1148 removals =
1149 gst_debug_remove_with_compare_func
1150 (gst_debug_compare_log_function_by_data, data);
1151 GST_DEBUG
1152 ("removed %d log functions with user data %p from log function list",
1153 removals, data);
1155 return removals;
1156 }
1158 /**
1159 * gst_debug_set_colored:
1160 * @colored: Whether to use colored output or not
1161 *
1162 * Sets or unsets the use of coloured debugging output.
1163 *
1164 * This function may be called before gst_init().
1165 */
1166 void
1167 gst_debug_set_colored (gboolean colored)
1168 {
1169 g_atomic_int_set (&__use_color, colored ? 1 : 0);
1170 }
1172 /**
1173 * gst_debug_is_colored:
1174 *
1175 * Checks if the debugging output should be colored.
1176 *
1177 * Returns: TRUE, if the debug output should be colored.
1178 */
1179 gboolean
1180 gst_debug_is_colored (void)
1181 {
1182 return g_atomic_int_get (&__use_color) == 0 ? FALSE : TRUE;
1183 }
1185 /**
1186 * gst_debug_set_active:
1187 * @active: Whether to use debugging output or not
1188 *
1189 * If activated, debugging messages are sent to the debugging
1190 * handlers.
1191 * It makes sense to deactivate it for speed issues.
1192 * <note><para>This function is not threadsafe. It makes sense to only call it
1193 * during initialization.</para></note>
1194 */
1195 void
1196 gst_debug_set_active (gboolean active)
1197 {
1198 __gst_debug_enabled = active;
1199 if (active)
1200 __gst_debug_min = GST_LEVEL_COUNT;
1201 else
1202 __gst_debug_min = GST_LEVEL_NONE;
1203 }
1205 /**
1206 * gst_debug_is_active:
1207 *
1208 * Checks if debugging output is activated.
1209 *
1210 * Returns: TRUE, if debugging is activated
1211 */
1212 gboolean
1213 gst_debug_is_active (void)
1214 {
1215 return __gst_debug_enabled;
1216 }
1218 /**
1219 * gst_debug_set_default_threshold:
1220 * @level: level to set
1221 *
1222 * Sets the default threshold to the given level and updates all categories to
1223 * use this threshold.
1224 *
1225 * This function may be called before gst_init().
1226 */
1227 void
1228 gst_debug_set_default_threshold (GstDebugLevel level)
1229 {
1230 g_atomic_int_set (&__default_level, level);
1231 gst_debug_reset_all_thresholds ();
1232 }
1234 /**
1235 * gst_debug_get_default_threshold:
1236 *
1237 * Returns the default threshold that is used for new categories.
1238 *
1239 * Returns: the default threshold level
1240 */
1241 GstDebugLevel
1242 gst_debug_get_default_threshold (void)
1243 {
1244 return (GstDebugLevel) g_atomic_int_get (&__default_level);
1245 }
1247 static void
1248 gst_debug_reset_threshold (gpointer category, gpointer unused)
1249 {
1250 GstDebugCategory *cat = (GstDebugCategory *) category;
1251 GSList *walk;
1253 g_static_mutex_lock (&__level_name_mutex);
1254 walk = __level_name;
1255 while (walk) {
1256 LevelNameEntry *entry = walk->data;
1258 walk = g_slist_next (walk);
1259 if (g_pattern_match_string (entry->pat, cat->name)) {
1260 GST_LOG ("category %s matches pattern %p - gets set to level %d",
1261 cat->name, entry->pat, entry->level);
1262 gst_debug_category_set_threshold (cat, entry->level);
1263 goto exit;
1264 }
1265 }
1266 gst_debug_category_set_threshold (cat, gst_debug_get_default_threshold ());
1268 exit:
1269 g_static_mutex_unlock (&__level_name_mutex);
1270 }
1272 static void
1273 gst_debug_reset_all_thresholds (void)
1274 {
1275 g_static_mutex_lock (&__cat_mutex);
1276 g_slist_foreach (__categories, gst_debug_reset_threshold, NULL);
1277 g_static_mutex_unlock (&__cat_mutex);
1278 }
1280 static void
1281 for_each_threshold_by_entry (gpointer data, gpointer user_data)
1282 {
1283 GstDebugCategory *cat = (GstDebugCategory *) data;
1284 LevelNameEntry *entry = (LevelNameEntry *) user_data;
1286 if (g_pattern_match_string (entry->pat, cat->name)) {
1287 GST_LOG ("category %s matches pattern %p - gets set to level %d",
1288 cat->name, entry->pat, entry->level);
1289 gst_debug_category_set_threshold (cat, entry->level);
1290 }
1291 }
1293 /**
1294 * gst_debug_set_threshold_for_name:
1295 * @name: name of the categories to set
1296 * @level: level to set them to
1297 *
1298 * Sets all categories which match the given glob style pattern to the given
1299 * level.
1300 */
1301 void
1302 gst_debug_set_threshold_for_name (const gchar * name, GstDebugLevel level)
1303 {
1304 GPatternSpec *pat;
1305 LevelNameEntry *entry;
1307 g_return_if_fail (name != NULL);
1309 pat = g_pattern_spec_new (name);
1310 entry = g_slice_new (LevelNameEntry);
1311 entry->pat = pat;
1312 entry->level = level;
1313 g_static_mutex_lock (&__level_name_mutex);
1314 __level_name = g_slist_prepend (__level_name, entry);
1315 g_static_mutex_unlock (&__level_name_mutex);
1316 g_static_mutex_lock (&__cat_mutex);
1317 g_slist_foreach (__categories, for_each_threshold_by_entry, entry);
1318 g_static_mutex_unlock (&__cat_mutex);
1319 }
1321 /**
1322 * gst_debug_unset_threshold_for_name:
1323 * @name: name of the categories to set
1324 *
1325 * Resets all categories with the given name back to the default level.
1326 */
1327 void
1328 gst_debug_unset_threshold_for_name (const gchar * name)
1329 {
1330 GSList *walk;
1331 GPatternSpec *pat;
1333 g_return_if_fail (name != NULL);
1335 pat = g_pattern_spec_new (name);
1336 g_static_mutex_lock (&__level_name_mutex);
1337 walk = __level_name;
1338 /* improve this if you want, it's mighty slow */
1339 while (walk) {
1340 LevelNameEntry *entry = walk->data;
1342 if (g_pattern_spec_equal (entry->pat, pat)) {
1343 __level_name = g_slist_remove_link (__level_name, walk);
1344 g_pattern_spec_free (entry->pat);
1345 g_slice_free (LevelNameEntry, entry);
1346 g_slist_free_1 (walk);
1347 walk = __level_name;
1348 }
1349 }
1350 g_static_mutex_unlock (&__level_name_mutex);
1351 g_pattern_spec_free (pat);
1352 gst_debug_reset_all_thresholds ();
1353 }
1355 GstDebugCategory *
1356 _gst_debug_category_new (const gchar * name, guint color,
1357 const gchar * description)
1358 {
1359 GstDebugCategory *cat;
1361 g_return_val_if_fail (name != NULL, NULL);
1363 cat = g_slice_new (GstDebugCategory);
1364 cat->name = g_strdup (name);
1365 cat->color = color;
1366 if (description != NULL) {
1367 cat->description = g_strdup (description);
1368 } else {
1369 cat->description = g_strdup ("no description");
1370 }
1371 g_atomic_int_set (&cat->threshold, 0);
1372 gst_debug_reset_threshold (cat, NULL);
1374 /* add to category list */
1375 g_static_mutex_lock (&__cat_mutex);
1376 __categories = g_slist_prepend (__categories, cat);
1377 g_static_mutex_unlock (&__cat_mutex);
1379 return cat;
1380 }
1382 /**
1383 * gst_debug_category_free:
1384 * @category: #GstDebugCategory to free.
1385 *
1386 * Removes and frees the category and all associated resources.
1387 */
1388 void
1389 gst_debug_category_free (GstDebugCategory * category)
1390 {
1391 if (category == NULL)
1392 return;
1394 /* remove from category list */
1395 g_static_mutex_lock (&__cat_mutex);
1396 __categories = g_slist_remove (__categories, category);
1397 g_static_mutex_unlock (&__cat_mutex);
1399 g_free ((gpointer) category->name);
1400 g_free ((gpointer) category->description);
1401 g_slice_free (GstDebugCategory, category);
1402 }
1404 /**
1405 * gst_debug_category_set_threshold:
1406 * @category: a #GstDebugCategory to set threshold of.
1407 * @level: the #GstDebugLevel threshold to set.
1408 *
1409 * Sets the threshold of the category to the given level. Debug information will
1410 * only be output if the threshold is lower or equal to the level of the
1411 * debugging message.
1412 * <note><para>
1413 * Do not use this function in production code, because other functions may
1414 * change the threshold of categories as side effect. It is however a nice
1415 * function to use when debugging (even from gdb).
1416 * </para></note>
1417 */
1418 void
1419 gst_debug_category_set_threshold (GstDebugCategory * category,
1420 GstDebugLevel level)
1421 {
1422 g_return_if_fail (category != NULL);
1424 if (level > __gst_debug_min) {
1425 __gst_debug_enabled = TRUE;
1426 __gst_debug_min = level;
1427 }
1429 g_atomic_int_set (&category->threshold, level);
1430 }
1432 /**
1433 * gst_debug_category_reset_threshold:
1434 * @category: a #GstDebugCategory to reset threshold of.
1435 *
1436 * Resets the threshold of the category to the default level. Debug information
1437 * will only be output if the threshold is lower or equal to the level of the
1438 * debugging message.
1439 * Use this function to set the threshold back to where it was after using
1440 * gst_debug_category_set_threshold().
1441 */
1442 void
1443 gst_debug_category_reset_threshold (GstDebugCategory * category)
1444 {
1445 gst_debug_reset_threshold (category, NULL);
1446 }
1448 /**
1449 * gst_debug_category_get_threshold:
1450 * @category: a #GstDebugCategory to get threshold of.
1451 *
1452 * Returns the threshold of a #GstDebugCategory.
1453 *
1454 * Returns: the #GstDebugLevel that is used as threshold.
1455 */
1456 GstDebugLevel
1457 gst_debug_category_get_threshold (GstDebugCategory * category)
1458 {
1459 return g_atomic_int_get (&category->threshold);
1460 }
1462 /**
1463 * gst_debug_category_get_name:
1464 * @category: a #GstDebugCategory to get name of.
1465 *
1466 * Returns the name of a debug category.
1467 *
1468 * Returns: the name of the category.
1469 */
1470 const gchar *
1471 gst_debug_category_get_name (GstDebugCategory * category)
1472 {
1473 return category->name;
1474 }
1476 /**
1477 * gst_debug_category_get_color:
1478 * @category: a #GstDebugCategory to get the color of.
1479 *
1480 * Returns the color of a debug category used when printing output in this
1481 * category.
1482 *
1483 * Returns: the color of the category.
1484 */
1485 guint
1486 gst_debug_category_get_color (GstDebugCategory * category)
1487 {
1488 return category->color;
1489 }
1491 /**
1492 * gst_debug_category_get_description:
1493 * @category: a #GstDebugCategory to get the description of.
1494 *
1495 * Returns the description of a debug category.
1496 *
1497 * Returns: the description of the category.
1498 */
1499 const gchar *
1500 gst_debug_category_get_description (GstDebugCategory * category)
1501 {
1502 return category->description;
1503 }
1505 /**
1506 * gst_debug_get_all_categories:
1507 *
1508 * Returns a snapshot of a all categories that are currently in use . This list
1509 * may change anytime.
1510 * The caller has to free the list after use.
1511 *
1512 * Returns: the list of categories
1513 */
1514 GSList *
1515 gst_debug_get_all_categories (void)
1516 {
1517 GSList *ret;
1519 g_static_mutex_lock (&__cat_mutex);
1520 ret = g_slist_copy (__categories);
1521 g_static_mutex_unlock (&__cat_mutex);
1523 return ret;
1524 }
1526 GstDebugCategory *
1527 _gst_debug_get_category (const gchar * name)
1528 {
1529 GstDebugCategory *ret = NULL;
1530 GSList *node;
1532 for (node = __categories; node; node = g_slist_next (node)) {
1533 ret = (GstDebugCategory *) node->data;
1534 if (!strcmp (name, ret->name)) {
1535 return ret;
1536 }
1537 }
1538 return NULL;
1539 }
1541 /*** FUNCTION POINTERS ********************************************************/
1543 static GHashTable *__gst_function_pointers; /* NULL */
1544 static GStaticMutex __dbg_functions_mutex = G_STATIC_MUTEX_INIT;
1546 /* This function MUST NOT return NULL */
1547 const gchar *
1548 _gst_debug_nameof_funcptr (GstDebugFuncPtr func)
1549 {
1550 gchar *ptrname;
1552 #ifdef HAVE_DLADDR
1553 Dl_info dl_info;
1554 #endif
1556 if (G_UNLIKELY (func == NULL))
1557 return "(NULL)";
1559 g_static_mutex_lock (&__dbg_functions_mutex);
1560 if (G_LIKELY (__gst_function_pointers)) {
1561 ptrname = g_hash_table_lookup (__gst_function_pointers, (gpointer) func);
1562 g_static_mutex_unlock (&__dbg_functions_mutex);
1563 if (G_LIKELY (ptrname))
1564 return ptrname;
1565 } else {
1566 g_static_mutex_unlock (&__dbg_functions_mutex);
1567 }
1568 /* we need to create an entry in the hash table for this one so we don't leak
1569 * the name */
1570 #ifdef HAVE_DLADDR
1571 if (dladdr ((gpointer) func, &dl_info) && dl_info.dli_sname) {
1572 gchar *name = g_strdup (dl_info.dli_sname);
1574 _gst_debug_register_funcptr (func, name);
1575 return name;
1576 } else
1577 #endif
1578 {
1579 gchar *name = g_strdup_printf ("%p", (gpointer) func);
1581 _gst_debug_register_funcptr (func, name);
1582 return name;
1583 }
1584 }
1586 void
1587 _gst_debug_register_funcptr (GstDebugFuncPtr func, const gchar * ptrname)
1588 {
1589 gpointer ptr = (gpointer) func;
1591 g_static_mutex_lock (&__dbg_functions_mutex);
1593 if (!__gst_function_pointers)
1594 __gst_function_pointers = g_hash_table_new (g_direct_hash, g_direct_equal);
1595 if (!g_hash_table_lookup (__gst_function_pointers, ptr))
1596 g_hash_table_insert (__gst_function_pointers, ptr, (gpointer) ptrname);
1598 g_static_mutex_unlock (&__dbg_functions_mutex);
1599 }
1601 /*** PRINTF EXTENSIONS ********************************************************/
1603 #ifdef HAVE_PRINTF_EXTENSION
1604 static int
1605 _gst_info_printf_extension_ptr (FILE * stream, const struct printf_info *info,
1606 const void *const *args)
1607 {
1608 char *buffer;
1609 int len;
1610 void *ptr;
1612 buffer = NULL;
1613 ptr = *(void **) args[0];
1615 buffer = gst_debug_print_object (ptr);
1616 len = fprintf (stream, "%*s", (info->left ? -info->width : info->width),
1617 buffer);
1619 g_free (buffer);
1620 return len;
1621 }
1623 static int
1624 _gst_info_printf_extension_segment (FILE * stream,
1625 const struct printf_info *info, const void *const *args)
1626 {
1627 char *buffer;
1628 int len;
1629 void *ptr;
1631 buffer = NULL;
1632 ptr = *(void **) args[0];
1634 buffer = gst_debug_print_segment (ptr);
1635 len = fprintf (stream, "%*s", (info->left ? -info->width : info->width),
1636 buffer);
1638 g_free (buffer);
1639 return len;
1640 }
1642 #ifdef HAVE_REGISTER_PRINTF_SPECIFIER
1643 static int
1644 _gst_info_printf_extension_arginfo (const struct printf_info *info, size_t n,
1645 int *argtypes, int *size)
1646 #else
1647 static int
1648 _gst_info_printf_extension_arginfo (const struct printf_info *info, size_t n,
1649 int *argtypes)
1650 #endif
1651 {
1652 if (n > 0) {
1653 argtypes[0] = PA_POINTER;
1654 #ifdef HAVE_REGISTER_PRINTF_SPECIFIER
1655 *size = sizeof (gpointer);
1656 #endif
1657 }
1658 return 1;
1659 }
1660 #endif /* HAVE_PRINTF_EXTENSION */
1662 static void
1663 gst_info_dump_mem_line (gchar * linebuf, gsize linebuf_size,
1664 const guint8 * mem, gsize mem_offset, gsize mem_size)
1665 {
1666 gchar hexstr[50], ascstr[18], digitstr[4];
1668 if (mem_size > 16)
1669 mem_size = 16;
1671 hexstr[0] = '\0';
1672 ascstr[0] = '\0';
1674 if (mem != NULL) {
1675 guint i = 0;
1677 mem += mem_offset;
1678 while (i < mem_size) {
1679 ascstr[i] = (g_ascii_isprint (mem[i])) ? mem[i] : '.';
1680 g_snprintf (digitstr, sizeof (digitstr), "%02x ", mem[i]);
1681 g_strlcat (hexstr, digitstr, sizeof (hexstr));
1682 ++i;
1683 }
1684 ascstr[i] = '\0';
1685 }
1687 g_snprintf (linebuf, linebuf_size, "%08x: %-48.48s %-16.16s",
1688 (guint) mem_offset, hexstr, ascstr);
1689 }
1691 void
1692 _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
1693 const gchar * func, gint line, GObject * obj, const gchar * msg,
1694 const guint8 * data, guint length)
1695 {
1696 guint off = 0;
1698 gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "--------"
1699 "-------------------------------------------------------------------");
1701 if (msg != NULL && *msg != '\0') {
1702 gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "%s", msg);
1703 }
1705 while (off < length) {
1706 gchar buf[128];
1708 /* gst_info_dump_mem_line will process 16 bytes at most */
1709 gst_info_dump_mem_line (buf, sizeof (buf), data, off, length - off);
1710 gst_debug_log (cat, GST_LEVEL_MEMDUMP, file, func, line, obj, "%s", buf);
1711 off += 16;
1712 }
1714 gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "--------"
1715 "-------------------------------------------------------------------");
1716 }
1718 #else /* !GST_DISABLE_GST_DEBUG */
1719 #ifndef GST_REMOVE_DISABLED
1721 GstDebugCategory *
1722 _gst_debug_category_new (const gchar * name, guint color,
1723 const gchar * description)
1724 {
1725 return NULL;
1726 }
1728 void
1729 _gst_debug_register_funcptr (GstDebugFuncPtr func, const gchar * ptrname)
1730 {
1731 }
1733 /* This function MUST NOT return NULL */
1734 const gchar *
1735 _gst_debug_nameof_funcptr (GstDebugFuncPtr func)
1736 {
1737 return "(NULL)";
1738 }
1740 void
1741 gst_debug_log (GstDebugCategory * category, GstDebugLevel level,
1742 const gchar * file, const gchar * function, gint line,
1743 GObject * object, const gchar * format, ...)
1744 {
1745 }
1747 void
1748 gst_debug_log_valist (GstDebugCategory * category, GstDebugLevel level,
1749 const gchar * file, const gchar * function, gint line,
1750 GObject * object, const gchar * format, va_list args)
1751 {
1752 }
1754 const gchar *
1755 gst_debug_message_get (GstDebugMessage * message)
1756 {
1757 return "";
1758 }
1760 void
1761 gst_debug_log_default (GstDebugCategory * category, GstDebugLevel level,
1762 const gchar * file, const gchar * function, gint line,
1763 GObject * object, GstDebugMessage * message, gpointer unused)
1764 {
1765 }
1767 G_CONST_RETURN gchar *
1768 gst_debug_level_get_name (GstDebugLevel level)
1769 {
1770 return "NONE";
1771 }
1773 void
1774 gst_debug_add_log_function (GstLogFunction func, gpointer data)
1775 {
1776 }
1778 guint
1779 gst_debug_remove_log_function (GstLogFunction func)
1780 {
1781 return 0;
1782 }
1784 guint
1785 gst_debug_remove_log_function_by_data (gpointer data)
1786 {
1787 return 0;
1788 }
1790 void
1791 gst_debug_set_active (gboolean active)
1792 {
1793 }
1795 gboolean
1796 gst_debug_is_active (void)
1797 {
1798 return FALSE;
1799 }
1801 void
1802 gst_debug_set_colored (gboolean colored)
1803 {
1804 }
1806 gboolean
1807 gst_debug_is_colored (void)
1808 {
1809 return FALSE;
1810 }
1812 void
1813 gst_debug_set_default_threshold (GstDebugLevel level)
1814 {
1815 }
1817 GstDebugLevel
1818 gst_debug_get_default_threshold (void)
1819 {
1820 return GST_LEVEL_NONE;
1821 }
1823 void
1824 gst_debug_set_threshold_for_name (const gchar * name, GstDebugLevel level)
1825 {
1826 }
1828 void
1829 gst_debug_unset_threshold_for_name (const gchar * name)
1830 {
1831 }
1833 void
1834 gst_debug_category_free (GstDebugCategory * category)
1835 {
1836 }
1838 void
1839 gst_debug_category_set_threshold (GstDebugCategory * category,
1840 GstDebugLevel level)
1841 {
1842 }
1844 void
1845 gst_debug_category_reset_threshold (GstDebugCategory * category)
1846 {
1847 }
1849 GstDebugLevel
1850 gst_debug_category_get_threshold (GstDebugCategory * category)
1851 {
1852 return GST_LEVEL_NONE;
1853 }
1855 G_CONST_RETURN gchar *
1856 gst_debug_category_get_name (GstDebugCategory * category)
1857 {
1858 return "";
1859 }
1861 guint
1862 gst_debug_category_get_color (GstDebugCategory * category)
1863 {
1864 return 0;
1865 }
1867 G_CONST_RETURN gchar *
1868 gst_debug_category_get_description (GstDebugCategory * category)
1869 {
1870 return "";
1871 }
1873 GSList *
1874 gst_debug_get_all_categories (void)
1875 {
1876 return NULL;
1877 }
1879 GstDebugCategory *
1880 _gst_debug_get_category (const gchar * name)
1881 {
1882 return NULL;
1883 }
1885 gchar *
1886 gst_debug_construct_term_color (guint colorinfo)
1887 {
1888 return g_strdup ("00");
1889 }
1891 gint
1892 gst_debug_construct_win_color (guint colorinfo)
1893 {
1894 return 0;
1895 }
1897 gboolean
1898 _priv_gst_in_valgrind (void)
1899 {
1900 return FALSE;
1901 }
1903 void
1904 _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
1905 const gchar * func, gint line, GObject * obj, const gchar * msg,
1906 const guint8 * data, guint length)
1907 {
1908 }
1909 #endif /* GST_REMOVE_DISABLED */
1910 #endif /* GST_DISABLE_GST_DEBUG */
1913 #ifdef GST_ENABLE_FUNC_INSTRUMENTATION
1914 /* FIXME make this thread specific */
1915 static GSList *stack_trace = NULL;
1917 void
1918 __cyg_profile_func_enter (void *this_fn, void *call_site)
1919 G_GNUC_NO_INSTRUMENT;
1920 void __cyg_profile_func_enter (void *this_fn, void *call_site)
1921 {
1922 gchar *name = _gst_debug_nameof_funcptr (this_fn);
1923 gchar *site = _gst_debug_nameof_funcptr (call_site);
1925 GST_CAT_DEBUG (GST_CAT_CALL_TRACE, "entering function %s from %s", name,
1926 site);
1927 stack_trace =
1928 g_slist_prepend (stack_trace, g_strdup_printf ("%8p in %s from %p (%s)",
1929 this_fn, name, call_site, site));
1931 g_free (name);
1932 g_free (site);
1933 }
1935 void
1936 __cyg_profile_func_exit (void *this_fn, void *call_site)
1937 G_GNUC_NO_INSTRUMENT;
1938 void __cyg_profile_func_exit (void *this_fn, void *call_site)
1939 {
1940 gchar *name = _gst_debug_nameof_funcptr (this_fn);
1942 GST_CAT_DEBUG (GST_CAT_CALL_TRACE, "leaving function %s", name);
1943 g_free (stack_trace->data);
1944 stack_trace = g_slist_delete_link (stack_trace, stack_trace);
1946 g_free (name);
1947 }
1949 /**
1950 * gst_debug_print_stack_trace:
1951 *
1952 * If GST_ENABLE_FUNC_INSTRUMENTATION is defined a stacktrace is available for
1953 * gstreamer code, which can be printed with this function.
1954 */
1955 void
1956 gst_debug_print_stack_trace (void)
1957 {
1958 GSList *walk = stack_trace;
1959 gint count = 0;
1961 if (walk)
1962 walk = g_slist_next (walk);
1964 while (walk) {
1965 gchar *name = (gchar *) walk->data;
1967 g_print ("#%-2d %s\n", count++, name);
1969 walk = g_slist_next (walk);
1970 }
1971 }
1972 #else
1973 void
1974 gst_debug_print_stack_trace (void)
1975 {
1976 /* nothing because it's compiled out */
1977 }
1979 #endif /* GST_ENABLE_FUNC_INSTRUMENTATION */