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 base_init function, like so:
42 * my_element_base_init (gpointer g_class)
44 * GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
46 * // sinktemplate should be a #GstStaticPadTemplate with direction
47 * // #GST_PAD_SINK and name "sink"
48 * gst_element_class_add_pad_template (gstelement_class,
49 * gst_static_pad_template_get (&sinktemplate));
50 * // see #GstElementDetails
51 * gst_element_class_set_details (gstelement_class, &details);
55 * #GstBaseSink will handle the prerolling correctly. This means that it will
56 * return #GST_STATE_CHANGE_ASYNC from a state change to PAUSED until the first
57 * buffer arrives in this element. The base class will call the
58 * #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 * #GstBaseSink provides an overridable #GstBaseSinkClass.buffer_alloc()
109 * function that can be used by sinks that want to do reverse negotiation or to
110 * provide custom buffers (hardware buffers for example) to upstream elements.
112 * The #GstBaseSinkClass.unlock() method is called when the elements should
113 * unblock any blocking operations they perform in the
114 * #GstBaseSinkClass.render() method. This is mostly useful when the
115 * #GstBaseSinkClass.render() method performs a blocking write on a file
116 * descriptor, for example.
118 * The #GstBaseSink:max-lateness property affects how the sink deals with
119 * buffers that arrive too late in the sink. A buffer arrives too late in the
120 * sink when the presentation time (as a combination of the last segment, buffer
121 * timestamp and element base_time) plus the duration is before the current
123 * If the frame is later than max-lateness, the sink will drop the buffer
124 * without calling the render method.
125 * This feature is disabled if sync is disabled, the
126 * #GstBaseSinkClass.get_times() method does not return a valid start time or
127 * max-lateness is set to -1 (the default).
128 * Subclasses can use gst_base_sink_set_max_lateness() to configure the
129 * max-lateness value.
131 * The #GstBaseSink:qos property will enable the quality-of-service features of
132 * the basesink which gather statistics about the real-time performance of the
133 * clock synchronisation. For each buffer received in the sink, statistics are
134 * gathered and a QOS event is sent upstream with these numbers. This
135 * information can then be used by upstream elements to reduce their processing
138 * Since 0.10.15 the #GstBaseSink:async property can be used to instruct the
139 * sink to never perform an ASYNC state change. This feature is mostly usable
140 * when dealing with non-synchronized streams or sparse streams.
142 * Last reviewed on 2007-08-29 (0.10.15)
149 #include <gst/gst_private.h>
151 #include "gstbasesink.h"
152 #include <gst/gstmarshal.h>
153 #include <gst/gst-i18n-lib.h>
155 GST_DEBUG_CATEGORY_STATIC (gst_base_sink_debug);
156 #define GST_CAT_DEFAULT gst_base_sink_debug
158 #define GST_BASE_SINK_GET_PRIVATE(obj) \
159 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_BASE_SINK, GstBaseSinkPrivate))
161 #define GST_FLOW_STEP GST_FLOW_CUSTOM_ERROR
165 gboolean valid; /* if this info is valid */
166 guint32 seqnum; /* the seqnum of the STEP event */
167 GstFormat format; /* the format of the amount */
168 guint64 amount; /* the total amount of data to skip */
169 guint64 position; /* the position in the stepped data */
170 guint64 duration; /* the duration in time of the skipped data */
171 guint64 start; /* running_time of the start */
172 gdouble rate; /* rate of skipping */
173 gdouble start_rate; /* rate before skipping */
174 guint64 start_start; /* start position skipping */
175 guint64 start_stop; /* stop position skipping */
176 gboolean flush; /* if this was a flushing step */
177 gboolean intermediate; /* if this is an intermediate step */
178 gboolean need_preroll; /* if we need preroll after this step */
181 /* FIXME, some stuff in ABI.data and other in Private...
182 * Make up your mind please.
184 struct _GstBaseSinkPrivate
186 gint qos_enabled; /* ATOMIC */
187 gboolean async_enabled;
188 GstClockTimeDiff ts_offset;
189 GstClockTime render_delay;
191 /* start, stop of current buffer, stream time, used to report position */
192 GstClockTime current_sstart;
193 GstClockTime current_sstop;
195 /* start, stop and jitter of current buffer, running time */
196 GstClockTime current_rstart;
197 GstClockTime current_rstop;
198 GstClockTimeDiff current_jitter;
199 /* the running time of the previous buffer */
200 GstClockTime prev_rstart;
202 /* EOS sync time in running time */
203 GstClockTime eos_rtime;
205 /* last buffer that arrived in time, running time */
206 GstClockTime last_render_time;
207 /* when the last buffer left the sink, running time */
208 GstClockTime last_left;
210 /* running averages go here these are done on running time */
212 GstClockTime avg_duration;
214 GstClockTime avg_in_diff;
216 /* these are done on system time. avg_jitter and avg_render are
217 * compared to eachother to see if the rendering time takes a
218 * huge amount of the processing, If so we are flooded with
220 GstClockTime last_left_systime;
221 GstClockTime avg_jitter;
222 GstClockTime start, stop;
223 GstClockTime avg_render;
225 /* number of rendered and dropped frames */
230 GstClockTime latency;
232 /* if we already commited the state */
235 /* when we received EOS */
236 gboolean received_eos;
238 /* when we are prerolled and able to report latency */
239 gboolean have_latency;
241 /* the last buffer we prerolled or rendered. Useful for making snapshots */
242 gint enable_last_buffer; /* atomic */
243 GstBuffer *last_buffer;
245 /* caps for pull based scheduling */
248 /* blocksize for pulling */
253 /* seqnum of the stream */
256 gboolean call_preroll;
257 gboolean step_unlock;
259 /* we have a pending and a current step operation */
260 GstStepInfo current_step;
261 GstStepInfo pending_step;
263 /* Cached GstClockID */
264 GstClockID cached_clock_id;
266 /* for throttling and QoS */
267 GstClockTime earliest_in_time;
268 GstClockTime throttle_time;
271 #define DO_RUNNING_AVG(avg,val,size) (((val) + ((size)-1) * (avg)) / (size))
273 /* generic running average, this has a neutral window size */
274 #define UPDATE_RUNNING_AVG(avg,val) DO_RUNNING_AVG(avg,val,8)
276 /* the windows for these running averages are experimentally obtained.
277 * possitive values get averaged more while negative values use a small
278 * window so we can react faster to badness. */
279 #define UPDATE_RUNNING_AVG_P(avg,val) DO_RUNNING_AVG(avg,val,16)
280 #define UPDATE_RUNNING_AVG_N(avg,val) DO_RUNNING_AVG(avg,val,4)
284 _PR_IS_NOTHING = 1 << 0,
285 _PR_IS_BUFFER = 1 << 1,
286 _PR_IS_BUFFERLIST = 1 << 2,
287 _PR_IS_EVENT = 1 << 3
290 #define OBJ_IS_BUFFER(a) ((a) & _PR_IS_BUFFER)
291 #define OBJ_IS_BUFFERLIST(a) ((a) & _PR_IS_BUFFERLIST)
292 #define OBJ_IS_EVENT(a) ((a) & _PR_IS_EVENT)
293 #define OBJ_IS_BUFFERFULL(a) ((a) & (_PR_IS_BUFFER | _PR_IS_BUFFERLIST))
295 /* BaseSink properties */
297 #define DEFAULT_CAN_ACTIVATE_PULL FALSE /* fixme: enable me */
298 #define DEFAULT_CAN_ACTIVATE_PUSH TRUE
300 #define DEFAULT_PREROLL_QUEUE_LEN 0
301 #define DEFAULT_SYNC TRUE
302 #define DEFAULT_MAX_LATENESS -1
303 #define DEFAULT_QOS FALSE
304 #define DEFAULT_ASYNC TRUE
305 #define DEFAULT_TS_OFFSET 0
306 #define DEFAULT_BLOCKSIZE 4096
307 #define DEFAULT_RENDER_DELAY 0
308 #define DEFAULT_ENABLE_LAST_BUFFER TRUE
309 #define DEFAULT_THROTTLE_TIME 0
314 PROP_PREROLL_QUEUE_LEN,
320 PROP_ENABLE_LAST_BUFFER,
328 static GstElementClass *parent_class = NULL;
330 static void gst_base_sink_class_init (GstBaseSinkClass * klass);
331 static void gst_base_sink_init (GstBaseSink * trans, gpointer g_class);
332 static void gst_base_sink_finalize (GObject * object);
335 gst_base_sink_get_type (void)
337 static volatile gsize base_sink_type = 0;
339 if (g_once_init_enter (&base_sink_type)) {
341 static const GTypeInfo base_sink_info = {
342 sizeof (GstBaseSinkClass),
345 (GClassInitFunc) gst_base_sink_class_init,
348 sizeof (GstBaseSink),
350 (GInstanceInitFunc) gst_base_sink_init,
353 _type = g_type_register_static (GST_TYPE_ELEMENT,
354 "GstBaseSink", &base_sink_info, G_TYPE_FLAG_ABSTRACT);
355 g_once_init_leave (&base_sink_type, _type);
357 return base_sink_type;
360 static void gst_base_sink_set_property (GObject * object, guint prop_id,
361 const GValue * value, GParamSpec * pspec);
362 static void gst_base_sink_get_property (GObject * object, guint prop_id,
363 GValue * value, GParamSpec * pspec);
365 static gboolean gst_base_sink_send_event (GstElement * element,
367 static gboolean gst_base_sink_query (GstElement * element, GstQuery * query);
368 static const GstQueryType *gst_base_sink_get_query_types (GstElement * element);
370 static GstCaps *gst_base_sink_get_caps (GstBaseSink * sink);
371 static gboolean gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps);
372 static GstFlowReturn gst_base_sink_buffer_alloc (GstBaseSink * sink,
373 guint64 offset, guint size, GstCaps * caps, GstBuffer ** buf);
374 static void gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
375 GstClockTime * start, GstClockTime * end);
376 static gboolean gst_base_sink_set_flushing (GstBaseSink * basesink,
377 GstPad * pad, gboolean flushing);
378 static gboolean gst_base_sink_default_activate_pull (GstBaseSink * basesink,
380 static gboolean gst_base_sink_default_do_seek (GstBaseSink * sink,
381 GstSegment * segment);
382 static gboolean gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
383 GstEvent * event, GstSegment * segment);
385 static GstStateChangeReturn gst_base_sink_change_state (GstElement * element,
386 GstStateChange transition);
388 static GstFlowReturn gst_base_sink_chain (GstPad * pad, GstBuffer * buffer);
389 static GstFlowReturn gst_base_sink_chain_list (GstPad * pad,
390 GstBufferList * list);
392 static void gst_base_sink_loop (GstPad * pad);
393 static gboolean gst_base_sink_pad_activate (GstPad * pad);
394 static gboolean gst_base_sink_pad_activate_push (GstPad * pad, gboolean active);
395 static gboolean gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active);
396 static gboolean gst_base_sink_event (GstPad * pad, GstEvent * event);
398 static gboolean gst_base_sink_negotiate_pull (GstBaseSink * basesink);
399 static GstCaps *gst_base_sink_pad_getcaps (GstPad * pad);
400 static gboolean gst_base_sink_pad_setcaps (GstPad * pad, GstCaps * caps);
401 static void gst_base_sink_pad_fixate (GstPad * pad, GstCaps * caps);
402 static GstFlowReturn gst_base_sink_pad_buffer_alloc (GstPad * pad,
403 guint64 offset, guint size, GstCaps * caps, GstBuffer ** buf);
406 /* check if an object was too late */
407 static gboolean gst_base_sink_is_too_late (GstBaseSink * basesink,
408 GstMiniObject * obj, GstClockTime rstart, GstClockTime rstop,
409 GstClockReturn status, GstClockTimeDiff jitter);
410 static GstFlowReturn gst_base_sink_preroll_object (GstBaseSink * basesink,
411 guint8 obj_type, GstMiniObject * obj);
414 gst_base_sink_class_init (GstBaseSinkClass * klass)
416 GObjectClass *gobject_class;
417 GstElementClass *gstelement_class;
419 gobject_class = G_OBJECT_CLASS (klass);
420 gstelement_class = GST_ELEMENT_CLASS (klass);
422 GST_DEBUG_CATEGORY_INIT (gst_base_sink_debug, "basesink", 0,
425 g_type_class_add_private (klass, sizeof (GstBaseSinkPrivate));
427 parent_class = g_type_class_peek_parent (klass);
429 gobject_class->finalize = gst_base_sink_finalize;
430 gobject_class->set_property = gst_base_sink_set_property;
431 gobject_class->get_property = gst_base_sink_get_property;
433 /* FIXME, this next value should be configured using an event from the
434 * upstream element, ie, the BUFFER_SIZE event. */
435 g_object_class_install_property (gobject_class, PROP_PREROLL_QUEUE_LEN,
436 g_param_spec_uint ("preroll-queue-len", "Preroll queue length",
437 "Number of buffers to queue during preroll", 0, G_MAXUINT,
438 DEFAULT_PREROLL_QUEUE_LEN,
439 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
441 g_object_class_install_property (gobject_class, PROP_SYNC,
442 g_param_spec_boolean ("sync", "Sync", "Sync on the clock", DEFAULT_SYNC,
443 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
445 g_object_class_install_property (gobject_class, PROP_MAX_LATENESS,
446 g_param_spec_int64 ("max-lateness", "Max Lateness",
447 "Maximum number of nanoseconds that a buffer can be late before it "
448 "is dropped (-1 unlimited)", -1, G_MAXINT64, DEFAULT_MAX_LATENESS,
449 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
451 g_object_class_install_property (gobject_class, PROP_QOS,
452 g_param_spec_boolean ("qos", "Qos",
453 "Generate Quality-of-Service events upstream", DEFAULT_QOS,
454 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
458 * If set to #TRUE, the basesink will perform asynchronous state changes.
459 * When set to #FALSE, the sink will not signal the parent when it prerolls.
460 * Use this option when dealing with sparse streams or when synchronisation is
465 g_object_class_install_property (gobject_class, PROP_ASYNC,
466 g_param_spec_boolean ("async", "Async",
467 "Go asynchronously to PAUSED", DEFAULT_ASYNC,
468 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
470 * GstBaseSink:ts-offset
472 * Controls the final synchronisation, a negative value will render the buffer
473 * earlier while a positive value delays playback. This property can be
474 * used to fix synchronisation in bad files.
478 g_object_class_install_property (gobject_class, PROP_TS_OFFSET,
479 g_param_spec_int64 ("ts-offset", "TS Offset",
480 "Timestamp offset in nanoseconds", G_MININT64, G_MAXINT64,
481 DEFAULT_TS_OFFSET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
484 * GstBaseSink:enable-last-buffer
486 * Enable the last-buffer property. If FALSE, basesink doesn't keep a
487 * reference to the last buffer arrived and the last-buffer property is always
488 * set to NULL. This can be useful if you need buffers to be released as soon
489 * as possible, eg. if you're using a buffer pool.
493 g_object_class_install_property (gobject_class, PROP_ENABLE_LAST_BUFFER,
494 g_param_spec_boolean ("enable-last-buffer", "Enable Last Buffer",
495 "Enable the last-buffer property", DEFAULT_ENABLE_LAST_BUFFER,
496 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
499 * GstBaseSink:last-buffer
501 * The last buffer that arrived in the sink and was used for preroll or for
502 * rendering. This property can be used to generate thumbnails. This property
503 * can be NULL when the sink has not yet received a bufer.
507 g_object_class_install_property (gobject_class, PROP_LAST_BUFFER,
508 gst_param_spec_mini_object ("last-buffer", "Last Buffer",
509 "The last buffer received in the sink", GST_TYPE_BUFFER,
510 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
512 * GstBaseSink:blocksize
514 * The amount of bytes to pull when operating in pull mode.
518 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
519 g_object_class_install_property (gobject_class, PROP_BLOCKSIZE,
520 g_param_spec_uint ("blocksize", "Block size",
521 "Size in bytes to pull per buffer (0 = default)", 0, G_MAXUINT,
522 DEFAULT_BLOCKSIZE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
524 * GstBaseSink:render-delay
526 * The additional delay between synchronisation and actual rendering of the
527 * media. This property will add additional latency to the device in order to
528 * make other sinks compensate for the delay.
532 g_object_class_install_property (gobject_class, PROP_RENDER_DELAY,
533 g_param_spec_uint64 ("render-delay", "Render Delay",
534 "Additional render delay of the sink in nanoseconds", 0, G_MAXUINT64,
535 DEFAULT_RENDER_DELAY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
537 * GstBaseSink:throttle-time
539 * The time to insert between buffers. This property can be used to control
540 * the maximum amount of buffers per second to render. Setting this property
541 * to a value bigger than 0 will make the sink create THROTTLE QoS events.
545 g_object_class_install_property (gobject_class, PROP_THROTTLE_TIME,
546 g_param_spec_uint64 ("throttle-time", "Throttle time",
547 "The time to keep between rendered buffers (unused)", 0, G_MAXUINT64,
548 DEFAULT_THROTTLE_TIME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
550 gstelement_class->change_state =
551 GST_DEBUG_FUNCPTR (gst_base_sink_change_state);
552 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_base_sink_send_event);
553 gstelement_class->query = GST_DEBUG_FUNCPTR (gst_base_sink_query);
554 gstelement_class->get_query_types =
555 GST_DEBUG_FUNCPTR (gst_base_sink_get_query_types);
557 klass->get_caps = GST_DEBUG_FUNCPTR (gst_base_sink_get_caps);
558 klass->set_caps = GST_DEBUG_FUNCPTR (gst_base_sink_set_caps);
559 klass->buffer_alloc = GST_DEBUG_FUNCPTR (gst_base_sink_buffer_alloc);
560 klass->get_times = GST_DEBUG_FUNCPTR (gst_base_sink_get_times);
561 klass->activate_pull =
562 GST_DEBUG_FUNCPTR (gst_base_sink_default_activate_pull);
564 /* Registering debug symbols for function pointers */
565 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_getcaps);
566 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_setcaps);
567 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_fixate);
568 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_buffer_alloc);
569 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate);
570 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate_push);
571 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate_pull);
572 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_event);
573 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain);
574 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain_list);
578 gst_base_sink_pad_getcaps (GstPad * pad)
580 GstBaseSinkClass *bclass;
582 GstCaps *caps = NULL;
584 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
585 bclass = GST_BASE_SINK_GET_CLASS (bsink);
587 if (bsink->pad_mode == GST_ACTIVATE_PULL) {
588 /* if we are operating in pull mode we only accept the negotiated caps */
589 GST_OBJECT_LOCK (pad);
590 if ((caps = GST_PAD_CAPS (pad)))
592 GST_OBJECT_UNLOCK (pad);
595 if (bclass->get_caps)
596 caps = bclass->get_caps (bsink);
599 GstPadTemplate *pad_template;
602 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass),
604 if (pad_template != NULL) {
605 caps = gst_caps_ref (gst_pad_template_get_caps (pad_template));
609 gst_object_unref (bsink);
615 gst_base_sink_pad_setcaps (GstPad * pad, GstCaps * caps)
617 GstBaseSinkClass *bclass;
621 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
622 bclass = GST_BASE_SINK_GET_CLASS (bsink);
624 if (res && bclass->set_caps)
625 res = bclass->set_caps (bsink, caps);
627 gst_object_unref (bsink);
633 gst_base_sink_pad_fixate (GstPad * pad, GstCaps * caps)
635 GstBaseSinkClass *bclass;
638 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
639 bclass = GST_BASE_SINK_GET_CLASS (bsink);
642 bclass->fixate (bsink, caps);
644 gst_object_unref (bsink);
648 gst_base_sink_pad_buffer_alloc (GstPad * pad, guint64 offset, guint size,
649 GstCaps * caps, GstBuffer ** buf)
651 GstBaseSinkClass *bclass;
653 GstFlowReturn result = GST_FLOW_OK;
655 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
656 if (G_UNLIKELY (bsink == NULL))
657 return GST_FLOW_WRONG_STATE;
658 bclass = GST_BASE_SINK_GET_CLASS (bsink);
660 if (bclass->buffer_alloc)
661 result = bclass->buffer_alloc (bsink, offset, size, caps, buf);
663 *buf = NULL; /* fallback in gstpad.c will allocate generic buffer */
665 gst_object_unref (bsink);
671 gst_base_sink_init (GstBaseSink * basesink, gpointer g_class)
673 GstPadTemplate *pad_template;
674 GstBaseSinkPrivate *priv;
676 basesink->priv = priv = GST_BASE_SINK_GET_PRIVATE (basesink);
679 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "sink");
680 g_return_if_fail (pad_template != NULL);
682 basesink->sinkpad = gst_pad_new_from_template (pad_template, "sink");
684 gst_pad_set_getcaps_function (basesink->sinkpad, gst_base_sink_pad_getcaps);
685 gst_pad_set_setcaps_function (basesink->sinkpad, gst_base_sink_pad_setcaps);
686 gst_pad_set_fixatecaps_function (basesink->sinkpad, gst_base_sink_pad_fixate);
687 gst_pad_set_bufferalloc_function (basesink->sinkpad,
688 gst_base_sink_pad_buffer_alloc);
689 gst_pad_set_activate_function (basesink->sinkpad, gst_base_sink_pad_activate);
690 gst_pad_set_activatepush_function (basesink->sinkpad,
691 gst_base_sink_pad_activate_push);
692 gst_pad_set_activatepull_function (basesink->sinkpad,
693 gst_base_sink_pad_activate_pull);
694 gst_pad_set_event_function (basesink->sinkpad, gst_base_sink_event);
695 gst_pad_set_chain_function (basesink->sinkpad, gst_base_sink_chain);
696 gst_pad_set_chain_list_function (basesink->sinkpad, gst_base_sink_chain_list);
697 gst_element_add_pad (GST_ELEMENT_CAST (basesink), basesink->sinkpad);
699 basesink->pad_mode = GST_ACTIVATE_NONE;
700 basesink->preroll_queue = g_queue_new ();
701 basesink->abidata.ABI.clip_segment = gst_segment_new ();
702 priv->have_latency = FALSE;
704 basesink->can_activate_push = DEFAULT_CAN_ACTIVATE_PUSH;
705 basesink->can_activate_pull = DEFAULT_CAN_ACTIVATE_PULL;
707 basesink->sync = DEFAULT_SYNC;
708 basesink->abidata.ABI.max_lateness = DEFAULT_MAX_LATENESS;
709 g_atomic_int_set (&priv->qos_enabled, DEFAULT_QOS);
710 priv->async_enabled = DEFAULT_ASYNC;
711 priv->ts_offset = DEFAULT_TS_OFFSET;
712 priv->render_delay = DEFAULT_RENDER_DELAY;
713 priv->blocksize = DEFAULT_BLOCKSIZE;
714 priv->cached_clock_id = NULL;
715 g_atomic_int_set (&priv->enable_last_buffer, DEFAULT_ENABLE_LAST_BUFFER);
716 priv->throttle_time = DEFAULT_THROTTLE_TIME;
718 GST_OBJECT_FLAG_SET (basesink, GST_ELEMENT_IS_SINK);
722 gst_base_sink_finalize (GObject * object)
724 GstBaseSink *basesink;
726 basesink = GST_BASE_SINK (object);
728 g_queue_free (basesink->preroll_queue);
729 gst_segment_free (basesink->abidata.ABI.clip_segment);
731 G_OBJECT_CLASS (parent_class)->finalize (object);
735 * gst_base_sink_set_sync:
737 * @sync: the new sync value.
739 * Configures @sink to synchronize on the clock or not. When
740 * @sync is FALSE, incomming samples will be played as fast as
741 * possible. If @sync is TRUE, the timestamps of the incomming
742 * buffers will be used to schedule the exact render time of its
748 gst_base_sink_set_sync (GstBaseSink * sink, gboolean sync)
750 g_return_if_fail (GST_IS_BASE_SINK (sink));
752 GST_OBJECT_LOCK (sink);
754 GST_OBJECT_UNLOCK (sink);
758 * gst_base_sink_get_sync:
761 * Checks if @sink is currently configured to synchronize against the
764 * Returns: TRUE if the sink is configured to synchronize against the clock.
769 gst_base_sink_get_sync (GstBaseSink * sink)
773 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
775 GST_OBJECT_LOCK (sink);
777 GST_OBJECT_UNLOCK (sink);
783 * gst_base_sink_set_max_lateness:
785 * @max_lateness: the new max lateness value.
787 * Sets the new max lateness value to @max_lateness. This value is
788 * used to decide if a buffer should be dropped or not based on the
789 * buffer timestamp and the current clock time. A value of -1 means
795 gst_base_sink_set_max_lateness (GstBaseSink * sink, gint64 max_lateness)
797 g_return_if_fail (GST_IS_BASE_SINK (sink));
799 GST_OBJECT_LOCK (sink);
800 sink->abidata.ABI.max_lateness = max_lateness;
801 GST_OBJECT_UNLOCK (sink);
805 * gst_base_sink_get_max_lateness:
808 * Gets the max lateness value. See gst_base_sink_set_max_lateness for
811 * Returns: The maximum time in nanoseconds that a buffer can be late
812 * before it is dropped and not rendered. A value of -1 means an
818 gst_base_sink_get_max_lateness (GstBaseSink * sink)
822 g_return_val_if_fail (GST_IS_BASE_SINK (sink), -1);
824 GST_OBJECT_LOCK (sink);
825 res = sink->abidata.ABI.max_lateness;
826 GST_OBJECT_UNLOCK (sink);
832 * gst_base_sink_set_qos_enabled:
834 * @enabled: the new qos value.
836 * Configures @sink to send Quality-of-Service events upstream.
841 gst_base_sink_set_qos_enabled (GstBaseSink * sink, gboolean enabled)
843 g_return_if_fail (GST_IS_BASE_SINK (sink));
845 g_atomic_int_set (&sink->priv->qos_enabled, enabled);
849 * gst_base_sink_is_qos_enabled:
852 * Checks if @sink is currently configured to send Quality-of-Service events
855 * Returns: TRUE if the sink is configured to perform Quality-of-Service.
860 gst_base_sink_is_qos_enabled (GstBaseSink * sink)
864 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
866 res = g_atomic_int_get (&sink->priv->qos_enabled);
872 * gst_base_sink_set_async_enabled:
874 * @enabled: the new async value.
876 * Configures @sink to perform all state changes asynchronusly. When async is
877 * disabled, the sink will immediatly go to PAUSED instead of waiting for a
878 * preroll buffer. This feature is usefull if the sink does not synchronize
879 * against the clock or when it is dealing with sparse streams.
884 gst_base_sink_set_async_enabled (GstBaseSink * sink, gboolean enabled)
886 g_return_if_fail (GST_IS_BASE_SINK (sink));
888 GST_PAD_PREROLL_LOCK (sink->sinkpad);
889 g_atomic_int_set (&sink->priv->async_enabled, enabled);
890 GST_LOG_OBJECT (sink, "set async enabled to %d", enabled);
891 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
895 * gst_base_sink_is_async_enabled:
898 * Checks if @sink is currently configured to perform asynchronous state
901 * Returns: TRUE if the sink is configured to perform asynchronous state
907 gst_base_sink_is_async_enabled (GstBaseSink * sink)
911 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
913 res = g_atomic_int_get (&sink->priv->async_enabled);
919 * gst_base_sink_set_ts_offset:
921 * @offset: the new offset
923 * Adjust the synchronisation of @sink with @offset. A negative value will
924 * render buffers earlier than their timestamp. A positive value will delay
925 * rendering. This function can be used to fix playback of badly timestamped
931 gst_base_sink_set_ts_offset (GstBaseSink * sink, GstClockTimeDiff offset)
933 g_return_if_fail (GST_IS_BASE_SINK (sink));
935 GST_OBJECT_LOCK (sink);
936 sink->priv->ts_offset = offset;
937 GST_LOG_OBJECT (sink, "set time offset to %" G_GINT64_FORMAT, offset);
938 GST_OBJECT_UNLOCK (sink);
942 * gst_base_sink_get_ts_offset:
945 * Get the synchronisation offset of @sink.
947 * Returns: The synchronisation offset.
952 gst_base_sink_get_ts_offset (GstBaseSink * sink)
954 GstClockTimeDiff res;
956 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
958 GST_OBJECT_LOCK (sink);
959 res = sink->priv->ts_offset;
960 GST_OBJECT_UNLOCK (sink);
966 * gst_base_sink_get_last_buffer:
969 * Get the last buffer that arrived in the sink and was used for preroll or for
970 * rendering. This property can be used to generate thumbnails.
972 * The #GstCaps on the buffer can be used to determine the type of the buffer.
974 * Free-function: gst_buffer_unref
976 * Returns: (transfer full): a #GstBuffer. gst_buffer_unref() after usage.
977 * This function returns NULL when no buffer has arrived in the sink yet
978 * or when the sink is not in PAUSED or PLAYING.
983 gst_base_sink_get_last_buffer (GstBaseSink * sink)
987 g_return_val_if_fail (GST_IS_BASE_SINK (sink), NULL);
989 GST_OBJECT_LOCK (sink);
990 if ((res = sink->priv->last_buffer))
991 gst_buffer_ref (res);
992 GST_OBJECT_UNLOCK (sink);
997 /* with OBJECT_LOCK */
999 gst_base_sink_set_last_buffer_unlocked (GstBaseSink * sink, GstBuffer * buffer)
1003 old = sink->priv->last_buffer;
1004 if (G_LIKELY (old != buffer)) {
1005 GST_DEBUG_OBJECT (sink, "setting last buffer to %p", buffer);
1006 if (G_LIKELY (buffer))
1007 gst_buffer_ref (buffer);
1008 sink->priv->last_buffer = buffer;
1012 /* avoid unreffing with the lock because cleanup code might want to take the
1014 if (G_LIKELY (old)) {
1015 GST_OBJECT_UNLOCK (sink);
1016 gst_buffer_unref (old);
1017 GST_OBJECT_LOCK (sink);
1022 gst_base_sink_set_last_buffer (GstBaseSink * sink, GstBuffer * buffer)
1024 if (!g_atomic_int_get (&sink->priv->enable_last_buffer))
1027 GST_OBJECT_LOCK (sink);
1028 gst_base_sink_set_last_buffer_unlocked (sink, buffer);
1029 GST_OBJECT_UNLOCK (sink);
1033 * gst_base_sink_set_last_buffer_enabled:
1035 * @enabled: the new enable-last-buffer value.
1037 * Configures @sink to store the last received buffer in the last-buffer
1043 gst_base_sink_set_last_buffer_enabled (GstBaseSink * sink, gboolean enabled)
1045 g_return_if_fail (GST_IS_BASE_SINK (sink));
1047 /* Only take lock if we change the value */
1048 if (g_atomic_int_compare_and_exchange (&sink->priv->enable_last_buffer,
1049 !enabled, enabled) && !enabled) {
1050 GST_OBJECT_LOCK (sink);
1051 gst_base_sink_set_last_buffer_unlocked (sink, NULL);
1052 GST_OBJECT_UNLOCK (sink);
1057 * gst_base_sink_is_last_buffer_enabled:
1060 * Checks if @sink is currently configured to store the last received buffer in
1061 * the last-buffer property.
1063 * Returns: TRUE if the sink is configured to store the last received buffer.
1068 gst_base_sink_is_last_buffer_enabled (GstBaseSink * sink)
1070 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
1072 return g_atomic_int_get (&sink->priv->enable_last_buffer);
1076 * gst_base_sink_get_latency:
1079 * Get the currently configured latency.
1081 * Returns: The configured latency.
1086 gst_base_sink_get_latency (GstBaseSink * sink)
1090 GST_OBJECT_LOCK (sink);
1091 res = sink->priv->latency;
1092 GST_OBJECT_UNLOCK (sink);
1098 * gst_base_sink_query_latency:
1100 * @live: (out) (allow-none): if the sink is live
1101 * @upstream_live: (out) (allow-none): if an upstream element is live
1102 * @min_latency: (out) (allow-none): the min latency of the upstream elements
1103 * @max_latency: (out) (allow-none): the max latency of the upstream elements
1105 * Query the sink for the latency parameters. The latency will be queried from
1106 * the upstream elements. @live will be TRUE if @sink is configured to
1107 * synchronize against the clock. @upstream_live will be TRUE if an upstream
1110 * If both @live and @upstream_live are TRUE, the sink will want to compensate
1111 * for the latency introduced by the upstream elements by setting the
1112 * @min_latency to a strictly possitive value.
1114 * This function is mostly used by subclasses.
1116 * Returns: TRUE if the query succeeded.
1121 gst_base_sink_query_latency (GstBaseSink * sink, gboolean * live,
1122 gboolean * upstream_live, GstClockTime * min_latency,
1123 GstClockTime * max_latency)
1125 gboolean l, us_live, res, have_latency;
1126 GstClockTime min, max, render_delay;
1128 GstClockTime us_min, us_max;
1130 /* we are live when we sync to the clock */
1131 GST_OBJECT_LOCK (sink);
1133 have_latency = sink->priv->have_latency;
1134 render_delay = sink->priv->render_delay;
1135 GST_OBJECT_UNLOCK (sink);
1137 /* assume no latency */
1143 GST_DEBUG_OBJECT (sink, "we are ready for LATENCY query");
1144 /* we are ready for a latency query this is when we preroll or when we are
1146 query = gst_query_new_latency ();
1148 /* ask the peer for the latency */
1149 if ((res = gst_pad_peer_query (sink->sinkpad, query))) {
1150 /* get upstream min and max latency */
1151 gst_query_parse_latency (query, &us_live, &us_min, &us_max);
1154 /* upstream live, use its latency, subclasses should use these
1155 * values to create the complete latency. */
1160 /* we need to add the render delay if we are live */
1162 min += render_delay;
1164 max += render_delay;
1167 gst_query_unref (query);
1169 GST_DEBUG_OBJECT (sink, "we are not yet ready for LATENCY query");
1173 /* not live, we tried to do the query, if it failed we return TRUE anyway */
1177 GST_DEBUG_OBJECT (sink, "latency query failed but we are not live");
1179 GST_DEBUG_OBJECT (sink, "latency query failed and we are live");
1184 GST_DEBUG_OBJECT (sink, "latency query: live: %d, have_latency %d,"
1185 " upstream: %d, min %" GST_TIME_FORMAT ", max %" GST_TIME_FORMAT, l,
1186 have_latency, us_live, GST_TIME_ARGS (min), GST_TIME_ARGS (max));
1191 *upstream_live = us_live;
1201 * gst_base_sink_set_render_delay:
1202 * @sink: a #GstBaseSink
1203 * @delay: the new delay
1205 * Set the render delay in @sink to @delay. The render delay is the time
1206 * between actual rendering of a buffer and its synchronisation time. Some
1207 * devices might delay media rendering which can be compensated for with this
1210 * After calling this function, this sink will report additional latency and
1211 * other sinks will adjust their latency to delay the rendering of their media.
1213 * This function is usually called by subclasses.
1218 gst_base_sink_set_render_delay (GstBaseSink * sink, GstClockTime delay)
1220 GstClockTime old_render_delay;
1222 g_return_if_fail (GST_IS_BASE_SINK (sink));
1224 GST_OBJECT_LOCK (sink);
1225 old_render_delay = sink->priv->render_delay;
1226 sink->priv->render_delay = delay;
1227 GST_LOG_OBJECT (sink, "set render delay to %" GST_TIME_FORMAT,
1228 GST_TIME_ARGS (delay));
1229 GST_OBJECT_UNLOCK (sink);
1231 if (delay != old_render_delay) {
1232 GST_DEBUG_OBJECT (sink, "posting latency changed");
1233 gst_element_post_message (GST_ELEMENT_CAST (sink),
1234 gst_message_new_latency (GST_OBJECT_CAST (sink)));
1239 * gst_base_sink_get_render_delay:
1240 * @sink: a #GstBaseSink
1242 * Get the render delay of @sink. see gst_base_sink_set_render_delay() for more
1243 * information about the render delay.
1245 * Returns: the render delay of @sink.
1250 gst_base_sink_get_render_delay (GstBaseSink * sink)
1252 GstClockTimeDiff res;
1254 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1256 GST_OBJECT_LOCK (sink);
1257 res = sink->priv->render_delay;
1258 GST_OBJECT_UNLOCK (sink);
1264 * gst_base_sink_set_blocksize:
1265 * @sink: a #GstBaseSink
1266 * @blocksize: the blocksize in bytes
1268 * Set the number of bytes that the sink will pull when it is operating in pull
1273 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
1275 gst_base_sink_set_blocksize (GstBaseSink * sink, guint blocksize)
1277 g_return_if_fail (GST_IS_BASE_SINK (sink));
1279 GST_OBJECT_LOCK (sink);
1280 sink->priv->blocksize = blocksize;
1281 GST_LOG_OBJECT (sink, "set blocksize to %u", blocksize);
1282 GST_OBJECT_UNLOCK (sink);
1286 * gst_base_sink_get_blocksize:
1287 * @sink: a #GstBaseSink
1289 * Get the number of bytes that the sink will pull when it is operating in pull
1292 * Returns: the number of bytes @sink will pull in pull mode.
1296 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
1298 gst_base_sink_get_blocksize (GstBaseSink * sink)
1302 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1304 GST_OBJECT_LOCK (sink);
1305 res = sink->priv->blocksize;
1306 GST_OBJECT_UNLOCK (sink);
1312 * gst_base_sink_set_throttle_time:
1313 * @sink: a #GstBaseSink
1314 * @throttle: the throttle time in nanoseconds
1316 * Set the time that will be inserted between rendered buffers. This
1317 * can be used to control the maximum buffers per second that the sink
1323 gst_base_sink_set_throttle_time (GstBaseSink * sink, guint64 throttle)
1325 g_return_if_fail (GST_IS_BASE_SINK (sink));
1327 GST_OBJECT_LOCK (sink);
1328 sink->priv->throttle_time = throttle;
1329 GST_LOG_OBJECT (sink, "set throttle_time to %" G_GUINT64_FORMAT, throttle);
1330 GST_OBJECT_UNLOCK (sink);
1334 * gst_base_sink_get_throttle_time:
1335 * @sink: a #GstBaseSink
1337 * Get the time that will be inserted between frames to control the
1338 * maximum buffers per second.
1340 * Returns: the number of nanoseconds @sink will put between frames.
1345 gst_base_sink_get_throttle_time (GstBaseSink * sink)
1349 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1351 GST_OBJECT_LOCK (sink);
1352 res = sink->priv->throttle_time;
1353 GST_OBJECT_UNLOCK (sink);
1359 gst_base_sink_set_property (GObject * object, guint prop_id,
1360 const GValue * value, GParamSpec * pspec)
1362 GstBaseSink *sink = GST_BASE_SINK (object);
1365 case PROP_PREROLL_QUEUE_LEN:
1366 /* preroll lock necessary to serialize with finish_preroll */
1367 GST_PAD_PREROLL_LOCK (sink->sinkpad);
1368 g_atomic_int_set (&sink->preroll_queue_max_len, g_value_get_uint (value));
1369 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
1372 gst_base_sink_set_sync (sink, g_value_get_boolean (value));
1374 case PROP_MAX_LATENESS:
1375 gst_base_sink_set_max_lateness (sink, g_value_get_int64 (value));
1378 gst_base_sink_set_qos_enabled (sink, g_value_get_boolean (value));
1381 gst_base_sink_set_async_enabled (sink, g_value_get_boolean (value));
1383 case PROP_TS_OFFSET:
1384 gst_base_sink_set_ts_offset (sink, g_value_get_int64 (value));
1386 case PROP_BLOCKSIZE:
1387 gst_base_sink_set_blocksize (sink, g_value_get_uint (value));
1389 case PROP_RENDER_DELAY:
1390 gst_base_sink_set_render_delay (sink, g_value_get_uint64 (value));
1392 case PROP_ENABLE_LAST_BUFFER:
1393 gst_base_sink_set_last_buffer_enabled (sink, g_value_get_boolean (value));
1395 case PROP_THROTTLE_TIME:
1396 gst_base_sink_set_throttle_time (sink, g_value_get_uint64 (value));
1399 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1405 gst_base_sink_get_property (GObject * object, guint prop_id, GValue * value,
1408 GstBaseSink *sink = GST_BASE_SINK (object);
1411 case PROP_PREROLL_QUEUE_LEN:
1412 g_value_set_uint (value, g_atomic_int_get (&sink->preroll_queue_max_len));
1415 g_value_set_boolean (value, gst_base_sink_get_sync (sink));
1417 case PROP_MAX_LATENESS:
1418 g_value_set_int64 (value, gst_base_sink_get_max_lateness (sink));
1421 g_value_set_boolean (value, gst_base_sink_is_qos_enabled (sink));
1424 g_value_set_boolean (value, gst_base_sink_is_async_enabled (sink));
1426 case PROP_TS_OFFSET:
1427 g_value_set_int64 (value, gst_base_sink_get_ts_offset (sink));
1429 case PROP_LAST_BUFFER:
1430 gst_value_take_buffer (value, gst_base_sink_get_last_buffer (sink));
1432 case PROP_ENABLE_LAST_BUFFER:
1433 g_value_set_boolean (value, gst_base_sink_is_last_buffer_enabled (sink));
1435 case PROP_BLOCKSIZE:
1436 g_value_set_uint (value, gst_base_sink_get_blocksize (sink));
1438 case PROP_RENDER_DELAY:
1439 g_value_set_uint64 (value, gst_base_sink_get_render_delay (sink));
1441 case PROP_THROTTLE_TIME:
1442 g_value_set_uint64 (value, gst_base_sink_get_throttle_time (sink));
1445 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1452 gst_base_sink_get_caps (GstBaseSink * sink)
1458 gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps)
1463 static GstFlowReturn
1464 gst_base_sink_buffer_alloc (GstBaseSink * sink, guint64 offset, guint size,
1465 GstCaps * caps, GstBuffer ** buf)
1471 /* with PREROLL_LOCK, STREAM_LOCK */
1473 gst_base_sink_preroll_queue_flush (GstBaseSink * basesink, GstPad * pad)
1477 GST_DEBUG_OBJECT (basesink, "flushing queue %p", basesink);
1478 while ((obj = g_queue_pop_head (basesink->preroll_queue))) {
1479 GST_DEBUG_OBJECT (basesink, "popped %p", obj);
1480 gst_mini_object_unref (obj);
1482 /* we can't have EOS anymore now */
1483 basesink->eos = FALSE;
1484 basesink->priv->received_eos = FALSE;
1485 basesink->have_preroll = FALSE;
1486 basesink->priv->step_unlock = FALSE;
1487 basesink->eos_queued = FALSE;
1488 basesink->preroll_queued = 0;
1489 basesink->buffers_queued = 0;
1490 basesink->events_queued = 0;
1491 /* can't report latency anymore until we preroll again */
1492 if (basesink->priv->async_enabled) {
1493 GST_OBJECT_LOCK (basesink);
1494 basesink->priv->have_latency = FALSE;
1495 GST_OBJECT_UNLOCK (basesink);
1497 /* and signal any waiters now */
1498 GST_PAD_PREROLL_SIGNAL (pad);
1501 /* with STREAM_LOCK, configures given segment with the event information. */
1503 gst_base_sink_configure_segment (GstBaseSink * basesink, GstPad * pad,
1504 GstEvent * event, GstSegment * segment)
1507 gdouble rate, arate;
1513 /* the newsegment event is needed to bring the buffer timestamps to the
1514 * stream time and to drop samples outside of the playback segment. */
1515 gst_event_parse_new_segment_full (event, &update, &rate, &arate, &format,
1516 &start, &stop, &time);
1518 /* The segment is protected with both the STREAM_LOCK and the OBJECT_LOCK.
1519 * We protect with the OBJECT_LOCK so that we can use the values to
1520 * safely answer a POSITION query. */
1521 GST_OBJECT_LOCK (basesink);
1522 gst_segment_set_newsegment_full (segment, update, rate, arate, format, start,
1525 if (format == GST_FORMAT_TIME) {
1526 GST_DEBUG_OBJECT (basesink,
1527 "configured NEWSEGMENT update %d, rate %lf, applied rate %lf, "
1528 "format GST_FORMAT_TIME, "
1529 "%" GST_TIME_FORMAT " -- %" GST_TIME_FORMAT
1530 ", time %" GST_TIME_FORMAT ", accum %" GST_TIME_FORMAT,
1531 update, rate, arate, GST_TIME_ARGS (segment->start),
1532 GST_TIME_ARGS (segment->stop), GST_TIME_ARGS (segment->time),
1533 GST_TIME_ARGS (segment->accum));
1535 GST_DEBUG_OBJECT (basesink,
1536 "configured NEWSEGMENT update %d, rate %lf, applied rate %lf, "
1538 "%" G_GINT64_FORMAT " -- %" G_GINT64_FORMAT ", time %"
1539 G_GINT64_FORMAT ", accum %" G_GINT64_FORMAT, update, rate, arate,
1540 segment->format, segment->start, segment->stop, segment->time,
1543 GST_OBJECT_UNLOCK (basesink);
1546 /* with PREROLL_LOCK, STREAM_LOCK */
1548 gst_base_sink_commit_state (GstBaseSink * basesink)
1550 /* commit state and proceed to next pending state */
1551 GstState current, next, pending, post_pending;
1552 gboolean post_paused = FALSE;
1553 gboolean post_async_done = FALSE;
1554 gboolean post_playing = FALSE;
1556 /* we are certainly not playing async anymore now */
1557 basesink->playing_async = FALSE;
1559 GST_OBJECT_LOCK (basesink);
1560 current = GST_STATE (basesink);
1561 next = GST_STATE_NEXT (basesink);
1562 pending = GST_STATE_PENDING (basesink);
1563 post_pending = pending;
1566 case GST_STATE_PLAYING:
1568 GstBaseSinkClass *bclass;
1569 GstStateChangeReturn ret;
1571 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1573 GST_DEBUG_OBJECT (basesink, "commiting state to PLAYING");
1575 basesink->need_preroll = FALSE;
1576 post_async_done = TRUE;
1577 basesink->priv->commited = TRUE;
1578 post_playing = TRUE;
1579 /* post PAUSED too when we were READY */
1580 if (current == GST_STATE_READY) {
1584 /* make sure we notify the subclass of async playing */
1585 if (bclass->async_play) {
1586 GST_WARNING_OBJECT (basesink, "deprecated async_play");
1587 ret = bclass->async_play (basesink);
1588 if (ret == GST_STATE_CHANGE_FAILURE)
1593 case GST_STATE_PAUSED:
1594 GST_DEBUG_OBJECT (basesink, "commiting state to PAUSED");
1596 post_async_done = TRUE;
1597 basesink->priv->commited = TRUE;
1598 post_pending = GST_STATE_VOID_PENDING;
1600 case GST_STATE_READY:
1601 case GST_STATE_NULL:
1603 case GST_STATE_VOID_PENDING:
1604 goto nothing_pending;
1609 /* we can report latency queries now */
1610 basesink->priv->have_latency = TRUE;
1612 GST_STATE (basesink) = pending;
1613 GST_STATE_NEXT (basesink) = GST_STATE_VOID_PENDING;
1614 GST_STATE_PENDING (basesink) = GST_STATE_VOID_PENDING;
1615 GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_SUCCESS;
1616 GST_OBJECT_UNLOCK (basesink);
1619 GST_DEBUG_OBJECT (basesink, "posting PAUSED state change message");
1620 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1621 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1622 current, next, post_pending));
1624 if (post_async_done) {
1625 GST_DEBUG_OBJECT (basesink, "posting async-done message");
1626 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1627 gst_message_new_async_done (GST_OBJECT_CAST (basesink)));
1630 GST_DEBUG_OBJECT (basesink, "posting PLAYING state change message");
1631 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1632 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1633 next, pending, GST_STATE_VOID_PENDING));
1636 GST_STATE_BROADCAST (basesink);
1642 /* Depending on the state, set our vars. We get in this situation when the
1643 * state change function got a change to update the state vars before the
1644 * streaming thread did. This is fine but we need to make sure that we
1645 * update the need_preroll var since it was TRUE when we got here and might
1646 * become FALSE if we got to PLAYING. */
1647 GST_DEBUG_OBJECT (basesink, "nothing to commit, now in %s",
1648 gst_element_state_get_name (current));
1650 case GST_STATE_PLAYING:
1651 basesink->need_preroll = FALSE;
1653 case GST_STATE_PAUSED:
1654 basesink->need_preroll = TRUE;
1657 basesink->need_preroll = FALSE;
1658 basesink->flushing = TRUE;
1661 /* we can report latency queries now */
1662 basesink->priv->have_latency = TRUE;
1663 GST_OBJECT_UNLOCK (basesink);
1668 /* app is going to READY */
1669 GST_DEBUG_OBJECT (basesink, "stopping");
1670 basesink->need_preroll = FALSE;
1671 basesink->flushing = TRUE;
1672 GST_OBJECT_UNLOCK (basesink);
1677 GST_DEBUG_OBJECT (basesink, "async commit failed");
1678 GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_FAILURE;
1679 GST_OBJECT_UNLOCK (basesink);
1685 start_stepping (GstBaseSink * sink, GstSegment * segment,
1686 GstStepInfo * pending, GstStepInfo * current)
1689 GstMessage *message;
1691 GST_DEBUG_OBJECT (sink, "update pending step");
1693 GST_OBJECT_LOCK (sink);
1694 memcpy (current, pending, sizeof (GstStepInfo));
1695 pending->valid = FALSE;
1696 GST_OBJECT_UNLOCK (sink);
1698 /* post message first */
1700 gst_message_new_step_start (GST_OBJECT (sink), TRUE, current->format,
1701 current->amount, current->rate, current->flush, current->intermediate);
1702 gst_message_set_seqnum (message, current->seqnum);
1703 gst_element_post_message (GST_ELEMENT (sink), message);
1705 /* get the running time of where we paused and remember it */
1706 current->start = gst_element_get_start_time (GST_ELEMENT_CAST (sink));
1707 gst_segment_set_running_time (segment, GST_FORMAT_TIME, current->start);
1709 /* set the new rate for the remainder of the segment */
1710 current->start_rate = segment->rate;
1711 segment->rate *= current->rate;
1712 segment->abs_rate = ABS (segment->rate);
1715 if (segment->rate > 0.0)
1716 current->start_stop = segment->stop;
1718 current->start_start = segment->start;
1720 if (current->format == GST_FORMAT_TIME) {
1721 end = current->start + current->amount;
1722 if (!current->flush) {
1723 /* update the segment clipping regions for non-flushing seeks */
1724 if (segment->rate > 0.0) {
1725 segment->stop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1726 segment->last_stop = segment->stop;
1730 position = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1731 segment->time = position;
1732 segment->start = position;
1733 segment->last_stop = position;
1738 GST_DEBUG_OBJECT (sink,
1739 "segment now rate %lf, applied rate %lf, "
1740 "format GST_FORMAT_TIME, "
1741 "%" GST_TIME_FORMAT " -- %" GST_TIME_FORMAT
1742 ", time %" GST_TIME_FORMAT ", accum %" GST_TIME_FORMAT,
1743 segment->rate, segment->applied_rate, GST_TIME_ARGS (segment->start),
1744 GST_TIME_ARGS (segment->stop), GST_TIME_ARGS (segment->time),
1745 GST_TIME_ARGS (segment->accum));
1747 GST_DEBUG_OBJECT (sink, "step started at running_time %" GST_TIME_FORMAT,
1748 GST_TIME_ARGS (current->start));
1750 if (current->amount == -1) {
1751 GST_DEBUG_OBJECT (sink, "step amount == -1, stop stepping");
1752 current->valid = FALSE;
1754 GST_DEBUG_OBJECT (sink, "step amount: %" G_GUINT64_FORMAT ", format: %s, "
1755 "rate: %f", current->amount, gst_format_get_name (current->format),
1761 stop_stepping (GstBaseSink * sink, GstSegment * segment,
1762 GstStepInfo * current, gint64 rstart, gint64 rstop, gboolean eos)
1764 gint64 stop, position;
1765 GstMessage *message;
1767 GST_DEBUG_OBJECT (sink, "step complete");
1769 if (segment->rate > 0.0)
1774 GST_DEBUG_OBJECT (sink,
1775 "step stop at running_time %" GST_TIME_FORMAT, GST_TIME_ARGS (stop));
1778 current->duration = current->position;
1780 current->duration = stop - current->start;
1782 GST_DEBUG_OBJECT (sink, "step elapsed running_time %" GST_TIME_FORMAT,
1783 GST_TIME_ARGS (current->duration));
1785 position = current->start + current->duration;
1787 /* now move the segment to the new running time */
1788 gst_segment_set_running_time (segment, GST_FORMAT_TIME, position);
1790 if (current->flush) {
1791 /* and remove the accumulated time we flushed, start time did not change */
1792 segment->accum = current->start;
1794 /* start time is now the stepped position */
1795 gst_element_set_start_time (GST_ELEMENT_CAST (sink), position);
1798 /* restore the previous rate */
1799 segment->rate = current->start_rate;
1800 segment->abs_rate = ABS (segment->rate);
1802 if (segment->rate > 0.0)
1803 segment->stop = current->start_stop;
1805 segment->start = current->start_start;
1807 /* the clip segment is used for position report in paused... */
1808 memcpy (sink->abidata.ABI.clip_segment, segment, sizeof (GstSegment));
1810 /* post the step done when we know the stepped duration in TIME */
1812 gst_message_new_step_done (GST_OBJECT_CAST (sink), current->format,
1813 current->amount, current->rate, current->flush, current->intermediate,
1814 current->duration, eos);
1815 gst_message_set_seqnum (message, current->seqnum);
1816 gst_element_post_message (GST_ELEMENT_CAST (sink), message);
1818 if (!current->intermediate)
1819 sink->need_preroll = current->need_preroll;
1821 /* and the current step info finished and becomes invalid */
1822 current->valid = FALSE;
1826 handle_stepping (GstBaseSink * sink, GstSegment * segment,
1827 GstStepInfo * current, gint64 * cstart, gint64 * cstop, gint64 * rstart,
1830 gboolean step_end = FALSE;
1832 /* see if we need to skip this buffer because of stepping */
1833 switch (current->format) {
1834 case GST_FORMAT_TIME:
1839 if (segment->rate > 0.0) {
1840 if (segment->stop == *cstop)
1841 *rstop = *rstart + current->amount;
1846 if (segment->start == *cstart)
1847 *rstart = *rstop + current->amount;
1853 end = current->start + current->amount;
1854 current->position = first - current->start;
1856 if (G_UNLIKELY (segment->abs_rate != 1.0))
1857 current->position /= segment->abs_rate;
1859 GST_DEBUG_OBJECT (sink,
1860 "buffer: %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT,
1861 GST_TIME_ARGS (first), GST_TIME_ARGS (last));
1862 GST_DEBUG_OBJECT (sink,
1863 "got time step %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT "/%"
1864 GST_TIME_FORMAT, GST_TIME_ARGS (current->position),
1865 GST_TIME_ARGS (last - current->start),
1866 GST_TIME_ARGS (current->amount));
1868 if ((current->flush && current->position >= current->amount)
1870 GST_DEBUG_OBJECT (sink, "step ended, we need clipping");
1872 if (segment->rate > 0.0) {
1874 *cstart = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1877 *cstop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1880 GST_DEBUG_OBJECT (sink,
1881 "cstart %" GST_TIME_FORMAT ", rstart %" GST_TIME_FORMAT,
1882 GST_TIME_ARGS (*cstart), GST_TIME_ARGS (*rstart));
1883 GST_DEBUG_OBJECT (sink,
1884 "cstop %" GST_TIME_FORMAT ", rstop %" GST_TIME_FORMAT,
1885 GST_TIME_ARGS (*cstop), GST_TIME_ARGS (*rstop));
1888 case GST_FORMAT_BUFFERS:
1889 GST_DEBUG_OBJECT (sink,
1890 "got default step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1891 current->position, current->amount);
1893 if (current->position < current->amount) {
1894 current->position++;
1899 case GST_FORMAT_DEFAULT:
1901 GST_DEBUG_OBJECT (sink,
1902 "got unknown step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1903 current->position, current->amount);
1909 /* with STREAM_LOCK, PREROLL_LOCK
1911 * Returns TRUE if the object needs synchronisation and takes therefore
1912 * part in prerolling.
1914 * rsstart/rsstop contain the start/stop in stream time.
1915 * rrstart/rrstop contain the start/stop in running time.
1918 gst_base_sink_get_sync_times (GstBaseSink * basesink, GstMiniObject * obj,
1919 GstClockTime * rsstart, GstClockTime * rsstop,
1920 GstClockTime * rrstart, GstClockTime * rrstop, gboolean * do_sync,
1921 gboolean * stepped, GstSegment * segment, GstStepInfo * step,
1922 gboolean * step_end, guint8 obj_type)
1924 GstBaseSinkClass *bclass;
1926 GstClockTime start, stop; /* raw start/stop timestamps */
1927 gint64 cstart, cstop; /* clipped raw timestamps */
1928 gint64 rstart, rstop; /* clipped timestamps converted to running time */
1929 GstClockTime sstart, sstop; /* clipped timestamps converted to stream time */
1931 GstBaseSinkPrivate *priv;
1934 priv = basesink->priv;
1936 /* start with nothing */
1937 start = stop = GST_CLOCK_TIME_NONE;
1939 if (G_UNLIKELY (OBJ_IS_EVENT (obj_type))) {
1940 GstEvent *event = GST_EVENT_CAST (obj);
1942 switch (GST_EVENT_TYPE (event)) {
1943 /* EOS event needs syncing */
1946 if (basesink->segment.rate >= 0.0) {
1947 sstart = sstop = priv->current_sstop;
1948 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1949 /* we have not seen a buffer yet, use the segment values */
1950 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1951 basesink->segment.format, basesink->segment.stop);
1954 sstart = sstop = priv->current_sstart;
1955 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1956 /* we have not seen a buffer yet, use the segment values */
1957 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1958 basesink->segment.format, basesink->segment.start);
1962 rstart = rstop = priv->eos_rtime;
1963 *do_sync = rstart != -1;
1964 GST_DEBUG_OBJECT (basesink, "sync times for EOS %" GST_TIME_FORMAT,
1965 GST_TIME_ARGS (rstart));
1966 /* if we are stepping, we end now */
1967 *step_end = step->valid;
1972 /* other events do not need syncing */
1973 /* FIXME, maybe NEWSEGMENT might need synchronisation
1974 * since the POSITION query depends on accumulated times and
1975 * we cannot accumulate the current segment before the previous
1985 /* else do buffer sync code */
1986 buffer = GST_BUFFER_CAST (obj);
1988 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1990 /* just get the times to see if we need syncing, if the start returns -1 we
1992 if (bclass->get_times)
1993 bclass->get_times (basesink, buffer, &start, &stop);
1995 if (!GST_CLOCK_TIME_IS_VALID (start)) {
1996 /* we don't need to sync but we still want to get the timestamps for
1997 * tracking the position */
1998 gst_base_sink_get_times (basesink, buffer, &start, &stop);
2004 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
2005 ", stop: %" GST_TIME_FORMAT ", do_sync %d", GST_TIME_ARGS (start),
2006 GST_TIME_ARGS (stop), *do_sync);
2008 /* collect segment and format for code clarity */
2009 format = segment->format;
2011 /* no timestamp clipping if we did not get a TIME segment format */
2012 if (G_UNLIKELY (format != GST_FORMAT_TIME)) {
2015 /* do running and stream time in TIME format */
2016 format = GST_FORMAT_TIME;
2017 GST_LOG_OBJECT (basesink, "not time format, don't clip");
2021 /* clip, only when we know about time */
2022 if (G_UNLIKELY (!gst_segment_clip (segment, GST_FORMAT_TIME,
2023 (gint64) start, (gint64) stop, &cstart, &cstop))) {
2025 GST_DEBUG_OBJECT (basesink, "step out of segment");
2026 /* when we are stepping, pretend we're at the end of the segment */
2027 if (segment->rate > 0.0) {
2028 cstart = segment->stop;
2029 cstop = segment->stop;
2031 cstart = segment->start;
2032 cstop = segment->start;
2036 goto out_of_segment;
2039 if (G_UNLIKELY (start != cstart || stop != cstop)) {
2040 GST_DEBUG_OBJECT (basesink, "clipped to: start %" GST_TIME_FORMAT
2041 ", stop: %" GST_TIME_FORMAT, GST_TIME_ARGS (cstart),
2042 GST_TIME_ARGS (cstop));
2045 /* set last stop position */
2046 if (G_LIKELY (stop != GST_CLOCK_TIME_NONE && cstop != GST_CLOCK_TIME_NONE))
2047 gst_segment_set_last_stop (segment, GST_FORMAT_TIME, cstop);
2049 gst_segment_set_last_stop (segment, GST_FORMAT_TIME, cstart);
2052 rstart = gst_segment_to_running_time (segment, format, cstart);
2053 rstop = gst_segment_to_running_time (segment, format, cstop);
2055 if (G_UNLIKELY (step->valid)) {
2056 if (!(*step_end = handle_stepping (basesink, segment, step, &cstart, &cstop,
2057 &rstart, &rstop))) {
2058 /* step is still busy, we discard data when we are flushing */
2059 *stepped = step->flush;
2060 GST_DEBUG_OBJECT (basesink, "stepping busy");
2063 /* this can produce wrong values if we accumulated non-TIME segments. If this happens,
2064 * upstream is behaving very badly */
2065 sstart = gst_segment_to_stream_time (segment, format, cstart);
2066 sstop = gst_segment_to_stream_time (segment, format, cstop);
2069 /* eos_done label only called when doing EOS, we also stop stepping then */
2070 if (*step_end && step->flush) {
2071 GST_DEBUG_OBJECT (basesink, "flushing step ended");
2072 stop_stepping (basesink, segment, step, rstart, rstop, eos);
2074 /* re-determine running start times for adjusted segment
2075 * (which has a flushed amount of running/accumulated time removed) */
2076 if (!GST_IS_EVENT (obj)) {
2077 GST_DEBUG_OBJECT (basesink, "refresh sync times");
2088 /* buffers and EOS always need syncing and preroll */
2094 /* we usually clip in the chain function already but stepping could cause
2095 * the segment to be updated later. we return FALSE so that we don't try
2097 GST_LOG_OBJECT (basesink, "buffer skipped, not in segment");
2102 /* with STREAM_LOCK, PREROLL_LOCK, LOCK
2103 * adjust a timestamp with the latency and timestamp offset. This function does
2104 * not adjust for the render delay. */
2106 gst_base_sink_adjust_time (GstBaseSink * basesink, GstClockTime time)
2108 GstClockTimeDiff ts_offset;
2110 /* don't do anything funny with invalid timestamps */
2111 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
2114 time += basesink->priv->latency;
2116 /* apply offset, be carefull for underflows */
2117 ts_offset = basesink->priv->ts_offset;
2118 if (ts_offset < 0) {
2119 ts_offset = -ts_offset;
2120 if (ts_offset < time)
2127 /* subtract the render delay again, which was included in the latency */
2128 if (time > basesink->priv->render_delay)
2129 time -= basesink->priv->render_delay;
2137 * gst_base_sink_wait_clock:
2139 * @time: the running_time to be reached
2140 * @jitter: (out) (allow-none): the jitter to be filled with time diff, or NULL
2142 * This function will block until @time is reached. It is usually called by
2143 * subclasses that use their own internal synchronisation.
2145 * If @time is not valid, no sycnhronisation is done and #GST_CLOCK_BADTIME is
2146 * returned. Likewise, if synchronisation is disabled in the element or there
2147 * is no clock, no synchronisation is done and #GST_CLOCK_BADTIME is returned.
2149 * This function should only be called with the PREROLL_LOCK held, like when
2150 * receiving an EOS event in the #GstBaseSinkClass.event() vmethod or when
2151 * receiving a buffer in
2152 * the #GstBaseSinkClass.render() vmethod.
2154 * The @time argument should be the running_time of when this method should
2155 * return and is not adjusted with any latency or offset configured in the
2160 * Returns: #GstClockReturn
2163 gst_base_sink_wait_clock (GstBaseSink * sink, GstClockTime time,
2164 GstClockTimeDiff * jitter)
2168 GstClockTime base_time;
2170 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
2173 GST_OBJECT_LOCK (sink);
2174 if (G_UNLIKELY (!sink->sync))
2177 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (sink)) == NULL))
2180 base_time = GST_ELEMENT_CAST (sink)->base_time;
2181 GST_LOG_OBJECT (sink,
2182 "time %" GST_TIME_FORMAT ", base_time %" GST_TIME_FORMAT,
2183 GST_TIME_ARGS (time), GST_TIME_ARGS (base_time));
2185 /* add base_time to running_time to get the time against the clock */
2188 /* Re-use existing clockid if available */
2189 if (G_LIKELY (sink->priv->cached_clock_id != NULL)) {
2190 if (!gst_clock_single_shot_id_reinit (clock, sink->priv->cached_clock_id,
2192 gst_clock_id_unref (sink->priv->cached_clock_id);
2193 sink->priv->cached_clock_id = gst_clock_new_single_shot_id (clock, time);
2196 sink->priv->cached_clock_id = gst_clock_new_single_shot_id (clock, time);
2197 GST_OBJECT_UNLOCK (sink);
2199 /* A blocking wait is performed on the clock. We save the ClockID
2200 * so we can unlock the entry at any time. While we are blocking, we
2201 * release the PREROLL_LOCK so that other threads can interrupt the
2203 sink->clock_id = sink->priv->cached_clock_id;
2204 /* release the preroll lock while waiting */
2205 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
2207 ret = gst_clock_id_wait (sink->priv->cached_clock_id, jitter);
2209 GST_PAD_PREROLL_LOCK (sink->sinkpad);
2210 sink->clock_id = NULL;
2214 /* no syncing needed */
2217 GST_DEBUG_OBJECT (sink, "time not valid, no sync needed");
2218 return GST_CLOCK_BADTIME;
2222 GST_DEBUG_OBJECT (sink, "sync disabled");
2223 GST_OBJECT_UNLOCK (sink);
2224 return GST_CLOCK_BADTIME;
2228 GST_DEBUG_OBJECT (sink, "no clock, can't sync");
2229 GST_OBJECT_UNLOCK (sink);
2230 return GST_CLOCK_BADTIME;
2235 * gst_base_sink_wait_preroll:
2238 * If the #GstBaseSinkClass.render() method performs its own synchronisation
2239 * against the clock it must unblock when going from PLAYING to the PAUSED state
2240 * and call this method before continuing to render the remaining data.
2242 * This function will block until a state change to PLAYING happens (in which
2243 * case this function returns #GST_FLOW_OK) or the processing must be stopped due
2244 * to a state change to READY or a FLUSH event (in which case this function
2245 * returns #GST_FLOW_WRONG_STATE).
2247 * This function should only be called with the PREROLL_LOCK held, like in the
2250 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2251 * continue. Any other return value should be returned from the render vmethod.
2256 gst_base_sink_wait_preroll (GstBaseSink * sink)
2258 sink->have_preroll = TRUE;
2259 GST_DEBUG_OBJECT (sink, "waiting in preroll for flush or PLAYING");
2260 /* block until the state changes, or we get a flush, or something */
2261 GST_PAD_PREROLL_WAIT (sink->sinkpad);
2262 sink->have_preroll = FALSE;
2263 if (G_UNLIKELY (sink->flushing))
2265 if (G_UNLIKELY (sink->priv->step_unlock))
2267 GST_DEBUG_OBJECT (sink, "continue after preroll");
2274 GST_DEBUG_OBJECT (sink, "preroll interrupted because of flush");
2275 return GST_FLOW_WRONG_STATE;
2279 sink->priv->step_unlock = FALSE;
2280 GST_DEBUG_OBJECT (sink, "preroll interrupted because of step");
2281 return GST_FLOW_STEP;
2285 static inline guint8
2286 get_object_type (GstMiniObject * obj)
2290 if (G_LIKELY (GST_IS_BUFFER (obj)))
2291 obj_type = _PR_IS_BUFFER;
2292 else if (GST_IS_EVENT (obj))
2293 obj_type = _PR_IS_EVENT;
2294 else if (GST_IS_BUFFER_LIST (obj))
2295 obj_type = _PR_IS_BUFFERLIST;
2297 obj_type = _PR_IS_NOTHING;
2303 * gst_base_sink_do_preroll:
2305 * @obj: (transfer none): the mini object that caused the preroll
2307 * If the @sink spawns its own thread for pulling buffers from upstream it
2308 * should call this method after it has pulled a buffer. If the element needed
2309 * to preroll, this function will perform the preroll and will then block
2310 * until the element state is changed.
2312 * This function should be called with the PREROLL_LOCK held.
2314 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2315 * continue. Any other return value should be returned from the render vmethod.
2320 gst_base_sink_do_preroll (GstBaseSink * sink, GstMiniObject * obj)
2324 while (G_UNLIKELY (sink->need_preroll)) {
2326 GST_DEBUG_OBJECT (sink, "prerolling object %p", obj);
2328 obj_type = get_object_type (obj);
2330 ret = gst_base_sink_preroll_object (sink, obj_type, obj);
2331 if (ret != GST_FLOW_OK)
2332 goto preroll_failed;
2334 /* need to recheck here because the commit state could have
2335 * made us not need the preroll anymore */
2336 if (G_LIKELY (sink->need_preroll)) {
2337 /* block until the state changes, or we get a flush, or something */
2338 ret = gst_base_sink_wait_preroll (sink);
2339 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2340 goto preroll_failed;
2348 GST_DEBUG_OBJECT (sink, "preroll failed: %s", gst_flow_get_name (ret));
2354 * gst_base_sink_wait_eos:
2356 * @time: the running_time to be reached
2357 * @jitter: (out) (allow-none): the jitter to be filled with time diff, or NULL
2359 * This function will block until @time is reached. It is usually called by
2360 * subclasses that use their own internal synchronisation but want to let the
2361 * EOS be handled by the base class.
2363 * This function should only be called with the PREROLL_LOCK held, like when
2364 * receiving an EOS event in the ::event vmethod.
2366 * The @time argument should be the running_time of when the EOS should happen
2367 * and will be adjusted with any latency and offset configured in the sink.
2369 * Returns: #GstFlowReturn
2374 gst_base_sink_wait_eos (GstBaseSink * sink, GstClockTime time,
2375 GstClockTimeDiff * jitter)
2377 GstClockReturn status;
2383 GST_DEBUG_OBJECT (sink, "checking preroll");
2385 /* first wait for the playing state before we can continue */
2386 while (G_UNLIKELY (sink->need_preroll)) {
2387 ret = gst_base_sink_wait_preroll (sink);
2388 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2392 /* preroll done, we can sync since we are in PLAYING now. */
2393 GST_DEBUG_OBJECT (sink, "possibly waiting for clock to reach %"
2394 GST_TIME_FORMAT, GST_TIME_ARGS (time));
2396 /* compensate for latency and ts_offset. We don't adjust for render delay
2397 * because we don't interact with the device on EOS normally. */
2398 stime = gst_base_sink_adjust_time (sink, time);
2400 /* wait for the clock, this can be interrupted because we got shut down or
2402 status = gst_base_sink_wait_clock (sink, stime, jitter);
2404 GST_DEBUG_OBJECT (sink, "clock returned %d", status);
2406 /* invalid time, no clock or sync disabled, just continue then */
2407 if (status == GST_CLOCK_BADTIME)
2410 /* waiting could have been interrupted and we can be flushing now */
2411 if (G_UNLIKELY (sink->flushing))
2414 /* retry if we got unscheduled, which means we did not reach the timeout
2415 * yet. if some other error occures, we continue. */
2416 } while (status == GST_CLOCK_UNSCHEDULED);
2418 GST_DEBUG_OBJECT (sink, "end of stream");
2425 GST_DEBUG_OBJECT (sink, "we are flushing");
2426 return GST_FLOW_WRONG_STATE;
2430 /* with STREAM_LOCK, PREROLL_LOCK
2432 * Make sure we are in PLAYING and synchronize an object to the clock.
2434 * If we need preroll, we are not in PLAYING. We try to commit the state
2435 * if needed and then block if we still are not PLAYING.
2437 * We start waiting on the clock in PLAYING. If we got interrupted, we
2438 * immediatly try to re-preroll.
2440 * Some objects do not need synchronisation (most events) and so this function
2441 * immediatly returns GST_FLOW_OK.
2443 * for objects that arrive later than max-lateness to be synchronized to the
2444 * clock have the @late boolean set to TRUE.
2446 * This function keeps a running average of the jitter (the diff between the
2447 * clock time and the requested sync time). The jitter is negative for
2448 * objects that arrive in time and positive for late buffers.
2450 * does not take ownership of obj.
2452 static GstFlowReturn
2453 gst_base_sink_do_sync (GstBaseSink * basesink, GstPad * pad,
2454 GstMiniObject * obj, gboolean * late, gboolean * step_end, guint8 obj_type)
2456 GstClockTimeDiff jitter = 0;
2458 GstClockReturn status = GST_CLOCK_OK;
2459 GstClockTime rstart, rstop, sstart, sstop, stime;
2461 GstBaseSinkPrivate *priv;
2463 GstStepInfo *current, *pending;
2466 priv = basesink->priv;
2469 sstart = sstop = rstart = rstop = GST_CLOCK_TIME_NONE;
2473 priv->current_rstart = GST_CLOCK_TIME_NONE;
2475 /* get stepping info */
2476 current = &priv->current_step;
2477 pending = &priv->pending_step;
2479 /* get timing information for this object against the render segment */
2480 syncable = gst_base_sink_get_sync_times (basesink, obj,
2481 &sstart, &sstop, &rstart, &rstop, &do_sync, &stepped, &basesink->segment,
2482 current, step_end, obj_type);
2484 if (G_UNLIKELY (stepped))
2487 /* a syncable object needs to participate in preroll and
2488 * clocking. All buffers and EOS are syncable. */
2489 if (G_UNLIKELY (!syncable))
2492 /* store timing info for current object */
2493 priv->current_rstart = rstart;
2494 priv->current_rstop = (GST_CLOCK_TIME_IS_VALID (rstop) ? rstop : rstart);
2496 /* save sync time for eos when the previous object needed sync */
2497 priv->eos_rtime = (do_sync ? priv->current_rstop : GST_CLOCK_TIME_NONE);
2499 /* calculate inter frame spacing */
2500 if (G_UNLIKELY (priv->prev_rstart != -1 && priv->prev_rstart < rstart)) {
2501 GstClockTime in_diff;
2503 in_diff = rstart - priv->prev_rstart;
2505 if (priv->avg_in_diff == -1)
2506 priv->avg_in_diff = in_diff;
2508 priv->avg_in_diff = UPDATE_RUNNING_AVG (priv->avg_in_diff, in_diff);
2510 GST_LOG_OBJECT (basesink, "avg frame diff %" GST_TIME_FORMAT,
2511 GST_TIME_ARGS (priv->avg_in_diff));
2514 priv->prev_rstart = rstart;
2516 if (G_UNLIKELY (priv->earliest_in_time != -1
2517 && rstart < priv->earliest_in_time))
2521 /* first do preroll, this makes sure we commit our state
2522 * to PAUSED and can continue to PLAYING. We cannot perform
2523 * any clock sync in PAUSED because there is no clock. */
2524 ret = gst_base_sink_do_preroll (basesink, obj);
2525 if (G_UNLIKELY (ret != GST_FLOW_OK))
2526 goto preroll_failed;
2528 /* update the segment with a pending step if the current one is invalid and we
2529 * have a new pending one. We only accept new step updates after a preroll */
2530 if (G_UNLIKELY (pending->valid && !current->valid)) {
2531 start_stepping (basesink, &basesink->segment, pending, current);
2535 /* After rendering we store the position of the last buffer so that we can use
2536 * it to report the position. We need to take the lock here. */
2537 GST_OBJECT_LOCK (basesink);
2538 priv->current_sstart = sstart;
2539 priv->current_sstop = (GST_CLOCK_TIME_IS_VALID (sstop) ? sstop : sstart);
2540 GST_OBJECT_UNLOCK (basesink);
2545 /* adjust for latency */
2546 stime = gst_base_sink_adjust_time (basesink, rstart);
2548 /* adjust for render-delay, avoid underflows */
2549 if (GST_CLOCK_TIME_IS_VALID (stime)) {
2550 if (stime > priv->render_delay)
2551 stime -= priv->render_delay;
2556 /* preroll done, we can sync since we are in PLAYING now. */
2557 GST_DEBUG_OBJECT (basesink, "possibly waiting for clock to reach %"
2558 GST_TIME_FORMAT ", adjusted %" GST_TIME_FORMAT,
2559 GST_TIME_ARGS (rstart), GST_TIME_ARGS (stime));
2561 /* This function will return immediatly if start == -1, no clock
2562 * or sync is disabled with GST_CLOCK_BADTIME. */
2563 status = gst_base_sink_wait_clock (basesink, stime, &jitter);
2565 GST_DEBUG_OBJECT (basesink, "clock returned %d, jitter %c%" GST_TIME_FORMAT,
2566 status, (jitter < 0 ? '-' : ' '), GST_TIME_ARGS (ABS (jitter)));
2568 /* invalid time, no clock or sync disabled, just render */
2569 if (status == GST_CLOCK_BADTIME)
2572 /* waiting could have been interrupted and we can be flushing now */
2573 if (G_UNLIKELY (basesink->flushing))
2576 /* check for unlocked by a state change, we are not flushing so
2577 * we can try to preroll on the current buffer. */
2578 if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED)) {
2579 GST_DEBUG_OBJECT (basesink, "unscheduled, waiting some more");
2580 priv->call_preroll = TRUE;
2584 /* successful syncing done, record observation */
2585 priv->current_jitter = jitter;
2587 /* check if the object should be dropped */
2588 *late = gst_base_sink_is_too_late (basesink, obj, rstart, rstop,
2597 GST_DEBUG_OBJECT (basesink, "skipped stepped object %p", obj);
2603 GST_DEBUG_OBJECT (basesink, "non syncable object %p", obj);
2608 GST_DEBUG_OBJECT (basesink, "dropped because of QoS %p", obj);
2614 GST_DEBUG_OBJECT (basesink, "we are flushing");
2615 return GST_FLOW_WRONG_STATE;
2619 GST_DEBUG_OBJECT (basesink, "preroll failed");
2626 gst_base_sink_send_qos (GstBaseSink * basesink, GstQOSType type,
2627 gdouble proportion, GstClockTime time, GstClockTimeDiff diff)
2632 /* generate Quality-of-Service event */
2633 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2634 "qos: type %d, proportion: %lf, diff %" G_GINT64_FORMAT ", timestamp %"
2635 GST_TIME_FORMAT, type, proportion, diff, GST_TIME_ARGS (time));
2637 event = gst_event_new_qos_full (type, proportion, diff, time);
2640 res = gst_pad_push_event (basesink->sinkpad, event);
2646 gst_base_sink_perform_qos (GstBaseSink * sink, gboolean dropped)
2648 GstBaseSinkPrivate *priv;
2649 GstClockTime start, stop;
2650 GstClockTimeDiff jitter;
2651 GstClockTime pt, entered, left;
2652 GstClockTime duration;
2657 start = priv->current_rstart;
2659 if (priv->current_step.valid)
2662 /* if Quality-of-Service disabled, do nothing */
2663 if (!g_atomic_int_get (&priv->qos_enabled) ||
2664 !GST_CLOCK_TIME_IS_VALID (start))
2667 stop = priv->current_rstop;
2668 jitter = priv->current_jitter;
2671 /* this is the time the buffer entered the sink */
2672 if (start < -jitter)
2675 entered = start + jitter;
2678 /* this is the time the buffer entered the sink */
2679 entered = start + jitter;
2680 /* this is the time the buffer left the sink */
2681 left = start + jitter;
2684 /* calculate duration of the buffer */
2685 if (GST_CLOCK_TIME_IS_VALID (stop) && stop != start)
2686 duration = stop - start;
2688 duration = priv->avg_in_diff;
2690 /* if we have the time when the last buffer left us, calculate
2691 * processing time */
2692 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2693 if (entered > priv->last_left) {
2694 pt = entered - priv->last_left;
2702 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "start: %" GST_TIME_FORMAT
2703 ", stop %" GST_TIME_FORMAT ", entered %" GST_TIME_FORMAT ", left %"
2704 GST_TIME_FORMAT ", pt: %" GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT
2705 ",jitter %" G_GINT64_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (stop),
2706 GST_TIME_ARGS (entered), GST_TIME_ARGS (left), GST_TIME_ARGS (pt),
2707 GST_TIME_ARGS (duration), jitter);
2709 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "avg_duration: %" GST_TIME_FORMAT
2710 ", avg_pt: %" GST_TIME_FORMAT ", avg_rate: %g",
2711 GST_TIME_ARGS (priv->avg_duration), GST_TIME_ARGS (priv->avg_pt),
2714 /* collect running averages. for first observations, we copy the
2716 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_duration))
2717 priv->avg_duration = duration;
2719 priv->avg_duration = UPDATE_RUNNING_AVG (priv->avg_duration, duration);
2721 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_pt))
2724 priv->avg_pt = UPDATE_RUNNING_AVG (priv->avg_pt, pt);
2726 if (priv->avg_duration != 0)
2728 gst_guint64_to_gdouble (priv->avg_pt) /
2729 gst_guint64_to_gdouble (priv->avg_duration);
2733 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2734 if (dropped || priv->avg_rate < 0.0) {
2735 priv->avg_rate = rate;
2738 priv->avg_rate = UPDATE_RUNNING_AVG_N (priv->avg_rate, rate);
2740 priv->avg_rate = UPDATE_RUNNING_AVG_P (priv->avg_rate, rate);
2744 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink,
2745 "updated: avg_duration: %" GST_TIME_FORMAT ", avg_pt: %" GST_TIME_FORMAT
2746 ", avg_rate: %g", GST_TIME_ARGS (priv->avg_duration),
2747 GST_TIME_ARGS (priv->avg_pt), priv->avg_rate);
2750 if (priv->avg_rate >= 0.0) {
2752 GstClockTimeDiff diff;
2754 /* if we have a valid rate, start sending QoS messages */
2755 if (priv->current_jitter < 0) {
2756 /* make sure we never go below 0 when adding the jitter to the
2758 if (priv->current_rstart < -priv->current_jitter)
2759 priv->current_jitter = -priv->current_rstart;
2762 if (priv->throttle_time > 0) {
2763 diff = priv->throttle_time;
2764 type = GST_QOS_TYPE_THROTTLE;
2766 diff = priv->current_jitter;
2768 type = GST_QOS_TYPE_OVERFLOW;
2770 type = GST_QOS_TYPE_UNDERFLOW;
2773 gst_base_sink_send_qos (sink, type, priv->avg_rate, priv->current_rstart,
2777 /* record when this buffer will leave us */
2778 priv->last_left = left;
2781 /* reset all qos measuring */
2783 gst_base_sink_reset_qos (GstBaseSink * sink)
2785 GstBaseSinkPrivate *priv;
2789 priv->last_render_time = GST_CLOCK_TIME_NONE;
2790 priv->prev_rstart = GST_CLOCK_TIME_NONE;
2791 priv->earliest_in_time = GST_CLOCK_TIME_NONE;
2792 priv->last_left = GST_CLOCK_TIME_NONE;
2793 priv->avg_duration = GST_CLOCK_TIME_NONE;
2794 priv->avg_pt = GST_CLOCK_TIME_NONE;
2795 priv->avg_rate = -1.0;
2796 priv->avg_render = GST_CLOCK_TIME_NONE;
2797 priv->avg_in_diff = GST_CLOCK_TIME_NONE;
2803 /* Checks if the object was scheduled too late.
2805 * rstart/rstop contain the running_time start and stop values
2808 * status and jitter contain the return values from the clock wait.
2810 * returns TRUE if the buffer was too late.
2813 gst_base_sink_is_too_late (GstBaseSink * basesink, GstMiniObject * obj,
2814 GstClockTime rstart, GstClockTime rstop,
2815 GstClockReturn status, GstClockTimeDiff jitter)
2818 gint64 max_lateness;
2819 GstBaseSinkPrivate *priv;
2821 priv = basesink->priv;
2825 /* only for objects that were too late */
2826 if (G_LIKELY (status != GST_CLOCK_EARLY))
2829 max_lateness = basesink->abidata.ABI.max_lateness;
2831 /* check if frame dropping is enabled */
2832 if (max_lateness == -1)
2835 /* only check for buffers */
2836 if (G_UNLIKELY (!GST_IS_BUFFER (obj)))
2839 /* can't do check if we don't have a timestamp */
2840 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (rstart)))
2843 /* we can add a valid stop time */
2844 if (GST_CLOCK_TIME_IS_VALID (rstop))
2845 max_lateness += rstop;
2847 max_lateness += rstart;
2848 /* no stop time, use avg frame diff */
2849 if (priv->avg_in_diff != -1)
2850 max_lateness += priv->avg_in_diff;
2853 /* if the jitter bigger than duration and lateness we are too late */
2854 if ((late = rstart + jitter > max_lateness)) {
2855 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2856 "buffer is too late %" GST_TIME_FORMAT
2857 " > %" GST_TIME_FORMAT, GST_TIME_ARGS (rstart + jitter),
2858 GST_TIME_ARGS (max_lateness));
2859 /* !!emergency!!, if we did not receive anything valid for more than a
2860 * second, render it anyway so the user sees something */
2861 if (GST_CLOCK_TIME_IS_VALID (priv->last_render_time) &&
2862 rstart - priv->last_render_time > GST_SECOND) {
2864 GST_ELEMENT_WARNING (basesink, CORE, CLOCK,
2865 (_("A lot of buffers are being dropped.")),
2866 ("There may be a timestamping problem, or this computer is too slow."));
2867 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2868 "**emergency** last buffer at %" GST_TIME_FORMAT " > GST_SECOND",
2869 GST_TIME_ARGS (priv->last_render_time));
2874 if (!late || !GST_CLOCK_TIME_IS_VALID (priv->last_render_time)) {
2875 priv->last_render_time = rstart;
2876 /* the next allowed input timestamp */
2877 if (priv->throttle_time > 0)
2878 priv->earliest_in_time = rstart + priv->throttle_time;
2885 GST_DEBUG_OBJECT (basesink, "object was scheduled in time");
2890 GST_DEBUG_OBJECT (basesink, "frame dropping disabled");
2895 GST_DEBUG_OBJECT (basesink, "object is not a buffer");
2900 GST_DEBUG_OBJECT (basesink, "buffer has no timestamp");
2905 /* called before and after calling the render vmethod. It keeps track of how
2906 * much time was spent in the render method and is used to check if we are
2909 gst_base_sink_do_render_stats (GstBaseSink * basesink, gboolean start)
2911 GstBaseSinkPrivate *priv;
2913 priv = basesink->priv;
2916 priv->start = gst_util_get_timestamp ();
2918 GstClockTime elapsed;
2920 priv->stop = gst_util_get_timestamp ();
2922 elapsed = GST_CLOCK_DIFF (priv->start, priv->stop);
2924 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_render))
2925 priv->avg_render = elapsed;
2927 priv->avg_render = UPDATE_RUNNING_AVG (priv->avg_render, elapsed);
2929 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2930 "avg_render: %" GST_TIME_FORMAT, GST_TIME_ARGS (priv->avg_render));
2934 /* with STREAM_LOCK, PREROLL_LOCK,
2936 * Synchronize the object on the clock and then render it.
2938 * takes ownership of obj.
2940 static GstFlowReturn
2941 gst_base_sink_render_object (GstBaseSink * basesink, GstPad * pad,
2942 guint8 obj_type, gpointer obj)
2945 GstBaseSinkClass *bclass;
2946 gboolean late, step_end;
2948 GstBaseSinkPrivate *priv;
2950 priv = basesink->priv;
2952 if (OBJ_IS_BUFFERLIST (obj_type)) {
2954 * If buffer list, use the first group buffer within the list
2957 sync_obj = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0, 0);
2958 g_assert (NULL != sync_obj);
2967 /* synchronize this object, non syncable objects return OK
2970 gst_base_sink_do_sync (basesink, pad, sync_obj, &late, &step_end,
2972 if (G_UNLIKELY (ret != GST_FLOW_OK))
2975 /* and now render, event or buffer/buffer list. */
2976 if (G_LIKELY (OBJ_IS_BUFFERFULL (obj_type))) {
2977 /* drop late buffers unconditionally, let's hope it's unlikely */
2978 if (G_UNLIKELY (late))
2981 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2983 if (G_LIKELY ((OBJ_IS_BUFFERLIST (obj_type) && bclass->render_list) ||
2984 (!OBJ_IS_BUFFERLIST (obj_type) && bclass->render))) {
2987 /* read once, to get same value before and after */
2988 do_qos = g_atomic_int_get (&priv->qos_enabled);
2990 GST_DEBUG_OBJECT (basesink, "rendering object %p", obj);
2992 /* record rendering time for QoS and stats */
2994 gst_base_sink_do_render_stats (basesink, TRUE);
2996 if (!OBJ_IS_BUFFERLIST (obj_type)) {
2999 /* For buffer lists do not set last buffer. Creating buffer
3000 * with meaningful data can be done only with memcpy which will
3001 * significantly affect performance */
3002 buf = GST_BUFFER_CAST (obj);
3003 gst_base_sink_set_last_buffer (basesink, buf);
3005 ret = bclass->render (basesink, buf);
3007 GstBufferList *buflist;
3009 buflist = GST_BUFFER_LIST_CAST (obj);
3011 ret = bclass->render_list (basesink, buflist);
3015 gst_base_sink_do_render_stats (basesink, FALSE);
3017 if (ret == GST_FLOW_STEP)
3020 if (G_UNLIKELY (basesink->flushing))
3025 } else if (G_LIKELY (OBJ_IS_EVENT (obj_type))) {
3026 GstEvent *event = GST_EVENT_CAST (obj);
3027 gboolean event_res = TRUE;
3030 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3032 type = GST_EVENT_TYPE (event);
3034 GST_DEBUG_OBJECT (basesink, "rendering event %p, type %s", obj,
3035 gst_event_type_get_name (type));
3038 event_res = bclass->event (basesink, event);
3040 /* when we get here we could be flushing again when the event handler calls
3041 * _wait_eos(). We have to ignore this object in that case. */
3042 if (G_UNLIKELY (basesink->flushing))
3045 if (G_LIKELY (event_res)) {
3048 seqnum = basesink->priv->seqnum = gst_event_get_seqnum (event);
3049 GST_DEBUG_OBJECT (basesink, "Got seqnum #%" G_GUINT32_FORMAT, seqnum);
3054 GstMessage *message;
3056 /* the EOS event is completely handled so we mark
3057 * ourselves as being in the EOS state. eos is also
3058 * protected by the object lock so we can read it when
3059 * answering the POSITION query. */
3060 GST_OBJECT_LOCK (basesink);
3061 basesink->eos = TRUE;
3062 GST_OBJECT_UNLOCK (basesink);
3064 /* ok, now we can post the message */
3065 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
3067 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
3068 gst_message_set_seqnum (message, seqnum);
3069 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
3072 case GST_EVENT_NEWSEGMENT:
3073 /* configure the segment */
3074 gst_base_sink_configure_segment (basesink, pad, event,
3075 &basesink->segment);
3077 case GST_EVENT_SINK_MESSAGE:{
3078 GstMessage *msg = NULL;
3080 gst_event_parse_sink_message (event, &msg);
3083 gst_element_post_message (GST_ELEMENT_CAST (basesink), msg);
3090 g_return_val_if_reached (GST_FLOW_ERROR);
3095 /* the step ended, check if we need to activate a new step */
3096 GST_DEBUG_OBJECT (basesink, "step ended");
3097 stop_stepping (basesink, &basesink->segment, &priv->current_step,
3098 priv->current_rstart, priv->current_rstop, basesink->eos);
3102 gst_base_sink_perform_qos (basesink, late);
3104 GST_DEBUG_OBJECT (basesink, "object unref after render %p", obj);
3105 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3111 GST_DEBUG_OBJECT (basesink, "do_sync returned %s", gst_flow_get_name (ret));
3117 GST_DEBUG_OBJECT (basesink, "buffer late, dropping");
3119 if (g_atomic_int_get (&priv->qos_enabled)) {
3120 GstMessage *qos_msg;
3121 GstClockTime timestamp, duration;
3123 timestamp = GST_BUFFER_TIMESTAMP (GST_BUFFER_CAST (sync_obj));
3124 duration = GST_BUFFER_DURATION (GST_BUFFER_CAST (sync_obj));
3126 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
3127 "qos: dropped buffer rt %" GST_TIME_FORMAT ", st %" GST_TIME_FORMAT
3128 ", ts %" GST_TIME_FORMAT ", dur %" GST_TIME_FORMAT,
3129 GST_TIME_ARGS (priv->current_rstart),
3130 GST_TIME_ARGS (priv->current_sstart), GST_TIME_ARGS (timestamp),
3131 GST_TIME_ARGS (duration));
3132 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
3133 "qos: rendered %" G_GUINT64_FORMAT ", dropped %" G_GUINT64_FORMAT,
3134 priv->rendered, priv->dropped);
3137 gst_message_new_qos (GST_OBJECT_CAST (basesink), basesink->sync,
3138 priv->current_rstart, priv->current_sstart, timestamp, duration);
3139 gst_message_set_qos_values (qos_msg, priv->current_jitter, priv->avg_rate,
3141 gst_message_set_qos_stats (qos_msg, GST_FORMAT_BUFFERS, priv->rendered,
3143 gst_element_post_message (GST_ELEMENT_CAST (basesink), qos_msg);
3149 GST_DEBUG_OBJECT (basesink, "we are flushing, ignore object");
3150 gst_mini_object_unref (obj);
3151 return GST_FLOW_WRONG_STATE;
3155 /* with STREAM_LOCK, PREROLL_LOCK
3157 * Perform preroll on the given object. For buffers this means
3158 * calling the preroll subclass method.
3159 * If that succeeds, the state will be commited.
3161 * function does not take ownership of obj.
3163 static GstFlowReturn
3164 gst_base_sink_preroll_object (GstBaseSink * basesink, guint8 obj_type,
3165 GstMiniObject * obj)
3169 GST_DEBUG_OBJECT (basesink, "prerolling object %p", obj);
3171 /* if it's a buffer, we need to call the preroll method */
3172 if (G_LIKELY (OBJ_IS_BUFFERFULL (obj_type) && basesink->priv->call_preroll)) {
3173 GstBaseSinkClass *bclass;
3175 GstClockTime timestamp;
3177 if (OBJ_IS_BUFFERLIST (obj_type)) {
3178 buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0, 0);
3179 g_assert (NULL != buf);
3181 buf = GST_BUFFER_CAST (obj);
3184 timestamp = GST_BUFFER_TIMESTAMP (buf);
3186 GST_DEBUG_OBJECT (basesink, "preroll buffer %" GST_TIME_FORMAT,
3187 GST_TIME_ARGS (timestamp));
3190 * For buffer lists do not set last buffer. Creating buffer
3191 * with meaningful data can be done only with memcpy which will
3192 * significantly affect performance
3194 if (!OBJ_IS_BUFFERLIST (obj_type)) {
3195 gst_base_sink_set_last_buffer (basesink, buf);
3198 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3199 if (bclass->preroll)
3200 if ((ret = bclass->preroll (basesink, buf)) != GST_FLOW_OK)
3201 goto preroll_failed;
3203 basesink->priv->call_preroll = FALSE;
3207 if (G_LIKELY (basesink->playing_async)) {
3208 if (G_UNLIKELY (!gst_base_sink_commit_state (basesink)))
3217 GST_DEBUG_OBJECT (basesink, "preroll failed, abort state");
3218 gst_element_abort_state (GST_ELEMENT_CAST (basesink));
3223 GST_DEBUG_OBJECT (basesink, "stopping while commiting state");
3224 return GST_FLOW_WRONG_STATE;
3228 /* with STREAM_LOCK, PREROLL_LOCK
3230 * Queue an object for rendering.
3231 * The first prerollable object queued will complete the preroll. If the
3232 * preroll queue if filled, we render all the objects in the queue.
3234 * This function takes ownership of the object.
3236 static GstFlowReturn
3237 gst_base_sink_queue_object_unlocked (GstBaseSink * basesink, GstPad * pad,
3238 guint8 obj_type, gpointer obj, gboolean prerollable)
3240 GstFlowReturn ret = GST_FLOW_OK;
3244 if (G_UNLIKELY (basesink->need_preroll)) {
3245 if (G_LIKELY (prerollable))
3246 basesink->preroll_queued++;
3248 length = basesink->preroll_queued;
3250 GST_DEBUG_OBJECT (basesink, "now %d prerolled items", length);
3252 /* first prerollable item needs to finish the preroll */
3254 ret = gst_base_sink_preroll_object (basesink, obj_type, obj);
3255 if (G_UNLIKELY (ret != GST_FLOW_OK))
3256 goto preroll_failed;
3258 /* need to recheck if we need preroll, commmit state during preroll
3259 * could have made us not need more preroll. */
3260 if (G_UNLIKELY (basesink->need_preroll)) {
3261 /* see if we can render now, if we can't add the object to the preroll
3263 if (G_UNLIKELY (length <= basesink->preroll_queue_max_len))
3267 /* we can start rendering (or blocking) the queued object
3269 q = basesink->preroll_queue;
3270 while (G_UNLIKELY (!g_queue_is_empty (q))) {
3274 o = g_queue_pop_head (q);
3275 GST_DEBUG_OBJECT (basesink, "rendering queued object %p", o);
3277 ot = get_object_type (o);
3279 /* do something with the return value */
3280 ret = gst_base_sink_render_object (basesink, pad, ot, o);
3281 if (ret != GST_FLOW_OK)
3282 goto dequeue_failed;
3285 /* now render the object */
3286 ret = gst_base_sink_render_object (basesink, pad, obj_type, obj);
3287 basesink->preroll_queued = 0;
3294 GST_DEBUG_OBJECT (basesink, "preroll failed, reason %s",
3295 gst_flow_get_name (ret));
3296 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3301 /* add object to the queue and return */
3302 GST_DEBUG_OBJECT (basesink, "need more preroll data %d <= %d",
3303 length, basesink->preroll_queue_max_len);
3304 g_queue_push_tail (basesink->preroll_queue, obj);
3309 GST_DEBUG_OBJECT (basesink, "rendering queued objects failed, reason %s",
3310 gst_flow_get_name (ret));
3311 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3318 * This function grabs the PREROLL_LOCK and adds the object to
3321 * This function takes ownership of obj.
3323 * Note: Only GstEvent seem to be passed to this private method
3325 static GstFlowReturn
3326 gst_base_sink_queue_object (GstBaseSink * basesink, GstPad * pad,
3327 GstMiniObject * obj, gboolean prerollable)
3331 GST_PAD_PREROLL_LOCK (pad);
3332 if (G_UNLIKELY (basesink->flushing))
3335 if (G_UNLIKELY (basesink->priv->received_eos))
3339 gst_base_sink_queue_object_unlocked (basesink, pad, _PR_IS_EVENT, obj,
3341 GST_PAD_PREROLL_UNLOCK (pad);
3348 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3349 GST_PAD_PREROLL_UNLOCK (pad);
3350 gst_mini_object_unref (obj);
3351 return GST_FLOW_WRONG_STATE;
3355 GST_DEBUG_OBJECT (basesink,
3356 "we are EOS, dropping object, return UNEXPECTED");
3357 GST_PAD_PREROLL_UNLOCK (pad);
3358 gst_mini_object_unref (obj);
3359 return GST_FLOW_UNEXPECTED;
3364 gst_base_sink_flush_start (GstBaseSink * basesink, GstPad * pad)
3366 /* make sure we are not blocked on the clock also clear any pending
3368 gst_base_sink_set_flushing (basesink, pad, TRUE);
3370 /* we grab the stream lock but that is not needed since setting the
3371 * sink to flushing would make sure no state commit is being done
3373 GST_PAD_STREAM_LOCK (pad);
3374 gst_base_sink_reset_qos (basesink);
3375 /* and we need to commit our state again on the next
3376 * prerolled buffer */
3377 basesink->playing_async = TRUE;
3378 if (basesink->priv->async_enabled) {
3379 gst_element_lost_state (GST_ELEMENT_CAST (basesink));
3381 basesink->priv->have_latency = TRUE;
3383 gst_base_sink_set_last_buffer (basesink, NULL);
3384 GST_PAD_STREAM_UNLOCK (pad);
3388 gst_base_sink_flush_stop (GstBaseSink * basesink, GstPad * pad)
3390 /* unset flushing so we can accept new data, this also flushes out any EOS
3392 gst_base_sink_set_flushing (basesink, pad, FALSE);
3394 /* for position reporting */
3395 GST_OBJECT_LOCK (basesink);
3396 basesink->priv->current_sstart = GST_CLOCK_TIME_NONE;
3397 basesink->priv->current_sstop = GST_CLOCK_TIME_NONE;
3398 basesink->priv->eos_rtime = GST_CLOCK_TIME_NONE;
3399 basesink->priv->call_preroll = TRUE;
3400 basesink->priv->current_step.valid = FALSE;
3401 basesink->priv->pending_step.valid = FALSE;
3402 if (basesink->pad_mode == GST_ACTIVATE_PUSH) {
3403 /* we need new segment info after the flush. */
3404 basesink->have_newsegment = FALSE;
3405 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
3406 gst_segment_init (basesink->abidata.ABI.clip_segment, GST_FORMAT_UNDEFINED);
3408 GST_OBJECT_UNLOCK (basesink);
3412 gst_base_sink_event (GstPad * pad, GstEvent * event)
3414 GstBaseSink *basesink;
3415 gboolean result = TRUE;
3416 GstBaseSinkClass *bclass;
3418 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3419 if (G_UNLIKELY (basesink == NULL)) {
3420 gst_event_unref (event);
3424 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3426 GST_DEBUG_OBJECT (basesink, "received event %p %" GST_PTR_FORMAT, event,
3429 switch (GST_EVENT_TYPE (event)) {
3434 GST_PAD_PREROLL_LOCK (pad);
3435 if (G_UNLIKELY (basesink->flushing))
3438 if (G_UNLIKELY (basesink->priv->received_eos)) {
3439 /* we can't accept anything when we are EOS */
3441 gst_event_unref (event);
3443 /* we set the received EOS flag here so that we can use it when testing if
3444 * we are prerolled and to refuse more buffers. */
3445 basesink->priv->received_eos = TRUE;
3447 /* EOS is a prerollable object, we call the unlocked version because it
3448 * does not check the received_eos flag. */
3449 ret = gst_base_sink_queue_object_unlocked (basesink, pad,
3450 _PR_IS_EVENT, GST_MINI_OBJECT_CAST (event), TRUE);
3451 if (G_UNLIKELY (ret != GST_FLOW_OK))
3454 GST_PAD_PREROLL_UNLOCK (pad);
3457 case GST_EVENT_NEWSEGMENT:
3462 GST_DEBUG_OBJECT (basesink, "newsegment %p", event);
3464 GST_PAD_PREROLL_LOCK (pad);
3465 if (G_UNLIKELY (basesink->flushing))
3468 gst_event_parse_new_segment_full (event, &update, NULL, NULL, NULL, NULL,
3471 if (G_UNLIKELY (basesink->priv->received_eos && !update)) {
3472 /* we can't accept anything when we are EOS */
3474 gst_event_unref (event);
3476 /* the new segment is a non prerollable item and does not block anything,
3477 * we need to configure the current clipping segment and insert the event
3478 * in the queue to serialize it with the buffers for rendering. */
3479 gst_base_sink_configure_segment (basesink, pad, event,
3480 basesink->abidata.ABI.clip_segment);
3483 gst_base_sink_queue_object_unlocked (basesink, pad,
3484 _PR_IS_EVENT, GST_MINI_OBJECT_CAST (event), FALSE);
3485 if (G_UNLIKELY (ret != GST_FLOW_OK))
3488 GST_OBJECT_LOCK (basesink);
3489 basesink->have_newsegment = TRUE;
3490 GST_OBJECT_UNLOCK (basesink);
3493 GST_PAD_PREROLL_UNLOCK (pad);
3496 case GST_EVENT_FLUSH_START:
3498 bclass->event (basesink, event);
3500 GST_DEBUG_OBJECT (basesink, "flush-start %p", event);
3502 gst_base_sink_flush_start (basesink, pad);
3504 gst_event_unref (event);
3506 case GST_EVENT_FLUSH_STOP:
3508 bclass->event (basesink, event);
3510 GST_DEBUG_OBJECT (basesink, "flush-stop %p", event);
3512 gst_base_sink_flush_stop (basesink, pad);
3514 gst_event_unref (event);
3517 /* other events are sent to queue or subclass depending on if they
3518 * are serialized. */
3519 if (GST_EVENT_IS_SERIALIZED (event)) {
3520 gst_base_sink_queue_object (basesink, pad,
3521 GST_MINI_OBJECT_CAST (event), FALSE);
3524 bclass->event (basesink, event);
3525 gst_event_unref (event);
3530 gst_object_unref (basesink);
3537 GST_DEBUG_OBJECT (basesink, "we are flushing");
3538 GST_PAD_PREROLL_UNLOCK (pad);
3540 gst_event_unref (event);
3545 /* default implementation to calculate the start and end
3546 * timestamps on a buffer, subclasses can override
3549 gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
3550 GstClockTime * start, GstClockTime * end)
3552 GstClockTime timestamp, duration;
3554 timestamp = GST_BUFFER_TIMESTAMP (buffer);
3555 if (GST_CLOCK_TIME_IS_VALID (timestamp)) {
3557 /* get duration to calculate end time */
3558 duration = GST_BUFFER_DURATION (buffer);
3559 if (GST_CLOCK_TIME_IS_VALID (duration)) {
3560 *end = timestamp + duration;
3566 /* must be called with PREROLL_LOCK */
3568 gst_base_sink_needs_preroll (GstBaseSink * basesink)
3570 gboolean is_prerolled, res;
3572 /* we have 2 cases where the PREROLL_LOCK is released:
3573 * 1) we are blocking in the PREROLL_LOCK and thus are prerolled.
3574 * 2) we are syncing on the clock
3576 is_prerolled = basesink->have_preroll || basesink->priv->received_eos;
3577 res = !is_prerolled;
3579 GST_DEBUG_OBJECT (basesink, "have_preroll: %d, EOS: %d => needs preroll: %d",
3580 basesink->have_preroll, basesink->priv->received_eos, res);
3585 /* with STREAM_LOCK, PREROLL_LOCK
3587 * Takes a buffer and compare the timestamps with the last segment.
3588 * If the buffer falls outside of the segment boundaries, drop it.
3589 * Else queue the buffer for preroll and rendering.
3591 * This function takes ownership of the buffer.
3593 static GstFlowReturn
3594 gst_base_sink_chain_unlocked (GstBaseSink * basesink, GstPad * pad,
3595 guint8 obj_type, gpointer obj)
3597 GstBaseSinkClass *bclass;
3598 GstFlowReturn result;
3599 GstClockTime start = GST_CLOCK_TIME_NONE, end = GST_CLOCK_TIME_NONE;
3600 GstSegment *clip_segment;
3601 GstBuffer *time_buf;
3603 if (G_UNLIKELY (basesink->flushing))
3606 if (G_UNLIKELY (basesink->priv->received_eos))
3609 if (OBJ_IS_BUFFERLIST (obj_type)) {
3610 time_buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0, 0);
3611 g_assert (NULL != time_buf);
3613 time_buf = GST_BUFFER_CAST (obj);
3616 /* for code clarity */
3617 clip_segment = basesink->abidata.ABI.clip_segment;
3619 if (G_UNLIKELY (!basesink->have_newsegment)) {
3622 sync = gst_base_sink_get_sync (basesink);
3624 GST_ELEMENT_WARNING (basesink, STREAM, FAILED,
3625 (_("Internal data flow problem.")),
3626 ("Received buffer without a new-segment. Assuming timestamps start from 0."));
3629 /* this means this sink will assume timestamps start from 0 */
3630 GST_OBJECT_LOCK (basesink);
3631 clip_segment->start = 0;
3632 clip_segment->stop = -1;
3633 basesink->segment.start = 0;
3634 basesink->segment.stop = -1;
3635 basesink->have_newsegment = TRUE;
3636 GST_OBJECT_UNLOCK (basesink);
3639 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3641 /* check if the buffer needs to be dropped, we first ask the subclass for the
3643 if (bclass->get_times)
3644 bclass->get_times (basesink, time_buf, &start, &end);
3646 if (!GST_CLOCK_TIME_IS_VALID (start)) {
3647 /* if the subclass does not want sync, we use our own values so that we at
3648 * least clip the buffer to the segment */
3649 gst_base_sink_get_times (basesink, time_buf, &start, &end);
3652 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
3653 ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (end));
3655 /* a dropped buffer does not participate in anything */
3656 if (GST_CLOCK_TIME_IS_VALID (start) &&
3657 (clip_segment->format == GST_FORMAT_TIME)) {
3658 if (G_UNLIKELY (!gst_segment_clip (clip_segment,
3659 GST_FORMAT_TIME, (gint64) start, (gint64) end, NULL, NULL)))
3660 goto out_of_segment;
3663 /* now we can process the buffer in the queue, this function takes ownership
3665 result = gst_base_sink_queue_object_unlocked (basesink, pad,
3666 obj_type, obj, TRUE);
3672 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3673 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3674 return GST_FLOW_WRONG_STATE;
3678 GST_DEBUG_OBJECT (basesink,
3679 "we are EOS, dropping object, return UNEXPECTED");
3680 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3681 return GST_FLOW_UNEXPECTED;
3685 GST_DEBUG_OBJECT (basesink, "dropping buffer, out of clipping segment");
3686 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3693 static GstFlowReturn
3694 gst_base_sink_chain_main (GstBaseSink * basesink, GstPad * pad,
3695 guint8 obj_type, gpointer obj)
3697 GstFlowReturn result;
3699 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH))
3702 GST_PAD_PREROLL_LOCK (pad);
3703 result = gst_base_sink_chain_unlocked (basesink, pad, obj_type, obj);
3704 GST_PAD_PREROLL_UNLOCK (pad);
3712 GST_OBJECT_LOCK (pad);
3713 GST_WARNING_OBJECT (basesink,
3714 "Push on pad %s:%s, but it was not activated in push mode",
3715 GST_DEBUG_PAD_NAME (pad));
3716 GST_OBJECT_UNLOCK (pad);
3717 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3718 /* we don't post an error message this will signal to the peer
3719 * pushing that EOS is reached. */
3720 result = GST_FLOW_UNEXPECTED;
3725 static GstFlowReturn
3726 gst_base_sink_chain (GstPad * pad, GstBuffer * buf)
3728 GstBaseSink *basesink;
3730 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3732 return gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFER, buf);
3735 static GstFlowReturn
3736 gst_base_sink_chain_list (GstPad * pad, GstBufferList * list)
3738 GstBaseSink *basesink;
3739 GstBaseSinkClass *bclass;
3740 GstFlowReturn result;
3742 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3743 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3745 if (G_LIKELY (bclass->render_list)) {
3746 result = gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFERLIST, list);
3748 GstBufferListIterator *it;
3751 GST_INFO_OBJECT (pad, "chaining each group in list as a merged buffer");
3753 it = gst_buffer_list_iterate (list);
3755 if (gst_buffer_list_iterator_next_group (it)) {
3757 group = gst_buffer_list_iterator_merge_group (it);
3758 if (group == NULL) {
3759 group = gst_buffer_new ();
3760 GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining empty group");
3762 GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining group");
3764 result = gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFER, group);
3765 } while (result == GST_FLOW_OK
3766 && gst_buffer_list_iterator_next_group (it));
3768 GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining empty group");
3770 gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFER,
3773 gst_buffer_list_iterator_free (it);
3774 gst_buffer_list_unref (list);
3781 gst_base_sink_default_do_seek (GstBaseSink * sink, GstSegment * segment)
3783 gboolean res = TRUE;
3785 /* update our offset if the start/stop position was updated */
3786 if (segment->format == GST_FORMAT_BYTES) {
3787 segment->time = segment->start;
3788 } else if (segment->start == 0) {
3789 /* seek to start, we can implement a default for this. */
3793 GST_INFO_OBJECT (sink, "Can't do a default seek");
3799 #define SEEK_TYPE_IS_RELATIVE(t) (((t) != GST_SEEK_TYPE_NONE) && ((t) != GST_SEEK_TYPE_SET))
3802 gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
3803 GstEvent * event, GstSegment * segment)
3805 /* By default, we try one of 2 things:
3806 * - For absolute seek positions, convert the requested position to our
3807 * configured processing format and place it in the output segment \
3808 * - For relative seek positions, convert our current (input) values to the
3809 * seek format, adjust by the relative seek offset and then convert back to
3810 * the processing format
3812 GstSeekType cur_type, stop_type;
3815 GstFormat seek_format, dest_format;
3818 gboolean res = TRUE;
3820 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3821 &cur_type, &cur, &stop_type, &stop);
3822 dest_format = segment->format;
3824 if (seek_format == dest_format) {
3825 gst_segment_set_seek (segment, rate, seek_format, flags,
3826 cur_type, cur, stop_type, stop, &update);
3830 if (cur_type != GST_SEEK_TYPE_NONE) {
3831 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3833 gst_pad_query_convert (sink->sinkpad, seek_format, cur, &dest_format,
3835 cur_type = GST_SEEK_TYPE_SET;
3838 if (res && stop_type != GST_SEEK_TYPE_NONE) {
3839 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3841 gst_pad_query_convert (sink->sinkpad, seek_format, stop, &dest_format,
3843 stop_type = GST_SEEK_TYPE_SET;
3846 /* And finally, configure our output segment in the desired format */
3847 gst_segment_set_seek (segment, rate, dest_format, flags, cur_type, cur,
3848 stop_type, stop, &update);
3857 GST_DEBUG_OBJECT (sink, "undefined format given, seek aborted.");
3862 /* perform a seek, only executed in pull mode */
3864 gst_base_sink_perform_seek (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3868 GstFormat seek_format, dest_format;
3870 GstSeekType cur_type, stop_type;
3871 gboolean seekseg_configured = FALSE;
3873 gboolean update, res = TRUE;
3874 GstSegment seeksegment;
3876 dest_format = sink->segment.format;
3879 GST_DEBUG_OBJECT (sink, "performing seek with event %p", event);
3880 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3881 &cur_type, &cur, &stop_type, &stop);
3883 flush = flags & GST_SEEK_FLAG_FLUSH;
3885 GST_DEBUG_OBJECT (sink, "performing seek without event");
3890 GST_DEBUG_OBJECT (sink, "flushing upstream");
3891 gst_pad_push_event (pad, gst_event_new_flush_start ());
3892 gst_base_sink_flush_start (sink, pad);
3894 GST_DEBUG_OBJECT (sink, "pausing pulling thread");
3897 GST_PAD_STREAM_LOCK (pad);
3899 /* If we configured the seeksegment above, don't overwrite it now. Otherwise
3900 * copy the current segment info into the temp segment that we can actually
3901 * attempt the seek with. We only update the real segment if the seek suceeds. */
3902 if (!seekseg_configured) {
3903 memcpy (&seeksegment, &sink->segment, sizeof (GstSegment));
3905 /* now configure the final seek segment */
3907 if (sink->segment.format != seek_format) {
3908 /* OK, here's where we give the subclass a chance to convert the relative
3909 * seek into an absolute one in the processing format. We set up any
3910 * absolute seek above, before taking the stream lock. */
3911 if (!gst_base_sink_default_prepare_seek_segment (sink, event,
3913 GST_DEBUG_OBJECT (sink,
3914 "Preparing the seek failed after flushing. " "Aborting seek");
3918 /* The seek format matches our processing format, no need to ask the
3919 * the subclass to configure the segment. */
3920 gst_segment_set_seek (&seeksegment, rate, seek_format, flags,
3921 cur_type, cur, stop_type, stop, &update);
3924 /* Else, no seek event passed, so we're just (re)starting the
3929 GST_DEBUG_OBJECT (sink, "segment configured from %" G_GINT64_FORMAT
3930 " to %" G_GINT64_FORMAT ", position %" G_GINT64_FORMAT,
3931 seeksegment.start, seeksegment.stop, seeksegment.last_stop);
3933 /* do the seek, segment.last_stop contains the new position. */
3934 res = gst_base_sink_default_do_seek (sink, &seeksegment);
3939 GST_DEBUG_OBJECT (sink, "stop flushing upstream");
3940 gst_pad_push_event (pad, gst_event_new_flush_stop ());
3941 gst_base_sink_flush_stop (sink, pad);
3942 } else if (res && sink->abidata.ABI.running) {
3943 /* we are running the current segment and doing a non-flushing seek,
3944 * close the segment first based on the last_stop. */
3945 GST_DEBUG_OBJECT (sink, "closing running segment %" G_GINT64_FORMAT
3946 " to %" G_GINT64_FORMAT, sink->segment.start, sink->segment.last_stop);
3949 /* The subclass must have converted the segment to the processing format
3951 if (res && seeksegment.format != dest_format) {
3952 GST_DEBUG_OBJECT (sink, "Subclass failed to prepare a seek segment "
3953 "in the correct format. Aborting seek.");
3957 /* if successfull seek, we update our real segment and push
3958 * out the new segment. */
3960 memcpy (&sink->segment, &seeksegment, sizeof (GstSegment));
3962 if (sink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3963 gst_element_post_message (GST_ELEMENT (sink),
3964 gst_message_new_segment_start (GST_OBJECT (sink),
3965 sink->segment.format, sink->segment.last_stop));
3969 sink->priv->discont = TRUE;
3970 sink->abidata.ABI.running = TRUE;
3972 GST_PAD_STREAM_UNLOCK (pad);
3978 set_step_info (GstBaseSink * sink, GstStepInfo * current, GstStepInfo * pending,
3979 guint seqnum, GstFormat format, guint64 amount, gdouble rate,
3980 gboolean flush, gboolean intermediate)
3982 GST_OBJECT_LOCK (sink);
3983 pending->seqnum = seqnum;
3984 pending->format = format;
3985 pending->amount = amount;
3986 pending->position = 0;
3987 pending->rate = rate;
3988 pending->flush = flush;
3989 pending->intermediate = intermediate;
3990 pending->valid = TRUE;
3991 /* flush invalidates the current stepping segment */
3993 current->valid = FALSE;
3994 GST_OBJECT_UNLOCK (sink);
3998 gst_base_sink_perform_step (GstBaseSink * sink, GstPad * pad, GstEvent * event)
4000 GstBaseSinkPrivate *priv;
4001 GstBaseSinkClass *bclass;
4002 gboolean flush, intermediate;
4007 GstStepInfo *pending, *current;
4008 GstMessage *message;
4010 bclass = GST_BASE_SINK_GET_CLASS (sink);
4013 GST_DEBUG_OBJECT (sink, "performing step with event %p", event);
4015 gst_event_parse_step (event, &format, &amount, &rate, &flush, &intermediate);
4016 seqnum = gst_event_get_seqnum (event);
4018 pending = &priv->pending_step;
4019 current = &priv->current_step;
4021 /* post message first */
4022 message = gst_message_new_step_start (GST_OBJECT (sink), FALSE, format,
4023 amount, rate, flush, intermediate);
4024 gst_message_set_seqnum (message, seqnum);
4025 gst_element_post_message (GST_ELEMENT (sink), message);
4028 /* we need to call ::unlock before locking PREROLL_LOCK
4029 * since we lock it before going into ::render */
4031 bclass->unlock (sink);
4033 GST_PAD_PREROLL_LOCK (sink->sinkpad);
4034 /* now that we have the PREROLL lock, clear our unlock request */
4035 if (bclass->unlock_stop)
4036 bclass->unlock_stop (sink);
4038 /* update the stepinfo and make it valid */
4039 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
4042 if (sink->priv->async_enabled) {
4043 /* and we need to commit our state again on the next
4044 * prerolled buffer */
4045 sink->playing_async = TRUE;
4046 priv->pending_step.need_preroll = TRUE;
4047 sink->need_preroll = FALSE;
4048 gst_element_lost_state_full (GST_ELEMENT_CAST (sink), FALSE);
4050 sink->priv->have_latency = TRUE;
4051 sink->need_preroll = FALSE;
4053 priv->current_sstart = GST_CLOCK_TIME_NONE;
4054 priv->current_sstop = GST_CLOCK_TIME_NONE;
4055 priv->eos_rtime = GST_CLOCK_TIME_NONE;
4056 priv->call_preroll = TRUE;
4057 gst_base_sink_set_last_buffer (sink, NULL);
4058 gst_base_sink_reset_qos (sink);
4060 if (sink->clock_id) {
4061 gst_clock_id_unschedule (sink->clock_id);
4064 if (sink->have_preroll) {
4065 GST_DEBUG_OBJECT (sink, "signal waiter");
4066 priv->step_unlock = TRUE;
4067 GST_PAD_PREROLL_SIGNAL (sink->sinkpad);
4069 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
4071 /* update the stepinfo and make it valid */
4072 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
4082 gst_base_sink_loop (GstPad * pad)
4084 GstBaseSink *basesink;
4085 GstBuffer *buf = NULL;
4086 GstFlowReturn result;
4090 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
4092 g_assert (basesink->pad_mode == GST_ACTIVATE_PULL);
4094 if ((blocksize = basesink->priv->blocksize) == 0)
4097 offset = basesink->segment.last_stop;
4099 GST_DEBUG_OBJECT (basesink, "pulling %" G_GUINT64_FORMAT ", %u",
4102 result = gst_pad_pull_range (pad, offset, blocksize, &buf);
4103 if (G_UNLIKELY (result != GST_FLOW_OK))
4106 if (G_UNLIKELY (buf == NULL))
4109 offset += GST_BUFFER_SIZE (buf);
4111 gst_segment_set_last_stop (&basesink->segment, GST_FORMAT_BYTES, offset);
4113 GST_PAD_PREROLL_LOCK (pad);
4114 result = gst_base_sink_chain_unlocked (basesink, pad, _PR_IS_BUFFER, buf);
4115 GST_PAD_PREROLL_UNLOCK (pad);
4116 if (G_UNLIKELY (result != GST_FLOW_OK))
4124 GST_LOG_OBJECT (basesink, "pausing task, reason %s",
4125 gst_flow_get_name (result));
4126 gst_pad_pause_task (pad);
4127 if (result == GST_FLOW_UNEXPECTED) {
4128 /* perform EOS logic */
4129 if (basesink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
4130 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4131 gst_message_new_segment_done (GST_OBJECT_CAST (basesink),
4132 basesink->segment.format, basesink->segment.last_stop));
4134 gst_base_sink_event (pad, gst_event_new_eos ());
4136 } else if (result == GST_FLOW_NOT_LINKED || result <= GST_FLOW_UNEXPECTED) {
4137 /* for fatal errors we post an error message, post the error
4138 * first so the app knows about the error first.
4139 * wrong-state is not a fatal error because it happens due to
4140 * flushing and posting an error message in that case is the
4141 * wrong thing to do, e.g. when basesrc is doing a flushing
4143 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
4144 (_("Internal data stream error.")),
4145 ("stream stopped, reason %s", gst_flow_get_name (result)));
4146 gst_base_sink_event (pad, gst_event_new_eos ());
4152 GST_LOG_OBJECT (basesink, "no buffer, pausing");
4153 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
4154 (_("Internal data flow error.")), ("element returned NULL buffer"));
4155 result = GST_FLOW_ERROR;
4161 gst_base_sink_set_flushing (GstBaseSink * basesink, GstPad * pad,
4164 GstBaseSinkClass *bclass;
4166 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4169 /* unlock any subclasses, we need to do this before grabbing the
4170 * PREROLL_LOCK since we hold this lock before going into ::render. */
4172 bclass->unlock (basesink);
4175 GST_PAD_PREROLL_LOCK (pad);
4176 basesink->flushing = flushing;
4178 /* step 1, now that we have the PREROLL lock, clear our unlock request */
4179 if (bclass->unlock_stop)
4180 bclass->unlock_stop (basesink);
4182 /* set need_preroll before we unblock the clock. If the clock is unblocked
4183 * before timing out, we can reuse the buffer for preroll. */
4184 basesink->need_preroll = TRUE;
4186 /* step 2, unblock clock sync (if any) or any other blocking thing */
4187 if (basesink->clock_id) {
4188 gst_clock_id_unschedule (basesink->clock_id);
4191 /* flush out the data thread if it's locked in finish_preroll, this will
4192 * also flush out the EOS state */
4193 GST_DEBUG_OBJECT (basesink,
4194 "flushing out data thread, need preroll to TRUE");
4195 gst_base_sink_preroll_queue_flush (basesink, pad);
4197 GST_PAD_PREROLL_UNLOCK (pad);
4203 gst_base_sink_default_activate_pull (GstBaseSink * basesink, gboolean active)
4209 result = gst_pad_start_task (basesink->sinkpad,
4210 (GstTaskFunction) gst_base_sink_loop, basesink->sinkpad);
4212 /* step 2, make sure streaming finishes */
4213 result = gst_pad_stop_task (basesink->sinkpad);
4220 gst_base_sink_pad_activate (GstPad * pad)
4222 gboolean result = FALSE;
4223 GstBaseSink *basesink;
4225 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4227 GST_DEBUG_OBJECT (basesink, "Trying pull mode first");
4229 gst_base_sink_set_flushing (basesink, pad, FALSE);
4231 /* we need to have the pull mode enabled */
4232 if (!basesink->can_activate_pull) {
4233 GST_DEBUG_OBJECT (basesink, "pull mode disabled");
4237 /* check if downstreams supports pull mode at all */
4238 if (!gst_pad_check_pull_range (pad)) {
4239 GST_DEBUG_OBJECT (basesink, "pull mode not supported");
4243 /* set the pad mode before starting the task so that it's in the
4244 * correct state for the new thread. also the sink set_caps and get_caps
4245 * function checks this */
4246 basesink->pad_mode = GST_ACTIVATE_PULL;
4248 /* we first try to negotiate a format so that when we try to activate
4249 * downstream, it knows about our format */
4250 if (!gst_base_sink_negotiate_pull (basesink)) {
4251 GST_DEBUG_OBJECT (basesink, "failed to negotiate in pull mode");
4255 /* ok activate now */
4256 if (!gst_pad_activate_pull (pad, TRUE)) {
4257 /* clear any pending caps */
4258 GST_OBJECT_LOCK (basesink);
4259 gst_caps_replace (&basesink->priv->pull_caps, NULL);
4260 GST_OBJECT_UNLOCK (basesink);
4261 GST_DEBUG_OBJECT (basesink, "failed to activate in pull mode");
4265 GST_DEBUG_OBJECT (basesink, "Success activating pull mode");
4269 /* push mode fallback */
4271 GST_DEBUG_OBJECT (basesink, "Falling back to push mode");
4272 if ((result = gst_pad_activate_push (pad, TRUE))) {
4273 GST_DEBUG_OBJECT (basesink, "Success activating push mode");
4278 GST_WARNING_OBJECT (basesink, "Could not activate pad in either mode");
4279 gst_base_sink_set_flushing (basesink, pad, TRUE);
4282 gst_object_unref (basesink);
4288 gst_base_sink_pad_activate_push (GstPad * pad, gboolean active)
4291 GstBaseSink *basesink;
4293 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4296 if (!basesink->can_activate_push) {
4298 basesink->pad_mode = GST_ACTIVATE_NONE;
4301 basesink->pad_mode = GST_ACTIVATE_PUSH;
4304 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH)) {
4305 g_warning ("Internal GStreamer activation error!!!");
4308 gst_base_sink_set_flushing (basesink, pad, TRUE);
4310 basesink->pad_mode = GST_ACTIVATE_NONE;
4314 gst_object_unref (basesink);
4320 gst_base_sink_negotiate_pull (GstBaseSink * basesink)
4327 /* this returns the intersection between our caps and the peer caps. If there
4328 * is no peer, it returns NULL and we can't operate in pull mode so we can
4329 * fail the negotiation. */
4330 caps = gst_pad_get_allowed_caps (GST_BASE_SINK_PAD (basesink));
4331 if (caps == NULL || gst_caps_is_empty (caps))
4332 goto no_caps_possible;
4334 GST_DEBUG_OBJECT (basesink, "allowed caps: %" GST_PTR_FORMAT, caps);
4336 caps = gst_caps_make_writable (caps);
4337 /* get the first (prefered) format */
4338 gst_caps_truncate (caps);
4340 gst_pad_fixate_caps (GST_BASE_SINK_PAD (basesink), caps);
4342 GST_DEBUG_OBJECT (basesink, "fixated to: %" GST_PTR_FORMAT, caps);
4344 if (gst_caps_is_any (caps)) {
4345 GST_DEBUG_OBJECT (basesink, "caps were ANY after fixating, "
4347 /* neither side has template caps in this case, so they are prepared for
4348 pull() without setcaps() */
4350 } else if (gst_caps_is_fixed (caps)) {
4351 if (!gst_pad_set_caps (GST_BASE_SINK_PAD (basesink), caps))
4352 goto could_not_set_caps;
4354 GST_OBJECT_LOCK (basesink);
4355 gst_caps_replace (&basesink->priv->pull_caps, caps);
4356 GST_OBJECT_UNLOCK (basesink);
4361 gst_caps_unref (caps);
4367 GST_INFO_OBJECT (basesink, "Pipeline could not agree on caps");
4368 GST_DEBUG_OBJECT (basesink, "get_allowed_caps() returned EMPTY");
4370 gst_caps_unref (caps);
4375 GST_INFO_OBJECT (basesink, "Could not set caps: %" GST_PTR_FORMAT, caps);
4376 gst_caps_unref (caps);
4381 /* this won't get called until we implement an activate function */
4383 gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active)
4385 gboolean result = FALSE;
4386 GstBaseSink *basesink;
4387 GstBaseSinkClass *bclass;
4389 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4390 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4396 /* we mark we have a newsegment here because pull based
4397 * mode works just fine without having a newsegment before the
4399 format = GST_FORMAT_BYTES;
4401 gst_segment_init (&basesink->segment, format);
4402 gst_segment_init (basesink->abidata.ABI.clip_segment, format);
4403 GST_OBJECT_LOCK (basesink);
4404 basesink->have_newsegment = TRUE;
4405 GST_OBJECT_UNLOCK (basesink);
4407 /* get the peer duration in bytes */
4408 result = gst_pad_query_peer_duration (pad, &format, &duration);
4410 GST_DEBUG_OBJECT (basesink,
4411 "setting duration in bytes to %" G_GINT64_FORMAT, duration);
4412 gst_segment_set_duration (basesink->abidata.ABI.clip_segment, format,
4414 gst_segment_set_duration (&basesink->segment, format, duration);
4416 GST_DEBUG_OBJECT (basesink, "unknown duration");
4419 if (bclass->activate_pull)
4420 result = bclass->activate_pull (basesink, TRUE);
4425 goto activate_failed;
4428 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PULL)) {
4429 g_warning ("Internal GStreamer activation error!!!");
4432 result = gst_base_sink_set_flushing (basesink, pad, TRUE);
4433 if (bclass->activate_pull)
4434 result &= bclass->activate_pull (basesink, FALSE);
4435 basesink->pad_mode = GST_ACTIVATE_NONE;
4436 /* clear any pending caps */
4437 GST_OBJECT_LOCK (basesink);
4438 gst_caps_replace (&basesink->priv->pull_caps, NULL);
4439 GST_OBJECT_UNLOCK (basesink);
4442 gst_object_unref (basesink);
4449 /* reset, as starting the thread failed */
4450 basesink->pad_mode = GST_ACTIVATE_NONE;
4452 GST_ERROR_OBJECT (basesink, "subclass failed to activate in pull mode");
4457 /* send an event to our sinkpad peer. */
4459 gst_base_sink_send_event (GstElement * element, GstEvent * event)
4462 GstBaseSink *basesink = GST_BASE_SINK (element);
4463 gboolean forward, result = TRUE;
4464 GstActivateMode mode;
4466 GST_OBJECT_LOCK (element);
4467 /* get the pad and the scheduling mode */
4468 pad = gst_object_ref (basesink->sinkpad);
4469 mode = basesink->pad_mode;
4470 GST_OBJECT_UNLOCK (element);
4472 /* only push UPSTREAM events upstream */
4473 forward = GST_EVENT_IS_UPSTREAM (event);
4475 GST_DEBUG_OBJECT (basesink, "handling event %p %" GST_PTR_FORMAT, event,
4478 switch (GST_EVENT_TYPE (event)) {
4479 case GST_EVENT_LATENCY:
4481 GstClockTime latency;
4483 gst_event_parse_latency (event, &latency);
4485 /* store the latency. We use this to adjust the running_time before syncing
4486 * it to the clock. */
4487 GST_OBJECT_LOCK (element);
4488 basesink->priv->latency = latency;
4489 if (!basesink->priv->have_latency)
4491 GST_OBJECT_UNLOCK (element);
4492 GST_DEBUG_OBJECT (basesink, "latency set to %" GST_TIME_FORMAT,
4493 GST_TIME_ARGS (latency));
4495 /* We forward this event so that all elements know about the global pipeline
4496 * latency. This is interesting for an element when it wants to figure out
4497 * when a particular piece of data will be rendered. */
4500 case GST_EVENT_SEEK:
4501 /* in pull mode we will execute the seek */
4502 if (mode == GST_ACTIVATE_PULL)
4503 result = gst_base_sink_perform_seek (basesink, pad, event);
4505 case GST_EVENT_STEP:
4506 result = gst_base_sink_perform_step (basesink, pad, event);
4514 result = gst_pad_push_event (pad, event);
4516 /* not forwarded, unref the event */
4517 gst_event_unref (event);
4520 gst_object_unref (pad);
4525 gst_base_sink_get_position (GstBaseSink * basesink, GstFormat format,
4526 gint64 * cur, gboolean * upstream)
4528 GstClock *clock = NULL;
4529 gboolean res = FALSE;
4530 GstFormat oformat, tformat;
4531 GstSegment *segment;
4532 GstClockTime now, latency;
4533 GstClockTimeDiff base;
4534 gint64 time, accum, duration;
4537 gboolean last_seen, with_clock, in_paused;
4539 GST_OBJECT_LOCK (basesink);
4540 /* we can only get the segment when we are not NULL or READY */
4541 if (!basesink->have_newsegment)
4545 /* when not in PLAYING or when we're busy with a state change, we
4546 * cannot read from the clock so we report time based on the
4547 * last seen timestamp. */
4548 if (GST_STATE (basesink) != GST_STATE_PLAYING ||
4549 GST_STATE_PENDING (basesink) != GST_STATE_VOID_PENDING) {
4553 /* we don't use the clip segment in pull mode, when seeking we update the
4554 * main segment directly with the new segment values without it having to be
4555 * activated by the rendering after preroll */
4556 if (basesink->pad_mode == GST_ACTIVATE_PUSH)
4557 segment = basesink->abidata.ABI.clip_segment;
4559 segment = &basesink->segment;
4561 /* our intermediate time format */
4562 tformat = GST_FORMAT_TIME;
4563 /* get the format in the segment */
4564 oformat = segment->format;
4566 /* report with last seen position when EOS */
4567 last_seen = basesink->eos;
4569 /* assume we will use the clock for getting the current position */
4571 if (basesink->sync == FALSE)
4574 /* and we need a clock */
4575 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (basesink)) == NULL))
4578 gst_object_ref (clock);
4580 /* collect all data we need holding the lock */
4581 if (GST_CLOCK_TIME_IS_VALID (segment->time))
4582 time = segment->time;
4586 if (GST_CLOCK_TIME_IS_VALID (segment->stop))
4587 duration = segment->stop - segment->start;
4591 accum = segment->accum;
4592 rate = segment->rate * segment->applied_rate;
4593 latency = basesink->priv->latency;
4595 if (oformat == GST_FORMAT_TIME) {
4598 start = basesink->priv->current_sstart;
4599 stop = basesink->priv->current_sstop;
4602 /* in paused we use the last position as a lower bound */
4603 if (stop == -1 || segment->rate > 0.0)
4608 /* in playing, use last stop time as upper bound */
4609 if (start == -1 || segment->rate > 0.0)
4615 /* convert last stop to stream time */
4616 last = gst_segment_to_stream_time (segment, oformat, segment->last_stop);
4620 /* in paused, use start_time */
4621 base = GST_ELEMENT_START_TIME (basesink);
4622 GST_DEBUG_OBJECT (basesink, "in paused, using start time %" GST_TIME_FORMAT,
4623 GST_TIME_ARGS (base));
4624 } else if (with_clock) {
4625 /* else use clock when needed */
4626 base = GST_ELEMENT_CAST (basesink)->base_time;
4627 GST_DEBUG_OBJECT (basesink, "using clock and base time %" GST_TIME_FORMAT,
4628 GST_TIME_ARGS (base));
4630 /* else, no sync or clock -> no base time */
4631 GST_DEBUG_OBJECT (basesink, "no sync or no clock");
4635 /* no base, we can't calculate running_time, use last seem timestamp to report
4640 /* need to release the object lock before we can get the time,
4641 * a clock might take the LOCK of the provider, which could be
4642 * a basesink subclass. */
4643 GST_OBJECT_UNLOCK (basesink);
4646 /* in EOS or when no valid stream_time, report the value of last seen
4649 /* no timestamp, we need to ask upstream */
4650 GST_DEBUG_OBJECT (basesink, "no last seen timestamp, asking upstream");
4655 GST_DEBUG_OBJECT (basesink, "using last seen timestamp %" GST_TIME_FORMAT,
4656 GST_TIME_ARGS (last));
4659 if (oformat != tformat) {
4660 /* convert accum, time and duration to time */
4661 if (!gst_pad_query_convert (basesink->sinkpad, oformat, accum, &tformat,
4663 goto convert_failed;
4664 if (!gst_pad_query_convert (basesink->sinkpad, oformat, duration,
4665 &tformat, &duration))
4666 goto convert_failed;
4667 if (!gst_pad_query_convert (basesink->sinkpad, oformat, time, &tformat,
4669 goto convert_failed;
4670 if (!gst_pad_query_convert (basesink->sinkpad, oformat, last, &tformat,
4672 goto convert_failed;
4674 /* assume time format from now on */
4678 if (!in_paused && with_clock) {
4679 now = gst_clock_get_time (clock);
4685 /* subtract base time and accumulated time from the clock time.
4686 * Make sure we don't go negative. This is the current time in
4687 * the segment which we need to scale with the combined
4688 * rate and applied rate. */
4691 if (GST_CLOCK_DIFF (base, now) < 0)
4694 /* for negative rates we need to count back from the segment
4699 *cur = time + gst_guint64_to_gdouble (now - base) * rate;
4702 /* never report less than segment values in paused */
4704 *cur = MAX (last, *cur);
4706 /* never report more than last seen position in playing */
4708 *cur = MIN (last, *cur);
4711 GST_DEBUG_OBJECT (basesink,
4712 "now %" GST_TIME_FORMAT " - base %" GST_TIME_FORMAT " - accum %"
4713 GST_TIME_FORMAT " + time %" GST_TIME_FORMAT " last %" GST_TIME_FORMAT,
4714 GST_TIME_ARGS (now), GST_TIME_ARGS (base), GST_TIME_ARGS (accum),
4715 GST_TIME_ARGS (time), GST_TIME_ARGS (last));
4718 if (oformat != format) {
4719 /* convert to final format */
4720 if (!gst_pad_query_convert (basesink->sinkpad, oformat, *cur, &format, cur))
4721 goto convert_failed;
4727 GST_DEBUG_OBJECT (basesink, "res: %d, POSITION: %" GST_TIME_FORMAT,
4728 res, GST_TIME_ARGS (*cur));
4731 gst_object_unref (clock);
4738 /* in NULL or READY we always return FALSE and -1 */
4739 GST_DEBUG_OBJECT (basesink, "position in wrong state, return -1");
4742 GST_OBJECT_UNLOCK (basesink);
4747 GST_DEBUG_OBJECT (basesink, "convert failed, try upstream");
4755 gst_base_sink_get_duration (GstBaseSink * basesink, GstFormat format,
4756 gint64 * dur, gboolean * upstream)
4758 gboolean res = FALSE;
4760 if (basesink->pad_mode == GST_ACTIVATE_PULL) {
4761 GstFormat uformat = GST_FORMAT_BYTES;
4764 /* get the duration in bytes, in pull mode that's all we are sure to
4765 * know. We have to explicitly get this value from upstream instead of
4766 * using our cached value because it might change. Duration caching
4767 * should be done at a higher level. */
4768 res = gst_pad_query_peer_duration (basesink->sinkpad, &uformat, &uduration);
4770 gst_segment_set_duration (&basesink->segment, uformat, uduration);
4771 if (format != uformat) {
4772 /* convert to the requested format */
4773 res = gst_pad_query_convert (basesink->sinkpad, uformat, uduration,
4787 static const GstQueryType *
4788 gst_base_sink_get_query_types (GstElement * element)
4790 static const GstQueryType query_types[] = {
4802 gst_base_sink_query (GstElement * element, GstQuery * query)
4804 gboolean res = FALSE;
4806 GstBaseSink *basesink = GST_BASE_SINK (element);
4808 switch (GST_QUERY_TYPE (query)) {
4809 case GST_QUERY_POSITION:
4813 gboolean upstream = FALSE;
4815 gst_query_parse_position (query, &format, NULL);
4817 GST_DEBUG_OBJECT (basesink, "position query in format %s",
4818 gst_format_get_name (format));
4820 /* first try to get the position based on the clock */
4822 gst_base_sink_get_position (basesink, format, &cur, &upstream))) {
4823 gst_query_set_position (query, format, cur);
4824 } else if (upstream) {
4825 /* fallback to peer query */
4826 res = gst_pad_peer_query (basesink->sinkpad, query);
4829 /* we can handle a few things if upstream failed */
4830 if (format == GST_FORMAT_PERCENT) {
4832 GstFormat uformat = GST_FORMAT_TIME;
4834 res = gst_base_sink_get_position (basesink, GST_FORMAT_TIME, &cur,
4836 if (!res && upstream) {
4837 res = gst_pad_query_peer_position (basesink->sinkpad, &uformat,
4841 res = gst_base_sink_get_duration (basesink, GST_FORMAT_TIME, &dur,
4843 if (!res && upstream) {
4844 res = gst_pad_query_peer_duration (basesink->sinkpad, &uformat,
4851 pos = gst_util_uint64_scale (100 * GST_FORMAT_PERCENT_SCALE, cur,
4853 gst_query_set_position (query, GST_FORMAT_PERCENT, pos);
4859 case GST_QUERY_DURATION:
4863 gboolean upstream = FALSE;
4865 gst_query_parse_duration (query, &format, NULL);
4867 GST_DEBUG_OBJECT (basesink, "duration query in format %s",
4868 gst_format_get_name (format));
4871 gst_base_sink_get_duration (basesink, format, &dur, &upstream))) {
4872 gst_query_set_duration (query, format, dur);
4873 } else if (upstream) {
4874 /* fallback to peer query */
4875 res = gst_pad_peer_query (basesink->sinkpad, query);
4878 /* we can handle a few things if upstream failed */
4879 if (format == GST_FORMAT_PERCENT) {
4880 gst_query_set_duration (query, GST_FORMAT_PERCENT,
4881 GST_FORMAT_PERCENT_MAX);
4887 case GST_QUERY_LATENCY:
4889 gboolean live, us_live;
4890 GstClockTime min, max;
4892 if ((res = gst_base_sink_query_latency (basesink, &live, &us_live, &min,
4894 gst_query_set_latency (query, live, min, max);
4898 case GST_QUERY_JITTER:
4900 case GST_QUERY_RATE:
4901 /* gst_query_set_rate (query, basesink->segment_rate); */
4904 case GST_QUERY_SEGMENT:
4906 if (basesink->pad_mode == GST_ACTIVATE_PULL) {
4907 gst_query_set_segment (query, basesink->segment.rate,
4908 GST_FORMAT_TIME, basesink->segment.start, basesink->segment.stop);
4911 res = gst_pad_peer_query (basesink->sinkpad, query);
4915 case GST_QUERY_SEEKING:
4916 case GST_QUERY_CONVERT:
4917 case GST_QUERY_FORMATS:
4919 res = gst_pad_peer_query (basesink->sinkpad, query);
4922 GST_DEBUG_OBJECT (basesink, "query %s returns %d",
4923 GST_QUERY_TYPE_NAME (query), res);
4927 static GstStateChangeReturn
4928 gst_base_sink_change_state (GstElement * element, GstStateChange transition)
4930 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
4931 GstBaseSink *basesink = GST_BASE_SINK (element);
4932 GstBaseSinkClass *bclass;
4933 GstBaseSinkPrivate *priv;
4935 priv = basesink->priv;
4937 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4939 switch (transition) {
4940 case GST_STATE_CHANGE_NULL_TO_READY:
4942 if (!bclass->start (basesink))
4945 case GST_STATE_CHANGE_READY_TO_PAUSED:
4946 /* need to complete preroll before this state change completes, there
4947 * is no data flow in READY so we can safely assume we need to preroll. */
4948 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4949 GST_DEBUG_OBJECT (basesink, "READY to PAUSED");
4950 basesink->have_newsegment = FALSE;
4951 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
4952 gst_segment_init (basesink->abidata.ABI.clip_segment,
4953 GST_FORMAT_UNDEFINED);
4954 basesink->offset = 0;
4955 basesink->have_preroll = FALSE;
4956 priv->step_unlock = FALSE;
4957 basesink->need_preroll = TRUE;
4958 basesink->playing_async = TRUE;
4959 priv->current_sstart = GST_CLOCK_TIME_NONE;
4960 priv->current_sstop = GST_CLOCK_TIME_NONE;
4961 priv->eos_rtime = GST_CLOCK_TIME_NONE;
4963 basesink->eos = FALSE;
4964 priv->received_eos = FALSE;
4965 gst_base_sink_reset_qos (basesink);
4966 priv->commited = FALSE;
4967 priv->call_preroll = TRUE;
4968 priv->current_step.valid = FALSE;
4969 priv->pending_step.valid = FALSE;
4970 if (priv->async_enabled) {
4971 GST_DEBUG_OBJECT (basesink, "doing async state change");
4972 /* when async enabled, post async-start message and return ASYNC from
4973 * the state change function */
4974 ret = GST_STATE_CHANGE_ASYNC;
4975 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4976 gst_message_new_async_start (GST_OBJECT_CAST (basesink), FALSE));
4978 priv->have_latency = TRUE;
4980 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4982 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
4983 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4984 if (!gst_base_sink_needs_preroll (basesink)) {
4985 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, don't need preroll");
4986 /* no preroll needed anymore now. */
4987 basesink->playing_async = FALSE;
4988 basesink->need_preroll = FALSE;
4989 if (basesink->eos) {
4990 GstMessage *message;
4992 /* need to post EOS message here */
4993 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
4994 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
4995 gst_message_set_seqnum (message, basesink->priv->seqnum);
4996 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
4998 GST_DEBUG_OBJECT (basesink, "signal preroll");
4999 GST_PAD_PREROLL_SIGNAL (basesink->sinkpad);
5002 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, we are not prerolled");
5003 basesink->need_preroll = TRUE;
5004 basesink->playing_async = TRUE;
5005 priv->call_preroll = TRUE;
5006 priv->commited = FALSE;
5007 if (priv->async_enabled) {
5008 GST_DEBUG_OBJECT (basesink, "doing async state change");
5009 ret = GST_STATE_CHANGE_ASYNC;
5010 gst_element_post_message (GST_ELEMENT_CAST (basesink),
5011 gst_message_new_async_start (GST_OBJECT_CAST (basesink), FALSE));
5014 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
5021 GstStateChangeReturn bret;
5023 bret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
5024 if (G_UNLIKELY (bret == GST_STATE_CHANGE_FAILURE))
5025 goto activate_failed;
5028 switch (transition) {
5029 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
5030 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED");
5031 /* FIXME, make sure we cannot enter _render first */
5033 /* we need to call ::unlock before locking PREROLL_LOCK
5034 * since we lock it before going into ::render */
5036 bclass->unlock (basesink);
5038 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
5039 GST_DEBUG_OBJECT (basesink, "got preroll lock");
5040 /* now that we have the PREROLL lock, clear our unlock request */
5041 if (bclass->unlock_stop)
5042 bclass->unlock_stop (basesink);
5044 /* we need preroll again and we set the flag before unlocking the clockid
5045 * because if the clockid is unlocked before a current buffer expired, we
5046 * can use that buffer to preroll with */
5047 basesink->need_preroll = TRUE;
5049 if (basesink->clock_id) {
5050 GST_DEBUG_OBJECT (basesink, "unschedule clock");
5051 gst_clock_id_unschedule (basesink->clock_id);
5054 /* if we don't have a preroll buffer we need to wait for a preroll and
5056 if (!gst_base_sink_needs_preroll (basesink)) {
5057 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED, we are prerolled");
5058 basesink->playing_async = FALSE;
5060 if (GST_STATE_TARGET (GST_ELEMENT (basesink)) <= GST_STATE_READY) {
5061 GST_DEBUG_OBJECT (basesink, "element is <= READY");
5062 ret = GST_STATE_CHANGE_SUCCESS;
5064 GST_DEBUG_OBJECT (basesink,
5065 "PLAYING to PAUSED, we are not prerolled");
5066 basesink->playing_async = TRUE;
5067 priv->commited = FALSE;
5068 priv->call_preroll = TRUE;
5069 if (priv->async_enabled) {
5070 GST_DEBUG_OBJECT (basesink, "doing async state change");
5071 ret = GST_STATE_CHANGE_ASYNC;
5072 gst_element_post_message (GST_ELEMENT_CAST (basesink),
5073 gst_message_new_async_start (GST_OBJECT_CAST (basesink),
5078 GST_DEBUG_OBJECT (basesink, "rendered: %" G_GUINT64_FORMAT
5079 ", dropped: %" G_GUINT64_FORMAT, priv->rendered, priv->dropped);
5081 gst_base_sink_reset_qos (basesink);
5082 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
5084 case GST_STATE_CHANGE_PAUSED_TO_READY:
5085 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
5086 /* start by reseting our position state with the object lock so that the
5087 * position query gets the right idea. We do this before we post the
5088 * messages so that the message handlers pick this up. */
5089 GST_OBJECT_LOCK (basesink);
5090 basesink->have_newsegment = FALSE;
5091 priv->current_sstart = GST_CLOCK_TIME_NONE;
5092 priv->current_sstop = GST_CLOCK_TIME_NONE;
5093 priv->have_latency = FALSE;
5094 if (priv->cached_clock_id) {
5095 gst_clock_id_unref (priv->cached_clock_id);
5096 priv->cached_clock_id = NULL;
5098 GST_OBJECT_UNLOCK (basesink);
5100 gst_base_sink_set_last_buffer (basesink, NULL);
5101 priv->call_preroll = FALSE;
5103 if (!priv->commited) {
5104 if (priv->async_enabled) {
5105 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, posting async-done");
5107 gst_element_post_message (GST_ELEMENT_CAST (basesink),
5108 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
5109 GST_STATE_PLAYING, GST_STATE_PAUSED, GST_STATE_READY));
5111 gst_element_post_message (GST_ELEMENT_CAST (basesink),
5112 gst_message_new_async_done (GST_OBJECT_CAST (basesink)));
5114 priv->commited = TRUE;
5116 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, don't need_preroll");
5118 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
5120 case GST_STATE_CHANGE_READY_TO_NULL:
5122 if (!bclass->stop (basesink)) {
5123 GST_WARNING_OBJECT (basesink, "failed to stop");
5126 gst_base_sink_set_last_buffer (basesink, NULL);
5127 priv->call_preroll = FALSE;
5138 GST_DEBUG_OBJECT (basesink, "failed to start");
5139 return GST_STATE_CHANGE_FAILURE;
5143 GST_DEBUG_OBJECT (basesink,
5144 "element failed to change states -- activation problem?");
5145 return GST_STATE_CHANGE_FAILURE;