basesink: Clamp the base time correctly in position reporting
[platform/upstream/gstreamer.git] / libs / gst / base / gstbasesink.c
1 /* GStreamer
2  * Copyright (C) 2005-2007 Wim Taymans <wim.taymans@gmail.com>
3  *
4  * gstbasesink.c: Base class for sink elements
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public
17  * License along with this library; if not, write to the
18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19  * Boston, MA 02111-1307, USA.
20  */
21
22 /**
23  * SECTION:gstbasesink
24  * @short_description: Base class for sink elements
25  * @see_also: #GstBaseTransform, #GstBaseSource
26  *
27  * #GstBaseSink is the base class for sink elements in GStreamer, such as
28  * xvimagesink or filesink. It is a layer on top of #GstElement that provides a
29  * simplified interface to plugin writers. #GstBaseSink handles many details
30  * for you, for example: preroll, clock synchronization, state changes,
31  * activation in push or pull mode, and queries.
32  *
33  * In most cases, when writing sink elements, there is no need to implement
34  * class methods from #GstElement or to set functions on pads, because the
35  * #GstBaseSink infrastructure should be sufficient.
36  *
37  * #GstBaseSink provides support for exactly one sink pad, which should be
38  * named "sink". A sink implementation (subclass of #GstBaseSink) should
39  * install a pad template in its base_init function, like so:
40  * <programlisting>
41  * static void
42  * my_element_base_init (gpointer g_class)
43  * {
44  *   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
45  *
46  *   // sinktemplate should be a #GstStaticPadTemplate with direction
47  *   // #GST_PAD_SINK and name "sink"
48  *   gst_element_class_add_pad_template (gstelement_class,
49  *       gst_static_pad_template_get (&amp;sinktemplate));
50  *   // see #GstElementDetails
51  *   gst_element_class_set_details (gstelement_class, &amp;details);
52  * }
53  * </programlisting>
54  *
55  * #GstBaseSink will handle the prerolling correctly. This means that it will
56  * return #GST_STATE_CHANGE_ASYNC from a state change to PAUSED until the first
57  * buffer arrives in this element. The base class will call the
58  * #GstBaseSink::preroll vmethod with this preroll buffer and will then commit
59  * the state change to the next asynchronously pending state.
60  *
61  * When the element is set to PLAYING, #GstBaseSink will synchronise on the
62  * clock using the times returned from ::get_times. If this function returns
63  * #GST_CLOCK_TIME_NONE for the start time, no synchronisation will be done.
64  * Synchronisation can be disabled entirely by setting the object "sync"
65  * property to %FALSE.
66  *
67  * After synchronisation the virtual method #GstBaseSink::render will be called.
68  * Subclasses should minimally implement this method.
69  *
70  * Since 0.10.3 subclasses that synchronise on the clock in the ::render method
71  * are supported as well. These classes typically receive a buffer in the render
72  * method and can then potentially block on the clock while rendering. A typical
73  * example is an audiosink. Since 0.10.11 these subclasses can use
74  * gst_base_sink_wait_preroll() to perform the blocking wait.
75  *
76  * Upon receiving the EOS event in the PLAYING state, #GstBaseSink will wait
77  * for the clock to reach the time indicated by the stop time of the last
78  * ::get_times call before posting an EOS message. When the element receives
79  * EOS in PAUSED, preroll completes, the event is queued and an EOS message is
80  * posted when going to PLAYING.
81  *
82  * #GstBaseSink will internally use the #GST_EVENT_NEWSEGMENT events to schedule
83  * synchronisation and clipping of buffers. Buffers that fall completely outside
84  * of the current segment are dropped. Buffers that fall partially in the
85  * segment are rendered (and prerolled). Subclasses should do any subbuffer
86  * clipping themselves when needed.
87  *
88  * #GstBaseSink will by default report the current playback position in
89  * #GST_FORMAT_TIME based on the current clock time and segment information.
90  * If no clock has been set on the element, the query will be forwarded
91  * upstream.
92  *
93  * The ::set_caps function will be called when the subclass should configure
94  * itself to process a specific media type.
95  *
96  * The ::start and ::stop virtual methods will be called when resources should
97  * be allocated. Any ::preroll, ::render  and ::set_caps function will be
98  * called between the ::start and ::stop calls.
99  *
100  * The ::event virtual method will be called when an event is received by
101  * #GstBaseSink. Normally this method should only be overriden by very specific
102  * elements (such as file sinks) which need to handle the newsegment event
103  * specially.
104  *
105  * #GstBaseSink provides an overridable ::buffer_alloc function that can be
106  * used by sinks that want to do reverse negotiation or to provide
107  * custom buffers (hardware buffers for example) to upstream elements.
108  *
109  * The ::unlock method is called when the elements should unblock any blocking
110  * operations they perform in the ::render method. This is mostly useful when
111  * the ::render method performs a blocking write on a file descriptor, for
112  * example.
113  *
114  * The max-lateness property affects how the sink deals with buffers that
115  * arrive too late in the sink. A buffer arrives too late in the sink when
116  * the presentation time (as a combination of the last segment, buffer
117  * timestamp and element base_time) plus the duration is before the current
118  * time of the clock.
119  * If the frame is later than max-lateness, the sink will drop the buffer
120  * without calling the render method.
121  * This feature is disabled if sync is disabled, the ::get-times method does
122  * not return a valid start time or max-lateness is set to -1 (the default).
123  * Subclasses can use gst_base_sink_set_max_lateness() to configure the
124  * max-lateness value.
125  *
126  * The qos property will enable the quality-of-service features of the basesink
127  * which gather statistics about the real-time performance of the clock
128  * synchronisation. For each buffer received in the sink, statistics are
129  * gathered and a QOS event is sent upstream with these numbers. This
130  * information can then be used by upstream elements to reduce their processing
131  * rate, for example.
132  *
133  * Since 0.10.15 the async property can be used to instruct the sink to never
134  * perform an ASYNC state change. This feature is mostly usable when dealing
135  * with non-synchronized streams or sparse streams.
136  *
137  * Last reviewed on 2007-08-29 (0.10.15)
138  */
139
140 #ifdef HAVE_CONFIG_H
141 #  include "config.h"
142 #endif
143
144 #include "gstbasesink.h"
145 #include <gst/gstmarshal.h>
146 #include <gst/gst_private.h>
147 #include <gst/gst-i18n-lib.h>
148
149 GST_DEBUG_CATEGORY_STATIC (gst_base_sink_debug);
150 #define GST_CAT_DEFAULT gst_base_sink_debug
151
152 #define GST_BASE_SINK_GET_PRIVATE(obj)  \
153    (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_BASE_SINK, GstBaseSinkPrivate))
154
155 #define GST_FLOW_STEP GST_FLOW_CUSTOM_ERROR
156
157 typedef struct
158 {
159   gboolean valid;               /* if this info is valid */
160   guint32 seqnum;               /* the seqnum of the STEP event */
161   GstFormat format;             /* the format of the amount */
162   guint64 amount;               /* the total amount of data to skip */
163   guint64 position;             /* the position in the stepped data */
164   guint64 duration;             /* the duration in time of the skipped data */
165   guint64 start;                /* running_time of the start */
166   gdouble rate;                 /* rate of skipping */
167   gdouble start_rate;           /* rate before skipping */
168   guint64 start_start;          /* start position skipping */
169   guint64 start_stop;           /* stop position skipping */
170   gboolean flush;               /* if this was a flushing step */
171   gboolean intermediate;        /* if this is an intermediate step */
172   gboolean need_preroll;        /* if we need preroll after this step */
173 } GstStepInfo;
174
175 /* FIXME, some stuff in ABI.data and other in Private...
176  * Make up your mind please.
177  */
178 struct _GstBaseSinkPrivate
179 {
180   gint qos_enabled;             /* ATOMIC */
181   gboolean async_enabled;
182   GstClockTimeDiff ts_offset;
183   GstClockTime render_delay;
184
185   /* start, stop of current buffer, stream time, used to report position */
186   GstClockTime current_sstart;
187   GstClockTime current_sstop;
188
189   /* start, stop and jitter of current buffer, running time */
190   GstClockTime current_rstart;
191   GstClockTime current_rstop;
192   GstClockTimeDiff current_jitter;
193
194   /* EOS sync time in running time */
195   GstClockTime eos_rtime;
196
197   /* last buffer that arrived in time, running time */
198   GstClockTime last_in_time;
199   /* when the last buffer left the sink, running time */
200   GstClockTime last_left;
201
202   /* running averages go here these are done on running time */
203   GstClockTime avg_pt;
204   GstClockTime avg_duration;
205   gdouble avg_rate;
206
207   /* these are done on system time. avg_jitter and avg_render are
208    * compared to eachother to see if the rendering time takes a
209    * huge amount of the processing, If so we are flooded with
210    * buffers. */
211   GstClockTime last_left_systime;
212   GstClockTime avg_jitter;
213   GstClockTime start, stop;
214   GstClockTime avg_render;
215
216   /* number of rendered and dropped frames */
217   guint64 rendered;
218   guint64 dropped;
219
220   /* latency stuff */
221   GstClockTime latency;
222
223   /* if we already commited the state */
224   gboolean commited;
225
226   /* when we received EOS */
227   gboolean received_eos;
228
229   /* when we are prerolled and able to report latency */
230   gboolean have_latency;
231
232   /* the last buffer we prerolled or rendered. Useful for making snapshots */
233   GstBuffer *last_buffer;
234
235   /* caps for pull based scheduling */
236   GstCaps *pull_caps;
237
238   /* blocksize for pulling */
239   guint blocksize;
240
241   gboolean discont;
242
243   /* seqnum of the stream */
244   guint32 seqnum;
245
246   gboolean call_preroll;
247   gboolean step_unlock;
248
249   /* we have a pending and a current step operation */
250   GstStepInfo current_step;
251   GstStepInfo pending_step;
252 };
253
254 #define DO_RUNNING_AVG(avg,val,size) (((val) + ((size)-1) * (avg)) / (size))
255
256 /* generic running average, this has a neutral window size */
257 #define UPDATE_RUNNING_AVG(avg,val)   DO_RUNNING_AVG(avg,val,8)
258
259 /* the windows for these running averages are experimentally obtained.
260  * possitive values get averaged more while negative values use a small
261  * window so we can react faster to badness. */
262 #define UPDATE_RUNNING_AVG_P(avg,val) DO_RUNNING_AVG(avg,val,16)
263 #define UPDATE_RUNNING_AVG_N(avg,val) DO_RUNNING_AVG(avg,val,4)
264
265 /* BaseSink properties */
266
267 #define DEFAULT_CAN_ACTIVATE_PULL FALSE /* fixme: enable me */
268 #define DEFAULT_CAN_ACTIVATE_PUSH TRUE
269
270 #define DEFAULT_PREROLL_QUEUE_LEN   0
271 #define DEFAULT_SYNC                TRUE
272 #define DEFAULT_MAX_LATENESS        -1
273 #define DEFAULT_QOS                 FALSE
274 #define DEFAULT_ASYNC               TRUE
275 #define DEFAULT_TS_OFFSET           0
276 #define DEFAULT_BLOCKSIZE           4096
277 #define DEFAULT_RENDER_DELAY        0
278
279 enum
280 {
281   PROP_0,
282   PROP_PREROLL_QUEUE_LEN,
283   PROP_SYNC,
284   PROP_MAX_LATENESS,
285   PROP_QOS,
286   PROP_ASYNC,
287   PROP_TS_OFFSET,
288   PROP_LAST_BUFFER,
289   PROP_BLOCKSIZE,
290   PROP_RENDER_DELAY,
291   PROP_LAST
292 };
293
294 static GstElementClass *parent_class = NULL;
295
296 static void gst_base_sink_class_init (GstBaseSinkClass * klass);
297 static void gst_base_sink_init (GstBaseSink * trans, gpointer g_class);
298 static void gst_base_sink_finalize (GObject * object);
299
300 GType
301 gst_base_sink_get_type (void)
302 {
303   static volatile gsize base_sink_type = 0;
304
305   if (g_once_init_enter (&base_sink_type)) {
306     GType _type;
307     static const GTypeInfo base_sink_info = {
308       sizeof (GstBaseSinkClass),
309       NULL,
310       NULL,
311       (GClassInitFunc) gst_base_sink_class_init,
312       NULL,
313       NULL,
314       sizeof (GstBaseSink),
315       0,
316       (GInstanceInitFunc) gst_base_sink_init,
317     };
318
319     _type = g_type_register_static (GST_TYPE_ELEMENT,
320         "GstBaseSink", &base_sink_info, G_TYPE_FLAG_ABSTRACT);
321     g_once_init_leave (&base_sink_type, _type);
322   }
323   return base_sink_type;
324 }
325
326 static void gst_base_sink_set_property (GObject * object, guint prop_id,
327     const GValue * value, GParamSpec * pspec);
328 static void gst_base_sink_get_property (GObject * object, guint prop_id,
329     GValue * value, GParamSpec * pspec);
330
331 static gboolean gst_base_sink_send_event (GstElement * element,
332     GstEvent * event);
333 static gboolean gst_base_sink_query (GstElement * element, GstQuery * query);
334
335 static GstCaps *gst_base_sink_get_caps (GstBaseSink * sink);
336 static gboolean gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps);
337 static GstFlowReturn gst_base_sink_buffer_alloc (GstBaseSink * sink,
338     guint64 offset, guint size, GstCaps * caps, GstBuffer ** buf);
339 static void gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
340     GstClockTime * start, GstClockTime * end);
341 static gboolean gst_base_sink_set_flushing (GstBaseSink * basesink,
342     GstPad * pad, gboolean flushing);
343 static gboolean gst_base_sink_default_activate_pull (GstBaseSink * basesink,
344     gboolean active);
345 static gboolean gst_base_sink_default_do_seek (GstBaseSink * sink,
346     GstSegment * segment);
347 static gboolean gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
348     GstEvent * event, GstSegment * segment);
349
350 static GstStateChangeReturn gst_base_sink_change_state (GstElement * element,
351     GstStateChange transition);
352
353 static GstFlowReturn gst_base_sink_chain (GstPad * pad, GstBuffer * buffer);
354 static GstFlowReturn gst_base_sink_chain_list (GstPad * pad,
355     GstBufferList * list);
356
357 static void gst_base_sink_loop (GstPad * pad);
358 static gboolean gst_base_sink_pad_activate (GstPad * pad);
359 static gboolean gst_base_sink_pad_activate_push (GstPad * pad, gboolean active);
360 static gboolean gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active);
361 static gboolean gst_base_sink_event (GstPad * pad, GstEvent * event);
362 static gboolean gst_base_sink_peer_query (GstBaseSink * sink, GstQuery * query);
363
364 static gboolean gst_base_sink_negotiate_pull (GstBaseSink * basesink);
365
366 /* check if an object was too late */
367 static gboolean gst_base_sink_is_too_late (GstBaseSink * basesink,
368     GstMiniObject * obj, GstClockTime start, GstClockTime stop,
369     GstClockReturn status, GstClockTimeDiff jitter);
370 static GstFlowReturn gst_base_sink_preroll_object (GstBaseSink * basesink,
371     gboolean is_list, GstMiniObject * obj);
372
373 static void
374 gst_base_sink_class_init (GstBaseSinkClass * klass)
375 {
376   GObjectClass *gobject_class;
377   GstElementClass *gstelement_class;
378
379   gobject_class = G_OBJECT_CLASS (klass);
380   gstelement_class = GST_ELEMENT_CLASS (klass);
381
382   GST_DEBUG_CATEGORY_INIT (gst_base_sink_debug, "basesink", 0,
383       "basesink element");
384
385   g_type_class_add_private (klass, sizeof (GstBaseSinkPrivate));
386
387   parent_class = g_type_class_peek_parent (klass);
388
389   gobject_class->finalize = gst_base_sink_finalize;
390   gobject_class->set_property = gst_base_sink_set_property;
391   gobject_class->get_property = gst_base_sink_get_property;
392
393   /* FIXME, this next value should be configured using an event from the
394    * upstream element, ie, the BUFFER_SIZE event. */
395   g_object_class_install_property (gobject_class, PROP_PREROLL_QUEUE_LEN,
396       g_param_spec_uint ("preroll-queue-len", "Preroll queue length",
397           "Number of buffers to queue during preroll", 0, G_MAXUINT,
398           DEFAULT_PREROLL_QUEUE_LEN,
399           G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
400
401   g_object_class_install_property (gobject_class, PROP_SYNC,
402       g_param_spec_boolean ("sync", "Sync", "Sync on the clock", DEFAULT_SYNC,
403           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
404
405   g_object_class_install_property (gobject_class, PROP_MAX_LATENESS,
406       g_param_spec_int64 ("max-lateness", "Max Lateness",
407           "Maximum number of nanoseconds that a buffer can be late before it "
408           "is dropped (-1 unlimited)", -1, G_MAXINT64, DEFAULT_MAX_LATENESS,
409           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
410
411   g_object_class_install_property (gobject_class, PROP_QOS,
412       g_param_spec_boolean ("qos", "Qos",
413           "Generate Quality-of-Service events upstream", DEFAULT_QOS,
414           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
415   /**
416    * GstBaseSink:async
417    *
418    * If set to #TRUE, the basesink will perform asynchronous state changes.
419    * When set to #FALSE, the sink will not signal the parent when it prerolls.
420    * Use this option when dealing with sparse streams or when synchronisation is
421    * not required.
422    *
423    * Since: 0.10.15
424    */
425   g_object_class_install_property (gobject_class, PROP_ASYNC,
426       g_param_spec_boolean ("async", "Async",
427           "Go asynchronously to PAUSED", DEFAULT_ASYNC,
428           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
429   /**
430    * GstBaseSink:ts-offset
431    *
432    * Controls the final synchronisation, a negative value will render the buffer
433    * earlier while a positive value delays playback. This property can be
434    * used to fix synchronisation in bad files.
435    *
436    * Since: 0.10.15
437    */
438   g_object_class_install_property (gobject_class, PROP_TS_OFFSET,
439       g_param_spec_int64 ("ts-offset", "TS Offset",
440           "Timestamp offset in nanoseconds", G_MININT64, G_MAXINT64,
441           DEFAULT_TS_OFFSET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
442   /**
443    * GstBaseSink:last-buffer
444    *
445    * The last buffer that arrived in the sink and was used for preroll or for
446    * rendering. This property can be used to generate thumbnails. This property
447    * can be NULL when the sink has not yet received a bufer.
448    *
449    * Since: 0.10.15
450    */
451   g_object_class_install_property (gobject_class, PROP_LAST_BUFFER,
452       gst_param_spec_mini_object ("last-buffer", "Last Buffer",
453           "The last buffer received in the sink", GST_TYPE_BUFFER,
454           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
455   /**
456    * GstBaseSink:blocksize
457    *
458    * The amount of bytes to pull when operating in pull mode.
459    *
460    * Since: 0.10.22
461    */
462   g_object_class_install_property (gobject_class, PROP_BLOCKSIZE,
463       g_param_spec_uint ("blocksize", "Block size",
464           "Size in bytes to pull per buffer (0 = default)", 0, G_MAXUINT,
465           DEFAULT_BLOCKSIZE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
466   /**
467    * GstBaseSink:render-delay
468    *
469    * The additional delay between synchronisation and actual rendering of the
470    * media. This property will add additional latency to the device in order to
471    * make other sinks compensate for the delay.
472    *
473    * Since: 0.10.22
474    */
475   g_object_class_install_property (gobject_class, PROP_RENDER_DELAY,
476       g_param_spec_uint64 ("render-delay", "Render Delay",
477           "Additional render delay of the sink in nanoseconds", 0, G_MAXUINT64,
478           DEFAULT_RENDER_DELAY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
479
480   gstelement_class->change_state =
481       GST_DEBUG_FUNCPTR (gst_base_sink_change_state);
482   gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_base_sink_send_event);
483   gstelement_class->query = GST_DEBUG_FUNCPTR (gst_base_sink_query);
484
485   klass->get_caps = GST_DEBUG_FUNCPTR (gst_base_sink_get_caps);
486   klass->set_caps = GST_DEBUG_FUNCPTR (gst_base_sink_set_caps);
487   klass->buffer_alloc = GST_DEBUG_FUNCPTR (gst_base_sink_buffer_alloc);
488   klass->get_times = GST_DEBUG_FUNCPTR (gst_base_sink_get_times);
489   klass->activate_pull =
490       GST_DEBUG_FUNCPTR (gst_base_sink_default_activate_pull);
491 }
492
493 static GstCaps *
494 gst_base_sink_pad_getcaps (GstPad * pad)
495 {
496   GstBaseSinkClass *bclass;
497   GstBaseSink *bsink;
498   GstCaps *caps = NULL;
499
500   bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
501   bclass = GST_BASE_SINK_GET_CLASS (bsink);
502
503   if (bsink->pad_mode == GST_ACTIVATE_PULL) {
504     /* if we are operating in pull mode we only accept the negotiated caps */
505     GST_OBJECT_LOCK (pad);
506     if ((caps = GST_PAD_CAPS (pad)))
507       gst_caps_ref (caps);
508     GST_OBJECT_UNLOCK (pad);
509   }
510   if (caps == NULL) {
511     if (bclass->get_caps)
512       caps = bclass->get_caps (bsink);
513
514     if (caps == NULL) {
515       GstPadTemplate *pad_template;
516
517       pad_template =
518           gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass),
519           "sink");
520       if (pad_template != NULL) {
521         caps = gst_caps_ref (gst_pad_template_get_caps (pad_template));
522       }
523     }
524   }
525   gst_object_unref (bsink);
526
527   return caps;
528 }
529
530 static gboolean
531 gst_base_sink_pad_setcaps (GstPad * pad, GstCaps * caps)
532 {
533   GstBaseSinkClass *bclass;
534   GstBaseSink *bsink;
535   gboolean res = TRUE;
536
537   bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
538   bclass = GST_BASE_SINK_GET_CLASS (bsink);
539
540   if (res && bclass->set_caps)
541     res = bclass->set_caps (bsink, caps);
542
543   gst_object_unref (bsink);
544
545   return res;
546 }
547
548 static void
549 gst_base_sink_pad_fixate (GstPad * pad, GstCaps * caps)
550 {
551   GstBaseSinkClass *bclass;
552   GstBaseSink *bsink;
553
554   bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
555   bclass = GST_BASE_SINK_GET_CLASS (bsink);
556
557   if (bclass->fixate)
558     bclass->fixate (bsink, caps);
559
560   gst_object_unref (bsink);
561 }
562
563 static GstFlowReturn
564 gst_base_sink_pad_buffer_alloc (GstPad * pad, guint64 offset, guint size,
565     GstCaps * caps, GstBuffer ** buf)
566 {
567   GstBaseSinkClass *bclass;
568   GstBaseSink *bsink;
569   GstFlowReturn result = GST_FLOW_OK;
570
571   bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
572   bclass = GST_BASE_SINK_GET_CLASS (bsink);
573
574   if (bclass->buffer_alloc)
575     result = bclass->buffer_alloc (bsink, offset, size, caps, buf);
576   else
577     *buf = NULL;                /* fallback in gstpad.c will allocate generic buffer */
578
579   gst_object_unref (bsink);
580
581   return result;
582 }
583
584 static void
585 gst_base_sink_init (GstBaseSink * basesink, gpointer g_class)
586 {
587   GstPadTemplate *pad_template;
588   GstBaseSinkPrivate *priv;
589
590   basesink->priv = priv = GST_BASE_SINK_GET_PRIVATE (basesink);
591
592   pad_template =
593       gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "sink");
594   g_return_if_fail (pad_template != NULL);
595
596   basesink->sinkpad = gst_pad_new_from_template (pad_template, "sink");
597
598   gst_pad_set_getcaps_function (basesink->sinkpad,
599       GST_DEBUG_FUNCPTR (gst_base_sink_pad_getcaps));
600   gst_pad_set_setcaps_function (basesink->sinkpad,
601       GST_DEBUG_FUNCPTR (gst_base_sink_pad_setcaps));
602   gst_pad_set_fixatecaps_function (basesink->sinkpad,
603       GST_DEBUG_FUNCPTR (gst_base_sink_pad_fixate));
604   gst_pad_set_bufferalloc_function (basesink->sinkpad,
605       GST_DEBUG_FUNCPTR (gst_base_sink_pad_buffer_alloc));
606   gst_pad_set_activate_function (basesink->sinkpad,
607       GST_DEBUG_FUNCPTR (gst_base_sink_pad_activate));
608   gst_pad_set_activatepush_function (basesink->sinkpad,
609       GST_DEBUG_FUNCPTR (gst_base_sink_pad_activate_push));
610   gst_pad_set_activatepull_function (basesink->sinkpad,
611       GST_DEBUG_FUNCPTR (gst_base_sink_pad_activate_pull));
612   gst_pad_set_event_function (basesink->sinkpad,
613       GST_DEBUG_FUNCPTR (gst_base_sink_event));
614   gst_pad_set_chain_function (basesink->sinkpad,
615       GST_DEBUG_FUNCPTR (gst_base_sink_chain));
616   gst_pad_set_chain_list_function (basesink->sinkpad,
617       GST_DEBUG_FUNCPTR (gst_base_sink_chain_list));
618   gst_element_add_pad (GST_ELEMENT_CAST (basesink), basesink->sinkpad);
619
620   basesink->pad_mode = GST_ACTIVATE_NONE;
621   basesink->preroll_queue = g_queue_new ();
622   basesink->abidata.ABI.clip_segment = gst_segment_new ();
623   priv->have_latency = FALSE;
624
625   basesink->can_activate_push = DEFAULT_CAN_ACTIVATE_PUSH;
626   basesink->can_activate_pull = DEFAULT_CAN_ACTIVATE_PULL;
627
628   basesink->sync = DEFAULT_SYNC;
629   basesink->abidata.ABI.max_lateness = DEFAULT_MAX_LATENESS;
630   g_atomic_int_set (&priv->qos_enabled, DEFAULT_QOS);
631   priv->async_enabled = DEFAULT_ASYNC;
632   priv->ts_offset = DEFAULT_TS_OFFSET;
633   priv->render_delay = DEFAULT_RENDER_DELAY;
634   priv->blocksize = DEFAULT_BLOCKSIZE;
635
636   GST_OBJECT_FLAG_SET (basesink, GST_ELEMENT_IS_SINK);
637 }
638
639 static void
640 gst_base_sink_finalize (GObject * object)
641 {
642   GstBaseSink *basesink;
643
644   basesink = GST_BASE_SINK (object);
645
646   g_queue_free (basesink->preroll_queue);
647   gst_segment_free (basesink->abidata.ABI.clip_segment);
648
649   G_OBJECT_CLASS (parent_class)->finalize (object);
650 }
651
652 /**
653  * gst_base_sink_set_sync:
654  * @sink: the sink
655  * @sync: the new sync value.
656  *
657  * Configures @sink to synchronize on the clock or not. When
658  * @sync is FALSE, incomming samples will be played as fast as
659  * possible. If @sync is TRUE, the timestamps of the incomming
660  * buffers will be used to schedule the exact render time of its
661  * contents.
662  *
663  * Since: 0.10.4
664  */
665 void
666 gst_base_sink_set_sync (GstBaseSink * sink, gboolean sync)
667 {
668   g_return_if_fail (GST_IS_BASE_SINK (sink));
669
670   GST_OBJECT_LOCK (sink);
671   sink->sync = sync;
672   GST_OBJECT_UNLOCK (sink);
673 }
674
675 /**
676  * gst_base_sink_get_sync:
677  * @sink: the sink
678  *
679  * Checks if @sink is currently configured to synchronize against the
680  * clock.
681  *
682  * Returns: TRUE if the sink is configured to synchronize against the clock.
683  *
684  * Since: 0.10.4
685  */
686 gboolean
687 gst_base_sink_get_sync (GstBaseSink * sink)
688 {
689   gboolean res;
690
691   g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
692
693   GST_OBJECT_LOCK (sink);
694   res = sink->sync;
695   GST_OBJECT_UNLOCK (sink);
696
697   return res;
698 }
699
700 /**
701  * gst_base_sink_set_max_lateness:
702  * @sink: the sink
703  * @max_lateness: the new max lateness value.
704  *
705  * Sets the new max lateness value to @max_lateness. This value is
706  * used to decide if a buffer should be dropped or not based on the
707  * buffer timestamp and the current clock time. A value of -1 means
708  * an unlimited time.
709  *
710  * Since: 0.10.4
711  */
712 void
713 gst_base_sink_set_max_lateness (GstBaseSink * sink, gint64 max_lateness)
714 {
715   g_return_if_fail (GST_IS_BASE_SINK (sink));
716
717   GST_OBJECT_LOCK (sink);
718   sink->abidata.ABI.max_lateness = max_lateness;
719   GST_OBJECT_UNLOCK (sink);
720 }
721
722 /**
723  * gst_base_sink_get_max_lateness:
724  * @sink: the sink
725  *
726  * Gets the max lateness value. See gst_base_sink_set_max_lateness for
727  * more details.
728  *
729  * Returns: The maximum time in nanoseconds that a buffer can be late
730  * before it is dropped and not rendered. A value of -1 means an
731  * unlimited time.
732  *
733  * Since: 0.10.4
734  */
735 gint64
736 gst_base_sink_get_max_lateness (GstBaseSink * sink)
737 {
738   gint64 res;
739
740   g_return_val_if_fail (GST_IS_BASE_SINK (sink), -1);
741
742   GST_OBJECT_LOCK (sink);
743   res = sink->abidata.ABI.max_lateness;
744   GST_OBJECT_UNLOCK (sink);
745
746   return res;
747 }
748
749 /**
750  * gst_base_sink_set_qos_enabled:
751  * @sink: the sink
752  * @enabled: the new qos value.
753  *
754  * Configures @sink to send Quality-of-Service events upstream.
755  *
756  * Since: 0.10.5
757  */
758 void
759 gst_base_sink_set_qos_enabled (GstBaseSink * sink, gboolean enabled)
760 {
761   g_return_if_fail (GST_IS_BASE_SINK (sink));
762
763   g_atomic_int_set (&sink->priv->qos_enabled, enabled);
764 }
765
766 /**
767  * gst_base_sink_is_qos_enabled:
768  * @sink: the sink
769  *
770  * Checks if @sink is currently configured to send Quality-of-Service events
771  * upstream.
772  *
773  * Returns: TRUE if the sink is configured to perform Quality-of-Service.
774  *
775  * Since: 0.10.5
776  */
777 gboolean
778 gst_base_sink_is_qos_enabled (GstBaseSink * sink)
779 {
780   gboolean res;
781
782   g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
783
784   res = g_atomic_int_get (&sink->priv->qos_enabled);
785
786   return res;
787 }
788
789 /**
790  * gst_base_sink_set_async_enabled:
791  * @sink: the sink
792  * @enabled: the new async value.
793  *
794  * Configures @sink to perform all state changes asynchronusly. When async is
795  * disabled, the sink will immediatly go to PAUSED instead of waiting for a
796  * preroll buffer. This feature is usefull if the sink does not synchronize
797  * against the clock or when it is dealing with sparse streams.
798  *
799  * Since: 0.10.15
800  */
801 void
802 gst_base_sink_set_async_enabled (GstBaseSink * sink, gboolean enabled)
803 {
804   g_return_if_fail (GST_IS_BASE_SINK (sink));
805
806   GST_PAD_PREROLL_LOCK (sink->sinkpad);
807   sink->priv->async_enabled = enabled;
808   GST_LOG_OBJECT (sink, "set async enabled to %d", enabled);
809   GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
810 }
811
812 /**
813  * gst_base_sink_is_async_enabled:
814  * @sink: the sink
815  *
816  * Checks if @sink is currently configured to perform asynchronous state
817  * changes to PAUSED.
818  *
819  * Returns: TRUE if the sink is configured to perform asynchronous state
820  * changes.
821  *
822  * Since: 0.10.15
823  */
824 gboolean
825 gst_base_sink_is_async_enabled (GstBaseSink * sink)
826 {
827   gboolean res;
828
829   g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
830
831   GST_PAD_PREROLL_LOCK (sink->sinkpad);
832   res = sink->priv->async_enabled;
833   GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
834
835   return res;
836 }
837
838 /**
839  * gst_base_sink_set_ts_offset:
840  * @sink: the sink
841  * @offset: the new offset
842  *
843  * Adjust the synchronisation of @sink with @offset. A negative value will
844  * render buffers earlier than their timestamp. A positive value will delay
845  * rendering. This function can be used to fix playback of badly timestamped
846  * buffers.
847  *
848  * Since: 0.10.15
849  */
850 void
851 gst_base_sink_set_ts_offset (GstBaseSink * sink, GstClockTimeDiff offset)
852 {
853   g_return_if_fail (GST_IS_BASE_SINK (sink));
854
855   GST_OBJECT_LOCK (sink);
856   sink->priv->ts_offset = offset;
857   GST_LOG_OBJECT (sink, "set time offset to %" G_GINT64_FORMAT, offset);
858   GST_OBJECT_UNLOCK (sink);
859 }
860
861 /**
862  * gst_base_sink_get_ts_offset:
863  * @sink: the sink
864  *
865  * Get the synchronisation offset of @sink.
866  *
867  * Returns: The synchronisation offset.
868  *
869  * Since: 0.10.15
870  */
871 GstClockTimeDiff
872 gst_base_sink_get_ts_offset (GstBaseSink * sink)
873 {
874   GstClockTimeDiff res;
875
876   g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
877
878   GST_OBJECT_LOCK (sink);
879   res = sink->priv->ts_offset;
880   GST_OBJECT_UNLOCK (sink);
881
882   return res;
883 }
884
885 /**
886  * gst_base_sink_get_last_buffer:
887  * @sink: the sink
888  *
889  * Get the last buffer that arrived in the sink and was used for preroll or for
890  * rendering. This property can be used to generate thumbnails.
891  *
892  * The #GstCaps on the buffer can be used to determine the type of the buffer.
893  *
894  * Returns: a #GstBuffer. gst_buffer_unref() after usage. This function returns
895  * NULL when no buffer has arrived in the sink yet or when the sink is not in
896  * PAUSED or PLAYING.
897  *
898  * Since: 0.10.15
899  */
900 GstBuffer *
901 gst_base_sink_get_last_buffer (GstBaseSink * sink)
902 {
903   GstBuffer *res;
904
905   g_return_val_if_fail (GST_IS_BASE_SINK (sink), NULL);
906
907   GST_OBJECT_LOCK (sink);
908   if ((res = sink->priv->last_buffer))
909     gst_buffer_ref (res);
910   GST_OBJECT_UNLOCK (sink);
911
912   return res;
913 }
914
915 static void
916 gst_base_sink_set_last_buffer (GstBaseSink * sink, GstBuffer * buffer)
917 {
918   GstBuffer *old;
919
920   GST_OBJECT_LOCK (sink);
921   old = sink->priv->last_buffer;
922   if (G_LIKELY (old != buffer)) {
923     GST_DEBUG_OBJECT (sink, "setting last buffer to %p", buffer);
924     if (G_LIKELY (buffer))
925       gst_buffer_ref (buffer);
926     sink->priv->last_buffer = buffer;
927   } else {
928     old = NULL;
929   }
930   GST_OBJECT_UNLOCK (sink);
931
932   /* avoid unreffing with the lock because cleanup code might want to take the
933    * lock too */
934   if (G_LIKELY (old))
935     gst_buffer_unref (old);
936 }
937
938 /**
939  * gst_base_sink_get_latency:
940  * @sink: the sink
941  *
942  * Get the currently configured latency.
943  *
944  * Returns: The configured latency.
945  *
946  * Since: 0.10.12
947  */
948 GstClockTime
949 gst_base_sink_get_latency (GstBaseSink * sink)
950 {
951   GstClockTime res;
952
953   GST_OBJECT_LOCK (sink);
954   res = sink->priv->latency;
955   GST_OBJECT_UNLOCK (sink);
956
957   return res;
958 }
959
960 /**
961  * gst_base_sink_query_latency:
962  * @sink: the sink
963  * @live: if the sink is live
964  * @upstream_live: if an upstream element is live
965  * @min_latency: the min latency of the upstream elements
966  * @max_latency: the max latency of the upstream elements
967  *
968  * Query the sink for the latency parameters. The latency will be queried from
969  * the upstream elements. @live will be TRUE if @sink is configured to
970  * synchronize against the clock. @upstream_live will be TRUE if an upstream
971  * element is live.
972  *
973  * If both @live and @upstream_live are TRUE, the sink will want to compensate
974  * for the latency introduced by the upstream elements by setting the
975  * @min_latency to a strictly possitive value.
976  *
977  * This function is mostly used by subclasses.
978  *
979  * Returns: TRUE if the query succeeded.
980  *
981  * Since: 0.10.12
982  */
983 gboolean
984 gst_base_sink_query_latency (GstBaseSink * sink, gboolean * live,
985     gboolean * upstream_live, GstClockTime * min_latency,
986     GstClockTime * max_latency)
987 {
988   gboolean l, us_live, res, have_latency;
989   GstClockTime min, max, render_delay;
990   GstQuery *query;
991   GstClockTime us_min, us_max;
992
993   /* we are live when we sync to the clock */
994   GST_OBJECT_LOCK (sink);
995   l = sink->sync;
996   have_latency = sink->priv->have_latency;
997   render_delay = sink->priv->render_delay;
998   GST_OBJECT_UNLOCK (sink);
999
1000   /* assume no latency */
1001   min = 0;
1002   max = -1;
1003   us_live = FALSE;
1004
1005   if (have_latency) {
1006     GST_DEBUG_OBJECT (sink, "we are ready for LATENCY query");
1007     /* we are ready for a latency query this is when we preroll or when we are
1008      * not async. */
1009     query = gst_query_new_latency ();
1010
1011     /* ask the peer for the latency */
1012     if ((res = gst_base_sink_peer_query (sink, query))) {
1013       /* get upstream min and max latency */
1014       gst_query_parse_latency (query, &us_live, &us_min, &us_max);
1015
1016       if (us_live) {
1017         /* upstream live, use its latency, subclasses should use these
1018          * values to create the complete latency. */
1019         min = us_min;
1020         max = us_max;
1021       }
1022       if (l) {
1023         /* we need to add the render delay if we are live */
1024         if (min != -1)
1025           min += render_delay;
1026         if (max != -1)
1027           max += render_delay;
1028       }
1029     }
1030     gst_query_unref (query);
1031   } else {
1032     GST_DEBUG_OBJECT (sink, "we are not yet ready for LATENCY query");
1033     res = FALSE;
1034   }
1035
1036   /* not live, we tried to do the query, if it failed we return TRUE anyway */
1037   if (!res) {
1038     if (!l) {
1039       res = TRUE;
1040       GST_DEBUG_OBJECT (sink, "latency query failed but we are not live");
1041     } else {
1042       GST_DEBUG_OBJECT (sink, "latency query failed and we are live");
1043     }
1044   }
1045
1046   if (res) {
1047     GST_DEBUG_OBJECT (sink, "latency query: live: %d, have_latency %d,"
1048         " upstream: %d, min %" GST_TIME_FORMAT ", max %" GST_TIME_FORMAT, l,
1049         have_latency, us_live, GST_TIME_ARGS (min), GST_TIME_ARGS (max));
1050
1051     if (live)
1052       *live = l;
1053     if (upstream_live)
1054       *upstream_live = us_live;
1055     if (min_latency)
1056       *min_latency = min;
1057     if (max_latency)
1058       *max_latency = max;
1059   }
1060   return res;
1061 }
1062
1063 /**
1064  * gst_base_sink_set_render_delay:
1065  * @sink: a #GstBaseSink
1066  * @delay: the new delay
1067  *
1068  * Set the render delay in @sink to @delay. The render delay is the time
1069  * between actual rendering of a buffer and its synchronisation time. Some
1070  * devices might delay media rendering which can be compensated for with this
1071  * function.
1072  *
1073  * After calling this function, this sink will report additional latency and
1074  * other sinks will adjust their latency to delay the rendering of their media.
1075  *
1076  * This function is usually called by subclasses.
1077  *
1078  * Since: 0.10.21
1079  */
1080 void
1081 gst_base_sink_set_render_delay (GstBaseSink * sink, GstClockTime delay)
1082 {
1083   GstClockTime old_render_delay;
1084
1085   g_return_if_fail (GST_IS_BASE_SINK (sink));
1086
1087   GST_OBJECT_LOCK (sink);
1088   old_render_delay = sink->priv->render_delay;
1089   sink->priv->render_delay = delay;
1090   GST_LOG_OBJECT (sink, "set render delay to %" GST_TIME_FORMAT,
1091       GST_TIME_ARGS (delay));
1092   GST_OBJECT_UNLOCK (sink);
1093
1094   if (delay != old_render_delay) {
1095     GST_DEBUG_OBJECT (sink, "posting latency changed");
1096     gst_element_post_message (GST_ELEMENT_CAST (sink),
1097         gst_message_new_latency (GST_OBJECT_CAST (sink)));
1098   }
1099 }
1100
1101 /**
1102  * gst_base_sink_get_render_delay:
1103  * @sink: a #GstBaseSink
1104  *
1105  * Get the render delay of @sink. see gst_base_sink_set_render_delay() for more
1106  * information about the render delay.
1107  *
1108  * Returns: the render delay of @sink.
1109  *
1110  * Since: 0.10.21
1111  */
1112 GstClockTime
1113 gst_base_sink_get_render_delay (GstBaseSink * sink)
1114 {
1115   GstClockTimeDiff res;
1116
1117   g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1118
1119   GST_OBJECT_LOCK (sink);
1120   res = sink->priv->render_delay;
1121   GST_OBJECT_UNLOCK (sink);
1122
1123   return res;
1124 }
1125
1126 /**
1127  * gst_base_sink_set_blocksize:
1128  * @sink: a #GstBaseSink
1129  * @blocksize: the blocksize in bytes
1130  *
1131  * Set the number of bytes that the sink will pull when it is operating in pull
1132  * mode.
1133  *
1134  * Since: 0.10.22
1135  */
1136 void
1137 gst_base_sink_set_blocksize (GstBaseSink * sink, guint blocksize)
1138 {
1139   g_return_if_fail (GST_IS_BASE_SINK (sink));
1140
1141   GST_OBJECT_LOCK (sink);
1142   sink->priv->blocksize = blocksize;
1143   GST_LOG_OBJECT (sink, "set blocksize to %u", blocksize);
1144   GST_OBJECT_UNLOCK (sink);
1145 }
1146
1147 /**
1148  * gst_base_sink_get_blocksize:
1149  * @sink: a #GstBaseSink
1150  *
1151  * Get the number of bytes that the sink will pull when it is operating in pull
1152  * mode.
1153  *
1154  * Returns: the number of bytes @sink will pull in pull mode.
1155  *
1156  * Since: 0.10.22
1157  */
1158 guint
1159 gst_base_sink_get_blocksize (GstBaseSink * sink)
1160 {
1161   guint res;
1162
1163   g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1164
1165   GST_OBJECT_LOCK (sink);
1166   res = sink->priv->blocksize;
1167   GST_OBJECT_UNLOCK (sink);
1168
1169   return res;
1170 }
1171
1172 static void
1173 gst_base_sink_set_property (GObject * object, guint prop_id,
1174     const GValue * value, GParamSpec * pspec)
1175 {
1176   GstBaseSink *sink = GST_BASE_SINK (object);
1177
1178   switch (prop_id) {
1179     case PROP_PREROLL_QUEUE_LEN:
1180       /* preroll lock necessary to serialize with finish_preroll */
1181       GST_PAD_PREROLL_LOCK (sink->sinkpad);
1182       sink->preroll_queue_max_len = g_value_get_uint (value);
1183       GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
1184       break;
1185     case PROP_SYNC:
1186       gst_base_sink_set_sync (sink, g_value_get_boolean (value));
1187       break;
1188     case PROP_MAX_LATENESS:
1189       gst_base_sink_set_max_lateness (sink, g_value_get_int64 (value));
1190       break;
1191     case PROP_QOS:
1192       gst_base_sink_set_qos_enabled (sink, g_value_get_boolean (value));
1193       break;
1194     case PROP_ASYNC:
1195       gst_base_sink_set_async_enabled (sink, g_value_get_boolean (value));
1196       break;
1197     case PROP_TS_OFFSET:
1198       gst_base_sink_set_ts_offset (sink, g_value_get_int64 (value));
1199       break;
1200     case PROP_BLOCKSIZE:
1201       gst_base_sink_set_blocksize (sink, g_value_get_uint (value));
1202       break;
1203     case PROP_RENDER_DELAY:
1204       gst_base_sink_set_render_delay (sink, g_value_get_uint64 (value));
1205       break;
1206     default:
1207       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1208       break;
1209   }
1210 }
1211
1212 static void
1213 gst_base_sink_get_property (GObject * object, guint prop_id, GValue * value,
1214     GParamSpec * pspec)
1215 {
1216   GstBaseSink *sink = GST_BASE_SINK (object);
1217
1218   switch (prop_id) {
1219     case PROP_PREROLL_QUEUE_LEN:
1220       GST_PAD_PREROLL_LOCK (sink->sinkpad);
1221       g_value_set_uint (value, sink->preroll_queue_max_len);
1222       GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
1223       break;
1224     case PROP_SYNC:
1225       g_value_set_boolean (value, gst_base_sink_get_sync (sink));
1226       break;
1227     case PROP_MAX_LATENESS:
1228       g_value_set_int64 (value, gst_base_sink_get_max_lateness (sink));
1229       break;
1230     case PROP_QOS:
1231       g_value_set_boolean (value, gst_base_sink_is_qos_enabled (sink));
1232       break;
1233     case PROP_ASYNC:
1234       g_value_set_boolean (value, gst_base_sink_is_async_enabled (sink));
1235       break;
1236     case PROP_TS_OFFSET:
1237       g_value_set_int64 (value, gst_base_sink_get_ts_offset (sink));
1238       break;
1239     case PROP_LAST_BUFFER:
1240       gst_value_take_buffer (value, gst_base_sink_get_last_buffer (sink));
1241       break;
1242     case PROP_BLOCKSIZE:
1243       g_value_set_uint (value, gst_base_sink_get_blocksize (sink));
1244       break;
1245     case PROP_RENDER_DELAY:
1246       g_value_set_uint64 (value, gst_base_sink_get_render_delay (sink));
1247       break;
1248     default:
1249       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1250       break;
1251   }
1252 }
1253
1254
1255 static GstCaps *
1256 gst_base_sink_get_caps (GstBaseSink * sink)
1257 {
1258   return NULL;
1259 }
1260
1261 static gboolean
1262 gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps)
1263 {
1264   return TRUE;
1265 }
1266
1267 static GstFlowReturn
1268 gst_base_sink_buffer_alloc (GstBaseSink * sink, guint64 offset, guint size,
1269     GstCaps * caps, GstBuffer ** buf)
1270 {
1271   *buf = NULL;
1272   return GST_FLOW_OK;
1273 }
1274
1275 /* with PREROLL_LOCK, STREAM_LOCK */
1276 static void
1277 gst_base_sink_preroll_queue_flush (GstBaseSink * basesink, GstPad * pad)
1278 {
1279   GstMiniObject *obj;
1280
1281   GST_DEBUG_OBJECT (basesink, "flushing queue %p", basesink);
1282   while ((obj = g_queue_pop_head (basesink->preroll_queue))) {
1283     GST_DEBUG_OBJECT (basesink, "popped %p", obj);
1284     gst_mini_object_unref (obj);
1285   }
1286   /* we can't have EOS anymore now */
1287   basesink->eos = FALSE;
1288   basesink->priv->received_eos = FALSE;
1289   basesink->have_preroll = FALSE;
1290   basesink->priv->step_unlock = FALSE;
1291   basesink->eos_queued = FALSE;
1292   basesink->preroll_queued = 0;
1293   basesink->buffers_queued = 0;
1294   basesink->events_queued = 0;
1295   /* can't report latency anymore until we preroll again */
1296   if (basesink->priv->async_enabled) {
1297     GST_OBJECT_LOCK (basesink);
1298     basesink->priv->have_latency = FALSE;
1299     GST_OBJECT_UNLOCK (basesink);
1300   }
1301   /* and signal any waiters now */
1302   GST_PAD_PREROLL_SIGNAL (pad);
1303 }
1304
1305 /* with STREAM_LOCK, configures given segment with the event information. */
1306 static void
1307 gst_base_sink_configure_segment (GstBaseSink * basesink, GstPad * pad,
1308     GstEvent * event, GstSegment * segment)
1309 {
1310   gboolean update;
1311   gdouble rate, arate;
1312   GstFormat format;
1313   gint64 start;
1314   gint64 stop;
1315   gint64 time;
1316
1317   /* the newsegment event is needed to bring the buffer timestamps to the
1318    * stream time and to drop samples outside of the playback segment. */
1319   gst_event_parse_new_segment_full (event, &update, &rate, &arate, &format,
1320       &start, &stop, &time);
1321
1322   /* The segment is protected with both the STREAM_LOCK and the OBJECT_LOCK.
1323    * We protect with the OBJECT_LOCK so that we can use the values to
1324    * safely answer a POSITION query. */
1325   GST_OBJECT_LOCK (basesink);
1326   gst_segment_set_newsegment_full (segment, update, rate, arate, format, start,
1327       stop, time);
1328
1329   if (format == GST_FORMAT_TIME) {
1330     GST_DEBUG_OBJECT (basesink,
1331         "configured NEWSEGMENT update %d, rate %lf, applied rate %lf, "
1332         "format GST_FORMAT_TIME, "
1333         "%" GST_TIME_FORMAT " -- %" GST_TIME_FORMAT
1334         ", time %" GST_TIME_FORMAT ", accum %" GST_TIME_FORMAT,
1335         update, rate, arate, GST_TIME_ARGS (segment->start),
1336         GST_TIME_ARGS (segment->stop), GST_TIME_ARGS (segment->time),
1337         GST_TIME_ARGS (segment->accum));
1338   } else {
1339     GST_DEBUG_OBJECT (basesink,
1340         "configured NEWSEGMENT update %d, rate %lf, applied rate %lf, "
1341         "format %d, "
1342         "%" G_GINT64_FORMAT " -- %" G_GINT64_FORMAT ", time %"
1343         G_GINT64_FORMAT ", accum %" G_GINT64_FORMAT, update, rate, arate,
1344         segment->format, segment->start, segment->stop, segment->time,
1345         segment->accum);
1346   }
1347   GST_OBJECT_UNLOCK (basesink);
1348 }
1349
1350 /* with PREROLL_LOCK, STREAM_LOCK */
1351 static gboolean
1352 gst_base_sink_commit_state (GstBaseSink * basesink)
1353 {
1354   /* commit state and proceed to next pending state */
1355   GstState current, next, pending, post_pending;
1356   gboolean post_paused = FALSE;
1357   gboolean post_async_done = FALSE;
1358   gboolean post_playing = FALSE;
1359
1360   /* we are certainly not playing async anymore now */
1361   basesink->playing_async = FALSE;
1362
1363   GST_OBJECT_LOCK (basesink);
1364   current = GST_STATE (basesink);
1365   next = GST_STATE_NEXT (basesink);
1366   pending = GST_STATE_PENDING (basesink);
1367   post_pending = pending;
1368
1369   switch (pending) {
1370     case GST_STATE_PLAYING:
1371     {
1372       GstBaseSinkClass *bclass;
1373       GstStateChangeReturn ret;
1374
1375       bclass = GST_BASE_SINK_GET_CLASS (basesink);
1376
1377       GST_DEBUG_OBJECT (basesink, "commiting state to PLAYING");
1378
1379       basesink->need_preroll = FALSE;
1380       post_async_done = TRUE;
1381       basesink->priv->commited = TRUE;
1382       post_playing = TRUE;
1383       /* post PAUSED too when we were READY */
1384       if (current == GST_STATE_READY) {
1385         post_paused = TRUE;
1386       }
1387
1388       /* make sure we notify the subclass of async playing */
1389       if (bclass->async_play) {
1390         GST_WARNING_OBJECT (basesink, "deprecated async_play");
1391         ret = bclass->async_play (basesink);
1392         if (ret == GST_STATE_CHANGE_FAILURE)
1393           goto async_failed;
1394       }
1395       break;
1396     }
1397     case GST_STATE_PAUSED:
1398       GST_DEBUG_OBJECT (basesink, "commiting state to PAUSED");
1399       post_paused = TRUE;
1400       post_async_done = TRUE;
1401       basesink->priv->commited = TRUE;
1402       post_pending = GST_STATE_VOID_PENDING;
1403       break;
1404     case GST_STATE_READY:
1405     case GST_STATE_NULL:
1406       goto stopping;
1407     case GST_STATE_VOID_PENDING:
1408       goto nothing_pending;
1409     default:
1410       break;
1411   }
1412
1413   /* we can report latency queries now */
1414   basesink->priv->have_latency = TRUE;
1415
1416   GST_STATE (basesink) = pending;
1417   GST_STATE_NEXT (basesink) = GST_STATE_VOID_PENDING;
1418   GST_STATE_PENDING (basesink) = GST_STATE_VOID_PENDING;
1419   GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_SUCCESS;
1420   GST_OBJECT_UNLOCK (basesink);
1421
1422   if (post_paused) {
1423     GST_DEBUG_OBJECT (basesink, "posting PAUSED state change message");
1424     gst_element_post_message (GST_ELEMENT_CAST (basesink),
1425         gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1426             current, next, post_pending));
1427   }
1428   if (post_async_done) {
1429     GST_DEBUG_OBJECT (basesink, "posting async-done message");
1430     gst_element_post_message (GST_ELEMENT_CAST (basesink),
1431         gst_message_new_async_done (GST_OBJECT_CAST (basesink)));
1432   }
1433   if (post_playing) {
1434     GST_DEBUG_OBJECT (basesink, "posting PLAYING state change message");
1435     gst_element_post_message (GST_ELEMENT_CAST (basesink),
1436         gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1437             next, pending, GST_STATE_VOID_PENDING));
1438   }
1439
1440   GST_STATE_BROADCAST (basesink);
1441
1442   return TRUE;
1443
1444 nothing_pending:
1445   {
1446     /* Depending on the state, set our vars. We get in this situation when the
1447      * state change function got a change to update the state vars before the
1448      * streaming thread did. This is fine but we need to make sure that we
1449      * update the need_preroll var since it was TRUE when we got here and might
1450      * become FALSE if we got to PLAYING. */
1451     GST_DEBUG_OBJECT (basesink, "nothing to commit, now in %s",
1452         gst_element_state_get_name (current));
1453     switch (current) {
1454       case GST_STATE_PLAYING:
1455         basesink->need_preroll = FALSE;
1456         break;
1457       case GST_STATE_PAUSED:
1458         basesink->need_preroll = TRUE;
1459         break;
1460       default:
1461         basesink->need_preroll = FALSE;
1462         basesink->flushing = TRUE;
1463         break;
1464     }
1465     /* we can report latency queries now */
1466     basesink->priv->have_latency = TRUE;
1467     GST_OBJECT_UNLOCK (basesink);
1468     return TRUE;
1469   }
1470 stopping:
1471   {
1472     /* app is going to READY */
1473     GST_DEBUG_OBJECT (basesink, "stopping");
1474     basesink->need_preroll = FALSE;
1475     basesink->flushing = TRUE;
1476     GST_OBJECT_UNLOCK (basesink);
1477     return FALSE;
1478   }
1479 async_failed:
1480   {
1481     GST_DEBUG_OBJECT (basesink, "async commit failed");
1482     GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_FAILURE;
1483     GST_OBJECT_UNLOCK (basesink);
1484     return FALSE;
1485   }
1486 }
1487
1488 static void
1489 start_stepping (GstBaseSink * sink, GstSegment * segment,
1490     GstStepInfo * pending, GstStepInfo * current)
1491 {
1492   gint64 end;
1493   GstMessage *message;
1494
1495   GST_DEBUG_OBJECT (sink, "update pending step");
1496
1497   GST_OBJECT_LOCK (sink);
1498   memcpy (current, pending, sizeof (GstStepInfo));
1499   pending->valid = FALSE;
1500   GST_OBJECT_UNLOCK (sink);
1501
1502   /* post message first */
1503   message =
1504       gst_message_new_step_start (GST_OBJECT (sink), TRUE, current->format,
1505       current->amount, current->rate, current->flush, current->intermediate);
1506   gst_message_set_seqnum (message, current->seqnum);
1507   gst_element_post_message (GST_ELEMENT (sink), message);
1508
1509   /* get the running time of where we paused and remember it */
1510   current->start = gst_element_get_start_time (GST_ELEMENT_CAST (sink));
1511   gst_segment_set_running_time (segment, GST_FORMAT_TIME, current->start);
1512
1513   /* set the new rate for the remainder of the segment */
1514   current->start_rate = segment->rate;
1515   segment->rate *= current->rate;
1516   segment->abs_rate = ABS (segment->rate);
1517
1518   /* save values */
1519   if (segment->rate > 0.0)
1520     current->start_stop = segment->stop;
1521   else
1522     current->start_start = segment->start;
1523
1524   if (current->format == GST_FORMAT_TIME) {
1525     end = current->start + current->amount;
1526     if (!current->flush) {
1527       /* update the segment clipping regions for non-flushing seeks */
1528       if (segment->rate > 0.0) {
1529         segment->stop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1530         segment->last_stop = segment->stop;
1531       } else {
1532         gint64 position;
1533
1534         position = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1535         segment->time = position;
1536         segment->start = position;
1537         segment->last_stop = position;
1538       }
1539     }
1540   }
1541
1542   GST_DEBUG_OBJECT (sink,
1543       "segment now rate %lf, applied rate %lf, "
1544       "format GST_FORMAT_TIME, "
1545       "%" GST_TIME_FORMAT " -- %" GST_TIME_FORMAT
1546       ", time %" GST_TIME_FORMAT ", accum %" GST_TIME_FORMAT,
1547       segment->rate, segment->applied_rate, GST_TIME_ARGS (segment->start),
1548       GST_TIME_ARGS (segment->stop), GST_TIME_ARGS (segment->time),
1549       GST_TIME_ARGS (segment->accum));
1550
1551   GST_DEBUG_OBJECT (sink, "step started at running_time %" GST_TIME_FORMAT,
1552       GST_TIME_ARGS (current->start));
1553
1554   if (current->amount == -1) {
1555     GST_DEBUG_OBJECT (sink, "step amount == -1, stop stepping");
1556     current->valid = FALSE;
1557   } else {
1558     GST_DEBUG_OBJECT (sink, "step amount: %" G_GUINT64_FORMAT ", format: %s, "
1559         "rate: %f", current->amount, gst_format_get_name (current->format),
1560         current->rate);
1561   }
1562 }
1563
1564 static void
1565 stop_stepping (GstBaseSink * sink, GstSegment * segment,
1566     GstStepInfo * current, gint64 rstart, gint64 rstop, gboolean eos)
1567 {
1568   gint64 stop, position;
1569   GstMessage *message;
1570
1571   GST_DEBUG_OBJECT (sink, "step complete");
1572
1573   if (segment->rate > 0.0)
1574     stop = rstart;
1575   else
1576     stop = rstop;
1577
1578   GST_DEBUG_OBJECT (sink,
1579       "step stop at running_time %" GST_TIME_FORMAT, GST_TIME_ARGS (stop));
1580
1581   if (stop == -1)
1582     current->duration = current->position;
1583   else
1584     current->duration = stop - current->start;
1585
1586   GST_DEBUG_OBJECT (sink, "step elapsed running_time %" GST_TIME_FORMAT,
1587       GST_TIME_ARGS (current->duration));
1588
1589   position = current->start + current->duration;
1590
1591   /* now move the segment to the new running time */
1592   gst_segment_set_running_time (segment, GST_FORMAT_TIME, position);
1593
1594   if (current->flush) {
1595     /* and remove the accumulated time we flushed, start time did not change */
1596     segment->accum = current->start;
1597   } else {
1598     /* start time is now the stepped position */
1599     gst_element_set_start_time (GST_ELEMENT_CAST (sink), position);
1600   }
1601
1602   /* restore the previous rate */
1603   segment->rate = current->start_rate;
1604   segment->abs_rate = ABS (segment->rate);
1605
1606   if (segment->rate > 0.0)
1607     segment->stop = current->start_stop;
1608   else
1609     segment->start = current->start_start;
1610
1611   /* the clip segment is used for position report in paused... */
1612   memcpy (sink->abidata.ABI.clip_segment, segment, sizeof (GstSegment));
1613
1614   /* post the step done when we know the stepped duration in TIME */
1615   message =
1616       gst_message_new_step_done (GST_OBJECT_CAST (sink), current->format,
1617       current->amount, current->rate, current->flush, current->intermediate,
1618       current->duration, eos);
1619   gst_message_set_seqnum (message, current->seqnum);
1620   gst_element_post_message (GST_ELEMENT_CAST (sink), message);
1621
1622   if (!current->intermediate)
1623     sink->need_preroll = current->need_preroll;
1624
1625   /* and the current step info finished and becomes invalid */
1626   current->valid = FALSE;
1627 }
1628
1629 static gboolean
1630 handle_stepping (GstBaseSink * sink, GstSegment * segment,
1631     GstStepInfo * current, gint64 * cstart, gint64 * cstop, gint64 * rstart,
1632     gint64 * rstop)
1633 {
1634   gboolean step_end = FALSE;
1635
1636   /* see if we need to skip this buffer because of stepping */
1637   switch (current->format) {
1638     case GST_FORMAT_TIME:
1639     {
1640       guint64 end;
1641       gint64 first, last;
1642
1643       if (segment->rate > 0.0) {
1644         first = *rstart;
1645         last = *rstop;
1646       } else {
1647         first = *rstop;
1648         last = *rstart;
1649       }
1650
1651       end = current->start + current->amount;
1652       current->position = first - current->start;
1653
1654       if (G_UNLIKELY (segment->abs_rate != 1.0))
1655         current->position /= segment->abs_rate;
1656
1657       GST_DEBUG_OBJECT (sink,
1658           "buffer: %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT,
1659           GST_TIME_ARGS (first), GST_TIME_ARGS (last));
1660       GST_DEBUG_OBJECT (sink,
1661           "got time step %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT "/%"
1662           GST_TIME_FORMAT, GST_TIME_ARGS (current->position),
1663           GST_TIME_ARGS (last - current->start),
1664           GST_TIME_ARGS (current->amount));
1665
1666       if ((current->flush && current->position >= current->amount)
1667           || last >= end) {
1668         GST_DEBUG_OBJECT (sink, "step ended, we need clipping");
1669         step_end = TRUE;
1670         if (segment->rate > 0.0) {
1671           *rstart = end;
1672           *cstart = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1673         } else {
1674           *rstop = end;
1675           *cstop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1676         }
1677       }
1678       GST_DEBUG_OBJECT (sink,
1679           "cstart %" GST_TIME_FORMAT ", rstart %" GST_TIME_FORMAT,
1680           GST_TIME_ARGS (*cstart), GST_TIME_ARGS (*rstart));
1681       GST_DEBUG_OBJECT (sink,
1682           "cstop %" GST_TIME_FORMAT ", rstop %" GST_TIME_FORMAT,
1683           GST_TIME_ARGS (*cstop), GST_TIME_ARGS (*rstop));
1684       break;
1685     }
1686     case GST_FORMAT_BUFFERS:
1687       GST_DEBUG_OBJECT (sink,
1688           "got default step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1689           current->position, current->amount);
1690
1691       if (current->position < current->amount) {
1692         current->position++;
1693       } else {
1694         step_end = TRUE;
1695       }
1696       break;
1697     case GST_FORMAT_DEFAULT:
1698     default:
1699       GST_DEBUG_OBJECT (sink,
1700           "got unknown step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1701           current->position, current->amount);
1702       break;
1703   }
1704   return step_end;
1705 }
1706
1707 /* with STREAM_LOCK, PREROLL_LOCK
1708  *
1709  * Returns TRUE if the object needs synchronisation and takes therefore
1710  * part in prerolling.
1711  *
1712  * rsstart/rsstop contain the start/stop in stream time.
1713  * rrstart/rrstop contain the start/stop in running time.
1714  */
1715 static gboolean
1716 gst_base_sink_get_sync_times (GstBaseSink * basesink, GstMiniObject * obj,
1717     GstClockTime * rsstart, GstClockTime * rsstop,
1718     GstClockTime * rrstart, GstClockTime * rrstop, gboolean * do_sync,
1719     gboolean * stepped, GstSegment * segment, GstStepInfo * step,
1720     gboolean * step_end)
1721 {
1722   GstBaseSinkClass *bclass;
1723   GstBuffer *buffer;
1724   GstClockTime start, stop;     /* raw start/stop timestamps */
1725   gint64 cstart, cstop;         /* clipped raw timestamps */
1726   gint64 rstart, rstop;         /* clipped timestamps converted to running time */
1727   GstClockTime sstart, sstop;   /* clipped timestamps converted to stream time */
1728   GstFormat format;
1729   GstBaseSinkPrivate *priv;
1730   gboolean eos;
1731
1732   priv = basesink->priv;
1733
1734   /* start with nothing */
1735   start = stop = GST_CLOCK_TIME_NONE;
1736
1737   if (G_UNLIKELY (GST_IS_EVENT (obj))) {
1738     GstEvent *event = GST_EVENT_CAST (obj);
1739
1740     switch (GST_EVENT_TYPE (event)) {
1741         /* EOS event needs syncing */
1742       case GST_EVENT_EOS:
1743       {
1744         if (basesink->segment.rate >= 0.0) {
1745           sstart = sstop = priv->current_sstop;
1746           if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1747             /* we have not seen a buffer yet, use the segment values */
1748             sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1749                 basesink->segment.format, basesink->segment.stop);
1750           }
1751         } else {
1752           sstart = sstop = priv->current_sstart;
1753           if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1754             /* we have not seen a buffer yet, use the segment values */
1755             sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1756                 basesink->segment.format, basesink->segment.start);
1757           }
1758         }
1759
1760         rstart = rstop = priv->eos_rtime;
1761         *do_sync = rstart != -1;
1762         GST_DEBUG_OBJECT (basesink, "sync times for EOS %" GST_TIME_FORMAT,
1763             GST_TIME_ARGS (rstart));
1764         /* if we are stepping, we end now */
1765         *step_end = step->valid;
1766         eos = TRUE;
1767         goto eos_done;
1768       }
1769       default:
1770         /* other events do not need syncing */
1771         /* FIXME, maybe NEWSEGMENT might need synchronisation
1772          * since the POSITION query depends on accumulated times and
1773          * we cannot accumulate the current segment before the previous
1774          * one completed.
1775          */
1776         return FALSE;
1777     }
1778   }
1779
1780   eos = FALSE;
1781
1782   /* else do buffer sync code */
1783   buffer = GST_BUFFER_CAST (obj);
1784
1785   bclass = GST_BASE_SINK_GET_CLASS (basesink);
1786
1787   /* just get the times to see if we need syncing, if the start returns -1 we
1788    * don't sync. */
1789   if (bclass->get_times)
1790     bclass->get_times (basesink, buffer, &start, &stop);
1791
1792   if (!GST_CLOCK_TIME_IS_VALID (start)) {
1793     /* we don't need to sync but we still want to get the timestamps for
1794      * tracking the position */
1795     gst_base_sink_get_times (basesink, buffer, &start, &stop);
1796     *do_sync = FALSE;
1797   } else {
1798     *do_sync = TRUE;
1799   }
1800
1801   GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
1802       ", stop: %" GST_TIME_FORMAT ", do_sync %d", GST_TIME_ARGS (start),
1803       GST_TIME_ARGS (stop), *do_sync);
1804
1805   /* collect segment and format for code clarity */
1806   format = segment->format;
1807
1808   /* no timestamp clipping if we did not get a TIME segment format */
1809   if (G_UNLIKELY (format != GST_FORMAT_TIME)) {
1810     cstart = start;
1811     cstop = stop;
1812     /* do running and stream time in TIME format */
1813     format = GST_FORMAT_TIME;
1814     GST_LOG_OBJECT (basesink, "not time format, don't clip");
1815     goto do_times;
1816   }
1817
1818   /* clip, only when we know about time */
1819   if (G_UNLIKELY (!gst_segment_clip (segment, GST_FORMAT_TIME,
1820               (gint64) start, (gint64) stop, &cstart, &cstop))) {
1821     if (step->valid) {
1822       GST_DEBUG_OBJECT (basesink, "step out of segment");
1823       /* when we are stepping, pretend we're at the end of the segment */
1824       if (segment->rate > 0.0) {
1825         cstart = segment->stop;
1826         cstop = segment->stop;
1827       } else {
1828         cstart = segment->start;
1829         cstop = segment->start;
1830       }
1831       goto do_times;
1832     }
1833     goto out_of_segment;
1834   }
1835
1836   if (G_UNLIKELY (start != cstart || stop != cstop)) {
1837     GST_DEBUG_OBJECT (basesink, "clipped to: start %" GST_TIME_FORMAT
1838         ", stop: %" GST_TIME_FORMAT, GST_TIME_ARGS (cstart),
1839         GST_TIME_ARGS (cstop));
1840   }
1841
1842   /* set last stop position */
1843   if (G_LIKELY (cstop != GST_CLOCK_TIME_NONE))
1844     gst_segment_set_last_stop (segment, GST_FORMAT_TIME, cstop);
1845   else
1846     gst_segment_set_last_stop (segment, GST_FORMAT_TIME, cstart);
1847
1848 do_times:
1849   rstart = gst_segment_to_running_time (segment, format, cstart);
1850   rstop = gst_segment_to_running_time (segment, format, cstop);
1851
1852   if (G_UNLIKELY (step->valid)) {
1853     if (!(*step_end = handle_stepping (basesink, segment, step, &cstart, &cstop,
1854                 &rstart, &rstop))) {
1855       /* step is still busy, we discard data when we are flushing */
1856       *stepped = step->flush;
1857       GST_DEBUG_OBJECT (basesink, "stepping busy");
1858     }
1859   }
1860   /* this can produce wrong values if we accumulated non-TIME segments. If this happens,
1861    * upstream is behaving very badly */
1862   sstart = gst_segment_to_stream_time (segment, format, cstart);
1863   sstop = gst_segment_to_stream_time (segment, format, cstop);
1864
1865 eos_done:
1866   /* eos_done label only called when doing EOS, we also stop stepping then */
1867   if (*step_end && step->flush) {
1868     GST_DEBUG_OBJECT (basesink, "flushing step ended");
1869     stop_stepping (basesink, segment, step, rstart, rstop, eos);
1870     *step_end = FALSE;
1871   }
1872
1873   /* save times */
1874   *rsstart = sstart;
1875   *rsstop = sstop;
1876   *rrstart = rstart;
1877   *rrstop = rstop;
1878
1879   /* buffers and EOS always need syncing and preroll */
1880   return TRUE;
1881
1882   /* special cases */
1883 out_of_segment:
1884   {
1885     /* we usually clip in the chain function already but stepping could cause
1886      * the segment to be updated later. we return FALSE so that we don't try
1887      * to sync on it. */
1888     GST_LOG_OBJECT (basesink, "buffer skipped, not in segment");
1889     return FALSE;
1890   }
1891 }
1892
1893 /* with STREAM_LOCK, PREROLL_LOCK, LOCK
1894  * adjust a timestamp with the latency and timestamp offset */
1895 static GstClockTime
1896 gst_base_sink_adjust_time (GstBaseSink * basesink, GstClockTime time)
1897 {
1898   GstClockTimeDiff ts_offset;
1899
1900   /* don't do anything funny with invalid timestamps */
1901   if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
1902     return time;
1903
1904   time += basesink->priv->latency;
1905
1906   /* apply offset, be carefull for underflows */
1907   ts_offset = basesink->priv->ts_offset;
1908   if (ts_offset < 0) {
1909     ts_offset = -ts_offset;
1910     if (ts_offset < time)
1911       time -= ts_offset;
1912     else
1913       time = 0;
1914   } else
1915     time += ts_offset;
1916
1917   return time;
1918 }
1919
1920 /**
1921  * gst_base_sink_wait_clock:
1922  * @sink: the sink
1923  * @time: the running_time to be reached
1924  * @jitter: the jitter to be filled with time diff (can be NULL)
1925  *
1926  * This function will block until @time is reached. It is usually called by
1927  * subclasses that use their own internal synchronisation.
1928  *
1929  * If @time is not valid, no sycnhronisation is done and #GST_CLOCK_BADTIME is
1930  * returned. Likewise, if synchronisation is disabled in the element or there
1931  * is no clock, no synchronisation is done and #GST_CLOCK_BADTIME is returned.
1932  *
1933  * This function should only be called with the PREROLL_LOCK held, like when
1934  * receiving an EOS event in the ::event vmethod or when receiving a buffer in
1935  * the ::render vmethod.
1936  *
1937  * The @time argument should be the running_time of when this method should
1938  * return and is not adjusted with any latency or offset configured in the
1939  * sink.
1940  *
1941  * Since 0.10.20
1942  *
1943  * Returns: #GstClockReturn
1944  */
1945 GstClockReturn
1946 gst_base_sink_wait_clock (GstBaseSink * sink, GstClockTime time,
1947     GstClockTimeDiff * jitter)
1948 {
1949   GstClockID id;
1950   GstClockReturn ret;
1951   GstClock *clock;
1952
1953   if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
1954     goto invalid_time;
1955
1956   GST_OBJECT_LOCK (sink);
1957   if (G_UNLIKELY (!sink->sync))
1958     goto no_sync;
1959
1960   if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (sink)) == NULL))
1961     goto no_clock;
1962
1963   /* add base_time to running_time to get the time against the clock */
1964   time += GST_ELEMENT_CAST (sink)->base_time;
1965
1966   id = gst_clock_new_single_shot_id (clock, time);
1967   GST_OBJECT_UNLOCK (sink);
1968
1969   /* A blocking wait is performed on the clock. We save the ClockID
1970    * so we can unlock the entry at any time. While we are blocking, we
1971    * release the PREROLL_LOCK so that other threads can interrupt the
1972    * entry. */
1973   sink->clock_id = id;
1974   /* release the preroll lock while waiting */
1975   GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
1976
1977   ret = gst_clock_id_wait (id, jitter);
1978
1979   GST_PAD_PREROLL_LOCK (sink->sinkpad);
1980   gst_clock_id_unref (id);
1981   sink->clock_id = NULL;
1982
1983   return ret;
1984
1985   /* no syncing needed */
1986 invalid_time:
1987   {
1988     GST_DEBUG_OBJECT (sink, "time not valid, no sync needed");
1989     return GST_CLOCK_BADTIME;
1990   }
1991 no_sync:
1992   {
1993     GST_DEBUG_OBJECT (sink, "sync disabled");
1994     GST_OBJECT_UNLOCK (sink);
1995     return GST_CLOCK_BADTIME;
1996   }
1997 no_clock:
1998   {
1999     GST_DEBUG_OBJECT (sink, "no clock, can't sync");
2000     GST_OBJECT_UNLOCK (sink);
2001     return GST_CLOCK_BADTIME;
2002   }
2003 }
2004
2005 /**
2006  * gst_base_sink_wait_preroll:
2007  * @sink: the sink
2008  *
2009  * If the #GstBaseSinkClass::render method performs its own synchronisation against
2010  * the clock it must unblock when going from PLAYING to the PAUSED state and call
2011  * this method before continuing to render the remaining data.
2012  *
2013  * This function will block until a state change to PLAYING happens (in which
2014  * case this function returns #GST_FLOW_OK) or the processing must be stopped due
2015  * to a state change to READY or a FLUSH event (in which case this function
2016  * returns #GST_FLOW_WRONG_STATE).
2017  *
2018  * This function should only be called with the PREROLL_LOCK held, like in the
2019  * render function.
2020  *
2021  * Since: 0.10.11
2022  *
2023  * Returns: #GST_FLOW_OK if the preroll completed and processing can
2024  * continue. Any other return value should be returned from the render vmethod.
2025  */
2026 GstFlowReturn
2027 gst_base_sink_wait_preroll (GstBaseSink * sink)
2028 {
2029   sink->have_preroll = TRUE;
2030   GST_DEBUG_OBJECT (sink, "waiting in preroll for flush or PLAYING");
2031   /* block until the state changes, or we get a flush, or something */
2032   GST_PAD_PREROLL_WAIT (sink->sinkpad);
2033   sink->have_preroll = FALSE;
2034   if (G_UNLIKELY (sink->flushing))
2035     goto stopping;
2036   if (G_UNLIKELY (sink->priv->step_unlock))
2037     goto step_unlocked;
2038   GST_DEBUG_OBJECT (sink, "continue after preroll");
2039
2040   return GST_FLOW_OK;
2041
2042   /* ERRORS */
2043 stopping:
2044   {
2045     GST_DEBUG_OBJECT (sink, "preroll interrupted because of flush");
2046     return GST_FLOW_WRONG_STATE;
2047   }
2048 step_unlocked:
2049   {
2050     sink->priv->step_unlock = FALSE;
2051     GST_DEBUG_OBJECT (sink, "preroll interrupted because of step");
2052     return GST_FLOW_STEP;
2053   }
2054 }
2055
2056 /**
2057  * gst_base_sink_do_preroll:
2058  * @sink: the sink
2059  * @obj: the object that caused the preroll
2060  *
2061  * If the @sink spawns its own thread for pulling buffers from upstream it
2062  * should call this method after it has pulled a buffer. If the element needed
2063  * to preroll, this function will perform the preroll and will then block
2064  * until the element state is changed.
2065  *
2066  * This function should be called with the PREROLL_LOCK held.
2067  *
2068  * Since 0.10.22
2069  *
2070  * Returns: #GST_FLOW_OK if the preroll completed and processing can
2071  * continue. Any other return value should be returned from the render vmethod.
2072  */
2073 GstFlowReturn
2074 gst_base_sink_do_preroll (GstBaseSink * sink, GstMiniObject * obj)
2075 {
2076   GstFlowReturn ret;
2077
2078   while (G_UNLIKELY (sink->need_preroll)) {
2079     GST_DEBUG_OBJECT (sink, "prerolling object %p", obj);
2080
2081     ret = gst_base_sink_preroll_object (sink, FALSE, obj);
2082     if (ret != GST_FLOW_OK)
2083       goto preroll_failed;
2084
2085     /* need to recheck here because the commit state could have
2086      * made us not need the preroll anymore */
2087     if (G_LIKELY (sink->need_preroll)) {
2088       /* block until the state changes, or we get a flush, or something */
2089       ret = gst_base_sink_wait_preroll (sink);
2090       if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2091         goto preroll_failed;
2092     }
2093   }
2094   return GST_FLOW_OK;
2095
2096   /* ERRORS */
2097 preroll_failed:
2098   {
2099     GST_DEBUG_OBJECT (sink, "preroll failed %d", ret);
2100     return ret;
2101   }
2102 }
2103
2104 /**
2105  * gst_base_sink_wait_eos:
2106  * @sink: the sink
2107  * @time: the running_time to be reached
2108  * @jitter: the jitter to be filled with time diff (can be NULL)
2109  *
2110  * This function will block until @time is reached. It is usually called by
2111  * subclasses that use their own internal synchronisation but want to let the
2112  * EOS be handled by the base class.
2113  *
2114  * This function should only be called with the PREROLL_LOCK held, like when
2115  * receiving an EOS event in the ::event vmethod.
2116  *
2117  * The @time argument should be the running_time of when the EOS should happen
2118  * and will be adjusted with any latency and offset configured in the sink.
2119  *
2120  * Since 0.10.15
2121  *
2122  * Returns: #GstFlowReturn
2123  */
2124 GstFlowReturn
2125 gst_base_sink_wait_eos (GstBaseSink * sink, GstClockTime time,
2126     GstClockTimeDiff * jitter)
2127 {
2128   GstClockReturn status;
2129   GstFlowReturn ret;
2130
2131   do {
2132     GstClockTime stime;
2133
2134     GST_DEBUG_OBJECT (sink, "checking preroll");
2135
2136     /* first wait for the playing state before we can continue */
2137     if (G_UNLIKELY (sink->need_preroll)) {
2138       ret = gst_base_sink_wait_preroll (sink);
2139       if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2140         goto flushing;
2141     }
2142
2143     /* preroll done, we can sync since we are in PLAYING now. */
2144     GST_DEBUG_OBJECT (sink, "possibly waiting for clock to reach %"
2145         GST_TIME_FORMAT, GST_TIME_ARGS (time));
2146
2147     /* compensate for latency and ts_offset. We don't adjust for render delay
2148      * because we don't interact with the device on EOS normally. */
2149     stime = gst_base_sink_adjust_time (sink, time);
2150
2151     /* wait for the clock, this can be interrupted because we got shut down or
2152      * we PAUSED. */
2153     status = gst_base_sink_wait_clock (sink, stime, jitter);
2154
2155     GST_DEBUG_OBJECT (sink, "clock returned %d", status);
2156
2157     /* invalid time, no clock or sync disabled, just continue then */
2158     if (status == GST_CLOCK_BADTIME)
2159       break;
2160
2161     /* waiting could have been interrupted and we can be flushing now */
2162     if (G_UNLIKELY (sink->flushing))
2163       goto flushing;
2164
2165     /* retry if we got unscheduled, which means we did not reach the timeout
2166      * yet. if some other error occures, we continue. */
2167   } while (status == GST_CLOCK_UNSCHEDULED);
2168
2169   GST_DEBUG_OBJECT (sink, "end of stream");
2170
2171   return GST_FLOW_OK;
2172
2173   /* ERRORS */
2174 flushing:
2175   {
2176     GST_DEBUG_OBJECT (sink, "we are flushing");
2177     return GST_FLOW_WRONG_STATE;
2178   }
2179 }
2180
2181 /* with STREAM_LOCK, PREROLL_LOCK
2182  *
2183  * Make sure we are in PLAYING and synchronize an object to the clock.
2184  *
2185  * If we need preroll, we are not in PLAYING. We try to commit the state
2186  * if needed and then block if we still are not PLAYING.
2187  *
2188  * We start waiting on the clock in PLAYING. If we got interrupted, we
2189  * immediatly try to re-preroll.
2190  *
2191  * Some objects do not need synchronisation (most events) and so this function
2192  * immediatly returns GST_FLOW_OK.
2193  *
2194  * for objects that arrive later than max-lateness to be synchronized to the
2195  * clock have the @late boolean set to TRUE.
2196  *
2197  * This function keeps a running average of the jitter (the diff between the
2198  * clock time and the requested sync time). The jitter is negative for
2199  * objects that arrive in time and positive for late buffers.
2200  *
2201  * does not take ownership of obj.
2202  */
2203 static GstFlowReturn
2204 gst_base_sink_do_sync (GstBaseSink * basesink, GstPad * pad,
2205     GstMiniObject * obj, gboolean * late, gboolean * step_end)
2206 {
2207   GstClockTimeDiff jitter;
2208   gboolean syncable;
2209   GstClockReturn status = GST_CLOCK_OK;
2210   GstClockTime rstart, rstop, sstart, sstop, stime;
2211   gboolean do_sync;
2212   GstBaseSinkPrivate *priv;
2213   GstFlowReturn ret;
2214   GstStepInfo *current, *pending;
2215   gboolean stepped;
2216
2217   priv = basesink->priv;
2218
2219 do_step:
2220   sstart = sstop = rstart = rstop = GST_CLOCK_TIME_NONE;
2221   do_sync = TRUE;
2222   stepped = FALSE;
2223
2224   priv->current_rstart = GST_CLOCK_TIME_NONE;
2225
2226   /* get stepping info */
2227   current = &priv->current_step;
2228   pending = &priv->pending_step;
2229
2230   /* get timing information for this object against the render segment */
2231   syncable = gst_base_sink_get_sync_times (basesink, obj,
2232       &sstart, &sstop, &rstart, &rstop, &do_sync, &stepped, &basesink->segment,
2233       current, step_end);
2234
2235   if (G_UNLIKELY (stepped))
2236     goto step_skipped;
2237
2238   /* a syncable object needs to participate in preroll and
2239    * clocking. All buffers and EOS are syncable. */
2240   if (G_UNLIKELY (!syncable))
2241     goto not_syncable;
2242
2243   /* store timing info for current object */
2244   priv->current_rstart = rstart;
2245   priv->current_rstop = (GST_CLOCK_TIME_IS_VALID (rstop) ? rstop : rstart);
2246
2247   /* save sync time for eos when the previous object needed sync */
2248   priv->eos_rtime = (do_sync ? priv->current_rstop : GST_CLOCK_TIME_NONE);
2249
2250 again:
2251   /* first do preroll, this makes sure we commit our state
2252    * to PAUSED and can continue to PLAYING. We cannot perform
2253    * any clock sync in PAUSED because there is no clock. */
2254   ret = gst_base_sink_do_preroll (basesink, obj);
2255   if (G_UNLIKELY (ret != GST_FLOW_OK))
2256     goto preroll_failed;
2257
2258   /* update the segment with a pending step if the current one is invalid and we
2259    * have a new pending one. We only accept new step updates after a preroll */
2260   if (G_UNLIKELY (pending->valid && !current->valid)) {
2261     start_stepping (basesink, &basesink->segment, pending, current);
2262     goto do_step;
2263   }
2264
2265   /* After rendering we store the position of the last buffer so that we can use
2266    * it to report the position. We need to take the lock here. */
2267   GST_OBJECT_LOCK (basesink);
2268   priv->current_sstart = sstart;
2269   priv->current_sstop = (GST_CLOCK_TIME_IS_VALID (sstop) ? sstop : sstart);
2270   GST_OBJECT_UNLOCK (basesink);
2271
2272   if (!do_sync)
2273     goto done;
2274
2275   /* adjust for latency */
2276   stime = gst_base_sink_adjust_time (basesink, rstart);
2277
2278   /* adjust for render-delay, avoid underflows */
2279   if (GST_CLOCK_TIME_IS_VALID (stime)) {
2280     if (stime > priv->render_delay)
2281       stime -= priv->render_delay;
2282     else
2283       stime = 0;
2284   }
2285
2286   /* preroll done, we can sync since we are in PLAYING now. */
2287   GST_DEBUG_OBJECT (basesink, "possibly waiting for clock to reach %"
2288       GST_TIME_FORMAT ", adjusted %" GST_TIME_FORMAT,
2289       GST_TIME_ARGS (rstart), GST_TIME_ARGS (stime));
2290
2291   /* This function will return immediatly if start == -1, no clock
2292    * or sync is disabled with GST_CLOCK_BADTIME. */
2293   status = gst_base_sink_wait_clock (basesink, stime, &jitter);
2294
2295   GST_DEBUG_OBJECT (basesink, "clock returned %d", status);
2296
2297   /* invalid time, no clock or sync disabled, just render */
2298   if (status == GST_CLOCK_BADTIME)
2299     goto done;
2300
2301   /* waiting could have been interrupted and we can be flushing now */
2302   if (G_UNLIKELY (basesink->flushing))
2303     goto flushing;
2304
2305   /* check for unlocked by a state change, we are not flushing so
2306    * we can try to preroll on the current buffer. */
2307   if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED)) {
2308     GST_DEBUG_OBJECT (basesink, "unscheduled, waiting some more");
2309     priv->call_preroll = TRUE;
2310     goto again;
2311   }
2312
2313   /* successful syncing done, record observation */
2314   priv->current_jitter = jitter;
2315
2316   /* check if the object should be dropped */
2317   *late = gst_base_sink_is_too_late (basesink, obj, rstart, rstop,
2318       status, jitter);
2319
2320 done:
2321   return GST_FLOW_OK;
2322
2323   /* ERRORS */
2324 step_skipped:
2325   {
2326     GST_DEBUG_OBJECT (basesink, "skipped stepped object %p", obj);
2327     *late = TRUE;
2328     return GST_FLOW_OK;
2329   }
2330 not_syncable:
2331   {
2332     GST_DEBUG_OBJECT (basesink, "non syncable object %p", obj);
2333     return GST_FLOW_OK;
2334   }
2335 flushing:
2336   {
2337     GST_DEBUG_OBJECT (basesink, "we are flushing");
2338     return GST_FLOW_WRONG_STATE;
2339   }
2340 preroll_failed:
2341   {
2342     GST_DEBUG_OBJECT (basesink, "preroll failed");
2343     *step_end = FALSE;
2344     return ret;
2345   }
2346 }
2347
2348 static gboolean
2349 gst_base_sink_send_qos (GstBaseSink * basesink,
2350     gdouble proportion, GstClockTime time, GstClockTimeDiff diff)
2351 {
2352   GstEvent *event;
2353   gboolean res;
2354
2355   /* generate Quality-of-Service event */
2356   GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2357       "qos: proportion: %lf, diff %" G_GINT64_FORMAT ", timestamp %"
2358       GST_TIME_FORMAT, proportion, diff, GST_TIME_ARGS (time));
2359
2360   event = gst_event_new_qos (proportion, diff, time);
2361
2362   /* send upstream */
2363   res = gst_pad_push_event (basesink->sinkpad, event);
2364
2365   return res;
2366 }
2367
2368 static void
2369 gst_base_sink_perform_qos (GstBaseSink * sink, gboolean dropped)
2370 {
2371   GstBaseSinkPrivate *priv;
2372   GstClockTime start, stop;
2373   GstClockTimeDiff jitter;
2374   GstClockTime pt, entered, left;
2375   GstClockTime duration;
2376   gdouble rate;
2377
2378   priv = sink->priv;
2379
2380   start = priv->current_rstart;
2381
2382   if (priv->current_step.valid)
2383     return;
2384
2385   /* if Quality-of-Service disabled, do nothing */
2386   if (!g_atomic_int_get (&priv->qos_enabled) ||
2387       !GST_CLOCK_TIME_IS_VALID (start))
2388     return;
2389
2390   stop = priv->current_rstop;
2391   jitter = priv->current_jitter;
2392
2393   if (jitter < 0) {
2394     /* this is the time the buffer entered the sink */
2395     if (start < -jitter)
2396       entered = 0;
2397     else
2398       entered = start + jitter;
2399     left = start;
2400   } else {
2401     /* this is the time the buffer entered the sink */
2402     entered = start + jitter;
2403     /* this is the time the buffer left the sink */
2404     left = start + jitter;
2405   }
2406
2407   /* calculate duration of the buffer */
2408   if (GST_CLOCK_TIME_IS_VALID (stop))
2409     duration = stop - start;
2410   else
2411     duration = GST_CLOCK_TIME_NONE;
2412
2413   /* if we have the time when the last buffer left us, calculate
2414    * processing time */
2415   if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2416     if (entered > priv->last_left) {
2417       pt = entered - priv->last_left;
2418     } else {
2419       pt = 0;
2420     }
2421   } else {
2422     pt = priv->avg_pt;
2423   }
2424
2425   GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "start: %" GST_TIME_FORMAT
2426       ", entered %" GST_TIME_FORMAT ", left %" GST_TIME_FORMAT ", pt: %"
2427       GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT ",jitter %"
2428       G_GINT64_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (entered),
2429       GST_TIME_ARGS (left), GST_TIME_ARGS (pt), GST_TIME_ARGS (duration),
2430       jitter);
2431
2432   GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "avg_duration: %" GST_TIME_FORMAT
2433       ", avg_pt: %" GST_TIME_FORMAT ", avg_rate: %g",
2434       GST_TIME_ARGS (priv->avg_duration), GST_TIME_ARGS (priv->avg_pt),
2435       priv->avg_rate);
2436
2437   /* collect running averages. for first observations, we copy the
2438    * values */
2439   if (!GST_CLOCK_TIME_IS_VALID (priv->avg_duration))
2440     priv->avg_duration = duration;
2441   else
2442     priv->avg_duration = UPDATE_RUNNING_AVG (priv->avg_duration, duration);
2443
2444   if (!GST_CLOCK_TIME_IS_VALID (priv->avg_pt))
2445     priv->avg_pt = pt;
2446   else
2447     priv->avg_pt = UPDATE_RUNNING_AVG (priv->avg_pt, pt);
2448
2449   if (priv->avg_duration != 0)
2450     rate =
2451         gst_guint64_to_gdouble (priv->avg_pt) /
2452         gst_guint64_to_gdouble (priv->avg_duration);
2453   else
2454     rate = 0.0;
2455
2456   if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2457     if (dropped || priv->avg_rate < 0.0) {
2458       priv->avg_rate = rate;
2459     } else {
2460       if (rate > 1.0)
2461         priv->avg_rate = UPDATE_RUNNING_AVG_N (priv->avg_rate, rate);
2462       else
2463         priv->avg_rate = UPDATE_RUNNING_AVG_P (priv->avg_rate, rate);
2464     }
2465   }
2466
2467   GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink,
2468       "updated: avg_duration: %" GST_TIME_FORMAT ", avg_pt: %" GST_TIME_FORMAT
2469       ", avg_rate: %g", GST_TIME_ARGS (priv->avg_duration),
2470       GST_TIME_ARGS (priv->avg_pt), priv->avg_rate);
2471
2472
2473   if (priv->avg_rate >= 0.0) {
2474     /* if we have a valid rate, start sending QoS messages */
2475     if (priv->current_jitter < 0) {
2476       /* make sure we never go below 0 when adding the jitter to the
2477        * timestamp. */
2478       if (priv->current_rstart < -priv->current_jitter)
2479         priv->current_jitter = -priv->current_rstart;
2480     }
2481     gst_base_sink_send_qos (sink, priv->avg_rate, priv->current_rstart,
2482         priv->current_jitter);
2483   }
2484
2485   /* record when this buffer will leave us */
2486   priv->last_left = left;
2487 }
2488
2489 /* reset all qos measuring */
2490 static void
2491 gst_base_sink_reset_qos (GstBaseSink * sink)
2492 {
2493   GstBaseSinkPrivate *priv;
2494
2495   priv = sink->priv;
2496
2497   priv->last_in_time = GST_CLOCK_TIME_NONE;
2498   priv->last_left = GST_CLOCK_TIME_NONE;
2499   priv->avg_duration = GST_CLOCK_TIME_NONE;
2500   priv->avg_pt = GST_CLOCK_TIME_NONE;
2501   priv->avg_rate = -1.0;
2502   priv->avg_render = GST_CLOCK_TIME_NONE;
2503   priv->rendered = 0;
2504   priv->dropped = 0;
2505
2506 }
2507
2508 /* Checks if the object was scheduled too late.
2509  *
2510  * start/stop contain the raw timestamp start and stop values
2511  * of the object.
2512  *
2513  * status and jitter contain the return values from the clock wait.
2514  *
2515  * returns TRUE if the buffer was too late.
2516  */
2517 static gboolean
2518 gst_base_sink_is_too_late (GstBaseSink * basesink, GstMiniObject * obj,
2519     GstClockTime start, GstClockTime stop,
2520     GstClockReturn status, GstClockTimeDiff jitter)
2521 {
2522   gboolean late;
2523   gint64 max_lateness;
2524   GstBaseSinkPrivate *priv;
2525
2526   priv = basesink->priv;
2527
2528   late = FALSE;
2529
2530   /* only for objects that were too late */
2531   if (G_LIKELY (status != GST_CLOCK_EARLY))
2532     goto in_time;
2533
2534   max_lateness = basesink->abidata.ABI.max_lateness;
2535
2536   /* check if frame dropping is enabled */
2537   if (max_lateness == -1)
2538     goto no_drop;
2539
2540   /* only check for buffers */
2541   if (G_UNLIKELY (!GST_IS_BUFFER (obj)))
2542     goto not_buffer;
2543
2544   /* can't do check if we don't have a timestamp */
2545   if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (start)))
2546     goto no_timestamp;
2547
2548   /* we can add a valid stop time */
2549   if (GST_CLOCK_TIME_IS_VALID (stop))
2550     max_lateness += stop;
2551   else
2552     max_lateness += start;
2553
2554   /* if the jitter bigger than duration and lateness we are too late */
2555   if ((late = start + jitter > max_lateness)) {
2556     GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2557         "buffer is too late %" GST_TIME_FORMAT
2558         " > %" GST_TIME_FORMAT, GST_TIME_ARGS (start + jitter),
2559         GST_TIME_ARGS (max_lateness));
2560     /* !!emergency!!, if we did not receive anything valid for more than a
2561      * second, render it anyway so the user sees something */
2562     if (GST_CLOCK_TIME_IS_VALID (priv->last_in_time) &&
2563         start - priv->last_in_time > GST_SECOND) {
2564       late = FALSE;
2565       GST_ELEMENT_WARNING (basesink, CORE, CLOCK,
2566           (_("A lot of buffers are being dropped.")),
2567           ("There may be a timestamping problem, or this computer is too slow."));
2568       GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2569           "**emergency** last buffer at %" GST_TIME_FORMAT " > GST_SECOND",
2570           GST_TIME_ARGS (priv->last_in_time));
2571     }
2572   }
2573
2574 done:
2575   if (!late) {
2576     priv->last_in_time = start;
2577   }
2578   return late;
2579
2580   /* all is fine */
2581 in_time:
2582   {
2583     GST_DEBUG_OBJECT (basesink, "object was scheduled in time");
2584     goto done;
2585   }
2586 no_drop:
2587   {
2588     GST_DEBUG_OBJECT (basesink, "frame dropping disabled");
2589     goto done;
2590   }
2591 not_buffer:
2592   {
2593     GST_DEBUG_OBJECT (basesink, "object is not a buffer");
2594     return FALSE;
2595   }
2596 no_timestamp:
2597   {
2598     GST_DEBUG_OBJECT (basesink, "buffer has no timestamp");
2599     return FALSE;
2600   }
2601 }
2602
2603 /* called before and after calling the render vmethod. It keeps track of how
2604  * much time was spent in the render method and is used to check if we are
2605  * flooded */
2606 static void
2607 gst_base_sink_do_render_stats (GstBaseSink * basesink, gboolean start)
2608 {
2609   GstBaseSinkPrivate *priv;
2610
2611   priv = basesink->priv;
2612
2613   if (start) {
2614     priv->start = gst_util_get_timestamp ();
2615   } else {
2616     GstClockTime elapsed;
2617
2618     priv->stop = gst_util_get_timestamp ();
2619
2620     elapsed = GST_CLOCK_DIFF (priv->start, priv->stop);
2621
2622     if (!GST_CLOCK_TIME_IS_VALID (priv->avg_render))
2623       priv->avg_render = elapsed;
2624     else
2625       priv->avg_render = UPDATE_RUNNING_AVG (priv->avg_render, elapsed);
2626
2627     GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2628         "avg_render: %" GST_TIME_FORMAT, GST_TIME_ARGS (priv->avg_render));
2629   }
2630 }
2631
2632 /* with STREAM_LOCK, PREROLL_LOCK,
2633  *
2634  * Synchronize the object on the clock and then render it.
2635  *
2636  * takes ownership of obj.
2637  */
2638 static GstFlowReturn
2639 gst_base_sink_render_object (GstBaseSink * basesink, GstPad * pad,
2640     gboolean is_list, gpointer obj)
2641 {
2642   GstFlowReturn ret;
2643   GstBaseSinkClass *bclass;
2644   gboolean late, step_end;
2645   gpointer sync_obj;
2646
2647   GstBaseSinkPrivate *priv;
2648
2649   priv = basesink->priv;
2650
2651   if (is_list) {
2652     /*
2653      * If buffer list, use the first group buffer within the list
2654      * for syncing
2655      */
2656     sync_obj = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0, 0);
2657     g_assert (NULL != sync_obj);
2658   } else {
2659     sync_obj = obj;
2660   }
2661
2662 again:
2663   late = FALSE;
2664   step_end = FALSE;
2665
2666   /* synchronize this object, non syncable objects return OK
2667    * immediatly. */
2668   ret = gst_base_sink_do_sync (basesink, pad, sync_obj, &late, &step_end);
2669   if (G_UNLIKELY (ret != GST_FLOW_OK))
2670     goto sync_failed;
2671
2672   /* and now render, event or buffer/buffer list. */
2673   if (G_LIKELY (is_list || GST_IS_BUFFER (obj))) {
2674     /* drop late buffers unconditionally, let's hope it's unlikely */
2675     if (G_UNLIKELY (late))
2676       goto dropped;
2677
2678     bclass = GST_BASE_SINK_GET_CLASS (basesink);
2679
2680     if (G_LIKELY ((is_list && bclass->render_list) ||
2681             (!is_list && bclass->render))) {
2682       gint do_qos;
2683
2684       /* read once, to get same value before and after */
2685       do_qos = g_atomic_int_get (&priv->qos_enabled);
2686
2687       GST_DEBUG_OBJECT (basesink, "rendering object %p", obj);
2688
2689       /* record rendering time for QoS and stats */
2690       if (do_qos)
2691         gst_base_sink_do_render_stats (basesink, TRUE);
2692
2693       if (!is_list) {
2694         GstBuffer *buf;
2695
2696         /* For buffer lists do not set last buffer. Creating buffer
2697          * with meaningful data can be done only with memcpy which will
2698          * significantly affect performance */
2699         buf = GST_BUFFER_CAST (obj);
2700         gst_base_sink_set_last_buffer (basesink, buf);
2701
2702         ret = bclass->render (basesink, buf);
2703       } else {
2704         GstBufferList *buflist;
2705
2706         buflist = GST_BUFFER_LIST_CAST (obj);
2707
2708         ret = bclass->render_list (basesink, buflist);
2709       }
2710
2711       if (do_qos)
2712         gst_base_sink_do_render_stats (basesink, FALSE);
2713
2714       if (ret == GST_FLOW_STEP)
2715         goto again;
2716
2717       if (G_UNLIKELY (basesink->flushing))
2718         goto flushing;
2719
2720       priv->rendered++;
2721     }
2722   } else {
2723     GstEvent *event = GST_EVENT_CAST (obj);
2724     gboolean event_res = TRUE;
2725     GstEventType type;
2726
2727     bclass = GST_BASE_SINK_GET_CLASS (basesink);
2728
2729     type = GST_EVENT_TYPE (event);
2730
2731     GST_DEBUG_OBJECT (basesink, "rendering event %p, type %s", obj,
2732         gst_event_type_get_name (type));
2733
2734     if (bclass->event)
2735       event_res = bclass->event (basesink, event);
2736
2737     /* when we get here we could be flushing again when the event handler calls
2738      * _wait_eos(). We have to ignore this object in that case. */
2739     if (G_UNLIKELY (basesink->flushing))
2740       goto flushing;
2741
2742     if (G_LIKELY (event_res)) {
2743       guint32 seqnum;
2744
2745       seqnum = basesink->priv->seqnum = gst_event_get_seqnum (event);
2746       GST_DEBUG_OBJECT (basesink, "Got seqnum #%" G_GUINT32_FORMAT, seqnum);
2747
2748       switch (type) {
2749         case GST_EVENT_EOS:
2750         {
2751           GstMessage *message;
2752
2753           /* the EOS event is completely handled so we mark
2754            * ourselves as being in the EOS state. eos is also
2755            * protected by the object lock so we can read it when
2756            * answering the POSITION query. */
2757           GST_OBJECT_LOCK (basesink);
2758           basesink->eos = TRUE;
2759           GST_OBJECT_UNLOCK (basesink);
2760
2761           /* ok, now we can post the message */
2762           GST_DEBUG_OBJECT (basesink, "Now posting EOS");
2763
2764           message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
2765           gst_message_set_seqnum (message, seqnum);
2766           gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
2767           break;
2768         }
2769         case GST_EVENT_NEWSEGMENT:
2770           /* configure the segment */
2771           gst_base_sink_configure_segment (basesink, pad, event,
2772               &basesink->segment);
2773           break;
2774         case GST_EVENT_SINK_MESSAGE:{
2775           GstMessage *msg = NULL;
2776
2777           gst_event_parse_sink_message (event, &msg);
2778
2779           if (msg)
2780             gst_element_post_message (GST_ELEMENT_CAST (basesink), msg);
2781         }
2782         default:
2783           break;
2784       }
2785     }
2786   }
2787
2788 done:
2789   if (step_end) {
2790     /* the step ended, check if we need to activate a new step */
2791     GST_DEBUG_OBJECT (basesink, "step ended");
2792     stop_stepping (basesink, &basesink->segment, &priv->current_step,
2793         priv->current_rstart, priv->current_rstop, basesink->eos);
2794     goto again;
2795   }
2796
2797   gst_base_sink_perform_qos (basesink, late);
2798
2799   GST_DEBUG_OBJECT (basesink, "object unref after render %p", obj);
2800   gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
2801   return ret;
2802
2803   /* ERRORS */
2804 sync_failed:
2805   {
2806     GST_DEBUG_OBJECT (basesink, "do_sync returned %s", gst_flow_get_name (ret));
2807     goto done;
2808   }
2809 dropped:
2810   {
2811     priv->dropped++;
2812     GST_DEBUG_OBJECT (basesink, "buffer late, dropping");
2813     goto done;
2814   }
2815 flushing:
2816   {
2817     GST_DEBUG_OBJECT (basesink, "we are flushing, ignore object");
2818     gst_mini_object_unref (obj);
2819     return GST_FLOW_WRONG_STATE;
2820   }
2821 }
2822
2823 /* with STREAM_LOCK, PREROLL_LOCK
2824  *
2825  * Perform preroll on the given object. For buffers this means
2826  * calling the preroll subclass method.
2827  * If that succeeds, the state will be commited.
2828  *
2829  * function does not take ownership of obj.
2830  */
2831 static GstFlowReturn
2832 gst_base_sink_preroll_object (GstBaseSink * basesink, gboolean is_list,
2833     GstMiniObject * obj)
2834 {
2835   GstFlowReturn ret;
2836
2837   GST_DEBUG_OBJECT (basesink, "prerolling object %p", obj);
2838
2839   /* if it's a buffer, we need to call the preroll method */
2840   if (G_LIKELY (is_list || GST_IS_BUFFER (obj)) && basesink->priv->call_preroll) {
2841     GstBaseSinkClass *bclass;
2842     GstBuffer *buf;
2843     GstClockTime timestamp;
2844
2845     if (is_list) {
2846       buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0, 0);
2847       g_assert (NULL != buf);
2848     } else {
2849       buf = GST_BUFFER_CAST (obj);
2850     }
2851
2852     timestamp = GST_BUFFER_TIMESTAMP (buf);
2853
2854     GST_DEBUG_OBJECT (basesink, "preroll buffer %" GST_TIME_FORMAT,
2855         GST_TIME_ARGS (timestamp));
2856
2857     /*
2858      * For buffer lists do not set last buffer. Creating buffer
2859      * with meaningful data can be done only with memcpy which will
2860      * significantly affect performance
2861      */
2862     if (!is_list) {
2863       gst_base_sink_set_last_buffer (basesink, buf);
2864     }
2865
2866     bclass = GST_BASE_SINK_GET_CLASS (basesink);
2867     if (bclass->preroll)
2868       if ((ret = bclass->preroll (basesink, buf)) != GST_FLOW_OK)
2869         goto preroll_failed;
2870
2871     basesink->priv->call_preroll = FALSE;
2872   }
2873
2874   /* commit state */
2875   if (G_LIKELY (basesink->playing_async)) {
2876     if (G_UNLIKELY (!gst_base_sink_commit_state (basesink)))
2877       goto stopping;
2878   }
2879
2880   return GST_FLOW_OK;
2881
2882   /* ERRORS */
2883 preroll_failed:
2884   {
2885     GST_DEBUG_OBJECT (basesink, "preroll failed, abort state");
2886     gst_element_abort_state (GST_ELEMENT_CAST (basesink));
2887     return ret;
2888   }
2889 stopping:
2890   {
2891     GST_DEBUG_OBJECT (basesink, "stopping while commiting state");
2892     return GST_FLOW_WRONG_STATE;
2893   }
2894 }
2895
2896 /* with STREAM_LOCK, PREROLL_LOCK
2897  *
2898  * Queue an object for rendering.
2899  * The first prerollable object queued will complete the preroll. If the
2900  * preroll queue if filled, we render all the objects in the queue.
2901  *
2902  * This function takes ownership of the object.
2903  */
2904 static GstFlowReturn
2905 gst_base_sink_queue_object_unlocked (GstBaseSink * basesink, GstPad * pad,
2906     gboolean is_list, gpointer obj, gboolean prerollable)
2907 {
2908   GstFlowReturn ret = GST_FLOW_OK;
2909   gint length;
2910   GQueue *q;
2911
2912   if (G_UNLIKELY (basesink->need_preroll)) {
2913     if (G_LIKELY (prerollable))
2914       basesink->preroll_queued++;
2915
2916     length = basesink->preroll_queued;
2917
2918     GST_DEBUG_OBJECT (basesink, "now %d prerolled items", length);
2919
2920     /* first prerollable item needs to finish the preroll */
2921     if (length == 1) {
2922       ret = gst_base_sink_preroll_object (basesink, is_list, obj);
2923       if (G_UNLIKELY (ret != GST_FLOW_OK))
2924         goto preroll_failed;
2925     }
2926     /* need to recheck if we need preroll, commmit state during preroll
2927      * could have made us not need more preroll. */
2928     if (G_UNLIKELY (basesink->need_preroll)) {
2929       /* see if we can render now, if we can't add the object to the preroll
2930        * queue. */
2931       if (G_UNLIKELY (length <= basesink->preroll_queue_max_len))
2932         goto more_preroll;
2933     }
2934   }
2935   /* we can start rendering (or blocking) the queued object
2936    * if any. */
2937   q = basesink->preroll_queue;
2938   while (G_UNLIKELY (!g_queue_is_empty (q))) {
2939     GstMiniObject *o;
2940
2941     o = g_queue_pop_head (q);
2942     GST_DEBUG_OBJECT (basesink, "rendering queued object %p", o);
2943
2944     /* do something with the return value */
2945     ret = gst_base_sink_render_object (basesink, pad, FALSE, o);
2946     if (ret != GST_FLOW_OK)
2947       goto dequeue_failed;
2948   }
2949
2950   /* now render the object */
2951   ret = gst_base_sink_render_object (basesink, pad, is_list, obj);
2952   basesink->preroll_queued = 0;
2953
2954   return ret;
2955
2956   /* special cases */
2957 preroll_failed:
2958   {
2959     GST_DEBUG_OBJECT (basesink, "preroll failed, reason %s",
2960         gst_flow_get_name (ret));
2961     gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
2962     return ret;
2963   }
2964 more_preroll:
2965   {
2966     /* add object to the queue and return */
2967     GST_DEBUG_OBJECT (basesink, "need more preroll data %d <= %d",
2968         length, basesink->preroll_queue_max_len);
2969     g_queue_push_tail (basesink->preroll_queue, obj);
2970     return GST_FLOW_OK;
2971   }
2972 dequeue_failed:
2973   {
2974     GST_DEBUG_OBJECT (basesink, "rendering queued objects failed, reason %s",
2975         gst_flow_get_name (ret));
2976     gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
2977     return ret;
2978   }
2979 }
2980
2981 /* with STREAM_LOCK
2982  *
2983  * This function grabs the PREROLL_LOCK and adds the object to
2984  * the queue.
2985  *
2986  * This function takes ownership of obj.
2987  */
2988 static GstFlowReturn
2989 gst_base_sink_queue_object (GstBaseSink * basesink, GstPad * pad,
2990     GstMiniObject * obj, gboolean prerollable)
2991 {
2992   GstFlowReturn ret;
2993
2994   GST_PAD_PREROLL_LOCK (pad);
2995   if (G_UNLIKELY (basesink->flushing))
2996     goto flushing;
2997
2998   if (G_UNLIKELY (basesink->priv->received_eos))
2999     goto was_eos;
3000
3001   ret =
3002       gst_base_sink_queue_object_unlocked (basesink, pad, FALSE, obj,
3003       prerollable);
3004   GST_PAD_PREROLL_UNLOCK (pad);
3005
3006   return ret;
3007
3008   /* ERRORS */
3009 flushing:
3010   {
3011     GST_DEBUG_OBJECT (basesink, "sink is flushing");
3012     GST_PAD_PREROLL_UNLOCK (pad);
3013     gst_mini_object_unref (obj);
3014     return GST_FLOW_WRONG_STATE;
3015   }
3016 was_eos:
3017   {
3018     GST_DEBUG_OBJECT (basesink,
3019         "we are EOS, dropping object, return UNEXPECTED");
3020     GST_PAD_PREROLL_UNLOCK (pad);
3021     gst_mini_object_unref (obj);
3022     return GST_FLOW_UNEXPECTED;
3023   }
3024 }
3025
3026 static void
3027 gst_base_sink_flush_start (GstBaseSink * basesink, GstPad * pad)
3028 {
3029   /* make sure we are not blocked on the clock also clear any pending
3030    * eos state. */
3031   gst_base_sink_set_flushing (basesink, pad, TRUE);
3032
3033   /* we grab the stream lock but that is not needed since setting the
3034    * sink to flushing would make sure no state commit is being done
3035    * anymore */
3036   GST_PAD_STREAM_LOCK (pad);
3037   gst_base_sink_reset_qos (basesink);
3038   if (basesink->priv->async_enabled) {
3039     /* and we need to commit our state again on the next
3040      * prerolled buffer */
3041     basesink->playing_async = TRUE;
3042     gst_element_lost_state (GST_ELEMENT_CAST (basesink));
3043   } else {
3044     basesink->priv->have_latency = TRUE;
3045     basesink->need_preroll = FALSE;
3046   }
3047   gst_base_sink_set_last_buffer (basesink, NULL);
3048   GST_PAD_STREAM_UNLOCK (pad);
3049 }
3050
3051 static void
3052 gst_base_sink_flush_stop (GstBaseSink * basesink, GstPad * pad)
3053 {
3054   /* unset flushing so we can accept new data, this also flushes out any EOS
3055    * event. */
3056   gst_base_sink_set_flushing (basesink, pad, FALSE);
3057
3058   /* for position reporting */
3059   GST_OBJECT_LOCK (basesink);
3060   basesink->priv->current_sstart = GST_CLOCK_TIME_NONE;
3061   basesink->priv->current_sstop = GST_CLOCK_TIME_NONE;
3062   basesink->priv->eos_rtime = GST_CLOCK_TIME_NONE;
3063   basesink->priv->call_preroll = TRUE;
3064   basesink->priv->current_step.valid = FALSE;
3065   basesink->priv->pending_step.valid = FALSE;
3066   if (basesink->pad_mode == GST_ACTIVATE_PUSH) {
3067     /* we need new segment info after the flush. */
3068     basesink->have_newsegment = FALSE;
3069     gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
3070     gst_segment_init (basesink->abidata.ABI.clip_segment, GST_FORMAT_UNDEFINED);
3071   }
3072   GST_OBJECT_UNLOCK (basesink);
3073 }
3074
3075 static gboolean
3076 gst_base_sink_event (GstPad * pad, GstEvent * event)
3077 {
3078   GstBaseSink *basesink;
3079   gboolean result = TRUE;
3080   GstBaseSinkClass *bclass;
3081
3082   basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3083
3084   bclass = GST_BASE_SINK_GET_CLASS (basesink);
3085
3086   GST_DEBUG_OBJECT (basesink, "event %p (%s)", event,
3087       GST_EVENT_TYPE_NAME (event));
3088
3089   switch (GST_EVENT_TYPE (event)) {
3090     case GST_EVENT_EOS:
3091     {
3092       GstFlowReturn ret;
3093
3094       GST_PAD_PREROLL_LOCK (pad);
3095       if (G_UNLIKELY (basesink->flushing))
3096         goto flushing;
3097
3098       if (G_UNLIKELY (basesink->priv->received_eos)) {
3099         /* we can't accept anything when we are EOS */
3100         result = FALSE;
3101         gst_event_unref (event);
3102       } else {
3103         /* we set the received EOS flag here so that we can use it when testing if
3104          * we are prerolled and to refuse more buffers. */
3105         basesink->priv->received_eos = TRUE;
3106
3107         /* EOS is a prerollable object, we call the unlocked version because it
3108          * does not check the received_eos flag. */
3109         ret = gst_base_sink_queue_object_unlocked (basesink, pad,
3110             FALSE, GST_MINI_OBJECT_CAST (event), TRUE);
3111         if (G_UNLIKELY (ret != GST_FLOW_OK))
3112           result = FALSE;
3113       }
3114       GST_PAD_PREROLL_UNLOCK (pad);
3115       break;
3116     }
3117     case GST_EVENT_NEWSEGMENT:
3118     {
3119       GstFlowReturn ret;
3120
3121       GST_DEBUG_OBJECT (basesink, "newsegment %p", event);
3122
3123       GST_PAD_PREROLL_LOCK (pad);
3124       if (G_UNLIKELY (basesink->flushing))
3125         goto flushing;
3126
3127       if (G_UNLIKELY (basesink->priv->received_eos)) {
3128         /* we can't accept anything when we are EOS */
3129         result = FALSE;
3130         gst_event_unref (event);
3131       } else {
3132         /* the new segment is a non prerollable item and does not block anything,
3133          * we need to configure the current clipping segment and insert the event
3134          * in the queue to serialize it with the buffers for rendering. */
3135         gst_base_sink_configure_segment (basesink, pad, event,
3136             basesink->abidata.ABI.clip_segment);
3137
3138         ret =
3139             gst_base_sink_queue_object_unlocked (basesink, pad,
3140             FALSE, GST_MINI_OBJECT_CAST (event), FALSE);
3141         if (G_UNLIKELY (ret != GST_FLOW_OK))
3142           result = FALSE;
3143         else {
3144           GST_OBJECT_LOCK (basesink);
3145           basesink->have_newsegment = TRUE;
3146           GST_OBJECT_UNLOCK (basesink);
3147         }
3148       }
3149       GST_PAD_PREROLL_UNLOCK (pad);
3150       break;
3151     }
3152     case GST_EVENT_FLUSH_START:
3153       if (bclass->event)
3154         bclass->event (basesink, event);
3155
3156       GST_DEBUG_OBJECT (basesink, "flush-start %p", event);
3157
3158       gst_base_sink_flush_start (basesink, pad);
3159
3160       gst_event_unref (event);
3161       break;
3162     case GST_EVENT_FLUSH_STOP:
3163       if (bclass->event)
3164         bclass->event (basesink, event);
3165
3166       GST_DEBUG_OBJECT (basesink, "flush-stop %p", event);
3167
3168       gst_base_sink_flush_stop (basesink, pad);
3169
3170       gst_event_unref (event);
3171       break;
3172     default:
3173       /* other events are sent to queue or subclass depending on if they
3174        * are serialized. */
3175       if (GST_EVENT_IS_SERIALIZED (event)) {
3176         gst_base_sink_queue_object (basesink, pad,
3177             GST_MINI_OBJECT_CAST (event), FALSE);
3178       } else {
3179         if (bclass->event)
3180           bclass->event (basesink, event);
3181         gst_event_unref (event);
3182       }
3183       break;
3184   }
3185 done:
3186   gst_object_unref (basesink);
3187
3188   return result;
3189
3190   /* ERRORS */
3191 flushing:
3192   {
3193     GST_DEBUG_OBJECT (basesink, "we are flushing");
3194     GST_PAD_PREROLL_UNLOCK (pad);
3195     result = FALSE;
3196     gst_event_unref (event);
3197     goto done;
3198   }
3199 }
3200
3201 /* default implementation to calculate the start and end
3202  * timestamps on a buffer, subclasses can override
3203  */
3204 static void
3205 gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
3206     GstClockTime * start, GstClockTime * end)
3207 {
3208   GstClockTime timestamp, duration;
3209
3210   timestamp = GST_BUFFER_TIMESTAMP (buffer);
3211   if (GST_CLOCK_TIME_IS_VALID (timestamp)) {
3212
3213     /* get duration to calculate end time */
3214     duration = GST_BUFFER_DURATION (buffer);
3215     if (GST_CLOCK_TIME_IS_VALID (duration)) {
3216       *end = timestamp + duration;
3217     }
3218     *start = timestamp;
3219   }
3220 }
3221
3222 /* must be called with PREROLL_LOCK */
3223 static gboolean
3224 gst_base_sink_needs_preroll (GstBaseSink * basesink)
3225 {
3226   gboolean is_prerolled, res;
3227
3228   /* we have 2 cases where the PREROLL_LOCK is released:
3229    *  1) we are blocking in the PREROLL_LOCK and thus are prerolled.
3230    *  2) we are syncing on the clock
3231    */
3232   is_prerolled = basesink->have_preroll || basesink->priv->received_eos;
3233   res = !is_prerolled;
3234
3235   GST_DEBUG_OBJECT (basesink, "have_preroll: %d, EOS: %d => needs preroll: %d",
3236       basesink->have_preroll, basesink->priv->received_eos, res);
3237
3238   return res;
3239 }
3240
3241 /* with STREAM_LOCK, PREROLL_LOCK
3242  *
3243  * Takes a buffer and compare the timestamps with the last segment.
3244  * If the buffer falls outside of the segment boundaries, drop it.
3245  * Else queue the buffer for preroll and rendering.
3246  *
3247  * This function takes ownership of the buffer.
3248  */
3249 static GstFlowReturn
3250 gst_base_sink_chain_unlocked (GstBaseSink * basesink, GstPad * pad,
3251     gboolean is_list, gpointer obj)
3252 {
3253   GstBaseSinkClass *bclass;
3254   GstFlowReturn result;
3255   GstClockTime start = GST_CLOCK_TIME_NONE, end = GST_CLOCK_TIME_NONE;
3256   GstSegment *clip_segment;
3257   GstBuffer *time_buf;
3258
3259   if (G_UNLIKELY (basesink->flushing))
3260     goto flushing;
3261
3262   if (G_UNLIKELY (basesink->priv->received_eos))
3263     goto was_eos;
3264
3265   if (is_list) {
3266     time_buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0, 0);
3267     g_assert (NULL != time_buf);
3268   } else {
3269     time_buf = GST_BUFFER_CAST (obj);
3270   }
3271
3272   /* for code clarity */
3273   clip_segment = basesink->abidata.ABI.clip_segment;
3274
3275   if (G_UNLIKELY (!basesink->have_newsegment)) {
3276     gboolean sync;
3277
3278     sync = gst_base_sink_get_sync (basesink);
3279     if (sync) {
3280       GST_ELEMENT_WARNING (basesink, STREAM, FAILED,
3281           (_("Internal data flow problem.")),
3282           ("Received buffer without a new-segment. Assuming timestamps start from 0."));
3283     }
3284
3285     /* this means this sink will assume timestamps start from 0 */
3286     GST_OBJECT_LOCK (basesink);
3287     clip_segment->start = 0;
3288     clip_segment->stop = -1;
3289     basesink->segment.start = 0;
3290     basesink->segment.stop = -1;
3291     basesink->have_newsegment = TRUE;
3292     GST_OBJECT_UNLOCK (basesink);
3293   }
3294
3295   bclass = GST_BASE_SINK_GET_CLASS (basesink);
3296
3297   /* check if the buffer needs to be dropped, we first ask the subclass for the
3298    * start and end */
3299   if (bclass->get_times)
3300     bclass->get_times (basesink, time_buf, &start, &end);
3301
3302   if (!GST_CLOCK_TIME_IS_VALID (start)) {
3303     /* if the subclass does not want sync, we use our own values so that we at
3304      * least clip the buffer to the segment */
3305     gst_base_sink_get_times (basesink, time_buf, &start, &end);
3306   }
3307
3308   GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
3309       ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (end));
3310
3311   /* a dropped buffer does not participate in anything */
3312   if (GST_CLOCK_TIME_IS_VALID (start) &&
3313       (clip_segment->format == GST_FORMAT_TIME)) {
3314     if (G_UNLIKELY (!gst_segment_clip (clip_segment,
3315                 GST_FORMAT_TIME, (gint64) start, (gint64) end, NULL, NULL)))
3316       goto out_of_segment;
3317   }
3318
3319   /* now we can process the buffer in the queue, this function takes ownership
3320    * of the buffer */
3321   result = gst_base_sink_queue_object_unlocked (basesink, pad,
3322       is_list, obj, TRUE);
3323   return result;
3324
3325   /* ERRORS */
3326 flushing:
3327   {
3328     GST_DEBUG_OBJECT (basesink, "sink is flushing");
3329     gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3330     return GST_FLOW_WRONG_STATE;
3331   }
3332 was_eos:
3333   {
3334     GST_DEBUG_OBJECT (basesink,
3335         "we are EOS, dropping object, return UNEXPECTED");
3336     gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3337     return GST_FLOW_UNEXPECTED;
3338   }
3339 out_of_segment:
3340   {
3341     GST_DEBUG_OBJECT (basesink, "dropping buffer, out of clipping segment");
3342     gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3343     return GST_FLOW_OK;
3344   }
3345 }
3346
3347 /* with STREAM_LOCK
3348  */
3349 static GstFlowReturn
3350 gst_base_sink_chain_main (GstBaseSink * basesink, GstPad * pad,
3351     gboolean is_list, gpointer obj)
3352 {
3353   GstFlowReturn result;
3354
3355   if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH))
3356     goto wrong_mode;
3357
3358   GST_PAD_PREROLL_LOCK (pad);
3359   result = gst_base_sink_chain_unlocked (basesink, pad, is_list, obj);
3360   GST_PAD_PREROLL_UNLOCK (pad);
3361
3362 done:
3363   return result;
3364
3365   /* ERRORS */
3366 wrong_mode:
3367   {
3368     GST_OBJECT_LOCK (pad);
3369     GST_WARNING_OBJECT (basesink,
3370         "Push on pad %s:%s, but it was not activated in push mode",
3371         GST_DEBUG_PAD_NAME (pad));
3372     GST_OBJECT_UNLOCK (pad);
3373     gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3374     /* we don't post an error message this will signal to the peer
3375      * pushing that EOS is reached. */
3376     result = GST_FLOW_UNEXPECTED;
3377     goto done;
3378   }
3379 }
3380
3381 static GstFlowReturn
3382 gst_base_sink_chain (GstPad * pad, GstBuffer * buf)
3383 {
3384   GstBaseSink *basesink;
3385
3386   basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3387
3388   return gst_base_sink_chain_main (basesink, pad, FALSE, buf);
3389 }
3390
3391 static GstFlowReturn
3392 gst_base_sink_chain_list (GstPad * pad, GstBufferList * list)
3393 {
3394   GstBaseSink *basesink;
3395   GstBaseSinkClass *bclass;
3396   GstFlowReturn result;
3397
3398   basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3399   bclass = GST_BASE_SINK_GET_CLASS (basesink);
3400
3401   if (G_LIKELY (bclass->render_list)) {
3402     result = gst_base_sink_chain_main (basesink, pad, TRUE, list);
3403   } else {
3404     GstBufferListIterator *it;
3405     GstBuffer *group;
3406
3407     GST_INFO_OBJECT (pad, "chaining each group in list as a merged buffer");
3408
3409     it = gst_buffer_list_iterate (list);
3410
3411     if (gst_buffer_list_iterator_next_group (it)) {
3412       do {
3413         group = gst_buffer_list_iterator_merge_group (it);
3414         if (group == NULL) {
3415           group = gst_buffer_new ();
3416           GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining empty group");
3417         } else {
3418           GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining group");
3419         }
3420         result = gst_base_sink_chain_main (basesink, pad, FALSE, group);
3421       } while (result == GST_FLOW_OK
3422           && gst_buffer_list_iterator_next_group (it));
3423     } else {
3424       GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining empty group");
3425       result =
3426           gst_base_sink_chain_main (basesink, pad, FALSE, gst_buffer_new ());
3427     }
3428     gst_buffer_list_iterator_free (it);
3429     gst_buffer_list_unref (list);
3430   }
3431   return result;
3432 }
3433
3434
3435 static gboolean
3436 gst_base_sink_default_do_seek (GstBaseSink * sink, GstSegment * segment)
3437 {
3438   gboolean res = TRUE;
3439
3440   /* update our offset if the start/stop position was updated */
3441   if (segment->format == GST_FORMAT_BYTES) {
3442     segment->time = segment->start;
3443   } else if (segment->start == 0) {
3444     /* seek to start, we can implement a default for this. */
3445     segment->time = 0;
3446   } else {
3447     res = FALSE;
3448     GST_INFO_OBJECT (sink, "Can't do a default seek");
3449   }
3450
3451   return res;
3452 }
3453
3454 #define SEEK_TYPE_IS_RELATIVE(t) (((t) != GST_SEEK_TYPE_NONE) && ((t) != GST_SEEK_TYPE_SET))
3455
3456 static gboolean
3457 gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
3458     GstEvent * event, GstSegment * segment)
3459 {
3460   /* By default, we try one of 2 things:
3461    *   - For absolute seek positions, convert the requested position to our
3462    *     configured processing format and place it in the output segment \
3463    *   - For relative seek positions, convert our current (input) values to the
3464    *     seek format, adjust by the relative seek offset and then convert back to
3465    *     the processing format
3466    */
3467   GstSeekType cur_type, stop_type;
3468   gint64 cur, stop;
3469   GstSeekFlags flags;
3470   GstFormat seek_format, dest_format;
3471   gdouble rate;
3472   gboolean update;
3473   gboolean res = TRUE;
3474
3475   gst_event_parse_seek (event, &rate, &seek_format, &flags,
3476       &cur_type, &cur, &stop_type, &stop);
3477   dest_format = segment->format;
3478
3479   if (seek_format == dest_format) {
3480     gst_segment_set_seek (segment, rate, seek_format, flags,
3481         cur_type, cur, stop_type, stop, &update);
3482     return TRUE;
3483   }
3484
3485   if (cur_type != GST_SEEK_TYPE_NONE) {
3486     /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3487     res =
3488         gst_pad_query_convert (sink->sinkpad, seek_format, cur, &dest_format,
3489         &cur);
3490     cur_type = GST_SEEK_TYPE_SET;
3491   }
3492
3493   if (res && stop_type != GST_SEEK_TYPE_NONE) {
3494     /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3495     res =
3496         gst_pad_query_convert (sink->sinkpad, seek_format, stop, &dest_format,
3497         &stop);
3498     stop_type = GST_SEEK_TYPE_SET;
3499   }
3500
3501   /* And finally, configure our output segment in the desired format */
3502   gst_segment_set_seek (segment, rate, dest_format, flags, cur_type, cur,
3503       stop_type, stop, &update);
3504
3505   if (!res)
3506     goto no_format;
3507
3508   return res;
3509
3510 no_format:
3511   {
3512     GST_DEBUG_OBJECT (sink, "undefined format given, seek aborted.");
3513     return FALSE;
3514   }
3515 }
3516
3517 /* perform a seek, only executed in pull mode */
3518 static gboolean
3519 gst_base_sink_perform_seek (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3520 {
3521   gboolean flush;
3522   gdouble rate;
3523   GstFormat seek_format, dest_format;
3524   GstSeekFlags flags;
3525   GstSeekType cur_type, stop_type;
3526   gboolean seekseg_configured = FALSE;
3527   gint64 cur, stop;
3528   gboolean update, res = TRUE;
3529   GstSegment seeksegment;
3530
3531   dest_format = sink->segment.format;
3532
3533   if (event) {
3534     GST_DEBUG_OBJECT (sink, "performing seek with event %p", event);
3535     gst_event_parse_seek (event, &rate, &seek_format, &flags,
3536         &cur_type, &cur, &stop_type, &stop);
3537
3538     flush = flags & GST_SEEK_FLAG_FLUSH;
3539   } else {
3540     GST_DEBUG_OBJECT (sink, "performing seek without event");
3541     flush = FALSE;
3542   }
3543
3544   if (flush) {
3545     GST_DEBUG_OBJECT (sink, "flushing upstream");
3546     gst_pad_push_event (pad, gst_event_new_flush_start ());
3547     gst_base_sink_flush_start (sink, pad);
3548   } else {
3549     GST_DEBUG_OBJECT (sink, "pausing pulling thread");
3550   }
3551
3552   GST_PAD_STREAM_LOCK (pad);
3553
3554   /* If we configured the seeksegment above, don't overwrite it now. Otherwise
3555    * copy the current segment info into the temp segment that we can actually
3556    * attempt the seek with. We only update the real segment if the seek suceeds. */
3557   if (!seekseg_configured) {
3558     memcpy (&seeksegment, &sink->segment, sizeof (GstSegment));
3559
3560     /* now configure the final seek segment */
3561     if (event) {
3562       if (sink->segment.format != seek_format) {
3563         /* OK, here's where we give the subclass a chance to convert the relative
3564          * seek into an absolute one in the processing format. We set up any
3565          * absolute seek above, before taking the stream lock. */
3566         if (!gst_base_sink_default_prepare_seek_segment (sink, event,
3567                 &seeksegment)) {
3568           GST_DEBUG_OBJECT (sink,
3569               "Preparing the seek failed after flushing. " "Aborting seek");
3570           res = FALSE;
3571         }
3572       } else {
3573         /* The seek format matches our processing format, no need to ask the
3574          * the subclass to configure the segment. */
3575         gst_segment_set_seek (&seeksegment, rate, seek_format, flags,
3576             cur_type, cur, stop_type, stop, &update);
3577       }
3578     }
3579     /* Else, no seek event passed, so we're just (re)starting the
3580        current segment. */
3581   }
3582
3583   if (res) {
3584     GST_DEBUG_OBJECT (sink, "segment configured from %" G_GINT64_FORMAT
3585         " to %" G_GINT64_FORMAT ", position %" G_GINT64_FORMAT,
3586         seeksegment.start, seeksegment.stop, seeksegment.last_stop);
3587
3588     /* do the seek, segment.last_stop contains the new position. */
3589     res = gst_base_sink_default_do_seek (sink, &seeksegment);
3590   }
3591
3592
3593   if (flush) {
3594     GST_DEBUG_OBJECT (sink, "stop flushing upstream");
3595     gst_pad_push_event (pad, gst_event_new_flush_stop ());
3596     gst_base_sink_flush_stop (sink, pad);
3597   } else if (res && sink->abidata.ABI.running) {
3598     /* we are running the current segment and doing a non-flushing seek,
3599      * close the segment first based on the last_stop. */
3600     GST_DEBUG_OBJECT (sink, "closing running segment %" G_GINT64_FORMAT
3601         " to %" G_GINT64_FORMAT, sink->segment.start, sink->segment.last_stop);
3602   }
3603
3604   /* The subclass must have converted the segment to the processing format
3605    * by now */
3606   if (res && seeksegment.format != dest_format) {
3607     GST_DEBUG_OBJECT (sink, "Subclass failed to prepare a seek segment "
3608         "in the correct format. Aborting seek.");
3609     res = FALSE;
3610   }
3611
3612   /* if successfull seek, we update our real segment and push
3613    * out the new segment. */
3614   if (res) {
3615     memcpy (&sink->segment, &seeksegment, sizeof (GstSegment));
3616
3617     if (sink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3618       gst_element_post_message (GST_ELEMENT (sink),
3619           gst_message_new_segment_start (GST_OBJECT (sink),
3620               sink->segment.format, sink->segment.last_stop));
3621     }
3622   }
3623
3624   sink->priv->discont = TRUE;
3625   sink->abidata.ABI.running = TRUE;
3626
3627   GST_PAD_STREAM_UNLOCK (pad);
3628
3629   return res;
3630 }
3631
3632 static void
3633 set_step_info (GstBaseSink * sink, GstStepInfo * current, GstStepInfo * pending,
3634     guint seqnum, GstFormat format, guint64 amount, gdouble rate,
3635     gboolean flush, gboolean intermediate)
3636 {
3637   GST_OBJECT_LOCK (sink);
3638   pending->seqnum = seqnum;
3639   pending->format = format;
3640   pending->amount = amount;
3641   pending->position = 0;
3642   pending->rate = rate;
3643   pending->flush = flush;
3644   pending->intermediate = intermediate;
3645   pending->valid = TRUE;
3646   /* flush invalidates the current stepping segment */
3647   if (flush)
3648     current->valid = FALSE;
3649   GST_OBJECT_UNLOCK (sink);
3650 }
3651
3652 static gboolean
3653 gst_base_sink_perform_step (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3654 {
3655   GstBaseSinkPrivate *priv;
3656   GstBaseSinkClass *bclass;
3657   gboolean flush, intermediate;
3658   gdouble rate;
3659   GstFormat format;
3660   guint64 amount;
3661   guint seqnum;
3662   GstStepInfo *pending, *current;
3663   GstMessage *message;
3664
3665   bclass = GST_BASE_SINK_GET_CLASS (sink);
3666   priv = sink->priv;
3667
3668   GST_DEBUG_OBJECT (sink, "performing step with event %p", event);
3669
3670   gst_event_parse_step (event, &format, &amount, &rate, &flush, &intermediate);
3671   seqnum = gst_event_get_seqnum (event);
3672
3673   pending = &priv->pending_step;
3674   current = &priv->current_step;
3675
3676   /* post message first */
3677   message = gst_message_new_step_start (GST_OBJECT (sink), FALSE, format,
3678       amount, rate, flush, intermediate);
3679   gst_message_set_seqnum (message, seqnum);
3680   gst_element_post_message (GST_ELEMENT (sink), message);
3681
3682   if (flush) {
3683     /* we need to call ::unlock before locking PREROLL_LOCK
3684      * since we lock it before going into ::render */
3685     if (bclass->unlock)
3686       bclass->unlock (sink);
3687
3688     GST_PAD_PREROLL_LOCK (sink->sinkpad);
3689     /* now that we have the PREROLL lock, clear our unlock request */
3690     if (bclass->unlock_stop)
3691       bclass->unlock_stop (sink);
3692
3693     /* update the stepinfo and make it valid */
3694     set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3695         intermediate);
3696
3697     if (sink->priv->async_enabled) {
3698       /* and we need to commit our state again on the next
3699        * prerolled buffer */
3700       sink->playing_async = TRUE;
3701       priv->pending_step.need_preroll = TRUE;
3702       sink->need_preroll = FALSE;
3703       gst_element_lost_state_full (GST_ELEMENT_CAST (sink), FALSE);
3704     } else {
3705       sink->priv->have_latency = TRUE;
3706       sink->need_preroll = FALSE;
3707     }
3708     priv->current_sstart = GST_CLOCK_TIME_NONE;
3709     priv->current_sstop = GST_CLOCK_TIME_NONE;
3710     priv->eos_rtime = GST_CLOCK_TIME_NONE;
3711     priv->call_preroll = TRUE;
3712     gst_base_sink_set_last_buffer (sink, NULL);
3713     gst_base_sink_reset_qos (sink);
3714
3715     if (sink->clock_id) {
3716       gst_clock_id_unschedule (sink->clock_id);
3717     }
3718
3719     if (sink->have_preroll) {
3720       GST_DEBUG_OBJECT (sink, "signal waiter");
3721       priv->step_unlock = TRUE;
3722       GST_PAD_PREROLL_SIGNAL (sink->sinkpad);
3723     }
3724     GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
3725   } else {
3726     /* update the stepinfo and make it valid */
3727     set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3728         intermediate);
3729   }
3730
3731   return TRUE;
3732 }
3733
3734 /* with STREAM_LOCK
3735  */
3736 static void
3737 gst_base_sink_loop (GstPad * pad)
3738 {
3739   GstBaseSink *basesink;
3740   GstBuffer *buf = NULL;
3741   GstFlowReturn result;
3742   guint blocksize;
3743   guint64 offset;
3744
3745   basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3746
3747   g_assert (basesink->pad_mode == GST_ACTIVATE_PULL);
3748
3749   if ((blocksize = basesink->priv->blocksize) == 0)
3750     blocksize = -1;
3751
3752   offset = basesink->segment.last_stop;
3753
3754   GST_DEBUG_OBJECT (basesink, "pulling %" G_GUINT64_FORMAT ", %u",
3755       offset, blocksize);
3756
3757   result = gst_pad_pull_range (pad, offset, blocksize, &buf);
3758   if (G_UNLIKELY (result != GST_FLOW_OK))
3759     goto paused;
3760
3761   if (G_UNLIKELY (buf == NULL))
3762     goto no_buffer;
3763
3764   offset += GST_BUFFER_SIZE (buf);
3765
3766   gst_segment_set_last_stop (&basesink->segment, GST_FORMAT_BYTES, offset);
3767
3768   GST_PAD_PREROLL_LOCK (pad);
3769   result = gst_base_sink_chain_unlocked (basesink, pad, FALSE, buf);
3770   GST_PAD_PREROLL_UNLOCK (pad);
3771   if (G_UNLIKELY (result != GST_FLOW_OK))
3772     goto paused;
3773
3774   return;
3775
3776   /* ERRORS */
3777 paused:
3778   {
3779     GST_LOG_OBJECT (basesink, "pausing task, reason %s",
3780         gst_flow_get_name (result));
3781     gst_pad_pause_task (pad);
3782     /* fatal errors and NOT_LINKED cause EOS */
3783     if (GST_FLOW_IS_FATAL (result) || result == GST_FLOW_NOT_LINKED) {
3784       if (result == GST_FLOW_UNEXPECTED) {
3785         /* perform EOS logic */
3786         if (basesink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3787           gst_element_post_message (GST_ELEMENT_CAST (basesink),
3788               gst_message_new_segment_done (GST_OBJECT_CAST (basesink),
3789                   basesink->segment.format, basesink->segment.last_stop));
3790         } else {
3791           gst_base_sink_event (pad, gst_event_new_eos ());
3792         }
3793       } else {
3794         /* for fatal errors we post an error message, post the error
3795          * first so the app knows about the error first. */
3796         GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
3797             (_("Internal data stream error.")),
3798             ("stream stopped, reason %s", gst_flow_get_name (result)));
3799         gst_base_sink_event (pad, gst_event_new_eos ());
3800       }
3801     }
3802     return;
3803   }
3804 no_buffer:
3805   {
3806     GST_LOG_OBJECT (basesink, "no buffer, pausing");
3807     GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
3808         (_("Internal data flow error.")), ("element returned NULL buffer"));
3809     result = GST_FLOW_ERROR;
3810     goto paused;
3811   }
3812 }
3813
3814 static gboolean
3815 gst_base_sink_set_flushing (GstBaseSink * basesink, GstPad * pad,
3816     gboolean flushing)
3817 {
3818   GstBaseSinkClass *bclass;
3819
3820   bclass = GST_BASE_SINK_GET_CLASS (basesink);
3821
3822   if (flushing) {
3823     /* unlock any subclasses, we need to do this before grabbing the
3824      * PREROLL_LOCK since we hold this lock before going into ::render. */
3825     if (bclass->unlock)
3826       bclass->unlock (basesink);
3827   }
3828
3829   GST_PAD_PREROLL_LOCK (pad);
3830   basesink->flushing = flushing;
3831   if (flushing) {
3832     /* step 1, now that we have the PREROLL lock, clear our unlock request */
3833     if (bclass->unlock_stop)
3834       bclass->unlock_stop (basesink);
3835
3836     /* set need_preroll before we unblock the clock. If the clock is unblocked
3837      * before timing out, we can reuse the buffer for preroll. */
3838     basesink->need_preroll = TRUE;
3839
3840     /* step 2, unblock clock sync (if any) or any other blocking thing */
3841     if (basesink->clock_id) {
3842       gst_clock_id_unschedule (basesink->clock_id);
3843     }
3844
3845     /* flush out the data thread if it's locked in finish_preroll, this will
3846      * also flush out the EOS state */
3847     GST_DEBUG_OBJECT (basesink,
3848         "flushing out data thread, need preroll to TRUE");
3849     gst_base_sink_preroll_queue_flush (basesink, pad);
3850   }
3851   GST_PAD_PREROLL_UNLOCK (pad);
3852
3853   return TRUE;
3854 }
3855
3856 static gboolean
3857 gst_base_sink_default_activate_pull (GstBaseSink * basesink, gboolean active)
3858 {
3859   gboolean result;
3860
3861   if (active) {
3862     /* start task */
3863     result = gst_pad_start_task (basesink->sinkpad,
3864         (GstTaskFunction) gst_base_sink_loop, basesink->sinkpad);
3865   } else {
3866     /* step 2, make sure streaming finishes */
3867     result = gst_pad_stop_task (basesink->sinkpad);
3868   }
3869
3870   return result;
3871 }
3872
3873 static gboolean
3874 gst_base_sink_pad_activate (GstPad * pad)
3875 {
3876   gboolean result = FALSE;
3877   GstBaseSink *basesink;
3878
3879   basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3880
3881   GST_DEBUG_OBJECT (basesink, "Trying pull mode first");
3882
3883   gst_base_sink_set_flushing (basesink, pad, FALSE);
3884
3885   /* we need to have the pull mode enabled */
3886   if (!basesink->can_activate_pull) {
3887     GST_DEBUG_OBJECT (basesink, "pull mode disabled");
3888     goto fallback;
3889   }
3890
3891   /* check if downstreams supports pull mode at all */
3892   if (!gst_pad_check_pull_range (pad)) {
3893     GST_DEBUG_OBJECT (basesink, "pull mode not supported");
3894     goto fallback;
3895   }
3896
3897   /* set the pad mode before starting the task so that it's in the
3898    * correct state for the new thread. also the sink set_caps and get_caps
3899    * function checks this */
3900   basesink->pad_mode = GST_ACTIVATE_PULL;
3901
3902   /* we first try to negotiate a format so that when we try to activate
3903    * downstream, it knows about our format */
3904   if (!gst_base_sink_negotiate_pull (basesink)) {
3905     GST_DEBUG_OBJECT (basesink, "failed to negotiate in pull mode");
3906     goto fallback;
3907   }
3908
3909   /* ok activate now */
3910   if (!gst_pad_activate_pull (pad, TRUE)) {
3911     /* clear any pending caps */
3912     GST_OBJECT_LOCK (basesink);
3913     gst_caps_replace (&basesink->priv->pull_caps, NULL);
3914     GST_OBJECT_UNLOCK (basesink);
3915     GST_DEBUG_OBJECT (basesink, "failed to activate in pull mode");
3916     goto fallback;
3917   }
3918
3919   GST_DEBUG_OBJECT (basesink, "Success activating pull mode");
3920   result = TRUE;
3921   goto done;
3922
3923   /* push mode fallback */
3924 fallback:
3925   GST_DEBUG_OBJECT (basesink, "Falling back to push mode");
3926   if ((result = gst_pad_activate_push (pad, TRUE))) {
3927     GST_DEBUG_OBJECT (basesink, "Success activating push mode");
3928   }
3929
3930 done:
3931   if (!result) {
3932     GST_WARNING_OBJECT (basesink, "Could not activate pad in either mode");
3933     gst_base_sink_set_flushing (basesink, pad, TRUE);
3934   }
3935
3936   gst_object_unref (basesink);
3937
3938   return result;
3939 }
3940
3941 static gboolean
3942 gst_base_sink_pad_activate_push (GstPad * pad, gboolean active)
3943 {
3944   gboolean result;
3945   GstBaseSink *basesink;
3946
3947   basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3948
3949   if (active) {
3950     if (!basesink->can_activate_push) {
3951       result = FALSE;
3952       basesink->pad_mode = GST_ACTIVATE_NONE;
3953     } else {
3954       result = TRUE;
3955       basesink->pad_mode = GST_ACTIVATE_PUSH;
3956     }
3957   } else {
3958     if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH)) {
3959       g_warning ("Internal GStreamer activation error!!!");
3960       result = FALSE;
3961     } else {
3962       gst_base_sink_set_flushing (basesink, pad, TRUE);
3963       result = TRUE;
3964       basesink->pad_mode = GST_ACTIVATE_NONE;
3965     }
3966   }
3967
3968   gst_object_unref (basesink);
3969
3970   return result;
3971 }
3972
3973 static gboolean
3974 gst_base_sink_negotiate_pull (GstBaseSink * basesink)
3975 {
3976   GstCaps *caps;
3977   gboolean result;
3978
3979   result = FALSE;
3980
3981   /* this returns the intersection between our caps and the peer caps. If there
3982    * is no peer, it returns NULL and we can't operate in pull mode so we can
3983    * fail the negotiation. */
3984   caps = gst_pad_get_allowed_caps (GST_BASE_SINK_PAD (basesink));
3985   if (caps == NULL || gst_caps_is_empty (caps))
3986     goto no_caps_possible;
3987
3988   GST_DEBUG_OBJECT (basesink, "allowed caps: %" GST_PTR_FORMAT, caps);
3989
3990   caps = gst_caps_make_writable (caps);
3991   /* get the first (prefered) format */
3992   gst_caps_truncate (caps);
3993   /* try to fixate */
3994   gst_pad_fixate_caps (GST_BASE_SINK_PAD (basesink), caps);
3995
3996   GST_DEBUG_OBJECT (basesink, "fixated to: %" GST_PTR_FORMAT, caps);
3997
3998   if (gst_caps_is_any (caps)) {
3999     GST_DEBUG_OBJECT (basesink, "caps were ANY after fixating, "
4000         "allowing pull()");
4001     /* neither side has template caps in this case, so they are prepared for
4002        pull() without setcaps() */
4003     result = TRUE;
4004   } else if (gst_caps_is_fixed (caps)) {
4005     if (!gst_pad_set_caps (GST_BASE_SINK_PAD (basesink), caps))
4006       goto could_not_set_caps;
4007
4008     GST_OBJECT_LOCK (basesink);
4009     gst_caps_replace (&basesink->priv->pull_caps, caps);
4010     GST_OBJECT_UNLOCK (basesink);
4011
4012     result = TRUE;
4013   }
4014
4015   gst_caps_unref (caps);
4016
4017   return result;
4018
4019 no_caps_possible:
4020   {
4021     GST_INFO_OBJECT (basesink, "Pipeline could not agree on caps");
4022     GST_DEBUG_OBJECT (basesink, "get_allowed_caps() returned EMPTY");
4023     if (caps)
4024       gst_caps_unref (caps);
4025     return FALSE;
4026   }
4027 could_not_set_caps:
4028   {
4029     GST_INFO_OBJECT (basesink, "Could not set caps: %" GST_PTR_FORMAT, caps);
4030     gst_caps_unref (caps);
4031     return FALSE;
4032   }
4033 }
4034
4035 /* this won't get called until we implement an activate function */
4036 static gboolean
4037 gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active)
4038 {
4039   gboolean result = FALSE;
4040   GstBaseSink *basesink;
4041   GstBaseSinkClass *bclass;
4042
4043   basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4044   bclass = GST_BASE_SINK_GET_CLASS (basesink);
4045
4046   if (active) {
4047     GstFormat format;
4048     gint64 duration;
4049
4050     /* we mark we have a newsegment here because pull based
4051      * mode works just fine without having a newsegment before the
4052      * first buffer */
4053     format = GST_FORMAT_BYTES;
4054
4055     gst_segment_init (&basesink->segment, format);
4056     gst_segment_init (basesink->abidata.ABI.clip_segment, format);
4057     GST_OBJECT_LOCK (basesink);
4058     basesink->have_newsegment = TRUE;
4059     GST_OBJECT_UNLOCK (basesink);
4060
4061     /* get the peer duration in bytes */
4062     result = gst_pad_query_peer_duration (pad, &format, &duration);
4063     if (result) {
4064       GST_DEBUG_OBJECT (basesink,
4065           "setting duration in bytes to %" G_GINT64_FORMAT, duration);
4066       gst_segment_set_duration (basesink->abidata.ABI.clip_segment, format,
4067           duration);
4068       gst_segment_set_duration (&basesink->segment, format, duration);
4069     } else {
4070       GST_DEBUG_OBJECT (basesink, "unknown duration");
4071     }
4072
4073     if (bclass->activate_pull)
4074       result = bclass->activate_pull (basesink, TRUE);
4075     else
4076       result = FALSE;
4077
4078     if (!result)
4079       goto activate_failed;
4080
4081   } else {
4082     if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PULL)) {
4083       g_warning ("Internal GStreamer activation error!!!");
4084       result = FALSE;
4085     } else {
4086       result = gst_base_sink_set_flushing (basesink, pad, TRUE);
4087       if (bclass->activate_pull)
4088         result &= bclass->activate_pull (basesink, FALSE);
4089       basesink->pad_mode = GST_ACTIVATE_NONE;
4090       /* clear any pending caps */
4091       GST_OBJECT_LOCK (basesink);
4092       gst_caps_replace (&basesink->priv->pull_caps, NULL);
4093       GST_OBJECT_UNLOCK (basesink);
4094     }
4095   }
4096   gst_object_unref (basesink);
4097
4098   return result;
4099
4100   /* ERRORS */
4101 activate_failed:
4102   {
4103     /* reset, as starting the thread failed */
4104     basesink->pad_mode = GST_ACTIVATE_NONE;
4105
4106     GST_ERROR_OBJECT (basesink, "subclass failed to activate in pull mode");
4107     return FALSE;
4108   }
4109 }
4110
4111 /* send an event to our sinkpad peer. */
4112 static gboolean
4113 gst_base_sink_send_event (GstElement * element, GstEvent * event)
4114 {
4115   GstPad *pad;
4116   GstBaseSink *basesink = GST_BASE_SINK (element);
4117   gboolean forward, result = TRUE;
4118   GstActivateMode mode;
4119
4120   GST_OBJECT_LOCK (element);
4121   /* get the pad and the scheduling mode */
4122   pad = gst_object_ref (basesink->sinkpad);
4123   mode = basesink->pad_mode;
4124   GST_OBJECT_UNLOCK (element);
4125
4126   /* only push UPSTREAM events upstream */
4127   forward = GST_EVENT_IS_UPSTREAM (event);
4128
4129   switch (GST_EVENT_TYPE (event)) {
4130     case GST_EVENT_LATENCY:
4131     {
4132       GstClockTime latency;
4133
4134       gst_event_parse_latency (event, &latency);
4135
4136       /* store the latency. We use this to adjust the running_time before syncing
4137        * it to the clock. */
4138       GST_OBJECT_LOCK (element);
4139       basesink->priv->latency = latency;
4140       if (!basesink->priv->have_latency)
4141         forward = FALSE;
4142       GST_OBJECT_UNLOCK (element);
4143       GST_DEBUG_OBJECT (basesink, "latency set to %" GST_TIME_FORMAT,
4144           GST_TIME_ARGS (latency));
4145
4146       /* We forward this event so that all elements know about the global pipeline
4147        * latency. This is interesting for an element when it wants to figure out
4148        * when a particular piece of data will be rendered. */
4149       break;
4150     }
4151     case GST_EVENT_SEEK:
4152       /* in pull mode we will execute the seek */
4153       if (mode == GST_ACTIVATE_PULL)
4154         result = gst_base_sink_perform_seek (basesink, pad, event);
4155       break;
4156     case GST_EVENT_STEP:
4157       result = gst_base_sink_perform_step (basesink, pad, event);
4158       forward = FALSE;
4159       break;
4160     default:
4161       break;
4162   }
4163
4164   if (forward) {
4165     result = gst_pad_push_event (pad, event);
4166   } else {
4167     /* not forwarded, unref the event */
4168     gst_event_unref (event);
4169   }
4170
4171   gst_object_unref (pad);
4172   return result;
4173 }
4174
4175 static gboolean
4176 gst_base_sink_peer_query (GstBaseSink * sink, GstQuery * query)
4177 {
4178   GstPad *peer;
4179   gboolean res = FALSE;
4180
4181   if ((peer = gst_pad_get_peer (sink->sinkpad))) {
4182     res = gst_pad_query (peer, query);
4183     gst_object_unref (peer);
4184   }
4185   return res;
4186 }
4187
4188 /* get the end position of the last seen object, this is used
4189  * for EOS and for making sure that we don't report a position we
4190  * have not reached yet. With LOCK. */
4191 static gboolean
4192 gst_base_sink_get_position_last (GstBaseSink * basesink, GstFormat format,
4193     gint64 * cur, gboolean * upstream)
4194 {
4195   GstFormat oformat;
4196   GstSegment *segment;
4197   gboolean ret = TRUE;
4198
4199   segment = &basesink->segment;
4200   oformat = segment->format;
4201
4202   if (oformat == GST_FORMAT_TIME) {
4203     /* return last observed stream time, we keep the stream time around in the
4204      * time format. */
4205     *cur = basesink->priv->current_sstop;
4206   } else {
4207     /* convert last stop to stream time */
4208     *cur = gst_segment_to_stream_time (segment, oformat, segment->last_stop);
4209   }
4210
4211   if (*cur != -1 && oformat != format) {
4212     GST_OBJECT_UNLOCK (basesink);
4213     /* convert to the target format if we need to, release lock first */
4214     ret =
4215         gst_pad_query_convert (basesink->sinkpad, oformat, *cur, &format, cur);
4216     if (!ret) {
4217       *cur = -1;
4218       *upstream = TRUE;
4219     }
4220     GST_OBJECT_LOCK (basesink);
4221   }
4222
4223   GST_DEBUG_OBJECT (basesink, "POSITION: %" GST_TIME_FORMAT,
4224       GST_TIME_ARGS (*cur));
4225
4226   return ret;
4227 }
4228
4229 /* get the position when we are PAUSED, this is the stream time of the buffer
4230  * that prerolled. If no buffer is prerolled (we are still flushing), this
4231  * value will be -1. With LOCK. */
4232 static gboolean
4233 gst_base_sink_get_position_paused (GstBaseSink * basesink, GstFormat format,
4234     gint64 * cur, gboolean * upstream)
4235 {
4236   gboolean res;
4237   gint64 time;
4238   GstSegment *segment;
4239   GstFormat oformat;
4240
4241   /* we don't use the clip segment in pull mode, when seeking we update the
4242    * main segment directly with the new segment values without it having to be
4243    * activated by the rendering after preroll */
4244   if (basesink->pad_mode == GST_ACTIVATE_PUSH)
4245     segment = basesink->abidata.ABI.clip_segment;
4246   else
4247     segment = &basesink->segment;
4248   oformat = segment->format;
4249
4250   if (oformat == GST_FORMAT_TIME) {
4251     *cur = basesink->priv->current_sstart;
4252     if (segment->rate < 0.0 &&
4253         GST_CLOCK_TIME_IS_VALID (basesink->priv->current_sstop)) {
4254       /* for reverse playback we prefer the stream time stop position if we have
4255        * one */
4256       *cur = basesink->priv->current_sstop;
4257     }
4258   } else {
4259     *cur = gst_segment_to_stream_time (segment, oformat, segment->last_stop);
4260   }
4261
4262   time = segment->time;
4263
4264   if (*cur != -1) {
4265     *cur = MAX (*cur, time);
4266     GST_DEBUG_OBJECT (basesink, "POSITION as max: %" GST_TIME_FORMAT
4267         ", time %" GST_TIME_FORMAT, GST_TIME_ARGS (*cur), GST_TIME_ARGS (time));
4268   } else {
4269     /* we have no buffer, use the segment times. */
4270     if (segment->rate >= 0.0) {
4271       /* forward, next position is always the time of the segment */
4272       *cur = time;
4273       GST_DEBUG_OBJECT (basesink, "POSITION as time: %" GST_TIME_FORMAT,
4274           GST_TIME_ARGS (*cur));
4275     } else {
4276       /* reverse, next expected timestamp is segment->stop. We use the function
4277        * to get things right for negative applied_rates. */
4278       *cur = gst_segment_to_stream_time (segment, oformat, segment->stop);
4279       GST_DEBUG_OBJECT (basesink, "reverse POSITION: %" GST_TIME_FORMAT,
4280           GST_TIME_ARGS (*cur));
4281     }
4282   }
4283
4284   res = (*cur != -1);
4285   if (res && oformat != format) {
4286     GST_OBJECT_UNLOCK (basesink);
4287     res =
4288         gst_pad_query_convert (basesink->sinkpad, oformat, *cur, &format, cur);
4289     if (!res) {
4290       *cur = -1;
4291       *upstream = TRUE;
4292     }
4293     GST_OBJECT_LOCK (basesink);
4294   }
4295
4296   return res;
4297 }
4298
4299 static gboolean
4300 gst_base_sink_get_position (GstBaseSink * basesink, GstFormat format,
4301     gint64 * cur, gboolean * upstream)
4302 {
4303   GstClock *clock;
4304   gboolean res = FALSE;
4305   GstFormat oformat, tformat;
4306   GstClockTime now, latency;
4307   GstClockTimeDiff base;
4308   gint64 time, accum, duration;
4309   gdouble rate;
4310   gint64 last;
4311
4312   GST_OBJECT_LOCK (basesink);
4313   /* our intermediate time format */
4314   tformat = GST_FORMAT_TIME;
4315   /* get the format in the segment */
4316   oformat = basesink->segment.format;
4317
4318   /* can only give answer based on the clock if not EOS */
4319   if (G_UNLIKELY (basesink->eos))
4320     goto in_eos;
4321
4322   /* we can only get the segment when we are not NULL or READY */
4323   if (!basesink->have_newsegment)
4324     goto wrong_state;
4325
4326   /* when not in PLAYING or when we're busy with a state change, we
4327    * cannot read from the clock so we report time based on the
4328    * last seen timestamp. */
4329   if (GST_STATE (basesink) != GST_STATE_PLAYING ||
4330       GST_STATE_PENDING (basesink) != GST_STATE_VOID_PENDING)
4331     goto in_pause;
4332
4333   /* we need to sync on the clock. */
4334   if (basesink->sync == FALSE)
4335     goto no_sync;
4336
4337   /* and we need a clock */
4338   if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (basesink)) == NULL))
4339     goto no_sync;
4340
4341   /* collect all data we need holding the lock */
4342   if (GST_CLOCK_TIME_IS_VALID (basesink->segment.time))
4343     time = basesink->segment.time;
4344   else
4345     time = 0;
4346
4347   if (GST_CLOCK_TIME_IS_VALID (basesink->segment.stop))
4348     duration = basesink->segment.stop - basesink->segment.start;
4349   else
4350     duration = 0;
4351
4352   base = GST_ELEMENT_CAST (basesink)->base_time;
4353   accum = basesink->segment.accum;
4354   rate = basesink->segment.rate * basesink->segment.applied_rate;
4355   latency = basesink->priv->latency;
4356
4357   gst_object_ref (clock);
4358
4359   /* this function might release the LOCK */
4360   gst_base_sink_get_position_last (basesink, format, &last, upstream);
4361
4362   /* need to release the object lock before we can get the time,
4363    * a clock might take the LOCK of the provider, which could be
4364    * a basesink subclass. */
4365   GST_OBJECT_UNLOCK (basesink);
4366
4367   now = gst_clock_get_time (clock);
4368
4369   if (oformat != tformat) {
4370     /* convert accum, time and duration to time */
4371     if (!gst_pad_query_convert (basesink->sinkpad, oformat, accum, &tformat,
4372             &accum))
4373       goto convert_failed;
4374     if (!gst_pad_query_convert (basesink->sinkpad, oformat, duration, &tformat,
4375             &duration))
4376       goto convert_failed;
4377     if (!gst_pad_query_convert (basesink->sinkpad, oformat, time, &tformat,
4378             &time))
4379       goto convert_failed;
4380   }
4381
4382   /* subtract base time and accumulated time from the clock time.
4383    * Make sure we don't go negative. This is the current time in
4384    * the segment which we need to scale with the combined
4385    * rate and applied rate. */
4386   base += accum;
4387   base += latency;
4388   if (GST_CLOCK_DIFF (base, now) < 0)
4389     base = now;
4390
4391   /* for negative rates we need to count back from the segment
4392    * duration. */
4393   if (rate < 0.0)
4394     time += duration;
4395
4396   *cur = time + gst_guint64_to_gdouble (now - base) * rate;
4397
4398   /* never report more than last seen position */
4399   if (last != -1)
4400     *cur = MIN (last, *cur);
4401
4402   gst_object_unref (clock);
4403
4404   GST_DEBUG_OBJECT (basesink,
4405       "now %" GST_TIME_FORMAT " - base %" GST_TIME_FORMAT " - accum %"
4406       GST_TIME_FORMAT " + time %" GST_TIME_FORMAT,
4407       GST_TIME_ARGS (now), GST_TIME_ARGS (base),
4408       GST_TIME_ARGS (accum), GST_TIME_ARGS (time));
4409
4410   if (oformat != format) {
4411     /* convert time to final format */
4412     if (!gst_pad_query_convert (basesink->sinkpad, tformat, *cur, &format, cur))
4413       goto convert_failed;
4414   }
4415
4416   res = TRUE;
4417
4418 done:
4419   GST_DEBUG_OBJECT (basesink, "res: %d, POSITION: %" GST_TIME_FORMAT,
4420       res, GST_TIME_ARGS (*cur));
4421   return res;
4422
4423   /* special cases */
4424 in_eos:
4425   {
4426     GST_DEBUG_OBJECT (basesink, "position in EOS");
4427     res = gst_base_sink_get_position_last (basesink, format, cur, upstream);
4428     GST_OBJECT_UNLOCK (basesink);
4429     goto done;
4430   }
4431 in_pause:
4432   {
4433     GST_DEBUG_OBJECT (basesink, "position in PAUSED");
4434     res = gst_base_sink_get_position_paused (basesink, format, cur, upstream);
4435     GST_OBJECT_UNLOCK (basesink);
4436     goto done;
4437   }
4438 wrong_state:
4439   {
4440     /* in NULL or READY we always return FALSE and -1 */
4441     GST_DEBUG_OBJECT (basesink, "position in wrong state, return -1");
4442     res = FALSE;
4443     *cur = -1;
4444     GST_OBJECT_UNLOCK (basesink);
4445     goto done;
4446   }
4447 no_sync:
4448   {
4449     /* report last seen timestamp if any, else ask upstream to answer */
4450     if ((*cur = basesink->priv->current_sstart) != -1)
4451       res = TRUE;
4452     else
4453       *upstream = TRUE;
4454
4455     GST_DEBUG_OBJECT (basesink, "no sync, res %d, POSITION %" GST_TIME_FORMAT,
4456         res, GST_TIME_ARGS (*cur));
4457     GST_OBJECT_UNLOCK (basesink);
4458     return res;
4459   }
4460 convert_failed:
4461   {
4462     GST_DEBUG_OBJECT (basesink, "convert failed, try upstream");
4463     *upstream = TRUE;
4464     return FALSE;
4465   }
4466 }
4467
4468 static gboolean
4469 gst_base_sink_query (GstElement * element, GstQuery * query)
4470 {
4471   gboolean res = FALSE;
4472
4473   GstBaseSink *basesink = GST_BASE_SINK (element);
4474
4475   switch (GST_QUERY_TYPE (query)) {
4476     case GST_QUERY_POSITION:
4477     {
4478       gint64 cur = 0;
4479       GstFormat format;
4480       gboolean upstream = FALSE;
4481
4482       gst_query_parse_position (query, &format, NULL);
4483
4484       GST_DEBUG_OBJECT (basesink, "position format %d", format);
4485
4486       /* first try to get the position based on the clock */
4487       if ((res =
4488               gst_base_sink_get_position (basesink, format, &cur, &upstream))) {
4489         gst_query_set_position (query, format, cur);
4490       } else if (upstream) {
4491         /* fallback to peer query */
4492         res = gst_base_sink_peer_query (basesink, query);
4493       }
4494       break;
4495     }
4496     case GST_QUERY_DURATION:
4497     {
4498       GstFormat format, uformat;
4499       gint64 duration, uduration;
4500
4501       gst_query_parse_duration (query, &format, NULL);
4502
4503       GST_DEBUG_OBJECT (basesink, "duration query in format %s",
4504           gst_format_get_name (format));
4505
4506       if (basesink->pad_mode == GST_ACTIVATE_PULL) {
4507         uformat = GST_FORMAT_BYTES;
4508
4509         /* get the duration in bytes, in pull mode that's all we are sure to
4510          * know. We have to explicitly get this value from upstream instead of
4511          * using our cached value because it might change. Duration caching
4512          * should be done at a higher level. */
4513         res = gst_pad_query_peer_duration (basesink->sinkpad, &uformat,
4514             &uduration);
4515         if (res) {
4516           gst_segment_set_duration (&basesink->segment, uformat, uduration);
4517           if (format != uformat) {
4518             /* convert to the requested format */
4519             res = gst_pad_query_convert (basesink->sinkpad, uformat, uduration,
4520                 &format, &duration);
4521           } else {
4522             duration = uduration;
4523           }
4524           if (res) {
4525             /* set the result */
4526             gst_query_set_duration (query, format, duration);
4527           }
4528         }
4529       } else {
4530         /* in push mode we simply forward upstream */
4531         res = gst_base_sink_peer_query (basesink, query);
4532       }
4533       break;
4534     }
4535     case GST_QUERY_LATENCY:
4536     {
4537       gboolean live, us_live;
4538       GstClockTime min, max;
4539
4540       if ((res = gst_base_sink_query_latency (basesink, &live, &us_live, &min,
4541                   &max))) {
4542         gst_query_set_latency (query, live, min, max);
4543       }
4544       break;
4545     }
4546     case GST_QUERY_JITTER:
4547       break;
4548     case GST_QUERY_RATE:
4549       /* gst_query_set_rate (query, basesink->segment_rate); */
4550       res = TRUE;
4551       break;
4552     case GST_QUERY_SEGMENT:
4553     {
4554       /* FIXME, bring start/stop to stream time */
4555       gst_query_set_segment (query, basesink->segment.rate,
4556           GST_FORMAT_TIME, basesink->segment.start, basesink->segment.stop);
4557       break;
4558     }
4559     case GST_QUERY_SEEKING:
4560     case GST_QUERY_CONVERT:
4561     case GST_QUERY_FORMATS:
4562     default:
4563       res = gst_base_sink_peer_query (basesink, query);
4564       break;
4565   }
4566   return res;
4567 }
4568
4569 static GstStateChangeReturn
4570 gst_base_sink_change_state (GstElement * element, GstStateChange transition)
4571 {
4572   GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
4573   GstBaseSink *basesink = GST_BASE_SINK (element);
4574   GstBaseSinkClass *bclass;
4575   GstBaseSinkPrivate *priv;
4576
4577   priv = basesink->priv;
4578
4579   bclass = GST_BASE_SINK_GET_CLASS (basesink);
4580
4581   switch (transition) {
4582     case GST_STATE_CHANGE_NULL_TO_READY:
4583       if (bclass->start)
4584         if (!bclass->start (basesink))
4585           goto start_failed;
4586       break;
4587     case GST_STATE_CHANGE_READY_TO_PAUSED:
4588       /* need to complete preroll before this state change completes, there
4589        * is no data flow in READY so we can safely assume we need to preroll. */
4590       GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4591       GST_DEBUG_OBJECT (basesink, "READY to PAUSED");
4592       basesink->have_newsegment = FALSE;
4593       gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
4594       gst_segment_init (basesink->abidata.ABI.clip_segment,
4595           GST_FORMAT_UNDEFINED);
4596       basesink->offset = 0;
4597       basesink->have_preroll = FALSE;
4598       priv->step_unlock = FALSE;
4599       basesink->need_preroll = TRUE;
4600       basesink->playing_async = TRUE;
4601       priv->current_sstart = GST_CLOCK_TIME_NONE;
4602       priv->current_sstop = GST_CLOCK_TIME_NONE;
4603       priv->eos_rtime = GST_CLOCK_TIME_NONE;
4604       priv->latency = 0;
4605       basesink->eos = FALSE;
4606       priv->received_eos = FALSE;
4607       gst_base_sink_reset_qos (basesink);
4608       priv->commited = FALSE;
4609       priv->call_preroll = TRUE;
4610       priv->current_step.valid = FALSE;
4611       priv->pending_step.valid = FALSE;
4612       if (priv->async_enabled) {
4613         GST_DEBUG_OBJECT (basesink, "doing async state change");
4614         /* when async enabled, post async-start message and return ASYNC from
4615          * the state change function */
4616         ret = GST_STATE_CHANGE_ASYNC;
4617         gst_element_post_message (GST_ELEMENT_CAST (basesink),
4618             gst_message_new_async_start (GST_OBJECT_CAST (basesink), FALSE));
4619       } else {
4620         priv->have_latency = TRUE;
4621       }
4622       GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4623       break;
4624     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
4625       GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4626       if (!gst_base_sink_needs_preroll (basesink)) {
4627         GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, don't need preroll");
4628         /* no preroll needed anymore now. */
4629         basesink->playing_async = FALSE;
4630         basesink->need_preroll = FALSE;
4631         if (basesink->eos) {
4632           GstMessage *message;
4633
4634           /* need to post EOS message here */
4635           GST_DEBUG_OBJECT (basesink, "Now posting EOS");
4636           message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
4637           gst_message_set_seqnum (message, basesink->priv->seqnum);
4638           gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
4639         } else {
4640           GST_DEBUG_OBJECT (basesink, "signal preroll");
4641           GST_PAD_PREROLL_SIGNAL (basesink->sinkpad);
4642         }
4643       } else {
4644         GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, we are not prerolled");
4645         basesink->need_preroll = TRUE;
4646         basesink->playing_async = TRUE;
4647         priv->call_preroll = TRUE;
4648         priv->commited = FALSE;
4649         if (priv->async_enabled) {
4650           GST_DEBUG_OBJECT (basesink, "doing async state change");
4651           ret = GST_STATE_CHANGE_ASYNC;
4652           gst_element_post_message (GST_ELEMENT_CAST (basesink),
4653               gst_message_new_async_start (GST_OBJECT_CAST (basesink), FALSE));
4654         }
4655       }
4656       GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4657       break;
4658     default:
4659       break;
4660   }
4661
4662   {
4663     GstStateChangeReturn bret;
4664
4665     bret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
4666     if (G_UNLIKELY (bret == GST_STATE_CHANGE_FAILURE))
4667       goto activate_failed;
4668   }
4669
4670   switch (transition) {
4671     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
4672       GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED");
4673       /* FIXME, make sure we cannot enter _render first */
4674
4675       /* we need to call ::unlock before locking PREROLL_LOCK
4676        * since we lock it before going into ::render */
4677       if (bclass->unlock)
4678         bclass->unlock (basesink);
4679
4680       GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4681       /* now that we have the PREROLL lock, clear our unlock request */
4682       if (bclass->unlock_stop)
4683         bclass->unlock_stop (basesink);
4684
4685       /* we need preroll again and we set the flag before unlocking the clockid
4686        * because if the clockid is unlocked before a current buffer expired, we
4687        * can use that buffer to preroll with */
4688       basesink->need_preroll = TRUE;
4689
4690       if (basesink->clock_id) {
4691         gst_clock_id_unschedule (basesink->clock_id);
4692       }
4693
4694       /* if we don't have a preroll buffer we need to wait for a preroll and
4695        * return ASYNC. */
4696       if (!gst_base_sink_needs_preroll (basesink)) {
4697         GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED, we are prerolled");
4698         basesink->playing_async = FALSE;
4699       } else {
4700         if (GST_STATE_TARGET (GST_ELEMENT (basesink)) <= GST_STATE_READY) {
4701           ret = GST_STATE_CHANGE_SUCCESS;
4702         } else {
4703           GST_DEBUG_OBJECT (basesink,
4704               "PLAYING to PAUSED, we are not prerolled");
4705           basesink->playing_async = TRUE;
4706           priv->commited = FALSE;
4707           priv->call_preroll = TRUE;
4708           if (priv->async_enabled) {
4709             GST_DEBUG_OBJECT (basesink, "doing async state change");
4710             ret = GST_STATE_CHANGE_ASYNC;
4711             gst_element_post_message (GST_ELEMENT_CAST (basesink),
4712                 gst_message_new_async_start (GST_OBJECT_CAST (basesink),
4713                     FALSE));
4714           }
4715         }
4716       }
4717       GST_DEBUG_OBJECT (basesink, "rendered: %" G_GUINT64_FORMAT
4718           ", dropped: %" G_GUINT64_FORMAT, priv->rendered, priv->dropped);
4719
4720       gst_base_sink_reset_qos (basesink);
4721       GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4722       break;
4723     case GST_STATE_CHANGE_PAUSED_TO_READY:
4724       GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4725       /* start by reseting our position state with the object lock so that the
4726        * position query gets the right idea. We do this before we post the
4727        * messages so that the message handlers pick this up. */
4728       GST_OBJECT_LOCK (basesink);
4729       basesink->have_newsegment = FALSE;
4730       priv->current_sstart = GST_CLOCK_TIME_NONE;
4731       priv->current_sstop = GST_CLOCK_TIME_NONE;
4732       priv->have_latency = FALSE;
4733       GST_OBJECT_UNLOCK (basesink);
4734
4735       gst_base_sink_set_last_buffer (basesink, NULL);
4736       priv->call_preroll = FALSE;
4737
4738       if (!priv->commited) {
4739         if (priv->async_enabled) {
4740           GST_DEBUG_OBJECT (basesink, "PAUSED to READY, posting async-done");
4741
4742           gst_element_post_message (GST_ELEMENT_CAST (basesink),
4743               gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
4744                   GST_STATE_PLAYING, GST_STATE_PAUSED, GST_STATE_READY));
4745
4746           gst_element_post_message (GST_ELEMENT_CAST (basesink),
4747               gst_message_new_async_done (GST_OBJECT_CAST (basesink)));
4748         }
4749         priv->commited = TRUE;
4750       } else {
4751         GST_DEBUG_OBJECT (basesink, "PAUSED to READY, don't need_preroll");
4752       }
4753       GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4754       break;
4755     case GST_STATE_CHANGE_READY_TO_NULL:
4756       if (bclass->stop) {
4757         if (!bclass->stop (basesink)) {
4758           GST_WARNING_OBJECT (basesink, "failed to stop");
4759         }
4760       }
4761       gst_base_sink_set_last_buffer (basesink, NULL);
4762       priv->call_preroll = FALSE;
4763       break;
4764     default:
4765       break;
4766   }
4767
4768   return ret;
4769
4770   /* ERRORS */
4771 start_failed:
4772   {
4773     GST_DEBUG_OBJECT (basesink, "failed to start");
4774     return GST_STATE_CHANGE_FAILURE;
4775   }
4776 activate_failed:
4777   {
4778     GST_DEBUG_OBJECT (basesink,
4779         "element failed to change states -- activation problem?");
4780     return GST_STATE_CHANGE_FAILURE;
4781   }
4782 }