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