2 * Copyright (C) 2005-2007 Wim Taymans <wim.taymans@gmail.com>
4 * gstbasesink.c: Base class for sink elements
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
24 * @short_description: Base class for sink elements
25 * @see_also: #GstBaseTransform, #GstBaseSrc
27 * #GstBaseSink is the base class for sink elements in GStreamer, such as
28 * xvimagesink or filesink. It is a layer on top of #GstElement that provides a
29 * simplified interface to plugin writers. #GstBaseSink handles many details
30 * for you, for example: preroll, clock synchronization, state changes,
31 * activation in push or pull mode, and queries.
33 * In most cases, when writing sink elements, there is no need to implement
34 * class methods from #GstElement or to set functions on pads, because the
35 * #GstBaseSink infrastructure should be sufficient.
37 * #GstBaseSink provides support for exactly one sink pad, which should be
38 * named "sink". A sink implementation (subclass of #GstBaseSink) should
39 * install a pad template in its class_init function, like so:
42 * my_element_class_init (GstMyElementClass *klass)
44 * GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
46 * // sinktemplate should be a #GstStaticPadTemplate with direction
47 * // #GST_PAD_SINK and name "sink"
48 * gst_element_class_add_pad_template (gstelement_class,
49 * gst_static_pad_template_get (&sinktemplate));
50 * // see #GstElementDetails
51 * gst_element_class_set_details (gstelement_class, &details);
55 * #GstBaseSink will handle the prerolling correctly. This means that it will
56 * return #GST_STATE_CHANGE_ASYNC from a state change to PAUSED until the first
57 * buffer arrives in this element. The base class will call the
58 * #GstBaseSinkClass.preroll() vmethod with this preroll buffer and will then
59 * commit the state change to the next asynchronously pending state.
61 * When the element is set to PLAYING, #GstBaseSink will synchronise on the
62 * clock using the times returned from #GstBaseSinkClass.get_times(). If this
63 * function returns #GST_CLOCK_TIME_NONE for the start time, no synchronisation
64 * will be done. Synchronisation can be disabled entirely by setting the object
65 * #GstBaseSink:sync property to %FALSE.
67 * After synchronisation the virtual method #GstBaseSinkClass.render() will be
68 * called. Subclasses should minimally implement this method.
70 * Since 0.10.3 subclasses that synchronise on the clock in the
71 * #GstBaseSinkClass.render() method are supported as well. These classes
72 * typically receive a buffer in the render method and can then potentially
73 * block on the clock while rendering. A typical example is an audiosink.
74 * Since 0.10.11 these subclasses can use gst_base_sink_wait_preroll() to
75 * perform the blocking wait.
77 * Upon receiving the EOS event in the PLAYING state, #GstBaseSink will wait
78 * for the clock to reach the time indicated by the stop time of the last
79 * #GstBaseSinkClass.get_times() call before posting an EOS message. When the
80 * element receives EOS in PAUSED, preroll completes, the event is queued and an
81 * EOS message is posted when going to PLAYING.
83 * #GstBaseSink will internally use the #GST_EVENT_NEWSEGMENT events to schedule
84 * synchronisation and clipping of buffers. Buffers that fall completely outside
85 * of the current segment are dropped. Buffers that fall partially in the
86 * segment are rendered (and prerolled). Subclasses should do any subbuffer
87 * clipping themselves when needed.
89 * #GstBaseSink will by default report the current playback position in
90 * #GST_FORMAT_TIME based on the current clock time and segment information.
91 * If no clock has been set on the element, the query will be forwarded
94 * The #GstBaseSinkClass.set_caps() function will be called when the subclass
95 * should configure itself to process a specific media type.
97 * The #GstBaseSinkClass.start() and #GstBaseSinkClass.stop() virtual methods
98 * will be called when resources should be allocated. Any
99 * #GstBaseSinkClass.preroll(), #GstBaseSinkClass.render() and
100 * #GstBaseSinkClass.set_caps() function will be called between the
101 * #GstBaseSinkClass.start() and #GstBaseSinkClass.stop() calls.
103 * The #GstBaseSinkClass.event() virtual method will be called when an event is
104 * received by #GstBaseSink. Normally this method should only be overriden by
105 * very specific elements (such as file sinks) which need to handle the
106 * newsegment event specially.
108 * The #GstBaseSinkClass.unlock() method is called when the elements should
109 * unblock any blocking operations they perform in the
110 * #GstBaseSinkClass.render() method. This is mostly useful when the
111 * #GstBaseSinkClass.render() method performs a blocking write on a file
112 * descriptor, for example.
114 * The #GstBaseSink:max-lateness property affects how the sink deals with
115 * buffers that arrive too late in the sink. A buffer arrives too late in the
116 * sink when the presentation time (as a combination of the last segment, buffer
117 * timestamp and element base_time) plus the duration is before the current
119 * If the frame is later than max-lateness, the sink will drop the buffer
120 * without calling the render method.
121 * This feature is disabled if sync is disabled, the
122 * #GstBaseSinkClass.get_times() method does not return a valid start time or
123 * max-lateness is set to -1 (the default).
124 * Subclasses can use gst_base_sink_set_max_lateness() to configure the
125 * max-lateness value.
127 * The #GstBaseSink:qos property will enable the quality-of-service features of
128 * the basesink which gather statistics about the real-time performance of the
129 * clock synchronisation. For each buffer received in the sink, statistics are
130 * gathered and a QOS event is sent upstream with these numbers. This
131 * information can then be used by upstream elements to reduce their processing
134 * Since 0.10.15 the #GstBaseSink:async property can be used to instruct the
135 * sink to never perform an ASYNC state change. This feature is mostly usable
136 * when dealing with non-synchronized streams or sparse streams.
138 * Last reviewed on 2007-08-29 (0.10.15)
145 #include <gst/gst_private.h>
147 #include "gstbasesink.h"
148 #include <gst/gstmarshal.h>
149 #include <gst/gst-i18n-lib.h>
151 GST_DEBUG_CATEGORY_STATIC (gst_base_sink_debug);
152 #define GST_CAT_DEFAULT gst_base_sink_debug
154 #define GST_BASE_SINK_GET_PRIVATE(obj) \
155 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_BASE_SINK, GstBaseSinkPrivate))
157 #define GST_FLOW_STEP GST_FLOW_CUSTOM_ERROR
161 gboolean valid; /* if this info is valid */
162 guint32 seqnum; /* the seqnum of the STEP event */
163 GstFormat format; /* the format of the amount */
164 guint64 amount; /* the total amount of data to skip */
165 guint64 position; /* the position in the stepped data */
166 guint64 duration; /* the duration in time of the skipped data */
167 guint64 start; /* running_time of the start */
168 gdouble rate; /* rate of skipping */
169 gdouble start_rate; /* rate before skipping */
170 guint64 start_start; /* start position skipping */
171 guint64 start_stop; /* stop position skipping */
172 gboolean flush; /* if this was a flushing step */
173 gboolean intermediate; /* if this is an intermediate step */
174 gboolean need_preroll; /* if we need preroll after this step */
177 /* FIXME, some stuff in ABI.data and other in Private...
178 * Make up your mind please.
180 struct _GstBaseSinkPrivate
182 gint qos_enabled; /* ATOMIC */
183 gboolean async_enabled;
184 GstClockTimeDiff ts_offset;
185 GstClockTime render_delay;
187 /* start, stop of current buffer, stream time, used to report position */
188 GstClockTime current_sstart;
189 GstClockTime current_sstop;
191 /* start, stop and jitter of current buffer, running time */
192 GstClockTime current_rstart;
193 GstClockTime current_rstop;
194 GstClockTimeDiff current_jitter;
195 /* the running time of the previous buffer */
196 GstClockTime prev_rstart;
198 /* EOS sync time in running time */
199 GstClockTime eos_rtime;
201 /* last buffer that arrived in time, running time */
202 GstClockTime last_render_time;
203 /* when the last buffer left the sink, running time */
204 GstClockTime last_left;
206 /* running averages go here these are done on running time */
208 GstClockTime avg_duration;
210 GstClockTime avg_in_diff;
212 /* these are done on system time. avg_jitter and avg_render are
213 * compared to eachother to see if the rendering time takes a
214 * huge amount of the processing, If so we are flooded with
216 GstClockTime last_left_systime;
217 GstClockTime avg_jitter;
218 GstClockTime start, stop;
219 GstClockTime avg_render;
221 /* number of rendered and dropped frames */
226 GstClockTime latency;
228 /* if we already commited the state */
230 /* state change to playing ongoing */
233 /* when we received EOS */
234 gboolean received_eos;
236 /* when we are prerolled and able to report latency */
237 gboolean have_latency;
239 /* the last buffer we prerolled or rendered. Useful for making snapshots */
240 gint enable_last_buffer; /* atomic */
241 GstBuffer *last_buffer;
243 /* caps for pull based scheduling */
246 /* blocksize for pulling */
251 /* seqnum of the stream */
254 gboolean call_preroll;
255 gboolean step_unlock;
257 /* we have a pending and a current step operation */
258 GstStepInfo current_step;
259 GstStepInfo pending_step;
261 /* Cached GstClockID */
262 GstClockID cached_clock_id;
264 /* for throttling and QoS */
265 GstClockTime earliest_in_time;
266 GstClockTime throttle_time;
271 #define DO_RUNNING_AVG(avg,val,size) (((val) + ((size)-1) * (avg)) / (size))
273 /* generic running average, this has a neutral window size */
274 #define UPDATE_RUNNING_AVG(avg,val) DO_RUNNING_AVG(avg,val,8)
276 /* the windows for these running averages are experimentally obtained.
277 * possitive values get averaged more while negative values use a small
278 * window so we can react faster to badness. */
279 #define UPDATE_RUNNING_AVG_P(avg,val) DO_RUNNING_AVG(avg,val,16)
280 #define UPDATE_RUNNING_AVG_N(avg,val) DO_RUNNING_AVG(avg,val,4)
284 _PR_IS_NOTHING = 1 << 0,
285 _PR_IS_BUFFER = 1 << 1,
286 _PR_IS_BUFFERLIST = 1 << 2,
287 _PR_IS_EVENT = 1 << 3
290 #define OBJ_IS_BUFFER(a) ((a) & _PR_IS_BUFFER)
291 #define OBJ_IS_BUFFERLIST(a) ((a) & _PR_IS_BUFFERLIST)
292 #define OBJ_IS_EVENT(a) ((a) & _PR_IS_EVENT)
293 #define OBJ_IS_BUFFERFULL(a) ((a) & (_PR_IS_BUFFER | _PR_IS_BUFFERLIST))
295 /* BaseSink properties */
297 #define DEFAULT_CAN_ACTIVATE_PULL FALSE /* fixme: enable me */
298 #define DEFAULT_CAN_ACTIVATE_PUSH TRUE
300 #define DEFAULT_PREROLL_QUEUE_LEN 0
301 #define DEFAULT_SYNC TRUE
302 #define DEFAULT_MAX_LATENESS -1
303 #define DEFAULT_QOS FALSE
304 #define DEFAULT_ASYNC TRUE
305 #define DEFAULT_TS_OFFSET 0
306 #define DEFAULT_BLOCKSIZE 4096
307 #define DEFAULT_RENDER_DELAY 0
308 #define DEFAULT_ENABLE_LAST_BUFFER TRUE
309 #define DEFAULT_THROTTLE_TIME 0
314 PROP_PREROLL_QUEUE_LEN,
320 PROP_ENABLE_LAST_BUFFER,
328 static GstElementClass *parent_class = NULL;
330 static void gst_base_sink_class_init (GstBaseSinkClass * klass);
331 static void gst_base_sink_init (GstBaseSink * trans, gpointer g_class);
332 static void gst_base_sink_finalize (GObject * object);
335 gst_base_sink_get_type (void)
337 static volatile gsize base_sink_type = 0;
339 if (g_once_init_enter (&base_sink_type)) {
341 static const GTypeInfo base_sink_info = {
342 sizeof (GstBaseSinkClass),
345 (GClassInitFunc) gst_base_sink_class_init,
348 sizeof (GstBaseSink),
350 (GInstanceInitFunc) gst_base_sink_init,
353 _type = g_type_register_static (GST_TYPE_ELEMENT,
354 "GstBaseSink", &base_sink_info, G_TYPE_FLAG_ABSTRACT);
355 g_once_init_leave (&base_sink_type, _type);
357 return base_sink_type;
360 static void gst_base_sink_set_property (GObject * object, guint prop_id,
361 const GValue * value, GParamSpec * pspec);
362 static void gst_base_sink_get_property (GObject * object, guint prop_id,
363 GValue * value, GParamSpec * pspec);
365 static gboolean gst_base_sink_send_event (GstElement * element,
367 static gboolean default_element_query (GstElement * element, GstQuery * query);
368 static const GstQueryType *gst_base_sink_get_query_types (GstElement * element);
370 static GstCaps *gst_base_sink_get_caps (GstBaseSink * sink, GstCaps * caps);
371 static gboolean gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps);
372 static void gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
373 GstClockTime * start, GstClockTime * end);
374 static gboolean gst_base_sink_set_flushing (GstBaseSink * basesink,
375 GstPad * pad, gboolean flushing);
376 static gboolean gst_base_sink_default_activate_pull (GstBaseSink * basesink,
378 static gboolean gst_base_sink_default_do_seek (GstBaseSink * sink,
379 GstSegment * segment);
380 static gboolean gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
381 GstEvent * event, GstSegment * segment);
383 static GstStateChangeReturn gst_base_sink_change_state (GstElement * element,
384 GstStateChange transition);
386 static gboolean gst_base_sink_sink_query (GstPad * pad, GstQuery * query);
387 static GstFlowReturn gst_base_sink_chain (GstPad * pad, GstBuffer * buffer);
388 static GstFlowReturn gst_base_sink_chain_list (GstPad * pad,
389 GstBufferList * list);
391 static void gst_base_sink_loop (GstPad * pad);
392 static gboolean gst_base_sink_pad_activate (GstPad * pad);
393 static gboolean gst_base_sink_pad_activate_push (GstPad * pad, gboolean active);
394 static gboolean gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active);
395 static gboolean gst_base_sink_event (GstPad * pad, GstEvent * event);
397 static gboolean default_sink_query (GstBaseSink * sink, GstQuery * query);
399 static gboolean gst_base_sink_negotiate_pull (GstBaseSink * basesink);
400 static GstCaps *gst_base_sink_pad_getcaps (GstPad * pad, GstCaps * filter);
401 static void gst_base_sink_pad_fixate (GstPad * pad, GstCaps * caps);
403 /* check if an object was too late */
404 static gboolean gst_base_sink_is_too_late (GstBaseSink * basesink,
405 GstMiniObject * obj, GstClockTime rstart, GstClockTime rstop,
406 GstClockReturn status, GstClockTimeDiff jitter);
407 static GstFlowReturn gst_base_sink_preroll_object (GstBaseSink * basesink,
408 guint8 obj_type, GstMiniObject * obj);
411 gst_base_sink_class_init (GstBaseSinkClass * klass)
413 GObjectClass *gobject_class;
414 GstElementClass *gstelement_class;
416 gobject_class = G_OBJECT_CLASS (klass);
417 gstelement_class = GST_ELEMENT_CLASS (klass);
419 GST_DEBUG_CATEGORY_INIT (gst_base_sink_debug, "basesink", 0,
422 g_type_class_add_private (klass, sizeof (GstBaseSinkPrivate));
424 parent_class = g_type_class_peek_parent (klass);
426 gobject_class->finalize = gst_base_sink_finalize;
427 gobject_class->set_property = gst_base_sink_set_property;
428 gobject_class->get_property = gst_base_sink_get_property;
430 /* FIXME, this next value should be configured using an event from the
431 * upstream element, ie, the BUFFER_SIZE event. */
432 g_object_class_install_property (gobject_class, PROP_PREROLL_QUEUE_LEN,
433 g_param_spec_uint ("preroll-queue-len", "Preroll queue length",
434 "Number of buffers to queue during preroll", 0, G_MAXUINT,
435 DEFAULT_PREROLL_QUEUE_LEN,
436 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
438 g_object_class_install_property (gobject_class, PROP_SYNC,
439 g_param_spec_boolean ("sync", "Sync", "Sync on the clock", DEFAULT_SYNC,
440 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
442 g_object_class_install_property (gobject_class, PROP_MAX_LATENESS,
443 g_param_spec_int64 ("max-lateness", "Max Lateness",
444 "Maximum number of nanoseconds that a buffer can be late before it "
445 "is dropped (-1 unlimited)", -1, G_MAXINT64, DEFAULT_MAX_LATENESS,
446 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
448 g_object_class_install_property (gobject_class, PROP_QOS,
449 g_param_spec_boolean ("qos", "Qos",
450 "Generate Quality-of-Service events upstream", DEFAULT_QOS,
451 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
455 * If set to #TRUE, the basesink will perform asynchronous state changes.
456 * When set to #FALSE, the sink will not signal the parent when it prerolls.
457 * Use this option when dealing with sparse streams or when synchronisation is
462 g_object_class_install_property (gobject_class, PROP_ASYNC,
463 g_param_spec_boolean ("async", "Async",
464 "Go asynchronously to PAUSED", DEFAULT_ASYNC,
465 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
467 * GstBaseSink:ts-offset
469 * Controls the final synchronisation, a negative value will render the buffer
470 * earlier while a positive value delays playback. This property can be
471 * used to fix synchronisation in bad files.
475 g_object_class_install_property (gobject_class, PROP_TS_OFFSET,
476 g_param_spec_int64 ("ts-offset", "TS Offset",
477 "Timestamp offset in nanoseconds", G_MININT64, G_MAXINT64,
478 DEFAULT_TS_OFFSET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
481 * GstBaseSink:enable-last-buffer
483 * Enable the last-buffer property. If FALSE, basesink doesn't keep a
484 * reference to the last buffer arrived and the last-buffer property is always
485 * set to NULL. This can be useful if you need buffers to be released as soon
486 * as possible, eg. if you're using a buffer pool.
490 g_object_class_install_property (gobject_class, PROP_ENABLE_LAST_BUFFER,
491 g_param_spec_boolean ("enable-last-buffer", "Enable Last Buffer",
492 "Enable the last-buffer property", DEFAULT_ENABLE_LAST_BUFFER,
493 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
496 * GstBaseSink:last-buffer
498 * The last buffer that arrived in the sink and was used for preroll or for
499 * rendering. This property can be used to generate thumbnails. This property
500 * can be NULL when the sink has not yet received a bufer.
504 g_object_class_install_property (gobject_class, PROP_LAST_BUFFER,
505 g_param_spec_boxed ("last-buffer", "Last Buffer",
506 "The last buffer received in the sink", GST_TYPE_BUFFER,
507 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
509 * GstBaseSink:blocksize
511 * The amount of bytes to pull when operating in pull mode.
515 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
516 g_object_class_install_property (gobject_class, PROP_BLOCKSIZE,
517 g_param_spec_uint ("blocksize", "Block size",
518 "Size in bytes to pull per buffer (0 = default)", 0, G_MAXUINT,
519 DEFAULT_BLOCKSIZE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
521 * GstBaseSink:render-delay
523 * The additional delay between synchronisation and actual rendering of the
524 * media. This property will add additional latency to the device in order to
525 * make other sinks compensate for the delay.
529 g_object_class_install_property (gobject_class, PROP_RENDER_DELAY,
530 g_param_spec_uint64 ("render-delay", "Render Delay",
531 "Additional render delay of the sink in nanoseconds", 0, G_MAXUINT64,
532 DEFAULT_RENDER_DELAY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
534 * GstBaseSink:throttle-time
536 * The time to insert between buffers. This property can be used to control
537 * the maximum amount of buffers per second to render. Setting this property
538 * to a value bigger than 0 will make the sink create THROTTLE QoS events.
542 g_object_class_install_property (gobject_class, PROP_THROTTLE_TIME,
543 g_param_spec_uint64 ("throttle-time", "Throttle time",
544 "The time to keep between rendered buffers (unused)", 0, G_MAXUINT64,
545 DEFAULT_THROTTLE_TIME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
547 gstelement_class->change_state =
548 GST_DEBUG_FUNCPTR (gst_base_sink_change_state);
549 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_base_sink_send_event);
550 gstelement_class->query = GST_DEBUG_FUNCPTR (default_element_query);
551 gstelement_class->get_query_types =
552 GST_DEBUG_FUNCPTR (gst_base_sink_get_query_types);
554 klass->get_caps = GST_DEBUG_FUNCPTR (gst_base_sink_get_caps);
555 klass->set_caps = GST_DEBUG_FUNCPTR (gst_base_sink_set_caps);
556 klass->get_times = GST_DEBUG_FUNCPTR (gst_base_sink_get_times);
557 klass->activate_pull =
558 GST_DEBUG_FUNCPTR (gst_base_sink_default_activate_pull);
559 klass->query = GST_DEBUG_FUNCPTR (default_sink_query);
561 /* Registering debug symbols for function pointers */
562 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_getcaps);
563 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_fixate);
564 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate);
565 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate_push);
566 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate_pull);
567 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_event);
568 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain);
569 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain_list);
573 gst_base_sink_pad_getcaps (GstPad * pad, GstCaps * filter)
575 GstBaseSinkClass *bclass;
577 GstCaps *caps = NULL;
579 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
580 bclass = GST_BASE_SINK_GET_CLASS (bsink);
582 if (bsink->pad_mode == GST_ACTIVATE_PULL) {
583 /* if we are operating in pull mode we only accept the negotiated caps */
584 caps = gst_pad_get_current_caps (pad);
587 if (bclass->get_caps)
588 caps = bclass->get_caps (bsink, filter);
591 GstPadTemplate *pad_template;
594 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass),
596 if (pad_template != NULL) {
597 caps = gst_pad_template_get_caps (pad_template);
600 GstCaps *intersection;
603 gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
604 gst_caps_unref (caps);
610 gst_object_unref (bsink);
616 gst_base_sink_pad_fixate (GstPad * pad, GstCaps * caps)
618 GstBaseSinkClass *bclass;
621 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
622 bclass = GST_BASE_SINK_GET_CLASS (bsink);
625 bclass->fixate (bsink, caps);
627 gst_object_unref (bsink);
631 gst_base_sink_init (GstBaseSink * basesink, gpointer g_class)
633 GstPadTemplate *pad_template;
634 GstBaseSinkPrivate *priv;
636 basesink->priv = priv = GST_BASE_SINK_GET_PRIVATE (basesink);
639 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "sink");
640 g_return_if_fail (pad_template != NULL);
642 basesink->sinkpad = gst_pad_new_from_template (pad_template, "sink");
644 gst_pad_set_getcaps_function (basesink->sinkpad, gst_base_sink_pad_getcaps);
645 gst_pad_set_fixatecaps_function (basesink->sinkpad, gst_base_sink_pad_fixate);
646 gst_pad_set_activate_function (basesink->sinkpad, gst_base_sink_pad_activate);
647 gst_pad_set_activatepush_function (basesink->sinkpad,
648 gst_base_sink_pad_activate_push);
649 gst_pad_set_activatepull_function (basesink->sinkpad,
650 gst_base_sink_pad_activate_pull);
651 gst_pad_set_query_function (basesink->sinkpad, gst_base_sink_sink_query);
652 gst_pad_set_event_function (basesink->sinkpad, gst_base_sink_event);
653 gst_pad_set_chain_function (basesink->sinkpad, gst_base_sink_chain);
654 gst_pad_set_chain_list_function (basesink->sinkpad, gst_base_sink_chain_list);
655 gst_element_add_pad (GST_ELEMENT_CAST (basesink), basesink->sinkpad);
657 basesink->pad_mode = GST_ACTIVATE_NONE;
658 basesink->preroll_lock = g_mutex_new ();
659 basesink->preroll_cond = g_cond_new ();
660 basesink->preroll_queue = g_queue_new ();
661 priv->have_latency = FALSE;
663 basesink->can_activate_push = DEFAULT_CAN_ACTIVATE_PUSH;
664 basesink->can_activate_pull = DEFAULT_CAN_ACTIVATE_PULL;
666 basesink->sync = DEFAULT_SYNC;
667 basesink->max_lateness = DEFAULT_MAX_LATENESS;
668 g_atomic_int_set (&priv->qos_enabled, DEFAULT_QOS);
669 priv->async_enabled = DEFAULT_ASYNC;
670 priv->ts_offset = DEFAULT_TS_OFFSET;
671 priv->render_delay = DEFAULT_RENDER_DELAY;
672 priv->blocksize = DEFAULT_BLOCKSIZE;
673 priv->cached_clock_id = NULL;
674 g_atomic_int_set (&priv->enable_last_buffer, DEFAULT_ENABLE_LAST_BUFFER);
675 priv->throttle_time = DEFAULT_THROTTLE_TIME;
677 GST_OBJECT_FLAG_SET (basesink, GST_ELEMENT_IS_SINK);
681 gst_base_sink_finalize (GObject * object)
683 GstBaseSink *basesink;
685 basesink = GST_BASE_SINK (object);
687 g_mutex_free (basesink->preroll_lock);
688 g_cond_free (basesink->preroll_cond);
689 g_queue_free (basesink->preroll_queue);
691 G_OBJECT_CLASS (parent_class)->finalize (object);
695 * gst_base_sink_set_sync:
697 * @sync: the new sync value.
699 * Configures @sink to synchronize on the clock or not. When
700 * @sync is FALSE, incomming samples will be played as fast as
701 * possible. If @sync is TRUE, the timestamps of the incomming
702 * buffers will be used to schedule the exact render time of its
708 gst_base_sink_set_sync (GstBaseSink * sink, gboolean sync)
710 g_return_if_fail (GST_IS_BASE_SINK (sink));
712 GST_OBJECT_LOCK (sink);
714 GST_OBJECT_UNLOCK (sink);
718 * gst_base_sink_get_sync:
721 * Checks if @sink is currently configured to synchronize against the
724 * Returns: TRUE if the sink is configured to synchronize against the clock.
729 gst_base_sink_get_sync (GstBaseSink * sink)
733 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
735 GST_OBJECT_LOCK (sink);
737 GST_OBJECT_UNLOCK (sink);
743 * gst_base_sink_set_max_lateness:
745 * @max_lateness: the new max lateness value.
747 * Sets the new max lateness value to @max_lateness. This value is
748 * used to decide if a buffer should be dropped or not based on the
749 * buffer timestamp and the current clock time. A value of -1 means
755 gst_base_sink_set_max_lateness (GstBaseSink * sink, gint64 max_lateness)
757 g_return_if_fail (GST_IS_BASE_SINK (sink));
759 GST_OBJECT_LOCK (sink);
760 sink->max_lateness = max_lateness;
761 GST_OBJECT_UNLOCK (sink);
765 * gst_base_sink_get_max_lateness:
768 * Gets the max lateness value. See gst_base_sink_set_max_lateness for
771 * Returns: The maximum time in nanoseconds that a buffer can be late
772 * before it is dropped and not rendered. A value of -1 means an
778 gst_base_sink_get_max_lateness (GstBaseSink * sink)
782 g_return_val_if_fail (GST_IS_BASE_SINK (sink), -1);
784 GST_OBJECT_LOCK (sink);
785 res = sink->max_lateness;
786 GST_OBJECT_UNLOCK (sink);
792 * gst_base_sink_set_qos_enabled:
794 * @enabled: the new qos value.
796 * Configures @sink to send Quality-of-Service events upstream.
801 gst_base_sink_set_qos_enabled (GstBaseSink * sink, gboolean enabled)
803 g_return_if_fail (GST_IS_BASE_SINK (sink));
805 g_atomic_int_set (&sink->priv->qos_enabled, enabled);
809 * gst_base_sink_is_qos_enabled:
812 * Checks if @sink is currently configured to send Quality-of-Service events
815 * Returns: TRUE if the sink is configured to perform Quality-of-Service.
820 gst_base_sink_is_qos_enabled (GstBaseSink * sink)
824 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
826 res = g_atomic_int_get (&sink->priv->qos_enabled);
832 * gst_base_sink_set_async_enabled:
834 * @enabled: the new async value.
836 * Configures @sink to perform all state changes asynchronusly. When async is
837 * disabled, the sink will immediatly go to PAUSED instead of waiting for a
838 * preroll buffer. This feature is usefull if the sink does not synchronize
839 * against the clock or when it is dealing with sparse streams.
844 gst_base_sink_set_async_enabled (GstBaseSink * sink, gboolean enabled)
846 g_return_if_fail (GST_IS_BASE_SINK (sink));
848 GST_BASE_SINK_PREROLL_LOCK (sink);
849 g_atomic_int_set (&sink->priv->async_enabled, enabled);
850 GST_LOG_OBJECT (sink, "set async enabled to %d", enabled);
851 GST_BASE_SINK_PREROLL_UNLOCK (sink);
855 * gst_base_sink_is_async_enabled:
858 * Checks if @sink is currently configured to perform asynchronous state
861 * Returns: TRUE if the sink is configured to perform asynchronous state
867 gst_base_sink_is_async_enabled (GstBaseSink * sink)
871 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
873 res = g_atomic_int_get (&sink->priv->async_enabled);
879 * gst_base_sink_set_ts_offset:
881 * @offset: the new offset
883 * Adjust the synchronisation of @sink with @offset. A negative value will
884 * render buffers earlier than their timestamp. A positive value will delay
885 * rendering. This function can be used to fix playback of badly timestamped
891 gst_base_sink_set_ts_offset (GstBaseSink * sink, GstClockTimeDiff offset)
893 g_return_if_fail (GST_IS_BASE_SINK (sink));
895 GST_OBJECT_LOCK (sink);
896 sink->priv->ts_offset = offset;
897 GST_LOG_OBJECT (sink, "set time offset to %" G_GINT64_FORMAT, offset);
898 GST_OBJECT_UNLOCK (sink);
902 * gst_base_sink_get_ts_offset:
905 * Get the synchronisation offset of @sink.
907 * Returns: The synchronisation offset.
912 gst_base_sink_get_ts_offset (GstBaseSink * sink)
914 GstClockTimeDiff res;
916 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
918 GST_OBJECT_LOCK (sink);
919 res = sink->priv->ts_offset;
920 GST_OBJECT_UNLOCK (sink);
926 * gst_base_sink_get_last_buffer:
929 * Get the last buffer that arrived in the sink and was used for preroll or for
930 * rendering. This property can be used to generate thumbnails.
932 * The #GstCaps on the buffer can be used to determine the type of the buffer.
934 * Free-function: gst_buffer_unref
936 * Returns: (transfer full): a #GstBuffer. gst_buffer_unref() after usage.
937 * This function returns NULL when no buffer has arrived in the sink yet
938 * or when the sink is not in PAUSED or PLAYING.
943 gst_base_sink_get_last_buffer (GstBaseSink * sink)
947 g_return_val_if_fail (GST_IS_BASE_SINK (sink), NULL);
949 GST_OBJECT_LOCK (sink);
950 if ((res = sink->priv->last_buffer))
951 gst_buffer_ref (res);
952 GST_OBJECT_UNLOCK (sink);
957 /* with OBJECT_LOCK */
959 gst_base_sink_set_last_buffer_unlocked (GstBaseSink * sink, GstBuffer * buffer)
963 old = sink->priv->last_buffer;
964 if (G_LIKELY (old != buffer)) {
965 GST_DEBUG_OBJECT (sink, "setting last buffer to %p", buffer);
966 if (G_LIKELY (buffer))
967 gst_buffer_ref (buffer);
968 sink->priv->last_buffer = buffer;
972 /* avoid unreffing with the lock because cleanup code might want to take the
974 if (G_LIKELY (old)) {
975 GST_OBJECT_UNLOCK (sink);
976 gst_buffer_unref (old);
977 GST_OBJECT_LOCK (sink);
982 gst_base_sink_set_last_buffer (GstBaseSink * sink, GstBuffer * buffer)
984 if (!g_atomic_int_get (&sink->priv->enable_last_buffer))
987 GST_OBJECT_LOCK (sink);
988 gst_base_sink_set_last_buffer_unlocked (sink, buffer);
989 GST_OBJECT_UNLOCK (sink);
993 * gst_base_sink_set_last_buffer_enabled:
995 * @enabled: the new enable-last-buffer value.
997 * Configures @sink to store the last received buffer in the last-buffer
1003 gst_base_sink_set_last_buffer_enabled (GstBaseSink * sink, gboolean enabled)
1005 g_return_if_fail (GST_IS_BASE_SINK (sink));
1007 /* Only take lock if we change the value */
1008 if (g_atomic_int_compare_and_exchange (&sink->priv->enable_last_buffer,
1009 !enabled, enabled) && !enabled) {
1010 GST_OBJECT_LOCK (sink);
1011 gst_base_sink_set_last_buffer_unlocked (sink, NULL);
1012 GST_OBJECT_UNLOCK (sink);
1017 * gst_base_sink_is_last_buffer_enabled:
1020 * Checks if @sink is currently configured to store the last received buffer in
1021 * the last-buffer property.
1023 * Returns: TRUE if the sink is configured to store the last received buffer.
1028 gst_base_sink_is_last_buffer_enabled (GstBaseSink * sink)
1030 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
1032 return g_atomic_int_get (&sink->priv->enable_last_buffer);
1036 * gst_base_sink_get_latency:
1039 * Get the currently configured latency.
1041 * Returns: The configured latency.
1046 gst_base_sink_get_latency (GstBaseSink * sink)
1050 GST_OBJECT_LOCK (sink);
1051 res = sink->priv->latency;
1052 GST_OBJECT_UNLOCK (sink);
1058 * gst_base_sink_query_latency:
1060 * @live: (out) (allow-none): if the sink is live
1061 * @upstream_live: (out) (allow-none): if an upstream element is live
1062 * @min_latency: (out) (allow-none): the min latency of the upstream elements
1063 * @max_latency: (out) (allow-none): the max latency of the upstream elements
1065 * Query the sink for the latency parameters. The latency will be queried from
1066 * the upstream elements. @live will be TRUE if @sink is configured to
1067 * synchronize against the clock. @upstream_live will be TRUE if an upstream
1070 * If both @live and @upstream_live are TRUE, the sink will want to compensate
1071 * for the latency introduced by the upstream elements by setting the
1072 * @min_latency to a strictly possitive value.
1074 * This function is mostly used by subclasses.
1076 * Returns: TRUE if the query succeeded.
1081 gst_base_sink_query_latency (GstBaseSink * sink, gboolean * live,
1082 gboolean * upstream_live, GstClockTime * min_latency,
1083 GstClockTime * max_latency)
1085 gboolean l, us_live, res, have_latency;
1086 GstClockTime min, max, render_delay;
1088 GstClockTime us_min, us_max;
1090 /* we are live when we sync to the clock */
1091 GST_OBJECT_LOCK (sink);
1093 have_latency = sink->priv->have_latency;
1094 render_delay = sink->priv->render_delay;
1095 GST_OBJECT_UNLOCK (sink);
1097 /* assume no latency */
1103 GST_DEBUG_OBJECT (sink, "we are ready for LATENCY query");
1104 /* we are ready for a latency query this is when we preroll or when we are
1106 query = gst_query_new_latency ();
1108 /* ask the peer for the latency */
1109 if ((res = gst_pad_peer_query (sink->sinkpad, query))) {
1110 /* get upstream min and max latency */
1111 gst_query_parse_latency (query, &us_live, &us_min, &us_max);
1114 /* upstream live, use its latency, subclasses should use these
1115 * values to create the complete latency. */
1120 /* we need to add the render delay if we are live */
1122 min += render_delay;
1124 max += render_delay;
1127 gst_query_unref (query);
1129 GST_DEBUG_OBJECT (sink, "we are not yet ready for LATENCY query");
1133 /* not live, we tried to do the query, if it failed we return TRUE anyway */
1137 GST_DEBUG_OBJECT (sink, "latency query failed but we are not live");
1139 GST_DEBUG_OBJECT (sink, "latency query failed and we are live");
1144 GST_DEBUG_OBJECT (sink, "latency query: live: %d, have_latency %d,"
1145 " upstream: %d, min %" GST_TIME_FORMAT ", max %" GST_TIME_FORMAT, l,
1146 have_latency, us_live, GST_TIME_ARGS (min), GST_TIME_ARGS (max));
1151 *upstream_live = us_live;
1161 * gst_base_sink_set_render_delay:
1162 * @sink: a #GstBaseSink
1163 * @delay: the new delay
1165 * Set the render delay in @sink to @delay. The render delay is the time
1166 * between actual rendering of a buffer and its synchronisation time. Some
1167 * devices might delay media rendering which can be compensated for with this
1170 * After calling this function, this sink will report additional latency and
1171 * other sinks will adjust their latency to delay the rendering of their media.
1173 * This function is usually called by subclasses.
1178 gst_base_sink_set_render_delay (GstBaseSink * sink, GstClockTime delay)
1180 GstClockTime old_render_delay;
1182 g_return_if_fail (GST_IS_BASE_SINK (sink));
1184 GST_OBJECT_LOCK (sink);
1185 old_render_delay = sink->priv->render_delay;
1186 sink->priv->render_delay = delay;
1187 GST_LOG_OBJECT (sink, "set render delay to %" GST_TIME_FORMAT,
1188 GST_TIME_ARGS (delay));
1189 GST_OBJECT_UNLOCK (sink);
1191 if (delay != old_render_delay) {
1192 GST_DEBUG_OBJECT (sink, "posting latency changed");
1193 gst_element_post_message (GST_ELEMENT_CAST (sink),
1194 gst_message_new_latency (GST_OBJECT_CAST (sink)));
1199 * gst_base_sink_get_render_delay:
1200 * @sink: a #GstBaseSink
1202 * Get the render delay of @sink. see gst_base_sink_set_render_delay() for more
1203 * information about the render delay.
1205 * Returns: the render delay of @sink.
1210 gst_base_sink_get_render_delay (GstBaseSink * sink)
1212 GstClockTimeDiff res;
1214 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1216 GST_OBJECT_LOCK (sink);
1217 res = sink->priv->render_delay;
1218 GST_OBJECT_UNLOCK (sink);
1224 * gst_base_sink_set_blocksize:
1225 * @sink: a #GstBaseSink
1226 * @blocksize: the blocksize in bytes
1228 * Set the number of bytes that the sink will pull when it is operating in pull
1233 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
1235 gst_base_sink_set_blocksize (GstBaseSink * sink, guint blocksize)
1237 g_return_if_fail (GST_IS_BASE_SINK (sink));
1239 GST_OBJECT_LOCK (sink);
1240 sink->priv->blocksize = blocksize;
1241 GST_LOG_OBJECT (sink, "set blocksize to %u", blocksize);
1242 GST_OBJECT_UNLOCK (sink);
1246 * gst_base_sink_get_blocksize:
1247 * @sink: a #GstBaseSink
1249 * Get the number of bytes that the sink will pull when it is operating in pull
1252 * Returns: the number of bytes @sink will pull in pull mode.
1256 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
1258 gst_base_sink_get_blocksize (GstBaseSink * sink)
1262 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1264 GST_OBJECT_LOCK (sink);
1265 res = sink->priv->blocksize;
1266 GST_OBJECT_UNLOCK (sink);
1272 * gst_base_sink_set_throttle_time:
1273 * @sink: a #GstBaseSink
1274 * @throttle: the throttle time in nanoseconds
1276 * Set the time that will be inserted between rendered buffers. This
1277 * can be used to control the maximum buffers per second that the sink
1283 gst_base_sink_set_throttle_time (GstBaseSink * sink, guint64 throttle)
1285 g_return_if_fail (GST_IS_BASE_SINK (sink));
1287 GST_OBJECT_LOCK (sink);
1288 sink->priv->throttle_time = throttle;
1289 GST_LOG_OBJECT (sink, "set throttle_time to %" G_GUINT64_FORMAT, throttle);
1290 GST_OBJECT_UNLOCK (sink);
1294 * gst_base_sink_get_throttle_time:
1295 * @sink: a #GstBaseSink
1297 * Get the time that will be inserted between frames to control the
1298 * maximum buffers per second.
1300 * Returns: the number of nanoseconds @sink will put between frames.
1305 gst_base_sink_get_throttle_time (GstBaseSink * sink)
1309 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1311 GST_OBJECT_LOCK (sink);
1312 res = sink->priv->throttle_time;
1313 GST_OBJECT_UNLOCK (sink);
1319 gst_base_sink_set_property (GObject * object, guint prop_id,
1320 const GValue * value, GParamSpec * pspec)
1322 GstBaseSink *sink = GST_BASE_SINK (object);
1325 case PROP_PREROLL_QUEUE_LEN:
1326 /* preroll lock necessary to serialize with finish_preroll */
1327 GST_BASE_SINK_PREROLL_LOCK (sink);
1328 g_atomic_int_set (&sink->preroll_queue_max_len, g_value_get_uint (value));
1329 GST_BASE_SINK_PREROLL_UNLOCK (sink);
1332 gst_base_sink_set_sync (sink, g_value_get_boolean (value));
1334 case PROP_MAX_LATENESS:
1335 gst_base_sink_set_max_lateness (sink, g_value_get_int64 (value));
1338 gst_base_sink_set_qos_enabled (sink, g_value_get_boolean (value));
1341 gst_base_sink_set_async_enabled (sink, g_value_get_boolean (value));
1343 case PROP_TS_OFFSET:
1344 gst_base_sink_set_ts_offset (sink, g_value_get_int64 (value));
1346 case PROP_BLOCKSIZE:
1347 gst_base_sink_set_blocksize (sink, g_value_get_uint (value));
1349 case PROP_RENDER_DELAY:
1350 gst_base_sink_set_render_delay (sink, g_value_get_uint64 (value));
1352 case PROP_ENABLE_LAST_BUFFER:
1353 gst_base_sink_set_last_buffer_enabled (sink, g_value_get_boolean (value));
1355 case PROP_THROTTLE_TIME:
1356 gst_base_sink_set_throttle_time (sink, g_value_get_uint64 (value));
1359 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1365 gst_base_sink_get_property (GObject * object, guint prop_id, GValue * value,
1368 GstBaseSink *sink = GST_BASE_SINK (object);
1371 case PROP_PREROLL_QUEUE_LEN:
1372 g_value_set_uint (value, g_atomic_int_get (&sink->preroll_queue_max_len));
1375 g_value_set_boolean (value, gst_base_sink_get_sync (sink));
1377 case PROP_MAX_LATENESS:
1378 g_value_set_int64 (value, gst_base_sink_get_max_lateness (sink));
1381 g_value_set_boolean (value, gst_base_sink_is_qos_enabled (sink));
1384 g_value_set_boolean (value, gst_base_sink_is_async_enabled (sink));
1386 case PROP_TS_OFFSET:
1387 g_value_set_int64 (value, gst_base_sink_get_ts_offset (sink));
1389 case PROP_LAST_BUFFER:
1390 gst_value_take_buffer (value, gst_base_sink_get_last_buffer (sink));
1392 case PROP_ENABLE_LAST_BUFFER:
1393 g_value_set_boolean (value, gst_base_sink_is_last_buffer_enabled (sink));
1395 case PROP_BLOCKSIZE:
1396 g_value_set_uint (value, gst_base_sink_get_blocksize (sink));
1398 case PROP_RENDER_DELAY:
1399 g_value_set_uint64 (value, gst_base_sink_get_render_delay (sink));
1401 case PROP_THROTTLE_TIME:
1402 g_value_set_uint64 (value, gst_base_sink_get_throttle_time (sink));
1405 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1412 gst_base_sink_get_caps (GstBaseSink * sink, GstCaps * filter)
1418 gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps)
1423 /* with PREROLL_LOCK, STREAM_LOCK */
1425 gst_base_sink_preroll_queue_flush (GstBaseSink * basesink, GstPad * pad)
1429 GST_DEBUG_OBJECT (basesink, "flushing queue %p", basesink);
1430 while ((obj = g_queue_pop_head (basesink->preroll_queue))) {
1431 GST_DEBUG_OBJECT (basesink, "popped %p", obj);
1432 gst_mini_object_unref (obj);
1434 /* we can't have EOS anymore now */
1435 basesink->eos = FALSE;
1436 basesink->priv->received_eos = FALSE;
1437 basesink->have_preroll = FALSE;
1438 basesink->priv->step_unlock = FALSE;
1439 basesink->eos_queued = FALSE;
1440 basesink->preroll_queued = 0;
1441 basesink->buffers_queued = 0;
1442 basesink->events_queued = 0;
1443 /* can't report latency anymore until we preroll again */
1444 if (basesink->priv->async_enabled) {
1445 GST_OBJECT_LOCK (basesink);
1446 basesink->priv->have_latency = FALSE;
1447 GST_OBJECT_UNLOCK (basesink);
1449 /* and signal any waiters now */
1450 GST_BASE_SINK_PREROLL_SIGNAL (basesink);
1453 /* with STREAM_LOCK, configures given segment with the event information. */
1455 gst_base_sink_configure_segment (GstBaseSink * basesink, GstPad * pad,
1456 GstEvent * event, GstSegment * segment)
1458 /* The segment is protected with both the STREAM_LOCK and the OBJECT_LOCK.
1459 * We protect with the OBJECT_LOCK so that we can use the values to
1460 * safely answer a POSITION query. */
1461 GST_OBJECT_LOCK (basesink);
1462 /* the newsegment event is needed to bring the buffer timestamps to the
1463 * stream time and to drop samples outside of the playback segment. */
1464 gst_event_copy_segment (event, segment);
1465 GST_DEBUG_OBJECT (basesink, "configured SEGMENT %" GST_SEGMENT_FORMAT,
1467 GST_OBJECT_UNLOCK (basesink);
1470 /* with PREROLL_LOCK, STREAM_LOCK */
1472 gst_base_sink_commit_state (GstBaseSink * basesink)
1474 /* commit state and proceed to next pending state */
1475 GstState current, next, pending, post_pending;
1476 gboolean post_paused = FALSE;
1477 gboolean post_async_done = FALSE;
1478 gboolean post_playing = FALSE;
1479 gboolean reset_time;
1481 /* we are certainly not playing async anymore now */
1482 basesink->playing_async = FALSE;
1484 GST_OBJECT_LOCK (basesink);
1485 current = GST_STATE (basesink);
1486 next = GST_STATE_NEXT (basesink);
1487 pending = GST_STATE_PENDING (basesink);
1488 post_pending = pending;
1489 reset_time = basesink->priv->reset_time;
1490 basesink->priv->reset_time = FALSE;
1493 case GST_STATE_PLAYING:
1495 GST_DEBUG_OBJECT (basesink, "commiting state to PLAYING");
1497 basesink->need_preroll = FALSE;
1498 post_async_done = TRUE;
1499 basesink->priv->commited = TRUE;
1500 post_playing = TRUE;
1501 /* post PAUSED too when we were READY */
1502 if (current == GST_STATE_READY) {
1507 case GST_STATE_PAUSED:
1508 GST_DEBUG_OBJECT (basesink, "commiting state to PAUSED");
1510 post_async_done = TRUE;
1511 basesink->priv->commited = TRUE;
1512 post_pending = GST_STATE_VOID_PENDING;
1514 case GST_STATE_READY:
1515 case GST_STATE_NULL:
1517 case GST_STATE_VOID_PENDING:
1518 goto nothing_pending;
1523 /* we can report latency queries now */
1524 basesink->priv->have_latency = TRUE;
1526 GST_STATE (basesink) = pending;
1527 GST_STATE_NEXT (basesink) = GST_STATE_VOID_PENDING;
1528 GST_STATE_PENDING (basesink) = GST_STATE_VOID_PENDING;
1529 GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_SUCCESS;
1530 GST_OBJECT_UNLOCK (basesink);
1533 GST_DEBUG_OBJECT (basesink, "posting PAUSED state change message");
1534 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1535 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1536 current, next, post_pending));
1538 if (post_async_done) {
1539 GST_DEBUG_OBJECT (basesink, "posting async-done message");
1540 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1541 gst_message_new_async_done (GST_OBJECT_CAST (basesink), reset_time));
1544 GST_DEBUG_OBJECT (basesink, "posting PLAYING state change message");
1545 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1546 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1547 next, pending, GST_STATE_VOID_PENDING));
1550 GST_STATE_BROADCAST (basesink);
1556 /* Depending on the state, set our vars. We get in this situation when the
1557 * state change function got a change to update the state vars before the
1558 * streaming thread did. This is fine but we need to make sure that we
1559 * update the need_preroll var since it was TRUE when we got here and might
1560 * become FALSE if we got to PLAYING. */
1561 GST_DEBUG_OBJECT (basesink, "nothing to commit, now in %s",
1562 gst_element_state_get_name (current));
1564 case GST_STATE_PLAYING:
1565 basesink->need_preroll = FALSE;
1567 case GST_STATE_PAUSED:
1568 basesink->need_preroll = TRUE;
1571 basesink->need_preroll = FALSE;
1572 basesink->flushing = TRUE;
1575 /* we can report latency queries now */
1576 basesink->priv->have_latency = TRUE;
1577 GST_OBJECT_UNLOCK (basesink);
1582 /* app is going to READY */
1583 GST_DEBUG_OBJECT (basesink, "stopping");
1584 basesink->need_preroll = FALSE;
1585 basesink->flushing = TRUE;
1586 GST_OBJECT_UNLOCK (basesink);
1592 start_stepping (GstBaseSink * sink, GstSegment * segment,
1593 GstStepInfo * pending, GstStepInfo * current)
1596 GstMessage *message;
1598 GST_DEBUG_OBJECT (sink, "update pending step");
1600 GST_OBJECT_LOCK (sink);
1601 memcpy (current, pending, sizeof (GstStepInfo));
1602 pending->valid = FALSE;
1603 GST_OBJECT_UNLOCK (sink);
1605 /* post message first */
1607 gst_message_new_step_start (GST_OBJECT (sink), TRUE, current->format,
1608 current->amount, current->rate, current->flush, current->intermediate);
1609 gst_message_set_seqnum (message, current->seqnum);
1610 gst_element_post_message (GST_ELEMENT (sink), message);
1612 /* get the running time of where we paused and remember it */
1613 current->start = gst_element_get_start_time (GST_ELEMENT_CAST (sink));
1614 gst_segment_set_running_time (segment, GST_FORMAT_TIME, current->start);
1616 /* set the new rate for the remainder of the segment */
1617 current->start_rate = segment->rate;
1618 segment->rate *= current->rate;
1621 if (segment->rate > 0.0)
1622 current->start_stop = segment->stop;
1624 current->start_start = segment->start;
1626 if (current->format == GST_FORMAT_TIME) {
1627 end = current->start + current->amount;
1628 if (!current->flush) {
1629 /* update the segment clipping regions for non-flushing seeks */
1630 if (segment->rate > 0.0) {
1631 segment->stop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1632 segment->position = segment->stop;
1636 position = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1637 segment->time = position;
1638 segment->start = position;
1639 segment->position = position;
1644 GST_DEBUG_OBJECT (sink, "segment now %" GST_SEGMENT_FORMAT, segment);
1645 GST_DEBUG_OBJECT (sink, "step started at running_time %" GST_TIME_FORMAT,
1646 GST_TIME_ARGS (current->start));
1648 if (current->amount == -1) {
1649 GST_DEBUG_OBJECT (sink, "step amount == -1, stop stepping");
1650 current->valid = FALSE;
1652 GST_DEBUG_OBJECT (sink, "step amount: %" G_GUINT64_FORMAT ", format: %s, "
1653 "rate: %f", current->amount, gst_format_get_name (current->format),
1659 stop_stepping (GstBaseSink * sink, GstSegment * segment,
1660 GstStepInfo * current, gint64 rstart, gint64 rstop, gboolean eos)
1662 gint64 stop, position;
1663 GstMessage *message;
1665 GST_DEBUG_OBJECT (sink, "step complete");
1667 if (segment->rate > 0.0)
1672 GST_DEBUG_OBJECT (sink,
1673 "step stop at running_time %" GST_TIME_FORMAT, GST_TIME_ARGS (stop));
1676 current->duration = current->position;
1678 current->duration = stop - current->start;
1680 GST_DEBUG_OBJECT (sink, "step elapsed running_time %" GST_TIME_FORMAT,
1681 GST_TIME_ARGS (current->duration));
1683 position = current->start + current->duration;
1685 /* now move the segment to the new running time */
1686 gst_segment_set_running_time (segment, GST_FORMAT_TIME, position);
1688 if (current->flush) {
1689 /* and remove the time we flushed, start time did not change */
1690 segment->base = current->start;
1692 /* start time is now the stepped position */
1693 gst_element_set_start_time (GST_ELEMENT_CAST (sink), position);
1696 /* restore the previous rate */
1697 segment->rate = current->start_rate;
1699 if (segment->rate > 0.0)
1700 segment->stop = current->start_stop;
1702 segment->start = current->start_start;
1704 /* the clip segment is used for position report in paused... */
1705 gst_segment_copy_into (segment, &sink->clip_segment);
1707 /* post the step done when we know the stepped duration in TIME */
1709 gst_message_new_step_done (GST_OBJECT_CAST (sink), current->format,
1710 current->amount, current->rate, current->flush, current->intermediate,
1711 current->duration, eos);
1712 gst_message_set_seqnum (message, current->seqnum);
1713 gst_element_post_message (GST_ELEMENT_CAST (sink), message);
1715 if (!current->intermediate)
1716 sink->need_preroll = current->need_preroll;
1718 /* and the current step info finished and becomes invalid */
1719 current->valid = FALSE;
1723 handle_stepping (GstBaseSink * sink, GstSegment * segment,
1724 GstStepInfo * current, guint64 * cstart, guint64 * cstop, guint64 * rstart,
1727 gboolean step_end = FALSE;
1729 /* see if we need to skip this buffer because of stepping */
1730 switch (current->format) {
1731 case GST_FORMAT_TIME:
1734 guint64 first, last;
1737 if (segment->rate > 0.0) {
1738 if (segment->stop == *cstop)
1739 *rstop = *rstart + current->amount;
1744 if (segment->start == *cstart)
1745 *rstart = *rstop + current->amount;
1751 end = current->start + current->amount;
1752 current->position = first - current->start;
1754 abs_rate = ABS (segment->rate);
1755 if (G_UNLIKELY (abs_rate != 1.0))
1756 current->position /= abs_rate;
1758 GST_DEBUG_OBJECT (sink,
1759 "buffer: %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT,
1760 GST_TIME_ARGS (first), GST_TIME_ARGS (last));
1761 GST_DEBUG_OBJECT (sink,
1762 "got time step %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT "/%"
1763 GST_TIME_FORMAT, GST_TIME_ARGS (current->position),
1764 GST_TIME_ARGS (last - current->start),
1765 GST_TIME_ARGS (current->amount));
1767 if ((current->flush && current->position >= current->amount)
1769 GST_DEBUG_OBJECT (sink, "step ended, we need clipping");
1771 if (segment->rate > 0.0) {
1773 *cstart = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1776 *cstop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1779 GST_DEBUG_OBJECT (sink,
1780 "cstart %" GST_TIME_FORMAT ", rstart %" GST_TIME_FORMAT,
1781 GST_TIME_ARGS (*cstart), GST_TIME_ARGS (*rstart));
1782 GST_DEBUG_OBJECT (sink,
1783 "cstop %" GST_TIME_FORMAT ", rstop %" GST_TIME_FORMAT,
1784 GST_TIME_ARGS (*cstop), GST_TIME_ARGS (*rstop));
1787 case GST_FORMAT_BUFFERS:
1788 GST_DEBUG_OBJECT (sink,
1789 "got default step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1790 current->position, current->amount);
1792 if (current->position < current->amount) {
1793 current->position++;
1798 case GST_FORMAT_DEFAULT:
1800 GST_DEBUG_OBJECT (sink,
1801 "got unknown step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1802 current->position, current->amount);
1808 /* with STREAM_LOCK, PREROLL_LOCK
1810 * Returns TRUE if the object needs synchronisation and takes therefore
1811 * part in prerolling.
1813 * rsstart/rsstop contain the start/stop in stream time.
1814 * rrstart/rrstop contain the start/stop in running time.
1817 gst_base_sink_get_sync_times (GstBaseSink * basesink, GstMiniObject * obj,
1818 GstClockTime * rsstart, GstClockTime * rsstop,
1819 GstClockTime * rrstart, GstClockTime * rrstop, gboolean * do_sync,
1820 gboolean * stepped, GstSegment * segment, GstStepInfo * step,
1821 gboolean * step_end, guint8 obj_type)
1823 GstBaseSinkClass *bclass;
1825 GstClockTime start, stop; /* raw start/stop timestamps */
1826 guint64 cstart, cstop; /* clipped raw timestamps */
1827 guint64 rstart, rstop; /* clipped timestamps converted to running time */
1828 GstClockTime sstart, sstop; /* clipped timestamps converted to stream time */
1830 GstBaseSinkPrivate *priv;
1833 priv = basesink->priv;
1835 /* start with nothing */
1836 start = stop = GST_CLOCK_TIME_NONE;
1838 if (G_UNLIKELY (OBJ_IS_EVENT (obj_type))) {
1839 GstEvent *event = GST_EVENT_CAST (obj);
1841 switch (GST_EVENT_TYPE (event)) {
1842 /* EOS event needs syncing */
1845 if (basesink->segment.rate >= 0.0) {
1846 sstart = sstop = priv->current_sstop;
1847 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1848 /* we have not seen a buffer yet, use the segment values */
1849 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1850 basesink->segment.format, basesink->segment.stop);
1853 sstart = sstop = priv->current_sstart;
1854 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1855 /* we have not seen a buffer yet, use the segment values */
1856 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1857 basesink->segment.format, basesink->segment.start);
1861 rstart = rstop = priv->eos_rtime;
1862 *do_sync = rstart != -1;
1863 GST_DEBUG_OBJECT (basesink, "sync times for EOS %" GST_TIME_FORMAT,
1864 GST_TIME_ARGS (rstart));
1865 /* if we are stepping, we end now */
1866 *step_end = step->valid;
1871 /* other events do not need syncing */
1879 /* else do buffer sync code */
1880 buffer = GST_BUFFER_CAST (obj);
1882 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1884 /* just get the times to see if we need syncing, if the start returns -1 we
1886 if (bclass->get_times)
1887 bclass->get_times (basesink, buffer, &start, &stop);
1889 if (!GST_CLOCK_TIME_IS_VALID (start)) {
1890 /* we don't need to sync but we still want to get the timestamps for
1891 * tracking the position */
1892 gst_base_sink_get_times (basesink, buffer, &start, &stop);
1898 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
1899 ", stop: %" GST_TIME_FORMAT ", do_sync %d", GST_TIME_ARGS (start),
1900 GST_TIME_ARGS (stop), *do_sync);
1902 /* collect segment and format for code clarity */
1903 format = segment->format;
1906 if (G_UNLIKELY (!gst_segment_clip (segment, format,
1907 start, stop, &cstart, &cstop))) {
1909 GST_DEBUG_OBJECT (basesink, "step out of segment");
1910 /* when we are stepping, pretend we're at the end of the segment */
1911 if (segment->rate > 0.0) {
1912 cstart = segment->stop;
1913 cstop = segment->stop;
1915 cstart = segment->start;
1916 cstop = segment->start;
1920 goto out_of_segment;
1923 if (G_UNLIKELY (start != cstart || stop != cstop)) {
1924 GST_DEBUG_OBJECT (basesink, "clipped to: start %" GST_TIME_FORMAT
1925 ", stop: %" GST_TIME_FORMAT, GST_TIME_ARGS (cstart),
1926 GST_TIME_ARGS (cstop));
1929 /* set last stop position */
1930 if (G_LIKELY (stop != GST_CLOCK_TIME_NONE && cstop != GST_CLOCK_TIME_NONE))
1931 segment->position = cstop;
1933 segment->position = cstart;
1936 rstart = gst_segment_to_running_time (segment, format, cstart);
1937 rstop = gst_segment_to_running_time (segment, format, cstop);
1939 if (G_UNLIKELY (step->valid)) {
1940 if (!(*step_end = handle_stepping (basesink, segment, step, &cstart, &cstop,
1941 &rstart, &rstop))) {
1942 /* step is still busy, we discard data when we are flushing */
1943 *stepped = step->flush;
1944 GST_DEBUG_OBJECT (basesink, "stepping busy");
1947 /* this can produce wrong values if we accumulated non-TIME segments. If this happens,
1948 * upstream is behaving very badly */
1949 sstart = gst_segment_to_stream_time (segment, format, cstart);
1950 sstop = gst_segment_to_stream_time (segment, format, cstop);
1953 /* eos_done label only called when doing EOS, we also stop stepping then */
1954 if (*step_end && step->flush) {
1955 GST_DEBUG_OBJECT (basesink, "flushing step ended");
1956 stop_stepping (basesink, segment, step, rstart, rstop, eos);
1958 /* re-determine running start times for adjusted segment
1959 * (which has a flushed amount of running/accumulated time removed) */
1960 if (!GST_IS_EVENT (obj)) {
1961 GST_DEBUG_OBJECT (basesink, "refresh sync times");
1972 /* buffers and EOS always need syncing and preroll */
1978 /* we usually clip in the chain function already but stepping could cause
1979 * the segment to be updated later. we return FALSE so that we don't try
1981 GST_LOG_OBJECT (basesink, "buffer skipped, not in segment");
1986 /* with STREAM_LOCK, PREROLL_LOCK, LOCK
1987 * adjust a timestamp with the latency and timestamp offset. This function does
1988 * not adjust for the render delay. */
1990 gst_base_sink_adjust_time (GstBaseSink * basesink, GstClockTime time)
1992 GstClockTimeDiff ts_offset;
1994 /* don't do anything funny with invalid timestamps */
1995 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
1998 time += basesink->priv->latency;
2000 /* apply offset, be carefull for underflows */
2001 ts_offset = basesink->priv->ts_offset;
2002 if (ts_offset < 0) {
2003 ts_offset = -ts_offset;
2004 if (ts_offset < time)
2011 /* subtract the render delay again, which was included in the latency */
2012 if (time > basesink->priv->render_delay)
2013 time -= basesink->priv->render_delay;
2021 * gst_base_sink_wait_clock:
2023 * @time: the running_time to be reached
2024 * @jitter: (out) (allow-none): the jitter to be filled with time diff, or NULL
2026 * This function will block until @time is reached. It is usually called by
2027 * subclasses that use their own internal synchronisation.
2029 * If @time is not valid, no sycnhronisation is done and #GST_CLOCK_BADTIME is
2030 * returned. Likewise, if synchronisation is disabled in the element or there
2031 * is no clock, no synchronisation is done and #GST_CLOCK_BADTIME is returned.
2033 * This function should only be called with the PREROLL_LOCK held, like when
2034 * receiving an EOS event in the #GstBaseSinkClass.event() vmethod or when
2035 * receiving a buffer in
2036 * the #GstBaseSinkClass.render() vmethod.
2038 * The @time argument should be the running_time of when this method should
2039 * return and is not adjusted with any latency or offset configured in the
2044 * Returns: #GstClockReturn
2047 gst_base_sink_wait_clock (GstBaseSink * sink, GstClockTime time,
2048 GstClockTimeDiff * jitter)
2052 GstClockTime base_time;
2054 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
2057 GST_OBJECT_LOCK (sink);
2058 if (G_UNLIKELY (!sink->sync))
2061 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (sink)) == NULL))
2064 base_time = GST_ELEMENT_CAST (sink)->base_time;
2065 GST_LOG_OBJECT (sink,
2066 "time %" GST_TIME_FORMAT ", base_time %" GST_TIME_FORMAT,
2067 GST_TIME_ARGS (time), GST_TIME_ARGS (base_time));
2069 /* add base_time to running_time to get the time against the clock */
2072 /* Re-use existing clockid if available */
2073 /* FIXME: Casting to GstClockEntry only works because the types
2075 if (G_LIKELY (sink->priv->cached_clock_id != NULL
2076 && GST_CLOCK_ENTRY_CLOCK ((GstClockEntry *) sink->priv->
2077 cached_clock_id) == clock)) {
2078 if (!gst_clock_single_shot_id_reinit (clock, sink->priv->cached_clock_id,
2080 gst_clock_id_unref (sink->priv->cached_clock_id);
2081 sink->priv->cached_clock_id = gst_clock_new_single_shot_id (clock, time);
2084 if (sink->priv->cached_clock_id != NULL)
2085 gst_clock_id_unref (sink->priv->cached_clock_id);
2086 sink->priv->cached_clock_id = gst_clock_new_single_shot_id (clock, time);
2088 GST_OBJECT_UNLOCK (sink);
2090 /* A blocking wait is performed on the clock. We save the ClockID
2091 * so we can unlock the entry at any time. While we are blocking, we
2092 * release the PREROLL_LOCK so that other threads can interrupt the
2094 sink->clock_id = sink->priv->cached_clock_id;
2095 /* release the preroll lock while waiting */
2096 GST_BASE_SINK_PREROLL_UNLOCK (sink);
2098 ret = gst_clock_id_wait (sink->priv->cached_clock_id, jitter);
2100 GST_BASE_SINK_PREROLL_LOCK (sink);
2101 sink->clock_id = NULL;
2105 /* no syncing needed */
2108 GST_DEBUG_OBJECT (sink, "time not valid, no sync needed");
2109 return GST_CLOCK_BADTIME;
2113 GST_DEBUG_OBJECT (sink, "sync disabled");
2114 GST_OBJECT_UNLOCK (sink);
2115 return GST_CLOCK_BADTIME;
2119 GST_DEBUG_OBJECT (sink, "no clock, can't sync");
2120 GST_OBJECT_UNLOCK (sink);
2121 return GST_CLOCK_BADTIME;
2126 * gst_base_sink_wait_preroll:
2129 * If the #GstBaseSinkClass.render() method performs its own synchronisation
2130 * against the clock it must unblock when going from PLAYING to the PAUSED state
2131 * and call this method before continuing to render the remaining data.
2133 * This function will block until a state change to PLAYING happens (in which
2134 * case this function returns #GST_FLOW_OK) or the processing must be stopped due
2135 * to a state change to READY or a FLUSH event (in which case this function
2136 * returns #GST_FLOW_WRONG_STATE).
2138 * This function should only be called with the PREROLL_LOCK held, like in the
2141 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2142 * continue. Any other return value should be returned from the render vmethod.
2147 gst_base_sink_wait_preroll (GstBaseSink * sink)
2149 sink->have_preroll = TRUE;
2150 GST_DEBUG_OBJECT (sink, "waiting in preroll for flush or PLAYING");
2151 /* block until the state changes, or we get a flush, or something */
2152 GST_BASE_SINK_PREROLL_WAIT (sink);
2153 sink->have_preroll = FALSE;
2154 if (G_UNLIKELY (sink->flushing))
2156 if (G_UNLIKELY (sink->priv->step_unlock))
2158 GST_DEBUG_OBJECT (sink, "continue after preroll");
2165 GST_DEBUG_OBJECT (sink, "preroll interrupted because of flush");
2166 return GST_FLOW_WRONG_STATE;
2170 sink->priv->step_unlock = FALSE;
2171 GST_DEBUG_OBJECT (sink, "preroll interrupted because of step");
2172 return GST_FLOW_STEP;
2176 static inline guint8
2177 get_object_type (GstMiniObject * obj)
2181 if (G_LIKELY (GST_IS_BUFFER (obj)))
2182 obj_type = _PR_IS_BUFFER;
2183 else if (GST_IS_EVENT (obj))
2184 obj_type = _PR_IS_EVENT;
2185 else if (GST_IS_BUFFER_LIST (obj))
2186 obj_type = _PR_IS_BUFFERLIST;
2188 obj_type = _PR_IS_NOTHING;
2194 * gst_base_sink_do_preroll:
2196 * @obj: (transfer none): the mini object that caused the preroll
2198 * If the @sink spawns its own thread for pulling buffers from upstream it
2199 * should call this method after it has pulled a buffer. If the element needed
2200 * to preroll, this function will perform the preroll and will then block
2201 * until the element state is changed.
2203 * This function should be called with the PREROLL_LOCK held.
2205 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2206 * continue. Any other return value should be returned from the render vmethod.
2211 gst_base_sink_do_preroll (GstBaseSink * sink, GstMiniObject * obj)
2215 while (G_UNLIKELY (sink->need_preroll)) {
2217 GST_DEBUG_OBJECT (sink, "prerolling object %p", obj);
2219 obj_type = get_object_type (obj);
2221 ret = gst_base_sink_preroll_object (sink, obj_type, obj);
2222 if (ret != GST_FLOW_OK)
2223 goto preroll_failed;
2225 /* need to recheck here because the commit state could have
2226 * made us not need the preroll anymore */
2227 if (G_LIKELY (sink->need_preroll)) {
2228 /* block until the state changes, or we get a flush, or something */
2229 ret = gst_base_sink_wait_preroll (sink);
2230 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2231 goto preroll_failed;
2239 GST_DEBUG_OBJECT (sink, "preroll failed: %s", gst_flow_get_name (ret));
2245 * gst_base_sink_wait_eos:
2247 * @time: the running_time to be reached
2248 * @jitter: (out) (allow-none): the jitter to be filled with time diff, or NULL
2250 * This function will block until @time is reached. It is usually called by
2251 * subclasses that use their own internal synchronisation but want to let the
2252 * EOS be handled by the base class.
2254 * This function should only be called with the PREROLL_LOCK held, like when
2255 * receiving an EOS event in the ::event vmethod.
2257 * The @time argument should be the running_time of when the EOS should happen
2258 * and will be adjusted with any latency and offset configured in the sink.
2260 * Returns: #GstFlowReturn
2265 gst_base_sink_wait_eos (GstBaseSink * sink, GstClockTime time,
2266 GstClockTimeDiff * jitter)
2268 GstClockReturn status;
2274 GST_DEBUG_OBJECT (sink, "checking preroll");
2276 /* first wait for the playing state before we can continue */
2277 while (G_UNLIKELY (sink->need_preroll)) {
2278 ret = gst_base_sink_wait_preroll (sink);
2279 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2283 /* preroll done, we can sync since we are in PLAYING now. */
2284 GST_DEBUG_OBJECT (sink, "possibly waiting for clock to reach %"
2285 GST_TIME_FORMAT, GST_TIME_ARGS (time));
2287 /* compensate for latency and ts_offset. We don't adjust for render delay
2288 * because we don't interact with the device on EOS normally. */
2289 stime = gst_base_sink_adjust_time (sink, time);
2291 /* wait for the clock, this can be interrupted because we got shut down or
2293 status = gst_base_sink_wait_clock (sink, stime, jitter);
2295 GST_DEBUG_OBJECT (sink, "clock returned %d", status);
2297 /* invalid time, no clock or sync disabled, just continue then */
2298 if (status == GST_CLOCK_BADTIME)
2301 /* waiting could have been interrupted and we can be flushing now */
2302 if (G_UNLIKELY (sink->flushing))
2305 /* retry if we got unscheduled, which means we did not reach the timeout
2306 * yet. if some other error occures, we continue. */
2307 } while (status == GST_CLOCK_UNSCHEDULED);
2309 GST_DEBUG_OBJECT (sink, "end of stream");
2316 GST_DEBUG_OBJECT (sink, "we are flushing");
2317 return GST_FLOW_WRONG_STATE;
2321 /* with STREAM_LOCK, PREROLL_LOCK
2323 * Make sure we are in PLAYING and synchronize an object to the clock.
2325 * If we need preroll, we are not in PLAYING. We try to commit the state
2326 * if needed and then block if we still are not PLAYING.
2328 * We start waiting on the clock in PLAYING. If we got interrupted, we
2329 * immediatly try to re-preroll.
2331 * Some objects do not need synchronisation (most events) and so this function
2332 * immediatly returns GST_FLOW_OK.
2334 * for objects that arrive later than max-lateness to be synchronized to the
2335 * clock have the @late boolean set to TRUE.
2337 * This function keeps a running average of the jitter (the diff between the
2338 * clock time and the requested sync time). The jitter is negative for
2339 * objects that arrive in time and positive for late buffers.
2341 * does not take ownership of obj.
2343 static GstFlowReturn
2344 gst_base_sink_do_sync (GstBaseSink * basesink, GstPad * pad,
2345 GstMiniObject * obj, gboolean * late, gboolean * step_end, guint8 obj_type)
2347 GstClockTimeDiff jitter = 0;
2349 GstClockReturn status = GST_CLOCK_OK;
2350 GstClockTime rstart, rstop, sstart, sstop, stime;
2352 GstBaseSinkPrivate *priv;
2354 GstStepInfo *current, *pending;
2357 priv = basesink->priv;
2360 sstart = sstop = rstart = rstop = GST_CLOCK_TIME_NONE;
2364 priv->current_rstart = GST_CLOCK_TIME_NONE;
2366 /* get stepping info */
2367 current = &priv->current_step;
2368 pending = &priv->pending_step;
2370 /* get timing information for this object against the render segment */
2371 syncable = gst_base_sink_get_sync_times (basesink, obj,
2372 &sstart, &sstop, &rstart, &rstop, &do_sync, &stepped, &basesink->segment,
2373 current, step_end, obj_type);
2375 if (G_UNLIKELY (stepped))
2378 /* a syncable object needs to participate in preroll and
2379 * clocking. All buffers and EOS are syncable. */
2380 if (G_UNLIKELY (!syncable))
2383 /* store timing info for current object */
2384 priv->current_rstart = rstart;
2385 priv->current_rstop = (GST_CLOCK_TIME_IS_VALID (rstop) ? rstop : rstart);
2387 /* save sync time for eos when the previous object needed sync */
2388 priv->eos_rtime = (do_sync ? priv->current_rstop : GST_CLOCK_TIME_NONE);
2390 /* calculate inter frame spacing */
2391 if (G_UNLIKELY (priv->prev_rstart != -1 && priv->prev_rstart < rstart)) {
2392 GstClockTime in_diff;
2394 in_diff = rstart - priv->prev_rstart;
2396 if (priv->avg_in_diff == -1)
2397 priv->avg_in_diff = in_diff;
2399 priv->avg_in_diff = UPDATE_RUNNING_AVG (priv->avg_in_diff, in_diff);
2401 GST_LOG_OBJECT (basesink, "avg frame diff %" GST_TIME_FORMAT,
2402 GST_TIME_ARGS (priv->avg_in_diff));
2405 priv->prev_rstart = rstart;
2407 if (G_UNLIKELY (priv->earliest_in_time != -1
2408 && rstart < priv->earliest_in_time))
2412 /* first do preroll, this makes sure we commit our state
2413 * to PAUSED and can continue to PLAYING. We cannot perform
2414 * any clock sync in PAUSED because there is no clock. */
2415 ret = gst_base_sink_do_preroll (basesink, obj);
2416 if (G_UNLIKELY (ret != GST_FLOW_OK))
2417 goto preroll_failed;
2419 /* update the segment with a pending step if the current one is invalid and we
2420 * have a new pending one. We only accept new step updates after a preroll */
2421 if (G_UNLIKELY (pending->valid && !current->valid)) {
2422 start_stepping (basesink, &basesink->segment, pending, current);
2426 /* After rendering we store the position of the last buffer so that we can use
2427 * it to report the position. We need to take the lock here. */
2428 GST_OBJECT_LOCK (basesink);
2429 priv->current_sstart = sstart;
2430 priv->current_sstop = (GST_CLOCK_TIME_IS_VALID (sstop) ? sstop : sstart);
2431 GST_OBJECT_UNLOCK (basesink);
2436 /* adjust for latency */
2437 stime = gst_base_sink_adjust_time (basesink, rstart);
2439 /* adjust for render-delay, avoid underflows */
2440 if (GST_CLOCK_TIME_IS_VALID (stime)) {
2441 if (stime > priv->render_delay)
2442 stime -= priv->render_delay;
2447 /* preroll done, we can sync since we are in PLAYING now. */
2448 GST_DEBUG_OBJECT (basesink, "possibly waiting for clock to reach %"
2449 GST_TIME_FORMAT ", adjusted %" GST_TIME_FORMAT,
2450 GST_TIME_ARGS (rstart), GST_TIME_ARGS (stime));
2452 /* This function will return immediatly if start == -1, no clock
2453 * or sync is disabled with GST_CLOCK_BADTIME. */
2454 status = gst_base_sink_wait_clock (basesink, stime, &jitter);
2456 GST_DEBUG_OBJECT (basesink, "clock returned %d, jitter %c%" GST_TIME_FORMAT,
2457 status, (jitter < 0 ? '-' : ' '), GST_TIME_ARGS (ABS (jitter)));
2459 /* invalid time, no clock or sync disabled, just render */
2460 if (status == GST_CLOCK_BADTIME)
2463 /* waiting could have been interrupted and we can be flushing now */
2464 if (G_UNLIKELY (basesink->flushing))
2467 /* check for unlocked by a state change, we are not flushing so
2468 * we can try to preroll on the current buffer. */
2469 if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED)) {
2470 GST_DEBUG_OBJECT (basesink, "unscheduled, waiting some more");
2471 priv->call_preroll = TRUE;
2475 /* successful syncing done, record observation */
2476 priv->current_jitter = jitter;
2478 /* check if the object should be dropped */
2479 *late = gst_base_sink_is_too_late (basesink, obj, rstart, rstop,
2488 GST_DEBUG_OBJECT (basesink, "skipped stepped object %p", obj);
2494 GST_DEBUG_OBJECT (basesink, "non syncable object %p", obj);
2499 GST_DEBUG_OBJECT (basesink, "dropped because of QoS %p", obj);
2505 GST_DEBUG_OBJECT (basesink, "we are flushing");
2506 return GST_FLOW_WRONG_STATE;
2510 GST_DEBUG_OBJECT (basesink, "preroll failed");
2517 gst_base_sink_send_qos (GstBaseSink * basesink, GstQOSType type,
2518 gdouble proportion, GstClockTime time, GstClockTimeDiff diff)
2523 /* generate Quality-of-Service event */
2524 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2525 "qos: type %d, proportion: %lf, diff %" G_GINT64_FORMAT ", timestamp %"
2526 GST_TIME_FORMAT, type, proportion, diff, GST_TIME_ARGS (time));
2528 event = gst_event_new_qos (type, proportion, diff, time);
2531 res = gst_pad_push_event (basesink->sinkpad, event);
2537 gst_base_sink_perform_qos (GstBaseSink * sink, gboolean dropped)
2539 GstBaseSinkPrivate *priv;
2540 GstClockTime start, stop;
2541 GstClockTimeDiff jitter;
2542 GstClockTime pt, entered, left;
2543 GstClockTime duration;
2548 start = priv->current_rstart;
2550 if (priv->current_step.valid)
2553 /* if Quality-of-Service disabled, do nothing */
2554 if (!g_atomic_int_get (&priv->qos_enabled) ||
2555 !GST_CLOCK_TIME_IS_VALID (start))
2558 stop = priv->current_rstop;
2559 jitter = priv->current_jitter;
2562 /* this is the time the buffer entered the sink */
2563 if (start < -jitter)
2566 entered = start + jitter;
2569 /* this is the time the buffer entered the sink */
2570 entered = start + jitter;
2571 /* this is the time the buffer left the sink */
2572 left = start + jitter;
2575 /* calculate duration of the buffer */
2576 if (GST_CLOCK_TIME_IS_VALID (stop) && stop != start)
2577 duration = stop - start;
2579 duration = priv->avg_in_diff;
2581 /* if we have the time when the last buffer left us, calculate
2582 * processing time */
2583 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2584 if (entered > priv->last_left) {
2585 pt = entered - priv->last_left;
2593 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "start: %" GST_TIME_FORMAT
2594 ", stop %" GST_TIME_FORMAT ", entered %" GST_TIME_FORMAT ", left %"
2595 GST_TIME_FORMAT ", pt: %" GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT
2596 ",jitter %" G_GINT64_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (stop),
2597 GST_TIME_ARGS (entered), GST_TIME_ARGS (left), GST_TIME_ARGS (pt),
2598 GST_TIME_ARGS (duration), jitter);
2600 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "avg_duration: %" GST_TIME_FORMAT
2601 ", avg_pt: %" GST_TIME_FORMAT ", avg_rate: %g",
2602 GST_TIME_ARGS (priv->avg_duration), GST_TIME_ARGS (priv->avg_pt),
2605 /* collect running averages. for first observations, we copy the
2607 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_duration))
2608 priv->avg_duration = duration;
2610 priv->avg_duration = UPDATE_RUNNING_AVG (priv->avg_duration, duration);
2612 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_pt))
2615 priv->avg_pt = UPDATE_RUNNING_AVG (priv->avg_pt, pt);
2617 if (priv->avg_duration != 0)
2619 gst_guint64_to_gdouble (priv->avg_pt) /
2620 gst_guint64_to_gdouble (priv->avg_duration);
2624 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2625 if (dropped || priv->avg_rate < 0.0) {
2626 priv->avg_rate = rate;
2629 priv->avg_rate = UPDATE_RUNNING_AVG_N (priv->avg_rate, rate);
2631 priv->avg_rate = UPDATE_RUNNING_AVG_P (priv->avg_rate, rate);
2635 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink,
2636 "updated: avg_duration: %" GST_TIME_FORMAT ", avg_pt: %" GST_TIME_FORMAT
2637 ", avg_rate: %g", GST_TIME_ARGS (priv->avg_duration),
2638 GST_TIME_ARGS (priv->avg_pt), priv->avg_rate);
2641 if (priv->avg_rate >= 0.0) {
2643 GstClockTimeDiff diff;
2645 /* if we have a valid rate, start sending QoS messages */
2646 if (priv->current_jitter < 0) {
2647 /* make sure we never go below 0 when adding the jitter to the
2649 if (priv->current_rstart < -priv->current_jitter)
2650 priv->current_jitter = -priv->current_rstart;
2653 if (priv->throttle_time > 0) {
2654 diff = priv->throttle_time;
2655 type = GST_QOS_TYPE_THROTTLE;
2657 diff = priv->current_jitter;
2659 type = GST_QOS_TYPE_OVERFLOW;
2661 type = GST_QOS_TYPE_UNDERFLOW;
2664 gst_base_sink_send_qos (sink, type, priv->avg_rate, priv->current_rstart,
2668 /* record when this buffer will leave us */
2669 priv->last_left = left;
2672 /* reset all qos measuring */
2674 gst_base_sink_reset_qos (GstBaseSink * sink)
2676 GstBaseSinkPrivate *priv;
2680 priv->last_render_time = GST_CLOCK_TIME_NONE;
2681 priv->prev_rstart = GST_CLOCK_TIME_NONE;
2682 priv->earliest_in_time = GST_CLOCK_TIME_NONE;
2683 priv->last_left = GST_CLOCK_TIME_NONE;
2684 priv->avg_duration = GST_CLOCK_TIME_NONE;
2685 priv->avg_pt = GST_CLOCK_TIME_NONE;
2686 priv->avg_rate = -1.0;
2687 priv->avg_render = GST_CLOCK_TIME_NONE;
2688 priv->avg_in_diff = GST_CLOCK_TIME_NONE;
2694 /* Checks if the object was scheduled too late.
2696 * rstart/rstop contain the running_time start and stop values
2699 * status and jitter contain the return values from the clock wait.
2701 * returns TRUE if the buffer was too late.
2704 gst_base_sink_is_too_late (GstBaseSink * basesink, GstMiniObject * obj,
2705 GstClockTime rstart, GstClockTime rstop,
2706 GstClockReturn status, GstClockTimeDiff jitter)
2709 guint64 max_lateness;
2710 GstBaseSinkPrivate *priv;
2712 priv = basesink->priv;
2716 /* only for objects that were too late */
2717 if (G_LIKELY (status != GST_CLOCK_EARLY))
2720 max_lateness = basesink->max_lateness;
2722 /* check if frame dropping is enabled */
2723 if (max_lateness == -1)
2726 /* only check for buffers */
2727 if (G_UNLIKELY (!GST_IS_BUFFER (obj)))
2730 /* can't do check if we don't have a timestamp */
2731 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (rstart)))
2734 /* we can add a valid stop time */
2735 if (GST_CLOCK_TIME_IS_VALID (rstop))
2736 max_lateness += rstop;
2738 max_lateness += rstart;
2739 /* no stop time, use avg frame diff */
2740 if (priv->avg_in_diff != -1)
2741 max_lateness += priv->avg_in_diff;
2744 /* if the jitter bigger than duration and lateness we are too late */
2745 if ((late = rstart + jitter > max_lateness)) {
2746 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2747 "buffer is too late %" GST_TIME_FORMAT
2748 " > %" GST_TIME_FORMAT, GST_TIME_ARGS (rstart + jitter),
2749 GST_TIME_ARGS (max_lateness));
2750 /* !!emergency!!, if we did not receive anything valid for more than a
2751 * second, render it anyway so the user sees something */
2752 if (GST_CLOCK_TIME_IS_VALID (priv->last_render_time) &&
2753 rstart - priv->last_render_time > GST_SECOND) {
2755 GST_ELEMENT_WARNING (basesink, CORE, CLOCK,
2756 (_("A lot of buffers are being dropped.")),
2757 ("There may be a timestamping problem, or this computer is too slow."));
2758 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2759 "**emergency** last buffer at %" GST_TIME_FORMAT " > GST_SECOND",
2760 GST_TIME_ARGS (priv->last_render_time));
2765 if (!late || !GST_CLOCK_TIME_IS_VALID (priv->last_render_time)) {
2766 priv->last_render_time = rstart;
2767 /* the next allowed input timestamp */
2768 if (priv->throttle_time > 0)
2769 priv->earliest_in_time = rstart + priv->throttle_time;
2776 GST_DEBUG_OBJECT (basesink, "object was scheduled in time");
2781 GST_DEBUG_OBJECT (basesink, "frame dropping disabled");
2786 GST_DEBUG_OBJECT (basesink, "object is not a buffer");
2791 GST_DEBUG_OBJECT (basesink, "buffer has no timestamp");
2796 /* called before and after calling the render vmethod. It keeps track of how
2797 * much time was spent in the render method and is used to check if we are
2800 gst_base_sink_do_render_stats (GstBaseSink * basesink, gboolean start)
2802 GstBaseSinkPrivate *priv;
2804 priv = basesink->priv;
2807 priv->start = gst_util_get_timestamp ();
2809 GstClockTime elapsed;
2811 priv->stop = gst_util_get_timestamp ();
2813 elapsed = GST_CLOCK_DIFF (priv->start, priv->stop);
2815 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_render))
2816 priv->avg_render = elapsed;
2818 priv->avg_render = UPDATE_RUNNING_AVG (priv->avg_render, elapsed);
2820 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2821 "avg_render: %" GST_TIME_FORMAT, GST_TIME_ARGS (priv->avg_render));
2825 /* with STREAM_LOCK, PREROLL_LOCK,
2827 * Synchronize the object on the clock and then render it.
2829 * takes ownership of obj.
2831 static GstFlowReturn
2832 gst_base_sink_render_object (GstBaseSink * basesink, GstPad * pad,
2833 guint8 obj_type, gpointer obj)
2836 GstBaseSinkClass *bclass;
2837 gboolean late, step_end;
2839 GstBaseSinkPrivate *priv;
2841 priv = basesink->priv;
2843 if (OBJ_IS_BUFFERLIST (obj_type)) {
2845 * If buffer list, use the first group buffer within the list
2848 sync_obj = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0);
2849 g_assert (NULL != sync_obj);
2858 /* synchronize this object, non syncable objects return OK
2861 gst_base_sink_do_sync (basesink, pad, sync_obj, &late, &step_end,
2863 if (G_UNLIKELY (ret != GST_FLOW_OK))
2866 /* and now render, event or buffer/buffer list. */
2867 if (G_LIKELY (OBJ_IS_BUFFERFULL (obj_type))) {
2868 /* drop late buffers unconditionally, let's hope it's unlikely */
2869 if (G_UNLIKELY (late))
2872 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2874 if (G_LIKELY ((OBJ_IS_BUFFERLIST (obj_type) && bclass->render_list) ||
2875 (!OBJ_IS_BUFFERLIST (obj_type) && bclass->render))) {
2878 /* read once, to get same value before and after */
2879 do_qos = g_atomic_int_get (&priv->qos_enabled);
2881 GST_DEBUG_OBJECT (basesink, "rendering object %p", obj);
2883 /* record rendering time for QoS and stats */
2885 gst_base_sink_do_render_stats (basesink, TRUE);
2887 if (!OBJ_IS_BUFFERLIST (obj_type)) {
2890 /* For buffer lists do not set last buffer. Creating buffer
2891 * with meaningful data can be done only with memcpy which will
2892 * significantly affect performance */
2893 buf = GST_BUFFER_CAST (obj);
2894 gst_base_sink_set_last_buffer (basesink, buf);
2896 ret = bclass->render (basesink, buf);
2898 GstBufferList *buflist;
2900 buflist = GST_BUFFER_LIST_CAST (obj);
2902 ret = bclass->render_list (basesink, buflist);
2906 gst_base_sink_do_render_stats (basesink, FALSE);
2908 if (ret == GST_FLOW_STEP)
2911 if (G_UNLIKELY (basesink->flushing))
2916 } else if (G_LIKELY (OBJ_IS_EVENT (obj_type))) {
2917 GstEvent *event = GST_EVENT_CAST (obj);
2918 gboolean event_res = TRUE;
2921 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2923 type = GST_EVENT_TYPE (event);
2925 GST_DEBUG_OBJECT (basesink, "rendering event %p, type %s", obj,
2926 gst_event_type_get_name (type));
2929 event_res = bclass->event (basesink, event);
2931 /* when we get here we could be flushing again when the event handler calls
2932 * _wait_eos(). We have to ignore this object in that case. */
2933 if (G_UNLIKELY (basesink->flushing))
2936 if (G_LIKELY (event_res)) {
2939 seqnum = basesink->priv->seqnum = gst_event_get_seqnum (event);
2940 GST_DEBUG_OBJECT (basesink, "Got seqnum #%" G_GUINT32_FORMAT, seqnum);
2945 GstMessage *message;
2947 /* the EOS event is completely handled so we mark
2948 * ourselves as being in the EOS state. eos is also
2949 * protected by the object lock so we can read it when
2950 * answering the POSITION query. */
2951 GST_OBJECT_LOCK (basesink);
2952 basesink->eos = TRUE;
2953 GST_OBJECT_UNLOCK (basesink);
2955 /* ok, now we can post the message */
2956 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
2958 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
2959 gst_message_set_seqnum (message, seqnum);
2960 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
2963 case GST_EVENT_SEGMENT:
2964 /* configure the segment */
2965 gst_base_sink_configure_segment (basesink, pad, event,
2966 &basesink->segment);
2970 GstTagList *taglist;
2972 gst_event_parse_tag (event, &taglist);
2974 gst_element_post_message (GST_ELEMENT_CAST (basesink),
2975 gst_message_new_tag (GST_OBJECT_CAST (basesink),
2976 gst_tag_list_copy (taglist)));
2979 case GST_EVENT_SINK_MESSAGE:
2981 GstMessage *msg = NULL;
2983 gst_event_parse_sink_message (event, &msg);
2986 gst_element_post_message (GST_ELEMENT_CAST (basesink), msg);
2993 g_return_val_if_reached (GST_FLOW_ERROR);
2998 /* the step ended, check if we need to activate a new step */
2999 GST_DEBUG_OBJECT (basesink, "step ended");
3000 stop_stepping (basesink, &basesink->segment, &priv->current_step,
3001 priv->current_rstart, priv->current_rstop, basesink->eos);
3005 gst_base_sink_perform_qos (basesink, late);
3007 GST_DEBUG_OBJECT (basesink, "object unref after render %p", obj);
3008 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3014 GST_DEBUG_OBJECT (basesink, "do_sync returned %s", gst_flow_get_name (ret));
3020 GST_DEBUG_OBJECT (basesink, "buffer late, dropping");
3022 if (g_atomic_int_get (&priv->qos_enabled)) {
3023 GstMessage *qos_msg;
3024 GstClockTime timestamp, duration;
3026 timestamp = GST_BUFFER_TIMESTAMP (GST_BUFFER_CAST (sync_obj));
3027 duration = GST_BUFFER_DURATION (GST_BUFFER_CAST (sync_obj));
3029 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
3030 "qos: dropped buffer rt %" GST_TIME_FORMAT ", st %" GST_TIME_FORMAT
3031 ", ts %" GST_TIME_FORMAT ", dur %" GST_TIME_FORMAT,
3032 GST_TIME_ARGS (priv->current_rstart),
3033 GST_TIME_ARGS (priv->current_sstart), GST_TIME_ARGS (timestamp),
3034 GST_TIME_ARGS (duration));
3035 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
3036 "qos: rendered %" G_GUINT64_FORMAT ", dropped %" G_GUINT64_FORMAT,
3037 priv->rendered, priv->dropped);
3040 gst_message_new_qos (GST_OBJECT_CAST (basesink), basesink->sync,
3041 priv->current_rstart, priv->current_sstart, timestamp, duration);
3042 gst_message_set_qos_values (qos_msg, priv->current_jitter, priv->avg_rate,
3044 gst_message_set_qos_stats (qos_msg, GST_FORMAT_BUFFERS, priv->rendered,
3046 gst_element_post_message (GST_ELEMENT_CAST (basesink), qos_msg);
3052 GST_DEBUG_OBJECT (basesink, "we are flushing, ignore object");
3053 gst_mini_object_unref (obj);
3054 return GST_FLOW_WRONG_STATE;
3058 /* with STREAM_LOCK, PREROLL_LOCK
3060 * Perform preroll on the given object. For buffers this means
3061 * calling the preroll subclass method.
3062 * If that succeeds, the state will be commited.
3064 * function does not take ownership of obj.
3066 static GstFlowReturn
3067 gst_base_sink_preroll_object (GstBaseSink * basesink, guint8 obj_type,
3068 GstMiniObject * obj)
3072 GST_DEBUG_OBJECT (basesink, "prerolling object %p", obj);
3074 /* if it's a buffer, we need to call the preroll method */
3075 if (G_LIKELY (OBJ_IS_BUFFERFULL (obj_type) && basesink->priv->call_preroll)) {
3076 GstBaseSinkClass *bclass;
3078 GstClockTime timestamp;
3080 if (OBJ_IS_BUFFERLIST (obj_type)) {
3081 buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0);
3082 g_assert (NULL != buf);
3084 buf = GST_BUFFER_CAST (obj);
3087 timestamp = GST_BUFFER_TIMESTAMP (buf);
3089 GST_DEBUG_OBJECT (basesink, "preroll buffer %" GST_TIME_FORMAT,
3090 GST_TIME_ARGS (timestamp));
3093 * For buffer lists do not set last buffer. Creating buffer
3094 * with meaningful data can be done only with memcpy which will
3095 * significantly affect performance
3097 if (!OBJ_IS_BUFFERLIST (obj_type)) {
3098 gst_base_sink_set_last_buffer (basesink, buf);
3101 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3102 if (bclass->preroll)
3103 if ((ret = bclass->preroll (basesink, buf)) != GST_FLOW_OK)
3104 goto preroll_failed;
3106 basesink->priv->call_preroll = FALSE;
3110 if (G_LIKELY (basesink->playing_async)) {
3111 if (G_UNLIKELY (!gst_base_sink_commit_state (basesink)))
3120 GST_DEBUG_OBJECT (basesink, "preroll failed, abort state");
3121 gst_element_abort_state (GST_ELEMENT_CAST (basesink));
3126 GST_DEBUG_OBJECT (basesink, "stopping while commiting state");
3127 return GST_FLOW_WRONG_STATE;
3131 /* with STREAM_LOCK, PREROLL_LOCK
3133 * Queue an object for rendering.
3134 * The first prerollable object queued will complete the preroll. If the
3135 * preroll queue is filled, we render all the objects in the queue.
3137 * This function takes ownership of the object.
3139 static GstFlowReturn
3140 gst_base_sink_queue_object_unlocked (GstBaseSink * basesink, GstPad * pad,
3141 guint8 obj_type, gpointer obj, gboolean prerollable)
3143 GstFlowReturn ret = GST_FLOW_OK;
3147 if (G_UNLIKELY (basesink->need_preroll)) {
3148 if (G_LIKELY (prerollable))
3149 basesink->preroll_queued++;
3151 length = basesink->preroll_queued;
3153 GST_DEBUG_OBJECT (basesink, "now %d prerolled items", length);
3155 /* first prerollable item needs to finish the preroll */
3157 ret = gst_base_sink_preroll_object (basesink, obj_type, obj);
3158 if (G_UNLIKELY (ret != GST_FLOW_OK))
3159 goto preroll_failed;
3161 /* need to recheck if we need preroll, commmit state during preroll
3162 * could have made us not need more preroll. */
3163 if (G_UNLIKELY (basesink->need_preroll)) {
3164 /* see if we can render now, if we can't add the object to the preroll
3166 if (G_UNLIKELY (length <= basesink->preroll_queue_max_len))
3170 /* we can start rendering (or blocking) the queued object
3172 q = basesink->preroll_queue;
3173 while (G_UNLIKELY (!g_queue_is_empty (q))) {
3177 o = g_queue_pop_head (q);
3178 GST_DEBUG_OBJECT (basesink, "rendering queued object %p", o);
3180 ot = get_object_type (o);
3182 /* do something with the return value */
3183 ret = gst_base_sink_render_object (basesink, pad, ot, o);
3184 if (ret != GST_FLOW_OK)
3185 goto dequeue_failed;
3188 /* now render the object */
3189 ret = gst_base_sink_render_object (basesink, pad, obj_type, obj);
3190 basesink->preroll_queued = 0;
3197 GST_DEBUG_OBJECT (basesink, "preroll failed, reason %s",
3198 gst_flow_get_name (ret));
3199 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3204 /* add object to the queue and return */
3205 GST_DEBUG_OBJECT (basesink, "need more preroll data %d <= %d",
3206 length, basesink->preroll_queue_max_len);
3207 g_queue_push_tail (basesink->preroll_queue, obj);
3212 GST_DEBUG_OBJECT (basesink, "rendering queued objects failed, reason %s",
3213 gst_flow_get_name (ret));
3214 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3221 * This function grabs the PREROLL_LOCK and adds the object to
3224 * This function takes ownership of obj.
3226 * Note: Only GstEvent seem to be passed to this private method
3228 static GstFlowReturn
3229 gst_base_sink_queue_object (GstBaseSink * basesink, GstPad * pad,
3230 GstMiniObject * obj, gboolean prerollable)
3234 GST_BASE_SINK_PREROLL_LOCK (basesink);
3235 if (G_UNLIKELY (basesink->flushing))
3238 if (G_UNLIKELY (basesink->priv->received_eos))
3242 gst_base_sink_queue_object_unlocked (basesink, pad, _PR_IS_EVENT, obj,
3244 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3251 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3252 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3253 gst_mini_object_unref (obj);
3254 return GST_FLOW_WRONG_STATE;
3258 GST_DEBUG_OBJECT (basesink,
3259 "we are EOS, dropping object, return UNEXPECTED");
3260 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3261 gst_mini_object_unref (obj);
3262 return GST_FLOW_UNEXPECTED;
3267 gst_base_sink_flush_start (GstBaseSink * basesink, GstPad * pad)
3269 /* make sure we are not blocked on the clock also clear any pending
3271 gst_base_sink_set_flushing (basesink, pad, TRUE);
3273 /* we grab the stream lock but that is not needed since setting the
3274 * sink to flushing would make sure no state commit is being done
3276 GST_PAD_STREAM_LOCK (pad);
3277 gst_base_sink_reset_qos (basesink);
3278 /* and we need to commit our state again on the next
3279 * prerolled buffer */
3280 basesink->playing_async = TRUE;
3281 if (basesink->priv->async_enabled) {
3282 gst_element_lost_state (GST_ELEMENT_CAST (basesink));
3284 basesink->priv->have_latency = TRUE;
3286 gst_base_sink_set_last_buffer (basesink, NULL);
3287 GST_PAD_STREAM_UNLOCK (pad);
3291 gst_base_sink_flush_stop (GstBaseSink * basesink, GstPad * pad,
3292 gboolean reset_time)
3294 /* unset flushing so we can accept new data, this also flushes out any EOS
3296 gst_base_sink_set_flushing (basesink, pad, FALSE);
3298 /* for position reporting */
3299 GST_OBJECT_LOCK (basesink);
3300 basesink->priv->current_sstart = GST_CLOCK_TIME_NONE;
3301 basesink->priv->current_sstop = GST_CLOCK_TIME_NONE;
3302 basesink->priv->eos_rtime = GST_CLOCK_TIME_NONE;
3303 basesink->priv->call_preroll = TRUE;
3304 basesink->priv->current_step.valid = FALSE;
3305 basesink->priv->pending_step.valid = FALSE;
3306 if (basesink->pad_mode == GST_ACTIVATE_PUSH) {
3307 /* we need new segment info after the flush. */
3308 basesink->have_newsegment = FALSE;
3310 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
3311 gst_segment_init (&basesink->clip_segment, GST_FORMAT_UNDEFINED);
3314 basesink->priv->reset_time = reset_time;
3315 GST_OBJECT_UNLOCK (basesink);
3319 gst_base_sink_event (GstPad * pad, GstEvent * event)
3321 GstBaseSink *basesink;
3322 gboolean result = TRUE;
3323 GstBaseSinkClass *bclass;
3325 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3326 if (G_UNLIKELY (basesink == NULL)) {
3327 gst_event_unref (event);
3331 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3333 GST_DEBUG_OBJECT (basesink, "received event %p %" GST_PTR_FORMAT, event,
3336 switch (GST_EVENT_TYPE (event)) {
3341 GST_BASE_SINK_PREROLL_LOCK (basesink);
3342 if (G_UNLIKELY (basesink->flushing))
3345 if (G_UNLIKELY (basesink->priv->received_eos))
3348 /* we set the received EOS flag here so that we can use it when testing if
3349 * we are prerolled and to refuse more buffers. */
3350 basesink->priv->received_eos = TRUE;
3352 /* EOS is a prerollable object, we call the unlocked version because it
3353 * does not check the received_eos flag. */
3354 ret = gst_base_sink_queue_object_unlocked (basesink, pad,
3355 _PR_IS_EVENT, GST_MINI_OBJECT_CAST (event), TRUE);
3356 if (G_UNLIKELY (ret != GST_FLOW_OK))
3359 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3362 case GST_EVENT_CAPS:
3366 GST_DEBUG_OBJECT (basesink, "caps %p", event);
3368 gst_event_parse_caps (event, &caps);
3369 if (bclass->set_caps)
3370 result = bclass->set_caps (basesink, caps);
3372 gst_event_unref (event);
3375 case GST_EVENT_SEGMENT:
3379 GST_DEBUG_OBJECT (basesink, "segment %p", event);
3381 GST_BASE_SINK_PREROLL_LOCK (basesink);
3382 if (G_UNLIKELY (basesink->flushing))
3385 if (G_UNLIKELY (basesink->priv->received_eos))
3388 /* the new segment is a non prerollable item and does not block anything,
3389 * we need to configure the current clipping segment and insert the event
3390 * in the queue to serialize it with the buffers for rendering. */
3391 gst_base_sink_configure_segment (basesink, pad, event,
3392 &basesink->clip_segment);
3395 gst_base_sink_queue_object_unlocked (basesink, pad,
3396 _PR_IS_EVENT, GST_MINI_OBJECT_CAST (event), FALSE);
3397 if (G_UNLIKELY (ret != GST_FLOW_OK))
3400 GST_OBJECT_LOCK (basesink);
3401 basesink->have_newsegment = TRUE;
3402 GST_OBJECT_UNLOCK (basesink);
3404 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3407 case GST_EVENT_FLUSH_START:
3409 bclass->event (basesink, event);
3411 GST_DEBUG_OBJECT (basesink, "flush-start %p", event);
3413 gst_base_sink_flush_start (basesink, pad);
3415 gst_event_unref (event);
3417 case GST_EVENT_FLUSH_STOP:
3419 gboolean reset_time;
3422 bclass->event (basesink, event);
3424 gst_event_parse_flush_stop (event, &reset_time);
3425 GST_DEBUG_OBJECT (basesink, "flush-stop %p, reset_time: %d", event,
3428 gst_base_sink_flush_stop (basesink, pad, reset_time);
3430 gst_event_unref (event);
3434 /* other events are sent to queue or subclass depending on if they
3435 * are serialized. */
3436 if (GST_EVENT_IS_SERIALIZED (event)) {
3437 gst_base_sink_queue_object (basesink, pad,
3438 GST_MINI_OBJECT_CAST (event), FALSE);
3441 bclass->event (basesink, event);
3442 gst_event_unref (event);
3447 gst_object_unref (basesink);
3454 GST_DEBUG_OBJECT (basesink, "we are flushing");
3455 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3457 gst_event_unref (event);
3463 GST_DEBUG_OBJECT (basesink, "Event received after EOS, dropping");
3464 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3466 gst_event_unref (event);
3471 /* default implementation to calculate the start and end
3472 * timestamps on a buffer, subclasses can override
3475 gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
3476 GstClockTime * start, GstClockTime * end)
3478 GstClockTime timestamp, duration;
3480 timestamp = GST_BUFFER_TIMESTAMP (buffer);
3481 if (GST_CLOCK_TIME_IS_VALID (timestamp)) {
3483 /* get duration to calculate end time */
3484 duration = GST_BUFFER_DURATION (buffer);
3485 if (GST_CLOCK_TIME_IS_VALID (duration)) {
3486 *end = timestamp + duration;
3492 /* must be called with PREROLL_LOCK */
3494 gst_base_sink_needs_preroll (GstBaseSink * basesink)
3496 gboolean is_prerolled, res;
3498 /* we have 2 cases where the PREROLL_LOCK is released:
3499 * 1) we are blocking in the PREROLL_LOCK and thus are prerolled.
3500 * 2) we are syncing on the clock
3502 is_prerolled = basesink->have_preroll || basesink->priv->received_eos;
3503 res = !is_prerolled;
3505 GST_DEBUG_OBJECT (basesink, "have_preroll: %d, EOS: %d => needs preroll: %d",
3506 basesink->have_preroll, basesink->priv->received_eos, res);
3511 /* with STREAM_LOCK, PREROLL_LOCK
3513 * Takes a buffer and compare the timestamps with the last segment.
3514 * If the buffer falls outside of the segment boundaries, drop it.
3515 * Else queue the buffer for preroll and rendering.
3517 * This function takes ownership of the buffer.
3519 static GstFlowReturn
3520 gst_base_sink_chain_unlocked (GstBaseSink * basesink, GstPad * pad,
3521 guint8 obj_type, gpointer obj)
3523 GstBaseSinkClass *bclass;
3524 GstFlowReturn result;
3525 GstClockTime start = GST_CLOCK_TIME_NONE, end = GST_CLOCK_TIME_NONE;
3526 GstSegment *clip_segment;
3527 GstBuffer *time_buf;
3529 if (G_UNLIKELY (basesink->flushing))
3532 if (G_UNLIKELY (basesink->priv->received_eos))
3535 if (OBJ_IS_BUFFERLIST (obj_type)) {
3536 time_buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0);
3537 g_assert (NULL != time_buf);
3539 time_buf = GST_BUFFER_CAST (obj);
3542 /* for code clarity */
3543 clip_segment = &basesink->clip_segment;
3545 if (G_UNLIKELY (!basesink->have_newsegment)) {
3548 sync = gst_base_sink_get_sync (basesink);
3550 GST_ELEMENT_WARNING (basesink, STREAM, FAILED,
3551 (_("Internal data flow problem.")),
3552 ("Received buffer without a new-segment. Assuming timestamps start from 0."));
3555 /* this means this sink will assume timestamps start from 0 */
3556 GST_OBJECT_LOCK (basesink);
3557 clip_segment->start = 0;
3558 clip_segment->stop = -1;
3559 basesink->segment.start = 0;
3560 basesink->segment.stop = -1;
3561 basesink->have_newsegment = TRUE;
3562 GST_OBJECT_UNLOCK (basesink);
3565 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3567 /* check if the buffer needs to be dropped, we first ask the subclass for the
3569 if (bclass->get_times)
3570 bclass->get_times (basesink, time_buf, &start, &end);
3572 if (!GST_CLOCK_TIME_IS_VALID (start)) {
3573 /* if the subclass does not want sync, we use our own values so that we at
3574 * least clip the buffer to the segment */
3575 gst_base_sink_get_times (basesink, time_buf, &start, &end);
3578 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
3579 ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (end));
3581 /* a dropped buffer does not participate in anything */
3582 if (GST_CLOCK_TIME_IS_VALID (start) &&
3583 (clip_segment->format == GST_FORMAT_TIME)) {
3584 if (G_UNLIKELY (!gst_segment_clip (clip_segment,
3585 GST_FORMAT_TIME, start, end, NULL, NULL)))
3586 goto out_of_segment;
3589 /* now we can process the buffer in the queue, this function takes ownership
3591 result = gst_base_sink_queue_object_unlocked (basesink, pad,
3592 obj_type, obj, TRUE);
3598 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3599 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3600 return GST_FLOW_WRONG_STATE;
3604 GST_DEBUG_OBJECT (basesink,
3605 "we are EOS, dropping object, return UNEXPECTED");
3606 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3607 return GST_FLOW_UNEXPECTED;
3611 GST_DEBUG_OBJECT (basesink, "dropping buffer, out of clipping segment");
3612 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3619 static GstFlowReturn
3620 gst_base_sink_chain_main (GstBaseSink * basesink, GstPad * pad,
3621 guint8 obj_type, gpointer obj)
3623 GstFlowReturn result;
3625 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH))
3628 GST_BASE_SINK_PREROLL_LOCK (basesink);
3629 result = gst_base_sink_chain_unlocked (basesink, pad, obj_type, obj);
3630 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3638 GST_OBJECT_LOCK (pad);
3639 GST_WARNING_OBJECT (basesink,
3640 "Push on pad %s:%s, but it was not activated in push mode",
3641 GST_DEBUG_PAD_NAME (pad));
3642 GST_OBJECT_UNLOCK (pad);
3643 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3644 /* we don't post an error message this will signal to the peer
3645 * pushing that EOS is reached. */
3646 result = GST_FLOW_UNEXPECTED;
3651 static GstFlowReturn
3652 gst_base_sink_chain (GstPad * pad, GstBuffer * buf)
3654 GstBaseSink *basesink;
3656 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3658 return gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFER, buf);
3661 static GstFlowReturn
3662 gst_base_sink_chain_list (GstPad * pad, GstBufferList * list)
3664 GstBaseSink *basesink;
3665 GstBaseSinkClass *bclass;
3666 GstFlowReturn result;
3668 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3669 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3671 if (G_LIKELY (bclass->render_list)) {
3672 result = gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFERLIST, list);
3677 GST_INFO_OBJECT (pad, "chaining each group in list as a merged buffer");
3679 len = gst_buffer_list_len (list);
3681 result = GST_FLOW_OK;
3682 for (i = 0; i < len; i++) {
3683 buffer = gst_buffer_list_get (list, 0);
3684 result = gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFER,
3685 gst_buffer_ref (buffer));
3686 if (result != GST_FLOW_OK)
3689 gst_buffer_list_unref (list);
3696 gst_base_sink_default_do_seek (GstBaseSink * sink, GstSegment * segment)
3698 gboolean res = TRUE;
3700 /* update our offset if the start/stop position was updated */
3701 if (segment->format == GST_FORMAT_BYTES) {
3702 segment->time = segment->start;
3703 } else if (segment->start == 0) {
3704 /* seek to start, we can implement a default for this. */
3708 GST_INFO_OBJECT (sink, "Can't do a default seek");
3714 #define SEEK_TYPE_IS_RELATIVE(t) (((t) != GST_SEEK_TYPE_NONE) && ((t) != GST_SEEK_TYPE_SET))
3717 gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
3718 GstEvent * event, GstSegment * segment)
3720 /* By default, we try one of 2 things:
3721 * - For absolute seek positions, convert the requested position to our
3722 * configured processing format and place it in the output segment \
3723 * - For relative seek positions, convert our current (input) values to the
3724 * seek format, adjust by the relative seek offset and then convert back to
3725 * the processing format
3727 GstSeekType cur_type, stop_type;
3730 GstFormat seek_format;
3733 gboolean res = TRUE;
3735 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3736 &cur_type, &cur, &stop_type, &stop);
3738 if (seek_format == segment->format) {
3739 gst_segment_do_seek (segment, rate, seek_format, flags,
3740 cur_type, cur, stop_type, stop, &update);
3744 if (cur_type != GST_SEEK_TYPE_NONE) {
3745 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3747 gst_pad_query_convert (sink->sinkpad, seek_format, cur, segment->format,
3749 cur_type = GST_SEEK_TYPE_SET;
3752 if (res && stop_type != GST_SEEK_TYPE_NONE) {
3753 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3755 gst_pad_query_convert (sink->sinkpad, seek_format, stop,
3756 segment->format, &stop);
3757 stop_type = GST_SEEK_TYPE_SET;
3760 /* And finally, configure our output segment in the desired format */
3761 gst_segment_do_seek (segment, rate, segment->format, flags, cur_type, cur,
3762 stop_type, stop, &update);
3771 GST_DEBUG_OBJECT (sink, "undefined format given, seek aborted.");
3776 /* perform a seek, only executed in pull mode */
3778 gst_base_sink_perform_seek (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3782 GstFormat seek_format, dest_format;
3784 GstSeekType cur_type, stop_type;
3785 gboolean seekseg_configured = FALSE;
3787 gboolean update, res = TRUE;
3788 GstSegment seeksegment;
3790 dest_format = sink->segment.format;
3793 GST_DEBUG_OBJECT (sink, "performing seek with event %p", event);
3794 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3795 &cur_type, &cur, &stop_type, &stop);
3797 flush = flags & GST_SEEK_FLAG_FLUSH;
3799 GST_DEBUG_OBJECT (sink, "performing seek without event");
3804 GST_DEBUG_OBJECT (sink, "flushing upstream");
3805 gst_pad_push_event (pad, gst_event_new_flush_start ());
3806 gst_base_sink_flush_start (sink, pad);
3808 GST_DEBUG_OBJECT (sink, "pausing pulling thread");
3811 GST_PAD_STREAM_LOCK (pad);
3813 /* If we configured the seeksegment above, don't overwrite it now. Otherwise
3814 * copy the current segment info into the temp segment that we can actually
3815 * attempt the seek with. We only update the real segment if the seek suceeds. */
3816 if (!seekseg_configured) {
3817 memcpy (&seeksegment, &sink->segment, sizeof (GstSegment));
3819 /* now configure the final seek segment */
3821 if (sink->segment.format != seek_format) {
3822 /* OK, here's where we give the subclass a chance to convert the relative
3823 * seek into an absolute one in the processing format. We set up any
3824 * absolute seek above, before taking the stream lock. */
3825 if (!gst_base_sink_default_prepare_seek_segment (sink, event,
3827 GST_DEBUG_OBJECT (sink,
3828 "Preparing the seek failed after flushing. " "Aborting seek");
3832 /* The seek format matches our processing format, no need to ask the
3833 * the subclass to configure the segment. */
3834 gst_segment_do_seek (&seeksegment, rate, seek_format, flags,
3835 cur_type, cur, stop_type, stop, &update);
3838 /* Else, no seek event passed, so we're just (re)starting the
3843 GST_DEBUG_OBJECT (sink, "segment configured from %" G_GINT64_FORMAT
3844 " to %" G_GINT64_FORMAT ", position %" G_GINT64_FORMAT,
3845 seeksegment.start, seeksegment.stop, seeksegment.position);
3847 /* do the seek, segment.position contains the new position. */
3848 res = gst_base_sink_default_do_seek (sink, &seeksegment);
3853 GST_DEBUG_OBJECT (sink, "stop flushing upstream");
3854 gst_pad_push_event (pad, gst_event_new_flush_stop (TRUE));
3855 gst_base_sink_flush_stop (sink, pad, TRUE);
3856 } else if (res && sink->running) {
3857 /* we are running the current segment and doing a non-flushing seek,
3858 * close the segment first based on the position. */
3859 GST_DEBUG_OBJECT (sink, "closing running segment %" G_GINT64_FORMAT
3860 " to %" G_GINT64_FORMAT, sink->segment.start, sink->segment.position);
3863 /* The subclass must have converted the segment to the processing format
3865 if (res && seeksegment.format != dest_format) {
3866 GST_DEBUG_OBJECT (sink, "Subclass failed to prepare a seek segment "
3867 "in the correct format. Aborting seek.");
3871 /* if successfull seek, we update our real segment and push
3872 * out the new segment. */
3874 gst_segment_copy_into (&seeksegment, &sink->segment);
3876 if (sink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3877 gst_element_post_message (GST_ELEMENT (sink),
3878 gst_message_new_segment_start (GST_OBJECT (sink),
3879 sink->segment.format, sink->segment.position));
3883 sink->priv->discont = TRUE;
3884 sink->running = TRUE;
3886 GST_PAD_STREAM_UNLOCK (pad);
3892 set_step_info (GstBaseSink * sink, GstStepInfo * current, GstStepInfo * pending,
3893 guint seqnum, GstFormat format, guint64 amount, gdouble rate,
3894 gboolean flush, gboolean intermediate)
3896 GST_OBJECT_LOCK (sink);
3897 pending->seqnum = seqnum;
3898 pending->format = format;
3899 pending->amount = amount;
3900 pending->position = 0;
3901 pending->rate = rate;
3902 pending->flush = flush;
3903 pending->intermediate = intermediate;
3904 pending->valid = TRUE;
3905 /* flush invalidates the current stepping segment */
3907 current->valid = FALSE;
3908 GST_OBJECT_UNLOCK (sink);
3912 gst_base_sink_perform_step (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3914 GstBaseSinkPrivate *priv;
3915 GstBaseSinkClass *bclass;
3916 gboolean flush, intermediate;
3921 GstStepInfo *pending, *current;
3922 GstMessage *message;
3924 bclass = GST_BASE_SINK_GET_CLASS (sink);
3927 GST_DEBUG_OBJECT (sink, "performing step with event %p", event);
3929 gst_event_parse_step (event, &format, &amount, &rate, &flush, &intermediate);
3930 seqnum = gst_event_get_seqnum (event);
3932 pending = &priv->pending_step;
3933 current = &priv->current_step;
3935 /* post message first */
3936 message = gst_message_new_step_start (GST_OBJECT (sink), FALSE, format,
3937 amount, rate, flush, intermediate);
3938 gst_message_set_seqnum (message, seqnum);
3939 gst_element_post_message (GST_ELEMENT (sink), message);
3942 /* we need to call ::unlock before locking PREROLL_LOCK
3943 * since we lock it before going into ::render */
3945 bclass->unlock (sink);
3947 GST_BASE_SINK_PREROLL_LOCK (sink);
3948 /* now that we have the PREROLL lock, clear our unlock request */
3949 if (bclass->unlock_stop)
3950 bclass->unlock_stop (sink);
3952 /* update the stepinfo and make it valid */
3953 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3956 if (sink->priv->async_enabled) {
3957 /* and we need to commit our state again on the next
3958 * prerolled buffer */
3959 sink->playing_async = TRUE;
3960 priv->pending_step.need_preroll = TRUE;
3961 sink->need_preroll = FALSE;
3962 gst_element_lost_state (GST_ELEMENT_CAST (sink));
3964 sink->priv->have_latency = TRUE;
3965 sink->need_preroll = FALSE;
3967 priv->current_sstart = GST_CLOCK_TIME_NONE;
3968 priv->current_sstop = GST_CLOCK_TIME_NONE;
3969 priv->eos_rtime = GST_CLOCK_TIME_NONE;
3970 priv->call_preroll = TRUE;
3971 gst_base_sink_set_last_buffer (sink, NULL);
3972 gst_base_sink_reset_qos (sink);
3974 if (sink->clock_id) {
3975 gst_clock_id_unschedule (sink->clock_id);
3978 if (sink->have_preroll) {
3979 GST_DEBUG_OBJECT (sink, "signal waiter");
3980 priv->step_unlock = TRUE;
3981 GST_BASE_SINK_PREROLL_SIGNAL (sink);
3983 GST_BASE_SINK_PREROLL_UNLOCK (sink);
3985 /* update the stepinfo and make it valid */
3986 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3996 gst_base_sink_loop (GstPad * pad)
3998 GstBaseSink *basesink;
3999 GstBuffer *buf = NULL;
4000 GstFlowReturn result;
4004 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
4006 g_assert (basesink->pad_mode == GST_ACTIVATE_PULL);
4008 if ((blocksize = basesink->priv->blocksize) == 0)
4011 offset = basesink->segment.position;
4013 GST_DEBUG_OBJECT (basesink, "pulling %" G_GUINT64_FORMAT ", %u",
4016 result = gst_pad_pull_range (pad, offset, blocksize, &buf);
4017 if (G_UNLIKELY (result != GST_FLOW_OK))
4020 if (G_UNLIKELY (buf == NULL))
4023 offset += gst_buffer_get_size (buf);
4025 basesink->segment.position = offset;
4027 GST_BASE_SINK_PREROLL_LOCK (basesink);
4028 result = gst_base_sink_chain_unlocked (basesink, pad, _PR_IS_BUFFER, buf);
4029 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4030 if (G_UNLIKELY (result != GST_FLOW_OK))
4038 GST_LOG_OBJECT (basesink, "pausing task, reason %s",
4039 gst_flow_get_name (result));
4040 gst_pad_pause_task (pad);
4041 if (result == GST_FLOW_UNEXPECTED) {
4042 /* perform EOS logic */
4043 if (basesink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
4044 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4045 gst_message_new_segment_done (GST_OBJECT_CAST (basesink),
4046 basesink->segment.format, basesink->segment.position));
4048 gst_base_sink_event (pad, gst_event_new_eos ());
4050 } else if (result == GST_FLOW_NOT_LINKED || result <= GST_FLOW_UNEXPECTED) {
4051 /* for fatal errors we post an error message, post the error
4052 * first so the app knows about the error first.
4053 * wrong-state is not a fatal error because it happens due to
4054 * flushing and posting an error message in that case is the
4055 * wrong thing to do, e.g. when basesrc is doing a flushing
4057 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
4058 (_("Internal data stream error.")),
4059 ("stream stopped, reason %s", gst_flow_get_name (result)));
4060 gst_base_sink_event (pad, gst_event_new_eos ());
4066 GST_LOG_OBJECT (basesink, "no buffer, pausing");
4067 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
4068 (_("Internal data flow error.")), ("element returned NULL buffer"));
4069 result = GST_FLOW_ERROR;
4075 gst_base_sink_set_flushing (GstBaseSink * basesink, GstPad * pad,
4078 GstBaseSinkClass *bclass;
4080 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4083 /* unlock any subclasses, we need to do this before grabbing the
4084 * PREROLL_LOCK since we hold this lock before going into ::render. */
4086 bclass->unlock (basesink);
4089 GST_BASE_SINK_PREROLL_LOCK (basesink);
4090 basesink->flushing = flushing;
4092 /* step 1, now that we have the PREROLL lock, clear our unlock request */
4093 if (bclass->unlock_stop)
4094 bclass->unlock_stop (basesink);
4096 /* set need_preroll before we unblock the clock. If the clock is unblocked
4097 * before timing out, we can reuse the buffer for preroll. */
4098 basesink->need_preroll = TRUE;
4100 /* step 2, unblock clock sync (if any) or any other blocking thing */
4101 if (basesink->clock_id) {
4102 gst_clock_id_unschedule (basesink->clock_id);
4105 /* flush out the data thread if it's locked in finish_preroll, this will
4106 * also flush out the EOS state */
4107 GST_DEBUG_OBJECT (basesink,
4108 "flushing out data thread, need preroll to TRUE");
4109 gst_base_sink_preroll_queue_flush (basesink, pad);
4111 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4117 gst_base_sink_default_activate_pull (GstBaseSink * basesink, gboolean active)
4123 result = gst_pad_start_task (basesink->sinkpad,
4124 (GstTaskFunction) gst_base_sink_loop, basesink->sinkpad);
4126 /* step 2, make sure streaming finishes */
4127 result = gst_pad_stop_task (basesink->sinkpad);
4134 gst_base_sink_pad_activate (GstPad * pad)
4136 gboolean result = FALSE;
4137 GstBaseSink *basesink;
4141 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4143 GST_DEBUG_OBJECT (basesink, "Trying pull mode first");
4145 gst_base_sink_set_flushing (basesink, pad, FALSE);
4147 /* we need to have the pull mode enabled */
4148 if (!basesink->can_activate_pull) {
4149 GST_DEBUG_OBJECT (basesink, "pull mode disabled");
4153 /* check if downstreams supports pull mode at all */
4154 query = gst_query_new_scheduling ();
4156 if (!gst_pad_peer_query (pad, query)) {
4157 gst_query_unref (query);
4158 GST_DEBUG_OBJECT (basesink, "peer query faild, no pull mode");
4162 /* parse result of the query */
4163 gst_query_parse_scheduling (query, &pull_mode, NULL, NULL, NULL, NULL, NULL);
4164 gst_query_unref (query);
4167 GST_DEBUG_OBJECT (basesink, "pull mode not supported");
4171 /* set the pad mode before starting the task so that it's in the
4172 * correct state for the new thread. also the sink set_caps and get_caps
4173 * function checks this */
4174 basesink->pad_mode = GST_ACTIVATE_PULL;
4176 /* we first try to negotiate a format so that when we try to activate
4177 * downstream, it knows about our format */
4178 if (!gst_base_sink_negotiate_pull (basesink)) {
4179 GST_DEBUG_OBJECT (basesink, "failed to negotiate in pull mode");
4183 /* ok activate now */
4184 if (!gst_pad_activate_pull (pad, TRUE)) {
4185 /* clear any pending caps */
4186 GST_OBJECT_LOCK (basesink);
4187 gst_caps_replace (&basesink->priv->pull_caps, NULL);
4188 GST_OBJECT_UNLOCK (basesink);
4189 GST_DEBUG_OBJECT (basesink, "failed to activate in pull mode");
4193 GST_DEBUG_OBJECT (basesink, "Success activating pull mode");
4197 /* push mode fallback */
4199 GST_DEBUG_OBJECT (basesink, "Falling back to push mode");
4200 if ((result = gst_pad_activate_push (pad, TRUE))) {
4201 GST_DEBUG_OBJECT (basesink, "Success activating push mode");
4206 GST_WARNING_OBJECT (basesink, "Could not activate pad in either mode");
4207 gst_base_sink_set_flushing (basesink, pad, TRUE);
4210 gst_object_unref (basesink);
4216 gst_base_sink_pad_activate_push (GstPad * pad, gboolean active)
4219 GstBaseSink *basesink;
4221 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4224 if (!basesink->can_activate_push) {
4226 basesink->pad_mode = GST_ACTIVATE_NONE;
4229 basesink->pad_mode = GST_ACTIVATE_PUSH;
4232 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH)) {
4233 g_warning ("Internal GStreamer activation error!!!");
4236 gst_base_sink_set_flushing (basesink, pad, TRUE);
4238 basesink->pad_mode = GST_ACTIVATE_NONE;
4242 gst_object_unref (basesink);
4248 gst_base_sink_negotiate_pull (GstBaseSink * basesink)
4255 /* this returns the intersection between our caps and the peer caps. If there
4256 * is no peer, it returns NULL and we can't operate in pull mode so we can
4257 * fail the negotiation. */
4258 caps = gst_pad_get_allowed_caps (GST_BASE_SINK_PAD (basesink));
4259 if (caps == NULL || gst_caps_is_empty (caps))
4260 goto no_caps_possible;
4262 GST_DEBUG_OBJECT (basesink, "allowed caps: %" GST_PTR_FORMAT, caps);
4264 caps = gst_caps_make_writable (caps);
4265 /* get the first (prefered) format */
4266 gst_caps_truncate (caps);
4268 GST_DEBUG_OBJECT (basesink, "have caps: %" GST_PTR_FORMAT, caps);
4270 if (gst_caps_is_any (caps)) {
4271 GST_DEBUG_OBJECT (basesink, "caps were ANY after fixating, "
4273 /* neither side has template caps in this case, so they are prepared for
4274 pull() without setcaps() */
4278 gst_pad_fixate_caps (GST_BASE_SINK_PAD (basesink), caps);
4279 GST_DEBUG_OBJECT (basesink, "fixated to: %" GST_PTR_FORMAT, caps);
4281 if (gst_caps_is_fixed (caps)) {
4282 if (!gst_pad_send_event (GST_BASE_SINK_PAD (basesink),
4283 gst_event_new_caps (caps)))
4284 goto could_not_set_caps;
4286 GST_OBJECT_LOCK (basesink);
4287 gst_caps_replace (&basesink->priv->pull_caps, caps);
4288 GST_OBJECT_UNLOCK (basesink);
4294 gst_caps_unref (caps);
4300 GST_INFO_OBJECT (basesink, "Pipeline could not agree on caps");
4301 GST_DEBUG_OBJECT (basesink, "get_allowed_caps() returned EMPTY");
4303 gst_caps_unref (caps);
4308 GST_INFO_OBJECT (basesink, "Could not set caps: %" GST_PTR_FORMAT, caps);
4309 gst_caps_unref (caps);
4314 /* this won't get called until we implement an activate function */
4316 gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active)
4318 gboolean result = FALSE;
4319 GstBaseSink *basesink;
4320 GstBaseSinkClass *bclass;
4322 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4323 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4328 /* we mark we have a newsegment here because pull based
4329 * mode works just fine without having a newsegment before the
4331 gst_segment_init (&basesink->segment, GST_FORMAT_BYTES);
4332 gst_segment_init (&basesink->clip_segment, GST_FORMAT_BYTES);
4333 GST_OBJECT_LOCK (basesink);
4334 basesink->have_newsegment = TRUE;
4335 GST_OBJECT_UNLOCK (basesink);
4337 /* get the peer duration in bytes */
4338 result = gst_pad_query_peer_duration (pad, GST_FORMAT_BYTES, &duration);
4340 GST_DEBUG_OBJECT (basesink,
4341 "setting duration in bytes to %" G_GINT64_FORMAT, duration);
4342 basesink->clip_segment.duration = duration;
4343 basesink->segment.duration = duration;
4345 GST_DEBUG_OBJECT (basesink, "unknown duration");
4348 if (bclass->activate_pull)
4349 result = bclass->activate_pull (basesink, TRUE);
4354 goto activate_failed;
4357 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PULL)) {
4358 g_warning ("Internal GStreamer activation error!!!");
4361 result = gst_base_sink_set_flushing (basesink, pad, TRUE);
4362 if (bclass->activate_pull)
4363 result &= bclass->activate_pull (basesink, FALSE);
4364 basesink->pad_mode = GST_ACTIVATE_NONE;
4365 /* clear any pending caps */
4366 GST_OBJECT_LOCK (basesink);
4367 gst_caps_replace (&basesink->priv->pull_caps, NULL);
4368 GST_OBJECT_UNLOCK (basesink);
4371 gst_object_unref (basesink);
4378 /* reset, as starting the thread failed */
4379 basesink->pad_mode = GST_ACTIVATE_NONE;
4381 GST_ERROR_OBJECT (basesink, "subclass failed to activate in pull mode");
4386 /* send an event to our sinkpad peer. */
4388 gst_base_sink_send_event (GstElement * element, GstEvent * event)
4391 GstBaseSink *basesink = GST_BASE_SINK (element);
4392 gboolean forward, result = TRUE;
4393 GstActivateMode mode;
4395 GST_OBJECT_LOCK (element);
4396 /* get the pad and the scheduling mode */
4397 pad = gst_object_ref (basesink->sinkpad);
4398 mode = basesink->pad_mode;
4399 GST_OBJECT_UNLOCK (element);
4401 /* only push UPSTREAM events upstream */
4402 forward = GST_EVENT_IS_UPSTREAM (event);
4404 GST_DEBUG_OBJECT (basesink, "handling event %p %" GST_PTR_FORMAT, event,
4407 switch (GST_EVENT_TYPE (event)) {
4408 case GST_EVENT_LATENCY:
4410 GstClockTime latency;
4412 gst_event_parse_latency (event, &latency);
4414 /* store the latency. We use this to adjust the running_time before syncing
4415 * it to the clock. */
4416 GST_OBJECT_LOCK (element);
4417 basesink->priv->latency = latency;
4418 if (!basesink->priv->have_latency)
4420 GST_OBJECT_UNLOCK (element);
4421 GST_DEBUG_OBJECT (basesink, "latency set to %" GST_TIME_FORMAT,
4422 GST_TIME_ARGS (latency));
4424 /* We forward this event so that all elements know about the global pipeline
4425 * latency. This is interesting for an element when it wants to figure out
4426 * when a particular piece of data will be rendered. */
4429 case GST_EVENT_SEEK:
4430 /* in pull mode we will execute the seek */
4431 if (mode == GST_ACTIVATE_PULL)
4432 result = gst_base_sink_perform_seek (basesink, pad, event);
4434 case GST_EVENT_STEP:
4435 result = gst_base_sink_perform_step (basesink, pad, event);
4443 result = gst_pad_push_event (pad, event);
4445 /* not forwarded, unref the event */
4446 gst_event_unref (event);
4449 gst_object_unref (pad);
4454 gst_base_sink_get_position (GstBaseSink * basesink, GstFormat format,
4455 gint64 * cur, gboolean * upstream)
4457 GstClock *clock = NULL;
4458 gboolean res = FALSE;
4460 GstSegment *segment;
4461 GstClockTime now, latency;
4462 GstClockTimeDiff base_time;
4463 gint64 time, base, duration;
4466 gboolean last_seen, with_clock, in_paused;
4468 GST_OBJECT_LOCK (basesink);
4469 /* we can only get the segment when we are not NULL or READY */
4470 if (!basesink->have_newsegment)
4474 /* when not in PLAYING or when we're busy with a state change, we
4475 * cannot read from the clock so we report time based on the
4476 * last seen timestamp. */
4477 if (GST_STATE (basesink) != GST_STATE_PLAYING ||
4478 GST_STATE_PENDING (basesink) != GST_STATE_VOID_PENDING) {
4482 /* we don't use the clip segment in pull mode, when seeking we update the
4483 * main segment directly with the new segment values without it having to be
4484 * activated by the rendering after preroll */
4485 if (basesink->pad_mode == GST_ACTIVATE_PUSH)
4486 segment = &basesink->clip_segment;
4488 segment = &basesink->segment;
4490 /* get the format in the segment */
4491 oformat = segment->format;
4493 /* report with last seen position when EOS */
4494 last_seen = basesink->eos;
4496 /* assume we will use the clock for getting the current position */
4498 if (basesink->sync == FALSE)
4501 /* and we need a clock */
4502 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (basesink)) == NULL))
4505 gst_object_ref (clock);
4507 /* mainloop might be querying position when going to playing async,
4508 * while (audio) rendering might be quickly advancing stream position,
4509 * so use clock asap rather than last reported position */
4510 if (in_paused && with_clock && g_atomic_int_get (&basesink->priv->to_playing)) {
4511 GST_DEBUG_OBJECT (basesink, "going to PLAYING, so not PAUSED");
4515 /* collect all data we need holding the lock */
4516 if (GST_CLOCK_TIME_IS_VALID (segment->time))
4517 time = segment->time;
4521 if (GST_CLOCK_TIME_IS_VALID (segment->stop))
4522 duration = segment->stop - segment->start;
4526 base = segment->base;
4527 rate = segment->rate * segment->applied_rate;
4528 latency = basesink->priv->latency;
4530 if (oformat == GST_FORMAT_TIME) {
4533 start = basesink->priv->current_sstart;
4534 stop = basesink->priv->current_sstop;
4537 /* in paused we use the last position as a lower bound */
4538 if (stop == -1 || segment->rate > 0.0)
4543 /* in playing, use last stop time as upper bound */
4544 if (start == -1 || segment->rate > 0.0)
4550 /* convert last stop to stream time */
4551 last = gst_segment_to_stream_time (segment, oformat, segment->position);
4555 /* in paused, use start_time */
4556 base_time = GST_ELEMENT_START_TIME (basesink);
4557 GST_DEBUG_OBJECT (basesink, "in paused, using start time %" GST_TIME_FORMAT,
4558 GST_TIME_ARGS (base_time));
4559 } else if (with_clock) {
4560 /* else use clock when needed */
4561 base_time = GST_ELEMENT_CAST (basesink)->base_time;
4562 GST_DEBUG_OBJECT (basesink, "using clock and base time %" GST_TIME_FORMAT,
4563 GST_TIME_ARGS (base_time));
4565 /* else, no sync or clock -> no base time */
4566 GST_DEBUG_OBJECT (basesink, "no sync or no clock");
4570 /* no base_time, we can't calculate running_time, use last seem timestamp to report
4572 if (base_time == -1)
4575 /* need to release the object lock before we can get the time,
4576 * a clock might take the LOCK of the provider, which could be
4577 * a basesink subclass. */
4578 GST_OBJECT_UNLOCK (basesink);
4581 /* in EOS or when no valid stream_time, report the value of last seen
4584 /* no timestamp, we need to ask upstream */
4585 GST_DEBUG_OBJECT (basesink, "no last seen timestamp, asking upstream");
4590 GST_DEBUG_OBJECT (basesink, "using last seen timestamp %" GST_TIME_FORMAT,
4591 GST_TIME_ARGS (last));
4594 if (oformat != GST_FORMAT_TIME) {
4595 /* convert base, time and duration to time */
4596 if (!gst_pad_query_convert (basesink->sinkpad, oformat, base,
4597 GST_FORMAT_TIME, &base))
4598 goto convert_failed;
4599 if (!gst_pad_query_convert (basesink->sinkpad, oformat, duration,
4600 GST_FORMAT_TIME, &duration))
4601 goto convert_failed;
4602 if (!gst_pad_query_convert (basesink->sinkpad, oformat, time,
4603 GST_FORMAT_TIME, &time))
4604 goto convert_failed;
4605 if (!gst_pad_query_convert (basesink->sinkpad, oformat, last,
4606 GST_FORMAT_TIME, &last))
4607 goto convert_failed;
4609 /* assume time format from now on */
4610 oformat = GST_FORMAT_TIME;
4613 if (!in_paused && with_clock) {
4614 now = gst_clock_get_time (clock);
4620 /* subtract base time and base time from the clock time.
4621 * Make sure we don't go negative. This is the current time in
4622 * the segment which we need to scale with the combined
4623 * rate and applied rate. */
4625 base_time += latency;
4626 if (GST_CLOCK_DIFF (base_time, now) < 0)
4629 /* for negative rates we need to count back from the segment
4634 *cur = time + gst_guint64_to_gdouble (now - base_time) * rate;
4637 /* never report less than segment values in paused */
4639 *cur = MAX (last, *cur);
4641 /* never report more than last seen position in playing */
4643 *cur = MIN (last, *cur);
4646 GST_DEBUG_OBJECT (basesink,
4647 "now %" GST_TIME_FORMAT " - base_time %" GST_TIME_FORMAT " - base %"
4648 GST_TIME_FORMAT " + time %" GST_TIME_FORMAT " last %" GST_TIME_FORMAT,
4649 GST_TIME_ARGS (now), GST_TIME_ARGS (base_time), GST_TIME_ARGS (base),
4650 GST_TIME_ARGS (time), GST_TIME_ARGS (last));
4653 if (oformat != format) {
4654 /* convert to final format */
4655 if (!gst_pad_query_convert (basesink->sinkpad, oformat, *cur, format, cur))
4656 goto convert_failed;
4662 GST_DEBUG_OBJECT (basesink, "res: %d, POSITION: %" GST_TIME_FORMAT,
4663 res, GST_TIME_ARGS (*cur));
4666 gst_object_unref (clock);
4673 /* in NULL or READY we always return FALSE and -1 */
4674 GST_DEBUG_OBJECT (basesink, "position in wrong state, return -1");
4677 GST_OBJECT_UNLOCK (basesink);
4682 GST_DEBUG_OBJECT (basesink, "convert failed, try upstream");
4690 gst_base_sink_get_duration (GstBaseSink * basesink, GstFormat format,
4691 gint64 * dur, gboolean * upstream)
4693 gboolean res = FALSE;
4695 if (basesink->pad_mode == GST_ACTIVATE_PULL) {
4698 /* get the duration in bytes, in pull mode that's all we are sure to
4699 * know. We have to explicitly get this value from upstream instead of
4700 * using our cached value because it might change. Duration caching
4701 * should be done at a higher level. */
4703 gst_pad_query_peer_duration (basesink->sinkpad, GST_FORMAT_BYTES,
4706 basesink->segment.duration = uduration;
4707 if (format != GST_FORMAT_BYTES) {
4708 /* convert to the requested format */
4710 gst_pad_query_convert (basesink->sinkpad, GST_FORMAT_BYTES,
4711 uduration, format, dur);
4724 static const GstQueryType *
4725 gst_base_sink_get_query_types (GstElement * element)
4727 static const GstQueryType query_types[] = {
4739 default_element_query (GstElement * element, GstQuery * query)
4741 gboolean res = FALSE;
4743 GstBaseSink *basesink = GST_BASE_SINK (element);
4745 switch (GST_QUERY_TYPE (query)) {
4746 case GST_QUERY_POSITION:
4750 gboolean upstream = FALSE;
4752 gst_query_parse_position (query, &format, NULL);
4754 GST_DEBUG_OBJECT (basesink, "position query in format %s",
4755 gst_format_get_name (format));
4757 /* first try to get the position based on the clock */
4759 gst_base_sink_get_position (basesink, format, &cur, &upstream))) {
4760 gst_query_set_position (query, format, cur);
4761 } else if (upstream) {
4762 /* fallback to peer query */
4763 res = gst_pad_peer_query (basesink->sinkpad, query);
4766 /* we can handle a few things if upstream failed */
4767 if (format == GST_FORMAT_PERCENT) {
4770 res = gst_base_sink_get_position (basesink, GST_FORMAT_TIME, &cur,
4772 if (!res && upstream) {
4774 gst_pad_query_peer_position (basesink->sinkpad, GST_FORMAT_TIME,
4778 res = gst_base_sink_get_duration (basesink, GST_FORMAT_TIME, &dur,
4780 if (!res && upstream) {
4782 gst_pad_query_peer_duration (basesink->sinkpad,
4783 GST_FORMAT_TIME, &dur);
4789 pos = gst_util_uint64_scale (100 * GST_FORMAT_PERCENT_SCALE, cur,
4791 gst_query_set_position (query, GST_FORMAT_PERCENT, pos);
4797 case GST_QUERY_DURATION:
4801 gboolean upstream = FALSE;
4803 gst_query_parse_duration (query, &format, NULL);
4805 GST_DEBUG_OBJECT (basesink, "duration query in format %s",
4806 gst_format_get_name (format));
4809 gst_base_sink_get_duration (basesink, format, &dur, &upstream))) {
4810 gst_query_set_duration (query, format, dur);
4811 } else if (upstream) {
4812 /* fallback to peer query */
4813 res = gst_pad_peer_query (basesink->sinkpad, query);
4816 /* we can handle a few things if upstream failed */
4817 if (format == GST_FORMAT_PERCENT) {
4818 gst_query_set_duration (query, GST_FORMAT_PERCENT,
4819 GST_FORMAT_PERCENT_MAX);
4825 case GST_QUERY_LATENCY:
4827 gboolean live, us_live;
4828 GstClockTime min, max;
4830 if ((res = gst_base_sink_query_latency (basesink, &live, &us_live, &min,
4832 gst_query_set_latency (query, live, min, max);
4836 case GST_QUERY_JITTER:
4838 case GST_QUERY_RATE:
4839 /* gst_query_set_rate (query, basesink->segment_rate); */
4842 case GST_QUERY_SEGMENT:
4844 if (basesink->pad_mode == GST_ACTIVATE_PULL) {
4845 gst_query_set_segment (query, basesink->segment.rate,
4846 GST_FORMAT_TIME, basesink->segment.start, basesink->segment.stop);
4849 res = gst_pad_peer_query (basesink->sinkpad, query);
4853 case GST_QUERY_SEEKING:
4854 case GST_QUERY_CONVERT:
4855 case GST_QUERY_FORMATS:
4857 res = gst_pad_peer_query (basesink->sinkpad, query);
4860 GST_DEBUG_OBJECT (basesink, "query %s returns %d",
4861 GST_QUERY_TYPE_NAME (query), res);
4867 default_sink_query (GstBaseSink * basesink, GstQuery * query)
4870 GstBaseSinkClass *bclass;
4872 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4874 switch (GST_QUERY_TYPE (query)) {
4875 case GST_QUERY_ALLOCATION:
4877 if (bclass->setup_allocation)
4878 res = bclass->setup_allocation (basesink, query);
4884 res = gst_pad_query_default (basesink->sinkpad, query);
4891 gst_base_sink_sink_query (GstPad * pad, GstQuery * query)
4893 GstBaseSink *basesink;
4894 GstBaseSinkClass *bclass;
4897 basesink = GST_BASE_SINK_CAST (gst_pad_get_parent (pad));
4898 if (G_UNLIKELY (basesink == NULL)) {
4899 gst_query_unref (query);
4903 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4906 res = bclass->query (basesink, query);
4910 gst_object_unref (basesink);
4915 static GstStateChangeReturn
4916 gst_base_sink_change_state (GstElement * element, GstStateChange transition)
4918 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
4919 GstBaseSink *basesink = GST_BASE_SINK (element);
4920 GstBaseSinkClass *bclass;
4921 GstBaseSinkPrivate *priv;
4923 priv = basesink->priv;
4925 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4927 switch (transition) {
4928 case GST_STATE_CHANGE_NULL_TO_READY:
4930 if (!bclass->start (basesink))
4933 case GST_STATE_CHANGE_READY_TO_PAUSED:
4934 /* need to complete preroll before this state change completes, there
4935 * is no data flow in READY so we can safely assume we need to preroll. */
4936 GST_BASE_SINK_PREROLL_LOCK (basesink);
4937 GST_DEBUG_OBJECT (basesink, "READY to PAUSED");
4938 basesink->have_newsegment = FALSE;
4939 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
4940 gst_segment_init (&basesink->clip_segment, GST_FORMAT_UNDEFINED);
4941 basesink->offset = 0;
4942 basesink->have_preroll = FALSE;
4943 priv->step_unlock = FALSE;
4944 basesink->need_preroll = TRUE;
4945 basesink->playing_async = TRUE;
4946 basesink->priv->reset_time = FALSE;
4947 priv->current_sstart = GST_CLOCK_TIME_NONE;
4948 priv->current_sstop = GST_CLOCK_TIME_NONE;
4949 priv->eos_rtime = GST_CLOCK_TIME_NONE;
4951 basesink->eos = FALSE;
4952 priv->received_eos = FALSE;
4953 gst_base_sink_reset_qos (basesink);
4954 priv->commited = FALSE;
4955 priv->call_preroll = TRUE;
4956 priv->current_step.valid = FALSE;
4957 priv->pending_step.valid = FALSE;
4958 if (priv->async_enabled) {
4959 GST_DEBUG_OBJECT (basesink, "doing async state change");
4960 /* when async enabled, post async-start message and return ASYNC from
4961 * the state change function */
4962 ret = GST_STATE_CHANGE_ASYNC;
4963 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4964 gst_message_new_async_start (GST_OBJECT_CAST (basesink)));
4966 priv->have_latency = TRUE;
4968 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4970 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
4971 GST_BASE_SINK_PREROLL_LOCK (basesink);
4972 g_atomic_int_set (&basesink->priv->to_playing, TRUE);
4973 if (!gst_base_sink_needs_preroll (basesink)) {
4974 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, don't need preroll");
4975 /* no preroll needed anymore now. */
4976 basesink->playing_async = FALSE;
4977 basesink->need_preroll = FALSE;
4978 if (basesink->eos) {
4979 GstMessage *message;
4981 /* need to post EOS message here */
4982 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
4983 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
4984 gst_message_set_seqnum (message, basesink->priv->seqnum);
4985 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
4987 GST_DEBUG_OBJECT (basesink, "signal preroll");
4988 GST_BASE_SINK_PREROLL_SIGNAL (basesink);
4991 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, we are not prerolled");
4992 basesink->need_preroll = TRUE;
4993 basesink->playing_async = TRUE;
4994 priv->call_preroll = TRUE;
4995 priv->commited = FALSE;
4996 if (priv->async_enabled) {
4997 GST_DEBUG_OBJECT (basesink, "doing async state change");
4998 ret = GST_STATE_CHANGE_ASYNC;
4999 gst_element_post_message (GST_ELEMENT_CAST (basesink),
5000 gst_message_new_async_start (GST_OBJECT_CAST (basesink)));
5003 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
5010 GstStateChangeReturn bret;
5012 bret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
5013 if (G_UNLIKELY (bret == GST_STATE_CHANGE_FAILURE))
5014 goto activate_failed;
5017 switch (transition) {
5018 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
5019 /* completed transition, so need not be marked any longer
5020 * And it should be unmarked, since e.g. losing our position upon flush
5021 * does not really change state to PAUSED ... */
5022 g_atomic_int_set (&basesink->priv->to_playing, FALSE);
5024 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
5025 g_atomic_int_set (&basesink->priv->to_playing, FALSE);
5026 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED");
5027 /* FIXME, make sure we cannot enter _render first */
5029 /* we need to call ::unlock before locking PREROLL_LOCK
5030 * since we lock it before going into ::render */
5032 bclass->unlock (basesink);
5034 GST_BASE_SINK_PREROLL_LOCK (basesink);
5035 GST_DEBUG_OBJECT (basesink, "got preroll lock");
5036 /* now that we have the PREROLL lock, clear our unlock request */
5037 if (bclass->unlock_stop)
5038 bclass->unlock_stop (basesink);
5040 /* we need preroll again and we set the flag before unlocking the clockid
5041 * because if the clockid is unlocked before a current buffer expired, we
5042 * can use that buffer to preroll with */
5043 basesink->need_preroll = TRUE;
5045 if (basesink->clock_id) {
5046 GST_DEBUG_OBJECT (basesink, "unschedule clock");
5047 gst_clock_id_unschedule (basesink->clock_id);
5050 /* if we don't have a preroll buffer we need to wait for a preroll and
5052 if (!gst_base_sink_needs_preroll (basesink)) {
5053 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED, we are prerolled");
5054 basesink->playing_async = FALSE;
5056 if (GST_STATE_TARGET (GST_ELEMENT (basesink)) <= GST_STATE_READY) {
5057 GST_DEBUG_OBJECT (basesink, "element is <= READY");
5058 ret = GST_STATE_CHANGE_SUCCESS;
5060 GST_DEBUG_OBJECT (basesink,
5061 "PLAYING to PAUSED, we are not prerolled");
5062 basesink->playing_async = TRUE;
5063 priv->commited = FALSE;
5064 priv->call_preroll = TRUE;
5065 if (priv->async_enabled) {
5066 GST_DEBUG_OBJECT (basesink, "doing async state change");
5067 ret = GST_STATE_CHANGE_ASYNC;
5068 gst_element_post_message (GST_ELEMENT_CAST (basesink),
5069 gst_message_new_async_start (GST_OBJECT_CAST (basesink)));
5073 GST_DEBUG_OBJECT (basesink, "rendered: %" G_GUINT64_FORMAT
5074 ", dropped: %" G_GUINT64_FORMAT, priv->rendered, priv->dropped);
5076 gst_base_sink_reset_qos (basesink);
5077 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
5079 case GST_STATE_CHANGE_PAUSED_TO_READY:
5080 GST_BASE_SINK_PREROLL_LOCK (basesink);
5081 /* start by reseting our position state with the object lock so that the
5082 * position query gets the right idea. We do this before we post the
5083 * messages so that the message handlers pick this up. */
5084 GST_OBJECT_LOCK (basesink);
5085 basesink->have_newsegment = FALSE;
5086 priv->current_sstart = GST_CLOCK_TIME_NONE;
5087 priv->current_sstop = GST_CLOCK_TIME_NONE;
5088 priv->have_latency = FALSE;
5089 if (priv->cached_clock_id) {
5090 gst_clock_id_unref (priv->cached_clock_id);
5091 priv->cached_clock_id = NULL;
5093 GST_OBJECT_UNLOCK (basesink);
5095 gst_base_sink_set_last_buffer (basesink, NULL);
5096 priv->call_preroll = FALSE;
5098 if (!priv->commited) {
5099 if (priv->async_enabled) {
5100 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, posting async-done");
5102 gst_element_post_message (GST_ELEMENT_CAST (basesink),
5103 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
5104 GST_STATE_PLAYING, GST_STATE_PAUSED, GST_STATE_READY));
5106 gst_element_post_message (GST_ELEMENT_CAST (basesink),
5107 gst_message_new_async_done (GST_OBJECT_CAST (basesink), FALSE));
5109 priv->commited = TRUE;
5111 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, don't need_preroll");
5113 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
5115 case GST_STATE_CHANGE_READY_TO_NULL:
5117 if (!bclass->stop (basesink)) {
5118 GST_WARNING_OBJECT (basesink, "failed to stop");
5121 gst_base_sink_set_last_buffer (basesink, NULL);
5122 priv->call_preroll = FALSE;
5133 GST_DEBUG_OBJECT (basesink, "failed to start");
5134 return GST_STATE_CHANGE_FAILURE;
5138 GST_DEBUG_OBJECT (basesink,
5139 "element failed to change states -- activation problem?");
5140 return GST_STATE_CHANGE_FAILURE;