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