57d5071e64eda2dd994e7aeae301bf0609c1afd2
[platform/upstream/gstreamer.git] / gst / videorate / gstvideorate.c
1 /* GStreamer
2  * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
3  *
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.
8  *
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.
13  *
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.
18  */
19
20 /**
21  * SECTION:element-videorate
22  *
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.
25  *
26  * The correction is performed by dropping and duplicating frames, no fancy
27  * algorithm is used to interpolate frames (yet).
28  *
29  * By default the element will simply negotiate the same framerate on its
30  * source and sink pad.
31  *
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.
35  *
36  * A conversion to a specific framerate can be forced by using filtered caps on
37  * the source pad.
38  *
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).
44  *
45  * An input stream that needs no adjustments will thus never have dropped or
46  * duplicated frames.
47  *
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.
54  *
55  * <refsect2>
56  * <title>Example pipelines</title>
57  * |[
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.
61  * |[
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.
65  * </refsect2>
66  *
67  * Last reviewed on 2006-09-02 (0.10.11)
68  */
69
70 #ifdef HAVE_CONFIG_H
71 #include "config.h"
72 #endif
73
74 #include "gstvideorate.h"
75
76 GST_DEBUG_CATEGORY_STATIC (video_rate_debug);
77 #define GST_CAT_DEFAULT video_rate_debug
78
79 /* GstVideoRate signals and args */
80 enum
81 {
82   /* FILL ME */
83   LAST_SIGNAL
84 };
85
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
92
93 enum
94 {
95   PROP_0,
96   PROP_IN,
97   PROP_OUT,
98   PROP_DUP,
99   PROP_DROP,
100   PROP_SILENT,
101   PROP_NEW_PREF,
102   PROP_SKIP_TO_FIRST,
103   PROP_DROP_ONLY,
104   PROP_AVERAGE_PERIOD,
105   PROP_MAX_RATE
106 };
107
108 static GstStaticPadTemplate gst_video_rate_src_template =
109     GST_STATIC_PAD_TEMPLATE ("src",
110     GST_PAD_SRC,
111     GST_PAD_ALWAYS,
112     GST_STATIC_CAPS ("video/x-raw;" "image/jpeg;" "image/png")
113     );
114
115 static GstStaticPadTemplate gst_video_rate_sink_template =
116     GST_STATIC_PAD_TEMPLATE ("sink",
117     GST_PAD_SINK,
118     GST_PAD_ALWAYS,
119     GST_STATIC_CAPS ("video/x-raw;" "image/jpeg;" "image/png")
120     );
121
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,
125     GstEvent * event);
126 static gboolean gst_video_rate_query (GstBaseTransform * trans,
127     GstPadDirection direction, GstQuery * query);
128
129 static gboolean gst_video_rate_setcaps (GstBaseTransform * trans,
130     GstCaps * in_caps, GstCaps * out_caps);
131
132 static GstCaps *gst_video_rate_transform_caps (GstBaseTransform * trans,
133     GstPadDirection direction, GstCaps * caps, GstCaps * filter);
134
135 static void gst_video_rate_fixate_caps (GstBaseTransform * trans,
136     GstPadDirection direction, GstCaps * caps, GstCaps * othercaps);
137
138 static GstFlowReturn gst_video_rate_transform_ip (GstBaseTransform * trans,
139     GstBuffer * buf);
140
141 static gboolean gst_video_rate_start (GstBaseTransform * trans);
142 static gboolean gst_video_rate_stop (GstBaseTransform * trans);
143
144
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);
149
150 static GParamSpec *pspec_drop = NULL;
151 static GParamSpec *pspec_duplicate = NULL;
152
153 #define gst_video_rate_parent_class parent_class
154 G_DEFINE_TYPE (GstVideoRate, gst_video_rate, GST_TYPE_BASE_TRANSFORM);
155
156 static void
157 gst_video_rate_class_init (GstVideoRateClass * klass)
158 {
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);
162
163   object_class->set_property = gst_video_rate_set_property;
164   object_class->get_property = gst_video_rate_get_property;
165
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);
175
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));
198
199   /**
200    * GstVideoRate:skip-to-first:
201    * 
202    * Don't produce buffers before the first one we receive.
203    *
204    * Since: 0.10.25
205    */
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));
210
211   /**
212    * GstVideoRate:drop-only:
213    *
214    * Only drop frames, no duplicates are produced.
215    *
216    * Since: 0.10.36
217    */
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));
222
223   /**
224    * GstVideoRate:average-period:
225    *
226    * Arrange for maximum framerate by dropping frames beyond a certain framerate,
227    * where the framerate is calculated using a moving average over the
228    * configured.
229    *
230    * Since: 0.10.36
231    */
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));
237
238   /**
239    * GstVideoRate:max-rate:
240    *
241    * maximum framerate to pass through
242    *
243    * Since: 0.10.36
244    */
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));
251
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>");
256
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));
261 }
262
263 static void
264 gst_value_fraction_get_extremes (const GValue * v,
265     gint * min_num, gint * min_denom, gint * max_num, gint * max_denom)
266 {
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;
272
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);
276
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;
282     int i, n;
283
284     *min_num = G_MAXINT;
285     *min_denom = 1;
286     *max_num = 0;
287     *max_denom = 1;
288
289     n = gst_value_list_get_size (v);
290
291     g_assert (n > 0);
292
293     for (i = 0; i < n; i++) {
294       const GValue *t = gst_value_list_get_value (v, i);
295
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) {
298         *min_num = min_n;
299         *min_denom = min_d;
300       }
301
302       if (gst_util_fraction_compare (max_n, max_d, *max_num, *max_denom) > 0) {
303         *max_num = max_n;
304         *max_denom = max_d;
305       }
306     }
307   } else {
308     g_warning ("Unknown type for framerate");
309     *min_num = 0;
310     *min_denom = 1;
311     *max_num = G_MAXINT;
312     *max_denom = 1;
313   }
314 }
315
316 /* Clamp the framerate in a caps structure to be a smaller range then
317  * [1...max_rate], otherwise return false */
318 static gboolean
319 gst_video_max_rate_clamp_structure (GstStructure * s, gint maxrate,
320     gint * min_num, gint * min_denom, gint * max_num, gint * max_denom)
321 {
322   gboolean ret = FALSE;
323
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 */
327     goto out;
328   } else {
329     const GValue *v;
330     GValue intersection = { 0, };
331     GValue clamp = { 0, };
332     gint tmp_num, tmp_denom;
333
334     g_value_init (&clamp, GST_TYPE_FRACTION_RANGE);
335     gst_value_set_fraction_range_full (&clamp, 0, 1, maxrate, 1);
336
337     v = gst_structure_get_value (s, "framerate");
338     ret = gst_value_intersect (&intersection, v, &clamp);
339     g_value_unset (&clamp);
340
341     if (!ret)
342       goto out;
343
344     gst_value_fraction_get_extremes (&intersection,
345         min_num, min_denom, max_num, max_denom);
346
347     gst_value_fraction_get_extremes (v,
348         &tmp_num, &tmp_denom, max_num, max_denom);
349
350     if (gst_util_fraction_compare (*max_num, *max_denom, maxrate, 1) > 0) {
351       *max_num = maxrate;
352       *max_denom = 1;
353     }
354
355     gst_structure_take_value (s, "framerate", &intersection);
356   }
357
358 out:
359   return ret;
360 }
361
362 static GstCaps *
363 gst_video_rate_transform_caps (GstBaseTransform * trans,
364     GstPadDirection direction, GstCaps * caps, GstCaps * filter)
365 {
366   GstVideoRate *videorate = GST_VIDEO_RATE (trans);
367   GstCaps *ret;
368   GstStructure *s, *s2;
369   GstStructure *s3 = NULL;
370   int maxrate = g_atomic_int_get (&videorate->max_rate);
371
372   /* Should always be called with simple caps */
373   g_return_val_if_fail (GST_CAPS_IS_SIMPLE (caps), NULL);
374
375   ret = gst_caps_copy (caps);
376
377   s = gst_caps_get_structure (ret, 0);
378   s2 = gst_structure_copy (s);
379
380   if (videorate->drop_only) {
381     gint min_num = 0, min_denom = 1;
382     gint max_num = G_MAXINT, max_denom = 1;
383
384     /* Clamp the caps to our maximum rate as the first caps if possible */
385     if (!gst_video_max_rate_clamp_structure (s, maxrate,
386             &min_num, &min_denom, &max_num, &max_denom)) {
387       min_num = 0;
388       min_denom = 1;
389       max_num = maxrate;
390       max_denom = 1;
391
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 :)
396        *
397        * In case [X..maxrate] == [X..maxint], skip as we'll set it later
398        */
399       if (direction == GST_PAD_SRC && maxrate != G_MAXINT)
400         gst_structure_set (s, "framerate", GST_TYPE_FRACTION_RANGE,
401             min_num, min_denom, maxrate, 1, NULL);
402       else
403         gst_caps_remove_structure (ret, 0);
404     }
405
406     if (direction == GST_PAD_SRC) {
407       /* We can accept anything as long as it's at least the minimal framerate
408        * the the sink needs */
409       gst_structure_set (s2, "framerate", GST_TYPE_FRACTION_RANGE,
410           min_num, min_denom, G_MAXINT, 1, NULL);
411
412       /* Also allow unknown framerate, if it isn't already */
413       if (min_num != 0 || min_denom != 1) {
414         s3 = gst_structure_copy (s);
415         gst_structure_set (s3, "framerate", GST_TYPE_FRACTION, 0, 1, NULL);
416       }
417     } else if (max_num != 0 || max_denom != 1) {
418       /* We can provide everything upto the maximum framerate at the src */
419       gst_structure_set (s2, "framerate", GST_TYPE_FRACTION_RANGE,
420           0, 1, max_num, max_denom, NULL);
421     }
422   } else if (direction == GST_PAD_SINK) {
423     gint min_num = 0, min_denom = 1;
424     gint max_num = G_MAXINT, max_denom = 1;
425
426     if (!gst_video_max_rate_clamp_structure (s, maxrate,
427             &min_num, &min_denom, &max_num, &max_denom))
428       gst_caps_remove_structure (ret, 0);
429
430     gst_structure_set (s2, "framerate", GST_TYPE_FRACTION_RANGE, 0, 1,
431         maxrate, 1, NULL);
432   } else {
433     /* set the framerate as a range */
434     gst_structure_set (s2, "framerate", GST_TYPE_FRACTION_RANGE, 0, 1,
435         G_MAXINT, 1, NULL);
436   }
437
438   gst_caps_merge_structure (ret, s2);
439   if (s3 != NULL)
440     gst_caps_merge_structure (ret, s3);
441
442   return ret;
443 }
444
445 static void
446 gst_video_rate_fixate_caps (GstBaseTransform * trans,
447     GstPadDirection direction, GstCaps * caps, GstCaps * othercaps)
448 {
449   GstStructure *s;
450   gint num, denom;
451
452   s = gst_caps_get_structure (caps, 0);
453   if (G_UNLIKELY (!gst_structure_get_fraction (s, "framerate", &num, &denom)))
454     return;
455
456   s = gst_caps_get_structure (othercaps, 0);
457   gst_structure_fixate_field_nearest_fraction (s, "framerate", num, denom);
458 }
459
460 static gboolean
461 gst_video_rate_setcaps (GstBaseTransform * trans, GstCaps * in_caps,
462     GstCaps * out_caps)
463 {
464   GstVideoRate *videorate = GST_VIDEO_RATE (trans);
465   GstStructure *structure;
466   gboolean ret = TRUE;
467   gint rate_numerator, rate_denominator;
468
469   videorate = GST_VIDEO_RATE (trans);
470
471   GST_DEBUG_OBJECT (trans, "setcaps called in: %" GST_PTR_FORMAT
472       " out: %" GST_PTR_FORMAT, in_caps, out_caps);
473
474   structure = gst_caps_get_structure (in_caps, 0);
475   if (!gst_structure_get_fraction (structure, "framerate",
476           &rate_numerator, &rate_denominator))
477     goto no_framerate;
478
479   videorate->from_rate_numerator = rate_numerator;
480   videorate->from_rate_denominator = rate_denominator;
481
482   structure = gst_caps_get_structure (out_caps, 0);
483   if (!gst_structure_get_fraction (structure, "framerate",
484           &rate_numerator, &rate_denominator))
485     goto no_framerate;
486
487   /* out_frame_count is scaled by the frame rate caps when calculating next_ts.
488    * when the frame rate caps change, we must update base_ts and reset
489    * out_frame_count */
490   if (videorate->to_rate_numerator) {
491     videorate->base_ts +=
492         gst_util_uint64_scale (videorate->out_frame_count,
493         videorate->to_rate_denominator * GST_SECOND,
494         videorate->to_rate_numerator);
495   }
496   videorate->out_frame_count = 0;
497   videorate->to_rate_numerator = rate_numerator;
498   videorate->to_rate_denominator = rate_denominator;
499
500   if (rate_numerator)
501     videorate->wanted_diff = gst_util_uint64_scale_int (GST_SECOND,
502         rate_denominator, rate_numerator);
503   else
504     videorate->wanted_diff = 0;
505
506 done:
507   /* After a setcaps, our caps may have changed. In that case, we can't use
508    * the old buffer, if there was one (it might have different dimensions) */
509   GST_DEBUG_OBJECT (videorate, "swapping old buffers");
510   gst_video_rate_swap_prev (videorate, NULL, GST_CLOCK_TIME_NONE);
511   videorate->last_ts = GST_CLOCK_TIME_NONE;
512   videorate->average = 0;
513
514   return ret;
515
516 no_framerate:
517   {
518     GST_DEBUG_OBJECT (videorate, "no framerate specified");
519     ret = FALSE;
520     goto done;
521   }
522 }
523
524 static void
525 gst_video_rate_reset (GstVideoRate * videorate)
526 {
527   GST_DEBUG_OBJECT (videorate, "resetting internal variables");
528
529   videorate->in = 0;
530   videorate->out = 0;
531   videorate->base_ts = 0;
532   videorate->out_frame_count = 0;
533   videorate->drop = 0;
534   videorate->dup = 0;
535   videorate->next_ts = GST_CLOCK_TIME_NONE;
536   videorate->last_ts = GST_CLOCK_TIME_NONE;
537   videorate->discont = TRUE;
538   videorate->average = 0;
539   gst_video_rate_swap_prev (videorate, NULL, 0);
540
541   gst_segment_init (&videorate->segment, GST_FORMAT_TIME);
542 }
543
544 static void
545 gst_video_rate_init (GstVideoRate * videorate)
546 {
547   gst_video_rate_reset (videorate);
548   videorate->silent = DEFAULT_SILENT;
549   videorate->new_pref = DEFAULT_NEW_PREF;
550   videorate->drop_only = DEFAULT_DROP_ONLY;
551   videorate->average_period = DEFAULT_AVERAGE_PERIOD;
552   videorate->average_period_set = DEFAULT_AVERAGE_PERIOD;
553   videorate->max_rate = DEFAULT_MAX_RATE;
554
555   videorate->from_rate_numerator = 0;
556   videorate->from_rate_denominator = 0;
557   videorate->to_rate_numerator = 0;
558   videorate->to_rate_denominator = 0;
559
560   gst_base_transform_set_gap_aware (GST_BASE_TRANSFORM (videorate), TRUE);
561 }
562
563 /* flush the oldest buffer */
564 static GstFlowReturn
565 gst_video_rate_flush_prev (GstVideoRate * videorate, gboolean duplicate)
566 {
567   GstFlowReturn res;
568   GstBuffer *outbuf;
569   GstClockTime push_ts;
570
571   if (!videorate->prevbuf)
572     goto eos_before_buffers;
573
574   /* make sure we can write to the metadata */
575   outbuf = gst_buffer_make_writable (gst_buffer_ref (videorate->prevbuf));
576
577   GST_BUFFER_OFFSET (outbuf) = videorate->out;
578   GST_BUFFER_OFFSET_END (outbuf) = videorate->out + 1;
579
580   if (videorate->discont) {
581     GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_DISCONT);
582     videorate->discont = FALSE;
583   } else
584     GST_BUFFER_FLAG_UNSET (outbuf, GST_BUFFER_FLAG_DISCONT);
585
586   if (duplicate)
587     GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_GAP);
588   else
589     GST_BUFFER_FLAG_UNSET (outbuf, GST_BUFFER_FLAG_GAP);
590
591   /* this is the timestamp we put on the buffer */
592   push_ts = videorate->next_ts;
593
594   videorate->out++;
595   videorate->out_frame_count++;
596   if (videorate->to_rate_numerator) {
597     /* interpolate next expected timestamp in the segment */
598     videorate->next_ts =
599         videorate->segment.base + videorate->segment.start +
600         videorate->base_ts + gst_util_uint64_scale (videorate->out_frame_count,
601         videorate->to_rate_denominator * GST_SECOND,
602         videorate->to_rate_numerator);
603     GST_BUFFER_DURATION (outbuf) = videorate->next_ts - push_ts;
604   }
605
606   /* We do not need to update time in VFR (variable frame rate) mode */
607   if (!videorate->drop_only) {
608     /* adapt for looping, bring back to time in current segment. */
609     GST_BUFFER_TIMESTAMP (outbuf) = push_ts - videorate->segment.base;
610   }
611
612   GST_LOG_OBJECT (videorate,
613       "old is best, dup, pushing buffer outgoing ts %" GST_TIME_FORMAT,
614       GST_TIME_ARGS (push_ts));
615
616   res = gst_pad_push (GST_BASE_TRANSFORM_SRC_PAD (videorate), outbuf);
617
618   return res;
619
620   /* WARNINGS */
621 eos_before_buffers:
622   {
623     GST_INFO_OBJECT (videorate, "got EOS before any buffer was received");
624     return GST_FLOW_OK;
625   }
626 }
627
628 static void
629 gst_video_rate_swap_prev (GstVideoRate * videorate, GstBuffer * buffer,
630     gint64 time)
631 {
632   GST_LOG_OBJECT (videorate, "swap_prev: storing buffer %p in prev", buffer);
633   if (videorate->prevbuf)
634     gst_buffer_unref (videorate->prevbuf);
635   videorate->prevbuf = buffer != NULL ? gst_buffer_ref (buffer) : NULL;
636   videorate->prev_ts = time;
637 }
638
639 static void
640 gst_video_rate_notify_drop (GstVideoRate * videorate)
641 {
642 #if !GLIB_CHECK_VERSION(2,26,0)
643   g_object_notify ((GObject *) videorate, "drop");
644 #else
645   g_object_notify_by_pspec ((GObject *) videorate, pspec_drop);
646 #endif
647 }
648
649 static void
650 gst_video_rate_notify_duplicate (GstVideoRate * videorate)
651 {
652 #if !GLIB_CHECK_VERSION(2,26,0)
653   g_object_notify ((GObject *) videorate, "duplicate");
654 #else
655   g_object_notify_by_pspec ((GObject *) videorate, pspec_duplicate);
656 #endif
657 }
658
659 #define MAGIC_LIMIT  25
660 static gboolean
661 gst_video_rate_sink_event (GstBaseTransform * trans, GstEvent * event)
662 {
663   GstVideoRate *videorate;
664
665   videorate = GST_VIDEO_RATE (trans);
666
667   switch (GST_EVENT_TYPE (event)) {
668     case GST_EVENT_SEGMENT:
669     {
670       const GstSegment *segment;
671
672       gst_event_parse_segment (event, &segment);
673
674       if (segment->format != GST_FORMAT_TIME)
675         goto format_error;
676
677       GST_DEBUG_OBJECT (videorate, "handle NEWSEGMENT");
678
679       /* close up the previous segment, if appropriate */
680       if (videorate->prevbuf) {
681         gint count = 0;
682         GstFlowReturn res;
683
684         res = GST_FLOW_OK;
685         /* fill up to the end of current segment,
686          * or only send out the stored buffer if there is no specific stop.
687          * regardless, prevent going loopy in strange cases */
688         while (res == GST_FLOW_OK && count <= MAGIC_LIMIT &&
689             ((GST_CLOCK_TIME_IS_VALID (videorate->segment.stop) &&
690                     videorate->next_ts - videorate->segment.base
691                     < videorate->segment.stop)
692                 || count < 1)) {
693           res = gst_video_rate_flush_prev (videorate, count > 0);
694           count++;
695         }
696         if (count > 1) {
697           videorate->dup += count - 1;
698           if (!videorate->silent)
699             gst_video_rate_notify_duplicate (videorate);
700         } else if (count == 0) {
701           videorate->drop++;
702           if (!videorate->silent)
703             gst_video_rate_notify_drop (videorate);
704         }
705         /* clean up for the new one; _chain will resume from the new start */
706         videorate->base_ts = 0;
707         videorate->out_frame_count = 0;
708         gst_video_rate_swap_prev (videorate, NULL, 0);
709         videorate->next_ts = GST_CLOCK_TIME_NONE;
710       }
711
712       /* We just want to update the accumulated stream_time  */
713       gst_segment_copy_into (segment, &videorate->segment);
714
715       GST_DEBUG_OBJECT (videorate, "updated segment: %" GST_SEGMENT_FORMAT,
716           &videorate->segment);
717       break;
718     }
719     case GST_EVENT_EOS:{
720       gint count = 0;
721       GstFlowReturn res = GST_FLOW_OK;
722
723       GST_DEBUG_OBJECT (videorate, "Got EOS");
724
725       /* If the segment has a stop position, fill the segment */
726       if (GST_CLOCK_TIME_IS_VALID (videorate->segment.stop)) {
727         /* fill up to the end of current segment,
728          * or only send out the stored buffer if there is no specific stop.
729          * regardless, prevent going loopy in strange cases */
730         while (res == GST_FLOW_OK && count <= MAGIC_LIMIT &&
731             ((videorate->next_ts - videorate->segment.base <
732                     videorate->segment.stop)
733                 || count < 1)) {
734           res = gst_video_rate_flush_prev (videorate, count > 0);
735           count++;
736         }
737       } else if (videorate->prevbuf) {
738         /* Output at least one frame but if the buffer duration is valid, output
739          * enough frames to use the complete buffer duration */
740         if (GST_BUFFER_DURATION_IS_VALID (videorate->prevbuf)) {
741           GstClockTime end_ts =
742               videorate->next_ts + GST_BUFFER_DURATION (videorate->prevbuf);
743
744           while (res == GST_FLOW_OK && count <= MAGIC_LIMIT &&
745               ((videorate->next_ts - videorate->segment.base < end_ts)
746                   || count < 1)) {
747             res = gst_video_rate_flush_prev (videorate, count > 0);
748             count++;
749           }
750         } else {
751           res = gst_video_rate_flush_prev (videorate, FALSE);
752           count = 1;
753         }
754       }
755
756       if (count > 1) {
757         videorate->dup += count - 1;
758         if (!videorate->silent)
759           gst_video_rate_notify_duplicate (videorate);
760       } else if (count == 0) {
761         videorate->drop++;
762         if (!videorate->silent)
763           gst_video_rate_notify_drop (videorate);
764       }
765
766       break;
767     }
768     case GST_EVENT_FLUSH_STOP:
769       /* also resets the segment */
770       GST_DEBUG_OBJECT (videorate, "Got FLUSH_STOP");
771       gst_video_rate_reset (videorate);
772       break;
773     default:
774       break;
775   }
776
777   return TRUE;
778
779   /* ERRORS */
780 format_error:
781   {
782     GST_WARNING_OBJECT (videorate,
783         "Got segment but doesn't have GST_FORMAT_TIME value");
784     return FALSE;
785   }
786 }
787
788 static gboolean
789 gst_video_rate_query (GstBaseTransform * trans, GstPadDirection direction,
790     GstQuery * query)
791 {
792   GstVideoRate *videorate = GST_VIDEO_RATE (trans);
793   gboolean res = FALSE;
794   GstPad *otherpad;
795
796   otherpad = (direction == GST_PAD_SRC) ?
797       GST_BASE_TRANSFORM_SINK_PAD (trans) : GST_BASE_TRANSFORM_SRC_PAD (trans);
798
799   switch (GST_QUERY_TYPE (query)) {
800     case GST_QUERY_LATENCY:
801     {
802       GstClockTime min, max;
803       gboolean live;
804       guint64 latency;
805       guint64 avg_period;
806       GstPad *peer;
807
808       GST_OBJECT_LOCK (videorate);
809       avg_period = videorate->average_period_set;
810       GST_OBJECT_UNLOCK (videorate);
811
812       if (avg_period == 0 && (peer = gst_pad_get_peer (otherpad))) {
813         if ((res = gst_pad_query (peer, query))) {
814           gst_query_parse_latency (query, &live, &min, &max);
815
816           GST_DEBUG_OBJECT (videorate, "Peer latency: min %"
817               GST_TIME_FORMAT " max %" GST_TIME_FORMAT,
818               GST_TIME_ARGS (min), GST_TIME_ARGS (max));
819
820           if (videorate->from_rate_numerator != 0) {
821             /* add latency. We don't really know since we hold on to the frames
822              * until we get a next frame, which can be anything. We assume
823              * however that this will take from_rate time. */
824             latency = gst_util_uint64_scale (GST_SECOND,
825                 videorate->from_rate_denominator,
826                 videorate->from_rate_numerator);
827           } else {
828             /* no input framerate, we don't know */
829             latency = 0;
830           }
831
832           GST_DEBUG_OBJECT (videorate, "Our latency: %"
833               GST_TIME_FORMAT, GST_TIME_ARGS (latency));
834
835           min += latency;
836           if (max != -1)
837             max += latency;
838
839           GST_DEBUG_OBJECT (videorate, "Calculated total latency : min %"
840               GST_TIME_FORMAT " max %" GST_TIME_FORMAT,
841               GST_TIME_ARGS (min), GST_TIME_ARGS (max));
842
843           gst_query_set_latency (query, live, min, max);
844         }
845         gst_object_unref (peer);
846         break;
847       }
848       /* Simple fallthrough if we don't have a latency or not a peer that we
849        * can't ask about its latency yet.. */
850     }
851     default:
852       res =
853           GST_BASE_TRANSFORM_CLASS (parent_class)->query (trans, direction,
854           query);
855       break;
856   }
857
858   return res;
859 }
860
861 static GstFlowReturn
862 gst_video_rate_trans_ip_max_avg (GstVideoRate * videorate, GstBuffer * buf)
863 {
864   GstClockTime ts = GST_BUFFER_TIMESTAMP (buf);
865
866   videorate->in++;
867
868   if (!GST_CLOCK_TIME_IS_VALID (ts) || videorate->wanted_diff == 0)
869     goto push;
870
871   /* drop frames if they exceed our output rate */
872   if (GST_CLOCK_TIME_IS_VALID (videorate->last_ts)) {
873     GstClockTimeDiff diff = ts - videorate->last_ts;
874
875     /* Drop buffer if its early compared to the desired frame rate and
876      * the current average is higher than the desired average
877      */
878     if (diff < videorate->wanted_diff &&
879         videorate->average < videorate->wanted_diff)
880       goto drop;
881
882     /* Update average */
883     if (videorate->average) {
884       GstClockTimeDiff wanted_diff;
885
886       if (G_LIKELY (videorate->average_period > videorate->wanted_diff))
887         wanted_diff = videorate->wanted_diff;
888       else
889         wanted_diff = videorate->average_period * 10;
890
891       videorate->average =
892           gst_util_uint64_scale_round (videorate->average,
893           videorate->average_period - wanted_diff,
894           videorate->average_period) +
895           gst_util_uint64_scale_round (diff, wanted_diff,
896           videorate->average_period);
897     } else {
898       videorate->average = diff;
899     }
900   }
901
902   videorate->last_ts = ts;
903
904 push:
905   videorate->out++;
906   return GST_FLOW_OK;
907
908 drop:
909   if (!videorate->silent)
910     gst_video_rate_notify_drop (videorate);
911   return GST_BASE_TRANSFORM_FLOW_DROPPED;
912 }
913
914 static GstFlowReturn
915 gst_video_rate_transform_ip (GstBaseTransform * trans, GstBuffer * buffer)
916 {
917   GstVideoRate *videorate;
918   GstFlowReturn res = GST_BASE_TRANSFORM_FLOW_DROPPED;
919   GstClockTime intime, in_ts, in_dur;
920   GstClockTime avg_period;
921   gboolean skip = FALSE;
922
923   videorate = GST_VIDEO_RATE (trans);
924
925   /* make sure the denominators are not 0 */
926   if (videorate->from_rate_denominator == 0 ||
927       videorate->to_rate_denominator == 0)
928     goto not_negotiated;
929
930   GST_OBJECT_LOCK (videorate);
931   avg_period = videorate->average_period_set;
932   GST_OBJECT_UNLOCK (videorate);
933
934   /* MT-safe switching between modes */
935   if (G_UNLIKELY (avg_period != videorate->average_period)) {
936     gboolean switch_mode = (avg_period == 0 || videorate->average_period == 0);
937     videorate->average_period = avg_period;
938     videorate->last_ts = GST_CLOCK_TIME_NONE;
939
940     if (switch_mode) {
941       if (avg_period) {
942         /* enabling average mode */
943         videorate->average = 0;
944         /* make sure no cached buffers from regular mode are left */
945         gst_video_rate_swap_prev (videorate, NULL, 0);
946       } else {
947         /* enable regular mode */
948         videorate->next_ts = GST_CLOCK_TIME_NONE;
949         skip = TRUE;
950       }
951
952       /* max averaging mode has a no latency, normal mode does */
953       gst_element_post_message (GST_ELEMENT (videorate),
954           gst_message_new_latency (GST_OBJECT (videorate)));
955     }
956   }
957
958   if (videorate->average_period > 0)
959     return gst_video_rate_trans_ip_max_avg (videorate, buffer);
960
961   in_ts = GST_BUFFER_TIMESTAMP (buffer);
962   in_dur = GST_BUFFER_DURATION (buffer);
963
964   if (G_UNLIKELY (in_ts == GST_CLOCK_TIME_NONE)) {
965     in_ts = videorate->last_ts;
966     if (G_UNLIKELY (in_ts == GST_CLOCK_TIME_NONE))
967       goto invalid_buffer;
968   }
969
970   /* get the time of the next expected buffer timestamp, we use this when the
971    * next buffer has -1 as a timestamp */
972   videorate->last_ts = in_ts;
973   if (in_dur != GST_CLOCK_TIME_NONE)
974     videorate->last_ts += in_dur;
975
976   GST_DEBUG_OBJECT (videorate, "got buffer with timestamp %" GST_TIME_FORMAT,
977       GST_TIME_ARGS (in_ts));
978
979   /* the input time is the time in the segment + all previously accumulated
980    * segments */
981   intime = in_ts + videorate->segment.base;
982
983   /* we need to have two buffers to compare */
984   if (videorate->prevbuf == NULL) {
985     gst_video_rate_swap_prev (videorate, buffer, intime);
986     videorate->in++;
987     if (!GST_CLOCK_TIME_IS_VALID (videorate->next_ts)) {
988       /* new buffer, we expect to output a buffer that matches the first
989        * timestamp in the segment */
990       if (videorate->skip_to_first || skip) {
991         videorate->next_ts = intime;
992         videorate->base_ts = in_ts - videorate->segment.start;
993         videorate->out_frame_count = 0;
994       } else {
995         videorate->next_ts = videorate->segment.start + videorate->segment.base;
996       }
997     }
998   } else {
999     GstClockTime prevtime;
1000     gint count = 0;
1001     gint64 diff1, diff2;
1002
1003     prevtime = videorate->prev_ts;
1004
1005     GST_LOG_OBJECT (videorate,
1006         "BEGINNING prev buf %" GST_TIME_FORMAT " new buf %" GST_TIME_FORMAT
1007         " outgoing ts %" GST_TIME_FORMAT, GST_TIME_ARGS (prevtime),
1008         GST_TIME_ARGS (intime), GST_TIME_ARGS (videorate->next_ts));
1009
1010     videorate->in++;
1011
1012     /* drop new buffer if it's before previous one */
1013     if (intime < prevtime) {
1014       GST_DEBUG_OBJECT (videorate,
1015           "The new buffer (%" GST_TIME_FORMAT
1016           ") is before the previous buffer (%"
1017           GST_TIME_FORMAT "). Dropping new buffer.",
1018           GST_TIME_ARGS (intime), GST_TIME_ARGS (prevtime));
1019       videorate->drop++;
1020       if (!videorate->silent)
1021         gst_video_rate_notify_drop (videorate);
1022       goto done;
1023     }
1024
1025     /* got 2 buffers, see which one is the best */
1026     do {
1027
1028       diff1 = prevtime - videorate->next_ts;
1029       diff2 = intime - videorate->next_ts;
1030
1031       /* take absolute values, beware: abs and ABS don't work for gint64 */
1032       if (diff1 < 0)
1033         diff1 = -diff1;
1034       if (diff2 < 0)
1035         diff2 = -diff2;
1036
1037       GST_LOG_OBJECT (videorate,
1038           "diff with prev %" GST_TIME_FORMAT " diff with new %"
1039           GST_TIME_FORMAT " outgoing ts %" GST_TIME_FORMAT,
1040           GST_TIME_ARGS (diff1), GST_TIME_ARGS (diff2),
1041           GST_TIME_ARGS (videorate->next_ts));
1042
1043       /* output first one when its the best */
1044       if (diff1 <= diff2) {
1045         GstFlowReturn r;
1046         count++;
1047
1048         /* on error the _flush function posted a warning already */
1049         if ((r = gst_video_rate_flush_prev (videorate,
1050                     count > 1)) != GST_FLOW_OK) {
1051           res = r;
1052           goto done;
1053         }
1054       }
1055
1056       /* Do not produce any dups. We can exit loop now */
1057       if (videorate->drop_only)
1058         break;
1059       /* continue while the first one was the best, if they were equal avoid
1060        * going into an infinite loop */
1061     }
1062     while (diff1 < diff2);
1063
1064     /* if we outputed the first buffer more then once, we have dups */
1065     if (count > 1) {
1066       videorate->dup += count - 1;
1067       if (!videorate->silent)
1068         gst_video_rate_notify_duplicate (videorate);
1069     }
1070     /* if we didn't output the first buffer, we have a drop */
1071     else if (count == 0) {
1072       videorate->drop++;
1073
1074       if (!videorate->silent)
1075         gst_video_rate_notify_drop (videorate);
1076
1077       GST_LOG_OBJECT (videorate,
1078           "new is best, old never used, drop, outgoing ts %"
1079           GST_TIME_FORMAT, GST_TIME_ARGS (videorate->next_ts));
1080     }
1081     GST_LOG_OBJECT (videorate,
1082         "END, putting new in old, diff1 %" GST_TIME_FORMAT
1083         ", diff2 %" GST_TIME_FORMAT ", next_ts %" GST_TIME_FORMAT
1084         ", in %" G_GUINT64_FORMAT ", out %" G_GUINT64_FORMAT ", drop %"
1085         G_GUINT64_FORMAT ", dup %" G_GUINT64_FORMAT, GST_TIME_ARGS (diff1),
1086         GST_TIME_ARGS (diff2), GST_TIME_ARGS (videorate->next_ts),
1087         videorate->in, videorate->out, videorate->drop, videorate->dup);
1088
1089     /* swap in new one when it's the best */
1090     gst_video_rate_swap_prev (videorate, buffer, intime);
1091   }
1092 done:
1093   return res;
1094
1095   /* ERRORS */
1096 not_negotiated:
1097   {
1098     GST_WARNING_OBJECT (videorate, "no framerate negotiated");
1099     res = GST_FLOW_NOT_NEGOTIATED;
1100     goto done;
1101   }
1102
1103 invalid_buffer:
1104   {
1105     GST_WARNING_OBJECT (videorate,
1106         "Got buffer with GST_CLOCK_TIME_NONE timestamp, discarding it");
1107     res = GST_BASE_TRANSFORM_FLOW_DROPPED;
1108     goto done;
1109   }
1110 }
1111
1112 static gboolean
1113 gst_video_rate_start (GstBaseTransform * trans)
1114 {
1115   gst_video_rate_reset (GST_VIDEO_RATE (trans));
1116   return TRUE;
1117 }
1118
1119 static gboolean
1120 gst_video_rate_stop (GstBaseTransform * trans)
1121 {
1122   gst_video_rate_reset (GST_VIDEO_RATE (trans));
1123   return TRUE;
1124 }
1125
1126 static void
1127 gst_video_rate_set_property (GObject * object,
1128     guint prop_id, const GValue * value, GParamSpec * pspec)
1129 {
1130   GstVideoRate *videorate = GST_VIDEO_RATE (object);
1131
1132   GST_OBJECT_LOCK (videorate);
1133   switch (prop_id) {
1134     case PROP_SILENT:
1135       videorate->silent = g_value_get_boolean (value);
1136       break;
1137     case PROP_NEW_PREF:
1138       videorate->new_pref = g_value_get_double (value);
1139       break;
1140     case PROP_SKIP_TO_FIRST:
1141       videorate->skip_to_first = g_value_get_boolean (value);
1142       break;
1143     case PROP_DROP_ONLY:
1144       videorate->drop_only = g_value_get_boolean (value);
1145       goto reconfigure;
1146       break;
1147     case PROP_AVERAGE_PERIOD:
1148       videorate->average_period_set = g_value_get_uint64 (value);
1149       break;
1150     case PROP_MAX_RATE:
1151       g_atomic_int_set (&videorate->max_rate, g_value_get_int (value));
1152       goto reconfigure;
1153       break;
1154     default:
1155       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1156       break;
1157   }
1158   GST_OBJECT_UNLOCK (videorate);
1159   return;
1160
1161 reconfigure:
1162   GST_OBJECT_UNLOCK (videorate);
1163   gst_base_transform_reconfigure (GST_BASE_TRANSFORM (videorate));
1164 }
1165
1166 static void
1167 gst_video_rate_get_property (GObject * object,
1168     guint prop_id, GValue * value, GParamSpec * pspec)
1169 {
1170   GstVideoRate *videorate = GST_VIDEO_RATE (object);
1171
1172   GST_OBJECT_LOCK (videorate);
1173   switch (prop_id) {
1174     case PROP_IN:
1175       g_value_set_uint64 (value, videorate->in);
1176       break;
1177     case PROP_OUT:
1178       g_value_set_uint64 (value, videorate->out);
1179       break;
1180     case PROP_DUP:
1181       g_value_set_uint64 (value, videorate->dup);
1182       break;
1183     case PROP_DROP:
1184       g_value_set_uint64 (value, videorate->drop);
1185       break;
1186     case PROP_SILENT:
1187       g_value_set_boolean (value, videorate->silent);
1188       break;
1189     case PROP_NEW_PREF:
1190       g_value_set_double (value, videorate->new_pref);
1191       break;
1192     case PROP_SKIP_TO_FIRST:
1193       g_value_set_boolean (value, videorate->skip_to_first);
1194       break;
1195     case PROP_DROP_ONLY:
1196       g_value_set_boolean (value, videorate->drop_only);
1197       break;
1198     case PROP_AVERAGE_PERIOD:
1199       g_value_set_uint64 (value, videorate->average_period_set);
1200       break;
1201     case PROP_MAX_RATE:
1202       g_value_set_int (value, g_atomic_int_get (&videorate->max_rate));
1203       break;
1204     default:
1205       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1206       break;
1207   }
1208   GST_OBJECT_UNLOCK (videorate);
1209 }
1210
1211 static gboolean
1212 plugin_init (GstPlugin * plugin)
1213 {
1214   GST_DEBUG_CATEGORY_INIT (video_rate_debug, "videorate", 0,
1215       "VideoRate stream fixer");
1216
1217   return gst_element_register (plugin, "videorate", GST_RANK_NONE,
1218       GST_TYPE_VIDEO_RATE);
1219 }
1220
1221 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
1222     GST_VERSION_MINOR,
1223     "videorate",
1224     "Adjusts video frames",
1225     plugin_init, VERSION, GST_LICENSE, GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)