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