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