2 * Copyright (C) 2005-2007 Wim Taymans <wim.taymans@gmail.com>
4 * gstbasesink.c: Base class for sink elements
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
24 * @short_description: Base class for sink elements
25 * @see_also: #GstBaseTransform, #GstBaseSrc
27 * #GstBaseSink is the base class for sink elements in GStreamer, such as
28 * xvimagesink or filesink. It is a layer on top of #GstElement that provides a
29 * simplified interface to plugin writers. #GstBaseSink handles many details
30 * for you, for example: preroll, clock synchronization, state changes,
31 * activation in push or pull mode, and queries.
33 * In most cases, when writing sink elements, there is no need to implement
34 * class methods from #GstElement or to set functions on pads, because the
35 * #GstBaseSink infrastructure should be sufficient.
37 * #GstBaseSink provides support for exactly one sink pad, which should be
38 * named "sink". A sink implementation (subclass of #GstBaseSink) should
39 * install a pad template in its class_init function, like so:
42 * my_element_class_init (GstMyElementClass *klass)
44 * GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
46 * // sinktemplate should be a #GstStaticPadTemplate with direction
47 * // #GST_PAD_SINK and name "sink"
48 * gst_element_class_add_pad_template (gstelement_class,
49 * gst_static_pad_template_get (&sinktemplate));
50 * // see #GstElementDetails
51 * gst_element_class_set_details (gstelement_class, &details);
55 * #GstBaseSink will handle the prerolling correctly. This means that it will
56 * return #GST_STATE_CHANGE_ASYNC from a state change to PAUSED until the first
57 * buffer arrives in this element. The base class will call the
58 * #GstBaseSinkClass.preroll() vmethod with this preroll buffer and will then
59 * commit the state change to the next asynchronously pending state.
61 * When the element is set to PLAYING, #GstBaseSink will synchronise on the
62 * clock using the times returned from #GstBaseSinkClass.get_times(). If this
63 * function returns #GST_CLOCK_TIME_NONE for the start time, no synchronisation
64 * will be done. Synchronisation can be disabled entirely by setting the object
65 * #GstBaseSink:sync property to %FALSE.
67 * After synchronisation the virtual method #GstBaseSinkClass.render() will be
68 * called. Subclasses should minimally implement this method.
70 * Since 0.10.3 subclasses that synchronise on the clock in the
71 * #GstBaseSinkClass.render() method are supported as well. These classes
72 * typically receive a buffer in the render method and can then potentially
73 * block on the clock while rendering. A typical example is an audiosink.
74 * Since 0.10.11 these subclasses can use gst_base_sink_wait_preroll() to
75 * perform the blocking wait.
77 * Upon receiving the EOS event in the PLAYING state, #GstBaseSink will wait
78 * for the clock to reach the time indicated by the stop time of the last
79 * #GstBaseSinkClass.get_times() call before posting an EOS message. When the
80 * element receives EOS in PAUSED, preroll completes, the event is queued and an
81 * EOS message is posted when going to PLAYING.
83 * #GstBaseSink will internally use the #GST_EVENT_NEWSEGMENT events to schedule
84 * synchronisation and clipping of buffers. Buffers that fall completely outside
85 * of the current segment are dropped. Buffers that fall partially in the
86 * segment are rendered (and prerolled). Subclasses should do any subbuffer
87 * clipping themselves when needed.
89 * #GstBaseSink will by default report the current playback position in
90 * #GST_FORMAT_TIME based on the current clock time and segment information.
91 * If no clock has been set on the element, the query will be forwarded
94 * The #GstBaseSinkClass.set_caps() function will be called when the subclass
95 * should configure itself to process a specific media type.
97 * The #GstBaseSinkClass.start() and #GstBaseSinkClass.stop() virtual methods
98 * will be called when resources should be allocated. Any
99 * #GstBaseSinkClass.preroll(), #GstBaseSinkClass.render() and
100 * #GstBaseSinkClass.set_caps() function will be called between the
101 * #GstBaseSinkClass.start() and #GstBaseSinkClass.stop() calls.
103 * The #GstBaseSinkClass.event() virtual method will be called when an event is
104 * received by #GstBaseSink. Normally this method should only be overriden by
105 * very specific elements (such as file sinks) which need to handle the
106 * newsegment event specially.
108 * The #GstBaseSinkClass.unlock() method is called when the elements should
109 * unblock any blocking operations they perform in the
110 * #GstBaseSinkClass.render() method. This is mostly useful when the
111 * #GstBaseSinkClass.render() method performs a blocking write on a file
112 * descriptor, for example.
114 * The #GstBaseSink:max-lateness property affects how the sink deals with
115 * buffers that arrive too late in the sink. A buffer arrives too late in the
116 * sink when the presentation time (as a combination of the last segment, buffer
117 * timestamp and element base_time) plus the duration is before the current
119 * If the frame is later than max-lateness, the sink will drop the buffer
120 * without calling the render method.
121 * This feature is disabled if sync is disabled, the
122 * #GstBaseSinkClass.get_times() method does not return a valid start time or
123 * max-lateness is set to -1 (the default).
124 * Subclasses can use gst_base_sink_set_max_lateness() to configure the
125 * max-lateness value.
127 * The #GstBaseSink:qos property will enable the quality-of-service features of
128 * the basesink which gather statistics about the real-time performance of the
129 * clock synchronisation. For each buffer received in the sink, statistics are
130 * gathered and a QOS event is sent upstream with these numbers. This
131 * information can then be used by upstream elements to reduce their processing
134 * Since 0.10.15 the #GstBaseSink:async property can be used to instruct the
135 * sink to never perform an ASYNC state change. This feature is mostly usable
136 * when dealing with non-synchronized streams or sparse streams.
138 * Last reviewed on 2007-08-29 (0.10.15)
145 #include <gst/gst_private.h>
147 #include "gstbasesink.h"
148 #include <gst/gstmarshal.h>
149 #include <gst/gst-i18n-lib.h>
151 GST_DEBUG_CATEGORY_STATIC (gst_base_sink_debug);
152 #define GST_CAT_DEFAULT gst_base_sink_debug
154 #define GST_BASE_SINK_GET_PRIVATE(obj) \
155 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_BASE_SINK, GstBaseSinkPrivate))
157 #define GST_FLOW_STEP GST_FLOW_CUSTOM_ERROR
161 gboolean valid; /* if this info is valid */
162 guint32 seqnum; /* the seqnum of the STEP event */
163 GstFormat format; /* the format of the amount */
164 guint64 amount; /* the total amount of data to skip */
165 guint64 position; /* the position in the stepped data */
166 guint64 duration; /* the duration in time of the skipped data */
167 guint64 start; /* running_time of the start */
168 gdouble rate; /* rate of skipping */
169 gdouble start_rate; /* rate before skipping */
170 guint64 start_start; /* start position skipping */
171 guint64 start_stop; /* stop position skipping */
172 gboolean flush; /* if this was a flushing step */
173 gboolean intermediate; /* if this is an intermediate step */
174 gboolean need_preroll; /* if we need preroll after this step */
177 /* FIXME, some stuff in ABI.data and other in Private...
178 * Make up your mind please.
180 struct _GstBaseSinkPrivate
182 gint qos_enabled; /* ATOMIC */
183 gboolean async_enabled;
184 GstClockTimeDiff ts_offset;
185 GstClockTime render_delay;
187 /* start, stop of current buffer, stream time, used to report position */
188 GstClockTime current_sstart;
189 GstClockTime current_sstop;
191 /* start, stop and jitter of current buffer, running time */
192 GstClockTime current_rstart;
193 GstClockTime current_rstop;
194 GstClockTimeDiff current_jitter;
195 /* the running time of the previous buffer */
196 GstClockTime prev_rstart;
198 /* EOS sync time in running time */
199 GstClockTime eos_rtime;
201 /* last buffer that arrived in time, running time */
202 GstClockTime last_render_time;
203 /* when the last buffer left the sink, running time */
204 GstClockTime last_left;
206 /* running averages go here these are done on running time */
208 GstClockTime avg_duration;
210 GstClockTime avg_in_diff;
212 /* these are done on system time. avg_jitter and avg_render are
213 * compared to eachother to see if the rendering time takes a
214 * huge amount of the processing, If so we are flooded with
216 GstClockTime last_left_systime;
217 GstClockTime avg_jitter;
218 GstClockTime start, stop;
219 GstClockTime avg_render;
221 /* number of rendered and dropped frames */
226 GstClockTime latency;
228 /* if we already commited the state */
231 /* when we received EOS */
232 gboolean received_eos;
234 /* when we are prerolled and able to report latency */
235 gboolean have_latency;
237 /* the last buffer we prerolled or rendered. Useful for making snapshots */
238 gint enable_last_buffer; /* atomic */
239 GstBuffer *last_buffer;
241 /* caps for pull based scheduling */
244 /* blocksize for pulling */
249 /* seqnum of the stream */
252 gboolean call_preroll;
253 gboolean step_unlock;
255 /* we have a pending and a current step operation */
256 GstStepInfo current_step;
257 GstStepInfo pending_step;
259 /* Cached GstClockID */
260 GstClockID cached_clock_id;
262 /* for throttling and QoS */
263 GstClockTime earliest_in_time;
264 GstClockTime throttle_time;
267 #define DO_RUNNING_AVG(avg,val,size) (((val) + ((size)-1) * (avg)) / (size))
269 /* generic running average, this has a neutral window size */
270 #define UPDATE_RUNNING_AVG(avg,val) DO_RUNNING_AVG(avg,val,8)
272 /* the windows for these running averages are experimentally obtained.
273 * possitive values get averaged more while negative values use a small
274 * window so we can react faster to badness. */
275 #define UPDATE_RUNNING_AVG_P(avg,val) DO_RUNNING_AVG(avg,val,16)
276 #define UPDATE_RUNNING_AVG_N(avg,val) DO_RUNNING_AVG(avg,val,4)
280 _PR_IS_NOTHING = 1 << 0,
281 _PR_IS_BUFFER = 1 << 1,
282 _PR_IS_BUFFERLIST = 1 << 2,
283 _PR_IS_EVENT = 1 << 3
286 #define OBJ_IS_BUFFER(a) ((a) & _PR_IS_BUFFER)
287 #define OBJ_IS_BUFFERLIST(a) ((a) & _PR_IS_BUFFERLIST)
288 #define OBJ_IS_EVENT(a) ((a) & _PR_IS_EVENT)
289 #define OBJ_IS_BUFFERFULL(a) ((a) & (_PR_IS_BUFFER | _PR_IS_BUFFERLIST))
291 /* BaseSink properties */
293 #define DEFAULT_CAN_ACTIVATE_PULL FALSE /* fixme: enable me */
294 #define DEFAULT_CAN_ACTIVATE_PUSH TRUE
296 #define DEFAULT_PREROLL_QUEUE_LEN 0
297 #define DEFAULT_SYNC TRUE
298 #define DEFAULT_MAX_LATENESS -1
299 #define DEFAULT_QOS FALSE
300 #define DEFAULT_ASYNC TRUE
301 #define DEFAULT_TS_OFFSET 0
302 #define DEFAULT_BLOCKSIZE 4096
303 #define DEFAULT_RENDER_DELAY 0
304 #define DEFAULT_ENABLE_LAST_BUFFER TRUE
305 #define DEFAULT_THROTTLE_TIME 0
310 PROP_PREROLL_QUEUE_LEN,
316 PROP_ENABLE_LAST_BUFFER,
324 static GstElementClass *parent_class = NULL;
326 static void gst_base_sink_class_init (GstBaseSinkClass * klass);
327 static void gst_base_sink_init (GstBaseSink * trans, gpointer g_class);
328 static void gst_base_sink_finalize (GObject * object);
331 gst_base_sink_get_type (void)
333 static volatile gsize base_sink_type = 0;
335 if (g_once_init_enter (&base_sink_type)) {
337 static const GTypeInfo base_sink_info = {
338 sizeof (GstBaseSinkClass),
341 (GClassInitFunc) gst_base_sink_class_init,
344 sizeof (GstBaseSink),
346 (GInstanceInitFunc) gst_base_sink_init,
349 _type = g_type_register_static (GST_TYPE_ELEMENT,
350 "GstBaseSink", &base_sink_info, G_TYPE_FLAG_ABSTRACT);
351 g_once_init_leave (&base_sink_type, _type);
353 return base_sink_type;
356 static void gst_base_sink_set_property (GObject * object, guint prop_id,
357 const GValue * value, GParamSpec * pspec);
358 static void gst_base_sink_get_property (GObject * object, guint prop_id,
359 GValue * value, GParamSpec * pspec);
361 static gboolean gst_base_sink_send_event (GstElement * element,
363 static gboolean gst_base_sink_query (GstElement * element, GstQuery * query);
364 static const GstQueryType *gst_base_sink_get_query_types (GstElement * element);
366 static GstCaps *gst_base_sink_get_caps (GstBaseSink * sink);
367 static gboolean gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps);
368 static void gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
369 GstClockTime * start, GstClockTime * end);
370 static gboolean gst_base_sink_set_flushing (GstBaseSink * basesink,
371 GstPad * pad, gboolean flushing);
372 static gboolean gst_base_sink_default_activate_pull (GstBaseSink * basesink,
374 static gboolean gst_base_sink_default_do_seek (GstBaseSink * sink,
375 GstSegment * segment);
376 static gboolean gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
377 GstEvent * event, GstSegment * segment);
379 static GstStateChangeReturn gst_base_sink_change_state (GstElement * element,
380 GstStateChange transition);
382 static GstFlowReturn gst_base_sink_chain (GstPad * pad, GstBuffer * buffer);
383 static GstFlowReturn gst_base_sink_chain_list (GstPad * pad,
384 GstBufferList * list);
386 static void gst_base_sink_loop (GstPad * pad);
387 static gboolean gst_base_sink_pad_activate (GstPad * pad);
388 static gboolean gst_base_sink_pad_activate_push (GstPad * pad, gboolean active);
389 static gboolean gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active);
390 static gboolean gst_base_sink_event (GstPad * pad, GstEvent * event);
392 static gboolean gst_base_sink_negotiate_pull (GstBaseSink * basesink);
393 static GstCaps *gst_base_sink_pad_getcaps (GstPad * pad);
394 static gboolean gst_base_sink_pad_setcaps (GstPad * pad, GstCaps * caps);
395 static void gst_base_sink_pad_fixate (GstPad * pad, GstCaps * caps);
397 /* check if an object was too late */
398 static gboolean gst_base_sink_is_too_late (GstBaseSink * basesink,
399 GstMiniObject * obj, GstClockTime rstart, GstClockTime rstop,
400 GstClockReturn status, GstClockTimeDiff jitter);
401 static GstFlowReturn gst_base_sink_preroll_object (GstBaseSink * basesink,
402 guint8 obj_type, GstMiniObject * obj);
405 gst_base_sink_class_init (GstBaseSinkClass * klass)
407 GObjectClass *gobject_class;
408 GstElementClass *gstelement_class;
410 gobject_class = G_OBJECT_CLASS (klass);
411 gstelement_class = GST_ELEMENT_CLASS (klass);
413 GST_DEBUG_CATEGORY_INIT (gst_base_sink_debug, "basesink", 0,
416 g_type_class_add_private (klass, sizeof (GstBaseSinkPrivate));
418 parent_class = g_type_class_peek_parent (klass);
420 gobject_class->finalize = gst_base_sink_finalize;
421 gobject_class->set_property = gst_base_sink_set_property;
422 gobject_class->get_property = gst_base_sink_get_property;
424 /* FIXME, this next value should be configured using an event from the
425 * upstream element, ie, the BUFFER_SIZE event. */
426 g_object_class_install_property (gobject_class, PROP_PREROLL_QUEUE_LEN,
427 g_param_spec_uint ("preroll-queue-len", "Preroll queue length",
428 "Number of buffers to queue during preroll", 0, G_MAXUINT,
429 DEFAULT_PREROLL_QUEUE_LEN,
430 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
432 g_object_class_install_property (gobject_class, PROP_SYNC,
433 g_param_spec_boolean ("sync", "Sync", "Sync on the clock", DEFAULT_SYNC,
434 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
436 g_object_class_install_property (gobject_class, PROP_MAX_LATENESS,
437 g_param_spec_int64 ("max-lateness", "Max Lateness",
438 "Maximum number of nanoseconds that a buffer can be late before it "
439 "is dropped (-1 unlimited)", -1, G_MAXINT64, DEFAULT_MAX_LATENESS,
440 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
442 g_object_class_install_property (gobject_class, PROP_QOS,
443 g_param_spec_boolean ("qos", "Qos",
444 "Generate Quality-of-Service events upstream", DEFAULT_QOS,
445 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
449 * If set to #TRUE, the basesink will perform asynchronous state changes.
450 * When set to #FALSE, the sink will not signal the parent when it prerolls.
451 * Use this option when dealing with sparse streams or when synchronisation is
456 g_object_class_install_property (gobject_class, PROP_ASYNC,
457 g_param_spec_boolean ("async", "Async",
458 "Go asynchronously to PAUSED", DEFAULT_ASYNC,
459 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
461 * GstBaseSink:ts-offset
463 * Controls the final synchronisation, a negative value will render the buffer
464 * earlier while a positive value delays playback. This property can be
465 * used to fix synchronisation in bad files.
469 g_object_class_install_property (gobject_class, PROP_TS_OFFSET,
470 g_param_spec_int64 ("ts-offset", "TS Offset",
471 "Timestamp offset in nanoseconds", G_MININT64, G_MAXINT64,
472 DEFAULT_TS_OFFSET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
475 * GstBaseSink:enable-last-buffer
477 * Enable the last-buffer property. If FALSE, basesink doesn't keep a
478 * reference to the last buffer arrived and the last-buffer property is always
479 * set to NULL. This can be useful if you need buffers to be released as soon
480 * as possible, eg. if you're using a buffer pool.
484 g_object_class_install_property (gobject_class, PROP_ENABLE_LAST_BUFFER,
485 g_param_spec_boolean ("enable-last-buffer", "Enable Last Buffer",
486 "Enable the last-buffer property", DEFAULT_ENABLE_LAST_BUFFER,
487 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
490 * GstBaseSink:last-buffer
492 * The last buffer that arrived in the sink and was used for preroll or for
493 * rendering. This property can be used to generate thumbnails. This property
494 * can be NULL when the sink has not yet received a bufer.
498 g_object_class_install_property (gobject_class, PROP_LAST_BUFFER,
499 g_param_spec_boxed ("last-buffer", "Last Buffer",
500 "The last buffer received in the sink", GST_TYPE_BUFFER,
501 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
503 * GstBaseSink:blocksize
505 * The amount of bytes to pull when operating in pull mode.
509 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
510 g_object_class_install_property (gobject_class, PROP_BLOCKSIZE,
511 g_param_spec_uint ("blocksize", "Block size",
512 "Size in bytes to pull per buffer (0 = default)", 0, G_MAXUINT,
513 DEFAULT_BLOCKSIZE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
515 * GstBaseSink:render-delay
517 * The additional delay between synchronisation and actual rendering of the
518 * media. This property will add additional latency to the device in order to
519 * make other sinks compensate for the delay.
523 g_object_class_install_property (gobject_class, PROP_RENDER_DELAY,
524 g_param_spec_uint64 ("render-delay", "Render Delay",
525 "Additional render delay of the sink in nanoseconds", 0, G_MAXUINT64,
526 DEFAULT_RENDER_DELAY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
528 * GstBaseSink:throttle-time
530 * The time to insert between buffers. This property can be used to control
531 * the maximum amount of buffers per second to render. Setting this property
532 * to a value bigger than 0 will make the sink create THROTTLE QoS events.
536 g_object_class_install_property (gobject_class, PROP_THROTTLE_TIME,
537 g_param_spec_uint64 ("throttle-time", "Throttle time",
538 "The time to keep between rendered buffers (unused)", 0, G_MAXUINT64,
539 DEFAULT_THROTTLE_TIME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
541 gstelement_class->change_state =
542 GST_DEBUG_FUNCPTR (gst_base_sink_change_state);
543 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_base_sink_send_event);
544 gstelement_class->query = GST_DEBUG_FUNCPTR (gst_base_sink_query);
545 gstelement_class->get_query_types =
546 GST_DEBUG_FUNCPTR (gst_base_sink_get_query_types);
548 klass->get_caps = GST_DEBUG_FUNCPTR (gst_base_sink_get_caps);
549 klass->set_caps = GST_DEBUG_FUNCPTR (gst_base_sink_set_caps);
550 klass->get_times = GST_DEBUG_FUNCPTR (gst_base_sink_get_times);
551 klass->activate_pull =
552 GST_DEBUG_FUNCPTR (gst_base_sink_default_activate_pull);
554 /* Registering debug symbols for function pointers */
555 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_getcaps);
556 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_setcaps);
557 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_fixate);
558 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate);
559 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate_push);
560 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate_pull);
561 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_event);
562 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain);
563 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain_list);
567 gst_base_sink_pad_getcaps (GstPad * pad)
569 GstBaseSinkClass *bclass;
571 GstCaps *caps = NULL;
573 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
574 bclass = GST_BASE_SINK_GET_CLASS (bsink);
576 if (bsink->pad_mode == GST_ACTIVATE_PULL) {
577 /* if we are operating in pull mode we only accept the negotiated caps */
578 GST_OBJECT_LOCK (pad);
579 if ((caps = GST_PAD_CAPS (pad)))
581 GST_OBJECT_UNLOCK (pad);
584 if (bclass->get_caps)
585 caps = bclass->get_caps (bsink);
588 GstPadTemplate *pad_template;
591 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass),
593 if (pad_template != NULL) {
594 caps = gst_caps_ref (gst_pad_template_get_caps (pad_template));
598 gst_object_unref (bsink);
604 gst_base_sink_pad_setcaps (GstPad * pad, GstCaps * caps)
606 GstBaseSinkClass *bclass;
610 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
611 bclass = GST_BASE_SINK_GET_CLASS (bsink);
613 if (res && bclass->set_caps)
614 res = bclass->set_caps (bsink, caps);
616 gst_object_unref (bsink);
622 gst_base_sink_pad_fixate (GstPad * pad, GstCaps * caps)
624 GstBaseSinkClass *bclass;
627 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
628 bclass = GST_BASE_SINK_GET_CLASS (bsink);
631 bclass->fixate (bsink, caps);
633 gst_object_unref (bsink);
637 gst_base_sink_init (GstBaseSink * basesink, gpointer g_class)
639 GstPadTemplate *pad_template;
640 GstBaseSinkPrivate *priv;
642 basesink->priv = priv = GST_BASE_SINK_GET_PRIVATE (basesink);
645 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "sink");
646 g_return_if_fail (pad_template != NULL);
648 basesink->sinkpad = gst_pad_new_from_template (pad_template, "sink");
650 gst_pad_set_getcaps_function (basesink->sinkpad, gst_base_sink_pad_getcaps);
651 gst_pad_set_setcaps_function (basesink->sinkpad, gst_base_sink_pad_setcaps);
652 gst_pad_set_fixatecaps_function (basesink->sinkpad, gst_base_sink_pad_fixate);
653 gst_pad_set_activate_function (basesink->sinkpad, gst_base_sink_pad_activate);
654 gst_pad_set_activatepush_function (basesink->sinkpad,
655 gst_base_sink_pad_activate_push);
656 gst_pad_set_activatepull_function (basesink->sinkpad,
657 gst_base_sink_pad_activate_pull);
658 gst_pad_set_event_function (basesink->sinkpad, gst_base_sink_event);
659 gst_pad_set_chain_function (basesink->sinkpad, gst_base_sink_chain);
660 gst_pad_set_chain_list_function (basesink->sinkpad, gst_base_sink_chain_list);
661 gst_element_add_pad (GST_ELEMENT_CAST (basesink), basesink->sinkpad);
663 basesink->pad_mode = GST_ACTIVATE_NONE;
664 basesink->preroll_lock = g_mutex_new ();
665 basesink->preroll_cond = g_cond_new ();
666 basesink->preroll_queue = g_queue_new ();
667 basesink->clip_segment = gst_segment_new ();
668 priv->have_latency = FALSE;
670 basesink->can_activate_push = DEFAULT_CAN_ACTIVATE_PUSH;
671 basesink->can_activate_pull = DEFAULT_CAN_ACTIVATE_PULL;
673 basesink->sync = DEFAULT_SYNC;
674 basesink->max_lateness = DEFAULT_MAX_LATENESS;
675 g_atomic_int_set (&priv->qos_enabled, DEFAULT_QOS);
676 priv->async_enabled = DEFAULT_ASYNC;
677 priv->ts_offset = DEFAULT_TS_OFFSET;
678 priv->render_delay = DEFAULT_RENDER_DELAY;
679 priv->blocksize = DEFAULT_BLOCKSIZE;
680 priv->cached_clock_id = NULL;
681 g_atomic_int_set (&priv->enable_last_buffer, DEFAULT_ENABLE_LAST_BUFFER);
682 priv->throttle_time = DEFAULT_THROTTLE_TIME;
684 GST_OBJECT_FLAG_SET (basesink, GST_ELEMENT_IS_SINK);
688 gst_base_sink_finalize (GObject * object)
690 GstBaseSink *basesink;
692 basesink = GST_BASE_SINK (object);
694 g_mutex_free (basesink->preroll_lock);
695 g_cond_free (basesink->preroll_cond);
696 g_queue_free (basesink->preroll_queue);
697 gst_segment_free (basesink->clip_segment);
699 G_OBJECT_CLASS (parent_class)->finalize (object);
703 * gst_base_sink_set_sync:
705 * @sync: the new sync value.
707 * Configures @sink to synchronize on the clock or not. When
708 * @sync is FALSE, incomming samples will be played as fast as
709 * possible. If @sync is TRUE, the timestamps of the incomming
710 * buffers will be used to schedule the exact render time of its
716 gst_base_sink_set_sync (GstBaseSink * sink, gboolean sync)
718 g_return_if_fail (GST_IS_BASE_SINK (sink));
720 GST_OBJECT_LOCK (sink);
722 GST_OBJECT_UNLOCK (sink);
726 * gst_base_sink_get_sync:
729 * Checks if @sink is currently configured to synchronize against the
732 * Returns: TRUE if the sink is configured to synchronize against the clock.
737 gst_base_sink_get_sync (GstBaseSink * sink)
741 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
743 GST_OBJECT_LOCK (sink);
745 GST_OBJECT_UNLOCK (sink);
751 * gst_base_sink_set_max_lateness:
753 * @max_lateness: the new max lateness value.
755 * Sets the new max lateness value to @max_lateness. This value is
756 * used to decide if a buffer should be dropped or not based on the
757 * buffer timestamp and the current clock time. A value of -1 means
763 gst_base_sink_set_max_lateness (GstBaseSink * sink, gint64 max_lateness)
765 g_return_if_fail (GST_IS_BASE_SINK (sink));
767 GST_OBJECT_LOCK (sink);
768 sink->max_lateness = max_lateness;
769 GST_OBJECT_UNLOCK (sink);
773 * gst_base_sink_get_max_lateness:
776 * Gets the max lateness value. See gst_base_sink_set_max_lateness for
779 * Returns: The maximum time in nanoseconds that a buffer can be late
780 * before it is dropped and not rendered. A value of -1 means an
786 gst_base_sink_get_max_lateness (GstBaseSink * sink)
790 g_return_val_if_fail (GST_IS_BASE_SINK (sink), -1);
792 GST_OBJECT_LOCK (sink);
793 res = sink->max_lateness;
794 GST_OBJECT_UNLOCK (sink);
800 * gst_base_sink_set_qos_enabled:
802 * @enabled: the new qos value.
804 * Configures @sink to send Quality-of-Service events upstream.
809 gst_base_sink_set_qos_enabled (GstBaseSink * sink, gboolean enabled)
811 g_return_if_fail (GST_IS_BASE_SINK (sink));
813 g_atomic_int_set (&sink->priv->qos_enabled, enabled);
817 * gst_base_sink_is_qos_enabled:
820 * Checks if @sink is currently configured to send Quality-of-Service events
823 * Returns: TRUE if the sink is configured to perform Quality-of-Service.
828 gst_base_sink_is_qos_enabled (GstBaseSink * sink)
832 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
834 res = g_atomic_int_get (&sink->priv->qos_enabled);
840 * gst_base_sink_set_async_enabled:
842 * @enabled: the new async value.
844 * Configures @sink to perform all state changes asynchronusly. When async is
845 * disabled, the sink will immediatly go to PAUSED instead of waiting for a
846 * preroll buffer. This feature is usefull if the sink does not synchronize
847 * against the clock or when it is dealing with sparse streams.
852 gst_base_sink_set_async_enabled (GstBaseSink * sink, gboolean enabled)
854 g_return_if_fail (GST_IS_BASE_SINK (sink));
856 GST_BASE_SINK_PREROLL_LOCK (sink);
857 g_atomic_int_set (&sink->priv->async_enabled, enabled);
858 GST_LOG_OBJECT (sink, "set async enabled to %d", enabled);
859 GST_BASE_SINK_PREROLL_UNLOCK (sink);
863 * gst_base_sink_is_async_enabled:
866 * Checks if @sink is currently configured to perform asynchronous state
869 * Returns: TRUE if the sink is configured to perform asynchronous state
875 gst_base_sink_is_async_enabled (GstBaseSink * sink)
879 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
881 res = g_atomic_int_get (&sink->priv->async_enabled);
887 * gst_base_sink_set_ts_offset:
889 * @offset: the new offset
891 * Adjust the synchronisation of @sink with @offset. A negative value will
892 * render buffers earlier than their timestamp. A positive value will delay
893 * rendering. This function can be used to fix playback of badly timestamped
899 gst_base_sink_set_ts_offset (GstBaseSink * sink, GstClockTimeDiff offset)
901 g_return_if_fail (GST_IS_BASE_SINK (sink));
903 GST_OBJECT_LOCK (sink);
904 sink->priv->ts_offset = offset;
905 GST_LOG_OBJECT (sink, "set time offset to %" G_GINT64_FORMAT, offset);
906 GST_OBJECT_UNLOCK (sink);
910 * gst_base_sink_get_ts_offset:
913 * Get the synchronisation offset of @sink.
915 * Returns: The synchronisation offset.
920 gst_base_sink_get_ts_offset (GstBaseSink * sink)
922 GstClockTimeDiff res;
924 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
926 GST_OBJECT_LOCK (sink);
927 res = sink->priv->ts_offset;
928 GST_OBJECT_UNLOCK (sink);
934 * gst_base_sink_get_last_buffer:
937 * Get the last buffer that arrived in the sink and was used for preroll or for
938 * rendering. This property can be used to generate thumbnails.
940 * The #GstCaps on the buffer can be used to determine the type of the buffer.
942 * Free-function: gst_buffer_unref
944 * Returns: (transfer full): a #GstBuffer. gst_buffer_unref() after usage.
945 * This function returns NULL when no buffer has arrived in the sink yet
946 * or when the sink is not in PAUSED or PLAYING.
951 gst_base_sink_get_last_buffer (GstBaseSink * sink)
955 g_return_val_if_fail (GST_IS_BASE_SINK (sink), NULL);
957 GST_OBJECT_LOCK (sink);
958 if ((res = sink->priv->last_buffer))
959 gst_buffer_ref (res);
960 GST_OBJECT_UNLOCK (sink);
965 /* with OBJECT_LOCK */
967 gst_base_sink_set_last_buffer_unlocked (GstBaseSink * sink, GstBuffer * buffer)
971 old = sink->priv->last_buffer;
972 if (G_LIKELY (old != buffer)) {
973 GST_DEBUG_OBJECT (sink, "setting last buffer to %p", buffer);
974 if (G_LIKELY (buffer))
975 gst_buffer_ref (buffer);
976 sink->priv->last_buffer = buffer;
980 /* avoid unreffing with the lock because cleanup code might want to take the
982 if (G_LIKELY (old)) {
983 GST_OBJECT_UNLOCK (sink);
984 gst_buffer_unref (old);
985 GST_OBJECT_LOCK (sink);
990 gst_base_sink_set_last_buffer (GstBaseSink * sink, GstBuffer * buffer)
992 if (!g_atomic_int_get (&sink->priv->enable_last_buffer))
995 GST_OBJECT_LOCK (sink);
996 gst_base_sink_set_last_buffer_unlocked (sink, buffer);
997 GST_OBJECT_UNLOCK (sink);
1001 * gst_base_sink_set_last_buffer_enabled:
1003 * @enabled: the new enable-last-buffer value.
1005 * Configures @sink to store the last received buffer in the last-buffer
1011 gst_base_sink_set_last_buffer_enabled (GstBaseSink * sink, gboolean enabled)
1013 g_return_if_fail (GST_IS_BASE_SINK (sink));
1015 /* Only take lock if we change the value */
1016 if (g_atomic_int_compare_and_exchange (&sink->priv->enable_last_buffer,
1017 !enabled, enabled) && !enabled) {
1018 GST_OBJECT_LOCK (sink);
1019 gst_base_sink_set_last_buffer_unlocked (sink, NULL);
1020 GST_OBJECT_UNLOCK (sink);
1025 * gst_base_sink_is_last_buffer_enabled:
1028 * Checks if @sink is currently configured to store the last received buffer in
1029 * the last-buffer property.
1031 * Returns: TRUE if the sink is configured to store the last received buffer.
1036 gst_base_sink_is_last_buffer_enabled (GstBaseSink * sink)
1038 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
1040 return g_atomic_int_get (&sink->priv->enable_last_buffer);
1044 * gst_base_sink_get_latency:
1047 * Get the currently configured latency.
1049 * Returns: The configured latency.
1054 gst_base_sink_get_latency (GstBaseSink * sink)
1058 GST_OBJECT_LOCK (sink);
1059 res = sink->priv->latency;
1060 GST_OBJECT_UNLOCK (sink);
1066 * gst_base_sink_query_latency:
1068 * @live: (out) (allow-none): if the sink is live
1069 * @upstream_live: (out) (allow-none): if an upstream element is live
1070 * @min_latency: (out) (allow-none): the min latency of the upstream elements
1071 * @max_latency: (out) (allow-none): the max latency of the upstream elements
1073 * Query the sink for the latency parameters. The latency will be queried from
1074 * the upstream elements. @live will be TRUE if @sink is configured to
1075 * synchronize against the clock. @upstream_live will be TRUE if an upstream
1078 * If both @live and @upstream_live are TRUE, the sink will want to compensate
1079 * for the latency introduced by the upstream elements by setting the
1080 * @min_latency to a strictly possitive value.
1082 * This function is mostly used by subclasses.
1084 * Returns: TRUE if the query succeeded.
1089 gst_base_sink_query_latency (GstBaseSink * sink, gboolean * live,
1090 gboolean * upstream_live, GstClockTime * min_latency,
1091 GstClockTime * max_latency)
1093 gboolean l, us_live, res, have_latency;
1094 GstClockTime min, max, render_delay;
1096 GstClockTime us_min, us_max;
1098 /* we are live when we sync to the clock */
1099 GST_OBJECT_LOCK (sink);
1101 have_latency = sink->priv->have_latency;
1102 render_delay = sink->priv->render_delay;
1103 GST_OBJECT_UNLOCK (sink);
1105 /* assume no latency */
1111 GST_DEBUG_OBJECT (sink, "we are ready for LATENCY query");
1112 /* we are ready for a latency query this is when we preroll or when we are
1114 query = gst_query_new_latency ();
1116 /* ask the peer for the latency */
1117 if ((res = gst_pad_peer_query (sink->sinkpad, query))) {
1118 /* get upstream min and max latency */
1119 gst_query_parse_latency (query, &us_live, &us_min, &us_max);
1122 /* upstream live, use its latency, subclasses should use these
1123 * values to create the complete latency. */
1128 /* we need to add the render delay if we are live */
1130 min += render_delay;
1132 max += render_delay;
1135 gst_query_unref (query);
1137 GST_DEBUG_OBJECT (sink, "we are not yet ready for LATENCY query");
1141 /* not live, we tried to do the query, if it failed we return TRUE anyway */
1145 GST_DEBUG_OBJECT (sink, "latency query failed but we are not live");
1147 GST_DEBUG_OBJECT (sink, "latency query failed and we are live");
1152 GST_DEBUG_OBJECT (sink, "latency query: live: %d, have_latency %d,"
1153 " upstream: %d, min %" GST_TIME_FORMAT ", max %" GST_TIME_FORMAT, l,
1154 have_latency, us_live, GST_TIME_ARGS (min), GST_TIME_ARGS (max));
1159 *upstream_live = us_live;
1169 * gst_base_sink_set_render_delay:
1170 * @sink: a #GstBaseSink
1171 * @delay: the new delay
1173 * Set the render delay in @sink to @delay. The render delay is the time
1174 * between actual rendering of a buffer and its synchronisation time. Some
1175 * devices might delay media rendering which can be compensated for with this
1178 * After calling this function, this sink will report additional latency and
1179 * other sinks will adjust their latency to delay the rendering of their media.
1181 * This function is usually called by subclasses.
1186 gst_base_sink_set_render_delay (GstBaseSink * sink, GstClockTime delay)
1188 GstClockTime old_render_delay;
1190 g_return_if_fail (GST_IS_BASE_SINK (sink));
1192 GST_OBJECT_LOCK (sink);
1193 old_render_delay = sink->priv->render_delay;
1194 sink->priv->render_delay = delay;
1195 GST_LOG_OBJECT (sink, "set render delay to %" GST_TIME_FORMAT,
1196 GST_TIME_ARGS (delay));
1197 GST_OBJECT_UNLOCK (sink);
1199 if (delay != old_render_delay) {
1200 GST_DEBUG_OBJECT (sink, "posting latency changed");
1201 gst_element_post_message (GST_ELEMENT_CAST (sink),
1202 gst_message_new_latency (GST_OBJECT_CAST (sink)));
1207 * gst_base_sink_get_render_delay:
1208 * @sink: a #GstBaseSink
1210 * Get the render delay of @sink. see gst_base_sink_set_render_delay() for more
1211 * information about the render delay.
1213 * Returns: the render delay of @sink.
1218 gst_base_sink_get_render_delay (GstBaseSink * sink)
1220 GstClockTimeDiff res;
1222 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1224 GST_OBJECT_LOCK (sink);
1225 res = sink->priv->render_delay;
1226 GST_OBJECT_UNLOCK (sink);
1232 * gst_base_sink_set_blocksize:
1233 * @sink: a #GstBaseSink
1234 * @blocksize: the blocksize in bytes
1236 * Set the number of bytes that the sink will pull when it is operating in pull
1241 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
1243 gst_base_sink_set_blocksize (GstBaseSink * sink, guint blocksize)
1245 g_return_if_fail (GST_IS_BASE_SINK (sink));
1247 GST_OBJECT_LOCK (sink);
1248 sink->priv->blocksize = blocksize;
1249 GST_LOG_OBJECT (sink, "set blocksize to %u", blocksize);
1250 GST_OBJECT_UNLOCK (sink);
1254 * gst_base_sink_get_blocksize:
1255 * @sink: a #GstBaseSink
1257 * Get the number of bytes that the sink will pull when it is operating in pull
1260 * Returns: the number of bytes @sink will pull in pull mode.
1264 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
1266 gst_base_sink_get_blocksize (GstBaseSink * sink)
1270 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1272 GST_OBJECT_LOCK (sink);
1273 res = sink->priv->blocksize;
1274 GST_OBJECT_UNLOCK (sink);
1280 * gst_base_sink_set_throttle_time:
1281 * @sink: a #GstBaseSink
1282 * @throttle: the throttle time in nanoseconds
1284 * Set the time that will be inserted between rendered buffers. This
1285 * can be used to control the maximum buffers per second that the sink
1291 gst_base_sink_set_throttle_time (GstBaseSink * sink, guint64 throttle)
1293 g_return_if_fail (GST_IS_BASE_SINK (sink));
1295 GST_OBJECT_LOCK (sink);
1296 sink->priv->throttle_time = throttle;
1297 GST_LOG_OBJECT (sink, "set throttle_time to %" G_GUINT64_FORMAT, throttle);
1298 GST_OBJECT_UNLOCK (sink);
1302 * gst_base_sink_get_throttle_time:
1303 * @sink: a #GstBaseSink
1305 * Get the time that will be inserted between frames to control the
1306 * maximum buffers per second.
1308 * Returns: the number of nanoseconds @sink will put between frames.
1313 gst_base_sink_get_throttle_time (GstBaseSink * sink)
1317 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1319 GST_OBJECT_LOCK (sink);
1320 res = sink->priv->throttle_time;
1321 GST_OBJECT_UNLOCK (sink);
1327 gst_base_sink_set_property (GObject * object, guint prop_id,
1328 const GValue * value, GParamSpec * pspec)
1330 GstBaseSink *sink = GST_BASE_SINK (object);
1333 case PROP_PREROLL_QUEUE_LEN:
1334 /* preroll lock necessary to serialize with finish_preroll */
1335 GST_BASE_SINK_PREROLL_LOCK (sink);
1336 g_atomic_int_set (&sink->preroll_queue_max_len, g_value_get_uint (value));
1337 GST_BASE_SINK_PREROLL_UNLOCK (sink);
1340 gst_base_sink_set_sync (sink, g_value_get_boolean (value));
1342 case PROP_MAX_LATENESS:
1343 gst_base_sink_set_max_lateness (sink, g_value_get_int64 (value));
1346 gst_base_sink_set_qos_enabled (sink, g_value_get_boolean (value));
1349 gst_base_sink_set_async_enabled (sink, g_value_get_boolean (value));
1351 case PROP_TS_OFFSET:
1352 gst_base_sink_set_ts_offset (sink, g_value_get_int64 (value));
1354 case PROP_BLOCKSIZE:
1355 gst_base_sink_set_blocksize (sink, g_value_get_uint (value));
1357 case PROP_RENDER_DELAY:
1358 gst_base_sink_set_render_delay (sink, g_value_get_uint64 (value));
1360 case PROP_ENABLE_LAST_BUFFER:
1361 gst_base_sink_set_last_buffer_enabled (sink, g_value_get_boolean (value));
1363 case PROP_THROTTLE_TIME:
1364 gst_base_sink_set_throttle_time (sink, g_value_get_uint64 (value));
1367 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1373 gst_base_sink_get_property (GObject * object, guint prop_id, GValue * value,
1376 GstBaseSink *sink = GST_BASE_SINK (object);
1379 case PROP_PREROLL_QUEUE_LEN:
1380 g_value_set_uint (value, g_atomic_int_get (&sink->preroll_queue_max_len));
1383 g_value_set_boolean (value, gst_base_sink_get_sync (sink));
1385 case PROP_MAX_LATENESS:
1386 g_value_set_int64 (value, gst_base_sink_get_max_lateness (sink));
1389 g_value_set_boolean (value, gst_base_sink_is_qos_enabled (sink));
1392 g_value_set_boolean (value, gst_base_sink_is_async_enabled (sink));
1394 case PROP_TS_OFFSET:
1395 g_value_set_int64 (value, gst_base_sink_get_ts_offset (sink));
1397 case PROP_LAST_BUFFER:
1398 gst_value_take_buffer (value, gst_base_sink_get_last_buffer (sink));
1400 case PROP_ENABLE_LAST_BUFFER:
1401 g_value_set_boolean (value, gst_base_sink_is_last_buffer_enabled (sink));
1403 case PROP_BLOCKSIZE:
1404 g_value_set_uint (value, gst_base_sink_get_blocksize (sink));
1406 case PROP_RENDER_DELAY:
1407 g_value_set_uint64 (value, gst_base_sink_get_render_delay (sink));
1409 case PROP_THROTTLE_TIME:
1410 g_value_set_uint64 (value, gst_base_sink_get_throttle_time (sink));
1413 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1420 gst_base_sink_get_caps (GstBaseSink * sink)
1426 gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps)
1431 /* with PREROLL_LOCK, STREAM_LOCK */
1433 gst_base_sink_preroll_queue_flush (GstBaseSink * basesink, GstPad * pad)
1437 GST_DEBUG_OBJECT (basesink, "flushing queue %p", basesink);
1438 while ((obj = g_queue_pop_head (basesink->preroll_queue))) {
1439 GST_DEBUG_OBJECT (basesink, "popped %p", obj);
1440 gst_mini_object_unref (obj);
1442 /* we can't have EOS anymore now */
1443 basesink->eos = FALSE;
1444 basesink->priv->received_eos = FALSE;
1445 basesink->have_preroll = FALSE;
1446 basesink->priv->step_unlock = FALSE;
1447 basesink->eos_queued = FALSE;
1448 basesink->preroll_queued = 0;
1449 basesink->buffers_queued = 0;
1450 basesink->events_queued = 0;
1451 /* can't report latency anymore until we preroll again */
1452 if (basesink->priv->async_enabled) {
1453 GST_OBJECT_LOCK (basesink);
1454 basesink->priv->have_latency = FALSE;
1455 GST_OBJECT_UNLOCK (basesink);
1457 /* and signal any waiters now */
1458 GST_BASE_SINK_PREROLL_SIGNAL (basesink);
1461 /* with STREAM_LOCK, configures given segment with the event information. */
1463 gst_base_sink_configure_segment (GstBaseSink * basesink, GstPad * pad,
1464 GstEvent * event, GstSegment * segment)
1467 gdouble rate, arate;
1473 /* the newsegment event is needed to bring the buffer timestamps to the
1474 * stream time and to drop samples outside of the playback segment. */
1475 gst_event_parse_new_segment_full (event, &update, &rate, &arate, &format,
1476 &start, &stop, &time);
1478 /* The segment is protected with both the STREAM_LOCK and the OBJECT_LOCK.
1479 * We protect with the OBJECT_LOCK so that we can use the values to
1480 * safely answer a POSITION query. */
1481 GST_OBJECT_LOCK (basesink);
1482 gst_segment_set_newsegment_full (segment, update, rate, arate, format, start,
1485 if (format == GST_FORMAT_TIME) {
1486 GST_DEBUG_OBJECT (basesink,
1487 "configured NEWSEGMENT update %d, rate %lf, applied rate %lf, "
1488 "format GST_FORMAT_TIME, "
1489 "%" GST_TIME_FORMAT " -- %" GST_TIME_FORMAT
1490 ", time %" GST_TIME_FORMAT ", accum %" GST_TIME_FORMAT,
1491 update, rate, arate, GST_TIME_ARGS (segment->start),
1492 GST_TIME_ARGS (segment->stop), GST_TIME_ARGS (segment->time),
1493 GST_TIME_ARGS (segment->accum));
1495 GST_DEBUG_OBJECT (basesink,
1496 "configured NEWSEGMENT update %d, rate %lf, applied rate %lf, "
1498 "%" G_GINT64_FORMAT " -- %" G_GINT64_FORMAT ", time %"
1499 G_GINT64_FORMAT ", accum %" G_GINT64_FORMAT, update, rate, arate,
1500 segment->format, segment->start, segment->stop, segment->time,
1503 GST_OBJECT_UNLOCK (basesink);
1506 /* with PREROLL_LOCK, STREAM_LOCK */
1508 gst_base_sink_commit_state (GstBaseSink * basesink)
1510 /* commit state and proceed to next pending state */
1511 GstState current, next, pending, post_pending;
1512 gboolean post_paused = FALSE;
1513 gboolean post_async_done = FALSE;
1514 gboolean post_playing = FALSE;
1516 /* we are certainly not playing async anymore now */
1517 basesink->playing_async = FALSE;
1519 GST_OBJECT_LOCK (basesink);
1520 current = GST_STATE (basesink);
1521 next = GST_STATE_NEXT (basesink);
1522 pending = GST_STATE_PENDING (basesink);
1523 post_pending = pending;
1526 case GST_STATE_PLAYING:
1528 GstBaseSinkClass *bclass;
1530 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1532 GST_DEBUG_OBJECT (basesink, "commiting state to PLAYING");
1534 basesink->need_preroll = FALSE;
1535 post_async_done = TRUE;
1536 basesink->priv->commited = TRUE;
1537 post_playing = TRUE;
1538 /* post PAUSED too when we were READY */
1539 if (current == GST_STATE_READY) {
1544 case GST_STATE_PAUSED:
1545 GST_DEBUG_OBJECT (basesink, "commiting state to PAUSED");
1547 post_async_done = TRUE;
1548 basesink->priv->commited = TRUE;
1549 post_pending = GST_STATE_VOID_PENDING;
1551 case GST_STATE_READY:
1552 case GST_STATE_NULL:
1554 case GST_STATE_VOID_PENDING:
1555 goto nothing_pending;
1560 /* we can report latency queries now */
1561 basesink->priv->have_latency = TRUE;
1563 GST_STATE (basesink) = pending;
1564 GST_STATE_NEXT (basesink) = GST_STATE_VOID_PENDING;
1565 GST_STATE_PENDING (basesink) = GST_STATE_VOID_PENDING;
1566 GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_SUCCESS;
1567 GST_OBJECT_UNLOCK (basesink);
1570 GST_DEBUG_OBJECT (basesink, "posting PAUSED state change message");
1571 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1572 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1573 current, next, post_pending));
1575 if (post_async_done) {
1576 GST_DEBUG_OBJECT (basesink, "posting async-done message");
1577 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1578 gst_message_new_async_done (GST_OBJECT_CAST (basesink)));
1581 GST_DEBUG_OBJECT (basesink, "posting PLAYING state change message");
1582 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1583 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1584 next, pending, GST_STATE_VOID_PENDING));
1587 GST_STATE_BROADCAST (basesink);
1593 /* Depending on the state, set our vars. We get in this situation when the
1594 * state change function got a change to update the state vars before the
1595 * streaming thread did. This is fine but we need to make sure that we
1596 * update the need_preroll var since it was TRUE when we got here and might
1597 * become FALSE if we got to PLAYING. */
1598 GST_DEBUG_OBJECT (basesink, "nothing to commit, now in %s",
1599 gst_element_state_get_name (current));
1601 case GST_STATE_PLAYING:
1602 basesink->need_preroll = FALSE;
1604 case GST_STATE_PAUSED:
1605 basesink->need_preroll = TRUE;
1608 basesink->need_preroll = FALSE;
1609 basesink->flushing = TRUE;
1612 /* we can report latency queries now */
1613 basesink->priv->have_latency = TRUE;
1614 GST_OBJECT_UNLOCK (basesink);
1619 /* app is going to READY */
1620 GST_DEBUG_OBJECT (basesink, "stopping");
1621 basesink->need_preroll = FALSE;
1622 basesink->flushing = TRUE;
1623 GST_OBJECT_UNLOCK (basesink);
1629 start_stepping (GstBaseSink * sink, GstSegment * segment,
1630 GstStepInfo * pending, GstStepInfo * current)
1633 GstMessage *message;
1635 GST_DEBUG_OBJECT (sink, "update pending step");
1637 GST_OBJECT_LOCK (sink);
1638 memcpy (current, pending, sizeof (GstStepInfo));
1639 pending->valid = FALSE;
1640 GST_OBJECT_UNLOCK (sink);
1642 /* post message first */
1644 gst_message_new_step_start (GST_OBJECT (sink), TRUE, current->format,
1645 current->amount, current->rate, current->flush, current->intermediate);
1646 gst_message_set_seqnum (message, current->seqnum);
1647 gst_element_post_message (GST_ELEMENT (sink), message);
1649 /* get the running time of where we paused and remember it */
1650 current->start = gst_element_get_start_time (GST_ELEMENT_CAST (sink));
1651 gst_segment_set_running_time (segment, GST_FORMAT_TIME, current->start);
1653 /* set the new rate for the remainder of the segment */
1654 current->start_rate = segment->rate;
1655 segment->rate *= current->rate;
1656 segment->abs_rate = ABS (segment->rate);
1659 if (segment->rate > 0.0)
1660 current->start_stop = segment->stop;
1662 current->start_start = segment->start;
1664 if (current->format == GST_FORMAT_TIME) {
1665 end = current->start + current->amount;
1666 if (!current->flush) {
1667 /* update the segment clipping regions for non-flushing seeks */
1668 if (segment->rate > 0.0) {
1669 segment->stop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1670 segment->last_stop = segment->stop;
1674 position = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1675 segment->time = position;
1676 segment->start = position;
1677 segment->last_stop = position;
1682 GST_DEBUG_OBJECT (sink,
1683 "segment now rate %lf, applied rate %lf, "
1684 "format GST_FORMAT_TIME, "
1685 "%" GST_TIME_FORMAT " -- %" GST_TIME_FORMAT
1686 ", time %" GST_TIME_FORMAT ", accum %" GST_TIME_FORMAT,
1687 segment->rate, segment->applied_rate, GST_TIME_ARGS (segment->start),
1688 GST_TIME_ARGS (segment->stop), GST_TIME_ARGS (segment->time),
1689 GST_TIME_ARGS (segment->accum));
1691 GST_DEBUG_OBJECT (sink, "step started at running_time %" GST_TIME_FORMAT,
1692 GST_TIME_ARGS (current->start));
1694 if (current->amount == -1) {
1695 GST_DEBUG_OBJECT (sink, "step amount == -1, stop stepping");
1696 current->valid = FALSE;
1698 GST_DEBUG_OBJECT (sink, "step amount: %" G_GUINT64_FORMAT ", format: %s, "
1699 "rate: %f", current->amount, gst_format_get_name (current->format),
1705 stop_stepping (GstBaseSink * sink, GstSegment * segment,
1706 GstStepInfo * current, gint64 rstart, gint64 rstop, gboolean eos)
1708 gint64 stop, position;
1709 GstMessage *message;
1711 GST_DEBUG_OBJECT (sink, "step complete");
1713 if (segment->rate > 0.0)
1718 GST_DEBUG_OBJECT (sink,
1719 "step stop at running_time %" GST_TIME_FORMAT, GST_TIME_ARGS (stop));
1722 current->duration = current->position;
1724 current->duration = stop - current->start;
1726 GST_DEBUG_OBJECT (sink, "step elapsed running_time %" GST_TIME_FORMAT,
1727 GST_TIME_ARGS (current->duration));
1729 position = current->start + current->duration;
1731 /* now move the segment to the new running time */
1732 gst_segment_set_running_time (segment, GST_FORMAT_TIME, position);
1734 if (current->flush) {
1735 /* and remove the accumulated time we flushed, start time did not change */
1736 segment->accum = current->start;
1738 /* start time is now the stepped position */
1739 gst_element_set_start_time (GST_ELEMENT_CAST (sink), position);
1742 /* restore the previous rate */
1743 segment->rate = current->start_rate;
1744 segment->abs_rate = ABS (segment->rate);
1746 if (segment->rate > 0.0)
1747 segment->stop = current->start_stop;
1749 segment->start = current->start_start;
1751 /* the clip segment is used for position report in paused... */
1752 memcpy (sink->clip_segment, segment, sizeof (GstSegment));
1754 /* post the step done when we know the stepped duration in TIME */
1756 gst_message_new_step_done (GST_OBJECT_CAST (sink), current->format,
1757 current->amount, current->rate, current->flush, current->intermediate,
1758 current->duration, eos);
1759 gst_message_set_seqnum (message, current->seqnum);
1760 gst_element_post_message (GST_ELEMENT_CAST (sink), message);
1762 if (!current->intermediate)
1763 sink->need_preroll = current->need_preroll;
1765 /* and the current step info finished and becomes invalid */
1766 current->valid = FALSE;
1770 handle_stepping (GstBaseSink * sink, GstSegment * segment,
1771 GstStepInfo * current, gint64 * cstart, gint64 * cstop, gint64 * rstart,
1774 gboolean step_end = FALSE;
1776 /* see if we need to skip this buffer because of stepping */
1777 switch (current->format) {
1778 case GST_FORMAT_TIME:
1783 if (segment->rate > 0.0) {
1784 if (segment->stop == *cstop)
1785 *rstop = *rstart + current->amount;
1790 if (segment->start == *cstart)
1791 *rstart = *rstop + current->amount;
1797 end = current->start + current->amount;
1798 current->position = first - current->start;
1800 if (G_UNLIKELY (segment->abs_rate != 1.0))
1801 current->position /= segment->abs_rate;
1803 GST_DEBUG_OBJECT (sink,
1804 "buffer: %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT,
1805 GST_TIME_ARGS (first), GST_TIME_ARGS (last));
1806 GST_DEBUG_OBJECT (sink,
1807 "got time step %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT "/%"
1808 GST_TIME_FORMAT, GST_TIME_ARGS (current->position),
1809 GST_TIME_ARGS (last - current->start),
1810 GST_TIME_ARGS (current->amount));
1812 if ((current->flush && current->position >= current->amount)
1814 GST_DEBUG_OBJECT (sink, "step ended, we need clipping");
1816 if (segment->rate > 0.0) {
1818 *cstart = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1821 *cstop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1824 GST_DEBUG_OBJECT (sink,
1825 "cstart %" GST_TIME_FORMAT ", rstart %" GST_TIME_FORMAT,
1826 GST_TIME_ARGS (*cstart), GST_TIME_ARGS (*rstart));
1827 GST_DEBUG_OBJECT (sink,
1828 "cstop %" GST_TIME_FORMAT ", rstop %" GST_TIME_FORMAT,
1829 GST_TIME_ARGS (*cstop), GST_TIME_ARGS (*rstop));
1832 case GST_FORMAT_BUFFERS:
1833 GST_DEBUG_OBJECT (sink,
1834 "got default step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1835 current->position, current->amount);
1837 if (current->position < current->amount) {
1838 current->position++;
1843 case GST_FORMAT_DEFAULT:
1845 GST_DEBUG_OBJECT (sink,
1846 "got unknown step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1847 current->position, current->amount);
1853 /* with STREAM_LOCK, PREROLL_LOCK
1855 * Returns TRUE if the object needs synchronisation and takes therefore
1856 * part in prerolling.
1858 * rsstart/rsstop contain the start/stop in stream time.
1859 * rrstart/rrstop contain the start/stop in running time.
1862 gst_base_sink_get_sync_times (GstBaseSink * basesink, GstMiniObject * obj,
1863 GstClockTime * rsstart, GstClockTime * rsstop,
1864 GstClockTime * rrstart, GstClockTime * rrstop, gboolean * do_sync,
1865 gboolean * stepped, GstSegment * segment, GstStepInfo * step,
1866 gboolean * step_end, guint8 obj_type)
1868 GstBaseSinkClass *bclass;
1870 GstClockTime start, stop; /* raw start/stop timestamps */
1871 gint64 cstart, cstop; /* clipped raw timestamps */
1872 gint64 rstart, rstop; /* clipped timestamps converted to running time */
1873 GstClockTime sstart, sstop; /* clipped timestamps converted to stream time */
1875 GstBaseSinkPrivate *priv;
1878 priv = basesink->priv;
1880 /* start with nothing */
1881 start = stop = GST_CLOCK_TIME_NONE;
1883 if (G_UNLIKELY (OBJ_IS_EVENT (obj_type))) {
1884 GstEvent *event = GST_EVENT_CAST (obj);
1886 switch (GST_EVENT_TYPE (event)) {
1887 /* EOS event needs syncing */
1890 if (basesink->segment.rate >= 0.0) {
1891 sstart = sstop = priv->current_sstop;
1892 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1893 /* we have not seen a buffer yet, use the segment values */
1894 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1895 basesink->segment.format, basesink->segment.stop);
1898 sstart = sstop = priv->current_sstart;
1899 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1900 /* we have not seen a buffer yet, use the segment values */
1901 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1902 basesink->segment.format, basesink->segment.start);
1906 rstart = rstop = priv->eos_rtime;
1907 *do_sync = rstart != -1;
1908 GST_DEBUG_OBJECT (basesink, "sync times for EOS %" GST_TIME_FORMAT,
1909 GST_TIME_ARGS (rstart));
1910 /* if we are stepping, we end now */
1911 *step_end = step->valid;
1916 /* other events do not need syncing */
1917 /* FIXME, maybe NEWSEGMENT might need synchronisation
1918 * since the POSITION query depends on accumulated times and
1919 * we cannot accumulate the current segment before the previous
1929 /* else do buffer sync code */
1930 buffer = GST_BUFFER_CAST (obj);
1932 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1934 /* just get the times to see if we need syncing, if the start returns -1 we
1936 if (bclass->get_times)
1937 bclass->get_times (basesink, buffer, &start, &stop);
1939 if (!GST_CLOCK_TIME_IS_VALID (start)) {
1940 /* we don't need to sync but we still want to get the timestamps for
1941 * tracking the position */
1942 gst_base_sink_get_times (basesink, buffer, &start, &stop);
1948 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
1949 ", stop: %" GST_TIME_FORMAT ", do_sync %d", GST_TIME_ARGS (start),
1950 GST_TIME_ARGS (stop), *do_sync);
1952 /* collect segment and format for code clarity */
1953 format = segment->format;
1955 /* no timestamp clipping if we did not get a TIME segment format */
1956 if (G_UNLIKELY (format != GST_FORMAT_TIME)) {
1959 /* do running and stream time in TIME format */
1960 format = GST_FORMAT_TIME;
1961 GST_LOG_OBJECT (basesink, "not time format, don't clip");
1965 /* clip, only when we know about time */
1966 if (G_UNLIKELY (!gst_segment_clip (segment, GST_FORMAT_TIME,
1967 (gint64) start, (gint64) stop, &cstart, &cstop))) {
1969 GST_DEBUG_OBJECT (basesink, "step out of segment");
1970 /* when we are stepping, pretend we're at the end of the segment */
1971 if (segment->rate > 0.0) {
1972 cstart = segment->stop;
1973 cstop = segment->stop;
1975 cstart = segment->start;
1976 cstop = segment->start;
1980 goto out_of_segment;
1983 if (G_UNLIKELY (start != cstart || stop != cstop)) {
1984 GST_DEBUG_OBJECT (basesink, "clipped to: start %" GST_TIME_FORMAT
1985 ", stop: %" GST_TIME_FORMAT, GST_TIME_ARGS (cstart),
1986 GST_TIME_ARGS (cstop));
1989 /* set last stop position */
1990 if (G_LIKELY (stop != GST_CLOCK_TIME_NONE && cstop != GST_CLOCK_TIME_NONE))
1991 gst_segment_set_last_stop (segment, GST_FORMAT_TIME, cstop);
1993 gst_segment_set_last_stop (segment, GST_FORMAT_TIME, cstart);
1996 rstart = gst_segment_to_running_time (segment, format, cstart);
1997 rstop = gst_segment_to_running_time (segment, format, cstop);
1999 if (G_UNLIKELY (step->valid)) {
2000 if (!(*step_end = handle_stepping (basesink, segment, step, &cstart, &cstop,
2001 &rstart, &rstop))) {
2002 /* step is still busy, we discard data when we are flushing */
2003 *stepped = step->flush;
2004 GST_DEBUG_OBJECT (basesink, "stepping busy");
2007 /* this can produce wrong values if we accumulated non-TIME segments. If this happens,
2008 * upstream is behaving very badly */
2009 sstart = gst_segment_to_stream_time (segment, format, cstart);
2010 sstop = gst_segment_to_stream_time (segment, format, cstop);
2013 /* eos_done label only called when doing EOS, we also stop stepping then */
2014 if (*step_end && step->flush) {
2015 GST_DEBUG_OBJECT (basesink, "flushing step ended");
2016 stop_stepping (basesink, segment, step, rstart, rstop, eos);
2018 /* re-determine running start times for adjusted segment
2019 * (which has a flushed amount of running/accumulated time removed) */
2020 if (!GST_IS_EVENT (obj)) {
2021 GST_DEBUG_OBJECT (basesink, "refresh sync times");
2032 /* buffers and EOS always need syncing and preroll */
2038 /* we usually clip in the chain function already but stepping could cause
2039 * the segment to be updated later. we return FALSE so that we don't try
2041 GST_LOG_OBJECT (basesink, "buffer skipped, not in segment");
2046 /* with STREAM_LOCK, PREROLL_LOCK, LOCK
2047 * adjust a timestamp with the latency and timestamp offset. This function does
2048 * not adjust for the render delay. */
2050 gst_base_sink_adjust_time (GstBaseSink * basesink, GstClockTime time)
2052 GstClockTimeDiff ts_offset;
2054 /* don't do anything funny with invalid timestamps */
2055 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
2058 time += basesink->priv->latency;
2060 /* apply offset, be carefull for underflows */
2061 ts_offset = basesink->priv->ts_offset;
2062 if (ts_offset < 0) {
2063 ts_offset = -ts_offset;
2064 if (ts_offset < time)
2071 /* subtract the render delay again, which was included in the latency */
2072 if (time > basesink->priv->render_delay)
2073 time -= basesink->priv->render_delay;
2081 * gst_base_sink_wait_clock:
2083 * @time: the running_time to be reached
2084 * @jitter: (out) (allow-none): the jitter to be filled with time diff, or NULL
2086 * This function will block until @time is reached. It is usually called by
2087 * subclasses that use their own internal synchronisation.
2089 * If @time is not valid, no sycnhronisation is done and #GST_CLOCK_BADTIME is
2090 * returned. Likewise, if synchronisation is disabled in the element or there
2091 * is no clock, no synchronisation is done and #GST_CLOCK_BADTIME is returned.
2093 * This function should only be called with the PREROLL_LOCK held, like when
2094 * receiving an EOS event in the #GstBaseSinkClass.event() vmethod or when
2095 * receiving a buffer in
2096 * the #GstBaseSinkClass.render() vmethod.
2098 * The @time argument should be the running_time of when this method should
2099 * return and is not adjusted with any latency or offset configured in the
2104 * Returns: #GstClockReturn
2107 gst_base_sink_wait_clock (GstBaseSink * sink, GstClockTime time,
2108 GstClockTimeDiff * jitter)
2112 GstClockTime base_time;
2114 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
2117 GST_OBJECT_LOCK (sink);
2118 if (G_UNLIKELY (!sink->sync))
2121 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (sink)) == NULL))
2124 base_time = GST_ELEMENT_CAST (sink)->base_time;
2125 GST_LOG_OBJECT (sink,
2126 "time %" GST_TIME_FORMAT ", base_time %" GST_TIME_FORMAT,
2127 GST_TIME_ARGS (time), GST_TIME_ARGS (base_time));
2129 /* add base_time to running_time to get the time against the clock */
2132 /* Re-use existing clockid if available */
2133 if (G_LIKELY (sink->priv->cached_clock_id != NULL)) {
2134 if (!gst_clock_single_shot_id_reinit (clock, sink->priv->cached_clock_id,
2136 gst_clock_id_unref (sink->priv->cached_clock_id);
2137 sink->priv->cached_clock_id = gst_clock_new_single_shot_id (clock, time);
2140 sink->priv->cached_clock_id = gst_clock_new_single_shot_id (clock, time);
2141 GST_OBJECT_UNLOCK (sink);
2143 /* A blocking wait is performed on the clock. We save the ClockID
2144 * so we can unlock the entry at any time. While we are blocking, we
2145 * release the PREROLL_LOCK so that other threads can interrupt the
2147 sink->clock_id = sink->priv->cached_clock_id;
2148 /* release the preroll lock while waiting */
2149 GST_BASE_SINK_PREROLL_UNLOCK (sink);
2151 ret = gst_clock_id_wait (sink->priv->cached_clock_id, jitter);
2153 GST_BASE_SINK_PREROLL_LOCK (sink);
2154 sink->clock_id = NULL;
2158 /* no syncing needed */
2161 GST_DEBUG_OBJECT (sink, "time not valid, no sync needed");
2162 return GST_CLOCK_BADTIME;
2166 GST_DEBUG_OBJECT (sink, "sync disabled");
2167 GST_OBJECT_UNLOCK (sink);
2168 return GST_CLOCK_BADTIME;
2172 GST_DEBUG_OBJECT (sink, "no clock, can't sync");
2173 GST_OBJECT_UNLOCK (sink);
2174 return GST_CLOCK_BADTIME;
2179 * gst_base_sink_wait_preroll:
2182 * If the #GstBaseSinkClass.render() method performs its own synchronisation
2183 * against the clock it must unblock when going from PLAYING to the PAUSED state
2184 * and call this method before continuing to render the remaining data.
2186 * This function will block until a state change to PLAYING happens (in which
2187 * case this function returns #GST_FLOW_OK) or the processing must be stopped due
2188 * to a state change to READY or a FLUSH event (in which case this function
2189 * returns #GST_FLOW_WRONG_STATE).
2191 * This function should only be called with the PREROLL_LOCK held, like in the
2194 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2195 * continue. Any other return value should be returned from the render vmethod.
2200 gst_base_sink_wait_preroll (GstBaseSink * sink)
2202 sink->have_preroll = TRUE;
2203 GST_DEBUG_OBJECT (sink, "waiting in preroll for flush or PLAYING");
2204 /* block until the state changes, or we get a flush, or something */
2205 GST_BASE_SINK_PREROLL_WAIT (sink);
2206 sink->have_preroll = FALSE;
2207 if (G_UNLIKELY (sink->flushing))
2209 if (G_UNLIKELY (sink->priv->step_unlock))
2211 GST_DEBUG_OBJECT (sink, "continue after preroll");
2218 GST_DEBUG_OBJECT (sink, "preroll interrupted because of flush");
2219 return GST_FLOW_WRONG_STATE;
2223 sink->priv->step_unlock = FALSE;
2224 GST_DEBUG_OBJECT (sink, "preroll interrupted because of step");
2225 return GST_FLOW_STEP;
2229 static inline guint8
2230 get_object_type (GstMiniObject * obj)
2234 if (G_LIKELY (GST_IS_BUFFER (obj)))
2235 obj_type = _PR_IS_BUFFER;
2236 else if (GST_IS_EVENT (obj))
2237 obj_type = _PR_IS_EVENT;
2238 else if (GST_IS_BUFFER_LIST (obj))
2239 obj_type = _PR_IS_BUFFERLIST;
2241 obj_type = _PR_IS_NOTHING;
2247 * gst_base_sink_do_preroll:
2249 * @obj: (transfer none): the mini object that caused the preroll
2251 * If the @sink spawns its own thread for pulling buffers from upstream it
2252 * should call this method after it has pulled a buffer. If the element needed
2253 * to preroll, this function will perform the preroll and will then block
2254 * until the element state is changed.
2256 * This function should be called with the PREROLL_LOCK held.
2258 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2259 * continue. Any other return value should be returned from the render vmethod.
2264 gst_base_sink_do_preroll (GstBaseSink * sink, GstMiniObject * obj)
2268 while (G_UNLIKELY (sink->need_preroll)) {
2270 GST_DEBUG_OBJECT (sink, "prerolling object %p", obj);
2272 obj_type = get_object_type (obj);
2274 ret = gst_base_sink_preroll_object (sink, obj_type, obj);
2275 if (ret != GST_FLOW_OK)
2276 goto preroll_failed;
2278 /* need to recheck here because the commit state could have
2279 * made us not need the preroll anymore */
2280 if (G_LIKELY (sink->need_preroll)) {
2281 /* block until the state changes, or we get a flush, or something */
2282 ret = gst_base_sink_wait_preroll (sink);
2283 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2284 goto preroll_failed;
2292 GST_DEBUG_OBJECT (sink, "preroll failed: %s", gst_flow_get_name (ret));
2298 * gst_base_sink_wait_eos:
2300 * @time: the running_time to be reached
2301 * @jitter: (out) (allow-none): the jitter to be filled with time diff, or NULL
2303 * This function will block until @time is reached. It is usually called by
2304 * subclasses that use their own internal synchronisation but want to let the
2305 * EOS be handled by the base class.
2307 * This function should only be called with the PREROLL_LOCK held, like when
2308 * receiving an EOS event in the ::event vmethod.
2310 * The @time argument should be the running_time of when the EOS should happen
2311 * and will be adjusted with any latency and offset configured in the sink.
2313 * Returns: #GstFlowReturn
2318 gst_base_sink_wait_eos (GstBaseSink * sink, GstClockTime time,
2319 GstClockTimeDiff * jitter)
2321 GstClockReturn status;
2327 GST_DEBUG_OBJECT (sink, "checking preroll");
2329 /* first wait for the playing state before we can continue */
2330 while (G_UNLIKELY (sink->need_preroll)) {
2331 ret = gst_base_sink_wait_preroll (sink);
2332 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2336 /* preroll done, we can sync since we are in PLAYING now. */
2337 GST_DEBUG_OBJECT (sink, "possibly waiting for clock to reach %"
2338 GST_TIME_FORMAT, GST_TIME_ARGS (time));
2340 /* compensate for latency and ts_offset. We don't adjust for render delay
2341 * because we don't interact with the device on EOS normally. */
2342 stime = gst_base_sink_adjust_time (sink, time);
2344 /* wait for the clock, this can be interrupted because we got shut down or
2346 status = gst_base_sink_wait_clock (sink, stime, jitter);
2348 GST_DEBUG_OBJECT (sink, "clock returned %d", status);
2350 /* invalid time, no clock or sync disabled, just continue then */
2351 if (status == GST_CLOCK_BADTIME)
2354 /* waiting could have been interrupted and we can be flushing now */
2355 if (G_UNLIKELY (sink->flushing))
2358 /* retry if we got unscheduled, which means we did not reach the timeout
2359 * yet. if some other error occures, we continue. */
2360 } while (status == GST_CLOCK_UNSCHEDULED);
2362 GST_DEBUG_OBJECT (sink, "end of stream");
2369 GST_DEBUG_OBJECT (sink, "we are flushing");
2370 return GST_FLOW_WRONG_STATE;
2374 /* with STREAM_LOCK, PREROLL_LOCK
2376 * Make sure we are in PLAYING and synchronize an object to the clock.
2378 * If we need preroll, we are not in PLAYING. We try to commit the state
2379 * if needed and then block if we still are not PLAYING.
2381 * We start waiting on the clock in PLAYING. If we got interrupted, we
2382 * immediatly try to re-preroll.
2384 * Some objects do not need synchronisation (most events) and so this function
2385 * immediatly returns GST_FLOW_OK.
2387 * for objects that arrive later than max-lateness to be synchronized to the
2388 * clock have the @late boolean set to TRUE.
2390 * This function keeps a running average of the jitter (the diff between the
2391 * clock time and the requested sync time). The jitter is negative for
2392 * objects that arrive in time and positive for late buffers.
2394 * does not take ownership of obj.
2396 static GstFlowReturn
2397 gst_base_sink_do_sync (GstBaseSink * basesink, GstPad * pad,
2398 GstMiniObject * obj, gboolean * late, gboolean * step_end, guint8 obj_type)
2400 GstClockTimeDiff jitter = 0;
2402 GstClockReturn status = GST_CLOCK_OK;
2403 GstClockTime rstart, rstop, sstart, sstop, stime;
2405 GstBaseSinkPrivate *priv;
2407 GstStepInfo *current, *pending;
2410 priv = basesink->priv;
2413 sstart = sstop = rstart = rstop = GST_CLOCK_TIME_NONE;
2417 priv->current_rstart = GST_CLOCK_TIME_NONE;
2419 /* get stepping info */
2420 current = &priv->current_step;
2421 pending = &priv->pending_step;
2423 /* get timing information for this object against the render segment */
2424 syncable = gst_base_sink_get_sync_times (basesink, obj,
2425 &sstart, &sstop, &rstart, &rstop, &do_sync, &stepped, &basesink->segment,
2426 current, step_end, obj_type);
2428 if (G_UNLIKELY (stepped))
2431 /* a syncable object needs to participate in preroll and
2432 * clocking. All buffers and EOS are syncable. */
2433 if (G_UNLIKELY (!syncable))
2436 /* store timing info for current object */
2437 priv->current_rstart = rstart;
2438 priv->current_rstop = (GST_CLOCK_TIME_IS_VALID (rstop) ? rstop : rstart);
2440 /* save sync time for eos when the previous object needed sync */
2441 priv->eos_rtime = (do_sync ? priv->current_rstop : GST_CLOCK_TIME_NONE);
2443 /* calculate inter frame spacing */
2444 if (G_UNLIKELY (priv->prev_rstart != -1 && priv->prev_rstart < rstart)) {
2445 GstClockTime in_diff;
2447 in_diff = rstart - priv->prev_rstart;
2449 if (priv->avg_in_diff == -1)
2450 priv->avg_in_diff = in_diff;
2452 priv->avg_in_diff = UPDATE_RUNNING_AVG (priv->avg_in_diff, in_diff);
2454 GST_LOG_OBJECT (basesink, "avg frame diff %" GST_TIME_FORMAT,
2455 GST_TIME_ARGS (priv->avg_in_diff));
2458 priv->prev_rstart = rstart;
2460 if (G_UNLIKELY (priv->earliest_in_time != -1
2461 && rstart < priv->earliest_in_time))
2465 /* first do preroll, this makes sure we commit our state
2466 * to PAUSED and can continue to PLAYING. We cannot perform
2467 * any clock sync in PAUSED because there is no clock. */
2468 ret = gst_base_sink_do_preroll (basesink, obj);
2469 if (G_UNLIKELY (ret != GST_FLOW_OK))
2470 goto preroll_failed;
2472 /* update the segment with a pending step if the current one is invalid and we
2473 * have a new pending one. We only accept new step updates after a preroll */
2474 if (G_UNLIKELY (pending->valid && !current->valid)) {
2475 start_stepping (basesink, &basesink->segment, pending, current);
2479 /* After rendering we store the position of the last buffer so that we can use
2480 * it to report the position. We need to take the lock here. */
2481 GST_OBJECT_LOCK (basesink);
2482 priv->current_sstart = sstart;
2483 priv->current_sstop = (GST_CLOCK_TIME_IS_VALID (sstop) ? sstop : sstart);
2484 GST_OBJECT_UNLOCK (basesink);
2489 /* adjust for latency */
2490 stime = gst_base_sink_adjust_time (basesink, rstart);
2492 /* adjust for render-delay, avoid underflows */
2493 if (GST_CLOCK_TIME_IS_VALID (stime)) {
2494 if (stime > priv->render_delay)
2495 stime -= priv->render_delay;
2500 /* preroll done, we can sync since we are in PLAYING now. */
2501 GST_DEBUG_OBJECT (basesink, "possibly waiting for clock to reach %"
2502 GST_TIME_FORMAT ", adjusted %" GST_TIME_FORMAT,
2503 GST_TIME_ARGS (rstart), GST_TIME_ARGS (stime));
2505 /* This function will return immediatly if start == -1, no clock
2506 * or sync is disabled with GST_CLOCK_BADTIME. */
2507 status = gst_base_sink_wait_clock (basesink, stime, &jitter);
2509 GST_DEBUG_OBJECT (basesink, "clock returned %d, jitter %c%" GST_TIME_FORMAT,
2510 status, (jitter < 0 ? '-' : ' '), GST_TIME_ARGS (ABS (jitter)));
2512 /* invalid time, no clock or sync disabled, just render */
2513 if (status == GST_CLOCK_BADTIME)
2516 /* waiting could have been interrupted and we can be flushing now */
2517 if (G_UNLIKELY (basesink->flushing))
2520 /* check for unlocked by a state change, we are not flushing so
2521 * we can try to preroll on the current buffer. */
2522 if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED)) {
2523 GST_DEBUG_OBJECT (basesink, "unscheduled, waiting some more");
2524 priv->call_preroll = TRUE;
2528 /* successful syncing done, record observation */
2529 priv->current_jitter = jitter;
2531 /* check if the object should be dropped */
2532 *late = gst_base_sink_is_too_late (basesink, obj, rstart, rstop,
2541 GST_DEBUG_OBJECT (basesink, "skipped stepped object %p", obj);
2547 GST_DEBUG_OBJECT (basesink, "non syncable object %p", obj);
2552 GST_DEBUG_OBJECT (basesink, "dropped because of QoS %p", obj);
2558 GST_DEBUG_OBJECT (basesink, "we are flushing");
2559 return GST_FLOW_WRONG_STATE;
2563 GST_DEBUG_OBJECT (basesink, "preroll failed");
2570 gst_base_sink_send_qos (GstBaseSink * basesink, GstQOSType type,
2571 gdouble proportion, GstClockTime time, GstClockTimeDiff diff)
2576 /* generate Quality-of-Service event */
2577 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2578 "qos: type %d, proportion: %lf, diff %" G_GINT64_FORMAT ", timestamp %"
2579 GST_TIME_FORMAT, type, proportion, diff, GST_TIME_ARGS (time));
2581 event = gst_event_new_qos_full (type, proportion, diff, time);
2584 res = gst_pad_push_event (basesink->sinkpad, event);
2590 gst_base_sink_perform_qos (GstBaseSink * sink, gboolean dropped)
2592 GstBaseSinkPrivate *priv;
2593 GstClockTime start, stop;
2594 GstClockTimeDiff jitter;
2595 GstClockTime pt, entered, left;
2596 GstClockTime duration;
2601 start = priv->current_rstart;
2603 if (priv->current_step.valid)
2606 /* if Quality-of-Service disabled, do nothing */
2607 if (!g_atomic_int_get (&priv->qos_enabled) ||
2608 !GST_CLOCK_TIME_IS_VALID (start))
2611 stop = priv->current_rstop;
2612 jitter = priv->current_jitter;
2615 /* this is the time the buffer entered the sink */
2616 if (start < -jitter)
2619 entered = start + jitter;
2622 /* this is the time the buffer entered the sink */
2623 entered = start + jitter;
2624 /* this is the time the buffer left the sink */
2625 left = start + jitter;
2628 /* calculate duration of the buffer */
2629 if (GST_CLOCK_TIME_IS_VALID (stop) && stop != start)
2630 duration = stop - start;
2632 duration = priv->avg_in_diff;
2634 /* if we have the time when the last buffer left us, calculate
2635 * processing time */
2636 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2637 if (entered > priv->last_left) {
2638 pt = entered - priv->last_left;
2646 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "start: %" GST_TIME_FORMAT
2647 ", stop %" GST_TIME_FORMAT ", entered %" GST_TIME_FORMAT ", left %"
2648 GST_TIME_FORMAT ", pt: %" GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT
2649 ",jitter %" G_GINT64_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (stop),
2650 GST_TIME_ARGS (entered), GST_TIME_ARGS (left), GST_TIME_ARGS (pt),
2651 GST_TIME_ARGS (duration), jitter);
2653 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "avg_duration: %" GST_TIME_FORMAT
2654 ", avg_pt: %" GST_TIME_FORMAT ", avg_rate: %g",
2655 GST_TIME_ARGS (priv->avg_duration), GST_TIME_ARGS (priv->avg_pt),
2658 /* collect running averages. for first observations, we copy the
2660 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_duration))
2661 priv->avg_duration = duration;
2663 priv->avg_duration = UPDATE_RUNNING_AVG (priv->avg_duration, duration);
2665 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_pt))
2668 priv->avg_pt = UPDATE_RUNNING_AVG (priv->avg_pt, pt);
2670 if (priv->avg_duration != 0)
2672 gst_guint64_to_gdouble (priv->avg_pt) /
2673 gst_guint64_to_gdouble (priv->avg_duration);
2677 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2678 if (dropped || priv->avg_rate < 0.0) {
2679 priv->avg_rate = rate;
2682 priv->avg_rate = UPDATE_RUNNING_AVG_N (priv->avg_rate, rate);
2684 priv->avg_rate = UPDATE_RUNNING_AVG_P (priv->avg_rate, rate);
2688 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink,
2689 "updated: avg_duration: %" GST_TIME_FORMAT ", avg_pt: %" GST_TIME_FORMAT
2690 ", avg_rate: %g", GST_TIME_ARGS (priv->avg_duration),
2691 GST_TIME_ARGS (priv->avg_pt), priv->avg_rate);
2694 if (priv->avg_rate >= 0.0) {
2696 GstClockTimeDiff diff;
2698 /* if we have a valid rate, start sending QoS messages */
2699 if (priv->current_jitter < 0) {
2700 /* make sure we never go below 0 when adding the jitter to the
2702 if (priv->current_rstart < -priv->current_jitter)
2703 priv->current_jitter = -priv->current_rstart;
2706 if (priv->throttle_time > 0) {
2707 diff = priv->throttle_time;
2708 type = GST_QOS_TYPE_THROTTLE;
2710 diff = priv->current_jitter;
2712 type = GST_QOS_TYPE_OVERFLOW;
2714 type = GST_QOS_TYPE_UNDERFLOW;
2717 gst_base_sink_send_qos (sink, type, priv->avg_rate, priv->current_rstart,
2721 /* record when this buffer will leave us */
2722 priv->last_left = left;
2725 /* reset all qos measuring */
2727 gst_base_sink_reset_qos (GstBaseSink * sink)
2729 GstBaseSinkPrivate *priv;
2733 priv->last_render_time = GST_CLOCK_TIME_NONE;
2734 priv->prev_rstart = GST_CLOCK_TIME_NONE;
2735 priv->earliest_in_time = GST_CLOCK_TIME_NONE;
2736 priv->last_left = GST_CLOCK_TIME_NONE;
2737 priv->avg_duration = GST_CLOCK_TIME_NONE;
2738 priv->avg_pt = GST_CLOCK_TIME_NONE;
2739 priv->avg_rate = -1.0;
2740 priv->avg_render = GST_CLOCK_TIME_NONE;
2741 priv->avg_in_diff = GST_CLOCK_TIME_NONE;
2747 /* Checks if the object was scheduled too late.
2749 * rstart/rstop contain the running_time start and stop values
2752 * status and jitter contain the return values from the clock wait.
2754 * returns TRUE if the buffer was too late.
2757 gst_base_sink_is_too_late (GstBaseSink * basesink, GstMiniObject * obj,
2758 GstClockTime rstart, GstClockTime rstop,
2759 GstClockReturn status, GstClockTimeDiff jitter)
2762 gint64 max_lateness;
2763 GstBaseSinkPrivate *priv;
2765 priv = basesink->priv;
2769 /* only for objects that were too late */
2770 if (G_LIKELY (status != GST_CLOCK_EARLY))
2773 max_lateness = basesink->max_lateness;
2775 /* check if frame dropping is enabled */
2776 if (max_lateness == -1)
2779 /* only check for buffers */
2780 if (G_UNLIKELY (!GST_IS_BUFFER (obj)))
2783 /* can't do check if we don't have a timestamp */
2784 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (rstart)))
2787 /* we can add a valid stop time */
2788 if (GST_CLOCK_TIME_IS_VALID (rstop))
2789 max_lateness += rstop;
2791 max_lateness += rstart;
2792 /* no stop time, use avg frame diff */
2793 if (priv->avg_in_diff != -1)
2794 max_lateness += priv->avg_in_diff;
2797 /* if the jitter bigger than duration and lateness we are too late */
2798 if ((late = rstart + jitter > max_lateness)) {
2799 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2800 "buffer is too late %" GST_TIME_FORMAT
2801 " > %" GST_TIME_FORMAT, GST_TIME_ARGS (rstart + jitter),
2802 GST_TIME_ARGS (max_lateness));
2803 /* !!emergency!!, if we did not receive anything valid for more than a
2804 * second, render it anyway so the user sees something */
2805 if (GST_CLOCK_TIME_IS_VALID (priv->last_render_time) &&
2806 rstart - priv->last_render_time > GST_SECOND) {
2808 GST_ELEMENT_WARNING (basesink, CORE, CLOCK,
2809 (_("A lot of buffers are being dropped.")),
2810 ("There may be a timestamping problem, or this computer is too slow."));
2811 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2812 "**emergency** last buffer at %" GST_TIME_FORMAT " > GST_SECOND",
2813 GST_TIME_ARGS (priv->last_render_time));
2818 if (!late || !GST_CLOCK_TIME_IS_VALID (priv->last_render_time)) {
2819 priv->last_render_time = rstart;
2820 /* the next allowed input timestamp */
2821 if (priv->throttle_time > 0)
2822 priv->earliest_in_time = rstart + priv->throttle_time;
2829 GST_DEBUG_OBJECT (basesink, "object was scheduled in time");
2834 GST_DEBUG_OBJECT (basesink, "frame dropping disabled");
2839 GST_DEBUG_OBJECT (basesink, "object is not a buffer");
2844 GST_DEBUG_OBJECT (basesink, "buffer has no timestamp");
2849 /* called before and after calling the render vmethod. It keeps track of how
2850 * much time was spent in the render method and is used to check if we are
2853 gst_base_sink_do_render_stats (GstBaseSink * basesink, gboolean start)
2855 GstBaseSinkPrivate *priv;
2857 priv = basesink->priv;
2860 priv->start = gst_util_get_timestamp ();
2862 GstClockTime elapsed;
2864 priv->stop = gst_util_get_timestamp ();
2866 elapsed = GST_CLOCK_DIFF (priv->start, priv->stop);
2868 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_render))
2869 priv->avg_render = elapsed;
2871 priv->avg_render = UPDATE_RUNNING_AVG (priv->avg_render, elapsed);
2873 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2874 "avg_render: %" GST_TIME_FORMAT, GST_TIME_ARGS (priv->avg_render));
2878 /* with STREAM_LOCK, PREROLL_LOCK,
2880 * Synchronize the object on the clock and then render it.
2882 * takes ownership of obj.
2884 static GstFlowReturn
2885 gst_base_sink_render_object (GstBaseSink * basesink, GstPad * pad,
2886 guint8 obj_type, gpointer obj)
2889 GstBaseSinkClass *bclass;
2890 gboolean late, step_end;
2892 GstBaseSinkPrivate *priv;
2894 priv = basesink->priv;
2896 if (OBJ_IS_BUFFERLIST (obj_type)) {
2898 * If buffer list, use the first group buffer within the list
2901 sync_obj = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0);
2902 g_assert (NULL != sync_obj);
2911 /* synchronize this object, non syncable objects return OK
2914 gst_base_sink_do_sync (basesink, pad, sync_obj, &late, &step_end,
2916 if (G_UNLIKELY (ret != GST_FLOW_OK))
2919 /* and now render, event or buffer/buffer list. */
2920 if (G_LIKELY (OBJ_IS_BUFFERFULL (obj_type))) {
2921 /* drop late buffers unconditionally, let's hope it's unlikely */
2922 if (G_UNLIKELY (late))
2925 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2927 if (G_LIKELY ((OBJ_IS_BUFFERLIST (obj_type) && bclass->render_list) ||
2928 (!OBJ_IS_BUFFERLIST (obj_type) && bclass->render))) {
2931 /* read once, to get same value before and after */
2932 do_qos = g_atomic_int_get (&priv->qos_enabled);
2934 GST_DEBUG_OBJECT (basesink, "rendering object %p", obj);
2936 /* record rendering time for QoS and stats */
2938 gst_base_sink_do_render_stats (basesink, TRUE);
2940 if (!OBJ_IS_BUFFERLIST (obj_type)) {
2943 /* For buffer lists do not set last buffer. Creating buffer
2944 * with meaningful data can be done only with memcpy which will
2945 * significantly affect performance */
2946 buf = GST_BUFFER_CAST (obj);
2947 gst_base_sink_set_last_buffer (basesink, buf);
2949 ret = bclass->render (basesink, buf);
2951 GstBufferList *buflist;
2953 buflist = GST_BUFFER_LIST_CAST (obj);
2955 ret = bclass->render_list (basesink, buflist);
2959 gst_base_sink_do_render_stats (basesink, FALSE);
2961 if (ret == GST_FLOW_STEP)
2964 if (G_UNLIKELY (basesink->flushing))
2969 } else if (G_LIKELY (OBJ_IS_EVENT (obj_type))) {
2970 GstEvent *event = GST_EVENT_CAST (obj);
2971 gboolean event_res = TRUE;
2974 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2976 type = GST_EVENT_TYPE (event);
2978 GST_DEBUG_OBJECT (basesink, "rendering event %p, type %s", obj,
2979 gst_event_type_get_name (type));
2982 event_res = bclass->event (basesink, event);
2984 /* when we get here we could be flushing again when the event handler calls
2985 * _wait_eos(). We have to ignore this object in that case. */
2986 if (G_UNLIKELY (basesink->flushing))
2989 if (G_LIKELY (event_res)) {
2992 seqnum = basesink->priv->seqnum = gst_event_get_seqnum (event);
2993 GST_DEBUG_OBJECT (basesink, "Got seqnum #%" G_GUINT32_FORMAT, seqnum);
2998 GstMessage *message;
3000 /* the EOS event is completely handled so we mark
3001 * ourselves as being in the EOS state. eos is also
3002 * protected by the object lock so we can read it when
3003 * answering the POSITION query. */
3004 GST_OBJECT_LOCK (basesink);
3005 basesink->eos = TRUE;
3006 GST_OBJECT_UNLOCK (basesink);
3008 /* ok, now we can post the message */
3009 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
3011 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
3012 gst_message_set_seqnum (message, seqnum);
3013 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
3016 case GST_EVENT_NEWSEGMENT:
3017 /* configure the segment */
3018 gst_base_sink_configure_segment (basesink, pad, event,
3019 &basesink->segment);
3021 case GST_EVENT_SINK_MESSAGE:{
3022 GstMessage *msg = NULL;
3024 gst_event_parse_sink_message (event, &msg);
3027 gst_element_post_message (GST_ELEMENT_CAST (basesink), msg);
3034 g_return_val_if_reached (GST_FLOW_ERROR);
3039 /* the step ended, check if we need to activate a new step */
3040 GST_DEBUG_OBJECT (basesink, "step ended");
3041 stop_stepping (basesink, &basesink->segment, &priv->current_step,
3042 priv->current_rstart, priv->current_rstop, basesink->eos);
3046 gst_base_sink_perform_qos (basesink, late);
3048 GST_DEBUG_OBJECT (basesink, "object unref after render %p", obj);
3049 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3055 GST_DEBUG_OBJECT (basesink, "do_sync returned %s", gst_flow_get_name (ret));
3061 GST_DEBUG_OBJECT (basesink, "buffer late, dropping");
3063 if (g_atomic_int_get (&priv->qos_enabled)) {
3064 GstMessage *qos_msg;
3065 GstClockTime timestamp, duration;
3067 timestamp = GST_BUFFER_TIMESTAMP (GST_BUFFER_CAST (sync_obj));
3068 duration = GST_BUFFER_DURATION (GST_BUFFER_CAST (sync_obj));
3070 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
3071 "qos: dropped buffer rt %" GST_TIME_FORMAT ", st %" GST_TIME_FORMAT
3072 ", ts %" GST_TIME_FORMAT ", dur %" GST_TIME_FORMAT,
3073 GST_TIME_ARGS (priv->current_rstart),
3074 GST_TIME_ARGS (priv->current_sstart), GST_TIME_ARGS (timestamp),
3075 GST_TIME_ARGS (duration));
3076 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
3077 "qos: rendered %" G_GUINT64_FORMAT ", dropped %" G_GUINT64_FORMAT,
3078 priv->rendered, priv->dropped);
3081 gst_message_new_qos (GST_OBJECT_CAST (basesink), basesink->sync,
3082 priv->current_rstart, priv->current_sstart, timestamp, duration);
3083 gst_message_set_qos_values (qos_msg, priv->current_jitter, priv->avg_rate,
3085 gst_message_set_qos_stats (qos_msg, GST_FORMAT_BUFFERS, priv->rendered,
3087 gst_element_post_message (GST_ELEMENT_CAST (basesink), qos_msg);
3093 GST_DEBUG_OBJECT (basesink, "we are flushing, ignore object");
3094 gst_mini_object_unref (obj);
3095 return GST_FLOW_WRONG_STATE;
3099 /* with STREAM_LOCK, PREROLL_LOCK
3101 * Perform preroll on the given object. For buffers this means
3102 * calling the preroll subclass method.
3103 * If that succeeds, the state will be commited.
3105 * function does not take ownership of obj.
3107 static GstFlowReturn
3108 gst_base_sink_preroll_object (GstBaseSink * basesink, guint8 obj_type,
3109 GstMiniObject * obj)
3113 GST_DEBUG_OBJECT (basesink, "prerolling object %p", obj);
3115 /* if it's a buffer, we need to call the preroll method */
3116 if (G_LIKELY (OBJ_IS_BUFFERFULL (obj_type) && basesink->priv->call_preroll)) {
3117 GstBaseSinkClass *bclass;
3119 GstClockTime timestamp;
3121 if (OBJ_IS_BUFFERLIST (obj_type)) {
3122 buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0);
3123 g_assert (NULL != buf);
3125 buf = GST_BUFFER_CAST (obj);
3128 timestamp = GST_BUFFER_TIMESTAMP (buf);
3130 GST_DEBUG_OBJECT (basesink, "preroll buffer %" GST_TIME_FORMAT,
3131 GST_TIME_ARGS (timestamp));
3134 * For buffer lists do not set last buffer. Creating buffer
3135 * with meaningful data can be done only with memcpy which will
3136 * significantly affect performance
3138 if (!OBJ_IS_BUFFERLIST (obj_type)) {
3139 gst_base_sink_set_last_buffer (basesink, buf);
3142 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3143 if (bclass->preroll)
3144 if ((ret = bclass->preroll (basesink, buf)) != GST_FLOW_OK)
3145 goto preroll_failed;
3147 basesink->priv->call_preroll = FALSE;
3151 if (G_LIKELY (basesink->playing_async)) {
3152 if (G_UNLIKELY (!gst_base_sink_commit_state (basesink)))
3161 GST_DEBUG_OBJECT (basesink, "preroll failed, abort state");
3162 gst_element_abort_state (GST_ELEMENT_CAST (basesink));
3167 GST_DEBUG_OBJECT (basesink, "stopping while commiting state");
3168 return GST_FLOW_WRONG_STATE;
3172 /* with STREAM_LOCK, PREROLL_LOCK
3174 * Queue an object for rendering.
3175 * The first prerollable object queued will complete the preroll. If the
3176 * preroll queue if filled, we render all the objects in the queue.
3178 * This function takes ownership of the object.
3180 static GstFlowReturn
3181 gst_base_sink_queue_object_unlocked (GstBaseSink * basesink, GstPad * pad,
3182 guint8 obj_type, gpointer obj, gboolean prerollable)
3184 GstFlowReturn ret = GST_FLOW_OK;
3188 if (G_UNLIKELY (basesink->need_preroll)) {
3189 if (G_LIKELY (prerollable))
3190 basesink->preroll_queued++;
3192 length = basesink->preroll_queued;
3194 GST_DEBUG_OBJECT (basesink, "now %d prerolled items", length);
3196 /* first prerollable item needs to finish the preroll */
3198 ret = gst_base_sink_preroll_object (basesink, obj_type, obj);
3199 if (G_UNLIKELY (ret != GST_FLOW_OK))
3200 goto preroll_failed;
3202 /* need to recheck if we need preroll, commmit state during preroll
3203 * could have made us not need more preroll. */
3204 if (G_UNLIKELY (basesink->need_preroll)) {
3205 /* see if we can render now, if we can't add the object to the preroll
3207 if (G_UNLIKELY (length <= basesink->preroll_queue_max_len))
3211 /* we can start rendering (or blocking) the queued object
3213 q = basesink->preroll_queue;
3214 while (G_UNLIKELY (!g_queue_is_empty (q))) {
3218 o = g_queue_pop_head (q);
3219 GST_DEBUG_OBJECT (basesink, "rendering queued object %p", o);
3221 ot = get_object_type (o);
3223 /* do something with the return value */
3224 ret = gst_base_sink_render_object (basesink, pad, ot, o);
3225 if (ret != GST_FLOW_OK)
3226 goto dequeue_failed;
3229 /* now render the object */
3230 ret = gst_base_sink_render_object (basesink, pad, obj_type, obj);
3231 basesink->preroll_queued = 0;
3238 GST_DEBUG_OBJECT (basesink, "preroll failed, reason %s",
3239 gst_flow_get_name (ret));
3240 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3245 /* add object to the queue and return */
3246 GST_DEBUG_OBJECT (basesink, "need more preroll data %d <= %d",
3247 length, basesink->preroll_queue_max_len);
3248 g_queue_push_tail (basesink->preroll_queue, obj);
3253 GST_DEBUG_OBJECT (basesink, "rendering queued objects failed, reason %s",
3254 gst_flow_get_name (ret));
3255 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3262 * This function grabs the PREROLL_LOCK and adds the object to
3265 * This function takes ownership of obj.
3267 * Note: Only GstEvent seem to be passed to this private method
3269 static GstFlowReturn
3270 gst_base_sink_queue_object (GstBaseSink * basesink, GstPad * pad,
3271 GstMiniObject * obj, gboolean prerollable)
3275 GST_BASE_SINK_PREROLL_LOCK (basesink);
3276 if (G_UNLIKELY (basesink->flushing))
3279 if (G_UNLIKELY (basesink->priv->received_eos))
3283 gst_base_sink_queue_object_unlocked (basesink, pad, _PR_IS_EVENT, obj,
3285 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3292 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3293 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3294 gst_mini_object_unref (obj);
3295 return GST_FLOW_WRONG_STATE;
3299 GST_DEBUG_OBJECT (basesink,
3300 "we are EOS, dropping object, return UNEXPECTED");
3301 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3302 gst_mini_object_unref (obj);
3303 return GST_FLOW_UNEXPECTED;
3308 gst_base_sink_flush_start (GstBaseSink * basesink, GstPad * pad)
3310 /* make sure we are not blocked on the clock also clear any pending
3312 gst_base_sink_set_flushing (basesink, pad, TRUE);
3314 /* we grab the stream lock but that is not needed since setting the
3315 * sink to flushing would make sure no state commit is being done
3317 GST_PAD_STREAM_LOCK (pad);
3318 gst_base_sink_reset_qos (basesink);
3319 /* and we need to commit our state again on the next
3320 * prerolled buffer */
3321 basesink->playing_async = TRUE;
3322 if (basesink->priv->async_enabled) {
3323 gst_element_lost_state (GST_ELEMENT_CAST (basesink));
3325 basesink->priv->have_latency = TRUE;
3327 gst_base_sink_set_last_buffer (basesink, NULL);
3328 GST_PAD_STREAM_UNLOCK (pad);
3332 gst_base_sink_flush_stop (GstBaseSink * basesink, GstPad * pad)
3334 /* unset flushing so we can accept new data, this also flushes out any EOS
3336 gst_base_sink_set_flushing (basesink, pad, FALSE);
3338 /* for position reporting */
3339 GST_OBJECT_LOCK (basesink);
3340 basesink->priv->current_sstart = GST_CLOCK_TIME_NONE;
3341 basesink->priv->current_sstop = GST_CLOCK_TIME_NONE;
3342 basesink->priv->eos_rtime = GST_CLOCK_TIME_NONE;
3343 basesink->priv->call_preroll = TRUE;
3344 basesink->priv->current_step.valid = FALSE;
3345 basesink->priv->pending_step.valid = FALSE;
3346 if (basesink->pad_mode == GST_ACTIVATE_PUSH) {
3347 /* we need new segment info after the flush. */
3348 basesink->have_newsegment = FALSE;
3349 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
3350 gst_segment_init (basesink->clip_segment, GST_FORMAT_UNDEFINED);
3352 GST_OBJECT_UNLOCK (basesink);
3356 gst_base_sink_event (GstPad * pad, GstEvent * event)
3358 GstBaseSink *basesink;
3359 gboolean result = TRUE;
3360 GstBaseSinkClass *bclass;
3362 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3363 if (G_UNLIKELY (basesink == NULL)) {
3364 gst_event_unref (event);
3368 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3370 GST_DEBUG_OBJECT (basesink, "received event %p %" GST_PTR_FORMAT, event,
3373 switch (GST_EVENT_TYPE (event)) {
3378 GST_BASE_SINK_PREROLL_LOCK (basesink);
3379 if (G_UNLIKELY (basesink->flushing))
3382 if (G_UNLIKELY (basesink->priv->received_eos)) {
3383 /* we can't accept anything when we are EOS */
3385 gst_event_unref (event);
3387 /* we set the received EOS flag here so that we can use it when testing if
3388 * we are prerolled and to refuse more buffers. */
3389 basesink->priv->received_eos = TRUE;
3391 /* EOS is a prerollable object, we call the unlocked version because it
3392 * does not check the received_eos flag. */
3393 ret = gst_base_sink_queue_object_unlocked (basesink, pad,
3394 _PR_IS_EVENT, GST_MINI_OBJECT_CAST (event), TRUE);
3395 if (G_UNLIKELY (ret != GST_FLOW_OK))
3398 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3401 case GST_EVENT_NEWSEGMENT:
3406 GST_DEBUG_OBJECT (basesink, "newsegment %p", event);
3408 GST_BASE_SINK_PREROLL_LOCK (basesink);
3409 if (G_UNLIKELY (basesink->flushing))
3412 gst_event_parse_new_segment_full (event, &update, NULL, NULL, NULL, NULL,
3415 if (G_UNLIKELY (basesink->priv->received_eos && !update)) {
3416 /* we can't accept anything when we are EOS */
3418 gst_event_unref (event);
3420 /* the new segment is a non prerollable item and does not block anything,
3421 * we need to configure the current clipping segment and insert the event
3422 * in the queue to serialize it with the buffers for rendering. */
3423 gst_base_sink_configure_segment (basesink, pad, event,
3424 basesink->clip_segment);
3427 gst_base_sink_queue_object_unlocked (basesink, pad,
3428 _PR_IS_EVENT, GST_MINI_OBJECT_CAST (event), FALSE);
3429 if (G_UNLIKELY (ret != GST_FLOW_OK))
3432 GST_OBJECT_LOCK (basesink);
3433 basesink->have_newsegment = TRUE;
3434 GST_OBJECT_UNLOCK (basesink);
3437 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3440 case GST_EVENT_FLUSH_START:
3442 bclass->event (basesink, event);
3444 GST_DEBUG_OBJECT (basesink, "flush-start %p", event);
3446 gst_base_sink_flush_start (basesink, pad);
3448 gst_event_unref (event);
3450 case GST_EVENT_FLUSH_STOP:
3452 bclass->event (basesink, event);
3454 GST_DEBUG_OBJECT (basesink, "flush-stop %p", event);
3456 gst_base_sink_flush_stop (basesink, pad);
3458 gst_event_unref (event);
3461 /* other events are sent to queue or subclass depending on if they
3462 * are serialized. */
3463 if (GST_EVENT_IS_SERIALIZED (event)) {
3464 gst_base_sink_queue_object (basesink, pad,
3465 GST_MINI_OBJECT_CAST (event), FALSE);
3468 bclass->event (basesink, event);
3469 gst_event_unref (event);
3474 gst_object_unref (basesink);
3481 GST_DEBUG_OBJECT (basesink, "we are flushing");
3482 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3484 gst_event_unref (event);
3489 /* default implementation to calculate the start and end
3490 * timestamps on a buffer, subclasses can override
3493 gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
3494 GstClockTime * start, GstClockTime * end)
3496 GstClockTime timestamp, duration;
3498 timestamp = GST_BUFFER_TIMESTAMP (buffer);
3499 if (GST_CLOCK_TIME_IS_VALID (timestamp)) {
3501 /* get duration to calculate end time */
3502 duration = GST_BUFFER_DURATION (buffer);
3503 if (GST_CLOCK_TIME_IS_VALID (duration)) {
3504 *end = timestamp + duration;
3510 /* must be called with PREROLL_LOCK */
3512 gst_base_sink_needs_preroll (GstBaseSink * basesink)
3514 gboolean is_prerolled, res;
3516 /* we have 2 cases where the PREROLL_LOCK is released:
3517 * 1) we are blocking in the PREROLL_LOCK and thus are prerolled.
3518 * 2) we are syncing on the clock
3520 is_prerolled = basesink->have_preroll || basesink->priv->received_eos;
3521 res = !is_prerolled;
3523 GST_DEBUG_OBJECT (basesink, "have_preroll: %d, EOS: %d => needs preroll: %d",
3524 basesink->have_preroll, basesink->priv->received_eos, res);
3529 /* with STREAM_LOCK, PREROLL_LOCK
3531 * Takes a buffer and compare the timestamps with the last segment.
3532 * If the buffer falls outside of the segment boundaries, drop it.
3533 * Else queue the buffer for preroll and rendering.
3535 * This function takes ownership of the buffer.
3537 static GstFlowReturn
3538 gst_base_sink_chain_unlocked (GstBaseSink * basesink, GstPad * pad,
3539 guint8 obj_type, gpointer obj)
3541 GstBaseSinkClass *bclass;
3542 GstFlowReturn result;
3543 GstClockTime start = GST_CLOCK_TIME_NONE, end = GST_CLOCK_TIME_NONE;
3544 GstSegment *clip_segment;
3545 GstBuffer *time_buf;
3547 if (G_UNLIKELY (basesink->flushing))
3550 if (G_UNLIKELY (basesink->priv->received_eos))
3553 if (OBJ_IS_BUFFERLIST (obj_type)) {
3554 time_buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0);
3555 g_assert (NULL != time_buf);
3557 time_buf = GST_BUFFER_CAST (obj);
3560 /* for code clarity */
3561 clip_segment = basesink->clip_segment;
3563 if (G_UNLIKELY (!basesink->have_newsegment)) {
3566 sync = gst_base_sink_get_sync (basesink);
3568 GST_ELEMENT_WARNING (basesink, STREAM, FAILED,
3569 (_("Internal data flow problem.")),
3570 ("Received buffer without a new-segment. Assuming timestamps start from 0."));
3573 /* this means this sink will assume timestamps start from 0 */
3574 GST_OBJECT_LOCK (basesink);
3575 clip_segment->start = 0;
3576 clip_segment->stop = -1;
3577 basesink->segment.start = 0;
3578 basesink->segment.stop = -1;
3579 basesink->have_newsegment = TRUE;
3580 GST_OBJECT_UNLOCK (basesink);
3583 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3585 /* check if the buffer needs to be dropped, we first ask the subclass for the
3587 if (bclass->get_times)
3588 bclass->get_times (basesink, time_buf, &start, &end);
3590 if (!GST_CLOCK_TIME_IS_VALID (start)) {
3591 /* if the subclass does not want sync, we use our own values so that we at
3592 * least clip the buffer to the segment */
3593 gst_base_sink_get_times (basesink, time_buf, &start, &end);
3596 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
3597 ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (end));
3599 /* a dropped buffer does not participate in anything */
3600 if (GST_CLOCK_TIME_IS_VALID (start) &&
3601 (clip_segment->format == GST_FORMAT_TIME)) {
3602 if (G_UNLIKELY (!gst_segment_clip (clip_segment,
3603 GST_FORMAT_TIME, (gint64) start, (gint64) end, NULL, NULL)))
3604 goto out_of_segment;
3607 /* now we can process the buffer in the queue, this function takes ownership
3609 result = gst_base_sink_queue_object_unlocked (basesink, pad,
3610 obj_type, obj, TRUE);
3616 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3617 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3618 return GST_FLOW_WRONG_STATE;
3622 GST_DEBUG_OBJECT (basesink,
3623 "we are EOS, dropping object, return UNEXPECTED");
3624 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3625 return GST_FLOW_UNEXPECTED;
3629 GST_DEBUG_OBJECT (basesink, "dropping buffer, out of clipping segment");
3630 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3637 static GstFlowReturn
3638 gst_base_sink_chain_main (GstBaseSink * basesink, GstPad * pad,
3639 guint8 obj_type, gpointer obj)
3641 GstFlowReturn result;
3643 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH))
3646 GST_BASE_SINK_PREROLL_LOCK (basesink);
3647 result = gst_base_sink_chain_unlocked (basesink, pad, obj_type, obj);
3648 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3656 GST_OBJECT_LOCK (pad);
3657 GST_WARNING_OBJECT (basesink,
3658 "Push on pad %s:%s, but it was not activated in push mode",
3659 GST_DEBUG_PAD_NAME (pad));
3660 GST_OBJECT_UNLOCK (pad);
3661 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3662 /* we don't post an error message this will signal to the peer
3663 * pushing that EOS is reached. */
3664 result = GST_FLOW_UNEXPECTED;
3669 static GstFlowReturn
3670 gst_base_sink_chain (GstPad * pad, GstBuffer * buf)
3672 GstBaseSink *basesink;
3674 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3676 return gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFER, buf);
3679 static GstFlowReturn
3680 gst_base_sink_chain_list (GstPad * pad, GstBufferList * list)
3682 GstBaseSink *basesink;
3683 GstBaseSinkClass *bclass;
3684 GstFlowReturn result;
3686 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3687 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3689 if (G_LIKELY (bclass->render_list)) {
3690 result = gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFERLIST, list);
3695 GST_INFO_OBJECT (pad, "chaining each group in list as a merged buffer");
3697 len = gst_buffer_list_len (list);
3699 result = GST_FLOW_OK;
3700 for (i = 0; i < len; i++) {
3701 buffer = gst_buffer_list_get (list, 0);
3702 result = gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFER,
3703 gst_buffer_ref (buffer));
3704 if (result != GST_FLOW_OK)
3707 gst_buffer_list_unref (list);
3714 gst_base_sink_default_do_seek (GstBaseSink * sink, GstSegment * segment)
3716 gboolean res = TRUE;
3718 /* update our offset if the start/stop position was updated */
3719 if (segment->format == GST_FORMAT_BYTES) {
3720 segment->time = segment->start;
3721 } else if (segment->start == 0) {
3722 /* seek to start, we can implement a default for this. */
3726 GST_INFO_OBJECT (sink, "Can't do a default seek");
3732 #define SEEK_TYPE_IS_RELATIVE(t) (((t) != GST_SEEK_TYPE_NONE) && ((t) != GST_SEEK_TYPE_SET))
3735 gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
3736 GstEvent * event, GstSegment * segment)
3738 /* By default, we try one of 2 things:
3739 * - For absolute seek positions, convert the requested position to our
3740 * configured processing format and place it in the output segment \
3741 * - For relative seek positions, convert our current (input) values to the
3742 * seek format, adjust by the relative seek offset and then convert back to
3743 * the processing format
3745 GstSeekType cur_type, stop_type;
3748 GstFormat seek_format, dest_format;
3751 gboolean res = TRUE;
3753 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3754 &cur_type, &cur, &stop_type, &stop);
3755 dest_format = segment->format;
3757 if (seek_format == dest_format) {
3758 gst_segment_set_seek (segment, rate, seek_format, flags,
3759 cur_type, cur, stop_type, stop, &update);
3763 if (cur_type != GST_SEEK_TYPE_NONE) {
3764 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3766 gst_pad_query_convert (sink->sinkpad, seek_format, cur, &dest_format,
3768 cur_type = GST_SEEK_TYPE_SET;
3771 if (res && stop_type != GST_SEEK_TYPE_NONE) {
3772 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3774 gst_pad_query_convert (sink->sinkpad, seek_format, stop, &dest_format,
3776 stop_type = GST_SEEK_TYPE_SET;
3779 /* And finally, configure our output segment in the desired format */
3780 gst_segment_set_seek (segment, rate, dest_format, flags, cur_type, cur,
3781 stop_type, stop, &update);
3790 GST_DEBUG_OBJECT (sink, "undefined format given, seek aborted.");
3795 /* perform a seek, only executed in pull mode */
3797 gst_base_sink_perform_seek (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3801 GstFormat seek_format, dest_format;
3803 GstSeekType cur_type, stop_type;
3804 gboolean seekseg_configured = FALSE;
3806 gboolean update, res = TRUE;
3807 GstSegment seeksegment;
3809 dest_format = sink->segment.format;
3812 GST_DEBUG_OBJECT (sink, "performing seek with event %p", event);
3813 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3814 &cur_type, &cur, &stop_type, &stop);
3816 flush = flags & GST_SEEK_FLAG_FLUSH;
3818 GST_DEBUG_OBJECT (sink, "performing seek without event");
3823 GST_DEBUG_OBJECT (sink, "flushing upstream");
3824 gst_pad_push_event (pad, gst_event_new_flush_start ());
3825 gst_base_sink_flush_start (sink, pad);
3827 GST_DEBUG_OBJECT (sink, "pausing pulling thread");
3830 GST_PAD_STREAM_LOCK (pad);
3832 /* If we configured the seeksegment above, don't overwrite it now. Otherwise
3833 * copy the current segment info into the temp segment that we can actually
3834 * attempt the seek with. We only update the real segment if the seek suceeds. */
3835 if (!seekseg_configured) {
3836 memcpy (&seeksegment, &sink->segment, sizeof (GstSegment));
3838 /* now configure the final seek segment */
3840 if (sink->segment.format != seek_format) {
3841 /* OK, here's where we give the subclass a chance to convert the relative
3842 * seek into an absolute one in the processing format. We set up any
3843 * absolute seek above, before taking the stream lock. */
3844 if (!gst_base_sink_default_prepare_seek_segment (sink, event,
3846 GST_DEBUG_OBJECT (sink,
3847 "Preparing the seek failed after flushing. " "Aborting seek");
3851 /* The seek format matches our processing format, no need to ask the
3852 * the subclass to configure the segment. */
3853 gst_segment_set_seek (&seeksegment, rate, seek_format, flags,
3854 cur_type, cur, stop_type, stop, &update);
3857 /* Else, no seek event passed, so we're just (re)starting the
3862 GST_DEBUG_OBJECT (sink, "segment configured from %" G_GINT64_FORMAT
3863 " to %" G_GINT64_FORMAT ", position %" G_GINT64_FORMAT,
3864 seeksegment.start, seeksegment.stop, seeksegment.last_stop);
3866 /* do the seek, segment.last_stop contains the new position. */
3867 res = gst_base_sink_default_do_seek (sink, &seeksegment);
3872 GST_DEBUG_OBJECT (sink, "stop flushing upstream");
3873 gst_pad_push_event (pad, gst_event_new_flush_stop ());
3874 gst_base_sink_flush_stop (sink, pad);
3875 } else if (res && sink->running) {
3876 /* we are running the current segment and doing a non-flushing seek,
3877 * close the segment first based on the last_stop. */
3878 GST_DEBUG_OBJECT (sink, "closing running segment %" G_GINT64_FORMAT
3879 " to %" G_GINT64_FORMAT, sink->segment.start, sink->segment.last_stop);
3882 /* The subclass must have converted the segment to the processing format
3884 if (res && seeksegment.format != dest_format) {
3885 GST_DEBUG_OBJECT (sink, "Subclass failed to prepare a seek segment "
3886 "in the correct format. Aborting seek.");
3890 /* if successfull seek, we update our real segment and push
3891 * out the new segment. */
3893 memcpy (&sink->segment, &seeksegment, sizeof (GstSegment));
3895 if (sink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3896 gst_element_post_message (GST_ELEMENT (sink),
3897 gst_message_new_segment_start (GST_OBJECT (sink),
3898 sink->segment.format, sink->segment.last_stop));
3902 sink->priv->discont = TRUE;
3903 sink->running = TRUE;
3905 GST_PAD_STREAM_UNLOCK (pad);
3911 set_step_info (GstBaseSink * sink, GstStepInfo * current, GstStepInfo * pending,
3912 guint seqnum, GstFormat format, guint64 amount, gdouble rate,
3913 gboolean flush, gboolean intermediate)
3915 GST_OBJECT_LOCK (sink);
3916 pending->seqnum = seqnum;
3917 pending->format = format;
3918 pending->amount = amount;
3919 pending->position = 0;
3920 pending->rate = rate;
3921 pending->flush = flush;
3922 pending->intermediate = intermediate;
3923 pending->valid = TRUE;
3924 /* flush invalidates the current stepping segment */
3926 current->valid = FALSE;
3927 GST_OBJECT_UNLOCK (sink);
3931 gst_base_sink_perform_step (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3933 GstBaseSinkPrivate *priv;
3934 GstBaseSinkClass *bclass;
3935 gboolean flush, intermediate;
3940 GstStepInfo *pending, *current;
3941 GstMessage *message;
3943 bclass = GST_BASE_SINK_GET_CLASS (sink);
3946 GST_DEBUG_OBJECT (sink, "performing step with event %p", event);
3948 gst_event_parse_step (event, &format, &amount, &rate, &flush, &intermediate);
3949 seqnum = gst_event_get_seqnum (event);
3951 pending = &priv->pending_step;
3952 current = &priv->current_step;
3954 /* post message first */
3955 message = gst_message_new_step_start (GST_OBJECT (sink), FALSE, format,
3956 amount, rate, flush, intermediate);
3957 gst_message_set_seqnum (message, seqnum);
3958 gst_element_post_message (GST_ELEMENT (sink), message);
3961 /* we need to call ::unlock before locking PREROLL_LOCK
3962 * since we lock it before going into ::render */
3964 bclass->unlock (sink);
3966 GST_BASE_SINK_PREROLL_LOCK (sink);
3967 /* now that we have the PREROLL lock, clear our unlock request */
3968 if (bclass->unlock_stop)
3969 bclass->unlock_stop (sink);
3971 /* update the stepinfo and make it valid */
3972 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3975 if (sink->priv->async_enabled) {
3976 /* and we need to commit our state again on the next
3977 * prerolled buffer */
3978 sink->playing_async = TRUE;
3979 priv->pending_step.need_preroll = TRUE;
3980 sink->need_preroll = FALSE;
3981 gst_element_lost_state_full (GST_ELEMENT_CAST (sink), FALSE);
3983 sink->priv->have_latency = TRUE;
3984 sink->need_preroll = FALSE;
3986 priv->current_sstart = GST_CLOCK_TIME_NONE;
3987 priv->current_sstop = GST_CLOCK_TIME_NONE;
3988 priv->eos_rtime = GST_CLOCK_TIME_NONE;
3989 priv->call_preroll = TRUE;
3990 gst_base_sink_set_last_buffer (sink, NULL);
3991 gst_base_sink_reset_qos (sink);
3993 if (sink->clock_id) {
3994 gst_clock_id_unschedule (sink->clock_id);
3997 if (sink->have_preroll) {
3998 GST_DEBUG_OBJECT (sink, "signal waiter");
3999 priv->step_unlock = TRUE;
4000 GST_BASE_SINK_PREROLL_SIGNAL (sink);
4002 GST_BASE_SINK_PREROLL_UNLOCK (sink);
4004 /* update the stepinfo and make it valid */
4005 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
4015 gst_base_sink_loop (GstPad * pad)
4017 GstBaseSink *basesink;
4018 GstBuffer *buf = NULL;
4019 GstFlowReturn result;
4023 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
4025 g_assert (basesink->pad_mode == GST_ACTIVATE_PULL);
4027 if ((blocksize = basesink->priv->blocksize) == 0)
4030 offset = basesink->segment.last_stop;
4032 GST_DEBUG_OBJECT (basesink, "pulling %" G_GUINT64_FORMAT ", %u",
4035 result = gst_pad_pull_range (pad, offset, blocksize, &buf);
4036 if (G_UNLIKELY (result != GST_FLOW_OK))
4039 if (G_UNLIKELY (buf == NULL))
4042 offset += gst_buffer_get_size (buf);
4044 gst_segment_set_last_stop (&basesink->segment, GST_FORMAT_BYTES, offset);
4046 GST_BASE_SINK_PREROLL_LOCK (basesink);
4047 result = gst_base_sink_chain_unlocked (basesink, pad, _PR_IS_BUFFER, buf);
4048 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4049 if (G_UNLIKELY (result != GST_FLOW_OK))
4057 GST_LOG_OBJECT (basesink, "pausing task, reason %s",
4058 gst_flow_get_name (result));
4059 gst_pad_pause_task (pad);
4060 if (result == GST_FLOW_UNEXPECTED) {
4061 /* perform EOS logic */
4062 if (basesink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
4063 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4064 gst_message_new_segment_done (GST_OBJECT_CAST (basesink),
4065 basesink->segment.format, basesink->segment.last_stop));
4067 gst_base_sink_event (pad, gst_event_new_eos ());
4069 } else if (result == GST_FLOW_NOT_LINKED || result <= GST_FLOW_UNEXPECTED) {
4070 /* for fatal errors we post an error message, post the error
4071 * first so the app knows about the error first.
4072 * wrong-state is not a fatal error because it happens due to
4073 * flushing and posting an error message in that case is the
4074 * wrong thing to do, e.g. when basesrc is doing a flushing
4076 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
4077 (_("Internal data stream error.")),
4078 ("stream stopped, reason %s", gst_flow_get_name (result)));
4079 gst_base_sink_event (pad, gst_event_new_eos ());
4085 GST_LOG_OBJECT (basesink, "no buffer, pausing");
4086 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
4087 (_("Internal data flow error.")), ("element returned NULL buffer"));
4088 result = GST_FLOW_ERROR;
4094 gst_base_sink_set_flushing (GstBaseSink * basesink, GstPad * pad,
4097 GstBaseSinkClass *bclass;
4099 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4102 /* unlock any subclasses, we need to do this before grabbing the
4103 * PREROLL_LOCK since we hold this lock before going into ::render. */
4105 bclass->unlock (basesink);
4108 GST_BASE_SINK_PREROLL_LOCK (basesink);
4109 basesink->flushing = flushing;
4111 /* step 1, now that we have the PREROLL lock, clear our unlock request */
4112 if (bclass->unlock_stop)
4113 bclass->unlock_stop (basesink);
4115 /* set need_preroll before we unblock the clock. If the clock is unblocked
4116 * before timing out, we can reuse the buffer for preroll. */
4117 basesink->need_preroll = TRUE;
4119 /* step 2, unblock clock sync (if any) or any other blocking thing */
4120 if (basesink->clock_id) {
4121 gst_clock_id_unschedule (basesink->clock_id);
4124 /* flush out the data thread if it's locked in finish_preroll, this will
4125 * also flush out the EOS state */
4126 GST_DEBUG_OBJECT (basesink,
4127 "flushing out data thread, need preroll to TRUE");
4128 gst_base_sink_preroll_queue_flush (basesink, pad);
4130 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4136 gst_base_sink_default_activate_pull (GstBaseSink * basesink, gboolean active)
4142 result = gst_pad_start_task (basesink->sinkpad,
4143 (GstTaskFunction) gst_base_sink_loop, basesink->sinkpad);
4145 /* step 2, make sure streaming finishes */
4146 result = gst_pad_stop_task (basesink->sinkpad);
4153 gst_base_sink_pad_activate (GstPad * pad)
4155 gboolean result = FALSE;
4156 GstBaseSink *basesink;
4158 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4160 GST_DEBUG_OBJECT (basesink, "Trying pull mode first");
4162 gst_base_sink_set_flushing (basesink, pad, FALSE);
4164 /* we need to have the pull mode enabled */
4165 if (!basesink->can_activate_pull) {
4166 GST_DEBUG_OBJECT (basesink, "pull mode disabled");
4170 /* check if downstreams supports pull mode at all */
4171 if (!gst_pad_check_pull_range (pad)) {
4172 GST_DEBUG_OBJECT (basesink, "pull mode not supported");
4176 /* set the pad mode before starting the task so that it's in the
4177 * correct state for the new thread. also the sink set_caps and get_caps
4178 * function checks this */
4179 basesink->pad_mode = GST_ACTIVATE_PULL;
4181 /* we first try to negotiate a format so that when we try to activate
4182 * downstream, it knows about our format */
4183 if (!gst_base_sink_negotiate_pull (basesink)) {
4184 GST_DEBUG_OBJECT (basesink, "failed to negotiate in pull mode");
4188 /* ok activate now */
4189 if (!gst_pad_activate_pull (pad, TRUE)) {
4190 /* clear any pending caps */
4191 GST_OBJECT_LOCK (basesink);
4192 gst_caps_replace (&basesink->priv->pull_caps, NULL);
4193 GST_OBJECT_UNLOCK (basesink);
4194 GST_DEBUG_OBJECT (basesink, "failed to activate in pull mode");
4198 GST_DEBUG_OBJECT (basesink, "Success activating pull mode");
4202 /* push mode fallback */
4204 GST_DEBUG_OBJECT (basesink, "Falling back to push mode");
4205 if ((result = gst_pad_activate_push (pad, TRUE))) {
4206 GST_DEBUG_OBJECT (basesink, "Success activating push mode");
4211 GST_WARNING_OBJECT (basesink, "Could not activate pad in either mode");
4212 gst_base_sink_set_flushing (basesink, pad, TRUE);
4215 gst_object_unref (basesink);
4221 gst_base_sink_pad_activate_push (GstPad * pad, gboolean active)
4224 GstBaseSink *basesink;
4226 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4229 if (!basesink->can_activate_push) {
4231 basesink->pad_mode = GST_ACTIVATE_NONE;
4234 basesink->pad_mode = GST_ACTIVATE_PUSH;
4237 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH)) {
4238 g_warning ("Internal GStreamer activation error!!!");
4241 gst_base_sink_set_flushing (basesink, pad, TRUE);
4243 basesink->pad_mode = GST_ACTIVATE_NONE;
4247 gst_object_unref (basesink);
4253 gst_base_sink_negotiate_pull (GstBaseSink * basesink)
4260 /* this returns the intersection between our caps and the peer caps. If there
4261 * is no peer, it returns NULL and we can't operate in pull mode so we can
4262 * fail the negotiation. */
4263 caps = gst_pad_get_allowed_caps (GST_BASE_SINK_PAD (basesink));
4264 if (caps == NULL || gst_caps_is_empty (caps))
4265 goto no_caps_possible;
4267 GST_DEBUG_OBJECT (basesink, "allowed caps: %" GST_PTR_FORMAT, caps);
4269 caps = gst_caps_make_writable (caps);
4270 /* get the first (prefered) format */
4271 gst_caps_truncate (caps);
4273 GST_DEBUG_OBJECT (basesink, "have caps: %" GST_PTR_FORMAT, caps);
4275 if (gst_caps_is_any (caps)) {
4276 GST_DEBUG_OBJECT (basesink, "caps were ANY after fixating, "
4278 /* neither side has template caps in this case, so they are prepared for
4279 pull() without setcaps() */
4283 gst_pad_fixate_caps (GST_BASE_SINK_PAD (basesink), caps);
4284 GST_DEBUG_OBJECT (basesink, "fixated to: %" GST_PTR_FORMAT, caps);
4286 if (gst_caps_is_fixed (caps)) {
4287 if (!gst_pad_set_caps (GST_BASE_SINK_PAD (basesink), caps))
4288 goto could_not_set_caps;
4290 GST_OBJECT_LOCK (basesink);
4291 gst_caps_replace (&basesink->priv->pull_caps, caps);
4292 GST_OBJECT_UNLOCK (basesink);
4298 gst_caps_unref (caps);
4304 GST_INFO_OBJECT (basesink, "Pipeline could not agree on caps");
4305 GST_DEBUG_OBJECT (basesink, "get_allowed_caps() returned EMPTY");
4307 gst_caps_unref (caps);
4312 GST_INFO_OBJECT (basesink, "Could not set caps: %" GST_PTR_FORMAT, caps);
4313 gst_caps_unref (caps);
4318 /* this won't get called until we implement an activate function */
4320 gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active)
4322 gboolean result = FALSE;
4323 GstBaseSink *basesink;
4324 GstBaseSinkClass *bclass;
4326 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4327 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4333 /* we mark we have a newsegment here because pull based
4334 * mode works just fine without having a newsegment before the
4336 format = GST_FORMAT_BYTES;
4338 gst_segment_init (&basesink->segment, format);
4339 gst_segment_init (basesink->clip_segment, format);
4340 GST_OBJECT_LOCK (basesink);
4341 basesink->have_newsegment = TRUE;
4342 GST_OBJECT_UNLOCK (basesink);
4344 /* get the peer duration in bytes */
4345 result = gst_pad_query_peer_duration (pad, &format, &duration);
4347 GST_DEBUG_OBJECT (basesink,
4348 "setting duration in bytes to %" G_GINT64_FORMAT, duration);
4349 gst_segment_set_duration (basesink->clip_segment, format, duration);
4350 gst_segment_set_duration (&basesink->segment, format, duration);
4352 GST_DEBUG_OBJECT (basesink, "unknown duration");
4355 if (bclass->activate_pull)
4356 result = bclass->activate_pull (basesink, TRUE);
4361 goto activate_failed;
4364 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PULL)) {
4365 g_warning ("Internal GStreamer activation error!!!");
4368 result = gst_base_sink_set_flushing (basesink, pad, TRUE);
4369 if (bclass->activate_pull)
4370 result &= bclass->activate_pull (basesink, FALSE);
4371 basesink->pad_mode = GST_ACTIVATE_NONE;
4372 /* clear any pending caps */
4373 GST_OBJECT_LOCK (basesink);
4374 gst_caps_replace (&basesink->priv->pull_caps, NULL);
4375 GST_OBJECT_UNLOCK (basesink);
4378 gst_object_unref (basesink);
4385 /* reset, as starting the thread failed */
4386 basesink->pad_mode = GST_ACTIVATE_NONE;
4388 GST_ERROR_OBJECT (basesink, "subclass failed to activate in pull mode");
4393 /* send an event to our sinkpad peer. */
4395 gst_base_sink_send_event (GstElement * element, GstEvent * event)
4398 GstBaseSink *basesink = GST_BASE_SINK (element);
4399 gboolean forward, result = TRUE;
4400 GstActivateMode mode;
4402 GST_OBJECT_LOCK (element);
4403 /* get the pad and the scheduling mode */
4404 pad = gst_object_ref (basesink->sinkpad);
4405 mode = basesink->pad_mode;
4406 GST_OBJECT_UNLOCK (element);
4408 /* only push UPSTREAM events upstream */
4409 forward = GST_EVENT_IS_UPSTREAM (event);
4411 GST_DEBUG_OBJECT (basesink, "handling event %p %" GST_PTR_FORMAT, event,
4414 switch (GST_EVENT_TYPE (event)) {
4415 case GST_EVENT_LATENCY:
4417 GstClockTime latency;
4419 gst_event_parse_latency (event, &latency);
4421 /* store the latency. We use this to adjust the running_time before syncing
4422 * it to the clock. */
4423 GST_OBJECT_LOCK (element);
4424 basesink->priv->latency = latency;
4425 if (!basesink->priv->have_latency)
4427 GST_OBJECT_UNLOCK (element);
4428 GST_DEBUG_OBJECT (basesink, "latency set to %" GST_TIME_FORMAT,
4429 GST_TIME_ARGS (latency));
4431 /* We forward this event so that all elements know about the global pipeline
4432 * latency. This is interesting for an element when it wants to figure out
4433 * when a particular piece of data will be rendered. */
4436 case GST_EVENT_SEEK:
4437 /* in pull mode we will execute the seek */
4438 if (mode == GST_ACTIVATE_PULL)
4439 result = gst_base_sink_perform_seek (basesink, pad, event);
4441 case GST_EVENT_STEP:
4442 result = gst_base_sink_perform_step (basesink, pad, event);
4450 result = gst_pad_push_event (pad, event);
4452 /* not forwarded, unref the event */
4453 gst_event_unref (event);
4456 gst_object_unref (pad);
4461 gst_base_sink_get_position (GstBaseSink * basesink, GstFormat format,
4462 gint64 * cur, gboolean * upstream)
4464 GstClock *clock = NULL;
4465 gboolean res = FALSE;
4466 GstFormat oformat, tformat;
4467 GstSegment *segment;
4468 GstClockTime now, latency;
4469 GstClockTimeDiff base;
4470 gint64 time, accum, duration;
4473 gboolean last_seen, with_clock, in_paused;
4475 GST_OBJECT_LOCK (basesink);
4476 /* we can only get the segment when we are not NULL or READY */
4477 if (!basesink->have_newsegment)
4481 /* when not in PLAYING or when we're busy with a state change, we
4482 * cannot read from the clock so we report time based on the
4483 * last seen timestamp. */
4484 if (GST_STATE (basesink) != GST_STATE_PLAYING ||
4485 GST_STATE_PENDING (basesink) != GST_STATE_VOID_PENDING) {
4489 /* we don't use the clip segment in pull mode, when seeking we update the
4490 * main segment directly with the new segment values without it having to be
4491 * activated by the rendering after preroll */
4492 if (basesink->pad_mode == GST_ACTIVATE_PUSH)
4493 segment = basesink->clip_segment;
4495 segment = &basesink->segment;
4497 /* our intermediate time format */
4498 tformat = GST_FORMAT_TIME;
4499 /* get the format in the segment */
4500 oformat = segment->format;
4502 /* report with last seen position when EOS */
4503 last_seen = basesink->eos;
4505 /* assume we will use the clock for getting the current position */
4507 if (basesink->sync == FALSE)
4510 /* and we need a clock */
4511 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (basesink)) == NULL))
4514 gst_object_ref (clock);
4516 /* collect all data we need holding the lock */
4517 if (GST_CLOCK_TIME_IS_VALID (segment->time))
4518 time = segment->time;
4522 if (GST_CLOCK_TIME_IS_VALID (segment->stop))
4523 duration = segment->stop - segment->start;
4527 accum = segment->accum;
4528 rate = segment->rate * segment->applied_rate;
4529 latency = basesink->priv->latency;
4531 if (oformat == GST_FORMAT_TIME) {
4534 start = basesink->priv->current_sstart;
4535 stop = basesink->priv->current_sstop;
4538 /* in paused we use the last position as a lower bound */
4539 if (stop == -1 || segment->rate > 0.0)
4544 /* in playing, use last stop time as upper bound */
4545 if (start == -1 || segment->rate > 0.0)
4551 /* convert last stop to stream time */
4552 last = gst_segment_to_stream_time (segment, oformat, segment->last_stop);
4556 /* in paused, use start_time */
4557 base = GST_ELEMENT_START_TIME (basesink);
4558 GST_DEBUG_OBJECT (basesink, "in paused, using start time %" GST_TIME_FORMAT,
4559 GST_TIME_ARGS (base));
4560 } else if (with_clock) {
4561 /* else use clock when needed */
4562 base = GST_ELEMENT_CAST (basesink)->base_time;
4563 GST_DEBUG_OBJECT (basesink, "using clock and base time %" GST_TIME_FORMAT,
4564 GST_TIME_ARGS (base));
4566 /* else, no sync or clock -> no base time */
4567 GST_DEBUG_OBJECT (basesink, "no sync or no clock");
4571 /* no base, we can't calculate running_time, use last seem timestamp to report
4576 /* need to release the object lock before we can get the time,
4577 * a clock might take the LOCK of the provider, which could be
4578 * a basesink subclass. */
4579 GST_OBJECT_UNLOCK (basesink);
4582 /* in EOS or when no valid stream_time, report the value of last seen
4585 /* no timestamp, we need to ask upstream */
4586 GST_DEBUG_OBJECT (basesink, "no last seen timestamp, asking upstream");
4591 GST_DEBUG_OBJECT (basesink, "using last seen timestamp %" GST_TIME_FORMAT,
4592 GST_TIME_ARGS (last));
4595 if (oformat != tformat) {
4596 /* convert accum, time and duration to time */
4597 if (!gst_pad_query_convert (basesink->sinkpad, oformat, accum, &tformat,
4599 goto convert_failed;
4600 if (!gst_pad_query_convert (basesink->sinkpad, oformat, duration,
4601 &tformat, &duration))
4602 goto convert_failed;
4603 if (!gst_pad_query_convert (basesink->sinkpad, oformat, time, &tformat,
4605 goto convert_failed;
4606 if (!gst_pad_query_convert (basesink->sinkpad, oformat, last, &tformat,
4608 goto convert_failed;
4610 /* assume time format from now on */
4614 if (!in_paused && with_clock) {
4615 now = gst_clock_get_time (clock);
4621 /* subtract base time and accumulated time from the clock time.
4622 * Make sure we don't go negative. This is the current time in
4623 * the segment which we need to scale with the combined
4624 * rate and applied rate. */
4627 if (GST_CLOCK_DIFF (base, now) < 0)
4630 /* for negative rates we need to count back from the segment
4635 *cur = time + gst_guint64_to_gdouble (now - base) * rate;
4638 /* never report less than segment values in paused */
4640 *cur = MAX (last, *cur);
4642 /* never report more than last seen position in playing */
4644 *cur = MIN (last, *cur);
4647 GST_DEBUG_OBJECT (basesink,
4648 "now %" GST_TIME_FORMAT " - base %" GST_TIME_FORMAT " - accum %"
4649 GST_TIME_FORMAT " + time %" GST_TIME_FORMAT " last %" GST_TIME_FORMAT,
4650 GST_TIME_ARGS (now), GST_TIME_ARGS (base), GST_TIME_ARGS (accum),
4651 GST_TIME_ARGS (time), GST_TIME_ARGS (last));
4654 if (oformat != format) {
4655 /* convert to final format */
4656 if (!gst_pad_query_convert (basesink->sinkpad, oformat, *cur, &format, cur))
4657 goto convert_failed;
4663 GST_DEBUG_OBJECT (basesink, "res: %d, POSITION: %" GST_TIME_FORMAT,
4664 res, GST_TIME_ARGS (*cur));
4667 gst_object_unref (clock);
4674 /* in NULL or READY we always return FALSE and -1 */
4675 GST_DEBUG_OBJECT (basesink, "position in wrong state, return -1");
4678 GST_OBJECT_UNLOCK (basesink);
4683 GST_DEBUG_OBJECT (basesink, "convert failed, try upstream");
4691 gst_base_sink_get_duration (GstBaseSink * basesink, GstFormat format,
4692 gint64 * dur, gboolean * upstream)
4694 gboolean res = FALSE;
4696 if (basesink->pad_mode == GST_ACTIVATE_PULL) {
4697 GstFormat uformat = GST_FORMAT_BYTES;
4700 /* get the duration in bytes, in pull mode that's all we are sure to
4701 * know. We have to explicitly get this value from upstream instead of
4702 * using our cached value because it might change. Duration caching
4703 * should be done at a higher level. */
4704 res = gst_pad_query_peer_duration (basesink->sinkpad, &uformat, &uduration);
4706 gst_segment_set_duration (&basesink->segment, uformat, uduration);
4707 if (format != uformat) {
4708 /* convert to the requested format */
4709 res = gst_pad_query_convert (basesink->sinkpad, uformat, uduration,
4723 static const GstQueryType *
4724 gst_base_sink_get_query_types (GstElement * element)
4726 static const GstQueryType query_types[] = {
4738 gst_base_sink_query (GstElement * element, GstQuery * query)
4740 gboolean res = FALSE;
4742 GstBaseSink *basesink = GST_BASE_SINK (element);
4744 switch (GST_QUERY_TYPE (query)) {
4745 case GST_QUERY_POSITION:
4749 gboolean upstream = FALSE;
4751 gst_query_parse_position (query, &format, NULL);
4753 GST_DEBUG_OBJECT (basesink, "position query in format %s",
4754 gst_format_get_name (format));
4756 /* first try to get the position based on the clock */
4758 gst_base_sink_get_position (basesink, format, &cur, &upstream))) {
4759 gst_query_set_position (query, format, cur);
4760 } else if (upstream) {
4761 /* fallback to peer query */
4762 res = gst_pad_peer_query (basesink->sinkpad, query);
4765 /* we can handle a few things if upstream failed */
4766 if (format == GST_FORMAT_PERCENT) {
4768 GstFormat uformat = GST_FORMAT_TIME;
4770 res = gst_base_sink_get_position (basesink, GST_FORMAT_TIME, &cur,
4772 if (!res && upstream) {
4773 res = gst_pad_query_peer_position (basesink->sinkpad, &uformat,
4777 res = gst_base_sink_get_duration (basesink, GST_FORMAT_TIME, &dur,
4779 if (!res && upstream) {
4780 res = gst_pad_query_peer_duration (basesink->sinkpad, &uformat,
4787 pos = gst_util_uint64_scale (100 * GST_FORMAT_PERCENT_SCALE, cur,
4789 gst_query_set_position (query, GST_FORMAT_PERCENT, pos);
4795 case GST_QUERY_DURATION:
4799 gboolean upstream = FALSE;
4801 gst_query_parse_duration (query, &format, NULL);
4803 GST_DEBUG_OBJECT (basesink, "duration query in format %s",
4804 gst_format_get_name (format));
4807 gst_base_sink_get_duration (basesink, format, &dur, &upstream))) {
4808 gst_query_set_duration (query, format, dur);
4809 } else if (upstream) {
4810 /* fallback to peer query */
4811 res = gst_pad_peer_query (basesink->sinkpad, query);
4814 /* we can handle a few things if upstream failed */
4815 if (format == GST_FORMAT_PERCENT) {
4816 gst_query_set_duration (query, GST_FORMAT_PERCENT,
4817 GST_FORMAT_PERCENT_MAX);
4823 case GST_QUERY_LATENCY:
4825 gboolean live, us_live;
4826 GstClockTime min, max;
4828 if ((res = gst_base_sink_query_latency (basesink, &live, &us_live, &min,
4830 gst_query_set_latency (query, live, min, max);
4834 case GST_QUERY_JITTER:
4836 case GST_QUERY_RATE:
4837 /* gst_query_set_rate (query, basesink->segment_rate); */
4840 case GST_QUERY_SEGMENT:
4842 if (basesink->pad_mode == GST_ACTIVATE_PULL) {
4843 gst_query_set_segment (query, basesink->segment.rate,
4844 GST_FORMAT_TIME, basesink->segment.start, basesink->segment.stop);
4847 res = gst_pad_peer_query (basesink->sinkpad, query);
4851 case GST_QUERY_SEEKING:
4852 case GST_QUERY_CONVERT:
4853 case GST_QUERY_FORMATS:
4855 res = gst_pad_peer_query (basesink->sinkpad, query);
4858 GST_DEBUG_OBJECT (basesink, "query %s returns %d",
4859 GST_QUERY_TYPE_NAME (query), res);
4863 static GstStateChangeReturn
4864 gst_base_sink_change_state (GstElement * element, GstStateChange transition)
4866 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
4867 GstBaseSink *basesink = GST_BASE_SINK (element);
4868 GstBaseSinkClass *bclass;
4869 GstBaseSinkPrivate *priv;
4871 priv = basesink->priv;
4873 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4875 switch (transition) {
4876 case GST_STATE_CHANGE_NULL_TO_READY:
4878 if (!bclass->start (basesink))
4881 case GST_STATE_CHANGE_READY_TO_PAUSED:
4882 /* need to complete preroll before this state change completes, there
4883 * is no data flow in READY so we can safely assume we need to preroll. */
4884 GST_BASE_SINK_PREROLL_LOCK (basesink);
4885 GST_DEBUG_OBJECT (basesink, "READY to PAUSED");
4886 basesink->have_newsegment = FALSE;
4887 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
4888 gst_segment_init (basesink->clip_segment, GST_FORMAT_UNDEFINED);
4889 basesink->offset = 0;
4890 basesink->have_preroll = FALSE;
4891 priv->step_unlock = FALSE;
4892 basesink->need_preroll = TRUE;
4893 basesink->playing_async = TRUE;
4894 priv->current_sstart = GST_CLOCK_TIME_NONE;
4895 priv->current_sstop = GST_CLOCK_TIME_NONE;
4896 priv->eos_rtime = GST_CLOCK_TIME_NONE;
4898 basesink->eos = FALSE;
4899 priv->received_eos = FALSE;
4900 gst_base_sink_reset_qos (basesink);
4901 priv->commited = FALSE;
4902 priv->call_preroll = TRUE;
4903 priv->current_step.valid = FALSE;
4904 priv->pending_step.valid = FALSE;
4905 if (priv->async_enabled) {
4906 GST_DEBUG_OBJECT (basesink, "doing async state change");
4907 /* when async enabled, post async-start message and return ASYNC from
4908 * the state change function */
4909 ret = GST_STATE_CHANGE_ASYNC;
4910 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4911 gst_message_new_async_start (GST_OBJECT_CAST (basesink), FALSE));
4913 priv->have_latency = TRUE;
4915 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4917 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
4918 GST_BASE_SINK_PREROLL_LOCK (basesink);
4919 if (!gst_base_sink_needs_preroll (basesink)) {
4920 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, don't need preroll");
4921 /* no preroll needed anymore now. */
4922 basesink->playing_async = FALSE;
4923 basesink->need_preroll = FALSE;
4924 if (basesink->eos) {
4925 GstMessage *message;
4927 /* need to post EOS message here */
4928 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
4929 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
4930 gst_message_set_seqnum (message, basesink->priv->seqnum);
4931 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
4933 GST_DEBUG_OBJECT (basesink, "signal preroll");
4934 GST_BASE_SINK_PREROLL_SIGNAL (basesink);
4937 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, we are not prerolled");
4938 basesink->need_preroll = TRUE;
4939 basesink->playing_async = TRUE;
4940 priv->call_preroll = TRUE;
4941 priv->commited = FALSE;
4942 if (priv->async_enabled) {
4943 GST_DEBUG_OBJECT (basesink, "doing async state change");
4944 ret = GST_STATE_CHANGE_ASYNC;
4945 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4946 gst_message_new_async_start (GST_OBJECT_CAST (basesink), FALSE));
4949 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4956 GstStateChangeReturn bret;
4958 bret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
4959 if (G_UNLIKELY (bret == GST_STATE_CHANGE_FAILURE))
4960 goto activate_failed;
4963 switch (transition) {
4964 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
4965 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED");
4966 /* FIXME, make sure we cannot enter _render first */
4968 /* we need to call ::unlock before locking PREROLL_LOCK
4969 * since we lock it before going into ::render */
4971 bclass->unlock (basesink);
4973 GST_BASE_SINK_PREROLL_LOCK (basesink);
4974 GST_DEBUG_OBJECT (basesink, "got preroll lock");
4975 /* now that we have the PREROLL lock, clear our unlock request */
4976 if (bclass->unlock_stop)
4977 bclass->unlock_stop (basesink);
4979 /* we need preroll again and we set the flag before unlocking the clockid
4980 * because if the clockid is unlocked before a current buffer expired, we
4981 * can use that buffer to preroll with */
4982 basesink->need_preroll = TRUE;
4984 if (basesink->clock_id) {
4985 GST_DEBUG_OBJECT (basesink, "unschedule clock");
4986 gst_clock_id_unschedule (basesink->clock_id);
4989 /* if we don't have a preroll buffer we need to wait for a preroll and
4991 if (!gst_base_sink_needs_preroll (basesink)) {
4992 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED, we are prerolled");
4993 basesink->playing_async = FALSE;
4995 if (GST_STATE_TARGET (GST_ELEMENT (basesink)) <= GST_STATE_READY) {
4996 GST_DEBUG_OBJECT (basesink, "element is <= READY");
4997 ret = GST_STATE_CHANGE_SUCCESS;
4999 GST_DEBUG_OBJECT (basesink,
5000 "PLAYING to PAUSED, we are not prerolled");
5001 basesink->playing_async = TRUE;
5002 priv->commited = FALSE;
5003 priv->call_preroll = TRUE;
5004 if (priv->async_enabled) {
5005 GST_DEBUG_OBJECT (basesink, "doing async state change");
5006 ret = GST_STATE_CHANGE_ASYNC;
5007 gst_element_post_message (GST_ELEMENT_CAST (basesink),
5008 gst_message_new_async_start (GST_OBJECT_CAST (basesink),
5013 GST_DEBUG_OBJECT (basesink, "rendered: %" G_GUINT64_FORMAT
5014 ", dropped: %" G_GUINT64_FORMAT, priv->rendered, priv->dropped);
5016 gst_base_sink_reset_qos (basesink);
5017 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
5019 case GST_STATE_CHANGE_PAUSED_TO_READY:
5020 GST_BASE_SINK_PREROLL_LOCK (basesink);
5021 /* start by reseting our position state with the object lock so that the
5022 * position query gets the right idea. We do this before we post the
5023 * messages so that the message handlers pick this up. */
5024 GST_OBJECT_LOCK (basesink);
5025 basesink->have_newsegment = FALSE;
5026 priv->current_sstart = GST_CLOCK_TIME_NONE;
5027 priv->current_sstop = GST_CLOCK_TIME_NONE;
5028 priv->have_latency = FALSE;
5029 if (priv->cached_clock_id) {
5030 gst_clock_id_unref (priv->cached_clock_id);
5031 priv->cached_clock_id = NULL;
5033 GST_OBJECT_UNLOCK (basesink);
5035 gst_base_sink_set_last_buffer (basesink, NULL);
5036 priv->call_preroll = FALSE;
5038 if (!priv->commited) {
5039 if (priv->async_enabled) {
5040 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, posting async-done");
5042 gst_element_post_message (GST_ELEMENT_CAST (basesink),
5043 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
5044 GST_STATE_PLAYING, GST_STATE_PAUSED, GST_STATE_READY));
5046 gst_element_post_message (GST_ELEMENT_CAST (basesink),
5047 gst_message_new_async_done (GST_OBJECT_CAST (basesink)));
5049 priv->commited = TRUE;
5051 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, don't need_preroll");
5053 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
5055 case GST_STATE_CHANGE_READY_TO_NULL:
5057 if (!bclass->stop (basesink)) {
5058 GST_WARNING_OBJECT (basesink, "failed to stop");
5061 gst_base_sink_set_last_buffer (basesink, NULL);
5062 priv->call_preroll = FALSE;
5073 GST_DEBUG_OBJECT (basesink, "failed to start");
5074 return GST_STATE_CHANGE_FAILURE;
5078 GST_DEBUG_OBJECT (basesink,
5079 "element failed to change states -- activation problem?");
5080 return GST_STATE_CHANGE_FAILURE;