gst/gstinfo.c

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