2 * Copyright (C) 2013 Stefan Sauer <ensonic@users.sf.net>
4 * gsttracerutils.h: tracing subsystem
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.
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.
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.
23 #ifndef __GST_TRACER_UTILS_H__
24 #define __GST_TRACER_UTILS_H__
27 #include <glib-object.h>
28 #include <gst/gstconfig.h>
29 #include <gst/gstbin.h>
33 #ifndef GST_DISABLE_GST_DEBUG
37 void _priv_gst_tracing_init (void);
38 void _priv_gst_tracing_deinit (void);
42 /* These enums need to match the number and order
43 * of strings declared in _quark_table, in gsttracerutils.c */
44 typedef enum /*< skip >*/
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,
74 extern GQuark _priv_gst_tracer_quark_table[GST_TRACER_QUARK_MAX];
76 #define GST_TRACER_QUARK(q) _priv_gst_tracer_quark_table[GST_TRACER_QUARK_##q]
78 /* tracing module helpers */
85 extern gboolean _priv_tracer_enabled;
86 /* key are hook-id quarks, values are GstTracerHook */
87 extern GHashTable *_priv_tracers;
89 #define GST_TRACER_IS_ENABLED (_priv_tracer_enabled)
91 #define GST_TRACER_TS \
92 GST_CLOCK_DIFF (_priv_gst_info_start_time, gst_util_get_timestamp ())
96 #define GST_TRACER_ARGS h->tracer, ts
97 #define GST_TRACER_DISPATCH(key,type,args) G_STMT_START{ \
98 if (GST_TRACER_IS_ENABLED) { \
99 GstClockTime ts = GST_TRACER_TS; \
102 __l = g_hash_table_lookup (_priv_tracers, GINT_TO_POINTER (key)); \
103 for (__n = __l; __n; __n = g_list_next (__n)) { \
104 h = (GstTracerHook *) __n->data; \
105 ((type)(h->func)) args; \
107 __l = g_hash_table_lookup (_priv_tracers, NULL); \
108 for (__n = __l; __n; __n = g_list_next (__n)) { \
109 h = (GstTracerHook *) __n->data; \
110 ((type)(h->func)) args; \
115 typedef void (*GstTracerHookPadPushPre) (GObject *, GstClockTime, GstPad *,
117 #define GST_TRACER_PAD_PUSH_PRE(pad, buffer) G_STMT_START{ \
118 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_PRE), \
119 GstTracerHookPadPushPre, (GST_TRACER_ARGS, pad, buffer)); \
122 typedef void (*GstTracerHookPadPushPost) (GObject *, GstClockTime, GstPad *,
124 #define GST_TRACER_PAD_PUSH_POST(pad, res) G_STMT_START{ \
125 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_POST), \
126 GstTracerHookPadPushPost, (GST_TRACER_ARGS, pad, res)); \
129 typedef void (*GstTracerHookPadPushListPre) (GObject *, GstClockTime, GstPad *,
131 #define GST_TRACER_PAD_PUSH_LIST_PRE(pad, list) G_STMT_START{ \
132 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_LIST_PRE), \
133 GstTracerHookPadPushListPre, (GST_TRACER_ARGS, pad, list)); \
136 typedef void (*GstTracerHookPadPushListPost) (GObject *, GstClockTime, GstPad *,
138 #define GST_TRACER_PAD_PUSH_LIST_POST(pad, res) G_STMT_START{ \
139 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_LIST_POST), \
140 GstTracerHookPadPushListPost, (GST_TRACER_ARGS, pad, res)); \
143 typedef void (*GstTracerHookPadPullRangePre) (GObject *, GstClockTime, GstPad *,
145 #define GST_TRACER_PAD_PULL_RANGE_PRE(pad, offset, size) G_STMT_START{ \
146 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PULL_RANGE_PRE), \
147 GstTracerHookPadPullRangePre, (GST_TRACER_ARGS, pad, offset, size)); \
150 typedef void (*GstTracerHookPadPullRangePost) (GObject *, GstClockTime,
151 GstPad *, GstBuffer *, GstFlowReturn);
152 #define GST_TRACER_PAD_PULL_RANGE_POST(pad, buffer, res) G_STMT_START{ \
153 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PULL_RANGE_POST), \
154 GstTracerHookPadPullRangePost, (GST_TRACER_ARGS, pad, buffer, res)); \
157 typedef void (*GstTracerHookPadPushEventPre) (GObject *, GstClockTime, GstPad *,
159 #define GST_TRACER_PAD_PUSH_EVENT_PRE(pad, event) G_STMT_START{ \
160 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_EVENT_PRE), \
161 GstTracerHookPadPushEventPre, (GST_TRACER_ARGS, pad, event)); \
164 typedef void (*GstTracerHookPadPushEventPost) (GObject *, GstClockTime,
166 #define GST_TRACER_PAD_PUSH_EVENT_POST(pad, res) G_STMT_START{ \
167 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_EVENT_POST), \
168 GstTracerHookPadPushEventPost, (GST_TRACER_ARGS, pad, res)); \
171 typedef void (*GstTracerHookPadQueryPre) (GObject *, GstClockTime, GstPad *,
173 #define GST_TRACER_PAD_QUERY_PRE(pad, query) G_STMT_START{ \
174 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_QUERY_PRE), \
175 GstTracerHookPadQueryPre, (GST_TRACER_ARGS, pad, query)); \
178 typedef void (*GstTracerHookPadQueryPost) (GObject *, GstClockTime,
179 GstPad *, gboolean, GstQuery *);
180 #define GST_TRACER_PAD_QUERY_POST(pad, res, query) G_STMT_START{ \
181 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_QUERY_POST), \
182 GstTracerHookPadQueryPost, (GST_TRACER_ARGS, pad, res, query)); \
185 typedef void (*GstTracerHookElementPostMessagePre) (GObject *, GstClockTime,
186 GstElement *, GstMessage *);
187 #define GST_TRACER_ELEMENT_POST_MESSAGE_PRE(element, message) G_STMT_START{ \
188 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_POST_MESSAGE_PRE), \
189 GstTracerHookElementPostMessagePre, (GST_TRACER_ARGS, element, message)); \
192 typedef void (*GstTracerHookElementPostMessagePost) (GObject *, GstClockTime,
193 GstElement *, gboolean);
194 #define GST_TRACER_ELEMENT_POST_MESSAGE_POST(element, res) G_STMT_START{ \
195 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_POST_MESSAGE_POST), \
196 GstTracerHookElementPostMessagePost, (GST_TRACER_ARGS, element, res)); \
199 typedef void (*GstTracerHookElementQueryPre) (GObject *, GstClockTime,
200 GstElement *, GstQuery *);
201 #define GST_TRACER_ELEMENT_QUERY_PRE(element, query) G_STMT_START{ \
202 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_QUERY_PRE), \
203 GstTracerHookElementQueryPre, (GST_TRACER_ARGS, element, query)); \
206 typedef void (*GstTracerHookElementQueryPost) (GObject *, GstClockTime,
207 GstElement *, gboolean);
208 #define GST_TRACER_ELEMENT_QUERY_POST(element, res) G_STMT_START{ \
209 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_QUERY_POST), \
210 GstTracerHookElementQueryPost, (GST_TRACER_ARGS, element, res)); \
213 typedef void (*GstTracerHookElementNew) (GObject *, GstClockTime,
215 #define GST_TRACER_ELEMENT_NEW(element) G_STMT_START{ \
216 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_NEW), \
217 GstTracerHookElementNew, (GST_TRACER_ARGS, element)); \
220 typedef void (*GstTracerHookElementAddPad) (GObject *, GstClockTime,
221 GstElement *, GstPad *);
222 #define GST_TRACER_ELEMENT_ADD_PAD(element, pad) G_STMT_START{ \
223 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_ADD_PAD), \
224 GstTracerHookElementAddPad, (GST_TRACER_ARGS, element, pad)); \
227 typedef void (*GstTracerHookElementRemovePad) (GObject *, GstClockTime,
228 GstElement *, GstPad *);
229 #define GST_TRACER_ELEMENT_REMOVE_PAD(element, pad) G_STMT_START{ \
230 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_REMOVE_PAD), \
231 GstTracerHookElementRemovePad, (GST_TRACER_ARGS, element, pad)); \
234 typedef void (*GstTracerHookBinAddPre) (GObject *, GstClockTime,
235 GstBin *, GstElement *);
236 #define GST_TRACER_BIN_ADD_PRE(bin, element) G_STMT_START{ \
237 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_BIN_ADD_PRE), \
238 GstTracerHookBinAddPre, (GST_TRACER_ARGS, bin, element)); \
241 typedef void (*GstTracerHookBinAddPost) (GObject *, GstClockTime,
242 GstBin *, GstElement *, gboolean);
243 #define GST_TRACER_BIN_ADD_POST(bin, element, result) G_STMT_START{ \
244 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_BIN_ADD_POST), \
245 GstTracerHookBinAddPost, (GST_TRACER_ARGS, bin, element, result)); \
248 typedef void (*GstTracerHookBinRemovePre) (GObject *, GstClockTime,
249 GstBin *, GstElement *);
250 #define GST_TRACER_BIN_REMOVE_PRE(bin, element) G_STMT_START{ \
251 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_BIN_REMOVE_PRE), \
252 GstTracerHookBinRemovePre, (GST_TRACER_ARGS, bin, element)); \
255 typedef void (*GstTracerHookBinRemovePost) (GObject *, GstClockTime,
257 #define GST_TRACER_BIN_REMOVE_POST(bin, result) G_STMT_START{ \
258 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_BIN_REMOVE_POST), \
259 GstTracerHookBinRemovePost, (GST_TRACER_ARGS, bin, result)); \
262 typedef void (*GstTracerHookPadLinkPre) (GObject *, GstClockTime,
264 #define GST_TRACER_PAD_LINK_PRE(srcpad, sinkpad) G_STMT_START{ \
265 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_LINK_PRE), \
266 GstTracerHookPadLinkPre, (GST_TRACER_ARGS, srcpad, sinkpad)); \
269 typedef void (*GstTracerHookPadLinkPost) (GObject *, GstClockTime,
270 GstPad *, GstPad *, GstPadLinkReturn);
271 #define GST_TRACER_PAD_LINK_POST(srcpad, sinkpad, result) G_STMT_START{ \
272 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_LINK_POST), \
273 GstTracerHookPadLinkPost, (GST_TRACER_ARGS, srcpad, sinkpad, result)); \
276 typedef void (*GstTracerHookPadUnlinkPre) (GObject *, GstClockTime,
278 #define GST_TRACER_PAD_UNLINK_PRE(srcpad, sinkpad) G_STMT_START{ \
279 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_UNLINK_PRE), \
280 GstTracerHookPadUnlinkPre, (GST_TRACER_ARGS, srcpad, sinkpad)); \
283 typedef void (*GstTracerHookPadUnlinkPost) (GObject *, GstClockTime,
284 GstPad *, GstPad *, gboolean);
285 #define GST_TRACER_PAD_UNLINK_POST(srcpad, sinkpad, result) G_STMT_START{ \
286 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_UNLINK_POST), \
287 GstTracerHookPadUnlinkPost, (GST_TRACER_ARGS, srcpad, sinkpad, result)); \
290 #else /* !GST_DISABLE_GST_DEBUG */
292 #define GST_TRACER_PAD_PUSH_PRE(pad, buffer)
293 #define GST_TRACER_PAD_PUSH_POST(pad, res)
294 #define GST_TRACER_PAD_PUSH_LIST_PRE(pad, list)
295 #define GST_TRACER_PAD_PUSH_LIST_POST(pad, res)
296 #define GST_TRACER_PAD_PULL_RANGE_PRE(pad, offset, size)
297 #define GST_TRACER_PAD_PULL_RANGE_POST(pad, buffer, res)
298 #define GST_TRACER_PAD_PUSH_EVENT_PRE(pad, event)
299 #define GST_TRACER_PAD_PUSH_EVENT_POST(pad, res)
300 #define GST_TRACER_PAD_QUERY_PRE(pad, query)
301 #define GST_TRACER_PAD_QUERY_POST(pad, res, query)
302 #define GST_TRACER_ELEMENT_POST_MESSAGE_PRE(element, message)
303 #define GST_TRACER_ELEMENT_POST_MESSAGE_POST(element, res)
304 #define GST_TRACER_ELEMENT_QUERY_PRE(element, query)
305 #define GST_TRACER_ELEMENT_QUERY_POST(element, res)
306 #define GST_TRACER_ELEMENT_NEW(element)
307 #define GST_TRACER_ELEMENT_ADD_PAD(element, pad)
308 #define GST_TRACER_ELEMENT_REMOVE_PAD(element, pad)
309 #define GST_TRACER_BIN_ADD_PRE(bin, element)
310 #define GST_TRACER_BIN_ADD_POST(bin, element, res)
311 #define GST_TRACER_BIN_REMOVE_PRE(bin, element)
312 #define GST_TRACER_BIN_REMOVE_POST(bin, res)
313 #define GST_TRACER_PAD_LINK_PRE(srcpad, sinkpad)
314 #define GST_TRACER_PAD_LINK_POST(srcpad, sinkpad, res)
315 #define GST_TRACER_PAD_UNLINK_PRE(srcpad, sinkpad)
316 #define GST_TRACER_PAD_UNLINK_POST(srcpad, sinkpad, res)
318 #endif /* GST_DISABLE_GST_DEBUG */
322 #endif /* __GST_TRACER_UTILS_H__ */