GstInfo

GstDebugCategory

gst_debug_category_free

gst_debug_category_free (GstDebugCategory * category)

Removes and frees the category and all associated resources.

deprecated : This function can easily cause memory corruption, don't use it.

gst_debug_category_get_color

guint
gst_debug_category_get_color (GstDebugCategory * category)

Returns the color of a debug category used when printing output in this category.

gst_debug_category_get_description

const gchar *
gst_debug_category_get_description (GstDebugCategory * category)

Returns the description of a debug category.

gst_debug_category_get_name

const gchar *
gst_debug_category_get_name (GstDebugCategory * category)

Returns the name of a debug category.

gst_debug_category_get_threshold

GstDebugLevel
gst_debug_category_get_threshold (GstDebugCategory * category)

Returns the threshold of a GstDebugCategory.

gst_debug_category_reset_threshold

gst_debug_category_reset_threshold (GstDebugCategory * category)

Resets the threshold of the category to the default level. Debug information will only be output if the threshold is lower or equal to the level of the debugging message. Use this function to set the threshold back to where it was after using gst_debug_category_set_threshold.

gst_debug_category_set_threshold

gst_debug_category_set_threshold (GstDebugCategory * category,
                                  GstDebugLevel level)

Sets the threshold of the category to the given level. Debug information will only be output if the threshold is lower or equal to the level of the debugging message.

Do not use this function in production code, because other functions may change the threshold of categories as side effect. It is however a nice function to use when debugging (even from gdb).

GstDebugMessage

gst_debug_message_get

const gchar *
gst_debug_message_get (GstDebugMessage * message)

Gets the string representation of a GstDebugMessage. This function is used in debug handlers to extract the message.

gst_debug_message_get_id

const gchar *
gst_debug_message_get_id (GstDebugMessage * message)

Get the id of the object that emitted this message. This function is used in debug handlers. Can be empty.

Since : 1.22

gst_debug_add_log_function

gst_debug_add_log_function (GstLogFunction func,
                            gpointer user_data,
                            GDestroyNotify notify)

Adds the logging function to the list of logging functions. Be sure to use G_GNUC_NO_INSTRUMENT on that function, it is needed.

gst_debug_add_ring_buffer_logger

gst_debug_add_ring_buffer_logger (guint max_size_per_thread,
                                  guint thread_timeout)

Adds a memory ringbuffer based debug logger that stores up to max_size_per_thread bytes of logs per thread and times out threads after thread_timeout seconds of inactivity.

Logs can be fetched with gst_debug_ring_buffer_logger_get_logs and the logger can be removed again with gst_debug_remove_ring_buffer_logger. Only one logger at a time is possible.

Since : 1.14

gst_debug_construct_term_color

gchar *
gst_debug_construct_term_color (guint colorinfo)

Constructs a string that can be used for getting the desired color in color terminals. You need to free the string after use.

gst_debug_construct_win_color

gint
gst_debug_construct_win_color (guint colorinfo)

Constructs an integer that can be used for getting the desired color in windows' terminals (cmd.exe). As there is no mean to underline, we simply ignore this attribute.

This function returns 0 on non-windows machines.

gst_debug_get_all_categories

GSList *
gst_debug_get_all_categories ()

Returns a snapshot of a all categories that are currently in use . This list may change anytime. The caller has to free the list after use.

gst_debug_get_color_mode

GstDebugColorMode
gst_debug_get_color_mode ()

Changes the coloring mode for debug output.

Since : 1.2

gst_debug_get_default_threshold

GstDebugLevel
gst_debug_get_default_threshold ()

Returns the default threshold that is used for new categories.

gst_debug_get_stack_trace

gchar *
gst_debug_get_stack_trace (GstStackTraceFlags flags)

Since : 1.12

gst_debug_is_active

gboolean
gst_debug_is_active ()

Checks if debugging output is activated.

gst_debug_is_colored

gboolean
gst_debug_is_colored ()

Checks if the debugging output should be colored.

gst_debug_level_get_name

const gchar *
gst_debug_level_get_name (GstDebugLevel level)

Get the string representation of a debugging level

gst_debug_log

gst_debug_log (GstDebugCategory * category,
               GstDebugLevel level,
               const gchar * file,
               const gchar * function,
               gint line,
               GObject * object,
               const gchar * format,
               ... ...)

