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 */
231 /* when we received EOS */
232 gboolean received_eos;
234 /* when we are prerolled and able to report latency */
235 gboolean have_latency;
237 /* the last buffer we prerolled or rendered. Useful for making snapshots */
238 gint enable_last_buffer; /* atomic */
239 GstBuffer *last_buffer;
241 /* caps for pull based scheduling */
244 /* blocksize for pulling */
249 /* seqnum of the stream */
252 gboolean call_preroll;
253 gboolean step_unlock;
255 /* we have a pending and a current step operation */
256 GstStepInfo current_step;
257 GstStepInfo pending_step;
259 /* Cached GstClockID */
260 GstClockID cached_clock_id;
262 /* for throttling and QoS */
263 GstClockTime earliest_in_time;
264 GstClockTime throttle_time;
269 #define DO_RUNNING_AVG(avg,val,size) (((val) + ((size)-1) * (avg)) / (size))
271 /* generic running average, this has a neutral window size */
272 #define UPDATE_RUNNING_AVG(avg,val) DO_RUNNING_AVG(avg,val,8)
274 /* the windows for these running averages are experimentally obtained.
275 * possitive values get averaged more while negative values use a small
276 * window so we can react faster to badness. */
277 #define UPDATE_RUNNING_AVG_P(avg,val) DO_RUNNING_AVG(avg,val,16)
278 #define UPDATE_RUNNING_AVG_N(avg,val) DO_RUNNING_AVG(avg,val,4)
282 _PR_IS_NOTHING = 1 << 0,
283 _PR_IS_BUFFER = 1 << 1,
284 _PR_IS_BUFFERLIST = 1 << 2,
285 _PR_IS_EVENT = 1 << 3
288 #define OBJ_IS_BUFFER(a) ((a) & _PR_IS_BUFFER)
289 #define OBJ_IS_BUFFERLIST(a) ((a) & _PR_IS_BUFFERLIST)
290 #define OBJ_IS_EVENT(a) ((a) & _PR_IS_EVENT)
291 #define OBJ_IS_BUFFERFULL(a) ((a) & (_PR_IS_BUFFER | _PR_IS_BUFFERLIST))
293 /* BaseSink properties */
295 #define DEFAULT_CAN_ACTIVATE_PULL FALSE /* fixme: enable me */
296 #define DEFAULT_CAN_ACTIVATE_PUSH TRUE
298 #define DEFAULT_PREROLL_QUEUE_LEN 0
299 #define DEFAULT_SYNC TRUE
300 #define DEFAULT_MAX_LATENESS -1
301 #define DEFAULT_QOS FALSE
302 #define DEFAULT_ASYNC TRUE
303 #define DEFAULT_TS_OFFSET 0
304 #define DEFAULT_BLOCKSIZE 4096
305 #define DEFAULT_RENDER_DELAY 0
306 #define DEFAULT_ENABLE_LAST_BUFFER TRUE
307 #define DEFAULT_THROTTLE_TIME 0
312 PROP_PREROLL_QUEUE_LEN,
318 PROP_ENABLE_LAST_BUFFER,
326 static GstElementClass *parent_class = NULL;
328 static void gst_base_sink_class_init (GstBaseSinkClass * klass);
329 static void gst_base_sink_init (GstBaseSink * trans, gpointer g_class);
330 static void gst_base_sink_finalize (GObject * object);
333 gst_base_sink_get_type (void)
335 static volatile gsize base_sink_type = 0;
337 if (g_once_init_enter (&base_sink_type)) {
339 static const GTypeInfo base_sink_info = {
340 sizeof (GstBaseSinkClass),
343 (GClassInitFunc) gst_base_sink_class_init,
346 sizeof (GstBaseSink),
348 (GInstanceInitFunc) gst_base_sink_init,
351 _type = g_type_register_static (GST_TYPE_ELEMENT,
352 "GstBaseSink", &base_sink_info, G_TYPE_FLAG_ABSTRACT);
353 g_once_init_leave (&base_sink_type, _type);
355 return base_sink_type;
358 static void gst_base_sink_set_property (GObject * object, guint prop_id,
359 const GValue * value, GParamSpec * pspec);
360 static void gst_base_sink_get_property (GObject * object, guint prop_id,
361 GValue * value, GParamSpec * pspec);
363 static gboolean gst_base_sink_send_event (GstElement * element,
365 static gboolean gst_base_sink_query (GstElement * element, GstQuery * query);
366 static const GstQueryType *gst_base_sink_get_query_types (GstElement * element);
368 static GstCaps *gst_base_sink_get_caps (GstBaseSink * sink, GstCaps * caps);
369 static gboolean gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps);
370 static void gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
371 GstClockTime * start, GstClockTime * end);
372 static gboolean gst_base_sink_set_flushing (GstBaseSink * basesink,
373 GstPad * pad, gboolean flushing);
374 static gboolean gst_base_sink_default_activate_pull (GstBaseSink * basesink,
376 static gboolean gst_base_sink_default_do_seek (GstBaseSink * sink,
377 GstSegment * segment);
378 static gboolean gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
379 GstEvent * event, GstSegment * segment);
381 static GstStateChangeReturn gst_base_sink_change_state (GstElement * element,
382 GstStateChange transition);
384 static GstFlowReturn gst_base_sink_chain (GstPad * pad, GstBuffer * buffer);
385 static GstFlowReturn gst_base_sink_chain_list (GstPad * pad,
386 GstBufferList * list);
388 static void gst_base_sink_loop (GstPad * pad);
389 static gboolean gst_base_sink_pad_activate (GstPad * pad);
390 static gboolean gst_base_sink_pad_activate_push (GstPad * pad, gboolean active);
391 static gboolean gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active);
392 static gboolean gst_base_sink_event (GstPad * pad, GstEvent * event);
394 static gboolean gst_base_sink_negotiate_pull (GstBaseSink * basesink);
395 static GstCaps *gst_base_sink_pad_getcaps (GstPad * pad, GstCaps * filter);
396 static void gst_base_sink_pad_fixate (GstPad * pad, GstCaps * caps);
398 /* check if an object was too late */
399 static gboolean gst_base_sink_is_too_late (GstBaseSink * basesink,
400 GstMiniObject * obj, GstClockTime rstart, GstClockTime rstop,
401 GstClockReturn status, GstClockTimeDiff jitter);
402 static GstFlowReturn gst_base_sink_preroll_object (GstBaseSink * basesink,
403 guint8 obj_type, GstMiniObject * obj);
406 gst_base_sink_class_init (GstBaseSinkClass * klass)
408 GObjectClass *gobject_class;
409 GstElementClass *gstelement_class;
411 gobject_class = G_OBJECT_CLASS (klass);
412 gstelement_class = GST_ELEMENT_CLASS (klass);
414 GST_DEBUG_CATEGORY_INIT (gst_base_sink_debug, "basesink", 0,
417 g_type_class_add_private (klass, sizeof (GstBaseSinkPrivate));
419 parent_class = g_type_class_peek_parent (klass);
421 gobject_class->finalize = gst_base_sink_finalize;
422 gobject_class->set_property = gst_base_sink_set_property;
423 gobject_class->get_property = gst_base_sink_get_property;
425 /* FIXME, this next value should be configured using an event from the
426 * upstream element, ie, the BUFFER_SIZE event. */
427 g_object_class_install_property (gobject_class, PROP_PREROLL_QUEUE_LEN,
428 g_param_spec_uint ("preroll-queue-len", "Preroll queue length",
429 "Number of buffers to queue during preroll", 0, G_MAXUINT,
430 DEFAULT_PREROLL_QUEUE_LEN,
431 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
433 g_object_class_install_property (gobject_class, PROP_SYNC,
434 g_param_spec_boolean ("sync", "Sync", "Sync on the clock", DEFAULT_SYNC,
435 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
437 g_object_class_install_property (gobject_class, PROP_MAX_LATENESS,
438 g_param_spec_int64 ("max-lateness", "Max Lateness",
439 "Maximum number of nanoseconds that a buffer can be late before it "
440 "is dropped (-1 unlimited)", -1, G_MAXINT64, DEFAULT_MAX_LATENESS,
441 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
443 g_object_class_install_property (gobject_class, PROP_QOS,
444 g_param_spec_boolean ("qos", "Qos",
445 "Generate Quality-of-Service events upstream", DEFAULT_QOS,
446 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
450 * If set to #TRUE, the basesink will perform asynchronous state changes.
451 * When set to #FALSE, the sink will not signal the parent when it prerolls.
452 * Use this option when dealing with sparse streams or when synchronisation is
457 g_object_class_install_property (gobject_class, PROP_ASYNC,
458 g_param_spec_boolean ("async", "Async",
459 "Go asynchronously to PAUSED", DEFAULT_ASYNC,
460 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
462 * GstBaseSink:ts-offset
464 * Controls the final synchronisation, a negative value will render the buffer
465 * earlier while a positive value delays playback. This property can be
466 * used to fix synchronisation in bad files.
470 g_object_class_install_property (gobject_class, PROP_TS_OFFSET,
471 g_param_spec_int64 ("ts-offset", "TS Offset",
472 "Timestamp offset in nanoseconds", G_MININT64, G_MAXINT64,
473 DEFAULT_TS_OFFSET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
476 * GstBaseSink:enable-last-buffer
478 * Enable the last-buffer property. If FALSE, basesink doesn't keep a
479 * reference to the last buffer arrived and the last-buffer property is always
480 * set to NULL. This can be useful if you need buffers to be released as soon
481 * as possible, eg. if you're using a buffer pool.
485 g_object_class_install_property (gobject_class, PROP_ENABLE_LAST_BUFFER,
486 g_param_spec_boolean ("enable-last-buffer", "Enable Last Buffer",
487 "Enable the last-buffer property", DEFAULT_ENABLE_LAST_BUFFER,
488 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
491 * GstBaseSink:last-buffer
493 * The last buffer that arrived in the sink and was used for preroll or for
494 * rendering. This property can be used to generate thumbnails. This property
495 * can be NULL when the sink has not yet received a bufer.
499 g_object_class_install_property (gobject_class, PROP_LAST_BUFFER,
500 g_param_spec_boxed ("last-buffer", "Last Buffer",
501 "The last buffer received in the sink", GST_TYPE_BUFFER,
502 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
504 * GstBaseSink:blocksize
506 * The amount of bytes to pull when operating in pull mode.
510 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
511 g_object_class_install_property (gobject_class, PROP_BLOCKSIZE,
512 g_param_spec_uint ("blocksize", "Block size",
513 "Size in bytes to pull per buffer (0 = default)", 0, G_MAXUINT,
514 DEFAULT_BLOCKSIZE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
516 * GstBaseSink:render-delay
518 * The additional delay between synchronisation and actual rendering of the
519 * media. This property will add additional latency to the device in order to
520 * make other sinks compensate for the delay.
524 g_object_class_install_property (gobject_class, PROP_RENDER_DELAY,
525 g_param_spec_uint64 ("render-delay", "Render Delay",
526 "Additional render delay of the sink in nanoseconds", 0, G_MAXUINT64,
527 DEFAULT_RENDER_DELAY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
529 * GstBaseSink:throttle-time
531 * The time to insert between buffers. This property can be used to control
532 * the maximum amount of buffers per second to render. Setting this property
533 * to a value bigger than 0 will make the sink create THROTTLE QoS events.
537 g_object_class_install_property (gobject_class, PROP_THROTTLE_TIME,
538 g_param_spec_uint64 ("throttle-time", "Throttle time",
539 "The time to keep between rendered buffers (unused)", 0, G_MAXUINT64,
540 DEFAULT_THROTTLE_TIME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
542 gstelement_class->change_state =
543 GST_DEBUG_FUNCPTR (gst_base_sink_change_state);
544 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_base_sink_send_event);
545 gstelement_class->query = GST_DEBUG_FUNCPTR (gst_base_sink_query);
546 gstelement_class->get_query_types =
547 GST_DEBUG_FUNCPTR (gst_base_sink_get_query_types);
549 klass->get_caps = GST_DEBUG_FUNCPTR (gst_base_sink_get_caps);
550 klass->set_caps = GST_DEBUG_FUNCPTR (gst_base_sink_set_caps);
551 klass->get_times = GST_DEBUG_FUNCPTR (gst_base_sink_get_times);
552 klass->activate_pull =
553 GST_DEBUG_FUNCPTR (gst_base_sink_default_activate_pull);
555 /* Registering debug symbols for function pointers */
556 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_getcaps);
557 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_fixate);
558 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate);
559 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate_push);
560 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate_pull);
561 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_event);
562 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain);
563 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain_list);
567 gst_base_sink_pad_getcaps (GstPad * pad, GstCaps * filter)
569 GstBaseSinkClass *bclass;
571 GstCaps *caps = NULL;
573 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
574 bclass = GST_BASE_SINK_GET_CLASS (bsink);
576 if (bsink->pad_mode == GST_ACTIVATE_PULL) {
577 /* if we are operating in pull mode we only accept the negotiated caps */
578 caps = gst_pad_get_current_caps (pad);
581 if (bclass->get_caps)
582 caps = bclass->get_caps (bsink, filter);
585 GstPadTemplate *pad_template;
588 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass),
590 if (pad_template != NULL) {
591 caps = gst_pad_template_get_caps (pad_template);
594 GstCaps *intersection;
597 gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
598 gst_caps_unref (caps);
604 gst_object_unref (bsink);
610 gst_base_sink_pad_fixate (GstPad * pad, GstCaps * caps)
612 GstBaseSinkClass *bclass;
615 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
616 bclass = GST_BASE_SINK_GET_CLASS (bsink);
619 bclass->fixate (bsink, caps);
621 gst_object_unref (bsink);
625 gst_base_sink_init (GstBaseSink * basesink, gpointer g_class)
627 GstPadTemplate *pad_template;
628 GstBaseSinkPrivate *priv;
630 basesink->priv = priv = GST_BASE_SINK_GET_PRIVATE (basesink);
633 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "sink");
634 g_return_if_fail (pad_template != NULL);
636 basesink->sinkpad = gst_pad_new_from_template (pad_template, "sink");
638 gst_pad_set_getcaps_function (basesink->sinkpad, gst_base_sink_pad_getcaps);
639 gst_pad_set_fixatecaps_function (basesink->sinkpad, gst_base_sink_pad_fixate);
640 gst_pad_set_activate_function (basesink->sinkpad, gst_base_sink_pad_activate);
641 gst_pad_set_activatepush_function (basesink->sinkpad,
642 gst_base_sink_pad_activate_push);
643 gst_pad_set_activatepull_function (basesink->sinkpad,
644 gst_base_sink_pad_activate_pull);
645 gst_pad_set_event_function (basesink->sinkpad, gst_base_sink_event);
646 gst_pad_set_chain_function (basesink->sinkpad, gst_base_sink_chain);
647 gst_pad_set_chain_list_function (basesink->sinkpad, gst_base_sink_chain_list);
648 gst_element_add_pad (GST_ELEMENT_CAST (basesink), basesink->sinkpad);
650 basesink->pad_mode = GST_ACTIVATE_NONE;
651 basesink->preroll_lock = g_mutex_new ();
652 basesink->preroll_cond = g_cond_new ();
653 basesink->preroll_queue = g_queue_new ();
654 priv->have_latency = FALSE;
656 basesink->can_activate_push = DEFAULT_CAN_ACTIVATE_PUSH;
657 basesink->can_activate_pull = DEFAULT_CAN_ACTIVATE_PULL;
659 basesink->sync = DEFAULT_SYNC;
660 basesink->max_lateness = DEFAULT_MAX_LATENESS;
661 g_atomic_int_set (&priv->qos_enabled, DEFAULT_QOS);
662 priv->async_enabled = DEFAULT_ASYNC;
663 priv->ts_offset = DEFAULT_TS_OFFSET;
664 priv->render_delay = DEFAULT_RENDER_DELAY;
665 priv->blocksize = DEFAULT_BLOCKSIZE;
666 priv->cached_clock_id = NULL;
667 g_atomic_int_set (&priv->enable_last_buffer, DEFAULT_ENABLE_LAST_BUFFER);
668 priv->throttle_time = DEFAULT_THROTTLE_TIME;
670 GST_OBJECT_FLAG_SET (basesink, GST_ELEMENT_IS_SINK);
674 gst_base_sink_finalize (GObject * object)
676 GstBaseSink *basesink;
678 basesink = GST_BASE_SINK (object);
680 g_mutex_free (basesink->preroll_lock);
681 g_cond_free (basesink->preroll_cond);
682 g_queue_free (basesink->preroll_queue);
684 G_OBJECT_CLASS (parent_class)->finalize (object);
688 * gst_base_sink_set_sync:
690 * @sync: the new sync value.
692 * Configures @sink to synchronize on the clock or not. When
693 * @sync is FALSE, incomming samples will be played as fast as
694 * possible. If @sync is TRUE, the timestamps of the incomming
695 * buffers will be used to schedule the exact render time of its
701 gst_base_sink_set_sync (GstBaseSink * sink, gboolean sync)
703 g_return_if_fail (GST_IS_BASE_SINK (sink));
705 GST_OBJECT_LOCK (sink);
707 GST_OBJECT_UNLOCK (sink);
711 * gst_base_sink_get_sync:
714 * Checks if @sink is currently configured to synchronize against the
717 * Returns: TRUE if the sink is configured to synchronize against the clock.
722 gst_base_sink_get_sync (GstBaseSink * sink)
726 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
728 GST_OBJECT_LOCK (sink);
730 GST_OBJECT_UNLOCK (sink);
736 * gst_base_sink_set_max_lateness:
738 * @max_lateness: the new max lateness value.
740 * Sets the new max lateness value to @max_lateness. This value is
741 * used to decide if a buffer should be dropped or not based on the
742 * buffer timestamp and the current clock time. A value of -1 means
748 gst_base_sink_set_max_lateness (GstBaseSink * sink, gint64 max_lateness)
750 g_return_if_fail (GST_IS_BASE_SINK (sink));
752 GST_OBJECT_LOCK (sink);
753 sink->max_lateness = max_lateness;
754 GST_OBJECT_UNLOCK (sink);
758 * gst_base_sink_get_max_lateness:
761 * Gets the max lateness value. See gst_base_sink_set_max_lateness for
764 * Returns: The maximum time in nanoseconds that a buffer can be late
765 * before it is dropped and not rendered. A value of -1 means an
771 gst_base_sink_get_max_lateness (GstBaseSink * sink)
775 g_return_val_if_fail (GST_IS_BASE_SINK (sink), -1);
777 GST_OBJECT_LOCK (sink);
778 res = sink->max_lateness;
779 GST_OBJECT_UNLOCK (sink);
785 * gst_base_sink_set_qos_enabled:
787 * @enabled: the new qos value.
789 * Configures @sink to send Quality-of-Service events upstream.
794 gst_base_sink_set_qos_enabled (GstBaseSink * sink, gboolean enabled)
796 g_return_if_fail (GST_IS_BASE_SINK (sink));
798 g_atomic_int_set (&sink->priv->qos_enabled, enabled);
802 * gst_base_sink_is_qos_enabled:
805 * Checks if @sink is currently configured to send Quality-of-Service events
808 * Returns: TRUE if the sink is configured to perform Quality-of-Service.
813 gst_base_sink_is_qos_enabled (GstBaseSink * sink)
817 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
819 res = g_atomic_int_get (&sink->priv->qos_enabled);
825 * gst_base_sink_set_async_enabled:
827 * @enabled: the new async value.
829 * Configures @sink to perform all state changes asynchronusly. When async is
830 * disabled, the sink will immediatly go to PAUSED instead of waiting for a
831 * preroll buffer. This feature is usefull if the sink does not synchronize
832 * against the clock or when it is dealing with sparse streams.
837 gst_base_sink_set_async_enabled (GstBaseSink * sink, gboolean enabled)
839 g_return_if_fail (GST_IS_BASE_SINK (sink));
841 GST_BASE_SINK_PREROLL_LOCK (sink);
842 g_atomic_int_set (&sink->priv->async_enabled, enabled);
843 GST_LOG_OBJECT (sink, "set async enabled to %d", enabled);
844 GST_BASE_SINK_PREROLL_UNLOCK (sink);
848 * gst_base_sink_is_async_enabled:
851 * Checks if @sink is currently configured to perform asynchronous state
854 * Returns: TRUE if the sink is configured to perform asynchronous state
860 gst_base_sink_is_async_enabled (GstBaseSink * sink)
864 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
866 res = g_atomic_int_get (&sink->priv->async_enabled);
872 * gst_base_sink_set_ts_offset:
874 * @offset: the new offset
876 * Adjust the synchronisation of @sink with @offset. A negative value will
877 * render buffers earlier than their timestamp. A positive value will delay
878 * rendering. This function can be used to fix playback of badly timestamped
884 gst_base_sink_set_ts_offset (GstBaseSink * sink, GstClockTimeDiff offset)
886 g_return_if_fail (GST_IS_BASE_SINK (sink));
888 GST_OBJECT_LOCK (sink);
889 sink->priv->ts_offset = offset;
890 GST_LOG_OBJECT (sink, "set time offset to %" G_GINT64_FORMAT, offset);
891 GST_OBJECT_UNLOCK (sink);
895 * gst_base_sink_get_ts_offset:
898 * Get the synchronisation offset of @sink.
900 * Returns: The synchronisation offset.
905 gst_base_sink_get_ts_offset (GstBaseSink * sink)
907 GstClockTimeDiff res;
909 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
911 GST_OBJECT_LOCK (sink);
912 res = sink->priv->ts_offset;
913 GST_OBJECT_UNLOCK (sink);
919 * gst_base_sink_get_last_buffer:
922 * Get the last buffer that arrived in the sink and was used for preroll or for
923 * rendering. This property can be used to generate thumbnails.
925 * The #GstCaps on the buffer can be used to determine the type of the buffer.
927 * Free-function: gst_buffer_unref
929 * Returns: (transfer full): a #GstBuffer. gst_buffer_unref() after usage.
930 * This function returns NULL when no buffer has arrived in the sink yet
931 * or when the sink is not in PAUSED or PLAYING.
936 gst_base_sink_get_last_buffer (GstBaseSink * sink)
940 g_return_val_if_fail (GST_IS_BASE_SINK (sink), NULL);
942 GST_OBJECT_LOCK (sink);
943 if ((res = sink->priv->last_buffer))
944 gst_buffer_ref (res);
945 GST_OBJECT_UNLOCK (sink);
950 /* with OBJECT_LOCK */
952 gst_base_sink_set_last_buffer_unlocked (GstBaseSink * sink, GstBuffer * buffer)
956 old = sink->priv->last_buffer;
957 if (G_LIKELY (old != buffer)) {
958 GST_DEBUG_OBJECT (sink, "setting last buffer to %p", buffer);
959 if (G_LIKELY (buffer))
960 gst_buffer_ref (buffer);
961 sink->priv->last_buffer = buffer;
965 /* avoid unreffing with the lock because cleanup code might want to take the
967 if (G_LIKELY (old)) {
968 GST_OBJECT_UNLOCK (sink);
969 gst_buffer_unref (old);
970 GST_OBJECT_LOCK (sink);
975 gst_base_sink_set_last_buffer (GstBaseSink * sink, GstBuffer * buffer)
977 if (!g_atomic_int_get (&sink->priv->enable_last_buffer))
980 GST_OBJECT_LOCK (sink);
981 gst_base_sink_set_last_buffer_unlocked (sink, buffer);
982 GST_OBJECT_UNLOCK (sink);
986 * gst_base_sink_set_last_buffer_enabled:
988 * @enabled: the new enable-last-buffer value.
990 * Configures @sink to store the last received buffer in the last-buffer
996 gst_base_sink_set_last_buffer_enabled (GstBaseSink * sink, gboolean enabled)
998 g_return_if_fail (GST_IS_BASE_SINK (sink));
1000 /* Only take lock if we change the value */
1001 if (g_atomic_int_compare_and_exchange (&sink->priv->enable_last_buffer,
1002 !enabled, enabled) && !enabled) {
1003 GST_OBJECT_LOCK (sink);
1004 gst_base_sink_set_last_buffer_unlocked (sink, NULL);
1005 GST_OBJECT_UNLOCK (sink);
1010 * gst_base_sink_is_last_buffer_enabled:
1013 * Checks if @sink is currently configured to store the last received buffer in
1014 * the last-buffer property.
1016 * Returns: TRUE if the sink is configured to store the last received buffer.
1021 gst_base_sink_is_last_buffer_enabled (GstBaseSink * sink)
1023 g_return_val_if_fail (GST_IS_BASE_SINK (sink), FALSE);
1025 return g_atomic_int_get (&sink->priv->enable_last_buffer);
1029 * gst_base_sink_get_latency:
1032 * Get the currently configured latency.
1034 * Returns: The configured latency.
1039 gst_base_sink_get_latency (GstBaseSink * sink)
1043 GST_OBJECT_LOCK (sink);
1044 res = sink->priv->latency;
1045 GST_OBJECT_UNLOCK (sink);
1051 * gst_base_sink_query_latency:
1053 * @live: (out) (allow-none): if the sink is live
1054 * @upstream_live: (out) (allow-none): if an upstream element is live
1055 * @min_latency: (out) (allow-none): the min latency of the upstream elements
1056 * @max_latency: (out) (allow-none): the max latency of the upstream elements
1058 * Query the sink for the latency parameters. The latency will be queried from
1059 * the upstream elements. @live will be TRUE if @sink is configured to
1060 * synchronize against the clock. @upstream_live will be TRUE if an upstream
1063 * If both @live and @upstream_live are TRUE, the sink will want to compensate
1064 * for the latency introduced by the upstream elements by setting the
1065 * @min_latency to a strictly possitive value.
1067 * This function is mostly used by subclasses.
1069 * Returns: TRUE if the query succeeded.
1074 gst_base_sink_query_latency (GstBaseSink * sink, gboolean * live,
1075 gboolean * upstream_live, GstClockTime * min_latency,
1076 GstClockTime * max_latency)
1078 gboolean l, us_live, res, have_latency;
1079 GstClockTime min, max, render_delay;
1081 GstClockTime us_min, us_max;
1083 /* we are live when we sync to the clock */
1084 GST_OBJECT_LOCK (sink);
1086 have_latency = sink->priv->have_latency;
1087 render_delay = sink->priv->render_delay;
1088 GST_OBJECT_UNLOCK (sink);
1090 /* assume no latency */
1096 GST_DEBUG_OBJECT (sink, "we are ready for LATENCY query");
1097 /* we are ready for a latency query this is when we preroll or when we are
1099 query = gst_query_new_latency ();
1101 /* ask the peer for the latency */
1102 if ((res = gst_pad_peer_query (sink->sinkpad, query))) {
1103 /* get upstream min and max latency */
1104 gst_query_parse_latency (query, &us_live, &us_min, &us_max);
1107 /* upstream live, use its latency, subclasses should use these
1108 * values to create the complete latency. */
1113 /* we need to add the render delay if we are live */
1115 min += render_delay;
1117 max += render_delay;
1120 gst_query_unref (query);
1122 GST_DEBUG_OBJECT (sink, "we are not yet ready for LATENCY query");
1126 /* not live, we tried to do the query, if it failed we return TRUE anyway */
1130 GST_DEBUG_OBJECT (sink, "latency query failed but we are not live");
1132 GST_DEBUG_OBJECT (sink, "latency query failed and we are live");
1137 GST_DEBUG_OBJECT (sink, "latency query: live: %d, have_latency %d,"
1138 " upstream: %d, min %" GST_TIME_FORMAT ", max %" GST_TIME_FORMAT, l,
1139 have_latency, us_live, GST_TIME_ARGS (min), GST_TIME_ARGS (max));
1144 *upstream_live = us_live;
1154 * gst_base_sink_set_render_delay:
1155 * @sink: a #GstBaseSink
1156 * @delay: the new delay
1158 * Set the render delay in @sink to @delay. The render delay is the time
1159 * between actual rendering of a buffer and its synchronisation time. Some
1160 * devices might delay media rendering which can be compensated for with this
1163 * After calling this function, this sink will report additional latency and
1164 * other sinks will adjust their latency to delay the rendering of their media.
1166 * This function is usually called by subclasses.
1171 gst_base_sink_set_render_delay (GstBaseSink * sink, GstClockTime delay)
1173 GstClockTime old_render_delay;
1175 g_return_if_fail (GST_IS_BASE_SINK (sink));
1177 GST_OBJECT_LOCK (sink);
1178 old_render_delay = sink->priv->render_delay;
1179 sink->priv->render_delay = delay;
1180 GST_LOG_OBJECT (sink, "set render delay to %" GST_TIME_FORMAT,
1181 GST_TIME_ARGS (delay));
1182 GST_OBJECT_UNLOCK (sink);
1184 if (delay != old_render_delay) {
1185 GST_DEBUG_OBJECT (sink, "posting latency changed");
1186 gst_element_post_message (GST_ELEMENT_CAST (sink),
1187 gst_message_new_latency (GST_OBJECT_CAST (sink)));
1192 * gst_base_sink_get_render_delay:
1193 * @sink: a #GstBaseSink
1195 * Get the render delay of @sink. see gst_base_sink_set_render_delay() for more
1196 * information about the render delay.
1198 * Returns: the render delay of @sink.
1203 gst_base_sink_get_render_delay (GstBaseSink * sink)
1205 GstClockTimeDiff res;
1207 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1209 GST_OBJECT_LOCK (sink);
1210 res = sink->priv->render_delay;
1211 GST_OBJECT_UNLOCK (sink);
1217 * gst_base_sink_set_blocksize:
1218 * @sink: a #GstBaseSink
1219 * @blocksize: the blocksize in bytes
1221 * Set the number of bytes that the sink will pull when it is operating in pull
1226 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
1228 gst_base_sink_set_blocksize (GstBaseSink * sink, guint blocksize)
1230 g_return_if_fail (GST_IS_BASE_SINK (sink));
1232 GST_OBJECT_LOCK (sink);
1233 sink->priv->blocksize = blocksize;
1234 GST_LOG_OBJECT (sink, "set blocksize to %u", blocksize);
1235 GST_OBJECT_UNLOCK (sink);
1239 * gst_base_sink_get_blocksize:
1240 * @sink: a #GstBaseSink
1242 * Get the number of bytes that the sink will pull when it is operating in pull
1245 * Returns: the number of bytes @sink will pull in pull mode.
1249 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
1251 gst_base_sink_get_blocksize (GstBaseSink * sink)
1255 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1257 GST_OBJECT_LOCK (sink);
1258 res = sink->priv->blocksize;
1259 GST_OBJECT_UNLOCK (sink);
1265 * gst_base_sink_set_throttle_time:
1266 * @sink: a #GstBaseSink
1267 * @throttle: the throttle time in nanoseconds
1269 * Set the time that will be inserted between rendered buffers. This
1270 * can be used to control the maximum buffers per second that the sink
1276 gst_base_sink_set_throttle_time (GstBaseSink * sink, guint64 throttle)
1278 g_return_if_fail (GST_IS_BASE_SINK (sink));
1280 GST_OBJECT_LOCK (sink);
1281 sink->priv->throttle_time = throttle;
1282 GST_LOG_OBJECT (sink, "set throttle_time to %" G_GUINT64_FORMAT, throttle);
1283 GST_OBJECT_UNLOCK (sink);
1287 * gst_base_sink_get_throttle_time:
1288 * @sink: a #GstBaseSink
1290 * Get the time that will be inserted between frames to control the
1291 * maximum buffers per second.
1293 * Returns: the number of nanoseconds @sink will put between frames.
1298 gst_base_sink_get_throttle_time (GstBaseSink * sink)
1302 g_return_val_if_fail (GST_IS_BASE_SINK (sink), 0);
1304 GST_OBJECT_LOCK (sink);
1305 res = sink->priv->throttle_time;
1306 GST_OBJECT_UNLOCK (sink);
1312 gst_base_sink_set_property (GObject * object, guint prop_id,
1313 const GValue * value, GParamSpec * pspec)
1315 GstBaseSink *sink = GST_BASE_SINK (object);
1318 case PROP_PREROLL_QUEUE_LEN:
1319 /* preroll lock necessary to serialize with finish_preroll */
1320 GST_BASE_SINK_PREROLL_LOCK (sink);
1321 g_atomic_int_set (&sink->preroll_queue_max_len, g_value_get_uint (value));
1322 GST_BASE_SINK_PREROLL_UNLOCK (sink);
1325 gst_base_sink_set_sync (sink, g_value_get_boolean (value));
1327 case PROP_MAX_LATENESS:
1328 gst_base_sink_set_max_lateness (sink, g_value_get_int64 (value));
1331 gst_base_sink_set_qos_enabled (sink, g_value_get_boolean (value));
1334 gst_base_sink_set_async_enabled (sink, g_value_get_boolean (value));
1336 case PROP_TS_OFFSET:
1337 gst_base_sink_set_ts_offset (sink, g_value_get_int64 (value));
1339 case PROP_BLOCKSIZE:
1340 gst_base_sink_set_blocksize (sink, g_value_get_uint (value));
1342 case PROP_RENDER_DELAY:
1343 gst_base_sink_set_render_delay (sink, g_value_get_uint64 (value));
1345 case PROP_ENABLE_LAST_BUFFER:
1346 gst_base_sink_set_last_buffer_enabled (sink, g_value_get_boolean (value));
1348 case PROP_THROTTLE_TIME:
1349 gst_base_sink_set_throttle_time (sink, g_value_get_uint64 (value));
1352 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1358 gst_base_sink_get_property (GObject * object, guint prop_id, GValue * value,
1361 GstBaseSink *sink = GST_BASE_SINK (object);
1364 case PROP_PREROLL_QUEUE_LEN:
1365 g_value_set_uint (value, g_atomic_int_get (&sink->preroll_queue_max_len));
1368 g_value_set_boolean (value, gst_base_sink_get_sync (sink));
1370 case PROP_MAX_LATENESS:
1371 g_value_set_int64 (value, gst_base_sink_get_max_lateness (sink));
1374 g_value_set_boolean (value, gst_base_sink_is_qos_enabled (sink));
1377 g_value_set_boolean (value, gst_base_sink_is_async_enabled (sink));
1379 case PROP_TS_OFFSET:
1380 g_value_set_int64 (value, gst_base_sink_get_ts_offset (sink));
1382 case PROP_LAST_BUFFER:
1383 gst_value_take_buffer (value, gst_base_sink_get_last_buffer (sink));
1385 case PROP_ENABLE_LAST_BUFFER:
1386 g_value_set_boolean (value, gst_base_sink_is_last_buffer_enabled (sink));
1388 case PROP_BLOCKSIZE:
1389 g_value_set_uint (value, gst_base_sink_get_blocksize (sink));
1391 case PROP_RENDER_DELAY:
1392 g_value_set_uint64 (value, gst_base_sink_get_render_delay (sink));
1394 case PROP_THROTTLE_TIME:
1395 g_value_set_uint64 (value, gst_base_sink_get_throttle_time (sink));
1398 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1405 gst_base_sink_get_caps (GstBaseSink * sink, GstCaps * filter)
1411 gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps)
1416 /* with PREROLL_LOCK, STREAM_LOCK */
1418 gst_base_sink_preroll_queue_flush (GstBaseSink * basesink, GstPad * pad)
1422 GST_DEBUG_OBJECT (basesink, "flushing queue %p", basesink);
1423 while ((obj = g_queue_pop_head (basesink->preroll_queue))) {
1424 GST_DEBUG_OBJECT (basesink, "popped %p", obj);
1425 gst_mini_object_unref (obj);
1427 /* we can't have EOS anymore now */
1428 basesink->eos = FALSE;
1429 basesink->priv->received_eos = FALSE;
1430 basesink->have_preroll = FALSE;
1431 basesink->priv->step_unlock = FALSE;
1432 basesink->eos_queued = FALSE;
1433 basesink->preroll_queued = 0;
1434 basesink->buffers_queued = 0;
1435 basesink->events_queued = 0;
1436 /* can't report latency anymore until we preroll again */
1437 if (basesink->priv->async_enabled) {
1438 GST_OBJECT_LOCK (basesink);
1439 basesink->priv->have_latency = FALSE;
1440 GST_OBJECT_UNLOCK (basesink);
1442 /* and signal any waiters now */
1443 GST_BASE_SINK_PREROLL_SIGNAL (basesink);
1446 /* with STREAM_LOCK, configures given segment with the event information. */
1448 gst_base_sink_configure_segment (GstBaseSink * basesink, GstPad * pad,
1449 GstEvent * event, GstSegment * segment)
1451 /* The segment is protected with both the STREAM_LOCK and the OBJECT_LOCK.
1452 * We protect with the OBJECT_LOCK so that we can use the values to
1453 * safely answer a POSITION query. */
1454 GST_OBJECT_LOCK (basesink);
1455 /* the newsegment event is needed to bring the buffer timestamps to the
1456 * stream time and to drop samples outside of the playback segment. */
1457 gst_event_copy_segment (event, segment);
1458 GST_DEBUG_OBJECT (basesink, "configured SEGMENT %" GST_SEGMENT_FORMAT,
1460 GST_OBJECT_UNLOCK (basesink);
1463 /* with PREROLL_LOCK, STREAM_LOCK */
1465 gst_base_sink_commit_state (GstBaseSink * basesink)
1467 /* commit state and proceed to next pending state */
1468 GstState current, next, pending, post_pending;
1469 gboolean post_paused = FALSE;
1470 gboolean post_async_done = FALSE;
1471 gboolean post_playing = FALSE;
1472 gboolean reset_time;
1474 /* we are certainly not playing async anymore now */
1475 basesink->playing_async = FALSE;
1477 GST_OBJECT_LOCK (basesink);
1478 current = GST_STATE (basesink);
1479 next = GST_STATE_NEXT (basesink);
1480 pending = GST_STATE_PENDING (basesink);
1481 post_pending = pending;
1482 reset_time = basesink->priv->reset_time;
1483 basesink->priv->reset_time = FALSE;
1486 case GST_STATE_PLAYING:
1488 GST_DEBUG_OBJECT (basesink, "commiting state to PLAYING");
1490 basesink->need_preroll = FALSE;
1491 post_async_done = TRUE;
1492 basesink->priv->commited = TRUE;
1493 post_playing = TRUE;
1494 /* post PAUSED too when we were READY */
1495 if (current == GST_STATE_READY) {
1500 case GST_STATE_PAUSED:
1501 GST_DEBUG_OBJECT (basesink, "commiting state to PAUSED");
1503 post_async_done = TRUE;
1504 basesink->priv->commited = TRUE;
1505 post_pending = GST_STATE_VOID_PENDING;
1507 case GST_STATE_READY:
1508 case GST_STATE_NULL:
1510 case GST_STATE_VOID_PENDING:
1511 goto nothing_pending;
1516 /* we can report latency queries now */
1517 basesink->priv->have_latency = TRUE;
1519 GST_STATE (basesink) = pending;
1520 GST_STATE_NEXT (basesink) = GST_STATE_VOID_PENDING;
1521 GST_STATE_PENDING (basesink) = GST_STATE_VOID_PENDING;
1522 GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_SUCCESS;
1523 GST_OBJECT_UNLOCK (basesink);
1526 GST_DEBUG_OBJECT (basesink, "posting PAUSED state change message");
1527 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1528 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1529 current, next, post_pending));
1531 if (post_async_done) {
1532 GST_DEBUG_OBJECT (basesink, "posting async-done message");
1533 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1534 gst_message_new_async_done (GST_OBJECT_CAST (basesink), reset_time));
1537 GST_DEBUG_OBJECT (basesink, "posting PLAYING state change message");
1538 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1539 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1540 next, pending, GST_STATE_VOID_PENDING));
1543 GST_STATE_BROADCAST (basesink);
1549 /* Depending on the state, set our vars. We get in this situation when the
1550 * state change function got a change to update the state vars before the
1551 * streaming thread did. This is fine but we need to make sure that we
1552 * update the need_preroll var since it was TRUE when we got here and might
1553 * become FALSE if we got to PLAYING. */
1554 GST_DEBUG_OBJECT (basesink, "nothing to commit, now in %s",
1555 gst_element_state_get_name (current));
1557 case GST_STATE_PLAYING:
1558 basesink->need_preroll = FALSE;
1560 case GST_STATE_PAUSED:
1561 basesink->need_preroll = TRUE;
1564 basesink->need_preroll = FALSE;
1565 basesink->flushing = TRUE;
1568 /* we can report latency queries now */
1569 basesink->priv->have_latency = TRUE;
1570 GST_OBJECT_UNLOCK (basesink);
1575 /* app is going to READY */
1576 GST_DEBUG_OBJECT (basesink, "stopping");
1577 basesink->need_preroll = FALSE;
1578 basesink->flushing = TRUE;
1579 GST_OBJECT_UNLOCK (basesink);
1585 start_stepping (GstBaseSink * sink, GstSegment * segment,
1586 GstStepInfo * pending, GstStepInfo * current)
1589 GstMessage *message;
1591 GST_DEBUG_OBJECT (sink, "update pending step");
1593 GST_OBJECT_LOCK (sink);
1594 memcpy (current, pending, sizeof (GstStepInfo));
1595 pending->valid = FALSE;
1596 GST_OBJECT_UNLOCK (sink);
1598 /* post message first */
1600 gst_message_new_step_start (GST_OBJECT (sink), TRUE, current->format,
1601 current->amount, current->rate, current->flush, current->intermediate);
1602 gst_message_set_seqnum (message, current->seqnum);
1603 gst_element_post_message (GST_ELEMENT (sink), message);
1605 /* get the running time of where we paused and remember it */
1606 current->start = gst_element_get_start_time (GST_ELEMENT_CAST (sink));
1607 gst_segment_set_running_time (segment, GST_FORMAT_TIME, current->start);
1609 /* set the new rate for the remainder of the segment */
1610 current->start_rate = segment->rate;
1611 segment->rate *= current->rate;
1614 if (segment->rate > 0.0)
1615 current->start_stop = segment->stop;
1617 current->start_start = segment->start;
1619 if (current->format == GST_FORMAT_TIME) {
1620 end = current->start + current->amount;
1621 if (!current->flush) {
1622 /* update the segment clipping regions for non-flushing seeks */
1623 if (segment->rate > 0.0) {
1624 segment->stop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1625 segment->position = segment->stop;
1629 position = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1630 segment->time = position;
1631 segment->start = position;
1632 segment->position = position;
1637 GST_DEBUG_OBJECT (sink, "segment now %" GST_SEGMENT_FORMAT, segment);
1638 GST_DEBUG_OBJECT (sink, "step started at running_time %" GST_TIME_FORMAT,
1639 GST_TIME_ARGS (current->start));
1641 if (current->amount == -1) {
1642 GST_DEBUG_OBJECT (sink, "step amount == -1, stop stepping");
1643 current->valid = FALSE;
1645 GST_DEBUG_OBJECT (sink, "step amount: %" G_GUINT64_FORMAT ", format: %s, "
1646 "rate: %f", current->amount, gst_format_get_name (current->format),
1652 stop_stepping (GstBaseSink * sink, GstSegment * segment,
1653 GstStepInfo * current, gint64 rstart, gint64 rstop, gboolean eos)
1655 gint64 stop, position;
1656 GstMessage *message;
1658 GST_DEBUG_OBJECT (sink, "step complete");
1660 if (segment->rate > 0.0)
1665 GST_DEBUG_OBJECT (sink,
1666 "step stop at running_time %" GST_TIME_FORMAT, GST_TIME_ARGS (stop));
1669 current->duration = current->position;
1671 current->duration = stop - current->start;
1673 GST_DEBUG_OBJECT (sink, "step elapsed running_time %" GST_TIME_FORMAT,
1674 GST_TIME_ARGS (current->duration));
1676 position = current->start + current->duration;
1678 /* now move the segment to the new running time */
1679 gst_segment_set_running_time (segment, GST_FORMAT_TIME, position);
1681 if (current->flush) {
1682 /* and remove the time we flushed, start time did not change */
1683 segment->base = current->start;
1685 /* start time is now the stepped position */
1686 gst_element_set_start_time (GST_ELEMENT_CAST (sink), position);
1689 /* restore the previous rate */
1690 segment->rate = current->start_rate;
1692 if (segment->rate > 0.0)
1693 segment->stop = current->start_stop;
1695 segment->start = current->start_start;
1697 /* the clip segment is used for position report in paused... */
1698 gst_segment_copy_into (segment, &sink->clip_segment);
1700 /* post the step done when we know the stepped duration in TIME */
1702 gst_message_new_step_done (GST_OBJECT_CAST (sink), current->format,
1703 current->amount, current->rate, current->flush, current->intermediate,
1704 current->duration, eos);
1705 gst_message_set_seqnum (message, current->seqnum);
1706 gst_element_post_message (GST_ELEMENT_CAST (sink), message);
1708 if (!current->intermediate)
1709 sink->need_preroll = current->need_preroll;
1711 /* and the current step info finished and becomes invalid */
1712 current->valid = FALSE;
1716 handle_stepping (GstBaseSink * sink, GstSegment * segment,
1717 GstStepInfo * current, guint64 * cstart, guint64 * cstop, guint64 * rstart,
1720 gboolean step_end = FALSE;
1722 /* see if we need to skip this buffer because of stepping */
1723 switch (current->format) {
1724 case GST_FORMAT_TIME:
1727 guint64 first, last;
1730 if (segment->rate > 0.0) {
1731 if (segment->stop == *cstop)
1732 *rstop = *rstart + current->amount;
1737 if (segment->start == *cstart)
1738 *rstart = *rstop + current->amount;
1744 end = current->start + current->amount;
1745 current->position = first - current->start;
1747 abs_rate = ABS (segment->rate);
1748 if (G_UNLIKELY (abs_rate != 1.0))
1749 current->position /= abs_rate;
1751 GST_DEBUG_OBJECT (sink,
1752 "buffer: %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT,
1753 GST_TIME_ARGS (first), GST_TIME_ARGS (last));
1754 GST_DEBUG_OBJECT (sink,
1755 "got time step %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT "/%"
1756 GST_TIME_FORMAT, GST_TIME_ARGS (current->position),
1757 GST_TIME_ARGS (last - current->start),
1758 GST_TIME_ARGS (current->amount));
1760 if ((current->flush && current->position >= current->amount)
1762 GST_DEBUG_OBJECT (sink, "step ended, we need clipping");
1764 if (segment->rate > 0.0) {
1766 *cstart = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1769 *cstop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1772 GST_DEBUG_OBJECT (sink,
1773 "cstart %" GST_TIME_FORMAT ", rstart %" GST_TIME_FORMAT,
1774 GST_TIME_ARGS (*cstart), GST_TIME_ARGS (*rstart));
1775 GST_DEBUG_OBJECT (sink,
1776 "cstop %" GST_TIME_FORMAT ", rstop %" GST_TIME_FORMAT,
1777 GST_TIME_ARGS (*cstop), GST_TIME_ARGS (*rstop));
1780 case GST_FORMAT_BUFFERS:
1781 GST_DEBUG_OBJECT (sink,
1782 "got default step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1783 current->position, current->amount);
1785 if (current->position < current->amount) {
1786 current->position++;
1791 case GST_FORMAT_DEFAULT:
1793 GST_DEBUG_OBJECT (sink,
1794 "got unknown step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1795 current->position, current->amount);
1801 /* with STREAM_LOCK, PREROLL_LOCK
1803 * Returns TRUE if the object needs synchronisation and takes therefore
1804 * part in prerolling.
1806 * rsstart/rsstop contain the start/stop in stream time.
1807 * rrstart/rrstop contain the start/stop in running time.
1810 gst_base_sink_get_sync_times (GstBaseSink * basesink, GstMiniObject * obj,
1811 GstClockTime * rsstart, GstClockTime * rsstop,
1812 GstClockTime * rrstart, GstClockTime * rrstop, gboolean * do_sync,
1813 gboolean * stepped, GstSegment * segment, GstStepInfo * step,
1814 gboolean * step_end, guint8 obj_type)
1816 GstBaseSinkClass *bclass;
1818 GstClockTime start, stop; /* raw start/stop timestamps */
1819 guint64 cstart, cstop; /* clipped raw timestamps */
1820 guint64 rstart, rstop; /* clipped timestamps converted to running time */
1821 GstClockTime sstart, sstop; /* clipped timestamps converted to stream time */
1823 GstBaseSinkPrivate *priv;
1826 priv = basesink->priv;
1828 /* start with nothing */
1829 start = stop = GST_CLOCK_TIME_NONE;
1831 if (G_UNLIKELY (OBJ_IS_EVENT (obj_type))) {
1832 GstEvent *event = GST_EVENT_CAST (obj);
1834 switch (GST_EVENT_TYPE (event)) {
1835 /* EOS event needs syncing */
1838 if (basesink->segment.rate >= 0.0) {
1839 sstart = sstop = priv->current_sstop;
1840 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1841 /* we have not seen a buffer yet, use the segment values */
1842 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1843 basesink->segment.format, basesink->segment.stop);
1846 sstart = sstop = priv->current_sstart;
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.start);
1854 rstart = rstop = priv->eos_rtime;
1855 *do_sync = rstart != -1;
1856 GST_DEBUG_OBJECT (basesink, "sync times for EOS %" GST_TIME_FORMAT,
1857 GST_TIME_ARGS (rstart));
1858 /* if we are stepping, we end now */
1859 *step_end = step->valid;
1864 /* other events do not need syncing */
1872 /* else do buffer sync code */
1873 buffer = GST_BUFFER_CAST (obj);
1875 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1877 /* just get the times to see if we need syncing, if the start returns -1 we
1879 if (bclass->get_times)
1880 bclass->get_times (basesink, buffer, &start, &stop);
1882 if (!GST_CLOCK_TIME_IS_VALID (start)) {
1883 /* we don't need to sync but we still want to get the timestamps for
1884 * tracking the position */
1885 gst_base_sink_get_times (basesink, buffer, &start, &stop);
1891 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
1892 ", stop: %" GST_TIME_FORMAT ", do_sync %d", GST_TIME_ARGS (start),
1893 GST_TIME_ARGS (stop), *do_sync);
1895 /* collect segment and format for code clarity */
1896 format = segment->format;
1899 if (G_UNLIKELY (!gst_segment_clip (segment, format,
1900 start, stop, &cstart, &cstop))) {
1902 GST_DEBUG_OBJECT (basesink, "step out of segment");
1903 /* when we are stepping, pretend we're at the end of the segment */
1904 if (segment->rate > 0.0) {
1905 cstart = segment->stop;
1906 cstop = segment->stop;
1908 cstart = segment->start;
1909 cstop = segment->start;
1913 goto out_of_segment;
1916 if (G_UNLIKELY (start != cstart || stop != cstop)) {
1917 GST_DEBUG_OBJECT (basesink, "clipped to: start %" GST_TIME_FORMAT
1918 ", stop: %" GST_TIME_FORMAT, GST_TIME_ARGS (cstart),
1919 GST_TIME_ARGS (cstop));
1922 /* set last stop position */
1923 if (G_LIKELY (stop != GST_CLOCK_TIME_NONE && cstop != GST_CLOCK_TIME_NONE))
1924 segment->position = cstop;
1926 segment->position = cstart;
1929 rstart = gst_segment_to_running_time (segment, format, cstart);
1930 rstop = gst_segment_to_running_time (segment, format, cstop);
1932 if (G_UNLIKELY (step->valid)) {
1933 if (!(*step_end = handle_stepping (basesink, segment, step, &cstart, &cstop,
1934 &rstart, &rstop))) {
1935 /* step is still busy, we discard data when we are flushing */
1936 *stepped = step->flush;
1937 GST_DEBUG_OBJECT (basesink, "stepping busy");
1940 /* this can produce wrong values if we accumulated non-TIME segments. If this happens,
1941 * upstream is behaving very badly */
1942 sstart = gst_segment_to_stream_time (segment, format, cstart);
1943 sstop = gst_segment_to_stream_time (segment, format, cstop);
1946 /* eos_done label only called when doing EOS, we also stop stepping then */
1947 if (*step_end && step->flush) {
1948 GST_DEBUG_OBJECT (basesink, "flushing step ended");
1949 stop_stepping (basesink, segment, step, rstart, rstop, eos);
1951 /* re-determine running start times for adjusted segment
1952 * (which has a flushed amount of running/accumulated time removed) */
1953 if (!GST_IS_EVENT (obj)) {
1954 GST_DEBUG_OBJECT (basesink, "refresh sync times");
1965 /* buffers and EOS always need syncing and preroll */
1971 /* we usually clip in the chain function already but stepping could cause
1972 * the segment to be updated later. we return FALSE so that we don't try
1974 GST_LOG_OBJECT (basesink, "buffer skipped, not in segment");
1979 /* with STREAM_LOCK, PREROLL_LOCK, LOCK
1980 * adjust a timestamp with the latency and timestamp offset. This function does
1981 * not adjust for the render delay. */
1983 gst_base_sink_adjust_time (GstBaseSink * basesink, GstClockTime time)
1985 GstClockTimeDiff ts_offset;
1987 /* don't do anything funny with invalid timestamps */
1988 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
1991 time += basesink->priv->latency;
1993 /* apply offset, be carefull for underflows */
1994 ts_offset = basesink->priv->ts_offset;
1995 if (ts_offset < 0) {
1996 ts_offset = -ts_offset;
1997 if (ts_offset < time)
2004 /* subtract the render delay again, which was included in the latency */
2005 if (time > basesink->priv->render_delay)
2006 time -= basesink->priv->render_delay;
2014 * gst_base_sink_wait_clock:
2016 * @time: the running_time to be reached
2017 * @jitter: (out) (allow-none): the jitter to be filled with time diff, or NULL
2019 * This function will block until @time is reached. It is usually called by
2020 * subclasses that use their own internal synchronisation.
2022 * If @time is not valid, no sycnhronisation is done and #GST_CLOCK_BADTIME is
2023 * returned. Likewise, if synchronisation is disabled in the element or there
2024 * is no clock, no synchronisation is done and #GST_CLOCK_BADTIME is returned.
2026 * This function should only be called with the PREROLL_LOCK held, like when
2027 * receiving an EOS event in the #GstBaseSinkClass.event() vmethod or when
2028 * receiving a buffer in
2029 * the #GstBaseSinkClass.render() vmethod.
2031 * The @time argument should be the running_time of when this method should
2032 * return and is not adjusted with any latency or offset configured in the
2037 * Returns: #GstClockReturn
2040 gst_base_sink_wait_clock (GstBaseSink * sink, GstClockTime time,
2041 GstClockTimeDiff * jitter)
2045 GstClockTime base_time;
2047 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
2050 GST_OBJECT_LOCK (sink);
2051 if (G_UNLIKELY (!sink->sync))
2054 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (sink)) == NULL))
2057 base_time = GST_ELEMENT_CAST (sink)->base_time;
2058 GST_LOG_OBJECT (sink,
2059 "time %" GST_TIME_FORMAT ", base_time %" GST_TIME_FORMAT,
2060 GST_TIME_ARGS (time), GST_TIME_ARGS (base_time));
2062 /* add base_time to running_time to get the time against the clock */
2065 /* Re-use existing clockid if available */
2066 /* FIXME: Casting to GstClockEntry only works because the types
2068 if (G_LIKELY (sink->priv->cached_clock_id != NULL
2069 && GST_CLOCK_ENTRY_CLOCK ((GstClockEntry *) sink->
2070 priv->cached_clock_id) == clock)) {
2071 if (!gst_clock_single_shot_id_reinit (clock, sink->priv->cached_clock_id,
2073 gst_clock_id_unref (sink->priv->cached_clock_id);
2074 sink->priv->cached_clock_id = gst_clock_new_single_shot_id (clock, time);
2077 if (sink->priv->cached_clock_id != NULL)
2078 gst_clock_id_unref (sink->priv->cached_clock_id);
2079 sink->priv->cached_clock_id = gst_clock_new_single_shot_id (clock, time);
2081 GST_OBJECT_UNLOCK (sink);
2083 /* A blocking wait is performed on the clock. We save the ClockID
2084 * so we can unlock the entry at any time. While we are blocking, we
2085 * release the PREROLL_LOCK so that other threads can interrupt the
2087 sink->clock_id = sink->priv->cached_clock_id;
2088 /* release the preroll lock while waiting */
2089 GST_BASE_SINK_PREROLL_UNLOCK (sink);
2091 ret = gst_clock_id_wait (sink->priv->cached_clock_id, jitter);
2093 GST_BASE_SINK_PREROLL_LOCK (sink);
2094 sink->clock_id = NULL;
2098 /* no syncing needed */
2101 GST_DEBUG_OBJECT (sink, "time not valid, no sync needed");
2102 return GST_CLOCK_BADTIME;
2106 GST_DEBUG_OBJECT (sink, "sync disabled");
2107 GST_OBJECT_UNLOCK (sink);
2108 return GST_CLOCK_BADTIME;
2112 GST_DEBUG_OBJECT (sink, "no clock, can't sync");
2113 GST_OBJECT_UNLOCK (sink);
2114 return GST_CLOCK_BADTIME;
2119 * gst_base_sink_wait_preroll:
2122 * If the #GstBaseSinkClass.render() method performs its own synchronisation
2123 * against the clock it must unblock when going from PLAYING to the PAUSED state
2124 * and call this method before continuing to render the remaining data.
2126 * This function will block until a state change to PLAYING happens (in which
2127 * case this function returns #GST_FLOW_OK) or the processing must be stopped due
2128 * to a state change to READY or a FLUSH event (in which case this function
2129 * returns #GST_FLOW_WRONG_STATE).
2131 * This function should only be called with the PREROLL_LOCK held, like in the
2134 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2135 * continue. Any other return value should be returned from the render vmethod.
2140 gst_base_sink_wait_preroll (GstBaseSink * sink)
2142 sink->have_preroll = TRUE;
2143 GST_DEBUG_OBJECT (sink, "waiting in preroll for flush or PLAYING");
2144 /* block until the state changes, or we get a flush, or something */
2145 GST_BASE_SINK_PREROLL_WAIT (sink);
2146 sink->have_preroll = FALSE;
2147 if (G_UNLIKELY (sink->flushing))
2149 if (G_UNLIKELY (sink->priv->step_unlock))
2151 GST_DEBUG_OBJECT (sink, "continue after preroll");
2158 GST_DEBUG_OBJECT (sink, "preroll interrupted because of flush");
2159 return GST_FLOW_WRONG_STATE;
2163 sink->priv->step_unlock = FALSE;
2164 GST_DEBUG_OBJECT (sink, "preroll interrupted because of step");
2165 return GST_FLOW_STEP;
2169 static inline guint8
2170 get_object_type (GstMiniObject * obj)
2174 if (G_LIKELY (GST_IS_BUFFER (obj)))
2175 obj_type = _PR_IS_BUFFER;
2176 else if (GST_IS_EVENT (obj))
2177 obj_type = _PR_IS_EVENT;
2178 else if (GST_IS_BUFFER_LIST (obj))
2179 obj_type = _PR_IS_BUFFERLIST;
2181 obj_type = _PR_IS_NOTHING;
2187 * gst_base_sink_do_preroll:
2189 * @obj: (transfer none): the mini object that caused the preroll
2191 * If the @sink spawns its own thread for pulling buffers from upstream it
2192 * should call this method after it has pulled a buffer. If the element needed
2193 * to preroll, this function will perform the preroll and will then block
2194 * until the element state is changed.
2196 * This function should be called with the PREROLL_LOCK held.
2198 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2199 * continue. Any other return value should be returned from the render vmethod.
2204 gst_base_sink_do_preroll (GstBaseSink * sink, GstMiniObject * obj)
2208 while (G_UNLIKELY (sink->need_preroll)) {
2210 GST_DEBUG_OBJECT (sink, "prerolling object %p", obj);
2212 obj_type = get_object_type (obj);
2214 ret = gst_base_sink_preroll_object (sink, obj_type, obj);
2215 if (ret != GST_FLOW_OK)
2216 goto preroll_failed;
2218 /* need to recheck here because the commit state could have
2219 * made us not need the preroll anymore */
2220 if (G_LIKELY (sink->need_preroll)) {
2221 /* block until the state changes, or we get a flush, or something */
2222 ret = gst_base_sink_wait_preroll (sink);
2223 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2224 goto preroll_failed;
2232 GST_DEBUG_OBJECT (sink, "preroll failed: %s", gst_flow_get_name (ret));
2238 * gst_base_sink_wait_eos:
2240 * @time: the running_time to be reached
2241 * @jitter: (out) (allow-none): the jitter to be filled with time diff, or NULL
2243 * This function will block until @time is reached. It is usually called by
2244 * subclasses that use their own internal synchronisation but want to let the
2245 * EOS be handled by the base class.
2247 * This function should only be called with the PREROLL_LOCK held, like when
2248 * receiving an EOS event in the ::event vmethod.
2250 * The @time argument should be the running_time of when the EOS should happen
2251 * and will be adjusted with any latency and offset configured in the sink.
2253 * Returns: #GstFlowReturn
2258 gst_base_sink_wait_eos (GstBaseSink * sink, GstClockTime time,
2259 GstClockTimeDiff * jitter)
2261 GstClockReturn status;
2267 GST_DEBUG_OBJECT (sink, "checking preroll");
2269 /* first wait for the playing state before we can continue */
2270 while (G_UNLIKELY (sink->need_preroll)) {
2271 ret = gst_base_sink_wait_preroll (sink);
2272 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2276 /* preroll done, we can sync since we are in PLAYING now. */
2277 GST_DEBUG_OBJECT (sink, "possibly waiting for clock to reach %"
2278 GST_TIME_FORMAT, GST_TIME_ARGS (time));
2280 /* compensate for latency and ts_offset. We don't adjust for render delay
2281 * because we don't interact with the device on EOS normally. */
2282 stime = gst_base_sink_adjust_time (sink, time);
2284 /* wait for the clock, this can be interrupted because we got shut down or
2286 status = gst_base_sink_wait_clock (sink, stime, jitter);
2288 GST_DEBUG_OBJECT (sink, "clock returned %d", status);
2290 /* invalid time, no clock or sync disabled, just continue then */
2291 if (status == GST_CLOCK_BADTIME)
2294 /* waiting could have been interrupted and we can be flushing now */
2295 if (G_UNLIKELY (sink->flushing))
2298 /* retry if we got unscheduled, which means we did not reach the timeout
2299 * yet. if some other error occures, we continue. */
2300 } while (status == GST_CLOCK_UNSCHEDULED);
2302 GST_DEBUG_OBJECT (sink, "end of stream");
2309 GST_DEBUG_OBJECT (sink, "we are flushing");
2310 return GST_FLOW_WRONG_STATE;
2314 /* with STREAM_LOCK, PREROLL_LOCK
2316 * Make sure we are in PLAYING and synchronize an object to the clock.
2318 * If we need preroll, we are not in PLAYING. We try to commit the state
2319 * if needed and then block if we still are not PLAYING.
2321 * We start waiting on the clock in PLAYING. If we got interrupted, we
2322 * immediatly try to re-preroll.
2324 * Some objects do not need synchronisation (most events) and so this function
2325 * immediatly returns GST_FLOW_OK.
2327 * for objects that arrive later than max-lateness to be synchronized to the
2328 * clock have the @late boolean set to TRUE.
2330 * This function keeps a running average of the jitter (the diff between the
2331 * clock time and the requested sync time). The jitter is negative for
2332 * objects that arrive in time and positive for late buffers.
2334 * does not take ownership of obj.
2336 static GstFlowReturn
2337 gst_base_sink_do_sync (GstBaseSink * basesink, GstPad * pad,
2338 GstMiniObject * obj, gboolean * late, gboolean * step_end, guint8 obj_type)
2340 GstClockTimeDiff jitter = 0;
2342 GstClockReturn status = GST_CLOCK_OK;
2343 GstClockTime rstart, rstop, sstart, sstop, stime;
2345 GstBaseSinkPrivate *priv;
2347 GstStepInfo *current, *pending;
2350 priv = basesink->priv;
2353 sstart = sstop = rstart = rstop = GST_CLOCK_TIME_NONE;
2357 priv->current_rstart = GST_CLOCK_TIME_NONE;
2359 /* get stepping info */
2360 current = &priv->current_step;
2361 pending = &priv->pending_step;
2363 /* get timing information for this object against the render segment */
2364 syncable = gst_base_sink_get_sync_times (basesink, obj,
2365 &sstart, &sstop, &rstart, &rstop, &do_sync, &stepped, &basesink->segment,
2366 current, step_end, obj_type);
2368 if (G_UNLIKELY (stepped))
2371 /* a syncable object needs to participate in preroll and
2372 * clocking. All buffers and EOS are syncable. */
2373 if (G_UNLIKELY (!syncable))
2376 /* store timing info for current object */
2377 priv->current_rstart = rstart;
2378 priv->current_rstop = (GST_CLOCK_TIME_IS_VALID (rstop) ? rstop : rstart);
2380 /* save sync time for eos when the previous object needed sync */
2381 priv->eos_rtime = (do_sync ? priv->current_rstop : GST_CLOCK_TIME_NONE);
2383 /* calculate inter frame spacing */
2384 if (G_UNLIKELY (priv->prev_rstart != -1 && priv->prev_rstart < rstart)) {
2385 GstClockTime in_diff;
2387 in_diff = rstart - priv->prev_rstart;
2389 if (priv->avg_in_diff == -1)
2390 priv->avg_in_diff = in_diff;
2392 priv->avg_in_diff = UPDATE_RUNNING_AVG (priv->avg_in_diff, in_diff);
2394 GST_LOG_OBJECT (basesink, "avg frame diff %" GST_TIME_FORMAT,
2395 GST_TIME_ARGS (priv->avg_in_diff));
2398 priv->prev_rstart = rstart;
2400 if (G_UNLIKELY (priv->earliest_in_time != -1
2401 && rstart < priv->earliest_in_time))
2405 /* first do preroll, this makes sure we commit our state
2406 * to PAUSED and can continue to PLAYING. We cannot perform
2407 * any clock sync in PAUSED because there is no clock. */
2408 ret = gst_base_sink_do_preroll (basesink, obj);
2409 if (G_UNLIKELY (ret != GST_FLOW_OK))
2410 goto preroll_failed;
2412 /* update the segment with a pending step if the current one is invalid and we
2413 * have a new pending one. We only accept new step updates after a preroll */
2414 if (G_UNLIKELY (pending->valid && !current->valid)) {
2415 start_stepping (basesink, &basesink->segment, pending, current);
2419 /* After rendering we store the position of the last buffer so that we can use
2420 * it to report the position. We need to take the lock here. */
2421 GST_OBJECT_LOCK (basesink);
2422 priv->current_sstart = sstart;
2423 priv->current_sstop = (GST_CLOCK_TIME_IS_VALID (sstop) ? sstop : sstart);
2424 GST_OBJECT_UNLOCK (basesink);
2429 /* adjust for latency */
2430 stime = gst_base_sink_adjust_time (basesink, rstart);
2432 /* adjust for render-delay, avoid underflows */
2433 if (GST_CLOCK_TIME_IS_VALID (stime)) {
2434 if (stime > priv->render_delay)
2435 stime -= priv->render_delay;
2440 /* preroll done, we can sync since we are in PLAYING now. */
2441 GST_DEBUG_OBJECT (basesink, "possibly waiting for clock to reach %"
2442 GST_TIME_FORMAT ", adjusted %" GST_TIME_FORMAT,
2443 GST_TIME_ARGS (rstart), GST_TIME_ARGS (stime));
2445 /* This function will return immediatly if start == -1, no clock
2446 * or sync is disabled with GST_CLOCK_BADTIME. */
2447 status = gst_base_sink_wait_clock (basesink, stime, &jitter);
2449 GST_DEBUG_OBJECT (basesink, "clock returned %d, jitter %c%" GST_TIME_FORMAT,
2450 status, (jitter < 0 ? '-' : ' '), GST_TIME_ARGS (ABS (jitter)));
2452 /* invalid time, no clock or sync disabled, just render */
2453 if (status == GST_CLOCK_BADTIME)
2456 /* waiting could have been interrupted and we can be flushing now */
2457 if (G_UNLIKELY (basesink->flushing))
2460 /* check for unlocked by a state change, we are not flushing so
2461 * we can try to preroll on the current buffer. */
2462 if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED)) {
2463 GST_DEBUG_OBJECT (basesink, "unscheduled, waiting some more");
2464 priv->call_preroll = TRUE;
2468 /* successful syncing done, record observation */
2469 priv->current_jitter = jitter;
2471 /* check if the object should be dropped */
2472 *late = gst_base_sink_is_too_late (basesink, obj, rstart, rstop,
2481 GST_DEBUG_OBJECT (basesink, "skipped stepped object %p", obj);
2487 GST_DEBUG_OBJECT (basesink, "non syncable object %p", obj);
2492 GST_DEBUG_OBJECT (basesink, "dropped because of QoS %p", obj);
2498 GST_DEBUG_OBJECT (basesink, "we are flushing");
2499 return GST_FLOW_WRONG_STATE;
2503 GST_DEBUG_OBJECT (basesink, "preroll failed");
2510 gst_base_sink_send_qos (GstBaseSink * basesink, GstQOSType type,
2511 gdouble proportion, GstClockTime time, GstClockTimeDiff diff)
2516 /* generate Quality-of-Service event */
2517 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2518 "qos: type %d, proportion: %lf, diff %" G_GINT64_FORMAT ", timestamp %"
2519 GST_TIME_FORMAT, type, proportion, diff, GST_TIME_ARGS (time));
2521 event = gst_event_new_qos (type, proportion, diff, time);
2524 res = gst_pad_push_event (basesink->sinkpad, event);
2530 gst_base_sink_perform_qos (GstBaseSink * sink, gboolean dropped)
2532 GstBaseSinkPrivate *priv;
2533 GstClockTime start, stop;
2534 GstClockTimeDiff jitter;
2535 GstClockTime pt, entered, left;
2536 GstClockTime duration;
2541 start = priv->current_rstart;
2543 if (priv->current_step.valid)
2546 /* if Quality-of-Service disabled, do nothing */
2547 if (!g_atomic_int_get (&priv->qos_enabled) ||
2548 !GST_CLOCK_TIME_IS_VALID (start))
2551 stop = priv->current_rstop;
2552 jitter = priv->current_jitter;
2555 /* this is the time the buffer entered the sink */
2556 if (start < -jitter)
2559 entered = start + jitter;
2562 /* this is the time the buffer entered the sink */
2563 entered = start + jitter;
2564 /* this is the time the buffer left the sink */
2565 left = start + jitter;
2568 /* calculate duration of the buffer */
2569 if (GST_CLOCK_TIME_IS_VALID (stop) && stop != start)
2570 duration = stop - start;
2572 duration = priv->avg_in_diff;
2574 /* if we have the time when the last buffer left us, calculate
2575 * processing time */
2576 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2577 if (entered > priv->last_left) {
2578 pt = entered - priv->last_left;
2586 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "start: %" GST_TIME_FORMAT
2587 ", stop %" GST_TIME_FORMAT ", entered %" GST_TIME_FORMAT ", left %"
2588 GST_TIME_FORMAT ", pt: %" GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT
2589 ",jitter %" G_GINT64_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (stop),
2590 GST_TIME_ARGS (entered), GST_TIME_ARGS (left), GST_TIME_ARGS (pt),
2591 GST_TIME_ARGS (duration), jitter);
2593 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "avg_duration: %" GST_TIME_FORMAT
2594 ", avg_pt: %" GST_TIME_FORMAT ", avg_rate: %g",
2595 GST_TIME_ARGS (priv->avg_duration), GST_TIME_ARGS (priv->avg_pt),
2598 /* collect running averages. for first observations, we copy the
2600 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_duration))
2601 priv->avg_duration = duration;
2603 priv->avg_duration = UPDATE_RUNNING_AVG (priv->avg_duration, duration);
2605 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_pt))
2608 priv->avg_pt = UPDATE_RUNNING_AVG (priv->avg_pt, pt);
2610 if (priv->avg_duration != 0)
2612 gst_guint64_to_gdouble (priv->avg_pt) /
2613 gst_guint64_to_gdouble (priv->avg_duration);
2617 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2618 if (dropped || priv->avg_rate < 0.0) {
2619 priv->avg_rate = rate;
2622 priv->avg_rate = UPDATE_RUNNING_AVG_N (priv->avg_rate, rate);
2624 priv->avg_rate = UPDATE_RUNNING_AVG_P (priv->avg_rate, rate);
2628 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink,
2629 "updated: avg_duration: %" GST_TIME_FORMAT ", avg_pt: %" GST_TIME_FORMAT
2630 ", avg_rate: %g", GST_TIME_ARGS (priv->avg_duration),
2631 GST_TIME_ARGS (priv->avg_pt), priv->avg_rate);
2634 if (priv->avg_rate >= 0.0) {
2636 GstClockTimeDiff diff;
2638 /* if we have a valid rate, start sending QoS messages */
2639 if (priv->current_jitter < 0) {
2640 /* make sure we never go below 0 when adding the jitter to the
2642 if (priv->current_rstart < -priv->current_jitter)
2643 priv->current_jitter = -priv->current_rstart;
2646 if (priv->throttle_time > 0) {
2647 diff = priv->throttle_time;
2648 type = GST_QOS_TYPE_THROTTLE;
2650 diff = priv->current_jitter;
2652 type = GST_QOS_TYPE_OVERFLOW;
2654 type = GST_QOS_TYPE_UNDERFLOW;
2657 gst_base_sink_send_qos (sink, type, priv->avg_rate, priv->current_rstart,
2661 /* record when this buffer will leave us */
2662 priv->last_left = left;
2665 /* reset all qos measuring */
2667 gst_base_sink_reset_qos (GstBaseSink * sink)
2669 GstBaseSinkPrivate *priv;
2673 priv->last_render_time = GST_CLOCK_TIME_NONE;
2674 priv->prev_rstart = GST_CLOCK_TIME_NONE;
2675 priv->earliest_in_time = GST_CLOCK_TIME_NONE;
2676 priv->last_left = GST_CLOCK_TIME_NONE;
2677 priv->avg_duration = GST_CLOCK_TIME_NONE;
2678 priv->avg_pt = GST_CLOCK_TIME_NONE;
2679 priv->avg_rate = -1.0;
2680 priv->avg_render = GST_CLOCK_TIME_NONE;
2681 priv->avg_in_diff = GST_CLOCK_TIME_NONE;
2687 /* Checks if the object was scheduled too late.
2689 * rstart/rstop contain the running_time start and stop values
2692 * status and jitter contain the return values from the clock wait.
2694 * returns TRUE if the buffer was too late.
2697 gst_base_sink_is_too_late (GstBaseSink * basesink, GstMiniObject * obj,
2698 GstClockTime rstart, GstClockTime rstop,
2699 GstClockReturn status, GstClockTimeDiff jitter)
2702 guint64 max_lateness;
2703 GstBaseSinkPrivate *priv;
2705 priv = basesink->priv;
2709 /* only for objects that were too late */
2710 if (G_LIKELY (status != GST_CLOCK_EARLY))
2713 max_lateness = basesink->max_lateness;
2715 /* check if frame dropping is enabled */
2716 if (max_lateness == -1)
2719 /* only check for buffers */
2720 if (G_UNLIKELY (!GST_IS_BUFFER (obj)))
2723 /* can't do check if we don't have a timestamp */
2724 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (rstart)))
2727 /* we can add a valid stop time */
2728 if (GST_CLOCK_TIME_IS_VALID (rstop))
2729 max_lateness += rstop;
2731 max_lateness += rstart;
2732 /* no stop time, use avg frame diff */
2733 if (priv->avg_in_diff != -1)
2734 max_lateness += priv->avg_in_diff;
2737 /* if the jitter bigger than duration and lateness we are too late */
2738 if ((late = rstart + jitter > max_lateness)) {
2739 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2740 "buffer is too late %" GST_TIME_FORMAT
2741 " > %" GST_TIME_FORMAT, GST_TIME_ARGS (rstart + jitter),
2742 GST_TIME_ARGS (max_lateness));
2743 /* !!emergency!!, if we did not receive anything valid for more than a
2744 * second, render it anyway so the user sees something */
2745 if (GST_CLOCK_TIME_IS_VALID (priv->last_render_time) &&
2746 rstart - priv->last_render_time > GST_SECOND) {
2748 GST_ELEMENT_WARNING (basesink, CORE, CLOCK,
2749 (_("A lot of buffers are being dropped.")),
2750 ("There may be a timestamping problem, or this computer is too slow."));
2751 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2752 "**emergency** last buffer at %" GST_TIME_FORMAT " > GST_SECOND",
2753 GST_TIME_ARGS (priv->last_render_time));
2758 if (!late || !GST_CLOCK_TIME_IS_VALID (priv->last_render_time)) {
2759 priv->last_render_time = rstart;
2760 /* the next allowed input timestamp */
2761 if (priv->throttle_time > 0)
2762 priv->earliest_in_time = rstart + priv->throttle_time;
2769 GST_DEBUG_OBJECT (basesink, "object was scheduled in time");
2774 GST_DEBUG_OBJECT (basesink, "frame dropping disabled");
2779 GST_DEBUG_OBJECT (basesink, "object is not a buffer");
2784 GST_DEBUG_OBJECT (basesink, "buffer has no timestamp");
2789 /* called before and after calling the render vmethod. It keeps track of how
2790 * much time was spent in the render method and is used to check if we are
2793 gst_base_sink_do_render_stats (GstBaseSink * basesink, gboolean start)
2795 GstBaseSinkPrivate *priv;
2797 priv = basesink->priv;
2800 priv->start = gst_util_get_timestamp ();
2802 GstClockTime elapsed;
2804 priv->stop = gst_util_get_timestamp ();
2806 elapsed = GST_CLOCK_DIFF (priv->start, priv->stop);
2808 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_render))
2809 priv->avg_render = elapsed;
2811 priv->avg_render = UPDATE_RUNNING_AVG (priv->avg_render, elapsed);
2813 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2814 "avg_render: %" GST_TIME_FORMAT, GST_TIME_ARGS (priv->avg_render));
2818 /* with STREAM_LOCK, PREROLL_LOCK,
2820 * Synchronize the object on the clock and then render it.
2822 * takes ownership of obj.
2824 static GstFlowReturn
2825 gst_base_sink_render_object (GstBaseSink * basesink, GstPad * pad,
2826 guint8 obj_type, gpointer obj)
2829 GstBaseSinkClass *bclass;
2830 gboolean late, step_end;
2832 GstBaseSinkPrivate *priv;
2834 priv = basesink->priv;
2836 if (OBJ_IS_BUFFERLIST (obj_type)) {
2838 * If buffer list, use the first group buffer within the list
2841 sync_obj = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0);
2842 g_assert (NULL != sync_obj);
2851 /* synchronize this object, non syncable objects return OK
2854 gst_base_sink_do_sync (basesink, pad, sync_obj, &late, &step_end,
2856 if (G_UNLIKELY (ret != GST_FLOW_OK))
2859 /* and now render, event or buffer/buffer list. */
2860 if (G_LIKELY (OBJ_IS_BUFFERFULL (obj_type))) {
2861 /* drop late buffers unconditionally, let's hope it's unlikely */
2862 if (G_UNLIKELY (late))
2865 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2867 if (G_LIKELY ((OBJ_IS_BUFFERLIST (obj_type) && bclass->render_list) ||
2868 (!OBJ_IS_BUFFERLIST (obj_type) && bclass->render))) {
2871 /* read once, to get same value before and after */
2872 do_qos = g_atomic_int_get (&priv->qos_enabled);
2874 GST_DEBUG_OBJECT (basesink, "rendering object %p", obj);
2876 /* record rendering time for QoS and stats */
2878 gst_base_sink_do_render_stats (basesink, TRUE);
2880 if (!OBJ_IS_BUFFERLIST (obj_type)) {
2883 /* For buffer lists do not set last buffer. Creating buffer
2884 * with meaningful data can be done only with memcpy which will
2885 * significantly affect performance */
2886 buf = GST_BUFFER_CAST (obj);
2887 gst_base_sink_set_last_buffer (basesink, buf);
2889 ret = bclass->render (basesink, buf);
2891 GstBufferList *buflist;
2893 buflist = GST_BUFFER_LIST_CAST (obj);
2895 ret = bclass->render_list (basesink, buflist);
2899 gst_base_sink_do_render_stats (basesink, FALSE);
2901 if (ret == GST_FLOW_STEP)
2904 if (G_UNLIKELY (basesink->flushing))
2909 } else if (G_LIKELY (OBJ_IS_EVENT (obj_type))) {
2910 GstEvent *event = GST_EVENT_CAST (obj);
2911 gboolean event_res = TRUE;
2914 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2916 type = GST_EVENT_TYPE (event);
2918 GST_DEBUG_OBJECT (basesink, "rendering event %p, type %s", obj,
2919 gst_event_type_get_name (type));
2922 event_res = bclass->event (basesink, event);
2924 /* when we get here we could be flushing again when the event handler calls
2925 * _wait_eos(). We have to ignore this object in that case. */
2926 if (G_UNLIKELY (basesink->flushing))
2929 if (G_LIKELY (event_res)) {
2932 seqnum = basesink->priv->seqnum = gst_event_get_seqnum (event);
2933 GST_DEBUG_OBJECT (basesink, "Got seqnum #%" G_GUINT32_FORMAT, seqnum);
2938 GstMessage *message;
2940 /* the EOS event is completely handled so we mark
2941 * ourselves as being in the EOS state. eos is also
2942 * protected by the object lock so we can read it when
2943 * answering the POSITION query. */
2944 GST_OBJECT_LOCK (basesink);
2945 basesink->eos = TRUE;
2946 GST_OBJECT_UNLOCK (basesink);
2948 /* ok, now we can post the message */
2949 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
2951 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
2952 gst_message_set_seqnum (message, seqnum);
2953 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
2956 case GST_EVENT_SEGMENT:
2957 /* configure the segment */
2958 gst_base_sink_configure_segment (basesink, pad, event,
2959 &basesink->segment);
2963 GstTagList *taglist;
2965 gst_event_parse_tag (event, &taglist);
2967 gst_element_post_message (GST_ELEMENT_CAST (basesink),
2968 gst_message_new_tag (GST_OBJECT_CAST (basesink),
2969 gst_tag_list_copy (taglist)));
2972 case GST_EVENT_SINK_MESSAGE:
2974 GstMessage *msg = NULL;
2976 gst_event_parse_sink_message (event, &msg);
2979 gst_element_post_message (GST_ELEMENT_CAST (basesink), msg);
2986 g_return_val_if_reached (GST_FLOW_ERROR);
2991 /* the step ended, check if we need to activate a new step */
2992 GST_DEBUG_OBJECT (basesink, "step ended");
2993 stop_stepping (basesink, &basesink->segment, &priv->current_step,
2994 priv->current_rstart, priv->current_rstop, basesink->eos);
2998 gst_base_sink_perform_qos (basesink, late);
3000 GST_DEBUG_OBJECT (basesink, "object unref after render %p", obj);
3001 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3007 GST_DEBUG_OBJECT (basesink, "do_sync returned %s", gst_flow_get_name (ret));
3013 GST_DEBUG_OBJECT (basesink, "buffer late, dropping");
3015 if (g_atomic_int_get (&priv->qos_enabled)) {
3016 GstMessage *qos_msg;
3017 GstClockTime timestamp, duration;
3019 timestamp = GST_BUFFER_TIMESTAMP (GST_BUFFER_CAST (sync_obj));
3020 duration = GST_BUFFER_DURATION (GST_BUFFER_CAST (sync_obj));
3022 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
3023 "qos: dropped buffer rt %" GST_TIME_FORMAT ", st %" GST_TIME_FORMAT
3024 ", ts %" GST_TIME_FORMAT ", dur %" GST_TIME_FORMAT,
3025 GST_TIME_ARGS (priv->current_rstart),
3026 GST_TIME_ARGS (priv->current_sstart), GST_TIME_ARGS (timestamp),
3027 GST_TIME_ARGS (duration));
3028 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
3029 "qos: rendered %" G_GUINT64_FORMAT ", dropped %" G_GUINT64_FORMAT,
3030 priv->rendered, priv->dropped);
3033 gst_message_new_qos (GST_OBJECT_CAST (basesink), basesink->sync,
3034 priv->current_rstart, priv->current_sstart, timestamp, duration);
3035 gst_message_set_qos_values (qos_msg, priv->current_jitter, priv->avg_rate,
3037 gst_message_set_qos_stats (qos_msg, GST_FORMAT_BUFFERS, priv->rendered,
3039 gst_element_post_message (GST_ELEMENT_CAST (basesink), qos_msg);
3045 GST_DEBUG_OBJECT (basesink, "we are flushing, ignore object");
3046 gst_mini_object_unref (obj);
3047 return GST_FLOW_WRONG_STATE;
3051 /* with STREAM_LOCK, PREROLL_LOCK
3053 * Perform preroll on the given object. For buffers this means
3054 * calling the preroll subclass method.
3055 * If that succeeds, the state will be commited.
3057 * function does not take ownership of obj.
3059 static GstFlowReturn
3060 gst_base_sink_preroll_object (GstBaseSink * basesink, guint8 obj_type,
3061 GstMiniObject * obj)
3065 GST_DEBUG_OBJECT (basesink, "prerolling object %p", obj);
3067 /* if it's a buffer, we need to call the preroll method */
3068 if (G_LIKELY (OBJ_IS_BUFFERFULL (obj_type) && basesink->priv->call_preroll)) {
3069 GstBaseSinkClass *bclass;
3071 GstClockTime timestamp;
3073 if (OBJ_IS_BUFFERLIST (obj_type)) {
3074 buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0);
3075 g_assert (NULL != buf);
3077 buf = GST_BUFFER_CAST (obj);
3080 timestamp = GST_BUFFER_TIMESTAMP (buf);
3082 GST_DEBUG_OBJECT (basesink, "preroll buffer %" GST_TIME_FORMAT,
3083 GST_TIME_ARGS (timestamp));
3086 * For buffer lists do not set last buffer. Creating buffer
3087 * with meaningful data can be done only with memcpy which will
3088 * significantly affect performance
3090 if (!OBJ_IS_BUFFERLIST (obj_type)) {
3091 gst_base_sink_set_last_buffer (basesink, buf);
3094 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3095 if (bclass->preroll)
3096 if ((ret = bclass->preroll (basesink, buf)) != GST_FLOW_OK)
3097 goto preroll_failed;
3099 basesink->priv->call_preroll = FALSE;
3103 if (G_LIKELY (basesink->playing_async)) {
3104 if (G_UNLIKELY (!gst_base_sink_commit_state (basesink)))
3113 GST_DEBUG_OBJECT (basesink, "preroll failed, abort state");
3114 gst_element_abort_state (GST_ELEMENT_CAST (basesink));
3119 GST_DEBUG_OBJECT (basesink, "stopping while commiting state");
3120 return GST_FLOW_WRONG_STATE;
3124 /* with STREAM_LOCK, PREROLL_LOCK
3126 * Queue an object for rendering.
3127 * The first prerollable object queued will complete the preroll. If the
3128 * preroll queue is filled, we render all the objects in the queue.
3130 * This function takes ownership of the object.
3132 static GstFlowReturn
3133 gst_base_sink_queue_object_unlocked (GstBaseSink * basesink, GstPad * pad,
3134 guint8 obj_type, gpointer obj, gboolean prerollable)
3136 GstFlowReturn ret = GST_FLOW_OK;
3140 if (G_UNLIKELY (basesink->need_preroll)) {
3141 if (G_LIKELY (prerollable))
3142 basesink->preroll_queued++;
3144 length = basesink->preroll_queued;
3146 GST_DEBUG_OBJECT (basesink, "now %d prerolled items", length);
3148 /* first prerollable item needs to finish the preroll */
3150 ret = gst_base_sink_preroll_object (basesink, obj_type, obj);
3151 if (G_UNLIKELY (ret != GST_FLOW_OK))
3152 goto preroll_failed;
3154 /* need to recheck if we need preroll, commmit state during preroll
3155 * could have made us not need more preroll. */
3156 if (G_UNLIKELY (basesink->need_preroll)) {
3157 /* see if we can render now, if we can't add the object to the preroll
3159 if (G_UNLIKELY (length <= basesink->preroll_queue_max_len))
3163 /* we can start rendering (or blocking) the queued object
3165 q = basesink->preroll_queue;
3166 while (G_UNLIKELY (!g_queue_is_empty (q))) {
3170 o = g_queue_pop_head (q);
3171 GST_DEBUG_OBJECT (basesink, "rendering queued object %p", o);
3173 ot = get_object_type (o);
3175 /* do something with the return value */
3176 ret = gst_base_sink_render_object (basesink, pad, ot, o);
3177 if (ret != GST_FLOW_OK)
3178 goto dequeue_failed;
3181 /* now render the object */
3182 ret = gst_base_sink_render_object (basesink, pad, obj_type, obj);
3183 basesink->preroll_queued = 0;
3190 GST_DEBUG_OBJECT (basesink, "preroll failed, reason %s",
3191 gst_flow_get_name (ret));
3192 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3197 /* add object to the queue and return */
3198 GST_DEBUG_OBJECT (basesink, "need more preroll data %d <= %d",
3199 length, basesink->preroll_queue_max_len);
3200 g_queue_push_tail (basesink->preroll_queue, obj);
3205 GST_DEBUG_OBJECT (basesink, "rendering queued objects failed, reason %s",
3206 gst_flow_get_name (ret));
3207 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3214 * This function grabs the PREROLL_LOCK and adds the object to
3217 * This function takes ownership of obj.
3219 * Note: Only GstEvent seem to be passed to this private method
3221 static GstFlowReturn
3222 gst_base_sink_queue_object (GstBaseSink * basesink, GstPad * pad,
3223 GstMiniObject * obj, gboolean prerollable)
3227 GST_BASE_SINK_PREROLL_LOCK (basesink);
3228 if (G_UNLIKELY (basesink->flushing))
3231 if (G_UNLIKELY (basesink->priv->received_eos))
3235 gst_base_sink_queue_object_unlocked (basesink, pad, _PR_IS_EVENT, obj,
3237 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3244 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3245 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3246 gst_mini_object_unref (obj);
3247 return GST_FLOW_WRONG_STATE;
3251 GST_DEBUG_OBJECT (basesink,
3252 "we are EOS, dropping object, return UNEXPECTED");
3253 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3254 gst_mini_object_unref (obj);
3255 return GST_FLOW_UNEXPECTED;
3260 gst_base_sink_flush_start (GstBaseSink * basesink, GstPad * pad)
3262 /* make sure we are not blocked on the clock also clear any pending
3264 gst_base_sink_set_flushing (basesink, pad, TRUE);
3266 /* we grab the stream lock but that is not needed since setting the
3267 * sink to flushing would make sure no state commit is being done
3269 GST_PAD_STREAM_LOCK (pad);
3270 gst_base_sink_reset_qos (basesink);
3271 /* and we need to commit our state again on the next
3272 * prerolled buffer */
3273 basesink->playing_async = TRUE;
3274 if (basesink->priv->async_enabled) {
3275 gst_element_lost_state (GST_ELEMENT_CAST (basesink));
3277 basesink->priv->have_latency = TRUE;
3279 gst_base_sink_set_last_buffer (basesink, NULL);
3280 GST_PAD_STREAM_UNLOCK (pad);
3284 gst_base_sink_flush_stop (GstBaseSink * basesink, GstPad * pad,
3285 gboolean reset_time)
3287 /* unset flushing so we can accept new data, this also flushes out any EOS
3289 gst_base_sink_set_flushing (basesink, pad, FALSE);
3291 /* for position reporting */
3292 GST_OBJECT_LOCK (basesink);
3293 basesink->priv->current_sstart = GST_CLOCK_TIME_NONE;
3294 basesink->priv->current_sstop = GST_CLOCK_TIME_NONE;
3295 basesink->priv->eos_rtime = GST_CLOCK_TIME_NONE;
3296 basesink->priv->call_preroll = TRUE;
3297 basesink->priv->current_step.valid = FALSE;
3298 basesink->priv->pending_step.valid = FALSE;
3299 if (basesink->pad_mode == GST_ACTIVATE_PUSH) {
3300 /* we need new segment info after the flush. */
3301 basesink->have_newsegment = FALSE;
3303 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
3304 gst_segment_init (&basesink->clip_segment, GST_FORMAT_UNDEFINED);
3307 basesink->priv->reset_time = reset_time;
3308 GST_OBJECT_UNLOCK (basesink);
3312 gst_base_sink_event (GstPad * pad, GstEvent * event)
3314 GstBaseSink *basesink;
3315 gboolean result = TRUE;
3316 GstBaseSinkClass *bclass;
3318 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3319 if (G_UNLIKELY (basesink == NULL)) {
3320 gst_event_unref (event);
3324 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3326 GST_DEBUG_OBJECT (basesink, "received event %p %" GST_PTR_FORMAT, event,
3329 switch (GST_EVENT_TYPE (event)) {
3334 GST_BASE_SINK_PREROLL_LOCK (basesink);
3335 if (G_UNLIKELY (basesink->flushing))
3338 if (G_UNLIKELY (basesink->priv->received_eos))
3341 /* we set the received EOS flag here so that we can use it when testing if
3342 * we are prerolled and to refuse more buffers. */
3343 basesink->priv->received_eos = TRUE;
3345 /* EOS is a prerollable object, we call the unlocked version because it
3346 * does not check the received_eos flag. */
3347 ret = gst_base_sink_queue_object_unlocked (basesink, pad,
3348 _PR_IS_EVENT, GST_MINI_OBJECT_CAST (event), TRUE);
3349 if (G_UNLIKELY (ret != GST_FLOW_OK))
3352 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3355 case GST_EVENT_CAPS:
3359 GST_DEBUG_OBJECT (basesink, "caps %p", event);
3361 gst_event_parse_caps (event, &caps);
3362 if (bclass->set_caps)
3363 result = bclass->set_caps (basesink, caps);
3365 gst_event_unref (event);
3368 case GST_EVENT_SEGMENT:
3372 GST_DEBUG_OBJECT (basesink, "segment %p", event);
3374 GST_BASE_SINK_PREROLL_LOCK (basesink);
3375 if (G_UNLIKELY (basesink->flushing))
3378 if (G_UNLIKELY (basesink->priv->received_eos))
3381 /* the new segment is a non prerollable item and does not block anything,
3382 * we need to configure the current clipping segment and insert the event
3383 * in the queue to serialize it with the buffers for rendering. */
3384 gst_base_sink_configure_segment (basesink, pad, event,
3385 &basesink->clip_segment);
3388 gst_base_sink_queue_object_unlocked (basesink, pad,
3389 _PR_IS_EVENT, GST_MINI_OBJECT_CAST (event), FALSE);
3390 if (G_UNLIKELY (ret != GST_FLOW_OK))
3393 GST_OBJECT_LOCK (basesink);
3394 basesink->have_newsegment = TRUE;
3395 GST_OBJECT_UNLOCK (basesink);
3397 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3400 case GST_EVENT_FLUSH_START:
3402 bclass->event (basesink, event);
3404 GST_DEBUG_OBJECT (basesink, "flush-start %p", event);
3406 gst_base_sink_flush_start (basesink, pad);
3408 gst_event_unref (event);
3410 case GST_EVENT_FLUSH_STOP:
3412 gboolean reset_time;
3415 bclass->event (basesink, event);
3417 gst_event_parse_flush_stop (event, &reset_time);
3418 GST_DEBUG_OBJECT (basesink, "flush-stop %p, reset_time: %d", event,
3421 gst_base_sink_flush_stop (basesink, pad, reset_time);
3423 gst_event_unref (event);
3427 /* other events are sent to queue or subclass depending on if they
3428 * are serialized. */
3429 if (GST_EVENT_IS_SERIALIZED (event)) {
3430 gst_base_sink_queue_object (basesink, pad,
3431 GST_MINI_OBJECT_CAST (event), FALSE);
3434 bclass->event (basesink, event);
3435 gst_event_unref (event);
3440 gst_object_unref (basesink);
3447 GST_DEBUG_OBJECT (basesink, "we are flushing");
3448 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3450 gst_event_unref (event);
3456 GST_DEBUG_OBJECT (basesink, "Event received after EOS, dropping");
3457 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3459 gst_event_unref (event);
3464 /* default implementation to calculate the start and end
3465 * timestamps on a buffer, subclasses can override
3468 gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
3469 GstClockTime * start, GstClockTime * end)
3471 GstClockTime timestamp, duration;
3473 timestamp = GST_BUFFER_TIMESTAMP (buffer);
3474 if (GST_CLOCK_TIME_IS_VALID (timestamp)) {
3476 /* get duration to calculate end time */
3477 duration = GST_BUFFER_DURATION (buffer);
3478 if (GST_CLOCK_TIME_IS_VALID (duration)) {
3479 *end = timestamp + duration;
3485 /* must be called with PREROLL_LOCK */
3487 gst_base_sink_needs_preroll (GstBaseSink * basesink)
3489 gboolean is_prerolled, res;
3491 /* we have 2 cases where the PREROLL_LOCK is released:
3492 * 1) we are blocking in the PREROLL_LOCK and thus are prerolled.
3493 * 2) we are syncing on the clock
3495 is_prerolled = basesink->have_preroll || basesink->priv->received_eos;
3496 res = !is_prerolled;
3498 GST_DEBUG_OBJECT (basesink, "have_preroll: %d, EOS: %d => needs preroll: %d",
3499 basesink->have_preroll, basesink->priv->received_eos, res);
3504 /* with STREAM_LOCK, PREROLL_LOCK
3506 * Takes a buffer and compare the timestamps with the last segment.
3507 * If the buffer falls outside of the segment boundaries, drop it.
3508 * Else queue the buffer for preroll and rendering.
3510 * This function takes ownership of the buffer.
3512 static GstFlowReturn
3513 gst_base_sink_chain_unlocked (GstBaseSink * basesink, GstPad * pad,
3514 guint8 obj_type, gpointer obj)
3516 GstBaseSinkClass *bclass;
3517 GstFlowReturn result;
3518 GstClockTime start = GST_CLOCK_TIME_NONE, end = GST_CLOCK_TIME_NONE;
3519 GstSegment *clip_segment;
3520 GstBuffer *time_buf;
3522 if (G_UNLIKELY (basesink->flushing))
3525 if (G_UNLIKELY (basesink->priv->received_eos))
3528 if (OBJ_IS_BUFFERLIST (obj_type)) {
3529 time_buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0);
3530 g_assert (NULL != time_buf);
3532 time_buf = GST_BUFFER_CAST (obj);
3535 /* for code clarity */
3536 clip_segment = &basesink->clip_segment;
3538 if (G_UNLIKELY (!basesink->have_newsegment)) {
3541 sync = gst_base_sink_get_sync (basesink);
3543 GST_ELEMENT_WARNING (basesink, STREAM, FAILED,
3544 (_("Internal data flow problem.")),
3545 ("Received buffer without a new-segment. Assuming timestamps start from 0."));
3548 /* this means this sink will assume timestamps start from 0 */
3549 GST_OBJECT_LOCK (basesink);
3550 clip_segment->start = 0;
3551 clip_segment->stop = -1;
3552 basesink->segment.start = 0;
3553 basesink->segment.stop = -1;
3554 basesink->have_newsegment = TRUE;
3555 GST_OBJECT_UNLOCK (basesink);
3558 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3560 /* check if the buffer needs to be dropped, we first ask the subclass for the
3562 if (bclass->get_times)
3563 bclass->get_times (basesink, time_buf, &start, &end);
3565 if (!GST_CLOCK_TIME_IS_VALID (start)) {
3566 /* if the subclass does not want sync, we use our own values so that we at
3567 * least clip the buffer to the segment */
3568 gst_base_sink_get_times (basesink, time_buf, &start, &end);
3571 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
3572 ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (end));
3574 /* a dropped buffer does not participate in anything */
3575 if (GST_CLOCK_TIME_IS_VALID (start) &&
3576 (clip_segment->format == GST_FORMAT_TIME)) {
3577 if (G_UNLIKELY (!gst_segment_clip (clip_segment,
3578 GST_FORMAT_TIME, start, end, NULL, NULL)))
3579 goto out_of_segment;
3582 /* now we can process the buffer in the queue, this function takes ownership
3584 result = gst_base_sink_queue_object_unlocked (basesink, pad,
3585 obj_type, obj, TRUE);
3591 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3592 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3593 return GST_FLOW_WRONG_STATE;
3597 GST_DEBUG_OBJECT (basesink,
3598 "we are EOS, dropping object, return UNEXPECTED");
3599 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3600 return GST_FLOW_UNEXPECTED;
3604 GST_DEBUG_OBJECT (basesink, "dropping buffer, out of clipping segment");
3605 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3612 static GstFlowReturn
3613 gst_base_sink_chain_main (GstBaseSink * basesink, GstPad * pad,
3614 guint8 obj_type, gpointer obj)
3616 GstFlowReturn result;
3618 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH))
3621 GST_BASE_SINK_PREROLL_LOCK (basesink);
3622 result = gst_base_sink_chain_unlocked (basesink, pad, obj_type, obj);
3623 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3631 GST_OBJECT_LOCK (pad);
3632 GST_WARNING_OBJECT (basesink,
3633 "Push on pad %s:%s, but it was not activated in push mode",
3634 GST_DEBUG_PAD_NAME (pad));
3635 GST_OBJECT_UNLOCK (pad);
3636 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3637 /* we don't post an error message this will signal to the peer
3638 * pushing that EOS is reached. */
3639 result = GST_FLOW_UNEXPECTED;
3644 static GstFlowReturn
3645 gst_base_sink_chain (GstPad * pad, GstBuffer * buf)
3647 GstBaseSink *basesink;
3649 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3651 return gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFER, buf);
3654 static GstFlowReturn
3655 gst_base_sink_chain_list (GstPad * pad, GstBufferList * list)
3657 GstBaseSink *basesink;
3658 GstBaseSinkClass *bclass;
3659 GstFlowReturn result;
3661 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3662 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3664 if (G_LIKELY (bclass->render_list)) {
3665 result = gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFERLIST, list);
3670 GST_INFO_OBJECT (pad, "chaining each group in list as a merged buffer");
3672 len = gst_buffer_list_len (list);
3674 result = GST_FLOW_OK;
3675 for (i = 0; i < len; i++) {
3676 buffer = gst_buffer_list_get (list, 0);
3677 result = gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFER,
3678 gst_buffer_ref (buffer));
3679 if (result != GST_FLOW_OK)
3682 gst_buffer_list_unref (list);
3689 gst_base_sink_default_do_seek (GstBaseSink * sink, GstSegment * segment)
3691 gboolean res = TRUE;
3693 /* update our offset if the start/stop position was updated */
3694 if (segment->format == GST_FORMAT_BYTES) {
3695 segment->time = segment->start;
3696 } else if (segment->start == 0) {
3697 /* seek to start, we can implement a default for this. */
3701 GST_INFO_OBJECT (sink, "Can't do a default seek");
3707 #define SEEK_TYPE_IS_RELATIVE(t) (((t) != GST_SEEK_TYPE_NONE) && ((t) != GST_SEEK_TYPE_SET))
3710 gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
3711 GstEvent * event, GstSegment * segment)
3713 /* By default, we try one of 2 things:
3714 * - For absolute seek positions, convert the requested position to our
3715 * configured processing format and place it in the output segment \
3716 * - For relative seek positions, convert our current (input) values to the
3717 * seek format, adjust by the relative seek offset and then convert back to
3718 * the processing format
3720 GstSeekType cur_type, stop_type;
3723 GstFormat seek_format, dest_format;
3726 gboolean res = TRUE;
3728 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3729 &cur_type, &cur, &stop_type, &stop);
3730 dest_format = segment->format;
3732 if (seek_format == dest_format) {
3733 gst_segment_do_seek (segment, rate, seek_format, flags,
3734 cur_type, cur, stop_type, stop, &update);
3738 if (cur_type != GST_SEEK_TYPE_NONE) {
3739 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3741 gst_pad_query_convert (sink->sinkpad, seek_format, cur, &dest_format,
3743 cur_type = GST_SEEK_TYPE_SET;
3746 if (res && stop_type != GST_SEEK_TYPE_NONE) {
3747 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3749 gst_pad_query_convert (sink->sinkpad, seek_format, stop, &dest_format,
3751 stop_type = GST_SEEK_TYPE_SET;
3754 /* And finally, configure our output segment in the desired format */
3755 gst_segment_do_seek (segment, rate, dest_format, flags, cur_type, cur,
3756 stop_type, stop, &update);
3765 GST_DEBUG_OBJECT (sink, "undefined format given, seek aborted.");
3770 /* perform a seek, only executed in pull mode */
3772 gst_base_sink_perform_seek (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3776 GstFormat seek_format, dest_format;
3778 GstSeekType cur_type, stop_type;
3779 gboolean seekseg_configured = FALSE;
3781 gboolean update, res = TRUE;
3782 GstSegment seeksegment;
3784 dest_format = sink->segment.format;
3787 GST_DEBUG_OBJECT (sink, "performing seek with event %p", event);
3788 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3789 &cur_type, &cur, &stop_type, &stop);
3791 flush = flags & GST_SEEK_FLAG_FLUSH;
3793 GST_DEBUG_OBJECT (sink, "performing seek without event");
3798 GST_DEBUG_OBJECT (sink, "flushing upstream");
3799 gst_pad_push_event (pad, gst_event_new_flush_start ());
3800 gst_base_sink_flush_start (sink, pad);
3802 GST_DEBUG_OBJECT (sink, "pausing pulling thread");
3805 GST_PAD_STREAM_LOCK (pad);
3807 /* If we configured the seeksegment above, don't overwrite it now. Otherwise
3808 * copy the current segment info into the temp segment that we can actually
3809 * attempt the seek with. We only update the real segment if the seek suceeds. */
3810 if (!seekseg_configured) {
3811 memcpy (&seeksegment, &sink->segment, sizeof (GstSegment));
3813 /* now configure the final seek segment */
3815 if (sink->segment.format != seek_format) {
3816 /* OK, here's where we give the subclass a chance to convert the relative
3817 * seek into an absolute one in the processing format. We set up any
3818 * absolute seek above, before taking the stream lock. */
3819 if (!gst_base_sink_default_prepare_seek_segment (sink, event,
3821 GST_DEBUG_OBJECT (sink,
3822 "Preparing the seek failed after flushing. " "Aborting seek");
3826 /* The seek format matches our processing format, no need to ask the
3827 * the subclass to configure the segment. */
3828 gst_segment_do_seek (&seeksegment, rate, seek_format, flags,
3829 cur_type, cur, stop_type, stop, &update);
3832 /* Else, no seek event passed, so we're just (re)starting the
3837 GST_DEBUG_OBJECT (sink, "segment configured from %" G_GINT64_FORMAT
3838 " to %" G_GINT64_FORMAT ", position %" G_GINT64_FORMAT,
3839 seeksegment.start, seeksegment.stop, seeksegment.position);
3841 /* do the seek, segment.position contains the new position. */
3842 res = gst_base_sink_default_do_seek (sink, &seeksegment);
3847 GST_DEBUG_OBJECT (sink, "stop flushing upstream");
3848 gst_pad_push_event (pad, gst_event_new_flush_stop (TRUE));
3849 gst_base_sink_flush_stop (sink, pad, TRUE);
3850 } else if (res && sink->running) {
3851 /* we are running the current segment and doing a non-flushing seek,
3852 * close the segment first based on the position. */
3853 GST_DEBUG_OBJECT (sink, "closing running segment %" G_GINT64_FORMAT
3854 " to %" G_GINT64_FORMAT, sink->segment.start, sink->segment.position);
3857 /* The subclass must have converted the segment to the processing format
3859 if (res && seeksegment.format != dest_format) {
3860 GST_DEBUG_OBJECT (sink, "Subclass failed to prepare a seek segment "
3861 "in the correct format. Aborting seek.");
3865 /* if successfull seek, we update our real segment and push
3866 * out the new segment. */
3868 gst_segment_copy_into (&seeksegment, &sink->segment);
3870 if (sink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3871 gst_element_post_message (GST_ELEMENT (sink),
3872 gst_message_new_segment_start (GST_OBJECT (sink),
3873 sink->segment.format, sink->segment.position));
3877 sink->priv->discont = TRUE;
3878 sink->running = TRUE;
3880 GST_PAD_STREAM_UNLOCK (pad);
3886 set_step_info (GstBaseSink * sink, GstStepInfo * current, GstStepInfo * pending,
3887 guint seqnum, GstFormat format, guint64 amount, gdouble rate,
3888 gboolean flush, gboolean intermediate)
3890 GST_OBJECT_LOCK (sink);
3891 pending->seqnum = seqnum;
3892 pending->format = format;
3893 pending->amount = amount;
3894 pending->position = 0;
3895 pending->rate = rate;
3896 pending->flush = flush;
3897 pending->intermediate = intermediate;
3898 pending->valid = TRUE;
3899 /* flush invalidates the current stepping segment */
3901 current->valid = FALSE;
3902 GST_OBJECT_UNLOCK (sink);
3906 gst_base_sink_perform_step (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3908 GstBaseSinkPrivate *priv;
3909 GstBaseSinkClass *bclass;
3910 gboolean flush, intermediate;
3915 GstStepInfo *pending, *current;
3916 GstMessage *message;
3918 bclass = GST_BASE_SINK_GET_CLASS (sink);
3921 GST_DEBUG_OBJECT (sink, "performing step with event %p", event);
3923 gst_event_parse_step (event, &format, &amount, &rate, &flush, &intermediate);
3924 seqnum = gst_event_get_seqnum (event);
3926 pending = &priv->pending_step;
3927 current = &priv->current_step;
3929 /* post message first */
3930 message = gst_message_new_step_start (GST_OBJECT (sink), FALSE, format,
3931 amount, rate, flush, intermediate);
3932 gst_message_set_seqnum (message, seqnum);
3933 gst_element_post_message (GST_ELEMENT (sink), message);
3936 /* we need to call ::unlock before locking PREROLL_LOCK
3937 * since we lock it before going into ::render */
3939 bclass->unlock (sink);
3941 GST_BASE_SINK_PREROLL_LOCK (sink);
3942 /* now that we have the PREROLL lock, clear our unlock request */
3943 if (bclass->unlock_stop)
3944 bclass->unlock_stop (sink);
3946 /* update the stepinfo and make it valid */
3947 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3950 if (sink->priv->async_enabled) {
3951 /* and we need to commit our state again on the next
3952 * prerolled buffer */
3953 sink->playing_async = TRUE;
3954 priv->pending_step.need_preroll = TRUE;
3955 sink->need_preroll = FALSE;
3956 gst_element_lost_state (GST_ELEMENT_CAST (sink));
3958 sink->priv->have_latency = TRUE;
3959 sink->need_preroll = FALSE;
3961 priv->current_sstart = GST_CLOCK_TIME_NONE;
3962 priv->current_sstop = GST_CLOCK_TIME_NONE;
3963 priv->eos_rtime = GST_CLOCK_TIME_NONE;
3964 priv->call_preroll = TRUE;
3965 gst_base_sink_set_last_buffer (sink, NULL);
3966 gst_base_sink_reset_qos (sink);
3968 if (sink->clock_id) {
3969 gst_clock_id_unschedule (sink->clock_id);
3972 if (sink->have_preroll) {
3973 GST_DEBUG_OBJECT (sink, "signal waiter");
3974 priv->step_unlock = TRUE;
3975 GST_BASE_SINK_PREROLL_SIGNAL (sink);
3977 GST_BASE_SINK_PREROLL_UNLOCK (sink);
3979 /* update the stepinfo and make it valid */
3980 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3990 gst_base_sink_loop (GstPad * pad)
3992 GstBaseSink *basesink;
3993 GstBuffer *buf = NULL;
3994 GstFlowReturn result;
3998 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
4000 g_assert (basesink->pad_mode == GST_ACTIVATE_PULL);
4002 if ((blocksize = basesink->priv->blocksize) == 0)
4005 offset = basesink->segment.position;
4007 GST_DEBUG_OBJECT (basesink, "pulling %" G_GUINT64_FORMAT ", %u",
4010 result = gst_pad_pull_range (pad, offset, blocksize, &buf);
4011 if (G_UNLIKELY (result != GST_FLOW_OK))
4014 if (G_UNLIKELY (buf == NULL))
4017 offset += gst_buffer_get_size (buf);
4019 basesink->segment.position = offset;
4021 GST_BASE_SINK_PREROLL_LOCK (basesink);
4022 result = gst_base_sink_chain_unlocked (basesink, pad, _PR_IS_BUFFER, buf);
4023 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4024 if (G_UNLIKELY (result != GST_FLOW_OK))
4032 GST_LOG_OBJECT (basesink, "pausing task, reason %s",
4033 gst_flow_get_name (result));
4034 gst_pad_pause_task (pad);
4035 if (result == GST_FLOW_UNEXPECTED) {
4036 /* perform EOS logic */
4037 if (basesink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
4038 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4039 gst_message_new_segment_done (GST_OBJECT_CAST (basesink),
4040 basesink->segment.format, basesink->segment.position));
4042 gst_base_sink_event (pad, gst_event_new_eos ());
4044 } else if (result == GST_FLOW_NOT_LINKED || result <= GST_FLOW_UNEXPECTED) {
4045 /* for fatal errors we post an error message, post the error
4046 * first so the app knows about the error first.
4047 * wrong-state is not a fatal error because it happens due to
4048 * flushing and posting an error message in that case is the
4049 * wrong thing to do, e.g. when basesrc is doing a flushing
4051 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
4052 (_("Internal data stream error.")),
4053 ("stream stopped, reason %s", gst_flow_get_name (result)));
4054 gst_base_sink_event (pad, gst_event_new_eos ());
4060 GST_LOG_OBJECT (basesink, "no buffer, pausing");
4061 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
4062 (_("Internal data flow error.")), ("element returned NULL buffer"));
4063 result = GST_FLOW_ERROR;
4069 gst_base_sink_set_flushing (GstBaseSink * basesink, GstPad * pad,
4072 GstBaseSinkClass *bclass;
4074 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4077 /* unlock any subclasses, we need to do this before grabbing the
4078 * PREROLL_LOCK since we hold this lock before going into ::render. */
4080 bclass->unlock (basesink);
4083 GST_BASE_SINK_PREROLL_LOCK (basesink);
4084 basesink->flushing = flushing;
4086 /* step 1, now that we have the PREROLL lock, clear our unlock request */
4087 if (bclass->unlock_stop)
4088 bclass->unlock_stop (basesink);
4090 /* set need_preroll before we unblock the clock. If the clock is unblocked
4091 * before timing out, we can reuse the buffer for preroll. */
4092 basesink->need_preroll = TRUE;
4094 /* step 2, unblock clock sync (if any) or any other blocking thing */
4095 if (basesink->clock_id) {
4096 gst_clock_id_unschedule (basesink->clock_id);
4099 /* flush out the data thread if it's locked in finish_preroll, this will
4100 * also flush out the EOS state */
4101 GST_DEBUG_OBJECT (basesink,
4102 "flushing out data thread, need preroll to TRUE");
4103 gst_base_sink_preroll_queue_flush (basesink, pad);
4105 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4111 gst_base_sink_default_activate_pull (GstBaseSink * basesink, gboolean active)
4117 result = gst_pad_start_task (basesink->sinkpad,
4118 (GstTaskFunction) gst_base_sink_loop, basesink->sinkpad);
4120 /* step 2, make sure streaming finishes */
4121 result = gst_pad_stop_task (basesink->sinkpad);
4128 gst_base_sink_pad_activate (GstPad * pad)
4130 gboolean result = FALSE;
4131 GstBaseSink *basesink;
4135 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4137 GST_DEBUG_OBJECT (basesink, "Trying pull mode first");
4139 gst_base_sink_set_flushing (basesink, pad, FALSE);
4141 /* we need to have the pull mode enabled */
4142 if (!basesink->can_activate_pull) {
4143 GST_DEBUG_OBJECT (basesink, "pull mode disabled");
4147 /* check if downstreams supports pull mode at all */
4148 query = gst_query_new_scheduling ();
4150 if (!gst_pad_peer_query (pad, query)) {
4151 gst_query_unref (query);
4152 GST_DEBUG_OBJECT (basesink, "peer query faild, no pull mode");
4156 /* parse result of the query */
4157 gst_query_parse_scheduling (query, &pull_mode, NULL, NULL, NULL, NULL, NULL);
4158 gst_query_unref (query);
4161 GST_DEBUG_OBJECT (basesink, "pull mode not supported");
4165 /* set the pad mode before starting the task so that it's in the
4166 * correct state for the new thread. also the sink set_caps and get_caps
4167 * function checks this */
4168 basesink->pad_mode = GST_ACTIVATE_PULL;
4170 /* we first try to negotiate a format so that when we try to activate
4171 * downstream, it knows about our format */
4172 if (!gst_base_sink_negotiate_pull (basesink)) {
4173 GST_DEBUG_OBJECT (basesink, "failed to negotiate in pull mode");
4177 /* ok activate now */
4178 if (!gst_pad_activate_pull (pad, TRUE)) {
4179 /* clear any pending caps */
4180 GST_OBJECT_LOCK (basesink);
4181 gst_caps_replace (&basesink->priv->pull_caps, NULL);
4182 GST_OBJECT_UNLOCK (basesink);
4183 GST_DEBUG_OBJECT (basesink, "failed to activate in pull mode");
4187 GST_DEBUG_OBJECT (basesink, "Success activating pull mode");
4191 /* push mode fallback */
4193 GST_DEBUG_OBJECT (basesink, "Falling back to push mode");
4194 if ((result = gst_pad_activate_push (pad, TRUE))) {
4195 GST_DEBUG_OBJECT (basesink, "Success activating push mode");
4200 GST_WARNING_OBJECT (basesink, "Could not activate pad in either mode");
4201 gst_base_sink_set_flushing (basesink, pad, TRUE);
4204 gst_object_unref (basesink);
4210 gst_base_sink_pad_activate_push (GstPad * pad, gboolean active)
4213 GstBaseSink *basesink;
4215 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4218 if (!basesink->can_activate_push) {
4220 basesink->pad_mode = GST_ACTIVATE_NONE;
4223 basesink->pad_mode = GST_ACTIVATE_PUSH;
4226 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH)) {
4227 g_warning ("Internal GStreamer activation error!!!");
4230 gst_base_sink_set_flushing (basesink, pad, TRUE);
4232 basesink->pad_mode = GST_ACTIVATE_NONE;
4236 gst_object_unref (basesink);
4242 gst_base_sink_negotiate_pull (GstBaseSink * basesink)
4249 /* this returns the intersection between our caps and the peer caps. If there
4250 * is no peer, it returns NULL and we can't operate in pull mode so we can
4251 * fail the negotiation. */
4252 caps = gst_pad_get_allowed_caps (GST_BASE_SINK_PAD (basesink));
4253 if (caps == NULL || gst_caps_is_empty (caps))
4254 goto no_caps_possible;
4256 GST_DEBUG_OBJECT (basesink, "allowed caps: %" GST_PTR_FORMAT, caps);
4258 caps = gst_caps_make_writable (caps);
4259 /* get the first (prefered) format */
4260 gst_caps_truncate (caps);
4262 GST_DEBUG_OBJECT (basesink, "have caps: %" GST_PTR_FORMAT, caps);
4264 if (gst_caps_is_any (caps)) {
4265 GST_DEBUG_OBJECT (basesink, "caps were ANY after fixating, "
4267 /* neither side has template caps in this case, so they are prepared for
4268 pull() without setcaps() */
4272 gst_pad_fixate_caps (GST_BASE_SINK_PAD (basesink), caps);
4273 GST_DEBUG_OBJECT (basesink, "fixated to: %" GST_PTR_FORMAT, caps);
4275 if (gst_caps_is_fixed (caps)) {
4276 if (!gst_pad_send_event (GST_BASE_SINK_PAD (basesink),
4277 gst_event_new_caps (caps)))
4278 goto could_not_set_caps;
4280 GST_OBJECT_LOCK (basesink);
4281 gst_caps_replace (&basesink->priv->pull_caps, caps);
4282 GST_OBJECT_UNLOCK (basesink);
4288 gst_caps_unref (caps);
4294 GST_INFO_OBJECT (basesink, "Pipeline could not agree on caps");
4295 GST_DEBUG_OBJECT (basesink, "get_allowed_caps() returned EMPTY");
4297 gst_caps_unref (caps);
4302 GST_INFO_OBJECT (basesink, "Could not set caps: %" GST_PTR_FORMAT, caps);
4303 gst_caps_unref (caps);
4308 /* this won't get called until we implement an activate function */
4310 gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active)
4312 gboolean result = FALSE;
4313 GstBaseSink *basesink;
4314 GstBaseSinkClass *bclass;
4316 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4317 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4323 /* we mark we have a newsegment here because pull based
4324 * mode works just fine without having a newsegment before the
4326 format = GST_FORMAT_BYTES;
4328 gst_segment_init (&basesink->segment, format);
4329 gst_segment_init (&basesink->clip_segment, format);
4330 GST_OBJECT_LOCK (basesink);
4331 basesink->have_newsegment = TRUE;
4332 GST_OBJECT_UNLOCK (basesink);
4334 /* get the peer duration in bytes */
4335 result = gst_pad_query_peer_duration (pad, &format, &duration);
4337 GST_DEBUG_OBJECT (basesink,
4338 "setting duration in bytes to %" G_GINT64_FORMAT, duration);
4339 basesink->clip_segment.duration = duration;
4340 basesink->segment.duration = duration;
4342 GST_DEBUG_OBJECT (basesink, "unknown duration");
4345 if (bclass->activate_pull)
4346 result = bclass->activate_pull (basesink, TRUE);
4351 goto activate_failed;
4354 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PULL)) {
4355 g_warning ("Internal GStreamer activation error!!!");
4358 result = gst_base_sink_set_flushing (basesink, pad, TRUE);
4359 if (bclass->activate_pull)
4360 result &= bclass->activate_pull (basesink, FALSE);
4361 basesink->pad_mode = GST_ACTIVATE_NONE;
4362 /* clear any pending caps */
4363 GST_OBJECT_LOCK (basesink);
4364 gst_caps_replace (&basesink->priv->pull_caps, NULL);
4365 GST_OBJECT_UNLOCK (basesink);
4368 gst_object_unref (basesink);
4375 /* reset, as starting the thread failed */
4376 basesink->pad_mode = GST_ACTIVATE_NONE;
4378 GST_ERROR_OBJECT (basesink, "subclass failed to activate in pull mode");
4383 /* send an event to our sinkpad peer. */
4385 gst_base_sink_send_event (GstElement * element, GstEvent * event)
4388 GstBaseSink *basesink = GST_BASE_SINK (element);
4389 gboolean forward, result = TRUE;
4390 GstActivateMode mode;
4392 GST_OBJECT_LOCK (element);
4393 /* get the pad and the scheduling mode */
4394 pad = gst_object_ref (basesink->sinkpad);
4395 mode = basesink->pad_mode;
4396 GST_OBJECT_UNLOCK (element);
4398 /* only push UPSTREAM events upstream */
4399 forward = GST_EVENT_IS_UPSTREAM (event);
4401 GST_DEBUG_OBJECT (basesink, "handling event %p %" GST_PTR_FORMAT, event,
4404 switch (GST_EVENT_TYPE (event)) {
4405 case GST_EVENT_LATENCY:
4407 GstClockTime latency;
4409 gst_event_parse_latency (event, &latency);
4411 /* store the latency. We use this to adjust the running_time before syncing
4412 * it to the clock. */
4413 GST_OBJECT_LOCK (element);
4414 basesink->priv->latency = latency;
4415 if (!basesink->priv->have_latency)
4417 GST_OBJECT_UNLOCK (element);
4418 GST_DEBUG_OBJECT (basesink, "latency set to %" GST_TIME_FORMAT,
4419 GST_TIME_ARGS (latency));
4421 /* We forward this event so that all elements know about the global pipeline
4422 * latency. This is interesting for an element when it wants to figure out
4423 * when a particular piece of data will be rendered. */
4426 case GST_EVENT_SEEK:
4427 /* in pull mode we will execute the seek */
4428 if (mode == GST_ACTIVATE_PULL)
4429 result = gst_base_sink_perform_seek (basesink, pad, event);
4431 case GST_EVENT_STEP:
4432 result = gst_base_sink_perform_step (basesink, pad, event);
4440 result = gst_pad_push_event (pad, event);
4442 /* not forwarded, unref the event */
4443 gst_event_unref (event);
4446 gst_object_unref (pad);
4451 gst_base_sink_get_position (GstBaseSink * basesink, GstFormat format,
4452 gint64 * cur, gboolean * upstream)
4454 GstClock *clock = NULL;
4455 gboolean res = FALSE;
4456 GstFormat oformat, tformat;
4457 GstSegment *segment;
4458 GstClockTime now, latency;
4459 GstClockTimeDiff base_time;
4460 gint64 time, base, duration;
4463 gboolean last_seen, with_clock, in_paused;
4465 GST_OBJECT_LOCK (basesink);
4466 /* we can only get the segment when we are not NULL or READY */
4467 if (!basesink->have_newsegment)
4471 /* when not in PLAYING or when we're busy with a state change, we
4472 * cannot read from the clock so we report time based on the
4473 * last seen timestamp. */
4474 if (GST_STATE (basesink) != GST_STATE_PLAYING ||
4475 GST_STATE_PENDING (basesink) != GST_STATE_VOID_PENDING) {
4479 /* we don't use the clip segment in pull mode, when seeking we update the
4480 * main segment directly with the new segment values without it having to be
4481 * activated by the rendering after preroll */
4482 if (basesink->pad_mode == GST_ACTIVATE_PUSH)
4483 segment = &basesink->clip_segment;
4485 segment = &basesink->segment;
4487 /* our intermediate time format */
4488 tformat = GST_FORMAT_TIME;
4489 /* get the format in the segment */
4490 oformat = segment->format;
4492 /* report with last seen position when EOS */
4493 last_seen = basesink->eos;
4495 /* assume we will use the clock for getting the current position */
4497 if (basesink->sync == FALSE)
4500 /* and we need a clock */
4501 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (basesink)) == NULL))
4504 gst_object_ref (clock);
4506 /* collect all data we need holding the lock */
4507 if (GST_CLOCK_TIME_IS_VALID (segment->time))
4508 time = segment->time;
4512 if (GST_CLOCK_TIME_IS_VALID (segment->stop))
4513 duration = segment->stop - segment->start;
4517 base = segment->base;
4518 rate = segment->rate * segment->applied_rate;
4519 latency = basesink->priv->latency;
4521 if (oformat == GST_FORMAT_TIME) {
4524 start = basesink->priv->current_sstart;
4525 stop = basesink->priv->current_sstop;
4528 /* in paused we use the last position as a lower bound */
4529 if (stop == -1 || segment->rate > 0.0)
4534 /* in playing, use last stop time as upper bound */
4535 if (start == -1 || segment->rate > 0.0)
4541 /* convert last stop to stream time */
4542 last = gst_segment_to_stream_time (segment, oformat, segment->position);
4546 /* in paused, use start_time */
4547 base_time = GST_ELEMENT_START_TIME (basesink);
4548 GST_DEBUG_OBJECT (basesink, "in paused, using start time %" GST_TIME_FORMAT,
4549 GST_TIME_ARGS (base_time));
4550 } else if (with_clock) {
4551 /* else use clock when needed */
4552 base_time = GST_ELEMENT_CAST (basesink)->base_time;
4553 GST_DEBUG_OBJECT (basesink, "using clock and base time %" GST_TIME_FORMAT,
4554 GST_TIME_ARGS (base_time));
4556 /* else, no sync or clock -> no base time */
4557 GST_DEBUG_OBJECT (basesink, "no sync or no clock");
4561 /* no base_time, we can't calculate running_time, use last seem timestamp to report
4563 if (base_time == -1)
4566 /* need to release the object lock before we can get the time,
4567 * a clock might take the LOCK of the provider, which could be
4568 * a basesink subclass. */
4569 GST_OBJECT_UNLOCK (basesink);
4572 /* in EOS or when no valid stream_time, report the value of last seen
4575 /* no timestamp, we need to ask upstream */
4576 GST_DEBUG_OBJECT (basesink, "no last seen timestamp, asking upstream");
4581 GST_DEBUG_OBJECT (basesink, "using last seen timestamp %" GST_TIME_FORMAT,
4582 GST_TIME_ARGS (last));
4585 if (oformat != tformat) {
4586 /* convert base, time and duration to time */
4587 if (!gst_pad_query_convert (basesink->sinkpad, oformat, base, &tformat,
4589 goto convert_failed;
4590 if (!gst_pad_query_convert (basesink->sinkpad, oformat, duration,
4591 &tformat, &duration))
4592 goto convert_failed;
4593 if (!gst_pad_query_convert (basesink->sinkpad, oformat, time, &tformat,
4595 goto convert_failed;
4596 if (!gst_pad_query_convert (basesink->sinkpad, oformat, last, &tformat,
4598 goto convert_failed;
4600 /* assume time format from now on */
4604 if (!in_paused && with_clock) {
4605 now = gst_clock_get_time (clock);
4611 /* subtract base time and base time from the clock time.
4612 * Make sure we don't go negative. This is the current time in
4613 * the segment which we need to scale with the combined
4614 * rate and applied rate. */
4616 base_time += latency;
4617 if (GST_CLOCK_DIFF (base_time, now) < 0)
4620 /* for negative rates we need to count back from the segment
4625 *cur = time + gst_guint64_to_gdouble (now - base_time) * rate;
4628 /* never report less than segment values in paused */
4630 *cur = MAX (last, *cur);
4632 /* never report more than last seen position in playing */
4634 *cur = MIN (last, *cur);
4637 GST_DEBUG_OBJECT (basesink,
4638 "now %" GST_TIME_FORMAT " - base_time %" GST_TIME_FORMAT " - base %"
4639 GST_TIME_FORMAT " + time %" GST_TIME_FORMAT " last %" GST_TIME_FORMAT,
4640 GST_TIME_ARGS (now), GST_TIME_ARGS (base_time), GST_TIME_ARGS (base),
4641 GST_TIME_ARGS (time), GST_TIME_ARGS (last));
4644 if (oformat != format) {
4645 /* convert to final format */
4646 if (!gst_pad_query_convert (basesink->sinkpad, oformat, *cur, &format, cur))
4647 goto convert_failed;
4653 GST_DEBUG_OBJECT (basesink, "res: %d, POSITION: %" GST_TIME_FORMAT,
4654 res, GST_TIME_ARGS (*cur));
4657 gst_object_unref (clock);
4664 /* in NULL or READY we always return FALSE and -1 */
4665 GST_DEBUG_OBJECT (basesink, "position in wrong state, return -1");
4668 GST_OBJECT_UNLOCK (basesink);
4673 GST_DEBUG_OBJECT (basesink, "convert failed, try upstream");
4681 gst_base_sink_get_duration (GstBaseSink * basesink, GstFormat format,
4682 gint64 * dur, gboolean * upstream)
4684 gboolean res = FALSE;
4686 if (basesink->pad_mode == GST_ACTIVATE_PULL) {
4687 GstFormat uformat = GST_FORMAT_BYTES;
4690 /* get the duration in bytes, in pull mode that's all we are sure to
4691 * know. We have to explicitly get this value from upstream instead of
4692 * using our cached value because it might change. Duration caching
4693 * should be done at a higher level. */
4694 res = gst_pad_query_peer_duration (basesink->sinkpad, &uformat, &uduration);
4696 basesink->segment.duration = uduration;
4697 if (format != uformat) {
4698 /* convert to the requested format */
4699 res = gst_pad_query_convert (basesink->sinkpad, uformat, uduration,
4713 static const GstQueryType *
4714 gst_base_sink_get_query_types (GstElement * element)
4716 static const GstQueryType query_types[] = {
4728 gst_base_sink_query (GstElement * element, GstQuery * query)
4730 gboolean res = FALSE;
4732 GstBaseSink *basesink = GST_BASE_SINK (element);
4734 switch (GST_QUERY_TYPE (query)) {
4735 case GST_QUERY_POSITION:
4739 gboolean upstream = FALSE;
4741 gst_query_parse_position (query, &format, NULL);
4743 GST_DEBUG_OBJECT (basesink, "position query in format %s",
4744 gst_format_get_name (format));
4746 /* first try to get the position based on the clock */
4748 gst_base_sink_get_position (basesink, format, &cur, &upstream))) {
4749 gst_query_set_position (query, format, cur);
4750 } else if (upstream) {
4751 /* fallback to peer query */
4752 res = gst_pad_peer_query (basesink->sinkpad, query);
4755 /* we can handle a few things if upstream failed */
4756 if (format == GST_FORMAT_PERCENT) {
4758 GstFormat uformat = GST_FORMAT_TIME;
4760 res = gst_base_sink_get_position (basesink, GST_FORMAT_TIME, &cur,
4762 if (!res && upstream) {
4763 res = gst_pad_query_peer_position (basesink->sinkpad, &uformat,
4767 res = gst_base_sink_get_duration (basesink, GST_FORMAT_TIME, &dur,
4769 if (!res && upstream) {
4770 res = gst_pad_query_peer_duration (basesink->sinkpad, &uformat,
4777 pos = gst_util_uint64_scale (100 * GST_FORMAT_PERCENT_SCALE, cur,
4779 gst_query_set_position (query, GST_FORMAT_PERCENT, pos);
4785 case GST_QUERY_DURATION:
4789 gboolean upstream = FALSE;
4791 gst_query_parse_duration (query, &format, NULL);
4793 GST_DEBUG_OBJECT (basesink, "duration query in format %s",
4794 gst_format_get_name (format));
4797 gst_base_sink_get_duration (basesink, format, &dur, &upstream))) {
4798 gst_query_set_duration (query, format, dur);
4799 } else if (upstream) {
4800 /* fallback to peer query */
4801 res = gst_pad_peer_query (basesink->sinkpad, query);
4804 /* we can handle a few things if upstream failed */
4805 if (format == GST_FORMAT_PERCENT) {
4806 gst_query_set_duration (query, GST_FORMAT_PERCENT,
4807 GST_FORMAT_PERCENT_MAX);
4813 case GST_QUERY_LATENCY:
4815 gboolean live, us_live;
4816 GstClockTime min, max;
4818 if ((res = gst_base_sink_query_latency (basesink, &live, &us_live, &min,
4820 gst_query_set_latency (query, live, min, max);
4824 case GST_QUERY_JITTER:
4826 case GST_QUERY_RATE:
4827 /* gst_query_set_rate (query, basesink->segment_rate); */
4830 case GST_QUERY_SEGMENT:
4832 if (basesink->pad_mode == GST_ACTIVATE_PULL) {
4833 gst_query_set_segment (query, basesink->segment.rate,
4834 GST_FORMAT_TIME, basesink->segment.start, basesink->segment.stop);
4837 res = gst_pad_peer_query (basesink->sinkpad, query);
4841 case GST_QUERY_SEEKING:
4842 case GST_QUERY_CONVERT:
4843 case GST_QUERY_FORMATS:
4845 res = gst_pad_peer_query (basesink->sinkpad, query);
4848 GST_DEBUG_OBJECT (basesink, "query %s returns %d",
4849 GST_QUERY_TYPE_NAME (query), res);
4853 static GstStateChangeReturn
4854 gst_base_sink_change_state (GstElement * element, GstStateChange transition)
4856 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
4857 GstBaseSink *basesink = GST_BASE_SINK (element);
4858 GstBaseSinkClass *bclass;
4859 GstBaseSinkPrivate *priv;
4861 priv = basesink->priv;
4863 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4865 switch (transition) {
4866 case GST_STATE_CHANGE_NULL_TO_READY:
4868 if (!bclass->start (basesink))
4871 case GST_STATE_CHANGE_READY_TO_PAUSED:
4872 /* need to complete preroll before this state change completes, there
4873 * is no data flow in READY so we can safely assume we need to preroll. */
4874 GST_BASE_SINK_PREROLL_LOCK (basesink);
4875 GST_DEBUG_OBJECT (basesink, "READY to PAUSED");
4876 basesink->have_newsegment = FALSE;
4877 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
4878 gst_segment_init (&basesink->clip_segment, GST_FORMAT_UNDEFINED);
4879 basesink->offset = 0;
4880 basesink->have_preroll = FALSE;
4881 priv->step_unlock = FALSE;
4882 basesink->need_preroll = TRUE;
4883 basesink->playing_async = TRUE;
4884 basesink->priv->reset_time = FALSE;
4885 priv->current_sstart = GST_CLOCK_TIME_NONE;
4886 priv->current_sstop = GST_CLOCK_TIME_NONE;
4887 priv->eos_rtime = GST_CLOCK_TIME_NONE;
4889 basesink->eos = FALSE;
4890 priv->received_eos = FALSE;
4891 gst_base_sink_reset_qos (basesink);
4892 priv->commited = FALSE;
4893 priv->call_preroll = TRUE;
4894 priv->current_step.valid = FALSE;
4895 priv->pending_step.valid = FALSE;
4896 if (priv->async_enabled) {
4897 GST_DEBUG_OBJECT (basesink, "doing async state change");
4898 /* when async enabled, post async-start message and return ASYNC from
4899 * the state change function */
4900 ret = GST_STATE_CHANGE_ASYNC;
4901 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4902 gst_message_new_async_start (GST_OBJECT_CAST (basesink)));
4904 priv->have_latency = TRUE;
4906 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4908 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
4909 GST_BASE_SINK_PREROLL_LOCK (basesink);
4910 if (!gst_base_sink_needs_preroll (basesink)) {
4911 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, don't need preroll");
4912 /* no preroll needed anymore now. */
4913 basesink->playing_async = FALSE;
4914 basesink->need_preroll = FALSE;
4915 if (basesink->eos) {
4916 GstMessage *message;
4918 /* need to post EOS message here */
4919 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
4920 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
4921 gst_message_set_seqnum (message, basesink->priv->seqnum);
4922 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
4924 GST_DEBUG_OBJECT (basesink, "signal preroll");
4925 GST_BASE_SINK_PREROLL_SIGNAL (basesink);
4928 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, we are not prerolled");
4929 basesink->need_preroll = TRUE;
4930 basesink->playing_async = TRUE;
4931 priv->call_preroll = TRUE;
4932 priv->commited = FALSE;
4933 if (priv->async_enabled) {
4934 GST_DEBUG_OBJECT (basesink, "doing async state change");
4935 ret = GST_STATE_CHANGE_ASYNC;
4936 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4937 gst_message_new_async_start (GST_OBJECT_CAST (basesink)));
4940 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4947 GstStateChangeReturn bret;
4949 bret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
4950 if (G_UNLIKELY (bret == GST_STATE_CHANGE_FAILURE))
4951 goto activate_failed;
4954 switch (transition) {
4955 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
4956 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED");
4957 /* FIXME, make sure we cannot enter _render first */
4959 /* we need to call ::unlock before locking PREROLL_LOCK
4960 * since we lock it before going into ::render */
4962 bclass->unlock (basesink);
4964 GST_BASE_SINK_PREROLL_LOCK (basesink);
4965 GST_DEBUG_OBJECT (basesink, "got preroll lock");
4966 /* now that we have the PREROLL lock, clear our unlock request */
4967 if (bclass->unlock_stop)
4968 bclass->unlock_stop (basesink);
4970 /* we need preroll again and we set the flag before unlocking the clockid
4971 * because if the clockid is unlocked before a current buffer expired, we
4972 * can use that buffer to preroll with */
4973 basesink->need_preroll = TRUE;
4975 if (basesink->clock_id) {
4976 GST_DEBUG_OBJECT (basesink, "unschedule clock");
4977 gst_clock_id_unschedule (basesink->clock_id);
4980 /* if we don't have a preroll buffer we need to wait for a preroll and
4982 if (!gst_base_sink_needs_preroll (basesink)) {
4983 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED, we are prerolled");
4984 basesink->playing_async = FALSE;
4986 if (GST_STATE_TARGET (GST_ELEMENT (basesink)) <= GST_STATE_READY) {
4987 GST_DEBUG_OBJECT (basesink, "element is <= READY");
4988 ret = GST_STATE_CHANGE_SUCCESS;
4990 GST_DEBUG_OBJECT (basesink,
4991 "PLAYING to PAUSED, we are not prerolled");
4992 basesink->playing_async = TRUE;
4993 priv->commited = FALSE;
4994 priv->call_preroll = TRUE;
4995 if (priv->async_enabled) {
4996 GST_DEBUG_OBJECT (basesink, "doing async state change");
4997 ret = GST_STATE_CHANGE_ASYNC;
4998 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4999 gst_message_new_async_start (GST_OBJECT_CAST (basesink)));
5003 GST_DEBUG_OBJECT (basesink, "rendered: %" G_GUINT64_FORMAT
5004 ", dropped: %" G_GUINT64_FORMAT, priv->rendered, priv->dropped);
5006 gst_base_sink_reset_qos (basesink);
5007 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
5009 case GST_STATE_CHANGE_PAUSED_TO_READY:
5010 GST_BASE_SINK_PREROLL_LOCK (basesink);
5011 /* start by reseting our position state with the object lock so that the
5012 * position query gets the right idea. We do this before we post the
5013 * messages so that the message handlers pick this up. */
5014 GST_OBJECT_LOCK (basesink);
5015 basesink->have_newsegment = FALSE;
5016 priv->current_sstart = GST_CLOCK_TIME_NONE;
5017 priv->current_sstop = GST_CLOCK_TIME_NONE;
5018 priv->have_latency = FALSE;
5019 if (priv->cached_clock_id) {
5020 gst_clock_id_unref (priv->cached_clock_id);
5021 priv->cached_clock_id = NULL;
5023 GST_OBJECT_UNLOCK (basesink);
5025 gst_base_sink_set_last_buffer (basesink, NULL);
5026 priv->call_preroll = FALSE;
5028 if (!priv->commited) {
5029 if (priv->async_enabled) {
5030 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, posting async-done");
5032 gst_element_post_message (GST_ELEMENT_CAST (basesink),
5033 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
5034 GST_STATE_PLAYING, GST_STATE_PAUSED, GST_STATE_READY));
5036 gst_element_post_message (GST_ELEMENT_CAST (basesink),
5037 gst_message_new_async_done (GST_OBJECT_CAST (basesink), FALSE));
5039 priv->commited = TRUE;
5041 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, don't need_preroll");
5043 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
5045 case GST_STATE_CHANGE_READY_TO_NULL:
5047 if (!bclass->stop (basesink)) {
5048 GST_WARNING_OBJECT (basesink, "failed to stop");
5051 gst_base_sink_set_last_buffer (basesink, NULL);
5052 priv->call_preroll = FALSE;
5063 GST_DEBUG_OBJECT (basesink, "failed to start");
5064 return GST_STATE_CHANGE_FAILURE;
5068 GST_DEBUG_OBJECT (basesink,
5069 "element failed to change states -- activation problem?");
5070 return GST_STATE_CHANGE_FAILURE;