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 gboolean enable_last_buffer;
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;
261 #define DO_RUNNING_AVG(avg,val,size) (((val) + ((size)-1) * (avg)) / (size))
263 /* generic running average, this has a neutral window size */
264 #define UPDATE_RUNNING_AVG(avg,val) DO_RUNNING_AVG(avg,val,8)
266 /* the windows for these running averages are experimentally obtained.
267 * possitive values get averaged more while negative values use a small
268 * window so we can react faster to badness. */
269 #define UPDATE_RUNNING_AVG_P(avg,val) DO_RUNNING_AVG(avg,val,16)
270 #define UPDATE_RUNNING_AVG_N(avg,val) DO_RUNNING_AVG(avg,val,4)
272 /* BaseSink properties */
274 #define DEFAULT_CAN_ACTIVATE_PULL FALSE /* fixme: enable me */
275 #define DEFAULT_CAN_ACTIVATE_PUSH TRUE
277 #define DEFAULT_PREROLL_QUEUE_LEN 0
278 #define DEFAULT_SYNC TRUE
279 #define DEFAULT_MAX_LATENESS -1
280 #define DEFAULT_QOS FALSE
281 #define DEFAULT_ASYNC TRUE
282 #define DEFAULT_TS_OFFSET 0
283 #define DEFAULT_BLOCKSIZE 4096
284 #define DEFAULT_RENDER_DELAY 0
285 #define DEFAULT_ENABLE_LAST_BUFFER TRUE
290 PROP_PREROLL_QUEUE_LEN,
296 PROP_ENABLE_LAST_BUFFER,
303 static GstElementClass *parent_class = NULL;
305 static void gst_base_sink_class_init (GstBaseSinkClass * klass);
306 static void gst_base_sink_init (GstBaseSink * trans, gpointer g_class);
307 static void gst_base_sink_finalize (GObject * object);
310 gst_base_sink_get_type (void)
312 static volatile gsize base_sink_type = 0;
314 if (g_once_init_enter (&base_sink_type)) {
316 static const GTypeInfo base_sink_info = {
317 sizeof (GstBaseSinkClass),
320 (GClassInitFunc) gst_base_sink_class_init,
323 sizeof (GstBaseSink),
325 (GInstanceInitFunc) gst_base_sink_init,
328 _type = g_type_register_static (GST_TYPE_ELEMENT,
329 "GstBaseSink", &base_sink_info, G_TYPE_FLAG_ABSTRACT);
330 g_once_init_leave (&base_sink_type, _type);
332 return base_sink_type;
335 static void gst_base_sink_set_property (GObject * object, guint prop_id,
336 const GValue * value, GParamSpec * pspec);
337 static void gst_base_sink_get_property (GObject * object, guint prop_id,
338 GValue * value, GParamSpec * pspec);
340 static gboolean gst_base_sink_send_event (GstElement * element,
342 static gboolean gst_base_sink_query (GstElement * element, GstQuery * query);
343 static const GstQueryType *gst_base_sink_get_query_types (GstElement * element);
345 static GstCaps *gst_base_sink_get_caps (GstBaseSink * sink);
346 static gboolean gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps);
347 static GstFlowReturn gst_base_sink_buffer_alloc (GstBaseSink * sink,
348 guint64 offset, guint size, GstCaps * caps, GstBuffer ** buf);
349 static void gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
350 GstClockTime * start, GstClockTime * end);
351 static gboolean gst_base_sink_set_flushing (GstBaseSink * basesink,
352 GstPad * pad, gboolean flushing);
353 static gboolean gst_base_sink_default_activate_pull (GstBaseSink * basesink,
355 static gboolean gst_base_sink_default_do_seek (GstBaseSink * sink,
356 GstSegment * segment);
357 static gboolean gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
358 GstEvent * event, GstSegment * segment);
360 static GstStateChangeReturn gst_base_sink_change_state (GstElement * element,
361 GstStateChange transition);
363 static GstFlowReturn gst_base_sink_chain (GstPad * pad, GstBuffer * buffer);
364 static GstFlowReturn gst_base_sink_chain_list (GstPad * pad,
365 GstBufferList * list);
367 static void gst_base_sink_loop (GstPad * pad);
368 static gboolean gst_base_sink_pad_activate (GstPad * pad);
369 static gboolean gst_base_sink_pad_activate_push (GstPad * pad, gboolean active);
370 static gboolean gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active);
371 static gboolean gst_base_sink_event (GstPad * pad, GstEvent * event);
373 static gboolean gst_base_sink_negotiate_pull (GstBaseSink * basesink);
374 static GstCaps *gst_base_sink_pad_getcaps (GstPad * pad);
375 static gboolean gst_base_sink_pad_setcaps (GstPad * pad, GstCaps * caps);
376 static void gst_base_sink_pad_fixate (GstPad * pad, GstCaps * caps);
377 static GstFlowReturn gst_base_sink_pad_buffer_alloc (GstPad * pad,
378 guint64 offset, guint size, GstCaps * caps, GstBuffer ** buf);
381 /* check if an object was too late */
382 static gboolean gst_base_sink_is_too_late (GstBaseSink * basesink,
383 GstMiniObject * obj, GstClockTime start, GstClockTime stop,
384 GstClockReturn status, GstClockTimeDiff jitter);
385 static GstFlowReturn gst_base_sink_preroll_object (GstBaseSink * basesink,
386 gboolean is_list, GstMiniObject * obj);
389 gst_base_sink_class_init (GstBaseSinkClass * klass)
391 GObjectClass *gobject_class;
392 GstElementClass *gstelement_class;
394 gobject_class = G_OBJECT_CLASS (klass);
395 gstelement_class = GST_ELEMENT_CLASS (klass);
397 GST_DEBUG_CATEGORY_INIT (gst_base_sink_debug, "basesink", 0,
400 g_type_class_add_private (klass, sizeof (GstBaseSinkPrivate));
402 parent_class = g_type_class_peek_parent (klass);
404 gobject_class->finalize = gst_base_sink_finalize;
405 gobject_class->set_property = gst_base_sink_set_property;
406 gobject_class->get_property = gst_base_sink_get_property;
408 /* FIXME, this next value should be configured using an event from the
409 * upstream element, ie, the BUFFER_SIZE event. */
410 g_object_class_install_property (gobject_class, PROP_PREROLL_QUEUE_LEN,
411 g_param_spec_uint ("preroll-queue-len", "Preroll queue length",
412 "Number of buffers to queue during preroll", 0, G_MAXUINT,
413 DEFAULT_PREROLL_QUEUE_LEN,
414 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
416 g_object_class_install_property (gobject_class, PROP_SYNC,
417 g_param_spec_boolean ("sync", "Sync", "Sync on the clock", DEFAULT_SYNC,
418 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
420 g_object_class_install_property (gobject_class, PROP_MAX_LATENESS,
421 g_param_spec_int64 ("max-lateness", "Max Lateness",
422 "Maximum number of nanoseconds that a buffer can be late before it "
423 "is dropped (-1 unlimited)", -1, G_MAXINT64, DEFAULT_MAX_LATENESS,
424 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
426 g_object_class_install_property (gobject_class, PROP_QOS,
427 g_param_spec_boolean ("qos", "Qos",
428 "Generate Quality-of-Service events upstream", DEFAULT_QOS,
429 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
433 * If set to #TRUE, the basesink will perform asynchronous state changes.
434 * When set to #FALSE, the sink will not signal the parent when it prerolls.
435 * Use this option when dealing with sparse streams or when synchronisation is
440 g_object_class_install_property (gobject_class, PROP_ASYNC,
441 g_param_spec_boolean ("async", "Async",
442 "Go asynchronously to PAUSED", DEFAULT_ASYNC,
443 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
445 * GstBaseSink:ts-offset
447 * Controls the final synchronisation, a negative value will render the buffer
448 * earlier while a positive value delays playback. This property can be
449 * used to fix synchronisation in bad files.
453 g_object_class_install_property (gobject_class, PROP_TS_OFFSET,
454 g_param_spec_int64 ("ts-offset", "TS Offset",
455 "Timestamp offset in nanoseconds", G_MININT64, G_MAXINT64,
456 DEFAULT_TS_OFFSET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
459 * GstBaseSink:enable-last-buffer
461 * Enable the last-buffer property. If FALSE, basesink doesn't keep a
462 * reference to the last buffer arrived and the last-buffer property is always
463 * set to NULL. This can be useful if you need buffers to be released as soon
464 * as possible, eg. if you're using a buffer pool.
468 g_object_class_install_property (gobject_class, PROP_ENABLE_LAST_BUFFER,
469 g_param_spec_boolean ("enable-last-buffer", "Enable Last Buffer",
470 "Enable the last-buffer property", DEFAULT_ENABLE_LAST_BUFFER,
471 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
474 * GstBaseSink:last-buffer
476 * The last buffer that arrived in the sink and was used for preroll or for
477 * rendering. This property can be used to generate thumbnails. This property
478 * can be NULL when the sink has not yet received a bufer.
482 g_object_class_install_property (gobject_class, PROP_LAST_BUFFER,
483 gst_param_spec_mini_object ("last-buffer", "Last Buffer",
484 "The last buffer received in the sink", GST_TYPE_BUFFER,
485 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
487 * GstBaseSink:blocksize
489 * The amount of bytes to pull when operating in pull mode.
493 g_object_class_install_property (gobject_class, PROP_BLOCKSIZE,
494 g_param_spec_uint ("blocksize", "Block size",
495 "Size in bytes to pull per buffer (0 = default)", 0, G_MAXUINT,
496 DEFAULT_BLOCKSIZE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
498 * GstBaseSink:render-delay
500 * The additional delay between synchronisation and actual rendering of the
501 * media. This property will add additional latency to the device in order to
502 * make other sinks compensate for the delay.
506 g_object_class_install_property (gobject_class, PROP_RENDER_DELAY,
507 g_param_spec_uint64 ("render-delay", "Render Delay",
508 "Additional render delay of the sink in nanoseconds", 0, G_MAXUINT64,
509 DEFAULT_RENDER_DELAY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
511 gstelement_class->change_state =
512 GST_DEBUG_FUNCPTR (gst_base_sink_change_state);
513 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_base_sink_send_event);
514 gstelement_class->query = GST_DEBUG_FUNCPTR (gst_base_sink_query);
515 gstelement_class->get_query_types =
516 GST_DEBUG_FUNCPTR (gst_base_sink_get_query_types);
518 klass->get_caps = GST_DEBUG_FUNCPTR (gst_base_sink_get_caps);
519 klass->set_caps = GST_DEBUG_FUNCPTR (gst_base_sink_set_caps);
520 klass->buffer_alloc = GST_DEBUG_FUNCPTR (gst_base_sink_buffer_alloc);
521 klass->get_times = GST_DEBUG_FUNCPTR (gst_base_sink_get_times);
522 klass->activate_pull =
523 GST_DEBUG_FUNCPTR (gst_base_sink_default_activate_pull);
525 /* Registering debug symbols for function pointers */
526 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_getcaps);
527 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_setcaps);
528 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_fixate);
529 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_buffer_alloc);
530 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate);
531 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate_push);
532 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate_pull);
533 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_event);
534 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain);
535 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain_list);
539 gst_base_sink_pad_getcaps (GstPad * pad)
541 GstBaseSinkClass *bclass;
543 GstCaps *caps = NULL;
545 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
546 bclass = GST_BASE_SINK_GET_CLASS (bsink);
548 if (bsink->pad_mode == GST_ACTIVATE_PULL) {
549 /* if we are operating in pull mode we only accept the negotiated caps */
550 GST_OBJECT_LOCK (pad);
551 if ((caps = GST_PAD_CAPS (pad)))
553 GST_OBJECT_UNLOCK (pad);
556 if (bclass->get_caps)
557 caps = bclass->get_caps (bsink);
560 GstPadTemplate *pad_template;
563 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass),
565 if (pad_template != NULL) {
566 caps = gst_caps_ref (gst_pad_template_get_caps (pad_template));
570 gst_object_unref (bsink);
576 gst_base_sink_pad_setcaps (GstPad * pad, GstCaps * caps)
578 GstBaseSinkClass *bclass;
582 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
583 bclass = GST_BASE_SINK_GET_CLASS (bsink);
585 if (res && bclass->set_caps)
586 res = bclass->set_caps (bsink, caps);
588 gst_object_unref (bsink);
594 gst_base_sink_pad_fixate (GstPad * pad, GstCaps * caps)
596 GstBaseSinkClass *bclass;
599 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
600 bclass = GST_BASE_SINK_GET_CLASS (bsink);
603 bclass->fixate (bsink, caps);
605 gst_object_unref (bsink);
609 gst_base_sink_pad_buffer_alloc (GstPad * pad, guint64 offset, guint size,
610 GstCaps * caps, GstBuffer ** buf)
612 GstBaseSinkClass *bclass;
614 GstFlowReturn result = GST_FLOW_OK;
616 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
617 bclass = GST_BASE_SINK_GET_CLASS (bsink);
619 if (bclass->buffer_alloc)
620 result = bclass->buffer_alloc (bsink, offset, size, caps, buf);
622 *buf = NULL; /* fallback in gstpad.c will allocate generic buffer */
624 gst_object_unref (bsink);
630 gst_base_sink_init (GstBaseSink * basesink, gpointer g_class)
632 GstPadTemplate *pad_template;
633 GstBaseSinkPrivate *priv;
635 basesink->priv = priv = GST_BASE_SINK_GET_PRIVATE (basesink);
638 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "sink");
639 g_return_if_fail (pad_template != NULL);
641 basesink->sinkpad = gst_pad_new_from_template (pad_template, "sink");
643 gst_pad_set_getcaps_function (basesink->sinkpad, gst_base_sink_pad_getcaps);
644 gst_pad_set_setcaps_function (basesink->sinkpad, gst_base_sink_pad_setcaps);
645 gst_pad_set_fixatecaps_function (basesink->sinkpad, gst_base_sink_pad_fixate);
646 gst_pad_set_bufferalloc_function (basesink->sinkpad,
647 gst_base_sink_pad_buffer_alloc);
648 gst_pad_set_activate_function (basesink->sinkpad, gst_base_sink_pad_activate);
649 gst_pad_set_activatepush_function (basesink->sinkpad,
650 gst_base_sink_pad_activate_push);
651 gst_pad_set_activatepull_function (basesink->sinkpad,
652 gst_base_sink_pad_activate_pull);
653 gst_pad_set_event_function (basesink->sinkpad, gst_base_sink_event);
654 gst_pad_set_chain_function (basesink->sinkpad, gst_base_sink_chain);
655 gst_pad_set_chain_list_function (basesink->sinkpad, gst_base_sink_chain_list);
656 gst_element_add_pad (GST_ELEMENT_CAST (basesink), basesink->sinkpad);
658 basesink->pad_mode = GST_ACTIVATE_NONE;
659 basesink->preroll_queue = g_queue_new ();
660 basesink->abidata.ABI.clip_segment = gst_segment_new ();
661 priv->have_latency = FALSE;
663 basesink->can_activate_push = DEFAULT_CAN_ACTIVATE_PUSH;
664 basesink->can_activate_pull = DEFAULT_CAN_ACTIVATE_PULL;
666 basesink->sync = DEFAULT_SYNC;
667 basesink->abidata.ABI.max_lateness = DEFAULT_MAX_LATENESS;
668 g_atomic_int_set (&priv->qos_enabled, DEFAULT_QOS);
669 priv->async_enabled = DEFAULT_ASYNC;
670 priv->ts_offset = DEFAULT_TS_OFFSET;
671 priv->render_delay = DEFAULT_RENDER_DELAY;
672 priv->blocksize = DEFAULT_BLOCKSIZE;
673 priv->enable_last_buffer = DEFAULT_ENABLE_LAST_BUFFER;
675 GST_OBJECT_FLAG_SET (basesink, GST_ELEMENT_IS_SINK);
679 gst_base_sink_finalize (GObject * object)
681 GstBaseSink *basesink;
683 basesink = GST_BASE_SINK (object);
685 g_queue_free (basesink->preroll_queue);
686 gst_segment_free (basesink->abidata.ABI.clip_segment);
688 G_OBJECT_CLASS (parent_class)->finalize (object);
692 * gst_base_sink_set_sync:
694 * @sync: the new sync value.
696 * Configures @sink to synchronize on the clock or not. When
697 * @sync is FALSE, incomming samples will be played as fast as
698 * possible. If @sync is TRUE, the timestamps of the incomming
699 * buffers will be used to schedule the exact render time of its
705 gst_base_sink_set_sync (GstBaseSink * sink, gboolean sync)
707 g_return_if_fail (GST_IS_BASE_SINK (sink));
709 GST_OBJECT_LOCK (sink);
711 GST_OBJECT_UNLOCK (sink);
715 * gst_base_sink_get_sync:
718 * Checks if @sink is currently configured to synchronize against the
721 * Returns: TRUE if the sink is configured to synchronize against the clock.
726 gst_base_sink_get_sync (GstBaseSink * sink)
730 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
732 GST_OBJECT_LOCK (sink);
734 GST_OBJECT_UNLOCK (sink);
740 * gst_base_sink_set_max_lateness:
742 * @max_lateness: the new max lateness value.
744 * Sets the new max lateness value to @max_lateness. This value is
745 * used to decide if a buffer should be dropped or not based on the
746 * buffer timestamp and the current clock time. A value of -1 means
752 gst_base_sink_set_max_lateness (GstBaseSink * sink, gint64 max_lateness)
754 g_return_if_fail (GST_IS_BASE_SINK (sink));
756 GST_OBJECT_LOCK (sink);
757 sink->abidata.ABI.max_lateness = max_lateness;
758 GST_OBJECT_UNLOCK (sink);
762 * gst_base_sink_get_max_lateness:
765 * Gets the max lateness value. See gst_base_sink_set_max_lateness for
768 * Returns: The maximum time in nanoseconds that a buffer can be late
769 * before it is dropped and not rendered. A value of -1 means an
775 gst_base_sink_get_max_lateness (GstBaseSink * sink)
779 g_return_val_if_fail (GST_IS_BASE_SINK (sink), -1);
781 GST_OBJECT_LOCK (sink);
782 res = sink->abidata.ABI.max_lateness;
783 GST_OBJECT_UNLOCK (sink);
789 * gst_base_sink_set_qos_enabled:
791 * @enabled: the new qos value.
793 * Configures @sink to send Quality-of-Service events upstream.
798 gst_base_sink_set_qos_enabled (GstBaseSink * sink, gboolean enabled)
800 g_return_if_fail (GST_IS_BASE_SINK (sink));
802 g_atomic_int_set (&sink->priv->qos_enabled, enabled);
806 * gst_base_sink_is_qos_enabled:
809 * Checks if @sink is currently configured to send Quality-of-Service events
812 * Returns: TRUE if the sink is configured to perform Quality-of-Service.
817 gst_base_sink_is_qos_enabled (GstBaseSink * sink)
821 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
823 res = g_atomic_int_get (&sink->priv->qos_enabled);
829 * gst_base_sink_set_async_enabled:
831 * @enabled: the new async value.
833 * Configures @sink to perform all state changes asynchronusly. When async is
834 * disabled, the sink will immediatly go to PAUSED instead of waiting for a
835 * preroll buffer. This feature is usefull if the sink does not synchronize
836 * against the clock or when it is dealing with sparse streams.
841 gst_base_sink_set_async_enabled (GstBaseSink * sink, gboolean enabled)
843 g_return_if_fail (GST_IS_BASE_SINK (sink));
845 GST_PAD_PREROLL_LOCK (sink->sinkpad);
846 g_atomic_int_set (&sink->priv->async_enabled, enabled);
847 GST_LOG_OBJECT (sink, "set async enabled to %d", enabled);
848 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
852 * gst_base_sink_is_async_enabled:
855 * Checks if @sink is currently configured to perform asynchronous state
858 * Returns: TRUE if the sink is configured to perform asynchronous state
864 gst_base_sink_is_async_enabled (GstBaseSink * sink)
868 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
870 res = g_atomic_int_get (&sink->priv->async_enabled);
876 * gst_base_sink_set_ts_offset:
878 * @offset: the new offset
880 * Adjust the synchronisation of @sink with @offset. A negative value will
881 * render buffers earlier than their timestamp. A positive value will delay
882 * rendering. This function can be used to fix playback of badly timestamped
888 gst_base_sink_set_ts_offset (GstBaseSink * sink, GstClockTimeDiff offset)
890 g_return_if_fail (GST_IS_BASE_SINK (sink));
892 GST_OBJECT_LOCK (sink);
893 sink->priv->ts_offset = offset;
894 GST_LOG_OBJECT (sink, "set time offset to %" G_GINT64_FORMAT, offset);
895 GST_OBJECT_UNLOCK (sink);
899 * gst_base_sink_get_ts_offset:
902 * Get the synchronisation offset of @sink.
904 * Returns: The synchronisation offset.
909 gst_base_sink_get_ts_offset (GstBaseSink * sink)
911 GstClockTimeDiff res;
913 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
915 GST_OBJECT_LOCK (sink);
916 res = sink->priv->ts_offset;
917 GST_OBJECT_UNLOCK (sink);
923 * gst_base_sink_get_last_buffer:
926 * Get the last buffer that arrived in the sink and was used for preroll or for
927 * rendering. This property can be used to generate thumbnails.
929 * The #GstCaps on the buffer can be used to determine the type of the buffer.
931 * Returns: a #GstBuffer. gst_buffer_unref() after usage. This function returns
932 * NULL when no buffer has arrived in the sink yet or when the sink is not in
938 gst_base_sink_get_last_buffer (GstBaseSink * sink)
942 g_return_val_if_fail (GST_IS_BASE_SINK (sink), NULL);
944 GST_OBJECT_LOCK (sink);
945 if ((res = sink->priv->last_buffer))
946 gst_buffer_ref (res);
947 GST_OBJECT_UNLOCK (sink);
952 /* with OBJECT_LOCK */
954 gst_base_sink_set_last_buffer_unlocked (GstBaseSink * sink, GstBuffer * buffer)
958 old = sink->priv->last_buffer;
959 if (G_LIKELY (old != buffer)) {
960 GST_DEBUG_OBJECT (sink, "setting last buffer to %p", buffer);
961 if (G_LIKELY (buffer))
962 gst_buffer_ref (buffer);
963 sink->priv->last_buffer = buffer;
967 /* avoid unreffing with the lock because cleanup code might want to take the
969 if (G_LIKELY (old)) {
970 GST_OBJECT_UNLOCK (sink);
971 gst_buffer_unref (old);
972 GST_OBJECT_LOCK (sink);
977 gst_base_sink_set_last_buffer (GstBaseSink * sink, GstBuffer * buffer)
979 GST_OBJECT_LOCK (sink);
980 if (sink->priv->enable_last_buffer == FALSE)
983 gst_base_sink_set_last_buffer_unlocked (sink, buffer);
986 GST_OBJECT_UNLOCK (sink);
990 * gst_base_sink_set_last_buffer_enabled:
992 * @enabled: the new enable-last-buffer value.
994 * Configures @sink to store the last received buffer in the last-buffer
1000 gst_base_sink_set_last_buffer_enabled (GstBaseSink * sink, gboolean enabled)
1002 g_return_if_fail (GST_IS_BASE_SINK (sink));
1004 GST_OBJECT_LOCK (sink);
1005 if (enabled != sink->priv->enable_last_buffer) {
1006 sink->priv->enable_last_buffer = enabled;
1008 gst_base_sink_set_last_buffer_unlocked (sink, NULL);
1010 GST_OBJECT_UNLOCK (sink);
1014 * gst_base_sink_is_last_buffer_enabled:
1017 * Checks if @sink is currently configured to store the last received buffer in
1018 * the last-buffer property.
1020 * Returns: TRUE if the sink is configured to store the last received buffer.
1025 gst_base_sink_is_last_buffer_enabled (GstBaseSink * sink)
1029 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
1031 GST_OBJECT_LOCK (sink);
1032 res = sink->priv->enable_last_buffer;
1033 GST_OBJECT_UNLOCK (sink);
1039 * gst_base_sink_get_latency:
1042 * Get the currently configured latency.
1044 * Returns: The configured latency.
1049 gst_base_sink_get_latency (GstBaseSink * sink)
1053 GST_OBJECT_LOCK (sink);
1054 res = sink->priv->latency;
1055 GST_OBJECT_UNLOCK (sink);
1061 * gst_base_sink_query_latency:
1063 * @live: if the sink is live
1064 * @upstream_live: if an upstream element is live
1065 * @min_latency: the min latency of the upstream elements
1066 * @max_latency: the max latency of the upstream elements
1068 * Query the sink for the latency parameters. The latency will be queried from
1069 * the upstream elements. @live will be TRUE if @sink is configured to
1070 * synchronize against the clock. @upstream_live will be TRUE if an upstream
1073 * If both @live and @upstream_live are TRUE, the sink will want to compensate
1074 * for the latency introduced by the upstream elements by setting the
1075 * @min_latency to a strictly possitive value.
1077 * This function is mostly used by subclasses.
1079 * Returns: TRUE if the query succeeded.
1084 gst_base_sink_query_latency (GstBaseSink * sink, gboolean * live,
1085 gboolean * upstream_live, GstClockTime * min_latency,
1086 GstClockTime * max_latency)
1088 gboolean l, us_live, res, have_latency;
1089 GstClockTime min, max, render_delay;
1091 GstClockTime us_min, us_max;
1093 /* we are live when we sync to the clock */
1094 GST_OBJECT_LOCK (sink);
1096 have_latency = sink->priv->have_latency;
1097 render_delay = sink->priv->render_delay;
1098 GST_OBJECT_UNLOCK (sink);
1100 /* assume no latency */
1106 GST_DEBUG_OBJECT (sink, "we are ready for LATENCY query");
1107 /* we are ready for a latency query this is when we preroll or when we are
1109 query = gst_query_new_latency ();
1111 /* ask the peer for the latency */
1112 if ((res = gst_pad_peer_query (sink->sinkpad, query))) {
1113 /* get upstream min and max latency */
1114 gst_query_parse_latency (query, &us_live, &us_min, &us_max);
1117 /* upstream live, use its latency, subclasses should use these
1118 * values to create the complete latency. */
1123 /* we need to add the render delay if we are live */
1125 min += render_delay;
1127 max += render_delay;
1130 gst_query_unref (query);
1132 GST_DEBUG_OBJECT (sink, "we are not yet ready for LATENCY query");
1136 /* not live, we tried to do the query, if it failed we return TRUE anyway */
1140 GST_DEBUG_OBJECT (sink, "latency query failed but we are not live");
1142 GST_DEBUG_OBJECT (sink, "latency query failed and we are live");
1147 GST_DEBUG_OBJECT (sink, "latency query: live: %d, have_latency %d,"
1148 " upstream: %d, min %" GST_TIME_FORMAT ", max %" GST_TIME_FORMAT, l,
1149 have_latency, us_live, GST_TIME_ARGS (min), GST_TIME_ARGS (max));
1154 *upstream_live = us_live;
1164 * gst_base_sink_set_render_delay:
1165 * @sink: a #GstBaseSink
1166 * @delay: the new delay
1168 * Set the render delay in @sink to @delay. The render delay is the time
1169 * between actual rendering of a buffer and its synchronisation time. Some
1170 * devices might delay media rendering which can be compensated for with this
1173 * After calling this function, this sink will report additional latency and
1174 * other sinks will adjust their latency to delay the rendering of their media.
1176 * This function is usually called by subclasses.
1181 gst_base_sink_set_render_delay (GstBaseSink * sink, GstClockTime delay)
1183 GstClockTime old_render_delay;
1185 g_return_if_fail (GST_IS_BASE_SINK (sink));
1187 GST_OBJECT_LOCK (sink);
1188 old_render_delay = sink->priv->render_delay;
1189 sink->priv->render_delay = delay;
1190 GST_LOG_OBJECT (sink, "set render delay to %" GST_TIME_FORMAT,
1191 GST_TIME_ARGS (delay));
1192 GST_OBJECT_UNLOCK (sink);
1194 if (delay != old_render_delay) {
1195 GST_DEBUG_OBJECT (sink, "posting latency changed");
1196 gst_element_post_message (GST_ELEMENT_CAST (sink),
1197 gst_message_new_latency (GST_OBJECT_CAST (sink)));
1202 * gst_base_sink_get_render_delay:
1203 * @sink: a #GstBaseSink
1205 * Get the render delay of @sink. see gst_base_sink_set_render_delay() for more
1206 * information about the render delay.
1208 * Returns: the render delay of @sink.
1213 gst_base_sink_get_render_delay (GstBaseSink * sink)
1215 GstClockTimeDiff res;
1217 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1219 GST_OBJECT_LOCK (sink);
1220 res = sink->priv->render_delay;
1221 GST_OBJECT_UNLOCK (sink);
1227 * gst_base_sink_set_blocksize:
1228 * @sink: a #GstBaseSink
1229 * @blocksize: the blocksize in bytes
1231 * Set the number of bytes that the sink will pull when it is operating in pull
1237 gst_base_sink_set_blocksize (GstBaseSink * sink, guint blocksize)
1239 g_return_if_fail (GST_IS_BASE_SINK (sink));
1241 GST_OBJECT_LOCK (sink);
1242 sink->priv->blocksize = blocksize;
1243 GST_LOG_OBJECT (sink, "set blocksize to %u", blocksize);
1244 GST_OBJECT_UNLOCK (sink);
1248 * gst_base_sink_get_blocksize:
1249 * @sink: a #GstBaseSink
1251 * Get the number of bytes that the sink will pull when it is operating in pull
1254 * Returns: the number of bytes @sink will pull in pull mode.
1259 gst_base_sink_get_blocksize (GstBaseSink * sink)
1263 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1265 GST_OBJECT_LOCK (sink);
1266 res = sink->priv->blocksize;
1267 GST_OBJECT_UNLOCK (sink);
1273 gst_base_sink_set_property (GObject * object, guint prop_id,
1274 const GValue * value, GParamSpec * pspec)
1276 GstBaseSink *sink = GST_BASE_SINK (object);
1279 case PROP_PREROLL_QUEUE_LEN:
1280 /* preroll lock necessary to serialize with finish_preroll */
1281 GST_PAD_PREROLL_LOCK (sink->sinkpad);
1282 g_atomic_int_set (&sink->preroll_queue_max_len, g_value_get_uint (value));
1283 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
1286 gst_base_sink_set_sync (sink, g_value_get_boolean (value));
1288 case PROP_MAX_LATENESS:
1289 gst_base_sink_set_max_lateness (sink, g_value_get_int64 (value));
1292 gst_base_sink_set_qos_enabled (sink, g_value_get_boolean (value));
1295 gst_base_sink_set_async_enabled (sink, g_value_get_boolean (value));
1297 case PROP_TS_OFFSET:
1298 gst_base_sink_set_ts_offset (sink, g_value_get_int64 (value));
1300 case PROP_BLOCKSIZE:
1301 gst_base_sink_set_blocksize (sink, g_value_get_uint (value));
1303 case PROP_RENDER_DELAY:
1304 gst_base_sink_set_render_delay (sink, g_value_get_uint64 (value));
1306 case PROP_ENABLE_LAST_BUFFER:
1307 gst_base_sink_set_last_buffer_enabled (sink, g_value_get_boolean (value));
1310 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1316 gst_base_sink_get_property (GObject * object, guint prop_id, GValue * value,
1319 GstBaseSink *sink = GST_BASE_SINK (object);
1322 case PROP_PREROLL_QUEUE_LEN:
1323 g_value_set_uint (value, g_atomic_int_get (&sink->preroll_queue_max_len));
1326 g_value_set_boolean (value, gst_base_sink_get_sync (sink));
1328 case PROP_MAX_LATENESS:
1329 g_value_set_int64 (value, gst_base_sink_get_max_lateness (sink));
1332 g_value_set_boolean (value, gst_base_sink_is_qos_enabled (sink));
1335 g_value_set_boolean (value, gst_base_sink_is_async_enabled (sink));
1337 case PROP_TS_OFFSET:
1338 g_value_set_int64 (value, gst_base_sink_get_ts_offset (sink));
1340 case PROP_LAST_BUFFER:
1341 gst_value_take_buffer (value, gst_base_sink_get_last_buffer (sink));
1343 case PROP_ENABLE_LAST_BUFFER:
1344 g_value_set_boolean (value, gst_base_sink_is_last_buffer_enabled (sink));
1346 case PROP_BLOCKSIZE:
1347 g_value_set_uint (value, gst_base_sink_get_blocksize (sink));
1349 case PROP_RENDER_DELAY:
1350 g_value_set_uint64 (value, gst_base_sink_get_render_delay (sink));
1353 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1360 gst_base_sink_get_caps (GstBaseSink * sink)
1366 gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps)
1371 static GstFlowReturn
1372 gst_base_sink_buffer_alloc (GstBaseSink * sink, guint64 offset, guint size,
1373 GstCaps * caps, GstBuffer ** buf)
1379 /* with PREROLL_LOCK, STREAM_LOCK */
1381 gst_base_sink_preroll_queue_flush (GstBaseSink * basesink, GstPad * pad)
1385 GST_DEBUG_OBJECT (basesink, "flushing queue %p", basesink);
1386 while ((obj = g_queue_pop_head (basesink->preroll_queue))) {
1387 GST_DEBUG_OBJECT (basesink, "popped %p", obj);
1388 gst_mini_object_unref (obj);
1390 /* we can't have EOS anymore now */
1391 basesink->eos = FALSE;
1392 basesink->priv->received_eos = FALSE;
1393 basesink->have_preroll = FALSE;
1394 basesink->priv->step_unlock = FALSE;
1395 basesink->eos_queued = FALSE;
1396 basesink->preroll_queued = 0;
1397 basesink->buffers_queued = 0;
1398 basesink->events_queued = 0;
1399 /* can't report latency anymore until we preroll again */
1400 if (basesink->priv->async_enabled) {
1401 GST_OBJECT_LOCK (basesink);
1402 basesink->priv->have_latency = FALSE;
1403 GST_OBJECT_UNLOCK (basesink);
1405 /* and signal any waiters now */
1406 GST_PAD_PREROLL_SIGNAL (pad);
1409 /* with STREAM_LOCK, configures given segment with the event information. */
1411 gst_base_sink_configure_segment (GstBaseSink * basesink, GstPad * pad,
1412 GstEvent * event, GstSegment * segment)
1415 gdouble rate, arate;
1421 /* the newsegment event is needed to bring the buffer timestamps to the
1422 * stream time and to drop samples outside of the playback segment. */
1423 gst_event_parse_new_segment_full (event, &update, &rate, &arate, &format,
1424 &start, &stop, &time);
1426 /* The segment is protected with both the STREAM_LOCK and the OBJECT_LOCK.
1427 * We protect with the OBJECT_LOCK so that we can use the values to
1428 * safely answer a POSITION query. */
1429 GST_OBJECT_LOCK (basesink);
1430 gst_segment_set_newsegment_full (segment, update, rate, arate, format, start,
1433 if (format == GST_FORMAT_TIME) {
1434 GST_DEBUG_OBJECT (basesink,
1435 "configured NEWSEGMENT update %d, rate %lf, applied rate %lf, "
1436 "format GST_FORMAT_TIME, "
1437 "%" GST_TIME_FORMAT " -- %" GST_TIME_FORMAT
1438 ", time %" GST_TIME_FORMAT ", accum %" GST_TIME_FORMAT,
1439 update, rate, arate, GST_TIME_ARGS (segment->start),
1440 GST_TIME_ARGS (segment->stop), GST_TIME_ARGS (segment->time),
1441 GST_TIME_ARGS (segment->accum));
1443 GST_DEBUG_OBJECT (basesink,
1444 "configured NEWSEGMENT update %d, rate %lf, applied rate %lf, "
1446 "%" G_GINT64_FORMAT " -- %" G_GINT64_FORMAT ", time %"
1447 G_GINT64_FORMAT ", accum %" G_GINT64_FORMAT, update, rate, arate,
1448 segment->format, segment->start, segment->stop, segment->time,
1451 GST_OBJECT_UNLOCK (basesink);
1454 /* with PREROLL_LOCK, STREAM_LOCK */
1456 gst_base_sink_commit_state (GstBaseSink * basesink)
1458 /* commit state and proceed to next pending state */
1459 GstState current, next, pending, post_pending;
1460 gboolean post_paused = FALSE;
1461 gboolean post_async_done = FALSE;
1462 gboolean post_playing = FALSE;
1464 /* we are certainly not playing async anymore now */
1465 basesink->playing_async = FALSE;
1467 GST_OBJECT_LOCK (basesink);
1468 current = GST_STATE (basesink);
1469 next = GST_STATE_NEXT (basesink);
1470 pending = GST_STATE_PENDING (basesink);
1471 post_pending = pending;
1474 case GST_STATE_PLAYING:
1476 GstBaseSinkClass *bclass;
1477 GstStateChangeReturn ret;
1479 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1481 GST_DEBUG_OBJECT (basesink, "commiting state to PLAYING");
1483 basesink->need_preroll = FALSE;
1484 post_async_done = TRUE;
1485 basesink->priv->commited = TRUE;
1486 post_playing = TRUE;
1487 /* post PAUSED too when we were READY */
1488 if (current == GST_STATE_READY) {
1492 /* make sure we notify the subclass of async playing */
1493 if (bclass->async_play) {
1494 GST_WARNING_OBJECT (basesink, "deprecated async_play");
1495 ret = bclass->async_play (basesink);
1496 if (ret == GST_STATE_CHANGE_FAILURE)
1501 case GST_STATE_PAUSED:
1502 GST_DEBUG_OBJECT (basesink, "commiting state to PAUSED");
1504 post_async_done = TRUE;
1505 basesink->priv->commited = TRUE;
1506 post_pending = GST_STATE_VOID_PENDING;
1508 case GST_STATE_READY:
1509 case GST_STATE_NULL:
1511 case GST_STATE_VOID_PENDING:
1512 goto nothing_pending;
1517 /* we can report latency queries now */
1518 basesink->priv->have_latency = TRUE;
1520 GST_STATE (basesink) = pending;
1521 GST_STATE_NEXT (basesink) = GST_STATE_VOID_PENDING;
1522 GST_STATE_PENDING (basesink) = GST_STATE_VOID_PENDING;
1523 GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_SUCCESS;
1524 GST_OBJECT_UNLOCK (basesink);
1527 GST_DEBUG_OBJECT (basesink, "posting PAUSED state change message");
1528 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1529 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1530 current, next, post_pending));
1532 if (post_async_done) {
1533 GST_DEBUG_OBJECT (basesink, "posting async-done message");
1534 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1535 gst_message_new_async_done (GST_OBJECT_CAST (basesink)));
1538 GST_DEBUG_OBJECT (basesink, "posting PLAYING state change message");
1539 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1540 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1541 next, pending, GST_STATE_VOID_PENDING));
1544 GST_STATE_BROADCAST (basesink);
1550 /* Depending on the state, set our vars. We get in this situation when the
1551 * state change function got a change to update the state vars before the
1552 * streaming thread did. This is fine but we need to make sure that we
1553 * update the need_preroll var since it was TRUE when we got here and might
1554 * become FALSE if we got to PLAYING. */
1555 GST_DEBUG_OBJECT (basesink, "nothing to commit, now in %s",
1556 gst_element_state_get_name (current));
1558 case GST_STATE_PLAYING:
1559 basesink->need_preroll = FALSE;
1561 case GST_STATE_PAUSED:
1562 basesink->need_preroll = TRUE;
1565 basesink->need_preroll = FALSE;
1566 basesink->flushing = TRUE;
1569 /* we can report latency queries now */
1570 basesink->priv->have_latency = TRUE;
1571 GST_OBJECT_UNLOCK (basesink);
1576 /* app is going to READY */
1577 GST_DEBUG_OBJECT (basesink, "stopping");
1578 basesink->need_preroll = FALSE;
1579 basesink->flushing = TRUE;
1580 GST_OBJECT_UNLOCK (basesink);
1585 GST_DEBUG_OBJECT (basesink, "async commit failed");
1586 GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_FAILURE;
1587 GST_OBJECT_UNLOCK (basesink);
1593 start_stepping (GstBaseSink * sink, GstSegment * segment,
1594 GstStepInfo * pending, GstStepInfo * current)
1597 GstMessage *message;
1599 GST_DEBUG_OBJECT (sink, "update pending step");
1601 GST_OBJECT_LOCK (sink);
1602 memcpy (current, pending, sizeof (GstStepInfo));
1603 pending->valid = FALSE;
1604 GST_OBJECT_UNLOCK (sink);
1606 /* post message first */
1608 gst_message_new_step_start (GST_OBJECT (sink), TRUE, current->format,
1609 current->amount, current->rate, current->flush, current->intermediate);
1610 gst_message_set_seqnum (message, current->seqnum);
1611 gst_element_post_message (GST_ELEMENT (sink), message);
1613 /* get the running time of where we paused and remember it */
1614 current->start = gst_element_get_start_time (GST_ELEMENT_CAST (sink));
1615 gst_segment_set_running_time (segment, GST_FORMAT_TIME, current->start);
1617 /* set the new rate for the remainder of the segment */
1618 current->start_rate = segment->rate;
1619 segment->rate *= current->rate;
1620 segment->abs_rate = ABS (segment->rate);
1623 if (segment->rate > 0.0)
1624 current->start_stop = segment->stop;
1626 current->start_start = segment->start;
1628 if (current->format == GST_FORMAT_TIME) {
1629 end = current->start + current->amount;
1630 if (!current->flush) {
1631 /* update the segment clipping regions for non-flushing seeks */
1632 if (segment->rate > 0.0) {
1633 segment->stop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1634 segment->last_stop = segment->stop;
1638 position = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1639 segment->time = position;
1640 segment->start = position;
1641 segment->last_stop = position;
1646 GST_DEBUG_OBJECT (sink,
1647 "segment now rate %lf, applied rate %lf, "
1648 "format GST_FORMAT_TIME, "
1649 "%" GST_TIME_FORMAT " -- %" GST_TIME_FORMAT
1650 ", time %" GST_TIME_FORMAT ", accum %" GST_TIME_FORMAT,
1651 segment->rate, segment->applied_rate, GST_TIME_ARGS (segment->start),
1652 GST_TIME_ARGS (segment->stop), GST_TIME_ARGS (segment->time),
1653 GST_TIME_ARGS (segment->accum));
1655 GST_DEBUG_OBJECT (sink, "step started at running_time %" GST_TIME_FORMAT,
1656 GST_TIME_ARGS (current->start));
1658 if (current->amount == -1) {
1659 GST_DEBUG_OBJECT (sink, "step amount == -1, stop stepping");
1660 current->valid = FALSE;
1662 GST_DEBUG_OBJECT (sink, "step amount: %" G_GUINT64_FORMAT ", format: %s, "
1663 "rate: %f", current->amount, gst_format_get_name (current->format),
1669 stop_stepping (GstBaseSink * sink, GstSegment * segment,
1670 GstStepInfo * current, gint64 rstart, gint64 rstop, gboolean eos)
1672 gint64 stop, position;
1673 GstMessage *message;
1675 GST_DEBUG_OBJECT (sink, "step complete");
1677 if (segment->rate > 0.0)
1682 GST_DEBUG_OBJECT (sink,
1683 "step stop at running_time %" GST_TIME_FORMAT, GST_TIME_ARGS (stop));
1686 current->duration = current->position;
1688 current->duration = stop - current->start;
1690 GST_DEBUG_OBJECT (sink, "step elapsed running_time %" GST_TIME_FORMAT,
1691 GST_TIME_ARGS (current->duration));
1693 position = current->start + current->duration;
1695 /* now move the segment to the new running time */
1696 gst_segment_set_running_time (segment, GST_FORMAT_TIME, position);
1698 if (current->flush) {
1699 /* and remove the accumulated time we flushed, start time did not change */
1700 segment->accum = current->start;
1702 /* start time is now the stepped position */
1703 gst_element_set_start_time (GST_ELEMENT_CAST (sink), position);
1706 /* restore the previous rate */
1707 segment->rate = current->start_rate;
1708 segment->abs_rate = ABS (segment->rate);
1710 if (segment->rate > 0.0)
1711 segment->stop = current->start_stop;
1713 segment->start = current->start_start;
1715 /* the clip segment is used for position report in paused... */
1716 memcpy (sink->abidata.ABI.clip_segment, segment, sizeof (GstSegment));
1718 /* post the step done when we know the stepped duration in TIME */
1720 gst_message_new_step_done (GST_OBJECT_CAST (sink), current->format,
1721 current->amount, current->rate, current->flush, current->intermediate,
1722 current->duration, eos);
1723 gst_message_set_seqnum (message, current->seqnum);
1724 gst_element_post_message (GST_ELEMENT_CAST (sink), message);
1726 if (!current->intermediate)
1727 sink->need_preroll = current->need_preroll;
1729 /* and the current step info finished and becomes invalid */
1730 current->valid = FALSE;
1734 handle_stepping (GstBaseSink * sink, GstSegment * segment,
1735 GstStepInfo * current, gint64 * cstart, gint64 * cstop, gint64 * rstart,
1738 gboolean step_end = FALSE;
1740 /* see if we need to skip this buffer because of stepping */
1741 switch (current->format) {
1742 case GST_FORMAT_TIME:
1747 if (segment->rate > 0.0) {
1748 if (segment->stop == *cstop)
1749 *rstop = *rstart + current->amount;
1754 if (segment->start == *cstart)
1755 *rstart = *rstop + current->amount;
1761 end = current->start + current->amount;
1762 current->position = first - current->start;
1764 if (G_UNLIKELY (segment->abs_rate != 1.0))
1765 current->position /= segment->abs_rate;
1767 GST_DEBUG_OBJECT (sink,
1768 "buffer: %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT,
1769 GST_TIME_ARGS (first), GST_TIME_ARGS (last));
1770 GST_DEBUG_OBJECT (sink,
1771 "got time step %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT "/%"
1772 GST_TIME_FORMAT, GST_TIME_ARGS (current->position),
1773 GST_TIME_ARGS (last - current->start),
1774 GST_TIME_ARGS (current->amount));
1776 if ((current->flush && current->position >= current->amount)
1778 GST_DEBUG_OBJECT (sink, "step ended, we need clipping");
1780 if (segment->rate > 0.0) {
1782 *cstart = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1785 *cstop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1788 GST_DEBUG_OBJECT (sink,
1789 "cstart %" GST_TIME_FORMAT ", rstart %" GST_TIME_FORMAT,
1790 GST_TIME_ARGS (*cstart), GST_TIME_ARGS (*rstart));
1791 GST_DEBUG_OBJECT (sink,
1792 "cstop %" GST_TIME_FORMAT ", rstop %" GST_TIME_FORMAT,
1793 GST_TIME_ARGS (*cstop), GST_TIME_ARGS (*rstop));
1796 case GST_FORMAT_BUFFERS:
1797 GST_DEBUG_OBJECT (sink,
1798 "got default step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1799 current->position, current->amount);
1801 if (current->position < current->amount) {
1802 current->position++;
1807 case GST_FORMAT_DEFAULT:
1809 GST_DEBUG_OBJECT (sink,
1810 "got unknown step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1811 current->position, current->amount);
1817 /* with STREAM_LOCK, PREROLL_LOCK
1819 * Returns TRUE if the object needs synchronisation and takes therefore
1820 * part in prerolling.
1822 * rsstart/rsstop contain the start/stop in stream time.
1823 * rrstart/rrstop contain the start/stop in running time.
1826 gst_base_sink_get_sync_times (GstBaseSink * basesink, GstMiniObject * obj,
1827 GstClockTime * rsstart, GstClockTime * rsstop,
1828 GstClockTime * rrstart, GstClockTime * rrstop, gboolean * do_sync,
1829 gboolean * stepped, GstSegment * segment, GstStepInfo * step,
1830 gboolean * step_end)
1832 GstBaseSinkClass *bclass;
1834 GstClockTime start, stop; /* raw start/stop timestamps */
1835 gint64 cstart, cstop; /* clipped raw timestamps */
1836 gint64 rstart, rstop; /* clipped timestamps converted to running time */
1837 GstClockTime sstart, sstop; /* clipped timestamps converted to stream time */
1839 GstBaseSinkPrivate *priv;
1842 priv = basesink->priv;
1844 /* start with nothing */
1845 start = stop = GST_CLOCK_TIME_NONE;
1847 if (G_UNLIKELY (GST_IS_EVENT (obj))) {
1848 GstEvent *event = GST_EVENT_CAST (obj);
1850 switch (GST_EVENT_TYPE (event)) {
1851 /* EOS event needs syncing */
1854 if (basesink->segment.rate >= 0.0) {
1855 sstart = sstop = priv->current_sstop;
1856 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1857 /* we have not seen a buffer yet, use the segment values */
1858 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1859 basesink->segment.format, basesink->segment.stop);
1862 sstart = sstop = priv->current_sstart;
1863 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1864 /* we have not seen a buffer yet, use the segment values */
1865 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1866 basesink->segment.format, basesink->segment.start);
1870 rstart = rstop = priv->eos_rtime;
1871 *do_sync = rstart != -1;
1872 GST_DEBUG_OBJECT (basesink, "sync times for EOS %" GST_TIME_FORMAT,
1873 GST_TIME_ARGS (rstart));
1874 /* if we are stepping, we end now */
1875 *step_end = step->valid;
1880 /* other events do not need syncing */
1881 /* FIXME, maybe NEWSEGMENT might need synchronisation
1882 * since the POSITION query depends on accumulated times and
1883 * we cannot accumulate the current segment before the previous
1893 /* else do buffer sync code */
1894 buffer = GST_BUFFER_CAST (obj);
1896 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1898 /* just get the times to see if we need syncing, if the start returns -1 we
1900 if (bclass->get_times)
1901 bclass->get_times (basesink, buffer, &start, &stop);
1903 if (!GST_CLOCK_TIME_IS_VALID (start)) {
1904 /* we don't need to sync but we still want to get the timestamps for
1905 * tracking the position */
1906 gst_base_sink_get_times (basesink, buffer, &start, &stop);
1912 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
1913 ", stop: %" GST_TIME_FORMAT ", do_sync %d", GST_TIME_ARGS (start),
1914 GST_TIME_ARGS (stop), *do_sync);
1916 /* collect segment and format for code clarity */
1917 format = segment->format;
1919 /* no timestamp clipping if we did not get a TIME segment format */
1920 if (G_UNLIKELY (format != GST_FORMAT_TIME)) {
1923 /* do running and stream time in TIME format */
1924 format = GST_FORMAT_TIME;
1925 GST_LOG_OBJECT (basesink, "not time format, don't clip");
1929 /* clip, only when we know about time */
1930 if (G_UNLIKELY (!gst_segment_clip (segment, GST_FORMAT_TIME,
1931 (gint64) start, (gint64) stop, &cstart, &cstop))) {
1933 GST_DEBUG_OBJECT (basesink, "step out of segment");
1934 /* when we are stepping, pretend we're at the end of the segment */
1935 if (segment->rate > 0.0) {
1936 cstart = segment->stop;
1937 cstop = segment->stop;
1939 cstart = segment->start;
1940 cstop = segment->start;
1944 goto out_of_segment;
1947 if (G_UNLIKELY (start != cstart || stop != cstop)) {
1948 GST_DEBUG_OBJECT (basesink, "clipped to: start %" GST_TIME_FORMAT
1949 ", stop: %" GST_TIME_FORMAT, GST_TIME_ARGS (cstart),
1950 GST_TIME_ARGS (cstop));
1953 /* set last stop position */
1954 if (G_LIKELY (cstop != GST_CLOCK_TIME_NONE))
1955 gst_segment_set_last_stop (segment, GST_FORMAT_TIME, cstop);
1957 gst_segment_set_last_stop (segment, GST_FORMAT_TIME, cstart);
1960 rstart = gst_segment_to_running_time (segment, format, cstart);
1961 rstop = gst_segment_to_running_time (segment, format, cstop);
1963 if (G_UNLIKELY (step->valid)) {
1964 if (!(*step_end = handle_stepping (basesink, segment, step, &cstart, &cstop,
1965 &rstart, &rstop))) {
1966 /* step is still busy, we discard data when we are flushing */
1967 *stepped = step->flush;
1968 GST_DEBUG_OBJECT (basesink, "stepping busy");
1971 /* this can produce wrong values if we accumulated non-TIME segments. If this happens,
1972 * upstream is behaving very badly */
1973 sstart = gst_segment_to_stream_time (segment, format, cstart);
1974 sstop = gst_segment_to_stream_time (segment, format, cstop);
1977 /* eos_done label only called when doing EOS, we also stop stepping then */
1978 if (*step_end && step->flush) {
1979 GST_DEBUG_OBJECT (basesink, "flushing step ended");
1980 stop_stepping (basesink, segment, step, rstart, rstop, eos);
1982 /* re-determine running start times for adjusted segment
1983 * (which has a flushed amount of running/accumulated time removed) */
1984 if (!GST_IS_EVENT (obj)) {
1985 GST_DEBUG_OBJECT (basesink, "refresh sync times");
1996 /* buffers and EOS always need syncing and preroll */
2002 /* we usually clip in the chain function already but stepping could cause
2003 * the segment to be updated later. we return FALSE so that we don't try
2005 GST_LOG_OBJECT (basesink, "buffer skipped, not in segment");
2010 /* with STREAM_LOCK, PREROLL_LOCK, LOCK
2011 * adjust a timestamp with the latency and timestamp offset. This function does
2012 * not adjust for the render delay. */
2014 gst_base_sink_adjust_time (GstBaseSink * basesink, GstClockTime time)
2016 GstClockTimeDiff ts_offset;
2018 /* don't do anything funny with invalid timestamps */
2019 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
2022 time += basesink->priv->latency;
2024 /* apply offset, be carefull for underflows */
2025 ts_offset = basesink->priv->ts_offset;
2026 if (ts_offset < 0) {
2027 ts_offset = -ts_offset;
2028 if (ts_offset < time)
2035 /* subtract the render delay again, which was included in the latency */
2036 if (time > basesink->priv->render_delay)
2037 time -= basesink->priv->render_delay;
2045 * gst_base_sink_wait_clock:
2047 * @time: the running_time to be reached
2048 * @jitter: the jitter to be filled with time diff (can be NULL)
2050 * This function will block until @time is reached. It is usually called by
2051 * subclasses that use their own internal synchronisation.
2053 * If @time is not valid, no sycnhronisation is done and #GST_CLOCK_BADTIME is
2054 * returned. Likewise, if synchronisation is disabled in the element or there
2055 * is no clock, no synchronisation is done and #GST_CLOCK_BADTIME is returned.
2057 * This function should only be called with the PREROLL_LOCK held, like when
2058 * receiving an EOS event in the #GstBaseSinkClass.event() vmethod or when
2059 * receiving a buffer in
2060 * the #GstBaseSinkClass.render() vmethod.
2062 * The @time argument should be the running_time of when this method should
2063 * return and is not adjusted with any latency or offset configured in the
2068 * Returns: #GstClockReturn
2071 gst_base_sink_wait_clock (GstBaseSink * sink, GstClockTime time,
2072 GstClockTimeDiff * jitter)
2077 GstClockTime base_time;
2079 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
2082 GST_OBJECT_LOCK (sink);
2083 if (G_UNLIKELY (!sink->sync))
2086 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (sink)) == NULL))
2089 base_time = GST_ELEMENT_CAST (sink)->base_time;
2090 GST_LOG_OBJECT (sink,
2091 "time %" GST_TIME_FORMAT ", base_time %" GST_TIME_FORMAT,
2092 GST_TIME_ARGS (time), GST_TIME_ARGS (base_time));
2094 /* add base_time to running_time to get the time against the clock */
2097 id = gst_clock_new_single_shot_id (clock, time);
2098 GST_OBJECT_UNLOCK (sink);
2100 /* A blocking wait is performed on the clock. We save the ClockID
2101 * so we can unlock the entry at any time. While we are blocking, we
2102 * release the PREROLL_LOCK so that other threads can interrupt the
2104 sink->clock_id = id;
2105 /* release the preroll lock while waiting */
2106 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
2108 ret = gst_clock_id_wait (id, jitter);
2110 GST_PAD_PREROLL_LOCK (sink->sinkpad);
2111 gst_clock_id_unref (id);
2112 sink->clock_id = NULL;
2116 /* no syncing needed */
2119 GST_DEBUG_OBJECT (sink, "time not valid, no sync needed");
2120 return GST_CLOCK_BADTIME;
2124 GST_DEBUG_OBJECT (sink, "sync disabled");
2125 GST_OBJECT_UNLOCK (sink);
2126 return GST_CLOCK_BADTIME;
2130 GST_DEBUG_OBJECT (sink, "no clock, can't sync");
2131 GST_OBJECT_UNLOCK (sink);
2132 return GST_CLOCK_BADTIME;
2137 * gst_base_sink_wait_preroll:
2140 * If the #GstBaseSinkClass.render() method performs its own synchronisation
2141 * against the clock it must unblock when going from PLAYING to the PAUSED state
2142 * and call this method before continuing to render the remaining data.
2144 * This function will block until a state change to PLAYING happens (in which
2145 * case this function returns #GST_FLOW_OK) or the processing must be stopped due
2146 * to a state change to READY or a FLUSH event (in which case this function
2147 * returns #GST_FLOW_WRONG_STATE).
2149 * This function should only be called with the PREROLL_LOCK held, like in the
2154 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2155 * continue. Any other return value should be returned from the render vmethod.
2158 gst_base_sink_wait_preroll (GstBaseSink * sink)
2160 sink->have_preroll = TRUE;
2161 GST_DEBUG_OBJECT (sink, "waiting in preroll for flush or PLAYING");
2162 /* block until the state changes, or we get a flush, or something */
2163 GST_PAD_PREROLL_WAIT (sink->sinkpad);
2164 sink->have_preroll = FALSE;
2165 if (G_UNLIKELY (sink->flushing))
2167 if (G_UNLIKELY (sink->priv->step_unlock))
2169 GST_DEBUG_OBJECT (sink, "continue after preroll");
2176 GST_DEBUG_OBJECT (sink, "preroll interrupted because of flush");
2177 return GST_FLOW_WRONG_STATE;
2181 sink->priv->step_unlock = FALSE;
2182 GST_DEBUG_OBJECT (sink, "preroll interrupted because of step");
2183 return GST_FLOW_STEP;
2188 * gst_base_sink_do_preroll:
2190 * @obj: the object that caused the preroll
2192 * If the @sink spawns its own thread for pulling buffers from upstream it
2193 * should call this method after it has pulled a buffer. If the element needed
2194 * to preroll, this function will perform the preroll and will then block
2195 * until the element state is changed.
2197 * This function should be called with the PREROLL_LOCK held.
2201 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2202 * continue. Any other return value should be returned from the render vmethod.
2205 gst_base_sink_do_preroll (GstBaseSink * sink, GstMiniObject * obj)
2209 while (G_UNLIKELY (sink->need_preroll)) {
2210 GST_DEBUG_OBJECT (sink, "prerolling object %p", obj);
2212 ret = gst_base_sink_preroll_object (sink, FALSE, obj);
2213 if (ret != GST_FLOW_OK)
2214 goto preroll_failed;
2216 /* need to recheck here because the commit state could have
2217 * made us not need the preroll anymore */
2218 if (G_LIKELY (sink->need_preroll)) {
2219 /* block until the state changes, or we get a flush, or something */
2220 ret = gst_base_sink_wait_preroll (sink);
2221 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2222 goto preroll_failed;
2230 GST_DEBUG_OBJECT (sink, "preroll failed %d", ret);
2236 * gst_base_sink_wait_eos:
2238 * @time: the running_time to be reached
2239 * @jitter: the jitter to be filled with time diff (can be NULL)
2241 * This function will block until @time is reached. It is usually called by
2242 * subclasses that use their own internal synchronisation but want to let the
2243 * EOS be handled by the base class.
2245 * This function should only be called with the PREROLL_LOCK held, like when
2246 * receiving an EOS event in the ::event vmethod.
2248 * The @time argument should be the running_time of when the EOS should happen
2249 * and will be adjusted with any latency and offset configured in the sink.
2253 * Returns: #GstFlowReturn
2256 gst_base_sink_wait_eos (GstBaseSink * sink, GstClockTime time,
2257 GstClockTimeDiff * jitter)
2259 GstClockReturn status;
2265 GST_DEBUG_OBJECT (sink, "checking preroll");
2267 /* first wait for the playing state before we can continue */
2268 if (G_UNLIKELY (sink->need_preroll)) {
2269 ret = gst_base_sink_wait_preroll (sink);
2270 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2274 /* preroll done, we can sync since we are in PLAYING now. */
2275 GST_DEBUG_OBJECT (sink, "possibly waiting for clock to reach %"
2276 GST_TIME_FORMAT, GST_TIME_ARGS (time));
2278 /* compensate for latency and ts_offset. We don't adjust for render delay
2279 * because we don't interact with the device on EOS normally. */
2280 stime = gst_base_sink_adjust_time (sink, time);
2282 /* wait for the clock, this can be interrupted because we got shut down or
2284 status = gst_base_sink_wait_clock (sink, stime, jitter);
2286 GST_DEBUG_OBJECT (sink, "clock returned %d", status);
2288 /* invalid time, no clock or sync disabled, just continue then */
2289 if (status == GST_CLOCK_BADTIME)
2292 /* waiting could have been interrupted and we can be flushing now */
2293 if (G_UNLIKELY (sink->flushing))
2296 /* retry if we got unscheduled, which means we did not reach the timeout
2297 * yet. if some other error occures, we continue. */
2298 } while (status == GST_CLOCK_UNSCHEDULED);
2300 GST_DEBUG_OBJECT (sink, "end of stream");
2307 GST_DEBUG_OBJECT (sink, "we are flushing");
2308 return GST_FLOW_WRONG_STATE;
2312 /* with STREAM_LOCK, PREROLL_LOCK
2314 * Make sure we are in PLAYING and synchronize an object to the clock.
2316 * If we need preroll, we are not in PLAYING. We try to commit the state
2317 * if needed and then block if we still are not PLAYING.
2319 * We start waiting on the clock in PLAYING. If we got interrupted, we
2320 * immediatly try to re-preroll.
2322 * Some objects do not need synchronisation (most events) and so this function
2323 * immediatly returns GST_FLOW_OK.
2325 * for objects that arrive later than max-lateness to be synchronized to the
2326 * clock have the @late boolean set to TRUE.
2328 * This function keeps a running average of the jitter (the diff between the
2329 * clock time and the requested sync time). The jitter is negative for
2330 * objects that arrive in time and positive for late buffers.
2332 * does not take ownership of obj.
2334 static GstFlowReturn
2335 gst_base_sink_do_sync (GstBaseSink * basesink, GstPad * pad,
2336 GstMiniObject * obj, gboolean * late, gboolean * step_end)
2338 GstClockTimeDiff jitter = 0;
2340 GstClockReturn status = GST_CLOCK_OK;
2341 GstClockTime rstart, rstop, sstart, sstop, stime;
2343 GstBaseSinkPrivate *priv;
2345 GstStepInfo *current, *pending;
2348 priv = basesink->priv;
2351 sstart = sstop = rstart = rstop = GST_CLOCK_TIME_NONE;
2355 priv->current_rstart = GST_CLOCK_TIME_NONE;
2357 /* get stepping info */
2358 current = &priv->current_step;
2359 pending = &priv->pending_step;
2361 /* get timing information for this object against the render segment */
2362 syncable = gst_base_sink_get_sync_times (basesink, obj,
2363 &sstart, &sstop, &rstart, &rstop, &do_sync, &stepped, &basesink->segment,
2366 if (G_UNLIKELY (stepped))
2369 /* a syncable object needs to participate in preroll and
2370 * clocking. All buffers and EOS are syncable. */
2371 if (G_UNLIKELY (!syncable))
2374 /* store timing info for current object */
2375 priv->current_rstart = rstart;
2376 priv->current_rstop = (GST_CLOCK_TIME_IS_VALID (rstop) ? rstop : rstart);
2378 /* save sync time for eos when the previous object needed sync */
2379 priv->eos_rtime = (do_sync ? priv->current_rstop : GST_CLOCK_TIME_NONE);
2382 /* first do preroll, this makes sure we commit our state
2383 * to PAUSED and can continue to PLAYING. We cannot perform
2384 * any clock sync in PAUSED because there is no clock. */
2385 ret = gst_base_sink_do_preroll (basesink, obj);
2386 if (G_UNLIKELY (ret != GST_FLOW_OK))
2387 goto preroll_failed;
2389 /* update the segment with a pending step if the current one is invalid and we
2390 * have a new pending one. We only accept new step updates after a preroll */
2391 if (G_UNLIKELY (pending->valid && !current->valid)) {
2392 start_stepping (basesink, &basesink->segment, pending, current);
2396 /* After rendering we store the position of the last buffer so that we can use
2397 * it to report the position. We need to take the lock here. */
2398 GST_OBJECT_LOCK (basesink);
2399 priv->current_sstart = sstart;
2400 priv->current_sstop = (GST_CLOCK_TIME_IS_VALID (sstop) ? sstop : sstart);
2401 GST_OBJECT_UNLOCK (basesink);
2406 /* adjust for latency */
2407 stime = gst_base_sink_adjust_time (basesink, rstart);
2409 /* adjust for render-delay, avoid underflows */
2410 if (GST_CLOCK_TIME_IS_VALID (stime)) {
2411 if (stime > priv->render_delay)
2412 stime -= priv->render_delay;
2417 /* preroll done, we can sync since we are in PLAYING now. */
2418 GST_DEBUG_OBJECT (basesink, "possibly waiting for clock to reach %"
2419 GST_TIME_FORMAT ", adjusted %" GST_TIME_FORMAT,
2420 GST_TIME_ARGS (rstart), GST_TIME_ARGS (stime));
2422 /* This function will return immediatly if start == -1, no clock
2423 * or sync is disabled with GST_CLOCK_BADTIME. */
2424 status = gst_base_sink_wait_clock (basesink, stime, &jitter);
2426 GST_DEBUG_OBJECT (basesink, "clock returned %d, jitter %c%" GST_TIME_FORMAT,
2427 status, (jitter < 0 ? '-' : ' '), GST_TIME_ARGS (ABS (jitter)));
2429 /* invalid time, no clock or sync disabled, just render */
2430 if (status == GST_CLOCK_BADTIME)
2433 /* waiting could have been interrupted and we can be flushing now */
2434 if (G_UNLIKELY (basesink->flushing))
2437 /* check for unlocked by a state change, we are not flushing so
2438 * we can try to preroll on the current buffer. */
2439 if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED)) {
2440 GST_DEBUG_OBJECT (basesink, "unscheduled, waiting some more");
2441 priv->call_preroll = TRUE;
2445 /* successful syncing done, record observation */
2446 priv->current_jitter = jitter;
2448 /* check if the object should be dropped */
2449 *late = gst_base_sink_is_too_late (basesink, obj, rstart, rstop,
2458 GST_DEBUG_OBJECT (basesink, "skipped stepped object %p", obj);
2464 GST_DEBUG_OBJECT (basesink, "non syncable object %p", obj);
2469 GST_DEBUG_OBJECT (basesink, "we are flushing");
2470 return GST_FLOW_WRONG_STATE;
2474 GST_DEBUG_OBJECT (basesink, "preroll failed");
2481 gst_base_sink_send_qos (GstBaseSink * basesink,
2482 gdouble proportion, GstClockTime time, GstClockTimeDiff diff)
2487 /* generate Quality-of-Service event */
2488 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2489 "qos: proportion: %lf, diff %" G_GINT64_FORMAT ", timestamp %"
2490 GST_TIME_FORMAT, proportion, diff, GST_TIME_ARGS (time));
2492 event = gst_event_new_qos (proportion, diff, time);
2495 res = gst_pad_push_event (basesink->sinkpad, event);
2501 gst_base_sink_perform_qos (GstBaseSink * sink, gboolean dropped)
2503 GstBaseSinkPrivate *priv;
2504 GstClockTime start, stop;
2505 GstClockTimeDiff jitter;
2506 GstClockTime pt, entered, left;
2507 GstClockTime duration;
2512 start = priv->current_rstart;
2514 if (priv->current_step.valid)
2517 /* if Quality-of-Service disabled, do nothing */
2518 if (!g_atomic_int_get (&priv->qos_enabled) ||
2519 !GST_CLOCK_TIME_IS_VALID (start))
2522 stop = priv->current_rstop;
2523 jitter = priv->current_jitter;
2526 /* this is the time the buffer entered the sink */
2527 if (start < -jitter)
2530 entered = start + jitter;
2533 /* this is the time the buffer entered the sink */
2534 entered = start + jitter;
2535 /* this is the time the buffer left the sink */
2536 left = start + jitter;
2539 /* calculate duration of the buffer */
2540 if (GST_CLOCK_TIME_IS_VALID (stop))
2541 duration = stop - start;
2543 duration = GST_CLOCK_TIME_NONE;
2545 /* if we have the time when the last buffer left us, calculate
2546 * processing time */
2547 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2548 if (entered > priv->last_left) {
2549 pt = entered - priv->last_left;
2557 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "start: %" GST_TIME_FORMAT
2558 ", entered %" GST_TIME_FORMAT ", left %" GST_TIME_FORMAT ", pt: %"
2559 GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT ",jitter %"
2560 G_GINT64_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (entered),
2561 GST_TIME_ARGS (left), GST_TIME_ARGS (pt), GST_TIME_ARGS (duration),
2564 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "avg_duration: %" GST_TIME_FORMAT
2565 ", avg_pt: %" GST_TIME_FORMAT ", avg_rate: %g",
2566 GST_TIME_ARGS (priv->avg_duration), GST_TIME_ARGS (priv->avg_pt),
2569 /* collect running averages. for first observations, we copy the
2571 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_duration))
2572 priv->avg_duration = duration;
2574 priv->avg_duration = UPDATE_RUNNING_AVG (priv->avg_duration, duration);
2576 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_pt))
2579 priv->avg_pt = UPDATE_RUNNING_AVG (priv->avg_pt, pt);
2581 if (priv->avg_duration != 0)
2583 gst_guint64_to_gdouble (priv->avg_pt) /
2584 gst_guint64_to_gdouble (priv->avg_duration);
2588 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2589 if (dropped || priv->avg_rate < 0.0) {
2590 priv->avg_rate = rate;
2593 priv->avg_rate = UPDATE_RUNNING_AVG_N (priv->avg_rate, rate);
2595 priv->avg_rate = UPDATE_RUNNING_AVG_P (priv->avg_rate, rate);
2599 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink,
2600 "updated: avg_duration: %" GST_TIME_FORMAT ", avg_pt: %" GST_TIME_FORMAT
2601 ", avg_rate: %g", GST_TIME_ARGS (priv->avg_duration),
2602 GST_TIME_ARGS (priv->avg_pt), priv->avg_rate);
2605 if (priv->avg_rate >= 0.0) {
2606 /* if we have a valid rate, start sending QoS messages */
2607 if (priv->current_jitter < 0) {
2608 /* make sure we never go below 0 when adding the jitter to the
2610 if (priv->current_rstart < -priv->current_jitter)
2611 priv->current_jitter = -priv->current_rstart;
2613 gst_base_sink_send_qos (sink, priv->avg_rate, priv->current_rstart,
2614 priv->current_jitter);
2617 /* record when this buffer will leave us */
2618 priv->last_left = left;
2621 /* reset all qos measuring */
2623 gst_base_sink_reset_qos (GstBaseSink * sink)
2625 GstBaseSinkPrivate *priv;
2629 priv->last_in_time = GST_CLOCK_TIME_NONE;
2630 priv->last_left = GST_CLOCK_TIME_NONE;
2631 priv->avg_duration = GST_CLOCK_TIME_NONE;
2632 priv->avg_pt = GST_CLOCK_TIME_NONE;
2633 priv->avg_rate = -1.0;
2634 priv->avg_render = GST_CLOCK_TIME_NONE;
2640 /* Checks if the object was scheduled too late.
2642 * start/stop contain the raw timestamp start and stop values
2645 * status and jitter contain the return values from the clock wait.
2647 * returns TRUE if the buffer was too late.
2650 gst_base_sink_is_too_late (GstBaseSink * basesink, GstMiniObject * obj,
2651 GstClockTime start, GstClockTime stop,
2652 GstClockReturn status, GstClockTimeDiff jitter)
2655 gint64 max_lateness;
2656 GstBaseSinkPrivate *priv;
2658 priv = basesink->priv;
2662 /* only for objects that were too late */
2663 if (G_LIKELY (status != GST_CLOCK_EARLY))
2666 max_lateness = basesink->abidata.ABI.max_lateness;
2668 /* check if frame dropping is enabled */
2669 if (max_lateness == -1)
2672 /* only check for buffers */
2673 if (G_UNLIKELY (!GST_IS_BUFFER (obj)))
2676 /* can't do check if we don't have a timestamp */
2677 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (start)))
2680 /* we can add a valid stop time */
2681 if (GST_CLOCK_TIME_IS_VALID (stop))
2682 max_lateness += stop;
2684 max_lateness += start;
2686 /* if the jitter bigger than duration and lateness we are too late */
2687 if ((late = start + jitter > max_lateness)) {
2688 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2689 "buffer is too late %" GST_TIME_FORMAT
2690 " > %" GST_TIME_FORMAT, GST_TIME_ARGS (start + jitter),
2691 GST_TIME_ARGS (max_lateness));
2692 /* !!emergency!!, if we did not receive anything valid for more than a
2693 * second, render it anyway so the user sees something */
2694 if (GST_CLOCK_TIME_IS_VALID (priv->last_in_time) &&
2695 start - priv->last_in_time > GST_SECOND) {
2697 GST_ELEMENT_WARNING (basesink, CORE, CLOCK,
2698 (_("A lot of buffers are being dropped.")),
2699 ("There may be a timestamping problem, or this computer is too slow."));
2700 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2701 "**emergency** last buffer at %" GST_TIME_FORMAT " > GST_SECOND",
2702 GST_TIME_ARGS (priv->last_in_time));
2707 if (!late || !GST_CLOCK_TIME_IS_VALID (priv->last_in_time)) {
2708 priv->last_in_time = start;
2715 GST_DEBUG_OBJECT (basesink, "object was scheduled in time");
2720 GST_DEBUG_OBJECT (basesink, "frame dropping disabled");
2725 GST_DEBUG_OBJECT (basesink, "object is not a buffer");
2730 GST_DEBUG_OBJECT (basesink, "buffer has no timestamp");
2735 /* called before and after calling the render vmethod. It keeps track of how
2736 * much time was spent in the render method and is used to check if we are
2739 gst_base_sink_do_render_stats (GstBaseSink * basesink, gboolean start)
2741 GstBaseSinkPrivate *priv;
2743 priv = basesink->priv;
2746 priv->start = gst_util_get_timestamp ();
2748 GstClockTime elapsed;
2750 priv->stop = gst_util_get_timestamp ();
2752 elapsed = GST_CLOCK_DIFF (priv->start, priv->stop);
2754 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_render))
2755 priv->avg_render = elapsed;
2757 priv->avg_render = UPDATE_RUNNING_AVG (priv->avg_render, elapsed);
2759 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2760 "avg_render: %" GST_TIME_FORMAT, GST_TIME_ARGS (priv->avg_render));
2764 /* with STREAM_LOCK, PREROLL_LOCK,
2766 * Synchronize the object on the clock and then render it.
2768 * takes ownership of obj.
2770 static GstFlowReturn
2771 gst_base_sink_render_object (GstBaseSink * basesink, GstPad * pad,
2772 gboolean is_list, gpointer obj)
2775 GstBaseSinkClass *bclass;
2776 gboolean late, step_end;
2778 GstBaseSinkPrivate *priv;
2780 priv = basesink->priv;
2784 * If buffer list, use the first group buffer within the list
2787 sync_obj = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0, 0);
2788 g_assert (NULL != sync_obj);
2797 /* synchronize this object, non syncable objects return OK
2799 ret = gst_base_sink_do_sync (basesink, pad, sync_obj, &late, &step_end);
2800 if (G_UNLIKELY (ret != GST_FLOW_OK))
2803 /* and now render, event or buffer/buffer list. */
2804 if (G_LIKELY (is_list || GST_IS_BUFFER (obj))) {
2805 /* drop late buffers unconditionally, let's hope it's unlikely */
2806 if (G_UNLIKELY (late))
2809 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2811 if (G_LIKELY ((is_list && bclass->render_list) ||
2812 (!is_list && bclass->render))) {
2815 /* read once, to get same value before and after */
2816 do_qos = g_atomic_int_get (&priv->qos_enabled);
2818 GST_DEBUG_OBJECT (basesink, "rendering object %p", obj);
2820 /* record rendering time for QoS and stats */
2822 gst_base_sink_do_render_stats (basesink, TRUE);
2827 /* For buffer lists do not set last buffer. Creating buffer
2828 * with meaningful data can be done only with memcpy which will
2829 * significantly affect performance */
2830 buf = GST_BUFFER_CAST (obj);
2831 gst_base_sink_set_last_buffer (basesink, buf);
2833 ret = bclass->render (basesink, buf);
2835 GstBufferList *buflist;
2837 buflist = GST_BUFFER_LIST_CAST (obj);
2839 ret = bclass->render_list (basesink, buflist);
2843 gst_base_sink_do_render_stats (basesink, FALSE);
2845 if (ret == GST_FLOW_STEP)
2848 if (G_UNLIKELY (basesink->flushing))
2853 } else if (G_LIKELY (GST_IS_EVENT (obj))) {
2854 GstEvent *event = GST_EVENT_CAST (obj);
2855 gboolean event_res = TRUE;
2858 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2860 type = GST_EVENT_TYPE (event);
2862 GST_DEBUG_OBJECT (basesink, "rendering event %p, type %s", obj,
2863 gst_event_type_get_name (type));
2866 event_res = bclass->event (basesink, event);
2868 /* when we get here we could be flushing again when the event handler calls
2869 * _wait_eos(). We have to ignore this object in that case. */
2870 if (G_UNLIKELY (basesink->flushing))
2873 if (G_LIKELY (event_res)) {
2876 seqnum = basesink->priv->seqnum = gst_event_get_seqnum (event);
2877 GST_DEBUG_OBJECT (basesink, "Got seqnum #%" G_GUINT32_FORMAT, seqnum);
2882 GstMessage *message;
2884 /* the EOS event is completely handled so we mark
2885 * ourselves as being in the EOS state. eos is also
2886 * protected by the object lock so we can read it when
2887 * answering the POSITION query. */
2888 GST_OBJECT_LOCK (basesink);
2889 basesink->eos = TRUE;
2890 GST_OBJECT_UNLOCK (basesink);
2892 /* ok, now we can post the message */
2893 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
2895 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
2896 gst_message_set_seqnum (message, seqnum);
2897 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
2900 case GST_EVENT_NEWSEGMENT:
2901 /* configure the segment */
2902 gst_base_sink_configure_segment (basesink, pad, event,
2903 &basesink->segment);
2905 case GST_EVENT_SINK_MESSAGE:{
2906 GstMessage *msg = NULL;
2908 gst_event_parse_sink_message (event, &msg);
2911 gst_element_post_message (GST_ELEMENT_CAST (basesink), msg);
2918 g_return_val_if_reached (GST_FLOW_ERROR);
2923 /* the step ended, check if we need to activate a new step */
2924 GST_DEBUG_OBJECT (basesink, "step ended");
2925 stop_stepping (basesink, &basesink->segment, &priv->current_step,
2926 priv->current_rstart, priv->current_rstop, basesink->eos);
2930 gst_base_sink_perform_qos (basesink, late);
2932 GST_DEBUG_OBJECT (basesink, "object unref after render %p", obj);
2933 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
2939 GST_DEBUG_OBJECT (basesink, "do_sync returned %s", gst_flow_get_name (ret));
2945 GST_DEBUG_OBJECT (basesink, "buffer late, dropping");
2947 if (g_atomic_int_get (&priv->qos_enabled)) {
2948 GstMessage *qos_msg;
2949 GstClockTime timestamp, duration;
2951 timestamp = GST_BUFFER_TIMESTAMP (GST_BUFFER_CAST (sync_obj));
2952 duration = GST_BUFFER_DURATION (GST_BUFFER_CAST (sync_obj));
2954 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2955 "qos: dropped buffer rt %" GST_TIME_FORMAT ", st %" GST_TIME_FORMAT
2956 ", ts %" GST_TIME_FORMAT ", dur %" GST_TIME_FORMAT,
2957 GST_TIME_ARGS (priv->current_rstart),
2958 GST_TIME_ARGS (priv->current_sstart), GST_TIME_ARGS (timestamp),
2959 GST_TIME_ARGS (duration));
2960 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2961 "qos: rendered %" G_GUINT64_FORMAT ", dropped %" G_GUINT64_FORMAT,
2962 priv->rendered, priv->dropped);
2965 gst_message_new_qos (GST_OBJECT_CAST (basesink), basesink->sync,
2966 priv->current_rstart, priv->current_sstart, timestamp, duration);
2967 gst_message_set_qos_values (qos_msg, priv->current_jitter, priv->avg_rate,
2969 gst_message_set_qos_stats (qos_msg, GST_FORMAT_BUFFERS, priv->rendered,
2971 gst_element_post_message (GST_ELEMENT_CAST (basesink), qos_msg);
2977 GST_DEBUG_OBJECT (basesink, "we are flushing, ignore object");
2978 gst_mini_object_unref (obj);
2979 return GST_FLOW_WRONG_STATE;
2983 /* with STREAM_LOCK, PREROLL_LOCK
2985 * Perform preroll on the given object. For buffers this means
2986 * calling the preroll subclass method.
2987 * If that succeeds, the state will be commited.
2989 * function does not take ownership of obj.
2991 static GstFlowReturn
2992 gst_base_sink_preroll_object (GstBaseSink * basesink, gboolean is_list,
2993 GstMiniObject * obj)
2997 GST_DEBUG_OBJECT (basesink, "prerolling object %p", obj);
2999 /* if it's a buffer, we need to call the preroll method */
3000 if (G_LIKELY (is_list || GST_IS_BUFFER (obj)) && basesink->priv->call_preroll) {
3001 GstBaseSinkClass *bclass;
3003 GstClockTime timestamp;
3006 buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0, 0);
3007 g_assert (NULL != buf);
3009 buf = GST_BUFFER_CAST (obj);
3012 timestamp = GST_BUFFER_TIMESTAMP (buf);
3014 GST_DEBUG_OBJECT (basesink, "preroll buffer %" GST_TIME_FORMAT,
3015 GST_TIME_ARGS (timestamp));
3018 * For buffer lists do not set last buffer. Creating buffer
3019 * with meaningful data can be done only with memcpy which will
3020 * significantly affect performance
3023 gst_base_sink_set_last_buffer (basesink, buf);
3026 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3027 if (bclass->preroll)
3028 if ((ret = bclass->preroll (basesink, buf)) != GST_FLOW_OK)
3029 goto preroll_failed;
3031 basesink->priv->call_preroll = FALSE;
3035 if (G_LIKELY (basesink->playing_async)) {
3036 if (G_UNLIKELY (!gst_base_sink_commit_state (basesink)))
3045 GST_DEBUG_OBJECT (basesink, "preroll failed, abort state");
3046 gst_element_abort_state (GST_ELEMENT_CAST (basesink));
3051 GST_DEBUG_OBJECT (basesink, "stopping while commiting state");
3052 return GST_FLOW_WRONG_STATE;
3056 /* with STREAM_LOCK, PREROLL_LOCK
3058 * Queue an object for rendering.
3059 * The first prerollable object queued will complete the preroll. If the
3060 * preroll queue if filled, we render all the objects in the queue.
3062 * This function takes ownership of the object.
3064 static GstFlowReturn
3065 gst_base_sink_queue_object_unlocked (GstBaseSink * basesink, GstPad * pad,
3066 gboolean is_list, gpointer obj, gboolean prerollable)
3068 GstFlowReturn ret = GST_FLOW_OK;
3072 if (G_UNLIKELY (basesink->need_preroll)) {
3073 if (G_LIKELY (prerollable))
3074 basesink->preroll_queued++;
3076 length = basesink->preroll_queued;
3078 GST_DEBUG_OBJECT (basesink, "now %d prerolled items", length);
3080 /* first prerollable item needs to finish the preroll */
3082 ret = gst_base_sink_preroll_object (basesink, is_list, obj);
3083 if (G_UNLIKELY (ret != GST_FLOW_OK))
3084 goto preroll_failed;
3086 /* need to recheck if we need preroll, commmit state during preroll
3087 * could have made us not need more preroll. */
3088 if (G_UNLIKELY (basesink->need_preroll)) {
3089 /* see if we can render now, if we can't add the object to the preroll
3091 if (G_UNLIKELY (length <= basesink->preroll_queue_max_len))
3095 /* we can start rendering (or blocking) the queued object
3097 q = basesink->preroll_queue;
3098 while (G_UNLIKELY (!g_queue_is_empty (q))) {
3101 o = g_queue_pop_head (q);
3102 GST_DEBUG_OBJECT (basesink, "rendering queued object %p", o);
3104 /* do something with the return value */
3105 ret = gst_base_sink_render_object (basesink, pad, FALSE, o);
3106 if (ret != GST_FLOW_OK)
3107 goto dequeue_failed;
3110 /* now render the object */
3111 ret = gst_base_sink_render_object (basesink, pad, is_list, obj);
3112 basesink->preroll_queued = 0;
3119 GST_DEBUG_OBJECT (basesink, "preroll failed, reason %s",
3120 gst_flow_get_name (ret));
3121 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3126 /* add object to the queue and return */
3127 GST_DEBUG_OBJECT (basesink, "need more preroll data %d <= %d",
3128 length, basesink->preroll_queue_max_len);
3129 g_queue_push_tail (basesink->preroll_queue, obj);
3134 GST_DEBUG_OBJECT (basesink, "rendering queued objects failed, reason %s",
3135 gst_flow_get_name (ret));
3136 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3143 * This function grabs the PREROLL_LOCK and adds the object to
3146 * This function takes ownership of obj.
3148 static GstFlowReturn
3149 gst_base_sink_queue_object (GstBaseSink * basesink, GstPad * pad,
3150 GstMiniObject * obj, gboolean prerollable)
3154 GST_PAD_PREROLL_LOCK (pad);
3155 if (G_UNLIKELY (basesink->flushing))
3158 if (G_UNLIKELY (basesink->priv->received_eos))
3162 gst_base_sink_queue_object_unlocked (basesink, pad, FALSE, obj,
3164 GST_PAD_PREROLL_UNLOCK (pad);
3171 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3172 GST_PAD_PREROLL_UNLOCK (pad);
3173 gst_mini_object_unref (obj);
3174 return GST_FLOW_WRONG_STATE;
3178 GST_DEBUG_OBJECT (basesink,
3179 "we are EOS, dropping object, return UNEXPECTED");
3180 GST_PAD_PREROLL_UNLOCK (pad);
3181 gst_mini_object_unref (obj);
3182 return GST_FLOW_UNEXPECTED;
3187 gst_base_sink_flush_start (GstBaseSink * basesink, GstPad * pad)
3189 /* make sure we are not blocked on the clock also clear any pending
3191 gst_base_sink_set_flushing (basesink, pad, TRUE);
3193 /* we grab the stream lock but that is not needed since setting the
3194 * sink to flushing would make sure no state commit is being done
3196 GST_PAD_STREAM_LOCK (pad);
3197 gst_base_sink_reset_qos (basesink);
3198 if (basesink->priv->async_enabled) {
3199 /* and we need to commit our state again on the next
3200 * prerolled buffer */
3201 basesink->playing_async = TRUE;
3202 gst_element_lost_state (GST_ELEMENT_CAST (basesink));
3204 basesink->priv->have_latency = TRUE;
3205 basesink->need_preroll = FALSE;
3207 gst_base_sink_set_last_buffer (basesink, NULL);
3208 GST_PAD_STREAM_UNLOCK (pad);
3212 gst_base_sink_flush_stop (GstBaseSink * basesink, GstPad * pad)
3214 /* unset flushing so we can accept new data, this also flushes out any EOS
3216 gst_base_sink_set_flushing (basesink, pad, FALSE);
3218 /* for position reporting */
3219 GST_OBJECT_LOCK (basesink);
3220 basesink->priv->current_sstart = GST_CLOCK_TIME_NONE;
3221 basesink->priv->current_sstop = GST_CLOCK_TIME_NONE;
3222 basesink->priv->eos_rtime = GST_CLOCK_TIME_NONE;
3223 basesink->priv->call_preroll = TRUE;
3224 basesink->priv->current_step.valid = FALSE;
3225 basesink->priv->pending_step.valid = FALSE;
3226 if (basesink->pad_mode == GST_ACTIVATE_PUSH) {
3227 /* we need new segment info after the flush. */
3228 basesink->have_newsegment = FALSE;
3229 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
3230 gst_segment_init (basesink->abidata.ABI.clip_segment, GST_FORMAT_UNDEFINED);
3232 GST_OBJECT_UNLOCK (basesink);
3236 gst_base_sink_event (GstPad * pad, GstEvent * event)
3238 GstBaseSink *basesink;
3239 gboolean result = TRUE;
3240 GstBaseSinkClass *bclass;
3242 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3244 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3246 GST_DEBUG_OBJECT (basesink, "reveived event %p %" GST_PTR_FORMAT, event,
3249 switch (GST_EVENT_TYPE (event)) {
3254 GST_PAD_PREROLL_LOCK (pad);
3255 if (G_UNLIKELY (basesink->flushing))
3258 if (G_UNLIKELY (basesink->priv->received_eos)) {
3259 /* we can't accept anything when we are EOS */
3261 gst_event_unref (event);
3263 /* we set the received EOS flag here so that we can use it when testing if
3264 * we are prerolled and to refuse more buffers. */
3265 basesink->priv->received_eos = TRUE;
3267 /* EOS is a prerollable object, we call the unlocked version because it
3268 * does not check the received_eos flag. */
3269 ret = gst_base_sink_queue_object_unlocked (basesink, pad,
3270 FALSE, GST_MINI_OBJECT_CAST (event), TRUE);
3271 if (G_UNLIKELY (ret != GST_FLOW_OK))
3274 GST_PAD_PREROLL_UNLOCK (pad);
3277 case GST_EVENT_NEWSEGMENT:
3282 GST_DEBUG_OBJECT (basesink, "newsegment %p", event);
3284 GST_PAD_PREROLL_LOCK (pad);
3285 if (G_UNLIKELY (basesink->flushing))
3288 gst_event_parse_new_segment_full (event, &update, NULL, NULL, NULL, NULL,
3291 if (G_UNLIKELY (basesink->priv->received_eos && !update)) {
3292 /* we can't accept anything when we are EOS */
3294 gst_event_unref (event);
3296 /* the new segment is a non prerollable item and does not block anything,
3297 * we need to configure the current clipping segment and insert the event
3298 * in the queue to serialize it with the buffers for rendering. */
3299 gst_base_sink_configure_segment (basesink, pad, event,
3300 basesink->abidata.ABI.clip_segment);
3303 gst_base_sink_queue_object_unlocked (basesink, pad,
3304 FALSE, GST_MINI_OBJECT_CAST (event), FALSE);
3305 if (G_UNLIKELY (ret != GST_FLOW_OK))
3308 GST_OBJECT_LOCK (basesink);
3309 basesink->have_newsegment = TRUE;
3310 GST_OBJECT_UNLOCK (basesink);
3313 GST_PAD_PREROLL_UNLOCK (pad);
3316 case GST_EVENT_FLUSH_START:
3318 bclass->event (basesink, event);
3320 GST_DEBUG_OBJECT (basesink, "flush-start %p", event);
3322 gst_base_sink_flush_start (basesink, pad);
3324 gst_event_unref (event);
3326 case GST_EVENT_FLUSH_STOP:
3328 bclass->event (basesink, event);
3330 GST_DEBUG_OBJECT (basesink, "flush-stop %p", event);
3332 gst_base_sink_flush_stop (basesink, pad);
3334 gst_event_unref (event);
3337 /* other events are sent to queue or subclass depending on if they
3338 * are serialized. */
3339 if (GST_EVENT_IS_SERIALIZED (event)) {
3340 gst_base_sink_queue_object (basesink, pad,
3341 GST_MINI_OBJECT_CAST (event), FALSE);
3344 bclass->event (basesink, event);
3345 gst_event_unref (event);
3350 gst_object_unref (basesink);
3357 GST_DEBUG_OBJECT (basesink, "we are flushing");
3358 GST_PAD_PREROLL_UNLOCK (pad);
3360 gst_event_unref (event);
3365 /* default implementation to calculate the start and end
3366 * timestamps on a buffer, subclasses can override
3369 gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
3370 GstClockTime * start, GstClockTime * end)
3372 GstClockTime timestamp, duration;
3374 timestamp = GST_BUFFER_TIMESTAMP (buffer);
3375 if (GST_CLOCK_TIME_IS_VALID (timestamp)) {
3377 /* get duration to calculate end time */
3378 duration = GST_BUFFER_DURATION (buffer);
3379 if (GST_CLOCK_TIME_IS_VALID (duration)) {
3380 *end = timestamp + duration;
3386 /* must be called with PREROLL_LOCK */
3388 gst_base_sink_needs_preroll (GstBaseSink * basesink)
3390 gboolean is_prerolled, res;
3392 /* we have 2 cases where the PREROLL_LOCK is released:
3393 * 1) we are blocking in the PREROLL_LOCK and thus are prerolled.
3394 * 2) we are syncing on the clock
3396 is_prerolled = basesink->have_preroll || basesink->priv->received_eos;
3397 res = !is_prerolled;
3399 GST_DEBUG_OBJECT (basesink, "have_preroll: %d, EOS: %d => needs preroll: %d",
3400 basesink->have_preroll, basesink->priv->received_eos, res);
3405 /* with STREAM_LOCK, PREROLL_LOCK
3407 * Takes a buffer and compare the timestamps with the last segment.
3408 * If the buffer falls outside of the segment boundaries, drop it.
3409 * Else queue the buffer for preroll and rendering.
3411 * This function takes ownership of the buffer.
3413 static GstFlowReturn
3414 gst_base_sink_chain_unlocked (GstBaseSink * basesink, GstPad * pad,
3415 gboolean is_list, gpointer obj)
3417 GstBaseSinkClass *bclass;
3418 GstFlowReturn result;
3419 GstClockTime start = GST_CLOCK_TIME_NONE, end = GST_CLOCK_TIME_NONE;
3420 GstSegment *clip_segment;
3421 GstBuffer *time_buf;
3423 if (G_UNLIKELY (basesink->flushing))
3426 if (G_UNLIKELY (basesink->priv->received_eos))
3430 time_buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0, 0);
3431 g_assert (NULL != time_buf);
3433 time_buf = GST_BUFFER_CAST (obj);
3436 /* for code clarity */
3437 clip_segment = basesink->abidata.ABI.clip_segment;
3439 if (G_UNLIKELY (!basesink->have_newsegment)) {
3442 sync = gst_base_sink_get_sync (basesink);
3444 GST_ELEMENT_WARNING (basesink, STREAM, FAILED,
3445 (_("Internal data flow problem.")),
3446 ("Received buffer without a new-segment. Assuming timestamps start from 0."));
3449 /* this means this sink will assume timestamps start from 0 */
3450 GST_OBJECT_LOCK (basesink);
3451 clip_segment->start = 0;
3452 clip_segment->stop = -1;
3453 basesink->segment.start = 0;
3454 basesink->segment.stop = -1;
3455 basesink->have_newsegment = TRUE;
3456 GST_OBJECT_UNLOCK (basesink);
3459 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3461 /* check if the buffer needs to be dropped, we first ask the subclass for the
3463 if (bclass->get_times)
3464 bclass->get_times (basesink, time_buf, &start, &end);
3466 if (!GST_CLOCK_TIME_IS_VALID (start)) {
3467 /* if the subclass does not want sync, we use our own values so that we at
3468 * least clip the buffer to the segment */
3469 gst_base_sink_get_times (basesink, time_buf, &start, &end);
3472 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
3473 ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (end));
3475 /* a dropped buffer does not participate in anything */
3476 if (GST_CLOCK_TIME_IS_VALID (start) &&
3477 (clip_segment->format == GST_FORMAT_TIME)) {
3478 if (G_UNLIKELY (!gst_segment_clip (clip_segment,
3479 GST_FORMAT_TIME, (gint64) start, (gint64) end, NULL, NULL)))
3480 goto out_of_segment;
3483 /* now we can process the buffer in the queue, this function takes ownership
3485 result = gst_base_sink_queue_object_unlocked (basesink, pad,
3486 is_list, obj, TRUE);
3492 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3493 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3494 return GST_FLOW_WRONG_STATE;
3498 GST_DEBUG_OBJECT (basesink,
3499 "we are EOS, dropping object, return UNEXPECTED");
3500 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3501 return GST_FLOW_UNEXPECTED;
3505 GST_DEBUG_OBJECT (basesink, "dropping buffer, out of clipping segment");
3506 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3513 static GstFlowReturn
3514 gst_base_sink_chain_main (GstBaseSink * basesink, GstPad * pad,
3515 gboolean is_list, gpointer obj)
3517 GstFlowReturn result;
3519 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH))
3522 GST_PAD_PREROLL_LOCK (pad);
3523 result = gst_base_sink_chain_unlocked (basesink, pad, is_list, obj);
3524 GST_PAD_PREROLL_UNLOCK (pad);
3532 GST_OBJECT_LOCK (pad);
3533 GST_WARNING_OBJECT (basesink,
3534 "Push on pad %s:%s, but it was not activated in push mode",
3535 GST_DEBUG_PAD_NAME (pad));
3536 GST_OBJECT_UNLOCK (pad);
3537 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3538 /* we don't post an error message this will signal to the peer
3539 * pushing that EOS is reached. */
3540 result = GST_FLOW_UNEXPECTED;
3545 static GstFlowReturn
3546 gst_base_sink_chain (GstPad * pad, GstBuffer * buf)
3548 GstBaseSink *basesink;
3550 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3552 return gst_base_sink_chain_main (basesink, pad, FALSE, buf);
3555 static GstFlowReturn
3556 gst_base_sink_chain_list (GstPad * pad, GstBufferList * list)
3558 GstBaseSink *basesink;
3559 GstBaseSinkClass *bclass;
3560 GstFlowReturn result;
3562 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3563 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3565 if (G_LIKELY (bclass->render_list)) {
3566 result = gst_base_sink_chain_main (basesink, pad, TRUE, list);
3568 GstBufferListIterator *it;
3571 GST_INFO_OBJECT (pad, "chaining each group in list as a merged buffer");
3573 it = gst_buffer_list_iterate (list);
3575 if (gst_buffer_list_iterator_next_group (it)) {
3577 group = gst_buffer_list_iterator_merge_group (it);
3578 if (group == NULL) {
3579 group = gst_buffer_new ();
3580 GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining empty group");
3582 GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining group");
3584 result = gst_base_sink_chain_main (basesink, pad, FALSE, group);
3585 } while (result == GST_FLOW_OK
3586 && gst_buffer_list_iterator_next_group (it));
3588 GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining empty group");
3590 gst_base_sink_chain_main (basesink, pad, FALSE, gst_buffer_new ());
3592 gst_buffer_list_iterator_free (it);
3593 gst_buffer_list_unref (list);
3600 gst_base_sink_default_do_seek (GstBaseSink * sink, GstSegment * segment)
3602 gboolean res = TRUE;
3604 /* update our offset if the start/stop position was updated */
3605 if (segment->format == GST_FORMAT_BYTES) {
3606 segment->time = segment->start;
3607 } else if (segment->start == 0) {
3608 /* seek to start, we can implement a default for this. */
3612 GST_INFO_OBJECT (sink, "Can't do a default seek");
3618 #define SEEK_TYPE_IS_RELATIVE(t) (((t) != GST_SEEK_TYPE_NONE) && ((t) != GST_SEEK_TYPE_SET))
3621 gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
3622 GstEvent * event, GstSegment * segment)
3624 /* By default, we try one of 2 things:
3625 * - For absolute seek positions, convert the requested position to our
3626 * configured processing format and place it in the output segment \
3627 * - For relative seek positions, convert our current (input) values to the
3628 * seek format, adjust by the relative seek offset and then convert back to
3629 * the processing format
3631 GstSeekType cur_type, stop_type;
3634 GstFormat seek_format, dest_format;
3637 gboolean res = TRUE;
3639 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3640 &cur_type, &cur, &stop_type, &stop);
3641 dest_format = segment->format;
3643 if (seek_format == dest_format) {
3644 gst_segment_set_seek (segment, rate, seek_format, flags,
3645 cur_type, cur, stop_type, stop, &update);
3649 if (cur_type != GST_SEEK_TYPE_NONE) {
3650 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3652 gst_pad_query_convert (sink->sinkpad, seek_format, cur, &dest_format,
3654 cur_type = GST_SEEK_TYPE_SET;
3657 if (res && stop_type != GST_SEEK_TYPE_NONE) {
3658 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3660 gst_pad_query_convert (sink->sinkpad, seek_format, stop, &dest_format,
3662 stop_type = GST_SEEK_TYPE_SET;
3665 /* And finally, configure our output segment in the desired format */
3666 gst_segment_set_seek (segment, rate, dest_format, flags, cur_type, cur,
3667 stop_type, stop, &update);
3676 GST_DEBUG_OBJECT (sink, "undefined format given, seek aborted.");
3681 /* perform a seek, only executed in pull mode */
3683 gst_base_sink_perform_seek (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3687 GstFormat seek_format, dest_format;
3689 GstSeekType cur_type, stop_type;
3690 gboolean seekseg_configured = FALSE;
3692 gboolean update, res = TRUE;
3693 GstSegment seeksegment;
3695 dest_format = sink->segment.format;
3698 GST_DEBUG_OBJECT (sink, "performing seek with event %p", event);
3699 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3700 &cur_type, &cur, &stop_type, &stop);
3702 flush = flags & GST_SEEK_FLAG_FLUSH;
3704 GST_DEBUG_OBJECT (sink, "performing seek without event");
3709 GST_DEBUG_OBJECT (sink, "flushing upstream");
3710 gst_pad_push_event (pad, gst_event_new_flush_start ());
3711 gst_base_sink_flush_start (sink, pad);
3713 GST_DEBUG_OBJECT (sink, "pausing pulling thread");
3716 GST_PAD_STREAM_LOCK (pad);
3718 /* If we configured the seeksegment above, don't overwrite it now. Otherwise
3719 * copy the current segment info into the temp segment that we can actually
3720 * attempt the seek with. We only update the real segment if the seek suceeds. */
3721 if (!seekseg_configured) {
3722 memcpy (&seeksegment, &sink->segment, sizeof (GstSegment));
3724 /* now configure the final seek segment */
3726 if (sink->segment.format != seek_format) {
3727 /* OK, here's where we give the subclass a chance to convert the relative
3728 * seek into an absolute one in the processing format. We set up any
3729 * absolute seek above, before taking the stream lock. */
3730 if (!gst_base_sink_default_prepare_seek_segment (sink, event,
3732 GST_DEBUG_OBJECT (sink,
3733 "Preparing the seek failed after flushing. " "Aborting seek");
3737 /* The seek format matches our processing format, no need to ask the
3738 * the subclass to configure the segment. */
3739 gst_segment_set_seek (&seeksegment, rate, seek_format, flags,
3740 cur_type, cur, stop_type, stop, &update);
3743 /* Else, no seek event passed, so we're just (re)starting the
3748 GST_DEBUG_OBJECT (sink, "segment configured from %" G_GINT64_FORMAT
3749 " to %" G_GINT64_FORMAT ", position %" G_GINT64_FORMAT,
3750 seeksegment.start, seeksegment.stop, seeksegment.last_stop);
3752 /* do the seek, segment.last_stop contains the new position. */
3753 res = gst_base_sink_default_do_seek (sink, &seeksegment);
3758 GST_DEBUG_OBJECT (sink, "stop flushing upstream");
3759 gst_pad_push_event (pad, gst_event_new_flush_stop ());
3760 gst_base_sink_flush_stop (sink, pad);
3761 } else if (res && sink->abidata.ABI.running) {
3762 /* we are running the current segment and doing a non-flushing seek,
3763 * close the segment first based on the last_stop. */
3764 GST_DEBUG_OBJECT (sink, "closing running segment %" G_GINT64_FORMAT
3765 " to %" G_GINT64_FORMAT, sink->segment.start, sink->segment.last_stop);
3768 /* The subclass must have converted the segment to the processing format
3770 if (res && seeksegment.format != dest_format) {
3771 GST_DEBUG_OBJECT (sink, "Subclass failed to prepare a seek segment "
3772 "in the correct format. Aborting seek.");
3776 /* if successfull seek, we update our real segment and push
3777 * out the new segment. */
3779 memcpy (&sink->segment, &seeksegment, sizeof (GstSegment));
3781 if (sink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3782 gst_element_post_message (GST_ELEMENT (sink),
3783 gst_message_new_segment_start (GST_OBJECT (sink),
3784 sink->segment.format, sink->segment.last_stop));
3788 sink->priv->discont = TRUE;
3789 sink->abidata.ABI.running = TRUE;
3791 GST_PAD_STREAM_UNLOCK (pad);
3797 set_step_info (GstBaseSink * sink, GstStepInfo * current, GstStepInfo * pending,
3798 guint seqnum, GstFormat format, guint64 amount, gdouble rate,
3799 gboolean flush, gboolean intermediate)
3801 GST_OBJECT_LOCK (sink);
3802 pending->seqnum = seqnum;
3803 pending->format = format;
3804 pending->amount = amount;
3805 pending->position = 0;
3806 pending->rate = rate;
3807 pending->flush = flush;
3808 pending->intermediate = intermediate;
3809 pending->valid = TRUE;
3810 /* flush invalidates the current stepping segment */
3812 current->valid = FALSE;
3813 GST_OBJECT_UNLOCK (sink);
3817 gst_base_sink_perform_step (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3819 GstBaseSinkPrivate *priv;
3820 GstBaseSinkClass *bclass;
3821 gboolean flush, intermediate;
3826 GstStepInfo *pending, *current;
3827 GstMessage *message;
3829 bclass = GST_BASE_SINK_GET_CLASS (sink);
3832 GST_DEBUG_OBJECT (sink, "performing step with event %p", event);
3834 gst_event_parse_step (event, &format, &amount, &rate, &flush, &intermediate);
3835 seqnum = gst_event_get_seqnum (event);
3837 pending = &priv->pending_step;
3838 current = &priv->current_step;
3840 /* post message first */
3841 message = gst_message_new_step_start (GST_OBJECT (sink), FALSE, format,
3842 amount, rate, flush, intermediate);
3843 gst_message_set_seqnum (message, seqnum);
3844 gst_element_post_message (GST_ELEMENT (sink), message);
3847 /* we need to call ::unlock before locking PREROLL_LOCK
3848 * since we lock it before going into ::render */
3850 bclass->unlock (sink);
3852 GST_PAD_PREROLL_LOCK (sink->sinkpad);
3853 /* now that we have the PREROLL lock, clear our unlock request */
3854 if (bclass->unlock_stop)
3855 bclass->unlock_stop (sink);
3857 /* update the stepinfo and make it valid */
3858 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3861 if (sink->priv->async_enabled) {
3862 /* and we need to commit our state again on the next
3863 * prerolled buffer */
3864 sink->playing_async = TRUE;
3865 priv->pending_step.need_preroll = TRUE;
3866 sink->need_preroll = FALSE;
3867 gst_element_lost_state_full (GST_ELEMENT_CAST (sink), FALSE);
3869 sink->priv->have_latency = TRUE;
3870 sink->need_preroll = FALSE;
3872 priv->current_sstart = GST_CLOCK_TIME_NONE;
3873 priv->current_sstop = GST_CLOCK_TIME_NONE;
3874 priv->eos_rtime = GST_CLOCK_TIME_NONE;
3875 priv->call_preroll = TRUE;
3876 gst_base_sink_set_last_buffer (sink, NULL);
3877 gst_base_sink_reset_qos (sink);
3879 if (sink->clock_id) {
3880 gst_clock_id_unschedule (sink->clock_id);
3883 if (sink->have_preroll) {
3884 GST_DEBUG_OBJECT (sink, "signal waiter");
3885 priv->step_unlock = TRUE;
3886 GST_PAD_PREROLL_SIGNAL (sink->sinkpad);
3888 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
3890 /* update the stepinfo and make it valid */
3891 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3901 gst_base_sink_loop (GstPad * pad)
3903 GstBaseSink *basesink;
3904 GstBuffer *buf = NULL;
3905 GstFlowReturn result;
3909 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3911 g_assert (basesink->pad_mode == GST_ACTIVATE_PULL);
3913 if ((blocksize = basesink->priv->blocksize) == 0)
3916 offset = basesink->segment.last_stop;
3918 GST_DEBUG_OBJECT (basesink, "pulling %" G_GUINT64_FORMAT ", %u",
3921 result = gst_pad_pull_range (pad, offset, blocksize, &buf);
3922 if (G_UNLIKELY (result != GST_FLOW_OK))
3925 if (G_UNLIKELY (buf == NULL))
3928 offset += GST_BUFFER_SIZE (buf);
3930 gst_segment_set_last_stop (&basesink->segment, GST_FORMAT_BYTES, offset);
3932 GST_PAD_PREROLL_LOCK (pad);
3933 result = gst_base_sink_chain_unlocked (basesink, pad, FALSE, buf);
3934 GST_PAD_PREROLL_UNLOCK (pad);
3935 if (G_UNLIKELY (result != GST_FLOW_OK))
3943 GST_LOG_OBJECT (basesink, "pausing task, reason %s",
3944 gst_flow_get_name (result));
3945 gst_pad_pause_task (pad);
3946 if (result == GST_FLOW_UNEXPECTED) {
3947 /* perform EOS logic */
3948 if (basesink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3949 gst_element_post_message (GST_ELEMENT_CAST (basesink),
3950 gst_message_new_segment_done (GST_OBJECT_CAST (basesink),
3951 basesink->segment.format, basesink->segment.last_stop));
3953 gst_base_sink_event (pad, gst_event_new_eos ());
3955 } else if (result == GST_FLOW_NOT_LINKED || result <= GST_FLOW_UNEXPECTED) {
3956 /* for fatal errors we post an error message, post the error
3957 * first so the app knows about the error first.
3958 * wrong-state is not a fatal error because it happens due to
3959 * flushing and posting an error message in that case is the
3960 * wrong thing to do, e.g. when basesrc is doing a flushing
3962 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
3963 (_("Internal data stream error.")),
3964 ("stream stopped, reason %s", gst_flow_get_name (result)));
3965 gst_base_sink_event (pad, gst_event_new_eos ());
3971 GST_LOG_OBJECT (basesink, "no buffer, pausing");
3972 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
3973 (_("Internal data flow error.")), ("element returned NULL buffer"));
3974 result = GST_FLOW_ERROR;
3980 gst_base_sink_set_flushing (GstBaseSink * basesink, GstPad * pad,
3983 GstBaseSinkClass *bclass;
3985 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3988 /* unlock any subclasses, we need to do this before grabbing the
3989 * PREROLL_LOCK since we hold this lock before going into ::render. */
3991 bclass->unlock (basesink);
3994 GST_PAD_PREROLL_LOCK (pad);
3995 basesink->flushing = flushing;
3997 /* step 1, now that we have the PREROLL lock, clear our unlock request */
3998 if (bclass->unlock_stop)
3999 bclass->unlock_stop (basesink);
4001 /* set need_preroll before we unblock the clock. If the clock is unblocked
4002 * before timing out, we can reuse the buffer for preroll. */
4003 basesink->need_preroll = TRUE;
4005 /* step 2, unblock clock sync (if any) or any other blocking thing */
4006 if (basesink->clock_id) {
4007 gst_clock_id_unschedule (basesink->clock_id);
4010 /* flush out the data thread if it's locked in finish_preroll, this will
4011 * also flush out the EOS state */
4012 GST_DEBUG_OBJECT (basesink,
4013 "flushing out data thread, need preroll to TRUE");
4014 gst_base_sink_preroll_queue_flush (basesink, pad);
4016 GST_PAD_PREROLL_UNLOCK (pad);
4022 gst_base_sink_default_activate_pull (GstBaseSink * basesink, gboolean active)
4028 result = gst_pad_start_task (basesink->sinkpad,
4029 (GstTaskFunction) gst_base_sink_loop, basesink->sinkpad);
4031 /* step 2, make sure streaming finishes */
4032 result = gst_pad_stop_task (basesink->sinkpad);
4039 gst_base_sink_pad_activate (GstPad * pad)
4041 gboolean result = FALSE;
4042 GstBaseSink *basesink;
4044 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4046 GST_DEBUG_OBJECT (basesink, "Trying pull mode first");
4048 gst_base_sink_set_flushing (basesink, pad, FALSE);
4050 /* we need to have the pull mode enabled */
4051 if (!basesink->can_activate_pull) {
4052 GST_DEBUG_OBJECT (basesink, "pull mode disabled");
4056 /* check if downstreams supports pull mode at all */
4057 if (!gst_pad_check_pull_range (pad)) {
4058 GST_DEBUG_OBJECT (basesink, "pull mode not supported");
4062 /* set the pad mode before starting the task so that it's in the
4063 * correct state for the new thread. also the sink set_caps and get_caps
4064 * function checks this */
4065 basesink->pad_mode = GST_ACTIVATE_PULL;
4067 /* we first try to negotiate a format so that when we try to activate
4068 * downstream, it knows about our format */
4069 if (!gst_base_sink_negotiate_pull (basesink)) {
4070 GST_DEBUG_OBJECT (basesink, "failed to negotiate in pull mode");
4074 /* ok activate now */
4075 if (!gst_pad_activate_pull (pad, TRUE)) {
4076 /* clear any pending caps */
4077 GST_OBJECT_LOCK (basesink);
4078 gst_caps_replace (&basesink->priv->pull_caps, NULL);
4079 GST_OBJECT_UNLOCK (basesink);
4080 GST_DEBUG_OBJECT (basesink, "failed to activate in pull mode");
4084 GST_DEBUG_OBJECT (basesink, "Success activating pull mode");
4088 /* push mode fallback */
4090 GST_DEBUG_OBJECT (basesink, "Falling back to push mode");
4091 if ((result = gst_pad_activate_push (pad, TRUE))) {
4092 GST_DEBUG_OBJECT (basesink, "Success activating push mode");
4097 GST_WARNING_OBJECT (basesink, "Could not activate pad in either mode");
4098 gst_base_sink_set_flushing (basesink, pad, TRUE);
4101 gst_object_unref (basesink);
4107 gst_base_sink_pad_activate_push (GstPad * pad, gboolean active)
4110 GstBaseSink *basesink;
4112 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4115 if (!basesink->can_activate_push) {
4117 basesink->pad_mode = GST_ACTIVATE_NONE;
4120 basesink->pad_mode = GST_ACTIVATE_PUSH;
4123 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH)) {
4124 g_warning ("Internal GStreamer activation error!!!");
4127 gst_base_sink_set_flushing (basesink, pad, TRUE);
4129 basesink->pad_mode = GST_ACTIVATE_NONE;
4133 gst_object_unref (basesink);
4139 gst_base_sink_negotiate_pull (GstBaseSink * basesink)
4146 /* this returns the intersection between our caps and the peer caps. If there
4147 * is no peer, it returns NULL and we can't operate in pull mode so we can
4148 * fail the negotiation. */
4149 caps = gst_pad_get_allowed_caps (GST_BASE_SINK_PAD (basesink));
4150 if (caps == NULL || gst_caps_is_empty (caps))
4151 goto no_caps_possible;
4153 GST_DEBUG_OBJECT (basesink, "allowed caps: %" GST_PTR_FORMAT, caps);
4155 caps = gst_caps_make_writable (caps);
4156 /* get the first (prefered) format */
4157 gst_caps_truncate (caps);
4159 gst_pad_fixate_caps (GST_BASE_SINK_PAD (basesink), caps);
4161 GST_DEBUG_OBJECT (basesink, "fixated to: %" GST_PTR_FORMAT, caps);
4163 if (gst_caps_is_any (caps)) {
4164 GST_DEBUG_OBJECT (basesink, "caps were ANY after fixating, "
4166 /* neither side has template caps in this case, so they are prepared for
4167 pull() without setcaps() */
4169 } else if (gst_caps_is_fixed (caps)) {
4170 if (!gst_pad_set_caps (GST_BASE_SINK_PAD (basesink), caps))
4171 goto could_not_set_caps;
4173 GST_OBJECT_LOCK (basesink);
4174 gst_caps_replace (&basesink->priv->pull_caps, caps);
4175 GST_OBJECT_UNLOCK (basesink);
4180 gst_caps_unref (caps);
4186 GST_INFO_OBJECT (basesink, "Pipeline could not agree on caps");
4187 GST_DEBUG_OBJECT (basesink, "get_allowed_caps() returned EMPTY");
4189 gst_caps_unref (caps);
4194 GST_INFO_OBJECT (basesink, "Could not set caps: %" GST_PTR_FORMAT, caps);
4195 gst_caps_unref (caps);
4200 /* this won't get called until we implement an activate function */
4202 gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active)
4204 gboolean result = FALSE;
4205 GstBaseSink *basesink;
4206 GstBaseSinkClass *bclass;
4208 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4209 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4215 /* we mark we have a newsegment here because pull based
4216 * mode works just fine without having a newsegment before the
4218 format = GST_FORMAT_BYTES;
4220 gst_segment_init (&basesink->segment, format);
4221 gst_segment_init (basesink->abidata.ABI.clip_segment, format);
4222 GST_OBJECT_LOCK (basesink);
4223 basesink->have_newsegment = TRUE;
4224 GST_OBJECT_UNLOCK (basesink);
4226 /* get the peer duration in bytes */
4227 result = gst_pad_query_peer_duration (pad, &format, &duration);
4229 GST_DEBUG_OBJECT (basesink,
4230 "setting duration in bytes to %" G_GINT64_FORMAT, duration);
4231 gst_segment_set_duration (basesink->abidata.ABI.clip_segment, format,
4233 gst_segment_set_duration (&basesink->segment, format, duration);
4235 GST_DEBUG_OBJECT (basesink, "unknown duration");
4238 if (bclass->activate_pull)
4239 result = bclass->activate_pull (basesink, TRUE);
4244 goto activate_failed;
4247 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PULL)) {
4248 g_warning ("Internal GStreamer activation error!!!");
4251 result = gst_base_sink_set_flushing (basesink, pad, TRUE);
4252 if (bclass->activate_pull)
4253 result &= bclass->activate_pull (basesink, FALSE);
4254 basesink->pad_mode = GST_ACTIVATE_NONE;
4255 /* clear any pending caps */
4256 GST_OBJECT_LOCK (basesink);
4257 gst_caps_replace (&basesink->priv->pull_caps, NULL);
4258 GST_OBJECT_UNLOCK (basesink);
4261 gst_object_unref (basesink);
4268 /* reset, as starting the thread failed */
4269 basesink->pad_mode = GST_ACTIVATE_NONE;
4271 GST_ERROR_OBJECT (basesink, "subclass failed to activate in pull mode");
4276 /* send an event to our sinkpad peer. */
4278 gst_base_sink_send_event (GstElement * element, GstEvent * event)
4281 GstBaseSink *basesink = GST_BASE_SINK (element);
4282 gboolean forward, result = TRUE;
4283 GstActivateMode mode;
4285 GST_OBJECT_LOCK (element);
4286 /* get the pad and the scheduling mode */
4287 pad = gst_object_ref (basesink->sinkpad);
4288 mode = basesink->pad_mode;
4289 GST_OBJECT_UNLOCK (element);
4291 /* only push UPSTREAM events upstream */
4292 forward = GST_EVENT_IS_UPSTREAM (event);
4294 GST_DEBUG_OBJECT (basesink, "handling event %p %" GST_PTR_FORMAT, event,
4297 switch (GST_EVENT_TYPE (event)) {
4298 case GST_EVENT_LATENCY:
4300 GstClockTime latency;
4302 gst_event_parse_latency (event, &latency);
4304 /* store the latency. We use this to adjust the running_time before syncing
4305 * it to the clock. */
4306 GST_OBJECT_LOCK (element);
4307 basesink->priv->latency = latency;
4308 if (!basesink->priv->have_latency)
4310 GST_OBJECT_UNLOCK (element);
4311 GST_DEBUG_OBJECT (basesink, "latency set to %" GST_TIME_FORMAT,
4312 GST_TIME_ARGS (latency));
4314 /* We forward this event so that all elements know about the global pipeline
4315 * latency. This is interesting for an element when it wants to figure out
4316 * when a particular piece of data will be rendered. */
4319 case GST_EVENT_SEEK:
4320 /* in pull mode we will execute the seek */
4321 if (mode == GST_ACTIVATE_PULL)
4322 result = gst_base_sink_perform_seek (basesink, pad, event);
4324 case GST_EVENT_STEP:
4325 result = gst_base_sink_perform_step (basesink, pad, event);
4333 result = gst_pad_push_event (pad, event);
4335 /* not forwarded, unref the event */
4336 gst_event_unref (event);
4339 gst_object_unref (pad);
4343 /* get the end position of the last seen object, this is used
4344 * for EOS and for making sure that we don't report a position we
4345 * have not reached yet. With LOCK. */
4347 gst_base_sink_get_position_last (GstBaseSink * basesink, GstFormat format,
4348 gint64 * cur, gboolean * upstream)
4351 GstSegment *segment;
4352 gboolean ret = TRUE;
4354 segment = &basesink->segment;
4355 oformat = segment->format;
4357 if (oformat == GST_FORMAT_TIME) {
4358 /* return last observed stream time, we keep the stream time around in the
4360 *cur = basesink->priv->current_sstop;
4362 /* convert last stop to stream time */
4363 *cur = gst_segment_to_stream_time (segment, oformat, segment->last_stop);
4366 if (*cur != -1 && oformat != format) {
4367 GST_OBJECT_UNLOCK (basesink);
4368 /* convert to the target format if we need to, release lock first */
4370 gst_pad_query_convert (basesink->sinkpad, oformat, *cur, &format, cur);
4375 GST_OBJECT_LOCK (basesink);
4378 GST_DEBUG_OBJECT (basesink, "POSITION: %" GST_TIME_FORMAT,
4379 GST_TIME_ARGS (*cur));
4384 /* get the position when we are PAUSED, this is the stream time of the buffer
4385 * that prerolled. If no buffer is prerolled (we are still flushing), this
4386 * value will be -1. With LOCK. */
4388 gst_base_sink_get_position_paused (GstBaseSink * basesink, GstFormat format,
4389 gint64 * cur, gboolean * upstream)
4393 GstSegment *segment;
4396 /* we don't use the clip segment in pull mode, when seeking we update the
4397 * main segment directly with the new segment values without it having to be
4398 * activated by the rendering after preroll */
4399 if (basesink->pad_mode == GST_ACTIVATE_PUSH)
4400 segment = basesink->abidata.ABI.clip_segment;
4402 segment = &basesink->segment;
4403 oformat = segment->format;
4405 if (oformat == GST_FORMAT_TIME) {
4406 *cur = basesink->priv->current_sstart;
4407 if (segment->rate < 0.0 &&
4408 GST_CLOCK_TIME_IS_VALID (basesink->priv->current_sstop)) {
4409 /* for reverse playback we prefer the stream time stop position if we have
4411 *cur = basesink->priv->current_sstop;
4414 *cur = gst_segment_to_stream_time (segment, oformat, segment->last_stop);
4417 time = segment->time;
4420 *cur = MAX (*cur, time);
4421 GST_DEBUG_OBJECT (basesink, "POSITION as max: %" GST_TIME_FORMAT
4422 ", time %" GST_TIME_FORMAT, GST_TIME_ARGS (*cur), GST_TIME_ARGS (time));
4424 /* we have no buffer, use the segment times. */
4425 if (segment->rate >= 0.0) {
4426 /* forward, next position is always the time of the segment */
4428 GST_DEBUG_OBJECT (basesink, "POSITION as time: %" GST_TIME_FORMAT,
4429 GST_TIME_ARGS (*cur));
4431 /* reverse, next expected timestamp is segment->stop. We use the function
4432 * to get things right for negative applied_rates. */
4433 *cur = gst_segment_to_stream_time (segment, oformat, segment->stop);
4434 GST_DEBUG_OBJECT (basesink, "reverse POSITION: %" GST_TIME_FORMAT,
4435 GST_TIME_ARGS (*cur));
4440 if (res && oformat != format) {
4441 GST_OBJECT_UNLOCK (basesink);
4443 gst_pad_query_convert (basesink->sinkpad, oformat, *cur, &format, cur);
4448 GST_OBJECT_LOCK (basesink);
4455 gst_base_sink_get_position (GstBaseSink * basesink, GstFormat format,
4456 gint64 * cur, gboolean * upstream)
4459 gboolean res = FALSE;
4460 GstFormat oformat, tformat;
4461 GstClockTime now, latency;
4462 GstClockTimeDiff base;
4463 gint64 time, accum, duration;
4467 GST_OBJECT_LOCK (basesink);
4468 /* our intermediate time format */
4469 tformat = GST_FORMAT_TIME;
4470 /* get the format in the segment */
4471 oformat = basesink->segment.format;
4473 /* can only give answer based on the clock if not EOS */
4474 if (G_UNLIKELY (basesink->eos))
4477 /* we can only get the segment when we are not NULL or READY */
4478 if (!basesink->have_newsegment)
4481 /* when not in PLAYING or when we're busy with a state change, we
4482 * cannot read from the clock so we report time based on the
4483 * last seen timestamp. */
4484 if (GST_STATE (basesink) != GST_STATE_PLAYING ||
4485 GST_STATE_PENDING (basesink) != GST_STATE_VOID_PENDING)
4488 /* we need to sync on the clock. */
4489 if (basesink->sync == FALSE)
4492 /* and we need a clock */
4493 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (basesink)) == NULL))
4496 /* collect all data we need holding the lock */
4497 if (GST_CLOCK_TIME_IS_VALID (basesink->segment.time))
4498 time = basesink->segment.time;
4502 if (GST_CLOCK_TIME_IS_VALID (basesink->segment.stop))
4503 duration = basesink->segment.stop - basesink->segment.start;
4507 base = GST_ELEMENT_CAST (basesink)->base_time;
4508 accum = basesink->segment.accum;
4509 rate = basesink->segment.rate * basesink->segment.applied_rate;
4510 latency = basesink->priv->latency;
4512 gst_object_ref (clock);
4514 /* this function might release the LOCK */
4515 gst_base_sink_get_position_last (basesink, format, &last, upstream);
4517 /* need to release the object lock before we can get the time,
4518 * a clock might take the LOCK of the provider, which could be
4519 * a basesink subclass. */
4520 GST_OBJECT_UNLOCK (basesink);
4522 now = gst_clock_get_time (clock);
4524 if (oformat != tformat) {
4525 /* convert accum, time and duration to time */
4526 if (!gst_pad_query_convert (basesink->sinkpad, oformat, accum, &tformat,
4528 goto convert_failed;
4529 if (!gst_pad_query_convert (basesink->sinkpad, oformat, duration, &tformat,
4531 goto convert_failed;
4532 if (!gst_pad_query_convert (basesink->sinkpad, oformat, time, &tformat,
4534 goto convert_failed;
4537 /* subtract base time and accumulated time from the clock time.
4538 * Make sure we don't go negative. This is the current time in
4539 * the segment which we need to scale with the combined
4540 * rate and applied rate. */
4543 if (GST_CLOCK_DIFF (base, now) < 0)
4546 /* for negative rates we need to count back from the segment
4551 *cur = time + gst_guint64_to_gdouble (now - base) * rate;
4553 /* never report more than last seen position */
4555 *cur = MIN (last, *cur);
4557 gst_object_unref (clock);
4559 GST_DEBUG_OBJECT (basesink,
4560 "now %" GST_TIME_FORMAT " - base %" GST_TIME_FORMAT " - accum %"
4561 GST_TIME_FORMAT " + time %" GST_TIME_FORMAT,
4562 GST_TIME_ARGS (now), GST_TIME_ARGS (base),
4563 GST_TIME_ARGS (accum), GST_TIME_ARGS (time));
4565 if (oformat != format) {
4566 /* convert time to final format */
4567 if (!gst_pad_query_convert (basesink->sinkpad, tformat, *cur, &format, cur))
4568 goto convert_failed;
4574 GST_DEBUG_OBJECT (basesink, "res: %d, POSITION: %" GST_TIME_FORMAT,
4575 res, GST_TIME_ARGS (*cur));
4581 GST_DEBUG_OBJECT (basesink, "position in EOS");
4582 res = gst_base_sink_get_position_last (basesink, format, cur, upstream);
4583 GST_OBJECT_UNLOCK (basesink);
4588 GST_DEBUG_OBJECT (basesink, "position in PAUSED");
4589 res = gst_base_sink_get_position_paused (basesink, format, cur, upstream);
4590 GST_OBJECT_UNLOCK (basesink);
4595 /* in NULL or READY we always return FALSE and -1 */
4596 GST_DEBUG_OBJECT (basesink, "position in wrong state, return -1");
4599 GST_OBJECT_UNLOCK (basesink);
4604 /* report last seen timestamp if any, else ask upstream to answer */
4605 if ((*cur = basesink->priv->current_sstart) != -1)
4610 GST_DEBUG_OBJECT (basesink, "no sync, res %d, POSITION %" GST_TIME_FORMAT,
4611 res, GST_TIME_ARGS (*cur));
4612 GST_OBJECT_UNLOCK (basesink);
4617 GST_DEBUG_OBJECT (basesink, "convert failed, try upstream");
4624 gst_base_sink_get_duration (GstBaseSink * basesink, GstFormat format,
4625 gint64 * dur, gboolean * upstream)
4627 gboolean res = FALSE;
4629 if (basesink->pad_mode == GST_ACTIVATE_PULL) {
4630 GstFormat uformat = GST_FORMAT_BYTES;
4633 /* get the duration in bytes, in pull mode that's all we are sure to
4634 * know. We have to explicitly get this value from upstream instead of
4635 * using our cached value because it might change. Duration caching
4636 * should be done at a higher level. */
4637 res = gst_pad_query_peer_duration (basesink->sinkpad, &uformat, &uduration);
4639 gst_segment_set_duration (&basesink->segment, uformat, uduration);
4640 if (format != uformat) {
4641 /* convert to the requested format */
4642 res = gst_pad_query_convert (basesink->sinkpad, uformat, uduration,
4656 static const GstQueryType *
4657 gst_base_sink_get_query_types (GstElement * element)
4659 static const GstQueryType query_types[] = {
4671 gst_base_sink_query (GstElement * element, GstQuery * query)
4673 gboolean res = FALSE;
4675 GstBaseSink *basesink = GST_BASE_SINK (element);
4677 switch (GST_QUERY_TYPE (query)) {
4678 case GST_QUERY_POSITION:
4682 gboolean upstream = FALSE;
4684 gst_query_parse_position (query, &format, NULL);
4686 GST_DEBUG_OBJECT (basesink, "position query in format %s",
4687 gst_format_get_name (format));
4689 /* first try to get the position based on the clock */
4691 gst_base_sink_get_position (basesink, format, &cur, &upstream))) {
4692 gst_query_set_position (query, format, cur);
4693 } else if (upstream) {
4694 /* fallback to peer query */
4695 res = gst_pad_peer_query (basesink->sinkpad, query);
4698 /* we can handle a few things if upstream failed */
4699 if (format == GST_FORMAT_PERCENT) {
4701 GstFormat uformat = GST_FORMAT_TIME;
4703 res = gst_base_sink_get_position (basesink, GST_FORMAT_TIME, &cur,
4705 if (!res && upstream) {
4706 res = gst_pad_query_peer_position (basesink->sinkpad, &uformat,
4710 res = gst_base_sink_get_duration (basesink, GST_FORMAT_TIME, &dur,
4712 if (!res && upstream) {
4713 res = gst_pad_query_peer_duration (basesink->sinkpad, &uformat,
4720 pos = gst_util_uint64_scale (100 * GST_FORMAT_PERCENT_SCALE, cur,
4722 gst_query_set_position (query, GST_FORMAT_PERCENT, pos);
4728 case GST_QUERY_DURATION:
4732 gboolean upstream = FALSE;
4734 gst_query_parse_duration (query, &format, NULL);
4736 GST_DEBUG_OBJECT (basesink, "duration query in format %s",
4737 gst_format_get_name (format));
4740 gst_base_sink_get_duration (basesink, format, &dur, &upstream))) {
4741 gst_query_set_duration (query, format, dur);
4742 } else if (upstream) {
4743 /* fallback to peer query */
4744 res = gst_pad_peer_query (basesink->sinkpad, query);
4747 /* we can handle a few things if upstream failed */
4748 if (format == GST_FORMAT_PERCENT) {
4749 gst_query_set_duration (query, GST_FORMAT_PERCENT,
4750 GST_FORMAT_PERCENT_MAX);
4756 case GST_QUERY_LATENCY:
4758 gboolean live, us_live;
4759 GstClockTime min, max;
4761 if ((res = gst_base_sink_query_latency (basesink, &live, &us_live, &min,
4763 gst_query_set_latency (query, live, min, max);
4767 case GST_QUERY_JITTER:
4769 case GST_QUERY_RATE:
4770 /* gst_query_set_rate (query, basesink->segment_rate); */
4773 case GST_QUERY_SEGMENT:
4775 if (basesink->pad_mode == GST_ACTIVATE_PULL) {
4776 gst_query_set_segment (query, basesink->segment.rate,
4777 GST_FORMAT_TIME, basesink->segment.start, basesink->segment.stop);
4780 res = gst_pad_peer_query (basesink->sinkpad, query);
4784 case GST_QUERY_SEEKING:
4785 case GST_QUERY_CONVERT:
4786 case GST_QUERY_FORMATS:
4788 res = gst_pad_peer_query (basesink->sinkpad, query);
4791 GST_DEBUG_OBJECT (basesink, "query %s returns %d",
4792 GST_QUERY_TYPE_NAME (query), res);
4796 static GstStateChangeReturn
4797 gst_base_sink_change_state (GstElement * element, GstStateChange transition)
4799 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
4800 GstBaseSink *basesink = GST_BASE_SINK (element);
4801 GstBaseSinkClass *bclass;
4802 GstBaseSinkPrivate *priv;
4804 priv = basesink->priv;
4806 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4808 switch (transition) {
4809 case GST_STATE_CHANGE_NULL_TO_READY:
4811 if (!bclass->start (basesink))
4814 case GST_STATE_CHANGE_READY_TO_PAUSED:
4815 /* need to complete preroll before this state change completes, there
4816 * is no data flow in READY so we can safely assume we need to preroll. */
4817 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4818 GST_DEBUG_OBJECT (basesink, "READY to PAUSED");
4819 basesink->have_newsegment = FALSE;
4820 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
4821 gst_segment_init (basesink->abidata.ABI.clip_segment,
4822 GST_FORMAT_UNDEFINED);
4823 basesink->offset = 0;
4824 basesink->have_preroll = FALSE;
4825 priv->step_unlock = FALSE;
4826 basesink->need_preroll = TRUE;
4827 basesink->playing_async = TRUE;
4828 priv->current_sstart = GST_CLOCK_TIME_NONE;
4829 priv->current_sstop = GST_CLOCK_TIME_NONE;
4830 priv->eos_rtime = GST_CLOCK_TIME_NONE;
4832 basesink->eos = FALSE;
4833 priv->received_eos = FALSE;
4834 gst_base_sink_reset_qos (basesink);
4835 priv->commited = FALSE;
4836 priv->call_preroll = TRUE;
4837 priv->current_step.valid = FALSE;
4838 priv->pending_step.valid = FALSE;
4839 if (priv->async_enabled) {
4840 GST_DEBUG_OBJECT (basesink, "doing async state change");
4841 /* when async enabled, post async-start message and return ASYNC from
4842 * the state change function */
4843 ret = GST_STATE_CHANGE_ASYNC;
4844 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4845 gst_message_new_async_start (GST_OBJECT_CAST (basesink), FALSE));
4847 priv->have_latency = TRUE;
4849 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4851 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
4852 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4853 if (!gst_base_sink_needs_preroll (basesink)) {
4854 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, don't need preroll");
4855 /* no preroll needed anymore now. */
4856 basesink->playing_async = FALSE;
4857 basesink->need_preroll = FALSE;
4858 if (basesink->eos) {
4859 GstMessage *message;
4861 /* need to post EOS message here */
4862 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
4863 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
4864 gst_message_set_seqnum (message, basesink->priv->seqnum);
4865 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
4867 GST_DEBUG_OBJECT (basesink, "signal preroll");
4868 GST_PAD_PREROLL_SIGNAL (basesink->sinkpad);
4871 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, we are not prerolled");
4872 basesink->need_preroll = TRUE;
4873 basesink->playing_async = TRUE;
4874 priv->call_preroll = TRUE;
4875 priv->commited = FALSE;
4876 if (priv->async_enabled) {
4877 GST_DEBUG_OBJECT (basesink, "doing async state change");
4878 ret = GST_STATE_CHANGE_ASYNC;
4879 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4880 gst_message_new_async_start (GST_OBJECT_CAST (basesink), FALSE));
4883 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4890 GstStateChangeReturn bret;
4892 bret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
4893 if (G_UNLIKELY (bret == GST_STATE_CHANGE_FAILURE))
4894 goto activate_failed;
4897 switch (transition) {
4898 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
4899 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED");
4900 /* FIXME, make sure we cannot enter _render first */
4902 /* we need to call ::unlock before locking PREROLL_LOCK
4903 * since we lock it before going into ::render */
4905 bclass->unlock (basesink);
4907 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4908 GST_DEBUG_OBJECT (basesink, "got preroll lock");
4909 /* now that we have the PREROLL lock, clear our unlock request */
4910 if (bclass->unlock_stop)
4911 bclass->unlock_stop (basesink);
4913 /* we need preroll again and we set the flag before unlocking the clockid
4914 * because if the clockid is unlocked before a current buffer expired, we
4915 * can use that buffer to preroll with */
4916 basesink->need_preroll = TRUE;
4918 if (basesink->clock_id) {
4919 GST_DEBUG_OBJECT (basesink, "unschedule clock");
4920 gst_clock_id_unschedule (basesink->clock_id);
4923 /* if we don't have a preroll buffer we need to wait for a preroll and
4925 if (!gst_base_sink_needs_preroll (basesink)) {
4926 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED, we are prerolled");
4927 basesink->playing_async = FALSE;
4929 if (GST_STATE_TARGET (GST_ELEMENT (basesink)) <= GST_STATE_READY) {
4930 GST_DEBUG_OBJECT (basesink, "element is <= READY");
4931 ret = GST_STATE_CHANGE_SUCCESS;
4933 GST_DEBUG_OBJECT (basesink,
4934 "PLAYING to PAUSED, we are not prerolled");
4935 basesink->playing_async = TRUE;
4936 priv->commited = FALSE;
4937 priv->call_preroll = TRUE;
4938 if (priv->async_enabled) {
4939 GST_DEBUG_OBJECT (basesink, "doing async state change");
4940 ret = GST_STATE_CHANGE_ASYNC;
4941 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4942 gst_message_new_async_start (GST_OBJECT_CAST (basesink),
4947 GST_DEBUG_OBJECT (basesink, "rendered: %" G_GUINT64_FORMAT
4948 ", dropped: %" G_GUINT64_FORMAT, priv->rendered, priv->dropped);
4950 gst_base_sink_reset_qos (basesink);
4951 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4953 case GST_STATE_CHANGE_PAUSED_TO_READY:
4954 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4955 /* start by reseting our position state with the object lock so that the
4956 * position query gets the right idea. We do this before we post the
4957 * messages so that the message handlers pick this up. */
4958 GST_OBJECT_LOCK (basesink);
4959 basesink->have_newsegment = FALSE;
4960 priv->current_sstart = GST_CLOCK_TIME_NONE;
4961 priv->current_sstop = GST_CLOCK_TIME_NONE;
4962 priv->have_latency = FALSE;
4963 GST_OBJECT_UNLOCK (basesink);
4965 gst_base_sink_set_last_buffer (basesink, NULL);
4966 priv->call_preroll = FALSE;
4968 if (!priv->commited) {
4969 if (priv->async_enabled) {
4970 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, posting async-done");
4972 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4973 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
4974 GST_STATE_PLAYING, GST_STATE_PAUSED, GST_STATE_READY));
4976 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4977 gst_message_new_async_done (GST_OBJECT_CAST (basesink)));
4979 priv->commited = TRUE;
4981 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, don't need_preroll");
4983 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4985 case GST_STATE_CHANGE_READY_TO_NULL:
4987 if (!bclass->stop (basesink)) {
4988 GST_WARNING_OBJECT (basesink, "failed to stop");
4991 gst_base_sink_set_last_buffer (basesink, NULL);
4992 priv->call_preroll = FALSE;
5003 GST_DEBUG_OBJECT (basesink, "failed to start");
5004 return GST_STATE_CHANGE_FAILURE;
5008 GST_DEBUG_OBJECT (basesink,
5009 "element failed to change states -- activation problem?");
5010 return GST_STATE_CHANGE_FAILURE;