Logs the given message using the currently registered debugging handlers.

gst_debug_log_default

gst_debug_log_default (GstDebugCategory * category,
                       GstDebugLevel level,
                       const gchar * file,
                       const gchar * function,
                       gint line,
                       GObject * object,
                       GstDebugMessage * message,
                       gpointer user_data)

The default logging handler used by GStreamer. Logging functions get called whenever a macro like GST_DEBUG or similar is used. By default this function is setup to output the message and additional info to stderr (or the log file specified via the GST_DEBUG_FILE environment variable) as received via user_data.

You can add other handlers by using gst_debug_add_log_function. And you can remove this handler by calling gst_debug_remove_log_function(gst_debug_log_default);

gst_debug_log_get_line

gchar *
gst_debug_log_get_line (GstDebugCategory * category,
                        GstDebugLevel level,
                        const gchar * file,
                        const gchar * function,
                        gint line,
                        GObject * object,
                        GstDebugMessage * message)

Returns the string representation for the specified debug log message formatted in the same way as gst_debug_log_default (the default handler), without color. The purpose is to make it easy for custom log output handlers to get a log output that is identical to what the default handler would write out.

Since : 1.18

gst_debug_log_id

gst_debug_log_id (GstDebugCategory * category,
                  GstDebugLevel level,
                  const gchar * file,
                  const gchar * function,
                  gint line,
                  const gchar * id,
                  const gchar * format,
                  ... ...)

Logs the given message using the currently registered debugging handlers.

Since : 1.22

gst_debug_log_id_literal

gst_debug_log_id_literal (GstDebugCategory * category,
                          GstDebugLevel level,
                          const gchar * file,
                          const gchar * function,
                          gint line,
                          const gchar * id,
                          const gchar * message_string)

Logs the given message using the currently registered debugging handlers.

Since : 1.22

gst_debug_log_id_valist

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)

Logs the given message using the currently registered debugging handlers.

Since : 1.22

gst_debug_log_literal

gst_debug_log_literal (GstDebugCategory * category,
                       GstDebugLevel level,
                       const gchar * file,
                       const gchar * function,
                       gint line,
                       GObject * object,
                       const gchar * message_string)

Logs the given message using the currently registered debugging handlers.

Since : 1.20

gst_debug_log_valist

gst_debug_log_valist (GstDebugCategory * category,
                      GstDebugLevel level,
                      const gchar * file,
                      const gchar * function,
                      gint line,
                      GObject * object,
                      const gchar * format,
                      va_list args)

Logs the given message using the currently registered debugging handlers.

gst_debug_print_object

gchar *
gst_debug_print_object (gconstpointer ptr)

Returns a string that represents ptr. This is safe to call with GstStructure, GstCapsFeatures, GstMiniObject s (e.g. GstCaps, GstBuffer or GstMessage), and GObject (e.g. GstElement or GstPad).

The string representation is meant to be used for debugging purposes and might change between GStreamer versions.

Passing other kind of pointers might or might not work and is generally unsafe to do.

Since : 1.26

gst_debug_print_segment

gchar *
gst_debug_print_segment (const GstSegment * segment)

Returns a string that represents segments.

The string representation is meant to be used for debugging purposes and might change between GStreamer versions.

Since : 1.26

gst_debug_print_stack_trace

gst_debug_print_stack_trace ()

If libunwind, glibc backtrace or DbgHelp are present a stack trace is printed.

gst_debug_remove_log_function

guint
gst_debug_remove_log_function (GstLogFunction func)

Removes all registered instances of the given logging functions.

gst_debug_remove_log_function_by_data

guint
gst_debug_remove_log_function_by_data (gpointer data)

Removes all registered instances of log functions with the given user data.

gst_debug_remove_ring_buffer_logger

gst_debug_remove_ring_buffer_logger ()

Removes any previously added ring buffer logger with gst_debug_add_ring_buffer_logger.

Since : 1.14

gst_debug_ring_buffer_logger_get_logs

gchar **
gst_debug_ring_buffer_logger_get_logs ()

Fetches the current logs per thread from the ring buffer logger. See gst_debug_add_ring_buffer_logger for details.

