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