plugins/tracers/gstlatency.c

   1 /* GStreamer
   2  * Copyright (C) 2013 Stefan Sauer <ensonic@users.sf.net>
   3  *
   4  * gstlatency.c: tracing module that logs processing latency stats
   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  * SECTION:gstlatency
  23  * @short_description: log processing latency stats
  24  *
  25  * A tracing module that determines src-to-sink latencies by injecting custom
  26  * events at sources and process them at sinks.
  27  */
  28 /* TODO(ensonic): if there are two sources feeding into a mixer/muxer and later
  29  * we fan-out with tee and have two sinks, each sink would get all two events,
  30  * the later event would overwrite the former. Unfortunately when the buffer
  31  * arrives on the sink we don't know to which event it correlates. Better would
  32  * be to use the buffer meta in 1.0 instead of the event. Or we track a min/max
  33  * latency.
  34  */
  35
  36 #ifdef HAVE_CONFIG_H
  37 #  include "config.h"
  38 #endif
  39
  40 #include "gstlatency.h"
  41
  42 GST_DEBUG_CATEGORY_STATIC (gst_latency_debug);
  43 #define GST_CAT_DEFAULT gst_latency_debug
  44
  45 #define _do_init \
  46     GST_DEBUG_CATEGORY_INIT (gst_latency_debug, "latency", 0, "latency tracer");
  47 #define gst_latency_tracer_parent_class parent_class
  48 G_DEFINE_TYPE_WITH_CODE (GstLatencyTracer, gst_latency_tracer, GST_TYPE_TRACER,
  49     _do_init);
  50
  51 static GQuark latency_probe_id;
  52 static GQuark latency_probe_pad;
  53 static GQuark latency_probe_ts;
  54
  55 /* data helpers */
  56
  57 /*
  58  * Get the element/bin owning the pad.
  59  *
  60  * in: a normal pad
  61  * out: the element
  62  *
  63  * in: a proxy pad
  64  * out: the element that contains the peer of the proxy
  65  *
  66  * in: a ghost pad
  67  * out: the bin owning the ghostpad
  68  */
  69 /* TODO(ensonic): gst_pad_get_parent_element() would not work here, should we
  70  * add this as new api, e.g. gst_pad_find_parent_element();
  71  */
  72 static GstElement *
  73 get_real_pad_parent (GstPad * pad)
  74 {
  75   GstObject *parent;
  76
  77   if (!pad)
  78     return NULL;
  79
  80   parent = GST_OBJECT_PARENT (pad);
  81
  82   /* if parent of pad is a ghost-pad, then pad is a proxy_pad */
  83   if (parent && GST_IS_GHOST_PAD (parent)) {
  84     pad = GST_PAD_CAST (parent);
  85     parent = GST_OBJECT_PARENT (pad);
  86   }
  87   return GST_ELEMENT_CAST (parent);
  88 }
  89
  90 /* hooks */
  91
  92 static void
  93 log_latency (const GstStructure * data, GstPad * sink_pad, guint64 sink_ts)
  94 {
  95   GstPad *src_pad;
  96   guint64 src_ts;
  97   gchar *src, *sink;
  98
  99   gst_structure_id_get (data,
 100       latency_probe_pad, GST_TYPE_PAD, &src_pad,
 101       latency_probe_ts, G_TYPE_UINT64, &src_ts, NULL);
 102
 103   src = g_strdup_printf ("%s_%s", GST_DEBUG_PAD_NAME (src_pad));
 104   sink = g_strdup_printf ("%s_%s", GST_DEBUG_PAD_NAME (sink_pad));
 105
 106   /* TODO(ensonic): report format is still unstable */
 107   gst_tracer_log_trace (gst_structure_new ("latency",
 108           "src", G_TYPE_STRING, src,
 109           "sink", G_TYPE_STRING, sink,
 110           "time", G_TYPE_UINT64, GST_CLOCK_DIFF (src_ts, sink_ts), NULL));
 111   g_free (src);
 112   g_free (sink);
 113 }
 114
 115 static void
 116 send_latency_probe (GstElement * parent, GstPad * pad, guint64 ts)
 117 {
 118   if (parent && (!GST_IS_BIN (parent)) &&
 119       GST_OBJECT_FLAG_IS_SET (parent, GST_ELEMENT_FLAG_SOURCE)) {
 120     GstEvent *latency_probe = gst_event_new_custom (GST_EVENT_CUSTOM_DOWNSTREAM,
 121         gst_structure_new_id (latency_probe_id,
 122             latency_probe_pad, GST_TYPE_PAD, pad,
 123             latency_probe_ts, G_TYPE_UINT64, ts,
 124             NULL));
 125     gst_pad_push_event (pad, latency_probe);
 126   }
 127 }
 128
 129 static void
 130 do_push_buffer_pre (GstTracer * self, guint64 ts, GstPad * pad)
 131 {
 132   GstElement *parent = get_real_pad_parent (pad);
 133
 134   send_latency_probe (parent, pad, ts);
 135 }
 136
 137 static void
 138 do_pull_range_pre (GstTracer * self, guint64 ts, GstPad * pad)
 139 {
 140   GstPad *peer_pad = GST_PAD_PEER (pad);
 141   GstElement *parent = get_real_pad_parent (peer_pad);
 142
 143   send_latency_probe (parent, peer_pad, ts);
 144 }
 145
 146 static void
 147 calculate_latency (GstElement * parent, GstPad * pad, guint64 ts)
 148 {
 149   if (parent && (!GST_IS_BIN (parent)) &&
 150       GST_OBJECT_FLAG_IS_SET (parent, GST_ELEMENT_FLAG_SINK)) {
 151     GstEvent *ev = g_object_get_qdata ((GObject *) pad, latency_probe_id);
 152
 153     log_latency (gst_event_get_structure (ev), pad, ts);
 154     gst_event_unref (ev);
 155   }
 156 }
 157
 158 static void
 159 do_push_buffer_post (GstTracer * self, guint64 ts, GstPad * pad)
 160 {
 161   GstPad *peer_pad = GST_PAD_PEER (pad);
 162   GstElement *parent = get_real_pad_parent (peer_pad);
 163
 164   calculate_latency (parent, peer_pad, ts);
 165 }
 166
 167 static void
 168 do_pull_range_post (GstTracer * self, guint64 ts, GstPad * pad)
 169 {
 170   GstElement *parent = get_real_pad_parent (pad);
 171
 172   calculate_latency (parent, pad, ts);
 173 }
 174
 175 static void
 176 do_push_event_pre (GstTracer * self, guint64 ts, GstPad * pad, GstEvent * ev)
 177 {
 178   GstPad *peer_pad = GST_PAD_PEER (pad);
 179   GstElement *parent = get_real_pad_parent (peer_pad);
 180
 181   if (parent && (!GST_IS_BIN (parent)) &&
 182       GST_OBJECT_FLAG_IS_SET (parent, GST_ELEMENT_FLAG_SINK)) {
 183     if (GST_EVENT_TYPE (ev) == GST_EVENT_CUSTOM_DOWNSTREAM) {
 184       const GstStructure *data = gst_event_get_structure (ev);
 185
 186       if (gst_structure_get_name_id (data) == latency_probe_id) {
 187         /* store event and calculate latency when the buffer that follows
 188          * has been processed */
 189         g_object_set_qdata ((GObject *) peer_pad, latency_probe_id,
 190             gst_event_ref (ev));
 191       }
 192     }
 193   }
 194 }
 195
 196 /* tracer class */
 197
 198 static void
 199 gst_latency_tracer_class_init (GstLatencyTracerClass * klass)
 200 {
 201   latency_probe_id = g_quark_from_static_string ("latency_probe.id");
 202   latency_probe_pad = g_quark_from_static_string ("latency_probe.pad");
 203   latency_probe_ts = g_quark_from_static_string ("latency_probe.ts");
 204
 205   /* announce trace formats */
 206   /* *INDENT-OFF* */
 207   gst_tracer_log_trace (gst_structure_new ("latency.class",
 208       "src", GST_TYPE_STRUCTURE, gst_structure_new ("scope",
 209           "related-to", G_TYPE_STRING, "pad",  /* TODO: use genum */
 210           NULL),
 211       "sink", GST_TYPE_STRUCTURE, gst_structure_new ("scope",
 212           "related-to", G_TYPE_STRING, "pad",  /* TODO: use genum */
 213           NULL),
 214       "time", GST_TYPE_STRUCTURE, gst_structure_new ("value",
 215           "type", G_TYPE_GTYPE, G_TYPE_UINT64,
 216           "description", G_TYPE_STRING,
 217               "time it took for the buffer to go from src to sink ns",
 218           "flags", G_TYPE_STRING, "aggregated",  /* TODO: use gflags */
 219           "min", G_TYPE_UINT64, G_GUINT64_CONSTANT (0),
 220           "max", G_TYPE_UINT64, G_MAXUINT64,
 221           NULL),
 222       NULL));
 223   /* *INDENT-ON* */
 224 }
 225
 226 static void
 227 gst_latency_tracer_init (GstLatencyTracer * self)
 228 {
 229   GstTracer *tracer = GST_TRACER (self);
 230   gst_tracing_register_hook (tracer, "pad-push-pre",
 231       G_CALLBACK (do_push_buffer_pre));
 232   gst_tracing_register_hook (tracer, "pad-push-list-pre",
 233       G_CALLBACK (do_push_buffer_pre));
 234   gst_tracing_register_hook (tracer, "pad-push-post",
 235       G_CALLBACK (do_push_buffer_post));
 236   gst_tracing_register_hook (tracer, "pad-push-list-post",
 237       G_CALLBACK (do_push_buffer_post));
 238   gst_tracing_register_hook (tracer, "pad-pull-range-pre",
 239       G_CALLBACK (do_pull_range_pre));
 240   gst_tracing_register_hook (tracer, "pad-pull-range-post",
 241       G_CALLBACK (do_pull_range_post));
 242   gst_tracing_register_hook (tracer, "pad-push-event-pre",
 243       G_CALLBACK (do_push_event_pre));
 244 }