/* GStreamer * Copyright (C) 1999,2000 Erik Walthinsen * 2000 Wim Taymans * 2003 Benjamin Otte * * gstinfo.h: debugging functions * * 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., 51 Franklin St, Fifth Floor, * Boston, MA 02110-1301, USA. */ #ifndef __GSTINFO_H__ #define __GSTINFO_H__ #include "gstclock.h" #include #include #include #include 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 occurred * 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_error. * @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_FIXME: Fixme messages are messages that indicate that something * in the executed code path is not fully implemented or handled yet. Note * that this does not replace proper error handling in any way, the purpose * of this message is to make it easier to spot incomplete/unfinished pieces * of code when reading the debug log. * @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, or something that's * useful to know but doesn't happen all the time (ie. per loop iteration or * buffer processed or event handled). * 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 running as expected * should never output anything else but LOG messages whilst processing data. * Use this log level to log recurring information in chain functions and * loop functions, for example. * @GST_LEVEL_TRACE: Tracing-related messages. * Examples for this are referencing/dereferencing of objects. * @GST_LEVEL_MEMDUMP: memory dump messages are used to log (small) chunks of * data as memory dumps in the log. They will be displayed as hexdump with * ASCII characters. * @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 = 1, GST_LEVEL_WARNING = 2, GST_LEVEL_FIXME = 3, GST_LEVEL_INFO = 4, GST_LEVEL_DEBUG = 5, GST_LEVEL_LOG = 6, GST_LEVEL_TRACE = 7, /* add more */ GST_LEVEL_MEMDUMP = 9, /* 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 /** * GST_LEVEL_MAX: * * Defines the maximum debugging level to be enabled at compilation time. By default * it is set such that all debugging statements will be enabled. * * If you wish to compile GStreamer and plugins with only some debugging statements * (Such as just warnings and errors), you can define it at compile time to the * maximum debug level. Any debug statements above that level will be compiled out. * * Since: 1.6 */ #ifndef GST_LEVEL_MAX #define GST_LEVEL_MAX GST_LEVEL_COUNT #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 { /*< flags >*/ /* 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; /** * GstStackTraceFlags: * @GST_STACK_TRACE_SHOW_NONE: Try to retrieve the minimum information * available, which may be none on some platforms * (Since: 1.18) * @GST_STACK_TRACE_SHOW_FULL: Try to retrieve as much information as possible, * including source information when getting the * stack trace * * Since: 1.12 */ typedef enum { GST_STACK_TRACE_SHOW_NONE = 0, GST_STACK_TRACE_SHOW_FULL = 1 << 0 } GstStackTraceFlags; /** * GstDebugColorMode: * @GST_DEBUG_COLOR_MODE_OFF: Do not use colors in logs. * @GST_DEBUG_COLOR_MODE_ON: Paint logs in a platform-specific way. * @GST_DEBUG_COLOR_MODE_UNIX: Paint logs with UNIX terminal color codes * no matter what platform GStreamer is running on. */ typedef enum { GST_DEBUG_COLOR_MODE_OFF = 0, GST_DEBUG_COLOR_MODE_ON = 1, GST_DEBUG_COLOR_MODE_UNIX = 2 } GstDebugColorMode; #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: (allow-none): 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 dependent. If it * is not defined, some default value is used. It is used to provide debugging * output with the function name of the message. * * Note that this is different from G_STRFUNC as we do not want the full * function signature in C++ code. */ #ifndef GST_FUNCTION #if defined (__STDC__) && defined (__STDC_VERSION__) && __STDC_VERSION__ >= 199901L # define GST_FUNCTION ((const char*) (__func__)) #elif defined (__GNUC__) || (defined (_MSC_VER) && _MSC_VER >= 1300) # define GST_FUNCTION ((const char*) (__FUNCTION__)) #else # define GST_FUNCTION ((const char*) ("???")) #endif #endif /* ifndef GST_FUNCTION */ /** * GST_PTR_FORMAT: (skip): * * printf format type used to debug GStreamer types. You can use this in * combination with GStreamer's debug logging system as well as the functions * gst_info_vasprintf(), gst_info_strdup_vprintf() and gst_info_strdup_printf() * to pretty-print the following types: #GstCaps, #GstStructure, * #GstCapsFeatures, #GstTagList, #GstDateTime, #GstBuffer, #GstBufferList, * #GstMessage, #GstEvent, #GstQuery, #GstContext, #GstPad, #GstObject. All * #GObject types will be printed as typename plus pointer, and everything * else will simply be printed as pointer address. * * This can only be used on types whose size is >= sizeof(gpointer). */ #define GST_PTR_FORMAT "p\aA" /** * GST_SEGMENT_FORMAT: (skip): * * printf format type used to debug GStreamer segments. You can use this in * combination with GStreamer's debug logging system as well as the functions * gst_info_vasprintf(), gst_info_strdup_vprintf() and gst_info_strdup_printf() * to pretty-print #GstSegment structures. * This can only be used on pointers to GstSegment structures. */ #define GST_SEGMENT_FORMAT "p\aB" /** * GST_TIMEP_FORMAT: (skip): * * printf format type used to debug GStreamer ClockTime pointers. You can use * this in combination with GStreamer's debug logging system as well as the * functions gst_info_vasprintf(), gst_info_strdup_vprintf() and * gst_info_strdup_printf() to pretty-print #GstClockTime pointers. This can * only be used on pointers to GstClockTime values. * * Since: 1.18 */ #define GST_TIMEP_FORMAT "p\aT" /** * GST_STIMEP_FORMAT: (skip): * * printf format type used to debug GStreamer signed time value pointers. You * can use this in combination with GStreamer's debug logging system as well as * the functions gst_info_vasprintf(), gst_info_strdup_vprintf() and * gst_info_strdup_printf() to pretty-print signed time (pointers to * #GstClockTimeDiff or #gint64). * * Since: 1.18 */ #define GST_STIMEP_FORMAT "p\aS" 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 * @user_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 user_data); GST_API 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; GST_API 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; GST_API void gst_debug_log_literal (GstDebugCategory * category, GstDebugLevel level, const gchar * file, const gchar * function, gint line, GObject * object, const gchar * message_string) G_GNUC_NO_INSTRUMENT; GST_API void gst_debug_log_id (GstDebugCategory * category, GstDebugLevel level, const gchar * file, const gchar * function, gint line, const gchar * id, const gchar * format, ...) G_GNUC_PRINTF (7, 8) G_GNUC_NO_INSTRUMENT; GST_API void gst_debug_log_id_valist (GstDebugCategory * category, GstDebugLevel level, const gchar * file, const gchar * function, gint line, const gchar * id, const gchar * format, va_list args) G_GNUC_NO_INSTRUMENT; GST_API void gst_debug_log_id_literal (GstDebugCategory * category, GstDebugLevel level, const gchar * file, const gchar * function, gint line, const gchar * id, const gchar * message_string) G_GNUC_NO_INSTRUMENT; /* do not use this function, use the GST_DEBUG_CATEGORY_INIT macro */ GST_API GstDebugCategory *_gst_debug_category_new (const gchar * name, guint color, const gchar * description); /* do not use this function, use the GST_DEBUG_CATEGORY_GET macro */ GST_API GstDebugCategory *_gst_debug_get_category (const gchar *name); /* do not use these functions, use the GST_CAT_MEMDUMP_* macros */ GST_API void _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file, const gchar * func, gint line, GObject * obj, const gchar * msg, const guint8 * data, guint length); GST_API void _gst_debug_dump_mem_id (GstDebugCategory * cat, const gchar * file, const gchar * func, gint line, const gchar *object_id, const gchar * msg, const guint8 * data, guint length); /** * GstDebugFuncPtr: (attributes doc.skip=true) * we define this to avoid a compiler warning regarding a cast from a function * pointer to a void pointer * (see https://bugzilla.gnome.org/show_bug.cgi?id=309253) */ typedef void (* GstDebugFuncPtr) (void); /* do no use these functions, use the GST_DEBUG*_FUNCPTR macros */ GST_API void _gst_debug_register_funcptr (GstDebugFuncPtr func, const gchar * ptrname); GST_API const gchar * _gst_debug_nameof_funcptr (GstDebugFuncPtr func) G_GNUC_NO_INSTRUMENT; GST_API const gchar * gst_debug_message_get (GstDebugMessage * message); GST_API const gchar * gst_debug_message_get_id (GstDebugMessage * message); GST_API gchar * gst_debug_log_get_line (GstDebugCategory * category, GstDebugLevel level, const gchar * file, const gchar * function, gint line, GObject * object, GstDebugMessage * message) G_GNUC_NO_INSTRUMENT; GST_API void gst_debug_log_default (GstDebugCategory * category, GstDebugLevel level, const gchar * file, const gchar * function, gint line, GObject * object, GstDebugMessage * message, gpointer user_data) G_GNUC_NO_INSTRUMENT; GST_API const gchar * gst_debug_level_get_name (GstDebugLevel level); GST_API void gst_debug_add_log_function (GstLogFunction func, gpointer user_data, GDestroyNotify notify); GST_API guint gst_debug_remove_log_function (GstLogFunction func); GST_API guint gst_debug_remove_log_function_by_data (gpointer data); GST_API void gst_debug_set_active (gboolean active); GST_API gboolean gst_debug_is_active (void); GST_API void gst_debug_set_colored (gboolean colored); GST_API void gst_debug_set_color_mode (GstDebugColorMode mode); GST_API void gst_debug_set_color_mode_from_string (const gchar * mode); GST_API gboolean gst_debug_is_colored (void); GST_API GstDebugColorMode gst_debug_get_color_mode (void); GST_API void gst_debug_set_default_threshold (GstDebugLevel level); GST_API GstDebugLevel gst_debug_get_default_threshold (void); GST_API void gst_debug_set_threshold_for_name (const gchar * name, GstDebugLevel level); GST_API void gst_debug_set_threshold_from_string (const gchar * list, gboolean reset); GST_API void gst_debug_unset_threshold_for_name (const gchar * name); GST_DEPRECATED void gst_debug_category_free (GstDebugCategory * category); GST_API void gst_debug_category_set_threshold (GstDebugCategory * category, GstDebugLevel level); GST_API void gst_debug_category_reset_threshold (GstDebugCategory * category); GST_API GstDebugLevel gst_debug_category_get_threshold (GstDebugCategory * category); GST_API const gchar * gst_debug_category_get_name (GstDebugCategory * category); GST_API guint gst_debug_category_get_color (GstDebugCategory * category); GST_API const gchar * gst_debug_category_get_description (GstDebugCategory * category); GST_API GSList * gst_debug_get_all_categories (void); GST_API gchar * gst_debug_print_object (gconstpointer ptr); GST_API gchar * gst_debug_print_segment (const GstSegment *segment); GST_API gchar * gst_debug_construct_term_color (guint colorinfo); GST_API gint gst_debug_construct_win_color (guint colorinfo); GST_API gint gst_info_vasprintf (gchar ** result, const gchar * format, va_list args) G_GNUC_PRINTF (2, 0); GST_API gchar * gst_info_strdup_vprintf (const gchar *format, va_list args) G_GNUC_PRINTF (1, 0); GST_API gchar * gst_info_strdup_printf (const gchar *format, ...) G_GNUC_PRINTF (1, 2); GST_API void gst_print (const gchar * format, ...) G_GNUC_PRINTF (1, 2); GST_API void gst_println (const gchar * format, ...) G_GNUC_PRINTF (1, 2); GST_API void gst_printerr (const gchar * format, ...) G_GNUC_PRINTF (1, 2); GST_API void gst_printerrln (const gchar * format, ...) G_GNUC_PRINTF (1, 2); #ifndef GST_DISABLE_GST_DEBUG /* cast to void * avoids a warning with gcc 6 * see https://bugzilla.gnome.org/show_bug.cgi?id=764526 */ #define gst_debug_add_log_function(func,data,notify) \ G_STMT_START{ \ if ((void *) (func) == (void *) gst_debug_log_default) { \ gst_debug_add_log_function(NULL,data,notify); \ } else { \ gst_debug_add_log_function(func,data,notify); \ } \ }G_STMT_END #define gst_debug_remove_log_function(func) \ ((void *) (func) == (void *) gst_debug_log_default) ? \ gst_debug_remove_log_function(NULL) : \ gst_debug_remove_log_function(func) /** * 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 /** * 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. * * If your element uses static features, this should be called in * `class_init()` for the feature, and not in `plugin_init()` since that will * not be called if a static feature is registered manually. * * If you need to share the same category across multiple features, you can * move the call to a shared function and use #GOnce to make it re-entrant so * that the category is initialized exactly once. * * > This macro expands to nothing if debugging is disabled. * > * > 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. * > * > 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" * > * > 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. * */ #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 /** * GST_DEBUG_CATEGORY_GET: * @cat: the category to initialize. * @name: log category name * * Looks up an existing #GstDebugCategory by its @name and sets @cat. If the * category is not found, but GST_CAT_DEFAULT is defined, that is assigned to * @cat. Otherwise @cat will be %NULL. * * |[ * GST_DEBUG_CATEGORY_STATIC (gst_myplugin_debug); * #define GST_CAT_DEFAULT gst_myplugin_debug * GST_DEBUG_CATEGORY_STATIC (GST_CAT_PERFORMANCE); * ... * GST_DEBUG_CATEGORY_INIT (gst_myplugin_debug, "myplugin", 0, "nice element"); * GST_DEBUG_CATEGORY_GET (GST_CAT_PERFORMANCE, "GST_PERFORMANCE"); * ]| */ #ifdef GST_CAT_DEFAULT #define GST_DEBUG_CATEGORY_GET(cat,name) G_STMT_START{\ cat = _gst_debug_get_category (name); \ if (!cat) { \ cat = GST_CAT_DEFAULT; \ } \ }G_STMT_END #else #define GST_DEBUG_CATEGORY_GET(cat,name) G_STMT_START{\ cat = _gst_debug_get_category (name); \ }G_STMT_END #endif /** * GST_CAT_DEFAULT: * * Default gstreamer core debug log category. Please define your own. */ GST_API GstDebugCategory * GST_CAT_DEFAULT; /* this symbol may not be used */ GST_API gboolean _gst_debug_enabled; /* the min debug level, used for quickly discarding debug * messages that fall under the threshold. */ GST_API GstDebugLevel _gst_debug_min; /** * GST_CAT_LEVEL_LOG: * @cat: category to use * @level: the severity of the message * @object: (allow-none): the #GObject the message belongs to or %NULL if none * @...: A printf-style message to output * * Outputs a debugging message with a specific category and level. This is the * most general macro for this purpose. You will probably want to use one of * the simpler ones described below. * * There is no need to finish the end of the debug message with a newline * character, a newline character will be added automatically. */ #define GST_CAT_LEVEL_LOG(cat,level,object,...) G_STMT_START{ \ if (G_UNLIKELY (((level) <= GST_LEVEL_MAX) && ((level) <= _gst_debug_min))) { \ gst_debug_log ((cat), (level), __FILE__, GST_FUNCTION, __LINE__, \ (GObject *) (object), __VA_ARGS__); \ } \ }G_STMT_END /** * GST_CAT_LEVEL_LOG_ID: * @cat: category to use * @level: the severity of the message * @id: (transfer none) (allow-none): the identifier of the object this message * relates to, or %NULL if none * @...: A printf-style message to output * * Outputs a debugging message with an identifier. This is the most general * macro for this purpose. You will probably want to use one of the simpler * ones described below. * * There is no need to finish the end of the debug message with a newline * character, a newline character will be added automatically. * * Since: 1.22 */ #define GST_CAT_LEVEL_LOG_ID(cat,level,id,...) G_STMT_START{ \ if (G_UNLIKELY (((level) <= GST_LEVEL_MAX) && ((level) <= _gst_debug_min))) { \ gst_debug_log_id ((cat), (level), __FILE__, GST_FUNCTION, __LINE__, \ (id), __VA_ARGS__); \ } \ }G_STMT_END /* This one doesn't have varargs in the macro, so it's different than all the * other macros and hence in a separate block right here. Docs chunks are * with the other doc chunks below though. */ #define __GST_CAT_MEMDUMP_LOG(cat,object,msg,data,length) G_STMT_START{ \ if (G_UNLIKELY ((GST_LEVEL_MEMDUMP <= GST_LEVEL_MAX) && \ (GST_LEVEL_MEMDUMP <= _gst_debug_min))) { \ _gst_debug_dump_mem ((cat), __FILE__, GST_FUNCTION, __LINE__, \ (GObject *) (object), (msg), (data), (length)); \ } \ }G_STMT_END /** * __GST_CAT_MEMDUMP_LOG_ID: * * Only for private usage * * This one doesn't have varargs in the macro, so it's different than all the * other macros and hence in a separate block right here. Docs chunks are * with the other doc chunks below though. * * Since: 1.22 */ #define __GST_CAT_MEMDUMP_LOG_ID(cat,id,msg,data,length) G_STMT_START{ \ if (G_UNLIKELY ((GST_LEVEL_MEMDUMP <= GST_LEVEL_MAX) && \ (GST_LEVEL_MEMDUMP <= _gst_debug_min))) { \ _gst_debug_dump_mem_id ((cat), __FILE__, GST_FUNCTION, __LINE__, \ (id), (msg), (data), (length)); \ } \ }G_STMT_END #define GST_CAT_MEMDUMP_OBJECT(cat,obj,msg,data,length) \ __GST_CAT_MEMDUMP_LOG(cat,obj,msg,data,length) #define GST_CAT_MEMDUMP_ID(cat,id,msg,data,length) \ __GST_CAT_MEMDUMP_LOG_ID(cat,id,msg,data,length) #define GST_CAT_MEMDUMP(cat,msg,data,length) \ __GST_CAT_MEMDUMP_LOG(cat,NULL,msg,data,length) #define GST_MEMDUMP_OBJECT(obj,msg,data,length) \ __GST_CAT_MEMDUMP_LOG(GST_CAT_DEFAULT,obj,msg,data,length) #define GST_MEMDUMP_ID(id,msg,data,length) \ __GST_CAT_MEMDUMP_LOG_ID(GST_CAT_DEFAULT,id,msg,data,length) #define GST_MEMDUMP(msg,data,length) \ __GST_CAT_MEMDUMP_LOG(GST_CAT_DEFAULT,NULL,msg,data,length) /** * 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. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * 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. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * 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. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * GST_CAT_DEBUG_OBJECT: * @cat: category to use * @obj: the #GObject the message belongs to * @...: printf-style message to output * * Output a debugging message belonging to the given object in the given category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * GST_CAT_LOG_OBJECT: * @cat: category to use * @obj: the #GObject the message belongs to * @...: printf-style message to output * * Output a logging message belonging to the given object in the given * category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * GST_CAT_FIXME_OBJECT: * @cat: category to use * @obj: the #GObject the message belongs to * @...: printf-style message to output * * Output a fixme message belonging to the given object in the given category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * GST_CAT_TRACE_OBJECT: * @cat: category to use * @obj: the #GObject the message belongs to * @...: printf-style message to output * * Output a tracing message belonging to the given object in the given * category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * GST_CAT_MEMDUMP_OBJECT: * @cat: category to use * @obj: the #GObject the message belongs to * @msg: message string to log with the data * @data: pointer to the data to output * @length: length of the data to output * * Output a hexdump of @data relating to the given object in the given * category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * GST_CAT_MEMDUMP_ID: * @cat: category to use * @id: An identifier of the message provider * @msg: message string to log with the data * @data: pointer to the data to output * @length: length of the data to output * * Output a hexdump of @data relating to the given @id in the given category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.22 */ /** * GST_CAT_ERROR: * @cat: category to use * @...: printf-style message to output * * Output an error message in the given category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * GST_CAT_WARNING: * @cat: category to use * @...: printf-style message to output * * Output an warning message in the given category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * GST_CAT_INFO: * @cat: category to use * @...: printf-style message to output * * Output an informational message in the given category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * GST_CAT_DEBUG: * @cat: category to use * @...: printf-style message to output * * Output a debugging message in the given category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * GST_CAT_LOG: * @cat: category to use * @...: printf-style message to output * * Output a logging message in the given category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * GST_CAT_FIXME: * @cat: category to use * @...: printf-style message to output * * Output an fixme message in the given category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * GST_CAT_TRACE: * @cat: category to use * @...: printf-style message to output * * Output a tracing message in the given category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * GST_CAT_MEMDUMP: * @cat: category to use * @msg: message string to log with the data * @data: pointer to the data to output * @length: length of the data to output * * Output a hexdump of @data in the given category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * 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. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * 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. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * 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. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * 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. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * 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. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * GST_FIXME_OBJECT: * @obj: the #GObject the message belongs to * @...: printf-style message to output * * Output a fixme message belonging to the given object in the default category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * GST_TRACE_OBJECT: * @obj: the #GObject the message belongs to * @...: printf-style message to output * * Output a tracing message belonging to the given object in the default category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * GST_MEMDUMP_OBJECT: * @obj: the #GObject the message belongs to * @msg: message string to log with the data * @data: pointer to the data to output * @length: length of the data to output * * Output a logging message belonging to the given object in the default category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * GST_ERROR_ID: * @id: An identifier of the message provider * @...: printf-style message to output * * Output an error message for the given identifier in the default category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.22 */ /** * GST_WARNING_ID: * @id: An identifier of the message provider * @...: printf-style message to output * * Output a warning message for the given identifier in the default category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.22 */ /** * GST_INFO_ID: * @id: An identifier of the message provider * @...: printf-style message to output * * Output an informational message for the given identifier the default * category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.22 */ /** * GST_DEBUG_ID: * @id: An identifier of the message provider * @...: printf-style message to output * * Output a debugging message for the given identifier in the default category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.22 */ /** * GST_LOG_ID: * @id: An identifier of the message provider * @...: printf-style message to output * * Output a logging message for the given identifier in the default category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.22 */ /** * GST_FIXME_ID: * @id: An identifier of the message provider * @...: printf-style message to output * * Output a fixme message for the given identifier in the default category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.22 */ /** * GST_TRACE_ID: * @id: An identifier of the message provider * @...: printf-style message to output * * Output a tracing message for the given identifier in the default category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.22 */ /** * GST_MEMDUMP_ID: * @id: An identifier of the message provider * @msg: message string to log with the data * @data: pointer to the data to output * @length: length of the data to output * * Output a logging message belonging to the given object in the default category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.22 */ /** * GST_ERROR: * @...: printf-style message to output * * Output an error message in the default category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * GST_WARNING: * @...: printf-style message to output * * Output a warning message in the default category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * GST_INFO: * @...: printf-style message to output * * Output an informational message in the default category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * GST_DEBUG: * @...: printf-style message to output * * Output a debugging message in the default category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * GST_LOG: * @...: printf-style message to output * * Output a logging message in the default category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * GST_FIXME: * @...: printf-style message to output * * Output a fixme message in the default category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * GST_TRACE: * @...: printf-style message to output * * Output a tracing message in the default category. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ /** * GST_MEMDUMP: * @msg: message string to log with the data * @data: pointer to the data to output * @length: length of the data to output * * Output a hexdump of @data. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. */ #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_FIXME_OBJECT(cat,obj,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_FIXME, obj, __VA_ARGS__) #define GST_CAT_TRACE_OBJECT(cat,obj,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_TRACE, 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_CAT_FIXME(cat,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_FIXME, NULL, __VA_ARGS__) #define GST_CAT_TRACE(cat,...) GST_CAT_LEVEL_LOG (cat, GST_LEVEL_TRACE, 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_FIXME_OBJECT(obj,...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_FIXME, obj, __VA_ARGS__) #define GST_TRACE_OBJECT(obj,...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_TRACE, obj, __VA_ARGS__) #define GST_ERROR_ID(id,...) GST_CAT_LEVEL_LOG_ID (GST_CAT_DEFAULT, GST_LEVEL_ERROR, id, __VA_ARGS__) #define GST_WARNING_ID(id,...) GST_CAT_LEVEL_LOG_ID (GST_CAT_DEFAULT, GST_LEVEL_WARNING, id, __VA_ARGS__) #define GST_INFO_ID(id,...) GST_CAT_LEVEL_LOG_ID (GST_CAT_DEFAULT, GST_LEVEL_INFO, id, __VA_ARGS__) #define GST_DEBUG_ID(id,...) GST_CAT_LEVEL_LOG_ID (GST_CAT_DEFAULT, GST_LEVEL_DEBUG, id, __VA_ARGS__) #define GST_LOG_ID(id,...) GST_CAT_LEVEL_LOG_ID (GST_CAT_DEFAULT, GST_LEVEL_LOG, id, __VA_ARGS__) #define GST_FIXME_ID(id,...) GST_CAT_LEVEL_LOG_ID (GST_CAT_DEFAULT, GST_LEVEL_FIXME, id, __VA_ARGS__) #define GST_TRACE_ID(id,...) GST_CAT_LEVEL_LOG_ID (GST_CAT_DEFAULT, GST_LEVEL_TRACE, id, __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__) #define GST_FIXME(...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_FIXME, NULL, __VA_ARGS__) #define GST_TRACE(...) GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_TRACE, NULL, __VA_ARGS__) /* Context-based debug macros */ #define GST_CTX_LEVEL_LOG(ctx,level,object,...) \ G_STMT_START{ \ if (G_UNLIKELY (gst_debug_category_get_threshold (gst_log_context_get_category (ctx)) >= (level))) { \ gst_debug_log_with_context (ctx, level, __FILE__, \ GST_FUNCTION, __LINE__, (GObject*) object, __VA_ARGS__); \ } \ }G_STMT_END /* With default category and objects */ #define GST_CTX_ERROR_OBJECT(ctx,object,...) GST_CTX_LEVEL_LOG(ctx,GST_LEVEL_ERROR,object,__VA_ARGS__) #define GST_CTX_WARNING_OBJECT(ctx,object,...) GST_CTX_LEVEL_LOG(ctx,GST_LEVEL_WARNING,object,__VA_ARGS__) #define GST_CTX_INFO_OBJECT(ctx,object,...) GST_CTX_LEVEL_LOG(ctx,GST_LEVEL_INFO,object,__VA_ARGS__) #define GST_CTX_DEBUG_OBJECT(ctx,object,...) GST_CTX_LEVEL_LOG(ctx,GST_LEVEL_DEBUG,object,__VA_ARGS__) #define GST_CTX_LOG_OBJECT(ctx,object,...) GST_CTX_LEVEL_LOG(ctx,GST_LEVEL_LOG,object,__VA_ARGS__) #define GST_CTX_FIXME_OBJECT(ctx,object,...) GST_CTX_LEVEL_LOG(ctx,GST_LEVEL_FIXME,object,__VA_ARGS__) #define GST_CTX_TRACE_OBJECT(ctx,object,...) GST_CTX_LEVEL_LOG(ctx,GST_LEVEL_TRACE,object,__VA_ARGS__) /* Context-based debug macros for IDs */ #define GST_CTX_LEVEL_LOG_ID(ctx,level,id,...) \ G_STMT_START{ \ if (G_UNLIKELY (gst_debug_category_get_threshold (gst_log_context_get_category (ctx)) >= (level))) { \ gst_debug_log_id_with_context (ctx, level, __FILE__, \ GST_FUNCTION, __LINE__, id, __VA_ARGS__); \ } \ }G_STMT_END /* With ids */ #define GST_CTX_ERROR_ID(ctx,id,...) GST_CTX_LEVEL_LOG_ID(ctx,GST_LEVEL_ERROR,id,__VA_ARGS__) #define GST_CTX_WARNING_ID(ctx,id,...) GST_CTX_LEVEL_LOG_ID(ctx,GST_LEVEL_WARNING,id,__VA_ARGS__) #define GST_CTX_INFO_ID(ctx,id,...) GST_CTX_LEVEL_LOG_ID(ctx,GST_LEVEL_INFO,id,__VA_ARGS__) #define GST_CTX_DEBUG_ID(ctx,id,...) GST_CTX_LEVEL_LOG_ID(ctx,GST_LEVEL_DEBUG,id,__VA_ARGS__) #define GST_CTX_LOG_ID(ctx,id,...) GST_CTX_LEVEL_LOG_ID(ctx,GST_LEVEL_LOG,id,__VA_ARGS__) #define GST_CTX_FIXME_ID(ctx,id,...) GST_CTX_LEVEL_LOG_ID(ctx,GST_LEVEL_FIXME,id,__VA_ARGS__) #define GST_CTX_TRACE_ID(ctx,id,...) GST_CTX_LEVEL_LOG_ID(ctx,GST_LEVEL_TRACE,id,__VA_ARGS__) /* No object, no id */ #define GST_CTX_ERROR(ctx,...) GST_CTX_ERROR_OBJECT(ctx,NULL,__VA_ARGS__) #define GST_CTX_WARNING(ctx,...) GST_CTX_WARNING_OBJECT(ctx,NULL,__VA_ARGS__) #define GST_CTX_INFO(ctx,...) GST_CTX_INFO_OBJECT(ctx,NULL,__VA_ARGS__) #define GST_CTX_DEBUG(ctx,...) GST_CTX_DEBUG_OBJECT(ctx,NULL,__VA_ARGS__) #define GST_CTX_LOG(ctx,...) GST_CTX_LOG_OBJECT(ctx,NULL,__VA_ARGS__) #define GST_CTX_FIXME(ctx,...) GST_CTX_FIXME_OBJECT(ctx,NULL,__VA_ARGS__) #define GST_CTX_TRACE(ctx,...) GST_CTX_TRACE_OBJECT(ctx,NULL,__VA_ARGS__) #define GST_LOG_CONTEXT_STATIC_DEFINE(name, flags, ...) \ static GstLogContext *name = NULL; \ static void _init_##name (void) { \ GstLogContextBuilder *builder = GST_LOG_CONTEXT_BUILDER_NEW(flags); \ GST_LOG_CONTEXT_BUILDER_SET_CATEGORY(GST_CAT_DEFAULT); \ GST_LOG_CONTEXT_BUILDER_SET_HASH_FLAGS(GST_LOG_CONTEXT_DEFAULT); \ __VA_ARGS__ \ name = gst_log_context_builder_build(builder); \ } \ G_GNUC_UNUSED static GstLogContext * _ensure_##name (void) { \ static gsize _init_##name##_guard = 0; \ if (g_once_init_enter (&_init_##name##_guard)) { \ _init_##name (); \ g_once_init_leave (&_init_##name##_guard, 1); \ } \ return name; \ } #define GST_LOG_CONTEXT_INIT(var, flags, ...) G_STMT_START { \ GstLogContextBuilder *builder = GST_LOG_CONTEXT_BUILDER_NEW(flags); \ GST_LOG_CONTEXT_BUILDER_SET_CATEGORY(GST_CAT_DEFAULT); \ GST_LOG_CONTEXT_BUILDER_SET_HASH_FLAGS(GST_LOG_CONTEXT_DEFAULT); \ __VA_ARGS__ \ var = gst_log_context_builder_build(builder); \ } G_STMT_END; /* Automatic context-based once debug macros */ /** * GST_CAT_LEVEL_LOG_ONCE: * @cat: category to use * @level: the severity of the message * @object: (allow-none): the #GObject the message belongs to or %NULL if none * @...: A printf-style message to output * * Outputs a debugging message with a specific category and level exactly once * per statement. * * This is the most general macro for this purpose. You will probably * want to use one of the simpler ones described below. * * There is no need to finish the end of the debug message with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ #define GST_CAT_LEVEL_LOG_ONCE(cat,level,object,...) G_STMT_START{ \ if (G_UNLIKELY (((level) <= GST_LEVEL_MAX) && ((level) <= _gst_debug_min))) { \ _gst_debug_log_once ((cat), (level), __FILE__, GST_FUNCTION, __LINE__, \ (GObject *) (object), __VA_ARGS__); \ } \ }G_STMT_END /* With specified category and object */ #define GST_CAT_ERROR_ONCE_OBJECT(cat,obj,...) GST_CAT_LEVEL_LOG_ONCE(cat,GST_LEVEL_ERROR, obj,__VA_ARGS__) #define GST_CAT_WARNING_ONCE_OBJECT(cat,obj,...) GST_CAT_LEVEL_LOG_ONCE(cat,GST_LEVEL_WARNING, obj,__VA_ARGS__) #define GST_CAT_INFO_ONCE_OBJECT(cat,obj,...) GST_CAT_LEVEL_LOG_ONCE(cat,GST_LEVEL_INFO, obj,__VA_ARGS__) #define GST_CAT_DEBUG_ONCE_OBJECT(cat,obj,...) GST_CAT_LEVEL_LOG_ONCE(cat,GST_LEVEL_DEBUG, obj,__VA_ARGS__) #define GST_CAT_LOG_ONCE_OBJECT(cat,obj,...) GST_CAT_LEVEL_LOG_ONCE(cat,GST_LEVEL_LOG, obj,__VA_ARGS__) #define GST_CAT_FIXME_ONCE_OBJECT(cat,obj,...) GST_CAT_LEVEL_LOG_ONCE(cat,GST_LEVEL_FIXME, obj,__VA_ARGS__) #define GST_CAT_TRACE_ONCE_OBJECT(cat,obj,...) GST_CAT_LEVEL_LOG_ONCE(cat,GST_LEVEL_TRACE, obj,__VA_ARGS__) /* With specified category and no object */ #define GST_CAT_ERROR_ONCE(cat,...) GST_CAT_LEVEL_LOG_ONCE(cat,GST_LEVEL_ERROR, NULL,__VA_ARGS__) #define GST_CAT_WARNING_ONCE(cat,...) GST_CAT_LEVEL_LOG_ONCE(cat,GST_LEVEL_WARNING, NULL,__VA_ARGS__) #define GST_CAT_INFO_ONCE(cat,...) GST_CAT_LEVEL_LOG_ONCE(cat,GST_LEVEL_INFO, NULL,__VA_ARGS__) #define GST_CAT_DEBUG_ONCE(cat,...) GST_CAT_LEVEL_LOG_ONCE(cat,GST_LEVEL_DEBUG, NULL,__VA_ARGS__) #define GST_CAT_LOG_ONCE(cat,...) GST_CAT_LEVEL_LOG_ONCE(cat,GST_LEVEL_LOG, NULL,__VA_ARGS__) #define GST_CAT_FIXME_ONCE(cat,...) GST_CAT_LEVEL_LOG_ONCE(cat,GST_LEVEL_FIXME, NULL,__VA_ARGS__) #define GST_CAT_TRACE_ONCE(cat,...) GST_CAT_LEVEL_LOG_ONCE(cat,GST_LEVEL_TRACE, NULL,__VA_ARGS__) /* With default category and specified object */ #define GST_ERROR_ONCE_OBJECT(object,...) GST_CAT_LEVEL_LOG_ONCE(GST_CAT_DEFAULT,GST_LEVEL_ERROR,object,__VA_ARGS__) #define GST_WARNING_ONCE_OBJECT(object,...) GST_CAT_LEVEL_LOG_ONCE(GST_CAT_DEFAULT,GST_LEVEL_WARNING,object,__VA_ARGS__) #define GST_INFO_ONCE_OBJECT(object,...) GST_CAT_LEVEL_LOG_ONCE(GST_CAT_DEFAULT,GST_LEVEL_INFO,object,__VA_ARGS__) #define GST_DEBUG_ONCE_OBJECT(object,...) GST_CAT_LEVEL_LOG_ONCE(GST_CAT_DEFAULT,GST_LEVEL_DEBUG,object,__VA_ARGS__) #define GST_LOG_ONCE_OBJECT(object,...) GST_CAT_LEVEL_LOG_ONCE(GST_CAT_DEFAULT,GST_LEVEL_LOG,object,__VA_ARGS__) #define GST_FIXME_ONCE_OBJECT(object,...) GST_CAT_LEVEL_LOG_ONCE(GST_CAT_DEFAULT,GST_LEVEL_FIXME,object,__VA_ARGS__) #define GST_TRACE_ONCE_OBJECT(object,...) GST_CAT_LEVEL_LOG_ONCE(GST_CAT_DEFAULT,GST_LEVEL_TRACE,object,__VA_ARGS__) /** * GST_CAT_LEVEL_LOG_ONCE_ID: * @cat: category to use * @level: the severity of the message * @id: (transfer none) (allow-none): the identifier of the object this message * relates to, or %NULL if none * @...: A printf-style message to output * * Outputs a debugging message with a specific category, level, and identifier * exactly once per statement. * * This is the most general macro for this purpose. You will probably want to * use one of the simpler ones described below. * * There is no need to finish the end of the debug message with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ #define GST_CAT_LEVEL_LOG_ONCE_ID(cat,level,id,...) G_STMT_START{ \ if (G_UNLIKELY (((level) <= GST_LEVEL_MAX) && ((level) <= _gst_debug_min))) { \ _gst_debug_log_once_id ((cat), (level), __FILE__, GST_FUNCTION, __LINE__, \ (id), __VA_ARGS__); \ } \ }G_STMT_END /* With ids */ #define GST_ERROR_ONCE_ID(id,...) GST_CTX_LEVEL_LOG_ONCE_ID(GST_CAT_DEFAULT,GST_LEVEL_ERROR,id,__VA_ARGS__) #define GST_WARNING_ONCE_ID(id,...) GST_CTX_LEVEL_LOG_ONCE_ID(GST_CAT_DEFAULT,GST_LEVEL_WARNING,id,__VA_ARGS__) #define GST_INFO_ONCE_ID(id,...) GST_CTX_LEVEL_LOG_ONCE_ID(GST_CAT_DEFAULT,GST_LEVEL_INFO,id,__VA_ARGS__) #define GST_DEBUG_ONCE_ID(id,...) GST_CTX_LEVEL_LOG_ONCE_ID(GST_CAT_DEFAULT,GST_LEVEL_DEBUG,id,__VA_ARGS__) #define GST_LOG_ONCE_ID(id,...) GST_CTX_LEVEL_LOG_ONCE_ID(GST_CAT_DEFAULT,GST_LEVEL_LOG,id,__VA_ARGS__) #define GST_FIXME_ONCE_ID(id,...) GST_CTX_LEVEL_LOG_ONCE_ID(GST_CAT_DEFAULT,GST_LEVEL_FIXME,id,__VA_ARGS__) #define GST_TRACE_ONCE_ID(id,...) GST_CTX_LEVEL_LOG_ONCE_ID(GST_CAT_DEFAULT,GST_LEVEL_TRACE,id,__VA_ARGS__) /* No object, no id */ #define GST_ERROR_ONCE(...) GST_ERROR_ONCE_OBJECT(NULL,__VA_ARGS__) #define GST_WARNING_ONCE(...) GST_WARNING_ONCE_OBJECT(NULL,__VA_ARGS__) #define GST_INFO_ONCE(...) GST_INFO_ONCE_OBJECT(NULL,__VA_ARGS__) #define GST_DEBUG_ONCE(...) GST_DEBUG_ONCE_OBJECT(NULL,__VA_ARGS__) #define GST_LOG_ONCE(...) GST_LOG_ONCE_OBJECT(NULL,__VA_ARGS__) #define GST_FIXME_ONCE(...) GST_FIXME_ONCE_OBJECT(NULL,__VA_ARGS__) #define GST_TRACE_ONCE(...) GST_TRACE_ONCE_OBJECT(NULL,__VA_ARGS__) /********** function pointer stuff **********/ /** * GST_DEBUG_REGISTER_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(). * * Use this variant of #GST_DEBUG_FUNCPTR if you do not need to use @ptr. */ #define GST_DEBUG_REGISTER_FUNCPTR(ptr) \ _gst_debug_register_funcptr((GstDebugFuncPtr)(ptr), #ptr) /** * 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(). * * Returns: the value passed to @ptr. */ #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 */ #ifndef GST_INFO_C #if defined(__GNUC__) && __GNUC__ >= 3 # pragma GCC poison gst_debug_log # pragma GCC poison gst_debug_log_valist # pragma GCC poison gst_debug_log_literal # pragma GCC poison gst_debug_log_id # pragma GCC poison gst_debug_log_id_valist # pragma GCC poison gst_debug_log_id_literal # pragma GCC poison _gst_debug_category_new #endif #define _gst_debug_min GST_LEVEL_NONE #define gst_debug_set_default_threshold(level) G_STMT_START{ }G_STMT_END #define gst_debug_get_default_threshold() (GST_LEVEL_NONE) #define gst_debug_level_get_name(level) ("NONE") #define gst_debug_message_get(message) ("") #define gst_debug_message_get_id(message) (NULL) #define gst_debug_add_log_function(func,data,notify) G_STMT_START{ }G_STMT_END #define gst_debug_set_active(active) G_STMT_START{ }G_STMT_END #define gst_debug_is_active() (FALSE) #define gst_debug_set_colored(colored) G_STMT_START{ }G_STMT_END #define gst_debug_set_color_mode(mode) G_STMT_START{ }G_STMT_END #define gst_debug_set_color_mode_from_string(mode) G_STMT_START{ }G_STMT_END #define gst_debug_is_colored() (FALSE) #define gst_debug_get_color_mode() (GST_DEBUG_COLOR_MODE_OFF) #define gst_debug_set_default_threshold(level) G_STMT_START{ }G_STMT_END #define gst_debug_get_default_threshold() (GST_LEVEL_NONE) #define gst_debug_set_threshold_for_name(name,level) G_STMT_START{ }G_STMT_END #define gst_debug_unset_threshold_for_name(name) G_STMT_START{ }G_STMT_END /* we are using dummy function prototypes here to eat ';' as these macros are * used outside of functions */ #define GST_DEBUG_CATEGORY(var) void _gst_debug_dummy_##var (void) #define GST_DEBUG_CATEGORY_EXTERN(var) void _gst_debug_dummy_extern_##var (void) #define GST_DEBUG_CATEGORY_STATIC(var) void _gst_debug_dummy_static_##var (void) #define GST_DEBUG_CATEGORY_INIT(var,name,color,desc) G_STMT_START{ }G_STMT_END #define GST_DEBUG_CATEGORY_GET(var,name) G_STMT_START{ }G_STMT_END #ifndef GST_DISABLE_DEPRECATED #define gst_debug_category_free(category) G_STMT_START{ }G_STMT_END #endif #define gst_debug_category_set_threshold(category,level) G_STMT_START{ }G_STMT_END #define gst_debug_category_reset_threshold(category) G_STMT_START{ }G_STMT_END #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")) #define gst_debug_construct_win_color(colorinfo) (0) #endif /* !GST_INFO_C */ #define GST_CAT_LEVEL_LOG(cat,level,...) G_STMT_START{ }G_STMT_END #define GST_CAT_ERROR_OBJECT(...) G_STMT_START{ }G_STMT_END #define GST_CAT_WARNING_OBJECT(...) G_STMT_START{ }G_STMT_END #define GST_CAT_INFO_OBJECT(...) G_STMT_START{ }G_STMT_END #define GST_CAT_DEBUG_OBJECT(...) G_STMT_START{ }G_STMT_END #define GST_CAT_LOG_OBJECT(...) G_STMT_START{ }G_STMT_END #define GST_CAT_FIXME_OBJECT(...) G_STMT_START{ }G_STMT_END #define GST_CAT_TRACE_OBJECT(...) G_STMT_START{ }G_STMT_END #define GST_CAT_ERROR(...) G_STMT_START{ }G_STMT_END #define GST_CAT_WARNING(...) G_STMT_START{ }G_STMT_END #define GST_CAT_INFO(...) G_STMT_START{ }G_STMT_END #define GST_CAT_DEBUG(...) G_STMT_START{ }G_STMT_END #define GST_CAT_LOG(...) G_STMT_START{ }G_STMT_END #define GST_CAT_FIXME(...) G_STMT_START{ }G_STMT_END #define GST_CAT_TRACE(...) G_STMT_START{ }G_STMT_END #define GST_ERROR_OBJECT(...) G_STMT_START{ }G_STMT_END #define GST_WARNING_OBJECT(...) G_STMT_START{ }G_STMT_END #define GST_INFO_OBJECT(...) G_STMT_START{ }G_STMT_END #define GST_DEBUG_OBJECT(...) G_STMT_START{ }G_STMT_END #define GST_LOG_OBJECT(...) G_STMT_START{ }G_STMT_END #define GST_FIXME_OBJECT(...) G_STMT_START{ }G_STMT_END #define GST_TRACE_OBJECT(...) G_STMT_START{ }G_STMT_END #define GST_ERROR_ID(...) G_STMT_START{ }G_STMT_END #define GST_WARNING_ID(...) G_STMT_START{ }G_STMT_END #define GST_INFO_ID(...) G_STMT_START{ }G_STMT_END #define GST_DEBUG_ID(...) G_STMT_START{ }G_STMT_END #define GST_LOG_ID(...) G_STMT_START{ }G_STMT_END #define GST_FIXME_ID(...) G_STMT_START{ }G_STMT_END #define GST_TRACE_ID(...) G_STMT_START{ }G_STMT_END #define GST_ERROR(...) G_STMT_START{ }G_STMT_END #define GST_WARNING(...) G_STMT_START{ }G_STMT_END #define GST_INFO(...) G_STMT_START{ }G_STMT_END #define GST_DEBUG(...) G_STMT_START{ }G_STMT_END #define GST_LOG(...) G_STMT_START{ }G_STMT_END #define GST_FIXME(...) G_STMT_START{ }G_STMT_END #define GST_TRACE(...) G_STMT_START{ }G_STMT_END /* we are using dummy function prototypes here to eat ';' as these macros are used outside of functions */ #define GST_LOG_CONTEXT_STATIC_DEFINE(name, flags, ...) void _gst_log_context_dummy_static_##name (void) #define GST_LOG_CONTEXT_INIT(var, flags, ...) #define GST_DEBUG_REGISTER_FUNCPTR(ptr) G_STMT_START{ }G_STMT_END #define GST_DEBUG_FUNCPTR(ptr) (ptr) #define GST_DEBUG_FUNCPTR_NAME(ptr) (g_strdup_printf ("%p", (ptr))) #define GST_CAT_MEMDUMP_OBJECT(cat,obj,msg,data,length) G_STMT_START{ }G_STMT_END #define GST_CAT_MEMDUMP_ID(cat,id,msg,data,length) G_STMT_START{ }G_STMT_END #define GST_CAT_MEMDUMP(cat,msg,data,length) G_STMT_START{ }G_STMT_END #define GST_MEMDUMP_OBJECT(obj,msg,data,length) G_STMT_START{ }G_STMT_END #define GST_MEMDUMP_ID(id,msg,data,length) G_STMT_START{ }G_STMT_END #define GST_MEMDUMP(msg,data,length) G_STMT_START{ }G_STMT_END /* Stubs for context-based debug macros when debugging is disabled */ #define GST_CTX_LEVEL_LOG(ctx,level,object,...) G_STMT_START{ }G_STMT_END /* With objects */ #define GST_CTX_ERROR_OBJECT(ctx,object,...) G_STMT_START{ }G_STMT_END #define GST_CTX_WARNING_OBJECT(ctx,object,...) G_STMT_START{ }G_STMT_END #define GST_CTX_INFO_OBJECT(ctx,object,...) G_STMT_START{ }G_STMT_END #define GST_CTX_DEBUG_OBJECT(ctx,object,...) G_STMT_START{ }G_STMT_END #define GST_CTX_LOG_OBJECT(ctx,object,...) G_STMT_START{ }G_STMT_END #define GST_CTX_FIXME_OBJECT(ctx,object,...) G_STMT_START{ }G_STMT_END #define GST_CTX_TRACE_OBJECT(ctx,object,...) G_STMT_START{ }G_STMT_END /* With IDs */ #define GST_CTX_ERROR_ID(ctx,id,...) G_STMT_START{ }G_STMT_END #define GST_CTX_WARNING_ID(ctx,id,...) G_STMT_START{ }G_STMT_END #define GST_CTX_INFO_ID(ctx,id,...) G_STMT_START{ }G_STMT_END #define GST_CTX_DEBUG_ID(ctx,id,...) G_STMT_START{ }G_STMT_END #define GST_CTX_LOG_ID(ctx,id,...) G_STMT_START{ }G_STMT_END #define GST_CTX_FIXME_ID(ctx,id,...) G_STMT_START{ }G_STMT_END #define GST_CTX_TRACE_ID(ctx,id,...) G_STMT_START{ }G_STMT_END /* Without objects */ #define GST_CTX_ERROR(ctx,...) G_STMT_START{ }G_STMT_END #define GST_CTX_WARNING(ctx,...) G_STMT_START{ }G_STMT_END #define GST_CTX_INFO(ctx,...) G_STMT_START{ }G_STMT_END #define GST_CTX_DEBUG(ctx,...) G_STMT_START{ }G_STMT_END #define GST_CTX_LOG(ctx,...) G_STMT_START{ }G_STMT_END #define GST_CTX_FIXME(ctx,...) G_STMT_START{ }G_STMT_END #define GST_CTX_TRACE(ctx,...) G_STMT_START{ }G_STMT_END /* Log context macros are no-ops when debugging is disabled */ #define GST_CAT_LEVEL_LOG_ONCE(cat,level,...) G_STMT_START{ }G_STMT_END #define GST_CAT_LEVEL_LOG_ONCE_ID(cat,level,...) G_STMT_START{ }G_STMT_END #define GST_CAT_ERROR_ONCE_OBJECT(...) G_STMT_START{ }G_STMT_END #define GST_CAT_WARNING_ONCE_OBJECT(...) G_STMT_START{ }G_STMT_END #define GST_CAT_INFO_ONCE_OBJECT(...) G_STMT_START{ }G_STMT_END #define GST_CAT_DEBUG_ONCE_OBJECT(...) G_STMT_START{ }G_STMT_END #define GST_CAT_LOG_ONCE_OBJECT(...) G_STMT_START{ }G_STMT_END #define GST_CAT_FIXME_ONCE_OBJECT(...) G_STMT_START{ }G_STMT_END #define GST_CAT_TRACE_ONCE_OBJECT(...) G_STMT_START{ }G_STMT_END #define GST_CAT_ERROR_ONCE(...) G_STMT_START{ }G_STMT_END #define GST_CAT_WARNING_ONCE(...) G_STMT_START{ }G_STMT_END #define GST_CAT_INFO_ONCE(...) G_STMT_START{ }G_STMT_END #define GST_CAT_DEBUG_ONCE(...) G_STMT_START{ }G_STMT_END #define GST_CAT_LOG_ONCE(...) G_STMT_START{ }G_STMT_END #define GST_CAT_FIXME_ONCE(...) G_STMT_START{ }G_STMT_END #define GST_CAT_TRACE_ONCE(...) G_STMT_START{ }G_STMT_END #define GST_ERROR_ONCE_OBJECT(...) G_STMT_START{ }G_STMT_END #define GST_WARNING_ONCE_OBJECT(...) G_STMT_START{ }G_STMT_END #define GST_INFO_ONCE_OBJECT(...) G_STMT_START{ }G_STMT_END #define GST_DEBUG_ONCE_OBJECT(...) G_STMT_START{ }G_STMT_END #define GST_LOG_ONCE_OBJECT(...) G_STMT_START{ }G_STMT_END #define GST_FIXME_ONCE_OBJECT(...) G_STMT_START{ }G_STMT_END #define GST_TRACE_ONCE_OBJECT(...) G_STMT_START{ }G_STMT_END #define GST_ERROR_ONCE_ID(...) G_STMT_START{ }G_STMT_END #define GST_WARNING_ONCE_ID(...) G_STMT_START{ }G_STMT_END #define GST_INFO_ONCE_ID(...) G_STMT_START{ }G_STMT_END #define GST_DEBUG_ONCE_ID(...) G_STMT_START{ }G_STMT_END #define GST_LOG_ONCE_ID(...) G_STMT_START{ }G_STMT_END #define GST_FIXME_ONCE_ID(...) G_STMT_START{ }G_STMT_END #define GST_TRACE_ONCE_ID(...) G_STMT_START{ }G_STMT_END #define GST_ERROR_ONCE(...) G_STMT_START{ }G_STMT_END #define GST_WARNING_ONCE(...) G_STMT_START{ }G_STMT_END #define GST_INFO_ONCE(...) G_STMT_START{ }G_STMT_END #define GST_DEBUG_ONCE(...) G_STMT_START{ }G_STMT_END #define GST_LOG_ONCE(...) G_STMT_START{ }G_STMT_END #define GST_FIXME_ONCE(...) G_STMT_START{ }G_STMT_END #define GST_TRACE_ONCE(...) G_STMT_START{ }G_STMT_END #endif /* GST_DISABLE_GST_DEBUG */ GST_API void gst_debug_print_stack_trace (void); GST_API gchar * gst_debug_get_stack_trace (GstStackTraceFlags flags); GST_API void gst_debug_add_ring_buffer_logger (guint max_size_per_thread, guint thread_timeout); GST_API void gst_debug_remove_ring_buffer_logger (void); GST_API gchar ** gst_debug_ring_buffer_logger_get_logs (void); /** * GstLogContextHashFlags: * @GST_LOG_CONTEXT_DEFAULT: Default behavior for logging context * (uses object, format, file but not line number or string args) * @GST_LOG_CONTEXT_IGNORE_OBJECT: Ignore object pointer or object ID when calculating message hash * @GST_LOG_CONTEXT_IGNORE_FORMAT: Ignore the "format" part of the debug * log message * @GST_LOG_CONTEXT_IGNORE_FILE: Ignore file name when calculating message hash * @GST_LOG_CONTEXT_USE_LINE_NUMBER: Use line number when calculating message hash (not used by default) * @GST_LOG_CONTEXT_USE_STRING_ARGS: Use the arguments part of the string message (not used by default) * * Flags to control how the message hash is calculated in a #GstLogContext. * The message hash is used to determine if a message is a duplicate of a previously * logged message. * * Since: 1.28 */ typedef enum { GST_LOG_CONTEXT_DEFAULT = 0, GST_LOG_CONTEXT_IGNORE_OBJECT = (1 << 0), GST_LOG_CONTEXT_IGNORE_FORMAT = (1 << 1), GST_LOG_CONTEXT_IGNORE_FILE = (1 << 2), GST_LOG_CONTEXT_USE_LINE_NUMBER = (1 << 3), GST_LOG_CONTEXT_USE_STRING_ARGS = (1 << 4), } GstLogContextHashFlags; /** * GstLogContextFlags: * @GST_LOG_CONTEXT_FLAG_NONE: No special behavior (empty flags) * @GST_LOG_CONTEXT_FLAG_THROTTLE: Enable message throttling/deduplication. This * makes the context track which messages have been logged already based on * their message hash, and only log them once (or periodically if an * interval is set). Without this flag, all messages will be logged regardless * of whether they've been logged before. * * Flags to control the behavior of a #GstLogContext. * * Since: 1.28 */ typedef enum { GST_LOG_CONTEXT_FLAG_NONE = 0, GST_LOG_CONTEXT_FLAG_THROTTLE = (1 << 0), } GstLogContextFlags; /** * GstLogContext: * * A context for controlling logging behavior, for example to handle * logging once or periodic logging, avoiding to * spam the terminal with the same log message multiple times. * * ## Simple log context using static macros * * ``` c * // At global/file scope: * GST_LOG_CONTEXT_STATIC_DEFINE(my_context, GST_LOG_CONTEXT_FLAG_THROTTLE, ); * #define MY_CONTEXT GST_LOG_CONTEXT_LAZY_INIT(my_context) * * // Then in code: * GST_CTX_INFO(MY_CONTEXT, "This will only appear once per file/line"); * ``` * * ## Periodic logging * * For messages that should be logged periodically (e.g., maximum once per minute): * * ``` c * // At global/file scope: * GST_LOG_CONTEXT_STATIC_DEFINE(my_periodic_context, GST_LOG_CONTEXT_FLAG_THROTTLE, * GST_LOG_CONTEXT_BUILDER_SET_INTERVAL(60 * GST_SECOND); * ); * #define MY_PERIODIC_CONTEXT GST_LOG_CONTEXT_LAZY_INIT(my_periodic_context) * * // Then in code: * GST_CTX_INFO(MY_PERIODIC_CONTEXT, "This appears once per minute"); * ``` * * ## Customizing Message hash with custom flags and category * * By default, a message's hash is determined by the file name, object pointer, * and format string. You can customize this with builder operations: * * ``` c * // Ignore the object pointer when determining message hash (with throttling) * GST_LOG_CONTEXT_STATIC_DEFINE(obj_independent_ctx, GST_LOG_CONTEXT_FLAG_THROTTLE, * GST_LOG_CONTEXT_BUILDER_SET_HASH_FLAGS(GST_LOG_CONTEXT_IGNORE_OBJECT); * ); * * // Use a custom category (without throttling) * GST_LOG_CONTEXT_STATIC_DEFINE(custom_cat_ctx, GST_LOG_CONTEXT_FLAG_NONE, * GST_LOG_CONTEXT_BUILDER_SET_CATEGORY(my_category); * ); * ``` * * Since: 1.28 */ typedef struct _GstLogContext GstLogContext; /** * GstLogContextBuilder: * * A builder for creating a #GstLogContext. This provides a flexible way to * configure a log context with various options while maintaining immutability * of the resulting context. * * Since: 1.28 */ typedef struct _GstLogContextBuilder GstLogContextBuilder; GST_API GstDebugCategory *gst_log_context_get_category (GstLogContext *context); GST_API void gst_log_context_reset (GstLogContext *ctx); GST_API void gst_log_context_free (GstLogContext *ctx); GST_API void gst_debug_log_with_context (GstLogContext *ctx, GstDebugLevel level, const gchar *file, const gchar *function, gint line, GObject *object, const gchar *format, ...) G_GNUC_PRINTF(7, 8); GST_API void gst_debug_log_with_context_valist (GstLogContext *ctx, GstDebugLevel level, const gchar *file, const gchar *function, gint line, GObject *object, const gchar *format, va_list args) G_GNUC_PRINTF (7, 0) G_GNUC_NO_INSTRUMENT; GST_API void gst_debug_log_literal_with_context (GstLogContext *ctx, GstDebugLevel level, const gchar *file, const gchar *function, gint line, GObject *object, const gchar *message); GST_API void gst_debug_log_id_with_context (GstLogContext *ctx, GstDebugLevel level, const gchar *file, const gchar *function, gint line, const gchar *id, const gchar *format, ...) G_GNUC_PRINTF(7, 8); GST_API void gst_debug_log_id_with_context_valist (GstLogContext *ctx, GstDebugLevel level, const gchar *file, const gchar *function, gint line, const gchar *id, const gchar *format, va_list args) G_GNUC_PRINTF(7, 0); GST_API void gst_debug_log_id_literal_with_context (GstLogContext *ctx, GstDebugLevel level, const gchar *file, const gchar *function, gint line, const gchar *id, const gchar *message); GST_API void _gst_debug_log_once (GstDebugCategory * category, GstDebugLevel level, const gchar * file, const gchar * function, gint line, GObject * object, const gchar * format, ...) G_GNUC_PRINTF(7, 8); GST_API void _gst_debug_log_once_id (GstDebugCategory * category, GstDebugLevel level, const gchar * file, const gchar * function, gint line, const gchar * id, const gchar * format, ...) G_GNUC_PRINTF(7, 8); /* Builder pattern API */ GST_API GstLogContextBuilder* gst_log_context_builder_new (GstDebugCategory *category, GstLogContextFlags flags) G_GNUC_WARN_UNUSED_RESULT; GST_API GstLogContextBuilder* gst_log_context_builder_set_hash_flags (GstLogContextBuilder* builder, GstLogContextHashFlags flags) G_GNUC_WARN_UNUSED_RESULT; GST_API GstLogContextBuilder* gst_log_context_builder_set_category (GstLogContextBuilder* builder, GstDebugCategory* category) G_GNUC_WARN_UNUSED_RESULT; GST_API GstLogContextBuilder* gst_log_context_builder_set_interval (GstLogContextBuilder* builder, GstClockTime interval) G_GNUC_WARN_UNUSED_RESULT; GST_API GstLogContext* gst_log_context_builder_build (GstLogContextBuilder* builder) G_GNUC_WARN_UNUSED_RESULT; /** * GST_LOG_CONTEXT_BUILDER_NEW: * * Creates a new log context builder with default settings. * * Returns: a new #GstLogContextBuilder * * Since: 1.28 */ #define GST_LOG_CONTEXT_BUILDER_NEW(flags) \ gst_log_context_builder_new(GST_CAT_DEFAULT, flags) /** * GST_LOG_CONTEXT_BUILDER_SET_HASH_FLAGS: * @flags: #GstLogContextHashFlags to control message hash calculation * * Sets the hash flags for the log context being built, which control how * the message hash is calculated. * * Returns: the same #GstLogContextBuilder for chaining * * Since: 1.28 */ #define GST_LOG_CONTEXT_BUILDER_SET_HASH_FLAGS(flags) \ builder = gst_log_context_builder_set_hash_flags(builder, (flags)) /** * GST_LOG_CONTEXT_BUILDER_SET_CATEGORY: * @category: a #GstDebugCategory to associate with the context * * Sets the debug category for the log context being built. * * Returns: the same #GstLogContextBuilder for chaining * * Since: 1.28 */ #define GST_LOG_CONTEXT_BUILDER_SET_CATEGORY(category) \ builder = gst_log_context_builder_set_category(builder, (category)) /** * GST_LOG_CONTEXT_BUILDER_SET_INTERVAL: * @interval: interval in nanoseconds for automatic reset (e.g., 1 * GST_SECOND) * * Sets the automatic reset interval for the log context being built. * After this interval has elapsed, the context will allow previously logged * messages to be logged again. This is useful for allowing periodic log * messages. * * Example: * * ``` c * // Create a context that allows messages to repeat every minute * GST_LOG_CONTEXT_STATIC_DEFINE(minute_ctx, * GST_LOG_CONTEXT_BUILDER_SET_INTERVAL(60 * GST_SECOND); * ); * ``` * * Returns: the same #GstLogContextBuilder for chaining * * Since: 1.28 */ #define GST_LOG_CONTEXT_BUILDER_SET_INTERVAL(interval) \ builder = gst_log_context_builder_set_interval(builder, (interval)) /** * GST_LOG_CONTEXT_STATIC_DEFINE: * @name: variable name for the context * @_init_code: optional initialization code to customize the context * * Creates a static logging context that will be automatically initialized on * first use and cleaned up during GStreamer deinitialization. It requires the * behavior flags as a parameter to explicitly control whether throttling is enabled. * By default, it uses GST_CAT_DEFAULT and GST_LOG_CONTEXT_DEFAULT hash flags, * but can be further customized with optional initialization code. * * Example usage: * ``` * // Simple case with throttling enabled (logs messages only once) * GST_LOG_CONTEXT_STATIC_DEFINE(simple_ctx, GST_LOG_CONTEXT_FLAG_THROTTLE, ); * * // With interval for periodic logging (allow message to repeat after 60 seconds) * GST_LOG_CONTEXT_STATIC_DEFINE(periodic_ctx, * GST_LOG_CONTEXT_BUILDER_SET_INTERVAL(60 * GST_SECOND); * ); * * // With custom category and flags (ignore object pointers when calculating message hash) * GST_LOG_CONTEXT_STATIC_DEFINE(custom_ctx, * GST_LOG_CONTEXT_BUILDER_SET_CATEGORY(my_category); * GST_LOG_CONTEXT_BUILDER_SET_FLAGS(GST_LOG_CONTEXT_IGNORE_OBJECT); * ); * ``` * * Use with GST_LOG_CONTEXT_LAZY_INIT() to get a reference to the context: * ``` * #define MY_CONTEXT GST_LOG_CONTEXT_LAZY_INIT(simple_ctx) * * // Then in code: * GST_CTX_INFO(MY_CONTEXT, "This will only appear once"); * GST_CTX_INFO(MY_CONTEXT, "This will only appear once"); // Not logged again * ``` * * When using this macro, gst_init() must be called in the application. * * Since: 1.28 */ /** * GST_LOG_CONTEXT_LAZY_INIT: * @name: variable name for the context * * This macro is used to ensure a static logging context is initialized on * first use. It should be used with a context defined using * GST_LOG_CONTEXT_STATIC_DEFINE(). * * Returns: the initialized #GstLogContext * * Since: 1.28 */ #define GST_LOG_CONTEXT_LAZY_INIT(name) _ensure_##name() /** * GST_LOG_CONTEXT_INIT: * @var: name for the context variable to initialize * @flags: #GstLogContextFlags to control throttling behavior * @_init_code: optional initialization code to customize the context * * Initializes a new log context for immediate use within a function. It requires * flags to explicitly control whether throttling is enabled. * By default, the context uses GST_CAT_DEFAULT and GST_LOG_CONTEXT_DEFAULT hash flags, * but can be further customized with optional initialization code. * * Typical usage: * * ``` c * // Simple case with throttling * GstLogContext *ctx = NULL, *periodic_ctx = NULL; * * GST_LOG_CONTEXT_INIT(ctx, GST_LOG_CONTEXT_FLAG_THROTTLE); * * // With interval for periodic reset and throttling * GST_LOG_CONTEXT_INIT(periodic_ctx, GST_LOG_CONTEXT_FLAG_THROTTLE, * GST_LOG_CONTEXT_BUILDER_SET_INTERVAL(60 * GST_SECOND); * ); * ``` * * The returned context should be freed with gst_log_context_free() when no longer needed. * * Since: 1.28 */ /** * GST_CTX_LEVEL_LOG: * @ctx: #GstLogContext to use * @level: level of the message * @object: (nullable): an object or %NULL * @...: format string and optional arguments * * Outputs a debugging message in the specified context with the specified * level. This is the most general macro for this purpose. You will probably * want to use one of the simpler ones described below. * * There is no need to finish the end of the debug message with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CTX_LEVEL_LOG_ID: * @ctx: #GstLogContext to use * @level: level of the message * @id: (nullable): an object or %NULL * @...: format string and optional arguments * * Outputs a debugging message with an identifier in the specified context * with the specified level. This is the most general macro for this purpose. * You will probably want to use one of the simpler ones described below. * * Since: 1.28 */ /** * GST_CTX_ERROR_OBJECT: * @ctx: #GstLogContext to use * @object: (nullable): a #GObject or %NULL * @...: format string and optional arguments * * Output an error message belonging to the given object in the specified * context. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CTX_WARNING_OBJECT: * @ctx: #GstLogContext to use * @object: (nullable): a #GObject or %NULL * @...: format string and optional arguments * * Output a warning message belonging to the given object in the specified context. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CTX_DEBUG_OBJECT: * @ctx: #GstLogContext to use * @object: (nullable): a #GObject or %NULL * @...: format string and optional arguments * * Output a debugging message belonging to the given object in the specified * context. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CTX_INFO_OBJECT: * @ctx: #GstLogContext to use * @object: (nullable): a #GObject or %NULL * @...: format string and optional arguments * * Output an informational message belonging to the given object in the * specified context. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CTX_LOG_OBJECT: * @ctx: #GstLogContext to use * @object: (nullable): a #GObject or %NULL * @...: format string and optional arguments * * Output a logging message belonging to the given object in the specified * context. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CTX_FIXME_OBJECT: * @ctx: #GstLogContext to use * @object: (nullable): a #GObject or %NULL * @...: format string and optional arguments * * Output a fixme message belonging to the given object in the specified * context. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CTX_TRACE_OBJECT: * @ctx: #GstLogContext to use * @object: (nullable): a #GObject or %NULL * @...: format string and optional arguments * * Output a tracing message belonging to the given object in the specified * context. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /* Similar macros for non-object logging */ /** * GST_CTX_ERROR: * @ctx: #GstLogContext to use * @...: format string and optional arguments * * Output an error message in the specified context. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CTX_WARNING: * @ctx: #GstLogContext to use * @...: format string and optional arguments * * Output a warning message in the specified context. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CTX_INFO: * @ctx: #GstLogContext to use * @...: format string and optional arguments * * Output an info message in the specified context. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CTX_DEBUG: * @ctx: #GstLogContext to use for determining if message should be logged * @...: format string and optional arguments * * Output a debug message in the specified context. * If this exact message was already logged from the same location with this * context, it will not be logged again unless the context has been reset. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Example: * ``` c * // Define a static context * GST_LOG_CONTEXT_STATIC_DEFINE(debug_ctx, ); * #define DEBUG_CTX GST_LOG_CONTEXT_LAZY_INIT(debug_ctx) * * // Use in code - this message will only be logged once * for (i = 0; i < 1000; i++) { * GST_CTX_DEBUG(DEBUG_CTX, "Processing iteration %d", i); * } * ``` * * Since: 1.28 */ /** * GST_CTX_LOG: * @ctx: #GstLogContext to use * @...: format string and optional arguments * * Output a log message in the specified context. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CTX_FIXME: * @ctx: #GstLogContext to use * @...: format string and optional arguments * * Output a fixme message in the specified context. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CTX_TRACE: * @ctx: #GstLogContext to use * @...: format string and optional arguments * * Output a trace message in the specified context. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /* Similar macros for object ID logging */ /** * GST_CTX_ERROR_ID: * @ctx: #GstLogContext to use * @...: format string and optional arguments * @id: (nullable): an object ID or %NULL * * Output an error message for the given identifier in the specified context. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CTX_WARNING_ID: * @ctx: #GstLogContext to use * @...: format string and optional arguments * @id: (nullable): an object ID or %NULL * * Output a warning message for the given identifier in the specified context. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CTX_INFO_ID: * @ctx: #GstLogContext to use * @...: format string and optional arguments * @id: (nullable): an object ID or %NULL * * Output an info message for the given identifier in the specified context. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CTX_DEBUG_ID: * @ctx: #GstLogContext to use * @...: format string and optional arguments * @id: (nullable): an object ID or %NULL * * Output a debug message for the given identifier in the specified context. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CTX_LOG_ID: * @ctx: #GstLogContext to use * @...: format string and optional arguments * @id: (nullable): an object ID or %NULL * * Output a log message for the given identifier in the specified context. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CTX_FIXME_ID: * @ctx: #GstLogContext to use * @...: format string and optional arguments * @id: (nullable): an object ID or %NULL * * Output a fixme message for the given identifier in the specified context. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CTX_TRACE_ID: * @ctx: #GstLogContext to use * @...: format string and optional arguments * @id: (nullable): an object ID or %NULL * * Output a trace message for the given identifier in the specified context. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /* `ONCE` convenience macros around GstLogContext */ /** * GST_CAT_ERROR_ONCE_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 * exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CAT_WARNING_ONCE_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 exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CAT_INFO_ONCE_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 exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CAT_DEBUG_ONCE_OBJECT: * @cat: category to use * @obj: the #GObject the message belongs to * @...: printf-style message to output * * Output a debugging message belonging to the given object in the given * category exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CAT_LOG_ONCE_OBJECT: * @cat: category to use * @obj: the #GObject the message belongs to * @...: printf-style message to output * * Output a logging message belonging to the given object in the given * category exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CAT_FIXME_ONCE_OBJECT: * @cat: category to use * @obj: the #GObject the message belongs to * @...: printf-style message to output * * Output a fixme message belonging to the given object in the given category * exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CAT_TRACE_ONCE_OBJECT: * @cat: category to use * @obj: the #GObject the message belongs to * @...: printf-style message to output * * Output a tracing message belonging to the given object in the given * category exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CAT_ERROR_ONCE: * @cat: category to use * @...: printf-style message to output * * Output an error message in the given category exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CAT_WARNING_ONCE: * @cat: category to use * @...: printf-style message to output * * Output a warning message in the given category exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CAT_INFO_ONCE: * @cat: category to use * @...: printf-style message to output * * Output an informational message in the given category exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CAT_DEBUG_ONCE: * @cat: category to use * @...: printf-style message to output * * Output a debugging message in the given category exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CAT_LOG_ONCE: * @cat: category to use * @...: printf-style message to output * * Output a logging message in the given category exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CAT_FIXME_ONCE: * @cat: category to use * @...: printf-style message to output * * Output a fixme message in the given category exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_CAT_TRACE_ONCE: * @cat: category to use * @...: printf-style message to output * * Output a tracing message in the given category exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_ERROR_ONCE_OBJECT: * @object: (nullable): a #GObject or %NULL * @...: format string and optional arguments * * Output an error message belonging to the given object in the default * category exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_WARNING_ONCE_OBJECT: * @object: (nullable): a #GObject or %NULL * @...: format string and optional arguments * * Output a warning message belonging to the given object in the default * category exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_INFO_ONCE_OBJECT: * @object: (nullable): a #GObject or %NULL * @...: format string and optional arguments * * Logs an info message in the specified context. * * Since: 1.28 */ /** * GST_DEBUG_ONCE_OBJECT: * @object: (nullable): a #GObject or %NULL * @...: format string and optional arguments * * Output a debugging message belonging to the given object in the default * category exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_LOG_ONCE_OBJECT: * @object: (nullable): a #GObject or %NULL * @...: format string and optional arguments * * Logs a log message in the specified context. * * Since: 1.28 */ /** * GST_FIXME_ONCE_OBJECT: * @object: (nullable): a #GObject or %NULL * @...: format string and optional arguments * * Output a fixme message belonging to the given object in the default * category exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_TRACE_ONCE_OBJECT: * @object: (nullable): a #GObject or %NULL * @...: format string and optional arguments * * Output a tracing message belonging to the given object in the default * category exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /* Similar macros for non-object logging */ /** * GST_ERROR_ONCE: * @...: format string and optional arguments * * Output an error message in the default category exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_WARNING_ONCE: * @...: format string and optional arguments * * Output a warning message in the default category exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_INFO_ONCE: * @...: format string and optional arguments * * Output an informational message in the default category exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_DEBUG_ONCE: * @...: format string and optional arguments * * Output a debugging message in the default category exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Example: * ``` c * // Use in code - this message will only be logged once * for (i = 0; i < 1000; i++) { * GST_DEBUG_ONCE ("Processing iteration %d", i); * } * ``` * * Since: 1.28 */ /** * GST_LOG_ONCE: * @...: format string and optional arguments * * Output a logging message in the default category exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_FIXME_ONCE: * @...: format string and optional arguments * * Output a fixme message in the default category exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_TRACE_ONCE: * @...: format string and optional arguments * * Output a tracing message in the default category exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /* Similar macros for object ID logging */ /** * GST_ERROR_ONCE_ID: * @id: (nullable): an object ID or %NULL * @...: format string and optional arguments * * Output an error message for the given identifier in the default category * exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_WARNING_ONCE_ID: * @id: (nullable): an object ID or %NULL * @...: format string and optional arguments * * Output a warning message for the given identifier in the default category * exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_INFO_ONCE_ID: * @id: (nullable): an object ID or %NULL * @...: format string and optional arguments * * Output an informational message for the given identifier the default * category exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_DEBUG_ONCE_ID: * @id: (nullable): an object ID or %NULL * @...: format string and optional arguments * * Output a debugging message for the given identifier in the default category * exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_LOG_ONCE_ID: * @id: (nullable): an object ID or %NULL * @...: format string and optional arguments * * Output a logging message for the given identifier in the default category * exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_FIXME_ONCE_ID: * @id: (nullable): an object ID or %NULL * @...: format string and optional arguments * * Output a fixme message for the given identifier in the default category * exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ /** * GST_TRACE_ONCE_ID: * @id: (nullable): an object ID or %NULL * @...: format string and optional arguments * * Output a tracing message for the given identifier in the default category * exactly once per statement. * * There is no need to finish the end of the message string with a newline * character, a newline character will be added automatically. * * Since: 1.28 */ G_END_DECLS #endif /* __GSTINFO_H__ */