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