Since : 1.14

gst_debug_set_active

gst_debug_set_active (gboolean active)

If activated, debugging messages are sent to the debugging handlers. It makes sense to deactivate it for speed issues.

This function is not threadsafe. It makes sense to only call it during initialization.

gst_debug_set_color_mode

gst_debug_set_color_mode (GstDebugColorMode mode)

Changes the coloring mode for debug output.

This function may be called before gst_init.

Since : 1.2

gst_debug_set_color_mode_from_string

gst_debug_set_color_mode_from_string (const gchar * mode)

Changes the coloring mode for debug output.

This function may be called before gst_init.

Since : 1.2

gst_debug_set_colored

gst_debug_set_colored (gboolean colored)

Sets or unsets the use of coloured debugging output. Same as gst_debug_set_color_mode () with the argument being being GST_DEBUG_COLOR_MODE_ON or GST_DEBUG_COLOR_MODE_OFF.

This function may be called before gst_init.

gst_debug_set_default_threshold

gst_debug_set_default_threshold (GstDebugLevel level)

Sets the default threshold to the given level and updates all categories to use this threshold.

This function may be called before gst_init.

gst_debug_set_threshold_for_name

gst_debug_set_threshold_for_name (const gchar * name,
                                  GstDebugLevel level)

Sets all categories which match the given glob style pattern to the given level.

gst_debug_set_threshold_from_string

gst_debug_set_threshold_from_string (const gchar * list,
                                     gboolean reset)

Sets the debug logging wanted in the same form as with the GST_DEBUG environment variable. You can use wildcards such as *, but note that the order matters when you use wild cards, e.g. foosrc:6,*src:3,*:2 sets everything to log level 2.

Since : 1.2

gst_debug_unset_threshold_for_name

gst_debug_unset_threshold_for_name (const gchar * name)

Resets all categories with the given name back to the default level.

gst_info_strdup_printf

gchar *
gst_info_strdup_printf (const gchar * format,
                        ... ...)

Allocates, fills and returns a 0-terminated string from the printf style format string and corresponding arguments.

See gst_info_vasprintf for when this function is required.

Free with g_free.

Since : 1.8

gst_info_strdup_vprintf

gchar *
gst_info_strdup_vprintf (const gchar * format,
                         va_list args)

Allocates, fills and returns a null terminated string from the printf style format string and args.

See gst_info_vasprintf for when this function is required.

Free with g_free.

Since : 1.8

gst_info_vasprintf

gint
gst_info_vasprintf (gchar ** result,
                    const gchar * format,
                    va_list args)

Allocates and fills a string large enough (including the terminating null byte) to hold the specified printf style format and args.

This function deals with the GStreamer specific printf specifiers GST_PTR_FORMAT and GST_SEGMENT_FORMAT. If you do not have these specifiers in your format string, you do not need to use this function and can use alternatives such as g_vasprintf.

Free result with g_free.

Since : 1.8

gst_print

gst_print (const gchar * format,
           ... ...)

Outputs a formatted message via the GLib print handler. The default print handler simply outputs the message to stdout.

This function will not append a new-line character at the end, unlike gst_println which will.

All strings must be in ASCII or UTF-8 encoding.

This function differs from g_print in that it supports all the additional printf specifiers that are supported by GStreamer's debug logging system, such as GST_PTR_FORMAT and GST_SEGMENT_FORMAT.

This function is primarily for printing debug output.

Since : 1.12

gst_printerr

gst_printerr (const gchar * format,
              ... ...)

Outputs a formatted message via the GLib error message handler. The default handler simply outputs the message to stderr.

This function will not append a new-line character at the end, unlike gst_printerrln which will.

All strings must be in ASCII or UTF-8 encoding.

This function differs from g_printerr in that it supports the additional printf specifiers that are supported by GStreamer's debug logging system, such as GST_PTR_FORMAT and GST_SEGMENT_FORMAT.

This function is primarily for printing debug output.

Since : 1.12

gst_printerrln

gst_printerrln (const gchar * format,
                ... ...)

Outputs a formatted message via the GLib error message handler. The default handler simply outputs the message to stderr.

This function will append a new-line character at the end, unlike gst_printerr which will not.

All strings must be in ASCII or UTF-8 encoding.

