2 * Copyright (C) 2005-2007 Wim Taymans <wim.taymans@gmail.com>
4 * gstbasesink.c: Base class for sink elements
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
24 * @short_description: Base class for sink elements
25 * @see_also: #GstBaseTransform, #GstBaseSrc
27 * #GstBaseSink is the base class for sink elements in GStreamer, such as
28 * xvimagesink or filesink. It is a layer on top of #GstElement that provides a
29 * simplified interface to plugin writers. #GstBaseSink handles many details
30 * for you, for example: preroll, clock synchronization, state changes,
31 * activation in push or pull mode, and queries.
33 * In most cases, when writing sink elements, there is no need to implement
34 * class methods from #GstElement or to set functions on pads, because the
35 * #GstBaseSink infrastructure should be sufficient.
37 * #GstBaseSink provides support for exactly one sink pad, which should be
38 * named "sink". A sink implementation (subclass of #GstBaseSink) should
39 * install a pad template in its base_init function, like so:
42 * my_element_base_init (gpointer g_class)
44 * GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
46 * // sinktemplate should be a #GstStaticPadTemplate with direction
47 * // #GST_PAD_SINK and name "sink"
48 * gst_element_class_add_pad_template (gstelement_class,
49 * gst_static_pad_template_get (&sinktemplate));
50 * // see #GstElementDetails
51 * gst_element_class_set_details (gstelement_class, &details);
55 * #GstBaseSink will handle the prerolling correctly. This means that it will
56 * return #GST_STATE_CHANGE_ASYNC from a state change to PAUSED until the first
57 * buffer arrives in this element. The base class will call the
58 * #GstBaseSinkClass.preroll() vmethod with this preroll buffer and will then
59 * commit the state change to the next asynchronously pending state.
61 * When the element is set to PLAYING, #GstBaseSink will synchronise on the
62 * clock using the times returned from #GstBaseSinkClass.get_times(). If this
63 * function returns #GST_CLOCK_TIME_NONE for the start time, no synchronisation
64 * will be done. Synchronisation can be disabled entirely by setting the object
65 * #GstBaseSink:sync property to %FALSE.
67 * After synchronisation the virtual method #GstBaseSinkClass.render() will be
68 * called. Subclasses should minimally implement this method.
70 * Since 0.10.3 subclasses that synchronise on the clock in the
71 * #GstBaseSinkClass.render() method are supported as well. These classes
72 * typically receive a buffer in the render method and can then potentially
73 * block on the clock while rendering. A typical example is an audiosink.
74 * Since 0.10.11 these subclasses can use gst_base_sink_wait_preroll() to
75 * perform the blocking wait.
77 * Upon receiving the EOS event in the PLAYING state, #GstBaseSink will wait
78 * for the clock to reach the time indicated by the stop time of the last
79 * #GstBaseSinkClass.get_times() call before posting an EOS message. When the
80 * element receives EOS in PAUSED, preroll completes, the event is queued and an
81 * EOS message is posted when going to PLAYING.
83 * #GstBaseSink will internally use the #GST_EVENT_NEWSEGMENT events to schedule
84 * synchronisation and clipping of buffers. Buffers that fall completely outside
85 * of the current segment are dropped. Buffers that fall partially in the
86 * segment are rendered (and prerolled). Subclasses should do any subbuffer
87 * clipping themselves when needed.
89 * #GstBaseSink will by default report the current playback position in
90 * #GST_FORMAT_TIME based on the current clock time and segment information.
91 * If no clock has been set on the element, the query will be forwarded
94 * The #GstBaseSinkClass.set_caps() function will be called when the subclass
95 * should configure itself to process a specific media type.
97 * The #GstBaseSinkClass.start() and #GstBaseSinkClass.stop() virtual methods
98 * will be called when resources should be allocated. Any
99 * #GstBaseSinkClass.preroll(), #GstBaseSinkClass.render() and
100 * #GstBaseSinkClass.set_caps() function will be called between the
101 * #GstBaseSinkClass.start() and #GstBaseSinkClass.stop() calls.
103 * The #GstBaseSinkClass.event() virtual method will be called when an event is
104 * received by #GstBaseSink. Normally this method should only be overriden by
105 * very specific elements (such as file sinks) which need to handle the
106 * newsegment event specially.
108 * #GstBaseSink provides an overridable #GstBaseSinkClass.buffer_alloc()
109 * function that can be used by sinks that want to do reverse negotiation or to
110 * provide custom buffers (hardware buffers for example) to upstream elements.
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 * Since 0.10.15 the #GstBaseSink:async property can be used to instruct the
139 * sink to never perform an ASYNC state change. This feature is mostly usable
140 * when dealing with non-synchronized streams or sparse streams.
142 * Last reviewed on 2007-08-29 (0.10.15)
149 #include "gstbasesink.h"
150 #include <gst/gstmarshal.h>
151 #include <gst/gst_private.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 /* FIXME, some stuff in ABI.data and other in Private...
181 * Make up your mind please.
183 struct _GstBaseSinkPrivate
185 gint qos_enabled; /* ATOMIC */
186 gboolean async_enabled;
187 GstClockTimeDiff ts_offset;
188 GstClockTime render_delay;
190 /* start, stop of current buffer, stream time, used to report position */
191 GstClockTime current_sstart;
192 GstClockTime current_sstop;
194 /* start, stop and jitter of current buffer, running time */
195 GstClockTime current_rstart;
196 GstClockTime current_rstop;
197 GstClockTimeDiff current_jitter;
199 /* EOS sync time in running time */
200 GstClockTime eos_rtime;
202 /* last buffer that arrived in time, running time */
203 GstClockTime last_in_time;
204 /* when the last buffer left the sink, running time */
205 GstClockTime last_left;
207 /* running averages go here these are done on running time */
209 GstClockTime avg_duration;
212 /* these are done on system time. avg_jitter and avg_render are
213 * compared to eachother to see if the rendering time takes a
214 * huge amount of the processing, If so we are flooded with
216 GstClockTime last_left_systime;
217 GstClockTime avg_jitter;
218 GstClockTime start, stop;
219 GstClockTime avg_render;
221 /* number of rendered and dropped frames */
226 GstClockTime latency;
228 /* if we already commited the state */
231 /* when we received EOS */
232 gboolean received_eos;
234 /* when we are prerolled and able to report latency */
235 gboolean have_latency;
237 /* the last buffer we prerolled or rendered. Useful for making snapshots */
238 GstBuffer *last_buffer;
240 /* caps for pull based scheduling */
243 /* blocksize for pulling */
248 /* seqnum of the stream */
251 gboolean call_preroll;
252 gboolean step_unlock;
254 /* we have a pending and a current step operation */
255 GstStepInfo current_step;
256 GstStepInfo pending_step;
259 #define DO_RUNNING_AVG(avg,val,size) (((val) + ((size)-1) * (avg)) / (size))
261 /* generic running average, this has a neutral window size */
262 #define UPDATE_RUNNING_AVG(avg,val) DO_RUNNING_AVG(avg,val,8)
264 /* the windows for these running averages are experimentally obtained.
265 * possitive values get averaged more while negative values use a small
266 * window so we can react faster to badness. */
267 #define UPDATE_RUNNING_AVG_P(avg,val) DO_RUNNING_AVG(avg,val,16)
268 #define UPDATE_RUNNING_AVG_N(avg,val) DO_RUNNING_AVG(avg,val,4)
270 /* BaseSink properties */
272 #define DEFAULT_CAN_ACTIVATE_PULL FALSE /* fixme: enable me */
273 #define DEFAULT_CAN_ACTIVATE_PUSH TRUE
275 #define DEFAULT_PREROLL_QUEUE_LEN 0
276 #define DEFAULT_SYNC TRUE
277 #define DEFAULT_MAX_LATENESS -1
278 #define DEFAULT_QOS FALSE
279 #define DEFAULT_ASYNC TRUE
280 #define DEFAULT_TS_OFFSET 0
281 #define DEFAULT_BLOCKSIZE 4096
282 #define DEFAULT_RENDER_DELAY 0
287 PROP_PREROLL_QUEUE_LEN,
299 static GstElementClass *parent_class = NULL;
301 static void gst_base_sink_class_init (GstBaseSinkClass * klass);
302 static void gst_base_sink_init (GstBaseSink * trans, gpointer g_class);
303 static void gst_base_sink_finalize (GObject * object);
306 gst_base_sink_get_type (void)
308 static volatile gsize base_sink_type = 0;
310 if (g_once_init_enter (&base_sink_type)) {
312 static const GTypeInfo base_sink_info = {
313 sizeof (GstBaseSinkClass),
316 (GClassInitFunc) gst_base_sink_class_init,
319 sizeof (GstBaseSink),
321 (GInstanceInitFunc) gst_base_sink_init,
324 _type = g_type_register_static (GST_TYPE_ELEMENT,
325 "GstBaseSink", &base_sink_info, G_TYPE_FLAG_ABSTRACT);
326 g_once_init_leave (&base_sink_type, _type);
328 return base_sink_type;
331 static void gst_base_sink_set_property (GObject * object, guint prop_id,
332 const GValue * value, GParamSpec * pspec);
333 static void gst_base_sink_get_property (GObject * object, guint prop_id,
334 GValue * value, GParamSpec * pspec);
336 static gboolean gst_base_sink_send_event (GstElement * element,
338 static gboolean gst_base_sink_query (GstElement * element, GstQuery * query);
340 static GstCaps *gst_base_sink_get_caps (GstBaseSink * sink);
341 static gboolean gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps);
342 static GstFlowReturn gst_base_sink_buffer_alloc (GstBaseSink * sink,
343 guint64 offset, guint size, GstCaps * caps, GstBuffer ** buf);
344 static void gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
345 GstClockTime * start, GstClockTime * end);
346 static gboolean gst_base_sink_set_flushing (GstBaseSink * basesink,
347 GstPad * pad, gboolean flushing);
348 static gboolean gst_base_sink_default_activate_pull (GstBaseSink * basesink,
350 static gboolean gst_base_sink_default_do_seek (GstBaseSink * sink,
351 GstSegment * segment);
352 static gboolean gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
353 GstEvent * event, GstSegment * segment);
355 static GstStateChangeReturn gst_base_sink_change_state (GstElement * element,
356 GstStateChange transition);
358 static GstFlowReturn gst_base_sink_chain (GstPad * pad, GstBuffer * buffer);
359 static GstFlowReturn gst_base_sink_chain_list (GstPad * pad,
360 GstBufferList * list);
362 static void gst_base_sink_loop (GstPad * pad);
363 static gboolean gst_base_sink_pad_activate (GstPad * pad);
364 static gboolean gst_base_sink_pad_activate_push (GstPad * pad, gboolean active);
365 static gboolean gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active);
366 static gboolean gst_base_sink_event (GstPad * pad, GstEvent * event);
367 static gboolean gst_base_sink_peer_query (GstBaseSink * sink, GstQuery * query);
369 static gboolean gst_base_sink_negotiate_pull (GstBaseSink * basesink);
370 static GstCaps *gst_base_sink_pad_getcaps (GstPad * pad);
371 static gboolean gst_base_sink_pad_setcaps (GstPad * pad, GstCaps * caps);
372 static void gst_base_sink_pad_fixate (GstPad * pad, GstCaps * caps);
373 static GstFlowReturn gst_base_sink_pad_buffer_alloc (GstPad * pad,
374 guint64 offset, guint size, GstCaps * caps, GstBuffer ** buf);
377 /* check if an object was too late */
378 static gboolean gst_base_sink_is_too_late (GstBaseSink * basesink,
379 GstMiniObject * obj, GstClockTime start, GstClockTime stop,
380 GstClockReturn status, GstClockTimeDiff jitter);
381 static GstFlowReturn gst_base_sink_preroll_object (GstBaseSink * basesink,
382 gboolean is_list, GstMiniObject * obj);
385 gst_base_sink_class_init (GstBaseSinkClass * klass)
387 GObjectClass *gobject_class;
388 GstElementClass *gstelement_class;
390 gobject_class = G_OBJECT_CLASS (klass);
391 gstelement_class = GST_ELEMENT_CLASS (klass);
393 GST_DEBUG_CATEGORY_INIT (gst_base_sink_debug, "basesink", 0,
396 g_type_class_add_private (klass, sizeof (GstBaseSinkPrivate));
398 parent_class = g_type_class_peek_parent (klass);
400 gobject_class->finalize = gst_base_sink_finalize;
401 gobject_class->set_property = gst_base_sink_set_property;
402 gobject_class->get_property = gst_base_sink_get_property;
404 /* FIXME, this next value should be configured using an event from the
405 * upstream element, ie, the BUFFER_SIZE event. */
406 g_object_class_install_property (gobject_class, PROP_PREROLL_QUEUE_LEN,
407 g_param_spec_uint ("preroll-queue-len", "Preroll queue length",
408 "Number of buffers to queue during preroll", 0, G_MAXUINT,
409 DEFAULT_PREROLL_QUEUE_LEN,
410 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
412 g_object_class_install_property (gobject_class, PROP_SYNC,
413 g_param_spec_boolean ("sync", "Sync", "Sync on the clock", DEFAULT_SYNC,
414 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
416 g_object_class_install_property (gobject_class, PROP_MAX_LATENESS,
417 g_param_spec_int64 ("max-lateness", "Max Lateness",
418 "Maximum number of nanoseconds that a buffer can be late before it "
419 "is dropped (-1 unlimited)", -1, G_MAXINT64, DEFAULT_MAX_LATENESS,
420 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
422 g_object_class_install_property (gobject_class, PROP_QOS,
423 g_param_spec_boolean ("qos", "Qos",
424 "Generate Quality-of-Service events upstream", DEFAULT_QOS,
425 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
429 * If set to #TRUE, the basesink will perform asynchronous state changes.
430 * When set to #FALSE, the sink will not signal the parent when it prerolls.
431 * Use this option when dealing with sparse streams or when synchronisation is
436 g_object_class_install_property (gobject_class, PROP_ASYNC,
437 g_param_spec_boolean ("async", "Async",
438 "Go asynchronously to PAUSED", DEFAULT_ASYNC,
439 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
441 * GstBaseSink:ts-offset
443 * Controls the final synchronisation, a negative value will render the buffer
444 * earlier while a positive value delays playback. This property can be
445 * used to fix synchronisation in bad files.
449 g_object_class_install_property (gobject_class, PROP_TS_OFFSET,
450 g_param_spec_int64 ("ts-offset", "TS Offset",
451 "Timestamp offset in nanoseconds", G_MININT64, G_MAXINT64,
452 DEFAULT_TS_OFFSET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
454 * GstBaseSink:last-buffer
456 * The last buffer that arrived in the sink and was used for preroll or for
457 * rendering. This property can be used to generate thumbnails. This property
458 * can be NULL when the sink has not yet received a bufer.
462 g_object_class_install_property (gobject_class, PROP_LAST_BUFFER,
463 gst_param_spec_mini_object ("last-buffer", "Last Buffer",
464 "The last buffer received in the sink", GST_TYPE_BUFFER,
465 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
467 * GstBaseSink:blocksize
469 * The amount of bytes to pull when operating in pull mode.
473 g_object_class_install_property (gobject_class, PROP_BLOCKSIZE,
474 g_param_spec_uint ("blocksize", "Block size",
475 "Size in bytes to pull per buffer (0 = default)", 0, G_MAXUINT,
476 DEFAULT_BLOCKSIZE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
478 * GstBaseSink:render-delay
480 * The additional delay between synchronisation and actual rendering of the
481 * media. This property will add additional latency to the device in order to
482 * make other sinks compensate for the delay.
486 g_object_class_install_property (gobject_class, PROP_RENDER_DELAY,
487 g_param_spec_uint64 ("render-delay", "Render Delay",
488 "Additional render delay of the sink in nanoseconds", 0, G_MAXUINT64,
489 DEFAULT_RENDER_DELAY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
491 gstelement_class->change_state =
492 GST_DEBUG_FUNCPTR (gst_base_sink_change_state);
493 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_base_sink_send_event);
494 gstelement_class->query = GST_DEBUG_FUNCPTR (gst_base_sink_query);
496 klass->get_caps = GST_DEBUG_FUNCPTR (gst_base_sink_get_caps);
497 klass->set_caps = GST_DEBUG_FUNCPTR (gst_base_sink_set_caps);
498 klass->buffer_alloc = GST_DEBUG_FUNCPTR (gst_base_sink_buffer_alloc);
499 klass->get_times = GST_DEBUG_FUNCPTR (gst_base_sink_get_times);
500 klass->activate_pull =
501 GST_DEBUG_FUNCPTR (gst_base_sink_default_activate_pull);
503 /* Registering debug symbols for function pointers */
504 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_getcaps);
505 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_setcaps);
506 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_fixate);
507 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_buffer_alloc);
508 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate);
509 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate_push);
510 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate_pull);
511 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_event);
512 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain);
513 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain_list);
517 gst_base_sink_pad_getcaps (GstPad * pad)
519 GstBaseSinkClass *bclass;
521 GstCaps *caps = NULL;
523 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
524 bclass = GST_BASE_SINK_GET_CLASS (bsink);
526 if (bsink->pad_mode == GST_ACTIVATE_PULL) {
527 /* if we are operating in pull mode we only accept the negotiated caps */
528 GST_OBJECT_LOCK (pad);
529 if ((caps = GST_PAD_CAPS (pad)))
531 GST_OBJECT_UNLOCK (pad);
534 if (bclass->get_caps)
535 caps = bclass->get_caps (bsink);
538 GstPadTemplate *pad_template;
541 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass),
543 if (pad_template != NULL) {
544 caps = gst_caps_ref (gst_pad_template_get_caps (pad_template));
548 gst_object_unref (bsink);
554 gst_base_sink_pad_setcaps (GstPad * pad, GstCaps * caps)
556 GstBaseSinkClass *bclass;
560 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
561 bclass = GST_BASE_SINK_GET_CLASS (bsink);
563 if (res && bclass->set_caps)
564 res = bclass->set_caps (bsink, caps);
566 gst_object_unref (bsink);
572 gst_base_sink_pad_fixate (GstPad * pad, GstCaps * caps)
574 GstBaseSinkClass *bclass;
577 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
578 bclass = GST_BASE_SINK_GET_CLASS (bsink);
581 bclass->fixate (bsink, caps);
583 gst_object_unref (bsink);
587 gst_base_sink_pad_buffer_alloc (GstPad * pad, guint64 offset, guint size,
588 GstCaps * caps, GstBuffer ** buf)
590 GstBaseSinkClass *bclass;
592 GstFlowReturn result = GST_FLOW_OK;
594 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
595 bclass = GST_BASE_SINK_GET_CLASS (bsink);
597 if (bclass->buffer_alloc)
598 result = bclass->buffer_alloc (bsink, offset, size, caps, buf);
600 *buf = NULL; /* fallback in gstpad.c will allocate generic buffer */
602 gst_object_unref (bsink);
608 gst_base_sink_init (GstBaseSink * basesink, gpointer g_class)
610 GstPadTemplate *pad_template;
611 GstBaseSinkPrivate *priv;
613 basesink->priv = priv = GST_BASE_SINK_GET_PRIVATE (basesink);
616 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "sink");
617 g_return_if_fail (pad_template != NULL);
619 basesink->sinkpad = gst_pad_new_from_template (pad_template, "sink");
621 gst_pad_set_getcaps_function (basesink->sinkpad, gst_base_sink_pad_getcaps);
622 gst_pad_set_setcaps_function (basesink->sinkpad, gst_base_sink_pad_setcaps);
623 gst_pad_set_fixatecaps_function (basesink->sinkpad, gst_base_sink_pad_fixate);
624 gst_pad_set_bufferalloc_function (basesink->sinkpad,
625 gst_base_sink_pad_buffer_alloc);
626 gst_pad_set_activate_function (basesink->sinkpad, gst_base_sink_pad_activate);
627 gst_pad_set_activatepush_function (basesink->sinkpad,
628 gst_base_sink_pad_activate_push);
629 gst_pad_set_activatepull_function (basesink->sinkpad,
630 gst_base_sink_pad_activate_pull);
631 gst_pad_set_event_function (basesink->sinkpad, gst_base_sink_event);
632 gst_pad_set_chain_function (basesink->sinkpad, gst_base_sink_chain);
633 gst_pad_set_chain_list_function (basesink->sinkpad, gst_base_sink_chain_list);
634 gst_element_add_pad (GST_ELEMENT_CAST (basesink), basesink->sinkpad);
636 basesink->pad_mode = GST_ACTIVATE_NONE;
637 basesink->preroll_queue = g_queue_new ();
638 basesink->abidata.ABI.clip_segment = gst_segment_new ();
639 priv->have_latency = FALSE;
641 basesink->can_activate_push = DEFAULT_CAN_ACTIVATE_PUSH;
642 basesink->can_activate_pull = DEFAULT_CAN_ACTIVATE_PULL;
644 basesink->sync = DEFAULT_SYNC;
645 basesink->abidata.ABI.max_lateness = DEFAULT_MAX_LATENESS;
646 g_atomic_int_set (&priv->qos_enabled, DEFAULT_QOS);
647 priv->async_enabled = DEFAULT_ASYNC;
648 priv->ts_offset = DEFAULT_TS_OFFSET;
649 priv->render_delay = DEFAULT_RENDER_DELAY;
650 priv->blocksize = DEFAULT_BLOCKSIZE;
652 GST_OBJECT_FLAG_SET (basesink, GST_ELEMENT_IS_SINK);
656 gst_base_sink_finalize (GObject * object)
658 GstBaseSink *basesink;
660 basesink = GST_BASE_SINK (object);
662 g_queue_free (basesink->preroll_queue);
663 gst_segment_free (basesink->abidata.ABI.clip_segment);
665 G_OBJECT_CLASS (parent_class)->finalize (object);
669 * gst_base_sink_set_sync:
671 * @sync: the new sync value.
673 * Configures @sink to synchronize on the clock or not. When
674 * @sync is FALSE, incomming samples will be played as fast as
675 * possible. If @sync is TRUE, the timestamps of the incomming
676 * buffers will be used to schedule the exact render time of its
682 gst_base_sink_set_sync (GstBaseSink * sink, gboolean sync)
684 g_return_if_fail (GST_IS_BASE_SINK (sink));
686 GST_OBJECT_LOCK (sink);
688 GST_OBJECT_UNLOCK (sink);
692 * gst_base_sink_get_sync:
695 * Checks if @sink is currently configured to synchronize against the
698 * Returns: TRUE if the sink is configured to synchronize against the clock.
703 gst_base_sink_get_sync (GstBaseSink * sink)
707 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
709 GST_OBJECT_LOCK (sink);
711 GST_OBJECT_UNLOCK (sink);
717 * gst_base_sink_set_max_lateness:
719 * @max_lateness: the new max lateness value.
721 * Sets the new max lateness value to @max_lateness. This value is
722 * used to decide if a buffer should be dropped or not based on the
723 * buffer timestamp and the current clock time. A value of -1 means
729 gst_base_sink_set_max_lateness (GstBaseSink * sink, gint64 max_lateness)
731 g_return_if_fail (GST_IS_BASE_SINK (sink));
733 GST_OBJECT_LOCK (sink);
734 sink->abidata.ABI.max_lateness = max_lateness;
735 GST_OBJECT_UNLOCK (sink);
739 * gst_base_sink_get_max_lateness:
742 * Gets the max lateness value. See gst_base_sink_set_max_lateness for
745 * Returns: The maximum time in nanoseconds that a buffer can be late
746 * before it is dropped and not rendered. A value of -1 means an
752 gst_base_sink_get_max_lateness (GstBaseSink * sink)
756 g_return_val_if_fail (GST_IS_BASE_SINK (sink), -1);
758 GST_OBJECT_LOCK (sink);
759 res = sink->abidata.ABI.max_lateness;
760 GST_OBJECT_UNLOCK (sink);
766 * gst_base_sink_set_qos_enabled:
768 * @enabled: the new qos value.
770 * Configures @sink to send Quality-of-Service events upstream.
775 gst_base_sink_set_qos_enabled (GstBaseSink * sink, gboolean enabled)
777 g_return_if_fail (GST_IS_BASE_SINK (sink));
779 g_atomic_int_set (&sink->priv->qos_enabled, enabled);
783 * gst_base_sink_is_qos_enabled:
786 * Checks if @sink is currently configured to send Quality-of-Service events
789 * Returns: TRUE if the sink is configured to perform Quality-of-Service.
794 gst_base_sink_is_qos_enabled (GstBaseSink * sink)
798 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
800 res = g_atomic_int_get (&sink->priv->qos_enabled);
806 * gst_base_sink_set_async_enabled:
808 * @enabled: the new async value.
810 * Configures @sink to perform all state changes asynchronusly. When async is
811 * disabled, the sink will immediatly go to PAUSED instead of waiting for a
812 * preroll buffer. This feature is usefull if the sink does not synchronize
813 * against the clock or when it is dealing with sparse streams.
818 gst_base_sink_set_async_enabled (GstBaseSink * sink, gboolean enabled)
820 g_return_if_fail (GST_IS_BASE_SINK (sink));
822 GST_PAD_PREROLL_LOCK (sink->sinkpad);
823 sink->priv->async_enabled = enabled;
824 GST_LOG_OBJECT (sink, "set async enabled to %d", enabled);
825 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
829 * gst_base_sink_is_async_enabled:
832 * Checks if @sink is currently configured to perform asynchronous state
835 * Returns: TRUE if the sink is configured to perform asynchronous state
841 gst_base_sink_is_async_enabled (GstBaseSink * sink)
845 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
847 GST_PAD_PREROLL_LOCK (sink->sinkpad);
848 res = sink->priv->async_enabled;
849 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
855 * gst_base_sink_set_ts_offset:
857 * @offset: the new offset
859 * Adjust the synchronisation of @sink with @offset. A negative value will
860 * render buffers earlier than their timestamp. A positive value will delay
861 * rendering. This function can be used to fix playback of badly timestamped
867 gst_base_sink_set_ts_offset (GstBaseSink * sink, GstClockTimeDiff offset)
869 g_return_if_fail (GST_IS_BASE_SINK (sink));
871 GST_OBJECT_LOCK (sink);
872 sink->priv->ts_offset = offset;
873 GST_LOG_OBJECT (sink, "set time offset to %" G_GINT64_FORMAT, offset);
874 GST_OBJECT_UNLOCK (sink);
878 * gst_base_sink_get_ts_offset:
881 * Get the synchronisation offset of @sink.
883 * Returns: The synchronisation offset.
888 gst_base_sink_get_ts_offset (GstBaseSink * sink)
890 GstClockTimeDiff res;
892 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
894 GST_OBJECT_LOCK (sink);
895 res = sink->priv->ts_offset;
896 GST_OBJECT_UNLOCK (sink);
902 * gst_base_sink_get_last_buffer:
905 * Get the last buffer that arrived in the sink and was used for preroll or for
906 * rendering. This property can be used to generate thumbnails.
908 * The #GstCaps on the buffer can be used to determine the type of the buffer.
910 * Returns: a #GstBuffer. gst_buffer_unref() after usage. This function returns
911 * NULL when no buffer has arrived in the sink yet or when the sink is not in
917 gst_base_sink_get_last_buffer (GstBaseSink * sink)
921 g_return_val_if_fail (GST_IS_BASE_SINK (sink), NULL);
923 GST_OBJECT_LOCK (sink);
924 if ((res = sink->priv->last_buffer))
925 gst_buffer_ref (res);
926 GST_OBJECT_UNLOCK (sink);
932 gst_base_sink_set_last_buffer (GstBaseSink * sink, GstBuffer * buffer)
936 GST_OBJECT_LOCK (sink);
937 old = sink->priv->last_buffer;
938 if (G_LIKELY (old != buffer)) {
939 GST_DEBUG_OBJECT (sink, "setting last buffer to %p", buffer);
940 if (G_LIKELY (buffer))
941 gst_buffer_ref (buffer);
942 sink->priv->last_buffer = buffer;
946 GST_OBJECT_UNLOCK (sink);
948 /* avoid unreffing with the lock because cleanup code might want to take the
951 gst_buffer_unref (old);
955 * gst_base_sink_get_latency:
958 * Get the currently configured latency.
960 * Returns: The configured latency.
965 gst_base_sink_get_latency (GstBaseSink * sink)
969 GST_OBJECT_LOCK (sink);
970 res = sink->priv->latency;
971 GST_OBJECT_UNLOCK (sink);
977 * gst_base_sink_query_latency:
979 * @live: if the sink is live
980 * @upstream_live: if an upstream element is live
981 * @min_latency: the min latency of the upstream elements
982 * @max_latency: the max latency of the upstream elements
984 * Query the sink for the latency parameters. The latency will be queried from
985 * the upstream elements. @live will be TRUE if @sink is configured to
986 * synchronize against the clock. @upstream_live will be TRUE if an upstream
989 * If both @live and @upstream_live are TRUE, the sink will want to compensate
990 * for the latency introduced by the upstream elements by setting the
991 * @min_latency to a strictly possitive value.
993 * This function is mostly used by subclasses.
995 * Returns: TRUE if the query succeeded.
1000 gst_base_sink_query_latency (GstBaseSink * sink, gboolean * live,
1001 gboolean * upstream_live, GstClockTime * min_latency,
1002 GstClockTime * max_latency)
1004 gboolean l, us_live, res, have_latency;
1005 GstClockTime min, max, render_delay;
1007 GstClockTime us_min, us_max;
1009 /* we are live when we sync to the clock */
1010 GST_OBJECT_LOCK (sink);
1012 have_latency = sink->priv->have_latency;
1013 render_delay = sink->priv->render_delay;
1014 GST_OBJECT_UNLOCK (sink);
1016 /* assume no latency */
1022 GST_DEBUG_OBJECT (sink, "we are ready for LATENCY query");
1023 /* we are ready for a latency query this is when we preroll or when we are
1025 query = gst_query_new_latency ();
1027 /* ask the peer for the latency */
1028 if ((res = gst_base_sink_peer_query (sink, query))) {
1029 /* get upstream min and max latency */
1030 gst_query_parse_latency (query, &us_live, &us_min, &us_max);
1033 /* upstream live, use its latency, subclasses should use these
1034 * values to create the complete latency. */
1039 /* we need to add the render delay if we are live */
1041 min += render_delay;
1043 max += render_delay;
1046 gst_query_unref (query);
1048 GST_DEBUG_OBJECT (sink, "we are not yet ready for LATENCY query");
1052 /* not live, we tried to do the query, if it failed we return TRUE anyway */
1056 GST_DEBUG_OBJECT (sink, "latency query failed but we are not live");
1058 GST_DEBUG_OBJECT (sink, "latency query failed and we are live");
1063 GST_DEBUG_OBJECT (sink, "latency query: live: %d, have_latency %d,"
1064 " upstream: %d, min %" GST_TIME_FORMAT ", max %" GST_TIME_FORMAT, l,
1065 have_latency, us_live, GST_TIME_ARGS (min), GST_TIME_ARGS (max));
1070 *upstream_live = us_live;
1080 * gst_base_sink_set_render_delay:
1081 * @sink: a #GstBaseSink
1082 * @delay: the new delay
1084 * Set the render delay in @sink to @delay. The render delay is the time
1085 * between actual rendering of a buffer and its synchronisation time. Some
1086 * devices might delay media rendering which can be compensated for with this
1089 * After calling this function, this sink will report additional latency and
1090 * other sinks will adjust their latency to delay the rendering of their media.
1092 * This function is usually called by subclasses.
1097 gst_base_sink_set_render_delay (GstBaseSink * sink, GstClockTime delay)
1099 GstClockTime old_render_delay;
1101 g_return_if_fail (GST_IS_BASE_SINK (sink));
1103 GST_OBJECT_LOCK (sink);
1104 old_render_delay = sink->priv->render_delay;
1105 sink->priv->render_delay = delay;
1106 GST_LOG_OBJECT (sink, "set render delay to %" GST_TIME_FORMAT,
1107 GST_TIME_ARGS (delay));
1108 GST_OBJECT_UNLOCK (sink);
1110 if (delay != old_render_delay) {
1111 GST_DEBUG_OBJECT (sink, "posting latency changed");
1112 gst_element_post_message (GST_ELEMENT_CAST (sink),
1113 gst_message_new_latency (GST_OBJECT_CAST (sink)));
1118 * gst_base_sink_get_render_delay:
1119 * @sink: a #GstBaseSink
1121 * Get the render delay of @sink. see gst_base_sink_set_render_delay() for more
1122 * information about the render delay.
1124 * Returns: the render delay of @sink.
1129 gst_base_sink_get_render_delay (GstBaseSink * sink)
1131 GstClockTimeDiff res;
1133 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1135 GST_OBJECT_LOCK (sink);
1136 res = sink->priv->render_delay;
1137 GST_OBJECT_UNLOCK (sink);
1143 * gst_base_sink_set_blocksize:
1144 * @sink: a #GstBaseSink
1145 * @blocksize: the blocksize in bytes
1147 * Set the number of bytes that the sink will pull when it is operating in pull
1153 gst_base_sink_set_blocksize (GstBaseSink * sink, guint blocksize)
1155 g_return_if_fail (GST_IS_BASE_SINK (sink));
1157 GST_OBJECT_LOCK (sink);
1158 sink->priv->blocksize = blocksize;
1159 GST_LOG_OBJECT (sink, "set blocksize to %u", blocksize);
1160 GST_OBJECT_UNLOCK (sink);
1164 * gst_base_sink_get_blocksize:
1165 * @sink: a #GstBaseSink
1167 * Get the number of bytes that the sink will pull when it is operating in pull
1170 * Returns: the number of bytes @sink will pull in pull mode.
1175 gst_base_sink_get_blocksize (GstBaseSink * sink)
1179 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1181 GST_OBJECT_LOCK (sink);
1182 res = sink->priv->blocksize;
1183 GST_OBJECT_UNLOCK (sink);
1189 gst_base_sink_set_property (GObject * object, guint prop_id,
1190 const GValue * value, GParamSpec * pspec)
1192 GstBaseSink *sink = GST_BASE_SINK (object);
1195 case PROP_PREROLL_QUEUE_LEN:
1196 /* preroll lock necessary to serialize with finish_preroll */
1197 GST_PAD_PREROLL_LOCK (sink->sinkpad);
1198 sink->preroll_queue_max_len = g_value_get_uint (value);
1199 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
1202 gst_base_sink_set_sync (sink, g_value_get_boolean (value));
1204 case PROP_MAX_LATENESS:
1205 gst_base_sink_set_max_lateness (sink, g_value_get_int64 (value));
1208 gst_base_sink_set_qos_enabled (sink, g_value_get_boolean (value));
1211 gst_base_sink_set_async_enabled (sink, g_value_get_boolean (value));
1213 case PROP_TS_OFFSET:
1214 gst_base_sink_set_ts_offset (sink, g_value_get_int64 (value));
1216 case PROP_BLOCKSIZE:
1217 gst_base_sink_set_blocksize (sink, g_value_get_uint (value));
1219 case PROP_RENDER_DELAY:
1220 gst_base_sink_set_render_delay (sink, g_value_get_uint64 (value));
1223 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1229 gst_base_sink_get_property (GObject * object, guint prop_id, GValue * value,
1232 GstBaseSink *sink = GST_BASE_SINK (object);
1235 case PROP_PREROLL_QUEUE_LEN:
1236 GST_PAD_PREROLL_LOCK (sink->sinkpad);
1237 g_value_set_uint (value, sink->preroll_queue_max_len);
1238 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
1241 g_value_set_boolean (value, gst_base_sink_get_sync (sink));
1243 case PROP_MAX_LATENESS:
1244 g_value_set_int64 (value, gst_base_sink_get_max_lateness (sink));
1247 g_value_set_boolean (value, gst_base_sink_is_qos_enabled (sink));
1250 g_value_set_boolean (value, gst_base_sink_is_async_enabled (sink));
1252 case PROP_TS_OFFSET:
1253 g_value_set_int64 (value, gst_base_sink_get_ts_offset (sink));
1255 case PROP_LAST_BUFFER:
1256 gst_value_take_buffer (value, gst_base_sink_get_last_buffer (sink));
1258 case PROP_BLOCKSIZE:
1259 g_value_set_uint (value, gst_base_sink_get_blocksize (sink));
1261 case PROP_RENDER_DELAY:
1262 g_value_set_uint64 (value, gst_base_sink_get_render_delay (sink));
1265 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1272 gst_base_sink_get_caps (GstBaseSink * sink)
1278 gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps)
1283 static GstFlowReturn
1284 gst_base_sink_buffer_alloc (GstBaseSink * sink, guint64 offset, guint size,
1285 GstCaps * caps, GstBuffer ** buf)
1291 /* with PREROLL_LOCK, STREAM_LOCK */
1293 gst_base_sink_preroll_queue_flush (GstBaseSink * basesink, GstPad * pad)
1297 GST_DEBUG_OBJECT (basesink, "flushing queue %p", basesink);
1298 while ((obj = g_queue_pop_head (basesink->preroll_queue))) {
1299 GST_DEBUG_OBJECT (basesink, "popped %p", obj);
1300 gst_mini_object_unref (obj);
1302 /* we can't have EOS anymore now */
1303 basesink->eos = FALSE;
1304 basesink->priv->received_eos = FALSE;
1305 basesink->have_preroll = FALSE;
1306 basesink->priv->step_unlock = FALSE;
1307 basesink->eos_queued = FALSE;
1308 basesink->preroll_queued = 0;
1309 basesink->buffers_queued = 0;
1310 basesink->events_queued = 0;
1311 /* can't report latency anymore until we preroll again */
1312 if (basesink->priv->async_enabled) {
1313 GST_OBJECT_LOCK (basesink);
1314 basesink->priv->have_latency = FALSE;
1315 GST_OBJECT_UNLOCK (basesink);
1317 /* and signal any waiters now */
1318 GST_PAD_PREROLL_SIGNAL (pad);
1321 /* with STREAM_LOCK, configures given segment with the event information. */
1323 gst_base_sink_configure_segment (GstBaseSink * basesink, GstPad * pad,
1324 GstEvent * event, GstSegment * segment)
1327 gdouble rate, arate;
1333 /* the newsegment event is needed to bring the buffer timestamps to the
1334 * stream time and to drop samples outside of the playback segment. */
1335 gst_event_parse_new_segment_full (event, &update, &rate, &arate, &format,
1336 &start, &stop, &time);
1338 /* The segment is protected with both the STREAM_LOCK and the OBJECT_LOCK.
1339 * We protect with the OBJECT_LOCK so that we can use the values to
1340 * safely answer a POSITION query. */
1341 GST_OBJECT_LOCK (basesink);
1342 gst_segment_set_newsegment_full (segment, update, rate, arate, format, start,
1345 if (format == GST_FORMAT_TIME) {
1346 GST_DEBUG_OBJECT (basesink,
1347 "configured NEWSEGMENT update %d, rate %lf, applied rate %lf, "
1348 "format GST_FORMAT_TIME, "
1349 "%" GST_TIME_FORMAT " -- %" GST_TIME_FORMAT
1350 ", time %" GST_TIME_FORMAT ", accum %" GST_TIME_FORMAT,
1351 update, rate, arate, GST_TIME_ARGS (segment->start),
1352 GST_TIME_ARGS (segment->stop), GST_TIME_ARGS (segment->time),
1353 GST_TIME_ARGS (segment->accum));
1355 GST_DEBUG_OBJECT (basesink,
1356 "configured NEWSEGMENT update %d, rate %lf, applied rate %lf, "
1358 "%" G_GINT64_FORMAT " -- %" G_GINT64_FORMAT ", time %"
1359 G_GINT64_FORMAT ", accum %" G_GINT64_FORMAT, update, rate, arate,
1360 segment->format, segment->start, segment->stop, segment->time,
1363 GST_OBJECT_UNLOCK (basesink);
1366 /* with PREROLL_LOCK, STREAM_LOCK */
1368 gst_base_sink_commit_state (GstBaseSink * basesink)
1370 /* commit state and proceed to next pending state */
1371 GstState current, next, pending, post_pending;
1372 gboolean post_paused = FALSE;
1373 gboolean post_async_done = FALSE;
1374 gboolean post_playing = FALSE;
1376 /* we are certainly not playing async anymore now */
1377 basesink->playing_async = FALSE;
1379 GST_OBJECT_LOCK (basesink);
1380 current = GST_STATE (basesink);
1381 next = GST_STATE_NEXT (basesink);
1382 pending = GST_STATE_PENDING (basesink);
1383 post_pending = pending;
1386 case GST_STATE_PLAYING:
1388 GstBaseSinkClass *bclass;
1389 GstStateChangeReturn ret;
1391 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1393 GST_DEBUG_OBJECT (basesink, "commiting state to PLAYING");
1395 basesink->need_preroll = FALSE;
1396 post_async_done = TRUE;
1397 basesink->priv->commited = TRUE;
1398 post_playing = TRUE;
1399 /* post PAUSED too when we were READY */
1400 if (current == GST_STATE_READY) {
1404 /* make sure we notify the subclass of async playing */
1405 if (bclass->async_play) {
1406 GST_WARNING_OBJECT (basesink, "deprecated async_play");
1407 ret = bclass->async_play (basesink);
1408 if (ret == GST_STATE_CHANGE_FAILURE)
1413 case GST_STATE_PAUSED:
1414 GST_DEBUG_OBJECT (basesink, "commiting state to PAUSED");
1416 post_async_done = TRUE;
1417 basesink->priv->commited = TRUE;
1418 post_pending = GST_STATE_VOID_PENDING;
1420 case GST_STATE_READY:
1421 case GST_STATE_NULL:
1423 case GST_STATE_VOID_PENDING:
1424 goto nothing_pending;
1429 /* we can report latency queries now */
1430 basesink->priv->have_latency = TRUE;
1432 GST_STATE (basesink) = pending;
1433 GST_STATE_NEXT (basesink) = GST_STATE_VOID_PENDING;
1434 GST_STATE_PENDING (basesink) = GST_STATE_VOID_PENDING;
1435 GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_SUCCESS;
1436 GST_OBJECT_UNLOCK (basesink);
1439 GST_DEBUG_OBJECT (basesink, "posting PAUSED state change message");
1440 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1441 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1442 current, next, post_pending));
1444 if (post_async_done) {
1445 GST_DEBUG_OBJECT (basesink, "posting async-done message");
1446 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1447 gst_message_new_async_done (GST_OBJECT_CAST (basesink)));
1450 GST_DEBUG_OBJECT (basesink, "posting PLAYING state change message");
1451 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1452 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1453 next, pending, GST_STATE_VOID_PENDING));
1456 GST_STATE_BROADCAST (basesink);
1462 /* Depending on the state, set our vars. We get in this situation when the
1463 * state change function got a change to update the state vars before the
1464 * streaming thread did. This is fine but we need to make sure that we
1465 * update the need_preroll var since it was TRUE when we got here and might
1466 * become FALSE if we got to PLAYING. */
1467 GST_DEBUG_OBJECT (basesink, "nothing to commit, now in %s",
1468 gst_element_state_get_name (current));
1470 case GST_STATE_PLAYING:
1471 basesink->need_preroll = FALSE;
1473 case GST_STATE_PAUSED:
1474 basesink->need_preroll = TRUE;
1477 basesink->need_preroll = FALSE;
1478 basesink->flushing = TRUE;
1481 /* we can report latency queries now */
1482 basesink->priv->have_latency = TRUE;
1483 GST_OBJECT_UNLOCK (basesink);
1488 /* app is going to READY */
1489 GST_DEBUG_OBJECT (basesink, "stopping");
1490 basesink->need_preroll = FALSE;
1491 basesink->flushing = TRUE;
1492 GST_OBJECT_UNLOCK (basesink);
1497 GST_DEBUG_OBJECT (basesink, "async commit failed");
1498 GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_FAILURE;
1499 GST_OBJECT_UNLOCK (basesink);
1505 start_stepping (GstBaseSink * sink, GstSegment * segment,
1506 GstStepInfo * pending, GstStepInfo * current)
1509 GstMessage *message;
1511 GST_DEBUG_OBJECT (sink, "update pending step");
1513 GST_OBJECT_LOCK (sink);
1514 memcpy (current, pending, sizeof (GstStepInfo));
1515 pending->valid = FALSE;
1516 GST_OBJECT_UNLOCK (sink);
1518 /* post message first */
1520 gst_message_new_step_start (GST_OBJECT (sink), TRUE, current->format,
1521 current->amount, current->rate, current->flush, current->intermediate);
1522 gst_message_set_seqnum (message, current->seqnum);
1523 gst_element_post_message (GST_ELEMENT (sink), message);
1525 /* get the running time of where we paused and remember it */
1526 current->start = gst_element_get_start_time (GST_ELEMENT_CAST (sink));
1527 gst_segment_set_running_time (segment, GST_FORMAT_TIME, current->start);
1529 /* set the new rate for the remainder of the segment */
1530 current->start_rate = segment->rate;
1531 segment->rate *= current->rate;
1532 segment->abs_rate = ABS (segment->rate);
1535 if (segment->rate > 0.0)
1536 current->start_stop = segment->stop;
1538 current->start_start = segment->start;
1540 if (current->format == GST_FORMAT_TIME) {
1541 end = current->start + current->amount;
1542 if (!current->flush) {
1543 /* update the segment clipping regions for non-flushing seeks */
1544 if (segment->rate > 0.0) {
1545 segment->stop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1546 segment->last_stop = segment->stop;
1550 position = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1551 segment->time = position;
1552 segment->start = position;
1553 segment->last_stop = position;
1558 GST_DEBUG_OBJECT (sink,
1559 "segment now rate %lf, applied rate %lf, "
1560 "format GST_FORMAT_TIME, "
1561 "%" GST_TIME_FORMAT " -- %" GST_TIME_FORMAT
1562 ", time %" GST_TIME_FORMAT ", accum %" GST_TIME_FORMAT,
1563 segment->rate, segment->applied_rate, GST_TIME_ARGS (segment->start),
1564 GST_TIME_ARGS (segment->stop), GST_TIME_ARGS (segment->time),
1565 GST_TIME_ARGS (segment->accum));
1567 GST_DEBUG_OBJECT (sink, "step started at running_time %" GST_TIME_FORMAT,
1568 GST_TIME_ARGS (current->start));
1570 if (current->amount == -1) {
1571 GST_DEBUG_OBJECT (sink, "step amount == -1, stop stepping");
1572 current->valid = FALSE;
1574 GST_DEBUG_OBJECT (sink, "step amount: %" G_GUINT64_FORMAT ", format: %s, "
1575 "rate: %f", current->amount, gst_format_get_name (current->format),
1581 stop_stepping (GstBaseSink * sink, GstSegment * segment,
1582 GstStepInfo * current, gint64 rstart, gint64 rstop, gboolean eos)
1584 gint64 stop, position;
1585 GstMessage *message;
1587 GST_DEBUG_OBJECT (sink, "step complete");
1589 if (segment->rate > 0.0)
1594 GST_DEBUG_OBJECT (sink,
1595 "step stop at running_time %" GST_TIME_FORMAT, GST_TIME_ARGS (stop));
1598 current->duration = current->position;
1600 current->duration = stop - current->start;
1602 GST_DEBUG_OBJECT (sink, "step elapsed running_time %" GST_TIME_FORMAT,
1603 GST_TIME_ARGS (current->duration));
1605 position = current->start + current->duration;
1607 /* now move the segment to the new running time */
1608 gst_segment_set_running_time (segment, GST_FORMAT_TIME, position);
1610 if (current->flush) {
1611 /* and remove the accumulated time we flushed, start time did not change */
1612 segment->accum = current->start;
1614 /* start time is now the stepped position */
1615 gst_element_set_start_time (GST_ELEMENT_CAST (sink), position);
1618 /* restore the previous rate */
1619 segment->rate = current->start_rate;
1620 segment->abs_rate = ABS (segment->rate);
1622 if (segment->rate > 0.0)
1623 segment->stop = current->start_stop;
1625 segment->start = current->start_start;
1627 /* the clip segment is used for position report in paused... */
1628 memcpy (sink->abidata.ABI.clip_segment, segment, sizeof (GstSegment));
1630 /* post the step done when we know the stepped duration in TIME */
1632 gst_message_new_step_done (GST_OBJECT_CAST (sink), current->format,
1633 current->amount, current->rate, current->flush, current->intermediate,
1634 current->duration, eos);
1635 gst_message_set_seqnum (message, current->seqnum);
1636 gst_element_post_message (GST_ELEMENT_CAST (sink), message);
1638 if (!current->intermediate)
1639 sink->need_preroll = current->need_preroll;
1641 /* and the current step info finished and becomes invalid */
1642 current->valid = FALSE;
1646 handle_stepping (GstBaseSink * sink, GstSegment * segment,
1647 GstStepInfo * current, gint64 * cstart, gint64 * cstop, gint64 * rstart,
1650 gboolean step_end = FALSE;
1652 /* see if we need to skip this buffer because of stepping */
1653 switch (current->format) {
1654 case GST_FORMAT_TIME:
1659 if (segment->rate > 0.0) {
1660 if (segment->stop == *cstop)
1661 *rstop = *rstart + current->amount;
1666 if (segment->start == *cstart)
1667 *rstart = *rstop + current->amount;
1673 end = current->start + current->amount;
1674 current->position = first - current->start;
1676 if (G_UNLIKELY (segment->abs_rate != 1.0))
1677 current->position /= segment->abs_rate;
1679 GST_DEBUG_OBJECT (sink,
1680 "buffer: %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT,
1681 GST_TIME_ARGS (first), GST_TIME_ARGS (last));
1682 GST_DEBUG_OBJECT (sink,
1683 "got time step %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT "/%"
1684 GST_TIME_FORMAT, GST_TIME_ARGS (current->position),
1685 GST_TIME_ARGS (last - current->start),
1686 GST_TIME_ARGS (current->amount));
1688 if ((current->flush && current->position >= current->amount)
1690 GST_DEBUG_OBJECT (sink, "step ended, we need clipping");
1692 if (segment->rate > 0.0) {
1694 *cstart = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1697 *cstop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1700 GST_DEBUG_OBJECT (sink,
1701 "cstart %" GST_TIME_FORMAT ", rstart %" GST_TIME_FORMAT,
1702 GST_TIME_ARGS (*cstart), GST_TIME_ARGS (*rstart));
1703 GST_DEBUG_OBJECT (sink,
1704 "cstop %" GST_TIME_FORMAT ", rstop %" GST_TIME_FORMAT,
1705 GST_TIME_ARGS (*cstop), GST_TIME_ARGS (*rstop));
1708 case GST_FORMAT_BUFFERS:
1709 GST_DEBUG_OBJECT (sink,
1710 "got default step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1711 current->position, current->amount);
1713 if (current->position < current->amount) {
1714 current->position++;
1719 case GST_FORMAT_DEFAULT:
1721 GST_DEBUG_OBJECT (sink,
1722 "got unknown step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1723 current->position, current->amount);
1729 /* with STREAM_LOCK, PREROLL_LOCK
1731 * Returns TRUE if the object needs synchronisation and takes therefore
1732 * part in prerolling.
1734 * rsstart/rsstop contain the start/stop in stream time.
1735 * rrstart/rrstop contain the start/stop in running time.
1738 gst_base_sink_get_sync_times (GstBaseSink * basesink, GstMiniObject * obj,
1739 GstClockTime * rsstart, GstClockTime * rsstop,
1740 GstClockTime * rrstart, GstClockTime * rrstop, gboolean * do_sync,
1741 gboolean * stepped, GstSegment * segment, GstStepInfo * step,
1742 gboolean * step_end)
1744 GstBaseSinkClass *bclass;
1746 GstClockTime start, stop; /* raw start/stop timestamps */
1747 gint64 cstart, cstop; /* clipped raw timestamps */
1748 gint64 rstart, rstop; /* clipped timestamps converted to running time */
1749 GstClockTime sstart, sstop; /* clipped timestamps converted to stream time */
1751 GstBaseSinkPrivate *priv;
1754 priv = basesink->priv;
1756 /* start with nothing */
1757 start = stop = GST_CLOCK_TIME_NONE;
1759 if (G_UNLIKELY (GST_IS_EVENT (obj))) {
1760 GstEvent *event = GST_EVENT_CAST (obj);
1762 switch (GST_EVENT_TYPE (event)) {
1763 /* EOS event needs syncing */
1766 if (basesink->segment.rate >= 0.0) {
1767 sstart = sstop = priv->current_sstop;
1768 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1769 /* we have not seen a buffer yet, use the segment values */
1770 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1771 basesink->segment.format, basesink->segment.stop);
1774 sstart = sstop = priv->current_sstart;
1775 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1776 /* we have not seen a buffer yet, use the segment values */
1777 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1778 basesink->segment.format, basesink->segment.start);
1782 rstart = rstop = priv->eos_rtime;
1783 *do_sync = rstart != -1;
1784 GST_DEBUG_OBJECT (basesink, "sync times for EOS %" GST_TIME_FORMAT,
1785 GST_TIME_ARGS (rstart));
1786 /* if we are stepping, we end now */
1787 *step_end = step->valid;
1792 /* other events do not need syncing */
1793 /* FIXME, maybe NEWSEGMENT might need synchronisation
1794 * since the POSITION query depends on accumulated times and
1795 * we cannot accumulate the current segment before the previous
1804 /* else do buffer sync code */
1805 buffer = GST_BUFFER_CAST (obj);
1807 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1809 /* just get the times to see if we need syncing, if the start returns -1 we
1811 if (bclass->get_times)
1812 bclass->get_times (basesink, buffer, &start, &stop);
1814 if (!GST_CLOCK_TIME_IS_VALID (start)) {
1815 /* we don't need to sync but we still want to get the timestamps for
1816 * tracking the position */
1817 gst_base_sink_get_times (basesink, buffer, &start, &stop);
1823 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
1824 ", stop: %" GST_TIME_FORMAT ", do_sync %d", GST_TIME_ARGS (start),
1825 GST_TIME_ARGS (stop), *do_sync);
1827 /* collect segment and format for code clarity */
1828 format = segment->format;
1830 /* no timestamp clipping if we did not get a TIME segment format */
1831 if (G_UNLIKELY (format != GST_FORMAT_TIME)) {
1834 /* do running and stream time in TIME format */
1835 format = GST_FORMAT_TIME;
1836 GST_LOG_OBJECT (basesink, "not time format, don't clip");
1840 /* clip, only when we know about time */
1841 if (G_UNLIKELY (!gst_segment_clip (segment, GST_FORMAT_TIME,
1842 (gint64) start, (gint64) stop, &cstart, &cstop))) {
1844 GST_DEBUG_OBJECT (basesink, "step out of segment");
1845 /* when we are stepping, pretend we're at the end of the segment */
1846 if (segment->rate > 0.0) {
1847 cstart = segment->stop;
1848 cstop = segment->stop;
1850 cstart = segment->start;
1851 cstop = segment->start;
1855 goto out_of_segment;
1858 if (G_UNLIKELY (start != cstart || stop != cstop)) {
1859 GST_DEBUG_OBJECT (basesink, "clipped to: start %" GST_TIME_FORMAT
1860 ", stop: %" GST_TIME_FORMAT, GST_TIME_ARGS (cstart),
1861 GST_TIME_ARGS (cstop));
1864 /* set last stop position */
1865 if (G_LIKELY (cstop != GST_CLOCK_TIME_NONE))
1866 gst_segment_set_last_stop (segment, GST_FORMAT_TIME, cstop);
1868 gst_segment_set_last_stop (segment, GST_FORMAT_TIME, cstart);
1871 rstart = gst_segment_to_running_time (segment, format, cstart);
1872 rstop = gst_segment_to_running_time (segment, format, cstop);
1874 if (G_UNLIKELY (step->valid)) {
1875 if (!(*step_end = handle_stepping (basesink, segment, step, &cstart, &cstop,
1876 &rstart, &rstop))) {
1877 /* step is still busy, we discard data when we are flushing */
1878 *stepped = step->flush;
1879 GST_DEBUG_OBJECT (basesink, "stepping busy");
1882 /* this can produce wrong values if we accumulated non-TIME segments. If this happens,
1883 * upstream is behaving very badly */
1884 sstart = gst_segment_to_stream_time (segment, format, cstart);
1885 sstop = gst_segment_to_stream_time (segment, format, cstop);
1888 /* eos_done label only called when doing EOS, we also stop stepping then */
1889 if (*step_end && step->flush) {
1890 GST_DEBUG_OBJECT (basesink, "flushing step ended");
1891 stop_stepping (basesink, segment, step, rstart, rstop, eos);
1901 /* buffers and EOS always need syncing and preroll */
1907 /* we usually clip in the chain function already but stepping could cause
1908 * the segment to be updated later. we return FALSE so that we don't try
1910 GST_LOG_OBJECT (basesink, "buffer skipped, not in segment");
1915 /* with STREAM_LOCK, PREROLL_LOCK, LOCK
1916 * adjust a timestamp with the latency and timestamp offset */
1918 gst_base_sink_adjust_time (GstBaseSink * basesink, GstClockTime time)
1920 GstClockTimeDiff ts_offset;
1922 /* don't do anything funny with invalid timestamps */
1923 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
1926 time += basesink->priv->latency;
1928 /* apply offset, be carefull for underflows */
1929 ts_offset = basesink->priv->ts_offset;
1930 if (ts_offset < 0) {
1931 ts_offset = -ts_offset;
1932 if (ts_offset < time)
1943 * gst_base_sink_wait_clock:
1945 * @time: the running_time to be reached
1946 * @jitter: the jitter to be filled with time diff (can be NULL)
1948 * This function will block until @time is reached. It is usually called by
1949 * subclasses that use their own internal synchronisation.
1951 * If @time is not valid, no sycnhronisation is done and #GST_CLOCK_BADTIME is
1952 * returned. Likewise, if synchronisation is disabled in the element or there
1953 * is no clock, no synchronisation is done and #GST_CLOCK_BADTIME is returned.
1955 * This function should only be called with the PREROLL_LOCK held, like when
1956 * receiving an EOS event in the #GstBaseSinkClass.event() vmethod or when
1957 * receiving a buffer in
1958 * the #GstBaseSinkClass.render() vmethod.
1960 * The @time argument should be the running_time of when this method should
1961 * return and is not adjusted with any latency or offset configured in the
1966 * Returns: #GstClockReturn
1969 gst_base_sink_wait_clock (GstBaseSink * sink, GstClockTime time,
1970 GstClockTimeDiff * jitter)
1976 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
1979 GST_OBJECT_LOCK (sink);
1980 if (G_UNLIKELY (!sink->sync))
1983 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (sink)) == NULL))
1986 /* add base_time to running_time to get the time against the clock */
1987 time += GST_ELEMENT_CAST (sink)->base_time;
1989 id = gst_clock_new_single_shot_id (clock, time);
1990 GST_OBJECT_UNLOCK (sink);
1992 /* A blocking wait is performed on the clock. We save the ClockID
1993 * so we can unlock the entry at any time. While we are blocking, we
1994 * release the PREROLL_LOCK so that other threads can interrupt the
1996 sink->clock_id = id;
1997 /* release the preroll lock while waiting */
1998 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
2000 ret = gst_clock_id_wait (id, jitter);
2002 GST_PAD_PREROLL_LOCK (sink->sinkpad);
2003 gst_clock_id_unref (id);
2004 sink->clock_id = NULL;
2008 /* no syncing needed */
2011 GST_DEBUG_OBJECT (sink, "time not valid, no sync needed");
2012 return GST_CLOCK_BADTIME;
2016 GST_DEBUG_OBJECT (sink, "sync disabled");
2017 GST_OBJECT_UNLOCK (sink);
2018 return GST_CLOCK_BADTIME;
2022 GST_DEBUG_OBJECT (sink, "no clock, can't sync");
2023 GST_OBJECT_UNLOCK (sink);
2024 return GST_CLOCK_BADTIME;
2029 * gst_base_sink_wait_preroll:
2032 * If the #GstBaseSinkClass.render() method performs its own synchronisation
2033 * against the clock it must unblock when going from PLAYING to the PAUSED state
2034 * and call this method before continuing to render the remaining data.
2036 * This function will block until a state change to PLAYING happens (in which
2037 * case this function returns #GST_FLOW_OK) or the processing must be stopped due
2038 * to a state change to READY or a FLUSH event (in which case this function
2039 * returns #GST_FLOW_WRONG_STATE).
2041 * This function should only be called with the PREROLL_LOCK held, like in the
2046 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2047 * continue. Any other return value should be returned from the render vmethod.
2050 gst_base_sink_wait_preroll (GstBaseSink * sink)
2052 sink->have_preroll = TRUE;
2053 GST_DEBUG_OBJECT (sink, "waiting in preroll for flush or PLAYING");
2054 /* block until the state changes, or we get a flush, or something */
2055 GST_PAD_PREROLL_WAIT (sink->sinkpad);
2056 sink->have_preroll = FALSE;
2057 if (G_UNLIKELY (sink->flushing))
2059 if (G_UNLIKELY (sink->priv->step_unlock))
2061 GST_DEBUG_OBJECT (sink, "continue after preroll");
2068 GST_DEBUG_OBJECT (sink, "preroll interrupted because of flush");
2069 return GST_FLOW_WRONG_STATE;
2073 sink->priv->step_unlock = FALSE;
2074 GST_DEBUG_OBJECT (sink, "preroll interrupted because of step");
2075 return GST_FLOW_STEP;
2080 * gst_base_sink_do_preroll:
2082 * @obj: the object that caused the preroll
2084 * If the @sink spawns its own thread for pulling buffers from upstream it
2085 * should call this method after it has pulled a buffer. If the element needed
2086 * to preroll, this function will perform the preroll and will then block
2087 * until the element state is changed.
2089 * This function should be called with the PREROLL_LOCK held.
2093 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2094 * continue. Any other return value should be returned from the render vmethod.
2097 gst_base_sink_do_preroll (GstBaseSink * sink, GstMiniObject * obj)
2101 while (G_UNLIKELY (sink->need_preroll)) {
2102 GST_DEBUG_OBJECT (sink, "prerolling object %p", obj);
2104 ret = gst_base_sink_preroll_object (sink, FALSE, obj);
2105 if (ret != GST_FLOW_OK)
2106 goto preroll_failed;
2108 /* need to recheck here because the commit state could have
2109 * made us not need the preroll anymore */
2110 if (G_LIKELY (sink->need_preroll)) {
2111 /* block until the state changes, or we get a flush, or something */
2112 ret = gst_base_sink_wait_preroll (sink);
2113 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2114 goto preroll_failed;
2122 GST_DEBUG_OBJECT (sink, "preroll failed %d", ret);
2128 * gst_base_sink_wait_eos:
2130 * @time: the running_time to be reached
2131 * @jitter: the jitter to be filled with time diff (can be NULL)
2133 * This function will block until @time is reached. It is usually called by
2134 * subclasses that use their own internal synchronisation but want to let the
2135 * EOS be handled by the base class.
2137 * This function should only be called with the PREROLL_LOCK held, like when
2138 * receiving an EOS event in the ::event vmethod.
2140 * The @time argument should be the running_time of when the EOS should happen
2141 * and will be adjusted with any latency and offset configured in the sink.
2145 * Returns: #GstFlowReturn
2148 gst_base_sink_wait_eos (GstBaseSink * sink, GstClockTime time,
2149 GstClockTimeDiff * jitter)
2151 GstClockReturn status;
2157 GST_DEBUG_OBJECT (sink, "checking preroll");
2159 /* first wait for the playing state before we can continue */
2160 if (G_UNLIKELY (sink->need_preroll)) {
2161 ret = gst_base_sink_wait_preroll (sink);
2162 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2166 /* preroll done, we can sync since we are in PLAYING now. */
2167 GST_DEBUG_OBJECT (sink, "possibly waiting for clock to reach %"
2168 GST_TIME_FORMAT, GST_TIME_ARGS (time));
2170 /* compensate for latency and ts_offset. We don't adjust for render delay
2171 * because we don't interact with the device on EOS normally. */
2172 stime = gst_base_sink_adjust_time (sink, time);
2174 /* wait for the clock, this can be interrupted because we got shut down or
2176 status = gst_base_sink_wait_clock (sink, stime, jitter);
2178 GST_DEBUG_OBJECT (sink, "clock returned %d", status);
2180 /* invalid time, no clock or sync disabled, just continue then */
2181 if (status == GST_CLOCK_BADTIME)
2184 /* waiting could have been interrupted and we can be flushing now */
2185 if (G_UNLIKELY (sink->flushing))
2188 /* retry if we got unscheduled, which means we did not reach the timeout
2189 * yet. if some other error occures, we continue. */
2190 } while (status == GST_CLOCK_UNSCHEDULED);
2192 GST_DEBUG_OBJECT (sink, "end of stream");
2199 GST_DEBUG_OBJECT (sink, "we are flushing");
2200 return GST_FLOW_WRONG_STATE;
2204 /* with STREAM_LOCK, PREROLL_LOCK
2206 * Make sure we are in PLAYING and synchronize an object to the clock.
2208 * If we need preroll, we are not in PLAYING. We try to commit the state
2209 * if needed and then block if we still are not PLAYING.
2211 * We start waiting on the clock in PLAYING. If we got interrupted, we
2212 * immediatly try to re-preroll.
2214 * Some objects do not need synchronisation (most events) and so this function
2215 * immediatly returns GST_FLOW_OK.
2217 * for objects that arrive later than max-lateness to be synchronized to the
2218 * clock have the @late boolean set to TRUE.
2220 * This function keeps a running average of the jitter (the diff between the
2221 * clock time and the requested sync time). The jitter is negative for
2222 * objects that arrive in time and positive for late buffers.
2224 * does not take ownership of obj.
2226 static GstFlowReturn
2227 gst_base_sink_do_sync (GstBaseSink * basesink, GstPad * pad,
2228 GstMiniObject * obj, gboolean * late, gboolean * step_end)
2230 GstClockTimeDiff jitter;
2232 GstClockReturn status = GST_CLOCK_OK;
2233 GstClockTime rstart, rstop, sstart, sstop, stime;
2235 GstBaseSinkPrivate *priv;
2237 GstStepInfo *current, *pending;
2240 priv = basesink->priv;
2243 sstart = sstop = rstart = rstop = GST_CLOCK_TIME_NONE;
2247 priv->current_rstart = GST_CLOCK_TIME_NONE;
2249 /* get stepping info */
2250 current = &priv->current_step;
2251 pending = &priv->pending_step;
2253 /* get timing information for this object against the render segment */
2254 syncable = gst_base_sink_get_sync_times (basesink, obj,
2255 &sstart, &sstop, &rstart, &rstop, &do_sync, &stepped, &basesink->segment,
2258 if (G_UNLIKELY (stepped))
2261 /* a syncable object needs to participate in preroll and
2262 * clocking. All buffers and EOS are syncable. */
2263 if (G_UNLIKELY (!syncable))
2266 /* store timing info for current object */
2267 priv->current_rstart = rstart;
2268 priv->current_rstop = (GST_CLOCK_TIME_IS_VALID (rstop) ? rstop : rstart);
2270 /* save sync time for eos when the previous object needed sync */
2271 priv->eos_rtime = (do_sync ? priv->current_rstop : GST_CLOCK_TIME_NONE);
2274 /* first do preroll, this makes sure we commit our state
2275 * to PAUSED and can continue to PLAYING. We cannot perform
2276 * any clock sync in PAUSED because there is no clock. */
2277 ret = gst_base_sink_do_preroll (basesink, obj);
2278 if (G_UNLIKELY (ret != GST_FLOW_OK))
2279 goto preroll_failed;
2281 /* update the segment with a pending step if the current one is invalid and we
2282 * have a new pending one. We only accept new step updates after a preroll */
2283 if (G_UNLIKELY (pending->valid && !current->valid)) {
2284 start_stepping (basesink, &basesink->segment, pending, current);
2288 /* After rendering we store the position of the last buffer so that we can use
2289 * it to report the position. We need to take the lock here. */
2290 GST_OBJECT_LOCK (basesink);
2291 priv->current_sstart = sstart;
2292 priv->current_sstop = (GST_CLOCK_TIME_IS_VALID (sstop) ? sstop : sstart);
2293 GST_OBJECT_UNLOCK (basesink);
2298 /* adjust for latency */
2299 stime = gst_base_sink_adjust_time (basesink, rstart);
2301 /* adjust for render-delay, avoid underflows */
2302 if (GST_CLOCK_TIME_IS_VALID (stime)) {
2303 if (stime > priv->render_delay)
2304 stime -= priv->render_delay;
2309 /* preroll done, we can sync since we are in PLAYING now. */
2310 GST_DEBUG_OBJECT (basesink, "possibly waiting for clock to reach %"
2311 GST_TIME_FORMAT ", adjusted %" GST_TIME_FORMAT,
2312 GST_TIME_ARGS (rstart), GST_TIME_ARGS (stime));
2314 /* This function will return immediatly if start == -1, no clock
2315 * or sync is disabled with GST_CLOCK_BADTIME. */
2316 status = gst_base_sink_wait_clock (basesink, stime, &jitter);
2318 GST_DEBUG_OBJECT (basesink, "clock returned %d", status);
2320 /* invalid time, no clock or sync disabled, just render */
2321 if (status == GST_CLOCK_BADTIME)
2324 /* waiting could have been interrupted and we can be flushing now */
2325 if (G_UNLIKELY (basesink->flushing))
2328 /* check for unlocked by a state change, we are not flushing so
2329 * we can try to preroll on the current buffer. */
2330 if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED)) {
2331 GST_DEBUG_OBJECT (basesink, "unscheduled, waiting some more");
2332 priv->call_preroll = TRUE;
2336 /* successful syncing done, record observation */
2337 priv->current_jitter = jitter;
2339 /* check if the object should be dropped */
2340 *late = gst_base_sink_is_too_late (basesink, obj, rstart, rstop,
2349 GST_DEBUG_OBJECT (basesink, "skipped stepped object %p", obj);
2355 GST_DEBUG_OBJECT (basesink, "non syncable object %p", obj);
2360 GST_DEBUG_OBJECT (basesink, "we are flushing");
2361 return GST_FLOW_WRONG_STATE;
2365 GST_DEBUG_OBJECT (basesink, "preroll failed");
2372 gst_base_sink_send_qos (GstBaseSink * basesink,
2373 gdouble proportion, GstClockTime time, GstClockTimeDiff diff)
2378 /* generate Quality-of-Service event */
2379 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2380 "qos: proportion: %lf, diff %" G_GINT64_FORMAT ", timestamp %"
2381 GST_TIME_FORMAT, proportion, diff, GST_TIME_ARGS (time));
2383 event = gst_event_new_qos (proportion, diff, time);
2386 res = gst_pad_push_event (basesink->sinkpad, event);
2392 gst_base_sink_perform_qos (GstBaseSink * sink, gboolean dropped)
2394 GstBaseSinkPrivate *priv;
2395 GstClockTime start, stop;
2396 GstClockTimeDiff jitter;
2397 GstClockTime pt, entered, left;
2398 GstClockTime duration;
2403 start = priv->current_rstart;
2405 if (priv->current_step.valid)
2408 /* if Quality-of-Service disabled, do nothing */
2409 if (!g_atomic_int_get (&priv->qos_enabled) ||
2410 !GST_CLOCK_TIME_IS_VALID (start))
2413 stop = priv->current_rstop;
2414 jitter = priv->current_jitter;
2417 /* this is the time the buffer entered the sink */
2418 if (start < -jitter)
2421 entered = start + jitter;
2424 /* this is the time the buffer entered the sink */
2425 entered = start + jitter;
2426 /* this is the time the buffer left the sink */
2427 left = start + jitter;
2430 /* calculate duration of the buffer */
2431 if (GST_CLOCK_TIME_IS_VALID (stop))
2432 duration = stop - start;
2434 duration = GST_CLOCK_TIME_NONE;
2436 /* if we have the time when the last buffer left us, calculate
2437 * processing time */
2438 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2439 if (entered > priv->last_left) {
2440 pt = entered - priv->last_left;
2448 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "start: %" GST_TIME_FORMAT
2449 ", entered %" GST_TIME_FORMAT ", left %" GST_TIME_FORMAT ", pt: %"
2450 GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT ",jitter %"
2451 G_GINT64_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (entered),
2452 GST_TIME_ARGS (left), GST_TIME_ARGS (pt), GST_TIME_ARGS (duration),
2455 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "avg_duration: %" GST_TIME_FORMAT
2456 ", avg_pt: %" GST_TIME_FORMAT ", avg_rate: %g",
2457 GST_TIME_ARGS (priv->avg_duration), GST_TIME_ARGS (priv->avg_pt),
2460 /* collect running averages. for first observations, we copy the
2462 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_duration))
2463 priv->avg_duration = duration;
2465 priv->avg_duration = UPDATE_RUNNING_AVG (priv->avg_duration, duration);
2467 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_pt))
2470 priv->avg_pt = UPDATE_RUNNING_AVG (priv->avg_pt, pt);
2472 if (priv->avg_duration != 0)
2474 gst_guint64_to_gdouble (priv->avg_pt) /
2475 gst_guint64_to_gdouble (priv->avg_duration);
2479 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2480 if (dropped || priv->avg_rate < 0.0) {
2481 priv->avg_rate = rate;
2484 priv->avg_rate = UPDATE_RUNNING_AVG_N (priv->avg_rate, rate);
2486 priv->avg_rate = UPDATE_RUNNING_AVG_P (priv->avg_rate, rate);
2490 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink,
2491 "updated: avg_duration: %" GST_TIME_FORMAT ", avg_pt: %" GST_TIME_FORMAT
2492 ", avg_rate: %g", GST_TIME_ARGS (priv->avg_duration),
2493 GST_TIME_ARGS (priv->avg_pt), priv->avg_rate);
2496 if (priv->avg_rate >= 0.0) {
2497 /* if we have a valid rate, start sending QoS messages */
2498 if (priv->current_jitter < 0) {
2499 /* make sure we never go below 0 when adding the jitter to the
2501 if (priv->current_rstart < -priv->current_jitter)
2502 priv->current_jitter = -priv->current_rstart;
2504 gst_base_sink_send_qos (sink, priv->avg_rate, priv->current_rstart,
2505 priv->current_jitter);
2508 /* record when this buffer will leave us */
2509 priv->last_left = left;
2512 /* reset all qos measuring */
2514 gst_base_sink_reset_qos (GstBaseSink * sink)
2516 GstBaseSinkPrivate *priv;
2520 priv->last_in_time = GST_CLOCK_TIME_NONE;
2521 priv->last_left = GST_CLOCK_TIME_NONE;
2522 priv->avg_duration = GST_CLOCK_TIME_NONE;
2523 priv->avg_pt = GST_CLOCK_TIME_NONE;
2524 priv->avg_rate = -1.0;
2525 priv->avg_render = GST_CLOCK_TIME_NONE;
2531 /* Checks if the object was scheduled too late.
2533 * start/stop contain the raw timestamp start and stop values
2536 * status and jitter contain the return values from the clock wait.
2538 * returns TRUE if the buffer was too late.
2541 gst_base_sink_is_too_late (GstBaseSink * basesink, GstMiniObject * obj,
2542 GstClockTime start, GstClockTime stop,
2543 GstClockReturn status, GstClockTimeDiff jitter)
2546 gint64 max_lateness;
2547 GstBaseSinkPrivate *priv;
2549 priv = basesink->priv;
2553 /* only for objects that were too late */
2554 if (G_LIKELY (status != GST_CLOCK_EARLY))
2557 max_lateness = basesink->abidata.ABI.max_lateness;
2559 /* check if frame dropping is enabled */
2560 if (max_lateness == -1)
2563 /* only check for buffers */
2564 if (G_UNLIKELY (!GST_IS_BUFFER (obj)))
2567 /* can't do check if we don't have a timestamp */
2568 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (start)))
2571 /* we can add a valid stop time */
2572 if (GST_CLOCK_TIME_IS_VALID (stop))
2573 max_lateness += stop;
2575 max_lateness += start;
2577 /* if the jitter bigger than duration and lateness we are too late */
2578 if ((late = start + jitter > max_lateness)) {
2579 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2580 "buffer is too late %" GST_TIME_FORMAT
2581 " > %" GST_TIME_FORMAT, GST_TIME_ARGS (start + jitter),
2582 GST_TIME_ARGS (max_lateness));
2583 /* !!emergency!!, if we did not receive anything valid for more than a
2584 * second, render it anyway so the user sees something */
2585 if (GST_CLOCK_TIME_IS_VALID (priv->last_in_time) &&
2586 start - priv->last_in_time > GST_SECOND) {
2588 GST_ELEMENT_WARNING (basesink, CORE, CLOCK,
2589 (_("A lot of buffers are being dropped.")),
2590 ("There may be a timestamping problem, or this computer is too slow."));
2591 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2592 "**emergency** last buffer at %" GST_TIME_FORMAT " > GST_SECOND",
2593 GST_TIME_ARGS (priv->last_in_time));
2599 priv->last_in_time = start;
2606 GST_DEBUG_OBJECT (basesink, "object was scheduled in time");
2611 GST_DEBUG_OBJECT (basesink, "frame dropping disabled");
2616 GST_DEBUG_OBJECT (basesink, "object is not a buffer");
2621 GST_DEBUG_OBJECT (basesink, "buffer has no timestamp");
2626 /* called before and after calling the render vmethod. It keeps track of how
2627 * much time was spent in the render method and is used to check if we are
2630 gst_base_sink_do_render_stats (GstBaseSink * basesink, gboolean start)
2632 GstBaseSinkPrivate *priv;
2634 priv = basesink->priv;
2637 priv->start = gst_util_get_timestamp ();
2639 GstClockTime elapsed;
2641 priv->stop = gst_util_get_timestamp ();
2643 elapsed = GST_CLOCK_DIFF (priv->start, priv->stop);
2645 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_render))
2646 priv->avg_render = elapsed;
2648 priv->avg_render = UPDATE_RUNNING_AVG (priv->avg_render, elapsed);
2650 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2651 "avg_render: %" GST_TIME_FORMAT, GST_TIME_ARGS (priv->avg_render));
2655 /* with STREAM_LOCK, PREROLL_LOCK,
2657 * Synchronize the object on the clock and then render it.
2659 * takes ownership of obj.
2661 static GstFlowReturn
2662 gst_base_sink_render_object (GstBaseSink * basesink, GstPad * pad,
2663 gboolean is_list, gpointer obj)
2666 GstBaseSinkClass *bclass;
2667 gboolean late, step_end;
2670 GstBaseSinkPrivate *priv;
2672 priv = basesink->priv;
2676 * If buffer list, use the first group buffer within the list
2679 sync_obj = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0, 0);
2680 g_assert (NULL != sync_obj);
2689 /* synchronize this object, non syncable objects return OK
2691 ret = gst_base_sink_do_sync (basesink, pad, sync_obj, &late, &step_end);
2692 if (G_UNLIKELY (ret != GST_FLOW_OK))
2695 /* and now render, event or buffer/buffer list. */
2696 if (G_LIKELY (is_list || GST_IS_BUFFER (obj))) {
2697 /* drop late buffers unconditionally, let's hope it's unlikely */
2698 if (G_UNLIKELY (late))
2701 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2703 if (G_LIKELY ((is_list && bclass->render_list) ||
2704 (!is_list && bclass->render))) {
2707 /* read once, to get same value before and after */
2708 do_qos = g_atomic_int_get (&priv->qos_enabled);
2710 GST_DEBUG_OBJECT (basesink, "rendering object %p", obj);
2712 /* record rendering time for QoS and stats */
2714 gst_base_sink_do_render_stats (basesink, TRUE);
2719 /* For buffer lists do not set last buffer. Creating buffer
2720 * with meaningful data can be done only with memcpy which will
2721 * significantly affect performance */
2722 buf = GST_BUFFER_CAST (obj);
2723 gst_base_sink_set_last_buffer (basesink, buf);
2725 ret = bclass->render (basesink, buf);
2727 GstBufferList *buflist;
2729 buflist = GST_BUFFER_LIST_CAST (obj);
2731 ret = bclass->render_list (basesink, buflist);
2735 gst_base_sink_do_render_stats (basesink, FALSE);
2737 if (ret == GST_FLOW_STEP)
2740 if (G_UNLIKELY (basesink->flushing))
2746 GstEvent *event = GST_EVENT_CAST (obj);
2747 gboolean event_res = TRUE;
2750 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2752 type = GST_EVENT_TYPE (event);
2754 GST_DEBUG_OBJECT (basesink, "rendering event %p, type %s", obj,
2755 gst_event_type_get_name (type));
2758 event_res = bclass->event (basesink, event);
2760 /* when we get here we could be flushing again when the event handler calls
2761 * _wait_eos(). We have to ignore this object in that case. */
2762 if (G_UNLIKELY (basesink->flushing))
2765 if (G_LIKELY (event_res)) {
2768 seqnum = basesink->priv->seqnum = gst_event_get_seqnum (event);
2769 GST_DEBUG_OBJECT (basesink, "Got seqnum #%" G_GUINT32_FORMAT, seqnum);
2774 GstMessage *message;
2776 /* the EOS event is completely handled so we mark
2777 * ourselves as being in the EOS state. eos is also
2778 * protected by the object lock so we can read it when
2779 * answering the POSITION query. */
2780 GST_OBJECT_LOCK (basesink);
2781 basesink->eos = TRUE;
2782 GST_OBJECT_UNLOCK (basesink);
2784 /* ok, now we can post the message */
2785 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
2787 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
2788 gst_message_set_seqnum (message, seqnum);
2789 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
2792 case GST_EVENT_NEWSEGMENT:
2793 /* configure the segment */
2794 gst_base_sink_configure_segment (basesink, pad, event,
2795 &basesink->segment);
2797 case GST_EVENT_SINK_MESSAGE:{
2798 GstMessage *msg = NULL;
2800 gst_event_parse_sink_message (event, &msg);
2803 gst_element_post_message (GST_ELEMENT_CAST (basesink), msg);
2813 /* the step ended, check if we need to activate a new step */
2814 GST_DEBUG_OBJECT (basesink, "step ended");
2815 stop_stepping (basesink, &basesink->segment, &priv->current_step,
2816 priv->current_rstart, priv->current_rstop, basesink->eos);
2820 gst_base_sink_perform_qos (basesink, late);
2822 GST_DEBUG_OBJECT (basesink, "object unref after render %p", obj);
2823 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
2829 GST_DEBUG_OBJECT (basesink, "do_sync returned %s", gst_flow_get_name (ret));
2835 GST_DEBUG_OBJECT (basesink, "buffer late, dropping");
2840 GST_DEBUG_OBJECT (basesink, "we are flushing, ignore object");
2841 gst_mini_object_unref (obj);
2842 return GST_FLOW_WRONG_STATE;
2846 /* with STREAM_LOCK, PREROLL_LOCK
2848 * Perform preroll on the given object. For buffers this means
2849 * calling the preroll subclass method.
2850 * If that succeeds, the state will be commited.
2852 * function does not take ownership of obj.
2854 static GstFlowReturn
2855 gst_base_sink_preroll_object (GstBaseSink * basesink, gboolean is_list,
2856 GstMiniObject * obj)
2860 GST_DEBUG_OBJECT (basesink, "prerolling object %p", obj);
2862 /* if it's a buffer, we need to call the preroll method */
2863 if (G_LIKELY (is_list || GST_IS_BUFFER (obj)) && basesink->priv->call_preroll) {
2864 GstBaseSinkClass *bclass;
2866 GstClockTime timestamp;
2869 buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0, 0);
2870 g_assert (NULL != buf);
2872 buf = GST_BUFFER_CAST (obj);
2875 timestamp = GST_BUFFER_TIMESTAMP (buf);
2877 GST_DEBUG_OBJECT (basesink, "preroll buffer %" GST_TIME_FORMAT,
2878 GST_TIME_ARGS (timestamp));
2881 * For buffer lists do not set last buffer. Creating buffer
2882 * with meaningful data can be done only with memcpy which will
2883 * significantly affect performance
2886 gst_base_sink_set_last_buffer (basesink, buf);
2889 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2890 if (bclass->preroll)
2891 if ((ret = bclass->preroll (basesink, buf)) != GST_FLOW_OK)
2892 goto preroll_failed;
2894 basesink->priv->call_preroll = FALSE;
2898 if (G_LIKELY (basesink->playing_async)) {
2899 if (G_UNLIKELY (!gst_base_sink_commit_state (basesink)))
2908 GST_DEBUG_OBJECT (basesink, "preroll failed, abort state");
2909 gst_element_abort_state (GST_ELEMENT_CAST (basesink));
2914 GST_DEBUG_OBJECT (basesink, "stopping while commiting state");
2915 return GST_FLOW_WRONG_STATE;
2919 /* with STREAM_LOCK, PREROLL_LOCK
2921 * Queue an object for rendering.
2922 * The first prerollable object queued will complete the preroll. If the
2923 * preroll queue if filled, we render all the objects in the queue.
2925 * This function takes ownership of the object.
2927 static GstFlowReturn
2928 gst_base_sink_queue_object_unlocked (GstBaseSink * basesink, GstPad * pad,
2929 gboolean is_list, gpointer obj, gboolean prerollable)
2931 GstFlowReturn ret = GST_FLOW_OK;
2935 if (G_UNLIKELY (basesink->need_preroll)) {
2936 if (G_LIKELY (prerollable))
2937 basesink->preroll_queued++;
2939 length = basesink->preroll_queued;
2941 GST_DEBUG_OBJECT (basesink, "now %d prerolled items", length);
2943 /* first prerollable item needs to finish the preroll */
2945 ret = gst_base_sink_preroll_object (basesink, is_list, obj);
2946 if (G_UNLIKELY (ret != GST_FLOW_OK))
2947 goto preroll_failed;
2949 /* need to recheck if we need preroll, commmit state during preroll
2950 * could have made us not need more preroll. */
2951 if (G_UNLIKELY (basesink->need_preroll)) {
2952 /* see if we can render now, if we can't add the object to the preroll
2954 if (G_UNLIKELY (length <= basesink->preroll_queue_max_len))
2958 /* we can start rendering (or blocking) the queued object
2960 q = basesink->preroll_queue;
2961 while (G_UNLIKELY (!g_queue_is_empty (q))) {
2964 o = g_queue_pop_head (q);
2965 GST_DEBUG_OBJECT (basesink, "rendering queued object %p", o);
2967 /* do something with the return value */
2968 ret = gst_base_sink_render_object (basesink, pad, FALSE, o);
2969 if (ret != GST_FLOW_OK)
2970 goto dequeue_failed;
2973 /* now render the object */
2974 ret = gst_base_sink_render_object (basesink, pad, is_list, obj);
2975 basesink->preroll_queued = 0;
2982 GST_DEBUG_OBJECT (basesink, "preroll failed, reason %s",
2983 gst_flow_get_name (ret));
2984 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
2989 /* add object to the queue and return */
2990 GST_DEBUG_OBJECT (basesink, "need more preroll data %d <= %d",
2991 length, basesink->preroll_queue_max_len);
2992 g_queue_push_tail (basesink->preroll_queue, obj);
2997 GST_DEBUG_OBJECT (basesink, "rendering queued objects failed, reason %s",
2998 gst_flow_get_name (ret));
2999 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3006 * This function grabs the PREROLL_LOCK and adds the object to
3009 * This function takes ownership of obj.
3011 static GstFlowReturn
3012 gst_base_sink_queue_object (GstBaseSink * basesink, GstPad * pad,
3013 GstMiniObject * obj, gboolean prerollable)
3017 GST_PAD_PREROLL_LOCK (pad);
3018 if (G_UNLIKELY (basesink->flushing))
3021 if (G_UNLIKELY (basesink->priv->received_eos))
3025 gst_base_sink_queue_object_unlocked (basesink, pad, FALSE, obj,
3027 GST_PAD_PREROLL_UNLOCK (pad);
3034 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3035 GST_PAD_PREROLL_UNLOCK (pad);
3036 gst_mini_object_unref (obj);
3037 return GST_FLOW_WRONG_STATE;
3041 GST_DEBUG_OBJECT (basesink,
3042 "we are EOS, dropping object, return UNEXPECTED");
3043 GST_PAD_PREROLL_UNLOCK (pad);
3044 gst_mini_object_unref (obj);
3045 return GST_FLOW_UNEXPECTED;
3050 gst_base_sink_flush_start (GstBaseSink * basesink, GstPad * pad)
3052 /* make sure we are not blocked on the clock also clear any pending
3054 gst_base_sink_set_flushing (basesink, pad, TRUE);
3056 /* we grab the stream lock but that is not needed since setting the
3057 * sink to flushing would make sure no state commit is being done
3059 GST_PAD_STREAM_LOCK (pad);
3060 gst_base_sink_reset_qos (basesink);
3061 if (basesink->priv->async_enabled) {
3062 /* and we need to commit our state again on the next
3063 * prerolled buffer */
3064 basesink->playing_async = TRUE;
3065 gst_element_lost_state (GST_ELEMENT_CAST (basesink));
3067 basesink->priv->have_latency = TRUE;
3068 basesink->need_preroll = FALSE;
3070 gst_base_sink_set_last_buffer (basesink, NULL);
3071 GST_PAD_STREAM_UNLOCK (pad);
3075 gst_base_sink_flush_stop (GstBaseSink * basesink, GstPad * pad)
3077 /* unset flushing so we can accept new data, this also flushes out any EOS
3079 gst_base_sink_set_flushing (basesink, pad, FALSE);
3081 /* for position reporting */
3082 GST_OBJECT_LOCK (basesink);
3083 basesink->priv->current_sstart = GST_CLOCK_TIME_NONE;
3084 basesink->priv->current_sstop = GST_CLOCK_TIME_NONE;
3085 basesink->priv->eos_rtime = GST_CLOCK_TIME_NONE;
3086 basesink->priv->call_preroll = TRUE;
3087 basesink->priv->current_step.valid = FALSE;
3088 basesink->priv->pending_step.valid = FALSE;
3089 if (basesink->pad_mode == GST_ACTIVATE_PUSH) {
3090 /* we need new segment info after the flush. */
3091 basesink->have_newsegment = FALSE;
3092 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
3093 gst_segment_init (basesink->abidata.ABI.clip_segment, GST_FORMAT_UNDEFINED);
3095 GST_OBJECT_UNLOCK (basesink);
3099 gst_base_sink_event (GstPad * pad, GstEvent * event)
3101 GstBaseSink *basesink;
3102 gboolean result = TRUE;
3103 GstBaseSinkClass *bclass;
3105 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3107 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3109 GST_DEBUG_OBJECT (basesink, "event %p (%s)", event,
3110 GST_EVENT_TYPE_NAME (event));
3112 switch (GST_EVENT_TYPE (event)) {
3117 GST_PAD_PREROLL_LOCK (pad);
3118 if (G_UNLIKELY (basesink->flushing))
3121 if (G_UNLIKELY (basesink->priv->received_eos)) {
3122 /* we can't accept anything when we are EOS */
3124 gst_event_unref (event);
3126 /* we set the received EOS flag here so that we can use it when testing if
3127 * we are prerolled and to refuse more buffers. */
3128 basesink->priv->received_eos = TRUE;
3130 /* EOS is a prerollable object, we call the unlocked version because it
3131 * does not check the received_eos flag. */
3132 ret = gst_base_sink_queue_object_unlocked (basesink, pad,
3133 FALSE, GST_MINI_OBJECT_CAST (event), TRUE);
3134 if (G_UNLIKELY (ret != GST_FLOW_OK))
3137 GST_PAD_PREROLL_UNLOCK (pad);
3140 case GST_EVENT_NEWSEGMENT:
3144 GST_DEBUG_OBJECT (basesink, "newsegment %p", event);
3146 GST_PAD_PREROLL_LOCK (pad);
3147 if (G_UNLIKELY (basesink->flushing))
3150 if (G_UNLIKELY (basesink->priv->received_eos)) {
3151 /* we can't accept anything when we are EOS */
3153 gst_event_unref (event);
3155 /* the new segment is a non prerollable item and does not block anything,
3156 * we need to configure the current clipping segment and insert the event
3157 * in the queue to serialize it with the buffers for rendering. */
3158 gst_base_sink_configure_segment (basesink, pad, event,
3159 basesink->abidata.ABI.clip_segment);
3162 gst_base_sink_queue_object_unlocked (basesink, pad,
3163 FALSE, GST_MINI_OBJECT_CAST (event), FALSE);
3164 if (G_UNLIKELY (ret != GST_FLOW_OK))
3167 GST_OBJECT_LOCK (basesink);
3168 basesink->have_newsegment = TRUE;
3169 GST_OBJECT_UNLOCK (basesink);
3172 GST_PAD_PREROLL_UNLOCK (pad);
3175 case GST_EVENT_FLUSH_START:
3177 bclass->event (basesink, event);
3179 GST_DEBUG_OBJECT (basesink, "flush-start %p", event);
3181 gst_base_sink_flush_start (basesink, pad);
3183 gst_event_unref (event);
3185 case GST_EVENT_FLUSH_STOP:
3187 bclass->event (basesink, event);
3189 GST_DEBUG_OBJECT (basesink, "flush-stop %p", event);
3191 gst_base_sink_flush_stop (basesink, pad);
3193 gst_event_unref (event);
3196 /* other events are sent to queue or subclass depending on if they
3197 * are serialized. */
3198 if (GST_EVENT_IS_SERIALIZED (event)) {
3199 gst_base_sink_queue_object (basesink, pad,
3200 GST_MINI_OBJECT_CAST (event), FALSE);
3203 bclass->event (basesink, event);
3204 gst_event_unref (event);
3209 gst_object_unref (basesink);
3216 GST_DEBUG_OBJECT (basesink, "we are flushing");
3217 GST_PAD_PREROLL_UNLOCK (pad);
3219 gst_event_unref (event);
3224 /* default implementation to calculate the start and end
3225 * timestamps on a buffer, subclasses can override
3228 gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
3229 GstClockTime * start, GstClockTime * end)
3231 GstClockTime timestamp, duration;
3233 timestamp = GST_BUFFER_TIMESTAMP (buffer);
3234 if (GST_CLOCK_TIME_IS_VALID (timestamp)) {
3236 /* get duration to calculate end time */
3237 duration = GST_BUFFER_DURATION (buffer);
3238 if (GST_CLOCK_TIME_IS_VALID (duration)) {
3239 *end = timestamp + duration;
3245 /* must be called with PREROLL_LOCK */
3247 gst_base_sink_needs_preroll (GstBaseSink * basesink)
3249 gboolean is_prerolled, res;
3251 /* we have 2 cases where the PREROLL_LOCK is released:
3252 * 1) we are blocking in the PREROLL_LOCK and thus are prerolled.
3253 * 2) we are syncing on the clock
3255 is_prerolled = basesink->have_preroll || basesink->priv->received_eos;
3256 res = !is_prerolled;
3258 GST_DEBUG_OBJECT (basesink, "have_preroll: %d, EOS: %d => needs preroll: %d",
3259 basesink->have_preroll, basesink->priv->received_eos, res);
3264 /* with STREAM_LOCK, PREROLL_LOCK
3266 * Takes a buffer and compare the timestamps with the last segment.
3267 * If the buffer falls outside of the segment boundaries, drop it.
3268 * Else queue the buffer for preroll and rendering.
3270 * This function takes ownership of the buffer.
3272 static GstFlowReturn
3273 gst_base_sink_chain_unlocked (GstBaseSink * basesink, GstPad * pad,
3274 gboolean is_list, gpointer obj)
3276 GstBaseSinkClass *bclass;
3277 GstFlowReturn result;
3278 GstClockTime start = GST_CLOCK_TIME_NONE, end = GST_CLOCK_TIME_NONE;
3279 GstSegment *clip_segment;
3280 GstBuffer *time_buf;
3282 if (G_UNLIKELY (basesink->flushing))
3285 if (G_UNLIKELY (basesink->priv->received_eos))
3289 time_buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0, 0);
3290 g_assert (NULL != time_buf);
3292 time_buf = GST_BUFFER_CAST (obj);
3295 /* for code clarity */
3296 clip_segment = basesink->abidata.ABI.clip_segment;
3298 if (G_UNLIKELY (!basesink->have_newsegment)) {
3301 sync = gst_base_sink_get_sync (basesink);
3303 GST_ELEMENT_WARNING (basesink, STREAM, FAILED,
3304 (_("Internal data flow problem.")),
3305 ("Received buffer without a new-segment. Assuming timestamps start from 0."));
3308 /* this means this sink will assume timestamps start from 0 */
3309 GST_OBJECT_LOCK (basesink);
3310 clip_segment->start = 0;
3311 clip_segment->stop = -1;
3312 basesink->segment.start = 0;
3313 basesink->segment.stop = -1;
3314 basesink->have_newsegment = TRUE;
3315 GST_OBJECT_UNLOCK (basesink);
3318 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3320 /* check if the buffer needs to be dropped, we first ask the subclass for the
3322 if (bclass->get_times)
3323 bclass->get_times (basesink, time_buf, &start, &end);
3325 if (!GST_CLOCK_TIME_IS_VALID (start)) {
3326 /* if the subclass does not want sync, we use our own values so that we at
3327 * least clip the buffer to the segment */
3328 gst_base_sink_get_times (basesink, time_buf, &start, &end);
3331 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
3332 ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (end));
3334 /* a dropped buffer does not participate in anything */
3335 if (GST_CLOCK_TIME_IS_VALID (start) &&
3336 (clip_segment->format == GST_FORMAT_TIME)) {
3337 if (G_UNLIKELY (!gst_segment_clip (clip_segment,
3338 GST_FORMAT_TIME, (gint64) start, (gint64) end, NULL, NULL)))
3339 goto out_of_segment;
3342 /* now we can process the buffer in the queue, this function takes ownership
3344 result = gst_base_sink_queue_object_unlocked (basesink, pad,
3345 is_list, obj, TRUE);
3351 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3352 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3353 return GST_FLOW_WRONG_STATE;
3357 GST_DEBUG_OBJECT (basesink,
3358 "we are EOS, dropping object, return UNEXPECTED");
3359 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3360 return GST_FLOW_UNEXPECTED;
3364 GST_DEBUG_OBJECT (basesink, "dropping buffer, out of clipping segment");
3365 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3372 static GstFlowReturn
3373 gst_base_sink_chain_main (GstBaseSink * basesink, GstPad * pad,
3374 gboolean is_list, gpointer obj)
3376 GstFlowReturn result;
3378 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH))
3381 GST_PAD_PREROLL_LOCK (pad);
3382 result = gst_base_sink_chain_unlocked (basesink, pad, is_list, obj);
3383 GST_PAD_PREROLL_UNLOCK (pad);
3391 GST_OBJECT_LOCK (pad);
3392 GST_WARNING_OBJECT (basesink,
3393 "Push on pad %s:%s, but it was not activated in push mode",
3394 GST_DEBUG_PAD_NAME (pad));
3395 GST_OBJECT_UNLOCK (pad);
3396 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3397 /* we don't post an error message this will signal to the peer
3398 * pushing that EOS is reached. */
3399 result = GST_FLOW_UNEXPECTED;
3404 static GstFlowReturn
3405 gst_base_sink_chain (GstPad * pad, GstBuffer * buf)
3407 GstBaseSink *basesink;
3409 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3411 return gst_base_sink_chain_main (basesink, pad, FALSE, buf);
3414 static GstFlowReturn
3415 gst_base_sink_chain_list (GstPad * pad, GstBufferList * list)
3417 GstBaseSink *basesink;
3418 GstBaseSinkClass *bclass;
3419 GstFlowReturn result;
3421 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3422 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3424 if (G_LIKELY (bclass->render_list)) {
3425 result = gst_base_sink_chain_main (basesink, pad, TRUE, list);
3427 GstBufferListIterator *it;
3430 GST_INFO_OBJECT (pad, "chaining each group in list as a merged buffer");
3432 it = gst_buffer_list_iterate (list);
3434 if (gst_buffer_list_iterator_next_group (it)) {
3436 group = gst_buffer_list_iterator_merge_group (it);
3437 if (group == NULL) {
3438 group = gst_buffer_new ();
3439 GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining empty group");
3441 GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining group");
3443 result = gst_base_sink_chain_main (basesink, pad, FALSE, group);
3444 } while (result == GST_FLOW_OK
3445 && gst_buffer_list_iterator_next_group (it));
3447 GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining empty group");
3449 gst_base_sink_chain_main (basesink, pad, FALSE, gst_buffer_new ());
3451 gst_buffer_list_iterator_free (it);
3452 gst_buffer_list_unref (list);
3459 gst_base_sink_default_do_seek (GstBaseSink * sink, GstSegment * segment)
3461 gboolean res = TRUE;
3463 /* update our offset if the start/stop position was updated */
3464 if (segment->format == GST_FORMAT_BYTES) {
3465 segment->time = segment->start;
3466 } else if (segment->start == 0) {
3467 /* seek to start, we can implement a default for this. */
3471 GST_INFO_OBJECT (sink, "Can't do a default seek");
3477 #define SEEK_TYPE_IS_RELATIVE(t) (((t) != GST_SEEK_TYPE_NONE) && ((t) != GST_SEEK_TYPE_SET))
3480 gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
3481 GstEvent * event, GstSegment * segment)
3483 /* By default, we try one of 2 things:
3484 * - For absolute seek positions, convert the requested position to our
3485 * configured processing format and place it in the output segment \
3486 * - For relative seek positions, convert our current (input) values to the
3487 * seek format, adjust by the relative seek offset and then convert back to
3488 * the processing format
3490 GstSeekType cur_type, stop_type;
3493 GstFormat seek_format, dest_format;
3496 gboolean res = TRUE;
3498 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3499 &cur_type, &cur, &stop_type, &stop);
3500 dest_format = segment->format;
3502 if (seek_format == dest_format) {
3503 gst_segment_set_seek (segment, rate, seek_format, flags,
3504 cur_type, cur, stop_type, stop, &update);
3508 if (cur_type != GST_SEEK_TYPE_NONE) {
3509 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3511 gst_pad_query_convert (sink->sinkpad, seek_format, cur, &dest_format,
3513 cur_type = GST_SEEK_TYPE_SET;
3516 if (res && stop_type != GST_SEEK_TYPE_NONE) {
3517 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3519 gst_pad_query_convert (sink->sinkpad, seek_format, stop, &dest_format,
3521 stop_type = GST_SEEK_TYPE_SET;
3524 /* And finally, configure our output segment in the desired format */
3525 gst_segment_set_seek (segment, rate, dest_format, flags, cur_type, cur,
3526 stop_type, stop, &update);
3535 GST_DEBUG_OBJECT (sink, "undefined format given, seek aborted.");
3540 /* perform a seek, only executed in pull mode */
3542 gst_base_sink_perform_seek (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3546 GstFormat seek_format, dest_format;
3548 GstSeekType cur_type, stop_type;
3549 gboolean seekseg_configured = FALSE;
3551 gboolean update, res = TRUE;
3552 GstSegment seeksegment;
3554 dest_format = sink->segment.format;
3557 GST_DEBUG_OBJECT (sink, "performing seek with event %p", event);
3558 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3559 &cur_type, &cur, &stop_type, &stop);
3561 flush = flags & GST_SEEK_FLAG_FLUSH;
3563 GST_DEBUG_OBJECT (sink, "performing seek without event");
3568 GST_DEBUG_OBJECT (sink, "flushing upstream");
3569 gst_pad_push_event (pad, gst_event_new_flush_start ());
3570 gst_base_sink_flush_start (sink, pad);
3572 GST_DEBUG_OBJECT (sink, "pausing pulling thread");
3575 GST_PAD_STREAM_LOCK (pad);
3577 /* If we configured the seeksegment above, don't overwrite it now. Otherwise
3578 * copy the current segment info into the temp segment that we can actually
3579 * attempt the seek with. We only update the real segment if the seek suceeds. */
3580 if (!seekseg_configured) {
3581 memcpy (&seeksegment, &sink->segment, sizeof (GstSegment));
3583 /* now configure the final seek segment */
3585 if (sink->segment.format != seek_format) {
3586 /* OK, here's where we give the subclass a chance to convert the relative
3587 * seek into an absolute one in the processing format. We set up any
3588 * absolute seek above, before taking the stream lock. */
3589 if (!gst_base_sink_default_prepare_seek_segment (sink, event,
3591 GST_DEBUG_OBJECT (sink,
3592 "Preparing the seek failed after flushing. " "Aborting seek");
3596 /* The seek format matches our processing format, no need to ask the
3597 * the subclass to configure the segment. */
3598 gst_segment_set_seek (&seeksegment, rate, seek_format, flags,
3599 cur_type, cur, stop_type, stop, &update);
3602 /* Else, no seek event passed, so we're just (re)starting the
3607 GST_DEBUG_OBJECT (sink, "segment configured from %" G_GINT64_FORMAT
3608 " to %" G_GINT64_FORMAT ", position %" G_GINT64_FORMAT,
3609 seeksegment.start, seeksegment.stop, seeksegment.last_stop);
3611 /* do the seek, segment.last_stop contains the new position. */
3612 res = gst_base_sink_default_do_seek (sink, &seeksegment);
3617 GST_DEBUG_OBJECT (sink, "stop flushing upstream");
3618 gst_pad_push_event (pad, gst_event_new_flush_stop ());
3619 gst_base_sink_flush_stop (sink, pad);
3620 } else if (res && sink->abidata.ABI.running) {
3621 /* we are running the current segment and doing a non-flushing seek,
3622 * close the segment first based on the last_stop. */
3623 GST_DEBUG_OBJECT (sink, "closing running segment %" G_GINT64_FORMAT
3624 " to %" G_GINT64_FORMAT, sink->segment.start, sink->segment.last_stop);
3627 /* The subclass must have converted the segment to the processing format
3629 if (res && seeksegment.format != dest_format) {
3630 GST_DEBUG_OBJECT (sink, "Subclass failed to prepare a seek segment "
3631 "in the correct format. Aborting seek.");
3635 /* if successfull seek, we update our real segment and push
3636 * out the new segment. */
3638 memcpy (&sink->segment, &seeksegment, sizeof (GstSegment));
3640 if (sink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3641 gst_element_post_message (GST_ELEMENT (sink),
3642 gst_message_new_segment_start (GST_OBJECT (sink),
3643 sink->segment.format, sink->segment.last_stop));
3647 sink->priv->discont = TRUE;
3648 sink->abidata.ABI.running = TRUE;
3650 GST_PAD_STREAM_UNLOCK (pad);
3656 set_step_info (GstBaseSink * sink, GstStepInfo * current, GstStepInfo * pending,
3657 guint seqnum, GstFormat format, guint64 amount, gdouble rate,
3658 gboolean flush, gboolean intermediate)
3660 GST_OBJECT_LOCK (sink);
3661 pending->seqnum = seqnum;
3662 pending->format = format;
3663 pending->amount = amount;
3664 pending->position = 0;
3665 pending->rate = rate;
3666 pending->flush = flush;
3667 pending->intermediate = intermediate;
3668 pending->valid = TRUE;
3669 /* flush invalidates the current stepping segment */
3671 current->valid = FALSE;
3672 GST_OBJECT_UNLOCK (sink);
3676 gst_base_sink_perform_step (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3678 GstBaseSinkPrivate *priv;
3679 GstBaseSinkClass *bclass;
3680 gboolean flush, intermediate;
3685 GstStepInfo *pending, *current;
3686 GstMessage *message;
3688 bclass = GST_BASE_SINK_GET_CLASS (sink);
3691 GST_DEBUG_OBJECT (sink, "performing step with event %p", event);
3693 gst_event_parse_step (event, &format, &amount, &rate, &flush, &intermediate);
3694 seqnum = gst_event_get_seqnum (event);
3696 pending = &priv->pending_step;
3697 current = &priv->current_step;
3699 /* post message first */
3700 message = gst_message_new_step_start (GST_OBJECT (sink), FALSE, format,
3701 amount, rate, flush, intermediate);
3702 gst_message_set_seqnum (message, seqnum);
3703 gst_element_post_message (GST_ELEMENT (sink), message);
3706 /* we need to call ::unlock before locking PREROLL_LOCK
3707 * since we lock it before going into ::render */
3709 bclass->unlock (sink);
3711 GST_PAD_PREROLL_LOCK (sink->sinkpad);
3712 /* now that we have the PREROLL lock, clear our unlock request */
3713 if (bclass->unlock_stop)
3714 bclass->unlock_stop (sink);
3716 /* update the stepinfo and make it valid */
3717 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3720 if (sink->priv->async_enabled) {
3721 /* and we need to commit our state again on the next
3722 * prerolled buffer */
3723 sink->playing_async = TRUE;
3724 priv->pending_step.need_preroll = TRUE;
3725 sink->need_preroll = FALSE;
3726 gst_element_lost_state_full (GST_ELEMENT_CAST (sink), FALSE);
3728 sink->priv->have_latency = TRUE;
3729 sink->need_preroll = FALSE;
3731 priv->current_sstart = GST_CLOCK_TIME_NONE;
3732 priv->current_sstop = GST_CLOCK_TIME_NONE;
3733 priv->eos_rtime = GST_CLOCK_TIME_NONE;
3734 priv->call_preroll = TRUE;
3735 gst_base_sink_set_last_buffer (sink, NULL);
3736 gst_base_sink_reset_qos (sink);
3738 if (sink->clock_id) {
3739 gst_clock_id_unschedule (sink->clock_id);
3742 if (sink->have_preroll) {
3743 GST_DEBUG_OBJECT (sink, "signal waiter");
3744 priv->step_unlock = TRUE;
3745 GST_PAD_PREROLL_SIGNAL (sink->sinkpad);
3747 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
3749 /* update the stepinfo and make it valid */
3750 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3760 gst_base_sink_loop (GstPad * pad)
3762 GstBaseSink *basesink;
3763 GstBuffer *buf = NULL;
3764 GstFlowReturn result;
3768 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3770 g_assert (basesink->pad_mode == GST_ACTIVATE_PULL);
3772 if ((blocksize = basesink->priv->blocksize) == 0)
3775 offset = basesink->segment.last_stop;
3777 GST_DEBUG_OBJECT (basesink, "pulling %" G_GUINT64_FORMAT ", %u",
3780 result = gst_pad_pull_range (pad, offset, blocksize, &buf);
3781 if (G_UNLIKELY (result != GST_FLOW_OK))
3784 if (G_UNLIKELY (buf == NULL))
3787 offset += GST_BUFFER_SIZE (buf);
3789 gst_segment_set_last_stop (&basesink->segment, GST_FORMAT_BYTES, offset);
3791 GST_PAD_PREROLL_LOCK (pad);
3792 result = gst_base_sink_chain_unlocked (basesink, pad, FALSE, buf);
3793 GST_PAD_PREROLL_UNLOCK (pad);
3794 if (G_UNLIKELY (result != GST_FLOW_OK))
3802 GST_LOG_OBJECT (basesink, "pausing task, reason %s",
3803 gst_flow_get_name (result));
3804 gst_pad_pause_task (pad);
3805 /* fatal errors and NOT_LINKED cause EOS */
3806 if (GST_FLOW_IS_FATAL (result) || result == GST_FLOW_NOT_LINKED) {
3807 if (result == GST_FLOW_UNEXPECTED) {
3808 /* perform EOS logic */
3809 if (basesink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3810 gst_element_post_message (GST_ELEMENT_CAST (basesink),
3811 gst_message_new_segment_done (GST_OBJECT_CAST (basesink),
3812 basesink->segment.format, basesink->segment.last_stop));
3814 gst_base_sink_event (pad, gst_event_new_eos ());
3817 /* for fatal errors we post an error message, post the error
3818 * first so the app knows about the error first. */
3819 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
3820 (_("Internal data stream error.")),
3821 ("stream stopped, reason %s", gst_flow_get_name (result)));
3822 gst_base_sink_event (pad, gst_event_new_eos ());
3829 GST_LOG_OBJECT (basesink, "no buffer, pausing");
3830 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
3831 (_("Internal data flow error.")), ("element returned NULL buffer"));
3832 result = GST_FLOW_ERROR;
3838 gst_base_sink_set_flushing (GstBaseSink * basesink, GstPad * pad,
3841 GstBaseSinkClass *bclass;
3843 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3846 /* unlock any subclasses, we need to do this before grabbing the
3847 * PREROLL_LOCK since we hold this lock before going into ::render. */
3849 bclass->unlock (basesink);
3852 GST_PAD_PREROLL_LOCK (pad);
3853 basesink->flushing = flushing;
3855 /* step 1, now that we have the PREROLL lock, clear our unlock request */
3856 if (bclass->unlock_stop)
3857 bclass->unlock_stop (basesink);
3859 /* set need_preroll before we unblock the clock. If the clock is unblocked
3860 * before timing out, we can reuse the buffer for preroll. */
3861 basesink->need_preroll = TRUE;
3863 /* step 2, unblock clock sync (if any) or any other blocking thing */
3864 if (basesink->clock_id) {
3865 gst_clock_id_unschedule (basesink->clock_id);
3868 /* flush out the data thread if it's locked in finish_preroll, this will
3869 * also flush out the EOS state */
3870 GST_DEBUG_OBJECT (basesink,
3871 "flushing out data thread, need preroll to TRUE");
3872 gst_base_sink_preroll_queue_flush (basesink, pad);
3874 GST_PAD_PREROLL_UNLOCK (pad);
3880 gst_base_sink_default_activate_pull (GstBaseSink * basesink, gboolean active)
3886 result = gst_pad_start_task (basesink->sinkpad,
3887 (GstTaskFunction) gst_base_sink_loop, basesink->sinkpad);
3889 /* step 2, make sure streaming finishes */
3890 result = gst_pad_stop_task (basesink->sinkpad);
3897 gst_base_sink_pad_activate (GstPad * pad)
3899 gboolean result = FALSE;
3900 GstBaseSink *basesink;
3902 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3904 GST_DEBUG_OBJECT (basesink, "Trying pull mode first");
3906 gst_base_sink_set_flushing (basesink, pad, FALSE);
3908 /* we need to have the pull mode enabled */
3909 if (!basesink->can_activate_pull) {
3910 GST_DEBUG_OBJECT (basesink, "pull mode disabled");
3914 /* check if downstreams supports pull mode at all */
3915 if (!gst_pad_check_pull_range (pad)) {
3916 GST_DEBUG_OBJECT (basesink, "pull mode not supported");
3920 /* set the pad mode before starting the task so that it's in the
3921 * correct state for the new thread. also the sink set_caps and get_caps
3922 * function checks this */
3923 basesink->pad_mode = GST_ACTIVATE_PULL;
3925 /* we first try to negotiate a format so that when we try to activate
3926 * downstream, it knows about our format */
3927 if (!gst_base_sink_negotiate_pull (basesink)) {
3928 GST_DEBUG_OBJECT (basesink, "failed to negotiate in pull mode");
3932 /* ok activate now */
3933 if (!gst_pad_activate_pull (pad, TRUE)) {
3934 /* clear any pending caps */
3935 GST_OBJECT_LOCK (basesink);
3936 gst_caps_replace (&basesink->priv->pull_caps, NULL);
3937 GST_OBJECT_UNLOCK (basesink);
3938 GST_DEBUG_OBJECT (basesink, "failed to activate in pull mode");
3942 GST_DEBUG_OBJECT (basesink, "Success activating pull mode");
3946 /* push mode fallback */
3948 GST_DEBUG_OBJECT (basesink, "Falling back to push mode");
3949 if ((result = gst_pad_activate_push (pad, TRUE))) {
3950 GST_DEBUG_OBJECT (basesink, "Success activating push mode");
3955 GST_WARNING_OBJECT (basesink, "Could not activate pad in either mode");
3956 gst_base_sink_set_flushing (basesink, pad, TRUE);
3959 gst_object_unref (basesink);
3965 gst_base_sink_pad_activate_push (GstPad * pad, gboolean active)
3968 GstBaseSink *basesink;
3970 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3973 if (!basesink->can_activate_push) {
3975 basesink->pad_mode = GST_ACTIVATE_NONE;
3978 basesink->pad_mode = GST_ACTIVATE_PUSH;
3981 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH)) {
3982 g_warning ("Internal GStreamer activation error!!!");
3985 gst_base_sink_set_flushing (basesink, pad, TRUE);
3987 basesink->pad_mode = GST_ACTIVATE_NONE;
3991 gst_object_unref (basesink);
3997 gst_base_sink_negotiate_pull (GstBaseSink * basesink)
4004 /* this returns the intersection between our caps and the peer caps. If there
4005 * is no peer, it returns NULL and we can't operate in pull mode so we can
4006 * fail the negotiation. */
4007 caps = gst_pad_get_allowed_caps (GST_BASE_SINK_PAD (basesink));
4008 if (caps == NULL || gst_caps_is_empty (caps))
4009 goto no_caps_possible;
4011 GST_DEBUG_OBJECT (basesink, "allowed caps: %" GST_PTR_FORMAT, caps);
4013 caps = gst_caps_make_writable (caps);
4014 /* get the first (prefered) format */
4015 gst_caps_truncate (caps);
4017 gst_pad_fixate_caps (GST_BASE_SINK_PAD (basesink), caps);
4019 GST_DEBUG_OBJECT (basesink, "fixated to: %" GST_PTR_FORMAT, caps);
4021 if (gst_caps_is_any (caps)) {
4022 GST_DEBUG_OBJECT (basesink, "caps were ANY after fixating, "
4024 /* neither side has template caps in this case, so they are prepared for
4025 pull() without setcaps() */
4027 } else if (gst_caps_is_fixed (caps)) {
4028 if (!gst_pad_set_caps (GST_BASE_SINK_PAD (basesink), caps))
4029 goto could_not_set_caps;
4031 GST_OBJECT_LOCK (basesink);
4032 gst_caps_replace (&basesink->priv->pull_caps, caps);
4033 GST_OBJECT_UNLOCK (basesink);
4038 gst_caps_unref (caps);
4044 GST_INFO_OBJECT (basesink, "Pipeline could not agree on caps");
4045 GST_DEBUG_OBJECT (basesink, "get_allowed_caps() returned EMPTY");
4047 gst_caps_unref (caps);
4052 GST_INFO_OBJECT (basesink, "Could not set caps: %" GST_PTR_FORMAT, caps);
4053 gst_caps_unref (caps);
4058 /* this won't get called until we implement an activate function */
4060 gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active)
4062 gboolean result = FALSE;
4063 GstBaseSink *basesink;
4064 GstBaseSinkClass *bclass;
4066 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4067 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4073 /* we mark we have a newsegment here because pull based
4074 * mode works just fine without having a newsegment before the
4076 format = GST_FORMAT_BYTES;
4078 gst_segment_init (&basesink->segment, format);
4079 gst_segment_init (basesink->abidata.ABI.clip_segment, format);
4080 GST_OBJECT_LOCK (basesink);
4081 basesink->have_newsegment = TRUE;
4082 GST_OBJECT_UNLOCK (basesink);
4084 /* get the peer duration in bytes */
4085 result = gst_pad_query_peer_duration (pad, &format, &duration);
4087 GST_DEBUG_OBJECT (basesink,
4088 "setting duration in bytes to %" G_GINT64_FORMAT, duration);
4089 gst_segment_set_duration (basesink->abidata.ABI.clip_segment, format,
4091 gst_segment_set_duration (&basesink->segment, format, duration);
4093 GST_DEBUG_OBJECT (basesink, "unknown duration");
4096 if (bclass->activate_pull)
4097 result = bclass->activate_pull (basesink, TRUE);
4102 goto activate_failed;
4105 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PULL)) {
4106 g_warning ("Internal GStreamer activation error!!!");
4109 result = gst_base_sink_set_flushing (basesink, pad, TRUE);
4110 if (bclass->activate_pull)
4111 result &= bclass->activate_pull (basesink, FALSE);
4112 basesink->pad_mode = GST_ACTIVATE_NONE;
4113 /* clear any pending caps */
4114 GST_OBJECT_LOCK (basesink);
4115 gst_caps_replace (&basesink->priv->pull_caps, NULL);
4116 GST_OBJECT_UNLOCK (basesink);
4119 gst_object_unref (basesink);
4126 /* reset, as starting the thread failed */
4127 basesink->pad_mode = GST_ACTIVATE_NONE;
4129 GST_ERROR_OBJECT (basesink, "subclass failed to activate in pull mode");
4134 /* send an event to our sinkpad peer. */
4136 gst_base_sink_send_event (GstElement * element, GstEvent * event)
4139 GstBaseSink *basesink = GST_BASE_SINK (element);
4140 gboolean forward, result = TRUE;
4141 GstActivateMode mode;
4143 GST_OBJECT_LOCK (element);
4144 /* get the pad and the scheduling mode */
4145 pad = gst_object_ref (basesink->sinkpad);
4146 mode = basesink->pad_mode;
4147 GST_OBJECT_UNLOCK (element);
4149 /* only push UPSTREAM events upstream */
4150 forward = GST_EVENT_IS_UPSTREAM (event);
4152 switch (GST_EVENT_TYPE (event)) {
4153 case GST_EVENT_LATENCY:
4155 GstClockTime latency;
4157 gst_event_parse_latency (event, &latency);
4159 /* store the latency. We use this to adjust the running_time before syncing
4160 * it to the clock. */
4161 GST_OBJECT_LOCK (element);
4162 basesink->priv->latency = latency;
4163 if (!basesink->priv->have_latency)
4165 GST_OBJECT_UNLOCK (element);
4166 GST_DEBUG_OBJECT (basesink, "latency set to %" GST_TIME_FORMAT,
4167 GST_TIME_ARGS (latency));
4169 /* We forward this event so that all elements know about the global pipeline
4170 * latency. This is interesting for an element when it wants to figure out
4171 * when a particular piece of data will be rendered. */
4174 case GST_EVENT_SEEK:
4175 /* in pull mode we will execute the seek */
4176 if (mode == GST_ACTIVATE_PULL)
4177 result = gst_base_sink_perform_seek (basesink, pad, event);
4179 case GST_EVENT_STEP:
4180 result = gst_base_sink_perform_step (basesink, pad, event);
4188 result = gst_pad_push_event (pad, event);
4190 /* not forwarded, unref the event */
4191 gst_event_unref (event);
4194 gst_object_unref (pad);
4199 gst_base_sink_peer_query (GstBaseSink * sink, GstQuery * query)
4202 gboolean res = FALSE;
4204 if ((peer = gst_pad_get_peer (sink->sinkpad))) {
4205 res = gst_pad_query (peer, query);
4206 gst_object_unref (peer);
4211 /* get the end position of the last seen object, this is used
4212 * for EOS and for making sure that we don't report a position we
4213 * have not reached yet. With LOCK. */
4215 gst_base_sink_get_position_last (GstBaseSink * basesink, GstFormat format,
4216 gint64 * cur, gboolean * upstream)
4219 GstSegment *segment;
4220 gboolean ret = TRUE;
4222 segment = &basesink->segment;
4223 oformat = segment->format;
4225 if (oformat == GST_FORMAT_TIME) {
4226 /* return last observed stream time, we keep the stream time around in the
4228 *cur = basesink->priv->current_sstop;
4230 /* convert last stop to stream time */
4231 *cur = gst_segment_to_stream_time (segment, oformat, segment->last_stop);
4234 if (*cur != -1 && oformat != format) {
4235 GST_OBJECT_UNLOCK (basesink);
4236 /* convert to the target format if we need to, release lock first */
4238 gst_pad_query_convert (basesink->sinkpad, oformat, *cur, &format, cur);
4243 GST_OBJECT_LOCK (basesink);
4246 GST_DEBUG_OBJECT (basesink, "POSITION: %" GST_TIME_FORMAT,
4247 GST_TIME_ARGS (*cur));
4252 /* get the position when we are PAUSED, this is the stream time of the buffer
4253 * that prerolled. If no buffer is prerolled (we are still flushing), this
4254 * value will be -1. With LOCK. */
4256 gst_base_sink_get_position_paused (GstBaseSink * basesink, GstFormat format,
4257 gint64 * cur, gboolean * upstream)
4261 GstSegment *segment;
4264 /* we don't use the clip segment in pull mode, when seeking we update the
4265 * main segment directly with the new segment values without it having to be
4266 * activated by the rendering after preroll */
4267 if (basesink->pad_mode == GST_ACTIVATE_PUSH)
4268 segment = basesink->abidata.ABI.clip_segment;
4270 segment = &basesink->segment;
4271 oformat = segment->format;
4273 if (oformat == GST_FORMAT_TIME) {
4274 *cur = basesink->priv->current_sstart;
4275 if (segment->rate < 0.0 &&
4276 GST_CLOCK_TIME_IS_VALID (basesink->priv->current_sstop)) {
4277 /* for reverse playback we prefer the stream time stop position if we have
4279 *cur = basesink->priv->current_sstop;
4282 *cur = gst_segment_to_stream_time (segment, oformat, segment->last_stop);
4285 time = segment->time;
4288 *cur = MAX (*cur, time);
4289 GST_DEBUG_OBJECT (basesink, "POSITION as max: %" GST_TIME_FORMAT
4290 ", time %" GST_TIME_FORMAT, GST_TIME_ARGS (*cur), GST_TIME_ARGS (time));
4292 /* we have no buffer, use the segment times. */
4293 if (segment->rate >= 0.0) {
4294 /* forward, next position is always the time of the segment */
4296 GST_DEBUG_OBJECT (basesink, "POSITION as time: %" GST_TIME_FORMAT,
4297 GST_TIME_ARGS (*cur));
4299 /* reverse, next expected timestamp is segment->stop. We use the function
4300 * to get things right for negative applied_rates. */
4301 *cur = gst_segment_to_stream_time (segment, oformat, segment->stop);
4302 GST_DEBUG_OBJECT (basesink, "reverse POSITION: %" GST_TIME_FORMAT,
4303 GST_TIME_ARGS (*cur));
4308 if (res && oformat != format) {
4309 GST_OBJECT_UNLOCK (basesink);
4311 gst_pad_query_convert (basesink->sinkpad, oformat, *cur, &format, cur);
4316 GST_OBJECT_LOCK (basesink);
4323 gst_base_sink_get_position (GstBaseSink * basesink, GstFormat format,
4324 gint64 * cur, gboolean * upstream)
4327 gboolean res = FALSE;
4328 GstFormat oformat, tformat;
4329 GstClockTime now, latency;
4330 GstClockTimeDiff base;
4331 gint64 time, accum, duration;
4335 GST_OBJECT_LOCK (basesink);
4336 /* our intermediate time format */
4337 tformat = GST_FORMAT_TIME;
4338 /* get the format in the segment */
4339 oformat = basesink->segment.format;
4341 /* can only give answer based on the clock if not EOS */
4342 if (G_UNLIKELY (basesink->eos))
4345 /* we can only get the segment when we are not NULL or READY */
4346 if (!basesink->have_newsegment)
4349 /* when not in PLAYING or when we're busy with a state change, we
4350 * cannot read from the clock so we report time based on the
4351 * last seen timestamp. */
4352 if (GST_STATE (basesink) != GST_STATE_PLAYING ||
4353 GST_STATE_PENDING (basesink) != GST_STATE_VOID_PENDING)
4356 /* we need to sync on the clock. */
4357 if (basesink->sync == FALSE)
4360 /* and we need a clock */
4361 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (basesink)) == NULL))
4364 /* collect all data we need holding the lock */
4365 if (GST_CLOCK_TIME_IS_VALID (basesink->segment.time))
4366 time = basesink->segment.time;
4370 if (GST_CLOCK_TIME_IS_VALID (basesink->segment.stop))
4371 duration = basesink->segment.stop - basesink->segment.start;
4375 base = GST_ELEMENT_CAST (basesink)->base_time;
4376 accum = basesink->segment.accum;
4377 rate = basesink->segment.rate * basesink->segment.applied_rate;
4378 latency = basesink->priv->latency;
4380 gst_object_ref (clock);
4382 /* this function might release the LOCK */
4383 gst_base_sink_get_position_last (basesink, format, &last, upstream);
4385 /* need to release the object lock before we can get the time,
4386 * a clock might take the LOCK of the provider, which could be
4387 * a basesink subclass. */
4388 GST_OBJECT_UNLOCK (basesink);
4390 now = gst_clock_get_time (clock);
4392 if (oformat != tformat) {
4393 /* convert accum, time and duration to time */
4394 if (!gst_pad_query_convert (basesink->sinkpad, oformat, accum, &tformat,
4396 goto convert_failed;
4397 if (!gst_pad_query_convert (basesink->sinkpad, oformat, duration, &tformat,
4399 goto convert_failed;
4400 if (!gst_pad_query_convert (basesink->sinkpad, oformat, time, &tformat,
4402 goto convert_failed;
4405 /* subtract base time and accumulated time from the clock time.
4406 * Make sure we don't go negative. This is the current time in
4407 * the segment which we need to scale with the combined
4408 * rate and applied rate. */
4411 if (GST_CLOCK_DIFF (base, now) < 0)
4414 /* for negative rates we need to count back from the segment
4419 *cur = time + gst_guint64_to_gdouble (now - base) * rate;
4421 /* never report more than last seen position */
4423 *cur = MIN (last, *cur);
4425 gst_object_unref (clock);
4427 GST_DEBUG_OBJECT (basesink,
4428 "now %" GST_TIME_FORMAT " - base %" GST_TIME_FORMAT " - accum %"
4429 GST_TIME_FORMAT " + time %" GST_TIME_FORMAT,
4430 GST_TIME_ARGS (now), GST_TIME_ARGS (base),
4431 GST_TIME_ARGS (accum), GST_TIME_ARGS (time));
4433 if (oformat != format) {
4434 /* convert time to final format */
4435 if (!gst_pad_query_convert (basesink->sinkpad, tformat, *cur, &format, cur))
4436 goto convert_failed;
4442 GST_DEBUG_OBJECT (basesink, "res: %d, POSITION: %" GST_TIME_FORMAT,
4443 res, GST_TIME_ARGS (*cur));
4449 GST_DEBUG_OBJECT (basesink, "position in EOS");
4450 res = gst_base_sink_get_position_last (basesink, format, cur, upstream);
4451 GST_OBJECT_UNLOCK (basesink);
4456 GST_DEBUG_OBJECT (basesink, "position in PAUSED");
4457 res = gst_base_sink_get_position_paused (basesink, format, cur, upstream);
4458 GST_OBJECT_UNLOCK (basesink);
4463 /* in NULL or READY we always return FALSE and -1 */
4464 GST_DEBUG_OBJECT (basesink, "position in wrong state, return -1");
4467 GST_OBJECT_UNLOCK (basesink);
4472 /* report last seen timestamp if any, else ask upstream to answer */
4473 if ((*cur = basesink->priv->current_sstart) != -1)
4478 GST_DEBUG_OBJECT (basesink, "no sync, res %d, POSITION %" GST_TIME_FORMAT,
4479 res, GST_TIME_ARGS (*cur));
4480 GST_OBJECT_UNLOCK (basesink);
4485 GST_DEBUG_OBJECT (basesink, "convert failed, try upstream");
4492 gst_base_sink_query (GstElement * element, GstQuery * query)
4494 gboolean res = FALSE;
4496 GstBaseSink *basesink = GST_BASE_SINK (element);
4498 switch (GST_QUERY_TYPE (query)) {
4499 case GST_QUERY_POSITION:
4503 gboolean upstream = FALSE;
4505 gst_query_parse_position (query, &format, NULL);
4507 GST_DEBUG_OBJECT (basesink, "position format %d", format);
4509 /* first try to get the position based on the clock */
4511 gst_base_sink_get_position (basesink, format, &cur, &upstream))) {
4512 gst_query_set_position (query, format, cur);
4513 } else if (upstream) {
4514 /* fallback to peer query */
4515 res = gst_base_sink_peer_query (basesink, query);
4519 case GST_QUERY_DURATION:
4521 GstFormat format, uformat;
4522 gint64 duration, uduration;
4524 gst_query_parse_duration (query, &format, NULL);
4526 GST_DEBUG_OBJECT (basesink, "duration query in format %s",
4527 gst_format_get_name (format));
4529 if (basesink->pad_mode == GST_ACTIVATE_PULL) {
4530 uformat = GST_FORMAT_BYTES;
4532 /* get the duration in bytes, in pull mode that's all we are sure to
4533 * know. We have to explicitly get this value from upstream instead of
4534 * using our cached value because it might change. Duration caching
4535 * should be done at a higher level. */
4536 res = gst_pad_query_peer_duration (basesink->sinkpad, &uformat,
4539 gst_segment_set_duration (&basesink->segment, uformat, uduration);
4540 if (format != uformat) {
4541 /* convert to the requested format */
4542 res = gst_pad_query_convert (basesink->sinkpad, uformat, uduration,
4543 &format, &duration);
4545 duration = uduration;
4548 /* set the result */
4549 gst_query_set_duration (query, format, duration);
4553 /* in push mode we simply forward upstream */
4554 res = gst_base_sink_peer_query (basesink, query);
4558 case GST_QUERY_LATENCY:
4560 gboolean live, us_live;
4561 GstClockTime min, max;
4563 if ((res = gst_base_sink_query_latency (basesink, &live, &us_live, &min,
4565 gst_query_set_latency (query, live, min, max);
4569 case GST_QUERY_JITTER:
4571 case GST_QUERY_RATE:
4572 /* gst_query_set_rate (query, basesink->segment_rate); */
4575 case GST_QUERY_SEGMENT:
4577 /* FIXME, bring start/stop to stream time */
4578 gst_query_set_segment (query, basesink->segment.rate,
4579 GST_FORMAT_TIME, basesink->segment.start, basesink->segment.stop);
4582 case GST_QUERY_SEEKING:
4583 case GST_QUERY_CONVERT:
4584 case GST_QUERY_FORMATS:
4586 res = gst_base_sink_peer_query (basesink, query);
4592 static GstStateChangeReturn
4593 gst_base_sink_change_state (GstElement * element, GstStateChange transition)
4595 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
4596 GstBaseSink *basesink = GST_BASE_SINK (element);
4597 GstBaseSinkClass *bclass;
4598 GstBaseSinkPrivate *priv;
4600 priv = basesink->priv;
4602 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4604 switch (transition) {
4605 case GST_STATE_CHANGE_NULL_TO_READY:
4607 if (!bclass->start (basesink))
4610 case GST_STATE_CHANGE_READY_TO_PAUSED:
4611 /* need to complete preroll before this state change completes, there
4612 * is no data flow in READY so we can safely assume we need to preroll. */
4613 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4614 GST_DEBUG_OBJECT (basesink, "READY to PAUSED");
4615 basesink->have_newsegment = FALSE;
4616 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
4617 gst_segment_init (basesink->abidata.ABI.clip_segment,
4618 GST_FORMAT_UNDEFINED);
4619 basesink->offset = 0;
4620 basesink->have_preroll = FALSE;
4621 priv->step_unlock = FALSE;
4622 basesink->need_preroll = TRUE;
4623 basesink->playing_async = TRUE;
4624 priv->current_sstart = GST_CLOCK_TIME_NONE;
4625 priv->current_sstop = GST_CLOCK_TIME_NONE;
4626 priv->eos_rtime = GST_CLOCK_TIME_NONE;
4628 basesink->eos = FALSE;
4629 priv->received_eos = FALSE;
4630 gst_base_sink_reset_qos (basesink);
4631 priv->commited = FALSE;
4632 priv->call_preroll = TRUE;
4633 priv->current_step.valid = FALSE;
4634 priv->pending_step.valid = FALSE;
4635 if (priv->async_enabled) {
4636 GST_DEBUG_OBJECT (basesink, "doing async state change");
4637 /* when async enabled, post async-start message and return ASYNC from
4638 * the state change function */
4639 ret = GST_STATE_CHANGE_ASYNC;
4640 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4641 gst_message_new_async_start (GST_OBJECT_CAST (basesink), FALSE));
4643 priv->have_latency = TRUE;
4645 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4647 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
4648 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4649 if (!gst_base_sink_needs_preroll (basesink)) {
4650 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, don't need preroll");
4651 /* no preroll needed anymore now. */
4652 basesink->playing_async = FALSE;
4653 basesink->need_preroll = FALSE;
4654 if (basesink->eos) {
4655 GstMessage *message;
4657 /* need to post EOS message here */
4658 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
4659 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
4660 gst_message_set_seqnum (message, basesink->priv->seqnum);
4661 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
4663 GST_DEBUG_OBJECT (basesink, "signal preroll");
4664 GST_PAD_PREROLL_SIGNAL (basesink->sinkpad);
4667 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, we are not prerolled");
4668 basesink->need_preroll = TRUE;
4669 basesink->playing_async = TRUE;
4670 priv->call_preroll = TRUE;
4671 priv->commited = FALSE;
4672 if (priv->async_enabled) {
4673 GST_DEBUG_OBJECT (basesink, "doing async state change");
4674 ret = GST_STATE_CHANGE_ASYNC;
4675 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4676 gst_message_new_async_start (GST_OBJECT_CAST (basesink), FALSE));
4679 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4686 GstStateChangeReturn bret;
4688 bret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
4689 if (G_UNLIKELY (bret == GST_STATE_CHANGE_FAILURE))
4690 goto activate_failed;
4693 switch (transition) {
4694 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
4695 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED");
4696 /* FIXME, make sure we cannot enter _render first */
4698 /* we need to call ::unlock before locking PREROLL_LOCK
4699 * since we lock it before going into ::render */
4701 bclass->unlock (basesink);
4703 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4704 GST_DEBUG_OBJECT (basesink, "got preroll lock");
4705 /* now that we have the PREROLL lock, clear our unlock request */
4706 if (bclass->unlock_stop)
4707 bclass->unlock_stop (basesink);
4709 /* we need preroll again and we set the flag before unlocking the clockid
4710 * because if the clockid is unlocked before a current buffer expired, we
4711 * can use that buffer to preroll with */
4712 basesink->need_preroll = TRUE;
4714 if (basesink->clock_id) {
4715 GST_DEBUG_OBJECT (basesink, "unschedule clock");
4716 gst_clock_id_unschedule (basesink->clock_id);
4719 /* if we don't have a preroll buffer we need to wait for a preroll and
4721 if (!gst_base_sink_needs_preroll (basesink)) {
4722 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED, we are prerolled");
4723 basesink->playing_async = FALSE;
4725 if (GST_STATE_TARGET (GST_ELEMENT (basesink)) <= GST_STATE_READY) {
4726 GST_DEBUG_OBJECT (basesink, "element is <= READY");
4727 ret = GST_STATE_CHANGE_SUCCESS;
4729 GST_DEBUG_OBJECT (basesink,
4730 "PLAYING to PAUSED, we are not prerolled");
4731 basesink->playing_async = TRUE;
4732 priv->commited = FALSE;
4733 priv->call_preroll = TRUE;
4734 if (priv->async_enabled) {
4735 GST_DEBUG_OBJECT (basesink, "doing async state change");
4736 ret = GST_STATE_CHANGE_ASYNC;
4737 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4738 gst_message_new_async_start (GST_OBJECT_CAST (basesink),
4743 GST_DEBUG_OBJECT (basesink, "rendered: %" G_GUINT64_FORMAT
4744 ", dropped: %" G_GUINT64_FORMAT, priv->rendered, priv->dropped);
4746 gst_base_sink_reset_qos (basesink);
4747 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4749 case GST_STATE_CHANGE_PAUSED_TO_READY:
4750 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
4751 /* start by reseting our position state with the object lock so that the
4752 * position query gets the right idea. We do this before we post the
4753 * messages so that the message handlers pick this up. */
4754 GST_OBJECT_LOCK (basesink);
4755 basesink->have_newsegment = FALSE;
4756 priv->current_sstart = GST_CLOCK_TIME_NONE;
4757 priv->current_sstop = GST_CLOCK_TIME_NONE;
4758 priv->have_latency = FALSE;
4759 GST_OBJECT_UNLOCK (basesink);
4761 gst_base_sink_set_last_buffer (basesink, NULL);
4762 priv->call_preroll = FALSE;
4764 if (!priv->commited) {
4765 if (priv->async_enabled) {
4766 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, posting async-done");
4768 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4769 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
4770 GST_STATE_PLAYING, GST_STATE_PAUSED, GST_STATE_READY));
4772 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4773 gst_message_new_async_done (GST_OBJECT_CAST (basesink)));
4775 priv->commited = TRUE;
4777 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, don't need_preroll");
4779 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
4781 case GST_STATE_CHANGE_READY_TO_NULL:
4783 if (!bclass->stop (basesink)) {
4784 GST_WARNING_OBJECT (basesink, "failed to stop");
4787 gst_base_sink_set_last_buffer (basesink, NULL);
4788 priv->call_preroll = FALSE;
4799 GST_DEBUG_OBJECT (basesink, "failed to start");
4800 return GST_STATE_CHANGE_FAILURE;
4804 GST_DEBUG_OBJECT (basesink,
4805 "element failed to change states -- activation problem?");
4806 return GST_STATE_CHANGE_FAILURE;