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