gst/gstinfo.c

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