2 * Copyright (C) 2005-2007 Wim Taymans <wim.taymans@gmail.com>
4 * gstbasesink.c: Base class for sink elements
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
24 * @short_description: Base class for sink elements
25 * @see_also: #GstBaseTransform, #GstBaseSrc
27 * #GstBaseSink is the base class for sink elements in GStreamer, such as
28 * xvimagesink or filesink. It is a layer on top of #GstElement that provides a
29 * simplified interface to plugin writers. #GstBaseSink handles many details
30 * for you, for example: preroll, clock synchronization, state changes,
31 * activation in push or pull mode, and queries.
33 * In most cases, when writing sink elements, there is no need to implement
34 * class methods from #GstElement or to set functions on pads, because the
35 * #GstBaseSink infrastructure should be sufficient.
37 * #GstBaseSink provides support for exactly one sink pad, which should be
38 * named "sink". A sink implementation (subclass of #GstBaseSink) should
39 * install a pad template in its base_init function, like so:
42 * my_element_base_init (gpointer g_class)
44 * GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
46 * // sinktemplate should be a #GstStaticPadTemplate with direction
47 * // #GST_PAD_SINK and name "sink"
48 * gst_element_class_add_pad_template (gstelement_class,
49 * gst_static_pad_template_get (&sinktemplate));
50 * // see #GstElementDetails
51 * gst_element_class_set_details (gstelement_class, &details);
55 * #GstBaseSink will handle the prerolling correctly. This means that it will
56 * return #GST_STATE_CHANGE_ASYNC from a state change to PAUSED until the first
57 * buffer arrives in this element. The base class will call the
58 * #GstBaseSinkClass.preroll() vmethod with this preroll buffer and will then
59 * commit the state change to the next asynchronously pending state.
61 * When the element is set to PLAYING, #GstBaseSink will synchronise on the
62 * clock using the times returned from #GstBaseSinkClass.get_times(). If this
63 * function returns #GST_CLOCK_TIME_NONE for the start time, no synchronisation
64 * will be done. Synchronisation can be disabled entirely by setting the object
65 * #GstBaseSink:sync property to %FALSE.
67 * After synchronisation the virtual method #GstBaseSinkClass.render() will be
68 * called. Subclasses should minimally implement this method.
70 * Since 0.10.3 subclasses that synchronise on the clock in the
71 * #GstBaseSinkClass.render() method are supported as well. These classes
72 * typically receive a buffer in the render method and can then potentially
73 * block on the clock while rendering. A typical example is an audiosink.
74 * Since 0.10.11 these subclasses can use gst_base_sink_wait_preroll() to
75 * perform the blocking wait.
77 * Upon receiving the EOS event in the PLAYING state, #GstBaseSink will wait
78 * for the clock to reach the time indicated by the stop time of the last
79 * #GstBaseSinkClass.get_times() call before posting an EOS message. When the
80 * element receives EOS in PAUSED, preroll completes, the event is queued and an
81 * EOS message is posted when going to PLAYING.
83 * #GstBaseSink will internally use the #GST_EVENT_NEWSEGMENT events to schedule
84 * synchronisation and clipping of buffers. Buffers that fall completely outside
85 * of the current segment are dropped. Buffers that fall partially in the
86 * segment are rendered (and prerolled). Subclasses should do any subbuffer
87 * clipping themselves when needed.
89 * #GstBaseSink will by default report the current playback position in
90 * #GST_FORMAT_TIME based on the current clock time and segment information.
91 * If no clock has been set on the element, the query will be forwarded
94 * The #GstBaseSinkClass.set_caps() function will be called when the subclass
95 * should configure itself to process a specific media type.
97 * The #GstBaseSinkClass.start() and #GstBaseSinkClass.stop() virtual methods
98 * will be called when resources should be allocated. Any
99 * #GstBaseSinkClass.preroll(), #GstBaseSinkClass.render() and
100 * #GstBaseSinkClass.set_caps() function will be called between the
101 * #GstBaseSinkClass.start() and #GstBaseSinkClass.stop() calls.
103 * The #GstBaseSinkClass.event() virtual method will be called when an event is
104 * received by #GstBaseSink. Normally this method should only be overriden by
105 * very specific elements (such as file sinks) which need to handle the
106 * newsegment event specially.
108 * #GstBaseSink provides an overridable #GstBaseSinkClass.buffer_alloc()
109 * function that can be used by sinks that want to do reverse negotiation or to
110 * provide custom buffers (hardware buffers for example) to upstream elements.
112 * The #GstBaseSinkClass.unlock() method is called when the elements should
113 * unblock any blocking operations they perform in the
114 * #GstBaseSinkClass.render() method. This is mostly useful when the
115 * #GstBaseSinkClass.render() method performs a blocking write on a file
116 * descriptor, for example.
118 * The #GstBaseSink:max-lateness property affects how the sink deals with
119 * buffers that arrive too late in the sink. A buffer arrives too late in the
120 * sink when the presentation time (as a combination of the last segment, buffer
121 * timestamp and element base_time) plus the duration is before the current
123 * If the frame is later than max-lateness, the sink will drop the buffer
124 * without calling the render method.
125 * This feature is disabled if sync is disabled, the
126 * #GstBaseSinkClass.get_times() method does not return a valid start time or
127 * max-lateness is set to -1 (the default).
128 * Subclasses can use gst_base_sink_set_max_lateness() to configure the
129 * max-lateness value.
131 * The #GstBaseSink:qos property will enable the quality-of-service features of
132 * the basesink which gather statistics about the real-time performance of the
133 * clock synchronisation. For each buffer received in the sink, statistics are
134 * gathered and a QOS event is sent upstream with these numbers. This
135 * information can then be used by upstream elements to reduce their processing
138 * Since 0.10.15 the #GstBaseSink:async property can be used to instruct the
139 * sink to never perform an ASYNC state change. This feature is mostly usable
140 * when dealing with non-synchronized streams or sparse streams.
142 * Last reviewed on 2007-08-29 (0.10.15)
149 #include <gst/gst_private.h>
151 #include "gstbasesink.h"
152 #include <gst/gstmarshal.h>
153 #include <gst/gst-i18n-lib.h>
155 GST_DEBUG_CATEGORY_STATIC (gst_base_sink_debug);
156 #define GST_CAT_DEFAULT gst_base_sink_debug
158 #define GST_BASE_SINK_GET_PRIVATE(obj) \
159 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_BASE_SINK, GstBaseSinkPrivate))
161 #define GST_FLOW_STEP GST_FLOW_CUSTOM_ERROR
165 gboolean valid; /* if this info is valid */
166 guint32 seqnum; /* the seqnum of the STEP event */
167 GstFormat format; /* the format of the amount */
168 guint64 amount; /* the total amount of data to skip */
169 guint64 position; /* the position in the stepped data */
170 guint64 duration; /* the duration in time of the skipped data */
171 guint64 start; /* running_time of the start */
172 gdouble rate; /* rate of skipping */
173 gdouble start_rate; /* rate before skipping */
174 guint64 start_start; /* start position skipping */
175 guint64 start_stop; /* stop position skipping */
176 gboolean flush; /* if this was a flushing step */
177 gboolean intermediate; /* if this is an intermediate step */
178 gboolean need_preroll; /* if we need preroll after this step */
181 /* FIXME, some stuff in ABI.data and other in Private...
182 * Make up your mind please.
184 struct _GstBaseSinkPrivate
186 gint qos_enabled; /* ATOMIC */
187 gboolean async_enabled;
188 GstClockTimeDiff ts_offset;
189 GstClockTime render_delay;
191 /* start, stop of current buffer, stream time, used to report position */
192 GstClockTime current_sstart;
193 GstClockTime current_sstop;
195 /* start, stop and jitter of current buffer, running time */
196 GstClockTime current_rstart;
197 GstClockTime current_rstop;
198 GstClockTimeDiff current_jitter;
200 /* EOS sync time in running time */
201 GstClockTime eos_rtime;
203 /* last buffer that arrived in time, running time */
204 GstClockTime last_in_time;
205 /* when the last buffer left the sink, running time */
206 GstClockTime last_left;
208 /* running averages go here these are done on running time */
210 GstClockTime avg_duration;
213 /* these are done on system time. avg_jitter and avg_render are
214 * compared to eachother to see if the rendering time takes a
215 * huge amount of the processing, If so we are flooded with
217 GstClockTime last_left_systime;
218 GstClockTime avg_jitter;
219 GstClockTime start, stop;
220 GstClockTime avg_render;
222 /* number of rendered and dropped frames */
227 GstClockTime latency;
229 /* if we already commited the state */
232 /* when we received EOS */
233 gboolean received_eos;
235 /* when we are prerolled and able to report latency */
236 gboolean have_latency;
238 /* the last buffer we prerolled or rendered. Useful for making snapshots */
239 gint enable_last_buffer; /* atomic */
240 GstBuffer *last_buffer;
242 /* caps for pull based scheduling */
245 /* blocksize for pulling */
250 /* seqnum of the stream */
253 gboolean call_preroll;
254 gboolean step_unlock;
256 /* we have a pending and a current step operation */
257 GstStepInfo current_step;
258 GstStepInfo pending_step;
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 g_atomic_int_set (&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 if (!g_atomic_int_get (&sink->priv->enable_last_buffer))
982 GST_OBJECT_LOCK (sink);
983 gst_base_sink_set_last_buffer_unlocked (sink, buffer);
984 GST_OBJECT_UNLOCK (sink);
988 * gst_base_sink_set_last_buffer_enabled:
990 * @enabled: the new enable-last-buffer value.
992 * Configures @sink to store the last received buffer in the last-buffer
998 gst_base_sink_set_last_buffer_enabled (GstBaseSink * sink, gboolean enabled)
1000 g_return_if_fail (GST_IS_BASE_SINK (sink));
1002 /* Only take lock if we change the value */
1003 if (g_atomic_int_compare_and_exchange (&sink->priv->enable_last_buffer,
1004 !enabled, enabled) && !enabled) {
1005 GST_OBJECT_LOCK (sink);
1006 gst_base_sink_set_last_buffer_unlocked (sink, NULL);
1007 GST_OBJECT_UNLOCK (sink);
1012 * gst_base_sink_is_last_buffer_enabled:
1015 * Checks if @sink is currently configured to store the last received buffer in
1016 * the last-buffer property.
1018 * Returns: TRUE if the sink is configured to store the last received buffer.
1023 gst_base_sink_is_last_buffer_enabled (GstBaseSink * sink)
1025 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
1027 return g_atomic_int_get (&sink->priv->enable_last_buffer);
1031 * gst_base_sink_get_latency:
1034 * Get the currently configured latency.
1036 * Returns: The configured latency.
1041 gst_base_sink_get_latency (GstBaseSink * sink)
1045 GST_OBJECT_LOCK (sink);
1046 res = sink->priv->latency;
1047 GST_OBJECT_UNLOCK (sink);
1053 * gst_base_sink_query_latency:
1055 * @live: if the sink is live
1056 * @upstream_live: if an upstream element is live
1057 * @min_latency: the min latency of the upstream elements
1058 * @max_latency: the max latency of the upstream elements
1060 * Query the sink for the latency parameters. The latency will be queried from
1061 * the upstream elements. @live will be TRUE if @sink is configured to
1062 * synchronize against the clock. @upstream_live will be TRUE if an upstream
1065 * If both @live and @upstream_live are TRUE, the sink will want to compensate
1066 * for the latency introduced by the upstream elements by setting the
1067 * @min_latency to a strictly possitive value.
1069 * This function is mostly used by subclasses.
1071 * Returns: TRUE if the query succeeded.
1076 gst_base_sink_query_latency (GstBaseSink * sink, gboolean * live,
1077 gboolean * upstream_live, GstClockTime * min_latency,
1078 GstClockTime * max_latency)
1080 gboolean l, us_live, res, have_latency;
1081 GstClockTime min, max, render_delay;
1083 GstClockTime us_min, us_max;
1085 /* we are live when we sync to the clock */
1086 GST_OBJECT_LOCK (sink);
1088 have_latency = sink->priv->have_latency;
1089 render_delay = sink->priv->render_delay;
1090 GST_OBJECT_UNLOCK (sink);
1092 /* assume no latency */
1098 GST_DEBUG_OBJECT (sink, "we are ready for LATENCY query");
1099 /* we are ready for a latency query this is when we preroll or when we are
1101 query = gst_query_new_latency ();
1103 /* ask the peer for the latency */
1104 if ((res = gst_pad_peer_query (sink->sinkpad, query))) {
1105 /* get upstream min and max latency */
1106 gst_query_parse_latency (query, &us_live, &us_min, &us_max);
1109 /* upstream live, use its latency, subclasses should use these
1110 * values to create the complete latency. */
1115 /* we need to add the render delay if we are live */
1117 min += render_delay;
1119 max += render_delay;
1122 gst_query_unref (query);
1124 GST_DEBUG_OBJECT (sink, "we are not yet ready for LATENCY query");
1128 /* not live, we tried to do the query, if it failed we return TRUE anyway */
1132 GST_DEBUG_OBJECT (sink, "latency query failed but we are not live");
1134 GST_DEBUG_OBJECT (sink, "latency query failed and we are live");
1139 GST_DEBUG_OBJECT (sink, "latency query: live: %d, have_latency %d,"
1140 " upstream: %d, min %" GST_TIME_FORMAT ", max %" GST_TIME_FORMAT, l,
1141 have_latency, us_live, GST_TIME_ARGS (min), GST_TIME_ARGS (max));
1146 *upstream_live = us_live;
1156 * gst_base_sink_set_render_delay:
1157 * @sink: a #GstBaseSink
1158 * @delay: the new delay
1160 * Set the render delay in @sink to @delay. The render delay is the time
1161 * between actual rendering of a buffer and its synchronisation time. Some
1162 * devices might delay media rendering which can be compensated for with this
1165 * After calling this function, this sink will report additional latency and
1166 * other sinks will adjust their latency to delay the rendering of their media.
1168 * This function is usually called by subclasses.
1173 gst_base_sink_set_render_delay (GstBaseSink * sink, GstClockTime delay)
1175 GstClockTime old_render_delay;
1177 g_return_if_fail (GST_IS_BASE_SINK (sink));
1179 GST_OBJECT_LOCK (sink);
1180 old_render_delay = sink->priv->render_delay;
1181 sink->priv->render_delay = delay;
1182 GST_LOG_OBJECT (sink, "set render delay to %" GST_TIME_FORMAT,
1183 GST_TIME_ARGS (delay));
1184 GST_OBJECT_UNLOCK (sink);
1186 if (delay != old_render_delay) {
1187 GST_DEBUG_OBJECT (sink, "posting latency changed");
1188 gst_element_post_message (GST_ELEMENT_CAST (sink),
1189 gst_message_new_latency (GST_OBJECT_CAST (sink)));
1194 * gst_base_sink_get_render_delay:
1195 * @sink: a #GstBaseSink
1197 * Get the render delay of @sink. see gst_base_sink_set_render_delay() for more
1198 * information about the render delay.
1200 * Returns: the render delay of @sink.
1205 gst_base_sink_get_render_delay (GstBaseSink * sink)
1207 GstClockTimeDiff res;
1209 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1211 GST_OBJECT_LOCK (sink);
1212 res = sink->priv->render_delay;
1213 GST_OBJECT_UNLOCK (sink);
1219 * gst_base_sink_set_blocksize:
1220 * @sink: a #GstBaseSink
1221 * @blocksize: the blocksize in bytes
1223 * Set the number of bytes that the sink will pull when it is operating in pull
1229 gst_base_sink_set_blocksize (GstBaseSink * sink, guint blocksize)
1231 g_return_if_fail (GST_IS_BASE_SINK (sink));
1233 GST_OBJECT_LOCK (sink);
1234 sink->priv->blocksize = blocksize;
1235 GST_LOG_OBJECT (sink, "set blocksize to %u", blocksize);
1236 GST_OBJECT_UNLOCK (sink);
1240 * gst_base_sink_get_blocksize:
1241 * @sink: a #GstBaseSink
1243 * Get the number of bytes that the sink will pull when it is operating in pull
1246 * Returns: the number of bytes @sink will pull in pull mode.
1251 gst_base_sink_get_blocksize (GstBaseSink * sink)
1255 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1257 GST_OBJECT_LOCK (sink);
1258 res = sink->priv->blocksize;
1259 GST_OBJECT_UNLOCK (sink);
1265 gst_base_sink_set_property (GObject * object, guint prop_id,
1266 const GValue * value, GParamSpec * pspec)
1268 GstBaseSink *sink = GST_BASE_SINK (object);
1271 case PROP_PREROLL_QUEUE_LEN:
1272 /* preroll lock necessary to serialize with finish_preroll */
1273 GST_PAD_PREROLL_LOCK (sink->sinkpad);
1274 g_atomic_int_set (&sink->preroll_queue_max_len, g_value_get_uint (value));
1275 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
1278 gst_base_sink_set_sync (sink, g_value_get_boolean (value));
1280 case PROP_MAX_LATENESS:
1281 gst_base_sink_set_max_lateness (sink, g_value_get_int64 (value));
1284 gst_base_sink_set_qos_enabled (sink, g_value_get_boolean (value));
1287 gst_base_sink_set_async_enabled (sink, g_value_get_boolean (value));
1289 case PROP_TS_OFFSET:
1290 gst_base_sink_set_ts_offset (sink, g_value_get_int64 (value));
1292 case PROP_BLOCKSIZE:
1293 gst_base_sink_set_blocksize (sink, g_value_get_uint (value));
1295 case PROP_RENDER_DELAY:
1296 gst_base_sink_set_render_delay (sink, g_value_get_uint64 (value));
1298 case PROP_ENABLE_LAST_BUFFER:
1299 gst_base_sink_set_last_buffer_enabled (sink, g_value_get_boolean (value));
1302 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1308 gst_base_sink_get_property (GObject * object, guint prop_id, GValue * value,
1311 GstBaseSink *sink = GST_BASE_SINK (object);
1314 case PROP_PREROLL_QUEUE_LEN:
1315 g_value_set_uint (value, g_atomic_int_get (&sink->preroll_queue_max_len));
1318 g_value_set_boolean (value, gst_base_sink_get_sync (sink));
1320 case PROP_MAX_LATENESS:
1321 g_value_set_int64 (value, gst_base_sink_get_max_lateness (sink));
1324 g_value_set_boolean (value, gst_base_sink_is_qos_enabled (sink));
1327 g_value_set_boolean (value, gst_base_sink_is_async_enabled (sink));
1329 case PROP_TS_OFFSET:
1330 g_value_set_int64 (value, gst_base_sink_get_ts_offset (sink));
1332 case PROP_LAST_BUFFER:
1333 gst_value_take_buffer (value, gst_base_sink_get_last_buffer (sink));
1335 case PROP_ENABLE_LAST_BUFFER:
1336 g_value_set_boolean (value, gst_base_sink_is_last_buffer_enabled (sink));
1338 case PROP_BLOCKSIZE:
1339 g_value_set_uint (value, gst_base_sink_get_blocksize (sink));
1341 case PROP_RENDER_DELAY:
1342 g_value_set_uint64 (value, gst_base_sink_get_render_delay (sink));
1345 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1352 gst_base_sink_get_caps (GstBaseSink * sink)
1358 gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps)
1363 static GstFlowReturn
1364 gst_base_sink_buffer_alloc (GstBaseSink * sink, guint64 offset, guint size,
1365 GstCaps * caps, GstBuffer ** buf)
1371 /* with PREROLL_LOCK, STREAM_LOCK */
1373 gst_base_sink_preroll_queue_flush (GstBaseSink * basesink, GstPad * pad)
1377 GST_DEBUG_OBJECT (basesink, "flushing queue %p", basesink);
1378 while ((obj = g_queue_pop_head (basesink->preroll_queue))) {
1379 GST_DEBUG_OBJECT (basesink, "popped %p", obj);
1380 gst_mini_object_unref (obj);
1382 /* we can't have EOS anymore now */
1383 basesink->eos = FALSE;
1384 basesink->priv->received_eos = FALSE;
1385 basesink->have_preroll = FALSE;
1386 basesink->priv->step_unlock = FALSE;
1387 basesink->eos_queued = FALSE;
1388 basesink->preroll_queued = 0;
1389 basesink->buffers_queued = 0;
1390 basesink->events_queued = 0;
1391 /* can't report latency anymore until we preroll again */
1392 if (basesink->priv->async_enabled) {
1393 GST_OBJECT_LOCK (basesink);
1394 basesink->priv->have_latency = FALSE;
1395 GST_OBJECT_UNLOCK (basesink);
1397 /* and signal any waiters now */
1398 GST_PAD_PREROLL_SIGNAL (pad);
1401 /* with STREAM_LOCK, configures given segment with the event information. */
1403 gst_base_sink_configure_segment (GstBaseSink * basesink, GstPad * pad,
1404 GstEvent * event, GstSegment * segment)
1407 gdouble rate, arate;
1413 /* the newsegment event is needed to bring the buffer timestamps to the
1414 * stream time and to drop samples outside of the playback segment. */
1415 gst_event_parse_new_segment_full (event, &update, &rate, &arate, &format,
1416 &start, &stop, &time);
1418 /* The segment is protected with both the STREAM_LOCK and the OBJECT_LOCK.
1419 * We protect with the OBJECT_LOCK so that we can use the values to
1420 * safely answer a POSITION query. */
1421 GST_OBJECT_LOCK (basesink);
1422 gst_segment_set_newsegment_full (segment, update, rate, arate, format, start,
1425 if (format == GST_FORMAT_TIME) {
1426 GST_DEBUG_OBJECT (basesink,
1427 "configured NEWSEGMENT update %d, rate %lf, applied rate %lf, "
1428 "format GST_FORMAT_TIME, "
1429 "%" GST_TIME_FORMAT " -- %" GST_TIME_FORMAT
1430 ", time %" GST_TIME_FORMAT ", accum %" GST_TIME_FORMAT,
1431 update, rate, arate, GST_TIME_ARGS (segment->start),
1432 GST_TIME_ARGS (segment->stop), GST_TIME_ARGS (segment->time),
1433 GST_TIME_ARGS (segment->accum));
1435 GST_DEBUG_OBJECT (basesink,
1436 "configured NEWSEGMENT update %d, rate %lf, applied rate %lf, "
1438 "%" G_GINT64_FORMAT " -- %" G_GINT64_FORMAT ", time %"
1439 G_GINT64_FORMAT ", accum %" G_GINT64_FORMAT, update, rate, arate,
1440 segment->format, segment->start, segment->stop, segment->time,
1443 GST_OBJECT_UNLOCK (basesink);
1446 /* with PREROLL_LOCK, STREAM_LOCK */
1448 gst_base_sink_commit_state (GstBaseSink * basesink)
1450 /* commit state and proceed to next pending state */
1451 GstState current, next, pending, post_pending;
1452 gboolean post_paused = FALSE;
1453 gboolean post_async_done = FALSE;
1454 gboolean post_playing = FALSE;
1456 /* we are certainly not playing async anymore now */
1457 basesink->playing_async = FALSE;
1459 GST_OBJECT_LOCK (basesink);
1460 current = GST_STATE (basesink);
1461 next = GST_STATE_NEXT (basesink);
1462 pending = GST_STATE_PENDING (basesink);
1463 post_pending = pending;
1466 case GST_STATE_PLAYING:
1468 GstBaseSinkClass *bclass;
1469 GstStateChangeReturn ret;
1471 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1473 GST_DEBUG_OBJECT (basesink, "commiting state to PLAYING");
1475 basesink->need_preroll = FALSE;
1476 post_async_done = TRUE;
1477 basesink->priv->commited = TRUE;
1478 post_playing = TRUE;
1479 /* post PAUSED too when we were READY */
1480 if (current == GST_STATE_READY) {
1484 /* make sure we notify the subclass of async playing */
1485 if (bclass->async_play) {
1486 GST_WARNING_OBJECT (basesink, "deprecated async_play");
1487 ret = bclass->async_play (basesink);
1488 if (ret == GST_STATE_CHANGE_FAILURE)
1493 case GST_STATE_PAUSED:
1494 GST_DEBUG_OBJECT (basesink, "commiting state to PAUSED");
1496 post_async_done = TRUE;
1497 basesink->priv->commited = TRUE;
1498 post_pending = GST_STATE_VOID_PENDING;
1500 case GST_STATE_READY:
1501 case GST_STATE_NULL:
1503 case GST_STATE_VOID_PENDING:
1504 goto nothing_pending;
1509 /* we can report latency queries now */
1510 basesink->priv->have_latency = TRUE;
1512 GST_STATE (basesink) = pending;
1513 GST_STATE_NEXT (basesink) = GST_STATE_VOID_PENDING;
1514 GST_STATE_PENDING (basesink) = GST_STATE_VOID_PENDING;
1515 GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_SUCCESS;
1516 GST_OBJECT_UNLOCK (basesink);
1519 GST_DEBUG_OBJECT (basesink, "posting PAUSED state change message");
1520 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1521 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1522 current, next, post_pending));
1524 if (post_async_done) {
1525 GST_DEBUG_OBJECT (basesink, "posting async-done message");
1526 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1527 gst_message_new_async_done (GST_OBJECT_CAST (basesink)));
1530 GST_DEBUG_OBJECT (basesink, "posting PLAYING state change message");
1531 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1532 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1533 next, pending, GST_STATE_VOID_PENDING));
1536 GST_STATE_BROADCAST (basesink);
1542 /* Depending on the state, set our vars. We get in this situation when the
1543 * state change function got a change to update the state vars before the
1544 * streaming thread did. This is fine but we need to make sure that we
1545 * update the need_preroll var since it was TRUE when we got here and might
1546 * become FALSE if we got to PLAYING. */
1547 GST_DEBUG_OBJECT (basesink, "nothing to commit, now in %s",
1548 gst_element_state_get_name (current));
1550 case GST_STATE_PLAYING:
1551 basesink->need_preroll = FALSE;
1553 case GST_STATE_PAUSED:
1554 basesink->need_preroll = TRUE;
1557 basesink->need_preroll = FALSE;
1558 basesink->flushing = TRUE;
1561 /* we can report latency queries now */
1562 basesink->priv->have_latency = TRUE;
1563 GST_OBJECT_UNLOCK (basesink);
1568 /* app is going to READY */
1569 GST_DEBUG_OBJECT (basesink, "stopping");
1570 basesink->need_preroll = FALSE;
1571 basesink->flushing = TRUE;
1572 GST_OBJECT_UNLOCK (basesink);
1577 GST_DEBUG_OBJECT (basesink, "async commit failed");
1578 GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_FAILURE;
1579 GST_OBJECT_UNLOCK (basesink);
1585 start_stepping (GstBaseSink * sink, GstSegment * segment,
1586 GstStepInfo * pending, GstStepInfo * current)
1589 GstMessage *message;
1591 GST_DEBUG_OBJECT (sink, "update pending step");
1593 GST_OBJECT_LOCK (sink);
1594 memcpy (current, pending, sizeof (GstStepInfo));
1595 pending->valid = FALSE;
1596 GST_OBJECT_UNLOCK (sink);
1598 /* post message first */
1600 gst_message_new_step_start (GST_OBJECT (sink), TRUE, current->format,
1601 current->amount, current->rate, current->flush, current->intermediate);
1602 gst_message_set_seqnum (message, current->seqnum);
1603 gst_element_post_message (GST_ELEMENT (sink), message);
1605 /* get the running time of where we paused and remember it */
1606 current->start = gst_element_get_start_time (GST_ELEMENT_CAST (sink));
1607 gst_segment_set_running_time (segment, GST_FORMAT_TIME, current->start);
1609 /* set the new rate for the remainder of the segment */
1610 current->start_rate = segment->rate;
1611 segment->rate *= current->rate;
1612 segment->abs_rate = ABS (segment->rate);
1615 if (segment->rate > 0.0)
1616 current->start_stop = segment->stop;
1618 current->start_start = segment->start;
1620 if (current->format == GST_FORMAT_TIME) {
1621 end = current->start + current->amount;
1622 if (!current->flush) {
1623 /* update the segment clipping regions for non-flushing seeks */
1624 if (segment->rate > 0.0) {
1625 segment->stop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1626 segment->last_stop = segment->stop;
1630 position = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1631 segment->time = position;
1632 segment->start = position;
1633 segment->last_stop = position;
1638 GST_DEBUG_OBJECT (sink,
1639 "segment now rate %lf, applied rate %lf, "
1640 "format GST_FORMAT_TIME, "
1641 "%" GST_TIME_FORMAT " -- %" GST_TIME_FORMAT
1642 ", time %" GST_TIME_FORMAT ", accum %" GST_TIME_FORMAT,
1643 segment->rate, segment->applied_rate, GST_TIME_ARGS (segment->start),
1644 GST_TIME_ARGS (segment->stop), GST_TIME_ARGS (segment->time),
1645 GST_TIME_ARGS (segment->accum));
1647 GST_DEBUG_OBJECT (sink, "step started at running_time %" GST_TIME_FORMAT,
1648 GST_TIME_ARGS (current->start));
1650 if (current->amount == -1) {
1651 GST_DEBUG_OBJECT (sink, "step amount == -1, stop stepping");
1652 current->valid = FALSE;
1654 GST_DEBUG_OBJECT (sink, "step amount: %" G_GUINT64_FORMAT ", format: %s, "
1655 "rate: %f", current->amount, gst_format_get_name (current->format),
1661 stop_stepping (GstBaseSink * sink, GstSegment * segment,
1662 GstStepInfo * current, gint64 rstart, gint64 rstop, gboolean eos)
1664 gint64 stop, position;
1665 GstMessage *message;
1667 GST_DEBUG_OBJECT (sink, "step complete");
1669 if (segment->rate > 0.0)
1674 GST_DEBUG_OBJECT (sink,
1675 "step stop at running_time %" GST_TIME_FORMAT, GST_TIME_ARGS (stop));
1678 current->duration = current->position;
1680 current->duration = stop - current->start;
1682 GST_DEBUG_OBJECT (sink, "step elapsed running_time %" GST_TIME_FORMAT,
1683 GST_TIME_ARGS (current->duration));
1685 position = current->start + current->duration;
1687 /* now move the segment to the new running time */
1688 gst_segment_set_running_time (segment, GST_FORMAT_TIME, position);
1690 if (current->flush) {
1691 /* and remove the accumulated time we flushed, start time did not change */
1692 segment->accum = current->start;
1694 /* start time is now the stepped position */
1695 gst_element_set_start_time (GST_ELEMENT_CAST (sink), position);
1698 /* restore the previous rate */
1699 segment->rate = current->start_rate;
1700 segment->abs_rate = ABS (segment->rate);
1702 if (segment->rate > 0.0)
1703 segment->stop = current->start_stop;
1705 segment->start = current->start_start;
1707 /* the clip segment is used for position report in paused... */
1708 memcpy (sink->abidata.ABI.clip_segment, segment, sizeof (GstSegment));
1710 /* post the step done when we know the stepped duration in TIME */
1712 gst_message_new_step_done (GST_OBJECT_CAST (sink), current->format,
1713 current->amount, current->rate, current->flush, current->intermediate,
1714 current->duration, eos);
1715 gst_message_set_seqnum (message, current->seqnum);
1716 gst_element_post_message (GST_ELEMENT_CAST (sink), message);
1718 if (!current->intermediate)
1719 sink->need_preroll = current->need_preroll;
1721 /* and the current step info finished and becomes invalid */
1722 current->valid = FALSE;
1726 handle_stepping (GstBaseSink * sink, GstSegment * segment,
1727 GstStepInfo * current, gint64 * cstart, gint64 * cstop, gint64 * rstart,
1730 gboolean step_end = FALSE;
1732 /* see if we need to skip this buffer because of stepping */
1733 switch (current->format) {
1734 case GST_FORMAT_TIME:
1739 if (segment->rate > 0.0) {
1740 if (segment->stop == *cstop)
1741 *rstop = *rstart + current->amount;
1746 if (segment->start == *cstart)
1747 *rstart = *rstop + current->amount;
1753 end = current->start + current->amount;
1754 current->position = first - current->start;
1756 if (G_UNLIKELY (segment->abs_rate != 1.0))
1757 current->position /= segment->abs_rate;
1759 GST_DEBUG_OBJECT (sink,
1760 "buffer: %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT,
1761 GST_TIME_ARGS (first), GST_TIME_ARGS (last));
1762 GST_DEBUG_OBJECT (sink,
1763 "got time step %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT "/%"
1764 GST_TIME_FORMAT, GST_TIME_ARGS (current->position),
1765 GST_TIME_ARGS (last - current->start),
1766 GST_TIME_ARGS (current->amount));
1768 if ((current->flush && current->position >= current->amount)
1770 GST_DEBUG_OBJECT (sink, "step ended, we need clipping");
1772 if (segment->rate > 0.0) {
1774 *cstart = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1777 *cstop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1780 GST_DEBUG_OBJECT (sink,
1781 "cstart %" GST_TIME_FORMAT ", rstart %" GST_TIME_FORMAT,
1782 GST_TIME_ARGS (*cstart), GST_TIME_ARGS (*rstart));
1783 GST_DEBUG_OBJECT (sink,
1784 "cstop %" GST_TIME_FORMAT ", rstop %" GST_TIME_FORMAT,
1785 GST_TIME_ARGS (*cstop), GST_TIME_ARGS (*rstop));
1788 case GST_FORMAT_BUFFERS:
1789 GST_DEBUG_OBJECT (sink,
1790 "got default step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1791 current->position, current->amount);
1793 if (current->position < current->amount) {
1794 current->position++;
1799 case GST_FORMAT_DEFAULT:
1801 GST_DEBUG_OBJECT (sink,
1802 "got unknown step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1803 current->position, current->amount);
1809 /* with STREAM_LOCK, PREROLL_LOCK
1811 * Returns TRUE if the object needs synchronisation and takes therefore
1812 * part in prerolling.
1814 * rsstart/rsstop contain the start/stop in stream time.
1815 * rrstart/rrstop contain the start/stop in running time.
1818 gst_base_sink_get_sync_times (GstBaseSink * basesink, GstMiniObject * obj,
1819 GstClockTime * rsstart, GstClockTime * rsstop,
1820 GstClockTime * rrstart, GstClockTime * rrstop, gboolean * do_sync,
1821 gboolean * stepped, GstSegment * segment, GstStepInfo * step,
1822 gboolean * step_end)
1824 GstBaseSinkClass *bclass;
1826 GstClockTime start, stop; /* raw start/stop timestamps */
1827 gint64 cstart, cstop; /* clipped raw timestamps */
1828 gint64 rstart, rstop; /* clipped timestamps converted to running time */
1829 GstClockTime sstart, sstop; /* clipped timestamps converted to stream time */
1831 GstBaseSinkPrivate *priv;
1834 priv = basesink->priv;
1836 /* start with nothing */
1837 start = stop = GST_CLOCK_TIME_NONE;
1839 if (G_UNLIKELY (GST_IS_EVENT (obj))) {
1840 GstEvent *event = GST_EVENT_CAST (obj);
1842 switch (GST_EVENT_TYPE (event)) {
1843 /* EOS event needs syncing */
1846 if (basesink->segment.rate >= 0.0) {
1847 sstart = sstop = priv->current_sstop;
1848 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1849 /* we have not seen a buffer yet, use the segment values */
1850 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1851 basesink->segment.format, basesink->segment.stop);
1854 sstart = sstop = priv->current_sstart;
1855 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1856 /* we have not seen a buffer yet, use the segment values */
1857 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1858 basesink->segment.format, basesink->segment.start);
1862 rstart = rstop = priv->eos_rtime;
1863 *do_sync = rstart != -1;
1864 GST_DEBUG_OBJECT (basesink, "sync times for EOS %" GST_TIME_FORMAT,
1865 GST_TIME_ARGS (rstart));
1866 /* if we are stepping, we end now */
1867 *step_end = step->valid;
1872 /* other events do not need syncing */
1873 /* FIXME, maybe NEWSEGMENT might need synchronisation
1874 * since the POSITION query depends on accumulated times and
1875 * we cannot accumulate the current segment before the previous
1885 /* else do buffer sync code */
1886 buffer = GST_BUFFER_CAST (obj);
1888 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1890 /* just get the times to see if we need syncing, if the start returns -1 we
1892 if (bclass->get_times)
1893 bclass->get_times (basesink, buffer, &start, &stop);
1895 if (!GST_CLOCK_TIME_IS_VALID (start)) {
1896 /* we don't need to sync but we still want to get the timestamps for
1897 * tracking the position */
1898 gst_base_sink_get_times (basesink, buffer, &start, &stop);
1904 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
1905 ", stop: %" GST_TIME_FORMAT ", do_sync %d", GST_TIME_ARGS (start),
1906 GST_TIME_ARGS (stop), *do_sync);
1908 /* collect segment and format for code clarity */
1909 format = segment->format;
1911 /* no timestamp clipping if we did not get a TIME segment format */
1912 if (G_UNLIKELY (format != GST_FORMAT_TIME)) {
1915 /* do running and stream time in TIME format */
1916 format = GST_FORMAT_TIME;
1917 GST_LOG_OBJECT (basesink, "not time format, don't clip");
1921 /* clip, only when we know about time */
1922 if (G_UNLIKELY (!gst_segment_clip (segment, GST_FORMAT_TIME,
1923 (gint64) start, (gint64) stop, &cstart, &cstop))) {
1925 GST_DEBUG_OBJECT (basesink, "step out of segment");
1926 /* when we are stepping, pretend we're at the end of the segment */
1927 if (segment->rate > 0.0) {
1928 cstart = segment->stop;
1929 cstop = segment->stop;
1931 cstart = segment->start;
1932 cstop = segment->start;
1936 goto out_of_segment;
1939 if (G_UNLIKELY (start != cstart || stop != cstop)) {
1940 GST_DEBUG_OBJECT (basesink, "clipped to: start %" GST_TIME_FORMAT
1941 ", stop: %" GST_TIME_FORMAT, GST_TIME_ARGS (cstart),
1942 GST_TIME_ARGS (cstop));
1945 /* set last stop position */
1946 if (G_LIKELY (cstop != GST_CLOCK_TIME_NONE))
1947 gst_segment_set_last_stop (segment, GST_FORMAT_TIME, cstop);
1949 gst_segment_set_last_stop (segment, GST_FORMAT_TIME, cstart);
1952 rstart = gst_segment_to_running_time (segment, format, cstart);
1953 rstop = gst_segment_to_running_time (segment, format, cstop);
1955 if (G_UNLIKELY (step->valid)) {
1956 if (!(*step_end = handle_stepping (basesink, segment, step, &cstart, &cstop,
1957 &rstart, &rstop))) {
1958 /* step is still busy, we discard data when we are flushing */
1959 *stepped = step->flush;
1960 GST_DEBUG_OBJECT (basesink, "stepping busy");
1963 /* this can produce wrong values if we accumulated non-TIME segments. If this happens,
1964 * upstream is behaving very badly */
1965 sstart = gst_segment_to_stream_time (segment, format, cstart);
1966 sstop = gst_segment_to_stream_time (segment, format, cstop);
1969 /* eos_done label only called when doing EOS, we also stop stepping then */
1970 if (*step_end && step->flush) {
1971 GST_DEBUG_OBJECT (basesink, "flushing step ended");
1972 stop_stepping (basesink, segment, step, rstart, rstop, eos);
1974 /* re-determine running start times for adjusted segment
1975 * (which has a flushed amount of running/accumulated time removed) */
1976 if (!GST_IS_EVENT (obj)) {
1977 GST_DEBUG_OBJECT (basesink, "refresh sync times");
1988 /* buffers and EOS always need syncing and preroll */
1994 /* we usually clip in the chain function already but stepping could cause
1995 * the segment to be updated later. we return FALSE so that we don't try
1997 GST_LOG_OBJECT (basesink, "buffer skipped, not in segment");
2002 /* with STREAM_LOCK, PREROLL_LOCK, LOCK
2003 * adjust a timestamp with the latency and timestamp offset. This function does
2004 * not adjust for the render delay. */
2006 gst_base_sink_adjust_time (GstBaseSink * basesink, GstClockTime time)
2008 GstClockTimeDiff ts_offset;
2010 /* don't do anything funny with invalid timestamps */
2011 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
2014 time += basesink->priv->latency;
2016 /* apply offset, be carefull for underflows */
2017 ts_offset = basesink->priv->ts_offset;
2018 if (ts_offset < 0) {
2019 ts_offset = -ts_offset;
2020 if (ts_offset < time)
2027 /* subtract the render delay again, which was included in the latency */
2028 if (time > basesink->priv->render_delay)
2029 time -= basesink->priv->render_delay;
2037 * gst_base_sink_wait_clock:
2039 * @time: the running_time to be reached
2040 * @jitter: the jitter to be filled with time diff (can be NULL)
2042 * This function will block until @time is reached. It is usually called by
2043 * subclasses that use their own internal synchronisation.
2045 * If @time is not valid, no sycnhronisation is done and #GST_CLOCK_BADTIME is
2046 * returned. Likewise, if synchronisation is disabled in the element or there
2047 * is no clock, no synchronisation is done and #GST_CLOCK_BADTIME is returned.
2049 * This function should only be called with the PREROLL_LOCK held, like when
2050 * receiving an EOS event in the #GstBaseSinkClass.event() vmethod or when
2051 * receiving a buffer in
2052 * the #GstBaseSinkClass.render() vmethod.
2054 * The @time argument should be the running_time of when this method should
2055 * return and is not adjusted with any latency or offset configured in the
2060 * Returns: #GstClockReturn
2063 gst_base_sink_wait_clock (GstBaseSink * sink, GstClockTime time,
2064 GstClockTimeDiff * jitter)
2069 GstClockTime base_time;
2071 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
2074 GST_OBJECT_LOCK (sink);
2075 if (G_UNLIKELY (!sink->sync))
2078 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (sink)) == NULL))
2081 base_time = GST_ELEMENT_CAST (sink)->base_time;
2082 GST_LOG_OBJECT (sink,
2083 "time %" GST_TIME_FORMAT ", base_time %" GST_TIME_FORMAT,
2084 GST_TIME_ARGS (time), GST_TIME_ARGS (base_time));
2086 /* add base_time to running_time to get the time against the clock */
2089 id = gst_clock_new_single_shot_id (clock, time);
2090 GST_OBJECT_UNLOCK (sink);
2092 /* A blocking wait is performed on the clock. We save the ClockID
2093 * so we can unlock the entry at any time. While we are blocking, we
2094 * release the PREROLL_LOCK so that other threads can interrupt the
2096 sink->clock_id = id;
2097 /* release the preroll lock while waiting */
2098 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
2100 ret = gst_clock_id_wait (id, jitter);
2102 GST_PAD_PREROLL_LOCK (sink->sinkpad);
2103 gst_clock_id_unref (id);
2104 sink->clock_id = NULL;
2108 /* no syncing needed */
2111 GST_DEBUG_OBJECT (sink, "time not valid, no sync needed");
2112 return GST_CLOCK_BADTIME;
2116 GST_DEBUG_OBJECT (sink, "sync disabled");
2117 GST_OBJECT_UNLOCK (sink);
2118 return GST_CLOCK_BADTIME;
2122 GST_DEBUG_OBJECT (sink, "no clock, can't sync");
2123 GST_OBJECT_UNLOCK (sink);
2124 return GST_CLOCK_BADTIME;
2129 * gst_base_sink_wait_preroll:
2132 * If the #GstBaseSinkClass.render() method performs its own synchronisation
2133 * against the clock it must unblock when going from PLAYING to the PAUSED state
2134 * and call this method before continuing to render the remaining data.
2136 * This function will block until a state change to PLAYING happens (in which
2137 * case this function returns #GST_FLOW_OK) or the processing must be stopped due
2138 * to a state change to READY or a FLUSH event (in which case this function
2139 * returns #GST_FLOW_WRONG_STATE).
2141 * This function should only be called with the PREROLL_LOCK held, like in the
2146 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2147 * continue. Any other return value should be returned from the render vmethod.
2150 gst_base_sink_wait_preroll (GstBaseSink * sink)
2152 sink->have_preroll = TRUE;
2153 GST_DEBUG_OBJECT (sink, "waiting in preroll for flush or PLAYING");
2154 /* block until the state changes, or we get a flush, or something */
2155 GST_PAD_PREROLL_WAIT (sink->sinkpad);
2156 sink->have_preroll = FALSE;
2157 if (G_UNLIKELY (sink->flushing))
2159 if (G_UNLIKELY (sink->priv->step_unlock))
2161 GST_DEBUG_OBJECT (sink, "continue after preroll");
2168 GST_DEBUG_OBJECT (sink, "preroll interrupted because of flush");
2169 return GST_FLOW_WRONG_STATE;
2173 sink->priv->step_unlock = FALSE;
2174 GST_DEBUG_OBJECT (sink, "preroll interrupted because of step");
2175 return GST_FLOW_STEP;
2180 * gst_base_sink_do_preroll:
2182 * @obj: the object that caused the preroll
2184 * If the @sink spawns its own thread for pulling buffers from upstream it
2185 * should call this method after it has pulled a buffer. If the element needed
2186 * to preroll, this function will perform the preroll and will then block
2187 * until the element state is changed.
2189 * This function should be called with the PREROLL_LOCK held.
2193 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2194 * continue. Any other return value should be returned from the render vmethod.
2197 gst_base_sink_do_preroll (GstBaseSink * sink, GstMiniObject * obj)
2201 while (G_UNLIKELY (sink->need_preroll)) {
2202 GST_DEBUG_OBJECT (sink, "prerolling object %p", obj);
2204 ret = gst_base_sink_preroll_object (sink, FALSE, obj);
2205 if (ret != GST_FLOW_OK)
2206 goto preroll_failed;
2208 /* need to recheck here because the commit state could have
2209 * made us not need the preroll anymore */
2210 if (G_LIKELY (sink->need_preroll)) {
2211 /* block until the state changes, or we get a flush, or something */
2212 ret = gst_base_sink_wait_preroll (sink);
2213 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2214 goto preroll_failed;
2222 GST_DEBUG_OBJECT (sink, "preroll failed %d", ret);
2228 * gst_base_sink_wait_eos:
2230 * @time: the running_time to be reached
2231 * @jitter: the jitter to be filled with time diff (can be NULL)
2233 * This function will block until @time is reached. It is usually called by
2234 * subclasses that use their own internal synchronisation but want to let the
2235 * EOS be handled by the base class.
2237 * This function should only be called with the PREROLL_LOCK held, like when
2238 * receiving an EOS event in the ::event vmethod.
2240 * The @time argument should be the running_time of when the EOS should happen
2241 * and will be adjusted with any latency and offset configured in the sink.
2245 * Returns: #GstFlowReturn
2248 gst_base_sink_wait_eos (GstBaseSink * sink, GstClockTime time,
2249 GstClockTimeDiff * jitter)
2251 GstClockReturn status;
2257 GST_DEBUG_OBJECT (sink, "checking preroll");
2259 /* first wait for the playing state before we can continue */
2260 if (G_UNLIKELY (sink->need_preroll)) {
2261 ret = gst_base_sink_wait_preroll (sink);
2262 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2266 /* preroll done, we can sync since we are in PLAYING now. */
2267 GST_DEBUG_OBJECT (sink, "possibly waiting for clock to reach %"
2268 GST_TIME_FORMAT, GST_TIME_ARGS (time));
2270 /* compensate for latency and ts_offset. We don't adjust for render delay
2271 * because we don't interact with the device on EOS normally. */
2272 stime = gst_base_sink_adjust_time (sink, time);
2274 /* wait for the clock, this can be interrupted because we got shut down or
2276 status = gst_base_sink_wait_clock (sink, stime, jitter);
2278 GST_DEBUG_OBJECT (sink, "clock returned %d", status);
2280 /* invalid time, no clock or sync disabled, just continue then */
2281 if (status == GST_CLOCK_BADTIME)
2284 /* waiting could have been interrupted and we can be flushing now */
2285 if (G_UNLIKELY (sink->flushing))
2288 /* retry if we got unscheduled, which means we did not reach the timeout
2289 * yet. if some other error occures, we continue. */
2290 } while (status == GST_CLOCK_UNSCHEDULED);
2292 GST_DEBUG_OBJECT (sink, "end of stream");
2299 GST_DEBUG_OBJECT (sink, "we are flushing");
2300 return GST_FLOW_WRONG_STATE;
2304 /* with STREAM_LOCK, PREROLL_LOCK
2306 * Make sure we are in PLAYING and synchronize an object to the clock.
2308 * If we need preroll, we are not in PLAYING. We try to commit the state
2309 * if needed and then block if we still are not PLAYING.
2311 * We start waiting on the clock in PLAYING. If we got interrupted, we
2312 * immediatly try to re-preroll.
2314 * Some objects do not need synchronisation (most events) and so this function
2315 * immediatly returns GST_FLOW_OK.
2317 * for objects that arrive later than max-lateness to be synchronized to the
2318 * clock have the @late boolean set to TRUE.
2320 * This function keeps a running average of the jitter (the diff between the
2321 * clock time and the requested sync time). The jitter is negative for
2322 * objects that arrive in time and positive for late buffers.
2324 * does not take ownership of obj.
2326 static GstFlowReturn
2327 gst_base_sink_do_sync (GstBaseSink * basesink, GstPad * pad,
2328 GstMiniObject * obj, gboolean * late, gboolean * step_end)
2330 GstClockTimeDiff jitter = 0;
2332 GstClockReturn status = GST_CLOCK_OK;
2333 GstClockTime rstart, rstop, sstart, sstop, stime;
2335 GstBaseSinkPrivate *priv;
2337 GstStepInfo *current, *pending;
2340 priv = basesink->priv;
2343 sstart = sstop = rstart = rstop = GST_CLOCK_TIME_NONE;
2347 priv->current_rstart = GST_CLOCK_TIME_NONE;
2349 /* get stepping info */
2350 current = &priv->current_step;
2351 pending = &priv->pending_step;
2353 /* get timing information for this object against the render segment */
2354 syncable = gst_base_sink_get_sync_times (basesink, obj,
2355 &sstart, &sstop, &rstart, &rstop, &do_sync, &stepped, &basesink->segment,
2358 if (G_UNLIKELY (stepped))
2361 /* a syncable object needs to participate in preroll and
2362 * clocking. All buffers and EOS are syncable. */
2363 if (G_UNLIKELY (!syncable))
2366 /* store timing info for current object */
2367 priv->current_rstart = rstart;
2368 priv->current_rstop = (GST_CLOCK_TIME_IS_VALID (rstop) ? rstop : rstart);
2370 /* save sync time for eos when the previous object needed sync */
2371 priv->eos_rtime = (do_sync ? priv->current_rstop : GST_CLOCK_TIME_NONE);
2374 /* first do preroll, this makes sure we commit our state
2375 * to PAUSED and can continue to PLAYING. We cannot perform
2376 * any clock sync in PAUSED because there is no clock. */
2377 ret = gst_base_sink_do_preroll (basesink, obj);
2378 if (G_UNLIKELY (ret != GST_FLOW_OK))
2379 goto preroll_failed;
2381 /* update the segment with a pending step if the current one is invalid and we
2382 * have a new pending one. We only accept new step updates after a preroll */
2383 if (G_UNLIKELY (pending->valid && !current->valid)) {
2384 start_stepping (basesink, &basesink->segment, pending, current);
2388 /* After rendering we store the position of the last buffer so that we can use
2389 * it to report the position. We need to take the lock here. */
2390 GST_OBJECT_LOCK (basesink);
2391 priv->current_sstart = sstart;
2392 priv->current_sstop = (GST_CLOCK_TIME_IS_VALID (sstop) ? sstop : sstart);
2393 GST_OBJECT_UNLOCK (basesink);
2398 /* adjust for latency */
2399 stime = gst_base_sink_adjust_time (basesink, rstart);
2401 /* adjust for render-delay, avoid underflows */
2402 if (GST_CLOCK_TIME_IS_VALID (stime)) {
2403 if (stime > priv->render_delay)
2404 stime -= priv->render_delay;
2409 /* preroll done, we can sync since we are in PLAYING now. */
2410 GST_DEBUG_OBJECT (basesink, "possibly waiting for clock to reach %"
2411 GST_TIME_FORMAT ", adjusted %" GST_TIME_FORMAT,
2412 GST_TIME_ARGS (rstart), GST_TIME_ARGS (stime));
2414 /* This function will return immediatly if start == -1, no clock
2415 * or sync is disabled with GST_CLOCK_BADTIME. */
2416 status = gst_base_sink_wait_clock (basesink, stime, &jitter);
2418 GST_DEBUG_OBJECT (basesink, "clock returned %d, jitter %c%" GST_TIME_FORMAT,
2419 status, (jitter < 0 ? '-' : ' '), GST_TIME_ARGS (ABS (jitter)));
2421 /* invalid time, no clock or sync disabled, just render */
2422 if (status == GST_CLOCK_BADTIME)
2425 /* waiting could have been interrupted and we can be flushing now */
2426 if (G_UNLIKELY (basesink->flushing))
2429 /* check for unlocked by a state change, we are not flushing so
2430 * we can try to preroll on the current buffer. */
2431 if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED)) {
2432 GST_DEBUG_OBJECT (basesink, "unscheduled, waiting some more");
2433 priv->call_preroll = TRUE;
2437 /* successful syncing done, record observation */
2438 priv->current_jitter = jitter;
2440 /* check if the object should be dropped */
2441 *late = gst_base_sink_is_too_late (basesink, obj, rstart, rstop,
2450 GST_DEBUG_OBJECT (basesink, "skipped stepped object %p", obj);
2456 GST_DEBUG_OBJECT (basesink, "non syncable object %p", obj);
2461 GST_DEBUG_OBJECT (basesink, "we are flushing");
2462 return GST_FLOW_WRONG_STATE;
2466 GST_DEBUG_OBJECT (basesink, "preroll failed");
2473 gst_base_sink_send_qos (GstBaseSink * basesink,
2474 gdouble proportion, GstClockTime time, GstClockTimeDiff diff)
2479 /* generate Quality-of-Service event */
2480 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2481 "qos: proportion: %lf, diff %" G_GINT64_FORMAT ", timestamp %"
2482 GST_TIME_FORMAT, proportion, diff, GST_TIME_ARGS (time));
2484 event = gst_event_new_qos (proportion, diff, time);
2487 res = gst_pad_push_event (basesink->sinkpad, event);
2493 gst_base_sink_perform_qos (GstBaseSink * sink, gboolean dropped)
2495 GstBaseSinkPrivate *priv;
2496 GstClockTime start, stop;
2497 GstClockTimeDiff jitter;
2498 GstClockTime pt, entered, left;
2499 GstClockTime duration;
2504 start = priv->current_rstart;
2506 if (priv->current_step.valid)
2509 /* if Quality-of-Service disabled, do nothing */
2510 if (!g_atomic_int_get (&priv->qos_enabled) ||
2511 !GST_CLOCK_TIME_IS_VALID (start))
2514 stop = priv->current_rstop;
2515 jitter = priv->current_jitter;
2518 /* this is the time the buffer entered the sink */
2519 if (start < -jitter)
2522 entered = start + jitter;
2525 /* this is the time the buffer entered the sink */
2526 entered = start + jitter;
2527 /* this is the time the buffer left the sink */
2528 left = start + jitter;
2531 /* calculate duration of the buffer */
2532 if (GST_CLOCK_TIME_IS_VALID (stop))
2533 duration = stop - start;
2535 duration = GST_CLOCK_TIME_NONE;
2537 /* if we have the time when the last buffer left us, calculate
2538 * processing time */
2539 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2540 if (entered > priv->last_left) {
2541 pt = entered - priv->last_left;
2549 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "start: %" GST_TIME_FORMAT
2550 ", entered %" GST_TIME_FORMAT ", left %" GST_TIME_FORMAT ", pt: %"
2551 GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT ",jitter %"
2552 G_GINT64_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (entered),
2553 GST_TIME_ARGS (left), GST_TIME_ARGS (pt), GST_TIME_ARGS (duration),
2556 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "avg_duration: %" GST_TIME_FORMAT
2557 ", avg_pt: %" GST_TIME_FORMAT ", avg_rate: %g",
2558 GST_TIME_ARGS (priv->avg_duration), GST_TIME_ARGS (priv->avg_pt),
2561 /* collect running averages. for first observations, we copy the
2563 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_duration))
2564 priv->avg_duration = duration;
2566 priv->avg_duration = UPDATE_RUNNING_AVG (priv->avg_duration, duration);
2568 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_pt))
2571 priv->avg_pt = UPDATE_RUNNING_AVG (priv->avg_pt, pt);
2573 if (priv->avg_duration != 0)
2575 gst_guint64_to_gdouble (priv->avg_pt) /
2576 gst_guint64_to_gdouble (priv->avg_duration);
2580 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2581 if (dropped || priv->avg_rate < 0.0) {
2582 priv->avg_rate = rate;
2585 priv->avg_rate = UPDATE_RUNNING_AVG_N (priv->avg_rate, rate);
2587 priv->avg_rate = UPDATE_RUNNING_AVG_P (priv->avg_rate, rate);
2591 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink,
2592 "updated: avg_duration: %" GST_TIME_FORMAT ", avg_pt: %" GST_TIME_FORMAT
2593 ", avg_rate: %g", GST_TIME_ARGS (priv->avg_duration),
2594 GST_TIME_ARGS (priv->avg_pt), priv->avg_rate);
2597 if (priv->avg_rate >= 0.0) {
2598 /* if we have a valid rate, start sending QoS messages */
2599 if (priv->current_jitter < 0) {
2600 /* make sure we never go below 0 when adding the jitter to the
2602 if (priv->current_rstart < -priv->current_jitter)
2603 priv->current_jitter = -priv->current_rstart;
2605 gst_base_sink_send_qos (sink, priv->avg_rate, priv->current_rstart,
2606 priv->current_jitter);
2609 /* record when this buffer will leave us */
2610 priv->last_left = left;
2613 /* reset all qos measuring */
2615 gst_base_sink_reset_qos (GstBaseSink * sink)
2617 GstBaseSinkPrivate *priv;
2621 priv->last_in_time = GST_CLOCK_TIME_NONE;
2622 priv->last_left = GST_CLOCK_TIME_NONE;
2623 priv->avg_duration = GST_CLOCK_TIME_NONE;
2624 priv->avg_pt = GST_CLOCK_TIME_NONE;
2625 priv->avg_rate = -1.0;
2626 priv->avg_render = GST_CLOCK_TIME_NONE;
2632 /* Checks if the object was scheduled too late.
2634 * start/stop contain the raw timestamp start and stop values
2637 * status and jitter contain the return values from the clock wait.
2639 * returns TRUE if the buffer was too late.
2642 gst_base_sink_is_too_late (GstBaseSink * basesink, GstMiniObject * obj,
2643 GstClockTime start, GstClockTime stop,
2644 GstClockReturn status, GstClockTimeDiff jitter)
2647 gint64 max_lateness;
2648 GstBaseSinkPrivate *priv;
2650 priv = basesink->priv;
2654 /* only for objects that were too late */
2655 if (G_LIKELY (status != GST_CLOCK_EARLY))
2658 max_lateness = basesink->abidata.ABI.max_lateness;
2660 /* check if frame dropping is enabled */
2661 if (max_lateness == -1)
2664 /* only check for buffers */
2665 if (G_UNLIKELY (!GST_IS_BUFFER (obj)))
2668 /* can't do check if we don't have a timestamp */
2669 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (start)))
2672 /* we can add a valid stop time */
2673 if (GST_CLOCK_TIME_IS_VALID (stop))
2674 max_lateness += stop;
2676 max_lateness += start;
2678 /* if the jitter bigger than duration and lateness we are too late */
2679 if ((late = start + jitter > max_lateness)) {
2680 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2681 "buffer is too late %" GST_TIME_FORMAT
2682 " > %" GST_TIME_FORMAT, GST_TIME_ARGS (start + jitter),
2683 GST_TIME_ARGS (max_lateness));
2684 /* !!emergency!!, if we did not receive anything valid for more than a
2685 * second, render it anyway so the user sees something */
2686 if (GST_CLOCK_TIME_IS_VALID (priv->last_in_time) &&
2687 start - priv->last_in_time > GST_SECOND) {
2689 GST_ELEMENT_WARNING (basesink, CORE, CLOCK,
2690 (_("A lot of buffers are being dropped.")),
2691 ("There may be a timestamping problem, or this computer is too slow."));
2692 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2693 "**emergency** last buffer at %" GST_TIME_FORMAT " > GST_SECOND",
2694 GST_TIME_ARGS (priv->last_in_time));
2699 if (!late || !GST_CLOCK_TIME_IS_VALID (priv->last_in_time)) {
2700 priv->last_in_time = start;
2707 GST_DEBUG_OBJECT (basesink, "object was scheduled in time");
2712 GST_DEBUG_OBJECT (basesink, "frame dropping disabled");
2717 GST_DEBUG_OBJECT (basesink, "object is not a buffer");
2722 GST_DEBUG_OBJECT (basesink, "buffer has no timestamp");
2727 /* called before and after calling the render vmethod. It keeps track of how
2728 * much time was spent in the render method and is used to check if we are
2731 gst_base_sink_do_render_stats (GstBaseSink * basesink, gboolean start)
2733 GstBaseSinkPrivate *priv;
2735 priv = basesink->priv;
2738 priv->start = gst_util_get_timestamp ();
2740 GstClockTime elapsed;
2742 priv->stop = gst_util_get_timestamp ();
2744 elapsed = GST_CLOCK_DIFF (priv->start, priv->stop);
2746 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_render))
2747 priv->avg_render = elapsed;
2749 priv->avg_render = UPDATE_RUNNING_AVG (priv->avg_render, elapsed);
2751 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2752 "avg_render: %" GST_TIME_FORMAT, GST_TIME_ARGS (priv->avg_render));
2756 /* with STREAM_LOCK, PREROLL_LOCK,
2758 * Synchronize the object on the clock and then render it.
2760 * takes ownership of obj.
2762 static GstFlowReturn
2763 gst_base_sink_render_object (GstBaseSink * basesink, GstPad * pad,
2764 gboolean is_list, gpointer obj)
2767 GstBaseSinkClass *bclass;
2768 gboolean late, step_end;
2770 GstBaseSinkPrivate *priv;
2772 priv = basesink->priv;
2776 * If buffer list, use the first group buffer within the list
2779 sync_obj = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0, 0);
2780 g_assert (NULL != sync_obj);
2789 /* synchronize this object, non syncable objects return OK
2791 ret = gst_base_sink_do_sync (basesink, pad, sync_obj, &late, &step_end);
2792 if (G_UNLIKELY (ret != GST_FLOW_OK))
2795 /* and now render, event or buffer/buffer list. */
2796 if (G_LIKELY (is_list || GST_IS_BUFFER (obj))) {
2797 /* drop late buffers unconditionally, let's hope it's unlikely */
2798 if (G_UNLIKELY (late))
2801 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2803 if (G_LIKELY ((is_list && bclass->render_list) ||
2804 (!is_list && bclass->render))) {
2807 /* read once, to get same value before and after */
2808 do_qos = g_atomic_int_get (&priv->qos_enabled);
2810 GST_DEBUG_OBJECT (basesink, "rendering object %p", obj);
2812 /* record rendering time for QoS and stats */
2814 gst_base_sink_do_render_stats (basesink, TRUE);
2819 /* For buffer lists do not set last buffer. Creating buffer
2820 * with meaningful data can be done only with memcpy which will
2821 * significantly affect performance */
2822 buf = GST_BUFFER_CAST (obj);
2823 gst_base_sink_set_last_buffer (basesink, buf);
2825 ret = bclass->render (basesink, buf);
2827 GstBufferList *buflist;
2829 buflist = GST_BUFFER_LIST_CAST (obj);
2831 ret = bclass->render_list (basesink, buflist);
2835 gst_base_sink_do_render_stats (basesink, FALSE);
2837 if (ret == GST_FLOW_STEP)
2840 if (G_UNLIKELY (basesink->flushing))
2845 } else if (G_LIKELY (GST_IS_EVENT (obj))) {
2846 GstEvent *event = GST_EVENT_CAST (obj);
2847 gboolean event_res = TRUE;
2850 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2852 type = GST_EVENT_TYPE (event);
2854 GST_DEBUG_OBJECT (basesink, "rendering event %p, type %s", obj,
2855 gst_event_type_get_name (type));
2858 event_res = bclass->event (basesink, event);
2860 /* when we get here we could be flushing again when the event handler calls
2861 * _wait_eos(). We have to ignore this object in that case. */
2862 if (G_UNLIKELY (basesink->flushing))
2865 if (G_LIKELY (event_res)) {
2868 seqnum = basesink->priv->seqnum = gst_event_get_seqnum (event);
2869 GST_DEBUG_OBJECT (basesink, "Got seqnum #%" G_GUINT32_FORMAT, seqnum);
2874 GstMessage *message;
2876 /* the EOS event is completely handled so we mark
2877 * ourselves as being in the EOS state. eos is also
2878 * protected by the object lock so we can read it when
2879 * answering the POSITION query. */
2880 GST_OBJECT_LOCK (basesink);
2881 basesink->eos = TRUE;
2882 GST_OBJECT_UNLOCK (basesink);
2884 /* ok, now we can post the message */
2885 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
2887 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
2888 gst_message_set_seqnum (message, seqnum);
2889 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
2892 case GST_EVENT_NEWSEGMENT:
2893 /* configure the segment */
2894 gst_base_sink_configure_segment (basesink, pad, event,
2895 &basesink->segment);
2897 case GST_EVENT_SINK_MESSAGE:{
2898 GstMessage *msg = NULL;
2900 gst_event_parse_sink_message (event, &msg);
2903 gst_element_post_message (GST_ELEMENT_CAST (basesink), msg);
2910 g_return_val_if_reached (GST_FLOW_ERROR);
2915 /* the step ended, check if we need to activate a new step */
2916 GST_DEBUG_OBJECT (basesink, "step ended");
2917 stop_stepping (basesink, &basesink->segment, &priv->current_step,
2918 priv->current_rstart, priv->current_rstop, basesink->eos);
2922 gst_base_sink_perform_qos (basesink, late);
2924 GST_DEBUG_OBJECT (basesink, "object unref after render %p", obj);
2925 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
2931 GST_DEBUG_OBJECT (basesink, "do_sync returned %s", gst_flow_get_name (ret));
2937 GST_DEBUG_OBJECT (basesink, "buffer late, dropping");
2939 if (g_atomic_int_get (&priv->qos_enabled)) {
2940 GstMessage *qos_msg;
2941 GstClockTime timestamp, duration;
2943 timestamp = GST_BUFFER_TIMESTAMP (GST_BUFFER_CAST (sync_obj));
2944 duration = GST_BUFFER_DURATION (GST_BUFFER_CAST (sync_obj));
2946 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2947 "qos: dropped buffer rt %" GST_TIME_FORMAT ", st %" GST_TIME_FORMAT
2948 ", ts %" GST_TIME_FORMAT ", dur %" GST_TIME_FORMAT,
2949 GST_TIME_ARGS (priv->current_rstart),
2950 GST_TIME_ARGS (priv->current_sstart), GST_TIME_ARGS (timestamp),
2951 GST_TIME_ARGS (duration));
2952 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2953 "qos: rendered %" G_GUINT64_FORMAT ", dropped %" G_GUINT64_FORMAT,
2954 priv->rendered, priv->dropped);
2957 gst_message_new_qos (GST_OBJECT_CAST (basesink), basesink->sync,
2958 priv->current_rstart, priv->current_sstart, timestamp, duration);
2959 gst_message_set_qos_values (qos_msg, priv->current_jitter, priv->avg_rate,
2961 gst_message_set_qos_stats (qos_msg, GST_FORMAT_BUFFERS, priv->rendered,
2963 gst_element_post_message (GST_ELEMENT_CAST (basesink), qos_msg);
2969 GST_DEBUG_OBJECT (basesink, "we are flushing, ignore object");
2970 gst_mini_object_unref (obj);
2971 return GST_FLOW_WRONG_STATE;
2975 /* with STREAM_LOCK, PREROLL_LOCK
2977 * Perform preroll on the given object. For buffers this means
2978 * calling the preroll subclass method.
2979 * If that succeeds, the state will be commited.
2981 * function does not take ownership of obj.
2983 static GstFlowReturn
2984 gst_base_sink_preroll_object (GstBaseSink * basesink, gboolean is_list,
2985 GstMiniObject * obj)
2989 GST_DEBUG_OBJECT (basesink, "prerolling object %p", obj);
2991 /* if it's a buffer, we need to call the preroll method */
2992 if (G_LIKELY (is_list || GST_IS_BUFFER (obj)) && basesink->priv->call_preroll) {
2993 GstBaseSinkClass *bclass;
2995 GstClockTime timestamp;
2998 buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0, 0);
2999 g_assert (NULL != buf);
3001 buf = GST_BUFFER_CAST (obj);
3004 timestamp = GST_BUFFER_TIMESTAMP (buf);
3006 GST_DEBUG_OBJECT (basesink, "preroll buffer %" GST_TIME_FORMAT,
3007 GST_TIME_ARGS (timestamp));
3010 * For buffer lists do not set last buffer. Creating buffer
3011 * with meaningful data can be done only with memcpy which will
3012 * significantly affect performance
3015 gst_base_sink_set_last_buffer (basesink, buf);
3018 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3019 if (bclass->preroll)
3020 if ((ret = bclass->preroll (basesink, buf)) != GST_FLOW_OK)
3021 goto preroll_failed;
3023 basesink->priv->call_preroll = FALSE;
3027 if (G_LIKELY (basesink->playing_async)) {
3028 if (G_UNLIKELY (!gst_base_sink_commit_state (basesink)))
3037 GST_DEBUG_OBJECT (basesink, "preroll failed, abort state");
3038 gst_element_abort_state (GST_ELEMENT_CAST (basesink));
3043 GST_DEBUG_OBJECT (basesink, "stopping while commiting state");
3044 return GST_FLOW_WRONG_STATE;
3048 /* with STREAM_LOCK, PREROLL_LOCK
3050 * Queue an object for rendering.
3051 * The first prerollable object queued will complete the preroll. If the
3052 * preroll queue if filled, we render all the objects in the queue.
3054 * This function takes ownership of the object.
3056 static GstFlowReturn
3057 gst_base_sink_queue_object_unlocked (GstBaseSink * basesink, GstPad * pad,
3058 gboolean is_list, gpointer obj, gboolean prerollable)
3060 GstFlowReturn ret = GST_FLOW_OK;
3064 if (G_UNLIKELY (basesink->need_preroll)) {
3065 if (G_LIKELY (prerollable))
3066 basesink->preroll_queued++;
3068 length = basesink->preroll_queued;
3070 GST_DEBUG_OBJECT (basesink, "now %d prerolled items", length);
3072 /* first prerollable item needs to finish the preroll */
3074 ret = gst_base_sink_preroll_object (basesink, is_list, obj);
3075 if (G_UNLIKELY (ret != GST_FLOW_OK))
3076 goto preroll_failed;
3078 /* need to recheck if we need preroll, commmit state during preroll
3079 * could have made us not need more preroll. */
3080 if (G_UNLIKELY (basesink->need_preroll)) {
3081 /* see if we can render now, if we can't add the object to the preroll
3083 if (G_UNLIKELY (length <= basesink->preroll_queue_max_len))
3087 /* we can start rendering (or blocking) the queued object
3089 q = basesink->preroll_queue;
3090 while (G_UNLIKELY (!g_queue_is_empty (q))) {
3093 o = g_queue_pop_head (q);
3094 GST_DEBUG_OBJECT (basesink, "rendering queued object %p", o);
3096 /* do something with the return value */
3097 ret = gst_base_sink_render_object (basesink, pad, FALSE, o);
3098 if (ret != GST_FLOW_OK)
3099 goto dequeue_failed;
3102 /* now render the object */
3103 ret = gst_base_sink_render_object (basesink, pad, is_list, obj);
3104 basesink->preroll_queued = 0;
3111 GST_DEBUG_OBJECT (basesink, "preroll failed, reason %s",
3112 gst_flow_get_name (ret));
3113 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3118 /* add object to the queue and return */
3119 GST_DEBUG_OBJECT (basesink, "need more preroll data %d <= %d",
3120 length, basesink->preroll_queue_max_len);
3121 g_queue_push_tail (basesink->preroll_queue, obj);
3126 GST_DEBUG_OBJECT (basesink, "rendering queued objects failed, reason %s",
3127 gst_flow_get_name (ret));
3128 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3135 * This function grabs the PREROLL_LOCK and adds the object to
3138 * This function takes ownership of obj.
3140 static GstFlowReturn
3141 gst_base_sink_queue_object (GstBaseSink * basesink, GstPad * pad,
3142 GstMiniObject * obj, gboolean prerollable)
3146 GST_PAD_PREROLL_LOCK (pad);
3147 if (G_UNLIKELY (basesink->flushing))
3150 if (G_UNLIKELY (basesink->priv->received_eos))
3154 gst_base_sink_queue_object_unlocked (basesink, pad, FALSE, obj,
3156 GST_PAD_PREROLL_UNLOCK (pad);
3163 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3164 GST_PAD_PREROLL_UNLOCK (pad);
3165 gst_mini_object_unref (obj);
3166 return GST_FLOW_WRONG_STATE;
3170 GST_DEBUG_OBJECT (basesink,
3171 "we are EOS, dropping object, return UNEXPECTED");
3172 GST_PAD_PREROLL_UNLOCK (pad);
3173 gst_mini_object_unref (obj);
3174 return GST_FLOW_UNEXPECTED;
3179 gst_base_sink_flush_start (GstBaseSink * basesink, GstPad * pad)
3181 /* make sure we are not blocked on the clock also clear any pending
3183 gst_base_sink_set_flushing (basesink, pad, TRUE);
3185 /* we grab the stream lock but that is not needed since setting the
3186 * sink to flushing would make sure no state commit is being done
3188 GST_PAD_STREAM_LOCK (pad);
3189 gst_base_sink_reset_qos (basesink);
3190 if (basesink->priv->async_enabled) {
3191 /* and we need to commit our state again on the next
3192 * prerolled buffer */
3193 basesink->playing_async = TRUE;
3194 gst_element_lost_state (GST_ELEMENT_CAST (basesink));
3196 basesink->priv->have_latency = TRUE;
3197 basesink->need_preroll = FALSE;
3199 gst_base_sink_set_last_buffer (basesink, NULL);
3200 GST_PAD_STREAM_UNLOCK (pad);
3204 gst_base_sink_flush_stop (GstBaseSink * basesink, GstPad * pad)
3206 /* unset flushing so we can accept new data, this also flushes out any EOS
3208 gst_base_sink_set_flushing (basesink, pad, FALSE);
3210 /* for position reporting */
3211 GST_OBJECT_LOCK (basesink);
3212 basesink->priv->current_sstart = GST_CLOCK_TIME_NONE;
3213 basesink->priv->current_sstop = GST_CLOCK_TIME_NONE;
3214 basesink->priv->eos_rtime = GST_CLOCK_TIME_NONE;
3215 basesink->priv->call_preroll = TRUE;
3216 basesink->priv->current_step.valid = FALSE;
3217 basesink->priv->pending_step.valid = FALSE;
3218 if (basesink->pad_mode == GST_ACTIVATE_PUSH) {
3219 /* we need new segment info after the flush. */
3220 basesink->have_newsegment = FALSE;
3221 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
3222 gst_segment_init (basesink->abidata.ABI.clip_segment, GST_FORMAT_UNDEFINED);
3224 GST_OBJECT_UNLOCK (basesink);
3228 gst_base_sink_event (GstPad * pad, GstEvent * event)
3230 GstBaseSink *basesink;
3231 gboolean result = TRUE;
3232 GstBaseSinkClass *bclass;
3234 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3236 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3238 GST_DEBUG_OBJECT (basesink, "reveived event %p %" GST_PTR_FORMAT, event,
3241 switch (GST_EVENT_TYPE (event)) {
3246 GST_PAD_PREROLL_LOCK (pad);
3247 if (G_UNLIKELY (basesink->flushing))
3250 if (G_UNLIKELY (basesink->priv->received_eos)) {
3251 /* we can't accept anything when we are EOS */
3253 gst_event_unref (event);
3255 /* we set the received EOS flag here so that we can use it when testing if
3256 * we are prerolled and to refuse more buffers. */
3257 basesink->priv->received_eos = TRUE;
3259 /* EOS is a prerollable object, we call the unlocked version because it
3260 * does not check the received_eos flag. */
3261 ret = gst_base_sink_queue_object_unlocked (basesink, pad,
3262 FALSE, GST_MINI_OBJECT_CAST (event), TRUE);
3263 if (G_UNLIKELY (ret != GST_FLOW_OK))
3266 GST_PAD_PREROLL_UNLOCK (pad);
3269 case GST_EVENT_NEWSEGMENT:
3274 GST_DEBUG_OBJECT (basesink, "newsegment %p", event);
3276 GST_PAD_PREROLL_LOCK (pad);
3277 if (G_UNLIKELY (basesink->flushing))
3280 gst_event_parse_new_segment_full (event, &update, NULL, NULL, NULL, NULL,
3283 if (G_UNLIKELY (basesink->priv->received_eos && !update)) {
3284 /* we can't accept anything when we are EOS */
3286 gst_event_unref (event);
3288 /* the new segment is a non prerollable item and does not block anything,
3289 * we need to configure the current clipping segment and insert the event
3290 * in the queue to serialize it with the buffers for rendering. */
3291 gst_base_sink_configure_segment (basesink, pad, event,
3292 basesink->abidata.ABI.clip_segment);
3295 gst_base_sink_queue_object_unlocked (basesink, pad,
3296 FALSE, GST_MINI_OBJECT_CAST (event), FALSE);
3297 if (G_UNLIKELY (ret != GST_FLOW_OK))
3300 GST_OBJECT_LOCK (basesink);
3301 basesink->have_newsegment = TRUE;
3302 GST_OBJECT_UNLOCK (basesink);
3305 GST_PAD_PREROLL_UNLOCK (pad);
3308 case GST_EVENT_FLUSH_START:
3310 bclass->event (basesink, event);
3312 GST_DEBUG_OBJECT (basesink, "flush-start %p", event);
3314 gst_base_sink_flush_start (basesink, pad);
3316 gst_event_unref (event);
3318 case GST_EVENT_FLUSH_STOP:
3320 bclass->event (basesink, event);
3322 GST_DEBUG_OBJECT (basesink, "flush-stop %p", event);
3324 gst_base_sink_flush_stop (basesink, pad);
3326 gst_event_unref (event);
3329 /* other events are sent to queue or subclass depending on if they
3330 * are serialized. */
3331 if (GST_EVENT_IS_SERIALIZED (event)) {
3332 gst_base_sink_queue_object (basesink, pad,
3333 GST_MINI_OBJECT_CAST (event), FALSE);
3336 bclass->event (basesink, event);
3337 gst_event_unref (event);
3342 gst_object_unref (basesink);
3349 GST_DEBUG_OBJECT (basesink, "we are flushing");
3350 GST_PAD_PREROLL_UNLOCK (pad);
3352 gst_event_unref (event);
3357 /* default implementation to calculate the start and end
3358 * timestamps on a buffer, subclasses can override
3361 gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
3362 GstClockTime * start, GstClockTime * end)
3364 GstClockTime timestamp, duration;
3366 timestamp = GST_BUFFER_TIMESTAMP (buffer);
3367 if (GST_CLOCK_TIME_IS_VALID (timestamp)) {
3369 /* get duration to calculate end time */
3370 duration = GST_BUFFER_DURATION (buffer);
3371 if (GST_CLOCK_TIME_IS_VALID (duration)) {
3372 *end = timestamp + duration;
3378 /* must be called with PREROLL_LOCK */
3380 gst_base_sink_needs_preroll (GstBaseSink * basesink)
3382 gboolean is_prerolled, res;
3384 /* we have 2 cases where the PREROLL_LOCK is released:
3385 * 1) we are blocking in the PREROLL_LOCK and thus are prerolled.
3386 * 2) we are syncing on the clock
3388 is_prerolled = basesink->have_preroll || basesink->priv->received_eos;
3389 res = !is_prerolled;
3391 GST_DEBUG_OBJECT (basesink, "have_preroll: %d, EOS: %d => needs preroll: %d",
3392 basesink->have_preroll, basesink->priv->received_eos, res);
3397 /* with STREAM_LOCK, PREROLL_LOCK
3399 * Takes a buffer and compare the timestamps with the last segment.
3400 * If the buffer falls outside of the segment boundaries, drop it.
3401 * Else queue the buffer for preroll and rendering.
3403 * This function takes ownership of the buffer.
3405 static GstFlowReturn
3406 gst_base_sink_chain_unlocked (GstBaseSink * basesink, GstPad * pad,
3407 gboolean is_list, gpointer obj)
3409 GstBaseSinkClass *bclass;
3410 GstFlowReturn result;
3411 GstClockTime start = GST_CLOCK_TIME_NONE, end = GST_CLOCK_TIME_NONE;
3412 GstSegment *clip_segment;
3413 GstBuffer *time_buf;
3415 if (G_UNLIKELY (basesink->flushing))
3418 if (G_UNLIKELY (basesink->priv->received_eos))
3422 time_buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0, 0);
3423 g_assert (NULL != time_buf);
3425 time_buf = GST_BUFFER_CAST (obj);
3428 /* for code clarity */
3429 clip_segment = basesink->abidata.ABI.clip_segment;
3431 if (G_UNLIKELY (!basesink->have_newsegment)) {
3434 sync = gst_base_sink_get_sync (basesink);
3436 GST_ELEMENT_WARNING (basesink, STREAM, FAILED,
3437 (_("Internal data flow problem.")),
3438 ("Received buffer without a new-segment. Assuming timestamps start from 0."));
3441 /* this means this sink will assume timestamps start from 0 */
3442 GST_OBJECT_LOCK (basesink);
3443 clip_segment->start = 0;
3444 clip_segment->stop = -1;
3445 basesink->segment.start = 0;
3446 basesink->segment.stop = -1;
3447 basesink->have_newsegment = TRUE;
3448 GST_OBJECT_UNLOCK (basesink);
3451 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3453 /* check if the buffer needs to be dropped, we first ask the subclass for the
3455 if (bclass->get_times)
3456 bclass->get_times (basesink, time_buf, &start, &end);
3458 if (!GST_CLOCK_TIME_IS_VALID (start)) {
3459 /* if the subclass does not want sync, we use our own values so that we at
3460 * least clip the buffer to the segment */
3461 gst_base_sink_get_times (basesink, time_buf, &start, &end);
3464 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
3465 ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (end));
3467 /* a dropped buffer does not participate in anything */
3468 if (GST_CLOCK_TIME_IS_VALID (start) &&
3469 (clip_segment->format == GST_FORMAT_TIME)) {
3470 if (G_UNLIKELY (!gst_segment_clip (clip_segment,
3471 GST_FORMAT_TIME, (gint64) start, (gint64) end, NULL, NULL)))
3472 goto out_of_segment;
3475 /* now we can process the buffer in the queue, this function takes ownership
3477 result = gst_base_sink_queue_object_unlocked (basesink, pad,
3478 is_list, obj, TRUE);
3484 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3485 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3486 return GST_FLOW_WRONG_STATE;
3490 GST_DEBUG_OBJECT (basesink,
3491 "we are EOS, dropping object, return UNEXPECTED");
3492 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3493 return GST_FLOW_UNEXPECTED;
3497 GST_DEBUG_OBJECT (basesink, "dropping buffer, out of clipping segment");
3498 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3505 static GstFlowReturn
3506 gst_base_sink_chain_main (GstBaseSink * basesink, GstPad * pad,
3507 gboolean is_list, gpointer obj)
3509 GstFlowReturn result;
3511 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH))
3514 GST_PAD_PREROLL_LOCK (pad);
3515 result = gst_base_sink_chain_unlocked (basesink, pad, is_list, obj);
3516 GST_PAD_PREROLL_UNLOCK (pad);
3524 GST_OBJECT_LOCK (pad);
3525 GST_WARNING_OBJECT (basesink,
3526 "Push on pad %s:%s, but it was not activated in push mode",
3527 GST_DEBUG_PAD_NAME (pad));
3528 GST_OBJECT_UNLOCK (pad);
3529 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3530 /* we don't post an error message this will signal to the peer
3531 * pushing that EOS is reached. */
3532 result = GST_FLOW_UNEXPECTED;
3537 static GstFlowReturn
3538 gst_base_sink_chain (GstPad * pad, GstBuffer * buf)
3540 GstBaseSink *basesink;
3542 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3544 return gst_base_sink_chain_main (basesink, pad, FALSE, buf);
3547 static GstFlowReturn
3548 gst_base_sink_chain_list (GstPad * pad, GstBufferList * list)
3550 GstBaseSink *basesink;
3551 GstBaseSinkClass *bclass;
3552 GstFlowReturn result;
3554 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3555 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3557 if (G_LIKELY (bclass->render_list)) {
3558 result = gst_base_sink_chain_main (basesink, pad, TRUE, list);
3560 GstBufferListIterator *it;
3563 GST_INFO_OBJECT (pad, "chaining each group in list as a merged buffer");
3565 it = gst_buffer_list_iterate (list);
3567 if (gst_buffer_list_iterator_next_group (it)) {
3569 group = gst_buffer_list_iterator_merge_group (it);
3570 if (group == NULL) {
3571 group = gst_buffer_new ();
3572 GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining empty group");
3574 GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining group");
3576 result = gst_base_sink_chain_main (basesink, pad, FALSE, group);
3577 } while (result == GST_FLOW_OK
3578 && gst_buffer_list_iterator_next_group (it));
3580 GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining empty group");
3582 gst_base_sink_chain_main (basesink, pad, FALSE, gst_buffer_new ());
3584 gst_buffer_list_iterator_free (it);
3585 gst_buffer_list_unref (list);
3592 gst_base_sink_default_do_seek (GstBaseSink * sink, GstSegment * segment)
3594 gboolean res = TRUE;
3596 /* update our offset if the start/stop position was updated */
3597 if (segment->format == GST_FORMAT_BYTES) {
3598 segment->time = segment->start;
3599 } else if (segment->start == 0) {
3600 /* seek to start, we can implement a default for this. */
3604 GST_INFO_OBJECT (sink, "Can't do a default seek");
3610 #define SEEK_TYPE_IS_RELATIVE(t) (((t) != GST_SEEK_TYPE_NONE) && ((t) != GST_SEEK_TYPE_SET))
3613 gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
3614 GstEvent * event, GstSegment * segment)
3616 /* By default, we try one of 2 things:
3617 * - For absolute seek positions, convert the requested position to our
3618 * configured processing format and place it in the output segment \
3619 * - For relative seek positions, convert our current (input) values to the
3620 * seek format, adjust by the relative seek offset and then convert back to
3621 * the processing format
3623 GstSeekType cur_type, stop_type;
3626 GstFormat seek_format, dest_format;
3629 gboolean res = TRUE;
3631 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3632 &cur_type, &cur, &stop_type, &stop);
3633 dest_format = segment->format;
3635 if (seek_format == dest_format) {
3636 gst_segment_set_seek (segment, rate, seek_format, flags,
3637 cur_type, cur, stop_type, stop, &update);
3641 if (cur_type != GST_SEEK_TYPE_NONE) {
3642 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3644 gst_pad_query_convert (sink->sinkpad, seek_format, cur, &dest_format,
3646 cur_type = GST_SEEK_TYPE_SET;
3649 if (res && stop_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, stop, &dest_format,
3654 stop_type = GST_SEEK_TYPE_SET;
3657 /* And finally, configure our output segment in the desired format */
3658 gst_segment_set_seek (segment, rate, dest_format, flags, cur_type, cur,
3659 stop_type, stop, &update);
3668 GST_DEBUG_OBJECT (sink, "undefined format given, seek aborted.");
3673 /* perform a seek, only executed in pull mode */
3675 gst_base_sink_perform_seek (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3679 GstFormat seek_format, dest_format;
3681 GstSeekType cur_type, stop_type;
3682 gboolean seekseg_configured = FALSE;
3684 gboolean update, res = TRUE;
3685 GstSegment seeksegment;
3687 dest_format = sink->segment.format;
3690 GST_DEBUG_OBJECT (sink, "performing seek with event %p", event);
3691 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3692 &cur_type, &cur, &stop_type, &stop);
3694 flush = flags & GST_SEEK_FLAG_FLUSH;
3696 GST_DEBUG_OBJECT (sink, "performing seek without event");
3701 GST_DEBUG_OBJECT (sink, "flushing upstream");
3702 gst_pad_push_event (pad, gst_event_new_flush_start ());
3703 gst_base_sink_flush_start (sink, pad);
3705 GST_DEBUG_OBJECT (sink, "pausing pulling thread");
3708 GST_PAD_STREAM_LOCK (pad);
3710 /* If we configured the seeksegment above, don't overwrite it now. Otherwise
3711 * copy the current segment info into the temp segment that we can actually
3712 * attempt the seek with. We only update the real segment if the seek suceeds. */
3713 if (!seekseg_configured) {
3714 memcpy (&seeksegment, &sink->segment, sizeof (GstSegment));
3716 /* now configure the final seek segment */
3718 if (sink->segment.format != seek_format) {
3719 /* OK, here's where we give the subclass a chance to convert the relative
3720 * seek into an absolute one in the processing format. We set up any
3721 * absolute seek above, before taking the stream lock. */
3722 if (!gst_base_sink_default_prepare_seek_segment (sink, event,
3724 GST_DEBUG_OBJECT (sink,
3725 "Preparing the seek failed after flushing. " "Aborting seek");
3729 /* The seek format matches our processing format, no need to ask the
3730 * the subclass to configure the segment. */
3731 gst_segment_set_seek (&seeksegment, rate, seek_format, flags,
3732 cur_type, cur, stop_type, stop, &update);
3735 /* Else, no seek event passed, so we're just (re)starting the
3740 GST_DEBUG_OBJECT (sink, "segment configured from %" G_GINT64_FORMAT
3741 " to %" G_GINT64_FORMAT ", position %" G_GINT64_FORMAT,
3742 seeksegment.start, seeksegment.stop, seeksegment.last_stop);
3744 /* do the seek, segment.last_stop contains the new position. */
3745 res = gst_base_sink_default_do_seek (sink, &seeksegment);
3750 GST_DEBUG_OBJECT (sink, "stop flushing upstream");
3751 gst_pad_push_event (pad, gst_event_new_flush_stop ());
3752 gst_base_sink_flush_stop (sink, pad);
3753 } else if (res && sink->abidata.ABI.running) {
3754 /* we are running the current segment and doing a non-flushing seek,
3755 * close the segment first based on the last_stop. */
3756 GST_DEBUG_OBJECT (sink, "closing running segment %" G_GINT64_FORMAT
3757 " to %" G_GINT64_FORMAT, sink->segment.start, sink->segment.last_stop);
3760 /* The subclass must have converted the segment to the processing format
3762 if (res && seeksegment.format != dest_format) {
3763 GST_DEBUG_OBJECT (sink, "Subclass failed to prepare a seek segment "
3764 "in the correct format. Aborting seek.");
3768 /* if successfull seek, we update our real segment and push
3769 * out the new segment. */
3771 memcpy (&sink->segment, &seeksegment, sizeof (GstSegment));
3773 if (sink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3774 gst_element_post_message (GST_ELEMENT (sink),
3775 gst_message_new_segment_start (GST_OBJECT (sink),
3776 sink->segment.format, sink->segment.last_stop));
3780 sink->priv->discont = TRUE;
3781 sink->abidata.ABI.running = TRUE;
3783 GST_PAD_STREAM_UNLOCK (pad);
3789 set_step_info (GstBaseSink * sink, GstStepInfo * current, GstStepInfo * pending,
3790 guint seqnum, GstFormat format, guint64 amount, gdouble rate,
3791 gboolean flush, gboolean intermediate)
3793 GST_OBJECT_LOCK (sink);
3794 pending->seqnum = seqnum;
3795 pending->format = format;
3796 pending->amount = amount;
3797 pending->position = 0;
3798 pending->rate = rate;
3799 pending->flush = flush;
3800 pending->intermediate = intermediate;
3801 pending->valid = TRUE;
3802 /* flush invalidates the current stepping segment */
3804 current->valid = FALSE;
3805 GST_OBJECT_UNLOCK (sink);
3809 gst_base_sink_perform_step (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3811 GstBaseSinkPrivate *priv;
3812 GstBaseSinkClass *bclass;
3813 gboolean flush, intermediate;
3818 GstStepInfo *pending, *current;
3819 GstMessage *message;
3821 bclass = GST_BASE_SINK_GET_CLASS (sink);
3824 GST_DEBUG_OBJECT (sink, "performing step with event %p", event);
3826 gst_event_parse_step (event, &format, &amount, &rate, &flush, &intermediate);
3827 seqnum = gst_event_get_seqnum (event);
3829 pending = &priv->pending_step;
3830 current = &priv->current_step;
3832 /* post message first */
3833 message = gst_message_new_step_start (GST_OBJECT (sink), FALSE, format,
3834 amount, rate, flush, intermediate);
3835 gst_message_set_seqnum (message, seqnum);
3836 gst_element_post_message (GST_ELEMENT (sink), message);
3839 /* we need to call ::unlock before locking PREROLL_LOCK
3840 * since we lock it before going into ::render */
3842 bclass->unlock (sink);
3844 GST_PAD_PREROLL_LOCK (sink->sinkpad);
3845 /* now that we have the PREROLL lock, clear our unlock request */
3846 if (bclass->unlock_stop)
3847 bclass->unlock_stop (sink);
3849 /* update the stepinfo and make it valid */
3850 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3853 if (sink->priv->async_enabled) {
3854 /* and we need to commit our state again on the next
3855 * prerolled buffer */
3856 sink->playing_async = TRUE;
3857 priv->pending_step.need_preroll = TRUE;
3858 sink->need_preroll = FALSE;
3859 gst_element_lost_state_full (GST_ELEMENT_CAST (sink), FALSE);
3861 sink->priv->have_latency = TRUE;
3862 sink->need_preroll = FALSE;
3864 priv->current_sstart = GST_CLOCK_TIME_NONE;
3865 priv->current_sstop = GST_CLOCK_TIME_NONE;
3866 priv->eos_rtime = GST_CLOCK_TIME_NONE;
3867 priv->call_preroll = TRUE;
3868 gst_base_sink_set_last_buffer (sink, NULL);
3869 gst_base_sink_reset_qos (sink);
3871 if (sink->clock_id) {
3872 gst_clock_id_unschedule (sink->clock_id);
3875 if (sink->have_preroll) {
3876 GST_DEBUG_OBJECT (sink, "signal waiter");
3877 priv->step_unlock = TRUE;
3878 GST_PAD_PREROLL_SIGNAL (sink->sinkpad);
3880 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
3882 /* update the stepinfo and make it valid */
3883 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3893 gst_base_sink_loop (GstPad * pad)
3895 GstBaseSink *basesink;
3896 GstBuffer *buf = NULL;
3897 GstFlowReturn result;
3901 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3903 g_assert (basesink->pad_mode == GST_ACTIVATE_PULL);
3905 if ((blocksize = basesink->priv->blocksize) == 0)
3908 offset = basesink->segment.last_stop;
3910 GST_DEBUG_OBJECT (basesink, "pulling %" G_GUINT64_FORMAT ", %u",
3913 result = gst_pad_pull_range (pad, offset, blocksize, &buf);
3914 if (G_UNLIKELY (result != GST_FLOW_OK))
3917 if (G_UNLIKELY (buf == NULL))
3920 offset += GST_BUFFER_SIZE (buf);
3922 gst_segment_set_last_stop (&basesink->segment, GST_FORMAT_BYTES, offset);
3924 GST_PAD_PREROLL_LOCK (pad);
3925 result = gst_base_sink_chain_unlocked (basesink, pad, FALSE, buf);
3926 GST_PAD_PREROLL_UNLOCK (pad);
3927 if (G_UNLIKELY (result != GST_FLOW_OK))
3935 GST_LOG_OBJECT (basesink, "pausing task, reason %s",
3936 gst_flow_get_name (result));
3937 gst_pad_pause_task (pad);
3938 if (result == GST_FLOW_UNEXPECTED) {
3939 /* perform EOS logic */
3940 if (basesink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3941 gst_element_post_message (GST_ELEMENT_CAST (basesink),
3942 gst_message_new_segment_done (GST_OBJECT_CAST (basesink),
3943 basesink->segment.format, basesink->segment.last_stop));
3945 gst_base_sink_event (pad, gst_event_new_eos ());
3947 } else if (result == GST_FLOW_NOT_LINKED || result <= GST_FLOW_UNEXPECTED) {
3948 /* for fatal errors we post an error message, post the error
3949 * first so the app knows about the error first.
3950 * wrong-state is not a fatal error because it happens due to
3951 * flushing and posting an error message in that case is the
3952 * wrong thing to do, e.g. when basesrc is doing a flushing
3954 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
3955 (_("Internal data stream error.")),
3956 ("stream stopped, reason %s", gst_flow_get_name (result)));
3957 gst_base_sink_event (pad, gst_event_new_eos ());
3963 GST_LOG_OBJECT (basesink, "no buffer, pausing");
3964 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
3965 (_("Internal data flow error.")), ("element returned NULL buffer"));
3966 result = GST_FLOW_ERROR;
3972 gst_base_sink_set_flushing (GstBaseSink * basesink, GstPad * pad,
3975 GstBaseSinkClass *bclass;
3977 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3980 /* unlock any subclasses, we need to do this before grabbing the
3981 * PREROLL_LOCK since we hold this lock before going into ::render. */
3983 bclass->unlock (basesink);
3986 GST_PAD_PREROLL_LOCK (pad);
3987 basesink->flushing = flushing;
3989 /* step 1, now that we have the PREROLL lock, clear our unlock request */
3990 if (bclass->unlock_stop)
3991 bclass->unlock_stop (basesink);
3993 /* set need_preroll before we unblock the clock. If the clock is unblocked
3994 * before timing out, we can reuse the buffer for preroll. */
3995 basesink->need_preroll = TRUE;
3997 /* step 2, unblock clock sync (if any) or any other blocking thing */
3998 if (basesink->clock_id) {
3999 gst_clock_id_unschedule (basesink->clock_id);
4002 /* flush out the data thread if it's locked in finish_preroll, this will
4003 * also flush out the EOS state */
4004 GST_DEBUG_OBJECT (basesink,
4005 "flushing out data thread, need preroll to TRUE");
4006 gst_base_sink_preroll_queue_flush (basesink, pad);
4008 GST_PAD_PREROLL_UNLOCK (pad);
4014 gst_base_sink_default_activate_pull (GstBaseSink * basesink, gboolean active)
4020 result = gst_pad_start_task (basesink->sinkpad,
4021 (GstTaskFunction) gst_base_sink_loop, basesink->sinkpad);
4023 /* step 2, make sure streaming finishes */
4024 result = gst_pad_stop_task (basesink->sinkpad);
4031 gst_base_sink_pad_activate (GstPad * pad)
4033 gboolean result = FALSE;
4034 GstBaseSink *basesink;
4036 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4038 GST_DEBUG_OBJECT (basesink, "Trying pull mode first");
4040 gst_base_sink_set_flushing (basesink, pad, FALSE);
4042 /* we need to have the pull mode enabled */
4043 if (!basesink->can_activate_pull) {
4044 GST_DEBUG_OBJECT (basesink, "pull mode disabled");
4048 /* check if downstreams supports pull mode at all */
4049 if (!gst_pad_check_pull_range (pad)) {
4050 GST_DEBUG_OBJECT (basesink, "pull mode not supported");
4054 /* set the pad mode before starting the task so that it's in the
4055 * correct state for the new thread. also the sink set_caps and get_caps
4056 * function checks this */
4057 basesink->pad_mode = GST_ACTIVATE_PULL;
4059 /* we first try to negotiate a format so that when we try to activate
4060 * downstream, it knows about our format */
4061 if (!gst_base_sink_negotiate_pull (basesink)) {
4062 GST_DEBUG_OBJECT (basesink, "failed to negotiate in pull mode");
4066 /* ok activate now */
4067 if (!gst_pad_activate_pull (pad, TRUE)) {
4068 /* clear any pending caps */
4069 GST_OBJECT_LOCK (basesink);
4070 gst_caps_replace (&basesink->priv->pull_caps, NULL);
4071 GST_OBJECT_UNLOCK (basesink);
4072 GST_DEBUG_OBJECT (basesink, "failed to activate in pull mode");
4076 GST_DEBUG_OBJECT (basesink, "Success activating pull mode");
4080 /* push mode fallback */
4082 GST_DEBUG_OBJECT (basesink, "Falling back to push mode");
4083 if ((result = gst_pad_activate_push (pad, TRUE))) {
4084 GST_DEBUG_OBJECT (basesink, "Success activating push mode");
4089 GST_WARNING_OBJECT (basesink, "Could not activate pad in either mode");
4090 gst_base_sink_set_flushing (basesink, pad, TRUE);
4093 gst_object_unref (basesink);
4099 gst_base_sink_pad_activate_push (GstPad * pad, gboolean active)
4102 GstBaseSink *basesink;
4104 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4107 if (!basesink->can_activate_push) {
4109 basesink->pad_mode = GST_ACTIVATE_NONE;
4112 basesink->pad_mode = GST_ACTIVATE_PUSH;
4115 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH)) {
4116 g_warning ("Internal GStreamer activation error!!!");
4119 gst_base_sink_set_flushing (basesink, pad, TRUE);
4121 basesink->pad_mode = GST_ACTIVATE_NONE;
4125 gst_object_unref (basesink);
4131 gst_base_sink_negotiate_pull (GstBaseSink * basesink)
4138 /* this returns the intersection between our caps and the peer caps. If there
4139 * is no peer, it returns NULL and we can't operate in pull mode so we can
4140 * fail the negotiation. */
4141 caps = gst_pad_get_allowed_caps (GST_BASE_SINK_PAD (basesink));
4142 if (caps == NULL || gst_caps_is_empty (caps))
4143 goto no_caps_possible;
4145 GST_DEBUG_OBJECT (basesink, "allowed caps: %" GST_PTR_FORMAT, caps);
4147 caps = gst_caps_make_writable (caps);
4148 /* get the first (prefered) format */
4149 gst_caps_truncate (caps);
4151 gst_pad_fixate_caps (GST_BASE_SINK_PAD (basesink), caps);
4153 GST_DEBUG_OBJECT (basesink, "fixated to: %" GST_PTR_FORMAT, caps);
4155 if (gst_caps_is_any (caps)) {
4156 GST_DEBUG_OBJECT (basesink, "caps were ANY after fixating, "
4158 /* neither side has template caps in this case, so they are prepared for
4159 pull() without setcaps() */
4161 } else if (gst_caps_is_fixed (caps)) {
4162 if (!gst_pad_set_caps (GST_BASE_SINK_PAD (basesink), caps))
4163 goto could_not_set_caps;
4165 GST_OBJECT_LOCK (basesink);
4166 gst_caps_replace (&basesink->priv->pull_caps, caps);
4167 GST_OBJECT_UNLOCK (basesink);
4172 gst_caps_unref (caps);
4178 GST_INFO_OBJECT (basesink, "Pipeline could not agree on caps");
4179 GST_DEBUG_OBJECT (basesink, "get_allowed_caps() returned EMPTY");
4181 gst_caps_unref (caps);
4186 GST_INFO_OBJECT (basesink, "Could not set caps: %" GST_PTR_FORMAT, caps);
4187 gst_caps_unref (caps);
4192 /* this won't get called until we implement an activate function */
4194 gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active)
4196 gboolean result = FALSE;
4197 GstBaseSink *basesink;
4198 GstBaseSinkClass *bclass;
4200 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4201 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4207 /* we mark we have a newsegment here because pull based
4208 * mode works just fine without having a newsegment before the
4210 format = GST_FORMAT_BYTES;
4212 gst_segment_init (&basesink->segment, format);
4213 gst_segment_init (basesink->abidata.ABI.clip_segment, format);
4214 GST_OBJECT_LOCK (basesink);
4215 basesink->have_newsegment = TRUE;
4216 GST_OBJECT_UNLOCK (basesink);
4218 /* get the peer duration in bytes */
4219 result = gst_pad_query_peer_duration (pad, &format, &duration);
4221 GST_DEBUG_OBJECT (basesink,
4222 "setting duration in bytes to %" G_GINT64_FORMAT, duration);
4223 gst_segment_set_duration (basesink->abidata.ABI.clip_segment, format,
4225 gst_segment_set_duration (&basesink->segment, format, duration);
4227 GST_DEBUG_OBJECT (basesink, "unknown duration");
4230 if (bclass->activate_pull)
4231 result = bclass->activate_pull (basesink, TRUE);
4236 goto activate_failed;
4239 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PULL)) {
4240 g_warning ("Internal GStreamer activation error!!!");
4243 result = gst_base_sink_set_flushing (basesink, pad, TRUE);
4244 if (bclass->activate_pull)
4245 result &= bclass->activate_pull (basesink, FALSE);
4246 basesink->pad_mode = GST_ACTIVATE_NONE;
4247 /* clear any pending caps */
4248 GST_OBJECT_LOCK (basesink);
4249 gst_caps_replace (&basesink->priv->pull_caps, NULL);
4250 GST_OBJECT_UNLOCK (basesink);
4253 gst_object_unref (basesink);
4260 /* reset, as starting the thread failed */
4261 basesink->pad_mode = GST_ACTIVATE_NONE;
4263 GST_ERROR_OBJECT (basesink, "subclass failed to activate in pull mode");
4268 /* send an event to our sinkpad peer. */
4270 gst_base_sink_send_event (GstElement * element, GstEvent * event)
4273 GstBaseSink *basesink = GST_BASE_SINK (element);
4274 gboolean forward, result = TRUE;
4275 GstActivateMode mode;
4277 GST_OBJECT_LOCK (element);
4278 /* get the pad and the scheduling mode */
4279 pad = gst_object_ref (basesink->sinkpad);
4280 mode = basesink->pad_mode;
4281 GST_OBJECT_UNLOCK (element);
4283 /* only push UPSTREAM events upstream */
4284 forward = GST_EVENT_IS_UPSTREAM (event);
4286 GST_DEBUG_OBJECT (basesink, "handling event %p %" GST_PTR_FORMAT, event,
4289 switch (GST_EVENT_TYPE (event)) {
4290 case GST_EVENT_LATENCY:
4292 GstClockTime latency;
4294 gst_event_parse_latency (event, &latency);
4296 /* store the latency. We use this to adjust the running_time before syncing
4297 * it to the clock. */
4298 GST_OBJECT_LOCK (element);
4299 basesink->priv->latency = latency;
4300 if (!basesink->priv->have_latency)
4302 GST_OBJECT_UNLOCK (element);
4303 GST_DEBUG_OBJECT (basesink, "latency set to %" GST_TIME_FORMAT,
4304 GST_TIME_ARGS (latency));
4306 /* We forward this event so that all elements know about the global pipeline
4307 * latency. This is interesting for an element when it wants to figure out
4308 * when a particular piece of data will be rendered. */
4311 case GST_EVENT_SEEK:
4312 /* in pull mode we will execute the seek */
4313 if (mode == GST_ACTIVATE_PULL)
4314 result = gst_base_sink_perform_seek (basesink, pad, event);
4316 case GST_EVENT_STEP:
4317 result = gst_base_sink_perform_step (basesink, pad, event);
4325 result = gst_pad_push_event (pad, event);
4327 /* not forwarded, unref the event */
4328 gst_event_unref (event);
4331 gst_object_unref (pad);
4335 /* get the end position of the last seen object, this is used
4336 * for EOS and for making sure that we don't report a position we
4337 * have not reached yet. With LOCK. */
4339 gst_base_sink_get_position_last (GstBaseSink * basesink, GstFormat format,
4340 gint64 * cur, gboolean * upstream)
4343 GstSegment *segment;
4344 gboolean ret = TRUE;
4346 segment = &basesink->segment;
4347 oformat = segment->format;
4349 if (oformat == GST_FORMAT_TIME) {
4350 /* return last observed stream time, we keep the stream time around in the
4352 *cur = basesink->priv->current_sstop;
4354 /* convert last stop to stream time */
4355 *cur = gst_segment_to_stream_time (segment, oformat, segment->last_stop);
4358 if (*cur != -1 && oformat != format) {
4359 GST_OBJECT_UNLOCK (basesink);
4360 /* convert to the target format if we need to, release lock first */
4362 gst_pad_query_convert (basesink->sinkpad, oformat, *cur, &format, cur);
4367 GST_OBJECT_LOCK (basesink);
4370 GST_DEBUG_OBJECT (basesink, "POSITION: %" GST_TIME_FORMAT,
4371 GST_TIME_ARGS (*cur));
4376 /* get the position when we are PAUSED, this is the stream time of the buffer
4377 * that prerolled. If no buffer is prerolled (we are still flushing), this
4378 * value will be -1. With LOCK. */
4380 gst_base_sink_get_position_paused (GstBaseSink * basesink, GstFormat format,
4381 gint64 * cur, gboolean * upstream)
4385 GstSegment *segment;
4388 /* we don't use the clip segment in pull mode, when seeking we update the
4389 * main segment directly with the new segment values without it having to be
4390 * activated by the rendering after preroll */
4391 if (basesink->pad_mode == GST_ACTIVATE_PUSH)
4392 segment = basesink->abidata.ABI.clip_segment;
4394 segment = &basesink->segment;
4395 oformat = segment->format;
4397 if (oformat == GST_FORMAT_TIME) {
4398 *cur = basesink->priv->current_sstart;
4399 if (segment->rate < 0.0 &&
4400 GST_CLOCK_TIME_IS_VALID (basesink->priv->current_sstop)) {
4401 /* for reverse playback we prefer the stream time stop position if we have
4403 *cur = basesink->priv->current_sstop;
4406 *cur = gst_segment_to_stream_time (segment, oformat, segment->last_stop);
4409 time = segment->time;
4412 *cur = MAX (*cur, time);
4413 GST_DEBUG_OBJECT (basesink, "POSITION as max: %" GST_TIME_FORMAT
4414 ", time %" GST_TIME_FORMAT, GST_TIME_ARGS (*cur), GST_TIME_ARGS (time));
4416 /* we have no buffer, use the segment times. */
4417 if (segment->rate >= 0.0) {
4418 /* forward, next position is always the time of the segment */
4420 GST_DEBUG_OBJECT (basesink, "POSITION as time: %" GST_TIME_FORMAT,
4421 GST_TIME_ARGS (*cur));
4423 /* reverse, next expected timestamp is segment->stop. We use the function
4424 * to get things right for negative applied_rates. */
4425 *cur = gst_segment_to_stream_time (segment, oformat, segment->stop);
4426 GST_DEBUG_OBJECT (basesink, "reverse POSITION: %" GST_TIME_FORMAT,
4427 GST_TIME_ARGS (*cur));
4432 if (res && oformat != format) {
4433 GST_OBJECT_UNLOCK (basesink);
4435 gst_pad_query_convert (basesink->sinkpad, oformat, *cur, &format, cur);
4440 GST_OBJECT_LOCK (basesink);
4447 gst_base_sink_get_position (GstBaseSink * basesink, GstFormat format,
4448 gint64 * cur, gboolean * upstream)
4451 gboolean res = FALSE;
4452 GstFormat oformat, tformat;
4453 GstClockTime now, latency;
4454 GstClockTimeDiff base;
4455 gint64 time, accum, duration;
4459 GST_OBJECT_LOCK (basesink);
4460 /* our intermediate time format */
4461 tformat = GST_FORMAT_TIME;
4462 /* get the format in the segment */
4463 oformat = basesink->segment.format;
4465 /* can only give answer based on the clock if not EOS */
4466 if (G_UNLIKELY (basesink->eos))
4469 /* we can only get the segment when we are not NULL or READY */
4470 if (!basesink->have_newsegment)
4473 /* when not in PLAYING or when we're busy with a state change, we
4474 * cannot read from the clock so we report time based on the
4475 * last seen timestamp. */
4476 if (GST_STATE (basesink) != GST_STATE_PLAYING ||
4477 GST_STATE_PENDING (basesink) != GST_STATE_VOID_PENDING)
4480 /* we need to sync on the clock. */
4481 if (basesink->sync == FALSE)
4484 /* and we need a clock */
4485 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (basesink)) == NULL))
4488 /* collect all data we need holding the lock */
4489 if (GST_CLOCK_TIME_IS_VALID (basesink->segment.time))
4490 time = basesink->segment.time;
4494 if (GST_CLOCK_TIME_IS_VALID (basesink->segment.stop))
4495 duration = basesink->segment.stop - basesink->segment.start;
4499 base = GST_ELEMENT_CAST (basesink)->base_time;
4500 accum = basesink->segment.accum;
4501 rate = basesink->segment.rate * basesink->segment.applied_rate;
4502 latency = basesink->priv->latency;
4504 gst_object_ref (clock);
4506 /* this function might release the LOCK */
4507 gst_base_sink_get_position_last (basesink, format, &last, upstream);
4509 /* need to release the object lock before we can get the time,
4510 * a clock might take the LOCK of the provider, which could be
4511 * a basesink subclass. */
4512 GST_OBJECT_UNLOCK (basesink);
4514 now = gst_clock_get_time (clock);
4516 if (oformat != tformat) {
4517 /* convert accum, time and duration to time */
4518 if (!gst_pad_query_convert (basesink->sinkpad, oformat, accum, &tformat,
4520 goto convert_failed;
4521 if (!gst_pad_query_convert (basesink->sinkpad, oformat, duration, &tformat,
4523 goto convert_failed;
4524 if (!gst_pad_query_convert (basesink->sinkpad, oformat, time, &tformat,
4526 goto convert_failed;
4529 /* subtract base time and accumulated time from the clock time.
4530 * Make sure we don't go negative. This is the current time in
4531 * the segment which we need to scale with the combined
4532 * rate and applied rate. */
4535 if (GST_CLOCK_DIFF (base, now) < 0)
4538 /* for negative rates we need to count back from the segment
4543 *cur = time + gst_guint64_to_gdouble (now - base) * rate;
4545 /* never report more than last seen position */
4547 *cur = MIN (last, *cur);
4549 gst_object_unref (clock);
4551 GST_DEBUG_OBJECT (basesink,
4552 "now %" GST_TIME_FORMAT " - base %" GST_TIME_FORMAT " - accum %"
4553 GST_TIME_FORMAT " + time %" GST_TIME_FORMAT,
4554 GST_TIME_ARGS (now), GST_TIME_ARGS (base),
4555 GST_TIME_ARGS (accum), GST_TIME_ARGS (time));
4557 if (oformat != format) {
4558 /* convert time to final format */
4559 if (!gst_pad_query_convert (basesink->sinkpad, tformat, *cur, &format, cur))
4560 goto convert_failed;
4566 GST_DEBUG_OBJECT (basesink, "res: %d, POSITION: %" GST_TIME_FORMAT,
4567 res, GST_TIME_ARGS (*cur));
4573 GST_DEBUG_OBJECT (basesink, "position in EOS");
4574 res = gst_base_sink_get_position_last (basesink, format, cur, upstream);
4575 GST_OBJECT_UNLOCK (basesink);
4580 GST_DEBUG_OBJECT (basesink, "position in PAUSED");
4581 res = gst_base_sink_get_position_paused (basesink, format, cur, upstream);
4582 GST_OBJECT_UNLOCK (basesink);
4587 /* in NULL or READY we always return FALSE and -1 */
4588 GST_DEBUG_OBJECT (basesink, "position in wrong state, return -1");
4591 GST_OBJECT_UNLOCK (basesink);
4596 /* report last seen timestamp if any, else ask upstream to answer */
4597 if ((*cur = basesink->priv->current_sstart) != -1)
4602 GST_DEBUG_OBJECT (basesink, "no sync, res %d, POSITION %" GST_TIME_FORMAT,
4603 res, GST_TIME_ARGS (*cur));
4604 GST_OBJECT_UNLOCK (basesink);
4609 GST_DEBUG_OBJECT (basesink, "convert failed, try upstream");
4616 gst_base_sink_get_duration (GstBaseSink * basesink, GstFormat format,
4617 gint64 * dur, gboolean * upstream)
4619 gboolean res = FALSE;
4621 if (basesink->pad_mode == GST_ACTIVATE_PULL) {
4622 GstFormat uformat = GST_FORMAT_BYTES;
4625 /* get the duration in bytes, in pull mode that's all we are sure to
4626 * know. We have to explicitly get this value from upstream instead of
4627 * using our cached value because it might change. Duration caching
4628 * should be done at a higher level. */
4629 res = gst_pad_query_peer_duration (basesink->sinkpad, &uformat, &uduration);
4631 gst_segment_set_duration (&basesink->segment, uformat, uduration);
4632 if (format != uformat) {
4633 /* convert to the requested format */
4634 res = gst_pad_query_convert (basesink->sinkpad, uformat, uduration,
4648 static const GstQueryType *
4649 gst_base_sink_get_query_types (GstElement * element)
4651 static const GstQueryType query_types[] = {
4663 gst_base_sink_query (GstElement * element, GstQuery * query)
4665 gboolean res = FALSE;
4667 GstBaseSink *basesink = GST_BASE_SINK (element);
4669 switch (GST_QUERY_TYPE (query)) {
4670 case GST_QUERY_POSITION:
4674 gboolean upstream = FALSE;
4676 gst_query_parse_position (query, &format, NULL);
4678 GST_DEBUG_OBJECT (basesink, "position query in format %s",
4679 gst_format_get_name (format));
4681 /* first try to get the position based on the clock */
4683 gst_base_sink_get_position (basesink, format, &cur, &upstream))) {
4684 gst_query_set_position (query, format, cur);
4685 } else if (upstream) {
4686 /* fallback to peer query */
4687 res = gst_pad_peer_query (basesink->sinkpad, query);
4690 /* we can handle a few things if upstream failed */
4691 if (format == GST_FORMAT_PERCENT) {
4693 GstFormat uformat = GST_FORMAT_TIME;
4695 res = gst_base_sink_get_position (basesink, GST_FORMAT_TIME, &cur,
4697 if (!res && upstream) {
4698 res = gst_pad_query_peer_position (basesink->sinkpad, &uformat,
4702 res = gst_base_sink_get_duration (basesink, GST_FORMAT_TIME, &dur,
4704 if (!res && upstream) {
4705 res = gst_pad_query_peer_duration (basesink->sinkpad, &uformat,
4712 pos = gst_util_uint64_scale (100 * GST_FORMAT_PERCENT_SCALE, cur,
4714 gst_query_set_position (query, GST_FORMAT_PERCENT, pos);
4720 case GST_QUERY_DURATION:
4724 gboolean upstream = FALSE;
4726 gst_query_parse_duration (query, &format, NULL);
4728 GST_DEBUG_OBJECT (basesink, "duration query in format %s",
4729 gst_format_get_name (format));
4732 gst_base_sink_get_duration (basesink, format, &dur, &upstream))) {
4733 gst_query_set_duration (query, format, dur);
4734 } else if (upstream) {
4735 /* fallback to peer query */
4736 res = gst_pad_peer_query (basesink->sinkpad, query);
4739 /* we can handle a few things if upstream failed */
4740 if (format == GST_FORMAT_PERCENT) {
4741 gst_query_set_duration (query, GST_FORMAT_PERCENT,
4742 GST_FORMAT_PERCENT_MAX);
4748 case GST_QUERY_LATENCY:
4750 gboolean live, us_live;
4751 GstClockTime min, max;
4753 if ((res = gst_base_sink_query_latency (basesink, &live, &us_live, &min,
4755 gst_query_set_latency (query, live, min, max);
4759 case GST_QUERY_JITTER:
4761 case GST_QUERY_RATE:
4762 /* gst_query_set_rate (query, basesink->segment_rate); */
4765 case GST_QUERY_SEGMENT:
4767 if (basesink->pad_mode == GST_ACTIVATE_PULL) {
4768 gst_query_set_segment (query, basesink->segment.rate,
4769 GST_FORMAT_TIME, basesink->segment.start, basesink->segment.stop);
4772 res = gst_pad_peer_query (basesink->sinkpad, query);
4776 case GST_QUERY_SEEKING:
4777 case GST_QUERY_CONVERT:
4778 case GST_QUERY_FORMATS:
4780 res = gst_pad_peer_query (basesink->sinkpad, query);
4783 GST_DEBUG_OBJECT (basesink, "query %s returns %d",
4784 GST_QUERY_TYPE_NAME (query), res);
4788 static GstStateChangeReturn
4789 gst_base_sink_change_state (GstElement * element, GstStateChange transition)
4791 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
4792 GstBaseSink *basesink = GST_BASE_SINK (element);
4793 GstBaseSinkClass *bclass;
4794 GstBaseSinkPrivate *priv;
4796 priv = basesink->priv;
4798 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4800 switch (transition) {
4801 case GST_STATE_CHANGE_NULL_TO_READY:
4803 if (!bclass->start (basesink))
4806 case GST_STATE_CHANGE_READY_TO_PAUSED:
4807 /* need to complete preroll before this state change completes, there
4808 * is no data flow in READY so we can safely assume we need to preroll. */
4809 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4810 GST_DEBUG_OBJECT (basesink, "READY to PAUSED");
4811 basesink->have_newsegment = FALSE;
4812 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
4813 gst_segment_init (basesink->abidata.ABI.clip_segment,
4814 GST_FORMAT_UNDEFINED);
4815 basesink->offset = 0;
4816 basesink->have_preroll = FALSE;
4817 priv->step_unlock = FALSE;
4818 basesink->need_preroll = TRUE;
4819 basesink->playing_async = TRUE;
4820 priv->current_sstart = GST_CLOCK_TIME_NONE;
4821 priv->current_sstop = GST_CLOCK_TIME_NONE;
4822 priv->eos_rtime = GST_CLOCK_TIME_NONE;
4824 basesink->eos = FALSE;
4825 priv->received_eos = FALSE;
4826 gst_base_sink_reset_qos (basesink);
4827 priv->commited = FALSE;
4828 priv->call_preroll = TRUE;
4829 priv->current_step.valid = FALSE;
4830 priv->pending_step.valid = FALSE;
4831 if (priv->async_enabled) {
4832 GST_DEBUG_OBJECT (basesink, "doing async state change");
4833 /* when async enabled, post async-start message and return ASYNC from
4834 * the state change function */
4835 ret = GST_STATE_CHANGE_ASYNC;
4836 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4837 gst_message_new_async_start (GST_OBJECT_CAST (basesink), FALSE));
4839 priv->have_latency = TRUE;
4841 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4843 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
4844 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4845 if (!gst_base_sink_needs_preroll (basesink)) {
4846 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, don't need preroll");
4847 /* no preroll needed anymore now. */
4848 basesink->playing_async = FALSE;
4849 basesink->need_preroll = FALSE;
4850 if (basesink->eos) {
4851 GstMessage *message;
4853 /* need to post EOS message here */
4854 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
4855 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
4856 gst_message_set_seqnum (message, basesink->priv->seqnum);
4857 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
4859 GST_DEBUG_OBJECT (basesink, "signal preroll");
4860 GST_PAD_PREROLL_SIGNAL (basesink->sinkpad);
4863 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, we are not prerolled");
4864 basesink->need_preroll = TRUE;
4865 basesink->playing_async = TRUE;
4866 priv->call_preroll = TRUE;
4867 priv->commited = FALSE;
4868 if (priv->async_enabled) {
4869 GST_DEBUG_OBJECT (basesink, "doing async state change");
4870 ret = GST_STATE_CHANGE_ASYNC;
4871 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4872 gst_message_new_async_start (GST_OBJECT_CAST (basesink), FALSE));
4875 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4882 GstStateChangeReturn bret;
4884 bret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
4885 if (G_UNLIKELY (bret == GST_STATE_CHANGE_FAILURE))
4886 goto activate_failed;
4889 switch (transition) {
4890 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
4891 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED");
4892 /* FIXME, make sure we cannot enter _render first */
4894 /* we need to call ::unlock before locking PREROLL_LOCK
4895 * since we lock it before going into ::render */
4897 bclass->unlock (basesink);
4899 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4900 GST_DEBUG_OBJECT (basesink, "got preroll lock");
4901 /* now that we have the PREROLL lock, clear our unlock request */
4902 if (bclass->unlock_stop)
4903 bclass->unlock_stop (basesink);
4905 /* we need preroll again and we set the flag before unlocking the clockid
4906 * because if the clockid is unlocked before a current buffer expired, we
4907 * can use that buffer to preroll with */
4908 basesink->need_preroll = TRUE;
4910 if (basesink->clock_id) {
4911 GST_DEBUG_OBJECT (basesink, "unschedule clock");
4912 gst_clock_id_unschedule (basesink->clock_id);
4915 /* if we don't have a preroll buffer we need to wait for a preroll and
4917 if (!gst_base_sink_needs_preroll (basesink)) {
4918 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED, we are prerolled");
4919 basesink->playing_async = FALSE;
4921 if (GST_STATE_TARGET (GST_ELEMENT (basesink)) <= GST_STATE_READY) {
4922 GST_DEBUG_OBJECT (basesink, "element is <= READY");
4923 ret = GST_STATE_CHANGE_SUCCESS;
4925 GST_DEBUG_OBJECT (basesink,
4926 "PLAYING to PAUSED, we are not prerolled");
4927 basesink->playing_async = TRUE;
4928 priv->commited = FALSE;
4929 priv->call_preroll = TRUE;
4930 if (priv->async_enabled) {
4931 GST_DEBUG_OBJECT (basesink, "doing async state change");
4932 ret = GST_STATE_CHANGE_ASYNC;
4933 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4934 gst_message_new_async_start (GST_OBJECT_CAST (basesink),
4939 GST_DEBUG_OBJECT (basesink, "rendered: %" G_GUINT64_FORMAT
4940 ", dropped: %" G_GUINT64_FORMAT, priv->rendered, priv->dropped);
4942 gst_base_sink_reset_qos (basesink);
4943 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4945 case GST_STATE_CHANGE_PAUSED_TO_READY:
4946 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4947 /* start by reseting our position state with the object lock so that the
4948 * position query gets the right idea. We do this before we post the
4949 * messages so that the message handlers pick this up. */
4950 GST_OBJECT_LOCK (basesink);
4951 basesink->have_newsegment = FALSE;
4952 priv->current_sstart = GST_CLOCK_TIME_NONE;
4953 priv->current_sstop = GST_CLOCK_TIME_NONE;
4954 priv->have_latency = FALSE;
4955 GST_OBJECT_UNLOCK (basesink);
4957 gst_base_sink_set_last_buffer (basesink, NULL);
4958 priv->call_preroll = FALSE;
4960 if (!priv->commited) {
4961 if (priv->async_enabled) {
4962 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, posting async-done");
4964 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4965 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
4966 GST_STATE_PLAYING, GST_STATE_PAUSED, GST_STATE_READY));
4968 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4969 gst_message_new_async_done (GST_OBJECT_CAST (basesink)));
4971 priv->commited = TRUE;
4973 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, don't need_preroll");
4975 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4977 case GST_STATE_CHANGE_READY_TO_NULL:
4979 if (!bclass->stop (basesink)) {
4980 GST_WARNING_OBJECT (basesink, "failed to stop");
4983 gst_base_sink_set_last_buffer (basesink, NULL);
4984 priv->call_preroll = FALSE;
4995 GST_DEBUG_OBJECT (basesink, "failed to start");
4996 return GST_STATE_CHANGE_FAILURE;
5000 GST_DEBUG_OBJECT (basesink,
5001 "element failed to change states -- activation problem?");
5002 return GST_STATE_CHANGE_FAILURE;