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 /* tracer hook message ids */
  36
  37 typedef enum
  38 {
  39   GST_TRACER_HOOK_ID_PAD_PUSH_PRE = 0,
  40   GST_TRACER_HOOK_ID_PAD_PUSH_POST,
  41   GST_TRACER_HOOK_ID_PAD_PUSH_LIST_PRE,
  42   GST_TRACER_HOOK_ID_PAD_PUSH_LIST_POST,
  43   GST_TRACER_HOOK_ID_PAD_PULL_RANGE_PRE,
  44   GST_TRACER_HOOK_ID_PAD_PULL_RANGE_POST,
  45   GST_TRACER_HOOK_ID_PAD_PUSH_EVENT_PRE,
  46   GST_TRACER_HOOK_ID_PAD_PUSH_EVENT_POST,
  47   GST_TRACER_HOOK_ID_ELEMENT_POST_MESSAGE_PRE,
  48   GST_TRACER_HOOK_ID_ELEMENT_POST_MESSAGE_POST,
  49   GST_TRACER_HOOK_ID_ELEMENT_QUERY_PRE,
  50   GST_TRACER_HOOK_ID_ELEMENT_QUERY_POST,
  51   GST_TRACER_HOOK_ID_LAST
  52 } GstTracerHookId;
  53
  54 /* tracing hooks */
  55
  56 void _priv_gst_tracer_init (void);
  57 void _priv_gst_tracer_deinit (void);
  58
  59 /* tracing modules */
  60
  61 gboolean gst_tracer_register (GstPlugin * plugin, const gchar * name, GType type);
  62
  63 /* tracing helpers */
  64
  65 void gst_tracer_dispatch (GstTracerHookId id, ...);
  66
  67 /* tracing module helpers */
  68
  69 void gst_tracer_log_trace (GstStructure * s);
  70
  71 extern gboolean _priv_tracer_enabled;
  72 extern GList *_priv_tracers[GST_TRACER_HOOK_ID_LAST];
  73
  74 #define GST_TRACER_IS_ENABLED(id) \
  75   (_priv_tracer_enabled && (_priv_tracers[id] != NULL))
  76
  77 #define GST_TRACER_TS \
  78   GST_CLOCK_DIFF (_priv_gst_info_start_time, gst_util_get_timestamp ())
  79
  80 /* tracing hooks */
  81
  82 #define GST_TRACER_PAD_PUSH_PRE(pad, buffer) G_STMT_START{ \
  83   if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_PAD_PUSH_PRE)) { \
  84     gst_tracer_dispatch (GST_TRACER_HOOK_ID_PAD_PUSH_PRE, \
  85         GST_TRACER_TS, \
  86         pad, buffer); \
  87   } \
  88 }G_STMT_END
  89
  90 #define GST_TRACER_PAD_PUSH_POST(pad, res) G_STMT_START{ \
  91   if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_PAD_PUSH_POST)) { \
  92     gst_tracer_dispatch (GST_TRACER_HOOK_ID_PAD_PUSH_POST, \
  93         GST_TRACER_TS, \
  94         pad, res); \
  95   } \
  96 }G_STMT_END
  97
  98 #define GST_TRACER_PAD_PUSH_LIST_PRE(pad, list) G_STMT_START{ \
  99   if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_PAD_PUSH_LIST_PRE)) { \
 100     gst_tracer_dispatch (GST_TRACER_HOOK_ID_PAD_PUSH_LIST_PRE, \
 101         GST_TRACER_TS, \
 102         pad, list); \
 103   } \
 104 }G_STMT_END
 105
 106 #define GST_TRACER_PAD_PUSH_LIST_POST(pad, res) G_STMT_START{ \
 107   if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_PAD_PUSH_LIST_POST)) { \
 108     gst_tracer_dispatch (GST_TRACER_HOOK_ID_PAD_PUSH_LIST_POST, \
 109         GST_TRACER_TS, \
 110         pad, res); \
 111   } \
 112 }G_STMT_END
 113
 114 #define GST_TRACER_PAD_PULL_RANGE_PRE(pad, offset, size) G_STMT_START{ \
 115   if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_PAD_PULL_RANGE_PRE)) { \
 116     gst_tracer_dispatch (GST_TRACER_HOOK_ID_PAD_PULL_RANGE_PRE, \
 117         GST_TRACER_TS, \
 118         pad, offset, size); \
 119   } \
 120 }G_STMT_END
 121
 122 #define GST_TRACER_PAD_PULL_RANGE_POST(pad, buffer, res) G_STMT_START{ \
 123   if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_PAD_PULL_RANGE_POST)) { \
 124     gst_tracer_dispatch (GST_TRACER_HOOK_ID_PAD_PULL_RANGE_POST, \
 125         GST_TRACER_TS, \
 126         pad, buffer, res); \
 127   } \
 128 }G_STMT_END
 129
 130 #define GST_TRACER_PAD_PUSH_EVENT_PRE(pad, event) G_STMT_START{ \
 131   if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_PAD_PUSH_EVENT_PRE)) { \
 132     gst_tracer_dispatch (GST_TRACER_HOOK_ID_PAD_PUSH_EVENT_PRE, \
 133         GST_TRACER_TS, \
 134         pad, event); \
 135   } \
 136 }G_STMT_END
 137
 138 #define GST_TRACER_PAD_PUSH_EVENT_POST(pad, res) G_STMT_START{ \
 139   if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_PAD_PUSH_EVENT_POST)) { \
 140     gst_tracer_dispatch (GST_TRACER_HOOK_ID_PAD_PUSH_EVENT_POST, \
 141         GST_TRACER_TS, \
 142         pad, res); \
 143   } \
 144 }G_STMT_END
 145
 146 #define GST_TRACER_ELEMENT_POST_MESSAGE_PRE(element, message) G_STMT_START{ \
 147   if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_ELEMENT_POST_MESSAGE_PRE)) { \
 148     gst_tracer_dispatch (GST_TRACER_HOOK_ID_ELEMENT_POST_MESSAGE_PRE, \
 149         GST_TRACER_TS, \
 150         element, message); \
 151   } \
 152 }G_STMT_END
 153
 154 #define GST_TRACER_ELEMENT_POST_MESSAGE_POST(element, res) G_STMT_START{ \
 155   if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_ELEMENT_POST_MESSAGE_POST)) { \
 156     gst_tracer_dispatch (GST_TRACER_HOOK_ID_ELEMENT_POST_MESSAGE_POST, \
 157         GST_TRACER_TS, \
 158         element, res); \
 159   } \
 160 }G_STMT_END
 161
 162 #define GST_TRACER_ELEMENT_QUERY_PRE(element, query) G_STMT_START{ \
 163   if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_ELEMENT_QUERY_PRE)) { \
 164     gst_tracer_dispatch (GST_TRACER_HOOK_ID_ELEMENT_QUERY_PRE, \
 165         GST_TRACER_TS, \
 166         element, query); \
 167   } \
 168 }G_STMT_END
 169
 170 #define GST_TRACER_ELEMENT_QUERY_POST(element, res) G_STMT_START{ \
 171   if (GST_TRACER_IS_ENABLED(GST_TRACER_HOOK_ID_ELEMENT_QUERY_POST)) { \
 172     gst_tracer_dispatch (GST_TRACER_HOOK_ID_ELEMENT_QUERY_POST, \
 173         GST_TRACER_TS, \
 174         element, res); \
 175   } \
 176 }G_STMT_END
 177
 178 #else /* !GST_DISABLE_GST_DEBUG */
 179
 180 #define GST_TRACER_PAD_PUSH_PRE(pad, buffer)
 181 #define GST_TRACER_PAD_PUSH_POST(pad, res)
 182 #define GST_TRACER_PAD_PUSH_LIST_PRE(pad, list)
 183 #define GST_TRACER_PAD_PUSH_LIST_POST(pad, res)
 184 #define GST_TRACER_PAD_PULL_RANGE_PRE(pad, offset, size)
 185 #define GST_TRACER_PAD_PULL_RANGE_POST(pad, buffer, res)
 186 #define GST_TRACER_PAD_PUSH_EVENT_PRE(pad, event)
 187 #define GST_TRACER_PAD_PUSH_EVENT_POST(pad, res)
 188 #define GST_TRACER_ELEMENT_POST_MESSAGE_PRE(element, message)
 189 #define GST_TRACER_ELEMENT_POST_MESSAGE_POST(element, res)
 190 #define GST_TRACER_ELEMENT_QUERY_PRE(element, query)
 191 #define GST_TRACER_ELEMENT_QUERY_POST(element, res)
 192
 193 #endif /* GST_DISABLE_GST_DEBUG */
 194
 195 G_END_DECLS
 196
 197 #endif /* __GST_TRACER_UTILS_H__ */
 198