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 void gst_base_sink_loop (GstPad * pad);
355 static gboolean gst_base_sink_pad_activate (GstPad * pad);
356 static gboolean gst_base_sink_pad_activate_push (GstPad * pad, gboolean active);
357 static gboolean gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active);
358 static gboolean gst_base_sink_event (GstPad * pad, GstEvent * event);
359 static gboolean gst_base_sink_peer_query (GstBaseSink * sink, GstQuery * query);
361 static gboolean gst_base_sink_negotiate_pull (GstBaseSink * basesink);
363 /* check if an object was too late */
364 static gboolean gst_base_sink_is_too_late (GstBaseSink * basesink,
365 GstMiniObject * obj, GstClockTime start, GstClockTime stop,
366 GstClockReturn status, GstClockTimeDiff jitter);
367 static GstFlowReturn gst_base_sink_preroll_object (GstBaseSink * basesink,
368 GstMiniObject * obj);
371 gst_base_sink_class_init (GstBaseSinkClass * klass)
373 GObjectClass *gobject_class;
374 GstElementClass *gstelement_class;
376 gobject_class = G_OBJECT_CLASS (klass);
377 gstelement_class = GST_ELEMENT_CLASS (klass);
379 GST_DEBUG_CATEGORY_INIT (gst_base_sink_debug, "basesink", 0,
382 g_type_class_add_private (klass, sizeof (GstBaseSinkPrivate));
384 parent_class = g_type_class_peek_parent (klass);
386 gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_base_sink_finalize);
387 gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_base_sink_set_property);
388 gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_base_sink_get_property);
390 /* FIXME, this next value should be configured using an event from the
391 * upstream element, ie, the BUFFER_SIZE event. */
392 g_object_class_install_property (gobject_class, PROP_PREROLL_QUEUE_LEN,
393 g_param_spec_uint ("preroll-queue-len", "Preroll queue length",
394 "Number of buffers to queue during preroll", 0, G_MAXUINT,
395 DEFAULT_PREROLL_QUEUE_LEN,
396 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
398 g_object_class_install_property (gobject_class, PROP_SYNC,
399 g_param_spec_boolean ("sync", "Sync", "Sync on the clock", DEFAULT_SYNC,
400 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
402 g_object_class_install_property (gobject_class, PROP_MAX_LATENESS,
403 g_param_spec_int64 ("max-lateness", "Max Lateness",
404 "Maximum number of nanoseconds that a buffer can be late before it "
405 "is dropped (-1 unlimited)", -1, G_MAXINT64, DEFAULT_MAX_LATENESS,
406 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
408 g_object_class_install_property (gobject_class, PROP_QOS,
409 g_param_spec_boolean ("qos", "Qos",
410 "Generate Quality-of-Service events upstream", DEFAULT_QOS,
411 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
415 * If set to #TRUE, the basesink will perform asynchronous state changes.
416 * When set to #FALSE, the sink will not signal the parent when it prerolls.
417 * Use this option when dealing with sparse streams or when synchronisation is
422 g_object_class_install_property (gobject_class, PROP_ASYNC,
423 g_param_spec_boolean ("async", "Async",
424 "Go asynchronously to PAUSED", DEFAULT_ASYNC,
425 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
427 * GstBaseSink:ts-offset
429 * Controls the final synchronisation, a negative value will render the buffer
430 * earlier while a positive value delays playback. This property can be
431 * used to fix synchronisation in bad files.
435 g_object_class_install_property (gobject_class, PROP_TS_OFFSET,
436 g_param_spec_int64 ("ts-offset", "TS Offset",
437 "Timestamp offset in nanoseconds", G_MININT64, G_MAXINT64,
438 DEFAULT_TS_OFFSET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
440 * GstBaseSink:last-buffer
442 * The last buffer that arrived in the sink and was used for preroll or for
443 * rendering. This property can be used to generate thumbnails. This property
444 * can be NULL when the sink has not yet received a bufer.
448 g_object_class_install_property (gobject_class, PROP_LAST_BUFFER,
449 gst_param_spec_mini_object ("last-buffer", "Last Buffer",
450 "The last buffer received in the sink", GST_TYPE_BUFFER,
451 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
453 * GstBaseSink:blocksize
455 * The amount of bytes to pull when operating in pull mode.
459 g_object_class_install_property (gobject_class, PROP_BLOCKSIZE,
460 g_param_spec_uint ("blocksize", "Block size",
461 "Size in bytes to pull per buffer (0 = default)", 0, G_MAXUINT,
462 DEFAULT_BLOCKSIZE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
464 * GstBaseSink:render-delay
466 * The additional delay between synchronisation and actual rendering of the
467 * media. This property will add additional latency to the device in order to
468 * make other sinks compensate for the delay.
472 g_object_class_install_property (gobject_class, PROP_RENDER_DELAY,
473 g_param_spec_uint64 ("render-delay", "Render Delay",
474 "Additional render delay of the sink in nanoseconds", 0, G_MAXUINT64,
475 DEFAULT_RENDER_DELAY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
477 gstelement_class->change_state =
478 GST_DEBUG_FUNCPTR (gst_base_sink_change_state);
479 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_base_sink_send_event);
480 gstelement_class->query = GST_DEBUG_FUNCPTR (gst_base_sink_query);
482 klass->get_caps = GST_DEBUG_FUNCPTR (gst_base_sink_get_caps);
483 klass->set_caps = GST_DEBUG_FUNCPTR (gst_base_sink_set_caps);
484 klass->buffer_alloc = GST_DEBUG_FUNCPTR (gst_base_sink_buffer_alloc);
485 klass->get_times = GST_DEBUG_FUNCPTR (gst_base_sink_get_times);
486 klass->activate_pull =
487 GST_DEBUG_FUNCPTR (gst_base_sink_default_activate_pull);
491 gst_base_sink_pad_getcaps (GstPad * pad)
493 GstBaseSinkClass *bclass;
495 GstCaps *caps = NULL;
497 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
498 bclass = GST_BASE_SINK_GET_CLASS (bsink);
500 if (bsink->pad_mode == GST_ACTIVATE_PULL) {
501 /* if we are operating in pull mode we only accept the negotiated caps */
502 GST_OBJECT_LOCK (pad);
503 if ((caps = GST_PAD_CAPS (pad)))
505 GST_OBJECT_UNLOCK (pad);
508 if (bclass->get_caps)
509 caps = bclass->get_caps (bsink);
512 GstPadTemplate *pad_template;
515 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass),
517 if (pad_template != NULL) {
518 caps = gst_caps_ref (gst_pad_template_get_caps (pad_template));
522 gst_object_unref (bsink);
528 gst_base_sink_pad_setcaps (GstPad * pad, GstCaps * caps)
530 GstBaseSinkClass *bclass;
534 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
535 bclass = GST_BASE_SINK_GET_CLASS (bsink);
537 if (res && bclass->set_caps)
538 res = bclass->set_caps (bsink, caps);
540 gst_object_unref (bsink);
546 gst_base_sink_pad_fixate (GstPad * pad, GstCaps * caps)
548 GstBaseSinkClass *bclass;
551 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
552 bclass = GST_BASE_SINK_GET_CLASS (bsink);
555 bclass->fixate (bsink, caps);
557 gst_object_unref (bsink);
561 gst_base_sink_pad_buffer_alloc (GstPad * pad, guint64 offset, guint size,
562 GstCaps * caps, GstBuffer ** buf)
564 GstBaseSinkClass *bclass;
566 GstFlowReturn result = GST_FLOW_OK;
568 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
569 bclass = GST_BASE_SINK_GET_CLASS (bsink);
571 if (bclass->buffer_alloc)
572 result = bclass->buffer_alloc (bsink, offset, size, caps, buf);
574 *buf = NULL; /* fallback in gstpad.c will allocate generic buffer */
576 gst_object_unref (bsink);
582 gst_base_sink_init (GstBaseSink * basesink, gpointer g_class)
584 GstPadTemplate *pad_template;
585 GstBaseSinkPrivate *priv;
587 basesink->priv = priv = GST_BASE_SINK_GET_PRIVATE (basesink);
590 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "sink");
591 g_return_if_fail (pad_template != NULL);
593 basesink->sinkpad = gst_pad_new_from_template (pad_template, "sink");
595 gst_pad_set_getcaps_function (basesink->sinkpad,
596 GST_DEBUG_FUNCPTR (gst_base_sink_pad_getcaps));
597 gst_pad_set_setcaps_function (basesink->sinkpad,
598 GST_DEBUG_FUNCPTR (gst_base_sink_pad_setcaps));
599 gst_pad_set_fixatecaps_function (basesink->sinkpad,
600 GST_DEBUG_FUNCPTR (gst_base_sink_pad_fixate));
601 gst_pad_set_bufferalloc_function (basesink->sinkpad,
602 GST_DEBUG_FUNCPTR (gst_base_sink_pad_buffer_alloc));
603 gst_pad_set_activate_function (basesink->sinkpad,
604 GST_DEBUG_FUNCPTR (gst_base_sink_pad_activate));
605 gst_pad_set_activatepush_function (basesink->sinkpad,
606 GST_DEBUG_FUNCPTR (gst_base_sink_pad_activate_push));
607 gst_pad_set_activatepull_function (basesink->sinkpad,
608 GST_DEBUG_FUNCPTR (gst_base_sink_pad_activate_pull));
609 gst_pad_set_event_function (basesink->sinkpad,
610 GST_DEBUG_FUNCPTR (gst_base_sink_event));
611 gst_pad_set_chain_function (basesink->sinkpad,
612 GST_DEBUG_FUNCPTR (gst_base_sink_chain));
613 gst_element_add_pad (GST_ELEMENT_CAST (basesink), basesink->sinkpad);
615 basesink->pad_mode = GST_ACTIVATE_NONE;
616 basesink->preroll_queue = g_queue_new ();
617 basesink->abidata.ABI.clip_segment = gst_segment_new ();
618 priv->have_latency = FALSE;
620 basesink->can_activate_push = DEFAULT_CAN_ACTIVATE_PUSH;
621 basesink->can_activate_pull = DEFAULT_CAN_ACTIVATE_PULL;
623 basesink->sync = DEFAULT_SYNC;
624 basesink->abidata.ABI.max_lateness = DEFAULT_MAX_LATENESS;
625 g_atomic_int_set (&priv->qos_enabled, DEFAULT_QOS);
626 priv->async_enabled = DEFAULT_ASYNC;
627 priv->ts_offset = DEFAULT_TS_OFFSET;
628 priv->render_delay = DEFAULT_RENDER_DELAY;
629 priv->blocksize = DEFAULT_BLOCKSIZE;
631 GST_OBJECT_FLAG_SET (basesink, GST_ELEMENT_IS_SINK);
635 gst_base_sink_finalize (GObject * object)
637 GstBaseSink *basesink;
639 basesink = GST_BASE_SINK (object);
641 g_queue_free (basesink->preroll_queue);
642 gst_segment_free (basesink->abidata.ABI.clip_segment);
644 G_OBJECT_CLASS (parent_class)->finalize (object);
648 * gst_base_sink_set_sync:
650 * @sync: the new sync value.
652 * Configures @sink to synchronize on the clock or not. When
653 * @sync is FALSE, incomming samples will be played as fast as
654 * possible. If @sync is TRUE, the timestamps of the incomming
655 * buffers will be used to schedule the exact render time of its
661 gst_base_sink_set_sync (GstBaseSink * sink, gboolean sync)
663 g_return_if_fail (GST_IS_BASE_SINK (sink));
665 GST_OBJECT_LOCK (sink);
667 GST_OBJECT_UNLOCK (sink);
671 * gst_base_sink_get_sync:
674 * Checks if @sink is currently configured to synchronize against the
677 * Returns: TRUE if the sink is configured to synchronize against the clock.
682 gst_base_sink_get_sync (GstBaseSink * sink)
686 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
688 GST_OBJECT_LOCK (sink);
690 GST_OBJECT_UNLOCK (sink);
696 * gst_base_sink_set_max_lateness:
698 * @max_lateness: the new max lateness value.
700 * Sets the new max lateness value to @max_lateness. This value is
701 * used to decide if a buffer should be dropped or not based on the
702 * buffer timestamp and the current clock time. A value of -1 means
708 gst_base_sink_set_max_lateness (GstBaseSink * sink, gint64 max_lateness)
710 g_return_if_fail (GST_IS_BASE_SINK (sink));
712 GST_OBJECT_LOCK (sink);
713 sink->abidata.ABI.max_lateness = max_lateness;
714 GST_OBJECT_UNLOCK (sink);
718 * gst_base_sink_get_max_lateness:
721 * Gets the max lateness value. See gst_base_sink_set_max_lateness for
724 * Returns: The maximum time in nanoseconds that a buffer can be late
725 * before it is dropped and not rendered. A value of -1 means an
731 gst_base_sink_get_max_lateness (GstBaseSink * sink)
735 g_return_val_if_fail (GST_IS_BASE_SINK (sink), -1);
737 GST_OBJECT_LOCK (sink);
738 res = sink->abidata.ABI.max_lateness;
739 GST_OBJECT_UNLOCK (sink);
745 * gst_base_sink_set_qos_enabled:
747 * @enabled: the new qos value.
749 * Configures @sink to send Quality-of-Service events upstream.
754 gst_base_sink_set_qos_enabled (GstBaseSink * sink, gboolean enabled)
756 g_return_if_fail (GST_IS_BASE_SINK (sink));
758 g_atomic_int_set (&sink->priv->qos_enabled, enabled);
762 * gst_base_sink_is_qos_enabled:
765 * Checks if @sink is currently configured to send Quality-of-Service events
768 * Returns: TRUE if the sink is configured to perform Quality-of-Service.
773 gst_base_sink_is_qos_enabled (GstBaseSink * sink)
777 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
779 res = g_atomic_int_get (&sink->priv->qos_enabled);
785 * gst_base_sink_set_async_enabled:
787 * @enabled: the new async value.
789 * Configures @sink to perform all state changes asynchronusly. When async is
790 * disabled, the sink will immediatly go to PAUSED instead of waiting for a
791 * preroll buffer. This feature is usefull if the sink does not synchronize
792 * against the clock or when it is dealing with sparse streams.
797 gst_base_sink_set_async_enabled (GstBaseSink * sink, gboolean enabled)
799 g_return_if_fail (GST_IS_BASE_SINK (sink));
801 GST_PAD_PREROLL_LOCK (sink->sinkpad);
802 sink->priv->async_enabled = enabled;
803 GST_LOG_OBJECT (sink, "set async enabled to %d", enabled);
804 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
808 * gst_base_sink_is_async_enabled:
811 * Checks if @sink is currently configured to perform asynchronous state
814 * Returns: TRUE if the sink is configured to perform asynchronous state
820 gst_base_sink_is_async_enabled (GstBaseSink * sink)
824 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
826 GST_PAD_PREROLL_LOCK (sink->sinkpad);
827 res = sink->priv->async_enabled;
828 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
834 * gst_base_sink_set_ts_offset:
836 * @offset: the new offset
838 * Adjust the synchronisation of @sink with @offset. A negative value will
839 * render buffers earlier than their timestamp. A positive value will delay
840 * rendering. This function can be used to fix playback of badly timestamped
846 gst_base_sink_set_ts_offset (GstBaseSink * sink, GstClockTimeDiff offset)
848 g_return_if_fail (GST_IS_BASE_SINK (sink));
850 GST_OBJECT_LOCK (sink);
851 sink->priv->ts_offset = offset;
852 GST_LOG_OBJECT (sink, "set time offset to %" G_GINT64_FORMAT, offset);
853 GST_OBJECT_UNLOCK (sink);
857 * gst_base_sink_get_ts_offset:
860 * Get the synchronisation offset of @sink.
862 * Returns: The synchronisation offset.
867 gst_base_sink_get_ts_offset (GstBaseSink * sink)
869 GstClockTimeDiff res;
871 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
873 GST_OBJECT_LOCK (sink);
874 res = sink->priv->ts_offset;
875 GST_OBJECT_UNLOCK (sink);
881 * gst_base_sink_get_last_buffer:
884 * Get the last buffer that arrived in the sink and was used for preroll or for
885 * rendering. This property can be used to generate thumbnails.
887 * The #GstCaps on the buffer can be used to determine the type of the buffer.
889 * Returns: a #GstBuffer. gst_buffer_unref() after usage. This function returns
890 * NULL when no buffer has arrived in the sink yet or when the sink is not in
896 gst_base_sink_get_last_buffer (GstBaseSink * sink)
900 g_return_val_if_fail (GST_IS_BASE_SINK (sink), NULL);
902 GST_OBJECT_LOCK (sink);
903 if ((res = sink->priv->last_buffer))
904 gst_buffer_ref (res);
905 GST_OBJECT_UNLOCK (sink);
911 gst_base_sink_set_last_buffer (GstBaseSink * sink, GstBuffer * buffer)
915 GST_OBJECT_LOCK (sink);
916 old = sink->priv->last_buffer;
917 if (G_LIKELY (old != buffer)) {
918 GST_DEBUG_OBJECT (sink, "setting last buffer to %p", buffer);
919 if (G_LIKELY (buffer))
920 gst_buffer_ref (buffer);
921 sink->priv->last_buffer = buffer;
925 GST_OBJECT_UNLOCK (sink);
927 /* avoid unreffing with the lock because cleanup code might want to take the
930 gst_buffer_unref (old);
934 * gst_base_sink_get_latency:
937 * Get the currently configured latency.
939 * Returns: The configured latency.
944 gst_base_sink_get_latency (GstBaseSink * sink)
948 GST_OBJECT_LOCK (sink);
949 res = sink->priv->latency;
950 GST_OBJECT_UNLOCK (sink);
956 * gst_base_sink_query_latency:
958 * @live: if the sink is live
959 * @upstream_live: if an upstream element is live
960 * @min_latency: the min latency of the upstream elements
961 * @max_latency: the max latency of the upstream elements
963 * Query the sink for the latency parameters. The latency will be queried from
964 * the upstream elements. @live will be TRUE if @sink is configured to
965 * synchronize against the clock. @upstream_live will be TRUE if an upstream
968 * If both @live and @upstream_live are TRUE, the sink will want to compensate
969 * for the latency introduced by the upstream elements by setting the
970 * @min_latency to a strictly possitive value.
972 * This function is mostly used by subclasses.
974 * Returns: TRUE if the query succeeded.
979 gst_base_sink_query_latency (GstBaseSink * sink, gboolean * live,
980 gboolean * upstream_live, GstClockTime * min_latency,
981 GstClockTime * max_latency)
983 gboolean l, us_live, res, have_latency;
984 GstClockTime min, max, render_delay;
986 GstClockTime us_min, us_max;
988 /* we are live when we sync to the clock */
989 GST_OBJECT_LOCK (sink);
991 have_latency = sink->priv->have_latency;
992 render_delay = sink->priv->render_delay;
993 GST_OBJECT_UNLOCK (sink);
995 /* assume no latency */
1001 GST_DEBUG_OBJECT (sink, "we are ready for LATENCY query");
1002 /* we are ready for a latency query this is when we preroll or when we are
1004 query = gst_query_new_latency ();
1006 /* ask the peer for the latency */
1007 if ((res = gst_base_sink_peer_query (sink, query))) {
1008 /* get upstream min and max latency */
1009 gst_query_parse_latency (query, &us_live, &us_min, &us_max);
1012 /* upstream live, use its latency, subclasses should use these
1013 * values to create the complete latency. */
1018 /* we need to add the render delay if we are live */
1020 min += render_delay;
1022 max += render_delay;
1025 gst_query_unref (query);
1027 GST_DEBUG_OBJECT (sink, "we are not yet ready for LATENCY query");
1031 /* not live, we tried to do the query, if it failed we return TRUE anyway */
1035 GST_DEBUG_OBJECT (sink, "latency query failed but we are not live");
1037 GST_DEBUG_OBJECT (sink, "latency query failed and we are live");
1042 GST_DEBUG_OBJECT (sink, "latency query: live: %d, have_latency %d,"
1043 " upstream: %d, min %" GST_TIME_FORMAT ", max %" GST_TIME_FORMAT, l,
1044 have_latency, us_live, GST_TIME_ARGS (min), GST_TIME_ARGS (max));
1049 *upstream_live = us_live;
1059 * gst_base_sink_set_render_delay:
1060 * @sink: a #GstBaseSink
1061 * @delay: the new delay
1063 * Set the render delay in @sink to @delay. The render delay is the time
1064 * between actual rendering of a buffer and its synchronisation time. Some
1065 * devices might delay media rendering which can be compensated for with this
1068 * After calling this function, this sink will report additional latency and
1069 * other sinks will adjust their latency to delay the rendering of their media.
1071 * This function is usually called by subclasses.
1076 gst_base_sink_set_render_delay (GstBaseSink * sink, GstClockTime delay)
1078 GstClockTime old_render_delay;
1080 g_return_if_fail (GST_IS_BASE_SINK (sink));
1082 GST_OBJECT_LOCK (sink);
1083 old_render_delay = sink->priv->render_delay;
1084 sink->priv->render_delay = delay;
1085 GST_LOG_OBJECT (sink, "set render delay to %" GST_TIME_FORMAT,
1086 GST_TIME_ARGS (delay));
1087 GST_OBJECT_UNLOCK (sink);
1089 if (delay != old_render_delay) {
1090 GST_DEBUG_OBJECT (sink, "posting latency changed");
1091 gst_element_post_message (GST_ELEMENT_CAST (sink),
1092 gst_message_new_latency (GST_OBJECT_CAST (sink)));
1097 * gst_base_sink_get_render_delay:
1098 * @sink: a #GstBaseSink
1100 * Get the render delay of @sink. see gst_base_sink_set_render_delay() for more
1101 * information about the render delay.
1103 * Returns: the render delay of @sink.
1108 gst_base_sink_get_render_delay (GstBaseSink * sink)
1110 GstClockTimeDiff res;
1112 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1114 GST_OBJECT_LOCK (sink);
1115 res = sink->priv->render_delay;
1116 GST_OBJECT_UNLOCK (sink);
1122 * gst_base_sink_set_blocksize:
1123 * @sink: a #GstBaseSink
1124 * @blocksize: the blocksize in bytes
1126 * Set the number of bytes that the sink will pull when it is operating in pull
1132 gst_base_sink_set_blocksize (GstBaseSink * sink, guint blocksize)
1134 g_return_if_fail (GST_IS_BASE_SINK (sink));
1136 GST_OBJECT_LOCK (sink);
1137 sink->priv->blocksize = blocksize;
1138 GST_LOG_OBJECT (sink, "set blocksize to %u", blocksize);
1139 GST_OBJECT_UNLOCK (sink);
1143 * gst_base_sink_get_blocksize:
1144 * @sink: a #GstBaseSink
1146 * Get the number of bytes that the sink will pull when it is operating in pull
1149 * Returns: the number of bytes @sink will pull in pull mode.
1154 gst_base_sink_get_blocksize (GstBaseSink * sink)
1158 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1160 GST_OBJECT_LOCK (sink);
1161 res = sink->priv->blocksize;
1162 GST_OBJECT_UNLOCK (sink);
1168 gst_base_sink_set_property (GObject * object, guint prop_id,
1169 const GValue * value, GParamSpec * pspec)
1171 GstBaseSink *sink = GST_BASE_SINK (object);
1174 case PROP_PREROLL_QUEUE_LEN:
1175 /* preroll lock necessary to serialize with finish_preroll */
1176 GST_PAD_PREROLL_LOCK (sink->sinkpad);
1177 sink->preroll_queue_max_len = g_value_get_uint (value);
1178 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
1181 gst_base_sink_set_sync (sink, g_value_get_boolean (value));
1183 case PROP_MAX_LATENESS:
1184 gst_base_sink_set_max_lateness (sink, g_value_get_int64 (value));
1187 gst_base_sink_set_qos_enabled (sink, g_value_get_boolean (value));
1190 gst_base_sink_set_async_enabled (sink, g_value_get_boolean (value));
1192 case PROP_TS_OFFSET:
1193 gst_base_sink_set_ts_offset (sink, g_value_get_int64 (value));
1195 case PROP_BLOCKSIZE:
1196 gst_base_sink_set_blocksize (sink, g_value_get_uint (value));
1198 case PROP_RENDER_DELAY:
1199 gst_base_sink_set_render_delay (sink, g_value_get_uint64 (value));
1202 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1208 gst_base_sink_get_property (GObject * object, guint prop_id, GValue * value,
1211 GstBaseSink *sink = GST_BASE_SINK (object);
1214 case PROP_PREROLL_QUEUE_LEN:
1215 GST_PAD_PREROLL_LOCK (sink->sinkpad);
1216 g_value_set_uint (value, sink->preroll_queue_max_len);
1217 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
1220 g_value_set_boolean (value, gst_base_sink_get_sync (sink));
1222 case PROP_MAX_LATENESS:
1223 g_value_set_int64 (value, gst_base_sink_get_max_lateness (sink));
1226 g_value_set_boolean (value, gst_base_sink_is_qos_enabled (sink));
1229 g_value_set_boolean (value, gst_base_sink_is_async_enabled (sink));
1231 case PROP_TS_OFFSET:
1232 g_value_set_int64 (value, gst_base_sink_get_ts_offset (sink));
1234 case PROP_LAST_BUFFER:
1235 gst_value_take_buffer (value, gst_base_sink_get_last_buffer (sink));
1237 case PROP_BLOCKSIZE:
1238 g_value_set_uint (value, gst_base_sink_get_blocksize (sink));
1240 case PROP_RENDER_DELAY:
1241 g_value_set_uint64 (value, gst_base_sink_get_render_delay (sink));
1244 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1251 gst_base_sink_get_caps (GstBaseSink * sink)
1257 gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps)
1262 static GstFlowReturn
1263 gst_base_sink_buffer_alloc (GstBaseSink * sink, guint64 offset, guint size,
1264 GstCaps * caps, GstBuffer ** buf)
1270 /* with PREROLL_LOCK, STREAM_LOCK */
1272 gst_base_sink_preroll_queue_flush (GstBaseSink * basesink, GstPad * pad)
1276 GST_DEBUG_OBJECT (basesink, "flushing queue %p", basesink);
1277 while ((obj = g_queue_pop_head (basesink->preroll_queue))) {
1278 GST_DEBUG_OBJECT (basesink, "popped %p", obj);
1279 gst_mini_object_unref (obj);
1281 /* we can't have EOS anymore now */
1282 basesink->eos = FALSE;
1283 basesink->priv->received_eos = FALSE;
1284 basesink->have_preroll = FALSE;
1285 basesink->priv->step_unlock = FALSE;
1286 basesink->eos_queued = FALSE;
1287 basesink->preroll_queued = 0;
1288 basesink->buffers_queued = 0;
1289 basesink->events_queued = 0;
1290 /* can't report latency anymore until we preroll again */
1291 if (basesink->priv->async_enabled) {
1292 GST_OBJECT_LOCK (basesink);
1293 basesink->priv->have_latency = FALSE;
1294 GST_OBJECT_UNLOCK (basesink);
1296 /* and signal any waiters now */
1297 GST_PAD_PREROLL_SIGNAL (pad);
1300 /* with STREAM_LOCK, configures given segment with the event information. */
1302 gst_base_sink_configure_segment (GstBaseSink * basesink, GstPad * pad,
1303 GstEvent * event, GstSegment * segment)
1306 gdouble rate, arate;
1312 /* the newsegment event is needed to bring the buffer timestamps to the
1313 * stream time and to drop samples outside of the playback segment. */
1314 gst_event_parse_new_segment_full (event, &update, &rate, &arate, &format,
1315 &start, &stop, &time);
1317 /* The segment is protected with both the STREAM_LOCK and the OBJECT_LOCK.
1318 * We protect with the OBJECT_LOCK so that we can use the values to
1319 * safely answer a POSITION query. */
1320 GST_OBJECT_LOCK (basesink);
1321 gst_segment_set_newsegment_full (segment, update, rate, arate, format, start,
1324 if (format == GST_FORMAT_TIME) {
1325 GST_DEBUG_OBJECT (basesink,
1326 "configured NEWSEGMENT update %d, rate %lf, applied rate %lf, "
1327 "format GST_FORMAT_TIME, "
1328 "%" GST_TIME_FORMAT " -- %" GST_TIME_FORMAT
1329 ", time %" GST_TIME_FORMAT ", accum %" GST_TIME_FORMAT,
1330 update, rate, arate, GST_TIME_ARGS (segment->start),
1331 GST_TIME_ARGS (segment->stop), GST_TIME_ARGS (segment->time),
1332 GST_TIME_ARGS (segment->accum));
1334 GST_DEBUG_OBJECT (basesink,
1335 "configured NEWSEGMENT update %d, rate %lf, applied rate %lf, "
1337 "%" G_GINT64_FORMAT " -- %" G_GINT64_FORMAT ", time %"
1338 G_GINT64_FORMAT ", accum %" G_GINT64_FORMAT, update, rate, arate,
1339 segment->format, segment->start, segment->stop, segment->time,
1342 GST_OBJECT_UNLOCK (basesink);
1345 /* with PREROLL_LOCK, STREAM_LOCK */
1347 gst_base_sink_commit_state (GstBaseSink * basesink)
1349 /* commit state and proceed to next pending state */
1350 GstState current, next, pending, post_pending;
1351 gboolean post_paused = FALSE;
1352 gboolean post_async_done = FALSE;
1353 gboolean post_playing = FALSE;
1355 /* we are certainly not playing async anymore now */
1356 basesink->playing_async = FALSE;
1358 GST_OBJECT_LOCK (basesink);
1359 current = GST_STATE (basesink);
1360 next = GST_STATE_NEXT (basesink);
1361 pending = GST_STATE_PENDING (basesink);
1362 post_pending = pending;
1365 case GST_STATE_PLAYING:
1367 GstBaseSinkClass *bclass;
1368 GstStateChangeReturn ret;
1370 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1372 GST_DEBUG_OBJECT (basesink, "commiting state to PLAYING");
1374 basesink->need_preroll = FALSE;
1375 post_async_done = TRUE;
1376 basesink->priv->commited = TRUE;
1377 post_playing = TRUE;
1378 /* post PAUSED too when we were READY */
1379 if (current == GST_STATE_READY) {
1383 /* make sure we notify the subclass of async playing */
1384 if (bclass->async_play) {
1385 GST_WARNING_OBJECT (basesink, "deprecated async_play");
1386 ret = bclass->async_play (basesink);
1387 if (ret == GST_STATE_CHANGE_FAILURE)
1392 case GST_STATE_PAUSED:
1393 GST_DEBUG_OBJECT (basesink, "commiting state to PAUSED");
1395 post_async_done = TRUE;
1396 basesink->priv->commited = TRUE;
1397 post_pending = GST_STATE_VOID_PENDING;
1399 case GST_STATE_READY:
1400 case GST_STATE_NULL:
1402 case GST_STATE_VOID_PENDING:
1403 goto nothing_pending;
1408 /* we can report latency queries now */
1409 basesink->priv->have_latency = TRUE;
1411 GST_STATE (basesink) = pending;
1412 GST_STATE_NEXT (basesink) = GST_STATE_VOID_PENDING;
1413 GST_STATE_PENDING (basesink) = GST_STATE_VOID_PENDING;
1414 GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_SUCCESS;
1415 GST_OBJECT_UNLOCK (basesink);
1418 GST_DEBUG_OBJECT (basesink, "posting PAUSED state change message");
1419 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1420 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1421 current, next, post_pending));
1423 if (post_async_done) {
1424 GST_DEBUG_OBJECT (basesink, "posting async-done message");
1425 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1426 gst_message_new_async_done (GST_OBJECT_CAST (basesink)));
1429 GST_DEBUG_OBJECT (basesink, "posting PLAYING state change message");
1430 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1431 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1432 next, pending, GST_STATE_VOID_PENDING));
1435 GST_STATE_BROADCAST (basesink);
1441 /* Depending on the state, set our vars. We get in this situation when the
1442 * state change function got a change to update the state vars before the
1443 * streaming thread did. This is fine but we need to make sure that we
1444 * update the need_preroll var since it was TRUE when we got here and might
1445 * become FALSE if we got to PLAYING. */
1446 GST_DEBUG_OBJECT (basesink, "nothing to commit, now in %s",
1447 gst_element_state_get_name (current));
1449 case GST_STATE_PLAYING:
1450 basesink->need_preroll = FALSE;
1452 case GST_STATE_PAUSED:
1453 basesink->need_preroll = TRUE;
1456 basesink->need_preroll = FALSE;
1457 basesink->flushing = TRUE;
1460 /* we can report latency queries now */
1461 basesink->priv->have_latency = TRUE;
1462 GST_OBJECT_UNLOCK (basesink);
1467 /* app is going to READY */
1468 GST_DEBUG_OBJECT (basesink, "stopping");
1469 basesink->need_preroll = FALSE;
1470 basesink->flushing = TRUE;
1471 GST_OBJECT_UNLOCK (basesink);
1476 GST_DEBUG_OBJECT (basesink, "async commit failed");
1477 GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_FAILURE;
1478 GST_OBJECT_UNLOCK (basesink);
1484 start_stepping (GstBaseSink * sink, GstSegment * segment,
1485 GstStepInfo * pending, GstStepInfo * current)
1489 GST_DEBUG_OBJECT (sink, "update pending step");
1491 GST_OBJECT_LOCK (sink);
1492 memcpy (current, pending, sizeof (GstStepInfo));
1493 pending->valid = FALSE;
1494 GST_OBJECT_UNLOCK (sink);
1496 /* get the running time of where we paused and remember it */
1497 current->start = gst_element_get_start_time (GST_ELEMENT_CAST (sink));
1498 gst_segment_set_running_time (segment, GST_FORMAT_TIME, current->start);
1500 /* set the new rate for the remainder of the segment */
1501 current->start_rate = segment->rate;
1502 segment->rate *= current->rate;
1503 segment->abs_rate = ABS (segment->rate);
1506 if (segment->rate > 0.0)
1507 current->start_stop = segment->stop;
1509 current->start_start = segment->start;
1511 if (current->format == GST_FORMAT_TIME) {
1512 end = current->start + current->amount;
1513 if (!current->flush) {
1514 /* update the segment clipping regions for non-flushing seeks */
1515 if (segment->rate > 0.0)
1516 segment->stop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1519 gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1523 GST_DEBUG_OBJECT (sink, "segment now %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT,
1524 GST_TIME_ARGS (segment->start), GST_TIME_ARGS (segment->stop));
1526 GST_DEBUG_OBJECT (sink, "step started at running_time %" GST_TIME_FORMAT,
1527 GST_TIME_ARGS (current->start));
1529 if (current->amount == -1) {
1530 GST_DEBUG_OBJECT (sink, "step amount == -1, stop stepping");
1531 current->valid = FALSE;
1533 GST_DEBUG_OBJECT (sink, "step amount: %" G_GUINT64_FORMAT ", format: %s, "
1534 "rate: %f", current->amount, gst_format_get_name (current->format),
1540 stop_stepping (GstBaseSink * sink, GstSegment * segment,
1541 GstStepInfo * current, gint64 rstart, gint64 rstop)
1543 gint64 stop, position;
1544 GstMessage *message;
1546 GST_DEBUG_OBJECT (sink, "step complete");
1548 if (segment->rate > 0.0)
1553 GST_DEBUG_OBJECT (sink,
1554 "step stop at running_time %" GST_TIME_FORMAT, GST_TIME_ARGS (stop));
1557 current->duration = current->position;
1559 current->duration = stop - current->start;
1561 GST_DEBUG_OBJECT (sink, "step elapsed running_time %" GST_TIME_FORMAT,
1562 GST_TIME_ARGS (current->duration));
1564 position = current->start + current->duration;
1566 /* now move the segment to the new running time */
1567 gst_segment_set_running_time (segment, GST_FORMAT_TIME, position);
1569 if (current->flush) {
1570 /* and remove the accumulated time we flushed, start time did not change */
1571 segment->accum = current->start;
1573 /* start time is now the stepped position */
1574 gst_element_set_start_time (GST_ELEMENT_CAST (sink), position);
1577 /* restore the previous rate */
1578 segment->rate = current->start_rate;
1579 segment->abs_rate = ABS (segment->rate);
1581 if (segment->rate > 0.0)
1582 segment->stop = current->start_stop;
1584 segment->start = current->start_start;
1586 /* the clip segment is used for position report in paused... */
1587 memcpy (sink->abidata.ABI.clip_segment, segment, sizeof (GstSegment));
1589 /* post the step done when we know the stepped duration in TIME */
1591 gst_message_new_step_done (GST_OBJECT_CAST (sink), current->format,
1592 current->amount, current->rate, current->flush, current->intermediate,
1594 gst_message_set_seqnum (message, current->seqnum);
1595 gst_element_post_message (GST_ELEMENT_CAST (sink), message);
1597 if (!current->intermediate)
1598 sink->need_preroll = current->need_preroll;
1600 /* and the current step info finished and becomes invalid */
1601 current->valid = FALSE;
1605 handle_stepping (GstBaseSink * sink, GstSegment * segment,
1606 GstStepInfo * current, gint64 * cstart, gint64 * cstop, gint64 * rstart,
1609 GstBaseSinkPrivate *priv;
1610 gboolean step_end = FALSE;
1614 /* see if we need to skip this buffer because of stepping */
1615 switch (current->format) {
1616 case GST_FORMAT_TIME:
1621 if (segment->rate > 0.0) {
1629 end = current->start + current->amount;
1630 current->position = first - current->start;
1632 if (G_UNLIKELY (segment->abs_rate != 1.0))
1633 current->position /= segment->abs_rate;
1635 GST_DEBUG_OBJECT (sink,
1636 "buffer: %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT,
1637 GST_TIME_ARGS (first), GST_TIME_ARGS (last));
1638 GST_DEBUG_OBJECT (sink,
1639 "got time step %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT "/%"
1640 GST_TIME_FORMAT, GST_TIME_ARGS (current->position),
1641 GST_TIME_ARGS (last - current->start),
1642 GST_TIME_ARGS (current->amount));
1644 if ((current->flush && current->position >= current->amount)
1646 GST_DEBUG_OBJECT (sink, "step ended, we need clipping");
1648 if (segment->rate > 0.0) {
1650 *cstart = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1653 *cstop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1656 GST_DEBUG_OBJECT (sink,
1657 "cstart %" GST_TIME_FORMAT ", rstart %" GST_TIME_FORMAT,
1658 GST_TIME_ARGS (*cstart), GST_TIME_ARGS (*rstart));
1659 GST_DEBUG_OBJECT (sink,
1660 "cstop %" GST_TIME_FORMAT ", rstop %" GST_TIME_FORMAT,
1661 GST_TIME_ARGS (*cstop), GST_TIME_ARGS (*rstop));
1664 case GST_FORMAT_BUFFERS:
1665 GST_DEBUG_OBJECT (sink,
1666 "got default step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1667 current->position, current->amount);
1669 if (current->position < current->amount) {
1670 current->position++;
1675 case GST_FORMAT_DEFAULT:
1677 GST_DEBUG_OBJECT (sink,
1678 "got unknown step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1679 current->position, current->amount);
1685 /* with STREAM_LOCK, PREROLL_LOCK
1687 * Returns TRUE if the object needs synchronisation and takes therefore
1688 * part in prerolling.
1690 * rsstart/rsstop contain the start/stop in stream time.
1691 * rrstart/rrstop contain the start/stop in running time.
1694 gst_base_sink_get_sync_times (GstBaseSink * basesink, GstMiniObject * obj,
1695 GstClockTime * rsstart, GstClockTime * rsstop,
1696 GstClockTime * rrstart, GstClockTime * rrstop, gboolean * do_sync,
1697 gboolean * stepped, GstSegment * segment, GstStepInfo * step,
1698 gboolean * step_end)
1700 GstBaseSinkClass *bclass;
1702 GstClockTime start, stop; /* raw start/stop timestamps */
1703 gint64 cstart, cstop; /* clipped raw timestamps */
1704 gint64 rstart, rstop; /* clipped timestamps converted to running time */
1705 GstClockTime sstart, sstop; /* clipped timestamps converted to stream time */
1707 GstBaseSinkPrivate *priv;
1709 priv = basesink->priv;
1711 /* start with nothing */
1714 if (G_UNLIKELY (GST_IS_EVENT (obj))) {
1715 GstEvent *event = GST_EVENT_CAST (obj);
1717 switch (GST_EVENT_TYPE (event)) {
1718 /* EOS event needs syncing */
1721 if (basesink->segment.rate >= 0.0) {
1722 sstart = sstop = priv->current_sstop;
1724 /* we have not seen a buffer yet, use the segment values */
1725 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1726 basesink->segment.format, basesink->segment.stop);
1729 sstart = sstop = priv->current_sstart;
1731 /* we have not seen a buffer yet, use the segment values */
1732 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1733 basesink->segment.format, basesink->segment.start);
1737 rstart = rstop = priv->eos_rtime;
1738 *do_sync = rstart != -1;
1739 GST_DEBUG_OBJECT (basesink, "sync times for EOS %" GST_TIME_FORMAT,
1740 GST_TIME_ARGS (rstart));
1741 /* if we are stepping, we end now */
1742 *step_end = step->valid;
1746 /* other events do not need syncing */
1747 /* FIXME, maybe NEWSEGMENT might need synchronisation
1748 * since the POSITION query depends on accumulated times and
1749 * we cannot accumulate the current segment before the previous
1756 /* else do buffer sync code */
1757 buffer = GST_BUFFER_CAST (obj);
1759 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1761 /* just get the times to see if we need syncing, if the start returns -1 we
1763 if (bclass->get_times)
1764 bclass->get_times (basesink, buffer, &start, &stop);
1767 /* we don't need to sync but we still want to get the timestamps for
1768 * tracking the position */
1769 gst_base_sink_get_times (basesink, buffer, &start, &stop);
1775 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
1776 ", stop: %" GST_TIME_FORMAT ", do_sync %d", GST_TIME_ARGS (start),
1777 GST_TIME_ARGS (stop), *do_sync);
1779 /* collect segment and format for code clarity */
1780 format = segment->format;
1782 /* no timestamp clipping if we did not get a TIME segment format */
1783 if (G_UNLIKELY (format != GST_FORMAT_TIME)) {
1786 /* do running and stream time in TIME format */
1787 format = GST_FORMAT_TIME;
1788 GST_LOG_OBJECT (basesink, "not time format, don't clip");
1792 /* clip, only when we know about time */
1793 if (G_UNLIKELY (!gst_segment_clip (segment, GST_FORMAT_TIME,
1794 (gint64) start, (gint64) stop, &cstart, &cstop)))
1795 goto out_of_segment;
1797 if (G_UNLIKELY (start != cstart || stop != cstop)) {
1798 GST_DEBUG_OBJECT (basesink, "clipped to: start %" GST_TIME_FORMAT
1799 ", stop: %" GST_TIME_FORMAT, GST_TIME_ARGS (cstart),
1800 GST_TIME_ARGS (cstop));
1803 /* set last stop position */
1804 if (G_LIKELY (cstop != GST_CLOCK_TIME_NONE))
1805 gst_segment_set_last_stop (segment, GST_FORMAT_TIME, cstop);
1807 gst_segment_set_last_stop (segment, GST_FORMAT_TIME, cstart);
1810 rstart = gst_segment_to_running_time (segment, format, cstart);
1811 rstop = gst_segment_to_running_time (segment, format, cstop);
1813 if (G_UNLIKELY (step->valid)) {
1814 if (!(*step_end = handle_stepping (basesink, segment, step, &cstart, &cstop,
1815 &rstart, &rstop))) {
1816 /* step is still busy, we discard data when we are flushing */
1817 *stepped = step->flush;
1820 /* this can produce wrong values if we accumulated non-TIME segments. If this happens,
1821 * upstream is behaving very badly */
1822 sstart = gst_segment_to_stream_time (segment, format, cstart);
1823 sstop = gst_segment_to_stream_time (segment, format, cstop);
1826 /* done label only called when doing EOS, we also stop stepping then */
1827 if (*step_end && step->flush) {
1828 GST_DEBUG_OBJECT (basesink, "flushing step ended");
1829 stop_stepping (basesink, segment, step, rstart, rstop);
1839 /* buffers and EOS always need syncing and preroll */
1845 /* we usually clip in the chain function already but stepping could cause
1846 * the segment to be updated later. we return FALSE so that we don't try
1848 GST_LOG_OBJECT (basesink, "buffer skipped, not in segment");
1853 /* with STREAM_LOCK, PREROLL_LOCK, LOCK
1854 * adjust a timestamp with the latency and timestamp offset */
1856 gst_base_sink_adjust_time (GstBaseSink * basesink, GstClockTime time)
1858 GstClockTimeDiff ts_offset;
1860 /* don't do anything funny with invalid timestamps */
1861 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
1864 time += basesink->priv->latency;
1866 /* apply offset, be carefull for underflows */
1867 ts_offset = basesink->priv->ts_offset;
1868 if (ts_offset < 0) {
1869 ts_offset = -ts_offset;
1870 if (ts_offset < time)
1881 * gst_base_sink_wait_clock:
1883 * @time: the running_time to be reached
1884 * @jitter: the jitter to be filled with time diff (can be NULL)
1886 * This function will block until @time is reached. It is usually called by
1887 * subclasses that use their own internal synchronisation.
1889 * If @time is not valid, no sycnhronisation is done and #GST_CLOCK_BADTIME is
1890 * returned. Likewise, if synchronisation is disabled in the element or there
1891 * is no clock, no synchronisation is done and #GST_CLOCK_BADTIME is returned.
1893 * This function should only be called with the PREROLL_LOCK held, like when
1894 * receiving an EOS event in the ::event vmethod or when receiving a buffer in
1895 * the ::render vmethod.
1897 * The @time argument should be the running_time of when this method should
1898 * return and is not adjusted with any latency or offset configured in the
1903 * Returns: #GstClockReturn
1906 gst_base_sink_wait_clock (GstBaseSink * sink, GstClockTime time,
1907 GstClockTimeDiff * jitter)
1913 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
1916 GST_OBJECT_LOCK (sink);
1917 if (G_UNLIKELY (!sink->sync))
1920 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (sink)) == NULL))
1923 /* add base_time to running_time to get the time against the clock */
1924 time += GST_ELEMENT_CAST (sink)->base_time;
1926 id = gst_clock_new_single_shot_id (clock, time);
1927 GST_OBJECT_UNLOCK (sink);
1929 /* A blocking wait is performed on the clock. We save the ClockID
1930 * so we can unlock the entry at any time. While we are blocking, we
1931 * release the PREROLL_LOCK so that other threads can interrupt the
1933 sink->clock_id = id;
1934 /* release the preroll lock while waiting */
1935 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
1937 ret = gst_clock_id_wait (id, jitter);
1939 GST_PAD_PREROLL_LOCK (sink->sinkpad);
1940 gst_clock_id_unref (id);
1941 sink->clock_id = NULL;
1945 /* no syncing needed */
1948 GST_DEBUG_OBJECT (sink, "time not valid, no sync needed");
1949 return GST_CLOCK_BADTIME;
1953 GST_DEBUG_OBJECT (sink, "sync disabled");
1954 GST_OBJECT_UNLOCK (sink);
1955 return GST_CLOCK_BADTIME;
1959 GST_DEBUG_OBJECT (sink, "no clock, can't sync");
1960 GST_OBJECT_UNLOCK (sink);
1961 return GST_CLOCK_BADTIME;
1966 * gst_base_sink_wait_preroll:
1969 * If the #GstBaseSinkClass::render method performs its own synchronisation against
1970 * the clock it must unblock when going from PLAYING to the PAUSED state and call
1971 * this method before continuing to render the remaining data.
1973 * This function will block until a state change to PLAYING happens (in which
1974 * case this function returns #GST_FLOW_OK) or the processing must be stopped due
1975 * to a state change to READY or a FLUSH event (in which case this function
1976 * returns #GST_FLOW_WRONG_STATE).
1978 * This function should only be called with the PREROLL_LOCK held, like in the
1983 * Returns: #GST_FLOW_OK if the preroll completed and processing can
1984 * continue. Any other return value should be returned from the render vmethod.
1987 gst_base_sink_wait_preroll (GstBaseSink * sink)
1989 sink->have_preroll = TRUE;
1990 GST_DEBUG_OBJECT (sink, "waiting in preroll for flush or PLAYING");
1991 /* block until the state changes, or we get a flush, or something */
1992 GST_PAD_PREROLL_WAIT (sink->sinkpad);
1993 sink->have_preroll = FALSE;
1994 if (G_UNLIKELY (sink->flushing))
1996 if (G_UNLIKELY (sink->priv->step_unlock))
1998 GST_DEBUG_OBJECT (sink, "continue after preroll");
2005 GST_DEBUG_OBJECT (sink, "preroll interrupted because of flush");
2006 return GST_FLOW_WRONG_STATE;
2010 sink->priv->step_unlock = FALSE;
2011 GST_DEBUG_OBJECT (sink, "preroll interrupted because of step");
2012 return GST_FLOW_STEP;
2017 * gst_base_sink_do_preroll:
2019 * @obj: the object that caused the preroll
2021 * If the @sink spawns its own thread for pulling buffers from upstream it
2022 * should call this method after it has pulled a buffer. If the element needed
2023 * to preroll, this function will perform the preroll and will then block
2024 * until the element state is changed.
2026 * This function should be called with the PREROLL_LOCK held.
2030 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2031 * continue. Any other return value should be returned from the render vmethod.
2034 gst_base_sink_do_preroll (GstBaseSink * sink, GstMiniObject * obj)
2038 while (G_UNLIKELY (sink->need_preroll)) {
2039 GST_DEBUG_OBJECT (sink, "prerolling object %p", obj);
2041 ret = gst_base_sink_preroll_object (sink, obj);
2042 if (ret != GST_FLOW_OK)
2043 goto preroll_failed;
2045 /* need to recheck here because the commit state could have
2046 * made us not need the preroll anymore */
2047 if (G_LIKELY (sink->need_preroll)) {
2048 /* block until the state changes, or we get a flush, or something */
2049 ret = gst_base_sink_wait_preroll (sink);
2050 if (ret != GST_FLOW_OK) {
2051 if (ret == GST_FLOW_STEP)
2054 goto preroll_failed;
2063 GST_DEBUG_OBJECT (sink, "preroll failed %d", ret);
2069 * gst_base_sink_wait_eos:
2071 * @time: the running_time to be reached
2072 * @jitter: the jitter to be filled with time diff (can be NULL)
2074 * This function will block until @time is reached. It is usually called by
2075 * subclasses that use their own internal synchronisation but want to let the
2076 * EOS be handled by the base class.
2078 * This function should only be called with the PREROLL_LOCK held, like when
2079 * receiving an EOS event in the ::event vmethod.
2081 * The @time argument should be the running_time of when the EOS should happen
2082 * and will be adjusted with any latency and offset configured in the sink.
2086 * Returns: #GstFlowReturn
2089 gst_base_sink_wait_eos (GstBaseSink * sink, GstClockTime time,
2090 GstClockTimeDiff * jitter)
2092 GstClockReturn status;
2098 GST_DEBUG_OBJECT (sink, "checking preroll");
2100 /* first wait for the playing state before we can continue */
2101 if (G_UNLIKELY (sink->need_preroll)) {
2102 ret = gst_base_sink_wait_preroll (sink);
2103 if (ret != GST_FLOW_OK) {
2104 if (ret == GST_FLOW_STEP)
2111 /* preroll done, we can sync since we are in PLAYING now. */
2112 GST_DEBUG_OBJECT (sink, "possibly waiting for clock to reach %"
2113 GST_TIME_FORMAT, GST_TIME_ARGS (time));
2115 /* compensate for latency and ts_offset. We don't adjust for render delay
2116 * because we don't interact with the device on EOS normally. */
2117 stime = gst_base_sink_adjust_time (sink, time);
2119 /* wait for the clock, this can be interrupted because we got shut down or
2121 status = gst_base_sink_wait_clock (sink, stime, jitter);
2123 GST_DEBUG_OBJECT (sink, "clock returned %d", status);
2125 /* invalid time, no clock or sync disabled, just continue then */
2126 if (status == GST_CLOCK_BADTIME)
2129 /* waiting could have been interrupted and we can be flushing now */
2130 if (G_UNLIKELY (sink->flushing))
2133 /* retry if we got unscheduled, which means we did not reach the timeout
2134 * yet. if some other error occures, we continue. */
2135 } while (status == GST_CLOCK_UNSCHEDULED);
2137 GST_DEBUG_OBJECT (sink, "end of stream");
2144 GST_DEBUG_OBJECT (sink, "we are flushing");
2145 return GST_FLOW_WRONG_STATE;
2149 /* with STREAM_LOCK, PREROLL_LOCK
2151 * Make sure we are in PLAYING and synchronize an object to the clock.
2153 * If we need preroll, we are not in PLAYING. We try to commit the state
2154 * if needed and then block if we still are not PLAYING.
2156 * We start waiting on the clock in PLAYING. If we got interrupted, we
2157 * immediatly try to re-preroll.
2159 * Some objects do not need synchronisation (most events) and so this function
2160 * immediatly returns GST_FLOW_OK.
2162 * for objects that arrive later than max-lateness to be synchronized to the
2163 * clock have the @late boolean set to TRUE.
2165 * This function keeps a running average of the jitter (the diff between the
2166 * clock time and the requested sync time). The jitter is negative for
2167 * objects that arrive in time and positive for late buffers.
2169 * does not take ownership of obj.
2171 static GstFlowReturn
2172 gst_base_sink_do_sync (GstBaseSink * basesink, GstPad * pad,
2173 GstMiniObject * obj, gboolean * late, gboolean * step_end)
2175 GstClockTimeDiff jitter;
2177 GstClockReturn status = GST_CLOCK_OK;
2178 GstClockTime rstart, rstop, sstart, sstop, stime;
2180 GstBaseSinkPrivate *priv;
2182 GstStepInfo *current, *pending;
2185 priv = basesink->priv;
2188 sstart = sstop = rstart = rstop = -1;
2192 priv->current_rstart = -1;
2194 /* get stepping info */
2195 current = &priv->current_step;
2196 pending = &priv->pending_step;
2198 /* get timing information for this object against the render segment */
2199 syncable = gst_base_sink_get_sync_times (basesink, obj,
2200 &sstart, &sstop, &rstart, &rstop, &do_sync, &stepped, &basesink->segment,
2203 if (G_UNLIKELY (stepped))
2206 /* a syncable object needs to participate in preroll and
2207 * clocking. All buffers and EOS are syncable. */
2208 if (G_UNLIKELY (!syncable))
2211 /* store timing info for current object */
2212 priv->current_rstart = rstart;
2213 priv->current_rstop = (rstop != -1 ? rstop : rstart);
2215 /* save sync time for eos when the previous object needed sync */
2216 priv->eos_rtime = (do_sync ? priv->current_rstop : -1);
2219 /* first do preroll, this makes sure we commit our state
2220 * to PAUSED and can continue to PLAYING. We cannot perform
2221 * any clock sync in PAUSED because there is no clock. */
2222 ret = gst_base_sink_do_preroll (basesink, obj);
2223 if (G_UNLIKELY (ret != GST_FLOW_OK))
2224 goto preroll_failed;
2226 /* After rendering we store the position of the last buffer so that we can use
2227 * it to report the position. We need to take the lock here. */
2228 GST_OBJECT_LOCK (basesink);
2229 priv->current_sstart = sstart;
2230 priv->current_sstop = (sstop != -1 ? sstop : sstart);
2231 GST_OBJECT_UNLOCK (basesink);
2233 /* update the segment with a pending step if the current one is invalid and we
2234 * have a new pending one. We only accept new step updates after a preroll */
2235 if (G_UNLIKELY (pending->valid && !current->valid)) {
2236 start_stepping (basesink, &basesink->segment, pending, current);
2243 /* adjust for latency */
2244 stime = gst_base_sink_adjust_time (basesink, rstart);
2246 /* adjust for render-delay, avoid underflows */
2248 if (stime > priv->render_delay)
2249 stime -= priv->render_delay;
2254 /* preroll done, we can sync since we are in PLAYING now. */
2255 GST_DEBUG_OBJECT (basesink, "possibly waiting for clock to reach %"
2256 GST_TIME_FORMAT ", adjusted %" GST_TIME_FORMAT,
2257 GST_TIME_ARGS (rstart), GST_TIME_ARGS (stime));
2259 /* This function will return immediatly if start == -1, no clock
2260 * or sync is disabled with GST_CLOCK_BADTIME. */
2261 status = gst_base_sink_wait_clock (basesink, stime, &jitter);
2263 GST_DEBUG_OBJECT (basesink, "clock returned %d", status);
2265 /* invalid time, no clock or sync disabled, just render */
2266 if (status == GST_CLOCK_BADTIME)
2269 /* waiting could have been interrupted and we can be flushing now */
2270 if (G_UNLIKELY (basesink->flushing))
2273 /* check for unlocked by a state change, we are not flushing so
2274 * we can try to preroll on the current buffer. */
2275 if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED)) {
2276 GST_DEBUG_OBJECT (basesink, "unscheduled, waiting some more");
2277 priv->call_preroll = TRUE;
2281 /* successful syncing done, record observation */
2282 priv->current_jitter = jitter;
2284 /* check if the object should be dropped */
2285 *late = gst_base_sink_is_too_late (basesink, obj, rstart, rstop,
2294 GST_DEBUG_OBJECT (basesink, "skipped stepped object %p", obj);
2300 GST_DEBUG_OBJECT (basesink, "non syncable object %p", obj);
2305 GST_DEBUG_OBJECT (basesink, "we are flushing");
2306 return GST_FLOW_WRONG_STATE;
2310 GST_DEBUG_OBJECT (basesink, "preroll failed");
2316 gst_base_sink_send_qos (GstBaseSink * basesink,
2317 gdouble proportion, GstClockTime time, GstClockTimeDiff diff)
2322 /* generate Quality-of-Service event */
2323 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2324 "qos: proportion: %lf, diff %" G_GINT64_FORMAT ", timestamp %"
2325 GST_TIME_FORMAT, proportion, diff, GST_TIME_ARGS (time));
2327 event = gst_event_new_qos (proportion, diff, time);
2330 res = gst_pad_push_event (basesink->sinkpad, event);
2336 gst_base_sink_perform_qos (GstBaseSink * sink, gboolean dropped)
2338 GstBaseSinkPrivate *priv;
2339 GstClockTime start, stop;
2340 GstClockTimeDiff jitter;
2341 GstClockTime pt, entered, left;
2342 GstClockTime duration;
2347 start = priv->current_rstart;
2349 /* if Quality-of-Service disabled, do nothing */
2350 if (!g_atomic_int_get (&priv->qos_enabled) || start == -1)
2353 stop = priv->current_rstop;
2354 jitter = priv->current_jitter;
2357 /* this is the time the buffer entered the sink */
2358 if (start < -jitter)
2361 entered = start + jitter;
2364 /* this is the time the buffer entered the sink */
2365 entered = start + jitter;
2366 /* this is the time the buffer left the sink */
2367 left = start + jitter;
2370 /* calculate duration of the buffer */
2372 duration = stop - start;
2376 /* if we have the time when the last buffer left us, calculate
2377 * processing time */
2378 if (priv->last_left != -1) {
2379 if (entered > priv->last_left) {
2380 pt = entered - priv->last_left;
2388 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "start: %" GST_TIME_FORMAT
2389 ", entered %" GST_TIME_FORMAT ", left %" GST_TIME_FORMAT ", pt: %"
2390 GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT ",jitter %"
2391 G_GINT64_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (entered),
2392 GST_TIME_ARGS (left), GST_TIME_ARGS (pt), GST_TIME_ARGS (duration),
2395 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "avg_duration: %" GST_TIME_FORMAT
2396 ", avg_pt: %" GST_TIME_FORMAT ", avg_rate: %g",
2397 GST_TIME_ARGS (priv->avg_duration), GST_TIME_ARGS (priv->avg_pt),
2400 /* collect running averages. for first observations, we copy the
2402 if (priv->avg_duration == -1)
2403 priv->avg_duration = duration;
2405 priv->avg_duration = UPDATE_RUNNING_AVG (priv->avg_duration, duration);
2407 if (priv->avg_pt == -1)
2410 priv->avg_pt = UPDATE_RUNNING_AVG (priv->avg_pt, pt);
2412 if (priv->avg_duration != 0)
2414 gst_guint64_to_gdouble (priv->avg_pt) /
2415 gst_guint64_to_gdouble (priv->avg_duration);
2419 if (priv->last_left != -1) {
2420 if (dropped || priv->avg_rate < 0.0) {
2421 priv->avg_rate = rate;
2424 priv->avg_rate = UPDATE_RUNNING_AVG_N (priv->avg_rate, rate);
2426 priv->avg_rate = UPDATE_RUNNING_AVG_P (priv->avg_rate, rate);
2430 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink,
2431 "updated: avg_duration: %" GST_TIME_FORMAT ", avg_pt: %" GST_TIME_FORMAT
2432 ", avg_rate: %g", GST_TIME_ARGS (priv->avg_duration),
2433 GST_TIME_ARGS (priv->avg_pt), priv->avg_rate);
2436 if (priv->avg_rate >= 0.0) {
2437 /* if we have a valid rate, start sending QoS messages */
2438 if (priv->current_jitter < 0) {
2439 /* make sure we never go below 0 when adding the jitter to the
2441 if (priv->current_rstart < -priv->current_jitter)
2442 priv->current_jitter = -priv->current_rstart;
2444 gst_base_sink_send_qos (sink, priv->avg_rate, priv->current_rstart,
2445 priv->current_jitter);
2448 /* record when this buffer will leave us */
2449 priv->last_left = left;
2452 /* reset all qos measuring */
2454 gst_base_sink_reset_qos (GstBaseSink * sink)
2456 GstBaseSinkPrivate *priv;
2460 priv->last_in_time = -1;
2461 priv->last_left = -1;
2462 priv->avg_duration = -1;
2464 priv->avg_rate = -1.0;
2465 priv->avg_render = -1;
2471 /* Checks if the object was scheduled too late.
2473 * start/stop contain the raw timestamp start and stop values
2476 * status and jitter contain the return values from the clock wait.
2478 * returns TRUE if the buffer was too late.
2481 gst_base_sink_is_too_late (GstBaseSink * basesink, GstMiniObject * obj,
2482 GstClockTime start, GstClockTime stop,
2483 GstClockReturn status, GstClockTimeDiff jitter)
2486 gint64 max_lateness;
2487 GstBaseSinkPrivate *priv;
2489 priv = basesink->priv;
2493 /* only for objects that were too late */
2494 if (G_LIKELY (status != GST_CLOCK_EARLY))
2497 max_lateness = basesink->abidata.ABI.max_lateness;
2499 /* check if frame dropping is enabled */
2500 if (max_lateness == -1)
2503 /* only check for buffers */
2504 if (G_UNLIKELY (!GST_IS_BUFFER (obj)))
2507 /* can't do check if we don't have a timestamp */
2508 if (G_UNLIKELY (start == -1))
2511 /* we can add a valid stop time */
2513 max_lateness += stop;
2515 max_lateness += start;
2517 /* if the jitter bigger than duration and lateness we are too late */
2518 if ((late = start + jitter > max_lateness)) {
2519 GST_DEBUG_OBJECT (basesink, "buffer is too late %" GST_TIME_FORMAT
2520 " > %" GST_TIME_FORMAT, GST_TIME_ARGS (start + jitter),
2521 GST_TIME_ARGS (max_lateness));
2522 /* !!emergency!!, if we did not receive anything valid for more than a
2523 * second, render it anyway so the user sees something */
2524 if (priv->last_in_time != -1 && start - priv->last_in_time > GST_SECOND) {
2526 GST_ELEMENT_WARNING (basesink, CORE, CLOCK,
2527 (_("A lot of buffers are being dropped.")),
2528 ("There may be a timestamping problem, or this computer is too slow."));
2529 GST_DEBUG_OBJECT (basesink,
2530 "**emergency** last buffer at %" GST_TIME_FORMAT " > GST_SECOND",
2531 GST_TIME_ARGS (priv->last_in_time));
2537 priv->last_in_time = start;
2544 GST_DEBUG_OBJECT (basesink, "object was scheduled in time");
2549 GST_DEBUG_OBJECT (basesink, "frame dropping disabled");
2554 GST_DEBUG_OBJECT (basesink, "object is not a buffer");
2559 GST_DEBUG_OBJECT (basesink, "buffer has no timestamp");
2564 /* called before and after calling the render vmethod. It keeps track of how
2565 * much time was spent in the render method and is used to check if we are
2568 gst_base_sink_do_render_stats (GstBaseSink * basesink, gboolean start)
2570 GstBaseSinkPrivate *priv;
2572 priv = basesink->priv;
2575 priv->start = gst_util_get_timestamp ();
2577 GstClockTime elapsed;
2579 priv->stop = gst_util_get_timestamp ();
2581 elapsed = GST_CLOCK_DIFF (priv->start, priv->stop);
2583 if (priv->avg_render == -1)
2584 priv->avg_render = elapsed;
2586 priv->avg_render = UPDATE_RUNNING_AVG (priv->avg_render, elapsed);
2588 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2589 "avg_render: %" GST_TIME_FORMAT, GST_TIME_ARGS (priv->avg_render));
2593 /* with STREAM_LOCK, PREROLL_LOCK,
2595 * Synchronize the object on the clock and then render it.
2597 * takes ownership of obj.
2599 static GstFlowReturn
2600 gst_base_sink_render_object (GstBaseSink * basesink, GstPad * pad,
2601 GstMiniObject * obj)
2604 GstBaseSinkClass *bclass;
2605 gboolean late, step_end;
2607 GstBaseSinkPrivate *priv;
2609 priv = basesink->priv;
2616 /* synchronize this object, non syncable objects return OK
2618 ret = gst_base_sink_do_sync (basesink, pad, obj, &late, &step_end);
2619 if (G_UNLIKELY (ret != GST_FLOW_OK))
2622 /* and now render, event or buffer. */
2623 if (G_LIKELY (GST_IS_BUFFER (obj))) {
2626 /* drop late buffers unconditionally, let's hope it's unlikely */
2627 if (G_UNLIKELY (late))
2630 buf = GST_BUFFER_CAST (obj);
2632 gst_base_sink_set_last_buffer (basesink, buf);
2634 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2636 if (G_LIKELY (bclass->render)) {
2639 /* read once, to get same value before and after */
2640 do_qos = g_atomic_int_get (&priv->qos_enabled);
2642 GST_DEBUG_OBJECT (basesink, "rendering buffer %p", obj);
2644 /* record rendering time for QoS and stats */
2646 gst_base_sink_do_render_stats (basesink, TRUE);
2648 ret = bclass->render (basesink, buf);
2651 gst_base_sink_do_render_stats (basesink, FALSE);
2653 if (ret == GST_FLOW_STEP)
2659 GstEvent *event = GST_EVENT_CAST (obj);
2660 gboolean event_res = TRUE;
2663 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2665 type = GST_EVENT_TYPE (event);
2667 GST_DEBUG_OBJECT (basesink, "rendering event %p, type %s", obj,
2668 gst_event_type_get_name (type));
2671 event_res = bclass->event (basesink, event);
2673 /* when we get here we could be flushing again when the event handler calls
2674 * _wait_eos(). We have to ignore this object in that case. */
2675 if (G_UNLIKELY (basesink->flushing))
2678 if (G_LIKELY (event_res)) {
2681 seqnum = basesink->priv->seqnum = gst_event_get_seqnum (event);
2682 GST_DEBUG_OBJECT (basesink, "Got seqnum #%" G_GUINT32_FORMAT, seqnum);
2687 GstMessage *message;
2689 /* the EOS event is completely handled so we mark
2690 * ourselves as being in the EOS state. eos is also
2691 * protected by the object lock so we can read it when
2692 * answering the POSITION query. */
2693 GST_OBJECT_LOCK (basesink);
2694 basesink->eos = TRUE;
2695 GST_OBJECT_UNLOCK (basesink);
2697 /* ok, now we can post the message */
2698 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
2700 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
2701 gst_message_set_seqnum (message, seqnum);
2702 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
2705 case GST_EVENT_NEWSEGMENT:
2706 /* configure the segment */
2707 gst_base_sink_configure_segment (basesink, pad, event,
2708 &basesink->segment);
2718 stop_stepping (basesink, &basesink->segment, &priv->current_step,
2719 priv->current_rstart, priv->current_rstop);
2723 gst_base_sink_perform_qos (basesink, late);
2725 GST_DEBUG_OBJECT (basesink, "object unref after render %p", obj);
2726 gst_mini_object_unref (obj);
2733 GST_DEBUG_OBJECT (basesink, "do_sync returned %s", gst_flow_get_name (ret));
2739 GST_DEBUG_OBJECT (basesink, "buffer late, dropping");
2744 GST_DEBUG_OBJECT (basesink, "we are flushing, ignore object");
2745 gst_mini_object_unref (obj);
2746 return GST_FLOW_WRONG_STATE;
2750 /* with STREAM_LOCK, PREROLL_LOCK
2752 * Perform preroll on the given object. For buffers this means
2753 * calling the preroll subclass method.
2754 * If that succeeds, the state will be commited.
2756 * function does not take ownership of obj.
2758 static GstFlowReturn
2759 gst_base_sink_preroll_object (GstBaseSink * basesink, GstMiniObject * obj)
2763 GST_DEBUG_OBJECT (basesink, "prerolling object %p", obj);
2765 /* if it's a buffer, we need to call the preroll method */
2766 if (G_LIKELY (GST_IS_BUFFER (obj)) && basesink->priv->call_preroll) {
2767 GstBaseSinkClass *bclass;
2769 GstClockTime timestamp;
2771 buf = GST_BUFFER_CAST (obj);
2772 timestamp = GST_BUFFER_TIMESTAMP (buf);
2774 GST_DEBUG_OBJECT (basesink, "preroll buffer %" GST_TIME_FORMAT,
2775 GST_TIME_ARGS (timestamp));
2777 gst_base_sink_set_last_buffer (basesink, buf);
2779 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2780 if (bclass->preroll)
2781 if ((ret = bclass->preroll (basesink, buf)) != GST_FLOW_OK)
2782 goto preroll_failed;
2784 basesink->priv->call_preroll = FALSE;
2788 if (G_LIKELY (basesink->playing_async)) {
2789 if (G_UNLIKELY (!gst_base_sink_commit_state (basesink)))
2798 GST_DEBUG_OBJECT (basesink, "preroll failed, abort state");
2799 gst_element_abort_state (GST_ELEMENT_CAST (basesink));
2804 GST_DEBUG_OBJECT (basesink, "stopping while commiting state");
2805 return GST_FLOW_WRONG_STATE;
2809 /* with STREAM_LOCK, PREROLL_LOCK
2811 * Queue an object for rendering.
2812 * The first prerollable object queued will complete the preroll. If the
2813 * preroll queue if filled, we render all the objects in the queue.
2815 * This function takes ownership of the object.
2817 static GstFlowReturn
2818 gst_base_sink_queue_object_unlocked (GstBaseSink * basesink, GstPad * pad,
2819 GstMiniObject * obj, gboolean prerollable)
2821 GstFlowReturn ret = GST_FLOW_OK;
2825 if (G_UNLIKELY (basesink->need_preroll)) {
2826 if (G_LIKELY (prerollable))
2827 basesink->preroll_queued++;
2829 length = basesink->preroll_queued;
2831 GST_DEBUG_OBJECT (basesink, "now %d prerolled items", length);
2833 /* first prerollable item needs to finish the preroll */
2835 ret = gst_base_sink_preroll_object (basesink, obj);
2836 if (G_UNLIKELY (ret != GST_FLOW_OK))
2837 goto preroll_failed;
2839 /* need to recheck if we need preroll, commmit state during preroll
2840 * could have made us not need more preroll. */
2841 if (G_UNLIKELY (basesink->need_preroll)) {
2842 /* see if we can render now, if we can't add the object to the preroll
2844 if (G_UNLIKELY (length <= basesink->preroll_queue_max_len))
2849 /* we can start rendering (or blocking) the queued object
2851 q = basesink->preroll_queue;
2852 while (G_UNLIKELY (!g_queue_is_empty (q))) {
2855 o = g_queue_pop_head (q);
2856 GST_DEBUG_OBJECT (basesink, "rendering queued object %p", o);
2858 /* do something with the return value */
2859 ret = gst_base_sink_render_object (basesink, pad, o);
2860 if (ret != GST_FLOW_OK)
2861 goto dequeue_failed;
2864 /* now render the object */
2865 ret = gst_base_sink_render_object (basesink, pad, obj);
2866 basesink->preroll_queued = 0;
2873 GST_DEBUG_OBJECT (basesink, "preroll failed, reason %s",
2874 gst_flow_get_name (ret));
2875 gst_mini_object_unref (obj);
2880 /* add object to the queue and return */
2881 GST_DEBUG_OBJECT (basesink, "need more preroll data %d <= %d",
2882 length, basesink->preroll_queue_max_len);
2883 g_queue_push_tail (basesink->preroll_queue, obj);
2888 GST_DEBUG_OBJECT (basesink, "rendering queued objects failed, reason %s",
2889 gst_flow_get_name (ret));
2890 gst_mini_object_unref (obj);
2897 * This function grabs the PREROLL_LOCK and adds the object to
2900 * This function takes ownership of obj.
2902 static GstFlowReturn
2903 gst_base_sink_queue_object (GstBaseSink * basesink, GstPad * pad,
2904 GstMiniObject * obj, gboolean prerollable)
2908 GST_PAD_PREROLL_LOCK (pad);
2909 if (G_UNLIKELY (basesink->flushing))
2912 if (G_UNLIKELY (basesink->priv->received_eos))
2915 ret = gst_base_sink_queue_object_unlocked (basesink, pad, obj, prerollable);
2916 GST_PAD_PREROLL_UNLOCK (pad);
2923 GST_DEBUG_OBJECT (basesink, "sink is flushing");
2924 GST_PAD_PREROLL_UNLOCK (pad);
2925 gst_mini_object_unref (obj);
2926 return GST_FLOW_WRONG_STATE;
2930 GST_DEBUG_OBJECT (basesink,
2931 "we are EOS, dropping object, return UNEXPECTED");
2932 GST_PAD_PREROLL_UNLOCK (pad);
2933 gst_mini_object_unref (obj);
2934 return GST_FLOW_UNEXPECTED;
2939 gst_base_sink_flush_start (GstBaseSink * basesink, GstPad * pad)
2941 /* make sure we are not blocked on the clock also clear any pending
2943 gst_base_sink_set_flushing (basesink, pad, TRUE);
2945 /* we grab the stream lock but that is not needed since setting the
2946 * sink to flushing would make sure no state commit is being done
2948 GST_PAD_STREAM_LOCK (pad);
2949 gst_base_sink_reset_qos (basesink);
2950 if (basesink->priv->async_enabled) {
2951 /* and we need to commit our state again on the next
2952 * prerolled buffer */
2953 basesink->playing_async = TRUE;
2954 gst_element_lost_state (GST_ELEMENT_CAST (basesink));
2956 basesink->priv->have_latency = TRUE;
2957 basesink->need_preroll = FALSE;
2959 gst_base_sink_set_last_buffer (basesink, NULL);
2960 GST_PAD_STREAM_UNLOCK (pad);
2964 gst_base_sink_flush_stop (GstBaseSink * basesink, GstPad * pad)
2966 /* unset flushing so we can accept new data, this also flushes out any EOS
2968 gst_base_sink_set_flushing (basesink, pad, FALSE);
2970 /* for position reporting */
2971 GST_OBJECT_LOCK (basesink);
2972 basesink->priv->current_sstart = -1;
2973 basesink->priv->current_sstop = -1;
2974 basesink->priv->eos_rtime = -1;
2975 basesink->priv->call_preroll = TRUE;
2976 basesink->priv->current_step.valid = FALSE;
2977 basesink->priv->pending_step.valid = FALSE;
2978 if (basesink->pad_mode == GST_ACTIVATE_PUSH) {
2979 /* we need new segment info after the flush. */
2980 basesink->have_newsegment = FALSE;
2981 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
2982 gst_segment_init (basesink->abidata.ABI.clip_segment, GST_FORMAT_UNDEFINED);
2984 GST_OBJECT_UNLOCK (basesink);
2988 gst_base_sink_event (GstPad * pad, GstEvent * event)
2990 GstBaseSink *basesink;
2991 gboolean result = TRUE;
2992 GstBaseSinkClass *bclass;
2994 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
2996 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2998 GST_DEBUG_OBJECT (basesink, "event %p (%s)", event,
2999 GST_EVENT_TYPE_NAME (event));
3001 switch (GST_EVENT_TYPE (event)) {
3006 GST_PAD_PREROLL_LOCK (pad);
3007 if (G_UNLIKELY (basesink->flushing))
3010 if (G_UNLIKELY (basesink->priv->received_eos)) {
3011 /* we can't accept anything when we are EOS */
3013 gst_event_unref (event);
3015 /* we set the received EOS flag here so that we can use it when testing if
3016 * we are prerolled and to refuse more buffers. */
3017 basesink->priv->received_eos = TRUE;
3019 /* EOS is a prerollable object, we call the unlocked version because it
3020 * does not check the received_eos flag. */
3021 ret = gst_base_sink_queue_object_unlocked (basesink, pad,
3022 GST_MINI_OBJECT_CAST (event), TRUE);
3023 if (G_UNLIKELY (ret != GST_FLOW_OK))
3026 GST_PAD_PREROLL_UNLOCK (pad);
3029 case GST_EVENT_NEWSEGMENT:
3033 GST_DEBUG_OBJECT (basesink, "newsegment %p", event);
3035 GST_PAD_PREROLL_LOCK (pad);
3036 if (G_UNLIKELY (basesink->flushing))
3039 if (G_UNLIKELY (basesink->priv->received_eos)) {
3040 /* we can't accept anything when we are EOS */
3042 gst_event_unref (event);
3044 /* the new segment is a non prerollable item and does not block anything,
3045 * we need to configure the current clipping segment and insert the event
3046 * in the queue to serialize it with the buffers for rendering. */
3047 gst_base_sink_configure_segment (basesink, pad, event,
3048 basesink->abidata.ABI.clip_segment);
3051 gst_base_sink_queue_object_unlocked (basesink, pad,
3052 GST_MINI_OBJECT_CAST (event), FALSE);
3053 if (G_UNLIKELY (ret != GST_FLOW_OK))
3056 GST_OBJECT_LOCK (basesink);
3057 basesink->have_newsegment = TRUE;
3058 GST_OBJECT_UNLOCK (basesink);
3061 GST_PAD_PREROLL_UNLOCK (pad);
3064 case GST_EVENT_FLUSH_START:
3066 bclass->event (basesink, event);
3068 GST_DEBUG_OBJECT (basesink, "flush-start %p", event);
3070 gst_base_sink_flush_start (basesink, pad);
3072 gst_event_unref (event);
3074 case GST_EVENT_FLUSH_STOP:
3076 bclass->event (basesink, event);
3078 GST_DEBUG_OBJECT (basesink, "flush-stop %p", event);
3080 gst_base_sink_flush_stop (basesink, pad);
3082 gst_event_unref (event);
3085 /* other events are sent to queue or subclass depending on if they
3086 * are serialized. */
3087 if (GST_EVENT_IS_SERIALIZED (event)) {
3088 gst_base_sink_queue_object (basesink, pad,
3089 GST_MINI_OBJECT_CAST (event), FALSE);
3092 bclass->event (basesink, event);
3093 gst_event_unref (event);
3098 gst_object_unref (basesink);
3105 GST_DEBUG_OBJECT (basesink, "we are flushing");
3106 GST_PAD_PREROLL_UNLOCK (pad);
3108 gst_event_unref (event);
3113 /* default implementation to calculate the start and end
3114 * timestamps on a buffer, subclasses can override
3117 gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
3118 GstClockTime * start, GstClockTime * end)
3120 GstClockTime timestamp, duration;
3122 timestamp = GST_BUFFER_TIMESTAMP (buffer);
3123 if (GST_CLOCK_TIME_IS_VALID (timestamp)) {
3125 /* get duration to calculate end time */
3126 duration = GST_BUFFER_DURATION (buffer);
3127 if (GST_CLOCK_TIME_IS_VALID (duration)) {
3128 *end = timestamp + duration;
3134 /* must be called with PREROLL_LOCK */
3136 gst_base_sink_needs_preroll (GstBaseSink * basesink)
3138 gboolean is_prerolled, res;
3140 /* we have 2 cases where the PREROLL_LOCK is released:
3141 * 1) we are blocking in the PREROLL_LOCK and thus are prerolled.
3142 * 2) we are syncing on the clock
3144 is_prerolled = basesink->have_preroll || basesink->priv->received_eos;
3145 res = !is_prerolled;
3147 GST_DEBUG_OBJECT (basesink, "have_preroll: %d, EOS: %d => needs preroll: %d",
3148 basesink->have_preroll, basesink->priv->received_eos, res);
3153 /* with STREAM_LOCK, PREROLL_LOCK
3155 * Takes a buffer and compare the timestamps with the last segment.
3156 * If the buffer falls outside of the segment boundaries, drop it.
3157 * Else queue the buffer for preroll and rendering.
3159 * This function takes ownership of the buffer.
3161 static GstFlowReturn
3162 gst_base_sink_chain_unlocked (GstBaseSink * basesink, GstPad * pad,
3165 GstBaseSinkClass *bclass;
3166 GstFlowReturn result;
3167 GstClockTime start = GST_CLOCK_TIME_NONE, end = GST_CLOCK_TIME_NONE;
3168 GstSegment *clip_segment;
3170 if (G_UNLIKELY (basesink->flushing))
3173 if (G_UNLIKELY (basesink->priv->received_eos))
3176 /* for code clarity */
3177 clip_segment = basesink->abidata.ABI.clip_segment;
3179 if (G_UNLIKELY (!basesink->have_newsegment)) {
3182 sync = gst_base_sink_get_sync (basesink);
3184 GST_ELEMENT_WARNING (basesink, STREAM, FAILED,
3185 (_("Internal data flow problem.")),
3186 ("Received buffer without a new-segment. Assuming timestamps start from 0."));
3189 /* this means this sink will assume timestamps start from 0 */
3190 GST_OBJECT_LOCK (basesink);
3191 clip_segment->start = 0;
3192 clip_segment->stop = -1;
3193 basesink->segment.start = 0;
3194 basesink->segment.stop = -1;
3195 basesink->have_newsegment = TRUE;
3196 GST_OBJECT_UNLOCK (basesink);
3199 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3201 /* check if the buffer needs to be dropped, we first ask the subclass for the
3203 if (bclass->get_times)
3204 bclass->get_times (basesink, buf, &start, &end);
3207 /* if the subclass does not want sync, we use our own values so that we at
3208 * least clip the buffer to the segment */
3209 gst_base_sink_get_times (basesink, buf, &start, &end);
3212 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
3213 ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (end));
3215 /* a dropped buffer does not participate in anything */
3216 if (GST_CLOCK_TIME_IS_VALID (start) &&
3217 (clip_segment->format == GST_FORMAT_TIME)) {
3218 if (G_UNLIKELY (!gst_segment_clip (clip_segment,
3219 GST_FORMAT_TIME, (gint64) start, (gint64) end, NULL, NULL)))
3220 goto out_of_segment;
3223 /* now we can process the buffer in the queue, this function takes ownership
3225 result = gst_base_sink_queue_object_unlocked (basesink, pad,
3226 GST_MINI_OBJECT_CAST (buf), TRUE);
3233 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3234 gst_buffer_unref (buf);
3235 return GST_FLOW_WRONG_STATE;
3239 GST_DEBUG_OBJECT (basesink,
3240 "we are EOS, dropping object, return UNEXPECTED");
3241 gst_buffer_unref (buf);
3242 return GST_FLOW_UNEXPECTED;
3246 GST_DEBUG_OBJECT (basesink, "dropping buffer, out of clipping segment");
3247 gst_buffer_unref (buf);
3254 static GstFlowReturn
3255 gst_base_sink_chain (GstPad * pad, GstBuffer * buf)
3257 GstBaseSink *basesink;
3258 GstFlowReturn result;
3260 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3262 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH))
3265 GST_PAD_PREROLL_LOCK (pad);
3266 result = gst_base_sink_chain_unlocked (basesink, pad, buf);
3267 GST_PAD_PREROLL_UNLOCK (pad);
3275 GST_OBJECT_LOCK (pad);
3276 GST_WARNING_OBJECT (basesink,
3277 "Push on pad %s:%s, but it was not activated in push mode",
3278 GST_DEBUG_PAD_NAME (pad));
3279 GST_OBJECT_UNLOCK (pad);
3280 gst_buffer_unref (buf);
3281 /* we don't post an error message this will signal to the peer
3282 * pushing that EOS is reached. */
3283 result = GST_FLOW_UNEXPECTED;
3289 gst_base_sink_default_do_seek (GstBaseSink * sink, GstSegment * segment)
3291 gboolean res = TRUE;
3293 /* update our offset if the start/stop position was updated */
3294 if (segment->format == GST_FORMAT_BYTES) {
3295 segment->time = segment->start;
3296 } else if (segment->start == 0) {
3297 /* seek to start, we can implement a default for this. */
3301 GST_INFO_OBJECT (sink, "Can't do a default seek");
3307 #define SEEK_TYPE_IS_RELATIVE(t) (((t) != GST_SEEK_TYPE_NONE) && ((t) != GST_SEEK_TYPE_SET))
3310 gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
3311 GstEvent * event, GstSegment * segment)
3313 /* By default, we try one of 2 things:
3314 * - For absolute seek positions, convert the requested position to our
3315 * configured processing format and place it in the output segment \
3316 * - For relative seek positions, convert our current (input) values to the
3317 * seek format, adjust by the relative seek offset and then convert back to
3318 * the processing format
3320 GstSeekType cur_type, stop_type;
3323 GstFormat seek_format, dest_format;
3326 gboolean res = TRUE;
3328 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3329 &cur_type, &cur, &stop_type, &stop);
3330 dest_format = segment->format;
3332 if (seek_format == dest_format) {
3333 gst_segment_set_seek (segment, rate, seek_format, flags,
3334 cur_type, cur, stop_type, stop, &update);
3338 if (cur_type != GST_SEEK_TYPE_NONE) {
3339 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3341 gst_pad_query_convert (sink->sinkpad, seek_format, cur, &dest_format,
3343 cur_type = GST_SEEK_TYPE_SET;
3346 if (res && stop_type != GST_SEEK_TYPE_NONE) {
3347 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3349 gst_pad_query_convert (sink->sinkpad, seek_format, stop, &dest_format,
3351 stop_type = GST_SEEK_TYPE_SET;
3354 /* And finally, configure our output segment in the desired format */
3355 gst_segment_set_seek (segment, rate, dest_format, flags, cur_type, cur,
3356 stop_type, stop, &update);
3365 GST_DEBUG_OBJECT (sink, "undefined format given, seek aborted.");
3370 /* perform a seek, only executed in pull mode */
3372 gst_base_sink_perform_seek (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3376 GstFormat seek_format, dest_format;
3378 GstSeekType cur_type, stop_type;
3379 gboolean seekseg_configured = FALSE;
3381 gboolean update, res = TRUE;
3382 GstSegment seeksegment;
3384 dest_format = sink->segment.format;
3387 GST_DEBUG_OBJECT (sink, "performing seek with event %p", event);
3388 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3389 &cur_type, &cur, &stop_type, &stop);
3391 flush = flags & GST_SEEK_FLAG_FLUSH;
3393 GST_DEBUG_OBJECT (sink, "performing seek without event");
3398 GST_DEBUG_OBJECT (sink, "flushing upstream");
3399 gst_pad_push_event (pad, gst_event_new_flush_start ());
3400 gst_base_sink_flush_start (sink, pad);
3402 GST_DEBUG_OBJECT (sink, "pausing pulling thread");
3405 GST_PAD_STREAM_LOCK (pad);
3407 /* If we configured the seeksegment above, don't overwrite it now. Otherwise
3408 * copy the current segment info into the temp segment that we can actually
3409 * attempt the seek with. We only update the real segment if the seek suceeds. */
3410 if (!seekseg_configured) {
3411 memcpy (&seeksegment, &sink->segment, sizeof (GstSegment));
3413 /* now configure the final seek segment */
3415 if (sink->segment.format != seek_format) {
3416 /* OK, here's where we give the subclass a chance to convert the relative
3417 * seek into an absolute one in the processing format. We set up any
3418 * absolute seek above, before taking the stream lock. */
3419 if (!gst_base_sink_default_prepare_seek_segment (sink, event,
3421 GST_DEBUG_OBJECT (sink,
3422 "Preparing the seek failed after flushing. " "Aborting seek");
3426 /* The seek format matches our processing format, no need to ask the
3427 * the subclass to configure the segment. */
3428 gst_segment_set_seek (&seeksegment, rate, seek_format, flags,
3429 cur_type, cur, stop_type, stop, &update);
3432 /* Else, no seek event passed, so we're just (re)starting the
3437 GST_DEBUG_OBJECT (sink, "segment configured from %" G_GINT64_FORMAT
3438 " to %" G_GINT64_FORMAT ", position %" G_GINT64_FORMAT,
3439 seeksegment.start, seeksegment.stop, seeksegment.last_stop);
3441 /* do the seek, segment.last_stop contains the new position. */
3442 res = gst_base_sink_default_do_seek (sink, &seeksegment);
3447 GST_DEBUG_OBJECT (sink, "stop flushing upstream");
3448 gst_pad_push_event (pad, gst_event_new_flush_stop ());
3449 gst_base_sink_flush_stop (sink, pad);
3450 } else if (res && sink->abidata.ABI.running) {
3451 /* we are running the current segment and doing a non-flushing seek,
3452 * close the segment first based on the last_stop. */
3453 GST_DEBUG_OBJECT (sink, "closing running segment %" G_GINT64_FORMAT
3454 " to %" G_GINT64_FORMAT, sink->segment.start, sink->segment.last_stop);
3457 /* The subclass must have converted the segment to the processing format
3459 if (res && seeksegment.format != dest_format) {
3460 GST_DEBUG_OBJECT (sink, "Subclass failed to prepare a seek segment "
3461 "in the correct format. Aborting seek.");
3465 /* if successfull seek, we update our real segment and push
3466 * out the new segment. */
3468 memcpy (&sink->segment, &seeksegment, sizeof (GstSegment));
3470 if (sink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3471 gst_element_post_message (GST_ELEMENT (sink),
3472 gst_message_new_segment_start (GST_OBJECT (sink),
3473 sink->segment.format, sink->segment.last_stop));
3477 sink->priv->discont = TRUE;
3478 sink->abidata.ABI.running = TRUE;
3480 GST_PAD_STREAM_UNLOCK (pad);
3486 set_step_info (GstBaseSink * sink, GstStepInfo * current, GstStepInfo * pending,
3487 guint seqnum, GstFormat format, guint64 amount, gdouble rate,
3488 gboolean flush, gboolean intermediate)
3490 GST_OBJECT_LOCK (sink);
3491 pending->seqnum = seqnum;
3492 pending->format = format;
3493 pending->amount = amount;
3494 pending->position = 0;
3495 pending->rate = rate;
3496 pending->flush = flush;
3497 pending->intermediate = intermediate;
3498 pending->valid = TRUE;
3499 /* flush invalidates the current stepping segment */
3501 current->valid = FALSE;
3502 GST_OBJECT_UNLOCK (sink);
3506 gst_base_sink_perform_step (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3508 GstBaseSinkPrivate *priv;
3509 GstBaseSinkClass *bclass;
3510 gboolean flush, intermediate;
3515 GstStepInfo *pending, *current;
3517 bclass = GST_BASE_SINK_GET_CLASS (sink);
3520 GST_DEBUG_OBJECT (sink, "performing step with event %p", event);
3522 gst_event_parse_step (event, &format, &amount, &rate, &flush, &intermediate);
3523 seqnum = gst_event_get_seqnum (event);
3525 pending = &priv->pending_step;
3526 current = &priv->current_step;
3529 /* we need to call ::unlock before locking PREROLL_LOCK
3530 * since we lock it before going into ::render */
3532 bclass->unlock (sink);
3534 GST_PAD_PREROLL_LOCK (sink->sinkpad);
3535 /* now that we have the PREROLL lock, clear our unlock request */
3536 if (bclass->unlock_stop)
3537 bclass->unlock_stop (sink);
3539 /* update the stepinfo and make it valid */
3540 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3543 if (sink->priv->async_enabled) {
3544 /* and we need to commit our state again on the next
3545 * prerolled buffer */
3546 sink->playing_async = TRUE;
3547 priv->pending_step.need_preroll = TRUE;
3548 sink->need_preroll = FALSE;
3549 gst_element_lost_state_full (GST_ELEMENT_CAST (sink), FALSE);
3551 sink->priv->have_latency = TRUE;
3552 sink->need_preroll = FALSE;
3554 priv->current_sstart = -1;
3555 priv->current_sstop = -1;
3556 priv->eos_rtime = -1;
3557 priv->call_preroll = TRUE;
3558 gst_base_sink_set_last_buffer (sink, NULL);
3559 gst_base_sink_reset_qos (sink);
3561 if (sink->clock_id) {
3562 gst_clock_id_unschedule (sink->clock_id);
3565 if (sink->have_preroll) {
3566 GST_DEBUG_OBJECT (sink, "signal waiter");
3567 priv->step_unlock = TRUE;
3568 GST_PAD_PREROLL_SIGNAL (sink->sinkpad);
3570 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
3572 /* update the stepinfo and make it valid */
3573 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3583 gst_base_sink_loop (GstPad * pad)
3585 GstBaseSink *basesink;
3586 GstBuffer *buf = NULL;
3587 GstFlowReturn result;
3591 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3593 g_assert (basesink->pad_mode == GST_ACTIVATE_PULL);
3595 if ((blocksize = basesink->priv->blocksize) == 0)
3598 offset = basesink->segment.last_stop;
3600 GST_DEBUG_OBJECT (basesink, "pulling %" G_GUINT64_FORMAT ", %u",
3603 result = gst_pad_pull_range (pad, offset, blocksize, &buf);
3604 if (G_UNLIKELY (result != GST_FLOW_OK))
3607 if (G_UNLIKELY (buf == NULL))
3610 offset += GST_BUFFER_SIZE (buf);
3612 gst_segment_set_last_stop (&basesink->segment, GST_FORMAT_BYTES, offset);
3614 GST_PAD_PREROLL_LOCK (pad);
3615 result = gst_base_sink_chain_unlocked (basesink, pad, buf);
3616 GST_PAD_PREROLL_UNLOCK (pad);
3617 if (G_UNLIKELY (result != GST_FLOW_OK))
3625 GST_LOG_OBJECT (basesink, "pausing task, reason %s",
3626 gst_flow_get_name (result));
3627 gst_pad_pause_task (pad);
3628 /* fatal errors and NOT_LINKED cause EOS */
3629 if (GST_FLOW_IS_FATAL (result) || result == GST_FLOW_NOT_LINKED) {
3630 if (result == GST_FLOW_UNEXPECTED) {
3631 /* perform EOS logic */
3632 if (basesink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3633 gst_element_post_message (GST_ELEMENT_CAST (basesink),
3634 gst_message_new_segment_done (GST_OBJECT_CAST (basesink),
3635 basesink->segment.format, basesink->segment.last_stop));
3637 gst_base_sink_event (pad, gst_event_new_eos ());
3640 /* for fatal errors we post an error message, post the error
3641 * first so the app knows about the error first. */
3642 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
3643 (_("Internal data stream error.")),
3644 ("stream stopped, reason %s", gst_flow_get_name (result)));
3645 gst_base_sink_event (pad, gst_event_new_eos ());
3652 GST_LOG_OBJECT (basesink, "no buffer, pausing");
3653 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
3654 (_("Internal data flow error.")), ("element returned NULL buffer"));
3655 result = GST_FLOW_ERROR;
3661 gst_base_sink_set_flushing (GstBaseSink * basesink, GstPad * pad,
3664 GstBaseSinkClass *bclass;
3666 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3669 /* unlock any subclasses, we need to do this before grabbing the
3670 * PREROLL_LOCK since we hold this lock before going into ::render. */
3672 bclass->unlock (basesink);
3675 GST_PAD_PREROLL_LOCK (pad);
3676 basesink->flushing = flushing;
3678 /* step 1, now that we have the PREROLL lock, clear our unlock request */
3679 if (bclass->unlock_stop)
3680 bclass->unlock_stop (basesink);
3682 /* set need_preroll before we unblock the clock. If the clock is unblocked
3683 * before timing out, we can reuse the buffer for preroll. */
3684 basesink->need_preroll = TRUE;
3686 /* step 2, unblock clock sync (if any) or any other blocking thing */
3687 if (basesink->clock_id) {
3688 gst_clock_id_unschedule (basesink->clock_id);
3691 /* flush out the data thread if it's locked in finish_preroll, this will
3692 * also flush out the EOS state */
3693 GST_DEBUG_OBJECT (basesink,
3694 "flushing out data thread, need preroll to TRUE");
3695 gst_base_sink_preroll_queue_flush (basesink, pad);
3697 GST_PAD_PREROLL_UNLOCK (pad);
3703 gst_base_sink_default_activate_pull (GstBaseSink * basesink, gboolean active)
3709 result = gst_pad_start_task (basesink->sinkpad,
3710 (GstTaskFunction) gst_base_sink_loop, basesink->sinkpad);
3712 /* step 2, make sure streaming finishes */
3713 result = gst_pad_stop_task (basesink->sinkpad);
3720 gst_base_sink_pad_activate (GstPad * pad)
3722 gboolean result = FALSE;
3723 GstBaseSink *basesink;
3725 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3727 GST_DEBUG_OBJECT (basesink, "Trying pull mode first");
3729 gst_base_sink_set_flushing (basesink, pad, FALSE);
3731 /* we need to have the pull mode enabled */
3732 if (!basesink->can_activate_pull) {
3733 GST_DEBUG_OBJECT (basesink, "pull mode disabled");
3737 /* check if downstreams supports pull mode at all */
3738 if (!gst_pad_check_pull_range (pad)) {
3739 GST_DEBUG_OBJECT (basesink, "pull mode not supported");
3743 /* set the pad mode before starting the task so that it's in the
3744 * correct state for the new thread. also the sink set_caps and get_caps
3745 * function checks this */
3746 basesink->pad_mode = GST_ACTIVATE_PULL;
3748 /* we first try to negotiate a format so that when we try to activate
3749 * downstream, it knows about our format */
3750 if (!gst_base_sink_negotiate_pull (basesink)) {
3751 GST_DEBUG_OBJECT (basesink, "failed to negotiate in pull mode");
3755 /* ok activate now */
3756 if (!gst_pad_activate_pull (pad, TRUE)) {
3757 /* clear any pending caps */
3758 GST_OBJECT_LOCK (basesink);
3759 gst_caps_replace (&basesink->priv->pull_caps, NULL);
3760 GST_OBJECT_UNLOCK (basesink);
3761 GST_DEBUG_OBJECT (basesink, "failed to activate in pull mode");
3765 GST_DEBUG_OBJECT (basesink, "Success activating pull mode");
3769 /* push mode fallback */
3771 GST_DEBUG_OBJECT (basesink, "Falling back to push mode");
3772 if ((result = gst_pad_activate_push (pad, TRUE))) {
3773 GST_DEBUG_OBJECT (basesink, "Success activating push mode");
3778 GST_WARNING_OBJECT (basesink, "Could not activate pad in either mode");
3779 gst_base_sink_set_flushing (basesink, pad, TRUE);
3782 gst_object_unref (basesink);
3788 gst_base_sink_pad_activate_push (GstPad * pad, gboolean active)
3791 GstBaseSink *basesink;
3793 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3796 if (!basesink->can_activate_push) {
3798 basesink->pad_mode = GST_ACTIVATE_NONE;
3801 basesink->pad_mode = GST_ACTIVATE_PUSH;
3804 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH)) {
3805 g_warning ("Internal GStreamer activation error!!!");
3808 gst_base_sink_set_flushing (basesink, pad, TRUE);
3810 basesink->pad_mode = GST_ACTIVATE_NONE;
3814 gst_object_unref (basesink);
3820 gst_base_sink_negotiate_pull (GstBaseSink * basesink)
3827 /* this returns the intersection between our caps and the peer caps. If there
3828 * is no peer, it returns NULL and we can't operate in pull mode so we can
3829 * fail the negotiation. */
3830 caps = gst_pad_get_allowed_caps (GST_BASE_SINK_PAD (basesink));
3831 if (caps == NULL || gst_caps_is_empty (caps))
3832 goto no_caps_possible;
3834 GST_DEBUG_OBJECT (basesink, "allowed caps: %" GST_PTR_FORMAT, caps);
3836 caps = gst_caps_make_writable (caps);
3837 /* get the first (prefered) format */
3838 gst_caps_truncate (caps);
3840 gst_pad_fixate_caps (GST_BASE_SINK_PAD (basesink), caps);
3842 GST_DEBUG_OBJECT (basesink, "fixated to: %" GST_PTR_FORMAT, caps);
3844 if (gst_caps_is_any (caps)) {
3845 GST_DEBUG_OBJECT (basesink, "caps were ANY after fixating, "
3847 /* neither side has template caps in this case, so they are prepared for
3848 pull() without setcaps() */
3850 } else if (gst_caps_is_fixed (caps)) {
3851 if (!gst_pad_set_caps (GST_BASE_SINK_PAD (basesink), caps))
3852 goto could_not_set_caps;
3854 GST_OBJECT_LOCK (basesink);
3855 gst_caps_replace (&basesink->priv->pull_caps, caps);
3856 GST_OBJECT_UNLOCK (basesink);
3861 gst_caps_unref (caps);
3867 GST_INFO_OBJECT (basesink, "Pipeline could not agree on caps");
3868 GST_DEBUG_OBJECT (basesink, "get_allowed_caps() returned EMPTY");
3870 gst_caps_unref (caps);
3875 GST_INFO_OBJECT (basesink, "Could not set caps: %" GST_PTR_FORMAT, caps);
3876 gst_caps_unref (caps);
3881 /* this won't get called until we implement an activate function */
3883 gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active)
3885 gboolean result = FALSE;
3886 GstBaseSink *basesink;
3887 GstBaseSinkClass *bclass;
3889 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3890 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3896 /* we mark we have a newsegment here because pull based
3897 * mode works just fine without having a newsegment before the
3899 format = GST_FORMAT_BYTES;
3901 gst_segment_init (&basesink->segment, format);
3902 gst_segment_init (basesink->abidata.ABI.clip_segment, format);
3903 GST_OBJECT_LOCK (basesink);
3904 basesink->have_newsegment = TRUE;
3905 GST_OBJECT_UNLOCK (basesink);
3907 /* get the peer duration in bytes */
3908 result = gst_pad_query_peer_duration (pad, &format, &duration);
3910 GST_DEBUG_OBJECT (basesink,
3911 "setting duration in bytes to %" G_GINT64_FORMAT, duration);
3912 gst_segment_set_duration (basesink->abidata.ABI.clip_segment, format,
3914 gst_segment_set_duration (&basesink->segment, format, duration);
3916 GST_DEBUG_OBJECT (basesink, "unknown duration");
3919 if (bclass->activate_pull)
3920 result = bclass->activate_pull (basesink, TRUE);
3925 goto activate_failed;
3928 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PULL)) {
3929 g_warning ("Internal GStreamer activation error!!!");
3932 result = gst_base_sink_set_flushing (basesink, pad, TRUE);
3933 if (bclass->activate_pull)
3934 result &= bclass->activate_pull (basesink, FALSE);
3935 basesink->pad_mode = GST_ACTIVATE_NONE;
3936 /* clear any pending caps */
3937 GST_OBJECT_LOCK (basesink);
3938 gst_caps_replace (&basesink->priv->pull_caps, NULL);
3939 GST_OBJECT_UNLOCK (basesink);
3942 gst_object_unref (basesink);
3949 /* reset, as starting the thread failed */
3950 basesink->pad_mode = GST_ACTIVATE_NONE;
3952 GST_ERROR_OBJECT (basesink, "subclass failed to activate in pull mode");
3957 /* send an event to our sinkpad peer. */
3959 gst_base_sink_send_event (GstElement * element, GstEvent * event)
3962 GstBaseSink *basesink = GST_BASE_SINK (element);
3963 gboolean forward, result = TRUE;
3964 GstActivateMode mode;
3966 GST_OBJECT_LOCK (element);
3967 /* get the pad and the scheduling mode */
3968 pad = gst_object_ref (basesink->sinkpad);
3969 mode = basesink->pad_mode;
3970 GST_OBJECT_UNLOCK (element);
3972 /* only push UPSTREAM events upstream */
3973 forward = GST_EVENT_IS_UPSTREAM (event);
3975 switch (GST_EVENT_TYPE (event)) {
3976 case GST_EVENT_LATENCY:
3978 GstClockTime latency;
3980 gst_event_parse_latency (event, &latency);
3982 /* store the latency. We use this to adjust the running_time before syncing
3983 * it to the clock. */
3984 GST_OBJECT_LOCK (element);
3985 basesink->priv->latency = latency;
3986 if (!basesink->priv->have_latency)
3988 GST_OBJECT_UNLOCK (element);
3989 GST_DEBUG_OBJECT (basesink, "latency set to %" GST_TIME_FORMAT,
3990 GST_TIME_ARGS (latency));
3992 /* We forward this event so that all elements know about the global pipeline
3993 * latency. This is interesting for an element when it wants to figure out
3994 * when a particular piece of data will be rendered. */
3997 case GST_EVENT_SEEK:
3998 /* in pull mode we will execute the seek */
3999 if (mode == GST_ACTIVATE_PULL)
4000 result = gst_base_sink_perform_seek (basesink, pad, event);
4002 case GST_EVENT_STEP:
4003 result = gst_base_sink_perform_step (basesink, pad, event);
4011 result = gst_pad_push_event (pad, event);
4013 /* not forwarded, unref the event */
4014 gst_event_unref (event);
4017 gst_object_unref (pad);
4022 gst_base_sink_peer_query (GstBaseSink * sink, GstQuery * query)
4025 gboolean res = FALSE;
4027 if ((peer = gst_pad_get_peer (sink->sinkpad))) {
4028 res = gst_pad_query (peer, query);
4029 gst_object_unref (peer);
4034 /* get the end position of the last seen object, this is used
4035 * for EOS and for making sure that we don't report a position we
4036 * have not reached yet. With LOCK. */
4038 gst_base_sink_get_position_last (GstBaseSink * basesink, GstFormat format,
4042 GstSegment *segment;
4043 gboolean ret = TRUE;
4045 segment = &basesink->segment;
4046 oformat = segment->format;
4048 if (oformat == GST_FORMAT_TIME) {
4049 /* return last observed stream time, we keep the stream time around in the
4051 *cur = basesink->priv->current_sstop;
4053 /* convert last stop to stream time */
4054 *cur = gst_segment_to_stream_time (segment, oformat, segment->last_stop);
4057 if (*cur != -1 && oformat != format) {
4058 GST_OBJECT_UNLOCK (basesink);
4059 /* convert to the target format if we need to, release lock first */
4061 gst_pad_query_convert (basesink->sinkpad, oformat, *cur, &format, cur);
4064 GST_OBJECT_LOCK (basesink);
4067 GST_DEBUG_OBJECT (basesink, "POSITION: %" GST_TIME_FORMAT,
4068 GST_TIME_ARGS (*cur));
4073 /* get the position when we are PAUSED, this is the stream time of the buffer
4074 * that prerolled. If no buffer is prerolled (we are still flushing), this
4075 * value will be -1. With LOCK. */
4077 gst_base_sink_get_position_paused (GstBaseSink * basesink, GstFormat format,
4082 GstSegment *segment;
4085 /* we don't use the clip segment in pull mode, when seeking we update the
4086 * main segment directly with the new segment values without it having to be
4087 * activated by the rendering after preroll */
4088 if (basesink->pad_mode == GST_ACTIVATE_PUSH)
4089 segment = basesink->abidata.ABI.clip_segment;
4091 segment = &basesink->segment;
4092 oformat = segment->format;
4094 if (oformat == GST_FORMAT_TIME) {
4095 *cur = basesink->priv->current_sstart;
4096 if (segment->rate < 0.0 && basesink->priv->current_sstop != -1) {
4097 /* for reverse playback we prefer the stream time stop position if we have
4099 *cur = basesink->priv->current_sstop;
4102 *cur = gst_segment_to_stream_time (segment, oformat, segment->last_stop);
4105 time = segment->time;
4108 *cur = MAX (*cur, time);
4109 GST_DEBUG_OBJECT (basesink, "POSITION as max: %" GST_TIME_FORMAT
4110 ", time %" GST_TIME_FORMAT, GST_TIME_ARGS (*cur), GST_TIME_ARGS (time));
4112 /* we have no buffer, use the segment times. */
4113 if (segment->rate >= 0.0) {
4114 /* forward, next position is always the time of the segment */
4116 GST_DEBUG_OBJECT (basesink, "POSITION as time: %" GST_TIME_FORMAT,
4117 GST_TIME_ARGS (*cur));
4119 /* reverse, next expected timestamp is segment->stop. We use the function
4120 * to get things right for negative applied_rates. */
4121 *cur = gst_segment_to_stream_time (segment, oformat, segment->stop);
4122 GST_DEBUG_OBJECT (basesink, "reverse POSITION: %" GST_TIME_FORMAT,
4123 GST_TIME_ARGS (*cur));
4128 if (res && oformat != format) {
4129 GST_OBJECT_UNLOCK (basesink);
4131 gst_pad_query_convert (basesink->sinkpad, oformat, *cur, &format, cur);
4134 GST_OBJECT_LOCK (basesink);
4141 gst_base_sink_get_position (GstBaseSink * basesink, GstFormat format,
4142 gint64 * cur, gboolean * upstream)
4145 gboolean res = FALSE;
4146 GstFormat oformat, tformat;
4147 GstClockTime now, base, latency;
4148 gint64 time, accum, duration;
4152 GST_OBJECT_LOCK (basesink);
4153 /* our intermediate time format */
4154 tformat = GST_FORMAT_TIME;
4155 /* get the format in the segment */
4156 oformat = basesink->segment.format;
4158 /* can only give answer based on the clock if not EOS */
4159 if (G_UNLIKELY (basesink->eos))
4162 /* we can only get the segment when we are not NULL or READY */
4163 if (!basesink->have_newsegment)
4166 /* when not in PLAYING or when we're busy with a state change, we
4167 * cannot read from the clock so we report time based on the
4168 * last seen timestamp. */
4169 if (GST_STATE (basesink) != GST_STATE_PLAYING ||
4170 GST_STATE_PENDING (basesink) != GST_STATE_VOID_PENDING)
4173 /* we need to sync on the clock. */
4174 if (basesink->sync == FALSE)
4177 /* and we need a clock */
4178 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (basesink)) == NULL))
4181 /* collect all data we need holding the lock */
4182 if (GST_CLOCK_TIME_IS_VALID (basesink->segment.time))
4183 time = basesink->segment.time;
4187 if (GST_CLOCK_TIME_IS_VALID (basesink->segment.stop))
4188 duration = basesink->segment.stop - basesink->segment.start;
4192 base = GST_ELEMENT_CAST (basesink)->base_time;
4193 accum = basesink->segment.accum;
4194 rate = basesink->segment.rate * basesink->segment.applied_rate;
4195 latency = basesink->priv->latency;
4197 gst_object_ref (clock);
4199 /* this function might release the LOCK */
4200 gst_base_sink_get_position_last (basesink, format, &last);
4202 /* need to release the object lock before we can get the time,
4203 * a clock might take the LOCK of the provider, which could be
4204 * a basesink subclass. */
4205 GST_OBJECT_UNLOCK (basesink);
4207 now = gst_clock_get_time (clock);
4209 if (oformat != tformat) {
4210 /* convert accum, time and duration to time */
4211 if (!gst_pad_query_convert (basesink->sinkpad, oformat, accum, &tformat,
4213 goto convert_failed;
4214 if (!gst_pad_query_convert (basesink->sinkpad, oformat, duration, &tformat,
4216 goto convert_failed;
4217 if (!gst_pad_query_convert (basesink->sinkpad, oformat, time, &tformat,
4219 goto convert_failed;
4222 /* subtract base time and accumulated time from the clock time.
4223 * Make sure we don't go negative. This is the current time in
4224 * the segment which we need to scale with the combined
4225 * rate and applied rate. */
4228 base = MIN (now, base);
4230 /* for negative rates we need to count back from from the segment
4235 *cur = time + gst_guint64_to_gdouble (now - base) * rate;
4237 /* never report more than last seen position */
4239 *cur = MIN (last, *cur);
4241 gst_object_unref (clock);
4243 GST_DEBUG_OBJECT (basesink,
4244 "now %" GST_TIME_FORMAT " - base %" GST_TIME_FORMAT " - accum %"
4245 GST_TIME_FORMAT " + time %" GST_TIME_FORMAT,
4246 GST_TIME_ARGS (now), GST_TIME_ARGS (base),
4247 GST_TIME_ARGS (accum), GST_TIME_ARGS (time));
4249 if (oformat != format) {
4250 /* convert time to final format */
4251 if (!gst_pad_query_convert (basesink->sinkpad, tformat, *cur, &format, cur))
4252 goto convert_failed;
4258 GST_DEBUG_OBJECT (basesink, "res: %d, POSITION: %" GST_TIME_FORMAT,
4259 res, GST_TIME_ARGS (*cur));
4265 GST_DEBUG_OBJECT (basesink, "position in EOS");
4266 res = gst_base_sink_get_position_last (basesink, format, cur);
4267 GST_OBJECT_UNLOCK (basesink);
4272 GST_DEBUG_OBJECT (basesink, "position in PAUSED");
4273 res = gst_base_sink_get_position_paused (basesink, format, cur);
4274 GST_OBJECT_UNLOCK (basesink);
4279 /* in NULL or READY we always return FALSE and -1 */
4280 GST_DEBUG_OBJECT (basesink, "position in wrong state, return -1");
4283 GST_OBJECT_UNLOCK (basesink);
4288 /* report last seen timestamp if any, else ask upstream to answer */
4289 if ((*cur = basesink->priv->current_sstart) != -1)
4294 GST_DEBUG_OBJECT (basesink, "no sync, res %d, POSITION %" GST_TIME_FORMAT,
4295 res, GST_TIME_ARGS (*cur));
4296 GST_OBJECT_UNLOCK (basesink);
4301 GST_DEBUG_OBJECT (basesink, "convert failed, try upstream");
4308 gst_base_sink_query (GstElement * element, GstQuery * query)
4310 gboolean res = FALSE;
4312 GstBaseSink *basesink = GST_BASE_SINK (element);
4314 switch (GST_QUERY_TYPE (query)) {
4315 case GST_QUERY_POSITION:
4319 gboolean upstream = FALSE;
4321 gst_query_parse_position (query, &format, NULL);
4323 GST_DEBUG_OBJECT (basesink, "position format %d", format);
4325 /* first try to get the position based on the clock */
4327 gst_base_sink_get_position (basesink, format, &cur, &upstream))) {
4328 gst_query_set_position (query, format, cur);
4329 } else if (upstream) {
4330 /* fallback to peer query */
4331 res = gst_base_sink_peer_query (basesink, query);
4335 case GST_QUERY_DURATION:
4337 GstFormat format, uformat;
4338 gint64 duration, uduration;
4340 gst_query_parse_duration (query, &format, NULL);
4342 GST_DEBUG_OBJECT (basesink, "duration query in format %s",
4343 gst_format_get_name (format));
4345 if (basesink->pad_mode == GST_ACTIVATE_PULL) {
4346 uformat = GST_FORMAT_BYTES;
4348 /* get the duration in bytes, in pull mode that's all we are sure to
4349 * know. We have to explicitly get this value from upstream instead of
4350 * using our cached value because it might change. Duration caching
4351 * should be done at a higher level. */
4352 res = gst_pad_query_peer_duration (basesink->sinkpad, &uformat,
4355 gst_segment_set_duration (&basesink->segment, uformat, uduration);
4356 if (format != uformat) {
4357 /* convert to the requested format */
4358 res = gst_pad_query_convert (basesink->sinkpad, uformat, uduration,
4359 &format, &duration);
4361 duration = uduration;
4364 /* set the result */
4365 gst_query_set_duration (query, format, duration);
4369 /* in push mode we simply forward upstream */
4370 res = gst_base_sink_peer_query (basesink, query);
4374 case GST_QUERY_LATENCY:
4376 gboolean live, us_live;
4377 GstClockTime min, max;
4379 if ((res = gst_base_sink_query_latency (basesink, &live, &us_live, &min,
4381 gst_query_set_latency (query, live, min, max);
4385 case GST_QUERY_JITTER:
4387 case GST_QUERY_RATE:
4388 /* gst_query_set_rate (query, basesink->segment_rate); */
4391 case GST_QUERY_SEGMENT:
4393 /* FIXME, bring start/stop to stream time */
4394 gst_query_set_segment (query, basesink->segment.rate,
4395 GST_FORMAT_TIME, basesink->segment.start, basesink->segment.stop);
4398 case GST_QUERY_SEEKING:
4399 case GST_QUERY_CONVERT:
4400 case GST_QUERY_FORMATS:
4402 res = gst_base_sink_peer_query (basesink, query);
4408 static GstStateChangeReturn
4409 gst_base_sink_change_state (GstElement * element, GstStateChange transition)
4411 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
4412 GstBaseSink *basesink = GST_BASE_SINK (element);
4413 GstBaseSinkClass *bclass;
4414 GstBaseSinkPrivate *priv;
4416 priv = basesink->priv;
4418 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4420 switch (transition) {
4421 case GST_STATE_CHANGE_NULL_TO_READY:
4423 if (!bclass->start (basesink))
4426 case GST_STATE_CHANGE_READY_TO_PAUSED:
4427 /* need to complete preroll before this state change completes, there
4428 * is no data flow in READY so we can safely assume we need to preroll. */
4429 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4430 GST_DEBUG_OBJECT (basesink, "READY to PAUSED");
4431 basesink->have_newsegment = FALSE;
4432 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
4433 gst_segment_init (basesink->abidata.ABI.clip_segment,
4434 GST_FORMAT_UNDEFINED);
4435 basesink->offset = 0;
4436 basesink->have_preroll = FALSE;
4437 priv->step_unlock = FALSE;
4438 basesink->need_preroll = TRUE;
4439 basesink->playing_async = TRUE;
4440 priv->current_sstart = -1;
4441 priv->current_sstop = -1;
4442 priv->eos_rtime = -1;
4444 basesink->eos = FALSE;
4445 priv->received_eos = FALSE;
4446 gst_base_sink_reset_qos (basesink);
4447 priv->commited = FALSE;
4448 priv->call_preroll = TRUE;
4449 priv->current_step.valid = FALSE;
4450 priv->pending_step.valid = FALSE;
4451 if (priv->async_enabled) {
4452 GST_DEBUG_OBJECT (basesink, "doing async state change");
4453 /* when async enabled, post async-start message and return ASYNC from
4454 * the state change function */
4455 ret = GST_STATE_CHANGE_ASYNC;
4456 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4457 gst_message_new_async_start (GST_OBJECT_CAST (basesink), FALSE));
4459 priv->have_latency = TRUE;
4461 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4463 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
4464 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4465 if (!gst_base_sink_needs_preroll (basesink)) {
4466 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, don't need preroll");
4467 /* no preroll needed anymore now. */
4468 basesink->playing_async = FALSE;
4469 basesink->need_preroll = FALSE;
4470 if (basesink->eos) {
4471 GstMessage *message;
4473 /* need to post EOS message here */
4474 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
4475 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
4476 gst_message_set_seqnum (message, basesink->priv->seqnum);
4477 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
4479 GST_DEBUG_OBJECT (basesink, "signal preroll");
4480 GST_PAD_PREROLL_SIGNAL (basesink->sinkpad);
4483 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, we are not prerolled");
4484 basesink->need_preroll = TRUE;
4485 basesink->playing_async = TRUE;
4486 priv->call_preroll = TRUE;
4487 priv->commited = FALSE;
4488 if (priv->async_enabled) {
4489 GST_DEBUG_OBJECT (basesink, "doing async state change");
4490 ret = GST_STATE_CHANGE_ASYNC;
4491 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4492 gst_message_new_async_start (GST_OBJECT_CAST (basesink), FALSE));
4495 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4502 GstStateChangeReturn bret;
4504 bret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
4505 if (G_UNLIKELY (bret == GST_STATE_CHANGE_FAILURE))
4506 goto activate_failed;
4509 switch (transition) {
4510 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
4511 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED");
4512 /* FIXME, make sure we cannot enter _render first */
4514 /* we need to call ::unlock before locking PREROLL_LOCK
4515 * since we lock it before going into ::render */
4517 bclass->unlock (basesink);
4519 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4520 /* now that we have the PREROLL lock, clear our unlock request */
4521 if (bclass->unlock_stop)
4522 bclass->unlock_stop (basesink);
4524 /* we need preroll again and we set the flag before unlocking the clockid
4525 * because if the clockid is unlocked before a current buffer expired, we
4526 * can use that buffer to preroll with */
4527 basesink->need_preroll = TRUE;
4529 if (basesink->clock_id) {
4530 gst_clock_id_unschedule (basesink->clock_id);
4533 /* if we don't have a preroll buffer we need to wait for a preroll and
4535 if (!gst_base_sink_needs_preroll (basesink)) {
4536 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED, we are prerolled");
4537 basesink->playing_async = FALSE;
4539 if (GST_STATE_TARGET (GST_ELEMENT (basesink)) <= GST_STATE_READY) {
4540 ret = GST_STATE_CHANGE_SUCCESS;
4542 GST_DEBUG_OBJECT (basesink,
4543 "PLAYING to PAUSED, we are not prerolled");
4544 basesink->playing_async = TRUE;
4545 priv->commited = FALSE;
4546 priv->call_preroll = TRUE;
4547 if (priv->async_enabled) {
4548 GST_DEBUG_OBJECT (basesink, "doing async state change");
4549 ret = GST_STATE_CHANGE_ASYNC;
4550 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4551 gst_message_new_async_start (GST_OBJECT_CAST (basesink),
4556 GST_DEBUG_OBJECT (basesink, "rendered: %" G_GUINT64_FORMAT
4557 ", dropped: %" G_GUINT64_FORMAT, priv->rendered, priv->dropped);
4559 gst_base_sink_reset_qos (basesink);
4560 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4562 case GST_STATE_CHANGE_PAUSED_TO_READY:
4563 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4564 /* start by reseting our position state with the object lock so that the
4565 * position query gets the right idea. We do this before we post the
4566 * messages so that the message handlers pick this up. */
4567 GST_OBJECT_LOCK (basesink);
4568 basesink->have_newsegment = FALSE;
4569 priv->current_sstart = -1;
4570 priv->current_sstop = -1;
4571 priv->have_latency = FALSE;
4572 GST_OBJECT_UNLOCK (basesink);
4574 gst_base_sink_set_last_buffer (basesink, NULL);
4575 priv->call_preroll = FALSE;
4577 if (!priv->commited) {
4578 if (priv->async_enabled) {
4579 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, posting async-done");
4581 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4582 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
4583 GST_STATE_PLAYING, GST_STATE_PAUSED, GST_STATE_READY));
4585 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4586 gst_message_new_async_done (GST_OBJECT_CAST (basesink)));
4588 priv->commited = TRUE;
4590 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, don't need_preroll");
4592 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4594 case GST_STATE_CHANGE_READY_TO_NULL:
4596 if (!bclass->stop (basesink)) {
4597 GST_WARNING_OBJECT (basesink, "failed to stop");
4600 gst_base_sink_set_last_buffer (basesink, NULL);
4601 priv->call_preroll = FALSE;
4612 GST_DEBUG_OBJECT (basesink, "failed to start");
4613 return GST_STATE_CHANGE_FAILURE;
4617 GST_DEBUG_OBJECT (basesink,
4618 "element failed to change states -- activation problem?");
4619 return GST_STATE_CHANGE_FAILURE;