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