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