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