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 gboolean flush; /* if this was a flushing step */
168 gboolean intermediate; /* if this is an intermediate step */
169 gboolean need_preroll; /* if we need preroll after this step */
172 /* FIXME, some stuff in ABI.data and other in Private...
173 * Make up your mind please.
175 struct _GstBaseSinkPrivate
177 gint qos_enabled; /* ATOMIC */
178 gboolean async_enabled;
179 GstClockTimeDiff ts_offset;
180 GstClockTime render_delay;
182 /* start, stop of current buffer, stream time, used to report position */
183 GstClockTime current_sstart;
184 GstClockTime current_sstop;
186 /* start, stop and jitter of current buffer, running time */
187 GstClockTime current_rstart;
188 GstClockTime current_rstop;
189 GstClockTimeDiff current_jitter;
191 /* EOS sync time in running time */
192 GstClockTime eos_rtime;
194 /* last buffer that arrived in time, running time */
195 GstClockTime last_in_time;
196 /* when the last buffer left the sink, running time */
197 GstClockTime last_left;
199 /* running averages go here these are done on running time */
201 GstClockTime avg_duration;
204 /* these are done on system time. avg_jitter and avg_render are
205 * compared to eachother to see if the rendering time takes a
206 * huge amount of the processing, If so we are flooded with
208 GstClockTime last_left_systime;
209 GstClockTime avg_jitter;
210 GstClockTime start, stop;
211 GstClockTime avg_render;
213 /* number of rendered and dropped frames */
218 GstClockTime latency;
220 /* if we already commited the state */
223 /* when we received EOS */
224 gboolean received_eos;
226 /* when we are prerolled and able to report latency */
227 gboolean have_latency;
229 /* the last buffer we prerolled or rendered. Useful for making snapshots */
230 GstBuffer *last_buffer;
232 /* caps for pull based scheduling */
235 /* blocksize for pulling */
240 /* seqnum of the stream */
243 gboolean call_preroll;
244 gboolean step_unlock;
246 /* we have a pending and a current step operation */
247 GstStepInfo current_step;
248 GstStepInfo pending_step;
251 #define DO_RUNNING_AVG(avg,val,size) (((val) + ((size)-1) * (avg)) / (size))
253 /* generic running average, this has a neutral window size */
254 #define UPDATE_RUNNING_AVG(avg,val) DO_RUNNING_AVG(avg,val,8)
256 /* the windows for these running averages are experimentally obtained.
257 * possitive values get averaged more while negative values use a small
258 * window so we can react faster to badness. */
259 #define UPDATE_RUNNING_AVG_P(avg,val) DO_RUNNING_AVG(avg,val,16)
260 #define UPDATE_RUNNING_AVG_N(avg,val) DO_RUNNING_AVG(avg,val,4)
262 /* BaseSink properties */
264 #define DEFAULT_CAN_ACTIVATE_PULL FALSE /* fixme: enable me */
265 #define DEFAULT_CAN_ACTIVATE_PUSH TRUE
267 #define DEFAULT_PREROLL_QUEUE_LEN 0
268 #define DEFAULT_SYNC TRUE
269 #define DEFAULT_MAX_LATENESS -1
270 #define DEFAULT_QOS FALSE
271 #define DEFAULT_ASYNC TRUE
272 #define DEFAULT_TS_OFFSET 0
273 #define DEFAULT_BLOCKSIZE 4096
274 #define DEFAULT_RENDER_DELAY 0
279 PROP_PREROLL_QUEUE_LEN,
291 static GstElementClass *parent_class = NULL;
293 static void gst_base_sink_class_init (GstBaseSinkClass * klass);
294 static void gst_base_sink_init (GstBaseSink * trans, gpointer g_class);
295 static void gst_base_sink_finalize (GObject * object);
298 gst_base_sink_get_type (void)
300 static volatile gsize base_sink_type = 0;
302 if (g_once_init_enter (&base_sink_type)) {
304 static const GTypeInfo base_sink_info = {
305 sizeof (GstBaseSinkClass),
308 (GClassInitFunc) gst_base_sink_class_init,
311 sizeof (GstBaseSink),
313 (GInstanceInitFunc) gst_base_sink_init,
316 _type = g_type_register_static (GST_TYPE_ELEMENT,
317 "GstBaseSink", &base_sink_info, G_TYPE_FLAG_ABSTRACT);
318 g_once_init_leave (&base_sink_type, _type);
320 return base_sink_type;
323 static void gst_base_sink_set_property (GObject * object, guint prop_id,
324 const GValue * value, GParamSpec * pspec);
325 static void gst_base_sink_get_property (GObject * object, guint prop_id,
326 GValue * value, GParamSpec * pspec);
328 static gboolean gst_base_sink_send_event (GstElement * element,
330 static gboolean gst_base_sink_query (GstElement * element, GstQuery * query);
332 static GstCaps *gst_base_sink_get_caps (GstBaseSink * sink);
333 static gboolean gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps);
334 static GstFlowReturn gst_base_sink_buffer_alloc (GstBaseSink * sink,
335 guint64 offset, guint size, GstCaps * caps, GstBuffer ** buf);
336 static void gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
337 GstClockTime * start, GstClockTime * end);
338 static gboolean gst_base_sink_set_flushing (GstBaseSink * basesink,
339 GstPad * pad, gboolean flushing);
340 static gboolean gst_base_sink_default_activate_pull (GstBaseSink * basesink,
342 static gboolean gst_base_sink_default_do_seek (GstBaseSink * sink,
343 GstSegment * segment);
344 static gboolean gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
345 GstEvent * event, GstSegment * segment);
347 static GstStateChangeReturn gst_base_sink_change_state (GstElement * element,
348 GstStateChange transition);
350 static GstFlowReturn gst_base_sink_chain (GstPad * pad, GstBuffer * buffer);
351 static void gst_base_sink_loop (GstPad * pad);
352 static gboolean gst_base_sink_pad_activate (GstPad * pad);
353 static gboolean gst_base_sink_pad_activate_push (GstPad * pad, gboolean active);
354 static gboolean gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active);
355 static gboolean gst_base_sink_event (GstPad * pad, GstEvent * event);
356 static gboolean gst_base_sink_peer_query (GstBaseSink * sink, GstQuery * query);
358 static gboolean gst_base_sink_negotiate_pull (GstBaseSink * basesink);
360 /* check if an object was too late */
361 static gboolean gst_base_sink_is_too_late (GstBaseSink * basesink,
362 GstMiniObject * obj, GstClockTime start, GstClockTime stop,
363 GstClockReturn status, GstClockTimeDiff jitter);
364 static GstFlowReturn gst_base_sink_preroll_object (GstBaseSink * basesink,
365 GstMiniObject * obj);
368 gst_base_sink_class_init (GstBaseSinkClass * klass)
370 GObjectClass *gobject_class;
371 GstElementClass *gstelement_class;
373 gobject_class = G_OBJECT_CLASS (klass);
374 gstelement_class = GST_ELEMENT_CLASS (klass);
376 GST_DEBUG_CATEGORY_INIT (gst_base_sink_debug, "basesink", 0,
379 g_type_class_add_private (klass, sizeof (GstBaseSinkPrivate));
381 parent_class = g_type_class_peek_parent (klass);
383 gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_base_sink_finalize);
384 gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_base_sink_set_property);
385 gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_base_sink_get_property);
387 /* FIXME, this next value should be configured using an event from the
388 * upstream element, ie, the BUFFER_SIZE event. */
389 g_object_class_install_property (gobject_class, PROP_PREROLL_QUEUE_LEN,
390 g_param_spec_uint ("preroll-queue-len", "Preroll queue length",
391 "Number of buffers to queue during preroll", 0, G_MAXUINT,
392 DEFAULT_PREROLL_QUEUE_LEN,
393 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
395 g_object_class_install_property (gobject_class, PROP_SYNC,
396 g_param_spec_boolean ("sync", "Sync", "Sync on the clock", DEFAULT_SYNC,
397 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
399 g_object_class_install_property (gobject_class, PROP_MAX_LATENESS,
400 g_param_spec_int64 ("max-lateness", "Max Lateness",
401 "Maximum number of nanoseconds that a buffer can be late before it "
402 "is dropped (-1 unlimited)", -1, G_MAXINT64, DEFAULT_MAX_LATENESS,
403 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
405 g_object_class_install_property (gobject_class, PROP_QOS,
406 g_param_spec_boolean ("qos", "Qos",
407 "Generate Quality-of-Service events upstream", DEFAULT_QOS,
408 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
412 * If set to #TRUE, the basesink will perform asynchronous state changes.
413 * When set to #FALSE, the sink will not signal the parent when it prerolls.
414 * Use this option when dealing with sparse streams or when synchronisation is
419 g_object_class_install_property (gobject_class, PROP_ASYNC,
420 g_param_spec_boolean ("async", "Async",
421 "Go asynchronously to PAUSED", DEFAULT_ASYNC,
422 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
424 * GstBaseSink:ts-offset
426 * Controls the final synchronisation, a negative value will render the buffer
427 * earlier while a positive value delays playback. This property can be
428 * used to fix synchronisation in bad files.
432 g_object_class_install_property (gobject_class, PROP_TS_OFFSET,
433 g_param_spec_int64 ("ts-offset", "TS Offset",
434 "Timestamp offset in nanoseconds", G_MININT64, G_MAXINT64,
435 DEFAULT_TS_OFFSET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
437 * GstBaseSink:last-buffer
439 * The last buffer that arrived in the sink and was used for preroll or for
440 * rendering. This property can be used to generate thumbnails. This property
441 * can be NULL when the sink has not yet received a bufer.
445 g_object_class_install_property (gobject_class, PROP_LAST_BUFFER,
446 gst_param_spec_mini_object ("last-buffer", "Last Buffer",
447 "The last buffer received in the sink", GST_TYPE_BUFFER,
448 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
450 * GstBaseSink:blocksize
452 * The amount of bytes to pull when operating in pull mode.
456 g_object_class_install_property (gobject_class, PROP_BLOCKSIZE,
457 g_param_spec_uint ("blocksize", "Block size",
458 "Size in bytes to pull per buffer (0 = default)", 0, G_MAXUINT,
459 DEFAULT_BLOCKSIZE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
461 * GstBaseSink:render-delay
463 * The additional delay between synchronisation and actual rendering of the
464 * media. This property will add additional latency to the device in order to
465 * make other sinks compensate for the delay.
469 g_object_class_install_property (gobject_class, PROP_RENDER_DELAY,
470 g_param_spec_uint64 ("render-delay", "Render Delay",
471 "Additional render delay of the sink in nanoseconds", 0, G_MAXUINT64,
472 DEFAULT_RENDER_DELAY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
474 gstelement_class->change_state =
475 GST_DEBUG_FUNCPTR (gst_base_sink_change_state);
476 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_base_sink_send_event);
477 gstelement_class->query = GST_DEBUG_FUNCPTR (gst_base_sink_query);
479 klass->get_caps = GST_DEBUG_FUNCPTR (gst_base_sink_get_caps);
480 klass->set_caps = GST_DEBUG_FUNCPTR (gst_base_sink_set_caps);
481 klass->buffer_alloc = GST_DEBUG_FUNCPTR (gst_base_sink_buffer_alloc);
482 klass->get_times = GST_DEBUG_FUNCPTR (gst_base_sink_get_times);
483 klass->activate_pull =
484 GST_DEBUG_FUNCPTR (gst_base_sink_default_activate_pull);
488 gst_base_sink_pad_getcaps (GstPad * pad)
490 GstBaseSinkClass *bclass;
492 GstCaps *caps = NULL;
494 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
495 bclass = GST_BASE_SINK_GET_CLASS (bsink);
497 if (bsink->pad_mode == GST_ACTIVATE_PULL) {
498 /* if we are operating in pull mode we only accept the negotiated caps */
499 GST_OBJECT_LOCK (pad);
500 if ((caps = GST_PAD_CAPS (pad)))
502 GST_OBJECT_UNLOCK (pad);
505 if (bclass->get_caps)
506 caps = bclass->get_caps (bsink);
509 GstPadTemplate *pad_template;
512 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass),
514 if (pad_template != NULL) {
515 caps = gst_caps_ref (gst_pad_template_get_caps (pad_template));
519 gst_object_unref (bsink);
525 gst_base_sink_pad_setcaps (GstPad * pad, GstCaps * caps)
527 GstBaseSinkClass *bclass;
531 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
532 bclass = GST_BASE_SINK_GET_CLASS (bsink);
534 if (res && bclass->set_caps)
535 res = bclass->set_caps (bsink, caps);
537 gst_object_unref (bsink);
543 gst_base_sink_pad_fixate (GstPad * pad, GstCaps * caps)
545 GstBaseSinkClass *bclass;
548 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
549 bclass = GST_BASE_SINK_GET_CLASS (bsink);
552 bclass->fixate (bsink, caps);
554 gst_object_unref (bsink);
558 gst_base_sink_pad_buffer_alloc (GstPad * pad, guint64 offset, guint size,
559 GstCaps * caps, GstBuffer ** buf)
561 GstBaseSinkClass *bclass;
563 GstFlowReturn result = GST_FLOW_OK;
565 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
566 bclass = GST_BASE_SINK_GET_CLASS (bsink);
568 if (bclass->buffer_alloc)
569 result = bclass->buffer_alloc (bsink, offset, size, caps, buf);
571 *buf = NULL; /* fallback in gstpad.c will allocate generic buffer */
573 gst_object_unref (bsink);
579 gst_base_sink_init (GstBaseSink * basesink, gpointer g_class)
581 GstPadTemplate *pad_template;
582 GstBaseSinkPrivate *priv;
584 basesink->priv = priv = GST_BASE_SINK_GET_PRIVATE (basesink);
587 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "sink");
588 g_return_if_fail (pad_template != NULL);
590 basesink->sinkpad = gst_pad_new_from_template (pad_template, "sink");
592 gst_pad_set_getcaps_function (basesink->sinkpad,
593 GST_DEBUG_FUNCPTR (gst_base_sink_pad_getcaps));
594 gst_pad_set_setcaps_function (basesink->sinkpad,
595 GST_DEBUG_FUNCPTR (gst_base_sink_pad_setcaps));
596 gst_pad_set_fixatecaps_function (basesink->sinkpad,
597 GST_DEBUG_FUNCPTR (gst_base_sink_pad_fixate));
598 gst_pad_set_bufferalloc_function (basesink->sinkpad,
599 GST_DEBUG_FUNCPTR (gst_base_sink_pad_buffer_alloc));
600 gst_pad_set_activate_function (basesink->sinkpad,
601 GST_DEBUG_FUNCPTR (gst_base_sink_pad_activate));
602 gst_pad_set_activatepush_function (basesink->sinkpad,
603 GST_DEBUG_FUNCPTR (gst_base_sink_pad_activate_push));
604 gst_pad_set_activatepull_function (basesink->sinkpad,
605 GST_DEBUG_FUNCPTR (gst_base_sink_pad_activate_pull));
606 gst_pad_set_event_function (basesink->sinkpad,
607 GST_DEBUG_FUNCPTR (gst_base_sink_event));
608 gst_pad_set_chain_function (basesink->sinkpad,
609 GST_DEBUG_FUNCPTR (gst_base_sink_chain));
610 gst_element_add_pad (GST_ELEMENT_CAST (basesink), basesink->sinkpad);
612 basesink->pad_mode = GST_ACTIVATE_NONE;
613 basesink->preroll_queue = g_queue_new ();
614 basesink->abidata.ABI.clip_segment = gst_segment_new ();
615 priv->have_latency = FALSE;
617 basesink->can_activate_push = DEFAULT_CAN_ACTIVATE_PUSH;
618 basesink->can_activate_pull = DEFAULT_CAN_ACTIVATE_PULL;
620 basesink->sync = DEFAULT_SYNC;
621 basesink->abidata.ABI.max_lateness = DEFAULT_MAX_LATENESS;
622 g_atomic_int_set (&priv->qos_enabled, DEFAULT_QOS);
623 priv->async_enabled = DEFAULT_ASYNC;
624 priv->ts_offset = DEFAULT_TS_OFFSET;
625 priv->render_delay = DEFAULT_RENDER_DELAY;
626 priv->blocksize = DEFAULT_BLOCKSIZE;
628 GST_OBJECT_FLAG_SET (basesink, GST_ELEMENT_IS_SINK);
632 gst_base_sink_finalize (GObject * object)
634 GstBaseSink *basesink;
636 basesink = GST_BASE_SINK (object);
638 g_queue_free (basesink->preroll_queue);
639 gst_segment_free (basesink->abidata.ABI.clip_segment);
641 G_OBJECT_CLASS (parent_class)->finalize (object);
645 * gst_base_sink_set_sync:
647 * @sync: the new sync value.
649 * Configures @sink to synchronize on the clock or not. When
650 * @sync is FALSE, incomming samples will be played as fast as
651 * possible. If @sync is TRUE, the timestamps of the incomming
652 * buffers will be used to schedule the exact render time of its
658 gst_base_sink_set_sync (GstBaseSink * sink, gboolean sync)
660 g_return_if_fail (GST_IS_BASE_SINK (sink));
662 GST_OBJECT_LOCK (sink);
664 GST_OBJECT_UNLOCK (sink);
668 * gst_base_sink_get_sync:
671 * Checks if @sink is currently configured to synchronize against the
674 * Returns: TRUE if the sink is configured to synchronize against the clock.
679 gst_base_sink_get_sync (GstBaseSink * sink)
683 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
685 GST_OBJECT_LOCK (sink);
687 GST_OBJECT_UNLOCK (sink);
693 * gst_base_sink_set_max_lateness:
695 * @max_lateness: the new max lateness value.
697 * Sets the new max lateness value to @max_lateness. This value is
698 * used to decide if a buffer should be dropped or not based on the
699 * buffer timestamp and the current clock time. A value of -1 means
705 gst_base_sink_set_max_lateness (GstBaseSink * sink, gint64 max_lateness)
707 g_return_if_fail (GST_IS_BASE_SINK (sink));
709 GST_OBJECT_LOCK (sink);
710 sink->abidata.ABI.max_lateness = max_lateness;
711 GST_OBJECT_UNLOCK (sink);
715 * gst_base_sink_get_max_lateness:
718 * Gets the max lateness value. See gst_base_sink_set_max_lateness for
721 * Returns: The maximum time in nanoseconds that a buffer can be late
722 * before it is dropped and not rendered. A value of -1 means an
728 gst_base_sink_get_max_lateness (GstBaseSink * sink)
732 g_return_val_if_fail (GST_IS_BASE_SINK (sink), -1);
734 GST_OBJECT_LOCK (sink);
735 res = sink->abidata.ABI.max_lateness;
736 GST_OBJECT_UNLOCK (sink);
742 * gst_base_sink_set_qos_enabled:
744 * @enabled: the new qos value.
746 * Configures @sink to send Quality-of-Service events upstream.
751 gst_base_sink_set_qos_enabled (GstBaseSink * sink, gboolean enabled)
753 g_return_if_fail (GST_IS_BASE_SINK (sink));
755 g_atomic_int_set (&sink->priv->qos_enabled, enabled);
759 * gst_base_sink_is_qos_enabled:
762 * Checks if @sink is currently configured to send Quality-of-Service events
765 * Returns: TRUE if the sink is configured to perform Quality-of-Service.
770 gst_base_sink_is_qos_enabled (GstBaseSink * sink)
774 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
776 res = g_atomic_int_get (&sink->priv->qos_enabled);
782 * gst_base_sink_set_async_enabled:
784 * @enabled: the new async value.
786 * Configures @sink to perform all state changes asynchronusly. When async is
787 * disabled, the sink will immediatly go to PAUSED instead of waiting for a
788 * preroll buffer. This feature is usefull if the sink does not synchronize
789 * against the clock or when it is dealing with sparse streams.
794 gst_base_sink_set_async_enabled (GstBaseSink * sink, gboolean enabled)
796 g_return_if_fail (GST_IS_BASE_SINK (sink));
798 GST_PAD_PREROLL_LOCK (sink->sinkpad);
799 sink->priv->async_enabled = enabled;
800 GST_LOG_OBJECT (sink, "set async enabled to %d", enabled);
801 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
805 * gst_base_sink_is_async_enabled:
808 * Checks if @sink is currently configured to perform asynchronous state
811 * Returns: TRUE if the sink is configured to perform asynchronous state
817 gst_base_sink_is_async_enabled (GstBaseSink * sink)
821 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
823 GST_PAD_PREROLL_LOCK (sink->sinkpad);
824 res = sink->priv->async_enabled;
825 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
831 * gst_base_sink_set_ts_offset:
833 * @offset: the new offset
835 * Adjust the synchronisation of @sink with @offset. A negative value will
836 * render buffers earlier than their timestamp. A positive value will delay
837 * rendering. This function can be used to fix playback of badly timestamped
843 gst_base_sink_set_ts_offset (GstBaseSink * sink, GstClockTimeDiff offset)
845 g_return_if_fail (GST_IS_BASE_SINK (sink));
847 GST_OBJECT_LOCK (sink);
848 sink->priv->ts_offset = offset;
849 GST_LOG_OBJECT (sink, "set time offset to %" G_GINT64_FORMAT, offset);
850 GST_OBJECT_UNLOCK (sink);
854 * gst_base_sink_get_ts_offset:
857 * Get the synchronisation offset of @sink.
859 * Returns: The synchronisation offset.
864 gst_base_sink_get_ts_offset (GstBaseSink * sink)
866 GstClockTimeDiff res;
868 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
870 GST_OBJECT_LOCK (sink);
871 res = sink->priv->ts_offset;
872 GST_OBJECT_UNLOCK (sink);
878 * gst_base_sink_get_last_buffer:
881 * Get the last buffer that arrived in the sink and was used for preroll or for
882 * rendering. This property can be used to generate thumbnails.
884 * The #GstCaps on the buffer can be used to determine the type of the buffer.
886 * Returns: a #GstBuffer. gst_buffer_unref() after usage. This function returns
887 * NULL when no buffer has arrived in the sink yet or when the sink is not in
893 gst_base_sink_get_last_buffer (GstBaseSink * sink)
897 g_return_val_if_fail (GST_IS_BASE_SINK (sink), NULL);
899 GST_OBJECT_LOCK (sink);
900 if ((res = sink->priv->last_buffer))
901 gst_buffer_ref (res);
902 GST_OBJECT_UNLOCK (sink);
908 gst_base_sink_set_last_buffer (GstBaseSink * sink, GstBuffer * buffer)
912 GST_OBJECT_LOCK (sink);
913 old = sink->priv->last_buffer;
914 if (G_LIKELY (old != buffer)) {
915 GST_DEBUG_OBJECT (sink, "setting last buffer to %p", buffer);
916 if (G_LIKELY (buffer))
917 gst_buffer_ref (buffer);
918 sink->priv->last_buffer = buffer;
922 GST_OBJECT_UNLOCK (sink);
924 /* avoid unreffing with the lock because cleanup code might want to take the
927 gst_buffer_unref (old);
931 * gst_base_sink_get_latency:
934 * Get the currently configured latency.
936 * Returns: The configured latency.
941 gst_base_sink_get_latency (GstBaseSink * sink)
945 GST_OBJECT_LOCK (sink);
946 res = sink->priv->latency;
947 GST_OBJECT_UNLOCK (sink);
953 * gst_base_sink_query_latency:
955 * @live: if the sink is live
956 * @upstream_live: if an upstream element is live
957 * @min_latency: the min latency of the upstream elements
958 * @max_latency: the max latency of the upstream elements
960 * Query the sink for the latency parameters. The latency will be queried from
961 * the upstream elements. @live will be TRUE if @sink is configured to
962 * synchronize against the clock. @upstream_live will be TRUE if an upstream
965 * If both @live and @upstream_live are TRUE, the sink will want to compensate
966 * for the latency introduced by the upstream elements by setting the
967 * @min_latency to a strictly possitive value.
969 * This function is mostly used by subclasses.
971 * Returns: TRUE if the query succeeded.
976 gst_base_sink_query_latency (GstBaseSink * sink, gboolean * live,
977 gboolean * upstream_live, GstClockTime * min_latency,
978 GstClockTime * max_latency)
980 gboolean l, us_live, res, have_latency;
981 GstClockTime min, max, render_delay;
983 GstClockTime us_min, us_max;
985 /* we are live when we sync to the clock */
986 GST_OBJECT_LOCK (sink);
988 have_latency = sink->priv->have_latency;
989 render_delay = sink->priv->render_delay;
990 GST_OBJECT_UNLOCK (sink);
992 /* assume no latency */
998 GST_DEBUG_OBJECT (sink, "we are ready for LATENCY query");
999 /* we are ready for a latency query this is when we preroll or when we are
1001 query = gst_query_new_latency ();
1003 /* ask the peer for the latency */
1004 if ((res = gst_base_sink_peer_query (sink, query))) {
1005 /* get upstream min and max latency */
1006 gst_query_parse_latency (query, &us_live, &us_min, &us_max);
1009 /* upstream live, use its latency, subclasses should use these
1010 * values to create the complete latency. */
1015 /* we need to add the render delay if we are live */
1017 min += render_delay;
1019 max += render_delay;
1022 gst_query_unref (query);
1024 GST_DEBUG_OBJECT (sink, "we are not yet ready for LATENCY query");
1028 /* not live, we tried to do the query, if it failed we return TRUE anyway */
1032 GST_DEBUG_OBJECT (sink, "latency query failed but we are not live");
1034 GST_DEBUG_OBJECT (sink, "latency query failed and we are live");
1039 GST_DEBUG_OBJECT (sink, "latency query: live: %d, have_latency %d,"
1040 " upstream: %d, min %" GST_TIME_FORMAT ", max %" GST_TIME_FORMAT, l,
1041 have_latency, us_live, GST_TIME_ARGS (min), GST_TIME_ARGS (max));
1046 *upstream_live = us_live;
1056 * gst_base_sink_set_render_delay:
1057 * @sink: a #GstBaseSink
1058 * @delay: the new delay
1060 * Set the render delay in @sink to @delay. The render delay is the time
1061 * between actual rendering of a buffer and its synchronisation time. Some
1062 * devices might delay media rendering which can be compensated for with this
1065 * After calling this function, this sink will report additional latency and
1066 * other sinks will adjust their latency to delay the rendering of their media.
1068 * This function is usually called by subclasses.
1073 gst_base_sink_set_render_delay (GstBaseSink * sink, GstClockTime delay)
1075 GstClockTime old_render_delay;
1077 g_return_if_fail (GST_IS_BASE_SINK (sink));
1079 GST_OBJECT_LOCK (sink);
1080 old_render_delay = sink->priv->render_delay;
1081 sink->priv->render_delay = delay;
1082 GST_LOG_OBJECT (sink, "set render delay to %" GST_TIME_FORMAT,
1083 GST_TIME_ARGS (delay));
1084 GST_OBJECT_UNLOCK (sink);
1086 if (delay != old_render_delay) {
1087 GST_DEBUG_OBJECT (sink, "posting latency changed");
1088 gst_element_post_message (GST_ELEMENT_CAST (sink),
1089 gst_message_new_latency (GST_OBJECT_CAST (sink)));
1094 * gst_base_sink_get_render_delay:
1095 * @sink: a #GstBaseSink
1097 * Get the render delay of @sink. see gst_base_sink_set_render_delay() for more
1098 * information about the render delay.
1100 * Returns: the render delay of @sink.
1105 gst_base_sink_get_render_delay (GstBaseSink * sink)
1107 GstClockTimeDiff res;
1109 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1111 GST_OBJECT_LOCK (sink);
1112 res = sink->priv->render_delay;
1113 GST_OBJECT_UNLOCK (sink);
1119 * gst_base_sink_set_blocksize:
1120 * @sink: a #GstBaseSink
1121 * @blocksize: the blocksize in bytes
1123 * Set the number of bytes that the sink will pull when it is operating in pull
1129 gst_base_sink_set_blocksize (GstBaseSink * sink, guint blocksize)
1131 g_return_if_fail (GST_IS_BASE_SINK (sink));
1133 GST_OBJECT_LOCK (sink);
1134 sink->priv->blocksize = blocksize;
1135 GST_LOG_OBJECT (sink, "set blocksize to %u", blocksize);
1136 GST_OBJECT_UNLOCK (sink);
1140 * gst_base_sink_get_blocksize:
1141 * @sink: a #GstBaseSink
1143 * Get the number of bytes that the sink will pull when it is operating in pull
1146 * Returns: the number of bytes @sink will pull in pull mode.
1151 gst_base_sink_get_blocksize (GstBaseSink * sink)
1155 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1157 GST_OBJECT_LOCK (sink);
1158 res = sink->priv->blocksize;
1159 GST_OBJECT_UNLOCK (sink);
1165 gst_base_sink_set_property (GObject * object, guint prop_id,
1166 const GValue * value, GParamSpec * pspec)
1168 GstBaseSink *sink = GST_BASE_SINK (object);
1171 case PROP_PREROLL_QUEUE_LEN:
1172 /* preroll lock necessary to serialize with finish_preroll */
1173 GST_PAD_PREROLL_LOCK (sink->sinkpad);
1174 sink->preroll_queue_max_len = g_value_get_uint (value);
1175 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
1178 gst_base_sink_set_sync (sink, g_value_get_boolean (value));
1180 case PROP_MAX_LATENESS:
1181 gst_base_sink_set_max_lateness (sink, g_value_get_int64 (value));
1184 gst_base_sink_set_qos_enabled (sink, g_value_get_boolean (value));
1187 gst_base_sink_set_async_enabled (sink, g_value_get_boolean (value));
1189 case PROP_TS_OFFSET:
1190 gst_base_sink_set_ts_offset (sink, g_value_get_int64 (value));
1192 case PROP_BLOCKSIZE:
1193 gst_base_sink_set_blocksize (sink, g_value_get_uint (value));
1195 case PROP_RENDER_DELAY:
1196 gst_base_sink_set_render_delay (sink, g_value_get_uint64 (value));
1199 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1205 gst_base_sink_get_property (GObject * object, guint prop_id, GValue * value,
1208 GstBaseSink *sink = GST_BASE_SINK (object);
1211 case PROP_PREROLL_QUEUE_LEN:
1212 GST_PAD_PREROLL_LOCK (sink->sinkpad);
1213 g_value_set_uint (value, sink->preroll_queue_max_len);
1214 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
1217 g_value_set_boolean (value, gst_base_sink_get_sync (sink));
1219 case PROP_MAX_LATENESS:
1220 g_value_set_int64 (value, gst_base_sink_get_max_lateness (sink));
1223 g_value_set_boolean (value, gst_base_sink_is_qos_enabled (sink));
1226 g_value_set_boolean (value, gst_base_sink_is_async_enabled (sink));
1228 case PROP_TS_OFFSET:
1229 g_value_set_int64 (value, gst_base_sink_get_ts_offset (sink));
1231 case PROP_LAST_BUFFER:
1232 gst_value_take_buffer (value, gst_base_sink_get_last_buffer (sink));
1234 case PROP_BLOCKSIZE:
1235 g_value_set_uint (value, gst_base_sink_get_blocksize (sink));
1237 case PROP_RENDER_DELAY:
1238 g_value_set_uint64 (value, gst_base_sink_get_render_delay (sink));
1241 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1248 gst_base_sink_get_caps (GstBaseSink * sink)
1254 gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps)
1259 static GstFlowReturn
1260 gst_base_sink_buffer_alloc (GstBaseSink * sink, guint64 offset, guint size,
1261 GstCaps * caps, GstBuffer ** buf)
1267 /* with PREROLL_LOCK, STREAM_LOCK */
1269 gst_base_sink_preroll_queue_flush (GstBaseSink * basesink, GstPad * pad)
1273 GST_DEBUG_OBJECT (basesink, "flushing queue %p", basesink);
1274 while ((obj = g_queue_pop_head (basesink->preroll_queue))) {
1275 GST_DEBUG_OBJECT (basesink, "popped %p", obj);
1276 gst_mini_object_unref (obj);
1278 /* we can't have EOS anymore now */
1279 basesink->eos = FALSE;
1280 basesink->priv->received_eos = FALSE;
1281 basesink->have_preroll = FALSE;
1282 basesink->priv->step_unlock = FALSE;
1283 basesink->eos_queued = FALSE;
1284 basesink->preroll_queued = 0;
1285 basesink->buffers_queued = 0;
1286 basesink->events_queued = 0;
1287 /* can't report latency anymore until we preroll again */
1288 if (basesink->priv->async_enabled) {
1289 GST_OBJECT_LOCK (basesink);
1290 basesink->priv->have_latency = FALSE;
1291 GST_OBJECT_UNLOCK (basesink);
1293 /* and signal any waiters now */
1294 GST_PAD_PREROLL_SIGNAL (pad);
1297 /* with STREAM_LOCK, configures given segment with the event information. */
1299 gst_base_sink_configure_segment (GstBaseSink * basesink, GstPad * pad,
1300 GstEvent * event, GstSegment * segment)
1303 gdouble rate, arate;
1309 /* the newsegment event is needed to bring the buffer timestamps to the
1310 * stream time and to drop samples outside of the playback segment. */
1311 gst_event_parse_new_segment_full (event, &update, &rate, &arate, &format,
1312 &start, &stop, &time);
1314 /* The segment is protected with both the STREAM_LOCK and the OBJECT_LOCK.
1315 * We protect with the OBJECT_LOCK so that we can use the values to
1316 * safely answer a POSITION query. */
1317 GST_OBJECT_LOCK (basesink);
1318 gst_segment_set_newsegment_full (segment, update, rate, arate, format, start,
1321 if (format == GST_FORMAT_TIME) {
1322 GST_DEBUG_OBJECT (basesink,
1323 "configured NEWSEGMENT update %d, rate %lf, applied rate %lf, "
1324 "format GST_FORMAT_TIME, "
1325 "%" GST_TIME_FORMAT " -- %" GST_TIME_FORMAT
1326 ", time %" GST_TIME_FORMAT ", accum %" GST_TIME_FORMAT,
1327 update, rate, arate, GST_TIME_ARGS (segment->start),
1328 GST_TIME_ARGS (segment->stop), GST_TIME_ARGS (segment->time),
1329 GST_TIME_ARGS (segment->accum));
1331 GST_DEBUG_OBJECT (basesink,
1332 "configured NEWSEGMENT update %d, rate %lf, applied rate %lf, "
1334 "%" G_GINT64_FORMAT " -- %" G_GINT64_FORMAT ", time %"
1335 G_GINT64_FORMAT ", accum %" G_GINT64_FORMAT, update, rate, arate,
1336 segment->format, segment->start, segment->stop, segment->time,
1339 GST_OBJECT_UNLOCK (basesink);
1342 /* with PREROLL_LOCK, STREAM_LOCK */
1344 gst_base_sink_commit_state (GstBaseSink * basesink)
1346 /* commit state and proceed to next pending state */
1347 GstState current, next, pending, post_pending;
1348 gboolean post_paused = FALSE;
1349 gboolean post_async_done = FALSE;
1350 gboolean post_playing = FALSE;
1352 /* we are certainly not playing async anymore now */
1353 basesink->playing_async = FALSE;
1355 GST_OBJECT_LOCK (basesink);
1356 current = GST_STATE (basesink);
1357 next = GST_STATE_NEXT (basesink);
1358 pending = GST_STATE_PENDING (basesink);
1359 post_pending = pending;
1362 case GST_STATE_PLAYING:
1364 GstBaseSinkClass *bclass;
1365 GstStateChangeReturn ret;
1367 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1369 GST_DEBUG_OBJECT (basesink, "commiting state to PLAYING");
1371 basesink->need_preroll = FALSE;
1372 post_async_done = TRUE;
1373 basesink->priv->commited = TRUE;
1374 post_playing = TRUE;
1375 /* post PAUSED too when we were READY */
1376 if (current == GST_STATE_READY) {
1380 /* make sure we notify the subclass of async playing */
1381 if (bclass->async_play) {
1382 GST_WARNING_OBJECT (basesink, "deprecated async_play");
1383 ret = bclass->async_play (basesink);
1384 if (ret == GST_STATE_CHANGE_FAILURE)
1389 case GST_STATE_PAUSED:
1390 GST_DEBUG_OBJECT (basesink, "commiting state to PAUSED");
1392 post_async_done = TRUE;
1393 basesink->priv->commited = TRUE;
1394 post_pending = GST_STATE_VOID_PENDING;
1396 case GST_STATE_READY:
1397 case GST_STATE_NULL:
1399 case GST_STATE_VOID_PENDING:
1400 goto nothing_pending;
1405 /* we can report latency queries now */
1406 basesink->priv->have_latency = TRUE;
1408 GST_STATE (basesink) = pending;
1409 GST_STATE_NEXT (basesink) = GST_STATE_VOID_PENDING;
1410 GST_STATE_PENDING (basesink) = GST_STATE_VOID_PENDING;
1411 GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_SUCCESS;
1412 GST_OBJECT_UNLOCK (basesink);
1415 GST_DEBUG_OBJECT (basesink, "posting PAUSED state change message");
1416 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1417 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1418 current, next, post_pending));
1420 if (post_async_done) {
1421 GST_DEBUG_OBJECT (basesink, "posting async-done message");
1422 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1423 gst_message_new_async_done (GST_OBJECT_CAST (basesink)));
1426 GST_DEBUG_OBJECT (basesink, "posting PLAYING state change message");
1427 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1428 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1429 next, pending, GST_STATE_VOID_PENDING));
1432 GST_STATE_BROADCAST (basesink);
1438 /* Depending on the state, set our vars. We get in this situation when the
1439 * state change function got a change to update the state vars before the
1440 * streaming thread did. This is fine but we need to make sure that we
1441 * update the need_preroll var since it was TRUE when we got here and might
1442 * become FALSE if we got to PLAYING. */
1443 GST_DEBUG_OBJECT (basesink, "nothing to commit, now in %s",
1444 gst_element_state_get_name (current));
1446 case GST_STATE_PLAYING:
1447 basesink->need_preroll = FALSE;
1449 case GST_STATE_PAUSED:
1450 basesink->need_preroll = TRUE;
1453 basesink->need_preroll = FALSE;
1454 basesink->flushing = TRUE;
1457 /* we can report latency queries now */
1458 basesink->priv->have_latency = TRUE;
1459 GST_OBJECT_UNLOCK (basesink);
1464 /* app is going to READY */
1465 GST_DEBUG_OBJECT (basesink, "stopping");
1466 basesink->need_preroll = FALSE;
1467 basesink->flushing = TRUE;
1468 GST_OBJECT_UNLOCK (basesink);
1473 GST_DEBUG_OBJECT (basesink, "async commit failed");
1474 GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_FAILURE;
1475 GST_OBJECT_UNLOCK (basesink);
1481 start_stepping (GstBaseSink * sink, GstSegment * segment,
1482 GstStepInfo * pending, GstStepInfo * current)
1484 GST_DEBUG_OBJECT (sink, "update pending step");
1485 memcpy (current, pending, sizeof (GstStepInfo));
1486 pending->valid = FALSE;
1488 /* get the running time of where we paused and remember it */
1489 current->start = gst_element_get_start_time (GST_ELEMENT_CAST (sink));
1491 /* set the new rate */
1492 segment->rate = segment->rate * current->rate;
1494 GST_DEBUG_OBJECT (sink, "step started at running_time %" GST_TIME_FORMAT,
1495 GST_TIME_ARGS (current->start));
1497 if (current->amount == -1) {
1498 GST_DEBUG_OBJECT (sink, "step amount == -1, stop stepping");
1499 current->valid = FALSE;
1501 GST_DEBUG_OBJECT (sink, "step amount: %" G_GUINT64_FORMAT ", format: %s, "
1502 "rate: %f", current->amount, gst_format_get_name (current->format),
1508 stop_stepping (GstBaseSink * sink, GstSegment * segment,
1509 GstStepInfo * current, guint64 cstart, guint64 cstop, gint64 * rstart,
1512 GstMessage *message;
1514 GST_DEBUG_OBJECT (sink, "step complete");
1516 /* update the segment, discarding what was consumed, running time goes
1517 * backwards with the duration of the data we skipped. FIXME, this only works
1519 if (segment->rate > 0.0) {
1520 GST_DEBUG_OBJECT (sink,
1521 "step stop at running_time %" GST_TIME_FORMAT ", timestamp %"
1522 GST_TIME_FORMAT, GST_TIME_ARGS (*rstart), GST_TIME_ARGS (cstart));
1524 *rstart = current->start + current->position;
1526 current->duration = *rstart - current->start;
1529 gst_segment_to_stream_time (segment, segment->format, cstart);
1530 segment->start = cstart;
1532 *rstart = current->start;
1534 *rstop -= current->duration;
1536 GST_DEBUG_OBJECT (sink,
1537 "step stop at running_time %" GST_TIME_FORMAT ", timestamp %"
1538 GST_TIME_FORMAT, GST_TIME_ARGS (*rstop), GST_TIME_ARGS (cstop));
1540 *rstop = current->start + current->position;
1542 current->duration = *rstop - current->start;
1544 segment->stop = cstop;
1545 *rstop = current->start;
1547 *rstart -= current->duration;
1549 segment->accum = current->start;
1551 GST_DEBUG_OBJECT (sink, "step elapsed running_time %" GST_TIME_FORMAT,
1552 GST_TIME_ARGS (current->duration));
1554 /* the clip segment is used for position report in paused... */
1555 memcpy (sink->abidata.ABI.clip_segment, segment, sizeof (GstSegment));
1558 gst_message_new_step_done (GST_OBJECT_CAST (sink), current->format,
1559 current->amount, current->rate, current->flush, current->intermediate,
1561 gst_message_set_seqnum (message, current->seqnum);
1562 gst_element_post_message (GST_ELEMENT_CAST (sink), message);
1564 if (!current->intermediate)
1565 sink->need_preroll = current->need_preroll;
1567 /* and the current step info finished and becomes invalid */
1568 current->valid = FALSE;
1572 handle_stepping (GstBaseSink * sink, GstSegment * segment,
1573 GstStepInfo * current, gint64 * cstart, gint64 * cstop, gint64 * rstart,
1576 GstBaseSinkPrivate *priv;
1577 gboolean step_end = FALSE;
1581 /* see if we need to skip this buffer because of stepping */
1582 switch (current->format) {
1583 case GST_FORMAT_TIME:
1588 if (segment->rate > 0.0) {
1596 end = current->start + current->amount;
1597 current->position = first - current->start;
1599 GST_DEBUG_OBJECT (sink,
1600 "buffer: %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT,
1601 GST_TIME_ARGS (first), GST_TIME_ARGS (last));
1602 GST_DEBUG_OBJECT (sink,
1603 "got time step %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT "/%"
1604 GST_TIME_FORMAT, GST_TIME_ARGS (current->position),
1605 GST_TIME_ARGS (last - current->start),
1606 GST_TIME_ARGS (current->amount));
1608 if (current->position >= current->amount || last >= end) {
1609 GST_DEBUG_OBJECT (sink, "step ended, we need clipping");
1611 if (segment->rate > 0.0) {
1612 *cstart += end - *rstart;
1615 *cstop += *rstop - end;
1619 GST_DEBUG_OBJECT (sink,
1620 "cstart %" GST_TIME_FORMAT ", rstart %" GST_TIME_FORMAT,
1621 GST_TIME_ARGS (*cstart), GST_TIME_ARGS (*rstart));
1622 GST_DEBUG_OBJECT (sink,
1623 "cstop %" GST_TIME_FORMAT ", rstop %" GST_TIME_FORMAT,
1624 GST_TIME_ARGS (*cstop), GST_TIME_ARGS (*rstop));
1627 case GST_FORMAT_BUFFERS:
1628 GST_DEBUG_OBJECT (sink,
1629 "got default step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1630 current->position, current->amount);
1632 if (current->position < current->amount) {
1633 current->position++;
1638 case GST_FORMAT_DEFAULT:
1640 GST_DEBUG_OBJECT (sink,
1641 "got unknown step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1642 current->position, current->amount);
1648 /* with STREAM_LOCK, PREROLL_LOCK
1650 * Returns TRUE if the object needs synchronisation and takes therefore
1651 * part in prerolling.
1653 * rsstart/rsstop contain the start/stop in stream time.
1654 * rrstart/rrstop contain the start/stop in running time.
1657 gst_base_sink_get_sync_times (GstBaseSink * basesink, GstMiniObject * obj,
1658 GstClockTime * rsstart, GstClockTime * rsstop,
1659 GstClockTime * rrstart, GstClockTime * rrstop, gboolean * do_sync,
1660 gboolean * stepped, GstSegment * segment, GstStepInfo * step)
1662 GstBaseSinkClass *bclass;
1664 GstClockTime start, stop; /* raw start/stop timestamps */
1665 gint64 cstart, cstop; /* clipped raw timestamps */
1666 gint64 rstart, rstop; /* clipped timestamps converted to running time */
1667 GstClockTime sstart, sstop; /* clipped timestamps converted to stream time */
1669 GstBaseSinkPrivate *priv;
1672 priv = basesink->priv;
1674 /* start with nothing */
1679 if (G_UNLIKELY (GST_IS_EVENT (obj))) {
1680 GstEvent *event = GST_EVENT_CAST (obj);
1682 switch (GST_EVENT_TYPE (event)) {
1683 /* EOS event needs syncing */
1686 if (basesink->segment.rate >= 0.0) {
1687 sstart = sstop = priv->current_sstop;
1689 /* we have not seen a buffer yet, use the segment values */
1690 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1691 basesink->segment.format, basesink->segment.stop);
1694 sstart = sstop = priv->current_sstart;
1696 /* we have not seen a buffer yet, use the segment values */
1697 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1698 basesink->segment.format, basesink->segment.start);
1702 rstart = rstop = priv->eos_rtime;
1703 *do_sync = rstart != -1;
1704 GST_DEBUG_OBJECT (basesink, "sync times for EOS %" GST_TIME_FORMAT,
1705 GST_TIME_ARGS (rstart));
1706 /* if we are stepping, we end now */
1707 step_end = step->valid;
1711 /* other events do not need syncing */
1712 /* FIXME, maybe NEWSEGMENT might need synchronisation
1713 * since the POSITION query depends on accumulated times and
1714 * we cannot accumulate the current segment before the previous
1721 /* else do buffer sync code */
1722 buffer = GST_BUFFER_CAST (obj);
1724 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1726 /* just get the times to see if we need syncing, if the start returns -1 we
1728 if (bclass->get_times)
1729 bclass->get_times (basesink, buffer, &start, &stop);
1732 /* we don't need to sync but we still want to get the timestamps for
1733 * tracking the position */
1734 gst_base_sink_get_times (basesink, buffer, &start, &stop);
1740 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
1741 ", stop: %" GST_TIME_FORMAT ", do_sync %d", GST_TIME_ARGS (start),
1742 GST_TIME_ARGS (stop), *do_sync);
1744 /* collect segment and format for code clarity */
1745 format = segment->format;
1747 /* no timestamp clipping if we did not get a TIME segment format */
1748 if (G_UNLIKELY (format != GST_FORMAT_TIME)) {
1751 /* do running and stream time in TIME format */
1752 format = GST_FORMAT_TIME;
1753 GST_LOG_OBJECT (basesink, "not time format, don't clip");
1757 /* clip, only when we know about time */
1758 if (G_UNLIKELY (!gst_segment_clip (segment, GST_FORMAT_TIME,
1759 (gint64) start, (gint64) stop, &cstart, &cstop)))
1760 goto out_of_segment;
1762 if (G_UNLIKELY (start != cstart || stop != cstop)) {
1763 GST_DEBUG_OBJECT (basesink, "clipped to: start %" GST_TIME_FORMAT
1764 ", stop: %" GST_TIME_FORMAT, GST_TIME_ARGS (cstart),
1765 GST_TIME_ARGS (cstop));
1768 /* set last stop position */
1769 if (G_LIKELY (cstop != GST_CLOCK_TIME_NONE))
1770 gst_segment_set_last_stop (segment, GST_FORMAT_TIME, cstop);
1772 gst_segment_set_last_stop (segment, GST_FORMAT_TIME, cstart);
1775 rstart = gst_segment_to_running_time (segment, format, cstart);
1776 rstop = gst_segment_to_running_time (segment, format, cstop);
1778 if (G_UNLIKELY (step->valid)) {
1779 if (!(step_end = handle_stepping (basesink, segment, step, &cstart, &cstop,
1783 /* this can produce wrong values if we accumulated non-TIME segments. If this happens,
1784 * upstream is behaving very badly */
1785 sstart = gst_segment_to_stream_time (segment, format, cstart);
1786 sstop = gst_segment_to_stream_time (segment, format, cstop);
1789 /* done label only called when doing EOS, we also stop stepping then */
1791 stop_stepping (basesink, segment, step, cstart, cstop, &rstart, &rstop);
1799 /* buffers and EOS always need syncing and preroll */
1805 /* we usually clip in the chain function already but stepping could cause
1806 * the segment to be updated later. we return FALSE so that we don't try
1808 GST_LOG_OBJECT (basesink, "buffer skipped, not in segment");
1813 /* with STREAM_LOCK, PREROLL_LOCK, LOCK
1814 * adjust a timestamp with the latency and timestamp offset */
1816 gst_base_sink_adjust_time (GstBaseSink * basesink, GstClockTime time)
1818 GstClockTimeDiff ts_offset;
1820 /* don't do anything funny with invalid timestamps */
1821 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
1824 time += basesink->priv->latency;
1826 /* apply offset, be carefull for underflows */
1827 ts_offset = basesink->priv->ts_offset;
1828 if (ts_offset < 0) {
1829 ts_offset = -ts_offset;
1830 if (ts_offset < time)
1841 * gst_base_sink_wait_clock:
1843 * @time: the running_time to be reached
1844 * @jitter: the jitter to be filled with time diff (can be NULL)
1846 * This function will block until @time is reached. It is usually called by
1847 * subclasses that use their own internal synchronisation.
1849 * If @time is not valid, no sycnhronisation is done and #GST_CLOCK_BADTIME is
1850 * returned. Likewise, if synchronisation is disabled in the element or there
1851 * is no clock, no synchronisation is done and #GST_CLOCK_BADTIME is returned.
1853 * This function should only be called with the PREROLL_LOCK held, like when
1854 * receiving an EOS event in the ::event vmethod or when receiving a buffer in
1855 * the ::render vmethod.
1857 * The @time argument should be the running_time of when this method should
1858 * return and is not adjusted with any latency or offset configured in the
1863 * Returns: #GstClockReturn
1866 gst_base_sink_wait_clock (GstBaseSink * sink, GstClockTime time,
1867 GstClockTimeDiff * jitter)
1873 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
1876 GST_OBJECT_LOCK (sink);
1877 if (G_UNLIKELY (!sink->sync))
1880 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (sink)) == NULL))
1883 /* add base_time to running_time to get the time against the clock */
1884 time += GST_ELEMENT_CAST (sink)->base_time;
1886 id = gst_clock_new_single_shot_id (clock, time);
1887 GST_OBJECT_UNLOCK (sink);
1889 /* A blocking wait is performed on the clock. We save the ClockID
1890 * so we can unlock the entry at any time. While we are blocking, we
1891 * release the PREROLL_LOCK so that other threads can interrupt the
1893 sink->clock_id = id;
1894 /* release the preroll lock while waiting */
1895 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
1897 ret = gst_clock_id_wait (id, jitter);
1899 GST_PAD_PREROLL_LOCK (sink->sinkpad);
1900 gst_clock_id_unref (id);
1901 sink->clock_id = NULL;
1905 /* no syncing needed */
1908 GST_DEBUG_OBJECT (sink, "time not valid, no sync needed");
1909 return GST_CLOCK_BADTIME;
1913 GST_DEBUG_OBJECT (sink, "sync disabled");
1914 GST_OBJECT_UNLOCK (sink);
1915 return GST_CLOCK_BADTIME;
1919 GST_DEBUG_OBJECT (sink, "no clock, can't sync");
1920 GST_OBJECT_UNLOCK (sink);
1921 return GST_CLOCK_BADTIME;
1926 * gst_base_sink_wait_preroll:
1929 * If the #GstBaseSinkClass::render method performs its own synchronisation against
1930 * the clock it must unblock when going from PLAYING to the PAUSED state and call
1931 * this method before continuing to render the remaining data.
1933 * This function will block until a state change to PLAYING happens (in which
1934 * case this function returns #GST_FLOW_OK) or the processing must be stopped due
1935 * to a state change to READY or a FLUSH event (in which case this function
1936 * returns #GST_FLOW_WRONG_STATE).
1938 * This function should only be called with the PREROLL_LOCK held, like in the
1943 * Returns: #GST_FLOW_OK if the preroll completed and processing can
1944 * continue. Any other return value should be returned from the render vmethod.
1947 gst_base_sink_wait_preroll (GstBaseSink * sink)
1949 sink->have_preroll = TRUE;
1950 GST_DEBUG_OBJECT (sink, "waiting in preroll for flush or PLAYING");
1951 /* block until the state changes, or we get a flush, or something */
1952 GST_PAD_PREROLL_WAIT (sink->sinkpad);
1953 sink->have_preroll = FALSE;
1954 if (G_UNLIKELY (sink->flushing))
1956 if (G_UNLIKELY (sink->priv->step_unlock))
1958 GST_DEBUG_OBJECT (sink, "continue after preroll");
1965 GST_DEBUG_OBJECT (sink, "preroll interrupted because of flush");
1966 return GST_FLOW_WRONG_STATE;
1970 sink->priv->step_unlock = FALSE;
1971 GST_DEBUG_OBJECT (sink, "preroll interrupted because of step");
1972 return GST_FLOW_STEP;
1977 * gst_base_sink_do_preroll:
1979 * @obj: the object that caused the preroll
1981 * If the @sink spawns its own thread for pulling buffers from upstream it
1982 * should call this method after it has pulled a buffer. If the element needed
1983 * to preroll, this function will perform the preroll and will then block
1984 * until the element state is changed.
1986 * This function should be called with the PREROLL_LOCK held.
1990 * Returns: #GST_FLOW_OK if the preroll completed and processing can
1991 * continue. Any other return value should be returned from the render vmethod.
1994 gst_base_sink_do_preroll (GstBaseSink * sink, GstMiniObject * obj)
1998 while (G_UNLIKELY (sink->need_preroll)) {
1999 GST_DEBUG_OBJECT (sink, "prerolling object %p", obj);
2001 ret = gst_base_sink_preroll_object (sink, obj);
2002 if (ret != GST_FLOW_OK)
2003 goto preroll_failed;
2005 /* need to recheck here because the commit state could have
2006 * made us not need the preroll anymore */
2007 if (G_LIKELY (sink->need_preroll)) {
2008 /* block until the state changes, or we get a flush, or something */
2009 ret = gst_base_sink_wait_preroll (sink);
2010 if (ret != GST_FLOW_OK) {
2011 if (ret == GST_FLOW_STEP)
2014 goto preroll_failed;
2023 GST_DEBUG_OBJECT (sink, "preroll failed %d", ret);
2029 * gst_base_sink_wait_eos:
2031 * @time: the running_time to be reached
2032 * @jitter: the jitter to be filled with time diff (can be NULL)
2034 * This function will block until @time is reached. It is usually called by
2035 * subclasses that use their own internal synchronisation but want to let the
2036 * EOS be handled by the base class.
2038 * This function should only be called with the PREROLL_LOCK held, like when
2039 * receiving an EOS event in the ::event vmethod.
2041 * The @time argument should be the running_time of when the EOS should happen
2042 * and will be adjusted with any latency and offset configured in the sink.
2046 * Returns: #GstFlowReturn
2049 gst_base_sink_wait_eos (GstBaseSink * sink, GstClockTime time,
2050 GstClockTimeDiff * jitter)
2052 GstClockReturn status;
2058 GST_DEBUG_OBJECT (sink, "checking preroll");
2060 /* first wait for the playing state before we can continue */
2061 if (G_UNLIKELY (sink->need_preroll)) {
2062 ret = gst_base_sink_wait_preroll (sink);
2063 if (ret != GST_FLOW_OK) {
2064 if (ret == GST_FLOW_STEP)
2071 /* preroll done, we can sync since we are in PLAYING now. */
2072 GST_DEBUG_OBJECT (sink, "possibly waiting for clock to reach %"
2073 GST_TIME_FORMAT, GST_TIME_ARGS (time));
2075 /* compensate for latency and ts_offset. We don't adjust for render delay
2076 * because we don't interact with the device on EOS normally. */
2077 stime = gst_base_sink_adjust_time (sink, time);
2079 /* wait for the clock, this can be interrupted because we got shut down or
2081 status = gst_base_sink_wait_clock (sink, stime, jitter);
2083 GST_DEBUG_OBJECT (sink, "clock returned %d", status);
2085 /* invalid time, no clock or sync disabled, just continue then */
2086 if (status == GST_CLOCK_BADTIME)
2089 /* waiting could have been interrupted and we can be flushing now */
2090 if (G_UNLIKELY (sink->flushing))
2093 /* retry if we got unscheduled, which means we did not reach the timeout
2094 * yet. if some other error occures, we continue. */
2095 } while (status == GST_CLOCK_UNSCHEDULED);
2097 GST_DEBUG_OBJECT (sink, "end of stream");
2104 GST_DEBUG_OBJECT (sink, "we are flushing");
2105 return GST_FLOW_WRONG_STATE;
2109 /* with STREAM_LOCK, PREROLL_LOCK
2111 * Make sure we are in PLAYING and synchronize an object to the clock.
2113 * If we need preroll, we are not in PLAYING. We try to commit the state
2114 * if needed and then block if we still are not PLAYING.
2116 * We start waiting on the clock in PLAYING. If we got interrupted, we
2117 * immediatly try to re-preroll.
2119 * Some objects do not need synchronisation (most events) and so this function
2120 * immediatly returns GST_FLOW_OK.
2122 * for objects that arrive later than max-lateness to be synchronized to the
2123 * clock have the @late boolean set to TRUE.
2125 * This function keeps a running average of the jitter (the diff between the
2126 * clock time and the requested sync time). The jitter is negative for
2127 * objects that arrive in time and positive for late buffers.
2129 * does not take ownership of obj.
2131 static GstFlowReturn
2132 gst_base_sink_do_sync (GstBaseSink * basesink, GstPad * pad,
2133 GstMiniObject * obj, gboolean * late)
2135 GstClockTimeDiff jitter;
2137 GstClockReturn status = GST_CLOCK_OK;
2138 GstClockTime rstart, rstop, sstart, sstop, stime;
2140 GstBaseSinkPrivate *priv;
2142 GstStepInfo *current, *pending;
2145 priv = basesink->priv;
2148 sstart = sstop = rstart = rstop = -1;
2152 priv->current_rstart = -1;
2154 /* get stepping info */
2155 current = &priv->current_step;
2156 pending = &priv->pending_step;
2158 /* get timing information for this object against the render segment */
2159 syncable = gst_base_sink_get_sync_times (basesink, obj,
2160 &sstart, &sstop, &rstart, &rstop, &do_sync, &stepped, &basesink->segment,
2163 if (G_UNLIKELY (stepped))
2166 /* a syncable object needs to participate in preroll and
2167 * clocking. All buffers and EOS are syncable. */
2168 if (G_UNLIKELY (!syncable))
2171 /* store timing info for current object */
2172 priv->current_rstart = rstart;
2173 priv->current_rstop = (rstop != -1 ? rstop : rstart);
2175 /* save sync time for eos when the previous object needed sync */
2176 priv->eos_rtime = (do_sync ? priv->current_rstop : -1);
2179 /* first do preroll, this makes sure we commit our state
2180 * to PAUSED and can continue to PLAYING. We cannot perform
2181 * any clock sync in PAUSED because there is no clock. */
2182 ret = gst_base_sink_do_preroll (basesink, obj);
2183 if (G_UNLIKELY (ret != GST_FLOW_OK))
2184 goto preroll_failed;
2186 /* After rendering we store the position of the last buffer so that we can use
2187 * it to report the position. We need to take the lock here. */
2188 GST_OBJECT_LOCK (basesink);
2189 priv->current_sstart = sstart;
2190 priv->current_sstop = (sstop != -1 ? sstop : sstart);
2191 GST_OBJECT_UNLOCK (basesink);
2193 /* update the segment with a pending step if the current one is invalid and we
2194 * have a new pending one. We only accept new step updates after a preroll */
2195 if (G_UNLIKELY (pending->valid && !current->valid)) {
2196 start_stepping (basesink, &basesink->segment, pending, current);
2203 /* adjust for latency */
2204 stime = gst_base_sink_adjust_time (basesink, rstart);
2206 /* adjust for render-delay, avoid underflows */
2208 if (stime > priv->render_delay)
2209 stime -= priv->render_delay;
2214 /* preroll done, we can sync since we are in PLAYING now. */
2215 GST_DEBUG_OBJECT (basesink, "possibly waiting for clock to reach %"
2216 GST_TIME_FORMAT ", adjusted %" GST_TIME_FORMAT,
2217 GST_TIME_ARGS (rstart), GST_TIME_ARGS (stime));
2219 /* This function will return immediatly if start == -1, no clock
2220 * or sync is disabled with GST_CLOCK_BADTIME. */
2221 status = gst_base_sink_wait_clock (basesink, stime, &jitter);
2223 GST_DEBUG_OBJECT (basesink, "clock returned %d", status);
2225 /* invalid time, no clock or sync disabled, just render */
2226 if (status == GST_CLOCK_BADTIME)
2229 /* waiting could have been interrupted and we can be flushing now */
2230 if (G_UNLIKELY (basesink->flushing))
2233 /* check for unlocked by a state change, we are not flushing so
2234 * we can try to preroll on the current buffer. */
2235 if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED)) {
2236 GST_DEBUG_OBJECT (basesink, "unscheduled, waiting some more");
2237 priv->call_preroll = TRUE;
2241 /* successful syncing done, record observation */
2242 priv->current_jitter = jitter;
2244 /* check if the object should be dropped */
2245 *late = gst_base_sink_is_too_late (basesink, obj, rstart, rstop,
2254 GST_DEBUG_OBJECT (basesink, "skipped stepped object %p", obj);
2260 GST_DEBUG_OBJECT (basesink, "non syncable object %p", obj);
2265 GST_DEBUG_OBJECT (basesink, "we are flushing");
2266 return GST_FLOW_WRONG_STATE;
2270 GST_DEBUG_OBJECT (basesink, "preroll failed");
2276 gst_base_sink_send_qos (GstBaseSink * basesink,
2277 gdouble proportion, GstClockTime time, GstClockTimeDiff diff)
2282 /* generate Quality-of-Service event */
2283 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2284 "qos: proportion: %lf, diff %" G_GINT64_FORMAT ", timestamp %"
2285 GST_TIME_FORMAT, proportion, diff, GST_TIME_ARGS (time));
2287 event = gst_event_new_qos (proportion, diff, time);
2290 res = gst_pad_push_event (basesink->sinkpad, event);
2296 gst_base_sink_perform_qos (GstBaseSink * sink, gboolean dropped)
2298 GstBaseSinkPrivate *priv;
2299 GstClockTime start, stop;
2300 GstClockTimeDiff jitter;
2301 GstClockTime pt, entered, left;
2302 GstClockTime duration;
2307 start = priv->current_rstart;
2309 /* if Quality-of-Service disabled, do nothing */
2310 if (!g_atomic_int_get (&priv->qos_enabled) || start == -1)
2313 stop = priv->current_rstop;
2314 jitter = priv->current_jitter;
2317 /* this is the time the buffer entered the sink */
2318 if (start < -jitter)
2321 entered = start + jitter;
2324 /* this is the time the buffer entered the sink */
2325 entered = start + jitter;
2326 /* this is the time the buffer left the sink */
2327 left = start + jitter;
2330 /* calculate duration of the buffer */
2332 duration = stop - start;
2336 /* if we have the time when the last buffer left us, calculate
2337 * processing time */
2338 if (priv->last_left != -1) {
2339 if (entered > priv->last_left) {
2340 pt = entered - priv->last_left;
2348 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "start: %" GST_TIME_FORMAT
2349 ", entered %" GST_TIME_FORMAT ", left %" GST_TIME_FORMAT ", pt: %"
2350 GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT ",jitter %"
2351 G_GINT64_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (entered),
2352 GST_TIME_ARGS (left), GST_TIME_ARGS (pt), GST_TIME_ARGS (duration),
2355 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "avg_duration: %" GST_TIME_FORMAT
2356 ", avg_pt: %" GST_TIME_FORMAT ", avg_rate: %g",
2357 GST_TIME_ARGS (priv->avg_duration), GST_TIME_ARGS (priv->avg_pt),
2360 /* collect running averages. for first observations, we copy the
2362 if (priv->avg_duration == -1)
2363 priv->avg_duration = duration;
2365 priv->avg_duration = UPDATE_RUNNING_AVG (priv->avg_duration, duration);
2367 if (priv->avg_pt == -1)
2370 priv->avg_pt = UPDATE_RUNNING_AVG (priv->avg_pt, pt);
2372 if (priv->avg_duration != 0)
2374 gst_guint64_to_gdouble (priv->avg_pt) /
2375 gst_guint64_to_gdouble (priv->avg_duration);
2379 if (priv->last_left != -1) {
2380 if (dropped || priv->avg_rate < 0.0) {
2381 priv->avg_rate = rate;
2384 priv->avg_rate = UPDATE_RUNNING_AVG_N (priv->avg_rate, rate);
2386 priv->avg_rate = UPDATE_RUNNING_AVG_P (priv->avg_rate, rate);
2390 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink,
2391 "updated: avg_duration: %" GST_TIME_FORMAT ", avg_pt: %" GST_TIME_FORMAT
2392 ", avg_rate: %g", GST_TIME_ARGS (priv->avg_duration),
2393 GST_TIME_ARGS (priv->avg_pt), priv->avg_rate);
2396 if (priv->avg_rate >= 0.0) {
2397 /* if we have a valid rate, start sending QoS messages */
2398 if (priv->current_jitter < 0) {
2399 /* make sure we never go below 0 when adding the jitter to the
2401 if (priv->current_rstart < -priv->current_jitter)
2402 priv->current_jitter = -priv->current_rstart;
2404 gst_base_sink_send_qos (sink, priv->avg_rate, priv->current_rstart,
2405 priv->current_jitter);
2408 /* record when this buffer will leave us */
2409 priv->last_left = left;
2412 /* reset all qos measuring */
2414 gst_base_sink_reset_qos (GstBaseSink * sink)
2416 GstBaseSinkPrivate *priv;
2420 priv->last_in_time = -1;
2421 priv->last_left = -1;
2422 priv->avg_duration = -1;
2424 priv->avg_rate = -1.0;
2425 priv->avg_render = -1;
2431 /* Checks if the object was scheduled too late.
2433 * start/stop contain the raw timestamp start and stop values
2436 * status and jitter contain the return values from the clock wait.
2438 * returns TRUE if the buffer was too late.
2441 gst_base_sink_is_too_late (GstBaseSink * basesink, GstMiniObject * obj,
2442 GstClockTime start, GstClockTime stop,
2443 GstClockReturn status, GstClockTimeDiff jitter)
2446 gint64 max_lateness;
2447 GstBaseSinkPrivate *priv;
2449 priv = basesink->priv;
2453 /* only for objects that were too late */
2454 if (G_LIKELY (status != GST_CLOCK_EARLY))
2457 max_lateness = basesink->abidata.ABI.max_lateness;
2459 /* check if frame dropping is enabled */
2460 if (max_lateness == -1)
2463 /* only check for buffers */
2464 if (G_UNLIKELY (!GST_IS_BUFFER (obj)))
2467 /* can't do check if we don't have a timestamp */
2468 if (G_UNLIKELY (start == -1))
2471 /* we can add a valid stop time */
2473 max_lateness += stop;
2475 max_lateness += start;
2477 /* if the jitter bigger than duration and lateness we are too late */
2478 if ((late = start + jitter > max_lateness)) {
2479 GST_DEBUG_OBJECT (basesink, "buffer is too late %" GST_TIME_FORMAT
2480 " > %" GST_TIME_FORMAT, GST_TIME_ARGS (start + jitter),
2481 GST_TIME_ARGS (max_lateness));
2482 /* !!emergency!!, if we did not receive anything valid for more than a
2483 * second, render it anyway so the user sees something */
2484 if (priv->last_in_time != -1 && start - priv->last_in_time > GST_SECOND) {
2486 GST_ELEMENT_WARNING (basesink, CORE, CLOCK,
2487 (_("A lot of buffers are dropped.")),
2488 ("Maybe there is a timestamp problem or this computer is too slow."));
2489 GST_DEBUG_OBJECT (basesink,
2490 "**emergency** last buffer at %" GST_TIME_FORMAT " > GST_SECOND",
2491 GST_TIME_ARGS (priv->last_in_time));
2497 priv->last_in_time = start;
2504 GST_DEBUG_OBJECT (basesink, "object was scheduled in time");
2509 GST_DEBUG_OBJECT (basesink, "frame dropping disabled");
2514 GST_DEBUG_OBJECT (basesink, "object is not a buffer");
2519 GST_DEBUG_OBJECT (basesink, "buffer has no timestamp");
2524 /* called before and after calling the render vmethod. It keeps track of how
2525 * much time was spent in the render method and is used to check if we are
2528 gst_base_sink_do_render_stats (GstBaseSink * basesink, gboolean start)
2530 GstBaseSinkPrivate *priv;
2532 priv = basesink->priv;
2535 priv->start = gst_util_get_timestamp ();
2537 GstClockTime elapsed;
2539 priv->stop = gst_util_get_timestamp ();
2541 elapsed = GST_CLOCK_DIFF (priv->start, priv->stop);
2543 if (priv->avg_render == -1)
2544 priv->avg_render = elapsed;
2546 priv->avg_render = UPDATE_RUNNING_AVG (priv->avg_render, elapsed);
2548 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2549 "avg_render: %" GST_TIME_FORMAT, GST_TIME_ARGS (priv->avg_render));
2553 /* with STREAM_LOCK, PREROLL_LOCK,
2555 * Synchronize the object on the clock and then render it.
2557 * takes ownership of obj.
2559 static GstFlowReturn
2560 gst_base_sink_render_object (GstBaseSink * basesink, GstPad * pad,
2561 GstMiniObject * obj)
2564 GstBaseSinkClass *bclass;
2567 GstBaseSinkPrivate *priv;
2569 priv = basesink->priv;
2575 /* synchronize this object, non syncable objects return OK
2577 ret = gst_base_sink_do_sync (basesink, pad, obj, &late);
2578 if (G_UNLIKELY (ret != GST_FLOW_OK))
2581 /* and now render, event or buffer. */
2582 if (G_LIKELY (GST_IS_BUFFER (obj))) {
2585 /* drop late buffers unconditionally, let's hope it's unlikely */
2586 if (G_UNLIKELY (late))
2589 buf = GST_BUFFER_CAST (obj);
2591 gst_base_sink_set_last_buffer (basesink, buf);
2593 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2595 if (G_LIKELY (bclass->render)) {
2598 /* read once, to get same value before and after */
2599 do_qos = g_atomic_int_get (&priv->qos_enabled);
2601 GST_DEBUG_OBJECT (basesink, "rendering buffer %p", obj);
2603 /* record rendering time for QoS and stats */
2605 gst_base_sink_do_render_stats (basesink, TRUE);
2607 ret = bclass->render (basesink, buf);
2610 gst_base_sink_do_render_stats (basesink, FALSE);
2612 if (ret == GST_FLOW_STEP)
2618 GstEvent *event = GST_EVENT_CAST (obj);
2619 gboolean event_res = TRUE;
2622 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2624 type = GST_EVENT_TYPE (event);
2626 GST_DEBUG_OBJECT (basesink, "rendering event %p, type %s", obj,
2627 gst_event_type_get_name (type));
2630 event_res = bclass->event (basesink, event);
2632 /* when we get here we could be flushing again when the event handler calls
2633 * _wait_eos(). We have to ignore this object in that case. */
2634 if (G_UNLIKELY (basesink->flushing))
2637 if (G_LIKELY (event_res)) {
2640 seqnum = basesink->priv->seqnum = gst_event_get_seqnum (event);
2641 GST_DEBUG_OBJECT (basesink, "Got seqnum #%" G_GUINT32_FORMAT, seqnum);
2646 GstMessage *message;
2648 /* the EOS event is completely handled so we mark
2649 * ourselves as being in the EOS state. eos is also
2650 * protected by the object lock so we can read it when
2651 * answering the POSITION query. */
2652 GST_OBJECT_LOCK (basesink);
2653 basesink->eos = TRUE;
2654 GST_OBJECT_UNLOCK (basesink);
2656 /* ok, now we can post the message */
2657 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
2659 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
2660 gst_message_set_seqnum (message, seqnum);
2661 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
2664 case GST_EVENT_NEWSEGMENT:
2665 /* configure the segment */
2666 gst_base_sink_configure_segment (basesink, pad, event,
2667 &basesink->segment);
2676 gst_base_sink_perform_qos (basesink, late);
2678 GST_DEBUG_OBJECT (basesink, "object unref after render %p", obj);
2679 gst_mini_object_unref (obj);
2686 GST_DEBUG_OBJECT (basesink, "do_sync returned %s", gst_flow_get_name (ret));
2692 GST_DEBUG_OBJECT (basesink, "buffer late, dropping");
2697 GST_DEBUG_OBJECT (basesink, "we are flushing, ignore object");
2698 gst_mini_object_unref (obj);
2699 return GST_FLOW_WRONG_STATE;
2703 /* with STREAM_LOCK, PREROLL_LOCK
2705 * Perform preroll on the given object. For buffers this means
2706 * calling the preroll subclass method.
2707 * If that succeeds, the state will be commited.
2709 * function does not take ownership of obj.
2711 static GstFlowReturn
2712 gst_base_sink_preroll_object (GstBaseSink * basesink, GstMiniObject * obj)
2716 GST_DEBUG_OBJECT (basesink, "prerolling object %p", obj);
2718 /* if it's a buffer, we need to call the preroll method */
2719 if (G_LIKELY (GST_IS_BUFFER (obj)) && basesink->priv->call_preroll) {
2720 GstBaseSinkClass *bclass;
2722 GstClockTime timestamp;
2724 buf = GST_BUFFER_CAST (obj);
2725 timestamp = GST_BUFFER_TIMESTAMP (buf);
2727 GST_DEBUG_OBJECT (basesink, "preroll buffer %" GST_TIME_FORMAT,
2728 GST_TIME_ARGS (timestamp));
2730 gst_base_sink_set_last_buffer (basesink, buf);
2732 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2733 if (bclass->preroll)
2734 if ((ret = bclass->preroll (basesink, buf)) != GST_FLOW_OK)
2735 goto preroll_failed;
2737 basesink->priv->call_preroll = FALSE;
2741 if (G_LIKELY (basesink->playing_async)) {
2742 if (G_UNLIKELY (!gst_base_sink_commit_state (basesink)))
2751 GST_DEBUG_OBJECT (basesink, "preroll failed, abort state");
2752 gst_element_abort_state (GST_ELEMENT_CAST (basesink));
2757 GST_DEBUG_OBJECT (basesink, "stopping while commiting state");
2758 return GST_FLOW_WRONG_STATE;
2762 /* with STREAM_LOCK, PREROLL_LOCK
2764 * Queue an object for rendering.
2765 * The first prerollable object queued will complete the preroll. If the
2766 * preroll queue if filled, we render all the objects in the queue.
2768 * This function takes ownership of the object.
2770 static GstFlowReturn
2771 gst_base_sink_queue_object_unlocked (GstBaseSink * basesink, GstPad * pad,
2772 GstMiniObject * obj, gboolean prerollable)
2774 GstFlowReturn ret = GST_FLOW_OK;
2778 if (G_UNLIKELY (basesink->need_preroll)) {
2779 if (G_LIKELY (prerollable))
2780 basesink->preroll_queued++;
2782 length = basesink->preroll_queued;
2784 GST_DEBUG_OBJECT (basesink, "now %d prerolled items", length);
2786 /* first prerollable item needs to finish the preroll */
2788 ret = gst_base_sink_preroll_object (basesink, obj);
2789 if (G_UNLIKELY (ret != GST_FLOW_OK))
2790 goto preroll_failed;
2792 /* need to recheck if we need preroll, commmit state during preroll
2793 * could have made us not need more preroll. */
2794 if (G_UNLIKELY (basesink->need_preroll)) {
2795 /* see if we can render now, if we can't add the object to the preroll
2797 if (G_UNLIKELY (length <= basesink->preroll_queue_max_len))
2802 /* we can start rendering (or blocking) the queued object
2804 q = basesink->preroll_queue;
2805 while (G_UNLIKELY (!g_queue_is_empty (q))) {
2808 o = g_queue_pop_head (q);
2809 GST_DEBUG_OBJECT (basesink, "rendering queued object %p", o);
2811 /* do something with the return value */
2812 ret = gst_base_sink_render_object (basesink, pad, o);
2813 if (ret != GST_FLOW_OK)
2814 goto dequeue_failed;
2817 /* now render the object */
2818 ret = gst_base_sink_render_object (basesink, pad, obj);
2819 basesink->preroll_queued = 0;
2826 GST_DEBUG_OBJECT (basesink, "preroll failed, reason %s",
2827 gst_flow_get_name (ret));
2828 gst_mini_object_unref (obj);
2833 /* add object to the queue and return */
2834 GST_DEBUG_OBJECT (basesink, "need more preroll data %d <= %d",
2835 length, basesink->preroll_queue_max_len);
2836 g_queue_push_tail (basesink->preroll_queue, obj);
2841 GST_DEBUG_OBJECT (basesink, "rendering queued objects failed, reason %s",
2842 gst_flow_get_name (ret));
2843 gst_mini_object_unref (obj);
2850 * This function grabs the PREROLL_LOCK and adds the object to
2853 * This function takes ownership of obj.
2855 static GstFlowReturn
2856 gst_base_sink_queue_object (GstBaseSink * basesink, GstPad * pad,
2857 GstMiniObject * obj, gboolean prerollable)
2861 GST_PAD_PREROLL_LOCK (pad);
2862 if (G_UNLIKELY (basesink->flushing))
2865 if (G_UNLIKELY (basesink->priv->received_eos))
2868 ret = gst_base_sink_queue_object_unlocked (basesink, pad, obj, prerollable);
2869 GST_PAD_PREROLL_UNLOCK (pad);
2876 GST_DEBUG_OBJECT (basesink, "sink is flushing");
2877 GST_PAD_PREROLL_UNLOCK (pad);
2878 gst_mini_object_unref (obj);
2879 return GST_FLOW_WRONG_STATE;
2883 GST_DEBUG_OBJECT (basesink,
2884 "we are EOS, dropping object, return UNEXPECTED");
2885 GST_PAD_PREROLL_UNLOCK (pad);
2886 gst_mini_object_unref (obj);
2887 return GST_FLOW_UNEXPECTED;
2892 gst_base_sink_flush_start (GstBaseSink * basesink, GstPad * pad)
2894 /* make sure we are not blocked on the clock also clear any pending
2896 gst_base_sink_set_flushing (basesink, pad, TRUE);
2898 /* we grab the stream lock but that is not needed since setting the
2899 * sink to flushing would make sure no state commit is being done
2901 GST_PAD_STREAM_LOCK (pad);
2902 gst_base_sink_reset_qos (basesink);
2903 if (basesink->priv->async_enabled) {
2904 /* and we need to commit our state again on the next
2905 * prerolled buffer */
2906 basesink->playing_async = TRUE;
2907 gst_element_lost_state (GST_ELEMENT_CAST (basesink));
2909 basesink->priv->have_latency = TRUE;
2910 basesink->need_preroll = FALSE;
2912 gst_base_sink_set_last_buffer (basesink, NULL);
2913 GST_PAD_STREAM_UNLOCK (pad);
2917 gst_base_sink_flush_stop (GstBaseSink * basesink, GstPad * pad)
2919 /* unset flushing so we can accept new data, this also flushes out any EOS
2921 gst_base_sink_set_flushing (basesink, pad, FALSE);
2923 /* for position reporting */
2924 GST_OBJECT_LOCK (basesink);
2925 basesink->priv->current_sstart = -1;
2926 basesink->priv->current_sstop = -1;
2927 basesink->priv->eos_rtime = -1;
2928 basesink->priv->call_preroll = TRUE;
2929 if (basesink->pad_mode == GST_ACTIVATE_PUSH) {
2930 /* we need new segment info after the flush. */
2931 basesink->have_newsegment = FALSE;
2932 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
2933 gst_segment_init (basesink->abidata.ABI.clip_segment, GST_FORMAT_UNDEFINED);
2935 GST_OBJECT_UNLOCK (basesink);
2939 gst_base_sink_event (GstPad * pad, GstEvent * event)
2941 GstBaseSink *basesink;
2942 gboolean result = TRUE;
2943 GstBaseSinkClass *bclass;
2945 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
2947 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2949 GST_DEBUG_OBJECT (basesink, "event %p (%s)", event,
2950 GST_EVENT_TYPE_NAME (event));
2952 switch (GST_EVENT_TYPE (event)) {
2957 GST_PAD_PREROLL_LOCK (pad);
2958 if (G_UNLIKELY (basesink->flushing))
2961 if (G_UNLIKELY (basesink->priv->received_eos)) {
2962 /* we can't accept anything when we are EOS */
2964 gst_event_unref (event);
2966 /* we set the received EOS flag here so that we can use it when testing if
2967 * we are prerolled and to refuse more buffers. */
2968 basesink->priv->received_eos = TRUE;
2970 /* EOS is a prerollable object, we call the unlocked version because it
2971 * does not check the received_eos flag. */
2972 ret = gst_base_sink_queue_object_unlocked (basesink, pad,
2973 GST_MINI_OBJECT_CAST (event), TRUE);
2974 if (G_UNLIKELY (ret != GST_FLOW_OK))
2977 GST_PAD_PREROLL_UNLOCK (pad);
2980 case GST_EVENT_NEWSEGMENT:
2984 GST_DEBUG_OBJECT (basesink, "newsegment %p", event);
2986 GST_PAD_PREROLL_LOCK (pad);
2987 if (G_UNLIKELY (basesink->flushing))
2990 if (G_UNLIKELY (basesink->priv->received_eos)) {
2991 /* we can't accept anything when we are EOS */
2993 gst_event_unref (event);
2995 /* the new segment is a non prerollable item and does not block anything,
2996 * we need to configure the current clipping segment and insert the event
2997 * in the queue to serialize it with the buffers for rendering. */
2998 gst_base_sink_configure_segment (basesink, pad, event,
2999 basesink->abidata.ABI.clip_segment);
3002 gst_base_sink_queue_object_unlocked (basesink, pad,
3003 GST_MINI_OBJECT_CAST (event), FALSE);
3004 if (G_UNLIKELY (ret != GST_FLOW_OK))
3007 GST_OBJECT_LOCK (basesink);
3008 basesink->have_newsegment = TRUE;
3009 GST_OBJECT_UNLOCK (basesink);
3012 GST_PAD_PREROLL_UNLOCK (pad);
3015 case GST_EVENT_FLUSH_START:
3017 bclass->event (basesink, event);
3019 GST_DEBUG_OBJECT (basesink, "flush-start %p", event);
3021 gst_base_sink_flush_start (basesink, pad);
3023 gst_event_unref (event);
3025 case GST_EVENT_FLUSH_STOP:
3027 bclass->event (basesink, event);
3029 GST_DEBUG_OBJECT (basesink, "flush-stop %p", event);
3031 gst_base_sink_flush_stop (basesink, pad);
3033 gst_event_unref (event);
3036 /* other events are sent to queue or subclass depending on if they
3037 * are serialized. */
3038 if (GST_EVENT_IS_SERIALIZED (event)) {
3039 gst_base_sink_queue_object (basesink, pad,
3040 GST_MINI_OBJECT_CAST (event), FALSE);
3043 bclass->event (basesink, event);
3044 gst_event_unref (event);
3049 gst_object_unref (basesink);
3056 GST_DEBUG_OBJECT (basesink, "we are flushing");
3057 GST_PAD_PREROLL_UNLOCK (pad);
3059 gst_event_unref (event);
3064 /* default implementation to calculate the start and end
3065 * timestamps on a buffer, subclasses can override
3068 gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
3069 GstClockTime * start, GstClockTime * end)
3071 GstClockTime timestamp, duration;
3073 timestamp = GST_BUFFER_TIMESTAMP (buffer);
3074 if (GST_CLOCK_TIME_IS_VALID (timestamp)) {
3076 /* get duration to calculate end time */
3077 duration = GST_BUFFER_DURATION (buffer);
3078 if (GST_CLOCK_TIME_IS_VALID (duration)) {
3079 *end = timestamp + duration;
3085 /* must be called with PREROLL_LOCK */
3087 gst_base_sink_needs_preroll (GstBaseSink * basesink)
3089 gboolean is_prerolled, res;
3091 /* we have 2 cases where the PREROLL_LOCK is released:
3092 * 1) we are blocking in the PREROLL_LOCK and thus are prerolled.
3093 * 2) we are syncing on the clock
3095 is_prerolled = basesink->have_preroll || basesink->priv->received_eos;
3096 res = !is_prerolled;
3098 GST_DEBUG_OBJECT (basesink, "have_preroll: %d, EOS: %d => needs preroll: %d",
3099 basesink->have_preroll, basesink->priv->received_eos, res);
3104 /* with STREAM_LOCK, PREROLL_LOCK
3106 * Takes a buffer and compare the timestamps with the last segment.
3107 * If the buffer falls outside of the segment boundaries, drop it.
3108 * Else queue the buffer for preroll and rendering.
3110 * This function takes ownership of the buffer.
3112 static GstFlowReturn
3113 gst_base_sink_chain_unlocked (GstBaseSink * basesink, GstPad * pad,
3116 GstBaseSinkClass *bclass;
3117 GstFlowReturn result;
3118 GstClockTime start = GST_CLOCK_TIME_NONE, end = GST_CLOCK_TIME_NONE;
3119 GstSegment *clip_segment;
3121 if (G_UNLIKELY (basesink->flushing))
3124 if (G_UNLIKELY (basesink->priv->received_eos))
3127 /* for code clarity */
3128 clip_segment = basesink->abidata.ABI.clip_segment;
3130 if (G_UNLIKELY (!basesink->have_newsegment)) {
3133 sync = gst_base_sink_get_sync (basesink);
3135 GST_ELEMENT_WARNING (basesink, STREAM, FAILED,
3136 (_("Internal data flow problem.")),
3137 ("Received buffer without a new-segment. Assuming timestamps start from 0."));
3140 /* this means this sink will assume timestamps start from 0 */
3141 GST_OBJECT_LOCK (basesink);
3142 clip_segment->start = 0;
3143 clip_segment->stop = -1;
3144 basesink->segment.start = 0;
3145 basesink->segment.stop = -1;
3146 basesink->have_newsegment = TRUE;
3147 GST_OBJECT_UNLOCK (basesink);
3150 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3152 /* check if the buffer needs to be dropped, we first ask the subclass for the
3154 if (bclass->get_times)
3155 bclass->get_times (basesink, buf, &start, &end);
3158 /* if the subclass does not want sync, we use our own values so that we at
3159 * least clip the buffer to the segment */
3160 gst_base_sink_get_times (basesink, buf, &start, &end);
3163 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
3164 ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (end));
3166 /* a dropped buffer does not participate in anything */
3167 if (GST_CLOCK_TIME_IS_VALID (start) &&
3168 (clip_segment->format == GST_FORMAT_TIME)) {
3169 if (G_UNLIKELY (!gst_segment_clip (clip_segment,
3170 GST_FORMAT_TIME, (gint64) start, (gint64) end, NULL, NULL)))
3171 goto out_of_segment;
3174 /* now we can process the buffer in the queue, this function takes ownership
3176 result = gst_base_sink_queue_object_unlocked (basesink, pad,
3177 GST_MINI_OBJECT_CAST (buf), TRUE);
3184 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3185 gst_buffer_unref (buf);
3186 return GST_FLOW_WRONG_STATE;
3190 GST_DEBUG_OBJECT (basesink,
3191 "we are EOS, dropping object, return UNEXPECTED");
3192 gst_buffer_unref (buf);
3193 return GST_FLOW_UNEXPECTED;
3197 GST_DEBUG_OBJECT (basesink, "dropping buffer, out of clipping segment");
3198 gst_buffer_unref (buf);
3205 static GstFlowReturn
3206 gst_base_sink_chain (GstPad * pad, GstBuffer * buf)
3208 GstBaseSink *basesink;
3209 GstFlowReturn result;
3211 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3213 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH))
3216 GST_PAD_PREROLL_LOCK (pad);
3217 result = gst_base_sink_chain_unlocked (basesink, pad, buf);
3218 GST_PAD_PREROLL_UNLOCK (pad);
3226 GST_OBJECT_LOCK (pad);
3227 GST_WARNING_OBJECT (basesink,
3228 "Push on pad %s:%s, but it was not activated in push mode",
3229 GST_DEBUG_PAD_NAME (pad));
3230 GST_OBJECT_UNLOCK (pad);
3231 gst_buffer_unref (buf);
3232 /* we don't post an error message this will signal to the peer
3233 * pushing that EOS is reached. */
3234 result = GST_FLOW_UNEXPECTED;
3240 gst_base_sink_default_do_seek (GstBaseSink * sink, GstSegment * segment)
3242 gboolean res = TRUE;
3244 /* update our offset if the start/stop position was updated */
3245 if (segment->format == GST_FORMAT_BYTES) {
3246 segment->time = segment->start;
3247 } else if (segment->start == 0) {
3248 /* seek to start, we can implement a default for this. */
3252 GST_INFO_OBJECT (sink, "Can't do a default seek");
3258 #define SEEK_TYPE_IS_RELATIVE(t) (((t) != GST_SEEK_TYPE_NONE) && ((t) != GST_SEEK_TYPE_SET))
3261 gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
3262 GstEvent * event, GstSegment * segment)
3264 /* By default, we try one of 2 things:
3265 * - For absolute seek positions, convert the requested position to our
3266 * configured processing format and place it in the output segment \
3267 * - For relative seek positions, convert our current (input) values to the
3268 * seek format, adjust by the relative seek offset and then convert back to
3269 * the processing format
3271 GstSeekType cur_type, stop_type;
3274 GstFormat seek_format, dest_format;
3277 gboolean res = TRUE;
3279 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3280 &cur_type, &cur, &stop_type, &stop);
3281 dest_format = segment->format;
3283 if (seek_format == dest_format) {
3284 gst_segment_set_seek (segment, rate, seek_format, flags,
3285 cur_type, cur, stop_type, stop, &update);
3289 if (cur_type != GST_SEEK_TYPE_NONE) {
3290 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3292 gst_pad_query_convert (sink->sinkpad, seek_format, cur, &dest_format,
3294 cur_type = GST_SEEK_TYPE_SET;
3297 if (res && stop_type != GST_SEEK_TYPE_NONE) {
3298 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3300 gst_pad_query_convert (sink->sinkpad, seek_format, stop, &dest_format,
3302 stop_type = GST_SEEK_TYPE_SET;
3305 /* And finally, configure our output segment in the desired format */
3306 gst_segment_set_seek (segment, rate, dest_format, flags, cur_type, cur,
3307 stop_type, stop, &update);
3316 GST_DEBUG_OBJECT (sink, "undefined format given, seek aborted.");
3321 /* perform a seek, only executed in pull mode */
3323 gst_base_sink_perform_seek (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3327 GstFormat seek_format, dest_format;
3329 GstSeekType cur_type, stop_type;
3330 gboolean seekseg_configured = FALSE;
3332 gboolean update, res = TRUE;
3333 GstSegment seeksegment;
3335 dest_format = sink->segment.format;
3338 GST_DEBUG_OBJECT (sink, "performing seek with event %p", event);
3339 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3340 &cur_type, &cur, &stop_type, &stop);
3342 flush = flags & GST_SEEK_FLAG_FLUSH;
3344 GST_DEBUG_OBJECT (sink, "performing seek without event");
3349 GST_DEBUG_OBJECT (sink, "flushing upstream");
3350 gst_pad_push_event (pad, gst_event_new_flush_start ());
3351 gst_base_sink_flush_start (sink, pad);
3353 GST_DEBUG_OBJECT (sink, "pausing pulling thread");
3356 GST_PAD_STREAM_LOCK (pad);
3358 /* If we configured the seeksegment above, don't overwrite it now. Otherwise
3359 * copy the current segment info into the temp segment that we can actually
3360 * attempt the seek with. We only update the real segment if the seek suceeds. */
3361 if (!seekseg_configured) {
3362 memcpy (&seeksegment, &sink->segment, sizeof (GstSegment));
3364 /* now configure the final seek segment */
3366 if (sink->segment.format != seek_format) {
3367 /* OK, here's where we give the subclass a chance to convert the relative
3368 * seek into an absolute one in the processing format. We set up any
3369 * absolute seek above, before taking the stream lock. */
3370 if (!gst_base_sink_default_prepare_seek_segment (sink, event,
3372 GST_DEBUG_OBJECT (sink,
3373 "Preparing the seek failed after flushing. " "Aborting seek");
3377 /* The seek format matches our processing format, no need to ask the
3378 * the subclass to configure the segment. */
3379 gst_segment_set_seek (&seeksegment, rate, seek_format, flags,
3380 cur_type, cur, stop_type, stop, &update);
3383 /* Else, no seek event passed, so we're just (re)starting the
3388 GST_DEBUG_OBJECT (sink, "segment configured from %" G_GINT64_FORMAT
3389 " to %" G_GINT64_FORMAT ", position %" G_GINT64_FORMAT,
3390 seeksegment.start, seeksegment.stop, seeksegment.last_stop);
3392 /* do the seek, segment.last_stop contains the new position. */
3393 res = gst_base_sink_default_do_seek (sink, &seeksegment);
3398 GST_DEBUG_OBJECT (sink, "stop flushing upstream");
3399 gst_pad_push_event (pad, gst_event_new_flush_stop ());
3400 gst_base_sink_flush_stop (sink, pad);
3401 } else if (res && sink->abidata.ABI.running) {
3402 /* we are running the current segment and doing a non-flushing seek,
3403 * close the segment first based on the last_stop. */
3404 GST_DEBUG_OBJECT (sink, "closing running segment %" G_GINT64_FORMAT
3405 " to %" G_GINT64_FORMAT, sink->segment.start, sink->segment.last_stop);
3408 /* The subclass must have converted the segment to the processing format
3410 if (res && seeksegment.format != dest_format) {
3411 GST_DEBUG_OBJECT (sink, "Subclass failed to prepare a seek segment "
3412 "in the correct format. Aborting seek.");
3416 /* if successfull seek, we update our real segment and push
3417 * out the new segment. */
3419 memcpy (&sink->segment, &seeksegment, sizeof (GstSegment));
3421 if (sink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3422 gst_element_post_message (GST_ELEMENT (sink),
3423 gst_message_new_segment_start (GST_OBJECT (sink),
3424 sink->segment.format, sink->segment.last_stop));
3428 sink->priv->discont = TRUE;
3429 sink->abidata.ABI.running = TRUE;
3431 GST_PAD_STREAM_UNLOCK (pad);
3437 gst_base_sink_perform_step (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3439 GstBaseSinkPrivate *priv;
3440 GstBaseSinkClass *bclass;
3441 gboolean flush, intermediate;
3446 GstStepInfo *pending;
3448 bclass = GST_BASE_SINK_GET_CLASS (sink);
3451 GST_DEBUG_OBJECT (sink, "performing step with event %p", event);
3453 gst_event_parse_step (event, &format, &amount, &rate, &flush, &intermediate);
3454 seqnum = gst_event_get_seqnum (event);
3456 pending = &priv->pending_step;
3459 /* we need to call ::unlock before locking PREROLL_LOCK
3460 * since we lock it before going into ::render */
3462 bclass->unlock (sink);
3464 GST_PAD_PREROLL_LOCK (sink->sinkpad);
3465 /* now that we have the PREROLL lock, clear our unlock request */
3466 if (bclass->unlock_stop)
3467 bclass->unlock_stop (sink);
3469 /* update the stepinfo and make it valid */
3470 pending->seqnum = seqnum;
3471 pending->format = format;
3472 pending->amount = amount;
3473 pending->position = 0;
3474 pending->rate = rate;
3475 pending->flush = flush;
3476 pending->intermediate = intermediate;
3477 pending->valid = TRUE;
3479 if (sink->priv->async_enabled) {
3480 /* and we need to commit our state again on the next
3481 * prerolled buffer */
3482 sink->playing_async = TRUE;
3483 priv->pending_step.need_preroll = TRUE;
3484 sink->need_preroll = FALSE;
3485 gst_element_lost_state_full (GST_ELEMENT_CAST (sink), FALSE);
3487 sink->priv->have_latency = TRUE;
3488 sink->need_preroll = FALSE;
3490 priv->current_sstart = -1;
3491 priv->current_sstop = -1;
3492 priv->eos_rtime = -1;
3493 priv->call_preroll = TRUE;
3494 gst_base_sink_set_last_buffer (sink, NULL);
3495 gst_base_sink_reset_qos (sink);
3497 if (sink->clock_id) {
3498 gst_clock_id_unschedule (sink->clock_id);
3501 if (sink->have_preroll) {
3502 GST_DEBUG_OBJECT (sink, "signal waiter");
3503 priv->step_unlock = TRUE;
3504 GST_PAD_PREROLL_SIGNAL (sink->sinkpad);
3506 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
3515 gst_base_sink_loop (GstPad * pad)
3517 GstBaseSink *basesink;
3518 GstBuffer *buf = NULL;
3519 GstFlowReturn result;
3523 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3525 g_assert (basesink->pad_mode == GST_ACTIVATE_PULL);
3527 if ((blocksize = basesink->priv->blocksize) == 0)
3530 offset = basesink->segment.last_stop;
3532 GST_DEBUG_OBJECT (basesink, "pulling %" G_GUINT64_FORMAT ", %u",
3535 result = gst_pad_pull_range (pad, offset, blocksize, &buf);
3536 if (G_UNLIKELY (result != GST_FLOW_OK))
3539 if (G_UNLIKELY (buf == NULL))
3542 offset += GST_BUFFER_SIZE (buf);
3544 gst_segment_set_last_stop (&basesink->segment, GST_FORMAT_BYTES, offset);
3546 GST_PAD_PREROLL_LOCK (pad);
3547 result = gst_base_sink_chain_unlocked (basesink, pad, buf);
3548 GST_PAD_PREROLL_UNLOCK (pad);
3549 if (G_UNLIKELY (result != GST_FLOW_OK))
3557 GST_LOG_OBJECT (basesink, "pausing task, reason %s",
3558 gst_flow_get_name (result));
3559 gst_pad_pause_task (pad);
3560 /* fatal errors and NOT_LINKED cause EOS */
3561 if (GST_FLOW_IS_FATAL (result) || result == GST_FLOW_NOT_LINKED) {
3562 if (result == GST_FLOW_UNEXPECTED) {
3563 /* perform EOS logic */
3564 if (basesink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3565 gst_element_post_message (GST_ELEMENT_CAST (basesink),
3566 gst_message_new_segment_done (GST_OBJECT_CAST (basesink),
3567 basesink->segment.format, basesink->segment.last_stop));
3569 gst_base_sink_event (pad, gst_event_new_eos ());
3572 /* for fatal errors we post an error message, post the error
3573 * first so the app knows about the error first. */
3574 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
3575 (_("Internal data stream error.")),
3576 ("stream stopped, reason %s", gst_flow_get_name (result)));
3577 gst_base_sink_event (pad, gst_event_new_eos ());
3584 GST_LOG_OBJECT (basesink, "no buffer, pausing");
3585 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
3586 (_("Internal data flow error.")), ("element returned NULL buffer"));
3587 result = GST_FLOW_ERROR;
3593 gst_base_sink_set_flushing (GstBaseSink * basesink, GstPad * pad,
3596 GstBaseSinkClass *bclass;
3598 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3601 /* unlock any subclasses, we need to do this before grabbing the
3602 * PREROLL_LOCK since we hold this lock before going into ::render. */
3604 bclass->unlock (basesink);
3607 GST_PAD_PREROLL_LOCK (pad);
3608 basesink->flushing = flushing;
3610 /* step 1, now that we have the PREROLL lock, clear our unlock request */
3611 if (bclass->unlock_stop)
3612 bclass->unlock_stop (basesink);
3614 /* set need_preroll before we unblock the clock. If the clock is unblocked
3615 * before timing out, we can reuse the buffer for preroll. */
3616 basesink->need_preroll = TRUE;
3618 /* step 2, unblock clock sync (if any) or any other blocking thing */
3619 if (basesink->clock_id) {
3620 gst_clock_id_unschedule (basesink->clock_id);
3623 /* flush out the data thread if it's locked in finish_preroll, this will
3624 * also flush out the EOS state */
3625 GST_DEBUG_OBJECT (basesink,
3626 "flushing out data thread, need preroll to TRUE");
3627 gst_base_sink_preroll_queue_flush (basesink, pad);
3629 GST_PAD_PREROLL_UNLOCK (pad);
3635 gst_base_sink_default_activate_pull (GstBaseSink * basesink, gboolean active)
3641 result = gst_pad_start_task (basesink->sinkpad,
3642 (GstTaskFunction) gst_base_sink_loop, basesink->sinkpad);
3644 /* step 2, make sure streaming finishes */
3645 result = gst_pad_stop_task (basesink->sinkpad);
3652 gst_base_sink_pad_activate (GstPad * pad)
3654 gboolean result = FALSE;
3655 GstBaseSink *basesink;
3657 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3659 GST_DEBUG_OBJECT (basesink, "Trying pull mode first");
3661 gst_base_sink_set_flushing (basesink, pad, FALSE);
3663 /* we need to have the pull mode enabled */
3664 if (!basesink->can_activate_pull) {
3665 GST_DEBUG_OBJECT (basesink, "pull mode disabled");
3669 /* check if downstreams supports pull mode at all */
3670 if (!gst_pad_check_pull_range (pad)) {
3671 GST_DEBUG_OBJECT (basesink, "pull mode not supported");
3675 /* set the pad mode before starting the task so that it's in the
3676 * correct state for the new thread. also the sink set_caps and get_caps
3677 * function checks this */
3678 basesink->pad_mode = GST_ACTIVATE_PULL;
3680 /* we first try to negotiate a format so that when we try to activate
3681 * downstream, it knows about our format */
3682 if (!gst_base_sink_negotiate_pull (basesink)) {
3683 GST_DEBUG_OBJECT (basesink, "failed to negotiate in pull mode");
3687 /* ok activate now */
3688 if (!gst_pad_activate_pull (pad, TRUE)) {
3689 /* clear any pending caps */
3690 GST_OBJECT_LOCK (basesink);
3691 gst_caps_replace (&basesink->priv->pull_caps, NULL);
3692 GST_OBJECT_UNLOCK (basesink);
3693 GST_DEBUG_OBJECT (basesink, "failed to activate in pull mode");
3697 GST_DEBUG_OBJECT (basesink, "Success activating pull mode");
3701 /* push mode fallback */
3703 GST_DEBUG_OBJECT (basesink, "Falling back to push mode");
3704 if ((result = gst_pad_activate_push (pad, TRUE))) {
3705 GST_DEBUG_OBJECT (basesink, "Success activating push mode");
3710 GST_WARNING_OBJECT (basesink, "Could not activate pad in either mode");
3711 gst_base_sink_set_flushing (basesink, pad, TRUE);
3714 gst_object_unref (basesink);
3720 gst_base_sink_pad_activate_push (GstPad * pad, gboolean active)
3723 GstBaseSink *basesink;
3725 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3728 if (!basesink->can_activate_push) {
3730 basesink->pad_mode = GST_ACTIVATE_NONE;
3733 basesink->pad_mode = GST_ACTIVATE_PUSH;
3736 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH)) {
3737 g_warning ("Internal GStreamer activation error!!!");
3740 gst_base_sink_set_flushing (basesink, pad, TRUE);
3742 basesink->pad_mode = GST_ACTIVATE_NONE;
3746 gst_object_unref (basesink);
3752 gst_base_sink_negotiate_pull (GstBaseSink * basesink)
3759 /* this returns the intersection between our caps and the peer caps. If there
3760 * is no peer, it returns NULL and we can't operate in pull mode so we can
3761 * fail the negotiation. */
3762 caps = gst_pad_get_allowed_caps (GST_BASE_SINK_PAD (basesink));
3763 if (caps == NULL || gst_caps_is_empty (caps))
3764 goto no_caps_possible;
3766 GST_DEBUG_OBJECT (basesink, "allowed caps: %" GST_PTR_FORMAT, caps);
3768 caps = gst_caps_make_writable (caps);
3769 /* get the first (prefered) format */
3770 gst_caps_truncate (caps);
3772 gst_pad_fixate_caps (GST_BASE_SINK_PAD (basesink), caps);
3774 GST_DEBUG_OBJECT (basesink, "fixated to: %" GST_PTR_FORMAT, caps);
3776 if (gst_caps_is_any (caps)) {
3777 GST_DEBUG_OBJECT (basesink, "caps were ANY after fixating, "
3779 /* neither side has template caps in this case, so they are prepared for
3780 pull() without setcaps() */
3782 } else if (gst_caps_is_fixed (caps)) {
3783 if (!gst_pad_set_caps (GST_BASE_SINK_PAD (basesink), caps))
3784 goto could_not_set_caps;
3786 GST_OBJECT_LOCK (basesink);
3787 gst_caps_replace (&basesink->priv->pull_caps, caps);
3788 GST_OBJECT_UNLOCK (basesink);
3793 gst_caps_unref (caps);
3799 GST_INFO_OBJECT (basesink, "Pipeline could not agree on caps");
3800 GST_DEBUG_OBJECT (basesink, "get_allowed_caps() returned EMPTY");
3802 gst_caps_unref (caps);
3807 GST_INFO_OBJECT (basesink, "Could not set caps: %" GST_PTR_FORMAT, caps);
3808 gst_caps_unref (caps);
3813 /* this won't get called until we implement an activate function */
3815 gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active)
3817 gboolean result = FALSE;
3818 GstBaseSink *basesink;
3819 GstBaseSinkClass *bclass;
3821 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3822 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3828 /* we mark we have a newsegment here because pull based
3829 * mode works just fine without having a newsegment before the
3831 format = GST_FORMAT_BYTES;
3833 gst_segment_init (&basesink->segment, format);
3834 gst_segment_init (basesink->abidata.ABI.clip_segment, format);
3835 GST_OBJECT_LOCK (basesink);
3836 basesink->have_newsegment = TRUE;
3837 GST_OBJECT_UNLOCK (basesink);
3839 /* get the peer duration in bytes */
3840 result = gst_pad_query_peer_duration (pad, &format, &duration);
3842 GST_DEBUG_OBJECT (basesink,
3843 "setting duration in bytes to %" G_GINT64_FORMAT, duration);
3844 gst_segment_set_duration (basesink->abidata.ABI.clip_segment, format,
3846 gst_segment_set_duration (&basesink->segment, format, duration);
3848 GST_DEBUG_OBJECT (basesink, "unknown duration");
3851 if (bclass->activate_pull)
3852 result = bclass->activate_pull (basesink, TRUE);
3857 goto activate_failed;
3860 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PULL)) {
3861 g_warning ("Internal GStreamer activation error!!!");
3864 result = gst_base_sink_set_flushing (basesink, pad, TRUE);
3865 if (bclass->activate_pull)
3866 result &= bclass->activate_pull (basesink, FALSE);
3867 basesink->pad_mode = GST_ACTIVATE_NONE;
3868 /* clear any pending caps */
3869 GST_OBJECT_LOCK (basesink);
3870 gst_caps_replace (&basesink->priv->pull_caps, NULL);
3871 GST_OBJECT_UNLOCK (basesink);
3874 gst_object_unref (basesink);
3881 /* reset, as starting the thread failed */
3882 basesink->pad_mode = GST_ACTIVATE_NONE;
3884 GST_ERROR_OBJECT (basesink, "subclass failed to activate in pull mode");
3889 /* send an event to our sinkpad peer. */
3891 gst_base_sink_send_event (GstElement * element, GstEvent * event)
3894 GstBaseSink *basesink = GST_BASE_SINK (element);
3895 gboolean forward, result = TRUE;
3896 GstActivateMode mode;
3898 GST_OBJECT_LOCK (element);
3899 /* get the pad and the scheduling mode */
3900 pad = gst_object_ref (basesink->sinkpad);
3901 mode = basesink->pad_mode;
3902 GST_OBJECT_UNLOCK (element);
3904 /* only push UPSTREAM events upstream */
3905 forward = GST_EVENT_IS_UPSTREAM (event);
3907 switch (GST_EVENT_TYPE (event)) {
3908 case GST_EVENT_LATENCY:
3910 GstClockTime latency;
3912 gst_event_parse_latency (event, &latency);
3914 /* store the latency. We use this to adjust the running_time before syncing
3915 * it to the clock. */
3916 GST_OBJECT_LOCK (element);
3917 basesink->priv->latency = latency;
3918 if (!basesink->priv->have_latency)
3920 GST_OBJECT_UNLOCK (element);
3921 GST_DEBUG_OBJECT (basesink, "latency set to %" GST_TIME_FORMAT,
3922 GST_TIME_ARGS (latency));
3924 /* We forward this event so that all elements know about the global pipeline
3925 * latency. This is interesting for an element when it wants to figure out
3926 * when a particular piece of data will be rendered. */
3929 case GST_EVENT_SEEK:
3930 /* in pull mode we will execute the seek */
3931 if (mode == GST_ACTIVATE_PULL)
3932 result = gst_base_sink_perform_seek (basesink, pad, event);
3934 case GST_EVENT_STEP:
3935 result = gst_base_sink_perform_step (basesink, pad, event);
3943 result = gst_pad_push_event (pad, event);
3945 /* not forwarded, unref the event */
3946 gst_event_unref (event);
3949 gst_object_unref (pad);
3954 gst_base_sink_peer_query (GstBaseSink * sink, GstQuery * query)
3957 gboolean res = FALSE;
3959 if ((peer = gst_pad_get_peer (sink->sinkpad))) {
3960 res = gst_pad_query (peer, query);
3961 gst_object_unref (peer);
3966 /* get the end position of the last seen object, this is used
3967 * for EOS and for making sure that we don't report a position we
3968 * have not reached yet. With LOCK. */
3970 gst_base_sink_get_position_last (GstBaseSink * basesink, GstFormat format,
3974 GstSegment *segment;
3975 gboolean ret = TRUE;
3977 segment = &basesink->segment;
3978 oformat = segment->format;
3980 if (oformat == GST_FORMAT_TIME) {
3981 /* return last observed stream time, we keep the stream time around in the
3983 *cur = basesink->priv->current_sstop;
3985 /* convert last stop to stream time */
3986 *cur = gst_segment_to_stream_time (segment, oformat, segment->last_stop);
3989 if (*cur != -1 && oformat != format) {
3990 GST_OBJECT_UNLOCK (basesink);
3991 /* convert to the target format if we need to, release lock first */
3993 gst_pad_query_convert (basesink->sinkpad, oformat, *cur, &format, cur);
3996 GST_OBJECT_LOCK (basesink);
3999 GST_DEBUG_OBJECT (basesink, "POSITION: %" GST_TIME_FORMAT,
4000 GST_TIME_ARGS (*cur));
4005 /* get the position when we are PAUSED, this is the stream time of the buffer
4006 * that prerolled. If no buffer is prerolled (we are still flushing), this
4007 * value will be -1. With LOCK. */
4009 gst_base_sink_get_position_paused (GstBaseSink * basesink, GstFormat format,
4014 GstSegment *segment;
4017 /* we don't use the clip segment in pull mode, when seeking we update the
4018 * main segment directly with the new segment values without it having to be
4019 * activated by the rendering after preroll */
4020 if (basesink->pad_mode == GST_ACTIVATE_PUSH)
4021 segment = basesink->abidata.ABI.clip_segment;
4023 segment = &basesink->segment;
4024 oformat = segment->format;
4026 if (oformat == GST_FORMAT_TIME) {
4027 *cur = basesink->priv->current_sstart;
4028 if (segment->rate < 0.0 && basesink->priv->current_sstop != -1) {
4029 /* for reverse playback we prefer the stream time stop position if we have
4031 *cur = basesink->priv->current_sstop;
4034 *cur = gst_segment_to_stream_time (segment, oformat, segment->last_stop);
4037 time = segment->time;
4040 *cur = MAX (*cur, time);
4041 GST_DEBUG_OBJECT (basesink, "POSITION as max: %" GST_TIME_FORMAT
4042 ", time %" GST_TIME_FORMAT, GST_TIME_ARGS (*cur), GST_TIME_ARGS (time));
4044 /* we have no buffer, use the segment times. */
4045 if (segment->rate >= 0.0) {
4046 /* forward, next position is always the time of the segment */
4048 GST_DEBUG_OBJECT (basesink, "POSITION as time: %" GST_TIME_FORMAT,
4049 GST_TIME_ARGS (*cur));
4051 /* reverse, next expected timestamp is segment->stop. We use the function
4052 * to get things right for negative applied_rates. */
4053 *cur = gst_segment_to_stream_time (segment, oformat, segment->stop);
4054 GST_DEBUG_OBJECT (basesink, "reverse POSITION: %" GST_TIME_FORMAT,
4055 GST_TIME_ARGS (*cur));
4060 if (res && oformat != format) {
4061 GST_OBJECT_UNLOCK (basesink);
4063 gst_pad_query_convert (basesink->sinkpad, oformat, *cur, &format, cur);
4066 GST_OBJECT_LOCK (basesink);
4073 gst_base_sink_get_position (GstBaseSink * basesink, GstFormat format,
4074 gint64 * cur, gboolean * upstream)
4077 gboolean res = FALSE;
4078 GstFormat oformat, tformat;
4079 GstClockTime now, base, latency;
4080 gint64 time, accum, duration;
4084 GST_OBJECT_LOCK (basesink);
4085 /* our intermediate time format */
4086 tformat = GST_FORMAT_TIME;
4087 /* get the format in the segment */
4088 oformat = basesink->segment.format;
4090 /* can only give answer based on the clock if not EOS */
4091 if (G_UNLIKELY (basesink->eos))
4094 /* we can only get the segment when we are not NULL or READY */
4095 if (!basesink->have_newsegment)
4098 /* when not in PLAYING or when we're busy with a state change, we
4099 * cannot read from the clock so we report time based on the
4100 * last seen timestamp. */
4101 if (GST_STATE (basesink) != GST_STATE_PLAYING ||
4102 GST_STATE_PENDING (basesink) != GST_STATE_VOID_PENDING)
4105 /* we need to sync on the clock. */
4106 if (basesink->sync == FALSE)
4109 /* and we need a clock */
4110 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (basesink)) == NULL))
4113 /* collect all data we need holding the lock */
4114 if (GST_CLOCK_TIME_IS_VALID (basesink->segment.time))
4115 time = basesink->segment.time;
4119 if (GST_CLOCK_TIME_IS_VALID (basesink->segment.stop))
4120 duration = basesink->segment.stop - basesink->segment.start;
4124 base = GST_ELEMENT_CAST (basesink)->base_time;
4125 accum = basesink->segment.accum;
4126 rate = basesink->segment.rate * basesink->segment.applied_rate;
4127 latency = basesink->priv->latency;
4129 gst_object_ref (clock);
4131 /* this function might release the LOCK */
4132 gst_base_sink_get_position_last (basesink, format, &last);
4134 /* need to release the object lock before we can get the time,
4135 * a clock might take the LOCK of the provider, which could be
4136 * a basesink subclass. */
4137 GST_OBJECT_UNLOCK (basesink);
4139 now = gst_clock_get_time (clock);
4141 if (oformat != tformat) {
4142 /* convert accum, time and duration to time */
4143 if (!gst_pad_query_convert (basesink->sinkpad, oformat, accum, &tformat,
4145 goto convert_failed;
4146 if (!gst_pad_query_convert (basesink->sinkpad, oformat, duration, &tformat,
4148 goto convert_failed;
4149 if (!gst_pad_query_convert (basesink->sinkpad, oformat, time, &tformat,
4151 goto convert_failed;
4154 /* subtract base time and accumulated time from the clock time.
4155 * Make sure we don't go negative. This is the current time in
4156 * the segment which we need to scale with the combined
4157 * rate and applied rate. */
4160 base = MIN (now, base);
4162 /* for negative rates we need to count back from from the segment
4167 *cur = time + gst_guint64_to_gdouble (now - base) * rate;
4169 /* never report more than last seen position */
4171 *cur = MIN (last, *cur);
4173 gst_object_unref (clock);
4175 GST_DEBUG_OBJECT (basesink,
4176 "now %" GST_TIME_FORMAT " - base %" GST_TIME_FORMAT " - accum %"
4177 GST_TIME_FORMAT " + time %" GST_TIME_FORMAT,
4178 GST_TIME_ARGS (now), GST_TIME_ARGS (base),
4179 GST_TIME_ARGS (accum), GST_TIME_ARGS (time));
4181 if (oformat != format) {
4182 /* convert time to final format */
4183 if (!gst_pad_query_convert (basesink->sinkpad, tformat, *cur, &format, cur))
4184 goto convert_failed;
4190 GST_DEBUG_OBJECT (basesink, "res: %d, POSITION: %" GST_TIME_FORMAT,
4191 res, GST_TIME_ARGS (*cur));
4197 GST_DEBUG_OBJECT (basesink, "position in EOS");
4198 res = gst_base_sink_get_position_last (basesink, format, cur);
4199 GST_OBJECT_UNLOCK (basesink);
4204 GST_DEBUG_OBJECT (basesink, "position in PAUSED");
4205 res = gst_base_sink_get_position_paused (basesink, format, cur);
4206 GST_OBJECT_UNLOCK (basesink);
4211 /* in NULL or READY we always return FALSE and -1 */
4212 GST_DEBUG_OBJECT (basesink, "position in wrong state, return -1");
4215 GST_OBJECT_UNLOCK (basesink);
4220 /* report last seen timestamp if any, else ask upstream to answer */
4221 if ((*cur = basesink->priv->current_sstart) != -1)
4226 GST_DEBUG_OBJECT (basesink, "no sync, res %d, POSITION %" GST_TIME_FORMAT,
4227 res, GST_TIME_ARGS (*cur));
4228 GST_OBJECT_UNLOCK (basesink);
4233 GST_DEBUG_OBJECT (basesink, "convert failed, try upstream");
4240 gst_base_sink_query (GstElement * element, GstQuery * query)
4242 gboolean res = FALSE;
4244 GstBaseSink *basesink = GST_BASE_SINK (element);
4246 switch (GST_QUERY_TYPE (query)) {
4247 case GST_QUERY_POSITION:
4251 gboolean upstream = FALSE;
4253 gst_query_parse_position (query, &format, NULL);
4255 GST_DEBUG_OBJECT (basesink, "position format %d", format);
4257 /* first try to get the position based on the clock */
4259 gst_base_sink_get_position (basesink, format, &cur, &upstream))) {
4260 gst_query_set_position (query, format, cur);
4261 } else if (upstream) {
4262 /* fallback to peer query */
4263 res = gst_base_sink_peer_query (basesink, query);
4267 case GST_QUERY_DURATION:
4269 GstFormat format, uformat;
4270 gint64 duration, uduration;
4272 gst_query_parse_duration (query, &format, NULL);
4274 GST_DEBUG_OBJECT (basesink, "duration query in format %s",
4275 gst_format_get_name (format));
4277 if (basesink->pad_mode == GST_ACTIVATE_PULL) {
4278 uformat = GST_FORMAT_BYTES;
4280 /* get the duration in bytes, in pull mode that's all we are sure to
4281 * know. We have to explicitly get this value from upstream instead of
4282 * using our cached value because it might change. Duration caching
4283 * should be done at a higher level. */
4284 res = gst_pad_query_peer_duration (basesink->sinkpad, &uformat,
4287 gst_segment_set_duration (&basesink->segment, uformat, uduration);
4288 if (format != uformat) {
4289 /* convert to the requested format */
4290 res = gst_pad_query_convert (basesink->sinkpad, uformat, uduration,
4291 &format, &duration);
4293 duration = uduration;
4296 /* set the result */
4297 gst_query_set_duration (query, format, duration);
4301 /* in push mode we simply forward upstream */
4302 res = gst_base_sink_peer_query (basesink, query);
4306 case GST_QUERY_LATENCY:
4308 gboolean live, us_live;
4309 GstClockTime min, max;
4311 if ((res = gst_base_sink_query_latency (basesink, &live, &us_live, &min,
4313 gst_query_set_latency (query, live, min, max);
4317 case GST_QUERY_JITTER:
4319 case GST_QUERY_RATE:
4320 /* gst_query_set_rate (query, basesink->segment_rate); */
4323 case GST_QUERY_SEGMENT:
4325 /* FIXME, bring start/stop to stream time */
4326 gst_query_set_segment (query, basesink->segment.rate,
4327 GST_FORMAT_TIME, basesink->segment.start, basesink->segment.stop);
4330 case GST_QUERY_SEEKING:
4331 case GST_QUERY_CONVERT:
4332 case GST_QUERY_FORMATS:
4334 res = gst_base_sink_peer_query (basesink, query);
4340 static GstStateChangeReturn
4341 gst_base_sink_change_state (GstElement * element, GstStateChange transition)
4343 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
4344 GstBaseSink *basesink = GST_BASE_SINK (element);
4345 GstBaseSinkClass *bclass;
4346 GstBaseSinkPrivate *priv;
4348 priv = basesink->priv;
4350 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4352 switch (transition) {
4353 case GST_STATE_CHANGE_NULL_TO_READY:
4355 if (!bclass->start (basesink))
4358 case GST_STATE_CHANGE_READY_TO_PAUSED:
4359 /* need to complete preroll before this state change completes, there
4360 * is no data flow in READY so we can safely assume we need to preroll. */
4361 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4362 GST_DEBUG_OBJECT (basesink, "READY to PAUSED");
4363 basesink->have_newsegment = FALSE;
4364 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
4365 gst_segment_init (basesink->abidata.ABI.clip_segment,
4366 GST_FORMAT_UNDEFINED);
4367 basesink->offset = 0;
4368 basesink->have_preroll = FALSE;
4369 priv->step_unlock = FALSE;
4370 basesink->need_preroll = TRUE;
4371 basesink->playing_async = TRUE;
4372 priv->current_sstart = -1;
4373 priv->current_sstop = -1;
4374 priv->eos_rtime = -1;
4376 basesink->eos = FALSE;
4377 priv->received_eos = FALSE;
4378 gst_base_sink_reset_qos (basesink);
4379 priv->commited = FALSE;
4380 priv->call_preroll = TRUE;
4381 priv->current_step.valid = FALSE;
4382 priv->pending_step.valid = FALSE;
4383 if (priv->async_enabled) {
4384 GST_DEBUG_OBJECT (basesink, "doing async state change");
4385 /* when async enabled, post async-start message and return ASYNC from
4386 * the state change function */
4387 ret = GST_STATE_CHANGE_ASYNC;
4388 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4389 gst_message_new_async_start (GST_OBJECT_CAST (basesink), FALSE));
4391 priv->have_latency = TRUE;
4393 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4395 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
4396 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4397 if (!gst_base_sink_needs_preroll (basesink)) {
4398 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, don't need preroll");
4399 /* no preroll needed anymore now. */
4400 basesink->playing_async = FALSE;
4401 basesink->need_preroll = FALSE;
4402 if (basesink->eos) {
4403 GstMessage *message;
4405 /* need to post EOS message here */
4406 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
4407 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
4408 gst_message_set_seqnum (message, basesink->priv->seqnum);
4409 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
4411 GST_DEBUG_OBJECT (basesink, "signal preroll");
4412 GST_PAD_PREROLL_SIGNAL (basesink->sinkpad);
4415 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, we are not prerolled");
4416 basesink->need_preroll = TRUE;
4417 basesink->playing_async = TRUE;
4418 priv->call_preroll = TRUE;
4419 priv->commited = FALSE;
4420 if (priv->async_enabled) {
4421 GST_DEBUG_OBJECT (basesink, "doing async state change");
4422 ret = GST_STATE_CHANGE_ASYNC;
4423 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4424 gst_message_new_async_start (GST_OBJECT_CAST (basesink), FALSE));
4427 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4434 GstStateChangeReturn bret;
4436 bret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
4437 if (G_UNLIKELY (bret == GST_STATE_CHANGE_FAILURE))
4438 goto activate_failed;
4441 switch (transition) {
4442 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
4443 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED");
4444 /* FIXME, make sure we cannot enter _render first */
4446 /* we need to call ::unlock before locking PREROLL_LOCK
4447 * since we lock it before going into ::render */
4449 bclass->unlock (basesink);
4451 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4452 /* now that we have the PREROLL lock, clear our unlock request */
4453 if (bclass->unlock_stop)
4454 bclass->unlock_stop (basesink);
4456 /* we need preroll again and we set the flag before unlocking the clockid
4457 * because if the clockid is unlocked before a current buffer expired, we
4458 * can use that buffer to preroll with */
4459 basesink->need_preroll = TRUE;
4461 if (basesink->clock_id) {
4462 gst_clock_id_unschedule (basesink->clock_id);
4465 /* if we don't have a preroll buffer we need to wait for a preroll and
4467 if (!gst_base_sink_needs_preroll (basesink)) {
4468 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED, we are prerolled");
4469 basesink->playing_async = FALSE;
4471 if (GST_STATE_TARGET (GST_ELEMENT (basesink)) <= GST_STATE_READY) {
4472 ret = GST_STATE_CHANGE_SUCCESS;
4474 GST_DEBUG_OBJECT (basesink,
4475 "PLAYING to PAUSED, we are not prerolled");
4476 basesink->playing_async = TRUE;
4477 priv->commited = FALSE;
4478 priv->call_preroll = TRUE;
4479 if (priv->async_enabled) {
4480 GST_DEBUG_OBJECT (basesink, "doing async state change");
4481 ret = GST_STATE_CHANGE_ASYNC;
4482 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4483 gst_message_new_async_start (GST_OBJECT_CAST (basesink),
4488 GST_DEBUG_OBJECT (basesink, "rendered: %" G_GUINT64_FORMAT
4489 ", dropped: %" G_GUINT64_FORMAT, priv->rendered, priv->dropped);
4491 gst_base_sink_reset_qos (basesink);
4492 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4494 case GST_STATE_CHANGE_PAUSED_TO_READY:
4495 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4496 /* start by reseting our position state with the object lock so that the
4497 * position query gets the right idea. We do this before we post the
4498 * messages so that the message handlers pick this up. */
4499 GST_OBJECT_LOCK (basesink);
4500 basesink->have_newsegment = FALSE;
4501 priv->current_sstart = -1;
4502 priv->current_sstop = -1;
4503 priv->have_latency = FALSE;
4504 GST_OBJECT_UNLOCK (basesink);
4506 gst_base_sink_set_last_buffer (basesink, NULL);
4507 priv->call_preroll = FALSE;
4509 if (!priv->commited) {
4510 if (priv->async_enabled) {
4511 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, posting async-done");
4513 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4514 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
4515 GST_STATE_PLAYING, GST_STATE_PAUSED, GST_STATE_READY));
4517 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4518 gst_message_new_async_done (GST_OBJECT_CAST (basesink)));
4520 priv->commited = TRUE;
4522 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, don't need_preroll");
4524 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4526 case GST_STATE_CHANGE_READY_TO_NULL:
4528 if (!bclass->stop (basesink)) {
4529 GST_WARNING_OBJECT (basesink, "failed to stop");
4532 gst_base_sink_set_last_buffer (basesink, NULL);
4533 priv->call_preroll = FALSE;
4544 GST_DEBUG_OBJECT (basesink, "failed to start");
4545 return GST_STATE_CHANGE_FAILURE;
4549 GST_DEBUG_OBJECT (basesink,
4550 "element failed to change states -- activation problem?");
4551 return GST_STATE_CHANGE_FAILURE;