gst/gstinfo.c

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