gstreamer/gst/gstinfo.h

1157 lines
36 KiB
C
Raw Permalink Normal View History

/* GStreamer
* Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
* 2000 Wim Taymans <wtay@chello.be>
* 2003 Benjamin Otte <in7y118@public.uni-hamburg.de>
*
* gstinfo.h: debugging functions
Changes made to the DEBUG system. New header file gstdebug.h holds the stuff to keep it out of gst.h's hair. DEBUG ... Original commit message from CVS: Changes made to the DEBUG system. New header file gstdebug.h holds the stuff to keep it out of gst.h's hair. DEBUG prints out the process id, cothread id, source filename and line number. Two new macros DEBUG_ENTER and DEBUG_LEAVE are used to show the entry and exit of a given function. This eventually might be used to construct call trace graphs, even taking cothreads into account. This would be quite useful in visualizing the scheduling mechanism. Minor changes to various debug messages. Also sitting in gstdebug.h is a prototypical DEBUG_ENTER that's capable of performing DEBUG_LEAVE automatically. It does this by utilizing a little-known GCC extension that allows one to call a function with the same parameters as the current function. The macro uses this to basically call itself. A boolean is used to ensure that when it calls itself it actually runs the body of the function. In the meantime it prints stuff out before and after the real function, as well as constructing a debugging string. This can be used eventually to provide call-wide data on the DEBUG lines, instead of having to replicate data on each call to DEBUG. More research is needed into how this would most cleanly be fit into some other chunk of code, like GStreamer (I think of this DEBUG trick as a separate project, sorta). Unfortunately, the aforementioned DEBUG trick interacts quite poorly with cothreads. Almost any time it's used in a function that has anything remotely to do with a cothread context (as in, it runs in one), a segfault results from the __builtin_apply call, which is the heart of the whole thing. If someone who really knows assembly could analyze the resulting code to see what's really going on, we might find a way to fix either the macro or the cothreads (I'm thinking that there's something we missed in constructing the cothreads themselves) so this works in all cases. In the meantime, please insert both DEBUG_ENTER and DEBUG_LEAVE in your functions. Be sure to put DEBUG_ENTER after your variable declarations and before any functional code, not to put the function name in any DEBUG strings (it's already there, trust me), and put a DEBUG_LEAVE if you care enough. Changes are going to happen in the way DEBUGs and other printouts occur, so stay tuned.
2000-12-04 09:35:08 +00:00
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#ifndef __GSTINFO_H__
#define __GSTINFO_H__
Changes made to the DEBUG system. New header file gstdebug.h holds the stuff to keep it out of gst.h's hair. DEBUG ... Original commit message from CVS: Changes made to the DEBUG system. New header file gstdebug.h holds the stuff to keep it out of gst.h's hair. DEBUG prints out the process id, cothread id, source filename and line number. Two new macros DEBUG_ENTER and DEBUG_LEAVE are used to show the entry and exit of a given function. This eventually might be used to construct call trace graphs, even taking cothreads into account. This would be quite useful in visualizing the scheduling mechanism. Minor changes to various debug messages. Also sitting in gstdebug.h is a prototypical DEBUG_ENTER that's capable of performing DEBUG_LEAVE automatically. It does this by utilizing a little-known GCC extension that allows one to call a function with the same parameters as the current function. The macro uses this to basically call itself. A boolean is used to ensure that when it calls itself it actually runs the body of the function. In the meantime it prints stuff out before and after the real function, as well as constructing a debugging string. This can be used eventually to provide call-wide data on the DEBUG lines, instead of having to replicate data on each call to DEBUG. More research is needed into how this would most cleanly be fit into some other chunk of code, like GStreamer (I think of this DEBUG trick as a separate project, sorta). Unfortunately, the aforementioned DEBUG trick interacts quite poorly with cothreads. Almost any time it's used in a function that has anything remotely to do with a cothread context (as in, it runs in one), a segfault results from the __builtin_apply call, which is the heart of the whole thing. If someone who really knows assembly could analyze the resulting code to see what's really going on, we might find a way to fix either the macro or the cothreads (I'm thinking that there's something we missed in constructing the cothreads themselves) so this works in all cases. In the meantime, please insert both DEBUG_ENTER and DEBUG_LEAVE in your functions. Be sure to put DEBUG_ENTER after your variable declarations and before any functional code, not to put the function name in any DEBUG strings (it's already there, trust me), and put a DEBUG_LEAVE if you care enough. Changes are going to happen in the way DEBUGs and other printouts occur, so stay tuned.
2000-12-04 09:35:08 +00:00
#include <glib.h>
#include <glib-object.h>
#include <gst/gstconfig.h>
#ifndef _MSC_VER
#define IMPORT_SYMBOL
#else /* _MSC_VER */
#ifndef LIBGSTREAMER_EXPORTS
#define IMPORT_SYMBOL __declspec(dllimport)
#else
#define IMPORT_SYMBOL
#endif
#endif
#ifndef M_PI
#define M_PI 3.14159265358979323846
#endif
G_BEGIN_DECLS
/**
* GstDebugLevel:
* @GST_LEVEL_NONE: No debugging level specified or desired. Used to deactivate
* debugging output.
* @GST_LEVEL_ERROR: Error messages are to be used only when an error occured
* that stops the application from keeping working correctly.
* An examples is gst_element_error, which outputs a message with this priority.
* It does not mean that the application is terminating as with g_errror.
* @GST_LEVEL_WARNING: Warning messages are to inform about abnormal behaviour
* that could lead to problems or weird behaviour later on. An example of this
* would be clocking issues ("your computer is pretty slow") or broken input
* data ("Can't synchronize to stream.")
* @GST_LEVEL_INFO: Informational messages should be used to keep the developer
* updated about what is happening.
* Examples where this should be used are when a typefind function has
* successfully determined the type of the stream or when an mp3 plugin detects
* the format to be used. ("This file has mono sound.")
* @GST_LEVEL_DEBUG: Debugging messages should be used when something common
* happens that is not the expected default behavior.
* An example would be notifications about state changes or receiving/sending of
* events.
* @GST_LEVEL_LOG: Log messages are messages that are very common but might be
* useful to know. As a rule of thumb a pipeline that is iterating as expected
* should never output anzthing else but LOG messages.
* Examples for this are referencing/dereferencing of objects or cothread switches.
* @GST_LEVEL_COUNT: The number of defined debugging levels.
*
* The level defines the importance of a debugging message. The more important a
* message is, the greater the probability that the debugging system outputs it.
*/
typedef enum {
GST_LEVEL_NONE = 0,
GST_LEVEL_ERROR,
GST_LEVEL_WARNING,
GST_LEVEL_INFO,
GST_LEVEL_DEBUG,
GST_LEVEL_LOG,
/* add more */
GST_LEVEL_COUNT
} GstDebugLevel;
/**
* GST_LEVEL_DEFAULT:
*
* Defines the default debugging level to be used with GStreamer. It is normally
* set to #GST_LEVEL_NONE so nothing get printed.
* As it can be configured at compile time, developer builds may chose to
* override that though.
* You can use this as an argument to gst_debug_set_default_threshold() to
* reset the debugging output to default behaviour.
*/
#ifndef GST_LEVEL_DEFAULT
#define GST_LEVEL_DEFAULT GST_LEVEL_NONE
#endif
/* defines for format (colors etc)
* don't change them around, it uses terminal layout
* Terminal color strings:
* 00=none 01=bold 04=underscore 05=blink 07=reverse 08=concealed
* Text color codes:
* 30=black 31=red 32=green 33=yellow 34=blue 35=magenta 36=cyan 37=white
* Background color codes:
* 40=black 41=red 42=green 43=yellow 44=blue 45=magenta 46=cyan 47=white
*/
/**
* GstDebugColorFlags:
* @GST_DEBUG_FG_BLACK: Use black as foreground color.
* @GST_DEBUG_FG_RED: Use red as foreground color.
* @GST_DEBUG_FG_GREEN: Use green as foreground color.
* @GST_DEBUG_FG_YELLOW: Use yellow as foreground color.
* @GST_DEBUG_FG_BLUE: Use blue as foreground color.
* @GST_DEBUG_FG_MAGENTA: Use magenta as foreground color.
* @GST_DEBUG_FG_CYAN: Use cyan as foreground color.
* @GST_DEBUG_FG_WHITE: Use white as foreground color.
* @GST_DEBUG_BG_BLACK: Use black as background color.
* @GST_DEBUG_BG_RED: Use red as background color.
* @GST_DEBUG_BG_GREEN: Use green as background color.
* @GST_DEBUG_BG_YELLOW: Use yellow as background color.
* @GST_DEBUG_BG_BLUE: Use blue as background color.
* @GST_DEBUG_BG_MAGENTA: Use magenta as background color.
* @GST_DEBUG_BG_CYAN: Use cyan as background color.
* @GST_DEBUG_BG_WHITE: Use white as background color.
* @GST_DEBUG_BOLD: Make the output bold.
* @GST_DEBUG_UNDERLINE: Underline the output.
*
* These are some terminal style flags you can use when creating your
* debugging categories to make them stand out in debugging output.
*/
typedef enum {
/* colors */
GST_DEBUG_FG_BLACK = 0x0000,
GST_DEBUG_FG_RED = 0x0001,
GST_DEBUG_FG_GREEN = 0x0002,
GST_DEBUG_FG_YELLOW = 0x0003,
GST_DEBUG_FG_BLUE = 0x0004,
GST_DEBUG_FG_MAGENTA = 0x0005,
GST_DEBUG_FG_CYAN = 0x0006,
GST_DEBUG_FG_WHITE = 0x0007,
/* background colors */
GST_DEBUG_BG_BLACK = 0x0000,
GST_DEBUG_BG_RED = 0x0010,
GST_DEBUG_BG_GREEN = 0x0020,
GST_DEBUG_BG_YELLOW = 0x0030,
GST_DEBUG_BG_BLUE = 0x0040,
GST_DEBUG_BG_MAGENTA = 0x0050,
GST_DEBUG_BG_CYAN = 0x0060,
GST_DEBUG_BG_WHITE = 0x0070,
/* other formats */
GST_DEBUG_BOLD = 0x0100,
GST_DEBUG_UNDERLINE = 0x0200
} GstDebugColorFlags;
#define GST_DEBUG_FG_MASK (0x000F)
#define GST_DEBUG_BG_MASK (0x00F0)
#define GST_DEBUG_FORMAT_MASK (0xFF00)
typedef struct _GstDebugCategory GstDebugCategory;
/**
* GstDebugCategory:
*
* This is the struct that describes the categories. Once initialized with
* #GST_DEBUG_CATEGORY_INIT, its values can't be changed anymore.
*/
struct _GstDebugCategory {
/*< private >*/
gint threshold;
guint color; /* see defines above */
const gchar * name;
const gchar * description;
};
/********** some convenience macros for debugging **********/
/**
* GST_STR_NULL:
* @str: The string to check.
*
* Macro to use when a string must not be NULL, but may be NULL. If the string
* is NULL, "(NULL)" is printed instead.
* In GStreamer printf string arguments may not be NULL, because on some
* platforms (ie Solaris) the libc crashes in that case. This includes debugging
* strings.
*/
#define GST_STR_NULL(str) ((str) ? (str) : "(NULL)")
/* FIXME, not MT safe */
/**
* GST_DEBUG_PAD_NAME:
* @pad: The pad to debug.
*
* Evaluates to 2 strings, that describe the pad. Often used in debugging
* statements.
*/
#define GST_DEBUG_PAD_NAME(pad) \
(pad != NULL) ? \
((GST_OBJECT_PARENT(pad) != NULL) ? \
GST_STR_NULL (GST_OBJECT_NAME (GST_OBJECT_PARENT(pad))) : \
"''" ) : "''", \
(pad != NULL) ? GST_STR_NULL (GST_OBJECT_NAME (pad)) : "''"
/**
* GST_FUNCTION:
*
* This macro should evaluate to the name of the current function and be should
* be defined when configuring your project, as it is compiler dependant. If it
* is not defined, some default value is used. It is used to provide debugging
* output with the function name of the message.
*/
#ifndef GST_FUNCTION
#if defined (__GNUC__)
# define GST_FUNCTION ((const char*) (__FUNCTION__))
#elif defined (G_HAVE_ISO_VARARGS)
# define GST_FUNCTION ((const char*) (__func__))
#else
# define GST_FUNCTION ((const char*) ("???"))
#endif
#endif /* ifndef GST_FUNCTION */
typedef struct _GstDebugMessage GstDebugMessage;
/**
* GstLogFunction:
* @category: a #GstDebugCategory
* @level: a #GstDebugLevel
* @file: file name
* @function: function name
* @line: line number
* @object: a #GObject
* @message: the message
* @data: user data for the log function
*
* Function prototype for a logging function that can be registered with
* gst_debug_add_log_function().
* Use G_GNUC_NO_INSTRUMENT on that function.
*/
typedef void (*GstLogFunction) (GstDebugCategory * category,
GstDebugLevel level,
const gchar * file,
const gchar * function,
gint line,
GObject * object,
GstDebugMessage * message,
gpointer data);
#ifndef GST_DISABLE_GST_DEBUG
Makefile.am: Add check-exports target and run it as part of 'make check' (see #499140 and #493983). Original commit message from CVS: * Makefile.am: Add check-exports target and run it as part of 'make check' (see #499140 and #493983). * gst/gst_private.h: * gst/gstelementfactory.h: * gst/gstghostpad.c: (gst_proxy_pad_class_init): * gst/gstinfo.c: (_priv_gst_in_valgrind), (_gst_debug_init), (_priv_gst_in_valgrind): * gst/gstinfo.h: (GstLogFunction): * gst/gsttypefind.c: (type_find_debug), (GST_CAT_DEFAULT), (gst_type_find_register): * gst/gsttypefindfactory.c: (type_find_debug), (GST_CAT_DEFAULT), (gst_type_find_factory_get_type): * libs/gst/controller/gstcontroller.c: (GST_CAT_DEFAULT), (GST_CAT_DEFAULT), (parent_class), (priv_gst_controller_key), (gst_controller_new_valist), (gst_controller_new_list), (_gst_controller_dispose), (_gst_controller_class_init): * libs/gst/controller/gstcontrolsource.c: (GST_CAT_DEFAULT): * libs/gst/controller/gsthelper.c: (GST_CAT_DEFAULT), (GST_CAT_DEFAULT), (gst_object_uncontrol_properties), (gst_object_get_controller), (gst_object_set_controller), (gst_object_suggest_next_sync), (gst_object_sync_values), (gst_object_set_control_source), (gst_object_get_control_source), (gst_object_get_value_arrays), (gst_object_get_value_array), (gst_object_get_control_rate), (gst_object_set_control_rate): * libs/gst/controller/gstinterpolation.c: (GST_CAT_DEFAULT): * libs/gst/controller/lib.c: (GST_CAT_DEFAULT): Make some functions that should be static static; rename some private symbols so that they don't get exported; add some FIXME comments so we can move accidentally exported functions into our private section in 0.11. * win32/common/libgstreamer.def: Add gst_utils_get_timestamp().
2007-12-12 23:20:00 +00:00
/* FIXME 0.11: move this into private headers */
void _gst_debug_init (void);
#ifdef GST_USING_PRINTF_EXTENSION
/* not using G_GNUC_PRINTF, since gcc will choke on GST_PTR_FORMAT being %P */
void gst_debug_log (GstDebugCategory * category,
GstDebugLevel level,
const gchar * file,
const gchar * function,
gint line,
GObject * object,
const gchar * format,
...) G_GNUC_NO_INSTRUMENT;
#else /* GST_USING_PRINTF_EXTENSION */
void gst_debug_log (GstDebugCategory * category,
GstDebugLevel level,
const gchar * file,
const gchar * function,
gint line,
GObject * object,
const gchar * format,
...) G_GNUC_PRINTF (7, 8) G_GNUC_NO_INSTRUMENT;
#endif /* GST_USING_PRINTF_EXTENSION */
void gst_debug_log_valist (GstDebugCategory * category,
GstDebugLevel level,
const gchar * file,
const gchar * function,
gint line,
GObject * object,
const gchar * format,
va_list args) G_GNUC_NO_INSTRUMENT;
const gchar * gst_debug_message_get (GstDebugMessage * message);
void gst_debug_log_default (GstDebugCategory * category,
GstDebugLevel level,
const gchar * file,
const gchar * function,
gint line,
GObject * object,
GstDebugMessage * message,
gpointer unused) G_GNUC_NO_INSTRUMENT;
G_CONST_RETURN gchar *
gst_debug_level_get_name (GstDebugLevel level);
void gst_debug_add_log_function (GstLogFunction func,
gpointer data);
guint gst_debug_remove_log_function (GstLogFunction func);
guint gst_debug_remove_log_function_by_data (gpointer data);
void gst_debug_set_active (gboolean active);
gboolean gst_debug_is_active (void);
void gst_debug_set_colored (gboolean colored);
gboolean gst_debug_is_colored (void);
void gst_debug_set_default_threshold (GstDebugLevel level);
GstDebugLevel gst_debug_get_default_threshold (void);
void gst_debug_set_threshold_for_name (const gchar * name,
GstDebugLevel level);
void gst_debug_unset_threshold_for_name (const gchar * name);
/**
* GST_DEBUG_CATEGORY:
* @cat: the category
*
* Defines a GstDebugCategory variable.
* This macro expands to nothing if debugging is disabled.
*/
#define GST_DEBUG_CATEGORY(cat) GstDebugCategory *cat = NULL
/**
* GST_DEBUG_CATEGORY_EXTERN:
* @cat: the category
*
* Declares a GstDebugCategory variable as extern. Use in header files.
* This macro expands to nothing if debugging is disabled.
*/
#define GST_DEBUG_CATEGORY_EXTERN(cat) extern GstDebugCategory *cat
/**
* GST_DEBUG_CATEGORY_STATIC:
* @cat: the category
*
* Defines a static GstDebugCategory variable.
* This macro expands to nothing if debugging is disabled.
*/
#define GST_DEBUG_CATEGORY_STATIC(cat) static GstDebugCategory *cat = NULL
/* do not use this function, use the macros below */
GstDebugCategory *_gst_debug_category_new (const gchar * name,
guint color,
const gchar * description);
/**
* GST_DEBUG_CATEGORY_INIT:
* @cat: the category to initialize.
* @name: the name of the category.
* @color: the colors to use for a color representation or 0 for no color.
* @description: optional description of the category.
*
* Initializes a new #GstDebugCategory with the given properties and set to
* the default threshold.
*
* <note>
* <para>
* This macro expands to nothing if debugging is disabled.
* </para>
* <para>
* When naming your category, please follow the following conventions to ensure
* that the pattern matching for categories works as expected. It is not
* earth-shattering if you don't follow these conventions, but it would be nice
* for everyone.
* </para>
* <para>
* If you define a category for a plugin or a feature of it, name the category
* like the feature. So if you wanted to write a "filesrc" element, you would
* name the category "filesrc". Use lowercase letters only.
* If you define more than one category for the same element, append an
* underscore and an identifier to your categories, like this: "filesrc_cache"
* </para>
* <para>
* If you create a library or an application using debugging categories, use a
* common prefix followed by an underscore for all your categories. GStreamer
* uses the GST prefix so GStreamer categories look like "GST_STATES". Be sure
* to include uppercase letters.
* </para>
* </note>
*/
#define GST_DEBUG_CATEGORY_INIT(cat,name,color,description) G_STMT_START{\
if (cat == NULL) \
cat = _gst_debug_category_new (name,color,description); \
}G_STMT_END
void gst_debug_category_free (GstDebugCategory * category);
void gst_debug_category_set_threshold (GstDebugCategory * category,
GstDebugLevel level);
void gst_debug_category_reset_threshold(GstDebugCategory * category);
GstDebugLevel
gst_debug_category_get_threshold (GstDebugCategory * category);
G_CONST_RETURN gchar *
gst_debug_category_get_name (GstDebugCategory * category);
guint gst_debug_category_get_color (GstDebugCategory * category);
G_CONST_RETURN gchar *
gst_debug_category_get_description (GstDebugCategory * category);
GSList *
gst_debug_get_all_categories (void);
gchar * gst_debug_construct_term_color (guint colorinfo);
/**
* GST_CAT_DEFAULT:
*
* Default gstreamer core debug log category. Please define your own.
*/
GST_EXPORT GstDebugCategory * GST_CAT_DEFAULT;
/* this symbol may not be used */
extern gboolean __gst_debug_enabled;
/* since 0.10.7, the min debug level, used for quickly discarding debug
* messages that fall under the threshold. */
extern IMPORT_SYMBOL GstDebugLevel __gst_debug_min;
/**
* GST_CAT_LEVEL_LOG:
* @cat: category to use
* @level: the severity of the message
* @object: the #GObject the message belongs to or NULL if none
* @...: A printf-style message to output
*
* Outputs a debugging message. This is the most general macro for outputting
* debugging messages. You will probably want to use one of the ones described
* below.
*/
#ifdef G_HAVE_ISO_VARARGS
#define GST_CAT_LEVEL_LOG(cat,level,object,...) G_STMT_START{ \
if (G_UNLIKELY (level <= __gst_debug_min)) { \
gst_debug_log ((cat), (level), __FILE__, GST_FUNCTION, __LINE__, \
(GObject *) (object), __VA_ARGS__); \
} \
}G_STMT_END
#else /* G_HAVE_GNUC_VARARGS */
#ifdef G_HAVE_GNUC_VARARGS
#define GST_CAT_LEVEL_LOG(cat,level,object,args...) G_STMT_START{ \
if (G_UNLIKELY (level <= __gst_debug_min)) { \
gst_debug_log ((cat), (level), __FILE__, GST_FUNCTION, __LINE__, \
(GObject *) (object), ##args ); \
} \
}G_STMT_END
#else /* no variadic macros, use inline */
static inline void
GST_CAT_LEVEL_LOG_valist (GstDebugCategory * cat,
GstDebugLevel level, gpointer object, const char *format, va_list varargs)
{
if (G_UNLIKELY (level <= __gst_debug_min)) {
gst_debug_log_valist (cat, level, "", "", 0, (GObject *) object, format,
varargs);
}
}
static inline void
GST_CAT_LEVEL_LOG (GstDebugCategory * cat, GstDebugLevel level,
gpointer object, const char *format, ...)
{
va_list varargs;
va_start (varargs, format);
GST_CAT_LEVEL_LOG_valist (cat, level, object, format, varargs);
va_end (varargs);
}
#endif
#endif /* G_HAVE_ISO_VARARGS */
/**
* GST_CAT_ERROR_OBJECT:
* @cat: category to use
* @obj: the #GObject the message belongs to
* @...: printf-style message to output
*
* Output an error message belonging to the given object in the given category.
*/
/**
* GST_CAT_WARNING_OBJECT:
* @cat: category to use
* @obj: the #GObject the message belongs to
* @...: printf-style message to output
*
* Output a warning message belonging to the given object in the given category.
*/
/**
* GST_CAT_INFO_OBJECT:
* @cat: category to use
* @obj: the #GObject the message belongs to
* @...: printf-style message to output
*
* Output an informational message belonging to the given object in the given
* category.
*/
/**
* GST_CAT_DEBUG_OBJECT:
* @cat: category to use
* @obj: the #GObject the message belongs to
* @...: printf-style message to output
*
* Output an debugging message belonging to the given object in the given category.
*/
/**
* GST_CAT_LOG_OBJECT:
* @cat: category to use
* @obj: the #GObject the message belongs to
* @...: printf-style message to output
*
* Output an logging message belonging to the given object in the given category.
*/
/**
* GST_CAT_ERROR:
* @cat: category to use
* @...: printf-style message to output
*
* Output an error message in the given category.
*/
/**
* GST_CAT_WARNING:
* @cat: category to use
* @...: printf-style message to output
*
* Output an warning message in the given category.
*/
/**
* GST_CAT_INFO:
* @cat: category to use
* @...: printf-style message to output
*
* Output an informational message in the given category.
*/
/**
* GST_CAT_DEBUG:
* @cat: category to use
* @...: printf-style message to output
*
* Output an debugging message in the given category.
*/
/**
* GST_CAT_LOG:
* @cat: category to use
* @...: printf-style message to output
*
* Output an logging message in the given category.
*/
/**
* GST_ERROR_OBJECT:
* @obj: the #GObject the message belongs to
* @...: printf-style message to output
*
* Output an error message belonging to the given object in the default category.
*/
/**
* GST_WARNING_OBJECT:
* @obj: the #GObject the message belongs to
* @...: printf-style message to output
*
* Output a warning message belonging to the given object in the default category.
*/
/**
* GST_INFO_OBJECT:
* @obj: the #GObject the message belongs to
* @...: printf-style message to output
*
* Output an informational message belonging to the given object in the default
* category.
*/
/**
* GST_DEBUG_OBJECT:
* @obj: the #GObject the message belongs to
* @...: printf-style message to output
*
* Output a debugging message belonging to the given object in the default
* category.
*/
/**
* GST_LOG_OBJECT:
* @obj: the #GObject the message belongs to
* @...: printf-style message to output
*
* Output a logging message belonging to the given object in the default category.
*/
/**
* GST_ERROR:
* @...: printf-style message to output
*
* Output an error message in the default category.
*/
/**
* GST_WARNING:
* @...: printf-style message to output
*
* Output a warning message in the default category.
*/
/**
* GST_INFO:
* @...: printf-style message to output
*
* Output an informational message in the default category.
*/
/**
* GST_DEBUG:
* @...: printf-style message to output
*
* Output a debugging message in the default category.
*/
/**
* GST_LOG:
* @...: printf-style message to output
*
* Output a logging message in the default category.
*/
#ifdef G_HAVE_ISO_VARARGS
#define GST_CAT_ERROR_OBJECT(cat,obj,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_ERROR, obj, __VA_ARGS__)
#define GST_CAT_WARNING_OBJECT(cat,obj,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_WARNING, obj, __VA_ARGS__)
#define GST_CAT_INFO_OBJECT(cat,obj,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_INFO, obj, __VA_ARGS__)
#define GST_CAT_DEBUG_OBJECT(cat,obj,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_DEBUG, obj, __VA_ARGS__)
#define GST_CAT_LOG_OBJECT(cat,obj,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_LOG, obj, __VA_ARGS__)
#define GST_CAT_ERROR(cat,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_ERROR, NULL, __VA_ARGS__)
#define GST_CAT_WARNING(cat,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_WARNING, NULL, __VA_ARGS__)
#define GST_CAT_INFO(cat,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_INFO, NULL, __VA_ARGS__)
#define GST_CAT_DEBUG(cat,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_DEBUG, NULL, __VA_ARGS__)
#define GST_CAT_LOG(cat,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_LOG, NULL, __VA_ARGS__)
#define GST_ERROR_OBJECT(obj,...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_ERROR, obj, __VA_ARGS__)
#define GST_WARNING_OBJECT(obj,...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_WARNING, obj, __VA_ARGS__)
#define GST_INFO_OBJECT(obj,...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_INFO, obj, __VA_ARGS__)
#define GST_DEBUG_OBJECT(obj,...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_DEBUG, obj, __VA_ARGS__)
#define GST_LOG_OBJECT(obj,...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_LOG, obj, __VA_ARGS__)
#define GST_ERROR(...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_ERROR, NULL, __VA_ARGS__)
#define GST_WARNING(...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_WARNING, NULL, __VA_ARGS__)
#define GST_INFO(...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_INFO, NULL, __VA_ARGS__)
#define GST_DEBUG(...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_DEBUG, NULL, __VA_ARGS__)
#define GST_LOG(...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_LOG, NULL, __VA_ARGS__)
#else
#ifdef G_HAVE_GNUC_VARARGS
#define GST_CAT_ERROR_OBJECT(cat,obj,args...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_ERROR, obj, ##args )
#define GST_CAT_WARNING_OBJECT(cat,obj,args...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_WARNING, obj, ##args )
#define GST_CAT_INFO_OBJECT(cat,obj,args...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_INFO, obj, ##args )
#define GST_CAT_DEBUG_OBJECT(cat,obj,args...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_DEBUG, obj, ##args )
#define GST_CAT_LOG_OBJECT(cat,obj,args...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_LOG, obj, ##args )
#define GST_CAT_ERROR(cat,args...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_ERROR, NULL, ##args )
#define GST_CAT_WARNING(cat,args...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_WARNING, NULL, ##args )
#define GST_CAT_INFO(cat,args...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_INFO, NULL, ##args )
#define GST_CAT_DEBUG(cat,args...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_DEBUG, NULL, ##args )
#define GST_CAT_LOG(cat,args...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_LOG, NULL, ##args )
#define GST_ERROR_OBJECT(obj,args...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_ERROR, obj, ##args )
#define GST_WARNING_OBJECT(obj,args...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_WARNING, obj, ##args )
#define GST_INFO_OBJECT(obj,args...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_INFO, obj, ##args )
#define GST_DEBUG_OBJECT(obj,args...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_DEBUG, obj, ##args )
#define GST_LOG_OBJECT(obj,args...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_LOG, obj, ##args )
#define GST_ERROR(args...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_ERROR, NULL, ##args )
#define GST_WARNING(args...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_WARNING, NULL, ##args )
#define GST_INFO(args...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_INFO, NULL, ##args )
#define GST_DEBUG(args...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_DEBUG, NULL, ##args )
#define GST_LOG(args...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_LOG, NULL, ##args )
#else
/* no variadic macros, use inline */
static inline void
GST_CAT_ERROR_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
...)
{
va_list varargs;
va_start (varargs, format);
GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_ERROR, obj, format, varargs);
va_end (varargs);
}
static inline void
GST_CAT_WARNING_OBJECT (GstDebugCategory * cat, gpointer obj,
const char *format, ...)
{
va_list varargs;
va_start (varargs, format);
GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_WARNING, obj, format, varargs);
va_end (varargs);
}
static inline void
GST_CAT_INFO_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
...)
{
va_list varargs;
va_start (varargs, format);
GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_INFO, obj, format, varargs);
va_end (varargs);
}
static inline void
GST_CAT_DEBUG_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
...)
{
va_list varargs;
va_start (varargs, format);
GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_DEBUG, obj, format, varargs);
va_end (varargs);
}
static inline void
GST_CAT_LOG_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
...)
{
va_list varargs;
va_start (varargs, format);
GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_LOG, obj, format, varargs);
va_end (varargs);
}
static inline void
GST_CAT_ERROR (GstDebugCategory * cat, const char *format, ...)
{
va_list varargs;
va_start (varargs, format);
GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_ERROR, NULL, format, varargs);
va_end (varargs);
}
static inline void
GST_CAT_WARNING (GstDebugCategory * cat, const char *format, ...)
{
va_list varargs;
va_start (varargs, format);
GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_WARNING, NULL, format, varargs);
va_end (varargs);
}
static inline void
GST_CAT_INFO (GstDebugCategory * cat, const char *format, ...)
{
va_list varargs;
va_start (varargs, format);
GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_INFO, NULL, format, varargs);
va_end (varargs);
}
static inline void
GST_CAT_DEBUG (GstDebugCategory * cat, const char *format, ...)
{
va_list varargs;
va_start (varargs, format);
GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_DEBUG, NULL, format, varargs);
va_end (varargs);
}
static inline void
GST_CAT_LOG (GstDebugCategory * cat, const char *format, ...)
{
va_list varargs;
va_start (varargs, format);
GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_LOG, NULL, format, varargs);
va_end (varargs);
}
static inline void
GST_ERROR_OBJECT (gpointer obj, const char *format, ...)
{
va_list varargs;
va_start (varargs, format);
GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_ERROR, obj, format,
varargs);
va_end (varargs);
}
static inline void
GST_WARNING_OBJECT (gpointer obj, const char *format, ...)
{
va_list varargs;
va_start (varargs, format);
GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_WARNING, obj, format,
varargs);
va_end (varargs);
}
static inline void
GST_INFO_OBJECT (gpointer obj, const char *format, ...)
{
va_list varargs;
va_start (varargs, format);
GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_INFO, obj, format,
varargs);
va_end (varargs);
}
static inline void
GST_DEBUG_OBJECT (gpointer obj, const char *format, ...)
{
va_list varargs;
va_start (varargs, format);
GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_DEBUG, obj, format,
varargs);
va_end (varargs);
}
static inline void
GST_LOG_OBJECT (gpointer obj, const char *format, ...)
{
va_list varargs;
va_start (varargs, format);
GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_LOG, obj, format,
varargs);
va_end (varargs);
}
static inline void
GST_ERROR (const char *format, ...)
{
va_list varargs;
va_start (varargs, format);
GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_ERROR, NULL, format,
varargs);
va_end (varargs);
}
static inline void
GST_WARNING (const char *format, ...)
{
va_list varargs;
va_start (varargs, format);
GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_WARNING, NULL, format,
varargs);
va_end (varargs);
}
static inline void
GST_INFO (const char *format, ...)
{
va_list varargs;
va_start (varargs, format);
GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_INFO, NULL, format,
varargs);
va_end (varargs);
}
static inline void
GST_DEBUG (const char *format, ...)
{
va_list varargs;
va_start (varargs, format);
GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_DEBUG, NULL, format,
varargs);
va_end (varargs);
}
static inline void
GST_LOG (const char *format, ...)
{
va_list varargs;
va_start (varargs, format);
GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_LOG, NULL,
format, varargs);
va_end (varargs);
}
#endif
#endif
/********** function pointer stuff **********/
typedef void (* GstDebugFuncPtr) (void);
void _gst_debug_register_funcptr (GstDebugFuncPtr func,
const gchar * ptrname);
G_CONST_RETURN gchar *
_gst_debug_nameof_funcptr (GstDebugFuncPtr func);
/**
* GST_DEBUG_FUNCPTR:
* @ptr: pointer to the function to register
*
* Register a pointer to a function with its name, so it can later be used by
* GST_DEBUG_FUNCPTR_NAME().
*/
#define GST_DEBUG_FUNCPTR(ptr) \
(_gst_debug_register_funcptr((GstDebugFuncPtr)(ptr), #ptr) , ptr)
/**
* GST_DEBUG_FUNCPTR_NAME:
* @ptr: address of the function of which to look up the name
*
* Retrieves the name of the function, if it was previously registered with
* GST_DEBUG_FUNCPTR(). If not, it returns a description of the pointer.
*
* This macro returns a constant string which must not be modified or
* freed by the caller.
*/
#define GST_DEBUG_FUNCPTR_NAME(ptr) \
_gst_debug_nameof_funcptr((GstDebugFuncPtr)ptr)
#else /* GST_DISABLE_GST_DEBUG */
#if defined(__GNUC__) && __GNUC__ >= 3
# pragma GCC poison gst_debug_log
# pragma GCC poison gst_debug_log_valist
# pragma GCC poison _gst_debug_category_new
#endif
#define _gst_debug_init() /* NOP */
#define gst_debug_set_default_threshold(level) /* NOP */
#define gst_debug_get_default_threshold() (GST_LEVEL_NONE)
#define gst_debug_level_get_name(level) ("NONE")
#define gst_debug_message_get(message) ("NONE")
#define gst_debug_add_log_function(func,data) /* NOP */
guint gst_debug_remove_log_function (GstLogFunction func);
guint gst_debug_remove_log_function_by_data (gpointer data);
#define gst_debug_set_active(active) /* NOP */
#define gst_debug_is_active() (FALSE)
#define gst_debug_set_colored(colored) /* NOP */
#define gst_debug_is_colored() (FALSE)
#define gst_debug_set_default_threshold(level) /* NOP */
#define gst_debug_get_default_threshold() (GST_LEVEL_NONE)
#define gst_debug_set_threshold_for_name(name,level) /* NOP */
#define gst_debug_unset_threshold_for_name(name) /* NOP */
#define GST_DEBUG_CATEGORY(var) /* NOP */
#define GST_DEBUG_CATEGORY_EXTERN(var) /* NOP */
#if !defined(G_HAVE_GNUC_VARARGS) && !defined(G_HAVE_ISO_VARARGS)
#define GST_DEBUG_CATEGORY_STATIC(var) static GstDebugCategory *var = NULL
#else
#define GST_DEBUG_CATEGORY_STATIC(var) /* NOP */
#endif
#define GST_DEBUG_CATEGORY_INIT(var,name,color,desc) /* NOP */
#define gst_debug_category_free(category) /* NOP */
#define gst_debug_category_set_threshold(category,level) /* NOP */
#define gst_debug_category_reset_threshold(category) /* NOP */
#define gst_debug_category_get_threshold(category) (GST_LEVEL_NONE)
#define gst_debug_category_get_name(cat) ("")
#define gst_debug_category_get_color(cat) (0)
#define gst_debug_category_get_description(cat) ("")
#define gst_debug_get_all_categories() (NULL)
#define gst_debug_construct_term_color(colorinfo) (g_strdup ("00"))
#ifdef G_HAVE_ISO_VARARGS
#define GST_CAT_LEVEL_LOG(cat,level,...) /* NOP */
#define GST_CAT_ERROR_OBJECT(...) /* NOP */
#define GST_CAT_WARNING_OBJECT(...) /* NOP */
#define GST_CAT_INFO_OBJECT(...) /* NOP */
#define GST_CAT_DEBUG_OBJECT(...) /* NOP */
#define GST_CAT_LOG_OBJECT(...) /* NOP */
#define GST_CAT_ERROR(...) /* NOP */
#define GST_CAT_WARNING(...) /* NOP */
#define GST_CAT_INFO(...) /* NOP */
#define GST_CAT_DEBUG(...) /* NOP */
#define GST_CAT_LOG(...) /* NOP */
#define GST_ERROR_OBJECT(...) /* NOP */
#define GST_WARNING_OBJECT(...) /* NOP */
#define GST_INFO_OBJECT(...) /* NOP */
#define GST_DEBUG_OBJECT(...) /* NOP */
#define GST_LOG_OBJECT(...) /* NOP */
#define GST_ERROR(...) /* NOP */
#define GST_WARNING(...) /* NOP */
#define GST_INFO(...) /* NOP */
#define GST_DEBUG(...) /* NOP */
#define GST_LOG(...) /* NOP */
#else
#ifdef G_HAVE_GNUC_VARARGS
#define GST_CAT_LEVEL_LOG(cat,level,args...) /* NOP */
#define GST_CAT_ERROR_OBJECT(args...) /* NOP */
#define GST_CAT_WARNING_OBJECT(args...) /* NOP */
#define GST_CAT_INFO_OBJECT(args...) /* NOP */
#define GST_CAT_DEBUG_OBJECT(args...) /* NOP */
#define GST_CAT_LOG_OBJECT(args...) /* NOP */
#define GST_CAT_ERROR(args...) /* NOP */
#define GST_CAT_WARNING(args...) /* NOP */
#define GST_CAT_INFO(args...) /* NOP */
#define GST_CAT_DEBUG(args...) /* NOP */
#define GST_CAT_LOG(args...) /* NOP */
#define GST_ERROR_OBJECT(args...) /* NOP */
#define GST_WARNING_OBJECT(args...) /* NOP */
#define GST_INFO_OBJECT(args...) /* NOP */
#define GST_DEBUG_OBJECT(args...) /* NOP */
#define GST_LOG_OBJECT(args...) /* NOP */
#define GST_ERROR(args...) /* NOP */
#define GST_WARNING(args...) /* NOP */
#define GST_INFO(args...) /* NOP */
#define GST_DEBUG(args...) /* NOP */
#define GST_LOG(args...) /* NOP */
#else
static inline void
GST_CAT_LEVEL_LOG_valist (GstDebugCategory * cat,
GstDebugLevel level, gpointer object, const char *format, va_list varargs)
{
}
static inline void
GST_CAT_ERROR_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
...)
{
}
static inline void
GST_CAT_WARNING_OBJECT (GstDebugCategory * cat, gpointer obj,
const char *format, ...)
{
}
static inline void
GST_CAT_INFO_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
...)
{
}
static inline void
GST_CAT_DEBUG_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
...)
{
}
static inline void
GST_CAT_LOG_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
...)
{
}
static inline void
GST_CAT_ERROR (GstDebugCategory * cat, const char *format, ...)
{
}
static inline void
GST_CAT_WARNING (GstDebugCategory * cat, const char *format, ...)
{
}
static inline void
GST_CAT_INFO (GstDebugCategory * cat, const char *format, ...)
{
}
static inline void
GST_CAT_DEBUG (GstDebugCategory * cat, const char *format, ...)
{
}
static inline void
GST_CAT_LOG (GstDebugCategory * cat, const char *format, ...)
{
}
static inline void
GST_ERROR_OBJECT (gpointer obj, const char *format, ...)
{
}
static inline void
GST_WARNING_OBJECT (gpointer obj, const char *format, ...)
{
}
static inline void
GST_INFO_OBJECT (gpointer obj, const char *format, ...)
{
}
static inline void
GST_DEBUG_OBJECT (gpointer obj, const char *format, ...)
{
}
static inline void
GST_LOG_OBJECT (gpointer obj, const char *format, ...)
{
}
static inline void
GST_ERROR (const char *format, ...)
{
}
static inline void
GST_WARNING (const char *format, ...)
{
}
static inline void
GST_INFO (const char *format, ...)
{
}
static inline void
GST_DEBUG (const char *format, ...)
{
}
static inline void
GST_LOG (const char *format, ...)
{
}
#endif
#endif
#define GST_DEBUG_FUNCPTR(ptr) (ptr)
#define GST_DEBUG_FUNCPTR_NAME(ptr) (g_strdup_printf ("%p", ptr))
#endif /* GST_DISABLE_GST_DEBUG */
void gst_debug_print_stack_trace (void);
G_END_DECLS
#endif /* __GSTINFO_H__ */