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