This function differs from g_printerr in that it supports the additional printf specifiers that are supported by GStreamer's debug logging system, such as GST_PTR_FORMAT and GST_SEGMENT_FORMAT.

This function is primarily for printing debug output.

Since : 1.12

gst_println

gst_println (const gchar * format,
             ... ...)

Outputs a formatted message via the GLib print handler. The default print handler simply outputs the message to stdout.

This function will append a new-line character at the end, unlike gst_print which will not.

All strings must be in ASCII or UTF-8 encoding.

This function differs from g_print in that it supports all the additional printf specifiers that are supported by GStreamer's debug logging system, such as GST_PTR_FORMAT and GST_SEGMENT_FORMAT.

This function is primarily for printing debug output.

Since : 1.12

GST_CAT_DEBUG

#define GST_CAT_DEBUG(cat,...)			GST_CAT_LEVEL_LOG (cat, GST_LEVEL_DEBUG,   NULL, __VA_ARGS__)

Output an 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_DEBUG_OBJECT

#define GST_CAT_DEBUG_OBJECT(cat,obj,...)	GST_CAT_LEVEL_LOG (cat, GST_LEVEL_DEBUG,   obj,  __VA_ARGS__)

Output an 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_ERROR

#define GST_CAT_ERROR(cat,...)			GST_CAT_LEVEL_LOG (cat, GST_LEVEL_ERROR,   NULL, __VA_ARGS__)

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_ERROR_OBJECT

#define GST_CAT_ERROR_OBJECT(cat,obj,...)	GST_CAT_LEVEL_LOG (cat, GST_LEVEL_ERROR,   obj,  __VA_ARGS__)

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_FIXME

#define GST_CAT_FIXME(cat,...)			GST_CAT_LEVEL_LOG (cat, GST_LEVEL_FIXME,   NULL, __VA_ARGS__)

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_FIXME_OBJECT

#define GST_CAT_FIXME_OBJECT(cat,obj,...)	GST_CAT_LEVEL_LOG (cat, GST_LEVEL_FIXME,   obj,  __VA_ARGS__)

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_INFO

#define GST_CAT_INFO(cat,...)			GST_CAT_LEVEL_LOG (cat, GST_LEVEL_INFO,    NULL, __VA_ARGS__)

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_INFO_OBJECT

#define GST_CAT_INFO_OBJECT(cat,obj,...)	GST_CAT_LEVEL_LOG (cat, GST_LEVEL_INFO,    obj,  __VA_ARGS__)

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_LEVEL_LOG

#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

Outputs a debugging message. This is the most general macro for outputting debugging messages. You will probably want to use one of the ones described below.

There is no need to finish the end of the debug message with a newline character, a newline character will be added automatically.

GST_CAT_LEVEL_LOG_ID

#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

Outputs a debugging message. This is the most general macro for outputting debugging messages. You will probably want to use one of the ones described below.

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

GST_CAT_LOG

#define GST_CAT_LOG(cat,...)			GST_CAT_LEVEL_LOG (cat, GST_LEVEL_LOG,     NULL, __VA_ARGS__)

Output an 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_LOG_OBJECT

#define GST_CAT_LOG_OBJECT(cat,obj,...)		GST_CAT_LEVEL_LOG (cat, GST_LEVEL_LOG,     obj,  __VA_ARGS__)

Output an 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_MEMDUMP

#define GST_CAT_MEMDUMP(cat,msg,data,length)             \
    __GST_CAT_MEMDUMP_LOG(cat,NULL,msg,data,length)

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_CAT_MEMDUMP_ID

#define GST_CAT_MEMDUMP_ID(cat,id,msg,data,length)	\
    __GST_CAT_MEMDUMP_LOG_ID(cat,id,msg,data,length)

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_MEMDUMP_OBJECT

#define GST_CAT_MEMDUMP_OBJECT(cat,obj,msg,data,length)  \
    __GST_CAT_MEMDUMP_LOG(cat,obj,msg,data,length)

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_TRACE

#define GST_CAT_TRACE(cat,...)		GST_CAT_LEVEL_LOG (cat, GST_LEVEL_TRACE,   NULL, __VA_ARGS__)

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_TRACE_OBJECT

