Rework GstSegment handling
[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 ", rate=%f, applied_rate=%f"
728           ", flags=0x%02x, time=%" GST_TIME_FORMAT ", base=%" GST_TIME_FORMAT,
729           GST_TIME_ARGS (segment->start), GST_TIME_ARGS (segment->stop),
730           segment->rate, segment->applied_rate, (guint) segment->flags,
731           GST_TIME_ARGS (segment->time), GST_TIME_ARGS (segment->base));
732     }
733     default:{
734       const gchar *format_name;
735
736       format_name = gst_format_get_name (segment->format);
737       if (G_UNLIKELY (format_name == NULL))
738         format_name = "(UNKNOWN FORMAT)";
739       return g_strdup_printf ("%s segment start=%" G_GINT64_FORMAT
740           ", stop=%" G_GINT64_FORMAT ", rate=%f, applied_rate=%f"
741           ", flags=0x%02x, time=%" GST_TIME_FORMAT ", base=%" GST_TIME_FORMAT,
742           format_name, segment->start, segment->stop, segment->rate,
743           segment->applied_rate, (guint) segment->flags,
744           GST_TIME_ARGS (segment->time), GST_TIME_ARGS (segment->base));
745     }
746   }
747 }
748
749 #endif /* HAVE_PRINTF_EXTENSION */
750
751 /**
752  * gst_debug_construct_term_color:
753  * @colorinfo: the color info
754  *
755  * Constructs a string that can be used for getting the desired color in color
756  * terminals.
757  * You need to free the string after use.
758  *
759  * Returns: (transfer full) (type gchar*): a string containing the color
760  *     definition
761  */
762 gchar *
763 gst_debug_construct_term_color (guint colorinfo)
764 {
765   GString *color;
766
767   color = g_string_new ("\033[00");
768
769   if (colorinfo & GST_DEBUG_BOLD) {
770     g_string_append_len (color, ";01", 3);
771   }
772   if (colorinfo & GST_DEBUG_UNDERLINE) {
773     g_string_append_len (color, ";04", 3);
774   }
775   if (colorinfo & GST_DEBUG_FG_MASK) {
776     g_string_append_printf (color, ";3%1d", colorinfo & GST_DEBUG_FG_MASK);
777   }
778   if (colorinfo & GST_DEBUG_BG_MASK) {
779     g_string_append_printf (color, ";4%1d",
780         (colorinfo & GST_DEBUG_BG_MASK) >> 4);
781   }
782   g_string_append_c (color, 'm');
783
784   return g_string_free (color, FALSE);
785 }
786
787 /**
788  * gst_debug_construct_win_color:
789  * @colorinfo: the color info
790  *
791  * Constructs an integer that can be used for getting the desired color in
792  * windows' terminals (cmd.exe). As there is no mean to underline, we simply
793  * ignore this attribute.
794  *
795  * This function returns 0 on non-windows machines.
796  *
797  * Returns: an integer containing the color definition
798  *
799  * Since: 0.10.23
800  */
801 gint
802 gst_debug_construct_win_color (guint colorinfo)
803 {
804   gint color = 0;
805 #ifdef G_OS_WIN32
806   static const guchar ansi_to_win_fg[8] = {
807     0,                          /* black   */
808     FOREGROUND_RED,             /* red     */
809     FOREGROUND_GREEN,           /* green   */
810     FOREGROUND_RED | FOREGROUND_GREEN,  /* yellow  */
811     FOREGROUND_BLUE,            /* blue    */
812     FOREGROUND_RED | FOREGROUND_BLUE,   /* magenta */
813     FOREGROUND_GREEN | FOREGROUND_BLUE, /* cyan    */
814     FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE /* white   */
815   };
816   static const guchar ansi_to_win_bg[8] = {
817     0,
818     BACKGROUND_RED,
819     BACKGROUND_GREEN,
820     BACKGROUND_RED | BACKGROUND_GREEN,
821     BACKGROUND_BLUE,
822     BACKGROUND_RED | BACKGROUND_BLUE,
823     BACKGROUND_GREEN | FOREGROUND_BLUE,
824     BACKGROUND_RED | BACKGROUND_GREEN | BACKGROUND_BLUE
825   };
826
827   /* we draw black as white, as cmd.exe can only have black bg */
828   if (colorinfo == 0) {
829     return ansi_to_win_fg[7];
830   }
831
832   if (colorinfo & GST_DEBUG_BOLD) {
833     color |= FOREGROUND_INTENSITY;
834   }
835   if (colorinfo & GST_DEBUG_FG_MASK) {
836     color |= ansi_to_win_fg[colorinfo & GST_DEBUG_FG_MASK];
837   }
838   if (colorinfo & GST_DEBUG_BG_MASK) {
839     color |= ansi_to_win_bg[(colorinfo & GST_DEBUG_BG_MASK) >> 4];
840   }
841 #endif
842   return color;
843 }
844
845 /* width of %p varies depending on actual value of pointer, which can make
846  * output unevenly aligned if multiple threads are involved, hence the %14p
847  * (should really be %18p, but %14p seems a good compromise between too many
848  * white spaces and likely unalignment on my system) */
849 #if defined (GLIB_SIZEOF_VOID_P) && GLIB_SIZEOF_VOID_P == 8
850 #define PTR_FMT "%14p"
851 #else
852 #define PTR_FMT "%10p"
853 #endif
854 #define PID_FMT "%5d"
855 #define CAT_FMT "%20s %s:%d:%s:%s"
856
857 #ifdef G_OS_WIN32
858 static const guchar levelcolormap[GST_LEVEL_COUNT] = {
859   /* GST_LEVEL_NONE */
860   FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE,
861   /* GST_LEVEL_ERROR */
862   FOREGROUND_RED | FOREGROUND_INTENSITY,
863   /* GST_LEVEL_WARNING */
864   FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_INTENSITY,
865   /* GST_LEVEL_INFO */
866   FOREGROUND_GREEN | FOREGROUND_INTENSITY,
867   /* GST_LEVEL_DEBUG */
868   FOREGROUND_GREEN | FOREGROUND_BLUE,
869   /* GST_LEVEL_LOG */
870   FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE,
871   /* GST_LEVEL_FIXME */
872   FOREGROUND_RED | FOREGROUND_GREEN,
873   /* GST_LEVEL_TRACE */
874   FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE,
875   /* placeholder for log level 8 */
876   0,
877   /* GST_LEVEL_MEMDUMP */
878   FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE
879 };
880
881 static const guchar available_colors[] = {
882   FOREGROUND_RED, FOREGROUND_GREEN, FOREGROUND_RED | FOREGROUND_GREEN,
883   FOREGROUND_BLUE, FOREGROUND_RED | FOREGROUND_BLUE,
884   FOREGROUND_GREEN | FOREGROUND_BLUE,
885 };
886 #else
887 static const gchar *levelcolormap[GST_LEVEL_COUNT] = {
888   "\033[37m",                   /* GST_LEVEL_NONE */
889   "\033[31;01m",                /* GST_LEVEL_ERROR */
890   "\033[33;01m",                /* GST_LEVEL_WARNING */
891   "\033[32;01m",                /* GST_LEVEL_INFO */
892   "\033[36m",                   /* GST_LEVEL_DEBUG */
893   "\033[37m",                   /* GST_LEVEL_LOG */
894   "\033[33;01m",                /* GST_LEVEL_FIXME */
895   "\033[37m",                   /* GST_LEVEL_TRACE */
896   "\033[37m",                   /* placeholder for log level 8 */
897   "\033[37m"                    /* GST_LEVEL_MEMDUMP */
898 };
899 #endif
900
901 /**
902  * gst_debug_log_default:
903  * @category: category to log
904  * @level: level of the message
905  * @file: the file that emitted the message, usually the __FILE__ identifier
906  * @function: the function that emitted the message
907  * @line: the line from that the message was emitted, usually __LINE__
908  * @message: the actual message
909  * @object: (transfer none) (allow-none): the object this message relates to,
910  *     or NULL if none
911  * @unused: an unused variable, reserved for some user_data.
912  *
913  * The default logging handler used by GStreamer. Logging functions get called
914  * whenever a macro like GST_DEBUG or similar is used. This function outputs the
915  * message and additional info to stderr (or the log file specified via the
916  * GST_DEBUG_FILE environment variable).
917  *
918  * You can add other handlers by using gst_debug_add_log_function().
919  * And you can remove this handler by calling
920  * gst_debug_remove_log_function(gst_debug_log_default);
921  */
922 void
923 gst_debug_log_default (GstDebugCategory * category, GstDebugLevel level,
924     const gchar * file, const gchar * function, gint line,
925     GObject * object, GstDebugMessage * message, gpointer unused)
926 {
927   gint pid;
928   GstClockTime elapsed;
929   gchar *obj = NULL;
930   gboolean is_colored;
931
932   if (level > gst_debug_category_get_threshold (category))
933     return;
934
935   pid = getpid ();
936   is_colored = gst_debug_is_colored ();
937
938   if (object) {
939     obj = gst_debug_print_object (object);
940   } else {
941     obj = g_strdup ("");
942   }
943
944   elapsed = GST_CLOCK_DIFF (_priv_gst_info_start_time,
945       gst_util_get_timestamp ());
946
947   if (is_colored) {
948 #ifndef G_OS_WIN32
949     /* colors, non-windows */
950     gchar *color = NULL;
951     const gchar *clear;
952     gchar pidcolor[10];
953     const gchar *levelcolor;
954
955     color = gst_debug_construct_term_color (gst_debug_category_get_color
956         (category));
957     clear = "\033[00m";
958     g_sprintf (pidcolor, "\033[3%1dm", pid % 6 + 31);
959     levelcolor = levelcolormap[level];
960
961 #define PRINT_FMT " %s"PID_FMT"%s "PTR_FMT" %s%s%s %s"CAT_FMT"%s %s\n"
962     fprintf (log_file, "%" GST_TIME_FORMAT PRINT_FMT, GST_TIME_ARGS (elapsed),
963         pidcolor, pid, clear, g_thread_self (), levelcolor,
964         gst_debug_level_get_name (level), clear, color,
965         gst_debug_category_get_name (category), file, line, function, obj,
966         clear, gst_debug_message_get (message));
967     fflush (log_file);
968 #undef PRINT_FMT
969     g_free (color);
970 #else
971     /* colors, windows. We take a lock to keep colors and content together.
972      * Maybe there is a better way but for now this will do the right
973      * thing. */
974     static GStaticMutex win_print_mutex = G_STATIC_MUTEX_INIT;
975     const gint clear = FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE;
976 #define SET_COLOR(c) G_STMT_START { \
977   if (log_file == stderr) \
978     SetConsoleTextAttribute (GetStdHandle (STD_ERROR_HANDLE), (c)); \
979   } G_STMT_END
980     g_static_mutex_lock (&win_print_mutex);
981     /* timestamp */
982     fprintf (log_file, "%" GST_TIME_FORMAT " ", GST_TIME_ARGS (elapsed));
983     fflush (log_file);
984     /* pid */
985     SET_COLOR (available_colors[pid % G_N_ELEMENTS (available_colors)]);
986     fprintf (log_file, PID_FMT, pid);
987     fflush (log_file);
988     /* thread */
989     SET_COLOR (clear);
990     fprintf (log_file, " " PTR_FMT " ", g_thread_self ());
991     fflush (log_file);
992     /* level */
993     SET_COLOR (levelcolormap[level]);
994     fprintf (log_file, "%s ", gst_debug_level_get_name (level));
995     fflush (log_file);
996     /* category */
997     SET_COLOR (gst_debug_construct_win_color (gst_debug_category_get_color
998             (category)));
999     fprintf (log_file, CAT_FMT, gst_debug_category_get_name (category),
1000         file, line, function, obj);
1001     fflush (log_file);
1002     /* message */
1003     SET_COLOR (clear);
1004     fprintf (log_file, " %s\n", gst_debug_message_get (message));
1005     fflush (log_file);
1006     g_static_mutex_unlock (&win_print_mutex);
1007 #endif
1008   } else {
1009     /* no color, all platforms */
1010 #define PRINT_FMT " "PID_FMT" "PTR_FMT" %s "CAT_FMT" %s\n"
1011     fprintf (log_file, "%" GST_TIME_FORMAT PRINT_FMT, GST_TIME_ARGS (elapsed),
1012         pid, g_thread_self (), gst_debug_level_get_name (level),
1013         gst_debug_category_get_name (category), file, line, function, obj,
1014         gst_debug_message_get (message));
1015     fflush (log_file);
1016 #undef PRINT_FMT
1017   }
1018
1019   g_free (obj);
1020 }
1021
1022 /**
1023  * gst_debug_level_get_name:
1024  * @level: the level to get the name for
1025  *
1026  * Get the string representation of a debugging level
1027  *
1028  * Returns: the name
1029  */
1030 const gchar *
1031 gst_debug_level_get_name (GstDebugLevel level)
1032 {
1033   switch (level) {
1034     case GST_LEVEL_NONE:
1035       return "";
1036     case GST_LEVEL_ERROR:
1037       return "ERROR  ";
1038     case GST_LEVEL_WARNING:
1039       return "WARN   ";
1040     case GST_LEVEL_INFO:
1041       return "INFO   ";
1042     case GST_LEVEL_DEBUG:
1043       return "DEBUG  ";
1044     case GST_LEVEL_LOG:
1045       return "LOG    ";
1046     case GST_LEVEL_FIXME:
1047       return "FIXME  ";
1048     case GST_LEVEL_TRACE:
1049       return "TRACE  ";
1050     case GST_LEVEL_MEMDUMP:
1051       return "MEMDUMP";
1052     default:
1053       g_warning ("invalid level specified for gst_debug_level_get_name");
1054       return "";
1055   }
1056 }
1057
1058 /**
1059  * gst_debug_add_log_function:
1060  * @func: the function to use
1061  * @data: (closure): user data
1062  *
1063  * Adds the logging function to the list of logging functions.
1064  * Be sure to use #G_GNUC_NO_INSTRUMENT on that function, it is needed.
1065  */
1066 void
1067 gst_debug_add_log_function (GstLogFunction func, gpointer data)
1068 {
1069   LogFuncEntry *entry;
1070   GSList *list;
1071
1072   if (func == NULL)
1073     func = gst_debug_log_default;
1074
1075   entry = g_slice_new (LogFuncEntry);
1076   entry->func = func;
1077   entry->user_data = data;
1078   /* FIXME: we leak the old list here - other threads might access it right now
1079    * in gst_debug_logv. Another solution is to lock the mutex in gst_debug_logv,
1080    * but that is waaay costly.
1081    * It'd probably be clever to use some kind of RCU here, but I don't know
1082    * anything about that.
1083    */
1084   g_static_mutex_lock (&__log_func_mutex);
1085   list = g_slist_copy (__log_functions);
1086   __log_functions = g_slist_prepend (list, entry);
1087   g_static_mutex_unlock (&__log_func_mutex);
1088
1089   GST_DEBUG ("prepended log function %p (user data %p) to log functions",
1090       func, data);
1091 }
1092
1093 static gint
1094 gst_debug_compare_log_function_by_func (gconstpointer entry, gconstpointer func)
1095 {
1096   gpointer entryfunc = (gpointer) (((LogFuncEntry *) entry)->func);
1097
1098   return (entryfunc < func) ? -1 : (entryfunc > func) ? 1 : 0;
1099 }
1100
1101 static gint
1102 gst_debug_compare_log_function_by_data (gconstpointer entry, gconstpointer data)
1103 {
1104   gpointer entrydata = ((LogFuncEntry *) entry)->user_data;
1105
1106   return (entrydata < data) ? -1 : (entrydata > data) ? 1 : 0;
1107 }
1108
1109 static guint
1110 gst_debug_remove_with_compare_func (GCompareFunc func, gpointer data)
1111 {
1112   GSList *found;
1113   GSList *new;
1114   guint removals = 0;
1115
1116   g_static_mutex_lock (&__log_func_mutex);
1117   new = __log_functions;
1118   while ((found = g_slist_find_custom (new, data, func))) {
1119     if (new == __log_functions) {
1120       /* make a copy when we have the first hit, so that we modify the copy and
1121        * make that the new list later */
1122       new = g_slist_copy (new);
1123       continue;
1124     }
1125     g_slice_free (LogFuncEntry, found->data);
1126     new = g_slist_delete_link (new, found);
1127     removals++;
1128   }
1129   /* FIXME: We leak the old list here. See _add_log_function for why. */
1130   __log_functions = new;
1131   g_static_mutex_unlock (&__log_func_mutex);
1132
1133   return removals;
1134 }
1135
1136 /**
1137  * gst_debug_remove_log_function:
1138  * @func: the log function to remove
1139  *
1140  * Removes all registered instances of the given logging functions.
1141  *
1142  * Returns: How many instances of the function were removed
1143  */
1144 guint
1145 gst_debug_remove_log_function (GstLogFunction func)
1146 {
1147   guint removals;
1148
1149   if (func == NULL)
1150     func = gst_debug_log_default;
1151
1152   removals =
1153       gst_debug_remove_with_compare_func
1154       (gst_debug_compare_log_function_by_func, (gpointer) func);
1155   GST_DEBUG ("removed log function %p %d times from log function list", func,
1156       removals);
1157
1158   return removals;
1159 }
1160
1161 /**
1162  * gst_debug_remove_log_function_by_data:
1163  * @data: user data of the log function to remove
1164  *
1165  * Removes all registered instances of log functions with the given user data.
1166  *
1167  * Returns: How many instances of the function were removed
1168  */
1169 guint
1170 gst_debug_remove_log_function_by_data (gpointer data)
1171 {
1172   guint removals;
1173
1174   removals =
1175       gst_debug_remove_with_compare_func
1176       (gst_debug_compare_log_function_by_data, data);
1177   GST_DEBUG
1178       ("removed %d log functions with user data %p from log function list",
1179       removals, data);
1180
1181   return removals;
1182 }
1183
1184 /**
1185  * gst_debug_set_colored:
1186  * @colored: Whether to use colored output or not
1187  *
1188  * Sets or unsets the use of coloured debugging output.
1189  *
1190  * This function may be called before gst_init().
1191  */
1192 void
1193 gst_debug_set_colored (gboolean colored)
1194 {
1195   g_atomic_int_set (&__use_color, (gint) colored);
1196 }
1197
1198 /**
1199  * gst_debug_is_colored:
1200  *
1201  * Checks if the debugging output should be colored.
1202  *
1203  * Returns: TRUE, if the debug output should be colored.
1204  */
1205 gboolean
1206 gst_debug_is_colored (void)
1207 {
1208   return (gboolean) g_atomic_int_get (&__use_color);
1209 }
1210
1211 /**
1212  * gst_debug_set_active:
1213  * @active: Whether to use debugging output or not
1214  *
1215  * If activated, debugging messages are sent to the debugging
1216  * handlers.
1217  * It makes sense to deactivate it for speed issues.
1218  * <note><para>This function is not threadsafe. It makes sense to only call it
1219  * during initialization.</para></note>
1220  */
1221 void
1222 gst_debug_set_active (gboolean active)
1223 {
1224   __gst_debug_enabled = active;
1225   if (active)
1226     __gst_debug_min = GST_LEVEL_COUNT;
1227   else
1228     __gst_debug_min = GST_LEVEL_NONE;
1229 }
1230
1231 /**
1232  * gst_debug_is_active:
1233  *
1234  * Checks if debugging output is activated.
1235  *
1236  * Returns: TRUE, if debugging is activated
1237  */
1238 gboolean
1239 gst_debug_is_active (void)
1240 {
1241   return __gst_debug_enabled;
1242 }
1243
1244 /**
1245  * gst_debug_set_default_threshold:
1246  * @level: level to set
1247  *
1248  * Sets the default threshold to the given level and updates all categories to
1249  * use this threshold.
1250  *
1251  * This function may be called before gst_init().
1252  */
1253 void
1254 gst_debug_set_default_threshold (GstDebugLevel level)
1255 {
1256   g_atomic_int_set (&__default_level, level);
1257   gst_debug_reset_all_thresholds ();
1258 }
1259
1260 /**
1261  * gst_debug_get_default_threshold:
1262  *
1263  * Returns the default threshold that is used for new categories.
1264  *
1265  * Returns: the default threshold level
1266  */
1267 GstDebugLevel
1268 gst_debug_get_default_threshold (void)
1269 {
1270   return (GstDebugLevel) g_atomic_int_get (&__default_level);
1271 }
1272
1273 static void
1274 gst_debug_reset_threshold (gpointer category, gpointer unused)
1275 {
1276   GstDebugCategory *cat = (GstDebugCategory *) category;
1277   GSList *walk;
1278
1279   g_static_mutex_lock (&__level_name_mutex);
1280   walk = __level_name;
1281   while (walk) {
1282     LevelNameEntry *entry = walk->data;
1283
1284     walk = g_slist_next (walk);
1285     if (g_pattern_match_string (entry->pat, cat->name)) {
1286       GST_LOG ("category %s matches pattern %p - gets set to level %d",
1287           cat->name, entry->pat, entry->level);
1288       gst_debug_category_set_threshold (cat, entry->level);
1289       goto exit;
1290     }
1291   }
1292   gst_debug_category_set_threshold (cat, gst_debug_get_default_threshold ());
1293
1294 exit:
1295   g_static_mutex_unlock (&__level_name_mutex);
1296 }
1297
1298 static void
1299 gst_debug_reset_all_thresholds (void)
1300 {
1301   g_static_mutex_lock (&__cat_mutex);
1302   g_slist_foreach (__categories, gst_debug_reset_threshold, NULL);
1303   g_static_mutex_unlock (&__cat_mutex);
1304 }
1305
1306 static void
1307 for_each_threshold_by_entry (gpointer data, gpointer user_data)
1308 {
1309   GstDebugCategory *cat = (GstDebugCategory *) data;
1310   LevelNameEntry *entry = (LevelNameEntry *) user_data;
1311
1312   if (g_pattern_match_string (entry->pat, cat->name)) {
1313     GST_LOG ("category %s matches pattern %p - gets set to level %d",
1314         cat->name, entry->pat, entry->level);
1315     gst_debug_category_set_threshold (cat, entry->level);
1316   }
1317 }
1318
1319 /**
1320  * gst_debug_set_threshold_for_name:
1321  * @name: name of the categories to set
1322  * @level: level to set them to
1323  *
1324  * Sets all categories which match the given glob style pattern to the given
1325  * level.
1326  */
1327 void
1328 gst_debug_set_threshold_for_name (const gchar * name, GstDebugLevel level)
1329 {
1330   GPatternSpec *pat;
1331   LevelNameEntry *entry;
1332
1333   g_return_if_fail (name != NULL);
1334
1335   pat = g_pattern_spec_new (name);
1336   entry = g_slice_new (LevelNameEntry);
1337   entry->pat = pat;
1338   entry->level = level;
1339   g_static_mutex_lock (&__level_name_mutex);
1340   __level_name = g_slist_prepend (__level_name, entry);
1341   g_static_mutex_unlock (&__level_name_mutex);
1342   g_static_mutex_lock (&__cat_mutex);
1343   g_slist_foreach (__categories, for_each_threshold_by_entry, entry);
1344   g_static_mutex_unlock (&__cat_mutex);
1345 }
1346
1347 /**
1348  * gst_debug_unset_threshold_for_name:
1349  * @name: name of the categories to set
1350  *
1351  * Resets all categories with the given name back to the default level.
1352  */
1353 void
1354 gst_debug_unset_threshold_for_name (const gchar * name)
1355 {
1356   GSList *walk;
1357   GPatternSpec *pat;
1358
1359   g_return_if_fail (name != NULL);
1360
1361   pat = g_pattern_spec_new (name);
1362   g_static_mutex_lock (&__level_name_mutex);
1363   walk = __level_name;
1364   /* improve this if you want, it's mighty slow */
1365   while (walk) {
1366     LevelNameEntry *entry = walk->data;
1367
1368     if (g_pattern_spec_equal (entry->pat, pat)) {
1369       __level_name = g_slist_remove_link (__level_name, walk);
1370       g_pattern_spec_free (entry->pat);
1371       g_slice_free (LevelNameEntry, entry);
1372       g_slist_free_1 (walk);
1373       walk = __level_name;
1374     }
1375   }
1376   g_static_mutex_unlock (&__level_name_mutex);
1377   g_pattern_spec_free (pat);
1378   gst_debug_reset_all_thresholds ();
1379 }
1380
1381 GstDebugCategory *
1382 _gst_debug_category_new (const gchar * name, guint color,
1383     const gchar * description)
1384 {
1385   GstDebugCategory *cat;
1386
1387   g_return_val_if_fail (name != NULL, NULL);
1388
1389   cat = g_slice_new (GstDebugCategory);
1390   cat->name = g_strdup (name);
1391   cat->color = color;
1392   if (description != NULL) {
1393     cat->description = g_strdup (description);
1394   } else {
1395     cat->description = g_strdup ("no description");
1396   }
1397   g_atomic_int_set (&cat->threshold, 0);
1398   gst_debug_reset_threshold (cat, NULL);
1399
1400   /* add to category list */
1401   g_static_mutex_lock (&__cat_mutex);
1402   __categories = g_slist_prepend (__categories, cat);
1403   g_static_mutex_unlock (&__cat_mutex);
1404
1405   return cat;
1406 }
1407
1408 /**
1409  * gst_debug_category_free:
1410  * @category: #GstDebugCategory to free.
1411  *
1412  * Removes and frees the category and all associated resources.
1413  */
1414 void
1415 gst_debug_category_free (GstDebugCategory * category)
1416 {
1417   if (category == NULL)
1418     return;
1419
1420   /* remove from category list */
1421   g_static_mutex_lock (&__cat_mutex);
1422   __categories = g_slist_remove (__categories, category);
1423   g_static_mutex_unlock (&__cat_mutex);
1424
1425   g_free ((gpointer) category->name);
1426   g_free ((gpointer) category->description);
1427   g_slice_free (GstDebugCategory, category);
1428 }
1429
1430 /**
1431  * gst_debug_category_set_threshold:
1432  * @category: a #GstDebugCategory to set threshold of.
1433  * @level: the #GstDebugLevel threshold to set.
1434  *
1435  * Sets the threshold of the category to the given level. Debug information will
1436  * only be output if the threshold is lower or equal to the level of the
1437  * debugging message.
1438  * <note><para>
1439  * Do not use this function in production code, because other functions may
1440  * change the threshold of categories as side effect. It is however a nice
1441  * function to use when debugging (even from gdb).
1442  * </para></note>
1443  */
1444 void
1445 gst_debug_category_set_threshold (GstDebugCategory * category,
1446     GstDebugLevel level)
1447 {
1448   g_return_if_fail (category != NULL);
1449
1450   if (level > __gst_debug_min) {
1451     __gst_debug_enabled = TRUE;
1452     __gst_debug_min = level;
1453   }
1454
1455   g_atomic_int_set (&category->threshold, level);
1456 }
1457
1458 /**
1459  * gst_debug_category_reset_threshold:
1460  * @category: a #GstDebugCategory to reset threshold of.
1461  *
1462  * Resets the threshold of the category to the default level. Debug information
1463  * will only be output if the threshold is lower or equal to the level of the
1464  * debugging message.
1465  * Use this function to set the threshold back to where it was after using
1466  * gst_debug_category_set_threshold().
1467  */
1468 void
1469 gst_debug_category_reset_threshold (GstDebugCategory * category)
1470 {
1471   gst_debug_reset_threshold (category, NULL);
1472 }
1473
1474 /**
1475  * gst_debug_category_get_threshold:
1476  * @category: a #GstDebugCategory to get threshold of.
1477  *
1478  * Returns the threshold of a #GstDebugCategory.
1479  *
1480  * Returns: the #GstDebugLevel that is used as threshold.
1481  */
1482 GstDebugLevel
1483 gst_debug_category_get_threshold (GstDebugCategory * category)
1484 {
1485   return g_atomic_int_get (&category->threshold);
1486 }
1487
1488 /**
1489  * gst_debug_category_get_name:
1490  * @category: a #GstDebugCategory to get name of.
1491  *
1492  * Returns the name of a debug category.
1493  *
1494  * Returns: the name of the category.
1495  */
1496 const gchar *
1497 gst_debug_category_get_name (GstDebugCategory * category)
1498 {
1499   return category->name;
1500 }
1501
1502 /**
1503  * gst_debug_category_get_color:
1504  * @category: a #GstDebugCategory to get the color of.
1505  *
1506  * Returns the color of a debug category used when printing output in this
1507  * category.
1508  *
1509  * Returns: the color of the category.
1510  */
1511 guint
1512 gst_debug_category_get_color (GstDebugCategory * category)
1513 {
1514   return category->color;
1515 }
1516
1517 /**
1518  * gst_debug_category_get_description:
1519  * @category: a #GstDebugCategory to get the description of.
1520  *
1521  * Returns the description of a debug category.
1522  *
1523  * Returns: the description of the category.
1524  */
1525 const gchar *
1526 gst_debug_category_get_description (GstDebugCategory * category)
1527 {
1528   return category->description;
1529 }
1530
1531 /**
1532  * gst_debug_get_all_categories:
1533  *
1534  * Returns a snapshot of a all categories that are currently in use . This list
1535  * may change anytime.
1536  * The caller has to free the list after use.
1537  *
1538  * Returns: (transfer container) (element-type Gst.DebugCategory): the list of
1539  *     debug categories
1540  */
1541 GSList *
1542 gst_debug_get_all_categories (void)
1543 {
1544   GSList *ret;
1545
1546   g_static_mutex_lock (&__cat_mutex);
1547   ret = g_slist_copy (__categories);
1548   g_static_mutex_unlock (&__cat_mutex);
1549
1550   return ret;
1551 }
1552
1553 GstDebugCategory *
1554 _gst_debug_get_category (const gchar * name)
1555 {
1556   GstDebugCategory *ret = NULL;
1557   GSList *node;
1558
1559   for (node = __categories; node; node = g_slist_next (node)) {
1560     ret = (GstDebugCategory *) node->data;
1561     if (!strcmp (name, ret->name)) {
1562       return ret;
1563     }
1564   }
1565   return NULL;
1566 }
1567
1568 /*** FUNCTION POINTERS ********************************************************/
1569
1570 static GHashTable *__gst_function_pointers;     /* NULL */
1571 static GStaticMutex __dbg_functions_mutex = G_STATIC_MUTEX_INIT;
1572
1573 /* This function MUST NOT return NULL */
1574 const gchar *
1575 _gst_debug_nameof_funcptr (GstDebugFuncPtr func)
1576 {
1577   gchar *ptrname;
1578
1579 #ifdef HAVE_DLADDR
1580   Dl_info dl_info;
1581 #endif
1582
1583   if (G_UNLIKELY (func == NULL))
1584     return "(NULL)";
1585
1586   g_static_mutex_lock (&__dbg_functions_mutex);
1587   if (G_LIKELY (__gst_function_pointers)) {
1588     ptrname = g_hash_table_lookup (__gst_function_pointers, (gpointer) func);
1589     g_static_mutex_unlock (&__dbg_functions_mutex);
1590     if (G_LIKELY (ptrname))
1591       return ptrname;
1592   } else {
1593     g_static_mutex_unlock (&__dbg_functions_mutex);
1594   }
1595   /* we need to create an entry in the hash table for this one so we don't leak
1596    * the name */
1597 #ifdef HAVE_DLADDR
1598   if (dladdr ((gpointer) func, &dl_info) && dl_info.dli_sname) {
1599     gchar *name = g_strdup (dl_info.dli_sname);
1600
1601     _gst_debug_register_funcptr (func, name);
1602     return name;
1603   } else
1604 #endif
1605   {
1606     gchar *name = g_strdup_printf ("%p", (gpointer) func);
1607
1608     _gst_debug_register_funcptr (func, name);
1609     return name;
1610   }
1611 }
1612
1613 void
1614 _gst_debug_register_funcptr (GstDebugFuncPtr func, const gchar * ptrname)
1615 {
1616   gpointer ptr = (gpointer) func;
1617
1618   g_static_mutex_lock (&__dbg_functions_mutex);
1619
1620   if (!__gst_function_pointers)
1621     __gst_function_pointers = g_hash_table_new (g_direct_hash, g_direct_equal);
1622   if (!g_hash_table_lookup (__gst_function_pointers, ptr))
1623     g_hash_table_insert (__gst_function_pointers, ptr, (gpointer) ptrname);
1624
1625   g_static_mutex_unlock (&__dbg_functions_mutex);
1626 }
1627
1628 /*** PRINTF EXTENSIONS ********************************************************/
1629
1630 #ifdef HAVE_PRINTF_EXTENSION
1631 static int
1632 _gst_info_printf_extension_ptr (FILE * stream, const struct printf_info *info,
1633     const void *const *args)
1634 {
1635   char *buffer;
1636   int len;
1637   void *ptr;
1638
1639   buffer = NULL;
1640   ptr = *(void **) args[0];
1641
1642   buffer = gst_debug_print_object (ptr);
1643   len = fprintf (stream, "%*s", (info->left ? -info->width : info->width),
1644       buffer);
1645
1646   g_free (buffer);
1647   return len;
1648 }
1649
1650 static int
1651 _gst_info_printf_extension_segment (FILE * stream,
1652     const struct printf_info *info, const void *const *args)
1653 {
1654   char *buffer;
1655   int len;
1656   void *ptr;
1657
1658   buffer = NULL;
1659   ptr = *(void **) args[0];
1660
1661   buffer = gst_debug_print_segment (ptr);
1662   len = fprintf (stream, "%*s", (info->left ? -info->width : info->width),
1663       buffer);
1664
1665   g_free (buffer);
1666   return len;
1667 }
1668
1669 #ifdef HAVE_REGISTER_PRINTF_SPECIFIER
1670 static int
1671 _gst_info_printf_extension_arginfo (const struct printf_info *info, size_t n,
1672     int *argtypes, int *size)
1673 #else
1674 static int
1675 _gst_info_printf_extension_arginfo (const struct printf_info *info, size_t n,
1676     int *argtypes)
1677 #endif
1678 {
1679   if (n > 0) {
1680     argtypes[0] = PA_POINTER;
1681 #ifdef HAVE_REGISTER_PRINTF_SPECIFIER
1682     *size = sizeof (gpointer);
1683 #endif
1684   }
1685   return 1;
1686 }
1687 #endif /* HAVE_PRINTF_EXTENSION */
1688
1689 static void
1690 gst_info_dump_mem_line (gchar * linebuf, gsize linebuf_size,
1691     const guint8 * mem, gsize mem_offset, gsize mem_size)
1692 {
1693   gchar hexstr[50], ascstr[18], digitstr[4];
1694
1695   if (mem_size > 16)
1696     mem_size = 16;
1697
1698   hexstr[0] = '\0';
1699   ascstr[0] = '\0';
1700
1701   if (mem != NULL) {
1702     guint i = 0;
1703
1704     mem += mem_offset;
1705     while (i < mem_size) {
1706       ascstr[i] = (g_ascii_isprint (mem[i])) ? mem[i] : '.';
1707       g_snprintf (digitstr, sizeof (digitstr), "%02x ", mem[i]);
1708       g_strlcat (hexstr, digitstr, sizeof (hexstr));
1709       ++i;
1710     }
1711     ascstr[i] = '\0';
1712   }
1713
1714   g_snprintf (linebuf, linebuf_size, "%08x: %-48.48s %-16.16s",
1715       (guint) mem_offset, hexstr, ascstr);
1716 }
1717
1718 void
1719 _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
1720     const gchar * func, gint line, GObject * obj, const gchar * msg,
1721     const guint8 * data, guint length)
1722 {
1723   guint off = 0;
1724
1725   gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "--------"
1726       "-------------------------------------------------------------------");
1727
1728   if (msg != NULL && *msg != '\0') {
1729     gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "%s", msg);
1730   }
1731
1732   while (off < length) {
1733     gchar buf[128];
1734
1735     /* gst_info_dump_mem_line will process 16 bytes at most */
1736     gst_info_dump_mem_line (buf, sizeof (buf), data, off, length - off);
1737     gst_debug_log (cat, GST_LEVEL_MEMDUMP, file, func, line, obj, "%s", buf);
1738     off += 16;
1739   }
1740
1741   gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "--------"
1742       "-------------------------------------------------------------------");
1743 }
1744
1745 #else /* !GST_DISABLE_GST_DEBUG */
1746 #ifndef GST_REMOVE_DISABLED
1747
1748 GstDebugCategory *
1749 _gst_debug_category_new (const gchar * name, guint color,
1750     const gchar * description)
1751 {
1752   return NULL;
1753 }
1754
1755 void
1756 _gst_debug_register_funcptr (GstDebugFuncPtr func, const gchar * ptrname)
1757 {
1758 }
1759
1760 /* This function MUST NOT return NULL */
1761 const gchar *
1762 _gst_debug_nameof_funcptr (GstDebugFuncPtr func)
1763 {
1764   return "(NULL)";
1765 }
1766
1767 void
1768 gst_debug_log (GstDebugCategory * category, GstDebugLevel level,
1769     const gchar * file, const gchar * function, gint line,
1770     GObject * object, const gchar * format, ...)
1771 {
1772 }
1773
1774 void
1775 gst_debug_log_valist (GstDebugCategory * category, GstDebugLevel level,
1776     const gchar * file, const gchar * function, gint line,
1777     GObject * object, const gchar * format, va_list args)
1778 {
1779 }
1780
1781 const gchar *
1782 gst_debug_message_get (GstDebugMessage * message)
1783 {
1784   return "";
1785 }
1786
1787 void
1788 gst_debug_log_default (GstDebugCategory * category, GstDebugLevel level,
1789     const gchar * file, const gchar * function, gint line,
1790     GObject * object, GstDebugMessage * message, gpointer unused)
1791 {
1792 }
1793
1794 G_CONST_RETURN gchar *
1795 gst_debug_level_get_name (GstDebugLevel level)
1796 {
1797   return "NONE";
1798 }
1799
1800 void
1801 gst_debug_add_log_function (GstLogFunction func, gpointer data)
1802 {
1803 }
1804
1805 guint
1806 gst_debug_remove_log_function (GstLogFunction func)
1807 {
1808   return 0;
1809 }
1810
1811 guint
1812 gst_debug_remove_log_function_by_data (gpointer data)
1813 {
1814   return 0;
1815 }
1816
1817 void
1818 gst_debug_set_active (gboolean active)
1819 {
1820 }
1821
1822 gboolean
1823 gst_debug_is_active (void)
1824 {
1825   return FALSE;
1826 }
1827
1828 void
1829 gst_debug_set_colored (gboolean colored)
1830 {
1831 }
1832
1833 gboolean
1834 gst_debug_is_colored (void)
1835 {
1836   return FALSE;
1837 }
1838
1839 void
1840 gst_debug_set_default_threshold (GstDebugLevel level)
1841 {
1842 }
1843
1844 GstDebugLevel
1845 gst_debug_get_default_threshold (void)
1846 {
1847   return GST_LEVEL_NONE;
1848 }
1849
1850 void
1851 gst_debug_set_threshold_for_name (const gchar * name, GstDebugLevel level)
1852 {
1853 }
1854
1855 void
1856 gst_debug_unset_threshold_for_name (const gchar * name)
1857 {
1858 }
1859
1860 void
1861 gst_debug_category_free (GstDebugCategory * category)
1862 {
1863 }
1864
1865 void
1866 gst_debug_category_set_threshold (GstDebugCategory * category,
1867     GstDebugLevel level)
1868 {
1869 }
1870
1871 void
1872 gst_debug_category_reset_threshold (GstDebugCategory * category)
1873 {
1874 }
1875
1876 GstDebugLevel
1877 gst_debug_category_get_threshold (GstDebugCategory * category)
1878 {
1879   return GST_LEVEL_NONE;
1880 }
1881
1882 G_CONST_RETURN gchar *
1883 gst_debug_category_get_name (GstDebugCategory * category)
1884 {
1885   return "";
1886 }
1887
1888 guint
1889 gst_debug_category_get_color (GstDebugCategory * category)
1890 {
1891   return 0;
1892 }
1893
1894 G_CONST_RETURN gchar *
1895 gst_debug_category_get_description (GstDebugCategory * category)
1896 {
1897   return "";
1898 }
1899
1900 GSList *
1901 gst_debug_get_all_categories (void)
1902 {
1903   return NULL;
1904 }
1905
1906 GstDebugCategory *
1907 _gst_debug_get_category (const gchar * name)
1908 {
1909   return NULL;
1910 }
1911
1912 gchar *
1913 gst_debug_construct_term_color (guint colorinfo)
1914 {
1915   return g_strdup ("00");
1916 }
1917
1918 gint
1919 gst_debug_construct_win_color (guint colorinfo)
1920 {
1921   return 0;
1922 }
1923
1924 gboolean
1925 _priv_gst_in_valgrind (void)
1926 {
1927   return FALSE;
1928 }
1929
1930 void
1931 _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
1932     const gchar * func, gint line, GObject * obj, const gchar * msg,
1933     const guint8 * data, guint length)
1934 {
1935 }
1936 #endif /* GST_REMOVE_DISABLED */
1937 #endif /* GST_DISABLE_GST_DEBUG */
1938
1939
1940 #ifdef GST_ENABLE_FUNC_INSTRUMENTATION
1941 /* FIXME make this thread specific */
1942 static GSList *stack_trace = NULL;
1943
1944 void
1945 __cyg_profile_func_enter (void *this_fn, void *call_site)
1946     G_GNUC_NO_INSTRUMENT;
1947      void __cyg_profile_func_enter (void *this_fn, void *call_site)
1948 {
1949   gchar *name = _gst_debug_nameof_funcptr (this_fn);
1950   gchar *site = _gst_debug_nameof_funcptr (call_site);
1951
1952   GST_CAT_DEBUG (GST_CAT_CALL_TRACE, "entering function %s from %s", name,
1953       site);
1954   stack_trace =
1955       g_slist_prepend (stack_trace, g_strdup_printf ("%8p in %s from %p (%s)",
1956           this_fn, name, call_site, site));
1957
1958   g_free (name);
1959   g_free (site);
1960 }
1961
1962 void
1963 __cyg_profile_func_exit (void *this_fn, void *call_site)
1964     G_GNUC_NO_INSTRUMENT;
1965      void __cyg_profile_func_exit (void *this_fn, void *call_site)
1966 {
1967   gchar *name = _gst_debug_nameof_funcptr (this_fn);
1968
1969   GST_CAT_DEBUG (GST_CAT_CALL_TRACE, "leaving function %s", name);
1970   g_free (stack_trace->data);
1971   stack_trace = g_slist_delete_link (stack_trace, stack_trace);
1972
1973   g_free (name);
1974 }
1975
1976 /**
1977  * gst_debug_print_stack_trace:
1978  *
1979  * If GST_ENABLE_FUNC_INSTRUMENTATION is defined a stacktrace is available for
1980  * gstreamer code, which can be printed with this function.
1981  */
1982 void
1983 gst_debug_print_stack_trace (void)
1984 {
1985   GSList *walk = stack_trace;
1986   gint count = 0;
1987
1988   if (walk)
1989     walk = g_slist_next (walk);
1990
1991   while (walk) {
1992     gchar *name = (gchar *) walk->data;
1993
1994     g_print ("#%-2d %s\n", count++, name);
1995
1996     walk = g_slist_next (walk);
1997   }
1998 }
1999 #else
2000 void
2001 gst_debug_print_stack_trace (void)
2002 {
2003   /* nothing because it's compiled out */
2004 }
2005
2006 #endif /* GST_ENABLE_FUNC_INSTRUMENTATION */