gst/gsttracer.h

   1 /* GStreamer
   2  * Copyright (C) 2013 Stefan Sauer <ensonic@users.sf.net>
   3  *
   4  * gsttracer.h: tracing subsystem
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  19  * Boston, MA 02110-1301, USA.
  20  */
  21
  22 #ifndef __GST_TRACER_H__
  23 #define __GST_TRACER_H__
  24
  25 #include <glib.h>
  26 #include <glib-object.h>
  27 #include <gst/gstconfig.h>
  28 #include <gst/gstbin.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #ifndef GST_DISABLE_GST_DEBUG
  33
  34 /* hook flags and ids */
  35
  36 typedef enum
  37 {
  38   GST_TRACER_HOOK_NONE      = 0,
  39   GST_TRACER_HOOK_BUFFERS   = (1 << 0),
  40   GST_TRACER_HOOK_EVENTS    = (1 << 1),
  41   GST_TRACER_HOOK_MESSAGES  = (1 << 2),
  42   GST_TRACER_HOOK_QUERIES   = (1 << 3),
  43   GST_TRACER_HOOK_TOPOLOGY  = (1 << 4),
  44   /*
  45   GST_TRACER_HOOK_TIMER
  46   */
  47   GST_TRACER_HOOK_ALL       = (1 << 5) - 1
  48 } GstTracerHook;
  49
  50 typedef enum
  51 {
  52   GST_TRACER_HOOK_ID_BUFFERS = 0,
  53   GST_TRACER_HOOK_ID_EVENTS,
  54   GST_TRACER_HOOK_ID_MESSAGES,
  55   GST_TRACER_HOOK_ID_QUERIES,
  56   GST_TRACER_HOOK_ID_TOPLOGY,
  57   /*
  58   GST_TRACER_HOOK_ID_TIMER
  59   */
  60   GST_TRACER_HOOK_ID_LAST
  61 } GstTracerHookId;
  62
  63 typedef enum
  64 {
  65   GST_TRACER_MESSAGE_ID_PAD_PUSH_PRE = 0,
  66   GST_TRACER_MESSAGE_ID_PAD_PUSH_POST,
  67   GST_TRACER_MESSAGE_ID_PAD_PUSH_LIST_PRE,
  68   GST_TRACER_MESSAGE_ID_PAD_PUSH_LIST_POST,
  69   GST_TRACER_MESSAGE_ID_PAD_PULL_RANGE_PRE,
  70   GST_TRACER_MESSAGE_ID_PAD_PULL_RANGE_POST,
  71   GST_TRACER_MESSAGE_ID_PAD_PUSH_EVENT_PRE,
  72   GST_TRACER_MESSAGE_ID_PAD_PUSH_EVENT_POST,
  73   GST_TRACER_MESSAGE_ID_ELEMENT_POST_MESSAGE_PRE,
  74   GST_TRACER_MESSAGE_ID_ELEMENT_POST_MESSAGE_POST,
  75   GST_TRACER_MESSAGE_ID_ELEMENT_QUERY_PRE,
  76   GST_TRACER_MESSAGE_ID_ELEMENT_QUERY_POST,
  77   GST_TRACER_MESSAGE_ID_LAST
  78 } GstTracerMessageId;
  79
  80 /* tracing plugins */
  81
  82 typedef struct _GstTracer GstTracer;
  83 typedef struct _GstTracerPrivate GstTracerPrivate;
  84 typedef struct _GstTracerClass GstTracerClass;
  85
  86 #define GST_TYPE_TRACER            (gst_tracer_get_type())
  87 #define GST_TRACER(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_TRACER,GstTracer))
  88 #define GST_TRACER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_TRACER,GstTracerClass))
  89 #define GST_IS_TRACER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_TRACER))
  90 #define GST_IS_TRACER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_TRACER))
  91 #define GST_TRACER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj),GST_TYPE_TRACER,GstTracerClass))
  92 #define GST_TRACER_CAST(obj)       ((GstTracer *)(obj))
  93
  94 struct _GstTracer {
  95   GstObject        parent;
  96   /*< private >*/
  97   GstTracerPrivate *priv;
  98   gpointer _gst_reserved[GST_PADDING];
  99 };
 100
 101 typedef void (*GstTracerInvokeFunction) (GstTracer * self, GstTracerHookId hid,
 102     GstTracerMessageId mid, va_list var_args);
 103
 104 struct _GstTracerClass {
 105   GstObjectClass parent_class;
 106
 107   /* plugin vmethods */
 108   GstTracerInvokeFunction invoke;
 109
 110   /*< private >*/
 111   gpointer _gst_reserved[GST_PADDING];
 112 };
 113
 114 GType gst_tracer_get_type          (void);
 115
 116 /* tracing hooks */
 117
 118 void _priv_gst_tracer_init (void);
 119 void _priv_gst_tracer_deinit (void);
 120
 121 gboolean gst_tracer_register (GstPlugin * plugin, const gchar * name, GType type);
 122 void gst_tracer_dispatch (GstTracerHookId hid, GstTracerMessageId mid, ...);
 123
 124 extern gboolean _priv_tracer_enabled;
 125 extern GList *_priv_tracers[GST_TRACER_HOOK_ID_LAST];
 126
 127 extern GstClockTime _priv_gst_info_start_time;
 128 #define GST_TRACER_IS_ENABLED(id) \
 129   (_priv_tracer_enabled && (_priv_tracers[id] != NULL))
 130
 131 #define GST_TRACER_TS \
 132   GST_CLOCK_DIFF (_priv_gst_info_start_time, gst_util_get_timestamp ())
 133
 134 /* tracing hooks */
 135
 136 #define GST_TRACER_PAD_PUSH_PRE(pad, buffer) G_STMT_START{ \
 137   if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_BUFFERS)) { \
 138     gst_tracer_dispatch (GST_TRACER_HOOK_ID_BUFFERS, \
 139         GST_TRACER_MESSAGE_ID_PAD_PUSH_PRE, GST_TRACER_TS, \
 140         pad, buffer); \
 141   } \
 142 }G_STMT_END
 143
 144 #define GST_TRACER_PAD_PUSH_POST(pad, res) G_STMT_START{ \
 145   if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_BUFFERS)) { \
 146     gst_tracer_dispatch (GST_TRACER_HOOK_ID_BUFFERS, \
 147         GST_TRACER_MESSAGE_ID_PAD_PUSH_POST, GST_TRACER_TS, \
 148         pad, res); \
 149   } \
 150 }G_STMT_END
 151
 152 #define GST_TRACER_PAD_PUSH_LIST_PRE(pad, list) G_STMT_START{ \
 153   if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_BUFFERS)) { \
 154     gst_tracer_dispatch (GST_TRACER_HOOK_ID_BUFFERS, \
 155         GST_TRACER_MESSAGE_ID_PAD_PUSH_LIST_PRE, GST_TRACER_TS, \
 156         pad, list); \
 157   } \
 158 }G_STMT_END
 159
 160 #define GST_TRACER_PAD_PUSH_LIST_POST(pad, res) G_STMT_START{ \
 161   if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_BUFFERS)) { \
 162     gst_tracer_dispatch (GST_TRACER_HOOK_ID_BUFFERS, \
 163         GST_TRACER_MESSAGE_ID_PAD_PUSH_LIST_POST, GST_TRACER_TS, \
 164         pad, res); \
 165   } \
 166 }G_STMT_END
 167
 168 #define GST_TRACER_PAD_PULL_RANGE_PRE(pad, offset, size) G_STMT_START{ \
 169   if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_BUFFERS)) { \
 170     gst_tracer_dispatch (GST_TRACER_HOOK_ID_BUFFERS, \
 171         GST_TRACER_MESSAGE_ID_PAD_PULL_RANGE_PRE, GST_TRACER_TS, \
 172         pad, offset, size); \
 173   } \
 174 }G_STMT_END
 175
 176 #define GST_TRACER_PAD_PULL_RANGE_POST(pad, buffer, res) G_STMT_START{ \
 177   if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_BUFFERS)) { \
 178     gst_tracer_dispatch (GST_TRACER_HOOK_ID_BUFFERS, \
 179         GST_TRACER_MESSAGE_ID_PAD_PULL_RANGE_POST, GST_TRACER_TS, \
 180         pad, buffer, res); \
 181   } \
 182 }G_STMT_END
 183
 184 #define GST_TRACER_PAD_PUSH_EVENT_PRE(pad, event) G_STMT_START{ \
 185   if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_EVENTS)) { \
 186     gst_tracer_dispatch (GST_TRACER_HOOK_ID_EVENTS, \
 187         GST_TRACER_MESSAGE_ID_PAD_PUSH_EVENT_PRE, GST_TRACER_TS, \
 188         pad, event); \
 189   } \
 190 }G_STMT_END
 191
 192 #define GST_TRACER_PAD_PUSH_EVENT_POST(pad, res) G_STMT_START{ \
 193   if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_EVENTS)) { \
 194     gst_tracer_dispatch (GST_TRACER_HOOK_ID_EVENTS, \
 195         GST_TRACER_MESSAGE_ID_PAD_PUSH_EVENT_POST, GST_TRACER_TS, \
 196         pad, res); \
 197   } \
 198 }G_STMT_END
 199
 200 #define GST_TRACER_ELEMENT_POST_MESSAGE_PRE(element, message) G_STMT_START{ \
 201   if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_MESSAGES)) { \
 202     gst_tracer_dispatch (GST_TRACER_HOOK_ID_MESSAGES, \
 203         GST_TRACER_MESSAGE_ID_ELEMENT_POST_MESSAGE_PRE, GST_TRACER_TS, \
 204         element, message); \
 205   } \
 206 }G_STMT_END
 207
 208 #define GST_TRACER_ELEMENT_POST_MESSAGE_POST(element, res) G_STMT_START{ \
 209   if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_MESSAGES)) { \
 210     gst_tracer_dispatch (GST_TRACER_HOOK_ID_MESSAGES, \
 211         GST_TRACER_MESSAGE_ID_ELEMENT_POST_MESSAGE_POST, GST_TRACER_TS, \
 212         element, res); \
 213   } \
 214 }G_STMT_END
 215
 216 #define GST_TRACER_ELEMENT_QUERY_PRE(element, query) G_STMT_START{ \
 217   if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_QUERIES)) { \
 218     gst_tracer_dispatch (GST_TRACER_HOOK_ID_QUERIES, \
 219         GST_TRACER_MESSAGE_ID_ELEMENT_QUERY_PRE, GST_TRACER_TS, \
 220         element, query); \
 221   } \
 222 }G_STMT_END
 223
 224 #define GST_TRACER_ELEMENT_QUERY_POST(element, res) G_STMT_START{ \
 225   if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_QUERIES)) { \
 226     gst_tracer_dispatch (GST_TRACER_HOOK_ID_QUERIES, \
 227         GST_TRACER_MESSAGE_ID_ELEMENT_QUERY_POST, GST_TRACER_TS, \
 228         element, res); \
 229   } \
 230 }G_STMT_END
 231
 232 #else /* !GST_DISABLE_GST_DEBUG */
 233
 234 #define GST_TRACER_PAD_PUSH_PRE(pad, buffer)
 235 #define GST_TRACER_PAD_PUSH_POST(pad, res)
 236 #define GST_TRACER_PAD_PUSH_LIST_PRE(pad, list)
 237 #define GST_TRACER_PAD_PUSH_LIST_POST(pad, res)
 238 #define GST_TRACER_PAD_PULL_RANGE_PRE(pad, offset, size)
 239 #define GST_TRACER_PAD_PULL_RANGE_POST(pad, buffer, res)
 240 #define GST_TRACER_PAD_PUSH_EVENT_PRE(pad, event)
 241 #define GST_TRACER_PAD_PUSH_EVENT_POST(pad, res)
 242 #define GST_TRACER_ELEMENT_POST_MESSAGE_PRE(element, message)
 243 #define GST_TRACER_ELEMENT_POST_MESSAGE_POST(element, res)
 244 #define GST_TRACER_ELEMENT_QUERY_PRE(element, query)
 245 #define GST_TRACER_ELEMENT_QUERY_POST(element, res)
 246
 247 #endif /* GST_DISABLE_GST_DEBUG */
 248
 249 G_END_DECLS
 250
 251 #endif /* __GST_TRACER_H__ */
 252