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