2 * Copyright (C) 2005-2007 Wim Taymans <wim.taymans@gmail.com>
4 * gstbasesink.c: Base class for sink elements
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.
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.
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.
24 * @short_description: Base class for sink elements
25 * @see_also: #GstBaseTransform, #GstBaseSrc
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.
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.
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:
42 * my_element_class_init (GstMyElementClass *klass)
44 * GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
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 (&sinktemplate));
50 * // see #GstElementDetails
51 * gst_element_class_set_details (gstelement_class, &details);
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.
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.
67 * After synchronisation the virtual method #GstBaseSinkClass.render() will be
68 * called. Subclasses should minimally implement this method.
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.
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.
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.
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
94 * The #GstBaseSinkClass.set_caps() function will be called when the subclass
95 * should configure itself to process a specific media type.
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.
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.
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.
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
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.
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
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.
138 * Last reviewed on 2007-08-29 (0.10.15)
145 #include <gst/gst_private.h>
147 #include "gstbasesink.h"
148 #include <gst/gstmarshal.h>
149 #include <gst/gst-i18n-lib.h>
151 GST_DEBUG_CATEGORY_STATIC (gst_base_sink_debug);
152 #define GST_CAT_DEFAULT gst_base_sink_debug
154 #define GST_BASE_SINK_GET_PRIVATE(obj) \
155 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_BASE_SINK, GstBaseSinkPrivate))
157 #define GST_FLOW_STEP GST_FLOW_CUSTOM_ERROR
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 */
177 /* FIXME, some stuff in ABI.data and other in Private...
178 * Make up your mind please.
180 struct _GstBaseSinkPrivate
182 GQueue *preroll_queue;
185 gint qos_enabled; /* ATOMIC */
186 gboolean async_enabled;
187 GstClockTimeDiff ts_offset;
188 GstClockTime render_delay;
190 /* start, stop of current buffer, stream time, used to report position */
191 GstClockTime current_sstart;
192 GstClockTime current_sstop;
194 /* start, stop and jitter of current buffer, running time */
195 GstClockTime current_rstart;
196 GstClockTime current_rstop;
197 GstClockTimeDiff current_jitter;
198 /* the running time of the previous buffer */
199 GstClockTime prev_rstart;
201 /* EOS sync time in running time */
202 GstClockTime eos_rtime;
204 /* last buffer that arrived in time, running time */
205 GstClockTime last_render_time;
206 /* when the last buffer left the sink, running time */
207 GstClockTime last_left;
209 /* running averages go here these are done on running time */
211 GstClockTime avg_duration;
213 GstClockTime avg_in_diff;
215 /* these are done on system time. avg_jitter and avg_render are
216 * compared to eachother to see if the rendering time takes a
217 * huge amount of the processing, If so we are flooded with
219 GstClockTime last_left_systime;
220 GstClockTime avg_jitter;
221 GstClockTime start, stop;
222 GstClockTime avg_render;
224 /* number of rendered and dropped frames */
229 GstClockTime latency;
231 /* if we already commited the state */
233 /* state change to playing ongoing */
236 /* when we received EOS */
237 gboolean received_eos;
239 /* when we are prerolled and able to report latency */
240 gboolean have_latency;
242 /* the last buffer we prerolled or rendered. Useful for making snapshots */
243 gint enable_last_buffer; /* atomic */
244 GstBuffer *last_buffer;
246 /* caps for pull based scheduling */
249 /* blocksize for pulling */
254 /* seqnum of the stream */
257 gboolean call_preroll;
258 gboolean step_unlock;
260 /* we have a pending and a current step operation */
261 GstStepInfo current_step;
262 GstStepInfo pending_step;
264 /* Cached GstClockID */
265 GstClockID cached_clock_id;
267 /* for throttling and QoS */
268 GstClockTime earliest_in_time;
269 GstClockTime throttle_time;
274 #define DO_RUNNING_AVG(avg,val,size) (((val) + ((size)-1) * (avg)) / (size))
276 /* generic running average, this has a neutral window size */
277 #define UPDATE_RUNNING_AVG(avg,val) DO_RUNNING_AVG(avg,val,8)
279 /* the windows for these running averages are experimentally obtained.
280 * possitive values get averaged more while negative values use a small
281 * window so we can react faster to badness. */
282 #define UPDATE_RUNNING_AVG_P(avg,val) DO_RUNNING_AVG(avg,val,16)
283 #define UPDATE_RUNNING_AVG_N(avg,val) DO_RUNNING_AVG(avg,val,4)
287 _PR_IS_NOTHING = 1 << 0,
288 _PR_IS_BUFFER = 1 << 1,
289 _PR_IS_BUFFERLIST = 1 << 2,
290 _PR_IS_EVENT = 1 << 3
293 #define OBJ_IS_BUFFER(a) ((a) & _PR_IS_BUFFER)
294 #define OBJ_IS_BUFFERLIST(a) ((a) & _PR_IS_BUFFERLIST)
295 #define OBJ_IS_EVENT(a) ((a) & _PR_IS_EVENT)
296 #define OBJ_IS_BUFFERFULL(a) ((a) & (_PR_IS_BUFFER | _PR_IS_BUFFERLIST))
298 /* BaseSink properties */
300 #define DEFAULT_CAN_ACTIVATE_PULL FALSE /* fixme: enable me */
301 #define DEFAULT_CAN_ACTIVATE_PUSH TRUE
303 #define DEFAULT_SYNC TRUE
304 #define DEFAULT_MAX_LATENESS -1
305 #define DEFAULT_QOS FALSE
306 #define DEFAULT_ASYNC TRUE
307 #define DEFAULT_TS_OFFSET 0
308 #define DEFAULT_BLOCKSIZE 4096
309 #define DEFAULT_RENDER_DELAY 0
310 #define DEFAULT_ENABLE_LAST_BUFFER TRUE
311 #define DEFAULT_THROTTLE_TIME 0
321 PROP_ENABLE_LAST_BUFFER,
329 static GstElementClass *parent_class = NULL;
331 static void gst_base_sink_class_init (GstBaseSinkClass * klass);
332 static void gst_base_sink_init (GstBaseSink * trans, gpointer g_class);
333 static void gst_base_sink_finalize (GObject * object);
336 gst_base_sink_get_type (void)
338 static volatile gsize base_sink_type = 0;
340 if (g_once_init_enter (&base_sink_type)) {
342 static const GTypeInfo base_sink_info = {
343 sizeof (GstBaseSinkClass),
346 (GClassInitFunc) gst_base_sink_class_init,
349 sizeof (GstBaseSink),
351 (GInstanceInitFunc) gst_base_sink_init,
354 _type = g_type_register_static (GST_TYPE_ELEMENT,
355 "GstBaseSink", &base_sink_info, G_TYPE_FLAG_ABSTRACT);
356 g_once_init_leave (&base_sink_type, _type);
358 return base_sink_type;
361 static void gst_base_sink_set_property (GObject * object, guint prop_id,
362 const GValue * value, GParamSpec * pspec);
363 static void gst_base_sink_get_property (GObject * object, guint prop_id,
364 GValue * value, GParamSpec * pspec);
366 static gboolean gst_base_sink_send_event (GstElement * element,
368 static gboolean default_element_query (GstElement * element, GstQuery * query);
370 static GstCaps *gst_base_sink_get_caps (GstBaseSink * sink, GstCaps * caps);
371 static gboolean gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps);
372 static void gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
373 GstClockTime * start, GstClockTime * end);
374 static gboolean gst_base_sink_set_flushing (GstBaseSink * basesink,
375 GstPad * pad, gboolean flushing);
376 static gboolean gst_base_sink_default_activate_pull (GstBaseSink * basesink,
378 static gboolean gst_base_sink_default_do_seek (GstBaseSink * sink,
379 GstSegment * segment);
380 static gboolean gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
381 GstEvent * event, GstSegment * segment);
383 static GstStateChangeReturn gst_base_sink_change_state (GstElement * element,
384 GstStateChange transition);
386 static gboolean gst_base_sink_sink_query (GstPad * pad, GstObject * parent,
388 static GstFlowReturn gst_base_sink_chain (GstPad * pad, GstObject * parent,
390 static GstFlowReturn gst_base_sink_chain_list (GstPad * pad, GstObject * parent,
391 GstBufferList * list);
393 static void gst_base_sink_loop (GstPad * pad);
394 static gboolean gst_base_sink_pad_activate (GstPad * pad, GstObject * parent);
395 static gboolean gst_base_sink_pad_activate_mode (GstPad * pad,
396 GstObject * parent, GstPadMode mode, gboolean active);
397 static gboolean gst_base_sink_event (GstPad * pad, GstObject * parent,
400 static gboolean default_sink_query (GstBaseSink * sink, GstQuery * query);
402 static gboolean gst_base_sink_negotiate_pull (GstBaseSink * basesink);
403 static void gst_base_sink_default_fixate (GstBaseSink * bsink, GstCaps * caps);
404 static void gst_base_sink_fixate (GstBaseSink * bsink, GstCaps * caps);
406 /* check if an object was too late */
407 static gboolean gst_base_sink_is_too_late (GstBaseSink * basesink,
408 GstMiniObject * obj, GstClockTime rstart, GstClockTime rstop,
409 GstClockReturn status, GstClockTimeDiff jitter);
410 static GstFlowReturn gst_base_sink_preroll_object (GstBaseSink * basesink,
411 guint8 obj_type, GstMiniObject * obj);
414 gst_base_sink_class_init (GstBaseSinkClass * klass)
416 GObjectClass *gobject_class;
417 GstElementClass *gstelement_class;
419 gobject_class = G_OBJECT_CLASS (klass);
420 gstelement_class = GST_ELEMENT_CLASS (klass);
422 GST_DEBUG_CATEGORY_INIT (gst_base_sink_debug, "basesink", 0,
425 g_type_class_add_private (klass, sizeof (GstBaseSinkPrivate));
427 parent_class = g_type_class_peek_parent (klass);
429 gobject_class->finalize = gst_base_sink_finalize;
430 gobject_class->set_property = gst_base_sink_set_property;
431 gobject_class->get_property = gst_base_sink_get_property;
433 g_object_class_install_property (gobject_class, PROP_SYNC,
434 g_param_spec_boolean ("sync", "Sync", "Sync on the clock", DEFAULT_SYNC,
435 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
437 g_object_class_install_property (gobject_class, PROP_MAX_LATENESS,
438 g_param_spec_int64 ("max-lateness", "Max Lateness",
439 "Maximum number of nanoseconds that a buffer can be late before it "
440 "is dropped (-1 unlimited)", -1, G_MAXINT64, DEFAULT_MAX_LATENESS,
441 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
443 g_object_class_install_property (gobject_class, PROP_QOS,
444 g_param_spec_boolean ("qos", "Qos",
445 "Generate Quality-of-Service events upstream", DEFAULT_QOS,
446 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
450 * If set to #TRUE, the basesink will perform asynchronous state changes.
451 * When set to #FALSE, the sink will not signal the parent when it prerolls.
452 * Use this option when dealing with sparse streams or when synchronisation is
457 g_object_class_install_property (gobject_class, PROP_ASYNC,
458 g_param_spec_boolean ("async", "Async",
459 "Go asynchronously to PAUSED", DEFAULT_ASYNC,
460 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
462 * GstBaseSink:ts-offset
464 * Controls the final synchronisation, a negative value will render the buffer
465 * earlier while a positive value delays playback. This property can be
466 * used to fix synchronisation in bad files.
470 g_object_class_install_property (gobject_class, PROP_TS_OFFSET,
471 g_param_spec_int64 ("ts-offset", "TS Offset",
472 "Timestamp offset in nanoseconds", G_MININT64, G_MAXINT64,
473 DEFAULT_TS_OFFSET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
476 * GstBaseSink:enable-last-buffer
478 * Enable the last-buffer property. If FALSE, basesink doesn't keep a
479 * reference to the last buffer arrived and the last-buffer property is always
480 * set to NULL. This can be useful if you need buffers to be released as soon
481 * as possible, eg. if you're using a buffer pool.
485 g_object_class_install_property (gobject_class, PROP_ENABLE_LAST_BUFFER,
486 g_param_spec_boolean ("enable-last-buffer", "Enable Last Buffer",
487 "Enable the last-buffer property", DEFAULT_ENABLE_LAST_BUFFER,
488 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
491 * GstBaseSink:last-buffer
493 * The last buffer that arrived in the sink and was used for preroll or for
494 * rendering. This property can be used to generate thumbnails. This property
495 * can be NULL when the sink has not yet received a bufer.
499 g_object_class_install_property (gobject_class, PROP_LAST_BUFFER,
500 g_param_spec_boxed ("last-buffer", "Last Buffer",
501 "The last buffer received in the sink", GST_TYPE_BUFFER,
502 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
504 * GstBaseSink:blocksize
506 * The amount of bytes to pull when operating in pull mode.
510 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
511 g_object_class_install_property (gobject_class, PROP_BLOCKSIZE,
512 g_param_spec_uint ("blocksize", "Block size",
513 "Size in bytes to pull per buffer (0 = default)", 0, G_MAXUINT,
514 DEFAULT_BLOCKSIZE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
516 * GstBaseSink:render-delay
518 * The additional delay between synchronisation and actual rendering of the
519 * media. This property will add additional latency to the device in order to
520 * make other sinks compensate for the delay.
524 g_object_class_install_property (gobject_class, PROP_RENDER_DELAY,
525 g_param_spec_uint64 ("render-delay", "Render Delay",
526 "Additional render delay of the sink in nanoseconds", 0, G_MAXUINT64,
527 DEFAULT_RENDER_DELAY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
529 * GstBaseSink:throttle-time
531 * The time to insert between buffers. This property can be used to control
532 * the maximum amount of buffers per second to render. Setting this property
533 * to a value bigger than 0 will make the sink create THROTTLE QoS events.
537 g_object_class_install_property (gobject_class, PROP_THROTTLE_TIME,
538 g_param_spec_uint64 ("throttle-time", "Throttle time",
539 "The time to keep between rendered buffers (unused)", 0, G_MAXUINT64,
540 DEFAULT_THROTTLE_TIME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
542 gstelement_class->change_state =
543 GST_DEBUG_FUNCPTR (gst_base_sink_change_state);
544 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_base_sink_send_event);
545 gstelement_class->query = GST_DEBUG_FUNCPTR (default_element_query);
547 klass->get_caps = GST_DEBUG_FUNCPTR (gst_base_sink_get_caps);
548 klass->set_caps = GST_DEBUG_FUNCPTR (gst_base_sink_set_caps);
549 klass->fixate = GST_DEBUG_FUNCPTR (gst_base_sink_default_fixate);
550 klass->activate_pull =
551 GST_DEBUG_FUNCPTR (gst_base_sink_default_activate_pull);
552 klass->get_times = GST_DEBUG_FUNCPTR (gst_base_sink_get_times);
553 klass->query = GST_DEBUG_FUNCPTR (default_sink_query);
555 /* Registering debug symbols for function pointers */
556 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_fixate);
557 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate);
558 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate_mode);
559 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_event);
560 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain);
561 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain_list);
562 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_sink_query);
566 gst_base_sink_query_caps (GstBaseSink * bsink, GstPad * pad, GstCaps * filter)
568 GstBaseSinkClass *bclass;
569 GstCaps *caps = NULL;
572 bclass = GST_BASE_SINK_GET_CLASS (bsink);
573 fixed = GST_PAD_IS_FIXED_CAPS (pad);
575 if (fixed || bsink->pad_mode == GST_PAD_MODE_PULL) {
576 /* if we are operating in pull mode or fixed caps, we only accept the
577 * currently negotiated caps */
578 caps = gst_pad_get_current_caps (pad);
581 if (bclass->get_caps)
582 caps = bclass->get_caps (bsink, filter);
585 GstPadTemplate *pad_template;
588 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass),
590 if (pad_template != NULL) {
591 caps = gst_pad_template_get_caps (pad_template);
594 GstCaps *intersection;
597 gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
598 gst_caps_unref (caps);
609 gst_base_sink_default_fixate (GstBaseSink * bsink, GstCaps * caps)
611 GST_DEBUG_OBJECT (bsink, "using default caps fixate function");
612 gst_caps_fixate (caps);
616 gst_base_sink_fixate (GstBaseSink * bsink, GstCaps * caps)
618 GstBaseSinkClass *bclass;
620 bclass = GST_BASE_SINK_GET_CLASS (bsink);
623 bclass->fixate (bsink, caps);
627 gst_base_sink_init (GstBaseSink * basesink, gpointer g_class)
629 GstPadTemplate *pad_template;
630 GstBaseSinkPrivate *priv;
632 basesink->priv = priv = GST_BASE_SINK_GET_PRIVATE (basesink);
635 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "sink");
636 g_return_if_fail (pad_template != NULL);
638 basesink->sinkpad = gst_pad_new_from_template (pad_template, "sink");
640 gst_pad_set_activate_function (basesink->sinkpad, gst_base_sink_pad_activate);
641 gst_pad_set_activatemode_function (basesink->sinkpad,
642 gst_base_sink_pad_activate_mode);
643 gst_pad_set_query_function (basesink->sinkpad, gst_base_sink_sink_query);
644 gst_pad_set_event_function (basesink->sinkpad, gst_base_sink_event);
645 gst_pad_set_chain_function (basesink->sinkpad, gst_base_sink_chain);
646 gst_pad_set_chain_list_function (basesink->sinkpad, gst_base_sink_chain_list);
647 gst_element_add_pad (GST_ELEMENT_CAST (basesink), basesink->sinkpad);
649 basesink->pad_mode = GST_PAD_MODE_NONE;
650 basesink->preroll_lock = g_mutex_new ();
651 basesink->preroll_cond = g_cond_new ();
652 priv->preroll_queue = g_queue_new ();
653 priv->have_latency = FALSE;
655 basesink->can_activate_push = DEFAULT_CAN_ACTIVATE_PUSH;
656 basesink->can_activate_pull = DEFAULT_CAN_ACTIVATE_PULL;
658 basesink->sync = DEFAULT_SYNC;
659 basesink->max_lateness = DEFAULT_MAX_LATENESS;
660 g_atomic_int_set (&priv->qos_enabled, DEFAULT_QOS);
661 priv->async_enabled = DEFAULT_ASYNC;
662 priv->ts_offset = DEFAULT_TS_OFFSET;
663 priv->render_delay = DEFAULT_RENDER_DELAY;
664 priv->blocksize = DEFAULT_BLOCKSIZE;
665 priv->cached_clock_id = NULL;
666 g_atomic_int_set (&priv->enable_last_buffer, DEFAULT_ENABLE_LAST_BUFFER);
667 priv->throttle_time = DEFAULT_THROTTLE_TIME;
669 GST_OBJECT_FLAG_SET (basesink, GST_ELEMENT_FLAG_SINK);
673 gst_base_sink_finalize (GObject * object)
675 GstBaseSink *basesink;
677 basesink = GST_BASE_SINK (object);
679 g_mutex_free (basesink->preroll_lock);
680 g_cond_free (basesink->preroll_cond);
681 g_queue_free (basesink->priv->preroll_queue);
683 G_OBJECT_CLASS (parent_class)->finalize (object);
687 * gst_base_sink_set_sync:
689 * @sync: the new sync value.
691 * Configures @sink to synchronize on the clock or not. When
692 * @sync is FALSE, incoming samples will be played as fast as
693 * possible. If @sync is TRUE, the timestamps of the incomming
694 * buffers will be used to schedule the exact render time of its
700 gst_base_sink_set_sync (GstBaseSink * sink, gboolean sync)
702 g_return_if_fail (GST_IS_BASE_SINK (sink));
704 GST_OBJECT_LOCK (sink);
706 GST_OBJECT_UNLOCK (sink);
710 * gst_base_sink_get_sync:
713 * Checks if @sink is currently configured to synchronize against the
716 * Returns: TRUE if the sink is configured to synchronize against the clock.
721 gst_base_sink_get_sync (GstBaseSink * sink)
725 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
727 GST_OBJECT_LOCK (sink);
729 GST_OBJECT_UNLOCK (sink);
735 * gst_base_sink_set_max_lateness:
737 * @max_lateness: the new max lateness value.
739 * Sets the new max lateness value to @max_lateness. This value is
740 * used to decide if a buffer should be dropped or not based on the
741 * buffer timestamp and the current clock time. A value of -1 means
747 gst_base_sink_set_max_lateness (GstBaseSink * sink, gint64 max_lateness)
749 g_return_if_fail (GST_IS_BASE_SINK (sink));
751 GST_OBJECT_LOCK (sink);
752 sink->max_lateness = max_lateness;
753 GST_OBJECT_UNLOCK (sink);
757 * gst_base_sink_get_max_lateness:
760 * Gets the max lateness value. See gst_base_sink_set_max_lateness for
763 * Returns: The maximum time in nanoseconds that a buffer can be late
764 * before it is dropped and not rendered. A value of -1 means an
770 gst_base_sink_get_max_lateness (GstBaseSink * sink)
774 g_return_val_if_fail (GST_IS_BASE_SINK (sink), -1);
776 GST_OBJECT_LOCK (sink);
777 res = sink->max_lateness;
778 GST_OBJECT_UNLOCK (sink);
784 * gst_base_sink_set_qos_enabled:
786 * @enabled: the new qos value.
788 * Configures @sink to send Quality-of-Service events upstream.
793 gst_base_sink_set_qos_enabled (GstBaseSink * sink, gboolean enabled)
795 g_return_if_fail (GST_IS_BASE_SINK (sink));
797 g_atomic_int_set (&sink->priv->qos_enabled, enabled);
801 * gst_base_sink_is_qos_enabled:
804 * Checks if @sink is currently configured to send Quality-of-Service events
807 * Returns: TRUE if the sink is configured to perform Quality-of-Service.
812 gst_base_sink_is_qos_enabled (GstBaseSink * sink)
816 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
818 res = g_atomic_int_get (&sink->priv->qos_enabled);
824 * gst_base_sink_set_async_enabled:
826 * @enabled: the new async value.
828 * Configures @sink to perform all state changes asynchronusly. When async is
829 * disabled, the sink will immediately go to PAUSED instead of waiting for a
830 * preroll buffer. This feature is useful if the sink does not synchronize
831 * against the clock or when it is dealing with sparse streams.
836 gst_base_sink_set_async_enabled (GstBaseSink * sink, gboolean enabled)
838 g_return_if_fail (GST_IS_BASE_SINK (sink));
840 GST_BASE_SINK_PREROLL_LOCK (sink);
841 g_atomic_int_set (&sink->priv->async_enabled, enabled);
842 GST_LOG_OBJECT (sink, "set async enabled to %d", enabled);
843 GST_BASE_SINK_PREROLL_UNLOCK (sink);
847 * gst_base_sink_is_async_enabled:
850 * Checks if @sink is currently configured to perform asynchronous state
853 * Returns: TRUE if the sink is configured to perform asynchronous state
859 gst_base_sink_is_async_enabled (GstBaseSink * sink)
863 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
865 res = g_atomic_int_get (&sink->priv->async_enabled);
871 * gst_base_sink_set_ts_offset:
873 * @offset: the new offset
875 * Adjust the synchronisation of @sink with @offset. A negative value will
876 * render buffers earlier than their timestamp. A positive value will delay
877 * rendering. This function can be used to fix playback of badly timestamped
883 gst_base_sink_set_ts_offset (GstBaseSink * sink, GstClockTimeDiff offset)
885 g_return_if_fail (GST_IS_BASE_SINK (sink));
887 GST_OBJECT_LOCK (sink);
888 sink->priv->ts_offset = offset;
889 GST_LOG_OBJECT (sink, "set time offset to %" G_GINT64_FORMAT, offset);
890 GST_OBJECT_UNLOCK (sink);
894 * gst_base_sink_get_ts_offset:
897 * Get the synchronisation offset of @sink.
899 * Returns: The synchronisation offset.
904 gst_base_sink_get_ts_offset (GstBaseSink * sink)
906 GstClockTimeDiff res;
908 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
910 GST_OBJECT_LOCK (sink);
911 res = sink->priv->ts_offset;
912 GST_OBJECT_UNLOCK (sink);
918 * gst_base_sink_get_last_buffer:
921 * Get the last buffer that arrived in the sink and was used for preroll or for
922 * rendering. This property can be used to generate thumbnails.
924 * The #GstCaps on the buffer can be used to determine the type of the buffer.
926 * Free-function: gst_buffer_unref
928 * Returns: (transfer full): a #GstBuffer. gst_buffer_unref() after usage.
929 * This function returns NULL when no buffer has arrived in the sink yet
930 * or when the sink is not in PAUSED or PLAYING.
935 gst_base_sink_get_last_buffer (GstBaseSink * sink)
939 g_return_val_if_fail (GST_IS_BASE_SINK (sink), NULL);
941 GST_OBJECT_LOCK (sink);
942 if ((res = sink->priv->last_buffer))
943 gst_buffer_ref (res);
944 GST_OBJECT_UNLOCK (sink);
949 /* with OBJECT_LOCK */
951 gst_base_sink_set_last_buffer_unlocked (GstBaseSink * sink, GstBuffer * buffer)
955 old = sink->priv->last_buffer;
956 if (G_LIKELY (old != buffer)) {
957 GST_DEBUG_OBJECT (sink, "setting last buffer to %p", buffer);
958 if (G_LIKELY (buffer))
959 gst_buffer_ref (buffer);
960 sink->priv->last_buffer = buffer;
964 /* avoid unreffing with the lock because cleanup code might want to take the
966 if (G_LIKELY (old)) {
967 GST_OBJECT_UNLOCK (sink);
968 gst_buffer_unref (old);
969 GST_OBJECT_LOCK (sink);
974 gst_base_sink_set_last_buffer (GstBaseSink * sink, GstBuffer * buffer)
976 if (!g_atomic_int_get (&sink->priv->enable_last_buffer))
979 GST_OBJECT_LOCK (sink);
980 gst_base_sink_set_last_buffer_unlocked (sink, buffer);
981 GST_OBJECT_UNLOCK (sink);
985 * gst_base_sink_set_last_buffer_enabled:
987 * @enabled: the new enable-last-buffer value.
989 * Configures @sink to store the last received buffer in the last-buffer
995 gst_base_sink_set_last_buffer_enabled (GstBaseSink * sink, gboolean enabled)
997 g_return_if_fail (GST_IS_BASE_SINK (sink));
999 /* Only take lock if we change the value */
1000 if (g_atomic_int_compare_and_exchange (&sink->priv->enable_last_buffer,
1001 !enabled, enabled) && !enabled) {
1002 GST_OBJECT_LOCK (sink);
1003 gst_base_sink_set_last_buffer_unlocked (sink, NULL);
1004 GST_OBJECT_UNLOCK (sink);
1009 * gst_base_sink_is_last_buffer_enabled:
1012 * Checks if @sink is currently configured to store the last received buffer in
1013 * the last-buffer property.
1015 * Returns: TRUE if the sink is configured to store the last received buffer.
1020 gst_base_sink_is_last_buffer_enabled (GstBaseSink * sink)
1022 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
1024 return g_atomic_int_get (&sink->priv->enable_last_buffer);
1028 * gst_base_sink_get_latency:
1031 * Get the currently configured latency.
1033 * Returns: The configured latency.
1038 gst_base_sink_get_latency (GstBaseSink * sink)
1042 GST_OBJECT_LOCK (sink);
1043 res = sink->priv->latency;
1044 GST_OBJECT_UNLOCK (sink);
1050 * gst_base_sink_query_latency:
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
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
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.
1066 * This function is mostly used by subclasses.
1068 * Returns: TRUE if the query succeeded.
1073 gst_base_sink_query_latency (GstBaseSink * sink, gboolean * live,
1074 gboolean * upstream_live, GstClockTime * min_latency,
1075 GstClockTime * max_latency)
1077 gboolean l, us_live, res, have_latency;
1078 GstClockTime min, max, render_delay;
1080 GstClockTime us_min, us_max;
1082 /* we are live when we sync to the clock */
1083 GST_OBJECT_LOCK (sink);
1085 have_latency = sink->priv->have_latency;
1086 render_delay = sink->priv->render_delay;
1087 GST_OBJECT_UNLOCK (sink);
1089 /* assume no 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
1098 query = gst_query_new_latency ();
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);
1106 /* upstream live, use its latency, subclasses should use these
1107 * values to create the complete latency. */
1112 /* we need to add the render delay if we are live */
1114 min += render_delay;
1116 max += render_delay;
1119 gst_query_unref (query);
1121 GST_DEBUG_OBJECT (sink, "we are not yet ready for LATENCY query");
1125 /* not live, we tried to do the query, if it failed we return TRUE anyway */
1129 GST_DEBUG_OBJECT (sink, "latency query failed but we are not live");
1131 GST_DEBUG_OBJECT (sink, "latency query failed and we are live");
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));
1143 *upstream_live = us_live;
1153 * gst_base_sink_set_render_delay:
1154 * @sink: a #GstBaseSink
1155 * @delay: the new delay
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
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.
1165 * This function is usually called by subclasses.
1170 gst_base_sink_set_render_delay (GstBaseSink * sink, GstClockTime delay)
1172 GstClockTime old_render_delay;
1174 g_return_if_fail (GST_IS_BASE_SINK (sink));
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);
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)));
1191 * gst_base_sink_get_render_delay:
1192 * @sink: a #GstBaseSink
1194 * Get the render delay of @sink. see gst_base_sink_set_render_delay() for more
1195 * information about the render delay.
1197 * Returns: the render delay of @sink.
1202 gst_base_sink_get_render_delay (GstBaseSink * sink)
1204 GstClockTimeDiff res;
1206 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1208 GST_OBJECT_LOCK (sink);
1209 res = sink->priv->render_delay;
1210 GST_OBJECT_UNLOCK (sink);
1216 * gst_base_sink_set_blocksize:
1217 * @sink: a #GstBaseSink
1218 * @blocksize: the blocksize in bytes
1220 * Set the number of bytes that the sink will pull when it is operating in pull
1225 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
1227 gst_base_sink_set_blocksize (GstBaseSink * sink, guint blocksize)
1229 g_return_if_fail (GST_IS_BASE_SINK (sink));
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);
1238 * gst_base_sink_get_blocksize:
1239 * @sink: a #GstBaseSink
1241 * Get the number of bytes that the sink will pull when it is operating in pull
1244 * Returns: the number of bytes @sink will pull in pull mode.
1248 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
1250 gst_base_sink_get_blocksize (GstBaseSink * sink)
1254 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1256 GST_OBJECT_LOCK (sink);
1257 res = sink->priv->blocksize;
1258 GST_OBJECT_UNLOCK (sink);
1264 * gst_base_sink_set_throttle_time:
1265 * @sink: a #GstBaseSink
1266 * @throttle: the throttle time in nanoseconds
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
1275 gst_base_sink_set_throttle_time (GstBaseSink * sink, guint64 throttle)
1277 g_return_if_fail (GST_IS_BASE_SINK (sink));
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);
1286 * gst_base_sink_get_throttle_time:
1287 * @sink: a #GstBaseSink
1289 * Get the time that will be inserted between frames to control the
1290 * maximum buffers per second.
1292 * Returns: the number of nanoseconds @sink will put between frames.
1297 gst_base_sink_get_throttle_time (GstBaseSink * sink)
1301 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1303 GST_OBJECT_LOCK (sink);
1304 res = sink->priv->throttle_time;
1305 GST_OBJECT_UNLOCK (sink);
1311 gst_base_sink_set_property (GObject * object, guint prop_id,
1312 const GValue * value, GParamSpec * pspec)
1314 GstBaseSink *sink = GST_BASE_SINK (object);
1318 gst_base_sink_set_sync (sink, g_value_get_boolean (value));
1320 case PROP_MAX_LATENESS:
1321 gst_base_sink_set_max_lateness (sink, g_value_get_int64 (value));
1324 gst_base_sink_set_qos_enabled (sink, g_value_get_boolean (value));
1327 gst_base_sink_set_async_enabled (sink, g_value_get_boolean (value));
1329 case PROP_TS_OFFSET:
1330 gst_base_sink_set_ts_offset (sink, g_value_get_int64 (value));
1332 case PROP_BLOCKSIZE:
1333 gst_base_sink_set_blocksize (sink, g_value_get_uint (value));
1335 case PROP_RENDER_DELAY:
1336 gst_base_sink_set_render_delay (sink, g_value_get_uint64 (value));
1338 case PROP_ENABLE_LAST_BUFFER:
1339 gst_base_sink_set_last_buffer_enabled (sink, g_value_get_boolean (value));
1341 case PROP_THROTTLE_TIME:
1342 gst_base_sink_set_throttle_time (sink, g_value_get_uint64 (value));
1345 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1351 gst_base_sink_get_property (GObject * object, guint prop_id, GValue * value,
1354 GstBaseSink *sink = GST_BASE_SINK (object);
1358 g_value_set_boolean (value, gst_base_sink_get_sync (sink));
1360 case PROP_MAX_LATENESS:
1361 g_value_set_int64 (value, gst_base_sink_get_max_lateness (sink));
1364 g_value_set_boolean (value, gst_base_sink_is_qos_enabled (sink));
1367 g_value_set_boolean (value, gst_base_sink_is_async_enabled (sink));
1369 case PROP_TS_OFFSET:
1370 g_value_set_int64 (value, gst_base_sink_get_ts_offset (sink));
1372 case PROP_LAST_BUFFER:
1373 gst_value_take_buffer (value, gst_base_sink_get_last_buffer (sink));
1375 case PROP_ENABLE_LAST_BUFFER:
1376 g_value_set_boolean (value, gst_base_sink_is_last_buffer_enabled (sink));
1378 case PROP_BLOCKSIZE:
1379 g_value_set_uint (value, gst_base_sink_get_blocksize (sink));
1381 case PROP_RENDER_DELAY:
1382 g_value_set_uint64 (value, gst_base_sink_get_render_delay (sink));
1384 case PROP_THROTTLE_TIME:
1385 g_value_set_uint64 (value, gst_base_sink_get_throttle_time (sink));
1388 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1395 gst_base_sink_get_caps (GstBaseSink * sink, GstCaps * filter)
1401 gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps)
1406 /* with PREROLL_LOCK, STREAM_LOCK */
1408 gst_base_sink_preroll_queue_flush (GstBaseSink * basesink, GstPad * pad)
1412 GST_DEBUG_OBJECT (basesink, "flushing queue %p", basesink);
1413 while ((obj = g_queue_pop_head (basesink->priv->preroll_queue))) {
1414 GST_DEBUG_OBJECT (basesink, "popped %p", obj);
1415 gst_mini_object_unref (obj);
1417 /* we can't have EOS anymore now */
1418 basesink->eos = FALSE;
1419 basesink->priv->received_eos = FALSE;
1420 basesink->have_preroll = FALSE;
1421 basesink->priv->step_unlock = FALSE;
1422 basesink->eos_queued = FALSE;
1423 basesink->priv->preroll_queued = 0;
1424 /* can't report latency anymore until we preroll again */
1425 if (basesink->priv->async_enabled) {
1426 GST_OBJECT_LOCK (basesink);
1427 basesink->priv->have_latency = FALSE;
1428 GST_OBJECT_UNLOCK (basesink);
1430 /* and signal any waiters now */
1431 GST_BASE_SINK_PREROLL_SIGNAL (basesink);
1434 /* with STREAM_LOCK, configures given segment with the event information. */
1436 gst_base_sink_configure_segment (GstBaseSink * basesink, GstPad * pad,
1437 GstEvent * event, GstSegment * segment)
1439 /* The segment is protected with both the STREAM_LOCK and the OBJECT_LOCK.
1440 * We protect with the OBJECT_LOCK so that we can use the values to
1441 * safely answer a POSITION query. */
1442 GST_OBJECT_LOCK (basesink);
1443 /* the newsegment event is needed to bring the buffer timestamps to the
1444 * stream time and to drop samples outside of the playback segment. */
1445 gst_event_copy_segment (event, segment);
1446 GST_DEBUG_OBJECT (basesink, "configured SEGMENT %" GST_SEGMENT_FORMAT,
1448 GST_OBJECT_UNLOCK (basesink);
1451 /* with PREROLL_LOCK, STREAM_LOCK */
1453 gst_base_sink_commit_state (GstBaseSink * basesink)
1455 /* commit state and proceed to next pending state */
1456 GstState current, next, pending, post_pending;
1457 gboolean post_paused = FALSE;
1458 gboolean post_async_done = FALSE;
1459 gboolean post_playing = FALSE;
1460 gboolean reset_time;
1462 /* we are certainly not playing async anymore now */
1463 basesink->playing_async = FALSE;
1465 GST_OBJECT_LOCK (basesink);
1466 current = GST_STATE (basesink);
1467 next = GST_STATE_NEXT (basesink);
1468 pending = GST_STATE_PENDING (basesink);
1469 post_pending = pending;
1470 reset_time = basesink->priv->reset_time;
1471 basesink->priv->reset_time = FALSE;
1474 case GST_STATE_PLAYING:
1476 GST_DEBUG_OBJECT (basesink, "commiting state to PLAYING");
1478 basesink->need_preroll = FALSE;
1479 post_async_done = TRUE;
1480 basesink->priv->commited = TRUE;
1481 post_playing = TRUE;
1482 /* post PAUSED too when we were READY */
1483 if (current == GST_STATE_READY) {
1488 case GST_STATE_PAUSED:
1489 GST_DEBUG_OBJECT (basesink, "commiting state to PAUSED");
1491 post_async_done = TRUE;
1492 basesink->priv->commited = TRUE;
1493 post_pending = GST_STATE_VOID_PENDING;
1495 case GST_STATE_READY:
1496 case GST_STATE_NULL:
1498 case GST_STATE_VOID_PENDING:
1499 goto nothing_pending;
1504 /* we can report latency queries now */
1505 basesink->priv->have_latency = TRUE;
1507 GST_STATE (basesink) = pending;
1508 GST_STATE_NEXT (basesink) = GST_STATE_VOID_PENDING;
1509 GST_STATE_PENDING (basesink) = GST_STATE_VOID_PENDING;
1510 GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_SUCCESS;
1511 GST_OBJECT_UNLOCK (basesink);
1514 GST_DEBUG_OBJECT (basesink, "posting PAUSED state change message");
1515 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1516 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1517 current, next, post_pending));
1519 if (post_async_done) {
1520 GST_DEBUG_OBJECT (basesink, "posting async-done message");
1521 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1522 gst_message_new_async_done (GST_OBJECT_CAST (basesink), reset_time));
1525 GST_DEBUG_OBJECT (basesink, "posting PLAYING state change message");
1526 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1527 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1528 next, pending, GST_STATE_VOID_PENDING));
1531 GST_STATE_BROADCAST (basesink);
1537 /* Depending on the state, set our vars. We get in this situation when the
1538 * state change function got a change to update the state vars before the
1539 * streaming thread did. This is fine but we need to make sure that we
1540 * update the need_preroll var since it was TRUE when we got here and might
1541 * become FALSE if we got to PLAYING. */
1542 GST_DEBUG_OBJECT (basesink, "nothing to commit, now in %s",
1543 gst_element_state_get_name (current));
1545 case GST_STATE_PLAYING:
1546 basesink->need_preroll = FALSE;
1548 case GST_STATE_PAUSED:
1549 basesink->need_preroll = TRUE;
1552 basesink->need_preroll = FALSE;
1553 basesink->flushing = TRUE;
1556 /* we can report latency queries now */
1557 basesink->priv->have_latency = TRUE;
1558 GST_OBJECT_UNLOCK (basesink);
1563 /* app is going to READY */
1564 GST_DEBUG_OBJECT (basesink, "stopping");
1565 basesink->need_preroll = FALSE;
1566 basesink->flushing = TRUE;
1567 GST_OBJECT_UNLOCK (basesink);
1573 start_stepping (GstBaseSink * sink, GstSegment * segment,
1574 GstStepInfo * pending, GstStepInfo * current)
1577 GstMessage *message;
1579 GST_DEBUG_OBJECT (sink, "update pending step");
1581 GST_OBJECT_LOCK (sink);
1582 memcpy (current, pending, sizeof (GstStepInfo));
1583 pending->valid = FALSE;
1584 GST_OBJECT_UNLOCK (sink);
1586 /* post message first */
1588 gst_message_new_step_start (GST_OBJECT (sink), TRUE, current->format,
1589 current->amount, current->rate, current->flush, current->intermediate);
1590 gst_message_set_seqnum (message, current->seqnum);
1591 gst_element_post_message (GST_ELEMENT (sink), message);
1593 /* get the running time of where we paused and remember it */
1594 current->start = gst_element_get_start_time (GST_ELEMENT_CAST (sink));
1595 gst_segment_set_running_time (segment, GST_FORMAT_TIME, current->start);
1597 /* set the new rate for the remainder of the segment */
1598 current->start_rate = segment->rate;
1599 segment->rate *= current->rate;
1602 if (segment->rate > 0.0)
1603 current->start_stop = segment->stop;
1605 current->start_start = segment->start;
1607 if (current->format == GST_FORMAT_TIME) {
1608 end = current->start + current->amount;
1609 if (!current->flush) {
1610 /* update the segment clipping regions for non-flushing seeks */
1611 if (segment->rate > 0.0) {
1612 segment->stop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1613 segment->position = segment->stop;
1617 position = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1618 segment->time = position;
1619 segment->start = position;
1620 segment->position = position;
1625 GST_DEBUG_OBJECT (sink, "segment now %" GST_SEGMENT_FORMAT, segment);
1626 GST_DEBUG_OBJECT (sink, "step started at running_time %" GST_TIME_FORMAT,
1627 GST_TIME_ARGS (current->start));
1629 if (current->amount == -1) {
1630 GST_DEBUG_OBJECT (sink, "step amount == -1, stop stepping");
1631 current->valid = FALSE;
1633 GST_DEBUG_OBJECT (sink, "step amount: %" G_GUINT64_FORMAT ", format: %s, "
1634 "rate: %f", current->amount, gst_format_get_name (current->format),
1640 stop_stepping (GstBaseSink * sink, GstSegment * segment,
1641 GstStepInfo * current, gint64 rstart, gint64 rstop, gboolean eos)
1643 gint64 stop, position;
1644 GstMessage *message;
1646 GST_DEBUG_OBJECT (sink, "step complete");
1648 if (segment->rate > 0.0)
1653 GST_DEBUG_OBJECT (sink,
1654 "step stop at running_time %" GST_TIME_FORMAT, GST_TIME_ARGS (stop));
1657 current->duration = current->position;
1659 current->duration = stop - current->start;
1661 GST_DEBUG_OBJECT (sink, "step elapsed running_time %" GST_TIME_FORMAT,
1662 GST_TIME_ARGS (current->duration));
1664 position = current->start + current->duration;
1666 /* now move the segment to the new running time */
1667 gst_segment_set_running_time (segment, GST_FORMAT_TIME, position);
1669 if (current->flush) {
1670 /* and remove the time we flushed, start time did not change */
1671 segment->base = current->start;
1673 /* start time is now the stepped position */
1674 gst_element_set_start_time (GST_ELEMENT_CAST (sink), position);
1677 /* restore the previous rate */
1678 segment->rate = current->start_rate;
1680 if (segment->rate > 0.0)
1681 segment->stop = current->start_stop;
1683 segment->start = current->start_start;
1685 /* the clip segment is used for position report in paused... */
1686 gst_segment_copy_into (segment, &sink->clip_segment);
1688 /* post the step done when we know the stepped duration in TIME */
1690 gst_message_new_step_done (GST_OBJECT_CAST (sink), current->format,
1691 current->amount, current->rate, current->flush, current->intermediate,
1692 current->duration, eos);
1693 gst_message_set_seqnum (message, current->seqnum);
1694 gst_element_post_message (GST_ELEMENT_CAST (sink), message);
1696 if (!current->intermediate)
1697 sink->need_preroll = current->need_preroll;
1699 /* and the current step info finished and becomes invalid */
1700 current->valid = FALSE;
1704 handle_stepping (GstBaseSink * sink, GstSegment * segment,
1705 GstStepInfo * current, guint64 * cstart, guint64 * cstop, guint64 * rstart,
1708 gboolean step_end = FALSE;
1710 /* see if we need to skip this buffer because of stepping */
1711 switch (current->format) {
1712 case GST_FORMAT_TIME:
1715 guint64 first, last;
1718 if (segment->rate > 0.0) {
1719 if (segment->stop == *cstop)
1720 *rstop = *rstart + current->amount;
1725 if (segment->start == *cstart)
1726 *rstart = *rstop + current->amount;
1732 end = current->start + current->amount;
1733 current->position = first - current->start;
1735 abs_rate = ABS (segment->rate);
1736 if (G_UNLIKELY (abs_rate != 1.0))
1737 current->position /= abs_rate;
1739 GST_DEBUG_OBJECT (sink,
1740 "buffer: %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT,
1741 GST_TIME_ARGS (first), GST_TIME_ARGS (last));
1742 GST_DEBUG_OBJECT (sink,
1743 "got time step %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT "/%"
1744 GST_TIME_FORMAT, GST_TIME_ARGS (current->position),
1745 GST_TIME_ARGS (last - current->start),
1746 GST_TIME_ARGS (current->amount));
1748 if ((current->flush && current->position >= current->amount)
1750 GST_DEBUG_OBJECT (sink, "step ended, we need clipping");
1752 if (segment->rate > 0.0) {
1754 *cstart = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1757 *cstop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1760 GST_DEBUG_OBJECT (sink,
1761 "cstart %" GST_TIME_FORMAT ", rstart %" GST_TIME_FORMAT,
1762 GST_TIME_ARGS (*cstart), GST_TIME_ARGS (*rstart));
1763 GST_DEBUG_OBJECT (sink,
1764 "cstop %" GST_TIME_FORMAT ", rstop %" GST_TIME_FORMAT,
1765 GST_TIME_ARGS (*cstop), GST_TIME_ARGS (*rstop));
1768 case GST_FORMAT_BUFFERS:
1769 GST_DEBUG_OBJECT (sink,
1770 "got default step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1771 current->position, current->amount);
1773 if (current->position < current->amount) {
1774 current->position++;
1779 case GST_FORMAT_DEFAULT:
1781 GST_DEBUG_OBJECT (sink,
1782 "got unknown step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1783 current->position, current->amount);
1789 /* with STREAM_LOCK, PREROLL_LOCK
1791 * Returns TRUE if the object needs synchronisation and takes therefore
1792 * part in prerolling.
1794 * rsstart/rsstop contain the start/stop in stream time.
1795 * rrstart/rrstop contain the start/stop in running time.
1798 gst_base_sink_get_sync_times (GstBaseSink * basesink, GstMiniObject * obj,
1799 GstClockTime * rsstart, GstClockTime * rsstop,
1800 GstClockTime * rrstart, GstClockTime * rrstop, gboolean * do_sync,
1801 gboolean * stepped, GstSegment * segment, GstStepInfo * step,
1802 gboolean * step_end, guint8 obj_type)
1804 GstBaseSinkClass *bclass;
1806 GstClockTime start, stop; /* raw start/stop timestamps */
1807 guint64 cstart, cstop; /* clipped raw timestamps */
1808 guint64 rstart, rstop; /* clipped timestamps converted to running time */
1809 GstClockTime sstart, sstop; /* clipped timestamps converted to stream time */
1811 GstBaseSinkPrivate *priv;
1814 priv = basesink->priv;
1816 /* start with nothing */
1817 start = stop = GST_CLOCK_TIME_NONE;
1819 if (G_UNLIKELY (OBJ_IS_EVENT (obj_type))) {
1820 GstEvent *event = GST_EVENT_CAST (obj);
1822 switch (GST_EVENT_TYPE (event)) {
1823 /* EOS event needs syncing */
1826 if (basesink->segment.rate >= 0.0) {
1827 sstart = sstop = priv->current_sstop;
1828 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1829 /* we have not seen a buffer yet, use the segment values */
1830 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1831 basesink->segment.format, basesink->segment.stop);
1834 sstart = sstop = priv->current_sstart;
1835 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1836 /* we have not seen a buffer yet, use the segment values */
1837 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1838 basesink->segment.format, basesink->segment.start);
1842 rstart = rstop = priv->eos_rtime;
1843 *do_sync = rstart != -1;
1844 GST_DEBUG_OBJECT (basesink, "sync times for EOS %" GST_TIME_FORMAT,
1845 GST_TIME_ARGS (rstart));
1846 /* if we are stepping, we end now */
1847 *step_end = step->valid;
1852 /* other events do not need syncing */
1860 /* else do buffer sync code */
1861 buffer = GST_BUFFER_CAST (obj);
1863 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1865 /* just get the times to see if we need syncing, if the start returns -1 we
1867 if (bclass->get_times)
1868 bclass->get_times (basesink, buffer, &start, &stop);
1870 if (!GST_CLOCK_TIME_IS_VALID (start)) {
1871 /* we don't need to sync but we still want to get the timestamps for
1872 * tracking the position */
1873 gst_base_sink_get_times (basesink, buffer, &start, &stop);
1879 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
1880 ", stop: %" GST_TIME_FORMAT ", do_sync %d", GST_TIME_ARGS (start),
1881 GST_TIME_ARGS (stop), *do_sync);
1883 /* collect segment and format for code clarity */
1884 format = segment->format;
1887 if (G_UNLIKELY (!gst_segment_clip (segment, format,
1888 start, stop, &cstart, &cstop))) {
1890 GST_DEBUG_OBJECT (basesink, "step out of segment");
1891 /* when we are stepping, pretend we're at the end of the segment */
1892 if (segment->rate > 0.0) {
1893 cstart = segment->stop;
1894 cstop = segment->stop;
1896 cstart = segment->start;
1897 cstop = segment->start;
1901 goto out_of_segment;
1904 if (G_UNLIKELY (start != cstart || stop != cstop)) {
1905 GST_DEBUG_OBJECT (basesink, "clipped to: start %" GST_TIME_FORMAT
1906 ", stop: %" GST_TIME_FORMAT, GST_TIME_ARGS (cstart),
1907 GST_TIME_ARGS (cstop));
1910 /* set last stop position */
1911 if (G_LIKELY (stop != GST_CLOCK_TIME_NONE && cstop != GST_CLOCK_TIME_NONE))
1912 segment->position = cstop;
1914 segment->position = cstart;
1917 rstart = gst_segment_to_running_time (segment, format, cstart);
1918 rstop = gst_segment_to_running_time (segment, format, cstop);
1920 if (G_UNLIKELY (step->valid)) {
1921 if (!(*step_end = handle_stepping (basesink, segment, step, &cstart, &cstop,
1922 &rstart, &rstop))) {
1923 /* step is still busy, we discard data when we are flushing */
1924 *stepped = step->flush;
1925 GST_DEBUG_OBJECT (basesink, "stepping busy");
1928 /* this can produce wrong values if we accumulated non-TIME segments. If this happens,
1929 * upstream is behaving very badly */
1930 sstart = gst_segment_to_stream_time (segment, format, cstart);
1931 sstop = gst_segment_to_stream_time (segment, format, cstop);
1934 /* eos_done label only called when doing EOS, we also stop stepping then */
1935 if (*step_end && step->flush) {
1936 GST_DEBUG_OBJECT (basesink, "flushing step ended");
1937 stop_stepping (basesink, segment, step, rstart, rstop, eos);
1939 /* re-determine running start times for adjusted segment
1940 * (which has a flushed amount of running/accumulated time removed) */
1941 if (!GST_IS_EVENT (obj)) {
1942 GST_DEBUG_OBJECT (basesink, "refresh sync times");
1953 /* buffers and EOS always need syncing and preroll */
1959 /* we usually clip in the chain function already but stepping could cause
1960 * the segment to be updated later. we return FALSE so that we don't try
1962 GST_LOG_OBJECT (basesink, "buffer skipped, not in segment");
1967 /* with STREAM_LOCK, PREROLL_LOCK, LOCK
1968 * adjust a timestamp with the latency and timestamp offset. This function does
1969 * not adjust for the render delay. */
1971 gst_base_sink_adjust_time (GstBaseSink * basesink, GstClockTime time)
1973 GstClockTimeDiff ts_offset;
1975 /* don't do anything funny with invalid timestamps */
1976 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
1979 time += basesink->priv->latency;
1981 /* apply offset, be carefull for underflows */
1982 ts_offset = basesink->priv->ts_offset;
1983 if (ts_offset < 0) {
1984 ts_offset = -ts_offset;
1985 if (ts_offset < time)
1992 /* subtract the render delay again, which was included in the latency */
1993 if (time > basesink->priv->render_delay)
1994 time -= basesink->priv->render_delay;
2002 * gst_base_sink_wait_clock:
2004 * @time: the running_time to be reached
2005 * @jitter: (out) (allow-none): the jitter to be filled with time diff, or NULL
2007 * This function will block until @time is reached. It is usually called by
2008 * subclasses that use their own internal synchronisation.
2010 * If @time is not valid, no sycnhronisation is done and #GST_CLOCK_BADTIME is
2011 * returned. Likewise, if synchronisation is disabled in the element or there
2012 * is no clock, no synchronisation is done and #GST_CLOCK_BADTIME is returned.
2014 * This function should only be called with the PREROLL_LOCK held, like when
2015 * receiving an EOS event in the #GstBaseSinkClass.event() vmethod or when
2016 * receiving a buffer in
2017 * the #GstBaseSinkClass.render() vmethod.
2019 * The @time argument should be the running_time of when this method should
2020 * return and is not adjusted with any latency or offset configured in the
2025 * Returns: #GstClockReturn
2028 gst_base_sink_wait_clock (GstBaseSink * sink, GstClockTime time,
2029 GstClockTimeDiff * jitter)
2033 GstClockTime base_time;
2035 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
2038 GST_OBJECT_LOCK (sink);
2039 if (G_UNLIKELY (!sink->sync))
2042 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (sink)) == NULL))
2045 base_time = GST_ELEMENT_CAST (sink)->base_time;
2046 GST_LOG_OBJECT (sink,
2047 "time %" GST_TIME_FORMAT ", base_time %" GST_TIME_FORMAT,
2048 GST_TIME_ARGS (time), GST_TIME_ARGS (base_time));
2050 /* add base_time to running_time to get the time against the clock */
2053 /* Re-use existing clockid if available */
2054 /* FIXME: Casting to GstClockEntry only works because the types
2056 if (G_LIKELY (sink->priv->cached_clock_id != NULL
2057 && GST_CLOCK_ENTRY_CLOCK ((GstClockEntry *) sink->priv->
2058 cached_clock_id) == clock)) {
2059 if (!gst_clock_single_shot_id_reinit (clock, sink->priv->cached_clock_id,
2061 gst_clock_id_unref (sink->priv->cached_clock_id);
2062 sink->priv->cached_clock_id = gst_clock_new_single_shot_id (clock, time);
2065 if (sink->priv->cached_clock_id != NULL)
2066 gst_clock_id_unref (sink->priv->cached_clock_id);
2067 sink->priv->cached_clock_id = gst_clock_new_single_shot_id (clock, time);
2069 GST_OBJECT_UNLOCK (sink);
2071 /* A blocking wait is performed on the clock. We save the ClockID
2072 * so we can unlock the entry at any time. While we are blocking, we
2073 * release the PREROLL_LOCK so that other threads can interrupt the
2075 sink->clock_id = sink->priv->cached_clock_id;
2076 /* release the preroll lock while waiting */
2077 GST_BASE_SINK_PREROLL_UNLOCK (sink);
2079 ret = gst_clock_id_wait (sink->priv->cached_clock_id, jitter);
2081 GST_BASE_SINK_PREROLL_LOCK (sink);
2082 sink->clock_id = NULL;
2086 /* no syncing needed */
2089 GST_DEBUG_OBJECT (sink, "time not valid, no sync needed");
2090 return GST_CLOCK_BADTIME;
2094 GST_DEBUG_OBJECT (sink, "sync disabled");
2095 GST_OBJECT_UNLOCK (sink);
2096 return GST_CLOCK_BADTIME;
2100 GST_DEBUG_OBJECT (sink, "no clock, can't sync");
2101 GST_OBJECT_UNLOCK (sink);
2102 return GST_CLOCK_BADTIME;
2107 * gst_base_sink_wait_preroll:
2110 * If the #GstBaseSinkClass.render() method performs its own synchronisation
2111 * against the clock it must unblock when going from PLAYING to the PAUSED state
2112 * and call this method before continuing to render the remaining data.
2114 * This function will block until a state change to PLAYING happens (in which
2115 * case this function returns #GST_FLOW_OK) or the processing must be stopped due
2116 * to a state change to READY or a FLUSH event (in which case this function
2117 * returns #GST_FLOW_WRONG_STATE).
2119 * This function should only be called with the PREROLL_LOCK held, like in the
2122 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2123 * continue. Any other return value should be returned from the render vmethod.
2128 gst_base_sink_wait_preroll (GstBaseSink * sink)
2130 sink->have_preroll = TRUE;
2131 GST_DEBUG_OBJECT (sink, "waiting in preroll for flush or PLAYING");
2132 /* block until the state changes, or we get a flush, or something */
2133 GST_BASE_SINK_PREROLL_WAIT (sink);
2134 sink->have_preroll = FALSE;
2135 if (G_UNLIKELY (sink->flushing))
2137 if (G_UNLIKELY (sink->priv->step_unlock))
2139 GST_DEBUG_OBJECT (sink, "continue after preroll");
2146 GST_DEBUG_OBJECT (sink, "preroll interrupted because of flush");
2147 return GST_FLOW_WRONG_STATE;
2151 sink->priv->step_unlock = FALSE;
2152 GST_DEBUG_OBJECT (sink, "preroll interrupted because of step");
2153 return GST_FLOW_STEP;
2157 static inline guint8
2158 get_object_type (GstMiniObject * obj)
2162 if (G_LIKELY (GST_IS_BUFFER (obj)))
2163 obj_type = _PR_IS_BUFFER;
2164 else if (GST_IS_EVENT (obj))
2165 obj_type = _PR_IS_EVENT;
2166 else if (GST_IS_BUFFER_LIST (obj))
2167 obj_type = _PR_IS_BUFFERLIST;
2169 obj_type = _PR_IS_NOTHING;
2175 * gst_base_sink_do_preroll:
2177 * @obj: (transfer none): the mini object that caused the preroll
2179 * If the @sink spawns its own thread for pulling buffers from upstream it
2180 * should call this method after it has pulled a buffer. If the element needed
2181 * to preroll, this function will perform the preroll and will then block
2182 * until the element state is changed.
2184 * This function should be called with the PREROLL_LOCK held.
2186 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2187 * continue. Any other return value should be returned from the render vmethod.
2192 gst_base_sink_do_preroll (GstBaseSink * sink, GstMiniObject * obj)
2196 while (G_UNLIKELY (sink->need_preroll)) {
2198 GST_DEBUG_OBJECT (sink, "prerolling object %p", obj);
2200 obj_type = get_object_type (obj);
2202 ret = gst_base_sink_preroll_object (sink, obj_type, obj);
2203 if (ret != GST_FLOW_OK)
2204 goto preroll_failed;
2206 /* need to recheck here because the commit state could have
2207 * made us not need the preroll anymore */
2208 if (G_LIKELY (sink->need_preroll)) {
2209 /* block until the state changes, or we get a flush, or something */
2210 ret = gst_base_sink_wait_preroll (sink);
2211 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2212 goto preroll_failed;
2220 GST_DEBUG_OBJECT (sink, "preroll failed: %s", gst_flow_get_name (ret));
2226 * gst_base_sink_wait_eos:
2228 * @time: the running_time to be reached
2229 * @jitter: (out) (allow-none): the jitter to be filled with time diff, or NULL
2231 * This function will block until @time is reached. It is usually called by
2232 * subclasses that use their own internal synchronisation but want to let the
2233 * EOS be handled by the base class.
2235 * This function should only be called with the PREROLL_LOCK held, like when
2236 * receiving an EOS event in the ::event vmethod.
2238 * The @time argument should be the running_time of when the EOS should happen
2239 * and will be adjusted with any latency and offset configured in the sink.
2241 * Returns: #GstFlowReturn
2246 gst_base_sink_wait_eos (GstBaseSink * sink, GstClockTime time,
2247 GstClockTimeDiff * jitter)
2249 GstClockReturn status;
2255 GST_DEBUG_OBJECT (sink, "checking preroll");
2257 /* first wait for the playing state before we can continue */
2258 while (G_UNLIKELY (sink->need_preroll)) {
2259 ret = gst_base_sink_wait_preroll (sink);
2260 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2264 /* preroll done, we can sync since we are in PLAYING now. */
2265 GST_DEBUG_OBJECT (sink, "possibly waiting for clock to reach %"
2266 GST_TIME_FORMAT, GST_TIME_ARGS (time));
2268 /* compensate for latency and ts_offset. We don't adjust for render delay
2269 * because we don't interact with the device on EOS normally. */
2270 stime = gst_base_sink_adjust_time (sink, time);
2272 /* wait for the clock, this can be interrupted because we got shut down or
2274 status = gst_base_sink_wait_clock (sink, stime, jitter);
2276 GST_DEBUG_OBJECT (sink, "clock returned %d", status);
2278 /* invalid time, no clock or sync disabled, just continue then */
2279 if (status == GST_CLOCK_BADTIME)
2282 /* waiting could have been interrupted and we can be flushing now */
2283 if (G_UNLIKELY (sink->flushing))
2286 /* retry if we got unscheduled, which means we did not reach the timeout
2287 * yet. if some other error occures, we continue. */
2288 } while (status == GST_CLOCK_UNSCHEDULED);
2290 GST_DEBUG_OBJECT (sink, "end of stream");
2297 GST_DEBUG_OBJECT (sink, "we are flushing");
2298 return GST_FLOW_WRONG_STATE;
2302 /* with STREAM_LOCK, PREROLL_LOCK
2304 * Make sure we are in PLAYING and synchronize an object to the clock.
2306 * If we need preroll, we are not in PLAYING. We try to commit the state
2307 * if needed and then block if we still are not PLAYING.
2309 * We start waiting on the clock in PLAYING. If we got interrupted, we
2310 * immediately try to re-preroll.
2312 * Some objects do not need synchronisation (most events) and so this function
2313 * immediately returns GST_FLOW_OK.
2315 * for objects that arrive later than max-lateness to be synchronized to the
2316 * clock have the @late boolean set to TRUE.
2318 * This function keeps a running average of the jitter (the diff between the
2319 * clock time and the requested sync time). The jitter is negative for
2320 * objects that arrive in time and positive for late buffers.
2322 * does not take ownership of obj.
2324 static GstFlowReturn
2325 gst_base_sink_do_sync (GstBaseSink * basesink, GstPad * pad,
2326 GstMiniObject * obj, gboolean * late, gboolean * step_end, guint8 obj_type)
2328 GstClockTimeDiff jitter = 0;
2330 GstClockReturn status = GST_CLOCK_OK;
2331 GstClockTime rstart, rstop, sstart, sstop, stime;
2333 GstBaseSinkPrivate *priv;
2335 GstStepInfo *current, *pending;
2338 priv = basesink->priv;
2341 sstart = sstop = rstart = rstop = GST_CLOCK_TIME_NONE;
2345 priv->current_rstart = GST_CLOCK_TIME_NONE;
2347 /* get stepping info */
2348 current = &priv->current_step;
2349 pending = &priv->pending_step;
2351 /* get timing information for this object against the render segment */
2352 syncable = gst_base_sink_get_sync_times (basesink, obj,
2353 &sstart, &sstop, &rstart, &rstop, &do_sync, &stepped, &basesink->segment,
2354 current, step_end, obj_type);
2356 if (G_UNLIKELY (stepped))
2359 /* a syncable object needs to participate in preroll and
2360 * clocking. All buffers and EOS are syncable. */
2361 if (G_UNLIKELY (!syncable))
2364 /* store timing info for current object */
2365 priv->current_rstart = rstart;
2366 priv->current_rstop = (GST_CLOCK_TIME_IS_VALID (rstop) ? rstop : rstart);
2368 /* save sync time for eos when the previous object needed sync */
2369 priv->eos_rtime = (do_sync ? priv->current_rstop : GST_CLOCK_TIME_NONE);
2371 /* calculate inter frame spacing */
2372 if (G_UNLIKELY (priv->prev_rstart != -1 && priv->prev_rstart < rstart)) {
2373 GstClockTime in_diff;
2375 in_diff = rstart - priv->prev_rstart;
2377 if (priv->avg_in_diff == -1)
2378 priv->avg_in_diff = in_diff;
2380 priv->avg_in_diff = UPDATE_RUNNING_AVG (priv->avg_in_diff, in_diff);
2382 GST_LOG_OBJECT (basesink, "avg frame diff %" GST_TIME_FORMAT,
2383 GST_TIME_ARGS (priv->avg_in_diff));
2386 priv->prev_rstart = rstart;
2388 if (G_UNLIKELY (priv->earliest_in_time != -1
2389 && rstart < priv->earliest_in_time))
2393 /* first do preroll, this makes sure we commit our state
2394 * to PAUSED and can continue to PLAYING. We cannot perform
2395 * any clock sync in PAUSED because there is no clock. */
2396 ret = gst_base_sink_do_preroll (basesink, obj);
2397 if (G_UNLIKELY (ret != GST_FLOW_OK))
2398 goto preroll_failed;
2400 /* update the segment with a pending step if the current one is invalid and we
2401 * have a new pending one. We only accept new step updates after a preroll */
2402 if (G_UNLIKELY (pending->valid && !current->valid)) {
2403 start_stepping (basesink, &basesink->segment, pending, current);
2407 /* After rendering we store the position of the last buffer so that we can use
2408 * it to report the position. We need to take the lock here. */
2409 GST_OBJECT_LOCK (basesink);
2410 priv->current_sstart = sstart;
2411 priv->current_sstop = (GST_CLOCK_TIME_IS_VALID (sstop) ? sstop : sstart);
2412 GST_OBJECT_UNLOCK (basesink);
2417 /* adjust for latency */
2418 stime = gst_base_sink_adjust_time (basesink, rstart);
2420 /* adjust for render-delay, avoid underflows */
2421 if (GST_CLOCK_TIME_IS_VALID (stime)) {
2422 if (stime > priv->render_delay)
2423 stime -= priv->render_delay;
2428 /* preroll done, we can sync since we are in PLAYING now. */
2429 GST_DEBUG_OBJECT (basesink, "possibly waiting for clock to reach %"
2430 GST_TIME_FORMAT ", adjusted %" GST_TIME_FORMAT,
2431 GST_TIME_ARGS (rstart), GST_TIME_ARGS (stime));
2433 /* This function will return immediately if start == -1, no clock
2434 * or sync is disabled with GST_CLOCK_BADTIME. */
2435 status = gst_base_sink_wait_clock (basesink, stime, &jitter);
2437 GST_DEBUG_OBJECT (basesink, "clock returned %d, jitter %c%" GST_TIME_FORMAT,
2438 status, (jitter < 0 ? '-' : ' '), GST_TIME_ARGS (ABS (jitter)));
2440 /* invalid time, no clock or sync disabled, just render */
2441 if (status == GST_CLOCK_BADTIME)
2444 /* waiting could have been interrupted and we can be flushing now */
2445 if (G_UNLIKELY (basesink->flushing))
2448 /* check for unlocked by a state change, we are not flushing so
2449 * we can try to preroll on the current buffer. */
2450 if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED)) {
2451 GST_DEBUG_OBJECT (basesink, "unscheduled, waiting some more");
2452 priv->call_preroll = TRUE;
2456 /* successful syncing done, record observation */
2457 priv->current_jitter = jitter;
2459 /* check if the object should be dropped */
2460 *late = gst_base_sink_is_too_late (basesink, obj, rstart, rstop,
2469 GST_DEBUG_OBJECT (basesink, "skipped stepped object %p", obj);
2475 GST_DEBUG_OBJECT (basesink, "non syncable object %p", obj);
2480 GST_DEBUG_OBJECT (basesink, "dropped because of QoS %p", obj);
2486 GST_DEBUG_OBJECT (basesink, "we are flushing");
2487 return GST_FLOW_WRONG_STATE;
2491 GST_DEBUG_OBJECT (basesink, "preroll failed");
2498 gst_base_sink_send_qos (GstBaseSink * basesink, GstQOSType type,
2499 gdouble proportion, GstClockTime time, GstClockTimeDiff diff)
2504 /* generate Quality-of-Service event */
2505 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2506 "qos: type %d, proportion: %lf, diff %" G_GINT64_FORMAT ", timestamp %"
2507 GST_TIME_FORMAT, type, proportion, diff, GST_TIME_ARGS (time));
2509 event = gst_event_new_qos (type, proportion, diff, time);
2512 res = gst_pad_push_event (basesink->sinkpad, event);
2518 gst_base_sink_perform_qos (GstBaseSink * sink, gboolean dropped)
2520 GstBaseSinkPrivate *priv;
2521 GstClockTime start, stop;
2522 GstClockTimeDiff jitter;
2523 GstClockTime pt, entered, left;
2524 GstClockTime duration;
2529 start = priv->current_rstart;
2531 if (priv->current_step.valid)
2534 /* if Quality-of-Service disabled, do nothing */
2535 if (!g_atomic_int_get (&priv->qos_enabled) ||
2536 !GST_CLOCK_TIME_IS_VALID (start))
2539 stop = priv->current_rstop;
2540 jitter = priv->current_jitter;
2543 /* this is the time the buffer entered the sink */
2544 if (start < -jitter)
2547 entered = start + jitter;
2550 /* this is the time the buffer entered the sink */
2551 entered = start + jitter;
2552 /* this is the time the buffer left the sink */
2553 left = start + jitter;
2556 /* calculate duration of the buffer */
2557 if (GST_CLOCK_TIME_IS_VALID (stop) && stop != start)
2558 duration = stop - start;
2560 duration = priv->avg_in_diff;
2562 /* if we have the time when the last buffer left us, calculate
2563 * processing time */
2564 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2565 if (entered > priv->last_left) {
2566 pt = entered - priv->last_left;
2574 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "start: %" GST_TIME_FORMAT
2575 ", stop %" GST_TIME_FORMAT ", entered %" GST_TIME_FORMAT ", left %"
2576 GST_TIME_FORMAT ", pt: %" GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT
2577 ",jitter %" G_GINT64_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (stop),
2578 GST_TIME_ARGS (entered), GST_TIME_ARGS (left), GST_TIME_ARGS (pt),
2579 GST_TIME_ARGS (duration), jitter);
2581 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "avg_duration: %" GST_TIME_FORMAT
2582 ", avg_pt: %" GST_TIME_FORMAT ", avg_rate: %g",
2583 GST_TIME_ARGS (priv->avg_duration), GST_TIME_ARGS (priv->avg_pt),
2586 /* collect running averages. for first observations, we copy the
2588 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_duration))
2589 priv->avg_duration = duration;
2591 priv->avg_duration = UPDATE_RUNNING_AVG (priv->avg_duration, duration);
2593 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_pt))
2596 priv->avg_pt = UPDATE_RUNNING_AVG (priv->avg_pt, pt);
2598 if (priv->avg_duration != 0)
2600 gst_guint64_to_gdouble (priv->avg_pt) /
2601 gst_guint64_to_gdouble (priv->avg_duration);
2605 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2606 if (dropped || priv->avg_rate < 0.0) {
2607 priv->avg_rate = rate;
2610 priv->avg_rate = UPDATE_RUNNING_AVG_N (priv->avg_rate, rate);
2612 priv->avg_rate = UPDATE_RUNNING_AVG_P (priv->avg_rate, rate);
2616 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink,
2617 "updated: avg_duration: %" GST_TIME_FORMAT ", avg_pt: %" GST_TIME_FORMAT
2618 ", avg_rate: %g", GST_TIME_ARGS (priv->avg_duration),
2619 GST_TIME_ARGS (priv->avg_pt), priv->avg_rate);
2622 if (priv->avg_rate >= 0.0) {
2624 GstClockTimeDiff diff;
2626 /* if we have a valid rate, start sending QoS messages */
2627 if (priv->current_jitter < 0) {
2628 /* make sure we never go below 0 when adding the jitter to the
2630 if (priv->current_rstart < -priv->current_jitter)
2631 priv->current_jitter = -priv->current_rstart;
2634 if (priv->throttle_time > 0) {
2635 diff = priv->throttle_time;
2636 type = GST_QOS_TYPE_THROTTLE;
2638 diff = priv->current_jitter;
2640 type = GST_QOS_TYPE_OVERFLOW;
2642 type = GST_QOS_TYPE_UNDERFLOW;
2645 gst_base_sink_send_qos (sink, type, priv->avg_rate, priv->current_rstart,
2649 /* record when this buffer will leave us */
2650 priv->last_left = left;
2653 /* reset all qos measuring */
2655 gst_base_sink_reset_qos (GstBaseSink * sink)
2657 GstBaseSinkPrivate *priv;
2661 priv->last_render_time = GST_CLOCK_TIME_NONE;
2662 priv->prev_rstart = GST_CLOCK_TIME_NONE;
2663 priv->earliest_in_time = GST_CLOCK_TIME_NONE;
2664 priv->last_left = GST_CLOCK_TIME_NONE;
2665 priv->avg_duration = GST_CLOCK_TIME_NONE;
2666 priv->avg_pt = GST_CLOCK_TIME_NONE;
2667 priv->avg_rate = -1.0;
2668 priv->avg_render = GST_CLOCK_TIME_NONE;
2669 priv->avg_in_diff = GST_CLOCK_TIME_NONE;
2675 /* Checks if the object was scheduled too late.
2677 * rstart/rstop contain the running_time start and stop values
2680 * status and jitter contain the return values from the clock wait.
2682 * returns TRUE if the buffer was too late.
2685 gst_base_sink_is_too_late (GstBaseSink * basesink, GstMiniObject * obj,
2686 GstClockTime rstart, GstClockTime rstop,
2687 GstClockReturn status, GstClockTimeDiff jitter)
2690 guint64 max_lateness;
2691 GstBaseSinkPrivate *priv;
2693 priv = basesink->priv;
2697 /* only for objects that were too late */
2698 if (G_LIKELY (status != GST_CLOCK_EARLY))
2701 max_lateness = basesink->max_lateness;
2703 /* check if frame dropping is enabled */
2704 if (max_lateness == -1)
2707 /* only check for buffers */
2708 if (G_UNLIKELY (!GST_IS_BUFFER (obj)))
2711 /* can't do check if we don't have a timestamp */
2712 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (rstart)))
2715 /* we can add a valid stop time */
2716 if (GST_CLOCK_TIME_IS_VALID (rstop))
2717 max_lateness += rstop;
2719 max_lateness += rstart;
2720 /* no stop time, use avg frame diff */
2721 if (priv->avg_in_diff != -1)
2722 max_lateness += priv->avg_in_diff;
2725 /* if the jitter bigger than duration and lateness we are too late */
2726 if ((late = rstart + jitter > max_lateness)) {
2727 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2728 "buffer is too late %" GST_TIME_FORMAT
2729 " > %" GST_TIME_FORMAT, GST_TIME_ARGS (rstart + jitter),
2730 GST_TIME_ARGS (max_lateness));
2731 /* !!emergency!!, if we did not receive anything valid for more than a
2732 * second, render it anyway so the user sees something */
2733 if (GST_CLOCK_TIME_IS_VALID (priv->last_render_time) &&
2734 rstart - priv->last_render_time > GST_SECOND) {
2736 GST_ELEMENT_WARNING (basesink, CORE, CLOCK,
2737 (_("A lot of buffers are being dropped.")),
2738 ("There may be a timestamping problem, or this computer is too slow."));
2739 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2740 "**emergency** last buffer at %" GST_TIME_FORMAT " > GST_SECOND",
2741 GST_TIME_ARGS (priv->last_render_time));
2746 if (!late || !GST_CLOCK_TIME_IS_VALID (priv->last_render_time)) {
2747 priv->last_render_time = rstart;
2748 /* the next allowed input timestamp */
2749 if (priv->throttle_time > 0)
2750 priv->earliest_in_time = rstart + priv->throttle_time;
2757 GST_DEBUG_OBJECT (basesink, "object was scheduled in time");
2762 GST_DEBUG_OBJECT (basesink, "frame dropping disabled");
2767 GST_DEBUG_OBJECT (basesink, "object is not a buffer");
2772 GST_DEBUG_OBJECT (basesink, "buffer has no timestamp");
2777 /* called before and after calling the render vmethod. It keeps track of how
2778 * much time was spent in the render method and is used to check if we are
2781 gst_base_sink_do_render_stats (GstBaseSink * basesink, gboolean start)
2783 GstBaseSinkPrivate *priv;
2785 priv = basesink->priv;
2788 priv->start = gst_util_get_timestamp ();
2790 GstClockTime elapsed;
2792 priv->stop = gst_util_get_timestamp ();
2794 elapsed = GST_CLOCK_DIFF (priv->start, priv->stop);
2796 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_render))
2797 priv->avg_render = elapsed;
2799 priv->avg_render = UPDATE_RUNNING_AVG (priv->avg_render, elapsed);
2801 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2802 "avg_render: %" GST_TIME_FORMAT, GST_TIME_ARGS (priv->avg_render));
2806 /* with STREAM_LOCK, PREROLL_LOCK,
2808 * Synchronize the object on the clock and then render it.
2810 * takes ownership of obj.
2812 static GstFlowReturn
2813 gst_base_sink_render_object (GstBaseSink * basesink, GstPad * pad,
2814 guint8 obj_type, gpointer obj)
2817 GstBaseSinkClass *bclass;
2818 gboolean late, step_end;
2820 GstBaseSinkPrivate *priv;
2822 priv = basesink->priv;
2824 if (OBJ_IS_BUFFERLIST (obj_type)) {
2826 * If buffer list, use the first group buffer within the list
2829 sync_obj = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0);
2830 g_assert (NULL != sync_obj);
2839 /* synchronize this object, non syncable objects return OK
2842 gst_base_sink_do_sync (basesink, pad, sync_obj, &late, &step_end,
2844 if (G_UNLIKELY (ret != GST_FLOW_OK))
2847 /* and now render, event or buffer/buffer list. */
2848 if (G_LIKELY (OBJ_IS_BUFFERFULL (obj_type))) {
2849 /* drop late buffers unconditionally, let's hope it's unlikely */
2850 if (G_UNLIKELY (late))
2853 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2855 if (G_LIKELY ((OBJ_IS_BUFFERLIST (obj_type) && bclass->render_list) ||
2856 (!OBJ_IS_BUFFERLIST (obj_type) && bclass->render))) {
2859 /* read once, to get same value before and after */
2860 do_qos = g_atomic_int_get (&priv->qos_enabled);
2862 GST_DEBUG_OBJECT (basesink, "rendering object %p", obj);
2864 /* record rendering time for QoS and stats */
2866 gst_base_sink_do_render_stats (basesink, TRUE);
2868 if (!OBJ_IS_BUFFERLIST (obj_type)) {
2871 /* For buffer lists do not set last buffer. Creating buffer
2872 * with meaningful data can be done only with memcpy which will
2873 * significantly affect performance */
2874 buf = GST_BUFFER_CAST (obj);
2875 gst_base_sink_set_last_buffer (basesink, buf);
2877 ret = bclass->render (basesink, buf);
2879 GstBufferList *buflist;
2881 buflist = GST_BUFFER_LIST_CAST (obj);
2883 ret = bclass->render_list (basesink, buflist);
2887 gst_base_sink_do_render_stats (basesink, FALSE);
2889 if (ret == GST_FLOW_STEP)
2892 if (G_UNLIKELY (basesink->flushing))
2897 } else if (G_LIKELY (OBJ_IS_EVENT (obj_type))) {
2898 GstEvent *event = GST_EVENT_CAST (obj);
2899 gboolean event_res = TRUE;
2902 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2904 type = GST_EVENT_TYPE (event);
2906 GST_DEBUG_OBJECT (basesink, "rendering event %p, type %s", obj,
2907 gst_event_type_get_name (type));
2910 event_res = bclass->event (basesink, event);
2912 /* when we get here we could be flushing again when the event handler calls
2913 * _wait_eos(). We have to ignore this object in that case. */
2914 if (G_UNLIKELY (basesink->flushing))
2917 if (G_LIKELY (event_res)) {
2920 seqnum = basesink->priv->seqnum = gst_event_get_seqnum (event);
2921 GST_DEBUG_OBJECT (basesink, "Got seqnum #%" G_GUINT32_FORMAT, seqnum);
2926 GstMessage *message;
2928 /* the EOS event is completely handled so we mark
2929 * ourselves as being in the EOS state. eos is also
2930 * protected by the object lock so we can read it when
2931 * answering the POSITION query. */
2932 GST_OBJECT_LOCK (basesink);
2933 basesink->eos = TRUE;
2934 GST_OBJECT_UNLOCK (basesink);
2936 /* ok, now we can post the message */
2937 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
2939 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
2940 gst_message_set_seqnum (message, seqnum);
2941 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
2944 case GST_EVENT_SEGMENT:
2945 /* configure the segment */
2946 gst_base_sink_configure_segment (basesink, pad, event,
2947 &basesink->segment);
2951 GstTagList *taglist;
2953 gst_event_parse_tag (event, &taglist);
2955 gst_element_post_message (GST_ELEMENT_CAST (basesink),
2956 gst_message_new_tag (GST_OBJECT_CAST (basesink),
2957 gst_tag_list_copy (taglist)));
2960 case GST_EVENT_SINK_MESSAGE:
2962 GstMessage *msg = NULL;
2964 gst_event_parse_sink_message (event, &msg);
2967 gst_element_post_message (GST_ELEMENT_CAST (basesink), msg);
2974 g_return_val_if_reached (GST_FLOW_ERROR);
2979 /* the step ended, check if we need to activate a new step */
2980 GST_DEBUG_OBJECT (basesink, "step ended");
2981 stop_stepping (basesink, &basesink->segment, &priv->current_step,
2982 priv->current_rstart, priv->current_rstop, basesink->eos);
2986 gst_base_sink_perform_qos (basesink, late);
2988 GST_DEBUG_OBJECT (basesink, "object unref after render %p", obj);
2989 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
2995 GST_DEBUG_OBJECT (basesink, "do_sync returned %s", gst_flow_get_name (ret));
3001 GST_DEBUG_OBJECT (basesink, "buffer late, dropping");
3003 if (g_atomic_int_get (&priv->qos_enabled)) {
3004 GstMessage *qos_msg;
3005 GstClockTime timestamp, duration;
3007 timestamp = GST_BUFFER_TIMESTAMP (GST_BUFFER_CAST (sync_obj));
3008 duration = GST_BUFFER_DURATION (GST_BUFFER_CAST (sync_obj));
3010 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
3011 "qos: dropped buffer rt %" GST_TIME_FORMAT ", st %" GST_TIME_FORMAT
3012 ", ts %" GST_TIME_FORMAT ", dur %" GST_TIME_FORMAT,
3013 GST_TIME_ARGS (priv->current_rstart),
3014 GST_TIME_ARGS (priv->current_sstart), GST_TIME_ARGS (timestamp),
3015 GST_TIME_ARGS (duration));
3016 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
3017 "qos: rendered %" G_GUINT64_FORMAT ", dropped %" G_GUINT64_FORMAT,
3018 priv->rendered, priv->dropped);
3021 gst_message_new_qos (GST_OBJECT_CAST (basesink), basesink->sync,
3022 priv->current_rstart, priv->current_sstart, timestamp, duration);
3023 gst_message_set_qos_values (qos_msg, priv->current_jitter, priv->avg_rate,
3025 gst_message_set_qos_stats (qos_msg, GST_FORMAT_BUFFERS, priv->rendered,
3027 gst_element_post_message (GST_ELEMENT_CAST (basesink), qos_msg);
3033 GST_DEBUG_OBJECT (basesink, "we are flushing, ignore object");
3034 gst_mini_object_unref (obj);
3035 return GST_FLOW_WRONG_STATE;
3039 /* with STREAM_LOCK, PREROLL_LOCK
3041 * Perform preroll on the given object. For buffers this means
3042 * calling the preroll subclass method.
3043 * If that succeeds, the state will be commited.
3045 * function does not take ownership of obj.
3047 static GstFlowReturn
3048 gst_base_sink_preroll_object (GstBaseSink * basesink, guint8 obj_type,
3049 GstMiniObject * obj)
3053 GST_DEBUG_OBJECT (basesink, "prerolling object %p", obj);
3055 /* if it's a buffer, we need to call the preroll method */
3056 if (G_LIKELY (OBJ_IS_BUFFERFULL (obj_type) && basesink->priv->call_preroll)) {
3057 GstBaseSinkClass *bclass;
3059 GstClockTime timestamp;
3061 if (OBJ_IS_BUFFERLIST (obj_type)) {
3062 buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0);
3063 g_assert (NULL != buf);
3065 buf = GST_BUFFER_CAST (obj);
3068 timestamp = GST_BUFFER_TIMESTAMP (buf);
3070 GST_DEBUG_OBJECT (basesink, "preroll buffer %" GST_TIME_FORMAT,
3071 GST_TIME_ARGS (timestamp));
3074 * For buffer lists do not set last buffer. Creating buffer
3075 * with meaningful data can be done only with memcpy which will
3076 * significantly affect performance
3078 if (!OBJ_IS_BUFFERLIST (obj_type)) {
3079 gst_base_sink_set_last_buffer (basesink, buf);
3082 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3083 if (bclass->preroll)
3084 if ((ret = bclass->preroll (basesink, buf)) != GST_FLOW_OK)
3085 goto preroll_failed;
3087 basesink->priv->call_preroll = FALSE;
3091 if (G_LIKELY (basesink->playing_async)) {
3092 if (G_UNLIKELY (!gst_base_sink_commit_state (basesink)))
3101 GST_DEBUG_OBJECT (basesink, "preroll failed, abort state");
3102 gst_element_abort_state (GST_ELEMENT_CAST (basesink));
3107 GST_DEBUG_OBJECT (basesink, "stopping while commiting state");
3108 return GST_FLOW_WRONG_STATE;
3112 /* with STREAM_LOCK, PREROLL_LOCK
3114 * Queue an object for rendering.
3115 * The first prerollable object queued will complete the preroll. If the
3116 * preroll queue is filled, we render all the objects in the queue.
3118 * This function takes ownership of the object.
3120 static GstFlowReturn
3121 gst_base_sink_queue_object_unlocked (GstBaseSink * basesink, GstPad * pad,
3122 guint8 obj_type, gpointer obj, gboolean prerollable)
3124 GstFlowReturn ret = GST_FLOW_OK;
3128 if (G_UNLIKELY (basesink->need_preroll)) {
3129 if (G_LIKELY (prerollable))
3130 basesink->priv->preroll_queued++;
3132 length = basesink->priv->preroll_queued;
3134 GST_DEBUG_OBJECT (basesink, "now %d prerolled items", length);
3136 /* first prerollable item needs to finish the preroll */
3138 ret = gst_base_sink_preroll_object (basesink, obj_type, obj);
3139 if (G_UNLIKELY (ret != GST_FLOW_OK))
3140 goto preroll_failed;
3142 /* need to recheck if we need preroll, commit state during preroll
3143 * could have made us not need more preroll. */
3144 if (G_UNLIKELY (basesink->need_preroll)) {
3145 /* see if we can render now, if we can't add the object to the preroll
3147 if (G_UNLIKELY (length <= 0))
3151 /* we can start rendering (or blocking) the queued object
3153 q = basesink->priv->preroll_queue;
3154 while (G_UNLIKELY (!g_queue_is_empty (q))) {
3158 o = g_queue_pop_head (q);
3159 GST_DEBUG_OBJECT (basesink, "rendering queued object %p", o);
3161 ot = get_object_type (o);
3163 /* do something with the return value */
3164 ret = gst_base_sink_render_object (basesink, pad, ot, o);
3165 if (ret != GST_FLOW_OK)
3166 goto dequeue_failed;
3169 /* now render the object */
3170 ret = gst_base_sink_render_object (basesink, pad, obj_type, obj);
3171 basesink->priv->preroll_queued = 0;
3178 GST_DEBUG_OBJECT (basesink, "preroll failed, reason %s",
3179 gst_flow_get_name (ret));
3180 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3185 /* add object to the queue and return */
3186 GST_DEBUG_OBJECT (basesink, "need more preroll data");
3187 g_queue_push_tail (basesink->priv->preroll_queue, obj);
3192 GST_DEBUG_OBJECT (basesink, "rendering queued objects failed, reason %s",
3193 gst_flow_get_name (ret));
3194 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3201 * This function grabs the PREROLL_LOCK and adds the object to
3204 * This function takes ownership of obj.
3206 * Note: Only GstEvent seem to be passed to this private method
3208 static GstFlowReturn
3209 gst_base_sink_queue_object (GstBaseSink * basesink, GstPad * pad,
3210 GstMiniObject * obj, gboolean prerollable)
3214 GST_BASE_SINK_PREROLL_LOCK (basesink);
3215 if (G_UNLIKELY (basesink->flushing))
3218 if (G_UNLIKELY (basesink->priv->received_eos))
3222 gst_base_sink_queue_object_unlocked (basesink, pad, _PR_IS_EVENT, obj,
3224 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3231 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3232 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3233 gst_mini_object_unref (obj);
3234 return GST_FLOW_WRONG_STATE;
3238 GST_DEBUG_OBJECT (basesink, "we are EOS, dropping object, return EOS");
3239 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3240 gst_mini_object_unref (obj);
3241 return GST_FLOW_EOS;
3246 gst_base_sink_flush_start (GstBaseSink * basesink, GstPad * pad)
3248 /* make sure we are not blocked on the clock also clear any pending
3250 gst_base_sink_set_flushing (basesink, pad, TRUE);
3252 /* we grab the stream lock but that is not needed since setting the
3253 * sink to flushing would make sure no state commit is being done
3255 GST_PAD_STREAM_LOCK (pad);
3256 gst_base_sink_reset_qos (basesink);
3257 /* and we need to commit our state again on the next
3258 * prerolled buffer */
3259 basesink->playing_async = TRUE;
3260 if (basesink->priv->async_enabled) {
3261 gst_element_lost_state (GST_ELEMENT_CAST (basesink));
3263 /* start time reset in above case as well;
3264 * arranges for a.o. proper position reporting when flushing in PAUSED */
3265 gst_element_set_start_time (GST_ELEMENT_CAST (basesink), 0);
3266 basesink->priv->have_latency = TRUE;
3268 gst_base_sink_set_last_buffer (basesink, NULL);
3269 GST_PAD_STREAM_UNLOCK (pad);
3273 gst_base_sink_flush_stop (GstBaseSink * basesink, GstPad * pad,
3274 gboolean reset_time)
3276 /* unset flushing so we can accept new data, this also flushes out any EOS
3278 gst_base_sink_set_flushing (basesink, pad, FALSE);
3280 /* for position reporting */
3281 GST_OBJECT_LOCK (basesink);
3282 basesink->priv->current_sstart = GST_CLOCK_TIME_NONE;
3283 basesink->priv->current_sstop = GST_CLOCK_TIME_NONE;
3284 basesink->priv->eos_rtime = GST_CLOCK_TIME_NONE;
3285 basesink->priv->call_preroll = TRUE;
3286 basesink->priv->current_step.valid = FALSE;
3287 basesink->priv->pending_step.valid = FALSE;
3288 if (basesink->pad_mode == GST_PAD_MODE_PUSH) {
3289 /* we need new segment info after the flush. */
3290 basesink->have_newsegment = FALSE;
3292 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
3293 gst_segment_init (&basesink->clip_segment, GST_FORMAT_UNDEFINED);
3296 basesink->priv->reset_time = reset_time;
3297 GST_OBJECT_UNLOCK (basesink);
3301 gst_base_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
3303 GstBaseSink *basesink;
3304 gboolean result = TRUE;
3305 GstBaseSinkClass *bclass;
3307 basesink = GST_BASE_SINK (parent);
3308 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3310 GST_DEBUG_OBJECT (basesink, "received event %p %" GST_PTR_FORMAT, event,
3313 switch (GST_EVENT_TYPE (event)) {
3318 GST_BASE_SINK_PREROLL_LOCK (basesink);
3319 if (G_UNLIKELY (basesink->flushing))
3322 if (G_UNLIKELY (basesink->priv->received_eos))
3325 /* we set the received EOS flag here so that we can use it when testing if
3326 * we are prerolled and to refuse more buffers. */
3327 basesink->priv->received_eos = TRUE;
3329 /* EOS is a prerollable object, we call the unlocked version because it
3330 * does not check the received_eos flag. */
3331 ret = gst_base_sink_queue_object_unlocked (basesink, pad,
3332 _PR_IS_EVENT, GST_MINI_OBJECT_CAST (event), TRUE);
3333 if (G_UNLIKELY (ret != GST_FLOW_OK))
3336 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3339 case GST_EVENT_CAPS:
3343 GST_DEBUG_OBJECT (basesink, "caps %p", event);
3345 gst_event_parse_caps (event, &caps);
3346 if (bclass->set_caps)
3347 result = bclass->set_caps (basesink, caps);
3349 gst_event_unref (event);
3352 case GST_EVENT_SEGMENT:
3356 GST_DEBUG_OBJECT (basesink, "segment %p", event);
3358 GST_BASE_SINK_PREROLL_LOCK (basesink);
3359 if (G_UNLIKELY (basesink->flushing))
3362 if (G_UNLIKELY (basesink->priv->received_eos))
3365 /* the new segment is a non prerollable item and does not block anything,
3366 * we need to configure the current clipping segment and insert the event
3367 * in the queue to serialize it with the buffers for rendering. */
3368 gst_base_sink_configure_segment (basesink, pad, event,
3369 &basesink->clip_segment);
3372 gst_base_sink_queue_object_unlocked (basesink, pad,
3373 _PR_IS_EVENT, GST_MINI_OBJECT_CAST (event), FALSE);
3374 if (G_UNLIKELY (ret != GST_FLOW_OK))
3377 GST_OBJECT_LOCK (basesink);
3378 basesink->have_newsegment = TRUE;
3379 GST_OBJECT_UNLOCK (basesink);
3381 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3384 case GST_EVENT_FLUSH_START:
3386 bclass->event (basesink, event);
3388 GST_DEBUG_OBJECT (basesink, "flush-start %p", event);
3390 gst_base_sink_flush_start (basesink, pad);
3392 gst_event_unref (event);
3394 case GST_EVENT_FLUSH_STOP:
3396 gboolean reset_time;
3399 bclass->event (basesink, event);
3401 gst_event_parse_flush_stop (event, &reset_time);
3402 GST_DEBUG_OBJECT (basesink, "flush-stop %p, reset_time: %d", event,
3405 gst_base_sink_flush_stop (basesink, pad, reset_time);
3407 gst_event_unref (event);
3411 /* other events are sent to queue or subclass depending on if they
3412 * are serialized. */
3413 if (GST_EVENT_IS_SERIALIZED (event)) {
3414 gst_base_sink_queue_object (basesink, pad,
3415 GST_MINI_OBJECT_CAST (event), FALSE);
3418 bclass->event (basesink, event);
3419 gst_event_unref (event);
3429 GST_DEBUG_OBJECT (basesink, "we are flushing");
3430 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3432 gst_event_unref (event);
3438 GST_DEBUG_OBJECT (basesink, "Event received after EOS, dropping");
3439 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3441 gst_event_unref (event);
3446 /* default implementation to calculate the start and end
3447 * timestamps on a buffer, subclasses can override
3450 gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
3451 GstClockTime * start, GstClockTime * end)
3453 GstClockTime timestamp, duration;
3455 timestamp = GST_BUFFER_TIMESTAMP (buffer);
3456 if (GST_CLOCK_TIME_IS_VALID (timestamp)) {
3458 /* get duration to calculate end time */
3459 duration = GST_BUFFER_DURATION (buffer);
3460 if (GST_CLOCK_TIME_IS_VALID (duration)) {
3461 *end = timestamp + duration;
3467 /* must be called with PREROLL_LOCK */
3469 gst_base_sink_needs_preroll (GstBaseSink * basesink)
3471 gboolean is_prerolled, res;
3473 /* we have 2 cases where the PREROLL_LOCK is released:
3474 * 1) we are blocking in the PREROLL_LOCK and thus are prerolled.
3475 * 2) we are syncing on the clock
3477 is_prerolled = basesink->have_preroll || basesink->priv->received_eos;
3478 res = !is_prerolled;
3480 GST_DEBUG_OBJECT (basesink, "have_preroll: %d, EOS: %d => needs preroll: %d",
3481 basesink->have_preroll, basesink->priv->received_eos, res);
3486 /* with STREAM_LOCK, PREROLL_LOCK
3488 * Takes a buffer and compare the timestamps with the last segment.
3489 * If the buffer falls outside of the segment boundaries, drop it.
3490 * Else queue the buffer for preroll and rendering.
3492 * This function takes ownership of the buffer.
3494 static GstFlowReturn
3495 gst_base_sink_chain_unlocked (GstBaseSink * basesink, GstPad * pad,
3496 guint8 obj_type, gpointer obj)
3498 GstBaseSinkClass *bclass;
3499 GstFlowReturn result;
3500 GstClockTime start = GST_CLOCK_TIME_NONE, end = GST_CLOCK_TIME_NONE;
3501 GstSegment *clip_segment;
3502 GstBuffer *time_buf;
3504 if (G_UNLIKELY (basesink->flushing))
3507 if (G_UNLIKELY (basesink->priv->received_eos))
3510 if (OBJ_IS_BUFFERLIST (obj_type)) {
3511 time_buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0);
3512 g_assert (NULL != time_buf);
3514 time_buf = GST_BUFFER_CAST (obj);
3517 /* for code clarity */
3518 clip_segment = &basesink->clip_segment;
3520 if (G_UNLIKELY (!basesink->have_newsegment)) {
3523 sync = gst_base_sink_get_sync (basesink);
3525 GST_ELEMENT_WARNING (basesink, STREAM, FAILED,
3526 (_("Internal data flow problem.")),
3527 ("Received buffer without a new-segment. Assuming timestamps start from 0."));
3530 /* this means this sink will assume timestamps start from 0 */
3531 GST_OBJECT_LOCK (basesink);
3532 clip_segment->start = 0;
3533 clip_segment->stop = -1;
3534 basesink->segment.start = 0;
3535 basesink->segment.stop = -1;
3536 basesink->have_newsegment = TRUE;
3537 GST_OBJECT_UNLOCK (basesink);
3540 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3542 /* check if the buffer needs to be dropped, we first ask the subclass for the
3544 if (bclass->get_times)
3545 bclass->get_times (basesink, time_buf, &start, &end);
3547 if (!GST_CLOCK_TIME_IS_VALID (start)) {
3548 /* if the subclass does not want sync, we use our own values so that we at
3549 * least clip the buffer to the segment */
3550 gst_base_sink_get_times (basesink, time_buf, &start, &end);
3553 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
3554 ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (end));
3556 /* a dropped buffer does not participate in anything */
3557 if (GST_CLOCK_TIME_IS_VALID (start) &&
3558 (clip_segment->format == GST_FORMAT_TIME)) {
3559 if (G_UNLIKELY (!gst_segment_clip (clip_segment,
3560 GST_FORMAT_TIME, start, end, NULL, NULL)))
3561 goto out_of_segment;
3564 /* now we can process the buffer in the queue, this function takes ownership
3566 result = gst_base_sink_queue_object_unlocked (basesink, pad,
3567 obj_type, obj, TRUE);
3573 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3574 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3575 return GST_FLOW_WRONG_STATE;
3579 GST_DEBUG_OBJECT (basesink, "we are EOS, dropping object, return EOS");
3580 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3581 return GST_FLOW_EOS;
3585 GST_DEBUG_OBJECT (basesink, "dropping buffer, out of clipping segment");
3586 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3593 static GstFlowReturn
3594 gst_base_sink_chain_main (GstBaseSink * basesink, GstPad * pad,
3595 guint8 obj_type, gpointer obj)
3597 GstFlowReturn result;
3599 if (G_UNLIKELY (basesink->pad_mode != GST_PAD_MODE_PUSH))
3602 GST_BASE_SINK_PREROLL_LOCK (basesink);
3603 result = gst_base_sink_chain_unlocked (basesink, pad, obj_type, obj);
3604 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3612 GST_OBJECT_LOCK (pad);
3613 GST_WARNING_OBJECT (basesink,
3614 "Push on pad %s:%s, but it was not activated in push mode",
3615 GST_DEBUG_PAD_NAME (pad));
3616 GST_OBJECT_UNLOCK (pad);
3617 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3618 /* we don't post an error message this will signal to the peer
3619 * pushing that EOS is reached. */
3620 result = GST_FLOW_EOS;
3625 static GstFlowReturn
3626 gst_base_sink_chain (GstPad * pad, GstObject * parent, GstBuffer * buf)
3628 GstBaseSink *basesink;
3630 basesink = GST_BASE_SINK (parent);
3632 return gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFER, buf);
3635 static GstFlowReturn
3636 gst_base_sink_chain_list (GstPad * pad, GstObject * parent,
3637 GstBufferList * list)
3639 GstBaseSink *basesink;
3640 GstBaseSinkClass *bclass;
3641 GstFlowReturn result;
3643 basesink = GST_BASE_SINK (parent);
3644 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3646 if (G_LIKELY (bclass->render_list)) {
3647 result = gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFERLIST, list);
3652 GST_INFO_OBJECT (pad, "chaining each group in list as a merged buffer");
3654 len = gst_buffer_list_length (list);
3656 result = GST_FLOW_OK;
3657 for (i = 0; i < len; i++) {
3658 buffer = gst_buffer_list_get (list, 0);
3659 result = gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFER,
3660 gst_buffer_ref (buffer));
3661 if (result != GST_FLOW_OK)
3664 gst_buffer_list_unref (list);
3671 gst_base_sink_default_do_seek (GstBaseSink * sink, GstSegment * segment)
3673 gboolean res = TRUE;
3675 /* update our offset if the start/stop position was updated */
3676 if (segment->format == GST_FORMAT_BYTES) {
3677 segment->time = segment->start;
3678 } else if (segment->start == 0) {
3679 /* seek to start, we can implement a default for this. */
3683 GST_INFO_OBJECT (sink, "Can't do a default seek");
3689 #define SEEK_TYPE_IS_RELATIVE(t) (((t) != GST_SEEK_TYPE_NONE) && ((t) != GST_SEEK_TYPE_SET))
3692 gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
3693 GstEvent * event, GstSegment * segment)
3695 /* By default, we try one of 2 things:
3696 * - For absolute seek positions, convert the requested position to our
3697 * configured processing format and place it in the output segment \
3698 * - For relative seek positions, convert our current (input) values to the
3699 * seek format, adjust by the relative seek offset and then convert back to
3700 * the processing format
3702 GstSeekType cur_type, stop_type;
3705 GstFormat seek_format;
3708 gboolean res = TRUE;
3710 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3711 &cur_type, &cur, &stop_type, &stop);
3713 if (seek_format == segment->format) {
3714 gst_segment_do_seek (segment, rate, seek_format, flags,
3715 cur_type, cur, stop_type, stop, &update);
3719 if (cur_type != GST_SEEK_TYPE_NONE) {
3720 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3722 gst_pad_query_convert (sink->sinkpad, seek_format, cur, segment->format,
3724 cur_type = GST_SEEK_TYPE_SET;
3727 if (res && stop_type != GST_SEEK_TYPE_NONE) {
3728 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3730 gst_pad_query_convert (sink->sinkpad, seek_format, stop,
3731 segment->format, &stop);
3732 stop_type = GST_SEEK_TYPE_SET;
3735 /* And finally, configure our output segment in the desired format */
3736 gst_segment_do_seek (segment, rate, segment->format, flags, cur_type, cur,
3737 stop_type, stop, &update);
3746 GST_DEBUG_OBJECT (sink, "undefined format given, seek aborted.");
3751 /* perform a seek, only executed in pull mode */
3753 gst_base_sink_perform_seek (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3757 GstFormat seek_format, dest_format;
3759 GstSeekType cur_type, stop_type;
3760 gboolean seekseg_configured = FALSE;
3762 gboolean update, res = TRUE;
3763 GstSegment seeksegment;
3765 dest_format = sink->segment.format;
3768 GST_DEBUG_OBJECT (sink, "performing seek with event %p", event);
3769 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3770 &cur_type, &cur, &stop_type, &stop);
3772 flush = flags & GST_SEEK_FLAG_FLUSH;
3774 GST_DEBUG_OBJECT (sink, "performing seek without event");
3779 GST_DEBUG_OBJECT (sink, "flushing upstream");
3780 gst_pad_push_event (pad, gst_event_new_flush_start ());
3781 gst_base_sink_flush_start (sink, pad);
3783 GST_DEBUG_OBJECT (sink, "pausing pulling thread");
3786 GST_PAD_STREAM_LOCK (pad);
3788 /* If we configured the seeksegment above, don't overwrite it now. Otherwise
3789 * copy the current segment info into the temp segment that we can actually
3790 * attempt the seek with. We only update the real segment if the seek succeeds. */
3791 if (!seekseg_configured) {
3792 memcpy (&seeksegment, &sink->segment, sizeof (GstSegment));
3794 /* now configure the final seek segment */
3796 if (sink->segment.format != seek_format) {
3797 /* OK, here's where we give the subclass a chance to convert the relative
3798 * seek into an absolute one in the processing format. We set up any
3799 * absolute seek above, before taking the stream lock. */
3800 if (!gst_base_sink_default_prepare_seek_segment (sink, event,
3802 GST_DEBUG_OBJECT (sink,
3803 "Preparing the seek failed after flushing. " "Aborting seek");
3807 /* The seek format matches our processing format, no need to ask the
3808 * the subclass to configure the segment. */
3809 gst_segment_do_seek (&seeksegment, rate, seek_format, flags,
3810 cur_type, cur, stop_type, stop, &update);
3813 /* Else, no seek event passed, so we're just (re)starting the
3818 GST_DEBUG_OBJECT (sink, "segment configured from %" G_GINT64_FORMAT
3819 " to %" G_GINT64_FORMAT ", position %" G_GINT64_FORMAT,
3820 seeksegment.start, seeksegment.stop, seeksegment.position);
3822 /* do the seek, segment.position contains the new position. */
3823 res = gst_base_sink_default_do_seek (sink, &seeksegment);
3828 GST_DEBUG_OBJECT (sink, "stop flushing upstream");
3829 gst_pad_push_event (pad, gst_event_new_flush_stop (TRUE));
3830 gst_base_sink_flush_stop (sink, pad, TRUE);
3831 } else if (res && sink->running) {
3832 /* we are running the current segment and doing a non-flushing seek,
3833 * close the segment first based on the position. */
3834 GST_DEBUG_OBJECT (sink, "closing running segment %" G_GINT64_FORMAT
3835 " to %" G_GINT64_FORMAT, sink->segment.start, sink->segment.position);
3838 /* The subclass must have converted the segment to the processing format
3840 if (res && seeksegment.format != dest_format) {
3841 GST_DEBUG_OBJECT (sink, "Subclass failed to prepare a seek segment "
3842 "in the correct format. Aborting seek.");
3846 /* if successful seek, we update our real segment and push
3847 * out the new segment. */
3849 gst_segment_copy_into (&seeksegment, &sink->segment);
3851 if (sink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3852 gst_element_post_message (GST_ELEMENT (sink),
3853 gst_message_new_segment_start (GST_OBJECT (sink),
3854 sink->segment.format, sink->segment.position));
3858 sink->priv->discont = TRUE;
3859 sink->running = TRUE;
3861 GST_PAD_STREAM_UNLOCK (pad);
3867 set_step_info (GstBaseSink * sink, GstStepInfo * current, GstStepInfo * pending,
3868 guint seqnum, GstFormat format, guint64 amount, gdouble rate,
3869 gboolean flush, gboolean intermediate)
3871 GST_OBJECT_LOCK (sink);
3872 pending->seqnum = seqnum;
3873 pending->format = format;
3874 pending->amount = amount;
3875 pending->position = 0;
3876 pending->rate = rate;
3877 pending->flush = flush;
3878 pending->intermediate = intermediate;
3879 pending->valid = TRUE;
3880 /* flush invalidates the current stepping segment */
3882 current->valid = FALSE;
3883 GST_OBJECT_UNLOCK (sink);
3887 gst_base_sink_perform_step (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3889 GstBaseSinkPrivate *priv;
3890 GstBaseSinkClass *bclass;
3891 gboolean flush, intermediate;
3896 GstStepInfo *pending, *current;
3897 GstMessage *message;
3899 bclass = GST_BASE_SINK_GET_CLASS (sink);
3902 GST_DEBUG_OBJECT (sink, "performing step with event %p", event);
3904 gst_event_parse_step (event, &format, &amount, &rate, &flush, &intermediate);
3905 seqnum = gst_event_get_seqnum (event);
3907 pending = &priv->pending_step;
3908 current = &priv->current_step;
3910 /* post message first */
3911 message = gst_message_new_step_start (GST_OBJECT (sink), FALSE, format,
3912 amount, rate, flush, intermediate);
3913 gst_message_set_seqnum (message, seqnum);
3914 gst_element_post_message (GST_ELEMENT (sink), message);
3917 /* we need to call ::unlock before locking PREROLL_LOCK
3918 * since we lock it before going into ::render */
3920 bclass->unlock (sink);
3922 GST_BASE_SINK_PREROLL_LOCK (sink);
3923 /* now that we have the PREROLL lock, clear our unlock request */
3924 if (bclass->unlock_stop)
3925 bclass->unlock_stop (sink);
3927 /* update the stepinfo and make it valid */
3928 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3931 if (sink->priv->async_enabled) {
3932 /* and we need to commit our state again on the next
3933 * prerolled buffer */
3934 sink->playing_async = TRUE;
3935 priv->pending_step.need_preroll = TRUE;
3936 sink->need_preroll = FALSE;
3937 gst_element_lost_state (GST_ELEMENT_CAST (sink));
3939 sink->priv->have_latency = TRUE;
3940 sink->need_preroll = FALSE;
3942 priv->current_sstart = GST_CLOCK_TIME_NONE;
3943 priv->current_sstop = GST_CLOCK_TIME_NONE;
3944 priv->eos_rtime = GST_CLOCK_TIME_NONE;
3945 priv->call_preroll = TRUE;
3946 gst_base_sink_set_last_buffer (sink, NULL);
3947 gst_base_sink_reset_qos (sink);
3949 if (sink->clock_id) {
3950 gst_clock_id_unschedule (sink->clock_id);
3953 if (sink->have_preroll) {
3954 GST_DEBUG_OBJECT (sink, "signal waiter");
3955 priv->step_unlock = TRUE;
3956 GST_BASE_SINK_PREROLL_SIGNAL (sink);
3958 GST_BASE_SINK_PREROLL_UNLOCK (sink);
3960 /* update the stepinfo and make it valid */
3961 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3971 gst_base_sink_loop (GstPad * pad)
3974 GstBaseSink *basesink;
3975 GstBuffer *buf = NULL;
3976 GstFlowReturn result;
3980 parent = GST_OBJECT_PARENT (pad);
3981 basesink = GST_BASE_SINK (parent);
3983 g_assert (basesink->pad_mode == GST_PAD_MODE_PULL);
3985 if ((blocksize = basesink->priv->blocksize) == 0)
3988 offset = basesink->segment.position;
3990 GST_DEBUG_OBJECT (basesink, "pulling %" G_GUINT64_FORMAT ", %u",
3993 result = gst_pad_pull_range (pad, offset, blocksize, &buf);
3994 if (G_UNLIKELY (result != GST_FLOW_OK))
3997 if (G_UNLIKELY (buf == NULL))
4000 offset += gst_buffer_get_size (buf);
4002 basesink->segment.position = offset;
4004 GST_BASE_SINK_PREROLL_LOCK (basesink);
4005 result = gst_base_sink_chain_unlocked (basesink, pad, _PR_IS_BUFFER, buf);
4006 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4007 if (G_UNLIKELY (result != GST_FLOW_OK))
4015 GST_LOG_OBJECT (basesink, "pausing task, reason %s",
4016 gst_flow_get_name (result));
4017 gst_pad_pause_task (pad);
4018 if (result == GST_FLOW_EOS) {
4019 /* perform EOS logic */
4020 if (basesink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
4021 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4022 gst_message_new_segment_done (GST_OBJECT_CAST (basesink),
4023 basesink->segment.format, basesink->segment.position));
4025 gst_base_sink_event (pad, parent, gst_event_new_eos ());
4027 } else if (result == GST_FLOW_NOT_LINKED || result <= GST_FLOW_EOS) {
4028 /* for fatal errors we post an error message, post the error
4029 * first so the app knows about the error first.
4030 * wrong-state is not a fatal error because it happens due to
4031 * flushing and posting an error message in that case is the
4032 * wrong thing to do, e.g. when basesrc is doing a flushing
4034 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
4035 (_("Internal data stream error.")),
4036 ("stream stopped, reason %s", gst_flow_get_name (result)));
4037 gst_base_sink_event (pad, parent, gst_event_new_eos ());
4043 GST_LOG_OBJECT (basesink, "no buffer, pausing");
4044 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
4045 (_("Internal data flow error.")), ("element returned NULL buffer"));
4046 result = GST_FLOW_ERROR;
4052 gst_base_sink_set_flushing (GstBaseSink * basesink, GstPad * pad,
4055 GstBaseSinkClass *bclass;
4057 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4060 /* unlock any subclasses, we need to do this before grabbing the
4061 * PREROLL_LOCK since we hold this lock before going into ::render. */
4063 bclass->unlock (basesink);
4066 GST_BASE_SINK_PREROLL_LOCK (basesink);
4067 basesink->flushing = flushing;
4069 /* step 1, now that we have the PREROLL lock, clear our unlock request */
4070 if (bclass->unlock_stop)
4071 bclass->unlock_stop (basesink);
4073 /* set need_preroll before we unblock the clock. If the clock is unblocked
4074 * before timing out, we can reuse the buffer for preroll. */
4075 basesink->need_preroll = TRUE;
4077 /* step 2, unblock clock sync (if any) or any other blocking thing */
4078 if (basesink->clock_id) {
4079 gst_clock_id_unschedule (basesink->clock_id);
4082 /* flush out the data thread if it's locked in finish_preroll, this will
4083 * also flush out the EOS state */
4084 GST_DEBUG_OBJECT (basesink,
4085 "flushing out data thread, need preroll to TRUE");
4086 gst_base_sink_preroll_queue_flush (basesink, pad);
4088 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4094 gst_base_sink_default_activate_pull (GstBaseSink * basesink, gboolean active)
4100 result = gst_pad_start_task (basesink->sinkpad,
4101 (GstTaskFunction) gst_base_sink_loop, basesink->sinkpad);
4103 /* step 2, make sure streaming finishes */
4104 result = gst_pad_stop_task (basesink->sinkpad);
4111 gst_base_sink_pad_activate (GstPad * pad, GstObject * parent)
4113 gboolean result = FALSE;
4114 GstBaseSink *basesink;
4118 basesink = GST_BASE_SINK (parent);
4120 GST_DEBUG_OBJECT (basesink, "Trying pull mode first");
4122 gst_base_sink_set_flushing (basesink, pad, FALSE);
4124 /* we need to have the pull mode enabled */
4125 if (!basesink->can_activate_pull) {
4126 GST_DEBUG_OBJECT (basesink, "pull mode disabled");
4130 /* check if downstreams supports pull mode at all */
4131 query = gst_query_new_scheduling ();
4133 if (!gst_pad_peer_query (pad, query)) {
4134 gst_query_unref (query);
4135 GST_DEBUG_OBJECT (basesink, "peer query faild, no pull mode");
4139 /* parse result of the query */
4140 pull_mode = gst_query_has_scheduling_mode (query, GST_PAD_MODE_PULL);
4141 gst_query_unref (query);
4144 GST_DEBUG_OBJECT (basesink, "pull mode not supported");
4148 /* set the pad mode before starting the task so that it's in the
4149 * correct state for the new thread. also the sink set_caps and get_caps
4150 * function checks this */
4151 basesink->pad_mode = GST_PAD_MODE_PULL;
4153 /* we first try to negotiate a format so that when we try to activate
4154 * downstream, it knows about our format */
4155 if (!gst_base_sink_negotiate_pull (basesink)) {
4156 GST_DEBUG_OBJECT (basesink, "failed to negotiate in pull mode");
4160 /* ok activate now */
4161 if (!gst_pad_activate_mode (pad, GST_PAD_MODE_PULL, TRUE)) {
4162 /* clear any pending caps */
4163 GST_OBJECT_LOCK (basesink);
4164 gst_caps_replace (&basesink->priv->pull_caps, NULL);
4165 GST_OBJECT_UNLOCK (basesink);
4166 GST_DEBUG_OBJECT (basesink, "failed to activate in pull mode");
4170 GST_DEBUG_OBJECT (basesink, "Success activating pull mode");
4174 /* push mode fallback */
4176 GST_DEBUG_OBJECT (basesink, "Falling back to push mode");
4177 if ((result = gst_pad_activate_mode (pad, GST_PAD_MODE_PUSH, TRUE))) {
4178 GST_DEBUG_OBJECT (basesink, "Success activating push mode");
4183 GST_WARNING_OBJECT (basesink, "Could not activate pad in either mode");
4184 gst_base_sink_set_flushing (basesink, pad, TRUE);
4191 gst_base_sink_pad_activate_push (GstPad * pad, GstObject * parent,
4195 GstBaseSink *basesink;
4197 basesink = GST_BASE_SINK (parent);
4200 if (!basesink->can_activate_push) {
4202 basesink->pad_mode = GST_PAD_MODE_NONE;
4205 basesink->pad_mode = GST_PAD_MODE_PUSH;
4208 if (G_UNLIKELY (basesink->pad_mode != GST_PAD_MODE_PUSH)) {
4209 g_warning ("Internal GStreamer activation error!!!");
4212 gst_base_sink_set_flushing (basesink, pad, TRUE);
4214 basesink->pad_mode = GST_PAD_MODE_NONE;
4222 gst_base_sink_negotiate_pull (GstBaseSink * basesink)
4229 /* this returns the intersection between our caps and the peer caps. If there
4230 * is no peer, it returns NULL and we can't operate in pull mode so we can
4231 * fail the negotiation. */
4232 caps = gst_pad_get_allowed_caps (GST_BASE_SINK_PAD (basesink));
4233 if (caps == NULL || gst_caps_is_empty (caps))
4234 goto no_caps_possible;
4236 GST_DEBUG_OBJECT (basesink, "allowed caps: %" GST_PTR_FORMAT, caps);
4238 if (gst_caps_is_any (caps)) {
4239 GST_DEBUG_OBJECT (basesink, "caps were ANY after fixating, "
4241 /* neither side has template caps in this case, so they are prepared for
4242 pull() without setcaps() */
4245 caps = gst_caps_make_writable (caps);
4247 gst_base_sink_fixate (basesink, caps);
4248 GST_DEBUG_OBJECT (basesink, "fixated to: %" GST_PTR_FORMAT, caps);
4250 if (gst_caps_is_fixed (caps)) {
4251 if (!gst_pad_send_event (GST_BASE_SINK_PAD (basesink),
4252 gst_event_new_caps (caps)))
4253 goto could_not_set_caps;
4255 GST_OBJECT_LOCK (basesink);
4256 gst_caps_replace (&basesink->priv->pull_caps, caps);
4257 GST_OBJECT_UNLOCK (basesink);
4263 gst_caps_unref (caps);
4269 GST_INFO_OBJECT (basesink, "Pipeline could not agree on caps");
4270 GST_DEBUG_OBJECT (basesink, "get_allowed_caps() returned EMPTY");
4272 gst_caps_unref (caps);
4277 GST_INFO_OBJECT (basesink, "Could not set caps: %" GST_PTR_FORMAT, caps);
4278 gst_caps_unref (caps);
4283 /* this won't get called until we implement an activate function */
4285 gst_base_sink_pad_activate_pull (GstPad * pad, GstObject * parent,
4288 gboolean result = FALSE;
4289 GstBaseSink *basesink;
4290 GstBaseSinkClass *bclass;
4292 basesink = GST_BASE_SINK (parent);
4293 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4298 /* we mark we have a newsegment here because pull based
4299 * mode works just fine without having a newsegment before the
4301 gst_segment_init (&basesink->segment, GST_FORMAT_BYTES);
4302 gst_segment_init (&basesink->clip_segment, GST_FORMAT_BYTES);
4303 GST_OBJECT_LOCK (basesink);
4304 basesink->have_newsegment = TRUE;
4305 GST_OBJECT_UNLOCK (basesink);
4307 /* get the peer duration in bytes */
4308 result = gst_pad_peer_query_duration (pad, GST_FORMAT_BYTES, &duration);
4310 GST_DEBUG_OBJECT (basesink,
4311 "setting duration in bytes to %" G_GINT64_FORMAT, duration);
4312 basesink->clip_segment.duration = duration;
4313 basesink->segment.duration = duration;
4315 GST_DEBUG_OBJECT (basesink, "unknown duration");
4318 if (bclass->activate_pull)
4319 result = bclass->activate_pull (basesink, TRUE);
4324 goto activate_failed;
4327 if (G_UNLIKELY (basesink->pad_mode != GST_PAD_MODE_PULL)) {
4328 g_warning ("Internal GStreamer activation error!!!");
4331 result = gst_base_sink_set_flushing (basesink, pad, TRUE);
4332 if (bclass->activate_pull)
4333 result &= bclass->activate_pull (basesink, FALSE);
4334 basesink->pad_mode = GST_PAD_MODE_NONE;
4335 /* clear any pending caps */
4336 GST_OBJECT_LOCK (basesink);
4337 gst_caps_replace (&basesink->priv->pull_caps, NULL);
4338 GST_OBJECT_UNLOCK (basesink);
4347 /* reset, as starting the thread failed */
4348 basesink->pad_mode = GST_PAD_MODE_NONE;
4350 GST_ERROR_OBJECT (basesink, "subclass failed to activate in pull mode");
4356 gst_base_sink_pad_activate_mode (GstPad * pad, GstObject * parent,
4357 GstPadMode mode, gboolean active)
4362 case GST_PAD_MODE_PULL:
4363 res = gst_base_sink_pad_activate_pull (pad, parent, active);
4365 case GST_PAD_MODE_PUSH:
4366 res = gst_base_sink_pad_activate_push (pad, parent, active);
4369 GST_LOG_OBJECT (pad, "unknown activation mode %d", mode);
4376 /* send an event to our sinkpad peer. */
4378 gst_base_sink_send_event (GstElement * element, GstEvent * event)
4381 GstBaseSink *basesink = GST_BASE_SINK (element);
4382 gboolean forward, result = TRUE;
4385 GST_OBJECT_LOCK (element);
4386 /* get the pad and the scheduling mode */
4387 pad = gst_object_ref (basesink->sinkpad);
4388 mode = basesink->pad_mode;
4389 GST_OBJECT_UNLOCK (element);
4391 /* only push UPSTREAM events upstream */
4392 forward = GST_EVENT_IS_UPSTREAM (event);
4394 GST_DEBUG_OBJECT (basesink, "handling event %p %" GST_PTR_FORMAT, event,
4397 switch (GST_EVENT_TYPE (event)) {
4398 case GST_EVENT_LATENCY:
4400 GstClockTime latency;
4402 gst_event_parse_latency (event, &latency);
4404 /* store the latency. We use this to adjust the running_time before syncing
4405 * it to the clock. */
4406 GST_OBJECT_LOCK (element);
4407 basesink->priv->latency = latency;
4408 if (!basesink->priv->have_latency)
4410 GST_OBJECT_UNLOCK (element);
4411 GST_DEBUG_OBJECT (basesink, "latency set to %" GST_TIME_FORMAT,
4412 GST_TIME_ARGS (latency));
4414 /* We forward this event so that all elements know about the global pipeline
4415 * latency. This is interesting for an element when it wants to figure out
4416 * when a particular piece of data will be rendered. */
4419 case GST_EVENT_SEEK:
4420 /* in pull mode we will execute the seek */
4421 if (mode == GST_PAD_MODE_PULL)
4422 result = gst_base_sink_perform_seek (basesink, pad, event);
4424 case GST_EVENT_STEP:
4425 result = gst_base_sink_perform_step (basesink, pad, event);
4433 result = gst_pad_push_event (pad, event);
4435 /* not forwarded, unref the event */
4436 gst_event_unref (event);
4439 gst_object_unref (pad);
4441 GST_DEBUG_OBJECT (basesink, "handled event %p %" GST_PTR_FORMAT ": %d", event,
4448 gst_base_sink_get_position (GstBaseSink * basesink, GstFormat format,
4449 gint64 * cur, gboolean * upstream)
4451 GstClock *clock = NULL;
4452 gboolean res = FALSE;
4454 GstSegment *segment;
4455 GstClockTime now, latency;
4456 GstClockTimeDiff base_time;
4457 gint64 time, base, duration;
4460 gboolean last_seen, with_clock, in_paused;
4462 GST_OBJECT_LOCK (basesink);
4463 /* we can only get the segment when we are not NULL or READY */
4464 if (!basesink->have_newsegment)
4468 /* when not in PLAYING or when we're busy with a state change, we
4469 * cannot read from the clock so we report time based on the
4470 * last seen timestamp. */
4471 if (GST_STATE (basesink) != GST_STATE_PLAYING ||
4472 GST_STATE_PENDING (basesink) != GST_STATE_VOID_PENDING) {
4476 /* we don't use the clip segment in pull mode, when seeking we update the
4477 * main segment directly with the new segment values without it having to be
4478 * activated by the rendering after preroll */
4479 if (basesink->pad_mode == GST_PAD_MODE_PUSH)
4480 segment = &basesink->clip_segment;
4482 segment = &basesink->segment;
4484 /* get the format in the segment */
4485 oformat = segment->format;
4487 /* report with last seen position when EOS */
4488 last_seen = basesink->eos;
4490 /* assume we will use the clock for getting the current position */
4492 if (basesink->sync == FALSE)
4495 /* and we need a clock */
4496 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (basesink)) == NULL))
4499 gst_object_ref (clock);
4501 /* mainloop might be querying position when going to playing async,
4502 * while (audio) rendering might be quickly advancing stream position,
4503 * so use clock asap rather than last reported position */
4504 if (in_paused && with_clock && g_atomic_int_get (&basesink->priv->to_playing)) {
4505 GST_DEBUG_OBJECT (basesink, "going to PLAYING, so not PAUSED");
4509 /* collect all data we need holding the lock */
4510 if (GST_CLOCK_TIME_IS_VALID (segment->time))
4511 time = segment->time;
4515 if (GST_CLOCK_TIME_IS_VALID (segment->stop))
4516 duration = segment->stop - segment->start;
4520 base = segment->base;
4521 rate = segment->rate * segment->applied_rate;
4522 latency = basesink->priv->latency;
4524 if (oformat == GST_FORMAT_TIME) {
4527 start = basesink->priv->current_sstart;
4528 stop = basesink->priv->current_sstop;
4531 /* in paused we use the last position as a lower bound */
4532 if (stop == -1 || segment->rate > 0.0)
4537 /* in playing, use last stop time as upper bound */
4538 if (start == -1 || segment->rate > 0.0)
4544 /* convert last stop to stream time */
4545 last = gst_segment_to_stream_time (segment, oformat, segment->position);
4549 /* in paused, use start_time */
4550 base_time = GST_ELEMENT_START_TIME (basesink);
4551 GST_DEBUG_OBJECT (basesink, "in paused, using start time %" GST_TIME_FORMAT,
4552 GST_TIME_ARGS (base_time));
4553 } else if (with_clock) {
4554 /* else use clock when needed */
4555 base_time = GST_ELEMENT_CAST (basesink)->base_time;
4556 GST_DEBUG_OBJECT (basesink, "using clock and base time %" GST_TIME_FORMAT,
4557 GST_TIME_ARGS (base_time));
4559 /* else, no sync or clock -> no base time */
4560 GST_DEBUG_OBJECT (basesink, "no sync or no clock");
4564 /* no base_time, we can't calculate running_time, use last seem timestamp to report
4566 if (base_time == -1)
4569 /* need to release the object lock before we can get the time,
4570 * a clock might take the LOCK of the provider, which could be
4571 * a basesink subclass. */
4572 GST_OBJECT_UNLOCK (basesink);
4575 /* in EOS or when no valid stream_time, report the value of last seen
4578 /* no timestamp, we need to ask upstream */
4579 GST_DEBUG_OBJECT (basesink, "no last seen timestamp, asking upstream");
4584 GST_DEBUG_OBJECT (basesink, "using last seen timestamp %" GST_TIME_FORMAT,
4585 GST_TIME_ARGS (last));
4588 if (oformat != GST_FORMAT_TIME) {
4589 /* convert base, time and duration to time */
4590 if (!gst_pad_query_convert (basesink->sinkpad, oformat, base,
4591 GST_FORMAT_TIME, &base))
4592 goto convert_failed;
4593 if (!gst_pad_query_convert (basesink->sinkpad, oformat, duration,
4594 GST_FORMAT_TIME, &duration))
4595 goto convert_failed;
4596 if (!gst_pad_query_convert (basesink->sinkpad, oformat, time,
4597 GST_FORMAT_TIME, &time))
4598 goto convert_failed;
4599 if (!gst_pad_query_convert (basesink->sinkpad, oformat, last,
4600 GST_FORMAT_TIME, &last))
4601 goto convert_failed;
4603 /* assume time format from now on */
4604 oformat = GST_FORMAT_TIME;
4607 if (!in_paused && with_clock) {
4608 now = gst_clock_get_time (clock);
4614 /* subtract base time and base time from the clock time.
4615 * Make sure we don't go negative. This is the current time in
4616 * the segment which we need to scale with the combined
4617 * rate and applied rate. */
4619 base_time += latency;
4620 if (GST_CLOCK_DIFF (base_time, now) < 0)
4623 /* for negative rates we need to count back from the segment
4628 *cur = time + gst_guint64_to_gdouble (now - base_time) * rate;
4631 /* never report less than segment values in paused */
4633 *cur = MAX (last, *cur);
4635 /* never report more than last seen position in playing */
4637 *cur = MIN (last, *cur);
4640 GST_DEBUG_OBJECT (basesink,
4641 "now %" GST_TIME_FORMAT " - base_time %" GST_TIME_FORMAT " - base %"
4642 GST_TIME_FORMAT " + time %" GST_TIME_FORMAT " last %" GST_TIME_FORMAT,
4643 GST_TIME_ARGS (now), GST_TIME_ARGS (base_time), GST_TIME_ARGS (base),
4644 GST_TIME_ARGS (time), GST_TIME_ARGS (last));
4647 if (oformat != format) {
4648 /* convert to final format */
4649 if (!gst_pad_query_convert (basesink->sinkpad, oformat, *cur, format, cur))
4650 goto convert_failed;
4656 GST_DEBUG_OBJECT (basesink, "res: %d, POSITION: %" GST_TIME_FORMAT,
4657 res, GST_TIME_ARGS (*cur));
4660 gst_object_unref (clock);
4667 /* in NULL or READY we always return FALSE and -1 */
4668 GST_DEBUG_OBJECT (basesink, "position in wrong state, return -1");
4671 GST_OBJECT_UNLOCK (basesink);
4676 GST_DEBUG_OBJECT (basesink, "convert failed, try upstream");
4684 gst_base_sink_get_duration (GstBaseSink * basesink, GstFormat format,
4685 gint64 * dur, gboolean * upstream)
4687 gboolean res = FALSE;
4689 if (basesink->pad_mode == GST_PAD_MODE_PULL) {
4692 /* get the duration in bytes, in pull mode that's all we are sure to
4693 * know. We have to explicitly get this value from upstream instead of
4694 * using our cached value because it might change. Duration caching
4695 * should be done at a higher level. */
4697 gst_pad_peer_query_duration (basesink->sinkpad, GST_FORMAT_BYTES,
4700 basesink->segment.duration = uduration;
4701 if (format != GST_FORMAT_BYTES) {
4702 /* convert to the requested format */
4704 gst_pad_query_convert (basesink->sinkpad, GST_FORMAT_BYTES,
4705 uduration, format, dur);
4719 default_element_query (GstElement * element, GstQuery * query)
4721 gboolean res = FALSE;
4723 GstBaseSink *basesink = GST_BASE_SINK (element);
4725 switch (GST_QUERY_TYPE (query)) {
4726 case GST_QUERY_POSITION:
4730 gboolean upstream = FALSE;
4732 gst_query_parse_position (query, &format, NULL);
4734 GST_DEBUG_OBJECT (basesink, "position query in format %s",
4735 gst_format_get_name (format));
4737 /* first try to get the position based on the clock */
4739 gst_base_sink_get_position (basesink, format, &cur, &upstream))) {
4740 gst_query_set_position (query, format, cur);
4741 } else if (upstream) {
4742 /* fallback to peer query */
4743 res = gst_pad_peer_query (basesink->sinkpad, query);
4746 /* we can handle a few things if upstream failed */
4747 if (format == GST_FORMAT_PERCENT) {
4750 res = gst_base_sink_get_position (basesink, GST_FORMAT_TIME, &cur,
4752 if (!res && upstream) {
4754 gst_pad_peer_query_position (basesink->sinkpad, GST_FORMAT_TIME,
4758 res = gst_base_sink_get_duration (basesink, GST_FORMAT_TIME, &dur,
4760 if (!res && upstream) {
4762 gst_pad_peer_query_duration (basesink->sinkpad,
4763 GST_FORMAT_TIME, &dur);
4769 pos = gst_util_uint64_scale (100 * GST_FORMAT_PERCENT_SCALE, cur,
4771 gst_query_set_position (query, GST_FORMAT_PERCENT, pos);
4777 case GST_QUERY_DURATION:
4781 gboolean upstream = FALSE;
4783 gst_query_parse_duration (query, &format, NULL);
4785 GST_DEBUG_OBJECT (basesink, "duration query in format %s",
4786 gst_format_get_name (format));
4789 gst_base_sink_get_duration (basesink, format, &dur, &upstream))) {
4790 gst_query_set_duration (query, format, dur);
4791 } else if (upstream) {
4792 /* fallback to peer query */
4793 res = gst_pad_peer_query (basesink->sinkpad, query);
4796 /* we can handle a few things if upstream failed */
4797 if (format == GST_FORMAT_PERCENT) {
4798 gst_query_set_duration (query, GST_FORMAT_PERCENT,
4799 GST_FORMAT_PERCENT_MAX);
4805 case GST_QUERY_LATENCY:
4807 gboolean live, us_live;
4808 GstClockTime min, max;
4810 if ((res = gst_base_sink_query_latency (basesink, &live, &us_live, &min,
4812 gst_query_set_latency (query, live, min, max);
4816 case GST_QUERY_JITTER:
4818 case GST_QUERY_RATE:
4819 /* gst_query_set_rate (query, basesink->segment_rate); */
4822 case GST_QUERY_SEGMENT:
4824 if (basesink->pad_mode == GST_PAD_MODE_PULL) {
4825 gst_query_set_segment (query, basesink->segment.rate,
4826 GST_FORMAT_TIME, basesink->segment.start, basesink->segment.stop);
4829 res = gst_pad_peer_query (basesink->sinkpad, query);
4833 case GST_QUERY_SEEKING:
4834 case GST_QUERY_CONVERT:
4835 case GST_QUERY_FORMATS:
4837 res = gst_pad_peer_query (basesink->sinkpad, query);
4840 GST_DEBUG_OBJECT (basesink, "query %s returns %d",
4841 GST_QUERY_TYPE_NAME (query), res);
4847 default_sink_query (GstBaseSink * basesink, GstQuery * query)
4850 GstBaseSinkClass *bclass;
4852 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4854 switch (GST_QUERY_TYPE (query)) {
4855 case GST_QUERY_ALLOCATION:
4857 if (bclass->propose_allocation)
4858 res = bclass->propose_allocation (basesink, query);
4863 case GST_QUERY_CAPS:
4865 GstCaps *caps, *filter;
4867 gst_query_parse_caps (query, &filter);
4868 caps = gst_base_sink_query_caps (basesink, basesink->sinkpad, filter);
4869 gst_query_set_caps_result (query, caps);
4870 gst_caps_unref (caps);
4876 gst_pad_query_default (basesink->sinkpad, GST_OBJECT_CAST (basesink),
4884 gst_base_sink_sink_query (GstPad * pad, GstObject * parent, GstQuery * query)
4886 GstBaseSink *basesink;
4887 GstBaseSinkClass *bclass;
4890 basesink = GST_BASE_SINK_CAST (parent);
4891 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4894 res = bclass->query (basesink, query);
4901 static GstStateChangeReturn
4902 gst_base_sink_change_state (GstElement * element, GstStateChange transition)
4904 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
4905 GstBaseSink *basesink = GST_BASE_SINK (element);
4906 GstBaseSinkClass *bclass;
4907 GstBaseSinkPrivate *priv;
4909 priv = basesink->priv;
4911 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4913 switch (transition) {
4914 case GST_STATE_CHANGE_NULL_TO_READY:
4916 if (!bclass->start (basesink))
4919 case GST_STATE_CHANGE_READY_TO_PAUSED:
4920 /* need to complete preroll before this state change completes, there
4921 * is no data flow in READY so we can safely assume we need to preroll. */
4922 GST_BASE_SINK_PREROLL_LOCK (basesink);
4923 GST_DEBUG_OBJECT (basesink, "READY to PAUSED");
4924 basesink->have_newsegment = FALSE;
4925 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
4926 gst_segment_init (&basesink->clip_segment, GST_FORMAT_UNDEFINED);
4927 basesink->offset = 0;
4928 basesink->have_preroll = FALSE;
4929 priv->step_unlock = FALSE;
4930 basesink->need_preroll = TRUE;
4931 basesink->playing_async = TRUE;
4932 basesink->priv->reset_time = FALSE;
4933 priv->current_sstart = GST_CLOCK_TIME_NONE;
4934 priv->current_sstop = GST_CLOCK_TIME_NONE;
4935 priv->eos_rtime = GST_CLOCK_TIME_NONE;
4937 basesink->eos = FALSE;
4938 priv->received_eos = FALSE;
4939 gst_base_sink_reset_qos (basesink);
4940 priv->commited = FALSE;
4941 priv->call_preroll = TRUE;
4942 priv->current_step.valid = FALSE;
4943 priv->pending_step.valid = FALSE;
4944 if (priv->async_enabled) {
4945 GST_DEBUG_OBJECT (basesink, "doing async state change");
4946 /* when async enabled, post async-start message and return ASYNC from
4947 * the state change function */
4948 ret = GST_STATE_CHANGE_ASYNC;
4949 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4950 gst_message_new_async_start (GST_OBJECT_CAST (basesink)));
4952 priv->have_latency = TRUE;
4954 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4956 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
4957 GST_BASE_SINK_PREROLL_LOCK (basesink);
4958 g_atomic_int_set (&basesink->priv->to_playing, TRUE);
4959 if (!gst_base_sink_needs_preroll (basesink)) {
4960 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, don't need preroll");
4961 /* no preroll needed anymore now. */
4962 basesink->playing_async = FALSE;
4963 basesink->need_preroll = FALSE;
4964 if (basesink->eos) {
4965 GstMessage *message;
4967 /* need to post EOS message here */
4968 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
4969 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
4970 gst_message_set_seqnum (message, basesink->priv->seqnum);
4971 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
4973 GST_DEBUG_OBJECT (basesink, "signal preroll");
4974 GST_BASE_SINK_PREROLL_SIGNAL (basesink);
4977 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, we are not prerolled");
4978 basesink->need_preroll = TRUE;
4979 basesink->playing_async = TRUE;
4980 priv->call_preroll = TRUE;
4981 priv->commited = FALSE;
4982 if (priv->async_enabled) {
4983 GST_DEBUG_OBJECT (basesink, "doing async state change");
4984 ret = GST_STATE_CHANGE_ASYNC;
4985 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4986 gst_message_new_async_start (GST_OBJECT_CAST (basesink)));
4989 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4996 GstStateChangeReturn bret;
4998 bret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
4999 if (G_UNLIKELY (bret == GST_STATE_CHANGE_FAILURE))
5000 goto activate_failed;
5003 switch (transition) {
5004 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
5005 /* completed transition, so need not be marked any longer
5006 * And it should be unmarked, since e.g. losing our position upon flush
5007 * does not really change state to PAUSED ... */
5008 g_atomic_int_set (&basesink->priv->to_playing, FALSE);
5010 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
5011 g_atomic_int_set (&basesink->priv->to_playing, FALSE);
5012 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED");
5013 /* FIXME, make sure we cannot enter _render first */
5015 /* we need to call ::unlock before locking PREROLL_LOCK
5016 * since we lock it before going into ::render */
5018 bclass->unlock (basesink);
5020 GST_BASE_SINK_PREROLL_LOCK (basesink);
5021 GST_DEBUG_OBJECT (basesink, "got preroll lock");
5022 /* now that we have the PREROLL lock, clear our unlock request */
5023 if (bclass->unlock_stop)
5024 bclass->unlock_stop (basesink);
5026 /* we need preroll again and we set the flag before unlocking the clockid
5027 * because if the clockid is unlocked before a current buffer expired, we
5028 * can use that buffer to preroll with */
5029 basesink->need_preroll = TRUE;
5031 if (basesink->clock_id) {
5032 GST_DEBUG_OBJECT (basesink, "unschedule clock");
5033 gst_clock_id_unschedule (basesink->clock_id);
5036 /* if we don't have a preroll buffer we need to wait for a preroll and
5038 if (!gst_base_sink_needs_preroll (basesink)) {
5039 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED, we are prerolled");
5040 basesink->playing_async = FALSE;
5042 if (GST_STATE_TARGET (GST_ELEMENT (basesink)) <= GST_STATE_READY) {
5043 GST_DEBUG_OBJECT (basesink, "element is <= READY");
5044 ret = GST_STATE_CHANGE_SUCCESS;
5046 GST_DEBUG_OBJECT (basesink,
5047 "PLAYING to PAUSED, we are not prerolled");
5048 basesink->playing_async = TRUE;
5049 priv->commited = FALSE;
5050 priv->call_preroll = TRUE;
5051 if (priv->async_enabled) {
5052 GST_DEBUG_OBJECT (basesink, "doing async state change");
5053 ret = GST_STATE_CHANGE_ASYNC;
5054 gst_element_post_message (GST_ELEMENT_CAST (basesink),
5055 gst_message_new_async_start (GST_OBJECT_CAST (basesink)));
5059 GST_DEBUG_OBJECT (basesink, "rendered: %" G_GUINT64_FORMAT
5060 ", dropped: %" G_GUINT64_FORMAT, priv->rendered, priv->dropped);
5062 gst_base_sink_reset_qos (basesink);
5063 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
5065 case GST_STATE_CHANGE_PAUSED_TO_READY:
5066 GST_BASE_SINK_PREROLL_LOCK (basesink);
5067 /* start by resetting our position state with the object lock so that the
5068 * position query gets the right idea. We do this before we post the
5069 * messages so that the message handlers pick this up. */
5070 GST_OBJECT_LOCK (basesink);
5071 basesink->have_newsegment = FALSE;
5072 priv->current_sstart = GST_CLOCK_TIME_NONE;
5073 priv->current_sstop = GST_CLOCK_TIME_NONE;
5074 priv->have_latency = FALSE;
5075 if (priv->cached_clock_id) {
5076 gst_clock_id_unref (priv->cached_clock_id);
5077 priv->cached_clock_id = NULL;
5079 GST_OBJECT_UNLOCK (basesink);
5081 gst_base_sink_set_last_buffer (basesink, NULL);
5082 priv->call_preroll = FALSE;
5084 if (!priv->commited) {
5085 if (priv->async_enabled) {
5086 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, posting async-done");
5088 gst_element_post_message (GST_ELEMENT_CAST (basesink),
5089 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
5090 GST_STATE_PLAYING, GST_STATE_PAUSED, GST_STATE_READY));
5092 gst_element_post_message (GST_ELEMENT_CAST (basesink),
5093 gst_message_new_async_done (GST_OBJECT_CAST (basesink), FALSE));
5095 priv->commited = TRUE;
5097 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, don't need_preroll");
5099 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
5101 case GST_STATE_CHANGE_READY_TO_NULL:
5103 if (!bclass->stop (basesink)) {
5104 GST_WARNING_OBJECT (basesink, "failed to stop");
5107 gst_base_sink_set_last_buffer (basesink, NULL);
5108 priv->call_preroll = FALSE;
5119 GST_DEBUG_OBJECT (basesink, "failed to start");
5120 return GST_STATE_CHANGE_FAILURE;
5124 GST_DEBUG_OBJECT (basesink,
5125 "element failed to change states -- activation problem?");
5126 return GST_STATE_CHANGE_FAILURE;