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_ELEMENT_POST_MESSAGE_PRE,
  59   GST_TRACER_QUARK_HOOK_ELEMENT_POST_MESSAGE_POST,
  60   GST_TRACER_QUARK_HOOK_ELEMENT_QUERY_PRE,
  61   GST_TRACER_QUARK_HOOK_ELEMENT_QUERY_POST,
  62   GST_TRACER_QUARK_MAX
  63 } GstTracerQuarkId;
  64
  65 extern GQuark _priv_gst_tracer_quark_table[GST_TRACER_QUARK_MAX];
  66
  67 #define GST_TRACER_QUARK(q) _priv_gst_tracer_quark_table[GST_TRACER_QUARK_##q]
  68
  69 /* tracing module helpers */
  70
  71 typedef struct {
  72   GObject *tracer;
  73   GCallback func;
  74 } GstTracerHook;
  75
  76 extern gboolean _priv_tracer_enabled;
  77 /* key are hook-id quarks, values are GstTracerHook */
  78 extern GHashTable *_priv_tracers;
  79
  80 #define GST_TRACER_IS_ENABLED (_priv_tracer_enabled)
  81
  82 #define GST_TRACER_TS \
  83   GST_CLOCK_DIFF (_priv_gst_info_start_time, gst_util_get_timestamp ())
  84
  85 /* tracing hooks */
  86
  87 #define GST_TRACER_ARGS h->tracer, ts
  88 #define GST_TRACER_DISPATCH(key,type,args) G_STMT_START{ \
  89   if (GST_TRACER_IS_ENABLED) {                                         \
  90     GstClockTime ts = GST_TRACER_TS;                                   \
  91     GList *__l, *__n;                                                  \
  92     GstTracerHook *h;                                                  \
  93     __l = g_hash_table_lookup (_priv_tracers, GINT_TO_POINTER (key));  \
  94     for (__n = __l; __n; __n = g_list_next (__n)) {                    \
  95       h = (GstTracerHook *) __n->data;                                 \
  96       ((type)(h->func)) args;                                          \
  97     }                                                                  \
  98     __l = g_hash_table_lookup (_priv_tracers, NULL);                   \
  99     for (__n = __l; __n; __n = g_list_next (__n)) {                    \
 100       h = (GstTracerHook *) __n->data;                                 \
 101       ((type)(h->func)) args;                                          \
 102     }                                                                  \
 103   }                                                                    \
 104 }G_STMT_END
 105
 106 typedef void (*GstTracerHookPadPushPre) (GObject *, GstClockTime, GstPad *,
 107     GstBuffer *);
 108 #define GST_TRACER_PAD_PUSH_PRE(pad, buffer) G_STMT_START{ \
 109   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_PRE), \
 110     GstTracerHookPadPushPre, (GST_TRACER_ARGS, pad, buffer)); \
 111 }G_STMT_END
 112
 113 typedef void (*GstTracerHookPadPushPost) (GObject *, GstClockTime, GstPad *,
 114     GstFlowReturn);
 115 #define GST_TRACER_PAD_PUSH_POST(pad, res) G_STMT_START{ \
 116   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_POST), \
 117     GstTracerHookPadPushPost, (GST_TRACER_ARGS, pad, res)); \
 118 }G_STMT_END
 119
 120 typedef void (*GstTracerHookPadPushListPre) (GObject *, GstClockTime, GstPad *,
 121     GstBufferList *);
 122 #define GST_TRACER_PAD_PUSH_LIST_PRE(pad, list) G_STMT_START{ \
 123   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_LIST_PRE), \
 124     GstTracerHookPadPushListPre, (GST_TRACER_ARGS, pad, list)); \
 125 }G_STMT_END
 126
 127 typedef void (*GstTracerHookPadPushListPost) (GObject *, GstClockTime, GstPad *,
 128     GstFlowReturn);
 129 #define GST_TRACER_PAD_PUSH_LIST_POST(pad, res) G_STMT_START{ \
 130   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_LIST_POST), \
 131     GstTracerHookPadPushListPost, (GST_TRACER_ARGS, pad, res)); \
 132 }G_STMT_END
 133
 134 typedef void (*GstTracerHookPadPullRangePre) (GObject *, GstClockTime, GstPad *,
 135     guint64, guint);
 136 #define GST_TRACER_PAD_PULL_RANGE_PRE(pad, offset, size) G_STMT_START{ \
 137   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PULL_RANGE_PRE), \
 138     GstTracerHookPadPullRangePre, (GST_TRACER_ARGS, pad, offset, size)); \
 139 }G_STMT_END
 140
 141 typedef void (*GstTracerHookPadPullRangePost) (GObject *, GstClockTime,
 142     GstPad *, GstBuffer *, GstFlowReturn);
 143 #define GST_TRACER_PAD_PULL_RANGE_POST(pad, buffer, res) G_STMT_START{ \
 144   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PULL_RANGE_POST), \
 145     GstTracerHookPadPullRangePost, (GST_TRACER_ARGS, pad, buffer, res)); \
 146 }G_STMT_END
 147
 148 typedef void (*GstTracerHookPadPushEventPre) (GObject *, GstClockTime, GstPad *,
 149     GstEvent *);
 150 #define GST_TRACER_PAD_PUSH_EVENT_PRE(pad, event) G_STMT_START{ \
 151   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_EVENT_PRE), \
 152     GstTracerHookPadPushEventPre, (GST_TRACER_ARGS, pad, event)); \
 153 }G_STMT_END
 154
 155 typedef void (*GstTracerHookPadPushEventPost) (GObject *, GstClockTime,
 156     GstPad *, gboolean);
 157 #define GST_TRACER_PAD_PUSH_EVENT_POST(pad, res) G_STMT_START{ \
 158   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_EVENT_POST), \
 159     GstTracerHookPadPushEventPost, (GST_TRACER_ARGS, pad, res)); \
 160 }G_STMT_END
 161
 162 typedef void (*GstTracerHookElementPostMessagePre) (GObject *, GstClockTime,
 163     GstElement *, GstMessage *);
 164 #define GST_TRACER_ELEMENT_POST_MESSAGE_PRE(element, message) G_STMT_START{ \
 165   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_POST_MESSAGE_PRE), \
 166     GstTracerHookElementPostMessagePre, (GST_TRACER_ARGS, element, message)); \
 167 }G_STMT_END
 168
 169 typedef void (*GstTracerHookElementPostMessagePost) (GObject *, GstClockTime,
 170     GstElement *, gboolean);
 171 #define GST_TRACER_ELEMENT_POST_MESSAGE_POST(element, res) G_STMT_START{ \
 172   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_POST_MESSAGE_POST), \
 173     GstTracerHookElementPostMessagePost, (GST_TRACER_ARGS, element, res)); \
 174 }G_STMT_END
 175
 176 typedef void (*GstTracerHookElementQueryPre) (GObject *, GstClockTime,
 177     GstElement *, GstQuery *);
 178 #define GST_TRACER_ELEMENT_QUERY_PRE(element, query) G_STMT_START{ \
 179   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_QUERY_PRE), \
 180     GstTracerHookElementQueryPre, (GST_TRACER_ARGS, element, query)); \
 181 }G_STMT_END
 182
 183 typedef void (*GstTracerHookElementQueryPost) (GObject *, GstClockTime,
 184     GstElement *, gboolean);
 185 #define GST_TRACER_ELEMENT_QUERY_POST(element, res) G_STMT_START{ \
 186   GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_QUERY_POST), \
 187     GstTracerHookElementQueryPost, (GST_TRACER_ARGS, element, res)); \
 188 }G_STMT_END
 189
 190 #else /* !GST_DISABLE_GST_DEBUG */
 191
 192 #define GST_TRACER_PAD_PUSH_PRE(pad, buffer)
 193 #define GST_TRACER_PAD_PUSH_POST(pad, res)
 194 #define GST_TRACER_PAD_PUSH_LIST_PRE(pad, list)
 195 #define GST_TRACER_PAD_PUSH_LIST_POST(pad, res)
 196 #define GST_TRACER_PAD_PULL_RANGE_PRE(pad, offset, size)
 197 #define GST_TRACER_PAD_PULL_RANGE_POST(pad, buffer, res)
 198 #define GST_TRACER_PAD_PUSH_EVENT_PRE(pad, event)
 199 #define GST_TRACER_PAD_PUSH_EVENT_POST(pad, res)
 200 #define GST_TRACER_ELEMENT_POST_MESSAGE_PRE(element, message)
 201 #define GST_TRACER_ELEMENT_POST_MESSAGE_POST(element, res)
 202 #define GST_TRACER_ELEMENT_QUERY_PRE(element, query)
 203 #define GST_TRACER_ELEMENT_QUERY_POST(element, res)
 204
 205 #endif /* GST_DISABLE_GST_DEBUG */
 206
 207 G_END_DECLS
 208
 209 #endif /* __GST_TRACER_UTILS_H__ */
 210