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