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