gst/gsttracerutils.h

   1 /* GStreamer
   2  * Copyright (C) 2013 Stefan Sauer <ensonic@users.sf.net>
   3  *
   4  * gsttracerutils.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
  23 #ifndef __GST_TRACER_UTILS_H__
  24 #define __GST_TRACER_UTILS_H__
  25
  26 #include <glib.h>
  27 #include <glib-object.h>
  28 #include <gst/gstconfig.h>
  29 #include <gst/gstbin.h>
  30
  31 G_BEGIN_DECLS
  32
  33 #ifndef GST_DISABLE_GST_TRACER_HOOKS
  34
  35 /* tracing hooks */
  36
  37 void _priv_gst_tracing_init (void);
  38 void _priv_gst_tracing_deinit (void);
  39
  40 /* tracer quarks */
  41
  42 /* These enums need to match the number and order
  43  * of strings declared in _quark_table, in gsttracerutils.c */
  44 typedef enum /*< skip >*/
  45 {
  46   GST_TRACER_QUARK_HOOK_PAD_PUSH_PRE = 0,
  47   GST_TRACER_QUARK_HOOK_PAD_PUSH_POST,
  48   GST_TRACER_QUARK_HOOK_PAD_PUSH_LIST_PRE,
  49   GST_TRACER_QUARK_HOOK_PAD_PUSH_LIST_POST,
  50   GST_TRACER_QUARK_HOOK_PAD_PULL_RANGE_PRE,
  51   GST_TRACER_QUARK_HOOK_PAD_PULL_RANGE_POST,
  52   GST_TRACER_QUARK_HOOK_PAD_PUSH_EVENT_PRE ,
  53   GST_TRACER_QUARK_HOOK_PAD_PUSH_EVENT_POST,
  54   GST_TRACER_QUARK_HOOK_PAD_QUERY_PRE ,
  55   GST_TRACER_QUARK_HOOK_PAD_QUERY_POST,
  56   GST_TRACER_QUARK_HOOK_ELEMENT_POST_MESSAGE_PRE,
  57   GST_TRACER_QUARK_HOOK_ELEMENT_POST_MESSAGE_POST,
  58   GST_TRACER_QUARK_HOOK_ELEMENT_QUERY_PRE,
  59   GST_TRACER_QUARK_HOOK_ELEMENT_QUERY_POST,
  60   GST_TRACER_QUARK_HOOK_ELEMENT_NEW,
  61   GST_TRACER_QUARK_HOOK_ELEMENT_ADD_PAD,
  62   GST_TRACER_QUARK_HOOK_ELEMENT_REMOVE_PAD,
  63   GST_TRACER_QUARK_HOOK_BIN_ADD_PRE,
  64   GST_TRACER_QUARK_HOOK_BIN_ADD_POST,
  65   GST_TRACER_QUARK_HOOK_BIN_REMOVE_PRE,
  66   GST_TRACER_QUARK_HOOK_BIN_REMOVE_POST,
  67   GST_TRACER_QUARK_HOOK_PAD_LINK_PRE,
  68   GST_TRACER_QUARK_HOOK_PAD_LINK_POST,
  69   GST_TRACER_QUARK_HOOK_PAD_UNLINK_PRE,
  70   GST_TRACER_QUARK_HOOK_PAD_UNLINK_POST,
  71   GST_TRACER_QUARK_HOOK_ELEMENT_CHANGE_STATE_PRE,
  72   GST_TRACER_QUARK_HOOK_ELEMENT_CHANGE_STATE_POST,
  73   GST_TRACER_QUARK_MAX
  74 } GstTracerQuarkId;
  75
  76 extern GQuark _priv_gst_tracer_quark_table[GST_TRACER_QUARK_MAX];
  77
  78 #define GST_TRACER_QUARK(q) _priv_gst_tracer_quark_table[GST_TRACER_QUARK_##q]
  79
  80 /* tracing module helpers */
  81
  82 typedef struct {
  83   GObject *tracer;
  84   GCallback func;
  85 } GstTracerHook;
  86
  87 extern gboolean _priv_tracer_enabled;
  88 /* key are hook-id quarks, values are GstTracerHook */
  89 extern GHashTable *_priv_tracers;
  90
  91 #define GST_TRACER_IS_ENABLED (_priv_tracer_enabled)
  92
  93 #define GST_TRACER_TS \
  94   GST_CLOCK_DIFF (_priv_gst_info_start_time, gst_util_get_timestamp ())
  95
  96 /* tracing hooks */
  97
  98 #define GST_TRACER_ARGS h->tracer, ts
  99 #define GST_TRACER_DISPATCH(key,type,args) G_STMT_START{ \
 100   if (GST_TRACER_IS_ENABLED) {                                         \
 101     GstClockTime ts = GST_TRACER_TS;                                   \
 102     GList *__l, *__n;                                                  \
 103     GstTracerHook *h;                                                  \
 104     __l = g_hash_table_lookup (_priv_tracers, GINT_TO_POINTER (key));  \
 105     for (__n = __l; __n; __n = g_list_next (__n)) {                    \
 106       h = (GstTracerHook *) __n->data;                                 \
 107       ((type)(h->func)) args;                                          \
 108     }                                                                  \
 109     __l = g_hash_table_lookup (_priv_tracers, NULL);                   \
 110     for (__n = __l; __n; __n = g_list_next (__n)) {                    \
 111       h = (GstTracerHook *) __n->data;                                 \
 112       ((type)(h->func)) args;                                          \
 113     }                                                                  \
 114   }                                                                    \
 115 }G_STMT_END
 116
 117 typedef void (*GstTracerHookPadPushPre) (GObject *, GstClockTime, GstPad *,
 118     GstBuffer *);
 119 #define GST_TRACER_PAD_PUSH_PRE(pad, buffer) G_STMT_START{ \
 120   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_PRE), \
 121     GstTracerHookPadPushPre, (GST_TRACER_ARGS, pad, buffer)); \
 122 }G_STMT_END
 123
 124 typedef void (*GstTracerHookPadPushPost) (GObject *, GstClockTime, GstPad *,
 125     GstFlowReturn);
 126 #define GST_TRACER_PAD_PUSH_POST(pad, res) G_STMT_START{ \
 127   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_POST), \
 128     GstTracerHookPadPushPost, (GST_TRACER_ARGS, pad, res)); \
 129 }G_STMT_END
 130
 131 typedef void (*GstTracerHookPadPushListPre) (GObject *, GstClockTime, GstPad *,
 132     GstBufferList *);
 133 #define GST_TRACER_PAD_PUSH_LIST_PRE(pad, list) G_STMT_START{ \
 134   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_LIST_PRE), \
 135     GstTracerHookPadPushListPre, (GST_TRACER_ARGS, pad, list)); \
 136 }G_STMT_END
 137
 138 typedef void (*GstTracerHookPadPushListPost) (GObject *, GstClockTime, GstPad *,
 139     GstFlowReturn);
 140 #define GST_TRACER_PAD_PUSH_LIST_POST(pad, res) G_STMT_START{ \
 141   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_LIST_POST), \
 142     GstTracerHookPadPushListPost, (GST_TRACER_ARGS, pad, res)); \
 143 }G_STMT_END
 144
 145 typedef void (*GstTracerHookPadPullRangePre) (GObject *, GstClockTime, GstPad *,
 146     guint64, guint);
 147 #define GST_TRACER_PAD_PULL_RANGE_PRE(pad, offset, size) G_STMT_START{ \
 148   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PULL_RANGE_PRE), \
 149     GstTracerHookPadPullRangePre, (GST_TRACER_ARGS, pad, offset, size)); \
 150 }G_STMT_END
 151
 152 typedef void (*GstTracerHookPadPullRangePost) (GObject *, GstClockTime,
 153     GstPad *, GstBuffer *, GstFlowReturn);
 154 #define GST_TRACER_PAD_PULL_RANGE_POST(pad, buffer, res) G_STMT_START{ \
 155   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PULL_RANGE_POST), \
 156     GstTracerHookPadPullRangePost, (GST_TRACER_ARGS, pad, buffer, res)); \
 157 }G_STMT_END
 158
 159 typedef void (*GstTracerHookPadPushEventPre) (GObject *, GstClockTime, GstPad *,
 160     GstEvent *);
 161 #define GST_TRACER_PAD_PUSH_EVENT_PRE(pad, event) G_STMT_START{ \
 162   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_EVENT_PRE), \
 163     GstTracerHookPadPushEventPre, (GST_TRACER_ARGS, pad, event)); \
 164 }G_STMT_END
 165
 166 typedef void (*GstTracerHookPadPushEventPost) (GObject *, GstClockTime,
 167     GstPad *, gboolean);
 168 #define GST_TRACER_PAD_PUSH_EVENT_POST(pad, res) G_STMT_START{ \
 169   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_EVENT_POST), \
 170     GstTracerHookPadPushEventPost, (GST_TRACER_ARGS, pad, res)); \
 171 }G_STMT_END
 172
 173 typedef void (*GstTracerHookPadQueryPre) (GObject *, GstClockTime, GstPad *,
 174     GstQuery *);
 175 #define GST_TRACER_PAD_QUERY_PRE(pad, query) G_STMT_START{ \
 176   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_QUERY_PRE), \
 177     GstTracerHookPadQueryPre, (GST_TRACER_ARGS, pad, query)); \
 178 }G_STMT_END
 179
 180 typedef void (*GstTracerHookPadQueryPost) (GObject *, GstClockTime,
 181     GstPad *, gboolean, GstQuery *);
 182 #define GST_TRACER_PAD_QUERY_POST(pad, res, query) G_STMT_START{ \
 183   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_QUERY_POST), \
 184     GstTracerHookPadQueryPost, (GST_TRACER_ARGS, pad, res, query)); \
 185 }G_STMT_END
 186
 187 typedef void (*GstTracerHookElementPostMessagePre) (GObject *, GstClockTime,
 188     GstElement *, GstMessage *);
 189 #define GST_TRACER_ELEMENT_POST_MESSAGE_PRE(element, message) G_STMT_START{ \
 190   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_POST_MESSAGE_PRE), \
 191     GstTracerHookElementPostMessagePre, (GST_TRACER_ARGS, element, message)); \
 192 }G_STMT_END
 193
 194 typedef void (*GstTracerHookElementPostMessagePost) (GObject *, GstClockTime,
 195     GstElement *, gboolean);
 196 #define GST_TRACER_ELEMENT_POST_MESSAGE_POST(element, res) G_STMT_START{ \
 197   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_POST_MESSAGE_POST), \
 198     GstTracerHookElementPostMessagePost, (GST_TRACER_ARGS, element, res)); \
 199 }G_STMT_END
 200
 201 typedef void (*GstTracerHookElementQueryPre) (GObject *, GstClockTime,
 202     GstElement *, GstQuery *);
 203 #define GST_TRACER_ELEMENT_QUERY_PRE(element, query) G_STMT_START{ \
 204   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_QUERY_PRE), \
 205     GstTracerHookElementQueryPre, (GST_TRACER_ARGS, element, query)); \
 206 }G_STMT_END
 207
 208 typedef void (*GstTracerHookElementQueryPost) (GObject *, GstClockTime,
 209     GstElement *, gboolean);
 210 #define GST_TRACER_ELEMENT_QUERY_POST(element, res) G_STMT_START{ \
 211   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_QUERY_POST), \
 212     GstTracerHookElementQueryPost, (GST_TRACER_ARGS, element, res)); \
 213 }G_STMT_END
 214
 215 typedef void (*GstTracerHookElementNew) (GObject *, GstClockTime,
 216     GstElement *);
 217 #define GST_TRACER_ELEMENT_NEW(element) G_STMT_START{ \
 218   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_NEW), \
 219     GstTracerHookElementNew, (GST_TRACER_ARGS, element)); \
 220 }G_STMT_END
 221
 222 typedef void (*GstTracerHookElementAddPad) (GObject *, GstClockTime,
 223     GstElement *, GstPad *);
 224 #define GST_TRACER_ELEMENT_ADD_PAD(element, pad) G_STMT_START{ \
 225   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_ADD_PAD), \
 226     GstTracerHookElementAddPad, (GST_TRACER_ARGS, element, pad)); \
 227 }G_STMT_END
 228
 229 typedef void (*GstTracerHookElementRemovePad) (GObject *, GstClockTime,
 230     GstElement *, GstPad *);
 231 #define GST_TRACER_ELEMENT_REMOVE_PAD(element, pad) G_STMT_START{ \
 232   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_REMOVE_PAD), \
 233     GstTracerHookElementRemovePad, (GST_TRACER_ARGS, element, pad)); \
 234 }G_STMT_END
 235
 236 typedef void (*GstTracerHookElementChangeStatePre) (GObject *, GstClockTime,
 237     GstElement *, GstStateChange);
 238 #define GST_TRACER_ELEMENT_CHANGE_STATE_PRE(element, transition) G_STMT_START{ \
 239   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_CHANGE_STATE_PRE), \
 240     GstTracerHookElementChangeStatePre, (GST_TRACER_ARGS, element, transition)); \
 241 }G_STMT_END
 242
 243 typedef void (*GstTracerHookElementChangeStatePost) (GObject *, GstClockTime,
 244     GstElement *, GstStateChange, GstStateChangeReturn);
 245 #define GST_TRACER_ELEMENT_CHANGE_STATE_POST(element, transition, result) G_STMT_START{ \
 246   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_CHANGE_STATE_POST), \
 247     GstTracerHookElementChangeStatePost, (GST_TRACER_ARGS, element, transition, result)); \
 248 }G_STMT_END
 249
 250 typedef void (*GstTracerHookBinAddPre) (GObject *, GstClockTime,
 251     GstBin *, GstElement *);
 252 #define GST_TRACER_BIN_ADD_PRE(bin, element) G_STMT_START{ \
 253   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_BIN_ADD_PRE), \
 254     GstTracerHookBinAddPre, (GST_TRACER_ARGS, bin, element)); \
 255 }G_STMT_END
 256
 257 typedef void (*GstTracerHookBinAddPost) (GObject *, GstClockTime,
 258     GstBin *, GstElement *, gboolean);
 259 #define GST_TRACER_BIN_ADD_POST(bin, element, result) G_STMT_START{ \
 260   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_BIN_ADD_POST), \
 261     GstTracerHookBinAddPost, (GST_TRACER_ARGS, bin, element, result)); \
 262 }G_STMT_END
 263
 264 typedef void (*GstTracerHookBinRemovePre) (GObject *, GstClockTime,
 265     GstBin *, GstElement *);
 266 #define GST_TRACER_BIN_REMOVE_PRE(bin, element) G_STMT_START{ \
 267   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_BIN_REMOVE_PRE), \
 268     GstTracerHookBinRemovePre, (GST_TRACER_ARGS, bin, element)); \
 269 }G_STMT_END
 270
 271 typedef void (*GstTracerHookBinRemovePost) (GObject *, GstClockTime,
 272     GstBin *, gboolean);
 273 #define GST_TRACER_BIN_REMOVE_POST(bin, result) G_STMT_START{ \
 274   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_BIN_REMOVE_POST), \
 275     GstTracerHookBinRemovePost, (GST_TRACER_ARGS, bin, result)); \
 276 }G_STMT_END
 277
 278 typedef void (*GstTracerHookPadLinkPre) (GObject *, GstClockTime,
 279     GstPad *, GstPad *);
 280 #define GST_TRACER_PAD_LINK_PRE(srcpad, sinkpad) G_STMT_START{ \
 281   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_LINK_PRE), \
 282     GstTracerHookPadLinkPre, (GST_TRACER_ARGS, srcpad, sinkpad)); \
 283 }G_STMT_END
 284
 285 typedef void (*GstTracerHookPadLinkPost) (GObject *, GstClockTime,
 286     GstPad *, GstPad *, GstPadLinkReturn);
 287 #define GST_TRACER_PAD_LINK_POST(srcpad, sinkpad, result) G_STMT_START{ \
 288   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_LINK_POST), \
 289     GstTracerHookPadLinkPost, (GST_TRACER_ARGS, srcpad, sinkpad, result)); \
 290 }G_STMT_END
 291
 292 typedef void (*GstTracerHookPadUnlinkPre) (GObject *, GstClockTime,
 293     GstPad *, GstPad *);
 294 #define GST_TRACER_PAD_UNLINK_PRE(srcpad, sinkpad) G_STMT_START{ \
 295   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_UNLINK_PRE), \
 296     GstTracerHookPadUnlinkPre, (GST_TRACER_ARGS, srcpad, sinkpad)); \
 297 }G_STMT_END
 298
 299 typedef void (*GstTracerHookPadUnlinkPost) (GObject *, GstClockTime,
 300     GstPad *, GstPad *, gboolean);
 301 #define GST_TRACER_PAD_UNLINK_POST(srcpad, sinkpad, result) G_STMT_START{ \
 302   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_UNLINK_POST), \
 303     GstTracerHookPadUnlinkPost, (GST_TRACER_ARGS, srcpad, sinkpad, result)); \
 304 }G_STMT_END
 305
 306 #else /* !GST_DISABLE_GST_TRACER_HOOKS */
 307
 308 #define GST_TRACER_PAD_PUSH_PRE(pad, buffer)
 309 #define GST_TRACER_PAD_PUSH_POST(pad, res)
 310 #define GST_TRACER_PAD_PUSH_LIST_PRE(pad, list)
 311 #define GST_TRACER_PAD_PUSH_LIST_POST(pad, res)
 312 #define GST_TRACER_PAD_PULL_RANGE_PRE(pad, offset, size)
 313 #define GST_TRACER_PAD_PULL_RANGE_POST(pad, buffer, res)
 314 #define GST_TRACER_PAD_PUSH_EVENT_PRE(pad, event)
 315 #define GST_TRACER_PAD_PUSH_EVENT_POST(pad, res)
 316 #define GST_TRACER_PAD_QUERY_PRE(pad, query)
 317 #define GST_TRACER_PAD_QUERY_POST(pad, res, query)
 318 #define GST_TRACER_ELEMENT_POST_MESSAGE_PRE(element, message)
 319 #define GST_TRACER_ELEMENT_POST_MESSAGE_POST(element, res)
 320 #define GST_TRACER_ELEMENT_QUERY_PRE(element, query)
 321 #define GST_TRACER_ELEMENT_QUERY_POST(element, res)
 322 #define GST_TRACER_ELEMENT_NEW(element)
 323 #define GST_TRACER_ELEMENT_ADD_PAD(element, pad)
 324 #define GST_TRACER_ELEMENT_REMOVE_PAD(element, pad)
 325 #define GST_TRACER_ELEMENT_CHANGE_STATE_PRE(element, transition)
 326 #define GST_TRACER_ELEMENT_CHANGE_STATE_POST(element, transition, res)
 327 #define GST_TRACER_BIN_ADD_PRE(bin, element)
 328 #define GST_TRACER_BIN_ADD_POST(bin, element, res)
 329 #define GST_TRACER_BIN_REMOVE_PRE(bin, element)
 330 #define GST_TRACER_BIN_REMOVE_POST(bin, res)
 331 #define GST_TRACER_PAD_LINK_PRE(srcpad, sinkpad)
 332 #define GST_TRACER_PAD_LINK_POST(srcpad, sinkpad, res)
 333 #define GST_TRACER_PAD_UNLINK_PRE(srcpad, sinkpad)
 334 #define GST_TRACER_PAD_UNLINK_POST(srcpad, sinkpad, res)
 335
 336 #endif /* GST_DISABLE_GST_TRACER_HOOKS */
 337
 338 G_END_DECLS
 339
 340 #endif /* __GST_TRACER_UTILS_H__ */
 341