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 GQueue *preroll_queue;
185 gint qos_enabled; /* ATOMIC */
186 gboolean async_enabled;
187 GstClockTimeDiff ts_offset;
188 GstClockTime render_delay;
190 /* start, stop of current buffer, stream time, used to report position */
191 GstClockTime current_sstart;
192 GstClockTime current_sstop;
194 /* start, stop and jitter of current buffer, running time */
195 GstClockTime current_rstart;
196 GstClockTime current_rstop;
197 GstClockTimeDiff current_jitter;
198 /* the running time of the previous buffer */
199 GstClockTime prev_rstart;
201 /* EOS sync time in running time */
202 GstClockTime eos_rtime;
204 /* last buffer that arrived in time, running time */
205 GstClockTime last_render_time;
206 /* when the last buffer left the sink, running time */
207 GstClockTime last_left;
209 /* running averages go here these are done on running time */
211 GstClockTime avg_duration;
213 GstClockTime avg_in_diff;
215 /* these are done on system time. avg_jitter and avg_render are
216 * compared to eachother to see if the rendering time takes a
217 * huge amount of the processing, If so we are flooded with
219 GstClockTime last_left_systime;
220 GstClockTime avg_jitter;
221 GstClockTime start, stop;
222 GstClockTime avg_render;
224 /* number of rendered and dropped frames */
229 GstClockTime latency;
231 /* if we already commited the state */
233 /* state change to playing ongoing */
236 /* when we received EOS */
237 gboolean received_eos;
239 /* when we are prerolled and able to report latency */
240 gboolean have_latency;
242 /* the last buffer we prerolled or rendered. Useful for making snapshots */
243 gint enable_last_buffer; /* atomic */
244 GstBuffer *last_buffer;
246 /* caps for pull based scheduling */
249 /* blocksize for pulling */
254 /* seqnum of the stream */
257 gboolean call_preroll;
258 gboolean step_unlock;
260 /* we have a pending and a current step operation */
261 GstStepInfo current_step;
262 GstStepInfo pending_step;
264 /* Cached GstClockID */
265 GstClockID cached_clock_id;
267 /* for throttling and QoS */
268 GstClockTime earliest_in_time;
269 GstClockTime throttle_time;
274 #define DO_RUNNING_AVG(avg,val,size) (((val) + ((size)-1) * (avg)) / (size))
276 /* generic running average, this has a neutral window size */
277 #define UPDATE_RUNNING_AVG(avg,val) DO_RUNNING_AVG(avg,val,8)
279 /* the windows for these running averages are experimentally obtained.
280 * possitive values get averaged more while negative values use a small
281 * window so we can react faster to badness. */
282 #define UPDATE_RUNNING_AVG_P(avg,val) DO_RUNNING_AVG(avg,val,16)
283 #define UPDATE_RUNNING_AVG_N(avg,val) DO_RUNNING_AVG(avg,val,4)
287 _PR_IS_NOTHING = 1 << 0,
288 _PR_IS_BUFFER = 1 << 1,
289 _PR_IS_BUFFERLIST = 1 << 2,
290 _PR_IS_EVENT = 1 << 3
293 #define OBJ_IS_BUFFER(a) ((a) & _PR_IS_BUFFER)
294 #define OBJ_IS_BUFFERLIST(a) ((a) & _PR_IS_BUFFERLIST)
295 #define OBJ_IS_EVENT(a) ((a) & _PR_IS_EVENT)
296 #define OBJ_IS_BUFFERFULL(a) ((a) & (_PR_IS_BUFFER | _PR_IS_BUFFERLIST))
298 /* BaseSink properties */
300 #define DEFAULT_CAN_ACTIVATE_PULL FALSE /* fixme: enable me */
301 #define DEFAULT_CAN_ACTIVATE_PUSH TRUE
303 #define DEFAULT_PREROLL_QUEUE_LEN 0
304 #define DEFAULT_SYNC TRUE
305 #define DEFAULT_MAX_LATENESS -1
306 #define DEFAULT_QOS FALSE
307 #define DEFAULT_ASYNC TRUE
308 #define DEFAULT_TS_OFFSET 0
309 #define DEFAULT_BLOCKSIZE 4096
310 #define DEFAULT_RENDER_DELAY 0
311 #define DEFAULT_ENABLE_LAST_BUFFER TRUE
312 #define DEFAULT_THROTTLE_TIME 0
317 PROP_PREROLL_QUEUE_LEN,
323 PROP_ENABLE_LAST_BUFFER,
331 static GstElementClass *parent_class = NULL;
333 static void gst_base_sink_class_init (GstBaseSinkClass * klass);
334 static void gst_base_sink_init (GstBaseSink * trans, gpointer g_class);
335 static void gst_base_sink_finalize (GObject * object);
338 gst_base_sink_get_type (void)
340 static volatile gsize base_sink_type = 0;
342 if (g_once_init_enter (&base_sink_type)) {
344 static const GTypeInfo base_sink_info = {
345 sizeof (GstBaseSinkClass),
348 (GClassInitFunc) gst_base_sink_class_init,
351 sizeof (GstBaseSink),
353 (GInstanceInitFunc) gst_base_sink_init,
356 _type = g_type_register_static (GST_TYPE_ELEMENT,
357 "GstBaseSink", &base_sink_info, G_TYPE_FLAG_ABSTRACT);
358 g_once_init_leave (&base_sink_type, _type);
360 return base_sink_type;
363 static void gst_base_sink_set_property (GObject * object, guint prop_id,
364 const GValue * value, GParamSpec * pspec);
365 static void gst_base_sink_get_property (GObject * object, guint prop_id,
366 GValue * value, GParamSpec * pspec);
368 static gboolean gst_base_sink_send_event (GstElement * element,
370 static gboolean default_element_query (GstElement * element, GstQuery * query);
372 static GstCaps *gst_base_sink_get_caps (GstBaseSink * sink, GstCaps * caps);
373 static gboolean gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps);
374 static void gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
375 GstClockTime * start, GstClockTime * end);
376 static gboolean gst_base_sink_set_flushing (GstBaseSink * basesink,
377 GstPad * pad, gboolean flushing);
378 static gboolean gst_base_sink_default_activate_pull (GstBaseSink * basesink,
380 static gboolean gst_base_sink_default_do_seek (GstBaseSink * sink,
381 GstSegment * segment);
382 static gboolean gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
383 GstEvent * event, GstSegment * segment);
385 static GstStateChangeReturn gst_base_sink_change_state (GstElement * element,
386 GstStateChange transition);
388 static gboolean gst_base_sink_sink_query (GstPad * pad, GstObject * parent,
390 static GstFlowReturn gst_base_sink_chain (GstPad * pad, GstObject * parent,
392 static GstFlowReturn gst_base_sink_chain_list (GstPad * pad, GstObject * parent,
393 GstBufferList * list);
395 static void gst_base_sink_loop (GstPad * pad);
396 static gboolean gst_base_sink_pad_activate (GstPad * pad);
397 static gboolean gst_base_sink_pad_activate_push (GstPad * pad, gboolean active);
398 static gboolean gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active);
399 static gboolean gst_base_sink_event (GstPad * pad, GstObject * parent,
402 static gboolean default_sink_query (GstBaseSink * sink, GstQuery * query);
404 static gboolean gst_base_sink_negotiate_pull (GstBaseSink * basesink);
405 static void gst_base_sink_default_fixate (GstBaseSink * bsink, GstCaps * caps);
406 static void gst_base_sink_fixate (GstBaseSink * bsink, GstCaps * caps);
408 /* check if an object was too late */
409 static gboolean gst_base_sink_is_too_late (GstBaseSink * basesink,
410 GstMiniObject * obj, GstClockTime rstart, GstClockTime rstop,
411 GstClockReturn status, GstClockTimeDiff jitter);
412 static GstFlowReturn gst_base_sink_preroll_object (GstBaseSink * basesink,
413 guint8 obj_type, GstMiniObject * obj);
416 gst_base_sink_class_init (GstBaseSinkClass * klass)
418 GObjectClass *gobject_class;
419 GstElementClass *gstelement_class;
421 gobject_class = G_OBJECT_CLASS (klass);
422 gstelement_class = GST_ELEMENT_CLASS (klass);
424 GST_DEBUG_CATEGORY_INIT (gst_base_sink_debug, "basesink", 0,
427 g_type_class_add_private (klass, sizeof (GstBaseSinkPrivate));
429 parent_class = g_type_class_peek_parent (klass);
431 gobject_class->finalize = gst_base_sink_finalize;
432 gobject_class->set_property = gst_base_sink_set_property;
433 gobject_class->get_property = gst_base_sink_get_property;
435 g_object_class_install_property (gobject_class, PROP_SYNC,
436 g_param_spec_boolean ("sync", "Sync", "Sync on the clock", DEFAULT_SYNC,
437 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
439 g_object_class_install_property (gobject_class, PROP_MAX_LATENESS,
440 g_param_spec_int64 ("max-lateness", "Max Lateness",
441 "Maximum number of nanoseconds that a buffer can be late before it "
442 "is dropped (-1 unlimited)", -1, G_MAXINT64, DEFAULT_MAX_LATENESS,
443 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
445 g_object_class_install_property (gobject_class, PROP_QOS,
446 g_param_spec_boolean ("qos", "Qos",
447 "Generate Quality-of-Service events upstream", DEFAULT_QOS,
448 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
452 * If set to #TRUE, the basesink will perform asynchronous state changes.
453 * When set to #FALSE, the sink will not signal the parent when it prerolls.
454 * Use this option when dealing with sparse streams or when synchronisation is
459 g_object_class_install_property (gobject_class, PROP_ASYNC,
460 g_param_spec_boolean ("async", "Async",
461 "Go asynchronously to PAUSED", DEFAULT_ASYNC,
462 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
464 * GstBaseSink:ts-offset
466 * Controls the final synchronisation, a negative value will render the buffer
467 * earlier while a positive value delays playback. This property can be
468 * used to fix synchronisation in bad files.
472 g_object_class_install_property (gobject_class, PROP_TS_OFFSET,
473 g_param_spec_int64 ("ts-offset", "TS Offset",
474 "Timestamp offset in nanoseconds", G_MININT64, G_MAXINT64,
475 DEFAULT_TS_OFFSET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
478 * GstBaseSink:enable-last-buffer
480 * Enable the last-buffer property. If FALSE, basesink doesn't keep a
481 * reference to the last buffer arrived and the last-buffer property is always
482 * set to NULL. This can be useful if you need buffers to be released as soon
483 * as possible, eg. if you're using a buffer pool.
487 g_object_class_install_property (gobject_class, PROP_ENABLE_LAST_BUFFER,
488 g_param_spec_boolean ("enable-last-buffer", "Enable Last Buffer",
489 "Enable the last-buffer property", DEFAULT_ENABLE_LAST_BUFFER,
490 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
493 * GstBaseSink:last-buffer
495 * The last buffer that arrived in the sink and was used for preroll or for
496 * rendering. This property can be used to generate thumbnails. This property
497 * can be NULL when the sink has not yet received a bufer.
501 g_object_class_install_property (gobject_class, PROP_LAST_BUFFER,
502 g_param_spec_boxed ("last-buffer", "Last Buffer",
503 "The last buffer received in the sink", GST_TYPE_BUFFER,
504 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
506 * GstBaseSink:blocksize
508 * The amount of bytes to pull when operating in pull mode.
512 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
513 g_object_class_install_property (gobject_class, PROP_BLOCKSIZE,
514 g_param_spec_uint ("blocksize", "Block size",
515 "Size in bytes to pull per buffer (0 = default)", 0, G_MAXUINT,
516 DEFAULT_BLOCKSIZE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
518 * GstBaseSink:render-delay
520 * The additional delay between synchronisation and actual rendering of the
521 * media. This property will add additional latency to the device in order to
522 * make other sinks compensate for the delay.
526 g_object_class_install_property (gobject_class, PROP_RENDER_DELAY,
527 g_param_spec_uint64 ("render-delay", "Render Delay",
528 "Additional render delay of the sink in nanoseconds", 0, G_MAXUINT64,
529 DEFAULT_RENDER_DELAY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
531 * GstBaseSink:throttle-time
533 * The time to insert between buffers. This property can be used to control
534 * the maximum amount of buffers per second to render. Setting this property
535 * to a value bigger than 0 will make the sink create THROTTLE QoS events.
539 g_object_class_install_property (gobject_class, PROP_THROTTLE_TIME,
540 g_param_spec_uint64 ("throttle-time", "Throttle time",
541 "The time to keep between rendered buffers (unused)", 0, G_MAXUINT64,
542 DEFAULT_THROTTLE_TIME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
544 gstelement_class->change_state =
545 GST_DEBUG_FUNCPTR (gst_base_sink_change_state);
546 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_base_sink_send_event);
547 gstelement_class->query = GST_DEBUG_FUNCPTR (default_element_query);
549 klass->get_caps = GST_DEBUG_FUNCPTR (gst_base_sink_get_caps);
550 klass->set_caps = GST_DEBUG_FUNCPTR (gst_base_sink_set_caps);
551 klass->fixate = GST_DEBUG_FUNCPTR (gst_base_sink_default_fixate);
552 klass->activate_pull =
553 GST_DEBUG_FUNCPTR (gst_base_sink_default_activate_pull);
554 klass->get_times = GST_DEBUG_FUNCPTR (gst_base_sink_get_times);
555 klass->query = GST_DEBUG_FUNCPTR (default_sink_query);
557 /* Registering debug symbols for function pointers */
558 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_fixate);
559 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate);
560 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate_push);
561 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate_pull);
562 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_event);
563 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain);
564 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain_list);
565 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_sink_query);
569 gst_base_sink_query_caps (GstBaseSink * bsink, GstPad * pad, GstCaps * filter)
571 GstBaseSinkClass *bclass;
572 GstCaps *caps = NULL;
575 bclass = GST_BASE_SINK_GET_CLASS (bsink);
576 fixed = GST_PAD_IS_FIXED_CAPS (pad);
578 if (fixed || bsink->pad_mode == GST_PAD_MODE_PULL) {
579 /* if we are operating in pull mode or fixed caps, we only accept the
580 * currently negotiated caps */
581 caps = gst_pad_get_current_caps (pad);
584 if (bclass->get_caps)
585 caps = bclass->get_caps (bsink, filter);
588 GstPadTemplate *pad_template;
591 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass),
593 if (pad_template != NULL) {
594 caps = gst_pad_template_get_caps (pad_template);
597 GstCaps *intersection;
600 gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
601 gst_caps_unref (caps);
612 gst_base_sink_default_fixate (GstBaseSink * bsink, GstCaps * caps)
614 GST_DEBUG_OBJECT (bsink, "using default caps fixate function");
615 gst_caps_fixate (caps);
619 gst_base_sink_fixate (GstBaseSink * bsink, GstCaps * caps)
621 GstBaseSinkClass *bclass;
623 bclass = GST_BASE_SINK_GET_CLASS (bsink);
626 bclass->fixate (bsink, caps);
630 gst_base_sink_init (GstBaseSink * basesink, gpointer g_class)
632 GstPadTemplate *pad_template;
633 GstBaseSinkPrivate *priv;
635 basesink->priv = priv = GST_BASE_SINK_GET_PRIVATE (basesink);
638 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "sink");
639 g_return_if_fail (pad_template != NULL);
641 basesink->sinkpad = gst_pad_new_from_template (pad_template, "sink");
643 gst_pad_set_activate_function (basesink->sinkpad, gst_base_sink_pad_activate);
644 gst_pad_set_activatepush_function (basesink->sinkpad,
645 gst_base_sink_pad_activate_push);
646 gst_pad_set_activatepull_function (basesink->sinkpad,
647 gst_base_sink_pad_activate_pull);
648 gst_pad_set_query_function (basesink->sinkpad, gst_base_sink_sink_query);
649 gst_pad_set_event_function (basesink->sinkpad, gst_base_sink_event);
650 gst_pad_set_chain_function (basesink->sinkpad, gst_base_sink_chain);
651 gst_pad_set_chain_list_function (basesink->sinkpad, gst_base_sink_chain_list);
652 gst_element_add_pad (GST_ELEMENT_CAST (basesink), basesink->sinkpad);
654 basesink->pad_mode = GST_PAD_MODE_NONE;
655 basesink->preroll_lock = g_mutex_new ();
656 basesink->preroll_cond = g_cond_new ();
657 priv->preroll_queue = g_queue_new ();
658 priv->have_latency = FALSE;
660 basesink->can_activate_push = DEFAULT_CAN_ACTIVATE_PUSH;
661 basesink->can_activate_pull = DEFAULT_CAN_ACTIVATE_PULL;
663 basesink->sync = DEFAULT_SYNC;
664 basesink->max_lateness = DEFAULT_MAX_LATENESS;
665 g_atomic_int_set (&priv->qos_enabled, DEFAULT_QOS);
666 priv->async_enabled = DEFAULT_ASYNC;
667 priv->ts_offset = DEFAULT_TS_OFFSET;
668 priv->render_delay = DEFAULT_RENDER_DELAY;
669 priv->blocksize = DEFAULT_BLOCKSIZE;
670 priv->cached_clock_id = NULL;
671 g_atomic_int_set (&priv->enable_last_buffer, DEFAULT_ENABLE_LAST_BUFFER);
672 priv->throttle_time = DEFAULT_THROTTLE_TIME;
674 GST_OBJECT_FLAG_SET (basesink, GST_ELEMENT_IS_SINK);
678 gst_base_sink_finalize (GObject * object)
680 GstBaseSink *basesink;
682 basesink = GST_BASE_SINK (object);
684 g_mutex_free (basesink->preroll_lock);
685 g_cond_free (basesink->preroll_cond);
686 g_queue_free (basesink->priv->preroll_queue);
688 G_OBJECT_CLASS (parent_class)->finalize (object);
692 * gst_base_sink_set_sync:
694 * @sync: the new sync value.
696 * Configures @sink to synchronize on the clock or not. When
697 * @sync is FALSE, incoming samples will be played as fast as
698 * possible. If @sync is TRUE, the timestamps of the incomming
699 * buffers will be used to schedule the exact render time of its
705 gst_base_sink_set_sync (GstBaseSink * sink, gboolean sync)
707 g_return_if_fail (GST_IS_BASE_SINK (sink));
709 GST_OBJECT_LOCK (sink);
711 GST_OBJECT_UNLOCK (sink);
715 * gst_base_sink_get_sync:
718 * Checks if @sink is currently configured to synchronize against the
721 * Returns: TRUE if the sink is configured to synchronize against the clock.
726 gst_base_sink_get_sync (GstBaseSink * sink)
730 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
732 GST_OBJECT_LOCK (sink);
734 GST_OBJECT_UNLOCK (sink);
740 * gst_base_sink_set_max_lateness:
742 * @max_lateness: the new max lateness value.
744 * Sets the new max lateness value to @max_lateness. This value is
745 * used to decide if a buffer should be dropped or not based on the
746 * buffer timestamp and the current clock time. A value of -1 means
752 gst_base_sink_set_max_lateness (GstBaseSink * sink, gint64 max_lateness)
754 g_return_if_fail (GST_IS_BASE_SINK (sink));
756 GST_OBJECT_LOCK (sink);
757 sink->max_lateness = max_lateness;
758 GST_OBJECT_UNLOCK (sink);
762 * gst_base_sink_get_max_lateness:
765 * Gets the max lateness value. See gst_base_sink_set_max_lateness for
768 * Returns: The maximum time in nanoseconds that a buffer can be late
769 * before it is dropped and not rendered. A value of -1 means an
775 gst_base_sink_get_max_lateness (GstBaseSink * sink)
779 g_return_val_if_fail (GST_IS_BASE_SINK (sink), -1);
781 GST_OBJECT_LOCK (sink);
782 res = sink->max_lateness;
783 GST_OBJECT_UNLOCK (sink);
789 * gst_base_sink_set_qos_enabled:
791 * @enabled: the new qos value.
793 * Configures @sink to send Quality-of-Service events upstream.
798 gst_base_sink_set_qos_enabled (GstBaseSink * sink, gboolean enabled)
800 g_return_if_fail (GST_IS_BASE_SINK (sink));
802 g_atomic_int_set (&sink->priv->qos_enabled, enabled);
806 * gst_base_sink_is_qos_enabled:
809 * Checks if @sink is currently configured to send Quality-of-Service events
812 * Returns: TRUE if the sink is configured to perform Quality-of-Service.
817 gst_base_sink_is_qos_enabled (GstBaseSink * sink)
821 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
823 res = g_atomic_int_get (&sink->priv->qos_enabled);
829 * gst_base_sink_set_async_enabled:
831 * @enabled: the new async value.
833 * Configures @sink to perform all state changes asynchronusly. When async is
834 * disabled, the sink will immediately go to PAUSED instead of waiting for a
835 * preroll buffer. This feature is useful if the sink does not synchronize
836 * against the clock or when it is dealing with sparse streams.
841 gst_base_sink_set_async_enabled (GstBaseSink * sink, gboolean enabled)
843 g_return_if_fail (GST_IS_BASE_SINK (sink));
845 GST_BASE_SINK_PREROLL_LOCK (sink);
846 g_atomic_int_set (&sink->priv->async_enabled, enabled);
847 GST_LOG_OBJECT (sink, "set async enabled to %d", enabled);
848 GST_BASE_SINK_PREROLL_UNLOCK (sink);
852 * gst_base_sink_is_async_enabled:
855 * Checks if @sink is currently configured to perform asynchronous state
858 * Returns: TRUE if the sink is configured to perform asynchronous state
864 gst_base_sink_is_async_enabled (GstBaseSink * sink)
868 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
870 res = g_atomic_int_get (&sink->priv->async_enabled);
876 * gst_base_sink_set_ts_offset:
878 * @offset: the new offset
880 * Adjust the synchronisation of @sink with @offset. A negative value will
881 * render buffers earlier than their timestamp. A positive value will delay
882 * rendering. This function can be used to fix playback of badly timestamped
888 gst_base_sink_set_ts_offset (GstBaseSink * sink, GstClockTimeDiff offset)
890 g_return_if_fail (GST_IS_BASE_SINK (sink));
892 GST_OBJECT_LOCK (sink);
893 sink->priv->ts_offset = offset;
894 GST_LOG_OBJECT (sink, "set time offset to %" G_GINT64_FORMAT, offset);
895 GST_OBJECT_UNLOCK (sink);
899 * gst_base_sink_get_ts_offset:
902 * Get the synchronisation offset of @sink.
904 * Returns: The synchronisation offset.
909 gst_base_sink_get_ts_offset (GstBaseSink * sink)
911 GstClockTimeDiff res;
913 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
915 GST_OBJECT_LOCK (sink);
916 res = sink->priv->ts_offset;
917 GST_OBJECT_UNLOCK (sink);
923 * gst_base_sink_get_last_buffer:
926 * Get the last buffer that arrived in the sink and was used for preroll or for
927 * rendering. This property can be used to generate thumbnails.
929 * The #GstCaps on the buffer can be used to determine the type of the buffer.
931 * Free-function: gst_buffer_unref
933 * Returns: (transfer full): a #GstBuffer. gst_buffer_unref() after usage.
934 * This function returns NULL when no buffer has arrived in the sink yet
935 * or when the sink is not in PAUSED or PLAYING.
940 gst_base_sink_get_last_buffer (GstBaseSink * sink)
944 g_return_val_if_fail (GST_IS_BASE_SINK (sink), NULL);
946 GST_OBJECT_LOCK (sink);
947 if ((res = sink->priv->last_buffer))
948 gst_buffer_ref (res);
949 GST_OBJECT_UNLOCK (sink);
954 /* with OBJECT_LOCK */
956 gst_base_sink_set_last_buffer_unlocked (GstBaseSink * sink, GstBuffer * buffer)
960 old = sink->priv->last_buffer;
961 if (G_LIKELY (old != buffer)) {
962 GST_DEBUG_OBJECT (sink, "setting last buffer to %p", buffer);
963 if (G_LIKELY (buffer))
964 gst_buffer_ref (buffer);
965 sink->priv->last_buffer = buffer;
969 /* avoid unreffing with the lock because cleanup code might want to take the
971 if (G_LIKELY (old)) {
972 GST_OBJECT_UNLOCK (sink);
973 gst_buffer_unref (old);
974 GST_OBJECT_LOCK (sink);
979 gst_base_sink_set_last_buffer (GstBaseSink * sink, GstBuffer * buffer)
981 if (!g_atomic_int_get (&sink->priv->enable_last_buffer))
984 GST_OBJECT_LOCK (sink);
985 gst_base_sink_set_last_buffer_unlocked (sink, buffer);
986 GST_OBJECT_UNLOCK (sink);
990 * gst_base_sink_set_last_buffer_enabled:
992 * @enabled: the new enable-last-buffer value.
994 * Configures @sink to store the last received buffer in the last-buffer
1000 gst_base_sink_set_last_buffer_enabled (GstBaseSink * sink, gboolean enabled)
1002 g_return_if_fail (GST_IS_BASE_SINK (sink));
1004 /* Only take lock if we change the value */
1005 if (g_atomic_int_compare_and_exchange (&sink->priv->enable_last_buffer,
1006 !enabled, enabled) && !enabled) {
1007 GST_OBJECT_LOCK (sink);
1008 gst_base_sink_set_last_buffer_unlocked (sink, NULL);
1009 GST_OBJECT_UNLOCK (sink);
1014 * gst_base_sink_is_last_buffer_enabled:
1017 * Checks if @sink is currently configured to store the last received buffer in
1018 * the last-buffer property.
1020 * Returns: TRUE if the sink is configured to store the last received buffer.
1025 gst_base_sink_is_last_buffer_enabled (GstBaseSink * sink)
1027 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
1029 return g_atomic_int_get (&sink->priv->enable_last_buffer);
1033 * gst_base_sink_get_latency:
1036 * Get the currently configured latency.
1038 * Returns: The configured latency.
1043 gst_base_sink_get_latency (GstBaseSink * sink)
1047 GST_OBJECT_LOCK (sink);
1048 res = sink->priv->latency;
1049 GST_OBJECT_UNLOCK (sink);
1055 * gst_base_sink_query_latency:
1057 * @live: (out) (allow-none): if the sink is live
1058 * @upstream_live: (out) (allow-none): if an upstream element is live
1059 * @min_latency: (out) (allow-none): the min latency of the upstream elements
1060 * @max_latency: (out) (allow-none): the max latency of the upstream elements
1062 * Query the sink for the latency parameters. The latency will be queried from
1063 * the upstream elements. @live will be TRUE if @sink is configured to
1064 * synchronize against the clock. @upstream_live will be TRUE if an upstream
1067 * If both @live and @upstream_live are TRUE, the sink will want to compensate
1068 * for the latency introduced by the upstream elements by setting the
1069 * @min_latency to a strictly possitive value.
1071 * This function is mostly used by subclasses.
1073 * Returns: TRUE if the query succeeded.
1078 gst_base_sink_query_latency (GstBaseSink * sink, gboolean * live,
1079 gboolean * upstream_live, GstClockTime * min_latency,
1080 GstClockTime * max_latency)
1082 gboolean l, us_live, res, have_latency;
1083 GstClockTime min, max, render_delay;
1085 GstClockTime us_min, us_max;
1087 /* we are live when we sync to the clock */
1088 GST_OBJECT_LOCK (sink);
1090 have_latency = sink->priv->have_latency;
1091 render_delay = sink->priv->render_delay;
1092 GST_OBJECT_UNLOCK (sink);
1094 /* assume no latency */
1100 GST_DEBUG_OBJECT (sink, "we are ready for LATENCY query");
1101 /* we are ready for a latency query this is when we preroll or when we are
1103 query = gst_query_new_latency ();
1105 /* ask the peer for the latency */
1106 if ((res = gst_pad_peer_query (sink->sinkpad, query))) {
1107 /* get upstream min and max latency */
1108 gst_query_parse_latency (query, &us_live, &us_min, &us_max);
1111 /* upstream live, use its latency, subclasses should use these
1112 * values to create the complete latency. */
1117 /* we need to add the render delay if we are live */
1119 min += render_delay;
1121 max += render_delay;
1124 gst_query_unref (query);
1126 GST_DEBUG_OBJECT (sink, "we are not yet ready for LATENCY query");
1130 /* not live, we tried to do the query, if it failed we return TRUE anyway */
1134 GST_DEBUG_OBJECT (sink, "latency query failed but we are not live");
1136 GST_DEBUG_OBJECT (sink, "latency query failed and we are live");
1141 GST_DEBUG_OBJECT (sink, "latency query: live: %d, have_latency %d,"
1142 " upstream: %d, min %" GST_TIME_FORMAT ", max %" GST_TIME_FORMAT, l,
1143 have_latency, us_live, GST_TIME_ARGS (min), GST_TIME_ARGS (max));
1148 *upstream_live = us_live;
1158 * gst_base_sink_set_render_delay:
1159 * @sink: a #GstBaseSink
1160 * @delay: the new delay
1162 * Set the render delay in @sink to @delay. The render delay is the time
1163 * between actual rendering of a buffer and its synchronisation time. Some
1164 * devices might delay media rendering which can be compensated for with this
1167 * After calling this function, this sink will report additional latency and
1168 * other sinks will adjust their latency to delay the rendering of their media.
1170 * This function is usually called by subclasses.
1175 gst_base_sink_set_render_delay (GstBaseSink * sink, GstClockTime delay)
1177 GstClockTime old_render_delay;
1179 g_return_if_fail (GST_IS_BASE_SINK (sink));
1181 GST_OBJECT_LOCK (sink);
1182 old_render_delay = sink->priv->render_delay;
1183 sink->priv->render_delay = delay;
1184 GST_LOG_OBJECT (sink, "set render delay to %" GST_TIME_FORMAT,
1185 GST_TIME_ARGS (delay));
1186 GST_OBJECT_UNLOCK (sink);
1188 if (delay != old_render_delay) {
1189 GST_DEBUG_OBJECT (sink, "posting latency changed");
1190 gst_element_post_message (GST_ELEMENT_CAST (sink),
1191 gst_message_new_latency (GST_OBJECT_CAST (sink)));
1196 * gst_base_sink_get_render_delay:
1197 * @sink: a #GstBaseSink
1199 * Get the render delay of @sink. see gst_base_sink_set_render_delay() for more
1200 * information about the render delay.
1202 * Returns: the render delay of @sink.
1207 gst_base_sink_get_render_delay (GstBaseSink * sink)
1209 GstClockTimeDiff res;
1211 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1213 GST_OBJECT_LOCK (sink);
1214 res = sink->priv->render_delay;
1215 GST_OBJECT_UNLOCK (sink);
1221 * gst_base_sink_set_blocksize:
1222 * @sink: a #GstBaseSink
1223 * @blocksize: the blocksize in bytes
1225 * Set the number of bytes that the sink will pull when it is operating in pull
1230 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
1232 gst_base_sink_set_blocksize (GstBaseSink * sink, guint blocksize)
1234 g_return_if_fail (GST_IS_BASE_SINK (sink));
1236 GST_OBJECT_LOCK (sink);
1237 sink->priv->blocksize = blocksize;
1238 GST_LOG_OBJECT (sink, "set blocksize to %u", blocksize);
1239 GST_OBJECT_UNLOCK (sink);
1243 * gst_base_sink_get_blocksize:
1244 * @sink: a #GstBaseSink
1246 * Get the number of bytes that the sink will pull when it is operating in pull
1249 * Returns: the number of bytes @sink will pull in pull mode.
1253 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
1255 gst_base_sink_get_blocksize (GstBaseSink * sink)
1259 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1261 GST_OBJECT_LOCK (sink);
1262 res = sink->priv->blocksize;
1263 GST_OBJECT_UNLOCK (sink);
1269 * gst_base_sink_set_throttle_time:
1270 * @sink: a #GstBaseSink
1271 * @throttle: the throttle time in nanoseconds
1273 * Set the time that will be inserted between rendered buffers. This
1274 * can be used to control the maximum buffers per second that the sink
1280 gst_base_sink_set_throttle_time (GstBaseSink * sink, guint64 throttle)
1282 g_return_if_fail (GST_IS_BASE_SINK (sink));
1284 GST_OBJECT_LOCK (sink);
1285 sink->priv->throttle_time = throttle;
1286 GST_LOG_OBJECT (sink, "set throttle_time to %" G_GUINT64_FORMAT, throttle);
1287 GST_OBJECT_UNLOCK (sink);
1291 * gst_base_sink_get_throttle_time:
1292 * @sink: a #GstBaseSink
1294 * Get the time that will be inserted between frames to control the
1295 * maximum buffers per second.
1297 * Returns: the number of nanoseconds @sink will put between frames.
1302 gst_base_sink_get_throttle_time (GstBaseSink * sink)
1306 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1308 GST_OBJECT_LOCK (sink);
1309 res = sink->priv->throttle_time;
1310 GST_OBJECT_UNLOCK (sink);
1316 gst_base_sink_set_property (GObject * object, guint prop_id,
1317 const GValue * value, GParamSpec * pspec)
1319 GstBaseSink *sink = GST_BASE_SINK (object);
1323 gst_base_sink_set_sync (sink, g_value_get_boolean (value));
1325 case PROP_MAX_LATENESS:
1326 gst_base_sink_set_max_lateness (sink, g_value_get_int64 (value));
1329 gst_base_sink_set_qos_enabled (sink, g_value_get_boolean (value));
1332 gst_base_sink_set_async_enabled (sink, g_value_get_boolean (value));
1334 case PROP_TS_OFFSET:
1335 gst_base_sink_set_ts_offset (sink, g_value_get_int64 (value));
1337 case PROP_BLOCKSIZE:
1338 gst_base_sink_set_blocksize (sink, g_value_get_uint (value));
1340 case PROP_RENDER_DELAY:
1341 gst_base_sink_set_render_delay (sink, g_value_get_uint64 (value));
1343 case PROP_ENABLE_LAST_BUFFER:
1344 gst_base_sink_set_last_buffer_enabled (sink, g_value_get_boolean (value));
1346 case PROP_THROTTLE_TIME:
1347 gst_base_sink_set_throttle_time (sink, g_value_get_uint64 (value));
1350 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1356 gst_base_sink_get_property (GObject * object, guint prop_id, GValue * value,
1359 GstBaseSink *sink = GST_BASE_SINK (object);
1363 g_value_set_boolean (value, gst_base_sink_get_sync (sink));
1365 case PROP_MAX_LATENESS:
1366 g_value_set_int64 (value, gst_base_sink_get_max_lateness (sink));
1369 g_value_set_boolean (value, gst_base_sink_is_qos_enabled (sink));
1372 g_value_set_boolean (value, gst_base_sink_is_async_enabled (sink));
1374 case PROP_TS_OFFSET:
1375 g_value_set_int64 (value, gst_base_sink_get_ts_offset (sink));
1377 case PROP_LAST_BUFFER:
1378 gst_value_take_buffer (value, gst_base_sink_get_last_buffer (sink));
1380 case PROP_ENABLE_LAST_BUFFER:
1381 g_value_set_boolean (value, gst_base_sink_is_last_buffer_enabled (sink));
1383 case PROP_BLOCKSIZE:
1384 g_value_set_uint (value, gst_base_sink_get_blocksize (sink));
1386 case PROP_RENDER_DELAY:
1387 g_value_set_uint64 (value, gst_base_sink_get_render_delay (sink));
1389 case PROP_THROTTLE_TIME:
1390 g_value_set_uint64 (value, gst_base_sink_get_throttle_time (sink));
1393 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1400 gst_base_sink_get_caps (GstBaseSink * sink, GstCaps * filter)
1406 gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps)
1411 /* with PREROLL_LOCK, STREAM_LOCK */
1413 gst_base_sink_preroll_queue_flush (GstBaseSink * basesink, GstPad * pad)
1417 GST_DEBUG_OBJECT (basesink, "flushing queue %p", basesink);
1418 while ((obj = g_queue_pop_head (basesink->priv->preroll_queue))) {
1419 GST_DEBUG_OBJECT (basesink, "popped %p", obj);
1420 gst_mini_object_unref (obj);
1422 /* we can't have EOS anymore now */
1423 basesink->eos = FALSE;
1424 basesink->priv->received_eos = FALSE;
1425 basesink->have_preroll = FALSE;
1426 basesink->priv->step_unlock = FALSE;
1427 basesink->eos_queued = FALSE;
1428 basesink->priv->preroll_queued = 0;
1429 /* can't report latency anymore until we preroll again */
1430 if (basesink->priv->async_enabled) {
1431 GST_OBJECT_LOCK (basesink);
1432 basesink->priv->have_latency = FALSE;
1433 GST_OBJECT_UNLOCK (basesink);
1435 /* and signal any waiters now */
1436 GST_BASE_SINK_PREROLL_SIGNAL (basesink);
1439 /* with STREAM_LOCK, configures given segment with the event information. */
1441 gst_base_sink_configure_segment (GstBaseSink * basesink, GstPad * pad,
1442 GstEvent * event, GstSegment * segment)
1444 /* The segment is protected with both the STREAM_LOCK and the OBJECT_LOCK.
1445 * We protect with the OBJECT_LOCK so that we can use the values to
1446 * safely answer a POSITION query. */
1447 GST_OBJECT_LOCK (basesink);
1448 /* the newsegment event is needed to bring the buffer timestamps to the
1449 * stream time and to drop samples outside of the playback segment. */
1450 gst_event_copy_segment (event, segment);
1451 GST_DEBUG_OBJECT (basesink, "configured SEGMENT %" GST_SEGMENT_FORMAT,
1453 GST_OBJECT_UNLOCK (basesink);
1456 /* with PREROLL_LOCK, STREAM_LOCK */
1458 gst_base_sink_commit_state (GstBaseSink * basesink)
1460 /* commit state and proceed to next pending state */
1461 GstState current, next, pending, post_pending;
1462 gboolean post_paused = FALSE;
1463 gboolean post_async_done = FALSE;
1464 gboolean post_playing = FALSE;
1465 gboolean reset_time;
1467 /* we are certainly not playing async anymore now */
1468 basesink->playing_async = FALSE;
1470 GST_OBJECT_LOCK (basesink);
1471 current = GST_STATE (basesink);
1472 next = GST_STATE_NEXT (basesink);
1473 pending = GST_STATE_PENDING (basesink);
1474 post_pending = pending;
1475 reset_time = basesink->priv->reset_time;
1476 basesink->priv->reset_time = FALSE;
1479 case GST_STATE_PLAYING:
1481 GST_DEBUG_OBJECT (basesink, "commiting state to PLAYING");
1483 basesink->need_preroll = FALSE;
1484 post_async_done = TRUE;
1485 basesink->priv->commited = TRUE;
1486 post_playing = TRUE;
1487 /* post PAUSED too when we were READY */
1488 if (current == GST_STATE_READY) {
1493 case GST_STATE_PAUSED:
1494 GST_DEBUG_OBJECT (basesink, "commiting state to PAUSED");
1496 post_async_done = TRUE;
1497 basesink->priv->commited = TRUE;
1498 post_pending = GST_STATE_VOID_PENDING;
1500 case GST_STATE_READY:
1501 case GST_STATE_NULL:
1503 case GST_STATE_VOID_PENDING:
1504 goto nothing_pending;
1509 /* we can report latency queries now */
1510 basesink->priv->have_latency = TRUE;
1512 GST_STATE (basesink) = pending;
1513 GST_STATE_NEXT (basesink) = GST_STATE_VOID_PENDING;
1514 GST_STATE_PENDING (basesink) = GST_STATE_VOID_PENDING;
1515 GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_SUCCESS;
1516 GST_OBJECT_UNLOCK (basesink);
1519 GST_DEBUG_OBJECT (basesink, "posting PAUSED state change message");
1520 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1521 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1522 current, next, post_pending));
1524 if (post_async_done) {
1525 GST_DEBUG_OBJECT (basesink, "posting async-done message");
1526 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1527 gst_message_new_async_done (GST_OBJECT_CAST (basesink), reset_time));
1530 GST_DEBUG_OBJECT (basesink, "posting PLAYING state change message");
1531 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1532 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1533 next, pending, GST_STATE_VOID_PENDING));
1536 GST_STATE_BROADCAST (basesink);
1542 /* Depending on the state, set our vars. We get in this situation when the
1543 * state change function got a change to update the state vars before the
1544 * streaming thread did. This is fine but we need to make sure that we
1545 * update the need_preroll var since it was TRUE when we got here and might
1546 * become FALSE if we got to PLAYING. */
1547 GST_DEBUG_OBJECT (basesink, "nothing to commit, now in %s",
1548 gst_element_state_get_name (current));
1550 case GST_STATE_PLAYING:
1551 basesink->need_preroll = FALSE;
1553 case GST_STATE_PAUSED:
1554 basesink->need_preroll = TRUE;
1557 basesink->need_preroll = FALSE;
1558 basesink->flushing = TRUE;
1561 /* we can report latency queries now */
1562 basesink->priv->have_latency = TRUE;
1563 GST_OBJECT_UNLOCK (basesink);
1568 /* app is going to READY */
1569 GST_DEBUG_OBJECT (basesink, "stopping");
1570 basesink->need_preroll = FALSE;
1571 basesink->flushing = TRUE;
1572 GST_OBJECT_UNLOCK (basesink);
1578 start_stepping (GstBaseSink * sink, GstSegment * segment,
1579 GstStepInfo * pending, GstStepInfo * current)
1582 GstMessage *message;
1584 GST_DEBUG_OBJECT (sink, "update pending step");
1586 GST_OBJECT_LOCK (sink);
1587 memcpy (current, pending, sizeof (GstStepInfo));
1588 pending->valid = FALSE;
1589 GST_OBJECT_UNLOCK (sink);
1591 /* post message first */
1593 gst_message_new_step_start (GST_OBJECT (sink), TRUE, current->format,
1594 current->amount, current->rate, current->flush, current->intermediate);
1595 gst_message_set_seqnum (message, current->seqnum);
1596 gst_element_post_message (GST_ELEMENT (sink), message);
1598 /* get the running time of where we paused and remember it */
1599 current->start = gst_element_get_start_time (GST_ELEMENT_CAST (sink));
1600 gst_segment_set_running_time (segment, GST_FORMAT_TIME, current->start);
1602 /* set the new rate for the remainder of the segment */
1603 current->start_rate = segment->rate;
1604 segment->rate *= current->rate;
1607 if (segment->rate > 0.0)
1608 current->start_stop = segment->stop;
1610 current->start_start = segment->start;
1612 if (current->format == GST_FORMAT_TIME) {
1613 end = current->start + current->amount;
1614 if (!current->flush) {
1615 /* update the segment clipping regions for non-flushing seeks */
1616 if (segment->rate > 0.0) {
1617 segment->stop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1618 segment->position = segment->stop;
1622 position = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1623 segment->time = position;
1624 segment->start = position;
1625 segment->position = position;
1630 GST_DEBUG_OBJECT (sink, "segment now %" GST_SEGMENT_FORMAT, segment);
1631 GST_DEBUG_OBJECT (sink, "step started at running_time %" GST_TIME_FORMAT,
1632 GST_TIME_ARGS (current->start));
1634 if (current->amount == -1) {
1635 GST_DEBUG_OBJECT (sink, "step amount == -1, stop stepping");
1636 current->valid = FALSE;
1638 GST_DEBUG_OBJECT (sink, "step amount: %" G_GUINT64_FORMAT ", format: %s, "
1639 "rate: %f", current->amount, gst_format_get_name (current->format),
1645 stop_stepping (GstBaseSink * sink, GstSegment * segment,
1646 GstStepInfo * current, gint64 rstart, gint64 rstop, gboolean eos)
1648 gint64 stop, position;
1649 GstMessage *message;
1651 GST_DEBUG_OBJECT (sink, "step complete");
1653 if (segment->rate > 0.0)
1658 GST_DEBUG_OBJECT (sink,
1659 "step stop at running_time %" GST_TIME_FORMAT, GST_TIME_ARGS (stop));
1662 current->duration = current->position;
1664 current->duration = stop - current->start;
1666 GST_DEBUG_OBJECT (sink, "step elapsed running_time %" GST_TIME_FORMAT,
1667 GST_TIME_ARGS (current->duration));
1669 position = current->start + current->duration;
1671 /* now move the segment to the new running time */
1672 gst_segment_set_running_time (segment, GST_FORMAT_TIME, position);
1674 if (current->flush) {
1675 /* and remove the time we flushed, start time did not change */
1676 segment->base = current->start;
1678 /* start time is now the stepped position */
1679 gst_element_set_start_time (GST_ELEMENT_CAST (sink), position);
1682 /* restore the previous rate */
1683 segment->rate = current->start_rate;
1685 if (segment->rate > 0.0)
1686 segment->stop = current->start_stop;
1688 segment->start = current->start_start;
1690 /* the clip segment is used for position report in paused... */
1691 gst_segment_copy_into (segment, &sink->clip_segment);
1693 /* post the step done when we know the stepped duration in TIME */
1695 gst_message_new_step_done (GST_OBJECT_CAST (sink), current->format,
1696 current->amount, current->rate, current->flush, current->intermediate,
1697 current->duration, eos);
1698 gst_message_set_seqnum (message, current->seqnum);
1699 gst_element_post_message (GST_ELEMENT_CAST (sink), message);
1701 if (!current->intermediate)
1702 sink->need_preroll = current->need_preroll;
1704 /* and the current step info finished and becomes invalid */
1705 current->valid = FALSE;
1709 handle_stepping (GstBaseSink * sink, GstSegment * segment,
1710 GstStepInfo * current, guint64 * cstart, guint64 * cstop, guint64 * rstart,
1713 gboolean step_end = FALSE;
1715 /* see if we need to skip this buffer because of stepping */
1716 switch (current->format) {
1717 case GST_FORMAT_TIME:
1720 guint64 first, last;
1723 if (segment->rate > 0.0) {
1724 if (segment->stop == *cstop)
1725 *rstop = *rstart + current->amount;
1730 if (segment->start == *cstart)
1731 *rstart = *rstop + current->amount;
1737 end = current->start + current->amount;
1738 current->position = first - current->start;
1740 abs_rate = ABS (segment->rate);
1741 if (G_UNLIKELY (abs_rate != 1.0))
1742 current->position /= abs_rate;
1744 GST_DEBUG_OBJECT (sink,
1745 "buffer: %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT,
1746 GST_TIME_ARGS (first), GST_TIME_ARGS (last));
1747 GST_DEBUG_OBJECT (sink,
1748 "got time step %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT "/%"
1749 GST_TIME_FORMAT, GST_TIME_ARGS (current->position),
1750 GST_TIME_ARGS (last - current->start),
1751 GST_TIME_ARGS (current->amount));
1753 if ((current->flush && current->position >= current->amount)
1755 GST_DEBUG_OBJECT (sink, "step ended, we need clipping");
1757 if (segment->rate > 0.0) {
1759 *cstart = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1762 *cstop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1765 GST_DEBUG_OBJECT (sink,
1766 "cstart %" GST_TIME_FORMAT ", rstart %" GST_TIME_FORMAT,
1767 GST_TIME_ARGS (*cstart), GST_TIME_ARGS (*rstart));
1768 GST_DEBUG_OBJECT (sink,
1769 "cstop %" GST_TIME_FORMAT ", rstop %" GST_TIME_FORMAT,
1770 GST_TIME_ARGS (*cstop), GST_TIME_ARGS (*rstop));
1773 case GST_FORMAT_BUFFERS:
1774 GST_DEBUG_OBJECT (sink,
1775 "got default step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1776 current->position, current->amount);
1778 if (current->position < current->amount) {
1779 current->position++;
1784 case GST_FORMAT_DEFAULT:
1786 GST_DEBUG_OBJECT (sink,
1787 "got unknown step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1788 current->position, current->amount);
1794 /* with STREAM_LOCK, PREROLL_LOCK
1796 * Returns TRUE if the object needs synchronisation and takes therefore
1797 * part in prerolling.
1799 * rsstart/rsstop contain the start/stop in stream time.
1800 * rrstart/rrstop contain the start/stop in running time.
1803 gst_base_sink_get_sync_times (GstBaseSink * basesink, GstMiniObject * obj,
1804 GstClockTime * rsstart, GstClockTime * rsstop,
1805 GstClockTime * rrstart, GstClockTime * rrstop, gboolean * do_sync,
1806 gboolean * stepped, GstSegment * segment, GstStepInfo * step,
1807 gboolean * step_end, guint8 obj_type)
1809 GstBaseSinkClass *bclass;
1811 GstClockTime start, stop; /* raw start/stop timestamps */
1812 guint64 cstart, cstop; /* clipped raw timestamps */
1813 guint64 rstart, rstop; /* clipped timestamps converted to running time */
1814 GstClockTime sstart, sstop; /* clipped timestamps converted to stream time */
1816 GstBaseSinkPrivate *priv;
1819 priv = basesink->priv;
1821 /* start with nothing */
1822 start = stop = GST_CLOCK_TIME_NONE;
1824 if (G_UNLIKELY (OBJ_IS_EVENT (obj_type))) {
1825 GstEvent *event = GST_EVENT_CAST (obj);
1827 switch (GST_EVENT_TYPE (event)) {
1828 /* EOS event needs syncing */
1831 if (basesink->segment.rate >= 0.0) {
1832 sstart = sstop = priv->current_sstop;
1833 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1834 /* we have not seen a buffer yet, use the segment values */
1835 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1836 basesink->segment.format, basesink->segment.stop);
1839 sstart = sstop = priv->current_sstart;
1840 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1841 /* we have not seen a buffer yet, use the segment values */
1842 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1843 basesink->segment.format, basesink->segment.start);
1847 rstart = rstop = priv->eos_rtime;
1848 *do_sync = rstart != -1;
1849 GST_DEBUG_OBJECT (basesink, "sync times for EOS %" GST_TIME_FORMAT,
1850 GST_TIME_ARGS (rstart));
1851 /* if we are stepping, we end now */
1852 *step_end = step->valid;
1857 /* other events do not need syncing */
1865 /* else do buffer sync code */
1866 buffer = GST_BUFFER_CAST (obj);
1868 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1870 /* just get the times to see if we need syncing, if the start returns -1 we
1872 if (bclass->get_times)
1873 bclass->get_times (basesink, buffer, &start, &stop);
1875 if (!GST_CLOCK_TIME_IS_VALID (start)) {
1876 /* we don't need to sync but we still want to get the timestamps for
1877 * tracking the position */
1878 gst_base_sink_get_times (basesink, buffer, &start, &stop);
1884 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
1885 ", stop: %" GST_TIME_FORMAT ", do_sync %d", GST_TIME_ARGS (start),
1886 GST_TIME_ARGS (stop), *do_sync);
1888 /* collect segment and format for code clarity */
1889 format = segment->format;
1892 if (G_UNLIKELY (!gst_segment_clip (segment, format,
1893 start, stop, &cstart, &cstop))) {
1895 GST_DEBUG_OBJECT (basesink, "step out of segment");
1896 /* when we are stepping, pretend we're at the end of the segment */
1897 if (segment->rate > 0.0) {
1898 cstart = segment->stop;
1899 cstop = segment->stop;
1901 cstart = segment->start;
1902 cstop = segment->start;
1906 goto out_of_segment;
1909 if (G_UNLIKELY (start != cstart || stop != cstop)) {
1910 GST_DEBUG_OBJECT (basesink, "clipped to: start %" GST_TIME_FORMAT
1911 ", stop: %" GST_TIME_FORMAT, GST_TIME_ARGS (cstart),
1912 GST_TIME_ARGS (cstop));
1915 /* set last stop position */
1916 if (G_LIKELY (stop != GST_CLOCK_TIME_NONE && cstop != GST_CLOCK_TIME_NONE))
1917 segment->position = cstop;
1919 segment->position = cstart;
1922 rstart = gst_segment_to_running_time (segment, format, cstart);
1923 rstop = gst_segment_to_running_time (segment, format, cstop);
1925 if (G_UNLIKELY (step->valid)) {
1926 if (!(*step_end = handle_stepping (basesink, segment, step, &cstart, &cstop,
1927 &rstart, &rstop))) {
1928 /* step is still busy, we discard data when we are flushing */
1929 *stepped = step->flush;
1930 GST_DEBUG_OBJECT (basesink, "stepping busy");
1933 /* this can produce wrong values if we accumulated non-TIME segments. If this happens,
1934 * upstream is behaving very badly */
1935 sstart = gst_segment_to_stream_time (segment, format, cstart);
1936 sstop = gst_segment_to_stream_time (segment, format, cstop);
1939 /* eos_done label only called when doing EOS, we also stop stepping then */
1940 if (*step_end && step->flush) {
1941 GST_DEBUG_OBJECT (basesink, "flushing step ended");
1942 stop_stepping (basesink, segment, step, rstart, rstop, eos);
1944 /* re-determine running start times for adjusted segment
1945 * (which has a flushed amount of running/accumulated time removed) */
1946 if (!GST_IS_EVENT (obj)) {
1947 GST_DEBUG_OBJECT (basesink, "refresh sync times");
1958 /* buffers and EOS always need syncing and preroll */
1964 /* we usually clip in the chain function already but stepping could cause
1965 * the segment to be updated later. we return FALSE so that we don't try
1967 GST_LOG_OBJECT (basesink, "buffer skipped, not in segment");
1972 /* with STREAM_LOCK, PREROLL_LOCK, LOCK
1973 * adjust a timestamp with the latency and timestamp offset. This function does
1974 * not adjust for the render delay. */
1976 gst_base_sink_adjust_time (GstBaseSink * basesink, GstClockTime time)
1978 GstClockTimeDiff ts_offset;
1980 /* don't do anything funny with invalid timestamps */
1981 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
1984 time += basesink->priv->latency;
1986 /* apply offset, be carefull for underflows */
1987 ts_offset = basesink->priv->ts_offset;
1988 if (ts_offset < 0) {
1989 ts_offset = -ts_offset;
1990 if (ts_offset < time)
1997 /* subtract the render delay again, which was included in the latency */
1998 if (time > basesink->priv->render_delay)
1999 time -= basesink->priv->render_delay;
2007 * gst_base_sink_wait_clock:
2009 * @time: the running_time to be reached
2010 * @jitter: (out) (allow-none): the jitter to be filled with time diff, or NULL
2012 * This function will block until @time is reached. It is usually called by
2013 * subclasses that use their own internal synchronisation.
2015 * If @time is not valid, no sycnhronisation is done and #GST_CLOCK_BADTIME is
2016 * returned. Likewise, if synchronisation is disabled in the element or there
2017 * is no clock, no synchronisation is done and #GST_CLOCK_BADTIME is returned.
2019 * This function should only be called with the PREROLL_LOCK held, like when
2020 * receiving an EOS event in the #GstBaseSinkClass.event() vmethod or when
2021 * receiving a buffer in
2022 * the #GstBaseSinkClass.render() vmethod.
2024 * The @time argument should be the running_time of when this method should
2025 * return and is not adjusted with any latency or offset configured in the
2030 * Returns: #GstClockReturn
2033 gst_base_sink_wait_clock (GstBaseSink * sink, GstClockTime time,
2034 GstClockTimeDiff * jitter)
2038 GstClockTime base_time;
2040 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
2043 GST_OBJECT_LOCK (sink);
2044 if (G_UNLIKELY (!sink->sync))
2047 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (sink)) == NULL))
2050 base_time = GST_ELEMENT_CAST (sink)->base_time;
2051 GST_LOG_OBJECT (sink,
2052 "time %" GST_TIME_FORMAT ", base_time %" GST_TIME_FORMAT,
2053 GST_TIME_ARGS (time), GST_TIME_ARGS (base_time));
2055 /* add base_time to running_time to get the time against the clock */
2058 /* Re-use existing clockid if available */
2059 /* FIXME: Casting to GstClockEntry only works because the types
2061 if (G_LIKELY (sink->priv->cached_clock_id != NULL
2062 && GST_CLOCK_ENTRY_CLOCK ((GstClockEntry *) sink->
2063 priv->cached_clock_id) == clock)) {
2064 if (!gst_clock_single_shot_id_reinit (clock, sink->priv->cached_clock_id,
2066 gst_clock_id_unref (sink->priv->cached_clock_id);
2067 sink->priv->cached_clock_id = gst_clock_new_single_shot_id (clock, time);
2070 if (sink->priv->cached_clock_id != NULL)
2071 gst_clock_id_unref (sink->priv->cached_clock_id);
2072 sink->priv->cached_clock_id = gst_clock_new_single_shot_id (clock, time);
2074 GST_OBJECT_UNLOCK (sink);
2076 /* A blocking wait is performed on the clock. We save the ClockID
2077 * so we can unlock the entry at any time. While we are blocking, we
2078 * release the PREROLL_LOCK so that other threads can interrupt the
2080 sink->clock_id = sink->priv->cached_clock_id;
2081 /* release the preroll lock while waiting */
2082 GST_BASE_SINK_PREROLL_UNLOCK (sink);
2084 ret = gst_clock_id_wait (sink->priv->cached_clock_id, jitter);
2086 GST_BASE_SINK_PREROLL_LOCK (sink);
2087 sink->clock_id = NULL;
2091 /* no syncing needed */
2094 GST_DEBUG_OBJECT (sink, "time not valid, no sync needed");
2095 return GST_CLOCK_BADTIME;
2099 GST_DEBUG_OBJECT (sink, "sync disabled");
2100 GST_OBJECT_UNLOCK (sink);
2101 return GST_CLOCK_BADTIME;
2105 GST_DEBUG_OBJECT (sink, "no clock, can't sync");
2106 GST_OBJECT_UNLOCK (sink);
2107 return GST_CLOCK_BADTIME;
2112 * gst_base_sink_wait_preroll:
2115 * If the #GstBaseSinkClass.render() method performs its own synchronisation
2116 * against the clock it must unblock when going from PLAYING to the PAUSED state
2117 * and call this method before continuing to render the remaining data.
2119 * This function will block until a state change to PLAYING happens (in which
2120 * case this function returns #GST_FLOW_OK) or the processing must be stopped due
2121 * to a state change to READY or a FLUSH event (in which case this function
2122 * returns #GST_FLOW_WRONG_STATE).
2124 * This function should only be called with the PREROLL_LOCK held, like in the
2127 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2128 * continue. Any other return value should be returned from the render vmethod.
2133 gst_base_sink_wait_preroll (GstBaseSink * sink)
2135 sink->have_preroll = TRUE;
2136 GST_DEBUG_OBJECT (sink, "waiting in preroll for flush or PLAYING");
2137 /* block until the state changes, or we get a flush, or something */
2138 GST_BASE_SINK_PREROLL_WAIT (sink);
2139 sink->have_preroll = FALSE;
2140 if (G_UNLIKELY (sink->flushing))
2142 if (G_UNLIKELY (sink->priv->step_unlock))
2144 GST_DEBUG_OBJECT (sink, "continue after preroll");
2151 GST_DEBUG_OBJECT (sink, "preroll interrupted because of flush");
2152 return GST_FLOW_WRONG_STATE;
2156 sink->priv->step_unlock = FALSE;
2157 GST_DEBUG_OBJECT (sink, "preroll interrupted because of step");
2158 return GST_FLOW_STEP;
2162 static inline guint8
2163 get_object_type (GstMiniObject * obj)
2167 if (G_LIKELY (GST_IS_BUFFER (obj)))
2168 obj_type = _PR_IS_BUFFER;
2169 else if (GST_IS_EVENT (obj))
2170 obj_type = _PR_IS_EVENT;
2171 else if (GST_IS_BUFFER_LIST (obj))
2172 obj_type = _PR_IS_BUFFERLIST;
2174 obj_type = _PR_IS_NOTHING;
2180 * gst_base_sink_do_preroll:
2182 * @obj: (transfer none): the mini object that caused the preroll
2184 * If the @sink spawns its own thread for pulling buffers from upstream it
2185 * should call this method after it has pulled a buffer. If the element needed
2186 * to preroll, this function will perform the preroll and will then block
2187 * until the element state is changed.
2189 * This function should be called with the PREROLL_LOCK held.
2191 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2192 * continue. Any other return value should be returned from the render vmethod.
2197 gst_base_sink_do_preroll (GstBaseSink * sink, GstMiniObject * obj)
2201 while (G_UNLIKELY (sink->need_preroll)) {
2203 GST_DEBUG_OBJECT (sink, "prerolling object %p", obj);
2205 obj_type = get_object_type (obj);
2207 ret = gst_base_sink_preroll_object (sink, obj_type, obj);
2208 if (ret != GST_FLOW_OK)
2209 goto preroll_failed;
2211 /* need to recheck here because the commit state could have
2212 * made us not need the preroll anymore */
2213 if (G_LIKELY (sink->need_preroll)) {
2214 /* block until the state changes, or we get a flush, or something */
2215 ret = gst_base_sink_wait_preroll (sink);
2216 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2217 goto preroll_failed;
2225 GST_DEBUG_OBJECT (sink, "preroll failed: %s", gst_flow_get_name (ret));
2231 * gst_base_sink_wait_eos:
2233 * @time: the running_time to be reached
2234 * @jitter: (out) (allow-none): the jitter to be filled with time diff, or NULL
2236 * This function will block until @time is reached. It is usually called by
2237 * subclasses that use their own internal synchronisation but want to let the
2238 * EOS be handled by the base class.
2240 * This function should only be called with the PREROLL_LOCK held, like when
2241 * receiving an EOS event in the ::event vmethod.
2243 * The @time argument should be the running_time of when the EOS should happen
2244 * and will be adjusted with any latency and offset configured in the sink.
2246 * Returns: #GstFlowReturn
2251 gst_base_sink_wait_eos (GstBaseSink * sink, GstClockTime time,
2252 GstClockTimeDiff * jitter)
2254 GstClockReturn status;
2260 GST_DEBUG_OBJECT (sink, "checking preroll");
2262 /* first wait for the playing state before we can continue */
2263 while (G_UNLIKELY (sink->need_preroll)) {
2264 ret = gst_base_sink_wait_preroll (sink);
2265 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2269 /* preroll done, we can sync since we are in PLAYING now. */
2270 GST_DEBUG_OBJECT (sink, "possibly waiting for clock to reach %"
2271 GST_TIME_FORMAT, GST_TIME_ARGS (time));
2273 /* compensate for latency and ts_offset. We don't adjust for render delay
2274 * because we don't interact with the device on EOS normally. */
2275 stime = gst_base_sink_adjust_time (sink, time);
2277 /* wait for the clock, this can be interrupted because we got shut down or
2279 status = gst_base_sink_wait_clock (sink, stime, jitter);
2281 GST_DEBUG_OBJECT (sink, "clock returned %d", status);
2283 /* invalid time, no clock or sync disabled, just continue then */
2284 if (status == GST_CLOCK_BADTIME)
2287 /* waiting could have been interrupted and we can be flushing now */
2288 if (G_UNLIKELY (sink->flushing))
2291 /* retry if we got unscheduled, which means we did not reach the timeout
2292 * yet. if some other error occures, we continue. */
2293 } while (status == GST_CLOCK_UNSCHEDULED);
2295 GST_DEBUG_OBJECT (sink, "end of stream");
2302 GST_DEBUG_OBJECT (sink, "we are flushing");
2303 return GST_FLOW_WRONG_STATE;
2307 /* with STREAM_LOCK, PREROLL_LOCK
2309 * Make sure we are in PLAYING and synchronize an object to the clock.
2311 * If we need preroll, we are not in PLAYING. We try to commit the state
2312 * if needed and then block if we still are not PLAYING.
2314 * We start waiting on the clock in PLAYING. If we got interrupted, we
2315 * immediately try to re-preroll.
2317 * Some objects do not need synchronisation (most events) and so this function
2318 * immediately returns GST_FLOW_OK.
2320 * for objects that arrive later than max-lateness to be synchronized to the
2321 * clock have the @late boolean set to TRUE.
2323 * This function keeps a running average of the jitter (the diff between the
2324 * clock time and the requested sync time). The jitter is negative for
2325 * objects that arrive in time and positive for late buffers.
2327 * does not take ownership of obj.
2329 static GstFlowReturn
2330 gst_base_sink_do_sync (GstBaseSink * basesink, GstPad * pad,
2331 GstMiniObject * obj, gboolean * late, gboolean * step_end, guint8 obj_type)
2333 GstClockTimeDiff jitter = 0;
2335 GstClockReturn status = GST_CLOCK_OK;
2336 GstClockTime rstart, rstop, sstart, sstop, stime;
2338 GstBaseSinkPrivate *priv;
2340 GstStepInfo *current, *pending;
2343 priv = basesink->priv;
2346 sstart = sstop = rstart = rstop = GST_CLOCK_TIME_NONE;
2350 priv->current_rstart = GST_CLOCK_TIME_NONE;
2352 /* get stepping info */
2353 current = &priv->current_step;
2354 pending = &priv->pending_step;
2356 /* get timing information for this object against the render segment */
2357 syncable = gst_base_sink_get_sync_times (basesink, obj,
2358 &sstart, &sstop, &rstart, &rstop, &do_sync, &stepped, &basesink->segment,
2359 current, step_end, obj_type);
2361 if (G_UNLIKELY (stepped))
2364 /* a syncable object needs to participate in preroll and
2365 * clocking. All buffers and EOS are syncable. */
2366 if (G_UNLIKELY (!syncable))
2369 /* store timing info for current object */
2370 priv->current_rstart = rstart;
2371 priv->current_rstop = (GST_CLOCK_TIME_IS_VALID (rstop) ? rstop : rstart);
2373 /* save sync time for eos when the previous object needed sync */
2374 priv->eos_rtime = (do_sync ? priv->current_rstop : GST_CLOCK_TIME_NONE);
2376 /* calculate inter frame spacing */
2377 if (G_UNLIKELY (priv->prev_rstart != -1 && priv->prev_rstart < rstart)) {
2378 GstClockTime in_diff;
2380 in_diff = rstart - priv->prev_rstart;
2382 if (priv->avg_in_diff == -1)
2383 priv->avg_in_diff = in_diff;
2385 priv->avg_in_diff = UPDATE_RUNNING_AVG (priv->avg_in_diff, in_diff);
2387 GST_LOG_OBJECT (basesink, "avg frame diff %" GST_TIME_FORMAT,
2388 GST_TIME_ARGS (priv->avg_in_diff));
2391 priv->prev_rstart = rstart;
2393 if (G_UNLIKELY (priv->earliest_in_time != -1
2394 && rstart < priv->earliest_in_time))
2398 /* first do preroll, this makes sure we commit our state
2399 * to PAUSED and can continue to PLAYING. We cannot perform
2400 * any clock sync in PAUSED because there is no clock. */
2401 ret = gst_base_sink_do_preroll (basesink, obj);
2402 if (G_UNLIKELY (ret != GST_FLOW_OK))
2403 goto preroll_failed;
2405 /* update the segment with a pending step if the current one is invalid and we
2406 * have a new pending one. We only accept new step updates after a preroll */
2407 if (G_UNLIKELY (pending->valid && !current->valid)) {
2408 start_stepping (basesink, &basesink->segment, pending, current);
2412 /* After rendering we store the position of the last buffer so that we can use
2413 * it to report the position. We need to take the lock here. */
2414 GST_OBJECT_LOCK (basesink);
2415 priv->current_sstart = sstart;
2416 priv->current_sstop = (GST_CLOCK_TIME_IS_VALID (sstop) ? sstop : sstart);
2417 GST_OBJECT_UNLOCK (basesink);
2422 /* adjust for latency */
2423 stime = gst_base_sink_adjust_time (basesink, rstart);
2425 /* adjust for render-delay, avoid underflows */
2426 if (GST_CLOCK_TIME_IS_VALID (stime)) {
2427 if (stime > priv->render_delay)
2428 stime -= priv->render_delay;
2433 /* preroll done, we can sync since we are in PLAYING now. */
2434 GST_DEBUG_OBJECT (basesink, "possibly waiting for clock to reach %"
2435 GST_TIME_FORMAT ", adjusted %" GST_TIME_FORMAT,
2436 GST_TIME_ARGS (rstart), GST_TIME_ARGS (stime));
2438 /* This function will return immediately if start == -1, no clock
2439 * or sync is disabled with GST_CLOCK_BADTIME. */
2440 status = gst_base_sink_wait_clock (basesink, stime, &jitter);
2442 GST_DEBUG_OBJECT (basesink, "clock returned %d, jitter %c%" GST_TIME_FORMAT,
2443 status, (jitter < 0 ? '-' : ' '), GST_TIME_ARGS (ABS (jitter)));
2445 /* invalid time, no clock or sync disabled, just render */
2446 if (status == GST_CLOCK_BADTIME)
2449 /* waiting could have been interrupted and we can be flushing now */
2450 if (G_UNLIKELY (basesink->flushing))
2453 /* check for unlocked by a state change, we are not flushing so
2454 * we can try to preroll on the current buffer. */
2455 if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED)) {
2456 GST_DEBUG_OBJECT (basesink, "unscheduled, waiting some more");
2457 priv->call_preroll = TRUE;
2461 /* successful syncing done, record observation */
2462 priv->current_jitter = jitter;
2464 /* check if the object should be dropped */
2465 *late = gst_base_sink_is_too_late (basesink, obj, rstart, rstop,
2474 GST_DEBUG_OBJECT (basesink, "skipped stepped object %p", obj);
2480 GST_DEBUG_OBJECT (basesink, "non syncable object %p", obj);
2485 GST_DEBUG_OBJECT (basesink, "dropped because of QoS %p", obj);
2491 GST_DEBUG_OBJECT (basesink, "we are flushing");
2492 return GST_FLOW_WRONG_STATE;
2496 GST_DEBUG_OBJECT (basesink, "preroll failed");
2503 gst_base_sink_send_qos (GstBaseSink * basesink, GstQOSType type,
2504 gdouble proportion, GstClockTime time, GstClockTimeDiff diff)
2509 /* generate Quality-of-Service event */
2510 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2511 "qos: type %d, proportion: %lf, diff %" G_GINT64_FORMAT ", timestamp %"
2512 GST_TIME_FORMAT, type, proportion, diff, GST_TIME_ARGS (time));
2514 event = gst_event_new_qos (type, proportion, diff, time);
2517 res = gst_pad_push_event (basesink->sinkpad, event);
2523 gst_base_sink_perform_qos (GstBaseSink * sink, gboolean dropped)
2525 GstBaseSinkPrivate *priv;
2526 GstClockTime start, stop;
2527 GstClockTimeDiff jitter;
2528 GstClockTime pt, entered, left;
2529 GstClockTime duration;
2534 start = priv->current_rstart;
2536 if (priv->current_step.valid)
2539 /* if Quality-of-Service disabled, do nothing */
2540 if (!g_atomic_int_get (&priv->qos_enabled) ||
2541 !GST_CLOCK_TIME_IS_VALID (start))
2544 stop = priv->current_rstop;
2545 jitter = priv->current_jitter;
2548 /* this is the time the buffer entered the sink */
2549 if (start < -jitter)
2552 entered = start + jitter;
2555 /* this is the time the buffer entered the sink */
2556 entered = start + jitter;
2557 /* this is the time the buffer left the sink */
2558 left = start + jitter;
2561 /* calculate duration of the buffer */
2562 if (GST_CLOCK_TIME_IS_VALID (stop) && stop != start)
2563 duration = stop - start;
2565 duration = priv->avg_in_diff;
2567 /* if we have the time when the last buffer left us, calculate
2568 * processing time */
2569 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2570 if (entered > priv->last_left) {
2571 pt = entered - priv->last_left;
2579 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "start: %" GST_TIME_FORMAT
2580 ", stop %" GST_TIME_FORMAT ", entered %" GST_TIME_FORMAT ", left %"
2581 GST_TIME_FORMAT ", pt: %" GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT
2582 ",jitter %" G_GINT64_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (stop),
2583 GST_TIME_ARGS (entered), GST_TIME_ARGS (left), GST_TIME_ARGS (pt),
2584 GST_TIME_ARGS (duration), jitter);
2586 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "avg_duration: %" GST_TIME_FORMAT
2587 ", avg_pt: %" GST_TIME_FORMAT ", avg_rate: %g",
2588 GST_TIME_ARGS (priv->avg_duration), GST_TIME_ARGS (priv->avg_pt),
2591 /* collect running averages. for first observations, we copy the
2593 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_duration))
2594 priv->avg_duration = duration;
2596 priv->avg_duration = UPDATE_RUNNING_AVG (priv->avg_duration, duration);
2598 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_pt))
2601 priv->avg_pt = UPDATE_RUNNING_AVG (priv->avg_pt, pt);
2603 if (priv->avg_duration != 0)
2605 gst_guint64_to_gdouble (priv->avg_pt) /
2606 gst_guint64_to_gdouble (priv->avg_duration);
2610 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2611 if (dropped || priv->avg_rate < 0.0) {
2612 priv->avg_rate = rate;
2615 priv->avg_rate = UPDATE_RUNNING_AVG_N (priv->avg_rate, rate);
2617 priv->avg_rate = UPDATE_RUNNING_AVG_P (priv->avg_rate, rate);
2621 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink,
2622 "updated: avg_duration: %" GST_TIME_FORMAT ", avg_pt: %" GST_TIME_FORMAT
2623 ", avg_rate: %g", GST_TIME_ARGS (priv->avg_duration),
2624 GST_TIME_ARGS (priv->avg_pt), priv->avg_rate);
2627 if (priv->avg_rate >= 0.0) {
2629 GstClockTimeDiff diff;
2631 /* if we have a valid rate, start sending QoS messages */
2632 if (priv->current_jitter < 0) {
2633 /* make sure we never go below 0 when adding the jitter to the
2635 if (priv->current_rstart < -priv->current_jitter)
2636 priv->current_jitter = -priv->current_rstart;
2639 if (priv->throttle_time > 0) {
2640 diff = priv->throttle_time;
2641 type = GST_QOS_TYPE_THROTTLE;
2643 diff = priv->current_jitter;
2645 type = GST_QOS_TYPE_OVERFLOW;
2647 type = GST_QOS_TYPE_UNDERFLOW;
2650 gst_base_sink_send_qos (sink, type, priv->avg_rate, priv->current_rstart,
2654 /* record when this buffer will leave us */
2655 priv->last_left = left;
2658 /* reset all qos measuring */
2660 gst_base_sink_reset_qos (GstBaseSink * sink)
2662 GstBaseSinkPrivate *priv;
2666 priv->last_render_time = GST_CLOCK_TIME_NONE;
2667 priv->prev_rstart = GST_CLOCK_TIME_NONE;
2668 priv->earliest_in_time = GST_CLOCK_TIME_NONE;
2669 priv->last_left = GST_CLOCK_TIME_NONE;
2670 priv->avg_duration = GST_CLOCK_TIME_NONE;
2671 priv->avg_pt = GST_CLOCK_TIME_NONE;
2672 priv->avg_rate = -1.0;
2673 priv->avg_render = GST_CLOCK_TIME_NONE;
2674 priv->avg_in_diff = GST_CLOCK_TIME_NONE;
2680 /* Checks if the object was scheduled too late.
2682 * rstart/rstop contain the running_time start and stop values
2685 * status and jitter contain the return values from the clock wait.
2687 * returns TRUE if the buffer was too late.
2690 gst_base_sink_is_too_late (GstBaseSink * basesink, GstMiniObject * obj,
2691 GstClockTime rstart, GstClockTime rstop,
2692 GstClockReturn status, GstClockTimeDiff jitter)
2695 guint64 max_lateness;
2696 GstBaseSinkPrivate *priv;
2698 priv = basesink->priv;
2702 /* only for objects that were too late */
2703 if (G_LIKELY (status != GST_CLOCK_EARLY))
2706 max_lateness = basesink->max_lateness;
2708 /* check if frame dropping is enabled */
2709 if (max_lateness == -1)
2712 /* only check for buffers */
2713 if (G_UNLIKELY (!GST_IS_BUFFER (obj)))
2716 /* can't do check if we don't have a timestamp */
2717 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (rstart)))
2720 /* we can add a valid stop time */
2721 if (GST_CLOCK_TIME_IS_VALID (rstop))
2722 max_lateness += rstop;
2724 max_lateness += rstart;
2725 /* no stop time, use avg frame diff */
2726 if (priv->avg_in_diff != -1)
2727 max_lateness += priv->avg_in_diff;
2730 /* if the jitter bigger than duration and lateness we are too late */
2731 if ((late = rstart + jitter > max_lateness)) {
2732 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2733 "buffer is too late %" GST_TIME_FORMAT
2734 " > %" GST_TIME_FORMAT, GST_TIME_ARGS (rstart + jitter),
2735 GST_TIME_ARGS (max_lateness));
2736 /* !!emergency!!, if we did not receive anything valid for more than a
2737 * second, render it anyway so the user sees something */
2738 if (GST_CLOCK_TIME_IS_VALID (priv->last_render_time) &&
2739 rstart - priv->last_render_time > GST_SECOND) {
2741 GST_ELEMENT_WARNING (basesink, CORE, CLOCK,
2742 (_("A lot of buffers are being dropped.")),
2743 ("There may be a timestamping problem, or this computer is too slow."));
2744 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2745 "**emergency** last buffer at %" GST_TIME_FORMAT " > GST_SECOND",
2746 GST_TIME_ARGS (priv->last_render_time));
2751 if (!late || !GST_CLOCK_TIME_IS_VALID (priv->last_render_time)) {
2752 priv->last_render_time = rstart;
2753 /* the next allowed input timestamp */
2754 if (priv->throttle_time > 0)
2755 priv->earliest_in_time = rstart + priv->throttle_time;
2762 GST_DEBUG_OBJECT (basesink, "object was scheduled in time");
2767 GST_DEBUG_OBJECT (basesink, "frame dropping disabled");
2772 GST_DEBUG_OBJECT (basesink, "object is not a buffer");
2777 GST_DEBUG_OBJECT (basesink, "buffer has no timestamp");
2782 /* called before and after calling the render vmethod. It keeps track of how
2783 * much time was spent in the render method and is used to check if we are
2786 gst_base_sink_do_render_stats (GstBaseSink * basesink, gboolean start)
2788 GstBaseSinkPrivate *priv;
2790 priv = basesink->priv;
2793 priv->start = gst_util_get_timestamp ();
2795 GstClockTime elapsed;
2797 priv->stop = gst_util_get_timestamp ();
2799 elapsed = GST_CLOCK_DIFF (priv->start, priv->stop);
2801 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_render))
2802 priv->avg_render = elapsed;
2804 priv->avg_render = UPDATE_RUNNING_AVG (priv->avg_render, elapsed);
2806 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2807 "avg_render: %" GST_TIME_FORMAT, GST_TIME_ARGS (priv->avg_render));
2811 /* with STREAM_LOCK, PREROLL_LOCK,
2813 * Synchronize the object on the clock and then render it.
2815 * takes ownership of obj.
2817 static GstFlowReturn
2818 gst_base_sink_render_object (GstBaseSink * basesink, GstPad * pad,
2819 guint8 obj_type, gpointer obj)
2822 GstBaseSinkClass *bclass;
2823 gboolean late, step_end;
2825 GstBaseSinkPrivate *priv;
2827 priv = basesink->priv;
2829 if (OBJ_IS_BUFFERLIST (obj_type)) {
2831 * If buffer list, use the first group buffer within the list
2834 sync_obj = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0);
2835 g_assert (NULL != sync_obj);
2844 /* synchronize this object, non syncable objects return OK
2847 gst_base_sink_do_sync (basesink, pad, sync_obj, &late, &step_end,
2849 if (G_UNLIKELY (ret != GST_FLOW_OK))
2852 /* and now render, event or buffer/buffer list. */
2853 if (G_LIKELY (OBJ_IS_BUFFERFULL (obj_type))) {
2854 /* drop late buffers unconditionally, let's hope it's unlikely */
2855 if (G_UNLIKELY (late))
2858 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2860 if (G_LIKELY ((OBJ_IS_BUFFERLIST (obj_type) && bclass->render_list) ||
2861 (!OBJ_IS_BUFFERLIST (obj_type) && bclass->render))) {
2864 /* read once, to get same value before and after */
2865 do_qos = g_atomic_int_get (&priv->qos_enabled);
2867 GST_DEBUG_OBJECT (basesink, "rendering object %p", obj);
2869 /* record rendering time for QoS and stats */
2871 gst_base_sink_do_render_stats (basesink, TRUE);
2873 if (!OBJ_IS_BUFFERLIST (obj_type)) {
2876 /* For buffer lists do not set last buffer. Creating buffer
2877 * with meaningful data can be done only with memcpy which will
2878 * significantly affect performance */
2879 buf = GST_BUFFER_CAST (obj);
2880 gst_base_sink_set_last_buffer (basesink, buf);
2882 ret = bclass->render (basesink, buf);
2884 GstBufferList *buflist;
2886 buflist = GST_BUFFER_LIST_CAST (obj);
2888 ret = bclass->render_list (basesink, buflist);
2892 gst_base_sink_do_render_stats (basesink, FALSE);
2894 if (ret == GST_FLOW_STEP)
2897 if (G_UNLIKELY (basesink->flushing))
2902 } else if (G_LIKELY (OBJ_IS_EVENT (obj_type))) {
2903 GstEvent *event = GST_EVENT_CAST (obj);
2904 gboolean event_res = TRUE;
2907 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2909 type = GST_EVENT_TYPE (event);
2911 GST_DEBUG_OBJECT (basesink, "rendering event %p, type %s", obj,
2912 gst_event_type_get_name (type));
2915 event_res = bclass->event (basesink, event);
2917 /* when we get here we could be flushing again when the event handler calls
2918 * _wait_eos(). We have to ignore this object in that case. */
2919 if (G_UNLIKELY (basesink->flushing))
2922 if (G_LIKELY (event_res)) {
2925 seqnum = basesink->priv->seqnum = gst_event_get_seqnum (event);
2926 GST_DEBUG_OBJECT (basesink, "Got seqnum #%" G_GUINT32_FORMAT, seqnum);
2931 GstMessage *message;
2933 /* the EOS event is completely handled so we mark
2934 * ourselves as being in the EOS state. eos is also
2935 * protected by the object lock so we can read it when
2936 * answering the POSITION query. */
2937 GST_OBJECT_LOCK (basesink);
2938 basesink->eos = TRUE;
2939 GST_OBJECT_UNLOCK (basesink);
2941 /* ok, now we can post the message */
2942 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
2944 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
2945 gst_message_set_seqnum (message, seqnum);
2946 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
2949 case GST_EVENT_SEGMENT:
2950 /* configure the segment */
2951 gst_base_sink_configure_segment (basesink, pad, event,
2952 &basesink->segment);
2956 GstTagList *taglist;
2958 gst_event_parse_tag (event, &taglist);
2960 gst_element_post_message (GST_ELEMENT_CAST (basesink),
2961 gst_message_new_tag (GST_OBJECT_CAST (basesink),
2962 gst_tag_list_copy (taglist)));
2965 case GST_EVENT_SINK_MESSAGE:
2967 GstMessage *msg = NULL;
2969 gst_event_parse_sink_message (event, &msg);
2972 gst_element_post_message (GST_ELEMENT_CAST (basesink), msg);
2979 g_return_val_if_reached (GST_FLOW_ERROR);
2984 /* the step ended, check if we need to activate a new step */
2985 GST_DEBUG_OBJECT (basesink, "step ended");
2986 stop_stepping (basesink, &basesink->segment, &priv->current_step,
2987 priv->current_rstart, priv->current_rstop, basesink->eos);
2991 gst_base_sink_perform_qos (basesink, late);
2993 GST_DEBUG_OBJECT (basesink, "object unref after render %p", obj);
2994 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3000 GST_DEBUG_OBJECT (basesink, "do_sync returned %s", gst_flow_get_name (ret));
3006 GST_DEBUG_OBJECT (basesink, "buffer late, dropping");
3008 if (g_atomic_int_get (&priv->qos_enabled)) {
3009 GstMessage *qos_msg;
3010 GstClockTime timestamp, duration;
3012 timestamp = GST_BUFFER_TIMESTAMP (GST_BUFFER_CAST (sync_obj));
3013 duration = GST_BUFFER_DURATION (GST_BUFFER_CAST (sync_obj));
3015 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
3016 "qos: dropped buffer rt %" GST_TIME_FORMAT ", st %" GST_TIME_FORMAT
3017 ", ts %" GST_TIME_FORMAT ", dur %" GST_TIME_FORMAT,
3018 GST_TIME_ARGS (priv->current_rstart),
3019 GST_TIME_ARGS (priv->current_sstart), GST_TIME_ARGS (timestamp),
3020 GST_TIME_ARGS (duration));
3021 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
3022 "qos: rendered %" G_GUINT64_FORMAT ", dropped %" G_GUINT64_FORMAT,
3023 priv->rendered, priv->dropped);
3026 gst_message_new_qos (GST_OBJECT_CAST (basesink), basesink->sync,
3027 priv->current_rstart, priv->current_sstart, timestamp, duration);
3028 gst_message_set_qos_values (qos_msg, priv->current_jitter, priv->avg_rate,
3030 gst_message_set_qos_stats (qos_msg, GST_FORMAT_BUFFERS, priv->rendered,
3032 gst_element_post_message (GST_ELEMENT_CAST (basesink), qos_msg);
3038 GST_DEBUG_OBJECT (basesink, "we are flushing, ignore object");
3039 gst_mini_object_unref (obj);
3040 return GST_FLOW_WRONG_STATE;
3044 /* with STREAM_LOCK, PREROLL_LOCK
3046 * Perform preroll on the given object. For buffers this means
3047 * calling the preroll subclass method.
3048 * If that succeeds, the state will be commited.
3050 * function does not take ownership of obj.
3052 static GstFlowReturn
3053 gst_base_sink_preroll_object (GstBaseSink * basesink, guint8 obj_type,
3054 GstMiniObject * obj)
3058 GST_DEBUG_OBJECT (basesink, "prerolling object %p", obj);
3060 /* if it's a buffer, we need to call the preroll method */
3061 if (G_LIKELY (OBJ_IS_BUFFERFULL (obj_type) && basesink->priv->call_preroll)) {
3062 GstBaseSinkClass *bclass;
3064 GstClockTime timestamp;
3066 if (OBJ_IS_BUFFERLIST (obj_type)) {
3067 buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0);
3068 g_assert (NULL != buf);
3070 buf = GST_BUFFER_CAST (obj);
3073 timestamp = GST_BUFFER_TIMESTAMP (buf);
3075 GST_DEBUG_OBJECT (basesink, "preroll buffer %" GST_TIME_FORMAT,
3076 GST_TIME_ARGS (timestamp));
3079 * For buffer lists do not set last buffer. Creating buffer
3080 * with meaningful data can be done only with memcpy which will
3081 * significantly affect performance
3083 if (!OBJ_IS_BUFFERLIST (obj_type)) {
3084 gst_base_sink_set_last_buffer (basesink, buf);
3087 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3088 if (bclass->preroll)
3089 if ((ret = bclass->preroll (basesink, buf)) != GST_FLOW_OK)
3090 goto preroll_failed;
3092 basesink->priv->call_preroll = FALSE;
3096 if (G_LIKELY (basesink->playing_async)) {
3097 if (G_UNLIKELY (!gst_base_sink_commit_state (basesink)))
3106 GST_DEBUG_OBJECT (basesink, "preroll failed, abort state");
3107 gst_element_abort_state (GST_ELEMENT_CAST (basesink));
3112 GST_DEBUG_OBJECT (basesink, "stopping while commiting state");
3113 return GST_FLOW_WRONG_STATE;
3117 /* with STREAM_LOCK, PREROLL_LOCK
3119 * Queue an object for rendering.
3120 * The first prerollable object queued will complete the preroll. If the
3121 * preroll queue is filled, we render all the objects in the queue.
3123 * This function takes ownership of the object.
3125 static GstFlowReturn
3126 gst_base_sink_queue_object_unlocked (GstBaseSink * basesink, GstPad * pad,
3127 guint8 obj_type, gpointer obj, gboolean prerollable)
3129 GstFlowReturn ret = GST_FLOW_OK;
3133 if (G_UNLIKELY (basesink->need_preroll)) {
3134 if (G_LIKELY (prerollable))
3135 basesink->priv->preroll_queued++;
3137 length = basesink->priv->preroll_queued;
3139 GST_DEBUG_OBJECT (basesink, "now %d prerolled items", length);
3141 /* first prerollable item needs to finish the preroll */
3143 ret = gst_base_sink_preroll_object (basesink, obj_type, obj);
3144 if (G_UNLIKELY (ret != GST_FLOW_OK))
3145 goto preroll_failed;
3147 /* need to recheck if we need preroll, commit state during preroll
3148 * could have made us not need more preroll. */
3149 if (G_UNLIKELY (basesink->need_preroll)) {
3150 /* see if we can render now, if we can't add the object to the preroll
3152 if (G_UNLIKELY (length <= 0))
3156 /* we can start rendering (or blocking) the queued object
3158 q = basesink->priv->preroll_queue;
3159 while (G_UNLIKELY (!g_queue_is_empty (q))) {
3163 o = g_queue_pop_head (q);
3164 GST_DEBUG_OBJECT (basesink, "rendering queued object %p", o);
3166 ot = get_object_type (o);
3168 /* do something with the return value */
3169 ret = gst_base_sink_render_object (basesink, pad, ot, o);
3170 if (ret != GST_FLOW_OK)
3171 goto dequeue_failed;
3174 /* now render the object */
3175 ret = gst_base_sink_render_object (basesink, pad, obj_type, obj);
3176 basesink->priv->preroll_queued = 0;
3183 GST_DEBUG_OBJECT (basesink, "preroll failed, reason %s",
3184 gst_flow_get_name (ret));
3185 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3190 /* add object to the queue and return */
3191 GST_DEBUG_OBJECT (basesink, "need more preroll data");
3192 g_queue_push_tail (basesink->priv->preroll_queue, obj);
3197 GST_DEBUG_OBJECT (basesink, "rendering queued objects failed, reason %s",
3198 gst_flow_get_name (ret));
3199 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3206 * This function grabs the PREROLL_LOCK and adds the object to
3209 * This function takes ownership of obj.
3211 * Note: Only GstEvent seem to be passed to this private method
3213 static GstFlowReturn
3214 gst_base_sink_queue_object (GstBaseSink * basesink, GstPad * pad,
3215 GstMiniObject * obj, gboolean prerollable)
3219 GST_BASE_SINK_PREROLL_LOCK (basesink);
3220 if (G_UNLIKELY (basesink->flushing))
3223 if (G_UNLIKELY (basesink->priv->received_eos))
3227 gst_base_sink_queue_object_unlocked (basesink, pad, _PR_IS_EVENT, obj,
3229 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3236 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3237 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3238 gst_mini_object_unref (obj);
3239 return GST_FLOW_WRONG_STATE;
3243 GST_DEBUG_OBJECT (basesink, "we are EOS, dropping object, return EOS");
3244 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3245 gst_mini_object_unref (obj);
3246 return GST_FLOW_EOS;
3251 gst_base_sink_flush_start (GstBaseSink * basesink, GstPad * pad)
3253 /* make sure we are not blocked on the clock also clear any pending
3255 gst_base_sink_set_flushing (basesink, pad, TRUE);
3257 /* we grab the stream lock but that is not needed since setting the
3258 * sink to flushing would make sure no state commit is being done
3260 GST_PAD_STREAM_LOCK (pad);
3261 gst_base_sink_reset_qos (basesink);
3262 /* and we need to commit our state again on the next
3263 * prerolled buffer */
3264 basesink->playing_async = TRUE;
3265 if (basesink->priv->async_enabled) {
3266 gst_element_lost_state (GST_ELEMENT_CAST (basesink));
3268 /* start time reset in above case as well;
3269 * arranges for a.o. proper position reporting when flushing in PAUSED */
3270 gst_element_set_start_time (GST_ELEMENT_CAST (basesink), 0);
3271 basesink->priv->have_latency = TRUE;
3273 gst_base_sink_set_last_buffer (basesink, NULL);
3274 GST_PAD_STREAM_UNLOCK (pad);
3278 gst_base_sink_flush_stop (GstBaseSink * basesink, GstPad * pad,
3279 gboolean reset_time)
3281 /* unset flushing so we can accept new data, this also flushes out any EOS
3283 gst_base_sink_set_flushing (basesink, pad, FALSE);
3285 /* for position reporting */
3286 GST_OBJECT_LOCK (basesink);
3287 basesink->priv->current_sstart = GST_CLOCK_TIME_NONE;
3288 basesink->priv->current_sstop = GST_CLOCK_TIME_NONE;
3289 basesink->priv->eos_rtime = GST_CLOCK_TIME_NONE;
3290 basesink->priv->call_preroll = TRUE;
3291 basesink->priv->current_step.valid = FALSE;
3292 basesink->priv->pending_step.valid = FALSE;
3293 if (basesink->pad_mode == GST_PAD_MODE_PUSH) {
3294 /* we need new segment info after the flush. */
3295 basesink->have_newsegment = FALSE;
3297 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
3298 gst_segment_init (&basesink->clip_segment, GST_FORMAT_UNDEFINED);
3301 basesink->priv->reset_time = reset_time;
3302 GST_OBJECT_UNLOCK (basesink);
3306 gst_base_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
3308 GstBaseSink *basesink;
3309 gboolean result = TRUE;
3310 GstBaseSinkClass *bclass;
3312 basesink = GST_BASE_SINK (parent);
3313 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3315 GST_DEBUG_OBJECT (basesink, "received event %p %" GST_PTR_FORMAT, event,
3318 switch (GST_EVENT_TYPE (event)) {
3323 GST_BASE_SINK_PREROLL_LOCK (basesink);
3324 if (G_UNLIKELY (basesink->flushing))
3327 if (G_UNLIKELY (basesink->priv->received_eos))
3330 /* we set the received EOS flag here so that we can use it when testing if
3331 * we are prerolled and to refuse more buffers. */
3332 basesink->priv->received_eos = TRUE;
3334 /* EOS is a prerollable object, we call the unlocked version because it
3335 * does not check the received_eos flag. */
3336 ret = gst_base_sink_queue_object_unlocked (basesink, pad,
3337 _PR_IS_EVENT, GST_MINI_OBJECT_CAST (event), TRUE);
3338 if (G_UNLIKELY (ret != GST_FLOW_OK))
3341 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3344 case GST_EVENT_CAPS:
3348 GST_DEBUG_OBJECT (basesink, "caps %p", event);
3350 gst_event_parse_caps (event, &caps);
3351 if (bclass->set_caps)
3352 result = bclass->set_caps (basesink, caps);
3354 gst_event_unref (event);
3357 case GST_EVENT_SEGMENT:
3361 GST_DEBUG_OBJECT (basesink, "segment %p", event);
3363 GST_BASE_SINK_PREROLL_LOCK (basesink);
3364 if (G_UNLIKELY (basesink->flushing))
3367 if (G_UNLIKELY (basesink->priv->received_eos))
3370 /* the new segment is a non prerollable item and does not block anything,
3371 * we need to configure the current clipping segment and insert the event
3372 * in the queue to serialize it with the buffers for rendering. */
3373 gst_base_sink_configure_segment (basesink, pad, event,
3374 &basesink->clip_segment);
3377 gst_base_sink_queue_object_unlocked (basesink, pad,
3378 _PR_IS_EVENT, GST_MINI_OBJECT_CAST (event), FALSE);
3379 if (G_UNLIKELY (ret != GST_FLOW_OK))
3382 GST_OBJECT_LOCK (basesink);
3383 basesink->have_newsegment = TRUE;
3384 GST_OBJECT_UNLOCK (basesink);
3386 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3389 case GST_EVENT_FLUSH_START:
3391 bclass->event (basesink, event);
3393 GST_DEBUG_OBJECT (basesink, "flush-start %p", event);
3395 gst_base_sink_flush_start (basesink, pad);
3397 gst_event_unref (event);
3399 case GST_EVENT_FLUSH_STOP:
3401 gboolean reset_time;
3404 bclass->event (basesink, event);
3406 gst_event_parse_flush_stop (event, &reset_time);
3407 GST_DEBUG_OBJECT (basesink, "flush-stop %p, reset_time: %d", event,
3410 gst_base_sink_flush_stop (basesink, pad, reset_time);
3412 gst_event_unref (event);
3416 /* other events are sent to queue or subclass depending on if they
3417 * are serialized. */
3418 if (GST_EVENT_IS_SERIALIZED (event)) {
3419 gst_base_sink_queue_object (basesink, pad,
3420 GST_MINI_OBJECT_CAST (event), FALSE);
3423 bclass->event (basesink, event);
3424 gst_event_unref (event);
3434 GST_DEBUG_OBJECT (basesink, "we are flushing");
3435 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3437 gst_event_unref (event);
3443 GST_DEBUG_OBJECT (basesink, "Event received after EOS, dropping");
3444 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3446 gst_event_unref (event);
3451 /* default implementation to calculate the start and end
3452 * timestamps on a buffer, subclasses can override
3455 gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
3456 GstClockTime * start, GstClockTime * end)
3458 GstClockTime timestamp, duration;
3460 timestamp = GST_BUFFER_TIMESTAMP (buffer);
3461 if (GST_CLOCK_TIME_IS_VALID (timestamp)) {
3463 /* get duration to calculate end time */
3464 duration = GST_BUFFER_DURATION (buffer);
3465 if (GST_CLOCK_TIME_IS_VALID (duration)) {
3466 *end = timestamp + duration;
3472 /* must be called with PREROLL_LOCK */
3474 gst_base_sink_needs_preroll (GstBaseSink * basesink)
3476 gboolean is_prerolled, res;
3478 /* we have 2 cases where the PREROLL_LOCK is released:
3479 * 1) we are blocking in the PREROLL_LOCK and thus are prerolled.
3480 * 2) we are syncing on the clock
3482 is_prerolled = basesink->have_preroll || basesink->priv->received_eos;
3483 res = !is_prerolled;
3485 GST_DEBUG_OBJECT (basesink, "have_preroll: %d, EOS: %d => needs preroll: %d",
3486 basesink->have_preroll, basesink->priv->received_eos, res);
3491 /* with STREAM_LOCK, PREROLL_LOCK
3493 * Takes a buffer and compare the timestamps with the last segment.
3494 * If the buffer falls outside of the segment boundaries, drop it.
3495 * Else queue the buffer for preroll and rendering.
3497 * This function takes ownership of the buffer.
3499 static GstFlowReturn
3500 gst_base_sink_chain_unlocked (GstBaseSink * basesink, GstPad * pad,
3501 guint8 obj_type, gpointer obj)
3503 GstBaseSinkClass *bclass;
3504 GstFlowReturn result;
3505 GstClockTime start = GST_CLOCK_TIME_NONE, end = GST_CLOCK_TIME_NONE;
3506 GstSegment *clip_segment;
3507 GstBuffer *time_buf;
3509 if (G_UNLIKELY (basesink->flushing))
3512 if (G_UNLIKELY (basesink->priv->received_eos))
3515 if (OBJ_IS_BUFFERLIST (obj_type)) {
3516 time_buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0);
3517 g_assert (NULL != time_buf);
3519 time_buf = GST_BUFFER_CAST (obj);
3522 /* for code clarity */
3523 clip_segment = &basesink->clip_segment;
3525 if (G_UNLIKELY (!basesink->have_newsegment)) {
3528 sync = gst_base_sink_get_sync (basesink);
3530 GST_ELEMENT_WARNING (basesink, STREAM, FAILED,
3531 (_("Internal data flow problem.")),
3532 ("Received buffer without a new-segment. Assuming timestamps start from 0."));
3535 /* this means this sink will assume timestamps start from 0 */
3536 GST_OBJECT_LOCK (basesink);
3537 clip_segment->start = 0;
3538 clip_segment->stop = -1;
3539 basesink->segment.start = 0;
3540 basesink->segment.stop = -1;
3541 basesink->have_newsegment = TRUE;
3542 GST_OBJECT_UNLOCK (basesink);
3545 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3547 /* check if the buffer needs to be dropped, we first ask the subclass for the
3549 if (bclass->get_times)
3550 bclass->get_times (basesink, time_buf, &start, &end);
3552 if (!GST_CLOCK_TIME_IS_VALID (start)) {
3553 /* if the subclass does not want sync, we use our own values so that we at
3554 * least clip the buffer to the segment */
3555 gst_base_sink_get_times (basesink, time_buf, &start, &end);
3558 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
3559 ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (end));
3561 /* a dropped buffer does not participate in anything */
3562 if (GST_CLOCK_TIME_IS_VALID (start) &&
3563 (clip_segment->format == GST_FORMAT_TIME)) {
3564 if (G_UNLIKELY (!gst_segment_clip (clip_segment,
3565 GST_FORMAT_TIME, start, end, NULL, NULL)))
3566 goto out_of_segment;
3569 /* now we can process the buffer in the queue, this function takes ownership
3571 result = gst_base_sink_queue_object_unlocked (basesink, pad,
3572 obj_type, obj, TRUE);
3578 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3579 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3580 return GST_FLOW_WRONG_STATE;
3584 GST_DEBUG_OBJECT (basesink, "we are EOS, dropping object, return EOS");
3585 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3586 return GST_FLOW_EOS;
3590 GST_DEBUG_OBJECT (basesink, "dropping buffer, out of clipping segment");
3591 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3598 static GstFlowReturn
3599 gst_base_sink_chain_main (GstBaseSink * basesink, GstPad * pad,
3600 guint8 obj_type, gpointer obj)
3602 GstFlowReturn result;
3604 if (G_UNLIKELY (basesink->pad_mode != GST_PAD_MODE_PUSH))
3607 GST_BASE_SINK_PREROLL_LOCK (basesink);
3608 result = gst_base_sink_chain_unlocked (basesink, pad, obj_type, obj);
3609 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3617 GST_OBJECT_LOCK (pad);
3618 GST_WARNING_OBJECT (basesink,
3619 "Push on pad %s:%s, but it was not activated in push mode",
3620 GST_DEBUG_PAD_NAME (pad));
3621 GST_OBJECT_UNLOCK (pad);
3622 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3623 /* we don't post an error message this will signal to the peer
3624 * pushing that EOS is reached. */
3625 result = GST_FLOW_EOS;
3630 static GstFlowReturn
3631 gst_base_sink_chain (GstPad * pad, GstObject * parent, GstBuffer * buf)
3633 GstBaseSink *basesink;
3635 basesink = GST_BASE_SINK (parent);
3637 return gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFER, buf);
3640 static GstFlowReturn
3641 gst_base_sink_chain_list (GstPad * pad, GstObject * parent,
3642 GstBufferList * list)
3644 GstBaseSink *basesink;
3645 GstBaseSinkClass *bclass;
3646 GstFlowReturn result;
3648 basesink = GST_BASE_SINK (parent);
3649 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3651 if (G_LIKELY (bclass->render_list)) {
3652 result = gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFERLIST, list);
3657 GST_INFO_OBJECT (pad, "chaining each group in list as a merged buffer");
3659 len = gst_buffer_list_length (list);
3661 result = GST_FLOW_OK;
3662 for (i = 0; i < len; i++) {
3663 buffer = gst_buffer_list_get (list, 0);
3664 result = gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFER,
3665 gst_buffer_ref (buffer));
3666 if (result != GST_FLOW_OK)
3669 gst_buffer_list_unref (list);
3676 gst_base_sink_default_do_seek (GstBaseSink * sink, GstSegment * segment)
3678 gboolean res = TRUE;
3680 /* update our offset if the start/stop position was updated */
3681 if (segment->format == GST_FORMAT_BYTES) {
3682 segment->time = segment->start;
3683 } else if (segment->start == 0) {
3684 /* seek to start, we can implement a default for this. */
3688 GST_INFO_OBJECT (sink, "Can't do a default seek");
3694 #define SEEK_TYPE_IS_RELATIVE(t) (((t) != GST_SEEK_TYPE_NONE) && ((t) != GST_SEEK_TYPE_SET))
3697 gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
3698 GstEvent * event, GstSegment * segment)
3700 /* By default, we try one of 2 things:
3701 * - For absolute seek positions, convert the requested position to our
3702 * configured processing format and place it in the output segment \
3703 * - For relative seek positions, convert our current (input) values to the
3704 * seek format, adjust by the relative seek offset and then convert back to
3705 * the processing format
3707 GstSeekType cur_type, stop_type;
3710 GstFormat seek_format;
3713 gboolean res = TRUE;
3715 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3716 &cur_type, &cur, &stop_type, &stop);
3718 if (seek_format == segment->format) {
3719 gst_segment_do_seek (segment, rate, seek_format, flags,
3720 cur_type, cur, stop_type, stop, &update);
3724 if (cur_type != GST_SEEK_TYPE_NONE) {
3725 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3727 gst_pad_query_convert (sink->sinkpad, seek_format, cur, segment->format,
3729 cur_type = GST_SEEK_TYPE_SET;
3732 if (res && stop_type != GST_SEEK_TYPE_NONE) {
3733 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3735 gst_pad_query_convert (sink->sinkpad, seek_format, stop,
3736 segment->format, &stop);
3737 stop_type = GST_SEEK_TYPE_SET;
3740 /* And finally, configure our output segment in the desired format */
3741 gst_segment_do_seek (segment, rate, segment->format, flags, cur_type, cur,
3742 stop_type, stop, &update);
3751 GST_DEBUG_OBJECT (sink, "undefined format given, seek aborted.");
3756 /* perform a seek, only executed in pull mode */
3758 gst_base_sink_perform_seek (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3762 GstFormat seek_format, dest_format;
3764 GstSeekType cur_type, stop_type;
3765 gboolean seekseg_configured = FALSE;
3767 gboolean update, res = TRUE;
3768 GstSegment seeksegment;
3770 dest_format = sink->segment.format;
3773 GST_DEBUG_OBJECT (sink, "performing seek with event %p", event);
3774 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3775 &cur_type, &cur, &stop_type, &stop);
3777 flush = flags & GST_SEEK_FLAG_FLUSH;
3779 GST_DEBUG_OBJECT (sink, "performing seek without event");
3784 GST_DEBUG_OBJECT (sink, "flushing upstream");
3785 gst_pad_push_event (pad, gst_event_new_flush_start ());
3786 gst_base_sink_flush_start (sink, pad);
3788 GST_DEBUG_OBJECT (sink, "pausing pulling thread");
3791 GST_PAD_STREAM_LOCK (pad);
3793 /* If we configured the seeksegment above, don't overwrite it now. Otherwise
3794 * copy the current segment info into the temp segment that we can actually
3795 * attempt the seek with. We only update the real segment if the seek succeeds. */
3796 if (!seekseg_configured) {
3797 memcpy (&seeksegment, &sink->segment, sizeof (GstSegment));
3799 /* now configure the final seek segment */
3801 if (sink->segment.format != seek_format) {
3802 /* OK, here's where we give the subclass a chance to convert the relative
3803 * seek into an absolute one in the processing format. We set up any
3804 * absolute seek above, before taking the stream lock. */
3805 if (!gst_base_sink_default_prepare_seek_segment (sink, event,
3807 GST_DEBUG_OBJECT (sink,
3808 "Preparing the seek failed after flushing. " "Aborting seek");
3812 /* The seek format matches our processing format, no need to ask the
3813 * the subclass to configure the segment. */
3814 gst_segment_do_seek (&seeksegment, rate, seek_format, flags,
3815 cur_type, cur, stop_type, stop, &update);
3818 /* Else, no seek event passed, so we're just (re)starting the
3823 GST_DEBUG_OBJECT (sink, "segment configured from %" G_GINT64_FORMAT
3824 " to %" G_GINT64_FORMAT ", position %" G_GINT64_FORMAT,
3825 seeksegment.start, seeksegment.stop, seeksegment.position);
3827 /* do the seek, segment.position contains the new position. */
3828 res = gst_base_sink_default_do_seek (sink, &seeksegment);
3833 GST_DEBUG_OBJECT (sink, "stop flushing upstream");
3834 gst_pad_push_event (pad, gst_event_new_flush_stop (TRUE));
3835 gst_base_sink_flush_stop (sink, pad, TRUE);
3836 } else if (res && sink->running) {
3837 /* we are running the current segment and doing a non-flushing seek,
3838 * close the segment first based on the position. */
3839 GST_DEBUG_OBJECT (sink, "closing running segment %" G_GINT64_FORMAT
3840 " to %" G_GINT64_FORMAT, sink->segment.start, sink->segment.position);
3843 /* The subclass must have converted the segment to the processing format
3845 if (res && seeksegment.format != dest_format) {
3846 GST_DEBUG_OBJECT (sink, "Subclass failed to prepare a seek segment "
3847 "in the correct format. Aborting seek.");
3851 /* if successful seek, we update our real segment and push
3852 * out the new segment. */
3854 gst_segment_copy_into (&seeksegment, &sink->segment);
3856 if (sink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3857 gst_element_post_message (GST_ELEMENT (sink),
3858 gst_message_new_segment_start (GST_OBJECT (sink),
3859 sink->segment.format, sink->segment.position));
3863 sink->priv->discont = TRUE;
3864 sink->running = TRUE;
3866 GST_PAD_STREAM_UNLOCK (pad);
3872 set_step_info (GstBaseSink * sink, GstStepInfo * current, GstStepInfo * pending,
3873 guint seqnum, GstFormat format, guint64 amount, gdouble rate,
3874 gboolean flush, gboolean intermediate)
3876 GST_OBJECT_LOCK (sink);
3877 pending->seqnum = seqnum;
3878 pending->format = format;
3879 pending->amount = amount;
3880 pending->position = 0;
3881 pending->rate = rate;
3882 pending->flush = flush;
3883 pending->intermediate = intermediate;
3884 pending->valid = TRUE;
3885 /* flush invalidates the current stepping segment */
3887 current->valid = FALSE;
3888 GST_OBJECT_UNLOCK (sink);
3892 gst_base_sink_perform_step (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3894 GstBaseSinkPrivate *priv;
3895 GstBaseSinkClass *bclass;
3896 gboolean flush, intermediate;
3901 GstStepInfo *pending, *current;
3902 GstMessage *message;
3904 bclass = GST_BASE_SINK_GET_CLASS (sink);
3907 GST_DEBUG_OBJECT (sink, "performing step with event %p", event);
3909 gst_event_parse_step (event, &format, &amount, &rate, &flush, &intermediate);
3910 seqnum = gst_event_get_seqnum (event);
3912 pending = &priv->pending_step;
3913 current = &priv->current_step;
3915 /* post message first */
3916 message = gst_message_new_step_start (GST_OBJECT (sink), FALSE, format,
3917 amount, rate, flush, intermediate);
3918 gst_message_set_seqnum (message, seqnum);
3919 gst_element_post_message (GST_ELEMENT (sink), message);
3922 /* we need to call ::unlock before locking PREROLL_LOCK
3923 * since we lock it before going into ::render */
3925 bclass->unlock (sink);
3927 GST_BASE_SINK_PREROLL_LOCK (sink);
3928 /* now that we have the PREROLL lock, clear our unlock request */
3929 if (bclass->unlock_stop)
3930 bclass->unlock_stop (sink);
3932 /* update the stepinfo and make it valid */
3933 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3936 if (sink->priv->async_enabled) {
3937 /* and we need to commit our state again on the next
3938 * prerolled buffer */
3939 sink->playing_async = TRUE;
3940 priv->pending_step.need_preroll = TRUE;
3941 sink->need_preroll = FALSE;
3942 gst_element_lost_state (GST_ELEMENT_CAST (sink));
3944 sink->priv->have_latency = TRUE;
3945 sink->need_preroll = FALSE;
3947 priv->current_sstart = GST_CLOCK_TIME_NONE;
3948 priv->current_sstop = GST_CLOCK_TIME_NONE;
3949 priv->eos_rtime = GST_CLOCK_TIME_NONE;
3950 priv->call_preroll = TRUE;
3951 gst_base_sink_set_last_buffer (sink, NULL);
3952 gst_base_sink_reset_qos (sink);
3954 if (sink->clock_id) {
3955 gst_clock_id_unschedule (sink->clock_id);
3958 if (sink->have_preroll) {
3959 GST_DEBUG_OBJECT (sink, "signal waiter");
3960 priv->step_unlock = TRUE;
3961 GST_BASE_SINK_PREROLL_SIGNAL (sink);
3963 GST_BASE_SINK_PREROLL_UNLOCK (sink);
3965 /* update the stepinfo and make it valid */
3966 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3976 gst_base_sink_loop (GstPad * pad)
3979 GstBaseSink *basesink;
3980 GstBuffer *buf = NULL;
3981 GstFlowReturn result;
3985 parent = GST_OBJECT_PARENT (pad);
3986 basesink = GST_BASE_SINK (parent);
3988 g_assert (basesink->pad_mode == GST_PAD_MODE_PULL);
3990 if ((blocksize = basesink->priv->blocksize) == 0)
3993 offset = basesink->segment.position;
3995 GST_DEBUG_OBJECT (basesink, "pulling %" G_GUINT64_FORMAT ", %u",
3998 result = gst_pad_pull_range (pad, offset, blocksize, &buf);
3999 if (G_UNLIKELY (result != GST_FLOW_OK))
4002 if (G_UNLIKELY (buf == NULL))
4005 offset += gst_buffer_get_size (buf);
4007 basesink->segment.position = offset;
4009 GST_BASE_SINK_PREROLL_LOCK (basesink);
4010 result = gst_base_sink_chain_unlocked (basesink, pad, _PR_IS_BUFFER, buf);
4011 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4012 if (G_UNLIKELY (result != GST_FLOW_OK))
4020 GST_LOG_OBJECT (basesink, "pausing task, reason %s",
4021 gst_flow_get_name (result));
4022 gst_pad_pause_task (pad);
4023 if (result == GST_FLOW_EOS) {
4024 /* perform EOS logic */
4025 if (basesink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
4026 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4027 gst_message_new_segment_done (GST_OBJECT_CAST (basesink),
4028 basesink->segment.format, basesink->segment.position));
4030 gst_base_sink_event (pad, parent, gst_event_new_eos ());
4032 } else if (result == GST_FLOW_NOT_LINKED || result <= GST_FLOW_EOS) {
4033 /* for fatal errors we post an error message, post the error
4034 * first so the app knows about the error first.
4035 * wrong-state is not a fatal error because it happens due to
4036 * flushing and posting an error message in that case is the
4037 * wrong thing to do, e.g. when basesrc is doing a flushing
4039 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
4040 (_("Internal data stream error.")),
4041 ("stream stopped, reason %s", gst_flow_get_name (result)));
4042 gst_base_sink_event (pad, parent, gst_event_new_eos ());
4048 GST_LOG_OBJECT (basesink, "no buffer, pausing");
4049 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
4050 (_("Internal data flow error.")), ("element returned NULL buffer"));
4051 result = GST_FLOW_ERROR;
4057 gst_base_sink_set_flushing (GstBaseSink * basesink, GstPad * pad,
4060 GstBaseSinkClass *bclass;
4062 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4065 /* unlock any subclasses, we need to do this before grabbing the
4066 * PREROLL_LOCK since we hold this lock before going into ::render. */
4068 bclass->unlock (basesink);
4071 GST_BASE_SINK_PREROLL_LOCK (basesink);
4072 basesink->flushing = flushing;
4074 /* step 1, now that we have the PREROLL lock, clear our unlock request */
4075 if (bclass->unlock_stop)
4076 bclass->unlock_stop (basesink);
4078 /* set need_preroll before we unblock the clock. If the clock is unblocked
4079 * before timing out, we can reuse the buffer for preroll. */
4080 basesink->need_preroll = TRUE;
4082 /* step 2, unblock clock sync (if any) or any other blocking thing */
4083 if (basesink->clock_id) {
4084 gst_clock_id_unschedule (basesink->clock_id);
4087 /* flush out the data thread if it's locked in finish_preroll, this will
4088 * also flush out the EOS state */
4089 GST_DEBUG_OBJECT (basesink,
4090 "flushing out data thread, need preroll to TRUE");
4091 gst_base_sink_preroll_queue_flush (basesink, pad);
4093 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4099 gst_base_sink_default_activate_pull (GstBaseSink * basesink, gboolean active)
4105 result = gst_pad_start_task (basesink->sinkpad,
4106 (GstTaskFunction) gst_base_sink_loop, basesink->sinkpad);
4108 /* step 2, make sure streaming finishes */
4109 result = gst_pad_stop_task (basesink->sinkpad);
4116 gst_base_sink_pad_activate (GstPad * pad)
4118 gboolean result = FALSE;
4119 GstBaseSink *basesink;
4123 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4125 GST_DEBUG_OBJECT (basesink, "Trying pull mode first");
4127 gst_base_sink_set_flushing (basesink, pad, FALSE);
4129 /* we need to have the pull mode enabled */
4130 if (!basesink->can_activate_pull) {
4131 GST_DEBUG_OBJECT (basesink, "pull mode disabled");
4135 /* check if downstreams supports pull mode at all */
4136 query = gst_query_new_scheduling ();
4138 if (!gst_pad_peer_query (pad, query)) {
4139 gst_query_unref (query);
4140 GST_DEBUG_OBJECT (basesink, "peer query faild, no pull mode");
4144 /* parse result of the query */
4145 gst_query_parse_scheduling (query, &pull_mode, NULL, NULL, NULL, NULL, NULL);
4146 gst_query_unref (query);
4149 GST_DEBUG_OBJECT (basesink, "pull mode not supported");
4153 /* set the pad mode before starting the task so that it's in the
4154 * correct state for the new thread. also the sink set_caps and get_caps
4155 * function checks this */
4156 basesink->pad_mode = GST_PAD_MODE_PULL;
4158 /* we first try to negotiate a format so that when we try to activate
4159 * downstream, it knows about our format */
4160 if (!gst_base_sink_negotiate_pull (basesink)) {
4161 GST_DEBUG_OBJECT (basesink, "failed to negotiate in pull mode");
4165 /* ok activate now */
4166 if (!gst_pad_activate_pull (pad, TRUE)) {
4167 /* clear any pending caps */
4168 GST_OBJECT_LOCK (basesink);
4169 gst_caps_replace (&basesink->priv->pull_caps, NULL);
4170 GST_OBJECT_UNLOCK (basesink);
4171 GST_DEBUG_OBJECT (basesink, "failed to activate in pull mode");
4175 GST_DEBUG_OBJECT (basesink, "Success activating pull mode");
4179 /* push mode fallback */
4181 GST_DEBUG_OBJECT (basesink, "Falling back to push mode");
4182 if ((result = gst_pad_activate_push (pad, TRUE))) {
4183 GST_DEBUG_OBJECT (basesink, "Success activating push mode");
4188 GST_WARNING_OBJECT (basesink, "Could not activate pad in either mode");
4189 gst_base_sink_set_flushing (basesink, pad, TRUE);
4192 gst_object_unref (basesink);
4198 gst_base_sink_pad_activate_push (GstPad * pad, gboolean active)
4201 GstBaseSink *basesink;
4203 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4206 if (!basesink->can_activate_push) {
4208 basesink->pad_mode = GST_PAD_MODE_NONE;
4211 basesink->pad_mode = GST_PAD_MODE_PUSH;
4214 if (G_UNLIKELY (basesink->pad_mode != GST_PAD_MODE_PUSH)) {
4215 g_warning ("Internal GStreamer activation error!!!");
4218 gst_base_sink_set_flushing (basesink, pad, TRUE);
4220 basesink->pad_mode = GST_PAD_MODE_NONE;
4224 gst_object_unref (basesink);
4230 gst_base_sink_negotiate_pull (GstBaseSink * basesink)
4237 /* this returns the intersection between our caps and the peer caps. If there
4238 * is no peer, it returns NULL and we can't operate in pull mode so we can
4239 * fail the negotiation. */
4240 caps = gst_pad_get_allowed_caps (GST_BASE_SINK_PAD (basesink));
4241 if (caps == NULL || gst_caps_is_empty (caps))
4242 goto no_caps_possible;
4244 GST_DEBUG_OBJECT (basesink, "allowed caps: %" GST_PTR_FORMAT, caps);
4246 if (gst_caps_is_any (caps)) {
4247 GST_DEBUG_OBJECT (basesink, "caps were ANY after fixating, "
4249 /* neither side has template caps in this case, so they are prepared for
4250 pull() without setcaps() */
4253 caps = gst_caps_make_writable (caps);
4255 gst_base_sink_fixate (basesink, caps);
4256 GST_DEBUG_OBJECT (basesink, "fixated to: %" GST_PTR_FORMAT, caps);
4258 if (gst_caps_is_fixed (caps)) {
4259 if (!gst_pad_send_event (GST_BASE_SINK_PAD (basesink),
4260 gst_event_new_caps (caps)))
4261 goto could_not_set_caps;
4263 GST_OBJECT_LOCK (basesink);
4264 gst_caps_replace (&basesink->priv->pull_caps, caps);
4265 GST_OBJECT_UNLOCK (basesink);
4271 gst_caps_unref (caps);
4277 GST_INFO_OBJECT (basesink, "Pipeline could not agree on caps");
4278 GST_DEBUG_OBJECT (basesink, "get_allowed_caps() returned EMPTY");
4280 gst_caps_unref (caps);
4285 GST_INFO_OBJECT (basesink, "Could not set caps: %" GST_PTR_FORMAT, caps);
4286 gst_caps_unref (caps);
4291 /* this won't get called until we implement an activate function */
4293 gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active)
4295 gboolean result = FALSE;
4296 GstBaseSink *basesink;
4297 GstBaseSinkClass *bclass;
4299 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4300 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4305 /* we mark we have a newsegment here because pull based
4306 * mode works just fine without having a newsegment before the
4308 gst_segment_init (&basesink->segment, GST_FORMAT_BYTES);
4309 gst_segment_init (&basesink->clip_segment, GST_FORMAT_BYTES);
4310 GST_OBJECT_LOCK (basesink);
4311 basesink->have_newsegment = TRUE;
4312 GST_OBJECT_UNLOCK (basesink);
4314 /* get the peer duration in bytes */
4315 result = gst_pad_peer_query_duration (pad, GST_FORMAT_BYTES, &duration);
4317 GST_DEBUG_OBJECT (basesink,
4318 "setting duration in bytes to %" G_GINT64_FORMAT, duration);
4319 basesink->clip_segment.duration = duration;
4320 basesink->segment.duration = duration;
4322 GST_DEBUG_OBJECT (basesink, "unknown duration");
4325 if (bclass->activate_pull)
4326 result = bclass->activate_pull (basesink, TRUE);
4331 goto activate_failed;
4334 if (G_UNLIKELY (basesink->pad_mode != GST_PAD_MODE_PULL)) {
4335 g_warning ("Internal GStreamer activation error!!!");
4338 result = gst_base_sink_set_flushing (basesink, pad, TRUE);
4339 if (bclass->activate_pull)
4340 result &= bclass->activate_pull (basesink, FALSE);
4341 basesink->pad_mode = GST_PAD_MODE_NONE;
4342 /* clear any pending caps */
4343 GST_OBJECT_LOCK (basesink);
4344 gst_caps_replace (&basesink->priv->pull_caps, NULL);
4345 GST_OBJECT_UNLOCK (basesink);
4348 gst_object_unref (basesink);
4355 /* reset, as starting the thread failed */
4356 basesink->pad_mode = GST_PAD_MODE_NONE;
4358 GST_ERROR_OBJECT (basesink, "subclass failed to activate in pull mode");
4363 /* send an event to our sinkpad peer. */
4365 gst_base_sink_send_event (GstElement * element, GstEvent * event)
4368 GstBaseSink *basesink = GST_BASE_SINK (element);
4369 gboolean forward, result = TRUE;
4372 GST_OBJECT_LOCK (element);
4373 /* get the pad and the scheduling mode */
4374 pad = gst_object_ref (basesink->sinkpad);
4375 mode = basesink->pad_mode;
4376 GST_OBJECT_UNLOCK (element);
4378 /* only push UPSTREAM events upstream */
4379 forward = GST_EVENT_IS_UPSTREAM (event);
4381 GST_DEBUG_OBJECT (basesink, "handling event %p %" GST_PTR_FORMAT, event,
4384 switch (GST_EVENT_TYPE (event)) {
4385 case GST_EVENT_LATENCY:
4387 GstClockTime latency;
4389 gst_event_parse_latency (event, &latency);
4391 /* store the latency. We use this to adjust the running_time before syncing
4392 * it to the clock. */
4393 GST_OBJECT_LOCK (element);
4394 basesink->priv->latency = latency;
4395 if (!basesink->priv->have_latency)
4397 GST_OBJECT_UNLOCK (element);
4398 GST_DEBUG_OBJECT (basesink, "latency set to %" GST_TIME_FORMAT,
4399 GST_TIME_ARGS (latency));
4401 /* We forward this event so that all elements know about the global pipeline
4402 * latency. This is interesting for an element when it wants to figure out
4403 * when a particular piece of data will be rendered. */
4406 case GST_EVENT_SEEK:
4407 /* in pull mode we will execute the seek */
4408 if (mode == GST_PAD_MODE_PULL)
4409 result = gst_base_sink_perform_seek (basesink, pad, event);
4411 case GST_EVENT_STEP:
4412 result = gst_base_sink_perform_step (basesink, pad, event);
4420 result = gst_pad_push_event (pad, event);
4422 /* not forwarded, unref the event */
4423 gst_event_unref (event);
4426 gst_object_unref (pad);
4428 GST_DEBUG_OBJECT (basesink, "handled event %p %" GST_PTR_FORMAT ": %d", event,
4435 gst_base_sink_get_position (GstBaseSink * basesink, GstFormat format,
4436 gint64 * cur, gboolean * upstream)
4438 GstClock *clock = NULL;
4439 gboolean res = FALSE;
4441 GstSegment *segment;
4442 GstClockTime now, latency;
4443 GstClockTimeDiff base_time;
4444 gint64 time, base, duration;
4447 gboolean last_seen, with_clock, in_paused;
4449 GST_OBJECT_LOCK (basesink);
4450 /* we can only get the segment when we are not NULL or READY */
4451 if (!basesink->have_newsegment)
4455 /* when not in PLAYING or when we're busy with a state change, we
4456 * cannot read from the clock so we report time based on the
4457 * last seen timestamp. */
4458 if (GST_STATE (basesink) != GST_STATE_PLAYING ||
4459 GST_STATE_PENDING (basesink) != GST_STATE_VOID_PENDING) {
4463 /* we don't use the clip segment in pull mode, when seeking we update the
4464 * main segment directly with the new segment values without it having to be
4465 * activated by the rendering after preroll */
4466 if (basesink->pad_mode == GST_PAD_MODE_PUSH)
4467 segment = &basesink->clip_segment;
4469 segment = &basesink->segment;
4471 /* get the format in the segment */
4472 oformat = segment->format;
4474 /* report with last seen position when EOS */
4475 last_seen = basesink->eos;
4477 /* assume we will use the clock for getting the current position */
4479 if (basesink->sync == FALSE)
4482 /* and we need a clock */
4483 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (basesink)) == NULL))
4486 gst_object_ref (clock);
4488 /* mainloop might be querying position when going to playing async,
4489 * while (audio) rendering might be quickly advancing stream position,
4490 * so use clock asap rather than last reported position */
4491 if (in_paused && with_clock && g_atomic_int_get (&basesink->priv->to_playing)) {
4492 GST_DEBUG_OBJECT (basesink, "going to PLAYING, so not PAUSED");
4496 /* collect all data we need holding the lock */
4497 if (GST_CLOCK_TIME_IS_VALID (segment->time))
4498 time = segment->time;
4502 if (GST_CLOCK_TIME_IS_VALID (segment->stop))
4503 duration = segment->stop - segment->start;
4507 base = segment->base;
4508 rate = segment->rate * segment->applied_rate;
4509 latency = basesink->priv->latency;
4511 if (oformat == GST_FORMAT_TIME) {
4514 start = basesink->priv->current_sstart;
4515 stop = basesink->priv->current_sstop;
4518 /* in paused we use the last position as a lower bound */
4519 if (stop == -1 || segment->rate > 0.0)
4524 /* in playing, use last stop time as upper bound */
4525 if (start == -1 || segment->rate > 0.0)
4531 /* convert last stop to stream time */
4532 last = gst_segment_to_stream_time (segment, oformat, segment->position);
4536 /* in paused, use start_time */
4537 base_time = GST_ELEMENT_START_TIME (basesink);
4538 GST_DEBUG_OBJECT (basesink, "in paused, using start time %" GST_TIME_FORMAT,
4539 GST_TIME_ARGS (base_time));
4540 } else if (with_clock) {
4541 /* else use clock when needed */
4542 base_time = GST_ELEMENT_CAST (basesink)->base_time;
4543 GST_DEBUG_OBJECT (basesink, "using clock and base time %" GST_TIME_FORMAT,
4544 GST_TIME_ARGS (base_time));
4546 /* else, no sync or clock -> no base time */
4547 GST_DEBUG_OBJECT (basesink, "no sync or no clock");
4551 /* no base_time, we can't calculate running_time, use last seem timestamp to report
4553 if (base_time == -1)
4556 /* need to release the object lock before we can get the time,
4557 * a clock might take the LOCK of the provider, which could be
4558 * a basesink subclass. */
4559 GST_OBJECT_UNLOCK (basesink);
4562 /* in EOS or when no valid stream_time, report the value of last seen
4565 /* no timestamp, we need to ask upstream */
4566 GST_DEBUG_OBJECT (basesink, "no last seen timestamp, asking upstream");
4571 GST_DEBUG_OBJECT (basesink, "using last seen timestamp %" GST_TIME_FORMAT,
4572 GST_TIME_ARGS (last));
4575 if (oformat != GST_FORMAT_TIME) {
4576 /* convert base, time and duration to time */
4577 if (!gst_pad_query_convert (basesink->sinkpad, oformat, base,
4578 GST_FORMAT_TIME, &base))
4579 goto convert_failed;
4580 if (!gst_pad_query_convert (basesink->sinkpad, oformat, duration,
4581 GST_FORMAT_TIME, &duration))
4582 goto convert_failed;
4583 if (!gst_pad_query_convert (basesink->sinkpad, oformat, time,
4584 GST_FORMAT_TIME, &time))
4585 goto convert_failed;
4586 if (!gst_pad_query_convert (basesink->sinkpad, oformat, last,
4587 GST_FORMAT_TIME, &last))
4588 goto convert_failed;
4590 /* assume time format from now on */
4591 oformat = GST_FORMAT_TIME;
4594 if (!in_paused && with_clock) {
4595 now = gst_clock_get_time (clock);
4601 /* subtract base time and base time from the clock time.
4602 * Make sure we don't go negative. This is the current time in
4603 * the segment which we need to scale with the combined
4604 * rate and applied rate. */
4606 base_time += latency;
4607 if (GST_CLOCK_DIFF (base_time, now) < 0)
4610 /* for negative rates we need to count back from the segment
4615 *cur = time + gst_guint64_to_gdouble (now - base_time) * rate;
4618 /* never report less than segment values in paused */
4620 *cur = MAX (last, *cur);
4622 /* never report more than last seen position in playing */
4624 *cur = MIN (last, *cur);
4627 GST_DEBUG_OBJECT (basesink,
4628 "now %" GST_TIME_FORMAT " - base_time %" GST_TIME_FORMAT " - base %"
4629 GST_TIME_FORMAT " + time %" GST_TIME_FORMAT " last %" GST_TIME_FORMAT,
4630 GST_TIME_ARGS (now), GST_TIME_ARGS (base_time), GST_TIME_ARGS (base),
4631 GST_TIME_ARGS (time), GST_TIME_ARGS (last));
4634 if (oformat != format) {
4635 /* convert to final format */
4636 if (!gst_pad_query_convert (basesink->sinkpad, oformat, *cur, format, cur))
4637 goto convert_failed;
4643 GST_DEBUG_OBJECT (basesink, "res: %d, POSITION: %" GST_TIME_FORMAT,
4644 res, GST_TIME_ARGS (*cur));
4647 gst_object_unref (clock);
4654 /* in NULL or READY we always return FALSE and -1 */
4655 GST_DEBUG_OBJECT (basesink, "position in wrong state, return -1");
4658 GST_OBJECT_UNLOCK (basesink);
4663 GST_DEBUG_OBJECT (basesink, "convert failed, try upstream");
4671 gst_base_sink_get_duration (GstBaseSink * basesink, GstFormat format,
4672 gint64 * dur, gboolean * upstream)
4674 gboolean res = FALSE;
4676 if (basesink->pad_mode == GST_PAD_MODE_PULL) {
4679 /* get the duration in bytes, in pull mode that's all we are sure to
4680 * know. We have to explicitly get this value from upstream instead of
4681 * using our cached value because it might change. Duration caching
4682 * should be done at a higher level. */
4684 gst_pad_peer_query_duration (basesink->sinkpad, GST_FORMAT_BYTES,
4687 basesink->segment.duration = uduration;
4688 if (format != GST_FORMAT_BYTES) {
4689 /* convert to the requested format */
4691 gst_pad_query_convert (basesink->sinkpad, GST_FORMAT_BYTES,
4692 uduration, format, dur);
4706 default_element_query (GstElement * element, GstQuery * query)
4708 gboolean res = FALSE;
4710 GstBaseSink *basesink = GST_BASE_SINK (element);
4712 switch (GST_QUERY_TYPE (query)) {
4713 case GST_QUERY_POSITION:
4717 gboolean upstream = FALSE;
4719 gst_query_parse_position (query, &format, NULL);
4721 GST_DEBUG_OBJECT (basesink, "position query in format %s",
4722 gst_format_get_name (format));
4724 /* first try to get the position based on the clock */
4726 gst_base_sink_get_position (basesink, format, &cur, &upstream))) {
4727 gst_query_set_position (query, format, cur);
4728 } else if (upstream) {
4729 /* fallback to peer query */
4730 res = gst_pad_peer_query (basesink->sinkpad, query);
4733 /* we can handle a few things if upstream failed */
4734 if (format == GST_FORMAT_PERCENT) {
4737 res = gst_base_sink_get_position (basesink, GST_FORMAT_TIME, &cur,
4739 if (!res && upstream) {
4741 gst_pad_peer_query_position (basesink->sinkpad, GST_FORMAT_TIME,
4745 res = gst_base_sink_get_duration (basesink, GST_FORMAT_TIME, &dur,
4747 if (!res && upstream) {
4749 gst_pad_peer_query_duration (basesink->sinkpad,
4750 GST_FORMAT_TIME, &dur);
4756 pos = gst_util_uint64_scale (100 * GST_FORMAT_PERCENT_SCALE, cur,
4758 gst_query_set_position (query, GST_FORMAT_PERCENT, pos);
4764 case GST_QUERY_DURATION:
4768 gboolean upstream = FALSE;
4770 gst_query_parse_duration (query, &format, NULL);
4772 GST_DEBUG_OBJECT (basesink, "duration query in format %s",
4773 gst_format_get_name (format));
4776 gst_base_sink_get_duration (basesink, format, &dur, &upstream))) {
4777 gst_query_set_duration (query, format, dur);
4778 } else if (upstream) {
4779 /* fallback to peer query */
4780 res = gst_pad_peer_query (basesink->sinkpad, query);
4783 /* we can handle a few things if upstream failed */
4784 if (format == GST_FORMAT_PERCENT) {
4785 gst_query_set_duration (query, GST_FORMAT_PERCENT,
4786 GST_FORMAT_PERCENT_MAX);
4792 case GST_QUERY_LATENCY:
4794 gboolean live, us_live;
4795 GstClockTime min, max;
4797 if ((res = gst_base_sink_query_latency (basesink, &live, &us_live, &min,
4799 gst_query_set_latency (query, live, min, max);
4803 case GST_QUERY_JITTER:
4805 case GST_QUERY_RATE:
4806 /* gst_query_set_rate (query, basesink->segment_rate); */
4809 case GST_QUERY_SEGMENT:
4811 if (basesink->pad_mode == GST_PAD_MODE_PULL) {
4812 gst_query_set_segment (query, basesink->segment.rate,
4813 GST_FORMAT_TIME, basesink->segment.start, basesink->segment.stop);
4816 res = gst_pad_peer_query (basesink->sinkpad, query);
4820 case GST_QUERY_SEEKING:
4821 case GST_QUERY_CONVERT:
4822 case GST_QUERY_FORMATS:
4824 res = gst_pad_peer_query (basesink->sinkpad, query);
4827 GST_DEBUG_OBJECT (basesink, "query %s returns %d",
4828 GST_QUERY_TYPE_NAME (query), res);
4834 default_sink_query (GstBaseSink * basesink, GstQuery * query)
4837 GstBaseSinkClass *bclass;
4839 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4841 switch (GST_QUERY_TYPE (query)) {
4842 case GST_QUERY_ALLOCATION:
4844 if (bclass->propose_allocation)
4845 res = bclass->propose_allocation (basesink, query);
4850 case GST_QUERY_CAPS:
4852 GstCaps *caps, *filter;
4854 gst_query_parse_caps (query, &filter);
4855 caps = gst_base_sink_query_caps (basesink, basesink->sinkpad, filter);
4856 gst_query_set_caps_result (query, caps);
4857 gst_caps_unref (caps);
4863 gst_pad_query_default (basesink->sinkpad, GST_OBJECT_CAST (basesink),
4871 gst_base_sink_sink_query (GstPad * pad, GstObject * parent, GstQuery * query)
4873 GstBaseSink *basesink;
4874 GstBaseSinkClass *bclass;
4877 basesink = GST_BASE_SINK_CAST (parent);
4878 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4881 res = bclass->query (basesink, query);
4888 static GstStateChangeReturn
4889 gst_base_sink_change_state (GstElement * element, GstStateChange transition)
4891 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
4892 GstBaseSink *basesink = GST_BASE_SINK (element);
4893 GstBaseSinkClass *bclass;
4894 GstBaseSinkPrivate *priv;
4896 priv = basesink->priv;
4898 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4900 switch (transition) {
4901 case GST_STATE_CHANGE_NULL_TO_READY:
4903 if (!bclass->start (basesink))
4906 case GST_STATE_CHANGE_READY_TO_PAUSED:
4907 /* need to complete preroll before this state change completes, there
4908 * is no data flow in READY so we can safely assume we need to preroll. */
4909 GST_BASE_SINK_PREROLL_LOCK (basesink);
4910 GST_DEBUG_OBJECT (basesink, "READY to PAUSED");
4911 basesink->have_newsegment = FALSE;
4912 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
4913 gst_segment_init (&basesink->clip_segment, GST_FORMAT_UNDEFINED);
4914 basesink->offset = 0;
4915 basesink->have_preroll = FALSE;
4916 priv->step_unlock = FALSE;
4917 basesink->need_preroll = TRUE;
4918 basesink->playing_async = TRUE;
4919 basesink->priv->reset_time = FALSE;
4920 priv->current_sstart = GST_CLOCK_TIME_NONE;
4921 priv->current_sstop = GST_CLOCK_TIME_NONE;
4922 priv->eos_rtime = GST_CLOCK_TIME_NONE;
4924 basesink->eos = FALSE;
4925 priv->received_eos = FALSE;
4926 gst_base_sink_reset_qos (basesink);
4927 priv->commited = FALSE;
4928 priv->call_preroll = TRUE;
4929 priv->current_step.valid = FALSE;
4930 priv->pending_step.valid = FALSE;
4931 if (priv->async_enabled) {
4932 GST_DEBUG_OBJECT (basesink, "doing async state change");
4933 /* when async enabled, post async-start message and return ASYNC from
4934 * the state change function */
4935 ret = GST_STATE_CHANGE_ASYNC;
4936 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4937 gst_message_new_async_start (GST_OBJECT_CAST (basesink)));
4939 priv->have_latency = TRUE;
4941 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4943 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
4944 GST_BASE_SINK_PREROLL_LOCK (basesink);
4945 g_atomic_int_set (&basesink->priv->to_playing, TRUE);
4946 if (!gst_base_sink_needs_preroll (basesink)) {
4947 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, don't need preroll");
4948 /* no preroll needed anymore now. */
4949 basesink->playing_async = FALSE;
4950 basesink->need_preroll = FALSE;
4951 if (basesink->eos) {
4952 GstMessage *message;
4954 /* need to post EOS message here */
4955 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
4956 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
4957 gst_message_set_seqnum (message, basesink->priv->seqnum);
4958 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
4960 GST_DEBUG_OBJECT (basesink, "signal preroll");
4961 GST_BASE_SINK_PREROLL_SIGNAL (basesink);
4964 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, we are not prerolled");
4965 basesink->need_preroll = TRUE;
4966 basesink->playing_async = TRUE;
4967 priv->call_preroll = TRUE;
4968 priv->commited = FALSE;
4969 if (priv->async_enabled) {
4970 GST_DEBUG_OBJECT (basesink, "doing async state change");
4971 ret = GST_STATE_CHANGE_ASYNC;
4972 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4973 gst_message_new_async_start (GST_OBJECT_CAST (basesink)));
4976 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4983 GstStateChangeReturn bret;
4985 bret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
4986 if (G_UNLIKELY (bret == GST_STATE_CHANGE_FAILURE))
4987 goto activate_failed;
4990 switch (transition) {
4991 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
4992 /* completed transition, so need not be marked any longer
4993 * And it should be unmarked, since e.g. losing our position upon flush
4994 * does not really change state to PAUSED ... */
4995 g_atomic_int_set (&basesink->priv->to_playing, FALSE);
4997 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
4998 g_atomic_int_set (&basesink->priv->to_playing, FALSE);
4999 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED");
5000 /* FIXME, make sure we cannot enter _render first */
5002 /* we need to call ::unlock before locking PREROLL_LOCK
5003 * since we lock it before going into ::render */
5005 bclass->unlock (basesink);
5007 GST_BASE_SINK_PREROLL_LOCK (basesink);
5008 GST_DEBUG_OBJECT (basesink, "got preroll lock");
5009 /* now that we have the PREROLL lock, clear our unlock request */
5010 if (bclass->unlock_stop)
5011 bclass->unlock_stop (basesink);
5013 /* we need preroll again and we set the flag before unlocking the clockid
5014 * because if the clockid is unlocked before a current buffer expired, we
5015 * can use that buffer to preroll with */
5016 basesink->need_preroll = TRUE;
5018 if (basesink->clock_id) {
5019 GST_DEBUG_OBJECT (basesink, "unschedule clock");
5020 gst_clock_id_unschedule (basesink->clock_id);
5023 /* if we don't have a preroll buffer we need to wait for a preroll and
5025 if (!gst_base_sink_needs_preroll (basesink)) {
5026 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED, we are prerolled");
5027 basesink->playing_async = FALSE;
5029 if (GST_STATE_TARGET (GST_ELEMENT (basesink)) <= GST_STATE_READY) {
5030 GST_DEBUG_OBJECT (basesink, "element is <= READY");
5031 ret = GST_STATE_CHANGE_SUCCESS;
5033 GST_DEBUG_OBJECT (basesink,
5034 "PLAYING to PAUSED, we are not prerolled");
5035 basesink->playing_async = TRUE;
5036 priv->commited = FALSE;
5037 priv->call_preroll = TRUE;
5038 if (priv->async_enabled) {
5039 GST_DEBUG_OBJECT (basesink, "doing async state change");
5040 ret = GST_STATE_CHANGE_ASYNC;
5041 gst_element_post_message (GST_ELEMENT_CAST (basesink),
5042 gst_message_new_async_start (GST_OBJECT_CAST (basesink)));
5046 GST_DEBUG_OBJECT (basesink, "rendered: %" G_GUINT64_FORMAT
5047 ", dropped: %" G_GUINT64_FORMAT, priv->rendered, priv->dropped);
5049 gst_base_sink_reset_qos (basesink);
5050 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
5052 case GST_STATE_CHANGE_PAUSED_TO_READY:
5053 GST_BASE_SINK_PREROLL_LOCK (basesink);
5054 /* start by resetting our position state with the object lock so that the
5055 * position query gets the right idea. We do this before we post the
5056 * messages so that the message handlers pick this up. */
5057 GST_OBJECT_LOCK (basesink);
5058 basesink->have_newsegment = FALSE;
5059 priv->current_sstart = GST_CLOCK_TIME_NONE;
5060 priv->current_sstop = GST_CLOCK_TIME_NONE;
5061 priv->have_latency = FALSE;
5062 if (priv->cached_clock_id) {
5063 gst_clock_id_unref (priv->cached_clock_id);
5064 priv->cached_clock_id = NULL;
5066 GST_OBJECT_UNLOCK (basesink);
5068 gst_base_sink_set_last_buffer (basesink, NULL);
5069 priv->call_preroll = FALSE;
5071 if (!priv->commited) {
5072 if (priv->async_enabled) {
5073 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, posting async-done");
5075 gst_element_post_message (GST_ELEMENT_CAST (basesink),
5076 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
5077 GST_STATE_PLAYING, GST_STATE_PAUSED, GST_STATE_READY));
5079 gst_element_post_message (GST_ELEMENT_CAST (basesink),
5080 gst_message_new_async_done (GST_OBJECT_CAST (basesink), FALSE));
5082 priv->commited = TRUE;
5084 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, don't need_preroll");
5086 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
5088 case GST_STATE_CHANGE_READY_TO_NULL:
5090 if (!bclass->stop (basesink)) {
5091 GST_WARNING_OBJECT (basesink, "failed to stop");
5094 gst_base_sink_set_last_buffer (basesink, NULL);
5095 priv->call_preroll = FALSE;
5106 GST_DEBUG_OBJECT (basesink, "failed to start");
5107 return GST_STATE_CHANGE_FAILURE;
5111 GST_DEBUG_OBJECT (basesink,
5112 "element failed to change states -- activation problem?");
5113 return GST_STATE_CHANGE_FAILURE;