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., 51 Franklin St, Fifth Floor,
19 * Boston, MA 02110-1301, 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));
51 * gst_element_class_set_static_metadata (gstelement_class,
55 * "The author <my.sink@my.email>");
59 * #GstBaseSink will handle the prerolling correctly. This means that it will
60 * return #GST_STATE_CHANGE_ASYNC from a state change to PAUSED until the first
61 * buffer arrives in this element. The base class will call the
62 * #GstBaseSinkClass.preroll() vmethod with this preroll buffer and will then
63 * commit the state change to the next asynchronously pending state.
65 * When the element is set to PLAYING, #GstBaseSink will synchronise on the
66 * clock using the times returned from #GstBaseSinkClass.get_times(). If this
67 * function returns #GST_CLOCK_TIME_NONE for the start time, no synchronisation
68 * will be done. Synchronisation can be disabled entirely by setting the object
69 * #GstBaseSink:sync property to %FALSE.
71 * After synchronisation the virtual method #GstBaseSinkClass.render() will be
72 * called. Subclasses should minimally implement this method.
74 * Subclasses that synchronise on the clock in the #GstBaseSinkClass.render()
75 * method are supported as well. These classes typically receive a buffer in
76 * the render method and can then potentially block on the clock while
77 * rendering. A typical example is an audiosink.
78 * These subclasses can use gst_base_sink_wait_preroll() to perform the
81 * Upon receiving the EOS event in the PLAYING state, #GstBaseSink will wait
82 * for the clock to reach the time indicated by the stop time of the last
83 * #GstBaseSinkClass.get_times() call before posting an EOS message. When the
84 * element receives EOS in PAUSED, preroll completes, the event is queued and an
85 * EOS message is posted when going to PLAYING.
87 * #GstBaseSink will internally use the #GST_EVENT_SEGMENT events to schedule
88 * synchronisation and clipping of buffers. Buffers that fall completely outside
89 * of the current segment are dropped. Buffers that fall partially in the
90 * segment are rendered (and prerolled). Subclasses should do any subbuffer
91 * clipping themselves when needed.
93 * #GstBaseSink will by default report the current playback position in
94 * #GST_FORMAT_TIME based on the current clock time and segment information.
95 * If no clock has been set on the element, the query will be forwarded
98 * The #GstBaseSinkClass.set_caps() function will be called when the subclass
99 * should configure itself to process a specific media type.
101 * The #GstBaseSinkClass.start() and #GstBaseSinkClass.stop() virtual methods
102 * will be called when resources should be allocated. Any
103 * #GstBaseSinkClass.preroll(), #GstBaseSinkClass.render() and
104 * #GstBaseSinkClass.set_caps() function will be called between the
105 * #GstBaseSinkClass.start() and #GstBaseSinkClass.stop() calls.
107 * The #GstBaseSinkClass.event() virtual method will be called when an event is
108 * received by #GstBaseSink. Normally this method should only be overriden by
109 * very specific elements (such as file sinks) which need to handle the
110 * newsegment event specially.
112 * The #GstBaseSinkClass.unlock() method is called when the elements should
113 * unblock any blocking operations they perform in the
114 * #GstBaseSinkClass.render() method. This is mostly useful when the
115 * #GstBaseSinkClass.render() method performs a blocking write on a file
116 * descriptor, for example.
118 * The #GstBaseSink:max-lateness property affects how the sink deals with
119 * buffers that arrive too late in the sink. A buffer arrives too late in the
120 * sink when the presentation time (as a combination of the last segment, buffer
121 * timestamp and element base_time) plus the duration is before the current
123 * If the frame is later than max-lateness, the sink will drop the buffer
124 * without calling the render method.
125 * This feature is disabled if sync is disabled, the
126 * #GstBaseSinkClass.get_times() method does not return a valid start time or
127 * max-lateness is set to -1 (the default).
128 * Subclasses can use gst_base_sink_set_max_lateness() to configure the
129 * max-lateness value.
131 * The #GstBaseSink:qos property will enable the quality-of-service features of
132 * the basesink which gather statistics about the real-time performance of the
133 * clock synchronisation. For each buffer received in the sink, statistics are
134 * gathered and a QOS event is sent upstream with these numbers. This
135 * information can then be used by upstream elements to reduce their processing
138 * The #GstBaseSink:async property can be used to instruct the sink to never
139 * perform an ASYNC state change. This feature is mostly usable when dealing
140 * with non-synchronized streams or sparse streams.
142 * Last reviewed on 2007-08-29 (0.10.15)
149 #include <gst/gst_private.h>
151 #include "gstbasesink.h"
152 #include <gst/gst-i18n-lib.h>
154 GST_DEBUG_CATEGORY_STATIC (gst_base_sink_debug);
155 #define GST_CAT_DEFAULT gst_base_sink_debug
157 #define GST_BASE_SINK_GET_PRIVATE(obj) \
158 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_BASE_SINK, GstBaseSinkPrivate))
160 #define GST_FLOW_STEP GST_FLOW_CUSTOM_ERROR
164 gboolean valid; /* if this info is valid */
165 guint32 seqnum; /* the seqnum of the STEP event */
166 GstFormat format; /* the format of the amount */
167 guint64 amount; /* the total amount of data to skip */
168 guint64 position; /* the position in the stepped data */
169 guint64 duration; /* the duration in time of the skipped data */
170 guint64 start; /* running_time of the start */
171 gdouble rate; /* rate of skipping */
172 gdouble start_rate; /* rate before skipping */
173 guint64 start_start; /* start position skipping */
174 guint64 start_stop; /* stop position skipping */
175 gboolean flush; /* if this was a flushing step */
176 gboolean intermediate; /* if this is an intermediate step */
177 gboolean need_preroll; /* if we need preroll after this step */
180 struct _GstBaseSinkPrivate
182 gint qos_enabled; /* ATOMIC */
183 gboolean async_enabled;
184 GstClockTimeDiff ts_offset;
185 GstClockTime render_delay;
187 /* start, stop of current buffer, stream time, used to report position */
188 GstClockTime current_sstart;
189 GstClockTime current_sstop;
191 /* start, stop and jitter of current buffer, running time */
192 GstClockTime current_rstart;
193 GstClockTime current_rstop;
194 GstClockTimeDiff current_jitter;
195 /* the running time of the previous buffer */
196 GstClockTime prev_rstart;
198 /* EOS sync time in running time */
199 GstClockTime eos_rtime;
201 /* last buffer that arrived in time, running time */
202 GstClockTime last_render_time;
203 /* when the last buffer left the sink, running time */
204 GstClockTime last_left;
206 /* running averages go here these are done on running time */
208 GstClockTime avg_duration;
210 GstClockTime avg_in_diff;
212 /* these are done on system time. avg_jitter and avg_render are
213 * compared to eachother to see if the rendering time takes a
214 * huge amount of the processing, If so we are flooded with
216 GstClockTime last_left_systime;
217 GstClockTime avg_jitter;
218 GstClockTime start, stop;
219 GstClockTime avg_render;
221 /* number of rendered and dropped frames */
226 GstClockTime latency;
228 /* if we already commited the state */
230 /* state change to playing ongoing */
233 /* when we received EOS */
234 gboolean received_eos;
236 /* when we are prerolled and able to report latency */
237 gboolean have_latency;
239 /* the last buffer we prerolled or rendered. Useful for making snapshots */
240 gint enable_last_sample; /* atomic */
241 GstBuffer *last_buffer;
244 /* negotiated caps */
247 /* blocksize for pulling */
252 /* seqnum of the stream */
255 gboolean call_preroll;
256 gboolean step_unlock;
258 /* we have a pending and a current step operation */
259 GstStepInfo current_step;
260 GstStepInfo pending_step;
262 /* Cached GstClockID */
263 GstClockID cached_clock_id;
265 /* for throttling and QoS */
266 GstClockTime earliest_in_time;
267 GstClockTime throttle_time;
269 /* for rate control */
271 GstClockTime rc_time;
272 GstClockTime rc_next;
273 gsize rc_accumulated;
276 #define DO_RUNNING_AVG(avg,val,size) (((val) + ((size)-1) * (avg)) / (size))
278 /* generic running average, this has a neutral window size */
279 #define UPDATE_RUNNING_AVG(avg,val) DO_RUNNING_AVG(avg,val,8)
281 /* the windows for these running averages are experimentally obtained.
282 * possitive values get averaged more while negative values use a small
283 * window so we can react faster to badness. */
284 #define UPDATE_RUNNING_AVG_P(avg,val) DO_RUNNING_AVG(avg,val,16)
285 #define UPDATE_RUNNING_AVG_N(avg,val) DO_RUNNING_AVG(avg,val,4)
287 /* BaseSink properties */
289 #define DEFAULT_CAN_ACTIVATE_PULL FALSE /* fixme: enable me */
290 #define DEFAULT_CAN_ACTIVATE_PUSH TRUE
292 #define DEFAULT_SYNC TRUE
293 #define DEFAULT_MAX_LATENESS -1
294 #define DEFAULT_QOS FALSE
295 #define DEFAULT_ASYNC TRUE
296 #define DEFAULT_TS_OFFSET 0
297 #define DEFAULT_BLOCKSIZE 4096
298 #define DEFAULT_RENDER_DELAY 0
299 #define DEFAULT_ENABLE_LAST_SAMPLE TRUE
300 #define DEFAULT_THROTTLE_TIME 0
301 #define DEFAULT_MAX_BITRATE 0
311 PROP_ENABLE_LAST_SAMPLE,
320 static GstElementClass *parent_class = NULL;
322 static void gst_base_sink_class_init (GstBaseSinkClass * klass);
323 static void gst_base_sink_init (GstBaseSink * trans, gpointer g_class);
324 static void gst_base_sink_finalize (GObject * object);
327 gst_base_sink_get_type (void)
329 static volatile gsize base_sink_type = 0;
331 if (g_once_init_enter (&base_sink_type)) {
333 static const GTypeInfo base_sink_info = {
334 sizeof (GstBaseSinkClass),
337 (GClassInitFunc) gst_base_sink_class_init,
340 sizeof (GstBaseSink),
342 (GInstanceInitFunc) gst_base_sink_init,
345 _type = g_type_register_static (GST_TYPE_ELEMENT,
346 "GstBaseSink", &base_sink_info, G_TYPE_FLAG_ABSTRACT);
347 g_once_init_leave (&base_sink_type, _type);
349 return base_sink_type;
352 static void gst_base_sink_set_property (GObject * object, guint prop_id,
353 const GValue * value, GParamSpec * pspec);
354 static void gst_base_sink_get_property (GObject * object, guint prop_id,
355 GValue * value, GParamSpec * pspec);
357 static gboolean gst_base_sink_send_event (GstElement * element,
359 static gboolean default_element_query (GstElement * element, GstQuery * query);
361 static GstCaps *gst_base_sink_default_get_caps (GstBaseSink * sink,
363 static gboolean gst_base_sink_default_set_caps (GstBaseSink * sink,
365 static void gst_base_sink_default_get_times (GstBaseSink * basesink,
366 GstBuffer * buffer, GstClockTime * start, GstClockTime * end);
367 static gboolean gst_base_sink_set_flushing (GstBaseSink * basesink,
368 GstPad * pad, gboolean flushing);
369 static gboolean gst_base_sink_default_activate_pull (GstBaseSink * basesink,
371 static gboolean gst_base_sink_default_do_seek (GstBaseSink * sink,
372 GstSegment * segment);
373 static gboolean gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
374 GstEvent * event, GstSegment * segment);
376 static GstStateChangeReturn gst_base_sink_change_state (GstElement * element,
377 GstStateChange transition);
379 static gboolean gst_base_sink_sink_query (GstPad * pad, GstObject * parent,
381 static GstFlowReturn gst_base_sink_chain (GstPad * pad, GstObject * parent,
383 static GstFlowReturn gst_base_sink_chain_list (GstPad * pad, GstObject * parent,
384 GstBufferList * list);
386 static void gst_base_sink_loop (GstPad * pad);
387 static gboolean gst_base_sink_pad_activate (GstPad * pad, GstObject * parent);
388 static gboolean gst_base_sink_pad_activate_mode (GstPad * pad,
389 GstObject * parent, GstPadMode mode, gboolean active);
390 static gboolean gst_base_sink_default_event (GstBaseSink * basesink,
392 static GstFlowReturn gst_base_sink_default_wait_event (GstBaseSink * basesink,
394 static gboolean gst_base_sink_event (GstPad * pad, GstObject * parent,
397 static gboolean gst_base_sink_default_query (GstBaseSink * sink,
400 static gboolean gst_base_sink_negotiate_pull (GstBaseSink * basesink);
401 static GstCaps *gst_base_sink_default_fixate (GstBaseSink * bsink,
403 static GstCaps *gst_base_sink_fixate (GstBaseSink * bsink, GstCaps * caps);
405 /* check if an object was too late */
406 static gboolean gst_base_sink_is_too_late (GstBaseSink * basesink,
407 GstMiniObject * obj, GstClockTime rstart, GstClockTime rstop,
408 GstClockReturn status, GstClockTimeDiff jitter, gboolean render);
411 gst_base_sink_class_init (GstBaseSinkClass * klass)
413 GObjectClass *gobject_class;
414 GstElementClass *gstelement_class;
416 gobject_class = G_OBJECT_CLASS (klass);
417 gstelement_class = GST_ELEMENT_CLASS (klass);
419 GST_DEBUG_CATEGORY_INIT (gst_base_sink_debug, "basesink", 0,
422 g_type_class_add_private (klass, sizeof (GstBaseSinkPrivate));
424 parent_class = g_type_class_peek_parent (klass);
426 gobject_class->finalize = gst_base_sink_finalize;
427 gobject_class->set_property = gst_base_sink_set_property;
428 gobject_class->get_property = gst_base_sink_get_property;
430 g_object_class_install_property (gobject_class, PROP_SYNC,
431 g_param_spec_boolean ("sync", "Sync", "Sync on the clock", DEFAULT_SYNC,
432 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
434 g_object_class_install_property (gobject_class, PROP_MAX_LATENESS,
435 g_param_spec_int64 ("max-lateness", "Max Lateness",
436 "Maximum number of nanoseconds that a buffer can be late before it "
437 "is dropped (-1 unlimited)", -1, G_MAXINT64, DEFAULT_MAX_LATENESS,
438 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
440 g_object_class_install_property (gobject_class, PROP_QOS,
441 g_param_spec_boolean ("qos", "Qos",
442 "Generate Quality-of-Service events upstream", DEFAULT_QOS,
443 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
447 * If set to #TRUE, the basesink will perform asynchronous state changes.
448 * When set to #FALSE, the sink will not signal the parent when it prerolls.
449 * 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.
463 g_object_class_install_property (gobject_class, PROP_TS_OFFSET,
464 g_param_spec_int64 ("ts-offset", "TS Offset",
465 "Timestamp offset in nanoseconds", G_MININT64, G_MAXINT64,
466 DEFAULT_TS_OFFSET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
469 * GstBaseSink:enable-last-sample:
471 * Enable the last-sample property. If FALSE, basesink doesn't keep a
472 * reference to the last buffer arrived and the last-sample property is always
473 * set to NULL. This can be useful if you need buffers to be released as soon
474 * as possible, eg. if you're using a buffer pool.
476 g_object_class_install_property (gobject_class, PROP_ENABLE_LAST_SAMPLE,
477 g_param_spec_boolean ("enable-last-sample", "Enable Last Buffer",
478 "Enable the last-sample property", DEFAULT_ENABLE_LAST_SAMPLE,
479 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
482 * GstBaseSink:last-sample:
484 * The last buffer that arrived in the sink and was used for preroll or for
485 * rendering. This property can be used to generate thumbnails. This property
486 * can be NULL when the sink has not yet received a bufer.
488 g_object_class_install_property (gobject_class, PROP_LAST_SAMPLE,
489 g_param_spec_boxed ("last-sample", "Last Sample",
490 "The last sample received in the sink", GST_TYPE_SAMPLE,
491 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
493 * GstBaseSink:blocksize:
495 * The amount of bytes to pull when operating in pull mode.
497 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
498 g_object_class_install_property (gobject_class, PROP_BLOCKSIZE,
499 g_param_spec_uint ("blocksize", "Block size",
500 "Size in bytes to pull per buffer (0 = default)", 0, G_MAXUINT,
501 DEFAULT_BLOCKSIZE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
503 * GstBaseSink:render-delay:
505 * The additional delay between synchronisation and actual rendering of the
506 * media. This property will add additional latency to the device in order to
507 * make other sinks compensate for the delay.
509 g_object_class_install_property (gobject_class, PROP_RENDER_DELAY,
510 g_param_spec_uint64 ("render-delay", "Render Delay",
511 "Additional render delay of the sink in nanoseconds", 0, G_MAXUINT64,
512 DEFAULT_RENDER_DELAY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
514 * GstBaseSink:throttle-time:
516 * The time to insert between buffers. This property can be used to control
517 * the maximum amount of buffers per second to render. Setting this property
518 * to a value bigger than 0 will make the sink create THROTTLE QoS events.
520 g_object_class_install_property (gobject_class, PROP_THROTTLE_TIME,
521 g_param_spec_uint64 ("throttle-time", "Throttle time",
522 "The time to keep between rendered buffers (0 = disabled)", 0,
523 G_MAXUINT64, DEFAULT_THROTTLE_TIME,
524 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
526 * GstBaseSink:max-bitrate:
528 * Control the maximum amount of bits that will be rendered per second.
529 * Setting this property to a value bigger than 0 will make the sink delay
530 * rendering of the buffers when it would exceed to max-bitrate.
534 g_object_class_install_property (gobject_class, PROP_MAX_BITRATE,
535 g_param_spec_uint64 ("max-bitrate", "Max Bitrate",
536 "The maximum bits per second to render (0 = disabled)", 0,
537 G_MAXUINT64, DEFAULT_MAX_BITRATE,
538 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
540 gstelement_class->change_state =
541 GST_DEBUG_FUNCPTR (gst_base_sink_change_state);
542 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_base_sink_send_event);
543 gstelement_class->query = GST_DEBUG_FUNCPTR (default_element_query);
545 klass->get_caps = GST_DEBUG_FUNCPTR (gst_base_sink_default_get_caps);
546 klass->set_caps = GST_DEBUG_FUNCPTR (gst_base_sink_default_set_caps);
547 klass->fixate = GST_DEBUG_FUNCPTR (gst_base_sink_default_fixate);
548 klass->activate_pull =
549 GST_DEBUG_FUNCPTR (gst_base_sink_default_activate_pull);
550 klass->get_times = GST_DEBUG_FUNCPTR (gst_base_sink_default_get_times);
551 klass->query = GST_DEBUG_FUNCPTR (gst_base_sink_default_query);
552 klass->event = GST_DEBUG_FUNCPTR (gst_base_sink_default_event);
553 klass->wait_event = GST_DEBUG_FUNCPTR (gst_base_sink_default_wait_event);
555 /* Registering debug symbols for function pointers */
556 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_fixate);
557 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate);
558 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate_mode);
559 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_event);
560 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain);
561 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain_list);
562 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_sink_query);
566 gst_base_sink_query_caps (GstBaseSink * bsink, GstPad * pad, GstCaps * filter)
568 GstBaseSinkClass *bclass;
569 GstCaps *caps = NULL;
572 bclass = GST_BASE_SINK_GET_CLASS (bsink);
573 fixed = GST_PAD_IS_FIXED_CAPS (pad);
575 if (fixed || bsink->pad_mode == GST_PAD_MODE_PULL) {
576 /* if we are operating in pull mode or fixed caps, we only accept the
577 * currently negotiated caps */
578 caps = gst_pad_get_current_caps (pad);
581 if (bclass->get_caps)
582 caps = bclass->get_caps (bsink, filter);
585 GstPadTemplate *pad_template;
588 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass),
590 if (pad_template != NULL) {
591 caps = gst_pad_template_get_caps (pad_template);
594 GstCaps *intersection;
597 gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
598 gst_caps_unref (caps);
609 gst_base_sink_default_fixate (GstBaseSink * bsink, GstCaps * caps)
611 GST_DEBUG_OBJECT (bsink, "using default caps fixate function");
612 return gst_caps_fixate (caps);
616 gst_base_sink_fixate (GstBaseSink * bsink, GstCaps * caps)
618 GstBaseSinkClass *bclass;
620 bclass = GST_BASE_SINK_GET_CLASS (bsink);
623 caps = bclass->fixate (bsink, caps);
629 gst_base_sink_init (GstBaseSink * basesink, gpointer g_class)
631 GstPadTemplate *pad_template;
632 GstBaseSinkPrivate *priv;
634 basesink->priv = priv = GST_BASE_SINK_GET_PRIVATE (basesink);
637 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "sink");
638 g_return_if_fail (pad_template != NULL);
640 basesink->sinkpad = gst_pad_new_from_template (pad_template, "sink");
642 gst_pad_set_activate_function (basesink->sinkpad, gst_base_sink_pad_activate);
643 gst_pad_set_activatemode_function (basesink->sinkpad,
644 gst_base_sink_pad_activate_mode);
645 gst_pad_set_query_function (basesink->sinkpad, gst_base_sink_sink_query);
646 gst_pad_set_event_function (basesink->sinkpad, gst_base_sink_event);
647 gst_pad_set_chain_function (basesink->sinkpad, gst_base_sink_chain);
648 gst_pad_set_chain_list_function (basesink->sinkpad, gst_base_sink_chain_list);
649 gst_element_add_pad (GST_ELEMENT_CAST (basesink), basesink->sinkpad);
651 basesink->pad_mode = GST_PAD_MODE_NONE;
652 g_mutex_init (&basesink->preroll_lock);
653 g_cond_init (&basesink->preroll_cond);
654 priv->have_latency = FALSE;
656 basesink->can_activate_push = DEFAULT_CAN_ACTIVATE_PUSH;
657 basesink->can_activate_pull = DEFAULT_CAN_ACTIVATE_PULL;
659 basesink->sync = DEFAULT_SYNC;
660 basesink->max_lateness = DEFAULT_MAX_LATENESS;
661 g_atomic_int_set (&priv->qos_enabled, DEFAULT_QOS);
662 priv->async_enabled = DEFAULT_ASYNC;
663 priv->ts_offset = DEFAULT_TS_OFFSET;
664 priv->render_delay = DEFAULT_RENDER_DELAY;
665 priv->blocksize = DEFAULT_BLOCKSIZE;
666 priv->cached_clock_id = NULL;
667 g_atomic_int_set (&priv->enable_last_sample, DEFAULT_ENABLE_LAST_SAMPLE);
668 priv->throttle_time = DEFAULT_THROTTLE_TIME;
669 priv->max_bitrate = DEFAULT_MAX_BITRATE;
671 GST_OBJECT_FLAG_SET (basesink, GST_ELEMENT_FLAG_SINK);
675 gst_base_sink_finalize (GObject * object)
677 GstBaseSink *basesink;
679 basesink = GST_BASE_SINK (object);
681 g_mutex_clear (&basesink->preroll_lock);
682 g_cond_clear (&basesink->preroll_cond);
684 G_OBJECT_CLASS (parent_class)->finalize (object);
688 * gst_base_sink_set_sync:
690 * @sync: the new sync value.
692 * Configures @sink to synchronize on the clock or not. When
693 * @sync is FALSE, incoming samples will be played as fast as
694 * possible. If @sync is TRUE, the timestamps of the incomming
695 * buffers will be used to schedule the exact render time of its
699 gst_base_sink_set_sync (GstBaseSink * sink, gboolean sync)
701 g_return_if_fail (GST_IS_BASE_SINK (sink));
703 GST_OBJECT_LOCK (sink);
705 GST_OBJECT_UNLOCK (sink);
709 * gst_base_sink_get_sync:
712 * Checks if @sink is currently configured to synchronize against the
715 * Returns: TRUE if the sink is configured to synchronize against the clock.
718 gst_base_sink_get_sync (GstBaseSink * sink)
722 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
724 GST_OBJECT_LOCK (sink);
726 GST_OBJECT_UNLOCK (sink);
732 * gst_base_sink_set_max_lateness:
734 * @max_lateness: the new max lateness value.
736 * Sets the new max lateness value to @max_lateness. This value is
737 * used to decide if a buffer should be dropped or not based on the
738 * buffer timestamp and the current clock time. A value of -1 means
742 gst_base_sink_set_max_lateness (GstBaseSink * sink, gint64 max_lateness)
744 g_return_if_fail (GST_IS_BASE_SINK (sink));
746 GST_OBJECT_LOCK (sink);
747 sink->max_lateness = max_lateness;
748 GST_OBJECT_UNLOCK (sink);
752 * gst_base_sink_get_max_lateness:
755 * Gets the max lateness value. See gst_base_sink_set_max_lateness for
758 * Returns: The maximum time in nanoseconds that a buffer can be late
759 * 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.
784 gst_base_sink_set_qos_enabled (GstBaseSink * sink, gboolean enabled)
786 g_return_if_fail (GST_IS_BASE_SINK (sink));
788 g_atomic_int_set (&sink->priv->qos_enabled, enabled);
792 * gst_base_sink_is_qos_enabled:
795 * Checks if @sink is currently configured to send Quality-of-Service events
798 * Returns: TRUE if the sink is configured to perform Quality-of-Service.
801 gst_base_sink_is_qos_enabled (GstBaseSink * sink)
805 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
807 res = g_atomic_int_get (&sink->priv->qos_enabled);
813 * gst_base_sink_set_async_enabled:
815 * @enabled: the new async value.
817 * Configures @sink to perform all state changes asynchronusly. When async is
818 * disabled, the sink will immediately go to PAUSED instead of waiting for a
819 * preroll buffer. This feature is useful if the sink does not synchronize
820 * against the clock or when it is dealing with sparse streams.
823 gst_base_sink_set_async_enabled (GstBaseSink * sink, gboolean enabled)
825 g_return_if_fail (GST_IS_BASE_SINK (sink));
827 GST_BASE_SINK_PREROLL_LOCK (sink);
828 g_atomic_int_set (&sink->priv->async_enabled, enabled);
829 GST_LOG_OBJECT (sink, "set async enabled to %d", enabled);
830 GST_BASE_SINK_PREROLL_UNLOCK (sink);
834 * gst_base_sink_is_async_enabled:
837 * Checks if @sink is currently configured to perform asynchronous state
840 * Returns: TRUE if the sink is configured to perform asynchronous state
844 gst_base_sink_is_async_enabled (GstBaseSink * sink)
848 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
850 res = g_atomic_int_get (&sink->priv->async_enabled);
856 * gst_base_sink_set_ts_offset:
858 * @offset: the new offset
860 * Adjust the synchronisation of @sink with @offset. A negative value will
861 * render buffers earlier than their timestamp. A positive value will delay
862 * rendering. This function can be used to fix playback of badly timestamped
866 gst_base_sink_set_ts_offset (GstBaseSink * sink, GstClockTimeDiff offset)
868 g_return_if_fail (GST_IS_BASE_SINK (sink));
870 GST_OBJECT_LOCK (sink);
871 sink->priv->ts_offset = offset;
872 GST_LOG_OBJECT (sink, "set time offset to %" G_GINT64_FORMAT, offset);
873 GST_OBJECT_UNLOCK (sink);
877 * gst_base_sink_get_ts_offset:
880 * Get the synchronisation offset of @sink.
882 * Returns: The synchronisation offset.
885 gst_base_sink_get_ts_offset (GstBaseSink * sink)
887 GstClockTimeDiff res;
889 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
891 GST_OBJECT_LOCK (sink);
892 res = sink->priv->ts_offset;
893 GST_OBJECT_UNLOCK (sink);
899 * gst_base_sink_get_last_sample:
902 * Get the last sample that arrived in the sink and was used for preroll or for
903 * rendering. This property can be used to generate thumbnails.
905 * The #GstCaps on the sample can be used to determine the type of the buffer.
907 * Free-function: gst_sample_unref
909 * Returns: (transfer full): a #GstSample. gst_sample_unref() after usage.
910 * This function returns NULL when no buffer has arrived in the sink yet
911 * or when the sink is not in PAUSED or PLAYING.
914 gst_base_sink_get_last_sample (GstBaseSink * sink)
916 GstSample *res = NULL;
918 g_return_val_if_fail (GST_IS_BASE_SINK (sink), NULL);
920 GST_OBJECT_LOCK (sink);
921 if (sink->priv->last_buffer) {
922 res = gst_sample_new (sink->priv->last_buffer,
923 sink->priv->last_caps, &sink->segment, NULL);
925 GST_OBJECT_UNLOCK (sink);
930 /* with OBJECT_LOCK */
932 gst_base_sink_set_last_buffer_unlocked (GstBaseSink * sink, GstBuffer * buffer)
936 old = sink->priv->last_buffer;
937 if (G_LIKELY (old != buffer)) {
938 GST_DEBUG_OBJECT (sink, "setting last buffer to %p", buffer);
939 if (G_LIKELY (buffer))
940 gst_buffer_ref (buffer);
941 sink->priv->last_buffer = buffer;
943 /* copy over the caps */
944 gst_caps_replace (&sink->priv->last_caps, sink->priv->caps);
946 gst_caps_replace (&sink->priv->last_caps, NULL);
950 /* avoid unreffing with the lock because cleanup code might want to take the
952 if (G_LIKELY (old)) {
953 GST_OBJECT_UNLOCK (sink);
954 gst_buffer_unref (old);
955 GST_OBJECT_LOCK (sink);
960 gst_base_sink_set_last_buffer (GstBaseSink * sink, GstBuffer * buffer)
962 if (!g_atomic_int_get (&sink->priv->enable_last_sample))
965 GST_OBJECT_LOCK (sink);
966 gst_base_sink_set_last_buffer_unlocked (sink, buffer);
967 GST_OBJECT_UNLOCK (sink);
971 * gst_base_sink_set_last_sample_enabled:
973 * @enabled: the new enable-last-sample value.
975 * Configures @sink to store the last received sample in the last-sample
979 gst_base_sink_set_last_sample_enabled (GstBaseSink * sink, gboolean enabled)
981 g_return_if_fail (GST_IS_BASE_SINK (sink));
983 /* Only take lock if we change the value */
984 if (g_atomic_int_compare_and_exchange (&sink->priv->enable_last_sample,
985 !enabled, enabled) && !enabled) {
986 GST_OBJECT_LOCK (sink);
987 gst_base_sink_set_last_buffer_unlocked (sink, NULL);
988 GST_OBJECT_UNLOCK (sink);
993 * gst_base_sink_is_last_sample_enabled:
996 * Checks if @sink is currently configured to store the last received sample in
997 * the last-sample property.
999 * Returns: TRUE if the sink is configured to store the last received sample.
1002 gst_base_sink_is_last_sample_enabled (GstBaseSink * sink)
1004 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
1006 return g_atomic_int_get (&sink->priv->enable_last_sample);
1010 * gst_base_sink_get_latency:
1013 * Get the currently configured latency.
1015 * Returns: The configured latency.
1018 gst_base_sink_get_latency (GstBaseSink * sink)
1022 GST_OBJECT_LOCK (sink);
1023 res = sink->priv->latency;
1024 GST_OBJECT_UNLOCK (sink);
1030 * gst_base_sink_query_latency:
1032 * @live: (out) (allow-none): if the sink is live
1033 * @upstream_live: (out) (allow-none): if an upstream element is live
1034 * @min_latency: (out) (allow-none): the min latency of the upstream elements
1035 * @max_latency: (out) (allow-none): the max latency of the upstream elements
1037 * Query the sink for the latency parameters. The latency will be queried from
1038 * the upstream elements. @live will be TRUE if @sink is configured to
1039 * synchronize against the clock. @upstream_live will be TRUE if an upstream
1042 * If both @live and @upstream_live are TRUE, the sink will want to compensate
1043 * for the latency introduced by the upstream elements by setting the
1044 * @min_latency to a strictly possitive value.
1046 * This function is mostly used by subclasses.
1048 * Returns: TRUE if the query succeeded.
1051 gst_base_sink_query_latency (GstBaseSink * sink, gboolean * live,
1052 gboolean * upstream_live, GstClockTime * min_latency,
1053 GstClockTime * max_latency)
1055 gboolean l, us_live, res, have_latency;
1056 GstClockTime min, max, render_delay;
1058 GstClockTime us_min, us_max;
1060 /* we are live when we sync to the clock */
1061 GST_OBJECT_LOCK (sink);
1063 have_latency = sink->priv->have_latency;
1064 render_delay = sink->priv->render_delay;
1065 GST_OBJECT_UNLOCK (sink);
1067 /* assume no latency */
1073 GST_DEBUG_OBJECT (sink, "we are ready for LATENCY query");
1074 /* we are ready for a latency query this is when we preroll or when we are
1076 query = gst_query_new_latency ();
1078 /* ask the peer for the latency */
1079 if ((res = gst_pad_peer_query (sink->sinkpad, query))) {
1080 /* get upstream min and max latency */
1081 gst_query_parse_latency (query, &us_live, &us_min, &us_max);
1084 /* upstream live, use its latency, subclasses should use these
1085 * values to create the complete latency. */
1090 /* we need to add the render delay if we are live */
1092 min += render_delay;
1094 max += render_delay;
1097 gst_query_unref (query);
1099 GST_DEBUG_OBJECT (sink, "we are not yet ready for LATENCY query");
1103 /* not live, we tried to do the query, if it failed we return TRUE anyway */
1107 GST_DEBUG_OBJECT (sink, "latency query failed but we are not live");
1109 GST_DEBUG_OBJECT (sink, "latency query failed and we are live");
1114 GST_DEBUG_OBJECT (sink, "latency query: live: %d, have_latency %d,"
1115 " upstream: %d, min %" GST_TIME_FORMAT ", max %" GST_TIME_FORMAT, l,
1116 have_latency, us_live, GST_TIME_ARGS (min), GST_TIME_ARGS (max));
1121 *upstream_live = us_live;
1131 * gst_base_sink_set_render_delay:
1132 * @sink: a #GstBaseSink
1133 * @delay: the new delay
1135 * Set the render delay in @sink to @delay. The render delay is the time
1136 * between actual rendering of a buffer and its synchronisation time. Some
1137 * devices might delay media rendering which can be compensated for with this
1140 * After calling this function, this sink will report additional latency and
1141 * other sinks will adjust their latency to delay the rendering of their media.
1143 * This function is usually called by subclasses.
1146 gst_base_sink_set_render_delay (GstBaseSink * sink, GstClockTime delay)
1148 GstClockTime old_render_delay;
1150 g_return_if_fail (GST_IS_BASE_SINK (sink));
1152 GST_OBJECT_LOCK (sink);
1153 old_render_delay = sink->priv->render_delay;
1154 sink->priv->render_delay = delay;
1155 GST_LOG_OBJECT (sink, "set render delay to %" GST_TIME_FORMAT,
1156 GST_TIME_ARGS (delay));
1157 GST_OBJECT_UNLOCK (sink);
1159 if (delay != old_render_delay) {
1160 GST_DEBUG_OBJECT (sink, "posting latency changed");
1161 gst_element_post_message (GST_ELEMENT_CAST (sink),
1162 gst_message_new_latency (GST_OBJECT_CAST (sink)));
1167 * gst_base_sink_get_render_delay:
1168 * @sink: a #GstBaseSink
1170 * Get the render delay of @sink. see gst_base_sink_set_render_delay() for more
1171 * information about the render delay.
1173 * Returns: the render delay of @sink.
1176 gst_base_sink_get_render_delay (GstBaseSink * sink)
1178 GstClockTimeDiff res;
1180 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1182 GST_OBJECT_LOCK (sink);
1183 res = sink->priv->render_delay;
1184 GST_OBJECT_UNLOCK (sink);
1190 * gst_base_sink_set_blocksize:
1191 * @sink: a #GstBaseSink
1192 * @blocksize: the blocksize in bytes
1194 * Set the number of bytes that the sink will pull when it is operating in pull
1197 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
1199 gst_base_sink_set_blocksize (GstBaseSink * sink, guint blocksize)
1201 g_return_if_fail (GST_IS_BASE_SINK (sink));
1203 GST_OBJECT_LOCK (sink);
1204 sink->priv->blocksize = blocksize;
1205 GST_LOG_OBJECT (sink, "set blocksize to %u", blocksize);
1206 GST_OBJECT_UNLOCK (sink);
1210 * gst_base_sink_get_blocksize:
1211 * @sink: a #GstBaseSink
1213 * Get the number of bytes that the sink will pull when it is operating in pull
1216 * Returns: the number of bytes @sink will pull in pull mode.
1218 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
1220 gst_base_sink_get_blocksize (GstBaseSink * sink)
1224 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1226 GST_OBJECT_LOCK (sink);
1227 res = sink->priv->blocksize;
1228 GST_OBJECT_UNLOCK (sink);
1234 * gst_base_sink_set_throttle_time:
1235 * @sink: a #GstBaseSink
1236 * @throttle: the throttle time in nanoseconds
1238 * Set the time that will be inserted between rendered buffers. This
1239 * can be used to control the maximum buffers per second that the sink
1243 gst_base_sink_set_throttle_time (GstBaseSink * sink, guint64 throttle)
1245 g_return_if_fail (GST_IS_BASE_SINK (sink));
1247 GST_OBJECT_LOCK (sink);
1248 sink->priv->throttle_time = throttle;
1249 GST_LOG_OBJECT (sink, "set throttle_time to %" G_GUINT64_FORMAT, throttle);
1250 GST_OBJECT_UNLOCK (sink);
1254 * gst_base_sink_get_throttle_time:
1255 * @sink: a #GstBaseSink
1257 * Get the time that will be inserted between frames to control the
1258 * maximum buffers per second.
1260 * Returns: the number of nanoseconds @sink will put between frames.
1263 gst_base_sink_get_throttle_time (GstBaseSink * sink)
1267 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1269 GST_OBJECT_LOCK (sink);
1270 res = sink->priv->throttle_time;
1271 GST_OBJECT_UNLOCK (sink);
1277 * gst_base_sink_set_max_bitrate:
1278 * @sink: a #GstBaseSink
1279 * @max_bitrate: the max_bitrate in bits per second
1281 * Set the maximum amount of bits per second that the sink will render.
1286 gst_base_sink_set_max_bitrate (GstBaseSink * sink, guint64 max_bitrate)
1288 g_return_if_fail (GST_IS_BASE_SINK (sink));
1290 GST_OBJECT_LOCK (sink);
1291 sink->priv->max_bitrate = max_bitrate;
1292 GST_LOG_OBJECT (sink, "set max_bitrate to %" G_GUINT64_FORMAT, max_bitrate);
1293 GST_OBJECT_UNLOCK (sink);
1297 * gst_base_sink_get_max_bitrate:
1298 * @sink: a #GstBaseSink
1300 * Get the maximum amount of bits per second that the sink will render.
1302 * Returns: the maximum number of bits per second @sink will render.
1307 gst_base_sink_get_max_bitrate (GstBaseSink * sink)
1311 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1313 GST_OBJECT_LOCK (sink);
1314 res = sink->priv->max_bitrate;
1315 GST_OBJECT_UNLOCK (sink);
1321 gst_base_sink_set_property (GObject * object, guint prop_id,
1322 const GValue * value, GParamSpec * pspec)
1324 GstBaseSink *sink = GST_BASE_SINK (object);
1328 gst_base_sink_set_sync (sink, g_value_get_boolean (value));
1330 case PROP_MAX_LATENESS:
1331 gst_base_sink_set_max_lateness (sink, g_value_get_int64 (value));
1334 gst_base_sink_set_qos_enabled (sink, g_value_get_boolean (value));
1337 gst_base_sink_set_async_enabled (sink, g_value_get_boolean (value));
1339 case PROP_TS_OFFSET:
1340 gst_base_sink_set_ts_offset (sink, g_value_get_int64 (value));
1342 case PROP_BLOCKSIZE:
1343 gst_base_sink_set_blocksize (sink, g_value_get_uint (value));
1345 case PROP_RENDER_DELAY:
1346 gst_base_sink_set_render_delay (sink, g_value_get_uint64 (value));
1348 case PROP_ENABLE_LAST_SAMPLE:
1349 gst_base_sink_set_last_sample_enabled (sink, g_value_get_boolean (value));
1351 case PROP_THROTTLE_TIME:
1352 gst_base_sink_set_throttle_time (sink, g_value_get_uint64 (value));
1354 case PROP_MAX_BITRATE:
1355 gst_base_sink_set_max_bitrate (sink, g_value_get_uint64 (value));
1358 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1364 gst_base_sink_get_property (GObject * object, guint prop_id, GValue * value,
1367 GstBaseSink *sink = GST_BASE_SINK (object);
1371 g_value_set_boolean (value, gst_base_sink_get_sync (sink));
1373 case PROP_MAX_LATENESS:
1374 g_value_set_int64 (value, gst_base_sink_get_max_lateness (sink));
1377 g_value_set_boolean (value, gst_base_sink_is_qos_enabled (sink));
1380 g_value_set_boolean (value, gst_base_sink_is_async_enabled (sink));
1382 case PROP_TS_OFFSET:
1383 g_value_set_int64 (value, gst_base_sink_get_ts_offset (sink));
1385 case PROP_LAST_SAMPLE:
1386 gst_value_take_buffer (value, gst_base_sink_get_last_sample (sink));
1388 case PROP_ENABLE_LAST_SAMPLE:
1389 g_value_set_boolean (value, gst_base_sink_is_last_sample_enabled (sink));
1391 case PROP_BLOCKSIZE:
1392 g_value_set_uint (value, gst_base_sink_get_blocksize (sink));
1394 case PROP_RENDER_DELAY:
1395 g_value_set_uint64 (value, gst_base_sink_get_render_delay (sink));
1397 case PROP_THROTTLE_TIME:
1398 g_value_set_uint64 (value, gst_base_sink_get_throttle_time (sink));
1400 case PROP_MAX_BITRATE:
1401 g_value_set_uint64 (value, gst_base_sink_get_max_bitrate (sink));
1404 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1411 gst_base_sink_default_get_caps (GstBaseSink * sink, GstCaps * filter)
1417 gst_base_sink_default_set_caps (GstBaseSink * sink, GstCaps * caps)
1422 /* with PREROLL_LOCK, STREAM_LOCK */
1424 gst_base_sink_commit_state (GstBaseSink * basesink)
1426 /* commit state and proceed to next pending state */
1427 GstState current, next, pending, post_pending;
1428 gboolean post_paused = FALSE;
1429 gboolean post_async_done = FALSE;
1430 gboolean post_playing = FALSE;
1432 /* we are certainly not playing async anymore now */
1433 basesink->playing_async = FALSE;
1435 GST_OBJECT_LOCK (basesink);
1436 current = GST_STATE (basesink);
1437 next = GST_STATE_NEXT (basesink);
1438 pending = GST_STATE_PENDING (basesink);
1439 post_pending = pending;
1442 case GST_STATE_PLAYING:
1444 GST_DEBUG_OBJECT (basesink, "commiting state to PLAYING");
1446 basesink->need_preroll = FALSE;
1447 post_async_done = TRUE;
1448 basesink->priv->commited = TRUE;
1449 post_playing = TRUE;
1450 /* post PAUSED too when we were READY */
1451 if (current == GST_STATE_READY) {
1456 case GST_STATE_PAUSED:
1457 GST_DEBUG_OBJECT (basesink, "commiting state to PAUSED");
1459 post_async_done = TRUE;
1460 basesink->priv->commited = TRUE;
1461 post_pending = GST_STATE_VOID_PENDING;
1463 case GST_STATE_READY:
1464 case GST_STATE_NULL:
1466 case GST_STATE_VOID_PENDING:
1467 goto nothing_pending;
1472 /* we can report latency queries now */
1473 basesink->priv->have_latency = TRUE;
1475 GST_STATE (basesink) = pending;
1476 GST_STATE_NEXT (basesink) = GST_STATE_VOID_PENDING;
1477 GST_STATE_PENDING (basesink) = GST_STATE_VOID_PENDING;
1478 GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_SUCCESS;
1479 GST_OBJECT_UNLOCK (basesink);
1482 GST_DEBUG_OBJECT (basesink, "posting PAUSED state change message");
1483 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1484 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1485 current, next, post_pending));
1487 if (post_async_done) {
1488 GST_DEBUG_OBJECT (basesink, "posting async-done message");
1489 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1490 gst_message_new_async_done (GST_OBJECT_CAST (basesink),
1491 GST_CLOCK_TIME_NONE));
1495 GstElementClass *klass;
1497 klass = GST_ELEMENT_GET_CLASS (basesink);
1498 basesink->have_preroll = TRUE;
1499 /* after releasing this lock, the state change function
1500 * can execute concurrently with this thread. There is nothing we do to
1501 * prevent this for now. subclasses should be prepared to handle it. */
1502 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
1504 if (klass->change_state)
1505 klass->change_state (GST_ELEMENT_CAST (basesink),
1506 GST_STATE_CHANGE_PAUSED_TO_PLAYING);
1508 GST_BASE_SINK_PREROLL_LOCK (basesink);
1509 /* state change function could have been executed and we could be
1511 if (G_UNLIKELY (basesink->flushing))
1514 GST_DEBUG_OBJECT (basesink, "posting PLAYING state change message");
1515 /* FIXME, we released the PREROLL lock above, it's possible that this
1516 * message is not correct anymore when the element went back to PAUSED */
1517 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1518 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1519 next, pending, GST_STATE_VOID_PENDING));
1522 GST_STATE_BROADCAST (basesink);
1528 /* Depending on the state, set our vars. We get in this situation when the
1529 * state change function got a change to update the state vars before the
1530 * streaming thread did. This is fine but we need to make sure that we
1531 * update the need_preroll var since it was TRUE when we got here and might
1532 * become FALSE if we got to PLAYING. */
1533 GST_DEBUG_OBJECT (basesink, "nothing to commit, now in %s",
1534 gst_element_state_get_name (current));
1536 case GST_STATE_PLAYING:
1537 basesink->need_preroll = FALSE;
1539 case GST_STATE_PAUSED:
1540 basesink->need_preroll = TRUE;
1543 basesink->need_preroll = FALSE;
1544 basesink->flushing = TRUE;
1547 /* we can report latency queries now */
1548 basesink->priv->have_latency = TRUE;
1549 GST_OBJECT_UNLOCK (basesink);
1554 /* app is going to READY */
1555 GST_DEBUG_OBJECT (basesink, "stopping");
1556 basesink->need_preroll = FALSE;
1557 basesink->flushing = TRUE;
1558 GST_OBJECT_UNLOCK (basesink);
1564 start_stepping (GstBaseSink * sink, GstSegment * segment,
1565 GstStepInfo * pending, GstStepInfo * current)
1568 GstMessage *message;
1570 GST_DEBUG_OBJECT (sink, "update pending step");
1572 GST_OBJECT_LOCK (sink);
1573 memcpy (current, pending, sizeof (GstStepInfo));
1574 pending->valid = FALSE;
1575 GST_OBJECT_UNLOCK (sink);
1577 /* post message first */
1579 gst_message_new_step_start (GST_OBJECT (sink), TRUE, current->format,
1580 current->amount, current->rate, current->flush, current->intermediate);
1581 gst_message_set_seqnum (message, current->seqnum);
1582 gst_element_post_message (GST_ELEMENT (sink), message);
1584 /* get the running time of where we paused and remember it */
1585 current->start = gst_element_get_start_time (GST_ELEMENT_CAST (sink));
1586 gst_segment_set_running_time (segment, GST_FORMAT_TIME, current->start);
1588 /* set the new rate for the remainder of the segment */
1589 current->start_rate = segment->rate;
1590 segment->rate *= current->rate;
1593 if (segment->rate > 0.0)
1594 current->start_stop = segment->stop;
1596 current->start_start = segment->start;
1598 if (current->format == GST_FORMAT_TIME) {
1599 /* calculate the running-time when the step operation should stop */
1600 if (current->amount != -1)
1601 end = current->start + current->amount;
1605 if (!current->flush) {
1608 /* update the segment clipping regions for non-flushing seeks */
1609 if (segment->rate > 0.0) {
1611 position = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1613 position = segment->stop;
1615 segment->stop = position;
1616 segment->position = position;
1619 position = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1621 position = segment->start;
1623 segment->time = position;
1624 segment->start = position;
1625 segment->position = position;
1630 GST_DEBUG_OBJECT (sink, "segment now %" GST_SEGMENT_FORMAT, segment);
1631 GST_DEBUG_OBJECT (sink, "step started at running_time %" GST_TIME_FORMAT,
1632 GST_TIME_ARGS (current->start));
1634 GST_DEBUG_OBJECT (sink, "step amount: %" G_GUINT64_FORMAT ", format: %s, "
1635 "rate: %f", current->amount, gst_format_get_name (current->format),
1640 stop_stepping (GstBaseSink * sink, GstSegment * segment,
1641 GstStepInfo * current, gint64 rstart, gint64 rstop, gboolean eos)
1643 gint64 stop, position;
1644 GstMessage *message;
1646 GST_DEBUG_OBJECT (sink, "step complete");
1648 if (segment->rate > 0.0)
1653 GST_DEBUG_OBJECT (sink,
1654 "step stop at running_time %" GST_TIME_FORMAT, GST_TIME_ARGS (stop));
1657 current->duration = current->position;
1659 current->duration = stop - current->start;
1661 GST_DEBUG_OBJECT (sink, "step elapsed running_time %" GST_TIME_FORMAT,
1662 GST_TIME_ARGS (current->duration));
1664 position = current->start + current->duration;
1666 /* now move the segment to the new running time */
1667 gst_segment_set_running_time (segment, GST_FORMAT_TIME, position);
1669 if (current->flush) {
1670 /* and remove the time we flushed, start time did not change */
1671 segment->base = current->start;
1673 /* start time is now the stepped position */
1674 gst_element_set_start_time (GST_ELEMENT_CAST (sink), position);
1677 /* restore the previous rate */
1678 segment->rate = current->start_rate;
1680 if (segment->rate > 0.0)
1681 segment->stop = current->start_stop;
1683 segment->start = current->start_start;
1685 /* post the step done when we know the stepped duration in TIME */
1687 gst_message_new_step_done (GST_OBJECT_CAST (sink), current->format,
1688 current->amount, current->rate, current->flush, current->intermediate,
1689 current->duration, eos);
1690 gst_message_set_seqnum (message, current->seqnum);
1691 gst_element_post_message (GST_ELEMENT_CAST (sink), message);
1693 if (!current->intermediate)
1694 sink->need_preroll = current->need_preroll;
1696 /* and the current step info finished and becomes invalid */
1697 current->valid = FALSE;
1701 handle_stepping (GstBaseSink * sink, GstSegment * segment,
1702 GstStepInfo * current, guint64 * cstart, guint64 * cstop, guint64 * rstart,
1705 gboolean step_end = FALSE;
1707 /* stepping never stops */
1708 if (current->amount == -1)
1711 /* see if we need to skip this buffer because of stepping */
1712 switch (current->format) {
1713 case GST_FORMAT_TIME:
1716 guint64 first, last;
1719 if (segment->rate > 0.0) {
1720 if (segment->stop == *cstop)
1721 *rstop = *rstart + current->amount;
1726 if (segment->start == *cstart)
1727 *rstart = *rstop + current->amount;
1733 end = current->start + current->amount;
1734 current->position = first - current->start;
1736 abs_rate = ABS (segment->rate);
1737 if (G_UNLIKELY (abs_rate != 1.0))
1738 current->position /= abs_rate;
1740 GST_DEBUG_OBJECT (sink,
1741 "buffer: %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT,
1742 GST_TIME_ARGS (first), GST_TIME_ARGS (last));
1743 GST_DEBUG_OBJECT (sink,
1744 "got time step %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT "/%"
1745 GST_TIME_FORMAT, GST_TIME_ARGS (current->position),
1746 GST_TIME_ARGS (last - current->start),
1747 GST_TIME_ARGS (current->amount));
1749 if ((current->flush && current->position >= current->amount)
1751 GST_DEBUG_OBJECT (sink, "step ended, we need clipping");
1753 if (segment->rate > 0.0) {
1755 *cstart = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1758 *cstop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1761 GST_DEBUG_OBJECT (sink,
1762 "cstart %" GST_TIME_FORMAT ", rstart %" GST_TIME_FORMAT,
1763 GST_TIME_ARGS (*cstart), GST_TIME_ARGS (*rstart));
1764 GST_DEBUG_OBJECT (sink,
1765 "cstop %" GST_TIME_FORMAT ", rstop %" GST_TIME_FORMAT,
1766 GST_TIME_ARGS (*cstop), GST_TIME_ARGS (*rstop));
1769 case GST_FORMAT_BUFFERS:
1770 GST_DEBUG_OBJECT (sink,
1771 "got default step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1772 current->position, current->amount);
1774 if (current->position < current->amount) {
1775 current->position++;
1780 case GST_FORMAT_DEFAULT:
1782 GST_DEBUG_OBJECT (sink,
1783 "got unknown step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1784 current->position, current->amount);
1790 /* with STREAM_LOCK, PREROLL_LOCK
1792 * Returns TRUE if the object needs synchronisation and takes therefore
1793 * part in prerolling.
1795 * rsstart/rsstop contain the start/stop in stream time.
1796 * rrstart/rrstop contain the start/stop in running time.
1799 gst_base_sink_get_sync_times (GstBaseSink * basesink, GstMiniObject * obj,
1800 GstClockTime * rsstart, GstClockTime * rsstop,
1801 GstClockTime * rrstart, GstClockTime * rrstop, GstClockTime * rrnext,
1802 gboolean * do_sync, gboolean * stepped, GstStepInfo * step,
1803 gboolean * step_end)
1805 GstBaseSinkClass *bclass;
1806 GstClockTime start, stop; /* raw start/stop timestamps */
1807 guint64 cstart, cstop; /* clipped raw timestamps */
1808 guint64 rstart, rstop, rnext; /* clipped timestamps converted to running time */
1809 GstClockTime sstart, sstop; /* clipped timestamps converted to stream time */
1811 GstBaseSinkPrivate *priv;
1812 GstSegment *segment;
1815 priv = basesink->priv;
1816 segment = &basesink->segment;
1818 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1821 /* start with nothing */
1822 start = stop = GST_CLOCK_TIME_NONE;
1825 if (G_UNLIKELY (GST_IS_EVENT (obj))) {
1826 GstEvent *event = GST_EVENT_CAST (obj);
1828 switch (GST_EVENT_TYPE (event)) {
1829 /* EOS event needs syncing */
1832 if (segment->rate >= 0.0) {
1833 sstart = sstop = priv->current_sstop;
1834 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1835 /* we have not seen a buffer yet, use the segment values */
1836 sstart = sstop = gst_segment_to_stream_time (segment,
1837 segment->format, segment->stop);
1840 sstart = sstop = priv->current_sstart;
1841 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1842 /* we have not seen a buffer yet, use the segment values */
1843 sstart = sstop = gst_segment_to_stream_time (segment,
1844 segment->format, segment->start);
1848 rstart = rstop = rnext = priv->eos_rtime;
1849 *do_sync = rstart != -1;
1850 GST_DEBUG_OBJECT (basesink, "sync times for EOS %" GST_TIME_FORMAT,
1851 GST_TIME_ARGS (rstart));
1852 /* if we are stepping, we end now */
1853 *step_end = step->valid;
1859 GstClockTime timestamp, duration;
1860 gst_event_parse_gap (event, ×tamp, &duration);
1862 GST_DEBUG_OBJECT (basesink, "Got Gap time %" GST_TIME_FORMAT
1863 " duration %" GST_TIME_FORMAT,
1864 GST_TIME_ARGS (timestamp), GST_TIME_ARGS (duration));
1866 if (GST_CLOCK_TIME_IS_VALID (timestamp)) {
1868 if (GST_CLOCK_TIME_IS_VALID (duration))
1869 stop = start + duration;
1875 /* other events do not need syncing */
1879 /* else do buffer sync code */
1880 GstBuffer *buffer = GST_BUFFER_CAST (obj);
1882 /* just get the times to see if we need syncing, if the start returns -1 we
1884 if (bclass->get_times)
1885 bclass->get_times (basesink, buffer, &start, &stop);
1887 if (!GST_CLOCK_TIME_IS_VALID (start)) {
1888 /* we don't need to sync but we still want to get the timestamps for
1889 * tracking the position */
1890 gst_base_sink_default_get_times (basesink, buffer, &start, &stop);
1897 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
1898 ", stop: %" GST_TIME_FORMAT ", do_sync %d", GST_TIME_ARGS (start),
1899 GST_TIME_ARGS (stop), *do_sync);
1901 /* collect segment and format for code clarity */
1902 format = segment->format;
1905 if (G_UNLIKELY (!gst_segment_clip (segment, format,
1906 start, stop, &cstart, &cstop))) {
1908 GST_DEBUG_OBJECT (basesink, "step out of segment");
1909 /* when we are stepping, pretend we're at the end of the segment */
1910 if (segment->rate > 0.0) {
1911 cstart = segment->stop;
1912 cstop = segment->stop;
1914 cstart = segment->start;
1915 cstop = segment->start;
1919 goto out_of_segment;
1922 if (G_UNLIKELY (start != cstart || stop != cstop)) {
1923 GST_DEBUG_OBJECT (basesink, "clipped to: start %" GST_TIME_FORMAT
1924 ", stop: %" GST_TIME_FORMAT, GST_TIME_ARGS (cstart),
1925 GST_TIME_ARGS (cstop));
1928 /* set last stop position */
1929 if (G_LIKELY (stop != GST_CLOCK_TIME_NONE && cstop != GST_CLOCK_TIME_NONE))
1930 segment->position = cstop;
1932 segment->position = cstart;
1935 rstart = gst_segment_to_running_time (segment, format, cstart);
1936 rstop = gst_segment_to_running_time (segment, format, cstop);
1938 if (GST_CLOCK_TIME_IS_VALID (stop))
1943 if (G_UNLIKELY (step->valid)) {
1944 if (!(*step_end = handle_stepping (basesink, segment, step, &cstart, &cstop,
1945 &rstart, &rstop))) {
1946 /* step is still busy, we discard data when we are flushing */
1947 *stepped = step->flush;
1948 GST_DEBUG_OBJECT (basesink, "stepping busy");
1951 /* this can produce wrong values if we accumulated non-TIME segments. If this happens,
1952 * upstream is behaving very badly */
1953 sstart = gst_segment_to_stream_time (segment, format, cstart);
1954 sstop = gst_segment_to_stream_time (segment, format, cstop);
1957 /* eos_done label only called when doing EOS, we also stop stepping then */
1958 if (*step_end && step->flush) {
1959 GST_DEBUG_OBJECT (basesink, "flushing step ended");
1960 stop_stepping (basesink, segment, step, rstart, rstop, eos);
1962 /* re-determine running start times for adjusted segment
1963 * (which has a flushed amount of running/accumulated time removed) */
1964 if (!GST_IS_EVENT (obj)) {
1965 GST_DEBUG_OBJECT (basesink, "refresh sync times");
1977 /* buffers and EOS always need syncing and preroll */
1983 /* we usually clip in the chain function already but stepping could cause
1984 * the segment to be updated later. we return FALSE so that we don't try
1986 GST_LOG_OBJECT (basesink, "buffer skipped, not in segment");
1991 /* with STREAM_LOCK, PREROLL_LOCK, LOCK
1992 * adjust a timestamp with the latency and timestamp offset. This function does
1993 * not adjust for the render delay. */
1995 gst_base_sink_adjust_time (GstBaseSink * basesink, GstClockTime time)
1997 GstClockTimeDiff ts_offset;
1999 /* don't do anything funny with invalid timestamps */
2000 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
2003 time += basesink->priv->latency;
2005 /* apply offset, be carefull for underflows */
2006 ts_offset = basesink->priv->ts_offset;
2007 if (ts_offset < 0) {
2008 ts_offset = -ts_offset;
2009 if (ts_offset < time)
2016 /* subtract the render delay again, which was included in the latency */
2017 if (time > basesink->priv->render_delay)
2018 time -= basesink->priv->render_delay;
2026 * gst_base_sink_wait_clock:
2028 * @time: the running_time to be reached
2029 * @jitter: (out) (allow-none): the jitter to be filled with time diff, or NULL
2031 * This function will block until @time is reached. It is usually called by
2032 * subclasses that use their own internal synchronisation.
2034 * If @time is not valid, no sycnhronisation is done and #GST_CLOCK_BADTIME is
2035 * returned. Likewise, if synchronisation is disabled in the element or there
2036 * is no clock, no synchronisation is done and #GST_CLOCK_BADTIME is returned.
2038 * This function should only be called with the PREROLL_LOCK held, like when
2039 * receiving an EOS event in the #GstBaseSinkClass.event() vmethod or when
2040 * receiving a buffer in
2041 * the #GstBaseSinkClass.render() vmethod.
2043 * The @time argument should be the running_time of when this method should
2044 * return and is not adjusted with any latency or offset configured in the
2047 * Returns: #GstClockReturn
2050 gst_base_sink_wait_clock (GstBaseSink * sink, GstClockTime time,
2051 GstClockTimeDiff * jitter)
2055 GstClockTime base_time;
2057 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
2060 GST_OBJECT_LOCK (sink);
2061 if (G_UNLIKELY (!sink->sync))
2064 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (sink)) == NULL))
2067 base_time = GST_ELEMENT_CAST (sink)->base_time;
2068 GST_LOG_OBJECT (sink,
2069 "time %" GST_TIME_FORMAT ", base_time %" GST_TIME_FORMAT,
2070 GST_TIME_ARGS (time), GST_TIME_ARGS (base_time));
2072 /* add base_time to running_time to get the time against the clock */
2075 /* Re-use existing clockid if available */
2076 /* FIXME: Casting to GstClockEntry only works because the types
2078 if (G_LIKELY (sink->priv->cached_clock_id != NULL
2079 && GST_CLOCK_ENTRY_CLOCK ((GstClockEntry *) sink->priv->
2080 cached_clock_id) == clock)) {
2081 if (!gst_clock_single_shot_id_reinit (clock, sink->priv->cached_clock_id,
2083 gst_clock_id_unref (sink->priv->cached_clock_id);
2084 sink->priv->cached_clock_id = gst_clock_new_single_shot_id (clock, time);
2087 if (sink->priv->cached_clock_id != NULL)
2088 gst_clock_id_unref (sink->priv->cached_clock_id);
2089 sink->priv->cached_clock_id = gst_clock_new_single_shot_id (clock, time);
2091 GST_OBJECT_UNLOCK (sink);
2093 /* A blocking wait is performed on the clock. We save the ClockID
2094 * so we can unlock the entry at any time. While we are blocking, we
2095 * release the PREROLL_LOCK so that other threads can interrupt the
2097 sink->clock_id = sink->priv->cached_clock_id;
2098 /* release the preroll lock while waiting */
2099 GST_BASE_SINK_PREROLL_UNLOCK (sink);
2101 ret = gst_clock_id_wait (sink->priv->cached_clock_id, jitter);
2103 GST_BASE_SINK_PREROLL_LOCK (sink);
2104 sink->clock_id = NULL;
2108 /* no syncing needed */
2111 GST_DEBUG_OBJECT (sink, "time not valid, no sync needed");
2112 return GST_CLOCK_BADTIME;
2116 GST_DEBUG_OBJECT (sink, "sync disabled");
2117 GST_OBJECT_UNLOCK (sink);
2118 return GST_CLOCK_BADTIME;
2122 GST_DEBUG_OBJECT (sink, "no clock, can't sync");
2123 GST_OBJECT_UNLOCK (sink);
2124 return GST_CLOCK_BADTIME;
2129 * gst_base_sink_wait_preroll:
2132 * If the #GstBaseSinkClass.render() method performs its own synchronisation
2133 * against the clock it must unblock when going from PLAYING to the PAUSED state
2134 * and call this method before continuing to render the remaining data.
2136 * This function will block until a state change to PLAYING happens (in which
2137 * case this function returns #GST_FLOW_OK) or the processing must be stopped due
2138 * to a state change to READY or a FLUSH event (in which case this function
2139 * returns #GST_FLOW_FLUSHING).
2141 * This function should only be called with the PREROLL_LOCK held, like in the
2144 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2145 * continue. Any other return value should be returned from the render vmethod.
2148 gst_base_sink_wait_preroll (GstBaseSink * sink)
2150 sink->have_preroll = TRUE;
2151 GST_DEBUG_OBJECT (sink, "waiting in preroll for flush or PLAYING");
2152 /* block until the state changes, or we get a flush, or something */
2153 GST_BASE_SINK_PREROLL_WAIT (sink);
2154 sink->have_preroll = FALSE;
2155 if (G_UNLIKELY (sink->flushing))
2157 if (G_UNLIKELY (sink->priv->step_unlock))
2159 GST_DEBUG_OBJECT (sink, "continue after preroll");
2166 GST_DEBUG_OBJECT (sink, "preroll interrupted because of flush");
2167 return GST_FLOW_FLUSHING;
2171 sink->priv->step_unlock = FALSE;
2172 GST_DEBUG_OBJECT (sink, "preroll interrupted because of step");
2173 return GST_FLOW_STEP;
2178 * gst_base_sink_do_preroll:
2180 * @obj: (transfer none): the mini object that caused the preroll
2182 * If the @sink spawns its own thread for pulling buffers from upstream it
2183 * should call this method after it has pulled a buffer. If the element needed
2184 * to preroll, this function will perform the preroll and will then block
2185 * until the element state is changed.
2187 * This function should be called with the PREROLL_LOCK held.
2189 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2190 * continue. Any other return value should be returned from the render vmethod.
2193 gst_base_sink_do_preroll (GstBaseSink * sink, GstMiniObject * obj)
2197 while (G_UNLIKELY (sink->need_preroll)) {
2198 GST_DEBUG_OBJECT (sink, "prerolling object %p", obj);
2200 /* if it's a buffer, we need to call the preroll method */
2201 if (sink->priv->call_preroll) {
2202 GstBaseSinkClass *bclass;
2205 if (GST_IS_BUFFER_LIST (obj)) {
2206 buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0);
2207 g_assert (NULL != buf);
2208 } else if (GST_IS_BUFFER (obj)) {
2209 buf = GST_BUFFER_CAST (obj);
2210 /* For buffer lists do not set last buffer for now */
2211 gst_base_sink_set_last_buffer (sink, buf);
2216 GST_DEBUG_OBJECT (sink, "preroll buffer %" GST_TIME_FORMAT,
2217 GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buf)));
2219 bclass = GST_BASE_SINK_GET_CLASS (sink);
2221 if (bclass->prepare)
2222 if ((ret = bclass->prepare (sink, buf)) != GST_FLOW_OK)
2223 goto prepare_canceled;
2225 if (bclass->preroll)
2226 if ((ret = bclass->preroll (sink, buf)) != GST_FLOW_OK)
2227 goto preroll_canceled;
2229 sink->priv->call_preroll = FALSE;
2234 if (G_LIKELY (sink->playing_async)) {
2235 if (G_UNLIKELY (!gst_base_sink_commit_state (sink)))
2239 /* need to recheck here because the commit state could have
2240 * made us not need the preroll anymore */
2241 if (G_LIKELY (sink->need_preroll)) {
2242 /* block until the state changes, or we get a flush, or something */
2243 ret = gst_base_sink_wait_preroll (sink);
2244 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2245 goto preroll_failed;
2253 GST_DEBUG_OBJECT (sink, "prepare failed, abort state");
2254 gst_element_abort_state (GST_ELEMENT_CAST (sink));
2259 GST_DEBUG_OBJECT (sink, "preroll failed, abort state");
2260 gst_element_abort_state (GST_ELEMENT_CAST (sink));
2265 GST_DEBUG_OBJECT (sink, "stopping while commiting state");
2266 return GST_FLOW_FLUSHING;
2270 GST_DEBUG_OBJECT (sink, "preroll failed: %s", gst_flow_get_name (ret));
2276 * gst_base_sink_wait:
2278 * @time: the running_time to be reached
2279 * @jitter: (out) (allow-none): the jitter to be filled with time diff, or NULL
2281 * This function will wait for preroll to complete and will then block until @time
2282 * is reached. It is usually called by subclasses that use their own internal
2283 * synchronisation but want to let some synchronization (like EOS) be handled
2284 * by the base class.
2286 * This function should only be called with the PREROLL_LOCK held (like when
2287 * receiving an EOS event in the ::event vmethod or when handling buffers in
2290 * The @time argument should be the running_time of when the timeout should happen
2291 * and will be adjusted with any latency and offset configured in the sink.
2293 * Returns: #GstFlowReturn
2296 gst_base_sink_wait (GstBaseSink * sink, GstClockTime time,
2297 GstClockTimeDiff * jitter)
2299 GstClockReturn status;
2305 GST_DEBUG_OBJECT (sink, "checking preroll");
2307 /* first wait for the playing state before we can continue */
2308 while (G_UNLIKELY (sink->need_preroll)) {
2309 ret = gst_base_sink_wait_preroll (sink);
2310 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2314 /* preroll done, we can sync since we are in PLAYING now. */
2315 GST_DEBUG_OBJECT (sink, "possibly waiting for clock to reach %"
2316 GST_TIME_FORMAT, GST_TIME_ARGS (time));
2318 /* compensate for latency, ts_offset and render delay */
2319 stime = gst_base_sink_adjust_time (sink, time);
2321 /* wait for the clock, this can be interrupted because we got shut down or
2323 status = gst_base_sink_wait_clock (sink, stime, jitter);
2325 GST_DEBUG_OBJECT (sink, "clock returned %d", status);
2327 /* invalid time, no clock or sync disabled, just continue then */
2328 if (status == GST_CLOCK_BADTIME)
2331 /* waiting could have been interrupted and we can be flushing now */
2332 if (G_UNLIKELY (sink->flushing))
2335 /* retry if we got unscheduled, which means we did not reach the timeout
2336 * yet. if some other error occures, we continue. */
2337 } while (status == GST_CLOCK_UNSCHEDULED);
2339 GST_DEBUG_OBJECT (sink, "end of stream");
2346 GST_DEBUG_OBJECT (sink, "we are flushing");
2347 return GST_FLOW_FLUSHING;
2351 /* with STREAM_LOCK, PREROLL_LOCK
2353 * Make sure we are in PLAYING and synchronize an object to the clock.
2355 * If we need preroll, we are not in PLAYING. We try to commit the state
2356 * if needed and then block if we still are not PLAYING.
2358 * We start waiting on the clock in PLAYING. If we got interrupted, we
2359 * immediately try to re-preroll.
2361 * Some objects do not need synchronisation (most events) and so this function
2362 * immediately returns GST_FLOW_OK.
2364 * for objects that arrive later than max-lateness to be synchronized to the
2365 * clock have the @late boolean set to TRUE.
2367 * This function keeps a running average of the jitter (the diff between the
2368 * clock time and the requested sync time). The jitter is negative for
2369 * objects that arrive in time and positive for late buffers.
2371 * does not take ownership of obj.
2373 static GstFlowReturn
2374 gst_base_sink_do_sync (GstBaseSink * basesink,
2375 GstMiniObject * obj, gboolean * late, gboolean * step_end)
2377 GstClockTimeDiff jitter = 0;
2379 GstClockReturn status = GST_CLOCK_OK;
2380 GstClockTime rstart, rstop, rnext, sstart, sstop, stime;
2382 GstBaseSinkPrivate *priv;
2384 GstStepInfo *current, *pending;
2387 priv = basesink->priv;
2390 sstart = sstop = rstart = rstop = rnext = GST_CLOCK_TIME_NONE;
2394 priv->current_rstart = GST_CLOCK_TIME_NONE;
2396 /* get stepping info */
2397 current = &priv->current_step;
2398 pending = &priv->pending_step;
2400 /* get timing information for this object against the render segment */
2401 syncable = gst_base_sink_get_sync_times (basesink, obj,
2402 &sstart, &sstop, &rstart, &rstop, &rnext, &do_sync, &stepped, current,
2405 if (G_UNLIKELY (stepped))
2408 /* a syncable object needs to participate in preroll and
2409 * clocking. All buffers and EOS are syncable. */
2410 if (G_UNLIKELY (!syncable))
2413 /* store timing info for current object */
2414 priv->current_rstart = rstart;
2415 priv->current_rstop = (GST_CLOCK_TIME_IS_VALID (rstop) ? rstop : rstart);
2417 /* save sync time for eos when the previous object needed sync */
2418 priv->eos_rtime = (do_sync ? rnext : GST_CLOCK_TIME_NONE);
2420 /* calculate inter frame spacing */
2421 if (G_UNLIKELY (priv->prev_rstart != -1 && priv->prev_rstart < rstart)) {
2422 GstClockTime in_diff;
2424 in_diff = rstart - priv->prev_rstart;
2426 if (priv->avg_in_diff == -1)
2427 priv->avg_in_diff = in_diff;
2429 priv->avg_in_diff = UPDATE_RUNNING_AVG (priv->avg_in_diff, in_diff);
2431 GST_LOG_OBJECT (basesink, "avg frame diff %" GST_TIME_FORMAT,
2432 GST_TIME_ARGS (priv->avg_in_diff));
2435 priv->prev_rstart = rstart;
2437 if (G_UNLIKELY (priv->earliest_in_time != -1
2438 && rstart < priv->earliest_in_time))
2442 /* first do preroll, this makes sure we commit our state
2443 * to PAUSED and can continue to PLAYING. We cannot perform
2444 * any clock sync in PAUSED because there is no clock. */
2445 ret = gst_base_sink_do_preroll (basesink, obj);
2446 if (G_UNLIKELY (ret != GST_FLOW_OK))
2447 goto preroll_failed;
2449 /* update the segment with a pending step if the current one is invalid and we
2450 * have a new pending one. We only accept new step updates after a preroll */
2451 if (G_UNLIKELY (pending->valid && !current->valid)) {
2452 start_stepping (basesink, &basesink->segment, pending, current);
2456 /* After rendering we store the position of the last buffer so that we can use
2457 * it to report the position. We need to take the lock here. */
2458 GST_OBJECT_LOCK (basesink);
2459 priv->current_sstart = sstart;
2460 priv->current_sstop = (GST_CLOCK_TIME_IS_VALID (sstop) ? sstop : sstart);
2461 GST_OBJECT_UNLOCK (basesink);
2466 /* adjust for latency */
2467 stime = gst_base_sink_adjust_time (basesink, rstart);
2469 /* adjust for rate control */
2470 if (priv->rc_next == -1 || (stime != -1 && stime >= priv->rc_next)) {
2471 GST_DEBUG_OBJECT (basesink, "reset rc_time to time %" GST_TIME_FORMAT,
2472 GST_TIME_ARGS (stime));
2473 priv->rc_time = stime;
2474 priv->rc_accumulated = 0;
2476 GST_DEBUG_OBJECT (basesink, "rate control next %" GST_TIME_FORMAT,
2477 GST_TIME_ARGS (priv->rc_next));
2478 stime = priv->rc_next;
2481 /* preroll done, we can sync since we are in PLAYING now. */
2482 GST_DEBUG_OBJECT (basesink, "possibly waiting for clock to reach %"
2483 GST_TIME_FORMAT ", adjusted %" GST_TIME_FORMAT,
2484 GST_TIME_ARGS (rstart), GST_TIME_ARGS (stime));
2486 /* This function will return immediately if start == -1, no clock
2487 * or sync is disabled with GST_CLOCK_BADTIME. */
2488 status = gst_base_sink_wait_clock (basesink, stime, &jitter);
2490 GST_DEBUG_OBJECT (basesink, "clock returned %d, jitter %c%" GST_TIME_FORMAT,
2491 status, (jitter < 0 ? '-' : ' '), GST_TIME_ARGS (ABS (jitter)));
2493 /* invalid time, no clock or sync disabled, just render */
2494 if (status == GST_CLOCK_BADTIME)
2497 /* waiting could have been interrupted and we can be flushing now */
2498 if (G_UNLIKELY (basesink->flushing))
2501 /* check for unlocked by a state change, we are not flushing so
2502 * we can try to preroll on the current buffer. */
2503 if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED)) {
2504 GST_DEBUG_OBJECT (basesink, "unscheduled, waiting some more");
2505 priv->call_preroll = TRUE;
2509 /* successful syncing done, record observation */
2510 priv->current_jitter = jitter;
2512 /* check if the object should be dropped */
2513 *late = gst_base_sink_is_too_late (basesink, obj, rstart, rstop,
2514 status, jitter, TRUE);
2522 GST_DEBUG_OBJECT (basesink, "skipped stepped object %p", obj);
2528 GST_DEBUG_OBJECT (basesink, "non syncable object %p", obj);
2533 GST_DEBUG_OBJECT (basesink, "dropped because of QoS %p", obj);
2539 GST_DEBUG_OBJECT (basesink, "we are flushing");
2540 return GST_FLOW_FLUSHING;
2544 GST_DEBUG_OBJECT (basesink, "preroll failed");
2551 gst_base_sink_send_qos (GstBaseSink * basesink, GstQOSType type,
2552 gdouble proportion, GstClockTime time, GstClockTimeDiff diff)
2557 /* generate Quality-of-Service event */
2558 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2559 "qos: type %d, proportion: %lf, diff %" G_GINT64_FORMAT ", timestamp %"
2560 GST_TIME_FORMAT, type, proportion, diff, GST_TIME_ARGS (time));
2562 event = gst_event_new_qos (type, proportion, diff, time);
2565 res = gst_pad_push_event (basesink->sinkpad, event);
2571 gst_base_sink_perform_qos (GstBaseSink * sink, gboolean dropped)
2573 GstBaseSinkPrivate *priv;
2574 GstClockTime start, stop;
2575 GstClockTimeDiff jitter;
2576 GstClockTime pt, entered, left;
2577 GstClockTime duration;
2582 start = priv->current_rstart;
2584 if (priv->current_step.valid)
2587 /* if Quality-of-Service disabled, do nothing */
2588 if (!g_atomic_int_get (&priv->qos_enabled) ||
2589 !GST_CLOCK_TIME_IS_VALID (start))
2592 stop = priv->current_rstop;
2593 jitter = priv->current_jitter;
2596 /* this is the time the buffer entered the sink */
2597 if (start < -jitter)
2600 entered = start + jitter;
2603 /* this is the time the buffer entered the sink */
2604 entered = start + jitter;
2605 /* this is the time the buffer left the sink */
2606 left = start + jitter;
2609 /* calculate duration of the buffer */
2610 if (GST_CLOCK_TIME_IS_VALID (stop) && stop != start)
2611 duration = stop - start;
2613 duration = priv->avg_in_diff;
2615 /* if we have the time when the last buffer left us, calculate
2616 * processing time */
2617 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2618 if (entered > priv->last_left) {
2619 pt = entered - priv->last_left;
2627 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "start: %" GST_TIME_FORMAT
2628 ", stop %" GST_TIME_FORMAT ", entered %" GST_TIME_FORMAT ", left %"
2629 GST_TIME_FORMAT ", pt: %" GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT
2630 ",jitter %" G_GINT64_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (stop),
2631 GST_TIME_ARGS (entered), GST_TIME_ARGS (left), GST_TIME_ARGS (pt),
2632 GST_TIME_ARGS (duration), jitter);
2634 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "avg_duration: %" GST_TIME_FORMAT
2635 ", avg_pt: %" GST_TIME_FORMAT ", avg_rate: %g",
2636 GST_TIME_ARGS (priv->avg_duration), GST_TIME_ARGS (priv->avg_pt),
2639 /* collect running averages. for first observations, we copy the
2641 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_duration))
2642 priv->avg_duration = duration;
2644 priv->avg_duration = UPDATE_RUNNING_AVG (priv->avg_duration, duration);
2646 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_pt))
2649 priv->avg_pt = UPDATE_RUNNING_AVG (priv->avg_pt, pt);
2651 if (priv->avg_duration != 0)
2653 gst_guint64_to_gdouble (priv->avg_pt) /
2654 gst_guint64_to_gdouble (priv->avg_duration);
2658 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2659 if (dropped || priv->avg_rate < 0.0) {
2660 priv->avg_rate = rate;
2663 priv->avg_rate = UPDATE_RUNNING_AVG_N (priv->avg_rate, rate);
2665 priv->avg_rate = UPDATE_RUNNING_AVG_P (priv->avg_rate, rate);
2669 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink,
2670 "updated: avg_duration: %" GST_TIME_FORMAT ", avg_pt: %" GST_TIME_FORMAT
2671 ", avg_rate: %g", GST_TIME_ARGS (priv->avg_duration),
2672 GST_TIME_ARGS (priv->avg_pt), priv->avg_rate);
2675 if (priv->avg_rate >= 0.0) {
2677 GstClockTimeDiff diff;
2679 /* if we have a valid rate, start sending QoS messages */
2680 if (priv->current_jitter < 0) {
2681 /* make sure we never go below 0 when adding the jitter to the
2683 if (priv->current_rstart < -priv->current_jitter)
2684 priv->current_jitter = -priv->current_rstart;
2687 if (priv->throttle_time > 0) {
2688 diff = priv->throttle_time;
2689 type = GST_QOS_TYPE_THROTTLE;
2691 diff = priv->current_jitter;
2693 type = GST_QOS_TYPE_OVERFLOW;
2695 type = GST_QOS_TYPE_UNDERFLOW;
2698 gst_base_sink_send_qos (sink, type, priv->avg_rate, priv->current_rstart,
2702 /* record when this buffer will leave us */
2703 priv->last_left = left;
2706 /* reset all qos measuring */
2708 gst_base_sink_reset_qos (GstBaseSink * sink)
2710 GstBaseSinkPrivate *priv;
2714 priv->last_render_time = GST_CLOCK_TIME_NONE;
2715 priv->prev_rstart = GST_CLOCK_TIME_NONE;
2716 priv->earliest_in_time = GST_CLOCK_TIME_NONE;
2717 priv->last_left = GST_CLOCK_TIME_NONE;
2718 priv->avg_duration = GST_CLOCK_TIME_NONE;
2719 priv->avg_pt = GST_CLOCK_TIME_NONE;
2720 priv->avg_rate = -1.0;
2721 priv->avg_render = GST_CLOCK_TIME_NONE;
2722 priv->avg_in_diff = GST_CLOCK_TIME_NONE;
2728 /* Checks if the object was scheduled too late.
2730 * rstart/rstop contain the running_time start and stop values
2733 * status and jitter contain the return values from the clock wait.
2735 * returns TRUE if the buffer was too late.
2738 gst_base_sink_is_too_late (GstBaseSink * basesink, GstMiniObject * obj,
2739 GstClockTime rstart, GstClockTime rstop,
2740 GstClockReturn status, GstClockTimeDiff jitter, gboolean render)
2743 guint64 max_lateness;
2744 GstBaseSinkPrivate *priv;
2746 priv = basesink->priv;
2750 /* only for objects that were too late */
2751 if (G_LIKELY (status != GST_CLOCK_EARLY))
2754 max_lateness = basesink->max_lateness;
2756 /* check if frame dropping is enabled */
2757 if (max_lateness == -1)
2760 /* only check for buffers */
2761 if (G_UNLIKELY (!GST_IS_BUFFER (obj)))
2764 /* can't do check if we don't have a timestamp */
2765 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (rstart)))
2768 /* we can add a valid stop time */
2769 if (GST_CLOCK_TIME_IS_VALID (rstop))
2770 max_lateness += rstop;
2772 max_lateness += rstart;
2773 /* no stop time, use avg frame diff */
2774 if (priv->avg_in_diff != -1)
2775 max_lateness += priv->avg_in_diff;
2778 /* if the jitter bigger than duration and lateness we are too late */
2779 if ((late = rstart + jitter > max_lateness)) {
2780 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2781 "buffer is too late %" GST_TIME_FORMAT
2782 " > %" GST_TIME_FORMAT, GST_TIME_ARGS (rstart + jitter),
2783 GST_TIME_ARGS (max_lateness));
2784 /* !!emergency!!, if we did not receive anything valid for more than a
2785 * second, render it anyway so the user sees something */
2786 if (GST_CLOCK_TIME_IS_VALID (priv->last_render_time) &&
2787 rstart - priv->last_render_time > GST_SECOND) {
2789 GST_ELEMENT_WARNING (basesink, CORE, CLOCK,
2790 (_("A lot of buffers are being dropped.")),
2791 ("There may be a timestamping problem, or this computer is too slow."));
2792 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2793 "**emergency** last buffer at %" GST_TIME_FORMAT " > GST_SECOND",
2794 GST_TIME_ARGS (priv->last_render_time));
2799 if (render && (!late || !GST_CLOCK_TIME_IS_VALID (priv->last_render_time))) {
2800 priv->last_render_time = rstart;
2801 /* the next allowed input timestamp */
2802 if (priv->throttle_time > 0)
2803 priv->earliest_in_time = rstart + priv->throttle_time;
2810 GST_DEBUG_OBJECT (basesink, "object was scheduled in time");
2815 GST_DEBUG_OBJECT (basesink, "frame dropping disabled");
2820 GST_DEBUG_OBJECT (basesink, "object is not a buffer");
2825 GST_DEBUG_OBJECT (basesink, "buffer has no timestamp");
2830 /* called before and after calling the render vmethod. It keeps track of how
2831 * much time was spent in the render method and is used to check if we are
2834 gst_base_sink_do_render_stats (GstBaseSink * basesink, gboolean start)
2836 GstBaseSinkPrivate *priv;
2838 priv = basesink->priv;
2841 priv->start = gst_util_get_timestamp ();
2843 GstClockTime elapsed;
2845 priv->stop = gst_util_get_timestamp ();
2847 elapsed = GST_CLOCK_DIFF (priv->start, priv->stop);
2849 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_render))
2850 priv->avg_render = elapsed;
2852 priv->avg_render = UPDATE_RUNNING_AVG (priv->avg_render, elapsed);
2854 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2855 "avg_render: %" GST_TIME_FORMAT, GST_TIME_ARGS (priv->avg_render));
2860 gst_base_sink_flush_start (GstBaseSink * basesink, GstPad * pad)
2862 /* make sure we are not blocked on the clock also clear any pending
2864 gst_base_sink_set_flushing (basesink, pad, TRUE);
2866 /* we grab the stream lock but that is not needed since setting the
2867 * sink to flushing would make sure no state commit is being done
2869 GST_PAD_STREAM_LOCK (pad);
2870 gst_base_sink_reset_qos (basesink);
2871 /* and we need to commit our state again on the next
2872 * prerolled buffer */
2873 basesink->playing_async = TRUE;
2874 if (basesink->priv->async_enabled) {
2875 gst_element_lost_state (GST_ELEMENT_CAST (basesink));
2877 /* start time reset in above case as well;
2878 * arranges for a.o. proper position reporting when flushing in PAUSED */
2879 gst_element_set_start_time (GST_ELEMENT_CAST (basesink), 0);
2880 basesink->priv->have_latency = TRUE;
2882 gst_base_sink_set_last_buffer (basesink, NULL);
2883 GST_PAD_STREAM_UNLOCK (pad);
2887 gst_base_sink_flush_stop (GstBaseSink * basesink, GstPad * pad,
2888 gboolean reset_time)
2890 /* unset flushing so we can accept new data, this also flushes out any EOS
2892 gst_base_sink_set_flushing (basesink, pad, FALSE);
2894 /* for position reporting */
2895 GST_OBJECT_LOCK (basesink);
2896 basesink->priv->current_sstart = GST_CLOCK_TIME_NONE;
2897 basesink->priv->current_sstop = GST_CLOCK_TIME_NONE;
2898 basesink->priv->eos_rtime = GST_CLOCK_TIME_NONE;
2899 basesink->priv->call_preroll = TRUE;
2900 basesink->priv->current_step.valid = FALSE;
2901 basesink->priv->pending_step.valid = FALSE;
2902 if (basesink->pad_mode == GST_PAD_MODE_PUSH) {
2903 /* we need new segment info after the flush. */
2904 basesink->have_newsegment = FALSE;
2906 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
2907 GST_ELEMENT_START_TIME (basesink) = 0;
2910 GST_OBJECT_UNLOCK (basesink);
2913 GST_DEBUG_OBJECT (basesink, "posting reset-time message");
2914 gst_element_post_message (GST_ELEMENT_CAST (basesink),
2915 gst_message_new_reset_time (GST_OBJECT_CAST (basesink), 0));
2919 static GstFlowReturn
2920 gst_base_sink_default_wait_event (GstBaseSink * basesink, GstEvent * event)
2923 gboolean late, step_end = FALSE;
2925 ret = gst_base_sink_do_sync (basesink, GST_MINI_OBJECT_CAST (event),
2931 static GstFlowReturn
2932 gst_base_sink_wait_event (GstBaseSink * basesink, GstEvent * event)
2935 GstBaseSinkClass *bclass;
2937 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2939 if (G_LIKELY (bclass->wait_event))
2940 ret = bclass->wait_event (basesink, event);
2942 ret = GST_FLOW_NOT_SUPPORTED;
2948 gst_base_sink_default_event (GstBaseSink * basesink, GstEvent * event)
2950 gboolean result = TRUE;
2951 GstBaseSinkClass *bclass;
2953 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2955 switch (GST_EVENT_TYPE (event)) {
2956 case GST_EVENT_FLUSH_START:
2958 GST_DEBUG_OBJECT (basesink, "flush-start %p", event);
2959 gst_base_sink_flush_start (basesink, basesink->sinkpad);
2962 case GST_EVENT_FLUSH_STOP:
2964 gboolean reset_time;
2966 gst_event_parse_flush_stop (event, &reset_time);
2967 GST_DEBUG_OBJECT (basesink, "flush-stop %p, reset_time: %d", event,
2969 gst_base_sink_flush_stop (basesink, basesink->sinkpad, reset_time);
2974 GstMessage *message;
2977 /* we set the received EOS flag here so that we can use it when testing if
2978 * we are prerolled and to refuse more buffers. */
2979 basesink->priv->received_eos = TRUE;
2982 if (G_UNLIKELY (gst_base_sink_wait_event (basesink,
2983 event) != GST_FLOW_OK)) {
2988 /* the EOS event is completely handled so we mark
2989 * ourselves as being in the EOS state. eos is also
2990 * protected by the object lock so we can read it when
2991 * answering the POSITION query. */
2992 GST_OBJECT_LOCK (basesink);
2993 basesink->eos = TRUE;
2994 GST_OBJECT_UNLOCK (basesink);
2996 /* ok, now we can post the message */
2997 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
2999 seqnum = basesink->priv->seqnum = gst_event_get_seqnum (event);
3000 GST_DEBUG_OBJECT (basesink, "Got seqnum #%" G_GUINT32_FORMAT, seqnum);
3002 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
3003 gst_message_set_seqnum (message, seqnum);
3004 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
3007 case GST_EVENT_STREAM_START:
3009 GstMessage *message;
3012 seqnum = gst_event_get_seqnum (event);
3013 GST_DEBUG_OBJECT (basesink, "Now posting STREAM_START (seqnum:%d)",
3015 message = gst_message_new_stream_start (GST_OBJECT_CAST (basesink));
3016 gst_message_set_seqnum (message, seqnum);
3017 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
3020 case GST_EVENT_CAPS:
3024 GST_DEBUG_OBJECT (basesink, "caps %p", event);
3026 gst_event_parse_caps (event, &caps);
3027 if (bclass->set_caps)
3028 result = bclass->set_caps (basesink, caps);
3031 GST_OBJECT_LOCK (basesink);
3032 gst_caps_replace (&basesink->priv->caps, caps);
3033 GST_OBJECT_UNLOCK (basesink);
3037 case GST_EVENT_SEGMENT:
3038 /* configure the segment */
3039 /* The segment is protected with both the STREAM_LOCK and the OBJECT_LOCK.
3040 * We protect with the OBJECT_LOCK so that we can use the values to
3041 * safely answer a POSITION query. */
3042 GST_OBJECT_LOCK (basesink);
3043 /* the newsegment event is needed to bring the buffer timestamps to the
3044 * stream time and to drop samples outside of the playback segment. */
3045 gst_event_copy_segment (event, &basesink->segment);
3046 GST_DEBUG_OBJECT (basesink, "configured segment %" GST_SEGMENT_FORMAT,
3047 &basesink->segment);
3048 basesink->have_newsegment = TRUE;
3049 GST_OBJECT_UNLOCK (basesink);
3053 if (G_UNLIKELY (gst_base_sink_wait_event (basesink,
3054 event) != GST_FLOW_OK))
3060 GstTagList *taglist;
3062 gst_event_parse_tag (event, &taglist);
3064 gst_element_post_message (GST_ELEMENT_CAST (basesink),
3065 gst_message_new_tag (GST_OBJECT_CAST (basesink),
3066 gst_tag_list_copy (taglist)));
3074 gst_event_parse_toc (event, &toc, &updated);
3076 gst_element_post_message (GST_ELEMENT_CAST (basesink),
3077 gst_message_new_toc (GST_OBJECT_CAST (basesink), toc, updated));
3079 gst_toc_unref (toc);
3082 case GST_EVENT_SINK_MESSAGE:
3084 GstMessage *msg = NULL;
3086 gst_event_parse_sink_message (event, &msg);
3088 gst_element_post_message (GST_ELEMENT_CAST (basesink), msg);
3095 gst_event_unref (event);
3101 gst_base_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
3103 GstBaseSink *basesink;
3104 gboolean result = TRUE;
3105 GstBaseSinkClass *bclass;
3107 basesink = GST_BASE_SINK_CAST (parent);
3108 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3110 GST_DEBUG_OBJECT (basesink, "received event %p %" GST_PTR_FORMAT, event,
3113 switch (GST_EVENT_TYPE (event)) {
3114 case GST_EVENT_FLUSH_STOP:
3115 /* special case for this serialized event because we don't want to grab
3116 * the PREROLL lock or check if we were flushing */
3118 result = bclass->event (basesink, event);
3121 if (GST_EVENT_IS_SERIALIZED (event)) {
3122 GST_BASE_SINK_PREROLL_LOCK (basesink);
3123 if (G_UNLIKELY (basesink->flushing))
3126 if (G_UNLIKELY (basesink->priv->received_eos))
3130 result = bclass->event (basesink, event);
3132 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3135 result = bclass->event (basesink, event);
3145 GST_DEBUG_OBJECT (basesink, "we are flushing");
3146 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3147 gst_event_unref (event);
3154 GST_DEBUG_OBJECT (basesink, "Event received after EOS, dropping");
3155 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3156 gst_event_unref (event);
3162 /* default implementation to calculate the start and end
3163 * timestamps on a buffer, subclasses can override
3166 gst_base_sink_default_get_times (GstBaseSink * basesink, GstBuffer * buffer,
3167 GstClockTime * start, GstClockTime * end)
3169 GstClockTime timestamp, duration;
3171 /* first sync on DTS, else use PTS */
3172 timestamp = GST_BUFFER_DTS (buffer);
3173 if (!GST_CLOCK_TIME_IS_VALID (timestamp))
3174 timestamp = GST_BUFFER_PTS (buffer);
3176 if (GST_CLOCK_TIME_IS_VALID (timestamp)) {
3177 /* get duration to calculate end time */
3178 duration = GST_BUFFER_DURATION (buffer);
3179 if (GST_CLOCK_TIME_IS_VALID (duration)) {
3180 *end = timestamp + duration;
3186 /* must be called with PREROLL_LOCK */
3188 gst_base_sink_needs_preroll (GstBaseSink * basesink)
3190 gboolean is_prerolled, res;
3192 /* we have 2 cases where the PREROLL_LOCK is released:
3193 * 1) we are blocking in the PREROLL_LOCK and thus are prerolled.
3194 * 2) we are syncing on the clock
3196 is_prerolled = basesink->have_preroll || basesink->priv->received_eos;
3197 res = !is_prerolled;
3199 GST_DEBUG_OBJECT (basesink, "have_preroll: %d, EOS: %d => needs preroll: %d",
3200 basesink->have_preroll, basesink->priv->received_eos, res);
3206 count_list_bytes (GstBuffer ** buffer, guint idx, GstBaseSinkPrivate * priv)
3208 priv->rc_accumulated += gst_buffer_get_size (*buffer);
3212 /* with STREAM_LOCK, PREROLL_LOCK
3214 * Takes a buffer and compare the timestamps with the last segment.
3215 * If the buffer falls outside of the segment boundaries, drop it.
3216 * Else send the buffer for preroll and rendering.
3218 * This function takes ownership of the buffer.
3220 static GstFlowReturn
3221 gst_base_sink_chain_unlocked (GstBaseSink * basesink, GstPad * pad,
3222 gpointer obj, gboolean is_list)
3224 GstBaseSinkClass *bclass;
3225 GstBaseSinkPrivate *priv = basesink->priv;
3226 GstFlowReturn ret = GST_FLOW_OK;
3227 GstClockTime start = GST_CLOCK_TIME_NONE, end = GST_CLOCK_TIME_NONE;
3228 GstSegment *segment;
3229 GstBuffer *sync_buf;
3231 gboolean late, step_end;
3233 if (G_UNLIKELY (basesink->flushing))
3236 if (G_UNLIKELY (priv->received_eos))
3240 sync_buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0);
3241 g_assert (NULL != sync_buf);
3243 sync_buf = GST_BUFFER_CAST (obj);
3246 /* for code clarity */
3247 segment = &basesink->segment;
3249 if (G_UNLIKELY (!basesink->have_newsegment)) {
3252 sync = gst_base_sink_get_sync (basesink);
3254 GST_ELEMENT_WARNING (basesink, STREAM, FAILED,
3255 (_("Internal data flow problem.")),
3256 ("Received buffer without a new-segment. Assuming timestamps start from 0."));
3259 /* this means this sink will assume timestamps start from 0 */
3260 GST_OBJECT_LOCK (basesink);
3263 basesink->segment.start = 0;
3264 basesink->segment.stop = -1;
3265 basesink->have_newsegment = TRUE;
3266 GST_OBJECT_UNLOCK (basesink);
3269 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3271 /* check if the buffer needs to be dropped, we first ask the subclass for the
3273 if (bclass->get_times)
3274 bclass->get_times (basesink, sync_buf, &start, &end);
3276 if (!GST_CLOCK_TIME_IS_VALID (start)) {
3277 /* if the subclass does not want sync, we use our own values so that we at
3278 * least clip the buffer to the segment */
3279 gst_base_sink_default_get_times (basesink, sync_buf, &start, &end);
3282 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
3283 ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (end));
3285 /* a dropped buffer does not participate in anything */
3286 if (GST_CLOCK_TIME_IS_VALID (start) && (segment->format == GST_FORMAT_TIME)) {
3287 if (G_UNLIKELY (!gst_segment_clip (segment,
3288 GST_FORMAT_TIME, start, end, NULL, NULL)))
3289 goto out_of_segment;
3292 if (bclass->prepare || bclass->prepare_list) {
3293 gboolean late = FALSE;
3294 gboolean do_sync = TRUE, stepped = FALSE, step_end = FALSE, syncable = TRUE;
3295 GstClockTime sstart, sstop, rstart, rstop, rnext;
3296 GstStepInfo *current;
3298 current = &priv->current_step;
3300 gst_base_sink_get_sync_times (basesink, obj, &sstart, &sstop, &rstart,
3301 &rstop, &rnext, &do_sync, &stepped, current, &step_end);
3303 if (!stepped && syncable && do_sync)
3305 gst_base_sink_is_too_late (basesink, obj, rstart, rstop,
3306 GST_CLOCK_EARLY, 0, FALSE);
3311 if (bclass->prepare) {
3312 ret = bclass->prepare (basesink, GST_BUFFER_CAST (obj));
3313 if (G_UNLIKELY (ret != GST_FLOW_OK))
3314 goto prepare_failed;
3317 if (bclass->prepare_list) {
3318 ret = bclass->prepare_list (basesink, GST_BUFFER_LIST_CAST (obj));
3319 if (G_UNLIKELY (ret != GST_FLOW_OK))
3320 goto prepare_failed;
3329 /* synchronize this object, non syncable objects return OK
3331 ret = gst_base_sink_do_sync (basesink, GST_MINI_OBJECT_CAST (sync_buf),
3333 if (G_UNLIKELY (ret != GST_FLOW_OK))
3336 /* drop late buffers unconditionally, let's hope it's unlikely */
3337 if (G_UNLIKELY (late))
3340 if (priv->max_bitrate) {
3342 gst_buffer_list_foreach (GST_BUFFER_LIST_CAST (obj),
3343 (GstBufferListFunc) count_list_bytes, priv);
3345 priv->rc_accumulated += gst_buffer_get_size (GST_BUFFER_CAST (obj));
3347 priv->rc_next = priv->rc_time + gst_util_uint64_scale (priv->rc_accumulated,
3348 8 * GST_SECOND, priv->max_bitrate);
3351 /* read once, to get same value before and after */
3352 do_qos = g_atomic_int_get (&priv->qos_enabled);
3354 GST_DEBUG_OBJECT (basesink, "rendering object %p", obj);
3356 /* record rendering time for QoS and stats */
3358 gst_base_sink_do_render_stats (basesink, TRUE);
3361 /* For buffer lists do not set last buffer for now. */
3362 gst_base_sink_set_last_buffer (basesink, GST_BUFFER_CAST (obj));
3365 ret = bclass->render (basesink, GST_BUFFER_CAST (obj));
3367 if (bclass->render_list)
3368 ret = bclass->render_list (basesink, GST_BUFFER_LIST_CAST (obj));
3372 gst_base_sink_do_render_stats (basesink, FALSE);
3374 if (ret == GST_FLOW_STEP)
3377 if (G_UNLIKELY (basesink->flushing))
3384 /* the step ended, check if we need to activate a new step */
3385 GST_DEBUG_OBJECT (basesink, "step ended");
3386 stop_stepping (basesink, &basesink->segment, &priv->current_step,
3387 priv->current_rstart, priv->current_rstop, basesink->eos);
3391 gst_base_sink_perform_qos (basesink, late);
3393 GST_DEBUG_OBJECT (basesink, "object unref after render %p", obj);
3394 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3401 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3402 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3403 return GST_FLOW_FLUSHING;
3407 GST_DEBUG_OBJECT (basesink, "we are EOS, dropping object, return EOS");
3408 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3409 return GST_FLOW_EOS;
3413 GST_DEBUG_OBJECT (basesink, "dropping buffer, out of clipping segment");
3414 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3419 GST_DEBUG_OBJECT (basesink, "prepare buffer failed %s",
3420 gst_flow_get_name (ret));
3421 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3426 GST_DEBUG_OBJECT (basesink, "do_sync returned %s", gst_flow_get_name (ret));
3432 GST_DEBUG_OBJECT (basesink, "buffer late, dropping");
3434 if (g_atomic_int_get (&priv->qos_enabled)) {
3435 GstMessage *qos_msg;
3436 GstClockTime timestamp, duration;
3438 timestamp = GST_BUFFER_TIMESTAMP (GST_BUFFER_CAST (sync_buf));
3439 duration = GST_BUFFER_DURATION (GST_BUFFER_CAST (sync_buf));
3441 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
3442 "qos: dropped buffer rt %" GST_TIME_FORMAT ", st %" GST_TIME_FORMAT
3443 ", ts %" GST_TIME_FORMAT ", dur %" GST_TIME_FORMAT,
3444 GST_TIME_ARGS (priv->current_rstart),
3445 GST_TIME_ARGS (priv->current_sstart), GST_TIME_ARGS (timestamp),
3446 GST_TIME_ARGS (duration));
3447 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
3448 "qos: rendered %" G_GUINT64_FORMAT ", dropped %" G_GUINT64_FORMAT,
3449 priv->rendered, priv->dropped);
3452 gst_message_new_qos (GST_OBJECT_CAST (basesink), basesink->sync,
3453 priv->current_rstart, priv->current_sstart, timestamp, duration);
3454 gst_message_set_qos_values (qos_msg, priv->current_jitter, priv->avg_rate,
3456 gst_message_set_qos_stats (qos_msg, GST_FORMAT_BUFFERS, priv->rendered,
3458 gst_element_post_message (GST_ELEMENT_CAST (basesink), qos_msg);
3466 static GstFlowReturn
3467 gst_base_sink_chain_main (GstBaseSink * basesink, GstPad * pad, gpointer obj,
3470 GstFlowReturn result;
3472 if (G_UNLIKELY (basesink->pad_mode != GST_PAD_MODE_PUSH))
3475 GST_BASE_SINK_PREROLL_LOCK (basesink);
3476 result = gst_base_sink_chain_unlocked (basesink, pad, obj, is_list);
3477 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3485 GST_OBJECT_LOCK (pad);
3486 GST_WARNING_OBJECT (basesink,
3487 "Push on pad %s:%s, but it was not activated in push mode",
3488 GST_DEBUG_PAD_NAME (pad));
3489 GST_OBJECT_UNLOCK (pad);
3490 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3491 /* we don't post an error message this will signal to the peer
3492 * pushing that EOS is reached. */
3493 result = GST_FLOW_EOS;
3498 static GstFlowReturn
3499 gst_base_sink_chain (GstPad * pad, GstObject * parent, GstBuffer * buf)
3501 GstBaseSink *basesink;
3503 basesink = GST_BASE_SINK (parent);
3505 return gst_base_sink_chain_main (basesink, pad, buf, FALSE);
3508 static GstFlowReturn
3509 gst_base_sink_chain_list (GstPad * pad, GstObject * parent,
3510 GstBufferList * list)
3512 GstBaseSink *basesink;
3513 GstBaseSinkClass *bclass;
3514 GstFlowReturn result;
3516 basesink = GST_BASE_SINK (parent);
3517 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3519 if (G_LIKELY (bclass->render_list)) {
3520 result = gst_base_sink_chain_main (basesink, pad, list, TRUE);
3525 GST_INFO_OBJECT (pad, "chaining each buffer in list");
3527 len = gst_buffer_list_length (list);
3529 result = GST_FLOW_OK;
3530 for (i = 0; i < len; i++) {
3531 buffer = gst_buffer_list_get (list, i);
3532 result = gst_base_sink_chain_main (basesink, pad,
3533 gst_buffer_ref (buffer), FALSE);
3534 if (result != GST_FLOW_OK)
3537 gst_buffer_list_unref (list);
3544 gst_base_sink_default_do_seek (GstBaseSink * sink, GstSegment * segment)
3546 gboolean res = TRUE;
3548 /* update our offset if the start/stop position was updated */
3549 if (segment->format == GST_FORMAT_BYTES) {
3550 segment->time = segment->start;
3551 } else if (segment->start == 0) {
3552 /* seek to start, we can implement a default for this. */
3556 GST_INFO_OBJECT (sink, "Can't do a default seek");
3562 #define SEEK_TYPE_IS_RELATIVE(t) (((t) != GST_SEEK_TYPE_NONE) && ((t) != GST_SEEK_TYPE_SET))
3565 gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
3566 GstEvent * event, GstSegment * segment)
3568 /* By default, we try one of 2 things:
3569 * - For absolute seek positions, convert the requested position to our
3570 * configured processing format and place it in the output segment \
3571 * - For relative seek positions, convert our current (input) values to the
3572 * seek format, adjust by the relative seek offset and then convert back to
3573 * the processing format
3575 GstSeekType start_type, stop_type;
3578 GstFormat seek_format;
3581 gboolean res = TRUE;
3583 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3584 &start_type, &start, &stop_type, &stop);
3586 if (seek_format == segment->format) {
3587 gst_segment_do_seek (segment, rate, seek_format, flags,
3588 start_type, start, stop_type, stop, &update);
3592 if (start_type != GST_SEEK_TYPE_NONE) {
3593 /* FIXME: Handle seek_end by converting the input segment vals */
3595 gst_pad_query_convert (sink->sinkpad, seek_format, start,
3596 segment->format, &start);
3597 start_type = GST_SEEK_TYPE_SET;
3600 if (res && stop_type != GST_SEEK_TYPE_NONE) {
3601 /* FIXME: Handle seek_end by converting the input segment vals */
3603 gst_pad_query_convert (sink->sinkpad, seek_format, stop,
3604 segment->format, &stop);
3605 stop_type = GST_SEEK_TYPE_SET;
3608 /* And finally, configure our output segment in the desired format */
3609 gst_segment_do_seek (segment, rate, segment->format, flags, start_type, start,
3610 stop_type, stop, &update);
3619 GST_DEBUG_OBJECT (sink, "undefined format given, seek aborted.");
3624 /* perform a seek, only executed in pull mode */
3626 gst_base_sink_perform_seek (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3630 GstFormat seek_format, dest_format;
3632 GstSeekType start_type, stop_type;
3633 gboolean seekseg_configured = FALSE;
3635 gboolean update, res = TRUE;
3636 GstSegment seeksegment;
3638 dest_format = sink->segment.format;
3641 GST_DEBUG_OBJECT (sink, "performing seek with event %p", event);
3642 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3643 &start_type, &start, &stop_type, &stop);
3645 flush = flags & GST_SEEK_FLAG_FLUSH;
3647 GST_DEBUG_OBJECT (sink, "performing seek without event");
3652 GST_DEBUG_OBJECT (sink, "flushing upstream");
3653 gst_pad_push_event (pad, gst_event_new_flush_start ());
3654 gst_base_sink_flush_start (sink, pad);
3656 GST_DEBUG_OBJECT (sink, "pausing pulling thread");
3659 GST_PAD_STREAM_LOCK (pad);
3661 /* If we configured the seeksegment above, don't overwrite it now. Otherwise
3662 * copy the current segment info into the temp segment that we can actually
3663 * attempt the seek with. We only update the real segment if the seek succeeds. */
3664 if (!seekseg_configured) {
3665 memcpy (&seeksegment, &sink->segment, sizeof (GstSegment));
3667 /* now configure the final seek segment */
3669 if (sink->segment.format != seek_format) {
3670 /* OK, here's where we give the subclass a chance to convert the relative
3671 * seek into an absolute one in the processing format. We set up any
3672 * absolute seek above, before taking the stream lock. */
3673 if (!gst_base_sink_default_prepare_seek_segment (sink, event,
3675 GST_DEBUG_OBJECT (sink,
3676 "Preparing the seek failed after flushing. " "Aborting seek");
3680 /* The seek format matches our processing format, no need to ask the
3681 * the subclass to configure the segment. */
3682 gst_segment_do_seek (&seeksegment, rate, seek_format, flags,
3683 start_type, start, stop_type, stop, &update);
3686 /* Else, no seek event passed, so we're just (re)starting the
3691 GST_DEBUG_OBJECT (sink, "segment configured from %" G_GINT64_FORMAT
3692 " to %" G_GINT64_FORMAT ", position %" G_GINT64_FORMAT,
3693 seeksegment.start, seeksegment.stop, seeksegment.position);
3695 /* do the seek, segment.position contains the new position. */
3696 res = gst_base_sink_default_do_seek (sink, &seeksegment);
3700 GST_DEBUG_OBJECT (sink, "stop flushing upstream");
3701 gst_pad_push_event (pad, gst_event_new_flush_stop (TRUE));
3702 gst_base_sink_flush_stop (sink, pad, TRUE);
3703 } else if (res && sink->running) {
3704 /* we are running the current segment and doing a non-flushing seek,
3705 * close the segment first based on the position. */
3706 GST_DEBUG_OBJECT (sink, "closing running segment %" G_GINT64_FORMAT
3707 " to %" G_GINT64_FORMAT, sink->segment.start, sink->segment.position);
3710 /* The subclass must have converted the segment to the processing format
3712 if (res && seeksegment.format != dest_format) {
3713 GST_DEBUG_OBJECT (sink, "Subclass failed to prepare a seek segment "
3714 "in the correct format. Aborting seek.");
3718 GST_INFO_OBJECT (sink, "seeking done %d: %" GST_SEGMENT_FORMAT, res,
3721 /* if successful seek, we update our real segment and push
3722 * out the new segment. */
3724 gst_segment_copy_into (&seeksegment, &sink->segment);
3726 if (sink->segment.flags & GST_SEGMENT_FLAG_SEGMENT) {
3727 gst_element_post_message (GST_ELEMENT (sink),
3728 gst_message_new_segment_start (GST_OBJECT (sink),
3729 sink->segment.format, sink->segment.position));
3733 sink->priv->discont = TRUE;
3734 sink->running = TRUE;
3736 GST_PAD_STREAM_UNLOCK (pad);
3742 set_step_info (GstBaseSink * sink, GstStepInfo * current, GstStepInfo * pending,
3743 guint seqnum, GstFormat format, guint64 amount, gdouble rate,
3744 gboolean flush, gboolean intermediate)
3746 GST_OBJECT_LOCK (sink);
3747 pending->seqnum = seqnum;
3748 pending->format = format;
3749 pending->amount = amount;
3750 pending->position = 0;
3751 pending->rate = rate;
3752 pending->flush = flush;
3753 pending->intermediate = intermediate;
3754 pending->valid = TRUE;
3755 /* flush invalidates the current stepping segment */
3757 current->valid = FALSE;
3758 GST_OBJECT_UNLOCK (sink);
3762 gst_base_sink_perform_step (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3764 GstBaseSinkPrivate *priv;
3765 GstBaseSinkClass *bclass;
3766 gboolean flush, intermediate;
3771 GstStepInfo *pending, *current;
3772 GstMessage *message;
3774 bclass = GST_BASE_SINK_GET_CLASS (sink);
3777 GST_DEBUG_OBJECT (sink, "performing step with event %p", event);
3779 gst_event_parse_step (event, &format, &amount, &rate, &flush, &intermediate);
3780 seqnum = gst_event_get_seqnum (event);
3782 pending = &priv->pending_step;
3783 current = &priv->current_step;
3785 /* post message first */
3786 message = gst_message_new_step_start (GST_OBJECT (sink), FALSE, format,
3787 amount, rate, flush, intermediate);
3788 gst_message_set_seqnum (message, seqnum);
3789 gst_element_post_message (GST_ELEMENT (sink), message);
3792 /* we need to call ::unlock before locking PREROLL_LOCK
3793 * since we lock it before going into ::render */
3795 bclass->unlock (sink);
3797 GST_BASE_SINK_PREROLL_LOCK (sink);
3798 /* now that we have the PREROLL lock, clear our unlock request */
3799 if (bclass->unlock_stop)
3800 bclass->unlock_stop (sink);
3802 /* update the stepinfo and make it valid */
3803 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3806 if (sink->priv->async_enabled) {
3807 /* and we need to commit our state again on the next
3808 * prerolled buffer */
3809 sink->playing_async = TRUE;
3810 priv->pending_step.need_preroll = TRUE;
3811 sink->need_preroll = FALSE;
3812 gst_element_lost_state (GST_ELEMENT_CAST (sink));
3814 sink->priv->have_latency = TRUE;
3815 sink->need_preroll = FALSE;
3817 priv->current_sstart = GST_CLOCK_TIME_NONE;
3818 priv->current_sstop = GST_CLOCK_TIME_NONE;
3819 priv->eos_rtime = GST_CLOCK_TIME_NONE;
3820 priv->call_preroll = TRUE;
3821 gst_base_sink_set_last_buffer (sink, NULL);
3822 gst_base_sink_reset_qos (sink);
3824 if (sink->clock_id) {
3825 gst_clock_id_unschedule (sink->clock_id);
3828 if (sink->have_preroll) {
3829 GST_DEBUG_OBJECT (sink, "signal waiter");
3830 priv->step_unlock = TRUE;
3831 GST_BASE_SINK_PREROLL_SIGNAL (sink);
3833 GST_BASE_SINK_PREROLL_UNLOCK (sink);
3835 /* update the stepinfo and make it valid */
3836 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3846 gst_base_sink_loop (GstPad * pad)
3849 GstBaseSink *basesink;
3850 GstBuffer *buf = NULL;
3851 GstFlowReturn result;
3855 parent = GST_OBJECT_PARENT (pad);
3856 basesink = GST_BASE_SINK (parent);
3858 g_assert (basesink->pad_mode == GST_PAD_MODE_PULL);
3860 if ((blocksize = basesink->priv->blocksize) == 0)
3863 offset = basesink->segment.position;
3865 GST_DEBUG_OBJECT (basesink, "pulling %" G_GUINT64_FORMAT ", %u",
3868 result = gst_pad_pull_range (pad, offset, blocksize, &buf);
3869 if (G_UNLIKELY (result != GST_FLOW_OK))
3872 if (G_UNLIKELY (buf == NULL))
3875 offset += gst_buffer_get_size (buf);
3877 basesink->segment.position = offset;
3879 GST_BASE_SINK_PREROLL_LOCK (basesink);
3880 result = gst_base_sink_chain_unlocked (basesink, pad, buf, FALSE);
3881 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3882 if (G_UNLIKELY (result != GST_FLOW_OK))
3890 GST_LOG_OBJECT (basesink, "pausing task, reason %s",
3891 gst_flow_get_name (result));
3892 gst_pad_pause_task (pad);
3893 if (result == GST_FLOW_EOS) {
3894 /* perform EOS logic */
3895 if (basesink->segment.flags & GST_SEGMENT_FLAG_SEGMENT) {
3896 gst_element_post_message (GST_ELEMENT_CAST (basesink),
3897 gst_message_new_segment_done (GST_OBJECT_CAST (basesink),
3898 basesink->segment.format, basesink->segment.position));
3899 gst_base_sink_event (pad, parent,
3900 gst_event_new_segment_done (basesink->segment.format,
3901 basesink->segment.position));
3903 gst_base_sink_event (pad, parent, gst_event_new_eos ());
3905 } else if (result == GST_FLOW_NOT_LINKED || result <= GST_FLOW_EOS) {
3906 /* for fatal errors we post an error message, post the error
3907 * first so the app knows about the error first.
3908 * wrong-state is not a fatal error because it happens due to
3909 * flushing and posting an error message in that case is the
3910 * wrong thing to do, e.g. when basesrc is doing a flushing
3912 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
3913 (_("Internal data stream error.")),
3914 ("stream stopped, reason %s", gst_flow_get_name (result)));
3915 gst_base_sink_event (pad, parent, gst_event_new_eos ());
3921 GST_LOG_OBJECT (basesink, "no buffer, pausing");
3922 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
3923 (_("Internal data flow error.")), ("element returned NULL buffer"));
3924 result = GST_FLOW_ERROR;
3930 gst_base_sink_set_flushing (GstBaseSink * basesink, GstPad * pad,
3933 GstBaseSinkClass *bclass;
3935 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3938 /* unlock any subclasses, we need to do this before grabbing the
3939 * PREROLL_LOCK since we hold this lock before going into ::render. */
3941 bclass->unlock (basesink);
3944 GST_BASE_SINK_PREROLL_LOCK (basesink);
3945 basesink->flushing = flushing;
3947 /* step 1, now that we have the PREROLL lock, clear our unlock request */
3948 if (bclass->unlock_stop)
3949 bclass->unlock_stop (basesink);
3951 /* set need_preroll before we unblock the clock. If the clock is unblocked
3952 * before timing out, we can reuse the buffer for preroll. */
3953 basesink->need_preroll = TRUE;
3955 /* step 2, unblock clock sync (if any) or any other blocking thing */
3956 if (basesink->clock_id) {
3957 gst_clock_id_unschedule (basesink->clock_id);
3960 /* flush out the data thread if it's locked in finish_preroll, this will
3961 * also flush out the EOS state */
3962 GST_DEBUG_OBJECT (basesink,
3963 "flushing out data thread, need preroll to TRUE");
3965 /* we can't have EOS anymore now */
3966 basesink->eos = FALSE;
3967 basesink->priv->received_eos = FALSE;
3968 basesink->have_preroll = FALSE;
3969 basesink->priv->step_unlock = FALSE;
3970 /* can't report latency anymore until we preroll again */
3971 if (basesink->priv->async_enabled) {
3972 GST_OBJECT_LOCK (basesink);
3973 basesink->priv->have_latency = FALSE;
3974 GST_OBJECT_UNLOCK (basesink);
3976 /* and signal any waiters now */
3977 GST_BASE_SINK_PREROLL_SIGNAL (basesink);
3979 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3985 gst_base_sink_default_activate_pull (GstBaseSink * basesink, gboolean active)
3991 result = gst_pad_start_task (basesink->sinkpad,
3992 (GstTaskFunction) gst_base_sink_loop, basesink->sinkpad, NULL);
3994 /* step 2, make sure streaming finishes */
3995 result = gst_pad_stop_task (basesink->sinkpad);
4002 gst_base_sink_pad_activate (GstPad * pad, GstObject * parent)
4004 gboolean result = FALSE;
4005 GstBaseSink *basesink;
4009 basesink = GST_BASE_SINK (parent);
4011 GST_DEBUG_OBJECT (basesink, "Trying pull mode first");
4013 gst_base_sink_set_flushing (basesink, pad, FALSE);
4015 /* we need to have the pull mode enabled */
4016 if (!basesink->can_activate_pull) {
4017 GST_DEBUG_OBJECT (basesink, "pull mode disabled");
4021 /* check if downstreams supports pull mode at all */
4022 query = gst_query_new_scheduling ();
4024 if (!gst_pad_peer_query (pad, query)) {
4025 gst_query_unref (query);
4026 GST_DEBUG_OBJECT (basesink, "peer query faild, no pull mode");
4030 /* parse result of the query */
4031 pull_mode = gst_query_has_scheduling_mode (query, GST_PAD_MODE_PULL);
4032 gst_query_unref (query);
4035 GST_DEBUG_OBJECT (basesink, "pull mode not supported");
4039 /* set the pad mode before starting the task so that it's in the
4040 * correct state for the new thread. also the sink set_caps and get_caps
4041 * function checks this */
4042 basesink->pad_mode = GST_PAD_MODE_PULL;
4044 /* we first try to negotiate a format so that when we try to activate
4045 * downstream, it knows about our format */
4046 if (!gst_base_sink_negotiate_pull (basesink)) {
4047 GST_DEBUG_OBJECT (basesink, "failed to negotiate in pull mode");
4051 /* ok activate now */
4052 if (!gst_pad_activate_mode (pad, GST_PAD_MODE_PULL, TRUE)) {
4053 /* clear any pending caps */
4054 GST_OBJECT_LOCK (basesink);
4055 gst_caps_replace (&basesink->priv->caps, NULL);
4056 GST_OBJECT_UNLOCK (basesink);
4057 GST_DEBUG_OBJECT (basesink, "failed to activate in pull mode");
4061 GST_DEBUG_OBJECT (basesink, "Success activating pull mode");
4065 /* push mode fallback */
4067 GST_DEBUG_OBJECT (basesink, "Falling back to push mode");
4068 if ((result = gst_pad_activate_mode (pad, GST_PAD_MODE_PUSH, TRUE))) {
4069 GST_DEBUG_OBJECT (basesink, "Success activating push mode");
4074 GST_WARNING_OBJECT (basesink, "Could not activate pad in either mode");
4075 gst_base_sink_set_flushing (basesink, pad, TRUE);
4082 gst_base_sink_pad_activate_push (GstPad * pad, GstObject * parent,
4086 GstBaseSink *basesink;
4088 basesink = GST_BASE_SINK (parent);
4091 if (!basesink->can_activate_push) {
4093 basesink->pad_mode = GST_PAD_MODE_NONE;
4096 basesink->pad_mode = GST_PAD_MODE_PUSH;
4099 if (G_UNLIKELY (basesink->pad_mode != GST_PAD_MODE_PUSH)) {
4100 g_warning ("Internal GStreamer activation error!!!");
4103 gst_base_sink_set_flushing (basesink, pad, TRUE);
4105 basesink->pad_mode = GST_PAD_MODE_NONE;
4113 gst_base_sink_negotiate_pull (GstBaseSink * basesink)
4120 /* this returns the intersection between our caps and the peer caps. If there
4121 * is no peer, it returns NULL and we can't operate in pull mode so we can
4122 * fail the negotiation. */
4123 caps = gst_pad_get_allowed_caps (GST_BASE_SINK_PAD (basesink));
4124 if (caps == NULL || gst_caps_is_empty (caps))
4125 goto no_caps_possible;
4127 GST_DEBUG_OBJECT (basesink, "allowed caps: %" GST_PTR_FORMAT, caps);
4129 if (gst_caps_is_any (caps)) {
4130 GST_DEBUG_OBJECT (basesink, "caps were ANY after fixating, "
4132 /* neither side has template caps in this case, so they are prepared for
4133 pull() without setcaps() */
4137 caps = gst_base_sink_fixate (basesink, caps);
4138 GST_DEBUG_OBJECT (basesink, "fixated to: %" GST_PTR_FORMAT, caps);
4140 if (gst_caps_is_fixed (caps)) {
4141 if (!gst_pad_set_caps (GST_BASE_SINK_PAD (basesink), caps))
4142 goto could_not_set_caps;
4148 gst_caps_unref (caps);
4154 GST_INFO_OBJECT (basesink, "Pipeline could not agree on caps");
4155 GST_DEBUG_OBJECT (basesink, "get_allowed_caps() returned EMPTY");
4157 gst_caps_unref (caps);
4162 GST_INFO_OBJECT (basesink, "Could not set caps: %" GST_PTR_FORMAT, caps);
4163 gst_caps_unref (caps);
4168 /* this won't get called until we implement an activate function */
4170 gst_base_sink_pad_activate_pull (GstPad * pad, GstObject * parent,
4173 gboolean result = FALSE;
4174 GstBaseSink *basesink;
4175 GstBaseSinkClass *bclass;
4177 basesink = GST_BASE_SINK (parent);
4178 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4183 /* we mark we have a newsegment here because pull based
4184 * mode works just fine without having a newsegment before the
4186 gst_segment_init (&basesink->segment, GST_FORMAT_BYTES);
4187 GST_OBJECT_LOCK (basesink);
4188 basesink->have_newsegment = TRUE;
4189 GST_OBJECT_UNLOCK (basesink);
4191 /* get the peer duration in bytes */
4192 result = gst_pad_peer_query_duration (pad, GST_FORMAT_BYTES, &duration);
4194 GST_DEBUG_OBJECT (basesink,
4195 "setting duration in bytes to %" G_GINT64_FORMAT, duration);
4196 basesink->segment.duration = duration;
4198 GST_DEBUG_OBJECT (basesink, "unknown duration");
4201 if (bclass->activate_pull)
4202 result = bclass->activate_pull (basesink, TRUE);
4207 goto activate_failed;
4210 if (G_UNLIKELY (basesink->pad_mode != GST_PAD_MODE_PULL)) {
4211 g_warning ("Internal GStreamer activation error!!!");
4214 result = gst_base_sink_set_flushing (basesink, pad, TRUE);
4215 if (bclass->activate_pull)
4216 result &= bclass->activate_pull (basesink, FALSE);
4217 basesink->pad_mode = GST_PAD_MODE_NONE;
4226 /* reset, as starting the thread failed */
4227 basesink->pad_mode = GST_PAD_MODE_NONE;
4229 GST_ERROR_OBJECT (basesink, "subclass failed to activate in pull mode");
4235 gst_base_sink_pad_activate_mode (GstPad * pad, GstObject * parent,
4236 GstPadMode mode, gboolean active)
4241 case GST_PAD_MODE_PULL:
4242 res = gst_base_sink_pad_activate_pull (pad, parent, active);
4244 case GST_PAD_MODE_PUSH:
4245 res = gst_base_sink_pad_activate_push (pad, parent, active);
4248 GST_LOG_OBJECT (pad, "unknown activation mode %d", mode);
4255 /* send an event to our sinkpad peer. */
4257 gst_base_sink_send_event (GstElement * element, GstEvent * event)
4260 GstBaseSink *basesink = GST_BASE_SINK (element);
4261 gboolean forward, result = TRUE;
4264 GST_OBJECT_LOCK (element);
4265 /* get the pad and the scheduling mode */
4266 pad = gst_object_ref (basesink->sinkpad);
4267 mode = basesink->pad_mode;
4268 GST_OBJECT_UNLOCK (element);
4270 /* only push UPSTREAM events upstream */
4271 forward = GST_EVENT_IS_UPSTREAM (event);
4273 GST_DEBUG_OBJECT (basesink, "handling event %p %" GST_PTR_FORMAT, event,
4276 switch (GST_EVENT_TYPE (event)) {
4277 case GST_EVENT_LATENCY:
4279 GstClockTime latency;
4281 gst_event_parse_latency (event, &latency);
4283 /* store the latency. We use this to adjust the running_time before syncing
4284 * it to the clock. */
4285 GST_OBJECT_LOCK (element);
4286 basesink->priv->latency = latency;
4287 if (!basesink->priv->have_latency)
4289 GST_OBJECT_UNLOCK (element);
4290 GST_DEBUG_OBJECT (basesink, "latency set to %" GST_TIME_FORMAT,
4291 GST_TIME_ARGS (latency));
4293 /* We forward this event so that all elements know about the global pipeline
4294 * latency. This is interesting for an element when it wants to figure out
4295 * when a particular piece of data will be rendered. */
4298 case GST_EVENT_SEEK:
4299 /* in pull mode we will execute the seek */
4300 if (mode == GST_PAD_MODE_PULL)
4301 result = gst_base_sink_perform_seek (basesink, pad, event);
4303 case GST_EVENT_STEP:
4304 result = gst_base_sink_perform_step (basesink, pad, event);
4312 result = gst_pad_push_event (pad, event);
4314 /* not forwarded, unref the event */
4315 gst_event_unref (event);
4318 gst_object_unref (pad);
4320 GST_DEBUG_OBJECT (basesink, "handled event %p %" GST_PTR_FORMAT ": %d", event,
4327 gst_base_sink_get_position (GstBaseSink * basesink, GstFormat format,
4328 gint64 * cur, gboolean * upstream)
4330 GstClock *clock = NULL;
4331 gboolean res = FALSE;
4333 GstSegment *segment;
4334 GstClockTime now, latency;
4335 GstClockTimeDiff base_time;
4336 gint64 time, base, duration;
4339 gboolean last_seen, with_clock, in_paused;
4341 GST_OBJECT_LOCK (basesink);
4342 /* we can only get the segment when we are not NULL or READY */
4343 if (!basesink->have_newsegment)
4347 /* when not in PLAYING or when we're busy with a state change, we
4348 * cannot read from the clock so we report time based on the
4349 * last seen timestamp. */
4350 if (GST_STATE (basesink) != GST_STATE_PLAYING ||
4351 GST_STATE_PENDING (basesink) != GST_STATE_VOID_PENDING) {
4355 segment = &basesink->segment;
4357 /* get the format in the segment */
4358 oformat = segment->format;
4360 /* report with last seen position when EOS */
4361 last_seen = basesink->eos;
4363 /* assume we will use the clock for getting the current position */
4365 if (basesink->sync == FALSE)
4368 /* and we need a clock */
4369 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (basesink)) == NULL))
4372 gst_object_ref (clock);
4374 /* mainloop might be querying position when going to playing async,
4375 * while (audio) rendering might be quickly advancing stream position,
4376 * so use clock asap rather than last reported position */
4377 if (in_paused && with_clock && g_atomic_int_get (&basesink->priv->to_playing)) {
4378 GST_DEBUG_OBJECT (basesink, "going to PLAYING, so not PAUSED");
4382 /* collect all data we need holding the lock */
4383 if (GST_CLOCK_TIME_IS_VALID (segment->time))
4384 time = segment->time;
4388 if (GST_CLOCK_TIME_IS_VALID (segment->stop))
4389 duration = segment->stop - segment->start;
4393 base = segment->base;
4394 rate = segment->rate * segment->applied_rate;
4395 latency = basesink->priv->latency;
4398 /* in paused, use start_time */
4399 base_time = GST_ELEMENT_START_TIME (basesink);
4400 GST_DEBUG_OBJECT (basesink, "in paused, using start time %" GST_TIME_FORMAT,
4401 GST_TIME_ARGS (base_time));
4402 } else if (with_clock) {
4403 /* else use clock when needed */
4404 base_time = GST_ELEMENT_CAST (basesink)->base_time;
4405 GST_DEBUG_OBJECT (basesink, "using clock and base time %" GST_TIME_FORMAT,
4406 GST_TIME_ARGS (base_time));
4408 /* else, no sync or clock -> no base time */
4409 GST_DEBUG_OBJECT (basesink, "no sync or no clock");
4413 /* no base_time, we can't calculate running_time, use last seem timestamp to report
4415 if (base_time == -1)
4418 if (oformat == GST_FORMAT_TIME) {
4421 start = basesink->priv->current_sstart;
4422 stop = basesink->priv->current_sstop;
4424 if (in_paused || last_seen) {
4425 /* in paused or when we don't use the clock, we use the last position
4426 * as a lower bound */
4427 if (stop == -1 || segment->rate > 0.0)
4432 GST_DEBUG_OBJECT (basesink, "in PAUSED using last %" GST_TIME_FORMAT,
4433 GST_TIME_ARGS (last));
4435 /* in playing, use last stop time as upper bound */
4436 if (start == -1 || segment->rate > 0.0)
4441 GST_DEBUG_OBJECT (basesink, "in PLAYING using last %" GST_TIME_FORMAT,
4442 GST_TIME_ARGS (last));
4445 /* convert position to stream time */
4446 last = gst_segment_to_stream_time (segment, oformat, segment->position);
4448 GST_DEBUG_OBJECT (basesink, "in using last %" G_GINT64_FORMAT, last);
4451 /* need to release the object lock before we can get the time,
4452 * a clock might take the LOCK of the provider, which could be
4453 * a basesink subclass. */
4454 GST_OBJECT_UNLOCK (basesink);
4457 /* in EOS or when no valid stream_time, report the value of last seen
4460 /* no timestamp, we need to ask upstream */
4461 GST_DEBUG_OBJECT (basesink, "no last seen timestamp, asking upstream");
4466 GST_DEBUG_OBJECT (basesink, "using last seen timestamp %" GST_TIME_FORMAT,
4467 GST_TIME_ARGS (last));
4470 if (oformat != GST_FORMAT_TIME) {
4471 /* convert base, time and duration to time */
4472 if (!gst_pad_query_convert (basesink->sinkpad, oformat, base,
4473 GST_FORMAT_TIME, &base))
4474 goto convert_failed;
4475 if (!gst_pad_query_convert (basesink->sinkpad, oformat, duration,
4476 GST_FORMAT_TIME, &duration))
4477 goto convert_failed;
4478 if (!gst_pad_query_convert (basesink->sinkpad, oformat, time,
4479 GST_FORMAT_TIME, &time))
4480 goto convert_failed;
4481 if (!gst_pad_query_convert (basesink->sinkpad, oformat, last,
4482 GST_FORMAT_TIME, &last))
4483 goto convert_failed;
4485 /* assume time format from now on */
4486 oformat = GST_FORMAT_TIME;
4489 if (!in_paused && with_clock) {
4490 now = gst_clock_get_time (clock);
4496 /* subtract base time and base time from the clock time.
4497 * Make sure we don't go negative. This is the current time in
4498 * the segment which we need to scale with the combined
4499 * rate and applied rate. */
4501 base_time += latency;
4502 if (GST_CLOCK_DIFF (base_time, now) < 0)
4505 /* for negative rates we need to count back from the segment
4510 *cur = time + gst_guint64_to_gdouble (now - base_time) * rate;
4513 /* never report less than segment values in paused */
4515 *cur = MAX (last, *cur);
4517 /* never report more than last seen position in playing */
4519 *cur = MIN (last, *cur);
4522 GST_DEBUG_OBJECT (basesink,
4523 "now %" GST_TIME_FORMAT " - base_time %" GST_TIME_FORMAT " - base %"
4524 GST_TIME_FORMAT " + time %" GST_TIME_FORMAT " last %" GST_TIME_FORMAT,
4525 GST_TIME_ARGS (now), GST_TIME_ARGS (base_time), GST_TIME_ARGS (base),
4526 GST_TIME_ARGS (time), GST_TIME_ARGS (last));
4529 if (oformat != format) {
4530 /* convert to final format */
4531 if (!gst_pad_query_convert (basesink->sinkpad, oformat, *cur, format, cur))
4532 goto convert_failed;
4538 GST_DEBUG_OBJECT (basesink, "res: %d, POSITION: %" GST_TIME_FORMAT,
4539 res, GST_TIME_ARGS (*cur));
4542 gst_object_unref (clock);
4549 /* in NULL or READY we always return FALSE and -1 */
4550 GST_DEBUG_OBJECT (basesink, "position in wrong state, return -1");
4553 GST_OBJECT_UNLOCK (basesink);
4558 GST_DEBUG_OBJECT (basesink, "convert failed, try upstream");
4566 gst_base_sink_get_duration (GstBaseSink * basesink, GstFormat format,
4567 gint64 * dur, gboolean * upstream)
4569 gboolean res = FALSE;
4571 if (basesink->pad_mode == GST_PAD_MODE_PULL) {
4574 /* get the duration in bytes, in pull mode that's all we are sure to
4575 * know. We have to explicitly get this value from upstream instead of
4576 * using our cached value because it might change. Duration caching
4577 * should be done at a higher level. */
4579 gst_pad_peer_query_duration (basesink->sinkpad, GST_FORMAT_BYTES,
4582 basesink->segment.duration = uduration;
4583 if (format != GST_FORMAT_BYTES) {
4584 /* convert to the requested format */
4586 gst_pad_query_convert (basesink->sinkpad, GST_FORMAT_BYTES,
4587 uduration, format, dur);
4601 default_element_query (GstElement * element, GstQuery * query)
4603 gboolean res = FALSE;
4605 GstBaseSink *basesink = GST_BASE_SINK (element);
4607 switch (GST_QUERY_TYPE (query)) {
4608 case GST_QUERY_POSITION:
4612 gboolean upstream = FALSE;
4614 gst_query_parse_position (query, &format, NULL);
4616 GST_DEBUG_OBJECT (basesink, "position query in format %s",
4617 gst_format_get_name (format));
4619 /* first try to get the position based on the clock */
4621 gst_base_sink_get_position (basesink, format, &cur, &upstream))) {
4622 gst_query_set_position (query, format, cur);
4623 } else if (upstream) {
4624 /* fallback to peer query */
4625 res = gst_pad_peer_query (basesink->sinkpad, query);
4628 /* we can handle a few things if upstream failed */
4629 if (format == GST_FORMAT_PERCENT) {
4632 res = gst_base_sink_get_position (basesink, GST_FORMAT_TIME, &cur,
4634 if (!res && upstream) {
4636 gst_pad_peer_query_position (basesink->sinkpad, GST_FORMAT_TIME,
4640 res = gst_base_sink_get_duration (basesink, GST_FORMAT_TIME, &dur,
4642 if (!res && upstream) {
4644 gst_pad_peer_query_duration (basesink->sinkpad,
4645 GST_FORMAT_TIME, &dur);
4651 pos = gst_util_uint64_scale (100 * GST_FORMAT_PERCENT_SCALE, cur,
4653 gst_query_set_position (query, GST_FORMAT_PERCENT, pos);
4659 case GST_QUERY_DURATION:
4663 gboolean upstream = FALSE;
4665 gst_query_parse_duration (query, &format, NULL);
4667 GST_DEBUG_OBJECT (basesink, "duration query in format %s",
4668 gst_format_get_name (format));
4671 gst_base_sink_get_duration (basesink, format, &dur, &upstream))) {
4672 gst_query_set_duration (query, format, dur);
4673 } else if (upstream) {
4674 /* fallback to peer query */
4675 res = gst_pad_peer_query (basesink->sinkpad, query);
4678 /* we can handle a few things if upstream failed */
4679 if (format == GST_FORMAT_PERCENT) {
4680 gst_query_set_duration (query, GST_FORMAT_PERCENT,
4681 GST_FORMAT_PERCENT_MAX);
4687 case GST_QUERY_LATENCY:
4689 gboolean live, us_live;
4690 GstClockTime min, max;
4692 if ((res = gst_base_sink_query_latency (basesink, &live, &us_live, &min,
4694 gst_query_set_latency (query, live, min, max);
4698 case GST_QUERY_JITTER:
4700 case GST_QUERY_RATE:
4701 /* gst_query_set_rate (query, basesink->segment_rate); */
4704 case GST_QUERY_SEGMENT:
4706 if (basesink->pad_mode == GST_PAD_MODE_PULL) {
4707 gst_query_set_segment (query, basesink->segment.rate,
4708 GST_FORMAT_TIME, basesink->segment.start, basesink->segment.stop);
4711 res = gst_pad_peer_query (basesink->sinkpad, query);
4715 case GST_QUERY_SEEKING:
4716 case GST_QUERY_CONVERT:
4717 case GST_QUERY_FORMATS:
4719 res = gst_pad_peer_query (basesink->sinkpad, query);
4722 GST_DEBUG_OBJECT (basesink, "query %s returns %d",
4723 GST_QUERY_TYPE_NAME (query), res);
4729 gst_base_sink_default_query (GstBaseSink * basesink, GstQuery * query)
4732 GstBaseSinkClass *bclass;
4734 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4736 switch (GST_QUERY_TYPE (query)) {
4737 case GST_QUERY_ALLOCATION:
4739 if (bclass->propose_allocation)
4740 res = bclass->propose_allocation (basesink, query);
4745 case GST_QUERY_CAPS:
4747 GstCaps *caps, *filter;
4749 gst_query_parse_caps (query, &filter);
4750 caps = gst_base_sink_query_caps (basesink, basesink->sinkpad, filter);
4751 gst_query_set_caps_result (query, caps);
4752 gst_caps_unref (caps);
4756 case GST_QUERY_ACCEPT_CAPS:
4758 GstCaps *caps, *allowed;
4761 /* slightly faster than the default implementation */
4762 gst_query_parse_accept_caps (query, &caps);
4763 allowed = gst_base_sink_query_caps (basesink, basesink->sinkpad, NULL);
4764 subset = gst_caps_is_subset (caps, allowed);
4765 gst_caps_unref (allowed);
4766 gst_query_set_accept_caps_result (query, subset);
4770 case GST_QUERY_DRAIN:
4775 gst_pad_query_default (basesink->sinkpad, GST_OBJECT_CAST (basesink),
4783 gst_base_sink_sink_query (GstPad * pad, GstObject * parent, GstQuery * query)
4785 GstBaseSink *basesink;
4786 GstBaseSinkClass *bclass;
4789 basesink = GST_BASE_SINK_CAST (parent);
4790 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4793 res = bclass->query (basesink, query);
4800 static GstStateChangeReturn
4801 gst_base_sink_change_state (GstElement * element, GstStateChange transition)
4803 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
4804 GstBaseSink *basesink = GST_BASE_SINK (element);
4805 GstBaseSinkClass *bclass;
4806 GstBaseSinkPrivate *priv;
4808 priv = basesink->priv;
4810 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4812 switch (transition) {
4813 case GST_STATE_CHANGE_NULL_TO_READY:
4815 if (!bclass->start (basesink))
4818 case GST_STATE_CHANGE_READY_TO_PAUSED:
4819 /* need to complete preroll before this state change completes, there
4820 * is no data flow in READY so we can safely assume we need to preroll. */
4821 GST_BASE_SINK_PREROLL_LOCK (basesink);
4822 GST_DEBUG_OBJECT (basesink, "READY to PAUSED");
4823 basesink->have_newsegment = FALSE;
4824 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
4825 basesink->offset = 0;
4826 basesink->have_preroll = FALSE;
4827 priv->step_unlock = FALSE;
4828 basesink->need_preroll = TRUE;
4829 basesink->playing_async = TRUE;
4830 priv->current_sstart = GST_CLOCK_TIME_NONE;
4831 priv->current_sstop = GST_CLOCK_TIME_NONE;
4832 priv->eos_rtime = GST_CLOCK_TIME_NONE;
4834 basesink->eos = FALSE;
4835 priv->received_eos = FALSE;
4836 gst_base_sink_reset_qos (basesink);
4838 priv->commited = FALSE;
4839 priv->call_preroll = TRUE;
4840 priv->current_step.valid = FALSE;
4841 priv->pending_step.valid = FALSE;
4842 if (priv->async_enabled) {
4843 GST_DEBUG_OBJECT (basesink, "doing async state change");
4844 /* when async enabled, post async-start message and return ASYNC from
4845 * the state change function */
4846 ret = GST_STATE_CHANGE_ASYNC;
4847 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4848 gst_message_new_async_start (GST_OBJECT_CAST (basesink)));
4850 priv->have_latency = TRUE;
4852 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4854 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
4855 GST_BASE_SINK_PREROLL_LOCK (basesink);
4856 g_atomic_int_set (&basesink->priv->to_playing, TRUE);
4857 if (!gst_base_sink_needs_preroll (basesink)) {
4858 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, don't need preroll");
4859 /* no preroll needed anymore now. */
4860 basesink->playing_async = FALSE;
4861 basesink->need_preroll = FALSE;
4862 if (basesink->eos) {
4863 GstMessage *message;
4865 /* need to post EOS message here */
4866 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
4867 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
4868 gst_message_set_seqnum (message, basesink->priv->seqnum);
4869 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
4871 GST_DEBUG_OBJECT (basesink, "signal preroll");
4872 GST_BASE_SINK_PREROLL_SIGNAL (basesink);
4875 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, we are not prerolled");
4876 basesink->need_preroll = TRUE;
4877 basesink->playing_async = TRUE;
4878 priv->call_preroll = TRUE;
4879 priv->commited = FALSE;
4880 if (priv->async_enabled) {
4881 GST_DEBUG_OBJECT (basesink, "doing async state change");
4882 ret = GST_STATE_CHANGE_ASYNC;
4883 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4884 gst_message_new_async_start (GST_OBJECT_CAST (basesink)));
4887 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4894 GstStateChangeReturn bret;
4896 bret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
4897 if (G_UNLIKELY (bret == GST_STATE_CHANGE_FAILURE))
4898 goto activate_failed;
4901 switch (transition) {
4902 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
4903 /* completed transition, so need not be marked any longer
4904 * And it should be unmarked, since e.g. losing our position upon flush
4905 * does not really change state to PAUSED ... */
4906 g_atomic_int_set (&basesink->priv->to_playing, FALSE);
4908 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
4909 g_atomic_int_set (&basesink->priv->to_playing, FALSE);
4910 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED");
4911 /* FIXME, make sure we cannot enter _render first */
4913 /* we need to call ::unlock before locking PREROLL_LOCK
4914 * since we lock it before going into ::render */
4916 bclass->unlock (basesink);
4918 GST_BASE_SINK_PREROLL_LOCK (basesink);
4919 GST_DEBUG_OBJECT (basesink, "got preroll lock");
4920 /* now that we have the PREROLL lock, clear our unlock request */
4921 if (bclass->unlock_stop)
4922 bclass->unlock_stop (basesink);
4924 /* we need preroll again and we set the flag before unlocking the clockid
4925 * because if the clockid is unlocked before a current buffer expired, we
4926 * can use that buffer to preroll with */
4927 basesink->need_preroll = TRUE;
4929 if (basesink->clock_id) {
4930 GST_DEBUG_OBJECT (basesink, "unschedule clock");
4931 gst_clock_id_unschedule (basesink->clock_id);
4934 /* if we don't have a preroll buffer we need to wait for a preroll and
4936 if (!gst_base_sink_needs_preroll (basesink)) {
4937 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED, we are prerolled");
4938 basesink->playing_async = FALSE;
4940 if (GST_STATE_TARGET (GST_ELEMENT (basesink)) <= GST_STATE_READY) {
4941 GST_DEBUG_OBJECT (basesink, "element is <= READY");
4942 ret = GST_STATE_CHANGE_SUCCESS;
4944 GST_DEBUG_OBJECT (basesink,
4945 "PLAYING to PAUSED, we are not prerolled");
4946 basesink->playing_async = TRUE;
4947 priv->commited = FALSE;
4948 priv->call_preroll = TRUE;
4949 if (priv->async_enabled) {
4950 GST_DEBUG_OBJECT (basesink, "doing async state change");
4951 ret = GST_STATE_CHANGE_ASYNC;
4952 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4953 gst_message_new_async_start (GST_OBJECT_CAST (basesink)));
4957 GST_DEBUG_OBJECT (basesink, "rendered: %" G_GUINT64_FORMAT
4958 ", dropped: %" G_GUINT64_FORMAT, priv->rendered, priv->dropped);
4960 gst_base_sink_reset_qos (basesink);
4961 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4963 case GST_STATE_CHANGE_PAUSED_TO_READY:
4964 GST_BASE_SINK_PREROLL_LOCK (basesink);
4965 /* start by resetting our position state with the object lock so that the
4966 * position query gets the right idea. We do this before we post the
4967 * messages so that the message handlers pick this up. */
4968 GST_OBJECT_LOCK (basesink);
4969 basesink->have_newsegment = FALSE;
4970 priv->current_sstart = GST_CLOCK_TIME_NONE;
4971 priv->current_sstop = GST_CLOCK_TIME_NONE;
4972 priv->have_latency = FALSE;
4973 if (priv->cached_clock_id) {
4974 gst_clock_id_unref (priv->cached_clock_id);
4975 priv->cached_clock_id = NULL;
4977 gst_caps_replace (&basesink->priv->caps, NULL);
4978 GST_OBJECT_UNLOCK (basesink);
4980 gst_base_sink_set_last_buffer (basesink, NULL);
4981 priv->call_preroll = FALSE;
4983 if (!priv->commited) {
4984 if (priv->async_enabled) {
4985 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, posting async-done");
4987 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4988 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
4989 GST_STATE_PLAYING, GST_STATE_PAUSED, GST_STATE_READY));
4991 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4992 gst_message_new_async_done (GST_OBJECT_CAST (basesink),
4993 GST_CLOCK_TIME_NONE));
4995 priv->commited = TRUE;
4997 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, don't need_preroll");
4999 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
5001 case GST_STATE_CHANGE_READY_TO_NULL:
5003 if (!bclass->stop (basesink)) {
5004 GST_WARNING_OBJECT (basesink, "failed to stop");
5007 gst_base_sink_set_last_buffer (basesink, NULL);
5008 priv->call_preroll = FALSE;
5019 GST_DEBUG_OBJECT (basesink, "failed to start");
5020 return GST_STATE_CHANGE_FAILURE;
5024 GST_DEBUG_OBJECT (basesink,
5025 "element failed to change states -- activation problem?");
5026 return GST_STATE_CHANGE_FAILURE;