docs: convert NULL, TRUE, and FALSE to %NULL, %TRUE, and %FALSE
[platform/upstream/gstreamer.git] / gst / gstinfo.h
index 27cdc76..319e841 100644 (file)
@@ -17,8 +17,8 @@
  *
  * You should have received a copy of the GNU Library General Public
  * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
  */
 
 #ifndef __GSTINFO_H__
 #include <glib-object.h>
 #include <gst/gstconfig.h>
 
-#ifndef M_PI
-#define M_PI  3.14159265358979323846
-#endif
-
 G_BEGIN_DECLS
 
 /**
  * GstDebugLevel:
  * @GST_LEVEL_NONE: No debugging level specified or desired. Used to deactivate
  *  debugging output.
- * @GST_LEVEL_ERROR: Error messages are to be used only when an error occured
+ * @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_errror.
+ *  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.
- *  An example would be notifications about state changes or receiving/sending of
- *  events.
+ *  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 iterating as expected
- *  should never output anzthing else but LOG messages.
- *  Examples for this are referencing/dereferencing of objects or cothread switches.
- * @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. (Since: 0.10.23)
+ *  should never output anything else but LOG messages. 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. (Since: 0.10.23)
+ *  ASCII characters.
  * @GST_LEVEL_COUNT: The number of defined debugging levels.
  *
  * The level defines the importance of a debugging message. The more important a
@@ -74,12 +75,13 @@ G_BEGIN_DECLS
  */
 typedef enum {
   GST_LEVEL_NONE = 0,
-  GST_LEVEL_ERROR,
-  GST_LEVEL_WARNING,
-  GST_LEVEL_INFO,
-  GST_LEVEL_DEBUG,
-  GST_LEVEL_LOG,
-  GST_LEVEL_FIXME = 6,
+  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 */
@@ -157,6 +159,20 @@ typedef enum {
   GST_DEBUG_UNDERLINE          = 0x0200
 } GstDebugColorFlags;
 
+/**
+ * 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)
@@ -183,9 +199,9 @@ struct _GstDebugCategory {
  * GST_STR_NULL:
  * @str: The string to check.
  *
- * Macro to use when a string must not be NULL, but may be NULL. If the string
- * is NULL, "(NULL)" is printed instead.
- * In GStreamer printf string arguments may not be NULL, because on some
+ * 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.
  */
@@ -227,6 +243,21 @@ struct _GstDebugCategory {
 #endif
 #endif /* ifndef GST_FUNCTION */
 
+/**
+ * GST_PTR_FORMAT:
+ *
+ * printf format type used to debug GStreamer types.
+ * This can only be used on types whose size is >= sizeof(gpointer).
+ */
+#define GST_PTR_FORMAT     "p\aA"
+
+/**
+ * GST_SEGMENT_FORMAT:
+ *
+ * printf format type used to debug GStreamer segments.
+ * This can only be used on pointers to GstSegment structures.
+ */
+#define GST_SEGMENT_FORMAT "p\aB"
 
 typedef struct _GstDebugMessage GstDebugMessage;
 
@@ -239,7 +270,7 @@ typedef struct _GstDebugMessage GstDebugMessage;
  * @line: line number
  * @object: a #GObject
  * @message: the message
- * @data: user data for the log function
+ * @user_data: user data for the log function
  *
  * Function prototype for a logging function that can be registered with
  * gst_debug_add_log_function().
@@ -252,27 +283,7 @@ typedef void (*GstLogFunction)  (GstDebugCategory * category,
                                  gint               line,
                                  GObject          * object,
                                  GstDebugMessage  * message,
-                                 gpointer           data);
-
-#ifndef GST_DISABLE_GST_DEBUG
-
-/* FIXME 0.11: move this into private headers */
-void            _gst_debug_init (void);
-
-
-#ifdef GST_USING_PRINTF_EXTENSION
-
-/* not using G_GNUC_PRINTF, since gcc will choke on GST_PTR_FORMAT being %P */
-void               gst_debug_log            (GstDebugCategory * category,
-                                          GstDebugLevel      level,
-                                          const gchar      * file,
-                                          const gchar      * function,
-                                          gint               line,
-                                          GObject          * object,
-                                          const gchar      * format,
-                                          ...) G_GNUC_NO_INSTRUMENT;
-
-#else /* GST_USING_PRINTF_EXTENSION */
+                                 gpointer           user_data);
 
 void               gst_debug_log            (GstDebugCategory * category,
                                           GstDebugLevel      level,
@@ -283,8 +294,6 @@ void                    gst_debug_log            (GstDebugCategory * category,
                                           const gchar      * format,
                                           ...) G_GNUC_PRINTF (7, 8) G_GNUC_NO_INSTRUMENT;
 
-#endif /* GST_USING_PRINTF_EXTENSION */
-
 void            gst_debug_log_valist     (GstDebugCategory * category,
                                           GstDebugLevel      level,
                                           const gchar      * file,
@@ -294,6 +303,32 @@ void            gst_debug_log_valist     (GstDebugCategory * category,
                                           const gchar      * format,
                                           va_list            args) G_GNUC_NO_INSTRUMENT;
 
+/* do not use this function, use the GST_DEBUG_CATEGORY_INIT macro */
+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 */
+GstDebugCategory *_gst_debug_get_category (const gchar *name);
+
+
+/* do not use this function, use the GST_CAT_MEMDUMP_* macros */
+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);
+
+/* 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 */
+void   _gst_debug_register_funcptr     (GstDebugFuncPtr        func,
+                                        const gchar *          ptrname);
+const gchar *
+       _gst_debug_nameof_funcptr       (GstDebugFuncPtr        func) G_GNUC_NO_INSTRUMENT;
+
+
 const gchar   * gst_debug_message_get    (GstDebugMessage  * message);
 
 void            gst_debug_log_default    (GstDebugCategory * category,
@@ -305,11 +340,12 @@ void            gst_debug_log_default    (GstDebugCategory * category,
                                           GstDebugMessage  * message,
                                           gpointer           unused) G_GNUC_NO_INSTRUMENT;
 
-G_CONST_RETURN gchar *
-                gst_debug_level_get_name (GstDebugLevel level);
+const gchar *   gst_debug_level_get_name (GstDebugLevel level);
 
 void            gst_debug_add_log_function            (GstLogFunction func,
-                                                       gpointer       data);
+                                                       gpointer       user_data,
+                                                       GDestroyNotify notify);
+
 guint           gst_debug_remove_log_function         (GstLogFunction func);
 guint           gst_debug_remove_log_function_by_data (gpointer       data);
 
@@ -317,13 +353,49 @@ void            gst_debug_set_active  (gboolean active);
 gboolean        gst_debug_is_active   (void);
 
 void            gst_debug_set_colored (gboolean colored);
+void            gst_debug_set_color_mode   (GstDebugColorMode mode);
+void            gst_debug_set_color_mode_from_string (const gchar * mode);
 gboolean        gst_debug_is_colored  (void);
+GstDebugColorMode gst_debug_get_color_mode (void);
+
+void            gst_debug_set_default_threshold      (GstDebugLevel level);
+GstDebugLevel   gst_debug_get_default_threshold      (void);
+void            gst_debug_set_threshold_for_name     (const gchar * name,
+                                                      GstDebugLevel level);
+void            gst_debug_set_threshold_from_string  (const gchar * list, gboolean reset);
+void            gst_debug_unset_threshold_for_name   (const gchar * name);
+
+
+void            gst_debug_category_free              (GstDebugCategory *       category);
+void               gst_debug_category_set_threshold     (GstDebugCategory *    category,
+                                                      GstDebugLevel            level);
+void            gst_debug_category_reset_threshold   (GstDebugCategory *       category);
+GstDebugLevel   gst_debug_category_get_threshold     (GstDebugCategory *       category);
+const gchar *   gst_debug_category_get_name          (GstDebugCategory *       category);
+guint           gst_debug_category_get_color         (GstDebugCategory *       category);
+const gchar *   gst_debug_category_get_description   (GstDebugCategory *       category);
+GSList *        gst_debug_get_all_categories   (void);
+
+
+gchar * gst_debug_construct_term_color (guint colorinfo);
+gint    gst_debug_construct_win_color  (guint colorinfo);
+
+
+#ifndef GST_DISABLE_GST_DEBUG
 
-void            gst_debug_set_default_threshold            (GstDebugLevel level);
-GstDebugLevel   gst_debug_get_default_threshold            (void);
-void            gst_debug_set_threshold_for_name    (const gchar * name,
-                                                     GstDebugLevel level);
-void            gst_debug_unset_threshold_for_name  (const gchar * name);
+#define gst_debug_add_log_function(func,data,notify) \
+G_STMT_START{                                        \
+  if (func == 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)   \
+    (func == gst_debug_log_default) ?         \
+        gst_debug_remove_log_function(NULL) : \
+        gst_debug_remove_log_function(func)
 
 /**
  * GST_DEBUG_CATEGORY:
@@ -351,10 +423,6 @@ void            gst_debug_unset_threshold_for_name  (const gchar * name);
  */
 #define GST_DEBUG_CATEGORY_STATIC(cat) static GstDebugCategory *cat = NULL
 
-/* do not use this function, use the GST_DEBUG_CATEGORY_INIT macro below */
-GstDebugCategory *_gst_debug_category_new (const gchar * name,
-                                           guint         color,
-                                           const gchar * description);
 /**
  * GST_DEBUG_CATEGORY_INIT:
  * @cat: the category to initialize.
@@ -395,31 +463,14 @@ GstDebugCategory *_gst_debug_category_new (const gchar * name,
     cat = _gst_debug_category_new (name,color,description);            \
 }G_STMT_END
 
-void   gst_debug_category_free         (GstDebugCategory *     category);
-void   gst_debug_category_set_threshold (GstDebugCategory *    category,
-                                        GstDebugLevel          level);
-void   gst_debug_category_reset_threshold(GstDebugCategory *   category);
-GstDebugLevel
-       gst_debug_category_get_threshold (GstDebugCategory *    category);
-G_CONST_RETURN gchar *
-       gst_debug_category_get_name     (GstDebugCategory *     category);
-guint  gst_debug_category_get_color    (GstDebugCategory *     category);
-G_CONST_RETURN gchar *
-       gst_debug_category_get_description (GstDebugCategory *  category);
-GSList *
-        gst_debug_get_all_categories   (void);
-
-/* do not use this function, use the GST_DEBUG_CATEGORY_GET macro below */
-GstDebugCategory *_gst_debug_get_category (const gchar *name);
-
 /**
  * GST_DEBUG_CATEGORY_GET:
  * @cat: the category to initialize.
  * @name: log category name
  *
- * Lookup an exiting #GstDebugCategory by its @name and sets @cat. If category
- * is not found, but %GST_CAT_DEFAULT is defined, that is assigned to @cat.
- * Otherwise cat will be NULL.
+ * 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);
@@ -427,10 +478,8 @@ GstDebugCategory *_gst_debug_get_category (const gchar *name);
  * 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, "performance");
+ * GST_DEBUG_CATEGORY_GET (GST_CAT_PERFORMANCE, "GST_PERFORMANCE");
  * ]|
- *
- * Since: 0.10.24
  */
 #ifdef GST_CAT_DEFAULT
 #define GST_DEBUG_CATEGORY_GET(cat,name)  G_STMT_START{\
@@ -445,11 +494,6 @@ GstDebugCategory *_gst_debug_get_category (const gchar *name);
 }G_STMT_END
 #endif
 
-
-gchar * gst_debug_construct_term_color (guint colorinfo);
-gint    gst_debug_construct_win_color (guint colorinfo);
-
-
 /**
  * GST_CAT_DEFAULT:
  *
@@ -457,17 +501,17 @@ gint    gst_debug_construct_win_color (guint colorinfo);
  */
 GST_EXPORT GstDebugCategory *  GST_CAT_DEFAULT;
 /* this symbol may not be used */
-extern gboolean                        __gst_debug_enabled;
+GST_EXPORT gboolean                    _gst_debug_enabled;
 
-/* since 0.10.7, the min debug level, used for quickly discarding debug
+/* the min debug level, used for quickly discarding debug
  * messages that fall under the threshold. */
-GST_EXPORT GstDebugLevel            __gst_debug_min; 
+GST_EXPORT GstDebugLevel            _gst_debug_min;
 
 /**
  * GST_CAT_LEVEL_LOG:
  * @cat: category to use
  * @level: the severity of the message
- * @object: the #GObject the message belongs to or NULL if none
+ * @object: (allow-none): the #GObject the message belongs to or %NULL if none
  * @...: A printf-style message to output
  *
  * Outputs a debugging message. This is the most general macro for outputting
@@ -476,7 +520,7 @@ GST_EXPORT GstDebugLevel            __gst_debug_min;
  */
 #ifdef G_HAVE_ISO_VARARGS
 #define GST_CAT_LEVEL_LOG(cat,level,object,...) G_STMT_START{          \
-  if (G_UNLIKELY (level <= __gst_debug_min)) {                                         \
+  if (G_UNLIKELY (level <= _gst_debug_min)) {                                          \
     gst_debug_log ((cat), (level), __FILE__, GST_FUNCTION, __LINE__,   \
         (GObject *) (object), __VA_ARGS__);                            \
   }                                                                    \
@@ -484,7 +528,7 @@ GST_EXPORT GstDebugLevel            __gst_debug_min;
 #else /* G_HAVE_GNUC_VARARGS */
 #ifdef G_HAVE_GNUC_VARARGS
 #define GST_CAT_LEVEL_LOG(cat,level,object,args...) G_STMT_START{      \
-  if (G_UNLIKELY (level <= __gst_debug_min)) {                                         \
+  if (G_UNLIKELY (level <= _gst_debug_min)) {                                          \
     gst_debug_log ((cat), (level), __FILE__, GST_FUNCTION, __LINE__,   \
         (GObject *) (object), ##args );                                        \
   }                                                                    \
@@ -494,7 +538,7 @@ static inline void
 GST_CAT_LEVEL_LOG_valist (GstDebugCategory * cat,
     GstDebugLevel level, gpointer object, const char *format, va_list varargs)
 {
-  if (G_UNLIKELY (level <= __gst_debug_min)) {
+  if (G_UNLIKELY (level <= _gst_debug_min)) {
     gst_debug_log_valist (cat, level, "", "", 0, (GObject *) object, format,
         varargs);
   }
@@ -513,16 +557,11 @@ GST_CAT_LEVEL_LOG (GstDebugCategory * cat, GstDebugLevel level,
 #endif
 #endif /* G_HAVE_ISO_VARARGS */
 
-/* private helper function */
-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);
-
 /* 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_debug_min)) {                    \
+  if (G_UNLIKELY (GST_LEVEL_MEMDUMP <= _gst_debug_min)) {                    \
     _gst_debug_dump_mem ((cat), __FILE__, GST_FUNCTION, __LINE__,             \
         (GObject *) (object), (msg), (data), (length));                       \
   }                                                                           \
@@ -585,8 +624,15 @@ void _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
  * @...: printf-style message to output
  *
  * Output a fixme message belonging to the given object in the given category.
+ */
+/**
+ * GST_CAT_TRACE_OBJECT:
+ * @cat: category to use
+ * @obj: the #GObject the message belongs to
+ * @...: printf-style message to output
  *
- * Since: 0.10.23
+ * Output a tracing message belonging to the given object in the given
+ * category.
  */
 /**
  * GST_CAT_MEMDUMP_OBJECT:
@@ -598,8 +644,6 @@ void _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
  *
  * Output a hexdump of @data relating to the given object in the given
  * category.
- *
- * Since: 0.10.23
  */
 
 
@@ -644,8 +688,13 @@ void _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
  * @...: printf-style message to output
  *
  * Output an fixme message in the given category.
+ */
+/**
+ * GST_CAT_TRACE:
+ * @cat: category to use
+ * @...: printf-style message to output
  *
- * Since: 0.10.23
+ * Output a tracing message in the given category.
  */
 /**
  * GST_CAT_MEMDUMP:
@@ -655,8 +704,6 @@ void _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
  * @length: length of the data to output
  *
  * Output a hexdump of @data in the given category.
- *
- * Since: 0.10.23
  */
 
 
@@ -702,9 +749,14 @@ void _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
  * @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.
+ * Output a fixme message belonging to the given object in the default category.
+ */
+/**
+ * GST_TRACE_OBJECT:
+ * @obj: the #GObject the message belongs to
+ * @...: printf-style message to output
  *
- * Since: 0.10.23
+ * Output a tracing message belonging to the given object in the default category.
  */
 /**
  * GST_MEMDUMP_OBJECT:
@@ -714,8 +766,6 @@ void _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
  * @length: length of the data to output
  *
  * Output a logging message belonging to the given object in the default category.
- *
- * Since: 0.10.23
  */
 
 
@@ -754,8 +804,12 @@ void _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
  * @...: printf-style message to output
  *
  * Output a fixme message in the default category.
+ */
+/**
+ * GST_TRACE:
+ * @...: printf-style message to output
  *
- * Since: 0.10.23
+ * Output a tracing message in the default category.
  */
 /**
  * GST_MEMDUMP:
@@ -764,8 +818,6 @@ void _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
  * @length: length of the data to output
  *
  * Output a hexdump of @data.
- *
- * Since: 0.10.23
  */
 
 #ifdef G_HAVE_ISO_VARARGS
@@ -776,6 +828,7 @@ void _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
 #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__)
@@ -783,6 +836,7 @@ void _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
 #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__)
@@ -790,6 +844,7 @@ void _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
 #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(...)                 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__)
@@ -797,6 +852,7 @@ void _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
 #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__)
 
 #else
 #ifdef G_HAVE_GNUC_VARARGS
@@ -807,6 +863,7 @@ void _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
 #define GST_CAT_DEBUG_OBJECT(cat,obj,args...)  GST_CAT_LEVEL_LOG (cat, GST_LEVEL_DEBUG,   obj,  ##args )
 #define GST_CAT_LOG_OBJECT(cat,obj,args...)    GST_CAT_LEVEL_LOG (cat, GST_LEVEL_LOG,     obj,  ##args )
 #define GST_CAT_FIXME_OBJECT(cat,obj,args...)  GST_CAT_LEVEL_LOG (cat, GST_LEVEL_FIXME,   obj,  ##args )
+#define GST_CAT_TRACE_OBJECT(cat,obj,args...)  GST_CAT_LEVEL_LOG (cat, GST_LEVEL_TRACE,   obj,  ##args )
 
 #define GST_CAT_ERROR(cat,args...)             GST_CAT_LEVEL_LOG (cat, GST_LEVEL_ERROR,   NULL, ##args )
 #define GST_CAT_WARNING(cat,args...)           GST_CAT_LEVEL_LOG (cat, GST_LEVEL_WARNING, NULL, ##args )
@@ -814,6 +871,7 @@ void _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
 #define GST_CAT_DEBUG(cat,args...)             GST_CAT_LEVEL_LOG (cat, GST_LEVEL_DEBUG,   NULL, ##args )
 #define GST_CAT_LOG(cat,args...)               GST_CAT_LEVEL_LOG (cat, GST_LEVEL_LOG,     NULL, ##args )
 #define GST_CAT_FIXME(cat,args...)             GST_CAT_LEVEL_LOG (cat, GST_LEVEL_FIXME,   NULL, ##args )
+#define GST_CAT_TRACE(cat,args...)             GST_CAT_LEVEL_LOG (cat, GST_LEVEL_TRACE,   NULL, ##args )
 
 #define GST_ERROR_OBJECT(obj,args...)  GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_ERROR,   obj,  ##args )
 #define GST_WARNING_OBJECT(obj,args...)        GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_WARNING, obj,  ##args )
@@ -821,6 +879,7 @@ void _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
 #define GST_DEBUG_OBJECT(obj,args...)  GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_DEBUG,   obj,  ##args )
 #define GST_LOG_OBJECT(obj,args...)    GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_LOG,     obj,  ##args )
 #define GST_FIXME_OBJECT(obj,args...)  GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_FIXME,   obj,  ##args )
+#define GST_TRACE_OBJECT(obj,args...)  GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_TRACE,   obj,  ##args )
 
 #define GST_ERROR(args...)             GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_ERROR,   NULL, ##args )
 #define GST_WARNING(args...)           GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_WARNING, NULL, ##args )
@@ -828,6 +887,7 @@ void _gst_debug_dump_mem (GstDebugCategory * cat, const gchar * file,
 #define GST_DEBUG(args...)             GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_DEBUG,   NULL, ##args )
 #define GST_LOG(args...)               GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_LOG,     NULL, ##args )
 #define GST_FIXME(args...)             GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_FIXME,   NULL, ##args )
+#define GST_TRACE(args...)             GST_CAT_LEVEL_LOG (GST_CAT_DEFAULT, GST_LEVEL_TRACE,   NULL, ##args )
 
 #else
 /* no variadic macros, use inline */
@@ -898,6 +958,17 @@ GST_CAT_FIXME_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
 }
 
 static inline void
+GST_CAT_TRACE_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
+    ...)
+{
+  va_list varargs;
+
+  va_start (varargs, format);
+  GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_TRACE, obj, format, varargs);
+  va_end (varargs);
+}
+
+static inline void
 GST_CAT_ERROR (GstDebugCategory * cat, const char *format, ...)
 {
   va_list varargs;
@@ -958,6 +1029,16 @@ GST_CAT_FIXME (GstDebugCategory * cat, const char *format, ...)
 }
 
 static inline void
+GST_CAT_TRACE (GstDebugCategory * cat, const char *format, ...)
+{
+  va_list varargs;
+
+  va_start (varargs, format);
+  GST_CAT_LEVEL_LOG_valist (cat, GST_LEVEL_TRACE, NULL, format, varargs);
+  va_end (varargs);
+}
+
+static inline void
 GST_ERROR_OBJECT (gpointer obj, const char *format, ...)
 {
   va_list varargs;
@@ -1024,6 +1105,17 @@ GST_FIXME_OBJECT (gpointer obj, const char *format, ...)
 }
 
 static inline void
+GST_TRACE_OBJECT (gpointer obj, const char *format, ...)
+{
+  va_list varargs;
+
+  va_start (varargs, format);
+  GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_TRACE, obj, format,
+      varargs);
+  va_end (varargs);
+}
+
+static inline void
 GST_ERROR (const char *format, ...)
 {
   va_list varargs;
@@ -1088,24 +1180,42 @@ GST_FIXME (const char *format, ...)
       varargs);
   va_end (varargs);
 }
+
+static inline void
+GST_TRACE (const char *format, ...)
+{
+  va_list varargs;
+
+  va_start (varargs, format);
+  GST_CAT_LEVEL_LOG_valist (GST_CAT_DEFAULT, GST_LEVEL_TRACE, NULL, format,
+      varargs);
+  va_end (varargs);
+}
 #endif
 #endif
 
 
 /********** function pointer stuff **********/
 
-typedef        void (* GstDebugFuncPtr)        (void);
-void   _gst_debug_register_funcptr     (GstDebugFuncPtr        func,
-                                        const gchar *          ptrname);
-G_CONST_RETURN gchar *
-       _gst_debug_nameof_funcptr       (GstDebugFuncPtr        func);
-
+/**
+ * GST_DEBUG_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)
@@ -1135,34 +1245,32 @@ G_CONST_RETURN gchar *
 #  pragma GCC poison _gst_debug_category_new
 #endif
 
-#define __gst_debug_min GST_LEVEL_NONE
-
-#define _gst_debug_init()                              G_STMT_START{ }G_STMT_END
+#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_add_log_function(func,data)          G_STMT_START{ }G_STMT_END
-guint gst_debug_remove_log_function (GstLogFunction func);
-guint gst_debug_remove_log_function_by_data (gpointer data);
+#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
 
-#define GST_DEBUG_CATEGORY(var)                                void _gst_dummy_declaration (void)
-#define GST_DEBUG_CATEGORY_EXTERN(var)                 void _gst_dummy_declaration (void)
-#if !defined(G_HAVE_GNUC_VARARGS) && !defined(G_HAVE_ISO_VARARGS)
-#define GST_DEBUG_CATEGORY_STATIC(var)                 static GstDebugCategory *var = NULL
-#else
-#define GST_DEBUG_CATEGORY_STATIC(var)                 void _gst_dummy_declaration (void)
-#endif
+/* 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
 #define gst_debug_category_free(category)              G_STMT_START{ }G_STMT_END
@@ -1188,6 +1296,7 @@ guint gst_debug_remove_log_function_by_data (gpointer data);
 #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
@@ -1195,6 +1304,7 @@ guint gst_debug_remove_log_function_by_data (gpointer data);
 #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
@@ -1202,6 +1312,7 @@ guint gst_debug_remove_log_function_by_data (gpointer data);
 #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(...)                                 G_STMT_START{ }G_STMT_END
 #define GST_WARNING(...)                               G_STMT_START{ }G_STMT_END
@@ -1209,6 +1320,7 @@ guint gst_debug_remove_log_function_by_data (gpointer data);
 #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
 
 #else /* !G_HAVE_ISO_VARARGS */
 #ifdef G_HAVE_GNUC_VARARGS
@@ -1221,6 +1333,7 @@ guint gst_debug_remove_log_function_by_data (gpointer data);
 #define GST_CAT_DEBUG_OBJECT(args...)                  G_STMT_START{ }G_STMT_END
 #define GST_CAT_LOG_OBJECT(args...)                    G_STMT_START{ }G_STMT_END
 #define GST_CAT_FIXME_OBJECT(args...)                  G_STMT_START{ }G_STMT_END
+#define GST_CAT_TRACE_OBJECT(args...)                  G_STMT_START{ }G_STMT_END
 
 #define GST_CAT_ERROR(args...)                         G_STMT_START{ }G_STMT_END
 #define GST_CAT_WARNING(args...)                       G_STMT_START{ }G_STMT_END
@@ -1228,6 +1341,7 @@ guint gst_debug_remove_log_function_by_data (gpointer data);
 #define GST_CAT_DEBUG(args...)                         G_STMT_START{ }G_STMT_END
 #define GST_CAT_LOG(args...)                           G_STMT_START{ }G_STMT_END
 #define GST_CAT_FIXME(args...)                         G_STMT_START{ }G_STMT_END
+#define GST_CAT_TRACE(args...)                         G_STMT_START{ }G_STMT_END
 
 #define GST_ERROR_OBJECT(args...)                      G_STMT_START{ }G_STMT_END
 #define GST_WARNING_OBJECT(args...)                    G_STMT_START{ }G_STMT_END
@@ -1235,6 +1349,7 @@ guint gst_debug_remove_log_function_by_data (gpointer data);
 #define GST_DEBUG_OBJECT(args...)                      G_STMT_START{ }G_STMT_END
 #define GST_LOG_OBJECT(args...)                                G_STMT_START{ }G_STMT_END
 #define GST_FIXME_OBJECT(args...)                      G_STMT_START{ }G_STMT_END
+#define GST_TRACE_OBJECT(args...)                      G_STMT_START{ }G_STMT_END
 
 #define GST_ERROR(args...)                             G_STMT_START{ }G_STMT_END
 #define GST_WARNING(args...)                           G_STMT_START{ }G_STMT_END
@@ -1242,6 +1357,7 @@ guint gst_debug_remove_log_function_by_data (gpointer data);
 #define GST_DEBUG(args...)                             G_STMT_START{ }G_STMT_END
 #define GST_LOG(args...)                               G_STMT_START{ }G_STMT_END
 #define GST_FIXME(args...)                             G_STMT_START{ }G_STMT_END
+#define GST_TRACE(args...)                             G_STMT_START{ }G_STMT_END
 
 #else /* !G_HAVE_GNUC_VARARGS */
 static inline void
@@ -1287,6 +1403,12 @@ GST_CAT_FIXME_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
 }
 
 static inline void
+GST_CAT_TRACE_OBJECT (GstDebugCategory * cat, gpointer obj, const char *format,
+    ...)
+{
+}
+
+static inline void
 GST_CAT_ERROR (GstDebugCategory * cat, const char *format, ...)
 {
 }
@@ -1317,6 +1439,11 @@ GST_CAT_FIXME (GstDebugCategory * cat, const char *format, ...)
 }
 
 static inline void
+GST_CAT_TRACE (GstDebugCategory * cat, const char *format, ...)
+{
+}
+
+static inline void
 GST_ERROR_OBJECT (gpointer obj, const char *format, ...)
 {
 }
@@ -1347,6 +1474,11 @@ GST_FIXME_OBJECT (gpointer obj, const char *format, ...)
 }
 
 static inline void
+GST_TRACE_OBJECT (gpointer obj, const char *format, ...)
+{
+}
+
+static inline void
 GST_ERROR (const char *format, ...)
 {
 }
@@ -1376,9 +1508,15 @@ GST_FIXME (const char *format, ...)
 {
 }
 
+static inline void
+GST_TRACE (const char *format, ...)
+{
+}
+
 #endif /* G_HAVE_GNUC_VARARGS */
 #endif /* G_HAVE_ISO_VARARGS */
 
+#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))