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;
200 /* EOS sync time in running time */
201 GstClockTime eos_rtime;
203 /* last buffer that arrived in time, running time */
204 GstClockTime last_in_time;
205 /* when the last buffer left the sink, running time */
206 GstClockTime last_left;
208 /* running averages go here these are done on running time */
210 GstClockTime avg_duration;
213 /* these are done on system time. avg_jitter and avg_render are
214 * compared to eachother to see if the rendering time takes a
215 * huge amount of the processing, If so we are flooded with
217 GstClockTime last_left_systime;
218 GstClockTime avg_jitter;
219 GstClockTime start, stop;
220 GstClockTime avg_render;
222 /* number of rendered and dropped frames */
227 GstClockTime latency;
229 /* if we already commited the state */
232 /* when we received EOS */
233 gboolean received_eos;
235 /* when we are prerolled and able to report latency */
236 gboolean have_latency;
238 /* the last buffer we prerolled or rendered. Useful for making snapshots */
239 gint enable_last_buffer; /* atomic */
240 GstBuffer *last_buffer;
242 /* caps for pull based scheduling */
245 /* blocksize for pulling */
250 /* seqnum of the stream */
253 gboolean call_preroll;
254 gboolean step_unlock;
256 /* we have a pending and a current step operation */
257 GstStepInfo current_step;
258 GstStepInfo pending_step;
260 /* Cached GstClockID */
261 GstClockID cached_clock_id;
264 #define DO_RUNNING_AVG(avg,val,size) (((val) + ((size)-1) * (avg)) / (size))
266 /* generic running average, this has a neutral window size */
267 #define UPDATE_RUNNING_AVG(avg,val) DO_RUNNING_AVG(avg,val,8)
269 /* the windows for these running averages are experimentally obtained.
270 * possitive values get averaged more while negative values use a small
271 * window so we can react faster to badness. */
272 #define UPDATE_RUNNING_AVG_P(avg,val) DO_RUNNING_AVG(avg,val,16)
273 #define UPDATE_RUNNING_AVG_N(avg,val) DO_RUNNING_AVG(avg,val,4)
277 _PR_IS_NOTHING = 1 << 0,
278 _PR_IS_BUFFER = 1 << 1,
279 _PR_IS_BUFFERLIST = 1 << 2,
280 _PR_IS_EVENT = 1 << 3
283 #define OBJ_IS_BUFFER(a) ((a) & _PR_IS_BUFFER)
284 #define OBJ_IS_BUFFERLIST(a) ((a) & _PR_IS_BUFFERLIST)
285 #define OBJ_IS_EVENT(a) ((a) & _PR_IS_EVENT)
286 #define OBJ_IS_BUFFERFULL(a) ((a) & (_PR_IS_BUFFER | _PR_IS_BUFFERLIST))
288 /* BaseSink properties */
290 #define DEFAULT_CAN_ACTIVATE_PULL FALSE /* fixme: enable me */
291 #define DEFAULT_CAN_ACTIVATE_PUSH TRUE
293 #define DEFAULT_PREROLL_QUEUE_LEN 0
294 #define DEFAULT_SYNC TRUE
295 #define DEFAULT_MAX_LATENESS -1
296 #define DEFAULT_QOS FALSE
297 #define DEFAULT_ASYNC TRUE
298 #define DEFAULT_TS_OFFSET 0
299 #define DEFAULT_BLOCKSIZE 4096
300 #define DEFAULT_RENDER_DELAY 0
301 #define DEFAULT_ENABLE_LAST_BUFFER TRUE
306 PROP_PREROLL_QUEUE_LEN,
312 PROP_ENABLE_LAST_BUFFER,
319 static GstElementClass *parent_class = NULL;
321 static void gst_base_sink_class_init (GstBaseSinkClass * klass);
322 static void gst_base_sink_init (GstBaseSink * trans, gpointer g_class);
323 static void gst_base_sink_finalize (GObject * object);
326 gst_base_sink_get_type (void)
328 static volatile gsize base_sink_type = 0;
330 if (g_once_init_enter (&base_sink_type)) {
332 static const GTypeInfo base_sink_info = {
333 sizeof (GstBaseSinkClass),
336 (GClassInitFunc) gst_base_sink_class_init,
339 sizeof (GstBaseSink),
341 (GInstanceInitFunc) gst_base_sink_init,
344 _type = g_type_register_static (GST_TYPE_ELEMENT,
345 "GstBaseSink", &base_sink_info, G_TYPE_FLAG_ABSTRACT);
346 g_once_init_leave (&base_sink_type, _type);
348 return base_sink_type;
351 static void gst_base_sink_set_property (GObject * object, guint prop_id,
352 const GValue * value, GParamSpec * pspec);
353 static void gst_base_sink_get_property (GObject * object, guint prop_id,
354 GValue * value, GParamSpec * pspec);
356 static gboolean gst_base_sink_send_event (GstElement * element,
358 static gboolean gst_base_sink_query (GstElement * element, GstQuery * query);
359 static const GstQueryType *gst_base_sink_get_query_types (GstElement * element);
361 static GstCaps *gst_base_sink_get_caps (GstBaseSink * sink);
362 static gboolean gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps);
363 static GstFlowReturn gst_base_sink_buffer_alloc (GstBaseSink * sink,
364 guint64 offset, guint size, GstCaps * caps, GstBuffer ** buf);
365 static void gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
366 GstClockTime * start, GstClockTime * end);
367 static gboolean gst_base_sink_set_flushing (GstBaseSink * basesink,
368 GstPad * pad, gboolean flushing);
369 static gboolean gst_base_sink_default_activate_pull (GstBaseSink * basesink,
371 static gboolean gst_base_sink_default_do_seek (GstBaseSink * sink,
372 GstSegment * segment);
373 static gboolean gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
374 GstEvent * event, GstSegment * segment);
376 static GstStateChangeReturn gst_base_sink_change_state (GstElement * element,
377 GstStateChange transition);
379 static GstFlowReturn gst_base_sink_chain (GstPad * pad, GstBuffer * buffer);
380 static GstFlowReturn gst_base_sink_chain_list (GstPad * pad,
381 GstBufferList * list);
383 static void gst_base_sink_loop (GstPad * pad);
384 static gboolean gst_base_sink_pad_activate (GstPad * pad);
385 static gboolean gst_base_sink_pad_activate_push (GstPad * pad, gboolean active);
386 static gboolean gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active);
387 static gboolean gst_base_sink_event (GstPad * pad, GstEvent * event);
389 static gboolean gst_base_sink_negotiate_pull (GstBaseSink * basesink);
390 static GstCaps *gst_base_sink_pad_getcaps (GstPad * pad);
391 static gboolean gst_base_sink_pad_setcaps (GstPad * pad, GstCaps * caps);
392 static void gst_base_sink_pad_fixate (GstPad * pad, GstCaps * caps);
393 static GstFlowReturn gst_base_sink_pad_buffer_alloc (GstPad * pad,
394 guint64 offset, guint size, GstCaps * caps, GstBuffer ** buf);
397 /* check if an object was too late */
398 static gboolean gst_base_sink_is_too_late (GstBaseSink * basesink,
399 GstMiniObject * obj, GstClockTime start, GstClockTime stop,
400 GstClockReturn status, GstClockTimeDiff jitter);
401 static GstFlowReturn gst_base_sink_preroll_object (GstBaseSink * basesink,
402 guint8 obj_type, GstMiniObject * obj);
405 gst_base_sink_class_init (GstBaseSinkClass * klass)
407 GObjectClass *gobject_class;
408 GstElementClass *gstelement_class;
410 gobject_class = G_OBJECT_CLASS (klass);
411 gstelement_class = GST_ELEMENT_CLASS (klass);
413 GST_DEBUG_CATEGORY_INIT (gst_base_sink_debug, "basesink", 0,
416 g_type_class_add_private (klass, sizeof (GstBaseSinkPrivate));
418 parent_class = g_type_class_peek_parent (klass);
420 gobject_class->finalize = gst_base_sink_finalize;
421 gobject_class->set_property = gst_base_sink_set_property;
422 gobject_class->get_property = gst_base_sink_get_property;
424 /* FIXME, this next value should be configured using an event from the
425 * upstream element, ie, the BUFFER_SIZE event. */
426 g_object_class_install_property (gobject_class, PROP_PREROLL_QUEUE_LEN,
427 g_param_spec_uint ("preroll-queue-len", "Preroll queue length",
428 "Number of buffers to queue during preroll", 0, G_MAXUINT,
429 DEFAULT_PREROLL_QUEUE_LEN,
430 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
432 g_object_class_install_property (gobject_class, PROP_SYNC,
433 g_param_spec_boolean ("sync", "Sync", "Sync on the clock", DEFAULT_SYNC,
434 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
436 g_object_class_install_property (gobject_class, PROP_MAX_LATENESS,
437 g_param_spec_int64 ("max-lateness", "Max Lateness",
438 "Maximum number of nanoseconds that a buffer can be late before it "
439 "is dropped (-1 unlimited)", -1, G_MAXINT64, DEFAULT_MAX_LATENESS,
440 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
442 g_object_class_install_property (gobject_class, PROP_QOS,
443 g_param_spec_boolean ("qos", "Qos",
444 "Generate Quality-of-Service events upstream", DEFAULT_QOS,
445 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
449 * If set to #TRUE, the basesink will perform asynchronous state changes.
450 * When set to #FALSE, the sink will not signal the parent when it prerolls.
451 * Use this option when dealing with sparse streams or when synchronisation is
456 g_object_class_install_property (gobject_class, PROP_ASYNC,
457 g_param_spec_boolean ("async", "Async",
458 "Go asynchronously to PAUSED", DEFAULT_ASYNC,
459 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
461 * GstBaseSink:ts-offset
463 * Controls the final synchronisation, a negative value will render the buffer
464 * earlier while a positive value delays playback. This property can be
465 * used to fix synchronisation in bad files.
469 g_object_class_install_property (gobject_class, PROP_TS_OFFSET,
470 g_param_spec_int64 ("ts-offset", "TS Offset",
471 "Timestamp offset in nanoseconds", G_MININT64, G_MAXINT64,
472 DEFAULT_TS_OFFSET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
475 * GstBaseSink:enable-last-buffer
477 * Enable the last-buffer property. If FALSE, basesink doesn't keep a
478 * reference to the last buffer arrived and the last-buffer property is always
479 * set to NULL. This can be useful if you need buffers to be released as soon
480 * as possible, eg. if you're using a buffer pool.
484 g_object_class_install_property (gobject_class, PROP_ENABLE_LAST_BUFFER,
485 g_param_spec_boolean ("enable-last-buffer", "Enable Last Buffer",
486 "Enable the last-buffer property", DEFAULT_ENABLE_LAST_BUFFER,
487 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
490 * GstBaseSink:last-buffer
492 * The last buffer that arrived in the sink and was used for preroll or for
493 * rendering. This property can be used to generate thumbnails. This property
494 * can be NULL when the sink has not yet received a bufer.
498 g_object_class_install_property (gobject_class, PROP_LAST_BUFFER,
499 gst_param_spec_mini_object ("last-buffer", "Last Buffer",
500 "The last buffer received in the sink", GST_TYPE_BUFFER,
501 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
503 * GstBaseSink:blocksize
505 * The amount of bytes to pull when operating in pull mode.
509 g_object_class_install_property (gobject_class, PROP_BLOCKSIZE,
510 g_param_spec_uint ("blocksize", "Block size",
511 "Size in bytes to pull per buffer (0 = default)", 0, G_MAXUINT,
512 DEFAULT_BLOCKSIZE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
514 * GstBaseSink:render-delay
516 * The additional delay between synchronisation and actual rendering of the
517 * media. This property will add additional latency to the device in order to
518 * make other sinks compensate for the delay.
522 g_object_class_install_property (gobject_class, PROP_RENDER_DELAY,
523 g_param_spec_uint64 ("render-delay", "Render Delay",
524 "Additional render delay of the sink in nanoseconds", 0, G_MAXUINT64,
525 DEFAULT_RENDER_DELAY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
527 gstelement_class->change_state =
528 GST_DEBUG_FUNCPTR (gst_base_sink_change_state);
529 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_base_sink_send_event);
530 gstelement_class->query = GST_DEBUG_FUNCPTR (gst_base_sink_query);
531 gstelement_class->get_query_types =
532 GST_DEBUG_FUNCPTR (gst_base_sink_get_query_types);
534 klass->get_caps = GST_DEBUG_FUNCPTR (gst_base_sink_get_caps);
535 klass->set_caps = GST_DEBUG_FUNCPTR (gst_base_sink_set_caps);
536 klass->buffer_alloc = GST_DEBUG_FUNCPTR (gst_base_sink_buffer_alloc);
537 klass->get_times = GST_DEBUG_FUNCPTR (gst_base_sink_get_times);
538 klass->activate_pull =
539 GST_DEBUG_FUNCPTR (gst_base_sink_default_activate_pull);
541 /* Registering debug symbols for function pointers */
542 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_getcaps);
543 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_setcaps);
544 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_fixate);
545 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_buffer_alloc);
546 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate);
547 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate_push);
548 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate_pull);
549 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_event);
550 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain);
551 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain_list);
555 gst_base_sink_pad_getcaps (GstPad * pad)
557 GstBaseSinkClass *bclass;
559 GstCaps *caps = NULL;
561 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
562 bclass = GST_BASE_SINK_GET_CLASS (bsink);
564 if (bsink->pad_mode == GST_ACTIVATE_PULL) {
565 /* if we are operating in pull mode we only accept the negotiated caps */
566 GST_OBJECT_LOCK (pad);
567 if ((caps = GST_PAD_CAPS (pad)))
569 GST_OBJECT_UNLOCK (pad);
572 if (bclass->get_caps)
573 caps = bclass->get_caps (bsink);
576 GstPadTemplate *pad_template;
579 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass),
581 if (pad_template != NULL) {
582 caps = gst_caps_ref (gst_pad_template_get_caps (pad_template));
586 gst_object_unref (bsink);
592 gst_base_sink_pad_setcaps (GstPad * pad, GstCaps * caps)
594 GstBaseSinkClass *bclass;
598 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
599 bclass = GST_BASE_SINK_GET_CLASS (bsink);
601 if (res && bclass->set_caps)
602 res = bclass->set_caps (bsink, caps);
604 gst_object_unref (bsink);
610 gst_base_sink_pad_fixate (GstPad * pad, GstCaps * caps)
612 GstBaseSinkClass *bclass;
615 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
616 bclass = GST_BASE_SINK_GET_CLASS (bsink);
619 bclass->fixate (bsink, caps);
621 gst_object_unref (bsink);
625 gst_base_sink_pad_buffer_alloc (GstPad * pad, guint64 offset, guint size,
626 GstCaps * caps, GstBuffer ** buf)
628 GstBaseSinkClass *bclass;
630 GstFlowReturn result = GST_FLOW_OK;
632 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
633 bclass = GST_BASE_SINK_GET_CLASS (bsink);
635 if (bclass->buffer_alloc)
636 result = bclass->buffer_alloc (bsink, offset, size, caps, buf);
638 *buf = NULL; /* fallback in gstpad.c will allocate generic buffer */
640 gst_object_unref (bsink);
646 gst_base_sink_init (GstBaseSink * basesink, gpointer g_class)
648 GstPadTemplate *pad_template;
649 GstBaseSinkPrivate *priv;
651 basesink->priv = priv = GST_BASE_SINK_GET_PRIVATE (basesink);
654 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "sink");
655 g_return_if_fail (pad_template != NULL);
657 basesink->sinkpad = gst_pad_new_from_template (pad_template, "sink");
659 gst_pad_set_getcaps_function (basesink->sinkpad, gst_base_sink_pad_getcaps);
660 gst_pad_set_setcaps_function (basesink->sinkpad, gst_base_sink_pad_setcaps);
661 gst_pad_set_fixatecaps_function (basesink->sinkpad, gst_base_sink_pad_fixate);
662 gst_pad_set_bufferalloc_function (basesink->sinkpad,
663 gst_base_sink_pad_buffer_alloc);
664 gst_pad_set_activate_function (basesink->sinkpad, gst_base_sink_pad_activate);
665 gst_pad_set_activatepush_function (basesink->sinkpad,
666 gst_base_sink_pad_activate_push);
667 gst_pad_set_activatepull_function (basesink->sinkpad,
668 gst_base_sink_pad_activate_pull);
669 gst_pad_set_event_function (basesink->sinkpad, gst_base_sink_event);
670 gst_pad_set_chain_function (basesink->sinkpad, gst_base_sink_chain);
671 gst_pad_set_chain_list_function (basesink->sinkpad, gst_base_sink_chain_list);
672 gst_element_add_pad (GST_ELEMENT_CAST (basesink), basesink->sinkpad);
674 basesink->pad_mode = GST_ACTIVATE_NONE;
675 basesink->preroll_queue = g_queue_new ();
676 basesink->abidata.ABI.clip_segment = gst_segment_new ();
677 priv->have_latency = FALSE;
679 basesink->can_activate_push = DEFAULT_CAN_ACTIVATE_PUSH;
680 basesink->can_activate_pull = DEFAULT_CAN_ACTIVATE_PULL;
682 basesink->sync = DEFAULT_SYNC;
683 basesink->abidata.ABI.max_lateness = DEFAULT_MAX_LATENESS;
684 g_atomic_int_set (&priv->qos_enabled, DEFAULT_QOS);
685 priv->async_enabled = DEFAULT_ASYNC;
686 priv->ts_offset = DEFAULT_TS_OFFSET;
687 priv->render_delay = DEFAULT_RENDER_DELAY;
688 priv->blocksize = DEFAULT_BLOCKSIZE;
689 priv->cached_clock_id = NULL;
690 g_atomic_int_set (&priv->enable_last_buffer, DEFAULT_ENABLE_LAST_BUFFER);
692 GST_OBJECT_FLAG_SET (basesink, GST_ELEMENT_IS_SINK);
696 gst_base_sink_finalize (GObject * object)
698 GstBaseSink *basesink;
700 basesink = GST_BASE_SINK (object);
702 g_queue_free (basesink->preroll_queue);
703 gst_segment_free (basesink->abidata.ABI.clip_segment);
705 G_OBJECT_CLASS (parent_class)->finalize (object);
709 * gst_base_sink_set_sync:
711 * @sync: the new sync value.
713 * Configures @sink to synchronize on the clock or not. When
714 * @sync is FALSE, incomming samples will be played as fast as
715 * possible. If @sync is TRUE, the timestamps of the incomming
716 * buffers will be used to schedule the exact render time of its
722 gst_base_sink_set_sync (GstBaseSink * sink, gboolean sync)
724 g_return_if_fail (GST_IS_BASE_SINK (sink));
726 GST_OBJECT_LOCK (sink);
728 GST_OBJECT_UNLOCK (sink);
732 * gst_base_sink_get_sync:
735 * Checks if @sink is currently configured to synchronize against the
738 * Returns: TRUE if the sink is configured to synchronize against the clock.
743 gst_base_sink_get_sync (GstBaseSink * sink)
747 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
749 GST_OBJECT_LOCK (sink);
751 GST_OBJECT_UNLOCK (sink);
757 * gst_base_sink_set_max_lateness:
759 * @max_lateness: the new max lateness value.
761 * Sets the new max lateness value to @max_lateness. This value is
762 * used to decide if a buffer should be dropped or not based on the
763 * buffer timestamp and the current clock time. A value of -1 means
769 gst_base_sink_set_max_lateness (GstBaseSink * sink, gint64 max_lateness)
771 g_return_if_fail (GST_IS_BASE_SINK (sink));
773 GST_OBJECT_LOCK (sink);
774 sink->abidata.ABI.max_lateness = max_lateness;
775 GST_OBJECT_UNLOCK (sink);
779 * gst_base_sink_get_max_lateness:
782 * Gets the max lateness value. See gst_base_sink_set_max_lateness for
785 * Returns: The maximum time in nanoseconds that a buffer can be late
786 * before it is dropped and not rendered. A value of -1 means an
792 gst_base_sink_get_max_lateness (GstBaseSink * sink)
796 g_return_val_if_fail (GST_IS_BASE_SINK (sink), -1);
798 GST_OBJECT_LOCK (sink);
799 res = sink->abidata.ABI.max_lateness;
800 GST_OBJECT_UNLOCK (sink);
806 * gst_base_sink_set_qos_enabled:
808 * @enabled: the new qos value.
810 * Configures @sink to send Quality-of-Service events upstream.
815 gst_base_sink_set_qos_enabled (GstBaseSink * sink, gboolean enabled)
817 g_return_if_fail (GST_IS_BASE_SINK (sink));
819 g_atomic_int_set (&sink->priv->qos_enabled, enabled);
823 * gst_base_sink_is_qos_enabled:
826 * Checks if @sink is currently configured to send Quality-of-Service events
829 * Returns: TRUE if the sink is configured to perform Quality-of-Service.
834 gst_base_sink_is_qos_enabled (GstBaseSink * sink)
838 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
840 res = g_atomic_int_get (&sink->priv->qos_enabled);
846 * gst_base_sink_set_async_enabled:
848 * @enabled: the new async value.
850 * Configures @sink to perform all state changes asynchronusly. When async is
851 * disabled, the sink will immediatly go to PAUSED instead of waiting for a
852 * preroll buffer. This feature is usefull if the sink does not synchronize
853 * against the clock or when it is dealing with sparse streams.
858 gst_base_sink_set_async_enabled (GstBaseSink * sink, gboolean enabled)
860 g_return_if_fail (GST_IS_BASE_SINK (sink));
862 GST_PAD_PREROLL_LOCK (sink->sinkpad);
863 g_atomic_int_set (&sink->priv->async_enabled, enabled);
864 GST_LOG_OBJECT (sink, "set async enabled to %d", enabled);
865 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
869 * gst_base_sink_is_async_enabled:
872 * Checks if @sink is currently configured to perform asynchronous state
875 * Returns: TRUE if the sink is configured to perform asynchronous state
881 gst_base_sink_is_async_enabled (GstBaseSink * sink)
885 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
887 res = g_atomic_int_get (&sink->priv->async_enabled);
893 * gst_base_sink_set_ts_offset:
895 * @offset: the new offset
897 * Adjust the synchronisation of @sink with @offset. A negative value will
898 * render buffers earlier than their timestamp. A positive value will delay
899 * rendering. This function can be used to fix playback of badly timestamped
905 gst_base_sink_set_ts_offset (GstBaseSink * sink, GstClockTimeDiff offset)
907 g_return_if_fail (GST_IS_BASE_SINK (sink));
909 GST_OBJECT_LOCK (sink);
910 sink->priv->ts_offset = offset;
911 GST_LOG_OBJECT (sink, "set time offset to %" G_GINT64_FORMAT, offset);
912 GST_OBJECT_UNLOCK (sink);
916 * gst_base_sink_get_ts_offset:
919 * Get the synchronisation offset of @sink.
921 * Returns: The synchronisation offset.
926 gst_base_sink_get_ts_offset (GstBaseSink * sink)
928 GstClockTimeDiff res;
930 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
932 GST_OBJECT_LOCK (sink);
933 res = sink->priv->ts_offset;
934 GST_OBJECT_UNLOCK (sink);
940 * gst_base_sink_get_last_buffer:
943 * Get the last buffer that arrived in the sink and was used for preroll or for
944 * rendering. This property can be used to generate thumbnails.
946 * The #GstCaps on the buffer can be used to determine the type of the buffer.
948 * Returns: a #GstBuffer. gst_buffer_unref() after usage. This function returns
949 * NULL when no buffer has arrived in the sink yet or when the sink is not in
955 gst_base_sink_get_last_buffer (GstBaseSink * sink)
959 g_return_val_if_fail (GST_IS_BASE_SINK (sink), NULL);
961 GST_OBJECT_LOCK (sink);
962 if ((res = sink->priv->last_buffer))
963 gst_buffer_ref (res);
964 GST_OBJECT_UNLOCK (sink);
969 /* with OBJECT_LOCK */
971 gst_base_sink_set_last_buffer_unlocked (GstBaseSink * sink, GstBuffer * buffer)
975 old = sink->priv->last_buffer;
976 if (G_LIKELY (old != buffer)) {
977 GST_DEBUG_OBJECT (sink, "setting last buffer to %p", buffer);
978 if (G_LIKELY (buffer))
979 gst_buffer_ref (buffer);
980 sink->priv->last_buffer = buffer;
984 /* avoid unreffing with the lock because cleanup code might want to take the
986 if (G_LIKELY (old)) {
987 GST_OBJECT_UNLOCK (sink);
988 gst_buffer_unref (old);
989 GST_OBJECT_LOCK (sink);
994 gst_base_sink_set_last_buffer (GstBaseSink * sink, GstBuffer * buffer)
996 if (!g_atomic_int_get (&sink->priv->enable_last_buffer))
999 GST_OBJECT_LOCK (sink);
1000 gst_base_sink_set_last_buffer_unlocked (sink, buffer);
1001 GST_OBJECT_UNLOCK (sink);
1005 * gst_base_sink_set_last_buffer_enabled:
1007 * @enabled: the new enable-last-buffer value.
1009 * Configures @sink to store the last received buffer in the last-buffer
1015 gst_base_sink_set_last_buffer_enabled (GstBaseSink * sink, gboolean enabled)
1017 g_return_if_fail (GST_IS_BASE_SINK (sink));
1019 /* Only take lock if we change the value */
1020 if (g_atomic_int_compare_and_exchange (&sink->priv->enable_last_buffer,
1021 !enabled, enabled) && !enabled) {
1022 GST_OBJECT_LOCK (sink);
1023 gst_base_sink_set_last_buffer_unlocked (sink, NULL);
1024 GST_OBJECT_UNLOCK (sink);
1029 * gst_base_sink_is_last_buffer_enabled:
1032 * Checks if @sink is currently configured to store the last received buffer in
1033 * the last-buffer property.
1035 * Returns: TRUE if the sink is configured to store the last received buffer.
1040 gst_base_sink_is_last_buffer_enabled (GstBaseSink * sink)
1042 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
1044 return g_atomic_int_get (&sink->priv->enable_last_buffer);
1048 * gst_base_sink_get_latency:
1051 * Get the currently configured latency.
1053 * Returns: The configured latency.
1058 gst_base_sink_get_latency (GstBaseSink * sink)
1062 GST_OBJECT_LOCK (sink);
1063 res = sink->priv->latency;
1064 GST_OBJECT_UNLOCK (sink);
1070 * gst_base_sink_query_latency:
1072 * @live: if the sink is live
1073 * @upstream_live: if an upstream element is live
1074 * @min_latency: the min latency of the upstream elements
1075 * @max_latency: the max latency of the upstream elements
1077 * Query the sink for the latency parameters. The latency will be queried from
1078 * the upstream elements. @live will be TRUE if @sink is configured to
1079 * synchronize against the clock. @upstream_live will be TRUE if an upstream
1082 * If both @live and @upstream_live are TRUE, the sink will want to compensate
1083 * for the latency introduced by the upstream elements by setting the
1084 * @min_latency to a strictly possitive value.
1086 * This function is mostly used by subclasses.
1088 * Returns: TRUE if the query succeeded.
1093 gst_base_sink_query_latency (GstBaseSink * sink, gboolean * live,
1094 gboolean * upstream_live, GstClockTime * min_latency,
1095 GstClockTime * max_latency)
1097 gboolean l, us_live, res, have_latency;
1098 GstClockTime min, max, render_delay;
1100 GstClockTime us_min, us_max;
1102 /* we are live when we sync to the clock */
1103 GST_OBJECT_LOCK (sink);
1105 have_latency = sink->priv->have_latency;
1106 render_delay = sink->priv->render_delay;
1107 GST_OBJECT_UNLOCK (sink);
1109 /* assume no latency */
1115 GST_DEBUG_OBJECT (sink, "we are ready for LATENCY query");
1116 /* we are ready for a latency query this is when we preroll or when we are
1118 query = gst_query_new_latency ();
1120 /* ask the peer for the latency */
1121 if ((res = gst_pad_peer_query (sink->sinkpad, query))) {
1122 /* get upstream min and max latency */
1123 gst_query_parse_latency (query, &us_live, &us_min, &us_max);
1126 /* upstream live, use its latency, subclasses should use these
1127 * values to create the complete latency. */
1132 /* we need to add the render delay if we are live */
1134 min += render_delay;
1136 max += render_delay;
1139 gst_query_unref (query);
1141 GST_DEBUG_OBJECT (sink, "we are not yet ready for LATENCY query");
1145 /* not live, we tried to do the query, if it failed we return TRUE anyway */
1149 GST_DEBUG_OBJECT (sink, "latency query failed but we are not live");
1151 GST_DEBUG_OBJECT (sink, "latency query failed and we are live");
1156 GST_DEBUG_OBJECT (sink, "latency query: live: %d, have_latency %d,"
1157 " upstream: %d, min %" GST_TIME_FORMAT ", max %" GST_TIME_FORMAT, l,
1158 have_latency, us_live, GST_TIME_ARGS (min), GST_TIME_ARGS (max));
1163 *upstream_live = us_live;
1173 * gst_base_sink_set_render_delay:
1174 * @sink: a #GstBaseSink
1175 * @delay: the new delay
1177 * Set the render delay in @sink to @delay. The render delay is the time
1178 * between actual rendering of a buffer and its synchronisation time. Some
1179 * devices might delay media rendering which can be compensated for with this
1182 * After calling this function, this sink will report additional latency and
1183 * other sinks will adjust their latency to delay the rendering of their media.
1185 * This function is usually called by subclasses.
1190 gst_base_sink_set_render_delay (GstBaseSink * sink, GstClockTime delay)
1192 GstClockTime old_render_delay;
1194 g_return_if_fail (GST_IS_BASE_SINK (sink));
1196 GST_OBJECT_LOCK (sink);
1197 old_render_delay = sink->priv->render_delay;
1198 sink->priv->render_delay = delay;
1199 GST_LOG_OBJECT (sink, "set render delay to %" GST_TIME_FORMAT,
1200 GST_TIME_ARGS (delay));
1201 GST_OBJECT_UNLOCK (sink);
1203 if (delay != old_render_delay) {
1204 GST_DEBUG_OBJECT (sink, "posting latency changed");
1205 gst_element_post_message (GST_ELEMENT_CAST (sink),
1206 gst_message_new_latency (GST_OBJECT_CAST (sink)));
1211 * gst_base_sink_get_render_delay:
1212 * @sink: a #GstBaseSink
1214 * Get the render delay of @sink. see gst_base_sink_set_render_delay() for more
1215 * information about the render delay.
1217 * Returns: the render delay of @sink.
1222 gst_base_sink_get_render_delay (GstBaseSink * sink)
1224 GstClockTimeDiff res;
1226 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1228 GST_OBJECT_LOCK (sink);
1229 res = sink->priv->render_delay;
1230 GST_OBJECT_UNLOCK (sink);
1236 * gst_base_sink_set_blocksize:
1237 * @sink: a #GstBaseSink
1238 * @blocksize: the blocksize in bytes
1240 * Set the number of bytes that the sink will pull when it is operating in pull
1246 gst_base_sink_set_blocksize (GstBaseSink * sink, guint blocksize)
1248 g_return_if_fail (GST_IS_BASE_SINK (sink));
1250 GST_OBJECT_LOCK (sink);
1251 sink->priv->blocksize = blocksize;
1252 GST_LOG_OBJECT (sink, "set blocksize to %u", blocksize);
1253 GST_OBJECT_UNLOCK (sink);
1257 * gst_base_sink_get_blocksize:
1258 * @sink: a #GstBaseSink
1260 * Get the number of bytes that the sink will pull when it is operating in pull
1263 * Returns: the number of bytes @sink will pull in pull mode.
1268 gst_base_sink_get_blocksize (GstBaseSink * sink)
1272 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1274 GST_OBJECT_LOCK (sink);
1275 res = sink->priv->blocksize;
1276 GST_OBJECT_UNLOCK (sink);
1282 gst_base_sink_set_property (GObject * object, guint prop_id,
1283 const GValue * value, GParamSpec * pspec)
1285 GstBaseSink *sink = GST_BASE_SINK (object);
1288 case PROP_PREROLL_QUEUE_LEN:
1289 /* preroll lock necessary to serialize with finish_preroll */
1290 GST_PAD_PREROLL_LOCK (sink->sinkpad);
1291 g_atomic_int_set (&sink->preroll_queue_max_len, g_value_get_uint (value));
1292 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
1295 gst_base_sink_set_sync (sink, g_value_get_boolean (value));
1297 case PROP_MAX_LATENESS:
1298 gst_base_sink_set_max_lateness (sink, g_value_get_int64 (value));
1301 gst_base_sink_set_qos_enabled (sink, g_value_get_boolean (value));
1304 gst_base_sink_set_async_enabled (sink, g_value_get_boolean (value));
1306 case PROP_TS_OFFSET:
1307 gst_base_sink_set_ts_offset (sink, g_value_get_int64 (value));
1309 case PROP_BLOCKSIZE:
1310 gst_base_sink_set_blocksize (sink, g_value_get_uint (value));
1312 case PROP_RENDER_DELAY:
1313 gst_base_sink_set_render_delay (sink, g_value_get_uint64 (value));
1315 case PROP_ENABLE_LAST_BUFFER:
1316 gst_base_sink_set_last_buffer_enabled (sink, g_value_get_boolean (value));
1319 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1325 gst_base_sink_get_property (GObject * object, guint prop_id, GValue * value,
1328 GstBaseSink *sink = GST_BASE_SINK (object);
1331 case PROP_PREROLL_QUEUE_LEN:
1332 g_value_set_uint (value, g_atomic_int_get (&sink->preroll_queue_max_len));
1335 g_value_set_boolean (value, gst_base_sink_get_sync (sink));
1337 case PROP_MAX_LATENESS:
1338 g_value_set_int64 (value, gst_base_sink_get_max_lateness (sink));
1341 g_value_set_boolean (value, gst_base_sink_is_qos_enabled (sink));
1344 g_value_set_boolean (value, gst_base_sink_is_async_enabled (sink));
1346 case PROP_TS_OFFSET:
1347 g_value_set_int64 (value, gst_base_sink_get_ts_offset (sink));
1349 case PROP_LAST_BUFFER:
1350 gst_value_take_buffer (value, gst_base_sink_get_last_buffer (sink));
1352 case PROP_ENABLE_LAST_BUFFER:
1353 g_value_set_boolean (value, gst_base_sink_is_last_buffer_enabled (sink));
1355 case PROP_BLOCKSIZE:
1356 g_value_set_uint (value, gst_base_sink_get_blocksize (sink));
1358 case PROP_RENDER_DELAY:
1359 g_value_set_uint64 (value, gst_base_sink_get_render_delay (sink));
1362 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1369 gst_base_sink_get_caps (GstBaseSink * sink)
1375 gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps)
1380 static GstFlowReturn
1381 gst_base_sink_buffer_alloc (GstBaseSink * sink, guint64 offset, guint size,
1382 GstCaps * caps, GstBuffer ** buf)
1388 /* with PREROLL_LOCK, STREAM_LOCK */
1390 gst_base_sink_preroll_queue_flush (GstBaseSink * basesink, GstPad * pad)
1394 GST_DEBUG_OBJECT (basesink, "flushing queue %p", basesink);
1395 while ((obj = g_queue_pop_head (basesink->preroll_queue))) {
1396 GST_DEBUG_OBJECT (basesink, "popped %p", obj);
1397 gst_mini_object_unref (obj);
1399 /* we can't have EOS anymore now */
1400 basesink->eos = FALSE;
1401 basesink->priv->received_eos = FALSE;
1402 basesink->have_preroll = FALSE;
1403 basesink->priv->step_unlock = FALSE;
1404 basesink->eos_queued = FALSE;
1405 basesink->preroll_queued = 0;
1406 basesink->buffers_queued = 0;
1407 basesink->events_queued = 0;
1408 /* can't report latency anymore until we preroll again */
1409 if (basesink->priv->async_enabled) {
1410 GST_OBJECT_LOCK (basesink);
1411 basesink->priv->have_latency = FALSE;
1412 GST_OBJECT_UNLOCK (basesink);
1414 /* and signal any waiters now */
1415 GST_PAD_PREROLL_SIGNAL (pad);
1418 /* with STREAM_LOCK, configures given segment with the event information. */
1420 gst_base_sink_configure_segment (GstBaseSink * basesink, GstPad * pad,
1421 GstEvent * event, GstSegment * segment)
1424 gdouble rate, arate;
1430 /* the newsegment event is needed to bring the buffer timestamps to the
1431 * stream time and to drop samples outside of the playback segment. */
1432 gst_event_parse_new_segment_full (event, &update, &rate, &arate, &format,
1433 &start, &stop, &time);
1435 /* The segment is protected with both the STREAM_LOCK and the OBJECT_LOCK.
1436 * We protect with the OBJECT_LOCK so that we can use the values to
1437 * safely answer a POSITION query. */
1438 GST_OBJECT_LOCK (basesink);
1439 gst_segment_set_newsegment_full (segment, update, rate, arate, format, start,
1442 if (format == GST_FORMAT_TIME) {
1443 GST_DEBUG_OBJECT (basesink,
1444 "configured NEWSEGMENT update %d, rate %lf, applied rate %lf, "
1445 "format GST_FORMAT_TIME, "
1446 "%" GST_TIME_FORMAT " -- %" GST_TIME_FORMAT
1447 ", time %" GST_TIME_FORMAT ", accum %" GST_TIME_FORMAT,
1448 update, rate, arate, GST_TIME_ARGS (segment->start),
1449 GST_TIME_ARGS (segment->stop), GST_TIME_ARGS (segment->time),
1450 GST_TIME_ARGS (segment->accum));
1452 GST_DEBUG_OBJECT (basesink,
1453 "configured NEWSEGMENT update %d, rate %lf, applied rate %lf, "
1455 "%" G_GINT64_FORMAT " -- %" G_GINT64_FORMAT ", time %"
1456 G_GINT64_FORMAT ", accum %" G_GINT64_FORMAT, update, rate, arate,
1457 segment->format, segment->start, segment->stop, segment->time,
1460 GST_OBJECT_UNLOCK (basesink);
1463 /* with PREROLL_LOCK, STREAM_LOCK */
1465 gst_base_sink_commit_state (GstBaseSink * basesink)
1467 /* commit state and proceed to next pending state */
1468 GstState current, next, pending, post_pending;
1469 gboolean post_paused = FALSE;
1470 gboolean post_async_done = FALSE;
1471 gboolean post_playing = FALSE;
1473 /* we are certainly not playing async anymore now */
1474 basesink->playing_async = FALSE;
1476 GST_OBJECT_LOCK (basesink);
1477 current = GST_STATE (basesink);
1478 next = GST_STATE_NEXT (basesink);
1479 pending = GST_STATE_PENDING (basesink);
1480 post_pending = pending;
1483 case GST_STATE_PLAYING:
1485 GstBaseSinkClass *bclass;
1486 GstStateChangeReturn ret;
1488 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1490 GST_DEBUG_OBJECT (basesink, "commiting state to PLAYING");
1492 basesink->need_preroll = FALSE;
1493 post_async_done = TRUE;
1494 basesink->priv->commited = TRUE;
1495 post_playing = TRUE;
1496 /* post PAUSED too when we were READY */
1497 if (current == GST_STATE_READY) {
1501 /* make sure we notify the subclass of async playing */
1502 if (bclass->async_play) {
1503 GST_WARNING_OBJECT (basesink, "deprecated async_play");
1504 ret = bclass->async_play (basesink);
1505 if (ret == GST_STATE_CHANGE_FAILURE)
1510 case GST_STATE_PAUSED:
1511 GST_DEBUG_OBJECT (basesink, "commiting state to PAUSED");
1513 post_async_done = TRUE;
1514 basesink->priv->commited = TRUE;
1515 post_pending = GST_STATE_VOID_PENDING;
1517 case GST_STATE_READY:
1518 case GST_STATE_NULL:
1520 case GST_STATE_VOID_PENDING:
1521 goto nothing_pending;
1526 /* we can report latency queries now */
1527 basesink->priv->have_latency = TRUE;
1529 GST_STATE (basesink) = pending;
1530 GST_STATE_NEXT (basesink) = GST_STATE_VOID_PENDING;
1531 GST_STATE_PENDING (basesink) = GST_STATE_VOID_PENDING;
1532 GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_SUCCESS;
1533 GST_OBJECT_UNLOCK (basesink);
1536 GST_DEBUG_OBJECT (basesink, "posting PAUSED state change message");
1537 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1538 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1539 current, next, post_pending));
1541 if (post_async_done) {
1542 GST_DEBUG_OBJECT (basesink, "posting async-done message");
1543 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1544 gst_message_new_async_done (GST_OBJECT_CAST (basesink)));
1547 GST_DEBUG_OBJECT (basesink, "posting PLAYING state change message");
1548 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1549 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1550 next, pending, GST_STATE_VOID_PENDING));
1553 GST_STATE_BROADCAST (basesink);
1559 /* Depending on the state, set our vars. We get in this situation when the
1560 * state change function got a change to update the state vars before the
1561 * streaming thread did. This is fine but we need to make sure that we
1562 * update the need_preroll var since it was TRUE when we got here and might
1563 * become FALSE if we got to PLAYING. */
1564 GST_DEBUG_OBJECT (basesink, "nothing to commit, now in %s",
1565 gst_element_state_get_name (current));
1567 case GST_STATE_PLAYING:
1568 basesink->need_preroll = FALSE;
1570 case GST_STATE_PAUSED:
1571 basesink->need_preroll = TRUE;
1574 basesink->need_preroll = FALSE;
1575 basesink->flushing = TRUE;
1578 /* we can report latency queries now */
1579 basesink->priv->have_latency = TRUE;
1580 GST_OBJECT_UNLOCK (basesink);
1585 /* app is going to READY */
1586 GST_DEBUG_OBJECT (basesink, "stopping");
1587 basesink->need_preroll = FALSE;
1588 basesink->flushing = TRUE;
1589 GST_OBJECT_UNLOCK (basesink);
1594 GST_DEBUG_OBJECT (basesink, "async commit failed");
1595 GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_FAILURE;
1596 GST_OBJECT_UNLOCK (basesink);
1602 start_stepping (GstBaseSink * sink, GstSegment * segment,
1603 GstStepInfo * pending, GstStepInfo * current)
1606 GstMessage *message;
1608 GST_DEBUG_OBJECT (sink, "update pending step");
1610 GST_OBJECT_LOCK (sink);
1611 memcpy (current, pending, sizeof (GstStepInfo));
1612 pending->valid = FALSE;
1613 GST_OBJECT_UNLOCK (sink);
1615 /* post message first */
1617 gst_message_new_step_start (GST_OBJECT (sink), TRUE, current->format,
1618 current->amount, current->rate, current->flush, current->intermediate);
1619 gst_message_set_seqnum (message, current->seqnum);
1620 gst_element_post_message (GST_ELEMENT (sink), message);
1622 /* get the running time of where we paused and remember it */
1623 current->start = gst_element_get_start_time (GST_ELEMENT_CAST (sink));
1624 gst_segment_set_running_time (segment, GST_FORMAT_TIME, current->start);
1626 /* set the new rate for the remainder of the segment */
1627 current->start_rate = segment->rate;
1628 segment->rate *= current->rate;
1629 segment->abs_rate = ABS (segment->rate);
1632 if (segment->rate > 0.0)
1633 current->start_stop = segment->stop;
1635 current->start_start = segment->start;
1637 if (current->format == GST_FORMAT_TIME) {
1638 end = current->start + current->amount;
1639 if (!current->flush) {
1640 /* update the segment clipping regions for non-flushing seeks */
1641 if (segment->rate > 0.0) {
1642 segment->stop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1643 segment->last_stop = segment->stop;
1647 position = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1648 segment->time = position;
1649 segment->start = position;
1650 segment->last_stop = position;
1655 GST_DEBUG_OBJECT (sink,
1656 "segment now rate %lf, applied rate %lf, "
1657 "format GST_FORMAT_TIME, "
1658 "%" GST_TIME_FORMAT " -- %" GST_TIME_FORMAT
1659 ", time %" GST_TIME_FORMAT ", accum %" GST_TIME_FORMAT,
1660 segment->rate, segment->applied_rate, GST_TIME_ARGS (segment->start),
1661 GST_TIME_ARGS (segment->stop), GST_TIME_ARGS (segment->time),
1662 GST_TIME_ARGS (segment->accum));
1664 GST_DEBUG_OBJECT (sink, "step started at running_time %" GST_TIME_FORMAT,
1665 GST_TIME_ARGS (current->start));
1667 if (current->amount == -1) {
1668 GST_DEBUG_OBJECT (sink, "step amount == -1, stop stepping");
1669 current->valid = FALSE;
1671 GST_DEBUG_OBJECT (sink, "step amount: %" G_GUINT64_FORMAT ", format: %s, "
1672 "rate: %f", current->amount, gst_format_get_name (current->format),
1678 stop_stepping (GstBaseSink * sink, GstSegment * segment,
1679 GstStepInfo * current, gint64 rstart, gint64 rstop, gboolean eos)
1681 gint64 stop, position;
1682 GstMessage *message;
1684 GST_DEBUG_OBJECT (sink, "step complete");
1686 if (segment->rate > 0.0)
1691 GST_DEBUG_OBJECT (sink,
1692 "step stop at running_time %" GST_TIME_FORMAT, GST_TIME_ARGS (stop));
1695 current->duration = current->position;
1697 current->duration = stop - current->start;
1699 GST_DEBUG_OBJECT (sink, "step elapsed running_time %" GST_TIME_FORMAT,
1700 GST_TIME_ARGS (current->duration));
1702 position = current->start + current->duration;
1704 /* now move the segment to the new running time */
1705 gst_segment_set_running_time (segment, GST_FORMAT_TIME, position);
1707 if (current->flush) {
1708 /* and remove the accumulated time we flushed, start time did not change */
1709 segment->accum = current->start;
1711 /* start time is now the stepped position */
1712 gst_element_set_start_time (GST_ELEMENT_CAST (sink), position);
1715 /* restore the previous rate */
1716 segment->rate = current->start_rate;
1717 segment->abs_rate = ABS (segment->rate);
1719 if (segment->rate > 0.0)
1720 segment->stop = current->start_stop;
1722 segment->start = current->start_start;
1724 /* the clip segment is used for position report in paused... */
1725 memcpy (sink->abidata.ABI.clip_segment, segment, sizeof (GstSegment));
1727 /* post the step done when we know the stepped duration in TIME */
1729 gst_message_new_step_done (GST_OBJECT_CAST (sink), current->format,
1730 current->amount, current->rate, current->flush, current->intermediate,
1731 current->duration, eos);
1732 gst_message_set_seqnum (message, current->seqnum);
1733 gst_element_post_message (GST_ELEMENT_CAST (sink), message);
1735 if (!current->intermediate)
1736 sink->need_preroll = current->need_preroll;
1738 /* and the current step info finished and becomes invalid */
1739 current->valid = FALSE;
1743 handle_stepping (GstBaseSink * sink, GstSegment * segment,
1744 GstStepInfo * current, gint64 * cstart, gint64 * cstop, gint64 * rstart,
1747 gboolean step_end = FALSE;
1749 /* see if we need to skip this buffer because of stepping */
1750 switch (current->format) {
1751 case GST_FORMAT_TIME:
1756 if (segment->rate > 0.0) {
1757 if (segment->stop == *cstop)
1758 *rstop = *rstart + current->amount;
1763 if (segment->start == *cstart)
1764 *rstart = *rstop + current->amount;
1770 end = current->start + current->amount;
1771 current->position = first - current->start;
1773 if (G_UNLIKELY (segment->abs_rate != 1.0))
1774 current->position /= segment->abs_rate;
1776 GST_DEBUG_OBJECT (sink,
1777 "buffer: %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT,
1778 GST_TIME_ARGS (first), GST_TIME_ARGS (last));
1779 GST_DEBUG_OBJECT (sink,
1780 "got time step %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT "/%"
1781 GST_TIME_FORMAT, GST_TIME_ARGS (current->position),
1782 GST_TIME_ARGS (last - current->start),
1783 GST_TIME_ARGS (current->amount));
1785 if ((current->flush && current->position >= current->amount)
1787 GST_DEBUG_OBJECT (sink, "step ended, we need clipping");
1789 if (segment->rate > 0.0) {
1791 *cstart = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1794 *cstop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1797 GST_DEBUG_OBJECT (sink,
1798 "cstart %" GST_TIME_FORMAT ", rstart %" GST_TIME_FORMAT,
1799 GST_TIME_ARGS (*cstart), GST_TIME_ARGS (*rstart));
1800 GST_DEBUG_OBJECT (sink,
1801 "cstop %" GST_TIME_FORMAT ", rstop %" GST_TIME_FORMAT,
1802 GST_TIME_ARGS (*cstop), GST_TIME_ARGS (*rstop));
1805 case GST_FORMAT_BUFFERS:
1806 GST_DEBUG_OBJECT (sink,
1807 "got default step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1808 current->position, current->amount);
1810 if (current->position < current->amount) {
1811 current->position++;
1816 case GST_FORMAT_DEFAULT:
1818 GST_DEBUG_OBJECT (sink,
1819 "got unknown step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1820 current->position, current->amount);
1826 /* with STREAM_LOCK, PREROLL_LOCK
1828 * Returns TRUE if the object needs synchronisation and takes therefore
1829 * part in prerolling.
1831 * rsstart/rsstop contain the start/stop in stream time.
1832 * rrstart/rrstop contain the start/stop in running time.
1835 gst_base_sink_get_sync_times (GstBaseSink * basesink, GstMiniObject * obj,
1836 GstClockTime * rsstart, GstClockTime * rsstop,
1837 GstClockTime * rrstart, GstClockTime * rrstop, gboolean * do_sync,
1838 gboolean * stepped, GstSegment * segment, GstStepInfo * step,
1839 gboolean * step_end, guint8 obj_type)
1841 GstBaseSinkClass *bclass;
1843 GstClockTime start, stop; /* raw start/stop timestamps */
1844 gint64 cstart, cstop; /* clipped raw timestamps */
1845 gint64 rstart, rstop; /* clipped timestamps converted to running time */
1846 GstClockTime sstart, sstop; /* clipped timestamps converted to stream time */
1848 GstBaseSinkPrivate *priv;
1851 priv = basesink->priv;
1853 /* start with nothing */
1854 start = stop = GST_CLOCK_TIME_NONE;
1856 if (G_UNLIKELY (OBJ_IS_EVENT (obj_type))) {
1857 GstEvent *event = GST_EVENT_CAST (obj);
1859 switch (GST_EVENT_TYPE (event)) {
1860 /* EOS event needs syncing */
1863 if (basesink->segment.rate >= 0.0) {
1864 sstart = sstop = priv->current_sstop;
1865 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1866 /* we have not seen a buffer yet, use the segment values */
1867 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1868 basesink->segment.format, basesink->segment.stop);
1871 sstart = sstop = priv->current_sstart;
1872 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1873 /* we have not seen a buffer yet, use the segment values */
1874 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1875 basesink->segment.format, basesink->segment.start);
1879 rstart = rstop = priv->eos_rtime;
1880 *do_sync = rstart != -1;
1881 GST_DEBUG_OBJECT (basesink, "sync times for EOS %" GST_TIME_FORMAT,
1882 GST_TIME_ARGS (rstart));
1883 /* if we are stepping, we end now */
1884 *step_end = step->valid;
1889 /* other events do not need syncing */
1890 /* FIXME, maybe NEWSEGMENT might need synchronisation
1891 * since the POSITION query depends on accumulated times and
1892 * we cannot accumulate the current segment before the previous
1902 /* else do buffer sync code */
1903 buffer = GST_BUFFER_CAST (obj);
1905 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1907 /* just get the times to see if we need syncing, if the start returns -1 we
1909 if (bclass->get_times)
1910 bclass->get_times (basesink, buffer, &start, &stop);
1912 if (!GST_CLOCK_TIME_IS_VALID (start)) {
1913 /* we don't need to sync but we still want to get the timestamps for
1914 * tracking the position */
1915 gst_base_sink_get_times (basesink, buffer, &start, &stop);
1921 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
1922 ", stop: %" GST_TIME_FORMAT ", do_sync %d", GST_TIME_ARGS (start),
1923 GST_TIME_ARGS (stop), *do_sync);
1925 /* collect segment and format for code clarity */
1926 format = segment->format;
1928 /* no timestamp clipping if we did not get a TIME segment format */
1929 if (G_UNLIKELY (format != GST_FORMAT_TIME)) {
1932 /* do running and stream time in TIME format */
1933 format = GST_FORMAT_TIME;
1934 GST_LOG_OBJECT (basesink, "not time format, don't clip");
1938 /* clip, only when we know about time */
1939 if (G_UNLIKELY (!gst_segment_clip (segment, GST_FORMAT_TIME,
1940 (gint64) start, (gint64) stop, &cstart, &cstop))) {
1942 GST_DEBUG_OBJECT (basesink, "step out of segment");
1943 /* when we are stepping, pretend we're at the end of the segment */
1944 if (segment->rate > 0.0) {
1945 cstart = segment->stop;
1946 cstop = segment->stop;
1948 cstart = segment->start;
1949 cstop = segment->start;
1953 goto out_of_segment;
1956 if (G_UNLIKELY (start != cstart || stop != cstop)) {
1957 GST_DEBUG_OBJECT (basesink, "clipped to: start %" GST_TIME_FORMAT
1958 ", stop: %" GST_TIME_FORMAT, GST_TIME_ARGS (cstart),
1959 GST_TIME_ARGS (cstop));
1962 /* set last stop position */
1963 if (G_LIKELY (cstop != GST_CLOCK_TIME_NONE))
1964 gst_segment_set_last_stop (segment, GST_FORMAT_TIME, cstop);
1966 gst_segment_set_last_stop (segment, GST_FORMAT_TIME, cstart);
1969 rstart = gst_segment_to_running_time (segment, format, cstart);
1970 rstop = gst_segment_to_running_time (segment, format, cstop);
1972 if (G_UNLIKELY (step->valid)) {
1973 if (!(*step_end = handle_stepping (basesink, segment, step, &cstart, &cstop,
1974 &rstart, &rstop))) {
1975 /* step is still busy, we discard data when we are flushing */
1976 *stepped = step->flush;
1977 GST_DEBUG_OBJECT (basesink, "stepping busy");
1980 /* this can produce wrong values if we accumulated non-TIME segments. If this happens,
1981 * upstream is behaving very badly */
1982 sstart = gst_segment_to_stream_time (segment, format, cstart);
1983 sstop = gst_segment_to_stream_time (segment, format, cstop);
1986 /* eos_done label only called when doing EOS, we also stop stepping then */
1987 if (*step_end && step->flush) {
1988 GST_DEBUG_OBJECT (basesink, "flushing step ended");
1989 stop_stepping (basesink, segment, step, rstart, rstop, eos);
1991 /* re-determine running start times for adjusted segment
1992 * (which has a flushed amount of running/accumulated time removed) */
1993 if (!GST_IS_EVENT (obj)) {
1994 GST_DEBUG_OBJECT (basesink, "refresh sync times");
2005 /* buffers and EOS always need syncing and preroll */
2011 /* we usually clip in the chain function already but stepping could cause
2012 * the segment to be updated later. we return FALSE so that we don't try
2014 GST_LOG_OBJECT (basesink, "buffer skipped, not in segment");
2019 /* with STREAM_LOCK, PREROLL_LOCK, LOCK
2020 * adjust a timestamp with the latency and timestamp offset. This function does
2021 * not adjust for the render delay. */
2023 gst_base_sink_adjust_time (GstBaseSink * basesink, GstClockTime time)
2025 GstClockTimeDiff ts_offset;
2027 /* don't do anything funny with invalid timestamps */
2028 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
2031 time += basesink->priv->latency;
2033 /* apply offset, be carefull for underflows */
2034 ts_offset = basesink->priv->ts_offset;
2035 if (ts_offset < 0) {
2036 ts_offset = -ts_offset;
2037 if (ts_offset < time)
2044 /* subtract the render delay again, which was included in the latency */
2045 if (time > basesink->priv->render_delay)
2046 time -= basesink->priv->render_delay;
2054 * gst_base_sink_wait_clock:
2056 * @time: the running_time to be reached
2057 * @jitter: the jitter to be filled with time diff (can be NULL)
2059 * This function will block until @time is reached. It is usually called by
2060 * subclasses that use their own internal synchronisation.
2062 * If @time is not valid, no sycnhronisation is done and #GST_CLOCK_BADTIME is
2063 * returned. Likewise, if synchronisation is disabled in the element or there
2064 * is no clock, no synchronisation is done and #GST_CLOCK_BADTIME is returned.
2066 * This function should only be called with the PREROLL_LOCK held, like when
2067 * receiving an EOS event in the #GstBaseSinkClass.event() vmethod or when
2068 * receiving a buffer in
2069 * the #GstBaseSinkClass.render() vmethod.
2071 * The @time argument should be the running_time of when this method should
2072 * return and is not adjusted with any latency or offset configured in the
2077 * Returns: #GstClockReturn
2080 gst_base_sink_wait_clock (GstBaseSink * sink, GstClockTime time,
2081 GstClockTimeDiff * jitter)
2085 GstClockTime base_time;
2087 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
2090 GST_OBJECT_LOCK (sink);
2091 if (G_UNLIKELY (!sink->sync))
2094 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (sink)) == NULL))
2097 base_time = GST_ELEMENT_CAST (sink)->base_time;
2098 GST_LOG_OBJECT (sink,
2099 "time %" GST_TIME_FORMAT ", base_time %" GST_TIME_FORMAT,
2100 GST_TIME_ARGS (time), GST_TIME_ARGS (base_time));
2102 /* add base_time to running_time to get the time against the clock */
2105 /* Re-use existing clockid if available */
2106 if (G_LIKELY (sink->priv->cached_clock_id != NULL)) {
2107 if (!gst_clock_single_shot_id_reinit (clock, sink->priv->cached_clock_id,
2109 gst_clock_id_unref (sink->priv->cached_clock_id);
2110 sink->priv->cached_clock_id = gst_clock_new_single_shot_id (clock, time);
2113 sink->priv->cached_clock_id = gst_clock_new_single_shot_id (clock, time);
2114 GST_OBJECT_UNLOCK (sink);
2116 /* A blocking wait is performed on the clock. We save the ClockID
2117 * so we can unlock the entry at any time. While we are blocking, we
2118 * release the PREROLL_LOCK so that other threads can interrupt the
2120 sink->clock_id = sink->priv->cached_clock_id;
2121 /* release the preroll lock while waiting */
2122 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
2124 ret = gst_clock_id_wait (sink->priv->cached_clock_id, jitter);
2126 GST_PAD_PREROLL_LOCK (sink->sinkpad);
2127 sink->clock_id = NULL;
2131 /* no syncing needed */
2134 GST_DEBUG_OBJECT (sink, "time not valid, no sync needed");
2135 return GST_CLOCK_BADTIME;
2139 GST_DEBUG_OBJECT (sink, "sync disabled");
2140 GST_OBJECT_UNLOCK (sink);
2141 return GST_CLOCK_BADTIME;
2145 GST_DEBUG_OBJECT (sink, "no clock, can't sync");
2146 GST_OBJECT_UNLOCK (sink);
2147 return GST_CLOCK_BADTIME;
2152 * gst_base_sink_wait_preroll:
2155 * If the #GstBaseSinkClass.render() method performs its own synchronisation
2156 * against the clock it must unblock when going from PLAYING to the PAUSED state
2157 * and call this method before continuing to render the remaining data.
2159 * This function will block until a state change to PLAYING happens (in which
2160 * case this function returns #GST_FLOW_OK) or the processing must be stopped due
2161 * to a state change to READY or a FLUSH event (in which case this function
2162 * returns #GST_FLOW_WRONG_STATE).
2164 * This function should only be called with the PREROLL_LOCK held, like in the
2169 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2170 * continue. Any other return value should be returned from the render vmethod.
2173 gst_base_sink_wait_preroll (GstBaseSink * sink)
2175 sink->have_preroll = TRUE;
2176 GST_DEBUG_OBJECT (sink, "waiting in preroll for flush or PLAYING");
2177 /* block until the state changes, or we get a flush, or something */
2178 GST_PAD_PREROLL_WAIT (sink->sinkpad);
2179 sink->have_preroll = FALSE;
2180 if (G_UNLIKELY (sink->flushing))
2182 if (G_UNLIKELY (sink->priv->step_unlock))
2184 GST_DEBUG_OBJECT (sink, "continue after preroll");
2191 GST_DEBUG_OBJECT (sink, "preroll interrupted because of flush");
2192 return GST_FLOW_WRONG_STATE;
2196 sink->priv->step_unlock = FALSE;
2197 GST_DEBUG_OBJECT (sink, "preroll interrupted because of step");
2198 return GST_FLOW_STEP;
2203 * gst_base_sink_do_preroll:
2205 * @obj: the object that caused the preroll
2207 * If the @sink spawns its own thread for pulling buffers from upstream it
2208 * should call this method after it has pulled a buffer. If the element needed
2209 * to preroll, this function will perform the preroll and will then block
2210 * until the element state is changed.
2212 * This function should be called with the PREROLL_LOCK held.
2216 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2217 * continue. Any other return value should be returned from the render vmethod.
2220 gst_base_sink_do_preroll (GstBaseSink * sink, GstMiniObject * obj)
2224 while (G_UNLIKELY (sink->need_preroll)) {
2225 guint8 obj_type = _PR_IS_NOTHING;
2226 GST_DEBUG_OBJECT (sink, "prerolling object %p", obj);
2228 if (G_LIKELY (GST_IS_BUFFER (obj)))
2229 obj_type = _PR_IS_BUFFER;
2230 else if (GST_IS_EVENT (obj))
2231 obj_type = _PR_IS_EVENT;
2232 else if (GST_IS_BUFFER_LIST (obj))
2233 obj_type = _PR_IS_BUFFERLIST;
2235 ret = gst_base_sink_preroll_object (sink, obj_type, obj);
2236 if (ret != GST_FLOW_OK)
2237 goto preroll_failed;
2239 /* need to recheck here because the commit state could have
2240 * made us not need the preroll anymore */
2241 if (G_LIKELY (sink->need_preroll)) {
2242 /* block until the state changes, or we get a flush, or something */
2243 ret = gst_base_sink_wait_preroll (sink);
2244 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2245 goto preroll_failed;
2253 GST_DEBUG_OBJECT (sink, "preroll failed %d", ret);
2259 * gst_base_sink_wait_eos:
2261 * @time: the running_time to be reached
2262 * @jitter: the jitter to be filled with time diff (can be NULL)
2264 * This function will block until @time is reached. It is usually called by
2265 * subclasses that use their own internal synchronisation but want to let the
2266 * EOS be handled by the base class.
2268 * This function should only be called with the PREROLL_LOCK held, like when
2269 * receiving an EOS event in the ::event vmethod.
2271 * The @time argument should be the running_time of when the EOS should happen
2272 * and will be adjusted with any latency and offset configured in the sink.
2276 * Returns: #GstFlowReturn
2279 gst_base_sink_wait_eos (GstBaseSink * sink, GstClockTime time,
2280 GstClockTimeDiff * jitter)
2282 GstClockReturn status;
2288 GST_DEBUG_OBJECT (sink, "checking preroll");
2290 /* first wait for the playing state before we can continue */
2291 if (G_UNLIKELY (sink->need_preroll)) {
2292 ret = gst_base_sink_wait_preroll (sink);
2293 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2297 /* preroll done, we can sync since we are in PLAYING now. */
2298 GST_DEBUG_OBJECT (sink, "possibly waiting for clock to reach %"
2299 GST_TIME_FORMAT, GST_TIME_ARGS (time));
2301 /* compensate for latency and ts_offset. We don't adjust for render delay
2302 * because we don't interact with the device on EOS normally. */
2303 stime = gst_base_sink_adjust_time (sink, time);
2305 /* wait for the clock, this can be interrupted because we got shut down or
2307 status = gst_base_sink_wait_clock (sink, stime, jitter);
2309 GST_DEBUG_OBJECT (sink, "clock returned %d", status);
2311 /* invalid time, no clock or sync disabled, just continue then */
2312 if (status == GST_CLOCK_BADTIME)
2315 /* waiting could have been interrupted and we can be flushing now */
2316 if (G_UNLIKELY (sink->flushing))
2319 /* retry if we got unscheduled, which means we did not reach the timeout
2320 * yet. if some other error occures, we continue. */
2321 } while (status == GST_CLOCK_UNSCHEDULED);
2323 GST_DEBUG_OBJECT (sink, "end of stream");
2330 GST_DEBUG_OBJECT (sink, "we are flushing");
2331 return GST_FLOW_WRONG_STATE;
2335 /* with STREAM_LOCK, PREROLL_LOCK
2337 * Make sure we are in PLAYING and synchronize an object to the clock.
2339 * If we need preroll, we are not in PLAYING. We try to commit the state
2340 * if needed and then block if we still are not PLAYING.
2342 * We start waiting on the clock in PLAYING. If we got interrupted, we
2343 * immediatly try to re-preroll.
2345 * Some objects do not need synchronisation (most events) and so this function
2346 * immediatly returns GST_FLOW_OK.
2348 * for objects that arrive later than max-lateness to be synchronized to the
2349 * clock have the @late boolean set to TRUE.
2351 * This function keeps a running average of the jitter (the diff between the
2352 * clock time and the requested sync time). The jitter is negative for
2353 * objects that arrive in time and positive for late buffers.
2355 * does not take ownership of obj.
2357 static GstFlowReturn
2358 gst_base_sink_do_sync (GstBaseSink * basesink, GstPad * pad,
2359 GstMiniObject * obj, gboolean * late, gboolean * step_end, guint8 obj_type)
2361 GstClockTimeDiff jitter = 0;
2363 GstClockReturn status = GST_CLOCK_OK;
2364 GstClockTime rstart, rstop, sstart, sstop, stime;
2366 GstBaseSinkPrivate *priv;
2368 GstStepInfo *current, *pending;
2371 priv = basesink->priv;
2374 sstart = sstop = rstart = rstop = GST_CLOCK_TIME_NONE;
2378 priv->current_rstart = GST_CLOCK_TIME_NONE;
2380 /* get stepping info */
2381 current = &priv->current_step;
2382 pending = &priv->pending_step;
2384 /* get timing information for this object against the render segment */
2385 syncable = gst_base_sink_get_sync_times (basesink, obj,
2386 &sstart, &sstop, &rstart, &rstop, &do_sync, &stepped, &basesink->segment,
2387 current, step_end, obj_type);
2389 if (G_UNLIKELY (stepped))
2392 /* a syncable object needs to participate in preroll and
2393 * clocking. All buffers and EOS are syncable. */
2394 if (G_UNLIKELY (!syncable))
2397 /* store timing info for current object */
2398 priv->current_rstart = rstart;
2399 priv->current_rstop = (GST_CLOCK_TIME_IS_VALID (rstop) ? rstop : rstart);
2401 /* save sync time for eos when the previous object needed sync */
2402 priv->eos_rtime = (do_sync ? priv->current_rstop : GST_CLOCK_TIME_NONE);
2405 /* first do preroll, this makes sure we commit our state
2406 * to PAUSED and can continue to PLAYING. We cannot perform
2407 * any clock sync in PAUSED because there is no clock. */
2408 ret = gst_base_sink_do_preroll (basesink, obj);
2409 if (G_UNLIKELY (ret != GST_FLOW_OK))
2410 goto preroll_failed;
2412 /* update the segment with a pending step if the current one is invalid and we
2413 * have a new pending one. We only accept new step updates after a preroll */
2414 if (G_UNLIKELY (pending->valid && !current->valid)) {
2415 start_stepping (basesink, &basesink->segment, pending, current);
2419 /* After rendering we store the position of the last buffer so that we can use
2420 * it to report the position. We need to take the lock here. */
2421 GST_OBJECT_LOCK (basesink);
2422 priv->current_sstart = sstart;
2423 priv->current_sstop = (GST_CLOCK_TIME_IS_VALID (sstop) ? sstop : sstart);
2424 GST_OBJECT_UNLOCK (basesink);
2429 /* adjust for latency */
2430 stime = gst_base_sink_adjust_time (basesink, rstart);
2432 /* adjust for render-delay, avoid underflows */
2433 if (GST_CLOCK_TIME_IS_VALID (stime)) {
2434 if (stime > priv->render_delay)
2435 stime -= priv->render_delay;
2440 /* preroll done, we can sync since we are in PLAYING now. */
2441 GST_DEBUG_OBJECT (basesink, "possibly waiting for clock to reach %"
2442 GST_TIME_FORMAT ", adjusted %" GST_TIME_FORMAT,
2443 GST_TIME_ARGS (rstart), GST_TIME_ARGS (stime));
2445 /* This function will return immediatly if start == -1, no clock
2446 * or sync is disabled with GST_CLOCK_BADTIME. */
2447 status = gst_base_sink_wait_clock (basesink, stime, &jitter);
2449 GST_DEBUG_OBJECT (basesink, "clock returned %d, jitter %c%" GST_TIME_FORMAT,
2450 status, (jitter < 0 ? '-' : ' '), GST_TIME_ARGS (ABS (jitter)));
2452 /* invalid time, no clock or sync disabled, just render */
2453 if (status == GST_CLOCK_BADTIME)
2456 /* waiting could have been interrupted and we can be flushing now */
2457 if (G_UNLIKELY (basesink->flushing))
2460 /* check for unlocked by a state change, we are not flushing so
2461 * we can try to preroll on the current buffer. */
2462 if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED)) {
2463 GST_DEBUG_OBJECT (basesink, "unscheduled, waiting some more");
2464 priv->call_preroll = TRUE;
2468 /* successful syncing done, record observation */
2469 priv->current_jitter = jitter;
2471 /* check if the object should be dropped */
2472 *late = gst_base_sink_is_too_late (basesink, obj, rstart, rstop,
2481 GST_DEBUG_OBJECT (basesink, "skipped stepped object %p", obj);
2487 GST_DEBUG_OBJECT (basesink, "non syncable object %p", obj);
2492 GST_DEBUG_OBJECT (basesink, "we are flushing");
2493 return GST_FLOW_WRONG_STATE;
2497 GST_DEBUG_OBJECT (basesink, "preroll failed");
2504 gst_base_sink_send_qos (GstBaseSink * basesink,
2505 gdouble proportion, GstClockTime time, GstClockTimeDiff diff)
2510 /* generate Quality-of-Service event */
2511 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2512 "qos: proportion: %lf, diff %" G_GINT64_FORMAT ", timestamp %"
2513 GST_TIME_FORMAT, proportion, diff, GST_TIME_ARGS (time));
2515 event = gst_event_new_qos (proportion, diff, time);
2518 res = gst_pad_push_event (basesink->sinkpad, event);
2524 gst_base_sink_perform_qos (GstBaseSink * sink, gboolean dropped)
2526 GstBaseSinkPrivate *priv;
2527 GstClockTime start, stop;
2528 GstClockTimeDiff jitter;
2529 GstClockTime pt, entered, left;
2530 GstClockTime duration;
2535 start = priv->current_rstart;
2537 if (priv->current_step.valid)
2540 /* if Quality-of-Service disabled, do nothing */
2541 if (!g_atomic_int_get (&priv->qos_enabled) ||
2542 !GST_CLOCK_TIME_IS_VALID (start))
2545 stop = priv->current_rstop;
2546 jitter = priv->current_jitter;
2549 /* this is the time the buffer entered the sink */
2550 if (start < -jitter)
2553 entered = start + jitter;
2556 /* this is the time the buffer entered the sink */
2557 entered = start + jitter;
2558 /* this is the time the buffer left the sink */
2559 left = start + jitter;
2562 /* calculate duration of the buffer */
2563 if (GST_CLOCK_TIME_IS_VALID (stop))
2564 duration = stop - start;
2566 duration = GST_CLOCK_TIME_NONE;
2568 /* if we have the time when the last buffer left us, calculate
2569 * processing time */
2570 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2571 if (entered > priv->last_left) {
2572 pt = entered - priv->last_left;
2580 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "start: %" GST_TIME_FORMAT
2581 ", entered %" GST_TIME_FORMAT ", left %" GST_TIME_FORMAT ", pt: %"
2582 GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT ",jitter %"
2583 G_GINT64_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (entered),
2584 GST_TIME_ARGS (left), GST_TIME_ARGS (pt), GST_TIME_ARGS (duration),
2587 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "avg_duration: %" GST_TIME_FORMAT
2588 ", avg_pt: %" GST_TIME_FORMAT ", avg_rate: %g",
2589 GST_TIME_ARGS (priv->avg_duration), GST_TIME_ARGS (priv->avg_pt),
2592 /* collect running averages. for first observations, we copy the
2594 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_duration))
2595 priv->avg_duration = duration;
2597 priv->avg_duration = UPDATE_RUNNING_AVG (priv->avg_duration, duration);
2599 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_pt))
2602 priv->avg_pt = UPDATE_RUNNING_AVG (priv->avg_pt, pt);
2604 if (priv->avg_duration != 0)
2606 gst_guint64_to_gdouble (priv->avg_pt) /
2607 gst_guint64_to_gdouble (priv->avg_duration);
2611 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2612 if (dropped || priv->avg_rate < 0.0) {
2613 priv->avg_rate = rate;
2616 priv->avg_rate = UPDATE_RUNNING_AVG_N (priv->avg_rate, rate);
2618 priv->avg_rate = UPDATE_RUNNING_AVG_P (priv->avg_rate, rate);
2622 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink,
2623 "updated: avg_duration: %" GST_TIME_FORMAT ", avg_pt: %" GST_TIME_FORMAT
2624 ", avg_rate: %g", GST_TIME_ARGS (priv->avg_duration),
2625 GST_TIME_ARGS (priv->avg_pt), priv->avg_rate);
2628 if (priv->avg_rate >= 0.0) {
2629 /* if we have a valid rate, start sending QoS messages */
2630 if (priv->current_jitter < 0) {
2631 /* make sure we never go below 0 when adding the jitter to the
2633 if (priv->current_rstart < -priv->current_jitter)
2634 priv->current_jitter = -priv->current_rstart;
2636 gst_base_sink_send_qos (sink, priv->avg_rate, priv->current_rstart,
2637 priv->current_jitter);
2640 /* record when this buffer will leave us */
2641 priv->last_left = left;
2644 /* reset all qos measuring */
2646 gst_base_sink_reset_qos (GstBaseSink * sink)
2648 GstBaseSinkPrivate *priv;
2652 priv->last_in_time = GST_CLOCK_TIME_NONE;
2653 priv->last_left = GST_CLOCK_TIME_NONE;
2654 priv->avg_duration = GST_CLOCK_TIME_NONE;
2655 priv->avg_pt = GST_CLOCK_TIME_NONE;
2656 priv->avg_rate = -1.0;
2657 priv->avg_render = GST_CLOCK_TIME_NONE;
2663 /* Checks if the object was scheduled too late.
2665 * start/stop contain the raw timestamp start and stop values
2668 * status and jitter contain the return values from the clock wait.
2670 * returns TRUE if the buffer was too late.
2673 gst_base_sink_is_too_late (GstBaseSink * basesink, GstMiniObject * obj,
2674 GstClockTime start, GstClockTime stop,
2675 GstClockReturn status, GstClockTimeDiff jitter)
2678 gint64 max_lateness;
2679 GstBaseSinkPrivate *priv;
2681 priv = basesink->priv;
2685 /* only for objects that were too late */
2686 if (G_LIKELY (status != GST_CLOCK_EARLY))
2689 max_lateness = basesink->abidata.ABI.max_lateness;
2691 /* check if frame dropping is enabled */
2692 if (max_lateness == -1)
2695 /* only check for buffers */
2696 if (G_UNLIKELY (!GST_IS_BUFFER (obj)))
2699 /* can't do check if we don't have a timestamp */
2700 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (start)))
2703 /* we can add a valid stop time */
2704 if (GST_CLOCK_TIME_IS_VALID (stop))
2705 max_lateness += stop;
2707 max_lateness += start;
2709 /* if the jitter bigger than duration and lateness we are too late */
2710 if ((late = start + jitter > max_lateness)) {
2711 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2712 "buffer is too late %" GST_TIME_FORMAT
2713 " > %" GST_TIME_FORMAT, GST_TIME_ARGS (start + jitter),
2714 GST_TIME_ARGS (max_lateness));
2715 /* !!emergency!!, if we did not receive anything valid for more than a
2716 * second, render it anyway so the user sees something */
2717 if (GST_CLOCK_TIME_IS_VALID (priv->last_in_time) &&
2718 start - priv->last_in_time > GST_SECOND) {
2720 GST_ELEMENT_WARNING (basesink, CORE, CLOCK,
2721 (_("A lot of buffers are being dropped.")),
2722 ("There may be a timestamping problem, or this computer is too slow."));
2723 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2724 "**emergency** last buffer at %" GST_TIME_FORMAT " > GST_SECOND",
2725 GST_TIME_ARGS (priv->last_in_time));
2730 if (!late || !GST_CLOCK_TIME_IS_VALID (priv->last_in_time)) {
2731 priv->last_in_time = start;
2738 GST_DEBUG_OBJECT (basesink, "object was scheduled in time");
2743 GST_DEBUG_OBJECT (basesink, "frame dropping disabled");
2748 GST_DEBUG_OBJECT (basesink, "object is not a buffer");
2753 GST_DEBUG_OBJECT (basesink, "buffer has no timestamp");
2758 /* called before and after calling the render vmethod. It keeps track of how
2759 * much time was spent in the render method and is used to check if we are
2762 gst_base_sink_do_render_stats (GstBaseSink * basesink, gboolean start)
2764 GstBaseSinkPrivate *priv;
2766 priv = basesink->priv;
2769 priv->start = gst_util_get_timestamp ();
2771 GstClockTime elapsed;
2773 priv->stop = gst_util_get_timestamp ();
2775 elapsed = GST_CLOCK_DIFF (priv->start, priv->stop);
2777 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_render))
2778 priv->avg_render = elapsed;
2780 priv->avg_render = UPDATE_RUNNING_AVG (priv->avg_render, elapsed);
2782 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2783 "avg_render: %" GST_TIME_FORMAT, GST_TIME_ARGS (priv->avg_render));
2787 /* with STREAM_LOCK, PREROLL_LOCK,
2789 * Synchronize the object on the clock and then render it.
2791 * takes ownership of obj.
2793 static GstFlowReturn
2794 gst_base_sink_render_object (GstBaseSink * basesink, GstPad * pad,
2795 guint8 obj_type, gpointer obj)
2798 GstBaseSinkClass *bclass;
2799 gboolean late, step_end;
2801 GstBaseSinkPrivate *priv;
2803 priv = basesink->priv;
2805 if (OBJ_IS_BUFFERLIST (obj_type)) {
2807 * If buffer list, use the first group buffer within the list
2810 sync_obj = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0, 0);
2811 g_assert (NULL != sync_obj);
2820 /* synchronize this object, non syncable objects return OK
2823 gst_base_sink_do_sync (basesink, pad, sync_obj, &late, &step_end,
2825 if (G_UNLIKELY (ret != GST_FLOW_OK))
2828 /* and now render, event or buffer/buffer list. */
2829 if (G_LIKELY (OBJ_IS_BUFFERFULL (obj_type))) {
2830 /* drop late buffers unconditionally, let's hope it's unlikely */
2831 if (G_UNLIKELY (late))
2834 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2836 if (G_LIKELY ((OBJ_IS_BUFFERLIST (obj_type) && bclass->render_list) ||
2837 (!OBJ_IS_BUFFERLIST (obj_type) && bclass->render))) {
2840 /* read once, to get same value before and after */
2841 do_qos = g_atomic_int_get (&priv->qos_enabled);
2843 GST_DEBUG_OBJECT (basesink, "rendering object %p", obj);
2845 /* record rendering time for QoS and stats */
2847 gst_base_sink_do_render_stats (basesink, TRUE);
2849 if (!OBJ_IS_BUFFERLIST (obj_type)) {
2852 /* For buffer lists do not set last buffer. Creating buffer
2853 * with meaningful data can be done only with memcpy which will
2854 * significantly affect performance */
2855 buf = GST_BUFFER_CAST (obj);
2856 gst_base_sink_set_last_buffer (basesink, buf);
2858 ret = bclass->render (basesink, buf);
2860 GstBufferList *buflist;
2862 buflist = GST_BUFFER_LIST_CAST (obj);
2864 ret = bclass->render_list (basesink, buflist);
2868 gst_base_sink_do_render_stats (basesink, FALSE);
2870 if (ret == GST_FLOW_STEP)
2873 if (G_UNLIKELY (basesink->flushing))
2878 } else if (G_LIKELY (OBJ_IS_EVENT (obj_type))) {
2879 GstEvent *event = GST_EVENT_CAST (obj);
2880 gboolean event_res = TRUE;
2883 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2885 type = GST_EVENT_TYPE (event);
2887 GST_DEBUG_OBJECT (basesink, "rendering event %p, type %s", obj,
2888 gst_event_type_get_name (type));
2891 event_res = bclass->event (basesink, event);
2893 /* when we get here we could be flushing again when the event handler calls
2894 * _wait_eos(). We have to ignore this object in that case. */
2895 if (G_UNLIKELY (basesink->flushing))
2898 if (G_LIKELY (event_res)) {
2901 seqnum = basesink->priv->seqnum = gst_event_get_seqnum (event);
2902 GST_DEBUG_OBJECT (basesink, "Got seqnum #%" G_GUINT32_FORMAT, seqnum);
2907 GstMessage *message;
2909 /* the EOS event is completely handled so we mark
2910 * ourselves as being in the EOS state. eos is also
2911 * protected by the object lock so we can read it when
2912 * answering the POSITION query. */
2913 GST_OBJECT_LOCK (basesink);
2914 basesink->eos = TRUE;
2915 GST_OBJECT_UNLOCK (basesink);
2917 /* ok, now we can post the message */
2918 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
2920 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
2921 gst_message_set_seqnum (message, seqnum);
2922 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
2925 case GST_EVENT_NEWSEGMENT:
2926 /* configure the segment */
2927 gst_base_sink_configure_segment (basesink, pad, event,
2928 &basesink->segment);
2930 case GST_EVENT_SINK_MESSAGE:{
2931 GstMessage *msg = NULL;
2933 gst_event_parse_sink_message (event, &msg);
2936 gst_element_post_message (GST_ELEMENT_CAST (basesink), msg);
2943 g_return_val_if_reached (GST_FLOW_ERROR);
2948 /* the step ended, check if we need to activate a new step */
2949 GST_DEBUG_OBJECT (basesink, "step ended");
2950 stop_stepping (basesink, &basesink->segment, &priv->current_step,
2951 priv->current_rstart, priv->current_rstop, basesink->eos);
2955 gst_base_sink_perform_qos (basesink, late);
2957 GST_DEBUG_OBJECT (basesink, "object unref after render %p", obj);
2958 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
2964 GST_DEBUG_OBJECT (basesink, "do_sync returned %s", gst_flow_get_name (ret));
2970 GST_DEBUG_OBJECT (basesink, "buffer late, dropping");
2972 if (g_atomic_int_get (&priv->qos_enabled)) {
2973 GstMessage *qos_msg;
2974 GstClockTime timestamp, duration;
2976 timestamp = GST_BUFFER_TIMESTAMP (GST_BUFFER_CAST (sync_obj));
2977 duration = GST_BUFFER_DURATION (GST_BUFFER_CAST (sync_obj));
2979 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2980 "qos: dropped buffer rt %" GST_TIME_FORMAT ", st %" GST_TIME_FORMAT
2981 ", ts %" GST_TIME_FORMAT ", dur %" GST_TIME_FORMAT,
2982 GST_TIME_ARGS (priv->current_rstart),
2983 GST_TIME_ARGS (priv->current_sstart), GST_TIME_ARGS (timestamp),
2984 GST_TIME_ARGS (duration));
2985 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2986 "qos: rendered %" G_GUINT64_FORMAT ", dropped %" G_GUINT64_FORMAT,
2987 priv->rendered, priv->dropped);
2990 gst_message_new_qos (GST_OBJECT_CAST (basesink), basesink->sync,
2991 priv->current_rstart, priv->current_sstart, timestamp, duration);
2992 gst_message_set_qos_values (qos_msg, priv->current_jitter, priv->avg_rate,
2994 gst_message_set_qos_stats (qos_msg, GST_FORMAT_BUFFERS, priv->rendered,
2996 gst_element_post_message (GST_ELEMENT_CAST (basesink), qos_msg);
3002 GST_DEBUG_OBJECT (basesink, "we are flushing, ignore object");
3003 gst_mini_object_unref (obj);
3004 return GST_FLOW_WRONG_STATE;
3008 /* with STREAM_LOCK, PREROLL_LOCK
3010 * Perform preroll on the given object. For buffers this means
3011 * calling the preroll subclass method.
3012 * If that succeeds, the state will be commited.
3014 * function does not take ownership of obj.
3016 static GstFlowReturn
3017 gst_base_sink_preroll_object (GstBaseSink * basesink, guint8 obj_type,
3018 GstMiniObject * obj)
3022 GST_DEBUG_OBJECT (basesink, "prerolling object %p", obj);
3024 /* if it's a buffer, we need to call the preroll method */
3025 if (G_LIKELY (OBJ_IS_BUFFERFULL (obj_type) && basesink->priv->call_preroll)) {
3026 GstBaseSinkClass *bclass;
3028 GstClockTime timestamp;
3030 if (OBJ_IS_BUFFERLIST (obj_type)) {
3031 buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0, 0);
3032 g_assert (NULL != buf);
3034 buf = GST_BUFFER_CAST (obj);
3037 timestamp = GST_BUFFER_TIMESTAMP (buf);
3039 GST_DEBUG_OBJECT (basesink, "preroll buffer %" GST_TIME_FORMAT,
3040 GST_TIME_ARGS (timestamp));
3043 * For buffer lists do not set last buffer. Creating buffer
3044 * with meaningful data can be done only with memcpy which will
3045 * significantly affect performance
3047 if (!OBJ_IS_BUFFERLIST (obj_type)) {
3048 gst_base_sink_set_last_buffer (basesink, buf);
3051 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3052 if (bclass->preroll)
3053 if ((ret = bclass->preroll (basesink, buf)) != GST_FLOW_OK)
3054 goto preroll_failed;
3056 basesink->priv->call_preroll = FALSE;
3060 if (G_LIKELY (basesink->playing_async)) {
3061 if (G_UNLIKELY (!gst_base_sink_commit_state (basesink)))
3070 GST_DEBUG_OBJECT (basesink, "preroll failed, abort state");
3071 gst_element_abort_state (GST_ELEMENT_CAST (basesink));
3076 GST_DEBUG_OBJECT (basesink, "stopping while commiting state");
3077 return GST_FLOW_WRONG_STATE;
3081 /* with STREAM_LOCK, PREROLL_LOCK
3083 * Queue an object for rendering.
3084 * The first prerollable object queued will complete the preroll. If the
3085 * preroll queue if filled, we render all the objects in the queue.
3087 * This function takes ownership of the object.
3089 static GstFlowReturn
3090 gst_base_sink_queue_object_unlocked (GstBaseSink * basesink, GstPad * pad,
3091 guint8 obj_type, gpointer obj, gboolean prerollable)
3093 GstFlowReturn ret = GST_FLOW_OK;
3097 if (G_UNLIKELY (basesink->need_preroll)) {
3098 if (G_LIKELY (prerollable))
3099 basesink->preroll_queued++;
3101 length = basesink->preroll_queued;
3103 GST_DEBUG_OBJECT (basesink, "now %d prerolled items", length);
3105 /* first prerollable item needs to finish the preroll */
3107 ret = gst_base_sink_preroll_object (basesink, obj_type, obj);
3108 if (G_UNLIKELY (ret != GST_FLOW_OK))
3109 goto preroll_failed;
3111 /* need to recheck if we need preroll, commmit state during preroll
3112 * could have made us not need more preroll. */
3113 if (G_UNLIKELY (basesink->need_preroll)) {
3114 /* see if we can render now, if we can't add the object to the preroll
3116 if (G_UNLIKELY (length <= basesink->preroll_queue_max_len))
3120 /* we can start rendering (or blocking) the queued object
3122 q = basesink->preroll_queue;
3123 while (G_UNLIKELY (!g_queue_is_empty (q))) {
3126 o = g_queue_pop_head (q);
3127 GST_DEBUG_OBJECT (basesink, "rendering queued object %p", o);
3129 /* do something with the return value */
3131 gst_base_sink_render_object (basesink, pad,
3132 GST_IS_BUFFER (o) ? _PR_IS_BUFFER : _PR_IS_EVENT, o);
3133 if (ret != GST_FLOW_OK)
3134 goto dequeue_failed;
3137 /* now render the object */
3138 ret = gst_base_sink_render_object (basesink, pad, obj_type, obj);
3139 basesink->preroll_queued = 0;
3146 GST_DEBUG_OBJECT (basesink, "preroll failed, reason %s",
3147 gst_flow_get_name (ret));
3148 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3153 /* add object to the queue and return */
3154 GST_DEBUG_OBJECT (basesink, "need more preroll data %d <= %d",
3155 length, basesink->preroll_queue_max_len);
3156 g_queue_push_tail (basesink->preroll_queue, obj);
3161 GST_DEBUG_OBJECT (basesink, "rendering queued objects failed, reason %s",
3162 gst_flow_get_name (ret));
3163 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3170 * This function grabs the PREROLL_LOCK and adds the object to
3173 * This function takes ownership of obj.
3175 * Note: Only GstEvent seem to be passed to this private method
3177 static GstFlowReturn
3178 gst_base_sink_queue_object (GstBaseSink * basesink, GstPad * pad,
3179 GstMiniObject * obj, gboolean prerollable)
3183 GST_PAD_PREROLL_LOCK (pad);
3184 if (G_UNLIKELY (basesink->flushing))
3187 if (G_UNLIKELY (basesink->priv->received_eos))
3191 gst_base_sink_queue_object_unlocked (basesink, pad, _PR_IS_EVENT, obj,
3193 GST_PAD_PREROLL_UNLOCK (pad);
3200 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3201 GST_PAD_PREROLL_UNLOCK (pad);
3202 gst_mini_object_unref (obj);
3203 return GST_FLOW_WRONG_STATE;
3207 GST_DEBUG_OBJECT (basesink,
3208 "we are EOS, dropping object, return UNEXPECTED");
3209 GST_PAD_PREROLL_UNLOCK (pad);
3210 gst_mini_object_unref (obj);
3211 return GST_FLOW_UNEXPECTED;
3216 gst_base_sink_flush_start (GstBaseSink * basesink, GstPad * pad)
3218 /* make sure we are not blocked on the clock also clear any pending
3220 gst_base_sink_set_flushing (basesink, pad, TRUE);
3222 /* we grab the stream lock but that is not needed since setting the
3223 * sink to flushing would make sure no state commit is being done
3225 GST_PAD_STREAM_LOCK (pad);
3226 gst_base_sink_reset_qos (basesink);
3227 if (basesink->priv->async_enabled) {
3228 /* and we need to commit our state again on the next
3229 * prerolled buffer */
3230 basesink->playing_async = TRUE;
3231 gst_element_lost_state (GST_ELEMENT_CAST (basesink));
3233 basesink->priv->have_latency = TRUE;
3234 basesink->need_preroll = FALSE;
3236 gst_base_sink_set_last_buffer (basesink, NULL);
3237 GST_PAD_STREAM_UNLOCK (pad);
3241 gst_base_sink_flush_stop (GstBaseSink * basesink, GstPad * pad)
3243 /* unset flushing so we can accept new data, this also flushes out any EOS
3245 gst_base_sink_set_flushing (basesink, pad, FALSE);
3247 /* for position reporting */
3248 GST_OBJECT_LOCK (basesink);
3249 basesink->priv->current_sstart = GST_CLOCK_TIME_NONE;
3250 basesink->priv->current_sstop = GST_CLOCK_TIME_NONE;
3251 basesink->priv->eos_rtime = GST_CLOCK_TIME_NONE;
3252 basesink->priv->call_preroll = TRUE;
3253 basesink->priv->current_step.valid = FALSE;
3254 basesink->priv->pending_step.valid = FALSE;
3255 if (basesink->pad_mode == GST_ACTIVATE_PUSH) {
3256 /* we need new segment info after the flush. */
3257 basesink->have_newsegment = FALSE;
3258 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
3259 gst_segment_init (basesink->abidata.ABI.clip_segment, GST_FORMAT_UNDEFINED);
3261 GST_OBJECT_UNLOCK (basesink);
3265 gst_base_sink_event (GstPad * pad, GstEvent * event)
3267 GstBaseSink *basesink;
3268 gboolean result = TRUE;
3269 GstBaseSinkClass *bclass;
3271 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3273 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3275 GST_DEBUG_OBJECT (basesink, "reveived event %p %" GST_PTR_FORMAT, event,
3278 switch (GST_EVENT_TYPE (event)) {
3283 GST_PAD_PREROLL_LOCK (pad);
3284 if (G_UNLIKELY (basesink->flushing))
3287 if (G_UNLIKELY (basesink->priv->received_eos)) {
3288 /* we can't accept anything when we are EOS */
3290 gst_event_unref (event);
3292 /* we set the received EOS flag here so that we can use it when testing if
3293 * we are prerolled and to refuse more buffers. */
3294 basesink->priv->received_eos = TRUE;
3296 /* EOS is a prerollable object, we call the unlocked version because it
3297 * does not check the received_eos flag. */
3298 ret = gst_base_sink_queue_object_unlocked (basesink, pad,
3299 _PR_IS_EVENT, GST_MINI_OBJECT_CAST (event), TRUE);
3300 if (G_UNLIKELY (ret != GST_FLOW_OK))
3303 GST_PAD_PREROLL_UNLOCK (pad);
3306 case GST_EVENT_NEWSEGMENT:
3311 GST_DEBUG_OBJECT (basesink, "newsegment %p", event);
3313 GST_PAD_PREROLL_LOCK (pad);
3314 if (G_UNLIKELY (basesink->flushing))
3317 gst_event_parse_new_segment_full (event, &update, NULL, NULL, NULL, NULL,
3320 if (G_UNLIKELY (basesink->priv->received_eos && !update)) {
3321 /* we can't accept anything when we are EOS */
3323 gst_event_unref (event);
3325 /* the new segment is a non prerollable item and does not block anything,
3326 * we need to configure the current clipping segment and insert the event
3327 * in the queue to serialize it with the buffers for rendering. */
3328 gst_base_sink_configure_segment (basesink, pad, event,
3329 basesink->abidata.ABI.clip_segment);
3332 gst_base_sink_queue_object_unlocked (basesink, pad,
3333 _PR_IS_EVENT, GST_MINI_OBJECT_CAST (event), FALSE);
3334 if (G_UNLIKELY (ret != GST_FLOW_OK))
3337 GST_OBJECT_LOCK (basesink);
3338 basesink->have_newsegment = TRUE;
3339 GST_OBJECT_UNLOCK (basesink);
3342 GST_PAD_PREROLL_UNLOCK (pad);
3345 case GST_EVENT_FLUSH_START:
3347 bclass->event (basesink, event);
3349 GST_DEBUG_OBJECT (basesink, "flush-start %p", event);
3351 gst_base_sink_flush_start (basesink, pad);
3353 gst_event_unref (event);
3355 case GST_EVENT_FLUSH_STOP:
3357 bclass->event (basesink, event);
3359 GST_DEBUG_OBJECT (basesink, "flush-stop %p", event);
3361 gst_base_sink_flush_stop (basesink, pad);
3363 gst_event_unref (event);
3366 /* other events are sent to queue or subclass depending on if they
3367 * are serialized. */
3368 if (GST_EVENT_IS_SERIALIZED (event)) {
3369 gst_base_sink_queue_object (basesink, pad,
3370 GST_MINI_OBJECT_CAST (event), FALSE);
3373 bclass->event (basesink, event);
3374 gst_event_unref (event);
3379 gst_object_unref (basesink);
3386 GST_DEBUG_OBJECT (basesink, "we are flushing");
3387 GST_PAD_PREROLL_UNLOCK (pad);
3389 gst_event_unref (event);
3394 /* default implementation to calculate the start and end
3395 * timestamps on a buffer, subclasses can override
3398 gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
3399 GstClockTime * start, GstClockTime * end)
3401 GstClockTime timestamp, duration;
3403 timestamp = GST_BUFFER_TIMESTAMP (buffer);
3404 if (GST_CLOCK_TIME_IS_VALID (timestamp)) {
3406 /* get duration to calculate end time */
3407 duration = GST_BUFFER_DURATION (buffer);
3408 if (GST_CLOCK_TIME_IS_VALID (duration)) {
3409 *end = timestamp + duration;
3415 /* must be called with PREROLL_LOCK */
3417 gst_base_sink_needs_preroll (GstBaseSink * basesink)
3419 gboolean is_prerolled, res;
3421 /* we have 2 cases where the PREROLL_LOCK is released:
3422 * 1) we are blocking in the PREROLL_LOCK and thus are prerolled.
3423 * 2) we are syncing on the clock
3425 is_prerolled = basesink->have_preroll || basesink->priv->received_eos;
3426 res = !is_prerolled;
3428 GST_DEBUG_OBJECT (basesink, "have_preroll: %d, EOS: %d => needs preroll: %d",
3429 basesink->have_preroll, basesink->priv->received_eos, res);
3434 /* with STREAM_LOCK, PREROLL_LOCK
3436 * Takes a buffer and compare the timestamps with the last segment.
3437 * If the buffer falls outside of the segment boundaries, drop it.
3438 * Else queue the buffer for preroll and rendering.
3440 * This function takes ownership of the buffer.
3442 static GstFlowReturn
3443 gst_base_sink_chain_unlocked (GstBaseSink * basesink, GstPad * pad,
3444 guint8 obj_type, gpointer obj)
3446 GstBaseSinkClass *bclass;
3447 GstFlowReturn result;
3448 GstClockTime start = GST_CLOCK_TIME_NONE, end = GST_CLOCK_TIME_NONE;
3449 GstSegment *clip_segment;
3450 GstBuffer *time_buf;
3452 if (G_UNLIKELY (basesink->flushing))
3455 if (G_UNLIKELY (basesink->priv->received_eos))
3458 if (OBJ_IS_BUFFERLIST (obj_type)) {
3459 time_buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0, 0);
3460 g_assert (NULL != time_buf);
3462 time_buf = GST_BUFFER_CAST (obj);
3465 /* for code clarity */
3466 clip_segment = basesink->abidata.ABI.clip_segment;
3468 if (G_UNLIKELY (!basesink->have_newsegment)) {
3471 sync = gst_base_sink_get_sync (basesink);
3473 GST_ELEMENT_WARNING (basesink, STREAM, FAILED,
3474 (_("Internal data flow problem.")),
3475 ("Received buffer without a new-segment. Assuming timestamps start from 0."));
3478 /* this means this sink will assume timestamps start from 0 */
3479 GST_OBJECT_LOCK (basesink);
3480 clip_segment->start = 0;
3481 clip_segment->stop = -1;
3482 basesink->segment.start = 0;
3483 basesink->segment.stop = -1;
3484 basesink->have_newsegment = TRUE;
3485 GST_OBJECT_UNLOCK (basesink);
3488 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3490 /* check if the buffer needs to be dropped, we first ask the subclass for the
3492 if (bclass->get_times)
3493 bclass->get_times (basesink, time_buf, &start, &end);
3495 if (!GST_CLOCK_TIME_IS_VALID (start)) {
3496 /* if the subclass does not want sync, we use our own values so that we at
3497 * least clip the buffer to the segment */
3498 gst_base_sink_get_times (basesink, time_buf, &start, &end);
3501 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
3502 ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (end));
3504 /* a dropped buffer does not participate in anything */
3505 if (GST_CLOCK_TIME_IS_VALID (start) &&
3506 (clip_segment->format == GST_FORMAT_TIME)) {
3507 if (G_UNLIKELY (!gst_segment_clip (clip_segment,
3508 GST_FORMAT_TIME, (gint64) start, (gint64) end, NULL, NULL)))
3509 goto out_of_segment;
3512 /* now we can process the buffer in the queue, this function takes ownership
3514 result = gst_base_sink_queue_object_unlocked (basesink, pad,
3515 obj_type, obj, TRUE);
3521 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3522 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3523 return GST_FLOW_WRONG_STATE;
3527 GST_DEBUG_OBJECT (basesink,
3528 "we are EOS, dropping object, return UNEXPECTED");
3529 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3530 return GST_FLOW_UNEXPECTED;
3534 GST_DEBUG_OBJECT (basesink, "dropping buffer, out of clipping segment");
3535 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3542 static GstFlowReturn
3543 gst_base_sink_chain_main (GstBaseSink * basesink, GstPad * pad,
3544 guint8 obj_type, gpointer obj)
3546 GstFlowReturn result;
3548 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH))
3551 GST_PAD_PREROLL_LOCK (pad);
3552 result = gst_base_sink_chain_unlocked (basesink, pad, obj_type, obj);
3553 GST_PAD_PREROLL_UNLOCK (pad);
3561 GST_OBJECT_LOCK (pad);
3562 GST_WARNING_OBJECT (basesink,
3563 "Push on pad %s:%s, but it was not activated in push mode",
3564 GST_DEBUG_PAD_NAME (pad));
3565 GST_OBJECT_UNLOCK (pad);
3566 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3567 /* we don't post an error message this will signal to the peer
3568 * pushing that EOS is reached. */
3569 result = GST_FLOW_UNEXPECTED;
3574 static GstFlowReturn
3575 gst_base_sink_chain (GstPad * pad, GstBuffer * buf)
3577 GstBaseSink *basesink;
3579 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3581 return gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFER, buf);
3584 static GstFlowReturn
3585 gst_base_sink_chain_list (GstPad * pad, GstBufferList * list)
3587 GstBaseSink *basesink;
3588 GstBaseSinkClass *bclass;
3589 GstFlowReturn result;
3591 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3592 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3594 if (G_LIKELY (bclass->render_list)) {
3595 result = gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFERLIST, list);
3597 GstBufferListIterator *it;
3600 GST_INFO_OBJECT (pad, "chaining each group in list as a merged buffer");
3602 it = gst_buffer_list_iterate (list);
3604 if (gst_buffer_list_iterator_next_group (it)) {
3606 group = gst_buffer_list_iterator_merge_group (it);
3607 if (group == NULL) {
3608 group = gst_buffer_new ();
3609 GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining empty group");
3611 GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining group");
3613 result = gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFER, group);
3614 } while (result == GST_FLOW_OK
3615 && gst_buffer_list_iterator_next_group (it));
3617 GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining empty group");
3619 gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFER,
3622 gst_buffer_list_iterator_free (it);
3623 gst_buffer_list_unref (list);
3630 gst_base_sink_default_do_seek (GstBaseSink * sink, GstSegment * segment)
3632 gboolean res = TRUE;
3634 /* update our offset if the start/stop position was updated */
3635 if (segment->format == GST_FORMAT_BYTES) {
3636 segment->time = segment->start;
3637 } else if (segment->start == 0) {
3638 /* seek to start, we can implement a default for this. */
3642 GST_INFO_OBJECT (sink, "Can't do a default seek");
3648 #define SEEK_TYPE_IS_RELATIVE(t) (((t) != GST_SEEK_TYPE_NONE) && ((t) != GST_SEEK_TYPE_SET))
3651 gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
3652 GstEvent * event, GstSegment * segment)
3654 /* By default, we try one of 2 things:
3655 * - For absolute seek positions, convert the requested position to our
3656 * configured processing format and place it in the output segment \
3657 * - For relative seek positions, convert our current (input) values to the
3658 * seek format, adjust by the relative seek offset and then convert back to
3659 * the processing format
3661 GstSeekType cur_type, stop_type;
3664 GstFormat seek_format, dest_format;
3667 gboolean res = TRUE;
3669 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3670 &cur_type, &cur, &stop_type, &stop);
3671 dest_format = segment->format;
3673 if (seek_format == dest_format) {
3674 gst_segment_set_seek (segment, rate, seek_format, flags,
3675 cur_type, cur, stop_type, stop, &update);
3679 if (cur_type != GST_SEEK_TYPE_NONE) {
3680 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3682 gst_pad_query_convert (sink->sinkpad, seek_format, cur, &dest_format,
3684 cur_type = GST_SEEK_TYPE_SET;
3687 if (res && stop_type != GST_SEEK_TYPE_NONE) {
3688 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3690 gst_pad_query_convert (sink->sinkpad, seek_format, stop, &dest_format,
3692 stop_type = GST_SEEK_TYPE_SET;
3695 /* And finally, configure our output segment in the desired format */
3696 gst_segment_set_seek (segment, rate, dest_format, flags, cur_type, cur,
3697 stop_type, stop, &update);
3706 GST_DEBUG_OBJECT (sink, "undefined format given, seek aborted.");
3711 /* perform a seek, only executed in pull mode */
3713 gst_base_sink_perform_seek (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3717 GstFormat seek_format, dest_format;
3719 GstSeekType cur_type, stop_type;
3720 gboolean seekseg_configured = FALSE;
3722 gboolean update, res = TRUE;
3723 GstSegment seeksegment;
3725 dest_format = sink->segment.format;
3728 GST_DEBUG_OBJECT (sink, "performing seek with event %p", event);
3729 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3730 &cur_type, &cur, &stop_type, &stop);
3732 flush = flags & GST_SEEK_FLAG_FLUSH;
3734 GST_DEBUG_OBJECT (sink, "performing seek without event");
3739 GST_DEBUG_OBJECT (sink, "flushing upstream");
3740 gst_pad_push_event (pad, gst_event_new_flush_start ());
3741 gst_base_sink_flush_start (sink, pad);
3743 GST_DEBUG_OBJECT (sink, "pausing pulling thread");
3746 GST_PAD_STREAM_LOCK (pad);
3748 /* If we configured the seeksegment above, don't overwrite it now. Otherwise
3749 * copy the current segment info into the temp segment that we can actually
3750 * attempt the seek with. We only update the real segment if the seek suceeds. */
3751 if (!seekseg_configured) {
3752 memcpy (&seeksegment, &sink->segment, sizeof (GstSegment));
3754 /* now configure the final seek segment */
3756 if (sink->segment.format != seek_format) {
3757 /* OK, here's where we give the subclass a chance to convert the relative
3758 * seek into an absolute one in the processing format. We set up any
3759 * absolute seek above, before taking the stream lock. */
3760 if (!gst_base_sink_default_prepare_seek_segment (sink, event,
3762 GST_DEBUG_OBJECT (sink,
3763 "Preparing the seek failed after flushing. " "Aborting seek");
3767 /* The seek format matches our processing format, no need to ask the
3768 * the subclass to configure the segment. */
3769 gst_segment_set_seek (&seeksegment, rate, seek_format, flags,
3770 cur_type, cur, stop_type, stop, &update);
3773 /* Else, no seek event passed, so we're just (re)starting the
3778 GST_DEBUG_OBJECT (sink, "segment configured from %" G_GINT64_FORMAT
3779 " to %" G_GINT64_FORMAT ", position %" G_GINT64_FORMAT,
3780 seeksegment.start, seeksegment.stop, seeksegment.last_stop);
3782 /* do the seek, segment.last_stop contains the new position. */
3783 res = gst_base_sink_default_do_seek (sink, &seeksegment);
3788 GST_DEBUG_OBJECT (sink, "stop flushing upstream");
3789 gst_pad_push_event (pad, gst_event_new_flush_stop ());
3790 gst_base_sink_flush_stop (sink, pad);
3791 } else if (res && sink->abidata.ABI.running) {
3792 /* we are running the current segment and doing a non-flushing seek,
3793 * close the segment first based on the last_stop. */
3794 GST_DEBUG_OBJECT (sink, "closing running segment %" G_GINT64_FORMAT
3795 " to %" G_GINT64_FORMAT, sink->segment.start, sink->segment.last_stop);
3798 /* The subclass must have converted the segment to the processing format
3800 if (res && seeksegment.format != dest_format) {
3801 GST_DEBUG_OBJECT (sink, "Subclass failed to prepare a seek segment "
3802 "in the correct format. Aborting seek.");
3806 /* if successfull seek, we update our real segment and push
3807 * out the new segment. */
3809 memcpy (&sink->segment, &seeksegment, sizeof (GstSegment));
3811 if (sink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3812 gst_element_post_message (GST_ELEMENT (sink),
3813 gst_message_new_segment_start (GST_OBJECT (sink),
3814 sink->segment.format, sink->segment.last_stop));
3818 sink->priv->discont = TRUE;
3819 sink->abidata.ABI.running = TRUE;
3821 GST_PAD_STREAM_UNLOCK (pad);
3827 set_step_info (GstBaseSink * sink, GstStepInfo * current, GstStepInfo * pending,
3828 guint seqnum, GstFormat format, guint64 amount, gdouble rate,
3829 gboolean flush, gboolean intermediate)
3831 GST_OBJECT_LOCK (sink);
3832 pending->seqnum = seqnum;
3833 pending->format = format;
3834 pending->amount = amount;
3835 pending->position = 0;
3836 pending->rate = rate;
3837 pending->flush = flush;
3838 pending->intermediate = intermediate;
3839 pending->valid = TRUE;
3840 /* flush invalidates the current stepping segment */
3842 current->valid = FALSE;
3843 GST_OBJECT_UNLOCK (sink);
3847 gst_base_sink_perform_step (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3849 GstBaseSinkPrivate *priv;
3850 GstBaseSinkClass *bclass;
3851 gboolean flush, intermediate;
3856 GstStepInfo *pending, *current;
3857 GstMessage *message;
3859 bclass = GST_BASE_SINK_GET_CLASS (sink);
3862 GST_DEBUG_OBJECT (sink, "performing step with event %p", event);
3864 gst_event_parse_step (event, &format, &amount, &rate, &flush, &intermediate);
3865 seqnum = gst_event_get_seqnum (event);
3867 pending = &priv->pending_step;
3868 current = &priv->current_step;
3870 /* post message first */
3871 message = gst_message_new_step_start (GST_OBJECT (sink), FALSE, format,
3872 amount, rate, flush, intermediate);
3873 gst_message_set_seqnum (message, seqnum);
3874 gst_element_post_message (GST_ELEMENT (sink), message);
3877 /* we need to call ::unlock before locking PREROLL_LOCK
3878 * since we lock it before going into ::render */
3880 bclass->unlock (sink);
3882 GST_PAD_PREROLL_LOCK (sink->sinkpad);
3883 /* now that we have the PREROLL lock, clear our unlock request */
3884 if (bclass->unlock_stop)
3885 bclass->unlock_stop (sink);
3887 /* update the stepinfo and make it valid */
3888 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3891 if (sink->priv->async_enabled) {
3892 /* and we need to commit our state again on the next
3893 * prerolled buffer */
3894 sink->playing_async = TRUE;
3895 priv->pending_step.need_preroll = TRUE;
3896 sink->need_preroll = FALSE;
3897 gst_element_lost_state_full (GST_ELEMENT_CAST (sink), FALSE);
3899 sink->priv->have_latency = TRUE;
3900 sink->need_preroll = FALSE;
3902 priv->current_sstart = GST_CLOCK_TIME_NONE;
3903 priv->current_sstop = GST_CLOCK_TIME_NONE;
3904 priv->eos_rtime = GST_CLOCK_TIME_NONE;
3905 priv->call_preroll = TRUE;
3906 gst_base_sink_set_last_buffer (sink, NULL);
3907 gst_base_sink_reset_qos (sink);
3909 if (sink->clock_id) {
3910 gst_clock_id_unschedule (sink->clock_id);
3913 if (sink->have_preroll) {
3914 GST_DEBUG_OBJECT (sink, "signal waiter");
3915 priv->step_unlock = TRUE;
3916 GST_PAD_PREROLL_SIGNAL (sink->sinkpad);
3918 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
3920 /* update the stepinfo and make it valid */
3921 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3931 gst_base_sink_loop (GstPad * pad)
3933 GstBaseSink *basesink;
3934 GstBuffer *buf = NULL;
3935 GstFlowReturn result;
3939 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3941 g_assert (basesink->pad_mode == GST_ACTIVATE_PULL);
3943 if ((blocksize = basesink->priv->blocksize) == 0)
3946 offset = basesink->segment.last_stop;
3948 GST_DEBUG_OBJECT (basesink, "pulling %" G_GUINT64_FORMAT ", %u",
3951 result = gst_pad_pull_range (pad, offset, blocksize, &buf);
3952 if (G_UNLIKELY (result != GST_FLOW_OK))
3955 if (G_UNLIKELY (buf == NULL))
3958 offset += GST_BUFFER_SIZE (buf);
3960 gst_segment_set_last_stop (&basesink->segment, GST_FORMAT_BYTES, offset);
3962 GST_PAD_PREROLL_LOCK (pad);
3963 result = gst_base_sink_chain_unlocked (basesink, pad, _PR_IS_BUFFER, buf);
3964 GST_PAD_PREROLL_UNLOCK (pad);
3965 if (G_UNLIKELY (result != GST_FLOW_OK))
3973 GST_LOG_OBJECT (basesink, "pausing task, reason %s",
3974 gst_flow_get_name (result));
3975 gst_pad_pause_task (pad);
3976 if (result == GST_FLOW_UNEXPECTED) {
3977 /* perform EOS logic */
3978 if (basesink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3979 gst_element_post_message (GST_ELEMENT_CAST (basesink),
3980 gst_message_new_segment_done (GST_OBJECT_CAST (basesink),
3981 basesink->segment.format, basesink->segment.last_stop));
3983 gst_base_sink_event (pad, gst_event_new_eos ());
3985 } else if (result == GST_FLOW_NOT_LINKED || result <= GST_FLOW_UNEXPECTED) {
3986 /* for fatal errors we post an error message, post the error
3987 * first so the app knows about the error first.
3988 * wrong-state is not a fatal error because it happens due to
3989 * flushing and posting an error message in that case is the
3990 * wrong thing to do, e.g. when basesrc is doing a flushing
3992 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
3993 (_("Internal data stream error.")),
3994 ("stream stopped, reason %s", gst_flow_get_name (result)));
3995 gst_base_sink_event (pad, gst_event_new_eos ());
4001 GST_LOG_OBJECT (basesink, "no buffer, pausing");
4002 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
4003 (_("Internal data flow error.")), ("element returned NULL buffer"));
4004 result = GST_FLOW_ERROR;
4010 gst_base_sink_set_flushing (GstBaseSink * basesink, GstPad * pad,
4013 GstBaseSinkClass *bclass;
4015 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4018 /* unlock any subclasses, we need to do this before grabbing the
4019 * PREROLL_LOCK since we hold this lock before going into ::render. */
4021 bclass->unlock (basesink);
4024 GST_PAD_PREROLL_LOCK (pad);
4025 basesink->flushing = flushing;
4027 /* step 1, now that we have the PREROLL lock, clear our unlock request */
4028 if (bclass->unlock_stop)
4029 bclass->unlock_stop (basesink);
4031 /* set need_preroll before we unblock the clock. If the clock is unblocked
4032 * before timing out, we can reuse the buffer for preroll. */
4033 basesink->need_preroll = TRUE;
4035 /* step 2, unblock clock sync (if any) or any other blocking thing */
4036 if (basesink->clock_id) {
4037 gst_clock_id_unschedule (basesink->clock_id);
4040 /* flush out the data thread if it's locked in finish_preroll, this will
4041 * also flush out the EOS state */
4042 GST_DEBUG_OBJECT (basesink,
4043 "flushing out data thread, need preroll to TRUE");
4044 gst_base_sink_preroll_queue_flush (basesink, pad);
4046 GST_PAD_PREROLL_UNLOCK (pad);
4052 gst_base_sink_default_activate_pull (GstBaseSink * basesink, gboolean active)
4058 result = gst_pad_start_task (basesink->sinkpad,
4059 (GstTaskFunction) gst_base_sink_loop, basesink->sinkpad);
4061 /* step 2, make sure streaming finishes */
4062 result = gst_pad_stop_task (basesink->sinkpad);
4069 gst_base_sink_pad_activate (GstPad * pad)
4071 gboolean result = FALSE;
4072 GstBaseSink *basesink;
4074 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4076 GST_DEBUG_OBJECT (basesink, "Trying pull mode first");
4078 gst_base_sink_set_flushing (basesink, pad, FALSE);
4080 /* we need to have the pull mode enabled */
4081 if (!basesink->can_activate_pull) {
4082 GST_DEBUG_OBJECT (basesink, "pull mode disabled");
4086 /* check if downstreams supports pull mode at all */
4087 if (!gst_pad_check_pull_range (pad)) {
4088 GST_DEBUG_OBJECT (basesink, "pull mode not supported");
4092 /* set the pad mode before starting the task so that it's in the
4093 * correct state for the new thread. also the sink set_caps and get_caps
4094 * function checks this */
4095 basesink->pad_mode = GST_ACTIVATE_PULL;
4097 /* we first try to negotiate a format so that when we try to activate
4098 * downstream, it knows about our format */
4099 if (!gst_base_sink_negotiate_pull (basesink)) {
4100 GST_DEBUG_OBJECT (basesink, "failed to negotiate in pull mode");
4104 /* ok activate now */
4105 if (!gst_pad_activate_pull (pad, TRUE)) {
4106 /* clear any pending caps */
4107 GST_OBJECT_LOCK (basesink);
4108 gst_caps_replace (&basesink->priv->pull_caps, NULL);
4109 GST_OBJECT_UNLOCK (basesink);
4110 GST_DEBUG_OBJECT (basesink, "failed to activate in pull mode");
4114 GST_DEBUG_OBJECT (basesink, "Success activating pull mode");
4118 /* push mode fallback */
4120 GST_DEBUG_OBJECT (basesink, "Falling back to push mode");
4121 if ((result = gst_pad_activate_push (pad, TRUE))) {
4122 GST_DEBUG_OBJECT (basesink, "Success activating push mode");
4127 GST_WARNING_OBJECT (basesink, "Could not activate pad in either mode");
4128 gst_base_sink_set_flushing (basesink, pad, TRUE);
4131 gst_object_unref (basesink);
4137 gst_base_sink_pad_activate_push (GstPad * pad, gboolean active)
4140 GstBaseSink *basesink;
4142 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4145 if (!basesink->can_activate_push) {
4147 basesink->pad_mode = GST_ACTIVATE_NONE;
4150 basesink->pad_mode = GST_ACTIVATE_PUSH;
4153 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH)) {
4154 g_warning ("Internal GStreamer activation error!!!");
4157 gst_base_sink_set_flushing (basesink, pad, TRUE);
4159 basesink->pad_mode = GST_ACTIVATE_NONE;
4163 gst_object_unref (basesink);
4169 gst_base_sink_negotiate_pull (GstBaseSink * basesink)
4176 /* this returns the intersection between our caps and the peer caps. If there
4177 * is no peer, it returns NULL and we can't operate in pull mode so we can
4178 * fail the negotiation. */
4179 caps = gst_pad_get_allowed_caps (GST_BASE_SINK_PAD (basesink));
4180 if (caps == NULL || gst_caps_is_empty (caps))
4181 goto no_caps_possible;
4183 GST_DEBUG_OBJECT (basesink, "allowed caps: %" GST_PTR_FORMAT, caps);
4185 caps = gst_caps_make_writable (caps);
4186 /* get the first (prefered) format */
4187 gst_caps_truncate (caps);
4189 gst_pad_fixate_caps (GST_BASE_SINK_PAD (basesink), caps);
4191 GST_DEBUG_OBJECT (basesink, "fixated to: %" GST_PTR_FORMAT, caps);
4193 if (gst_caps_is_any (caps)) {
4194 GST_DEBUG_OBJECT (basesink, "caps were ANY after fixating, "
4196 /* neither side has template caps in this case, so they are prepared for
4197 pull() without setcaps() */
4199 } else if (gst_caps_is_fixed (caps)) {
4200 if (!gst_pad_set_caps (GST_BASE_SINK_PAD (basesink), caps))
4201 goto could_not_set_caps;
4203 GST_OBJECT_LOCK (basesink);
4204 gst_caps_replace (&basesink->priv->pull_caps, caps);
4205 GST_OBJECT_UNLOCK (basesink);
4210 gst_caps_unref (caps);
4216 GST_INFO_OBJECT (basesink, "Pipeline could not agree on caps");
4217 GST_DEBUG_OBJECT (basesink, "get_allowed_caps() returned EMPTY");
4219 gst_caps_unref (caps);
4224 GST_INFO_OBJECT (basesink, "Could not set caps: %" GST_PTR_FORMAT, caps);
4225 gst_caps_unref (caps);
4230 /* this won't get called until we implement an activate function */
4232 gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active)
4234 gboolean result = FALSE;
4235 GstBaseSink *basesink;
4236 GstBaseSinkClass *bclass;
4238 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4239 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4245 /* we mark we have a newsegment here because pull based
4246 * mode works just fine without having a newsegment before the
4248 format = GST_FORMAT_BYTES;
4250 gst_segment_init (&basesink->segment, format);
4251 gst_segment_init (basesink->abidata.ABI.clip_segment, format);
4252 GST_OBJECT_LOCK (basesink);
4253 basesink->have_newsegment = TRUE;
4254 GST_OBJECT_UNLOCK (basesink);
4256 /* get the peer duration in bytes */
4257 result = gst_pad_query_peer_duration (pad, &format, &duration);
4259 GST_DEBUG_OBJECT (basesink,
4260 "setting duration in bytes to %" G_GINT64_FORMAT, duration);
4261 gst_segment_set_duration (basesink->abidata.ABI.clip_segment, format,
4263 gst_segment_set_duration (&basesink->segment, format, duration);
4265 GST_DEBUG_OBJECT (basesink, "unknown duration");
4268 if (bclass->activate_pull)
4269 result = bclass->activate_pull (basesink, TRUE);
4274 goto activate_failed;
4277 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PULL)) {
4278 g_warning ("Internal GStreamer activation error!!!");
4281 result = gst_base_sink_set_flushing (basesink, pad, TRUE);
4282 if (bclass->activate_pull)
4283 result &= bclass->activate_pull (basesink, FALSE);
4284 basesink->pad_mode = GST_ACTIVATE_NONE;
4285 /* clear any pending caps */
4286 GST_OBJECT_LOCK (basesink);
4287 gst_caps_replace (&basesink->priv->pull_caps, NULL);
4288 GST_OBJECT_UNLOCK (basesink);
4291 gst_object_unref (basesink);
4298 /* reset, as starting the thread failed */
4299 basesink->pad_mode = GST_ACTIVATE_NONE;
4301 GST_ERROR_OBJECT (basesink, "subclass failed to activate in pull mode");
4306 /* send an event to our sinkpad peer. */
4308 gst_base_sink_send_event (GstElement * element, GstEvent * event)
4311 GstBaseSink *basesink = GST_BASE_SINK (element);
4312 gboolean forward, result = TRUE;
4313 GstActivateMode mode;
4315 GST_OBJECT_LOCK (element);
4316 /* get the pad and the scheduling mode */
4317 pad = gst_object_ref (basesink->sinkpad);
4318 mode = basesink->pad_mode;
4319 GST_OBJECT_UNLOCK (element);
4321 /* only push UPSTREAM events upstream */
4322 forward = GST_EVENT_IS_UPSTREAM (event);
4324 GST_DEBUG_OBJECT (basesink, "handling event %p %" GST_PTR_FORMAT, event,
4327 switch (GST_EVENT_TYPE (event)) {
4328 case GST_EVENT_LATENCY:
4330 GstClockTime latency;
4332 gst_event_parse_latency (event, &latency);
4334 /* store the latency. We use this to adjust the running_time before syncing
4335 * it to the clock. */
4336 GST_OBJECT_LOCK (element);
4337 basesink->priv->latency = latency;
4338 if (!basesink->priv->have_latency)
4340 GST_OBJECT_UNLOCK (element);
4341 GST_DEBUG_OBJECT (basesink, "latency set to %" GST_TIME_FORMAT,
4342 GST_TIME_ARGS (latency));
4344 /* We forward this event so that all elements know about the global pipeline
4345 * latency. This is interesting for an element when it wants to figure out
4346 * when a particular piece of data will be rendered. */
4349 case GST_EVENT_SEEK:
4350 /* in pull mode we will execute the seek */
4351 if (mode == GST_ACTIVATE_PULL)
4352 result = gst_base_sink_perform_seek (basesink, pad, event);
4354 case GST_EVENT_STEP:
4355 result = gst_base_sink_perform_step (basesink, pad, event);
4363 result = gst_pad_push_event (pad, event);
4365 /* not forwarded, unref the event */
4366 gst_event_unref (event);
4369 gst_object_unref (pad);
4373 /* get the end position of the last seen object, this is used
4374 * for EOS and for making sure that we don't report a position we
4375 * have not reached yet. With LOCK. */
4377 gst_base_sink_get_position_last (GstBaseSink * basesink, GstFormat format,
4378 gint64 * cur, gboolean * upstream)
4381 GstSegment *segment;
4382 gboolean ret = TRUE;
4384 segment = &basesink->segment;
4385 oformat = segment->format;
4387 if (oformat == GST_FORMAT_TIME) {
4388 /* return last observed stream time, we keep the stream time around in the
4390 *cur = basesink->priv->current_sstop;
4392 /* convert last stop to stream time */
4393 *cur = gst_segment_to_stream_time (segment, oformat, segment->last_stop);
4396 if (*cur != -1 && oformat != format) {
4397 GST_OBJECT_UNLOCK (basesink);
4398 /* convert to the target format if we need to, release lock first */
4400 gst_pad_query_convert (basesink->sinkpad, oformat, *cur, &format, cur);
4405 GST_OBJECT_LOCK (basesink);
4408 GST_DEBUG_OBJECT (basesink, "POSITION: %" GST_TIME_FORMAT,
4409 GST_TIME_ARGS (*cur));
4414 /* get the position when we are PAUSED, this is the stream time of the buffer
4415 * that prerolled. If no buffer is prerolled (we are still flushing), this
4416 * value will be -1. With LOCK. */
4418 gst_base_sink_get_position_paused (GstBaseSink * basesink, GstFormat format,
4419 gint64 * cur, gboolean * upstream)
4423 GstSegment *segment;
4426 /* we don't use the clip segment in pull mode, when seeking we update the
4427 * main segment directly with the new segment values without it having to be
4428 * activated by the rendering after preroll */
4429 if (basesink->pad_mode == GST_ACTIVATE_PUSH)
4430 segment = basesink->abidata.ABI.clip_segment;
4432 segment = &basesink->segment;
4433 oformat = segment->format;
4435 if (oformat == GST_FORMAT_TIME) {
4436 *cur = basesink->priv->current_sstart;
4437 if (segment->rate < 0.0 &&
4438 GST_CLOCK_TIME_IS_VALID (basesink->priv->current_sstop)) {
4439 /* for reverse playback we prefer the stream time stop position if we have
4441 *cur = basesink->priv->current_sstop;
4444 *cur = gst_segment_to_stream_time (segment, oformat, segment->last_stop);
4447 time = segment->time;
4450 *cur = MAX (*cur, time);
4451 GST_DEBUG_OBJECT (basesink, "POSITION as max: %" GST_TIME_FORMAT
4452 ", time %" GST_TIME_FORMAT, GST_TIME_ARGS (*cur), GST_TIME_ARGS (time));
4454 /* we have no buffer, use the segment times. */
4455 if (segment->rate >= 0.0) {
4456 /* forward, next position is always the time of the segment */
4458 GST_DEBUG_OBJECT (basesink, "POSITION as time: %" GST_TIME_FORMAT,
4459 GST_TIME_ARGS (*cur));
4461 /* reverse, next expected timestamp is segment->stop. We use the function
4462 * to get things right for negative applied_rates. */
4463 *cur = gst_segment_to_stream_time (segment, oformat, segment->stop);
4464 GST_DEBUG_OBJECT (basesink, "reverse POSITION: %" GST_TIME_FORMAT,
4465 GST_TIME_ARGS (*cur));
4470 if (res && oformat != format) {
4471 GST_OBJECT_UNLOCK (basesink);
4473 gst_pad_query_convert (basesink->sinkpad, oformat, *cur, &format, cur);
4478 GST_OBJECT_LOCK (basesink);
4485 gst_base_sink_get_position (GstBaseSink * basesink, GstFormat format,
4486 gint64 * cur, gboolean * upstream)
4489 gboolean res = FALSE;
4490 GstFormat oformat, tformat;
4491 GstClockTime now, latency;
4492 GstClockTimeDiff base;
4493 gint64 time, accum, duration;
4497 GST_OBJECT_LOCK (basesink);
4498 /* our intermediate time format */
4499 tformat = GST_FORMAT_TIME;
4500 /* get the format in the segment */
4501 oformat = basesink->segment.format;
4503 /* can only give answer based on the clock if not EOS */
4504 if (G_UNLIKELY (basesink->eos))
4507 /* we can only get the segment when we are not NULL or READY */
4508 if (!basesink->have_newsegment)
4511 /* when not in PLAYING or when we're busy with a state change, we
4512 * cannot read from the clock so we report time based on the
4513 * last seen timestamp. */
4514 if (GST_STATE (basesink) != GST_STATE_PLAYING ||
4515 GST_STATE_PENDING (basesink) != GST_STATE_VOID_PENDING)
4518 /* we need to sync on the clock. */
4519 if (basesink->sync == FALSE)
4522 /* and we need a clock */
4523 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (basesink)) == NULL))
4526 /* collect all data we need holding the lock */
4527 if (GST_CLOCK_TIME_IS_VALID (basesink->segment.time))
4528 time = basesink->segment.time;
4532 if (GST_CLOCK_TIME_IS_VALID (basesink->segment.stop))
4533 duration = basesink->segment.stop - basesink->segment.start;
4537 base = GST_ELEMENT_CAST (basesink)->base_time;
4538 accum = basesink->segment.accum;
4539 rate = basesink->segment.rate * basesink->segment.applied_rate;
4540 latency = basesink->priv->latency;
4542 gst_object_ref (clock);
4544 /* this function might release the LOCK */
4545 gst_base_sink_get_position_last (basesink, format, &last, upstream);
4547 /* need to release the object lock before we can get the time,
4548 * a clock might take the LOCK of the provider, which could be
4549 * a basesink subclass. */
4550 GST_OBJECT_UNLOCK (basesink);
4552 now = gst_clock_get_time (clock);
4554 if (oformat != tformat) {
4555 /* convert accum, time and duration to time */
4556 if (!gst_pad_query_convert (basesink->sinkpad, oformat, accum, &tformat,
4558 goto convert_failed;
4559 if (!gst_pad_query_convert (basesink->sinkpad, oformat, duration, &tformat,
4561 goto convert_failed;
4562 if (!gst_pad_query_convert (basesink->sinkpad, oformat, time, &tformat,
4564 goto convert_failed;
4567 /* subtract base time and accumulated time from the clock time.
4568 * Make sure we don't go negative. This is the current time in
4569 * the segment which we need to scale with the combined
4570 * rate and applied rate. */
4573 if (GST_CLOCK_DIFF (base, now) < 0)
4576 /* for negative rates we need to count back from the segment
4581 *cur = time + gst_guint64_to_gdouble (now - base) * rate;
4583 /* never report more than last seen position */
4585 *cur = MIN (last, *cur);
4587 gst_object_unref (clock);
4589 GST_DEBUG_OBJECT (basesink,
4590 "now %" GST_TIME_FORMAT " - base %" GST_TIME_FORMAT " - accum %"
4591 GST_TIME_FORMAT " + time %" GST_TIME_FORMAT,
4592 GST_TIME_ARGS (now), GST_TIME_ARGS (base),
4593 GST_TIME_ARGS (accum), GST_TIME_ARGS (time));
4595 if (oformat != format) {
4596 /* convert time to final format */
4597 if (!gst_pad_query_convert (basesink->sinkpad, tformat, *cur, &format, cur))
4598 goto convert_failed;
4604 GST_DEBUG_OBJECT (basesink, "res: %d, POSITION: %" GST_TIME_FORMAT,
4605 res, GST_TIME_ARGS (*cur));
4611 GST_DEBUG_OBJECT (basesink, "position in EOS");
4612 res = gst_base_sink_get_position_last (basesink, format, cur, upstream);
4613 GST_OBJECT_UNLOCK (basesink);
4618 GST_DEBUG_OBJECT (basesink, "position in PAUSED");
4619 res = gst_base_sink_get_position_paused (basesink, format, cur, upstream);
4620 GST_OBJECT_UNLOCK (basesink);
4625 /* in NULL or READY we always return FALSE and -1 */
4626 GST_DEBUG_OBJECT (basesink, "position in wrong state, return -1");
4629 GST_OBJECT_UNLOCK (basesink);
4634 /* report last seen timestamp if any, else ask upstream to answer */
4635 if ((*cur = basesink->priv->current_sstart) != -1)
4640 GST_DEBUG_OBJECT (basesink, "no sync, res %d, POSITION %" GST_TIME_FORMAT,
4641 res, GST_TIME_ARGS (*cur));
4642 GST_OBJECT_UNLOCK (basesink);
4647 GST_DEBUG_OBJECT (basesink, "convert failed, try upstream");
4654 gst_base_sink_get_duration (GstBaseSink * basesink, GstFormat format,
4655 gint64 * dur, gboolean * upstream)
4657 gboolean res = FALSE;
4659 if (basesink->pad_mode == GST_ACTIVATE_PULL) {
4660 GstFormat uformat = GST_FORMAT_BYTES;
4663 /* get the duration in bytes, in pull mode that's all we are sure to
4664 * know. We have to explicitly get this value from upstream instead of
4665 * using our cached value because it might change. Duration caching
4666 * should be done at a higher level. */
4667 res = gst_pad_query_peer_duration (basesink->sinkpad, &uformat, &uduration);
4669 gst_segment_set_duration (&basesink->segment, uformat, uduration);
4670 if (format != uformat) {
4671 /* convert to the requested format */
4672 res = gst_pad_query_convert (basesink->sinkpad, uformat, uduration,
4686 static const GstQueryType *
4687 gst_base_sink_get_query_types (GstElement * element)
4689 static const GstQueryType query_types[] = {
4701 gst_base_sink_query (GstElement * element, GstQuery * query)
4703 gboolean res = FALSE;
4705 GstBaseSink *basesink = GST_BASE_SINK (element);
4707 switch (GST_QUERY_TYPE (query)) {
4708 case GST_QUERY_POSITION:
4712 gboolean upstream = FALSE;
4714 gst_query_parse_position (query, &format, NULL);
4716 GST_DEBUG_OBJECT (basesink, "position query in format %s",
4717 gst_format_get_name (format));
4719 /* first try to get the position based on the clock */
4721 gst_base_sink_get_position (basesink, format, &cur, &upstream))) {
4722 gst_query_set_position (query, format, cur);
4723 } else if (upstream) {
4724 /* fallback to peer query */
4725 res = gst_pad_peer_query (basesink->sinkpad, query);
4728 /* we can handle a few things if upstream failed */
4729 if (format == GST_FORMAT_PERCENT) {
4731 GstFormat uformat = GST_FORMAT_TIME;
4733 res = gst_base_sink_get_position (basesink, GST_FORMAT_TIME, &cur,
4735 if (!res && upstream) {
4736 res = gst_pad_query_peer_position (basesink->sinkpad, &uformat,
4740 res = gst_base_sink_get_duration (basesink, GST_FORMAT_TIME, &dur,
4742 if (!res && upstream) {
4743 res = gst_pad_query_peer_duration (basesink->sinkpad, &uformat,
4750 pos = gst_util_uint64_scale (100 * GST_FORMAT_PERCENT_SCALE, cur,
4752 gst_query_set_position (query, GST_FORMAT_PERCENT, pos);
4758 case GST_QUERY_DURATION:
4762 gboolean upstream = FALSE;
4764 gst_query_parse_duration (query, &format, NULL);
4766 GST_DEBUG_OBJECT (basesink, "duration query in format %s",
4767 gst_format_get_name (format));
4770 gst_base_sink_get_duration (basesink, format, &dur, &upstream))) {
4771 gst_query_set_duration (query, format, dur);
4772 } else if (upstream) {
4773 /* fallback to peer query */
4774 res = gst_pad_peer_query (basesink->sinkpad, query);
4777 /* we can handle a few things if upstream failed */
4778 if (format == GST_FORMAT_PERCENT) {
4779 gst_query_set_duration (query, GST_FORMAT_PERCENT,
4780 GST_FORMAT_PERCENT_MAX);
4786 case GST_QUERY_LATENCY:
4788 gboolean live, us_live;
4789 GstClockTime min, max;
4791 if ((res = gst_base_sink_query_latency (basesink, &live, &us_live, &min,
4793 gst_query_set_latency (query, live, min, max);
4797 case GST_QUERY_JITTER:
4799 case GST_QUERY_RATE:
4800 /* gst_query_set_rate (query, basesink->segment_rate); */
4803 case GST_QUERY_SEGMENT:
4805 if (basesink->pad_mode == GST_ACTIVATE_PULL) {
4806 gst_query_set_segment (query, basesink->segment.rate,
4807 GST_FORMAT_TIME, basesink->segment.start, basesink->segment.stop);
4810 res = gst_pad_peer_query (basesink->sinkpad, query);
4814 case GST_QUERY_SEEKING:
4815 case GST_QUERY_CONVERT:
4816 case GST_QUERY_FORMATS:
4818 res = gst_pad_peer_query (basesink->sinkpad, query);
4821 GST_DEBUG_OBJECT (basesink, "query %s returns %d",
4822 GST_QUERY_TYPE_NAME (query), res);
4826 static GstStateChangeReturn
4827 gst_base_sink_change_state (GstElement * element, GstStateChange transition)
4829 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
4830 GstBaseSink *basesink = GST_BASE_SINK (element);
4831 GstBaseSinkClass *bclass;
4832 GstBaseSinkPrivate *priv;
4834 priv = basesink->priv;
4836 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4838 switch (transition) {
4839 case GST_STATE_CHANGE_NULL_TO_READY:
4841 if (!bclass->start (basesink))
4844 case GST_STATE_CHANGE_READY_TO_PAUSED:
4845 /* need to complete preroll before this state change completes, there
4846 * is no data flow in READY so we can safely assume we need to preroll. */
4847 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4848 GST_DEBUG_OBJECT (basesink, "READY to PAUSED");
4849 basesink->have_newsegment = FALSE;
4850 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
4851 gst_segment_init (basesink->abidata.ABI.clip_segment,
4852 GST_FORMAT_UNDEFINED);
4853 basesink->offset = 0;
4854 basesink->have_preroll = FALSE;
4855 priv->step_unlock = FALSE;
4856 basesink->need_preroll = TRUE;
4857 basesink->playing_async = TRUE;
4858 priv->current_sstart = GST_CLOCK_TIME_NONE;
4859 priv->current_sstop = GST_CLOCK_TIME_NONE;
4860 priv->eos_rtime = GST_CLOCK_TIME_NONE;
4862 basesink->eos = FALSE;
4863 priv->received_eos = FALSE;
4864 gst_base_sink_reset_qos (basesink);
4865 priv->commited = FALSE;
4866 priv->call_preroll = TRUE;
4867 priv->current_step.valid = FALSE;
4868 priv->pending_step.valid = FALSE;
4869 if (priv->async_enabled) {
4870 GST_DEBUG_OBJECT (basesink, "doing async state change");
4871 /* when async enabled, post async-start message and return ASYNC from
4872 * the state change function */
4873 ret = GST_STATE_CHANGE_ASYNC;
4874 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4875 gst_message_new_async_start (GST_OBJECT_CAST (basesink), FALSE));
4877 priv->have_latency = TRUE;
4879 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4881 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
4882 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4883 if (!gst_base_sink_needs_preroll (basesink)) {
4884 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, don't need preroll");
4885 /* no preroll needed anymore now. */
4886 basesink->playing_async = FALSE;
4887 basesink->need_preroll = FALSE;
4888 if (basesink->eos) {
4889 GstMessage *message;
4891 /* need to post EOS message here */
4892 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
4893 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
4894 gst_message_set_seqnum (message, basesink->priv->seqnum);
4895 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
4897 GST_DEBUG_OBJECT (basesink, "signal preroll");
4898 GST_PAD_PREROLL_SIGNAL (basesink->sinkpad);
4901 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, we are not prerolled");
4902 basesink->need_preroll = TRUE;
4903 basesink->playing_async = TRUE;
4904 priv->call_preroll = TRUE;
4905 priv->commited = FALSE;
4906 if (priv->async_enabled) {
4907 GST_DEBUG_OBJECT (basesink, "doing async state change");
4908 ret = GST_STATE_CHANGE_ASYNC;
4909 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4910 gst_message_new_async_start (GST_OBJECT_CAST (basesink), FALSE));
4913 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4920 GstStateChangeReturn bret;
4922 bret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
4923 if (G_UNLIKELY (bret == GST_STATE_CHANGE_FAILURE))
4924 goto activate_failed;
4927 switch (transition) {
4928 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
4929 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED");
4930 /* FIXME, make sure we cannot enter _render first */
4932 /* we need to call ::unlock before locking PREROLL_LOCK
4933 * since we lock it before going into ::render */
4935 bclass->unlock (basesink);
4937 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4938 GST_DEBUG_OBJECT (basesink, "got preroll lock");
4939 /* now that we have the PREROLL lock, clear our unlock request */
4940 if (bclass->unlock_stop)
4941 bclass->unlock_stop (basesink);
4943 /* we need preroll again and we set the flag before unlocking the clockid
4944 * because if the clockid is unlocked before a current buffer expired, we
4945 * can use that buffer to preroll with */
4946 basesink->need_preroll = TRUE;
4948 if (basesink->clock_id) {
4949 GST_DEBUG_OBJECT (basesink, "unschedule clock");
4950 gst_clock_id_unschedule (basesink->clock_id);
4953 /* if we don't have a preroll buffer we need to wait for a preroll and
4955 if (!gst_base_sink_needs_preroll (basesink)) {
4956 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED, we are prerolled");
4957 basesink->playing_async = FALSE;
4959 if (GST_STATE_TARGET (GST_ELEMENT (basesink)) <= GST_STATE_READY) {
4960 GST_DEBUG_OBJECT (basesink, "element is <= READY");
4961 ret = GST_STATE_CHANGE_SUCCESS;
4963 GST_DEBUG_OBJECT (basesink,
4964 "PLAYING to PAUSED, we are not prerolled");
4965 basesink->playing_async = TRUE;
4966 priv->commited = FALSE;
4967 priv->call_preroll = TRUE;
4968 if (priv->async_enabled) {
4969 GST_DEBUG_OBJECT (basesink, "doing async state change");
4970 ret = GST_STATE_CHANGE_ASYNC;
4971 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4972 gst_message_new_async_start (GST_OBJECT_CAST (basesink),
4977 GST_DEBUG_OBJECT (basesink, "rendered: %" G_GUINT64_FORMAT
4978 ", dropped: %" G_GUINT64_FORMAT, priv->rendered, priv->dropped);
4980 gst_base_sink_reset_qos (basesink);
4981 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4983 case GST_STATE_CHANGE_PAUSED_TO_READY:
4984 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4985 /* start by reseting our position state with the object lock so that the
4986 * position query gets the right idea. We do this before we post the
4987 * messages so that the message handlers pick this up. */
4988 GST_OBJECT_LOCK (basesink);
4989 basesink->have_newsegment = FALSE;
4990 priv->current_sstart = GST_CLOCK_TIME_NONE;
4991 priv->current_sstop = GST_CLOCK_TIME_NONE;
4992 priv->have_latency = FALSE;
4993 GST_OBJECT_UNLOCK (basesink);
4995 gst_base_sink_set_last_buffer (basesink, NULL);
4996 priv->call_preroll = FALSE;
4998 if (!priv->commited) {
4999 if (priv->async_enabled) {
5000 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, posting async-done");
5002 gst_element_post_message (GST_ELEMENT_CAST (basesink),
5003 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
5004 GST_STATE_PLAYING, GST_STATE_PAUSED, GST_STATE_READY));
5006 gst_element_post_message (GST_ELEMENT_CAST (basesink),
5007 gst_message_new_async_done (GST_OBJECT_CAST (basesink)));
5009 priv->commited = TRUE;
5011 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, don't need_preroll");
5013 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
5015 case GST_STATE_CHANGE_READY_TO_NULL:
5017 if (!bclass->stop (basesink)) {
5018 GST_WARNING_OBJECT (basesink, "failed to stop");
5021 gst_base_sink_set_last_buffer (basesink, NULL);
5022 priv->call_preroll = FALSE;
5033 GST_DEBUG_OBJECT (basesink, "failed to start");
5034 return GST_STATE_CHANGE_FAILURE;
5038 GST_DEBUG_OBJECT (basesink,
5039 "element failed to change states -- activation problem?");
5040 return GST_STATE_CHANGE_FAILURE;