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_DEBUG
  34
  35 /* tracing hooks */
  36
  37 void _priv_gst_tracing_init (void);
  38 void _priv_gst_tracing_deinit (void);
  39
  40 /* tracing modules */
  41
  42 gboolean gst_tracer_register (GstPlugin * plugin, const gchar * name, GType type);
  43
  44 /* tracer quarks */
  45
  46 /* These enums need to match the number and order
  47  * of strings declared in _quark_table, in gsttracerutils.c */
  48 typedef enum _GstTracerQuarkId
  49 {
  50   GST_TRACER_QUARK_HOOK_PAD_PUSH_PRE = 0,
  51   GST_TRACER_QUARK_HOOK_PAD_PUSH_POST,
  52   GST_TRACER_QUARK_HOOK_PAD_PUSH_LIST_PRE,
  53   GST_TRACER_QUARK_HOOK_PAD_PUSH_LIST_POST,
  54   GST_TRACER_QUARK_HOOK_PAD_PULL_RANGE_PRE,
  55   GST_TRACER_QUARK_HOOK_PAD_PULL_RANGE_POST,
  56   GST_TRACER_QUARK_HOOK_PAD_PUSH_EVENT_PRE ,
  57   GST_TRACER_QUARK_HOOK_PAD_PUSH_EVENT_POST,
  58   GST_TRACER_QUARK_HOOK_PAD_QUERY_PRE ,
  59   GST_TRACER_QUARK_HOOK_PAD_QUERY_POST,
  60   GST_TRACER_QUARK_HOOK_ELEMENT_POST_MESSAGE_PRE,
  61   GST_TRACER_QUARK_HOOK_ELEMENT_POST_MESSAGE_POST,
  62   GST_TRACER_QUARK_HOOK_ELEMENT_QUERY_PRE,
  63   GST_TRACER_QUARK_HOOK_ELEMENT_QUERY_POST,
  64   GST_TRACER_QUARK_MAX
  65 } GstTracerQuarkId;
  66
  67 extern GQuark _priv_gst_tracer_quark_table[GST_TRACER_QUARK_MAX];
  68
  69 #define GST_TRACER_QUARK(q) _priv_gst_tracer_quark_table[GST_TRACER_QUARK_##q]
  70
  71 /* tracing module helpers */
  72
  73 typedef struct {
  74   GObject *tracer;
  75   GCallback func;
  76 } GstTracerHook;
  77
  78 extern gboolean _priv_tracer_enabled;
  79 /* key are hook-id quarks, values are GstTracerHook */
  80 extern GHashTable *_priv_tracers;
  81
  82 #define GST_TRACER_IS_ENABLED (_priv_tracer_enabled)
  83
  84 #define GST_TRACER_TS \
  85   GST_CLOCK_DIFF (_priv_gst_info_start_time, gst_util_get_timestamp ())
  86
  87 /* tracing hooks */
  88
  89 #define GST_TRACER_ARGS h->tracer, ts
  90 #define GST_TRACER_DISPATCH(key,type,args) G_STMT_START{ \
  91   if (GST_TRACER_IS_ENABLED) {                                         \
  92     GstClockTime ts = GST_TRACER_TS;                                   \
  93     GList *__l, *__n;                                                  \
  94     GstTracerHook *h;                                                  \
  95     __l = g_hash_table_lookup (_priv_tracers, GINT_TO_POINTER (key));  \
  96     for (__n = __l; __n; __n = g_list_next (__n)) {                    \
  97       h = (GstTracerHook *) __n->data;                                 \
  98       ((type)(h->func)) args;                                          \
  99     }                                                                  \
 100     __l = g_hash_table_lookup (_priv_tracers, NULL);                   \
 101     for (__n = __l; __n; __n = g_list_next (__n)) {                    \
 102       h = (GstTracerHook *) __n->data;                                 \
 103       ((type)(h->func)) args;                                          \
 104     }                                                                  \
 105   }                                                                    \
 106 }G_STMT_END
 107
 108 typedef void (*GstTracerHookPadPushPre) (GObject *, GstClockTime, GstPad *,
 109     GstBuffer *);
 110 #define GST_TRACER_PAD_PUSH_PRE(pad, buffer) G_STMT_START{ \
 111   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_PRE), \
 112     GstTracerHookPadPushPre, (GST_TRACER_ARGS, pad, buffer)); \
 113 }G_STMT_END
 114
 115 typedef void (*GstTracerHookPadPushPost) (GObject *, GstClockTime, GstPad *,
 116     GstFlowReturn);
 117 #define GST_TRACER_PAD_PUSH_POST(pad, res) G_STMT_START{ \
 118   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_POST), \
 119     GstTracerHookPadPushPost, (GST_TRACER_ARGS, pad, res)); \
 120 }G_STMT_END
 121
 122 typedef void (*GstTracerHookPadPushListPre) (GObject *, GstClockTime, GstPad *,
 123     GstBufferList *);
 124 #define GST_TRACER_PAD_PUSH_LIST_PRE(pad, list) G_STMT_START{ \
 125   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_LIST_PRE), \
 126     GstTracerHookPadPushListPre, (GST_TRACER_ARGS, pad, list)); \
 127 }G_STMT_END
 128
 129 typedef void (*GstTracerHookPadPushListPost) (GObject *, GstClockTime, GstPad *,
 130     GstFlowReturn);
 131 #define GST_TRACER_PAD_PUSH_LIST_POST(pad, res) G_STMT_START{ \
 132   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_LIST_POST), \
 133     GstTracerHookPadPushListPost, (GST_TRACER_ARGS, pad, res)); \
 134 }G_STMT_END
 135
 136 typedef void (*GstTracerHookPadPullRangePre) (GObject *, GstClockTime, GstPad *,
 137     guint64, guint);
 138 #define GST_TRACER_PAD_PULL_RANGE_PRE(pad, offset, size) G_STMT_START{ \
 139   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PULL_RANGE_PRE), \
 140     GstTracerHookPadPullRangePre, (GST_TRACER_ARGS, pad, offset, size)); \
 141 }G_STMT_END
 142
 143 typedef void (*GstTracerHookPadPullRangePost) (GObject *, GstClockTime,
 144     GstPad *, GstBuffer *, GstFlowReturn);
 145 #define GST_TRACER_PAD_PULL_RANGE_POST(pad, buffer, res) G_STMT_START{ \
 146   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PULL_RANGE_POST), \
 147     GstTracerHookPadPullRangePost, (GST_TRACER_ARGS, pad, buffer, res)); \
 148 }G_STMT_END
 149
 150 typedef void (*GstTracerHookPadPushEventPre) (GObject *, GstClockTime, GstPad *,
 151     GstEvent *);
 152 #define GST_TRACER_PAD_PUSH_EVENT_PRE(pad, event) G_STMT_START{ \
 153   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_EVENT_PRE), \
 154     GstTracerHookPadPushEventPre, (GST_TRACER_ARGS, pad, event)); \
 155 }G_STMT_END
 156
 157 typedef void (*GstTracerHookPadPushEventPost) (GObject *, GstClockTime,
 158     GstPad *, gboolean);
 159 #define GST_TRACER_PAD_PUSH_EVENT_POST(pad, res) G_STMT_START{ \
 160   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_EVENT_POST), \
 161     GstTracerHookPadPushEventPost, (GST_TRACER_ARGS, pad, res)); \
 162 }G_STMT_END
 163
 164 typedef void (*GstTracerHookPadQueryPre) (GObject *, GstClockTime, GstPad *,
 165     GstQuery *);
 166 #define GST_TRACER_PAD_QUERY_PRE(pad, query) G_STMT_START{ \
 167   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_QUERY_PRE), \
 168     GstTracerHookPadQueryPre, (GST_TRACER_ARGS, pad, query)); \
 169 }G_STMT_END
 170
 171 typedef void (*GstTracerHookPadQueryPost) (GObject *, GstClockTime,
 172     GstPad *, gboolean, GstQuery *);
 173 #define GST_TRACER_PAD_QUERY_POST(pad, res, query) G_STMT_START{ \
 174   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_QUERY_POST), \
 175     GstTracerHookPadQueryPost, (GST_TRACER_ARGS, pad, res, query)); \
 176 }G_STMT_END
 177
 178 typedef void (*GstTracerHookElementPostMessagePre) (GObject *, GstClockTime,
 179     GstElement *, GstMessage *);
 180 #define GST_TRACER_ELEMENT_POST_MESSAGE_PRE(element, message) G_STMT_START{ \
 181   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_POST_MESSAGE_PRE), \
 182     GstTracerHookElementPostMessagePre, (GST_TRACER_ARGS, element, message)); \
 183 }G_STMT_END
 184
 185 typedef void (*GstTracerHookElementPostMessagePost) (GObject *, GstClockTime,
 186     GstElement *, gboolean);
 187 #define GST_TRACER_ELEMENT_POST_MESSAGE_POST(element, res) G_STMT_START{ \
 188   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_POST_MESSAGE_POST), \
 189     GstTracerHookElementPostMessagePost, (GST_TRACER_ARGS, element, res)); \
 190 }G_STMT_END
 191
 192 typedef void (*GstTracerHookElementQueryPre) (GObject *, GstClockTime,
 193     GstElement *, GstQuery *);
 194 #define GST_TRACER_ELEMENT_QUERY_PRE(element, query) G_STMT_START{ \
 195   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_QUERY_PRE), \
 196     GstTracerHookElementQueryPre, (GST_TRACER_ARGS, element, query)); \
 197 }G_STMT_END
 198
 199 typedef void (*GstTracerHookElementQueryPost) (GObject *, GstClockTime,
 200     GstElement *, gboolean);
 201 #define GST_TRACER_ELEMENT_QUERY_POST(element, res) G_STMT_START{ \
 202   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_QUERY_POST), \
 203     GstTracerHookElementQueryPost, (GST_TRACER_ARGS, element, res)); \
 204 }G_STMT_END
 205
 206 #else /* !GST_DISABLE_GST_DEBUG */
 207
 208 #define GST_TRACER_PAD_PUSH_PRE(pad, buffer)
 209 #define GST_TRACER_PAD_PUSH_POST(pad, res)
 210 #define GST_TRACER_PAD_PUSH_LIST_PRE(pad, list)
 211 #define GST_TRACER_PAD_PUSH_LIST_POST(pad, res)
 212 #define GST_TRACER_PAD_PULL_RANGE_PRE(pad, offset, size)
 213 #define GST_TRACER_PAD_PULL_RANGE_POST(pad, buffer, res)
 214 #define GST_TRACER_PAD_PUSH_EVENT_PRE(pad, event)
 215 #define GST_TRACER_PAD_PUSH_EVENT_POST(pad, res)
 216 #define GST_TRACER_PAD_QUERY_PRE(pad, event)
 217 #define GST_TRACER_PAD_QUERY_POST(pad, res)
 218 #define GST_TRACER_ELEMENT_POST_MESSAGE_PRE(element, message)
 219 #define GST_TRACER_ELEMENT_POST_MESSAGE_POST(element, res)
 220 #define GST_TRACER_ELEMENT_QUERY_PRE(element, query)
 221 #define GST_TRACER_ELEMENT_QUERY_POST(element, res)
 222
 223 #endif /* GST_DISABLE_GST_DEBUG */
 224
 225 G_END_DECLS
 226
 227 #endif /* __GST_TRACER_UTILS_H__ */
 228