#define GST_CAT_TRACE_OBJECT(cat,obj,...)	GST_CAT_LEVEL_LOG (cat, GST_LEVEL_TRACE,   obj,  __VA_ARGS__)

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_WARNING

#define GST_CAT_WARNING(cat,...)		GST_CAT_LEVEL_LOG (cat, GST_LEVEL_WARNING, NULL, __VA_ARGS__)

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_WARNING_OBJECT

#define GST_CAT_WARNING_OBJECT(cat,obj,...)	GST_CAT_LEVEL_LOG (cat, GST_LEVEL_WARNING, obj,  __VA_ARGS__)

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_DEBUG

#define GST_DEBUG(...)			GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_DEBUG,   NULL, __VA_ARGS__)

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_DEBUG_CATEGORY

#define GST_DEBUG_CATEGORY(cat) GstDebugCategory *cat = NULL

Defines a GstDebugCategory variable. This macro expands to nothing if debugging is disabled.

GST_DEBUG_CATEGORY_EXTERN

#define GST_DEBUG_CATEGORY_EXTERN(cat) extern GstDebugCategory *cat

Declares a GstDebugCategory variable as extern. Use in header files. This macro expands to nothing if debugging is disabled.

GST_DEBUG_CATEGORY_GET

#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

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");

GST_DEBUG_CATEGORY_INIT

#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

Initializes a new GstDebugCategory with the given properties and set to the default threshold.

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.

GST_DEBUG_CATEGORY_STATIC

#define GST_DEBUG_CATEGORY_STATIC(cat) static GstDebugCategory *cat = NULL

Defines a static GstDebugCategory variable. This macro expands to nothing if debugging is disabled.

GST_DEBUG_FUNCPTR

