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 the current segment start and remember it */
1489 if (segment->rate > 0.0)
1491 gst_segment_to_running_time (segment, segment->format, segment->start);
1494 gst_segment_to_running_time (segment, segment->format, segment->stop);
1496 /* set the new rate */
1497 segment->rate = segment->rate * current->rate;
1499 GST_DEBUG_OBJECT (sink, "step started at running_time %" GST_TIME_FORMAT,
1500 GST_TIME_ARGS (current->start));
1502 if (current->amount == -1) {
1503 GST_DEBUG_OBJECT (sink, "step amount == -1, stop stepping");
1504 current->valid = FALSE;
1506 GST_DEBUG_OBJECT (sink, "step amount: %" G_GUINT64_FORMAT ", format: %s, "
1507 "rate: %f", current->amount, gst_format_get_name (current->format),
1513 stop_stepping (GstBaseSink * sink, GstSegment * segment,
1514 GstStepInfo * current, guint64 cstart, guint64 cstop, gint64 * rstart,
1517 GstMessage *message;
1519 GST_DEBUG_OBJECT (sink, "step complete");
1522 /* update the segment, discarding what was consumed, running time goes
1523 * backwards with the duration of the data we skipped. FIXME, this only works
1525 if (segment->rate > 0.0) {
1526 GST_DEBUG_OBJECT (sink,
1527 "step stop at running_time %" GST_TIME_FORMAT ", timestamp %"
1528 GST_TIME_FORMAT, GST_TIME_ARGS (*rstart), GST_TIME_ARGS (cstart));
1529 current->duration = *rstart - current->start;
1532 gst_segment_to_stream_time (segment, segment->format, cstart);
1533 segment->start = cstart;
1535 *rstart = current->start;
1536 *rstop -= current->duration;
1538 GST_DEBUG_OBJECT (sink,
1539 "step stop at running_time %" GST_TIME_FORMAT ", timestamp %"
1540 GST_TIME_FORMAT, GST_TIME_ARGS (*rstop), GST_TIME_ARGS (cstop));
1541 current->duration = *rstop - current->start;
1543 segment->stop = cstop;
1544 *rstop = current->start;
1545 *rstart -= current->duration;
1547 segment->accum = current->start;
1549 GST_DEBUG_OBJECT (sink, "step elapsed running_time %" GST_TIME_FORMAT,
1550 GST_TIME_ARGS (current->duration));
1552 /* the clip segment is used for position report in paused... */
1553 memcpy (sink->abidata.ABI.clip_segment, segment, sizeof (GstSegment));
1556 gst_message_new_step_done (GST_OBJECT_CAST (sink), current->format,
1557 current->amount, current->rate, current->flush, current->intermediate,
1559 gst_message_set_seqnum (message, current->seqnum);
1560 gst_element_post_message (GST_ELEMENT_CAST (sink), message);
1562 if (!current->intermediate)
1563 sink->need_preroll = current->need_preroll;
1565 /* and the current step info finished and becomes invalid */
1566 current->valid = FALSE;
1570 handle_stepping (GstBaseSink * sink, GstSegment * segment,
1571 GstStepInfo * current, gint64 * cstart, gint64 * cstop, gint64 * rstart,
1574 GstBaseSinkPrivate *priv;
1575 gboolean step_end = FALSE;
1579 /* see if we need to skip this buffer because of stepping */
1580 switch (current->format) {
1581 case GST_FORMAT_TIME:
1586 end = current->start + current->amount;
1588 if (segment->rate > 0.0) {
1589 current->position = *rstart - current->start;
1592 current->position = *rstop - current->start;
1596 GST_DEBUG_OBJECT (sink,
1597 "got time step %" GST_TIME_FORMAT "/%" GST_TIME_FORMAT,
1598 GST_TIME_ARGS (current->position), GST_TIME_ARGS (current->amount));
1600 if (current->position >= current->amount || last >= end) {
1602 if (segment->rate > 0.0) {
1603 *cstart += end - *rstart;
1606 *cstop += end - *rstop;
1612 case GST_FORMAT_BUFFERS:
1613 GST_DEBUG_OBJECT (sink,
1614 "got default step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1615 current->position, current->amount);
1617 if (current->position < current->amount) {
1618 current->position++;
1623 case GST_FORMAT_DEFAULT:
1625 GST_DEBUG_OBJECT (sink,
1626 "got unknown step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1627 current->position, current->amount);
1633 /* with STREAM_LOCK, PREROLL_LOCK
1635 * Returns TRUE if the object needs synchronisation and takes therefore
1636 * part in prerolling.
1638 * rsstart/rsstop contain the start/stop in stream time.
1639 * rrstart/rrstop contain the start/stop in running time.
1642 gst_base_sink_get_sync_times (GstBaseSink * basesink, GstMiniObject * obj,
1643 GstClockTime * rsstart, GstClockTime * rsstop,
1644 GstClockTime * rrstart, GstClockTime * rrstop, gboolean * do_sync,
1645 gboolean * stepped, GstSegment * segment, GstStepInfo * step)
1647 GstBaseSinkClass *bclass;
1649 GstClockTime start, stop; /* raw start/stop timestamps */
1650 gint64 cstart, cstop; /* clipped raw timestamps */
1651 gint64 rstart, rstop; /* clipped timestamps converted to running time */
1652 GstClockTime sstart, sstop; /* clipped timestamps converted to stream time */
1654 GstBaseSinkPrivate *priv;
1657 priv = basesink->priv;
1659 /* start with nothing */
1664 if (G_UNLIKELY (GST_IS_EVENT (obj))) {
1665 GstEvent *event = GST_EVENT_CAST (obj);
1667 switch (GST_EVENT_TYPE (event)) {
1668 /* EOS event needs syncing */
1671 if (basesink->segment.rate >= 0.0) {
1672 sstart = sstop = priv->current_sstop;
1674 /* we have not seen a buffer yet, use the segment values */
1675 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1676 basesink->segment.format, basesink->segment.stop);
1679 sstart = sstop = priv->current_sstart;
1681 /* we have not seen a buffer yet, use the segment values */
1682 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1683 basesink->segment.format, basesink->segment.start);
1687 rstart = rstop = priv->eos_rtime;
1688 *do_sync = rstart != -1;
1689 GST_DEBUG_OBJECT (basesink, "sync times for EOS %" GST_TIME_FORMAT,
1690 GST_TIME_ARGS (rstart));
1691 /* if we are stepping, we end now */
1692 step_end = step->valid;
1696 /* other events do not need syncing */
1697 /* FIXME, maybe NEWSEGMENT might need synchronisation
1698 * since the POSITION query depends on accumulated times and
1699 * we cannot accumulate the current segment before the previous
1706 /* else do buffer sync code */
1707 buffer = GST_BUFFER_CAST (obj);
1709 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1711 /* just get the times to see if we need syncing, if the start returns -1 we
1713 if (bclass->get_times)
1714 bclass->get_times (basesink, buffer, &start, &stop);
1717 /* we don't need to sync but we still want to get the timestamps for
1718 * tracking the position */
1719 gst_base_sink_get_times (basesink, buffer, &start, &stop);
1725 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
1726 ", stop: %" GST_TIME_FORMAT ", do_sync %d", GST_TIME_ARGS (start),
1727 GST_TIME_ARGS (stop), *do_sync);
1729 /* collect segment and format for code clarity */
1730 format = segment->format;
1732 /* no timestamp clipping if we did not get a TIME segment format */
1733 if (G_UNLIKELY (format != GST_FORMAT_TIME)) {
1736 /* do running and stream time in TIME format */
1737 format = GST_FORMAT_TIME;
1738 GST_LOG_OBJECT (basesink, "not time format, don't clip");
1742 /* clip, only when we know about time */
1743 if (G_UNLIKELY (!gst_segment_clip (segment, GST_FORMAT_TIME,
1744 (gint64) start, (gint64) stop, &cstart, &cstop)))
1745 goto out_of_segment;
1747 if (G_UNLIKELY (start != cstart || stop != cstop)) {
1748 GST_DEBUG_OBJECT (basesink, "clipped to: start %" GST_TIME_FORMAT
1749 ", stop: %" GST_TIME_FORMAT, GST_TIME_ARGS (cstart),
1750 GST_TIME_ARGS (cstop));
1753 /* set last stop position */
1754 if (G_LIKELY (cstop != GST_CLOCK_TIME_NONE))
1755 gst_segment_set_last_stop (segment, GST_FORMAT_TIME, cstop);
1757 gst_segment_set_last_stop (segment, GST_FORMAT_TIME, cstart);
1760 /* this can produce wrong values if we accumulated non-TIME segments. If this happens,
1761 * upstream is behaving very badly */
1762 sstart = gst_segment_to_stream_time (segment, format, cstart);
1763 sstop = gst_segment_to_stream_time (segment, format, cstop);
1764 rstart = gst_segment_to_running_time (segment, format, cstart);
1765 rstop = gst_segment_to_running_time (segment, format, cstop);
1767 if (G_UNLIKELY (step->valid)) {
1768 if (!(step_end = handle_stepping (basesink, segment, step, &cstart, &cstop,
1774 /* done label only called when doing EOS, we also stop stepping then */
1776 stop_stepping (basesink, segment, step, cstart, cstop, &rstart, &rstop);
1784 /* buffers and EOS always need syncing and preroll */
1790 /* should not happen since we clip them in the chain function already,
1791 * we return FALSE so that we don't try to sync on it. */
1792 GST_ELEMENT_WARNING (basesink, STREAM, FAILED,
1793 (NULL), ("unexpected buffer out of segment found."));
1794 GST_LOG_OBJECT (basesink, "buffer skipped, not in segment");
1799 /* with STREAM_LOCK, PREROLL_LOCK, LOCK
1800 * adjust a timestamp with the latency and timestamp offset */
1802 gst_base_sink_adjust_time (GstBaseSink * basesink, GstClockTime time)
1804 GstClockTimeDiff ts_offset;
1806 /* don't do anything funny with invalid timestamps */
1807 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
1810 time += basesink->priv->latency;
1812 /* apply offset, be carefull for underflows */
1813 ts_offset = basesink->priv->ts_offset;
1814 if (ts_offset < 0) {
1815 ts_offset = -ts_offset;
1816 if (ts_offset < time)
1827 * gst_base_sink_wait_clock:
1829 * @time: the running_time to be reached
1830 * @jitter: the jitter to be filled with time diff (can be NULL)
1832 * This function will block until @time is reached. It is usually called by
1833 * subclasses that use their own internal synchronisation.
1835 * If @time is not valid, no sycnhronisation is done and #GST_CLOCK_BADTIME is
1836 * returned. Likewise, if synchronisation is disabled in the element or there
1837 * is no clock, no synchronisation is done and #GST_CLOCK_BADTIME is returned.
1839 * This function should only be called with the PREROLL_LOCK held, like when
1840 * receiving an EOS event in the ::event vmethod or when receiving a buffer in
1841 * the ::render vmethod.
1843 * The @time argument should be the running_time of when this method should
1844 * return and is not adjusted with any latency or offset configured in the
1849 * Returns: #GstClockReturn
1852 gst_base_sink_wait_clock (GstBaseSink * sink, GstClockTime time,
1853 GstClockTimeDiff * jitter)
1859 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
1862 GST_OBJECT_LOCK (sink);
1863 if (G_UNLIKELY (!sink->sync))
1866 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (sink)) == NULL))
1869 /* add base_time to running_time to get the time against the clock */
1870 time += GST_ELEMENT_CAST (sink)->base_time;
1872 id = gst_clock_new_single_shot_id (clock, time);
1873 GST_OBJECT_UNLOCK (sink);
1875 /* A blocking wait is performed on the clock. We save the ClockID
1876 * so we can unlock the entry at any time. While we are blocking, we
1877 * release the PREROLL_LOCK so that other threads can interrupt the
1879 sink->clock_id = id;
1880 /* release the preroll lock while waiting */
1881 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
1883 ret = gst_clock_id_wait (id, jitter);
1885 GST_PAD_PREROLL_LOCK (sink->sinkpad);
1886 gst_clock_id_unref (id);
1887 sink->clock_id = NULL;
1891 /* no syncing needed */
1894 GST_DEBUG_OBJECT (sink, "time not valid, no sync needed");
1895 return GST_CLOCK_BADTIME;
1899 GST_DEBUG_OBJECT (sink, "sync disabled");
1900 GST_OBJECT_UNLOCK (sink);
1901 return GST_CLOCK_BADTIME;
1905 GST_DEBUG_OBJECT (sink, "no clock, can't sync");
1906 GST_OBJECT_UNLOCK (sink);
1907 return GST_CLOCK_BADTIME;
1912 * gst_base_sink_wait_preroll:
1915 * If the #GstBaseSinkClass::render method performs its own synchronisation against
1916 * the clock it must unblock when going from PLAYING to the PAUSED state and call
1917 * this method before continuing to render the remaining data.
1919 * This function will block until a state change to PLAYING happens (in which
1920 * case this function returns #GST_FLOW_OK) or the processing must be stopped due
1921 * to a state change to READY or a FLUSH event (in which case this function
1922 * returns #GST_FLOW_WRONG_STATE).
1924 * This function should only be called with the PREROLL_LOCK held, like in the
1929 * Returns: #GST_FLOW_OK if the preroll completed and processing can
1930 * continue. Any other return value should be returned from the render vmethod.
1933 gst_base_sink_wait_preroll (GstBaseSink * sink)
1935 sink->have_preroll = TRUE;
1936 GST_DEBUG_OBJECT (sink, "waiting in preroll for flush or PLAYING");
1937 /* block until the state changes, or we get a flush, or something */
1938 GST_PAD_PREROLL_WAIT (sink->sinkpad);
1939 sink->have_preroll = FALSE;
1940 if (G_UNLIKELY (sink->flushing))
1942 if (G_UNLIKELY (sink->priv->step_unlock))
1944 GST_DEBUG_OBJECT (sink, "continue after preroll");
1951 GST_DEBUG_OBJECT (sink, "preroll interrupted because of flush");
1952 return GST_FLOW_WRONG_STATE;
1956 sink->priv->step_unlock = FALSE;
1957 GST_DEBUG_OBJECT (sink, "preroll interrupted because of step");
1958 return GST_FLOW_STEP;
1963 * gst_base_sink_do_preroll:
1965 * @obj: the object that caused the preroll
1967 * If the @sink spawns its own thread for pulling buffers from upstream it
1968 * should call this method after it has pulled a buffer. If the element needed
1969 * to preroll, this function will perform the preroll and will then block
1970 * until the element state is changed.
1972 * This function should be called with the PREROLL_LOCK held.
1976 * Returns: #GST_FLOW_OK if the preroll completed and processing can
1977 * continue. Any other return value should be returned from the render vmethod.
1980 gst_base_sink_do_preroll (GstBaseSink * sink, GstMiniObject * obj)
1984 while (G_UNLIKELY (sink->need_preroll)) {
1985 GST_DEBUG_OBJECT (sink, "prerolling object %p", obj);
1987 ret = gst_base_sink_preroll_object (sink, obj);
1988 if (ret != GST_FLOW_OK)
1989 goto preroll_failed;
1991 /* need to recheck here because the commit state could have
1992 * made us not need the preroll anymore */
1993 if (G_LIKELY (sink->need_preroll)) {
1994 /* block until the state changes, or we get a flush, or something */
1995 ret = gst_base_sink_wait_preroll (sink);
1996 if (ret != GST_FLOW_OK) {
1997 if (ret == GST_FLOW_STEP)
2000 goto preroll_failed;
2009 GST_DEBUG_OBJECT (sink, "preroll failed %d", ret);
2015 * gst_base_sink_wait_eos:
2017 * @time: the running_time to be reached
2018 * @jitter: the jitter to be filled with time diff (can be NULL)
2020 * This function will block until @time is reached. It is usually called by
2021 * subclasses that use their own internal synchronisation but want to let the
2022 * EOS be handled by the base class.
2024 * This function should only be called with the PREROLL_LOCK held, like when
2025 * receiving an EOS event in the ::event vmethod.
2027 * The @time argument should be the running_time of when the EOS should happen
2028 * and will be adjusted with any latency and offset configured in the sink.
2032 * Returns: #GstFlowReturn
2035 gst_base_sink_wait_eos (GstBaseSink * sink, GstClockTime time,
2036 GstClockTimeDiff * jitter)
2038 GstClockReturn status;
2044 GST_DEBUG_OBJECT (sink, "checking preroll");
2046 /* first wait for the playing state before we can continue */
2047 if (G_UNLIKELY (sink->need_preroll)) {
2048 ret = gst_base_sink_wait_preroll (sink);
2049 if (ret != GST_FLOW_OK) {
2050 if (ret == GST_FLOW_STEP)
2057 /* preroll done, we can sync since we are in PLAYING now. */
2058 GST_DEBUG_OBJECT (sink, "possibly waiting for clock to reach %"
2059 GST_TIME_FORMAT, GST_TIME_ARGS (time));
2061 /* compensate for latency and ts_offset. We don't adjust for render delay
2062 * because we don't interact with the device on EOS normally. */
2063 stime = gst_base_sink_adjust_time (sink, time);
2065 /* wait for the clock, this can be interrupted because we got shut down or
2067 status = gst_base_sink_wait_clock (sink, stime, jitter);
2069 GST_DEBUG_OBJECT (sink, "clock returned %d", status);
2071 /* invalid time, no clock or sync disabled, just continue then */
2072 if (status == GST_CLOCK_BADTIME)
2075 /* waiting could have been interrupted and we can be flushing now */
2076 if (G_UNLIKELY (sink->flushing))
2079 /* retry if we got unscheduled, which means we did not reach the timeout
2080 * yet. if some other error occures, we continue. */
2081 } while (status == GST_CLOCK_UNSCHEDULED);
2083 GST_DEBUG_OBJECT (sink, "end of stream");
2090 GST_DEBUG_OBJECT (sink, "we are flushing");
2091 return GST_FLOW_WRONG_STATE;
2095 /* with STREAM_LOCK, PREROLL_LOCK
2097 * Make sure we are in PLAYING and synchronize an object to the clock.
2099 * If we need preroll, we are not in PLAYING. We try to commit the state
2100 * if needed and then block if we still are not PLAYING.
2102 * We start waiting on the clock in PLAYING. If we got interrupted, we
2103 * immediatly try to re-preroll.
2105 * Some objects do not need synchronisation (most events) and so this function
2106 * immediatly returns GST_FLOW_OK.
2108 * for objects that arrive later than max-lateness to be synchronized to the
2109 * clock have the @late boolean set to TRUE.
2111 * This function keeps a running average of the jitter (the diff between the
2112 * clock time and the requested sync time). The jitter is negative for
2113 * objects that arrive in time and positive for late buffers.
2115 * does not take ownership of obj.
2117 static GstFlowReturn
2118 gst_base_sink_do_sync (GstBaseSink * basesink, GstPad * pad,
2119 GstMiniObject * obj, gboolean * late)
2121 GstClockTimeDiff jitter;
2123 GstClockReturn status = GST_CLOCK_OK;
2124 GstClockTime rstart, rstop, sstart, sstop, stime;
2126 GstBaseSinkPrivate *priv;
2128 GstStepInfo *current, *pending;
2131 priv = basesink->priv;
2134 sstart = sstop = rstart = rstop = -1;
2138 priv->current_rstart = -1;
2140 /* get stepping info */
2141 current = &priv->current_step;
2142 pending = &priv->pending_step;
2144 /* get timing information for this object against the render segment */
2145 syncable = gst_base_sink_get_sync_times (basesink, obj,
2146 &sstart, &sstop, &rstart, &rstop, &do_sync, &stepped, &basesink->segment,
2149 if (G_UNLIKELY (stepped))
2152 /* a syncable object needs to participate in preroll and
2153 * clocking. All buffers and EOS are syncable. */
2154 if (G_UNLIKELY (!syncable))
2157 /* store timing info for current object */
2158 priv->current_rstart = rstart;
2159 priv->current_rstop = (rstop != -1 ? rstop : rstart);
2161 /* save sync time for eos when the previous object needed sync */
2162 priv->eos_rtime = (do_sync ? priv->current_rstop : -1);
2165 /* first do preroll, this makes sure we commit our state
2166 * to PAUSED and can continue to PLAYING. We cannot perform
2167 * any clock sync in PAUSED because there is no clock. */
2168 ret = gst_base_sink_do_preroll (basesink, obj);
2169 if (G_UNLIKELY (ret != GST_FLOW_OK))
2170 goto preroll_failed;
2172 /* update the segment with a pending step if the current one is invalid and we
2173 * have a new pending one. We only accept new step updates after a preroll */
2174 if (G_UNLIKELY (pending->valid && !current->valid)) {
2175 start_stepping (basesink, &basesink->segment, pending, current);
2179 /* After rendering we store the position of the last buffer so that we can use
2180 * it to report the position. We need to take the lock here. */
2181 GST_OBJECT_LOCK (basesink);
2182 priv->current_sstart = sstart;
2183 priv->current_sstop = (sstop != -1 ? sstop : sstart);
2184 GST_OBJECT_UNLOCK (basesink);
2189 /* adjust for latency */
2190 stime = gst_base_sink_adjust_time (basesink, rstart);
2192 /* adjust for render-delay, avoid underflows */
2194 if (stime > priv->render_delay)
2195 stime -= priv->render_delay;
2200 /* preroll done, we can sync since we are in PLAYING now. */
2201 GST_DEBUG_OBJECT (basesink, "possibly waiting for clock to reach %"
2202 GST_TIME_FORMAT ", adjusted %" GST_TIME_FORMAT,
2203 GST_TIME_ARGS (rstart), GST_TIME_ARGS (stime));
2205 /* This function will return immediatly if start == -1, no clock
2206 * or sync is disabled with GST_CLOCK_BADTIME. */
2207 status = gst_base_sink_wait_clock (basesink, stime, &jitter);
2209 GST_DEBUG_OBJECT (basesink, "clock returned %d", status);
2211 /* invalid time, no clock or sync disabled, just render */
2212 if (status == GST_CLOCK_BADTIME)
2215 /* waiting could have been interrupted and we can be flushing now */
2216 if (G_UNLIKELY (basesink->flushing))
2219 /* check for unlocked by a state change, we are not flushing so
2220 * we can try to preroll on the current buffer. */
2221 if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED)) {
2222 GST_DEBUG_OBJECT (basesink, "unscheduled, waiting some more");
2223 priv->call_preroll = TRUE;
2227 /* successful syncing done, record observation */
2228 priv->current_jitter = jitter;
2230 /* check if the object should be dropped */
2231 *late = gst_base_sink_is_too_late (basesink, obj, rstart, rstop,
2240 GST_DEBUG_OBJECT (basesink, "skipped stepped object %p", obj);
2246 GST_DEBUG_OBJECT (basesink, "non syncable object %p", obj);
2251 GST_DEBUG_OBJECT (basesink, "we are flushing");
2252 return GST_FLOW_WRONG_STATE;
2256 GST_DEBUG_OBJECT (basesink, "preroll failed");
2262 gst_base_sink_send_qos (GstBaseSink * basesink,
2263 gdouble proportion, GstClockTime time, GstClockTimeDiff diff)
2268 /* generate Quality-of-Service event */
2269 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2270 "qos: proportion: %lf, diff %" G_GINT64_FORMAT ", timestamp %"
2271 GST_TIME_FORMAT, proportion, diff, GST_TIME_ARGS (time));
2273 event = gst_event_new_qos (proportion, diff, time);
2276 res = gst_pad_push_event (basesink->sinkpad, event);
2282 gst_base_sink_perform_qos (GstBaseSink * sink, gboolean dropped)
2284 GstBaseSinkPrivate *priv;
2285 GstClockTime start, stop;
2286 GstClockTimeDiff jitter;
2287 GstClockTime pt, entered, left;
2288 GstClockTime duration;
2293 start = priv->current_rstart;
2295 /* if Quality-of-Service disabled, do nothing */
2296 if (!g_atomic_int_get (&priv->qos_enabled) || start == -1)
2299 stop = priv->current_rstop;
2300 jitter = priv->current_jitter;
2303 /* this is the time the buffer entered the sink */
2304 if (start < -jitter)
2307 entered = start + jitter;
2310 /* this is the time the buffer entered the sink */
2311 entered = start + jitter;
2312 /* this is the time the buffer left the sink */
2313 left = start + jitter;
2316 /* calculate duration of the buffer */
2318 duration = stop - start;
2322 /* if we have the time when the last buffer left us, calculate
2323 * processing time */
2324 if (priv->last_left != -1) {
2325 if (entered > priv->last_left) {
2326 pt = entered - priv->last_left;
2334 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "start: %" GST_TIME_FORMAT
2335 ", entered %" GST_TIME_FORMAT ", left %" GST_TIME_FORMAT ", pt: %"
2336 GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT ",jitter %"
2337 G_GINT64_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (entered),
2338 GST_TIME_ARGS (left), GST_TIME_ARGS (pt), GST_TIME_ARGS (duration),
2341 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "avg_duration: %" GST_TIME_FORMAT
2342 ", avg_pt: %" GST_TIME_FORMAT ", avg_rate: %g",
2343 GST_TIME_ARGS (priv->avg_duration), GST_TIME_ARGS (priv->avg_pt),
2346 /* collect running averages. for first observations, we copy the
2348 if (priv->avg_duration == -1)
2349 priv->avg_duration = duration;
2351 priv->avg_duration = UPDATE_RUNNING_AVG (priv->avg_duration, duration);
2353 if (priv->avg_pt == -1)
2356 priv->avg_pt = UPDATE_RUNNING_AVG (priv->avg_pt, pt);
2358 if (priv->avg_duration != 0)
2360 gst_guint64_to_gdouble (priv->avg_pt) /
2361 gst_guint64_to_gdouble (priv->avg_duration);
2365 if (priv->last_left != -1) {
2366 if (dropped || priv->avg_rate < 0.0) {
2367 priv->avg_rate = rate;
2370 priv->avg_rate = UPDATE_RUNNING_AVG_N (priv->avg_rate, rate);
2372 priv->avg_rate = UPDATE_RUNNING_AVG_P (priv->avg_rate, rate);
2376 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink,
2377 "updated: avg_duration: %" GST_TIME_FORMAT ", avg_pt: %" GST_TIME_FORMAT
2378 ", avg_rate: %g", GST_TIME_ARGS (priv->avg_duration),
2379 GST_TIME_ARGS (priv->avg_pt), priv->avg_rate);
2382 if (priv->avg_rate >= 0.0) {
2383 /* if we have a valid rate, start sending QoS messages */
2384 if (priv->current_jitter < 0) {
2385 /* make sure we never go below 0 when adding the jitter to the
2387 if (priv->current_rstart < -priv->current_jitter)
2388 priv->current_jitter = -priv->current_rstart;
2390 gst_base_sink_send_qos (sink, priv->avg_rate, priv->current_rstart,
2391 priv->current_jitter);
2394 /* record when this buffer will leave us */
2395 priv->last_left = left;
2398 /* reset all qos measuring */
2400 gst_base_sink_reset_qos (GstBaseSink * sink)
2402 GstBaseSinkPrivate *priv;
2406 priv->last_in_time = -1;
2407 priv->last_left = -1;
2408 priv->avg_duration = -1;
2410 priv->avg_rate = -1.0;
2411 priv->avg_render = -1;
2417 /* Checks if the object was scheduled too late.
2419 * start/stop contain the raw timestamp start and stop values
2422 * status and jitter contain the return values from the clock wait.
2424 * returns TRUE if the buffer was too late.
2427 gst_base_sink_is_too_late (GstBaseSink * basesink, GstMiniObject * obj,
2428 GstClockTime start, GstClockTime stop,
2429 GstClockReturn status, GstClockTimeDiff jitter)
2432 gint64 max_lateness;
2433 GstBaseSinkPrivate *priv;
2435 priv = basesink->priv;
2439 /* only for objects that were too late */
2440 if (G_LIKELY (status != GST_CLOCK_EARLY))
2443 max_lateness = basesink->abidata.ABI.max_lateness;
2445 /* check if frame dropping is enabled */
2446 if (max_lateness == -1)
2449 /* only check for buffers */
2450 if (G_UNLIKELY (!GST_IS_BUFFER (obj)))
2453 /* can't do check if we don't have a timestamp */
2454 if (G_UNLIKELY (start == -1))
2457 /* we can add a valid stop time */
2459 max_lateness += stop;
2461 max_lateness += start;
2463 /* if the jitter bigger than duration and lateness we are too late */
2464 if ((late = start + jitter > max_lateness)) {
2465 GST_DEBUG_OBJECT (basesink, "buffer is too late %" GST_TIME_FORMAT
2466 " > %" GST_TIME_FORMAT, GST_TIME_ARGS (start + jitter),
2467 GST_TIME_ARGS (max_lateness));
2468 /* !!emergency!!, if we did not receive anything valid for more than a
2469 * second, render it anyway so the user sees something */
2470 if (priv->last_in_time != -1 && start - priv->last_in_time > GST_SECOND) {
2472 GST_DEBUG_OBJECT (basesink,
2473 "**emergency** last buffer at %" GST_TIME_FORMAT " > GST_SECOND",
2474 GST_TIME_ARGS (priv->last_in_time));
2480 priv->last_in_time = start;
2487 GST_DEBUG_OBJECT (basesink, "object was scheduled in time");
2492 GST_DEBUG_OBJECT (basesink, "frame dropping disabled");
2497 GST_DEBUG_OBJECT (basesink, "object is not a buffer");
2502 GST_DEBUG_OBJECT (basesink, "buffer has no timestamp");
2507 /* called before and after calling the render vmethod. It keeps track of how
2508 * much time was spent in the render method and is used to check if we are
2511 gst_base_sink_do_render_stats (GstBaseSink * basesink, gboolean start)
2513 GstBaseSinkPrivate *priv;
2515 priv = basesink->priv;
2518 priv->start = gst_util_get_timestamp ();
2520 GstClockTime elapsed;
2522 priv->stop = gst_util_get_timestamp ();
2524 elapsed = GST_CLOCK_DIFF (priv->start, priv->stop);
2526 if (priv->avg_render == -1)
2527 priv->avg_render = elapsed;
2529 priv->avg_render = UPDATE_RUNNING_AVG (priv->avg_render, elapsed);
2531 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2532 "avg_render: %" GST_TIME_FORMAT, GST_TIME_ARGS (priv->avg_render));
2536 /* with STREAM_LOCK, PREROLL_LOCK,
2538 * Synchronize the object on the clock and then render it.
2540 * takes ownership of obj.
2542 static GstFlowReturn
2543 gst_base_sink_render_object (GstBaseSink * basesink, GstPad * pad,
2544 GstMiniObject * obj)
2547 GstBaseSinkClass *bclass;
2550 GstBaseSinkPrivate *priv;
2552 priv = basesink->priv;
2558 /* synchronize this object, non syncable objects return OK
2560 ret = gst_base_sink_do_sync (basesink, pad, obj, &late);
2561 if (G_UNLIKELY (ret != GST_FLOW_OK))
2564 /* and now render, event or buffer. */
2565 if (G_LIKELY (GST_IS_BUFFER (obj))) {
2568 /* drop late buffers unconditionally, let's hope it's unlikely */
2569 if (G_UNLIKELY (late))
2572 buf = GST_BUFFER_CAST (obj);
2574 gst_base_sink_set_last_buffer (basesink, buf);
2576 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2578 if (G_LIKELY (bclass->render)) {
2581 /* read once, to get same value before and after */
2582 do_qos = g_atomic_int_get (&priv->qos_enabled);
2584 GST_DEBUG_OBJECT (basesink, "rendering buffer %p", obj);
2586 /* record rendering time for QoS and stats */
2588 gst_base_sink_do_render_stats (basesink, TRUE);
2590 ret = bclass->render (basesink, buf);
2593 gst_base_sink_do_render_stats (basesink, FALSE);
2595 if (ret == GST_FLOW_STEP)
2601 GstEvent *event = GST_EVENT_CAST (obj);
2602 gboolean event_res = TRUE;
2605 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2607 type = GST_EVENT_TYPE (event);
2609 GST_DEBUG_OBJECT (basesink, "rendering event %p, type %s", obj,
2610 gst_event_type_get_name (type));
2613 event_res = bclass->event (basesink, event);
2615 /* when we get here we could be flushing again when the event handler calls
2616 * _wait_eos(). We have to ignore this object in that case. */
2617 if (G_UNLIKELY (basesink->flushing))
2620 if (G_LIKELY (event_res)) {
2623 seqnum = basesink->priv->seqnum = gst_event_get_seqnum (event);
2624 GST_DEBUG_OBJECT (basesink, "Got seqnum #%" G_GUINT32_FORMAT, seqnum);
2629 GstMessage *message;
2631 /* the EOS event is completely handled so we mark
2632 * ourselves as being in the EOS state. eos is also
2633 * protected by the object lock so we can read it when
2634 * answering the POSITION query. */
2635 GST_OBJECT_LOCK (basesink);
2636 basesink->eos = TRUE;
2637 GST_OBJECT_UNLOCK (basesink);
2639 /* ok, now we can post the message */
2640 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
2642 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
2643 gst_message_set_seqnum (message, seqnum);
2644 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
2647 case GST_EVENT_NEWSEGMENT:
2648 /* configure the segment */
2649 gst_base_sink_configure_segment (basesink, pad, event,
2650 &basesink->segment);
2659 gst_base_sink_perform_qos (basesink, late);
2661 GST_DEBUG_OBJECT (basesink, "object unref after render %p", obj);
2662 gst_mini_object_unref (obj);
2669 GST_DEBUG_OBJECT (basesink, "do_sync returned %s", gst_flow_get_name (ret));
2675 GST_DEBUG_OBJECT (basesink, "buffer late, dropping");
2680 GST_DEBUG_OBJECT (basesink, "we are flushing, ignore object");
2681 gst_mini_object_unref (obj);
2682 return GST_FLOW_WRONG_STATE;
2686 /* with STREAM_LOCK, PREROLL_LOCK
2688 * Perform preroll on the given object. For buffers this means
2689 * calling the preroll subclass method.
2690 * If that succeeds, the state will be commited.
2692 * function does not take ownership of obj.
2694 static GstFlowReturn
2695 gst_base_sink_preroll_object (GstBaseSink * basesink, GstMiniObject * obj)
2699 GST_DEBUG_OBJECT (basesink, "prerolling object %p", obj);
2701 /* if it's a buffer, we need to call the preroll method */
2702 if (G_LIKELY (GST_IS_BUFFER (obj)) && basesink->priv->call_preroll) {
2703 GstBaseSinkClass *bclass;
2705 GstClockTime timestamp;
2707 buf = GST_BUFFER_CAST (obj);
2708 timestamp = GST_BUFFER_TIMESTAMP (buf);
2710 GST_DEBUG_OBJECT (basesink, "preroll buffer %" GST_TIME_FORMAT,
2711 GST_TIME_ARGS (timestamp));
2713 gst_base_sink_set_last_buffer (basesink, buf);
2715 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2716 if (bclass->preroll)
2717 if ((ret = bclass->preroll (basesink, buf)) != GST_FLOW_OK)
2718 goto preroll_failed;
2720 basesink->priv->call_preroll = FALSE;
2724 if (G_LIKELY (basesink->playing_async)) {
2725 if (G_UNLIKELY (!gst_base_sink_commit_state (basesink)))
2734 GST_DEBUG_OBJECT (basesink, "preroll failed, abort state");
2735 gst_element_abort_state (GST_ELEMENT_CAST (basesink));
2740 GST_DEBUG_OBJECT (basesink, "stopping while commiting state");
2741 return GST_FLOW_WRONG_STATE;
2745 /* with STREAM_LOCK, PREROLL_LOCK
2747 * Queue an object for rendering.
2748 * The first prerollable object queued will complete the preroll. If the
2749 * preroll queue if filled, we render all the objects in the queue.
2751 * This function takes ownership of the object.
2753 static GstFlowReturn
2754 gst_base_sink_queue_object_unlocked (GstBaseSink * basesink, GstPad * pad,
2755 GstMiniObject * obj, gboolean prerollable)
2757 GstFlowReturn ret = GST_FLOW_OK;
2761 if (G_UNLIKELY (basesink->need_preroll)) {
2762 if (G_LIKELY (prerollable))
2763 basesink->preroll_queued++;
2765 length = basesink->preroll_queued;
2767 GST_DEBUG_OBJECT (basesink, "now %d prerolled items", length);
2769 /* first prerollable item needs to finish the preroll */
2771 ret = gst_base_sink_preroll_object (basesink, obj);
2772 if (G_UNLIKELY (ret != GST_FLOW_OK))
2773 goto preroll_failed;
2775 /* need to recheck if we need preroll, commmit state during preroll
2776 * could have made us not need more preroll. */
2777 if (G_UNLIKELY (basesink->need_preroll)) {
2778 /* see if we can render now, if we can't add the object to the preroll
2780 if (G_UNLIKELY (length <= basesink->preroll_queue_max_len))
2785 /* we can start rendering (or blocking) the queued object
2787 q = basesink->preroll_queue;
2788 while (G_UNLIKELY (!g_queue_is_empty (q))) {
2791 o = g_queue_pop_head (q);
2792 GST_DEBUG_OBJECT (basesink, "rendering queued object %p", o);
2794 /* do something with the return value */
2795 ret = gst_base_sink_render_object (basesink, pad, o);
2796 if (ret != GST_FLOW_OK)
2797 goto dequeue_failed;
2800 /* now render the object */
2801 ret = gst_base_sink_render_object (basesink, pad, obj);
2802 basesink->preroll_queued = 0;
2809 GST_DEBUG_OBJECT (basesink, "preroll failed, reason %s",
2810 gst_flow_get_name (ret));
2811 gst_mini_object_unref (obj);
2816 /* add object to the queue and return */
2817 GST_DEBUG_OBJECT (basesink, "need more preroll data %d <= %d",
2818 length, basesink->preroll_queue_max_len);
2819 g_queue_push_tail (basesink->preroll_queue, obj);
2824 GST_DEBUG_OBJECT (basesink, "rendering queued objects failed, reason %s",
2825 gst_flow_get_name (ret));
2826 gst_mini_object_unref (obj);
2833 * This function grabs the PREROLL_LOCK and adds the object to
2836 * This function takes ownership of obj.
2838 static GstFlowReturn
2839 gst_base_sink_queue_object (GstBaseSink * basesink, GstPad * pad,
2840 GstMiniObject * obj, gboolean prerollable)
2844 GST_PAD_PREROLL_LOCK (pad);
2845 if (G_UNLIKELY (basesink->flushing))
2848 if (G_UNLIKELY (basesink->priv->received_eos))
2851 ret = gst_base_sink_queue_object_unlocked (basesink, pad, obj, prerollable);
2852 GST_PAD_PREROLL_UNLOCK (pad);
2859 GST_DEBUG_OBJECT (basesink, "sink is flushing");
2860 GST_PAD_PREROLL_UNLOCK (pad);
2861 gst_mini_object_unref (obj);
2862 return GST_FLOW_WRONG_STATE;
2866 GST_DEBUG_OBJECT (basesink,
2867 "we are EOS, dropping object, return UNEXPECTED");
2868 GST_PAD_PREROLL_UNLOCK (pad);
2869 gst_mini_object_unref (obj);
2870 return GST_FLOW_UNEXPECTED;
2875 gst_base_sink_flush_start (GstBaseSink * basesink, GstPad * pad)
2877 /* make sure we are not blocked on the clock also clear any pending
2879 gst_base_sink_set_flushing (basesink, pad, TRUE);
2881 /* we grab the stream lock but that is not needed since setting the
2882 * sink to flushing would make sure no state commit is being done
2884 GST_PAD_STREAM_LOCK (pad);
2885 gst_base_sink_reset_qos (basesink);
2886 if (basesink->priv->async_enabled) {
2887 /* and we need to commit our state again on the next
2888 * prerolled buffer */
2889 basesink->playing_async = TRUE;
2890 gst_element_lost_state (GST_ELEMENT_CAST (basesink));
2892 basesink->priv->have_latency = TRUE;
2893 basesink->need_preroll = FALSE;
2895 gst_base_sink_set_last_buffer (basesink, NULL);
2896 GST_PAD_STREAM_UNLOCK (pad);
2900 gst_base_sink_flush_stop (GstBaseSink * basesink, GstPad * pad)
2902 /* unset flushing so we can accept new data, this also flushes out any EOS
2904 gst_base_sink_set_flushing (basesink, pad, FALSE);
2906 /* for position reporting */
2907 GST_OBJECT_LOCK (basesink);
2908 basesink->priv->current_sstart = -1;
2909 basesink->priv->current_sstop = -1;
2910 basesink->priv->eos_rtime = -1;
2911 basesink->priv->call_preroll = TRUE;
2912 if (basesink->pad_mode == GST_ACTIVATE_PUSH) {
2913 /* we need new segment info after the flush. */
2914 basesink->have_newsegment = FALSE;
2915 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
2916 gst_segment_init (basesink->abidata.ABI.clip_segment, GST_FORMAT_UNDEFINED);
2918 GST_OBJECT_UNLOCK (basesink);
2922 gst_base_sink_event (GstPad * pad, GstEvent * event)
2924 GstBaseSink *basesink;
2925 gboolean result = TRUE;
2926 GstBaseSinkClass *bclass;
2928 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
2930 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2932 GST_DEBUG_OBJECT (basesink, "event %p (%s)", event,
2933 GST_EVENT_TYPE_NAME (event));
2935 switch (GST_EVENT_TYPE (event)) {
2940 GST_PAD_PREROLL_LOCK (pad);
2941 if (G_UNLIKELY (basesink->flushing))
2944 if (G_UNLIKELY (basesink->priv->received_eos)) {
2945 /* we can't accept anything when we are EOS */
2947 gst_event_unref (event);
2949 /* we set the received EOS flag here so that we can use it when testing if
2950 * we are prerolled and to refuse more buffers. */
2951 basesink->priv->received_eos = TRUE;
2953 /* EOS is a prerollable object, we call the unlocked version because it
2954 * does not check the received_eos flag. */
2955 ret = gst_base_sink_queue_object_unlocked (basesink, pad,
2956 GST_MINI_OBJECT_CAST (event), TRUE);
2957 if (G_UNLIKELY (ret != GST_FLOW_OK))
2960 GST_PAD_PREROLL_UNLOCK (pad);
2963 case GST_EVENT_NEWSEGMENT:
2967 GST_DEBUG_OBJECT (basesink, "newsegment %p", event);
2969 GST_PAD_PREROLL_LOCK (pad);
2970 if (G_UNLIKELY (basesink->flushing))
2973 if (G_UNLIKELY (basesink->priv->received_eos)) {
2974 /* we can't accept anything when we are EOS */
2976 gst_event_unref (event);
2978 /* the new segment is a non prerollable item and does not block anything,
2979 * we need to configure the current clipping segment and insert the event
2980 * in the queue to serialize it with the buffers for rendering. */
2981 gst_base_sink_configure_segment (basesink, pad, event,
2982 basesink->abidata.ABI.clip_segment);
2985 gst_base_sink_queue_object_unlocked (basesink, pad,
2986 GST_MINI_OBJECT_CAST (event), FALSE);
2987 if (G_UNLIKELY (ret != GST_FLOW_OK))
2990 GST_OBJECT_LOCK (basesink);
2991 basesink->have_newsegment = TRUE;
2992 GST_OBJECT_UNLOCK (basesink);
2995 GST_PAD_PREROLL_UNLOCK (pad);
2998 case GST_EVENT_FLUSH_START:
3000 bclass->event (basesink, event);
3002 GST_DEBUG_OBJECT (basesink, "flush-start %p", event);
3004 gst_base_sink_flush_start (basesink, pad);
3006 gst_event_unref (event);
3008 case GST_EVENT_FLUSH_STOP:
3010 bclass->event (basesink, event);
3012 GST_DEBUG_OBJECT (basesink, "flush-stop %p", event);
3014 gst_base_sink_flush_stop (basesink, pad);
3016 gst_event_unref (event);
3019 /* other events are sent to queue or subclass depending on if they
3020 * are serialized. */
3021 if (GST_EVENT_IS_SERIALIZED (event)) {
3022 gst_base_sink_queue_object (basesink, pad,
3023 GST_MINI_OBJECT_CAST (event), FALSE);
3026 bclass->event (basesink, event);
3027 gst_event_unref (event);
3032 gst_object_unref (basesink);
3039 GST_DEBUG_OBJECT (basesink, "we are flushing");
3040 GST_PAD_PREROLL_UNLOCK (pad);
3042 gst_event_unref (event);
3047 /* default implementation to calculate the start and end
3048 * timestamps on a buffer, subclasses can override
3051 gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
3052 GstClockTime * start, GstClockTime * end)
3054 GstClockTime timestamp, duration;
3056 timestamp = GST_BUFFER_TIMESTAMP (buffer);
3057 if (GST_CLOCK_TIME_IS_VALID (timestamp)) {
3059 /* get duration to calculate end time */
3060 duration = GST_BUFFER_DURATION (buffer);
3061 if (GST_CLOCK_TIME_IS_VALID (duration)) {
3062 *end = timestamp + duration;
3068 /* must be called with PREROLL_LOCK */
3070 gst_base_sink_needs_preroll (GstBaseSink * basesink)
3072 gboolean is_prerolled, res;
3074 /* we have 2 cases where the PREROLL_LOCK is released:
3075 * 1) we are blocking in the PREROLL_LOCK and thus are prerolled.
3076 * 2) we are syncing on the clock
3078 is_prerolled = basesink->have_preroll || basesink->priv->received_eos;
3079 res = !is_prerolled;
3081 GST_DEBUG_OBJECT (basesink, "have_preroll: %d, EOS: %d => needs preroll: %d",
3082 basesink->have_preroll, basesink->priv->received_eos, res);
3087 /* with STREAM_LOCK, PREROLL_LOCK
3089 * Takes a buffer and compare the timestamps with the last segment.
3090 * If the buffer falls outside of the segment boundaries, drop it.
3091 * Else queue the buffer for preroll and rendering.
3093 * This function takes ownership of the buffer.
3095 static GstFlowReturn
3096 gst_base_sink_chain_unlocked (GstBaseSink * basesink, GstPad * pad,
3099 GstBaseSinkClass *bclass;
3100 GstFlowReturn result;
3101 GstClockTime start = GST_CLOCK_TIME_NONE, end = GST_CLOCK_TIME_NONE;
3102 GstSegment *clip_segment;
3104 if (G_UNLIKELY (basesink->flushing))
3107 if (G_UNLIKELY (basesink->priv->received_eos))
3110 /* for code clarity */
3111 clip_segment = basesink->abidata.ABI.clip_segment;
3113 if (G_UNLIKELY (!basesink->have_newsegment)) {
3116 sync = gst_base_sink_get_sync (basesink);
3118 GST_ELEMENT_WARNING (basesink, STREAM, FAILED,
3119 (_("Internal data flow problem.")),
3120 ("Received buffer without a new-segment. Assuming timestamps start from 0."));
3123 /* this means this sink will assume timestamps start from 0 */
3124 GST_OBJECT_LOCK (basesink);
3125 clip_segment->start = 0;
3126 clip_segment->stop = -1;
3127 basesink->segment.start = 0;
3128 basesink->segment.stop = -1;
3129 basesink->have_newsegment = TRUE;
3130 GST_OBJECT_UNLOCK (basesink);
3133 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3135 /* check if the buffer needs to be dropped, we first ask the subclass for the
3137 if (bclass->get_times)
3138 bclass->get_times (basesink, buf, &start, &end);
3141 /* if the subclass does not want sync, we use our own values so that we at
3142 * least clip the buffer to the segment */
3143 gst_base_sink_get_times (basesink, buf, &start, &end);
3146 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
3147 ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (end));
3149 /* a dropped buffer does not participate in anything */
3150 if (GST_CLOCK_TIME_IS_VALID (start) &&
3151 (clip_segment->format == GST_FORMAT_TIME)) {
3152 if (G_UNLIKELY (!gst_segment_clip (clip_segment,
3153 GST_FORMAT_TIME, (gint64) start, (gint64) end, NULL, NULL)))
3154 goto out_of_segment;
3157 /* now we can process the buffer in the queue, this function takes ownership
3159 result = gst_base_sink_queue_object_unlocked (basesink, pad,
3160 GST_MINI_OBJECT_CAST (buf), TRUE);
3167 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3168 gst_buffer_unref (buf);
3169 return GST_FLOW_WRONG_STATE;
3173 GST_DEBUG_OBJECT (basesink,
3174 "we are EOS, dropping object, return UNEXPECTED");
3175 gst_buffer_unref (buf);
3176 return GST_FLOW_UNEXPECTED;
3180 GST_DEBUG_OBJECT (basesink, "dropping buffer, out of clipping segment");
3181 gst_buffer_unref (buf);
3188 static GstFlowReturn
3189 gst_base_sink_chain (GstPad * pad, GstBuffer * buf)
3191 GstBaseSink *basesink;
3192 GstFlowReturn result;
3194 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3196 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH))
3199 GST_PAD_PREROLL_LOCK (pad);
3200 result = gst_base_sink_chain_unlocked (basesink, pad, buf);
3201 GST_PAD_PREROLL_UNLOCK (pad);
3209 GST_OBJECT_LOCK (pad);
3210 GST_WARNING_OBJECT (basesink,
3211 "Push on pad %s:%s, but it was not activated in push mode",
3212 GST_DEBUG_PAD_NAME (pad));
3213 GST_OBJECT_UNLOCK (pad);
3214 gst_buffer_unref (buf);
3215 /* we don't post an error message this will signal to the peer
3216 * pushing that EOS is reached. */
3217 result = GST_FLOW_UNEXPECTED;
3223 gst_base_sink_default_do_seek (GstBaseSink * sink, GstSegment * segment)
3225 gboolean res = TRUE;
3227 /* update our offset if the start/stop position was updated */
3228 if (segment->format == GST_FORMAT_BYTES) {
3229 segment->time = segment->start;
3230 } else if (segment->start == 0) {
3231 /* seek to start, we can implement a default for this. */
3235 GST_INFO_OBJECT (sink, "Can't do a default seek");
3241 #define SEEK_TYPE_IS_RELATIVE(t) (((t) != GST_SEEK_TYPE_NONE) && ((t) != GST_SEEK_TYPE_SET))
3244 gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
3245 GstEvent * event, GstSegment * segment)
3247 /* By default, we try one of 2 things:
3248 * - For absolute seek positions, convert the requested position to our
3249 * configured processing format and place it in the output segment \
3250 * - For relative seek positions, convert our current (input) values to the
3251 * seek format, adjust by the relative seek offset and then convert back to
3252 * the processing format
3254 GstSeekType cur_type, stop_type;
3257 GstFormat seek_format, dest_format;
3260 gboolean res = TRUE;
3262 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3263 &cur_type, &cur, &stop_type, &stop);
3264 dest_format = segment->format;
3266 if (seek_format == dest_format) {
3267 gst_segment_set_seek (segment, rate, seek_format, flags,
3268 cur_type, cur, stop_type, stop, &update);
3272 if (cur_type != GST_SEEK_TYPE_NONE) {
3273 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3275 gst_pad_query_convert (sink->sinkpad, seek_format, cur, &dest_format,
3277 cur_type = GST_SEEK_TYPE_SET;
3280 if (res && stop_type != GST_SEEK_TYPE_NONE) {
3281 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3283 gst_pad_query_convert (sink->sinkpad, seek_format, stop, &dest_format,
3285 stop_type = GST_SEEK_TYPE_SET;
3288 /* And finally, configure our output segment in the desired format */
3289 gst_segment_set_seek (segment, rate, dest_format, flags, cur_type, cur,
3290 stop_type, stop, &update);
3299 GST_DEBUG_OBJECT (sink, "undefined format given, seek aborted.");
3304 /* perform a seek, only executed in pull mode */
3306 gst_base_sink_perform_seek (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3310 GstFormat seek_format, dest_format;
3312 GstSeekType cur_type, stop_type;
3313 gboolean seekseg_configured = FALSE;
3315 gboolean update, res = TRUE;
3316 GstSegment seeksegment;
3318 dest_format = sink->segment.format;
3321 GST_DEBUG_OBJECT (sink, "performing seek with event %p", event);
3322 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3323 &cur_type, &cur, &stop_type, &stop);
3325 flush = flags & GST_SEEK_FLAG_FLUSH;
3327 GST_DEBUG_OBJECT (sink, "performing seek without event");
3332 GST_DEBUG_OBJECT (sink, "flushing upstream");
3333 gst_pad_push_event (pad, gst_event_new_flush_start ());
3334 gst_base_sink_flush_start (sink, pad);
3336 GST_DEBUG_OBJECT (sink, "pausing pulling thread");
3339 GST_PAD_STREAM_LOCK (pad);
3341 /* If we configured the seeksegment above, don't overwrite it now. Otherwise
3342 * copy the current segment info into the temp segment that we can actually
3343 * attempt the seek with. We only update the real segment if the seek suceeds. */
3344 if (!seekseg_configured) {
3345 memcpy (&seeksegment, &sink->segment, sizeof (GstSegment));
3347 /* now configure the final seek segment */
3349 if (sink->segment.format != seek_format) {
3350 /* OK, here's where we give the subclass a chance to convert the relative
3351 * seek into an absolute one in the processing format. We set up any
3352 * absolute seek above, before taking the stream lock. */
3353 if (!gst_base_sink_default_prepare_seek_segment (sink, event,
3355 GST_DEBUG_OBJECT (sink,
3356 "Preparing the seek failed after flushing. " "Aborting seek");
3360 /* The seek format matches our processing format, no need to ask the
3361 * the subclass to configure the segment. */
3362 gst_segment_set_seek (&seeksegment, rate, seek_format, flags,
3363 cur_type, cur, stop_type, stop, &update);
3366 /* Else, no seek event passed, so we're just (re)starting the
3371 GST_DEBUG_OBJECT (sink, "segment configured from %" G_GINT64_FORMAT
3372 " to %" G_GINT64_FORMAT ", position %" G_GINT64_FORMAT,
3373 seeksegment.start, seeksegment.stop, seeksegment.last_stop);
3375 /* do the seek, segment.last_stop contains the new position. */
3376 res = gst_base_sink_default_do_seek (sink, &seeksegment);
3381 GST_DEBUG_OBJECT (sink, "stop flushing upstream");
3382 gst_pad_push_event (pad, gst_event_new_flush_stop ());
3383 gst_base_sink_flush_stop (sink, pad);
3384 } else if (res && sink->abidata.ABI.running) {
3385 /* we are running the current segment and doing a non-flushing seek,
3386 * close the segment first based on the last_stop. */
3387 GST_DEBUG_OBJECT (sink, "closing running segment %" G_GINT64_FORMAT
3388 " to %" G_GINT64_FORMAT, sink->segment.start, sink->segment.last_stop);
3391 /* The subclass must have converted the segment to the processing format
3393 if (res && seeksegment.format != dest_format) {
3394 GST_DEBUG_OBJECT (sink, "Subclass failed to prepare a seek segment "
3395 "in the correct format. Aborting seek.");
3399 /* if successfull seek, we update our real segment and push
3400 * out the new segment. */
3402 memcpy (&sink->segment, &seeksegment, sizeof (GstSegment));
3404 if (sink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3405 gst_element_post_message (GST_ELEMENT (sink),
3406 gst_message_new_segment_start (GST_OBJECT (sink),
3407 sink->segment.format, sink->segment.last_stop));
3411 sink->priv->discont = TRUE;
3412 sink->abidata.ABI.running = TRUE;
3414 GST_PAD_STREAM_UNLOCK (pad);
3420 gst_base_sink_perform_step (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3422 GstBaseSinkPrivate *priv;
3423 GstBaseSinkClass *bclass;
3424 gboolean flush, intermediate;
3429 GstStepInfo *pending;
3431 bclass = GST_BASE_SINK_GET_CLASS (sink);
3434 GST_DEBUG_OBJECT (sink, "performing step with event %p", event);
3436 gst_event_parse_step (event, &format, &amount, &rate, &flush, &intermediate);
3437 seqnum = gst_event_get_seqnum (event);
3439 pending = &priv->pending_step;
3442 /* we need to call ::unlock before locking PREROLL_LOCK
3443 * since we lock it before going into ::render */
3445 bclass->unlock (sink);
3447 GST_PAD_PREROLL_LOCK (sink->sinkpad);
3448 /* now that we have the PREROLL lock, clear our unlock request */
3449 if (bclass->unlock_stop)
3450 bclass->unlock_stop (sink);
3452 /* update the stepinfo and make it valid */
3453 pending->seqnum = seqnum;
3454 pending->format = format;
3455 pending->amount = amount;
3456 pending->position = 0;
3457 pending->rate = rate;
3458 pending->flush = flush;
3459 pending->intermediate = intermediate;
3460 pending->valid = TRUE;
3462 if (sink->priv->async_enabled) {
3463 /* and we need to commit our state again on the next
3464 * prerolled buffer */
3465 sink->playing_async = TRUE;
3466 priv->pending_step.need_preroll = TRUE;
3467 sink->need_preroll = FALSE;
3468 gst_element_lost_state_full (GST_ELEMENT_CAST (sink), FALSE);
3470 sink->priv->have_latency = TRUE;
3471 sink->need_preroll = FALSE;
3473 priv->call_preroll = TRUE;
3474 gst_base_sink_set_last_buffer (sink, NULL);
3475 gst_base_sink_reset_qos (sink);
3477 if (sink->clock_id) {
3478 gst_clock_id_unschedule (sink->clock_id);
3481 if (sink->have_preroll) {
3482 GST_DEBUG_OBJECT (sink, "signal waiter");
3483 priv->step_unlock = TRUE;
3484 GST_PAD_PREROLL_SIGNAL (sink->sinkpad);
3486 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
3495 gst_base_sink_loop (GstPad * pad)
3497 GstBaseSink *basesink;
3498 GstBuffer *buf = NULL;
3499 GstFlowReturn result;
3503 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3505 g_assert (basesink->pad_mode == GST_ACTIVATE_PULL);
3507 if ((blocksize = basesink->priv->blocksize) == 0)
3510 offset = basesink->segment.last_stop;
3512 GST_DEBUG_OBJECT (basesink, "pulling %" G_GUINT64_FORMAT ", %u",
3515 result = gst_pad_pull_range (pad, offset, blocksize, &buf);
3516 if (G_UNLIKELY (result != GST_FLOW_OK))
3519 if (G_UNLIKELY (buf == NULL))
3522 offset += GST_BUFFER_SIZE (buf);
3524 gst_segment_set_last_stop (&basesink->segment, GST_FORMAT_BYTES, offset);
3526 GST_PAD_PREROLL_LOCK (pad);
3527 result = gst_base_sink_chain_unlocked (basesink, pad, buf);
3528 GST_PAD_PREROLL_UNLOCK (pad);
3529 if (G_UNLIKELY (result != GST_FLOW_OK))
3537 GST_LOG_OBJECT (basesink, "pausing task, reason %s",
3538 gst_flow_get_name (result));
3539 gst_pad_pause_task (pad);
3540 /* fatal errors and NOT_LINKED cause EOS */
3541 if (GST_FLOW_IS_FATAL (result) || result == GST_FLOW_NOT_LINKED) {
3542 if (result == GST_FLOW_UNEXPECTED) {
3543 /* perform EOS logic */
3544 if (basesink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3545 gst_element_post_message (GST_ELEMENT_CAST (basesink),
3546 gst_message_new_segment_done (GST_OBJECT_CAST (basesink),
3547 basesink->segment.format, basesink->segment.last_stop));
3549 gst_base_sink_event (pad, gst_event_new_eos ());
3552 /* for fatal errors we post an error message, post the error
3553 * first so the app knows about the error first. */
3554 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
3555 (_("Internal data stream error.")),
3556 ("stream stopped, reason %s", gst_flow_get_name (result)));
3557 gst_base_sink_event (pad, gst_event_new_eos ());
3564 GST_LOG_OBJECT (basesink, "no buffer, pausing");
3565 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
3566 (_("Internal data flow error.")), ("element returned NULL buffer"));
3567 result = GST_FLOW_ERROR;
3573 gst_base_sink_set_flushing (GstBaseSink * basesink, GstPad * pad,
3576 GstBaseSinkClass *bclass;
3578 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3581 /* unlock any subclasses, we need to do this before grabbing the
3582 * PREROLL_LOCK since we hold this lock before going into ::render. */
3584 bclass->unlock (basesink);
3587 GST_PAD_PREROLL_LOCK (pad);
3588 basesink->flushing = flushing;
3590 /* step 1, now that we have the PREROLL lock, clear our unlock request */
3591 if (bclass->unlock_stop)
3592 bclass->unlock_stop (basesink);
3594 /* set need_preroll before we unblock the clock. If the clock is unblocked
3595 * before timing out, we can reuse the buffer for preroll. */
3596 basesink->need_preroll = TRUE;
3598 /* step 2, unblock clock sync (if any) or any other blocking thing */
3599 if (basesink->clock_id) {
3600 gst_clock_id_unschedule (basesink->clock_id);
3603 /* flush out the data thread if it's locked in finish_preroll, this will
3604 * also flush out the EOS state */
3605 GST_DEBUG_OBJECT (basesink,
3606 "flushing out data thread, need preroll to TRUE");
3607 gst_base_sink_preroll_queue_flush (basesink, pad);
3609 GST_PAD_PREROLL_UNLOCK (pad);
3615 gst_base_sink_default_activate_pull (GstBaseSink * basesink, gboolean active)
3621 result = gst_pad_start_task (basesink->sinkpad,
3622 (GstTaskFunction) gst_base_sink_loop, basesink->sinkpad);
3624 /* step 2, make sure streaming finishes */
3625 result = gst_pad_stop_task (basesink->sinkpad);
3632 gst_base_sink_pad_activate (GstPad * pad)
3634 gboolean result = FALSE;
3635 GstBaseSink *basesink;
3637 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3639 GST_DEBUG_OBJECT (basesink, "Trying pull mode first");
3641 gst_base_sink_set_flushing (basesink, pad, FALSE);
3643 /* we need to have the pull mode enabled */
3644 if (!basesink->can_activate_pull) {
3645 GST_DEBUG_OBJECT (basesink, "pull mode disabled");
3649 /* check if downstreams supports pull mode at all */
3650 if (!gst_pad_check_pull_range (pad)) {
3651 GST_DEBUG_OBJECT (basesink, "pull mode not supported");
3655 /* set the pad mode before starting the task so that it's in the
3656 * correct state for the new thread. also the sink set_caps and get_caps
3657 * function checks this */
3658 basesink->pad_mode = GST_ACTIVATE_PULL;
3660 /* we first try to negotiate a format so that when we try to activate
3661 * downstream, it knows about our format */
3662 if (!gst_base_sink_negotiate_pull (basesink)) {
3663 GST_DEBUG_OBJECT (basesink, "failed to negotiate in pull mode");
3667 /* ok activate now */
3668 if (!gst_pad_activate_pull (pad, TRUE)) {
3669 /* clear any pending caps */
3670 GST_OBJECT_LOCK (basesink);
3671 gst_caps_replace (&basesink->priv->pull_caps, NULL);
3672 GST_OBJECT_UNLOCK (basesink);
3673 GST_DEBUG_OBJECT (basesink, "failed to activate in pull mode");
3677 GST_DEBUG_OBJECT (basesink, "Success activating pull mode");
3681 /* push mode fallback */
3683 GST_DEBUG_OBJECT (basesink, "Falling back to push mode");
3684 if ((result = gst_pad_activate_push (pad, TRUE))) {
3685 GST_DEBUG_OBJECT (basesink, "Success activating push mode");
3690 GST_WARNING_OBJECT (basesink, "Could not activate pad in either mode");
3691 gst_base_sink_set_flushing (basesink, pad, TRUE);
3694 gst_object_unref (basesink);
3700 gst_base_sink_pad_activate_push (GstPad * pad, gboolean active)
3703 GstBaseSink *basesink;
3705 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3708 if (!basesink->can_activate_push) {
3710 basesink->pad_mode = GST_ACTIVATE_NONE;
3713 basesink->pad_mode = GST_ACTIVATE_PUSH;
3716 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH)) {
3717 g_warning ("Internal GStreamer activation error!!!");
3720 gst_base_sink_set_flushing (basesink, pad, TRUE);
3722 basesink->pad_mode = GST_ACTIVATE_NONE;
3726 gst_object_unref (basesink);
3732 gst_base_sink_negotiate_pull (GstBaseSink * basesink)
3739 /* this returns the intersection between our caps and the peer caps. If there
3740 * is no peer, it returns NULL and we can't operate in pull mode so we can
3741 * fail the negotiation. */
3742 caps = gst_pad_get_allowed_caps (GST_BASE_SINK_PAD (basesink));
3743 if (caps == NULL || gst_caps_is_empty (caps))
3744 goto no_caps_possible;
3746 GST_DEBUG_OBJECT (basesink, "allowed caps: %" GST_PTR_FORMAT, caps);
3748 caps = gst_caps_make_writable (caps);
3749 /* get the first (prefered) format */
3750 gst_caps_truncate (caps);
3752 gst_pad_fixate_caps (GST_BASE_SINK_PAD (basesink), caps);
3754 GST_DEBUG_OBJECT (basesink, "fixated to: %" GST_PTR_FORMAT, caps);
3756 if (gst_caps_is_any (caps)) {
3757 GST_DEBUG_OBJECT (basesink, "caps were ANY after fixating, "
3759 /* neither side has template caps in this case, so they are prepared for
3760 pull() without setcaps() */
3762 } else if (gst_caps_is_fixed (caps)) {
3763 if (!gst_pad_set_caps (GST_BASE_SINK_PAD (basesink), caps))
3764 goto could_not_set_caps;
3766 GST_OBJECT_LOCK (basesink);
3767 gst_caps_replace (&basesink->priv->pull_caps, caps);
3768 GST_OBJECT_UNLOCK (basesink);
3773 gst_caps_unref (caps);
3779 GST_INFO_OBJECT (basesink, "Pipeline could not agree on caps");
3780 GST_DEBUG_OBJECT (basesink, "get_allowed_caps() returned EMPTY");
3782 gst_caps_unref (caps);
3787 GST_INFO_OBJECT (basesink, "Could not set caps: %" GST_PTR_FORMAT, caps);
3788 gst_caps_unref (caps);
3793 /* this won't get called until we implement an activate function */
3795 gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active)
3797 gboolean result = FALSE;
3798 GstBaseSink *basesink;
3799 GstBaseSinkClass *bclass;
3801 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3802 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3808 /* we mark we have a newsegment here because pull based
3809 * mode works just fine without having a newsegment before the
3811 format = GST_FORMAT_BYTES;
3813 gst_segment_init (&basesink->segment, format);
3814 gst_segment_init (basesink->abidata.ABI.clip_segment, format);
3815 GST_OBJECT_LOCK (basesink);
3816 basesink->have_newsegment = TRUE;
3817 GST_OBJECT_UNLOCK (basesink);
3819 /* get the peer duration in bytes */
3820 result = gst_pad_query_peer_duration (pad, &format, &duration);
3822 GST_DEBUG_OBJECT (basesink,
3823 "setting duration in bytes to %" G_GINT64_FORMAT, duration);
3824 gst_segment_set_duration (basesink->abidata.ABI.clip_segment, format,
3826 gst_segment_set_duration (&basesink->segment, format, duration);
3828 GST_DEBUG_OBJECT (basesink, "unknown duration");
3831 if (bclass->activate_pull)
3832 result = bclass->activate_pull (basesink, TRUE);
3837 goto activate_failed;
3840 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PULL)) {
3841 g_warning ("Internal GStreamer activation error!!!");
3844 result = gst_base_sink_set_flushing (basesink, pad, TRUE);
3845 if (bclass->activate_pull)
3846 result &= bclass->activate_pull (basesink, FALSE);
3847 basesink->pad_mode = GST_ACTIVATE_NONE;
3848 /* clear any pending caps */
3849 GST_OBJECT_LOCK (basesink);
3850 gst_caps_replace (&basesink->priv->pull_caps, NULL);
3851 GST_OBJECT_UNLOCK (basesink);
3854 gst_object_unref (basesink);
3861 /* reset, as starting the thread failed */
3862 basesink->pad_mode = GST_ACTIVATE_NONE;
3864 GST_ERROR_OBJECT (basesink, "subclass failed to activate in pull mode");
3869 /* send an event to our sinkpad peer. */
3871 gst_base_sink_send_event (GstElement * element, GstEvent * event)
3874 GstBaseSink *basesink = GST_BASE_SINK (element);
3875 gboolean forward, result = TRUE;
3876 GstActivateMode mode;
3878 GST_OBJECT_LOCK (element);
3879 /* get the pad and the scheduling mode */
3880 pad = gst_object_ref (basesink->sinkpad);
3881 mode = basesink->pad_mode;
3882 GST_OBJECT_UNLOCK (element);
3884 /* only push UPSTREAM events upstream */
3885 forward = GST_EVENT_IS_UPSTREAM (event);
3887 switch (GST_EVENT_TYPE (event)) {
3888 case GST_EVENT_LATENCY:
3890 GstClockTime latency;
3892 gst_event_parse_latency (event, &latency);
3894 /* store the latency. We use this to adjust the running_time before syncing
3895 * it to the clock. */
3896 GST_OBJECT_LOCK (element);
3897 basesink->priv->latency = latency;
3898 if (!basesink->priv->have_latency)
3900 GST_OBJECT_UNLOCK (element);
3901 GST_DEBUG_OBJECT (basesink, "latency set to %" GST_TIME_FORMAT,
3902 GST_TIME_ARGS (latency));
3904 /* We forward this event so that all elements know about the global pipeline
3905 * latency. This is interesting for an element when it wants to figure out
3906 * when a particular piece of data will be rendered. */
3909 case GST_EVENT_SEEK:
3910 /* in pull mode we will execute the seek */
3911 if (mode == GST_ACTIVATE_PULL)
3912 result = gst_base_sink_perform_seek (basesink, pad, event);
3914 case GST_EVENT_STEP:
3915 result = gst_base_sink_perform_step (basesink, pad, event);
3923 result = gst_pad_push_event (pad, event);
3925 /* not forwarded, unref the event */
3926 gst_event_unref (event);
3929 gst_object_unref (pad);
3934 gst_base_sink_peer_query (GstBaseSink * sink, GstQuery * query)
3937 gboolean res = FALSE;
3939 if ((peer = gst_pad_get_peer (sink->sinkpad))) {
3940 res = gst_pad_query (peer, query);
3941 gst_object_unref (peer);
3946 /* get the end position of the last seen object, this is used
3947 * for EOS and for making sure that we don't report a position we
3948 * have not reached yet. With LOCK. */
3950 gst_base_sink_get_position_last (GstBaseSink * basesink, GstFormat format,
3954 GstSegment *segment;
3955 gboolean ret = TRUE;
3957 segment = &basesink->segment;
3958 oformat = segment->format;
3960 if (oformat == GST_FORMAT_TIME) {
3961 /* return last observed stream time, we keep the stream time around in the
3963 *cur = basesink->priv->current_sstop;
3965 /* convert last stop to stream time */
3966 *cur = gst_segment_to_stream_time (segment, oformat, segment->last_stop);
3969 if (*cur != -1 && oformat != format) {
3970 GST_OBJECT_UNLOCK (basesink);
3971 /* convert to the target format if we need to, release lock first */
3973 gst_pad_query_convert (basesink->sinkpad, oformat, *cur, &format, cur);
3976 GST_OBJECT_LOCK (basesink);
3979 GST_DEBUG_OBJECT (basesink, "POSITION: %" GST_TIME_FORMAT,
3980 GST_TIME_ARGS (*cur));
3985 /* get the position when we are PAUSED, this is the stream time of the buffer
3986 * that prerolled. If no buffer is prerolled (we are still flushing), this
3987 * value will be -1. With LOCK. */
3989 gst_base_sink_get_position_paused (GstBaseSink * basesink, GstFormat format,
3994 GstSegment *segment;
3997 /* we don't use the clip segment in pull mode, when seeking we update the
3998 * main segment directly with the new segment values without it having to be
3999 * activated by the rendering after preroll */
4000 if (basesink->pad_mode == GST_ACTIVATE_PUSH)
4001 segment = basesink->abidata.ABI.clip_segment;
4003 segment = &basesink->segment;
4004 oformat = segment->format;
4006 if (oformat == GST_FORMAT_TIME) {
4007 *cur = basesink->priv->current_sstart;
4009 *cur = gst_segment_to_stream_time (segment, oformat, segment->last_stop);
4012 time = segment->time;
4015 *cur = MAX (*cur, time);
4016 GST_DEBUG_OBJECT (basesink, "POSITION as max: %" GST_TIME_FORMAT
4017 ", time %" GST_TIME_FORMAT, GST_TIME_ARGS (*cur), GST_TIME_ARGS (time));
4019 /* we have no buffer, use the segment times. */
4020 if (segment->rate >= 0.0) {
4021 /* forward, next position is always the time of the segment */
4023 GST_DEBUG_OBJECT (basesink, "POSITION as time: %" GST_TIME_FORMAT,
4024 GST_TIME_ARGS (*cur));
4026 /* reverse, next expected timestamp is segment->stop. We use the function
4027 * to get things right for negative applied_rates. */
4028 *cur = gst_segment_to_stream_time (segment, oformat, segment->stop);
4029 GST_DEBUG_OBJECT (basesink, "reverse POSITION: %" GST_TIME_FORMAT,
4030 GST_TIME_ARGS (*cur));
4035 if (res && oformat != format) {
4036 GST_OBJECT_UNLOCK (basesink);
4038 gst_pad_query_convert (basesink->sinkpad, oformat, *cur, &format, cur);
4041 GST_OBJECT_LOCK (basesink);
4048 gst_base_sink_get_position (GstBaseSink * basesink, GstFormat format,
4049 gint64 * cur, gboolean * upstream)
4052 gboolean res = FALSE;
4053 GstFormat oformat, tformat;
4054 GstClockTime now, base, latency;
4055 gint64 time, accum, duration;
4059 GST_OBJECT_LOCK (basesink);
4060 /* our intermediate time format */
4061 tformat = GST_FORMAT_TIME;
4062 /* get the format in the segment */
4063 oformat = basesink->segment.format;
4065 /* can only give answer based on the clock if not EOS */
4066 if (G_UNLIKELY (basesink->eos))
4069 /* we can only get the segment when we are not NULL or READY */
4070 if (!basesink->have_newsegment)
4073 /* when not in PLAYING or when we're busy with a state change, we
4074 * cannot read from the clock so we report time based on the
4075 * last seen timestamp. */
4076 if (GST_STATE (basesink) != GST_STATE_PLAYING ||
4077 GST_STATE_PENDING (basesink) != GST_STATE_VOID_PENDING)
4080 /* we need to sync on the clock. */
4081 if (basesink->sync == FALSE)
4084 /* and we need a clock */
4085 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (basesink)) == NULL))
4088 /* collect all data we need holding the lock */
4089 if (GST_CLOCK_TIME_IS_VALID (basesink->segment.time))
4090 time = basesink->segment.time;
4094 if (GST_CLOCK_TIME_IS_VALID (basesink->segment.stop))
4095 duration = basesink->segment.stop - basesink->segment.start;
4099 base = GST_ELEMENT_CAST (basesink)->base_time;
4100 accum = basesink->segment.accum;
4101 rate = basesink->segment.rate * basesink->segment.applied_rate;
4102 latency = basesink->priv->latency;
4104 gst_object_ref (clock);
4106 /* this function might release the LOCK */
4107 gst_base_sink_get_position_last (basesink, format, &last);
4109 /* need to release the object lock before we can get the time,
4110 * a clock might take the LOCK of the provider, which could be
4111 * a basesink subclass. */
4112 GST_OBJECT_UNLOCK (basesink);
4114 now = gst_clock_get_time (clock);
4116 if (oformat != tformat) {
4117 /* convert accum, time and duration to time */
4118 if (!gst_pad_query_convert (basesink->sinkpad, oformat, accum, &tformat,
4120 goto convert_failed;
4121 if (!gst_pad_query_convert (basesink->sinkpad, oformat, duration, &tformat,
4123 goto convert_failed;
4124 if (!gst_pad_query_convert (basesink->sinkpad, oformat, time, &tformat,
4126 goto convert_failed;
4129 /* subtract base time and accumulated time from the clock time.
4130 * Make sure we don't go negative. This is the current time in
4131 * the segment which we need to scale with the combined
4132 * rate and applied rate. */
4135 base = MIN (now, base);
4137 /* for negative rates we need to count back from from the segment
4142 *cur = time + gst_guint64_to_gdouble (now - base) * rate;
4144 /* never report more than last seen position */
4146 *cur = MIN (last, *cur);
4148 gst_object_unref (clock);
4150 GST_DEBUG_OBJECT (basesink,
4151 "now %" GST_TIME_FORMAT " - base %" GST_TIME_FORMAT " - accum %"
4152 GST_TIME_FORMAT " + time %" GST_TIME_FORMAT,
4153 GST_TIME_ARGS (now), GST_TIME_ARGS (base),
4154 GST_TIME_ARGS (accum), GST_TIME_ARGS (time));
4156 if (oformat != format) {
4157 /* convert time to final format */
4158 if (!gst_pad_query_convert (basesink->sinkpad, tformat, *cur, &format, cur))
4159 goto convert_failed;
4165 GST_DEBUG_OBJECT (basesink, "res: %d, POSITION: %" GST_TIME_FORMAT,
4166 res, GST_TIME_ARGS (*cur));
4172 GST_DEBUG_OBJECT (basesink, "position in EOS");
4173 res = gst_base_sink_get_position_last (basesink, format, cur);
4174 GST_OBJECT_UNLOCK (basesink);
4179 GST_DEBUG_OBJECT (basesink, "position in PAUSED");
4180 res = gst_base_sink_get_position_paused (basesink, format, cur);
4181 GST_OBJECT_UNLOCK (basesink);
4186 /* in NULL or READY we always return FALSE and -1 */
4187 GST_DEBUG_OBJECT (basesink, "position in wrong state, return -1");
4190 GST_OBJECT_UNLOCK (basesink);
4195 /* report last seen timestamp if any, else ask upstream to answer */
4196 if ((*cur = basesink->priv->current_sstart) != -1)
4201 GST_DEBUG_OBJECT (basesink, "no sync, res %d, POSITION %" GST_TIME_FORMAT,
4202 res, GST_TIME_ARGS (*cur));
4203 GST_OBJECT_UNLOCK (basesink);
4208 GST_DEBUG_OBJECT (basesink, "convert failed, try upstream");
4215 gst_base_sink_query (GstElement * element, GstQuery * query)
4217 gboolean res = FALSE;
4219 GstBaseSink *basesink = GST_BASE_SINK (element);
4221 switch (GST_QUERY_TYPE (query)) {
4222 case GST_QUERY_POSITION:
4226 gboolean upstream = FALSE;
4228 gst_query_parse_position (query, &format, NULL);
4230 GST_DEBUG_OBJECT (basesink, "position format %d", format);
4232 /* first try to get the position based on the clock */
4234 gst_base_sink_get_position (basesink, format, &cur, &upstream))) {
4235 gst_query_set_position (query, format, cur);
4236 } else if (upstream) {
4237 /* fallback to peer query */
4238 res = gst_base_sink_peer_query (basesink, query);
4242 case GST_QUERY_DURATION:
4244 GstFormat format, uformat;
4245 gint64 duration, uduration;
4247 gst_query_parse_duration (query, &format, NULL);
4249 GST_DEBUG_OBJECT (basesink, "duration query in format %s",
4250 gst_format_get_name (format));
4252 if (basesink->pad_mode == GST_ACTIVATE_PULL) {
4253 uformat = GST_FORMAT_BYTES;
4255 /* get the duration in bytes, in pull mode that's all we are sure to
4256 * know. We have to explicitly get this value from upstream instead of
4257 * using our cached value because it might change. Duration caching
4258 * should be done at a higher level. */
4259 res = gst_pad_query_peer_duration (basesink->sinkpad, &uformat,
4262 gst_segment_set_duration (&basesink->segment, uformat, uduration);
4263 if (format != uformat) {
4264 /* convert to the requested format */
4265 res = gst_pad_query_convert (basesink->sinkpad, uformat, uduration,
4266 &format, &duration);
4268 duration = uduration;
4271 /* set the result */
4272 gst_query_set_duration (query, format, duration);
4276 /* in push mode we simply forward upstream */
4277 res = gst_base_sink_peer_query (basesink, query);
4281 case GST_QUERY_LATENCY:
4283 gboolean live, us_live;
4284 GstClockTime min, max;
4286 if ((res = gst_base_sink_query_latency (basesink, &live, &us_live, &min,
4288 gst_query_set_latency (query, live, min, max);
4292 case GST_QUERY_JITTER:
4294 case GST_QUERY_RATE:
4295 /* gst_query_set_rate (query, basesink->segment_rate); */
4298 case GST_QUERY_SEGMENT:
4300 /* FIXME, bring start/stop to stream time */
4301 gst_query_set_segment (query, basesink->segment.rate,
4302 GST_FORMAT_TIME, basesink->segment.start, basesink->segment.stop);
4305 case GST_QUERY_SEEKING:
4306 case GST_QUERY_CONVERT:
4307 case GST_QUERY_FORMATS:
4309 res = gst_base_sink_peer_query (basesink, query);
4315 static GstStateChangeReturn
4316 gst_base_sink_change_state (GstElement * element, GstStateChange transition)
4318 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
4319 GstBaseSink *basesink = GST_BASE_SINK (element);
4320 GstBaseSinkClass *bclass;
4321 GstBaseSinkPrivate *priv;
4323 priv = basesink->priv;
4325 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4327 switch (transition) {
4328 case GST_STATE_CHANGE_NULL_TO_READY:
4330 if (!bclass->start (basesink))
4333 case GST_STATE_CHANGE_READY_TO_PAUSED:
4334 /* need to complete preroll before this state change completes, there
4335 * is no data flow in READY so we can safely assume we need to preroll. */
4336 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4337 GST_DEBUG_OBJECT (basesink, "READY to PAUSED");
4338 basesink->have_newsegment = FALSE;
4339 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
4340 gst_segment_init (basesink->abidata.ABI.clip_segment,
4341 GST_FORMAT_UNDEFINED);
4342 basesink->offset = 0;
4343 basesink->have_preroll = FALSE;
4344 priv->step_unlock = FALSE;
4345 basesink->need_preroll = TRUE;
4346 basesink->playing_async = TRUE;
4347 priv->current_sstart = -1;
4348 priv->current_sstop = -1;
4349 priv->eos_rtime = -1;
4351 basesink->eos = FALSE;
4352 priv->received_eos = FALSE;
4353 gst_base_sink_reset_qos (basesink);
4354 priv->commited = FALSE;
4355 priv->call_preroll = TRUE;
4356 priv->current_step.valid = FALSE;
4357 priv->pending_step.valid = FALSE;
4358 if (priv->async_enabled) {
4359 GST_DEBUG_OBJECT (basesink, "doing async state change");
4360 /* when async enabled, post async-start message and return ASYNC from
4361 * the state change function */
4362 ret = GST_STATE_CHANGE_ASYNC;
4363 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4364 gst_message_new_async_start (GST_OBJECT_CAST (basesink), FALSE));
4366 priv->have_latency = TRUE;
4368 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4370 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
4371 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4372 if (!gst_base_sink_needs_preroll (basesink)) {
4373 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, don't need preroll");
4374 /* no preroll needed anymore now. */
4375 basesink->playing_async = FALSE;
4376 basesink->need_preroll = FALSE;
4377 if (basesink->eos) {
4378 GstMessage *message;
4380 /* need to post EOS message here */
4381 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
4382 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
4383 gst_message_set_seqnum (message, basesink->priv->seqnum);
4384 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
4386 GST_DEBUG_OBJECT (basesink, "signal preroll");
4387 GST_PAD_PREROLL_SIGNAL (basesink->sinkpad);
4390 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, we are not prerolled");
4391 basesink->need_preroll = TRUE;
4392 basesink->playing_async = TRUE;
4393 priv->call_preroll = TRUE;
4394 priv->commited = FALSE;
4395 if (priv->async_enabled) {
4396 GST_DEBUG_OBJECT (basesink, "doing async state change");
4397 ret = GST_STATE_CHANGE_ASYNC;
4398 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4399 gst_message_new_async_start (GST_OBJECT_CAST (basesink), FALSE));
4402 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4409 GstStateChangeReturn bret;
4411 bret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
4412 if (G_UNLIKELY (bret == GST_STATE_CHANGE_FAILURE))
4413 goto activate_failed;
4416 switch (transition) {
4417 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
4418 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED");
4419 /* FIXME, make sure we cannot enter _render first */
4421 /* we need to call ::unlock before locking PREROLL_LOCK
4422 * since we lock it before going into ::render */
4424 bclass->unlock (basesink);
4426 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4427 /* now that we have the PREROLL lock, clear our unlock request */
4428 if (bclass->unlock_stop)
4429 bclass->unlock_stop (basesink);
4431 /* we need preroll again and we set the flag before unlocking the clockid
4432 * because if the clockid is unlocked before a current buffer expired, we
4433 * can use that buffer to preroll with */
4434 basesink->need_preroll = TRUE;
4436 if (basesink->clock_id) {
4437 gst_clock_id_unschedule (basesink->clock_id);
4440 /* if we don't have a preroll buffer we need to wait for a preroll and
4442 if (!gst_base_sink_needs_preroll (basesink)) {
4443 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED, we are prerolled");
4444 basesink->playing_async = FALSE;
4446 if (GST_STATE_TARGET (GST_ELEMENT (basesink)) <= GST_STATE_READY) {
4447 ret = GST_STATE_CHANGE_SUCCESS;
4449 GST_DEBUG_OBJECT (basesink,
4450 "PLAYING to PAUSED, we are not prerolled");
4451 basesink->playing_async = TRUE;
4452 priv->commited = FALSE;
4453 priv->call_preroll = TRUE;
4454 if (priv->async_enabled) {
4455 GST_DEBUG_OBJECT (basesink, "doing async state change");
4456 ret = GST_STATE_CHANGE_ASYNC;
4457 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4458 gst_message_new_async_start (GST_OBJECT_CAST (basesink),
4463 GST_DEBUG_OBJECT (basesink, "rendered: %" G_GUINT64_FORMAT
4464 ", dropped: %" G_GUINT64_FORMAT, priv->rendered, priv->dropped);
4466 gst_base_sink_reset_qos (basesink);
4467 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4469 case GST_STATE_CHANGE_PAUSED_TO_READY:
4470 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4471 /* start by reseting our position state with the object lock so that the
4472 * position query gets the right idea. We do this before we post the
4473 * messages so that the message handlers pick this up. */
4474 GST_OBJECT_LOCK (basesink);
4475 basesink->have_newsegment = FALSE;
4476 priv->current_sstart = -1;
4477 priv->current_sstop = -1;
4478 priv->have_latency = FALSE;
4479 GST_OBJECT_UNLOCK (basesink);
4481 gst_base_sink_set_last_buffer (basesink, NULL);
4482 priv->call_preroll = FALSE;
4484 if (!priv->commited) {
4485 if (priv->async_enabled) {
4486 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, posting async-done");
4488 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4489 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
4490 GST_STATE_PLAYING, GST_STATE_PAUSED, GST_STATE_READY));
4492 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4493 gst_message_new_async_done (GST_OBJECT_CAST (basesink)));
4495 priv->commited = TRUE;
4497 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, don't need_preroll");
4499 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4501 case GST_STATE_CHANGE_READY_TO_NULL:
4503 if (!bclass->stop (basesink)) {
4504 GST_WARNING_OBJECT (basesink, "failed to stop");
4507 gst_base_sink_set_last_buffer (basesink, NULL);
4508 priv->call_preroll = FALSE;
4519 GST_DEBUG_OBJECT (basesink, "failed to start");
4520 return GST_STATE_CHANGE_FAILURE;
4524 GST_DEBUG_OBJECT (basesink,
4525 "element failed to change states -- activation problem?");
4526 return GST_STATE_CHANGE_FAILURE;