2 * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * SECTION:element-videorate
23 * This element takes an incoming stream of timestamped video frames.
24 * It will produce a perfect stream that matches the source pad's framerate.
26 * The correction is performed by dropping and duplicating frames, no fancy
27 * algorithm is used to interpolate frames (yet).
29 * By default the element will simply negotiate the same framerate on its
30 * source and sink pad.
32 * This operation is useful to link to elements that require a perfect stream.
33 * Typical examples are formats that do not store timestamps for video frames,
34 * but only store a framerate, like Ogg and AVI.
36 * A conversion to a specific framerate can be forced by using filtered caps on
39 * The properties #GstVideoRate:in, #GstVideoRate:out, #GstVideoRate:duplicate
40 * and #GstVideoRate:drop can be read to obtain information about number of
41 * input frames, output frames, dropped frames (i.e. the number of unused input
42 * frames) and duplicated frames (i.e. the number of times an input frame was
43 * duplicated, beside being used normally).
45 * An input stream that needs no adjustments will thus never have dropped or
48 * When the #GstVideoRate:silent property is set to FALSE, a GObject property
49 * notification will be emitted whenever one of the #GstVideoRate:duplicate or
50 * #GstVideoRate:drop values changes.
51 * This can potentially cause performance degradation.
52 * Note that property notification will happen from the streaming thread, so
53 * applications should be prepared for this.
56 * <title>Example pipelines</title>
58 * gst-launch -v filesrc location=videotestsrc.ogg ! oggdemux ! theoradec ! videorate ! video/x-raw,framerate=15/1 ! xvimagesink
59 * ]| Decode an Ogg/Theora file and adjust the framerate to 15 fps before playing.
60 * To create the test Ogg/Theora file refer to the documentation of theoraenc.
62 * gst-launch -v v4l2src ! videorate ! video/x-raw,framerate=25/2 ! theoraenc ! oggmux ! filesink location=recording.ogg
63 * ]| Capture video from a V4L device, and adjust the stream to 12.5 fps before
64 * encoding to Ogg/Theora.
67 * Last reviewed on 2006-09-02 (0.10.11)
74 #include "gstvideorate.h"
76 GST_DEBUG_CATEGORY_STATIC (video_rate_debug);
77 #define GST_CAT_DEFAULT video_rate_debug
79 /* GstVideoRate signals and args */
86 #define DEFAULT_SILENT TRUE
87 #define DEFAULT_NEW_PREF 1.0
88 #define DEFAULT_SKIP_TO_FIRST FALSE
89 #define DEFAULT_DROP_ONLY FALSE
90 #define DEFAULT_AVERAGE_PERIOD 0
91 #define DEFAULT_MAX_RATE G_MAXINT
108 static GstStaticPadTemplate gst_video_rate_src_template =
109 GST_STATIC_PAD_TEMPLATE ("src",
112 GST_STATIC_CAPS ("video/x-raw;" "image/jpeg;" "image/png")
115 static GstStaticPadTemplate gst_video_rate_sink_template =
116 GST_STATIC_PAD_TEMPLATE ("sink",
119 GST_STATIC_CAPS ("video/x-raw;" "image/jpeg;" "image/png")
122 static void gst_video_rate_swap_prev (GstVideoRate * videorate,
123 GstBuffer * buffer, gint64 time);
124 static gboolean gst_video_rate_sink_event (GstBaseTransform * trans,
126 static gboolean gst_video_rate_query (GstBaseTransform * trans,
127 GstPadDirection direction, GstQuery * query);
129 static gboolean gst_video_rate_setcaps (GstBaseTransform * trans,
130 GstCaps * in_caps, GstCaps * out_caps);
132 static GstCaps *gst_video_rate_transform_caps (GstBaseTransform * trans,
133 GstPadDirection direction, GstCaps * caps, GstCaps * filter);
135 static void gst_video_rate_fixate_caps (GstBaseTransform * trans,
136 GstPadDirection direction, GstCaps * caps, GstCaps * othercaps);
138 static GstFlowReturn gst_video_rate_transform_ip (GstBaseTransform * trans,
141 static gboolean gst_video_rate_start (GstBaseTransform * trans);
142 static gboolean gst_video_rate_stop (GstBaseTransform * trans);
145 static void gst_video_rate_set_property (GObject * object,
146 guint prop_id, const GValue * value, GParamSpec * pspec);
147 static void gst_video_rate_get_property (GObject * object,
148 guint prop_id, GValue * value, GParamSpec * pspec);
150 static GParamSpec *pspec_drop = NULL;
151 static GParamSpec *pspec_duplicate = NULL;
153 #define gst_video_rate_parent_class parent_class
154 G_DEFINE_TYPE (GstVideoRate, gst_video_rate, GST_TYPE_BASE_TRANSFORM);
157 gst_video_rate_class_init (GstVideoRateClass * klass)
159 GObjectClass *object_class = G_OBJECT_CLASS (klass);
160 GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
161 GstBaseTransformClass *base_class = GST_BASE_TRANSFORM_CLASS (klass);
163 object_class->set_property = gst_video_rate_set_property;
164 object_class->get_property = gst_video_rate_get_property;
166 base_class->set_caps = GST_DEBUG_FUNCPTR (gst_video_rate_setcaps);
167 base_class->transform_caps =
168 GST_DEBUG_FUNCPTR (gst_video_rate_transform_caps);
169 base_class->transform_ip = GST_DEBUG_FUNCPTR (gst_video_rate_transform_ip);
170 base_class->sink_event = GST_DEBUG_FUNCPTR (gst_video_rate_sink_event);
171 base_class->start = GST_DEBUG_FUNCPTR (gst_video_rate_start);
172 base_class->stop = GST_DEBUG_FUNCPTR (gst_video_rate_stop);
173 base_class->fixate_caps = GST_DEBUG_FUNCPTR (gst_video_rate_fixate_caps);
174 base_class->query = GST_DEBUG_FUNCPTR (gst_video_rate_query);
176 g_object_class_install_property (object_class, PROP_IN,
177 g_param_spec_uint64 ("in", "In",
178 "Number of input frames", 0, G_MAXUINT64, 0,
179 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
180 g_object_class_install_property (object_class, PROP_OUT,
181 g_param_spec_uint64 ("out", "Out", "Number of output frames", 0,
182 G_MAXUINT64, 0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
183 pspec_duplicate = g_param_spec_uint64 ("duplicate", "Duplicate",
184 "Number of duplicated frames", 0, G_MAXUINT64, 0,
185 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
186 g_object_class_install_property (object_class, PROP_DUP, pspec_duplicate);
187 pspec_drop = g_param_spec_uint64 ("drop", "Drop", "Number of dropped frames",
188 0, G_MAXUINT64, 0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
189 g_object_class_install_property (object_class, PROP_DROP, pspec_drop);
190 g_object_class_install_property (object_class, PROP_SILENT,
191 g_param_spec_boolean ("silent", "silent",
192 "Don't emit notify for dropped and duplicated frames", DEFAULT_SILENT,
193 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
194 g_object_class_install_property (object_class, PROP_NEW_PREF,
195 g_param_spec_double ("new-pref", "New Pref",
196 "Value indicating how much to prefer new frames (unused)", 0.0, 1.0,
197 DEFAULT_NEW_PREF, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
200 * GstVideoRate:skip-to-first:
202 * Don't produce buffers before the first one we receive.
206 g_object_class_install_property (object_class, PROP_SKIP_TO_FIRST,
207 g_param_spec_boolean ("skip-to-first", "Skip to first buffer",
208 "Don't produce buffers before the first one we receive",
209 DEFAULT_SKIP_TO_FIRST, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
212 * GstVideoRate:drop-only:
214 * Only drop frames, no duplicates are produced.
218 g_object_class_install_property (object_class, PROP_DROP_ONLY,
219 g_param_spec_boolean ("drop-only", "Only Drop",
220 "Only drop frames, no duplicates are produced",
221 DEFAULT_DROP_ONLY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
224 * GstVideoRate:average-period:
226 * Arrange for maximum framerate by dropping frames beyond a certain framerate,
227 * where the framerate is calculated using a moving average over the
232 g_object_class_install_property (object_class, PROP_AVERAGE_PERIOD,
233 g_param_spec_uint64 ("average-period", "Period over which to average",
234 "Period over which to average the framerate (in ns) (0 = disabled)",
235 0, G_MAXINT64, DEFAULT_AVERAGE_PERIOD,
236 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
239 * GstVideoRate:max-rate:
241 * maximum framerate to pass through
245 g_object_class_install_property (object_class, PROP_MAX_RATE,
246 g_param_spec_int ("max-rate", "maximum framerate",
247 "Maximum framerate allowed to pass through "
248 "(in frames per second, implies drop-only)",
249 1, G_MAXINT, DEFAULT_MAX_RATE,
250 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
252 gst_element_class_set_details_simple (element_class,
253 "Video rate adjuster", "Filter/Effect/Video",
254 "Drops/duplicates/adjusts timestamps on video frames to make a perfect stream",
255 "Wim Taymans <wim@fluendo.com>");
257 gst_element_class_add_pad_template (element_class,
258 gst_static_pad_template_get (&gst_video_rate_sink_template));
259 gst_element_class_add_pad_template (element_class,
260 gst_static_pad_template_get (&gst_video_rate_src_template));
264 gst_value_fraction_get_extremes (const GValue * v,
265 gint * min_num, gint * min_denom, gint * max_num, gint * max_denom)
267 if (GST_VALUE_HOLDS_FRACTION (v)) {
268 *min_num = *max_num = gst_value_get_fraction_numerator (v);
269 *min_denom = *max_denom = gst_value_get_fraction_denominator (v);
270 } else if (GST_VALUE_HOLDS_FRACTION_RANGE (v)) {
271 const GValue *min, *max;
273 min = gst_value_get_fraction_range_min (v);
274 *min_num = gst_value_get_fraction_numerator (min);
275 *min_denom = gst_value_get_fraction_denominator (min);
277 max = gst_value_get_fraction_range_max (v);
278 *max_num = gst_value_get_fraction_numerator (max);
279 *max_denom = gst_value_get_fraction_denominator (max);
280 } else if (GST_VALUE_HOLDS_LIST (v)) {
281 gint min_n = G_MAXINT, min_d = 1, max_n = 0, max_d = 1;
289 n = gst_value_list_get_size (v);
293 for (i = 0; i < n; i++) {
294 const GValue *t = gst_value_list_get_value (v, i);
296 gst_value_fraction_get_extremes (t, &min_n, &min_d, &max_n, &max_d);
297 if (gst_util_fraction_compare (min_n, min_d, *min_num, *min_denom) < 0) {
302 if (gst_util_fraction_compare (max_n, max_d, *max_num, *max_denom) > 0) {
308 g_warning ("Unknown type for framerate");
316 /* Clamp the framerate in a caps structure to be a smaller range then
317 * [1...max_rate], otherwise return false */
319 gst_video_max_rate_clamp_structure (GstStructure * s, gint maxrate,
320 gint * min_num, gint * min_denom, gint * max_num, gint * max_denom)
322 gboolean ret = FALSE;
324 if (!gst_structure_has_field (s, "framerate")) {
325 /* No framerate field implies any framerate, clamping would result in
326 * [1..max_rate] so not a real subset */
330 GValue intersection = { 0, };
331 GValue clamp = { 0, };
332 gint tmp_num, tmp_denom;
334 g_value_init (&clamp, GST_TYPE_FRACTION_RANGE);
335 gst_value_set_fraction_range_full (&clamp, 0, 1, maxrate, 1);
337 v = gst_structure_get_value (s, "framerate");
338 ret = gst_value_intersect (&intersection, v, &clamp);
339 g_value_unset (&clamp);
344 gst_value_fraction_get_extremes (&intersection,
345 min_num, min_denom, max_num, max_denom);
347 gst_value_fraction_get_extremes (v,
348 &tmp_num, &tmp_denom, max_num, max_denom);
350 if (gst_util_fraction_compare (*max_num, *max_denom, maxrate, 1) > 0) {
355 gst_structure_take_value (s, "framerate", &intersection);
363 gst_video_rate_transform_caps (GstBaseTransform * trans,
364 GstPadDirection direction, GstCaps * caps, GstCaps * filter)
366 GstVideoRate *videorate = GST_VIDEO_RATE (trans);
368 GstStructure *s, *s1, *s2, *s3 = NULL;
369 int maxrate = g_atomic_int_get (&videorate->max_rate);
372 ret = gst_caps_new_empty ();
374 for (i = 0; i < gst_caps_get_size (caps); i++) {
375 s = gst_caps_get_structure (caps, i);
377 s1 = gst_structure_copy (s);
378 s2 = gst_structure_copy (s);
380 if (videorate->drop_only) {
381 gint min_num = 0, min_denom = 1;
382 gint max_num = G_MAXINT, max_denom = 1;
384 /* Clamp the caps to our maximum rate as the first caps if possible */
385 if (!gst_video_max_rate_clamp_structure (s1, maxrate,
386 &min_num, &min_denom, &max_num, &max_denom)) {
392 /* clamp wouldn't be a real subset of 1..maxrate, in this case the sink
393 * caps should become [1..maxrate], [1..maxint] and the src caps just
394 * [1..maxrate]. In case there was a caps incompatibility things will
395 * explode later as appropriate :)
397 * In case [X..maxrate] == [X..maxint], skip as we'll set it later
399 if (direction == GST_PAD_SRC && maxrate != G_MAXINT)
400 gst_structure_set (s1, "framerate", GST_TYPE_FRACTION_RANGE,
401 min_num, min_denom, maxrate, 1, NULL);
403 gst_structure_free (s1);
408 if (direction == GST_PAD_SRC) {
409 /* We can accept anything as long as it's at least the minimal framerate
410 * the the sink needs */
411 gst_structure_set (s2, "framerate", GST_TYPE_FRACTION_RANGE,
412 min_num, min_denom, G_MAXINT, 1, NULL);
414 /* Also allow unknown framerate, if it isn't already */
415 if (min_num != 0 || min_denom != 1) {
416 s3 = gst_structure_copy (s);
417 gst_structure_set (s3, "framerate", GST_TYPE_FRACTION, 0, 1, NULL);
419 } else if (max_num != 0 || max_denom != 1) {
420 /* We can provide everything upto the maximum framerate at the src */
421 gst_structure_set (s2, "framerate", GST_TYPE_FRACTION_RANGE,
422 0, 1, max_num, max_denom, NULL);
424 } else if (direction == GST_PAD_SINK) {
425 gint min_num = 0, min_denom = 1;
426 gint max_num = G_MAXINT, max_denom = 1;
428 if (!gst_video_max_rate_clamp_structure (s1, maxrate,
429 &min_num, &min_denom, &max_num, &max_denom)) {
430 gst_structure_free (s1);
433 gst_structure_set (s2, "framerate", GST_TYPE_FRACTION_RANGE, 0, 1,
436 /* set the framerate as a range */
437 gst_structure_set (s2, "framerate", GST_TYPE_FRACTION_RANGE, 0, 1,
441 gst_caps_merge_structure (ret, s1);
442 gst_caps_merge_structure (ret, s2);
444 gst_caps_merge_structure (ret, s3);
447 GstCaps *intersection;
450 gst_caps_intersect_full (filter, ret, GST_CAPS_INTERSECT_FIRST);
451 gst_caps_unref (ret);
458 gst_video_rate_fixate_caps (GstBaseTransform * trans,
459 GstPadDirection direction, GstCaps * caps, GstCaps * othercaps)
464 s = gst_caps_get_structure (caps, 0);
465 if (G_UNLIKELY (!gst_structure_get_fraction (s, "framerate", &num, &denom)))
468 gst_caps_truncate (othercaps);
469 s = gst_caps_get_structure (othercaps, 0);
470 gst_structure_fixate_field_nearest_fraction (s, "framerate", num, denom);
474 gst_video_rate_setcaps (GstBaseTransform * trans, GstCaps * in_caps,
477 GstVideoRate *videorate = GST_VIDEO_RATE (trans);
478 GstStructure *structure;
480 gint rate_numerator, rate_denominator;
482 videorate = GST_VIDEO_RATE (trans);
484 GST_DEBUG_OBJECT (trans, "setcaps called in: %" GST_PTR_FORMAT
485 " out: %" GST_PTR_FORMAT, in_caps, out_caps);
487 structure = gst_caps_get_structure (in_caps, 0);
488 if (!gst_structure_get_fraction (structure, "framerate",
489 &rate_numerator, &rate_denominator))
492 videorate->from_rate_numerator = rate_numerator;
493 videorate->from_rate_denominator = rate_denominator;
495 structure = gst_caps_get_structure (out_caps, 0);
496 if (!gst_structure_get_fraction (structure, "framerate",
497 &rate_numerator, &rate_denominator))
500 /* out_frame_count is scaled by the frame rate caps when calculating next_ts.
501 * when the frame rate caps change, we must update base_ts and reset
503 if (videorate->to_rate_numerator) {
504 videorate->base_ts +=
505 gst_util_uint64_scale (videorate->out_frame_count,
506 videorate->to_rate_denominator * GST_SECOND,
507 videorate->to_rate_numerator);
509 videorate->out_frame_count = 0;
510 videorate->to_rate_numerator = rate_numerator;
511 videorate->to_rate_denominator = rate_denominator;
514 videorate->wanted_diff = gst_util_uint64_scale_int (GST_SECOND,
515 rate_denominator, rate_numerator);
517 videorate->wanted_diff = 0;
520 /* After a setcaps, our caps may have changed. In that case, we can't use
521 * the old buffer, if there was one (it might have different dimensions) */
522 GST_DEBUG_OBJECT (videorate, "swapping old buffers");
523 gst_video_rate_swap_prev (videorate, NULL, GST_CLOCK_TIME_NONE);
524 videorate->last_ts = GST_CLOCK_TIME_NONE;
525 videorate->average = 0;
531 GST_DEBUG_OBJECT (videorate, "no framerate specified");
538 gst_video_rate_reset (GstVideoRate * videorate)
540 GST_DEBUG_OBJECT (videorate, "resetting internal variables");
544 videorate->base_ts = 0;
545 videorate->out_frame_count = 0;
548 videorate->next_ts = GST_CLOCK_TIME_NONE;
549 videorate->last_ts = GST_CLOCK_TIME_NONE;
550 videorate->discont = TRUE;
551 videorate->average = 0;
552 gst_video_rate_swap_prev (videorate, NULL, 0);
554 gst_segment_init (&videorate->segment, GST_FORMAT_TIME);
558 gst_video_rate_init (GstVideoRate * videorate)
560 gst_video_rate_reset (videorate);
561 videorate->silent = DEFAULT_SILENT;
562 videorate->new_pref = DEFAULT_NEW_PREF;
563 videorate->drop_only = DEFAULT_DROP_ONLY;
564 videorate->average_period = DEFAULT_AVERAGE_PERIOD;
565 videorate->average_period_set = DEFAULT_AVERAGE_PERIOD;
566 videorate->max_rate = DEFAULT_MAX_RATE;
568 videorate->from_rate_numerator = 0;
569 videorate->from_rate_denominator = 0;
570 videorate->to_rate_numerator = 0;
571 videorate->to_rate_denominator = 0;
573 gst_base_transform_set_gap_aware (GST_BASE_TRANSFORM (videorate), TRUE);
576 /* flush the oldest buffer */
578 gst_video_rate_flush_prev (GstVideoRate * videorate, gboolean duplicate)
582 GstClockTime push_ts;
584 if (!videorate->prevbuf)
585 goto eos_before_buffers;
587 /* make sure we can write to the metadata */
588 outbuf = gst_buffer_make_writable (gst_buffer_ref (videorate->prevbuf));
590 GST_BUFFER_OFFSET (outbuf) = videorate->out;
591 GST_BUFFER_OFFSET_END (outbuf) = videorate->out + 1;
593 if (videorate->discont) {
594 GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_DISCONT);
595 videorate->discont = FALSE;
597 GST_BUFFER_FLAG_UNSET (outbuf, GST_BUFFER_FLAG_DISCONT);
600 GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_GAP);
602 GST_BUFFER_FLAG_UNSET (outbuf, GST_BUFFER_FLAG_GAP);
604 /* this is the timestamp we put on the buffer */
605 push_ts = videorate->next_ts;
608 videorate->out_frame_count++;
609 if (videorate->to_rate_numerator) {
610 /* interpolate next expected timestamp in the segment */
612 videorate->segment.base + videorate->segment.start +
613 videorate->base_ts + gst_util_uint64_scale (videorate->out_frame_count,
614 videorate->to_rate_denominator * GST_SECOND,
615 videorate->to_rate_numerator);
616 GST_BUFFER_DURATION (outbuf) = videorate->next_ts - push_ts;
619 /* We do not need to update time in VFR (variable frame rate) mode */
620 if (!videorate->drop_only) {
621 /* adapt for looping, bring back to time in current segment. */
622 GST_BUFFER_TIMESTAMP (outbuf) = push_ts - videorate->segment.base;
625 GST_LOG_OBJECT (videorate,
626 "old is best, dup, pushing buffer outgoing ts %" GST_TIME_FORMAT,
627 GST_TIME_ARGS (push_ts));
629 res = gst_pad_push (GST_BASE_TRANSFORM_SRC_PAD (videorate), outbuf);
636 GST_INFO_OBJECT (videorate, "got EOS before any buffer was received");
642 gst_video_rate_swap_prev (GstVideoRate * videorate, GstBuffer * buffer,
645 GST_LOG_OBJECT (videorate, "swap_prev: storing buffer %p in prev", buffer);
646 if (videorate->prevbuf)
647 gst_buffer_unref (videorate->prevbuf);
648 videorate->prevbuf = buffer != NULL ? gst_buffer_ref (buffer) : NULL;
649 videorate->prev_ts = time;
653 gst_video_rate_notify_drop (GstVideoRate * videorate)
655 #if !GLIB_CHECK_VERSION(2,26,0)
656 g_object_notify ((GObject *) videorate, "drop");
658 g_object_notify_by_pspec ((GObject *) videorate, pspec_drop);
663 gst_video_rate_notify_duplicate (GstVideoRate * videorate)
665 #if !GLIB_CHECK_VERSION(2,26,0)
666 g_object_notify ((GObject *) videorate, "duplicate");
668 g_object_notify_by_pspec ((GObject *) videorate, pspec_duplicate);
672 #define MAGIC_LIMIT 25
674 gst_video_rate_sink_event (GstBaseTransform * trans, GstEvent * event)
676 GstVideoRate *videorate;
678 videorate = GST_VIDEO_RATE (trans);
680 switch (GST_EVENT_TYPE (event)) {
681 case GST_EVENT_SEGMENT:
683 const GstSegment *segment;
685 gst_event_parse_segment (event, &segment);
687 if (segment->format != GST_FORMAT_TIME)
690 GST_DEBUG_OBJECT (videorate, "handle NEWSEGMENT");
692 /* close up the previous segment, if appropriate */
693 if (videorate->prevbuf) {
698 /* fill up to the end of current segment,
699 * or only send out the stored buffer if there is no specific stop.
700 * regardless, prevent going loopy in strange cases */
701 while (res == GST_FLOW_OK && count <= MAGIC_LIMIT &&
702 ((GST_CLOCK_TIME_IS_VALID (videorate->segment.stop) &&
703 videorate->next_ts - videorate->segment.base
704 < videorate->segment.stop)
706 res = gst_video_rate_flush_prev (videorate, count > 0);
710 videorate->dup += count - 1;
711 if (!videorate->silent)
712 gst_video_rate_notify_duplicate (videorate);
713 } else if (count == 0) {
715 if (!videorate->silent)
716 gst_video_rate_notify_drop (videorate);
718 /* clean up for the new one; _chain will resume from the new start */
719 videorate->base_ts = 0;
720 videorate->out_frame_count = 0;
721 gst_video_rate_swap_prev (videorate, NULL, 0);
722 videorate->next_ts = GST_CLOCK_TIME_NONE;
725 /* We just want to update the accumulated stream_time */
726 gst_segment_copy_into (segment, &videorate->segment);
728 GST_DEBUG_OBJECT (videorate, "updated segment: %" GST_SEGMENT_FORMAT,
729 &videorate->segment);
734 GstFlowReturn res = GST_FLOW_OK;
736 GST_DEBUG_OBJECT (videorate, "Got EOS");
738 /* If the segment has a stop position, fill the segment */
739 if (GST_CLOCK_TIME_IS_VALID (videorate->segment.stop)) {
740 /* fill up to the end of current segment,
741 * or only send out the stored buffer if there is no specific stop.
742 * regardless, prevent going loopy in strange cases */
743 while (res == GST_FLOW_OK && count <= MAGIC_LIMIT &&
744 ((videorate->next_ts - videorate->segment.base <
745 videorate->segment.stop)
747 res = gst_video_rate_flush_prev (videorate, count > 0);
750 } else if (videorate->prevbuf) {
751 /* Output at least one frame but if the buffer duration is valid, output
752 * enough frames to use the complete buffer duration */
753 if (GST_BUFFER_DURATION_IS_VALID (videorate->prevbuf)) {
754 GstClockTime end_ts =
755 videorate->next_ts + GST_BUFFER_DURATION (videorate->prevbuf);
757 while (res == GST_FLOW_OK && count <= MAGIC_LIMIT &&
758 ((videorate->next_ts - videorate->segment.base < end_ts)
760 res = gst_video_rate_flush_prev (videorate, count > 0);
764 res = gst_video_rate_flush_prev (videorate, FALSE);
770 videorate->dup += count - 1;
771 if (!videorate->silent)
772 gst_video_rate_notify_duplicate (videorate);
773 } else if (count == 0) {
775 if (!videorate->silent)
776 gst_video_rate_notify_drop (videorate);
781 case GST_EVENT_FLUSH_STOP:
782 /* also resets the segment */
783 GST_DEBUG_OBJECT (videorate, "Got FLUSH_STOP");
784 gst_video_rate_reset (videorate);
795 GST_WARNING_OBJECT (videorate,
796 "Got segment but doesn't have GST_FORMAT_TIME value");
802 gst_video_rate_query (GstBaseTransform * trans, GstPadDirection direction,
805 GstVideoRate *videorate = GST_VIDEO_RATE (trans);
806 gboolean res = FALSE;
809 otherpad = (direction == GST_PAD_SRC) ?
810 GST_BASE_TRANSFORM_SINK_PAD (trans) : GST_BASE_TRANSFORM_SRC_PAD (trans);
812 switch (GST_QUERY_TYPE (query)) {
813 case GST_QUERY_LATENCY:
815 GstClockTime min, max;
821 GST_OBJECT_LOCK (videorate);
822 avg_period = videorate->average_period_set;
823 GST_OBJECT_UNLOCK (videorate);
825 if (avg_period == 0 && (peer = gst_pad_get_peer (otherpad))) {
826 if ((res = gst_pad_query (peer, query))) {
827 gst_query_parse_latency (query, &live, &min, &max);
829 GST_DEBUG_OBJECT (videorate, "Peer latency: min %"
830 GST_TIME_FORMAT " max %" GST_TIME_FORMAT,
831 GST_TIME_ARGS (min), GST_TIME_ARGS (max));
833 if (videorate->from_rate_numerator != 0) {
834 /* add latency. We don't really know since we hold on to the frames
835 * until we get a next frame, which can be anything. We assume
836 * however that this will take from_rate time. */
837 latency = gst_util_uint64_scale (GST_SECOND,
838 videorate->from_rate_denominator,
839 videorate->from_rate_numerator);
841 /* no input framerate, we don't know */
845 GST_DEBUG_OBJECT (videorate, "Our latency: %"
846 GST_TIME_FORMAT, GST_TIME_ARGS (latency));
852 GST_DEBUG_OBJECT (videorate, "Calculated total latency : min %"
853 GST_TIME_FORMAT " max %" GST_TIME_FORMAT,
854 GST_TIME_ARGS (min), GST_TIME_ARGS (max));
856 gst_query_set_latency (query, live, min, max);
858 gst_object_unref (peer);
861 /* Simple fallthrough if we don't have a latency or not a peer that we
862 * can't ask about its latency yet.. */
866 GST_BASE_TRANSFORM_CLASS (parent_class)->query (trans, direction,
875 gst_video_rate_trans_ip_max_avg (GstVideoRate * videorate, GstBuffer * buf)
877 GstClockTime ts = GST_BUFFER_TIMESTAMP (buf);
881 if (!GST_CLOCK_TIME_IS_VALID (ts) || videorate->wanted_diff == 0)
884 /* drop frames if they exceed our output rate */
885 if (GST_CLOCK_TIME_IS_VALID (videorate->last_ts)) {
886 GstClockTimeDiff diff = ts - videorate->last_ts;
888 /* Drop buffer if its early compared to the desired frame rate and
889 * the current average is higher than the desired average
891 if (diff < videorate->wanted_diff &&
892 videorate->average < videorate->wanted_diff)
896 if (videorate->average) {
897 GstClockTimeDiff wanted_diff;
899 if (G_LIKELY (videorate->average_period > videorate->wanted_diff))
900 wanted_diff = videorate->wanted_diff;
902 wanted_diff = videorate->average_period * 10;
905 gst_util_uint64_scale_round (videorate->average,
906 videorate->average_period - wanted_diff,
907 videorate->average_period) +
908 gst_util_uint64_scale_round (diff, wanted_diff,
909 videorate->average_period);
911 videorate->average = diff;
915 videorate->last_ts = ts;
922 if (!videorate->silent)
923 gst_video_rate_notify_drop (videorate);
924 return GST_BASE_TRANSFORM_FLOW_DROPPED;
928 gst_video_rate_transform_ip (GstBaseTransform * trans, GstBuffer * buffer)
930 GstVideoRate *videorate;
931 GstFlowReturn res = GST_BASE_TRANSFORM_FLOW_DROPPED;
932 GstClockTime intime, in_ts, in_dur;
933 GstClockTime avg_period;
934 gboolean skip = FALSE;
936 videorate = GST_VIDEO_RATE (trans);
938 /* make sure the denominators are not 0 */
939 if (videorate->from_rate_denominator == 0 ||
940 videorate->to_rate_denominator == 0)
943 GST_OBJECT_LOCK (videorate);
944 avg_period = videorate->average_period_set;
945 GST_OBJECT_UNLOCK (videorate);
947 /* MT-safe switching between modes */
948 if (G_UNLIKELY (avg_period != videorate->average_period)) {
949 gboolean switch_mode = (avg_period == 0 || videorate->average_period == 0);
950 videorate->average_period = avg_period;
951 videorate->last_ts = GST_CLOCK_TIME_NONE;
955 /* enabling average mode */
956 videorate->average = 0;
957 /* make sure no cached buffers from regular mode are left */
958 gst_video_rate_swap_prev (videorate, NULL, 0);
960 /* enable regular mode */
961 videorate->next_ts = GST_CLOCK_TIME_NONE;
965 /* max averaging mode has a no latency, normal mode does */
966 gst_element_post_message (GST_ELEMENT (videorate),
967 gst_message_new_latency (GST_OBJECT (videorate)));
971 if (videorate->average_period > 0)
972 return gst_video_rate_trans_ip_max_avg (videorate, buffer);
974 in_ts = GST_BUFFER_TIMESTAMP (buffer);
975 in_dur = GST_BUFFER_DURATION (buffer);
977 if (G_UNLIKELY (in_ts == GST_CLOCK_TIME_NONE)) {
978 in_ts = videorate->last_ts;
979 if (G_UNLIKELY (in_ts == GST_CLOCK_TIME_NONE))
983 /* get the time of the next expected buffer timestamp, we use this when the
984 * next buffer has -1 as a timestamp */
985 videorate->last_ts = in_ts;
986 if (in_dur != GST_CLOCK_TIME_NONE)
987 videorate->last_ts += in_dur;
989 GST_DEBUG_OBJECT (videorate, "got buffer with timestamp %" GST_TIME_FORMAT,
990 GST_TIME_ARGS (in_ts));
992 /* the input time is the time in the segment + all previously accumulated
994 intime = in_ts + videorate->segment.base;
996 /* we need to have two buffers to compare */
997 if (videorate->prevbuf == NULL) {
998 gst_video_rate_swap_prev (videorate, buffer, intime);
1000 if (!GST_CLOCK_TIME_IS_VALID (videorate->next_ts)) {
1001 /* new buffer, we expect to output a buffer that matches the first
1002 * timestamp in the segment */
1003 if (videorate->skip_to_first || skip) {
1004 videorate->next_ts = intime;
1005 videorate->base_ts = in_ts - videorate->segment.start;
1006 videorate->out_frame_count = 0;
1008 videorate->next_ts = videorate->segment.start + videorate->segment.base;
1012 GstClockTime prevtime;
1014 gint64 diff1, diff2;
1016 prevtime = videorate->prev_ts;
1018 GST_LOG_OBJECT (videorate,
1019 "BEGINNING prev buf %" GST_TIME_FORMAT " new buf %" GST_TIME_FORMAT
1020 " outgoing ts %" GST_TIME_FORMAT, GST_TIME_ARGS (prevtime),
1021 GST_TIME_ARGS (intime), GST_TIME_ARGS (videorate->next_ts));
1025 /* drop new buffer if it's before previous one */
1026 if (intime < prevtime) {
1027 GST_DEBUG_OBJECT (videorate,
1028 "The new buffer (%" GST_TIME_FORMAT
1029 ") is before the previous buffer (%"
1030 GST_TIME_FORMAT "). Dropping new buffer.",
1031 GST_TIME_ARGS (intime), GST_TIME_ARGS (prevtime));
1033 if (!videorate->silent)
1034 gst_video_rate_notify_drop (videorate);
1038 /* got 2 buffers, see which one is the best */
1041 diff1 = prevtime - videorate->next_ts;
1042 diff2 = intime - videorate->next_ts;
1044 /* take absolute values, beware: abs and ABS don't work for gint64 */
1050 GST_LOG_OBJECT (videorate,
1051 "diff with prev %" GST_TIME_FORMAT " diff with new %"
1052 GST_TIME_FORMAT " outgoing ts %" GST_TIME_FORMAT,
1053 GST_TIME_ARGS (diff1), GST_TIME_ARGS (diff2),
1054 GST_TIME_ARGS (videorate->next_ts));
1056 /* output first one when its the best */
1057 if (diff1 <= diff2) {
1061 /* on error the _flush function posted a warning already */
1062 if ((r = gst_video_rate_flush_prev (videorate,
1063 count > 1)) != GST_FLOW_OK) {
1069 /* Do not produce any dups. We can exit loop now */
1070 if (videorate->drop_only)
1072 /* continue while the first one was the best, if they were equal avoid
1073 * going into an infinite loop */
1075 while (diff1 < diff2);
1077 /* if we outputed the first buffer more then once, we have dups */
1079 videorate->dup += count - 1;
1080 if (!videorate->silent)
1081 gst_video_rate_notify_duplicate (videorate);
1083 /* if we didn't output the first buffer, we have a drop */
1084 else if (count == 0) {
1087 if (!videorate->silent)
1088 gst_video_rate_notify_drop (videorate);
1090 GST_LOG_OBJECT (videorate,
1091 "new is best, old never used, drop, outgoing ts %"
1092 GST_TIME_FORMAT, GST_TIME_ARGS (videorate->next_ts));
1094 GST_LOG_OBJECT (videorate,
1095 "END, putting new in old, diff1 %" GST_TIME_FORMAT
1096 ", diff2 %" GST_TIME_FORMAT ", next_ts %" GST_TIME_FORMAT
1097 ", in %" G_GUINT64_FORMAT ", out %" G_GUINT64_FORMAT ", drop %"
1098 G_GUINT64_FORMAT ", dup %" G_GUINT64_FORMAT, GST_TIME_ARGS (diff1),
1099 GST_TIME_ARGS (diff2), GST_TIME_ARGS (videorate->next_ts),
1100 videorate->in, videorate->out, videorate->drop, videorate->dup);
1102 /* swap in new one when it's the best */
1103 gst_video_rate_swap_prev (videorate, buffer, intime);
1111 GST_WARNING_OBJECT (videorate, "no framerate negotiated");
1112 res = GST_FLOW_NOT_NEGOTIATED;
1118 GST_WARNING_OBJECT (videorate,
1119 "Got buffer with GST_CLOCK_TIME_NONE timestamp, discarding it");
1120 res = GST_BASE_TRANSFORM_FLOW_DROPPED;
1126 gst_video_rate_start (GstBaseTransform * trans)
1128 gst_video_rate_reset (GST_VIDEO_RATE (trans));
1133 gst_video_rate_stop (GstBaseTransform * trans)
1135 gst_video_rate_reset (GST_VIDEO_RATE (trans));
1140 gst_video_rate_set_property (GObject * object,
1141 guint prop_id, const GValue * value, GParamSpec * pspec)
1143 GstVideoRate *videorate = GST_VIDEO_RATE (object);
1145 GST_OBJECT_LOCK (videorate);
1148 videorate->silent = g_value_get_boolean (value);
1151 videorate->new_pref = g_value_get_double (value);
1153 case PROP_SKIP_TO_FIRST:
1154 videorate->skip_to_first = g_value_get_boolean (value);
1156 case PROP_DROP_ONLY:
1157 videorate->drop_only = g_value_get_boolean (value);
1160 case PROP_AVERAGE_PERIOD:
1161 videorate->average_period_set = g_value_get_uint64 (value);
1164 g_atomic_int_set (&videorate->max_rate, g_value_get_int (value));
1168 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1171 GST_OBJECT_UNLOCK (videorate);
1175 GST_OBJECT_UNLOCK (videorate);
1176 gst_base_transform_reconfigure (GST_BASE_TRANSFORM (videorate));
1180 gst_video_rate_get_property (GObject * object,
1181 guint prop_id, GValue * value, GParamSpec * pspec)
1183 GstVideoRate *videorate = GST_VIDEO_RATE (object);
1185 GST_OBJECT_LOCK (videorate);
1188 g_value_set_uint64 (value, videorate->in);
1191 g_value_set_uint64 (value, videorate->out);
1194 g_value_set_uint64 (value, videorate->dup);
1197 g_value_set_uint64 (value, videorate->drop);
1200 g_value_set_boolean (value, videorate->silent);
1203 g_value_set_double (value, videorate->new_pref);
1205 case PROP_SKIP_TO_FIRST:
1206 g_value_set_boolean (value, videorate->skip_to_first);
1208 case PROP_DROP_ONLY:
1209 g_value_set_boolean (value, videorate->drop_only);
1211 case PROP_AVERAGE_PERIOD:
1212 g_value_set_uint64 (value, videorate->average_period_set);
1215 g_value_set_int (value, g_atomic_int_get (&videorate->max_rate));
1218 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1221 GST_OBJECT_UNLOCK (videorate);
1225 plugin_init (GstPlugin * plugin)
1227 GST_DEBUG_CATEGORY_INIT (video_rate_debug, "videorate", 0,
1228 "VideoRate stream fixer");
1230 return gst_element_register (plugin, "videorate", GST_RANK_NONE,
1231 GST_TYPE_VIDEO_RATE);
1234 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
1237 "Adjusts video frames",
1238 plugin_init, VERSION, GST_LICENSE, GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)