1 files changed, 478 insertions, 0 deletions
diff --git a/gst/debugutils/progressreport.c b/gst/debugutils/progressreport.c
new file mode 100644
index 00000000..8f2547b3
--- /dev/null
+++ b/gst/debugutils/progressreport.c
@@ -0,0 +1,478 @@
+/* GStreamer Progress Report Element
+ * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
+ * Copyright (C) <2003> David Schleef <ds@schleef.org>
+ * Copyright (C) <2004> Jan Schmidt <thaytan@mad.scientist.com>
+ * Copyright (C) <2006> Tim-Philipp Müller <tim centricular net>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
+/**
+ * SECTION:element-progressreport
+ *
+ * The progressreport element can be put into a pipeline to report progress,
+ * which is done by doing upstream duration and position queries in regular
+ * (real-time) intervals. Both the interval and the prefered query format
+ * can be specified via the #GstProgressReport:update-freq and the
+ * #GstProgressReport:format property.
+ *
+ * Element messages containing a "progress" structure are posted on the bus
+ * whenever progress has been queried (since gst-plugins-good 0.10.6 only).
+ *
+ * Since the element was originally designed for debugging purposes, it will
+ * by default also print information about the current progress to the
+ * terminal. This can be prevented by setting the #GstProgressReport:silent
+ * property to %TRUE.
+ *
+ * This element is most useful in transcoding pipelines or other situations
+ * where just querying the pipeline might not lead to the wanted result. For
+ * progress in TIME format, the element is best placed in a 'raw stream'
+ * section of the pipeline (or after any demuxers/decoders/parsers).
+ *
+ * Three more things should be pointed out: firstly, the element will only
+ * query progress when data flow happens. If data flow is stalled for some
+ * reason, no progress messages will be posted. Secondly, there are other
+ * elements (like qtdemux, for example) that may also post "progress" element
+ * messages on the bus. Applications should check the source of any element
+ * messages they receive, if needed. Finally, applications should not take
+ * action on receiving notification of progress being 100%, they should only
+ * take action when they receive an EOS message (since the progress reported
+ * is in reference to an internal point of a pipeline and not the pipeline as
+ * a whole).
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch -m filesrc location=foo.ogg ! decodebin ! progressreport update-freq=1 ! audioconvert ! audioresample ! autoaudiosink
+ * ]| This shows a progress query where a duration is available.
+ * |[
+ * gst-launch -m audiotestsrc ! progressreport update-freq=1 ! audioconvert ! autoaudiosink
+ * ]| This shows a progress query where no duration is available.
+ * </refsect2>
+ */
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include <gst/gst.h>
+#include <string.h>
+#include <math.h>
+#include <time.h>
+
+#include "progressreport.h"
+
+
+enum
+{
+  ARG_0,
+  ARG_UPDATE_FREQ,
+  ARG_SILENT,
+  ARG_FORMAT
+};
+
+GstStaticPadTemplate progress_report_src_template =
+GST_STATIC_PAD_TEMPLATE ("src",
+    GST_PAD_SRC,
+    GST_PAD_ALWAYS,
+    GST_STATIC_CAPS_ANY);
+
+GstStaticPadTemplate progress_report_sink_template =
+GST_STATIC_PAD_TEMPLATE ("sink",
+    GST_PAD_SINK,
+    GST_PAD_ALWAYS,
+    GST_STATIC_CAPS_ANY);
+
+static const GstElementDetails progress_report_details =
+GST_ELEMENT_DETAILS ("Progress report",
+    "Testing",
+    "Periodically query and report on processing progress",
+    "Jan Schmidt <thaytan@mad.scientist.com>");
+
+#define DEFAULT_UPDATE_FREQ  5
+#define DEFAULT_SILENT       FALSE
+#define DEFAULT_FORMAT       "auto"
+
+static void gst_progress_report_set_property (GObject * object, guint prop_id,
+    const GValue * value, GParamSpec * pspec);
+static void gst_progress_report_get_property (GObject * object, guint prop_id,
+    GValue * value, GParamSpec * pspec);
+
+static gboolean gst_progress_report_event (GstBaseTransform * trans,
+    GstEvent * event);
+static GstFlowReturn gst_progress_report_transform_ip (GstBaseTransform * trans,
+    GstBuffer * buf);
+
+static gboolean gst_progress_report_start (GstBaseTransform * trans);
+static gboolean gst_progress_report_stop (GstBaseTransform * trans);
+
+GST_BOILERPLATE (GstProgressReport, gst_progress_report, GstBaseTransform,
+    GST_TYPE_BASE_TRANSFORM);
+
+static void
+gst_progress_report_base_init (gpointer g_class)
+{
+  GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
+
+  gst_element_class_add_pad_template (element_class,
+      gst_static_pad_template_get (&progress_report_sink_template));
+  gst_element_class_add_pad_template (element_class,
+      gst_static_pad_template_get (&progress_report_src_template));
+
+  gst_element_class_set_details (element_class, &progress_report_details);
+}
+
+static void
+gst_progress_report_finalize (GObject * obj)
+{
+  GstProgressReport *filter = GST_PROGRESS_REPORT (obj);
+
+  g_free (filter->format);
+  filter->format = NULL;
+
+  G_OBJECT_CLASS (parent_class)->finalize (obj);
+}
+
+static void
+gst_progress_report_class_init (GstProgressReportClass * g_class)
+{
+  GstBaseTransformClass *gstbasetrans_class;
+  GObjectClass *gobject_class;
+
+  gobject_class = G_OBJECT_CLASS (g_class);
+  gstbasetrans_class = GST_BASE_TRANSFORM_CLASS (g_class);
+
+  gobject_class->finalize = gst_progress_report_finalize;
+  gobject_class->set_property = gst_progress_report_set_property;
+  gobject_class->get_property = gst_progress_report_get_property;
+
+  g_object_class_install_property (gobject_class,
+      ARG_UPDATE_FREQ, g_param_spec_int ("update-freq", "Update Frequency",
+          "Number of seconds between reports when data is flowing", 1, G_MAXINT,
+          DEFAULT_UPDATE_FREQ, G_PARAM_READWRITE));
+
+  g_object_class_install_property (gobject_class,
+      ARG_SILENT, g_param_spec_boolean ("silent",
+          "Do not print output to stdout", "Do not print output to stdout",
+          DEFAULT_SILENT, G_PARAM_READWRITE));
+
+  g_object_class_install_property (gobject_class,
+      ARG_FORMAT, g_param_spec_string ("format", "format",
+          "Format to use for the querying", DEFAULT_FORMAT, G_PARAM_READWRITE));
+
+  gstbasetrans_class->event = GST_DEBUG_FUNCPTR (gst_progress_report_event);
+  gstbasetrans_class->transform_ip =
+      GST_DEBUG_FUNCPTR (gst_progress_report_transform_ip);
+  gstbasetrans_class->start = GST_DEBUG_FUNCPTR (gst_progress_report_start);
+  gstbasetrans_class->stop = GST_DEBUG_FUNCPTR (gst_progress_report_stop);
+}
+
+static void
+gst_progress_report_init (GstProgressReport * report,
+    GstProgressReportClass * g_class)
+{
+  gst_base_transform_set_passthrough (GST_BASE_TRANSFORM (report), TRUE);
+
+  report->update_freq = DEFAULT_UPDATE_FREQ;
+  report->silent = DEFAULT_SILENT;
+  report->format = g_strdup (DEFAULT_FORMAT);
+}
+
+static void
+gst_progress_report_post_progress (GstProgressReport * filter,
+    GstFormat format, gint64 current, gint64 total)
+{
+  GstStructure *s = NULL;
+
+  if (current >= 0 && total > 0) {
+    gdouble perc;
+
+    perc = gst_util_guint64_to_gdouble (current) * 100.0 /
+        gst_util_guint64_to_gdouble (total);
+    perc = CLAMP (perc, 0.0, 100.0);
+
+    /* we provide a "percent" field of integer type to stay compatible
+     * with qtdemux, but add a second "percent-double" field for those who
+     * want more precision and are too lazy to calculate it themselves */
+    s = gst_structure_new ("progress", "percent", G_TYPE_INT, (gint) perc,
+        "percent-double", G_TYPE_DOUBLE, perc, "current", G_TYPE_INT64, current,
+        "total", G_TYPE_INT64, total, NULL);
+  } else if (current >= 0) {
+    s = gst_structure_new ("progress", "current", G_TYPE_INT64, current, NULL);
+  }
+
+  if (s) {
+    GST_LOG_OBJECT (filter, "posting progress message: %" GST_PTR_FORMAT, s);
+    gst_structure_set (s, "format", GST_TYPE_FORMAT, format, NULL);
+    /* can't post it right here because we're holding the object lock */
+    filter->pending_msg = gst_message_new_element (GST_OBJECT_CAST (filter), s);
+  }
+}
+
+static gboolean
+gst_progress_report_do_query (GstProgressReport * filter, GstFormat format,
+    gint hh, gint mm, gint ss)
+{
+  const gchar *format_name = NULL;
+  GstPad *sink_pad;
+  gint64 cur, total;
+
+  sink_pad = GST_BASE_TRANSFORM (filter)->sinkpad;
+
+  GST_LOG_OBJECT (filter, "querying using format %d (%s)", format,
+      gst_format_get_name (format));
+
+  if (!gst_pad_query_peer_position (sink_pad, &format, &cur) ||
+      !gst_pad_query_peer_duration (sink_pad, &format, &total)) {
+    return FALSE;
+  }
+
+  switch (format) {
+    case GST_FORMAT_BYTES:
+      format_name = "bytes";
+      break;
+    case GST_FORMAT_BUFFERS:
+      format_name = "buffers";
+      break;
+    case GST_FORMAT_PERCENT:
+      format_name = "percent";
+      break;
+    case GST_FORMAT_TIME:
+      format_name = "seconds";
+      cur /= GST_SECOND;
+      total /= GST_SECOND;
+      break;
+    case GST_FORMAT_DEFAULT:{
+      GstCaps *caps;
+
+      format_name = "bogounits";
+      caps = GST_PAD_CAPS (GST_BASE_TRANSFORM (filter)->sinkpad);
+      if (caps && gst_caps_is_fixed (caps) && !gst_caps_is_any (caps)) {
+        GstStructure *s = gst_caps_get_structure (caps, 0);
+        const gchar *mime_type = gst_structure_get_name (s);
+
+        if (g_str_has_prefix (mime_type, "video/") ||
+            g_str_has_prefix (mime_type, "image/")) {
+          format_name = "frames";
+        } else if (g_str_has_prefix (mime_type, "audio/")) {
+          format_name = "samples";
+        }
+      }
+      break;
+    }
+    default:{
+      const GstFormatDefinition *details;
+
+      details = gst_format_get_details (format);
+      if (details) {
+        format_name = details->nick;
+      } else {
+        format_name = "unknown";
+      }
+      break;
+    }
+  }
+
+  if (!filter->silent) {
+    if (total > 0) {
+      g_print ("%s (%02d:%02d:%02d): %" G_GINT64_FORMAT " / %"
+          G_GINT64_FORMAT " %s (%4.1f %%)\n", GST_OBJECT_NAME (filter), hh,
+          mm, ss, cur, total, format_name, (gdouble) cur / total * 100.0);
+    } else {
+      g_print ("%s (%02d:%02d:%02d): %" G_GINT64_FORMAT " %s\n",
+          GST_OBJECT_NAME (filter), hh, mm, ss, cur, format_name);
+    }
+  }
+
+  gst_progress_report_post_progress (filter, format, cur, total);
+  return TRUE;
+}
+
+static void
+gst_progress_report_report (GstProgressReport * filter, GTimeVal cur_time)
+{
+  GstFormat try_formats[] = { GST_FORMAT_TIME, GST_FORMAT_BYTES,
+    GST_FORMAT_PERCENT, GST_FORMAT_BUFFERS,
+    GST_FORMAT_DEFAULT
+  };
+  GstMessage *msg;
+  GstFormat format = GST_FORMAT_UNDEFINED;
+  gboolean done = FALSE;
+  glong run_time;
+  gint hh, mm, ss;
+
+  run_time = cur_time.tv_sec - filter->start_time.tv_sec;
+
+  hh = (run_time / 3600) % 100;
+  mm = (run_time / 60) % 60;
+  ss = (run_time % 60);
+
+  GST_OBJECT_LOCK (filter);
+
+  if (filter->format != NULL && strcmp (filter->format, "auto") != 0) {
+    format = gst_format_get_by_nick (filter->format);
+  }
+
+  if (format != GST_FORMAT_UNDEFINED) {
+    done = gst_progress_report_do_query (filter, format, hh, mm, ss);
+  } else {
+    gint i;
+
+    for (i = 0; i < G_N_ELEMENTS (try_formats); ++i) {
+      done = gst_progress_report_do_query (filter, try_formats[i], hh, mm, ss);
+      if (done)
+        break;
+    }
+  }
+
+  if (!done && !filter->silent) {
+    g_print ("%s (%2d:%2d:%2d): Could not query position and/or duration\n",
+        GST_OBJECT_NAME (filter), hh, mm, ss);
+  }
+
+  msg = filter->pending_msg;
+  filter->pending_msg = NULL;
+  GST_OBJECT_UNLOCK (filter);
+
+  if (msg) {
+    gst_element_post_message (GST_ELEMENT_CAST (filter), msg);
+  }
+}
+
+static gboolean
+gst_progress_report_event (GstBaseTransform * trans, GstEvent * event)
+{
+  GstProgressReport *filter;
+
+  filter = GST_PROGRESS_REPORT (trans);
+
+  if (GST_EVENT_TYPE (event) == GST_EVENT_EOS) {
+    GTimeVal cur_time;
+
+    g_get_current_time (&cur_time);
+    gst_progress_report_report (filter, cur_time);
+  }
+  return GST_BASE_TRANSFORM_CLASS (parent_class)->event (trans, event);
+}
+
+static GstFlowReturn
+gst_progress_report_transform_ip (GstBaseTransform * trans, GstBuffer * buf)
+{
+  GstProgressReport *filter;
+  gboolean need_update;
+  GTimeVal cur_time;
+
+  g_get_current_time (&cur_time);
+
+  filter = GST_PROGRESS_REPORT (trans);
+
+  /* Check if update_freq seconds have passed since the last update */
+  GST_OBJECT_LOCK (filter);
+  need_update =
+      ((cur_time.tv_sec - filter->last_report.tv_sec) >= filter->update_freq);
+  GST_OBJECT_UNLOCK (filter);
+
+  if (need_update) {
+    gst_progress_report_report (filter, cur_time);
+    GST_OBJECT_LOCK (filter);
+    filter->last_report = cur_time;
+    GST_OBJECT_UNLOCK (filter);
+  }
+
+  return GST_FLOW_OK;
+}
+
+static gboolean
+gst_progress_report_start (GstBaseTransform * trans)
+{
+  GstProgressReport *filter;
+
+  filter = GST_PROGRESS_REPORT (trans);
+
+  g_get_current_time (&filter->last_report);
+  filter->start_time = filter->last_report;
+
+  return TRUE;
+}
+
+static gboolean
+gst_progress_report_stop (GstBaseTransform * trans)
+{
+  /* anything we should be doing here? */
+  return TRUE;
+}
+
+static void
+gst_progress_report_set_property (GObject * object, guint prop_id,
+    const GValue * value, GParamSpec * pspec)
+{
+  GstProgressReport *filter;
+
+  filter = GST_PROGRESS_REPORT (object);
+
+  switch (prop_id) {
+    case ARG_UPDATE_FREQ:
+      GST_OBJECT_LOCK (filter);
+      filter->update_freq = g_value_get_int (value);
+      GST_OBJECT_UNLOCK (filter);
+      break;
+    case ARG_SILENT:
+      GST_OBJECT_LOCK (filter);
+      filter->silent = g_value_get_boolean (value);
+      GST_OBJECT_UNLOCK (filter);
+      break;
+    case ARG_FORMAT:
+      GST_OBJECT_LOCK (filter);
+      g_free (filter->format);
+      filter->format = g_value_dup_string (value);
+      if (filter->format == NULL)
+        filter->format = g_strdup ("auto");
+      GST_OBJECT_UNLOCK (filter);
+      break;
+    default:
+      break;
+  }
+}
+
+static void
+gst_progress_report_get_property (GObject * object, guint prop_id,
+    GValue * value, GParamSpec * pspec)
+{
+  GstProgressReport *filter;
+
+  filter = GST_PROGRESS_REPORT (object);
+
+  switch (prop_id) {
+    case ARG_UPDATE_FREQ:
+      GST_OBJECT_LOCK (filter);
+      g_value_set_int (value, filter->update_freq);
+      GST_OBJECT_UNLOCK (filter);
+      break;
+    case ARG_SILENT:
+      GST_OBJECT_LOCK (filter);
+      g_value_set_boolean (value, filter->silent);
+      GST_OBJECT_UNLOCK (filter);
+      break;
+    case ARG_FORMAT:
+      GST_OBJECT_LOCK (filter);
+      g_value_set_string (value, filter->format);
+      GST_OBJECT_UNLOCK (filter);
+      break;
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+      break;
+  }
+}