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