#define GST_DEBUG_FUNCPTR(ptr) \
  (_gst_debug_register_funcptr((GstDebugFuncPtr)(ptr), #ptr) , ptr)

Register a pointer to a function with its name, so it can later be used by GST_DEBUG_FUNCPTR_NAME.

GST_DEBUG_FUNCPTR_NAME

#define GST_DEBUG_FUNCPTR_NAME(ptr) \
  _gst_debug_nameof_funcptr((GstDebugFuncPtr)ptr)

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.

GST_DEBUG_ID

#define GST_DEBUG_ID(id,...)	GST_CAT_LEVEL_LOG_ID (GST_CAT_DEFAULT, GST_LEVEL_DEBUG,   id,  __VA_ARGS__)

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_DEBUG_OBJECT

#define GST_DEBUG_OBJECT(obj,...)	GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_DEBUG,   obj,  __VA_ARGS__)

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_DEBUG_PAD_NAME

#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)) : "''"

Evaluates to 2 strings, that describe the pad. Often used in debugging statements.

GST_DEBUG_REGISTER_FUNCPTR

#define GST_DEBUG_REGISTER_FUNCPTR(ptr) \
  _gst_debug_register_funcptr((GstDebugFuncPtr)(ptr), #ptr)

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.

GST_ERROR

#define GST_ERROR(...)			GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_ERROR,   NULL, __VA_ARGS__)

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_ERROR_ID

#define GST_ERROR_ID(id,...)	GST_CAT_LEVEL_LOG_ID (GST_CAT_DEFAULT, GST_LEVEL_ERROR,   id,  __VA_ARGS__)

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_ERROR_OBJECT

#define GST_ERROR_OBJECT(obj,...)	GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_ERROR,   obj,  __VA_ARGS__)

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_FIXME

#define GST_FIXME(...)			GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_FIXME,   NULL, __VA_ARGS__)

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_FIXME_ID

#define GST_FIXME_ID(id,...)	GST_CAT_LEVEL_LOG_ID (GST_CAT_DEFAULT, GST_LEVEL_FIXME,   id,  __VA_ARGS__)

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_FIXME_OBJECT

#define GST_FIXME_OBJECT(obj,...)	GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_FIXME,   obj,  __VA_ARGS__)

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_INFO

#define GST_INFO(...)			GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_INFO,    NULL, __VA_ARGS__)

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_INFO_ID

#define GST_INFO_ID(id,...)	GST_CAT_LEVEL_LOG_ID (GST_CAT_DEFAULT, GST_LEVEL_INFO,    id,  __VA_ARGS__)

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_INFO_OBJECT

#define GST_INFO_OBJECT(obj,...)	GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_INFO,    obj,  __VA_ARGS__)

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_LOG

#define GST_LOG(...)			GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_LOG,     NULL, __VA_ARGS__)

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_LOG_ID

#define GST_LOG_ID(id,...)	GST_CAT_LEVEL_LOG_ID (GST_CAT_DEFAULT, GST_LEVEL_LOG,     id,  __VA_ARGS__)

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_LOG_OBJECT

#define GST_LOG_OBJECT(obj,...)		GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_LOG,     obj,  __VA_ARGS__)

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_MEMDUMP

#define GST_MEMDUMP(msg,data,length)                     \
    __GST_CAT_MEMDUMP_LOG(GST_CAT_DEFAULT,NULL,msg,data,length)

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.

GST_MEMDUMP_ID

#define GST_MEMDUMP_ID(id,msg,data,length)          \
    __GST_CAT_MEMDUMP_LOG_ID(GST_CAT_DEFAULT,id,msg,data,length)

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_MEMDUMP_OBJECT

#define GST_MEMDUMP_OBJECT(obj,msg,data,length)          \
    __GST_CAT_MEMDUMP_LOG(GST_CAT_DEFAULT,obj,msg,data,length)

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_STR_NULL

#define GST_STR_NULL(str) ((str) ? (str) : "(NULL)")

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.

GST_TRACE

#define GST_TRACE(...)		GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_TRACE,   NULL, __VA_ARGS__)

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_TRACE_ID

#define GST_TRACE_ID(id,...)	GST_CAT_LEVEL_LOG_ID (GST_CAT_DEFAULT, GST_LEVEL_TRACE,   id,  __VA_ARGS__)

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_TRACE_OBJECT

#define GST_TRACE_OBJECT(obj,...)	GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_TRACE,   obj,  __VA_ARGS__)

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_WARNING

#define GST_WARNING(...)		GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_WARNING, NULL, __VA_ARGS__)

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_WARNING_ID

#define GST_WARNING_ID(id,...)	GST_CAT_LEVEL_LOG_ID (GST_CAT_DEFAULT, GST_LEVEL_WARNING, id,  __VA_ARGS__)

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_WARNING_OBJECT

#define GST_WARNING_OBJECT(obj,...)	GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_WARNING, obj,  __VA_ARGS__)

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_CAT_MEMDUMP_LOG

#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

#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

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

GstDebugColorFlags

These are some terminal style flags you can use when creating your debugging categories to make them stand out in debugging output.

GstDebugColorMode

GstDebugLevel

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.

GstStackTraceFlags

Since : 1.12

GST_DEBUG_BG_MASK

#define GST_DEBUG_BG_MASK	(0x00F0)

GST_DEBUG_FG_MASK

#define GST_DEBUG_FG_MASK	(0x000F)

GST_DEBUG_FORMAT_MASK

#define GST_DEBUG_FORMAT_MASK	(0xFF00)

GST_FUNCTION

#define GST_FUNCTION     ((const char*) (__func__))

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.

GST_LEVEL_DEFAULT

#define GST_LEVEL_DEFAULT GST_LEVEL_NONE

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.

GST_LEVEL_MAX

#define GST_LEVEL_MAX GST_LEVEL_COUNT

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

GST_PTR_FORMAT

#define GST_PTR_FORMAT     "p\aA"

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).

GST_SEGMENT_FORMAT

#define GST_SEGMENT_FORMAT "p\aB"

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.

GST_STIMEP_FORMAT

#define GST_STIMEP_FORMAT "p\aS"

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

GST_TIMEP_FORMAT

#define GST_TIMEP_FORMAT "p\aT"

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

_gst_debug_min

#define _gst_debug_min GST_LEVEL_NONE

GstLogFunction

(*GstLogFunction) (GstDebugCategory * category,
                   GstDebugLevel level,
                   const gchar * file,
                   const gchar * function,
                   gint line,
                   GObject * object,
                   GstDebugMessage * message,
                   gpointer user_data)

Function prototype for a logging function that can be registered with gst_debug_add_log_function. Use G_GNUC_NO_INSTRUMENT on that function.