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_tracer_init (void);
  38 void _priv_gst_tracer_deinit (void);
  39
  40 /* tracing modules */
  41
  42 gboolean gst_tracer_register (GstPlugin * plugin, const gchar * name, GType type);
  43
  44 /* tracing helpers */
  45
  46 void gst_tracer_dispatch (GQuark detail, ...);
  47
  48 /* tracer quarks */
  49
  50 /* These enums need to match the number and order
  51  * of strings declared in _quark_table, in gsttracerutils.c */
  52 typedef enum _GstTracerQuarkId
  53 {
  54   GST_TRACER_QUARK_HOOK_PAD_PUSH_PRE = 0,
  55   GST_TRACER_QUARK_HOOK_PAD_PUSH_POST,
  56   GST_TRACER_QUARK_HOOK_PAD_PUSH_LIST_PRE,
  57   GST_TRACER_QUARK_HOOK_PAD_PUSH_LIST_POST,
  58   GST_TRACER_QUARK_HOOK_PAD_PULL_RANGE_PRE,
  59   GST_TRACER_QUARK_HOOK_PAD_PULL_RANGE_POST,
  60   GST_TRACER_QUARK_HOOK_PAD_PUSH_EVENT_PRE ,
  61   GST_TRACER_QUARK_HOOK_PAD_PUSH_EVENT_POST,
  62   GST_TRACER_QUARK_HOOK_ELEMENT_POST_MESSAGE_PRE,
  63   GST_TRACER_QUARK_HOOK_ELEMENT_POST_MESSAGE_POST,
  64   GST_TRACER_QUARK_HOOK_ELEMENT_QUERY_PRE,
  65   GST_TRACER_QUARK_HOOK_ELEMENT_QUERY_POST,
  66   GST_TRACER_QUARK_MAX
  67 } GstTracerQuarkId;
  68
  69 extern GQuark _priv_gst_tracer_quark_table[GST_TRACER_QUARK_MAX];
  70
  71 #define GST_TRACER_QUARK(q) _priv_gst_tracer_quark_table[GST_TRACER_QUARK_##q]
  72
  73 /* tracing module helpers */
  74
  75 extern gboolean _priv_tracer_enabled;
  76 extern GHashTable *_priv_tracers;
  77
  78 #define GST_TRACER_IS_ENABLED(id) \
  79   (_priv_tracer_enabled && \
  80       (g_hash_table_contains (_priv_tracers, GINT_TO_POINTER(id))))
  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_PAD_PUSH_PRE(pad, buffer) G_STMT_START{ \
  88   if (GST_TRACER_IS_ENABLED(GST_TRACER_QUARK(HOOK_PAD_PUSH_PRE))) { \
  89     gst_tracer_dispatch (GST_TRACER_QUARK(HOOK_PAD_PUSH_PRE), \
  90         GST_TRACER_TS, \
  91         pad, buffer); \
  92   } \
  93 }G_STMT_END
  94
  95 #define GST_TRACER_PAD_PUSH_POST(pad, res) G_STMT_START{ \
  96   if (GST_TRACER_IS_ENABLED(GST_TRACER_QUARK(HOOK_PAD_PUSH_POST))) { \
  97     gst_tracer_dispatch (GST_TRACER_QUARK(HOOK_PAD_PUSH_POST), \
  98         GST_TRACER_TS, \
  99         pad, res); \
 100   } \
 101 }G_STMT_END
 102
 103 #define GST_TRACER_PAD_PUSH_LIST_PRE(pad, list) G_STMT_START{ \
 104   if (GST_TRACER_IS_ENABLED(GST_TRACER_QUARK(HOOK_PAD_PUSH_LIST_PRE))) { \
 105     gst_tracer_dispatch (GST_TRACER_QUARK(HOOK_PAD_PUSH_LIST_PRE), \
 106         GST_TRACER_TS, \
 107         pad, list); \
 108   } \
 109 }G_STMT_END
 110
 111 #define GST_TRACER_PAD_PUSH_LIST_POST(pad, res) G_STMT_START{ \
 112   if (GST_TRACER_IS_ENABLED(GST_TRACER_QUARK(HOOK_PAD_PUSH_LIST_POST))) { \
 113     gst_tracer_dispatch (GST_TRACER_QUARK(HOOK_PAD_PUSH_LIST_POST), \
 114         GST_TRACER_TS, \
 115         pad, res); \
 116   } \
 117 }G_STMT_END
 118
 119 #define GST_TRACER_PAD_PULL_RANGE_PRE(pad, offset, size) G_STMT_START{ \
 120   if (GST_TRACER_IS_ENABLED(GST_TRACER_QUARK(HOOK_PAD_PULL_RANGE_PRE))) { \
 121     gst_tracer_dispatch (GST_TRACER_QUARK(HOOK_PAD_PULL_RANGE_PRE), \
 122         GST_TRACER_TS, \
 123         pad, offset, size); \
 124   } \
 125 }G_STMT_END
 126
 127 #define GST_TRACER_PAD_PULL_RANGE_POST(pad, buffer, res) G_STMT_START{ \
 128   if (GST_TRACER_IS_ENABLED(GST_TRACER_QUARK(HOOK_PAD_PULL_RANGE_POST))) { \
 129     gst_tracer_dispatch (GST_TRACER_QUARK(HOOK_PAD_PULL_RANGE_POST), \
 130         GST_TRACER_TS, \
 131         pad, buffer, res); \
 132   } \
 133 }G_STMT_END
 134
 135 #define GST_TRACER_PAD_PUSH_EVENT_PRE(pad, event) G_STMT_START{ \
 136   if (GST_TRACER_IS_ENABLED(GST_TRACER_QUARK(HOOK_PAD_PUSH_EVENT_PRE))) { \
 137     gst_tracer_dispatch (GST_TRACER_QUARK(HOOK_PAD_PUSH_EVENT_PRE), \
 138         GST_TRACER_TS, \
 139         pad, event); \
 140   } \
 141 }G_STMT_END
 142
 143 #define GST_TRACER_PAD_PUSH_EVENT_POST(pad, res) G_STMT_START{ \
 144   if (GST_TRACER_IS_ENABLED(GST_TRACER_QUARK(HOOK_PAD_PUSH_EVENT_POST))) { \
 145     gst_tracer_dispatch (GST_TRACER_QUARK(HOOK_PAD_PUSH_EVENT_POST), \
 146         GST_TRACER_TS, \
 147         pad, res); \
 148   } \
 149 }G_STMT_END
 150
 151 #define GST_TRACER_ELEMENT_POST_MESSAGE_PRE(element, message) G_STMT_START{ \
 152   if (GST_TRACER_IS_ENABLED(GST_TRACER_QUARK(HOOK_ELEMENT_POST_MESSAGE_PRE))) { \
 153     gst_tracer_dispatch (GST_TRACER_QUARK(HOOK_ELEMENT_POST_MESSAGE_PRE), \
 154         GST_TRACER_TS, \
 155         element, message); \
 156   } \
 157 }G_STMT_END
 158
 159 #define GST_TRACER_ELEMENT_POST_MESSAGE_POST(element, res) G_STMT_START{ \
 160   if (GST_TRACER_IS_ENABLED(GST_TRACER_QUARK(HOOK_ELEMENT_POST_MESSAGE_POST))) { \
 161     gst_tracer_dispatch (GST_TRACER_QUARK(HOOK_ELEMENT_POST_MESSAGE_POST), \
 162         GST_TRACER_TS, \
 163         element, res); \
 164   } \
 165 }G_STMT_END
 166
 167 #define GST_TRACER_ELEMENT_QUERY_PRE(element, query) G_STMT_START{ \
 168   if (GST_TRACER_IS_ENABLED(GST_TRACER_QUARK(HOOK_ELEMENT_QUERY_PRE))) { \
 169     gst_tracer_dispatch (GST_TRACER_QUARK(HOOK_ELEMENT_QUERY_PRE), \
 170         GST_TRACER_TS, \
 171         element, query); \
 172   } \
 173 }G_STMT_END
 174
 175 #define GST_TRACER_ELEMENT_QUERY_POST(element, res) G_STMT_START{ \
 176   if (GST_TRACER_IS_ENABLED(GST_TRACER_QUARK(HOOK_ELEMENT_QUERY_POST))) { \
 177     gst_tracer_dispatch (GST_TRACER_QUARK(HOOK_ELEMENT_QUERY_POST), \
 178         GST_TRACER_TS, \
 179         element, res); \
 180   } \
 181 }G_STMT_END
 182
 183 #else /* !GST_DISABLE_GST_DEBUG */
 184
 185 #define GST_TRACER_PAD_PUSH_PRE(pad, buffer)
 186 #define GST_TRACER_PAD_PUSH_POST(pad, res)
 187 #define GST_TRACER_PAD_PUSH_LIST_PRE(pad, list)
 188 #define GST_TRACER_PAD_PUSH_LIST_POST(pad, res)
 189 #define GST_TRACER_PAD_PULL_RANGE_PRE(pad, offset, size)
 190 #define GST_TRACER_PAD_PULL_RANGE_POST(pad, buffer, res)
 191 #define GST_TRACER_PAD_PUSH_EVENT_PRE(pad, event)
 192 #define GST_TRACER_PAD_PUSH_EVENT_POST(pad, res)
 193 #define GST_TRACER_ELEMENT_POST_MESSAGE_PRE(element, message)
 194 #define GST_TRACER_ELEMENT_POST_MESSAGE_POST(element, res)
 195 #define GST_TRACER_ELEMENT_QUERY_PRE(element, query)
 196 #define GST_TRACER_ELEMENT_QUERY_POST(element, res)
 197
 198 #endif /* GST_DISABLE_GST_DEBUG */
 199
 200 G_END_DECLS
 201
 202 #endif /* __GST_TRACER_UTILS_H__ */
 203