2 * Copyright (C) 2005-2007 Wim Taymans <wim.taymans@gmail.com>
4 * gstbasesink.c: Base class for sink elements
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
24 * @short_description: Base class for sink elements
25 * @see_also: #GstBaseTransform, #GstBaseSrc
27 * #GstBaseSink is the base class for sink elements in GStreamer, such as
28 * xvimagesink or filesink. It is a layer on top of #GstElement that provides a
29 * simplified interface to plugin writers. #GstBaseSink handles many details
30 * for you, for example: preroll, clock synchronization, state changes,
31 * activation in push or pull mode, and queries.
33 * In most cases, when writing sink elements, there is no need to implement
34 * class methods from #GstElement or to set functions on pads, because the
35 * #GstBaseSink infrastructure should be sufficient.
37 * #GstBaseSink provides support for exactly one sink pad, which should be
38 * named "sink". A sink implementation (subclass of #GstBaseSink) should
39 * install a pad template in its class_init function, like so:
42 * my_element_class_init (GstMyElementClass *klass)
44 * GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
46 * // sinktemplate should be a #GstStaticPadTemplate with direction
47 * // #GST_PAD_SINK and name "sink"
48 * gst_element_class_add_pad_template (gstelement_class,
49 * gst_static_pad_template_get (&sinktemplate));
50 * // see #GstElementDetails
51 * gst_element_class_set_details (gstelement_class, &details);
55 * #GstBaseSink will handle the prerolling correctly. This means that it will
56 * return #GST_STATE_CHANGE_ASYNC from a state change to PAUSED until the first
57 * buffer arrives in this element. The base class will call the
58 * #GstBaseSinkClass.preroll() vmethod with this preroll buffer and will then
59 * commit the state change to the next asynchronously pending state.
61 * When the element is set to PLAYING, #GstBaseSink will synchronise on the
62 * clock using the times returned from #GstBaseSinkClass.get_times(). If this
63 * function returns #GST_CLOCK_TIME_NONE for the start time, no synchronisation
64 * will be done. Synchronisation can be disabled entirely by setting the object
65 * #GstBaseSink:sync property to %FALSE.
67 * After synchronisation the virtual method #GstBaseSinkClass.render() will be
68 * called. Subclasses should minimally implement this method.
70 * Since 0.10.3 subclasses that synchronise on the clock in the
71 * #GstBaseSinkClass.render() method are supported as well. These classes
72 * typically receive a buffer in the render method and can then potentially
73 * block on the clock while rendering. A typical example is an audiosink.
74 * Since 0.10.11 these subclasses can use gst_base_sink_wait_preroll() to
75 * perform the blocking wait.
77 * Upon receiving the EOS event in the PLAYING state, #GstBaseSink will wait
78 * for the clock to reach the time indicated by the stop time of the last
79 * #GstBaseSinkClass.get_times() call before posting an EOS message. When the
80 * element receives EOS in PAUSED, preroll completes, the event is queued and an
81 * EOS message is posted when going to PLAYING.
83 * #GstBaseSink will internally use the #GST_EVENT_NEWSEGMENT events to schedule
84 * synchronisation and clipping of buffers. Buffers that fall completely outside
85 * of the current segment are dropped. Buffers that fall partially in the
86 * segment are rendered (and prerolled). Subclasses should do any subbuffer
87 * clipping themselves when needed.
89 * #GstBaseSink will by default report the current playback position in
90 * #GST_FORMAT_TIME based on the current clock time and segment information.
91 * If no clock has been set on the element, the query will be forwarded
94 * The #GstBaseSinkClass.set_caps() function will be called when the subclass
95 * should configure itself to process a specific media type.
97 * The #GstBaseSinkClass.start() and #GstBaseSinkClass.stop() virtual methods
98 * will be called when resources should be allocated. Any
99 * #GstBaseSinkClass.preroll(), #GstBaseSinkClass.render() and
100 * #GstBaseSinkClass.set_caps() function will be called between the
101 * #GstBaseSinkClass.start() and #GstBaseSinkClass.stop() calls.
103 * The #GstBaseSinkClass.event() virtual method will be called when an event is
104 * received by #GstBaseSink. Normally this method should only be overriden by
105 * very specific elements (such as file sinks) which need to handle the
106 * newsegment event specially.
108 * The #GstBaseSinkClass.unlock() method is called when the elements should
109 * unblock any blocking operations they perform in the
110 * #GstBaseSinkClass.render() method. This is mostly useful when the
111 * #GstBaseSinkClass.render() method performs a blocking write on a file
112 * descriptor, for example.
114 * The #GstBaseSink:max-lateness property affects how the sink deals with
115 * buffers that arrive too late in the sink. A buffer arrives too late in the
116 * sink when the presentation time (as a combination of the last segment, buffer
117 * timestamp and element base_time) plus the duration is before the current
119 * If the frame is later than max-lateness, the sink will drop the buffer
120 * without calling the render method.
121 * This feature is disabled if sync is disabled, the
122 * #GstBaseSinkClass.get_times() method does not return a valid start time or
123 * max-lateness is set to -1 (the default).
124 * Subclasses can use gst_base_sink_set_max_lateness() to configure the
125 * max-lateness value.
127 * The #GstBaseSink:qos property will enable the quality-of-service features of
128 * the basesink which gather statistics about the real-time performance of the
129 * clock synchronisation. For each buffer received in the sink, statistics are
130 * gathered and a QOS event is sent upstream with these numbers. This
131 * information can then be used by upstream elements to reduce their processing
134 * Since 0.10.15 the #GstBaseSink:async property can be used to instruct the
135 * sink to never perform an ASYNC state change. This feature is mostly usable
136 * when dealing with non-synchronized streams or sparse streams.
138 * Last reviewed on 2007-08-29 (0.10.15)
145 #include <gst/gst_private.h>
147 #include "gstbasesink.h"
148 #include <gst/gst-i18n-lib.h>
150 GST_DEBUG_CATEGORY_STATIC (gst_base_sink_debug);
151 #define GST_CAT_DEFAULT gst_base_sink_debug
153 #define GST_BASE_SINK_GET_PRIVATE(obj) \
154 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_BASE_SINK, GstBaseSinkPrivate))
156 #define GST_FLOW_STEP GST_FLOW_CUSTOM_ERROR
160 gboolean valid; /* if this info is valid */
161 guint32 seqnum; /* the seqnum of the STEP event */
162 GstFormat format; /* the format of the amount */
163 guint64 amount; /* the total amount of data to skip */
164 guint64 position; /* the position in the stepped data */
165 guint64 duration; /* the duration in time of the skipped data */
166 guint64 start; /* running_time of the start */
167 gdouble rate; /* rate of skipping */
168 gdouble start_rate; /* rate before skipping */
169 guint64 start_start; /* start position skipping */
170 guint64 start_stop; /* stop position skipping */
171 gboolean flush; /* if this was a flushing step */
172 gboolean intermediate; /* if this is an intermediate step */
173 gboolean need_preroll; /* if we need preroll after this step */
176 struct _GstBaseSinkPrivate
178 gint qos_enabled; /* ATOMIC */
179 gboolean async_enabled;
180 GstClockTimeDiff ts_offset;
181 GstClockTime render_delay;
183 /* start, stop of current buffer, stream time, used to report position */
184 GstClockTime current_sstart;
185 GstClockTime current_sstop;
187 /* start, stop and jitter of current buffer, running time */
188 GstClockTime current_rstart;
189 GstClockTime current_rstop;
190 GstClockTimeDiff current_jitter;
191 /* the running time of the previous buffer */
192 GstClockTime prev_rstart;
194 /* EOS sync time in running time */
195 GstClockTime eos_rtime;
197 /* last buffer that arrived in time, running time */
198 GstClockTime last_render_time;
199 /* when the last buffer left the sink, running time */
200 GstClockTime last_left;
202 /* running averages go here these are done on running time */
204 GstClockTime avg_duration;
206 GstClockTime avg_in_diff;
208 /* these are done on system time. avg_jitter and avg_render are
209 * compared to eachother to see if the rendering time takes a
210 * huge amount of the processing, If so we are flooded with
212 GstClockTime last_left_systime;
213 GstClockTime avg_jitter;
214 GstClockTime start, stop;
215 GstClockTime avg_render;
217 /* number of rendered and dropped frames */
222 GstClockTime latency;
224 /* if we already commited the state */
226 /* state change to playing ongoing */
229 /* when we received EOS */
230 gboolean received_eos;
232 /* when we are prerolled and able to report latency */
233 gboolean have_latency;
235 /* the last buffer we prerolled or rendered. Useful for making snapshots */
236 gint enable_last_sample; /* atomic */
237 GstBuffer *last_buffer;
240 /* negotiated caps */
243 /* blocksize for pulling */
248 /* seqnum of the stream */
251 gboolean call_preroll;
252 gboolean step_unlock;
254 /* we have a pending and a current step operation */
255 GstStepInfo current_step;
256 GstStepInfo pending_step;
258 /* Cached GstClockID */
259 GstClockID cached_clock_id;
261 /* for throttling and QoS */
262 GstClockTime earliest_in_time;
263 GstClockTime throttle_time;
266 #define DO_RUNNING_AVG(avg,val,size) (((val) + ((size)-1) * (avg)) / (size))
268 /* generic running average, this has a neutral window size */
269 #define UPDATE_RUNNING_AVG(avg,val) DO_RUNNING_AVG(avg,val,8)
271 /* the windows for these running averages are experimentally obtained.
272 * possitive values get averaged more while negative values use a small
273 * window so we can react faster to badness. */
274 #define UPDATE_RUNNING_AVG_P(avg,val) DO_RUNNING_AVG(avg,val,16)
275 #define UPDATE_RUNNING_AVG_N(avg,val) DO_RUNNING_AVG(avg,val,4)
277 /* BaseSink properties */
279 #define DEFAULT_CAN_ACTIVATE_PULL FALSE /* fixme: enable me */
280 #define DEFAULT_CAN_ACTIVATE_PUSH TRUE
282 #define DEFAULT_SYNC TRUE
283 #define DEFAULT_MAX_LATENESS -1
284 #define DEFAULT_QOS FALSE
285 #define DEFAULT_ASYNC TRUE
286 #define DEFAULT_TS_OFFSET 0
287 #define DEFAULT_BLOCKSIZE 4096
288 #define DEFAULT_RENDER_DELAY 0
289 #define DEFAULT_ENABLE_LAST_SAMPLE TRUE
290 #define DEFAULT_THROTTLE_TIME 0
300 PROP_ENABLE_LAST_SAMPLE,
308 static GstElementClass *parent_class = NULL;
310 static void gst_base_sink_class_init (GstBaseSinkClass * klass);
311 static void gst_base_sink_init (GstBaseSink * trans, gpointer g_class);
312 static void gst_base_sink_finalize (GObject * object);
315 gst_base_sink_get_type (void)
317 static volatile gsize base_sink_type = 0;
319 if (g_once_init_enter (&base_sink_type)) {
321 static const GTypeInfo base_sink_info = {
322 sizeof (GstBaseSinkClass),
325 (GClassInitFunc) gst_base_sink_class_init,
328 sizeof (GstBaseSink),
330 (GInstanceInitFunc) gst_base_sink_init,
333 _type = g_type_register_static (GST_TYPE_ELEMENT,
334 "GstBaseSink", &base_sink_info, G_TYPE_FLAG_ABSTRACT);
335 g_once_init_leave (&base_sink_type, _type);
337 return base_sink_type;
340 static void gst_base_sink_set_property (GObject * object, guint prop_id,
341 const GValue * value, GParamSpec * pspec);
342 static void gst_base_sink_get_property (GObject * object, guint prop_id,
343 GValue * value, GParamSpec * pspec);
345 static gboolean gst_base_sink_send_event (GstElement * element,
347 static gboolean default_element_query (GstElement * element, GstQuery * query);
349 static GstCaps *gst_base_sink_default_get_caps (GstBaseSink * sink,
351 static gboolean gst_base_sink_default_set_caps (GstBaseSink * sink,
353 static void gst_base_sink_default_get_times (GstBaseSink * basesink,
354 GstBuffer * buffer, GstClockTime * start, GstClockTime * end);
355 static gboolean gst_base_sink_set_flushing (GstBaseSink * basesink,
356 GstPad * pad, gboolean flushing);
357 static gboolean gst_base_sink_default_activate_pull (GstBaseSink * basesink,
359 static gboolean gst_base_sink_default_do_seek (GstBaseSink * sink,
360 GstSegment * segment);
361 static gboolean gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
362 GstEvent * event, GstSegment * segment);
364 static GstStateChangeReturn gst_base_sink_change_state (GstElement * element,
365 GstStateChange transition);
367 static gboolean gst_base_sink_sink_query (GstPad * pad, GstObject * parent,
369 static GstFlowReturn gst_base_sink_chain (GstPad * pad, GstObject * parent,
371 static GstFlowReturn gst_base_sink_chain_list (GstPad * pad, GstObject * parent,
372 GstBufferList * list);
374 static void gst_base_sink_loop (GstPad * pad);
375 static gboolean gst_base_sink_pad_activate (GstPad * pad, GstObject * parent);
376 static gboolean gst_base_sink_pad_activate_mode (GstPad * pad,
377 GstObject * parent, GstPadMode mode, gboolean active);
378 static gboolean gst_base_sink_default_event (GstBaseSink * basesink,
380 static GstFlowReturn gst_base_sink_default_wait_eos (GstBaseSink * basesink,
382 static gboolean gst_base_sink_event (GstPad * pad, GstObject * parent,
385 static gboolean gst_base_sink_default_query (GstBaseSink * sink,
388 static gboolean gst_base_sink_negotiate_pull (GstBaseSink * basesink);
389 static GstCaps *gst_base_sink_default_fixate (GstBaseSink * bsink,
391 static GstCaps *gst_base_sink_fixate (GstBaseSink * bsink, GstCaps * caps);
393 /* check if an object was too late */
394 static gboolean gst_base_sink_is_too_late (GstBaseSink * basesink,
395 GstMiniObject * obj, GstClockTime rstart, GstClockTime rstop,
396 GstClockReturn status, GstClockTimeDiff jitter);
399 gst_base_sink_class_init (GstBaseSinkClass * klass)
401 GObjectClass *gobject_class;
402 GstElementClass *gstelement_class;
404 gobject_class = G_OBJECT_CLASS (klass);
405 gstelement_class = GST_ELEMENT_CLASS (klass);
407 GST_DEBUG_CATEGORY_INIT (gst_base_sink_debug, "basesink", 0,
410 g_type_class_add_private (klass, sizeof (GstBaseSinkPrivate));
412 parent_class = g_type_class_peek_parent (klass);
414 gobject_class->finalize = gst_base_sink_finalize;
415 gobject_class->set_property = gst_base_sink_set_property;
416 gobject_class->get_property = gst_base_sink_get_property;
418 g_object_class_install_property (gobject_class, PROP_SYNC,
419 g_param_spec_boolean ("sync", "Sync", "Sync on the clock", DEFAULT_SYNC,
420 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
422 g_object_class_install_property (gobject_class, PROP_MAX_LATENESS,
423 g_param_spec_int64 ("max-lateness", "Max Lateness",
424 "Maximum number of nanoseconds that a buffer can be late before it "
425 "is dropped (-1 unlimited)", -1, G_MAXINT64, DEFAULT_MAX_LATENESS,
426 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
428 g_object_class_install_property (gobject_class, PROP_QOS,
429 g_param_spec_boolean ("qos", "Qos",
430 "Generate Quality-of-Service events upstream", DEFAULT_QOS,
431 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
435 * If set to #TRUE, the basesink will perform asynchronous state changes.
436 * When set to #FALSE, the sink will not signal the parent when it prerolls.
437 * Use this option when dealing with sparse streams or when synchronisation is
442 g_object_class_install_property (gobject_class, PROP_ASYNC,
443 g_param_spec_boolean ("async", "Async",
444 "Go asynchronously to PAUSED", DEFAULT_ASYNC,
445 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
447 * GstBaseSink:ts-offset
449 * Controls the final synchronisation, a negative value will render the buffer
450 * earlier while a positive value delays playback. This property can be
451 * used to fix synchronisation in bad files.
455 g_object_class_install_property (gobject_class, PROP_TS_OFFSET,
456 g_param_spec_int64 ("ts-offset", "TS Offset",
457 "Timestamp offset in nanoseconds", G_MININT64, G_MAXINT64,
458 DEFAULT_TS_OFFSET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
461 * GstBaseSink:enable-last-sample
463 * Enable the last-sample property. If FALSE, basesink doesn't keep a
464 * reference to the last buffer arrived and the last-sample property is always
465 * set to NULL. This can be useful if you need buffers to be released as soon
466 * as possible, eg. if you're using a buffer pool.
470 g_object_class_install_property (gobject_class, PROP_ENABLE_LAST_SAMPLE,
471 g_param_spec_boolean ("enable-last-sample", "Enable Last Buffer",
472 "Enable the last-sample property", DEFAULT_ENABLE_LAST_SAMPLE,
473 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
476 * GstBaseSink:last-sample
478 * The last buffer that arrived in the sink and was used for preroll or for
479 * rendering. This property can be used to generate thumbnails. This property
480 * can be NULL when the sink has not yet received a bufer.
484 g_object_class_install_property (gobject_class, PROP_LAST_SAMPLE,
485 g_param_spec_boxed ("last-sample", "Last Sample",
486 "The last sample received in the sink", GST_TYPE_SAMPLE,
487 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
489 * GstBaseSink:blocksize
491 * The amount of bytes to pull when operating in pull mode.
495 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
496 g_object_class_install_property (gobject_class, PROP_BLOCKSIZE,
497 g_param_spec_uint ("blocksize", "Block size",
498 "Size in bytes to pull per buffer (0 = default)", 0, G_MAXUINT,
499 DEFAULT_BLOCKSIZE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
501 * GstBaseSink:render-delay
503 * The additional delay between synchronisation and actual rendering of the
504 * media. This property will add additional latency to the device in order to
505 * make other sinks compensate for the delay.
509 g_object_class_install_property (gobject_class, PROP_RENDER_DELAY,
510 g_param_spec_uint64 ("render-delay", "Render Delay",
511 "Additional render delay of the sink in nanoseconds", 0, G_MAXUINT64,
512 DEFAULT_RENDER_DELAY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
514 * GstBaseSink:throttle-time
516 * The time to insert between buffers. This property can be used to control
517 * the maximum amount of buffers per second to render. Setting this property
518 * to a value bigger than 0 will make the sink create THROTTLE QoS events.
522 g_object_class_install_property (gobject_class, PROP_THROTTLE_TIME,
523 g_param_spec_uint64 ("throttle-time", "Throttle time",
524 "The time to keep between rendered buffers", 0, G_MAXUINT64,
525 DEFAULT_THROTTLE_TIME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
527 gstelement_class->change_state =
528 GST_DEBUG_FUNCPTR (gst_base_sink_change_state);
529 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_base_sink_send_event);
530 gstelement_class->query = GST_DEBUG_FUNCPTR (default_element_query);
532 klass->get_caps = GST_DEBUG_FUNCPTR (gst_base_sink_default_get_caps);
533 klass->set_caps = GST_DEBUG_FUNCPTR (gst_base_sink_default_set_caps);
534 klass->fixate = GST_DEBUG_FUNCPTR (gst_base_sink_default_fixate);
535 klass->activate_pull =
536 GST_DEBUG_FUNCPTR (gst_base_sink_default_activate_pull);
537 klass->get_times = GST_DEBUG_FUNCPTR (gst_base_sink_default_get_times);
538 klass->query = GST_DEBUG_FUNCPTR (gst_base_sink_default_query);
539 klass->event = GST_DEBUG_FUNCPTR (gst_base_sink_default_event);
540 klass->wait_eos = GST_DEBUG_FUNCPTR (gst_base_sink_default_wait_eos);
542 /* Registering debug symbols for function pointers */
543 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_fixate);
544 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate);
545 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate_mode);
546 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_event);
547 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain);
548 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain_list);
549 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_sink_query);
553 gst_base_sink_query_caps (GstBaseSink * bsink, GstPad * pad, GstCaps * filter)
555 GstBaseSinkClass *bclass;
556 GstCaps *caps = NULL;
559 bclass = GST_BASE_SINK_GET_CLASS (bsink);
560 fixed = GST_PAD_IS_FIXED_CAPS (pad);
562 if (fixed || bsink->pad_mode == GST_PAD_MODE_PULL) {
563 /* if we are operating in pull mode or fixed caps, we only accept the
564 * currently negotiated caps */
565 caps = gst_pad_get_current_caps (pad);
568 if (bclass->get_caps)
569 caps = bclass->get_caps (bsink, filter);
572 GstPadTemplate *pad_template;
575 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass),
577 if (pad_template != NULL) {
578 caps = gst_pad_template_get_caps (pad_template);
581 GstCaps *intersection;
584 gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
585 gst_caps_unref (caps);
596 gst_base_sink_default_fixate (GstBaseSink * bsink, GstCaps * caps)
598 GST_DEBUG_OBJECT (bsink, "using default caps fixate function");
599 return gst_caps_fixate (caps);
603 gst_base_sink_fixate (GstBaseSink * bsink, GstCaps * caps)
605 GstBaseSinkClass *bclass;
607 bclass = GST_BASE_SINK_GET_CLASS (bsink);
610 caps = bclass->fixate (bsink, caps);
616 gst_base_sink_init (GstBaseSink * basesink, gpointer g_class)
618 GstPadTemplate *pad_template;
619 GstBaseSinkPrivate *priv;
621 basesink->priv = priv = GST_BASE_SINK_GET_PRIVATE (basesink);
624 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "sink");
625 g_return_if_fail (pad_template != NULL);
627 basesink->sinkpad = gst_pad_new_from_template (pad_template, "sink");
629 gst_pad_set_activate_function (basesink->sinkpad, gst_base_sink_pad_activate);
630 gst_pad_set_activatemode_function (basesink->sinkpad,
631 gst_base_sink_pad_activate_mode);
632 gst_pad_set_query_function (basesink->sinkpad, gst_base_sink_sink_query);
633 gst_pad_set_event_function (basesink->sinkpad, gst_base_sink_event);
634 gst_pad_set_chain_function (basesink->sinkpad, gst_base_sink_chain);
635 gst_pad_set_chain_list_function (basesink->sinkpad, gst_base_sink_chain_list);
636 gst_element_add_pad (GST_ELEMENT_CAST (basesink), basesink->sinkpad);
638 basesink->pad_mode = GST_PAD_MODE_NONE;
639 g_mutex_init (&basesink->preroll_lock);
640 g_cond_init (&basesink->preroll_cond);
641 priv->have_latency = FALSE;
643 basesink->can_activate_push = DEFAULT_CAN_ACTIVATE_PUSH;
644 basesink->can_activate_pull = DEFAULT_CAN_ACTIVATE_PULL;
646 basesink->sync = DEFAULT_SYNC;
647 basesink->max_lateness = DEFAULT_MAX_LATENESS;
648 g_atomic_int_set (&priv->qos_enabled, DEFAULT_QOS);
649 priv->async_enabled = DEFAULT_ASYNC;
650 priv->ts_offset = DEFAULT_TS_OFFSET;
651 priv->render_delay = DEFAULT_RENDER_DELAY;
652 priv->blocksize = DEFAULT_BLOCKSIZE;
653 priv->cached_clock_id = NULL;
654 g_atomic_int_set (&priv->enable_last_sample, DEFAULT_ENABLE_LAST_SAMPLE);
655 priv->throttle_time = DEFAULT_THROTTLE_TIME;
657 GST_OBJECT_FLAG_SET (basesink, GST_ELEMENT_FLAG_SINK);
661 gst_base_sink_finalize (GObject * object)
663 GstBaseSink *basesink;
665 basesink = GST_BASE_SINK (object);
667 g_mutex_clear (&basesink->preroll_lock);
668 g_cond_clear (&basesink->preroll_cond);
670 G_OBJECT_CLASS (parent_class)->finalize (object);
674 * gst_base_sink_set_sync:
676 * @sync: the new sync value.
678 * Configures @sink to synchronize on the clock or not. When
679 * @sync is FALSE, incoming samples will be played as fast as
680 * possible. If @sync is TRUE, the timestamps of the incomming
681 * buffers will be used to schedule the exact render time of its
687 gst_base_sink_set_sync (GstBaseSink * sink, gboolean sync)
689 g_return_if_fail (GST_IS_BASE_SINK (sink));
691 GST_OBJECT_LOCK (sink);
693 GST_OBJECT_UNLOCK (sink);
697 * gst_base_sink_get_sync:
700 * Checks if @sink is currently configured to synchronize against the
703 * Returns: TRUE if the sink is configured to synchronize against the clock.
708 gst_base_sink_get_sync (GstBaseSink * sink)
712 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
714 GST_OBJECT_LOCK (sink);
716 GST_OBJECT_UNLOCK (sink);
722 * gst_base_sink_set_max_lateness:
724 * @max_lateness: the new max lateness value.
726 * Sets the new max lateness value to @max_lateness. This value is
727 * used to decide if a buffer should be dropped or not based on the
728 * buffer timestamp and the current clock time. A value of -1 means
734 gst_base_sink_set_max_lateness (GstBaseSink * sink, gint64 max_lateness)
736 g_return_if_fail (GST_IS_BASE_SINK (sink));
738 GST_OBJECT_LOCK (sink);
739 sink->max_lateness = max_lateness;
740 GST_OBJECT_UNLOCK (sink);
744 * gst_base_sink_get_max_lateness:
747 * Gets the max lateness value. See gst_base_sink_set_max_lateness for
750 * Returns: The maximum time in nanoseconds that a buffer can be late
751 * before it is dropped and not rendered. A value of -1 means an
757 gst_base_sink_get_max_lateness (GstBaseSink * sink)
761 g_return_val_if_fail (GST_IS_BASE_SINK (sink), -1);
763 GST_OBJECT_LOCK (sink);
764 res = sink->max_lateness;
765 GST_OBJECT_UNLOCK (sink);
771 * gst_base_sink_set_qos_enabled:
773 * @enabled: the new qos value.
775 * Configures @sink to send Quality-of-Service events upstream.
780 gst_base_sink_set_qos_enabled (GstBaseSink * sink, gboolean enabled)
782 g_return_if_fail (GST_IS_BASE_SINK (sink));
784 g_atomic_int_set (&sink->priv->qos_enabled, enabled);
788 * gst_base_sink_is_qos_enabled:
791 * Checks if @sink is currently configured to send Quality-of-Service events
794 * Returns: TRUE if the sink is configured to perform Quality-of-Service.
799 gst_base_sink_is_qos_enabled (GstBaseSink * sink)
803 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
805 res = g_atomic_int_get (&sink->priv->qos_enabled);
811 * gst_base_sink_set_async_enabled:
813 * @enabled: the new async value.
815 * Configures @sink to perform all state changes asynchronusly. When async is
816 * disabled, the sink will immediately go to PAUSED instead of waiting for a
817 * preroll buffer. This feature is useful if the sink does not synchronize
818 * against the clock or when it is dealing with sparse streams.
823 gst_base_sink_set_async_enabled (GstBaseSink * sink, gboolean enabled)
825 g_return_if_fail (GST_IS_BASE_SINK (sink));
827 GST_BASE_SINK_PREROLL_LOCK (sink);
828 g_atomic_int_set (&sink->priv->async_enabled, enabled);
829 GST_LOG_OBJECT (sink, "set async enabled to %d", enabled);
830 GST_BASE_SINK_PREROLL_UNLOCK (sink);
834 * gst_base_sink_is_async_enabled:
837 * Checks if @sink is currently configured to perform asynchronous state
840 * Returns: TRUE if the sink is configured to perform asynchronous state
846 gst_base_sink_is_async_enabled (GstBaseSink * sink)
850 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
852 res = g_atomic_int_get (&sink->priv->async_enabled);
858 * gst_base_sink_set_ts_offset:
860 * @offset: the new offset
862 * Adjust the synchronisation of @sink with @offset. A negative value will
863 * render buffers earlier than their timestamp. A positive value will delay
864 * rendering. This function can be used to fix playback of badly timestamped
870 gst_base_sink_set_ts_offset (GstBaseSink * sink, GstClockTimeDiff offset)
872 g_return_if_fail (GST_IS_BASE_SINK (sink));
874 GST_OBJECT_LOCK (sink);
875 sink->priv->ts_offset = offset;
876 GST_LOG_OBJECT (sink, "set time offset to %" G_GINT64_FORMAT, offset);
877 GST_OBJECT_UNLOCK (sink);
881 * gst_base_sink_get_ts_offset:
884 * Get the synchronisation offset of @sink.
886 * Returns: The synchronisation offset.
891 gst_base_sink_get_ts_offset (GstBaseSink * sink)
893 GstClockTimeDiff res;
895 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
897 GST_OBJECT_LOCK (sink);
898 res = sink->priv->ts_offset;
899 GST_OBJECT_UNLOCK (sink);
905 * gst_base_sink_get_last_sample:
908 * Get the last sample that arrived in the sink and was used for preroll or for
909 * rendering. This property can be used to generate thumbnails.
911 * The #GstCaps on the sample can be used to determine the type of the buffer.
913 * Free-function: gst_sample_unref
915 * Returns: (transfer full): a #GstSample. gst_sample_unref() after usage.
916 * This function returns NULL when no buffer has arrived in the sink yet
917 * or when the sink is not in PAUSED or PLAYING.
922 gst_base_sink_get_last_sample (GstBaseSink * sink)
924 GstSample *res = NULL;
926 g_return_val_if_fail (GST_IS_BASE_SINK (sink), NULL);
928 GST_OBJECT_LOCK (sink);
929 if (sink->priv->last_buffer) {
930 res = gst_sample_new (sink->priv->last_buffer,
931 sink->priv->last_caps, &sink->segment, NULL);
933 GST_OBJECT_UNLOCK (sink);
938 /* with OBJECT_LOCK */
940 gst_base_sink_set_last_buffer_unlocked (GstBaseSink * sink, GstBuffer * buffer)
944 old = sink->priv->last_buffer;
945 if (G_LIKELY (old != buffer)) {
946 GST_DEBUG_OBJECT (sink, "setting last buffer to %p", buffer);
947 if (G_LIKELY (buffer))
948 gst_buffer_ref (buffer);
949 sink->priv->last_buffer = buffer;
951 /* copy over the caps */
952 gst_caps_replace (&sink->priv->last_caps, sink->priv->caps);
954 gst_caps_replace (&sink->priv->last_caps, NULL);
958 /* avoid unreffing with the lock because cleanup code might want to take the
960 if (G_LIKELY (old)) {
961 GST_OBJECT_UNLOCK (sink);
962 gst_buffer_unref (old);
963 GST_OBJECT_LOCK (sink);
968 gst_base_sink_set_last_buffer (GstBaseSink * sink, GstBuffer * buffer)
970 if (!g_atomic_int_get (&sink->priv->enable_last_sample))
973 GST_OBJECT_LOCK (sink);
974 gst_base_sink_set_last_buffer_unlocked (sink, buffer);
975 GST_OBJECT_UNLOCK (sink);
979 * gst_base_sink_set_last_sample_enabled:
981 * @enabled: the new enable-last-sample value.
983 * Configures @sink to store the last received sample in the last-sample
989 gst_base_sink_set_last_sample_enabled (GstBaseSink * sink, gboolean enabled)
991 g_return_if_fail (GST_IS_BASE_SINK (sink));
993 /* Only take lock if we change the value */
994 if (g_atomic_int_compare_and_exchange (&sink->priv->enable_last_sample,
995 !enabled, enabled) && !enabled) {
996 GST_OBJECT_LOCK (sink);
997 gst_base_sink_set_last_buffer_unlocked (sink, NULL);
998 GST_OBJECT_UNLOCK (sink);
1003 * gst_base_sink_is_last_sample_enabled:
1006 * Checks if @sink is currently configured to store the last received sample in
1007 * the last-sample property.
1009 * Returns: TRUE if the sink is configured to store the last received sample.
1014 gst_base_sink_is_last_sample_enabled (GstBaseSink * sink)
1016 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
1018 return g_atomic_int_get (&sink->priv->enable_last_sample);
1022 * gst_base_sink_get_latency:
1025 * Get the currently configured latency.
1027 * Returns: The configured latency.
1032 gst_base_sink_get_latency (GstBaseSink * sink)
1036 GST_OBJECT_LOCK (sink);
1037 res = sink->priv->latency;
1038 GST_OBJECT_UNLOCK (sink);
1044 * gst_base_sink_query_latency:
1046 * @live: (out) (allow-none): if the sink is live
1047 * @upstream_live: (out) (allow-none): if an upstream element is live
1048 * @min_latency: (out) (allow-none): the min latency of the upstream elements
1049 * @max_latency: (out) (allow-none): the max latency of the upstream elements
1051 * Query the sink for the latency parameters. The latency will be queried from
1052 * the upstream elements. @live will be TRUE if @sink is configured to
1053 * synchronize against the clock. @upstream_live will be TRUE if an upstream
1056 * If both @live and @upstream_live are TRUE, the sink will want to compensate
1057 * for the latency introduced by the upstream elements by setting the
1058 * @min_latency to a strictly possitive value.
1060 * This function is mostly used by subclasses.
1062 * Returns: TRUE if the query succeeded.
1067 gst_base_sink_query_latency (GstBaseSink * sink, gboolean * live,
1068 gboolean * upstream_live, GstClockTime * min_latency,
1069 GstClockTime * max_latency)
1071 gboolean l, us_live, res, have_latency;
1072 GstClockTime min, max, render_delay;
1074 GstClockTime us_min, us_max;
1076 /* we are live when we sync to the clock */
1077 GST_OBJECT_LOCK (sink);
1079 have_latency = sink->priv->have_latency;
1080 render_delay = sink->priv->render_delay;
1081 GST_OBJECT_UNLOCK (sink);
1083 /* assume no latency */
1089 GST_DEBUG_OBJECT (sink, "we are ready for LATENCY query");
1090 /* we are ready for a latency query this is when we preroll or when we are
1092 query = gst_query_new_latency ();
1094 /* ask the peer for the latency */
1095 if ((res = gst_pad_peer_query (sink->sinkpad, query))) {
1096 /* get upstream min and max latency */
1097 gst_query_parse_latency (query, &us_live, &us_min, &us_max);
1100 /* upstream live, use its latency, subclasses should use these
1101 * values to create the complete latency. */
1106 /* we need to add the render delay if we are live */
1108 min += render_delay;
1110 max += render_delay;
1113 gst_query_unref (query);
1115 GST_DEBUG_OBJECT (sink, "we are not yet ready for LATENCY query");
1119 /* not live, we tried to do the query, if it failed we return TRUE anyway */
1123 GST_DEBUG_OBJECT (sink, "latency query failed but we are not live");
1125 GST_DEBUG_OBJECT (sink, "latency query failed and we are live");
1130 GST_DEBUG_OBJECT (sink, "latency query: live: %d, have_latency %d,"
1131 " upstream: %d, min %" GST_TIME_FORMAT ", max %" GST_TIME_FORMAT, l,
1132 have_latency, us_live, GST_TIME_ARGS (min), GST_TIME_ARGS (max));
1137 *upstream_live = us_live;
1147 * gst_base_sink_set_render_delay:
1148 * @sink: a #GstBaseSink
1149 * @delay: the new delay
1151 * Set the render delay in @sink to @delay. The render delay is the time
1152 * between actual rendering of a buffer and its synchronisation time. Some
1153 * devices might delay media rendering which can be compensated for with this
1156 * After calling this function, this sink will report additional latency and
1157 * other sinks will adjust their latency to delay the rendering of their media.
1159 * This function is usually called by subclasses.
1164 gst_base_sink_set_render_delay (GstBaseSink * sink, GstClockTime delay)
1166 GstClockTime old_render_delay;
1168 g_return_if_fail (GST_IS_BASE_SINK (sink));
1170 GST_OBJECT_LOCK (sink);
1171 old_render_delay = sink->priv->render_delay;
1172 sink->priv->render_delay = delay;
1173 GST_LOG_OBJECT (sink, "set render delay to %" GST_TIME_FORMAT,
1174 GST_TIME_ARGS (delay));
1175 GST_OBJECT_UNLOCK (sink);
1177 if (delay != old_render_delay) {
1178 GST_DEBUG_OBJECT (sink, "posting latency changed");
1179 gst_element_post_message (GST_ELEMENT_CAST (sink),
1180 gst_message_new_latency (GST_OBJECT_CAST (sink)));
1185 * gst_base_sink_get_render_delay:
1186 * @sink: a #GstBaseSink
1188 * Get the render delay of @sink. see gst_base_sink_set_render_delay() for more
1189 * information about the render delay.
1191 * Returns: the render delay of @sink.
1196 gst_base_sink_get_render_delay (GstBaseSink * sink)
1198 GstClockTimeDiff res;
1200 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1202 GST_OBJECT_LOCK (sink);
1203 res = sink->priv->render_delay;
1204 GST_OBJECT_UNLOCK (sink);
1210 * gst_base_sink_set_blocksize:
1211 * @sink: a #GstBaseSink
1212 * @blocksize: the blocksize in bytes
1214 * Set the number of bytes that the sink will pull when it is operating in pull
1219 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
1221 gst_base_sink_set_blocksize (GstBaseSink * sink, guint blocksize)
1223 g_return_if_fail (GST_IS_BASE_SINK (sink));
1225 GST_OBJECT_LOCK (sink);
1226 sink->priv->blocksize = blocksize;
1227 GST_LOG_OBJECT (sink, "set blocksize to %u", blocksize);
1228 GST_OBJECT_UNLOCK (sink);
1232 * gst_base_sink_get_blocksize:
1233 * @sink: a #GstBaseSink
1235 * Get the number of bytes that the sink will pull when it is operating in pull
1238 * Returns: the number of bytes @sink will pull in pull mode.
1242 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
1244 gst_base_sink_get_blocksize (GstBaseSink * sink)
1248 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1250 GST_OBJECT_LOCK (sink);
1251 res = sink->priv->blocksize;
1252 GST_OBJECT_UNLOCK (sink);
1258 * gst_base_sink_set_throttle_time:
1259 * @sink: a #GstBaseSink
1260 * @throttle: the throttle time in nanoseconds
1262 * Set the time that will be inserted between rendered buffers. This
1263 * can be used to control the maximum buffers per second that the sink
1269 gst_base_sink_set_throttle_time (GstBaseSink * sink, guint64 throttle)
1271 g_return_if_fail (GST_IS_BASE_SINK (sink));
1273 GST_OBJECT_LOCK (sink);
1274 sink->priv->throttle_time = throttle;
1275 GST_LOG_OBJECT (sink, "set throttle_time to %" G_GUINT64_FORMAT, throttle);
1276 GST_OBJECT_UNLOCK (sink);
1280 * gst_base_sink_get_throttle_time:
1281 * @sink: a #GstBaseSink
1283 * Get the time that will be inserted between frames to control the
1284 * maximum buffers per second.
1286 * Returns: the number of nanoseconds @sink will put between frames.
1291 gst_base_sink_get_throttle_time (GstBaseSink * sink)
1295 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1297 GST_OBJECT_LOCK (sink);
1298 res = sink->priv->throttle_time;
1299 GST_OBJECT_UNLOCK (sink);
1305 gst_base_sink_set_property (GObject * object, guint prop_id,
1306 const GValue * value, GParamSpec * pspec)
1308 GstBaseSink *sink = GST_BASE_SINK (object);
1312 gst_base_sink_set_sync (sink, g_value_get_boolean (value));
1314 case PROP_MAX_LATENESS:
1315 gst_base_sink_set_max_lateness (sink, g_value_get_int64 (value));
1318 gst_base_sink_set_qos_enabled (sink, g_value_get_boolean (value));
1321 gst_base_sink_set_async_enabled (sink, g_value_get_boolean (value));
1323 case PROP_TS_OFFSET:
1324 gst_base_sink_set_ts_offset (sink, g_value_get_int64 (value));
1326 case PROP_BLOCKSIZE:
1327 gst_base_sink_set_blocksize (sink, g_value_get_uint (value));
1329 case PROP_RENDER_DELAY:
1330 gst_base_sink_set_render_delay (sink, g_value_get_uint64 (value));
1332 case PROP_ENABLE_LAST_SAMPLE:
1333 gst_base_sink_set_last_sample_enabled (sink, g_value_get_boolean (value));
1335 case PROP_THROTTLE_TIME:
1336 gst_base_sink_set_throttle_time (sink, g_value_get_uint64 (value));
1339 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1345 gst_base_sink_get_property (GObject * object, guint prop_id, GValue * value,
1348 GstBaseSink *sink = GST_BASE_SINK (object);
1352 g_value_set_boolean (value, gst_base_sink_get_sync (sink));
1354 case PROP_MAX_LATENESS:
1355 g_value_set_int64 (value, gst_base_sink_get_max_lateness (sink));
1358 g_value_set_boolean (value, gst_base_sink_is_qos_enabled (sink));
1361 g_value_set_boolean (value, gst_base_sink_is_async_enabled (sink));
1363 case PROP_TS_OFFSET:
1364 g_value_set_int64 (value, gst_base_sink_get_ts_offset (sink));
1366 case PROP_LAST_SAMPLE:
1367 gst_value_take_buffer (value, gst_base_sink_get_last_sample (sink));
1369 case PROP_ENABLE_LAST_SAMPLE:
1370 g_value_set_boolean (value, gst_base_sink_is_last_sample_enabled (sink));
1372 case PROP_BLOCKSIZE:
1373 g_value_set_uint (value, gst_base_sink_get_blocksize (sink));
1375 case PROP_RENDER_DELAY:
1376 g_value_set_uint64 (value, gst_base_sink_get_render_delay (sink));
1378 case PROP_THROTTLE_TIME:
1379 g_value_set_uint64 (value, gst_base_sink_get_throttle_time (sink));
1382 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1389 gst_base_sink_default_get_caps (GstBaseSink * sink, GstCaps * filter)
1395 gst_base_sink_default_set_caps (GstBaseSink * sink, GstCaps * caps)
1400 /* with PREROLL_LOCK, STREAM_LOCK */
1402 gst_base_sink_commit_state (GstBaseSink * basesink)
1404 /* commit state and proceed to next pending state */
1405 GstState current, next, pending, post_pending;
1406 gboolean post_paused = FALSE;
1407 gboolean post_async_done = FALSE;
1408 gboolean post_playing = FALSE;
1410 /* we are certainly not playing async anymore now */
1411 basesink->playing_async = FALSE;
1413 GST_OBJECT_LOCK (basesink);
1414 current = GST_STATE (basesink);
1415 next = GST_STATE_NEXT (basesink);
1416 pending = GST_STATE_PENDING (basesink);
1417 post_pending = pending;
1420 case GST_STATE_PLAYING:
1422 GST_DEBUG_OBJECT (basesink, "commiting state to PLAYING");
1424 basesink->need_preroll = FALSE;
1425 post_async_done = TRUE;
1426 basesink->priv->commited = TRUE;
1427 post_playing = TRUE;
1428 /* post PAUSED too when we were READY */
1429 if (current == GST_STATE_READY) {
1434 case GST_STATE_PAUSED:
1435 GST_DEBUG_OBJECT (basesink, "commiting state to PAUSED");
1437 post_async_done = TRUE;
1438 basesink->priv->commited = TRUE;
1439 post_pending = GST_STATE_VOID_PENDING;
1441 case GST_STATE_READY:
1442 case GST_STATE_NULL:
1444 case GST_STATE_VOID_PENDING:
1445 goto nothing_pending;
1450 /* we can report latency queries now */
1451 basesink->priv->have_latency = TRUE;
1453 GST_STATE (basesink) = pending;
1454 GST_STATE_NEXT (basesink) = GST_STATE_VOID_PENDING;
1455 GST_STATE_PENDING (basesink) = GST_STATE_VOID_PENDING;
1456 GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_SUCCESS;
1457 GST_OBJECT_UNLOCK (basesink);
1460 GST_DEBUG_OBJECT (basesink, "posting PAUSED state change message");
1461 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1462 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1463 current, next, post_pending));
1465 if (post_async_done) {
1466 GST_DEBUG_OBJECT (basesink, "posting async-done message");
1467 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1468 gst_message_new_async_done (GST_OBJECT_CAST (basesink), FALSE));
1471 GST_DEBUG_OBJECT (basesink, "posting PLAYING state change message");
1472 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1473 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1474 next, pending, GST_STATE_VOID_PENDING));
1477 GST_STATE_BROADCAST (basesink);
1483 /* Depending on the state, set our vars. We get in this situation when the
1484 * state change function got a change to update the state vars before the
1485 * streaming thread did. This is fine but we need to make sure that we
1486 * update the need_preroll var since it was TRUE when we got here and might
1487 * become FALSE if we got to PLAYING. */
1488 GST_DEBUG_OBJECT (basesink, "nothing to commit, now in %s",
1489 gst_element_state_get_name (current));
1491 case GST_STATE_PLAYING:
1492 basesink->need_preroll = FALSE;
1494 case GST_STATE_PAUSED:
1495 basesink->need_preroll = TRUE;
1498 basesink->need_preroll = FALSE;
1499 basesink->flushing = TRUE;
1502 /* we can report latency queries now */
1503 basesink->priv->have_latency = TRUE;
1504 GST_OBJECT_UNLOCK (basesink);
1509 /* app is going to READY */
1510 GST_DEBUG_OBJECT (basesink, "stopping");
1511 basesink->need_preroll = FALSE;
1512 basesink->flushing = TRUE;
1513 GST_OBJECT_UNLOCK (basesink);
1519 start_stepping (GstBaseSink * sink, GstSegment * segment,
1520 GstStepInfo * pending, GstStepInfo * current)
1523 GstMessage *message;
1525 GST_DEBUG_OBJECT (sink, "update pending step");
1527 GST_OBJECT_LOCK (sink);
1528 memcpy (current, pending, sizeof (GstStepInfo));
1529 pending->valid = FALSE;
1530 GST_OBJECT_UNLOCK (sink);
1532 /* post message first */
1534 gst_message_new_step_start (GST_OBJECT (sink), TRUE, current->format,
1535 current->amount, current->rate, current->flush, current->intermediate);
1536 gst_message_set_seqnum (message, current->seqnum);
1537 gst_element_post_message (GST_ELEMENT (sink), message);
1539 /* get the running time of where we paused and remember it */
1540 current->start = gst_element_get_start_time (GST_ELEMENT_CAST (sink));
1541 gst_segment_set_running_time (segment, GST_FORMAT_TIME, current->start);
1543 /* set the new rate for the remainder of the segment */
1544 current->start_rate = segment->rate;
1545 segment->rate *= current->rate;
1548 if (segment->rate > 0.0)
1549 current->start_stop = segment->stop;
1551 current->start_start = segment->start;
1553 if (current->format == GST_FORMAT_TIME) {
1554 end = current->start + current->amount;
1555 if (!current->flush) {
1556 /* update the segment clipping regions for non-flushing seeks */
1557 if (segment->rate > 0.0) {
1558 segment->stop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1559 segment->position = segment->stop;
1563 position = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1564 segment->time = position;
1565 segment->start = position;
1566 segment->position = position;
1571 GST_DEBUG_OBJECT (sink, "segment now %" GST_SEGMENT_FORMAT, segment);
1572 GST_DEBUG_OBJECT (sink, "step started at running_time %" GST_TIME_FORMAT,
1573 GST_TIME_ARGS (current->start));
1575 if (current->amount == -1) {
1576 GST_DEBUG_OBJECT (sink, "step amount == -1, stop stepping");
1577 current->valid = FALSE;
1579 GST_DEBUG_OBJECT (sink, "step amount: %" G_GUINT64_FORMAT ", format: %s, "
1580 "rate: %f", current->amount, gst_format_get_name (current->format),
1586 stop_stepping (GstBaseSink * sink, GstSegment * segment,
1587 GstStepInfo * current, gint64 rstart, gint64 rstop, gboolean eos)
1589 gint64 stop, position;
1590 GstMessage *message;
1592 GST_DEBUG_OBJECT (sink, "step complete");
1594 if (segment->rate > 0.0)
1599 GST_DEBUG_OBJECT (sink,
1600 "step stop at running_time %" GST_TIME_FORMAT, GST_TIME_ARGS (stop));
1603 current->duration = current->position;
1605 current->duration = stop - current->start;
1607 GST_DEBUG_OBJECT (sink, "step elapsed running_time %" GST_TIME_FORMAT,
1608 GST_TIME_ARGS (current->duration));
1610 position = current->start + current->duration;
1612 /* now move the segment to the new running time */
1613 gst_segment_set_running_time (segment, GST_FORMAT_TIME, position);
1615 if (current->flush) {
1616 /* and remove the time we flushed, start time did not change */
1617 segment->base = current->start;
1619 /* start time is now the stepped position */
1620 gst_element_set_start_time (GST_ELEMENT_CAST (sink), position);
1623 /* restore the previous rate */
1624 segment->rate = current->start_rate;
1626 if (segment->rate > 0.0)
1627 segment->stop = current->start_stop;
1629 segment->start = current->start_start;
1631 /* post the step done when we know the stepped duration in TIME */
1633 gst_message_new_step_done (GST_OBJECT_CAST (sink), current->format,
1634 current->amount, current->rate, current->flush, current->intermediate,
1635 current->duration, eos);
1636 gst_message_set_seqnum (message, current->seqnum);
1637 gst_element_post_message (GST_ELEMENT_CAST (sink), message);
1639 if (!current->intermediate)
1640 sink->need_preroll = current->need_preroll;
1642 /* and the current step info finished and becomes invalid */
1643 current->valid = FALSE;
1647 handle_stepping (GstBaseSink * sink, GstSegment * segment,
1648 GstStepInfo * current, guint64 * cstart, guint64 * cstop, guint64 * rstart,
1651 gboolean step_end = FALSE;
1653 /* see if we need to skip this buffer because of stepping */
1654 switch (current->format) {
1655 case GST_FORMAT_TIME:
1658 guint64 first, last;
1661 if (segment->rate > 0.0) {
1662 if (segment->stop == *cstop)
1663 *rstop = *rstart + current->amount;
1668 if (segment->start == *cstart)
1669 *rstart = *rstop + current->amount;
1675 end = current->start + current->amount;
1676 current->position = first - current->start;
1678 abs_rate = ABS (segment->rate);
1679 if (G_UNLIKELY (abs_rate != 1.0))
1680 current->position /= abs_rate;
1682 GST_DEBUG_OBJECT (sink,
1683 "buffer: %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT,
1684 GST_TIME_ARGS (first), GST_TIME_ARGS (last));
1685 GST_DEBUG_OBJECT (sink,
1686 "got time step %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT "/%"
1687 GST_TIME_FORMAT, GST_TIME_ARGS (current->position),
1688 GST_TIME_ARGS (last - current->start),
1689 GST_TIME_ARGS (current->amount));
1691 if ((current->flush && current->position >= current->amount)
1693 GST_DEBUG_OBJECT (sink, "step ended, we need clipping");
1695 if (segment->rate > 0.0) {
1697 *cstart = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1700 *cstop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1703 GST_DEBUG_OBJECT (sink,
1704 "cstart %" GST_TIME_FORMAT ", rstart %" GST_TIME_FORMAT,
1705 GST_TIME_ARGS (*cstart), GST_TIME_ARGS (*rstart));
1706 GST_DEBUG_OBJECT (sink,
1707 "cstop %" GST_TIME_FORMAT ", rstop %" GST_TIME_FORMAT,
1708 GST_TIME_ARGS (*cstop), GST_TIME_ARGS (*rstop));
1711 case GST_FORMAT_BUFFERS:
1712 GST_DEBUG_OBJECT (sink,
1713 "got default step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1714 current->position, current->amount);
1716 if (current->position < current->amount) {
1717 current->position++;
1722 case GST_FORMAT_DEFAULT:
1724 GST_DEBUG_OBJECT (sink,
1725 "got unknown step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1726 current->position, current->amount);
1732 /* with STREAM_LOCK, PREROLL_LOCK
1734 * Returns TRUE if the object needs synchronisation and takes therefore
1735 * part in prerolling.
1737 * rsstart/rsstop contain the start/stop in stream time.
1738 * rrstart/rrstop contain the start/stop in running time.
1741 gst_base_sink_get_sync_times (GstBaseSink * basesink, GstMiniObject * obj,
1742 GstClockTime * rsstart, GstClockTime * rsstop,
1743 GstClockTime * rrstart, GstClockTime * rrstop, gboolean * do_sync,
1744 gboolean * stepped, GstStepInfo * step, gboolean * step_end)
1746 GstBaseSinkClass *bclass;
1748 GstClockTime start, stop; /* raw start/stop timestamps */
1749 guint64 cstart, cstop; /* clipped raw timestamps */
1750 guint64 rstart, rstop; /* clipped timestamps converted to running time */
1751 GstClockTime sstart, sstop; /* clipped timestamps converted to stream time */
1753 GstBaseSinkPrivate *priv;
1754 GstSegment *segment;
1757 priv = basesink->priv;
1758 segment = &basesink->segment;
1760 /* start with nothing */
1761 start = stop = GST_CLOCK_TIME_NONE;
1763 if (G_UNLIKELY (GST_IS_EVENT (obj))) {
1764 GstEvent *event = GST_EVENT_CAST (obj);
1766 switch (GST_EVENT_TYPE (event)) {
1767 /* EOS event needs syncing */
1770 if (segment->rate >= 0.0) {
1771 sstart = sstop = priv->current_sstop;
1772 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1773 /* we have not seen a buffer yet, use the segment values */
1774 sstart = sstop = gst_segment_to_stream_time (segment,
1775 segment->format, segment->stop);
1778 sstart = sstop = priv->current_sstart;
1779 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1780 /* we have not seen a buffer yet, use the segment values */
1781 sstart = sstop = gst_segment_to_stream_time (segment,
1782 segment->format, segment->start);
1786 rstart = rstop = priv->eos_rtime;
1787 *do_sync = rstart != -1;
1788 GST_DEBUG_OBJECT (basesink, "sync times for EOS %" GST_TIME_FORMAT,
1789 GST_TIME_ARGS (rstart));
1790 /* if we are stepping, we end now */
1791 *step_end = step->valid;
1796 /* other events do not need syncing */
1804 /* else do buffer sync code */
1805 buffer = GST_BUFFER_CAST (obj);
1807 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1809 /* just get the times to see if we need syncing, if the start returns -1 we
1811 if (bclass->get_times)
1812 bclass->get_times (basesink, buffer, &start, &stop);
1814 if (!GST_CLOCK_TIME_IS_VALID (start)) {
1815 /* we don't need to sync but we still want to get the timestamps for
1816 * tracking the position */
1817 gst_base_sink_default_get_times (basesink, buffer, &start, &stop);
1823 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
1824 ", stop: %" GST_TIME_FORMAT ", do_sync %d", GST_TIME_ARGS (start),
1825 GST_TIME_ARGS (stop), *do_sync);
1827 /* collect segment and format for code clarity */
1828 format = segment->format;
1831 if (G_UNLIKELY (!gst_segment_clip (segment, format,
1832 start, stop, &cstart, &cstop))) {
1834 GST_DEBUG_OBJECT (basesink, "step out of segment");
1835 /* when we are stepping, pretend we're at the end of the segment */
1836 if (segment->rate > 0.0) {
1837 cstart = segment->stop;
1838 cstop = segment->stop;
1840 cstart = segment->start;
1841 cstop = segment->start;
1845 goto out_of_segment;
1848 if (G_UNLIKELY (start != cstart || stop != cstop)) {
1849 GST_DEBUG_OBJECT (basesink, "clipped to: start %" GST_TIME_FORMAT
1850 ", stop: %" GST_TIME_FORMAT, GST_TIME_ARGS (cstart),
1851 GST_TIME_ARGS (cstop));
1854 /* set last stop position */
1855 if (G_LIKELY (stop != GST_CLOCK_TIME_NONE && cstop != GST_CLOCK_TIME_NONE))
1856 segment->position = cstop;
1858 segment->position = cstart;
1861 rstart = gst_segment_to_running_time (segment, format, cstart);
1862 rstop = gst_segment_to_running_time (segment, format, cstop);
1864 if (G_UNLIKELY (step->valid)) {
1865 if (!(*step_end = handle_stepping (basesink, segment, step, &cstart, &cstop,
1866 &rstart, &rstop))) {
1867 /* step is still busy, we discard data when we are flushing */
1868 *stepped = step->flush;
1869 GST_DEBUG_OBJECT (basesink, "stepping busy");
1872 /* this can produce wrong values if we accumulated non-TIME segments. If this happens,
1873 * upstream is behaving very badly */
1874 sstart = gst_segment_to_stream_time (segment, format, cstart);
1875 sstop = gst_segment_to_stream_time (segment, format, cstop);
1878 /* eos_done label only called when doing EOS, we also stop stepping then */
1879 if (*step_end && step->flush) {
1880 GST_DEBUG_OBJECT (basesink, "flushing step ended");
1881 stop_stepping (basesink, segment, step, rstart, rstop, eos);
1883 /* re-determine running start times for adjusted segment
1884 * (which has a flushed amount of running/accumulated time removed) */
1885 if (!GST_IS_EVENT (obj)) {
1886 GST_DEBUG_OBJECT (basesink, "refresh sync times");
1897 /* buffers and EOS always need syncing and preroll */
1903 /* we usually clip in the chain function already but stepping could cause
1904 * the segment to be updated later. we return FALSE so that we don't try
1906 GST_LOG_OBJECT (basesink, "buffer skipped, not in segment");
1911 /* with STREAM_LOCK, PREROLL_LOCK, LOCK
1912 * adjust a timestamp with the latency and timestamp offset. This function does
1913 * not adjust for the render delay. */
1915 gst_base_sink_adjust_time (GstBaseSink * basesink, GstClockTime time)
1917 GstClockTimeDiff ts_offset;
1919 /* don't do anything funny with invalid timestamps */
1920 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
1923 time += basesink->priv->latency;
1925 /* apply offset, be carefull for underflows */
1926 ts_offset = basesink->priv->ts_offset;
1927 if (ts_offset < 0) {
1928 ts_offset = -ts_offset;
1929 if (ts_offset < time)
1936 /* subtract the render delay again, which was included in the latency */
1937 if (time > basesink->priv->render_delay)
1938 time -= basesink->priv->render_delay;
1946 * gst_base_sink_wait_clock:
1948 * @time: the running_time to be reached
1949 * @jitter: (out) (allow-none): the jitter to be filled with time diff, or NULL
1951 * This function will block until @time is reached. It is usually called by
1952 * subclasses that use their own internal synchronisation.
1954 * If @time is not valid, no sycnhronisation is done and #GST_CLOCK_BADTIME is
1955 * returned. Likewise, if synchronisation is disabled in the element or there
1956 * is no clock, no synchronisation is done and #GST_CLOCK_BADTIME is returned.
1958 * This function should only be called with the PREROLL_LOCK held, like when
1959 * receiving an EOS event in the #GstBaseSinkClass.event() vmethod or when
1960 * receiving a buffer in
1961 * the #GstBaseSinkClass.render() vmethod.
1963 * The @time argument should be the running_time of when this method should
1964 * return and is not adjusted with any latency or offset configured in the
1969 * Returns: #GstClockReturn
1972 gst_base_sink_wait_clock (GstBaseSink * sink, GstClockTime time,
1973 GstClockTimeDiff * jitter)
1977 GstClockTime base_time;
1979 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
1982 GST_OBJECT_LOCK (sink);
1983 if (G_UNLIKELY (!sink->sync))
1986 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (sink)) == NULL))
1989 base_time = GST_ELEMENT_CAST (sink)->base_time;
1990 GST_LOG_OBJECT (sink,
1991 "time %" GST_TIME_FORMAT ", base_time %" GST_TIME_FORMAT,
1992 GST_TIME_ARGS (time), GST_TIME_ARGS (base_time));
1994 /* add base_time to running_time to get the time against the clock */
1997 /* Re-use existing clockid if available */
1998 /* FIXME: Casting to GstClockEntry only works because the types
2000 if (G_LIKELY (sink->priv->cached_clock_id != NULL
2001 && GST_CLOCK_ENTRY_CLOCK ((GstClockEntry *) sink->priv->
2002 cached_clock_id) == clock)) {
2003 if (!gst_clock_single_shot_id_reinit (clock, sink->priv->cached_clock_id,
2005 gst_clock_id_unref (sink->priv->cached_clock_id);
2006 sink->priv->cached_clock_id = gst_clock_new_single_shot_id (clock, time);
2009 if (sink->priv->cached_clock_id != NULL)
2010 gst_clock_id_unref (sink->priv->cached_clock_id);
2011 sink->priv->cached_clock_id = gst_clock_new_single_shot_id (clock, time);
2013 GST_OBJECT_UNLOCK (sink);
2015 /* A blocking wait is performed on the clock. We save the ClockID
2016 * so we can unlock the entry at any time. While we are blocking, we
2017 * release the PREROLL_LOCK so that other threads can interrupt the
2019 sink->clock_id = sink->priv->cached_clock_id;
2020 /* release the preroll lock while waiting */
2021 GST_BASE_SINK_PREROLL_UNLOCK (sink);
2023 ret = gst_clock_id_wait (sink->priv->cached_clock_id, jitter);
2025 GST_BASE_SINK_PREROLL_LOCK (sink);
2026 sink->clock_id = NULL;
2030 /* no syncing needed */
2033 GST_DEBUG_OBJECT (sink, "time not valid, no sync needed");
2034 return GST_CLOCK_BADTIME;
2038 GST_DEBUG_OBJECT (sink, "sync disabled");
2039 GST_OBJECT_UNLOCK (sink);
2040 return GST_CLOCK_BADTIME;
2044 GST_DEBUG_OBJECT (sink, "no clock, can't sync");
2045 GST_OBJECT_UNLOCK (sink);
2046 return GST_CLOCK_BADTIME;
2051 * gst_base_sink_wait_preroll:
2054 * If the #GstBaseSinkClass.render() method performs its own synchronisation
2055 * against the clock it must unblock when going from PLAYING to the PAUSED state
2056 * and call this method before continuing to render the remaining data.
2058 * This function will block until a state change to PLAYING happens (in which
2059 * case this function returns #GST_FLOW_OK) or the processing must be stopped due
2060 * to a state change to READY or a FLUSH event (in which case this function
2061 * returns #GST_FLOW_FLUSHING).
2063 * This function should only be called with the PREROLL_LOCK held, like in the
2066 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2067 * continue. Any other return value should be returned from the render vmethod.
2072 gst_base_sink_wait_preroll (GstBaseSink * sink)
2074 sink->have_preroll = TRUE;
2075 GST_DEBUG_OBJECT (sink, "waiting in preroll for flush or PLAYING");
2076 /* block until the state changes, or we get a flush, or something */
2077 GST_BASE_SINK_PREROLL_WAIT (sink);
2078 sink->have_preroll = FALSE;
2079 if (G_UNLIKELY (sink->flushing))
2081 if (G_UNLIKELY (sink->priv->step_unlock))
2083 GST_DEBUG_OBJECT (sink, "continue after preroll");
2090 GST_DEBUG_OBJECT (sink, "preroll interrupted because of flush");
2091 return GST_FLOW_FLUSHING;
2095 sink->priv->step_unlock = FALSE;
2096 GST_DEBUG_OBJECT (sink, "preroll interrupted because of step");
2097 return GST_FLOW_STEP;
2102 * gst_base_sink_do_preroll:
2104 * @obj: (transfer none): the mini object that caused the preroll
2106 * If the @sink spawns its own thread for pulling buffers from upstream it
2107 * should call this method after it has pulled a buffer. If the element needed
2108 * to preroll, this function will perform the preroll and will then block
2109 * until the element state is changed.
2111 * This function should be called with the PREROLL_LOCK held.
2113 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2114 * continue. Any other return value should be returned from the render vmethod.
2119 gst_base_sink_do_preroll (GstBaseSink * sink, GstMiniObject * obj)
2123 while (G_UNLIKELY (sink->need_preroll)) {
2124 GST_DEBUG_OBJECT (sink, "prerolling object %p", obj);
2126 /* if it's a buffer, we need to call the preroll method */
2127 if (sink->priv->call_preroll) {
2128 GstBaseSinkClass *bclass;
2131 if (GST_IS_BUFFER_LIST (obj)) {
2132 buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0);
2133 g_assert (NULL != buf);
2134 } else if (GST_IS_BUFFER (obj)) {
2135 buf = GST_BUFFER_CAST (obj);
2136 /* For buffer lists do not set last buffer for now */
2137 gst_base_sink_set_last_buffer (sink, buf);
2142 GST_DEBUG_OBJECT (sink, "preroll buffer %" GST_TIME_FORMAT,
2143 GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buf)));
2145 bclass = GST_BASE_SINK_GET_CLASS (sink);
2147 if (bclass->prepare)
2148 if ((ret = bclass->prepare (sink, buf)) != GST_FLOW_OK)
2149 goto prepare_canceled;
2151 if (bclass->preroll)
2152 if ((ret = bclass->preroll (sink, buf)) != GST_FLOW_OK)
2153 goto preroll_canceled;
2155 sink->priv->call_preroll = FALSE;
2160 if (G_LIKELY (sink->playing_async)) {
2161 if (G_UNLIKELY (!gst_base_sink_commit_state (sink)))
2165 /* need to recheck here because the commit state could have
2166 * made us not need the preroll anymore */
2167 if (G_LIKELY (sink->need_preroll)) {
2168 /* block until the state changes, or we get a flush, or something */
2169 ret = gst_base_sink_wait_preroll (sink);
2170 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2171 goto preroll_failed;
2179 GST_DEBUG_OBJECT (sink, "prepare failed, abort state");
2180 gst_element_abort_state (GST_ELEMENT_CAST (sink));
2185 GST_DEBUG_OBJECT (sink, "preroll failed, abort state");
2186 gst_element_abort_state (GST_ELEMENT_CAST (sink));
2191 GST_DEBUG_OBJECT (sink, "stopping while commiting state");
2192 return GST_FLOW_FLUSHING;
2196 GST_DEBUG_OBJECT (sink, "preroll failed: %s", gst_flow_get_name (ret));
2202 * gst_base_sink_wait_eos:
2204 * @time: the running_time to be reached
2205 * @jitter: (out) (allow-none): the jitter to be filled with time diff, or NULL
2207 * This function will block until @time is reached. It is usually called by
2208 * subclasses that use their own internal synchronisation but want to let the
2209 * EOS be handled by the base class.
2211 * This function should only be called with the PREROLL_LOCK held, like when
2212 * receiving an EOS event in the ::event vmethod.
2214 * The @time argument should be the running_time of when the EOS should happen
2215 * and will be adjusted with any latency and offset configured in the sink.
2217 * Returns: #GstFlowReturn
2222 gst_base_sink_wait_eos (GstBaseSink * sink, GstClockTime time,
2223 GstClockTimeDiff * jitter)
2225 GstClockReturn status;
2231 GST_DEBUG_OBJECT (sink, "checking preroll");
2233 /* first wait for the playing state before we can continue */
2234 while (G_UNLIKELY (sink->need_preroll)) {
2235 ret = gst_base_sink_wait_preroll (sink);
2236 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2240 /* preroll done, we can sync since we are in PLAYING now. */
2241 GST_DEBUG_OBJECT (sink, "possibly waiting for clock to reach %"
2242 GST_TIME_FORMAT, GST_TIME_ARGS (time));
2244 /* compensate for latency, ts_offset and render delay */
2245 stime = gst_base_sink_adjust_time (sink, time);
2247 /* wait for the clock, this can be interrupted because we got shut down or
2249 status = gst_base_sink_wait_clock (sink, stime, jitter);
2251 GST_DEBUG_OBJECT (sink, "clock returned %d", status);
2253 /* invalid time, no clock or sync disabled, just continue then */
2254 if (status == GST_CLOCK_BADTIME)
2257 /* waiting could have been interrupted and we can be flushing now */
2258 if (G_UNLIKELY (sink->flushing))
2261 /* retry if we got unscheduled, which means we did not reach the timeout
2262 * yet. if some other error occures, we continue. */
2263 } while (status == GST_CLOCK_UNSCHEDULED);
2265 GST_DEBUG_OBJECT (sink, "end of stream");
2272 GST_DEBUG_OBJECT (sink, "we are flushing");
2273 return GST_FLOW_FLUSHING;
2277 /* with STREAM_LOCK, PREROLL_LOCK
2279 * Make sure we are in PLAYING and synchronize an object to the clock.
2281 * If we need preroll, we are not in PLAYING. We try to commit the state
2282 * if needed and then block if we still are not PLAYING.
2284 * We start waiting on the clock in PLAYING. If we got interrupted, we
2285 * immediately try to re-preroll.
2287 * Some objects do not need synchronisation (most events) and so this function
2288 * immediately returns GST_FLOW_OK.
2290 * for objects that arrive later than max-lateness to be synchronized to the
2291 * clock have the @late boolean set to TRUE.
2293 * This function keeps a running average of the jitter (the diff between the
2294 * clock time and the requested sync time). The jitter is negative for
2295 * objects that arrive in time and positive for late buffers.
2297 * does not take ownership of obj.
2299 static GstFlowReturn
2300 gst_base_sink_do_sync (GstBaseSink * basesink,
2301 GstMiniObject * obj, gboolean * late, gboolean * step_end)
2303 GstClockTimeDiff jitter = 0;
2305 GstClockReturn status = GST_CLOCK_OK;
2306 GstClockTime rstart, rstop, sstart, sstop, stime;
2308 GstBaseSinkPrivate *priv;
2310 GstStepInfo *current, *pending;
2313 priv = basesink->priv;
2316 sstart = sstop = rstart = rstop = GST_CLOCK_TIME_NONE;
2320 priv->current_rstart = GST_CLOCK_TIME_NONE;
2322 /* get stepping info */
2323 current = &priv->current_step;
2324 pending = &priv->pending_step;
2326 /* get timing information for this object against the render segment */
2327 syncable = gst_base_sink_get_sync_times (basesink, obj,
2328 &sstart, &sstop, &rstart, &rstop, &do_sync, &stepped, current, step_end);
2330 if (G_UNLIKELY (stepped))
2333 /* a syncable object needs to participate in preroll and
2334 * clocking. All buffers and EOS are syncable. */
2335 if (G_UNLIKELY (!syncable))
2338 /* store timing info for current object */
2339 priv->current_rstart = rstart;
2340 priv->current_rstop = (GST_CLOCK_TIME_IS_VALID (rstop) ? rstop : rstart);
2342 /* save sync time for eos when the previous object needed sync */
2343 priv->eos_rtime = (do_sync ? priv->current_rstop : GST_CLOCK_TIME_NONE);
2345 /* calculate inter frame spacing */
2346 if (G_UNLIKELY (priv->prev_rstart != -1 && priv->prev_rstart < rstart)) {
2347 GstClockTime in_diff;
2349 in_diff = rstart - priv->prev_rstart;
2351 if (priv->avg_in_diff == -1)
2352 priv->avg_in_diff = in_diff;
2354 priv->avg_in_diff = UPDATE_RUNNING_AVG (priv->avg_in_diff, in_diff);
2356 GST_LOG_OBJECT (basesink, "avg frame diff %" GST_TIME_FORMAT,
2357 GST_TIME_ARGS (priv->avg_in_diff));
2360 priv->prev_rstart = rstart;
2362 if (G_UNLIKELY (priv->earliest_in_time != -1
2363 && rstart < priv->earliest_in_time))
2367 /* first do preroll, this makes sure we commit our state
2368 * to PAUSED and can continue to PLAYING. We cannot perform
2369 * any clock sync in PAUSED because there is no clock. */
2370 ret = gst_base_sink_do_preroll (basesink, obj);
2371 if (G_UNLIKELY (ret != GST_FLOW_OK))
2372 goto preroll_failed;
2374 /* update the segment with a pending step if the current one is invalid and we
2375 * have a new pending one. We only accept new step updates after a preroll */
2376 if (G_UNLIKELY (pending->valid && !current->valid)) {
2377 start_stepping (basesink, &basesink->segment, pending, current);
2381 /* After rendering we store the position of the last buffer so that we can use
2382 * it to report the position. We need to take the lock here. */
2383 GST_OBJECT_LOCK (basesink);
2384 priv->current_sstart = sstart;
2385 priv->current_sstop = (GST_CLOCK_TIME_IS_VALID (sstop) ? sstop : sstart);
2386 GST_OBJECT_UNLOCK (basesink);
2391 /* adjust for latency */
2392 stime = gst_base_sink_adjust_time (basesink, rstart);
2394 /* preroll done, we can sync since we are in PLAYING now. */
2395 GST_DEBUG_OBJECT (basesink, "possibly waiting for clock to reach %"
2396 GST_TIME_FORMAT ", adjusted %" GST_TIME_FORMAT,
2397 GST_TIME_ARGS (rstart), GST_TIME_ARGS (stime));
2399 /* This function will return immediately if start == -1, no clock
2400 * or sync is disabled with GST_CLOCK_BADTIME. */
2401 status = gst_base_sink_wait_clock (basesink, stime, &jitter);
2403 GST_DEBUG_OBJECT (basesink, "clock returned %d, jitter %c%" GST_TIME_FORMAT,
2404 status, (jitter < 0 ? '-' : ' '), GST_TIME_ARGS (ABS (jitter)));
2406 /* invalid time, no clock or sync disabled, just render */
2407 if (status == GST_CLOCK_BADTIME)
2410 /* waiting could have been interrupted and we can be flushing now */
2411 if (G_UNLIKELY (basesink->flushing))
2414 /* check for unlocked by a state change, we are not flushing so
2415 * we can try to preroll on the current buffer. */
2416 if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED)) {
2417 GST_DEBUG_OBJECT (basesink, "unscheduled, waiting some more");
2418 priv->call_preroll = TRUE;
2422 /* successful syncing done, record observation */
2423 priv->current_jitter = jitter;
2425 /* check if the object should be dropped */
2426 *late = gst_base_sink_is_too_late (basesink, obj, rstart, rstop,
2435 GST_DEBUG_OBJECT (basesink, "skipped stepped object %p", obj);
2441 GST_DEBUG_OBJECT (basesink, "non syncable object %p", obj);
2446 GST_DEBUG_OBJECT (basesink, "dropped because of QoS %p", obj);
2452 GST_DEBUG_OBJECT (basesink, "we are flushing");
2453 return GST_FLOW_FLUSHING;
2457 GST_DEBUG_OBJECT (basesink, "preroll failed");
2464 gst_base_sink_send_qos (GstBaseSink * basesink, GstQOSType type,
2465 gdouble proportion, GstClockTime time, GstClockTimeDiff diff)
2470 /* generate Quality-of-Service event */
2471 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2472 "qos: type %d, proportion: %lf, diff %" G_GINT64_FORMAT ", timestamp %"
2473 GST_TIME_FORMAT, type, proportion, diff, GST_TIME_ARGS (time));
2475 event = gst_event_new_qos (type, proportion, diff, time);
2478 res = gst_pad_push_event (basesink->sinkpad, event);
2484 gst_base_sink_perform_qos (GstBaseSink * sink, gboolean dropped)
2486 GstBaseSinkPrivate *priv;
2487 GstClockTime start, stop;
2488 GstClockTimeDiff jitter;
2489 GstClockTime pt, entered, left;
2490 GstClockTime duration;
2495 start = priv->current_rstart;
2497 if (priv->current_step.valid)
2500 /* if Quality-of-Service disabled, do nothing */
2501 if (!g_atomic_int_get (&priv->qos_enabled) ||
2502 !GST_CLOCK_TIME_IS_VALID (start))
2505 stop = priv->current_rstop;
2506 jitter = priv->current_jitter;
2509 /* this is the time the buffer entered the sink */
2510 if (start < -jitter)
2513 entered = start + jitter;
2516 /* this is the time the buffer entered the sink */
2517 entered = start + jitter;
2518 /* this is the time the buffer left the sink */
2519 left = start + jitter;
2522 /* calculate duration of the buffer */
2523 if (GST_CLOCK_TIME_IS_VALID (stop) && stop != start)
2524 duration = stop - start;
2526 duration = priv->avg_in_diff;
2528 /* if we have the time when the last buffer left us, calculate
2529 * processing time */
2530 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2531 if (entered > priv->last_left) {
2532 pt = entered - priv->last_left;
2540 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "start: %" GST_TIME_FORMAT
2541 ", stop %" GST_TIME_FORMAT ", entered %" GST_TIME_FORMAT ", left %"
2542 GST_TIME_FORMAT ", pt: %" GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT
2543 ",jitter %" G_GINT64_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (stop),
2544 GST_TIME_ARGS (entered), GST_TIME_ARGS (left), GST_TIME_ARGS (pt),
2545 GST_TIME_ARGS (duration), jitter);
2547 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "avg_duration: %" GST_TIME_FORMAT
2548 ", avg_pt: %" GST_TIME_FORMAT ", avg_rate: %g",
2549 GST_TIME_ARGS (priv->avg_duration), GST_TIME_ARGS (priv->avg_pt),
2552 /* collect running averages. for first observations, we copy the
2554 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_duration))
2555 priv->avg_duration = duration;
2557 priv->avg_duration = UPDATE_RUNNING_AVG (priv->avg_duration, duration);
2559 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_pt))
2562 priv->avg_pt = UPDATE_RUNNING_AVG (priv->avg_pt, pt);
2564 if (priv->avg_duration != 0)
2566 gst_guint64_to_gdouble (priv->avg_pt) /
2567 gst_guint64_to_gdouble (priv->avg_duration);
2571 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2572 if (dropped || priv->avg_rate < 0.0) {
2573 priv->avg_rate = rate;
2576 priv->avg_rate = UPDATE_RUNNING_AVG_N (priv->avg_rate, rate);
2578 priv->avg_rate = UPDATE_RUNNING_AVG_P (priv->avg_rate, rate);
2582 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink,
2583 "updated: avg_duration: %" GST_TIME_FORMAT ", avg_pt: %" GST_TIME_FORMAT
2584 ", avg_rate: %g", GST_TIME_ARGS (priv->avg_duration),
2585 GST_TIME_ARGS (priv->avg_pt), priv->avg_rate);
2588 if (priv->avg_rate >= 0.0) {
2590 GstClockTimeDiff diff;
2592 /* if we have a valid rate, start sending QoS messages */
2593 if (priv->current_jitter < 0) {
2594 /* make sure we never go below 0 when adding the jitter to the
2596 if (priv->current_rstart < -priv->current_jitter)
2597 priv->current_jitter = -priv->current_rstart;
2600 if (priv->throttle_time > 0) {
2601 diff = priv->throttle_time;
2602 type = GST_QOS_TYPE_THROTTLE;
2604 diff = priv->current_jitter;
2606 type = GST_QOS_TYPE_OVERFLOW;
2608 type = GST_QOS_TYPE_UNDERFLOW;
2611 gst_base_sink_send_qos (sink, type, priv->avg_rate, priv->current_rstart,
2615 /* record when this buffer will leave us */
2616 priv->last_left = left;
2619 /* reset all qos measuring */
2621 gst_base_sink_reset_qos (GstBaseSink * sink)
2623 GstBaseSinkPrivate *priv;
2627 priv->last_render_time = GST_CLOCK_TIME_NONE;
2628 priv->prev_rstart = GST_CLOCK_TIME_NONE;
2629 priv->earliest_in_time = GST_CLOCK_TIME_NONE;
2630 priv->last_left = GST_CLOCK_TIME_NONE;
2631 priv->avg_duration = GST_CLOCK_TIME_NONE;
2632 priv->avg_pt = GST_CLOCK_TIME_NONE;
2633 priv->avg_rate = -1.0;
2634 priv->avg_render = GST_CLOCK_TIME_NONE;
2635 priv->avg_in_diff = GST_CLOCK_TIME_NONE;
2641 /* Checks if the object was scheduled too late.
2643 * rstart/rstop contain the running_time start and stop values
2646 * status and jitter contain the return values from the clock wait.
2648 * returns TRUE if the buffer was too late.
2651 gst_base_sink_is_too_late (GstBaseSink * basesink, GstMiniObject * obj,
2652 GstClockTime rstart, GstClockTime rstop,
2653 GstClockReturn status, GstClockTimeDiff jitter)
2656 guint64 max_lateness;
2657 GstBaseSinkPrivate *priv;
2659 priv = basesink->priv;
2663 /* only for objects that were too late */
2664 if (G_LIKELY (status != GST_CLOCK_EARLY))
2667 max_lateness = basesink->max_lateness;
2669 /* check if frame dropping is enabled */
2670 if (max_lateness == -1)
2673 /* only check for buffers */
2674 if (G_UNLIKELY (!GST_IS_BUFFER (obj)))
2677 /* can't do check if we don't have a timestamp */
2678 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (rstart)))
2681 /* we can add a valid stop time */
2682 if (GST_CLOCK_TIME_IS_VALID (rstop))
2683 max_lateness += rstop;
2685 max_lateness += rstart;
2686 /* no stop time, use avg frame diff */
2687 if (priv->avg_in_diff != -1)
2688 max_lateness += priv->avg_in_diff;
2691 /* if the jitter bigger than duration and lateness we are too late */
2692 if ((late = rstart + jitter > max_lateness)) {
2693 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2694 "buffer is too late %" GST_TIME_FORMAT
2695 " > %" GST_TIME_FORMAT, GST_TIME_ARGS (rstart + jitter),
2696 GST_TIME_ARGS (max_lateness));
2697 /* !!emergency!!, if we did not receive anything valid for more than a
2698 * second, render it anyway so the user sees something */
2699 if (GST_CLOCK_TIME_IS_VALID (priv->last_render_time) &&
2700 rstart - priv->last_render_time > GST_SECOND) {
2702 GST_ELEMENT_WARNING (basesink, CORE, CLOCK,
2703 (_("A lot of buffers are being dropped.")),
2704 ("There may be a timestamping problem, or this computer is too slow."));
2705 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2706 "**emergency** last buffer at %" GST_TIME_FORMAT " > GST_SECOND",
2707 GST_TIME_ARGS (priv->last_render_time));
2712 if (!late || !GST_CLOCK_TIME_IS_VALID (priv->last_render_time)) {
2713 priv->last_render_time = rstart;
2714 /* the next allowed input timestamp */
2715 if (priv->throttle_time > 0)
2716 priv->earliest_in_time = rstart + priv->throttle_time;
2723 GST_DEBUG_OBJECT (basesink, "object was scheduled in time");
2728 GST_DEBUG_OBJECT (basesink, "frame dropping disabled");
2733 GST_DEBUG_OBJECT (basesink, "object is not a buffer");
2738 GST_DEBUG_OBJECT (basesink, "buffer has no timestamp");
2743 /* called before and after calling the render vmethod. It keeps track of how
2744 * much time was spent in the render method and is used to check if we are
2747 gst_base_sink_do_render_stats (GstBaseSink * basesink, gboolean start)
2749 GstBaseSinkPrivate *priv;
2751 priv = basesink->priv;
2754 priv->start = gst_util_get_timestamp ();
2756 GstClockTime elapsed;
2758 priv->stop = gst_util_get_timestamp ();
2760 elapsed = GST_CLOCK_DIFF (priv->start, priv->stop);
2762 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_render))
2763 priv->avg_render = elapsed;
2765 priv->avg_render = UPDATE_RUNNING_AVG (priv->avg_render, elapsed);
2767 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2768 "avg_render: %" GST_TIME_FORMAT, GST_TIME_ARGS (priv->avg_render));
2773 gst_base_sink_flush_start (GstBaseSink * basesink, GstPad * pad)
2775 /* make sure we are not blocked on the clock also clear any pending
2777 gst_base_sink_set_flushing (basesink, pad, TRUE);
2779 /* we grab the stream lock but that is not needed since setting the
2780 * sink to flushing would make sure no state commit is being done
2782 GST_PAD_STREAM_LOCK (pad);
2783 gst_base_sink_reset_qos (basesink);
2784 /* and we need to commit our state again on the next
2785 * prerolled buffer */
2786 basesink->playing_async = TRUE;
2787 if (basesink->priv->async_enabled) {
2788 gst_element_lost_state (GST_ELEMENT_CAST (basesink));
2790 /* start time reset in above case as well;
2791 * arranges for a.o. proper position reporting when flushing in PAUSED */
2792 gst_element_set_start_time (GST_ELEMENT_CAST (basesink), 0);
2793 basesink->priv->have_latency = TRUE;
2795 gst_base_sink_set_last_buffer (basesink, NULL);
2796 GST_PAD_STREAM_UNLOCK (pad);
2800 gst_base_sink_flush_stop (GstBaseSink * basesink, GstPad * pad,
2801 gboolean reset_time)
2803 /* unset flushing so we can accept new data, this also flushes out any EOS
2805 gst_base_sink_set_flushing (basesink, pad, FALSE);
2807 /* for position reporting */
2808 GST_OBJECT_LOCK (basesink);
2809 basesink->priv->current_sstart = GST_CLOCK_TIME_NONE;
2810 basesink->priv->current_sstop = GST_CLOCK_TIME_NONE;
2811 basesink->priv->eos_rtime = GST_CLOCK_TIME_NONE;
2812 basesink->priv->call_preroll = TRUE;
2813 basesink->priv->current_step.valid = FALSE;
2814 basesink->priv->pending_step.valid = FALSE;
2815 if (basesink->pad_mode == GST_PAD_MODE_PUSH) {
2816 /* we need new segment info after the flush. */
2817 basesink->have_newsegment = FALSE;
2819 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
2822 GST_OBJECT_UNLOCK (basesink);
2825 GST_DEBUG_OBJECT (basesink, "posting reset-time message");
2826 gst_element_post_message (GST_ELEMENT_CAST (basesink),
2827 gst_message_new_reset_time (GST_OBJECT_CAST (basesink), 0));
2831 static GstFlowReturn
2832 gst_base_sink_default_wait_eos (GstBaseSink * basesink, GstEvent * event)
2835 gboolean late, step_end;
2837 ret = gst_base_sink_do_sync (basesink, GST_MINI_OBJECT_CAST (event),
2844 gst_base_sink_default_event (GstBaseSink * basesink, GstEvent * event)
2846 gboolean result = TRUE;
2847 GstBaseSinkClass *bclass;
2849 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2851 switch (GST_EVENT_TYPE (event)) {
2852 case GST_EVENT_FLUSH_START:
2854 GST_DEBUG_OBJECT (basesink, "flush-start %p", event);
2855 gst_base_sink_flush_start (basesink, basesink->sinkpad);
2858 case GST_EVENT_FLUSH_STOP:
2860 gboolean reset_time;
2862 gst_event_parse_flush_stop (event, &reset_time);
2863 GST_DEBUG_OBJECT (basesink, "flush-stop %p, reset_time: %d", event,
2865 gst_base_sink_flush_stop (basesink, basesink->sinkpad, reset_time);
2870 GstMessage *message;
2873 /* we set the received EOS flag here so that we can use it when testing if
2874 * we are prerolled and to refuse more buffers. */
2875 basesink->priv->received_eos = TRUE;
2878 if (G_LIKELY (bclass->wait_eos)) {
2881 ret = bclass->wait_eos (basesink, event);
2882 if (G_UNLIKELY (ret != GST_FLOW_OK)) {
2888 /* the EOS event is completely handled so we mark
2889 * ourselves as being in the EOS state. eos is also
2890 * protected by the object lock so we can read it when
2891 * answering the POSITION query. */
2892 GST_OBJECT_LOCK (basesink);
2893 basesink->eos = TRUE;
2894 GST_OBJECT_UNLOCK (basesink);
2896 /* ok, now we can post the message */
2897 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
2899 seqnum = basesink->priv->seqnum = gst_event_get_seqnum (event);
2900 GST_DEBUG_OBJECT (basesink, "Got seqnum #%" G_GUINT32_FORMAT, seqnum);
2902 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
2903 gst_message_set_seqnum (message, seqnum);
2904 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
2907 case GST_EVENT_CAPS:
2911 GST_DEBUG_OBJECT (basesink, "caps %p", event);
2913 gst_event_parse_caps (event, &caps);
2914 if (bclass->set_caps)
2915 result = bclass->set_caps (basesink, caps);
2918 GST_OBJECT_LOCK (basesink);
2919 gst_caps_replace (&basesink->priv->caps, caps);
2920 GST_OBJECT_UNLOCK (basesink);
2924 case GST_EVENT_SEGMENT:
2925 /* configure the segment */
2926 /* The segment is protected with both the STREAM_LOCK and the OBJECT_LOCK.
2927 * We protect with the OBJECT_LOCK so that we can use the values to
2928 * safely answer a POSITION query. */
2929 GST_OBJECT_LOCK (basesink);
2930 /* the newsegment event is needed to bring the buffer timestamps to the
2931 * stream time and to drop samples outside of the playback segment. */
2932 gst_event_copy_segment (event, &basesink->segment);
2933 GST_DEBUG_OBJECT (basesink, "configured SEGMENT %" GST_SEGMENT_FORMAT,
2934 &basesink->segment);
2935 basesink->have_newsegment = TRUE;
2936 GST_OBJECT_UNLOCK (basesink);
2940 GstTagList *taglist;
2942 gst_event_parse_tag (event, &taglist);
2944 gst_element_post_message (GST_ELEMENT_CAST (basesink),
2945 gst_message_new_tag (GST_OBJECT_CAST (basesink),
2946 gst_tag_list_copy (taglist)));
2949 case GST_EVENT_SINK_MESSAGE:
2951 GstMessage *msg = NULL;
2953 gst_event_parse_sink_message (event, &msg);
2955 gst_element_post_message (GST_ELEMENT_CAST (basesink), msg);
2962 gst_event_unref (event);
2968 gst_base_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
2970 GstBaseSink *basesink;
2971 gboolean result = TRUE;
2972 GstBaseSinkClass *bclass;
2974 basesink = GST_BASE_SINK_CAST (parent);
2975 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2977 GST_DEBUG_OBJECT (basesink, "received event %p %" GST_PTR_FORMAT, event,
2980 switch (GST_EVENT_TYPE (event)) {
2981 case GST_EVENT_FLUSH_STOP:
2982 /* special case for this serialized event because we don't want to grab
2983 * the PREROLL lock or check if we were flushing */
2985 result = bclass->event (basesink, event);
2988 if (GST_EVENT_IS_SERIALIZED (event)) {
2989 GST_BASE_SINK_PREROLL_LOCK (basesink);
2990 if (G_UNLIKELY (basesink->flushing))
2993 if (G_UNLIKELY (basesink->priv->received_eos))
2997 result = bclass->event (basesink, event);
2999 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3002 result = bclass->event (basesink, event);
3012 GST_DEBUG_OBJECT (basesink, "we are flushing");
3013 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3014 gst_event_unref (event);
3021 GST_DEBUG_OBJECT (basesink, "Event received after EOS, dropping");
3022 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3023 gst_event_unref (event);
3029 /* default implementation to calculate the start and end
3030 * timestamps on a buffer, subclasses can override
3033 gst_base_sink_default_get_times (GstBaseSink * basesink, GstBuffer * buffer,
3034 GstClockTime * start, GstClockTime * end)
3036 GstClockTime timestamp, duration;
3038 /* first sync on DTS, else use PTS */
3039 timestamp = GST_BUFFER_DTS (buffer);
3040 if (!GST_CLOCK_TIME_IS_VALID (timestamp))
3041 timestamp = GST_BUFFER_PTS (buffer);
3043 if (GST_CLOCK_TIME_IS_VALID (timestamp)) {
3044 /* get duration to calculate end time */
3045 duration = GST_BUFFER_DURATION (buffer);
3046 if (GST_CLOCK_TIME_IS_VALID (duration)) {
3047 *end = timestamp + duration;
3053 /* must be called with PREROLL_LOCK */
3055 gst_base_sink_needs_preroll (GstBaseSink * basesink)
3057 gboolean is_prerolled, res;
3059 /* we have 2 cases where the PREROLL_LOCK is released:
3060 * 1) we are blocking in the PREROLL_LOCK and thus are prerolled.
3061 * 2) we are syncing on the clock
3063 is_prerolled = basesink->have_preroll || basesink->priv->received_eos;
3064 res = !is_prerolled;
3066 GST_DEBUG_OBJECT (basesink, "have_preroll: %d, EOS: %d => needs preroll: %d",
3067 basesink->have_preroll, basesink->priv->received_eos, res);
3072 /* with STREAM_LOCK, PREROLL_LOCK
3074 * Takes a buffer and compare the timestamps with the last segment.
3075 * If the buffer falls outside of the segment boundaries, drop it.
3076 * Else send the buffer for preroll and rendering.
3078 * This function takes ownership of the buffer.
3080 static GstFlowReturn
3081 gst_base_sink_chain_unlocked (GstBaseSink * basesink, GstPad * pad,
3082 gpointer obj, gboolean is_list)
3084 GstBaseSinkClass *bclass;
3085 GstBaseSinkPrivate *priv = basesink->priv;
3087 GstClockTime start = GST_CLOCK_TIME_NONE, end = GST_CLOCK_TIME_NONE;
3088 GstSegment *segment;
3089 GstBuffer *sync_buf;
3091 gboolean late, step_end;
3093 if (G_UNLIKELY (basesink->flushing))
3096 if (G_UNLIKELY (priv->received_eos))
3100 sync_buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0);
3101 g_assert (NULL != sync_buf);
3103 sync_buf = GST_BUFFER_CAST (obj);
3106 /* for code clarity */
3107 segment = &basesink->segment;
3109 if (G_UNLIKELY (!basesink->have_newsegment)) {
3112 sync = gst_base_sink_get_sync (basesink);
3114 GST_ELEMENT_WARNING (basesink, STREAM, FAILED,
3115 (_("Internal data flow problem.")),
3116 ("Received buffer without a new-segment. Assuming timestamps start from 0."));
3119 /* this means this sink will assume timestamps start from 0 */
3120 GST_OBJECT_LOCK (basesink);
3123 basesink->segment.start = 0;
3124 basesink->segment.stop = -1;
3125 basesink->have_newsegment = TRUE;
3126 GST_OBJECT_UNLOCK (basesink);
3129 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3131 /* check if the buffer needs to be dropped, we first ask the subclass for the
3133 if (bclass->get_times)
3134 bclass->get_times (basesink, sync_buf, &start, &end);
3136 if (!GST_CLOCK_TIME_IS_VALID (start)) {
3137 /* if the subclass does not want sync, we use our own values so that we at
3138 * least clip the buffer to the segment */
3139 gst_base_sink_default_get_times (basesink, sync_buf, &start, &end);
3142 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
3143 ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (end));
3145 /* a dropped buffer does not participate in anything */
3146 if (GST_CLOCK_TIME_IS_VALID (start) && (segment->format == GST_FORMAT_TIME)) {
3147 if (G_UNLIKELY (!gst_segment_clip (segment,
3148 GST_FORMAT_TIME, start, end, NULL, NULL)))
3149 goto out_of_segment;
3153 if (bclass->prepare) {
3154 ret = bclass->prepare (basesink, GST_BUFFER_CAST (obj));
3155 if (G_UNLIKELY (ret != GST_FLOW_OK))
3156 goto prepare_failed;
3159 if (bclass->prepare_list) {
3160 ret = bclass->prepare_list (basesink, GST_BUFFER_LIST_CAST (obj));
3161 if (G_UNLIKELY (ret != GST_FLOW_OK))
3162 goto prepare_failed;
3170 /* synchronize this object, non syncable objects return OK
3172 ret = gst_base_sink_do_sync (basesink, GST_MINI_OBJECT_CAST (sync_buf),
3174 if (G_UNLIKELY (ret != GST_FLOW_OK))
3177 /* drop late buffers unconditionally, let's hope it's unlikely */
3178 if (G_UNLIKELY (late))
3181 /* read once, to get same value before and after */
3182 do_qos = g_atomic_int_get (&priv->qos_enabled);
3184 GST_DEBUG_OBJECT (basesink, "rendering object %p", obj);
3186 /* record rendering time for QoS and stats */
3188 gst_base_sink_do_render_stats (basesink, TRUE);
3191 /* For buffer lists do not set last buffer for now. */
3192 gst_base_sink_set_last_buffer (basesink, GST_BUFFER_CAST (obj));
3195 ret = bclass->render (basesink, GST_BUFFER_CAST (obj));
3197 if (bclass->render_list)
3198 ret = bclass->render_list (basesink, GST_BUFFER_LIST_CAST (obj));
3202 gst_base_sink_do_render_stats (basesink, FALSE);
3204 if (ret == GST_FLOW_STEP)
3207 if (G_UNLIKELY (basesink->flushing))
3214 /* the step ended, check if we need to activate a new step */
3215 GST_DEBUG_OBJECT (basesink, "step ended");
3216 stop_stepping (basesink, &basesink->segment, &priv->current_step,
3217 priv->current_rstart, priv->current_rstop, basesink->eos);
3221 gst_base_sink_perform_qos (basesink, late);
3223 GST_DEBUG_OBJECT (basesink, "object unref after render %p", obj);
3224 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3231 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3232 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3233 return GST_FLOW_FLUSHING;
3237 GST_DEBUG_OBJECT (basesink, "we are EOS, dropping object, return EOS");
3238 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3239 return GST_FLOW_EOS;
3243 GST_DEBUG_OBJECT (basesink, "dropping buffer, out of clipping segment");
3244 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3249 GST_DEBUG_OBJECT (basesink, "prepare buffer failed %s",
3250 gst_flow_get_name (ret));
3251 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3256 GST_DEBUG_OBJECT (basesink, "do_sync returned %s", gst_flow_get_name (ret));
3262 GST_DEBUG_OBJECT (basesink, "buffer late, dropping");
3264 if (g_atomic_int_get (&priv->qos_enabled)) {
3265 GstMessage *qos_msg;
3266 GstClockTime timestamp, duration;
3268 timestamp = GST_BUFFER_TIMESTAMP (GST_BUFFER_CAST (sync_buf));
3269 duration = GST_BUFFER_DURATION (GST_BUFFER_CAST (sync_buf));
3271 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
3272 "qos: dropped buffer rt %" GST_TIME_FORMAT ", st %" GST_TIME_FORMAT
3273 ", ts %" GST_TIME_FORMAT ", dur %" GST_TIME_FORMAT,
3274 GST_TIME_ARGS (priv->current_rstart),
3275 GST_TIME_ARGS (priv->current_sstart), GST_TIME_ARGS (timestamp),
3276 GST_TIME_ARGS (duration));
3277 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
3278 "qos: rendered %" G_GUINT64_FORMAT ", dropped %" G_GUINT64_FORMAT,
3279 priv->rendered, priv->dropped);
3282 gst_message_new_qos (GST_OBJECT_CAST (basesink), basesink->sync,
3283 priv->current_rstart, priv->current_sstart, timestamp, duration);
3284 gst_message_set_qos_values (qos_msg, priv->current_jitter, priv->avg_rate,
3286 gst_message_set_qos_stats (qos_msg, GST_FORMAT_BUFFERS, priv->rendered,
3288 gst_element_post_message (GST_ELEMENT_CAST (basesink), qos_msg);
3296 static GstFlowReturn
3297 gst_base_sink_chain_main (GstBaseSink * basesink, GstPad * pad, gpointer obj,
3300 GstFlowReturn result;
3302 if (G_UNLIKELY (basesink->pad_mode != GST_PAD_MODE_PUSH))
3305 GST_BASE_SINK_PREROLL_LOCK (basesink);
3306 result = gst_base_sink_chain_unlocked (basesink, pad, obj, is_list);
3307 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3315 GST_OBJECT_LOCK (pad);
3316 GST_WARNING_OBJECT (basesink,
3317 "Push on pad %s:%s, but it was not activated in push mode",
3318 GST_DEBUG_PAD_NAME (pad));
3319 GST_OBJECT_UNLOCK (pad);
3320 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3321 /* we don't post an error message this will signal to the peer
3322 * pushing that EOS is reached. */
3323 result = GST_FLOW_EOS;
3328 static GstFlowReturn
3329 gst_base_sink_chain (GstPad * pad, GstObject * parent, GstBuffer * buf)
3331 GstBaseSink *basesink;
3333 basesink = GST_BASE_SINK (parent);
3335 return gst_base_sink_chain_main (basesink, pad, buf, FALSE);
3338 static GstFlowReturn
3339 gst_base_sink_chain_list (GstPad * pad, GstObject * parent,
3340 GstBufferList * list)
3342 GstBaseSink *basesink;
3343 GstBaseSinkClass *bclass;
3344 GstFlowReturn result;
3346 basesink = GST_BASE_SINK (parent);
3347 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3349 if (G_LIKELY (bclass->render_list)) {
3350 result = gst_base_sink_chain_main (basesink, pad, list, TRUE);
3355 GST_INFO_OBJECT (pad, "chaining each group in list as a merged buffer");
3357 len = gst_buffer_list_length (list);
3359 result = GST_FLOW_OK;
3360 for (i = 0; i < len; i++) {
3361 buffer = gst_buffer_list_get (list, i);
3362 result = gst_base_sink_chain_main (basesink, pad,
3363 gst_buffer_ref (buffer), FALSE);
3364 if (result != GST_FLOW_OK)
3367 gst_buffer_list_unref (list);
3374 gst_base_sink_default_do_seek (GstBaseSink * sink, GstSegment * segment)
3376 gboolean res = TRUE;
3378 /* update our offset if the start/stop position was updated */
3379 if (segment->format == GST_FORMAT_BYTES) {
3380 segment->time = segment->start;
3381 } else if (segment->start == 0) {
3382 /* seek to start, we can implement a default for this. */
3386 GST_INFO_OBJECT (sink, "Can't do a default seek");
3392 #define SEEK_TYPE_IS_RELATIVE(t) (((t) != GST_SEEK_TYPE_NONE) && ((t) != GST_SEEK_TYPE_SET))
3395 gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
3396 GstEvent * event, GstSegment * segment)
3398 /* By default, we try one of 2 things:
3399 * - For absolute seek positions, convert the requested position to our
3400 * configured processing format and place it in the output segment \
3401 * - For relative seek positions, convert our current (input) values to the
3402 * seek format, adjust by the relative seek offset and then convert back to
3403 * the processing format
3405 GstSeekType cur_type, stop_type;
3408 GstFormat seek_format;
3411 gboolean res = TRUE;
3413 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3414 &cur_type, &cur, &stop_type, &stop);
3416 if (seek_format == segment->format) {
3417 gst_segment_do_seek (segment, rate, seek_format, flags,
3418 cur_type, cur, stop_type, stop, &update);
3422 if (cur_type != GST_SEEK_TYPE_NONE) {
3423 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3425 gst_pad_query_convert (sink->sinkpad, seek_format, cur, segment->format,
3427 cur_type = GST_SEEK_TYPE_SET;
3430 if (res && stop_type != GST_SEEK_TYPE_NONE) {
3431 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3433 gst_pad_query_convert (sink->sinkpad, seek_format, stop,
3434 segment->format, &stop);
3435 stop_type = GST_SEEK_TYPE_SET;
3438 /* And finally, configure our output segment in the desired format */
3439 gst_segment_do_seek (segment, rate, segment->format, flags, cur_type, cur,
3440 stop_type, stop, &update);
3449 GST_DEBUG_OBJECT (sink, "undefined format given, seek aborted.");
3454 /* perform a seek, only executed in pull mode */
3456 gst_base_sink_perform_seek (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3460 GstFormat seek_format, dest_format;
3462 GstSeekType cur_type, stop_type;
3463 gboolean seekseg_configured = FALSE;
3465 gboolean update, res = TRUE;
3466 GstSegment seeksegment;
3468 dest_format = sink->segment.format;
3471 GST_DEBUG_OBJECT (sink, "performing seek with event %p", event);
3472 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3473 &cur_type, &cur, &stop_type, &stop);
3475 flush = flags & GST_SEEK_FLAG_FLUSH;
3477 GST_DEBUG_OBJECT (sink, "performing seek without event");
3482 GST_DEBUG_OBJECT (sink, "flushing upstream");
3483 gst_pad_push_event (pad, gst_event_new_flush_start ());
3484 gst_base_sink_flush_start (sink, pad);
3486 GST_DEBUG_OBJECT (sink, "pausing pulling thread");
3489 GST_PAD_STREAM_LOCK (pad);
3491 /* If we configured the seeksegment above, don't overwrite it now. Otherwise
3492 * copy the current segment info into the temp segment that we can actually
3493 * attempt the seek with. We only update the real segment if the seek succeeds. */
3494 if (!seekseg_configured) {
3495 memcpy (&seeksegment, &sink->segment, sizeof (GstSegment));
3497 /* now configure the final seek segment */
3499 if (sink->segment.format != seek_format) {
3500 /* OK, here's where we give the subclass a chance to convert the relative
3501 * seek into an absolute one in the processing format. We set up any
3502 * absolute seek above, before taking the stream lock. */
3503 if (!gst_base_sink_default_prepare_seek_segment (sink, event,
3505 GST_DEBUG_OBJECT (sink,
3506 "Preparing the seek failed after flushing. " "Aborting seek");
3510 /* The seek format matches our processing format, no need to ask the
3511 * the subclass to configure the segment. */
3512 gst_segment_do_seek (&seeksegment, rate, seek_format, flags,
3513 cur_type, cur, stop_type, stop, &update);
3516 /* Else, no seek event passed, so we're just (re)starting the
3521 GST_DEBUG_OBJECT (sink, "segment configured from %" G_GINT64_FORMAT
3522 " to %" G_GINT64_FORMAT ", position %" G_GINT64_FORMAT,
3523 seeksegment.start, seeksegment.stop, seeksegment.position);
3525 /* do the seek, segment.position contains the new position. */
3526 res = gst_base_sink_default_do_seek (sink, &seeksegment);
3531 GST_DEBUG_OBJECT (sink, "stop flushing upstream");
3532 gst_pad_push_event (pad, gst_event_new_flush_stop (TRUE));
3533 gst_base_sink_flush_stop (sink, pad, TRUE);
3534 } else if (res && sink->running) {
3535 /* we are running the current segment and doing a non-flushing seek,
3536 * close the segment first based on the position. */
3537 GST_DEBUG_OBJECT (sink, "closing running segment %" G_GINT64_FORMAT
3538 " to %" G_GINT64_FORMAT, sink->segment.start, sink->segment.position);
3541 /* The subclass must have converted the segment to the processing format
3543 if (res && seeksegment.format != dest_format) {
3544 GST_DEBUG_OBJECT (sink, "Subclass failed to prepare a seek segment "
3545 "in the correct format. Aborting seek.");
3549 /* if successful seek, we update our real segment and push
3550 * out the new segment. */
3552 gst_segment_copy_into (&seeksegment, &sink->segment);
3554 if (sink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3555 gst_element_post_message (GST_ELEMENT (sink),
3556 gst_message_new_segment_start (GST_OBJECT (sink),
3557 sink->segment.format, sink->segment.position));
3561 sink->priv->discont = TRUE;
3562 sink->running = TRUE;
3564 GST_PAD_STREAM_UNLOCK (pad);
3570 set_step_info (GstBaseSink * sink, GstStepInfo * current, GstStepInfo * pending,
3571 guint seqnum, GstFormat format, guint64 amount, gdouble rate,
3572 gboolean flush, gboolean intermediate)
3574 GST_OBJECT_LOCK (sink);
3575 pending->seqnum = seqnum;
3576 pending->format = format;
3577 pending->amount = amount;
3578 pending->position = 0;
3579 pending->rate = rate;
3580 pending->flush = flush;
3581 pending->intermediate = intermediate;
3582 pending->valid = TRUE;
3583 /* flush invalidates the current stepping segment */
3585 current->valid = FALSE;
3586 GST_OBJECT_UNLOCK (sink);
3590 gst_base_sink_perform_step (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3592 GstBaseSinkPrivate *priv;
3593 GstBaseSinkClass *bclass;
3594 gboolean flush, intermediate;
3599 GstStepInfo *pending, *current;
3600 GstMessage *message;
3602 bclass = GST_BASE_SINK_GET_CLASS (sink);
3605 GST_DEBUG_OBJECT (sink, "performing step with event %p", event);
3607 gst_event_parse_step (event, &format, &amount, &rate, &flush, &intermediate);
3608 seqnum = gst_event_get_seqnum (event);
3610 pending = &priv->pending_step;
3611 current = &priv->current_step;
3613 /* post message first */
3614 message = gst_message_new_step_start (GST_OBJECT (sink), FALSE, format,
3615 amount, rate, flush, intermediate);
3616 gst_message_set_seqnum (message, seqnum);
3617 gst_element_post_message (GST_ELEMENT (sink), message);
3620 /* we need to call ::unlock before locking PREROLL_LOCK
3621 * since we lock it before going into ::render */
3623 bclass->unlock (sink);
3625 GST_BASE_SINK_PREROLL_LOCK (sink);
3626 /* now that we have the PREROLL lock, clear our unlock request */
3627 if (bclass->unlock_stop)
3628 bclass->unlock_stop (sink);
3630 /* update the stepinfo and make it valid */
3631 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3634 if (sink->priv->async_enabled) {
3635 /* and we need to commit our state again on the next
3636 * prerolled buffer */
3637 sink->playing_async = TRUE;
3638 priv->pending_step.need_preroll = TRUE;
3639 sink->need_preroll = FALSE;
3640 gst_element_lost_state (GST_ELEMENT_CAST (sink));
3642 sink->priv->have_latency = TRUE;
3643 sink->need_preroll = FALSE;
3645 priv->current_sstart = GST_CLOCK_TIME_NONE;
3646 priv->current_sstop = GST_CLOCK_TIME_NONE;
3647 priv->eos_rtime = GST_CLOCK_TIME_NONE;
3648 priv->call_preroll = TRUE;
3649 gst_base_sink_set_last_buffer (sink, NULL);
3650 gst_base_sink_reset_qos (sink);
3652 if (sink->clock_id) {
3653 gst_clock_id_unschedule (sink->clock_id);
3656 if (sink->have_preroll) {
3657 GST_DEBUG_OBJECT (sink, "signal waiter");
3658 priv->step_unlock = TRUE;
3659 GST_BASE_SINK_PREROLL_SIGNAL (sink);
3661 GST_BASE_SINK_PREROLL_UNLOCK (sink);
3663 /* update the stepinfo and make it valid */
3664 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3674 gst_base_sink_loop (GstPad * pad)
3677 GstBaseSink *basesink;
3678 GstBuffer *buf = NULL;
3679 GstFlowReturn result;
3683 parent = GST_OBJECT_PARENT (pad);
3684 basesink = GST_BASE_SINK (parent);
3686 g_assert (basesink->pad_mode == GST_PAD_MODE_PULL);
3688 if ((blocksize = basesink->priv->blocksize) == 0)
3691 offset = basesink->segment.position;
3693 GST_DEBUG_OBJECT (basesink, "pulling %" G_GUINT64_FORMAT ", %u",
3696 result = gst_pad_pull_range (pad, offset, blocksize, &buf);
3697 if (G_UNLIKELY (result != GST_FLOW_OK))
3700 if (G_UNLIKELY (buf == NULL))
3703 offset += gst_buffer_get_size (buf);
3705 basesink->segment.position = offset;
3707 GST_BASE_SINK_PREROLL_LOCK (basesink);
3708 result = gst_base_sink_chain_unlocked (basesink, pad, buf, FALSE);
3709 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3710 if (G_UNLIKELY (result != GST_FLOW_OK))
3718 GST_LOG_OBJECT (basesink, "pausing task, reason %s",
3719 gst_flow_get_name (result));
3720 gst_pad_pause_task (pad);
3721 if (result == GST_FLOW_EOS) {
3722 /* perform EOS logic */
3723 if (basesink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3724 gst_element_post_message (GST_ELEMENT_CAST (basesink),
3725 gst_message_new_segment_done (GST_OBJECT_CAST (basesink),
3726 basesink->segment.format, basesink->segment.position));
3728 gst_base_sink_event (pad, parent, gst_event_new_eos ());
3730 } else if (result == GST_FLOW_NOT_LINKED || result <= GST_FLOW_EOS) {
3731 /* for fatal errors we post an error message, post the error
3732 * first so the app knows about the error first.
3733 * wrong-state is not a fatal error because it happens due to
3734 * flushing and posting an error message in that case is the
3735 * wrong thing to do, e.g. when basesrc is doing a flushing
3737 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
3738 (_("Internal data stream error.")),
3739 ("stream stopped, reason %s", gst_flow_get_name (result)));
3740 gst_base_sink_event (pad, parent, gst_event_new_eos ());
3746 GST_LOG_OBJECT (basesink, "no buffer, pausing");
3747 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
3748 (_("Internal data flow error.")), ("element returned NULL buffer"));
3749 result = GST_FLOW_ERROR;
3755 gst_base_sink_set_flushing (GstBaseSink * basesink, GstPad * pad,
3758 GstBaseSinkClass *bclass;
3760 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3763 /* unlock any subclasses, we need to do this before grabbing the
3764 * PREROLL_LOCK since we hold this lock before going into ::render. */
3766 bclass->unlock (basesink);
3769 GST_BASE_SINK_PREROLL_LOCK (basesink);
3770 basesink->flushing = flushing;
3772 /* step 1, now that we have the PREROLL lock, clear our unlock request */
3773 if (bclass->unlock_stop)
3774 bclass->unlock_stop (basesink);
3776 /* set need_preroll before we unblock the clock. If the clock is unblocked
3777 * before timing out, we can reuse the buffer for preroll. */
3778 basesink->need_preroll = TRUE;
3780 /* step 2, unblock clock sync (if any) or any other blocking thing */
3781 if (basesink->clock_id) {
3782 gst_clock_id_unschedule (basesink->clock_id);
3785 /* flush out the data thread if it's locked in finish_preroll, this will
3786 * also flush out the EOS state */
3787 GST_DEBUG_OBJECT (basesink,
3788 "flushing out data thread, need preroll to TRUE");
3790 /* we can't have EOS anymore now */
3791 basesink->eos = FALSE;
3792 basesink->priv->received_eos = FALSE;
3793 basesink->have_preroll = FALSE;
3794 basesink->priv->step_unlock = FALSE;
3795 /* can't report latency anymore until we preroll again */
3796 if (basesink->priv->async_enabled) {
3797 GST_OBJECT_LOCK (basesink);
3798 basesink->priv->have_latency = FALSE;
3799 GST_OBJECT_UNLOCK (basesink);
3801 /* and signal any waiters now */
3802 GST_BASE_SINK_PREROLL_SIGNAL (basesink);
3804 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3810 gst_base_sink_default_activate_pull (GstBaseSink * basesink, gboolean active)
3816 result = gst_pad_start_task (basesink->sinkpad,
3817 (GstTaskFunction) gst_base_sink_loop, basesink->sinkpad);
3819 /* step 2, make sure streaming finishes */
3820 result = gst_pad_stop_task (basesink->sinkpad);
3827 gst_base_sink_pad_activate (GstPad * pad, GstObject * parent)
3829 gboolean result = FALSE;
3830 GstBaseSink *basesink;
3834 basesink = GST_BASE_SINK (parent);
3836 GST_DEBUG_OBJECT (basesink, "Trying pull mode first");
3838 gst_base_sink_set_flushing (basesink, pad, FALSE);
3840 /* we need to have the pull mode enabled */
3841 if (!basesink->can_activate_pull) {
3842 GST_DEBUG_OBJECT (basesink, "pull mode disabled");
3846 /* check if downstreams supports pull mode at all */
3847 query = gst_query_new_scheduling ();
3849 if (!gst_pad_peer_query (pad, query)) {
3850 gst_query_unref (query);
3851 GST_DEBUG_OBJECT (basesink, "peer query faild, no pull mode");
3855 /* parse result of the query */
3856 pull_mode = gst_query_has_scheduling_mode (query, GST_PAD_MODE_PULL);
3857 gst_query_unref (query);
3860 GST_DEBUG_OBJECT (basesink, "pull mode not supported");
3864 /* set the pad mode before starting the task so that it's in the
3865 * correct state for the new thread. also the sink set_caps and get_caps
3866 * function checks this */
3867 basesink->pad_mode = GST_PAD_MODE_PULL;
3869 /* we first try to negotiate a format so that when we try to activate
3870 * downstream, it knows about our format */
3871 if (!gst_base_sink_negotiate_pull (basesink)) {
3872 GST_DEBUG_OBJECT (basesink, "failed to negotiate in pull mode");
3876 /* ok activate now */
3877 if (!gst_pad_activate_mode (pad, GST_PAD_MODE_PULL, TRUE)) {
3878 /* clear any pending caps */
3879 GST_OBJECT_LOCK (basesink);
3880 gst_caps_replace (&basesink->priv->caps, NULL);
3881 GST_OBJECT_UNLOCK (basesink);
3882 GST_DEBUG_OBJECT (basesink, "failed to activate in pull mode");
3886 GST_DEBUG_OBJECT (basesink, "Success activating pull mode");
3890 /* push mode fallback */
3892 GST_DEBUG_OBJECT (basesink, "Falling back to push mode");
3893 if ((result = gst_pad_activate_mode (pad, GST_PAD_MODE_PUSH, TRUE))) {
3894 GST_DEBUG_OBJECT (basesink, "Success activating push mode");
3899 GST_WARNING_OBJECT (basesink, "Could not activate pad in either mode");
3900 gst_base_sink_set_flushing (basesink, pad, TRUE);
3907 gst_base_sink_pad_activate_push (GstPad * pad, GstObject * parent,
3911 GstBaseSink *basesink;
3913 basesink = GST_BASE_SINK (parent);
3916 if (!basesink->can_activate_push) {
3918 basesink->pad_mode = GST_PAD_MODE_NONE;
3921 basesink->pad_mode = GST_PAD_MODE_PUSH;
3924 if (G_UNLIKELY (basesink->pad_mode != GST_PAD_MODE_PUSH)) {
3925 g_warning ("Internal GStreamer activation error!!!");
3928 gst_base_sink_set_flushing (basesink, pad, TRUE);
3930 basesink->pad_mode = GST_PAD_MODE_NONE;
3938 gst_base_sink_negotiate_pull (GstBaseSink * basesink)
3945 /* this returns the intersection between our caps and the peer caps. If there
3946 * is no peer, it returns NULL and we can't operate in pull mode so we can
3947 * fail the negotiation. */
3948 caps = gst_pad_get_allowed_caps (GST_BASE_SINK_PAD (basesink));
3949 if (caps == NULL || gst_caps_is_empty (caps))
3950 goto no_caps_possible;
3952 GST_DEBUG_OBJECT (basesink, "allowed caps: %" GST_PTR_FORMAT, caps);
3954 if (gst_caps_is_any (caps)) {
3955 GST_DEBUG_OBJECT (basesink, "caps were ANY after fixating, "
3957 /* neither side has template caps in this case, so they are prepared for
3958 pull() without setcaps() */
3962 caps = gst_base_sink_fixate (basesink, caps);
3963 GST_DEBUG_OBJECT (basesink, "fixated to: %" GST_PTR_FORMAT, caps);
3965 if (gst_caps_is_fixed (caps)) {
3966 if (!gst_pad_set_caps (GST_BASE_SINK_PAD (basesink), caps))
3967 goto could_not_set_caps;
3973 gst_caps_unref (caps);
3979 GST_INFO_OBJECT (basesink, "Pipeline could not agree on caps");
3980 GST_DEBUG_OBJECT (basesink, "get_allowed_caps() returned EMPTY");
3982 gst_caps_unref (caps);
3987 GST_INFO_OBJECT (basesink, "Could not set caps: %" GST_PTR_FORMAT, caps);
3988 gst_caps_unref (caps);
3993 /* this won't get called until we implement an activate function */
3995 gst_base_sink_pad_activate_pull (GstPad * pad, GstObject * parent,
3998 gboolean result = FALSE;
3999 GstBaseSink *basesink;
4000 GstBaseSinkClass *bclass;
4002 basesink = GST_BASE_SINK (parent);
4003 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4008 /* we mark we have a newsegment here because pull based
4009 * mode works just fine without having a newsegment before the
4011 gst_segment_init (&basesink->segment, GST_FORMAT_BYTES);
4012 GST_OBJECT_LOCK (basesink);
4013 basesink->have_newsegment = TRUE;
4014 GST_OBJECT_UNLOCK (basesink);
4016 /* get the peer duration in bytes */
4017 result = gst_pad_peer_query_duration (pad, GST_FORMAT_BYTES, &duration);
4019 GST_DEBUG_OBJECT (basesink,
4020 "setting duration in bytes to %" G_GINT64_FORMAT, duration);
4021 basesink->segment.duration = duration;
4023 GST_DEBUG_OBJECT (basesink, "unknown duration");
4026 if (bclass->activate_pull)
4027 result = bclass->activate_pull (basesink, TRUE);
4032 goto activate_failed;
4035 if (G_UNLIKELY (basesink->pad_mode != GST_PAD_MODE_PULL)) {
4036 g_warning ("Internal GStreamer activation error!!!");
4039 result = gst_base_sink_set_flushing (basesink, pad, TRUE);
4040 if (bclass->activate_pull)
4041 result &= bclass->activate_pull (basesink, FALSE);
4042 basesink->pad_mode = GST_PAD_MODE_NONE;
4051 /* reset, as starting the thread failed */
4052 basesink->pad_mode = GST_PAD_MODE_NONE;
4054 GST_ERROR_OBJECT (basesink, "subclass failed to activate in pull mode");
4060 gst_base_sink_pad_activate_mode (GstPad * pad, GstObject * parent,
4061 GstPadMode mode, gboolean active)
4066 case GST_PAD_MODE_PULL:
4067 res = gst_base_sink_pad_activate_pull (pad, parent, active);
4069 case GST_PAD_MODE_PUSH:
4070 res = gst_base_sink_pad_activate_push (pad, parent, active);
4073 GST_LOG_OBJECT (pad, "unknown activation mode %d", mode);
4080 /* send an event to our sinkpad peer. */
4082 gst_base_sink_send_event (GstElement * element, GstEvent * event)
4085 GstBaseSink *basesink = GST_BASE_SINK (element);
4086 gboolean forward, result = TRUE;
4089 GST_OBJECT_LOCK (element);
4090 /* get the pad and the scheduling mode */
4091 pad = gst_object_ref (basesink->sinkpad);
4092 mode = basesink->pad_mode;
4093 GST_OBJECT_UNLOCK (element);
4095 /* only push UPSTREAM events upstream */
4096 forward = GST_EVENT_IS_UPSTREAM (event);
4098 GST_DEBUG_OBJECT (basesink, "handling event %p %" GST_PTR_FORMAT, event,
4101 switch (GST_EVENT_TYPE (event)) {
4102 case GST_EVENT_LATENCY:
4104 GstClockTime latency;
4106 gst_event_parse_latency (event, &latency);
4108 /* store the latency. We use this to adjust the running_time before syncing
4109 * it to the clock. */
4110 GST_OBJECT_LOCK (element);
4111 basesink->priv->latency = latency;
4112 if (!basesink->priv->have_latency)
4114 GST_OBJECT_UNLOCK (element);
4115 GST_DEBUG_OBJECT (basesink, "latency set to %" GST_TIME_FORMAT,
4116 GST_TIME_ARGS (latency));
4118 /* We forward this event so that all elements know about the global pipeline
4119 * latency. This is interesting for an element when it wants to figure out
4120 * when a particular piece of data will be rendered. */
4123 case GST_EVENT_SEEK:
4124 /* in pull mode we will execute the seek */
4125 if (mode == GST_PAD_MODE_PULL)
4126 result = gst_base_sink_perform_seek (basesink, pad, event);
4128 case GST_EVENT_STEP:
4129 result = gst_base_sink_perform_step (basesink, pad, event);
4137 result = gst_pad_push_event (pad, event);
4139 /* not forwarded, unref the event */
4140 gst_event_unref (event);
4143 gst_object_unref (pad);
4145 GST_DEBUG_OBJECT (basesink, "handled event %p %" GST_PTR_FORMAT ": %d", event,
4152 gst_base_sink_get_position (GstBaseSink * basesink, GstFormat format,
4153 gint64 * cur, gboolean * upstream)
4155 GstClock *clock = NULL;
4156 gboolean res = FALSE;
4158 GstSegment *segment;
4159 GstClockTime now, latency;
4160 GstClockTimeDiff base_time;
4161 gint64 time, base, duration;
4164 gboolean last_seen, with_clock, in_paused;
4166 GST_OBJECT_LOCK (basesink);
4167 /* we can only get the segment when we are not NULL or READY */
4168 if (!basesink->have_newsegment)
4172 /* when not in PLAYING or when we're busy with a state change, we
4173 * cannot read from the clock so we report time based on the
4174 * last seen timestamp. */
4175 if (GST_STATE (basesink) != GST_STATE_PLAYING ||
4176 GST_STATE_PENDING (basesink) != GST_STATE_VOID_PENDING) {
4180 segment = &basesink->segment;
4182 /* get the format in the segment */
4183 oformat = segment->format;
4185 /* report with last seen position when EOS */
4186 last_seen = basesink->eos;
4188 /* assume we will use the clock for getting the current position */
4190 if (basesink->sync == FALSE)
4193 /* and we need a clock */
4194 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (basesink)) == NULL))
4197 gst_object_ref (clock);
4199 /* mainloop might be querying position when going to playing async,
4200 * while (audio) rendering might be quickly advancing stream position,
4201 * so use clock asap rather than last reported position */
4202 if (in_paused && with_clock && g_atomic_int_get (&basesink->priv->to_playing)) {
4203 GST_DEBUG_OBJECT (basesink, "going to PLAYING, so not PAUSED");
4207 /* collect all data we need holding the lock */
4208 if (GST_CLOCK_TIME_IS_VALID (segment->time))
4209 time = segment->time;
4213 if (GST_CLOCK_TIME_IS_VALID (segment->stop))
4214 duration = segment->stop - segment->start;
4218 base = segment->base;
4219 rate = segment->rate * segment->applied_rate;
4220 latency = basesink->priv->latency;
4222 if (oformat == GST_FORMAT_TIME) {
4225 start = basesink->priv->current_sstart;
4226 stop = basesink->priv->current_sstop;
4229 /* in paused we use the last position as a lower bound */
4230 if (stop == -1 || segment->rate > 0.0)
4235 /* in playing, use last stop time as upper bound */
4236 if (start == -1 || segment->rate > 0.0)
4242 /* convert last stop to stream time */
4243 last = gst_segment_to_stream_time (segment, oformat, segment->position);
4247 /* in paused, use start_time */
4248 base_time = GST_ELEMENT_START_TIME (basesink);
4249 GST_DEBUG_OBJECT (basesink, "in paused, using start time %" GST_TIME_FORMAT,
4250 GST_TIME_ARGS (base_time));
4251 } else if (with_clock) {
4252 /* else use clock when needed */
4253 base_time = GST_ELEMENT_CAST (basesink)->base_time;
4254 GST_DEBUG_OBJECT (basesink, "using clock and base time %" GST_TIME_FORMAT,
4255 GST_TIME_ARGS (base_time));
4257 /* else, no sync or clock -> no base time */
4258 GST_DEBUG_OBJECT (basesink, "no sync or no clock");
4262 /* no base_time, we can't calculate running_time, use last seem timestamp to report
4264 if (base_time == -1)
4267 /* need to release the object lock before we can get the time,
4268 * a clock might take the LOCK of the provider, which could be
4269 * a basesink subclass. */
4270 GST_OBJECT_UNLOCK (basesink);
4273 /* in EOS or when no valid stream_time, report the value of last seen
4276 /* no timestamp, we need to ask upstream */
4277 GST_DEBUG_OBJECT (basesink, "no last seen timestamp, asking upstream");
4282 GST_DEBUG_OBJECT (basesink, "using last seen timestamp %" GST_TIME_FORMAT,
4283 GST_TIME_ARGS (last));
4286 if (oformat != GST_FORMAT_TIME) {
4287 /* convert base, time and duration to time */
4288 if (!gst_pad_query_convert (basesink->sinkpad, oformat, base,
4289 GST_FORMAT_TIME, &base))
4290 goto convert_failed;
4291 if (!gst_pad_query_convert (basesink->sinkpad, oformat, duration,
4292 GST_FORMAT_TIME, &duration))
4293 goto convert_failed;
4294 if (!gst_pad_query_convert (basesink->sinkpad, oformat, time,
4295 GST_FORMAT_TIME, &time))
4296 goto convert_failed;
4297 if (!gst_pad_query_convert (basesink->sinkpad, oformat, last,
4298 GST_FORMAT_TIME, &last))
4299 goto convert_failed;
4301 /* assume time format from now on */
4302 oformat = GST_FORMAT_TIME;
4305 if (!in_paused && with_clock) {
4306 now = gst_clock_get_time (clock);
4312 /* subtract base time and base time from the clock time.
4313 * Make sure we don't go negative. This is the current time in
4314 * the segment which we need to scale with the combined
4315 * rate and applied rate. */
4317 base_time += latency;
4318 if (GST_CLOCK_DIFF (base_time, now) < 0)
4321 /* for negative rates we need to count back from the segment
4326 *cur = time + gst_guint64_to_gdouble (now - base_time) * rate;
4329 /* never report less than segment values in paused */
4331 *cur = MAX (last, *cur);
4333 /* never report more than last seen position in playing */
4335 *cur = MIN (last, *cur);
4338 GST_DEBUG_OBJECT (basesink,
4339 "now %" GST_TIME_FORMAT " - base_time %" GST_TIME_FORMAT " - base %"
4340 GST_TIME_FORMAT " + time %" GST_TIME_FORMAT " last %" GST_TIME_FORMAT,
4341 GST_TIME_ARGS (now), GST_TIME_ARGS (base_time), GST_TIME_ARGS (base),
4342 GST_TIME_ARGS (time), GST_TIME_ARGS (last));
4345 if (oformat != format) {
4346 /* convert to final format */
4347 if (!gst_pad_query_convert (basesink->sinkpad, oformat, *cur, format, cur))
4348 goto convert_failed;
4354 GST_DEBUG_OBJECT (basesink, "res: %d, POSITION: %" GST_TIME_FORMAT,
4355 res, GST_TIME_ARGS (*cur));
4358 gst_object_unref (clock);
4365 /* in NULL or READY we always return FALSE and -1 */
4366 GST_DEBUG_OBJECT (basesink, "position in wrong state, return -1");
4369 GST_OBJECT_UNLOCK (basesink);
4374 GST_DEBUG_OBJECT (basesink, "convert failed, try upstream");
4382 gst_base_sink_get_duration (GstBaseSink * basesink, GstFormat format,
4383 gint64 * dur, gboolean * upstream)
4385 gboolean res = FALSE;
4387 if (basesink->pad_mode == GST_PAD_MODE_PULL) {
4390 /* get the duration in bytes, in pull mode that's all we are sure to
4391 * know. We have to explicitly get this value from upstream instead of
4392 * using our cached value because it might change. Duration caching
4393 * should be done at a higher level. */
4395 gst_pad_peer_query_duration (basesink->sinkpad, GST_FORMAT_BYTES,
4398 basesink->segment.duration = uduration;
4399 if (format != GST_FORMAT_BYTES) {
4400 /* convert to the requested format */
4402 gst_pad_query_convert (basesink->sinkpad, GST_FORMAT_BYTES,
4403 uduration, format, dur);
4417 default_element_query (GstElement * element, GstQuery * query)
4419 gboolean res = FALSE;
4421 GstBaseSink *basesink = GST_BASE_SINK (element);
4423 switch (GST_QUERY_TYPE (query)) {
4424 case GST_QUERY_POSITION:
4428 gboolean upstream = FALSE;
4430 gst_query_parse_position (query, &format, NULL);
4432 GST_DEBUG_OBJECT (basesink, "position query in format %s",
4433 gst_format_get_name (format));
4435 /* first try to get the position based on the clock */
4437 gst_base_sink_get_position (basesink, format, &cur, &upstream))) {
4438 gst_query_set_position (query, format, cur);
4439 } else if (upstream) {
4440 /* fallback to peer query */
4441 res = gst_pad_peer_query (basesink->sinkpad, query);
4444 /* we can handle a few things if upstream failed */
4445 if (format == GST_FORMAT_PERCENT) {
4448 res = gst_base_sink_get_position (basesink, GST_FORMAT_TIME, &cur,
4450 if (!res && upstream) {
4452 gst_pad_peer_query_position (basesink->sinkpad, GST_FORMAT_TIME,
4456 res = gst_base_sink_get_duration (basesink, GST_FORMAT_TIME, &dur,
4458 if (!res && upstream) {
4460 gst_pad_peer_query_duration (basesink->sinkpad,
4461 GST_FORMAT_TIME, &dur);
4467 pos = gst_util_uint64_scale (100 * GST_FORMAT_PERCENT_SCALE, cur,
4469 gst_query_set_position (query, GST_FORMAT_PERCENT, pos);
4475 case GST_QUERY_DURATION:
4479 gboolean upstream = FALSE;
4481 gst_query_parse_duration (query, &format, NULL);
4483 GST_DEBUG_OBJECT (basesink, "duration query in format %s",
4484 gst_format_get_name (format));
4487 gst_base_sink_get_duration (basesink, format, &dur, &upstream))) {
4488 gst_query_set_duration (query, format, dur);
4489 } else if (upstream) {
4490 /* fallback to peer query */
4491 res = gst_pad_peer_query (basesink->sinkpad, query);
4494 /* we can handle a few things if upstream failed */
4495 if (format == GST_FORMAT_PERCENT) {
4496 gst_query_set_duration (query, GST_FORMAT_PERCENT,
4497 GST_FORMAT_PERCENT_MAX);
4503 case GST_QUERY_LATENCY:
4505 gboolean live, us_live;
4506 GstClockTime min, max;
4508 if ((res = gst_base_sink_query_latency (basesink, &live, &us_live, &min,
4510 gst_query_set_latency (query, live, min, max);
4514 case GST_QUERY_JITTER:
4516 case GST_QUERY_RATE:
4517 /* gst_query_set_rate (query, basesink->segment_rate); */
4520 case GST_QUERY_SEGMENT:
4522 if (basesink->pad_mode == GST_PAD_MODE_PULL) {
4523 gst_query_set_segment (query, basesink->segment.rate,
4524 GST_FORMAT_TIME, basesink->segment.start, basesink->segment.stop);
4527 res = gst_pad_peer_query (basesink->sinkpad, query);
4531 case GST_QUERY_SEEKING:
4532 case GST_QUERY_CONVERT:
4533 case GST_QUERY_FORMATS:
4535 res = gst_pad_peer_query (basesink->sinkpad, query);
4538 GST_DEBUG_OBJECT (basesink, "query %s returns %d",
4539 GST_QUERY_TYPE_NAME (query), res);
4545 gst_base_sink_default_query (GstBaseSink * basesink, GstQuery * query)
4548 GstBaseSinkClass *bclass;
4550 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4552 switch (GST_QUERY_TYPE (query)) {
4553 case GST_QUERY_ALLOCATION:
4555 if (bclass->propose_allocation)
4556 res = bclass->propose_allocation (basesink, query);
4561 case GST_QUERY_CAPS:
4563 GstCaps *caps, *filter;
4565 gst_query_parse_caps (query, &filter);
4566 caps = gst_base_sink_query_caps (basesink, basesink->sinkpad, filter);
4567 gst_query_set_caps_result (query, caps);
4568 gst_caps_unref (caps);
4572 case GST_QUERY_ACCEPT_CAPS:
4574 GstCaps *caps, *allowed;
4577 /* slightly faster than the default implementation */
4578 gst_query_parse_accept_caps (query, &caps);
4579 allowed = gst_base_sink_query_caps (basesink, basesink->sinkpad, NULL);
4580 subset = gst_caps_is_subset (caps, allowed);
4581 gst_caps_unref (allowed);
4582 gst_query_set_accept_caps_result (query, subset);
4586 case GST_QUERY_DRAIN:
4591 gst_pad_query_default (basesink->sinkpad, GST_OBJECT_CAST (basesink),
4599 gst_base_sink_sink_query (GstPad * pad, GstObject * parent, GstQuery * query)
4601 GstBaseSink *basesink;
4602 GstBaseSinkClass *bclass;
4605 basesink = GST_BASE_SINK_CAST (parent);
4606 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4609 res = bclass->query (basesink, query);
4616 static GstStateChangeReturn
4617 gst_base_sink_change_state (GstElement * element, GstStateChange transition)
4619 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
4620 GstBaseSink *basesink = GST_BASE_SINK (element);
4621 GstBaseSinkClass *bclass;
4622 GstBaseSinkPrivate *priv;
4624 priv = basesink->priv;
4626 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4628 switch (transition) {
4629 case GST_STATE_CHANGE_NULL_TO_READY:
4631 if (!bclass->start (basesink))
4634 case GST_STATE_CHANGE_READY_TO_PAUSED:
4635 /* need to complete preroll before this state change completes, there
4636 * is no data flow in READY so we can safely assume we need to preroll. */
4637 GST_BASE_SINK_PREROLL_LOCK (basesink);
4638 GST_DEBUG_OBJECT (basesink, "READY to PAUSED");
4639 basesink->have_newsegment = FALSE;
4640 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
4641 basesink->offset = 0;
4642 basesink->have_preroll = FALSE;
4643 priv->step_unlock = FALSE;
4644 basesink->need_preroll = TRUE;
4645 basesink->playing_async = TRUE;
4646 priv->current_sstart = GST_CLOCK_TIME_NONE;
4647 priv->current_sstop = GST_CLOCK_TIME_NONE;
4648 priv->eos_rtime = GST_CLOCK_TIME_NONE;
4650 basesink->eos = FALSE;
4651 priv->received_eos = FALSE;
4652 gst_base_sink_reset_qos (basesink);
4653 priv->commited = FALSE;
4654 priv->call_preroll = TRUE;
4655 priv->current_step.valid = FALSE;
4656 priv->pending_step.valid = FALSE;
4657 if (priv->async_enabled) {
4658 GST_DEBUG_OBJECT (basesink, "doing async state change");
4659 /* when async enabled, post async-start message and return ASYNC from
4660 * the state change function */
4661 ret = GST_STATE_CHANGE_ASYNC;
4662 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4663 gst_message_new_async_start (GST_OBJECT_CAST (basesink)));
4665 priv->have_latency = TRUE;
4667 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4669 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
4670 GST_BASE_SINK_PREROLL_LOCK (basesink);
4671 g_atomic_int_set (&basesink->priv->to_playing, TRUE);
4672 if (!gst_base_sink_needs_preroll (basesink)) {
4673 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, don't need preroll");
4674 /* no preroll needed anymore now. */
4675 basesink->playing_async = FALSE;
4676 basesink->need_preroll = FALSE;
4677 if (basesink->eos) {
4678 GstMessage *message;
4680 /* need to post EOS message here */
4681 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
4682 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
4683 gst_message_set_seqnum (message, basesink->priv->seqnum);
4684 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
4686 GST_DEBUG_OBJECT (basesink, "signal preroll");
4687 GST_BASE_SINK_PREROLL_SIGNAL (basesink);
4690 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, we are not prerolled");
4691 basesink->need_preroll = TRUE;
4692 basesink->playing_async = TRUE;
4693 priv->call_preroll = TRUE;
4694 priv->commited = FALSE;
4695 if (priv->async_enabled) {
4696 GST_DEBUG_OBJECT (basesink, "doing async state change");
4697 ret = GST_STATE_CHANGE_ASYNC;
4698 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4699 gst_message_new_async_start (GST_OBJECT_CAST (basesink)));
4702 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4709 GstStateChangeReturn bret;
4711 bret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
4712 if (G_UNLIKELY (bret == GST_STATE_CHANGE_FAILURE))
4713 goto activate_failed;
4716 switch (transition) {
4717 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
4718 /* completed transition, so need not be marked any longer
4719 * And it should be unmarked, since e.g. losing our position upon flush
4720 * does not really change state to PAUSED ... */
4721 g_atomic_int_set (&basesink->priv->to_playing, FALSE);
4723 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
4724 g_atomic_int_set (&basesink->priv->to_playing, FALSE);
4725 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED");
4726 /* FIXME, make sure we cannot enter _render first */
4728 /* we need to call ::unlock before locking PREROLL_LOCK
4729 * since we lock it before going into ::render */
4731 bclass->unlock (basesink);
4733 GST_BASE_SINK_PREROLL_LOCK (basesink);
4734 GST_DEBUG_OBJECT (basesink, "got preroll lock");
4735 /* now that we have the PREROLL lock, clear our unlock request */
4736 if (bclass->unlock_stop)
4737 bclass->unlock_stop (basesink);
4739 /* we need preroll again and we set the flag before unlocking the clockid
4740 * because if the clockid is unlocked before a current buffer expired, we
4741 * can use that buffer to preroll with */
4742 basesink->need_preroll = TRUE;
4744 if (basesink->clock_id) {
4745 GST_DEBUG_OBJECT (basesink, "unschedule clock");
4746 gst_clock_id_unschedule (basesink->clock_id);
4749 /* if we don't have a preroll buffer we need to wait for a preroll and
4751 if (!gst_base_sink_needs_preroll (basesink)) {
4752 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED, we are prerolled");
4753 basesink->playing_async = FALSE;
4755 if (GST_STATE_TARGET (GST_ELEMENT (basesink)) <= GST_STATE_READY) {
4756 GST_DEBUG_OBJECT (basesink, "element is <= READY");
4757 ret = GST_STATE_CHANGE_SUCCESS;
4759 GST_DEBUG_OBJECT (basesink,
4760 "PLAYING to PAUSED, we are not prerolled");
4761 basesink->playing_async = TRUE;
4762 priv->commited = FALSE;
4763 priv->call_preroll = TRUE;
4764 if (priv->async_enabled) {
4765 GST_DEBUG_OBJECT (basesink, "doing async state change");
4766 ret = GST_STATE_CHANGE_ASYNC;
4767 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4768 gst_message_new_async_start (GST_OBJECT_CAST (basesink)));
4772 GST_DEBUG_OBJECT (basesink, "rendered: %" G_GUINT64_FORMAT
4773 ", dropped: %" G_GUINT64_FORMAT, priv->rendered, priv->dropped);
4775 gst_base_sink_reset_qos (basesink);
4776 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4778 case GST_STATE_CHANGE_PAUSED_TO_READY:
4779 GST_BASE_SINK_PREROLL_LOCK (basesink);
4780 /* start by resetting our position state with the object lock so that the
4781 * position query gets the right idea. We do this before we post the
4782 * messages so that the message handlers pick this up. */
4783 GST_OBJECT_LOCK (basesink);
4784 basesink->have_newsegment = FALSE;
4785 priv->current_sstart = GST_CLOCK_TIME_NONE;
4786 priv->current_sstop = GST_CLOCK_TIME_NONE;
4787 priv->have_latency = FALSE;
4788 if (priv->cached_clock_id) {
4789 gst_clock_id_unref (priv->cached_clock_id);
4790 priv->cached_clock_id = NULL;
4792 gst_caps_replace (&basesink->priv->caps, NULL);
4793 GST_OBJECT_UNLOCK (basesink);
4795 gst_base_sink_set_last_buffer (basesink, NULL);
4796 priv->call_preroll = FALSE;
4798 if (!priv->commited) {
4799 if (priv->async_enabled) {
4800 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, posting async-done");
4802 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4803 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
4804 GST_STATE_PLAYING, GST_STATE_PAUSED, GST_STATE_READY));
4806 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4807 gst_message_new_async_done (GST_OBJECT_CAST (basesink), FALSE));
4809 priv->commited = TRUE;
4811 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, don't need_preroll");
4813 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4815 case GST_STATE_CHANGE_READY_TO_NULL:
4817 if (!bclass->stop (basesink)) {
4818 GST_WARNING_OBJECT (basesink, "failed to stop");
4821 gst_base_sink_set_last_buffer (basesink, NULL);
4822 priv->call_preroll = FALSE;
4833 GST_DEBUG_OBJECT (basesink, "failed to start");
4834 return GST_STATE_CHANGE_FAILURE;
4838 GST_DEBUG_OBJECT (basesink,
4839 "element failed to change states -- activation problem?");
4840 return GST_STATE_CHANGE_FAILURE;