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