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