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