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   if (GST_IS_QUERY (object)) {
 534     GstQuery *query = GST_QUERY_CAST (object);
 535
 536     if (query->structure) {
 537       return gst_structure_to_string (query->structure);
 538     } else {
 539       const gchar *query_type_name;
 540
 541       query_type_name = gst_query_type_get_name (query->type);
 542       if (G_LIKELY (query_type_name != NULL)) {
 543         return g_strdup_printf ("%s query", query_type_name);
 544       } else {
 545         return g_strdup_printf ("query of unknown type %d", query->type);
 546       }
 547     }
 548   }
 549
 550   return g_strdup_printf ("%p", ptr);
 551 }
 552
 553 #ifdef HAVE_PRINTF_EXTENSION
 554
 555 static gchar *
 556 gst_debug_print_segment (gpointer ptr)
 557 {
 558   GstSegment *segment = (GstSegment *) ptr;
 559
 560   /* nicely printed segment */
 561   if (segment == NULL) {
 562     return g_strdup ("(NULL)");
 563   }
 564
 565   switch (segment->format) {
 566     case GST_FORMAT_UNDEFINED:{
 567       return g_strdup_printf ("UNDEFINED segment");
 568     }
 569     case GST_FORMAT_TIME:{
 570       return g_strdup_printf ("time segment start=%" GST_TIME_FORMAT
 571           ", stop=%" GST_TIME_FORMAT ", last_stop=%" GST_TIME_FORMAT
 572           ", duration=%" GST_TIME_FORMAT ", rate=%f, applied_rate=%f"
 573           ", flags=0x%02x, time=%" GST_TIME_FORMAT ", accum=%" GST_TIME_FORMAT,
 574           GST_TIME_ARGS (segment->start), GST_TIME_ARGS (segment->stop),
 575           GST_TIME_ARGS (segment->last_stop), GST_TIME_ARGS (segment->duration),
 576           segment->rate, segment->applied_rate, (guint) segment->flags,
 577           GST_TIME_ARGS (segment->time), GST_TIME_ARGS (segment->accum));
 578     }
 579     default:{
 580       const gchar *format_name;
 581
 582       format_name = gst_format_get_name (segment->format);
 583       if (G_UNLIKELY (format_name == NULL))
 584         format_name = "(UNKNOWN FORMAT)";
 585       return g_strdup_printf ("%s segment start=%" G_GINT64_FORMAT
 586           ", stop=%" G_GINT64_FORMAT ", last_stop=%" G_GINT64_FORMAT
 587           ", duration=%" G_GINT64_FORMAT ", rate=%f, applied_rate=%f"
 588           ", flags=0x%02x, time=%" GST_TIME_FORMAT ", accum=%" GST_TIME_FORMAT,
 589           format_name, segment->start, segment->stop, segment->last_stop,
 590           segment->duration, segment->rate, segment->applied_rate,
 591           (guint) segment->flags, GST_TIME_ARGS (segment->time),
 592           GST_TIME_ARGS (segment->accum));
 593     }
 594   }
 595 }
 596
 597 #endif /* HAVE_PRINTF_EXTENSION */
 598
 599 /**
 600  * gst_debug_construct_term_color:
 601  * @colorinfo: the color info
 602  *
 603  * Constructs a string that can be used for getting the desired color in color
 604  * terminals.
 605  * You need to free the string after use.
 606  *
 607  * Returns: a string containing the color definition
 608  */
 609 gchar *
 610 gst_debug_construct_term_color (guint colorinfo)
 611 {
 612   GString *color;
 613
 614   color = g_string_new ("\033[00");
 615
 616   if (colorinfo & GST_DEBUG_BOLD) {
 617     g_string_append_len (color, ";01", 3);
 618   }
 619   if (colorinfo & GST_DEBUG_UNDERLINE) {
 620     g_string_append_len (color, ";04", 3);
 621   }
 622   if (colorinfo & GST_DEBUG_FG_MASK) {
 623     g_string_append_printf (color, ";3%1d", colorinfo & GST_DEBUG_FG_MASK);
 624   }
 625   if (colorinfo & GST_DEBUG_BG_MASK) {
 626     g_string_append_printf (color, ";4%1d",
 627         (colorinfo & GST_DEBUG_BG_MASK) >> 4);
 628   }
 629   g_string_append_c (color, 'm');
 630
 631   return g_string_free (color, FALSE);
 632 }
 633
 634 /**
 635  * gst_debug_construct_win_color:
 636  * @colorinfo: the color info
 637  *
 638  * Constructs an integer that can be used for getting the desired color in
 639  * windows' terminals (cmd.exe). As there is no mean to underline, we simply
 640  * ignore this attribute.
 641  *
 642  * This function returns 0 on non-windows machines.
 643  *
 644  * Returns: an integer containing the color definition
 645  *
 646  * Since: 0.10.23
 647  */
 648 gint
 649 gst_debug_construct_win_color (guint colorinfo)
 650 {
 651   gint color = 0;
 652 #ifdef G_OS_WIN32
 653   static const guchar ansi_to_win_fg[8] = {
 654     0,                          /* black   */
 655     FOREGROUND_RED,             /* red     */
 656     FOREGROUND_GREEN,           /* green   */
 657     FOREGROUND_RED | FOREGROUND_GREEN,  /* yellow  */
 658     FOREGROUND_BLUE,            /* blue    */
 659     FOREGROUND_RED | FOREGROUND_BLUE,   /* magenta */
 660     FOREGROUND_GREEN | FOREGROUND_BLUE, /* cyan    */
 661     FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE /* white   */
 662   };
 663   static const guchar ansi_to_win_bg[8] = {
 664     0,
 665     BACKGROUND_RED,
 666     BACKGROUND_GREEN,
 667     BACKGROUND_RED | BACKGROUND_GREEN,
 668     BACKGROUND_BLUE,
 669     BACKGROUND_RED | BACKGROUND_BLUE,
 670     BACKGROUND_GREEN | FOREGROUND_BLUE,
 671     BACKGROUND_RED | BACKGROUND_GREEN | BACKGROUND_BLUE
 672   };
 673
 674   /* we draw black as white, as cmd.exe can only have black bg */
 675   if (colorinfo == 0) {
 676     return ansi_to_win_fg[7];
 677   }
 678
 679   if (colorinfo & GST_DEBUG_BOLD) {
 680     color |= FOREGROUND_INTENSITY;
 681   }
 682   if (colorinfo & GST_DEBUG_FG_MASK) {
 683     color |= ansi_to_win_fg[colorinfo & GST_DEBUG_FG_MASK];
 684   }
 685   if (colorinfo & GST_DEBUG_BG_MASK) {
 686     color |= ansi_to_win_bg[(colorinfo & GST_DEBUG_BG_MASK) >> 4];
 687   }
 688 #endif
 689   return color;
 690 }
 691
 692 /* width of %p varies depending on actual value of pointer, which can make
 693  * output unevenly aligned if multiple threads are involved, hence the %14p
 694  * (should really be %18p, but %14p seems a good compromise between too many
 695  * white spaces and likely unalignment on my system) */
 696 #if defined (GLIB_SIZEOF_VOID_P) && GLIB_SIZEOF_VOID_P == 8
 697 #define PTR_FMT "%14p"
 698 #else
 699 #define PTR_FMT "%10p"
 700 #endif
 701 #define PID_FMT "%5d"
 702 #define CAT_FMT "%20s %s:%d:%s:%s"
 703
 704 #ifdef G_OS_WIN32
 705 static const guchar levelcolormap[GST_LEVEL_COUNT] = {
 706   /* GST_LEVEL_NONE */
 707   FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE,
 708   /* GST_LEVEL_ERROR */
 709   FOREGROUND_RED | FOREGROUND_INTENSITY,
 710   /* GST_LEVEL_WARNING */
 711   FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_INTENSITY,
 712   /* GST_LEVEL_INFO */
 713   FOREGROUND_GREEN | FOREGROUND_INTENSITY,
 714   /* GST_LEVEL_DEBUG */
 715   FOREGROUND_GREEN | FOREGROUND_BLUE,
 716   /* GST_LEVEL_LOG */
 717   FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE,
 718   /* GST_LEVEL_FIXME */
 719   FOREGROUND_RED | FOREGROUND_GREEN,
 720   /* placeholder for log level 7 */
 721   0,
 722   /* placeholder for log level 8 */
 723   0,
 724   /* GST_LEVEL_MEMDUMP */
 725   FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE
 726 };
 727
 728 static const guchar available_colors[] = {
 729   FOREGROUND_RED, FOREGROUND_GREEN, FOREGROUND_RED | FOREGROUND_GREEN,
 730   FOREGROUND_BLUE, FOREGROUND_RED | FOREGROUND_BLUE,
 731   FOREGROUND_GREEN | FOREGROUND_BLUE,
 732 };
 733 #else
 734 static const gchar *levelcolormap[GST_LEVEL_COUNT] = {
 735   "\033[37m",                   /* GST_LEVEL_NONE */
 736   "\033[31;01m",                /* GST_LEVEL_ERROR */
 737   "\033[33;01m",                /* GST_LEVEL_WARNING */
 738   "\033[32;01m",                /* GST_LEVEL_INFO */
 739   "\033[36m",                   /* GST_LEVEL_DEBUG */
 740   "\033[37m",                   /* GST_LEVEL_LOG */
 741   "\033[33;01m",                /* GST_LEVEL_FIXME */
 742   "\033[37m",                   /* placeholder for log level 7 */
 743   "\033[37m",                   /* placeholder for log level 8 */
 744   "\033[37m"                    /* GST_LEVEL_MEMDUMP */
 745 };
 746 #endif
 747
 748 /**
 749  * gst_debug_log_default:
 750  * @category: category to log
 751  * @level: level of the message
 752  * @file: the file that emitted the message, usually the __FILE__ identifier
 753  * @function: the function that emitted the message
 754  * @line: the line from that the message was emitted, usually __LINE__
 755  * @message: the actual message
 756  * @object: the object this message relates to or NULL if none
 757  * @unused: an unused variable, reserved for some user_data.
 758  *
 759  * The default logging handler used by GStreamer. Logging functions get called
 760  * whenever a macro like GST_DEBUG or similar is used. This function outputs the
 761  * message and additional info using the glib error handler.
 762  * You can add other handlers by using gst_debug_add_log_function().
 763  * And you can remove this handler by calling
 764  * gst_debug_remove_log_function(gst_debug_log_default);
 765  */
 766 void
 767 gst_debug_log_default (GstDebugCategory * category, GstDebugLevel level,
 768     const gchar * file, const gchar * function, gint line,
 769     GObject * object, GstDebugMessage * message, gpointer unused)
 770 {
 771   gint pid;
 772   GstClockTime elapsed;
 773   gchar *obj = NULL;
 774   gboolean free_obj = TRUE;
 775   gboolean is_colored;
 776
 777   if (level > gst_debug_category_get_threshold (category))
 778     return;
 779
 780   pid = getpid ();
 781   is_colored = gst_debug_is_colored ();
 782
 783   elapsed = GST_CLOCK_DIFF (_priv_gst_info_start_time,
 784       gst_util_get_timestamp ());
 785
 786   if (object) {
 787     obj = gst_debug_print_object (object);
 788   } else {
 789     obj = "\0";
 790     free_obj = FALSE;
 791   }
 792
 793   if (is_colored) {
 794 #ifndef G_OS_WIN32
 795     gchar *color = NULL;
 796     gchar *clear;
 797     gchar pidcolor[10];
 798     const gchar *levelcolor;
 799
 800     color = gst_debug_construct_term_color (gst_debug_category_get_color
 801         (category));
 802     clear = "\033[00m";
 803     g_sprintf (pidcolor, "\033[3%1dm", pid % 6 + 31);
 804     levelcolor = levelcolormap[level];
 805
 806 #define PRINT_FMT " %s"PID_FMT"%s "PTR_FMT" %s%s%s %s"CAT_FMT"%s %s\n"
 807     g_printerr ("%" GST_TIME_FORMAT PRINT_FMT, GST_TIME_ARGS (elapsed),
 808         pidcolor, pid, clear, g_thread_self (), levelcolor,
 809         gst_debug_level_get_name (level), clear, color,
 810         gst_debug_category_get_name (category), file, line, function, obj,
 811         clear, gst_debug_message_get (message));
 812 #undef PRINT_FMT
 813     g_free (color);
 814 #else
 815     const gint clear = FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE;
 816 #define SET_COLOR(c) \
 817   SetConsoleTextAttribute (GetStdHandle (STD_ERROR_HANDLE), (c));
 818     /* timestamp */
 819     g_printerr ("%" GST_TIME_FORMAT " ", GST_TIME_ARGS (elapsed));
 820     /* pid */
 821     SET_COLOR (available_colors[pid % G_N_ELEMENTS (available_colors)]);
 822     g_printerr (PID_FMT, pid);
 823     /* thread */
 824     SET_COLOR (clear);
 825     g_printerr (" " PTR_FMT " ", g_thread_self ());
 826     /* level */
 827     SET_COLOR (levelcolormap[level]);
 828     g_printerr ("%s ", gst_debug_level_get_name (level));
 829     /* category */
 830     SET_COLOR (gst_debug_construct_win_color (gst_debug_category_get_color
 831             (category)));
 832     g_printerr (CAT_FMT, gst_debug_category_get_name (category),
 833         file, line, function, obj);
 834     /* message */
 835     SET_COLOR (clear);
 836     g_printerr (" %s\n", gst_debug_message_get (message));
 837 #endif
 838   } else {
 839 #define PRINT_FMT " "PID_FMT" "PTR_FMT" %s "CAT_FMT" %s\n"
 840     g_printerr ("%" GST_TIME_FORMAT PRINT_FMT, GST_TIME_ARGS (elapsed), pid,
 841         g_thread_self (), gst_debug_level_get_name (level),
 842         gst_debug_category_get_name (category), file, line, function, obj,
 843         gst_debug_message_get (message));
 844 #undef PRINT_FMT
 845   }
 846
 847   if (free_obj)
 848     g_free (obj);
 849 }
 850
 851 /**
 852  * gst_debug_level_get_name:
 853  * @level: the level to get the name for
 854  *
 855  * Get the string representation of a debugging level
 856  *
 857  * Returns: the name
 858  */
 859 const gchar *
 860 gst_debug_level_get_name (GstDebugLevel level)
 861 {
 862   switch (level) {
 863     case GST_LEVEL_NONE:
 864       return "";
 865     case GST_LEVEL_ERROR:
 866       return "ERROR";
 867     case GST_LEVEL_WARNING:
 868       return "WARN ";
 869     case GST_LEVEL_INFO:
 870       return "INFO ";
 871     case GST_LEVEL_DEBUG:
 872       return "DEBUG";
 873     case GST_LEVEL_LOG:
 874       return "LOG  ";
 875     case GST_LEVEL_FIXME:
 876       return "FIXME";
 877     case GST_LEVEL_MEMDUMP:
 878       return "MEMDUMP  ";
 879     default:
 880       g_warning ("invalid level specified for gst_debug_level_get_name");
 881       return "";
 882   }
 883 }
 884
 885 /**
 886  * gst_debug_add_log_function:
 887  * @func: the function to use
 888  * @data: user data
 889  *
 890  * Adds the logging function to the list of logging functions.
 891  * Be sure to use G_GNUC_NO_INSTRUMENT on that function, it is needed.
 892  */
 893 void
 894 gst_debug_add_log_function (GstLogFunction func, gpointer data)
 895 {
 896   LogFuncEntry *entry;
 897   GSList *list;
 898
 899   g_return_if_fail (func != NULL);
 900
 901   entry = g_new (LogFuncEntry, 1);
 902   entry->func = func;
 903   entry->user_data = data;
 904   /* FIXME: we leak the old list here - other threads might access it right now
 905    * in gst_debug_logv. Another solution is to lock the mutex in gst_debug_logv,
 906    * but that is waaay costly.
 907    * It'd probably be clever to use some kind of RCU here, but I don't know
 908    * anything about that.
 909    */
 910   g_static_mutex_lock (&__log_func_mutex);
 911   list = g_slist_copy (__log_functions);
 912   __log_functions = g_slist_prepend (list, entry);
 913   g_static_mutex_unlock (&__log_func_mutex);
 914
 915   GST_DEBUG ("prepended log function %p (user data %p) to log functions",
 916       func, data);
 917 }
 918
 919 static gint
 920 gst_debug_compare_log_function_by_func (gconstpointer entry, gconstpointer func)
 921 {
 922   gpointer entryfunc = (gpointer) (((LogFuncEntry *) entry)->func);
 923
 924   return (entryfunc < func) ? -1 : (entryfunc > func) ? 1 : 0;
 925 }
 926
 927 static gint
 928 gst_debug_compare_log_function_by_data (gconstpointer entry, gconstpointer data)
 929 {
 930   gpointer entrydata = ((LogFuncEntry *) entry)->user_data;
 931
 932   return (entrydata < data) ? -1 : (entrydata > data) ? 1 : 0;
 933 }
 934
 935 static guint
 936 gst_debug_remove_with_compare_func (GCompareFunc func, gpointer data)
 937 {
 938   GSList *found;
 939   GSList *new;
 940   guint removals = 0;
 941
 942   g_static_mutex_lock (&__log_func_mutex);
 943   new = __log_functions;
 944   while ((found = g_slist_find_custom (new, data, func))) {
 945     if (new == __log_functions) {
 946       /* make a copy when we have the first hit, so that we modify the copy and
 947        * make that the new list later */
 948       new = g_slist_copy (new);
 949       continue;
 950     }
 951     g_free (found->data);
 952     new = g_slist_delete_link (new, found);
 953     removals++;
 954   }
 955   /* FIXME: We leak the old list here. See _add_log_function for why. */
 956   __log_functions = new;
 957   g_static_mutex_unlock (&__log_func_mutex);
 958
 959   return removals;
 960 }
 961
 962 /**
 963  * gst_debug_remove_log_function:
 964  * @func: the log function to remove
 965  *
 966  * Removes all registered instances of the given logging functions.
 967  *
 968  * Returns: How many instances of the function were removed
 969  */
 970 guint
 971 gst_debug_remove_log_function (GstLogFunction func)
 972 {
 973   guint removals;
 974
 975   g_return_val_if_fail (func != NULL, 0);
 976
 977   removals =
 978       gst_debug_remove_with_compare_func
 979       (gst_debug_compare_log_function_by_func, (gpointer) func);
 980   GST_DEBUG ("removed log function %p %d times from log function list", func,
 981       removals);
 982
 983   return removals;
 984 }
 985
 986 /**
 987  * gst_debug_remove_log_function_by_data:
 988  * @data: user data of the log function to remove
 989  *
 990  * Removes all registered instances of log functions with the given user data.
 991  *
 992  * Returns: How many instances of the function were removed
 993  */
 994 guint
 995 gst_debug_remove_log_function_by_data (gpointer data)
 996 {
 997   guint removals;
 998
 999   removals =
1000       gst_debug_remove_with_compare_func
1001       (gst_debug_compare_log_function_by_data, data);
1002   GST_DEBUG
1003       ("removed %d log functions with user data %p from log function list",
1004       removals, data);
1005
1006   return removals;
1007 }
1008
1009 /**
1010  * gst_debug_set_colored:
1011  * @colored: Whether to use colored output or not
1012  *
1013  * Sets or unsets the use of coloured debugging output.
1014  */
1015 void
1016 gst_debug_set_colored (gboolean colored)
1017 {
1018   g_atomic_int_set (&__use_color, colored ? 1 : 0);
1019 }
1020
1021 /**
1022  * gst_debug_is_colored:
1023  *
1024  * Checks if the debugging output should be colored.
1025  *
1026  * Returns: TRUE, if the debug output should be colored.
1027  */
1028 gboolean
1029 gst_debug_is_colored (void)
1030 {
1031   return g_atomic_int_get (&__use_color) == 0 ? FALSE : TRUE;
1032 }
1033
1034 /**
1035  * gst_debug_set_active:
1036  * @active: Whether to use debugging output or not
1037  *
1038  * If activated, debugging messages are sent to the debugging
1039  * handlers.
1040  * It makes sense to deactivate it for speed issues.
1041  * <note><para>This function is not threadsafe. It makes sense to only call it
1042  * during initialization.</para></note>
1043  */
1044 void
1045 gst_debug_set_active (gboolean active)
1046 {
1047   __gst_debug_enabled = active;
1048   if (active)
1049     __gst_debug_min = GST_LEVEL_COUNT;
1050   else
1051     __gst_debug_min = GST_LEVEL_NONE;
1052 }
1053
1054 /**
1055  * gst_debug_is_active:
1056  *
1057  * Checks if debugging output is activated.
1058  *
1059  * Returns: TRUE, if debugging is activated
1060  */
1061 gboolean
1062 gst_debug_is_active (void)
1063 {
1064   return __gst_debug_enabled;
1065 }
1066
1067 /**
1068  * gst_debug_set_default_threshold:
1069  * @level: level to set
1070  *
1071  * Sets the default threshold to the given level and updates all categories to
1072  * use this threshold.
1073  */
1074 void
1075 gst_debug_set_default_threshold (GstDebugLevel level)
1076 {
1077   g_atomic_int_set (&__default_level, level);
1078   gst_debug_reset_all_thresholds ();
1079 }
1080
1081 /**
1082  * gst_debug_get_default_threshold:
1083  *
1084  * Returns the default threshold that is used for new categories.
1085  *
1086  * Returns: the default threshold level
1087  */
1088 GstDebugLevel
1089 gst_debug_get_default_threshold (void)
1090 {
1091   return (GstDebugLevel) g_atomic_int_get (&__default_level);
1092 }
1093
1094 static void
1095 gst_debug_reset_threshold (gpointer category, gpointer unused)
1096 {
1097   GstDebugCategory *cat = (GstDebugCategory *) category;
1098   GSList *walk;
1099
1100   g_static_mutex_lock (&__level_name_mutex);
1101   walk = __level_name;
1102   while (walk) {
1103     LevelNameEntry *entry = walk->data;
1104
1105     walk = g_slist_next (walk);
1106     if (g_pattern_match_string (entry->pat, cat->name)) {
1107       GST_LOG ("category %s matches pattern %p - gets set to level %d",
1108           cat->name, entry->pat, entry->level);
1109       gst_debug_category_set_threshold (cat, entry->level);
1110       goto exit;
1111     }
1112   }
1113   gst_debug_category_set_threshold (cat, gst_debug_get_default_threshold ());
1114
1115 exit:
1116   g_static_mutex_unlock (&__level_name_mutex);
1117 }
1118
1119 static void
1120 gst_debug_reset_all_thresholds (void)
1121 {
1122   g_static_mutex_lock (&__cat_mutex);
1123   g_slist_foreach (__categories, gst_debug_reset_threshold, NULL);
1124   g_static_mutex_unlock (&__cat_mutex);
1125 }
1126
1127 static void
1128 for_each_threshold_by_entry (gpointer data, gpointer user_data)
1129 {
1130   GstDebugCategory *cat = (GstDebugCategory *) data;
1131   LevelNameEntry *entry = (LevelNameEntry *) user_data;
1132
1133   if (g_pattern_match_string (entry->pat, cat->name)) {
1134     GST_LOG ("category %s matches pattern %p - gets set to level %d",
1135         cat->name, entry->pat, entry->level);
1136     gst_debug_category_set_threshold (cat, entry->level);
1137   }
1138 }
1139
1140 /**
1141  * gst_debug_set_threshold_for_name:
1142  * @name: name of the categories to set
1143  * @level: level to set them to
1144  *
1145  * Sets all categories which match the given glob style pattern to the given
1146  * level.
1147  */
1148 void
1149 gst_debug_set_threshold_for_name (const gchar * name, GstDebugLevel level)
1150 {
1151   GPatternSpec *pat;
1152   LevelNameEntry *entry;
1153
1154   g_return_if_fail (name != NULL);
1155
1156   pat = g_pattern_spec_new (name);
1157   entry = g_new (LevelNameEntry, 1);
1158   entry->pat = pat;
1159   entry->level = level;
1160   g_static_mutex_lock (&__level_name_mutex);
1161   __level_name = g_slist_prepend (__level_name, entry);
1162   g_static_mutex_unlock (&__level_name_mutex);
1163   g_static_mutex_lock (&__cat_mutex);
1164   g_slist_foreach (__categories, for_each_threshold_by_entry, entry);
1165   g_static_mutex_unlock (&__cat_mutex);
1166 }
1167
1168 /**
1169  * gst_debug_unset_threshold_for_name:
1170  * @name: name of the categories to set
1171  *
1172  * Resets all categories with the given name back to the default level.
1173  */
1174 void
1175 gst_debug_unset_threshold_for_name (const gchar * name)
1176 {
1177   GSList *walk;
1178   GPatternSpec *pat;
1179
1180   g_return_if_fail (name != NULL);
1181
1182   pat = g_pattern_spec_new (name);
1183   g_static_mutex_lock (&__level_name_mutex);
1184   walk = __level_name;
1185   /* improve this if you want, it's mighty slow */
1186   while (walk) {
1187     LevelNameEntry *entry = walk->data;
1188
1189     if (g_pattern_spec_equal (entry->pat, pat)) {
1190       __level_name = g_slist_remove_link (__level_name, walk);
1191       g_pattern_spec_free (entry->pat);
1192       g_free (entry);
1193       g_slist_free_1 (walk);
1194       walk = __level_name;
1195     }
1196   }
1197   g_static_mutex_unlock (&__level_name_mutex);
1198   g_pattern_spec_free (pat);
1199   gst_debug_reset_all_thresholds ();
1200 }
1201
1202 GstDebugCategory *
1203 _gst_debug_category_new (const gchar * name, guint color,
1204     const gchar * description)
1205 {
1206   GstDebugCategory *cat;
1207
1208   g_return_val_if_fail (name != NULL, NULL);
1209
1210   cat = g_new (GstDebugCategory, 1);
1211   cat->name = g_strdup (name);
1212   cat->color = color;
1213   if (description != NULL) {
1214     cat->description = g_strdup (description);
1215   } else {
1216     cat->description = g_strdup ("no description");
1217   }
1218   g_atomic_int_set (&cat->threshold, 0);
1219   gst_debug_reset_threshold (cat, NULL);
1220
1221   /* add to category list */
1222   g_static_mutex_lock (&__cat_mutex);
1223   __categories = g_slist_prepend (__categories, cat);
1224   g_static_mutex_unlock (&__cat_mutex);
1225
1226   return cat;
1227 }
1228
1229 /**
1230  * gst_debug_category_free:
1231  * @category: #GstDebugCategory to free.
1232  *
1233  * Removes and frees the category and all associated resources.
1234  */
1235 void
1236 gst_debug_category_free (GstDebugCategory * category)
1237 {
1238   if (category == NULL)
1239     return;
1240
1241   /* remove from category list */
1242   g_static_mutex_lock (&__cat_mutex);
1243   __categories = g_slist_remove (__categories, category);
1244   g_static_mutex_unlock (&__cat_mutex);
1245
1246   g_free ((gpointer) category->name);
1247   g_free ((gpointer) category->description);
1248   g_free (category);
1249 }
1250
1251 /**
1252  * gst_debug_category_set_threshold:
1253  * @category: a #GstDebugCategory to set threshold of.
1254  * @level: the #GstDebugLevel threshold to set.
1255  *
1256  * Sets the threshold of the category to the given level. Debug information will
1257  * only be output if the threshold is lower or equal to the level of the
1258  * debugging message.
1259  * <note><para>
1260  * Do not use this function in production code, because other functions may
1261  * change the threshold of categories as side effect. It is however a nice
1262  * function to use when debugging (even from gdb).
1263  * </para></note>
1264  */
1265 void
1266 gst_debug_category_set_threshold (GstDebugCategory * category,
1267     GstDebugLevel level)
1268 {
1269   g_return_if_fail (category != NULL);
1270
1271   if (level > __gst_debug_min) {
1272     __gst_debug_enabled = TRUE;
1273     __gst_debug_min = level;
1274   }
1275
1276   g_atomic_int_set (&category->threshold, level);
1277 }
1278
1279 /**
1280  * gst_debug_category_reset_threshold:
1281  * @category: a #GstDebugCategory to reset threshold of.
1282  *
1283  * Resets the threshold of the category to the default level. Debug information
1284  * will only be output if the threshold is lower or equal to the level of the
1285  * debugging message.
1286  * Use this function to set the threshold back to where it was after using
1287  * gst_debug_category_set_threshold().
1288  */
1289 void
1290 gst_debug_category_reset_threshold (GstDebugCategory * category)
1291 {
1292   gst_debug_reset_threshold (category, NULL);
1293 }
1294
1295 /**
1296  * gst_debug_category_get_threshold:
1297  * @category: a #GstDebugCategory to get threshold of.
1298  *
1299  * Returns the threshold of a #GstDebugCategory.
1300  *
1301  * Returns: the #GstDebugLevel that is used as threshold.
1302  */
1303 GstDebugLevel
1304 gst_debug_category_get_threshold (GstDebugCategory * category)
1305 {
1306   return g_atomic_int_get (&category->threshold);
1307 }
1308
1309 /**
1310  * gst_debug_category_get_name:
1311  * @category: a #GstDebugCategory to get name of.
1312  *
1313  * Returns the name of a debug category.
1314  *
1315  * Returns: the name of the category.
1316  */
1317 const gchar *
1318 gst_debug_category_get_name (GstDebugCategory * category)
1319 {
1320   return category->name;
1321 }
1322
1323 /**
1324  * gst_debug_category_get_color:
1325  * @category: a #GstDebugCategory to get the color of.
1326  *
1327  * Returns the color of a debug category used when printing output in this
1328  * category.
1329  *
1330  * Returns: the color of the category.
1331  */
1332 guint
1333 gst_debug_category_get_color (GstDebugCategory * category)
1334 {
1335   return category->color;
1336 }
1337
1338 /**
1339  * gst_debug_category_get_description:
1340  * @category: a #GstDebugCategory to get the description of.
1341  *
1342  * Returns the description of a debug category.
1343  *
1344  * Returns: the description of the category.
1345  */
1346 const gchar *
1347 gst_debug_category_get_description (GstDebugCategory * category)
1348 {
1349   return category->description;
1350 }
1351
1352 /**
1353  * gst_debug_get_all_categories:
1354  *
1355  * Returns a snapshot of a all categories that are currently in use . This list
1356  * may change anytime.
1357  * The caller has to free the list after use.
1358  *
1359  * Returns: the list of categories
1360  */
1361 GSList *
1362 gst_debug_get_all_categories (void)
1363 {
1364   GSList *ret;
1365
1366   g_static_mutex_lock (&__cat_mutex);
1367   ret = g_slist_copy (__categories);
1368   g_static_mutex_unlock (&__cat_mutex);
1369
1370   return ret;
1371 }
1372
1373 /*** FUNCTION POINTERS ********************************************************/
1374
1375 static GHashTable *__gst_function_pointers;     /* NULL */
1376 static GStaticMutex __dbg_functions_mutex = G_STATIC_MUTEX_INIT;
1377
1378 const gchar *
1379 _gst_debug_nameof_funcptr (GstDebugFuncPtr ptr)
1380     G_GNUC_NO_INSTRUMENT;
1381
1382 /* This function MUST NOT return NULL */
1383      const gchar *_gst_debug_nameof_funcptr (GstDebugFuncPtr func)
1384 {
1385   gchar *ptrname;
1386
1387 #ifdef HAVE_DLADDR
1388   Dl_info dl_info;
1389 #endif
1390
1391   if (G_UNLIKELY (func == NULL))
1392     return "(NULL)";
1393
1394   g_static_mutex_lock (&__dbg_functions_mutex);
1395   if (G_LIKELY (__gst_function_pointers)) {
1396     ptrname = g_hash_table_lookup (__gst_function_pointers, (gpointer) func);
1397     g_static_mutex_unlock (&__dbg_functions_mutex);
1398     if (G_LIKELY (ptrname))
1399       return ptrname;
1400   } else {
1401     g_static_mutex_unlock (&__dbg_functions_mutex);
1402   }
1403   /* we need to create an entry in the hash table for this one so we don't leak
1404    * the name */
1405 #ifdef HAVE_DLADDR
1406   if (dladdr ((gpointer) func, &dl_info) && dl_info.dli_sname) {
1407     gchar *name = g_strdup (dl_info.dli_sname);
1408
1409     _gst_debug_register_funcptr (func, name);
1410     return name;
1411   } else
1412 #endif
1413   {
1414     gchar *name = g_strdup_printf ("%p", (gpointer) func);
1415
1416     _gst_debug_register_funcptr (func, name);
1417     return name;
1418   }
1419 }
1420
1421 void
1422 _gst_debug_register_funcptr (GstDebugFuncPtr func, const gchar * ptrname)
1423 {
1424   gpointer ptr = (gpointer) func;
1425
1426   g_static_mutex_lock (&__dbg_functions_mutex);
1427
1428   if (!__gst_function_pointers)
1429     __gst_function_pointers = g_hash_table_new (g_direct_hash, g_direct_equal);
1430   if (!g_hash_table_lookup (__gst_function_pointers, ptr))
1431     g_hash_table_insert (__gst_function_pointers, ptr, (gpointer) ptrname);
1432
1433   g_static_mutex_unlock (&__dbg_functions_mutex);
1434 }
1435
1436 /*** PRINTF EXTENSIONS ********************************************************/
1437
1438 #ifdef HAVE_PRINTF_EXTENSION
1439 static int
1440 _gst_info_printf_extension_ptr (FILE * stream, const struct printf_info *info,
1441     const void *const *args)
1442 {
1443   char *buffer;
1444   int len;
1445   void *ptr;
1446
1447   buffer = NULL;
1448   ptr = *(void **) args[0];
1449
1450   buffer = gst_debug_print_object (ptr);
1451   len = fprintf (stream, "%*s", (info->left ? -info->width : info->width),
1452       buffer);
1453
1454   g_free (buffer);
1455   return len;
1456 }
1457
1458 static int
1459 _gst_info_printf_extension_segment (FILE * stream,
1460     const struct printf_info *info, const void *const *args)
1461 {
1462   char *buffer;
1463   int len;
1464   void *ptr;
1465
1466   buffer = NULL;
1467   ptr = *(void **) args[0];
1468
1469   buffer = gst_debug_print_segment (ptr);
1470   len = fprintf (stream, "%*s", (info->left ? -info->width : info->width),
1471       buffer);
1472
1473   g_free (buffer);
1474   return len;
1475 }
1476
1477 static int
1478 _gst_info_printf_extension_arginfo (const struct printf_info *info, size_t n,
1479     int *argtypes)
1480 {
1481   if (n > 0)
1482     argtypes[0] = PA_POINTER;
1483   return 1;
1484 }
1485 #endif /* HAVE_PRINTF_EXTENSION */
1486
1487 static void
1488 gst_info_dump_mem_line (gchar * linebuf, gsize linebuf_size,
1489     const guint8 * mem, gsize mem_offset, gsize mem_size)
1490 {
1491   gchar hexstr[50], ascstr[18], digitstr[4];
1492
1493   if (mem_size > 16)
1494     mem_size = 16;
1495
1496   hexstr[0] = '\0';
1497   ascstr[0] = '\0';
1498
1499   if (mem != NULL) {
1500     guint i = 0;
1501
1502     mem += mem_offset;
1503     while (i < mem_size) {
1504       ascstr[i] = (g_ascii_isprint (mem[i])) ? mem[i] : '.';
1505       g_snprintf (digitstr, sizeof (digitstr), "%02x ", mem[i]);
1506       g_strlcat (hexstr, digitstr, sizeof (hexstr));
1507       ++i;
1508     }
1509     ascstr[i] = '\0';
1510   }
1511
1512   g_snprintf (linebuf, linebuf_size, "%08x: %-48.48s %-16.16s",
1513       (guint) mem_offset, hexstr, ascstr);
1514 }
1515
1516 void
1517 _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
1518     const gchar * func, gint line, GObject * obj, const gchar * msg,
1519     const guint8 * data, guint length)
1520 {
1521   guint off = 0;
1522
1523   gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "--------"
1524       "-------------------------------------------------------------------");
1525
1526   if (msg != NULL && *msg != '\0') {
1527     gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, msg);
1528   }
1529
1530   while (off < length) {
1531     gchar buf[128];
1532
1533     /* gst_info_dump_mem_line will process 16 bytes at most */
1534     gst_info_dump_mem_line (buf, sizeof (buf), data, off, length - off);
1535     gst_debug_log (cat, GST_LEVEL_MEMDUMP, file, func, line, obj, "%s", buf);
1536     off += 16;
1537   }
1538
1539   gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "--------"
1540       "-------------------------------------------------------------------");
1541 }
1542
1543 #else /* !GST_DISABLE_GST_DEBUG */
1544 #ifndef GST_REMOVE_DISABLED
1545 void
1546 gst_debug_log (GstDebugCategory * category, GstDebugLevel level,
1547     const gchar * file, const gchar * function, gint line,
1548     GObject * object, const gchar * format, ...)
1549 {
1550 }
1551
1552 void
1553 gst_debug_log_valist (GstDebugCategory * category, GstDebugLevel level,
1554     const gchar * file, const gchar * function, gint line,
1555     GObject * object, const gchar * format, va_list args)
1556 {
1557 }
1558
1559 const gchar *
1560 gst_debug_message_get (GstDebugMessage * message)
1561 {
1562   return "";
1563 }
1564
1565 gchar *
1566 gst_debug_construct_term_color (guint colorinfo)
1567 {
1568   return g_strdup ("");
1569 }
1570
1571 gint
1572 gst_debug_construct_win_color (guint colorinfo)
1573 {
1574   return 0;
1575 }
1576
1577 void
1578 gst_debug_log_default (GstDebugCategory * category, GstDebugLevel level,
1579     const gchar * file, const gchar * function, gint line,
1580     GObject * object, GstDebugMessage * message, gpointer unused)
1581 {
1582 }
1583
1584 const gchar *
1585 gst_debug_level_get_name (GstDebugLevel level)
1586 {
1587   return "";
1588 }
1589
1590 void
1591 gst_debug_add_log_function (GstLogFunction func, gpointer data)
1592 {
1593 }
1594
1595 guint
1596 gst_debug_remove_log_function (GstLogFunction func)
1597 {
1598   return 0;
1599 }
1600
1601 guint
1602 gst_debug_remove_log_function_by_data (gpointer data)
1603 {
1604   return 0;
1605 }
1606
1607 gboolean
1608 _priv_gst_in_valgrind (void)
1609 {
1610   return FALSE;
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 }
1619 #endif /* GST_REMOVE_DISABLED */
1620 #endif /* GST_DISABLE_GST_DEBUG */
1621
1622
1623 #ifdef GST_ENABLE_FUNC_INSTRUMENTATION
1624 /* FIXME make this thread specific */
1625 static GSList *stack_trace = NULL;
1626
1627 void
1628 __cyg_profile_func_enter (void *this_fn, void *call_site)
1629     G_GNUC_NO_INSTRUMENT;
1630      void __cyg_profile_func_enter (void *this_fn, void *call_site)
1631 {
1632   gchar *name = _gst_debug_nameof_funcptr (this_fn);
1633   gchar *site = _gst_debug_nameof_funcptr (call_site);
1634
1635   GST_CAT_DEBUG (GST_CAT_CALL_TRACE, "entering function %s from %s", name,
1636       site);
1637   stack_trace =
1638       g_slist_prepend (stack_trace, g_strdup_printf ("%8p in %s from %p (%s)",
1639           this_fn, name, call_site, site));
1640
1641   g_free (name);
1642   g_free (site);
1643 }
1644
1645 void
1646 __cyg_profile_func_exit (void *this_fn, void *call_site)
1647     G_GNUC_NO_INSTRUMENT;
1648      void __cyg_profile_func_exit (void *this_fn, void *call_site)
1649 {
1650   gchar *name = _gst_debug_nameof_funcptr (this_fn);
1651
1652   GST_CAT_DEBUG (GST_CAT_CALL_TRACE, "leaving function %s", name);
1653   g_free (stack_trace->data);
1654   stack_trace = g_slist_delete_link (stack_trace, stack_trace);
1655
1656   g_free (name);
1657 }
1658
1659 /**
1660  * gst_debug_print_stack_trace:
1661  *
1662  * If GST_ENABLE_FUNC_INSTRUMENTATION is defined a stacktrace is available for
1663  * gstreamer code, which can be printed with this function.
1664  */
1665 void
1666 gst_debug_print_stack_trace (void)
1667 {
1668   GSList *walk = stack_trace;
1669   gint count = 0;
1670
1671   if (walk)
1672     walk = g_slist_next (walk);
1673
1674   while (walk) {
1675     gchar *name = (gchar *) walk->data;
1676
1677     g_print ("#%-2d %s\n", count++, name);
1678
1679     walk = g_slist_next (walk);
1680   }
1681 }
1682 #else
1683 void
1684 gst_debug_print_stack_trace (void)
1685 {
1686   /* nothing because it's compiled out */
1687 }
1688
1689 #endif /* GST_ENABLE_FUNC_INSTRUMENTATION */