2 * Copyright (C) 2013 Stefan Sauer <ensonic@users.sf.net>
4 * gsttracer.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.
22 #ifndef __GST_TRACER_H__
23 #define __GST_TRACER_H__
26 #include <glib-object.h>
27 #include <gst/gstconfig.h>
28 #include <gst/gstbin.h>
32 #ifndef GST_DISABLE_GST_DEBUG
34 /* hook flags and ids */
38 GST_TRACER_HOOK_NONE = 0,
39 GST_TRACER_HOOK_BUFFERS = (1 << 0),
40 GST_TRACER_HOOK_EVENTS = (1 << 1),
41 GST_TRACER_HOOK_MESSAGES = (1 << 2),
42 GST_TRACER_HOOK_QUERIES = (1 << 3),
43 GST_TRACER_HOOK_TOPOLOGY = (1 << 4),
47 GST_TRACER_HOOK_ALL = (1 << 5) - 1
52 GST_TRACER_HOOK_ID_BUFFERS = 0,
53 GST_TRACER_HOOK_ID_EVENTS,
54 GST_TRACER_HOOK_ID_MESSAGES,
55 GST_TRACER_HOOK_ID_QUERIES,
56 GST_TRACER_HOOK_ID_TOPLOGY,
58 GST_TRACER_HOOK_ID_TIMER
60 GST_TRACER_HOOK_ID_LAST
65 GST_TRACER_MESSAGE_ID_PAD_PUSH_PRE = 0,
66 GST_TRACER_MESSAGE_ID_PAD_PUSH_POST,
67 GST_TRACER_MESSAGE_ID_PAD_PUSH_LIST_PRE,
68 GST_TRACER_MESSAGE_ID_PAD_PUSH_LIST_POST,
69 GST_TRACER_MESSAGE_ID_PAD_PULL_RANGE_PRE,
70 GST_TRACER_MESSAGE_ID_PAD_PULL_RANGE_POST,
71 GST_TRACER_MESSAGE_ID_PAD_PUSH_EVENT_PRE,
72 GST_TRACER_MESSAGE_ID_PAD_PUSH_EVENT_POST,
73 GST_TRACER_MESSAGE_ID_ELEMENT_POST_MESSAGE_PRE,
74 GST_TRACER_MESSAGE_ID_ELEMENT_POST_MESSAGE_POST,
75 GST_TRACER_MESSAGE_ID_ELEMENT_QUERY_PRE,
76 GST_TRACER_MESSAGE_ID_ELEMENT_QUERY_POST,
77 GST_TRACER_MESSAGE_ID_LAST
82 typedef struct _GstTracer GstTracer;
83 typedef struct _GstTracerPrivate GstTracerPrivate;
84 typedef struct _GstTracerClass GstTracerClass;
86 #define GST_TYPE_TRACER (gst_tracer_get_type())
87 #define GST_TRACER(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_TRACER,GstTracer))
88 #define GST_TRACER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_TRACER,GstTracerClass))
89 #define GST_IS_TRACER(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_TRACER))
90 #define GST_IS_TRACER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_TRACER))
91 #define GST_TRACER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),GST_TYPE_TRACER,GstTracerClass))
92 #define GST_TRACER_CAST(obj) ((GstTracer *)(obj))
97 GstTracerPrivate *priv;
98 gpointer _gst_reserved[GST_PADDING];
101 typedef void (*GstTracerInvokeFunction) (GstTracer * self, GstTracerHookId hid,
102 GstTracerMessageId mid, va_list var_args);
104 struct _GstTracerClass {
105 GstObjectClass parent_class;
107 /* plugin vmethods */
108 GstTracerInvokeFunction invoke;
111 gpointer _gst_reserved[GST_PADDING];
114 GType gst_tracer_get_type (void);
118 void _priv_gst_tracer_init (void);
119 void _priv_gst_tracer_deinit (void);
121 /* tracing modules */
123 gboolean gst_tracer_register (GstPlugin * plugin, const gchar * name, GType type);
125 /* tracing helpers */
127 void gst_tracer_dispatch (GstTracerHookId hid, GstTracerMessageId mid, ...);
129 /* tracing module helpers */
131 void gst_tracer_log_trace (GstStructure * s);
133 extern gboolean _priv_tracer_enabled;
134 extern GList *_priv_tracers[GST_TRACER_HOOK_ID_LAST];
136 extern GstClockTime _priv_gst_info_start_time;
137 #define GST_TRACER_IS_ENABLED(id) \
138 (_priv_tracer_enabled && (_priv_tracers[id] != NULL))
140 #define GST_TRACER_TS \
141 GST_CLOCK_DIFF (_priv_gst_info_start_time, gst_util_get_timestamp ())
145 #define GST_TRACER_PAD_PUSH_PRE(pad, buffer) G_STMT_START{ \
146 if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_BUFFERS)) { \
147 gst_tracer_dispatch (GST_TRACER_HOOK_ID_BUFFERS, \
148 GST_TRACER_MESSAGE_ID_PAD_PUSH_PRE, GST_TRACER_TS, \
153 #define GST_TRACER_PAD_PUSH_POST(pad, res) G_STMT_START{ \
154 if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_BUFFERS)) { \
155 gst_tracer_dispatch (GST_TRACER_HOOK_ID_BUFFERS, \
156 GST_TRACER_MESSAGE_ID_PAD_PUSH_POST, GST_TRACER_TS, \
161 #define GST_TRACER_PAD_PUSH_LIST_PRE(pad, list) G_STMT_START{ \
162 if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_BUFFERS)) { \
163 gst_tracer_dispatch (GST_TRACER_HOOK_ID_BUFFERS, \
164 GST_TRACER_MESSAGE_ID_PAD_PUSH_LIST_PRE, GST_TRACER_TS, \
169 #define GST_TRACER_PAD_PUSH_LIST_POST(pad, res) G_STMT_START{ \
170 if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_BUFFERS)) { \
171 gst_tracer_dispatch (GST_TRACER_HOOK_ID_BUFFERS, \
172 GST_TRACER_MESSAGE_ID_PAD_PUSH_LIST_POST, GST_TRACER_TS, \
177 #define GST_TRACER_PAD_PULL_RANGE_PRE(pad, offset, size) G_STMT_START{ \
178 if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_BUFFERS)) { \
179 gst_tracer_dispatch (GST_TRACER_HOOK_ID_BUFFERS, \
180 GST_TRACER_MESSAGE_ID_PAD_PULL_RANGE_PRE, GST_TRACER_TS, \
181 pad, offset, size); \
185 #define GST_TRACER_PAD_PULL_RANGE_POST(pad, buffer, res) G_STMT_START{ \
186 if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_BUFFERS)) { \
187 gst_tracer_dispatch (GST_TRACER_HOOK_ID_BUFFERS, \
188 GST_TRACER_MESSAGE_ID_PAD_PULL_RANGE_POST, GST_TRACER_TS, \
193 #define GST_TRACER_PAD_PUSH_EVENT_PRE(pad, event) G_STMT_START{ \
194 if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_EVENTS)) { \
195 gst_tracer_dispatch (GST_TRACER_HOOK_ID_EVENTS, \
196 GST_TRACER_MESSAGE_ID_PAD_PUSH_EVENT_PRE, GST_TRACER_TS, \
201 #define GST_TRACER_PAD_PUSH_EVENT_POST(pad, res) G_STMT_START{ \
202 if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_EVENTS)) { \
203 gst_tracer_dispatch (GST_TRACER_HOOK_ID_EVENTS, \
204 GST_TRACER_MESSAGE_ID_PAD_PUSH_EVENT_POST, GST_TRACER_TS, \
209 #define GST_TRACER_ELEMENT_POST_MESSAGE_PRE(element, message) G_STMT_START{ \
210 if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_MESSAGES)) { \
211 gst_tracer_dispatch (GST_TRACER_HOOK_ID_MESSAGES, \
212 GST_TRACER_MESSAGE_ID_ELEMENT_POST_MESSAGE_PRE, GST_TRACER_TS, \
217 #define GST_TRACER_ELEMENT_POST_MESSAGE_POST(element, res) G_STMT_START{ \
218 if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_MESSAGES)) { \
219 gst_tracer_dispatch (GST_TRACER_HOOK_ID_MESSAGES, \
220 GST_TRACER_MESSAGE_ID_ELEMENT_POST_MESSAGE_POST, GST_TRACER_TS, \
225 #define GST_TRACER_ELEMENT_QUERY_PRE(element, query) G_STMT_START{ \
226 if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_QUERIES)) { \
227 gst_tracer_dispatch (GST_TRACER_HOOK_ID_QUERIES, \
228 GST_TRACER_MESSAGE_ID_ELEMENT_QUERY_PRE, GST_TRACER_TS, \
233 #define GST_TRACER_ELEMENT_QUERY_POST(element, res) G_STMT_START{ \
234 if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_QUERIES)) { \
235 gst_tracer_dispatch (GST_TRACER_HOOK_ID_QUERIES, \
236 GST_TRACER_MESSAGE_ID_ELEMENT_QUERY_POST, GST_TRACER_TS, \
241 #else /* !GST_DISABLE_GST_DEBUG */
243 #define GST_TRACER_PAD_PUSH_PRE(pad, buffer)
244 #define GST_TRACER_PAD_PUSH_POST(pad, res)
245 #define GST_TRACER_PAD_PUSH_LIST_PRE(pad, list)
246 #define GST_TRACER_PAD_PUSH_LIST_POST(pad, res)
247 #define GST_TRACER_PAD_PULL_RANGE_PRE(pad, offset, size)
248 #define GST_TRACER_PAD_PULL_RANGE_POST(pad, buffer, res)
249 #define GST_TRACER_PAD_PUSH_EVENT_PRE(pad, event)
250 #define GST_TRACER_PAD_PUSH_EVENT_POST(pad, res)
251 #define GST_TRACER_ELEMENT_POST_MESSAGE_PRE(element, message)
252 #define GST_TRACER_ELEMENT_POST_MESSAGE_POST(element, res)
253 #define GST_TRACER_ELEMENT_QUERY_PRE(element, query)
254 #define GST_TRACER_ELEMENT_QUERY_POST(element, res)
256 #endif /* GST_DISABLE_GST_DEBUG */
260 #endif /* __GST_TRACER_H__ */