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