gst/gstinfo.c

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