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