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