gst/gstinfo.c

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