1 /* GStreamer Progress Report Element
2 * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
3 * Copyright (C) <2003> David Schleef <ds@schleef.org>
4 * Copyright (C) <2004> Jan Schmidt <thaytan@mad.scientist.com>
5 * Copyright (C) <2006> Tim-Philipp Müller <tim centricular net>
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Library General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Library General Public License for more details.
17 * You should have received a copy of the GNU Library General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
20 * Boston, MA 02110-1301, USA.
24 * SECTION:element-progressreport
26 * The progressreport element can be put into a pipeline to report progress,
27 * which is done by doing upstream duration and position queries in regular
28 * (real-time) intervals. Both the interval and the prefered query format
29 * can be specified via the #GstProgressReport:update-freq and the
30 * #GstProgressReport:format property.
32 * Element messages containing a "progress" structure are posted on the bus
33 * whenever progress has been queried (since gst-plugins-good 0.10.6 only).
35 * Since the element was originally designed for debugging purposes, it will
36 * by default also print information about the current progress to the
37 * terminal. This can be prevented by setting the #GstProgressReport:silent
40 * This element is most useful in transcoding pipelines or other situations
41 * where just querying the pipeline might not lead to the wanted result. For
42 * progress in TIME format, the element is best placed in a 'raw stream'
43 * section of the pipeline (or after any demuxers/decoders/parsers).
45 * Three more things should be pointed out: firstly, the element will only
46 * query progress when data flow happens. If data flow is stalled for some
47 * reason, no progress messages will be posted. Secondly, there are other
48 * elements (like qtdemux, for example) that may also post "progress" element
49 * messages on the bus. Applications should check the source of any element
50 * messages they receive, if needed. Finally, applications should not take
51 * action on receiving notification of progress being 100%, they should only
52 * take action when they receive an EOS message (since the progress reported
53 * is in reference to an internal point of a pipeline and not the pipeline as
57 * <title>Example launch line</title>
59 * gst-launch-1.0 -m filesrc location=foo.ogg ! decodebin ! progressreport update-freq=1 ! audioconvert ! audioresample ! autoaudiosink
60 * ]| This shows a progress query where a duration is available.
62 * gst-launch-1.0 -m audiotestsrc ! progressreport update-freq=1 ! audioconvert ! autoaudiosink
63 * ]| This shows a progress query where no duration is available.
76 #include "progressreport.h"
88 GstStaticPadTemplate progress_report_src_template =
89 GST_STATIC_PAD_TEMPLATE ("src",
94 GstStaticPadTemplate progress_report_sink_template =
95 GST_STATIC_PAD_TEMPLATE ("sink",
100 #define DEFAULT_UPDATE_FREQ 5
101 #define DEFAULT_SILENT FALSE
102 #define DEFAULT_DO_QUERY TRUE
103 #define DEFAULT_FORMAT "auto"
105 static void gst_progress_report_set_property (GObject * object, guint prop_id,
106 const GValue * value, GParamSpec * pspec);
107 static void gst_progress_report_get_property (GObject * object, guint prop_id,
108 GValue * value, GParamSpec * pspec);
110 static gboolean gst_progress_report_sink_event (GstBaseTransform * trans,
112 static GstFlowReturn gst_progress_report_transform_ip (GstBaseTransform * trans,
115 static gboolean gst_progress_report_start (GstBaseTransform * trans);
116 static gboolean gst_progress_report_stop (GstBaseTransform * trans);
118 #define gst_progress_report_parent_class parent_class
119 G_DEFINE_TYPE (GstProgressReport, gst_progress_report, GST_TYPE_BASE_TRANSFORM);
122 gst_progress_report_finalize (GObject * obj)
124 GstProgressReport *filter = GST_PROGRESS_REPORT (obj);
126 g_free (filter->format);
127 filter->format = NULL;
129 G_OBJECT_CLASS (parent_class)->finalize (obj);
133 gst_progress_report_class_init (GstProgressReportClass * g_class)
135 GstBaseTransformClass *gstbasetrans_class;
136 GstElementClass *element_class;
137 GObjectClass *gobject_class;
139 gobject_class = G_OBJECT_CLASS (g_class);
140 element_class = GST_ELEMENT_CLASS (g_class);
141 gstbasetrans_class = GST_BASE_TRANSFORM_CLASS (g_class);
143 gobject_class->finalize = gst_progress_report_finalize;
144 gobject_class->set_property = gst_progress_report_set_property;
145 gobject_class->get_property = gst_progress_report_get_property;
147 g_object_class_install_property (gobject_class,
148 PROP_UPDATE_FREQ, g_param_spec_int ("update-freq", "Update Frequency",
149 "Number of seconds between reports when data is flowing", 1, G_MAXINT,
150 DEFAULT_UPDATE_FREQ, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
152 g_object_class_install_property (gobject_class,
153 PROP_SILENT, g_param_spec_boolean ("silent",
154 "Do not print output to stdout", "Do not print output to stdout",
155 DEFAULT_SILENT, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
157 g_object_class_install_property (gobject_class,
158 PROP_DO_QUERY, g_param_spec_boolean ("do-query",
159 "Use a query instead of buffer metadata to determine stream position",
160 "Use a query instead of buffer metadata to determine stream position",
161 DEFAULT_DO_QUERY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
163 g_object_class_install_property (gobject_class,
164 PROP_FORMAT, g_param_spec_string ("format", "format",
165 "Format to use for the querying", DEFAULT_FORMAT,
166 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
168 gst_element_class_add_static_pad_template (element_class,
169 &progress_report_sink_template);
170 gst_element_class_add_static_pad_template (element_class,
171 &progress_report_src_template);
173 gst_element_class_set_static_metadata (element_class, "Progress report",
175 "Periodically query and report on processing progress",
176 "Jan Schmidt <thaytan@mad.scientist.com>");
178 gstbasetrans_class->sink_event =
179 GST_DEBUG_FUNCPTR (gst_progress_report_sink_event);
180 gstbasetrans_class->transform_ip =
181 GST_DEBUG_FUNCPTR (gst_progress_report_transform_ip);
182 gstbasetrans_class->start = GST_DEBUG_FUNCPTR (gst_progress_report_start);
183 gstbasetrans_class->stop = GST_DEBUG_FUNCPTR (gst_progress_report_stop);
187 gst_progress_report_init (GstProgressReport * report)
189 gst_base_transform_set_passthrough (GST_BASE_TRANSFORM (report), TRUE);
191 report->update_freq = DEFAULT_UPDATE_FREQ;
192 report->silent = DEFAULT_SILENT;
193 report->do_query = DEFAULT_DO_QUERY;
194 report->format = g_strdup (DEFAULT_FORMAT);
198 gst_progress_report_post_progress (GstProgressReport * filter,
199 GstFormat format, gint64 current, gint64 total)
201 GstStructure *s = NULL;
203 if (current >= 0 && total > 0) {
206 perc = gst_util_guint64_to_gdouble (current) * 100.0 /
207 gst_util_guint64_to_gdouble (total);
208 perc = CLAMP (perc, 0.0, 100.0);
210 /* we provide a "percent" field of integer type to stay compatible
211 * with qtdemux, but add a second "percent-double" field for those who
212 * want more precision and are too lazy to calculate it themselves */
213 s = gst_structure_new ("progress", "percent", G_TYPE_INT, (gint) perc,
214 "percent-double", G_TYPE_DOUBLE, perc, "current", G_TYPE_INT64, current,
215 "total", G_TYPE_INT64, total, NULL);
216 } else if (current >= 0) {
217 s = gst_structure_new ("progress", "current", G_TYPE_INT64, current, NULL);
221 GST_LOG_OBJECT (filter, "posting progress message: %" GST_PTR_FORMAT, s);
222 gst_structure_set (s, "format", GST_TYPE_FORMAT, format, NULL);
223 /* can't post it right here because we're holding the object lock */
224 filter->pending_msg = gst_message_new_element (GST_OBJECT_CAST (filter), s);
229 gst_progress_report_do_query (GstProgressReport * filter, GstFormat format,
230 gint hh, gint mm, gint ss, GstBuffer * buf)
232 const gchar *format_name = NULL;
236 sink_pad = GST_BASE_TRANSFORM (filter)->sinkpad;
238 GST_LOG_OBJECT (filter, "querying using format %d (%s)", format,
239 gst_format_get_name (format));
241 if (filter->do_query || !buf) {
242 GST_LOG_OBJECT (filter, "using upstream query");
243 if (!gst_pad_peer_query_position (sink_pad, format, &cur) ||
244 !gst_pad_peer_query_duration (sink_pad, format, &total)) {
248 GstBaseTransform *base = GST_BASE_TRANSFORM (filter);
250 GST_LOG_OBJECT (filter, "using buffer metadata");
251 if (format == GST_FORMAT_TIME && base->segment.format == GST_FORMAT_TIME) {
252 cur = gst_segment_to_stream_time (&base->segment, format,
253 GST_BUFFER_TIMESTAMP (buf));
254 total = base->segment.duration;
255 } else if (format == GST_FORMAT_BUFFERS) {
256 cur = filter->buffer_count;
264 case GST_FORMAT_BYTES:
265 format_name = "bytes";
267 case GST_FORMAT_BUFFERS:
268 format_name = "buffers";
270 case GST_FORMAT_PERCENT:
271 format_name = "percent";
273 case GST_FORMAT_TIME:
274 format_name = "seconds";
278 case GST_FORMAT_DEFAULT:{
281 format_name = "bogounits";
282 caps = gst_pad_get_current_caps (GST_BASE_TRANSFORM (filter)->sinkpad);
284 if (gst_caps_is_fixed (caps) && !gst_caps_is_any (caps)) {
285 GstStructure *s = gst_caps_get_structure (caps, 0);
286 const gchar *mime_type = gst_structure_get_name (s);
288 if (g_str_has_prefix (mime_type, "video/") ||
289 g_str_has_prefix (mime_type, "image/")) {
290 format_name = "frames";
291 } else if (g_str_has_prefix (mime_type, "audio/")) {
292 format_name = "samples";
295 gst_caps_unref (caps);
300 const GstFormatDefinition *details;
302 details = gst_format_get_details (format);
304 format_name = details->nick;
306 format_name = "unknown";
312 if (!filter->silent) {
314 g_print ("%s (%02d:%02d:%02d): %" G_GINT64_FORMAT " / %"
315 G_GINT64_FORMAT " %s (%4.1f %%)\n", GST_OBJECT_NAME (filter), hh,
316 mm, ss, cur, total, format_name, (gdouble) cur / total * 100.0);
318 g_print ("%s (%02d:%02d:%02d): %" G_GINT64_FORMAT " %s\n",
319 GST_OBJECT_NAME (filter), hh, mm, ss, cur, format_name);
323 gst_progress_report_post_progress (filter, format, cur, total);
328 gst_progress_report_report (GstProgressReport * filter, GTimeVal cur_time,
331 GstFormat try_formats[] = { GST_FORMAT_TIME, GST_FORMAT_BYTES,
332 GST_FORMAT_PERCENT, GST_FORMAT_BUFFERS,
336 GstFormat format = GST_FORMAT_UNDEFINED;
337 gboolean done = FALSE;
341 run_time = cur_time.tv_sec - filter->start_time.tv_sec;
343 hh = (run_time / 3600) % 100;
344 mm = (run_time / 60) % 60;
345 ss = (run_time % 60);
347 GST_OBJECT_LOCK (filter);
349 if (filter->format != NULL && strcmp (filter->format, "auto") != 0) {
350 format = gst_format_get_by_nick (filter->format);
353 if (format != GST_FORMAT_UNDEFINED) {
354 done = gst_progress_report_do_query (filter, format, hh, mm, ss, buf);
358 for (i = 0; i < G_N_ELEMENTS (try_formats); ++i) {
359 done = gst_progress_report_do_query (filter, try_formats[i], hh, mm, ss,
366 if (!done && !filter->silent) {
367 g_print ("%s (%2d:%2d:%2d): Could not query position and/or duration\n",
368 GST_OBJECT_NAME (filter), hh, mm, ss);
371 msg = filter->pending_msg;
372 filter->pending_msg = NULL;
373 GST_OBJECT_UNLOCK (filter);
376 gst_element_post_message (GST_ELEMENT_CAST (filter), msg);
381 gst_progress_report_sink_event (GstBaseTransform * trans, GstEvent * event)
383 GstProgressReport *filter;
385 filter = GST_PROGRESS_REPORT (trans);
387 switch (GST_EVENT_TYPE (event)) {
392 g_get_current_time (&cur_time);
393 gst_progress_report_report (filter, cur_time, NULL);
399 return GST_BASE_TRANSFORM_CLASS (parent_class)->sink_event (trans, event);
403 gst_progress_report_transform_ip (GstBaseTransform * trans, GstBuffer * buf)
405 GstProgressReport *filter;
406 gboolean need_update;
409 g_get_current_time (&cur_time);
411 filter = GST_PROGRESS_REPORT (trans);
413 /* Check if update_freq seconds have passed since the last update */
414 GST_OBJECT_LOCK (filter);
416 ((cur_time.tv_sec - filter->last_report.tv_sec) >= filter->update_freq);
417 filter->buffer_count++;
418 GST_OBJECT_UNLOCK (filter);
421 gst_progress_report_report (filter, cur_time, buf);
422 GST_OBJECT_LOCK (filter);
423 filter->last_report = cur_time;
424 GST_OBJECT_UNLOCK (filter);
431 gst_progress_report_start (GstBaseTransform * trans)
433 GstProgressReport *filter;
435 filter = GST_PROGRESS_REPORT (trans);
437 g_get_current_time (&filter->last_report);
438 filter->start_time = filter->last_report;
439 filter->buffer_count = 0;
445 gst_progress_report_stop (GstBaseTransform * trans)
447 /* anything we should be doing here? */
452 gst_progress_report_set_property (GObject * object, guint prop_id,
453 const GValue * value, GParamSpec * pspec)
455 GstProgressReport *filter;
457 filter = GST_PROGRESS_REPORT (object);
460 case PROP_UPDATE_FREQ:
461 GST_OBJECT_LOCK (filter);
462 filter->update_freq = g_value_get_int (value);
463 GST_OBJECT_UNLOCK (filter);
466 GST_OBJECT_LOCK (filter);
467 filter->silent = g_value_get_boolean (value);
468 GST_OBJECT_UNLOCK (filter);
471 GST_OBJECT_LOCK (filter);
472 filter->do_query = g_value_get_boolean (value);
473 GST_OBJECT_UNLOCK (filter);
476 GST_OBJECT_LOCK (filter);
477 g_free (filter->format);
478 filter->format = g_value_dup_string (value);
479 if (filter->format == NULL)
480 filter->format = g_strdup ("auto");
481 GST_OBJECT_UNLOCK (filter);
489 gst_progress_report_get_property (GObject * object, guint prop_id,
490 GValue * value, GParamSpec * pspec)
492 GstProgressReport *filter;
494 filter = GST_PROGRESS_REPORT (object);
497 case PROP_UPDATE_FREQ:
498 GST_OBJECT_LOCK (filter);
499 g_value_set_int (value, filter->update_freq);
500 GST_OBJECT_UNLOCK (filter);
503 GST_OBJECT_LOCK (filter);
504 g_value_set_boolean (value, filter->silent);
505 GST_OBJECT_UNLOCK (filter);
508 GST_OBJECT_LOCK (filter);
509 g_value_set_boolean (value, filter->do_query);
510 GST_OBJECT_UNLOCK (filter);
513 GST_OBJECT_LOCK (filter);
514 g_value_set_string (value, filter->format);
515 GST_OBJECT_UNLOCK (filter);
518 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);