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 /* FIXME 0.11: suppress warnings for deprecated API such as GStaticRecMutex
150 * with newer GLib versions (>= 2.31.0) */
151 #define GLIB_DISABLE_DEPRECATION_WARNINGS
152 #include <gst/gst_private.h>
154 #include "gstbasesink.h"
155 #include <gst/gstmarshal.h>
156 #include <gst/gst-i18n-lib.h>
158 GST_DEBUG_CATEGORY_STATIC (gst_base_sink_debug);
159 #define GST_CAT_DEFAULT gst_base_sink_debug
161 #define GST_BASE_SINK_GET_PRIVATE(obj) \
162 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_BASE_SINK, GstBaseSinkPrivate))
164 #define GST_FLOW_STEP GST_FLOW_CUSTOM_ERROR
168 gboolean valid; /* if this info is valid */
169 guint32 seqnum; /* the seqnum of the STEP event */
170 GstFormat format; /* the format of the amount */
171 guint64 amount; /* the total amount of data to skip */
172 guint64 position; /* the position in the stepped data */
173 guint64 duration; /* the duration in time of the skipped data */
174 guint64 start; /* running_time of the start */
175 gdouble rate; /* rate of skipping */
176 gdouble start_rate; /* rate before skipping */
177 guint64 start_start; /* start position skipping */
178 guint64 start_stop; /* stop position skipping */
179 gboolean flush; /* if this was a flushing step */
180 gboolean intermediate; /* if this is an intermediate step */
181 gboolean need_preroll; /* if we need preroll after this step */
184 /* FIXME, some stuff in ABI.data and other in Private...
185 * Make up your mind please.
187 struct _GstBaseSinkPrivate
189 gint qos_enabled; /* ATOMIC */
190 gboolean async_enabled;
191 GstClockTimeDiff ts_offset;
192 GstClockTime render_delay;
194 /* start, stop of current buffer, stream time, used to report position */
195 GstClockTime current_sstart;
196 GstClockTime current_sstop;
198 /* start, stop and jitter of current buffer, running time */
199 GstClockTime current_rstart;
200 GstClockTime current_rstop;
201 GstClockTimeDiff current_jitter;
202 /* the running time of the previous buffer */
203 GstClockTime prev_rstart;
205 /* EOS sync time in running time */
206 GstClockTime eos_rtime;
208 /* last buffer that arrived in time, running time */
209 GstClockTime last_render_time;
210 /* when the last buffer left the sink, running time */
211 GstClockTime last_left;
213 /* running averages go here these are done on running time */
215 GstClockTime avg_duration;
217 GstClockTime avg_in_diff;
219 /* these are done on system time. avg_jitter and avg_render are
220 * compared to eachother to see if the rendering time takes a
221 * huge amount of the processing, If so we are flooded with
223 GstClockTime last_left_systime;
224 GstClockTime avg_jitter;
225 GstClockTime start, stop;
226 GstClockTime avg_render;
228 /* number of rendered and dropped frames */
233 GstClockTime latency;
235 /* if we already commited the state */
237 /* state change to playing ongoing */
240 /* when we received EOS */
241 gboolean received_eos;
243 /* when we are prerolled and able to report latency */
244 gboolean have_latency;
246 /* the last buffer we prerolled or rendered. Useful for making snapshots */
247 gint enable_last_buffer; /* atomic */
248 GstBuffer *last_buffer;
250 /* caps for pull based scheduling */
253 /* blocksize for pulling */
258 /* seqnum of the stream */
261 gboolean call_preroll;
262 gboolean step_unlock;
264 /* we have a pending and a current step operation */
265 GstStepInfo current_step;
266 GstStepInfo pending_step;
268 /* Cached GstClockID */
269 GstClockID cached_clock_id;
271 /* for throttling and QoS */
272 GstClockTime earliest_in_time;
273 GstClockTime throttle_time;
276 #define DO_RUNNING_AVG(avg,val,size) (((val) + ((size)-1) * (avg)) / (size))
278 /* generic running average, this has a neutral window size */
279 #define UPDATE_RUNNING_AVG(avg,val) DO_RUNNING_AVG(avg,val,8)
281 /* the windows for these running averages are experimentally obtained.
282 * possitive values get averaged more while negative values use a small
283 * window so we can react faster to badness. */
284 #define UPDATE_RUNNING_AVG_P(avg,val) DO_RUNNING_AVG(avg,val,16)
285 #define UPDATE_RUNNING_AVG_N(avg,val) DO_RUNNING_AVG(avg,val,4)
289 _PR_IS_NOTHING = 1 << 0,
290 _PR_IS_BUFFER = 1 << 1,
291 _PR_IS_BUFFERLIST = 1 << 2,
292 _PR_IS_EVENT = 1 << 3
295 #define OBJ_IS_BUFFER(a) ((a) & _PR_IS_BUFFER)
296 #define OBJ_IS_BUFFERLIST(a) ((a) & _PR_IS_BUFFERLIST)
297 #define OBJ_IS_EVENT(a) ((a) & _PR_IS_EVENT)
298 #define OBJ_IS_BUFFERFULL(a) ((a) & (_PR_IS_BUFFER | _PR_IS_BUFFERLIST))
300 /* BaseSink properties */
302 #define DEFAULT_CAN_ACTIVATE_PULL FALSE /* fixme: enable me */
303 #define DEFAULT_CAN_ACTIVATE_PUSH TRUE
305 #define DEFAULT_PREROLL_QUEUE_LEN 0
306 #define DEFAULT_SYNC TRUE
307 #define DEFAULT_MAX_LATENESS -1
308 #define DEFAULT_QOS FALSE
309 #define DEFAULT_ASYNC TRUE
310 #define DEFAULT_TS_OFFSET 0
311 #define DEFAULT_BLOCKSIZE 4096
312 #define DEFAULT_RENDER_DELAY 0
313 #define DEFAULT_ENABLE_LAST_BUFFER TRUE
314 #define DEFAULT_THROTTLE_TIME 0
319 PROP_PREROLL_QUEUE_LEN,
325 PROP_ENABLE_LAST_BUFFER,
333 static GstElementClass *parent_class = NULL;
335 static void gst_base_sink_class_init (GstBaseSinkClass * klass);
336 static void gst_base_sink_init (GstBaseSink * trans, gpointer g_class);
337 static void gst_base_sink_finalize (GObject * object);
340 gst_base_sink_get_type (void)
342 static volatile gsize base_sink_type = 0;
344 if (g_once_init_enter (&base_sink_type)) {
346 static const GTypeInfo base_sink_info = {
347 sizeof (GstBaseSinkClass),
350 (GClassInitFunc) gst_base_sink_class_init,
353 sizeof (GstBaseSink),
355 (GInstanceInitFunc) gst_base_sink_init,
358 _type = g_type_register_static (GST_TYPE_ELEMENT,
359 "GstBaseSink", &base_sink_info, G_TYPE_FLAG_ABSTRACT);
360 g_once_init_leave (&base_sink_type, _type);
362 return base_sink_type;
365 static void gst_base_sink_set_property (GObject * object, guint prop_id,
366 const GValue * value, GParamSpec * pspec);
367 static void gst_base_sink_get_property (GObject * object, guint prop_id,
368 GValue * value, GParamSpec * pspec);
370 static gboolean gst_base_sink_send_event (GstElement * element,
372 static gboolean default_element_query (GstElement * element, GstQuery * query);
373 static const GstQueryType *gst_base_sink_get_query_types (GstElement * element);
375 static GstCaps *gst_base_sink_get_caps (GstBaseSink * sink);
376 static gboolean gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps);
377 static GstFlowReturn gst_base_sink_buffer_alloc (GstBaseSink * sink,
378 guint64 offset, guint size, GstCaps * caps, GstBuffer ** buf);
379 static void gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
380 GstClockTime * start, GstClockTime * end);
381 static gboolean gst_base_sink_set_flushing (GstBaseSink * basesink,
382 GstPad * pad, gboolean flushing);
383 static gboolean gst_base_sink_default_activate_pull (GstBaseSink * basesink,
385 static gboolean gst_base_sink_default_do_seek (GstBaseSink * sink,
386 GstSegment * segment);
387 static gboolean gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
388 GstEvent * event, GstSegment * segment);
390 static GstStateChangeReturn gst_base_sink_change_state (GstElement * element,
391 GstStateChange transition);
393 static gboolean gst_base_sink_sink_query (GstPad * pad, GstQuery * query);
394 static GstFlowReturn gst_base_sink_chain (GstPad * pad, GstBuffer * buffer);
395 static GstFlowReturn gst_base_sink_chain_list (GstPad * pad,
396 GstBufferList * list);
398 static void gst_base_sink_loop (GstPad * pad);
399 static gboolean gst_base_sink_pad_activate (GstPad * pad);
400 static gboolean gst_base_sink_pad_activate_push (GstPad * pad, gboolean active);
401 static gboolean gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active);
402 static gboolean gst_base_sink_event (GstPad * pad, GstEvent * event);
404 static gboolean default_sink_query (GstBaseSink * sink, GstQuery * query);
406 static gboolean gst_base_sink_negotiate_pull (GstBaseSink * basesink);
407 static GstCaps *gst_base_sink_pad_getcaps (GstPad * pad);
408 static gboolean gst_base_sink_pad_setcaps (GstPad * pad, GstCaps * caps);
409 static void gst_base_sink_pad_fixate (GstPad * pad, GstCaps * caps);
410 static GstFlowReturn gst_base_sink_pad_buffer_alloc (GstPad * pad,
411 guint64 offset, guint size, GstCaps * caps, GstBuffer ** buf);
414 /* check if an object was too late */
415 static gboolean gst_base_sink_is_too_late (GstBaseSink * basesink,
416 GstMiniObject * obj, GstClockTime rstart, GstClockTime rstop,
417 GstClockReturn status, GstClockTimeDiff jitter);
418 static GstFlowReturn gst_base_sink_preroll_object (GstBaseSink * basesink,
419 guint8 obj_type, GstMiniObject * obj);
422 gst_base_sink_class_init (GstBaseSinkClass * klass)
424 GObjectClass *gobject_class;
425 GstElementClass *gstelement_class;
427 gobject_class = G_OBJECT_CLASS (klass);
428 gstelement_class = GST_ELEMENT_CLASS (klass);
430 GST_DEBUG_CATEGORY_INIT (gst_base_sink_debug, "basesink", 0,
433 g_type_class_add_private (klass, sizeof (GstBaseSinkPrivate));
435 parent_class = g_type_class_peek_parent (klass);
437 gobject_class->finalize = gst_base_sink_finalize;
438 gobject_class->set_property = gst_base_sink_set_property;
439 gobject_class->get_property = gst_base_sink_get_property;
441 /* FIXME, this next value should be configured using an event from the
442 * upstream element, ie, the BUFFER_SIZE event. */
443 g_object_class_install_property (gobject_class, PROP_PREROLL_QUEUE_LEN,
444 g_param_spec_uint ("preroll-queue-len", "Preroll queue length",
445 "Number of buffers to queue during preroll", 0, G_MAXUINT,
446 DEFAULT_PREROLL_QUEUE_LEN,
447 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
449 g_object_class_install_property (gobject_class, PROP_SYNC,
450 g_param_spec_boolean ("sync", "Sync", "Sync on the clock", DEFAULT_SYNC,
451 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
453 g_object_class_install_property (gobject_class, PROP_MAX_LATENESS,
454 g_param_spec_int64 ("max-lateness", "Max Lateness",
455 "Maximum number of nanoseconds that a buffer can be late before it "
456 "is dropped (-1 unlimited)", -1, G_MAXINT64, DEFAULT_MAX_LATENESS,
457 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
459 g_object_class_install_property (gobject_class, PROP_QOS,
460 g_param_spec_boolean ("qos", "Qos",
461 "Generate Quality-of-Service events upstream", DEFAULT_QOS,
462 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
466 * If set to #TRUE, the basesink will perform asynchronous state changes.
467 * When set to #FALSE, the sink will not signal the parent when it prerolls.
468 * Use this option when dealing with sparse streams or when synchronisation is
473 g_object_class_install_property (gobject_class, PROP_ASYNC,
474 g_param_spec_boolean ("async", "Async",
475 "Go asynchronously to PAUSED", DEFAULT_ASYNC,
476 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
478 * GstBaseSink:ts-offset
480 * Controls the final synchronisation, a negative value will render the buffer
481 * earlier while a positive value delays playback. This property can be
482 * used to fix synchronisation in bad files.
486 g_object_class_install_property (gobject_class, PROP_TS_OFFSET,
487 g_param_spec_int64 ("ts-offset", "TS Offset",
488 "Timestamp offset in nanoseconds", G_MININT64, G_MAXINT64,
489 DEFAULT_TS_OFFSET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
492 * GstBaseSink:enable-last-buffer
494 * Enable the last-buffer property. If FALSE, basesink doesn't keep a
495 * reference to the last buffer arrived and the last-buffer property is always
496 * set to NULL. This can be useful if you need buffers to be released as soon
497 * as possible, eg. if you're using a buffer pool.
501 g_object_class_install_property (gobject_class, PROP_ENABLE_LAST_BUFFER,
502 g_param_spec_boolean ("enable-last-buffer", "Enable Last Buffer",
503 "Enable the last-buffer property", DEFAULT_ENABLE_LAST_BUFFER,
504 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
507 * GstBaseSink:last-buffer
509 * The last buffer that arrived in the sink and was used for preroll or for
510 * rendering. This property can be used to generate thumbnails. This property
511 * can be NULL when the sink has not yet received a bufer.
515 g_object_class_install_property (gobject_class, PROP_LAST_BUFFER,
516 gst_param_spec_mini_object ("last-buffer", "Last Buffer",
517 "The last buffer received in the sink", GST_TYPE_BUFFER,
518 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
520 * GstBaseSink:blocksize
522 * The amount of bytes to pull when operating in pull mode.
526 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
527 g_object_class_install_property (gobject_class, PROP_BLOCKSIZE,
528 g_param_spec_uint ("blocksize", "Block size",
529 "Size in bytes to pull per buffer (0 = default)", 0, G_MAXUINT,
530 DEFAULT_BLOCKSIZE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
532 * GstBaseSink:render-delay
534 * The additional delay between synchronisation and actual rendering of the
535 * media. This property will add additional latency to the device in order to
536 * make other sinks compensate for the delay.
540 g_object_class_install_property (gobject_class, PROP_RENDER_DELAY,
541 g_param_spec_uint64 ("render-delay", "Render Delay",
542 "Additional render delay of the sink in nanoseconds", 0, G_MAXUINT64,
543 DEFAULT_RENDER_DELAY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
545 * GstBaseSink:throttle-time
547 * The time to insert between buffers. This property can be used to control
548 * the maximum amount of buffers per second to render. Setting this property
549 * to a value bigger than 0 will make the sink create THROTTLE QoS events.
553 g_object_class_install_property (gobject_class, PROP_THROTTLE_TIME,
554 g_param_spec_uint64 ("throttle-time", "Throttle time",
555 "The time to keep between rendered buffers (unused)", 0, G_MAXUINT64,
556 DEFAULT_THROTTLE_TIME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
558 gstelement_class->change_state =
559 GST_DEBUG_FUNCPTR (gst_base_sink_change_state);
560 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_base_sink_send_event);
561 gstelement_class->query = GST_DEBUG_FUNCPTR (default_element_query);
562 gstelement_class->get_query_types =
563 GST_DEBUG_FUNCPTR (gst_base_sink_get_query_types);
565 klass->get_caps = GST_DEBUG_FUNCPTR (gst_base_sink_get_caps);
566 klass->set_caps = GST_DEBUG_FUNCPTR (gst_base_sink_set_caps);
567 klass->buffer_alloc = GST_DEBUG_FUNCPTR (gst_base_sink_buffer_alloc);
568 klass->get_times = GST_DEBUG_FUNCPTR (gst_base_sink_get_times);
569 klass->activate_pull =
570 GST_DEBUG_FUNCPTR (gst_base_sink_default_activate_pull);
571 klass->query = GST_DEBUG_FUNCPTR (default_sink_query);
573 /* Registering debug symbols for function pointers */
574 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_getcaps);
575 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_setcaps);
576 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_fixate);
577 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_buffer_alloc);
578 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate);
579 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate_push);
580 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate_pull);
581 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_event);
582 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain);
583 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain_list);
584 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_sink_query);
588 gst_base_sink_pad_getcaps (GstPad * pad)
590 GstBaseSinkClass *bclass;
592 GstCaps *caps = NULL;
594 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
595 bclass = GST_BASE_SINK_GET_CLASS (bsink);
597 if (bsink->pad_mode == GST_ACTIVATE_PULL) {
598 /* if we are operating in pull mode we only accept the negotiated caps */
599 GST_OBJECT_LOCK (pad);
600 if ((caps = GST_PAD_CAPS (pad)))
602 GST_OBJECT_UNLOCK (pad);
605 if (bclass->get_caps)
606 caps = bclass->get_caps (bsink);
609 GstPadTemplate *pad_template;
612 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass),
614 if (pad_template != NULL) {
615 caps = gst_caps_ref (gst_pad_template_get_caps (pad_template));
619 gst_object_unref (bsink);
625 gst_base_sink_pad_setcaps (GstPad * pad, GstCaps * caps)
627 GstBaseSinkClass *bclass;
631 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
632 bclass = GST_BASE_SINK_GET_CLASS (bsink);
634 if (res && bclass->set_caps)
635 res = bclass->set_caps (bsink, caps);
637 gst_object_unref (bsink);
643 gst_base_sink_pad_fixate (GstPad * pad, GstCaps * caps)
645 GstBaseSinkClass *bclass;
648 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
649 bclass = GST_BASE_SINK_GET_CLASS (bsink);
652 bclass->fixate (bsink, caps);
654 gst_object_unref (bsink);
658 gst_base_sink_pad_buffer_alloc (GstPad * pad, guint64 offset, guint size,
659 GstCaps * caps, GstBuffer ** buf)
661 GstBaseSinkClass *bclass;
663 GstFlowReturn result = GST_FLOW_OK;
665 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
666 if (G_UNLIKELY (bsink == NULL))
667 return GST_FLOW_WRONG_STATE;
668 bclass = GST_BASE_SINK_GET_CLASS (bsink);
670 if (bclass->buffer_alloc)
671 result = bclass->buffer_alloc (bsink, offset, size, caps, buf);
673 *buf = NULL; /* fallback in gstpad.c will allocate generic buffer */
675 gst_object_unref (bsink);
681 gst_base_sink_init (GstBaseSink * basesink, gpointer g_class)
683 GstPadTemplate *pad_template;
684 GstBaseSinkPrivate *priv;
686 basesink->priv = priv = GST_BASE_SINK_GET_PRIVATE (basesink);
689 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "sink");
690 g_return_if_fail (pad_template != NULL);
692 basesink->sinkpad = gst_pad_new_from_template (pad_template, "sink");
694 gst_pad_set_getcaps_function (basesink->sinkpad, gst_base_sink_pad_getcaps);
695 gst_pad_set_setcaps_function (basesink->sinkpad, gst_base_sink_pad_setcaps);
696 gst_pad_set_fixatecaps_function (basesink->sinkpad, gst_base_sink_pad_fixate);
697 gst_pad_set_bufferalloc_function (basesink->sinkpad,
698 gst_base_sink_pad_buffer_alloc);
699 gst_pad_set_activate_function (basesink->sinkpad, gst_base_sink_pad_activate);
700 gst_pad_set_activatepush_function (basesink->sinkpad,
701 gst_base_sink_pad_activate_push);
702 gst_pad_set_activatepull_function (basesink->sinkpad,
703 gst_base_sink_pad_activate_pull);
704 gst_pad_set_query_function (basesink->sinkpad, gst_base_sink_sink_query);
705 gst_pad_set_event_function (basesink->sinkpad, gst_base_sink_event);
706 gst_pad_set_chain_function (basesink->sinkpad, gst_base_sink_chain);
707 gst_pad_set_chain_list_function (basesink->sinkpad, gst_base_sink_chain_list);
708 gst_element_add_pad (GST_ELEMENT_CAST (basesink), basesink->sinkpad);
710 basesink->pad_mode = GST_ACTIVATE_NONE;
711 basesink->preroll_queue = g_queue_new ();
712 basesink->abidata.ABI.clip_segment = gst_segment_new ();
713 priv->have_latency = FALSE;
715 basesink->can_activate_push = DEFAULT_CAN_ACTIVATE_PUSH;
716 basesink->can_activate_pull = DEFAULT_CAN_ACTIVATE_PULL;
718 basesink->sync = DEFAULT_SYNC;
719 basesink->abidata.ABI.max_lateness = DEFAULT_MAX_LATENESS;
720 g_atomic_int_set (&priv->qos_enabled, DEFAULT_QOS);
721 priv->async_enabled = DEFAULT_ASYNC;
722 priv->ts_offset = DEFAULT_TS_OFFSET;
723 priv->render_delay = DEFAULT_RENDER_DELAY;
724 priv->blocksize = DEFAULT_BLOCKSIZE;
725 priv->cached_clock_id = NULL;
726 g_atomic_int_set (&priv->enable_last_buffer, DEFAULT_ENABLE_LAST_BUFFER);
727 priv->throttle_time = DEFAULT_THROTTLE_TIME;
729 GST_OBJECT_FLAG_SET (basesink, GST_ELEMENT_IS_SINK);
733 gst_base_sink_finalize (GObject * object)
735 GstBaseSink *basesink;
737 basesink = GST_BASE_SINK (object);
739 g_queue_free (basesink->preroll_queue);
740 gst_segment_free (basesink->abidata.ABI.clip_segment);
742 G_OBJECT_CLASS (parent_class)->finalize (object);
746 * gst_base_sink_set_sync:
748 * @sync: the new sync value.
750 * Configures @sink to synchronize on the clock or not. When
751 * @sync is FALSE, incoming samples will be played as fast as
752 * possible. If @sync is TRUE, the timestamps of the incomming
753 * buffers will be used to schedule the exact render time of its
759 gst_base_sink_set_sync (GstBaseSink * sink, gboolean sync)
761 g_return_if_fail (GST_IS_BASE_SINK (sink));
763 GST_OBJECT_LOCK (sink);
765 GST_OBJECT_UNLOCK (sink);
769 * gst_base_sink_get_sync:
772 * Checks if @sink is currently configured to synchronize against the
775 * Returns: TRUE if the sink is configured to synchronize against the clock.
780 gst_base_sink_get_sync (GstBaseSink * sink)
784 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
786 GST_OBJECT_LOCK (sink);
788 GST_OBJECT_UNLOCK (sink);
794 * gst_base_sink_set_max_lateness:
796 * @max_lateness: the new max lateness value.
798 * Sets the new max lateness value to @max_lateness. This value is
799 * used to decide if a buffer should be dropped or not based on the
800 * buffer timestamp and the current clock time. A value of -1 means
806 gst_base_sink_set_max_lateness (GstBaseSink * sink, gint64 max_lateness)
808 g_return_if_fail (GST_IS_BASE_SINK (sink));
810 GST_OBJECT_LOCK (sink);
811 sink->abidata.ABI.max_lateness = max_lateness;
812 GST_OBJECT_UNLOCK (sink);
816 * gst_base_sink_get_max_lateness:
819 * Gets the max lateness value. See gst_base_sink_set_max_lateness for
822 * Returns: The maximum time in nanoseconds that a buffer can be late
823 * before it is dropped and not rendered. A value of -1 means an
829 gst_base_sink_get_max_lateness (GstBaseSink * sink)
833 g_return_val_if_fail (GST_IS_BASE_SINK (sink), -1);
835 GST_OBJECT_LOCK (sink);
836 res = sink->abidata.ABI.max_lateness;
837 GST_OBJECT_UNLOCK (sink);
843 * gst_base_sink_set_qos_enabled:
845 * @enabled: the new qos value.
847 * Configures @sink to send Quality-of-Service events upstream.
852 gst_base_sink_set_qos_enabled (GstBaseSink * sink, gboolean enabled)
854 g_return_if_fail (GST_IS_BASE_SINK (sink));
856 g_atomic_int_set (&sink->priv->qos_enabled, enabled);
860 * gst_base_sink_is_qos_enabled:
863 * Checks if @sink is currently configured to send Quality-of-Service events
866 * Returns: TRUE if the sink is configured to perform Quality-of-Service.
871 gst_base_sink_is_qos_enabled (GstBaseSink * sink)
875 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
877 res = g_atomic_int_get (&sink->priv->qos_enabled);
883 * gst_base_sink_set_async_enabled:
885 * @enabled: the new async value.
887 * Configures @sink to perform all state changes asynchronusly. When async is
888 * disabled, the sink will immediately go to PAUSED instead of waiting for a
889 * preroll buffer. This feature is useful if the sink does not synchronize
890 * against the clock or when it is dealing with sparse streams.
895 gst_base_sink_set_async_enabled (GstBaseSink * sink, gboolean enabled)
897 g_return_if_fail (GST_IS_BASE_SINK (sink));
899 GST_PAD_PREROLL_LOCK (sink->sinkpad);
900 g_atomic_int_set (&sink->priv->async_enabled, enabled);
901 GST_LOG_OBJECT (sink, "set async enabled to %d", enabled);
902 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
906 * gst_base_sink_is_async_enabled:
909 * Checks if @sink is currently configured to perform asynchronous state
912 * Returns: TRUE if the sink is configured to perform asynchronous state
918 gst_base_sink_is_async_enabled (GstBaseSink * sink)
922 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
924 res = g_atomic_int_get (&sink->priv->async_enabled);
930 * gst_base_sink_set_ts_offset:
932 * @offset: the new offset
934 * Adjust the synchronisation of @sink with @offset. A negative value will
935 * render buffers earlier than their timestamp. A positive value will delay
936 * rendering. This function can be used to fix playback of badly timestamped
942 gst_base_sink_set_ts_offset (GstBaseSink * sink, GstClockTimeDiff offset)
944 g_return_if_fail (GST_IS_BASE_SINK (sink));
946 GST_OBJECT_LOCK (sink);
947 sink->priv->ts_offset = offset;
948 GST_LOG_OBJECT (sink, "set time offset to %" G_GINT64_FORMAT, offset);
949 GST_OBJECT_UNLOCK (sink);
953 * gst_base_sink_get_ts_offset:
956 * Get the synchronisation offset of @sink.
958 * Returns: The synchronisation offset.
963 gst_base_sink_get_ts_offset (GstBaseSink * sink)
965 GstClockTimeDiff res;
967 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
969 GST_OBJECT_LOCK (sink);
970 res = sink->priv->ts_offset;
971 GST_OBJECT_UNLOCK (sink);
977 * gst_base_sink_get_last_buffer:
980 * Get the last buffer that arrived in the sink and was used for preroll or for
981 * rendering. This property can be used to generate thumbnails.
983 * The #GstCaps on the buffer can be used to determine the type of the buffer.
985 * Free-function: gst_buffer_unref
987 * Returns: (transfer full): a #GstBuffer. gst_buffer_unref() after usage.
988 * This function returns NULL when no buffer has arrived in the sink yet
989 * or when the sink is not in PAUSED or PLAYING.
994 gst_base_sink_get_last_buffer (GstBaseSink * sink)
998 g_return_val_if_fail (GST_IS_BASE_SINK (sink), NULL);
1000 GST_OBJECT_LOCK (sink);
1001 if ((res = sink->priv->last_buffer))
1002 gst_buffer_ref (res);
1003 GST_OBJECT_UNLOCK (sink);
1008 /* with OBJECT_LOCK */
1010 gst_base_sink_set_last_buffer_unlocked (GstBaseSink * sink, GstBuffer * buffer)
1014 old = sink->priv->last_buffer;
1015 if (G_LIKELY (old != buffer)) {
1016 GST_DEBUG_OBJECT (sink, "setting last buffer to %p", buffer);
1017 if (G_LIKELY (buffer))
1018 gst_buffer_ref (buffer);
1019 sink->priv->last_buffer = buffer;
1023 /* avoid unreffing with the lock because cleanup code might want to take the
1025 if (G_LIKELY (old)) {
1026 GST_OBJECT_UNLOCK (sink);
1027 gst_buffer_unref (old);
1028 GST_OBJECT_LOCK (sink);
1033 gst_base_sink_set_last_buffer (GstBaseSink * sink, GstBuffer * buffer)
1035 if (!g_atomic_int_get (&sink->priv->enable_last_buffer))
1038 GST_OBJECT_LOCK (sink);
1039 gst_base_sink_set_last_buffer_unlocked (sink, buffer);
1040 GST_OBJECT_UNLOCK (sink);
1044 * gst_base_sink_set_last_buffer_enabled:
1046 * @enabled: the new enable-last-buffer value.
1048 * Configures @sink to store the last received buffer in the last-buffer
1054 gst_base_sink_set_last_buffer_enabled (GstBaseSink * sink, gboolean enabled)
1056 g_return_if_fail (GST_IS_BASE_SINK (sink));
1058 /* Only take lock if we change the value */
1059 if (g_atomic_int_compare_and_exchange (&sink->priv->enable_last_buffer,
1060 !enabled, enabled) && !enabled) {
1061 GST_OBJECT_LOCK (sink);
1062 gst_base_sink_set_last_buffer_unlocked (sink, NULL);
1063 GST_OBJECT_UNLOCK (sink);
1068 * gst_base_sink_is_last_buffer_enabled:
1071 * Checks if @sink is currently configured to store the last received buffer in
1072 * the last-buffer property.
1074 * Returns: TRUE if the sink is configured to store the last received buffer.
1079 gst_base_sink_is_last_buffer_enabled (GstBaseSink * sink)
1081 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
1083 return g_atomic_int_get (&sink->priv->enable_last_buffer);
1087 * gst_base_sink_get_latency:
1090 * Get the currently configured latency.
1092 * Returns: The configured latency.
1097 gst_base_sink_get_latency (GstBaseSink * sink)
1101 GST_OBJECT_LOCK (sink);
1102 res = sink->priv->latency;
1103 GST_OBJECT_UNLOCK (sink);
1109 * gst_base_sink_query_latency:
1111 * @live: (out) (allow-none): if the sink is live
1112 * @upstream_live: (out) (allow-none): if an upstream element is live
1113 * @min_latency: (out) (allow-none): the min latency of the upstream elements
1114 * @max_latency: (out) (allow-none): the max latency of the upstream elements
1116 * Query the sink for the latency parameters. The latency will be queried from
1117 * the upstream elements. @live will be TRUE if @sink is configured to
1118 * synchronize against the clock. @upstream_live will be TRUE if an upstream
1121 * If both @live and @upstream_live are TRUE, the sink will want to compensate
1122 * for the latency introduced by the upstream elements by setting the
1123 * @min_latency to a strictly possitive value.
1125 * This function is mostly used by subclasses.
1127 * Returns: TRUE if the query succeeded.
1132 gst_base_sink_query_latency (GstBaseSink * sink, gboolean * live,
1133 gboolean * upstream_live, GstClockTime * min_latency,
1134 GstClockTime * max_latency)
1136 gboolean l, us_live, res, have_latency;
1137 GstClockTime min, max, render_delay;
1139 GstClockTime us_min, us_max;
1141 /* we are live when we sync to the clock */
1142 GST_OBJECT_LOCK (sink);
1144 have_latency = sink->priv->have_latency;
1145 render_delay = sink->priv->render_delay;
1146 GST_OBJECT_UNLOCK (sink);
1148 /* assume no latency */
1154 GST_DEBUG_OBJECT (sink, "we are ready for LATENCY query");
1155 /* we are ready for a latency query this is when we preroll or when we are
1157 query = gst_query_new_latency ();
1159 /* ask the peer for the latency */
1160 if ((res = gst_pad_peer_query (sink->sinkpad, query))) {
1161 /* get upstream min and max latency */
1162 gst_query_parse_latency (query, &us_live, &us_min, &us_max);
1165 /* upstream live, use its latency, subclasses should use these
1166 * values to create the complete latency. */
1171 /* we need to add the render delay if we are live */
1173 min += render_delay;
1175 max += render_delay;
1178 gst_query_unref (query);
1180 GST_DEBUG_OBJECT (sink, "we are not yet ready for LATENCY query");
1184 /* not live, we tried to do the query, if it failed we return TRUE anyway */
1188 GST_DEBUG_OBJECT (sink, "latency query failed but we are not live");
1190 GST_DEBUG_OBJECT (sink, "latency query failed and we are live");
1195 GST_DEBUG_OBJECT (sink, "latency query: live: %d, have_latency %d,"
1196 " upstream: %d, min %" GST_TIME_FORMAT ", max %" GST_TIME_FORMAT, l,
1197 have_latency, us_live, GST_TIME_ARGS (min), GST_TIME_ARGS (max));
1202 *upstream_live = us_live;
1212 * gst_base_sink_set_render_delay:
1213 * @sink: a #GstBaseSink
1214 * @delay: the new delay
1216 * Set the render delay in @sink to @delay. The render delay is the time
1217 * between actual rendering of a buffer and its synchronisation time. Some
1218 * devices might delay media rendering which can be compensated for with this
1221 * After calling this function, this sink will report additional latency and
1222 * other sinks will adjust their latency to delay the rendering of their media.
1224 * This function is usually called by subclasses.
1229 gst_base_sink_set_render_delay (GstBaseSink * sink, GstClockTime delay)
1231 GstClockTime old_render_delay;
1233 g_return_if_fail (GST_IS_BASE_SINK (sink));
1235 GST_OBJECT_LOCK (sink);
1236 old_render_delay = sink->priv->render_delay;
1237 sink->priv->render_delay = delay;
1238 GST_LOG_OBJECT (sink, "set render delay to %" GST_TIME_FORMAT,
1239 GST_TIME_ARGS (delay));
1240 GST_OBJECT_UNLOCK (sink);
1242 if (delay != old_render_delay) {
1243 GST_DEBUG_OBJECT (sink, "posting latency changed");
1244 gst_element_post_message (GST_ELEMENT_CAST (sink),
1245 gst_message_new_latency (GST_OBJECT_CAST (sink)));
1250 * gst_base_sink_get_render_delay:
1251 * @sink: a #GstBaseSink
1253 * Get the render delay of @sink. see gst_base_sink_set_render_delay() for more
1254 * information about the render delay.
1256 * Returns: the render delay of @sink.
1261 gst_base_sink_get_render_delay (GstBaseSink * sink)
1263 GstClockTimeDiff res;
1265 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1267 GST_OBJECT_LOCK (sink);
1268 res = sink->priv->render_delay;
1269 GST_OBJECT_UNLOCK (sink);
1275 * gst_base_sink_set_blocksize:
1276 * @sink: a #GstBaseSink
1277 * @blocksize: the blocksize in bytes
1279 * Set the number of bytes that the sink will pull when it is operating in pull
1284 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
1286 gst_base_sink_set_blocksize (GstBaseSink * sink, guint blocksize)
1288 g_return_if_fail (GST_IS_BASE_SINK (sink));
1290 GST_OBJECT_LOCK (sink);
1291 sink->priv->blocksize = blocksize;
1292 GST_LOG_OBJECT (sink, "set blocksize to %u", blocksize);
1293 GST_OBJECT_UNLOCK (sink);
1297 * gst_base_sink_get_blocksize:
1298 * @sink: a #GstBaseSink
1300 * Get the number of bytes that the sink will pull when it is operating in pull
1303 * Returns: the number of bytes @sink will pull in pull mode.
1307 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
1309 gst_base_sink_get_blocksize (GstBaseSink * sink)
1313 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1315 GST_OBJECT_LOCK (sink);
1316 res = sink->priv->blocksize;
1317 GST_OBJECT_UNLOCK (sink);
1323 * gst_base_sink_set_throttle_time:
1324 * @sink: a #GstBaseSink
1325 * @throttle: the throttle time in nanoseconds
1327 * Set the time that will be inserted between rendered buffers. This
1328 * can be used to control the maximum buffers per second that the sink
1334 gst_base_sink_set_throttle_time (GstBaseSink * sink, guint64 throttle)
1336 g_return_if_fail (GST_IS_BASE_SINK (sink));
1338 GST_OBJECT_LOCK (sink);
1339 sink->priv->throttle_time = throttle;
1340 GST_LOG_OBJECT (sink, "set throttle_time to %" G_GUINT64_FORMAT, throttle);
1341 GST_OBJECT_UNLOCK (sink);
1345 * gst_base_sink_get_throttle_time:
1346 * @sink: a #GstBaseSink
1348 * Get the time that will be inserted between frames to control the
1349 * maximum buffers per second.
1351 * Returns: the number of nanoseconds @sink will put between frames.
1356 gst_base_sink_get_throttle_time (GstBaseSink * sink)
1360 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1362 GST_OBJECT_LOCK (sink);
1363 res = sink->priv->throttle_time;
1364 GST_OBJECT_UNLOCK (sink);
1370 gst_base_sink_set_property (GObject * object, guint prop_id,
1371 const GValue * value, GParamSpec * pspec)
1373 GstBaseSink *sink = GST_BASE_SINK (object);
1376 case PROP_PREROLL_QUEUE_LEN:
1377 /* preroll lock necessary to serialize with finish_preroll */
1378 GST_PAD_PREROLL_LOCK (sink->sinkpad);
1379 g_atomic_int_set (&sink->preroll_queue_max_len, g_value_get_uint (value));
1380 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
1383 gst_base_sink_set_sync (sink, g_value_get_boolean (value));
1385 case PROP_MAX_LATENESS:
1386 gst_base_sink_set_max_lateness (sink, g_value_get_int64 (value));
1389 gst_base_sink_set_qos_enabled (sink, g_value_get_boolean (value));
1392 gst_base_sink_set_async_enabled (sink, g_value_get_boolean (value));
1394 case PROP_TS_OFFSET:
1395 gst_base_sink_set_ts_offset (sink, g_value_get_int64 (value));
1397 case PROP_BLOCKSIZE:
1398 gst_base_sink_set_blocksize (sink, g_value_get_uint (value));
1400 case PROP_RENDER_DELAY:
1401 gst_base_sink_set_render_delay (sink, g_value_get_uint64 (value));
1403 case PROP_ENABLE_LAST_BUFFER:
1404 gst_base_sink_set_last_buffer_enabled (sink, g_value_get_boolean (value));
1406 case PROP_THROTTLE_TIME:
1407 gst_base_sink_set_throttle_time (sink, g_value_get_uint64 (value));
1410 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1416 gst_base_sink_get_property (GObject * object, guint prop_id, GValue * value,
1419 GstBaseSink *sink = GST_BASE_SINK (object);
1422 case PROP_PREROLL_QUEUE_LEN:
1423 g_value_set_uint (value, g_atomic_int_get (&sink->preroll_queue_max_len));
1426 g_value_set_boolean (value, gst_base_sink_get_sync (sink));
1428 case PROP_MAX_LATENESS:
1429 g_value_set_int64 (value, gst_base_sink_get_max_lateness (sink));
1432 g_value_set_boolean (value, gst_base_sink_is_qos_enabled (sink));
1435 g_value_set_boolean (value, gst_base_sink_is_async_enabled (sink));
1437 case PROP_TS_OFFSET:
1438 g_value_set_int64 (value, gst_base_sink_get_ts_offset (sink));
1440 case PROP_LAST_BUFFER:
1441 gst_value_take_buffer (value, gst_base_sink_get_last_buffer (sink));
1443 case PROP_ENABLE_LAST_BUFFER:
1444 g_value_set_boolean (value, gst_base_sink_is_last_buffer_enabled (sink));
1446 case PROP_BLOCKSIZE:
1447 g_value_set_uint (value, gst_base_sink_get_blocksize (sink));
1449 case PROP_RENDER_DELAY:
1450 g_value_set_uint64 (value, gst_base_sink_get_render_delay (sink));
1452 case PROP_THROTTLE_TIME:
1453 g_value_set_uint64 (value, gst_base_sink_get_throttle_time (sink));
1456 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1463 gst_base_sink_get_caps (GstBaseSink * sink)
1469 gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps)
1474 static GstFlowReturn
1475 gst_base_sink_buffer_alloc (GstBaseSink * sink, guint64 offset, guint size,
1476 GstCaps * caps, GstBuffer ** buf)
1482 /* with PREROLL_LOCK, STREAM_LOCK */
1484 gst_base_sink_preroll_queue_flush (GstBaseSink * basesink, GstPad * pad)
1488 GST_DEBUG_OBJECT (basesink, "flushing queue %p", basesink);
1489 while ((obj = g_queue_pop_head (basesink->preroll_queue))) {
1490 GST_DEBUG_OBJECT (basesink, "popped %p", obj);
1491 gst_mini_object_unref (obj);
1493 /* we can't have EOS anymore now */
1494 basesink->eos = FALSE;
1495 basesink->priv->received_eos = FALSE;
1496 basesink->have_preroll = FALSE;
1497 basesink->priv->step_unlock = FALSE;
1498 basesink->eos_queued = FALSE;
1499 basesink->preroll_queued = 0;
1500 basesink->buffers_queued = 0;
1501 basesink->events_queued = 0;
1502 /* can't report latency anymore until we preroll again */
1503 if (basesink->priv->async_enabled) {
1504 GST_OBJECT_LOCK (basesink);
1505 basesink->priv->have_latency = FALSE;
1506 GST_OBJECT_UNLOCK (basesink);
1508 /* and signal any waiters now */
1509 GST_PAD_PREROLL_SIGNAL (pad);
1512 /* with STREAM_LOCK, configures given segment with the event information. */
1514 gst_base_sink_configure_segment (GstBaseSink * basesink, GstPad * pad,
1515 GstEvent * event, GstSegment * segment)
1518 gdouble rate, arate;
1524 /* the newsegment event is needed to bring the buffer timestamps to the
1525 * stream time and to drop samples outside of the playback segment. */
1526 gst_event_parse_new_segment_full (event, &update, &rate, &arate, &format,
1527 &start, &stop, &time);
1529 /* The segment is protected with both the STREAM_LOCK and the OBJECT_LOCK.
1530 * We protect with the OBJECT_LOCK so that we can use the values to
1531 * safely answer a POSITION query. */
1532 GST_OBJECT_LOCK (basesink);
1533 gst_segment_set_newsegment_full (segment, update, rate, arate, format, start,
1536 if (format == GST_FORMAT_TIME) {
1537 GST_DEBUG_OBJECT (basesink,
1538 "configured NEWSEGMENT update %d, rate %lf, applied rate %lf, "
1539 "format GST_FORMAT_TIME, "
1540 "%" GST_TIME_FORMAT " -- %" GST_TIME_FORMAT
1541 ", time %" GST_TIME_FORMAT ", accum %" GST_TIME_FORMAT,
1542 update, rate, arate, GST_TIME_ARGS (segment->start),
1543 GST_TIME_ARGS (segment->stop), GST_TIME_ARGS (segment->time),
1544 GST_TIME_ARGS (segment->accum));
1546 GST_DEBUG_OBJECT (basesink,
1547 "configured NEWSEGMENT update %d, rate %lf, applied rate %lf, "
1549 "%" G_GINT64_FORMAT " -- %" G_GINT64_FORMAT ", time %"
1550 G_GINT64_FORMAT ", accum %" G_GINT64_FORMAT, update, rate, arate,
1551 segment->format, segment->start, segment->stop, segment->time,
1554 GST_OBJECT_UNLOCK (basesink);
1557 /* with PREROLL_LOCK, STREAM_LOCK */
1559 gst_base_sink_commit_state (GstBaseSink * basesink)
1561 /* commit state and proceed to next pending state */
1562 GstState current, next, pending, post_pending;
1563 gboolean post_paused = FALSE;
1564 gboolean post_async_done = FALSE;
1565 gboolean post_playing = FALSE;
1567 /* we are certainly not playing async anymore now */
1568 basesink->playing_async = FALSE;
1570 GST_OBJECT_LOCK (basesink);
1571 current = GST_STATE (basesink);
1572 next = GST_STATE_NEXT (basesink);
1573 pending = GST_STATE_PENDING (basesink);
1574 post_pending = pending;
1577 case GST_STATE_PLAYING:
1579 GstBaseSinkClass *bclass;
1580 GstStateChangeReturn ret;
1582 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1584 GST_DEBUG_OBJECT (basesink, "commiting state to PLAYING");
1586 basesink->need_preroll = FALSE;
1587 post_async_done = TRUE;
1588 basesink->priv->commited = TRUE;
1589 post_playing = TRUE;
1590 /* post PAUSED too when we were READY */
1591 if (current == GST_STATE_READY) {
1595 /* make sure we notify the subclass of async playing */
1596 if (bclass->async_play) {
1597 GST_WARNING_OBJECT (basesink, "deprecated async_play");
1598 ret = bclass->async_play (basesink);
1599 if (ret == GST_STATE_CHANGE_FAILURE)
1604 case GST_STATE_PAUSED:
1605 GST_DEBUG_OBJECT (basesink, "commiting state to PAUSED");
1607 post_async_done = TRUE;
1608 basesink->priv->commited = TRUE;
1609 post_pending = GST_STATE_VOID_PENDING;
1611 case GST_STATE_READY:
1612 case GST_STATE_NULL:
1614 case GST_STATE_VOID_PENDING:
1615 goto nothing_pending;
1620 /* we can report latency queries now */
1621 basesink->priv->have_latency = TRUE;
1623 GST_STATE (basesink) = pending;
1624 GST_STATE_NEXT (basesink) = GST_STATE_VOID_PENDING;
1625 GST_STATE_PENDING (basesink) = GST_STATE_VOID_PENDING;
1626 GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_SUCCESS;
1627 GST_OBJECT_UNLOCK (basesink);
1630 GST_DEBUG_OBJECT (basesink, "posting PAUSED state change message");
1631 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1632 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1633 current, next, post_pending));
1635 if (post_async_done) {
1636 GST_DEBUG_OBJECT (basesink, "posting async-done message");
1637 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1638 gst_message_new_async_done (GST_OBJECT_CAST (basesink)));
1641 GST_DEBUG_OBJECT (basesink, "posting PLAYING state change message");
1642 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1643 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1644 next, pending, GST_STATE_VOID_PENDING));
1647 GST_STATE_BROADCAST (basesink);
1653 /* Depending on the state, set our vars. We get in this situation when the
1654 * state change function got a change to update the state vars before the
1655 * streaming thread did. This is fine but we need to make sure that we
1656 * update the need_preroll var since it was TRUE when we got here and might
1657 * become FALSE if we got to PLAYING. */
1658 GST_DEBUG_OBJECT (basesink, "nothing to commit, now in %s",
1659 gst_element_state_get_name (current));
1661 case GST_STATE_PLAYING:
1662 basesink->need_preroll = FALSE;
1664 case GST_STATE_PAUSED:
1665 basesink->need_preroll = TRUE;
1668 basesink->need_preroll = FALSE;
1669 basesink->flushing = TRUE;
1672 /* we can report latency queries now */
1673 basesink->priv->have_latency = TRUE;
1674 GST_OBJECT_UNLOCK (basesink);
1679 /* app is going to READY */
1680 GST_DEBUG_OBJECT (basesink, "stopping");
1681 basesink->need_preroll = FALSE;
1682 basesink->flushing = TRUE;
1683 GST_OBJECT_UNLOCK (basesink);
1688 GST_DEBUG_OBJECT (basesink, "async commit failed");
1689 GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_FAILURE;
1690 GST_OBJECT_UNLOCK (basesink);
1696 start_stepping (GstBaseSink * sink, GstSegment * segment,
1697 GstStepInfo * pending, GstStepInfo * current)
1700 GstMessage *message;
1702 GST_DEBUG_OBJECT (sink, "update pending step");
1704 GST_OBJECT_LOCK (sink);
1705 memcpy (current, pending, sizeof (GstStepInfo));
1706 pending->valid = FALSE;
1707 GST_OBJECT_UNLOCK (sink);
1709 /* post message first */
1711 gst_message_new_step_start (GST_OBJECT (sink), TRUE, current->format,
1712 current->amount, current->rate, current->flush, current->intermediate);
1713 gst_message_set_seqnum (message, current->seqnum);
1714 gst_element_post_message (GST_ELEMENT (sink), message);
1716 /* get the running time of where we paused and remember it */
1717 current->start = gst_element_get_start_time (GST_ELEMENT_CAST (sink));
1718 gst_segment_set_running_time (segment, GST_FORMAT_TIME, current->start);
1720 /* set the new rate for the remainder of the segment */
1721 current->start_rate = segment->rate;
1722 segment->rate *= current->rate;
1723 segment->abs_rate = ABS (segment->rate);
1726 if (segment->rate > 0.0)
1727 current->start_stop = segment->stop;
1729 current->start_start = segment->start;
1731 if (current->format == GST_FORMAT_TIME) {
1732 end = current->start + current->amount;
1733 if (!current->flush) {
1734 /* update the segment clipping regions for non-flushing seeks */
1735 if (segment->rate > 0.0) {
1736 segment->stop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1737 segment->last_stop = segment->stop;
1741 position = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1742 segment->time = position;
1743 segment->start = position;
1744 segment->last_stop = position;
1749 GST_DEBUG_OBJECT (sink,
1750 "segment now rate %lf, applied rate %lf, "
1751 "format GST_FORMAT_TIME, "
1752 "%" GST_TIME_FORMAT " -- %" GST_TIME_FORMAT
1753 ", time %" GST_TIME_FORMAT ", accum %" GST_TIME_FORMAT,
1754 segment->rate, segment->applied_rate, GST_TIME_ARGS (segment->start),
1755 GST_TIME_ARGS (segment->stop), GST_TIME_ARGS (segment->time),
1756 GST_TIME_ARGS (segment->accum));
1758 GST_DEBUG_OBJECT (sink, "step started at running_time %" GST_TIME_FORMAT,
1759 GST_TIME_ARGS (current->start));
1761 if (current->amount == -1) {
1762 GST_DEBUG_OBJECT (sink, "step amount == -1, stop stepping");
1763 current->valid = FALSE;
1765 GST_DEBUG_OBJECT (sink, "step amount: %" G_GUINT64_FORMAT ", format: %s, "
1766 "rate: %f", current->amount, gst_format_get_name (current->format),
1772 stop_stepping (GstBaseSink * sink, GstSegment * segment,
1773 GstStepInfo * current, gint64 rstart, gint64 rstop, gboolean eos)
1775 gint64 stop, position;
1776 GstMessage *message;
1778 GST_DEBUG_OBJECT (sink, "step complete");
1780 if (segment->rate > 0.0)
1785 GST_DEBUG_OBJECT (sink,
1786 "step stop at running_time %" GST_TIME_FORMAT, GST_TIME_ARGS (stop));
1789 current->duration = current->position;
1791 current->duration = stop - current->start;
1793 GST_DEBUG_OBJECT (sink, "step elapsed running_time %" GST_TIME_FORMAT,
1794 GST_TIME_ARGS (current->duration));
1796 position = current->start + current->duration;
1798 /* now move the segment to the new running time */
1799 gst_segment_set_running_time (segment, GST_FORMAT_TIME, position);
1801 if (current->flush) {
1802 /* and remove the accumulated time we flushed, start time did not change */
1803 segment->accum = current->start;
1805 /* start time is now the stepped position */
1806 gst_element_set_start_time (GST_ELEMENT_CAST (sink), position);
1809 /* restore the previous rate */
1810 segment->rate = current->start_rate;
1811 segment->abs_rate = ABS (segment->rate);
1813 if (segment->rate > 0.0)
1814 segment->stop = current->start_stop;
1816 segment->start = current->start_start;
1818 /* the clip segment is used for position report in paused... */
1819 memcpy (sink->abidata.ABI.clip_segment, segment, sizeof (GstSegment));
1821 /* post the step done when we know the stepped duration in TIME */
1823 gst_message_new_step_done (GST_OBJECT_CAST (sink), current->format,
1824 current->amount, current->rate, current->flush, current->intermediate,
1825 current->duration, eos);
1826 gst_message_set_seqnum (message, current->seqnum);
1827 gst_element_post_message (GST_ELEMENT_CAST (sink), message);
1829 if (!current->intermediate)
1830 sink->need_preroll = current->need_preroll;
1832 /* and the current step info finished and becomes invalid */
1833 current->valid = FALSE;
1837 handle_stepping (GstBaseSink * sink, GstSegment * segment,
1838 GstStepInfo * current, gint64 * cstart, gint64 * cstop, gint64 * rstart,
1841 gboolean step_end = FALSE;
1843 /* see if we need to skip this buffer because of stepping */
1844 switch (current->format) {
1845 case GST_FORMAT_TIME:
1850 if (segment->rate > 0.0) {
1851 if (segment->stop == *cstop)
1852 *rstop = *rstart + current->amount;
1857 if (segment->start == *cstart)
1858 *rstart = *rstop + current->amount;
1864 end = current->start + current->amount;
1865 current->position = first - current->start;
1867 if (G_UNLIKELY (segment->abs_rate != 1.0))
1868 current->position /= segment->abs_rate;
1870 GST_DEBUG_OBJECT (sink,
1871 "buffer: %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT,
1872 GST_TIME_ARGS (first), GST_TIME_ARGS (last));
1873 GST_DEBUG_OBJECT (sink,
1874 "got time step %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT "/%"
1875 GST_TIME_FORMAT, GST_TIME_ARGS (current->position),
1876 GST_TIME_ARGS (last - current->start),
1877 GST_TIME_ARGS (current->amount));
1879 if ((current->flush && current->position >= current->amount)
1881 GST_DEBUG_OBJECT (sink, "step ended, we need clipping");
1883 if (segment->rate > 0.0) {
1885 *cstart = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1888 *cstop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1891 GST_DEBUG_OBJECT (sink,
1892 "cstart %" GST_TIME_FORMAT ", rstart %" GST_TIME_FORMAT,
1893 GST_TIME_ARGS (*cstart), GST_TIME_ARGS (*rstart));
1894 GST_DEBUG_OBJECT (sink,
1895 "cstop %" GST_TIME_FORMAT ", rstop %" GST_TIME_FORMAT,
1896 GST_TIME_ARGS (*cstop), GST_TIME_ARGS (*rstop));
1899 case GST_FORMAT_BUFFERS:
1900 GST_DEBUG_OBJECT (sink,
1901 "got default step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1902 current->position, current->amount);
1904 if (current->position < current->amount) {
1905 current->position++;
1910 case GST_FORMAT_DEFAULT:
1912 GST_DEBUG_OBJECT (sink,
1913 "got unknown step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1914 current->position, current->amount);
1920 /* with STREAM_LOCK, PREROLL_LOCK
1922 * Returns TRUE if the object needs synchronisation and takes therefore
1923 * part in prerolling.
1925 * rsstart/rsstop contain the start/stop in stream time.
1926 * rrstart/rrstop contain the start/stop in running time.
1929 gst_base_sink_get_sync_times (GstBaseSink * basesink, GstMiniObject * obj,
1930 GstClockTime * rsstart, GstClockTime * rsstop,
1931 GstClockTime * rrstart, GstClockTime * rrstop, gboolean * do_sync,
1932 gboolean * stepped, GstSegment * segment, GstStepInfo * step,
1933 gboolean * step_end, guint8 obj_type)
1935 GstBaseSinkClass *bclass;
1937 GstClockTime start, stop; /* raw start/stop timestamps */
1938 gint64 cstart, cstop; /* clipped raw timestamps */
1939 gint64 rstart, rstop; /* clipped timestamps converted to running time */
1940 GstClockTime sstart, sstop; /* clipped timestamps converted to stream time */
1942 GstBaseSinkPrivate *priv;
1945 priv = basesink->priv;
1947 /* start with nothing */
1948 start = stop = GST_CLOCK_TIME_NONE;
1950 if (G_UNLIKELY (OBJ_IS_EVENT (obj_type))) {
1951 GstEvent *event = GST_EVENT_CAST (obj);
1953 switch (GST_EVENT_TYPE (event)) {
1954 /* EOS event needs syncing */
1957 if (basesink->segment.rate >= 0.0) {
1958 sstart = sstop = priv->current_sstop;
1959 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1960 /* we have not seen a buffer yet, use the segment values */
1961 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1962 basesink->segment.format, basesink->segment.stop);
1965 sstart = sstop = priv->current_sstart;
1966 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1967 /* we have not seen a buffer yet, use the segment values */
1968 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1969 basesink->segment.format, basesink->segment.start);
1973 rstart = rstop = priv->eos_rtime;
1974 *do_sync = rstart != -1;
1975 GST_DEBUG_OBJECT (basesink, "sync times for EOS %" GST_TIME_FORMAT,
1976 GST_TIME_ARGS (rstart));
1977 /* if we are stepping, we end now */
1978 *step_end = step->valid;
1983 /* other events do not need syncing */
1984 /* FIXME, maybe NEWSEGMENT might need synchronisation
1985 * since the POSITION query depends on accumulated times and
1986 * we cannot accumulate the current segment before the previous
1996 /* else do buffer sync code */
1997 buffer = GST_BUFFER_CAST (obj);
1999 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2001 /* just get the times to see if we need syncing, if the start returns -1 we
2003 if (bclass->get_times)
2004 bclass->get_times (basesink, buffer, &start, &stop);
2006 if (!GST_CLOCK_TIME_IS_VALID (start)) {
2007 /* we don't need to sync but we still want to get the timestamps for
2008 * tracking the position */
2009 gst_base_sink_get_times (basesink, buffer, &start, &stop);
2015 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
2016 ", stop: %" GST_TIME_FORMAT ", do_sync %d", GST_TIME_ARGS (start),
2017 GST_TIME_ARGS (stop), *do_sync);
2019 /* collect segment and format for code clarity */
2020 format = segment->format;
2022 /* no timestamp clipping if we did not get a TIME segment format */
2023 if (G_UNLIKELY (format != GST_FORMAT_TIME)) {
2026 /* do running and stream time in TIME format */
2027 format = GST_FORMAT_TIME;
2028 GST_LOG_OBJECT (basesink, "not time format, don't clip");
2032 /* clip, only when we know about time */
2033 if (G_UNLIKELY (!gst_segment_clip (segment, GST_FORMAT_TIME,
2034 (gint64) start, (gint64) stop, &cstart, &cstop))) {
2036 GST_DEBUG_OBJECT (basesink, "step out of segment");
2037 /* when we are stepping, pretend we're at the end of the segment */
2038 if (segment->rate > 0.0) {
2039 cstart = segment->stop;
2040 cstop = segment->stop;
2042 cstart = segment->start;
2043 cstop = segment->start;
2047 goto out_of_segment;
2050 if (G_UNLIKELY (start != cstart || stop != cstop)) {
2051 GST_DEBUG_OBJECT (basesink, "clipped to: start %" GST_TIME_FORMAT
2052 ", stop: %" GST_TIME_FORMAT, GST_TIME_ARGS (cstart),
2053 GST_TIME_ARGS (cstop));
2056 /* set last stop position */
2057 if (G_LIKELY (stop != GST_CLOCK_TIME_NONE && cstop != GST_CLOCK_TIME_NONE))
2058 gst_segment_set_last_stop (segment, GST_FORMAT_TIME, cstop);
2060 gst_segment_set_last_stop (segment, GST_FORMAT_TIME, cstart);
2063 rstart = gst_segment_to_running_time (segment, format, cstart);
2064 rstop = gst_segment_to_running_time (segment, format, cstop);
2066 if (G_UNLIKELY (step->valid)) {
2067 if (!(*step_end = handle_stepping (basesink, segment, step, &cstart, &cstop,
2068 &rstart, &rstop))) {
2069 /* step is still busy, we discard data when we are flushing */
2070 *stepped = step->flush;
2071 GST_DEBUG_OBJECT (basesink, "stepping busy");
2074 /* this can produce wrong values if we accumulated non-TIME segments. If this happens,
2075 * upstream is behaving very badly */
2076 sstart = gst_segment_to_stream_time (segment, format, cstart);
2077 sstop = gst_segment_to_stream_time (segment, format, cstop);
2080 /* eos_done label only called when doing EOS, we also stop stepping then */
2081 if (*step_end && step->flush) {
2082 GST_DEBUG_OBJECT (basesink, "flushing step ended");
2083 stop_stepping (basesink, segment, step, rstart, rstop, eos);
2085 /* re-determine running start times for adjusted segment
2086 * (which has a flushed amount of running/accumulated time removed) */
2087 if (!GST_IS_EVENT (obj)) {
2088 GST_DEBUG_OBJECT (basesink, "refresh sync times");
2099 /* buffers and EOS always need syncing and preroll */
2105 /* we usually clip in the chain function already but stepping could cause
2106 * the segment to be updated later. we return FALSE so that we don't try
2108 GST_LOG_OBJECT (basesink, "buffer skipped, not in segment");
2113 /* with STREAM_LOCK, PREROLL_LOCK, LOCK
2114 * adjust a timestamp with the latency and timestamp offset. This function does
2115 * not adjust for the render delay. */
2117 gst_base_sink_adjust_time (GstBaseSink * basesink, GstClockTime time)
2119 GstClockTimeDiff ts_offset;
2121 /* don't do anything funny with invalid timestamps */
2122 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
2125 time += basesink->priv->latency;
2127 /* apply offset, be carefull for underflows */
2128 ts_offset = basesink->priv->ts_offset;
2129 if (ts_offset < 0) {
2130 ts_offset = -ts_offset;
2131 if (ts_offset < time)
2138 /* subtract the render delay again, which was included in the latency */
2139 if (time > basesink->priv->render_delay)
2140 time -= basesink->priv->render_delay;
2148 * gst_base_sink_wait_clock:
2150 * @time: the running_time to be reached
2151 * @jitter: (out) (allow-none): the jitter to be filled with time diff, or NULL
2153 * This function will block until @time is reached. It is usually called by
2154 * subclasses that use their own internal synchronisation.
2156 * If @time is not valid, no sycnhronisation is done and #GST_CLOCK_BADTIME is
2157 * returned. Likewise, if synchronisation is disabled in the element or there
2158 * is no clock, no synchronisation is done and #GST_CLOCK_BADTIME is returned.
2160 * This function should only be called with the PREROLL_LOCK held, like when
2161 * receiving an EOS event in the #GstBaseSinkClass.event() vmethod or when
2162 * receiving a buffer in
2163 * the #GstBaseSinkClass.render() vmethod.
2165 * The @time argument should be the running_time of when this method should
2166 * return and is not adjusted with any latency or offset configured in the
2171 * Returns: #GstClockReturn
2174 gst_base_sink_wait_clock (GstBaseSink * sink, GstClockTime time,
2175 GstClockTimeDiff * jitter)
2179 GstClockTime base_time;
2181 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
2184 GST_OBJECT_LOCK (sink);
2185 if (G_UNLIKELY (!sink->sync))
2188 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (sink)) == NULL))
2191 base_time = GST_ELEMENT_CAST (sink)->base_time;
2192 GST_LOG_OBJECT (sink,
2193 "time %" GST_TIME_FORMAT ", base_time %" GST_TIME_FORMAT,
2194 GST_TIME_ARGS (time), GST_TIME_ARGS (base_time));
2196 /* add base_time to running_time to get the time against the clock */
2199 /* Re-use existing clockid if available */
2200 /* FIXME: Casting to GstClockEntry only works because the types
2202 if (G_LIKELY (sink->priv->cached_clock_id != NULL
2203 && GST_CLOCK_ENTRY_CLOCK ((GstClockEntry *) sink->priv->
2204 cached_clock_id) == clock)) {
2205 if (!gst_clock_single_shot_id_reinit (clock, sink->priv->cached_clock_id,
2207 gst_clock_id_unref (sink->priv->cached_clock_id);
2208 sink->priv->cached_clock_id = gst_clock_new_single_shot_id (clock, time);
2211 if (sink->priv->cached_clock_id != NULL)
2212 gst_clock_id_unref (sink->priv->cached_clock_id);
2213 sink->priv->cached_clock_id = gst_clock_new_single_shot_id (clock, time);
2215 GST_OBJECT_UNLOCK (sink);
2217 /* A blocking wait is performed on the clock. We save the ClockID
2218 * so we can unlock the entry at any time. While we are blocking, we
2219 * release the PREROLL_LOCK so that other threads can interrupt the
2221 sink->clock_id = sink->priv->cached_clock_id;
2222 /* release the preroll lock while waiting */
2223 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
2225 ret = gst_clock_id_wait (sink->priv->cached_clock_id, jitter);
2227 GST_PAD_PREROLL_LOCK (sink->sinkpad);
2228 sink->clock_id = NULL;
2232 /* no syncing needed */
2235 GST_DEBUG_OBJECT (sink, "time not valid, no sync needed");
2236 return GST_CLOCK_BADTIME;
2240 GST_DEBUG_OBJECT (sink, "sync disabled");
2241 GST_OBJECT_UNLOCK (sink);
2242 return GST_CLOCK_BADTIME;
2246 GST_DEBUG_OBJECT (sink, "no clock, can't sync");
2247 GST_OBJECT_UNLOCK (sink);
2248 return GST_CLOCK_BADTIME;
2253 * gst_base_sink_wait_preroll:
2256 * If the #GstBaseSinkClass.render() method performs its own synchronisation
2257 * against the clock it must unblock when going from PLAYING to the PAUSED state
2258 * and call this method before continuing to render the remaining data.
2260 * This function will block until a state change to PLAYING happens (in which
2261 * case this function returns #GST_FLOW_OK) or the processing must be stopped due
2262 * to a state change to READY or a FLUSH event (in which case this function
2263 * returns #GST_FLOW_WRONG_STATE).
2265 * This function should only be called with the PREROLL_LOCK held, like in the
2268 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2269 * continue. Any other return value should be returned from the render vmethod.
2274 gst_base_sink_wait_preroll (GstBaseSink * sink)
2276 sink->have_preroll = TRUE;
2277 GST_DEBUG_OBJECT (sink, "waiting in preroll for flush or PLAYING");
2278 /* block until the state changes, or we get a flush, or something */
2279 GST_PAD_PREROLL_WAIT (sink->sinkpad);
2280 sink->have_preroll = FALSE;
2281 if (G_UNLIKELY (sink->flushing))
2283 if (G_UNLIKELY (sink->priv->step_unlock))
2285 GST_DEBUG_OBJECT (sink, "continue after preroll");
2292 GST_DEBUG_OBJECT (sink, "preroll interrupted because of flush");
2293 return GST_FLOW_WRONG_STATE;
2297 sink->priv->step_unlock = FALSE;
2298 GST_DEBUG_OBJECT (sink, "preroll interrupted because of step");
2299 return GST_FLOW_STEP;
2303 static inline guint8
2304 get_object_type (GstMiniObject * obj)
2308 if (G_LIKELY (GST_IS_BUFFER (obj)))
2309 obj_type = _PR_IS_BUFFER;
2310 else if (GST_IS_EVENT (obj))
2311 obj_type = _PR_IS_EVENT;
2312 else if (GST_IS_BUFFER_LIST (obj))
2313 obj_type = _PR_IS_BUFFERLIST;
2315 obj_type = _PR_IS_NOTHING;
2321 * gst_base_sink_do_preroll:
2323 * @obj: (transfer none): the mini object that caused the preroll
2325 * If the @sink spawns its own thread for pulling buffers from upstream it
2326 * should call this method after it has pulled a buffer. If the element needed
2327 * to preroll, this function will perform the preroll and will then block
2328 * until the element state is changed.
2330 * This function should be called with the PREROLL_LOCK held.
2332 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2333 * continue. Any other return value should be returned from the render vmethod.
2338 gst_base_sink_do_preroll (GstBaseSink * sink, GstMiniObject * obj)
2342 while (G_UNLIKELY (sink->need_preroll)) {
2344 GST_DEBUG_OBJECT (sink, "prerolling object %p", obj);
2346 obj_type = get_object_type (obj);
2348 ret = gst_base_sink_preroll_object (sink, obj_type, obj);
2349 if (ret != GST_FLOW_OK)
2350 goto preroll_failed;
2352 /* need to recheck here because the commit state could have
2353 * made us not need the preroll anymore */
2354 if (G_LIKELY (sink->need_preroll)) {
2355 /* block until the state changes, or we get a flush, or something */
2356 ret = gst_base_sink_wait_preroll (sink);
2357 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2358 goto preroll_failed;
2366 GST_DEBUG_OBJECT (sink, "preroll failed: %s", gst_flow_get_name (ret));
2372 * gst_base_sink_wait_eos:
2374 * @time: the running_time to be reached
2375 * @jitter: (out) (allow-none): the jitter to be filled with time diff, or NULL
2377 * This function will block until @time is reached. It is usually called by
2378 * subclasses that use their own internal synchronisation but want to let the
2379 * EOS be handled by the base class.
2381 * This function should only be called with the PREROLL_LOCK held, like when
2382 * receiving an EOS event in the ::event vmethod.
2384 * The @time argument should be the running_time of when the EOS should happen
2385 * and will be adjusted with any latency and offset configured in the sink.
2387 * Returns: #GstFlowReturn
2392 gst_base_sink_wait_eos (GstBaseSink * sink, GstClockTime time,
2393 GstClockTimeDiff * jitter)
2395 GstClockReturn status;
2401 GST_DEBUG_OBJECT (sink, "checking preroll");
2403 /* first wait for the playing state before we can continue */
2404 while (G_UNLIKELY (sink->need_preroll)) {
2405 ret = gst_base_sink_wait_preroll (sink);
2406 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2410 /* preroll done, we can sync since we are in PLAYING now. */
2411 GST_DEBUG_OBJECT (sink, "possibly waiting for clock to reach %"
2412 GST_TIME_FORMAT, GST_TIME_ARGS (time));
2414 /* compensate for latency, ts_offset and render delay */
2415 stime = gst_base_sink_adjust_time (sink, time);
2417 /* wait for the clock, this can be interrupted because we got shut down or
2419 status = gst_base_sink_wait_clock (sink, stime, jitter);
2421 GST_DEBUG_OBJECT (sink, "clock returned %d", status);
2423 /* invalid time, no clock or sync disabled, just continue then */
2424 if (status == GST_CLOCK_BADTIME)
2427 /* waiting could have been interrupted and we can be flushing now */
2428 if (G_UNLIKELY (sink->flushing))
2431 /* retry if we got unscheduled, which means we did not reach the timeout
2432 * yet. if some other error occures, we continue. */
2433 } while (status == GST_CLOCK_UNSCHEDULED);
2435 GST_DEBUG_OBJECT (sink, "end of stream");
2442 GST_DEBUG_OBJECT (sink, "we are flushing");
2443 return GST_FLOW_WRONG_STATE;
2447 /* with STREAM_LOCK, PREROLL_LOCK
2449 * Make sure we are in PLAYING and synchronize an object to the clock.
2451 * If we need preroll, we are not in PLAYING. We try to commit the state
2452 * if needed and then block if we still are not PLAYING.
2454 * We start waiting on the clock in PLAYING. If we got interrupted, we
2455 * immediately try to re-preroll.
2457 * Some objects do not need synchronisation (most events) and so this function
2458 * immediately returns GST_FLOW_OK.
2460 * for objects that arrive later than max-lateness to be synchronized to the
2461 * clock have the @late boolean set to TRUE.
2463 * This function keeps a running average of the jitter (the diff between the
2464 * clock time and the requested sync time). The jitter is negative for
2465 * objects that arrive in time and positive for late buffers.
2467 * does not take ownership of obj.
2469 static GstFlowReturn
2470 gst_base_sink_do_sync (GstBaseSink * basesink, GstPad * pad,
2471 GstMiniObject * obj, gboolean * late, gboolean * step_end, guint8 obj_type)
2473 GstClockTimeDiff jitter = 0;
2475 GstClockReturn status = GST_CLOCK_OK;
2476 GstClockTime rstart, rstop, sstart, sstop, stime;
2478 GstBaseSinkPrivate *priv;
2480 GstStepInfo *current, *pending;
2483 priv = basesink->priv;
2486 sstart = sstop = rstart = rstop = GST_CLOCK_TIME_NONE;
2490 priv->current_rstart = GST_CLOCK_TIME_NONE;
2492 /* get stepping info */
2493 current = &priv->current_step;
2494 pending = &priv->pending_step;
2496 /* get timing information for this object against the render segment */
2497 syncable = gst_base_sink_get_sync_times (basesink, obj,
2498 &sstart, &sstop, &rstart, &rstop, &do_sync, &stepped, &basesink->segment,
2499 current, step_end, obj_type);
2501 if (G_UNLIKELY (stepped))
2504 /* a syncable object needs to participate in preroll and
2505 * clocking. All buffers and EOS are syncable. */
2506 if (G_UNLIKELY (!syncable))
2509 /* store timing info for current object */
2510 priv->current_rstart = rstart;
2511 priv->current_rstop = (GST_CLOCK_TIME_IS_VALID (rstop) ? rstop : rstart);
2513 /* save sync time for eos when the previous object needed sync */
2514 priv->eos_rtime = (do_sync ? priv->current_rstop : GST_CLOCK_TIME_NONE);
2516 /* calculate inter frame spacing */
2517 if (G_UNLIKELY (priv->prev_rstart != -1 && priv->prev_rstart < rstart)) {
2518 GstClockTime in_diff;
2520 in_diff = rstart - priv->prev_rstart;
2522 if (priv->avg_in_diff == -1)
2523 priv->avg_in_diff = in_diff;
2525 priv->avg_in_diff = UPDATE_RUNNING_AVG (priv->avg_in_diff, in_diff);
2527 GST_LOG_OBJECT (basesink, "avg frame diff %" GST_TIME_FORMAT,
2528 GST_TIME_ARGS (priv->avg_in_diff));
2531 priv->prev_rstart = rstart;
2533 if (G_UNLIKELY (priv->earliest_in_time != -1
2534 && rstart < priv->earliest_in_time))
2538 /* first do preroll, this makes sure we commit our state
2539 * to PAUSED and can continue to PLAYING. We cannot perform
2540 * any clock sync in PAUSED because there is no clock. */
2541 ret = gst_base_sink_do_preroll (basesink, obj);
2542 if (G_UNLIKELY (ret != GST_FLOW_OK))
2543 goto preroll_failed;
2545 /* update the segment with a pending step if the current one is invalid and we
2546 * have a new pending one. We only accept new step updates after a preroll */
2547 if (G_UNLIKELY (pending->valid && !current->valid)) {
2548 start_stepping (basesink, &basesink->segment, pending, current);
2552 /* After rendering we store the position of the last buffer so that we can use
2553 * it to report the position. We need to take the lock here. */
2554 GST_OBJECT_LOCK (basesink);
2555 priv->current_sstart = sstart;
2556 priv->current_sstop = (GST_CLOCK_TIME_IS_VALID (sstop) ? sstop : sstart);
2557 GST_OBJECT_UNLOCK (basesink);
2562 /* adjust for latency */
2563 stime = gst_base_sink_adjust_time (basesink, rstart);
2565 /* preroll done, we can sync since we are in PLAYING now. */
2566 GST_DEBUG_OBJECT (basesink, "possibly waiting for clock to reach %"
2567 GST_TIME_FORMAT ", adjusted %" GST_TIME_FORMAT,
2568 GST_TIME_ARGS (rstart), GST_TIME_ARGS (stime));
2570 /* This function will return immediately if start == -1, no clock
2571 * or sync is disabled with GST_CLOCK_BADTIME. */
2572 status = gst_base_sink_wait_clock (basesink, stime, &jitter);
2574 GST_DEBUG_OBJECT (basesink, "clock returned %d, jitter %c%" GST_TIME_FORMAT,
2575 status, (jitter < 0 ? '-' : ' '), GST_TIME_ARGS (ABS (jitter)));
2577 /* invalid time, no clock or sync disabled, just render */
2578 if (status == GST_CLOCK_BADTIME)
2581 /* waiting could have been interrupted and we can be flushing now */
2582 if (G_UNLIKELY (basesink->flushing))
2585 /* check for unlocked by a state change, we are not flushing so
2586 * we can try to preroll on the current buffer. */
2587 if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED)) {
2588 GST_DEBUG_OBJECT (basesink, "unscheduled, waiting some more");
2589 priv->call_preroll = TRUE;
2593 /* successful syncing done, record observation */
2594 priv->current_jitter = jitter;
2596 /* check if the object should be dropped */
2597 *late = gst_base_sink_is_too_late (basesink, obj, rstart, rstop,
2606 GST_DEBUG_OBJECT (basesink, "skipped stepped object %p", obj);
2612 GST_DEBUG_OBJECT (basesink, "non syncable object %p", obj);
2617 GST_DEBUG_OBJECT (basesink, "dropped because of QoS %p", obj);
2623 GST_DEBUG_OBJECT (basesink, "we are flushing");
2624 return GST_FLOW_WRONG_STATE;
2628 GST_DEBUG_OBJECT (basesink, "preroll failed");
2635 gst_base_sink_send_qos (GstBaseSink * basesink, GstQOSType type,
2636 gdouble proportion, GstClockTime time, GstClockTimeDiff diff)
2641 /* generate Quality-of-Service event */
2642 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2643 "qos: type %d, proportion: %lf, diff %" G_GINT64_FORMAT ", timestamp %"
2644 GST_TIME_FORMAT, type, proportion, diff, GST_TIME_ARGS (time));
2646 event = gst_event_new_qos_full (type, proportion, diff, time);
2649 res = gst_pad_push_event (basesink->sinkpad, event);
2655 gst_base_sink_perform_qos (GstBaseSink * sink, gboolean dropped)
2657 GstBaseSinkPrivate *priv;
2658 GstClockTime start, stop;
2659 GstClockTimeDiff jitter;
2660 GstClockTime pt, entered, left;
2661 GstClockTime duration;
2666 start = priv->current_rstart;
2668 if (priv->current_step.valid)
2671 /* if Quality-of-Service disabled, do nothing */
2672 if (!g_atomic_int_get (&priv->qos_enabled) ||
2673 !GST_CLOCK_TIME_IS_VALID (start))
2676 stop = priv->current_rstop;
2677 jitter = priv->current_jitter;
2680 /* this is the time the buffer entered the sink */
2681 if (start < -jitter)
2684 entered = start + jitter;
2687 /* this is the time the buffer entered the sink */
2688 entered = start + jitter;
2689 /* this is the time the buffer left the sink */
2690 left = start + jitter;
2693 /* calculate duration of the buffer */
2694 if (GST_CLOCK_TIME_IS_VALID (stop) && stop != start)
2695 duration = stop - start;
2697 duration = priv->avg_in_diff;
2699 /* if we have the time when the last buffer left us, calculate
2700 * processing time */
2701 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2702 if (entered > priv->last_left) {
2703 pt = entered - priv->last_left;
2711 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "start: %" GST_TIME_FORMAT
2712 ", stop %" GST_TIME_FORMAT ", entered %" GST_TIME_FORMAT ", left %"
2713 GST_TIME_FORMAT ", pt: %" GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT
2714 ",jitter %" G_GINT64_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (stop),
2715 GST_TIME_ARGS (entered), GST_TIME_ARGS (left), GST_TIME_ARGS (pt),
2716 GST_TIME_ARGS (duration), jitter);
2718 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "avg_duration: %" GST_TIME_FORMAT
2719 ", avg_pt: %" GST_TIME_FORMAT ", avg_rate: %g",
2720 GST_TIME_ARGS (priv->avg_duration), GST_TIME_ARGS (priv->avg_pt),
2723 /* collect running averages. for first observations, we copy the
2725 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_duration))
2726 priv->avg_duration = duration;
2728 priv->avg_duration = UPDATE_RUNNING_AVG (priv->avg_duration, duration);
2730 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_pt))
2733 priv->avg_pt = UPDATE_RUNNING_AVG (priv->avg_pt, pt);
2735 if (priv->avg_duration != 0)
2737 gst_guint64_to_gdouble (priv->avg_pt) /
2738 gst_guint64_to_gdouble (priv->avg_duration);
2742 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2743 if (dropped || priv->avg_rate < 0.0) {
2744 priv->avg_rate = rate;
2747 priv->avg_rate = UPDATE_RUNNING_AVG_N (priv->avg_rate, rate);
2749 priv->avg_rate = UPDATE_RUNNING_AVG_P (priv->avg_rate, rate);
2753 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink,
2754 "updated: avg_duration: %" GST_TIME_FORMAT ", avg_pt: %" GST_TIME_FORMAT
2755 ", avg_rate: %g", GST_TIME_ARGS (priv->avg_duration),
2756 GST_TIME_ARGS (priv->avg_pt), priv->avg_rate);
2759 if (priv->avg_rate >= 0.0) {
2761 GstClockTimeDiff diff;
2763 /* if we have a valid rate, start sending QoS messages */
2764 if (priv->current_jitter < 0) {
2765 /* make sure we never go below 0 when adding the jitter to the
2767 if (priv->current_rstart < -priv->current_jitter)
2768 priv->current_jitter = -priv->current_rstart;
2771 if (priv->throttle_time > 0) {
2772 diff = priv->throttle_time;
2773 type = GST_QOS_TYPE_THROTTLE;
2775 diff = priv->current_jitter;
2777 type = GST_QOS_TYPE_OVERFLOW;
2779 type = GST_QOS_TYPE_UNDERFLOW;
2782 gst_base_sink_send_qos (sink, type, priv->avg_rate, priv->current_rstart,
2786 /* record when this buffer will leave us */
2787 priv->last_left = left;
2790 /* reset all qos measuring */
2792 gst_base_sink_reset_qos (GstBaseSink * sink)
2794 GstBaseSinkPrivate *priv;
2798 priv->last_render_time = GST_CLOCK_TIME_NONE;
2799 priv->prev_rstart = GST_CLOCK_TIME_NONE;
2800 priv->earliest_in_time = GST_CLOCK_TIME_NONE;
2801 priv->last_left = GST_CLOCK_TIME_NONE;
2802 priv->avg_duration = GST_CLOCK_TIME_NONE;
2803 priv->avg_pt = GST_CLOCK_TIME_NONE;
2804 priv->avg_rate = -1.0;
2805 priv->avg_render = GST_CLOCK_TIME_NONE;
2806 priv->avg_in_diff = GST_CLOCK_TIME_NONE;
2812 /* Checks if the object was scheduled too late.
2814 * rstart/rstop contain the running_time start and stop values
2817 * status and jitter contain the return values from the clock wait.
2819 * returns TRUE if the buffer was too late.
2822 gst_base_sink_is_too_late (GstBaseSink * basesink, GstMiniObject * obj,
2823 GstClockTime rstart, GstClockTime rstop,
2824 GstClockReturn status, GstClockTimeDiff jitter)
2827 gint64 max_lateness;
2828 GstBaseSinkPrivate *priv;
2830 priv = basesink->priv;
2834 /* only for objects that were too late */
2835 if (G_LIKELY (status != GST_CLOCK_EARLY))
2838 max_lateness = basesink->abidata.ABI.max_lateness;
2840 /* check if frame dropping is enabled */
2841 if (max_lateness == -1)
2844 /* only check for buffers */
2845 if (G_UNLIKELY (!GST_IS_BUFFER (obj)))
2848 /* can't do check if we don't have a timestamp */
2849 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (rstart)))
2852 /* we can add a valid stop time */
2853 if (GST_CLOCK_TIME_IS_VALID (rstop))
2854 max_lateness += rstop;
2856 max_lateness += rstart;
2857 /* no stop time, use avg frame diff */
2858 if (priv->avg_in_diff != -1)
2859 max_lateness += priv->avg_in_diff;
2862 /* if the jitter bigger than duration and lateness we are too late */
2863 if ((late = rstart + jitter > max_lateness)) {
2864 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2865 "buffer is too late %" GST_TIME_FORMAT
2866 " > %" GST_TIME_FORMAT, GST_TIME_ARGS (rstart + jitter),
2867 GST_TIME_ARGS (max_lateness));
2868 /* !!emergency!!, if we did not receive anything valid for more than a
2869 * second, render it anyway so the user sees something */
2870 if (GST_CLOCK_TIME_IS_VALID (priv->last_render_time) &&
2871 rstart - priv->last_render_time > GST_SECOND) {
2873 GST_ELEMENT_WARNING (basesink, CORE, CLOCK,
2874 (_("A lot of buffers are being dropped.")),
2875 ("There may be a timestamping problem, or this computer is too slow."));
2876 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2877 "**emergency** last buffer at %" GST_TIME_FORMAT " > GST_SECOND",
2878 GST_TIME_ARGS (priv->last_render_time));
2883 if (!late || !GST_CLOCK_TIME_IS_VALID (priv->last_render_time)) {
2884 priv->last_render_time = rstart;
2885 /* the next allowed input timestamp */
2886 if (priv->throttle_time > 0)
2887 priv->earliest_in_time = rstart + priv->throttle_time;
2894 GST_DEBUG_OBJECT (basesink, "object was scheduled in time");
2899 GST_DEBUG_OBJECT (basesink, "frame dropping disabled");
2904 GST_DEBUG_OBJECT (basesink, "object is not a buffer");
2909 GST_DEBUG_OBJECT (basesink, "buffer has no timestamp");
2914 /* called before and after calling the render vmethod. It keeps track of how
2915 * much time was spent in the render method and is used to check if we are
2918 gst_base_sink_do_render_stats (GstBaseSink * basesink, gboolean start)
2920 GstBaseSinkPrivate *priv;
2922 priv = basesink->priv;
2925 priv->start = gst_util_get_timestamp ();
2927 GstClockTime elapsed;
2929 priv->stop = gst_util_get_timestamp ();
2931 elapsed = GST_CLOCK_DIFF (priv->start, priv->stop);
2933 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_render))
2934 priv->avg_render = elapsed;
2936 priv->avg_render = UPDATE_RUNNING_AVG (priv->avg_render, elapsed);
2938 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2939 "avg_render: %" GST_TIME_FORMAT, GST_TIME_ARGS (priv->avg_render));
2943 /* with STREAM_LOCK, PREROLL_LOCK,
2945 * Synchronize the object on the clock and then render it.
2947 * takes ownership of obj.
2949 static GstFlowReturn
2950 gst_base_sink_render_object (GstBaseSink * basesink, GstPad * pad,
2951 guint8 obj_type, gpointer obj)
2954 GstBaseSinkClass *bclass;
2955 gboolean late, step_end;
2957 GstBaseSinkPrivate *priv;
2959 priv = basesink->priv;
2961 if (OBJ_IS_BUFFERLIST (obj_type)) {
2963 * If buffer list, use the first group buffer within the list
2966 sync_obj = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0, 0);
2967 g_assert (NULL != sync_obj);
2976 /* synchronize this object, non syncable objects return OK
2979 gst_base_sink_do_sync (basesink, pad, sync_obj, &late, &step_end,
2981 if (G_UNLIKELY (ret != GST_FLOW_OK))
2984 /* and now render, event or buffer/buffer list. */
2985 if (G_LIKELY (OBJ_IS_BUFFERFULL (obj_type))) {
2986 /* drop late buffers unconditionally, let's hope it's unlikely */
2987 if (G_UNLIKELY (late))
2990 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2992 if (G_LIKELY ((OBJ_IS_BUFFERLIST (obj_type) && bclass->render_list) ||
2993 (!OBJ_IS_BUFFERLIST (obj_type) && bclass->render))) {
2996 /* read once, to get same value before and after */
2997 do_qos = g_atomic_int_get (&priv->qos_enabled);
2999 GST_DEBUG_OBJECT (basesink, "rendering object %p", obj);
3001 /* record rendering time for QoS and stats */
3003 gst_base_sink_do_render_stats (basesink, TRUE);
3005 if (!OBJ_IS_BUFFERLIST (obj_type)) {
3008 /* For buffer lists do not set last buffer. Creating buffer
3009 * with meaningful data can be done only with memcpy which will
3010 * significantly affect performance */
3011 buf = GST_BUFFER_CAST (obj);
3012 gst_base_sink_set_last_buffer (basesink, buf);
3014 ret = bclass->render (basesink, buf);
3016 GstBufferList *buflist;
3018 buflist = GST_BUFFER_LIST_CAST (obj);
3020 ret = bclass->render_list (basesink, buflist);
3024 gst_base_sink_do_render_stats (basesink, FALSE);
3026 if (ret == GST_FLOW_STEP)
3029 if (G_UNLIKELY (basesink->flushing))
3034 } else if (G_LIKELY (OBJ_IS_EVENT (obj_type))) {
3035 GstEvent *event = GST_EVENT_CAST (obj);
3036 gboolean event_res = TRUE;
3039 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3041 type = GST_EVENT_TYPE (event);
3043 GST_DEBUG_OBJECT (basesink, "rendering event %p, type %s", obj,
3044 gst_event_type_get_name (type));
3047 event_res = bclass->event (basesink, event);
3049 /* when we get here we could be flushing again when the event handler calls
3050 * _wait_eos(). We have to ignore this object in that case. */
3051 if (G_UNLIKELY (basesink->flushing))
3054 if (G_LIKELY (event_res)) {
3057 seqnum = basesink->priv->seqnum = gst_event_get_seqnum (event);
3058 GST_DEBUG_OBJECT (basesink, "Got seqnum #%" G_GUINT32_FORMAT, seqnum);
3063 GstMessage *message;
3065 /* the EOS event is completely handled so we mark
3066 * ourselves as being in the EOS state. eos is also
3067 * protected by the object lock so we can read it when
3068 * answering the POSITION query. */
3069 GST_OBJECT_LOCK (basesink);
3070 basesink->eos = TRUE;
3071 GST_OBJECT_UNLOCK (basesink);
3073 /* ok, now we can post the message */
3074 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
3076 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
3077 gst_message_set_seqnum (message, seqnum);
3078 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
3081 case GST_EVENT_NEWSEGMENT:
3082 /* configure the segment */
3083 gst_base_sink_configure_segment (basesink, pad, event,
3084 &basesink->segment);
3086 case GST_EVENT_SINK_MESSAGE:{
3087 GstMessage *msg = NULL;
3089 gst_event_parse_sink_message (event, &msg);
3092 gst_element_post_message (GST_ELEMENT_CAST (basesink), msg);
3099 g_return_val_if_reached (GST_FLOW_ERROR);
3104 /* the step ended, check if we need to activate a new step */
3105 GST_DEBUG_OBJECT (basesink, "step ended");
3106 stop_stepping (basesink, &basesink->segment, &priv->current_step,
3107 priv->current_rstart, priv->current_rstop, basesink->eos);
3111 gst_base_sink_perform_qos (basesink, late);
3113 GST_DEBUG_OBJECT (basesink, "object unref after render %p", obj);
3114 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3120 GST_DEBUG_OBJECT (basesink, "do_sync returned %s", gst_flow_get_name (ret));
3126 GST_DEBUG_OBJECT (basesink, "buffer late, dropping");
3128 if (g_atomic_int_get (&priv->qos_enabled)) {
3129 GstMessage *qos_msg;
3130 GstClockTime timestamp, duration;
3132 timestamp = GST_BUFFER_TIMESTAMP (GST_BUFFER_CAST (sync_obj));
3133 duration = GST_BUFFER_DURATION (GST_BUFFER_CAST (sync_obj));
3135 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
3136 "qos: dropped buffer rt %" GST_TIME_FORMAT ", st %" GST_TIME_FORMAT
3137 ", ts %" GST_TIME_FORMAT ", dur %" GST_TIME_FORMAT,
3138 GST_TIME_ARGS (priv->current_rstart),
3139 GST_TIME_ARGS (priv->current_sstart), GST_TIME_ARGS (timestamp),
3140 GST_TIME_ARGS (duration));
3141 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
3142 "qos: rendered %" G_GUINT64_FORMAT ", dropped %" G_GUINT64_FORMAT,
3143 priv->rendered, priv->dropped);
3146 gst_message_new_qos (GST_OBJECT_CAST (basesink), basesink->sync,
3147 priv->current_rstart, priv->current_sstart, timestamp, duration);
3148 gst_message_set_qos_values (qos_msg, priv->current_jitter, priv->avg_rate,
3150 gst_message_set_qos_stats (qos_msg, GST_FORMAT_BUFFERS, priv->rendered,
3152 gst_element_post_message (GST_ELEMENT_CAST (basesink), qos_msg);
3158 GST_DEBUG_OBJECT (basesink, "we are flushing, ignore object");
3159 gst_mini_object_unref (obj);
3160 return GST_FLOW_WRONG_STATE;
3164 /* with STREAM_LOCK, PREROLL_LOCK
3166 * Perform preroll on the given object. For buffers this means
3167 * calling the preroll subclass method.
3168 * If that succeeds, the state will be commited.
3170 * function does not take ownership of obj.
3172 static GstFlowReturn
3173 gst_base_sink_preroll_object (GstBaseSink * basesink, guint8 obj_type,
3174 GstMiniObject * obj)
3178 GST_DEBUG_OBJECT (basesink, "prerolling object %p", obj);
3180 /* if it's a buffer, we need to call the preroll method */
3181 if (G_LIKELY (OBJ_IS_BUFFERFULL (obj_type) && basesink->priv->call_preroll)) {
3182 GstBaseSinkClass *bclass;
3184 GstClockTime timestamp;
3186 if (OBJ_IS_BUFFERLIST (obj_type)) {
3187 buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0, 0);
3188 g_assert (NULL != buf);
3190 buf = GST_BUFFER_CAST (obj);
3193 timestamp = GST_BUFFER_TIMESTAMP (buf);
3195 GST_DEBUG_OBJECT (basesink, "preroll buffer %" GST_TIME_FORMAT,
3196 GST_TIME_ARGS (timestamp));
3199 * For buffer lists do not set last buffer. Creating buffer
3200 * with meaningful data can be done only with memcpy which will
3201 * significantly affect performance
3203 if (!OBJ_IS_BUFFERLIST (obj_type)) {
3204 gst_base_sink_set_last_buffer (basesink, buf);
3207 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3208 if (bclass->preroll)
3209 if ((ret = bclass->preroll (basesink, buf)) != GST_FLOW_OK)
3210 goto preroll_failed;
3212 basesink->priv->call_preroll = FALSE;
3216 if (G_LIKELY (basesink->playing_async)) {
3217 if (G_UNLIKELY (!gst_base_sink_commit_state (basesink)))
3226 GST_DEBUG_OBJECT (basesink, "preroll failed, abort state");
3227 gst_element_abort_state (GST_ELEMENT_CAST (basesink));
3232 GST_DEBUG_OBJECT (basesink, "stopping while commiting state");
3233 return GST_FLOW_WRONG_STATE;
3237 /* with STREAM_LOCK, PREROLL_LOCK
3239 * Queue an object for rendering.
3240 * The first prerollable object queued will complete the preroll. If the
3241 * preroll queue is filled, we render all the objects in the queue.
3243 * This function takes ownership of the object.
3245 static GstFlowReturn
3246 gst_base_sink_queue_object_unlocked (GstBaseSink * basesink, GstPad * pad,
3247 guint8 obj_type, gpointer obj, gboolean prerollable)
3249 GstFlowReturn ret = GST_FLOW_OK;
3253 if (G_UNLIKELY (basesink->need_preroll)) {
3254 if (G_LIKELY (prerollable))
3255 basesink->preroll_queued++;
3257 length = basesink->preroll_queued;
3259 GST_DEBUG_OBJECT (basesink, "now %d prerolled items", length);
3261 /* first prerollable item needs to finish the preroll */
3263 ret = gst_base_sink_preroll_object (basesink, obj_type, obj);
3264 if (G_UNLIKELY (ret != GST_FLOW_OK))
3265 goto preroll_failed;
3267 /* need to recheck if we need preroll, commit state during preroll
3268 * could have made us not need more preroll. */
3269 if (G_UNLIKELY (basesink->need_preroll)) {
3270 /* see if we can render now, if we can't add the object to the preroll
3272 if (G_UNLIKELY (length <= basesink->preroll_queue_max_len))
3276 /* we can start rendering (or blocking) the queued object
3278 q = basesink->preroll_queue;
3279 while (G_UNLIKELY (!g_queue_is_empty (q))) {
3283 o = g_queue_pop_head (q);
3284 GST_DEBUG_OBJECT (basesink, "rendering queued object %p", o);
3286 ot = get_object_type (o);
3288 /* do something with the return value */
3289 ret = gst_base_sink_render_object (basesink, pad, ot, o);
3290 if (ret != GST_FLOW_OK)
3291 goto dequeue_failed;
3294 /* now render the object */
3295 ret = gst_base_sink_render_object (basesink, pad, obj_type, obj);
3296 basesink->preroll_queued = 0;
3303 GST_DEBUG_OBJECT (basesink, "preroll failed, reason %s",
3304 gst_flow_get_name (ret));
3305 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3310 /* add object to the queue and return */
3311 GST_DEBUG_OBJECT (basesink, "need more preroll data %d <= %d",
3312 length, basesink->preroll_queue_max_len);
3313 g_queue_push_tail (basesink->preroll_queue, obj);
3318 GST_DEBUG_OBJECT (basesink, "rendering queued objects failed, reason %s",
3319 gst_flow_get_name (ret));
3320 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3327 * This function grabs the PREROLL_LOCK and adds the object to
3330 * This function takes ownership of obj.
3332 * Note: Only GstEvent seem to be passed to this private method
3334 static GstFlowReturn
3335 gst_base_sink_queue_object (GstBaseSink * basesink, GstPad * pad,
3336 GstMiniObject * obj, gboolean prerollable)
3340 GST_PAD_PREROLL_LOCK (pad);
3341 if (G_UNLIKELY (basesink->flushing))
3344 if (G_UNLIKELY (basesink->priv->received_eos))
3348 gst_base_sink_queue_object_unlocked (basesink, pad, _PR_IS_EVENT, obj,
3350 GST_PAD_PREROLL_UNLOCK (pad);
3357 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3358 GST_PAD_PREROLL_UNLOCK (pad);
3359 gst_mini_object_unref (obj);
3360 return GST_FLOW_WRONG_STATE;
3364 GST_DEBUG_OBJECT (basesink,
3365 "we are EOS, dropping object, return UNEXPECTED");
3366 GST_PAD_PREROLL_UNLOCK (pad);
3367 gst_mini_object_unref (obj);
3368 return GST_FLOW_UNEXPECTED;
3373 gst_base_sink_flush_start (GstBaseSink * basesink, GstPad * pad)
3375 /* make sure we are not blocked on the clock also clear any pending
3377 gst_base_sink_set_flushing (basesink, pad, TRUE);
3379 /* we grab the stream lock but that is not needed since setting the
3380 * sink to flushing would make sure no state commit is being done
3382 GST_PAD_STREAM_LOCK (pad);
3383 gst_base_sink_reset_qos (basesink);
3384 /* and we need to commit our state again on the next
3385 * prerolled buffer */
3386 basesink->playing_async = TRUE;
3387 if (basesink->priv->async_enabled) {
3388 gst_element_lost_state (GST_ELEMENT_CAST (basesink));
3390 /* start time reset in above case as well;
3391 * arranges for a.o. proper position reporting when flushing in PAUSED */
3392 gst_element_set_start_time (GST_ELEMENT_CAST (basesink), 0);
3393 basesink->priv->have_latency = TRUE;
3395 gst_base_sink_set_last_buffer (basesink, NULL);
3396 GST_PAD_STREAM_UNLOCK (pad);
3400 gst_base_sink_flush_stop (GstBaseSink * basesink, GstPad * pad)
3402 /* unset flushing so we can accept new data, this also flushes out any EOS
3404 gst_base_sink_set_flushing (basesink, pad, FALSE);
3406 /* for position reporting */
3407 GST_OBJECT_LOCK (basesink);
3408 basesink->priv->current_sstart = GST_CLOCK_TIME_NONE;
3409 basesink->priv->current_sstop = GST_CLOCK_TIME_NONE;
3410 basesink->priv->eos_rtime = GST_CLOCK_TIME_NONE;
3411 basesink->priv->call_preroll = TRUE;
3412 basesink->priv->current_step.valid = FALSE;
3413 basesink->priv->pending_step.valid = FALSE;
3414 if (basesink->pad_mode == GST_ACTIVATE_PUSH) {
3415 /* we need new segment info after the flush. */
3416 basesink->have_newsegment = FALSE;
3417 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
3418 gst_segment_init (basesink->abidata.ABI.clip_segment, GST_FORMAT_UNDEFINED);
3420 GST_OBJECT_UNLOCK (basesink);
3424 gst_base_sink_event (GstPad * pad, GstEvent * event)
3426 GstBaseSink *basesink;
3427 gboolean result = TRUE;
3428 GstBaseSinkClass *bclass;
3430 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3431 if (G_UNLIKELY (basesink == NULL)) {
3432 gst_event_unref (event);
3436 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3438 GST_DEBUG_OBJECT (basesink, "received event %p %" GST_PTR_FORMAT, event,
3441 switch (GST_EVENT_TYPE (event)) {
3446 GST_PAD_PREROLL_LOCK (pad);
3447 if (G_UNLIKELY (basesink->flushing))
3450 if (G_UNLIKELY (basesink->priv->received_eos)) {
3451 /* we can't accept anything when we are EOS */
3453 gst_event_unref (event);
3455 /* we set the received EOS flag here so that we can use it when testing if
3456 * we are prerolled and to refuse more buffers. */
3457 basesink->priv->received_eos = TRUE;
3459 /* EOS is a prerollable object, we call the unlocked version because it
3460 * does not check the received_eos flag. */
3461 ret = gst_base_sink_queue_object_unlocked (basesink, pad,
3462 _PR_IS_EVENT, GST_MINI_OBJECT_CAST (event), TRUE);
3463 if (G_UNLIKELY (ret != GST_FLOW_OK))
3466 GST_PAD_PREROLL_UNLOCK (pad);
3469 case GST_EVENT_NEWSEGMENT:
3474 GST_DEBUG_OBJECT (basesink, "newsegment %p", event);
3476 GST_PAD_PREROLL_LOCK (pad);
3477 if (G_UNLIKELY (basesink->flushing))
3480 gst_event_parse_new_segment_full (event, &update, NULL, NULL, NULL, NULL,
3483 if (G_UNLIKELY (basesink->priv->received_eos && !update)) {
3484 /* we can't accept anything when we are EOS */
3486 gst_event_unref (event);
3488 /* the new segment is a non prerollable item and does not block anything,
3489 * we need to configure the current clipping segment and insert the event
3490 * in the queue to serialize it with the buffers for rendering. */
3491 gst_base_sink_configure_segment (basesink, pad, event,
3492 basesink->abidata.ABI.clip_segment);
3495 gst_base_sink_queue_object_unlocked (basesink, pad,
3496 _PR_IS_EVENT, GST_MINI_OBJECT_CAST (event), FALSE);
3497 if (G_UNLIKELY (ret != GST_FLOW_OK))
3500 GST_OBJECT_LOCK (basesink);
3501 basesink->have_newsegment = TRUE;
3502 GST_OBJECT_UNLOCK (basesink);
3505 GST_PAD_PREROLL_UNLOCK (pad);
3508 case GST_EVENT_FLUSH_START:
3510 bclass->event (basesink, event);
3512 GST_DEBUG_OBJECT (basesink, "flush-start %p", event);
3514 gst_base_sink_flush_start (basesink, pad);
3516 gst_event_unref (event);
3518 case GST_EVENT_FLUSH_STOP:
3520 bclass->event (basesink, event);
3522 GST_DEBUG_OBJECT (basesink, "flush-stop %p", event);
3524 gst_base_sink_flush_stop (basesink, pad);
3526 gst_event_unref (event);
3529 /* other events are sent to queue or subclass depending on if they
3530 * are serialized. */
3531 if (GST_EVENT_IS_SERIALIZED (event)) {
3532 gst_base_sink_queue_object (basesink, pad,
3533 GST_MINI_OBJECT_CAST (event), FALSE);
3536 bclass->event (basesink, event);
3537 gst_event_unref (event);
3542 gst_object_unref (basesink);
3549 GST_DEBUG_OBJECT (basesink, "we are flushing");
3550 GST_PAD_PREROLL_UNLOCK (pad);
3552 gst_event_unref (event);
3557 /* default implementation to calculate the start and end
3558 * timestamps on a buffer, subclasses can override
3561 gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
3562 GstClockTime * start, GstClockTime * end)
3564 GstClockTime timestamp, duration;
3566 timestamp = GST_BUFFER_TIMESTAMP (buffer);
3567 if (GST_CLOCK_TIME_IS_VALID (timestamp)) {
3569 /* get duration to calculate end time */
3570 duration = GST_BUFFER_DURATION (buffer);
3571 if (GST_CLOCK_TIME_IS_VALID (duration)) {
3572 *end = timestamp + duration;
3578 /* must be called with PREROLL_LOCK */
3580 gst_base_sink_needs_preroll (GstBaseSink * basesink)
3582 gboolean is_prerolled, res;
3584 /* we have 2 cases where the PREROLL_LOCK is released:
3585 * 1) we are blocking in the PREROLL_LOCK and thus are prerolled.
3586 * 2) we are syncing on the clock
3588 is_prerolled = basesink->have_preroll || basesink->priv->received_eos;
3589 res = !is_prerolled;
3591 GST_DEBUG_OBJECT (basesink, "have_preroll: %d, EOS: %d => needs preroll: %d",
3592 basesink->have_preroll, basesink->priv->received_eos, res);
3597 /* with STREAM_LOCK, PREROLL_LOCK
3599 * Takes a buffer and compare the timestamps with the last segment.
3600 * If the buffer falls outside of the segment boundaries, drop it.
3601 * Else queue the buffer for preroll and rendering.
3603 * This function takes ownership of the buffer.
3605 static GstFlowReturn
3606 gst_base_sink_chain_unlocked (GstBaseSink * basesink, GstPad * pad,
3607 guint8 obj_type, gpointer obj)
3609 GstBaseSinkClass *bclass;
3610 GstFlowReturn result;
3611 GstClockTime start = GST_CLOCK_TIME_NONE, end = GST_CLOCK_TIME_NONE;
3612 GstSegment *clip_segment;
3613 GstBuffer *time_buf;
3615 if (G_UNLIKELY (basesink->flushing))
3618 if (G_UNLIKELY (basesink->priv->received_eos))
3621 if (OBJ_IS_BUFFERLIST (obj_type)) {
3622 time_buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0, 0);
3623 g_assert (NULL != time_buf);
3625 time_buf = GST_BUFFER_CAST (obj);
3628 /* for code clarity */
3629 clip_segment = basesink->abidata.ABI.clip_segment;
3631 if (G_UNLIKELY (!basesink->have_newsegment)) {
3634 sync = gst_base_sink_get_sync (basesink);
3636 GST_ELEMENT_WARNING (basesink, STREAM, FAILED,
3637 (_("Internal data flow problem.")),
3638 ("Received buffer without a new-segment. Assuming timestamps start from 0."));
3641 /* this means this sink will assume timestamps start from 0 */
3642 GST_OBJECT_LOCK (basesink);
3643 clip_segment->start = 0;
3644 clip_segment->stop = -1;
3645 basesink->segment.start = 0;
3646 basesink->segment.stop = -1;
3647 basesink->have_newsegment = TRUE;
3648 GST_OBJECT_UNLOCK (basesink);
3651 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3653 /* check if the buffer needs to be dropped, we first ask the subclass for the
3655 if (bclass->get_times)
3656 bclass->get_times (basesink, time_buf, &start, &end);
3658 if (!GST_CLOCK_TIME_IS_VALID (start)) {
3659 /* if the subclass does not want sync, we use our own values so that we at
3660 * least clip the buffer to the segment */
3661 gst_base_sink_get_times (basesink, time_buf, &start, &end);
3664 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
3665 ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (end));
3667 /* a dropped buffer does not participate in anything */
3668 if (GST_CLOCK_TIME_IS_VALID (start) &&
3669 (clip_segment->format == GST_FORMAT_TIME)) {
3670 if (G_UNLIKELY (!gst_segment_clip (clip_segment,
3671 GST_FORMAT_TIME, (gint64) start, (gint64) end, NULL, NULL)))
3672 goto out_of_segment;
3675 /* now we can process the buffer in the queue, this function takes ownership
3677 result = gst_base_sink_queue_object_unlocked (basesink, pad,
3678 obj_type, obj, TRUE);
3684 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3685 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3686 return GST_FLOW_WRONG_STATE;
3690 GST_DEBUG_OBJECT (basesink,
3691 "we are EOS, dropping object, return UNEXPECTED");
3692 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3693 return GST_FLOW_UNEXPECTED;
3697 GST_DEBUG_OBJECT (basesink, "dropping buffer, out of clipping segment");
3698 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3705 static GstFlowReturn
3706 gst_base_sink_chain_main (GstBaseSink * basesink, GstPad * pad,
3707 guint8 obj_type, gpointer obj)
3709 GstFlowReturn result;
3711 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH))
3714 GST_PAD_PREROLL_LOCK (pad);
3715 result = gst_base_sink_chain_unlocked (basesink, pad, obj_type, obj);
3716 GST_PAD_PREROLL_UNLOCK (pad);
3724 GST_OBJECT_LOCK (pad);
3725 GST_WARNING_OBJECT (basesink,
3726 "Push on pad %s:%s, but it was not activated in push mode",
3727 GST_DEBUG_PAD_NAME (pad));
3728 GST_OBJECT_UNLOCK (pad);
3729 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3730 /* we don't post an error message this will signal to the peer
3731 * pushing that EOS is reached. */
3732 result = GST_FLOW_UNEXPECTED;
3737 static GstFlowReturn
3738 gst_base_sink_chain (GstPad * pad, GstBuffer * buf)
3740 GstBaseSink *basesink;
3742 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3744 return gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFER, buf);
3747 static GstFlowReturn
3748 gst_base_sink_chain_list (GstPad * pad, GstBufferList * list)
3750 GstBaseSink *basesink;
3751 GstBaseSinkClass *bclass;
3752 GstFlowReturn result;
3754 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3755 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3757 if (G_LIKELY (bclass->render_list)) {
3758 result = gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFERLIST, list);
3760 GstBufferListIterator *it;
3763 GST_INFO_OBJECT (pad, "chaining each group in list as a merged buffer");
3765 it = gst_buffer_list_iterate (list);
3767 if (gst_buffer_list_iterator_next_group (it)) {
3769 group = gst_buffer_list_iterator_merge_group (it);
3770 if (group == NULL) {
3771 group = gst_buffer_new ();
3772 GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining empty group");
3774 GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining group");
3776 result = gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFER, group);
3777 } while (result == GST_FLOW_OK
3778 && gst_buffer_list_iterator_next_group (it));
3780 GST_CAT_INFO_OBJECT (GST_CAT_SCHEDULING, pad, "chaining empty group");
3782 gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFER,
3785 gst_buffer_list_iterator_free (it);
3786 gst_buffer_list_unref (list);
3793 gst_base_sink_default_do_seek (GstBaseSink * sink, GstSegment * segment)
3795 gboolean res = TRUE;
3797 /* update our offset if the start/stop position was updated */
3798 if (segment->format == GST_FORMAT_BYTES) {
3799 segment->time = segment->start;
3800 } else if (segment->start == 0) {
3801 /* seek to start, we can implement a default for this. */
3805 GST_INFO_OBJECT (sink, "Can't do a default seek");
3811 #define SEEK_TYPE_IS_RELATIVE(t) (((t) != GST_SEEK_TYPE_NONE) && ((t) != GST_SEEK_TYPE_SET))
3814 gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
3815 GstEvent * event, GstSegment * segment)
3817 /* By default, we try one of 2 things:
3818 * - For absolute seek positions, convert the requested position to our
3819 * configured processing format and place it in the output segment \
3820 * - For relative seek positions, convert our current (input) values to the
3821 * seek format, adjust by the relative seek offset and then convert back to
3822 * the processing format
3824 GstSeekType cur_type, stop_type;
3827 GstFormat seek_format, dest_format;
3830 gboolean res = TRUE;
3832 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3833 &cur_type, &cur, &stop_type, &stop);
3834 dest_format = segment->format;
3836 if (seek_format == dest_format) {
3837 gst_segment_set_seek (segment, rate, seek_format, flags,
3838 cur_type, cur, stop_type, stop, &update);
3842 if (cur_type != GST_SEEK_TYPE_NONE) {
3843 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3845 gst_pad_query_convert (sink->sinkpad, seek_format, cur, &dest_format,
3847 cur_type = GST_SEEK_TYPE_SET;
3850 if (res && stop_type != GST_SEEK_TYPE_NONE) {
3851 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3853 gst_pad_query_convert (sink->sinkpad, seek_format, stop, &dest_format,
3855 stop_type = GST_SEEK_TYPE_SET;
3858 /* And finally, configure our output segment in the desired format */
3859 gst_segment_set_seek (segment, rate, dest_format, flags, cur_type, cur,
3860 stop_type, stop, &update);
3869 GST_DEBUG_OBJECT (sink, "undefined format given, seek aborted.");
3874 /* perform a seek, only executed in pull mode */
3876 gst_base_sink_perform_seek (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3880 GstFormat seek_format, dest_format;
3882 GstSeekType cur_type, stop_type;
3883 gboolean seekseg_configured = FALSE;
3885 gboolean update, res = TRUE;
3886 GstSegment seeksegment;
3888 dest_format = sink->segment.format;
3891 GST_DEBUG_OBJECT (sink, "performing seek with event %p", event);
3892 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3893 &cur_type, &cur, &stop_type, &stop);
3895 flush = flags & GST_SEEK_FLAG_FLUSH;
3897 GST_DEBUG_OBJECT (sink, "performing seek without event");
3902 GST_DEBUG_OBJECT (sink, "flushing upstream");
3903 gst_pad_push_event (pad, gst_event_new_flush_start ());
3904 gst_base_sink_flush_start (sink, pad);
3906 GST_DEBUG_OBJECT (sink, "pausing pulling thread");
3909 GST_PAD_STREAM_LOCK (pad);
3911 /* If we configured the seeksegment above, don't overwrite it now. Otherwise
3912 * copy the current segment info into the temp segment that we can actually
3913 * attempt the seek with. We only update the real segment if the seek succeeds. */
3914 if (!seekseg_configured) {
3915 memcpy (&seeksegment, &sink->segment, sizeof (GstSegment));
3917 /* now configure the final seek segment */
3919 if (sink->segment.format != seek_format) {
3920 /* OK, here's where we give the subclass a chance to convert the relative
3921 * seek into an absolute one in the processing format. We set up any
3922 * absolute seek above, before taking the stream lock. */
3923 if (!gst_base_sink_default_prepare_seek_segment (sink, event,
3925 GST_DEBUG_OBJECT (sink,
3926 "Preparing the seek failed after flushing. " "Aborting seek");
3930 /* The seek format matches our processing format, no need to ask the
3931 * the subclass to configure the segment. */
3932 gst_segment_set_seek (&seeksegment, rate, seek_format, flags,
3933 cur_type, cur, stop_type, stop, &update);
3936 /* Else, no seek event passed, so we're just (re)starting the
3941 GST_DEBUG_OBJECT (sink, "segment configured from %" G_GINT64_FORMAT
3942 " to %" G_GINT64_FORMAT ", position %" G_GINT64_FORMAT,
3943 seeksegment.start, seeksegment.stop, seeksegment.last_stop);
3945 /* do the seek, segment.last_stop contains the new position. */
3946 res = gst_base_sink_default_do_seek (sink, &seeksegment);
3951 GST_DEBUG_OBJECT (sink, "stop flushing upstream");
3952 gst_pad_push_event (pad, gst_event_new_flush_stop ());
3953 gst_base_sink_flush_stop (sink, pad);
3954 } else if (res && sink->abidata.ABI.running) {
3955 /* we are running the current segment and doing a non-flushing seek,
3956 * close the segment first based on the last_stop. */
3957 GST_DEBUG_OBJECT (sink, "closing running segment %" G_GINT64_FORMAT
3958 " to %" G_GINT64_FORMAT, sink->segment.start, sink->segment.last_stop);
3961 /* The subclass must have converted the segment to the processing format
3963 if (res && seeksegment.format != dest_format) {
3964 GST_DEBUG_OBJECT (sink, "Subclass failed to prepare a seek segment "
3965 "in the correct format. Aborting seek.");
3969 /* if successful seek, we update our real segment and push
3970 * out the new segment. */
3972 memcpy (&sink->segment, &seeksegment, sizeof (GstSegment));
3974 if (sink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3975 gst_element_post_message (GST_ELEMENT (sink),
3976 gst_message_new_segment_start (GST_OBJECT (sink),
3977 sink->segment.format, sink->segment.last_stop));
3981 sink->priv->discont = TRUE;
3982 sink->abidata.ABI.running = TRUE;
3984 GST_PAD_STREAM_UNLOCK (pad);
3990 set_step_info (GstBaseSink * sink, GstStepInfo * current, GstStepInfo * pending,
3991 guint seqnum, GstFormat format, guint64 amount, gdouble rate,
3992 gboolean flush, gboolean intermediate)
3994 GST_OBJECT_LOCK (sink);
3995 pending->seqnum = seqnum;
3996 pending->format = format;
3997 pending->amount = amount;
3998 pending->position = 0;
3999 pending->rate = rate;
4000 pending->flush = flush;
4001 pending->intermediate = intermediate;
4002 pending->valid = TRUE;
4003 /* flush invalidates the current stepping segment */
4005 current->valid = FALSE;
4006 GST_OBJECT_UNLOCK (sink);
4010 gst_base_sink_perform_step (GstBaseSink * sink, GstPad * pad, GstEvent * event)
4012 GstBaseSinkPrivate *priv;
4013 GstBaseSinkClass *bclass;
4014 gboolean flush, intermediate;
4019 GstStepInfo *pending, *current;
4020 GstMessage *message;
4022 bclass = GST_BASE_SINK_GET_CLASS (sink);
4025 GST_DEBUG_OBJECT (sink, "performing step with event %p", event);
4027 gst_event_parse_step (event, &format, &amount, &rate, &flush, &intermediate);
4028 seqnum = gst_event_get_seqnum (event);
4030 pending = &priv->pending_step;
4031 current = &priv->current_step;
4033 /* post message first */
4034 message = gst_message_new_step_start (GST_OBJECT (sink), FALSE, format,
4035 amount, rate, flush, intermediate);
4036 gst_message_set_seqnum (message, seqnum);
4037 gst_element_post_message (GST_ELEMENT (sink), message);
4040 /* we need to call ::unlock before locking PREROLL_LOCK
4041 * since we lock it before going into ::render */
4043 bclass->unlock (sink);
4045 GST_PAD_PREROLL_LOCK (sink->sinkpad);
4046 /* now that we have the PREROLL lock, clear our unlock request */
4047 if (bclass->unlock_stop)
4048 bclass->unlock_stop (sink);
4050 /* update the stepinfo and make it valid */
4051 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
4054 if (sink->priv->async_enabled) {
4055 /* and we need to commit our state again on the next
4056 * prerolled buffer */
4057 sink->playing_async = TRUE;
4058 priv->pending_step.need_preroll = TRUE;
4059 sink->need_preroll = FALSE;
4060 gst_element_lost_state_full (GST_ELEMENT_CAST (sink), FALSE);
4062 sink->priv->have_latency = TRUE;
4063 sink->need_preroll = FALSE;
4065 priv->current_sstart = GST_CLOCK_TIME_NONE;
4066 priv->current_sstop = GST_CLOCK_TIME_NONE;
4067 priv->eos_rtime = GST_CLOCK_TIME_NONE;
4068 priv->call_preroll = TRUE;
4069 gst_base_sink_set_last_buffer (sink, NULL);
4070 gst_base_sink_reset_qos (sink);
4072 if (sink->clock_id) {
4073 gst_clock_id_unschedule (sink->clock_id);
4076 if (sink->have_preroll) {
4077 GST_DEBUG_OBJECT (sink, "signal waiter");
4078 priv->step_unlock = TRUE;
4079 GST_PAD_PREROLL_SIGNAL (sink->sinkpad);
4081 GST_PAD_PREROLL_UNLOCK (sink->sinkpad);
4083 /* update the stepinfo and make it valid */
4084 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
4094 gst_base_sink_loop (GstPad * pad)
4096 GstBaseSink *basesink;
4097 GstBuffer *buf = NULL;
4098 GstFlowReturn result;
4102 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
4104 g_assert (basesink->pad_mode == GST_ACTIVATE_PULL);
4106 if ((blocksize = basesink->priv->blocksize) == 0)
4109 offset = basesink->segment.last_stop;
4111 GST_DEBUG_OBJECT (basesink, "pulling %" G_GUINT64_FORMAT ", %u",
4114 result = gst_pad_pull_range (pad, offset, blocksize, &buf);
4115 if (G_UNLIKELY (result != GST_FLOW_OK))
4118 if (G_UNLIKELY (buf == NULL))
4121 offset += GST_BUFFER_SIZE (buf);
4123 gst_segment_set_last_stop (&basesink->segment, GST_FORMAT_BYTES, offset);
4125 GST_PAD_PREROLL_LOCK (pad);
4126 result = gst_base_sink_chain_unlocked (basesink, pad, _PR_IS_BUFFER, buf);
4127 GST_PAD_PREROLL_UNLOCK (pad);
4128 if (G_UNLIKELY (result != GST_FLOW_OK))
4136 GST_LOG_OBJECT (basesink, "pausing task, reason %s",
4137 gst_flow_get_name (result));
4138 gst_pad_pause_task (pad);
4139 if (result == GST_FLOW_UNEXPECTED) {
4140 /* perform EOS logic */
4141 if (basesink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
4142 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4143 gst_message_new_segment_done (GST_OBJECT_CAST (basesink),
4144 basesink->segment.format, basesink->segment.last_stop));
4146 gst_base_sink_event (pad, gst_event_new_eos ());
4148 } else if (result == GST_FLOW_NOT_LINKED || result <= GST_FLOW_UNEXPECTED) {
4149 /* for fatal errors we post an error message, post the error
4150 * first so the app knows about the error first.
4151 * wrong-state is not a fatal error because it happens due to
4152 * flushing and posting an error message in that case is the
4153 * wrong thing to do, e.g. when basesrc is doing a flushing
4155 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
4156 (_("Internal data stream error.")),
4157 ("stream stopped, reason %s", gst_flow_get_name (result)));
4158 gst_base_sink_event (pad, gst_event_new_eos ());
4164 GST_LOG_OBJECT (basesink, "no buffer, pausing");
4165 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
4166 (_("Internal data flow error.")), ("element returned NULL buffer"));
4167 result = GST_FLOW_ERROR;
4173 gst_base_sink_set_flushing (GstBaseSink * basesink, GstPad * pad,
4176 GstBaseSinkClass *bclass;
4178 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4181 /* unlock any subclasses, we need to do this before grabbing the
4182 * PREROLL_LOCK since we hold this lock before going into ::render. */
4184 bclass->unlock (basesink);
4187 GST_PAD_PREROLL_LOCK (pad);
4188 basesink->flushing = flushing;
4190 /* step 1, now that we have the PREROLL lock, clear our unlock request */
4191 if (bclass->unlock_stop)
4192 bclass->unlock_stop (basesink);
4194 /* set need_preroll before we unblock the clock. If the clock is unblocked
4195 * before timing out, we can reuse the buffer for preroll. */
4196 basesink->need_preroll = TRUE;
4198 /* step 2, unblock clock sync (if any) or any other blocking thing */
4199 if (basesink->clock_id) {
4200 gst_clock_id_unschedule (basesink->clock_id);
4203 /* flush out the data thread if it's locked in finish_preroll, this will
4204 * also flush out the EOS state */
4205 GST_DEBUG_OBJECT (basesink,
4206 "flushing out data thread, need preroll to TRUE");
4207 gst_base_sink_preroll_queue_flush (basesink, pad);
4209 GST_PAD_PREROLL_UNLOCK (pad);
4215 gst_base_sink_default_activate_pull (GstBaseSink * basesink, gboolean active)
4221 result = gst_pad_start_task (basesink->sinkpad,
4222 (GstTaskFunction) gst_base_sink_loop, basesink->sinkpad);
4224 /* step 2, make sure streaming finishes */
4225 result = gst_pad_stop_task (basesink->sinkpad);
4232 gst_base_sink_pad_activate (GstPad * pad)
4234 gboolean result = FALSE;
4235 GstBaseSink *basesink;
4237 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4239 GST_DEBUG_OBJECT (basesink, "Trying pull mode first");
4241 gst_base_sink_set_flushing (basesink, pad, FALSE);
4243 /* we need to have the pull mode enabled */
4244 if (!basesink->can_activate_pull) {
4245 GST_DEBUG_OBJECT (basesink, "pull mode disabled");
4249 /* check if downstreams supports pull mode at all */
4250 if (!gst_pad_check_pull_range (pad)) {
4251 GST_DEBUG_OBJECT (basesink, "pull mode not supported");
4255 /* set the pad mode before starting the task so that it's in the
4256 * correct state for the new thread. also the sink set_caps and get_caps
4257 * function checks this */
4258 basesink->pad_mode = GST_ACTIVATE_PULL;
4260 /* we first try to negotiate a format so that when we try to activate
4261 * downstream, it knows about our format */
4262 if (!gst_base_sink_negotiate_pull (basesink)) {
4263 GST_DEBUG_OBJECT (basesink, "failed to negotiate in pull mode");
4267 /* ok activate now */
4268 if (!gst_pad_activate_pull (pad, TRUE)) {
4269 /* clear any pending caps */
4270 GST_OBJECT_LOCK (basesink);
4271 gst_caps_replace (&basesink->priv->pull_caps, NULL);
4272 GST_OBJECT_UNLOCK (basesink);
4273 GST_DEBUG_OBJECT (basesink, "failed to activate in pull mode");
4277 GST_DEBUG_OBJECT (basesink, "Success activating pull mode");
4281 /* push mode fallback */
4283 GST_DEBUG_OBJECT (basesink, "Falling back to push mode");
4284 if ((result = gst_pad_activate_push (pad, TRUE))) {
4285 GST_DEBUG_OBJECT (basesink, "Success activating push mode");
4290 GST_WARNING_OBJECT (basesink, "Could not activate pad in either mode");
4291 gst_base_sink_set_flushing (basesink, pad, TRUE);
4294 gst_object_unref (basesink);
4300 gst_base_sink_pad_activate_push (GstPad * pad, gboolean active)
4303 GstBaseSink *basesink;
4305 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4308 if (!basesink->can_activate_push) {
4310 basesink->pad_mode = GST_ACTIVATE_NONE;
4313 basesink->pad_mode = GST_ACTIVATE_PUSH;
4316 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH)) {
4317 g_warning ("Internal GStreamer activation error!!!");
4320 gst_base_sink_set_flushing (basesink, pad, TRUE);
4322 basesink->pad_mode = GST_ACTIVATE_NONE;
4326 gst_object_unref (basesink);
4332 gst_base_sink_negotiate_pull (GstBaseSink * basesink)
4339 /* this returns the intersection between our caps and the peer caps. If there
4340 * is no peer, it returns NULL and we can't operate in pull mode so we can
4341 * fail the negotiation. */
4342 caps = gst_pad_get_allowed_caps (GST_BASE_SINK_PAD (basesink));
4343 if (caps == NULL || gst_caps_is_empty (caps))
4344 goto no_caps_possible;
4346 GST_DEBUG_OBJECT (basesink, "allowed caps: %" GST_PTR_FORMAT, caps);
4348 caps = gst_caps_make_writable (caps);
4349 /* get the first (preferred) format */
4350 gst_caps_truncate (caps);
4352 gst_pad_fixate_caps (GST_BASE_SINK_PAD (basesink), caps);
4354 GST_DEBUG_OBJECT (basesink, "fixated to: %" GST_PTR_FORMAT, caps);
4356 if (gst_caps_is_any (caps)) {
4357 GST_DEBUG_OBJECT (basesink, "caps were ANY after fixating, "
4359 /* neither side has template caps in this case, so they are prepared for
4360 pull() without setcaps() */
4362 } else if (gst_caps_is_fixed (caps)) {
4363 if (!gst_pad_set_caps (GST_BASE_SINK_PAD (basesink), caps))
4364 goto could_not_set_caps;
4366 GST_OBJECT_LOCK (basesink);
4367 gst_caps_replace (&basesink->priv->pull_caps, caps);
4368 GST_OBJECT_UNLOCK (basesink);
4373 gst_caps_unref (caps);
4379 GST_INFO_OBJECT (basesink, "Pipeline could not agree on caps");
4380 GST_DEBUG_OBJECT (basesink, "get_allowed_caps() returned EMPTY");
4382 gst_caps_unref (caps);
4387 GST_INFO_OBJECT (basesink, "Could not set caps: %" GST_PTR_FORMAT, caps);
4388 gst_caps_unref (caps);
4393 /* this won't get called until we implement an activate function */
4395 gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active)
4397 gboolean result = FALSE;
4398 GstBaseSink *basesink;
4399 GstBaseSinkClass *bclass;
4401 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4402 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4408 /* we mark we have a newsegment here because pull based
4409 * mode works just fine without having a newsegment before the
4411 format = GST_FORMAT_BYTES;
4413 gst_segment_init (&basesink->segment, format);
4414 gst_segment_init (basesink->abidata.ABI.clip_segment, format);
4415 GST_OBJECT_LOCK (basesink);
4416 basesink->have_newsegment = TRUE;
4417 GST_OBJECT_UNLOCK (basesink);
4419 /* get the peer duration in bytes */
4420 result = gst_pad_query_peer_duration (pad, &format, &duration);
4422 GST_DEBUG_OBJECT (basesink,
4423 "setting duration in bytes to %" G_GINT64_FORMAT, duration);
4424 gst_segment_set_duration (basesink->abidata.ABI.clip_segment, format,
4426 gst_segment_set_duration (&basesink->segment, format, duration);
4428 GST_DEBUG_OBJECT (basesink, "unknown duration");
4431 if (bclass->activate_pull)
4432 result = bclass->activate_pull (basesink, TRUE);
4437 goto activate_failed;
4440 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PULL)) {
4441 g_warning ("Internal GStreamer activation error!!!");
4444 result = gst_base_sink_set_flushing (basesink, pad, TRUE);
4445 if (bclass->activate_pull)
4446 result &= bclass->activate_pull (basesink, FALSE);
4447 basesink->pad_mode = GST_ACTIVATE_NONE;
4448 /* clear any pending caps */
4449 GST_OBJECT_LOCK (basesink);
4450 gst_caps_replace (&basesink->priv->pull_caps, NULL);
4451 GST_OBJECT_UNLOCK (basesink);
4454 gst_object_unref (basesink);
4461 /* reset, as starting the thread failed */
4462 basesink->pad_mode = GST_ACTIVATE_NONE;
4464 GST_ERROR_OBJECT (basesink, "subclass failed to activate in pull mode");
4469 /* send an event to our sinkpad peer. */
4471 gst_base_sink_send_event (GstElement * element, GstEvent * event)
4474 GstBaseSink *basesink = GST_BASE_SINK (element);
4475 gboolean forward, result = TRUE;
4476 GstActivateMode mode;
4478 GST_OBJECT_LOCK (element);
4479 /* get the pad and the scheduling mode */
4480 pad = gst_object_ref (basesink->sinkpad);
4481 mode = basesink->pad_mode;
4482 GST_OBJECT_UNLOCK (element);
4484 /* only push UPSTREAM events upstream */
4485 forward = GST_EVENT_IS_UPSTREAM (event);
4487 GST_DEBUG_OBJECT (basesink, "handling event %p %" GST_PTR_FORMAT, event,
4490 switch (GST_EVENT_TYPE (event)) {
4491 case GST_EVENT_LATENCY:
4493 GstClockTime latency;
4495 gst_event_parse_latency (event, &latency);
4497 /* store the latency. We use this to adjust the running_time before syncing
4498 * it to the clock. */
4499 GST_OBJECT_LOCK (element);
4500 basesink->priv->latency = latency;
4501 if (!basesink->priv->have_latency)
4503 GST_OBJECT_UNLOCK (element);
4504 GST_DEBUG_OBJECT (basesink, "latency set to %" GST_TIME_FORMAT,
4505 GST_TIME_ARGS (latency));
4507 /* We forward this event so that all elements know about the global pipeline
4508 * latency. This is interesting for an element when it wants to figure out
4509 * when a particular piece of data will be rendered. */
4512 case GST_EVENT_SEEK:
4513 /* in pull mode we will execute the seek */
4514 if (mode == GST_ACTIVATE_PULL)
4515 result = gst_base_sink_perform_seek (basesink, pad, event);
4517 case GST_EVENT_STEP:
4518 result = gst_base_sink_perform_step (basesink, pad, event);
4526 result = gst_pad_push_event (pad, event);
4528 /* not forwarded, unref the event */
4529 gst_event_unref (event);
4532 gst_object_unref (pad);
4534 GST_DEBUG_OBJECT (basesink, "handled event %p %" GST_PTR_FORMAT ": %d", event,
4541 gst_base_sink_get_position (GstBaseSink * basesink, GstFormat format,
4542 gint64 * cur, gboolean * upstream)
4544 GstClock *clock = NULL;
4545 gboolean res = FALSE;
4546 GstFormat oformat, tformat;
4547 GstSegment *segment;
4548 GstClockTime now, latency;
4549 GstClockTimeDiff base;
4550 gint64 time, accum, duration;
4553 gboolean last_seen, with_clock, in_paused;
4555 GST_OBJECT_LOCK (basesink);
4556 /* we can only get the segment when we are not NULL or READY */
4557 if (!basesink->have_newsegment)
4561 /* when not in PLAYING or when we're busy with a state change, we
4562 * cannot read from the clock so we report time based on the
4563 * last seen timestamp. */
4564 if (GST_STATE (basesink) != GST_STATE_PLAYING ||
4565 GST_STATE_PENDING (basesink) != GST_STATE_VOID_PENDING) {
4569 /* we don't use the clip segment in pull mode, when seeking we update the
4570 * main segment directly with the new segment values without it having to be
4571 * activated by the rendering after preroll */
4572 if (basesink->pad_mode == GST_ACTIVATE_PUSH)
4573 segment = basesink->abidata.ABI.clip_segment;
4575 segment = &basesink->segment;
4577 /* our intermediate time format */
4578 tformat = GST_FORMAT_TIME;
4579 /* get the format in the segment */
4580 oformat = segment->format;
4582 /* report with last seen position when EOS */
4583 last_seen = basesink->eos;
4585 /* assume we will use the clock for getting the current position */
4587 if (basesink->sync == FALSE)
4590 /* and we need a clock */
4591 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (basesink)) == NULL))
4594 gst_object_ref (clock);
4596 /* mainloop might be querying position when going to playing async,
4597 * while (audio) rendering might be quickly advancing stream position,
4598 * so use clock asap rather than last reported position */
4599 if (in_paused && with_clock && g_atomic_int_get (&basesink->priv->to_playing)) {
4600 GST_DEBUG_OBJECT (basesink, "going to PLAYING, so not PAUSED");
4604 /* collect all data we need holding the lock */
4605 if (GST_CLOCK_TIME_IS_VALID (segment->time))
4606 time = segment->time;
4610 if (GST_CLOCK_TIME_IS_VALID (segment->stop))
4611 duration = segment->stop - segment->start;
4615 accum = segment->accum;
4616 rate = segment->rate * segment->applied_rate;
4617 latency = basesink->priv->latency;
4619 if (oformat == GST_FORMAT_TIME) {
4622 start = basesink->priv->current_sstart;
4623 stop = basesink->priv->current_sstop;
4626 /* in paused we use the last position as a lower bound */
4627 if (stop == -1 || segment->rate > 0.0)
4632 /* in playing, use last stop time as upper bound */
4633 if (start == -1 || segment->rate > 0.0)
4639 /* convert last stop to stream time */
4640 last = gst_segment_to_stream_time (segment, oformat, segment->last_stop);
4644 /* in paused, use start_time */
4645 base = GST_ELEMENT_START_TIME (basesink);
4646 GST_DEBUG_OBJECT (basesink, "in paused, using start time %" GST_TIME_FORMAT,
4647 GST_TIME_ARGS (base));
4648 } else if (with_clock) {
4649 /* else use clock when needed */
4650 base = GST_ELEMENT_CAST (basesink)->base_time;
4651 GST_DEBUG_OBJECT (basesink, "using clock and base time %" GST_TIME_FORMAT,
4652 GST_TIME_ARGS (base));
4654 /* else, no sync or clock -> no base time */
4655 GST_DEBUG_OBJECT (basesink, "no sync or no clock");
4659 /* no base, we can't calculate running_time, use last seem timestamp to report
4664 /* need to release the object lock before we can get the time,
4665 * a clock might take the LOCK of the provider, which could be
4666 * a basesink subclass. */
4667 GST_OBJECT_UNLOCK (basesink);
4670 /* in EOS or when no valid stream_time, report the value of last seen
4673 /* no timestamp, we need to ask upstream */
4674 GST_DEBUG_OBJECT (basesink, "no last seen timestamp, asking upstream");
4679 GST_DEBUG_OBJECT (basesink, "using last seen timestamp %" GST_TIME_FORMAT,
4680 GST_TIME_ARGS (last));
4683 if (oformat != tformat) {
4684 /* convert accum, time and duration to time */
4685 if (!gst_pad_query_convert (basesink->sinkpad, oformat, accum, &tformat,
4687 goto convert_failed;
4688 if (!gst_pad_query_convert (basesink->sinkpad, oformat, duration,
4689 &tformat, &duration))
4690 goto convert_failed;
4691 if (!gst_pad_query_convert (basesink->sinkpad, oformat, time, &tformat,
4693 goto convert_failed;
4694 if (!gst_pad_query_convert (basesink->sinkpad, oformat, last, &tformat,
4696 goto convert_failed;
4698 /* assume time format from now on */
4702 if (!in_paused && with_clock) {
4703 now = gst_clock_get_time (clock);
4709 /* subtract base time and accumulated time from the clock time.
4710 * Make sure we don't go negative. This is the current time in
4711 * the segment which we need to scale with the combined
4712 * rate and applied rate. */
4715 if (GST_CLOCK_DIFF (base, now) < 0)
4718 /* for negative rates we need to count back from the segment
4723 *cur = time + gst_guint64_to_gdouble (now - base) * rate;
4726 /* never report less than segment values in paused */
4728 *cur = MAX (last, *cur);
4730 /* never report more than last seen position in playing */
4732 *cur = MIN (last, *cur);
4735 GST_DEBUG_OBJECT (basesink,
4736 "now %" GST_TIME_FORMAT " - base %" GST_TIME_FORMAT " - accum %"
4737 GST_TIME_FORMAT " + time %" GST_TIME_FORMAT " last %" GST_TIME_FORMAT,
4738 GST_TIME_ARGS (now), GST_TIME_ARGS (base), GST_TIME_ARGS (accum),
4739 GST_TIME_ARGS (time), GST_TIME_ARGS (last));
4742 if (oformat != format) {
4743 /* convert to final format */
4744 if (!gst_pad_query_convert (basesink->sinkpad, oformat, *cur, &format, cur))
4745 goto convert_failed;
4751 GST_DEBUG_OBJECT (basesink, "res: %d, POSITION: %" GST_TIME_FORMAT,
4752 res, GST_TIME_ARGS (*cur));
4755 gst_object_unref (clock);
4762 /* in NULL or READY we always return FALSE and -1 */
4763 GST_DEBUG_OBJECT (basesink, "position in wrong state, return -1");
4766 GST_OBJECT_UNLOCK (basesink);
4771 GST_DEBUG_OBJECT (basesink, "convert failed, try upstream");
4779 gst_base_sink_get_duration (GstBaseSink * basesink, GstFormat format,
4780 gint64 * dur, gboolean * upstream)
4782 gboolean res = FALSE;
4784 if (basesink->pad_mode == GST_ACTIVATE_PULL) {
4785 GstFormat uformat = GST_FORMAT_BYTES;
4788 /* get the duration in bytes, in pull mode that's all we are sure to
4789 * know. We have to explicitly get this value from upstream instead of
4790 * using our cached value because it might change. Duration caching
4791 * should be done at a higher level. */
4792 res = gst_pad_query_peer_duration (basesink->sinkpad, &uformat, &uduration);
4794 gst_segment_set_duration (&basesink->segment, uformat, uduration);
4795 if (format != uformat) {
4796 /* convert to the requested format */
4797 res = gst_pad_query_convert (basesink->sinkpad, uformat, uduration,
4811 static const GstQueryType *
4812 gst_base_sink_get_query_types (GstElement * element)
4814 static const GstQueryType query_types[] = {
4826 default_element_query (GstElement * element, GstQuery * query)
4828 gboolean res = FALSE;
4830 GstBaseSink *basesink = GST_BASE_SINK (element);
4832 switch (GST_QUERY_TYPE (query)) {
4833 case GST_QUERY_POSITION:
4837 gboolean upstream = FALSE;
4839 gst_query_parse_position (query, &format, NULL);
4841 GST_DEBUG_OBJECT (basesink, "position query in format %s",
4842 gst_format_get_name (format));
4844 /* first try to get the position based on the clock */
4846 gst_base_sink_get_position (basesink, format, &cur, &upstream))) {
4847 gst_query_set_position (query, format, cur);
4848 } else if (upstream) {
4849 /* fallback to peer query */
4850 res = gst_pad_peer_query (basesink->sinkpad, query);
4853 /* we can handle a few things if upstream failed */
4854 if (format == GST_FORMAT_PERCENT) {
4856 GstFormat uformat = GST_FORMAT_TIME;
4858 res = gst_base_sink_get_position (basesink, GST_FORMAT_TIME, &cur,
4860 if (!res && upstream) {
4861 res = gst_pad_query_peer_position (basesink->sinkpad, &uformat,
4865 res = gst_base_sink_get_duration (basesink, GST_FORMAT_TIME, &dur,
4867 if (!res && upstream) {
4868 res = gst_pad_query_peer_duration (basesink->sinkpad, &uformat,
4875 pos = gst_util_uint64_scale (100 * GST_FORMAT_PERCENT_SCALE, cur,
4877 gst_query_set_position (query, GST_FORMAT_PERCENT, pos);
4883 case GST_QUERY_DURATION:
4887 gboolean upstream = FALSE;
4889 gst_query_parse_duration (query, &format, NULL);
4891 GST_DEBUG_OBJECT (basesink, "duration query in format %s",
4892 gst_format_get_name (format));
4895 gst_base_sink_get_duration (basesink, format, &dur, &upstream))) {
4896 gst_query_set_duration (query, format, dur);
4897 } else if (upstream) {
4898 /* fallback to peer query */
4899 res = gst_pad_peer_query (basesink->sinkpad, query);
4902 /* we can handle a few things if upstream failed */
4903 if (format == GST_FORMAT_PERCENT) {
4904 gst_query_set_duration (query, GST_FORMAT_PERCENT,
4905 GST_FORMAT_PERCENT_MAX);
4911 case GST_QUERY_LATENCY:
4913 gboolean live, us_live;
4914 GstClockTime min, max;
4916 if ((res = gst_base_sink_query_latency (basesink, &live, &us_live, &min,
4918 gst_query_set_latency (query, live, min, max);
4922 case GST_QUERY_JITTER:
4924 case GST_QUERY_RATE:
4925 /* gst_query_set_rate (query, basesink->segment_rate); */
4928 case GST_QUERY_SEGMENT:
4930 if (basesink->pad_mode == GST_ACTIVATE_PULL) {
4931 gst_query_set_segment (query, basesink->segment.rate,
4932 GST_FORMAT_TIME, basesink->segment.start, basesink->segment.stop);
4935 res = gst_pad_peer_query (basesink->sinkpad, query);
4939 case GST_QUERY_SEEKING:
4940 case GST_QUERY_CONVERT:
4941 case GST_QUERY_FORMATS:
4943 res = gst_pad_peer_query (basesink->sinkpad, query);
4946 GST_DEBUG_OBJECT (basesink, "query %s returns %d",
4947 GST_QUERY_TYPE_NAME (query), res);
4952 default_sink_query (GstBaseSink * basesink, GstQuery * query)
4954 return gst_pad_query_default (basesink->sinkpad, query);
4958 gst_base_sink_sink_query (GstPad * pad, GstQuery * query)
4960 GstBaseSink *basesink;
4961 GstBaseSinkClass *bclass;
4964 basesink = GST_BASE_SINK_CAST (gst_pad_get_parent (pad));
4965 if (G_UNLIKELY (basesink == NULL)) {
4966 gst_query_unref (query);
4970 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4973 res = bclass->query (basesink, query);
4977 gst_object_unref (basesink);
4982 static GstStateChangeReturn
4983 gst_base_sink_change_state (GstElement * element, GstStateChange transition)
4985 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
4986 GstBaseSink *basesink = GST_BASE_SINK (element);
4987 GstBaseSinkClass *bclass;
4988 GstBaseSinkPrivate *priv;
4990 priv = basesink->priv;
4992 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4994 switch (transition) {
4995 case GST_STATE_CHANGE_NULL_TO_READY:
4997 if (!bclass->start (basesink))
5000 case GST_STATE_CHANGE_READY_TO_PAUSED:
5001 /* need to complete preroll before this state change completes, there
5002 * is no data flow in READY so we can safely assume we need to preroll. */
5003 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
5004 GST_DEBUG_OBJECT (basesink, "READY to PAUSED");
5005 basesink->have_newsegment = FALSE;
5006 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
5007 gst_segment_init (basesink->abidata.ABI.clip_segment,
5008 GST_FORMAT_UNDEFINED);
5009 basesink->offset = 0;
5010 basesink->have_preroll = FALSE;
5011 priv->step_unlock = FALSE;
5012 basesink->need_preroll = TRUE;
5013 basesink->playing_async = TRUE;
5014 priv->current_sstart = GST_CLOCK_TIME_NONE;
5015 priv->current_sstop = GST_CLOCK_TIME_NONE;
5016 priv->eos_rtime = GST_CLOCK_TIME_NONE;
5018 basesink->eos = FALSE;
5019 priv->received_eos = FALSE;
5020 gst_base_sink_reset_qos (basesink);
5021 priv->commited = FALSE;
5022 priv->call_preroll = TRUE;
5023 priv->current_step.valid = FALSE;
5024 priv->pending_step.valid = FALSE;
5025 if (priv->async_enabled) {
5026 GST_DEBUG_OBJECT (basesink, "doing async state change");
5027 /* when async enabled, post async-start message and return ASYNC from
5028 * the state change function */
5029 ret = GST_STATE_CHANGE_ASYNC;
5030 gst_element_post_message (GST_ELEMENT_CAST (basesink),
5031 gst_message_new_async_start (GST_OBJECT_CAST (basesink), FALSE));
5033 priv->have_latency = TRUE;
5035 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
5037 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
5038 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
5039 g_atomic_int_set (&basesink->priv->to_playing, TRUE);
5040 if (!gst_base_sink_needs_preroll (basesink)) {
5041 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, don't need preroll");
5042 /* no preroll needed anymore now. */
5043 basesink->playing_async = FALSE;
5044 basesink->need_preroll = FALSE;
5045 if (basesink->eos) {
5046 GstMessage *message;
5048 /* need to post EOS message here */
5049 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
5050 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
5051 gst_message_set_seqnum (message, basesink->priv->seqnum);
5052 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
5054 GST_DEBUG_OBJECT (basesink, "signal preroll");
5055 GST_PAD_PREROLL_SIGNAL (basesink->sinkpad);
5058 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, we are not prerolled");
5059 basesink->need_preroll = TRUE;
5060 basesink->playing_async = TRUE;
5061 priv->call_preroll = TRUE;
5062 priv->commited = FALSE;
5063 if (priv->async_enabled) {
5064 GST_DEBUG_OBJECT (basesink, "doing async state change");
5065 ret = GST_STATE_CHANGE_ASYNC;
5066 gst_element_post_message (GST_ELEMENT_CAST (basesink),
5067 gst_message_new_async_start (GST_OBJECT_CAST (basesink), FALSE));
5070 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
5077 GstStateChangeReturn bret;
5079 bret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
5080 if (G_UNLIKELY (bret == GST_STATE_CHANGE_FAILURE))
5081 goto activate_failed;
5084 switch (transition) {
5085 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
5086 /* completed transition, so need not be marked any longer
5087 * And it should be unmarked, since e.g. losing our position upon flush
5088 * does not really change state to PAUSED ... */
5089 g_atomic_int_set (&basesink->priv->to_playing, FALSE);
5091 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
5092 g_atomic_int_set (&basesink->priv->to_playing, FALSE);
5093 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED");
5094 /* FIXME, make sure we cannot enter _render first */
5096 /* we need to call ::unlock before locking PREROLL_LOCK
5097 * since we lock it before going into ::render */
5099 bclass->unlock (basesink);
5101 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
5102 GST_DEBUG_OBJECT (basesink, "got preroll lock");
5103 /* now that we have the PREROLL lock, clear our unlock request */
5104 if (bclass->unlock_stop)
5105 bclass->unlock_stop (basesink);
5107 /* we need preroll again and we set the flag before unlocking the clockid
5108 * because if the clockid is unlocked before a current buffer expired, we
5109 * can use that buffer to preroll with */
5110 basesink->need_preroll = TRUE;
5112 if (basesink->clock_id) {
5113 GST_DEBUG_OBJECT (basesink, "unschedule clock");
5114 gst_clock_id_unschedule (basesink->clock_id);
5117 /* if we don't have a preroll buffer we need to wait for a preroll and
5119 if (!gst_base_sink_needs_preroll (basesink)) {
5120 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED, we are prerolled");
5121 basesink->playing_async = FALSE;
5123 if (GST_STATE_TARGET (GST_ELEMENT (basesink)) <= GST_STATE_READY) {
5124 GST_DEBUG_OBJECT (basesink, "element is <= READY");
5125 ret = GST_STATE_CHANGE_SUCCESS;
5127 GST_DEBUG_OBJECT (basesink,
5128 "PLAYING to PAUSED, we are not prerolled");
5129 basesink->playing_async = TRUE;
5130 priv->commited = FALSE;
5131 priv->call_preroll = TRUE;
5132 if (priv->async_enabled) {
5133 GST_DEBUG_OBJECT (basesink, "doing async state change");
5134 ret = GST_STATE_CHANGE_ASYNC;
5135 gst_element_post_message (GST_ELEMENT_CAST (basesink),
5136 gst_message_new_async_start (GST_OBJECT_CAST (basesink),
5141 GST_DEBUG_OBJECT (basesink, "rendered: %" G_GUINT64_FORMAT
5142 ", dropped: %" G_GUINT64_FORMAT, priv->rendered, priv->dropped);
5144 gst_base_sink_reset_qos (basesink);
5145 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
5147 case GST_STATE_CHANGE_PAUSED_TO_READY:
5148 GST_PAD_PREROLL_LOCK (basesink->sinkpad);
5149 /* start by resetting our position state with the object lock so that the
5150 * position query gets the right idea. We do this before we post the
5151 * messages so that the message handlers pick this up. */
5152 GST_OBJECT_LOCK (basesink);
5153 basesink->have_newsegment = FALSE;
5154 priv->current_sstart = GST_CLOCK_TIME_NONE;
5155 priv->current_sstop = GST_CLOCK_TIME_NONE;
5156 priv->have_latency = FALSE;
5157 if (priv->cached_clock_id) {
5158 gst_clock_id_unref (priv->cached_clock_id);
5159 priv->cached_clock_id = NULL;
5161 GST_OBJECT_UNLOCK (basesink);
5163 gst_base_sink_set_last_buffer (basesink, NULL);
5164 priv->call_preroll = FALSE;
5166 if (!priv->commited) {
5167 if (priv->async_enabled) {
5168 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, posting async-done");
5170 gst_element_post_message (GST_ELEMENT_CAST (basesink),
5171 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
5172 GST_STATE_PLAYING, GST_STATE_PAUSED, GST_STATE_READY));
5174 gst_element_post_message (GST_ELEMENT_CAST (basesink),
5175 gst_message_new_async_done (GST_OBJECT_CAST (basesink)));
5177 priv->commited = TRUE;
5179 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, don't need_preroll");
5181 GST_PAD_PREROLL_UNLOCK (basesink->sinkpad);
5183 case GST_STATE_CHANGE_READY_TO_NULL:
5185 if (!bclass->stop (basesink)) {
5186 GST_WARNING_OBJECT (basesink, "failed to stop");
5189 gst_base_sink_set_last_buffer (basesink, NULL);
5190 priv->call_preroll = FALSE;
5201 GST_DEBUG_OBJECT (basesink, "failed to start");
5202 return GST_STATE_CHANGE_FAILURE;
5206 GST_DEBUG_OBJECT (basesink,
5207 "element failed to change states -- activation problem?");
5208 return GST_STATE_CHANGE_FAILURE;