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