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_BLUE, 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   const gchar *message_str;
1141   FILE *log_file = user_data ? user_data : stderr;
1142   gchar c;
1143
1144   /* Get message string first because printing it might call into our custom
1145    * printf format extension mechanism which in turn might log something, e.g.
1146    * from inside gst_structure_to_string() when something can't be serialised.
1147    * This means we either need to do this outside of any critical section or
1148    * use a recursive lock instead. As we always need the message string in all
1149    * code paths, we might just as well get it here first thing and outside of
1150    * the win_print_mutex critical section. */
1151   message_str = gst_debug_message_get (message);
1152
1153   /* __FILE__ might be a file name or an absolute path or a
1154    * relative path, irrespective of the exact compiler used,
1155    * in which case we want to shorten it to the filename for
1156    * readability. */
1157   c = file[0];
1158   if (c == '.' || c == '/' || c == '\\' || (c != '\0' && file[1] == ':')) {
1159     file = gst_path_basename (file);
1160   }
1161
1162   pid = getpid ();
1163   color_mode = gst_debug_get_color_mode ();
1164
1165   if (object) {
1166     obj = gst_debug_print_object (object);
1167   } else {
1168     obj = (gchar *) "";
1169   }
1170
1171   elapsed = GST_CLOCK_DIFF (_priv_gst_start_time, gst_util_get_timestamp ());
1172
1173   if (color_mode != GST_DEBUG_COLOR_MODE_OFF) {
1174 #ifdef G_OS_WIN32
1175     /* We take a lock to keep colors and content together.
1176      * Maybe there is a better way but for now this will do the right
1177      * thing. */
1178     static GMutex win_print_mutex;
1179     g_mutex_lock (&win_print_mutex);
1180     if (color_mode == GST_DEBUG_COLOR_MODE_UNIX) {
1181 #endif
1182       /* colors, non-windows */
1183       gchar *color = NULL;
1184       const gchar *clear;
1185       gchar pidcolor[10];
1186       const gchar *levelcolor;
1187
1188       color = gst_debug_construct_term_color (gst_debug_category_get_color
1189           (category));
1190       clear = "\033[00m";
1191       g_sprintf (pidcolor, "\033[3%1dm", pid % 6 + 31);
1192       levelcolor = levelcolormap[level];
1193
1194 #define PRINT_FMT " %s"PID_FMT"%s "PTR_FMT" %s%s%s %s"CAT_FMT"%s %s\n"
1195       fprintf (log_file, "%" GST_TIME_FORMAT PRINT_FMT, GST_TIME_ARGS (elapsed),
1196           pidcolor, pid, clear, g_thread_self (), levelcolor,
1197           gst_debug_level_get_name (level), clear, color,
1198           gst_debug_category_get_name (category), file, line, function, obj,
1199           clear, message_str);
1200       fflush (log_file);
1201 #undef PRINT_FMT
1202       g_free (color);
1203 #ifdef G_OS_WIN32
1204     } else {
1205       /* colors, windows. */
1206       const gint clear = FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE;
1207 #define SET_COLOR(c) G_STMT_START { \
1208   if (log_file == stderr) \
1209     SetConsoleTextAttribute (GetStdHandle (STD_ERROR_HANDLE), (c)); \
1210   } G_STMT_END
1211       /* timestamp */
1212       fprintf (log_file, "%" GST_TIME_FORMAT " ", GST_TIME_ARGS (elapsed));
1213       fflush (log_file);
1214       /* pid */
1215       SET_COLOR (available_colors[pid % G_N_ELEMENTS (available_colors)]);
1216       fprintf (log_file, PID_FMT, pid);
1217       fflush (log_file);
1218       /* thread */
1219       SET_COLOR (clear);
1220       fprintf (log_file, " " PTR_FMT " ", g_thread_self ());
1221       fflush (log_file);
1222       /* level */
1223       SET_COLOR (levelcolormap_w32[level]);
1224       fprintf (log_file, "%s ", gst_debug_level_get_name (level));
1225       fflush (log_file);
1226       /* category */
1227       SET_COLOR (gst_debug_construct_win_color (gst_debug_category_get_color
1228               (category)));
1229       fprintf (log_file, CAT_FMT, gst_debug_category_get_name (category),
1230           file, line, function, obj);
1231       fflush (log_file);
1232       /* message */
1233       SET_COLOR (clear);
1234       fprintf (log_file, " %s\n", message_str);
1235       fflush (log_file);
1236     }
1237     g_mutex_unlock (&win_print_mutex);
1238 #endif
1239   } else {
1240     /* no color, all platforms */
1241 #define PRINT_FMT " "PID_FMT" "PTR_FMT" %s "CAT_FMT" %s\n"
1242     fprintf (log_file, "%" GST_TIME_FORMAT PRINT_FMT, GST_TIME_ARGS (elapsed),
1243         pid, g_thread_self (), gst_debug_level_get_name (level),
1244         gst_debug_category_get_name (category), file, line, function, obj,
1245         message_str);
1246     fflush (log_file);
1247 #undef PRINT_FMT
1248   }
1249
1250   if (object != NULL)
1251     g_free (obj);
1252 }
1253
1254 /**
1255  * gst_debug_level_get_name:
1256  * @level: the level to get the name for
1257  *
1258  * Get the string representation of a debugging level
1259  *
1260  * Returns: the name
1261  */
1262 const gchar *
1263 gst_debug_level_get_name (GstDebugLevel level)
1264 {
1265   switch (level) {
1266     case GST_LEVEL_NONE:
1267       return "";
1268     case GST_LEVEL_ERROR:
1269       return "ERROR  ";
1270     case GST_LEVEL_WARNING:
1271       return "WARN   ";
1272     case GST_LEVEL_INFO:
1273       return "INFO   ";
1274     case GST_LEVEL_DEBUG:
1275       return "DEBUG  ";
1276     case GST_LEVEL_LOG:
1277       return "LOG    ";
1278     case GST_LEVEL_FIXME:
1279       return "FIXME  ";
1280     case GST_LEVEL_TRACE:
1281       return "TRACE  ";
1282     case GST_LEVEL_MEMDUMP:
1283       return "MEMDUMP";
1284     default:
1285       g_warning ("invalid level specified for gst_debug_level_get_name");
1286       return "";
1287   }
1288 }
1289
1290 /**
1291  * gst_debug_add_log_function:
1292  * @func: the function to use
1293  * @user_data: user data
1294  * @notify: called when @user_data is not used anymore
1295  *
1296  * Adds the logging function to the list of logging functions.
1297  * Be sure to use #G_GNUC_NO_INSTRUMENT on that function, it is needed.
1298  */
1299 void
1300 gst_debug_add_log_function (GstLogFunction func, gpointer user_data,
1301     GDestroyNotify notify)
1302 {
1303   LogFuncEntry *entry;
1304   GSList *list;
1305
1306   if (func == NULL)
1307     func = gst_debug_log_default;
1308
1309   entry = g_slice_new (LogFuncEntry);
1310   entry->func = func;
1311   entry->user_data = user_data;
1312   entry->notify = notify;
1313   /* FIXME: we leak the old list here - other threads might access it right now
1314    * in gst_debug_logv. Another solution is to lock the mutex in gst_debug_logv,
1315    * but that is waaay costly.
1316    * It'd probably be clever to use some kind of RCU here, but I don't know
1317    * anything about that.
1318    */
1319   g_mutex_lock (&__log_func_mutex);
1320   list = g_slist_copy (__log_functions);
1321   __log_functions = g_slist_prepend (list, entry);
1322   g_mutex_unlock (&__log_func_mutex);
1323
1324   if (gst_is_initialized ())
1325     GST_DEBUG ("prepended log function %p (user data %p) to log functions",
1326         func, user_data);
1327 }
1328
1329 static gint
1330 gst_debug_compare_log_function_by_func (gconstpointer entry, gconstpointer func)
1331 {
1332   gpointer entryfunc = (gpointer) (((LogFuncEntry *) entry)->func);
1333
1334   return (entryfunc < func) ? -1 : (entryfunc > func) ? 1 : 0;
1335 }
1336
1337 static gint
1338 gst_debug_compare_log_function_by_data (gconstpointer entry, gconstpointer data)
1339 {
1340   gpointer entrydata = ((LogFuncEntry *) entry)->user_data;
1341
1342   return (entrydata < data) ? -1 : (entrydata > data) ? 1 : 0;
1343 }
1344
1345 static guint
1346 gst_debug_remove_with_compare_func (GCompareFunc func, gpointer data)
1347 {
1348   GSList *found;
1349   GSList *new, *cleanup = NULL;
1350   guint removals = 0;
1351
1352   g_mutex_lock (&__log_func_mutex);
1353   new = __log_functions;
1354   cleanup = NULL;
1355   while ((found = g_slist_find_custom (new, data, func))) {
1356     if (new == __log_functions) {
1357       /* make a copy when we have the first hit, so that we modify the copy and
1358        * make that the new list later */
1359       new = g_slist_copy (new);
1360       continue;
1361     }
1362     cleanup = g_slist_prepend (cleanup, found->data);
1363     new = g_slist_delete_link (new, found);
1364     removals++;
1365   }
1366   /* FIXME: We leak the old list here. See _add_log_function for why. */
1367   __log_functions = new;
1368   g_mutex_unlock (&__log_func_mutex);
1369
1370   while (cleanup) {
1371     LogFuncEntry *entry = cleanup->data;
1372
1373     if (entry->notify)
1374       entry->notify (entry->user_data);
1375
1376     g_slice_free (LogFuncEntry, entry);
1377     cleanup = g_slist_delete_link (cleanup, cleanup);
1378   }
1379   return removals;
1380 }
1381
1382 /**
1383  * gst_debug_remove_log_function:
1384  * @func: (scope call) (allow-none): the log function to remove, or %NULL to
1385  *     remove the default log function
1386  *
1387  * Removes all registered instances of the given logging functions.
1388  *
1389  * Returns: How many instances of the function were removed
1390  */
1391 guint
1392 gst_debug_remove_log_function (GstLogFunction func)
1393 {
1394   guint removals;
1395
1396   if (func == NULL)
1397     func = gst_debug_log_default;
1398
1399   removals =
1400       gst_debug_remove_with_compare_func
1401       (gst_debug_compare_log_function_by_func, (gpointer) func);
1402
1403   if (gst_is_initialized ()) {
1404     GST_DEBUG ("removed log function %p %d times from log function list", func,
1405         removals);
1406   } else {
1407     /* If the default log function is removed before gst_init() was called,
1408      * set a flag so we don't add it in gst_init() later */
1409     if (func == gst_debug_log_default) {
1410       add_default_log_func = FALSE;
1411       ++removals;
1412     }
1413   }
1414
1415   return removals;
1416 }
1417
1418 /**
1419  * gst_debug_remove_log_function_by_data:
1420  * @data: user data of the log function to remove
1421  *
1422  * Removes all registered instances of log functions with the given user data.
1423  *
1424  * Returns: How many instances of the function were removed
1425  */
1426 guint
1427 gst_debug_remove_log_function_by_data (gpointer data)
1428 {
1429   guint removals;
1430
1431   removals =
1432       gst_debug_remove_with_compare_func
1433       (gst_debug_compare_log_function_by_data, data);
1434
1435   if (gst_is_initialized ())
1436     GST_DEBUG
1437         ("removed %d log functions with user data %p from log function list",
1438         removals, data);
1439
1440   return removals;
1441 }
1442
1443 /**
1444  * gst_debug_set_colored:
1445  * @colored: Whether to use colored output or not
1446  *
1447  * Sets or unsets the use of coloured debugging output.
1448  * Same as gst_debug_set_color_mode () with the argument being
1449  * being GST_DEBUG_COLOR_MODE_ON or GST_DEBUG_COLOR_MODE_OFF.
1450  *
1451  * This function may be called before gst_init().
1452  */
1453 void
1454 gst_debug_set_colored (gboolean colored)
1455 {
1456   GstDebugColorMode new_mode;
1457   new_mode = colored ? GST_DEBUG_COLOR_MODE_ON : GST_DEBUG_COLOR_MODE_OFF;
1458   g_atomic_int_set (&__use_color, (gint) new_mode);
1459 }
1460
1461 /**
1462  * gst_debug_set_color_mode:
1463  * @mode: The coloring mode for debug output. See @GstDebugColorMode.
1464  *
1465  * Changes the coloring mode for debug output.
1466  *
1467  * This function may be called before gst_init().
1468  *
1469  * Since: 1.2
1470  */
1471 void
1472 gst_debug_set_color_mode (GstDebugColorMode mode)
1473 {
1474   g_atomic_int_set (&__use_color, mode);
1475 }
1476
1477 /**
1478  * gst_debug_set_color_mode_from_string:
1479  * @mode: The coloring mode for debug output. One of the following:
1480  * "on", "auto", "off", "disable", "unix".
1481  *
1482  * Changes the coloring mode for debug output.
1483  *
1484  * This function may be called before gst_init().
1485  *
1486  * Since: 1.2
1487  */
1488 void
1489 gst_debug_set_color_mode_from_string (const gchar * mode)
1490 {
1491   if ((strcmp (mode, "on") == 0) || (strcmp (mode, "auto") == 0))
1492     gst_debug_set_color_mode (GST_DEBUG_COLOR_MODE_ON);
1493   else if ((strcmp (mode, "off") == 0) || (strcmp (mode, "disable") == 0))
1494     gst_debug_set_color_mode (GST_DEBUG_COLOR_MODE_OFF);
1495   else if (strcmp (mode, "unix") == 0)
1496     gst_debug_set_color_mode (GST_DEBUG_COLOR_MODE_UNIX);
1497 }
1498
1499 /**
1500  * gst_debug_is_colored:
1501  *
1502  * Checks if the debugging output should be colored.
1503  *
1504  * Returns: %TRUE, if the debug output should be colored.
1505  */
1506 gboolean
1507 gst_debug_is_colored (void)
1508 {
1509   GstDebugColorMode mode = g_atomic_int_get (&__use_color);
1510   return (mode == GST_DEBUG_COLOR_MODE_UNIX || mode == GST_DEBUG_COLOR_MODE_ON);
1511 }
1512
1513 /**
1514  * gst_debug_get_color_mode:
1515  *
1516  * Changes the coloring mode for debug output.
1517  *
1518  * Returns: see @GstDebugColorMode for possible values.
1519  *
1520  * Since: 1.2
1521  */
1522 GstDebugColorMode
1523 gst_debug_get_color_mode (void)
1524 {
1525   return g_atomic_int_get (&__use_color);
1526 }
1527
1528 /**
1529  * gst_debug_set_active:
1530  * @active: Whether to use debugging output or not
1531  *
1532  * If activated, debugging messages are sent to the debugging
1533  * handlers.
1534  * It makes sense to deactivate it for speed issues.
1535  * > This function is not threadsafe. It makes sense to only call it
1536  * during initialization.
1537  */
1538 void
1539 gst_debug_set_active (gboolean active)
1540 {
1541   _gst_debug_enabled = active;
1542   if (active)
1543     _gst_debug_min = GST_LEVEL_COUNT;
1544   else
1545     _gst_debug_min = GST_LEVEL_NONE;
1546 }
1547
1548 /**
1549  * gst_debug_is_active:
1550  *
1551  * Checks if debugging output is activated.
1552  *
1553  * Returns: %TRUE, if debugging is activated
1554  */
1555 gboolean
1556 gst_debug_is_active (void)
1557 {
1558   return _gst_debug_enabled;
1559 }
1560
1561 /**
1562  * gst_debug_set_default_threshold:
1563  * @level: level to set
1564  *
1565  * Sets the default threshold to the given level and updates all categories to
1566  * use this threshold.
1567  *
1568  * This function may be called before gst_init().
1569  */
1570 void
1571 gst_debug_set_default_threshold (GstDebugLevel level)
1572 {
1573   g_atomic_int_set (&__default_level, level);
1574   gst_debug_reset_all_thresholds ();
1575 }
1576
1577 /**
1578  * gst_debug_get_default_threshold:
1579  *
1580  * Returns the default threshold that is used for new categories.
1581  *
1582  * Returns: the default threshold level
1583  */
1584 GstDebugLevel
1585 gst_debug_get_default_threshold (void)
1586 {
1587   return (GstDebugLevel) g_atomic_int_get (&__default_level);
1588 }
1589
1590 static gboolean
1591 gst_debug_apply_entry (GstDebugCategory * cat, LevelNameEntry * entry)
1592 {
1593   if (!g_pattern_match_string (entry->pat, cat->name))
1594     return FALSE;
1595
1596   if (gst_is_initialized ())
1597     GST_LOG ("category %s matches pattern %p - gets set to level %d",
1598         cat->name, entry->pat, entry->level);
1599
1600   gst_debug_category_set_threshold (cat, entry->level);
1601   return TRUE;
1602 }
1603
1604 static void
1605 gst_debug_reset_threshold (gpointer category, gpointer unused)
1606 {
1607   GstDebugCategory *cat = (GstDebugCategory *) category;
1608   GSList *walk;
1609
1610   g_mutex_lock (&__level_name_mutex);
1611
1612   for (walk = __level_name; walk != NULL; walk = walk->next) {
1613     if (gst_debug_apply_entry (cat, walk->data))
1614       break;
1615   }
1616
1617   g_mutex_unlock (&__level_name_mutex);
1618
1619   if (walk == NULL)
1620     gst_debug_category_set_threshold (cat, gst_debug_get_default_threshold ());
1621 }
1622
1623 static void
1624 gst_debug_reset_all_thresholds (void)
1625 {
1626   g_mutex_lock (&__cat_mutex);
1627   g_slist_foreach (__categories, gst_debug_reset_threshold, NULL);
1628   g_mutex_unlock (&__cat_mutex);
1629 }
1630
1631 static void
1632 for_each_threshold_by_entry (gpointer data, gpointer user_data)
1633 {
1634   GstDebugCategory *cat = (GstDebugCategory *) data;
1635   LevelNameEntry *entry = (LevelNameEntry *) user_data;
1636
1637   gst_debug_apply_entry (cat, entry);
1638 }
1639
1640 /**
1641  * gst_debug_set_threshold_for_name:
1642  * @name: name of the categories to set
1643  * @level: level to set them to
1644  *
1645  * Sets all categories which match the given glob style pattern to the given
1646  * level.
1647  */
1648 void
1649 gst_debug_set_threshold_for_name (const gchar * name, GstDebugLevel level)
1650 {
1651   GPatternSpec *pat;
1652   LevelNameEntry *entry;
1653
1654   g_return_if_fail (name != NULL);
1655
1656   pat = g_pattern_spec_new (name);
1657   entry = g_slice_new (LevelNameEntry);
1658   entry->pat = pat;
1659   entry->level = level;
1660   g_mutex_lock (&__level_name_mutex);
1661   __level_name = g_slist_prepend (__level_name, entry);
1662   g_mutex_unlock (&__level_name_mutex);
1663   g_mutex_lock (&__cat_mutex);
1664   g_slist_foreach (__categories, for_each_threshold_by_entry, entry);
1665   g_mutex_unlock (&__cat_mutex);
1666 }
1667
1668 /**
1669  * gst_debug_unset_threshold_for_name:
1670  * @name: name of the categories to set
1671  *
1672  * Resets all categories with the given name back to the default level.
1673  */
1674 void
1675 gst_debug_unset_threshold_for_name (const gchar * name)
1676 {
1677   GSList *walk;
1678   GPatternSpec *pat;
1679
1680   g_return_if_fail (name != NULL);
1681
1682   pat = g_pattern_spec_new (name);
1683   g_mutex_lock (&__level_name_mutex);
1684   walk = __level_name;
1685   /* improve this if you want, it's mighty slow */
1686   while (walk) {
1687     LevelNameEntry *entry = walk->data;
1688
1689     if (g_pattern_spec_equal (entry->pat, pat)) {
1690       __level_name = g_slist_remove_link (__level_name, walk);
1691       g_pattern_spec_free (entry->pat);
1692       g_slice_free (LevelNameEntry, entry);
1693       g_slist_free_1 (walk);
1694       walk = __level_name;
1695     } else {
1696       walk = g_slist_next (walk);
1697     }
1698   }
1699   g_mutex_unlock (&__level_name_mutex);
1700   g_pattern_spec_free (pat);
1701   gst_debug_reset_all_thresholds ();
1702 }
1703
1704 GstDebugCategory *
1705 _gst_debug_category_new (const gchar * name, guint color,
1706     const gchar * description)
1707 {
1708   GstDebugCategory *cat, *catfound;
1709
1710   g_return_val_if_fail (name != NULL, NULL);
1711
1712   cat = g_slice_new (GstDebugCategory);
1713   cat->name = g_strdup (name);
1714   cat->color = color;
1715   if (description != NULL) {
1716     cat->description = g_strdup (description);
1717   } else {
1718     cat->description = g_strdup ("no description");
1719   }
1720   g_atomic_int_set (&cat->threshold, 0);
1721   gst_debug_reset_threshold (cat, NULL);
1722
1723   /* add to category list */
1724   g_mutex_lock (&__cat_mutex);
1725   catfound = _gst_debug_get_category_locked (name);
1726   if (catfound) {
1727     g_free ((gpointer) cat->name);
1728     g_free ((gpointer) cat->description);
1729     g_slice_free (GstDebugCategory, cat);
1730     cat = catfound;
1731   } else {
1732     __categories = g_slist_prepend (__categories, cat);
1733   }
1734   g_mutex_unlock (&__cat_mutex);
1735
1736   return cat;
1737 }
1738
1739 /**
1740  * gst_debug_category_free:
1741  * @category: #GstDebugCategory to free.
1742  *
1743  * Removes and frees the category and all associated resources.
1744  */
1745 void
1746 gst_debug_category_free (GstDebugCategory * category)
1747 {
1748   if (category == NULL)
1749     return;
1750
1751   /* remove from category list */
1752   g_mutex_lock (&__cat_mutex);
1753   __categories = g_slist_remove (__categories, category);
1754   g_mutex_unlock (&__cat_mutex);
1755
1756   g_free ((gpointer) category->name);
1757   g_free ((gpointer) category->description);
1758   g_slice_free (GstDebugCategory, category);
1759 }
1760
1761 /**
1762  * gst_debug_category_set_threshold:
1763  * @category: a #GstDebugCategory to set threshold of.
1764  * @level: the #GstDebugLevel threshold to set.
1765  *
1766  * Sets the threshold of the category to the given level. Debug information will
1767  * only be output if the threshold is lower or equal to the level of the
1768  * debugging message.
1769  * > Do not use this function in production code, because other functions may
1770  * > change the threshold of categories as side effect. It is however a nice
1771  * > function to use when debugging (even from gdb).
1772  */
1773 void
1774 gst_debug_category_set_threshold (GstDebugCategory * category,
1775     GstDebugLevel level)
1776 {
1777   g_return_if_fail (category != NULL);
1778
1779   if (level > _gst_debug_min) {
1780     _gst_debug_enabled = TRUE;
1781     _gst_debug_min = level;
1782   }
1783
1784   g_atomic_int_set (&category->threshold, level);
1785 }
1786
1787 /**
1788  * gst_debug_category_reset_threshold:
1789  * @category: a #GstDebugCategory to reset threshold of.
1790  *
1791  * Resets the threshold of the category to the default level. Debug information
1792  * will only be output if the threshold is lower or equal to the level of the
1793  * debugging message.
1794  * Use this function to set the threshold back to where it was after using
1795  * gst_debug_category_set_threshold().
1796  */
1797 void
1798 gst_debug_category_reset_threshold (GstDebugCategory * category)
1799 {
1800   gst_debug_reset_threshold (category, NULL);
1801 }
1802
1803 /**
1804  * gst_debug_category_get_threshold:
1805  * @category: a #GstDebugCategory to get threshold of.
1806  *
1807  * Returns the threshold of a #GstDebugCategory.
1808  *
1809  * Returns: the #GstDebugLevel that is used as threshold.
1810  */
1811 GstDebugLevel
1812 gst_debug_category_get_threshold (GstDebugCategory * category)
1813 {
1814   return (GstDebugLevel) g_atomic_int_get (&category->threshold);
1815 }
1816
1817 /**
1818  * gst_debug_category_get_name:
1819  * @category: a #GstDebugCategory to get name of.
1820  *
1821  * Returns the name of a debug category.
1822  *
1823  * Returns: the name of the category.
1824  */
1825 const gchar *
1826 gst_debug_category_get_name (GstDebugCategory * category)
1827 {
1828   return category->name;
1829 }
1830
1831 /**
1832  * gst_debug_category_get_color:
1833  * @category: a #GstDebugCategory to get the color of.
1834  *
1835  * Returns the color of a debug category used when printing output in this
1836  * category.
1837  *
1838  * Returns: the color of the category.
1839  */
1840 guint
1841 gst_debug_category_get_color (GstDebugCategory * category)
1842 {
1843   return category->color;
1844 }
1845
1846 /**
1847  * gst_debug_category_get_description:
1848  * @category: a #GstDebugCategory to get the description of.
1849  *
1850  * Returns the description of a debug category.
1851  *
1852  * Returns: the description of the category.
1853  */
1854 const gchar *
1855 gst_debug_category_get_description (GstDebugCategory * category)
1856 {
1857   return category->description;
1858 }
1859
1860 /**
1861  * gst_debug_get_all_categories:
1862  *
1863  * Returns a snapshot of a all categories that are currently in use . This list
1864  * may change anytime.
1865  * The caller has to free the list after use.
1866  *
1867  * Returns: (transfer container) (element-type Gst.DebugCategory): the list of
1868  *     debug categories
1869  */
1870 GSList *
1871 gst_debug_get_all_categories (void)
1872 {
1873   GSList *ret;
1874
1875   g_mutex_lock (&__cat_mutex);
1876   ret = g_slist_copy (__categories);
1877   g_mutex_unlock (&__cat_mutex);
1878
1879   return ret;
1880 }
1881
1882 static GstDebugCategory *
1883 _gst_debug_get_category_locked (const gchar * name)
1884 {
1885   GstDebugCategory *ret = NULL;
1886   GSList *node;
1887
1888   for (node = __categories; node; node = g_slist_next (node)) {
1889     ret = (GstDebugCategory *) node->data;
1890     if (!strcmp (name, ret->name)) {
1891       return ret;
1892     }
1893   }
1894   return NULL;
1895 }
1896
1897 GstDebugCategory *
1898 _gst_debug_get_category (const gchar * name)
1899 {
1900   GstDebugCategory *ret;
1901
1902   g_mutex_lock (&__cat_mutex);
1903   ret = _gst_debug_get_category_locked (name);
1904   g_mutex_unlock (&__cat_mutex);
1905
1906   return ret;
1907 }
1908
1909 static gboolean
1910 parse_debug_category (gchar * str, const gchar ** category)
1911 {
1912   if (!str)
1913     return FALSE;
1914
1915   /* works in place */
1916   g_strstrip (str);
1917
1918   if (str[0] != '\0') {
1919     *category = str;
1920     return TRUE;
1921   }
1922
1923   return FALSE;
1924 }
1925
1926 static gboolean
1927 parse_debug_level (gchar * str, GstDebugLevel * level)
1928 {
1929   if (!str)
1930     return FALSE;
1931
1932   /* works in place */
1933   g_strstrip (str);
1934
1935   if (g_ascii_isdigit (str[0])) {
1936     unsigned long l;
1937     char *endptr;
1938     l = strtoul (str, &endptr, 10);
1939     if (endptr > str && endptr[0] == 0) {
1940       *level = (GstDebugLevel) l;
1941     } else {
1942       return FALSE;
1943     }
1944   } else if (strcmp (str, "ERROR") == 0) {
1945     *level = GST_LEVEL_ERROR;
1946   } else if (strncmp (str, "WARN", 4) == 0) {
1947     *level = GST_LEVEL_WARNING;
1948   } else if (strcmp (str, "FIXME") == 0) {
1949     *level = GST_LEVEL_FIXME;
1950   } else if (strcmp (str, "INFO") == 0) {
1951     *level = GST_LEVEL_INFO;
1952   } else if (strcmp (str, "DEBUG") == 0) {
1953     *level = GST_LEVEL_DEBUG;
1954   } else if (strcmp (str, "LOG") == 0) {
1955     *level = GST_LEVEL_LOG;
1956   } else if (strcmp (str, "TRACE") == 0) {
1957     *level = GST_LEVEL_TRACE;
1958   } else if (strcmp (str, "MEMDUMP") == 0) {
1959     *level = GST_LEVEL_MEMDUMP;
1960   } else
1961     return FALSE;
1962
1963   return TRUE;
1964 }
1965
1966 /**
1967  * gst_debug_set_threshold_from_string:
1968  * @list: comma-separated list of "category:level" pairs to be used
1969  *     as debug logging levels
1970  * @reset: %TRUE to clear all previously-set debug levels before setting
1971  *     new thresholds
1972  * %FALSE if adding the threshold described by @list to the one already set.
1973  *
1974  * Sets the debug logging wanted in the same form as with the GST_DEBUG
1975  * environment variable. You can use wildcards such as '*', but note that
1976  * the order matters when you use wild cards, e.g. "foosrc:6,*src:3,*:2" sets
1977  * everything to log level 2.
1978  *
1979  * Since: 1.2
1980  */
1981 void
1982 gst_debug_set_threshold_from_string (const gchar * list, gboolean reset)
1983 {
1984   gchar **split;
1985   gchar **walk;
1986
1987   g_assert (list);
1988
1989   if (reset)
1990     gst_debug_set_default_threshold (GST_LEVEL_DEFAULT);
1991
1992   split = g_strsplit (list, ",", 0);
1993
1994   for (walk = split; *walk; walk++) {
1995     if (strchr (*walk, ':')) {
1996       gchar **values = g_strsplit (*walk, ":", 2);
1997
1998       if (values[0] && values[1]) {
1999         GstDebugLevel level;
2000         const gchar *category;
2001
2002         if (parse_debug_category (values[0], &category)
2003             && parse_debug_level (values[1], &level)) {
2004           gst_debug_set_threshold_for_name (category, level);
2005
2006           /* bump min-level anyway to allow the category to be registered in the
2007            * future still */
2008           if (level > _gst_debug_min) {
2009             _gst_debug_min = level;
2010           }
2011         }
2012       }
2013
2014       g_strfreev (values);
2015     } else {
2016       GstDebugLevel level;
2017
2018       if (parse_debug_level (*walk, &level))
2019         gst_debug_set_default_threshold (level);
2020     }
2021   }
2022
2023   g_strfreev (split);
2024 }
2025
2026 /*** FUNCTION POINTERS ********************************************************/
2027
2028 static GHashTable *__gst_function_pointers;     /* NULL */
2029 static GMutex __dbg_functions_mutex;
2030
2031 /* This function MUST NOT return NULL */
2032 const gchar *
2033 _gst_debug_nameof_funcptr (GstDebugFuncPtr func)
2034 {
2035   gchar *ptrname;
2036
2037 #ifdef HAVE_DLADDR
2038   Dl_info dl_info;
2039 #endif
2040
2041   if (G_UNLIKELY (func == NULL))
2042     return "(NULL)";
2043
2044   g_mutex_lock (&__dbg_functions_mutex);
2045   if (G_LIKELY (__gst_function_pointers)) {
2046     ptrname = g_hash_table_lookup (__gst_function_pointers, (gpointer) func);
2047     g_mutex_unlock (&__dbg_functions_mutex);
2048     if (G_LIKELY (ptrname))
2049       return ptrname;
2050   } else {
2051     g_mutex_unlock (&__dbg_functions_mutex);
2052   }
2053   /* we need to create an entry in the hash table for this one so we don't leak
2054    * the name */
2055 #ifdef HAVE_DLADDR
2056   if (dladdr ((gpointer) func, &dl_info) && dl_info.dli_sname) {
2057     gchar *name = g_strdup (dl_info.dli_sname);
2058
2059     _gst_debug_register_funcptr (func, name);
2060     return name;
2061   } else
2062 #endif
2063   {
2064     gchar *name = g_strdup_printf ("%p", (gpointer) func);
2065
2066     _gst_debug_register_funcptr (func, name);
2067     return name;
2068   }
2069 }
2070
2071 void
2072 _gst_debug_register_funcptr (GstDebugFuncPtr func, const gchar * ptrname)
2073 {
2074   gpointer ptr = (gpointer) func;
2075
2076   g_mutex_lock (&__dbg_functions_mutex);
2077
2078   if (!__gst_function_pointers)
2079     __gst_function_pointers = g_hash_table_new (g_direct_hash, g_direct_equal);
2080   if (!g_hash_table_lookup (__gst_function_pointers, ptr))
2081     g_hash_table_insert (__gst_function_pointers, ptr, (gpointer) ptrname);
2082
2083   g_mutex_unlock (&__dbg_functions_mutex);
2084 }
2085
2086 static void
2087 gst_info_dump_mem_line (gchar * linebuf, gsize linebuf_size,
2088     const guint8 * mem, gsize mem_offset, gsize mem_size)
2089 {
2090   gchar hexstr[50], ascstr[18], digitstr[4];
2091
2092   if (mem_size > 16)
2093     mem_size = 16;
2094
2095   hexstr[0] = '\0';
2096   ascstr[0] = '\0';
2097
2098   if (mem != NULL) {
2099     guint i = 0;
2100
2101     mem += mem_offset;
2102     while (i < mem_size) {
2103       ascstr[i] = (g_ascii_isprint (mem[i])) ? mem[i] : '.';
2104       g_snprintf (digitstr, sizeof (digitstr), "%02x ", mem[i]);
2105       g_strlcat (hexstr, digitstr, sizeof (hexstr));
2106       ++i;
2107     }
2108     ascstr[i] = '\0';
2109   }
2110
2111   g_snprintf (linebuf, linebuf_size, "%08x: %-48.48s %-16.16s",
2112       (guint) mem_offset, hexstr, ascstr);
2113 }
2114
2115 void
2116 _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
2117     const gchar * func, gint line, GObject * obj, const gchar * msg,
2118     const guint8 * data, guint length)
2119 {
2120   guint off = 0;
2121
2122   gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "--------"
2123       "-------------------------------------------------------------------");
2124
2125   if (msg != NULL && *msg != '\0') {
2126     gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "%s", msg);
2127   }
2128
2129   while (off < length) {
2130     gchar buf[128];
2131
2132     /* gst_info_dump_mem_line will process 16 bytes at most */
2133     gst_info_dump_mem_line (buf, sizeof (buf), data, off, length - off);
2134     gst_debug_log (cat, GST_LEVEL_MEMDUMP, file, func, line, obj, "%s", buf);
2135     off += 16;
2136   }
2137
2138   gst_debug_log ((cat), GST_LEVEL_MEMDUMP, file, func, line, obj, "--------"
2139       "-------------------------------------------------------------------");
2140 }
2141
2142 #else /* !GST_DISABLE_GST_DEBUG */
2143 #ifndef GST_REMOVE_DISABLED
2144
2145 GstDebugCategory *
2146 _gst_debug_category_new (const gchar * name, guint color,
2147     const gchar * description)
2148 {
2149   return NULL;
2150 }
2151
2152 void
2153 _gst_debug_register_funcptr (GstDebugFuncPtr func, const gchar * ptrname)
2154 {
2155 }
2156
2157 /* This function MUST NOT return NULL */
2158 const gchar *
2159 _gst_debug_nameof_funcptr (GstDebugFuncPtr func)
2160 {
2161   return "(NULL)";
2162 }
2163
2164 void
2165 gst_debug_log (GstDebugCategory * category, GstDebugLevel level,
2166     const gchar * file, const gchar * function, gint line,
2167     GObject * object, const gchar * format, ...)
2168 {
2169 }
2170
2171 void
2172 gst_debug_log_valist (GstDebugCategory * category, GstDebugLevel level,
2173     const gchar * file, const gchar * function, gint line,
2174     GObject * object, const gchar * format, va_list args)
2175 {
2176 }
2177
2178 const gchar *
2179 gst_debug_message_get (GstDebugMessage * message)
2180 {
2181   return "";
2182 }
2183
2184 void
2185 gst_debug_log_default (GstDebugCategory * category, GstDebugLevel level,
2186     const gchar * file, const gchar * function, gint line,
2187     GObject * object, GstDebugMessage * message, gpointer unused)
2188 {
2189 }
2190
2191 const gchar *
2192 gst_debug_level_get_name (GstDebugLevel level)
2193 {
2194   return "NONE";
2195 }
2196
2197 void
2198 gst_debug_add_log_function (GstLogFunction func, gpointer user_data,
2199     GDestroyNotify notify)
2200 {
2201 }
2202
2203 guint
2204 gst_debug_remove_log_function (GstLogFunction func)
2205 {
2206   return 0;
2207 }
2208
2209 guint
2210 gst_debug_remove_log_function_by_data (gpointer data)
2211 {
2212   return 0;
2213 }
2214
2215 void
2216 gst_debug_set_active (gboolean active)
2217 {
2218 }
2219
2220 gboolean
2221 gst_debug_is_active (void)
2222 {
2223   return FALSE;
2224 }
2225
2226 void
2227 gst_debug_set_colored (gboolean colored)
2228 {
2229 }
2230
2231 void
2232 gst_debug_set_color_mode (GstDebugColorMode mode)
2233 {
2234 }
2235
2236 void
2237 gst_debug_set_color_mode_from_string (const gchar * str)
2238 {
2239 }
2240
2241 gboolean
2242 gst_debug_is_colored (void)
2243 {
2244   return FALSE;
2245 }
2246
2247 GstDebugColorMode
2248 gst_debug_get_color_mode (void)
2249 {
2250   return GST_DEBUG_COLOR_MODE_OFF;
2251 }
2252
2253 void
2254 gst_debug_set_threshold_from_string (const gchar * list, gboolean reset)
2255 {
2256 }
2257
2258 void
2259 gst_debug_set_default_threshold (GstDebugLevel level)
2260 {
2261 }
2262
2263 GstDebugLevel
2264 gst_debug_get_default_threshold (void)
2265 {
2266   return GST_LEVEL_NONE;
2267 }
2268
2269 void
2270 gst_debug_set_threshold_for_name (const gchar * name, GstDebugLevel level)
2271 {
2272 }
2273
2274 void
2275 gst_debug_unset_threshold_for_name (const gchar * name)
2276 {
2277 }
2278
2279 void
2280 gst_debug_category_free (GstDebugCategory * category)
2281 {
2282 }
2283
2284 void
2285 gst_debug_category_set_threshold (GstDebugCategory * category,
2286     GstDebugLevel level)
2287 {
2288 }
2289
2290 void
2291 gst_debug_category_reset_threshold (GstDebugCategory * category)
2292 {
2293 }
2294
2295 GstDebugLevel
2296 gst_debug_category_get_threshold (GstDebugCategory * category)
2297 {
2298   return GST_LEVEL_NONE;
2299 }
2300
2301 const gchar *
2302 gst_debug_category_get_name (GstDebugCategory * category)
2303 {
2304   return "";
2305 }
2306
2307 guint
2308 gst_debug_category_get_color (GstDebugCategory * category)
2309 {
2310   return 0;
2311 }
2312
2313 const gchar *
2314 gst_debug_category_get_description (GstDebugCategory * category)
2315 {
2316   return "";
2317 }
2318
2319 GSList *
2320 gst_debug_get_all_categories (void)
2321 {
2322   return NULL;
2323 }
2324
2325 GstDebugCategory *
2326 _gst_debug_get_category (const gchar * name)
2327 {
2328   return NULL;
2329 }
2330
2331 gchar *
2332 gst_debug_construct_term_color (guint colorinfo)
2333 {
2334   return g_strdup ("00");
2335 }
2336
2337 gint
2338 gst_debug_construct_win_color (guint colorinfo)
2339 {
2340   return 0;
2341 }
2342
2343 gboolean
2344 _priv_gst_in_valgrind (void)
2345 {
2346   return FALSE;
2347 }
2348
2349 void
2350 _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
2351     const gchar * func, gint line, GObject * obj, const gchar * msg,
2352     const guint8 * data, guint length)
2353 {
2354 }
2355 #endif /* GST_REMOVE_DISABLED */
2356 #endif /* GST_DISABLE_GST_DEBUG */
2357
2358 /* Need this for _gst_element_error_printf even if GST_REMOVE_DISABLED is set:
2359  * fallback function that cleans up the format string and replaces all pointer
2360  * extension formats with plain %p. */
2361 #ifdef GST_DISABLE_GST_DEBUG
2362 int
2363 __gst_info_fallback_vasprintf (char **result, char const *format, va_list args)
2364 {
2365   gchar *clean_format, *c;
2366   gsize len;
2367
2368   if (format == NULL)
2369     return -1;
2370
2371   clean_format = g_strdup (format);
2372   c = clean_format;
2373   while ((c = strstr (c, "%p\a"))) {
2374     if (c[3] < 'A' || c[3] > 'Z') {
2375       c += 3;
2376       continue;
2377     }
2378     len = strlen (c + 4);
2379     memmove (c + 2, c + 4, len + 1);
2380     c += 2;
2381   }
2382   while ((c = strstr (clean_format, "%P")))     /* old GST_PTR_FORMAT */
2383     c[1] = 'p';
2384   while ((c = strstr (clean_format, "%Q")))     /* old GST_SEGMENT_FORMAT */
2385     c[1] = 'p';
2386
2387   len = g_vasprintf (result, clean_format, args);
2388
2389   g_free (clean_format);
2390
2391   if (*result == NULL)
2392     return -1;
2393
2394   return len;
2395 }
2396 #endif
2397
2398 /**
2399  * gst_info_vasprintf:
2400  * @result: (out): the resulting string
2401  * @format: a printf style format string
2402  * @args: the va_list of printf arguments for @format
2403  *
2404  * Allocates and fills a string large enough (including the terminating null
2405  * byte) to hold the specified printf style @format and @args.
2406  *
2407  * This function deals with the GStreamer specific printf specifiers
2408  * #GST_PTR_FORMAT and #GST_SEGMENT_FORMAT.  If you do not have these specifiers
2409  * in your @format string, you do not need to use this function and can use
2410  * alternatives such as g_vasprintf().
2411  *
2412  * Free @result with g_free().
2413  *
2414  * Returns: the length of the string allocated into @result or -1 on any error
2415  *
2416  * Since: 1.8
2417  */
2418 gint
2419 gst_info_vasprintf (gchar ** result, const gchar * format, va_list args)
2420 {
2421   /* This will fallback to __gst_info_fallback_vasprintf() via a #define in
2422    * gst_private.h if the debug system is disabled which will remove the gst
2423    * specific printf format specifiers */
2424   return __gst_vasprintf (result, format, args);
2425 }
2426
2427 /**
2428  * gst_info_strdup_vprintf:
2429  * @format: a printf style format string
2430  * @args: the va_list of printf arguments for @format
2431  *
2432  * Allocates, fills and returns a null terminated string from the printf style
2433  * @format string and @args.
2434  *
2435  * See gst_info_vasprintf() for when this function is required.
2436  *
2437  * Free with g_free().
2438  *
2439  * Returns: (nullable): a newly allocated null terminated string or %NULL on any error
2440  *
2441  * Since: 1.8
2442  */
2443 gchar *
2444 gst_info_strdup_vprintf (const gchar * format, va_list args)
2445 {
2446   gchar *ret;
2447
2448   if (gst_info_vasprintf (&ret, format, args) < 0)
2449     ret = NULL;
2450
2451   return ret;
2452 }
2453
2454 /**
2455  * gst_info_strdup_printf:
2456  * @format: a printf style format string
2457  * @...: the printf arguments for @format
2458  *
2459  * Allocates, fills and returns a 0-terminated string from the printf style
2460  * @format string and corresponding arguments.
2461  *
2462  * See gst_info_vasprintf() for when this function is required.
2463  *
2464  * Free with g_free().
2465  *
2466  * Returns: (nullable): a newly allocated null terminated string or %NULL on any error
2467  *
2468  * Since: 1.8
2469  */
2470 gchar *
2471 gst_info_strdup_printf (const gchar * format, ...)
2472 {
2473   gchar *ret;
2474   va_list args;
2475
2476   va_start (args, format);
2477   ret = gst_info_strdup_vprintf (format, args);
2478   va_end (args);
2479
2480   return ret;
2481 }
2482
2483 /**
2484  * gst_print:
2485  * @format: a printf style format string
2486  * @...: the printf arguments for @format
2487  *
2488  * Outputs a formatted message via the GLib print handler. The default print
2489  * handler simply outputs the message to stdout.
2490  *
2491  * This function will not append a new-line character at the end, unlike
2492  * gst_println() which will.
2493  *
2494  * All strings must be in ASCII or UTF-8 encoding.
2495  *
2496  * This function differs from g_print() in that it supports all the additional
2497  * printf specifiers that are supported by GStreamer's debug logging system,
2498  * such as #GST_PTR_FORMAT and #GST_SEGMENT_FORMAT.
2499  *
2500  * This function is primarily for printing debug output.
2501  *
2502  * Since: 1.12
2503  */
2504 void
2505 gst_print (const gchar * format, ...)
2506 {
2507   va_list args;
2508   gchar *str;
2509
2510   va_start (args, format);
2511   str = gst_info_strdup_vprintf (format, args);
2512   va_end (args);
2513
2514   g_print ("%s", str);
2515   g_free (str);
2516 }
2517
2518 /**
2519  * gst_println:
2520  * @format: a printf style format string
2521  * @...: the printf arguments for @format
2522  *
2523  * Outputs a formatted message via the GLib print handler. The default print
2524  * handler simply outputs the message to stdout.
2525  *
2526  * This function will append a new-line character at the end, unlike
2527  * gst_print() which will not.
2528  *
2529  * All strings must be in ASCII or UTF-8 encoding.
2530  *
2531  * This function differs from g_print() in that it supports all the additional
2532  * printf specifiers that are supported by GStreamer's debug logging system,
2533  * such as #GST_PTR_FORMAT and #GST_SEGMENT_FORMAT.
2534  *
2535  * This function is primarily for printing debug output.
2536  *
2537  * Since: 1.12
2538  */
2539 void
2540 gst_println (const gchar * format, ...)
2541 {
2542   va_list args;
2543   gchar *str;
2544
2545   va_start (args, format);
2546   str = gst_info_strdup_vprintf (format, args);
2547   va_end (args);
2548
2549   g_print ("%s\n", str);
2550   g_free (str);
2551 }
2552
2553 /**
2554  * gst_printerr:
2555  * @format: a printf style format string
2556  * @...: the printf arguments for @format
2557  *
2558  * Outputs a formatted message via the GLib error message handler. The default
2559  * handler simply outputs the message to stderr.
2560  *
2561  * This function will not append a new-line character at the end, unlike
2562  * gst_printerrln() which will.
2563  *
2564  * All strings must be in ASCII or UTF-8 encoding.
2565  *
2566  * This function differs from g_printerr() in that it supports the additional
2567  * printf specifiers that are supported by GStreamer's debug logging system,
2568  * such as #GST_PTR_FORMAT and #GST_SEGMENT_FORMAT.
2569  *
2570  * This function is primarily for printing debug output.
2571  *
2572  * Since: 1.12
2573  */
2574 void
2575 gst_printerr (const gchar * format, ...)
2576 {
2577   va_list args;
2578   gchar *str;
2579
2580   va_start (args, format);
2581   str = gst_info_strdup_vprintf (format, args);
2582   va_end (args);
2583
2584   g_printerr ("%s", str);
2585   g_free (str);
2586 }
2587
2588 /**
2589  * gst_printerrln:
2590  * @format: a printf style format string
2591  * @...: the printf arguments for @format
2592  *
2593  * Outputs a formatted message via the GLib error message handler. The default
2594  * handler simply outputs the message to stderr.
2595  *
2596  * This function will append a new-line character at the end, unlike
2597  * gst_printerr() which will not.
2598  *
2599  * All strings must be in ASCII or UTF-8 encoding.
2600  *
2601  * This function differs from g_printerr() in that it supports the additional
2602  * printf specifiers that are supported by GStreamer's debug logging system,
2603  * such as #GST_PTR_FORMAT and #GST_SEGMENT_FORMAT.
2604  *
2605  * This function is primarily for printing debug output.
2606  *
2607  * Since: 1.12
2608  */
2609 void
2610 gst_printerrln (const gchar * format, ...)
2611 {
2612   va_list args;
2613   gchar *str;
2614
2615   va_start (args, format);
2616   str = gst_info_strdup_vprintf (format, args);
2617   va_end (args);
2618
2619   g_printerr ("%s\n", str);
2620   g_free (str);
2621 }
2622
2623 #ifdef HAVE_UNWIND
2624 #ifdef HAVE_DW
2625 static gboolean
2626 append_debug_info (GString * trace, Dwfl * dwfl, const void *ip)
2627 {
2628   Dwfl_Line *line;
2629   Dwarf_Addr addr;
2630   Dwfl_Module *module;
2631   const gchar *function_name;
2632
2633   if (dwfl_linux_proc_report (dwfl, getpid ()) != 0)
2634     return FALSE;
2635
2636   if (dwfl_report_end (dwfl, NULL, NULL))
2637     return FALSE;
2638
2639   addr = (uintptr_t) ip;
2640   module = dwfl_addrmodule (dwfl, addr);
2641   function_name = dwfl_module_addrname (module, addr);
2642
2643   g_string_append_printf (trace, "%s (", function_name ? function_name : "??");
2644
2645   line = dwfl_getsrc (dwfl, addr);
2646   if (line != NULL) {
2647     gint nline;
2648     Dwarf_Addr addr;
2649     const gchar *filename = dwfl_lineinfo (line, &addr,
2650         &nline, NULL, NULL, NULL);
2651
2652     g_string_append_printf (trace, "%s:%d", strrchr (filename,
2653             G_DIR_SEPARATOR) + 1, nline);
2654   } else {
2655     const gchar *eflfile = NULL;
2656
2657     dwfl_module_info (module, NULL, NULL, NULL, NULL, NULL, &eflfile, NULL);
2658     g_string_append_printf (trace, "%s:%p", eflfile ? eflfile : "??", ip);
2659   }
2660
2661   return TRUE;
2662 }
2663 #endif /* HAVE_DW */
2664
2665 static gchar *
2666 generate_unwind_trace (GstStackTraceFlags flags)
2667 {
2668   gint unret;
2669   unw_context_t uc;
2670   unw_cursor_t cursor;
2671   gboolean use_libunwind = TRUE;
2672   GString *trace = g_string_new (NULL);
2673
2674 #ifdef HAVE_DW
2675   Dwfl *dwfl = NULL;
2676   Dwfl_Callbacks callbacks = {
2677     .find_elf = dwfl_linux_proc_find_elf,
2678     .find_debuginfo = dwfl_standard_find_debuginfo,
2679   };
2680
2681   if ((flags & GST_STACK_TRACE_SHOW_FULL))
2682     dwfl = dwfl_begin (&callbacks);
2683 #endif /* HAVE_DW */
2684
2685   unret = unw_getcontext (&uc);
2686   if (unret) {
2687     GST_DEBUG ("Could not get libunwind context (%d)", unret);
2688
2689     goto done;
2690   }
2691   unret = unw_init_local (&cursor, &uc);
2692   if (unret) {
2693     GST_DEBUG ("Could not init libunwind context (%d)", unret);
2694
2695     goto done;
2696   }
2697
2698   while (unw_step (&cursor) > 0) {
2699 #ifdef HAVE_DW
2700     if (dwfl) {
2701       unw_word_t ip;
2702
2703       unret = unw_get_reg (&cursor, UNW_REG_IP, &ip);
2704       if (unret) {
2705         GST_DEBUG ("libunwind could read frame info (%d)", unret);
2706
2707         goto done;
2708       }
2709
2710       if (append_debug_info (trace, dwfl, (void *) (ip - 4))) {
2711         use_libunwind = FALSE;
2712         g_string_append (trace, ")\n");
2713       }
2714     }
2715 #endif /* HAVE_DW */
2716
2717     if (use_libunwind) {
2718       char name[32];
2719
2720       unw_word_t offset = 0;
2721       unw_get_proc_name (&cursor, name, sizeof (name), &offset);
2722       g_string_append_printf (trace, "%s (0x%" G_GSIZE_FORMAT ")\n", name,
2723           (gsize) offset);
2724     }
2725   }
2726
2727 done:
2728 #ifdef HAVE_DW
2729   if (dwfl)
2730     dwfl_end (dwfl);
2731 #endif
2732
2733   return g_string_free (trace, FALSE);
2734 }
2735
2736 #endif /* HAVE_UNWIND */
2737
2738 #ifdef HAVE_BACKTRACE
2739 static gchar *
2740 generate_backtrace_trace (void)
2741 {
2742   int j, nptrs;
2743   void *buffer[BT_BUF_SIZE];
2744   char **strings;
2745   GString *trace;
2746
2747   trace = g_string_new (NULL);
2748   nptrs = backtrace (buffer, BT_BUF_SIZE);
2749
2750   strings = backtrace_symbols (buffer, nptrs);
2751
2752   if (!strings)
2753     return NULL;
2754
2755   for (j = 0; j < nptrs; j++)
2756     g_string_append_printf (trace, "%s\n", strings[j]);
2757
2758   free (strings);
2759
2760   return g_string_free (trace, FALSE);
2761 }
2762 #else
2763 #define generate_backtrace_trace() NULL
2764 #endif /* HAVE_BACKTRACE */
2765
2766 /**
2767  * gst_debug_get_stack_trace:
2768  * @flags: A set of #GstStackTraceFlags to determine how the stack
2769  * trace should look like. Pass 0 to retrieve a minimal backtrace.
2770  *
2771  * Returns: (nullable): a stack trace, if libunwind or glibc backtrace are
2772  * present, else %NULL.
2773  *
2774  * Since: 1.12
2775  */
2776 gchar *
2777 gst_debug_get_stack_trace (GstStackTraceFlags flags)
2778 {
2779   gchar *trace = NULL;
2780 #ifdef HAVE_BACKTRACE
2781   gboolean have_backtrace = TRUE;
2782 #else
2783   gboolean have_backtrace = FALSE;
2784 #endif
2785
2786 #ifdef HAVE_UNWIND
2787   if ((flags & GST_STACK_TRACE_SHOW_FULL) || !have_backtrace)
2788     trace = generate_unwind_trace (flags);
2789 #endif /* HAVE_UNWIND */
2790
2791   if (trace)
2792     return trace;
2793   else if (have_backtrace)
2794     return generate_backtrace_trace ();
2795
2796   return NULL;
2797 }
2798
2799 /**
2800  * gst_debug_print_stack_trace:
2801  *
2802  * If libunwind or glibc backtrace are present
2803  * a stack trace is printed.
2804  */
2805 void
2806 gst_debug_print_stack_trace (void)
2807 {
2808   gchar *trace = gst_debug_get_stack_trace (GST_STACK_TRACE_SHOW_FULL);
2809
2810   if (trace)
2811     g_print ("%s\n", trace);
2812
2813   g_free (trace);
2814 }
2815
2816 #ifndef GST_DISABLE_GST_DEBUG
2817 typedef struct
2818 {
2819   guint max_size_per_thread;
2820   guint thread_timeout;
2821   GQueue threads;
2822   GHashTable *thread_index;
2823 } GstRingBufferLogger;
2824
2825 typedef struct
2826 {
2827   GList *link;
2828   gint64 last_use;
2829   GThread *thread;
2830
2831   GQueue log;
2832   gsize log_size;
2833 } GstRingBufferLog;
2834
2835 G_LOCK_DEFINE_STATIC (ring_buffer_logger);
2836 static GstRingBufferLogger *ring_buffer_logger = NULL;
2837
2838 static void
2839 gst_ring_buffer_logger_log (GstDebugCategory * category,
2840     GstDebugLevel level,
2841     const gchar * file,
2842     const gchar * function,
2843     gint line, GObject * object, GstDebugMessage * message, gpointer user_data)
2844 {
2845   GstRingBufferLogger *logger = user_data;
2846   gint pid;
2847   GThread *thread;
2848   GstClockTime elapsed;
2849   gchar *obj = NULL;
2850   gchar c;
2851   gchar *output;
2852   gsize output_len;
2853   GstRingBufferLog *log;
2854   gint64 now = g_get_monotonic_time ();
2855   const gchar *message_str = gst_debug_message_get (message);
2856
2857   G_LOCK (ring_buffer_logger);
2858
2859   if (logger->thread_timeout > 0) {
2860     /* Remove all threads that saw no output since thread_timeout seconds.
2861      * By construction these are all at the tail of the queue, and the queue
2862      * is ordered by last use, so we just need to look at the tail.
2863      */
2864     while (logger->threads.tail) {
2865       log = logger->threads.tail->data;
2866       if (log->last_use + logger->thread_timeout * G_USEC_PER_SEC >= now)
2867         break;
2868
2869       g_hash_table_remove (logger->thread_index, log->thread);
2870       while ((output = g_queue_pop_head (&log->log)))
2871         g_free (output);
2872       g_free (log);
2873       g_queue_pop_tail (&logger->threads);
2874     }
2875   }
2876
2877   /* Get logger for this thread, and put it back at the
2878    * head of the threads queue */
2879   thread = g_thread_self ();
2880   log = g_hash_table_lookup (logger->thread_index, thread);
2881   if (!log) {
2882     log = g_new0 (GstRingBufferLog, 1);
2883     g_queue_init (&log->log);
2884     log->log_size = 0;
2885     g_queue_push_head (&logger->threads, log);
2886     log->link = logger->threads.head;
2887     log->thread = thread;
2888     g_hash_table_insert (logger->thread_index, thread, log);
2889   } else {
2890     g_queue_unlink (&logger->threads, log->link);
2891     g_queue_push_head_link (&logger->threads, log->link);
2892   }
2893   log->last_use = now;
2894
2895   /* __FILE__ might be a file name or an absolute path or a
2896    * relative path, irrespective of the exact compiler used,
2897    * in which case we want to shorten it to the filename for
2898    * readability. */
2899   c = file[0];
2900   if (c == '.' || c == '/' || c == '\\' || (c != '\0' && file[1] == ':')) {
2901     file = gst_path_basename (file);
2902   }
2903
2904   pid = getpid ();
2905
2906   if (object) {
2907     obj = gst_debug_print_object (object);
2908   } else {
2909     obj = (gchar *) "";
2910   }
2911
2912   elapsed = GST_CLOCK_DIFF (_priv_gst_start_time, gst_util_get_timestamp ());
2913
2914   /* no color, all platforms */
2915 #define PRINT_FMT " "PID_FMT" "PTR_FMT" %s "CAT_FMT" %s\n"
2916   output =
2917       g_strdup_printf ("%" GST_TIME_FORMAT PRINT_FMT, GST_TIME_ARGS (elapsed),
2918       pid, thread, gst_debug_level_get_name (level),
2919       gst_debug_category_get_name (category), file, line, function, obj,
2920       message_str);
2921 #undef PRINT_FMT
2922
2923   output_len = strlen (output);
2924
2925   if (output_len < logger->max_size_per_thread) {
2926     gchar *buf;
2927
2928     /* While using a GQueue here is not the most efficient thing to do, we
2929      * have to allocate a string for every output anyway and could just store
2930      * that instead of copying it to an actual ringbuffer.
2931      * Better than GQueue would be GstQueueArray, but that one is in
2932      * libgstbase and we can't use it here. That one allocation will not make
2933      * much of a difference anymore, considering the number of allocations
2934      * needed to get to this point...
2935      */
2936     while (log->log_size + output_len > logger->max_size_per_thread) {
2937       buf = g_queue_pop_head (&log->log);
2938       log->log_size -= strlen (buf);
2939       g_free (buf);
2940     }
2941     g_queue_push_tail (&log->log, output);
2942     log->log_size += output_len;
2943   } else {
2944     gchar *buf;
2945
2946     /* Can't really write anything as the line is bigger than the maximum
2947      * allowed log size already, so just remove everything */
2948
2949     while ((buf = g_queue_pop_head (&log->log)))
2950       g_free (buf);
2951     g_free (output);
2952     log->log_size = 0;
2953   }
2954
2955   if (object != NULL)
2956     g_free (obj);
2957
2958   G_UNLOCK (ring_buffer_logger);
2959 }
2960
2961 /**
2962  * gst_debug_ring_buffer_logger_get_logs:
2963  *
2964  * Fetches the current logs per thread from the ring buffer logger. See
2965  * gst_debug_add_ring_buffer_logger() for details.
2966  *
2967  * Returns: (transfer full) (array zero-terminated): NULL-terminated array of
2968  * strings with the debug output per thread
2969  *
2970  * Since: 1.14
2971  */
2972 gchar **
2973 gst_debug_ring_buffer_logger_get_logs (void)
2974 {
2975   gchar **logs, **tmp;
2976   GList *l;
2977
2978   g_return_val_if_fail (ring_buffer_logger != NULL, NULL);
2979
2980   G_LOCK (ring_buffer_logger);
2981
2982   tmp = logs = g_new0 (gchar *, ring_buffer_logger->threads.length + 1);
2983   for (l = ring_buffer_logger->threads.head; l; l = l->next) {
2984     GstRingBufferLog *log = l->data;
2985     GList *l;
2986     gchar *p;
2987     gsize len;
2988
2989     *tmp = p = g_new0 (gchar, log->log_size + 1);
2990
2991     for (l = log->log.head; l; l = l->next) {
2992       len = strlen (l->data);
2993       memcpy (p, l->data, len);
2994       p += len;
2995     }
2996
2997     tmp++;
2998   }
2999
3000   G_UNLOCK (ring_buffer_logger);
3001
3002   return logs;
3003 }
3004
3005 static void
3006 gst_ring_buffer_logger_free (GstRingBufferLogger * logger)
3007 {
3008   G_LOCK (ring_buffer_logger);
3009   if (ring_buffer_logger == logger) {
3010     GstRingBufferLog *log;
3011
3012     while ((log = g_queue_pop_head (&logger->threads))) {
3013       gchar *buf;
3014       while ((buf = g_queue_pop_head (&log->log)))
3015         g_free (buf);
3016       g_free (log);
3017     }
3018
3019     g_hash_table_unref (logger->thread_index);
3020
3021     g_free (logger);
3022     ring_buffer_logger = NULL;
3023   }
3024   G_UNLOCK (ring_buffer_logger);
3025 }
3026
3027 /**
3028  * gst_debug_add_ring_buffer_logger:
3029  * @max_size_per_thread: Maximum size of log per thread in bytes
3030  * @thread_timeout: Timeout for threads in seconds
3031  *
3032  * Adds a memory ringbuffer based debug logger that stores up to
3033  * @max_size_per_thread bytes of logs per thread and times out threads after
3034  * @thread_timeout seconds of inactivity.
3035  *
3036  * Logs can be fetched with gst_debug_ring_buffer_logger_get_logs() and the
3037  * logger can be removed again with gst_debug_remove_ring_buffer_logger().
3038  * Only one logger at a time is possible.
3039  *
3040  * Since: 1.14
3041  */
3042 void
3043 gst_debug_add_ring_buffer_logger (guint max_size_per_thread,
3044     guint thread_timeout)
3045 {
3046   GstRingBufferLogger *logger;
3047
3048   G_LOCK (ring_buffer_logger);
3049
3050   if (ring_buffer_logger) {
3051     g_warn_if_reached ();
3052     G_UNLOCK (ring_buffer_logger);
3053     return;
3054   }
3055
3056   logger = ring_buffer_logger = g_new0 (GstRingBufferLogger, 1);
3057
3058   logger->max_size_per_thread = max_size_per_thread;
3059   logger->thread_timeout = thread_timeout;
3060   logger->thread_index = g_hash_table_new (g_direct_hash, g_direct_equal);
3061   g_queue_init (&logger->threads);
3062
3063   gst_debug_add_log_function (gst_ring_buffer_logger_log, logger,
3064       (GDestroyNotify) gst_ring_buffer_logger_free);
3065   G_UNLOCK (ring_buffer_logger);
3066 }
3067
3068 /**
3069  * gst_debug_remove_ring_buffer_logger:
3070  *
3071  * Removes any previously added ring buffer logger with
3072  * gst_debug_add_ring_buffer_logger().
3073  *
3074  * Since: 1.14
3075  */
3076 void
3077 gst_debug_remove_ring_buffer_logger (void)
3078 {
3079   gst_debug_remove_log_function (gst_ring_buffer_logger_log);
3080 }
3081
3082 #else /* GST_DISABLE_GST_DEBUG */
3083 #ifndef GST_REMOVE_DISABLED
3084
3085 gchar **
3086 gst_debug_ring_buffer_logger_get_logs (void)
3087 {
3088   return NULL;
3089 }
3090
3091 void
3092 gst_debug_add_ring_buffer_logger (guint max_size_per_thread,
3093     guint thread_timeout)
3094 {
3095 }
3096
3097 void
3098 gst_debug_remove_ring_buffer_logger (void)
3099 {
3100 }
3101
3102 #endif /* GST_REMOVE_DISABLED */
3103 #endif /* GST_DISABLE_GST_DEBUG */