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, #GstBaseSource
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 base_init function, like so:
42 * my_element_base_init (gpointer g_class)
44 * GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
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 * #GstBaseSink::preroll vmethod with this preroll buffer and will then commit
59 * 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 ::get_times. If this function returns
63 * #GST_CLOCK_TIME_NONE for the start time, no synchronisation will be done.
64 * Synchronisation can be disabled entirely by setting the object "sync"
67 * After synchronisation the virtual method #GstBaseSink::render will be called.
68 * Subclasses should minimally implement this method.
70 * Since 0.10.3 subclasses that synchronise on the clock in the ::render method
71 * are supported as well. These classes typically receive a buffer in the render
72 * method and can then potentially block on the clock while rendering. A typical
73 * example is an audiosink. Since 0.10.11 these subclasses can use
74 * gst_base_sink_wait_preroll() to perform the blocking wait.
76 * Upon receiving the EOS event in the PLAYING state, #GstBaseSink will wait
77 * for the clock to reach the time indicated by the stop time of the last
78 * ::get_times call before posting an EOS message. When the element receives
79 * EOS in PAUSED, preroll completes, the event is queued and an EOS message is
80 * posted when going to PLAYING.
82 * #GstBaseSink will internally use the #GST_EVENT_NEWSEGMENT events to schedule
83 * synchronisation and clipping of buffers. Buffers that fall completely outside
84 * of the current segment are dropped. Buffers that fall partially in the
85 * segment are rendered (and prerolled). Subclasses should do any subbuffer
86 * clipping themselves when needed.
88 * #GstBaseSink will by default report the current playback position in
89 * #GST_FORMAT_TIME based on the current clock time and segment information.
90 * If no clock has been set on the element, the query will be forwarded
93 * The ::set_caps function will be called when the subclass should configure
94 * itself to process a specific media type.
96 * The ::start and ::stop virtual methods will be called when resources should
97 * be allocated. Any ::preroll, ::render and ::set_caps function will be
98 * called between the ::start and ::stop calls.
100 * The ::event virtual method will be called when an event is received by
101 * #GstBaseSink. Normally this method should only be overriden by very specific
102 * elements (such as file sinks) which need to handle the newsegment event
105 * #GstBaseSink provides an overridable ::buffer_alloc function that can be
106 * used by sinks that want to do reverse negotiation or to provide
107 * custom buffers (hardware buffers for example) to upstream elements.
109 * The ::unlock method is called when the elements should unblock any blocking
110 * operations they perform in the ::render method. This is mostly useful when
111 * the ::render method performs a blocking write on a file descriptor, for
114 * The max-lateness property affects how the sink deals with buffers that
115 * arrive too late in the sink. A buffer arrives too late in the sink when
116 * the presentation time (as a combination of the last segment, buffer
117 * timestamp and element base_time) plus the duration is before the current
119 * If the frame is later than max-lateness, the sink will drop the buffer
120 * without calling the render method.
121 * This feature is disabled if sync is disabled, the ::get-times method does
122 * not return a valid start time or max-lateness is set to -1 (the default).
123 * Subclasses can use gst_base_sink_set_max_lateness() to configure the
124 * max-lateness value.
126 * The qos property will enable the quality-of-service features of the basesink
127 * which gather statistics about the real-time performance of the clock
128 * synchronisation. For each buffer received in the sink, statistics are
129 * gathered and a QOS event is sent upstream with these numbers. This
130 * information can then be used by upstream elements to reduce their processing
133 * Since 0.10.15 the async property can be used to instruct the sink to never
134 * perform an ASYNC state change. This feature is mostly usable when dealing
135 * with non-synchronized streams or sparse streams.
137 * Last reviewed on 2007-08-29 (0.10.15)
144 #include "gstbasesink.h"
145 #include <gst/gstmarshal.h>
146 #include <gst/gst_private.h>
147 #include <gst/gst-i18n-lib.h>
149 GST_DEBUG_CATEGORY_STATIC (gst_base_sink_debug);
150 #define GST_CAT_DEFAULT gst_base_sink_debug
152 #define GST_BASE_SINK_GET_PRIVATE(obj) \
153 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_BASE_SINK, GstBaseSinkPrivate))
155 #define GST_FLOW_STEP GST_FLOW_CUSTOM_ERROR
159 gboolean valid; /* if this info is valid */
160 guint32 seqnum; /* the seqnum of the STEP event */
161 GstFormat format; /* the format of the amount */
162 guint64 amount; /* the total amount of data to skip */
163 guint64 position; /* the position in the stepped data */
164 guint64 duration; /* the duration in time of the skipped data */
165 guint64 start; /* running_time of the start */
166 gdouble rate; /* rate of skipping */
167 gdouble start_rate; /* rate before skipping */
168 guint64 start_start; /* start position skipping */
169 guint64 start_stop; /* stop position skipping */
170 gboolean flush; /* if this was a flushing step */
171 gboolean intermediate; /* if this is an intermediate step */
172 gboolean need_preroll; /* if we need preroll after this step */
175 /* FIXME, some stuff in ABI.data and other in Private...
176 * Make up your mind please.
178 struct _GstBaseSinkPrivate
180 gint qos_enabled; /* ATOMIC */
181 gboolean async_enabled;
182 GstClockTimeDiff ts_offset;
183 GstClockTime render_delay;
185 /* start, stop of current buffer, stream time, used to report position */
186 GstClockTime current_sstart;
187 GstClockTime current_sstop;
189 /* start, stop and jitter of current buffer, running time */
190 GstClockTime current_rstart;
191 GstClockTime current_rstop;
192 GstClockTimeDiff current_jitter;
194 /* EOS sync time in running time */
195 GstClockTime eos_rtime;
197 /* last buffer that arrived in time, running time */
198 GstClockTime last_in_time;
199 /* when the last buffer left the sink, running time */
200 GstClockTime last_left;
202 /* running averages go here these are done on running time */
204 GstClockTime avg_duration;
207 /* these are done on system time. avg_jitter and avg_render are
208 * compared to eachother to see if the rendering time takes a
209 * huge amount of the processing, If so we are flooded with
211 GstClockTime last_left_systime;
212 GstClockTime avg_jitter;
213 GstClockTime start, stop;
214 GstClockTime avg_render;
216 /* number of rendered and dropped frames */
221 GstClockTime latency;
223 /* if we already commited the state */
226 /* when we received EOS */
227 gboolean received_eos;
229 /* when we are prerolled and able to report latency */
230 gboolean have_latency;
232 /* the last buffer we prerolled or rendered. Useful for making snapshots */
233 GstBuffer *last_buffer;
235 /* caps for pull based scheduling */
238 /* blocksize for pulling */
243 /* seqnum of the stream */
246 gboolean call_preroll;
247 gboolean step_unlock;
249 /* we have a pending and a current step operation */
250 GstStepInfo current_step;
251 GstStepInfo pending_step;
254 #define DO_RUNNING_AVG(avg,val,size) (((val) + ((size)-1) * (avg)) / (size))
256 /* generic running average, this has a neutral window size */
257 #define UPDATE_RUNNING_AVG(avg,val) DO_RUNNING_AVG(avg,val,8)
259 /* the windows for these running averages are experimentally obtained.
260 * possitive values get averaged more while negative values use a small
261 * window so we can react faster to badness. */
262 #define UPDATE_RUNNING_AVG_P(avg,val) DO_RUNNING_AVG(avg,val,16)
263 #define UPDATE_RUNNING_AVG_N(avg,val) DO_RUNNING_AVG(avg,val,4)
265 /* BaseSink properties */
267 #define DEFAULT_CAN_ACTIVATE_PULL FALSE /* fixme: enable me */
268 #define DEFAULT_CAN_ACTIVATE_PUSH TRUE
270 #define DEFAULT_PREROLL_QUEUE_LEN 0
271 #define DEFAULT_SYNC TRUE
272 #define DEFAULT_MAX_LATENESS -1
273 #define DEFAULT_QOS FALSE
274 #define DEFAULT_ASYNC TRUE
275 #define DEFAULT_TS_OFFSET 0
276 #define DEFAULT_BLOCKSIZE 4096
277 #define DEFAULT_RENDER_DELAY 0
282 PROP_PREROLL_QUEUE_LEN,
294 static GstElementClass *parent_class = NULL;
296 static void gst_base_sink_class_init (GstBaseSinkClass * klass);
297 static void gst_base_sink_init (GstBaseSink * trans, gpointer g_class);
298 static void gst_base_sink_finalize (GObject * object);
301 gst_base_sink_get_type (void)
303 static volatile gsize base_sink_type = 0;
305 if (g_once_init_enter (&base_sink_type)) {
307 static const GTypeInfo base_sink_info = {
308 sizeof (GstBaseSinkClass),
311 (GClassInitFunc) gst_base_sink_class_init,
314 sizeof (GstBaseSink),
316 (GInstanceInitFunc) gst_base_sink_init,
319 _type = g_type_register_static (GST_TYPE_ELEMENT,
320 "GstBaseSink", &base_sink_info, G_TYPE_FLAG_ABSTRACT);
321 g_once_init_leave (&base_sink_type, _type);
323 return base_sink_type;
326 static void gst_base_sink_set_property (GObject * object, guint prop_id,
327 const GValue * value, GParamSpec * pspec);
328 static void gst_base_sink_get_property (GObject * object, guint prop_id,
329 GValue * value, GParamSpec * pspec);
331 static gboolean gst_base_sink_send_event (GstElement * element,
333 static gboolean gst_base_sink_query (GstElement * element, GstQuery * query);
335 static GstCaps *gst_base_sink_get_caps (GstBaseSink * sink);
336 static gboolean gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps);
337 static GstFlowReturn gst_base_sink_buffer_alloc (GstBaseSink * sink,
338 guint64 offset, guint size, GstCaps * caps, GstBuffer ** buf);
339 static void gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
340 GstClockTime * start, GstClockTime * end);
341 static gboolean gst_base_sink_set_flushing (GstBaseSink * basesink,
342 GstPad * pad, gboolean flushing);
343 static gboolean gst_base_sink_default_activate_pull (GstBaseSink * basesink,
345 static gboolean gst_base_sink_default_do_seek (GstBaseSink * sink,
346 GstSegment * segment);
347 static gboolean gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
348 GstEvent * event, GstSegment * segment);
350 static GstStateChangeReturn gst_base_sink_change_state (GstElement * element,
351 GstStateChange transition);
353 static GstFlowReturn gst_base_sink_chain (GstPad * pad, GstBuffer * buffer);
354 static GstFlowReturn gst_base_sink_chain_list (GstPad * pad,
355 GstBufferList * list);
357 static void gst_base_sink_loop (GstPad * pad);
358 static gboolean gst_base_sink_pad_activate (GstPad * pad);
359 static gboolean gst_base_sink_pad_activate_push (GstPad * pad, gboolean active);
360 static gboolean gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active);
361 static gboolean gst_base_sink_event (GstPad * pad, GstEvent * event);
362 static gboolean gst_base_sink_peer_query (GstBaseSink * sink, GstQuery * query);
364 static gboolean gst_base_sink_negotiate_pull (GstBaseSink * basesink);
366 /* check if an object was too late */
367 static gboolean gst_base_sink_is_too_late (GstBaseSink * basesink,
368 GstMiniObject * obj, GstClockTime start, GstClockTime stop,
369 GstClockReturn status, GstClockTimeDiff jitter);
370 static GstFlowReturn gst_base_sink_preroll_object (GstBaseSink * basesink,
371 gboolean is_list, GstMiniObject * obj);
374 gst_base_sink_class_init (GstBaseSinkClass * klass)
376 GObjectClass *gobject_class;
377 GstElementClass *gstelement_class;
379 gobject_class = G_OBJECT_CLASS (klass);
380 gstelement_class = GST_ELEMENT_CLASS (klass);
382 GST_DEBUG_CATEGORY_INIT (gst_base_sink_debug, "basesink", 0,
385 g_type_class_add_private (klass, sizeof (GstBaseSinkPrivate));
387 parent_class = g_type_class_peek_parent (klass);
389 gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_base_sink_finalize);
390 gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_base_sink_set_property);
391 gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_base_sink_get_property);
393 /* FIXME, this next value should be configured using an event from the
394 * upstream element, ie, the BUFFER_SIZE event. */
395 g_object_class_install_property (gobject_class, PROP_PREROLL_QUEUE_LEN,
396 g_param_spec_uint ("preroll-queue-len", "Preroll queue length",
397 "Number of buffers to queue during preroll", 0, G_MAXUINT,
398 DEFAULT_PREROLL_QUEUE_LEN,
399 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
401 g_object_class_install_property (gobject_class, PROP_SYNC,
402 g_param_spec_boolean ("sync", "Sync", "Sync on the clock", DEFAULT_SYNC,
403 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
405 g_object_class_install_property (gobject_class, PROP_MAX_LATENESS,
406 g_param_spec_int64 ("max-lateness", "Max Lateness",
407 "Maximum number of nanoseconds that a buffer can be late before it "
408 "is dropped (-1 unlimited)", -1, G_MAXINT64, DEFAULT_MAX_LATENESS,
409 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
411 g_object_class_install_property (gobject_class, PROP_QOS,
412 g_param_spec_boolean ("qos", "Qos",
413 "Generate Quality-of-Service events upstream", DEFAULT_QOS,
414 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
418 * If set to #TRUE, the basesink will perform asynchronous state changes.
419 * When set to #FALSE, the sink will not signal the parent when it prerolls.
420 * Use this option when dealing with sparse streams or when synchronisation is
425 g_object_class_install_property (gobject_class, PROP_ASYNC,
426 g_param_spec_boolean ("async", "Async",
427 "Go asynchronously to PAUSED", DEFAULT_ASYNC,
428 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
430 * GstBaseSink:ts-offset
432 * Controls the final synchronisation, a negative value will render the buffer
433 * earlier while a positive value delays playback. This property can be
434 * used to fix synchronisation in bad files.
438 g_object_class_install_property (gobject_class, PROP_TS_OFFSET,
439 g_param_spec_int64 ("ts-offset", "TS Offset",
440 "Timestamp offset in nanoseconds", G_MININT64, G_MAXINT64,
441 DEFAULT_TS_OFFSET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
443 * GstBaseSink:last-buffer
445 * The last buffer that arrived in the sink and was used for preroll or for
446 * rendering. This property can be used to generate thumbnails. This property
447 * can be NULL when the sink has not yet received a bufer.
451 g_object_class_install_property (gobject_class, PROP_LAST_BUFFER,
452 gst_param_spec_mini_object ("last-buffer", "Last Buffer",
453 "The last buffer received in the sink", GST_TYPE_BUFFER,
454 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
456 * GstBaseSink:blocksize
458 * The amount of bytes to pull when operating in pull mode.
462 g_object_class_install_property (gobject_class, PROP_BLOCKSIZE,
463 g_param_spec_uint ("blocksize", "Block size",
464 "Size in bytes to pull per buffer (0 = default)", 0, G_MAXUINT,
465 DEFAULT_BLOCKSIZE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
467 * GstBaseSink:render-delay
469 * The additional delay between synchronisation and actual rendering of the
470 * media. This property will add additional latency to the device in order to
471 * make other sinks compensate for the delay.
475 g_object_class_install_property (gobject_class, PROP_RENDER_DELAY,
476 g_param_spec_uint64 ("render-delay", "Render Delay",
477 "Additional render delay of the sink in nanoseconds", 0, G_MAXUINT64,
478 DEFAULT_RENDER_DELAY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
480 gstelement_class->change_state =
481 GST_DEBUG_FUNCPTR (gst_base_sink_change_state);
482 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_base_sink_send_event);
483 gstelement_class->query = GST_DEBUG_FUNCPTR (gst_base_sink_query);
485 klass->get_caps = GST_DEBUG_FUNCPTR (gst_base_sink_get_caps);
486 klass->set_caps = GST_DEBUG_FUNCPTR (gst_base_sink_set_caps);
487 klass->buffer_alloc = GST_DEBUG_FUNCPTR (gst_base_sink_buffer_alloc);
488 klass->get_times = GST_DEBUG_FUNCPTR (gst_base_sink_get_times);
489 klass->activate_pull =
490 GST_DEBUG_FUNCPTR (gst_base_sink_default_activate_pull);
494 gst_base_sink_pad_getcaps (GstPad * pad)
496 GstBaseSinkClass *bclass;
498 GstCaps *caps = NULL;
500 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
501 bclass = GST_BASE_SINK_GET_CLASS (bsink);
503 if (bsink->pad_mode == GST_ACTIVATE_PULL) {
504 /* if we are operating in pull mode we only accept the negotiated caps */
505 GST_OBJECT_LOCK (pad);
506 if ((caps = GST_PAD_CAPS (pad)))
508 GST_OBJECT_UNLOCK (pad);
511 if (bclass->get_caps)
512 caps = bclass->get_caps (bsink);
515 GstPadTemplate *pad_template;
518 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass),
520 if (pad_template != NULL) {
521 caps = gst_caps_ref (gst_pad_template_get_caps (pad_template));
525 gst_object_unref (bsink);
531 gst_base_sink_pad_setcaps (GstPad * pad, GstCaps * caps)
533 GstBaseSinkClass *bclass;
537 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
538 bclass = GST_BASE_SINK_GET_CLASS (bsink);
540 if (res && bclass->set_caps)
541 res = bclass->set_caps (bsink, caps);
543 gst_object_unref (bsink);
549 gst_base_sink_pad_fixate (GstPad * pad, GstCaps * caps)
551 GstBaseSinkClass *bclass;
554 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
555 bclass = GST_BASE_SINK_GET_CLASS (bsink);
558 bclass->fixate (bsink, caps);
560 gst_object_unref (bsink);
564 gst_base_sink_pad_buffer_alloc (GstPad * pad, guint64 offset, guint size,
565 GstCaps * caps, GstBuffer ** buf)
567 GstBaseSinkClass *bclass;
569 GstFlowReturn result = GST_FLOW_OK;
571 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
572 bclass = GST_BASE_SINK_GET_CLASS (bsink);
574 if (bclass->buffer_alloc)
575 result = bclass->buffer_alloc (bsink, offset, size, caps, buf);
577 *buf = NULL; /* fallback in gstpad.c will allocate generic buffer */
579 gst_object_unref (bsink);
585 gst_base_sink_init (GstBaseSink * basesink, gpointer g_class)
587 GstPadTemplate *pad_template;
588 GstBaseSinkPrivate *priv;
590 basesink->priv = priv = GST_BASE_SINK_GET_PRIVATE (basesink);
593 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "sink");
594 g_return_if_fail (pad_template != NULL);
596 basesink->sinkpad = gst_pad_new_from_template (pad_template, "sink");
598 gst_pad_set_getcaps_function (basesink->sinkpad,
599 GST_DEBUG_FUNCPTR (gst_base_sink_pad_getcaps));
600 gst_pad_set_setcaps_function (basesink->sinkpad,
601 GST_DEBUG_FUNCPTR (gst_base_sink_pad_setcaps));
602 gst_pad_set_fixatecaps_function (basesink->sinkpad,
603 GST_DEBUG_FUNCPTR (gst_base_sink_pad_fixate));
604 gst_pad_set_bufferalloc_function (basesink->sinkpad,
605 GST_DEBUG_FUNCPTR (gst_base_sink_pad_buffer_alloc));
606 gst_pad_set_activate_function (basesink->sinkpad,
607 GST_DEBUG_FUNCPTR (gst_base_sink_pad_activate));
608 gst_pad_set_activatepush_function (basesink->sinkpad,
609 GST_DEBUG_FUNCPTR (gst_base_sink_pad_activate_push));
610 gst_pad_set_activatepull_function (basesink->sinkpad,
611 GST_DEBUG_FUNCPTR (gst_base_sink_pad_activate_pull));
612 gst_pad_set_event_function (basesink->sinkpad,
613 GST_DEBUG_FUNCPTR (gst_base_sink_event));
614 gst_pad_set_chain_function (basesink->sinkpad,
615 GST_DEBUG_FUNCPTR (gst_base_sink_chain));
616 gst_pad_set_chain_list_function (basesink->sinkpad,
617 GST_DEBUG_FUNCPTR (gst_base_sink_chain_list));
618 gst_element_add_pad (GST_ELEMENT_CAST (basesink), basesink->sinkpad);
620 basesink->pad_mode = GST_ACTIVATE_NONE;
621 basesink->preroll_queue = g_queue_new ();
622 basesink->abidata.ABI.clip_segment = gst_segment_new ();
623 priv->have_latency = FALSE;
625 basesink->can_activate_push = DEFAULT_CAN_ACTIVATE_PUSH;
626 basesink->can_activate_pull = DEFAULT_CAN_ACTIVATE_PULL;
628 basesink->sync = DEFAULT_SYNC;
629 basesink->abidata.ABI.max_lateness = DEFAULT_MAX_LATENESS;
630 g_atomic_int_set (&priv->qos_enabled, DEFAULT_QOS);
631 priv->async_enabled = DEFAULT_ASYNC;
632 priv->ts_offset = DEFAULT_TS_OFFSET;
633 priv->render_delay = DEFAULT_RENDER_DELAY;
634 priv->blocksize = DEFAULT_BLOCKSIZE;
636 GST_OBJECT_FLAG_SET (basesink, GST_ELEMENT_IS_SINK);
640 gst_base_sink_finalize (GObject * object)
642 GstBaseSink *basesink;
644 basesink = GST_BASE_SINK (object);
646 g_queue_free (basesink->preroll_queue);
647 gst_segment_free (basesink->abidata.ABI.clip_segment);
649 G_OBJECT_CLASS (parent_class)->finalize (object);
653 * gst_base_sink_set_sync:
655 * @sync: the new sync value.
657 * Configures @sink to synchronize on the clock or not. When
658 * @sync is FALSE, incomming samples will be played as fast as
659 * possible. If @sync is TRUE, the timestamps of the incomming
660 * buffers will be used to schedule the exact render time of its
666 gst_base_sink_set_sync (GstBaseSink * sink, gboolean sync)
668 g_return_if_fail (GST_IS_BASE_SINK (sink));
670 GST_OBJECT_LOCK (sink);
672 GST_OBJECT_UNLOCK (sink);
676 * gst_base_sink_get_sync:
679 * Checks if @sink is currently configured to synchronize against the
682 * Returns: TRUE if the sink is configured to synchronize against the clock.
687 gst_base_sink_get_sync (GstBaseSink * sink)
691 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
693 GST_OBJECT_LOCK (sink);
695 GST_OBJECT_UNLOCK (sink);
701 * gst_base_sink_set_max_lateness:
703 * @max_lateness: the new max lateness value.
705 * Sets the new max lateness value to @max_lateness. This value is
706 * used to decide if a buffer should be dropped or not based on the
707 * buffer timestamp and the current clock time. A value of -1 means
713 gst_base_sink_set_max_lateness (GstBaseSink * sink, gint64 max_lateness)
715 g_return_if_fail (GST_IS_BASE_SINK (sink));
717 GST_OBJECT_LOCK (sink);
718 sink->abidata.ABI.max_lateness = max_lateness;
719 GST_OBJECT_UNLOCK (sink);
723 * gst_base_sink_get_max_lateness:
726 * Gets the max lateness value. See gst_base_sink_set_max_lateness for
729 * Returns: The maximum time in nanoseconds that a buffer can be late
730 * before it is dropped and not rendered. A value of -1 means an
736 gst_base_sink_get_max_lateness (GstBaseSink * sink)
740 g_return_val_if_fail (GST_IS_BASE_SINK (sink), -1);
742 GST_OBJECT_LOCK (sink);
743 res = sink->abidata.ABI.max_lateness;
744 GST_OBJECT_UNLOCK (sink);
750 * gst_base_sink_set_qos_enabled:
752 * @enabled: the new qos value.
754 * Configures @sink to send Quality-of-Service events upstream.
759 gst_base_sink_set_qos_enabled (GstBaseSink * sink, gboolean enabled)
761 g_return_if_fail (GST_IS_BASE_SINK (sink));
763 g_atomic_int_set (&sink->priv->qos_enabled, enabled);
767 * gst_base_sink_is_qos_enabled:
770 * Checks if @sink is currently configured to send Quality-of-Service events
773 * Returns: TRUE if the sink is configured to perform Quality-of-Service.
778 gst_base_sink_is_qos_enabled (GstBaseSink * sink)
782 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
784 res = g_atomic_int_get (&sink->priv->qos_enabled);
790 * gst_base_sink_set_async_enabled:
792 * @enabled: the new async value.
794 * Configures @sink to perform all state changes asynchronusly. When async is
795 * disabled, the sink will immediatly go to PAUSED instead of waiting for a
796 * preroll buffer. This feature is usefull if the sink does not synchronize
797 * against the clock or when it is dealing with sparse streams.
802 gst_base_sink_set_async_enabled (GstBaseSink * sink, gboolean enabled)
804 g_return_if_fail (GST_IS_BASE_SINK (sink));
806 GST_PAD_PREROLL_LOCK (sink->sinkpad);
807 sink->priv->async_enabled = enabled;
808 GST_LOG_OBJECT (sink, "set async enabled to %d", enabled);
809 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
813 * gst_base_sink_is_async_enabled:
816 * Checks if @sink is currently configured to perform asynchronous state
819 * Returns: TRUE if the sink is configured to perform asynchronous state
825 gst_base_sink_is_async_enabled (GstBaseSink * sink)
829 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
831 GST_PAD_PREROLL_LOCK (sink->sinkpad);
832 res = sink->priv->async_enabled;
833 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
839 * gst_base_sink_set_ts_offset:
841 * @offset: the new offset
843 * Adjust the synchronisation of @sink with @offset. A negative value will
844 * render buffers earlier than their timestamp. A positive value will delay
845 * rendering. This function can be used to fix playback of badly timestamped
851 gst_base_sink_set_ts_offset (GstBaseSink * sink, GstClockTimeDiff offset)
853 g_return_if_fail (GST_IS_BASE_SINK (sink));
855 GST_OBJECT_LOCK (sink);
856 sink->priv->ts_offset = offset;
857 GST_LOG_OBJECT (sink, "set time offset to %" G_GINT64_FORMAT, offset);
858 GST_OBJECT_UNLOCK (sink);
862 * gst_base_sink_get_ts_offset:
865 * Get the synchronisation offset of @sink.
867 * Returns: The synchronisation offset.
872 gst_base_sink_get_ts_offset (GstBaseSink * sink)
874 GstClockTimeDiff res;
876 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
878 GST_OBJECT_LOCK (sink);
879 res = sink->priv->ts_offset;
880 GST_OBJECT_UNLOCK (sink);
886 * gst_base_sink_get_last_buffer:
889 * Get the last buffer that arrived in the sink and was used for preroll or for
890 * rendering. This property can be used to generate thumbnails.
892 * The #GstCaps on the buffer can be used to determine the type of the buffer.
894 * Returns: a #GstBuffer. gst_buffer_unref() after usage. This function returns
895 * NULL when no buffer has arrived in the sink yet or when the sink is not in
901 gst_base_sink_get_last_buffer (GstBaseSink * sink)
905 g_return_val_if_fail (GST_IS_BASE_SINK (sink), NULL);
907 GST_OBJECT_LOCK (sink);
908 if ((res = sink->priv->last_buffer))
909 gst_buffer_ref (res);
910 GST_OBJECT_UNLOCK (sink);
916 gst_base_sink_set_last_buffer (GstBaseSink * sink, GstBuffer * buffer)
920 GST_OBJECT_LOCK (sink);
921 old = sink->priv->last_buffer;
922 if (G_LIKELY (old != buffer)) {
923 GST_DEBUG_OBJECT (sink, "setting last buffer to %p", buffer);
924 if (G_LIKELY (buffer))
925 gst_buffer_ref (buffer);
926 sink->priv->last_buffer = buffer;
930 GST_OBJECT_UNLOCK (sink);
932 /* avoid unreffing with the lock because cleanup code might want to take the
935 gst_buffer_unref (old);
939 * gst_base_sink_get_latency:
942 * Get the currently configured latency.
944 * Returns: The configured latency.
949 gst_base_sink_get_latency (GstBaseSink * sink)
953 GST_OBJECT_LOCK (sink);
954 res = sink->priv->latency;
955 GST_OBJECT_UNLOCK (sink);
961 * gst_base_sink_query_latency:
963 * @live: if the sink is live
964 * @upstream_live: if an upstream element is live
965 * @min_latency: the min latency of the upstream elements
966 * @max_latency: the max latency of the upstream elements
968 * Query the sink for the latency parameters. The latency will be queried from
969 * the upstream elements. @live will be TRUE if @sink is configured to
970 * synchronize against the clock. @upstream_live will be TRUE if an upstream
973 * If both @live and @upstream_live are TRUE, the sink will want to compensate
974 * for the latency introduced by the upstream elements by setting the
975 * @min_latency to a strictly possitive value.
977 * This function is mostly used by subclasses.
979 * Returns: TRUE if the query succeeded.
984 gst_base_sink_query_latency (GstBaseSink * sink, gboolean * live,
985 gboolean * upstream_live, GstClockTime * min_latency,
986 GstClockTime * max_latency)
988 gboolean l, us_live, res, have_latency;
989 GstClockTime min, max, render_delay;
991 GstClockTime us_min, us_max;
993 /* we are live when we sync to the clock */
994 GST_OBJECT_LOCK (sink);
996 have_latency = sink->priv->have_latency;
997 render_delay = sink->priv->render_delay;
998 GST_OBJECT_UNLOCK (sink);
1000 /* assume no latency */
1006 GST_DEBUG_OBJECT (sink, "we are ready for LATENCY query");
1007 /* we are ready for a latency query this is when we preroll or when we are
1009 query = gst_query_new_latency ();
1011 /* ask the peer for the latency */
1012 if ((res = gst_base_sink_peer_query (sink, query))) {
1013 /* get upstream min and max latency */
1014 gst_query_parse_latency (query, &us_live, &us_min, &us_max);
1017 /* upstream live, use its latency, subclasses should use these
1018 * values to create the complete latency. */
1023 /* we need to add the render delay if we are live */
1025 min += render_delay;
1027 max += render_delay;
1030 gst_query_unref (query);
1032 GST_DEBUG_OBJECT (sink, "we are not yet ready for LATENCY query");
1036 /* not live, we tried to do the query, if it failed we return TRUE anyway */
1040 GST_DEBUG_OBJECT (sink, "latency query failed but we are not live");
1042 GST_DEBUG_OBJECT (sink, "latency query failed and we are live");
1047 GST_DEBUG_OBJECT (sink, "latency query: live: %d, have_latency %d,"
1048 " upstream: %d, min %" GST_TIME_FORMAT ", max %" GST_TIME_FORMAT, l,
1049 have_latency, us_live, GST_TIME_ARGS (min), GST_TIME_ARGS (max));
1054 *upstream_live = us_live;
1064 * gst_base_sink_set_render_delay:
1065 * @sink: a #GstBaseSink
1066 * @delay: the new delay
1068 * Set the render delay in @sink to @delay. The render delay is the time
1069 * between actual rendering of a buffer and its synchronisation time. Some
1070 * devices might delay media rendering which can be compensated for with this
1073 * After calling this function, this sink will report additional latency and
1074 * other sinks will adjust their latency to delay the rendering of their media.
1076 * This function is usually called by subclasses.
1081 gst_base_sink_set_render_delay (GstBaseSink * sink, GstClockTime delay)
1083 GstClockTime old_render_delay;
1085 g_return_if_fail (GST_IS_BASE_SINK (sink));
1087 GST_OBJECT_LOCK (sink);
1088 old_render_delay = sink->priv->render_delay;
1089 sink->priv->render_delay = delay;
1090 GST_LOG_OBJECT (sink, "set render delay to %" GST_TIME_FORMAT,
1091 GST_TIME_ARGS (delay));
1092 GST_OBJECT_UNLOCK (sink);
1094 if (delay != old_render_delay) {
1095 GST_DEBUG_OBJECT (sink, "posting latency changed");
1096 gst_element_post_message (GST_ELEMENT_CAST (sink),
1097 gst_message_new_latency (GST_OBJECT_CAST (sink)));
1102 * gst_base_sink_get_render_delay:
1103 * @sink: a #GstBaseSink
1105 * Get the render delay of @sink. see gst_base_sink_set_render_delay() for more
1106 * information about the render delay.
1108 * Returns: the render delay of @sink.
1113 gst_base_sink_get_render_delay (GstBaseSink * sink)
1115 GstClockTimeDiff res;
1117 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1119 GST_OBJECT_LOCK (sink);
1120 res = sink->priv->render_delay;
1121 GST_OBJECT_UNLOCK (sink);
1127 * gst_base_sink_set_blocksize:
1128 * @sink: a #GstBaseSink
1129 * @blocksize: the blocksize in bytes
1131 * Set the number of bytes that the sink will pull when it is operating in pull
1137 gst_base_sink_set_blocksize (GstBaseSink * sink, guint blocksize)
1139 g_return_if_fail (GST_IS_BASE_SINK (sink));
1141 GST_OBJECT_LOCK (sink);
1142 sink->priv->blocksize = blocksize;
1143 GST_LOG_OBJECT (sink, "set blocksize to %u", blocksize);
1144 GST_OBJECT_UNLOCK (sink);
1148 * gst_base_sink_get_blocksize:
1149 * @sink: a #GstBaseSink
1151 * Get the number of bytes that the sink will pull when it is operating in pull
1154 * Returns: the number of bytes @sink will pull in pull mode.
1159 gst_base_sink_get_blocksize (GstBaseSink * sink)
1163 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1165 GST_OBJECT_LOCK (sink);
1166 res = sink->priv->blocksize;
1167 GST_OBJECT_UNLOCK (sink);
1173 gst_base_sink_set_property (GObject * object, guint prop_id,
1174 const GValue * value, GParamSpec * pspec)
1176 GstBaseSink *sink = GST_BASE_SINK (object);
1179 case PROP_PREROLL_QUEUE_LEN:
1180 /* preroll lock necessary to serialize with finish_preroll */
1181 GST_PAD_PREROLL_LOCK (sink->sinkpad);
1182 sink->preroll_queue_max_len = g_value_get_uint (value);
1183 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
1186 gst_base_sink_set_sync (sink, g_value_get_boolean (value));
1188 case PROP_MAX_LATENESS:
1189 gst_base_sink_set_max_lateness (sink, g_value_get_int64 (value));
1192 gst_base_sink_set_qos_enabled (sink, g_value_get_boolean (value));
1195 gst_base_sink_set_async_enabled (sink, g_value_get_boolean (value));
1197 case PROP_TS_OFFSET:
1198 gst_base_sink_set_ts_offset (sink, g_value_get_int64 (value));
1200 case PROP_BLOCKSIZE:
1201 gst_base_sink_set_blocksize (sink, g_value_get_uint (value));
1203 case PROP_RENDER_DELAY:
1204 gst_base_sink_set_render_delay (sink, g_value_get_uint64 (value));
1207 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1213 gst_base_sink_get_property (GObject * object, guint prop_id, GValue * value,
1216 GstBaseSink *sink = GST_BASE_SINK (object);
1219 case PROP_PREROLL_QUEUE_LEN:
1220 GST_PAD_PREROLL_LOCK (sink->sinkpad);
1221 g_value_set_uint (value, sink->preroll_queue_max_len);
1222 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
1225 g_value_set_boolean (value, gst_base_sink_get_sync (sink));
1227 case PROP_MAX_LATENESS:
1228 g_value_set_int64 (value, gst_base_sink_get_max_lateness (sink));
1231 g_value_set_boolean (value, gst_base_sink_is_qos_enabled (sink));
1234 g_value_set_boolean (value, gst_base_sink_is_async_enabled (sink));
1236 case PROP_TS_OFFSET:
1237 g_value_set_int64 (value, gst_base_sink_get_ts_offset (sink));
1239 case PROP_LAST_BUFFER:
1240 gst_value_take_buffer (value, gst_base_sink_get_last_buffer (sink));
1242 case PROP_BLOCKSIZE:
1243 g_value_set_uint (value, gst_base_sink_get_blocksize (sink));
1245 case PROP_RENDER_DELAY:
1246 g_value_set_uint64 (value, gst_base_sink_get_render_delay (sink));
1249 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1256 gst_base_sink_get_caps (GstBaseSink * sink)
1262 gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps)
1267 static GstFlowReturn
1268 gst_base_sink_buffer_alloc (GstBaseSink * sink, guint64 offset, guint size,
1269 GstCaps * caps, GstBuffer ** buf)
1275 /* with PREROLL_LOCK, STREAM_LOCK */
1277 gst_base_sink_preroll_queue_flush (GstBaseSink * basesink, GstPad * pad)
1281 GST_DEBUG_OBJECT (basesink, "flushing queue %p", basesink);
1282 while ((obj = g_queue_pop_head (basesink->preroll_queue))) {
1283 GST_DEBUG_OBJECT (basesink, "popped %p", obj);
1284 gst_mini_object_unref (obj);
1286 /* we can't have EOS anymore now */
1287 basesink->eos = FALSE;
1288 basesink->priv->received_eos = FALSE;
1289 basesink->have_preroll = FALSE;
1290 basesink->priv->step_unlock = FALSE;
1291 basesink->eos_queued = FALSE;
1292 basesink->preroll_queued = 0;
1293 basesink->buffers_queued = 0;
1294 basesink->events_queued = 0;
1295 /* can't report latency anymore until we preroll again */
1296 if (basesink->priv->async_enabled) {
1297 GST_OBJECT_LOCK (basesink);
1298 basesink->priv->have_latency = FALSE;
1299 GST_OBJECT_UNLOCK (basesink);
1301 /* and signal any waiters now */
1302 GST_PAD_PREROLL_SIGNAL (pad);
1305 /* with STREAM_LOCK, configures given segment with the event information. */
1307 gst_base_sink_configure_segment (GstBaseSink * basesink, GstPad * pad,
1308 GstEvent * event, GstSegment * segment)
1311 gdouble rate, arate;
1317 /* the newsegment event is needed to bring the buffer timestamps to the
1318 * stream time and to drop samples outside of the playback segment. */
1319 gst_event_parse_new_segment_full (event, &update, &rate, &arate, &format,
1320 &start, &stop, &time);
1322 /* The segment is protected with both the STREAM_LOCK and the OBJECT_LOCK.
1323 * We protect with the OBJECT_LOCK so that we can use the values to
1324 * safely answer a POSITION query. */
1325 GST_OBJECT_LOCK (basesink);
1326 gst_segment_set_newsegment_full (segment, update, rate, arate, format, start,
1329 if (format == GST_FORMAT_TIME) {
1330 GST_DEBUG_OBJECT (basesink,
1331 "configured NEWSEGMENT update %d, rate %lf, applied rate %lf, "
1332 "format GST_FORMAT_TIME, "
1333 "%" GST_TIME_FORMAT " -- %" GST_TIME_FORMAT
1334 ", time %" GST_TIME_FORMAT ", accum %" GST_TIME_FORMAT,
1335 update, rate, arate, GST_TIME_ARGS (segment->start),
1336 GST_TIME_ARGS (segment->stop), GST_TIME_ARGS (segment->time),
1337 GST_TIME_ARGS (segment->accum));
1339 GST_DEBUG_OBJECT (basesink,
1340 "configured NEWSEGMENT update %d, rate %lf, applied rate %lf, "
1342 "%" G_GINT64_FORMAT " -- %" G_GINT64_FORMAT ", time %"
1343 G_GINT64_FORMAT ", accum %" G_GINT64_FORMAT, update, rate, arate,
1344 segment->format, segment->start, segment->stop, segment->time,
1347 GST_OBJECT_UNLOCK (basesink);
1350 /* with PREROLL_LOCK, STREAM_LOCK */
1352 gst_base_sink_commit_state (GstBaseSink * basesink)
1354 /* commit state and proceed to next pending state */
1355 GstState current, next, pending, post_pending;
1356 gboolean post_paused = FALSE;
1357 gboolean post_async_done = FALSE;
1358 gboolean post_playing = FALSE;
1360 /* we are certainly not playing async anymore now */
1361 basesink->playing_async = FALSE;
1363 GST_OBJECT_LOCK (basesink);
1364 current = GST_STATE (basesink);
1365 next = GST_STATE_NEXT (basesink);
1366 pending = GST_STATE_PENDING (basesink);
1367 post_pending = pending;
1370 case GST_STATE_PLAYING:
1372 GstBaseSinkClass *bclass;
1373 GstStateChangeReturn ret;
1375 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1377 GST_DEBUG_OBJECT (basesink, "commiting state to PLAYING");
1379 basesink->need_preroll = FALSE;
1380 post_async_done = TRUE;
1381 basesink->priv->commited = TRUE;
1382 post_playing = TRUE;
1383 /* post PAUSED too when we were READY */
1384 if (current == GST_STATE_READY) {
1388 /* make sure we notify the subclass of async playing */
1389 if (bclass->async_play) {
1390 GST_WARNING_OBJECT (basesink, "deprecated async_play");
1391 ret = bclass->async_play (basesink);
1392 if (ret == GST_STATE_CHANGE_FAILURE)
1397 case GST_STATE_PAUSED:
1398 GST_DEBUG_OBJECT (basesink, "commiting state to PAUSED");
1400 post_async_done = TRUE;
1401 basesink->priv->commited = TRUE;
1402 post_pending = GST_STATE_VOID_PENDING;
1404 case GST_STATE_READY:
1405 case GST_STATE_NULL:
1407 case GST_STATE_VOID_PENDING:
1408 goto nothing_pending;
1413 /* we can report latency queries now */
1414 basesink->priv->have_latency = TRUE;
1416 GST_STATE (basesink) = pending;
1417 GST_STATE_NEXT (basesink) = GST_STATE_VOID_PENDING;
1418 GST_STATE_PENDING (basesink) = GST_STATE_VOID_PENDING;
1419 GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_SUCCESS;
1420 GST_OBJECT_UNLOCK (basesink);
1423 GST_DEBUG_OBJECT (basesink, "posting PAUSED state change message");
1424 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1425 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1426 current, next, post_pending));
1428 if (post_async_done) {
1429 GST_DEBUG_OBJECT (basesink, "posting async-done message");
1430 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1431 gst_message_new_async_done (GST_OBJECT_CAST (basesink)));
1434 GST_DEBUG_OBJECT (basesink, "posting PLAYING state change message");
1435 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1436 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1437 next, pending, GST_STATE_VOID_PENDING));
1440 GST_STATE_BROADCAST (basesink);
1446 /* Depending on the state, set our vars. We get in this situation when the
1447 * state change function got a change to update the state vars before the
1448 * streaming thread did. This is fine but we need to make sure that we
1449 * update the need_preroll var since it was TRUE when we got here and might
1450 * become FALSE if we got to PLAYING. */
1451 GST_DEBUG_OBJECT (basesink, "nothing to commit, now in %s",
1452 gst_element_state_get_name (current));
1454 case GST_STATE_PLAYING:
1455 basesink->need_preroll = FALSE;
1457 case GST_STATE_PAUSED:
1458 basesink->need_preroll = TRUE;
1461 basesink->need_preroll = FALSE;
1462 basesink->flushing = TRUE;
1465 /* we can report latency queries now */
1466 basesink->priv->have_latency = TRUE;
1467 GST_OBJECT_UNLOCK (basesink);
1472 /* app is going to READY */
1473 GST_DEBUG_OBJECT (basesink, "stopping");
1474 basesink->need_preroll = FALSE;
1475 basesink->flushing = TRUE;
1476 GST_OBJECT_UNLOCK (basesink);
1481 GST_DEBUG_OBJECT (basesink, "async commit failed");
1482 GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_FAILURE;
1483 GST_OBJECT_UNLOCK (basesink);
1489 start_stepping (GstBaseSink * sink, GstSegment * segment,
1490 GstStepInfo * pending, GstStepInfo * current)
1493 GstMessage *message;
1495 GST_DEBUG_OBJECT (sink, "update pending step");
1497 GST_OBJECT_LOCK (sink);
1498 memcpy (current, pending, sizeof (GstStepInfo));
1499 pending->valid = FALSE;
1500 GST_OBJECT_UNLOCK (sink);
1502 /* post message first */
1504 gst_message_new_step_start (GST_OBJECT (sink), TRUE, current->format,
1505 current->amount, current->rate, current->flush, current->intermediate);
1506 gst_message_set_seqnum (message, current->seqnum);
1507 gst_element_post_message (GST_ELEMENT (sink), message);
1509 /* get the running time of where we paused and remember it */
1510 current->start = gst_element_get_start_time (GST_ELEMENT_CAST (sink));
1511 gst_segment_set_running_time (segment, GST_FORMAT_TIME, current->start);
1513 /* set the new rate for the remainder of the segment */
1514 current->start_rate = segment->rate;
1515 segment->rate *= current->rate;
1516 segment->abs_rate = ABS (segment->rate);
1519 if (segment->rate > 0.0)
1520 current->start_stop = segment->stop;
1522 current->start_start = segment->start;
1524 if (current->format == GST_FORMAT_TIME) {
1525 end = current->start + current->amount;
1526 if (!current->flush) {
1527 /* update the segment clipping regions for non-flushing seeks */
1528 if (segment->rate > 0.0) {
1529 segment->stop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1530 segment->last_stop = segment->stop;
1534 position = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1535 segment->time = position;
1536 segment->start = position;
1537 segment->last_stop = position;
1542 GST_DEBUG_OBJECT (sink,
1543 "segment now rate %lf, applied rate %lf, "
1544 "format GST_FORMAT_TIME, "
1545 "%" GST_TIME_FORMAT " -- %" GST_TIME_FORMAT
1546 ", time %" GST_TIME_FORMAT ", accum %" GST_TIME_FORMAT,
1547 segment->rate, segment->applied_rate, GST_TIME_ARGS (segment->start),
1548 GST_TIME_ARGS (segment->stop), GST_TIME_ARGS (segment->time),
1549 GST_TIME_ARGS (segment->accum));
1551 GST_DEBUG_OBJECT (sink, "step started at running_time %" GST_TIME_FORMAT,
1552 GST_TIME_ARGS (current->start));
1554 if (current->amount == -1) {
1555 GST_DEBUG_OBJECT (sink, "step amount == -1, stop stepping");
1556 current->valid = FALSE;
1558 GST_DEBUG_OBJECT (sink, "step amount: %" G_GUINT64_FORMAT ", format: %s, "
1559 "rate: %f", current->amount, gst_format_get_name (current->format),
1565 stop_stepping (GstBaseSink * sink, GstSegment * segment,
1566 GstStepInfo * current, gint64 rstart, gint64 rstop, gboolean eos)
1568 gint64 stop, position;
1569 GstMessage *message;
1571 GST_DEBUG_OBJECT (sink, "step complete");
1573 if (segment->rate > 0.0)
1578 GST_DEBUG_OBJECT (sink,
1579 "step stop at running_time %" GST_TIME_FORMAT, GST_TIME_ARGS (stop));
1582 current->duration = current->position;
1584 current->duration = stop - current->start;
1586 GST_DEBUG_OBJECT (sink, "step elapsed running_time %" GST_TIME_FORMAT,
1587 GST_TIME_ARGS (current->duration));
1589 position = current->start + current->duration;
1591 /* now move the segment to the new running time */
1592 gst_segment_set_running_time (segment, GST_FORMAT_TIME, position);
1594 if (current->flush) {
1595 /* and remove the accumulated time we flushed, start time did not change */
1596 segment->accum = current->start;
1598 /* start time is now the stepped position */
1599 gst_element_set_start_time (GST_ELEMENT_CAST (sink), position);
1602 /* restore the previous rate */
1603 segment->rate = current->start_rate;
1604 segment->abs_rate = ABS (segment->rate);
1606 if (segment->rate > 0.0)
1607 segment->stop = current->start_stop;
1609 segment->start = current->start_start;
1611 /* the clip segment is used for position report in paused... */
1612 memcpy (sink->abidata.ABI.clip_segment, segment, sizeof (GstSegment));
1614 /* post the step done when we know the stepped duration in TIME */
1616 gst_message_new_step_done (GST_OBJECT_CAST (sink), current->format,
1617 current->amount, current->rate, current->flush, current->intermediate,
1618 current->duration, eos);
1619 gst_message_set_seqnum (message, current->seqnum);
1620 gst_element_post_message (GST_ELEMENT_CAST (sink), message);
1622 if (!current->intermediate)
1623 sink->need_preroll = current->need_preroll;
1625 /* and the current step info finished and becomes invalid */
1626 current->valid = FALSE;
1630 handle_stepping (GstBaseSink * sink, GstSegment * segment,
1631 GstStepInfo * current, gint64 * cstart, gint64 * cstop, gint64 * rstart,
1634 GstBaseSinkPrivate *priv;
1635 gboolean step_end = FALSE;
1639 /* see if we need to skip this buffer because of stepping */
1640 switch (current->format) {
1641 case GST_FORMAT_TIME:
1646 if (segment->rate > 0.0) {
1654 end = current->start + current->amount;
1655 current->position = first - current->start;
1657 if (G_UNLIKELY (segment->abs_rate != 1.0))
1658 current->position /= segment->abs_rate;
1660 GST_DEBUG_OBJECT (sink,
1661 "buffer: %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT,
1662 GST_TIME_ARGS (first), GST_TIME_ARGS (last));
1663 GST_DEBUG_OBJECT (sink,
1664 "got time step %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT "/%"
1665 GST_TIME_FORMAT, GST_TIME_ARGS (current->position),
1666 GST_TIME_ARGS (last - current->start),
1667 GST_TIME_ARGS (current->amount));
1669 if ((current->flush && current->position >= current->amount)
1671 GST_DEBUG_OBJECT (sink, "step ended, we need clipping");
1673 if (segment->rate > 0.0) {
1675 *cstart = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1678 *cstop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1681 GST_DEBUG_OBJECT (sink,
1682 "cstart %" GST_TIME_FORMAT ", rstart %" GST_TIME_FORMAT,
1683 GST_TIME_ARGS (*cstart), GST_TIME_ARGS (*rstart));
1684 GST_DEBUG_OBJECT (sink,
1685 "cstop %" GST_TIME_FORMAT ", rstop %" GST_TIME_FORMAT,
1686 GST_TIME_ARGS (*cstop), GST_TIME_ARGS (*rstop));
1689 case GST_FORMAT_BUFFERS:
1690 GST_DEBUG_OBJECT (sink,
1691 "got default step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1692 current->position, current->amount);
1694 if (current->position < current->amount) {
1695 current->position++;
1700 case GST_FORMAT_DEFAULT:
1702 GST_DEBUG_OBJECT (sink,
1703 "got unknown step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1704 current->position, current->amount);
1710 /* with STREAM_LOCK, PREROLL_LOCK
1712 * Returns TRUE if the object needs synchronisation and takes therefore
1713 * part in prerolling.
1715 * rsstart/rsstop contain the start/stop in stream time.
1716 * rrstart/rrstop contain the start/stop in running time.
1719 gst_base_sink_get_sync_times (GstBaseSink * basesink, GstMiniObject * obj,
1720 GstClockTime * rsstart, GstClockTime * rsstop,
1721 GstClockTime * rrstart, GstClockTime * rrstop, gboolean * do_sync,
1722 gboolean * stepped, GstSegment * segment, GstStepInfo * step,
1723 gboolean * step_end)
1725 GstBaseSinkClass *bclass;
1727 GstClockTime start, stop; /* raw start/stop timestamps */
1728 gint64 cstart, cstop; /* clipped raw timestamps */
1729 gint64 rstart, rstop; /* clipped timestamps converted to running time */
1730 GstClockTime sstart, sstop; /* clipped timestamps converted to stream time */
1732 GstBaseSinkPrivate *priv;
1735 priv = basesink->priv;
1737 /* start with nothing */
1740 if (G_UNLIKELY (GST_IS_EVENT (obj))) {
1741 GstEvent *event = GST_EVENT_CAST (obj);
1743 switch (GST_EVENT_TYPE (event)) {
1744 /* EOS event needs syncing */
1747 if (basesink->segment.rate >= 0.0) {
1748 sstart = sstop = priv->current_sstop;
1750 /* we have not seen a buffer yet, use the segment values */
1751 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1752 basesink->segment.format, basesink->segment.stop);
1755 sstart = sstop = priv->current_sstart;
1757 /* we have not seen a buffer yet, use the segment values */
1758 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1759 basesink->segment.format, basesink->segment.start);
1763 rstart = rstop = priv->eos_rtime;
1764 *do_sync = rstart != -1;
1765 GST_DEBUG_OBJECT (basesink, "sync times for EOS %" GST_TIME_FORMAT,
1766 GST_TIME_ARGS (rstart));
1767 /* if we are stepping, we end now */
1768 *step_end = step->valid;
1773 /* other events do not need syncing */
1774 /* FIXME, maybe NEWSEGMENT might need synchronisation
1775 * since the POSITION query depends on accumulated times and
1776 * we cannot accumulate the current segment before the previous
1785 /* else do buffer sync code */
1786 buffer = GST_BUFFER_CAST (obj);
1788 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1790 /* just get the times to see if we need syncing, if the start returns -1 we
1792 if (bclass->get_times)
1793 bclass->get_times (basesink, buffer, &start, &stop);
1796 /* we don't need to sync but we still want to get the timestamps for
1797 * tracking the position */
1798 gst_base_sink_get_times (basesink, buffer, &start, &stop);
1804 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
1805 ", stop: %" GST_TIME_FORMAT ", do_sync %d", GST_TIME_ARGS (start),
1806 GST_TIME_ARGS (stop), *do_sync);
1808 /* collect segment and format for code clarity */
1809 format = segment->format;
1811 /* no timestamp clipping if we did not get a TIME segment format */
1812 if (G_UNLIKELY (format != GST_FORMAT_TIME)) {
1815 /* do running and stream time in TIME format */
1816 format = GST_FORMAT_TIME;
1817 GST_LOG_OBJECT (basesink, "not time format, don't clip");
1821 /* clip, only when we know about time */
1822 if (G_UNLIKELY (!gst_segment_clip (segment, GST_FORMAT_TIME,
1823 (gint64) start, (gint64) stop, &cstart, &cstop))) {
1825 GST_DEBUG_OBJECT (basesink, "step out of segment");
1826 /* when we are stepping, pretend we're at the end of the segment */
1827 if (segment->rate > 0.0) {
1828 cstart = segment->stop;
1829 cstop = segment->stop;
1831 cstart = segment->start;
1832 cstop = segment->start;
1836 goto out_of_segment;
1839 if (G_UNLIKELY (start != cstart || stop != cstop)) {
1840 GST_DEBUG_OBJECT (basesink, "clipped to: start %" GST_TIME_FORMAT
1841 ", stop: %" GST_TIME_FORMAT, GST_TIME_ARGS (cstart),
1842 GST_TIME_ARGS (cstop));
1845 /* set last stop position */
1846 if (G_LIKELY (cstop != GST_CLOCK_TIME_NONE))
1847 gst_segment_set_last_stop (segment, GST_FORMAT_TIME, cstop);
1849 gst_segment_set_last_stop (segment, GST_FORMAT_TIME, cstart);
1852 rstart = gst_segment_to_running_time (segment, format, cstart);
1853 rstop = gst_segment_to_running_time (segment, format, cstop);
1855 if (G_UNLIKELY (step->valid)) {
1856 if (!(*step_end = handle_stepping (basesink, segment, step, &cstart, &cstop,
1857 &rstart, &rstop))) {
1858 /* step is still busy, we discard data when we are flushing */
1859 *stepped = step->flush;
1862 /* this can produce wrong values if we accumulated non-TIME segments. If this happens,
1863 * upstream is behaving very badly */
1864 sstart = gst_segment_to_stream_time (segment, format, cstart);
1865 sstop = gst_segment_to_stream_time (segment, format, cstop);
1868 /* eos_done label only called when doing EOS, we also stop stepping then */
1869 if (*step_end && step->flush) {
1870 GST_DEBUG_OBJECT (basesink, "flushing step ended");
1871 stop_stepping (basesink, segment, step, rstart, rstop, eos);
1881 /* buffers and EOS always need syncing and preroll */
1887 /* we usually clip in the chain function already but stepping could cause
1888 * the segment to be updated later. we return FALSE so that we don't try
1890 GST_LOG_OBJECT (basesink, "buffer skipped, not in segment");
1895 /* with STREAM_LOCK, PREROLL_LOCK, LOCK
1896 * adjust a timestamp with the latency and timestamp offset */
1898 gst_base_sink_adjust_time (GstBaseSink * basesink, GstClockTime time)
1900 GstClockTimeDiff ts_offset;
1902 /* don't do anything funny with invalid timestamps */
1903 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
1906 time += basesink->priv->latency;
1908 /* apply offset, be carefull for underflows */
1909 ts_offset = basesink->priv->ts_offset;
1910 if (ts_offset < 0) {
1911 ts_offset = -ts_offset;
1912 if (ts_offset < time)
1923 * gst_base_sink_wait_clock:
1925 * @time: the running_time to be reached
1926 * @jitter: the jitter to be filled with time diff (can be NULL)
1928 * This function will block until @time is reached. It is usually called by
1929 * subclasses that use their own internal synchronisation.
1931 * If @time is not valid, no sycnhronisation is done and #GST_CLOCK_BADTIME is
1932 * returned. Likewise, if synchronisation is disabled in the element or there
1933 * is no clock, no synchronisation is done and #GST_CLOCK_BADTIME is returned.
1935 * This function should only be called with the PREROLL_LOCK held, like when
1936 * receiving an EOS event in the ::event vmethod or when receiving a buffer in
1937 * the ::render vmethod.
1939 * The @time argument should be the running_time of when this method should
1940 * return and is not adjusted with any latency or offset configured in the
1945 * Returns: #GstClockReturn
1948 gst_base_sink_wait_clock (GstBaseSink * sink, GstClockTime time,
1949 GstClockTimeDiff * jitter)
1955 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
1958 GST_OBJECT_LOCK (sink);
1959 if (G_UNLIKELY (!sink->sync))
1962 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (sink)) == NULL))
1965 /* add base_time to running_time to get the time against the clock */
1966 time += GST_ELEMENT_CAST (sink)->base_time;
1968 id = gst_clock_new_single_shot_id (clock, time);
1969 GST_OBJECT_UNLOCK (sink);
1971 /* A blocking wait is performed on the clock. We save the ClockID
1972 * so we can unlock the entry at any time. While we are blocking, we
1973 * release the PREROLL_LOCK so that other threads can interrupt the
1975 sink->clock_id = id;
1976 /* release the preroll lock while waiting */
1977 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
1979 ret = gst_clock_id_wait (id, jitter);
1981 GST_PAD_PREROLL_LOCK (sink->sinkpad);
1982 gst_clock_id_unref (id);
1983 sink->clock_id = NULL;
1987 /* no syncing needed */
1990 GST_DEBUG_OBJECT (sink, "time not valid, no sync needed");
1991 return GST_CLOCK_BADTIME;
1995 GST_DEBUG_OBJECT (sink, "sync disabled");
1996 GST_OBJECT_UNLOCK (sink);
1997 return GST_CLOCK_BADTIME;
2001 GST_DEBUG_OBJECT (sink, "no clock, can't sync");
2002 GST_OBJECT_UNLOCK (sink);
2003 return GST_CLOCK_BADTIME;
2008 * gst_base_sink_wait_preroll:
2011 * If the #GstBaseSinkClass::render method performs its own synchronisation against
2012 * the clock it must unblock when going from PLAYING to the PAUSED state and call
2013 * this method before continuing to render the remaining data.
2015 * This function will block until a state change to PLAYING happens (in which
2016 * case this function returns #GST_FLOW_OK) or the processing must be stopped due
2017 * to a state change to READY or a FLUSH event (in which case this function
2018 * returns #GST_FLOW_WRONG_STATE).
2020 * This function should only be called with the PREROLL_LOCK held, like in the
2025 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2026 * continue. Any other return value should be returned from the render vmethod.
2029 gst_base_sink_wait_preroll (GstBaseSink * sink)
2031 sink->have_preroll = TRUE;
2032 GST_DEBUG_OBJECT (sink, "waiting in preroll for flush or PLAYING");
2033 /* block until the state changes, or we get a flush, or something */
2034 GST_PAD_PREROLL_WAIT (sink->sinkpad);
2035 sink->have_preroll = FALSE;
2036 if (G_UNLIKELY (sink->flushing))
2038 if (G_UNLIKELY (sink->priv->step_unlock))
2040 GST_DEBUG_OBJECT (sink, "continue after preroll");
2047 GST_DEBUG_OBJECT (sink, "preroll interrupted because of flush");
2048 return GST_FLOW_WRONG_STATE;
2052 sink->priv->step_unlock = FALSE;
2053 GST_DEBUG_OBJECT (sink, "preroll interrupted because of step");
2054 return GST_FLOW_STEP;
2059 * gst_base_sink_do_preroll:
2061 * @obj: the object that caused the preroll
2063 * If the @sink spawns its own thread for pulling buffers from upstream it
2064 * should call this method after it has pulled a buffer. If the element needed
2065 * to preroll, this function will perform the preroll and will then block
2066 * until the element state is changed.
2068 * This function should be called with the PREROLL_LOCK held.
2072 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2073 * continue. Any other return value should be returned from the render vmethod.
2076 gst_base_sink_do_preroll (GstBaseSink * sink, GstMiniObject * obj)
2080 while (G_UNLIKELY (sink->need_preroll)) {
2081 GST_DEBUG_OBJECT (sink, "prerolling object %p", obj);
2083 ret = gst_base_sink_preroll_object (sink, FALSE, obj);
2084 if (ret != GST_FLOW_OK)
2085 goto preroll_failed;
2087 /* need to recheck here because the commit state could have
2088 * made us not need the preroll anymore */
2089 if (G_LIKELY (sink->need_preroll)) {
2090 /* block until the state changes, or we get a flush, or something */
2091 ret = gst_base_sink_wait_preroll (sink);
2092 if (ret != GST_FLOW_OK) {
2093 if (ret == GST_FLOW_STEP)
2096 goto preroll_failed;
2105 GST_DEBUG_OBJECT (sink, "preroll failed %d", ret);
2111 * gst_base_sink_wait_eos:
2113 * @time: the running_time to be reached
2114 * @jitter: the jitter to be filled with time diff (can be NULL)
2116 * This function will block until @time is reached. It is usually called by
2117 * subclasses that use their own internal synchronisation but want to let the
2118 * EOS be handled by the base class.
2120 * This function should only be called with the PREROLL_LOCK held, like when
2121 * receiving an EOS event in the ::event vmethod.
2123 * The @time argument should be the running_time of when the EOS should happen
2124 * and will be adjusted with any latency and offset configured in the sink.
2128 * Returns: #GstFlowReturn
2131 gst_base_sink_wait_eos (GstBaseSink * sink, GstClockTime time,
2132 GstClockTimeDiff * jitter)
2134 GstClockReturn status;
2140 GST_DEBUG_OBJECT (sink, "checking preroll");
2142 /* first wait for the playing state before we can continue */
2143 if (G_UNLIKELY (sink->need_preroll)) {
2144 ret = gst_base_sink_wait_preroll (sink);
2145 if (ret != GST_FLOW_OK) {
2146 if (ret == GST_FLOW_STEP)
2153 /* preroll done, we can sync since we are in PLAYING now. */
2154 GST_DEBUG_OBJECT (sink, "possibly waiting for clock to reach %"
2155 GST_TIME_FORMAT, GST_TIME_ARGS (time));
2157 /* compensate for latency and ts_offset. We don't adjust for render delay
2158 * because we don't interact with the device on EOS normally. */
2159 stime = gst_base_sink_adjust_time (sink, time);
2161 /* wait for the clock, this can be interrupted because we got shut down or
2163 status = gst_base_sink_wait_clock (sink, stime, jitter);
2165 GST_DEBUG_OBJECT (sink, "clock returned %d", status);
2167 /* invalid time, no clock or sync disabled, just continue then */
2168 if (status == GST_CLOCK_BADTIME)
2171 /* waiting could have been interrupted and we can be flushing now */
2172 if (G_UNLIKELY (sink->flushing))
2175 /* retry if we got unscheduled, which means we did not reach the timeout
2176 * yet. if some other error occures, we continue. */
2177 } while (status == GST_CLOCK_UNSCHEDULED);
2179 GST_DEBUG_OBJECT (sink, "end of stream");
2186 GST_DEBUG_OBJECT (sink, "we are flushing");
2187 return GST_FLOW_WRONG_STATE;
2191 /* with STREAM_LOCK, PREROLL_LOCK
2193 * Make sure we are in PLAYING and synchronize an object to the clock.
2195 * If we need preroll, we are not in PLAYING. We try to commit the state
2196 * if needed and then block if we still are not PLAYING.
2198 * We start waiting on the clock in PLAYING. If we got interrupted, we
2199 * immediatly try to re-preroll.
2201 * Some objects do not need synchronisation (most events) and so this function
2202 * immediatly returns GST_FLOW_OK.
2204 * for objects that arrive later than max-lateness to be synchronized to the
2205 * clock have the @late boolean set to TRUE.
2207 * This function keeps a running average of the jitter (the diff between the
2208 * clock time and the requested sync time). The jitter is negative for
2209 * objects that arrive in time and positive for late buffers.
2211 * does not take ownership of obj.
2213 static GstFlowReturn
2214 gst_base_sink_do_sync (GstBaseSink * basesink, GstPad * pad,
2215 GstMiniObject * obj, gboolean * late, gboolean * step_end)
2217 GstClockTimeDiff jitter;
2219 GstClockReturn status = GST_CLOCK_OK;
2220 GstClockTime rstart, rstop, sstart, sstop, stime;
2222 GstBaseSinkPrivate *priv;
2224 GstStepInfo *current, *pending;
2227 priv = basesink->priv;
2230 sstart = sstop = rstart = rstop = -1;
2234 priv->current_rstart = -1;
2236 /* get stepping info */
2237 current = &priv->current_step;
2238 pending = &priv->pending_step;
2240 /* get timing information for this object against the render segment */
2241 syncable = gst_base_sink_get_sync_times (basesink, obj,
2242 &sstart, &sstop, &rstart, &rstop, &do_sync, &stepped, &basesink->segment,
2245 if (G_UNLIKELY (stepped))
2248 /* a syncable object needs to participate in preroll and
2249 * clocking. All buffers and EOS are syncable. */
2250 if (G_UNLIKELY (!syncable))
2253 /* store timing info for current object */
2254 priv->current_rstart = rstart;
2255 priv->current_rstop = (rstop != -1 ? rstop : rstart);
2257 /* save sync time for eos when the previous object needed sync */
2258 priv->eos_rtime = (do_sync ? priv->current_rstop : -1);
2261 /* first do preroll, this makes sure we commit our state
2262 * to PAUSED and can continue to PLAYING. We cannot perform
2263 * any clock sync in PAUSED because there is no clock. */
2264 ret = gst_base_sink_do_preroll (basesink, obj);
2265 if (G_UNLIKELY (ret != GST_FLOW_OK))
2266 goto preroll_failed;
2268 /* After rendering we store the position of the last buffer so that we can use
2269 * it to report the position. We need to take the lock here. */
2270 GST_OBJECT_LOCK (basesink);
2271 priv->current_sstart = sstart;
2272 priv->current_sstop = (sstop != -1 ? sstop : sstart);
2273 GST_OBJECT_UNLOCK (basesink);
2275 /* update the segment with a pending step if the current one is invalid and we
2276 * have a new pending one. We only accept new step updates after a preroll */
2277 if (G_UNLIKELY (pending->valid && !current->valid)) {
2278 start_stepping (basesink, &basesink->segment, pending, current);
2285 /* adjust for latency */
2286 stime = gst_base_sink_adjust_time (basesink, rstart);
2288 /* adjust for render-delay, avoid underflows */
2290 if (stime > priv->render_delay)
2291 stime -= priv->render_delay;
2296 /* preroll done, we can sync since we are in PLAYING now. */
2297 GST_DEBUG_OBJECT (basesink, "possibly waiting for clock to reach %"
2298 GST_TIME_FORMAT ", adjusted %" GST_TIME_FORMAT,
2299 GST_TIME_ARGS (rstart), GST_TIME_ARGS (stime));
2301 /* This function will return immediatly if start == -1, no clock
2302 * or sync is disabled with GST_CLOCK_BADTIME. */
2303 status = gst_base_sink_wait_clock (basesink, stime, &jitter);
2305 GST_DEBUG_OBJECT (basesink, "clock returned %d", status);
2307 /* invalid time, no clock or sync disabled, just render */
2308 if (status == GST_CLOCK_BADTIME)
2311 /* waiting could have been interrupted and we can be flushing now */
2312 if (G_UNLIKELY (basesink->flushing))
2315 /* check for unlocked by a state change, we are not flushing so
2316 * we can try to preroll on the current buffer. */
2317 if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED)) {
2318 GST_DEBUG_OBJECT (basesink, "unscheduled, waiting some more");
2319 priv->call_preroll = TRUE;
2323 /* successful syncing done, record observation */
2324 priv->current_jitter = jitter;
2326 /* check if the object should be dropped */
2327 *late = gst_base_sink_is_too_late (basesink, obj, rstart, rstop,
2336 GST_DEBUG_OBJECT (basesink, "skipped stepped object %p", obj);
2342 GST_DEBUG_OBJECT (basesink, "non syncable object %p", obj);
2347 GST_DEBUG_OBJECT (basesink, "we are flushing");
2348 return GST_FLOW_WRONG_STATE;
2352 GST_DEBUG_OBJECT (basesink, "preroll failed");
2359 gst_base_sink_send_qos (GstBaseSink * basesink,
2360 gdouble proportion, GstClockTime time, GstClockTimeDiff diff)
2365 /* generate Quality-of-Service event */
2366 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2367 "qos: proportion: %lf, diff %" G_GINT64_FORMAT ", timestamp %"
2368 GST_TIME_FORMAT, proportion, diff, GST_TIME_ARGS (time));
2370 event = gst_event_new_qos (proportion, diff, time);
2373 res = gst_pad_push_event (basesink->sinkpad, event);
2379 gst_base_sink_perform_qos (GstBaseSink * sink, gboolean dropped)
2381 GstBaseSinkPrivate *priv;
2382 GstClockTime start, stop;
2383 GstClockTimeDiff jitter;
2384 GstClockTime pt, entered, left;
2385 GstClockTime duration;
2390 start = priv->current_rstart;
2392 if (priv->current_step.valid)
2395 /* if Quality-of-Service disabled, do nothing */
2396 if (!g_atomic_int_get (&priv->qos_enabled) || start == -1)
2399 stop = priv->current_rstop;
2400 jitter = priv->current_jitter;
2403 /* this is the time the buffer entered the sink */
2404 if (start < -jitter)
2407 entered = start + jitter;
2410 /* this is the time the buffer entered the sink */
2411 entered = start + jitter;
2412 /* this is the time the buffer left the sink */
2413 left = start + jitter;
2416 /* calculate duration of the buffer */
2418 duration = stop - start;
2422 /* if we have the time when the last buffer left us, calculate
2423 * processing time */
2424 if (priv->last_left != -1) {
2425 if (entered > priv->last_left) {
2426 pt = entered - priv->last_left;
2434 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "start: %" GST_TIME_FORMAT
2435 ", entered %" GST_TIME_FORMAT ", left %" GST_TIME_FORMAT ", pt: %"
2436 GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT ",jitter %"
2437 G_GINT64_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (entered),
2438 GST_TIME_ARGS (left), GST_TIME_ARGS (pt), GST_TIME_ARGS (duration),
2441 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "avg_duration: %" GST_TIME_FORMAT
2442 ", avg_pt: %" GST_TIME_FORMAT ", avg_rate: %g",
2443 GST_TIME_ARGS (priv->avg_duration), GST_TIME_ARGS (priv->avg_pt),
2446 /* collect running averages. for first observations, we copy the
2448 if (priv->avg_duration == -1)
2449 priv->avg_duration = duration;
2451 priv->avg_duration = UPDATE_RUNNING_AVG (priv->avg_duration, duration);
2453 if (priv->avg_pt == -1)
2456 priv->avg_pt = UPDATE_RUNNING_AVG (priv->avg_pt, pt);
2458 if (priv->avg_duration != 0)
2460 gst_guint64_to_gdouble (priv->avg_pt) /
2461 gst_guint64_to_gdouble (priv->avg_duration);
2465 if (priv->last_left != -1) {
2466 if (dropped || priv->avg_rate < 0.0) {
2467 priv->avg_rate = rate;
2470 priv->avg_rate = UPDATE_RUNNING_AVG_N (priv->avg_rate, rate);
2472 priv->avg_rate = UPDATE_RUNNING_AVG_P (priv->avg_rate, rate);
2476 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink,
2477 "updated: avg_duration: %" GST_TIME_FORMAT ", avg_pt: %" GST_TIME_FORMAT
2478 ", avg_rate: %g", GST_TIME_ARGS (priv->avg_duration),
2479 GST_TIME_ARGS (priv->avg_pt), priv->avg_rate);
2482 if (priv->avg_rate >= 0.0) {
2483 /* if we have a valid rate, start sending QoS messages */
2484 if (priv->current_jitter < 0) {
2485 /* make sure we never go below 0 when adding the jitter to the
2487 if (priv->current_rstart < -priv->current_jitter)
2488 priv->current_jitter = -priv->current_rstart;
2490 gst_base_sink_send_qos (sink, priv->avg_rate, priv->current_rstart,
2491 priv->current_jitter);
2494 /* record when this buffer will leave us */
2495 priv->last_left = left;
2498 /* reset all qos measuring */
2500 gst_base_sink_reset_qos (GstBaseSink * sink)
2502 GstBaseSinkPrivate *priv;
2506 priv->last_in_time = -1;
2507 priv->last_left = -1;
2508 priv->avg_duration = -1;
2510 priv->avg_rate = -1.0;
2511 priv->avg_render = -1;
2517 /* Checks if the object was scheduled too late.
2519 * start/stop contain the raw timestamp start and stop values
2522 * status and jitter contain the return values from the clock wait.
2524 * returns TRUE if the buffer was too late.
2527 gst_base_sink_is_too_late (GstBaseSink * basesink, GstMiniObject * obj,
2528 GstClockTime start, GstClockTime stop,
2529 GstClockReturn status, GstClockTimeDiff jitter)
2532 gint64 max_lateness;
2533 GstBaseSinkPrivate *priv;
2535 priv = basesink->priv;
2539 /* only for objects that were too late */
2540 if (G_LIKELY (status != GST_CLOCK_EARLY))
2543 max_lateness = basesink->abidata.ABI.max_lateness;
2545 /* check if frame dropping is enabled */
2546 if (max_lateness == -1)
2549 /* only check for buffers */
2550 if (G_UNLIKELY (!GST_IS_BUFFER (obj)))
2553 /* can't do check if we don't have a timestamp */
2554 if (G_UNLIKELY (start == -1))
2557 /* we can add a valid stop time */
2559 max_lateness += stop;
2561 max_lateness += start;
2563 /* if the jitter bigger than duration and lateness we are too late */
2564 if ((late = start + jitter > max_lateness)) {
2565 GST_DEBUG_OBJECT (basesink, "buffer is too late %" GST_TIME_FORMAT
2566 " > %" GST_TIME_FORMAT, GST_TIME_ARGS (start + jitter),
2567 GST_TIME_ARGS (max_lateness));
2568 /* !!emergency!!, if we did not receive anything valid for more than a
2569 * second, render it anyway so the user sees something */
2570 if (priv->last_in_time != -1 && start - priv->last_in_time > GST_SECOND) {
2572 GST_ELEMENT_WARNING (basesink, CORE, CLOCK,
2573 (_("A lot of buffers are being dropped.")),
2574 ("There may be a timestamping problem, or this computer is too slow."));
2575 GST_DEBUG_OBJECT (basesink,
2576 "**emergency** last buffer at %" GST_TIME_FORMAT " > GST_SECOND",
2577 GST_TIME_ARGS (priv->last_in_time));
2583 priv->last_in_time = start;
2590 GST_DEBUG_OBJECT (basesink, "object was scheduled in time");
2595 GST_DEBUG_OBJECT (basesink, "frame dropping disabled");
2600 GST_DEBUG_OBJECT (basesink, "object is not a buffer");
2605 GST_DEBUG_OBJECT (basesink, "buffer has no timestamp");
2610 /* called before and after calling the render vmethod. It keeps track of how
2611 * much time was spent in the render method and is used to check if we are
2614 gst_base_sink_do_render_stats (GstBaseSink * basesink, gboolean start)
2616 GstBaseSinkPrivate *priv;
2618 priv = basesink->priv;
2621 priv->start = gst_util_get_timestamp ();
2623 GstClockTime elapsed;
2625 priv->stop = gst_util_get_timestamp ();
2627 elapsed = GST_CLOCK_DIFF (priv->start, priv->stop);
2629 if (priv->avg_render == -1)
2630 priv->avg_render = elapsed;
2632 priv->avg_render = UPDATE_RUNNING_AVG (priv->avg_render, elapsed);
2634 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2635 "avg_render: %" GST_TIME_FORMAT, GST_TIME_ARGS (priv->avg_render));
2639 /* with STREAM_LOCK, PREROLL_LOCK,
2641 * Synchronize the object on the clock and then render it.
2643 * takes ownership of obj.
2645 static GstFlowReturn
2646 gst_base_sink_render_object (GstBaseSink * basesink, GstPad * pad,
2647 gboolean is_list, gpointer obj)
2650 GstBaseSinkClass *bclass;
2651 gboolean late, step_end;
2654 GstBaseSinkPrivate *priv;
2656 priv = basesink->priv;
2660 * If buffer list, use the first group buffer within the list
2663 sync_obj = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0, 0);
2664 g_assert (NULL != sync_obj);
2674 /* synchronize this object, non syncable objects return OK
2676 ret = gst_base_sink_do_sync (basesink, pad, sync_obj, &late, &step_end);
2677 if (G_UNLIKELY (ret != GST_FLOW_OK))
2680 /* and now render, event or buffer/buffer list. */
2681 if (G_LIKELY (is_list || GST_IS_BUFFER (obj))) {
2682 /* drop late buffers unconditionally, let's hope it's unlikely */
2683 if (G_UNLIKELY (late))
2686 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2688 if (G_LIKELY ((is_list && bclass->render_list) ||
2689 (!is_list && bclass->render))) {
2692 /* read once, to get same value before and after */
2693 do_qos = g_atomic_int_get (&priv->qos_enabled);
2695 GST_DEBUG_OBJECT (basesink, "rendering object %p", obj);
2697 /* record rendering time for QoS and stats */
2699 gst_base_sink_do_render_stats (basesink, TRUE);
2704 /* For buffer lists do not set last buffer. Creating buffer
2705 * with meaningful data can be done only with memcpy which will
2706 * significantly affect performance */
2707 buf = GST_BUFFER_CAST (obj);
2708 gst_base_sink_set_last_buffer (basesink, buf);
2710 ret = bclass->render (basesink, buf);
2712 GstBufferList *buflist;
2714 buflist = GST_BUFFER_LIST_CAST (obj);
2716 ret = bclass->render_list (basesink, buflist);
2720 gst_base_sink_do_render_stats (basesink, FALSE);
2722 if (ret == GST_FLOW_STEP)
2725 if (G_UNLIKELY (basesink->flushing))
2731 GstEvent *event = GST_EVENT_CAST (obj);
2732 gboolean event_res = TRUE;
2735 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2737 type = GST_EVENT_TYPE (event);
2739 GST_DEBUG_OBJECT (basesink, "rendering event %p, type %s", obj,
2740 gst_event_type_get_name (type));
2743 event_res = bclass->event (basesink, event);
2745 /* when we get here we could be flushing again when the event handler calls
2746 * _wait_eos(). We have to ignore this object in that case. */
2747 if (G_UNLIKELY (basesink->flushing))
2750 if (G_LIKELY (event_res)) {
2753 seqnum = basesink->priv->seqnum = gst_event_get_seqnum (event);
2754 GST_DEBUG_OBJECT (basesink, "Got seqnum #%" G_GUINT32_FORMAT, seqnum);
2759 GstMessage *message;
2761 /* the EOS event is completely handled so we mark
2762 * ourselves as being in the EOS state. eos is also
2763 * protected by the object lock so we can read it when
2764 * answering the POSITION query. */
2765 GST_OBJECT_LOCK (basesink);
2766 basesink->eos = TRUE;
2767 GST_OBJECT_UNLOCK (basesink);
2769 /* ok, now we can post the message */
2770 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
2772 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
2773 gst_message_set_seqnum (message, seqnum);
2774 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
2777 case GST_EVENT_NEWSEGMENT:
2778 /* configure the segment */
2779 gst_base_sink_configure_segment (basesink, pad, event,
2780 &basesink->segment);
2790 /* the step ended, check if we need to activate a new step */
2791 GST_DEBUG_OBJECT (basesink, "step ended");
2792 stop_stepping (basesink, &basesink->segment, &priv->current_step,
2793 priv->current_rstart, priv->current_rstop, basesink->eos);
2797 gst_base_sink_perform_qos (basesink, late);
2799 GST_DEBUG_OBJECT (basesink, "object unref after render %p", obj);
2800 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
2806 GST_DEBUG_OBJECT (basesink, "do_sync returned %s", gst_flow_get_name (ret));
2812 GST_DEBUG_OBJECT (basesink, "buffer late, dropping");
2817 GST_DEBUG_OBJECT (basesink, "we are flushing, ignore object");
2818 gst_mini_object_unref (obj);
2819 return GST_FLOW_WRONG_STATE;
2823 /* with STREAM_LOCK, PREROLL_LOCK
2825 * Perform preroll on the given object. For buffers this means
2826 * calling the preroll subclass method.
2827 * If that succeeds, the state will be commited.
2829 * function does not take ownership of obj.
2831 static GstFlowReturn
2832 gst_base_sink_preroll_object (GstBaseSink * basesink, gboolean is_list,
2833 GstMiniObject * obj)
2837 GST_DEBUG_OBJECT (basesink, "prerolling object %p", obj);
2839 /* if it's a buffer, we need to call the preroll method */
2840 if (G_LIKELY (is_list || GST_IS_BUFFER (obj)) && basesink->priv->call_preroll) {
2841 GstBaseSinkClass *bclass;
2843 GstClockTime timestamp;
2846 buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0, 0);
2847 g_assert (NULL != buf);
2849 buf = GST_BUFFER_CAST (obj);
2852 timestamp = GST_BUFFER_TIMESTAMP (buf);
2854 GST_DEBUG_OBJECT (basesink, "preroll buffer %" GST_TIME_FORMAT,
2855 GST_TIME_ARGS (timestamp));
2858 * For buffer lists do not set last buffer. Creating buffer
2859 * with meaningful data can be done only with memcpy which will
2860 * significantly affect performance
2863 gst_base_sink_set_last_buffer (basesink, buf);
2866 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2867 if (bclass->preroll)
2868 if ((ret = bclass->preroll (basesink, buf)) != GST_FLOW_OK)
2869 goto preroll_failed;
2871 basesink->priv->call_preroll = FALSE;
2875 if (G_LIKELY (basesink->playing_async)) {
2876 if (G_UNLIKELY (!gst_base_sink_commit_state (basesink)))
2885 GST_DEBUG_OBJECT (basesink, "preroll failed, abort state");
2886 gst_element_abort_state (GST_ELEMENT_CAST (basesink));
2891 GST_DEBUG_OBJECT (basesink, "stopping while commiting state");
2892 return GST_FLOW_WRONG_STATE;
2896 /* with STREAM_LOCK, PREROLL_LOCK
2898 * Queue an object for rendering.
2899 * The first prerollable object queued will complete the preroll. If the
2900 * preroll queue if filled, we render all the objects in the queue.
2902 * This function takes ownership of the object.
2904 static GstFlowReturn
2905 gst_base_sink_queue_object_unlocked (GstBaseSink * basesink, GstPad * pad,
2906 gboolean is_list, gpointer obj, gboolean prerollable)
2908 GstFlowReturn ret = GST_FLOW_OK;
2912 if (G_UNLIKELY (basesink->need_preroll)) {
2913 if (G_LIKELY (prerollable))
2914 basesink->preroll_queued++;
2916 length = basesink->preroll_queued;
2918 GST_DEBUG_OBJECT (basesink, "now %d prerolled items", length);
2920 /* first prerollable item needs to finish the preroll */
2922 ret = gst_base_sink_preroll_object (basesink, is_list, obj);
2923 if (G_UNLIKELY (ret != GST_FLOW_OK))
2924 goto preroll_failed;
2926 /* need to recheck if we need preroll, commmit state during preroll
2927 * could have made us not need more preroll. */
2928 if (G_UNLIKELY (basesink->need_preroll)) {
2929 /* see if we can render now, if we can't add the object to the preroll
2931 if (G_UNLIKELY (length <= basesink->preroll_queue_max_len))
2935 /* we can start rendering (or blocking) the queued object
2937 q = basesink->preroll_queue;
2938 while (G_UNLIKELY (!g_queue_is_empty (q))) {
2941 o = g_queue_pop_head (q);
2942 GST_DEBUG_OBJECT (basesink, "rendering queued object %p", o);
2944 /* do something with the return value */
2945 ret = gst_base_sink_render_object (basesink, pad, FALSE, o);
2946 if (ret != GST_FLOW_OK)
2947 goto dequeue_failed;
2950 /* now render the object */
2951 ret = gst_base_sink_render_object (basesink, pad, is_list, obj);
2952 basesink->preroll_queued = 0;
2959 GST_DEBUG_OBJECT (basesink, "preroll failed, reason %s",
2960 gst_flow_get_name (ret));
2961 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
2966 /* add object to the queue and return */
2967 GST_DEBUG_OBJECT (basesink, "need more preroll data %d <= %d",
2968 length, basesink->preroll_queue_max_len);
2969 g_queue_push_tail (basesink->preroll_queue, obj);
2974 GST_DEBUG_OBJECT (basesink, "rendering queued objects failed, reason %s",
2975 gst_flow_get_name (ret));
2976 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
2983 * This function grabs the PREROLL_LOCK and adds the object to
2986 * This function takes ownership of obj.
2988 static GstFlowReturn
2989 gst_base_sink_queue_object (GstBaseSink * basesink, GstPad * pad,
2990 GstMiniObject * obj, gboolean prerollable)
2994 GST_PAD_PREROLL_LOCK (pad);
2995 if (G_UNLIKELY (basesink->flushing))
2998 if (G_UNLIKELY (basesink->priv->received_eos))
3002 gst_base_sink_queue_object_unlocked (basesink, pad, FALSE, obj,
3004 GST_PAD_PREROLL_UNLOCK (pad);
3011 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3012 GST_PAD_PREROLL_UNLOCK (pad);
3013 gst_mini_object_unref (obj);
3014 return GST_FLOW_WRONG_STATE;
3018 GST_DEBUG_OBJECT (basesink,
3019 "we are EOS, dropping object, return UNEXPECTED");
3020 GST_PAD_PREROLL_UNLOCK (pad);
3021 gst_mini_object_unref (obj);
3022 return GST_FLOW_UNEXPECTED;
3027 gst_base_sink_flush_start (GstBaseSink * basesink, GstPad * pad)
3029 /* make sure we are not blocked on the clock also clear any pending
3031 gst_base_sink_set_flushing (basesink, pad, TRUE);
3033 /* we grab the stream lock but that is not needed since setting the
3034 * sink to flushing would make sure no state commit is being done
3036 GST_PAD_STREAM_LOCK (pad);
3037 gst_base_sink_reset_qos (basesink);
3038 if (basesink->priv->async_enabled) {
3039 /* and we need to commit our state again on the next
3040 * prerolled buffer */
3041 basesink->playing_async = TRUE;
3042 gst_element_lost_state (GST_ELEMENT_CAST (basesink));
3044 basesink->priv->have_latency = TRUE;
3045 basesink->need_preroll = FALSE;
3047 gst_base_sink_set_last_buffer (basesink, NULL);
3048 GST_PAD_STREAM_UNLOCK (pad);
3052 gst_base_sink_flush_stop (GstBaseSink * basesink, GstPad * pad)
3054 /* unset flushing so we can accept new data, this also flushes out any EOS
3056 gst_base_sink_set_flushing (basesink, pad, FALSE);
3058 /* for position reporting */
3059 GST_OBJECT_LOCK (basesink);
3060 basesink->priv->current_sstart = -1;
3061 basesink->priv->current_sstop = -1;
3062 basesink->priv->eos_rtime = -1;
3063 basesink->priv->call_preroll = TRUE;
3064 basesink->priv->current_step.valid = FALSE;
3065 basesink->priv->pending_step.valid = FALSE;
3066 if (basesink->pad_mode == GST_ACTIVATE_PUSH) {
3067 /* we need new segment info after the flush. */
3068 basesink->have_newsegment = FALSE;
3069 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
3070 gst_segment_init (basesink->abidata.ABI.clip_segment, GST_FORMAT_UNDEFINED);
3072 GST_OBJECT_UNLOCK (basesink);
3076 gst_base_sink_event (GstPad * pad, GstEvent * event)
3078 GstBaseSink *basesink;
3079 gboolean result = TRUE;
3080 GstBaseSinkClass *bclass;
3082 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3084 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3086 GST_DEBUG_OBJECT (basesink, "event %p (%s)", event,
3087 GST_EVENT_TYPE_NAME (event));
3089 switch (GST_EVENT_TYPE (event)) {
3094 GST_PAD_PREROLL_LOCK (pad);
3095 if (G_UNLIKELY (basesink->flushing))
3098 if (G_UNLIKELY (basesink->priv->received_eos)) {
3099 /* we can't accept anything when we are EOS */
3101 gst_event_unref (event);
3103 /* we set the received EOS flag here so that we can use it when testing if
3104 * we are prerolled and to refuse more buffers. */
3105 basesink->priv->received_eos = TRUE;
3107 /* EOS is a prerollable object, we call the unlocked version because it
3108 * does not check the received_eos flag. */
3109 ret = gst_base_sink_queue_object_unlocked (basesink, pad,
3110 FALSE, GST_MINI_OBJECT_CAST (event), TRUE);
3111 if (G_UNLIKELY (ret != GST_FLOW_OK))
3114 GST_PAD_PREROLL_UNLOCK (pad);
3117 case GST_EVENT_NEWSEGMENT:
3121 GST_DEBUG_OBJECT (basesink, "newsegment %p", event);
3123 GST_PAD_PREROLL_LOCK (pad);
3124 if (G_UNLIKELY (basesink->flushing))
3127 if (G_UNLIKELY (basesink->priv->received_eos)) {
3128 /* we can't accept anything when we are EOS */
3130 gst_event_unref (event);
3132 /* the new segment is a non prerollable item and does not block anything,
3133 * we need to configure the current clipping segment and insert the event
3134 * in the queue to serialize it with the buffers for rendering. */
3135 gst_base_sink_configure_segment (basesink, pad, event,
3136 basesink->abidata.ABI.clip_segment);
3139 gst_base_sink_queue_object_unlocked (basesink, pad,
3140 FALSE, GST_MINI_OBJECT_CAST (event), FALSE);
3141 if (G_UNLIKELY (ret != GST_FLOW_OK))
3144 GST_OBJECT_LOCK (basesink);
3145 basesink->have_newsegment = TRUE;
3146 GST_OBJECT_UNLOCK (basesink);
3149 GST_PAD_PREROLL_UNLOCK (pad);
3152 case GST_EVENT_FLUSH_START:
3154 bclass->event (basesink, event);
3156 GST_DEBUG_OBJECT (basesink, "flush-start %p", event);
3158 gst_base_sink_flush_start (basesink, pad);
3160 gst_event_unref (event);
3162 case GST_EVENT_FLUSH_STOP:
3164 bclass->event (basesink, event);
3166 GST_DEBUG_OBJECT (basesink, "flush-stop %p", event);
3168 gst_base_sink_flush_stop (basesink, pad);
3170 gst_event_unref (event);
3173 /* other events are sent to queue or subclass depending on if they
3174 * are serialized. */
3175 if (GST_EVENT_IS_SERIALIZED (event)) {
3176 gst_base_sink_queue_object (basesink, pad,
3177 GST_MINI_OBJECT_CAST (event), FALSE);
3180 bclass->event (basesink, event);
3181 gst_event_unref (event);
3186 gst_object_unref (basesink);
3193 GST_DEBUG_OBJECT (basesink, "we are flushing");
3194 GST_PAD_PREROLL_UNLOCK (pad);
3196 gst_event_unref (event);
3201 /* default implementation to calculate the start and end
3202 * timestamps on a buffer, subclasses can override
3205 gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
3206 GstClockTime * start, GstClockTime * end)
3208 GstClockTime timestamp, duration;
3210 timestamp = GST_BUFFER_TIMESTAMP (buffer);
3211 if (GST_CLOCK_TIME_IS_VALID (timestamp)) {
3213 /* get duration to calculate end time */
3214 duration = GST_BUFFER_DURATION (buffer);
3215 if (GST_CLOCK_TIME_IS_VALID (duration)) {
3216 *end = timestamp + duration;
3222 /* must be called with PREROLL_LOCK */
3224 gst_base_sink_needs_preroll (GstBaseSink * basesink)
3226 gboolean is_prerolled, res;
3228 /* we have 2 cases where the PREROLL_LOCK is released:
3229 * 1) we are blocking in the PREROLL_LOCK and thus are prerolled.
3230 * 2) we are syncing on the clock
3232 is_prerolled = basesink->have_preroll || basesink->priv->received_eos;
3233 res = !is_prerolled;
3235 GST_DEBUG_OBJECT (basesink, "have_preroll: %d, EOS: %d => needs preroll: %d",
3236 basesink->have_preroll, basesink->priv->received_eos, res);
3241 /* with STREAM_LOCK, PREROLL_LOCK
3243 * Takes a buffer and compare the timestamps with the last segment.
3244 * If the buffer falls outside of the segment boundaries, drop it.
3245 * Else queue the buffer for preroll and rendering.
3247 * This function takes ownership of the buffer.
3249 static GstFlowReturn
3250 gst_base_sink_chain_unlocked (GstBaseSink * basesink, GstPad * pad,
3251 gboolean is_list, gpointer obj)
3253 GstBaseSinkClass *bclass;
3254 GstFlowReturn result;
3255 GstClockTime start = GST_CLOCK_TIME_NONE, end = GST_CLOCK_TIME_NONE;
3256 GstSegment *clip_segment;
3257 GstBuffer *time_buf;
3259 if (G_UNLIKELY (basesink->flushing))
3262 if (G_UNLIKELY (basesink->priv->received_eos))
3266 time_buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0, 0);
3267 g_assert (NULL != time_buf);
3269 time_buf = GST_BUFFER_CAST (obj);
3272 /* for code clarity */
3273 clip_segment = basesink->abidata.ABI.clip_segment;
3275 if (G_UNLIKELY (!basesink->have_newsegment)) {
3278 sync = gst_base_sink_get_sync (basesink);
3280 GST_ELEMENT_WARNING (basesink, STREAM, FAILED,
3281 (_("Internal data flow problem.")),
3282 ("Received buffer without a new-segment. Assuming timestamps start from 0."));
3285 /* this means this sink will assume timestamps start from 0 */
3286 GST_OBJECT_LOCK (basesink);
3287 clip_segment->start = 0;
3288 clip_segment->stop = -1;
3289 basesink->segment.start = 0;
3290 basesink->segment.stop = -1;
3291 basesink->have_newsegment = TRUE;
3292 GST_OBJECT_UNLOCK (basesink);
3295 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3297 /* check if the buffer needs to be dropped, we first ask the subclass for the
3299 if (bclass->get_times)
3300 bclass->get_times (basesink, time_buf, &start, &end);
3303 /* if the subclass does not want sync, we use our own values so that we at
3304 * least clip the buffer to the segment */
3305 gst_base_sink_get_times (basesink, time_buf, &start, &end);
3308 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
3309 ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (end));
3311 /* a dropped buffer does not participate in anything */
3312 if (GST_CLOCK_TIME_IS_VALID (start) &&
3313 (clip_segment->format == GST_FORMAT_TIME)) {
3314 if (G_UNLIKELY (!gst_segment_clip (clip_segment,
3315 GST_FORMAT_TIME, (gint64) start, (gint64) end, NULL, NULL)))
3316 goto out_of_segment;
3319 /* now we can process the buffer in the queue, this function takes ownership
3321 result = gst_base_sink_queue_object_unlocked (basesink, pad,
3322 is_list, obj, TRUE);
3328 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3329 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3330 return GST_FLOW_WRONG_STATE;
3334 GST_DEBUG_OBJECT (basesink,
3335 "we are EOS, dropping object, return UNEXPECTED");
3336 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3337 return GST_FLOW_UNEXPECTED;
3341 GST_DEBUG_OBJECT (basesink, "dropping buffer, out of clipping segment");
3342 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3349 static GstFlowReturn
3350 gst_base_sink_chain_main (GstBaseSink * basesink, GstPad * pad,
3351 gboolean is_list, gpointer obj)
3353 GstFlowReturn result;
3355 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH))
3358 GST_PAD_PREROLL_LOCK (pad);
3359 result = gst_base_sink_chain_unlocked (basesink, pad, is_list, obj);
3360 GST_PAD_PREROLL_UNLOCK (pad);
3368 GST_OBJECT_LOCK (pad);
3369 GST_WARNING_OBJECT (basesink,
3370 "Push on pad %s:%s, but it was not activated in push mode",
3371 GST_DEBUG_PAD_NAME (pad));
3372 GST_OBJECT_UNLOCK (pad);
3373 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3374 /* we don't post an error message this will signal to the peer
3375 * pushing that EOS is reached. */
3376 result = GST_FLOW_UNEXPECTED;
3381 static GstFlowReturn
3382 gst_base_sink_chain (GstPad * pad, GstBuffer * buf)
3384 GstBaseSink *basesink;
3386 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3388 return gst_base_sink_chain_main (basesink, pad, FALSE, buf);
3391 static GstFlowReturn
3392 gst_base_sink_chain_list (GstPad * pad, GstBufferList * list)
3394 GstBaseSink *basesink;
3395 GstBaseSinkClass *bclass;
3396 GstFlowReturn result;
3398 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3399 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3401 if (G_LIKELY (bclass->render_list)) {
3402 result = gst_base_sink_chain_main (basesink, pad, TRUE, list);
3404 GstBufferListIterator *it;
3407 GST_INFO_OBJECT (pad, "chaining each group in list as a merged buffer");
3409 it = gst_buffer_list_iterate (list);
3411 result = GST_FLOW_OK;
3412 if (gst_buffer_list_iterator_next_group (it)) {
3414 group = gst_buffer_list_iterator_merge_group (it);
3415 if (group == NULL) {
3416 group = gst_buffer_new ();
3417 GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining empty group");
3419 GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining group");
3421 result = gst_base_sink_chain_main (basesink, pad, FALSE, group);
3422 } while (result == GST_FLOW_OK
3423 && gst_buffer_list_iterator_next_group (it));
3425 GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining empty group");
3427 gst_base_sink_chain_main (basesink, pad, FALSE, gst_buffer_new ());
3429 gst_buffer_list_iterator_free (it);
3430 gst_buffer_list_unref (list);
3437 gst_base_sink_default_do_seek (GstBaseSink * sink, GstSegment * segment)
3439 gboolean res = TRUE;
3441 /* update our offset if the start/stop position was updated */
3442 if (segment->format == GST_FORMAT_BYTES) {
3443 segment->time = segment->start;
3444 } else if (segment->start == 0) {
3445 /* seek to start, we can implement a default for this. */
3449 GST_INFO_OBJECT (sink, "Can't do a default seek");
3455 #define SEEK_TYPE_IS_RELATIVE(t) (((t) != GST_SEEK_TYPE_NONE) && ((t) != GST_SEEK_TYPE_SET))
3458 gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
3459 GstEvent * event, GstSegment * segment)
3461 /* By default, we try one of 2 things:
3462 * - For absolute seek positions, convert the requested position to our
3463 * configured processing format and place it in the output segment \
3464 * - For relative seek positions, convert our current (input) values to the
3465 * seek format, adjust by the relative seek offset and then convert back to
3466 * the processing format
3468 GstSeekType cur_type, stop_type;
3471 GstFormat seek_format, dest_format;
3474 gboolean res = TRUE;
3476 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3477 &cur_type, &cur, &stop_type, &stop);
3478 dest_format = segment->format;
3480 if (seek_format == dest_format) {
3481 gst_segment_set_seek (segment, rate, seek_format, flags,
3482 cur_type, cur, stop_type, stop, &update);
3486 if (cur_type != GST_SEEK_TYPE_NONE) {
3487 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3489 gst_pad_query_convert (sink->sinkpad, seek_format, cur, &dest_format,
3491 cur_type = GST_SEEK_TYPE_SET;
3494 if (res && stop_type != GST_SEEK_TYPE_NONE) {
3495 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3497 gst_pad_query_convert (sink->sinkpad, seek_format, stop, &dest_format,
3499 stop_type = GST_SEEK_TYPE_SET;
3502 /* And finally, configure our output segment in the desired format */
3503 gst_segment_set_seek (segment, rate, dest_format, flags, cur_type, cur,
3504 stop_type, stop, &update);
3513 GST_DEBUG_OBJECT (sink, "undefined format given, seek aborted.");
3518 /* perform a seek, only executed in pull mode */
3520 gst_base_sink_perform_seek (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3524 GstFormat seek_format, dest_format;
3526 GstSeekType cur_type, stop_type;
3527 gboolean seekseg_configured = FALSE;
3529 gboolean update, res = TRUE;
3530 GstSegment seeksegment;
3532 dest_format = sink->segment.format;
3535 GST_DEBUG_OBJECT (sink, "performing seek with event %p", event);
3536 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3537 &cur_type, &cur, &stop_type, &stop);
3539 flush = flags & GST_SEEK_FLAG_FLUSH;
3541 GST_DEBUG_OBJECT (sink, "performing seek without event");
3546 GST_DEBUG_OBJECT (sink, "flushing upstream");
3547 gst_pad_push_event (pad, gst_event_new_flush_start ());
3548 gst_base_sink_flush_start (sink, pad);
3550 GST_DEBUG_OBJECT (sink, "pausing pulling thread");
3553 GST_PAD_STREAM_LOCK (pad);
3555 /* If we configured the seeksegment above, don't overwrite it now. Otherwise
3556 * copy the current segment info into the temp segment that we can actually
3557 * attempt the seek with. We only update the real segment if the seek suceeds. */
3558 if (!seekseg_configured) {
3559 memcpy (&seeksegment, &sink->segment, sizeof (GstSegment));
3561 /* now configure the final seek segment */
3563 if (sink->segment.format != seek_format) {
3564 /* OK, here's where we give the subclass a chance to convert the relative
3565 * seek into an absolute one in the processing format. We set up any
3566 * absolute seek above, before taking the stream lock. */
3567 if (!gst_base_sink_default_prepare_seek_segment (sink, event,
3569 GST_DEBUG_OBJECT (sink,
3570 "Preparing the seek failed after flushing. " "Aborting seek");
3574 /* The seek format matches our processing format, no need to ask the
3575 * the subclass to configure the segment. */
3576 gst_segment_set_seek (&seeksegment, rate, seek_format, flags,
3577 cur_type, cur, stop_type, stop, &update);
3580 /* Else, no seek event passed, so we're just (re)starting the
3585 GST_DEBUG_OBJECT (sink, "segment configured from %" G_GINT64_FORMAT
3586 " to %" G_GINT64_FORMAT ", position %" G_GINT64_FORMAT,
3587 seeksegment.start, seeksegment.stop, seeksegment.last_stop);
3589 /* do the seek, segment.last_stop contains the new position. */
3590 res = gst_base_sink_default_do_seek (sink, &seeksegment);
3595 GST_DEBUG_OBJECT (sink, "stop flushing upstream");
3596 gst_pad_push_event (pad, gst_event_new_flush_stop ());
3597 gst_base_sink_flush_stop (sink, pad);
3598 } else if (res && sink->abidata.ABI.running) {
3599 /* we are running the current segment and doing a non-flushing seek,
3600 * close the segment first based on the last_stop. */
3601 GST_DEBUG_OBJECT (sink, "closing running segment %" G_GINT64_FORMAT
3602 " to %" G_GINT64_FORMAT, sink->segment.start, sink->segment.last_stop);
3605 /* The subclass must have converted the segment to the processing format
3607 if (res && seeksegment.format != dest_format) {
3608 GST_DEBUG_OBJECT (sink, "Subclass failed to prepare a seek segment "
3609 "in the correct format. Aborting seek.");
3613 /* if successfull seek, we update our real segment and push
3614 * out the new segment. */
3616 memcpy (&sink->segment, &seeksegment, sizeof (GstSegment));
3618 if (sink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3619 gst_element_post_message (GST_ELEMENT (sink),
3620 gst_message_new_segment_start (GST_OBJECT (sink),
3621 sink->segment.format, sink->segment.last_stop));
3625 sink->priv->discont = TRUE;
3626 sink->abidata.ABI.running = TRUE;
3628 GST_PAD_STREAM_UNLOCK (pad);
3634 set_step_info (GstBaseSink * sink, GstStepInfo * current, GstStepInfo * pending,
3635 guint seqnum, GstFormat format, guint64 amount, gdouble rate,
3636 gboolean flush, gboolean intermediate)
3638 GST_OBJECT_LOCK (sink);
3639 pending->seqnum = seqnum;
3640 pending->format = format;
3641 pending->amount = amount;
3642 pending->position = 0;
3643 pending->rate = rate;
3644 pending->flush = flush;
3645 pending->intermediate = intermediate;
3646 pending->valid = TRUE;
3647 /* flush invalidates the current stepping segment */
3649 current->valid = FALSE;
3650 GST_OBJECT_UNLOCK (sink);
3654 gst_base_sink_perform_step (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3656 GstBaseSinkPrivate *priv;
3657 GstBaseSinkClass *bclass;
3658 gboolean flush, intermediate;
3663 GstStepInfo *pending, *current;
3664 GstMessage *message;
3666 bclass = GST_BASE_SINK_GET_CLASS (sink);
3669 GST_DEBUG_OBJECT (sink, "performing step with event %p", event);
3671 gst_event_parse_step (event, &format, &amount, &rate, &flush, &intermediate);
3672 seqnum = gst_event_get_seqnum (event);
3674 pending = &priv->pending_step;
3675 current = &priv->current_step;
3677 /* post message first */
3678 message = gst_message_new_step_start (GST_OBJECT (sink), FALSE, format,
3679 amount, rate, flush, intermediate);
3680 gst_message_set_seqnum (message, seqnum);
3681 gst_element_post_message (GST_ELEMENT (sink), message);
3684 /* we need to call ::unlock before locking PREROLL_LOCK
3685 * since we lock it before going into ::render */
3687 bclass->unlock (sink);
3689 GST_PAD_PREROLL_LOCK (sink->sinkpad);
3690 /* now that we have the PREROLL lock, clear our unlock request */
3691 if (bclass->unlock_stop)
3692 bclass->unlock_stop (sink);
3694 /* update the stepinfo and make it valid */
3695 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3698 if (sink->priv->async_enabled) {
3699 /* and we need to commit our state again on the next
3700 * prerolled buffer */
3701 sink->playing_async = TRUE;
3702 priv->pending_step.need_preroll = TRUE;
3703 sink->need_preroll = FALSE;
3704 gst_element_lost_state_full (GST_ELEMENT_CAST (sink), FALSE);
3706 sink->priv->have_latency = TRUE;
3707 sink->need_preroll = FALSE;
3709 priv->current_sstart = -1;
3710 priv->current_sstop = -1;
3711 priv->eos_rtime = -1;
3712 priv->call_preroll = TRUE;
3713 gst_base_sink_set_last_buffer (sink, NULL);
3714 gst_base_sink_reset_qos (sink);
3716 if (sink->clock_id) {
3717 gst_clock_id_unschedule (sink->clock_id);
3720 if (sink->have_preroll) {
3721 GST_DEBUG_OBJECT (sink, "signal waiter");
3722 priv->step_unlock = TRUE;
3723 GST_PAD_PREROLL_SIGNAL (sink->sinkpad);
3725 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
3727 /* update the stepinfo and make it valid */
3728 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3738 gst_base_sink_loop (GstPad * pad)
3740 GstBaseSink *basesink;
3741 GstBuffer *buf = NULL;
3742 GstFlowReturn result;
3746 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3748 g_assert (basesink->pad_mode == GST_ACTIVATE_PULL);
3750 if ((blocksize = basesink->priv->blocksize) == 0)
3753 offset = basesink->segment.last_stop;
3755 GST_DEBUG_OBJECT (basesink, "pulling %" G_GUINT64_FORMAT ", %u",
3758 result = gst_pad_pull_range (pad, offset, blocksize, &buf);
3759 if (G_UNLIKELY (result != GST_FLOW_OK))
3762 if (G_UNLIKELY (buf == NULL))
3765 offset += GST_BUFFER_SIZE (buf);
3767 gst_segment_set_last_stop (&basesink->segment, GST_FORMAT_BYTES, offset);
3769 GST_PAD_PREROLL_LOCK (pad);
3770 result = gst_base_sink_chain_unlocked (basesink, pad, FALSE, buf);
3771 GST_PAD_PREROLL_UNLOCK (pad);
3772 if (G_UNLIKELY (result != GST_FLOW_OK))
3780 GST_LOG_OBJECT (basesink, "pausing task, reason %s",
3781 gst_flow_get_name (result));
3782 gst_pad_pause_task (pad);
3783 /* fatal errors and NOT_LINKED cause EOS */
3784 if (GST_FLOW_IS_FATAL (result) || result == GST_FLOW_NOT_LINKED) {
3785 if (result == GST_FLOW_UNEXPECTED) {
3786 /* perform EOS logic */
3787 if (basesink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3788 gst_element_post_message (GST_ELEMENT_CAST (basesink),
3789 gst_message_new_segment_done (GST_OBJECT_CAST (basesink),
3790 basesink->segment.format, basesink->segment.last_stop));
3792 gst_base_sink_event (pad, gst_event_new_eos ());
3795 /* for fatal errors we post an error message, post the error
3796 * first so the app knows about the error first. */
3797 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
3798 (_("Internal data stream error.")),
3799 ("stream stopped, reason %s", gst_flow_get_name (result)));
3800 gst_base_sink_event (pad, gst_event_new_eos ());
3807 GST_LOG_OBJECT (basesink, "no buffer, pausing");
3808 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
3809 (_("Internal data flow error.")), ("element returned NULL buffer"));
3810 result = GST_FLOW_ERROR;
3816 gst_base_sink_set_flushing (GstBaseSink * basesink, GstPad * pad,
3819 GstBaseSinkClass *bclass;
3821 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3824 /* unlock any subclasses, we need to do this before grabbing the
3825 * PREROLL_LOCK since we hold this lock before going into ::render. */
3827 bclass->unlock (basesink);
3830 GST_PAD_PREROLL_LOCK (pad);
3831 basesink->flushing = flushing;
3833 /* step 1, now that we have the PREROLL lock, clear our unlock request */
3834 if (bclass->unlock_stop)
3835 bclass->unlock_stop (basesink);
3837 /* set need_preroll before we unblock the clock. If the clock is unblocked
3838 * before timing out, we can reuse the buffer for preroll. */
3839 basesink->need_preroll = TRUE;
3841 /* step 2, unblock clock sync (if any) or any other blocking thing */
3842 if (basesink->clock_id) {
3843 gst_clock_id_unschedule (basesink->clock_id);
3846 /* flush out the data thread if it's locked in finish_preroll, this will
3847 * also flush out the EOS state */
3848 GST_DEBUG_OBJECT (basesink,
3849 "flushing out data thread, need preroll to TRUE");
3850 gst_base_sink_preroll_queue_flush (basesink, pad);
3852 GST_PAD_PREROLL_UNLOCK (pad);
3858 gst_base_sink_default_activate_pull (GstBaseSink * basesink, gboolean active)
3864 result = gst_pad_start_task (basesink->sinkpad,
3865 (GstTaskFunction) gst_base_sink_loop, basesink->sinkpad);
3867 /* step 2, make sure streaming finishes */
3868 result = gst_pad_stop_task (basesink->sinkpad);
3875 gst_base_sink_pad_activate (GstPad * pad)
3877 gboolean result = FALSE;
3878 GstBaseSink *basesink;
3880 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3882 GST_DEBUG_OBJECT (basesink, "Trying pull mode first");
3884 gst_base_sink_set_flushing (basesink, pad, FALSE);
3886 /* we need to have the pull mode enabled */
3887 if (!basesink->can_activate_pull) {
3888 GST_DEBUG_OBJECT (basesink, "pull mode disabled");
3892 /* check if downstreams supports pull mode at all */
3893 if (!gst_pad_check_pull_range (pad)) {
3894 GST_DEBUG_OBJECT (basesink, "pull mode not supported");
3898 /* set the pad mode before starting the task so that it's in the
3899 * correct state for the new thread. also the sink set_caps and get_caps
3900 * function checks this */
3901 basesink->pad_mode = GST_ACTIVATE_PULL;
3903 /* we first try to negotiate a format so that when we try to activate
3904 * downstream, it knows about our format */
3905 if (!gst_base_sink_negotiate_pull (basesink)) {
3906 GST_DEBUG_OBJECT (basesink, "failed to negotiate in pull mode");
3910 /* ok activate now */
3911 if (!gst_pad_activate_pull (pad, TRUE)) {
3912 /* clear any pending caps */
3913 GST_OBJECT_LOCK (basesink);
3914 gst_caps_replace (&basesink->priv->pull_caps, NULL);
3915 GST_OBJECT_UNLOCK (basesink);
3916 GST_DEBUG_OBJECT (basesink, "failed to activate in pull mode");
3920 GST_DEBUG_OBJECT (basesink, "Success activating pull mode");
3924 /* push mode fallback */
3926 GST_DEBUG_OBJECT (basesink, "Falling back to push mode");
3927 if ((result = gst_pad_activate_push (pad, TRUE))) {
3928 GST_DEBUG_OBJECT (basesink, "Success activating push mode");
3933 GST_WARNING_OBJECT (basesink, "Could not activate pad in either mode");
3934 gst_base_sink_set_flushing (basesink, pad, TRUE);
3937 gst_object_unref (basesink);
3943 gst_base_sink_pad_activate_push (GstPad * pad, gboolean active)
3946 GstBaseSink *basesink;
3948 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3951 if (!basesink->can_activate_push) {
3953 basesink->pad_mode = GST_ACTIVATE_NONE;
3956 basesink->pad_mode = GST_ACTIVATE_PUSH;
3959 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH)) {
3960 g_warning ("Internal GStreamer activation error!!!");
3963 gst_base_sink_set_flushing (basesink, pad, TRUE);
3965 basesink->pad_mode = GST_ACTIVATE_NONE;
3969 gst_object_unref (basesink);
3975 gst_base_sink_negotiate_pull (GstBaseSink * basesink)
3982 /* this returns the intersection between our caps and the peer caps. If there
3983 * is no peer, it returns NULL and we can't operate in pull mode so we can
3984 * fail the negotiation. */
3985 caps = gst_pad_get_allowed_caps (GST_BASE_SINK_PAD (basesink));
3986 if (caps == NULL || gst_caps_is_empty (caps))
3987 goto no_caps_possible;
3989 GST_DEBUG_OBJECT (basesink, "allowed caps: %" GST_PTR_FORMAT, caps);
3991 caps = gst_caps_make_writable (caps);
3992 /* get the first (prefered) format */
3993 gst_caps_truncate (caps);
3995 gst_pad_fixate_caps (GST_BASE_SINK_PAD (basesink), caps);
3997 GST_DEBUG_OBJECT (basesink, "fixated to: %" GST_PTR_FORMAT, caps);
3999 if (gst_caps_is_any (caps)) {
4000 GST_DEBUG_OBJECT (basesink, "caps were ANY after fixating, "
4002 /* neither side has template caps in this case, so they are prepared for
4003 pull() without setcaps() */
4005 } else if (gst_caps_is_fixed (caps)) {
4006 if (!gst_pad_set_caps (GST_BASE_SINK_PAD (basesink), caps))
4007 goto could_not_set_caps;
4009 GST_OBJECT_LOCK (basesink);
4010 gst_caps_replace (&basesink->priv->pull_caps, caps);
4011 GST_OBJECT_UNLOCK (basesink);
4016 gst_caps_unref (caps);
4022 GST_INFO_OBJECT (basesink, "Pipeline could not agree on caps");
4023 GST_DEBUG_OBJECT (basesink, "get_allowed_caps() returned EMPTY");
4025 gst_caps_unref (caps);
4030 GST_INFO_OBJECT (basesink, "Could not set caps: %" GST_PTR_FORMAT, caps);
4031 gst_caps_unref (caps);
4036 /* this won't get called until we implement an activate function */
4038 gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active)
4040 gboolean result = FALSE;
4041 GstBaseSink *basesink;
4042 GstBaseSinkClass *bclass;
4044 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4045 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4051 /* we mark we have a newsegment here because pull based
4052 * mode works just fine without having a newsegment before the
4054 format = GST_FORMAT_BYTES;
4056 gst_segment_init (&basesink->segment, format);
4057 gst_segment_init (basesink->abidata.ABI.clip_segment, format);
4058 GST_OBJECT_LOCK (basesink);
4059 basesink->have_newsegment = TRUE;
4060 GST_OBJECT_UNLOCK (basesink);
4062 /* get the peer duration in bytes */
4063 result = gst_pad_query_peer_duration (pad, &format, &duration);
4065 GST_DEBUG_OBJECT (basesink,
4066 "setting duration in bytes to %" G_GINT64_FORMAT, duration);
4067 gst_segment_set_duration (basesink->abidata.ABI.clip_segment, format,
4069 gst_segment_set_duration (&basesink->segment, format, duration);
4071 GST_DEBUG_OBJECT (basesink, "unknown duration");
4074 if (bclass->activate_pull)
4075 result = bclass->activate_pull (basesink, TRUE);
4080 goto activate_failed;
4083 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PULL)) {
4084 g_warning ("Internal GStreamer activation error!!!");
4087 result = gst_base_sink_set_flushing (basesink, pad, TRUE);
4088 if (bclass->activate_pull)
4089 result &= bclass->activate_pull (basesink, FALSE);
4090 basesink->pad_mode = GST_ACTIVATE_NONE;
4091 /* clear any pending caps */
4092 GST_OBJECT_LOCK (basesink);
4093 gst_caps_replace (&basesink->priv->pull_caps, NULL);
4094 GST_OBJECT_UNLOCK (basesink);
4097 gst_object_unref (basesink);
4104 /* reset, as starting the thread failed */
4105 basesink->pad_mode = GST_ACTIVATE_NONE;
4107 GST_ERROR_OBJECT (basesink, "subclass failed to activate in pull mode");
4112 /* send an event to our sinkpad peer. */
4114 gst_base_sink_send_event (GstElement * element, GstEvent * event)
4117 GstBaseSink *basesink = GST_BASE_SINK (element);
4118 gboolean forward, result = TRUE;
4119 GstActivateMode mode;
4121 GST_OBJECT_LOCK (element);
4122 /* get the pad and the scheduling mode */
4123 pad = gst_object_ref (basesink->sinkpad);
4124 mode = basesink->pad_mode;
4125 GST_OBJECT_UNLOCK (element);
4127 /* only push UPSTREAM events upstream */
4128 forward = GST_EVENT_IS_UPSTREAM (event);
4130 switch (GST_EVENT_TYPE (event)) {
4131 case GST_EVENT_LATENCY:
4133 GstClockTime latency;
4135 gst_event_parse_latency (event, &latency);
4137 /* store the latency. We use this to adjust the running_time before syncing
4138 * it to the clock. */
4139 GST_OBJECT_LOCK (element);
4140 basesink->priv->latency = latency;
4141 if (!basesink->priv->have_latency)
4143 GST_OBJECT_UNLOCK (element);
4144 GST_DEBUG_OBJECT (basesink, "latency set to %" GST_TIME_FORMAT,
4145 GST_TIME_ARGS (latency));
4147 /* We forward this event so that all elements know about the global pipeline
4148 * latency. This is interesting for an element when it wants to figure out
4149 * when a particular piece of data will be rendered. */
4152 case GST_EVENT_SEEK:
4153 /* in pull mode we will execute the seek */
4154 if (mode == GST_ACTIVATE_PULL)
4155 result = gst_base_sink_perform_seek (basesink, pad, event);
4157 case GST_EVENT_STEP:
4158 result = gst_base_sink_perform_step (basesink, pad, event);
4166 result = gst_pad_push_event (pad, event);
4168 /* not forwarded, unref the event */
4169 gst_event_unref (event);
4172 gst_object_unref (pad);
4177 gst_base_sink_peer_query (GstBaseSink * sink, GstQuery * query)
4180 gboolean res = FALSE;
4182 if ((peer = gst_pad_get_peer (sink->sinkpad))) {
4183 res = gst_pad_query (peer, query);
4184 gst_object_unref (peer);
4189 /* get the end position of the last seen object, this is used
4190 * for EOS and for making sure that we don't report a position we
4191 * have not reached yet. With LOCK. */
4193 gst_base_sink_get_position_last (GstBaseSink * basesink, GstFormat format,
4197 GstSegment *segment;
4198 gboolean ret = TRUE;
4200 segment = &basesink->segment;
4201 oformat = segment->format;
4203 if (oformat == GST_FORMAT_TIME) {
4204 /* return last observed stream time, we keep the stream time around in the
4206 *cur = basesink->priv->current_sstop;
4208 /* convert last stop to stream time */
4209 *cur = gst_segment_to_stream_time (segment, oformat, segment->last_stop);
4212 if (*cur != -1 && oformat != format) {
4213 GST_OBJECT_UNLOCK (basesink);
4214 /* convert to the target format if we need to, release lock first */
4216 gst_pad_query_convert (basesink->sinkpad, oformat, *cur, &format, cur);
4219 GST_OBJECT_LOCK (basesink);
4222 GST_DEBUG_OBJECT (basesink, "POSITION: %" GST_TIME_FORMAT,
4223 GST_TIME_ARGS (*cur));
4228 /* get the position when we are PAUSED, this is the stream time of the buffer
4229 * that prerolled. If no buffer is prerolled (we are still flushing), this
4230 * value will be -1. With LOCK. */
4232 gst_base_sink_get_position_paused (GstBaseSink * basesink, GstFormat format,
4237 GstSegment *segment;
4240 /* we don't use the clip segment in pull mode, when seeking we update the
4241 * main segment directly with the new segment values without it having to be
4242 * activated by the rendering after preroll */
4243 if (basesink->pad_mode == GST_ACTIVATE_PUSH)
4244 segment = basesink->abidata.ABI.clip_segment;
4246 segment = &basesink->segment;
4247 oformat = segment->format;
4249 if (oformat == GST_FORMAT_TIME) {
4250 *cur = basesink->priv->current_sstart;
4251 if (segment->rate < 0.0 && basesink->priv->current_sstop != -1) {
4252 /* for reverse playback we prefer the stream time stop position if we have
4254 *cur = basesink->priv->current_sstop;
4257 *cur = gst_segment_to_stream_time (segment, oformat, segment->last_stop);
4260 time = segment->time;
4263 *cur = MAX (*cur, time);
4264 GST_DEBUG_OBJECT (basesink, "POSITION as max: %" GST_TIME_FORMAT
4265 ", time %" GST_TIME_FORMAT, GST_TIME_ARGS (*cur), GST_TIME_ARGS (time));
4267 /* we have no buffer, use the segment times. */
4268 if (segment->rate >= 0.0) {
4269 /* forward, next position is always the time of the segment */
4271 GST_DEBUG_OBJECT (basesink, "POSITION as time: %" GST_TIME_FORMAT,
4272 GST_TIME_ARGS (*cur));
4274 /* reverse, next expected timestamp is segment->stop. We use the function
4275 * to get things right for negative applied_rates. */
4276 *cur = gst_segment_to_stream_time (segment, oformat, segment->stop);
4277 GST_DEBUG_OBJECT (basesink, "reverse POSITION: %" GST_TIME_FORMAT,
4278 GST_TIME_ARGS (*cur));
4283 if (res && oformat != format) {
4284 GST_OBJECT_UNLOCK (basesink);
4286 gst_pad_query_convert (basesink->sinkpad, oformat, *cur, &format, cur);
4289 GST_OBJECT_LOCK (basesink);
4296 gst_base_sink_get_position (GstBaseSink * basesink, GstFormat format,
4297 gint64 * cur, gboolean * upstream)
4300 gboolean res = FALSE;
4301 GstFormat oformat, tformat;
4302 GstClockTime now, base, latency;
4303 gint64 time, accum, duration;
4307 GST_OBJECT_LOCK (basesink);
4308 /* our intermediate time format */
4309 tformat = GST_FORMAT_TIME;
4310 /* get the format in the segment */
4311 oformat = basesink->segment.format;
4313 /* can only give answer based on the clock if not EOS */
4314 if (G_UNLIKELY (basesink->eos))
4317 /* we can only get the segment when we are not NULL or READY */
4318 if (!basesink->have_newsegment)
4321 /* when not in PLAYING or when we're busy with a state change, we
4322 * cannot read from the clock so we report time based on the
4323 * last seen timestamp. */
4324 if (GST_STATE (basesink) != GST_STATE_PLAYING ||
4325 GST_STATE_PENDING (basesink) != GST_STATE_VOID_PENDING)
4328 /* we need to sync on the clock. */
4329 if (basesink->sync == FALSE)
4332 /* and we need a clock */
4333 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (basesink)) == NULL))
4336 /* collect all data we need holding the lock */
4337 if (GST_CLOCK_TIME_IS_VALID (basesink->segment.time))
4338 time = basesink->segment.time;
4342 if (GST_CLOCK_TIME_IS_VALID (basesink->segment.stop))
4343 duration = basesink->segment.stop - basesink->segment.start;
4347 base = GST_ELEMENT_CAST (basesink)->base_time;
4348 accum = basesink->segment.accum;
4349 rate = basesink->segment.rate * basesink->segment.applied_rate;
4350 latency = basesink->priv->latency;
4352 gst_object_ref (clock);
4354 /* this function might release the LOCK */
4355 gst_base_sink_get_position_last (basesink, format, &last);
4357 /* need to release the object lock before we can get the time,
4358 * a clock might take the LOCK of the provider, which could be
4359 * a basesink subclass. */
4360 GST_OBJECT_UNLOCK (basesink);
4362 now = gst_clock_get_time (clock);
4364 if (oformat != tformat) {
4365 /* convert accum, time and duration to time */
4366 if (!gst_pad_query_convert (basesink->sinkpad, oformat, accum, &tformat,
4368 goto convert_failed;
4369 if (!gst_pad_query_convert (basesink->sinkpad, oformat, duration, &tformat,
4371 goto convert_failed;
4372 if (!gst_pad_query_convert (basesink->sinkpad, oformat, time, &tformat,
4374 goto convert_failed;
4377 /* subtract base time and accumulated time from the clock time.
4378 * Make sure we don't go negative. This is the current time in
4379 * the segment which we need to scale with the combined
4380 * rate and applied rate. */
4383 base = MIN (now, base);
4385 /* for negative rates we need to count back from from the segment
4390 *cur = time + gst_guint64_to_gdouble (now - base) * rate;
4392 /* never report more than last seen position */
4394 *cur = MIN (last, *cur);
4396 gst_object_unref (clock);
4398 GST_DEBUG_OBJECT (basesink,
4399 "now %" GST_TIME_FORMAT " - base %" GST_TIME_FORMAT " - accum %"
4400 GST_TIME_FORMAT " + time %" GST_TIME_FORMAT,
4401 GST_TIME_ARGS (now), GST_TIME_ARGS (base),
4402 GST_TIME_ARGS (accum), GST_TIME_ARGS (time));
4404 if (oformat != format) {
4405 /* convert time to final format */
4406 if (!gst_pad_query_convert (basesink->sinkpad, tformat, *cur, &format, cur))
4407 goto convert_failed;
4413 GST_DEBUG_OBJECT (basesink, "res: %d, POSITION: %" GST_TIME_FORMAT,
4414 res, GST_TIME_ARGS (*cur));
4420 GST_DEBUG_OBJECT (basesink, "position in EOS");
4421 res = gst_base_sink_get_position_last (basesink, format, cur);
4422 GST_OBJECT_UNLOCK (basesink);
4427 GST_DEBUG_OBJECT (basesink, "position in PAUSED");
4428 res = gst_base_sink_get_position_paused (basesink, format, cur);
4429 GST_OBJECT_UNLOCK (basesink);
4434 /* in NULL or READY we always return FALSE and -1 */
4435 GST_DEBUG_OBJECT (basesink, "position in wrong state, return -1");
4438 GST_OBJECT_UNLOCK (basesink);
4443 /* report last seen timestamp if any, else ask upstream to answer */
4444 if ((*cur = basesink->priv->current_sstart) != -1)
4449 GST_DEBUG_OBJECT (basesink, "no sync, res %d, POSITION %" GST_TIME_FORMAT,
4450 res, GST_TIME_ARGS (*cur));
4451 GST_OBJECT_UNLOCK (basesink);
4456 GST_DEBUG_OBJECT (basesink, "convert failed, try upstream");
4463 gst_base_sink_query (GstElement * element, GstQuery * query)
4465 gboolean res = FALSE;
4467 GstBaseSink *basesink = GST_BASE_SINK (element);
4469 switch (GST_QUERY_TYPE (query)) {
4470 case GST_QUERY_POSITION:
4474 gboolean upstream = FALSE;
4476 gst_query_parse_position (query, &format, NULL);
4478 GST_DEBUG_OBJECT (basesink, "position format %d", format);
4480 /* first try to get the position based on the clock */
4482 gst_base_sink_get_position (basesink, format, &cur, &upstream))) {
4483 gst_query_set_position (query, format, cur);
4484 } else if (upstream) {
4485 /* fallback to peer query */
4486 res = gst_base_sink_peer_query (basesink, query);
4490 case GST_QUERY_DURATION:
4492 GstFormat format, uformat;
4493 gint64 duration, uduration;
4495 gst_query_parse_duration (query, &format, NULL);
4497 GST_DEBUG_OBJECT (basesink, "duration query in format %s",
4498 gst_format_get_name (format));
4500 if (basesink->pad_mode == GST_ACTIVATE_PULL) {
4501 uformat = GST_FORMAT_BYTES;
4503 /* get the duration in bytes, in pull mode that's all we are sure to
4504 * know. We have to explicitly get this value from upstream instead of
4505 * using our cached value because it might change. Duration caching
4506 * should be done at a higher level. */
4507 res = gst_pad_query_peer_duration (basesink->sinkpad, &uformat,
4510 gst_segment_set_duration (&basesink->segment, uformat, uduration);
4511 if (format != uformat) {
4512 /* convert to the requested format */
4513 res = gst_pad_query_convert (basesink->sinkpad, uformat, uduration,
4514 &format, &duration);
4516 duration = uduration;
4519 /* set the result */
4520 gst_query_set_duration (query, format, duration);
4524 /* in push mode we simply forward upstream */
4525 res = gst_base_sink_peer_query (basesink, query);
4529 case GST_QUERY_LATENCY:
4531 gboolean live, us_live;
4532 GstClockTime min, max;
4534 if ((res = gst_base_sink_query_latency (basesink, &live, &us_live, &min,
4536 gst_query_set_latency (query, live, min, max);
4540 case GST_QUERY_JITTER:
4542 case GST_QUERY_RATE:
4543 /* gst_query_set_rate (query, basesink->segment_rate); */
4546 case GST_QUERY_SEGMENT:
4548 /* FIXME, bring start/stop to stream time */
4549 gst_query_set_segment (query, basesink->segment.rate,
4550 GST_FORMAT_TIME, basesink->segment.start, basesink->segment.stop);
4553 case GST_QUERY_SEEKING:
4554 case GST_QUERY_CONVERT:
4555 case GST_QUERY_FORMATS:
4557 res = gst_base_sink_peer_query (basesink, query);
4563 static GstStateChangeReturn
4564 gst_base_sink_change_state (GstElement * element, GstStateChange transition)
4566 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
4567 GstBaseSink *basesink = GST_BASE_SINK (element);
4568 GstBaseSinkClass *bclass;
4569 GstBaseSinkPrivate *priv;
4571 priv = basesink->priv;
4573 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4575 switch (transition) {
4576 case GST_STATE_CHANGE_NULL_TO_READY:
4578 if (!bclass->start (basesink))
4581 case GST_STATE_CHANGE_READY_TO_PAUSED:
4582 /* need to complete preroll before this state change completes, there
4583 * is no data flow in READY so we can safely assume we need to preroll. */
4584 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4585 GST_DEBUG_OBJECT (basesink, "READY to PAUSED");
4586 basesink->have_newsegment = FALSE;
4587 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
4588 gst_segment_init (basesink->abidata.ABI.clip_segment,
4589 GST_FORMAT_UNDEFINED);
4590 basesink->offset = 0;
4591 basesink->have_preroll = FALSE;
4592 priv->step_unlock = FALSE;
4593 basesink->need_preroll = TRUE;
4594 basesink->playing_async = TRUE;
4595 priv->current_sstart = -1;
4596 priv->current_sstop = -1;
4597 priv->eos_rtime = -1;
4599 basesink->eos = FALSE;
4600 priv->received_eos = FALSE;
4601 gst_base_sink_reset_qos (basesink);
4602 priv->commited = FALSE;
4603 priv->call_preroll = TRUE;
4604 priv->current_step.valid = FALSE;
4605 priv->pending_step.valid = FALSE;
4606 if (priv->async_enabled) {
4607 GST_DEBUG_OBJECT (basesink, "doing async state change");
4608 /* when async enabled, post async-start message and return ASYNC from
4609 * the state change function */
4610 ret = GST_STATE_CHANGE_ASYNC;
4611 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4612 gst_message_new_async_start (GST_OBJECT_CAST (basesink), FALSE));
4614 priv->have_latency = TRUE;
4616 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4618 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
4619 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4620 if (!gst_base_sink_needs_preroll (basesink)) {
4621 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, don't need preroll");
4622 /* no preroll needed anymore now. */
4623 basesink->playing_async = FALSE;
4624 basesink->need_preroll = FALSE;
4625 if (basesink->eos) {
4626 GstMessage *message;
4628 /* need to post EOS message here */
4629 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
4630 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
4631 gst_message_set_seqnum (message, basesink->priv->seqnum);
4632 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
4634 GST_DEBUG_OBJECT (basesink, "signal preroll");
4635 GST_PAD_PREROLL_SIGNAL (basesink->sinkpad);
4638 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, we are not prerolled");
4639 basesink->need_preroll = TRUE;
4640 basesink->playing_async = TRUE;
4641 priv->call_preroll = TRUE;
4642 priv->commited = FALSE;
4643 if (priv->async_enabled) {
4644 GST_DEBUG_OBJECT (basesink, "doing async state change");
4645 ret = GST_STATE_CHANGE_ASYNC;
4646 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4647 gst_message_new_async_start (GST_OBJECT_CAST (basesink), FALSE));
4650 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4657 GstStateChangeReturn bret;
4659 bret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
4660 if (G_UNLIKELY (bret == GST_STATE_CHANGE_FAILURE))
4661 goto activate_failed;
4664 switch (transition) {
4665 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
4666 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED");
4667 /* FIXME, make sure we cannot enter _render first */
4669 /* we need to call ::unlock before locking PREROLL_LOCK
4670 * since we lock it before going into ::render */
4672 bclass->unlock (basesink);
4674 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4675 /* now that we have the PREROLL lock, clear our unlock request */
4676 if (bclass->unlock_stop)
4677 bclass->unlock_stop (basesink);
4679 /* we need preroll again and we set the flag before unlocking the clockid
4680 * because if the clockid is unlocked before a current buffer expired, we
4681 * can use that buffer to preroll with */
4682 basesink->need_preroll = TRUE;
4684 if (basesink->clock_id) {
4685 gst_clock_id_unschedule (basesink->clock_id);
4688 /* if we don't have a preroll buffer we need to wait for a preroll and
4690 if (!gst_base_sink_needs_preroll (basesink)) {
4691 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED, we are prerolled");
4692 basesink->playing_async = FALSE;
4694 if (GST_STATE_TARGET (GST_ELEMENT (basesink)) <= GST_STATE_READY) {
4695 ret = GST_STATE_CHANGE_SUCCESS;
4697 GST_DEBUG_OBJECT (basesink,
4698 "PLAYING to PAUSED, we are not prerolled");
4699 basesink->playing_async = TRUE;
4700 priv->commited = FALSE;
4701 priv->call_preroll = TRUE;
4702 if (priv->async_enabled) {
4703 GST_DEBUG_OBJECT (basesink, "doing async state change");
4704 ret = GST_STATE_CHANGE_ASYNC;
4705 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4706 gst_message_new_async_start (GST_OBJECT_CAST (basesink),
4711 GST_DEBUG_OBJECT (basesink, "rendered: %" G_GUINT64_FORMAT
4712 ", dropped: %" G_GUINT64_FORMAT, priv->rendered, priv->dropped);
4714 gst_base_sink_reset_qos (basesink);
4715 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4717 case GST_STATE_CHANGE_PAUSED_TO_READY:
4718 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4719 /* start by reseting our position state with the object lock so that the
4720 * position query gets the right idea. We do this before we post the
4721 * messages so that the message handlers pick this up. */
4722 GST_OBJECT_LOCK (basesink);
4723 basesink->have_newsegment = FALSE;
4724 priv->current_sstart = -1;
4725 priv->current_sstop = -1;
4726 priv->have_latency = FALSE;
4727 GST_OBJECT_UNLOCK (basesink);
4729 gst_base_sink_set_last_buffer (basesink, NULL);
4730 priv->call_preroll = FALSE;
4732 if (!priv->commited) {
4733 if (priv->async_enabled) {
4734 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, posting async-done");
4736 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4737 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
4738 GST_STATE_PLAYING, GST_STATE_PAUSED, GST_STATE_READY));
4740 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4741 gst_message_new_async_done (GST_OBJECT_CAST (basesink)));
4743 priv->commited = TRUE;
4745 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, don't need_preroll");
4747 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4749 case GST_STATE_CHANGE_READY_TO_NULL:
4751 if (!bclass->stop (basesink)) {
4752 GST_WARNING_OBJECT (basesink, "failed to stop");
4755 gst_base_sink_set_last_buffer (basesink, NULL);
4756 priv->call_preroll = FALSE;
4767 GST_DEBUG_OBJECT (basesink, "failed to start");
4768 return GST_STATE_CHANGE_FAILURE;
4772 GST_DEBUG_OBJECT (basesink,
4773 "element failed to change states -- activation problem?");
4774 return GST_STATE_CHANGE_FAILURE;