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., 51 Franklin St, Fifth Floor,
  22  * Boston, MA 02110-1301, USA.
  23  */
  24
  25 /**
  26  * SECTION:gstinfo
  27  * @title: GstInfo
  28  * @short_description: Debugging and logging facilities
  29  * @see_also: #gst-running for command line parameters
  30  * and environment variables that affect the debugging output.
  31  *
  32  * GStreamer's debugging subsystem is an easy way to get information about what
  33  * the application is doing.  It is not meant for programming errors. Use GLib
  34  * methods (g_warning and friends) for that.
  35  *
  36  * The debugging subsystem works only after GStreamer has been initialized
  37  * - for example by calling gst_init().
  38  *
  39  * The debugging subsystem is used to log informational messages while the
  40  * application runs.  Each messages has some properties attached to it. Among
  41  * these properties are the debugging category, the severity (called "level"
  42  * here) and an optional #GObject it belongs to. Each of these messages is sent
  43  * to all registered debugging handlers, which then handle the messages.
  44  * GStreamer attaches a default handler on startup, which outputs requested
  45  * messages to stderr.
  46  *
  47  * Messages are output by using shortcut macros like #GST_DEBUG,
  48  * #GST_CAT_ERROR_OBJECT or similar. These all expand to calling gst_debug_log()
  49  * with the right parameters.
  50  * The only thing a developer will probably want to do is define his own
  51  * categories. This is easily done with 3 lines. At the top of your code,
  52  * declare
  53  * the variables and set the default category.
  54  * |[<!-- language="C" -->
  55  *   GST_DEBUG_CATEGORY_STATIC (my_category);  // define category (statically)
  56  *   #define GST_CAT_DEFAULT my_category       // set as default
  57  * ]|
  58  * After that you only need to initialize the category.
  59  * |[<!-- language="C" -->
  60  *   GST_DEBUG_CATEGORY_INIT (my_category, "my category",
  61  *                            0, "This is my very own");
  62  * ]|
  63  * Initialization must be done before the category is used first.
  64  * Plugins do this
  65  * in their plugin_init function, libraries and applications should do that
  66  * during their initialization.
  67  *
  68  * The whole debugging subsystem can be disabled at build time with passing the
  69  * --disable-gst-debug switch to configure. If this is done, every function,
  70  * macro and even structs described in this file evaluate to default values or
  71  * nothing at all.
  72  * So don't take addresses of these functions or use other tricks.
  73  * If you must do that for some reason, there is still an option.
  74  * If the debugging
  75  * subsystem was compiled out, #GST_DISABLE_GST_DEBUG is defined in
  76  * &lt;gst/gst.h&gt;,
  77  * so you can check that before doing your trick.
  78  * Disabling the debugging subsystem will give you a slight (read: unnoticeable)
  79  * speed increase and will reduce the size of your compiled code. The GStreamer
  80  * library itself becomes around 10% smaller.
  81  *
  82  * Please note that there are naming conventions for the names of debugging
  83  * categories. These are explained at GST_DEBUG_CATEGORY_INIT().
  84  */
  85
  86 #define GST_INFO_C
  87 #include "gst_private.h"
  88 #include "gstinfo.h"
  89
  90 #undef gst_debug_remove_log_function
  91 #undef gst_debug_add_log_function
  92
  93 #ifndef GST_DISABLE_GST_DEBUG
  94 #ifdef HAVE_DLFCN_H
  95 #  include <dlfcn.h>
  96 #endif
  97 #include <stdio.h>              /* fprintf */
  98 #include <glib/gstdio.h>
  99 #include <errno.h>
 100 #ifdef HAVE_UNISTD_H
 101 #  include <unistd.h>           /* getpid on UNIX */
 102 #endif
 103 #ifdef HAVE_PROCESS_H
 104 #  include <process.h>          /* getpid on win32 */
 105 #endif
 106 #include <string.h>             /* G_VA_COPY */
 107 #ifdef G_OS_WIN32
 108 #  define WIN32_LEAN_AND_MEAN   /* prevents from including too many things */
 109 #  include <windows.h>          /* GetStdHandle, windows console */
 110 #endif
 111
 112 #include "gst_private.h"
 113 #include "gstutils.h"
 114 #include "gstquark.h"
 115 #include "gstsegment.h"
 116 #include "gstvalue.h"
 117 #include "gstcapsfeatures.h"
 118
 119 #ifdef HAVE_VALGRIND_VALGRIND_H
 120 #  include <valgrind/valgrind.h>
 121 #endif
 122 #include <glib/gprintf.h>       /* g_sprintf */
 123
 124 /* our own printf implementation with custom extensions to %p for caps etc. */
 125 #include "printf/printf.h"
 126 #include "printf/printf-extension.h"
 127
 128 static char *gst_info_printf_pointer_extension_func (const char *format,
 129     void *ptr);
 130 #else /* GST_DISABLE_GST_DEBUG */
 131
 132 #include <glib/gprintf.h>
 133 #endif /* !GST_DISABLE_GST_DEBUG */
 134
 135 #ifdef HAVE_UNWIND
 136 /* No need for remote debugging so turn on the 'local only' optimizations in
 137  * libunwind */
 138 #define UNW_LOCAL_ONLY
 139
 140 #include <libunwind.h>
 141 #include <stdio.h>
 142 #include <stdlib.h>
 143 #include <string.h>
 144 #include <stdarg.h>
 145 #include <unistd.h>
 146 #include <errno.h>
 147
 148 #ifdef HAVE_DW
 149 #include <elfutils/libdwfl.h>
 150 #endif /* HAVE_DW */
 151 #endif /* HAVE_UNWIND */
 152
 153 #ifdef HAVE_BACKTRACE
 154 #include <execinfo.h>
 155 #define BT_BUF_SIZE 100
 156 #endif /* HAVE_BACKTRACE */
 157
 158 extern gboolean gst_is_initialized (void);
 159
 160 /* we want these symbols exported even if debug is disabled, to maintain
 161  * ABI compatibility. Unless GST_REMOVE_DISABLED is defined. */
 162 #if !defined(GST_DISABLE_GST_DEBUG) || !defined(GST_REMOVE_DISABLED)
 163
 164 /* disabled by default, as soon as some threshold is set > NONE,
 165  * it becomes enabled. */
 166 gboolean _gst_debug_enabled = FALSE;
 167 GstDebugLevel _gst_debug_min = GST_LEVEL_NONE;
 168
 169 GstDebugCategory *GST_CAT_DEFAULT = NULL;
 170
 171 GstDebugCategory *GST_CAT_GST_INIT = NULL;
 172 GstDebugCategory *GST_CAT_MEMORY = NULL;
 173 GstDebugCategory *GST_CAT_PARENTAGE = NULL;
 174 GstDebugCategory *GST_CAT_STATES = NULL;
 175 GstDebugCategory *GST_CAT_SCHEDULING = NULL;
 176
 177 GstDebugCategory *GST_CAT_BUFFER = NULL;
 178 GstDebugCategory *GST_CAT_BUFFER_LIST = NULL;
 179 GstDebugCategory *GST_CAT_BUS = NULL;
 180 GstDebugCategory *GST_CAT_CAPS = NULL;
 181 GstDebugCategory *GST_CAT_CLOCK = NULL;
 182 GstDebugCategory *GST_CAT_ELEMENT_PADS = NULL;
 183 GstDebugCategory *GST_CAT_PADS = NULL;
 184 GstDebugCategory *GST_CAT_PERFORMANCE = NULL;
 185 GstDebugCategory *GST_CAT_PIPELINE = NULL;
 186 GstDebugCategory *GST_CAT_PLUGIN_LOADING = NULL;
 187 GstDebugCategory *GST_CAT_PLUGIN_INFO = NULL;
 188 GstDebugCategory *GST_CAT_PROPERTIES = NULL;
 189 GstDebugCategory *GST_CAT_NEGOTIATION = NULL;
 190 GstDebugCategory *GST_CAT_REFCOUNTING = NULL;
 191 GstDebugCategory *GST_CAT_ERROR_SYSTEM = NULL;
 192 GstDebugCategory *GST_CAT_EVENT = NULL;
 193 GstDebugCategory *GST_CAT_MESSAGE = NULL;
 194 GstDebugCategory *GST_CAT_PARAMS = NULL;
 195 GstDebugCategory *GST_CAT_CALL_TRACE = NULL;
 196 GstDebugCategory *GST_CAT_SIGNAL = NULL;
 197 GstDebugCategory *GST_CAT_PROBE = NULL;
 198 GstDebugCategory *GST_CAT_REGISTRY = NULL;
 199 GstDebugCategory *GST_CAT_QOS = NULL;
 200 GstDebugCategory *_priv_GST_CAT_POLL = NULL;
 201 GstDebugCategory *GST_CAT_META = NULL;
 202 GstDebugCategory *GST_CAT_LOCKING = NULL;
 203 GstDebugCategory *GST_CAT_CONTEXT = NULL;
 204 GstDebugCategory *_priv_GST_CAT_PROTECTION = NULL;
 205
 206
 207 #endif /* !defined(GST_DISABLE_GST_DEBUG) || !defined(GST_REMOVE_DISABLED) */
 208
 209 #ifndef GST_DISABLE_GST_DEBUG
 210
 211 /* underscore is to prevent conflict with GST_CAT_DEBUG define */
 212 GST_DEBUG_CATEGORY_STATIC (_GST_CAT_DEBUG);
 213
 214 #if 0
 215 #if defined __sgi__
 216 #include <rld_interface.h>
 217 typedef struct DL_INFO
 218 {
 219   const char *dli_fname;
 220   void *dli_fbase;
 221   const char *dli_sname;
 222   void *dli_saddr;
 223   int dli_version;
 224   int dli_reserved1;
 225   long dli_reserved[4];
 226 }
 227 Dl_info;
 228
 229 #define _RLD_DLADDR             14
 230 int dladdr (void *address, Dl_info * dl);
 231
 232 int
 233 dladdr (void *address, Dl_info * dl)
 234 {
 235   void *v;
 236
 237   v = _rld_new_interface (_RLD_DLADDR, address, dl);
 238   return (int) v;
 239 }
 240 #endif /* __sgi__ */
 241 #endif
 242
 243 static void gst_debug_reset_threshold (gpointer category, gpointer unused);
 244 static void gst_debug_reset_all_thresholds (void);
 245
 246 struct _GstDebugMessage
 247 {
 248   gchar *message;
 249   const gchar *format;
 250   va_list arguments;
 251 };
 252
 253 /* list of all name/level pairs from --gst-debug and GST_DEBUG */
 254 static GMutex __level_name_mutex;
 255 static GSList *__level_name = NULL;
 256 typedef struct
 257 {
 258   GPatternSpec *pat;
 259   GstDebugLevel level;
 260 }
 261 LevelNameEntry;
 262
 263 /* list of all categories */
 264 static GMutex __cat_mutex;
 265 static GSList *__categories = NULL;
 266
 267 static GstDebugCategory *_gst_debug_get_category_locked (const gchar * name);
 268
 269
 270 /* all registered debug handlers */
 271 typedef struct
 272 {
 273   GstLogFunction func;
 274   gpointer user_data;
 275   GDestroyNotify notify;
 276 }
 277 LogFuncEntry;
 278 static GMutex __log_func_mutex;
 279 static GSList *__log_functions = NULL;
 280
 281 /* whether to add the default log function in gst_init() */
 282 static gboolean add_default_log_func = TRUE;
 283
 284 #define PRETTY_TAGS_DEFAULT  TRUE
 285 static gboolean pretty_tags = PRETTY_TAGS_DEFAULT;
 286
 287 static volatile gint G_GNUC_MAY_ALIAS __default_level = GST_LEVEL_DEFAULT;
 288 static volatile gint G_GNUC_MAY_ALIAS __use_color = GST_DEBUG_COLOR_MODE_ON;
 289
 290 /* FIXME: export this? */
 291 gboolean
 292 _priv_gst_in_valgrind (void)
 293 {
 294   static enum
 295   {
 296     GST_VG_UNCHECKED,
 297     GST_VG_NO_VALGRIND,
 298     GST_VG_INSIDE
 299   }
 300   in_valgrind = GST_VG_UNCHECKED;
 301
 302   if (in_valgrind == GST_VG_UNCHECKED) {
 303 #ifdef HAVE_VALGRIND_VALGRIND_H
 304     if (RUNNING_ON_VALGRIND) {
 305       GST_CAT_INFO (GST_CAT_GST_INIT, "we're running inside valgrind");
 306       in_valgrind = GST_VG_INSIDE;
 307     } else {
 308       GST_CAT_LOG (GST_CAT_GST_INIT, "not doing extra valgrind stuff");
 309       in_valgrind = GST_VG_NO_VALGRIND;
 310     }
 311 #else
 312     in_valgrind = GST_VG_NO_VALGRIND;
 313 #endif
 314     g_assert (in_valgrind == GST_VG_NO_VALGRIND ||
 315         in_valgrind == GST_VG_INSIDE);
 316   }
 317   return (in_valgrind == GST_VG_INSIDE);
 318 }
 319
 320 static gchar *
 321 _replace_pattern_in_gst_debug_file_name (gchar * name, const char *token,
 322     guint val)
 323 {
 324   gchar *token_start;
 325   if ((token_start = strstr (name, token))) {
 326     gsize token_len = strlen (token);
 327     gchar *name_prefix = name;
 328     gchar *name_suffix = token_start + token_len;
 329     token_start[0] = '\0';
 330     name = g_strdup_printf ("%s%u%s", name_prefix, val, name_suffix);
 331     g_free (name_prefix);
 332   }
 333   return name;
 334 }
 335
 336 static gchar *
 337 _priv_gst_debug_file_name (const gchar * env)
 338 {
 339   gchar *name;
 340
 341   name = g_strdup (env);
 342   name = _replace_pattern_in_gst_debug_file_name (name, "%p", getpid ());
 343   name = _replace_pattern_in_gst_debug_file_name (name, "%r", g_random_int ());
 344
 345   return name;
 346 }
 347
 348 /* Initialize the debugging system */
 349 void
 350 _priv_gst_debug_init (void)
 351 {
 352   const gchar *env;
 353   FILE *log_file;
 354
 355   if (add_default_log_func) {
 356     env = g_getenv ("GST_DEBUG_FILE");
 357     if (env != NULL && *env != '\0') {
 358       if (strcmp (env, "-") == 0) {
 359         log_file = stdout;
 360       } else {
 361         gchar *name = _priv_gst_debug_file_name (env);
 362         log_file = g_fopen (name, "w");
 363         g_free (name);
 364         if (log_file == NULL) {
 365           g_printerr ("Could not open log file '%s' for writing: %s\n", env,
 366               g_strerror (errno));
 367           log_file = stderr;
 368         }
 369       }
 370     } else {
 371       log_file = stderr;
 372     }
 373
 374     gst_debug_add_log_function (gst_debug_log_default, log_file, NULL);
 375   }
 376
 377   __gst_printf_pointer_extension_set_func
 378       (gst_info_printf_pointer_extension_func);
 379
 380   /* do NOT use a single debug function before this line has been run */
 381   GST_CAT_DEFAULT = _gst_debug_category_new ("default",
 382       GST_DEBUG_UNDERLINE, NULL);
 383   _GST_CAT_DEBUG = _gst_debug_category_new ("GST_DEBUG",
 384       GST_DEBUG_BOLD | GST_DEBUG_FG_YELLOW, "debugging subsystem");
 385
 386   /* FIXME: add descriptions here */
 387   GST_CAT_GST_INIT = _gst_debug_category_new ("GST_INIT",
 388       GST_DEBUG_BOLD | GST_DEBUG_FG_RED, NULL);
 389   GST_CAT_MEMORY = _gst_debug_category_new ("GST_MEMORY",
 390       GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, "memory");
 391   GST_CAT_PARENTAGE = _gst_debug_category_new ("GST_PARENTAGE",
 392       GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
 393   GST_CAT_STATES = _gst_debug_category_new ("GST_STATES",
 394       GST_DEBUG_BOLD | GST_DEBUG_FG_RED, NULL);
 395   GST_CAT_SCHEDULING = _gst_debug_category_new ("GST_SCHEDULING",
 396       GST_DEBUG_BOLD | GST_DEBUG_FG_MAGENTA, NULL);
 397   GST_CAT_BUFFER = _gst_debug_category_new ("GST_BUFFER",
 398       GST_DEBUG_BOLD | GST_DEBUG_BG_GREEN, NULL);
 399   GST_CAT_BUFFER_LIST = _gst_debug_category_new ("GST_BUFFER_LIST",
 400       GST_DEBUG_BOLD | GST_DEBUG_BG_GREEN, NULL);
 401   GST_CAT_BUS = _gst_debug_category_new ("GST_BUS", GST_DEBUG_BG_YELLOW, NULL);
 402   GST_CAT_CAPS = _gst_debug_category_new ("GST_CAPS",
 403       GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
 404   GST_CAT_CLOCK = _gst_debug_category_new ("GST_CLOCK",
 405       GST_DEBUG_BOLD | GST_DEBUG_FG_YELLOW, NULL);
 406   GST_CAT_ELEMENT_PADS = _gst_debug_category_new ("GST_ELEMENT_PADS",
 407       GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
 408   GST_CAT_PADS = _gst_debug_category_new ("GST_PADS",
 409       GST_DEBUG_BOLD | GST_DEBUG_FG_RED | GST_DEBUG_BG_RED, NULL);
 410   GST_CAT_PERFORMANCE = _gst_debug_category_new ("GST_PERFORMANCE",
 411       GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
 412   GST_CAT_PIPELINE = _gst_debug_category_new ("GST_PIPELINE",
 413       GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
 414   GST_CAT_PLUGIN_LOADING = _gst_debug_category_new ("GST_PLUGIN_LOADING",
 415       GST_DEBUG_BOLD | GST_DEBUG_FG_CYAN, NULL);
 416   GST_CAT_PLUGIN_INFO = _gst_debug_category_new ("GST_PLUGIN_INFO",
 417       GST_DEBUG_BOLD | GST_DEBUG_FG_CYAN, NULL);
 418   GST_CAT_PROPERTIES = _gst_debug_category_new ("GST_PROPERTIES",
 419       GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_BLUE, NULL);
 420   GST_CAT_NEGOTIATION = _gst_debug_category_new ("GST_NEGOTIATION",
 421       GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
 422   GST_CAT_REFCOUNTING = _gst_debug_category_new ("GST_REFCOUNTING",
 423       GST_DEBUG_BOLD | GST_DEBUG_FG_RED | GST_DEBUG_BG_BLUE, NULL);
 424   GST_CAT_ERROR_SYSTEM = _gst_debug_category_new ("GST_ERROR_SYSTEM",
 425       GST_DEBUG_BOLD | GST_DEBUG_FG_RED | GST_DEBUG_BG_WHITE, NULL);
 426
 427   GST_CAT_EVENT = _gst_debug_category_new ("GST_EVENT",
 428       GST_DEBUG_BOLD | GST_DEBUG_FG_BLUE, NULL);
 429   GST_CAT_MESSAGE = _gst_debug_category_new ("GST_MESSAGE",
 430       GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
 431   GST_CAT_PARAMS = _gst_debug_category_new ("GST_PARAMS",
 432       GST_DEBUG_BOLD | GST_DEBUG_FG_BLACK | GST_DEBUG_BG_YELLOW, NULL);
 433   GST_CAT_CALL_TRACE = _gst_debug_category_new ("GST_CALL_TRACE",
 434       GST_DEBUG_BOLD, NULL);
 435   GST_CAT_SIGNAL = _gst_debug_category_new ("GST_SIGNAL",
 436       GST_DEBUG_BOLD | GST_DEBUG_FG_WHITE | GST_DEBUG_BG_RED, NULL);
 437   GST_CAT_PROBE = _gst_debug_category_new ("GST_PROBE",
 438       GST_DEBUG_BOLD | GST_DEBUG_FG_GREEN, "pad probes");
 439   GST_CAT_REGISTRY = _gst_debug_category_new ("GST_REGISTRY", 0, "registry");
 440   GST_CAT_QOS = _gst_debug_category_new ("GST_QOS", 0, "QoS");
 441   _priv_GST_CAT_POLL = _gst_debug_category_new ("GST_POLL", 0, "poll");
 442   GST_CAT_META = _gst_debug_category_new ("GST_META", 0, "meta");
 443   GST_CAT_LOCKING = _gst_debug_category_new ("GST_LOCKING", 0, "locking");
 444   GST_CAT_CONTEXT = _gst_debug_category_new ("GST_CONTEXT", 0, NULL);
 445   _priv_GST_CAT_PROTECTION =
 446       _gst_debug_category_new ("GST_PROTECTION", 0, "protection");
 447
 448   /* print out the valgrind message if we're in valgrind */
 449   _priv_gst_in_valgrind ();
 450
 451   env = g_getenv ("GST_DEBUG_OPTIONS");
 452   if (env != NULL) {
 453     if (strstr (env, "full_tags") || strstr (env, "full-tags"))
 454       pretty_tags = FALSE;
 455     else if (strstr (env, "pretty_tags") || strstr (env, "pretty-tags"))
 456       pretty_tags = TRUE;
 457   }
 458
 459   if (g_getenv ("GST_DEBUG_NO_COLOR") != NULL)
 460     gst_debug_set_color_mode (GST_DEBUG_COLOR_MODE_OFF);
 461   env = g_getenv ("GST_DEBUG_COLOR_MODE");
 462   if (env)
 463     gst_debug_set_color_mode_from_string (env);
 464
 465   env = g_getenv ("GST_DEBUG");
 466   if (env)
 467     gst_debug_set_threshold_from_string (env, FALSE);
 468 }
 469
 470 /* we can't do this further above, because we initialize the GST_CAT_DEFAULT struct */
 471 #define GST_CAT_DEFAULT _GST_CAT_DEBUG
 472
 473 /**
 474  * gst_debug_log:
 475  * @category: category to log
 476  * @level: level of the message is in
 477  * @file: the file that emitted the message, usually the __FILE__ identifier
 478  * @function: the function that emitted the message
 479  * @line: the line from that the message was emitted, usually __LINE__
 480  * @object: (transfer none) (allow-none): the object this message relates to,
 481  *     or %NULL if none
 482  * @format: a printf style format string
 483  * @...: optional arguments for the format
 484  *
 485  * Logs the given message using the currently registered debugging handlers.
 486  */
 487 void
 488 gst_debug_log (GstDebugCategory * category, GstDebugLevel level,
 489     const gchar * file, const gchar * function, gint line,
 490     GObject * object, const gchar * format, ...)
 491 {
 492   va_list var_args;
 493
 494   va_start (var_args, format);
 495   gst_debug_log_valist (category, level, file, function, line, object, format,
 496       var_args);
 497   va_end (var_args);
 498 }
 499
 500 /* based on g_basename(), which we can't use because it was deprecated */
 501 static inline const gchar *
 502 gst_path_basename (const gchar * file_name)
 503 {
 504   register const gchar *base;
 505
 506   base = strrchr (file_name, G_DIR_SEPARATOR);
 507
 508   {
 509     const gchar *q = strrchr (file_name, '/');
 510     if (base == NULL || (q != NULL && q > base))
 511       base = q;
 512   }
 513
 514   if (base)
 515     return base + 1;
 516
 517   if (g_ascii_isalpha (file_name[0]) && file_name[1] == ':')
 518     return file_name + 2;
 519
 520   return file_name;
 521 }
 522
 523 /**
 524  * gst_debug_log_valist:
 525  * @category: category to log
 526  * @level: level of the message is in
 527  * @file: the file that emitted the message, usually the __FILE__ identifier
 528  * @function: the function that emitted the message
 529  * @line: the line from that the message was emitted, usually __LINE__
 530  * @object: (transfer none) (allow-none): the object this message relates to,
 531  *     or %NULL if none
 532  * @format: a printf style format string
 533  * @args: optional arguments for the format
 534  *
 535  * Logs the given message using the currently registered debugging handlers.
 536  */
 537 void
 538 gst_debug_log_valist (GstDebugCategory * category, GstDebugLevel level,
 539     const gchar * file, const gchar * function, gint line,
 540     GObject * object, const gchar * format, va_list args)
 541 {
 542   GstDebugMessage message;
 543   LogFuncEntry *entry;
 544   GSList *handler;
 545
 546   g_return_if_fail (category != NULL);
 547
 548   if (level > gst_debug_category_get_threshold (category))
 549     return;
 550
 551   g_return_if_fail (file != NULL);
 552   g_return_if_fail (function != NULL);
 553   g_return_if_fail (format != NULL);
 554
 555   message.message = NULL;
 556   message.format = format;
 557   G_VA_COPY (message.arguments, args);
 558
 559   handler = __log_functions;
 560   while (handler) {
 561     entry = handler->data;
 562     handler = g_slist_next (handler);
 563     entry->func (category, level, file, function, line, object, &message,
 564         entry->user_data);
 565   }
 566   g_free (message.message);
 567   va_end (message.arguments);
 568 }
 569
 570 /**
 571  * gst_debug_message_get:
 572  * @message: a debug message
 573  *
 574  * Gets the string representation of a #GstDebugMessage. This function is used
 575  * in debug handlers to extract the message.
 576  *
 577  * Returns: (nullable): the string representation of a #GstDebugMessage.
 578  */
 579 const gchar *
 580 gst_debug_message_get (GstDebugMessage * message)
 581 {
 582   if (message->message == NULL) {
 583     int len;
 584
 585     len = __gst_vasprintf (&message->message, message->format,
 586         message->arguments);
 587
 588     if (len < 0)
 589       message->message = NULL;
 590   }
 591   return message->message;
 592 }
 593
 594 #define MAX_BUFFER_DUMP_STRING_LEN  100
 595
 596 /* structure_to_pretty_string:
 597  * @str: a serialized #GstStructure
 598  *
 599  * If the serialized structure contains large buffers such as images the hex
 600  * representation of those buffers will be shortened so that the string remains
 601  * readable.
 602  *
 603  * Returns: the filtered string
 604  */
 605 static gchar *
 606 prettify_structure_string (gchar * str)
 607 {
 608   gchar *pos = str, *end;
 609
 610   while ((pos = strstr (pos, "(buffer)"))) {
 611     guint count = 0;
 612
 613     pos += strlen ("(buffer)");
 614     for (end = pos; *end != '\0' && *end != ';' && *end != ' '; ++end)
 615       ++count;
 616     if (count > MAX_BUFFER_DUMP_STRING_LEN) {
 617       memcpy (pos + MAX_BUFFER_DUMP_STRING_LEN - 6, "..", 2);
 618       memcpy (pos + MAX_BUFFER_DUMP_STRING_LEN - 4, pos + count - 4, 4);
 619       memmove (pos + MAX_BUFFER_DUMP_STRING_LEN, pos + count,
 620           strlen (pos + count) + 1);
 621       pos += MAX_BUFFER_DUMP_STRING_LEN;
 622     }
 623   }
 624
 625   return str;
 626 }
 627
 628 static inline gchar *
 629 gst_info_structure_to_string (const GstStructure * s)
 630 {
 631   if (G_LIKELY (s)) {
 632     gchar *str = gst_structure_to_string (s);
 633     if (G_UNLIKELY (pretty_tags && s->name == GST_QUARK (TAGLIST)))
 634       return prettify_structure_string (str);
 635     else
 636       return str;
 637   }
 638   return NULL;
 639 }
 640
 641 static inline gchar *
 642 gst_info_describe_buffer (GstBuffer * buffer)
 643 {
 644   const gchar *offset_str = "none";
 645   const gchar *offset_end_str = "none";
 646   gchar offset_buf[32], offset_end_buf[32];
 647
 648   if (GST_BUFFER_OFFSET_IS_VALID (buffer)) {
 649     g_snprintf (offset_buf, sizeof (offset_buf), "%" G_GUINT64_FORMAT,
 650         GST_BUFFER_OFFSET (buffer));
 651     offset_str = offset_buf;
 652   }
 653   if (GST_BUFFER_OFFSET_END_IS_VALID (buffer)) {
 654     g_snprintf (offset_end_buf, sizeof (offset_end_buf), "%" G_GUINT64_FORMAT,
 655         GST_BUFFER_OFFSET_END (buffer));
 656     offset_end_str = offset_end_buf;
 657   }
 658
 659   return g_strdup_printf ("buffer: %p, pts %" GST_TIME_FORMAT ", dts %"
 660       GST_TIME_FORMAT ", dur %" GST_TIME_FORMAT ", size %" G_GSIZE_FORMAT
 661       ", offset %s, offset_end %s, flags 0x%x", buffer,
 662       GST_TIME_ARGS (GST_BUFFER_PTS (buffer)),
 663       GST_TIME_ARGS (GST_BUFFER_DTS (buffer)),
 664       GST_TIME_ARGS (GST_BUFFER_DURATION (buffer)),
 665       gst_buffer_get_size (buffer), offset_str, offset_end_str,
 666       GST_BUFFER_FLAGS (buffer));
 667 }
 668
 669 static inline gchar *
 670 gst_info_describe_buffer_list (GstBufferList * list)
 671 {
 672   GstClockTime pts = GST_CLOCK_TIME_NONE;
 673   GstClockTime dts = GST_CLOCK_TIME_NONE;
 674   gsize total_size = 0;
 675   guint n, i;
 676
 677   n = gst_buffer_list_length (list);
 678   for (i = 0; i < n; ++i) {
 679     GstBuffer *buf = gst_buffer_list_get (list, i);
 680
 681     if (i == 0) {
 682       pts = GST_BUFFER_PTS (buf);
 683       dts = GST_BUFFER_DTS (buf);
 684     }
 685
 686     total_size += gst_buffer_get_size (buf);
 687   }
 688
 689   return g_strdup_printf ("bufferlist: %p, %u buffers, pts %" GST_TIME_FORMAT
 690       ", dts %" GST_TIME_FORMAT ", size %" G_GSIZE_FORMAT, list, n,
 691       GST_TIME_ARGS (pts), GST_TIME_ARGS (dts), total_size);
 692 }
 693
 694 static inline gchar *
 695 gst_info_describe_event (GstEvent * event)
 696 {
 697   gchar *s, *ret;
 698
 699   s = gst_info_structure_to_string (gst_event_get_structure (event));
 700   ret = g_strdup_printf ("%s event: %p, time %" GST_TIME_FORMAT
 701       ", seq-num %d, %s", GST_EVENT_TYPE_NAME (event), event,
 702       GST_TIME_ARGS (GST_EVENT_TIMESTAMP (event)), GST_EVENT_SEQNUM (event),
 703       (s ? s : "(NULL)"));
 704   g_free (s);
 705   return ret;
 706 }
 707
 708 static inline gchar *
 709 gst_info_describe_message (GstMessage * message)
 710 {
 711   gchar *s, *ret;
 712
 713   s = gst_info_structure_to_string (gst_message_get_structure (message));
 714   ret = g_strdup_printf ("%s message: %p, time %" GST_TIME_FORMAT
 715       ", seq-num %d, element '%s', %s", GST_MESSAGE_TYPE_NAME (message),
 716       message, GST_TIME_ARGS (GST_MESSAGE_TIMESTAMP (message)),
 717       GST_MESSAGE_SEQNUM (message),
 718       ((message->src) ? GST_ELEMENT_NAME (message->src) : "(NULL)"),
 719       (s ? s : "(NULL)"));
 720   g_free (s);
 721   return ret;
 722 }
 723
 724 static inline gchar *
 725 gst_info_describe_query (GstQuery * query)
 726 {
 727   gchar *s, *ret;
 728
 729   s = gst_info_structure_to_string (gst_query_get_structure (query));
 730   ret = g_strdup_printf ("%s query: %p, %s", GST_QUERY_TYPE_NAME (query),
 731       query, (s ? s : "(NULL)"));
 732   g_free (s);
 733   return ret;
 734 }
 735
 736 static inline gchar *
 737 gst_info_describe_stream (GstStream * stream)
 738 {
 739   gchar *ret, *caps_str = NULL, *tags_str = NULL;
 740   GstCaps *caps;
 741   GstTagList *tags;
 742
 743   caps = gst_stream_get_caps (stream);
 744   if (caps) {
 745     caps_str = gst_caps_to_string (caps);
 746     gst_caps_unref (caps);
 747   }
 748
 749   tags = gst_stream_get_tags (stream);
 750   if (tags) {
 751     tags_str = gst_tag_list_to_string (tags);
 752     gst_tag_list_unref (tags);
 753   }
 754
 755   ret =
 756       g_strdup_printf ("stream %s %p, ID %s, flags 0x%x, caps [%s], tags [%s]",
 757       gst_stream_type_get_name (gst_stream_get_stream_type (stream)), stream,
 758       gst_stream_get_stream_id (stream), gst_stream_get_stream_flags (stream),
 759       caps_str ? caps_str : "", tags_str ? tags_str : "");
 760
 761   g_free (caps_str);
 762   g_free (tags_str);
 763
 764   return ret;
 765 }
 766
 767 static inline gchar *
 768 gst_info_describe_stream_collection (GstStreamCollection * collection)
 769 {
 770   gchar *ret;
 771   GString *streams_str;
 772   guint i;
 773
 774   streams_str = g_string_new ("<");
 775   for (i = 0; i < gst_stream_collection_get_size (collection); i++) {
 776     GstStream *stream = gst_stream_collection_get_stream (collection, i);
 777     gchar *s;
 778
 779     s = gst_info_describe_stream (stream);
 780     g_string_append_printf (streams_str, " %s,", s);
 781     g_free (s);
 782   }
 783   g_string_append (streams_str, " >");
 784
 785   ret = g_strdup_printf ("collection %p (%d streams) %s", collection,
 786       gst_stream_collection_get_size (collection), streams_str->str);
 787
 788   g_string_free (streams_str, TRUE);
 789   return ret;
 790 }
 791
 792 static gchar *
 793 gst_debug_print_object (gpointer ptr)
 794 {
 795   GObject *object = (GObject *) ptr;
 796
 797 #ifdef unused
 798   /* This is a cute trick to detect unmapped memory, but is unportable,
 799    * slow, screws around with madvise, and not actually that useful. */
 800   {
 801     int ret;
 802
 803     ret = madvise ((void *) ((unsigned long) ptr & (~0xfff)), 4096, 0);
 804     if (ret == -1 && errno == ENOMEM) {
 805       buffer = g_strdup_printf ("%p (unmapped memory)", ptr);
 806     }
 807   }
 808 #endif
 809
 810   /* nicely printed object */
 811   if (object == NULL) {
 812     return g_strdup ("(NULL)");
 813   }
 814   if (GST_IS_CAPS (ptr)) {
 815     return gst_caps_to_string ((const GstCaps *) ptr);
 816   }
 817   if (GST_IS_STRUCTURE (ptr)) {
 818     return gst_info_structure_to_string ((const GstStructure *) ptr);
 819   }
 820   if (*(GType *) ptr == GST_TYPE_CAPS_FEATURES) {
 821     return gst_caps_features_to_string ((const GstCapsFeatures *) ptr);
 822   }
 823   if (GST_IS_TAG_LIST (ptr)) {
 824     gchar *str = gst_tag_list_to_string ((GstTagList *) ptr);
 825     if (G_UNLIKELY (pretty_tags))
 826       return prettify_structure_string (str);
 827     else
 828       return str;
 829   }
 830   if (*(GType *) ptr == GST_TYPE_DATE_TIME) {
 831     return __gst_date_time_serialize ((GstDateTime *) ptr, TRUE);
 832   }
 833   if (GST_IS_BUFFER (ptr)) {
 834     return gst_info_describe_buffer (GST_BUFFER_CAST (ptr));
 835   }
 836   if (GST_IS_BUFFER_LIST (ptr)) {
 837     return gst_info_describe_buffer_list (GST_BUFFER_LIST_CAST (ptr));
 838   }
 839 #ifdef USE_POISONING
 840   if (*(guint32 *) ptr == 0xffffffff) {
 841     return g_strdup_printf ("<poisoned@%p>", ptr);
 842   }
 843 #endif
 844   if (GST_IS_MESSAGE (object)) {
 845     return gst_info_describe_message (GST_MESSAGE_CAST (object));
 846   }
 847   if (GST_IS_QUERY (object)) {
 848     return gst_info_describe_query (GST_QUERY_CAST (object));
 849   }
 850   if (GST_IS_EVENT (object)) {
 851     return gst_info_describe_event (GST_EVENT_CAST (object));
 852   }
 853   if (GST_IS_CONTEXT (object)) {
 854     GstContext *context = GST_CONTEXT_CAST (object);
 855     gchar *s, *ret;
 856     const gchar *type;
 857     const GstStructure *structure;
 858
 859     type = gst_context_get_context_type (context);
 860     structure = gst_context_get_structure (context);
 861
 862     s = gst_info_structure_to_string (structure);
 863
 864     ret = g_strdup_printf ("context '%s'='%s'", type, s);
 865     g_free (s);
 866     return ret;
 867   }
 868   if (GST_IS_STREAM (object)) {
 869     return gst_info_describe_stream (GST_STREAM_CAST (object));
 870   }
 871   if (GST_IS_STREAM_COLLECTION (object)) {
 872     return
 873         gst_info_describe_stream_collection (GST_STREAM_COLLECTION_CAST
 874         (object));
 875   }
 876   if (GST_IS_PAD (object) && GST_OBJECT_NAME (object)) {
 877     return g_strdup_printf ("<%s:%s>", GST_DEBUG_PAD_NAME (object));
 878   }
 879   if (GST_IS_OBJECT (object) && GST_OBJECT_NAME (object)) {
 880     return g_strdup_printf ("<%s>", GST_OBJECT_NAME (object));
 881   }
 882   if (G_IS_OBJECT (object)) {
 883     return g_strdup_printf ("<%s@%p>", G_OBJECT_TYPE_NAME (object), object);
 884   }
 885
 886   return g_strdup_printf ("%p", ptr);
 887 }
 888
 889 static gchar *
 890 gst_debug_print_segment (gpointer ptr)
 891 {
 892   GstSegment *segment = (GstSegment *) ptr;
 893
 894   /* nicely printed segment */
 895   if (segment == NULL) {
 896     return g_strdup ("(NULL)");
 897   }
 898
 899   switch (segment->format) {
 900     case GST_FORMAT_UNDEFINED:{
 901       return g_strdup_printf ("UNDEFINED segment");
 902     }
 903     case GST_FORMAT_TIME:{
 904       return g_strdup_printf ("time segment start=%" GST_TIME_FORMAT
 905           ", offset=%" GST_TIME_FORMAT ", stop=%" GST_TIME_FORMAT
 906           ", rate=%f, applied_rate=%f" ", flags=0x%02x, time=%" GST_TIME_FORMAT
 907           ", base=%" GST_TIME_FORMAT ", position %" GST_TIME_FORMAT
 908           ", duration %" GST_TIME_FORMAT, GST_TIME_ARGS (segment->start),
 909           GST_TIME_ARGS (segment->offset), GST_TIME_ARGS (segment->stop),
 910           segment->rate, segment->applied_rate, (guint) segment->flags,
 911           GST_TIME_ARGS (segment->time), GST_TIME_ARGS (segment->base),
 912           GST_TIME_ARGS (segment->position), GST_TIME_ARGS (segment->duration));
 913     }
 914     default:{
 915       const gchar *format_name;
 916
 917       format_name = gst_format_get_name (segment->format);
 918       if (G_UNLIKELY (format_name == NULL))
 919         format_name = "(UNKNOWN FORMAT)";
 920       return g_strdup_printf ("%s segment start=%" G_GINT64_FORMAT
 921           ", offset=%" G_GINT64_FORMAT ", stop=%" G_GINT64_FORMAT
 922           ", rate=%f, applied_rate=%f" ", flags=0x%02x, time=%" G_GINT64_FORMAT
 923           ", base=%" G_GINT64_FORMAT ", position %" G_GINT64_FORMAT
 924           ", duration %" G_GINT64_FORMAT, format_name, segment->start,
 925           segment->offset, segment->stop, segment->rate, segment->applied_rate,
 926           (guint) segment->flags, segment->time, segment->base,
 927           segment->position, segment->duration);
 928     }
 929   }
 930 }
 931
 932 static char *
 933 gst_info_printf_pointer_extension_func (const char *format, void *ptr)
 934 {
 935   char *s = NULL;
 936
 937   if (format[0] == 'p' && format[1] == '\a') {
 938     switch (format[2]) {
 939       case 'A':                /* GST_PTR_FORMAT     */
 940         s = gst_debug_print_object (ptr);
 941         break;
 942       case 'B':                /* GST_SEGMENT_FORMAT */
 943         s = gst_debug_print_segment (ptr);
 944         break;
 945       case 'a':                /* GST_WRAPPED_PTR_FORMAT */
 946         s = priv_gst_string_take_and_wrap (gst_debug_print_object (ptr));
 947         break;
 948       default:
 949         /* must have been compiled against a newer version with an extension
 950          * we don't known about yet - just ignore and fallback to %p below */
 951         break;
 952     }
 953   }
 954   if (s == NULL)
 955     s = g_strdup_printf ("%p", ptr);
 956
 957   return s;
 958 }
 959
 960 /**
 961  * gst_debug_construct_term_color:
 962  * @colorinfo: the color info
 963  *
 964  * Constructs a string that can be used for getting the desired color in color
 965  * terminals.
 966  * You need to free the string after use.
 967  *
 968  * Returns: (transfer full) (type gchar*): a string containing the color
 969  *     definition
 970  */
 971 gchar *
 972 gst_debug_construct_term_color (guint colorinfo)
 973 {
 974   GString *color;
 975
 976   color = g_string_new ("\033[00");
 977
 978   if (colorinfo & GST_DEBUG_BOLD) {
 979     g_string_append_len (color, ";01", 3);
 980   }
 981   if (colorinfo & GST_DEBUG_UNDERLINE) {
 982     g_string_append_len (color, ";04", 3);
 983   }
 984   if (colorinfo & GST_DEBUG_FG_MASK) {
 985     g_string_append_printf (color, ";3%1d", colorinfo & GST_DEBUG_FG_MASK);
 986   }
 987   if (colorinfo & GST_DEBUG_BG_MASK) {
 988     g_string_append_printf (color, ";4%1d",
 989         (colorinfo & GST_DEBUG_BG_MASK) >> 4);
 990   }
 991   g_string_append_c (color, 'm');
 992
 993   return g_string_free (color, FALSE);
 994 }
 995
 996 /**
 997  * gst_debug_construct_win_color:
 998  * @colorinfo: the color info
 999  *
1000  * Constructs an integer that can be used for getting the desired color in
1001  * windows' terminals (cmd.exe). As there is no mean to underline, we simply
1002  * ignore this attribute.
1003  *
1004  * This function returns 0 on non-windows machines.
1005  *
1006  * Returns: an integer containing the color definition
1007  */
1008 gint
1009 gst_debug_construct_win_color (guint colorinfo)
1010 {
1011   gint color = 0;
1012 #ifdef G_OS_WIN32
1013   static const guchar ansi_to_win_fg[8] = {
1014     0,                          /* black   */
1015     FOREGROUND_RED,             /* red     */
1016     FOREGROUND_GREEN,           /* green   */
1017     FOREGROUND_RED | FOREGROUND_GREEN,  /* yellow  */
1018     FOREGROUND_BLUE,            /* blue    */
1019     FOREGROUND_RED | FOREGROUND_BLUE,   /* magenta */
1020     FOREGROUND_GREEN | FOREGROUND_BLUE, /* cyan    */
1021     FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE /* white   */
1022   };
1023   static const guchar ansi_to_win_bg[8] = {
1024     0,
1025     BACKGROUND_RED,
1026     BACKGROUND_GREEN,
1027     BACKGROUND_RED | BACKGROUND_GREEN,
1028     BACKGROUND_BLUE,
1029     BACKGROUND_RED | BACKGROUND_BLUE,
1030     BACKGROUND_GREEN | FOREGROUND_BLUE,
1031     BACKGROUND_RED | BACKGROUND_GREEN | BACKGROUND_BLUE
1032   };
1033
1034   /* we draw black as white, as cmd.exe can only have black bg */
1035   if ((colorinfo & (GST_DEBUG_FG_MASK | GST_DEBUG_BG_MASK)) == 0) {
1036     color = ansi_to_win_fg[7];
1037   }
1038   if (colorinfo & GST_DEBUG_UNDERLINE) {
1039     color |= BACKGROUND_INTENSITY;
1040   }
1041   if (colorinfo & GST_DEBUG_BOLD) {
1042     color |= FOREGROUND_INTENSITY;
1043   }
1044   if (colorinfo & GST_DEBUG_FG_MASK) {
1045     color |= ansi_to_win_fg[colorinfo & GST_DEBUG_FG_MASK];
1046   }
1047   if (colorinfo & GST_DEBUG_BG_MASK) {
1048     color |= ansi_to_win_bg[(colorinfo & GST_DEBUG_BG_MASK) >> 4];
1049   }
1050 #endif
1051   return color;
1052 }
1053
1054 /* width of %p varies depending on actual value of pointer, which can make
1055  * output unevenly aligned if multiple threads are involved, hence the %14p
1056  * (should really be %18p, but %14p seems a good compromise between too many
1057  * white spaces and likely unalignment on my system) */
1058 #if defined (GLIB_SIZEOF_VOID_P) && GLIB_SIZEOF_VOID_P == 8
1059 #define PTR_FMT "%14p"
1060 #else
1061 #define PTR_FMT "%10p"
1062 #endif
1063 #define PID_FMT "%5d"
1064 #define CAT_FMT "%20s %s:%d:%s:%s"
1065
1066 #ifdef G_OS_WIN32
1067 static const guchar levelcolormap_w32[GST_LEVEL_COUNT] = {
1068   /* GST_LEVEL_NONE */
1069   FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE,
1070   /* GST_LEVEL_ERROR */
1071   FOREGROUND_RED | FOREGROUND_INTENSITY,
1072   /* GST_LEVEL_WARNING */
1073   FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_INTENSITY,
1074   /* GST_LEVEL_INFO */
1075   FOREGROUND_GREEN | FOREGROUND_INTENSITY,
1076   /* GST_LEVEL_DEBUG */
1077   FOREGROUND_GREEN | FOREGROUND_BLUE,
1078   /* GST_LEVEL_LOG */
1079   FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE,
1080   /* GST_LEVEL_FIXME */
1081   FOREGROUND_RED | FOREGROUND_GREEN,
1082   /* GST_LEVEL_TRACE */
1083   FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE,
1084   /* placeholder for log level 8 */
1085   0,
1086   /* GST_LEVEL_MEMDUMP */
1087   FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE
1088 };
1089
1090 static const guchar available_colors[] = {
1091   FOREGROUND_RED, FOREGROUND_GREEN, FOREGROUND_RED | FOREGROUND_GREEN,
1092   FOREGROUND_BLUE, FOREGROUND_RED | FOREGROUND_BLUE,
1093   FOREGROUND_GREEN | FOREGROUND_BLUE,
1094 };
1095 #endif /* G_OS_WIN32 */
1096 static const gchar *levelcolormap[GST_LEVEL_COUNT] = {
1097   "\033[37m",                   /* GST_LEVEL_NONE */
1098   "\033[31;01m",                /* GST_LEVEL_ERROR */
1099   "\033[33;01m",                /* GST_LEVEL_WARNING */
1100   "\033[32;01m",                /* GST_LEVEL_INFO */
1101   "\033[36m",                   /* GST_LEVEL_DEBUG */
1102   "\033[37m",                   /* GST_LEVEL_LOG */
1103   "\033[33;01m",                /* GST_LEVEL_FIXME */
1104   "\033[37m",                   /* GST_LEVEL_TRACE */
1105   "\033[37m",                   /* placeholder for log level 8 */
1106   "\033[37m"                    /* GST_LEVEL_MEMDUMP */
1107 };
1108
1109 /**
1110  * gst_debug_log_default:
1111  * @category: category to log
1112  * @level: level of the message
1113  * @file: the file that emitted the message, usually the __FILE__ identifier
1114  * @function: the function that emitted the message
1115  * @line: the line from that the message was emitted, usually __LINE__
1116  * @message: the actual message
1117  * @object: (transfer none) (allow-none): the object this message relates to,
1118  *     or %NULL if none
1119  * @user_data: the FILE* to log to
1120  *
1121  * The default logging handler used by GStreamer. Logging functions get called
1122  * whenever a macro like GST_DEBUG or similar is used. By default this function
1123  * is setup to output the message and additional info to stderr (or the log file
1124  * specified via the GST_DEBUG_FILE environment variable) as received via
1125  * @user_data.
1126  *
1127  * You can add other handlers by using gst_debug_add_log_function().
1128  * And you can remove this handler by calling
1129  * gst_debug_remove_log_function(gst_debug_log_default);
1130  */
1131 void
1132 gst_debug_log_default (GstDebugCategory * category, GstDebugLevel level,
1133     const gchar * file, const gchar * function, gint line,
1134     GObject * object, GstDebugMessage * message, gpointer user_data)
1135 {
1136   gint pid;
1137   GstClockTime elapsed;
1138   gchar *obj = NULL;
1139   GstDebugColorMode color_mode;
1140   FILE *log_file = user_data ? user_data : stderr;
1141   gchar c;
1142
1143   /* __FILE__ might be a file name or an absolute path or a
1144    * relative path, irrespective of the exact compiler used,
1145    * in which case we want to shorten it to the filename for
1146    * readability. */
1147   c = file[0];
1148   if (c == '.' || c == '/' || c == '\\' || (c != '\0' && file[1] == ':')) {
1149     file = gst_path_basename (file);
1150   }
1151
1152   pid = getpid ();
1153   color_mode = gst_debug_get_color_mode ();
1154
1155   if (object) {
1156     obj = gst_debug_print_object (object);
1157   } else {
1158     obj = (gchar *) "";
1159   }
1160
1161   elapsed = GST_CLOCK_DIFF (_priv_gst_start_time, gst_util_get_timestamp ());
1162
1163   if (color_mode != GST_DEBUG_COLOR_MODE_OFF) {
1164 #ifdef G_OS_WIN32
1165     /* We take a lock to keep colors and content together.
1166      * Maybe there is a better way but for now this will do the right
1167      * thing. */
1168     static GMutex win_print_mutex;
1169     g_mutex_lock (&win_print_mutex);
1170     if (color_mode == GST_DEBUG_COLOR_MODE_UNIX) {
1171 #endif
1172       /* colors, non-windows */
1173       gchar *color = NULL;
1174       const gchar *clear;
1175       gchar pidcolor[10];
1176       const gchar *levelcolor;
1177
1178       color = gst_debug_construct_term_color (gst_debug_category_get_color
1179           (category));
1180       clear = "\033[00m";
1181       g_sprintf (pidcolor, "\033[3%1dm", pid % 6 + 31);
1182       levelcolor = levelcolormap[level];
1183
1184 #define PRINT_FMT " %s"PID_FMT"%s "PTR_FMT" %s%s%s %s"CAT_FMT"%s %s\n"
1185       fprintf (log_file, "%" GST_TIME_FORMAT PRINT_FMT, GST_TIME_ARGS (elapsed),
1186           pidcolor, pid, clear, g_thread_self (), levelcolor,
1187           gst_debug_level_get_name (level), clear, color,
1188           gst_debug_category_get_name (category), file, line, function, obj,
1189           clear, gst_debug_message_get (message));
1190       fflush (log_file);
1191 #undef PRINT_FMT
1192       g_free (color);
1193 #ifdef G_OS_WIN32
1194     } else {
1195       /* colors, windows. */
1196       const gint clear = FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE;
1197 #define SET_COLOR(c) G_STMT_START { \
1198   if (log_file == stderr) \
1199     SetConsoleTextAttribute (GetStdHandle (STD_ERROR_HANDLE), (c)); \
1200   } G_STMT_END
1201       /* timestamp */
1202       fprintf (log_file, "%" GST_TIME_FORMAT " ", GST_TIME_ARGS (elapsed));
1203       fflush (log_file);
1204       /* pid */
1205       SET_COLOR (available_colors[pid % G_N_ELEMENTS (available_colors)]);
1206       fprintf (log_file, PID_FMT, pid);
1207       fflush (log_file);
1208       /* thread */
1209       SET_COLOR (clear);
1210       fprintf (log_file, " " PTR_FMT " ", g_thread_self ());
1211       fflush (log_file);
1212       /* level */
1213       SET_COLOR (levelcolormap_w32[level]);
1214       fprintf (log_file, "%s ", gst_debug_level_get_name (level));
1215       fflush (log_file);
1216       /* category */
1217       SET_COLOR (gst_debug_construct_win_color (gst_debug_category_get_color
1218               (category)));
1219       fprintf (log_file, CAT_FMT, gst_debug_category_get_name (category),
1220           file, line, function, obj);
1221       fflush (log_file);
1222       /* message */
1223       SET_COLOR (clear);
1224       fprintf (log_file, " %s\n", gst_debug_message_get (message));
1225       fflush (log_file);
1226     }
1227     g_mutex_unlock (&win_print_mutex);
1228 #endif
1229   } else {
1230     /* no color, all platforms */
1231 #define PRINT_FMT " "PID_FMT" "PTR_FMT" %s "CAT_FMT" %s\n"
1232     fprintf (log_file, "%" GST_TIME_FORMAT PRINT_FMT, GST_TIME_ARGS (elapsed),
1233         pid, g_thread_self (), gst_debug_level_get_name (level),
1234         gst_debug_category_get_name (category), file, line, function, obj,
1235         gst_debug_message_get (message));
1236     fflush (log_file);
1237 #undef PRINT_FMT
1238   }
1239
1240   if (object != NULL)
1241     g_free (obj);
1242 }
1243
1244 /**
1245  * gst_debug_level_get_name:
1246  * @level: the level to get the name for
1247  *
1248  * Get the string representation of a debugging level
1249  *
1250  * Returns: the name
1251  */
1252 const gchar *
1253 gst_debug_level_get_name (GstDebugLevel level)
1254 {
1255   switch (level) {
1256     case GST_LEVEL_NONE:
1257       return "";
1258     case GST_LEVEL_ERROR:
1259       return "ERROR  ";
1260     case GST_LEVEL_WARNING:
1261       return "WARN   ";
1262     case GST_LEVEL_INFO:
1263       return "INFO   ";
1264     case GST_LEVEL_DEBUG:
1265       return "DEBUG  ";
1266     case GST_LEVEL_LOG:
1267       return "LOG    ";
1268     case GST_LEVEL_FIXME:
1269       return "FIXME  ";
1270     case GST_LEVEL_TRACE:
1271       return "TRACE  ";
1272     case GST_LEVEL_MEMDUMP:
1273       return "MEMDUMP";
1274     default:
1275       g_warning ("invalid level specified for gst_debug_level_get_name");
1276       return "";
1277   }
1278 }
1279
1280 /**
1281  * gst_debug_add_log_function:
1282  * @func: the function to use
1283  * @user_data: user data
1284  * @notify: called when @user_data is not used anymore
1285  *
1286  * Adds the logging function to the list of logging functions.
1287  * Be sure to use #G_GNUC_NO_INSTRUMENT on that function, it is needed.
1288  */
1289 void
1290 gst_debug_add_log_function (GstLogFunction func, gpointer user_data,
1291     GDestroyNotify notify)
1292 {
1293   LogFuncEntry *entry;
1294   GSList *list;
1295
1296   if (func == NULL)
1297     func = gst_debug_log_default;
1298
1299   entry = g_slice_new (LogFuncEntry);
1300   entry->func = func;
1301   entry->user_data = user_data;
1302   entry->notify = notify;
1303   /* FIXME: we leak the old list here - other threads might access it right now
1304    * in gst_debug_logv. Another solution is to lock the mutex in gst_debug_logv,
1305    * but that is waaay costly.
1306    * It'd probably be clever to use some kind of RCU here, but I don't know
1307    * anything about that.
1308    */
1309   g_mutex_lock (&__log_func_mutex);
1310   list = g_slist_copy (__log_functions);
1311   __log_functions = g_slist_prepend (list, entry);
1312   g_mutex_unlock (&__log_func_mutex);
1313
1314   if (gst_is_initialized ())
1315     GST_DEBUG ("prepended log function %p (user data %p) to log functions",
1316         func, user_data);
1317 }
1318
1319 static gint
1320 gst_debug_compare_log_function_by_func (gconstpointer entry, gconstpointer func)
1321 {
1322   gpointer entryfunc = (gpointer) (((LogFuncEntry *) entry)->func);
1323
1324   return (entryfunc < func) ? -1 : (entryfunc > func) ? 1 : 0;
1325 }
1326
1327 static gint
1328 gst_debug_compare_log_function_by_data (gconstpointer entry, gconstpointer data)
1329 {
1330   gpointer entrydata = ((LogFuncEntry *) entry)->user_data;
1331
1332   return (entrydata < data) ? -1 : (entrydata > data) ? 1 : 0;
1333 }
1334
1335 static guint
1336 gst_debug_remove_with_compare_func (GCompareFunc func, gpointer data)
1337 {
1338   GSList *found;
1339   GSList *new, *cleanup = NULL;
1340   guint removals = 0;
1341
1342   g_mutex_lock (&__log_func_mutex);
1343   new = __log_functions;
1344   cleanup = NULL;
1345   while ((found = g_slist_find_custom (new, data, func))) {
1346     if (new == __log_functions) {
1347       /* make a copy when we have the first hit, so that we modify the copy and
1348        * make that the new list later */
1349       new = g_slist_copy (new);
1350       continue;
1351     }
1352     cleanup = g_slist_prepend (cleanup, found->data);
1353     new = g_slist_delete_link (new, found);
1354     removals++;
1355   }
1356   /* FIXME: We leak the old list here. See _add_log_function for why. */
1357   __log_functions = new;
1358   g_mutex_unlock (&__log_func_mutex);
1359
1360   while (cleanup) {
1361     LogFuncEntry *entry = cleanup->data;
1362
1363     if (entry->notify)
1364       entry->notify (entry->user_data);
1365
1366     g_slice_free (LogFuncEntry, entry);
1367     cleanup = g_slist_delete_link (cleanup, cleanup);
1368   }
1369   return removals;
1370 }
1371
1372 /**
1373  * gst_debug_remove_log_function:
1374  * @func: (scope call) (allow-none): the log function to remove, or %NULL to
1375  *     remove the default log function
1376  *
1377  * Removes all registered instances of the given logging functions.
1378  *
1379  * Returns: How many instances of the function were removed
1380  */
1381 guint
1382 gst_debug_remove_log_function (GstLogFunction func)
1383 {
1384   guint removals;
1385
1386   if (func == NULL)
1387     func = gst_debug_log_default;
1388
1389   removals =
1390       gst_debug_remove_with_compare_func
1391       (gst_debug_compare_log_function_by_func, (gpointer) func);
1392
1393   if (gst_is_initialized ()) {
1394     GST_DEBUG ("removed log function %p %d times from log function list", func,
1395         removals);
1396   } else {
1397     /* If the default log function is removed before gst_init() was called,
1398      * set a flag so we don't add it in gst_init() later */
1399     if (func == gst_debug_log_default) {
1400       add_default_log_func = FALSE;
1401       ++removals;
1402     }
1403   }
1404
1405   return removals;
1406 }
1407
1408 /**
1409  * gst_debug_remove_log_function_by_data:
1410  * @data: user data of the log function to remove
1411  *
1412  * Removes all registered instances of log functions with the given user data.
1413  *
1414  * Returns: How many instances of the function were removed
1415  */
1416 guint
1417 gst_debug_remove_log_function_by_data (gpointer data)
1418 {
1419   guint removals;
1420
1421   removals =
1422       gst_debug_remove_with_compare_func
1423       (gst_debug_compare_log_function_by_data, data);
1424
1425   if (gst_is_initialized ())
1426     GST_DEBUG
1427         ("removed %d log functions with user data %p from log function list",
1428         removals, data);
1429
1430   return removals;
1431 }
1432
1433 /**
1434  * gst_debug_set_colored:
1435  * @colored: Whether to use colored output or not
1436  *
1437  * Sets or unsets the use of coloured debugging output.
1438  * Same as gst_debug_set_color_mode () with the argument being
1439  * being GST_DEBUG_COLOR_MODE_ON or GST_DEBUG_COLOR_MODE_OFF.
1440  *
1441  * This function may be called before gst_init().
1442  */
1443 void
1444 gst_debug_set_colored (gboolean colored)
1445 {
1446   GstDebugColorMode new_mode;
1447   new_mode = colored ? GST_DEBUG_COLOR_MODE_ON : GST_DEBUG_COLOR_MODE_OFF;
1448   g_atomic_int_set (&__use_color, (gint) new_mode);
1449 }
1450
1451 /**
1452  * gst_debug_set_color_mode:
1453  * @mode: The coloring mode for debug output. See @GstDebugColorMode.
1454  *
1455  * Changes the coloring mode for debug output.
1456  *
1457  * This function may be called before gst_init().
1458  *
1459  * Since: 1.2
1460  */
1461 void
1462 gst_debug_set_color_mode (GstDebugColorMode mode)
1463 {
1464   g_atomic_int_set (&__use_color, mode);
1465 }
1466
1467 /**
1468  * gst_debug_set_color_mode_from_string:
1469  * @mode: The coloring mode for debug output. One of the following:
1470  * "on", "auto", "off", "disable", "unix".
1471  *
1472  * Changes the coloring mode for debug output.
1473  *
1474  * This function may be called before gst_init().
1475  *
1476  * Since: 1.2
1477  */
1478 void
1479 gst_debug_set_color_mode_from_string (const gchar * mode)
1480 {
1481   if ((strcmp (mode, "on") == 0) || (strcmp (mode, "auto") == 0))
1482     gst_debug_set_color_mode (GST_DEBUG_COLOR_MODE_ON);
1483   else if ((strcmp (mode, "off") == 0) || (strcmp (mode, "disable") == 0))
1484     gst_debug_set_color_mode (GST_DEBUG_COLOR_MODE_OFF);
1485   else if (strcmp (mode, "unix") == 0)
1486     gst_debug_set_color_mode (GST_DEBUG_COLOR_MODE_UNIX);
1487 }
1488
1489 /**
1490  * gst_debug_is_colored:
1491  *
1492  * Checks if the debugging output should be colored.
1493  *
1494  * Returns: %TRUE, if the debug output should be colored.
1495  */
1496 gboolean
1497 gst_debug_is_colored (void)
1498 {
1499   GstDebugColorMode mode = g_atomic_int_get (&__use_color);
1500   return (mode == GST_DEBUG_COLOR_MODE_UNIX || mode == GST_DEBUG_COLOR_MODE_ON);
1501 }
1502
1503 /**
1504  * gst_debug_get_color_mode:
1505  *
1506  * Changes the coloring mode for debug output.
1507  *
1508  * Returns: see @GstDebugColorMode for possible values.
1509  *
1510  * Since: 1.2
1511  */
1512 GstDebugColorMode
1513 gst_debug_get_color_mode (void)
1514 {
1515   return g_atomic_int_get (&__use_color);
1516 }
1517
1518 /**
1519  * gst_debug_set_active:
1520  * @active: Whether to use debugging output or not
1521  *
1522  * If activated, debugging messages are sent to the debugging
1523  * handlers.
1524  * It makes sense to deactivate it for speed issues.
1525  * > This function is not threadsafe. It makes sense to only call it
1526  * during initialization.
1527  */
1528 void
1529 gst_debug_set_active (gboolean active)
1530 {
1531   _gst_debug_enabled = active;
1532   if (active)
1533     _gst_debug_min = GST_LEVEL_COUNT;
1534   else
1535     _gst_debug_min = GST_LEVEL_NONE;
1536 }
1537
1538 /**
1539  * gst_debug_is_active:
1540  *
1541  * Checks if debugging output is activated.
1542  *
1543  * Returns: %TRUE, if debugging is activated
1544  */
1545 gboolean
1546 gst_debug_is_active (void)
1547 {
1548   return _gst_debug_enabled;
1549 }
1550
1551 /**
1552  * gst_debug_set_default_threshold:
1553  * @level: level to set
1554  *
1555  * Sets the default threshold to the given level and updates all categories to
1556  * use this threshold.
1557  *
1558  * This function may be called before gst_init().
1559  */
1560 void
1561 gst_debug_set_default_threshold (GstDebugLevel level)
1562 {
1563   g_atomic_int_set (&__default_level, level);
1564   gst_debug_reset_all_thresholds ();
1565 }
1566
1567 /**
1568  * gst_debug_get_default_threshold:
1569  *
1570  * Returns the default threshold that is used for new categories.
1571  *
1572  * Returns: the default threshold level
1573  */
1574 GstDebugLevel
1575 gst_debug_get_default_threshold (void)
1576 {
1577   return (GstDebugLevel) g_atomic_int_get (&__default_level);
1578 }
1579
1580 static gboolean
1581 gst_debug_apply_entry (GstDebugCategory * cat, LevelNameEntry * entry)
1582 {
1583   if (!g_pattern_match_string (entry->pat, cat->name))
1584     return FALSE;
1585
1586   if (gst_is_initialized ())
1587     GST_LOG ("category %s matches pattern %p - gets set to level %d",
1588         cat->name, entry->pat, entry->level);
1589
1590   gst_debug_category_set_threshold (cat, entry->level);
1591   return TRUE;
1592 }
1593
1594 static void
1595 gst_debug_reset_threshold (gpointer category, gpointer unused)
1596 {
1597   GstDebugCategory *cat = (GstDebugCategory *) category;
1598   GSList *walk;
1599
1600   g_mutex_lock (&__level_name_mutex);
1601   walk = __level_name;
1602   while (walk) {
1603     LevelNameEntry *entry = walk->data;
1604
1605     walk = g_slist_next (walk);
1606     if (gst_debug_apply_entry (cat, entry))
1607       goto exit;
1608   }
1609   gst_debug_category_set_threshold (cat, gst_debug_get_default_threshold ());
1610
1611 exit:
1612   g_mutex_unlock (&__level_name_mutex);
1613 }
1614
1615 static void
1616 gst_debug_reset_all_thresholds (void)
1617 {
1618   g_mutex_lock (&__cat_mutex);
1619   g_slist_foreach (__categories, gst_debug_reset_threshold, NULL);
1620   g_mutex_unlock (&__cat_mutex);
1621 }
1622
1623 static void
1624 for_each_threshold_by_entry (gpointer data, gpointer user_data)
1625 {
1626   GstDebugCategory *cat = (GstDebugCategory *) data;
1627   LevelNameEntry *entry = (LevelNameEntry *) user_data;
1628
1629   gst_debug_apply_entry (cat, entry);
1630 }
1631
1632 /**
1633  * gst_debug_set_threshold_for_name:
1634  * @name: name of the categories to set
1635  * @level: level to set them to
1636  *
1637  * Sets all categories which match the given glob style pattern to the given
1638  * level.
1639  */
1640 void
1641 gst_debug_set_threshold_for_name (const gchar * name, GstDebugLevel level)
1642 {
1643   GPatternSpec *pat;
1644   LevelNameEntry *entry;
1645
1646   g_return_if_fail (name != NULL);
1647
1648   pat = g_pattern_spec_new (name);
1649   entry = g_slice_new (LevelNameEntry);
1650   entry->pat = pat;
1651   entry->level = level;
1652   g_mutex_lock (&__level_name_mutex);
1653   __level_name = g_slist_prepend (__level_name, entry);
1654   g_mutex_unlock (&__level_name_mutex);
1655   g_mutex_lock (&__cat_mutex);
1656   g_slist_foreach (__categories, for_each_threshold_by_entry, entry);
1657   g_mutex_unlock (&__cat_mutex);
1658 }
1659
1660 /**
1661  * gst_debug_unset_threshold_for_name:
1662  * @name: name of the categories to set
1663  *
1664  * Resets all categories with the given name back to the default level.
1665  */
1666 void
1667 gst_debug_unset_threshold_for_name (const gchar * name)
1668 {
1669   GSList *walk;
1670   GPatternSpec *pat;
1671
1672   g_return_if_fail (name != NULL);
1673
1674   pat = g_pattern_spec_new (name);
1675   g_mutex_lock (&__level_name_mutex);
1676   walk = __level_name;
1677   /* improve this if you want, it's mighty slow */
1678   while (walk) {
1679     LevelNameEntry *entry = walk->data;
1680
1681     if (g_pattern_spec_equal (entry->pat, pat)) {
1682       __level_name = g_slist_remove_link (__level_name, walk);
1683       g_pattern_spec_free (entry->pat);
1684       g_slice_free (LevelNameEntry, entry);
1685       g_slist_free_1 (walk);
1686       walk = __level_name;
1687     } else {
1688       walk = g_slist_next (walk);
1689     }
1690   }
1691   g_mutex_unlock (&__level_name_mutex);
1692   g_pattern_spec_free (pat);
1693   gst_debug_reset_all_thresholds ();
1694 }
1695
1696 static void
1697 gst_debug_apply_patterns_to_category (GstDebugCategory * cat)
1698 {
1699   GSList *l;
1700
1701   g_mutex_lock (&__level_name_mutex);
1702   for (l = __level_name; l != NULL; l = l->next) {
1703     for_each_threshold_by_entry (cat, (LevelNameEntry *) l->data);
1704   }
1705   g_mutex_unlock (&__level_name_mutex);
1706 }
1707
1708 GstDebugCategory *
1709 _gst_debug_category_new (const gchar * name, guint color,
1710     const gchar * description)
1711 {
1712   GstDebugCategory *cat, *catfound;
1713
1714   g_return_val_if_fail (name != NULL, NULL);
1715
1716   cat = g_slice_new (GstDebugCategory);
1717   cat->name = g_strdup (name);
1718   cat->color = color;
1719   if (description != NULL) {
1720     cat->description = g_strdup (description);
1721   } else {
1722     cat->description = g_strdup ("no description");
1723   }
1724   g_atomic_int_set (&cat->threshold, 0);
1725   gst_debug_reset_threshold (cat, NULL);
1726
1727   /* add to category list */
1728   g_mutex_lock (&__cat_mutex);
1729   catfound = _gst_debug_get_category_locked (name);
1730   if (catfound) {
1731     g_free ((gpointer) cat->name);
1732     g_free ((gpointer) cat->description);
1733     g_slice_free (GstDebugCategory, cat);
1734     cat = catfound;
1735   } else {
1736     __categories = g_slist_prepend (__categories, cat);
1737   }
1738   g_mutex_unlock (&__cat_mutex);
1739
1740   /* ensure the filter is applied to categories registered after _debug_init */
1741   gst_debug_apply_patterns_to_category (cat);
1742
1743   return cat;
1744 }
1745
1746 /**
1747  * gst_debug_category_free:
1748  * @category: #GstDebugCategory to free.
1749  *
1750  * Removes and frees the category and all associated resources.
1751  */
1752 void
1753 gst_debug_category_free (GstDebugCategory * category)
1754 {
1755   if (category == NULL)
1756     return;
1757
1758   /* remove from category list */
1759   g_mutex_lock (&__cat_mutex);
1760   __categories = g_slist_remove (__categories, category);
1761   g_mutex_unlock (&__cat_mutex);
1762
1763   g_free ((gpointer) category->name);
1764   g_free ((gpointer) category->description);
1765   g_slice_free (GstDebugCategory, category);
1766 }
1767
1768 /**
1769  * gst_debug_category_set_threshold:
1770  * @category: a #GstDebugCategory to set threshold of.
1771  * @level: the #GstDebugLevel threshold to set.
1772  *
1773  * Sets the threshold of the category to the given level. Debug information will
1774  * only be output if the threshold is lower or equal to the level of the
1775  * debugging message.
1776  * > Do not use this function in production code, because other functions may
1777  * > change the threshold of categories as side effect. It is however a nice
1778  * > function to use when debugging (even from gdb).
1779  */
1780 void
1781 gst_debug_category_set_threshold (GstDebugCategory * category,
1782     GstDebugLevel level)
1783 {
1784   g_return_if_fail (category != NULL);
1785
1786   if (level > _gst_debug_min) {
1787     _gst_debug_enabled = TRUE;
1788     _gst_debug_min = level;
1789   }
1790
1791   g_atomic_int_set (&category->threshold, level);
1792 }
1793
1794 /**
1795  * gst_debug_category_reset_threshold:
1796  * @category: a #GstDebugCategory to reset threshold of.
1797  *
1798  * Resets the threshold of the category to the default level. Debug information
1799  * will only be output if the threshold is lower or equal to the level of the
1800  * debugging message.
1801  * Use this function to set the threshold back to where it was after using
1802  * gst_debug_category_set_threshold().
1803  */
1804 void
1805 gst_debug_category_reset_threshold (GstDebugCategory * category)
1806 {
1807   gst_debug_reset_threshold (category, NULL);
1808 }
1809
1810 /**
1811  * gst_debug_category_get_threshold:
1812  * @category: a #GstDebugCategory to get threshold of.
1813  *
1814  * Returns the threshold of a #GstDebugCategory.
1815  *
1816  * Returns: the #GstDebugLevel that is used as threshold.
1817  */
1818 GstDebugLevel
1819 gst_debug_category_get_threshold (GstDebugCategory * category)
1820 {
1821   return (GstDebugLevel) g_atomic_int_get (&category->threshold);
1822 }
1823
1824 /**
1825  * gst_debug_category_get_name:
1826  * @category: a #GstDebugCategory to get name of.
1827  *
1828  * Returns the name of a debug category.
1829  *
1830  * Returns: the name of the category.
1831  */
1832 const gchar *
1833 gst_debug_category_get_name (GstDebugCategory * category)
1834 {
1835   return category->name;
1836 }
1837
1838 /**
1839  * gst_debug_category_get_color:
1840  * @category: a #GstDebugCategory to get the color of.
1841  *
1842  * Returns the color of a debug category used when printing output in this
1843  * category.
1844  *
1845  * Returns: the color of the category.
1846  */
1847 guint
1848 gst_debug_category_get_color (GstDebugCategory * category)
1849 {
1850   return category->color;
1851 }
1852
1853 /**
1854  * gst_debug_category_get_description:
1855  * @category: a #GstDebugCategory to get the description of.
1856  *
1857  * Returns the description of a debug category.
1858  *
1859  * Returns: the description of the category.
1860  */
1861 const gchar *
1862 gst_debug_category_get_description (GstDebugCategory * category)
1863 {
1864   return category->description;
1865 }
1866
1867 /**
1868  * gst_debug_get_all_categories:
1869  *
1870  * Returns a snapshot of a all categories that are currently in use . This list
1871  * may change anytime.
1872  * The caller has to free the list after use.
1873  *
1874  * Returns: (transfer container) (element-type Gst.DebugCategory): the list of
1875  *     debug categories
1876  */
1877 GSList *
1878 gst_debug_get_all_categories (void)
1879 {
1880   GSList *ret;
1881
1882   g_mutex_lock (&__cat_mutex);
1883   ret = g_slist_copy (__categories);
1884   g_mutex_unlock (&__cat_mutex);
1885
1886   return ret;
1887 }
1888
1889 static GstDebugCategory *
1890 _gst_debug_get_category_locked (const gchar * name)
1891 {
1892   GstDebugCategory *ret = NULL;
1893   GSList *node;
1894
1895   for (node = __categories; node; node = g_slist_next (node)) {
1896     ret = (GstDebugCategory *) node->data;
1897     if (!strcmp (name, ret->name)) {
1898       return ret;
1899     }
1900   }
1901   return NULL;
1902 }
1903
1904 GstDebugCategory *
1905 _gst_debug_get_category (const gchar * name)
1906 {
1907   GstDebugCategory *ret;
1908
1909   g_mutex_lock (&__cat_mutex);
1910   ret = _gst_debug_get_category_locked (name);
1911   g_mutex_unlock (&__cat_mutex);
1912
1913   return ret;
1914 }
1915
1916 static gboolean
1917 parse_debug_category (gchar * str, const gchar ** category)
1918 {
1919   if (!str)
1920     return FALSE;
1921
1922   /* works in place */
1923   g_strstrip (str);
1924
1925   if (str[0] != '\0') {
1926     *category = str;
1927     return TRUE;
1928   }
1929
1930   return FALSE;
1931 }
1932
1933 static gboolean
1934 parse_debug_level (gchar * str, GstDebugLevel * level)
1935 {
1936   if (!str)
1937     return FALSE;
1938
1939   /* works in place */
1940   g_strstrip (str);
1941
1942   if (g_ascii_isdigit (str[0])) {
1943     unsigned long l;
1944     char *endptr;
1945     l = strtoul (str, &endptr, 10);
1946     if (endptr > str && endptr[0] == 0) {
1947       *level = (GstDebugLevel) l;
1948     } else {
1949       return FALSE;
1950     }
1951   } else if (strcmp (str, "ERROR") == 0) {
1952     *level = GST_LEVEL_ERROR;
1953   } else if (strncmp (str, "WARN", 4) == 0) {
1954     *level = GST_LEVEL_WARNING;
1955   } else if (strcmp (str, "FIXME") == 0) {
1956     *level = GST_LEVEL_FIXME;
1957   } else if (strcmp (str, "INFO") == 0) {
1958     *level = GST_LEVEL_INFO;
1959   } else if (strcmp (str, "DEBUG") == 0) {
1960     *level = GST_LEVEL_DEBUG;
1961   } else if (strcmp (str, "LOG") == 0) {
1962     *level = GST_LEVEL_LOG;
1963   } else if (strcmp (str, "TRACE") == 0) {
1964     *level = GST_LEVEL_TRACE;
1965   } else if (strcmp (str, "MEMDUMP") == 0) {
1966     *level = GST_LEVEL_MEMDUMP;
1967   } else
1968     return FALSE;
1969
1970   return TRUE;
1971 }
1972
1973 /**
1974  * gst_debug_set_threshold_from_string:
1975  * @list: comma-separated list of "category:level" pairs to be used
1976  *     as debug logging levels
1977  * @reset: %TRUE to clear all previously-set debug levels before setting
1978  *     new thresholds
1979  * %FALSE if adding the threshold described by @list to the one already set.
1980  *
1981  * Sets the debug logging wanted in the same form as with the GST_DEBUG
1982  * environment variable. You can use wildcards such as '*', but note that
1983  * the order matters when you use wild cards, e.g. "foosrc:6,*src:3,*:2" sets
1984  * everything to log level 2.
1985  *
1986  * Since: 1.2
1987  */
1988 void
1989 gst_debug_set_threshold_from_string (const gchar * list, gboolean reset)
1990 {
1991   gchar **split;
1992   gchar **walk;
1993
1994   g_assert (list);
1995
1996   if (reset)
1997     gst_debug_set_default_threshold (GST_LEVEL_DEFAULT);
1998
1999   split = g_strsplit (list, ",", 0);
2000
2001   for (walk = split; *walk; walk++) {
2002     if (strchr (*walk, ':')) {
2003       gchar **values = g_strsplit (*walk, ":", 2);
2004
2005       if (values[0] && values[1]) {
2006         GstDebugLevel level;
2007         const gchar *category;
2008
2009         if (parse_debug_category (values[0], &category)
2010             && parse_debug_level (values[1], &level)) {
2011           gst_debug_set_threshold_for_name (category, level);
2012
2013           /* bump min-level anyway to allow the category to be registered in the
2014            * future still */
2015           if (level > _gst_debug_min) {
2016             _gst_debug_min = level;
2017           }
2018         }
2019       }
2020
2021       g_strfreev (values);
2022     } else {
2023       GstDebugLevel level;
2024
2025       if (parse_debug_level (*walk, &level))
2026         gst_debug_set_default_threshold (level);
2027     }
2028   }
2029
2030   g_strfreev (split);
2031 }
2032
2033 /*** FUNCTION POINTERS ********************************************************/
2034
2035 static GHashTable *__gst_function_pointers;     /* NULL */
2036 static GMutex __dbg_functions_mutex;
2037
2038 /* This function MUST NOT return NULL */
2039 const gchar *
2040 _gst_debug_nameof_funcptr (GstDebugFuncPtr func)
2041 {
2042   gchar *ptrname;
2043
2044 #ifdef HAVE_DLADDR
2045   Dl_info dl_info;
2046 #endif
2047
2048   if (G_UNLIKELY (func == NULL))
2049     return "(NULL)";
2050
2051   g_mutex_lock (&__dbg_functions_mutex);
2052   if (G_LIKELY (__gst_function_pointers)) {
2053     ptrname = g_hash_table_lookup (__gst_function_pointers, (gpointer) func);
2054     g_mutex_unlock (&__dbg_functions_mutex);
2055     if (G_LIKELY (ptrname))
2056       return ptrname;
2057   } else {
2058     g_mutex_unlock (&__dbg_functions_mutex);
2059   }
2060   /* we need to create an entry in the hash table for this one so we don't leak
2061    * the name */
2062 #ifdef HAVE_DLADDR
2063   if (dladdr ((gpointer) func, &dl_info) && dl_info.dli_sname) {
2064     gchar *name = g_strdup (dl_info.dli_sname);
2065
2066     _gst_debug_register_funcptr (func, name);
2067     return name;
2068   } else
2069 #endif
2070   {
2071     gchar *name = g_strdup_printf ("%p", (gpointer) func);
2072
2073     _gst_debug_register_funcptr (func, name);
2074     return name;
2075   }
2076 }
2077
2078 void
2079 _gst_debug_register_funcptr (GstDebugFuncPtr func, const gchar * ptrname)
2080 {
2081   gpointer ptr = (gpointer) func;
2082
2083   g_mutex_lock (&__dbg_functions_mutex);
2084
2085   if (!__gst_function_pointers)
2086     __gst_function_pointers = g_hash_table_new (g_direct_hash, g_direct_equal);
2087   if (!g_hash_table_lookup (__gst_function_pointers, ptr))
2088     g_hash_table_insert (__gst_function_pointers, ptr, (gpointer) ptrname);
2089
2090   g_mutex_unlock (&__dbg_functions_mutex);
2091 }
2092
2093 static void
2094 gst_info_dump_mem_line (gchar * linebuf, gsize linebuf_size,
2095     const guint8 * mem, gsize mem_offset, gsize mem_size)
2096 {
2097   gchar hexstr[50], ascstr[18], digitstr[4];
2098
2099   if (mem_size > 16)
2100     mem_size = 16;
2101
2102   hexstr[0] = '\0';
2103   ascstr[0] = '\0';
2104
2105   if (mem != NULL) {
2106     guint i = 0;
2107
2108     mem += mem_offset;
2109     while (i < mem_size) {
2110       ascstr[i] = (g_ascii_isprint (mem[i])) ? mem[i] : '.';
2111       g_snprintf (digitstr, sizeof (digitstr), "%02x ", mem[i]);
2112       g_strlcat (hexstr, digitstr, sizeof (hexstr));
2113       ++i;
2114     }
2115     ascstr[i] = '\0';
2116   }
2117
2118   g_snprintf (linebuf, linebuf_size, "%08x: %-48.48s %-16.16s",
2119       (guint) mem_offset, hexstr, ascstr);
2120 }
2121
2122 void
2123 _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
2124     const gchar * func, gint line, GObject * obj, const gchar * msg,
2125     const guint8 * data, guint length)
2126 {
2127   guint off = 0;
2128
2129   gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "--------"
2130       "-------------------------------------------------------------------");
2131
2132   if (msg != NULL && *msg != '\0') {
2133     gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "%s", msg);
2134   }
2135
2136   while (off < length) {
2137     gchar buf[128];
2138
2139     /* gst_info_dump_mem_line will process 16 bytes at most */
2140     gst_info_dump_mem_line (buf, sizeof (buf), data, off, length - off);
2141     gst_debug_log (cat, GST_LEVEL_MEMDUMP, file, func, line, obj, "%s", buf);
2142     off += 16;
2143   }
2144
2145   gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "--------"
2146       "-------------------------------------------------------------------");
2147 }
2148
2149 #else /* !GST_DISABLE_GST_DEBUG */
2150 #ifndef GST_REMOVE_DISABLED
2151
2152 GstDebugCategory *
2153 _gst_debug_category_new (const gchar * name, guint color,
2154     const gchar * description)
2155 {
2156   return NULL;
2157 }
2158
2159 void
2160 _gst_debug_register_funcptr (GstDebugFuncPtr func, const gchar * ptrname)
2161 {
2162 }
2163
2164 /* This function MUST NOT return NULL */
2165 const gchar *
2166 _gst_debug_nameof_funcptr (GstDebugFuncPtr func)
2167 {
2168   return "(NULL)";
2169 }
2170
2171 void
2172 gst_debug_log (GstDebugCategory * category, GstDebugLevel level,
2173     const gchar * file, const gchar * function, gint line,
2174     GObject * object, const gchar * format, ...)
2175 {
2176 }
2177
2178 void
2179 gst_debug_log_valist (GstDebugCategory * category, GstDebugLevel level,
2180     const gchar * file, const gchar * function, gint line,
2181     GObject * object, const gchar * format, va_list args)
2182 {
2183 }
2184
2185 const gchar *
2186 gst_debug_message_get (GstDebugMessage * message)
2187 {
2188   return "";
2189 }
2190
2191 void
2192 gst_debug_log_default (GstDebugCategory * category, GstDebugLevel level,
2193     const gchar * file, const gchar * function, gint line,
2194     GObject * object, GstDebugMessage * message, gpointer unused)
2195 {
2196 }
2197
2198 const gchar *
2199 gst_debug_level_get_name (GstDebugLevel level)
2200 {
2201   return "NONE";
2202 }
2203
2204 void
2205 gst_debug_add_log_function (GstLogFunction func, gpointer user_data,
2206     GDestroyNotify notify)
2207 {
2208 }
2209
2210 guint
2211 gst_debug_remove_log_function (GstLogFunction func)
2212 {
2213   return 0;
2214 }
2215
2216 guint
2217 gst_debug_remove_log_function_by_data (gpointer data)
2218 {
2219   return 0;
2220 }
2221
2222 void
2223 gst_debug_set_active (gboolean active)
2224 {
2225 }
2226
2227 gboolean
2228 gst_debug_is_active (void)
2229 {
2230   return FALSE;
2231 }
2232
2233 void
2234 gst_debug_set_colored (gboolean colored)
2235 {
2236 }
2237
2238 void
2239 gst_debug_set_color_mode (GstDebugColorMode mode)
2240 {
2241 }
2242
2243 void
2244 gst_debug_set_color_mode_from_string (const gchar * str)
2245 {
2246 }
2247
2248 gboolean
2249 gst_debug_is_colored (void)
2250 {
2251   return FALSE;
2252 }
2253
2254 GstDebugColorMode
2255 gst_debug_get_color_mode (void)
2256 {
2257   return GST_DEBUG_COLOR_MODE_OFF;
2258 }
2259
2260 void
2261 gst_debug_set_threshold_from_string (const gchar * list, gboolean reset)
2262 {
2263 }
2264
2265 void
2266 gst_debug_set_default_threshold (GstDebugLevel level)
2267 {
2268 }
2269
2270 GstDebugLevel
2271 gst_debug_get_default_threshold (void)
2272 {
2273   return GST_LEVEL_NONE;
2274 }
2275
2276 void
2277 gst_debug_set_threshold_for_name (const gchar * name, GstDebugLevel level)
2278 {
2279 }
2280
2281 void
2282 gst_debug_unset_threshold_for_name (const gchar * name)
2283 {
2284 }
2285
2286 void
2287 gst_debug_category_free (GstDebugCategory * category)
2288 {
2289 }
2290
2291 void
2292 gst_debug_category_set_threshold (GstDebugCategory * category,
2293     GstDebugLevel level)
2294 {
2295 }
2296
2297 void
2298 gst_debug_category_reset_threshold (GstDebugCategory * category)
2299 {
2300 }
2301
2302 GstDebugLevel
2303 gst_debug_category_get_threshold (GstDebugCategory * category)
2304 {
2305   return GST_LEVEL_NONE;
2306 }
2307
2308 const gchar *
2309 gst_debug_category_get_name (GstDebugCategory * category)
2310 {
2311   return "";
2312 }
2313
2314 guint
2315 gst_debug_category_get_color (GstDebugCategory * category)
2316 {
2317   return 0;
2318 }
2319
2320 const gchar *
2321 gst_debug_category_get_description (GstDebugCategory * category)
2322 {
2323   return "";
2324 }
2325
2326 GSList *
2327 gst_debug_get_all_categories (void)
2328 {
2329   return NULL;
2330 }
2331
2332 GstDebugCategory *
2333 _gst_debug_get_category (const gchar * name)
2334 {
2335   return NULL;
2336 }
2337
2338 gchar *
2339 gst_debug_construct_term_color (guint colorinfo)
2340 {
2341   return g_strdup ("00");
2342 }
2343
2344 gint
2345 gst_debug_construct_win_color (guint colorinfo)
2346 {
2347   return 0;
2348 }
2349
2350 gboolean
2351 _priv_gst_in_valgrind (void)
2352 {
2353   return FALSE;
2354 }
2355
2356 void
2357 _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
2358     const gchar * func, gint line, GObject * obj, const gchar * msg,
2359     const guint8 * data, guint length)
2360 {
2361 }
2362 #endif /* GST_REMOVE_DISABLED */
2363 #endif /* GST_DISABLE_GST_DEBUG */
2364
2365 /* Need this for _gst_element_error_printf even if GST_REMOVE_DISABLED is set:
2366  * fallback function that cleans up the format string and replaces all pointer
2367  * extension formats with plain %p. */
2368 #ifdef GST_DISABLE_GST_DEBUG
2369 int
2370 __gst_info_fallback_vasprintf (char **result, char const *format, va_list args)
2371 {
2372   gchar *clean_format, *c;
2373   gsize len;
2374
2375   if (format == NULL)
2376     return -1;
2377
2378   clean_format = g_strdup (format);
2379   c = clean_format;
2380   while ((c = strstr (c, "%p\a"))) {
2381     if (c[3] < 'A' || c[3] > 'Z') {
2382       c += 3;
2383       continue;
2384     }
2385     len = strlen (c + 4);
2386     memmove (c + 2, c + 4, len + 1);
2387     c += 2;
2388   }
2389   while ((c = strstr (clean_format, "%P")))     /* old GST_PTR_FORMAT */
2390     c[1] = 'p';
2391   while ((c = strstr (clean_format, "%Q")))     /* old GST_SEGMENT_FORMAT */
2392     c[1] = 'p';
2393
2394   len = g_vasprintf (result, clean_format, args);
2395
2396   g_free (clean_format);
2397
2398   if (*result == NULL)
2399     return -1;
2400
2401   return len;
2402 }
2403 #endif
2404
2405 /**
2406  * gst_info_vasprintf:
2407  * @result: (out): the resulting string
2408  * @format: a printf style format string
2409  * @args: the va_list of printf arguments for @format
2410  *
2411  * Allocates and fills a string large enough (including the terminating null
2412  * byte) to hold the specified printf style @format and @args.
2413  *
2414  * This function deals with the GStreamer specific printf specifiers
2415  * #GST_PTR_FORMAT and #GST_SEGMENT_FORMAT.  If you do not have these specifiers
2416  * in your @format string, you do not need to use this function and can use
2417  * alternatives such as g_vasprintf().
2418  *
2419  * Free @result with g_free().
2420  *
2421  * Returns: the length of the string allocated into @result or -1 on any error
2422  *
2423  * Since: 1.8
2424  */
2425 gint
2426 gst_info_vasprintf (gchar ** result, const gchar * format, va_list args)
2427 {
2428   /* This will fallback to __gst_info_fallback_vasprintf() via a #define in
2429    * gst_private.h if the debug system is disabled which will remove the gst
2430    * specific printf format specifiers */
2431   return __gst_vasprintf (result, format, args);
2432 }
2433
2434 /**
2435  * gst_info_strdup_vprintf:
2436  * @format: a printf style format string
2437  * @args: the va_list of printf arguments for @format
2438  *
2439  * Allocates, fills and returns a null terminated string from the printf style
2440  * @format string and @args.
2441  *
2442  * See gst_info_vasprintf() for when this function is required.
2443  *
2444  * Free with g_free().
2445  *
2446  * Returns: (nullable): a newly allocated null terminated string or %NULL on any error
2447  *
2448  * Since: 1.8
2449  */
2450 gchar *
2451 gst_info_strdup_vprintf (const gchar * format, va_list args)
2452 {
2453   gchar *ret;
2454
2455   if (gst_info_vasprintf (&ret, format, args) < 0)
2456     ret = NULL;
2457
2458   return ret;
2459 }
2460
2461 /**
2462  * gst_info_strdup_printf:
2463  * @format: a printf style format string
2464  * @...: the printf arguments for @format
2465  *
2466  * Allocates, fills and returns a 0-terminated string from the printf style
2467  * @format string and corresponding arguments.
2468  *
2469  * See gst_info_vasprintf() for when this function is required.
2470  *
2471  * Free with g_free().
2472  *
2473  * Returns: (nullable): a newly allocated null terminated string or %NULL on any error
2474  *
2475  * Since: 1.8
2476  */
2477 gchar *
2478 gst_info_strdup_printf (const gchar * format, ...)
2479 {
2480   gchar *ret;
2481   va_list args;
2482
2483   va_start (args, format);
2484   ret = gst_info_strdup_vprintf (format, args);
2485   va_end (args);
2486
2487   return ret;
2488 }
2489
2490 /**
2491  * gst_print:
2492  * @format: a printf style format string
2493  * @...: the printf arguments for @format
2494  *
2495  * Outputs a formatted message via the GLib print handler. The default print
2496  * handler simply outputs the message to stdout.
2497  *
2498  * This function will not append a new-line character at the end, unlike
2499  * gst_println() which will.
2500  *
2501  * All strings must be in ASCII or UTF-8 encoding.
2502  *
2503  * This function differs from g_print() in that it supports all the additional
2504  * printf specifiers that are supported by GStreamer's debug logging system,
2505  * such as #GST_PTR_FORMAT and #GST_SEGMENT_FORMAT.
2506  *
2507  * This function is primarily for printing debug output.
2508  *
2509  * Since: 1.12
2510  */
2511 void
2512 gst_print (const gchar * format, ...)
2513 {
2514   va_list args;
2515   gchar *str;
2516
2517   va_start (args, format);
2518   str = gst_info_strdup_vprintf (format, args);
2519   va_end (args);
2520
2521   g_print ("%s", str);
2522   g_free (str);
2523 }
2524
2525 /**
2526  * gst_println:
2527  * @format: a printf style format string
2528  * @...: the printf arguments for @format
2529  *
2530  * Outputs a formatted message via the GLib print handler. The default print
2531  * handler simply outputs the message to stdout.
2532  *
2533  * This function will append a new-line character at the end, unlike
2534  * gst_print() which will not.
2535  *
2536  * All strings must be in ASCII or UTF-8 encoding.
2537  *
2538  * This function differs from g_print() in that it supports all the additional
2539  * printf specifiers that are supported by GStreamer's debug logging system,
2540  * such as #GST_PTR_FORMAT and #GST_SEGMENT_FORMAT.
2541  *
2542  * This function is primarily for printing debug output.
2543  *
2544  * Since: 1.12
2545  */
2546 void
2547 gst_println (const gchar * format, ...)
2548 {
2549   va_list args;
2550   gchar *str;
2551
2552   va_start (args, format);
2553   str = gst_info_strdup_vprintf (format, args);
2554   va_end (args);
2555
2556   g_print ("%s\n", str);
2557   g_free (str);
2558 }
2559
2560 /**
2561  * gst_printerr:
2562  * @format: a printf style format string
2563  * @...: the printf arguments for @format
2564  *
2565  * Outputs a formatted message via the GLib error message handler. The default
2566  * handler simply outputs the message to stderr.
2567  *
2568  * This function will not append a new-line character at the end, unlike
2569  * gst_printerrln() which will.
2570  *
2571  * All strings must be in ASCII or UTF-8 encoding.
2572  *
2573  * This function differs from g_printerr() in that it supports the additional
2574  * printf specifiers that are supported by GStreamer's debug logging system,
2575  * such as #GST_PTR_FORMAT and #GST_SEGMENT_FORMAT.
2576  *
2577  * This function is primarily for printing debug output.
2578  *
2579  * Since: 1.12
2580  */
2581 void
2582 gst_printerr (const gchar * format, ...)
2583 {
2584   va_list args;
2585   gchar *str;
2586
2587   va_start (args, format);
2588   str = gst_info_strdup_vprintf (format, args);
2589   va_end (args);
2590
2591   g_printerr ("%s", str);
2592   g_free (str);
2593 }
2594
2595 /**
2596  * gst_printerrln:
2597  * @format: a printf style format string
2598  * @...: the printf arguments for @format
2599  *
2600  * Outputs a formatted message via the GLib error message handler. The default
2601  * handler simply outputs the message to stderr.
2602  *
2603  * This function will append a new-line character at the end, unlike
2604  * gst_printerr() which will not.
2605  *
2606  * All strings must be in ASCII or UTF-8 encoding.
2607  *
2608  * This function differs from g_printerr() in that it supports the additional
2609  * printf specifiers that are supported by GStreamer's debug logging system,
2610  * such as #GST_PTR_FORMAT and #GST_SEGMENT_FORMAT.
2611  *
2612  * This function is primarily for printing debug output.
2613  *
2614  * Since: 1.12
2615  */
2616 void
2617 gst_printerrln (const gchar * format, ...)
2618 {
2619   va_list args;
2620   gchar *str;
2621
2622   va_start (args, format);
2623   str = gst_info_strdup_vprintf (format, args);
2624   va_end (args);
2625
2626   g_printerr ("%s\n", str);
2627   g_free (str);
2628 }
2629
2630 #ifdef HAVE_UNWIND
2631 #ifdef HAVE_DW
2632 static gboolean
2633 append_debug_info (GString * trace, Dwfl * dwfl, const void *ip)
2634 {
2635   Dwfl_Line *line;
2636   Dwarf_Addr addr;
2637   Dwfl_Module *module;
2638   const gchar *function_name;
2639
2640   if (dwfl_linux_proc_report (dwfl, getpid ()) != 0)
2641     return FALSE;
2642
2643   if (dwfl_report_end (dwfl, NULL, NULL))
2644     return FALSE;
2645
2646   addr = (uintptr_t) ip;
2647   module = dwfl_addrmodule (dwfl, addr);
2648   function_name = dwfl_module_addrname (module, addr);
2649
2650   g_string_append_printf (trace, "%s (", function_name ? function_name : "??");
2651
2652   line = dwfl_getsrc (dwfl, addr);
2653   if (line != NULL) {
2654     gint nline;
2655     Dwarf_Addr addr;
2656     const gchar *filename = dwfl_lineinfo (line, &addr,
2657         &nline, NULL, NULL, NULL);
2658
2659     g_string_append_printf (trace, "%s:%d", strrchr (filename,
2660             G_DIR_SEPARATOR) + 1, nline);
2661   } else {
2662     const gchar *eflfile = NULL;
2663
2664     dwfl_module_info (module, NULL, NULL, NULL, NULL, NULL, &eflfile, NULL);
2665     g_string_append_printf (trace, "%s:%p", eflfile ? eflfile : "??", ip);
2666   }
2667
2668   return TRUE;
2669 }
2670 #endif /* HAVE_DW */
2671
2672 static gchar *
2673 generate_unwind_trace (GstStackTraceFlags flags)
2674 {
2675   gint unret;
2676   unw_context_t uc;
2677   unw_cursor_t cursor;
2678   gboolean use_libunwind = TRUE;
2679   GString *trace = g_string_new (NULL);
2680
2681 #ifdef HAVE_DW
2682   Dwfl *dwfl = NULL;
2683   Dwfl_Callbacks callbacks = {
2684     .find_elf = dwfl_linux_proc_find_elf,
2685     .find_debuginfo = dwfl_standard_find_debuginfo,
2686   };
2687
2688   if ((flags & GST_STACK_TRACE_SHOW_FULL))
2689     dwfl = dwfl_begin (&callbacks);
2690 #endif /* HAVE_DW */
2691
2692   unret = unw_getcontext (&uc);
2693   if (unret) {
2694     GST_DEBUG ("Could not get libunwind context (%d)", unret);
2695
2696     goto done;
2697   }
2698   unret = unw_init_local (&cursor, &uc);
2699   if (unret) {
2700     GST_DEBUG ("Could not init libunwind context (%d)", unret);
2701
2702     goto done;
2703   }
2704
2705   while (unw_step (&cursor) > 0) {
2706 #ifdef HAVE_DW
2707     if (dwfl) {
2708       unw_word_t ip;
2709
2710       unret = unw_get_reg (&cursor, UNW_REG_IP, &ip);
2711       if (unret) {
2712         GST_DEBUG ("libunwind could read frame info (%d)", unret);
2713
2714         goto done;
2715       }
2716
2717       if (append_debug_info (trace, dwfl, (void *) (ip - 4))) {
2718         use_libunwind = FALSE;
2719         g_string_append (trace, ")\n");
2720       }
2721     }
2722 #endif /* HAVE_DW */
2723
2724     if (use_libunwind) {
2725       char name[32];
2726
2727       unw_word_t offset = 0;
2728       unw_get_proc_name (&cursor, name, sizeof (name), &offset);
2729       g_string_append_printf (trace, "%s (0x%" G_GSIZE_FORMAT ")\n", name,
2730           (gsize) offset);
2731     }
2732   }
2733
2734 done:
2735 #ifdef HAVE_DW
2736   if (dwfl)
2737     dwfl_end (dwfl);
2738 #endif
2739
2740   return g_string_free (trace, FALSE);
2741 }
2742
2743 #endif /* HAVE_UNWIND */
2744
2745 #ifdef HAVE_BACKTRACE
2746 static gchar *
2747 generate_backtrace_trace (void)
2748 {
2749   int j, nptrs;
2750   void *buffer[BT_BUF_SIZE];
2751   char **strings;
2752   GString *trace;
2753
2754   trace = g_string_new (NULL);
2755   nptrs = backtrace (buffer, BT_BUF_SIZE);
2756
2757   strings = backtrace_symbols (buffer, nptrs);
2758
2759   if (!strings)
2760     return NULL;
2761
2762   for (j = 0; j < nptrs; j++)
2763     g_string_append_printf (trace, "%s\n", strings[j]);
2764
2765   free (strings);
2766
2767   return g_string_free (trace, FALSE);
2768 }
2769 #else
2770 #define generate_backtrace_trace() NULL
2771 #endif /* HAVE_BACKTRACE */
2772
2773 /**
2774  * gst_debug_get_stack_trace:
2775  * @flags: A set of #GstStackTraceFlags to determine how the stack
2776  * trace should look like. Pass 0 to retrieve a minimal backtrace.
2777  *
2778  * Returns: (nullable): a stack trace, if libunwind or glibc backtrace are
2779  * present, else %NULL.
2780  *
2781  * Since: 1.12
2782  */
2783 gchar *
2784 gst_debug_get_stack_trace (GstStackTraceFlags flags)
2785 {
2786   gchar *trace = NULL;
2787 #ifdef HAVE_BACKTRACE
2788   gboolean have_backtrace = TRUE;
2789 #else
2790   gboolean have_backtrace = FALSE;
2791 #endif
2792
2793 #ifdef HAVE_UNWIND
2794   if ((flags & GST_STACK_TRACE_SHOW_FULL) || !have_backtrace)
2795     trace = generate_unwind_trace (flags);
2796 #endif /* HAVE_UNWIND */
2797
2798   if (trace)
2799     return trace;
2800   else if (have_backtrace)
2801     return generate_backtrace_trace ();
2802
2803   return NULL;
2804 }
2805
2806 /**
2807  * gst_debug_print_stack_trace:
2808  *
2809  * If libunwind or glibc backtrace are present
2810  * a stack trace is printed.
2811  */
2812 void
2813 gst_debug_print_stack_trace (void)
2814 {
2815   gchar *trace = gst_debug_get_stack_trace (GST_STACK_TRACE_SHOW_FULL);
2816
2817   if (trace)
2818     g_print ("%s\n", trace);
2819
2820   g_free (trace);
2821 }
2822
2823 #ifndef GST_DISABLE_GST_DEBUG
2824 typedef struct
2825 {
2826   guint max_size_per_thread;
2827   guint thread_timeout;
2828   GQueue threads;
2829   GHashTable *thread_index;
2830 } GstRingBufferLogger;
2831
2832 typedef struct
2833 {
2834   GList *link;
2835   gint64 last_use;
2836   GThread *thread;
2837
2838   GQueue log;
2839   gsize log_size;
2840 } GstRingBufferLog;
2841
2842 G_LOCK_DEFINE_STATIC (ring_buffer_logger);
2843 static GstRingBufferLogger *ring_buffer_logger = NULL;
2844
2845 static void
2846 gst_ring_buffer_logger_log (GstDebugCategory * category,
2847     GstDebugLevel level,
2848     const gchar * file,
2849     const gchar * function,
2850     gint line, GObject * object, GstDebugMessage * message, gpointer user_data)
2851 {
2852   GstRingBufferLogger *logger = user_data;
2853   gint pid;
2854   GThread *thread;
2855   GstClockTime elapsed;
2856   gchar *obj = NULL;
2857   gchar c;
2858   gchar *output;
2859   gsize output_len;
2860   GstRingBufferLog *log;
2861   gint64 now = g_get_monotonic_time ();
2862   const gchar *message_str = gst_debug_message_get (message);
2863
2864   G_LOCK (ring_buffer_logger);
2865
2866   if (logger->thread_timeout > 0) {
2867     /* Remove all threads that saw no output since thread_timeout seconds.
2868      * By construction these are all at the tail of the queue, and the queue
2869      * is ordered by last use, so we just need to look at the tail.
2870      */
2871     while (logger->threads.tail) {
2872       log = logger->threads.tail->data;
2873       if (log->last_use + logger->thread_timeout * G_USEC_PER_SEC >= now)
2874         break;
2875
2876       g_hash_table_remove (logger->thread_index, log->thread);
2877       while ((output = g_queue_pop_head (&log->log)))
2878         g_free (output);
2879       g_free (log);
2880       g_queue_pop_tail (&logger->threads);
2881     }
2882   }
2883
2884   /* Get logger for this thread, and put it back at the
2885    * head of the threads queue */
2886   thread = g_thread_self ();
2887   log = g_hash_table_lookup (logger->thread_index, thread);
2888   if (!log) {
2889     log = g_new0 (GstRingBufferLog, 1);
2890     g_queue_init (&log->log);
2891     log->log_size = 0;
2892     g_queue_push_head (&logger->threads, log);
2893     log->link = logger->threads.head;
2894     log->thread = thread;
2895     g_hash_table_insert (logger->thread_index, thread, log);
2896   } else {
2897     g_queue_unlink (&logger->threads, log->link);
2898     g_queue_push_head_link (&logger->threads, log->link);
2899   }
2900   log->last_use = now;
2901
2902   /* __FILE__ might be a file name or an absolute path or a
2903    * relative path, irrespective of the exact compiler used,
2904    * in which case we want to shorten it to the filename for
2905    * readability. */
2906   c = file[0];
2907   if (c == '.' || c == '/' || c == '\\' || (c != '\0' && file[1] == ':')) {
2908     file = gst_path_basename (file);
2909   }
2910
2911   pid = getpid ();
2912
2913   if (object) {
2914     obj = gst_debug_print_object (object);
2915   } else {
2916     obj = (gchar *) "";
2917   }
2918
2919   elapsed = GST_CLOCK_DIFF (_priv_gst_start_time, gst_util_get_timestamp ());
2920
2921   /* no color, all platforms */
2922 #define PRINT_FMT " "PID_FMT" "PTR_FMT" %s "CAT_FMT" %s\n"
2923   output =
2924       g_strdup_printf ("%" GST_TIME_FORMAT PRINT_FMT, GST_TIME_ARGS (elapsed),
2925       pid, thread, gst_debug_level_get_name (level),
2926       gst_debug_category_get_name (category), file, line, function, obj,
2927       message_str);
2928 #undef PRINT_FMT
2929
2930   output_len = strlen (output);
2931
2932   if (output_len < logger->max_size_per_thread) {
2933     gchar *buf;
2934
2935     /* While using a GQueue here is not the most efficient thing to do, we
2936      * have to allocate a string for every output anyway and could just store
2937      * that instead of copying it to an actual ringbuffer.
2938      * Better than GQueue would be GstQueueArray, but that one is in
2939      * libgstbase and we can't use it here. That one allocation will not make
2940      * much of a difference anymore, considering the number of allocations
2941      * needed to get to this point...
2942      */
2943     while (log->log_size + output_len > logger->max_size_per_thread) {
2944       buf = g_queue_pop_head (&log->log);
2945       log->log_size -= strlen (buf);
2946       g_free (buf);
2947     }
2948     g_queue_push_tail (&log->log, output);
2949     log->log_size += output_len;
2950   } else {
2951     gchar *buf;
2952
2953     /* Can't really write anything as the line is bigger than the maximum
2954      * allowed log size already, so just remove everything */
2955
2956     while ((buf = g_queue_pop_head (&log->log)))
2957       g_free (buf);
2958     g_free (output);
2959     log->log_size = 0;
2960   }
2961
2962   if (object != NULL)
2963     g_free (obj);
2964
2965   G_UNLOCK (ring_buffer_logger);
2966 }
2967
2968 /**
2969  * gst_debug_ring_buffer_logger_get_logs:
2970  *
2971  * Fetches the current logs per thread from the ring buffer logger. See
2972  * gst_debug_add_ring_buffer_logger() for details.
2973  *
2974  * Returns: (transfer full) (array zero-terminated): NULL-terminated array of
2975  * strings with the debug output per thread
2976  *
2977  * Since: 1.14
2978  */
2979 gchar **
2980 gst_debug_ring_buffer_logger_get_logs (void)
2981 {
2982   gchar **logs, **tmp;
2983   GList *l;
2984
2985   g_return_val_if_fail (ring_buffer_logger != NULL, NULL);
2986
2987   G_LOCK (ring_buffer_logger);
2988
2989   tmp = logs = g_new0 (gchar *, ring_buffer_logger->threads.length + 1);
2990   for (l = ring_buffer_logger->threads.head; l; l = l->next) {
2991     GstRingBufferLog *log = l->data;
2992     GList *l;
2993     gchar *p;
2994     gsize len;
2995
2996     *tmp = p = g_new0 (gchar, log->log_size + 1);
2997
2998     for (l = log->log.head; l; l = l->next) {
2999       len = strlen (l->data);
3000       memcpy (p, l->data, len);
3001       p += len;
3002     }
3003
3004     tmp++;
3005   }
3006
3007   G_UNLOCK (ring_buffer_logger);
3008
3009   return logs;
3010 }
3011
3012 static void
3013 gst_ring_buffer_logger_free (GstRingBufferLogger * logger)
3014 {
3015   G_LOCK (ring_buffer_logger);
3016   if (ring_buffer_logger == logger) {
3017     GstRingBufferLog *log;
3018
3019     while ((log = g_queue_pop_head (&logger->threads))) {
3020       gchar *buf;
3021       while ((buf = g_queue_pop_head (&log->log)))
3022         g_free (buf);
3023       g_free (log);
3024     }
3025
3026     g_hash_table_unref (logger->thread_index);
3027
3028     g_free (logger);
3029     ring_buffer_logger = NULL;
3030   }
3031   G_UNLOCK (ring_buffer_logger);
3032 }
3033
3034 /**
3035  * gst_debug_add_ring_buffer_logger:
3036  * @max_size_per_thread: Maximum size of log per thread in bytes
3037  * @thread_timeout: Timeout for threads in seconds
3038  *
3039  * Adds a memory ringbuffer based debug logger that stores up to
3040  * @max_size_per_thread bytes of logs per thread and times out threads after
3041  * @thread_timeout seconds of inactivity.
3042  *
3043  * Logs can be fetched with gst_debug_ring_buffer_logger_get_logs() and the
3044  * logger can be removed again with gst_debug_remove_ring_buffer_logger().
3045  * Only one logger at a time is possible.
3046  *
3047  * Since: 1.14
3048  */
3049 void
3050 gst_debug_add_ring_buffer_logger (guint max_size_per_thread,
3051     guint thread_timeout)
3052 {
3053   GstRingBufferLogger *logger;
3054
3055   G_LOCK (ring_buffer_logger);
3056
3057   if (ring_buffer_logger) {
3058     g_warn_if_reached ();
3059     G_UNLOCK (ring_buffer_logger);
3060     return;
3061   }
3062
3063   logger = ring_buffer_logger = g_new0 (GstRingBufferLogger, 1);
3064
3065   logger->max_size_per_thread = max_size_per_thread;
3066   logger->thread_timeout = thread_timeout;
3067   logger->thread_index = g_hash_table_new (g_direct_hash, g_direct_equal);
3068   g_queue_init (&logger->threads);
3069
3070   gst_debug_add_log_function (gst_ring_buffer_logger_log, logger,
3071       (GDestroyNotify) gst_ring_buffer_logger_free);
3072   G_UNLOCK (ring_buffer_logger);
3073 }
3074
3075 /**
3076  * gst_debug_remove_ring_buffer_logger:
3077  *
3078  * Removes any previously added ring buffer logger with
3079  * gst_debug_add_ring_buffer_logger().
3080  *
3081  * Since: 1.14
3082  */
3083 void
3084 gst_debug_remove_ring_buffer_logger (void)
3085 {
3086   gst_debug_remove_log_function (gst_ring_buffer_logger_log);
3087 }
3088
3089 #else /* GST_DISABLE_GST_DEBUG */
3090 #ifndef GST_REMOVE_DISABLED
3091
3092 gchar **
3093 gst_debug_ring_buffer_logger_get_logs (void)
3094 {
3095   return NULL;
3096 }
3097
3098 void
3099 gst_debug_add_ring_buffer_logger (guint max_size_per_thread,
3100     guint thread_timeout)
3101 {
3102 }
3103
3104 void
3105 gst_debug_remove_ring_buffer_logger (void)
3106 {
3107 }
3108
3109 #endif /* GST_REMOVE_DISABLED */
3110 #endif /* GST_DISABLE_GST_DEBUG */