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 struct _GstBaseSinkPrivate
179 gint qos_enabled; /* ATOMIC */
180 gboolean async_enabled;
181 GstClockTimeDiff ts_offset;
182 GstClockTime render_delay;
184 /* start, stop of current buffer, stream time, used to report position */
185 GstClockTime current_sstart;
186 GstClockTime current_sstop;
188 /* start, stop and jitter of current buffer, running time */
189 GstClockTime current_rstart;
190 GstClockTime current_rstop;
191 GstClockTimeDiff current_jitter;
192 /* the running time of the previous buffer */
193 GstClockTime prev_rstart;
195 /* EOS sync time in running time */
196 GstClockTime eos_rtime;
198 /* last buffer that arrived in time, running time */
199 GstClockTime last_render_time;
200 /* when the last buffer left the sink, running time */
201 GstClockTime last_left;
203 /* running averages go here these are done on running time */
205 GstClockTime avg_duration;
207 GstClockTime avg_in_diff;
209 /* these are done on system time. avg_jitter and avg_render are
210 * compared to eachother to see if the rendering time takes a
211 * huge amount of the processing, If so we are flooded with
213 GstClockTime last_left_systime;
214 GstClockTime avg_jitter;
215 GstClockTime start, stop;
216 GstClockTime avg_render;
218 /* number of rendered and dropped frames */
223 GstClockTime latency;
225 /* if we already commited the state */
227 /* state change to playing ongoing */
230 /* when we received EOS */
231 gboolean received_eos;
233 /* when we are prerolled and able to report latency */
234 gboolean have_latency;
236 /* the last buffer we prerolled or rendered. Useful for making snapshots */
237 gint enable_last_sample; /* atomic */
238 GstBuffer *last_buffer;
241 /* negotiated caps */
244 /* blocksize for pulling */
249 /* seqnum of the stream */
252 gboolean call_preroll;
253 gboolean step_unlock;
255 /* we have a pending and a current step operation */
256 GstStepInfo current_step;
257 GstStepInfo pending_step;
259 /* Cached GstClockID */
260 GstClockID cached_clock_id;
262 /* for throttling and QoS */
263 GstClockTime earliest_in_time;
264 GstClockTime throttle_time;
269 #define DO_RUNNING_AVG(avg,val,size) (((val) + ((size)-1) * (avg)) / (size))
271 /* generic running average, this has a neutral window size */
272 #define UPDATE_RUNNING_AVG(avg,val) DO_RUNNING_AVG(avg,val,8)
274 /* the windows for these running averages are experimentally obtained.
275 * possitive values get averaged more while negative values use a small
276 * window so we can react faster to badness. */
277 #define UPDATE_RUNNING_AVG_P(avg,val) DO_RUNNING_AVG(avg,val,16)
278 #define UPDATE_RUNNING_AVG_N(avg,val) DO_RUNNING_AVG(avg,val,4)
282 _PR_IS_NOTHING = 1 << 0,
283 _PR_IS_BUFFER = 1 << 1,
284 _PR_IS_BUFFERLIST = 1 << 2,
285 _PR_IS_EVENT = 1 << 3
288 #define OBJ_IS_BUFFER(a) ((a) & _PR_IS_BUFFER)
289 #define OBJ_IS_BUFFERLIST(a) ((a) & _PR_IS_BUFFERLIST)
290 #define OBJ_IS_EVENT(a) ((a) & _PR_IS_EVENT)
291 #define OBJ_IS_BUFFERFULL(a) ((a) & (_PR_IS_BUFFER | _PR_IS_BUFFERLIST))
293 /* BaseSink properties */
295 #define DEFAULT_CAN_ACTIVATE_PULL FALSE /* fixme: enable me */
296 #define DEFAULT_CAN_ACTIVATE_PUSH TRUE
298 #define DEFAULT_SYNC TRUE
299 #define DEFAULT_MAX_LATENESS -1
300 #define DEFAULT_QOS FALSE
301 #define DEFAULT_ASYNC TRUE
302 #define DEFAULT_TS_OFFSET 0
303 #define DEFAULT_BLOCKSIZE 4096
304 #define DEFAULT_RENDER_DELAY 0
305 #define DEFAULT_ENABLE_LAST_SAMPLE TRUE
306 #define DEFAULT_THROTTLE_TIME 0
316 PROP_ENABLE_LAST_SAMPLE,
324 static GstElementClass *parent_class = NULL;
326 static void gst_base_sink_class_init (GstBaseSinkClass * klass);
327 static void gst_base_sink_init (GstBaseSink * trans, gpointer g_class);
328 static void gst_base_sink_finalize (GObject * object);
331 gst_base_sink_get_type (void)
333 static volatile gsize base_sink_type = 0;
335 if (g_once_init_enter (&base_sink_type)) {
337 static const GTypeInfo base_sink_info = {
338 sizeof (GstBaseSinkClass),
341 (GClassInitFunc) gst_base_sink_class_init,
344 sizeof (GstBaseSink),
346 (GInstanceInitFunc) gst_base_sink_init,
349 _type = g_type_register_static (GST_TYPE_ELEMENT,
350 "GstBaseSink", &base_sink_info, G_TYPE_FLAG_ABSTRACT);
351 g_once_init_leave (&base_sink_type, _type);
353 return base_sink_type;
356 static void gst_base_sink_set_property (GObject * object, guint prop_id,
357 const GValue * value, GParamSpec * pspec);
358 static void gst_base_sink_get_property (GObject * object, guint prop_id,
359 GValue * value, GParamSpec * pspec);
361 static gboolean gst_base_sink_send_event (GstElement * element,
363 static gboolean default_element_query (GstElement * element, GstQuery * query);
365 static GstCaps *gst_base_sink_get_caps (GstBaseSink * sink, GstCaps * caps);
366 static gboolean gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps);
367 static void gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
368 GstClockTime * start, GstClockTime * end);
369 static gboolean gst_base_sink_set_flushing (GstBaseSink * basesink,
370 GstPad * pad, gboolean flushing);
371 static gboolean gst_base_sink_default_activate_pull (GstBaseSink * basesink,
373 static gboolean gst_base_sink_default_do_seek (GstBaseSink * sink,
374 GstSegment * segment);
375 static gboolean gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
376 GstEvent * event, GstSegment * segment);
378 static GstStateChangeReturn gst_base_sink_change_state (GstElement * element,
379 GstStateChange transition);
381 static gboolean gst_base_sink_sink_query (GstPad * pad, GstObject * parent,
383 static GstFlowReturn gst_base_sink_chain (GstPad * pad, GstObject * parent,
385 static GstFlowReturn gst_base_sink_chain_list (GstPad * pad, GstObject * parent,
386 GstBufferList * list);
388 static void gst_base_sink_loop (GstPad * pad);
389 static gboolean gst_base_sink_pad_activate (GstPad * pad, GstObject * parent);
390 static gboolean gst_base_sink_pad_activate_mode (GstPad * pad,
391 GstObject * parent, GstPadMode mode, gboolean active);
392 static gboolean gst_base_sink_event (GstPad * pad, GstObject * parent,
395 static gboolean default_sink_query (GstBaseSink * sink, GstQuery * query);
397 static gboolean gst_base_sink_negotiate_pull (GstBaseSink * basesink);
398 static void gst_base_sink_default_fixate (GstBaseSink * bsink, GstCaps * caps);
399 static void gst_base_sink_fixate (GstBaseSink * bsink, GstCaps * caps);
401 /* check if an object was too late */
402 static gboolean gst_base_sink_is_too_late (GstBaseSink * basesink,
403 GstMiniObject * obj, GstClockTime rstart, GstClockTime rstop,
404 GstClockReturn status, GstClockTimeDiff jitter);
405 static GstFlowReturn gst_base_sink_preroll_object (GstBaseSink * basesink,
406 guint8 obj_type, GstMiniObject * obj);
409 gst_base_sink_class_init (GstBaseSinkClass * klass)
411 GObjectClass *gobject_class;
412 GstElementClass *gstelement_class;
414 gobject_class = G_OBJECT_CLASS (klass);
415 gstelement_class = GST_ELEMENT_CLASS (klass);
417 GST_DEBUG_CATEGORY_INIT (gst_base_sink_debug, "basesink", 0,
420 g_type_class_add_private (klass, sizeof (GstBaseSinkPrivate));
422 parent_class = g_type_class_peek_parent (klass);
424 gobject_class->finalize = gst_base_sink_finalize;
425 gobject_class->set_property = gst_base_sink_set_property;
426 gobject_class->get_property = gst_base_sink_get_property;
428 g_object_class_install_property (gobject_class, PROP_SYNC,
429 g_param_spec_boolean ("sync", "Sync", "Sync on the clock", DEFAULT_SYNC,
430 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
432 g_object_class_install_property (gobject_class, PROP_MAX_LATENESS,
433 g_param_spec_int64 ("max-lateness", "Max Lateness",
434 "Maximum number of nanoseconds that a buffer can be late before it "
435 "is dropped (-1 unlimited)", -1, G_MAXINT64, DEFAULT_MAX_LATENESS,
436 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
438 g_object_class_install_property (gobject_class, PROP_QOS,
439 g_param_spec_boolean ("qos", "Qos",
440 "Generate Quality-of-Service events upstream", DEFAULT_QOS,
441 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
445 * If set to #TRUE, the basesink will perform asynchronous state changes.
446 * When set to #FALSE, the sink will not signal the parent when it prerolls.
447 * Use this option when dealing with sparse streams or when synchronisation is
452 g_object_class_install_property (gobject_class, PROP_ASYNC,
453 g_param_spec_boolean ("async", "Async",
454 "Go asynchronously to PAUSED", DEFAULT_ASYNC,
455 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
457 * GstBaseSink:ts-offset
459 * Controls the final synchronisation, a negative value will render the buffer
460 * earlier while a positive value delays playback. This property can be
461 * used to fix synchronisation in bad files.
465 g_object_class_install_property (gobject_class, PROP_TS_OFFSET,
466 g_param_spec_int64 ("ts-offset", "TS Offset",
467 "Timestamp offset in nanoseconds", G_MININT64, G_MAXINT64,
468 DEFAULT_TS_OFFSET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
471 * GstBaseSink:enable-last-sample
473 * Enable the last-sample property. If FALSE, basesink doesn't keep a
474 * reference to the last buffer arrived and the last-sample property is always
475 * set to NULL. This can be useful if you need buffers to be released as soon
476 * as possible, eg. if you're using a buffer pool.
480 g_object_class_install_property (gobject_class, PROP_ENABLE_LAST_SAMPLE,
481 g_param_spec_boolean ("enable-last-sample", "Enable Last Buffer",
482 "Enable the last-sample property", DEFAULT_ENABLE_LAST_SAMPLE,
483 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
486 * GstBaseSink:last-sample
488 * The last buffer that arrived in the sink and was used for preroll or for
489 * rendering. This property can be used to generate thumbnails. This property
490 * can be NULL when the sink has not yet received a bufer.
494 g_object_class_install_property (gobject_class, PROP_LAST_SAMPLE,
495 g_param_spec_boxed ("last-sample", "Last Sample",
496 "The last sample received in the sink", GST_TYPE_SAMPLE,
497 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
499 * GstBaseSink:blocksize
501 * The amount of bytes to pull when operating in pull mode.
505 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
506 g_object_class_install_property (gobject_class, PROP_BLOCKSIZE,
507 g_param_spec_uint ("blocksize", "Block size",
508 "Size in bytes to pull per buffer (0 = default)", 0, G_MAXUINT,
509 DEFAULT_BLOCKSIZE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
511 * GstBaseSink:render-delay
513 * The additional delay between synchronisation and actual rendering of the
514 * media. This property will add additional latency to the device in order to
515 * make other sinks compensate for the delay.
519 g_object_class_install_property (gobject_class, PROP_RENDER_DELAY,
520 g_param_spec_uint64 ("render-delay", "Render Delay",
521 "Additional render delay of the sink in nanoseconds", 0, G_MAXUINT64,
522 DEFAULT_RENDER_DELAY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
524 * GstBaseSink:throttle-time
526 * The time to insert between buffers. This property can be used to control
527 * the maximum amount of buffers per second to render. Setting this property
528 * to a value bigger than 0 will make the sink create THROTTLE QoS events.
532 g_object_class_install_property (gobject_class, PROP_THROTTLE_TIME,
533 g_param_spec_uint64 ("throttle-time", "Throttle time",
534 "The time to keep between rendered buffers (unused)", 0, G_MAXUINT64,
535 DEFAULT_THROTTLE_TIME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
537 gstelement_class->change_state =
538 GST_DEBUG_FUNCPTR (gst_base_sink_change_state);
539 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_base_sink_send_event);
540 gstelement_class->query = GST_DEBUG_FUNCPTR (default_element_query);
542 klass->get_caps = GST_DEBUG_FUNCPTR (gst_base_sink_get_caps);
543 klass->set_caps = GST_DEBUG_FUNCPTR (gst_base_sink_set_caps);
544 klass->fixate = GST_DEBUG_FUNCPTR (gst_base_sink_default_fixate);
545 klass->activate_pull =
546 GST_DEBUG_FUNCPTR (gst_base_sink_default_activate_pull);
547 klass->get_times = GST_DEBUG_FUNCPTR (gst_base_sink_get_times);
548 klass->query = GST_DEBUG_FUNCPTR (default_sink_query);
550 /* Registering debug symbols for function pointers */
551 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_fixate);
552 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate);
553 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate_mode);
554 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_event);
555 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain);
556 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain_list);
557 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_sink_query);
561 gst_base_sink_query_caps (GstBaseSink * bsink, GstPad * pad, GstCaps * filter)
563 GstBaseSinkClass *bclass;
564 GstCaps *caps = NULL;
567 bclass = GST_BASE_SINK_GET_CLASS (bsink);
568 fixed = GST_PAD_IS_FIXED_CAPS (pad);
570 if (fixed || bsink->pad_mode == GST_PAD_MODE_PULL) {
571 /* if we are operating in pull mode or fixed caps, we only accept the
572 * currently negotiated caps */
573 caps = gst_pad_get_current_caps (pad);
576 if (bclass->get_caps)
577 caps = bclass->get_caps (bsink, filter);
580 GstPadTemplate *pad_template;
583 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass),
585 if (pad_template != NULL) {
586 caps = gst_pad_template_get_caps (pad_template);
589 GstCaps *intersection;
592 gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
593 gst_caps_unref (caps);
604 gst_base_sink_default_fixate (GstBaseSink * bsink, GstCaps * caps)
606 GST_DEBUG_OBJECT (bsink, "using default caps fixate function");
607 gst_caps_fixate (caps);
611 gst_base_sink_fixate (GstBaseSink * bsink, GstCaps * caps)
613 GstBaseSinkClass *bclass;
615 bclass = GST_BASE_SINK_GET_CLASS (bsink);
618 bclass->fixate (bsink, caps);
622 gst_base_sink_init (GstBaseSink * basesink, gpointer g_class)
624 GstPadTemplate *pad_template;
625 GstBaseSinkPrivate *priv;
627 basesink->priv = priv = GST_BASE_SINK_GET_PRIVATE (basesink);
630 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "sink");
631 g_return_if_fail (pad_template != NULL);
633 basesink->sinkpad = gst_pad_new_from_template (pad_template, "sink");
635 gst_pad_set_activate_function (basesink->sinkpad, gst_base_sink_pad_activate);
636 gst_pad_set_activatemode_function (basesink->sinkpad,
637 gst_base_sink_pad_activate_mode);
638 gst_pad_set_query_function (basesink->sinkpad, gst_base_sink_sink_query);
639 gst_pad_set_event_function (basesink->sinkpad, gst_base_sink_event);
640 gst_pad_set_chain_function (basesink->sinkpad, gst_base_sink_chain);
641 gst_pad_set_chain_list_function (basesink->sinkpad, gst_base_sink_chain_list);
642 gst_element_add_pad (GST_ELEMENT_CAST (basesink), basesink->sinkpad);
644 basesink->pad_mode = GST_PAD_MODE_NONE;
645 basesink->preroll_lock = g_mutex_new ();
646 basesink->preroll_cond = g_cond_new ();
647 priv->have_latency = FALSE;
649 basesink->can_activate_push = DEFAULT_CAN_ACTIVATE_PUSH;
650 basesink->can_activate_pull = DEFAULT_CAN_ACTIVATE_PULL;
652 basesink->sync = DEFAULT_SYNC;
653 basesink->max_lateness = DEFAULT_MAX_LATENESS;
654 g_atomic_int_set (&priv->qos_enabled, DEFAULT_QOS);
655 priv->async_enabled = DEFAULT_ASYNC;
656 priv->ts_offset = DEFAULT_TS_OFFSET;
657 priv->render_delay = DEFAULT_RENDER_DELAY;
658 priv->blocksize = DEFAULT_BLOCKSIZE;
659 priv->cached_clock_id = NULL;
660 g_atomic_int_set (&priv->enable_last_sample, DEFAULT_ENABLE_LAST_SAMPLE);
661 priv->throttle_time = DEFAULT_THROTTLE_TIME;
663 GST_OBJECT_FLAG_SET (basesink, GST_ELEMENT_FLAG_SINK);
667 gst_base_sink_finalize (GObject * object)
669 GstBaseSink *basesink;
671 basesink = GST_BASE_SINK (object);
673 g_mutex_free (basesink->preroll_lock);
674 g_cond_free (basesink->preroll_cond);
676 G_OBJECT_CLASS (parent_class)->finalize (object);
680 * gst_base_sink_set_sync:
682 * @sync: the new sync value.
684 * Configures @sink to synchronize on the clock or not. When
685 * @sync is FALSE, incoming samples will be played as fast as
686 * possible. If @sync is TRUE, the timestamps of the incomming
687 * buffers will be used to schedule the exact render time of its
693 gst_base_sink_set_sync (GstBaseSink * sink, gboolean sync)
695 g_return_if_fail (GST_IS_BASE_SINK (sink));
697 GST_OBJECT_LOCK (sink);
699 GST_OBJECT_UNLOCK (sink);
703 * gst_base_sink_get_sync:
706 * Checks if @sink is currently configured to synchronize against the
709 * Returns: TRUE if the sink is configured to synchronize against the clock.
714 gst_base_sink_get_sync (GstBaseSink * sink)
718 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
720 GST_OBJECT_LOCK (sink);
722 GST_OBJECT_UNLOCK (sink);
728 * gst_base_sink_set_max_lateness:
730 * @max_lateness: the new max lateness value.
732 * Sets the new max lateness value to @max_lateness. This value is
733 * used to decide if a buffer should be dropped or not based on the
734 * buffer timestamp and the current clock time. A value of -1 means
740 gst_base_sink_set_max_lateness (GstBaseSink * sink, gint64 max_lateness)
742 g_return_if_fail (GST_IS_BASE_SINK (sink));
744 GST_OBJECT_LOCK (sink);
745 sink->max_lateness = max_lateness;
746 GST_OBJECT_UNLOCK (sink);
750 * gst_base_sink_get_max_lateness:
753 * Gets the max lateness value. See gst_base_sink_set_max_lateness for
756 * Returns: The maximum time in nanoseconds that a buffer can be late
757 * before it is dropped and not rendered. A value of -1 means an
763 gst_base_sink_get_max_lateness (GstBaseSink * sink)
767 g_return_val_if_fail (GST_IS_BASE_SINK (sink), -1);
769 GST_OBJECT_LOCK (sink);
770 res = sink->max_lateness;
771 GST_OBJECT_UNLOCK (sink);
777 * gst_base_sink_set_qos_enabled:
779 * @enabled: the new qos value.
781 * Configures @sink to send Quality-of-Service events upstream.
786 gst_base_sink_set_qos_enabled (GstBaseSink * sink, gboolean enabled)
788 g_return_if_fail (GST_IS_BASE_SINK (sink));
790 g_atomic_int_set (&sink->priv->qos_enabled, enabled);
794 * gst_base_sink_is_qos_enabled:
797 * Checks if @sink is currently configured to send Quality-of-Service events
800 * Returns: TRUE if the sink is configured to perform Quality-of-Service.
805 gst_base_sink_is_qos_enabled (GstBaseSink * sink)
809 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
811 res = g_atomic_int_get (&sink->priv->qos_enabled);
817 * gst_base_sink_set_async_enabled:
819 * @enabled: the new async value.
821 * Configures @sink to perform all state changes asynchronusly. When async is
822 * disabled, the sink will immediately go to PAUSED instead of waiting for a
823 * preroll buffer. This feature is useful if the sink does not synchronize
824 * against the clock or when it is dealing with sparse streams.
829 gst_base_sink_set_async_enabled (GstBaseSink * sink, gboolean enabled)
831 g_return_if_fail (GST_IS_BASE_SINK (sink));
833 GST_BASE_SINK_PREROLL_LOCK (sink);
834 g_atomic_int_set (&sink->priv->async_enabled, enabled);
835 GST_LOG_OBJECT (sink, "set async enabled to %d", enabled);
836 GST_BASE_SINK_PREROLL_UNLOCK (sink);
840 * gst_base_sink_is_async_enabled:
843 * Checks if @sink is currently configured to perform asynchronous state
846 * Returns: TRUE if the sink is configured to perform asynchronous state
852 gst_base_sink_is_async_enabled (GstBaseSink * sink)
856 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
858 res = g_atomic_int_get (&sink->priv->async_enabled);
864 * gst_base_sink_set_ts_offset:
866 * @offset: the new offset
868 * Adjust the synchronisation of @sink with @offset. A negative value will
869 * render buffers earlier than their timestamp. A positive value will delay
870 * rendering. This function can be used to fix playback of badly timestamped
876 gst_base_sink_set_ts_offset (GstBaseSink * sink, GstClockTimeDiff offset)
878 g_return_if_fail (GST_IS_BASE_SINK (sink));
880 GST_OBJECT_LOCK (sink);
881 sink->priv->ts_offset = offset;
882 GST_LOG_OBJECT (sink, "set time offset to %" G_GINT64_FORMAT, offset);
883 GST_OBJECT_UNLOCK (sink);
887 * gst_base_sink_get_ts_offset:
890 * Get the synchronisation offset of @sink.
892 * Returns: The synchronisation offset.
897 gst_base_sink_get_ts_offset (GstBaseSink * sink)
899 GstClockTimeDiff res;
901 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
903 GST_OBJECT_LOCK (sink);
904 res = sink->priv->ts_offset;
905 GST_OBJECT_UNLOCK (sink);
911 * gst_base_sink_get_last_sample:
914 * Get the last sample that arrived in the sink and was used for preroll or for
915 * rendering. This property can be used to generate thumbnails.
917 * The #GstCaps on the sample can be used to determine the type of the buffer.
919 * Free-function: gst_sample_unref
921 * Returns: (transfer full): a #GstSample. gst_sample_unref() after usage.
922 * This function returns NULL when no buffer has arrived in the sink yet
923 * or when the sink is not in PAUSED or PLAYING.
928 gst_base_sink_get_last_sample (GstBaseSink * sink)
930 GstSample *res = NULL;
932 g_return_val_if_fail (GST_IS_BASE_SINK (sink), NULL);
934 GST_OBJECT_LOCK (sink);
935 if (sink->priv->last_buffer) {
936 res = gst_sample_new (sink->priv->last_buffer,
937 sink->priv->last_caps, &sink->segment, NULL);
939 GST_OBJECT_UNLOCK (sink);
944 /* with OBJECT_LOCK */
946 gst_base_sink_set_last_buffer_unlocked (GstBaseSink * sink, GstBuffer * buffer)
950 old = sink->priv->last_buffer;
951 if (G_LIKELY (old != buffer)) {
952 GST_DEBUG_OBJECT (sink, "setting last buffer to %p", buffer);
953 if (G_LIKELY (buffer))
954 gst_buffer_ref (buffer);
955 sink->priv->last_buffer = buffer;
957 /* copy over the caps */
958 gst_caps_replace (&sink->priv->last_caps, sink->priv->caps);
960 gst_caps_replace (&sink->priv->last_caps, NULL);
964 /* avoid unreffing with the lock because cleanup code might want to take the
966 if (G_LIKELY (old)) {
967 GST_OBJECT_UNLOCK (sink);
968 gst_buffer_unref (old);
969 GST_OBJECT_LOCK (sink);
974 gst_base_sink_set_last_buffer (GstBaseSink * sink, GstBuffer * buffer)
976 if (!g_atomic_int_get (&sink->priv->enable_last_sample))
979 GST_OBJECT_LOCK (sink);
980 gst_base_sink_set_last_buffer_unlocked (sink, buffer);
981 GST_OBJECT_UNLOCK (sink);
985 * gst_base_sink_set_last_sample_enabled:
987 * @enabled: the new enable-last-sample value.
989 * Configures @sink to store the last received sample in the last-sample
995 gst_base_sink_set_last_sample_enabled (GstBaseSink * sink, gboolean enabled)
997 g_return_if_fail (GST_IS_BASE_SINK (sink));
999 /* Only take lock if we change the value */
1000 if (g_atomic_int_compare_and_exchange (&sink->priv->enable_last_sample,
1001 !enabled, enabled) && !enabled) {
1002 GST_OBJECT_LOCK (sink);
1003 gst_base_sink_set_last_buffer_unlocked (sink, NULL);
1004 GST_OBJECT_UNLOCK (sink);
1009 * gst_base_sink_is_last_sample_enabled:
1012 * Checks if @sink is currently configured to store the last received sample in
1013 * the last-sample property.
1015 * Returns: TRUE if the sink is configured to store the last received sample.
1020 gst_base_sink_is_last_sample_enabled (GstBaseSink * sink)
1022 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
1024 return g_atomic_int_get (&sink->priv->enable_last_sample);
1028 * gst_base_sink_get_latency:
1031 * Get the currently configured latency.
1033 * Returns: The configured latency.
1038 gst_base_sink_get_latency (GstBaseSink * sink)
1042 GST_OBJECT_LOCK (sink);
1043 res = sink->priv->latency;
1044 GST_OBJECT_UNLOCK (sink);
1050 * gst_base_sink_query_latency:
1052 * @live: (out) (allow-none): if the sink is live
1053 * @upstream_live: (out) (allow-none): if an upstream element is live
1054 * @min_latency: (out) (allow-none): the min latency of the upstream elements
1055 * @max_latency: (out) (allow-none): the max latency of the upstream elements
1057 * Query the sink for the latency parameters. The latency will be queried from
1058 * the upstream elements. @live will be TRUE if @sink is configured to
1059 * synchronize against the clock. @upstream_live will be TRUE if an upstream
1062 * If both @live and @upstream_live are TRUE, the sink will want to compensate
1063 * for the latency introduced by the upstream elements by setting the
1064 * @min_latency to a strictly possitive value.
1066 * This function is mostly used by subclasses.
1068 * Returns: TRUE if the query succeeded.
1073 gst_base_sink_query_latency (GstBaseSink * sink, gboolean * live,
1074 gboolean * upstream_live, GstClockTime * min_latency,
1075 GstClockTime * max_latency)
1077 gboolean l, us_live, res, have_latency;
1078 GstClockTime min, max, render_delay;
1080 GstClockTime us_min, us_max;
1082 /* we are live when we sync to the clock */
1083 GST_OBJECT_LOCK (sink);
1085 have_latency = sink->priv->have_latency;
1086 render_delay = sink->priv->render_delay;
1087 GST_OBJECT_UNLOCK (sink);
1089 /* assume no latency */
1095 GST_DEBUG_OBJECT (sink, "we are ready for LATENCY query");
1096 /* we are ready for a latency query this is when we preroll or when we are
1098 query = gst_query_new_latency ();
1100 /* ask the peer for the latency */
1101 if ((res = gst_pad_peer_query (sink->sinkpad, query))) {
1102 /* get upstream min and max latency */
1103 gst_query_parse_latency (query, &us_live, &us_min, &us_max);
1106 /* upstream live, use its latency, subclasses should use these
1107 * values to create the complete latency. */
1112 /* we need to add the render delay if we are live */
1114 min += render_delay;
1116 max += render_delay;
1119 gst_query_unref (query);
1121 GST_DEBUG_OBJECT (sink, "we are not yet ready for LATENCY query");
1125 /* not live, we tried to do the query, if it failed we return TRUE anyway */
1129 GST_DEBUG_OBJECT (sink, "latency query failed but we are not live");
1131 GST_DEBUG_OBJECT (sink, "latency query failed and we are live");
1136 GST_DEBUG_OBJECT (sink, "latency query: live: %d, have_latency %d,"
1137 " upstream: %d, min %" GST_TIME_FORMAT ", max %" GST_TIME_FORMAT, l,
1138 have_latency, us_live, GST_TIME_ARGS (min), GST_TIME_ARGS (max));
1143 *upstream_live = us_live;
1153 * gst_base_sink_set_render_delay:
1154 * @sink: a #GstBaseSink
1155 * @delay: the new delay
1157 * Set the render delay in @sink to @delay. The render delay is the time
1158 * between actual rendering of a buffer and its synchronisation time. Some
1159 * devices might delay media rendering which can be compensated for with this
1162 * After calling this function, this sink will report additional latency and
1163 * other sinks will adjust their latency to delay the rendering of their media.
1165 * This function is usually called by subclasses.
1170 gst_base_sink_set_render_delay (GstBaseSink * sink, GstClockTime delay)
1172 GstClockTime old_render_delay;
1174 g_return_if_fail (GST_IS_BASE_SINK (sink));
1176 GST_OBJECT_LOCK (sink);
1177 old_render_delay = sink->priv->render_delay;
1178 sink->priv->render_delay = delay;
1179 GST_LOG_OBJECT (sink, "set render delay to %" GST_TIME_FORMAT,
1180 GST_TIME_ARGS (delay));
1181 GST_OBJECT_UNLOCK (sink);
1183 if (delay != old_render_delay) {
1184 GST_DEBUG_OBJECT (sink, "posting latency changed");
1185 gst_element_post_message (GST_ELEMENT_CAST (sink),
1186 gst_message_new_latency (GST_OBJECT_CAST (sink)));
1191 * gst_base_sink_get_render_delay:
1192 * @sink: a #GstBaseSink
1194 * Get the render delay of @sink. see gst_base_sink_set_render_delay() for more
1195 * information about the render delay.
1197 * Returns: the render delay of @sink.
1202 gst_base_sink_get_render_delay (GstBaseSink * sink)
1204 GstClockTimeDiff res;
1206 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1208 GST_OBJECT_LOCK (sink);
1209 res = sink->priv->render_delay;
1210 GST_OBJECT_UNLOCK (sink);
1216 * gst_base_sink_set_blocksize:
1217 * @sink: a #GstBaseSink
1218 * @blocksize: the blocksize in bytes
1220 * Set the number of bytes that the sink will pull when it is operating in pull
1225 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
1227 gst_base_sink_set_blocksize (GstBaseSink * sink, guint blocksize)
1229 g_return_if_fail (GST_IS_BASE_SINK (sink));
1231 GST_OBJECT_LOCK (sink);
1232 sink->priv->blocksize = blocksize;
1233 GST_LOG_OBJECT (sink, "set blocksize to %u", blocksize);
1234 GST_OBJECT_UNLOCK (sink);
1238 * gst_base_sink_get_blocksize:
1239 * @sink: a #GstBaseSink
1241 * Get the number of bytes that the sink will pull when it is operating in pull
1244 * Returns: the number of bytes @sink will pull in pull mode.
1248 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
1250 gst_base_sink_get_blocksize (GstBaseSink * sink)
1254 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1256 GST_OBJECT_LOCK (sink);
1257 res = sink->priv->blocksize;
1258 GST_OBJECT_UNLOCK (sink);
1264 * gst_base_sink_set_throttle_time:
1265 * @sink: a #GstBaseSink
1266 * @throttle: the throttle time in nanoseconds
1268 * Set the time that will be inserted between rendered buffers. This
1269 * can be used to control the maximum buffers per second that the sink
1275 gst_base_sink_set_throttle_time (GstBaseSink * sink, guint64 throttle)
1277 g_return_if_fail (GST_IS_BASE_SINK (sink));
1279 GST_OBJECT_LOCK (sink);
1280 sink->priv->throttle_time = throttle;
1281 GST_LOG_OBJECT (sink, "set throttle_time to %" G_GUINT64_FORMAT, throttle);
1282 GST_OBJECT_UNLOCK (sink);
1286 * gst_base_sink_get_throttle_time:
1287 * @sink: a #GstBaseSink
1289 * Get the time that will be inserted between frames to control the
1290 * maximum buffers per second.
1292 * Returns: the number of nanoseconds @sink will put between frames.
1297 gst_base_sink_get_throttle_time (GstBaseSink * sink)
1301 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1303 GST_OBJECT_LOCK (sink);
1304 res = sink->priv->throttle_time;
1305 GST_OBJECT_UNLOCK (sink);
1311 gst_base_sink_set_property (GObject * object, guint prop_id,
1312 const GValue * value, GParamSpec * pspec)
1314 GstBaseSink *sink = GST_BASE_SINK (object);
1318 gst_base_sink_set_sync (sink, g_value_get_boolean (value));
1320 case PROP_MAX_LATENESS:
1321 gst_base_sink_set_max_lateness (sink, g_value_get_int64 (value));
1324 gst_base_sink_set_qos_enabled (sink, g_value_get_boolean (value));
1327 gst_base_sink_set_async_enabled (sink, g_value_get_boolean (value));
1329 case PROP_TS_OFFSET:
1330 gst_base_sink_set_ts_offset (sink, g_value_get_int64 (value));
1332 case PROP_BLOCKSIZE:
1333 gst_base_sink_set_blocksize (sink, g_value_get_uint (value));
1335 case PROP_RENDER_DELAY:
1336 gst_base_sink_set_render_delay (sink, g_value_get_uint64 (value));
1338 case PROP_ENABLE_LAST_SAMPLE:
1339 gst_base_sink_set_last_sample_enabled (sink, g_value_get_boolean (value));
1341 case PROP_THROTTLE_TIME:
1342 gst_base_sink_set_throttle_time (sink, g_value_get_uint64 (value));
1345 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1351 gst_base_sink_get_property (GObject * object, guint prop_id, GValue * value,
1354 GstBaseSink *sink = GST_BASE_SINK (object);
1358 g_value_set_boolean (value, gst_base_sink_get_sync (sink));
1360 case PROP_MAX_LATENESS:
1361 g_value_set_int64 (value, gst_base_sink_get_max_lateness (sink));
1364 g_value_set_boolean (value, gst_base_sink_is_qos_enabled (sink));
1367 g_value_set_boolean (value, gst_base_sink_is_async_enabled (sink));
1369 case PROP_TS_OFFSET:
1370 g_value_set_int64 (value, gst_base_sink_get_ts_offset (sink));
1372 case PROP_LAST_SAMPLE:
1373 gst_value_take_buffer (value, gst_base_sink_get_last_sample (sink));
1375 case PROP_ENABLE_LAST_SAMPLE:
1376 g_value_set_boolean (value, gst_base_sink_is_last_sample_enabled (sink));
1378 case PROP_BLOCKSIZE:
1379 g_value_set_uint (value, gst_base_sink_get_blocksize (sink));
1381 case PROP_RENDER_DELAY:
1382 g_value_set_uint64 (value, gst_base_sink_get_render_delay (sink));
1384 case PROP_THROTTLE_TIME:
1385 g_value_set_uint64 (value, gst_base_sink_get_throttle_time (sink));
1388 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1395 gst_base_sink_get_caps (GstBaseSink * sink, GstCaps * filter)
1401 gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps)
1406 /* with PREROLL_LOCK, STREAM_LOCK */
1408 gst_base_sink_commit_state (GstBaseSink * basesink)
1410 /* commit state and proceed to next pending state */
1411 GstState current, next, pending, post_pending;
1412 gboolean post_paused = FALSE;
1413 gboolean post_async_done = FALSE;
1414 gboolean post_playing = FALSE;
1415 gboolean reset_time;
1417 /* we are certainly not playing async anymore now */
1418 basesink->playing_async = FALSE;
1420 GST_OBJECT_LOCK (basesink);
1421 current = GST_STATE (basesink);
1422 next = GST_STATE_NEXT (basesink);
1423 pending = GST_STATE_PENDING (basesink);
1424 post_pending = pending;
1425 reset_time = basesink->priv->reset_time;
1426 basesink->priv->reset_time = FALSE;
1429 case GST_STATE_PLAYING:
1431 GST_DEBUG_OBJECT (basesink, "commiting state to PLAYING");
1433 basesink->need_preroll = FALSE;
1434 post_async_done = TRUE;
1435 basesink->priv->commited = TRUE;
1436 post_playing = TRUE;
1437 /* post PAUSED too when we were READY */
1438 if (current == GST_STATE_READY) {
1443 case GST_STATE_PAUSED:
1444 GST_DEBUG_OBJECT (basesink, "commiting state to PAUSED");
1446 post_async_done = TRUE;
1447 basesink->priv->commited = TRUE;
1448 post_pending = GST_STATE_VOID_PENDING;
1450 case GST_STATE_READY:
1451 case GST_STATE_NULL:
1453 case GST_STATE_VOID_PENDING:
1454 goto nothing_pending;
1459 /* we can report latency queries now */
1460 basesink->priv->have_latency = TRUE;
1462 GST_STATE (basesink) = pending;
1463 GST_STATE_NEXT (basesink) = GST_STATE_VOID_PENDING;
1464 GST_STATE_PENDING (basesink) = GST_STATE_VOID_PENDING;
1465 GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_SUCCESS;
1466 GST_OBJECT_UNLOCK (basesink);
1469 GST_DEBUG_OBJECT (basesink, "posting PAUSED state change message");
1470 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1471 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1472 current, next, post_pending));
1474 if (post_async_done) {
1475 GST_DEBUG_OBJECT (basesink, "posting async-done message");
1476 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1477 gst_message_new_async_done (GST_OBJECT_CAST (basesink), reset_time));
1480 GST_DEBUG_OBJECT (basesink, "posting PLAYING state change message");
1481 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1482 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1483 next, pending, GST_STATE_VOID_PENDING));
1486 GST_STATE_BROADCAST (basesink);
1492 /* Depending on the state, set our vars. We get in this situation when the
1493 * state change function got a change to update the state vars before the
1494 * streaming thread did. This is fine but we need to make sure that we
1495 * update the need_preroll var since it was TRUE when we got here and might
1496 * become FALSE if we got to PLAYING. */
1497 GST_DEBUG_OBJECT (basesink, "nothing to commit, now in %s",
1498 gst_element_state_get_name (current));
1500 case GST_STATE_PLAYING:
1501 basesink->need_preroll = FALSE;
1503 case GST_STATE_PAUSED:
1504 basesink->need_preroll = TRUE;
1507 basesink->need_preroll = FALSE;
1508 basesink->flushing = TRUE;
1511 /* we can report latency queries now */
1512 basesink->priv->have_latency = TRUE;
1513 GST_OBJECT_UNLOCK (basesink);
1518 /* app is going to READY */
1519 GST_DEBUG_OBJECT (basesink, "stopping");
1520 basesink->need_preroll = FALSE;
1521 basesink->flushing = TRUE;
1522 GST_OBJECT_UNLOCK (basesink);
1528 start_stepping (GstBaseSink * sink, GstSegment * segment,
1529 GstStepInfo * pending, GstStepInfo * current)
1532 GstMessage *message;
1534 GST_DEBUG_OBJECT (sink, "update pending step");
1536 GST_OBJECT_LOCK (sink);
1537 memcpy (current, pending, sizeof (GstStepInfo));
1538 pending->valid = FALSE;
1539 GST_OBJECT_UNLOCK (sink);
1541 /* post message first */
1543 gst_message_new_step_start (GST_OBJECT (sink), TRUE, current->format,
1544 current->amount, current->rate, current->flush, current->intermediate);
1545 gst_message_set_seqnum (message, current->seqnum);
1546 gst_element_post_message (GST_ELEMENT (sink), message);
1548 /* get the running time of where we paused and remember it */
1549 current->start = gst_element_get_start_time (GST_ELEMENT_CAST (sink));
1550 gst_segment_set_running_time (segment, GST_FORMAT_TIME, current->start);
1552 /* set the new rate for the remainder of the segment */
1553 current->start_rate = segment->rate;
1554 segment->rate *= current->rate;
1557 if (segment->rate > 0.0)
1558 current->start_stop = segment->stop;
1560 current->start_start = segment->start;
1562 if (current->format == GST_FORMAT_TIME) {
1563 end = current->start + current->amount;
1564 if (!current->flush) {
1565 /* update the segment clipping regions for non-flushing seeks */
1566 if (segment->rate > 0.0) {
1567 segment->stop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1568 segment->position = segment->stop;
1572 position = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1573 segment->time = position;
1574 segment->start = position;
1575 segment->position = position;
1580 GST_DEBUG_OBJECT (sink, "segment now %" GST_SEGMENT_FORMAT, segment);
1581 GST_DEBUG_OBJECT (sink, "step started at running_time %" GST_TIME_FORMAT,
1582 GST_TIME_ARGS (current->start));
1584 if (current->amount == -1) {
1585 GST_DEBUG_OBJECT (sink, "step amount == -1, stop stepping");
1586 current->valid = FALSE;
1588 GST_DEBUG_OBJECT (sink, "step amount: %" G_GUINT64_FORMAT ", format: %s, "
1589 "rate: %f", current->amount, gst_format_get_name (current->format),
1595 stop_stepping (GstBaseSink * sink, GstSegment * segment,
1596 GstStepInfo * current, gint64 rstart, gint64 rstop, gboolean eos)
1598 gint64 stop, position;
1599 GstMessage *message;
1601 GST_DEBUG_OBJECT (sink, "step complete");
1603 if (segment->rate > 0.0)
1608 GST_DEBUG_OBJECT (sink,
1609 "step stop at running_time %" GST_TIME_FORMAT, GST_TIME_ARGS (stop));
1612 current->duration = current->position;
1614 current->duration = stop - current->start;
1616 GST_DEBUG_OBJECT (sink, "step elapsed running_time %" GST_TIME_FORMAT,
1617 GST_TIME_ARGS (current->duration));
1619 position = current->start + current->duration;
1621 /* now move the segment to the new running time */
1622 gst_segment_set_running_time (segment, GST_FORMAT_TIME, position);
1624 if (current->flush) {
1625 /* and remove the time we flushed, start time did not change */
1626 segment->base = current->start;
1628 /* start time is now the stepped position */
1629 gst_element_set_start_time (GST_ELEMENT_CAST (sink), position);
1632 /* restore the previous rate */
1633 segment->rate = current->start_rate;
1635 if (segment->rate > 0.0)
1636 segment->stop = current->start_stop;
1638 segment->start = current->start_start;
1640 /* post the step done when we know the stepped duration in TIME */
1642 gst_message_new_step_done (GST_OBJECT_CAST (sink), current->format,
1643 current->amount, current->rate, current->flush, current->intermediate,
1644 current->duration, eos);
1645 gst_message_set_seqnum (message, current->seqnum);
1646 gst_element_post_message (GST_ELEMENT_CAST (sink), message);
1648 if (!current->intermediate)
1649 sink->need_preroll = current->need_preroll;
1651 /* and the current step info finished and becomes invalid */
1652 current->valid = FALSE;
1656 handle_stepping (GstBaseSink * sink, GstSegment * segment,
1657 GstStepInfo * current, guint64 * cstart, guint64 * cstop, guint64 * rstart,
1660 gboolean step_end = FALSE;
1662 /* see if we need to skip this buffer because of stepping */
1663 switch (current->format) {
1664 case GST_FORMAT_TIME:
1667 guint64 first, last;
1670 if (segment->rate > 0.0) {
1671 if (segment->stop == *cstop)
1672 *rstop = *rstart + current->amount;
1677 if (segment->start == *cstart)
1678 *rstart = *rstop + current->amount;
1684 end = current->start + current->amount;
1685 current->position = first - current->start;
1687 abs_rate = ABS (segment->rate);
1688 if (G_UNLIKELY (abs_rate != 1.0))
1689 current->position /= abs_rate;
1691 GST_DEBUG_OBJECT (sink,
1692 "buffer: %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT,
1693 GST_TIME_ARGS (first), GST_TIME_ARGS (last));
1694 GST_DEBUG_OBJECT (sink,
1695 "got time step %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT "/%"
1696 GST_TIME_FORMAT, GST_TIME_ARGS (current->position),
1697 GST_TIME_ARGS (last - current->start),
1698 GST_TIME_ARGS (current->amount));
1700 if ((current->flush && current->position >= current->amount)
1702 GST_DEBUG_OBJECT (sink, "step ended, we need clipping");
1704 if (segment->rate > 0.0) {
1706 *cstart = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1709 *cstop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1712 GST_DEBUG_OBJECT (sink,
1713 "cstart %" GST_TIME_FORMAT ", rstart %" GST_TIME_FORMAT,
1714 GST_TIME_ARGS (*cstart), GST_TIME_ARGS (*rstart));
1715 GST_DEBUG_OBJECT (sink,
1716 "cstop %" GST_TIME_FORMAT ", rstop %" GST_TIME_FORMAT,
1717 GST_TIME_ARGS (*cstop), GST_TIME_ARGS (*rstop));
1720 case GST_FORMAT_BUFFERS:
1721 GST_DEBUG_OBJECT (sink,
1722 "got default step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1723 current->position, current->amount);
1725 if (current->position < current->amount) {
1726 current->position++;
1731 case GST_FORMAT_DEFAULT:
1733 GST_DEBUG_OBJECT (sink,
1734 "got unknown step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1735 current->position, current->amount);
1741 /* with STREAM_LOCK, PREROLL_LOCK
1743 * Returns TRUE if the object needs synchronisation and takes therefore
1744 * part in prerolling.
1746 * rsstart/rsstop contain the start/stop in stream time.
1747 * rrstart/rrstop contain the start/stop in running time.
1750 gst_base_sink_get_sync_times (GstBaseSink * basesink, GstMiniObject * obj,
1751 GstClockTime * rsstart, GstClockTime * rsstop,
1752 GstClockTime * rrstart, GstClockTime * rrstop, gboolean * do_sync,
1753 gboolean * stepped, GstStepInfo * step,
1754 gboolean * step_end, guint8 obj_type)
1756 GstBaseSinkClass *bclass;
1758 GstClockTime start, stop; /* raw start/stop timestamps */
1759 guint64 cstart, cstop; /* clipped raw timestamps */
1760 guint64 rstart, rstop; /* clipped timestamps converted to running time */
1761 GstClockTime sstart, sstop; /* clipped timestamps converted to stream time */
1763 GstBaseSinkPrivate *priv;
1764 GstSegment *segment;
1767 priv = basesink->priv;
1768 segment = &basesink->segment;
1770 /* start with nothing */
1771 start = stop = GST_CLOCK_TIME_NONE;
1773 if (G_UNLIKELY (OBJ_IS_EVENT (obj_type))) {
1774 GstEvent *event = GST_EVENT_CAST (obj);
1776 switch (GST_EVENT_TYPE (event)) {
1777 /* EOS event needs syncing */
1780 if (basesink->segment.rate >= 0.0) {
1781 sstart = sstop = priv->current_sstop;
1782 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1783 /* we have not seen a buffer yet, use the segment values */
1784 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1785 basesink->segment.format, basesink->segment.stop);
1788 sstart = sstop = priv->current_sstart;
1789 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1790 /* we have not seen a buffer yet, use the segment values */
1791 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1792 basesink->segment.format, basesink->segment.start);
1796 rstart = rstop = priv->eos_rtime;
1797 *do_sync = rstart != -1;
1798 GST_DEBUG_OBJECT (basesink, "sync times for EOS %" GST_TIME_FORMAT,
1799 GST_TIME_ARGS (rstart));
1800 /* if we are stepping, we end now */
1801 *step_end = step->valid;
1806 /* other events do not need syncing */
1814 /* else do buffer sync code */
1815 buffer = GST_BUFFER_CAST (obj);
1817 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1819 /* just get the times to see if we need syncing, if the start returns -1 we
1821 if (bclass->get_times)
1822 bclass->get_times (basesink, buffer, &start, &stop);
1824 if (!GST_CLOCK_TIME_IS_VALID (start)) {
1825 /* we don't need to sync but we still want to get the timestamps for
1826 * tracking the position */
1827 gst_base_sink_get_times (basesink, buffer, &start, &stop);
1833 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
1834 ", stop: %" GST_TIME_FORMAT ", do_sync %d", GST_TIME_ARGS (start),
1835 GST_TIME_ARGS (stop), *do_sync);
1837 /* collect segment and format for code clarity */
1838 format = segment->format;
1841 if (G_UNLIKELY (!gst_segment_clip (segment, format,
1842 start, stop, &cstart, &cstop))) {
1844 GST_DEBUG_OBJECT (basesink, "step out of segment");
1845 /* when we are stepping, pretend we're at the end of the segment */
1846 if (segment->rate > 0.0) {
1847 cstart = segment->stop;
1848 cstop = segment->stop;
1850 cstart = segment->start;
1851 cstop = segment->start;
1855 goto out_of_segment;
1858 if (G_UNLIKELY (start != cstart || stop != cstop)) {
1859 GST_DEBUG_OBJECT (basesink, "clipped to: start %" GST_TIME_FORMAT
1860 ", stop: %" GST_TIME_FORMAT, GST_TIME_ARGS (cstart),
1861 GST_TIME_ARGS (cstop));
1864 /* set last stop position */
1865 if (G_LIKELY (stop != GST_CLOCK_TIME_NONE && cstop != GST_CLOCK_TIME_NONE))
1866 segment->position = cstop;
1868 segment->position = cstart;
1871 rstart = gst_segment_to_running_time (segment, format, cstart);
1872 rstop = gst_segment_to_running_time (segment, format, cstop);
1874 if (G_UNLIKELY (step->valid)) {
1875 if (!(*step_end = handle_stepping (basesink, segment, step, &cstart, &cstop,
1876 &rstart, &rstop))) {
1877 /* step is still busy, we discard data when we are flushing */
1878 *stepped = step->flush;
1879 GST_DEBUG_OBJECT (basesink, "stepping busy");
1882 /* this can produce wrong values if we accumulated non-TIME segments. If this happens,
1883 * upstream is behaving very badly */
1884 sstart = gst_segment_to_stream_time (segment, format, cstart);
1885 sstop = gst_segment_to_stream_time (segment, format, cstop);
1888 /* eos_done label only called when doing EOS, we also stop stepping then */
1889 if (*step_end && step->flush) {
1890 GST_DEBUG_OBJECT (basesink, "flushing step ended");
1891 stop_stepping (basesink, segment, step, rstart, rstop, eos);
1893 /* re-determine running start times for adjusted segment
1894 * (which has a flushed amount of running/accumulated time removed) */
1895 if (!GST_IS_EVENT (obj)) {
1896 GST_DEBUG_OBJECT (basesink, "refresh sync times");
1907 /* buffers and EOS always need syncing and preroll */
1913 /* we usually clip in the chain function already but stepping could cause
1914 * the segment to be updated later. we return FALSE so that we don't try
1916 GST_LOG_OBJECT (basesink, "buffer skipped, not in segment");
1921 /* with STREAM_LOCK, PREROLL_LOCK, LOCK
1922 * adjust a timestamp with the latency and timestamp offset. This function does
1923 * not adjust for the render delay. */
1925 gst_base_sink_adjust_time (GstBaseSink * basesink, GstClockTime time)
1927 GstClockTimeDiff ts_offset;
1929 /* don't do anything funny with invalid timestamps */
1930 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
1933 time += basesink->priv->latency;
1935 /* apply offset, be carefull for underflows */
1936 ts_offset = basesink->priv->ts_offset;
1937 if (ts_offset < 0) {
1938 ts_offset = -ts_offset;
1939 if (ts_offset < time)
1946 /* subtract the render delay again, which was included in the latency */
1947 if (time > basesink->priv->render_delay)
1948 time -= basesink->priv->render_delay;
1956 * gst_base_sink_wait_clock:
1958 * @time: the running_time to be reached
1959 * @jitter: (out) (allow-none): the jitter to be filled with time diff, or NULL
1961 * This function will block until @time is reached. It is usually called by
1962 * subclasses that use their own internal synchronisation.
1964 * If @time is not valid, no sycnhronisation is done and #GST_CLOCK_BADTIME is
1965 * returned. Likewise, if synchronisation is disabled in the element or there
1966 * is no clock, no synchronisation is done and #GST_CLOCK_BADTIME is returned.
1968 * This function should only be called with the PREROLL_LOCK held, like when
1969 * receiving an EOS event in the #GstBaseSinkClass.event() vmethod or when
1970 * receiving a buffer in
1971 * the #GstBaseSinkClass.render() vmethod.
1973 * The @time argument should be the running_time of when this method should
1974 * return and is not adjusted with any latency or offset configured in the
1979 * Returns: #GstClockReturn
1982 gst_base_sink_wait_clock (GstBaseSink * sink, GstClockTime time,
1983 GstClockTimeDiff * jitter)
1987 GstClockTime base_time;
1989 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
1992 GST_OBJECT_LOCK (sink);
1993 if (G_UNLIKELY (!sink->sync))
1996 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (sink)) == NULL))
1999 base_time = GST_ELEMENT_CAST (sink)->base_time;
2000 GST_LOG_OBJECT (sink,
2001 "time %" GST_TIME_FORMAT ", base_time %" GST_TIME_FORMAT,
2002 GST_TIME_ARGS (time), GST_TIME_ARGS (base_time));
2004 /* add base_time to running_time to get the time against the clock */
2007 /* Re-use existing clockid if available */
2008 /* FIXME: Casting to GstClockEntry only works because the types
2010 if (G_LIKELY (sink->priv->cached_clock_id != NULL
2011 && GST_CLOCK_ENTRY_CLOCK ((GstClockEntry *) sink->priv->
2012 cached_clock_id) == clock)) {
2013 if (!gst_clock_single_shot_id_reinit (clock, sink->priv->cached_clock_id,
2015 gst_clock_id_unref (sink->priv->cached_clock_id);
2016 sink->priv->cached_clock_id = gst_clock_new_single_shot_id (clock, time);
2019 if (sink->priv->cached_clock_id != NULL)
2020 gst_clock_id_unref (sink->priv->cached_clock_id);
2021 sink->priv->cached_clock_id = gst_clock_new_single_shot_id (clock, time);
2023 GST_OBJECT_UNLOCK (sink);
2025 /* A blocking wait is performed on the clock. We save the ClockID
2026 * so we can unlock the entry at any time. While we are blocking, we
2027 * release the PREROLL_LOCK so that other threads can interrupt the
2029 sink->clock_id = sink->priv->cached_clock_id;
2030 /* release the preroll lock while waiting */
2031 GST_BASE_SINK_PREROLL_UNLOCK (sink);
2033 ret = gst_clock_id_wait (sink->priv->cached_clock_id, jitter);
2035 GST_BASE_SINK_PREROLL_LOCK (sink);
2036 sink->clock_id = NULL;
2040 /* no syncing needed */
2043 GST_DEBUG_OBJECT (sink, "time not valid, no sync needed");
2044 return GST_CLOCK_BADTIME;
2048 GST_DEBUG_OBJECT (sink, "sync disabled");
2049 GST_OBJECT_UNLOCK (sink);
2050 return GST_CLOCK_BADTIME;
2054 GST_DEBUG_OBJECT (sink, "no clock, can't sync");
2055 GST_OBJECT_UNLOCK (sink);
2056 return GST_CLOCK_BADTIME;
2061 * gst_base_sink_wait_preroll:
2064 * If the #GstBaseSinkClass.render() method performs its own synchronisation
2065 * against the clock it must unblock when going from PLAYING to the PAUSED state
2066 * and call this method before continuing to render the remaining data.
2068 * This function will block until a state change to PLAYING happens (in which
2069 * case this function returns #GST_FLOW_OK) or the processing must be stopped due
2070 * to a state change to READY or a FLUSH event (in which case this function
2071 * returns #GST_FLOW_WRONG_STATE).
2073 * This function should only be called with the PREROLL_LOCK held, like in the
2076 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2077 * continue. Any other return value should be returned from the render vmethod.
2082 gst_base_sink_wait_preroll (GstBaseSink * sink)
2084 sink->have_preroll = TRUE;
2085 GST_DEBUG_OBJECT (sink, "waiting in preroll for flush or PLAYING");
2086 /* block until the state changes, or we get a flush, or something */
2087 GST_BASE_SINK_PREROLL_WAIT (sink);
2088 sink->have_preroll = FALSE;
2089 if (G_UNLIKELY (sink->flushing))
2091 if (G_UNLIKELY (sink->priv->step_unlock))
2093 GST_DEBUG_OBJECT (sink, "continue after preroll");
2100 GST_DEBUG_OBJECT (sink, "preroll interrupted because of flush");
2101 return GST_FLOW_WRONG_STATE;
2105 sink->priv->step_unlock = FALSE;
2106 GST_DEBUG_OBJECT (sink, "preroll interrupted because of step");
2107 return GST_FLOW_STEP;
2111 static inline guint8
2112 get_object_type (GstMiniObject * obj)
2116 if (G_LIKELY (GST_IS_BUFFER (obj)))
2117 obj_type = _PR_IS_BUFFER;
2118 else if (GST_IS_EVENT (obj))
2119 obj_type = _PR_IS_EVENT;
2120 else if (GST_IS_BUFFER_LIST (obj))
2121 obj_type = _PR_IS_BUFFERLIST;
2123 obj_type = _PR_IS_NOTHING;
2129 * gst_base_sink_do_preroll:
2131 * @obj: (transfer none): the mini object that caused the preroll
2133 * If the @sink spawns its own thread for pulling buffers from upstream it
2134 * should call this method after it has pulled a buffer. If the element needed
2135 * to preroll, this function will perform the preroll and will then block
2136 * until the element state is changed.
2138 * This function should be called with the PREROLL_LOCK held.
2140 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2141 * continue. Any other return value should be returned from the render vmethod.
2146 gst_base_sink_do_preroll (GstBaseSink * sink, GstMiniObject * obj)
2150 while (G_UNLIKELY (sink->need_preroll)) {
2152 GST_DEBUG_OBJECT (sink, "prerolling object %p", obj);
2154 obj_type = get_object_type (obj);
2156 ret = gst_base_sink_preroll_object (sink, obj_type, obj);
2157 if (ret != GST_FLOW_OK)
2158 goto preroll_failed;
2160 /* need to recheck here because the commit state could have
2161 * made us not need the preroll anymore */
2162 if (G_LIKELY (sink->need_preroll)) {
2163 /* block until the state changes, or we get a flush, or something */
2164 ret = gst_base_sink_wait_preroll (sink);
2165 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2166 goto preroll_failed;
2174 GST_DEBUG_OBJECT (sink, "preroll failed: %s", gst_flow_get_name (ret));
2180 * gst_base_sink_wait_eos:
2182 * @time: the running_time to be reached
2183 * @jitter: (out) (allow-none): the jitter to be filled with time diff, or NULL
2185 * This function will block until @time is reached. It is usually called by
2186 * subclasses that use their own internal synchronisation but want to let the
2187 * EOS be handled by the base class.
2189 * This function should only be called with the PREROLL_LOCK held, like when
2190 * receiving an EOS event in the ::event vmethod.
2192 * The @time argument should be the running_time of when the EOS should happen
2193 * and will be adjusted with any latency and offset configured in the sink.
2195 * Returns: #GstFlowReturn
2200 gst_base_sink_wait_eos (GstBaseSink * sink, GstClockTime time,
2201 GstClockTimeDiff * jitter)
2203 GstClockReturn status;
2209 GST_DEBUG_OBJECT (sink, "checking preroll");
2211 /* first wait for the playing state before we can continue */
2212 while (G_UNLIKELY (sink->need_preroll)) {
2213 ret = gst_base_sink_wait_preroll (sink);
2214 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2218 /* preroll done, we can sync since we are in PLAYING now. */
2219 GST_DEBUG_OBJECT (sink, "possibly waiting for clock to reach %"
2220 GST_TIME_FORMAT, GST_TIME_ARGS (time));
2222 /* compensate for latency and ts_offset. We don't adjust for render delay
2223 * because we don't interact with the device on EOS normally. */
2224 stime = gst_base_sink_adjust_time (sink, time);
2226 /* wait for the clock, this can be interrupted because we got shut down or
2228 status = gst_base_sink_wait_clock (sink, stime, jitter);
2230 GST_DEBUG_OBJECT (sink, "clock returned %d", status);
2232 /* invalid time, no clock or sync disabled, just continue then */
2233 if (status == GST_CLOCK_BADTIME)
2236 /* waiting could have been interrupted and we can be flushing now */
2237 if (G_UNLIKELY (sink->flushing))
2240 /* retry if we got unscheduled, which means we did not reach the timeout
2241 * yet. if some other error occures, we continue. */
2242 } while (status == GST_CLOCK_UNSCHEDULED);
2244 GST_DEBUG_OBJECT (sink, "end of stream");
2251 GST_DEBUG_OBJECT (sink, "we are flushing");
2252 return GST_FLOW_WRONG_STATE;
2256 /* with STREAM_LOCK, PREROLL_LOCK
2258 * Make sure we are in PLAYING and synchronize an object to the clock.
2260 * If we need preroll, we are not in PLAYING. We try to commit the state
2261 * if needed and then block if we still are not PLAYING.
2263 * We start waiting on the clock in PLAYING. If we got interrupted, we
2264 * immediately try to re-preroll.
2266 * Some objects do not need synchronisation (most events) and so this function
2267 * immediately returns GST_FLOW_OK.
2269 * for objects that arrive later than max-lateness to be synchronized to the
2270 * clock have the @late boolean set to TRUE.
2272 * This function keeps a running average of the jitter (the diff between the
2273 * clock time and the requested sync time). The jitter is negative for
2274 * objects that arrive in time and positive for late buffers.
2276 * does not take ownership of obj.
2278 static GstFlowReturn
2279 gst_base_sink_do_sync (GstBaseSink * basesink, GstPad * pad,
2280 GstMiniObject * obj, gboolean * late, gboolean * step_end, guint8 obj_type)
2282 GstClockTimeDiff jitter = 0;
2284 GstClockReturn status = GST_CLOCK_OK;
2285 GstClockTime rstart, rstop, sstart, sstop, stime;
2287 GstBaseSinkPrivate *priv;
2289 GstStepInfo *current, *pending;
2292 priv = basesink->priv;
2295 sstart = sstop = rstart = rstop = GST_CLOCK_TIME_NONE;
2299 priv->current_rstart = GST_CLOCK_TIME_NONE;
2301 /* get stepping info */
2302 current = &priv->current_step;
2303 pending = &priv->pending_step;
2305 /* get timing information for this object against the render segment */
2306 syncable = gst_base_sink_get_sync_times (basesink, obj,
2307 &sstart, &sstop, &rstart, &rstop, &do_sync, &stepped,
2308 current, step_end, obj_type);
2310 if (G_UNLIKELY (stepped))
2313 /* a syncable object needs to participate in preroll and
2314 * clocking. All buffers and EOS are syncable. */
2315 if (G_UNLIKELY (!syncable))
2318 /* store timing info for current object */
2319 priv->current_rstart = rstart;
2320 priv->current_rstop = (GST_CLOCK_TIME_IS_VALID (rstop) ? rstop : rstart);
2322 /* save sync time for eos when the previous object needed sync */
2323 priv->eos_rtime = (do_sync ? priv->current_rstop : GST_CLOCK_TIME_NONE);
2325 /* calculate inter frame spacing */
2326 if (G_UNLIKELY (priv->prev_rstart != -1 && priv->prev_rstart < rstart)) {
2327 GstClockTime in_diff;
2329 in_diff = rstart - priv->prev_rstart;
2331 if (priv->avg_in_diff == -1)
2332 priv->avg_in_diff = in_diff;
2334 priv->avg_in_diff = UPDATE_RUNNING_AVG (priv->avg_in_diff, in_diff);
2336 GST_LOG_OBJECT (basesink, "avg frame diff %" GST_TIME_FORMAT,
2337 GST_TIME_ARGS (priv->avg_in_diff));
2340 priv->prev_rstart = rstart;
2342 if (G_UNLIKELY (priv->earliest_in_time != -1
2343 && rstart < priv->earliest_in_time))
2347 /* first do preroll, this makes sure we commit our state
2348 * to PAUSED and can continue to PLAYING. We cannot perform
2349 * any clock sync in PAUSED because there is no clock. */
2350 ret = gst_base_sink_do_preroll (basesink, obj);
2351 if (G_UNLIKELY (ret != GST_FLOW_OK))
2352 goto preroll_failed;
2354 /* update the segment with a pending step if the current one is invalid and we
2355 * have a new pending one. We only accept new step updates after a preroll */
2356 if (G_UNLIKELY (pending->valid && !current->valid)) {
2357 start_stepping (basesink, &basesink->segment, pending, current);
2361 /* After rendering we store the position of the last buffer so that we can use
2362 * it to report the position. We need to take the lock here. */
2363 GST_OBJECT_LOCK (basesink);
2364 priv->current_sstart = sstart;
2365 priv->current_sstop = (GST_CLOCK_TIME_IS_VALID (sstop) ? sstop : sstart);
2366 GST_OBJECT_UNLOCK (basesink);
2371 /* adjust for latency */
2372 stime = gst_base_sink_adjust_time (basesink, rstart);
2374 /* adjust for render-delay, avoid underflows */
2375 if (GST_CLOCK_TIME_IS_VALID (stime)) {
2376 if (stime > priv->render_delay)
2377 stime -= priv->render_delay;
2382 /* preroll done, we can sync since we are in PLAYING now. */
2383 GST_DEBUG_OBJECT (basesink, "possibly waiting for clock to reach %"
2384 GST_TIME_FORMAT ", adjusted %" GST_TIME_FORMAT,
2385 GST_TIME_ARGS (rstart), GST_TIME_ARGS (stime));
2387 /* This function will return immediately if start == -1, no clock
2388 * or sync is disabled with GST_CLOCK_BADTIME. */
2389 status = gst_base_sink_wait_clock (basesink, stime, &jitter);
2391 GST_DEBUG_OBJECT (basesink, "clock returned %d, jitter %c%" GST_TIME_FORMAT,
2392 status, (jitter < 0 ? '-' : ' '), GST_TIME_ARGS (ABS (jitter)));
2394 /* invalid time, no clock or sync disabled, just render */
2395 if (status == GST_CLOCK_BADTIME)
2398 /* waiting could have been interrupted and we can be flushing now */
2399 if (G_UNLIKELY (basesink->flushing))
2402 /* check for unlocked by a state change, we are not flushing so
2403 * we can try to preroll on the current buffer. */
2404 if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED)) {
2405 GST_DEBUG_OBJECT (basesink, "unscheduled, waiting some more");
2406 priv->call_preroll = TRUE;
2410 /* successful syncing done, record observation */
2411 priv->current_jitter = jitter;
2413 /* check if the object should be dropped */
2414 *late = gst_base_sink_is_too_late (basesink, obj, rstart, rstop,
2423 GST_DEBUG_OBJECT (basesink, "skipped stepped object %p", obj);
2429 GST_DEBUG_OBJECT (basesink, "non syncable object %p", obj);
2434 GST_DEBUG_OBJECT (basesink, "dropped because of QoS %p", obj);
2440 GST_DEBUG_OBJECT (basesink, "we are flushing");
2441 return GST_FLOW_WRONG_STATE;
2445 GST_DEBUG_OBJECT (basesink, "preroll failed");
2452 gst_base_sink_send_qos (GstBaseSink * basesink, GstQOSType type,
2453 gdouble proportion, GstClockTime time, GstClockTimeDiff diff)
2458 /* generate Quality-of-Service event */
2459 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2460 "qos: type %d, proportion: %lf, diff %" G_GINT64_FORMAT ", timestamp %"
2461 GST_TIME_FORMAT, type, proportion, diff, GST_TIME_ARGS (time));
2463 event = gst_event_new_qos (type, proportion, diff, time);
2466 res = gst_pad_push_event (basesink->sinkpad, event);
2472 gst_base_sink_perform_qos (GstBaseSink * sink, gboolean dropped)
2474 GstBaseSinkPrivate *priv;
2475 GstClockTime start, stop;
2476 GstClockTimeDiff jitter;
2477 GstClockTime pt, entered, left;
2478 GstClockTime duration;
2483 start = priv->current_rstart;
2485 if (priv->current_step.valid)
2488 /* if Quality-of-Service disabled, do nothing */
2489 if (!g_atomic_int_get (&priv->qos_enabled) ||
2490 !GST_CLOCK_TIME_IS_VALID (start))
2493 stop = priv->current_rstop;
2494 jitter = priv->current_jitter;
2497 /* this is the time the buffer entered the sink */
2498 if (start < -jitter)
2501 entered = start + jitter;
2504 /* this is the time the buffer entered the sink */
2505 entered = start + jitter;
2506 /* this is the time the buffer left the sink */
2507 left = start + jitter;
2510 /* calculate duration of the buffer */
2511 if (GST_CLOCK_TIME_IS_VALID (stop) && stop != start)
2512 duration = stop - start;
2514 duration = priv->avg_in_diff;
2516 /* if we have the time when the last buffer left us, calculate
2517 * processing time */
2518 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2519 if (entered > priv->last_left) {
2520 pt = entered - priv->last_left;
2528 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "start: %" GST_TIME_FORMAT
2529 ", stop %" GST_TIME_FORMAT ", entered %" GST_TIME_FORMAT ", left %"
2530 GST_TIME_FORMAT ", pt: %" GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT
2531 ",jitter %" G_GINT64_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (stop),
2532 GST_TIME_ARGS (entered), GST_TIME_ARGS (left), GST_TIME_ARGS (pt),
2533 GST_TIME_ARGS (duration), jitter);
2535 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "avg_duration: %" GST_TIME_FORMAT
2536 ", avg_pt: %" GST_TIME_FORMAT ", avg_rate: %g",
2537 GST_TIME_ARGS (priv->avg_duration), GST_TIME_ARGS (priv->avg_pt),
2540 /* collect running averages. for first observations, we copy the
2542 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_duration))
2543 priv->avg_duration = duration;
2545 priv->avg_duration = UPDATE_RUNNING_AVG (priv->avg_duration, duration);
2547 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_pt))
2550 priv->avg_pt = UPDATE_RUNNING_AVG (priv->avg_pt, pt);
2552 if (priv->avg_duration != 0)
2554 gst_guint64_to_gdouble (priv->avg_pt) /
2555 gst_guint64_to_gdouble (priv->avg_duration);
2559 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2560 if (dropped || priv->avg_rate < 0.0) {
2561 priv->avg_rate = rate;
2564 priv->avg_rate = UPDATE_RUNNING_AVG_N (priv->avg_rate, rate);
2566 priv->avg_rate = UPDATE_RUNNING_AVG_P (priv->avg_rate, rate);
2570 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink,
2571 "updated: avg_duration: %" GST_TIME_FORMAT ", avg_pt: %" GST_TIME_FORMAT
2572 ", avg_rate: %g", GST_TIME_ARGS (priv->avg_duration),
2573 GST_TIME_ARGS (priv->avg_pt), priv->avg_rate);
2576 if (priv->avg_rate >= 0.0) {
2578 GstClockTimeDiff diff;
2580 /* if we have a valid rate, start sending QoS messages */
2581 if (priv->current_jitter < 0) {
2582 /* make sure we never go below 0 when adding the jitter to the
2584 if (priv->current_rstart < -priv->current_jitter)
2585 priv->current_jitter = -priv->current_rstart;
2588 if (priv->throttle_time > 0) {
2589 diff = priv->throttle_time;
2590 type = GST_QOS_TYPE_THROTTLE;
2592 diff = priv->current_jitter;
2594 type = GST_QOS_TYPE_OVERFLOW;
2596 type = GST_QOS_TYPE_UNDERFLOW;
2599 gst_base_sink_send_qos (sink, type, priv->avg_rate, priv->current_rstart,
2603 /* record when this buffer will leave us */
2604 priv->last_left = left;
2607 /* reset all qos measuring */
2609 gst_base_sink_reset_qos (GstBaseSink * sink)
2611 GstBaseSinkPrivate *priv;
2615 priv->last_render_time = GST_CLOCK_TIME_NONE;
2616 priv->prev_rstart = GST_CLOCK_TIME_NONE;
2617 priv->earliest_in_time = GST_CLOCK_TIME_NONE;
2618 priv->last_left = GST_CLOCK_TIME_NONE;
2619 priv->avg_duration = GST_CLOCK_TIME_NONE;
2620 priv->avg_pt = GST_CLOCK_TIME_NONE;
2621 priv->avg_rate = -1.0;
2622 priv->avg_render = GST_CLOCK_TIME_NONE;
2623 priv->avg_in_diff = GST_CLOCK_TIME_NONE;
2629 /* Checks if the object was scheduled too late.
2631 * rstart/rstop contain the running_time start and stop values
2634 * status and jitter contain the return values from the clock wait.
2636 * returns TRUE if the buffer was too late.
2639 gst_base_sink_is_too_late (GstBaseSink * basesink, GstMiniObject * obj,
2640 GstClockTime rstart, GstClockTime rstop,
2641 GstClockReturn status, GstClockTimeDiff jitter)
2644 guint64 max_lateness;
2645 GstBaseSinkPrivate *priv;
2647 priv = basesink->priv;
2651 /* only for objects that were too late */
2652 if (G_LIKELY (status != GST_CLOCK_EARLY))
2655 max_lateness = basesink->max_lateness;
2657 /* check if frame dropping is enabled */
2658 if (max_lateness == -1)
2661 /* only check for buffers */
2662 if (G_UNLIKELY (!GST_IS_BUFFER (obj)))
2665 /* can't do check if we don't have a timestamp */
2666 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (rstart)))
2669 /* we can add a valid stop time */
2670 if (GST_CLOCK_TIME_IS_VALID (rstop))
2671 max_lateness += rstop;
2673 max_lateness += rstart;
2674 /* no stop time, use avg frame diff */
2675 if (priv->avg_in_diff != -1)
2676 max_lateness += priv->avg_in_diff;
2679 /* if the jitter bigger than duration and lateness we are too late */
2680 if ((late = rstart + jitter > max_lateness)) {
2681 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2682 "buffer is too late %" GST_TIME_FORMAT
2683 " > %" GST_TIME_FORMAT, GST_TIME_ARGS (rstart + jitter),
2684 GST_TIME_ARGS (max_lateness));
2685 /* !!emergency!!, if we did not receive anything valid for more than a
2686 * second, render it anyway so the user sees something */
2687 if (GST_CLOCK_TIME_IS_VALID (priv->last_render_time) &&
2688 rstart - priv->last_render_time > GST_SECOND) {
2690 GST_ELEMENT_WARNING (basesink, CORE, CLOCK,
2691 (_("A lot of buffers are being dropped.")),
2692 ("There may be a timestamping problem, or this computer is too slow."));
2693 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2694 "**emergency** last buffer at %" GST_TIME_FORMAT " > GST_SECOND",
2695 GST_TIME_ARGS (priv->last_render_time));
2700 if (!late || !GST_CLOCK_TIME_IS_VALID (priv->last_render_time)) {
2701 priv->last_render_time = rstart;
2702 /* the next allowed input timestamp */
2703 if (priv->throttle_time > 0)
2704 priv->earliest_in_time = rstart + priv->throttle_time;
2711 GST_DEBUG_OBJECT (basesink, "object was scheduled in time");
2716 GST_DEBUG_OBJECT (basesink, "frame dropping disabled");
2721 GST_DEBUG_OBJECT (basesink, "object is not a buffer");
2726 GST_DEBUG_OBJECT (basesink, "buffer has no timestamp");
2731 /* called before and after calling the render vmethod. It keeps track of how
2732 * much time was spent in the render method and is used to check if we are
2735 gst_base_sink_do_render_stats (GstBaseSink * basesink, gboolean start)
2737 GstBaseSinkPrivate *priv;
2739 priv = basesink->priv;
2742 priv->start = gst_util_get_timestamp ();
2744 GstClockTime elapsed;
2746 priv->stop = gst_util_get_timestamp ();
2748 elapsed = GST_CLOCK_DIFF (priv->start, priv->stop);
2750 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_render))
2751 priv->avg_render = elapsed;
2753 priv->avg_render = UPDATE_RUNNING_AVG (priv->avg_render, elapsed);
2755 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2756 "avg_render: %" GST_TIME_FORMAT, GST_TIME_ARGS (priv->avg_render));
2760 /* with STREAM_LOCK, PREROLL_LOCK,
2762 * Synchronize the object on the clock and then render it.
2764 * takes ownership of obj.
2766 static GstFlowReturn
2767 gst_base_sink_render_object (GstBaseSink * basesink, GstPad * pad,
2768 guint8 obj_type, gpointer obj)
2771 GstBaseSinkClass *bclass;
2772 gboolean late, step_end;
2774 GstBaseSinkPrivate *priv;
2776 priv = basesink->priv;
2778 if (OBJ_IS_BUFFERLIST (obj_type)) {
2780 * If buffer list, use the first group buffer within the list
2783 sync_obj = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0);
2784 g_assert (NULL != sync_obj);
2793 /* synchronize this object, non syncable objects return OK
2796 gst_base_sink_do_sync (basesink, pad, sync_obj, &late, &step_end,
2798 if (G_UNLIKELY (ret != GST_FLOW_OK))
2801 /* and now render, event or buffer/buffer list. */
2802 if (G_LIKELY (OBJ_IS_BUFFERFULL (obj_type))) {
2803 /* drop late buffers unconditionally, let's hope it's unlikely */
2804 if (G_UNLIKELY (late))
2807 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2809 if (G_LIKELY ((OBJ_IS_BUFFERLIST (obj_type) && bclass->render_list) ||
2810 (!OBJ_IS_BUFFERLIST (obj_type) && bclass->render))) {
2813 /* read once, to get same value before and after */
2814 do_qos = g_atomic_int_get (&priv->qos_enabled);
2816 GST_DEBUG_OBJECT (basesink, "rendering object %p", obj);
2818 /* record rendering time for QoS and stats */
2820 gst_base_sink_do_render_stats (basesink, TRUE);
2822 if (!OBJ_IS_BUFFERLIST (obj_type)) {
2825 /* For buffer lists do not set last buffer. Creating buffer
2826 * with meaningful data can be done only with memcpy which will
2827 * significantly affect performance */
2828 buf = GST_BUFFER_CAST (obj);
2829 gst_base_sink_set_last_buffer (basesink, buf);
2831 ret = bclass->render (basesink, buf);
2833 GstBufferList *buflist;
2835 buflist = GST_BUFFER_LIST_CAST (obj);
2837 ret = bclass->render_list (basesink, buflist);
2841 gst_base_sink_do_render_stats (basesink, FALSE);
2843 if (ret == GST_FLOW_STEP)
2846 if (G_UNLIKELY (basesink->flushing))
2851 } else if (G_LIKELY (OBJ_IS_EVENT (obj_type))) {
2852 GstEvent *event = GST_EVENT_CAST (obj);
2853 gboolean event_res = TRUE;
2856 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2858 type = GST_EVENT_TYPE (event);
2860 GST_DEBUG_OBJECT (basesink, "rendering event %p, type %s", obj,
2861 gst_event_type_get_name (type));
2864 event_res = bclass->event (basesink, event);
2866 /* when we get here we could be flushing again when the event handler calls
2867 * _wait_eos(). We have to ignore this object in that case. */
2868 if (G_UNLIKELY (basesink->flushing))
2871 if (G_LIKELY (event_res)) {
2874 seqnum = basesink->priv->seqnum = gst_event_get_seqnum (event);
2875 GST_DEBUG_OBJECT (basesink, "Got seqnum #%" G_GUINT32_FORMAT, seqnum);
2880 GstMessage *message;
2882 /* the EOS event is completely handled so we mark
2883 * ourselves as being in the EOS state. eos is also
2884 * protected by the object lock so we can read it when
2885 * answering the POSITION query. */
2886 GST_OBJECT_LOCK (basesink);
2887 basesink->eos = TRUE;
2888 GST_OBJECT_UNLOCK (basesink);
2890 /* ok, now we can post the message */
2891 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
2893 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
2894 gst_message_set_seqnum (message, seqnum);
2895 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
2898 case GST_EVENT_SEGMENT:
2899 /* configure the segment */
2900 /* The segment is protected with both the STREAM_LOCK and the OBJECT_LOCK.
2901 * We protect with the OBJECT_LOCK so that we can use the values to
2902 * safely answer a POSITION query. */
2903 GST_OBJECT_LOCK (basesink);
2904 /* the newsegment event is needed to bring the buffer timestamps to the
2905 * stream time and to drop samples outside of the playback segment. */
2906 gst_event_copy_segment (event, &basesink->segment);
2907 GST_DEBUG_OBJECT (basesink, "configured SEGMENT %" GST_SEGMENT_FORMAT,
2908 &basesink->segment);
2909 basesink->have_newsegment = TRUE;
2910 GST_OBJECT_UNLOCK (basesink);
2914 GstTagList *taglist;
2916 gst_event_parse_tag (event, &taglist);
2918 gst_element_post_message (GST_ELEMENT_CAST (basesink),
2919 gst_message_new_tag (GST_OBJECT_CAST (basesink),
2920 gst_tag_list_copy (taglist)));
2923 case GST_EVENT_SINK_MESSAGE:
2925 GstMessage *msg = NULL;
2927 gst_event_parse_sink_message (event, &msg);
2930 gst_element_post_message (GST_ELEMENT_CAST (basesink), msg);
2937 g_return_val_if_reached (GST_FLOW_ERROR);
2942 /* the step ended, check if we need to activate a new step */
2943 GST_DEBUG_OBJECT (basesink, "step ended");
2944 stop_stepping (basesink, &basesink->segment, &priv->current_step,
2945 priv->current_rstart, priv->current_rstop, basesink->eos);
2949 gst_base_sink_perform_qos (basesink, late);
2951 GST_DEBUG_OBJECT (basesink, "object unref after render %p", obj);
2952 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
2958 GST_DEBUG_OBJECT (basesink, "do_sync returned %s", gst_flow_get_name (ret));
2964 GST_DEBUG_OBJECT (basesink, "buffer late, dropping");
2966 if (g_atomic_int_get (&priv->qos_enabled)) {
2967 GstMessage *qos_msg;
2968 GstClockTime timestamp, duration;
2970 timestamp = GST_BUFFER_TIMESTAMP (GST_BUFFER_CAST (sync_obj));
2971 duration = GST_BUFFER_DURATION (GST_BUFFER_CAST (sync_obj));
2973 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2974 "qos: dropped buffer rt %" GST_TIME_FORMAT ", st %" GST_TIME_FORMAT
2975 ", ts %" GST_TIME_FORMAT ", dur %" GST_TIME_FORMAT,
2976 GST_TIME_ARGS (priv->current_rstart),
2977 GST_TIME_ARGS (priv->current_sstart), GST_TIME_ARGS (timestamp),
2978 GST_TIME_ARGS (duration));
2979 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2980 "qos: rendered %" G_GUINT64_FORMAT ", dropped %" G_GUINT64_FORMAT,
2981 priv->rendered, priv->dropped);
2984 gst_message_new_qos (GST_OBJECT_CAST (basesink), basesink->sync,
2985 priv->current_rstart, priv->current_sstart, timestamp, duration);
2986 gst_message_set_qos_values (qos_msg, priv->current_jitter, priv->avg_rate,
2988 gst_message_set_qos_stats (qos_msg, GST_FORMAT_BUFFERS, priv->rendered,
2990 gst_element_post_message (GST_ELEMENT_CAST (basesink), qos_msg);
2996 GST_DEBUG_OBJECT (basesink, "we are flushing, ignore object");
2997 gst_mini_object_unref (obj);
2998 return GST_FLOW_WRONG_STATE;
3002 /* with STREAM_LOCK, PREROLL_LOCK
3004 * Perform preroll on the given object. For buffers this means
3005 * calling the preroll subclass method.
3006 * If that succeeds, the state will be commited.
3008 * function does not take ownership of obj.
3010 static GstFlowReturn
3011 gst_base_sink_preroll_object (GstBaseSink * basesink, guint8 obj_type,
3012 GstMiniObject * obj)
3016 GST_DEBUG_OBJECT (basesink, "prerolling object %p", obj);
3018 /* if it's a buffer, we need to call the preroll method */
3019 if (G_LIKELY (OBJ_IS_BUFFERFULL (obj_type) && basesink->priv->call_preroll)) {
3020 GstBaseSinkClass *bclass;
3023 if (OBJ_IS_BUFFERLIST (obj_type)) {
3024 buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0);
3025 g_assert (NULL != buf);
3027 buf = GST_BUFFER_CAST (obj);
3030 GST_DEBUG_OBJECT (basesink, "preroll buffer %" GST_TIME_FORMAT,
3031 GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buf)));
3034 * For buffer lists do not set last buffer. Creating buffer
3035 * with meaningful data can be done only with memcpy which will
3036 * significantly affect performance
3038 if (!OBJ_IS_BUFFERLIST (obj_type)) {
3039 gst_base_sink_set_last_buffer (basesink, buf);
3042 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3043 if (bclass->preroll)
3044 if ((ret = bclass->preroll (basesink, buf)) != GST_FLOW_OK)
3045 goto preroll_failed;
3047 basesink->priv->call_preroll = FALSE;
3051 if (G_LIKELY (basesink->playing_async)) {
3052 if (G_UNLIKELY (!gst_base_sink_commit_state (basesink)))
3061 GST_DEBUG_OBJECT (basesink, "preroll failed, abort state");
3062 gst_element_abort_state (GST_ELEMENT_CAST (basesink));
3067 GST_DEBUG_OBJECT (basesink, "stopping while commiting state");
3068 return GST_FLOW_WRONG_STATE;
3073 gst_base_sink_flush_start (GstBaseSink * basesink, GstPad * pad)
3075 /* make sure we are not blocked on the clock also clear any pending
3077 gst_base_sink_set_flushing (basesink, pad, TRUE);
3079 /* we grab the stream lock but that is not needed since setting the
3080 * sink to flushing would make sure no state commit is being done
3082 GST_PAD_STREAM_LOCK (pad);
3083 gst_base_sink_reset_qos (basesink);
3084 /* and we need to commit our state again on the next
3085 * prerolled buffer */
3086 basesink->playing_async = TRUE;
3087 if (basesink->priv->async_enabled) {
3088 gst_element_lost_state (GST_ELEMENT_CAST (basesink));
3090 /* start time reset in above case as well;
3091 * arranges for a.o. proper position reporting when flushing in PAUSED */
3092 gst_element_set_start_time (GST_ELEMENT_CAST (basesink), 0);
3093 basesink->priv->have_latency = TRUE;
3095 gst_base_sink_set_last_buffer (basesink, NULL);
3096 GST_PAD_STREAM_UNLOCK (pad);
3100 gst_base_sink_flush_stop (GstBaseSink * basesink, GstPad * pad,
3101 gboolean reset_time)
3103 /* unset flushing so we can accept new data, this also flushes out any EOS
3105 gst_base_sink_set_flushing (basesink, pad, FALSE);
3107 /* for position reporting */
3108 GST_OBJECT_LOCK (basesink);
3109 basesink->priv->current_sstart = GST_CLOCK_TIME_NONE;
3110 basesink->priv->current_sstop = GST_CLOCK_TIME_NONE;
3111 basesink->priv->eos_rtime = GST_CLOCK_TIME_NONE;
3112 basesink->priv->call_preroll = TRUE;
3113 basesink->priv->current_step.valid = FALSE;
3114 basesink->priv->pending_step.valid = FALSE;
3115 if (basesink->pad_mode == GST_PAD_MODE_PUSH) {
3116 /* we need new segment info after the flush. */
3117 basesink->have_newsegment = FALSE;
3119 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
3122 basesink->priv->reset_time = reset_time;
3123 GST_OBJECT_UNLOCK (basesink);
3127 gst_base_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
3129 GstBaseSink *basesink;
3130 gboolean result = TRUE;
3131 GstBaseSinkClass *bclass;
3133 basesink = GST_BASE_SINK (parent);
3134 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3136 GST_DEBUG_OBJECT (basesink, "received event %p %" GST_PTR_FORMAT, event,
3139 switch (GST_EVENT_TYPE (event)) {
3144 GST_BASE_SINK_PREROLL_LOCK (basesink);
3145 if (G_UNLIKELY (basesink->flushing))
3148 if (G_UNLIKELY (basesink->priv->received_eos))
3151 /* we set the received EOS flag here so that we can use it when testing if
3152 * we are prerolled and to refuse more buffers. */
3153 basesink->priv->received_eos = TRUE;
3155 /* EOS is a prerollable object, we call the unlocked version because it
3156 * does not check the received_eos flag. */
3157 ret = gst_base_sink_render_object (basesink, pad,
3158 _PR_IS_EVENT, GST_MINI_OBJECT_CAST (event));
3159 if (G_UNLIKELY (ret != GST_FLOW_OK))
3162 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3165 case GST_EVENT_CAPS:
3169 GST_DEBUG_OBJECT (basesink, "caps %p", event);
3171 gst_event_parse_caps (event, &caps);
3172 if (bclass->set_caps)
3173 result = bclass->set_caps (basesink, caps);
3176 GST_OBJECT_LOCK (basesink);
3177 gst_caps_replace (&basesink->priv->caps, caps);
3178 GST_OBJECT_UNLOCK (basesink);
3180 gst_event_unref (event);
3183 case GST_EVENT_SEGMENT:
3187 GST_DEBUG_OBJECT (basesink, "segment %p", event);
3189 GST_BASE_SINK_PREROLL_LOCK (basesink);
3190 if (G_UNLIKELY (basesink->flushing))
3193 if (G_UNLIKELY (basesink->priv->received_eos))
3197 gst_base_sink_render_object (basesink, pad,
3198 _PR_IS_EVENT, GST_MINI_OBJECT_CAST (event));
3199 if (G_UNLIKELY (ret != GST_FLOW_OK))
3202 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3205 case GST_EVENT_FLUSH_START:
3207 bclass->event (basesink, event);
3209 GST_DEBUG_OBJECT (basesink, "flush-start %p", event);
3211 gst_base_sink_flush_start (basesink, pad);
3213 gst_event_unref (event);
3215 case GST_EVENT_FLUSH_STOP:
3217 gboolean reset_time;
3220 bclass->event (basesink, event);
3222 gst_event_parse_flush_stop (event, &reset_time);
3223 GST_DEBUG_OBJECT (basesink, "flush-stop %p, reset_time: %d", event,
3226 gst_base_sink_flush_stop (basesink, pad, reset_time);
3228 gst_event_unref (event);
3232 /* other events are sent to queue or subclass depending on if they
3233 * are serialized. */
3234 if (GST_EVENT_IS_SERIALIZED (event)) {
3237 GST_BASE_SINK_PREROLL_LOCK (basesink);
3238 if (G_UNLIKELY (basesink->flushing))
3241 if (G_UNLIKELY (basesink->priv->received_eos))
3244 ret = gst_base_sink_render_object (basesink, pad, _PR_IS_EVENT,
3245 GST_MINI_OBJECT_CAST (event));
3246 if (G_UNLIKELY (ret != GST_FLOW_OK))
3249 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3252 bclass->event (basesink, event);
3253 gst_event_unref (event);
3263 GST_DEBUG_OBJECT (basesink, "we are flushing");
3264 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3266 gst_event_unref (event);
3272 GST_DEBUG_OBJECT (basesink, "Event received after EOS, dropping");
3273 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3275 gst_event_unref (event);
3280 /* default implementation to calculate the start and end
3281 * timestamps on a buffer, subclasses can override
3284 gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
3285 GstClockTime * start, GstClockTime * end)
3287 GstClockTime timestamp, duration;
3289 timestamp = GST_BUFFER_TIMESTAMP (buffer);
3290 if (GST_CLOCK_TIME_IS_VALID (timestamp)) {
3292 /* get duration to calculate end time */
3293 duration = GST_BUFFER_DURATION (buffer);
3294 if (GST_CLOCK_TIME_IS_VALID (duration)) {
3295 *end = timestamp + duration;
3301 /* must be called with PREROLL_LOCK */
3303 gst_base_sink_needs_preroll (GstBaseSink * basesink)
3305 gboolean is_prerolled, res;
3307 /* we have 2 cases where the PREROLL_LOCK is released:
3308 * 1) we are blocking in the PREROLL_LOCK and thus are prerolled.
3309 * 2) we are syncing on the clock
3311 is_prerolled = basesink->have_preroll || basesink->priv->received_eos;
3312 res = !is_prerolled;
3314 GST_DEBUG_OBJECT (basesink, "have_preroll: %d, EOS: %d => needs preroll: %d",
3315 basesink->have_preroll, basesink->priv->received_eos, res);
3320 /* with STREAM_LOCK, PREROLL_LOCK
3322 * Takes a buffer and compare the timestamps with the last segment.
3323 * If the buffer falls outside of the segment boundaries, drop it.
3324 * Else queue the buffer for preroll and rendering.
3326 * This function takes ownership of the buffer.
3328 static GstFlowReturn
3329 gst_base_sink_chain_unlocked (GstBaseSink * basesink, GstPad * pad,
3330 guint8 obj_type, gpointer obj)
3332 GstBaseSinkClass *bclass;
3333 GstFlowReturn result;
3334 GstClockTime start = GST_CLOCK_TIME_NONE, end = GST_CLOCK_TIME_NONE;
3335 GstSegment *segment;
3336 GstBuffer *time_buf;
3338 if (G_UNLIKELY (basesink->flushing))
3341 if (G_UNLIKELY (basesink->priv->received_eos))
3344 if (OBJ_IS_BUFFERLIST (obj_type)) {
3345 time_buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0);
3346 g_assert (NULL != time_buf);
3348 time_buf = GST_BUFFER_CAST (obj);
3351 /* for code clarity */
3352 segment = &basesink->segment;
3354 if (G_UNLIKELY (!basesink->have_newsegment)) {
3357 sync = gst_base_sink_get_sync (basesink);
3359 GST_ELEMENT_WARNING (basesink, STREAM, FAILED,
3360 (_("Internal data flow problem.")),
3361 ("Received buffer without a new-segment. Assuming timestamps start from 0."));
3364 /* this means this sink will assume timestamps start from 0 */
3365 GST_OBJECT_LOCK (basesink);
3368 basesink->segment.start = 0;
3369 basesink->segment.stop = -1;
3370 basesink->have_newsegment = TRUE;
3371 GST_OBJECT_UNLOCK (basesink);
3374 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3376 /* check if the buffer needs to be dropped, we first ask the subclass for the
3378 if (bclass->get_times)
3379 bclass->get_times (basesink, time_buf, &start, &end);
3381 if (!GST_CLOCK_TIME_IS_VALID (start)) {
3382 /* if the subclass does not want sync, we use our own values so that we at
3383 * least clip the buffer to the segment */
3384 gst_base_sink_get_times (basesink, time_buf, &start, &end);
3387 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
3388 ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (end));
3390 /* a dropped buffer does not participate in anything */
3391 if (GST_CLOCK_TIME_IS_VALID (start) && (segment->format == GST_FORMAT_TIME)) {
3392 if (G_UNLIKELY (!gst_segment_clip (segment,
3393 GST_FORMAT_TIME, start, end, NULL, NULL)))
3394 goto out_of_segment;
3397 /* now we can process the buffer in the queue, this function takes ownership
3399 result = gst_base_sink_render_object (basesink, pad, obj_type, obj);
3405 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3406 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3407 return GST_FLOW_WRONG_STATE;
3411 GST_DEBUG_OBJECT (basesink, "we are EOS, dropping object, return EOS");
3412 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3413 return GST_FLOW_EOS;
3417 GST_DEBUG_OBJECT (basesink, "dropping buffer, out of clipping segment");
3418 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3425 static GstFlowReturn
3426 gst_base_sink_chain_main (GstBaseSink * basesink, GstPad * pad,
3427 guint8 obj_type, gpointer obj)
3429 GstFlowReturn result;
3431 if (G_UNLIKELY (basesink->pad_mode != GST_PAD_MODE_PUSH))
3434 GST_BASE_SINK_PREROLL_LOCK (basesink);
3435 result = gst_base_sink_chain_unlocked (basesink, pad, obj_type, obj);
3436 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3444 GST_OBJECT_LOCK (pad);
3445 GST_WARNING_OBJECT (basesink,
3446 "Push on pad %s:%s, but it was not activated in push mode",
3447 GST_DEBUG_PAD_NAME (pad));
3448 GST_OBJECT_UNLOCK (pad);
3449 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3450 /* we don't post an error message this will signal to the peer
3451 * pushing that EOS is reached. */
3452 result = GST_FLOW_EOS;
3457 static GstFlowReturn
3458 gst_base_sink_chain (GstPad * pad, GstObject * parent, GstBuffer * buf)
3460 GstBaseSink *basesink;
3462 basesink = GST_BASE_SINK (parent);
3464 return gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFER, buf);
3467 static GstFlowReturn
3468 gst_base_sink_chain_list (GstPad * pad, GstObject * parent,
3469 GstBufferList * list)
3471 GstBaseSink *basesink;
3472 GstBaseSinkClass *bclass;
3473 GstFlowReturn result;
3475 basesink = GST_BASE_SINK (parent);
3476 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3478 if (G_LIKELY (bclass->render_list)) {
3479 result = gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFERLIST, list);
3484 GST_INFO_OBJECT (pad, "chaining each group in list as a merged buffer");
3486 len = gst_buffer_list_length (list);
3488 result = GST_FLOW_OK;
3489 for (i = 0; i < len; i++) {
3490 buffer = gst_buffer_list_get (list, 0);
3491 result = gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFER,
3492 gst_buffer_ref (buffer));
3493 if (result != GST_FLOW_OK)
3496 gst_buffer_list_unref (list);
3503 gst_base_sink_default_do_seek (GstBaseSink * sink, GstSegment * segment)
3505 gboolean res = TRUE;
3507 /* update our offset if the start/stop position was updated */
3508 if (segment->format == GST_FORMAT_BYTES) {
3509 segment->time = segment->start;
3510 } else if (segment->start == 0) {
3511 /* seek to start, we can implement a default for this. */
3515 GST_INFO_OBJECT (sink, "Can't do a default seek");
3521 #define SEEK_TYPE_IS_RELATIVE(t) (((t) != GST_SEEK_TYPE_NONE) && ((t) != GST_SEEK_TYPE_SET))
3524 gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
3525 GstEvent * event, GstSegment * segment)
3527 /* By default, we try one of 2 things:
3528 * - For absolute seek positions, convert the requested position to our
3529 * configured processing format and place it in the output segment \
3530 * - For relative seek positions, convert our current (input) values to the
3531 * seek format, adjust by the relative seek offset and then convert back to
3532 * the processing format
3534 GstSeekType cur_type, stop_type;
3537 GstFormat seek_format;
3540 gboolean res = TRUE;
3542 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3543 &cur_type, &cur, &stop_type, &stop);
3545 if (seek_format == segment->format) {
3546 gst_segment_do_seek (segment, rate, seek_format, flags,
3547 cur_type, cur, stop_type, stop, &update);
3551 if (cur_type != GST_SEEK_TYPE_NONE) {
3552 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3554 gst_pad_query_convert (sink->sinkpad, seek_format, cur, segment->format,
3556 cur_type = GST_SEEK_TYPE_SET;
3559 if (res && stop_type != GST_SEEK_TYPE_NONE) {
3560 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3562 gst_pad_query_convert (sink->sinkpad, seek_format, stop,
3563 segment->format, &stop);
3564 stop_type = GST_SEEK_TYPE_SET;
3567 /* And finally, configure our output segment in the desired format */
3568 gst_segment_do_seek (segment, rate, segment->format, flags, cur_type, cur,
3569 stop_type, stop, &update);
3578 GST_DEBUG_OBJECT (sink, "undefined format given, seek aborted.");
3583 /* perform a seek, only executed in pull mode */
3585 gst_base_sink_perform_seek (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3589 GstFormat seek_format, dest_format;
3591 GstSeekType cur_type, stop_type;
3592 gboolean seekseg_configured = FALSE;
3594 gboolean update, res = TRUE;
3595 GstSegment seeksegment;
3597 dest_format = sink->segment.format;
3600 GST_DEBUG_OBJECT (sink, "performing seek with event %p", event);
3601 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3602 &cur_type, &cur, &stop_type, &stop);
3604 flush = flags & GST_SEEK_FLAG_FLUSH;
3606 GST_DEBUG_OBJECT (sink, "performing seek without event");
3611 GST_DEBUG_OBJECT (sink, "flushing upstream");
3612 gst_pad_push_event (pad, gst_event_new_flush_start ());
3613 gst_base_sink_flush_start (sink, pad);
3615 GST_DEBUG_OBJECT (sink, "pausing pulling thread");
3618 GST_PAD_STREAM_LOCK (pad);
3620 /* If we configured the seeksegment above, don't overwrite it now. Otherwise
3621 * copy the current segment info into the temp segment that we can actually
3622 * attempt the seek with. We only update the real segment if the seek succeeds. */
3623 if (!seekseg_configured) {
3624 memcpy (&seeksegment, &sink->segment, sizeof (GstSegment));
3626 /* now configure the final seek segment */
3628 if (sink->segment.format != seek_format) {
3629 /* OK, here's where we give the subclass a chance to convert the relative
3630 * seek into an absolute one in the processing format. We set up any
3631 * absolute seek above, before taking the stream lock. */
3632 if (!gst_base_sink_default_prepare_seek_segment (sink, event,
3634 GST_DEBUG_OBJECT (sink,
3635 "Preparing the seek failed after flushing. " "Aborting seek");
3639 /* The seek format matches our processing format, no need to ask the
3640 * the subclass to configure the segment. */
3641 gst_segment_do_seek (&seeksegment, rate, seek_format, flags,
3642 cur_type, cur, stop_type, stop, &update);
3645 /* Else, no seek event passed, so we're just (re)starting the
3650 GST_DEBUG_OBJECT (sink, "segment configured from %" G_GINT64_FORMAT
3651 " to %" G_GINT64_FORMAT ", position %" G_GINT64_FORMAT,
3652 seeksegment.start, seeksegment.stop, seeksegment.position);
3654 /* do the seek, segment.position contains the new position. */
3655 res = gst_base_sink_default_do_seek (sink, &seeksegment);
3660 GST_DEBUG_OBJECT (sink, "stop flushing upstream");
3661 gst_pad_push_event (pad, gst_event_new_flush_stop (TRUE));
3662 gst_base_sink_flush_stop (sink, pad, TRUE);
3663 } else if (res && sink->running) {
3664 /* we are running the current segment and doing a non-flushing seek,
3665 * close the segment first based on the position. */
3666 GST_DEBUG_OBJECT (sink, "closing running segment %" G_GINT64_FORMAT
3667 " to %" G_GINT64_FORMAT, sink->segment.start, sink->segment.position);
3670 /* The subclass must have converted the segment to the processing format
3672 if (res && seeksegment.format != dest_format) {
3673 GST_DEBUG_OBJECT (sink, "Subclass failed to prepare a seek segment "
3674 "in the correct format. Aborting seek.");
3678 /* if successful seek, we update our real segment and push
3679 * out the new segment. */
3681 gst_segment_copy_into (&seeksegment, &sink->segment);
3683 if (sink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3684 gst_element_post_message (GST_ELEMENT (sink),
3685 gst_message_new_segment_start (GST_OBJECT (sink),
3686 sink->segment.format, sink->segment.position));
3690 sink->priv->discont = TRUE;
3691 sink->running = TRUE;
3693 GST_PAD_STREAM_UNLOCK (pad);
3699 set_step_info (GstBaseSink * sink, GstStepInfo * current, GstStepInfo * pending,
3700 guint seqnum, GstFormat format, guint64 amount, gdouble rate,
3701 gboolean flush, gboolean intermediate)
3703 GST_OBJECT_LOCK (sink);
3704 pending->seqnum = seqnum;
3705 pending->format = format;
3706 pending->amount = amount;
3707 pending->position = 0;
3708 pending->rate = rate;
3709 pending->flush = flush;
3710 pending->intermediate = intermediate;
3711 pending->valid = TRUE;
3712 /* flush invalidates the current stepping segment */
3714 current->valid = FALSE;
3715 GST_OBJECT_UNLOCK (sink);
3719 gst_base_sink_perform_step (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3721 GstBaseSinkPrivate *priv;
3722 GstBaseSinkClass *bclass;
3723 gboolean flush, intermediate;
3728 GstStepInfo *pending, *current;
3729 GstMessage *message;
3731 bclass = GST_BASE_SINK_GET_CLASS (sink);
3734 GST_DEBUG_OBJECT (sink, "performing step with event %p", event);
3736 gst_event_parse_step (event, &format, &amount, &rate, &flush, &intermediate);
3737 seqnum = gst_event_get_seqnum (event);
3739 pending = &priv->pending_step;
3740 current = &priv->current_step;
3742 /* post message first */
3743 message = gst_message_new_step_start (GST_OBJECT (sink), FALSE, format,
3744 amount, rate, flush, intermediate);
3745 gst_message_set_seqnum (message, seqnum);
3746 gst_element_post_message (GST_ELEMENT (sink), message);
3749 /* we need to call ::unlock before locking PREROLL_LOCK
3750 * since we lock it before going into ::render */
3752 bclass->unlock (sink);
3754 GST_BASE_SINK_PREROLL_LOCK (sink);
3755 /* now that we have the PREROLL lock, clear our unlock request */
3756 if (bclass->unlock_stop)
3757 bclass->unlock_stop (sink);
3759 /* update the stepinfo and make it valid */
3760 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3763 if (sink->priv->async_enabled) {
3764 /* and we need to commit our state again on the next
3765 * prerolled buffer */
3766 sink->playing_async = TRUE;
3767 priv->pending_step.need_preroll = TRUE;
3768 sink->need_preroll = FALSE;
3769 gst_element_lost_state (GST_ELEMENT_CAST (sink));
3771 sink->priv->have_latency = TRUE;
3772 sink->need_preroll = FALSE;
3774 priv->current_sstart = GST_CLOCK_TIME_NONE;
3775 priv->current_sstop = GST_CLOCK_TIME_NONE;
3776 priv->eos_rtime = GST_CLOCK_TIME_NONE;
3777 priv->call_preroll = TRUE;
3778 gst_base_sink_set_last_buffer (sink, NULL);
3779 gst_base_sink_reset_qos (sink);
3781 if (sink->clock_id) {
3782 gst_clock_id_unschedule (sink->clock_id);
3785 if (sink->have_preroll) {
3786 GST_DEBUG_OBJECT (sink, "signal waiter");
3787 priv->step_unlock = TRUE;
3788 GST_BASE_SINK_PREROLL_SIGNAL (sink);
3790 GST_BASE_SINK_PREROLL_UNLOCK (sink);
3792 /* update the stepinfo and make it valid */
3793 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3803 gst_base_sink_loop (GstPad * pad)
3806 GstBaseSink *basesink;
3807 GstBuffer *buf = NULL;
3808 GstFlowReturn result;
3812 parent = GST_OBJECT_PARENT (pad);
3813 basesink = GST_BASE_SINK (parent);
3815 g_assert (basesink->pad_mode == GST_PAD_MODE_PULL);
3817 if ((blocksize = basesink->priv->blocksize) == 0)
3820 offset = basesink->segment.position;
3822 GST_DEBUG_OBJECT (basesink, "pulling %" G_GUINT64_FORMAT ", %u",
3825 result = gst_pad_pull_range (pad, offset, blocksize, &buf);
3826 if (G_UNLIKELY (result != GST_FLOW_OK))
3829 if (G_UNLIKELY (buf == NULL))
3832 offset += gst_buffer_get_size (buf);
3834 basesink->segment.position = offset;
3836 GST_BASE_SINK_PREROLL_LOCK (basesink);
3837 result = gst_base_sink_chain_unlocked (basesink, pad, _PR_IS_BUFFER, buf);
3838 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3839 if (G_UNLIKELY (result != GST_FLOW_OK))
3847 GST_LOG_OBJECT (basesink, "pausing task, reason %s",
3848 gst_flow_get_name (result));
3849 gst_pad_pause_task (pad);
3850 if (result == GST_FLOW_EOS) {
3851 /* perform EOS logic */
3852 if (basesink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3853 gst_element_post_message (GST_ELEMENT_CAST (basesink),
3854 gst_message_new_segment_done (GST_OBJECT_CAST (basesink),
3855 basesink->segment.format, basesink->segment.position));
3857 gst_base_sink_event (pad, parent, gst_event_new_eos ());
3859 } else if (result == GST_FLOW_NOT_LINKED || result <= GST_FLOW_EOS) {
3860 /* for fatal errors we post an error message, post the error
3861 * first so the app knows about the error first.
3862 * wrong-state is not a fatal error because it happens due to
3863 * flushing and posting an error message in that case is the
3864 * wrong thing to do, e.g. when basesrc is doing a flushing
3866 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
3867 (_("Internal data stream error.")),
3868 ("stream stopped, reason %s", gst_flow_get_name (result)));
3869 gst_base_sink_event (pad, parent, gst_event_new_eos ());
3875 GST_LOG_OBJECT (basesink, "no buffer, pausing");
3876 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
3877 (_("Internal data flow error.")), ("element returned NULL buffer"));
3878 result = GST_FLOW_ERROR;
3884 gst_base_sink_set_flushing (GstBaseSink * basesink, GstPad * pad,
3887 GstBaseSinkClass *bclass;
3889 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3892 /* unlock any subclasses, we need to do this before grabbing the
3893 * PREROLL_LOCK since we hold this lock before going into ::render. */
3895 bclass->unlock (basesink);
3898 GST_BASE_SINK_PREROLL_LOCK (basesink);
3899 basesink->flushing = flushing;
3901 /* step 1, now that we have the PREROLL lock, clear our unlock request */
3902 if (bclass->unlock_stop)
3903 bclass->unlock_stop (basesink);
3905 /* set need_preroll before we unblock the clock. If the clock is unblocked
3906 * before timing out, we can reuse the buffer for preroll. */
3907 basesink->need_preroll = TRUE;
3909 /* step 2, unblock clock sync (if any) or any other blocking thing */
3910 if (basesink->clock_id) {
3911 gst_clock_id_unschedule (basesink->clock_id);
3914 /* flush out the data thread if it's locked in finish_preroll, this will
3915 * also flush out the EOS state */
3916 GST_DEBUG_OBJECT (basesink,
3917 "flushing out data thread, need preroll to TRUE");
3919 /* we can't have EOS anymore now */
3920 basesink->eos = FALSE;
3921 basesink->priv->received_eos = FALSE;
3922 basesink->have_preroll = FALSE;
3923 basesink->priv->step_unlock = FALSE;
3924 /* can't report latency anymore until we preroll again */
3925 if (basesink->priv->async_enabled) {
3926 GST_OBJECT_LOCK (basesink);
3927 basesink->priv->have_latency = FALSE;
3928 GST_OBJECT_UNLOCK (basesink);
3930 /* and signal any waiters now */
3931 GST_BASE_SINK_PREROLL_SIGNAL (basesink);
3933 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3939 gst_base_sink_default_activate_pull (GstBaseSink * basesink, gboolean active)
3945 result = gst_pad_start_task (basesink->sinkpad,
3946 (GstTaskFunction) gst_base_sink_loop, basesink->sinkpad);
3948 /* step 2, make sure streaming finishes */
3949 result = gst_pad_stop_task (basesink->sinkpad);
3956 gst_base_sink_pad_activate (GstPad * pad, GstObject * parent)
3958 gboolean result = FALSE;
3959 GstBaseSink *basesink;
3963 basesink = GST_BASE_SINK (parent);
3965 GST_DEBUG_OBJECT (basesink, "Trying pull mode first");
3967 gst_base_sink_set_flushing (basesink, pad, FALSE);
3969 /* we need to have the pull mode enabled */
3970 if (!basesink->can_activate_pull) {
3971 GST_DEBUG_OBJECT (basesink, "pull mode disabled");
3975 /* check if downstreams supports pull mode at all */
3976 query = gst_query_new_scheduling ();
3978 if (!gst_pad_peer_query (pad, query)) {
3979 gst_query_unref (query);
3980 GST_DEBUG_OBJECT (basesink, "peer query faild, no pull mode");
3984 /* parse result of the query */
3985 pull_mode = gst_query_has_scheduling_mode (query, GST_PAD_MODE_PULL);
3986 gst_query_unref (query);
3989 GST_DEBUG_OBJECT (basesink, "pull mode not supported");
3993 /* set the pad mode before starting the task so that it's in the
3994 * correct state for the new thread. also the sink set_caps and get_caps
3995 * function checks this */
3996 basesink->pad_mode = GST_PAD_MODE_PULL;
3998 /* we first try to negotiate a format so that when we try to activate
3999 * downstream, it knows about our format */
4000 if (!gst_base_sink_negotiate_pull (basesink)) {
4001 GST_DEBUG_OBJECT (basesink, "failed to negotiate in pull mode");
4005 /* ok activate now */
4006 if (!gst_pad_activate_mode (pad, GST_PAD_MODE_PULL, TRUE)) {
4007 /* clear any pending caps */
4008 GST_OBJECT_LOCK (basesink);
4009 gst_caps_replace (&basesink->priv->caps, NULL);
4010 GST_OBJECT_UNLOCK (basesink);
4011 GST_DEBUG_OBJECT (basesink, "failed to activate in pull mode");
4015 GST_DEBUG_OBJECT (basesink, "Success activating pull mode");
4019 /* push mode fallback */
4021 GST_DEBUG_OBJECT (basesink, "Falling back to push mode");
4022 if ((result = gst_pad_activate_mode (pad, GST_PAD_MODE_PUSH, TRUE))) {
4023 GST_DEBUG_OBJECT (basesink, "Success activating push mode");
4028 GST_WARNING_OBJECT (basesink, "Could not activate pad in either mode");
4029 gst_base_sink_set_flushing (basesink, pad, TRUE);
4036 gst_base_sink_pad_activate_push (GstPad * pad, GstObject * parent,
4040 GstBaseSink *basesink;
4042 basesink = GST_BASE_SINK (parent);
4045 if (!basesink->can_activate_push) {
4047 basesink->pad_mode = GST_PAD_MODE_NONE;
4050 basesink->pad_mode = GST_PAD_MODE_PUSH;
4053 if (G_UNLIKELY (basesink->pad_mode != GST_PAD_MODE_PUSH)) {
4054 g_warning ("Internal GStreamer activation error!!!");
4057 gst_base_sink_set_flushing (basesink, pad, TRUE);
4059 basesink->pad_mode = GST_PAD_MODE_NONE;
4067 gst_base_sink_negotiate_pull (GstBaseSink * basesink)
4074 /* this returns the intersection between our caps and the peer caps. If there
4075 * is no peer, it returns NULL and we can't operate in pull mode so we can
4076 * fail the negotiation. */
4077 caps = gst_pad_get_allowed_caps (GST_BASE_SINK_PAD (basesink));
4078 if (caps == NULL || gst_caps_is_empty (caps))
4079 goto no_caps_possible;
4081 GST_DEBUG_OBJECT (basesink, "allowed caps: %" GST_PTR_FORMAT, caps);
4083 if (gst_caps_is_any (caps)) {
4084 GST_DEBUG_OBJECT (basesink, "caps were ANY after fixating, "
4086 /* neither side has template caps in this case, so they are prepared for
4087 pull() without setcaps() */
4090 caps = gst_caps_make_writable (caps);
4092 gst_base_sink_fixate (basesink, caps);
4093 GST_DEBUG_OBJECT (basesink, "fixated to: %" GST_PTR_FORMAT, caps);
4095 if (gst_caps_is_fixed (caps)) {
4096 if (!gst_pad_send_event (GST_BASE_SINK_PAD (basesink),
4097 gst_event_new_caps (caps)))
4098 goto could_not_set_caps;
4104 gst_caps_unref (caps);
4110 GST_INFO_OBJECT (basesink, "Pipeline could not agree on caps");
4111 GST_DEBUG_OBJECT (basesink, "get_allowed_caps() returned EMPTY");
4113 gst_caps_unref (caps);
4118 GST_INFO_OBJECT (basesink, "Could not set caps: %" GST_PTR_FORMAT, caps);
4119 gst_caps_unref (caps);
4124 /* this won't get called until we implement an activate function */
4126 gst_base_sink_pad_activate_pull (GstPad * pad, GstObject * parent,
4129 gboolean result = FALSE;
4130 GstBaseSink *basesink;
4131 GstBaseSinkClass *bclass;
4133 basesink = GST_BASE_SINK (parent);
4134 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4139 /* we mark we have a newsegment here because pull based
4140 * mode works just fine without having a newsegment before the
4142 gst_segment_init (&basesink->segment, GST_FORMAT_BYTES);
4143 GST_OBJECT_LOCK (basesink);
4144 basesink->have_newsegment = TRUE;
4145 GST_OBJECT_UNLOCK (basesink);
4147 /* get the peer duration in bytes */
4148 result = gst_pad_peer_query_duration (pad, GST_FORMAT_BYTES, &duration);
4150 GST_DEBUG_OBJECT (basesink,
4151 "setting duration in bytes to %" G_GINT64_FORMAT, duration);
4152 basesink->segment.duration = duration;
4154 GST_DEBUG_OBJECT (basesink, "unknown duration");
4157 if (bclass->activate_pull)
4158 result = bclass->activate_pull (basesink, TRUE);
4163 goto activate_failed;
4166 if (G_UNLIKELY (basesink->pad_mode != GST_PAD_MODE_PULL)) {
4167 g_warning ("Internal GStreamer activation error!!!");
4170 result = gst_base_sink_set_flushing (basesink, pad, TRUE);
4171 if (bclass->activate_pull)
4172 result &= bclass->activate_pull (basesink, FALSE);
4173 basesink->pad_mode = GST_PAD_MODE_NONE;
4182 /* reset, as starting the thread failed */
4183 basesink->pad_mode = GST_PAD_MODE_NONE;
4185 GST_ERROR_OBJECT (basesink, "subclass failed to activate in pull mode");
4191 gst_base_sink_pad_activate_mode (GstPad * pad, GstObject * parent,
4192 GstPadMode mode, gboolean active)
4197 case GST_PAD_MODE_PULL:
4198 res = gst_base_sink_pad_activate_pull (pad, parent, active);
4200 case GST_PAD_MODE_PUSH:
4201 res = gst_base_sink_pad_activate_push (pad, parent, active);
4204 GST_LOG_OBJECT (pad, "unknown activation mode %d", mode);
4211 /* send an event to our sinkpad peer. */
4213 gst_base_sink_send_event (GstElement * element, GstEvent * event)
4216 GstBaseSink *basesink = GST_BASE_SINK (element);
4217 gboolean forward, result = TRUE;
4220 GST_OBJECT_LOCK (element);
4221 /* get the pad and the scheduling mode */
4222 pad = gst_object_ref (basesink->sinkpad);
4223 mode = basesink->pad_mode;
4224 GST_OBJECT_UNLOCK (element);
4226 /* only push UPSTREAM events upstream */
4227 forward = GST_EVENT_IS_UPSTREAM (event);
4229 GST_DEBUG_OBJECT (basesink, "handling event %p %" GST_PTR_FORMAT, event,
4232 switch (GST_EVENT_TYPE (event)) {
4233 case GST_EVENT_LATENCY:
4235 GstClockTime latency;
4237 gst_event_parse_latency (event, &latency);
4239 /* store the latency. We use this to adjust the running_time before syncing
4240 * it to the clock. */
4241 GST_OBJECT_LOCK (element);
4242 basesink->priv->latency = latency;
4243 if (!basesink->priv->have_latency)
4245 GST_OBJECT_UNLOCK (element);
4246 GST_DEBUG_OBJECT (basesink, "latency set to %" GST_TIME_FORMAT,
4247 GST_TIME_ARGS (latency));
4249 /* We forward this event so that all elements know about the global pipeline
4250 * latency. This is interesting for an element when it wants to figure out
4251 * when a particular piece of data will be rendered. */
4254 case GST_EVENT_SEEK:
4255 /* in pull mode we will execute the seek */
4256 if (mode == GST_PAD_MODE_PULL)
4257 result = gst_base_sink_perform_seek (basesink, pad, event);
4259 case GST_EVENT_STEP:
4260 result = gst_base_sink_perform_step (basesink, pad, event);
4268 result = gst_pad_push_event (pad, event);
4270 /* not forwarded, unref the event */
4271 gst_event_unref (event);
4274 gst_object_unref (pad);
4276 GST_DEBUG_OBJECT (basesink, "handled event %p %" GST_PTR_FORMAT ": %d", event,
4283 gst_base_sink_get_position (GstBaseSink * basesink, GstFormat format,
4284 gint64 * cur, gboolean * upstream)
4286 GstClock *clock = NULL;
4287 gboolean res = FALSE;
4289 GstSegment *segment;
4290 GstClockTime now, latency;
4291 GstClockTimeDiff base_time;
4292 gint64 time, base, duration;
4295 gboolean last_seen, with_clock, in_paused;
4297 GST_OBJECT_LOCK (basesink);
4298 /* we can only get the segment when we are not NULL or READY */
4299 if (!basesink->have_newsegment)
4303 /* when not in PLAYING or when we're busy with a state change, we
4304 * cannot read from the clock so we report time based on the
4305 * last seen timestamp. */
4306 if (GST_STATE (basesink) != GST_STATE_PLAYING ||
4307 GST_STATE_PENDING (basesink) != GST_STATE_VOID_PENDING) {
4311 segment = &basesink->segment;
4313 /* get the format in the segment */
4314 oformat = segment->format;
4316 /* report with last seen position when EOS */
4317 last_seen = basesink->eos;
4319 /* assume we will use the clock for getting the current position */
4321 if (basesink->sync == FALSE)
4324 /* and we need a clock */
4325 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (basesink)) == NULL))
4328 gst_object_ref (clock);
4330 /* mainloop might be querying position when going to playing async,
4331 * while (audio) rendering might be quickly advancing stream position,
4332 * so use clock asap rather than last reported position */
4333 if (in_paused && with_clock && g_atomic_int_get (&basesink->priv->to_playing)) {
4334 GST_DEBUG_OBJECT (basesink, "going to PLAYING, so not PAUSED");
4338 /* collect all data we need holding the lock */
4339 if (GST_CLOCK_TIME_IS_VALID (segment->time))
4340 time = segment->time;
4344 if (GST_CLOCK_TIME_IS_VALID (segment->stop))
4345 duration = segment->stop - segment->start;
4349 base = segment->base;
4350 rate = segment->rate * segment->applied_rate;
4351 latency = basesink->priv->latency;
4353 if (oformat == GST_FORMAT_TIME) {
4356 start = basesink->priv->current_sstart;
4357 stop = basesink->priv->current_sstop;
4360 /* in paused we use the last position as a lower bound */
4361 if (stop == -1 || segment->rate > 0.0)
4366 /* in playing, use last stop time as upper bound */
4367 if (start == -1 || segment->rate > 0.0)
4373 /* convert last stop to stream time */
4374 last = gst_segment_to_stream_time (segment, oformat, segment->position);
4378 /* in paused, use start_time */
4379 base_time = GST_ELEMENT_START_TIME (basesink);
4380 GST_DEBUG_OBJECT (basesink, "in paused, using start time %" GST_TIME_FORMAT,
4381 GST_TIME_ARGS (base_time));
4382 } else if (with_clock) {
4383 /* else use clock when needed */
4384 base_time = GST_ELEMENT_CAST (basesink)->base_time;
4385 GST_DEBUG_OBJECT (basesink, "using clock and base time %" GST_TIME_FORMAT,
4386 GST_TIME_ARGS (base_time));
4388 /* else, no sync or clock -> no base time */
4389 GST_DEBUG_OBJECT (basesink, "no sync or no clock");
4393 /* no base_time, we can't calculate running_time, use last seem timestamp to report
4395 if (base_time == -1)
4398 /* need to release the object lock before we can get the time,
4399 * a clock might take the LOCK of the provider, which could be
4400 * a basesink subclass. */
4401 GST_OBJECT_UNLOCK (basesink);
4404 /* in EOS or when no valid stream_time, report the value of last seen
4407 /* no timestamp, we need to ask upstream */
4408 GST_DEBUG_OBJECT (basesink, "no last seen timestamp, asking upstream");
4413 GST_DEBUG_OBJECT (basesink, "using last seen timestamp %" GST_TIME_FORMAT,
4414 GST_TIME_ARGS (last));
4417 if (oformat != GST_FORMAT_TIME) {
4418 /* convert base, time and duration to time */
4419 if (!gst_pad_query_convert (basesink->sinkpad, oformat, base,
4420 GST_FORMAT_TIME, &base))
4421 goto convert_failed;
4422 if (!gst_pad_query_convert (basesink->sinkpad, oformat, duration,
4423 GST_FORMAT_TIME, &duration))
4424 goto convert_failed;
4425 if (!gst_pad_query_convert (basesink->sinkpad, oformat, time,
4426 GST_FORMAT_TIME, &time))
4427 goto convert_failed;
4428 if (!gst_pad_query_convert (basesink->sinkpad, oformat, last,
4429 GST_FORMAT_TIME, &last))
4430 goto convert_failed;
4432 /* assume time format from now on */
4433 oformat = GST_FORMAT_TIME;
4436 if (!in_paused && with_clock) {
4437 now = gst_clock_get_time (clock);
4443 /* subtract base time and base time from the clock time.
4444 * Make sure we don't go negative. This is the current time in
4445 * the segment which we need to scale with the combined
4446 * rate and applied rate. */
4448 base_time += latency;
4449 if (GST_CLOCK_DIFF (base_time, now) < 0)
4452 /* for negative rates we need to count back from the segment
4457 *cur = time + gst_guint64_to_gdouble (now - base_time) * rate;
4460 /* never report less than segment values in paused */
4462 *cur = MAX (last, *cur);
4464 /* never report more than last seen position in playing */
4466 *cur = MIN (last, *cur);
4469 GST_DEBUG_OBJECT (basesink,
4470 "now %" GST_TIME_FORMAT " - base_time %" GST_TIME_FORMAT " - base %"
4471 GST_TIME_FORMAT " + time %" GST_TIME_FORMAT " last %" GST_TIME_FORMAT,
4472 GST_TIME_ARGS (now), GST_TIME_ARGS (base_time), GST_TIME_ARGS (base),
4473 GST_TIME_ARGS (time), GST_TIME_ARGS (last));
4476 if (oformat != format) {
4477 /* convert to final format */
4478 if (!gst_pad_query_convert (basesink->sinkpad, oformat, *cur, format, cur))
4479 goto convert_failed;
4485 GST_DEBUG_OBJECT (basesink, "res: %d, POSITION: %" GST_TIME_FORMAT,
4486 res, GST_TIME_ARGS (*cur));
4489 gst_object_unref (clock);
4496 /* in NULL or READY we always return FALSE and -1 */
4497 GST_DEBUG_OBJECT (basesink, "position in wrong state, return -1");
4500 GST_OBJECT_UNLOCK (basesink);
4505 GST_DEBUG_OBJECT (basesink, "convert failed, try upstream");
4513 gst_base_sink_get_duration (GstBaseSink * basesink, GstFormat format,
4514 gint64 * dur, gboolean * upstream)
4516 gboolean res = FALSE;
4518 if (basesink->pad_mode == GST_PAD_MODE_PULL) {
4521 /* get the duration in bytes, in pull mode that's all we are sure to
4522 * know. We have to explicitly get this value from upstream instead of
4523 * using our cached value because it might change. Duration caching
4524 * should be done at a higher level. */
4526 gst_pad_peer_query_duration (basesink->sinkpad, GST_FORMAT_BYTES,
4529 basesink->segment.duration = uduration;
4530 if (format != GST_FORMAT_BYTES) {
4531 /* convert to the requested format */
4533 gst_pad_query_convert (basesink->sinkpad, GST_FORMAT_BYTES,
4534 uduration, format, dur);
4548 default_element_query (GstElement * element, GstQuery * query)
4550 gboolean res = FALSE;
4552 GstBaseSink *basesink = GST_BASE_SINK (element);
4554 switch (GST_QUERY_TYPE (query)) {
4555 case GST_QUERY_POSITION:
4559 gboolean upstream = FALSE;
4561 gst_query_parse_position (query, &format, NULL);
4563 GST_DEBUG_OBJECT (basesink, "position query in format %s",
4564 gst_format_get_name (format));
4566 /* first try to get the position based on the clock */
4568 gst_base_sink_get_position (basesink, format, &cur, &upstream))) {
4569 gst_query_set_position (query, format, cur);
4570 } else if (upstream) {
4571 /* fallback to peer query */
4572 res = gst_pad_peer_query (basesink->sinkpad, query);
4575 /* we can handle a few things if upstream failed */
4576 if (format == GST_FORMAT_PERCENT) {
4579 res = gst_base_sink_get_position (basesink, GST_FORMAT_TIME, &cur,
4581 if (!res && upstream) {
4583 gst_pad_peer_query_position (basesink->sinkpad, GST_FORMAT_TIME,
4587 res = gst_base_sink_get_duration (basesink, GST_FORMAT_TIME, &dur,
4589 if (!res && upstream) {
4591 gst_pad_peer_query_duration (basesink->sinkpad,
4592 GST_FORMAT_TIME, &dur);
4598 pos = gst_util_uint64_scale (100 * GST_FORMAT_PERCENT_SCALE, cur,
4600 gst_query_set_position (query, GST_FORMAT_PERCENT, pos);
4606 case GST_QUERY_DURATION:
4610 gboolean upstream = FALSE;
4612 gst_query_parse_duration (query, &format, NULL);
4614 GST_DEBUG_OBJECT (basesink, "duration query in format %s",
4615 gst_format_get_name (format));
4618 gst_base_sink_get_duration (basesink, format, &dur, &upstream))) {
4619 gst_query_set_duration (query, format, dur);
4620 } else if (upstream) {
4621 /* fallback to peer query */
4622 res = gst_pad_peer_query (basesink->sinkpad, query);
4625 /* we can handle a few things if upstream failed */
4626 if (format == GST_FORMAT_PERCENT) {
4627 gst_query_set_duration (query, GST_FORMAT_PERCENT,
4628 GST_FORMAT_PERCENT_MAX);
4634 case GST_QUERY_LATENCY:
4636 gboolean live, us_live;
4637 GstClockTime min, max;
4639 if ((res = gst_base_sink_query_latency (basesink, &live, &us_live, &min,
4641 gst_query_set_latency (query, live, min, max);
4645 case GST_QUERY_JITTER:
4647 case GST_QUERY_RATE:
4648 /* gst_query_set_rate (query, basesink->segment_rate); */
4651 case GST_QUERY_SEGMENT:
4653 if (basesink->pad_mode == GST_PAD_MODE_PULL) {
4654 gst_query_set_segment (query, basesink->segment.rate,
4655 GST_FORMAT_TIME, basesink->segment.start, basesink->segment.stop);
4658 res = gst_pad_peer_query (basesink->sinkpad, query);
4662 case GST_QUERY_SEEKING:
4663 case GST_QUERY_CONVERT:
4664 case GST_QUERY_FORMATS:
4666 res = gst_pad_peer_query (basesink->sinkpad, query);
4669 GST_DEBUG_OBJECT (basesink, "query %s returns %d",
4670 GST_QUERY_TYPE_NAME (query), res);
4676 default_sink_query (GstBaseSink * basesink, GstQuery * query)
4679 GstBaseSinkClass *bclass;
4681 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4683 switch (GST_QUERY_TYPE (query)) {
4684 case GST_QUERY_ALLOCATION:
4686 if (bclass->propose_allocation)
4687 res = bclass->propose_allocation (basesink, query);
4692 case GST_QUERY_CAPS:
4694 GstCaps *caps, *filter;
4696 gst_query_parse_caps (query, &filter);
4697 caps = gst_base_sink_query_caps (basesink, basesink->sinkpad, filter);
4698 gst_query_set_caps_result (query, caps);
4699 gst_caps_unref (caps);
4705 gst_pad_query_default (basesink->sinkpad, GST_OBJECT_CAST (basesink),
4713 gst_base_sink_sink_query (GstPad * pad, GstObject * parent, GstQuery * query)
4715 GstBaseSink *basesink;
4716 GstBaseSinkClass *bclass;
4719 basesink = GST_BASE_SINK_CAST (parent);
4720 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4723 res = bclass->query (basesink, query);
4730 static GstStateChangeReturn
4731 gst_base_sink_change_state (GstElement * element, GstStateChange transition)
4733 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
4734 GstBaseSink *basesink = GST_BASE_SINK (element);
4735 GstBaseSinkClass *bclass;
4736 GstBaseSinkPrivate *priv;
4738 priv = basesink->priv;
4740 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4742 switch (transition) {
4743 case GST_STATE_CHANGE_NULL_TO_READY:
4745 if (!bclass->start (basesink))
4748 case GST_STATE_CHANGE_READY_TO_PAUSED:
4749 /* need to complete preroll before this state change completes, there
4750 * is no data flow in READY so we can safely assume we need to preroll. */
4751 GST_BASE_SINK_PREROLL_LOCK (basesink);
4752 GST_DEBUG_OBJECT (basesink, "READY to PAUSED");
4753 basesink->have_newsegment = FALSE;
4754 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
4755 basesink->offset = 0;
4756 basesink->have_preroll = FALSE;
4757 priv->step_unlock = FALSE;
4758 basesink->need_preroll = TRUE;
4759 basesink->playing_async = TRUE;
4760 basesink->priv->reset_time = FALSE;
4761 priv->current_sstart = GST_CLOCK_TIME_NONE;
4762 priv->current_sstop = GST_CLOCK_TIME_NONE;
4763 priv->eos_rtime = GST_CLOCK_TIME_NONE;
4765 basesink->eos = FALSE;
4766 priv->received_eos = FALSE;
4767 gst_base_sink_reset_qos (basesink);
4768 priv->commited = FALSE;
4769 priv->call_preroll = TRUE;
4770 priv->current_step.valid = FALSE;
4771 priv->pending_step.valid = FALSE;
4772 if (priv->async_enabled) {
4773 GST_DEBUG_OBJECT (basesink, "doing async state change");
4774 /* when async enabled, post async-start message and return ASYNC from
4775 * the state change function */
4776 ret = GST_STATE_CHANGE_ASYNC;
4777 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4778 gst_message_new_async_start (GST_OBJECT_CAST (basesink)));
4780 priv->have_latency = TRUE;
4782 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4784 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
4785 GST_BASE_SINK_PREROLL_LOCK (basesink);
4786 g_atomic_int_set (&basesink->priv->to_playing, TRUE);
4787 if (!gst_base_sink_needs_preroll (basesink)) {
4788 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, don't need preroll");
4789 /* no preroll needed anymore now. */
4790 basesink->playing_async = FALSE;
4791 basesink->need_preroll = FALSE;
4792 if (basesink->eos) {
4793 GstMessage *message;
4795 /* need to post EOS message here */
4796 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
4797 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
4798 gst_message_set_seqnum (message, basesink->priv->seqnum);
4799 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
4801 GST_DEBUG_OBJECT (basesink, "signal preroll");
4802 GST_BASE_SINK_PREROLL_SIGNAL (basesink);
4805 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, we are not prerolled");
4806 basesink->need_preroll = TRUE;
4807 basesink->playing_async = TRUE;
4808 priv->call_preroll = TRUE;
4809 priv->commited = FALSE;
4810 if (priv->async_enabled) {
4811 GST_DEBUG_OBJECT (basesink, "doing async state change");
4812 ret = GST_STATE_CHANGE_ASYNC;
4813 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4814 gst_message_new_async_start (GST_OBJECT_CAST (basesink)));
4817 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4824 GstStateChangeReturn bret;
4826 bret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
4827 if (G_UNLIKELY (bret == GST_STATE_CHANGE_FAILURE))
4828 goto activate_failed;
4831 switch (transition) {
4832 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
4833 /* completed transition, so need not be marked any longer
4834 * And it should be unmarked, since e.g. losing our position upon flush
4835 * does not really change state to PAUSED ... */
4836 g_atomic_int_set (&basesink->priv->to_playing, FALSE);
4838 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
4839 g_atomic_int_set (&basesink->priv->to_playing, FALSE);
4840 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED");
4841 /* FIXME, make sure we cannot enter _render first */
4843 /* we need to call ::unlock before locking PREROLL_LOCK
4844 * since we lock it before going into ::render */
4846 bclass->unlock (basesink);
4848 GST_BASE_SINK_PREROLL_LOCK (basesink);
4849 GST_DEBUG_OBJECT (basesink, "got preroll lock");
4850 /* now that we have the PREROLL lock, clear our unlock request */
4851 if (bclass->unlock_stop)
4852 bclass->unlock_stop (basesink);
4854 /* we need preroll again and we set the flag before unlocking the clockid
4855 * because if the clockid is unlocked before a current buffer expired, we
4856 * can use that buffer to preroll with */
4857 basesink->need_preroll = TRUE;
4859 if (basesink->clock_id) {
4860 GST_DEBUG_OBJECT (basesink, "unschedule clock");
4861 gst_clock_id_unschedule (basesink->clock_id);
4864 /* if we don't have a preroll buffer we need to wait for a preroll and
4866 if (!gst_base_sink_needs_preroll (basesink)) {
4867 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED, we are prerolled");
4868 basesink->playing_async = FALSE;
4870 if (GST_STATE_TARGET (GST_ELEMENT (basesink)) <= GST_STATE_READY) {
4871 GST_DEBUG_OBJECT (basesink, "element is <= READY");
4872 ret = GST_STATE_CHANGE_SUCCESS;
4874 GST_DEBUG_OBJECT (basesink,
4875 "PLAYING to PAUSED, we are not prerolled");
4876 basesink->playing_async = TRUE;
4877 priv->commited = FALSE;
4878 priv->call_preroll = TRUE;
4879 if (priv->async_enabled) {
4880 GST_DEBUG_OBJECT (basesink, "doing async state change");
4881 ret = GST_STATE_CHANGE_ASYNC;
4882 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4883 gst_message_new_async_start (GST_OBJECT_CAST (basesink)));
4887 GST_DEBUG_OBJECT (basesink, "rendered: %" G_GUINT64_FORMAT
4888 ", dropped: %" G_GUINT64_FORMAT, priv->rendered, priv->dropped);
4890 gst_base_sink_reset_qos (basesink);
4891 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4893 case GST_STATE_CHANGE_PAUSED_TO_READY:
4894 GST_BASE_SINK_PREROLL_LOCK (basesink);
4895 /* start by resetting our position state with the object lock so that the
4896 * position query gets the right idea. We do this before we post the
4897 * messages so that the message handlers pick this up. */
4898 GST_OBJECT_LOCK (basesink);
4899 basesink->have_newsegment = FALSE;
4900 priv->current_sstart = GST_CLOCK_TIME_NONE;
4901 priv->current_sstop = GST_CLOCK_TIME_NONE;
4902 priv->have_latency = FALSE;
4903 if (priv->cached_clock_id) {
4904 gst_clock_id_unref (priv->cached_clock_id);
4905 priv->cached_clock_id = NULL;
4907 gst_caps_replace (&basesink->priv->caps, NULL);
4908 GST_OBJECT_UNLOCK (basesink);
4910 gst_base_sink_set_last_buffer (basesink, NULL);
4911 priv->call_preroll = FALSE;
4913 if (!priv->commited) {
4914 if (priv->async_enabled) {
4915 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, posting async-done");
4917 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4918 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
4919 GST_STATE_PLAYING, GST_STATE_PAUSED, GST_STATE_READY));
4921 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4922 gst_message_new_async_done (GST_OBJECT_CAST (basesink), FALSE));
4924 priv->commited = TRUE;
4926 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, don't need_preroll");
4928 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4930 case GST_STATE_CHANGE_READY_TO_NULL:
4932 if (!bclass->stop (basesink)) {
4933 GST_WARNING_OBJECT (basesink, "failed to stop");
4936 gst_base_sink_set_last_buffer (basesink, NULL);
4937 priv->call_preroll = FALSE;
4948 GST_DEBUG_OBJECT (basesink, "failed to start");
4949 return GST_STATE_CHANGE_FAILURE;
4953 GST_DEBUG_OBJECT (basesink,
4954 "element failed to change states -- activation problem?");
4955 return GST_STATE_CHANGE_FAILURE;