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 gboolean gst_tracer_register (GstPlugin * plugin, const gchar * name, GType type);
46 /* These enums need to match the number and order
47 * of strings declared in _quark_table, in gsttracerutils.c */
48 typedef enum /*< skip >*/
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_HOOK_ELEMENT_NEW,
65 GST_TRACER_QUARK_HOOK_ELEMENT_ADD_PAD,
66 GST_TRACER_QUARK_HOOK_ELEMENT_REMOVE_PAD,
67 GST_TRACER_QUARK_HOOK_BIN_ADD_PRE,
68 GST_TRACER_QUARK_HOOK_BIN_ADD_POST,
69 GST_TRACER_QUARK_HOOK_BIN_REMOVE_PRE,
70 GST_TRACER_QUARK_HOOK_BIN_REMOVE_POST,
71 GST_TRACER_QUARK_HOOK_PAD_LINK_PRE,
72 GST_TRACER_QUARK_HOOK_PAD_LINK_POST,
73 GST_TRACER_QUARK_HOOK_PAD_UNLINK_PRE,
74 GST_TRACER_QUARK_HOOK_PAD_UNLINK_POST,
78 extern GQuark _priv_gst_tracer_quark_table[GST_TRACER_QUARK_MAX];
80 #define GST_TRACER_QUARK(q) _priv_gst_tracer_quark_table[GST_TRACER_QUARK_##q]
82 /* tracing module helpers */
89 extern gboolean _priv_tracer_enabled;
90 /* key are hook-id quarks, values are GstTracerHook */
91 extern GHashTable *_priv_tracers;
93 #define GST_TRACER_IS_ENABLED (_priv_tracer_enabled)
95 #define GST_TRACER_TS \
96 GST_CLOCK_DIFF (_priv_gst_info_start_time, gst_util_get_timestamp ())
100 #define GST_TRACER_ARGS h->tracer, ts
101 #define GST_TRACER_DISPATCH(key,type,args) G_STMT_START{ \
102 if (GST_TRACER_IS_ENABLED) { \
103 GstClockTime ts = GST_TRACER_TS; \
106 __l = g_hash_table_lookup (_priv_tracers, GINT_TO_POINTER (key)); \
107 for (__n = __l; __n; __n = g_list_next (__n)) { \
108 h = (GstTracerHook *) __n->data; \
109 ((type)(h->func)) args; \
111 __l = g_hash_table_lookup (_priv_tracers, NULL); \
112 for (__n = __l; __n; __n = g_list_next (__n)) { \
113 h = (GstTracerHook *) __n->data; \
114 ((type)(h->func)) args; \
119 typedef void (*GstTracerHookPadPushPre) (GObject *, GstClockTime, GstPad *,
121 #define GST_TRACER_PAD_PUSH_PRE(pad, buffer) G_STMT_START{ \
122 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_PRE), \
123 GstTracerHookPadPushPre, (GST_TRACER_ARGS, pad, buffer)); \
126 typedef void (*GstTracerHookPadPushPost) (GObject *, GstClockTime, GstPad *,
128 #define GST_TRACER_PAD_PUSH_POST(pad, res) G_STMT_START{ \
129 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_POST), \
130 GstTracerHookPadPushPost, (GST_TRACER_ARGS, pad, res)); \
133 typedef void (*GstTracerHookPadPushListPre) (GObject *, GstClockTime, GstPad *,
135 #define GST_TRACER_PAD_PUSH_LIST_PRE(pad, list) G_STMT_START{ \
136 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_LIST_PRE), \
137 GstTracerHookPadPushListPre, (GST_TRACER_ARGS, pad, list)); \
140 typedef void (*GstTracerHookPadPushListPost) (GObject *, GstClockTime, GstPad *,
142 #define GST_TRACER_PAD_PUSH_LIST_POST(pad, res) G_STMT_START{ \
143 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_LIST_POST), \
144 GstTracerHookPadPushListPost, (GST_TRACER_ARGS, pad, res)); \
147 typedef void (*GstTracerHookPadPullRangePre) (GObject *, GstClockTime, GstPad *,
149 #define GST_TRACER_PAD_PULL_RANGE_PRE(pad, offset, size) G_STMT_START{ \
150 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PULL_RANGE_PRE), \
151 GstTracerHookPadPullRangePre, (GST_TRACER_ARGS, pad, offset, size)); \
154 typedef void (*GstTracerHookPadPullRangePost) (GObject *, GstClockTime,
155 GstPad *, GstBuffer *, GstFlowReturn);
156 #define GST_TRACER_PAD_PULL_RANGE_POST(pad, buffer, res) G_STMT_START{ \
157 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PULL_RANGE_POST), \
158 GstTracerHookPadPullRangePost, (GST_TRACER_ARGS, pad, buffer, res)); \
161 typedef void (*GstTracerHookPadPushEventPre) (GObject *, GstClockTime, GstPad *,
163 #define GST_TRACER_PAD_PUSH_EVENT_PRE(pad, event) G_STMT_START{ \
164 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_EVENT_PRE), \
165 GstTracerHookPadPushEventPre, (GST_TRACER_ARGS, pad, event)); \
168 typedef void (*GstTracerHookPadPushEventPost) (GObject *, GstClockTime,
170 #define GST_TRACER_PAD_PUSH_EVENT_POST(pad, res) G_STMT_START{ \
171 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_PUSH_EVENT_POST), \
172 GstTracerHookPadPushEventPost, (GST_TRACER_ARGS, pad, res)); \
175 typedef void (*GstTracerHookPadQueryPre) (GObject *, GstClockTime, GstPad *,
177 #define GST_TRACER_PAD_QUERY_PRE(pad, query) G_STMT_START{ \
178 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_QUERY_PRE), \
179 GstTracerHookPadQueryPre, (GST_TRACER_ARGS, pad, query)); \
182 typedef void (*GstTracerHookPadQueryPost) (GObject *, GstClockTime,
183 GstPad *, gboolean, GstQuery *);
184 #define GST_TRACER_PAD_QUERY_POST(pad, res, query) G_STMT_START{ \
185 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_QUERY_POST), \
186 GstTracerHookPadQueryPost, (GST_TRACER_ARGS, pad, res, query)); \
189 typedef void (*GstTracerHookElementPostMessagePre) (GObject *, GstClockTime,
190 GstElement *, GstMessage *);
191 #define GST_TRACER_ELEMENT_POST_MESSAGE_PRE(element, message) G_STMT_START{ \
192 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_POST_MESSAGE_PRE), \
193 GstTracerHookElementPostMessagePre, (GST_TRACER_ARGS, element, message)); \
196 typedef void (*GstTracerHookElementPostMessagePost) (GObject *, GstClockTime,
197 GstElement *, gboolean);
198 #define GST_TRACER_ELEMENT_POST_MESSAGE_POST(element, res) G_STMT_START{ \
199 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_POST_MESSAGE_POST), \
200 GstTracerHookElementPostMessagePost, (GST_TRACER_ARGS, element, res)); \
203 typedef void (*GstTracerHookElementQueryPre) (GObject *, GstClockTime,
204 GstElement *, GstQuery *);
205 #define GST_TRACER_ELEMENT_QUERY_PRE(element, query) G_STMT_START{ \
206 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_QUERY_PRE), \
207 GstTracerHookElementQueryPre, (GST_TRACER_ARGS, element, query)); \
210 typedef void (*GstTracerHookElementQueryPost) (GObject *, GstClockTime,
211 GstElement *, gboolean);
212 #define GST_TRACER_ELEMENT_QUERY_POST(element, res) G_STMT_START{ \
213 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_QUERY_POST), \
214 GstTracerHookElementQueryPost, (GST_TRACER_ARGS, element, res)); \
217 typedef void (*GstTracerHookElementNew) (GObject *, GstClockTime,
219 #define GST_TRACER_ELEMENT_NEW(element) G_STMT_START{ \
220 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_NEW), \
221 GstTracerHookElementNew, (GST_TRACER_ARGS, element)); \
224 typedef void (*GstTracerHookElementAddPad) (GObject *, GstClockTime,
225 GstElement *, GstPad *);
226 #define GST_TRACER_ELEMENT_ADD_PAD(element, pad) G_STMT_START{ \
227 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_ADD_PAD), \
228 GstTracerHookElementAddPad, (GST_TRACER_ARGS, element, pad)); \
231 typedef void (*GstTracerHookElementRemovePad) (GObject *, GstClockTime,
232 GstElement *, GstPad *);
233 #define GST_TRACER_ELEMENT_REMOVE_PAD(element, pad) G_STMT_START{ \
234 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_ELEMENT_REMOVE_PAD), \
235 GstTracerHookElementRemovePad, (GST_TRACER_ARGS, element, pad)); \
238 typedef void (*GstTracerHookBinAddPre) (GObject *, GstClockTime,
239 GstBin *, GstElement *);
240 #define GST_TRACER_BIN_ADD_PRE(bin, element) G_STMT_START{ \
241 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_BIN_ADD_PRE), \
242 GstTracerHookBinAddPre, (GST_TRACER_ARGS, bin, element)); \
245 typedef void (*GstTracerHookBinAddPost) (GObject *, GstClockTime,
246 GstBin *, GstElement *, gboolean);
247 #define GST_TRACER_BIN_ADD_POST(bin, element, result) G_STMT_START{ \
248 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_BIN_ADD_POST), \
249 GstTracerHookBinAddPost, (GST_TRACER_ARGS, bin, element, result)); \
252 typedef void (*GstTracerHookBinRemovePre) (GObject *, GstClockTime,
253 GstBin *, GstElement *);
254 #define GST_TRACER_BIN_REMOVE_PRE(bin, element) G_STMT_START{ \
255 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_BIN_REMOVE_PRE), \
256 GstTracerHookBinRemovePre, (GST_TRACER_ARGS, bin, element)); \
259 typedef void (*GstTracerHookBinRemovePost) (GObject *, GstClockTime,
261 #define GST_TRACER_BIN_REMOVE_POST(bin, result) G_STMT_START{ \
262 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_BIN_REMOVE_POST), \
263 GstTracerHookBinRemovePost, (GST_TRACER_ARGS, bin, result)); \
266 typedef void (*GstTracerHookPadLinkPre) (GObject *, GstClockTime,
268 #define GST_TRACER_PAD_LINK_PRE(srcpad, sinkpad) G_STMT_START{ \
269 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_LINK_PRE), \
270 GstTracerHookPadLinkPre, (GST_TRACER_ARGS, srcpad, sinkpad)); \
273 typedef void (*GstTracerHookPadLinkPost) (GObject *, GstClockTime,
274 GstPad *, GstPad *, GstPadLinkReturn);
275 #define GST_TRACER_PAD_LINK_POST(srcpad, sinkpad, result) G_STMT_START{ \
276 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_LINK_POST), \
277 GstTracerHookPadLinkPost, (GST_TRACER_ARGS, srcpad, sinkpad, result)); \
280 typedef void (*GstTracerHookPadUnlinkPre) (GObject *, GstClockTime,
282 #define GST_TRACER_PAD_UNLINK_PRE(srcpad, sinkpad) G_STMT_START{ \
283 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_UNLINK_PRE), \
284 GstTracerHookPadUnlinkPre, (GST_TRACER_ARGS, srcpad, sinkpad)); \
287 typedef void (*GstTracerHookPadUnlinkPost) (GObject *, GstClockTime,
288 GstPad *, GstPad *, gboolean);
289 #define GST_TRACER_PAD_UNLINK_POST(srcpad, sinkpad, result) G_STMT_START{ \
290 GST_TRACER_DISPATCH(GST_TRACER_QUARK(HOOK_PAD_UNLINK_POST), \
291 GstTracerHookPadUnlinkPost, (GST_TRACER_ARGS, srcpad, sinkpad, result)); \
294 #else /* !GST_DISABLE_GST_DEBUG */
296 #define GST_TRACER_PAD_PUSH_PRE(pad, buffer)
297 #define GST_TRACER_PAD_PUSH_POST(pad, res)
298 #define GST_TRACER_PAD_PUSH_LIST_PRE(pad, list)
299 #define GST_TRACER_PAD_PUSH_LIST_POST(pad, res)
300 #define GST_TRACER_PAD_PULL_RANGE_PRE(pad, offset, size)
301 #define GST_TRACER_PAD_PULL_RANGE_POST(pad, buffer, res)
302 #define GST_TRACER_PAD_PUSH_EVENT_PRE(pad, event)
303 #define GST_TRACER_PAD_PUSH_EVENT_POST(pad, res)
304 #define GST_TRACER_PAD_QUERY_PRE(pad, query)
305 #define GST_TRACER_PAD_QUERY_POST(pad, res, query)
306 #define GST_TRACER_ELEMENT_POST_MESSAGE_PRE(element, message)
307 #define GST_TRACER_ELEMENT_POST_MESSAGE_POST(element, res)
308 #define GST_TRACER_ELEMENT_QUERY_PRE(element, query)
309 #define GST_TRACER_ELEMENT_QUERY_POST(element, res)
310 #define GST_TRACER_ELEMENT_NEW(element)
311 #define GST_TRACER_ELEMENT_ADD_PAD(element, pad)
312 #define GST_TRACER_ELEMENT_REMOVE_PAD(element, pad)
313 #define GST_TRACER_BIN_ADD_PRE(bin, element)
314 #define GST_TRACER_BIN_ADD_POST(bin, element, res)
315 #define GST_TRACER_BIN_REMOVE_PRE(bin, element)
316 #define GST_TRACER_BIN_REMOVE_POST(bin, res)
317 #define GST_TRACER_PAD_LINK_PRE(srcpad, sinkpad)
318 #define GST_TRACER_PAD_LINK_POST(srcpad, sinkpad, res)
319 #define GST_TRACER_PAD_UNLINK_PRE(srcpad, sinkpad)
320 #define GST_TRACER_PAD_UNLINK_POST(srcpad, sinkpad, res)
322 #endif /* GST_DISABLE_GST_DEBUG */
326 #endif /* __GST_TRACER_UTILS_H__ */