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, GstBuffer * buffer);
391 static GstFlowReturn gst_base_sink_chain_list (GstPad * pad,
392 GstBufferList * list);
394 static void gst_base_sink_loop (GstPad * pad);
395 static gboolean gst_base_sink_pad_activate (GstPad * pad);
396 static gboolean gst_base_sink_pad_activate_push (GstPad * pad, gboolean active);
397 static gboolean gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active);
398 static gboolean gst_base_sink_event (GstPad * pad, GstEvent * event);
400 static gboolean default_sink_query (GstBaseSink * sink, GstQuery * query);
402 static gboolean gst_base_sink_negotiate_pull (GstBaseSink * basesink);
403 static void gst_base_sink_default_fixate (GstBaseSink * bsink, GstCaps * caps);
404 static void gst_base_sink_fixate (GstBaseSink * bsink, GstCaps * caps);
406 /* check if an object was too late */
407 static gboolean gst_base_sink_is_too_late (GstBaseSink * basesink,
408 GstMiniObject * obj, GstClockTime rstart, GstClockTime rstop,
409 GstClockReturn status, GstClockTimeDiff jitter);
410 static GstFlowReturn gst_base_sink_preroll_object (GstBaseSink * basesink,
411 guint8 obj_type, GstMiniObject * obj);
414 gst_base_sink_class_init (GstBaseSinkClass * klass)
416 GObjectClass *gobject_class;
417 GstElementClass *gstelement_class;
419 gobject_class = G_OBJECT_CLASS (klass);
420 gstelement_class = GST_ELEMENT_CLASS (klass);
422 GST_DEBUG_CATEGORY_INIT (gst_base_sink_debug, "basesink", 0,
425 g_type_class_add_private (klass, sizeof (GstBaseSinkPrivate));
427 parent_class = g_type_class_peek_parent (klass);
429 gobject_class->finalize = gst_base_sink_finalize;
430 gobject_class->set_property = gst_base_sink_set_property;
431 gobject_class->get_property = gst_base_sink_get_property;
433 g_object_class_install_property (gobject_class, PROP_SYNC,
434 g_param_spec_boolean ("sync", "Sync", "Sync on the clock", DEFAULT_SYNC,
435 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
437 g_object_class_install_property (gobject_class, PROP_MAX_LATENESS,
438 g_param_spec_int64 ("max-lateness", "Max Lateness",
439 "Maximum number of nanoseconds that a buffer can be late before it "
440 "is dropped (-1 unlimited)", -1, G_MAXINT64, DEFAULT_MAX_LATENESS,
441 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
443 g_object_class_install_property (gobject_class, PROP_QOS,
444 g_param_spec_boolean ("qos", "Qos",
445 "Generate Quality-of-Service events upstream", DEFAULT_QOS,
446 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
450 * If set to #TRUE, the basesink will perform asynchronous state changes.
451 * When set to #FALSE, the sink will not signal the parent when it prerolls.
452 * Use this option when dealing with sparse streams or when synchronisation is
457 g_object_class_install_property (gobject_class, PROP_ASYNC,
458 g_param_spec_boolean ("async", "Async",
459 "Go asynchronously to PAUSED", DEFAULT_ASYNC,
460 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
462 * GstBaseSink:ts-offset
464 * Controls the final synchronisation, a negative value will render the buffer
465 * earlier while a positive value delays playback. This property can be
466 * used to fix synchronisation in bad files.
470 g_object_class_install_property (gobject_class, PROP_TS_OFFSET,
471 g_param_spec_int64 ("ts-offset", "TS Offset",
472 "Timestamp offset in nanoseconds", G_MININT64, G_MAXINT64,
473 DEFAULT_TS_OFFSET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
476 * GstBaseSink:enable-last-buffer
478 * Enable the last-buffer property. If FALSE, basesink doesn't keep a
479 * reference to the last buffer arrived and the last-buffer property is always
480 * set to NULL. This can be useful if you need buffers to be released as soon
481 * as possible, eg. if you're using a buffer pool.
485 g_object_class_install_property (gobject_class, PROP_ENABLE_LAST_BUFFER,
486 g_param_spec_boolean ("enable-last-buffer", "Enable Last Buffer",
487 "Enable the last-buffer property", DEFAULT_ENABLE_LAST_BUFFER,
488 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
491 * GstBaseSink:last-buffer
493 * The last buffer that arrived in the sink and was used for preroll or for
494 * rendering. This property can be used to generate thumbnails. This property
495 * can be NULL when the sink has not yet received a bufer.
499 g_object_class_install_property (gobject_class, PROP_LAST_BUFFER,
500 g_param_spec_boxed ("last-buffer", "Last Buffer",
501 "The last buffer received in the sink", GST_TYPE_BUFFER,
502 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
504 * GstBaseSink:blocksize
506 * The amount of bytes to pull when operating in pull mode.
510 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
511 g_object_class_install_property (gobject_class, PROP_BLOCKSIZE,
512 g_param_spec_uint ("blocksize", "Block size",
513 "Size in bytes to pull per buffer (0 = default)", 0, G_MAXUINT,
514 DEFAULT_BLOCKSIZE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
516 * GstBaseSink:render-delay
518 * The additional delay between synchronisation and actual rendering of the
519 * media. This property will add additional latency to the device in order to
520 * make other sinks compensate for the delay.
524 g_object_class_install_property (gobject_class, PROP_RENDER_DELAY,
525 g_param_spec_uint64 ("render-delay", "Render Delay",
526 "Additional render delay of the sink in nanoseconds", 0, G_MAXUINT64,
527 DEFAULT_RENDER_DELAY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
529 * GstBaseSink:throttle-time
531 * The time to insert between buffers. This property can be used to control
532 * the maximum amount of buffers per second to render. Setting this property
533 * to a value bigger than 0 will make the sink create THROTTLE QoS events.
537 g_object_class_install_property (gobject_class, PROP_THROTTLE_TIME,
538 g_param_spec_uint64 ("throttle-time", "Throttle time",
539 "The time to keep between rendered buffers (unused)", 0, G_MAXUINT64,
540 DEFAULT_THROTTLE_TIME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
542 gstelement_class->change_state =
543 GST_DEBUG_FUNCPTR (gst_base_sink_change_state);
544 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_base_sink_send_event);
545 gstelement_class->query = GST_DEBUG_FUNCPTR (default_element_query);
547 klass->get_caps = GST_DEBUG_FUNCPTR (gst_base_sink_get_caps);
548 klass->set_caps = GST_DEBUG_FUNCPTR (gst_base_sink_set_caps);
549 klass->fixate = GST_DEBUG_FUNCPTR (gst_base_sink_default_fixate);
550 klass->activate_pull =
551 GST_DEBUG_FUNCPTR (gst_base_sink_default_activate_pull);
552 klass->get_times = GST_DEBUG_FUNCPTR (gst_base_sink_get_times);
553 klass->query = GST_DEBUG_FUNCPTR (default_sink_query);
555 /* Registering debug symbols for function pointers */
556 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_fixate);
557 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate);
558 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate_push);
559 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate_pull);
560 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_event);
561 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain);
562 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain_list);
563 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_sink_query);
567 gst_base_sink_query_caps (GstBaseSink * bsink, GstPad * pad, GstCaps * filter)
569 GstBaseSinkClass *bclass;
570 GstCaps *caps = NULL;
573 bclass = GST_BASE_SINK_GET_CLASS (bsink);
574 fixed = GST_PAD_IS_FIXED_CAPS (pad);
576 if (fixed || bsink->pad_mode == GST_PAD_ACTIVATE_PULL) {
577 /* if we are operating in pull mode or fixed caps, we only accept the
578 * currently negotiated caps */
579 caps = gst_pad_get_current_caps (pad);
582 if (bclass->get_caps)
583 caps = bclass->get_caps (bsink, filter);
586 GstPadTemplate *pad_template;
589 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass),
591 if (pad_template != NULL) {
592 caps = gst_pad_template_get_caps (pad_template);
595 GstCaps *intersection;
598 gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
599 gst_caps_unref (caps);
610 gst_base_sink_default_fixate (GstBaseSink * bsink, GstCaps * caps)
612 GST_DEBUG_OBJECT (bsink, "using default caps fixate function");
613 gst_caps_fixate (caps);
617 gst_base_sink_fixate (GstBaseSink * bsink, GstCaps * caps)
619 GstBaseSinkClass *bclass;
621 bclass = GST_BASE_SINK_GET_CLASS (bsink);
624 bclass->fixate (bsink, caps);
628 gst_base_sink_init (GstBaseSink * basesink, gpointer g_class)
630 GstPadTemplate *pad_template;
631 GstBaseSinkPrivate *priv;
633 basesink->priv = priv = GST_BASE_SINK_GET_PRIVATE (basesink);
636 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "sink");
637 g_return_if_fail (pad_template != NULL);
639 basesink->sinkpad = gst_pad_new_from_template (pad_template, "sink");
641 gst_pad_set_activate_function (basesink->sinkpad, gst_base_sink_pad_activate);
642 gst_pad_set_activatepush_function (basesink->sinkpad,
643 gst_base_sink_pad_activate_push);
644 gst_pad_set_activatepull_function (basesink->sinkpad,
645 gst_base_sink_pad_activate_pull);
646 gst_pad_set_query_function (basesink->sinkpad, gst_base_sink_sink_query);
647 gst_pad_set_event_function (basesink->sinkpad, gst_base_sink_event);
648 gst_pad_set_chain_function (basesink->sinkpad, gst_base_sink_chain);
649 gst_pad_set_chain_list_function (basesink->sinkpad, gst_base_sink_chain_list);
650 gst_element_add_pad (GST_ELEMENT_CAST (basesink), basesink->sinkpad);
652 basesink->pad_mode = GST_PAD_ACTIVATE_NONE;
653 basesink->preroll_lock = g_mutex_new ();
654 basesink->preroll_cond = g_cond_new ();
655 priv->preroll_queue = g_queue_new ();
656 priv->have_latency = FALSE;
658 basesink->can_activate_push = DEFAULT_CAN_ACTIVATE_PUSH;
659 basesink->can_activate_pull = DEFAULT_CAN_ACTIVATE_PULL;
661 basesink->sync = DEFAULT_SYNC;
662 basesink->max_lateness = DEFAULT_MAX_LATENESS;
663 g_atomic_int_set (&priv->qos_enabled, DEFAULT_QOS);
664 priv->async_enabled = DEFAULT_ASYNC;
665 priv->ts_offset = DEFAULT_TS_OFFSET;
666 priv->render_delay = DEFAULT_RENDER_DELAY;
667 priv->blocksize = DEFAULT_BLOCKSIZE;
668 priv->cached_clock_id = NULL;
669 g_atomic_int_set (&priv->enable_last_buffer, DEFAULT_ENABLE_LAST_BUFFER);
670 priv->throttle_time = DEFAULT_THROTTLE_TIME;
672 GST_OBJECT_FLAG_SET (basesink, GST_ELEMENT_IS_SINK);
676 gst_base_sink_finalize (GObject * object)
678 GstBaseSink *basesink;
680 basesink = GST_BASE_SINK (object);
682 g_mutex_free (basesink->preroll_lock);
683 g_cond_free (basesink->preroll_cond);
684 g_queue_free (basesink->priv->preroll_queue);
686 G_OBJECT_CLASS (parent_class)->finalize (object);
690 * gst_base_sink_set_sync:
692 * @sync: the new sync value.
694 * Configures @sink to synchronize on the clock or not. When
695 * @sync is FALSE, incoming samples will be played as fast as
696 * possible. If @sync is TRUE, the timestamps of the incomming
697 * buffers will be used to schedule the exact render time of its
703 gst_base_sink_set_sync (GstBaseSink * sink, gboolean sync)
705 g_return_if_fail (GST_IS_BASE_SINK (sink));
707 GST_OBJECT_LOCK (sink);
709 GST_OBJECT_UNLOCK (sink);
713 * gst_base_sink_get_sync:
716 * Checks if @sink is currently configured to synchronize against the
719 * Returns: TRUE if the sink is configured to synchronize against the clock.
724 gst_base_sink_get_sync (GstBaseSink * sink)
728 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
730 GST_OBJECT_LOCK (sink);
732 GST_OBJECT_UNLOCK (sink);
738 * gst_base_sink_set_max_lateness:
740 * @max_lateness: the new max lateness value.
742 * Sets the new max lateness value to @max_lateness. This value is
743 * used to decide if a buffer should be dropped or not based on the
744 * buffer timestamp and the current clock time. A value of -1 means
750 gst_base_sink_set_max_lateness (GstBaseSink * sink, gint64 max_lateness)
752 g_return_if_fail (GST_IS_BASE_SINK (sink));
754 GST_OBJECT_LOCK (sink);
755 sink->max_lateness = max_lateness;
756 GST_OBJECT_UNLOCK (sink);
760 * gst_base_sink_get_max_lateness:
763 * Gets the max lateness value. See gst_base_sink_set_max_lateness for
766 * Returns: The maximum time in nanoseconds that a buffer can be late
767 * before it is dropped and not rendered. A value of -1 means an
773 gst_base_sink_get_max_lateness (GstBaseSink * sink)
777 g_return_val_if_fail (GST_IS_BASE_SINK (sink), -1);
779 GST_OBJECT_LOCK (sink);
780 res = sink->max_lateness;
781 GST_OBJECT_UNLOCK (sink);
787 * gst_base_sink_set_qos_enabled:
789 * @enabled: the new qos value.
791 * Configures @sink to send Quality-of-Service events upstream.
796 gst_base_sink_set_qos_enabled (GstBaseSink * sink, gboolean enabled)
798 g_return_if_fail (GST_IS_BASE_SINK (sink));
800 g_atomic_int_set (&sink->priv->qos_enabled, enabled);
804 * gst_base_sink_is_qos_enabled:
807 * Checks if @sink is currently configured to send Quality-of-Service events
810 * Returns: TRUE if the sink is configured to perform Quality-of-Service.
815 gst_base_sink_is_qos_enabled (GstBaseSink * sink)
819 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
821 res = g_atomic_int_get (&sink->priv->qos_enabled);
827 * gst_base_sink_set_async_enabled:
829 * @enabled: the new async value.
831 * Configures @sink to perform all state changes asynchronusly. When async is
832 * disabled, the sink will immediately go to PAUSED instead of waiting for a
833 * preroll buffer. This feature is useful if the sink does not synchronize
834 * against the clock or when it is dealing with sparse streams.
839 gst_base_sink_set_async_enabled (GstBaseSink * sink, gboolean enabled)
841 g_return_if_fail (GST_IS_BASE_SINK (sink));
843 GST_BASE_SINK_PREROLL_LOCK (sink);
844 g_atomic_int_set (&sink->priv->async_enabled, enabled);
845 GST_LOG_OBJECT (sink, "set async enabled to %d", enabled);
846 GST_BASE_SINK_PREROLL_UNLOCK (sink);
850 * gst_base_sink_is_async_enabled:
853 * Checks if @sink is currently configured to perform asynchronous state
856 * Returns: TRUE if the sink is configured to perform asynchronous state
862 gst_base_sink_is_async_enabled (GstBaseSink * sink)
866 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
868 res = g_atomic_int_get (&sink->priv->async_enabled);
874 * gst_base_sink_set_ts_offset:
876 * @offset: the new offset
878 * Adjust the synchronisation of @sink with @offset. A negative value will
879 * render buffers earlier than their timestamp. A positive value will delay
880 * rendering. This function can be used to fix playback of badly timestamped
886 gst_base_sink_set_ts_offset (GstBaseSink * sink, GstClockTimeDiff offset)
888 g_return_if_fail (GST_IS_BASE_SINK (sink));
890 GST_OBJECT_LOCK (sink);
891 sink->priv->ts_offset = offset;
892 GST_LOG_OBJECT (sink, "set time offset to %" G_GINT64_FORMAT, offset);
893 GST_OBJECT_UNLOCK (sink);
897 * gst_base_sink_get_ts_offset:
900 * Get the synchronisation offset of @sink.
902 * Returns: The synchronisation offset.
907 gst_base_sink_get_ts_offset (GstBaseSink * sink)
909 GstClockTimeDiff res;
911 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
913 GST_OBJECT_LOCK (sink);
914 res = sink->priv->ts_offset;
915 GST_OBJECT_UNLOCK (sink);
921 * gst_base_sink_get_last_buffer:
924 * Get the last buffer that arrived in the sink and was used for preroll or for
925 * rendering. This property can be used to generate thumbnails.
927 * The #GstCaps on the buffer can be used to determine the type of the buffer.
929 * Free-function: gst_buffer_unref
931 * Returns: (transfer full): a #GstBuffer. gst_buffer_unref() after usage.
932 * This function returns NULL when no buffer has arrived in the sink yet
933 * or when the sink is not in PAUSED or PLAYING.
938 gst_base_sink_get_last_buffer (GstBaseSink * sink)
942 g_return_val_if_fail (GST_IS_BASE_SINK (sink), NULL);
944 GST_OBJECT_LOCK (sink);
945 if ((res = sink->priv->last_buffer))
946 gst_buffer_ref (res);
947 GST_OBJECT_UNLOCK (sink);
952 /* with OBJECT_LOCK */
954 gst_base_sink_set_last_buffer_unlocked (GstBaseSink * sink, GstBuffer * buffer)
958 old = sink->priv->last_buffer;
959 if (G_LIKELY (old != buffer)) {
960 GST_DEBUG_OBJECT (sink, "setting last buffer to %p", buffer);
961 if (G_LIKELY (buffer))
962 gst_buffer_ref (buffer);
963 sink->priv->last_buffer = buffer;
967 /* avoid unreffing with the lock because cleanup code might want to take the
969 if (G_LIKELY (old)) {
970 GST_OBJECT_UNLOCK (sink);
971 gst_buffer_unref (old);
972 GST_OBJECT_LOCK (sink);
977 gst_base_sink_set_last_buffer (GstBaseSink * sink, GstBuffer * buffer)
979 if (!g_atomic_int_get (&sink->priv->enable_last_buffer))
982 GST_OBJECT_LOCK (sink);
983 gst_base_sink_set_last_buffer_unlocked (sink, buffer);
984 GST_OBJECT_UNLOCK (sink);
988 * gst_base_sink_set_last_buffer_enabled:
990 * @enabled: the new enable-last-buffer value.
992 * Configures @sink to store the last received buffer in the last-buffer
998 gst_base_sink_set_last_buffer_enabled (GstBaseSink * sink, gboolean enabled)
1000 g_return_if_fail (GST_IS_BASE_SINK (sink));
1002 /* Only take lock if we change the value */
1003 if (g_atomic_int_compare_and_exchange (&sink->priv->enable_last_buffer,
1004 !enabled, enabled) && !enabled) {
1005 GST_OBJECT_LOCK (sink);
1006 gst_base_sink_set_last_buffer_unlocked (sink, NULL);
1007 GST_OBJECT_UNLOCK (sink);
1012 * gst_base_sink_is_last_buffer_enabled:
1015 * Checks if @sink is currently configured to store the last received buffer in
1016 * the last-buffer property.
1018 * Returns: TRUE if the sink is configured to store the last received buffer.
1023 gst_base_sink_is_last_buffer_enabled (GstBaseSink * sink)
1025 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
1027 return g_atomic_int_get (&sink->priv->enable_last_buffer);
1031 * gst_base_sink_get_latency:
1034 * Get the currently configured latency.
1036 * Returns: The configured latency.
1041 gst_base_sink_get_latency (GstBaseSink * sink)
1045 GST_OBJECT_LOCK (sink);
1046 res = sink->priv->latency;
1047 GST_OBJECT_UNLOCK (sink);
1053 * gst_base_sink_query_latency:
1055 * @live: (out) (allow-none): if the sink is live
1056 * @upstream_live: (out) (allow-none): if an upstream element is live
1057 * @min_latency: (out) (allow-none): the min latency of the upstream elements
1058 * @max_latency: (out) (allow-none): the max latency of the upstream elements
1060 * Query the sink for the latency parameters. The latency will be queried from
1061 * the upstream elements. @live will be TRUE if @sink is configured to
1062 * synchronize against the clock. @upstream_live will be TRUE if an upstream
1065 * If both @live and @upstream_live are TRUE, the sink will want to compensate
1066 * for the latency introduced by the upstream elements by setting the
1067 * @min_latency to a strictly possitive value.
1069 * This function is mostly used by subclasses.
1071 * Returns: TRUE if the query succeeded.
1076 gst_base_sink_query_latency (GstBaseSink * sink, gboolean * live,
1077 gboolean * upstream_live, GstClockTime * min_latency,
1078 GstClockTime * max_latency)
1080 gboolean l, us_live, res, have_latency;
1081 GstClockTime min, max, render_delay;
1083 GstClockTime us_min, us_max;
1085 /* we are live when we sync to the clock */
1086 GST_OBJECT_LOCK (sink);
1088 have_latency = sink->priv->have_latency;
1089 render_delay = sink->priv->render_delay;
1090 GST_OBJECT_UNLOCK (sink);
1092 /* assume no latency */
1098 GST_DEBUG_OBJECT (sink, "we are ready for LATENCY query");
1099 /* we are ready for a latency query this is when we preroll or when we are
1101 query = gst_query_new_latency ();
1103 /* ask the peer for the latency */
1104 if ((res = gst_pad_peer_query (sink->sinkpad, query))) {
1105 /* get upstream min and max latency */
1106 gst_query_parse_latency (query, &us_live, &us_min, &us_max);
1109 /* upstream live, use its latency, subclasses should use these
1110 * values to create the complete latency. */
1115 /* we need to add the render delay if we are live */
1117 min += render_delay;
1119 max += render_delay;
1122 gst_query_unref (query);
1124 GST_DEBUG_OBJECT (sink, "we are not yet ready for LATENCY query");
1128 /* not live, we tried to do the query, if it failed we return TRUE anyway */
1132 GST_DEBUG_OBJECT (sink, "latency query failed but we are not live");
1134 GST_DEBUG_OBJECT (sink, "latency query failed and we are live");
1139 GST_DEBUG_OBJECT (sink, "latency query: live: %d, have_latency %d,"
1140 " upstream: %d, min %" GST_TIME_FORMAT ", max %" GST_TIME_FORMAT, l,
1141 have_latency, us_live, GST_TIME_ARGS (min), GST_TIME_ARGS (max));
1146 *upstream_live = us_live;
1156 * gst_base_sink_set_render_delay:
1157 * @sink: a #GstBaseSink
1158 * @delay: the new delay
1160 * Set the render delay in @sink to @delay. The render delay is the time
1161 * between actual rendering of a buffer and its synchronisation time. Some
1162 * devices might delay media rendering which can be compensated for with this
1165 * After calling this function, this sink will report additional latency and
1166 * other sinks will adjust their latency to delay the rendering of their media.
1168 * This function is usually called by subclasses.
1173 gst_base_sink_set_render_delay (GstBaseSink * sink, GstClockTime delay)
1175 GstClockTime old_render_delay;
1177 g_return_if_fail (GST_IS_BASE_SINK (sink));
1179 GST_OBJECT_LOCK (sink);
1180 old_render_delay = sink->priv->render_delay;
1181 sink->priv->render_delay = delay;
1182 GST_LOG_OBJECT (sink, "set render delay to %" GST_TIME_FORMAT,
1183 GST_TIME_ARGS (delay));
1184 GST_OBJECT_UNLOCK (sink);
1186 if (delay != old_render_delay) {
1187 GST_DEBUG_OBJECT (sink, "posting latency changed");
1188 gst_element_post_message (GST_ELEMENT_CAST (sink),
1189 gst_message_new_latency (GST_OBJECT_CAST (sink)));
1194 * gst_base_sink_get_render_delay:
1195 * @sink: a #GstBaseSink
1197 * Get the render delay of @sink. see gst_base_sink_set_render_delay() for more
1198 * information about the render delay.
1200 * Returns: the render delay of @sink.
1205 gst_base_sink_get_render_delay (GstBaseSink * sink)
1207 GstClockTimeDiff res;
1209 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1211 GST_OBJECT_LOCK (sink);
1212 res = sink->priv->render_delay;
1213 GST_OBJECT_UNLOCK (sink);
1219 * gst_base_sink_set_blocksize:
1220 * @sink: a #GstBaseSink
1221 * @blocksize: the blocksize in bytes
1223 * Set the number of bytes that the sink will pull when it is operating in pull
1228 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
1230 gst_base_sink_set_blocksize (GstBaseSink * sink, guint blocksize)
1232 g_return_if_fail (GST_IS_BASE_SINK (sink));
1234 GST_OBJECT_LOCK (sink);
1235 sink->priv->blocksize = blocksize;
1236 GST_LOG_OBJECT (sink, "set blocksize to %u", blocksize);
1237 GST_OBJECT_UNLOCK (sink);
1241 * gst_base_sink_get_blocksize:
1242 * @sink: a #GstBaseSink
1244 * Get the number of bytes that the sink will pull when it is operating in pull
1247 * Returns: the number of bytes @sink will pull in pull mode.
1251 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
1253 gst_base_sink_get_blocksize (GstBaseSink * sink)
1257 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1259 GST_OBJECT_LOCK (sink);
1260 res = sink->priv->blocksize;
1261 GST_OBJECT_UNLOCK (sink);
1267 * gst_base_sink_set_throttle_time:
1268 * @sink: a #GstBaseSink
1269 * @throttle: the throttle time in nanoseconds
1271 * Set the time that will be inserted between rendered buffers. This
1272 * can be used to control the maximum buffers per second that the sink
1278 gst_base_sink_set_throttle_time (GstBaseSink * sink, guint64 throttle)
1280 g_return_if_fail (GST_IS_BASE_SINK (sink));
1282 GST_OBJECT_LOCK (sink);
1283 sink->priv->throttle_time = throttle;
1284 GST_LOG_OBJECT (sink, "set throttle_time to %" G_GUINT64_FORMAT, throttle);
1285 GST_OBJECT_UNLOCK (sink);
1289 * gst_base_sink_get_throttle_time:
1290 * @sink: a #GstBaseSink
1292 * Get the time that will be inserted between frames to control the
1293 * maximum buffers per second.
1295 * Returns: the number of nanoseconds @sink will put between frames.
1300 gst_base_sink_get_throttle_time (GstBaseSink * sink)
1304 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1306 GST_OBJECT_LOCK (sink);
1307 res = sink->priv->throttle_time;
1308 GST_OBJECT_UNLOCK (sink);
1314 gst_base_sink_set_property (GObject * object, guint prop_id,
1315 const GValue * value, GParamSpec * pspec)
1317 GstBaseSink *sink = GST_BASE_SINK (object);
1321 gst_base_sink_set_sync (sink, g_value_get_boolean (value));
1323 case PROP_MAX_LATENESS:
1324 gst_base_sink_set_max_lateness (sink, g_value_get_int64 (value));
1327 gst_base_sink_set_qos_enabled (sink, g_value_get_boolean (value));
1330 gst_base_sink_set_async_enabled (sink, g_value_get_boolean (value));
1332 case PROP_TS_OFFSET:
1333 gst_base_sink_set_ts_offset (sink, g_value_get_int64 (value));
1335 case PROP_BLOCKSIZE:
1336 gst_base_sink_set_blocksize (sink, g_value_get_uint (value));
1338 case PROP_RENDER_DELAY:
1339 gst_base_sink_set_render_delay (sink, g_value_get_uint64 (value));
1341 case PROP_ENABLE_LAST_BUFFER:
1342 gst_base_sink_set_last_buffer_enabled (sink, g_value_get_boolean (value));
1344 case PROP_THROTTLE_TIME:
1345 gst_base_sink_set_throttle_time (sink, g_value_get_uint64 (value));
1348 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1354 gst_base_sink_get_property (GObject * object, guint prop_id, GValue * value,
1357 GstBaseSink *sink = GST_BASE_SINK (object);
1361 g_value_set_boolean (value, gst_base_sink_get_sync (sink));
1363 case PROP_MAX_LATENESS:
1364 g_value_set_int64 (value, gst_base_sink_get_max_lateness (sink));
1367 g_value_set_boolean (value, gst_base_sink_is_qos_enabled (sink));
1370 g_value_set_boolean (value, gst_base_sink_is_async_enabled (sink));
1372 case PROP_TS_OFFSET:
1373 g_value_set_int64 (value, gst_base_sink_get_ts_offset (sink));
1375 case PROP_LAST_BUFFER:
1376 gst_value_take_buffer (value, gst_base_sink_get_last_buffer (sink));
1378 case PROP_ENABLE_LAST_BUFFER:
1379 g_value_set_boolean (value, gst_base_sink_is_last_buffer_enabled (sink));
1381 case PROP_BLOCKSIZE:
1382 g_value_set_uint (value, gst_base_sink_get_blocksize (sink));
1384 case PROP_RENDER_DELAY:
1385 g_value_set_uint64 (value, gst_base_sink_get_render_delay (sink));
1387 case PROP_THROTTLE_TIME:
1388 g_value_set_uint64 (value, gst_base_sink_get_throttle_time (sink));
1391 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1398 gst_base_sink_get_caps (GstBaseSink * sink, GstCaps * filter)
1404 gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps)
1409 /* with PREROLL_LOCK, STREAM_LOCK */
1411 gst_base_sink_preroll_queue_flush (GstBaseSink * basesink, GstPad * pad)
1415 GST_DEBUG_OBJECT (basesink, "flushing queue %p", basesink);
1416 while ((obj = g_queue_pop_head (basesink->priv->preroll_queue))) {
1417 GST_DEBUG_OBJECT (basesink, "popped %p", obj);
1418 gst_mini_object_unref (obj);
1420 /* we can't have EOS anymore now */
1421 basesink->eos = FALSE;
1422 basesink->priv->received_eos = FALSE;
1423 basesink->have_preroll = FALSE;
1424 basesink->priv->step_unlock = FALSE;
1425 basesink->eos_queued = FALSE;
1426 basesink->priv->preroll_queued = 0;
1427 /* can't report latency anymore until we preroll again */
1428 if (basesink->priv->async_enabled) {
1429 GST_OBJECT_LOCK (basesink);
1430 basesink->priv->have_latency = FALSE;
1431 GST_OBJECT_UNLOCK (basesink);
1433 /* and signal any waiters now */
1434 GST_BASE_SINK_PREROLL_SIGNAL (basesink);
1437 /* with STREAM_LOCK, configures given segment with the event information. */
1439 gst_base_sink_configure_segment (GstBaseSink * basesink, GstPad * pad,
1440 GstEvent * event, GstSegment * segment)
1442 /* The segment is protected with both the STREAM_LOCK and the OBJECT_LOCK.
1443 * We protect with the OBJECT_LOCK so that we can use the values to
1444 * safely answer a POSITION query. */
1445 GST_OBJECT_LOCK (basesink);
1446 /* the newsegment event is needed to bring the buffer timestamps to the
1447 * stream time and to drop samples outside of the playback segment. */
1448 gst_event_copy_segment (event, segment);
1449 GST_DEBUG_OBJECT (basesink, "configured SEGMENT %" GST_SEGMENT_FORMAT,
1451 GST_OBJECT_UNLOCK (basesink);
1454 /* with PREROLL_LOCK, STREAM_LOCK */
1456 gst_base_sink_commit_state (GstBaseSink * basesink)
1458 /* commit state and proceed to next pending state */
1459 GstState current, next, pending, post_pending;
1460 gboolean post_paused = FALSE;
1461 gboolean post_async_done = FALSE;
1462 gboolean post_playing = FALSE;
1463 gboolean reset_time;
1465 /* we are certainly not playing async anymore now */
1466 basesink->playing_async = FALSE;
1468 GST_OBJECT_LOCK (basesink);
1469 current = GST_STATE (basesink);
1470 next = GST_STATE_NEXT (basesink);
1471 pending = GST_STATE_PENDING (basesink);
1472 post_pending = pending;
1473 reset_time = basesink->priv->reset_time;
1474 basesink->priv->reset_time = FALSE;
1477 case GST_STATE_PLAYING:
1479 GST_DEBUG_OBJECT (basesink, "commiting state to PLAYING");
1481 basesink->need_preroll = FALSE;
1482 post_async_done = TRUE;
1483 basesink->priv->commited = TRUE;
1484 post_playing = TRUE;
1485 /* post PAUSED too when we were READY */
1486 if (current == GST_STATE_READY) {
1491 case GST_STATE_PAUSED:
1492 GST_DEBUG_OBJECT (basesink, "commiting state to PAUSED");
1494 post_async_done = TRUE;
1495 basesink->priv->commited = TRUE;
1496 post_pending = GST_STATE_VOID_PENDING;
1498 case GST_STATE_READY:
1499 case GST_STATE_NULL:
1501 case GST_STATE_VOID_PENDING:
1502 goto nothing_pending;
1507 /* we can report latency queries now */
1508 basesink->priv->have_latency = TRUE;
1510 GST_STATE (basesink) = pending;
1511 GST_STATE_NEXT (basesink) = GST_STATE_VOID_PENDING;
1512 GST_STATE_PENDING (basesink) = GST_STATE_VOID_PENDING;
1513 GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_SUCCESS;
1514 GST_OBJECT_UNLOCK (basesink);
1517 GST_DEBUG_OBJECT (basesink, "posting PAUSED state change message");
1518 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1519 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1520 current, next, post_pending));
1522 if (post_async_done) {
1523 GST_DEBUG_OBJECT (basesink, "posting async-done message");
1524 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1525 gst_message_new_async_done (GST_OBJECT_CAST (basesink), reset_time));
1528 GST_DEBUG_OBJECT (basesink, "posting PLAYING state change message");
1529 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1530 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1531 next, pending, GST_STATE_VOID_PENDING));
1534 GST_STATE_BROADCAST (basesink);
1540 /* Depending on the state, set our vars. We get in this situation when the
1541 * state change function got a change to update the state vars before the
1542 * streaming thread did. This is fine but we need to make sure that we
1543 * update the need_preroll var since it was TRUE when we got here and might
1544 * become FALSE if we got to PLAYING. */
1545 GST_DEBUG_OBJECT (basesink, "nothing to commit, now in %s",
1546 gst_element_state_get_name (current));
1548 case GST_STATE_PLAYING:
1549 basesink->need_preroll = FALSE;
1551 case GST_STATE_PAUSED:
1552 basesink->need_preroll = TRUE;
1555 basesink->need_preroll = FALSE;
1556 basesink->flushing = TRUE;
1559 /* we can report latency queries now */
1560 basesink->priv->have_latency = TRUE;
1561 GST_OBJECT_UNLOCK (basesink);
1566 /* app is going to READY */
1567 GST_DEBUG_OBJECT (basesink, "stopping");
1568 basesink->need_preroll = FALSE;
1569 basesink->flushing = TRUE;
1570 GST_OBJECT_UNLOCK (basesink);
1576 start_stepping (GstBaseSink * sink, GstSegment * segment,
1577 GstStepInfo * pending, GstStepInfo * current)
1580 GstMessage *message;
1582 GST_DEBUG_OBJECT (sink, "update pending step");
1584 GST_OBJECT_LOCK (sink);
1585 memcpy (current, pending, sizeof (GstStepInfo));
1586 pending->valid = FALSE;
1587 GST_OBJECT_UNLOCK (sink);
1589 /* post message first */
1591 gst_message_new_step_start (GST_OBJECT (sink), TRUE, current->format,
1592 current->amount, current->rate, current->flush, current->intermediate);
1593 gst_message_set_seqnum (message, current->seqnum);
1594 gst_element_post_message (GST_ELEMENT (sink), message);
1596 /* get the running time of where we paused and remember it */
1597 current->start = gst_element_get_start_time (GST_ELEMENT_CAST (sink));
1598 gst_segment_set_running_time (segment, GST_FORMAT_TIME, current->start);
1600 /* set the new rate for the remainder of the segment */
1601 current->start_rate = segment->rate;
1602 segment->rate *= current->rate;
1605 if (segment->rate > 0.0)
1606 current->start_stop = segment->stop;
1608 current->start_start = segment->start;
1610 if (current->format == GST_FORMAT_TIME) {
1611 end = current->start + current->amount;
1612 if (!current->flush) {
1613 /* update the segment clipping regions for non-flushing seeks */
1614 if (segment->rate > 0.0) {
1615 segment->stop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1616 segment->position = segment->stop;
1620 position = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1621 segment->time = position;
1622 segment->start = position;
1623 segment->position = position;
1628 GST_DEBUG_OBJECT (sink, "segment now %" GST_SEGMENT_FORMAT, segment);
1629 GST_DEBUG_OBJECT (sink, "step started at running_time %" GST_TIME_FORMAT,
1630 GST_TIME_ARGS (current->start));
1632 if (current->amount == -1) {
1633 GST_DEBUG_OBJECT (sink, "step amount == -1, stop stepping");
1634 current->valid = FALSE;
1636 GST_DEBUG_OBJECT (sink, "step amount: %" G_GUINT64_FORMAT ", format: %s, "
1637 "rate: %f", current->amount, gst_format_get_name (current->format),
1643 stop_stepping (GstBaseSink * sink, GstSegment * segment,
1644 GstStepInfo * current, gint64 rstart, gint64 rstop, gboolean eos)
1646 gint64 stop, position;
1647 GstMessage *message;
1649 GST_DEBUG_OBJECT (sink, "step complete");
1651 if (segment->rate > 0.0)
1656 GST_DEBUG_OBJECT (sink,
1657 "step stop at running_time %" GST_TIME_FORMAT, GST_TIME_ARGS (stop));
1660 current->duration = current->position;
1662 current->duration = stop - current->start;
1664 GST_DEBUG_OBJECT (sink, "step elapsed running_time %" GST_TIME_FORMAT,
1665 GST_TIME_ARGS (current->duration));
1667 position = current->start + current->duration;
1669 /* now move the segment to the new running time */
1670 gst_segment_set_running_time (segment, GST_FORMAT_TIME, position);
1672 if (current->flush) {
1673 /* and remove the time we flushed, start time did not change */
1674 segment->base = current->start;
1676 /* start time is now the stepped position */
1677 gst_element_set_start_time (GST_ELEMENT_CAST (sink), position);
1680 /* restore the previous rate */
1681 segment->rate = current->start_rate;
1683 if (segment->rate > 0.0)
1684 segment->stop = current->start_stop;
1686 segment->start = current->start_start;
1688 /* the clip segment is used for position report in paused... */
1689 gst_segment_copy_into (segment, &sink->clip_segment);
1691 /* post the step done when we know the stepped duration in TIME */
1693 gst_message_new_step_done (GST_OBJECT_CAST (sink), current->format,
1694 current->amount, current->rate, current->flush, current->intermediate,
1695 current->duration, eos);
1696 gst_message_set_seqnum (message, current->seqnum);
1697 gst_element_post_message (GST_ELEMENT_CAST (sink), message);
1699 if (!current->intermediate)
1700 sink->need_preroll = current->need_preroll;
1702 /* and the current step info finished and becomes invalid */
1703 current->valid = FALSE;
1707 handle_stepping (GstBaseSink * sink, GstSegment * segment,
1708 GstStepInfo * current, guint64 * cstart, guint64 * cstop, guint64 * rstart,
1711 gboolean step_end = FALSE;
1713 /* see if we need to skip this buffer because of stepping */
1714 switch (current->format) {
1715 case GST_FORMAT_TIME:
1718 guint64 first, last;
1721 if (segment->rate > 0.0) {
1722 if (segment->stop == *cstop)
1723 *rstop = *rstart + current->amount;
1728 if (segment->start == *cstart)
1729 *rstart = *rstop + current->amount;
1735 end = current->start + current->amount;
1736 current->position = first - current->start;
1738 abs_rate = ABS (segment->rate);
1739 if (G_UNLIKELY (abs_rate != 1.0))
1740 current->position /= abs_rate;
1742 GST_DEBUG_OBJECT (sink,
1743 "buffer: %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT,
1744 GST_TIME_ARGS (first), GST_TIME_ARGS (last));
1745 GST_DEBUG_OBJECT (sink,
1746 "got time step %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT "/%"
1747 GST_TIME_FORMAT, GST_TIME_ARGS (current->position),
1748 GST_TIME_ARGS (last - current->start),
1749 GST_TIME_ARGS (current->amount));
1751 if ((current->flush && current->position >= current->amount)
1753 GST_DEBUG_OBJECT (sink, "step ended, we need clipping");
1755 if (segment->rate > 0.0) {
1757 *cstart = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1760 *cstop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1763 GST_DEBUG_OBJECT (sink,
1764 "cstart %" GST_TIME_FORMAT ", rstart %" GST_TIME_FORMAT,
1765 GST_TIME_ARGS (*cstart), GST_TIME_ARGS (*rstart));
1766 GST_DEBUG_OBJECT (sink,
1767 "cstop %" GST_TIME_FORMAT ", rstop %" GST_TIME_FORMAT,
1768 GST_TIME_ARGS (*cstop), GST_TIME_ARGS (*rstop));
1771 case GST_FORMAT_BUFFERS:
1772 GST_DEBUG_OBJECT (sink,
1773 "got default step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1774 current->position, current->amount);
1776 if (current->position < current->amount) {
1777 current->position++;
1782 case GST_FORMAT_DEFAULT:
1784 GST_DEBUG_OBJECT (sink,
1785 "got unknown step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1786 current->position, current->amount);
1792 /* with STREAM_LOCK, PREROLL_LOCK
1794 * Returns TRUE if the object needs synchronisation and takes therefore
1795 * part in prerolling.
1797 * rsstart/rsstop contain the start/stop in stream time.
1798 * rrstart/rrstop contain the start/stop in running time.
1801 gst_base_sink_get_sync_times (GstBaseSink * basesink, GstMiniObject * obj,
1802 GstClockTime * rsstart, GstClockTime * rsstop,
1803 GstClockTime * rrstart, GstClockTime * rrstop, gboolean * do_sync,
1804 gboolean * stepped, GstSegment * segment, GstStepInfo * step,
1805 gboolean * step_end, guint8 obj_type)
1807 GstBaseSinkClass *bclass;
1809 GstClockTime start, stop; /* raw start/stop timestamps */
1810 guint64 cstart, cstop; /* clipped raw timestamps */
1811 guint64 rstart, rstop; /* clipped timestamps converted to running time */
1812 GstClockTime sstart, sstop; /* clipped timestamps converted to stream time */
1814 GstBaseSinkPrivate *priv;
1817 priv = basesink->priv;
1819 /* start with nothing */
1820 start = stop = GST_CLOCK_TIME_NONE;
1822 if (G_UNLIKELY (OBJ_IS_EVENT (obj_type))) {
1823 GstEvent *event = GST_EVENT_CAST (obj);
1825 switch (GST_EVENT_TYPE (event)) {
1826 /* EOS event needs syncing */
1829 if (basesink->segment.rate >= 0.0) {
1830 sstart = sstop = priv->current_sstop;
1831 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1832 /* we have not seen a buffer yet, use the segment values */
1833 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1834 basesink->segment.format, basesink->segment.stop);
1837 sstart = sstop = priv->current_sstart;
1838 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1839 /* we have not seen a buffer yet, use the segment values */
1840 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1841 basesink->segment.format, basesink->segment.start);
1845 rstart = rstop = priv->eos_rtime;
1846 *do_sync = rstart != -1;
1847 GST_DEBUG_OBJECT (basesink, "sync times for EOS %" GST_TIME_FORMAT,
1848 GST_TIME_ARGS (rstart));
1849 /* if we are stepping, we end now */
1850 *step_end = step->valid;
1855 /* other events do not need syncing */
1863 /* else do buffer sync code */
1864 buffer = GST_BUFFER_CAST (obj);
1866 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1868 /* just get the times to see if we need syncing, if the start returns -1 we
1870 if (bclass->get_times)
1871 bclass->get_times (basesink, buffer, &start, &stop);
1873 if (!GST_CLOCK_TIME_IS_VALID (start)) {
1874 /* we don't need to sync but we still want to get the timestamps for
1875 * tracking the position */
1876 gst_base_sink_get_times (basesink, buffer, &start, &stop);
1882 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
1883 ", stop: %" GST_TIME_FORMAT ", do_sync %d", GST_TIME_ARGS (start),
1884 GST_TIME_ARGS (stop), *do_sync);
1886 /* collect segment and format for code clarity */
1887 format = segment->format;
1890 if (G_UNLIKELY (!gst_segment_clip (segment, format,
1891 start, stop, &cstart, &cstop))) {
1893 GST_DEBUG_OBJECT (basesink, "step out of segment");
1894 /* when we are stepping, pretend we're at the end of the segment */
1895 if (segment->rate > 0.0) {
1896 cstart = segment->stop;
1897 cstop = segment->stop;
1899 cstart = segment->start;
1900 cstop = segment->start;
1904 goto out_of_segment;
1907 if (G_UNLIKELY (start != cstart || stop != cstop)) {
1908 GST_DEBUG_OBJECT (basesink, "clipped to: start %" GST_TIME_FORMAT
1909 ", stop: %" GST_TIME_FORMAT, GST_TIME_ARGS (cstart),
1910 GST_TIME_ARGS (cstop));
1913 /* set last stop position */
1914 if (G_LIKELY (stop != GST_CLOCK_TIME_NONE && cstop != GST_CLOCK_TIME_NONE))
1915 segment->position = cstop;
1917 segment->position = cstart;
1920 rstart = gst_segment_to_running_time (segment, format, cstart);
1921 rstop = gst_segment_to_running_time (segment, format, cstop);
1923 if (G_UNLIKELY (step->valid)) {
1924 if (!(*step_end = handle_stepping (basesink, segment, step, &cstart, &cstop,
1925 &rstart, &rstop))) {
1926 /* step is still busy, we discard data when we are flushing */
1927 *stepped = step->flush;
1928 GST_DEBUG_OBJECT (basesink, "stepping busy");
1931 /* this can produce wrong values if we accumulated non-TIME segments. If this happens,
1932 * upstream is behaving very badly */
1933 sstart = gst_segment_to_stream_time (segment, format, cstart);
1934 sstop = gst_segment_to_stream_time (segment, format, cstop);
1937 /* eos_done label only called when doing EOS, we also stop stepping then */
1938 if (*step_end && step->flush) {
1939 GST_DEBUG_OBJECT (basesink, "flushing step ended");
1940 stop_stepping (basesink, segment, step, rstart, rstop, eos);
1942 /* re-determine running start times for adjusted segment
1943 * (which has a flushed amount of running/accumulated time removed) */
1944 if (!GST_IS_EVENT (obj)) {
1945 GST_DEBUG_OBJECT (basesink, "refresh sync times");
1956 /* buffers and EOS always need syncing and preroll */
1962 /* we usually clip in the chain function already but stepping could cause
1963 * the segment to be updated later. we return FALSE so that we don't try
1965 GST_LOG_OBJECT (basesink, "buffer skipped, not in segment");
1970 /* with STREAM_LOCK, PREROLL_LOCK, LOCK
1971 * adjust a timestamp with the latency and timestamp offset. This function does
1972 * not adjust for the render delay. */
1974 gst_base_sink_adjust_time (GstBaseSink * basesink, GstClockTime time)
1976 GstClockTimeDiff ts_offset;
1978 /* don't do anything funny with invalid timestamps */
1979 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
1982 time += basesink->priv->latency;
1984 /* apply offset, be carefull for underflows */
1985 ts_offset = basesink->priv->ts_offset;
1986 if (ts_offset < 0) {
1987 ts_offset = -ts_offset;
1988 if (ts_offset < time)
1995 /* subtract the render delay again, which was included in the latency */
1996 if (time > basesink->priv->render_delay)
1997 time -= basesink->priv->render_delay;
2005 * gst_base_sink_wait_clock:
2007 * @time: the running_time to be reached
2008 * @jitter: (out) (allow-none): the jitter to be filled with time diff, or NULL
2010 * This function will block until @time is reached. It is usually called by
2011 * subclasses that use their own internal synchronisation.
2013 * If @time is not valid, no sycnhronisation is done and #GST_CLOCK_BADTIME is
2014 * returned. Likewise, if synchronisation is disabled in the element or there
2015 * is no clock, no synchronisation is done and #GST_CLOCK_BADTIME is returned.
2017 * This function should only be called with the PREROLL_LOCK held, like when
2018 * receiving an EOS event in the #GstBaseSinkClass.event() vmethod or when
2019 * receiving a buffer in
2020 * the #GstBaseSinkClass.render() vmethod.
2022 * The @time argument should be the running_time of when this method should
2023 * return and is not adjusted with any latency or offset configured in the
2028 * Returns: #GstClockReturn
2031 gst_base_sink_wait_clock (GstBaseSink * sink, GstClockTime time,
2032 GstClockTimeDiff * jitter)
2036 GstClockTime base_time;
2038 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
2041 GST_OBJECT_LOCK (sink);
2042 if (G_UNLIKELY (!sink->sync))
2045 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (sink)) == NULL))
2048 base_time = GST_ELEMENT_CAST (sink)->base_time;
2049 GST_LOG_OBJECT (sink,
2050 "time %" GST_TIME_FORMAT ", base_time %" GST_TIME_FORMAT,
2051 GST_TIME_ARGS (time), GST_TIME_ARGS (base_time));
2053 /* add base_time to running_time to get the time against the clock */
2056 /* Re-use existing clockid if available */
2057 /* FIXME: Casting to GstClockEntry only works because the types
2059 if (G_LIKELY (sink->priv->cached_clock_id != NULL
2060 && GST_CLOCK_ENTRY_CLOCK ((GstClockEntry *) sink->priv->
2061 cached_clock_id) == clock)) {
2062 if (!gst_clock_single_shot_id_reinit (clock, sink->priv->cached_clock_id,
2064 gst_clock_id_unref (sink->priv->cached_clock_id);
2065 sink->priv->cached_clock_id = gst_clock_new_single_shot_id (clock, time);
2068 if (sink->priv->cached_clock_id != NULL)
2069 gst_clock_id_unref (sink->priv->cached_clock_id);
2070 sink->priv->cached_clock_id = gst_clock_new_single_shot_id (clock, time);
2072 GST_OBJECT_UNLOCK (sink);
2074 /* A blocking wait is performed on the clock. We save the ClockID
2075 * so we can unlock the entry at any time. While we are blocking, we
2076 * release the PREROLL_LOCK so that other threads can interrupt the
2078 sink->clock_id = sink->priv->cached_clock_id;
2079 /* release the preroll lock while waiting */
2080 GST_BASE_SINK_PREROLL_UNLOCK (sink);
2082 ret = gst_clock_id_wait (sink->priv->cached_clock_id, jitter);
2084 GST_BASE_SINK_PREROLL_LOCK (sink);
2085 sink->clock_id = NULL;
2089 /* no syncing needed */
2092 GST_DEBUG_OBJECT (sink, "time not valid, no sync needed");
2093 return GST_CLOCK_BADTIME;
2097 GST_DEBUG_OBJECT (sink, "sync disabled");
2098 GST_OBJECT_UNLOCK (sink);
2099 return GST_CLOCK_BADTIME;
2103 GST_DEBUG_OBJECT (sink, "no clock, can't sync");
2104 GST_OBJECT_UNLOCK (sink);
2105 return GST_CLOCK_BADTIME;
2110 * gst_base_sink_wait_preroll:
2113 * If the #GstBaseSinkClass.render() method performs its own synchronisation
2114 * against the clock it must unblock when going from PLAYING to the PAUSED state
2115 * and call this method before continuing to render the remaining data.
2117 * This function will block until a state change to PLAYING happens (in which
2118 * case this function returns #GST_FLOW_OK) or the processing must be stopped due
2119 * to a state change to READY or a FLUSH event (in which case this function
2120 * returns #GST_FLOW_WRONG_STATE).
2122 * This function should only be called with the PREROLL_LOCK held, like in the
2125 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2126 * continue. Any other return value should be returned from the render vmethod.
2131 gst_base_sink_wait_preroll (GstBaseSink * sink)
2133 sink->have_preroll = TRUE;
2134 GST_DEBUG_OBJECT (sink, "waiting in preroll for flush or PLAYING");
2135 /* block until the state changes, or we get a flush, or something */
2136 GST_BASE_SINK_PREROLL_WAIT (sink);
2137 sink->have_preroll = FALSE;
2138 if (G_UNLIKELY (sink->flushing))
2140 if (G_UNLIKELY (sink->priv->step_unlock))
2142 GST_DEBUG_OBJECT (sink, "continue after preroll");
2149 GST_DEBUG_OBJECT (sink, "preroll interrupted because of flush");
2150 return GST_FLOW_WRONG_STATE;
2154 sink->priv->step_unlock = FALSE;
2155 GST_DEBUG_OBJECT (sink, "preroll interrupted because of step");
2156 return GST_FLOW_STEP;
2160 static inline guint8
2161 get_object_type (GstMiniObject * obj)
2165 if (G_LIKELY (GST_IS_BUFFER (obj)))
2166 obj_type = _PR_IS_BUFFER;
2167 else if (GST_IS_EVENT (obj))
2168 obj_type = _PR_IS_EVENT;
2169 else if (GST_IS_BUFFER_LIST (obj))
2170 obj_type = _PR_IS_BUFFERLIST;
2172 obj_type = _PR_IS_NOTHING;
2178 * gst_base_sink_do_preroll:
2180 * @obj: (transfer none): the mini object that caused the preroll
2182 * If the @sink spawns its own thread for pulling buffers from upstream it
2183 * should call this method after it has pulled a buffer. If the element needed
2184 * to preroll, this function will perform the preroll and will then block
2185 * until the element state is changed.
2187 * This function should be called with the PREROLL_LOCK held.
2189 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2190 * continue. Any other return value should be returned from the render vmethod.
2195 gst_base_sink_do_preroll (GstBaseSink * sink, GstMiniObject * obj)
2199 while (G_UNLIKELY (sink->need_preroll)) {
2201 GST_DEBUG_OBJECT (sink, "prerolling object %p", obj);
2203 obj_type = get_object_type (obj);
2205 ret = gst_base_sink_preroll_object (sink, obj_type, obj);
2206 if (ret != GST_FLOW_OK)
2207 goto preroll_failed;
2209 /* need to recheck here because the commit state could have
2210 * made us not need the preroll anymore */
2211 if (G_LIKELY (sink->need_preroll)) {
2212 /* block until the state changes, or we get a flush, or something */
2213 ret = gst_base_sink_wait_preroll (sink);
2214 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2215 goto preroll_failed;
2223 GST_DEBUG_OBJECT (sink, "preroll failed: %s", gst_flow_get_name (ret));
2229 * gst_base_sink_wait_eos:
2231 * @time: the running_time to be reached
2232 * @jitter: (out) (allow-none): the jitter to be filled with time diff, or NULL
2234 * This function will block until @time is reached. It is usually called by
2235 * subclasses that use their own internal synchronisation but want to let the
2236 * EOS be handled by the base class.
2238 * This function should only be called with the PREROLL_LOCK held, like when
2239 * receiving an EOS event in the ::event vmethod.
2241 * The @time argument should be the running_time of when the EOS should happen
2242 * and will be adjusted with any latency and offset configured in the sink.
2244 * Returns: #GstFlowReturn
2249 gst_base_sink_wait_eos (GstBaseSink * sink, GstClockTime time,
2250 GstClockTimeDiff * jitter)
2252 GstClockReturn status;
2258 GST_DEBUG_OBJECT (sink, "checking preroll");
2260 /* first wait for the playing state before we can continue */
2261 while (G_UNLIKELY (sink->need_preroll)) {
2262 ret = gst_base_sink_wait_preroll (sink);
2263 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2267 /* preroll done, we can sync since we are in PLAYING now. */
2268 GST_DEBUG_OBJECT (sink, "possibly waiting for clock to reach %"
2269 GST_TIME_FORMAT, GST_TIME_ARGS (time));
2271 /* compensate for latency and ts_offset. We don't adjust for render delay
2272 * because we don't interact with the device on EOS normally. */
2273 stime = gst_base_sink_adjust_time (sink, time);
2275 /* wait for the clock, this can be interrupted because we got shut down or
2277 status = gst_base_sink_wait_clock (sink, stime, jitter);
2279 GST_DEBUG_OBJECT (sink, "clock returned %d", status);
2281 /* invalid time, no clock or sync disabled, just continue then */
2282 if (status == GST_CLOCK_BADTIME)
2285 /* waiting could have been interrupted and we can be flushing now */
2286 if (G_UNLIKELY (sink->flushing))
2289 /* retry if we got unscheduled, which means we did not reach the timeout
2290 * yet. if some other error occures, we continue. */
2291 } while (status == GST_CLOCK_UNSCHEDULED);
2293 GST_DEBUG_OBJECT (sink, "end of stream");
2300 GST_DEBUG_OBJECT (sink, "we are flushing");
2301 return GST_FLOW_WRONG_STATE;
2305 /* with STREAM_LOCK, PREROLL_LOCK
2307 * Make sure we are in PLAYING and synchronize an object to the clock.
2309 * If we need preroll, we are not in PLAYING. We try to commit the state
2310 * if needed and then block if we still are not PLAYING.
2312 * We start waiting on the clock in PLAYING. If we got interrupted, we
2313 * immediately try to re-preroll.
2315 * Some objects do not need synchronisation (most events) and so this function
2316 * immediately returns GST_FLOW_OK.
2318 * for objects that arrive later than max-lateness to be synchronized to the
2319 * clock have the @late boolean set to TRUE.
2321 * This function keeps a running average of the jitter (the diff between the
2322 * clock time and the requested sync time). The jitter is negative for
2323 * objects that arrive in time and positive for late buffers.
2325 * does not take ownership of obj.
2327 static GstFlowReturn
2328 gst_base_sink_do_sync (GstBaseSink * basesink, GstPad * pad,
2329 GstMiniObject * obj, gboolean * late, gboolean * step_end, guint8 obj_type)
2331 GstClockTimeDiff jitter = 0;
2333 GstClockReturn status = GST_CLOCK_OK;
2334 GstClockTime rstart, rstop, sstart, sstop, stime;
2336 GstBaseSinkPrivate *priv;
2338 GstStepInfo *current, *pending;
2341 priv = basesink->priv;
2344 sstart = sstop = rstart = rstop = GST_CLOCK_TIME_NONE;
2348 priv->current_rstart = GST_CLOCK_TIME_NONE;
2350 /* get stepping info */
2351 current = &priv->current_step;
2352 pending = &priv->pending_step;
2354 /* get timing information for this object against the render segment */
2355 syncable = gst_base_sink_get_sync_times (basesink, obj,
2356 &sstart, &sstop, &rstart, &rstop, &do_sync, &stepped, &basesink->segment,
2357 current, step_end, obj_type);
2359 if (G_UNLIKELY (stepped))
2362 /* a syncable object needs to participate in preroll and
2363 * clocking. All buffers and EOS are syncable. */
2364 if (G_UNLIKELY (!syncable))
2367 /* store timing info for current object */
2368 priv->current_rstart = rstart;
2369 priv->current_rstop = (GST_CLOCK_TIME_IS_VALID (rstop) ? rstop : rstart);
2371 /* save sync time for eos when the previous object needed sync */
2372 priv->eos_rtime = (do_sync ? priv->current_rstop : GST_CLOCK_TIME_NONE);
2374 /* calculate inter frame spacing */
2375 if (G_UNLIKELY (priv->prev_rstart != -1 && priv->prev_rstart < rstart)) {
2376 GstClockTime in_diff;
2378 in_diff = rstart - priv->prev_rstart;
2380 if (priv->avg_in_diff == -1)
2381 priv->avg_in_diff = in_diff;
2383 priv->avg_in_diff = UPDATE_RUNNING_AVG (priv->avg_in_diff, in_diff);
2385 GST_LOG_OBJECT (basesink, "avg frame diff %" GST_TIME_FORMAT,
2386 GST_TIME_ARGS (priv->avg_in_diff));
2389 priv->prev_rstart = rstart;
2391 if (G_UNLIKELY (priv->earliest_in_time != -1
2392 && rstart < priv->earliest_in_time))
2396 /* first do preroll, this makes sure we commit our state
2397 * to PAUSED and can continue to PLAYING. We cannot perform
2398 * any clock sync in PAUSED because there is no clock. */
2399 ret = gst_base_sink_do_preroll (basesink, obj);
2400 if (G_UNLIKELY (ret != GST_FLOW_OK))
2401 goto preroll_failed;
2403 /* update the segment with a pending step if the current one is invalid and we
2404 * have a new pending one. We only accept new step updates after a preroll */
2405 if (G_UNLIKELY (pending->valid && !current->valid)) {
2406 start_stepping (basesink, &basesink->segment, pending, current);
2410 /* After rendering we store the position of the last buffer so that we can use
2411 * it to report the position. We need to take the lock here. */
2412 GST_OBJECT_LOCK (basesink);
2413 priv->current_sstart = sstart;
2414 priv->current_sstop = (GST_CLOCK_TIME_IS_VALID (sstop) ? sstop : sstart);
2415 GST_OBJECT_UNLOCK (basesink);
2420 /* adjust for latency */
2421 stime = gst_base_sink_adjust_time (basesink, rstart);
2423 /* adjust for render-delay, avoid underflows */
2424 if (GST_CLOCK_TIME_IS_VALID (stime)) {
2425 if (stime > priv->render_delay)
2426 stime -= priv->render_delay;
2431 /* preroll done, we can sync since we are in PLAYING now. */
2432 GST_DEBUG_OBJECT (basesink, "possibly waiting for clock to reach %"
2433 GST_TIME_FORMAT ", adjusted %" GST_TIME_FORMAT,
2434 GST_TIME_ARGS (rstart), GST_TIME_ARGS (stime));
2436 /* This function will return immediately if start == -1, no clock
2437 * or sync is disabled with GST_CLOCK_BADTIME. */
2438 status = gst_base_sink_wait_clock (basesink, stime, &jitter);
2440 GST_DEBUG_OBJECT (basesink, "clock returned %d, jitter %c%" GST_TIME_FORMAT,
2441 status, (jitter < 0 ? '-' : ' '), GST_TIME_ARGS (ABS (jitter)));
2443 /* invalid time, no clock or sync disabled, just render */
2444 if (status == GST_CLOCK_BADTIME)
2447 /* waiting could have been interrupted and we can be flushing now */
2448 if (G_UNLIKELY (basesink->flushing))
2451 /* check for unlocked by a state change, we are not flushing so
2452 * we can try to preroll on the current buffer. */
2453 if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED)) {
2454 GST_DEBUG_OBJECT (basesink, "unscheduled, waiting some more");
2455 priv->call_preroll = TRUE;
2459 /* successful syncing done, record observation */
2460 priv->current_jitter = jitter;
2462 /* check if the object should be dropped */
2463 *late = gst_base_sink_is_too_late (basesink, obj, rstart, rstop,
2472 GST_DEBUG_OBJECT (basesink, "skipped stepped object %p", obj);
2478 GST_DEBUG_OBJECT (basesink, "non syncable object %p", obj);
2483 GST_DEBUG_OBJECT (basesink, "dropped because of QoS %p", obj);
2489 GST_DEBUG_OBJECT (basesink, "we are flushing");
2490 return GST_FLOW_WRONG_STATE;
2494 GST_DEBUG_OBJECT (basesink, "preroll failed");
2501 gst_base_sink_send_qos (GstBaseSink * basesink, GstQOSType type,
2502 gdouble proportion, GstClockTime time, GstClockTimeDiff diff)
2507 /* generate Quality-of-Service event */
2508 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2509 "qos: type %d, proportion: %lf, diff %" G_GINT64_FORMAT ", timestamp %"
2510 GST_TIME_FORMAT, type, proportion, diff, GST_TIME_ARGS (time));
2512 event = gst_event_new_qos (type, proportion, diff, time);
2515 res = gst_pad_push_event (basesink->sinkpad, event);
2521 gst_base_sink_perform_qos (GstBaseSink * sink, gboolean dropped)
2523 GstBaseSinkPrivate *priv;
2524 GstClockTime start, stop;
2525 GstClockTimeDiff jitter;
2526 GstClockTime pt, entered, left;
2527 GstClockTime duration;
2532 start = priv->current_rstart;
2534 if (priv->current_step.valid)
2537 /* if Quality-of-Service disabled, do nothing */
2538 if (!g_atomic_int_get (&priv->qos_enabled) ||
2539 !GST_CLOCK_TIME_IS_VALID (start))
2542 stop = priv->current_rstop;
2543 jitter = priv->current_jitter;
2546 /* this is the time the buffer entered the sink */
2547 if (start < -jitter)
2550 entered = start + jitter;
2553 /* this is the time the buffer entered the sink */
2554 entered = start + jitter;
2555 /* this is the time the buffer left the sink */
2556 left = start + jitter;
2559 /* calculate duration of the buffer */
2560 if (GST_CLOCK_TIME_IS_VALID (stop) && stop != start)
2561 duration = stop - start;
2563 duration = priv->avg_in_diff;
2565 /* if we have the time when the last buffer left us, calculate
2566 * processing time */
2567 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2568 if (entered > priv->last_left) {
2569 pt = entered - priv->last_left;
2577 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "start: %" GST_TIME_FORMAT
2578 ", stop %" GST_TIME_FORMAT ", entered %" GST_TIME_FORMAT ", left %"
2579 GST_TIME_FORMAT ", pt: %" GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT
2580 ",jitter %" G_GINT64_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (stop),
2581 GST_TIME_ARGS (entered), GST_TIME_ARGS (left), GST_TIME_ARGS (pt),
2582 GST_TIME_ARGS (duration), jitter);
2584 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "avg_duration: %" GST_TIME_FORMAT
2585 ", avg_pt: %" GST_TIME_FORMAT ", avg_rate: %g",
2586 GST_TIME_ARGS (priv->avg_duration), GST_TIME_ARGS (priv->avg_pt),
2589 /* collect running averages. for first observations, we copy the
2591 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_duration))
2592 priv->avg_duration = duration;
2594 priv->avg_duration = UPDATE_RUNNING_AVG (priv->avg_duration, duration);
2596 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_pt))
2599 priv->avg_pt = UPDATE_RUNNING_AVG (priv->avg_pt, pt);
2601 if (priv->avg_duration != 0)
2603 gst_guint64_to_gdouble (priv->avg_pt) /
2604 gst_guint64_to_gdouble (priv->avg_duration);
2608 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2609 if (dropped || priv->avg_rate < 0.0) {
2610 priv->avg_rate = rate;
2613 priv->avg_rate = UPDATE_RUNNING_AVG_N (priv->avg_rate, rate);
2615 priv->avg_rate = UPDATE_RUNNING_AVG_P (priv->avg_rate, rate);
2619 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink,
2620 "updated: avg_duration: %" GST_TIME_FORMAT ", avg_pt: %" GST_TIME_FORMAT
2621 ", avg_rate: %g", GST_TIME_ARGS (priv->avg_duration),
2622 GST_TIME_ARGS (priv->avg_pt), priv->avg_rate);
2625 if (priv->avg_rate >= 0.0) {
2627 GstClockTimeDiff diff;
2629 /* if we have a valid rate, start sending QoS messages */
2630 if (priv->current_jitter < 0) {
2631 /* make sure we never go below 0 when adding the jitter to the
2633 if (priv->current_rstart < -priv->current_jitter)
2634 priv->current_jitter = -priv->current_rstart;
2637 if (priv->throttle_time > 0) {
2638 diff = priv->throttle_time;
2639 type = GST_QOS_TYPE_THROTTLE;
2641 diff = priv->current_jitter;
2643 type = GST_QOS_TYPE_OVERFLOW;
2645 type = GST_QOS_TYPE_UNDERFLOW;
2648 gst_base_sink_send_qos (sink, type, priv->avg_rate, priv->current_rstart,
2652 /* record when this buffer will leave us */
2653 priv->last_left = left;
2656 /* reset all qos measuring */
2658 gst_base_sink_reset_qos (GstBaseSink * sink)
2660 GstBaseSinkPrivate *priv;
2664 priv->last_render_time = GST_CLOCK_TIME_NONE;
2665 priv->prev_rstart = GST_CLOCK_TIME_NONE;
2666 priv->earliest_in_time = GST_CLOCK_TIME_NONE;
2667 priv->last_left = GST_CLOCK_TIME_NONE;
2668 priv->avg_duration = GST_CLOCK_TIME_NONE;
2669 priv->avg_pt = GST_CLOCK_TIME_NONE;
2670 priv->avg_rate = -1.0;
2671 priv->avg_render = GST_CLOCK_TIME_NONE;
2672 priv->avg_in_diff = GST_CLOCK_TIME_NONE;
2678 /* Checks if the object was scheduled too late.
2680 * rstart/rstop contain the running_time start and stop values
2683 * status and jitter contain the return values from the clock wait.
2685 * returns TRUE if the buffer was too late.
2688 gst_base_sink_is_too_late (GstBaseSink * basesink, GstMiniObject * obj,
2689 GstClockTime rstart, GstClockTime rstop,
2690 GstClockReturn status, GstClockTimeDiff jitter)
2693 guint64 max_lateness;
2694 GstBaseSinkPrivate *priv;
2696 priv = basesink->priv;
2700 /* only for objects that were too late */
2701 if (G_LIKELY (status != GST_CLOCK_EARLY))
2704 max_lateness = basesink->max_lateness;
2706 /* check if frame dropping is enabled */
2707 if (max_lateness == -1)
2710 /* only check for buffers */
2711 if (G_UNLIKELY (!GST_IS_BUFFER (obj)))
2714 /* can't do check if we don't have a timestamp */
2715 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (rstart)))
2718 /* we can add a valid stop time */
2719 if (GST_CLOCK_TIME_IS_VALID (rstop))
2720 max_lateness += rstop;
2722 max_lateness += rstart;
2723 /* no stop time, use avg frame diff */
2724 if (priv->avg_in_diff != -1)
2725 max_lateness += priv->avg_in_diff;
2728 /* if the jitter bigger than duration and lateness we are too late */
2729 if ((late = rstart + jitter > max_lateness)) {
2730 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2731 "buffer is too late %" GST_TIME_FORMAT
2732 " > %" GST_TIME_FORMAT, GST_TIME_ARGS (rstart + jitter),
2733 GST_TIME_ARGS (max_lateness));
2734 /* !!emergency!!, if we did not receive anything valid for more than a
2735 * second, render it anyway so the user sees something */
2736 if (GST_CLOCK_TIME_IS_VALID (priv->last_render_time) &&
2737 rstart - priv->last_render_time > GST_SECOND) {
2739 GST_ELEMENT_WARNING (basesink, CORE, CLOCK,
2740 (_("A lot of buffers are being dropped.")),
2741 ("There may be a timestamping problem, or this computer is too slow."));
2742 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2743 "**emergency** last buffer at %" GST_TIME_FORMAT " > GST_SECOND",
2744 GST_TIME_ARGS (priv->last_render_time));
2749 if (!late || !GST_CLOCK_TIME_IS_VALID (priv->last_render_time)) {
2750 priv->last_render_time = rstart;
2751 /* the next allowed input timestamp */
2752 if (priv->throttle_time > 0)
2753 priv->earliest_in_time = rstart + priv->throttle_time;
2760 GST_DEBUG_OBJECT (basesink, "object was scheduled in time");
2765 GST_DEBUG_OBJECT (basesink, "frame dropping disabled");
2770 GST_DEBUG_OBJECT (basesink, "object is not a buffer");
2775 GST_DEBUG_OBJECT (basesink, "buffer has no timestamp");
2780 /* called before and after calling the render vmethod. It keeps track of how
2781 * much time was spent in the render method and is used to check if we are
2784 gst_base_sink_do_render_stats (GstBaseSink * basesink, gboolean start)
2786 GstBaseSinkPrivate *priv;
2788 priv = basesink->priv;
2791 priv->start = gst_util_get_timestamp ();
2793 GstClockTime elapsed;
2795 priv->stop = gst_util_get_timestamp ();
2797 elapsed = GST_CLOCK_DIFF (priv->start, priv->stop);
2799 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_render))
2800 priv->avg_render = elapsed;
2802 priv->avg_render = UPDATE_RUNNING_AVG (priv->avg_render, elapsed);
2804 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2805 "avg_render: %" GST_TIME_FORMAT, GST_TIME_ARGS (priv->avg_render));
2809 /* with STREAM_LOCK, PREROLL_LOCK,
2811 * Synchronize the object on the clock and then render it.
2813 * takes ownership of obj.
2815 static GstFlowReturn
2816 gst_base_sink_render_object (GstBaseSink * basesink, GstPad * pad,
2817 guint8 obj_type, gpointer obj)
2820 GstBaseSinkClass *bclass;
2821 gboolean late, step_end;
2823 GstBaseSinkPrivate *priv;
2825 priv = basesink->priv;
2827 if (OBJ_IS_BUFFERLIST (obj_type)) {
2829 * If buffer list, use the first group buffer within the list
2832 sync_obj = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0);
2833 g_assert (NULL != sync_obj);
2842 /* synchronize this object, non syncable objects return OK
2845 gst_base_sink_do_sync (basesink, pad, sync_obj, &late, &step_end,
2847 if (G_UNLIKELY (ret != GST_FLOW_OK))
2850 /* and now render, event or buffer/buffer list. */
2851 if (G_LIKELY (OBJ_IS_BUFFERFULL (obj_type))) {
2852 /* drop late buffers unconditionally, let's hope it's unlikely */
2853 if (G_UNLIKELY (late))
2856 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2858 if (G_LIKELY ((OBJ_IS_BUFFERLIST (obj_type) && bclass->render_list) ||
2859 (!OBJ_IS_BUFFERLIST (obj_type) && bclass->render))) {
2862 /* read once, to get same value before and after */
2863 do_qos = g_atomic_int_get (&priv->qos_enabled);
2865 GST_DEBUG_OBJECT (basesink, "rendering object %p", obj);
2867 /* record rendering time for QoS and stats */
2869 gst_base_sink_do_render_stats (basesink, TRUE);
2871 if (!OBJ_IS_BUFFERLIST (obj_type)) {
2874 /* For buffer lists do not set last buffer. Creating buffer
2875 * with meaningful data can be done only with memcpy which will
2876 * significantly affect performance */
2877 buf = GST_BUFFER_CAST (obj);
2878 gst_base_sink_set_last_buffer (basesink, buf);
2880 ret = bclass->render (basesink, buf);
2882 GstBufferList *buflist;
2884 buflist = GST_BUFFER_LIST_CAST (obj);
2886 ret = bclass->render_list (basesink, buflist);
2890 gst_base_sink_do_render_stats (basesink, FALSE);
2892 if (ret == GST_FLOW_STEP)
2895 if (G_UNLIKELY (basesink->flushing))
2900 } else if (G_LIKELY (OBJ_IS_EVENT (obj_type))) {
2901 GstEvent *event = GST_EVENT_CAST (obj);
2902 gboolean event_res = TRUE;
2905 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2907 type = GST_EVENT_TYPE (event);
2909 GST_DEBUG_OBJECT (basesink, "rendering event %p, type %s", obj,
2910 gst_event_type_get_name (type));
2913 event_res = bclass->event (basesink, event);
2915 /* when we get here we could be flushing again when the event handler calls
2916 * _wait_eos(). We have to ignore this object in that case. */
2917 if (G_UNLIKELY (basesink->flushing))
2920 if (G_LIKELY (event_res)) {
2923 seqnum = basesink->priv->seqnum = gst_event_get_seqnum (event);
2924 GST_DEBUG_OBJECT (basesink, "Got seqnum #%" G_GUINT32_FORMAT, seqnum);
2929 GstMessage *message;
2931 /* the EOS event is completely handled so we mark
2932 * ourselves as being in the EOS state. eos is also
2933 * protected by the object lock so we can read it when
2934 * answering the POSITION query. */
2935 GST_OBJECT_LOCK (basesink);
2936 basesink->eos = TRUE;
2937 GST_OBJECT_UNLOCK (basesink);
2939 /* ok, now we can post the message */
2940 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
2942 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
2943 gst_message_set_seqnum (message, seqnum);
2944 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
2947 case GST_EVENT_SEGMENT:
2948 /* configure the segment */
2949 gst_base_sink_configure_segment (basesink, pad, event,
2950 &basesink->segment);
2954 GstTagList *taglist;
2956 gst_event_parse_tag (event, &taglist);
2958 gst_element_post_message (GST_ELEMENT_CAST (basesink),
2959 gst_message_new_tag (GST_OBJECT_CAST (basesink),
2960 gst_tag_list_copy (taglist)));
2963 case GST_EVENT_SINK_MESSAGE:
2965 GstMessage *msg = NULL;
2967 gst_event_parse_sink_message (event, &msg);
2970 gst_element_post_message (GST_ELEMENT_CAST (basesink), msg);
2977 g_return_val_if_reached (GST_FLOW_ERROR);
2982 /* the step ended, check if we need to activate a new step */
2983 GST_DEBUG_OBJECT (basesink, "step ended");
2984 stop_stepping (basesink, &basesink->segment, &priv->current_step,
2985 priv->current_rstart, priv->current_rstop, basesink->eos);
2989 gst_base_sink_perform_qos (basesink, late);
2991 GST_DEBUG_OBJECT (basesink, "object unref after render %p", obj);
2992 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
2998 GST_DEBUG_OBJECT (basesink, "do_sync returned %s", gst_flow_get_name (ret));
3004 GST_DEBUG_OBJECT (basesink, "buffer late, dropping");
3006 if (g_atomic_int_get (&priv->qos_enabled)) {
3007 GstMessage *qos_msg;
3008 GstClockTime timestamp, duration;
3010 timestamp = GST_BUFFER_TIMESTAMP (GST_BUFFER_CAST (sync_obj));
3011 duration = GST_BUFFER_DURATION (GST_BUFFER_CAST (sync_obj));
3013 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
3014 "qos: dropped buffer rt %" GST_TIME_FORMAT ", st %" GST_TIME_FORMAT
3015 ", ts %" GST_TIME_FORMAT ", dur %" GST_TIME_FORMAT,
3016 GST_TIME_ARGS (priv->current_rstart),
3017 GST_TIME_ARGS (priv->current_sstart), GST_TIME_ARGS (timestamp),
3018 GST_TIME_ARGS (duration));
3019 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
3020 "qos: rendered %" G_GUINT64_FORMAT ", dropped %" G_GUINT64_FORMAT,
3021 priv->rendered, priv->dropped);
3024 gst_message_new_qos (GST_OBJECT_CAST (basesink), basesink->sync,
3025 priv->current_rstart, priv->current_sstart, timestamp, duration);
3026 gst_message_set_qos_values (qos_msg, priv->current_jitter, priv->avg_rate,
3028 gst_message_set_qos_stats (qos_msg, GST_FORMAT_BUFFERS, priv->rendered,
3030 gst_element_post_message (GST_ELEMENT_CAST (basesink), qos_msg);
3036 GST_DEBUG_OBJECT (basesink, "we are flushing, ignore object");
3037 gst_mini_object_unref (obj);
3038 return GST_FLOW_WRONG_STATE;
3042 /* with STREAM_LOCK, PREROLL_LOCK
3044 * Perform preroll on the given object. For buffers this means
3045 * calling the preroll subclass method.
3046 * If that succeeds, the state will be commited.
3048 * function does not take ownership of obj.
3050 static GstFlowReturn
3051 gst_base_sink_preroll_object (GstBaseSink * basesink, guint8 obj_type,
3052 GstMiniObject * obj)
3056 GST_DEBUG_OBJECT (basesink, "prerolling object %p", obj);
3058 /* if it's a buffer, we need to call the preroll method */
3059 if (G_LIKELY (OBJ_IS_BUFFERFULL (obj_type) && basesink->priv->call_preroll)) {
3060 GstBaseSinkClass *bclass;
3062 GstClockTime timestamp;
3064 if (OBJ_IS_BUFFERLIST (obj_type)) {
3065 buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0);
3066 g_assert (NULL != buf);
3068 buf = GST_BUFFER_CAST (obj);
3071 timestamp = GST_BUFFER_TIMESTAMP (buf);
3073 GST_DEBUG_OBJECT (basesink, "preroll buffer %" GST_TIME_FORMAT,
3074 GST_TIME_ARGS (timestamp));
3077 * For buffer lists do not set last buffer. Creating buffer
3078 * with meaningful data can be done only with memcpy which will
3079 * significantly affect performance
3081 if (!OBJ_IS_BUFFERLIST (obj_type)) {
3082 gst_base_sink_set_last_buffer (basesink, buf);
3085 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3086 if (bclass->preroll)
3087 if ((ret = bclass->preroll (basesink, buf)) != GST_FLOW_OK)
3088 goto preroll_failed;
3090 basesink->priv->call_preroll = FALSE;
3094 if (G_LIKELY (basesink->playing_async)) {
3095 if (G_UNLIKELY (!gst_base_sink_commit_state (basesink)))
3104 GST_DEBUG_OBJECT (basesink, "preroll failed, abort state");
3105 gst_element_abort_state (GST_ELEMENT_CAST (basesink));
3110 GST_DEBUG_OBJECT (basesink, "stopping while commiting state");
3111 return GST_FLOW_WRONG_STATE;
3115 /* with STREAM_LOCK, PREROLL_LOCK
3117 * Queue an object for rendering.
3118 * The first prerollable object queued will complete the preroll. If the
3119 * preroll queue is filled, we render all the objects in the queue.
3121 * This function takes ownership of the object.
3123 static GstFlowReturn
3124 gst_base_sink_queue_object_unlocked (GstBaseSink * basesink, GstPad * pad,
3125 guint8 obj_type, gpointer obj, gboolean prerollable)
3127 GstFlowReturn ret = GST_FLOW_OK;
3131 if (G_UNLIKELY (basesink->need_preroll)) {
3132 if (G_LIKELY (prerollable))
3133 basesink->priv->preroll_queued++;
3135 length = basesink->priv->preroll_queued;
3137 GST_DEBUG_OBJECT (basesink, "now %d prerolled items", length);
3139 /* first prerollable item needs to finish the preroll */
3141 ret = gst_base_sink_preroll_object (basesink, obj_type, obj);
3142 if (G_UNLIKELY (ret != GST_FLOW_OK))
3143 goto preroll_failed;
3145 /* need to recheck if we need preroll, commit state during preroll
3146 * could have made us not need more preroll. */
3147 if (G_UNLIKELY (basesink->need_preroll)) {
3148 /* see if we can render now, if we can't add the object to the preroll
3150 if (G_UNLIKELY (length <= 0))
3154 /* we can start rendering (or blocking) the queued object
3156 q = basesink->priv->preroll_queue;
3157 while (G_UNLIKELY (!g_queue_is_empty (q))) {
3161 o = g_queue_pop_head (q);
3162 GST_DEBUG_OBJECT (basesink, "rendering queued object %p", o);
3164 ot = get_object_type (o);
3166 /* do something with the return value */
3167 ret = gst_base_sink_render_object (basesink, pad, ot, o);
3168 if (ret != GST_FLOW_OK)
3169 goto dequeue_failed;
3172 /* now render the object */
3173 ret = gst_base_sink_render_object (basesink, pad, obj_type, obj);
3174 basesink->priv->preroll_queued = 0;
3181 GST_DEBUG_OBJECT (basesink, "preroll failed, reason %s",
3182 gst_flow_get_name (ret));
3183 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3188 /* add object to the queue and return */
3189 GST_DEBUG_OBJECT (basesink, "need more preroll data");
3190 g_queue_push_tail (basesink->priv->preroll_queue, obj);
3195 GST_DEBUG_OBJECT (basesink, "rendering queued objects failed, reason %s",
3196 gst_flow_get_name (ret));
3197 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3204 * This function grabs the PREROLL_LOCK and adds the object to
3207 * This function takes ownership of obj.
3209 * Note: Only GstEvent seem to be passed to this private method
3211 static GstFlowReturn
3212 gst_base_sink_queue_object (GstBaseSink * basesink, GstPad * pad,
3213 GstMiniObject * obj, gboolean prerollable)
3217 GST_BASE_SINK_PREROLL_LOCK (basesink);
3218 if (G_UNLIKELY (basesink->flushing))
3221 if (G_UNLIKELY (basesink->priv->received_eos))
3225 gst_base_sink_queue_object_unlocked (basesink, pad, _PR_IS_EVENT, obj,
3227 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3234 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3235 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3236 gst_mini_object_unref (obj);
3237 return GST_FLOW_WRONG_STATE;
3241 GST_DEBUG_OBJECT (basesink, "we are EOS, dropping object, return EOS");
3242 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3243 gst_mini_object_unref (obj);
3244 return GST_FLOW_EOS;
3249 gst_base_sink_flush_start (GstBaseSink * basesink, GstPad * pad)
3251 /* make sure we are not blocked on the clock also clear any pending
3253 gst_base_sink_set_flushing (basesink, pad, TRUE);
3255 /* we grab the stream lock but that is not needed since setting the
3256 * sink to flushing would make sure no state commit is being done
3258 GST_PAD_STREAM_LOCK (pad);
3259 gst_base_sink_reset_qos (basesink);
3260 /* and we need to commit our state again on the next
3261 * prerolled buffer */
3262 basesink->playing_async = TRUE;
3263 if (basesink->priv->async_enabled) {
3264 gst_element_lost_state (GST_ELEMENT_CAST (basesink));
3266 /* start time reset in above case as well;
3267 * arranges for a.o. proper position reporting when flushing in PAUSED */
3268 gst_element_set_start_time (GST_ELEMENT_CAST (basesink), 0);
3269 basesink->priv->have_latency = TRUE;
3271 gst_base_sink_set_last_buffer (basesink, NULL);
3272 GST_PAD_STREAM_UNLOCK (pad);
3276 gst_base_sink_flush_stop (GstBaseSink * basesink, GstPad * pad,
3277 gboolean reset_time)
3279 /* unset flushing so we can accept new data, this also flushes out any EOS
3281 gst_base_sink_set_flushing (basesink, pad, FALSE);
3283 /* for position reporting */
3284 GST_OBJECT_LOCK (basesink);
3285 basesink->priv->current_sstart = GST_CLOCK_TIME_NONE;
3286 basesink->priv->current_sstop = GST_CLOCK_TIME_NONE;
3287 basesink->priv->eos_rtime = GST_CLOCK_TIME_NONE;
3288 basesink->priv->call_preroll = TRUE;
3289 basesink->priv->current_step.valid = FALSE;
3290 basesink->priv->pending_step.valid = FALSE;
3291 if (basesink->pad_mode == GST_PAD_ACTIVATE_PUSH) {
3292 /* we need new segment info after the flush. */
3293 basesink->have_newsegment = FALSE;
3295 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
3296 gst_segment_init (&basesink->clip_segment, GST_FORMAT_UNDEFINED);
3299 basesink->priv->reset_time = reset_time;
3300 GST_OBJECT_UNLOCK (basesink);
3304 gst_base_sink_event (GstPad * pad, GstEvent * event)
3306 GstBaseSink *basesink;
3307 gboolean result = TRUE;
3308 GstBaseSinkClass *bclass;
3310 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3311 if (G_UNLIKELY (basesink == NULL)) {
3312 gst_event_unref (event);
3316 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3318 GST_DEBUG_OBJECT (basesink, "received event %p %" GST_PTR_FORMAT, event,
3321 switch (GST_EVENT_TYPE (event)) {
3326 GST_BASE_SINK_PREROLL_LOCK (basesink);
3327 if (G_UNLIKELY (basesink->flushing))
3330 if (G_UNLIKELY (basesink->priv->received_eos))
3333 /* we set the received EOS flag here so that we can use it when testing if
3334 * we are prerolled and to refuse more buffers. */
3335 basesink->priv->received_eos = TRUE;
3337 /* EOS is a prerollable object, we call the unlocked version because it
3338 * does not check the received_eos flag. */
3339 ret = gst_base_sink_queue_object_unlocked (basesink, pad,
3340 _PR_IS_EVENT, GST_MINI_OBJECT_CAST (event), TRUE);
3341 if (G_UNLIKELY (ret != GST_FLOW_OK))
3344 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3347 case GST_EVENT_CAPS:
3351 GST_DEBUG_OBJECT (basesink, "caps %p", event);
3353 gst_event_parse_caps (event, &caps);
3354 if (bclass->set_caps)
3355 result = bclass->set_caps (basesink, caps);
3357 gst_event_unref (event);
3360 case GST_EVENT_SEGMENT:
3364 GST_DEBUG_OBJECT (basesink, "segment %p", event);
3366 GST_BASE_SINK_PREROLL_LOCK (basesink);
3367 if (G_UNLIKELY (basesink->flushing))
3370 if (G_UNLIKELY (basesink->priv->received_eos))
3373 /* the new segment is a non prerollable item and does not block anything,
3374 * we need to configure the current clipping segment and insert the event
3375 * in the queue to serialize it with the buffers for rendering. */
3376 gst_base_sink_configure_segment (basesink, pad, event,
3377 &basesink->clip_segment);
3380 gst_base_sink_queue_object_unlocked (basesink, pad,
3381 _PR_IS_EVENT, GST_MINI_OBJECT_CAST (event), FALSE);
3382 if (G_UNLIKELY (ret != GST_FLOW_OK))
3385 GST_OBJECT_LOCK (basesink);
3386 basesink->have_newsegment = TRUE;
3387 GST_OBJECT_UNLOCK (basesink);
3389 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3392 case GST_EVENT_FLUSH_START:
3394 bclass->event (basesink, event);
3396 GST_DEBUG_OBJECT (basesink, "flush-start %p", event);
3398 gst_base_sink_flush_start (basesink, pad);
3400 gst_event_unref (event);
3402 case GST_EVENT_FLUSH_STOP:
3404 gboolean reset_time;
3407 bclass->event (basesink, event);
3409 gst_event_parse_flush_stop (event, &reset_time);
3410 GST_DEBUG_OBJECT (basesink, "flush-stop %p, reset_time: %d", event,
3413 gst_base_sink_flush_stop (basesink, pad, reset_time);
3415 gst_event_unref (event);
3419 /* other events are sent to queue or subclass depending on if they
3420 * are serialized. */
3421 if (GST_EVENT_IS_SERIALIZED (event)) {
3422 gst_base_sink_queue_object (basesink, pad,
3423 GST_MINI_OBJECT_CAST (event), FALSE);
3426 bclass->event (basesink, event);
3427 gst_event_unref (event);
3432 gst_object_unref (basesink);
3439 GST_DEBUG_OBJECT (basesink, "we are flushing");
3440 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3442 gst_event_unref (event);
3448 GST_DEBUG_OBJECT (basesink, "Event received after EOS, dropping");
3449 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3451 gst_event_unref (event);
3456 /* default implementation to calculate the start and end
3457 * timestamps on a buffer, subclasses can override
3460 gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
3461 GstClockTime * start, GstClockTime * end)
3463 GstClockTime timestamp, duration;
3465 timestamp = GST_BUFFER_TIMESTAMP (buffer);
3466 if (GST_CLOCK_TIME_IS_VALID (timestamp)) {
3468 /* get duration to calculate end time */
3469 duration = GST_BUFFER_DURATION (buffer);
3470 if (GST_CLOCK_TIME_IS_VALID (duration)) {
3471 *end = timestamp + duration;
3477 /* must be called with PREROLL_LOCK */
3479 gst_base_sink_needs_preroll (GstBaseSink * basesink)
3481 gboolean is_prerolled, res;
3483 /* we have 2 cases where the PREROLL_LOCK is released:
3484 * 1) we are blocking in the PREROLL_LOCK and thus are prerolled.
3485 * 2) we are syncing on the clock
3487 is_prerolled = basesink->have_preroll || basesink->priv->received_eos;
3488 res = !is_prerolled;
3490 GST_DEBUG_OBJECT (basesink, "have_preroll: %d, EOS: %d => needs preroll: %d",
3491 basesink->have_preroll, basesink->priv->received_eos, res);
3496 /* with STREAM_LOCK, PREROLL_LOCK
3498 * Takes a buffer and compare the timestamps with the last segment.
3499 * If the buffer falls outside of the segment boundaries, drop it.
3500 * Else queue the buffer for preroll and rendering.
3502 * This function takes ownership of the buffer.
3504 static GstFlowReturn
3505 gst_base_sink_chain_unlocked (GstBaseSink * basesink, GstPad * pad,
3506 guint8 obj_type, gpointer obj)
3508 GstBaseSinkClass *bclass;
3509 GstFlowReturn result;
3510 GstClockTime start = GST_CLOCK_TIME_NONE, end = GST_CLOCK_TIME_NONE;
3511 GstSegment *clip_segment;
3512 GstBuffer *time_buf;
3514 if (G_UNLIKELY (basesink->flushing))
3517 if (G_UNLIKELY (basesink->priv->received_eos))
3520 if (OBJ_IS_BUFFERLIST (obj_type)) {
3521 time_buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0);
3522 g_assert (NULL != time_buf);
3524 time_buf = GST_BUFFER_CAST (obj);
3527 /* for code clarity */
3528 clip_segment = &basesink->clip_segment;
3530 if (G_UNLIKELY (!basesink->have_newsegment)) {
3533 sync = gst_base_sink_get_sync (basesink);
3535 GST_ELEMENT_WARNING (basesink, STREAM, FAILED,
3536 (_("Internal data flow problem.")),
3537 ("Received buffer without a new-segment. Assuming timestamps start from 0."));
3540 /* this means this sink will assume timestamps start from 0 */
3541 GST_OBJECT_LOCK (basesink);
3542 clip_segment->start = 0;
3543 clip_segment->stop = -1;
3544 basesink->segment.start = 0;
3545 basesink->segment.stop = -1;
3546 basesink->have_newsegment = TRUE;
3547 GST_OBJECT_UNLOCK (basesink);
3550 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3552 /* check if the buffer needs to be dropped, we first ask the subclass for the
3554 if (bclass->get_times)
3555 bclass->get_times (basesink, time_buf, &start, &end);
3557 if (!GST_CLOCK_TIME_IS_VALID (start)) {
3558 /* if the subclass does not want sync, we use our own values so that we at
3559 * least clip the buffer to the segment */
3560 gst_base_sink_get_times (basesink, time_buf, &start, &end);
3563 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
3564 ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (end));
3566 /* a dropped buffer does not participate in anything */
3567 if (GST_CLOCK_TIME_IS_VALID (start) &&
3568 (clip_segment->format == GST_FORMAT_TIME)) {
3569 if (G_UNLIKELY (!gst_segment_clip (clip_segment,
3570 GST_FORMAT_TIME, start, end, NULL, NULL)))
3571 goto out_of_segment;
3574 /* now we can process the buffer in the queue, this function takes ownership
3576 result = gst_base_sink_queue_object_unlocked (basesink, pad,
3577 obj_type, obj, TRUE);
3583 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3584 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3585 return GST_FLOW_WRONG_STATE;
3589 GST_DEBUG_OBJECT (basesink, "we are EOS, dropping object, return EOS");
3590 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3591 return GST_FLOW_EOS;
3595 GST_DEBUG_OBJECT (basesink, "dropping buffer, out of clipping segment");
3596 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3603 static GstFlowReturn
3604 gst_base_sink_chain_main (GstBaseSink * basesink, GstPad * pad,
3605 guint8 obj_type, gpointer obj)
3607 GstFlowReturn result;
3609 if (G_UNLIKELY (basesink->pad_mode != GST_PAD_ACTIVATE_PUSH))
3612 GST_BASE_SINK_PREROLL_LOCK (basesink);
3613 result = gst_base_sink_chain_unlocked (basesink, pad, obj_type, obj);
3614 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3622 GST_OBJECT_LOCK (pad);
3623 GST_WARNING_OBJECT (basesink,
3624 "Push on pad %s:%s, but it was not activated in push mode",
3625 GST_DEBUG_PAD_NAME (pad));
3626 GST_OBJECT_UNLOCK (pad);
3627 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3628 /* we don't post an error message this will signal to the peer
3629 * pushing that EOS is reached. */
3630 result = GST_FLOW_EOS;
3635 static GstFlowReturn
3636 gst_base_sink_chain (GstPad * pad, GstBuffer * buf)
3638 GstBaseSink *basesink;
3640 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3642 return gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFER, buf);
3645 static GstFlowReturn
3646 gst_base_sink_chain_list (GstPad * pad, GstBufferList * list)
3648 GstBaseSink *basesink;
3649 GstBaseSinkClass *bclass;
3650 GstFlowReturn result;
3652 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3653 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3655 if (G_LIKELY (bclass->render_list)) {
3656 result = gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFERLIST, list);
3661 GST_INFO_OBJECT (pad, "chaining each group in list as a merged buffer");
3663 len = gst_buffer_list_length (list);
3665 result = GST_FLOW_OK;
3666 for (i = 0; i < len; i++) {
3667 buffer = gst_buffer_list_get (list, 0);
3668 result = gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFER,
3669 gst_buffer_ref (buffer));
3670 if (result != GST_FLOW_OK)
3673 gst_buffer_list_unref (list);
3680 gst_base_sink_default_do_seek (GstBaseSink * sink, GstSegment * segment)
3682 gboolean res = TRUE;
3684 /* update our offset if the start/stop position was updated */
3685 if (segment->format == GST_FORMAT_BYTES) {
3686 segment->time = segment->start;
3687 } else if (segment->start == 0) {
3688 /* seek to start, we can implement a default for this. */
3692 GST_INFO_OBJECT (sink, "Can't do a default seek");
3698 #define SEEK_TYPE_IS_RELATIVE(t) (((t) != GST_SEEK_TYPE_NONE) && ((t) != GST_SEEK_TYPE_SET))
3701 gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
3702 GstEvent * event, GstSegment * segment)
3704 /* By default, we try one of 2 things:
3705 * - For absolute seek positions, convert the requested position to our
3706 * configured processing format and place it in the output segment \
3707 * - For relative seek positions, convert our current (input) values to the
3708 * seek format, adjust by the relative seek offset and then convert back to
3709 * the processing format
3711 GstSeekType cur_type, stop_type;
3714 GstFormat seek_format;
3717 gboolean res = TRUE;
3719 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3720 &cur_type, &cur, &stop_type, &stop);
3722 if (seek_format == segment->format) {
3723 gst_segment_do_seek (segment, rate, seek_format, flags,
3724 cur_type, cur, stop_type, stop, &update);
3728 if (cur_type != GST_SEEK_TYPE_NONE) {
3729 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3731 gst_pad_query_convert (sink->sinkpad, seek_format, cur, segment->format,
3733 cur_type = GST_SEEK_TYPE_SET;
3736 if (res && stop_type != GST_SEEK_TYPE_NONE) {
3737 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3739 gst_pad_query_convert (sink->sinkpad, seek_format, stop,
3740 segment->format, &stop);
3741 stop_type = GST_SEEK_TYPE_SET;
3744 /* And finally, configure our output segment in the desired format */
3745 gst_segment_do_seek (segment, rate, segment->format, flags, cur_type, cur,
3746 stop_type, stop, &update);
3755 GST_DEBUG_OBJECT (sink, "undefined format given, seek aborted.");
3760 /* perform a seek, only executed in pull mode */
3762 gst_base_sink_perform_seek (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3766 GstFormat seek_format, dest_format;
3768 GstSeekType cur_type, stop_type;
3769 gboolean seekseg_configured = FALSE;
3771 gboolean update, res = TRUE;
3772 GstSegment seeksegment;
3774 dest_format = sink->segment.format;
3777 GST_DEBUG_OBJECT (sink, "performing seek with event %p", event);
3778 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3779 &cur_type, &cur, &stop_type, &stop);
3781 flush = flags & GST_SEEK_FLAG_FLUSH;
3783 GST_DEBUG_OBJECT (sink, "performing seek without event");
3788 GST_DEBUG_OBJECT (sink, "flushing upstream");
3789 gst_pad_push_event (pad, gst_event_new_flush_start ());
3790 gst_base_sink_flush_start (sink, pad);
3792 GST_DEBUG_OBJECT (sink, "pausing pulling thread");
3795 GST_PAD_STREAM_LOCK (pad);
3797 /* If we configured the seeksegment above, don't overwrite it now. Otherwise
3798 * copy the current segment info into the temp segment that we can actually
3799 * attempt the seek with. We only update the real segment if the seek succeeds. */
3800 if (!seekseg_configured) {
3801 memcpy (&seeksegment, &sink->segment, sizeof (GstSegment));
3803 /* now configure the final seek segment */
3805 if (sink->segment.format != seek_format) {
3806 /* OK, here's where we give the subclass a chance to convert the relative
3807 * seek into an absolute one in the processing format. We set up any
3808 * absolute seek above, before taking the stream lock. */
3809 if (!gst_base_sink_default_prepare_seek_segment (sink, event,
3811 GST_DEBUG_OBJECT (sink,
3812 "Preparing the seek failed after flushing. " "Aborting seek");
3816 /* The seek format matches our processing format, no need to ask the
3817 * the subclass to configure the segment. */
3818 gst_segment_do_seek (&seeksegment, rate, seek_format, flags,
3819 cur_type, cur, stop_type, stop, &update);
3822 /* Else, no seek event passed, so we're just (re)starting the
3827 GST_DEBUG_OBJECT (sink, "segment configured from %" G_GINT64_FORMAT
3828 " to %" G_GINT64_FORMAT ", position %" G_GINT64_FORMAT,
3829 seeksegment.start, seeksegment.stop, seeksegment.position);
3831 /* do the seek, segment.position contains the new position. */
3832 res = gst_base_sink_default_do_seek (sink, &seeksegment);
3837 GST_DEBUG_OBJECT (sink, "stop flushing upstream");
3838 gst_pad_push_event (pad, gst_event_new_flush_stop (TRUE));
3839 gst_base_sink_flush_stop (sink, pad, TRUE);
3840 } else if (res && sink->running) {
3841 /* we are running the current segment and doing a non-flushing seek,
3842 * close the segment first based on the position. */
3843 GST_DEBUG_OBJECT (sink, "closing running segment %" G_GINT64_FORMAT
3844 " to %" G_GINT64_FORMAT, sink->segment.start, sink->segment.position);
3847 /* The subclass must have converted the segment to the processing format
3849 if (res && seeksegment.format != dest_format) {
3850 GST_DEBUG_OBJECT (sink, "Subclass failed to prepare a seek segment "
3851 "in the correct format. Aborting seek.");
3855 /* if successful seek, we update our real segment and push
3856 * out the new segment. */
3858 gst_segment_copy_into (&seeksegment, &sink->segment);
3860 if (sink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3861 gst_element_post_message (GST_ELEMENT (sink),
3862 gst_message_new_segment_start (GST_OBJECT (sink),
3863 sink->segment.format, sink->segment.position));
3867 sink->priv->discont = TRUE;
3868 sink->running = TRUE;
3870 GST_PAD_STREAM_UNLOCK (pad);
3876 set_step_info (GstBaseSink * sink, GstStepInfo * current, GstStepInfo * pending,
3877 guint seqnum, GstFormat format, guint64 amount, gdouble rate,
3878 gboolean flush, gboolean intermediate)
3880 GST_OBJECT_LOCK (sink);
3881 pending->seqnum = seqnum;
3882 pending->format = format;
3883 pending->amount = amount;
3884 pending->position = 0;
3885 pending->rate = rate;
3886 pending->flush = flush;
3887 pending->intermediate = intermediate;
3888 pending->valid = TRUE;
3889 /* flush invalidates the current stepping segment */
3891 current->valid = FALSE;
3892 GST_OBJECT_UNLOCK (sink);
3896 gst_base_sink_perform_step (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3898 GstBaseSinkPrivate *priv;
3899 GstBaseSinkClass *bclass;
3900 gboolean flush, intermediate;
3905 GstStepInfo *pending, *current;
3906 GstMessage *message;
3908 bclass = GST_BASE_SINK_GET_CLASS (sink);
3911 GST_DEBUG_OBJECT (sink, "performing step with event %p", event);
3913 gst_event_parse_step (event, &format, &amount, &rate, &flush, &intermediate);
3914 seqnum = gst_event_get_seqnum (event);
3916 pending = &priv->pending_step;
3917 current = &priv->current_step;
3919 /* post message first */
3920 message = gst_message_new_step_start (GST_OBJECT (sink), FALSE, format,
3921 amount, rate, flush, intermediate);
3922 gst_message_set_seqnum (message, seqnum);
3923 gst_element_post_message (GST_ELEMENT (sink), message);
3926 /* we need to call ::unlock before locking PREROLL_LOCK
3927 * since we lock it before going into ::render */
3929 bclass->unlock (sink);
3931 GST_BASE_SINK_PREROLL_LOCK (sink);
3932 /* now that we have the PREROLL lock, clear our unlock request */
3933 if (bclass->unlock_stop)
3934 bclass->unlock_stop (sink);
3936 /* update the stepinfo and make it valid */
3937 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3940 if (sink->priv->async_enabled) {
3941 /* and we need to commit our state again on the next
3942 * prerolled buffer */
3943 sink->playing_async = TRUE;
3944 priv->pending_step.need_preroll = TRUE;
3945 sink->need_preroll = FALSE;
3946 gst_element_lost_state (GST_ELEMENT_CAST (sink));
3948 sink->priv->have_latency = TRUE;
3949 sink->need_preroll = FALSE;
3951 priv->current_sstart = GST_CLOCK_TIME_NONE;
3952 priv->current_sstop = GST_CLOCK_TIME_NONE;
3953 priv->eos_rtime = GST_CLOCK_TIME_NONE;
3954 priv->call_preroll = TRUE;
3955 gst_base_sink_set_last_buffer (sink, NULL);
3956 gst_base_sink_reset_qos (sink);
3958 if (sink->clock_id) {
3959 gst_clock_id_unschedule (sink->clock_id);
3962 if (sink->have_preroll) {
3963 GST_DEBUG_OBJECT (sink, "signal waiter");
3964 priv->step_unlock = TRUE;
3965 GST_BASE_SINK_PREROLL_SIGNAL (sink);
3967 GST_BASE_SINK_PREROLL_UNLOCK (sink);
3969 /* update the stepinfo and make it valid */
3970 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3980 gst_base_sink_loop (GstPad * pad)
3982 GstBaseSink *basesink;
3983 GstBuffer *buf = NULL;
3984 GstFlowReturn result;
3988 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3990 g_assert (basesink->pad_mode == GST_PAD_ACTIVATE_PULL);
3992 if ((blocksize = basesink->priv->blocksize) == 0)
3995 offset = basesink->segment.position;
3997 GST_DEBUG_OBJECT (basesink, "pulling %" G_GUINT64_FORMAT ", %u",
4000 result = gst_pad_pull_range (pad, offset, blocksize, &buf);
4001 if (G_UNLIKELY (result != GST_FLOW_OK))
4004 if (G_UNLIKELY (buf == NULL))
4007 offset += gst_buffer_get_size (buf);
4009 basesink->segment.position = offset;
4011 GST_BASE_SINK_PREROLL_LOCK (basesink);
4012 result = gst_base_sink_chain_unlocked (basesink, pad, _PR_IS_BUFFER, buf);
4013 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4014 if (G_UNLIKELY (result != GST_FLOW_OK))
4022 GST_LOG_OBJECT (basesink, "pausing task, reason %s",
4023 gst_flow_get_name (result));
4024 gst_pad_pause_task (pad);
4025 if (result == GST_FLOW_EOS) {
4026 /* perform EOS logic */
4027 if (basesink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
4028 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4029 gst_message_new_segment_done (GST_OBJECT_CAST (basesink),
4030 basesink->segment.format, basesink->segment.position));
4032 gst_base_sink_event (pad, gst_event_new_eos ());
4034 } else if (result == GST_FLOW_NOT_LINKED || result <= GST_FLOW_EOS) {
4035 /* for fatal errors we post an error message, post the error
4036 * first so the app knows about the error first.
4037 * wrong-state is not a fatal error because it happens due to
4038 * flushing and posting an error message in that case is the
4039 * wrong thing to do, e.g. when basesrc is doing a flushing
4041 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
4042 (_("Internal data stream error.")),
4043 ("stream stopped, reason %s", gst_flow_get_name (result)));
4044 gst_base_sink_event (pad, gst_event_new_eos ());
4050 GST_LOG_OBJECT (basesink, "no buffer, pausing");
4051 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
4052 (_("Internal data flow error.")), ("element returned NULL buffer"));
4053 result = GST_FLOW_ERROR;
4059 gst_base_sink_set_flushing (GstBaseSink * basesink, GstPad * pad,
4062 GstBaseSinkClass *bclass;
4064 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4067 /* unlock any subclasses, we need to do this before grabbing the
4068 * PREROLL_LOCK since we hold this lock before going into ::render. */
4070 bclass->unlock (basesink);
4073 GST_BASE_SINK_PREROLL_LOCK (basesink);
4074 basesink->flushing = flushing;
4076 /* step 1, now that we have the PREROLL lock, clear our unlock request */
4077 if (bclass->unlock_stop)
4078 bclass->unlock_stop (basesink);
4080 /* set need_preroll before we unblock the clock. If the clock is unblocked
4081 * before timing out, we can reuse the buffer for preroll. */
4082 basesink->need_preroll = TRUE;
4084 /* step 2, unblock clock sync (if any) or any other blocking thing */
4085 if (basesink->clock_id) {
4086 gst_clock_id_unschedule (basesink->clock_id);
4089 /* flush out the data thread if it's locked in finish_preroll, this will
4090 * also flush out the EOS state */
4091 GST_DEBUG_OBJECT (basesink,
4092 "flushing out data thread, need preroll to TRUE");
4093 gst_base_sink_preroll_queue_flush (basesink, pad);
4095 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4101 gst_base_sink_default_activate_pull (GstBaseSink * basesink, gboolean active)
4107 result = gst_pad_start_task (basesink->sinkpad,
4108 (GstTaskFunction) gst_base_sink_loop, basesink->sinkpad);
4110 /* step 2, make sure streaming finishes */
4111 result = gst_pad_stop_task (basesink->sinkpad);
4118 gst_base_sink_pad_activate (GstPad * pad)
4120 gboolean result = FALSE;
4121 GstBaseSink *basesink;
4125 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4127 GST_DEBUG_OBJECT (basesink, "Trying pull mode first");
4129 gst_base_sink_set_flushing (basesink, pad, FALSE);
4131 /* we need to have the pull mode enabled */
4132 if (!basesink->can_activate_pull) {
4133 GST_DEBUG_OBJECT (basesink, "pull mode disabled");
4137 /* check if downstreams supports pull mode at all */
4138 query = gst_query_new_scheduling ();
4140 if (!gst_pad_peer_query (pad, query)) {
4141 gst_query_unref (query);
4142 GST_DEBUG_OBJECT (basesink, "peer query faild, no pull mode");
4146 /* parse result of the query */
4147 gst_query_parse_scheduling (query, &pull_mode, NULL, NULL, NULL, NULL, NULL);
4148 gst_query_unref (query);
4151 GST_DEBUG_OBJECT (basesink, "pull mode not supported");
4155 /* set the pad mode before starting the task so that it's in the
4156 * correct state for the new thread. also the sink set_caps and get_caps
4157 * function checks this */
4158 basesink->pad_mode = GST_PAD_ACTIVATE_PULL;
4160 /* we first try to negotiate a format so that when we try to activate
4161 * downstream, it knows about our format */
4162 if (!gst_base_sink_negotiate_pull (basesink)) {
4163 GST_DEBUG_OBJECT (basesink, "failed to negotiate in pull mode");
4167 /* ok activate now */
4168 if (!gst_pad_activate_pull (pad, TRUE)) {
4169 /* clear any pending caps */
4170 GST_OBJECT_LOCK (basesink);
4171 gst_caps_replace (&basesink->priv->pull_caps, NULL);
4172 GST_OBJECT_UNLOCK (basesink);
4173 GST_DEBUG_OBJECT (basesink, "failed to activate in pull mode");
4177 GST_DEBUG_OBJECT (basesink, "Success activating pull mode");
4181 /* push mode fallback */
4183 GST_DEBUG_OBJECT (basesink, "Falling back to push mode");
4184 if ((result = gst_pad_activate_push (pad, TRUE))) {
4185 GST_DEBUG_OBJECT (basesink, "Success activating push mode");
4190 GST_WARNING_OBJECT (basesink, "Could not activate pad in either mode");
4191 gst_base_sink_set_flushing (basesink, pad, TRUE);
4194 gst_object_unref (basesink);
4200 gst_base_sink_pad_activate_push (GstPad * pad, gboolean active)
4203 GstBaseSink *basesink;
4205 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4208 if (!basesink->can_activate_push) {
4210 basesink->pad_mode = GST_PAD_ACTIVATE_NONE;
4213 basesink->pad_mode = GST_PAD_ACTIVATE_PUSH;
4216 if (G_UNLIKELY (basesink->pad_mode != GST_PAD_ACTIVATE_PUSH)) {
4217 g_warning ("Internal GStreamer activation error!!!");
4220 gst_base_sink_set_flushing (basesink, pad, TRUE);
4222 basesink->pad_mode = GST_PAD_ACTIVATE_NONE;
4226 gst_object_unref (basesink);
4232 gst_base_sink_negotiate_pull (GstBaseSink * basesink)
4239 /* this returns the intersection between our caps and the peer caps. If there
4240 * is no peer, it returns NULL and we can't operate in pull mode so we can
4241 * fail the negotiation. */
4242 caps = gst_pad_get_allowed_caps (GST_BASE_SINK_PAD (basesink));
4243 if (caps == NULL || gst_caps_is_empty (caps))
4244 goto no_caps_possible;
4246 GST_DEBUG_OBJECT (basesink, "allowed caps: %" GST_PTR_FORMAT, caps);
4248 if (gst_caps_is_any (caps)) {
4249 GST_DEBUG_OBJECT (basesink, "caps were ANY after fixating, "
4251 /* neither side has template caps in this case, so they are prepared for
4252 pull() without setcaps() */
4255 caps = gst_caps_make_writable (caps);
4257 gst_base_sink_fixate (basesink, caps);
4258 GST_DEBUG_OBJECT (basesink, "fixated to: %" GST_PTR_FORMAT, caps);
4260 if (gst_caps_is_fixed (caps)) {
4261 if (!gst_pad_send_event (GST_BASE_SINK_PAD (basesink),
4262 gst_event_new_caps (caps)))
4263 goto could_not_set_caps;
4265 GST_OBJECT_LOCK (basesink);
4266 gst_caps_replace (&basesink->priv->pull_caps, caps);
4267 GST_OBJECT_UNLOCK (basesink);
4273 gst_caps_unref (caps);
4279 GST_INFO_OBJECT (basesink, "Pipeline could not agree on caps");
4280 GST_DEBUG_OBJECT (basesink, "get_allowed_caps() returned EMPTY");
4282 gst_caps_unref (caps);
4287 GST_INFO_OBJECT (basesink, "Could not set caps: %" GST_PTR_FORMAT, caps);
4288 gst_caps_unref (caps);
4293 /* this won't get called until we implement an activate function */
4295 gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active)
4297 gboolean result = FALSE;
4298 GstBaseSink *basesink;
4299 GstBaseSinkClass *bclass;
4301 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4302 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4307 /* we mark we have a newsegment here because pull based
4308 * mode works just fine without having a newsegment before the
4310 gst_segment_init (&basesink->segment, GST_FORMAT_BYTES);
4311 gst_segment_init (&basesink->clip_segment, GST_FORMAT_BYTES);
4312 GST_OBJECT_LOCK (basesink);
4313 basesink->have_newsegment = TRUE;
4314 GST_OBJECT_UNLOCK (basesink);
4316 /* get the peer duration in bytes */
4317 result = gst_pad_peer_query_duration (pad, GST_FORMAT_BYTES, &duration);
4319 GST_DEBUG_OBJECT (basesink,
4320 "setting duration in bytes to %" G_GINT64_FORMAT, duration);
4321 basesink->clip_segment.duration = duration;
4322 basesink->segment.duration = duration;
4324 GST_DEBUG_OBJECT (basesink, "unknown duration");
4327 if (bclass->activate_pull)
4328 result = bclass->activate_pull (basesink, TRUE);
4333 goto activate_failed;
4336 if (G_UNLIKELY (basesink->pad_mode != GST_PAD_ACTIVATE_PULL)) {
4337 g_warning ("Internal GStreamer activation error!!!");
4340 result = gst_base_sink_set_flushing (basesink, pad, TRUE);
4341 if (bclass->activate_pull)
4342 result &= bclass->activate_pull (basesink, FALSE);
4343 basesink->pad_mode = GST_PAD_ACTIVATE_NONE;
4344 /* clear any pending caps */
4345 GST_OBJECT_LOCK (basesink);
4346 gst_caps_replace (&basesink->priv->pull_caps, NULL);
4347 GST_OBJECT_UNLOCK (basesink);
4350 gst_object_unref (basesink);
4357 /* reset, as starting the thread failed */
4358 basesink->pad_mode = GST_PAD_ACTIVATE_NONE;
4360 GST_ERROR_OBJECT (basesink, "subclass failed to activate in pull mode");
4365 /* send an event to our sinkpad peer. */
4367 gst_base_sink_send_event (GstElement * element, GstEvent * event)
4370 GstBaseSink *basesink = GST_BASE_SINK (element);
4371 gboolean forward, result = TRUE;
4372 GstPadActivateMode mode;
4374 GST_OBJECT_LOCK (element);
4375 /* get the pad and the scheduling mode */
4376 pad = gst_object_ref (basesink->sinkpad);
4377 mode = basesink->pad_mode;
4378 GST_OBJECT_UNLOCK (element);
4380 /* only push UPSTREAM events upstream */
4381 forward = GST_EVENT_IS_UPSTREAM (event);
4383 GST_DEBUG_OBJECT (basesink, "handling event %p %" GST_PTR_FORMAT, event,
4386 switch (GST_EVENT_TYPE (event)) {
4387 case GST_EVENT_LATENCY:
4389 GstClockTime latency;
4391 gst_event_parse_latency (event, &latency);
4393 /* store the latency. We use this to adjust the running_time before syncing
4394 * it to the clock. */
4395 GST_OBJECT_LOCK (element);
4396 basesink->priv->latency = latency;
4397 if (!basesink->priv->have_latency)
4399 GST_OBJECT_UNLOCK (element);
4400 GST_DEBUG_OBJECT (basesink, "latency set to %" GST_TIME_FORMAT,
4401 GST_TIME_ARGS (latency));
4403 /* We forward this event so that all elements know about the global pipeline
4404 * latency. This is interesting for an element when it wants to figure out
4405 * when a particular piece of data will be rendered. */
4408 case GST_EVENT_SEEK:
4409 /* in pull mode we will execute the seek */
4410 if (mode == GST_PAD_ACTIVATE_PULL)
4411 result = gst_base_sink_perform_seek (basesink, pad, event);
4413 case GST_EVENT_STEP:
4414 result = gst_base_sink_perform_step (basesink, pad, event);
4422 result = gst_pad_push_event (pad, event);
4424 /* not forwarded, unref the event */
4425 gst_event_unref (event);
4428 gst_object_unref (pad);
4430 GST_DEBUG_OBJECT (basesink, "handled event %p %" GST_PTR_FORMAT ": %d", event,
4437 gst_base_sink_get_position (GstBaseSink * basesink, GstFormat format,
4438 gint64 * cur, gboolean * upstream)
4440 GstClock *clock = NULL;
4441 gboolean res = FALSE;
4443 GstSegment *segment;
4444 GstClockTime now, latency;
4445 GstClockTimeDiff base_time;
4446 gint64 time, base, duration;
4449 gboolean last_seen, with_clock, in_paused;
4451 GST_OBJECT_LOCK (basesink);
4452 /* we can only get the segment when we are not NULL or READY */
4453 if (!basesink->have_newsegment)
4457 /* when not in PLAYING or when we're busy with a state change, we
4458 * cannot read from the clock so we report time based on the
4459 * last seen timestamp. */
4460 if (GST_STATE (basesink) != GST_STATE_PLAYING ||
4461 GST_STATE_PENDING (basesink) != GST_STATE_VOID_PENDING) {
4465 /* we don't use the clip segment in pull mode, when seeking we update the
4466 * main segment directly with the new segment values without it having to be
4467 * activated by the rendering after preroll */
4468 if (basesink->pad_mode == GST_PAD_ACTIVATE_PUSH)
4469 segment = &basesink->clip_segment;
4471 segment = &basesink->segment;
4473 /* get the format in the segment */
4474 oformat = segment->format;
4476 /* report with last seen position when EOS */
4477 last_seen = basesink->eos;
4479 /* assume we will use the clock for getting the current position */
4481 if (basesink->sync == FALSE)
4484 /* and we need a clock */
4485 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (basesink)) == NULL))
4488 gst_object_ref (clock);
4490 /* mainloop might be querying position when going to playing async,
4491 * while (audio) rendering might be quickly advancing stream position,
4492 * so use clock asap rather than last reported position */
4493 if (in_paused && with_clock && g_atomic_int_get (&basesink->priv->to_playing)) {
4494 GST_DEBUG_OBJECT (basesink, "going to PLAYING, so not PAUSED");
4498 /* collect all data we need holding the lock */
4499 if (GST_CLOCK_TIME_IS_VALID (segment->time))
4500 time = segment->time;
4504 if (GST_CLOCK_TIME_IS_VALID (segment->stop))
4505 duration = segment->stop - segment->start;
4509 base = segment->base;
4510 rate = segment->rate * segment->applied_rate;
4511 latency = basesink->priv->latency;
4513 if (oformat == GST_FORMAT_TIME) {
4516 start = basesink->priv->current_sstart;
4517 stop = basesink->priv->current_sstop;
4520 /* in paused we use the last position as a lower bound */
4521 if (stop == -1 || segment->rate > 0.0)
4526 /* in playing, use last stop time as upper bound */
4527 if (start == -1 || segment->rate > 0.0)
4533 /* convert last stop to stream time */
4534 last = gst_segment_to_stream_time (segment, oformat, segment->position);
4538 /* in paused, use start_time */
4539 base_time = GST_ELEMENT_START_TIME (basesink);
4540 GST_DEBUG_OBJECT (basesink, "in paused, using start time %" GST_TIME_FORMAT,
4541 GST_TIME_ARGS (base_time));
4542 } else if (with_clock) {
4543 /* else use clock when needed */
4544 base_time = GST_ELEMENT_CAST (basesink)->base_time;
4545 GST_DEBUG_OBJECT (basesink, "using clock and base time %" GST_TIME_FORMAT,
4546 GST_TIME_ARGS (base_time));
4548 /* else, no sync or clock -> no base time */
4549 GST_DEBUG_OBJECT (basesink, "no sync or no clock");
4553 /* no base_time, we can't calculate running_time, use last seem timestamp to report
4555 if (base_time == -1)
4558 /* need to release the object lock before we can get the time,
4559 * a clock might take the LOCK of the provider, which could be
4560 * a basesink subclass. */
4561 GST_OBJECT_UNLOCK (basesink);
4564 /* in EOS or when no valid stream_time, report the value of last seen
4567 /* no timestamp, we need to ask upstream */
4568 GST_DEBUG_OBJECT (basesink, "no last seen timestamp, asking upstream");
4573 GST_DEBUG_OBJECT (basesink, "using last seen timestamp %" GST_TIME_FORMAT,
4574 GST_TIME_ARGS (last));
4577 if (oformat != GST_FORMAT_TIME) {
4578 /* convert base, time and duration to time */
4579 if (!gst_pad_query_convert (basesink->sinkpad, oformat, base,
4580 GST_FORMAT_TIME, &base))
4581 goto convert_failed;
4582 if (!gst_pad_query_convert (basesink->sinkpad, oformat, duration,
4583 GST_FORMAT_TIME, &duration))
4584 goto convert_failed;
4585 if (!gst_pad_query_convert (basesink->sinkpad, oformat, time,
4586 GST_FORMAT_TIME, &time))
4587 goto convert_failed;
4588 if (!gst_pad_query_convert (basesink->sinkpad, oformat, last,
4589 GST_FORMAT_TIME, &last))
4590 goto convert_failed;
4592 /* assume time format from now on */
4593 oformat = GST_FORMAT_TIME;
4596 if (!in_paused && with_clock) {
4597 now = gst_clock_get_time (clock);
4603 /* subtract base time and base time from the clock time.
4604 * Make sure we don't go negative. This is the current time in
4605 * the segment which we need to scale with the combined
4606 * rate and applied rate. */
4608 base_time += latency;
4609 if (GST_CLOCK_DIFF (base_time, now) < 0)
4612 /* for negative rates we need to count back from the segment
4617 *cur = time + gst_guint64_to_gdouble (now - base_time) * rate;
4620 /* never report less than segment values in paused */
4622 *cur = MAX (last, *cur);
4624 /* never report more than last seen position in playing */
4626 *cur = MIN (last, *cur);
4629 GST_DEBUG_OBJECT (basesink,
4630 "now %" GST_TIME_FORMAT " - base_time %" GST_TIME_FORMAT " - base %"
4631 GST_TIME_FORMAT " + time %" GST_TIME_FORMAT " last %" GST_TIME_FORMAT,
4632 GST_TIME_ARGS (now), GST_TIME_ARGS (base_time), GST_TIME_ARGS (base),
4633 GST_TIME_ARGS (time), GST_TIME_ARGS (last));
4636 if (oformat != format) {
4637 /* convert to final format */
4638 if (!gst_pad_query_convert (basesink->sinkpad, oformat, *cur, format, cur))
4639 goto convert_failed;
4645 GST_DEBUG_OBJECT (basesink, "res: %d, POSITION: %" GST_TIME_FORMAT,
4646 res, GST_TIME_ARGS (*cur));
4649 gst_object_unref (clock);
4656 /* in NULL or READY we always return FALSE and -1 */
4657 GST_DEBUG_OBJECT (basesink, "position in wrong state, return -1");
4660 GST_OBJECT_UNLOCK (basesink);
4665 GST_DEBUG_OBJECT (basesink, "convert failed, try upstream");
4673 gst_base_sink_get_duration (GstBaseSink * basesink, GstFormat format,
4674 gint64 * dur, gboolean * upstream)
4676 gboolean res = FALSE;
4678 if (basesink->pad_mode == GST_PAD_ACTIVATE_PULL) {
4681 /* get the duration in bytes, in pull mode that's all we are sure to
4682 * know. We have to explicitly get this value from upstream instead of
4683 * using our cached value because it might change. Duration caching
4684 * should be done at a higher level. */
4686 gst_pad_peer_query_duration (basesink->sinkpad, GST_FORMAT_BYTES,
4689 basesink->segment.duration = uduration;
4690 if (format != GST_FORMAT_BYTES) {
4691 /* convert to the requested format */
4693 gst_pad_query_convert (basesink->sinkpad, GST_FORMAT_BYTES,
4694 uduration, format, dur);
4708 default_element_query (GstElement * element, GstQuery * query)
4710 gboolean res = FALSE;
4712 GstBaseSink *basesink = GST_BASE_SINK (element);
4714 switch (GST_QUERY_TYPE (query)) {
4715 case GST_QUERY_POSITION:
4719 gboolean upstream = FALSE;
4721 gst_query_parse_position (query, &format, NULL);
4723 GST_DEBUG_OBJECT (basesink, "position query in format %s",
4724 gst_format_get_name (format));
4726 /* first try to get the position based on the clock */
4728 gst_base_sink_get_position (basesink, format, &cur, &upstream))) {
4729 gst_query_set_position (query, format, cur);
4730 } else if (upstream) {
4731 /* fallback to peer query */
4732 res = gst_pad_peer_query (basesink->sinkpad, query);
4735 /* we can handle a few things if upstream failed */
4736 if (format == GST_FORMAT_PERCENT) {
4739 res = gst_base_sink_get_position (basesink, GST_FORMAT_TIME, &cur,
4741 if (!res && upstream) {
4743 gst_pad_peer_query_position (basesink->sinkpad, GST_FORMAT_TIME,
4747 res = gst_base_sink_get_duration (basesink, GST_FORMAT_TIME, &dur,
4749 if (!res && upstream) {
4751 gst_pad_peer_query_duration (basesink->sinkpad,
4752 GST_FORMAT_TIME, &dur);
4758 pos = gst_util_uint64_scale (100 * GST_FORMAT_PERCENT_SCALE, cur,
4760 gst_query_set_position (query, GST_FORMAT_PERCENT, pos);
4766 case GST_QUERY_DURATION:
4770 gboolean upstream = FALSE;
4772 gst_query_parse_duration (query, &format, NULL);
4774 GST_DEBUG_OBJECT (basesink, "duration query in format %s",
4775 gst_format_get_name (format));
4778 gst_base_sink_get_duration (basesink, format, &dur, &upstream))) {
4779 gst_query_set_duration (query, format, dur);
4780 } else if (upstream) {
4781 /* fallback to peer query */
4782 res = gst_pad_peer_query (basesink->sinkpad, query);
4785 /* we can handle a few things if upstream failed */
4786 if (format == GST_FORMAT_PERCENT) {
4787 gst_query_set_duration (query, GST_FORMAT_PERCENT,
4788 GST_FORMAT_PERCENT_MAX);
4794 case GST_QUERY_LATENCY:
4796 gboolean live, us_live;
4797 GstClockTime min, max;
4799 if ((res = gst_base_sink_query_latency (basesink, &live, &us_live, &min,
4801 gst_query_set_latency (query, live, min, max);
4805 case GST_QUERY_JITTER:
4807 case GST_QUERY_RATE:
4808 /* gst_query_set_rate (query, basesink->segment_rate); */
4811 case GST_QUERY_SEGMENT:
4813 if (basesink->pad_mode == GST_PAD_ACTIVATE_PULL) {
4814 gst_query_set_segment (query, basesink->segment.rate,
4815 GST_FORMAT_TIME, basesink->segment.start, basesink->segment.stop);
4818 res = gst_pad_peer_query (basesink->sinkpad, query);
4822 case GST_QUERY_SEEKING:
4823 case GST_QUERY_CONVERT:
4824 case GST_QUERY_FORMATS:
4826 res = gst_pad_peer_query (basesink->sinkpad, query);
4829 GST_DEBUG_OBJECT (basesink, "query %s returns %d",
4830 GST_QUERY_TYPE_NAME (query), res);
4836 default_sink_query (GstBaseSink * basesink, GstQuery * query)
4839 GstBaseSinkClass *bclass;
4841 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4843 switch (GST_QUERY_TYPE (query)) {
4844 case GST_QUERY_ALLOCATION:
4846 if (bclass->propose_allocation)
4847 res = bclass->propose_allocation (basesink, query);
4852 case GST_QUERY_CAPS:
4854 GstCaps *caps, *filter;
4856 gst_query_parse_caps (query, &filter);
4857 caps = gst_base_sink_query_caps (basesink, basesink->sinkpad, filter);
4858 gst_query_set_caps_result (query, caps);
4859 gst_caps_unref (caps);
4865 gst_pad_query_default (basesink->sinkpad, GST_OBJECT_CAST (basesink),
4873 gst_base_sink_sink_query (GstPad * pad, GstObject * parent, GstQuery * query)
4875 GstBaseSink *basesink;
4876 GstBaseSinkClass *bclass;
4879 basesink = GST_BASE_SINK_CAST (parent);
4880 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4883 res = bclass->query (basesink, query);
4890 static GstStateChangeReturn
4891 gst_base_sink_change_state (GstElement * element, GstStateChange transition)
4893 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
4894 GstBaseSink *basesink = GST_BASE_SINK (element);
4895 GstBaseSinkClass *bclass;
4896 GstBaseSinkPrivate *priv;
4898 priv = basesink->priv;
4900 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4902 switch (transition) {
4903 case GST_STATE_CHANGE_NULL_TO_READY:
4905 if (!bclass->start (basesink))
4908 case GST_STATE_CHANGE_READY_TO_PAUSED:
4909 /* need to complete preroll before this state change completes, there
4910 * is no data flow in READY so we can safely assume we need to preroll. */
4911 GST_BASE_SINK_PREROLL_LOCK (basesink);
4912 GST_DEBUG_OBJECT (basesink, "READY to PAUSED");
4913 basesink->have_newsegment = FALSE;
4914 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
4915 gst_segment_init (&basesink->clip_segment, GST_FORMAT_UNDEFINED);
4916 basesink->offset = 0;
4917 basesink->have_preroll = FALSE;
4918 priv->step_unlock = FALSE;
4919 basesink->need_preroll = TRUE;
4920 basesink->playing_async = TRUE;
4921 basesink->priv->reset_time = FALSE;
4922 priv->current_sstart = GST_CLOCK_TIME_NONE;
4923 priv->current_sstop = GST_CLOCK_TIME_NONE;
4924 priv->eos_rtime = GST_CLOCK_TIME_NONE;
4926 basesink->eos = FALSE;
4927 priv->received_eos = FALSE;
4928 gst_base_sink_reset_qos (basesink);
4929 priv->commited = FALSE;
4930 priv->call_preroll = TRUE;
4931 priv->current_step.valid = FALSE;
4932 priv->pending_step.valid = FALSE;
4933 if (priv->async_enabled) {
4934 GST_DEBUG_OBJECT (basesink, "doing async state change");
4935 /* when async enabled, post async-start message and return ASYNC from
4936 * the state change function */
4937 ret = GST_STATE_CHANGE_ASYNC;
4938 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4939 gst_message_new_async_start (GST_OBJECT_CAST (basesink)));
4941 priv->have_latency = TRUE;
4943 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4945 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
4946 GST_BASE_SINK_PREROLL_LOCK (basesink);
4947 g_atomic_int_set (&basesink->priv->to_playing, TRUE);
4948 if (!gst_base_sink_needs_preroll (basesink)) {
4949 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, don't need preroll");
4950 /* no preroll needed anymore now. */
4951 basesink->playing_async = FALSE;
4952 basesink->need_preroll = FALSE;
4953 if (basesink->eos) {
4954 GstMessage *message;
4956 /* need to post EOS message here */
4957 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
4958 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
4959 gst_message_set_seqnum (message, basesink->priv->seqnum);
4960 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
4962 GST_DEBUG_OBJECT (basesink, "signal preroll");
4963 GST_BASE_SINK_PREROLL_SIGNAL (basesink);
4966 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, we are not prerolled");
4967 basesink->need_preroll = TRUE;
4968 basesink->playing_async = TRUE;
4969 priv->call_preroll = TRUE;
4970 priv->commited = FALSE;
4971 if (priv->async_enabled) {
4972 GST_DEBUG_OBJECT (basesink, "doing async state change");
4973 ret = GST_STATE_CHANGE_ASYNC;
4974 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4975 gst_message_new_async_start (GST_OBJECT_CAST (basesink)));
4978 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4985 GstStateChangeReturn bret;
4987 bret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
4988 if (G_UNLIKELY (bret == GST_STATE_CHANGE_FAILURE))
4989 goto activate_failed;
4992 switch (transition) {
4993 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
4994 /* completed transition, so need not be marked any longer
4995 * And it should be unmarked, since e.g. losing our position upon flush
4996 * does not really change state to PAUSED ... */
4997 g_atomic_int_set (&basesink->priv->to_playing, FALSE);
4999 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
5000 g_atomic_int_set (&basesink->priv->to_playing, FALSE);
5001 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED");
5002 /* FIXME, make sure we cannot enter _render first */
5004 /* we need to call ::unlock before locking PREROLL_LOCK
5005 * since we lock it before going into ::render */
5007 bclass->unlock (basesink);
5009 GST_BASE_SINK_PREROLL_LOCK (basesink);
5010 GST_DEBUG_OBJECT (basesink, "got preroll lock");
5011 /* now that we have the PREROLL lock, clear our unlock request */
5012 if (bclass->unlock_stop)
5013 bclass->unlock_stop (basesink);
5015 /* we need preroll again and we set the flag before unlocking the clockid
5016 * because if the clockid is unlocked before a current buffer expired, we
5017 * can use that buffer to preroll with */
5018 basesink->need_preroll = TRUE;
5020 if (basesink->clock_id) {
5021 GST_DEBUG_OBJECT (basesink, "unschedule clock");
5022 gst_clock_id_unschedule (basesink->clock_id);
5025 /* if we don't have a preroll buffer we need to wait for a preroll and
5027 if (!gst_base_sink_needs_preroll (basesink)) {
5028 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED, we are prerolled");
5029 basesink->playing_async = FALSE;
5031 if (GST_STATE_TARGET (GST_ELEMENT (basesink)) <= GST_STATE_READY) {
5032 GST_DEBUG_OBJECT (basesink, "element is <= READY");
5033 ret = GST_STATE_CHANGE_SUCCESS;
5035 GST_DEBUG_OBJECT (basesink,
5036 "PLAYING to PAUSED, we are not prerolled");
5037 basesink->playing_async = TRUE;
5038 priv->commited = FALSE;
5039 priv->call_preroll = TRUE;
5040 if (priv->async_enabled) {
5041 GST_DEBUG_OBJECT (basesink, "doing async state change");
5042 ret = GST_STATE_CHANGE_ASYNC;
5043 gst_element_post_message (GST_ELEMENT_CAST (basesink),
5044 gst_message_new_async_start (GST_OBJECT_CAST (basesink)));
5048 GST_DEBUG_OBJECT (basesink, "rendered: %" G_GUINT64_FORMAT
5049 ", dropped: %" G_GUINT64_FORMAT, priv->rendered, priv->dropped);
5051 gst_base_sink_reset_qos (basesink);
5052 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
5054 case GST_STATE_CHANGE_PAUSED_TO_READY:
5055 GST_BASE_SINK_PREROLL_LOCK (basesink);
5056 /* start by resetting our position state with the object lock so that the
5057 * position query gets the right idea. We do this before we post the
5058 * messages so that the message handlers pick this up. */
5059 GST_OBJECT_LOCK (basesink);
5060 basesink->have_newsegment = FALSE;
5061 priv->current_sstart = GST_CLOCK_TIME_NONE;
5062 priv->current_sstop = GST_CLOCK_TIME_NONE;
5063 priv->have_latency = FALSE;
5064 if (priv->cached_clock_id) {
5065 gst_clock_id_unref (priv->cached_clock_id);
5066 priv->cached_clock_id = NULL;
5068 GST_OBJECT_UNLOCK (basesink);
5070 gst_base_sink_set_last_buffer (basesink, NULL);
5071 priv->call_preroll = FALSE;
5073 if (!priv->commited) {
5074 if (priv->async_enabled) {
5075 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, posting async-done");
5077 gst_element_post_message (GST_ELEMENT_CAST (basesink),
5078 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
5079 GST_STATE_PLAYING, GST_STATE_PAUSED, GST_STATE_READY));
5081 gst_element_post_message (GST_ELEMENT_CAST (basesink),
5082 gst_message_new_async_done (GST_OBJECT_CAST (basesink), FALSE));
5084 priv->commited = TRUE;
5086 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, don't need_preroll");
5088 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
5090 case GST_STATE_CHANGE_READY_TO_NULL:
5092 if (!bclass->stop (basesink)) {
5093 GST_WARNING_OBJECT (basesink, "failed to stop");
5096 gst_base_sink_set_last_buffer (basesink, NULL);
5097 priv->call_preroll = FALSE;
5108 GST_DEBUG_OBJECT (basesink, "failed to start");
5109 return GST_STATE_CHANGE_FAILURE;
5113 GST_DEBUG_OBJECT (basesink,
5114 "element failed to change states -- activation problem?");
5115 return GST_STATE_CHANGE_FAILURE;