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