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