debugutils: new element cpureport

cpureport posts bus messages after every buffer received of cpu used, system
clock time, buffer time

gst/debugutils/Makefile.am

@@ -7,6 +7,7 @@ endif
 plugin_LTLIBRARIES = $(EFENCE_PLUGIN) libgstdebug.la libgstnavigationtest.la 
 
 noinst_HEADERS = \
+	cpureport.h \
 	efence.h \
 	gstcapsdebug.h \
 	gstcapssetter.h \
@@ -42,6 +43,7 @@ libgstdebug_la_SOURCES = \
 	rndbuffersize.c \
 	progressreport.c \
 	tests.c \
+	cpureport.c \
 	testplugin.c
 
 # 	negotiation.c

gst/debugutils/cpureport.c

@@ -0,0 +1,197 @@
+/* GStreamer Cpu Report Element
+ * Copyright (C) <2010> Zaheer Abbas Merali <zaheerabbas merali org>
+ *
+ * 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 #GstCpuReport:update-freq and the
+ * #GstCpuReport: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 #GstCpuReport: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 "cpureport.h"
+
+
+enum
+{
+  ARG_0,
+};
+
+GstStaticPadTemplate cpu_report_src_template = GST_STATIC_PAD_TEMPLATE ("src",
+    GST_PAD_SRC,
+    GST_PAD_ALWAYS,
+    GST_STATIC_CAPS_ANY);
+
+GstStaticPadTemplate cpu_report_sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
+    GST_PAD_SINK,
+    GST_PAD_ALWAYS,
+    GST_STATIC_CAPS_ANY);
+
+static GstFlowReturn gst_cpu_report_transform_ip (GstBaseTransform * trans,
+    GstBuffer * buf);
+
+static gboolean gst_cpu_report_start (GstBaseTransform * trans);
+static gboolean gst_cpu_report_stop (GstBaseTransform * trans);
+
+GST_BOILERPLATE (GstCpuReport, gst_cpu_report, GstBaseTransform,
+    GST_TYPE_BASE_TRANSFORM);
+
+static void
+gst_cpu_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 (&cpu_report_sink_template));
+  gst_element_class_add_pad_template (element_class,
+      gst_static_pad_template_get (&cpu_report_src_template));
+
+  gst_element_class_set_details_simple (element_class, "CPU report",
+      "Testing",
+      "Post cpu usage information every buffer",
+      "Zaheer Abbas Merali <zaheerabbas at merali dot org>");
+}
+
+static void
+gst_cpu_report_finalize (GObject * obj)
+{
+  G_OBJECT_CLASS (parent_class)->finalize (obj);
+}
+
+static void
+gst_cpu_report_class_init (GstCpuReportClass * 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_cpu_report_finalize;
+
+  gstbasetrans_class->transform_ip =
+      GST_DEBUG_FUNCPTR (gst_cpu_report_transform_ip);
+  gstbasetrans_class->start = GST_DEBUG_FUNCPTR (gst_cpu_report_start);
+  gstbasetrans_class->stop = GST_DEBUG_FUNCPTR (gst_cpu_report_stop);
+}
+
+static void
+gst_cpu_report_init (GstCpuReport * report, GstCpuReportClass * g_class)
+{
+  gst_base_transform_set_passthrough (GST_BASE_TRANSFORM (report), TRUE);
+
+}
+
+static GstFlowReturn
+gst_cpu_report_transform_ip (GstBaseTransform * trans, GstBuffer * buf)
+{
+  GstCpuReport *filter;
+  GTimeVal cur_time;
+  clock_t cur_cpu_time;
+  GstMessage *msg;
+  GstStructure *s;
+  gint64 time_taken;
+
+
+  g_get_current_time (&cur_time);
+  cur_cpu_time = clock ();
+
+  filter = GST_CPU_REPORT (trans);
+
+
+  time_taken = GST_TIMEVAL_TO_TIME (cur_time) -
+      GST_TIMEVAL_TO_TIME (filter->last_time);
+
+  s = gst_structure_new ("cpu-report", "cpu-time", G_TYPE_DOUBLE,
+      ((gdouble) (cur_cpu_time - filter->last_cpu_time)),
+      "actual-time", G_TYPE_INT64, time_taken, "buffer-time", G_TYPE_INT64,
+      GST_BUFFER_TIMESTAMP (buf), NULL);
+  msg = gst_message_new_element (GST_OBJECT_CAST (filter), s);
+  gst_element_post_message (GST_ELEMENT_CAST (filter), msg);
+  filter->last_time = cur_time;
+  filter->last_cpu_time = cur_cpu_time;
+
+
+  return GST_FLOW_OK;
+}
+
+static gboolean
+gst_cpu_report_start (GstBaseTransform * trans)
+{
+  GstCpuReport *filter;
+
+  filter = GST_CPU_REPORT (trans);
+
+  g_get_current_time (&filter->last_time);
+  filter->start_time = filter->last_time;
+  filter->last_cpu_time = clock ();
+  return TRUE;
+}
+
+static gboolean
+gst_cpu_report_stop (GstBaseTransform * trans)
+{
+  /* anything we should be doing here? */
+  return TRUE;
+}

gst/debugutils/cpureport.h

@@ -0,0 +1,58 @@
+/* GStreamer CPU Report Element
+ * Copyright (C) <2010> Zaheer Abbas Merali <zaheerabbas merali org>
+ *
+ * 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.
+ */
+
+#ifndef __GST_CPU_REPORT_H__
+#define __GST_CPU_REPORT_H__
+
+#include <time.h>
+
+#include <gst/base/gstbasetransform.h>
+
+G_BEGIN_DECLS
+#define GST_TYPE_CPU_REPORT \
+  (gst_cpu_report_get_type())
+#define GST_CPU_REPORT(obj) \
+  (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_CPU_REPORT,GstCpuReport))
+#define GST_CPU_REPORT_CLASS(klass) \
+  (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_CPU_REPORT,GstCpuReportClass))
+#define GST_IS_CPU_REPORT(obj) \
+  (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_CPU_REPORT))
+#define GST_IS_CPU_REPORT_CLASS(klass) \
+  (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_CPU_REPORT))
+typedef struct _GstCpuReport GstCpuReport;
+typedef struct _GstCpuReportClass GstCpuReportClass;
+
+struct _GstCpuReport
+{
+  GstBaseTransform basetransform;
+
+  GTimeVal start_time;
+  GTimeVal last_time;
+  clock_t last_cpu_time;
+};
+
+struct _GstCpuReportClass
+{
+  GstBaseTransformClass parent_class;
+};
+
+GType gst_cpu_report_get_type (void);
+
+G_END_DECLS
+#endif /* __GST_CPU_REPORT_H__ */

gst/debugutils/gstdebug.c

@@ -35,6 +35,7 @@ GType gst_push_file_src_get_type (void);
 /*
 GType gst_gst_negotiation_get_type (void);
 */
+GType gst_cpu_report_get_type (void);
 
 static gboolean
 plugin_init (GstPlugin * plugin)
@@ -57,7 +58,10 @@ plugin_init (GstPlugin * plugin)
       || !gst_element_register (plugin, "testsink", GST_RANK_NONE,
           gst_test_get_type ())
       || !gst_element_register (plugin, "capsdebug", GST_RANK_NONE,
-          gst_caps_debug_get_type ()))
+          gst_caps_debug_get_type ())
+      || !gst_element_register (plugin, "cpureport", GST_RANK_NONE,
+          gst_cpu_report_get_type ()))
+
     return FALSE;
 
   return TRUE;