basesink: lets keep -1 for segmenst as they are guint64 and not GstClockTime
[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_DEBUG_FUNCPTR (gst_base_sink_finalize);
390   gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_base_sink_set_property);
391   gobject_class->get_property = GST_DEBUG_FUNCPTR (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     }
1858   }
1859   /* this can produce wrong values if we accumulated non-TIME segments. If this happens,
1860    * upstream is behaving very badly */
1861   sstart = gst_segment_to_stream_time (segment, format, cstart);
1862   sstop = gst_segment_to_stream_time (segment, format, cstop);
1863
1864 eos_done:
1865   /* eos_done label only called when doing EOS, we also stop stepping then */
1866   if (*step_end && step->flush) {
1867     GST_DEBUG_OBJECT (basesink, "flushing step ended");
1868     stop_stepping (basesink, segment, step, rstart, rstop, eos);
1869     *step_end = FALSE;
1870   }
1871
1872   /* save times */
1873   *rsstart = sstart;
1874   *rsstop = sstop;
1875   *rrstart = rstart;
1876   *rrstop = rstop;
1877
1878   /* buffers and EOS always need syncing and preroll */
1879   return TRUE;
1880
1881   /* special cases */
1882 out_of_segment:
1883   {
1884     /* we usually clip in the chain function already but stepping could cause
1885      * the segment to be updated later. we return FALSE so that we don't try
1886      * to sync on it. */
1887     GST_LOG_OBJECT (basesink, "buffer skipped, not in segment");
1888     return FALSE;
1889   }
1890 }
1891
1892 /* with STREAM_LOCK, PREROLL_LOCK, LOCK
1893  * adjust a timestamp with the latency and timestamp offset */
1894 static GstClockTime
1895 gst_base_sink_adjust_time (GstBaseSink * basesink, GstClockTime time)
1896 {
1897   GstClockTimeDiff ts_offset;
1898
1899   /* don't do anything funny with invalid timestamps */
1900   if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
1901     return time;
1902
1903   time += basesink->priv->latency;
1904
1905   /* apply offset, be carefull for underflows */
1906   ts_offset = basesink->priv->ts_offset;
1907   if (ts_offset < 0) {
1908     ts_offset = -ts_offset;
1909     if (ts_offset < time)
1910       time -= ts_offset;
1911     else
1912       time = 0;
1913   } else
1914     time += ts_offset;
1915
1916   return time;
1917 }
1918
1919 /**
1920  * gst_base_sink_wait_clock:
1921  * @sink: the sink
1922  * @time: the running_time to be reached
1923  * @jitter: the jitter to be filled with time diff (can be NULL)
1924  *
1925  * This function will block until @time is reached. It is usually called by
1926  * subclasses that use their own internal synchronisation.
1927  *
1928  * If @time is not valid, no sycnhronisation is done and #GST_CLOCK_BADTIME is
1929  * returned. Likewise, if synchronisation is disabled in the element or there
1930  * is no clock, no synchronisation is done and #GST_CLOCK_BADTIME is returned.
1931  *
1932  * This function should only be called with the PREROLL_LOCK held, like when
1933  * receiving an EOS event in the ::event vmethod or when receiving a buffer in
1934  * the ::render vmethod.
1935  *
1936  * The @time argument should be the running_time of when this method should
1937  * return and is not adjusted with any latency or offset configured in the
1938  * sink.
1939  *
1940  * Since 0.10.20
1941  *
1942  * Returns: #GstClockReturn
1943  */
1944 GstClockReturn
1945 gst_base_sink_wait_clock (GstBaseSink * sink, GstClockTime time,
1946     GstClockTimeDiff * jitter)
1947 {
1948   GstClockID id;
1949   GstClockReturn ret;
1950   GstClock *clock;
1951
1952   if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
1953     goto invalid_time;
1954
1955   GST_OBJECT_LOCK (sink);
1956   if (G_UNLIKELY (!sink->sync))
1957     goto no_sync;
1958
1959   if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (sink)) == NULL))
1960     goto no_clock;
1961
1962   /* add base_time to running_time to get the time against the clock */
1963   time += GST_ELEMENT_CAST (sink)->base_time;
1964
1965   id = gst_clock_new_single_shot_id (clock, time);
1966   GST_OBJECT_UNLOCK (sink);
1967
1968   /* A blocking wait is performed on the clock. We save the ClockID
1969    * so we can unlock the entry at any time. While we are blocking, we
1970    * release the PREROLL_LOCK so that other threads can interrupt the
1971    * entry. */
1972   sink->clock_id = id;
1973   /* release the preroll lock while waiting */
1974   GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
1975
1976   ret = gst_clock_id_wait (id, jitter);
1977
1978   GST_PAD_PREROLL_LOCK (sink->sinkpad);
1979   gst_clock_id_unref (id);
1980   sink->clock_id = NULL;
1981
1982   return ret;
1983
1984   /* no syncing needed */
1985 invalid_time:
1986   {
1987     GST_DEBUG_OBJECT (sink, "time not valid, no sync needed");
1988     return GST_CLOCK_BADTIME;
1989   }
1990 no_sync:
1991   {
1992     GST_DEBUG_OBJECT (sink, "sync disabled");
1993     GST_OBJECT_UNLOCK (sink);
1994     return GST_CLOCK_BADTIME;
1995   }
1996 no_clock:
1997   {
1998     GST_DEBUG_OBJECT (sink, "no clock, can't sync");
1999     GST_OBJECT_UNLOCK (sink);
2000     return GST_CLOCK_BADTIME;
2001   }
2002 }
2003
2004 /**
2005  * gst_base_sink_wait_preroll:
2006  * @sink: the sink
2007  *
2008  * If the #GstBaseSinkClass::render method performs its own synchronisation against
2009  * the clock it must unblock when going from PLAYING to the PAUSED state and call
2010  * this method before continuing to render the remaining data.
2011  *
2012  * This function will block until a state change to PLAYING happens (in which
2013  * case this function returns #GST_FLOW_OK) or the processing must be stopped due
2014  * to a state change to READY or a FLUSH event (in which case this function
2015  * returns #GST_FLOW_WRONG_STATE).
2016  *
2017  * This function should only be called with the PREROLL_LOCK held, like in the
2018  * render function.
2019  *
2020  * Since: 0.10.11
2021  *
2022  * Returns: #GST_FLOW_OK if the preroll completed and processing can
2023  * continue. Any other return value should be returned from the render vmethod.
2024  */
2025 GstFlowReturn
2026 gst_base_sink_wait_preroll (GstBaseSink * sink)
2027 {
2028   sink->have_preroll = TRUE;
2029   GST_DEBUG_OBJECT (sink, "waiting in preroll for flush or PLAYING");
2030   /* block until the state changes, or we get a flush, or something */
2031   GST_PAD_PREROLL_WAIT (sink->sinkpad);
2032   sink->have_preroll = FALSE;
2033   if (G_UNLIKELY (sink->flushing))
2034     goto stopping;
2035   if (G_UNLIKELY (sink->priv->step_unlock))
2036     goto step_unlocked;
2037   GST_DEBUG_OBJECT (sink, "continue after preroll");
2038
2039   return GST_FLOW_OK;
2040
2041   /* ERRORS */
2042 stopping:
2043   {
2044     GST_DEBUG_OBJECT (sink, "preroll interrupted because of flush");
2045     return GST_FLOW_WRONG_STATE;
2046   }
2047 step_unlocked:
2048   {
2049     sink->priv->step_unlock = FALSE;
2050     GST_DEBUG_OBJECT (sink, "preroll interrupted because of step");
2051     return GST_FLOW_STEP;
2052   }
2053 }
2054
2055 /**
2056  * gst_base_sink_do_preroll:
2057  * @sink: the sink
2058  * @obj: the object that caused the preroll
2059  *
2060  * If the @sink spawns its own thread for pulling buffers from upstream it
2061  * should call this method after it has pulled a buffer. If the element needed
2062  * to preroll, this function will perform the preroll and will then block
2063  * until the element state is changed.
2064  *
2065  * This function should be called with the PREROLL_LOCK held.
2066  *
2067  * Since 0.10.22
2068  *
2069  * Returns: #GST_FLOW_OK if the preroll completed and processing can
2070  * continue. Any other return value should be returned from the render vmethod.
2071  */
2072 GstFlowReturn
2073 gst_base_sink_do_preroll (GstBaseSink * sink, GstMiniObject * obj)
2074 {
2075   GstFlowReturn ret;
2076
2077   while (G_UNLIKELY (sink->need_preroll)) {
2078     GST_DEBUG_OBJECT (sink, "prerolling object %p", obj);
2079
2080     ret = gst_base_sink_preroll_object (sink, FALSE, obj);
2081     if (ret != GST_FLOW_OK)
2082       goto preroll_failed;
2083
2084     /* need to recheck here because the commit state could have
2085      * made us not need the preroll anymore */
2086     if (G_LIKELY (sink->need_preroll)) {
2087       /* block until the state changes, or we get a flush, or something */
2088       ret = gst_base_sink_wait_preroll (sink);
2089       if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2090         goto preroll_failed;
2091     }
2092   }
2093   return GST_FLOW_OK;
2094
2095   /* ERRORS */
2096 preroll_failed:
2097   {
2098     GST_DEBUG_OBJECT (sink, "preroll failed %d", ret);
2099     return ret;
2100   }
2101 }
2102
2103 /**
2104  * gst_base_sink_wait_eos:
2105  * @sink: the sink
2106  * @time: the running_time to be reached
2107  * @jitter: the jitter to be filled with time diff (can be NULL)
2108  *
2109  * This function will block until @time is reached. It is usually called by
2110  * subclasses that use their own internal synchronisation but want to let the
2111  * EOS be handled by the base class.
2112  *
2113  * This function should only be called with the PREROLL_LOCK held, like when
2114  * receiving an EOS event in the ::event vmethod.
2115  *
2116  * The @time argument should be the running_time of when the EOS should happen
2117  * and will be adjusted with any latency and offset configured in the sink.
2118  *
2119  * Since 0.10.15
2120  *
2121  * Returns: #GstFlowReturn
2122  */
2123 GstFlowReturn
2124 gst_base_sink_wait_eos (GstBaseSink * sink, GstClockTime time,
2125     GstClockTimeDiff * jitter)
2126 {
2127   GstClockReturn status;
2128   GstFlowReturn ret;
2129
2130   do {
2131     GstClockTime stime;
2132
2133     GST_DEBUG_OBJECT (sink, "checking preroll");
2134
2135     /* first wait for the playing state before we can continue */
2136     if (G_UNLIKELY (sink->need_preroll)) {
2137       ret = gst_base_sink_wait_preroll (sink);
2138       if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2139         goto flushing;
2140     }
2141
2142     /* preroll done, we can sync since we are in PLAYING now. */
2143     GST_DEBUG_OBJECT (sink, "possibly waiting for clock to reach %"
2144         GST_TIME_FORMAT, GST_TIME_ARGS (time));
2145
2146     /* compensate for latency and ts_offset. We don't adjust for render delay
2147      * because we don't interact with the device on EOS normally. */
2148     stime = gst_base_sink_adjust_time (sink, time);
2149
2150     /* wait for the clock, this can be interrupted because we got shut down or
2151      * we PAUSED. */
2152     status = gst_base_sink_wait_clock (sink, stime, jitter);
2153
2154     GST_DEBUG_OBJECT (sink, "clock returned %d", status);
2155
2156     /* invalid time, no clock or sync disabled, just continue then */
2157     if (status == GST_CLOCK_BADTIME)
2158       break;
2159
2160     /* waiting could have been interrupted and we can be flushing now */
2161     if (G_UNLIKELY (sink->flushing))
2162       goto flushing;
2163
2164     /* retry if we got unscheduled, which means we did not reach the timeout
2165      * yet. if some other error occures, we continue. */
2166   } while (status == GST_CLOCK_UNSCHEDULED);
2167
2168   GST_DEBUG_OBJECT (sink, "end of stream");
2169
2170   return GST_FLOW_OK;
2171
2172   /* ERRORS */
2173 flushing:
2174   {
2175     GST_DEBUG_OBJECT (sink, "we are flushing");
2176     return GST_FLOW_WRONG_STATE;
2177   }
2178 }
2179
2180 /* with STREAM_LOCK, PREROLL_LOCK
2181  *
2182  * Make sure we are in PLAYING and synchronize an object to the clock.
2183  *
2184  * If we need preroll, we are not in PLAYING. We try to commit the state
2185  * if needed and then block if we still are not PLAYING.
2186  *
2187  * We start waiting on the clock in PLAYING. If we got interrupted, we
2188  * immediatly try to re-preroll.
2189  *
2190  * Some objects do not need synchronisation (most events) and so this function
2191  * immediatly returns GST_FLOW_OK.
2192  *
2193  * for objects that arrive later than max-lateness to be synchronized to the
2194  * clock have the @late boolean set to TRUE.
2195  *
2196  * This function keeps a running average of the jitter (the diff between the
2197  * clock time and the requested sync time). The jitter is negative for
2198  * objects that arrive in time and positive for late buffers.
2199  *
2200  * does not take ownership of obj.
2201  */
2202 static GstFlowReturn
2203 gst_base_sink_do_sync (GstBaseSink * basesink, GstPad * pad,
2204     GstMiniObject * obj, gboolean * late, gboolean * step_end)
2205 {
2206   GstClockTimeDiff jitter;
2207   gboolean syncable;
2208   GstClockReturn status = GST_CLOCK_OK;
2209   GstClockTime rstart, rstop, sstart, sstop, stime;
2210   gboolean do_sync;
2211   GstBaseSinkPrivate *priv;
2212   GstFlowReturn ret;
2213   GstStepInfo *current, *pending;
2214   gboolean stepped;
2215
2216   priv = basesink->priv;
2217
2218 do_step:
2219   sstart = sstop = rstart = rstop = GST_CLOCK_TIME_NONE;
2220   do_sync = TRUE;
2221   stepped = FALSE;
2222
2223   priv->current_rstart = GST_CLOCK_TIME_NONE;
2224
2225   /* get stepping info */
2226   current = &priv->current_step;
2227   pending = &priv->pending_step;
2228
2229   /* get timing information for this object against the render segment */
2230   syncable = gst_base_sink_get_sync_times (basesink, obj,
2231       &sstart, &sstop, &rstart, &rstop, &do_sync, &stepped, &basesink->segment,
2232       current, step_end);
2233
2234   if (G_UNLIKELY (stepped))
2235     goto step_skipped;
2236
2237   /* a syncable object needs to participate in preroll and
2238    * clocking. All buffers and EOS are syncable. */
2239   if (G_UNLIKELY (!syncable))
2240     goto not_syncable;
2241
2242   /* store timing info for current object */
2243   priv->current_rstart = rstart;
2244   priv->current_rstop = (GST_CLOCK_TIME_IS_VALID (rstop) ? rstop : rstart);
2245
2246   /* save sync time for eos when the previous object needed sync */
2247   priv->eos_rtime = (do_sync ? priv->current_rstop : GST_CLOCK_TIME_NONE);
2248
2249 again:
2250   /* first do preroll, this makes sure we commit our state
2251    * to PAUSED and can continue to PLAYING. We cannot perform
2252    * any clock sync in PAUSED because there is no clock. */
2253   ret = gst_base_sink_do_preroll (basesink, obj);
2254   if (G_UNLIKELY (ret != GST_FLOW_OK))
2255     goto preroll_failed;
2256
2257   /* After rendering we store the position of the last buffer so that we can use
2258    * it to report the position. We need to take the lock here. */
2259   GST_OBJECT_LOCK (basesink);
2260   priv->current_sstart = sstart;
2261   priv->current_sstop = (GST_CLOCK_TIME_IS_VALID (sstop) ? sstop : sstart);
2262   GST_OBJECT_UNLOCK (basesink);
2263
2264   /* update the segment with a pending step if the current one is invalid and we
2265    * have a new pending one. We only accept new step updates after a preroll */
2266   if (G_UNLIKELY (pending->valid && !current->valid)) {
2267     start_stepping (basesink, &basesink->segment, pending, current);
2268     goto do_step;
2269   }
2270
2271   if (!do_sync)
2272     goto done;
2273
2274   /* adjust for latency */
2275   stime = gst_base_sink_adjust_time (basesink, rstart);
2276
2277   /* adjust for render-delay, avoid underflows */
2278   if (GST_CLOCK_TIME_IS_VALID (stime)) {
2279     if (stime > priv->render_delay)
2280       stime -= priv->render_delay;
2281     else
2282       stime = 0;
2283   }
2284
2285   /* preroll done, we can sync since we are in PLAYING now. */
2286   GST_DEBUG_OBJECT (basesink, "possibly waiting for clock to reach %"
2287       GST_TIME_FORMAT ", adjusted %" GST_TIME_FORMAT,
2288       GST_TIME_ARGS (rstart), GST_TIME_ARGS (stime));
2289
2290   /* This function will return immediatly if start == -1, no clock
2291    * or sync is disabled with GST_CLOCK_BADTIME. */
2292   status = gst_base_sink_wait_clock (basesink, stime, &jitter);
2293
2294   GST_DEBUG_OBJECT (basesink, "clock returned %d", status);
2295
2296   /* invalid time, no clock or sync disabled, just render */
2297   if (status == GST_CLOCK_BADTIME)
2298     goto done;
2299
2300   /* waiting could have been interrupted and we can be flushing now */
2301   if (G_UNLIKELY (basesink->flushing))
2302     goto flushing;
2303
2304   /* check for unlocked by a state change, we are not flushing so
2305    * we can try to preroll on the current buffer. */
2306   if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED)) {
2307     GST_DEBUG_OBJECT (basesink, "unscheduled, waiting some more");
2308     priv->call_preroll = TRUE;
2309     goto again;
2310   }
2311
2312   /* successful syncing done, record observation */
2313   priv->current_jitter = jitter;
2314
2315   /* check if the object should be dropped */
2316   *late = gst_base_sink_is_too_late (basesink, obj, rstart, rstop,
2317       status, jitter);
2318
2319 done:
2320   return GST_FLOW_OK;
2321
2322   /* ERRORS */
2323 step_skipped:
2324   {
2325     GST_DEBUG_OBJECT (basesink, "skipped stepped object %p", obj);
2326     *late = TRUE;
2327     return GST_FLOW_OK;
2328   }
2329 not_syncable:
2330   {
2331     GST_DEBUG_OBJECT (basesink, "non syncable object %p", obj);
2332     return GST_FLOW_OK;
2333   }
2334 flushing:
2335   {
2336     GST_DEBUG_OBJECT (basesink, "we are flushing");
2337     return GST_FLOW_WRONG_STATE;
2338   }
2339 preroll_failed:
2340   {
2341     GST_DEBUG_OBJECT (basesink, "preroll failed");
2342     *step_end = FALSE;
2343     return ret;
2344   }
2345 }
2346
2347 static gboolean
2348 gst_base_sink_send_qos (GstBaseSink * basesink,
2349     gdouble proportion, GstClockTime time, GstClockTimeDiff diff)
2350 {
2351   GstEvent *event;
2352   gboolean res;
2353
2354   /* generate Quality-of-Service event */
2355   GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2356       "qos: proportion: %lf, diff %" G_GINT64_FORMAT ", timestamp %"
2357       GST_TIME_FORMAT, proportion, diff, GST_TIME_ARGS (time));
2358
2359   event = gst_event_new_qos (proportion, diff, time);
2360
2361   /* send upstream */
2362   res = gst_pad_push_event (basesink->sinkpad, event);
2363
2364   return res;
2365 }
2366
2367 static void
2368 gst_base_sink_perform_qos (GstBaseSink * sink, gboolean dropped)
2369 {
2370   GstBaseSinkPrivate *priv;
2371   GstClockTime start, stop;
2372   GstClockTimeDiff jitter;
2373   GstClockTime pt, entered, left;
2374   GstClockTime duration;
2375   gdouble rate;
2376
2377   priv = sink->priv;
2378
2379   start = priv->current_rstart;
2380
2381   if (priv->current_step.valid)
2382     return;
2383
2384   /* if Quality-of-Service disabled, do nothing */
2385   if (!g_atomic_int_get (&priv->qos_enabled) ||
2386       !GST_CLOCK_TIME_IS_VALID (start))
2387     return;
2388
2389   stop = priv->current_rstop;
2390   jitter = priv->current_jitter;
2391
2392   if (jitter < 0) {
2393     /* this is the time the buffer entered the sink */
2394     if (start < -jitter)
2395       entered = 0;
2396     else
2397       entered = start + jitter;
2398     left = start;
2399   } else {
2400     /* this is the time the buffer entered the sink */
2401     entered = start + jitter;
2402     /* this is the time the buffer left the sink */
2403     left = start + jitter;
2404   }
2405
2406   /* calculate duration of the buffer */
2407   if (GST_CLOCK_TIME_IS_VALID (stop))
2408     duration = stop - start;
2409   else
2410     duration = GST_CLOCK_TIME_NONE;
2411
2412   /* if we have the time when the last buffer left us, calculate
2413    * processing time */
2414   if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2415     if (entered > priv->last_left) {
2416       pt = entered - priv->last_left;
2417     } else {
2418       pt = 0;
2419     }
2420   } else {
2421     pt = priv->avg_pt;
2422   }
2423
2424   GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "start: %" GST_TIME_FORMAT
2425       ", entered %" GST_TIME_FORMAT ", left %" GST_TIME_FORMAT ", pt: %"
2426       GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT ",jitter %"
2427       G_GINT64_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (entered),
2428       GST_TIME_ARGS (left), GST_TIME_ARGS (pt), GST_TIME_ARGS (duration),
2429       jitter);
2430
2431   GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "avg_duration: %" GST_TIME_FORMAT
2432       ", avg_pt: %" GST_TIME_FORMAT ", avg_rate: %g",
2433       GST_TIME_ARGS (priv->avg_duration), GST_TIME_ARGS (priv->avg_pt),
2434       priv->avg_rate);
2435
2436   /* collect running averages. for first observations, we copy the
2437    * values */
2438   if (!GST_CLOCK_TIME_IS_VALID (priv->avg_duration))
2439     priv->avg_duration = duration;
2440   else
2441     priv->avg_duration = UPDATE_RUNNING_AVG (priv->avg_duration, duration);
2442
2443   if (!GST_CLOCK_TIME_IS_VALID (priv->avg_pt))
2444     priv->avg_pt = pt;
2445   else
2446     priv->avg_pt = UPDATE_RUNNING_AVG (priv->avg_pt, pt);
2447
2448   if (priv->avg_duration != 0)
2449     rate =
2450         gst_guint64_to_gdouble (priv->avg_pt) /
2451         gst_guint64_to_gdouble (priv->avg_duration);
2452   else
2453     rate = 0.0;
2454
2455   if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2456     if (dropped || priv->avg_rate < 0.0) {
2457       priv->avg_rate = rate;
2458     } else {
2459       if (rate > 1.0)
2460         priv->avg_rate = UPDATE_RUNNING_AVG_N (priv->avg_rate, rate);
2461       else
2462         priv->avg_rate = UPDATE_RUNNING_AVG_P (priv->avg_rate, rate);
2463     }
2464   }
2465
2466   GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink,
2467       "updated: avg_duration: %" GST_TIME_FORMAT ", avg_pt: %" GST_TIME_FORMAT
2468       ", avg_rate: %g", GST_TIME_ARGS (priv->avg_duration),
2469       GST_TIME_ARGS (priv->avg_pt), priv->avg_rate);
2470
2471
2472   if (priv->avg_rate >= 0.0) {
2473     /* if we have a valid rate, start sending QoS messages */
2474     if (priv->current_jitter < 0) {
2475       /* make sure we never go below 0 when adding the jitter to the
2476        * timestamp. */
2477       if (priv->current_rstart < -priv->current_jitter)
2478         priv->current_jitter = -priv->current_rstart;
2479     }
2480     gst_base_sink_send_qos (sink, priv->avg_rate, priv->current_rstart,
2481         priv->current_jitter);
2482   }
2483
2484   /* record when this buffer will leave us */
2485   priv->last_left = left;
2486 }
2487
2488 /* reset all qos measuring */
2489 static void
2490 gst_base_sink_reset_qos (GstBaseSink * sink)
2491 {
2492   GstBaseSinkPrivate *priv;
2493
2494   priv = sink->priv;
2495
2496   priv->last_in_time = GST_CLOCK_TIME_NONE;
2497   priv->last_left = GST_CLOCK_TIME_NONE;
2498   priv->avg_duration = GST_CLOCK_TIME_NONE;
2499   priv->avg_pt = GST_CLOCK_TIME_NONE;
2500   priv->avg_rate = -1.0;
2501   priv->avg_render = GST_CLOCK_TIME_NONE;
2502   priv->rendered = 0;
2503   priv->dropped = 0;
2504
2505 }
2506
2507 /* Checks if the object was scheduled too late.
2508  *
2509  * start/stop contain the raw timestamp start and stop values
2510  * of the object.
2511  *
2512  * status and jitter contain the return values from the clock wait.
2513  *
2514  * returns TRUE if the buffer was too late.
2515  */
2516 static gboolean
2517 gst_base_sink_is_too_late (GstBaseSink * basesink, GstMiniObject * obj,
2518     GstClockTime start, GstClockTime stop,
2519     GstClockReturn status, GstClockTimeDiff jitter)
2520 {
2521   gboolean late;
2522   gint64 max_lateness;
2523   GstBaseSinkPrivate *priv;
2524
2525   priv = basesink->priv;
2526
2527   late = FALSE;
2528
2529   /* only for objects that were too late */
2530   if (G_LIKELY (status != GST_CLOCK_EARLY))
2531     goto in_time;
2532
2533   max_lateness = basesink->abidata.ABI.max_lateness;
2534
2535   /* check if frame dropping is enabled */
2536   if (max_lateness == -1)
2537     goto no_drop;
2538
2539   /* only check for buffers */
2540   if (G_UNLIKELY (!GST_IS_BUFFER (obj)))
2541     goto not_buffer;
2542
2543   /* can't do check if we don't have a timestamp */
2544   if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (start)))
2545     goto no_timestamp;
2546
2547   /* we can add a valid stop time */
2548   if (GST_CLOCK_TIME_IS_VALID (stop))
2549     max_lateness += stop;
2550   else
2551     max_lateness += start;
2552
2553   /* if the jitter bigger than duration and lateness we are too late */
2554   if ((late = start + jitter > max_lateness)) {
2555     GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2556         "buffer is too late %" GST_TIME_FORMAT
2557         " > %" GST_TIME_FORMAT, GST_TIME_ARGS (start + jitter),
2558         GST_TIME_ARGS (max_lateness));
2559     /* !!emergency!!, if we did not receive anything valid for more than a
2560      * second, render it anyway so the user sees something */
2561     if (GST_CLOCK_TIME_IS_VALID (priv->last_in_time) &&
2562         start - priv->last_in_time > GST_SECOND) {
2563       late = FALSE;
2564       GST_ELEMENT_WARNING (basesink, CORE, CLOCK,
2565           (_("A lot of buffers are being dropped.")),
2566           ("There may be a timestamping problem, or this computer is too slow."));
2567       GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2568           "**emergency** last buffer at %" GST_TIME_FORMAT " > GST_SECOND",
2569           GST_TIME_ARGS (priv->last_in_time));
2570     }
2571   }
2572
2573 done:
2574   if (!late) {
2575     priv->last_in_time = start;
2576   }
2577   return late;
2578
2579   /* all is fine */
2580 in_time:
2581   {
2582     GST_DEBUG_OBJECT (basesink, "object was scheduled in time");
2583     goto done;
2584   }
2585 no_drop:
2586   {
2587     GST_DEBUG_OBJECT (basesink, "frame dropping disabled");
2588     goto done;
2589   }
2590 not_buffer:
2591   {
2592     GST_DEBUG_OBJECT (basesink, "object is not a buffer");
2593     return FALSE;
2594   }
2595 no_timestamp:
2596   {
2597     GST_DEBUG_OBJECT (basesink, "buffer has no timestamp");
2598     return FALSE;
2599   }
2600 }
2601
2602 /* called before and after calling the render vmethod. It keeps track of how
2603  * much time was spent in the render method and is used to check if we are
2604  * flooded */
2605 static void
2606 gst_base_sink_do_render_stats (GstBaseSink * basesink, gboolean start)
2607 {
2608   GstBaseSinkPrivate *priv;
2609
2610   priv = basesink->priv;
2611
2612   if (start) {
2613     priv->start = gst_util_get_timestamp ();
2614   } else {
2615     GstClockTime elapsed;
2616
2617     priv->stop = gst_util_get_timestamp ();
2618
2619     elapsed = GST_CLOCK_DIFF (priv->start, priv->stop);
2620
2621     if (!GST_CLOCK_TIME_IS_VALID (priv->avg_render))
2622       priv->avg_render = elapsed;
2623     else
2624       priv->avg_render = UPDATE_RUNNING_AVG (priv->avg_render, elapsed);
2625
2626     GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2627         "avg_render: %" GST_TIME_FORMAT, GST_TIME_ARGS (priv->avg_render));
2628   }
2629 }
2630
2631 /* with STREAM_LOCK, PREROLL_LOCK,
2632  *
2633  * Synchronize the object on the clock and then render it.
2634  *
2635  * takes ownership of obj.
2636  */
2637 static GstFlowReturn
2638 gst_base_sink_render_object (GstBaseSink * basesink, GstPad * pad,
2639     gboolean is_list, gpointer obj)
2640 {
2641   GstFlowReturn ret;
2642   GstBaseSinkClass *bclass;
2643   gboolean late, step_end;
2644   gpointer sync_obj;
2645
2646   GstBaseSinkPrivate *priv;
2647
2648   priv = basesink->priv;
2649
2650   if (is_list) {
2651     /*
2652      * If buffer list, use the first group buffer within the list
2653      * for syncing
2654      */
2655     sync_obj = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0, 0);
2656     g_assert (NULL != sync_obj);
2657   } else {
2658     sync_obj = obj;
2659   }
2660
2661 again:
2662   late = FALSE;
2663   step_end = FALSE;
2664
2665   /* synchronize this object, non syncable objects return OK
2666    * immediatly. */
2667   ret = gst_base_sink_do_sync (basesink, pad, sync_obj, &late, &step_end);
2668   if (G_UNLIKELY (ret != GST_FLOW_OK))
2669     goto sync_failed;
2670
2671   /* and now render, event or buffer/buffer list. */
2672   if (G_LIKELY (is_list || GST_IS_BUFFER (obj))) {
2673     /* drop late buffers unconditionally, let's hope it's unlikely */
2674     if (G_UNLIKELY (late))
2675       goto dropped;
2676
2677     bclass = GST_BASE_SINK_GET_CLASS (basesink);
2678
2679     if (G_LIKELY ((is_list && bclass->render_list) ||
2680             (!is_list && bclass->render))) {
2681       gint do_qos;
2682
2683       /* read once, to get same value before and after */
2684       do_qos = g_atomic_int_get (&priv->qos_enabled);
2685
2686       GST_DEBUG_OBJECT (basesink, "rendering object %p", obj);
2687
2688       /* record rendering time for QoS and stats */
2689       if (do_qos)
2690         gst_base_sink_do_render_stats (basesink, TRUE);
2691
2692       if (!is_list) {
2693         GstBuffer *buf;
2694
2695         /* For buffer lists do not set last buffer. Creating buffer
2696          * with meaningful data can be done only with memcpy which will
2697          * significantly affect performance */
2698         buf = GST_BUFFER_CAST (obj);
2699         gst_base_sink_set_last_buffer (basesink, buf);
2700
2701         ret = bclass->render (basesink, buf);
2702       } else {
2703         GstBufferList *buflist;
2704
2705         buflist = GST_BUFFER_LIST_CAST (obj);
2706
2707         ret = bclass->render_list (basesink, buflist);
2708       }
2709
2710       if (do_qos)
2711         gst_base_sink_do_render_stats (basesink, FALSE);
2712
2713       if (ret == GST_FLOW_STEP)
2714         goto again;
2715
2716       if (G_UNLIKELY (basesink->flushing))
2717         goto flushing;
2718
2719       priv->rendered++;
2720     }
2721   } else {
2722     GstEvent *event = GST_EVENT_CAST (obj);
2723     gboolean event_res = TRUE;
2724     GstEventType type;
2725
2726     bclass = GST_BASE_SINK_GET_CLASS (basesink);
2727
2728     type = GST_EVENT_TYPE (event);
2729
2730     GST_DEBUG_OBJECT (basesink, "rendering event %p, type %s", obj,
2731         gst_event_type_get_name (type));
2732
2733     if (bclass->event)
2734       event_res = bclass->event (basesink, event);
2735
2736     /* when we get here we could be flushing again when the event handler calls
2737      * _wait_eos(). We have to ignore this object in that case. */
2738     if (G_UNLIKELY (basesink->flushing))
2739       goto flushing;
2740
2741     if (G_LIKELY (event_res)) {
2742       guint32 seqnum;
2743
2744       seqnum = basesink->priv->seqnum = gst_event_get_seqnum (event);
2745       GST_DEBUG_OBJECT (basesink, "Got seqnum #%" G_GUINT32_FORMAT, seqnum);
2746
2747       switch (type) {
2748         case GST_EVENT_EOS:
2749         {
2750           GstMessage *message;
2751
2752           /* the EOS event is completely handled so we mark
2753            * ourselves as being in the EOS state. eos is also
2754            * protected by the object lock so we can read it when
2755            * answering the POSITION query. */
2756           GST_OBJECT_LOCK (basesink);
2757           basesink->eos = TRUE;
2758           GST_OBJECT_UNLOCK (basesink);
2759
2760           /* ok, now we can post the message */
2761           GST_DEBUG_OBJECT (basesink, "Now posting EOS");
2762
2763           message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
2764           gst_message_set_seqnum (message, seqnum);
2765           gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
2766           break;
2767         }
2768         case GST_EVENT_NEWSEGMENT:
2769           /* configure the segment */
2770           gst_base_sink_configure_segment (basesink, pad, event,
2771               &basesink->segment);
2772           break;
2773         default:
2774           break;
2775       }
2776     }
2777   }
2778
2779 done:
2780   if (step_end) {
2781     /* the step ended, check if we need to activate a new step */
2782     GST_DEBUG_OBJECT (basesink, "step ended");
2783     stop_stepping (basesink, &basesink->segment, &priv->current_step,
2784         priv->current_rstart, priv->current_rstop, basesink->eos);
2785     goto again;
2786   }
2787
2788   gst_base_sink_perform_qos (basesink, late);
2789
2790   GST_DEBUG_OBJECT (basesink, "object unref after render %p", obj);
2791   gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
2792   return ret;
2793
2794   /* ERRORS */
2795 sync_failed:
2796   {
2797     GST_DEBUG_OBJECT (basesink, "do_sync returned %s", gst_flow_get_name (ret));
2798     goto done;
2799   }
2800 dropped:
2801   {
2802     priv->dropped++;
2803     GST_DEBUG_OBJECT (basesink, "buffer late, dropping");
2804     goto done;
2805   }
2806 flushing:
2807   {
2808     GST_DEBUG_OBJECT (basesink, "we are flushing, ignore object");
2809     gst_mini_object_unref (obj);
2810     return GST_FLOW_WRONG_STATE;
2811   }
2812 }
2813
2814 /* with STREAM_LOCK, PREROLL_LOCK
2815  *
2816  * Perform preroll on the given object. For buffers this means
2817  * calling the preroll subclass method.
2818  * If that succeeds, the state will be commited.
2819  *
2820  * function does not take ownership of obj.
2821  */
2822 static GstFlowReturn
2823 gst_base_sink_preroll_object (GstBaseSink * basesink, gboolean is_list,
2824     GstMiniObject * obj)
2825 {
2826   GstFlowReturn ret;
2827
2828   GST_DEBUG_OBJECT (basesink, "prerolling object %p", obj);
2829
2830   /* if it's a buffer, we need to call the preroll method */
2831   if (G_LIKELY (is_list || GST_IS_BUFFER (obj)) && basesink->priv->call_preroll) {
2832     GstBaseSinkClass *bclass;
2833     GstBuffer *buf;
2834     GstClockTime timestamp;
2835
2836     if (is_list) {
2837       buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0, 0);
2838       g_assert (NULL != buf);
2839     } else {
2840       buf = GST_BUFFER_CAST (obj);
2841     }
2842
2843     timestamp = GST_BUFFER_TIMESTAMP (buf);
2844
2845     GST_DEBUG_OBJECT (basesink, "preroll buffer %" GST_TIME_FORMAT,
2846         GST_TIME_ARGS (timestamp));
2847
2848     /*
2849      * For buffer lists do not set last buffer. Creating buffer
2850      * with meaningful data can be done only with memcpy which will
2851      * significantly affect performance
2852      */
2853     if (!is_list) {
2854       gst_base_sink_set_last_buffer (basesink, buf);
2855     }
2856
2857     bclass = GST_BASE_SINK_GET_CLASS (basesink);
2858     if (bclass->preroll)
2859       if ((ret = bclass->preroll (basesink, buf)) != GST_FLOW_OK)
2860         goto preroll_failed;
2861
2862     basesink->priv->call_preroll = FALSE;
2863   }
2864
2865   /* commit state */
2866   if (G_LIKELY (basesink->playing_async)) {
2867     if (G_UNLIKELY (!gst_base_sink_commit_state (basesink)))
2868       goto stopping;
2869   }
2870
2871   return GST_FLOW_OK;
2872
2873   /* ERRORS */
2874 preroll_failed:
2875   {
2876     GST_DEBUG_OBJECT (basesink, "preroll failed, abort state");
2877     gst_element_abort_state (GST_ELEMENT_CAST (basesink));
2878     return ret;
2879   }
2880 stopping:
2881   {
2882     GST_DEBUG_OBJECT (basesink, "stopping while commiting state");
2883     return GST_FLOW_WRONG_STATE;
2884   }
2885 }
2886
2887 /* with STREAM_LOCK, PREROLL_LOCK
2888  *
2889  * Queue an object for rendering.
2890  * The first prerollable object queued will complete the preroll. If the
2891  * preroll queue if filled, we render all the objects in the queue.
2892  *
2893  * This function takes ownership of the object.
2894  */
2895 static GstFlowReturn
2896 gst_base_sink_queue_object_unlocked (GstBaseSink * basesink, GstPad * pad,
2897     gboolean is_list, gpointer obj, gboolean prerollable)
2898 {
2899   GstFlowReturn ret = GST_FLOW_OK;
2900   gint length;
2901   GQueue *q;
2902
2903   if (G_UNLIKELY (basesink->need_preroll)) {
2904     if (G_LIKELY (prerollable))
2905       basesink->preroll_queued++;
2906
2907     length = basesink->preroll_queued;
2908
2909     GST_DEBUG_OBJECT (basesink, "now %d prerolled items", length);
2910
2911     /* first prerollable item needs to finish the preroll */
2912     if (length == 1) {
2913       ret = gst_base_sink_preroll_object (basesink, is_list, obj);
2914       if (G_UNLIKELY (ret != GST_FLOW_OK))
2915         goto preroll_failed;
2916     }
2917     /* need to recheck if we need preroll, commmit state during preroll
2918      * could have made us not need more preroll. */
2919     if (G_UNLIKELY (basesink->need_preroll)) {
2920       /* see if we can render now, if we can't add the object to the preroll
2921        * queue. */
2922       if (G_UNLIKELY (length <= basesink->preroll_queue_max_len))
2923         goto more_preroll;
2924     }
2925   }
2926   /* we can start rendering (or blocking) the queued object
2927    * if any. */
2928   q = basesink->preroll_queue;
2929   while (G_UNLIKELY (!g_queue_is_empty (q))) {
2930     GstMiniObject *o;
2931
2932     o = g_queue_pop_head (q);
2933     GST_DEBUG_OBJECT (basesink, "rendering queued object %p", o);
2934
2935     /* do something with the return value */
2936     ret = gst_base_sink_render_object (basesink, pad, FALSE, o);
2937     if (ret != GST_FLOW_OK)
2938       goto dequeue_failed;
2939   }
2940
2941   /* now render the object */
2942   ret = gst_base_sink_render_object (basesink, pad, is_list, obj);
2943   basesink->preroll_queued = 0;
2944
2945   return ret;
2946
2947   /* special cases */
2948 preroll_failed:
2949   {
2950     GST_DEBUG_OBJECT (basesink, "preroll failed, reason %s",
2951         gst_flow_get_name (ret));
2952     gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
2953     return ret;
2954   }
2955 more_preroll:
2956   {
2957     /* add object to the queue and return */
2958     GST_DEBUG_OBJECT (basesink, "need more preroll data %d <= %d",
2959         length, basesink->preroll_queue_max_len);
2960     g_queue_push_tail (basesink->preroll_queue, obj);
2961     return GST_FLOW_OK;
2962   }
2963 dequeue_failed:
2964   {
2965     GST_DEBUG_OBJECT (basesink, "rendering queued objects failed, reason %s",
2966         gst_flow_get_name (ret));
2967     gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
2968     return ret;
2969   }
2970 }
2971
2972 /* with STREAM_LOCK
2973  *
2974  * This function grabs the PREROLL_LOCK and adds the object to
2975  * the queue.
2976  *
2977  * This function takes ownership of obj.
2978  */
2979 static GstFlowReturn
2980 gst_base_sink_queue_object (GstBaseSink * basesink, GstPad * pad,
2981     GstMiniObject * obj, gboolean prerollable)
2982 {
2983   GstFlowReturn ret;
2984
2985   GST_PAD_PREROLL_LOCK (pad);
2986   if (G_UNLIKELY (basesink->flushing))
2987     goto flushing;
2988
2989   if (G_UNLIKELY (basesink->priv->received_eos))
2990     goto was_eos;
2991
2992   ret =
2993       gst_base_sink_queue_object_unlocked (basesink, pad, FALSE, obj,
2994       prerollable);
2995   GST_PAD_PREROLL_UNLOCK (pad);
2996
2997   return ret;
2998
2999   /* ERRORS */
3000 flushing:
3001   {
3002     GST_DEBUG_OBJECT (basesink, "sink is flushing");
3003     GST_PAD_PREROLL_UNLOCK (pad);
3004     gst_mini_object_unref (obj);
3005     return GST_FLOW_WRONG_STATE;
3006   }
3007 was_eos:
3008   {
3009     GST_DEBUG_OBJECT (basesink,
3010         "we are EOS, dropping object, return UNEXPECTED");
3011     GST_PAD_PREROLL_UNLOCK (pad);
3012     gst_mini_object_unref (obj);
3013     return GST_FLOW_UNEXPECTED;
3014   }
3015 }
3016
3017 static void
3018 gst_base_sink_flush_start (GstBaseSink * basesink, GstPad * pad)
3019 {
3020   /* make sure we are not blocked on the clock also clear any pending
3021    * eos state. */
3022   gst_base_sink_set_flushing (basesink, pad, TRUE);
3023
3024   /* we grab the stream lock but that is not needed since setting the
3025    * sink to flushing would make sure no state commit is being done
3026    * anymore */
3027   GST_PAD_STREAM_LOCK (pad);
3028   gst_base_sink_reset_qos (basesink);
3029   if (basesink->priv->async_enabled) {
3030     /* and we need to commit our state again on the next
3031      * prerolled buffer */
3032     basesink->playing_async = TRUE;
3033     gst_element_lost_state (GST_ELEMENT_CAST (basesink));
3034   } else {
3035     basesink->priv->have_latency = TRUE;
3036     basesink->need_preroll = FALSE;
3037   }
3038   gst_base_sink_set_last_buffer (basesink, NULL);
3039   GST_PAD_STREAM_UNLOCK (pad);
3040 }
3041
3042 static void
3043 gst_base_sink_flush_stop (GstBaseSink * basesink, GstPad * pad)
3044 {
3045   /* unset flushing so we can accept new data, this also flushes out any EOS
3046    * event. */
3047   gst_base_sink_set_flushing (basesink, pad, FALSE);
3048
3049   /* for position reporting */
3050   GST_OBJECT_LOCK (basesink);
3051   basesink->priv->current_sstart = GST_CLOCK_TIME_NONE;
3052   basesink->priv->current_sstop = GST_CLOCK_TIME_NONE;
3053   basesink->priv->eos_rtime = GST_CLOCK_TIME_NONE;
3054   basesink->priv->call_preroll = TRUE;
3055   basesink->priv->current_step.valid = FALSE;
3056   basesink->priv->pending_step.valid = FALSE;
3057   if (basesink->pad_mode == GST_ACTIVATE_PUSH) {
3058     /* we need new segment info after the flush. */
3059     basesink->have_newsegment = FALSE;
3060     gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
3061     gst_segment_init (basesink->abidata.ABI.clip_segment, GST_FORMAT_UNDEFINED);
3062   }
3063   GST_OBJECT_UNLOCK (basesink);
3064 }
3065
3066 static gboolean
3067 gst_base_sink_event (GstPad * pad, GstEvent * event)
3068 {
3069   GstBaseSink *basesink;
3070   gboolean result = TRUE;
3071   GstBaseSinkClass *bclass;
3072
3073   basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3074
3075   bclass = GST_BASE_SINK_GET_CLASS (basesink);
3076
3077   GST_DEBUG_OBJECT (basesink, "event %p (%s)", event,
3078       GST_EVENT_TYPE_NAME (event));
3079
3080   switch (GST_EVENT_TYPE (event)) {
3081     case GST_EVENT_EOS:
3082     {
3083       GstFlowReturn ret;
3084
3085       GST_PAD_PREROLL_LOCK (pad);
3086       if (G_UNLIKELY (basesink->flushing))
3087         goto flushing;
3088
3089       if (G_UNLIKELY (basesink->priv->received_eos)) {
3090         /* we can't accept anything when we are EOS */
3091         result = FALSE;
3092         gst_event_unref (event);
3093       } else {
3094         /* we set the received EOS flag here so that we can use it when testing if
3095          * we are prerolled and to refuse more buffers. */
3096         basesink->priv->received_eos = TRUE;
3097
3098         /* EOS is a prerollable object, we call the unlocked version because it
3099          * does not check the received_eos flag. */
3100         ret = gst_base_sink_queue_object_unlocked (basesink, pad,
3101             FALSE, GST_MINI_OBJECT_CAST (event), TRUE);
3102         if (G_UNLIKELY (ret != GST_FLOW_OK))
3103           result = FALSE;
3104       }
3105       GST_PAD_PREROLL_UNLOCK (pad);
3106       break;
3107     }
3108     case GST_EVENT_NEWSEGMENT:
3109     {
3110       GstFlowReturn ret;
3111
3112       GST_DEBUG_OBJECT (basesink, "newsegment %p", event);
3113
3114       GST_PAD_PREROLL_LOCK (pad);
3115       if (G_UNLIKELY (basesink->flushing))
3116         goto flushing;
3117
3118       if (G_UNLIKELY (basesink->priv->received_eos)) {
3119         /* we can't accept anything when we are EOS */
3120         result = FALSE;
3121         gst_event_unref (event);
3122       } else {
3123         /* the new segment is a non prerollable item and does not block anything,
3124          * we need to configure the current clipping segment and insert the event
3125          * in the queue to serialize it with the buffers for rendering. */
3126         gst_base_sink_configure_segment (basesink, pad, event,
3127             basesink->abidata.ABI.clip_segment);
3128
3129         ret =
3130             gst_base_sink_queue_object_unlocked (basesink, pad,
3131             FALSE, GST_MINI_OBJECT_CAST (event), FALSE);
3132         if (G_UNLIKELY (ret != GST_FLOW_OK))
3133           result = FALSE;
3134         else {
3135           GST_OBJECT_LOCK (basesink);
3136           basesink->have_newsegment = TRUE;
3137           GST_OBJECT_UNLOCK (basesink);
3138         }
3139       }
3140       GST_PAD_PREROLL_UNLOCK (pad);
3141       break;
3142     }
3143     case GST_EVENT_FLUSH_START:
3144       if (bclass->event)
3145         bclass->event (basesink, event);
3146
3147       GST_DEBUG_OBJECT (basesink, "flush-start %p", event);
3148
3149       gst_base_sink_flush_start (basesink, pad);
3150
3151       gst_event_unref (event);
3152       break;
3153     case GST_EVENT_FLUSH_STOP:
3154       if (bclass->event)
3155         bclass->event (basesink, event);
3156
3157       GST_DEBUG_OBJECT (basesink, "flush-stop %p", event);
3158
3159       gst_base_sink_flush_stop (basesink, pad);
3160
3161       gst_event_unref (event);
3162       break;
3163     default:
3164       /* other events are sent to queue or subclass depending on if they
3165        * are serialized. */
3166       if (GST_EVENT_IS_SERIALIZED (event)) {
3167         gst_base_sink_queue_object (basesink, pad,
3168             GST_MINI_OBJECT_CAST (event), FALSE);
3169       } else {
3170         if (bclass->event)
3171           bclass->event (basesink, event);
3172         gst_event_unref (event);
3173       }
3174       break;
3175   }
3176 done:
3177   gst_object_unref (basesink);
3178
3179   return result;
3180
3181   /* ERRORS */
3182 flushing:
3183   {
3184     GST_DEBUG_OBJECT (basesink, "we are flushing");
3185     GST_PAD_PREROLL_UNLOCK (pad);
3186     result = FALSE;
3187     gst_event_unref (event);
3188     goto done;
3189   }
3190 }
3191
3192 /* default implementation to calculate the start and end
3193  * timestamps on a buffer, subclasses can override
3194  */
3195 static void
3196 gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
3197     GstClockTime * start, GstClockTime * end)
3198 {
3199   GstClockTime timestamp, duration;
3200
3201   timestamp = GST_BUFFER_TIMESTAMP (buffer);
3202   if (GST_CLOCK_TIME_IS_VALID (timestamp)) {
3203
3204     /* get duration to calculate end time */
3205     duration = GST_BUFFER_DURATION (buffer);
3206     if (GST_CLOCK_TIME_IS_VALID (duration)) {
3207       *end = timestamp + duration;
3208     }
3209     *start = timestamp;
3210   }
3211 }
3212
3213 /* must be called with PREROLL_LOCK */
3214 static gboolean
3215 gst_base_sink_needs_preroll (GstBaseSink * basesink)
3216 {
3217   gboolean is_prerolled, res;
3218
3219   /* we have 2 cases where the PREROLL_LOCK is released:
3220    *  1) we are blocking in the PREROLL_LOCK and thus are prerolled.
3221    *  2) we are syncing on the clock
3222    */
3223   is_prerolled = basesink->have_preroll || basesink->priv->received_eos;
3224   res = !is_prerolled;
3225
3226   GST_DEBUG_OBJECT (basesink, "have_preroll: %d, EOS: %d => needs preroll: %d",
3227       basesink->have_preroll, basesink->priv->received_eos, res);
3228
3229   return res;
3230 }
3231
3232 /* with STREAM_LOCK, PREROLL_LOCK
3233  *
3234  * Takes a buffer and compare the timestamps with the last segment.
3235  * If the buffer falls outside of the segment boundaries, drop it.
3236  * Else queue the buffer for preroll and rendering.
3237  *
3238  * This function takes ownership of the buffer.
3239  */
3240 static GstFlowReturn
3241 gst_base_sink_chain_unlocked (GstBaseSink * basesink, GstPad * pad,
3242     gboolean is_list, gpointer obj)
3243 {
3244   GstBaseSinkClass *bclass;
3245   GstFlowReturn result;
3246   GstClockTime start = GST_CLOCK_TIME_NONE, end = GST_CLOCK_TIME_NONE;
3247   GstSegment *clip_segment;
3248   GstBuffer *time_buf;
3249
3250   if (G_UNLIKELY (basesink->flushing))
3251     goto flushing;
3252
3253   if (G_UNLIKELY (basesink->priv->received_eos))
3254     goto was_eos;
3255
3256   if (is_list) {
3257     time_buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0, 0);
3258     g_assert (NULL != time_buf);
3259   } else {
3260     time_buf = GST_BUFFER_CAST (obj);
3261   }
3262
3263   /* for code clarity */
3264   clip_segment = basesink->abidata.ABI.clip_segment;
3265
3266   if (G_UNLIKELY (!basesink->have_newsegment)) {
3267     gboolean sync;
3268
3269     sync = gst_base_sink_get_sync (basesink);
3270     if (sync) {
3271       GST_ELEMENT_WARNING (basesink, STREAM, FAILED,
3272           (_("Internal data flow problem.")),
3273           ("Received buffer without a new-segment. Assuming timestamps start from 0."));
3274     }
3275
3276     /* this means this sink will assume timestamps start from 0 */
3277     GST_OBJECT_LOCK (basesink);
3278     clip_segment->start = 0;
3279     clip_segment->stop = -1;
3280     basesink->segment.start = 0;
3281     basesink->segment.stop = -1;
3282     basesink->have_newsegment = TRUE;
3283     GST_OBJECT_UNLOCK (basesink);
3284   }
3285
3286   bclass = GST_BASE_SINK_GET_CLASS (basesink);
3287
3288   /* check if the buffer needs to be dropped, we first ask the subclass for the
3289    * start and end */
3290   if (bclass->get_times)
3291     bclass->get_times (basesink, time_buf, &start, &end);
3292
3293   if (!GST_CLOCK_TIME_IS_VALID (start)) {
3294     /* if the subclass does not want sync, we use our own values so that we at
3295      * least clip the buffer to the segment */
3296     gst_base_sink_get_times (basesink, time_buf, &start, &end);
3297   }
3298
3299   GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
3300       ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (end));
3301
3302   /* a dropped buffer does not participate in anything */
3303   if (GST_CLOCK_TIME_IS_VALID (start) &&
3304       (clip_segment->format == GST_FORMAT_TIME)) {
3305     if (G_UNLIKELY (!gst_segment_clip (clip_segment,
3306                 GST_FORMAT_TIME, (gint64) start, (gint64) end, NULL, NULL)))
3307       goto out_of_segment;
3308   }
3309
3310   /* now we can process the buffer in the queue, this function takes ownership
3311    * of the buffer */
3312   result = gst_base_sink_queue_object_unlocked (basesink, pad,
3313       is_list, obj, TRUE);
3314   return result;
3315
3316   /* ERRORS */
3317 flushing:
3318   {
3319     GST_DEBUG_OBJECT (basesink, "sink is flushing");
3320     gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3321     return GST_FLOW_WRONG_STATE;
3322   }
3323 was_eos:
3324   {
3325     GST_DEBUG_OBJECT (basesink,
3326         "we are EOS, dropping object, return UNEXPECTED");
3327     gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3328     return GST_FLOW_UNEXPECTED;
3329   }
3330 out_of_segment:
3331   {
3332     GST_DEBUG_OBJECT (basesink, "dropping buffer, out of clipping segment");
3333     gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3334     return GST_FLOW_OK;
3335   }
3336 }
3337
3338 /* with STREAM_LOCK
3339  */
3340 static GstFlowReturn
3341 gst_base_sink_chain_main (GstBaseSink * basesink, GstPad * pad,
3342     gboolean is_list, gpointer obj)
3343 {
3344   GstFlowReturn result;
3345
3346   if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH))
3347     goto wrong_mode;
3348
3349   GST_PAD_PREROLL_LOCK (pad);
3350   result = gst_base_sink_chain_unlocked (basesink, pad, is_list, obj);
3351   GST_PAD_PREROLL_UNLOCK (pad);
3352
3353 done:
3354   return result;
3355
3356   /* ERRORS */
3357 wrong_mode:
3358   {
3359     GST_OBJECT_LOCK (pad);
3360     GST_WARNING_OBJECT (basesink,
3361         "Push on pad %s:%s, but it was not activated in push mode",
3362         GST_DEBUG_PAD_NAME (pad));
3363     GST_OBJECT_UNLOCK (pad);
3364     gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3365     /* we don't post an error message this will signal to the peer
3366      * pushing that EOS is reached. */
3367     result = GST_FLOW_UNEXPECTED;
3368     goto done;
3369   }
3370 }
3371
3372 static GstFlowReturn
3373 gst_base_sink_chain (GstPad * pad, GstBuffer * buf)
3374 {
3375   GstBaseSink *basesink;
3376
3377   basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3378
3379   return gst_base_sink_chain_main (basesink, pad, FALSE, buf);
3380 }
3381
3382 static GstFlowReturn
3383 gst_base_sink_chain_list (GstPad * pad, GstBufferList * list)
3384 {
3385   GstBaseSink *basesink;
3386   GstBaseSinkClass *bclass;
3387   GstFlowReturn result;
3388
3389   basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3390   bclass = GST_BASE_SINK_GET_CLASS (basesink);
3391
3392   if (G_LIKELY (bclass->render_list)) {
3393     result = gst_base_sink_chain_main (basesink, pad, TRUE, list);
3394   } else {
3395     GstBufferListIterator *it;
3396     GstBuffer *group;
3397
3398     GST_INFO_OBJECT (pad, "chaining each group in list as a merged buffer");
3399
3400     it = gst_buffer_list_iterate (list);
3401
3402     if (gst_buffer_list_iterator_next_group (it)) {
3403       do {
3404         group = gst_buffer_list_iterator_merge_group (it);
3405         if (group == NULL) {
3406           group = gst_buffer_new ();
3407           GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining empty group");
3408         } else {
3409           GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining group");
3410         }
3411         result = gst_base_sink_chain_main (basesink, pad, FALSE, group);
3412       } while (result == GST_FLOW_OK
3413           && gst_buffer_list_iterator_next_group (it));
3414     } else {
3415       GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining empty group");
3416       result =
3417           gst_base_sink_chain_main (basesink, pad, FALSE, gst_buffer_new ());
3418     }
3419     gst_buffer_list_iterator_free (it);
3420     gst_buffer_list_unref (list);
3421   }
3422   return result;
3423 }
3424
3425
3426 static gboolean
3427 gst_base_sink_default_do_seek (GstBaseSink * sink, GstSegment * segment)
3428 {
3429   gboolean res = TRUE;
3430
3431   /* update our offset if the start/stop position was updated */
3432   if (segment->format == GST_FORMAT_BYTES) {
3433     segment->time = segment->start;
3434   } else if (segment->start == 0) {
3435     /* seek to start, we can implement a default for this. */
3436     segment->time = 0;
3437   } else {
3438     res = FALSE;
3439     GST_INFO_OBJECT (sink, "Can't do a default seek");
3440   }
3441
3442   return res;
3443 }
3444
3445 #define SEEK_TYPE_IS_RELATIVE(t) (((t) != GST_SEEK_TYPE_NONE) && ((t) != GST_SEEK_TYPE_SET))
3446
3447 static gboolean
3448 gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
3449     GstEvent * event, GstSegment * segment)
3450 {
3451   /* By default, we try one of 2 things:
3452    *   - For absolute seek positions, convert the requested position to our
3453    *     configured processing format and place it in the output segment \
3454    *   - For relative seek positions, convert our current (input) values to the
3455    *     seek format, adjust by the relative seek offset and then convert back to
3456    *     the processing format
3457    */
3458   GstSeekType cur_type, stop_type;
3459   gint64 cur, stop;
3460   GstSeekFlags flags;
3461   GstFormat seek_format, dest_format;
3462   gdouble rate;
3463   gboolean update;
3464   gboolean res = TRUE;
3465
3466   gst_event_parse_seek (event, &rate, &seek_format, &flags,
3467       &cur_type, &cur, &stop_type, &stop);
3468   dest_format = segment->format;
3469
3470   if (seek_format == dest_format) {
3471     gst_segment_set_seek (segment, rate, seek_format, flags,
3472         cur_type, cur, stop_type, stop, &update);
3473     return TRUE;
3474   }
3475
3476   if (cur_type != GST_SEEK_TYPE_NONE) {
3477     /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3478     res =
3479         gst_pad_query_convert (sink->sinkpad, seek_format, cur, &dest_format,
3480         &cur);
3481     cur_type = GST_SEEK_TYPE_SET;
3482   }
3483
3484   if (res && stop_type != GST_SEEK_TYPE_NONE) {
3485     /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3486     res =
3487         gst_pad_query_convert (sink->sinkpad, seek_format, stop, &dest_format,
3488         &stop);
3489     stop_type = GST_SEEK_TYPE_SET;
3490   }
3491
3492   /* And finally, configure our output segment in the desired format */
3493   gst_segment_set_seek (segment, rate, dest_format, flags, cur_type, cur,
3494       stop_type, stop, &update);
3495
3496   if (!res)
3497     goto no_format;
3498
3499   return res;
3500
3501 no_format:
3502   {
3503     GST_DEBUG_OBJECT (sink, "undefined format given, seek aborted.");
3504     return FALSE;
3505   }
3506 }
3507
3508 /* perform a seek, only executed in pull mode */
3509 static gboolean
3510 gst_base_sink_perform_seek (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3511 {
3512   gboolean flush;
3513   gdouble rate;
3514   GstFormat seek_format, dest_format;
3515   GstSeekFlags flags;
3516   GstSeekType cur_type, stop_type;
3517   gboolean seekseg_configured = FALSE;
3518   gint64 cur, stop;
3519   gboolean update, res = TRUE;
3520   GstSegment seeksegment;
3521
3522   dest_format = sink->segment.format;
3523
3524   if (event) {
3525     GST_DEBUG_OBJECT (sink, "performing seek with event %p", event);
3526     gst_event_parse_seek (event, &rate, &seek_format, &flags,
3527         &cur_type, &cur, &stop_type, &stop);
3528
3529     flush = flags & GST_SEEK_FLAG_FLUSH;
3530   } else {
3531     GST_DEBUG_OBJECT (sink, "performing seek without event");
3532     flush = FALSE;
3533   }
3534
3535   if (flush) {
3536     GST_DEBUG_OBJECT (sink, "flushing upstream");
3537     gst_pad_push_event (pad, gst_event_new_flush_start ());
3538     gst_base_sink_flush_start (sink, pad);
3539   } else {
3540     GST_DEBUG_OBJECT (sink, "pausing pulling thread");
3541   }
3542
3543   GST_PAD_STREAM_LOCK (pad);
3544
3545   /* If we configured the seeksegment above, don't overwrite it now. Otherwise
3546    * copy the current segment info into the temp segment that we can actually
3547    * attempt the seek with. We only update the real segment if the seek suceeds. */
3548   if (!seekseg_configured) {
3549     memcpy (&seeksegment, &sink->segment, sizeof (GstSegment));
3550
3551     /* now configure the final seek segment */
3552     if (event) {
3553       if (sink->segment.format != seek_format) {
3554         /* OK, here's where we give the subclass a chance to convert the relative
3555          * seek into an absolute one in the processing format. We set up any
3556          * absolute seek above, before taking the stream lock. */
3557         if (!gst_base_sink_default_prepare_seek_segment (sink, event,
3558                 &seeksegment)) {
3559           GST_DEBUG_OBJECT (sink,
3560               "Preparing the seek failed after flushing. " "Aborting seek");
3561           res = FALSE;
3562         }
3563       } else {
3564         /* The seek format matches our processing format, no need to ask the
3565          * the subclass to configure the segment. */
3566         gst_segment_set_seek (&seeksegment, rate, seek_format, flags,
3567             cur_type, cur, stop_type, stop, &update);
3568       }
3569     }
3570     /* Else, no seek event passed, so we're just (re)starting the
3571        current segment. */
3572   }
3573
3574   if (res) {
3575     GST_DEBUG_OBJECT (sink, "segment configured from %" G_GINT64_FORMAT
3576         " to %" G_GINT64_FORMAT ", position %" G_GINT64_FORMAT,
3577         seeksegment.start, seeksegment.stop, seeksegment.last_stop);
3578
3579     /* do the seek, segment.last_stop contains the new position. */
3580     res = gst_base_sink_default_do_seek (sink, &seeksegment);
3581   }
3582
3583
3584   if (flush) {
3585     GST_DEBUG_OBJECT (sink, "stop flushing upstream");
3586     gst_pad_push_event (pad, gst_event_new_flush_stop ());
3587     gst_base_sink_flush_stop (sink, pad);
3588   } else if (res && sink->abidata.ABI.running) {
3589     /* we are running the current segment and doing a non-flushing seek,
3590      * close the segment first based on the last_stop. */
3591     GST_DEBUG_OBJECT (sink, "closing running segment %" G_GINT64_FORMAT
3592         " to %" G_GINT64_FORMAT, sink->segment.start, sink->segment.last_stop);
3593   }
3594
3595   /* The subclass must have converted the segment to the processing format
3596    * by now */
3597   if (res && seeksegment.format != dest_format) {
3598     GST_DEBUG_OBJECT (sink, "Subclass failed to prepare a seek segment "
3599         "in the correct format. Aborting seek.");
3600     res = FALSE;
3601   }
3602
3603   /* if successfull seek, we update our real segment and push
3604    * out the new segment. */
3605   if (res) {
3606     memcpy (&sink->segment, &seeksegment, sizeof (GstSegment));
3607
3608     if (sink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3609       gst_element_post_message (GST_ELEMENT (sink),
3610           gst_message_new_segment_start (GST_OBJECT (sink),
3611               sink->segment.format, sink->segment.last_stop));
3612     }
3613   }
3614
3615   sink->priv->discont = TRUE;
3616   sink->abidata.ABI.running = TRUE;
3617
3618   GST_PAD_STREAM_UNLOCK (pad);
3619
3620   return res;
3621 }
3622
3623 static void
3624 set_step_info (GstBaseSink * sink, GstStepInfo * current, GstStepInfo * pending,
3625     guint seqnum, GstFormat format, guint64 amount, gdouble rate,
3626     gboolean flush, gboolean intermediate)
3627 {
3628   GST_OBJECT_LOCK (sink);
3629   pending->seqnum = seqnum;
3630   pending->format = format;
3631   pending->amount = amount;
3632   pending->position = 0;
3633   pending->rate = rate;
3634   pending->flush = flush;
3635   pending->intermediate = intermediate;
3636   pending->valid = TRUE;
3637   /* flush invalidates the current stepping segment */
3638   if (flush)
3639     current->valid = FALSE;
3640   GST_OBJECT_UNLOCK (sink);
3641 }
3642
3643 static gboolean
3644 gst_base_sink_perform_step (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3645 {
3646   GstBaseSinkPrivate *priv;
3647   GstBaseSinkClass *bclass;
3648   gboolean flush, intermediate;
3649   gdouble rate;
3650   GstFormat format;
3651   guint64 amount;
3652   guint seqnum;
3653   GstStepInfo *pending, *current;
3654   GstMessage *message;
3655
3656   bclass = GST_BASE_SINK_GET_CLASS (sink);
3657   priv = sink->priv;
3658
3659   GST_DEBUG_OBJECT (sink, "performing step with event %p", event);
3660
3661   gst_event_parse_step (event, &format, &amount, &rate, &flush, &intermediate);
3662   seqnum = gst_event_get_seqnum (event);
3663
3664   pending = &priv->pending_step;
3665   current = &priv->current_step;
3666
3667   /* post message first */
3668   message = gst_message_new_step_start (GST_OBJECT (sink), FALSE, format,
3669       amount, rate, flush, intermediate);
3670   gst_message_set_seqnum (message, seqnum);
3671   gst_element_post_message (GST_ELEMENT (sink), message);
3672
3673   if (flush) {
3674     /* we need to call ::unlock before locking PREROLL_LOCK
3675      * since we lock it before going into ::render */
3676     if (bclass->unlock)
3677       bclass->unlock (sink);
3678
3679     GST_PAD_PREROLL_LOCK (sink->sinkpad);
3680     /* now that we have the PREROLL lock, clear our unlock request */
3681     if (bclass->unlock_stop)
3682       bclass->unlock_stop (sink);
3683
3684     /* update the stepinfo and make it valid */
3685     set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3686         intermediate);
3687
3688     if (sink->priv->async_enabled) {
3689       /* and we need to commit our state again on the next
3690        * prerolled buffer */
3691       sink->playing_async = TRUE;
3692       priv->pending_step.need_preroll = TRUE;
3693       sink->need_preroll = FALSE;
3694       gst_element_lost_state_full (GST_ELEMENT_CAST (sink), FALSE);
3695     } else {
3696       sink->priv->have_latency = TRUE;
3697       sink->need_preroll = FALSE;
3698     }
3699     priv->current_sstart = GST_CLOCK_TIME_NONE;
3700     priv->current_sstop = GST_CLOCK_TIME_NONE;
3701     priv->eos_rtime = GST_CLOCK_TIME_NONE;
3702     priv->call_preroll = TRUE;
3703     gst_base_sink_set_last_buffer (sink, NULL);
3704     gst_base_sink_reset_qos (sink);
3705
3706     if (sink->clock_id) {
3707       gst_clock_id_unschedule (sink->clock_id);
3708     }
3709
3710     if (sink->have_preroll) {
3711       GST_DEBUG_OBJECT (sink, "signal waiter");
3712       priv->step_unlock = TRUE;
3713       GST_PAD_PREROLL_SIGNAL (sink->sinkpad);
3714     }
3715     GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
3716   } else {
3717     /* update the stepinfo and make it valid */
3718     set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3719         intermediate);
3720   }
3721
3722   return TRUE;
3723 }
3724
3725 /* with STREAM_LOCK
3726  */
3727 static void
3728 gst_base_sink_loop (GstPad * pad)
3729 {
3730   GstBaseSink *basesink;
3731   GstBuffer *buf = NULL;
3732   GstFlowReturn result;
3733   guint blocksize;
3734   guint64 offset;
3735
3736   basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3737
3738   g_assert (basesink->pad_mode == GST_ACTIVATE_PULL);
3739
3740   if ((blocksize = basesink->priv->blocksize) == 0)
3741     blocksize = -1;
3742
3743   offset = basesink->segment.last_stop;
3744
3745   GST_DEBUG_OBJECT (basesink, "pulling %" G_GUINT64_FORMAT ", %u",
3746       offset, blocksize);
3747
3748   result = gst_pad_pull_range (pad, offset, blocksize, &buf);
3749   if (G_UNLIKELY (result != GST_FLOW_OK))
3750     goto paused;
3751
3752   if (G_UNLIKELY (buf == NULL))
3753     goto no_buffer;
3754
3755   offset += GST_BUFFER_SIZE (buf);
3756
3757   gst_segment_set_last_stop (&basesink->segment, GST_FORMAT_BYTES, offset);
3758
3759   GST_PAD_PREROLL_LOCK (pad);
3760   result = gst_base_sink_chain_unlocked (basesink, pad, FALSE, buf);
3761   GST_PAD_PREROLL_UNLOCK (pad);
3762   if (G_UNLIKELY (result != GST_FLOW_OK))
3763     goto paused;
3764
3765   return;
3766
3767   /* ERRORS */
3768 paused:
3769   {
3770     GST_LOG_OBJECT (basesink, "pausing task, reason %s",
3771         gst_flow_get_name (result));
3772     gst_pad_pause_task (pad);
3773     /* fatal errors and NOT_LINKED cause EOS */
3774     if (GST_FLOW_IS_FATAL (result) || result == GST_FLOW_NOT_LINKED) {
3775       if (result == GST_FLOW_UNEXPECTED) {
3776         /* perform EOS logic */
3777         if (basesink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3778           gst_element_post_message (GST_ELEMENT_CAST (basesink),
3779               gst_message_new_segment_done (GST_OBJECT_CAST (basesink),
3780                   basesink->segment.format, basesink->segment.last_stop));
3781         } else {
3782           gst_base_sink_event (pad, gst_event_new_eos ());
3783         }
3784       } else {
3785         /* for fatal errors we post an error message, post the error
3786          * first so the app knows about the error first. */
3787         GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
3788             (_("Internal data stream error.")),
3789             ("stream stopped, reason %s", gst_flow_get_name (result)));
3790         gst_base_sink_event (pad, gst_event_new_eos ());
3791       }
3792     }
3793     return;
3794   }
3795 no_buffer:
3796   {
3797     GST_LOG_OBJECT (basesink, "no buffer, pausing");
3798     GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
3799         (_("Internal data flow error.")), ("element returned NULL buffer"));
3800     result = GST_FLOW_ERROR;
3801     goto paused;
3802   }
3803 }
3804
3805 static gboolean
3806 gst_base_sink_set_flushing (GstBaseSink * basesink, GstPad * pad,
3807     gboolean flushing)
3808 {
3809   GstBaseSinkClass *bclass;
3810
3811   bclass = GST_BASE_SINK_GET_CLASS (basesink);
3812
3813   if (flushing) {
3814     /* unlock any subclasses, we need to do this before grabbing the
3815      * PREROLL_LOCK since we hold this lock before going into ::render. */
3816     if (bclass->unlock)
3817       bclass->unlock (basesink);
3818   }
3819
3820   GST_PAD_PREROLL_LOCK (pad);
3821   basesink->flushing = flushing;
3822   if (flushing) {
3823     /* step 1, now that we have the PREROLL lock, clear our unlock request */
3824     if (bclass->unlock_stop)
3825       bclass->unlock_stop (basesink);
3826
3827     /* set need_preroll before we unblock the clock. If the clock is unblocked
3828      * before timing out, we can reuse the buffer for preroll. */
3829     basesink->need_preroll = TRUE;
3830
3831     /* step 2, unblock clock sync (if any) or any other blocking thing */
3832     if (basesink->clock_id) {
3833       gst_clock_id_unschedule (basesink->clock_id);
3834     }
3835
3836     /* flush out the data thread if it's locked in finish_preroll, this will
3837      * also flush out the EOS state */
3838     GST_DEBUG_OBJECT (basesink,
3839         "flushing out data thread, need preroll to TRUE");
3840     gst_base_sink_preroll_queue_flush (basesink, pad);
3841   }
3842   GST_PAD_PREROLL_UNLOCK (pad);
3843
3844   return TRUE;
3845 }
3846
3847 static gboolean
3848 gst_base_sink_default_activate_pull (GstBaseSink * basesink, gboolean active)
3849 {
3850   gboolean result;
3851
3852   if (active) {
3853     /* start task */
3854     result = gst_pad_start_task (basesink->sinkpad,
3855         (GstTaskFunction) gst_base_sink_loop, basesink->sinkpad);
3856   } else {
3857     /* step 2, make sure streaming finishes */
3858     result = gst_pad_stop_task (basesink->sinkpad);
3859   }
3860
3861   return result;
3862 }
3863
3864 static gboolean
3865 gst_base_sink_pad_activate (GstPad * pad)
3866 {
3867   gboolean result = FALSE;
3868   GstBaseSink *basesink;
3869
3870   basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3871
3872   GST_DEBUG_OBJECT (basesink, "Trying pull mode first");
3873
3874   gst_base_sink_set_flushing (basesink, pad, FALSE);
3875
3876   /* we need to have the pull mode enabled */
3877   if (!basesink->can_activate_pull) {
3878     GST_DEBUG_OBJECT (basesink, "pull mode disabled");
3879     goto fallback;
3880   }
3881
3882   /* check if downstreams supports pull mode at all */
3883   if (!gst_pad_check_pull_range (pad)) {
3884     GST_DEBUG_OBJECT (basesink, "pull mode not supported");
3885     goto fallback;
3886   }
3887
3888   /* set the pad mode before starting the task so that it's in the
3889    * correct state for the new thread. also the sink set_caps and get_caps
3890    * function checks this */
3891   basesink->pad_mode = GST_ACTIVATE_PULL;
3892
3893   /* we first try to negotiate a format so that when we try to activate
3894    * downstream, it knows about our format */
3895   if (!gst_base_sink_negotiate_pull (basesink)) {
3896     GST_DEBUG_OBJECT (basesink, "failed to negotiate in pull mode");
3897     goto fallback;
3898   }
3899
3900   /* ok activate now */
3901   if (!gst_pad_activate_pull (pad, TRUE)) {
3902     /* clear any pending caps */
3903     GST_OBJECT_LOCK (basesink);
3904     gst_caps_replace (&basesink->priv->pull_caps, NULL);
3905     GST_OBJECT_UNLOCK (basesink);
3906     GST_DEBUG_OBJECT (basesink, "failed to activate in pull mode");
3907     goto fallback;
3908   }
3909
3910   GST_DEBUG_OBJECT (basesink, "Success activating pull mode");
3911   result = TRUE;
3912   goto done;
3913
3914   /* push mode fallback */
3915 fallback:
3916   GST_DEBUG_OBJECT (basesink, "Falling back to push mode");
3917   if ((result = gst_pad_activate_push (pad, TRUE))) {
3918     GST_DEBUG_OBJECT (basesink, "Success activating push mode");
3919   }
3920
3921 done:
3922   if (!result) {
3923     GST_WARNING_OBJECT (basesink, "Could not activate pad in either mode");
3924     gst_base_sink_set_flushing (basesink, pad, TRUE);
3925   }
3926
3927   gst_object_unref (basesink);
3928
3929   return result;
3930 }
3931
3932 static gboolean
3933 gst_base_sink_pad_activate_push (GstPad * pad, gboolean active)
3934 {
3935   gboolean result;
3936   GstBaseSink *basesink;
3937
3938   basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3939
3940   if (active) {
3941     if (!basesink->can_activate_push) {
3942       result = FALSE;
3943       basesink->pad_mode = GST_ACTIVATE_NONE;
3944     } else {
3945       result = TRUE;
3946       basesink->pad_mode = GST_ACTIVATE_PUSH;
3947     }
3948   } else {
3949     if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH)) {
3950       g_warning ("Internal GStreamer activation error!!!");
3951       result = FALSE;
3952     } else {
3953       gst_base_sink_set_flushing (basesink, pad, TRUE);
3954       result = TRUE;
3955       basesink->pad_mode = GST_ACTIVATE_NONE;
3956     }
3957   }
3958
3959   gst_object_unref (basesink);
3960
3961   return result;
3962 }
3963
3964 static gboolean
3965 gst_base_sink_negotiate_pull (GstBaseSink * basesink)
3966 {
3967   GstCaps *caps;
3968   gboolean result;
3969
3970   result = FALSE;
3971
3972   /* this returns the intersection between our caps and the peer caps. If there
3973    * is no peer, it returns NULL and we can't operate in pull mode so we can
3974    * fail the negotiation. */
3975   caps = gst_pad_get_allowed_caps (GST_BASE_SINK_PAD (basesink));
3976   if (caps == NULL || gst_caps_is_empty (caps))
3977     goto no_caps_possible;
3978
3979   GST_DEBUG_OBJECT (basesink, "allowed caps: %" GST_PTR_FORMAT, caps);
3980
3981   caps = gst_caps_make_writable (caps);
3982   /* get the first (prefered) format */
3983   gst_caps_truncate (caps);
3984   /* try to fixate */
3985   gst_pad_fixate_caps (GST_BASE_SINK_PAD (basesink), caps);
3986
3987   GST_DEBUG_OBJECT (basesink, "fixated to: %" GST_PTR_FORMAT, caps);
3988
3989   if (gst_caps_is_any (caps)) {
3990     GST_DEBUG_OBJECT (basesink, "caps were ANY after fixating, "
3991         "allowing pull()");
3992     /* neither side has template caps in this case, so they are prepared for
3993        pull() without setcaps() */
3994     result = TRUE;
3995   } else if (gst_caps_is_fixed (caps)) {
3996     if (!gst_pad_set_caps (GST_BASE_SINK_PAD (basesink), caps))
3997       goto could_not_set_caps;
3998
3999     GST_OBJECT_LOCK (basesink);
4000     gst_caps_replace (&basesink->priv->pull_caps, caps);
4001     GST_OBJECT_UNLOCK (basesink);
4002
4003     result = TRUE;
4004   }
4005
4006   gst_caps_unref (caps);
4007
4008   return result;
4009
4010 no_caps_possible:
4011   {
4012     GST_INFO_OBJECT (basesink, "Pipeline could not agree on caps");
4013     GST_DEBUG_OBJECT (basesink, "get_allowed_caps() returned EMPTY");
4014     if (caps)
4015       gst_caps_unref (caps);
4016     return FALSE;
4017   }
4018 could_not_set_caps:
4019   {
4020     GST_INFO_OBJECT (basesink, "Could not set caps: %" GST_PTR_FORMAT, caps);
4021     gst_caps_unref (caps);
4022     return FALSE;
4023   }
4024 }
4025
4026 /* this won't get called until we implement an activate function */
4027 static gboolean
4028 gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active)
4029 {
4030   gboolean result = FALSE;
4031   GstBaseSink *basesink;
4032   GstBaseSinkClass *bclass;
4033
4034   basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4035   bclass = GST_BASE_SINK_GET_CLASS (basesink);
4036
4037   if (active) {
4038     GstFormat format;
4039     gint64 duration;
4040
4041     /* we mark we have a newsegment here because pull based
4042      * mode works just fine without having a newsegment before the
4043      * first buffer */
4044     format = GST_FORMAT_BYTES;
4045
4046     gst_segment_init (&basesink->segment, format);
4047     gst_segment_init (basesink->abidata.ABI.clip_segment, format);
4048     GST_OBJECT_LOCK (basesink);
4049     basesink->have_newsegment = TRUE;
4050     GST_OBJECT_UNLOCK (basesink);
4051
4052     /* get the peer duration in bytes */
4053     result = gst_pad_query_peer_duration (pad, &format, &duration);
4054     if (result) {
4055       GST_DEBUG_OBJECT (basesink,
4056           "setting duration in bytes to %" G_GINT64_FORMAT, duration);
4057       gst_segment_set_duration (basesink->abidata.ABI.clip_segment, format,
4058           duration);
4059       gst_segment_set_duration (&basesink->segment, format, duration);
4060     } else {
4061       GST_DEBUG_OBJECT (basesink, "unknown duration");
4062     }
4063
4064     if (bclass->activate_pull)
4065       result = bclass->activate_pull (basesink, TRUE);
4066     else
4067       result = FALSE;
4068
4069     if (!result)
4070       goto activate_failed;
4071
4072   } else {
4073     if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PULL)) {
4074       g_warning ("Internal GStreamer activation error!!!");
4075       result = FALSE;
4076     } else {
4077       result = gst_base_sink_set_flushing (basesink, pad, TRUE);
4078       if (bclass->activate_pull)
4079         result &= bclass->activate_pull (basesink, FALSE);
4080       basesink->pad_mode = GST_ACTIVATE_NONE;
4081       /* clear any pending caps */
4082       GST_OBJECT_LOCK (basesink);
4083       gst_caps_replace (&basesink->priv->pull_caps, NULL);
4084       GST_OBJECT_UNLOCK (basesink);
4085     }
4086   }
4087   gst_object_unref (basesink);
4088
4089   return result;
4090
4091   /* ERRORS */
4092 activate_failed:
4093   {
4094     /* reset, as starting the thread failed */
4095     basesink->pad_mode = GST_ACTIVATE_NONE;
4096
4097     GST_ERROR_OBJECT (basesink, "subclass failed to activate in pull mode");
4098     return FALSE;
4099   }
4100 }
4101
4102 /* send an event to our sinkpad peer. */
4103 static gboolean
4104 gst_base_sink_send_event (GstElement * element, GstEvent * event)
4105 {
4106   GstPad *pad;
4107   GstBaseSink *basesink = GST_BASE_SINK (element);
4108   gboolean forward, result = TRUE;
4109   GstActivateMode mode;
4110
4111   GST_OBJECT_LOCK (element);
4112   /* get the pad and the scheduling mode */
4113   pad = gst_object_ref (basesink->sinkpad);
4114   mode = basesink->pad_mode;
4115   GST_OBJECT_UNLOCK (element);
4116
4117   /* only push UPSTREAM events upstream */
4118   forward = GST_EVENT_IS_UPSTREAM (event);
4119
4120   switch (GST_EVENT_TYPE (event)) {
4121     case GST_EVENT_LATENCY:
4122     {
4123       GstClockTime latency;
4124
4125       gst_event_parse_latency (event, &latency);
4126
4127       /* store the latency. We use this to adjust the running_time before syncing
4128        * it to the clock. */
4129       GST_OBJECT_LOCK (element);
4130       basesink->priv->latency = latency;
4131       if (!basesink->priv->have_latency)
4132         forward = FALSE;
4133       GST_OBJECT_UNLOCK (element);
4134       GST_DEBUG_OBJECT (basesink, "latency set to %" GST_TIME_FORMAT,
4135           GST_TIME_ARGS (latency));
4136
4137       /* We forward this event so that all elements know about the global pipeline
4138        * latency. This is interesting for an element when it wants to figure out
4139        * when a particular piece of data will be rendered. */
4140       break;
4141     }
4142     case GST_EVENT_SEEK:
4143       /* in pull mode we will execute the seek */
4144       if (mode == GST_ACTIVATE_PULL)
4145         result = gst_base_sink_perform_seek (basesink, pad, event);
4146       break;
4147     case GST_EVENT_STEP:
4148       result = gst_base_sink_perform_step (basesink, pad, event);
4149       forward = FALSE;
4150       break;
4151     default:
4152       break;
4153   }
4154
4155   if (forward) {
4156     result = gst_pad_push_event (pad, event);
4157   } else {
4158     /* not forwarded, unref the event */
4159     gst_event_unref (event);
4160   }
4161
4162   gst_object_unref (pad);
4163   return result;
4164 }
4165
4166 static gboolean
4167 gst_base_sink_peer_query (GstBaseSink * sink, GstQuery * query)
4168 {
4169   GstPad *peer;
4170   gboolean res = FALSE;
4171
4172   if ((peer = gst_pad_get_peer (sink->sinkpad))) {
4173     res = gst_pad_query (peer, query);
4174     gst_object_unref (peer);
4175   }
4176   return res;
4177 }
4178
4179 /* get the end position of the last seen object, this is used
4180  * for EOS and for making sure that we don't report a position we
4181  * have not reached yet. With LOCK. */
4182 static gboolean
4183 gst_base_sink_get_position_last (GstBaseSink * basesink, GstFormat format,
4184     gint64 * cur, gboolean * upstream)
4185 {
4186   GstFormat oformat;
4187   GstSegment *segment;
4188   gboolean ret = TRUE;
4189
4190   segment = &basesink->segment;
4191   oformat = segment->format;
4192
4193   if (oformat == GST_FORMAT_TIME) {
4194     /* return last observed stream time, we keep the stream time around in the
4195      * time format. */
4196     *cur = basesink->priv->current_sstop;
4197   } else {
4198     /* convert last stop to stream time */
4199     *cur = gst_segment_to_stream_time (segment, oformat, segment->last_stop);
4200   }
4201
4202   if (*cur != -1 && oformat != format) {
4203     GST_OBJECT_UNLOCK (basesink);
4204     /* convert to the target format if we need to, release lock first */
4205     ret =
4206         gst_pad_query_convert (basesink->sinkpad, oformat, *cur, &format, cur);
4207     if (!ret) {
4208       *cur = -1;
4209       *upstream = TRUE;
4210     }
4211     GST_OBJECT_LOCK (basesink);
4212   }
4213
4214   GST_DEBUG_OBJECT (basesink, "POSITION: %" GST_TIME_FORMAT,
4215       GST_TIME_ARGS (*cur));
4216
4217   return ret;
4218 }
4219
4220 /* get the position when we are PAUSED, this is the stream time of the buffer
4221  * that prerolled. If no buffer is prerolled (we are still flushing), this
4222  * value will be -1. With LOCK. */
4223 static gboolean
4224 gst_base_sink_get_position_paused (GstBaseSink * basesink, GstFormat format,
4225     gint64 * cur, gboolean * upstream)
4226 {
4227   gboolean res;
4228   gint64 time;
4229   GstSegment *segment;
4230   GstFormat oformat;
4231
4232   /* we don't use the clip segment in pull mode, when seeking we update the
4233    * main segment directly with the new segment values without it having to be
4234    * activated by the rendering after preroll */
4235   if (basesink->pad_mode == GST_ACTIVATE_PUSH)
4236     segment = basesink->abidata.ABI.clip_segment;
4237   else
4238     segment = &basesink->segment;
4239   oformat = segment->format;
4240
4241   if (oformat == GST_FORMAT_TIME) {
4242     *cur = basesink->priv->current_sstart;
4243     if (segment->rate < 0.0 &&
4244         GST_CLOCK_TIME_IS_VALID (basesink->priv->current_sstop)) {
4245       /* for reverse playback we prefer the stream time stop position if we have
4246        * one */
4247       *cur = basesink->priv->current_sstop;
4248     }
4249   } else {
4250     *cur = gst_segment_to_stream_time (segment, oformat, segment->last_stop);
4251   }
4252
4253   time = segment->time;
4254
4255   if (*cur != -1) {
4256     *cur = MAX (*cur, time);
4257     GST_DEBUG_OBJECT (basesink, "POSITION as max: %" GST_TIME_FORMAT
4258         ", time %" GST_TIME_FORMAT, GST_TIME_ARGS (*cur), GST_TIME_ARGS (time));
4259   } else {
4260     /* we have no buffer, use the segment times. */
4261     if (segment->rate >= 0.0) {
4262       /* forward, next position is always the time of the segment */
4263       *cur = time;
4264       GST_DEBUG_OBJECT (basesink, "POSITION as time: %" GST_TIME_FORMAT,
4265           GST_TIME_ARGS (*cur));
4266     } else {
4267       /* reverse, next expected timestamp is segment->stop. We use the function
4268        * to get things right for negative applied_rates. */
4269       *cur = gst_segment_to_stream_time (segment, oformat, segment->stop);
4270       GST_DEBUG_OBJECT (basesink, "reverse POSITION: %" GST_TIME_FORMAT,
4271           GST_TIME_ARGS (*cur));
4272     }
4273   }
4274
4275   res = (*cur != -1);
4276   if (res && oformat != format) {
4277     GST_OBJECT_UNLOCK (basesink);
4278     res =
4279         gst_pad_query_convert (basesink->sinkpad, oformat, *cur, &format, cur);
4280     if (!res) {
4281       *cur = -1;
4282       *upstream = TRUE;
4283     }
4284     GST_OBJECT_LOCK (basesink);
4285   }
4286
4287   return res;
4288 }
4289
4290 static gboolean
4291 gst_base_sink_get_position (GstBaseSink * basesink, GstFormat format,
4292     gint64 * cur, gboolean * upstream)
4293 {
4294   GstClock *clock;
4295   gboolean res = FALSE;
4296   GstFormat oformat, tformat;
4297   GstClockTime now, base, latency;
4298   gint64 time, accum, duration;
4299   gdouble rate;
4300   gint64 last;
4301
4302   GST_OBJECT_LOCK (basesink);
4303   /* our intermediate time format */
4304   tformat = GST_FORMAT_TIME;
4305   /* get the format in the segment */
4306   oformat = basesink->segment.format;
4307
4308   /* can only give answer based on the clock if not EOS */
4309   if (G_UNLIKELY (basesink->eos))
4310     goto in_eos;
4311
4312   /* we can only get the segment when we are not NULL or READY */
4313   if (!basesink->have_newsegment)
4314     goto wrong_state;
4315
4316   /* when not in PLAYING or when we're busy with a state change, we
4317    * cannot read from the clock so we report time based on the
4318    * last seen timestamp. */
4319   if (GST_STATE (basesink) != GST_STATE_PLAYING ||
4320       GST_STATE_PENDING (basesink) != GST_STATE_VOID_PENDING)
4321     goto in_pause;
4322
4323   /* we need to sync on the clock. */
4324   if (basesink->sync == FALSE)
4325     goto no_sync;
4326
4327   /* and we need a clock */
4328   if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (basesink)) == NULL))
4329     goto no_sync;
4330
4331   /* collect all data we need holding the lock */
4332   if (GST_CLOCK_TIME_IS_VALID (basesink->segment.time))
4333     time = basesink->segment.time;
4334   else
4335     time = 0;
4336
4337   if (GST_CLOCK_TIME_IS_VALID (basesink->segment.stop))
4338     duration = basesink->segment.stop - basesink->segment.start;
4339   else
4340     duration = 0;
4341
4342   base = GST_ELEMENT_CAST (basesink)->base_time;
4343   accum = basesink->segment.accum;
4344   rate = basesink->segment.rate * basesink->segment.applied_rate;
4345   latency = basesink->priv->latency;
4346
4347   gst_object_ref (clock);
4348
4349   /* this function might release the LOCK */
4350   gst_base_sink_get_position_last (basesink, format, &last, upstream);
4351
4352   /* need to release the object lock before we can get the time,
4353    * a clock might take the LOCK of the provider, which could be
4354    * a basesink subclass. */
4355   GST_OBJECT_UNLOCK (basesink);
4356
4357   now = gst_clock_get_time (clock);
4358
4359   if (oformat != tformat) {
4360     /* convert accum, time and duration to time */
4361     if (!gst_pad_query_convert (basesink->sinkpad, oformat, accum, &tformat,
4362             &accum))
4363       goto convert_failed;
4364     if (!gst_pad_query_convert (basesink->sinkpad, oformat, duration, &tformat,
4365             &duration))
4366       goto convert_failed;
4367     if (!gst_pad_query_convert (basesink->sinkpad, oformat, time, &tformat,
4368             &time))
4369       goto convert_failed;
4370   }
4371
4372   /* subtract base time and accumulated time from the clock time.
4373    * Make sure we don't go negative. This is the current time in
4374    * the segment which we need to scale with the combined
4375    * rate and applied rate. */
4376   base += accum;
4377   base += latency;
4378   base = MIN (now, base);
4379
4380   /* for negative rates we need to count back from from the segment
4381    * duration. */
4382   if (rate < 0.0)
4383     time += duration;
4384
4385   *cur = time + gst_guint64_to_gdouble (now - base) * rate;
4386
4387   /* never report more than last seen position */
4388   if (last != -1)
4389     *cur = MIN (last, *cur);
4390
4391   gst_object_unref (clock);
4392
4393   GST_DEBUG_OBJECT (basesink,
4394       "now %" GST_TIME_FORMAT " - base %" GST_TIME_FORMAT " - accum %"
4395       GST_TIME_FORMAT " + time %" GST_TIME_FORMAT,
4396       GST_TIME_ARGS (now), GST_TIME_ARGS (base),
4397       GST_TIME_ARGS (accum), GST_TIME_ARGS (time));
4398
4399   if (oformat != format) {
4400     /* convert time to final format */
4401     if (!gst_pad_query_convert (basesink->sinkpad, tformat, *cur, &format, cur))
4402       goto convert_failed;
4403   }
4404
4405   res = TRUE;
4406
4407 done:
4408   GST_DEBUG_OBJECT (basesink, "res: %d, POSITION: %" GST_TIME_FORMAT,
4409       res, GST_TIME_ARGS (*cur));
4410   return res;
4411
4412   /* special cases */
4413 in_eos:
4414   {
4415     GST_DEBUG_OBJECT (basesink, "position in EOS");
4416     res = gst_base_sink_get_position_last (basesink, format, cur, upstream);
4417     GST_OBJECT_UNLOCK (basesink);
4418     goto done;
4419   }
4420 in_pause:
4421   {
4422     GST_DEBUG_OBJECT (basesink, "position in PAUSED");
4423     res = gst_base_sink_get_position_paused (basesink, format, cur, upstream);
4424     GST_OBJECT_UNLOCK (basesink);
4425     goto done;
4426   }
4427 wrong_state:
4428   {
4429     /* in NULL or READY we always return FALSE and -1 */
4430     GST_DEBUG_OBJECT (basesink, "position in wrong state, return -1");
4431     res = FALSE;
4432     *cur = -1;
4433     GST_OBJECT_UNLOCK (basesink);
4434     goto done;
4435   }
4436 no_sync:
4437   {
4438     /* report last seen timestamp if any, else ask upstream to answer */
4439     if ((*cur = basesink->priv->current_sstart) != -1)
4440       res = TRUE;
4441     else
4442       *upstream = TRUE;
4443
4444     GST_DEBUG_OBJECT (basesink, "no sync, res %d, POSITION %" GST_TIME_FORMAT,
4445         res, GST_TIME_ARGS (*cur));
4446     GST_OBJECT_UNLOCK (basesink);
4447     return res;
4448   }
4449 convert_failed:
4450   {
4451     GST_DEBUG_OBJECT (basesink, "convert failed, try upstream");
4452     *upstream = TRUE;
4453     return FALSE;
4454   }
4455 }
4456
4457 static gboolean
4458 gst_base_sink_query (GstElement * element, GstQuery * query)
4459 {
4460   gboolean res = FALSE;
4461
4462   GstBaseSink *basesink = GST_BASE_SINK (element);
4463
4464   switch (GST_QUERY_TYPE (query)) {
4465     case GST_QUERY_POSITION:
4466     {
4467       gint64 cur = 0;
4468       GstFormat format;
4469       gboolean upstream = FALSE;
4470
4471       gst_query_parse_position (query, &format, NULL);
4472
4473       GST_DEBUG_OBJECT (basesink, "position format %d", format);
4474
4475       /* first try to get the position based on the clock */
4476       if ((res =
4477               gst_base_sink_get_position (basesink, format, &cur, &upstream))) {
4478         gst_query_set_position (query, format, cur);
4479       } else if (upstream) {
4480         /* fallback to peer query */
4481         res = gst_base_sink_peer_query (basesink, query);
4482       }
4483       break;
4484     }
4485     case GST_QUERY_DURATION:
4486     {
4487       GstFormat format, uformat;
4488       gint64 duration, uduration;
4489
4490       gst_query_parse_duration (query, &format, NULL);
4491
4492       GST_DEBUG_OBJECT (basesink, "duration query in format %s",
4493           gst_format_get_name (format));
4494
4495       if (basesink->pad_mode == GST_ACTIVATE_PULL) {
4496         uformat = GST_FORMAT_BYTES;
4497
4498         /* get the duration in bytes, in pull mode that's all we are sure to
4499          * know. We have to explicitly get this value from upstream instead of
4500          * using our cached value because it might change. Duration caching
4501          * should be done at a higher level. */
4502         res = gst_pad_query_peer_duration (basesink->sinkpad, &uformat,
4503             &uduration);
4504         if (res) {
4505           gst_segment_set_duration (&basesink->segment, uformat, uduration);
4506           if (format != uformat) {
4507             /* convert to the requested format */
4508             res = gst_pad_query_convert (basesink->sinkpad, uformat, uduration,
4509                 &format, &duration);
4510           } else {
4511             duration = uduration;
4512           }
4513           if (res) {
4514             /* set the result */
4515             gst_query_set_duration (query, format, duration);
4516           }
4517         }
4518       } else {
4519         /* in push mode we simply forward upstream */
4520         res = gst_base_sink_peer_query (basesink, query);
4521       }
4522       break;
4523     }
4524     case GST_QUERY_LATENCY:
4525     {
4526       gboolean live, us_live;
4527       GstClockTime min, max;
4528
4529       if ((res = gst_base_sink_query_latency (basesink, &live, &us_live, &min,
4530                   &max))) {
4531         gst_query_set_latency (query, live, min, max);
4532       }
4533       break;
4534     }
4535     case GST_QUERY_JITTER:
4536       break;
4537     case GST_QUERY_RATE:
4538       /* gst_query_set_rate (query, basesink->segment_rate); */
4539       res = TRUE;
4540       break;
4541     case GST_QUERY_SEGMENT:
4542     {
4543       /* FIXME, bring start/stop to stream time */
4544       gst_query_set_segment (query, basesink->segment.rate,
4545           GST_FORMAT_TIME, basesink->segment.start, basesink->segment.stop);
4546       break;
4547     }
4548     case GST_QUERY_SEEKING:
4549     case GST_QUERY_CONVERT:
4550     case GST_QUERY_FORMATS:
4551     default:
4552       res = gst_base_sink_peer_query (basesink, query);
4553       break;
4554   }
4555   return res;
4556 }
4557
4558 static GstStateChangeReturn
4559 gst_base_sink_change_state (GstElement * element, GstStateChange transition)
4560 {
4561   GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
4562   GstBaseSink *basesink = GST_BASE_SINK (element);
4563   GstBaseSinkClass *bclass;
4564   GstBaseSinkPrivate *priv;
4565
4566   priv = basesink->priv;
4567
4568   bclass = GST_BASE_SINK_GET_CLASS (basesink);
4569
4570   switch (transition) {
4571     case GST_STATE_CHANGE_NULL_TO_READY:
4572       if (bclass->start)
4573         if (!bclass->start (basesink))
4574           goto start_failed;
4575       break;
4576     case GST_STATE_CHANGE_READY_TO_PAUSED:
4577       /* need to complete preroll before this state change completes, there
4578        * is no data flow in READY so we can safely assume we need to preroll. */
4579       GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4580       GST_DEBUG_OBJECT (basesink, "READY to PAUSED");
4581       basesink->have_newsegment = FALSE;
4582       gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
4583       gst_segment_init (basesink->abidata.ABI.clip_segment,
4584           GST_FORMAT_UNDEFINED);
4585       basesink->offset = 0;
4586       basesink->have_preroll = FALSE;
4587       priv->step_unlock = FALSE;
4588       basesink->need_preroll = TRUE;
4589       basesink->playing_async = TRUE;
4590       priv->current_sstart = GST_CLOCK_TIME_NONE;
4591       priv->current_sstop = GST_CLOCK_TIME_NONE;
4592       priv->eos_rtime = GST_CLOCK_TIME_NONE;
4593       priv->latency = 0;
4594       basesink->eos = FALSE;
4595       priv->received_eos = FALSE;
4596       gst_base_sink_reset_qos (basesink);
4597       priv->commited = FALSE;
4598       priv->call_preroll = TRUE;
4599       priv->current_step.valid = FALSE;
4600       priv->pending_step.valid = FALSE;
4601       if (priv->async_enabled) {
4602         GST_DEBUG_OBJECT (basesink, "doing async state change");
4603         /* when async enabled, post async-start message and return ASYNC from
4604          * the state change function */
4605         ret = GST_STATE_CHANGE_ASYNC;
4606         gst_element_post_message (GST_ELEMENT_CAST (basesink),
4607             gst_message_new_async_start (GST_OBJECT_CAST (basesink), FALSE));
4608       } else {
4609         priv->have_latency = TRUE;
4610       }
4611       GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4612       break;
4613     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
4614       GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4615       if (!gst_base_sink_needs_preroll (basesink)) {
4616         GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, don't need preroll");
4617         /* no preroll needed anymore now. */
4618         basesink->playing_async = FALSE;
4619         basesink->need_preroll = FALSE;
4620         if (basesink->eos) {
4621           GstMessage *message;
4622
4623           /* need to post EOS message here */
4624           GST_DEBUG_OBJECT (basesink, "Now posting EOS");
4625           message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
4626           gst_message_set_seqnum (message, basesink->priv->seqnum);
4627           gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
4628         } else {
4629           GST_DEBUG_OBJECT (basesink, "signal preroll");
4630           GST_PAD_PREROLL_SIGNAL (basesink->sinkpad);
4631         }
4632       } else {
4633         GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, we are not prerolled");
4634         basesink->need_preroll = TRUE;
4635         basesink->playing_async = TRUE;
4636         priv->call_preroll = TRUE;
4637         priv->commited = FALSE;
4638         if (priv->async_enabled) {
4639           GST_DEBUG_OBJECT (basesink, "doing async state change");
4640           ret = GST_STATE_CHANGE_ASYNC;
4641           gst_element_post_message (GST_ELEMENT_CAST (basesink),
4642               gst_message_new_async_start (GST_OBJECT_CAST (basesink), FALSE));
4643         }
4644       }
4645       GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4646       break;
4647     default:
4648       break;
4649   }
4650
4651   {
4652     GstStateChangeReturn bret;
4653
4654     bret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
4655     if (G_UNLIKELY (bret == GST_STATE_CHANGE_FAILURE))
4656       goto activate_failed;
4657   }
4658
4659   switch (transition) {
4660     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
4661       GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED");
4662       /* FIXME, make sure we cannot enter _render first */
4663
4664       /* we need to call ::unlock before locking PREROLL_LOCK
4665        * since we lock it before going into ::render */
4666       if (bclass->unlock)
4667         bclass->unlock (basesink);
4668
4669       GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4670       /* now that we have the PREROLL lock, clear our unlock request */
4671       if (bclass->unlock_stop)
4672         bclass->unlock_stop (basesink);
4673
4674       /* we need preroll again and we set the flag before unlocking the clockid
4675        * because if the clockid is unlocked before a current buffer expired, we
4676        * can use that buffer to preroll with */
4677       basesink->need_preroll = TRUE;
4678
4679       if (basesink->clock_id) {
4680         gst_clock_id_unschedule (basesink->clock_id);
4681       }
4682
4683       /* if we don't have a preroll buffer we need to wait for a preroll and
4684        * return ASYNC. */
4685       if (!gst_base_sink_needs_preroll (basesink)) {
4686         GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED, we are prerolled");
4687         basesink->playing_async = FALSE;
4688       } else {
4689         if (GST_STATE_TARGET (GST_ELEMENT (basesink)) <= GST_STATE_READY) {
4690           ret = GST_STATE_CHANGE_SUCCESS;
4691         } else {
4692           GST_DEBUG_OBJECT (basesink,
4693               "PLAYING to PAUSED, we are not prerolled");
4694           basesink->playing_async = TRUE;
4695           priv->commited = FALSE;
4696           priv->call_preroll = TRUE;
4697           if (priv->async_enabled) {
4698             GST_DEBUG_OBJECT (basesink, "doing async state change");
4699             ret = GST_STATE_CHANGE_ASYNC;
4700             gst_element_post_message (GST_ELEMENT_CAST (basesink),
4701                 gst_message_new_async_start (GST_OBJECT_CAST (basesink),
4702                     FALSE));
4703           }
4704         }
4705       }
4706       GST_DEBUG_OBJECT (basesink, "rendered: %" G_GUINT64_FORMAT
4707           ", dropped: %" G_GUINT64_FORMAT, priv->rendered, priv->dropped);
4708
4709       gst_base_sink_reset_qos (basesink);
4710       GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4711       break;
4712     case GST_STATE_CHANGE_PAUSED_TO_READY:
4713       GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4714       /* start by reseting our position state with the object lock so that the
4715        * position query gets the right idea. We do this before we post the
4716        * messages so that the message handlers pick this up. */
4717       GST_OBJECT_LOCK (basesink);
4718       basesink->have_newsegment = FALSE;
4719       priv->current_sstart = GST_CLOCK_TIME_NONE;
4720       priv->current_sstop = GST_CLOCK_TIME_NONE;
4721       priv->have_latency = FALSE;
4722       GST_OBJECT_UNLOCK (basesink);
4723
4724       gst_base_sink_set_last_buffer (basesink, NULL);
4725       priv->call_preroll = FALSE;
4726
4727       if (!priv->commited) {
4728         if (priv->async_enabled) {
4729           GST_DEBUG_OBJECT (basesink, "PAUSED to READY, posting async-done");
4730
4731           gst_element_post_message (GST_ELEMENT_CAST (basesink),
4732               gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
4733                   GST_STATE_PLAYING, GST_STATE_PAUSED, GST_STATE_READY));
4734
4735           gst_element_post_message (GST_ELEMENT_CAST (basesink),
4736               gst_message_new_async_done (GST_OBJECT_CAST (basesink)));
4737         }
4738         priv->commited = TRUE;
4739       } else {
4740         GST_DEBUG_OBJECT (basesink, "PAUSED to READY, don't need_preroll");
4741       }
4742       GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4743       break;
4744     case GST_STATE_CHANGE_READY_TO_NULL:
4745       if (bclass->stop) {
4746         if (!bclass->stop (basesink)) {
4747           GST_WARNING_OBJECT (basesink, "failed to stop");
4748         }
4749       }
4750       gst_base_sink_set_last_buffer (basesink, NULL);
4751       priv->call_preroll = FALSE;
4752       break;
4753     default:
4754       break;
4755   }
4756
4757   return ret;
4758
4759   /* ERRORS */
4760 start_failed:
4761   {
4762     GST_DEBUG_OBJECT (basesink, "failed to start");
4763     return GST_STATE_CHANGE_FAILURE;
4764   }
4765 activate_failed:
4766   {
4767     GST_DEBUG_OBJECT (basesink,
4768         "element failed to change states -- activation problem?");
4769     return GST_STATE_CHANGE_FAILURE;
4770   }
4771 }