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;
267 #define DO_RUNNING_AVG(avg,val,size) (((val) + ((size)-1) * (avg)) / (size))
269 /* generic running average, this has a neutral window size */
270 #define UPDATE_RUNNING_AVG(avg,val) DO_RUNNING_AVG(avg,val,8)
272 /* the windows for these running averages are experimentally obtained.
273 * possitive values get averaged more while negative values use a small
274 * window so we can react faster to badness. */
275 #define UPDATE_RUNNING_AVG_P(avg,val) DO_RUNNING_AVG(avg,val,16)
276 #define UPDATE_RUNNING_AVG_N(avg,val) DO_RUNNING_AVG(avg,val,4)
280 _PR_IS_NOTHING = 1 << 0,
281 _PR_IS_BUFFER = 1 << 1,
282 _PR_IS_BUFFERLIST = 1 << 2,
283 _PR_IS_EVENT = 1 << 3
286 #define OBJ_IS_BUFFER(a) ((a) & _PR_IS_BUFFER)
287 #define OBJ_IS_BUFFERLIST(a) ((a) & _PR_IS_BUFFERLIST)
288 #define OBJ_IS_EVENT(a) ((a) & _PR_IS_EVENT)
289 #define OBJ_IS_BUFFERFULL(a) ((a) & (_PR_IS_BUFFER | _PR_IS_BUFFERLIST))
291 /* BaseSink properties */
293 #define DEFAULT_CAN_ACTIVATE_PULL FALSE /* fixme: enable me */
294 #define DEFAULT_CAN_ACTIVATE_PUSH TRUE
296 #define DEFAULT_PREROLL_QUEUE_LEN 0
297 #define DEFAULT_SYNC TRUE
298 #define DEFAULT_MAX_LATENESS -1
299 #define DEFAULT_QOS FALSE
300 #define DEFAULT_ASYNC TRUE
301 #define DEFAULT_TS_OFFSET 0
302 #define DEFAULT_BLOCKSIZE 4096
303 #define DEFAULT_RENDER_DELAY 0
304 #define DEFAULT_ENABLE_LAST_BUFFER TRUE
305 #define DEFAULT_THROTTLE_TIME 0
310 PROP_PREROLL_QUEUE_LEN,
316 PROP_ENABLE_LAST_BUFFER,
324 static GstElementClass *parent_class = NULL;
326 static void gst_base_sink_class_init (GstBaseSinkClass * klass);
327 static void gst_base_sink_init (GstBaseSink * trans, gpointer g_class);
328 static void gst_base_sink_finalize (GObject * object);
331 gst_base_sink_get_type (void)
333 static volatile gsize base_sink_type = 0;
335 if (g_once_init_enter (&base_sink_type)) {
337 static const GTypeInfo base_sink_info = {
338 sizeof (GstBaseSinkClass),
341 (GClassInitFunc) gst_base_sink_class_init,
344 sizeof (GstBaseSink),
346 (GInstanceInitFunc) gst_base_sink_init,
349 _type = g_type_register_static (GST_TYPE_ELEMENT,
350 "GstBaseSink", &base_sink_info, G_TYPE_FLAG_ABSTRACT);
351 g_once_init_leave (&base_sink_type, _type);
353 return base_sink_type;
356 static void gst_base_sink_set_property (GObject * object, guint prop_id,
357 const GValue * value, GParamSpec * pspec);
358 static void gst_base_sink_get_property (GObject * object, guint prop_id,
359 GValue * value, GParamSpec * pspec);
361 static gboolean gst_base_sink_send_event (GstElement * element,
363 static gboolean gst_base_sink_query (GstElement * element, GstQuery ** query);
364 static const GstQueryType *gst_base_sink_get_query_types (GstElement * element);
366 static GstCaps *gst_base_sink_get_caps (GstBaseSink * sink, GstCaps * caps);
367 static gboolean gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps);
368 static void gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
369 GstClockTime * start, GstClockTime * end);
370 static gboolean gst_base_sink_set_flushing (GstBaseSink * basesink,
371 GstPad * pad, gboolean flushing);
372 static gboolean gst_base_sink_default_activate_pull (GstBaseSink * basesink,
374 static gboolean gst_base_sink_default_do_seek (GstBaseSink * sink,
375 GstSegment * segment);
376 static gboolean gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
377 GstEvent * event, GstSegment * segment);
379 static GstStateChangeReturn gst_base_sink_change_state (GstElement * element,
380 GstStateChange transition);
382 static GstFlowReturn gst_base_sink_chain (GstPad * pad, GstBuffer * buffer);
383 static GstFlowReturn gst_base_sink_chain_list (GstPad * pad,
384 GstBufferList * list);
386 static void gst_base_sink_loop (GstPad * pad);
387 static gboolean gst_base_sink_pad_activate (GstPad * pad);
388 static gboolean gst_base_sink_pad_activate_push (GstPad * pad, gboolean active);
389 static gboolean gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active);
390 static gboolean gst_base_sink_event (GstPad * pad, GstEvent * event);
392 static gboolean gst_base_sink_negotiate_pull (GstBaseSink * basesink);
393 static GstCaps *gst_base_sink_pad_getcaps (GstPad * pad, GstCaps * filter);
394 static void gst_base_sink_pad_fixate (GstPad * pad, GstCaps * caps);
396 /* check if an object was too late */
397 static gboolean gst_base_sink_is_too_late (GstBaseSink * basesink,
398 GstMiniObject * obj, GstClockTime rstart, GstClockTime rstop,
399 GstClockReturn status, GstClockTimeDiff jitter);
400 static GstFlowReturn gst_base_sink_preroll_object (GstBaseSink * basesink,
401 guint8 obj_type, GstMiniObject * obj);
404 gst_base_sink_class_init (GstBaseSinkClass * klass)
406 GObjectClass *gobject_class;
407 GstElementClass *gstelement_class;
409 gobject_class = G_OBJECT_CLASS (klass);
410 gstelement_class = GST_ELEMENT_CLASS (klass);
412 GST_DEBUG_CATEGORY_INIT (gst_base_sink_debug, "basesink", 0,
415 g_type_class_add_private (klass, sizeof (GstBaseSinkPrivate));
417 parent_class = g_type_class_peek_parent (klass);
419 gobject_class->finalize = gst_base_sink_finalize;
420 gobject_class->set_property = gst_base_sink_set_property;
421 gobject_class->get_property = gst_base_sink_get_property;
423 /* FIXME, this next value should be configured using an event from the
424 * upstream element, ie, the BUFFER_SIZE event. */
425 g_object_class_install_property (gobject_class, PROP_PREROLL_QUEUE_LEN,
426 g_param_spec_uint ("preroll-queue-len", "Preroll queue length",
427 "Number of buffers to queue during preroll", 0, G_MAXUINT,
428 DEFAULT_PREROLL_QUEUE_LEN,
429 G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS));
431 g_object_class_install_property (gobject_class, PROP_SYNC,
432 g_param_spec_boolean ("sync", "Sync", "Sync on the clock", DEFAULT_SYNC,
433 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
435 g_object_class_install_property (gobject_class, PROP_MAX_LATENESS,
436 g_param_spec_int64 ("max-lateness", "Max Lateness",
437 "Maximum number of nanoseconds that a buffer can be late before it "
438 "is dropped (-1 unlimited)", -1, G_MAXINT64, DEFAULT_MAX_LATENESS,
439 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
441 g_object_class_install_property (gobject_class, PROP_QOS,
442 g_param_spec_boolean ("qos", "Qos",
443 "Generate Quality-of-Service events upstream", DEFAULT_QOS,
444 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
448 * If set to #TRUE, the basesink will perform asynchronous state changes.
449 * When set to #FALSE, the sink will not signal the parent when it prerolls.
450 * Use this option when dealing with sparse streams or when synchronisation is
455 g_object_class_install_property (gobject_class, PROP_ASYNC,
456 g_param_spec_boolean ("async", "Async",
457 "Go asynchronously to PAUSED", DEFAULT_ASYNC,
458 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
460 * GstBaseSink:ts-offset
462 * Controls the final synchronisation, a negative value will render the buffer
463 * earlier while a positive value delays playback. This property can be
464 * used to fix synchronisation in bad files.
468 g_object_class_install_property (gobject_class, PROP_TS_OFFSET,
469 g_param_spec_int64 ("ts-offset", "TS Offset",
470 "Timestamp offset in nanoseconds", G_MININT64, G_MAXINT64,
471 DEFAULT_TS_OFFSET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
474 * GstBaseSink:enable-last-buffer
476 * Enable the last-buffer property. If FALSE, basesink doesn't keep a
477 * reference to the last buffer arrived and the last-buffer property is always
478 * set to NULL. This can be useful if you need buffers to be released as soon
479 * as possible, eg. if you're using a buffer pool.
483 g_object_class_install_property (gobject_class, PROP_ENABLE_LAST_BUFFER,
484 g_param_spec_boolean ("enable-last-buffer", "Enable Last Buffer",
485 "Enable the last-buffer property", DEFAULT_ENABLE_LAST_BUFFER,
486 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
489 * GstBaseSink:last-buffer
491 * The last buffer that arrived in the sink and was used for preroll or for
492 * rendering. This property can be used to generate thumbnails. This property
493 * can be NULL when the sink has not yet received a bufer.
497 g_object_class_install_property (gobject_class, PROP_LAST_BUFFER,
498 g_param_spec_boxed ("last-buffer", "Last Buffer",
499 "The last buffer received in the sink", GST_TYPE_BUFFER,
500 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
502 * GstBaseSink:blocksize
504 * The amount of bytes to pull when operating in pull mode.
508 /* FIXME 0.11: blocksize property should be int, otherwise min>max.. */
509 g_object_class_install_property (gobject_class, PROP_BLOCKSIZE,
510 g_param_spec_uint ("blocksize", "Block size",
511 "Size in bytes to pull per buffer (0 = default)", 0, G_MAXUINT,
512 DEFAULT_BLOCKSIZE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
514 * GstBaseSink:render-delay
516 * The additional delay between synchronisation and actual rendering of the
517 * media. This property will add additional latency to the device in order to
518 * make other sinks compensate for the delay.
522 g_object_class_install_property (gobject_class, PROP_RENDER_DELAY,
523 g_param_spec_uint64 ("render-delay", "Render Delay",
524 "Additional render delay of the sink in nanoseconds", 0, G_MAXUINT64,
525 DEFAULT_RENDER_DELAY, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
527 * GstBaseSink:throttle-time
529 * The time to insert between buffers. This property can be used to control
530 * the maximum amount of buffers per second to render. Setting this property
531 * to a value bigger than 0 will make the sink create THROTTLE QoS events.
535 g_object_class_install_property (gobject_class, PROP_THROTTLE_TIME,
536 g_param_spec_uint64 ("throttle-time", "Throttle time",
537 "The time to keep between rendered buffers (unused)", 0, G_MAXUINT64,
538 DEFAULT_THROTTLE_TIME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
540 gstelement_class->change_state =
541 GST_DEBUG_FUNCPTR (gst_base_sink_change_state);
542 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_base_sink_send_event);
543 gstelement_class->query = GST_DEBUG_FUNCPTR (gst_base_sink_query);
544 gstelement_class->get_query_types =
545 GST_DEBUG_FUNCPTR (gst_base_sink_get_query_types);
547 klass->get_caps = GST_DEBUG_FUNCPTR (gst_base_sink_get_caps);
548 klass->set_caps = GST_DEBUG_FUNCPTR (gst_base_sink_set_caps);
549 klass->get_times = GST_DEBUG_FUNCPTR (gst_base_sink_get_times);
550 klass->activate_pull =
551 GST_DEBUG_FUNCPTR (gst_base_sink_default_activate_pull);
553 /* Registering debug symbols for function pointers */
554 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_getcaps);
555 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_fixate);
556 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate);
557 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate_push);
558 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_pad_activate_pull);
559 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_event);
560 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain);
561 GST_DEBUG_REGISTER_FUNCPTR (gst_base_sink_chain_list);
565 gst_base_sink_pad_getcaps (GstPad * pad, GstCaps * filter)
567 GstBaseSinkClass *bclass;
569 GstCaps *caps = NULL;
571 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
572 bclass = GST_BASE_SINK_GET_CLASS (bsink);
574 if (bsink->pad_mode == GST_ACTIVATE_PULL) {
575 /* if we are operating in pull mode we only accept the negotiated caps */
576 caps = gst_pad_get_current_caps (pad);
579 if (bclass->get_caps)
580 caps = bclass->get_caps (bsink, filter);
583 GstPadTemplate *pad_template;
586 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass),
588 if (pad_template != NULL) {
589 caps = gst_caps_ref (gst_pad_template_get_caps (pad_template));
592 GstCaps *intersection;
595 gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
596 gst_caps_unref (caps);
602 gst_object_unref (bsink);
608 gst_base_sink_pad_fixate (GstPad * pad, GstCaps * caps)
610 GstBaseSinkClass *bclass;
613 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
614 bclass = GST_BASE_SINK_GET_CLASS (bsink);
617 bclass->fixate (bsink, caps);
619 gst_object_unref (bsink);
623 gst_base_sink_init (GstBaseSink * basesink, gpointer g_class)
625 GstPadTemplate *pad_template;
626 GstBaseSinkPrivate *priv;
628 basesink->priv = priv = GST_BASE_SINK_GET_PRIVATE (basesink);
631 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "sink");
632 g_return_if_fail (pad_template != NULL);
634 basesink->sinkpad = gst_pad_new_from_template (pad_template, "sink");
636 gst_pad_set_getcaps_function (basesink->sinkpad, gst_base_sink_pad_getcaps);
637 gst_pad_set_fixatecaps_function (basesink->sinkpad, gst_base_sink_pad_fixate);
638 gst_pad_set_activate_function (basesink->sinkpad, gst_base_sink_pad_activate);
639 gst_pad_set_activatepush_function (basesink->sinkpad,
640 gst_base_sink_pad_activate_push);
641 gst_pad_set_activatepull_function (basesink->sinkpad,
642 gst_base_sink_pad_activate_pull);
643 gst_pad_set_event_function (basesink->sinkpad, gst_base_sink_event);
644 gst_pad_set_chain_function (basesink->sinkpad, gst_base_sink_chain);
645 gst_pad_set_chain_list_function (basesink->sinkpad, gst_base_sink_chain_list);
646 gst_element_add_pad (GST_ELEMENT_CAST (basesink), basesink->sinkpad);
648 basesink->pad_mode = GST_ACTIVATE_NONE;
649 basesink->preroll_lock = g_mutex_new ();
650 basesink->preroll_cond = g_cond_new ();
651 basesink->preroll_queue = g_queue_new ();
652 basesink->clip_segment = gst_segment_new ();
653 priv->have_latency = FALSE;
655 basesink->can_activate_push = DEFAULT_CAN_ACTIVATE_PUSH;
656 basesink->can_activate_pull = DEFAULT_CAN_ACTIVATE_PULL;
658 basesink->sync = DEFAULT_SYNC;
659 basesink->max_lateness = DEFAULT_MAX_LATENESS;
660 g_atomic_int_set (&priv->qos_enabled, DEFAULT_QOS);
661 priv->async_enabled = DEFAULT_ASYNC;
662 priv->ts_offset = DEFAULT_TS_OFFSET;
663 priv->render_delay = DEFAULT_RENDER_DELAY;
664 priv->blocksize = DEFAULT_BLOCKSIZE;
665 priv->cached_clock_id = NULL;
666 g_atomic_int_set (&priv->enable_last_buffer, DEFAULT_ENABLE_LAST_BUFFER);
667 priv->throttle_time = DEFAULT_THROTTLE_TIME;
669 GST_OBJECT_FLAG_SET (basesink, GST_ELEMENT_IS_SINK);
673 gst_base_sink_finalize (GObject * object)
675 GstBaseSink *basesink;
677 basesink = GST_BASE_SINK (object);
679 g_mutex_free (basesink->preroll_lock);
680 g_cond_free (basesink->preroll_cond);
681 g_queue_free (basesink->preroll_queue);
682 gst_segment_free (basesink->clip_segment);
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_parse_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;
1473 /* we are certainly not playing async anymore now */
1474 basesink->playing_async = FALSE;
1476 GST_OBJECT_LOCK (basesink);
1477 current = GST_STATE (basesink);
1478 next = GST_STATE_NEXT (basesink);
1479 pending = GST_STATE_PENDING (basesink);
1480 post_pending = pending;
1483 case GST_STATE_PLAYING:
1485 GstBaseSinkClass *bclass;
1487 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1489 GST_DEBUG_OBJECT (basesink, "commiting state to PLAYING");
1491 basesink->need_preroll = FALSE;
1492 post_async_done = TRUE;
1493 basesink->priv->commited = TRUE;
1494 post_playing = TRUE;
1495 /* post PAUSED too when we were READY */
1496 if (current == GST_STATE_READY) {
1501 case GST_STATE_PAUSED:
1502 GST_DEBUG_OBJECT (basesink, "commiting state to PAUSED");
1504 post_async_done = TRUE;
1505 basesink->priv->commited = TRUE;
1506 post_pending = GST_STATE_VOID_PENDING;
1508 case GST_STATE_READY:
1509 case GST_STATE_NULL:
1511 case GST_STATE_VOID_PENDING:
1512 goto nothing_pending;
1517 /* we can report latency queries now */
1518 basesink->priv->have_latency = TRUE;
1520 GST_STATE (basesink) = pending;
1521 GST_STATE_NEXT (basesink) = GST_STATE_VOID_PENDING;
1522 GST_STATE_PENDING (basesink) = GST_STATE_VOID_PENDING;
1523 GST_STATE_RETURN (basesink) = GST_STATE_CHANGE_SUCCESS;
1524 GST_OBJECT_UNLOCK (basesink);
1527 GST_DEBUG_OBJECT (basesink, "posting PAUSED state change message");
1528 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1529 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1530 current, next, post_pending));
1532 if (post_async_done) {
1533 GST_DEBUG_OBJECT (basesink, "posting async-done message");
1534 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1535 gst_message_new_async_done (GST_OBJECT_CAST (basesink)));
1538 GST_DEBUG_OBJECT (basesink, "posting PLAYING state change message");
1539 gst_element_post_message (GST_ELEMENT_CAST (basesink),
1540 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
1541 next, pending, GST_STATE_VOID_PENDING));
1544 GST_STATE_BROADCAST (basesink);
1550 /* Depending on the state, set our vars. We get in this situation when the
1551 * state change function got a change to update the state vars before the
1552 * streaming thread did. This is fine but we need to make sure that we
1553 * update the need_preroll var since it was TRUE when we got here and might
1554 * become FALSE if we got to PLAYING. */
1555 GST_DEBUG_OBJECT (basesink, "nothing to commit, now in %s",
1556 gst_element_state_get_name (current));
1558 case GST_STATE_PLAYING:
1559 basesink->need_preroll = FALSE;
1561 case GST_STATE_PAUSED:
1562 basesink->need_preroll = TRUE;
1565 basesink->need_preroll = FALSE;
1566 basesink->flushing = TRUE;
1569 /* we can report latency queries now */
1570 basesink->priv->have_latency = TRUE;
1571 GST_OBJECT_UNLOCK (basesink);
1576 /* app is going to READY */
1577 GST_DEBUG_OBJECT (basesink, "stopping");
1578 basesink->need_preroll = FALSE;
1579 basesink->flushing = TRUE;
1580 GST_OBJECT_UNLOCK (basesink);
1586 start_stepping (GstBaseSink * sink, GstSegment * segment,
1587 GstStepInfo * pending, GstStepInfo * current)
1590 GstMessage *message;
1592 GST_DEBUG_OBJECT (sink, "update pending step");
1594 GST_OBJECT_LOCK (sink);
1595 memcpy (current, pending, sizeof (GstStepInfo));
1596 pending->valid = FALSE;
1597 GST_OBJECT_UNLOCK (sink);
1599 /* post message first */
1601 gst_message_new_step_start (GST_OBJECT (sink), TRUE, current->format,
1602 current->amount, current->rate, current->flush, current->intermediate);
1603 gst_message_set_seqnum (message, current->seqnum);
1604 gst_element_post_message (GST_ELEMENT (sink), message);
1606 /* get the running time of where we paused and remember it */
1607 current->start = gst_element_get_start_time (GST_ELEMENT_CAST (sink));
1608 gst_segment_set_running_time (segment, GST_FORMAT_TIME, current->start);
1610 /* set the new rate for the remainder of the segment */
1611 current->start_rate = segment->rate;
1612 segment->rate *= current->rate;
1615 if (segment->rate > 0.0)
1616 current->start_stop = segment->stop;
1618 current->start_start = segment->start;
1620 if (current->format == GST_FORMAT_TIME) {
1621 end = current->start + current->amount;
1622 if (!current->flush) {
1623 /* update the segment clipping regions for non-flushing seeks */
1624 if (segment->rate > 0.0) {
1625 segment->stop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1626 segment->position = segment->stop;
1630 position = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1631 segment->time = position;
1632 segment->start = position;
1633 segment->position = position;
1638 GST_DEBUG_OBJECT (sink, "segment now %" GST_SEGMENT_FORMAT, segment);
1639 GST_DEBUG_OBJECT (sink, "step started at running_time %" GST_TIME_FORMAT,
1640 GST_TIME_ARGS (current->start));
1642 if (current->amount == -1) {
1643 GST_DEBUG_OBJECT (sink, "step amount == -1, stop stepping");
1644 current->valid = FALSE;
1646 GST_DEBUG_OBJECT (sink, "step amount: %" G_GUINT64_FORMAT ", format: %s, "
1647 "rate: %f", current->amount, gst_format_get_name (current->format),
1653 stop_stepping (GstBaseSink * sink, GstSegment * segment,
1654 GstStepInfo * current, gint64 rstart, gint64 rstop, gboolean eos)
1656 gint64 stop, position;
1657 GstMessage *message;
1659 GST_DEBUG_OBJECT (sink, "step complete");
1661 if (segment->rate > 0.0)
1666 GST_DEBUG_OBJECT (sink,
1667 "step stop at running_time %" GST_TIME_FORMAT, GST_TIME_ARGS (stop));
1670 current->duration = current->position;
1672 current->duration = stop - current->start;
1674 GST_DEBUG_OBJECT (sink, "step elapsed running_time %" GST_TIME_FORMAT,
1675 GST_TIME_ARGS (current->duration));
1677 position = current->start + current->duration;
1679 /* now move the segment to the new running time */
1680 gst_segment_set_running_time (segment, GST_FORMAT_TIME, position);
1682 if (current->flush) {
1683 /* and remove the time we flushed, start time did not change */
1684 segment->base = current->start;
1686 /* start time is now the stepped position */
1687 gst_element_set_start_time (GST_ELEMENT_CAST (sink), position);
1690 /* restore the previous rate */
1691 segment->rate = current->start_rate;
1693 if (segment->rate > 0.0)
1694 segment->stop = current->start_stop;
1696 segment->start = current->start_start;
1698 /* the clip segment is used for position report in paused... */
1699 gst_segment_copy_into (segment, sink->clip_segment);
1701 /* post the step done when we know the stepped duration in TIME */
1703 gst_message_new_step_done (GST_OBJECT_CAST (sink), current->format,
1704 current->amount, current->rate, current->flush, current->intermediate,
1705 current->duration, eos);
1706 gst_message_set_seqnum (message, current->seqnum);
1707 gst_element_post_message (GST_ELEMENT_CAST (sink), message);
1709 if (!current->intermediate)
1710 sink->need_preroll = current->need_preroll;
1712 /* and the current step info finished and becomes invalid */
1713 current->valid = FALSE;
1717 handle_stepping (GstBaseSink * sink, GstSegment * segment,
1718 GstStepInfo * current, guint64 * cstart, guint64 * cstop, guint64 * rstart,
1721 gboolean step_end = FALSE;
1723 /* see if we need to skip this buffer because of stepping */
1724 switch (current->format) {
1725 case GST_FORMAT_TIME:
1728 guint64 first, last;
1731 if (segment->rate > 0.0) {
1732 if (segment->stop == *cstop)
1733 *rstop = *rstart + current->amount;
1738 if (segment->start == *cstart)
1739 *rstart = *rstop + current->amount;
1745 end = current->start + current->amount;
1746 current->position = first - current->start;
1748 abs_rate = ABS (segment->rate);
1749 if (G_UNLIKELY (abs_rate != 1.0))
1750 current->position /= abs_rate;
1752 GST_DEBUG_OBJECT (sink,
1753 "buffer: %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT,
1754 GST_TIME_ARGS (first), GST_TIME_ARGS (last));
1755 GST_DEBUG_OBJECT (sink,
1756 "got time step %" GST_TIME_FORMAT "-%" GST_TIME_FORMAT "/%"
1757 GST_TIME_FORMAT, GST_TIME_ARGS (current->position),
1758 GST_TIME_ARGS (last - current->start),
1759 GST_TIME_ARGS (current->amount));
1761 if ((current->flush && current->position >= current->amount)
1763 GST_DEBUG_OBJECT (sink, "step ended, we need clipping");
1765 if (segment->rate > 0.0) {
1767 *cstart = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1770 *cstop = gst_segment_to_position (segment, GST_FORMAT_TIME, end);
1773 GST_DEBUG_OBJECT (sink,
1774 "cstart %" GST_TIME_FORMAT ", rstart %" GST_TIME_FORMAT,
1775 GST_TIME_ARGS (*cstart), GST_TIME_ARGS (*rstart));
1776 GST_DEBUG_OBJECT (sink,
1777 "cstop %" GST_TIME_FORMAT ", rstop %" GST_TIME_FORMAT,
1778 GST_TIME_ARGS (*cstop), GST_TIME_ARGS (*rstop));
1781 case GST_FORMAT_BUFFERS:
1782 GST_DEBUG_OBJECT (sink,
1783 "got default step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1784 current->position, current->amount);
1786 if (current->position < current->amount) {
1787 current->position++;
1792 case GST_FORMAT_DEFAULT:
1794 GST_DEBUG_OBJECT (sink,
1795 "got unknown step %" G_GUINT64_FORMAT "/%" G_GUINT64_FORMAT,
1796 current->position, current->amount);
1802 /* with STREAM_LOCK, PREROLL_LOCK
1804 * Returns TRUE if the object needs synchronisation and takes therefore
1805 * part in prerolling.
1807 * rsstart/rsstop contain the start/stop in stream time.
1808 * rrstart/rrstop contain the start/stop in running time.
1811 gst_base_sink_get_sync_times (GstBaseSink * basesink, GstMiniObject * obj,
1812 GstClockTime * rsstart, GstClockTime * rsstop,
1813 GstClockTime * rrstart, GstClockTime * rrstop, gboolean * do_sync,
1814 gboolean * stepped, GstSegment * segment, GstStepInfo * step,
1815 gboolean * step_end, guint8 obj_type)
1817 GstBaseSinkClass *bclass;
1819 GstClockTime start, stop; /* raw start/stop timestamps */
1820 guint64 cstart, cstop; /* clipped raw timestamps */
1821 guint64 rstart, rstop; /* clipped timestamps converted to running time */
1822 GstClockTime sstart, sstop; /* clipped timestamps converted to stream time */
1824 GstBaseSinkPrivate *priv;
1827 priv = basesink->priv;
1829 /* start with nothing */
1830 start = stop = GST_CLOCK_TIME_NONE;
1832 if (G_UNLIKELY (OBJ_IS_EVENT (obj_type))) {
1833 GstEvent *event = GST_EVENT_CAST (obj);
1835 switch (GST_EVENT_TYPE (event)) {
1836 /* EOS event needs syncing */
1839 if (basesink->segment.rate >= 0.0) {
1840 sstart = sstop = priv->current_sstop;
1841 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1842 /* we have not seen a buffer yet, use the segment values */
1843 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1844 basesink->segment.format, basesink->segment.stop);
1847 sstart = sstop = priv->current_sstart;
1848 if (!GST_CLOCK_TIME_IS_VALID (sstart)) {
1849 /* we have not seen a buffer yet, use the segment values */
1850 sstart = sstop = gst_segment_to_stream_time (&basesink->segment,
1851 basesink->segment.format, basesink->segment.start);
1855 rstart = rstop = priv->eos_rtime;
1856 *do_sync = rstart != -1;
1857 GST_DEBUG_OBJECT (basesink, "sync times for EOS %" GST_TIME_FORMAT,
1858 GST_TIME_ARGS (rstart));
1859 /* if we are stepping, we end now */
1860 *step_end = step->valid;
1865 /* other events do not need syncing */
1873 /* else do buffer sync code */
1874 buffer = GST_BUFFER_CAST (obj);
1876 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1878 /* just get the times to see if we need syncing, if the start returns -1 we
1880 if (bclass->get_times)
1881 bclass->get_times (basesink, buffer, &start, &stop);
1883 if (!GST_CLOCK_TIME_IS_VALID (start)) {
1884 /* we don't need to sync but we still want to get the timestamps for
1885 * tracking the position */
1886 gst_base_sink_get_times (basesink, buffer, &start, &stop);
1892 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
1893 ", stop: %" GST_TIME_FORMAT ", do_sync %d", GST_TIME_ARGS (start),
1894 GST_TIME_ARGS (stop), *do_sync);
1896 /* collect segment and format for code clarity */
1897 format = segment->format;
1900 if (G_UNLIKELY (!gst_segment_clip (segment, format,
1901 start, stop, &cstart, &cstop))) {
1903 GST_DEBUG_OBJECT (basesink, "step out of segment");
1904 /* when we are stepping, pretend we're at the end of the segment */
1905 if (segment->rate > 0.0) {
1906 cstart = segment->stop;
1907 cstop = segment->stop;
1909 cstart = segment->start;
1910 cstop = segment->start;
1914 goto out_of_segment;
1917 if (G_UNLIKELY (start != cstart || stop != cstop)) {
1918 GST_DEBUG_OBJECT (basesink, "clipped to: start %" GST_TIME_FORMAT
1919 ", stop: %" GST_TIME_FORMAT, GST_TIME_ARGS (cstart),
1920 GST_TIME_ARGS (cstop));
1923 /* set last stop position */
1924 if (G_LIKELY (stop != GST_CLOCK_TIME_NONE && cstop != GST_CLOCK_TIME_NONE))
1925 segment->position = cstop;
1927 segment->position = cstart;
1930 rstart = gst_segment_to_running_time (segment, format, cstart);
1931 rstop = gst_segment_to_running_time (segment, format, cstop);
1933 if (G_UNLIKELY (step->valid)) {
1934 if (!(*step_end = handle_stepping (basesink, segment, step, &cstart, &cstop,
1935 &rstart, &rstop))) {
1936 /* step is still busy, we discard data when we are flushing */
1937 *stepped = step->flush;
1938 GST_DEBUG_OBJECT (basesink, "stepping busy");
1941 /* this can produce wrong values if we accumulated non-TIME segments. If this happens,
1942 * upstream is behaving very badly */
1943 sstart = gst_segment_to_stream_time (segment, format, cstart);
1944 sstop = gst_segment_to_stream_time (segment, format, cstop);
1947 /* eos_done label only called when doing EOS, we also stop stepping then */
1948 if (*step_end && step->flush) {
1949 GST_DEBUG_OBJECT (basesink, "flushing step ended");
1950 stop_stepping (basesink, segment, step, rstart, rstop, eos);
1952 /* re-determine running start times for adjusted segment
1953 * (which has a flushed amount of running/accumulated time removed) */
1954 if (!GST_IS_EVENT (obj)) {
1955 GST_DEBUG_OBJECT (basesink, "refresh sync times");
1966 /* buffers and EOS always need syncing and preroll */
1972 /* we usually clip in the chain function already but stepping could cause
1973 * the segment to be updated later. we return FALSE so that we don't try
1975 GST_LOG_OBJECT (basesink, "buffer skipped, not in segment");
1980 /* with STREAM_LOCK, PREROLL_LOCK, LOCK
1981 * adjust a timestamp with the latency and timestamp offset. This function does
1982 * not adjust for the render delay. */
1984 gst_base_sink_adjust_time (GstBaseSink * basesink, GstClockTime time)
1986 GstClockTimeDiff ts_offset;
1988 /* don't do anything funny with invalid timestamps */
1989 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
1992 time += basesink->priv->latency;
1994 /* apply offset, be carefull for underflows */
1995 ts_offset = basesink->priv->ts_offset;
1996 if (ts_offset < 0) {
1997 ts_offset = -ts_offset;
1998 if (ts_offset < time)
2005 /* subtract the render delay again, which was included in the latency */
2006 if (time > basesink->priv->render_delay)
2007 time -= basesink->priv->render_delay;
2015 * gst_base_sink_wait_clock:
2017 * @time: the running_time to be reached
2018 * @jitter: (out) (allow-none): the jitter to be filled with time diff, or NULL
2020 * This function will block until @time is reached. It is usually called by
2021 * subclasses that use their own internal synchronisation.
2023 * If @time is not valid, no sycnhronisation is done and #GST_CLOCK_BADTIME is
2024 * returned. Likewise, if synchronisation is disabled in the element or there
2025 * is no clock, no synchronisation is done and #GST_CLOCK_BADTIME is returned.
2027 * This function should only be called with the PREROLL_LOCK held, like when
2028 * receiving an EOS event in the #GstBaseSinkClass.event() vmethod or when
2029 * receiving a buffer in
2030 * the #GstBaseSinkClass.render() vmethod.
2032 * The @time argument should be the running_time of when this method should
2033 * return and is not adjusted with any latency or offset configured in the
2038 * Returns: #GstClockReturn
2041 gst_base_sink_wait_clock (GstBaseSink * sink, GstClockTime time,
2042 GstClockTimeDiff * jitter)
2046 GstClockTime base_time;
2048 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (time)))
2051 GST_OBJECT_LOCK (sink);
2052 if (G_UNLIKELY (!sink->sync))
2055 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (sink)) == NULL))
2058 base_time = GST_ELEMENT_CAST (sink)->base_time;
2059 GST_LOG_OBJECT (sink,
2060 "time %" GST_TIME_FORMAT ", base_time %" GST_TIME_FORMAT,
2061 GST_TIME_ARGS (time), GST_TIME_ARGS (base_time));
2063 /* add base_time to running_time to get the time against the clock */
2066 /* Re-use existing clockid if available */
2067 if (G_LIKELY (sink->priv->cached_clock_id != NULL)) {
2068 if (!gst_clock_single_shot_id_reinit (clock, sink->priv->cached_clock_id,
2070 gst_clock_id_unref (sink->priv->cached_clock_id);
2071 sink->priv->cached_clock_id = gst_clock_new_single_shot_id (clock, time);
2074 sink->priv->cached_clock_id = gst_clock_new_single_shot_id (clock, time);
2075 GST_OBJECT_UNLOCK (sink);
2077 /* A blocking wait is performed on the clock. We save the ClockID
2078 * so we can unlock the entry at any time. While we are blocking, we
2079 * release the PREROLL_LOCK so that other threads can interrupt the
2081 sink->clock_id = sink->priv->cached_clock_id;
2082 /* release the preroll lock while waiting */
2083 GST_BASE_SINK_PREROLL_UNLOCK (sink);
2085 ret = gst_clock_id_wait (sink->priv->cached_clock_id, jitter);
2087 GST_BASE_SINK_PREROLL_LOCK (sink);
2088 sink->clock_id = NULL;
2092 /* no syncing needed */
2095 GST_DEBUG_OBJECT (sink, "time not valid, no sync needed");
2096 return GST_CLOCK_BADTIME;
2100 GST_DEBUG_OBJECT (sink, "sync disabled");
2101 GST_OBJECT_UNLOCK (sink);
2102 return GST_CLOCK_BADTIME;
2106 GST_DEBUG_OBJECT (sink, "no clock, can't sync");
2107 GST_OBJECT_UNLOCK (sink);
2108 return GST_CLOCK_BADTIME;
2113 * gst_base_sink_wait_preroll:
2116 * If the #GstBaseSinkClass.render() method performs its own synchronisation
2117 * against the clock it must unblock when going from PLAYING to the PAUSED state
2118 * and call this method before continuing to render the remaining data.
2120 * This function will block until a state change to PLAYING happens (in which
2121 * case this function returns #GST_FLOW_OK) or the processing must be stopped due
2122 * to a state change to READY or a FLUSH event (in which case this function
2123 * returns #GST_FLOW_WRONG_STATE).
2125 * This function should only be called with the PREROLL_LOCK held, like in the
2128 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2129 * continue. Any other return value should be returned from the render vmethod.
2134 gst_base_sink_wait_preroll (GstBaseSink * sink)
2136 sink->have_preroll = TRUE;
2137 GST_DEBUG_OBJECT (sink, "waiting in preroll for flush or PLAYING");
2138 /* block until the state changes, or we get a flush, or something */
2139 GST_BASE_SINK_PREROLL_WAIT (sink);
2140 sink->have_preroll = FALSE;
2141 if (G_UNLIKELY (sink->flushing))
2143 if (G_UNLIKELY (sink->priv->step_unlock))
2145 GST_DEBUG_OBJECT (sink, "continue after preroll");
2152 GST_DEBUG_OBJECT (sink, "preroll interrupted because of flush");
2153 return GST_FLOW_WRONG_STATE;
2157 sink->priv->step_unlock = FALSE;
2158 GST_DEBUG_OBJECT (sink, "preroll interrupted because of step");
2159 return GST_FLOW_STEP;
2163 static inline guint8
2164 get_object_type (GstMiniObject * obj)
2168 if (G_LIKELY (GST_IS_BUFFER (obj)))
2169 obj_type = _PR_IS_BUFFER;
2170 else if (GST_IS_EVENT (obj))
2171 obj_type = _PR_IS_EVENT;
2172 else if (GST_IS_BUFFER_LIST (obj))
2173 obj_type = _PR_IS_BUFFERLIST;
2175 obj_type = _PR_IS_NOTHING;
2181 * gst_base_sink_do_preroll:
2183 * @obj: (transfer none): the mini object that caused the preroll
2185 * If the @sink spawns its own thread for pulling buffers from upstream it
2186 * should call this method after it has pulled a buffer. If the element needed
2187 * to preroll, this function will perform the preroll and will then block
2188 * until the element state is changed.
2190 * This function should be called with the PREROLL_LOCK held.
2192 * Returns: #GST_FLOW_OK if the preroll completed and processing can
2193 * continue. Any other return value should be returned from the render vmethod.
2198 gst_base_sink_do_preroll (GstBaseSink * sink, GstMiniObject * obj)
2202 while (G_UNLIKELY (sink->need_preroll)) {
2204 GST_DEBUG_OBJECT (sink, "prerolling object %p", obj);
2206 obj_type = get_object_type (obj);
2208 ret = gst_base_sink_preroll_object (sink, obj_type, obj);
2209 if (ret != GST_FLOW_OK)
2210 goto preroll_failed;
2212 /* need to recheck here because the commit state could have
2213 * made us not need the preroll anymore */
2214 if (G_LIKELY (sink->need_preroll)) {
2215 /* block until the state changes, or we get a flush, or something */
2216 ret = gst_base_sink_wait_preroll (sink);
2217 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2218 goto preroll_failed;
2226 GST_DEBUG_OBJECT (sink, "preroll failed: %s", gst_flow_get_name (ret));
2232 * gst_base_sink_wait_eos:
2234 * @time: the running_time to be reached
2235 * @jitter: (out) (allow-none): the jitter to be filled with time diff, or NULL
2237 * This function will block until @time is reached. It is usually called by
2238 * subclasses that use their own internal synchronisation but want to let the
2239 * EOS be handled by the base class.
2241 * This function should only be called with the PREROLL_LOCK held, like when
2242 * receiving an EOS event in the ::event vmethod.
2244 * The @time argument should be the running_time of when the EOS should happen
2245 * and will be adjusted with any latency and offset configured in the sink.
2247 * Returns: #GstFlowReturn
2252 gst_base_sink_wait_eos (GstBaseSink * sink, GstClockTime time,
2253 GstClockTimeDiff * jitter)
2255 GstClockReturn status;
2261 GST_DEBUG_OBJECT (sink, "checking preroll");
2263 /* first wait for the playing state before we can continue */
2264 while (G_UNLIKELY (sink->need_preroll)) {
2265 ret = gst_base_sink_wait_preroll (sink);
2266 if ((ret != GST_FLOW_OK) && (ret != GST_FLOW_STEP))
2270 /* preroll done, we can sync since we are in PLAYING now. */
2271 GST_DEBUG_OBJECT (sink, "possibly waiting for clock to reach %"
2272 GST_TIME_FORMAT, GST_TIME_ARGS (time));
2274 /* compensate for latency and ts_offset. We don't adjust for render delay
2275 * because we don't interact with the device on EOS normally. */
2276 stime = gst_base_sink_adjust_time (sink, time);
2278 /* wait for the clock, this can be interrupted because we got shut down or
2280 status = gst_base_sink_wait_clock (sink, stime, jitter);
2282 GST_DEBUG_OBJECT (sink, "clock returned %d", status);
2284 /* invalid time, no clock or sync disabled, just continue then */
2285 if (status == GST_CLOCK_BADTIME)
2288 /* waiting could have been interrupted and we can be flushing now */
2289 if (G_UNLIKELY (sink->flushing))
2292 /* retry if we got unscheduled, which means we did not reach the timeout
2293 * yet. if some other error occures, we continue. */
2294 } while (status == GST_CLOCK_UNSCHEDULED);
2296 GST_DEBUG_OBJECT (sink, "end of stream");
2303 GST_DEBUG_OBJECT (sink, "we are flushing");
2304 return GST_FLOW_WRONG_STATE;
2308 /* with STREAM_LOCK, PREROLL_LOCK
2310 * Make sure we are in PLAYING and synchronize an object to the clock.
2312 * If we need preroll, we are not in PLAYING. We try to commit the state
2313 * if needed and then block if we still are not PLAYING.
2315 * We start waiting on the clock in PLAYING. If we got interrupted, we
2316 * immediatly try to re-preroll.
2318 * Some objects do not need synchronisation (most events) and so this function
2319 * immediatly returns GST_FLOW_OK.
2321 * for objects that arrive later than max-lateness to be synchronized to the
2322 * clock have the @late boolean set to TRUE.
2324 * This function keeps a running average of the jitter (the diff between the
2325 * clock time and the requested sync time). The jitter is negative for
2326 * objects that arrive in time and positive for late buffers.
2328 * does not take ownership of obj.
2330 static GstFlowReturn
2331 gst_base_sink_do_sync (GstBaseSink * basesink, GstPad * pad,
2332 GstMiniObject * obj, gboolean * late, gboolean * step_end, guint8 obj_type)
2334 GstClockTimeDiff jitter = 0;
2336 GstClockReturn status = GST_CLOCK_OK;
2337 GstClockTime rstart, rstop, sstart, sstop, stime;
2339 GstBaseSinkPrivate *priv;
2341 GstStepInfo *current, *pending;
2344 priv = basesink->priv;
2347 sstart = sstop = rstart = rstop = GST_CLOCK_TIME_NONE;
2351 priv->current_rstart = GST_CLOCK_TIME_NONE;
2353 /* get stepping info */
2354 current = &priv->current_step;
2355 pending = &priv->pending_step;
2357 /* get timing information for this object against the render segment */
2358 syncable = gst_base_sink_get_sync_times (basesink, obj,
2359 &sstart, &sstop, &rstart, &rstop, &do_sync, &stepped, &basesink->segment,
2360 current, step_end, obj_type);
2362 if (G_UNLIKELY (stepped))
2365 /* a syncable object needs to participate in preroll and
2366 * clocking. All buffers and EOS are syncable. */
2367 if (G_UNLIKELY (!syncable))
2370 /* store timing info for current object */
2371 priv->current_rstart = rstart;
2372 priv->current_rstop = (GST_CLOCK_TIME_IS_VALID (rstop) ? rstop : rstart);
2374 /* save sync time for eos when the previous object needed sync */
2375 priv->eos_rtime = (do_sync ? priv->current_rstop : GST_CLOCK_TIME_NONE);
2377 /* calculate inter frame spacing */
2378 if (G_UNLIKELY (priv->prev_rstart != -1 && priv->prev_rstart < rstart)) {
2379 GstClockTime in_diff;
2381 in_diff = rstart - priv->prev_rstart;
2383 if (priv->avg_in_diff == -1)
2384 priv->avg_in_diff = in_diff;
2386 priv->avg_in_diff = UPDATE_RUNNING_AVG (priv->avg_in_diff, in_diff);
2388 GST_LOG_OBJECT (basesink, "avg frame diff %" GST_TIME_FORMAT,
2389 GST_TIME_ARGS (priv->avg_in_diff));
2392 priv->prev_rstart = rstart;
2394 if (G_UNLIKELY (priv->earliest_in_time != -1
2395 && rstart < priv->earliest_in_time))
2399 /* first do preroll, this makes sure we commit our state
2400 * to PAUSED and can continue to PLAYING. We cannot perform
2401 * any clock sync in PAUSED because there is no clock. */
2402 ret = gst_base_sink_do_preroll (basesink, obj);
2403 if (G_UNLIKELY (ret != GST_FLOW_OK))
2404 goto preroll_failed;
2406 /* update the segment with a pending step if the current one is invalid and we
2407 * have a new pending one. We only accept new step updates after a preroll */
2408 if (G_UNLIKELY (pending->valid && !current->valid)) {
2409 start_stepping (basesink, &basesink->segment, pending, current);
2413 /* After rendering we store the position of the last buffer so that we can use
2414 * it to report the position. We need to take the lock here. */
2415 GST_OBJECT_LOCK (basesink);
2416 priv->current_sstart = sstart;
2417 priv->current_sstop = (GST_CLOCK_TIME_IS_VALID (sstop) ? sstop : sstart);
2418 GST_OBJECT_UNLOCK (basesink);
2423 /* adjust for latency */
2424 stime = gst_base_sink_adjust_time (basesink, rstart);
2426 /* adjust for render-delay, avoid underflows */
2427 if (GST_CLOCK_TIME_IS_VALID (stime)) {
2428 if (stime > priv->render_delay)
2429 stime -= priv->render_delay;
2434 /* preroll done, we can sync since we are in PLAYING now. */
2435 GST_DEBUG_OBJECT (basesink, "possibly waiting for clock to reach %"
2436 GST_TIME_FORMAT ", adjusted %" GST_TIME_FORMAT,
2437 GST_TIME_ARGS (rstart), GST_TIME_ARGS (stime));
2439 /* This function will return immediatly if start == -1, no clock
2440 * or sync is disabled with GST_CLOCK_BADTIME. */
2441 status = gst_base_sink_wait_clock (basesink, stime, &jitter);
2443 GST_DEBUG_OBJECT (basesink, "clock returned %d, jitter %c%" GST_TIME_FORMAT,
2444 status, (jitter < 0 ? '-' : ' '), GST_TIME_ARGS (ABS (jitter)));
2446 /* invalid time, no clock or sync disabled, just render */
2447 if (status == GST_CLOCK_BADTIME)
2450 /* waiting could have been interrupted and we can be flushing now */
2451 if (G_UNLIKELY (basesink->flushing))
2454 /* check for unlocked by a state change, we are not flushing so
2455 * we can try to preroll on the current buffer. */
2456 if (G_UNLIKELY (status == GST_CLOCK_UNSCHEDULED)) {
2457 GST_DEBUG_OBJECT (basesink, "unscheduled, waiting some more");
2458 priv->call_preroll = TRUE;
2462 /* successful syncing done, record observation */
2463 priv->current_jitter = jitter;
2465 /* check if the object should be dropped */
2466 *late = gst_base_sink_is_too_late (basesink, obj, rstart, rstop,
2475 GST_DEBUG_OBJECT (basesink, "skipped stepped object %p", obj);
2481 GST_DEBUG_OBJECT (basesink, "non syncable object %p", obj);
2486 GST_DEBUG_OBJECT (basesink, "dropped because of QoS %p", obj);
2492 GST_DEBUG_OBJECT (basesink, "we are flushing");
2493 return GST_FLOW_WRONG_STATE;
2497 GST_DEBUG_OBJECT (basesink, "preroll failed");
2504 gst_base_sink_send_qos (GstBaseSink * basesink, GstQOSType type,
2505 gdouble proportion, GstClockTime time, GstClockTimeDiff diff)
2510 /* generate Quality-of-Service event */
2511 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2512 "qos: type %d, proportion: %lf, diff %" G_GINT64_FORMAT ", timestamp %"
2513 GST_TIME_FORMAT, type, proportion, diff, GST_TIME_ARGS (time));
2515 event = gst_event_new_qos (type, proportion, diff, time);
2518 res = gst_pad_push_event (basesink->sinkpad, event);
2524 gst_base_sink_perform_qos (GstBaseSink * sink, gboolean dropped)
2526 GstBaseSinkPrivate *priv;
2527 GstClockTime start, stop;
2528 GstClockTimeDiff jitter;
2529 GstClockTime pt, entered, left;
2530 GstClockTime duration;
2535 start = priv->current_rstart;
2537 if (priv->current_step.valid)
2540 /* if Quality-of-Service disabled, do nothing */
2541 if (!g_atomic_int_get (&priv->qos_enabled) ||
2542 !GST_CLOCK_TIME_IS_VALID (start))
2545 stop = priv->current_rstop;
2546 jitter = priv->current_jitter;
2549 /* this is the time the buffer entered the sink */
2550 if (start < -jitter)
2553 entered = start + jitter;
2556 /* this is the time the buffer entered the sink */
2557 entered = start + jitter;
2558 /* this is the time the buffer left the sink */
2559 left = start + jitter;
2562 /* calculate duration of the buffer */
2563 if (GST_CLOCK_TIME_IS_VALID (stop) && stop != start)
2564 duration = stop - start;
2566 duration = priv->avg_in_diff;
2568 /* if we have the time when the last buffer left us, calculate
2569 * processing time */
2570 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2571 if (entered > priv->last_left) {
2572 pt = entered - priv->last_left;
2580 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "start: %" GST_TIME_FORMAT
2581 ", stop %" GST_TIME_FORMAT ", entered %" GST_TIME_FORMAT ", left %"
2582 GST_TIME_FORMAT ", pt: %" GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT
2583 ",jitter %" G_GINT64_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (stop),
2584 GST_TIME_ARGS (entered), GST_TIME_ARGS (left), GST_TIME_ARGS (pt),
2585 GST_TIME_ARGS (duration), jitter);
2587 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink, "avg_duration: %" GST_TIME_FORMAT
2588 ", avg_pt: %" GST_TIME_FORMAT ", avg_rate: %g",
2589 GST_TIME_ARGS (priv->avg_duration), GST_TIME_ARGS (priv->avg_pt),
2592 /* collect running averages. for first observations, we copy the
2594 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_duration))
2595 priv->avg_duration = duration;
2597 priv->avg_duration = UPDATE_RUNNING_AVG (priv->avg_duration, duration);
2599 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_pt))
2602 priv->avg_pt = UPDATE_RUNNING_AVG (priv->avg_pt, pt);
2604 if (priv->avg_duration != 0)
2606 gst_guint64_to_gdouble (priv->avg_pt) /
2607 gst_guint64_to_gdouble (priv->avg_duration);
2611 if (GST_CLOCK_TIME_IS_VALID (priv->last_left)) {
2612 if (dropped || priv->avg_rate < 0.0) {
2613 priv->avg_rate = rate;
2616 priv->avg_rate = UPDATE_RUNNING_AVG_N (priv->avg_rate, rate);
2618 priv->avg_rate = UPDATE_RUNNING_AVG_P (priv->avg_rate, rate);
2622 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, sink,
2623 "updated: avg_duration: %" GST_TIME_FORMAT ", avg_pt: %" GST_TIME_FORMAT
2624 ", avg_rate: %g", GST_TIME_ARGS (priv->avg_duration),
2625 GST_TIME_ARGS (priv->avg_pt), priv->avg_rate);
2628 if (priv->avg_rate >= 0.0) {
2630 GstClockTimeDiff diff;
2632 /* if we have a valid rate, start sending QoS messages */
2633 if (priv->current_jitter < 0) {
2634 /* make sure we never go below 0 when adding the jitter to the
2636 if (priv->current_rstart < -priv->current_jitter)
2637 priv->current_jitter = -priv->current_rstart;
2640 if (priv->throttle_time > 0) {
2641 diff = priv->throttle_time;
2642 type = GST_QOS_TYPE_THROTTLE;
2644 diff = priv->current_jitter;
2646 type = GST_QOS_TYPE_OVERFLOW;
2648 type = GST_QOS_TYPE_UNDERFLOW;
2651 gst_base_sink_send_qos (sink, type, priv->avg_rate, priv->current_rstart,
2655 /* record when this buffer will leave us */
2656 priv->last_left = left;
2659 /* reset all qos measuring */
2661 gst_base_sink_reset_qos (GstBaseSink * sink)
2663 GstBaseSinkPrivate *priv;
2667 priv->last_render_time = GST_CLOCK_TIME_NONE;
2668 priv->prev_rstart = GST_CLOCK_TIME_NONE;
2669 priv->earliest_in_time = GST_CLOCK_TIME_NONE;
2670 priv->last_left = GST_CLOCK_TIME_NONE;
2671 priv->avg_duration = GST_CLOCK_TIME_NONE;
2672 priv->avg_pt = GST_CLOCK_TIME_NONE;
2673 priv->avg_rate = -1.0;
2674 priv->avg_render = GST_CLOCK_TIME_NONE;
2675 priv->avg_in_diff = GST_CLOCK_TIME_NONE;
2681 /* Checks if the object was scheduled too late.
2683 * rstart/rstop contain the running_time start and stop values
2686 * status and jitter contain the return values from the clock wait.
2688 * returns TRUE if the buffer was too late.
2691 gst_base_sink_is_too_late (GstBaseSink * basesink, GstMiniObject * obj,
2692 GstClockTime rstart, GstClockTime rstop,
2693 GstClockReturn status, GstClockTimeDiff jitter)
2696 guint64 max_lateness;
2697 GstBaseSinkPrivate *priv;
2699 priv = basesink->priv;
2703 /* only for objects that were too late */
2704 if (G_LIKELY (status != GST_CLOCK_EARLY))
2707 max_lateness = basesink->max_lateness;
2709 /* check if frame dropping is enabled */
2710 if (max_lateness == -1)
2713 /* only check for buffers */
2714 if (G_UNLIKELY (!GST_IS_BUFFER (obj)))
2717 /* can't do check if we don't have a timestamp */
2718 if (G_UNLIKELY (!GST_CLOCK_TIME_IS_VALID (rstart)))
2721 /* we can add a valid stop time */
2722 if (GST_CLOCK_TIME_IS_VALID (rstop))
2723 max_lateness += rstop;
2725 max_lateness += rstart;
2726 /* no stop time, use avg frame diff */
2727 if (priv->avg_in_diff != -1)
2728 max_lateness += priv->avg_in_diff;
2731 /* if the jitter bigger than duration and lateness we are too late */
2732 if ((late = rstart + jitter > max_lateness)) {
2733 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2734 "buffer is too late %" GST_TIME_FORMAT
2735 " > %" GST_TIME_FORMAT, GST_TIME_ARGS (rstart + jitter),
2736 GST_TIME_ARGS (max_lateness));
2737 /* !!emergency!!, if we did not receive anything valid for more than a
2738 * second, render it anyway so the user sees something */
2739 if (GST_CLOCK_TIME_IS_VALID (priv->last_render_time) &&
2740 rstart - priv->last_render_time > GST_SECOND) {
2742 GST_ELEMENT_WARNING (basesink, CORE, CLOCK,
2743 (_("A lot of buffers are being dropped.")),
2744 ("There may be a timestamping problem, or this computer is too slow."));
2745 GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, basesink,
2746 "**emergency** last buffer at %" GST_TIME_FORMAT " > GST_SECOND",
2747 GST_TIME_ARGS (priv->last_render_time));
2752 if (!late || !GST_CLOCK_TIME_IS_VALID (priv->last_render_time)) {
2753 priv->last_render_time = rstart;
2754 /* the next allowed input timestamp */
2755 if (priv->throttle_time > 0)
2756 priv->earliest_in_time = rstart + priv->throttle_time;
2763 GST_DEBUG_OBJECT (basesink, "object was scheduled in time");
2768 GST_DEBUG_OBJECT (basesink, "frame dropping disabled");
2773 GST_DEBUG_OBJECT (basesink, "object is not a buffer");
2778 GST_DEBUG_OBJECT (basesink, "buffer has no timestamp");
2783 /* called before and after calling the render vmethod. It keeps track of how
2784 * much time was spent in the render method and is used to check if we are
2787 gst_base_sink_do_render_stats (GstBaseSink * basesink, gboolean start)
2789 GstBaseSinkPrivate *priv;
2791 priv = basesink->priv;
2794 priv->start = gst_util_get_timestamp ();
2796 GstClockTime elapsed;
2798 priv->stop = gst_util_get_timestamp ();
2800 elapsed = GST_CLOCK_DIFF (priv->start, priv->stop);
2802 if (!GST_CLOCK_TIME_IS_VALID (priv->avg_render))
2803 priv->avg_render = elapsed;
2805 priv->avg_render = UPDATE_RUNNING_AVG (priv->avg_render, elapsed);
2807 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
2808 "avg_render: %" GST_TIME_FORMAT, GST_TIME_ARGS (priv->avg_render));
2812 /* with STREAM_LOCK, PREROLL_LOCK,
2814 * Synchronize the object on the clock and then render it.
2816 * takes ownership of obj.
2818 static GstFlowReturn
2819 gst_base_sink_render_object (GstBaseSink * basesink, GstPad * pad,
2820 guint8 obj_type, gpointer obj)
2823 GstBaseSinkClass *bclass;
2824 gboolean late, step_end;
2826 GstBaseSinkPrivate *priv;
2828 priv = basesink->priv;
2830 if (OBJ_IS_BUFFERLIST (obj_type)) {
2832 * If buffer list, use the first group buffer within the list
2835 sync_obj = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0);
2836 g_assert (NULL != sync_obj);
2845 /* synchronize this object, non syncable objects return OK
2848 gst_base_sink_do_sync (basesink, pad, sync_obj, &late, &step_end,
2850 if (G_UNLIKELY (ret != GST_FLOW_OK))
2853 /* and now render, event or buffer/buffer list. */
2854 if (G_LIKELY (OBJ_IS_BUFFERFULL (obj_type))) {
2855 /* drop late buffers unconditionally, let's hope it's unlikely */
2856 if (G_UNLIKELY (late))
2859 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2861 if (G_LIKELY ((OBJ_IS_BUFFERLIST (obj_type) && bclass->render_list) ||
2862 (!OBJ_IS_BUFFERLIST (obj_type) && bclass->render))) {
2865 /* read once, to get same value before and after */
2866 do_qos = g_atomic_int_get (&priv->qos_enabled);
2868 GST_DEBUG_OBJECT (basesink, "rendering object %p", obj);
2870 /* record rendering time for QoS and stats */
2872 gst_base_sink_do_render_stats (basesink, TRUE);
2874 if (!OBJ_IS_BUFFERLIST (obj_type)) {
2877 /* For buffer lists do not set last buffer. Creating buffer
2878 * with meaningful data can be done only with memcpy which will
2879 * significantly affect performance */
2880 buf = GST_BUFFER_CAST (obj);
2881 gst_base_sink_set_last_buffer (basesink, buf);
2883 ret = bclass->render (basesink, buf);
2885 GstBufferList *buflist;
2887 buflist = GST_BUFFER_LIST_CAST (obj);
2889 ret = bclass->render_list (basesink, buflist);
2893 gst_base_sink_do_render_stats (basesink, FALSE);
2895 if (ret == GST_FLOW_STEP)
2898 if (G_UNLIKELY (basesink->flushing))
2903 } else if (G_LIKELY (OBJ_IS_EVENT (obj_type))) {
2904 GstEvent *event = GST_EVENT_CAST (obj);
2905 gboolean event_res = TRUE;
2908 bclass = GST_BASE_SINK_GET_CLASS (basesink);
2910 type = GST_EVENT_TYPE (event);
2912 GST_DEBUG_OBJECT (basesink, "rendering event %p, type %s", obj,
2913 gst_event_type_get_name (type));
2916 event_res = bclass->event (basesink, event);
2918 /* when we get here we could be flushing again when the event handler calls
2919 * _wait_eos(). We have to ignore this object in that case. */
2920 if (G_UNLIKELY (basesink->flushing))
2923 if (G_LIKELY (event_res)) {
2926 seqnum = basesink->priv->seqnum = gst_event_get_seqnum (event);
2927 GST_DEBUG_OBJECT (basesink, "Got seqnum #%" G_GUINT32_FORMAT, seqnum);
2932 GstMessage *message;
2934 /* the EOS event is completely handled so we mark
2935 * ourselves as being in the EOS state. eos is also
2936 * protected by the object lock so we can read it when
2937 * answering the POSITION query. */
2938 GST_OBJECT_LOCK (basesink);
2939 basesink->eos = TRUE;
2940 GST_OBJECT_UNLOCK (basesink);
2942 /* ok, now we can post the message */
2943 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
2945 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
2946 gst_message_set_seqnum (message, seqnum);
2947 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
2950 case GST_EVENT_SEGMENT:
2951 /* configure the segment */
2952 gst_base_sink_configure_segment (basesink, pad, event,
2953 &basesink->segment);
2955 case GST_EVENT_SINK_MESSAGE:{
2956 GstMessage *msg = NULL;
2958 gst_event_parse_sink_message (event, &msg);
2961 gst_element_post_message (GST_ELEMENT_CAST (basesink), msg);
2968 g_return_val_if_reached (GST_FLOW_ERROR);
2973 /* the step ended, check if we need to activate a new step */
2974 GST_DEBUG_OBJECT (basesink, "step ended");
2975 stop_stepping (basesink, &basesink->segment, &priv->current_step,
2976 priv->current_rstart, priv->current_rstop, basesink->eos);
2980 gst_base_sink_perform_qos (basesink, late);
2982 GST_DEBUG_OBJECT (basesink, "object unref after render %p", obj);
2983 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
2989 GST_DEBUG_OBJECT (basesink, "do_sync returned %s", gst_flow_get_name (ret));
2995 GST_DEBUG_OBJECT (basesink, "buffer late, dropping");
2997 if (g_atomic_int_get (&priv->qos_enabled)) {
2998 GstMessage *qos_msg;
2999 GstClockTime timestamp, duration;
3001 timestamp = GST_BUFFER_TIMESTAMP (GST_BUFFER_CAST (sync_obj));
3002 duration = GST_BUFFER_DURATION (GST_BUFFER_CAST (sync_obj));
3004 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
3005 "qos: dropped buffer rt %" GST_TIME_FORMAT ", st %" GST_TIME_FORMAT
3006 ", ts %" GST_TIME_FORMAT ", dur %" GST_TIME_FORMAT,
3007 GST_TIME_ARGS (priv->current_rstart),
3008 GST_TIME_ARGS (priv->current_sstart), GST_TIME_ARGS (timestamp),
3009 GST_TIME_ARGS (duration));
3010 GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, basesink,
3011 "qos: rendered %" G_GUINT64_FORMAT ", dropped %" G_GUINT64_FORMAT,
3012 priv->rendered, priv->dropped);
3015 gst_message_new_qos (GST_OBJECT_CAST (basesink), basesink->sync,
3016 priv->current_rstart, priv->current_sstart, timestamp, duration);
3017 gst_message_set_qos_values (qos_msg, priv->current_jitter, priv->avg_rate,
3019 gst_message_set_qos_stats (qos_msg, GST_FORMAT_BUFFERS, priv->rendered,
3021 gst_element_post_message (GST_ELEMENT_CAST (basesink), qos_msg);
3027 GST_DEBUG_OBJECT (basesink, "we are flushing, ignore object");
3028 gst_mini_object_unref (obj);
3029 return GST_FLOW_WRONG_STATE;
3033 /* with STREAM_LOCK, PREROLL_LOCK
3035 * Perform preroll on the given object. For buffers this means
3036 * calling the preroll subclass method.
3037 * If that succeeds, the state will be commited.
3039 * function does not take ownership of obj.
3041 static GstFlowReturn
3042 gst_base_sink_preroll_object (GstBaseSink * basesink, guint8 obj_type,
3043 GstMiniObject * obj)
3047 GST_DEBUG_OBJECT (basesink, "prerolling object %p", obj);
3049 /* if it's a buffer, we need to call the preroll method */
3050 if (G_LIKELY (OBJ_IS_BUFFERFULL (obj_type) && basesink->priv->call_preroll)) {
3051 GstBaseSinkClass *bclass;
3053 GstClockTime timestamp;
3055 if (OBJ_IS_BUFFERLIST (obj_type)) {
3056 buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0);
3057 g_assert (NULL != buf);
3059 buf = GST_BUFFER_CAST (obj);
3062 timestamp = GST_BUFFER_TIMESTAMP (buf);
3064 GST_DEBUG_OBJECT (basesink, "preroll buffer %" GST_TIME_FORMAT,
3065 GST_TIME_ARGS (timestamp));
3068 * For buffer lists do not set last buffer. Creating buffer
3069 * with meaningful data can be done only with memcpy which will
3070 * significantly affect performance
3072 if (!OBJ_IS_BUFFERLIST (obj_type)) {
3073 gst_base_sink_set_last_buffer (basesink, buf);
3076 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3077 if (bclass->preroll)
3078 if ((ret = bclass->preroll (basesink, buf)) != GST_FLOW_OK)
3079 goto preroll_failed;
3081 basesink->priv->call_preroll = FALSE;
3085 if (G_LIKELY (basesink->playing_async)) {
3086 if (G_UNLIKELY (!gst_base_sink_commit_state (basesink)))
3095 GST_DEBUG_OBJECT (basesink, "preroll failed, abort state");
3096 gst_element_abort_state (GST_ELEMENT_CAST (basesink));
3101 GST_DEBUG_OBJECT (basesink, "stopping while commiting state");
3102 return GST_FLOW_WRONG_STATE;
3106 /* with STREAM_LOCK, PREROLL_LOCK
3108 * Queue an object for rendering.
3109 * The first prerollable object queued will complete the preroll. If the
3110 * preroll queue if filled, we render all the objects in the queue.
3112 * This function takes ownership of the object.
3114 static GstFlowReturn
3115 gst_base_sink_queue_object_unlocked (GstBaseSink * basesink, GstPad * pad,
3116 guint8 obj_type, gpointer obj, gboolean prerollable)
3118 GstFlowReturn ret = GST_FLOW_OK;
3122 if (G_UNLIKELY (basesink->need_preroll)) {
3123 if (G_LIKELY (prerollable))
3124 basesink->preroll_queued++;
3126 length = basesink->preroll_queued;
3128 GST_DEBUG_OBJECT (basesink, "now %d prerolled items", length);
3130 /* first prerollable item needs to finish the preroll */
3132 ret = gst_base_sink_preroll_object (basesink, obj_type, obj);
3133 if (G_UNLIKELY (ret != GST_FLOW_OK))
3134 goto preroll_failed;
3136 /* need to recheck if we need preroll, commmit state during preroll
3137 * could have made us not need more preroll. */
3138 if (G_UNLIKELY (basesink->need_preroll)) {
3139 /* see if we can render now, if we can't add the object to the preroll
3141 if (G_UNLIKELY (length <= basesink->preroll_queue_max_len))
3145 /* we can start rendering (or blocking) the queued object
3147 q = basesink->preroll_queue;
3148 while (G_UNLIKELY (!g_queue_is_empty (q))) {
3152 o = g_queue_pop_head (q);
3153 GST_DEBUG_OBJECT (basesink, "rendering queued object %p", o);
3155 ot = get_object_type (o);
3157 /* do something with the return value */
3158 ret = gst_base_sink_render_object (basesink, pad, ot, o);
3159 if (ret != GST_FLOW_OK)
3160 goto dequeue_failed;
3163 /* now render the object */
3164 ret = gst_base_sink_render_object (basesink, pad, obj_type, obj);
3165 basesink->preroll_queued = 0;
3172 GST_DEBUG_OBJECT (basesink, "preroll failed, reason %s",
3173 gst_flow_get_name (ret));
3174 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3179 /* add object to the queue and return */
3180 GST_DEBUG_OBJECT (basesink, "need more preroll data %d <= %d",
3181 length, basesink->preroll_queue_max_len);
3182 g_queue_push_tail (basesink->preroll_queue, obj);
3187 GST_DEBUG_OBJECT (basesink, "rendering queued objects failed, reason %s",
3188 gst_flow_get_name (ret));
3189 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3196 * This function grabs the PREROLL_LOCK and adds the object to
3199 * This function takes ownership of obj.
3201 * Note: Only GstEvent seem to be passed to this private method
3203 static GstFlowReturn
3204 gst_base_sink_queue_object (GstBaseSink * basesink, GstPad * pad,
3205 GstMiniObject * obj, gboolean prerollable)
3209 GST_BASE_SINK_PREROLL_LOCK (basesink);
3210 if (G_UNLIKELY (basesink->flushing))
3213 if (G_UNLIKELY (basesink->priv->received_eos))
3217 gst_base_sink_queue_object_unlocked (basesink, pad, _PR_IS_EVENT, obj,
3219 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3226 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3227 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3228 gst_mini_object_unref (obj);
3229 return GST_FLOW_WRONG_STATE;
3233 GST_DEBUG_OBJECT (basesink,
3234 "we are EOS, dropping object, return UNEXPECTED");
3235 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3236 gst_mini_object_unref (obj);
3237 return GST_FLOW_UNEXPECTED;
3242 gst_base_sink_flush_start (GstBaseSink * basesink, GstPad * pad)
3244 /* make sure we are not blocked on the clock also clear any pending
3246 gst_base_sink_set_flushing (basesink, pad, TRUE);
3248 /* we grab the stream lock but that is not needed since setting the
3249 * sink to flushing would make sure no state commit is being done
3251 GST_PAD_STREAM_LOCK (pad);
3252 gst_base_sink_reset_qos (basesink);
3253 /* and we need to commit our state again on the next
3254 * prerolled buffer */
3255 basesink->playing_async = TRUE;
3256 if (basesink->priv->async_enabled) {
3257 gst_element_lost_state (GST_ELEMENT_CAST (basesink), TRUE);
3259 basesink->priv->have_latency = TRUE;
3261 gst_base_sink_set_last_buffer (basesink, NULL);
3262 GST_PAD_STREAM_UNLOCK (pad);
3266 gst_base_sink_flush_stop (GstBaseSink * basesink, GstPad * pad)
3268 /* unset flushing so we can accept new data, this also flushes out any EOS
3270 gst_base_sink_set_flushing (basesink, pad, FALSE);
3272 /* for position reporting */
3273 GST_OBJECT_LOCK (basesink);
3274 basesink->priv->current_sstart = GST_CLOCK_TIME_NONE;
3275 basesink->priv->current_sstop = GST_CLOCK_TIME_NONE;
3276 basesink->priv->eos_rtime = GST_CLOCK_TIME_NONE;
3277 basesink->priv->call_preroll = TRUE;
3278 basesink->priv->current_step.valid = FALSE;
3279 basesink->priv->pending_step.valid = FALSE;
3280 if (basesink->pad_mode == GST_ACTIVATE_PUSH) {
3281 /* we need new segment info after the flush. */
3282 basesink->have_newsegment = FALSE;
3283 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
3284 gst_segment_init (basesink->clip_segment, GST_FORMAT_UNDEFINED);
3286 GST_OBJECT_UNLOCK (basesink);
3290 gst_base_sink_event (GstPad * pad, GstEvent * event)
3292 GstBaseSink *basesink;
3293 gboolean result = TRUE;
3294 GstBaseSinkClass *bclass;
3296 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
3297 if (G_UNLIKELY (basesink == NULL)) {
3298 gst_event_unref (event);
3302 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3304 GST_DEBUG_OBJECT (basesink, "received event %p %" GST_PTR_FORMAT, event,
3307 switch (GST_EVENT_TYPE (event)) {
3312 GST_BASE_SINK_PREROLL_LOCK (basesink);
3313 if (G_UNLIKELY (basesink->flushing))
3316 if (G_UNLIKELY (basesink->priv->received_eos)) {
3317 /* we can't accept anything when we are EOS */
3319 gst_event_unref (event);
3321 /* we set the received EOS flag here so that we can use it when testing if
3322 * we are prerolled and to refuse more buffers. */
3323 basesink->priv->received_eos = TRUE;
3325 /* EOS is a prerollable object, we call the unlocked version because it
3326 * does not check the received_eos flag. */
3327 ret = gst_base_sink_queue_object_unlocked (basesink, pad,
3328 _PR_IS_EVENT, GST_MINI_OBJECT_CAST (event), TRUE);
3329 if (G_UNLIKELY (ret != GST_FLOW_OK))
3332 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3335 case GST_EVENT_CAPS:
3339 GST_DEBUG_OBJECT (basesink, "caps %p", event);
3341 gst_event_parse_caps (event, &caps);
3342 if (bclass->set_caps)
3343 result = bclass->set_caps (basesink, caps);
3345 gst_event_unref (event);
3348 case GST_EVENT_SEGMENT:
3352 GST_DEBUG_OBJECT (basesink, "segment %p", event);
3354 GST_BASE_SINK_PREROLL_LOCK (basesink);
3355 if (G_UNLIKELY (basesink->flushing))
3358 /* the new segment is a non prerollable item and does not block anything,
3359 * we need to configure the current clipping segment and insert the event
3360 * in the queue to serialize it with the buffers for rendering. */
3361 gst_base_sink_configure_segment (basesink, pad, event,
3362 basesink->clip_segment);
3365 gst_base_sink_queue_object_unlocked (basesink, pad,
3366 _PR_IS_EVENT, GST_MINI_OBJECT_CAST (event), FALSE);
3367 if (G_UNLIKELY (ret != GST_FLOW_OK))
3370 GST_OBJECT_LOCK (basesink);
3371 basesink->have_newsegment = TRUE;
3372 GST_OBJECT_UNLOCK (basesink);
3374 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3377 case GST_EVENT_FLUSH_START:
3379 bclass->event (basesink, event);
3381 GST_DEBUG_OBJECT (basesink, "flush-start %p", event);
3383 gst_base_sink_flush_start (basesink, pad);
3385 gst_event_unref (event);
3387 case GST_EVENT_FLUSH_STOP:
3389 bclass->event (basesink, event);
3391 GST_DEBUG_OBJECT (basesink, "flush-stop %p", event);
3393 gst_base_sink_flush_stop (basesink, pad);
3395 gst_event_unref (event);
3398 /* other events are sent to queue or subclass depending on if they
3399 * are serialized. */
3400 if (GST_EVENT_IS_SERIALIZED (event)) {
3401 gst_base_sink_queue_object (basesink, pad,
3402 GST_MINI_OBJECT_CAST (event), FALSE);
3405 bclass->event (basesink, event);
3406 gst_event_unref (event);
3411 gst_object_unref (basesink);
3418 GST_DEBUG_OBJECT (basesink, "we are flushing");
3419 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3421 gst_event_unref (event);
3426 /* default implementation to calculate the start and end
3427 * timestamps on a buffer, subclasses can override
3430 gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
3431 GstClockTime * start, GstClockTime * end)
3433 GstClockTime timestamp, duration;
3435 timestamp = GST_BUFFER_TIMESTAMP (buffer);
3436 if (GST_CLOCK_TIME_IS_VALID (timestamp)) {
3438 /* get duration to calculate end time */
3439 duration = GST_BUFFER_DURATION (buffer);
3440 if (GST_CLOCK_TIME_IS_VALID (duration)) {
3441 *end = timestamp + duration;
3447 /* must be called with PREROLL_LOCK */
3449 gst_base_sink_needs_preroll (GstBaseSink * basesink)
3451 gboolean is_prerolled, res;
3453 /* we have 2 cases where the PREROLL_LOCK is released:
3454 * 1) we are blocking in the PREROLL_LOCK and thus are prerolled.
3455 * 2) we are syncing on the clock
3457 is_prerolled = basesink->have_preroll || basesink->priv->received_eos;
3458 res = !is_prerolled;
3460 GST_DEBUG_OBJECT (basesink, "have_preroll: %d, EOS: %d => needs preroll: %d",
3461 basesink->have_preroll, basesink->priv->received_eos, res);
3466 /* with STREAM_LOCK, PREROLL_LOCK
3468 * Takes a buffer and compare the timestamps with the last segment.
3469 * If the buffer falls outside of the segment boundaries, drop it.
3470 * Else queue the buffer for preroll and rendering.
3472 * This function takes ownership of the buffer.
3474 static GstFlowReturn
3475 gst_base_sink_chain_unlocked (GstBaseSink * basesink, GstPad * pad,
3476 guint8 obj_type, gpointer obj)
3478 GstBaseSinkClass *bclass;
3479 GstFlowReturn result;
3480 GstClockTime start = GST_CLOCK_TIME_NONE, end = GST_CLOCK_TIME_NONE;
3481 GstSegment *clip_segment;
3482 GstBuffer *time_buf;
3484 if (G_UNLIKELY (basesink->flushing))
3487 if (G_UNLIKELY (basesink->priv->received_eos))
3490 if (OBJ_IS_BUFFERLIST (obj_type)) {
3491 time_buf = gst_buffer_list_get (GST_BUFFER_LIST_CAST (obj), 0);
3492 g_assert (NULL != time_buf);
3494 time_buf = GST_BUFFER_CAST (obj);
3497 /* for code clarity */
3498 clip_segment = basesink->clip_segment;
3500 if (G_UNLIKELY (!basesink->have_newsegment)) {
3503 sync = gst_base_sink_get_sync (basesink);
3505 GST_ELEMENT_WARNING (basesink, STREAM, FAILED,
3506 (_("Internal data flow problem.")),
3507 ("Received buffer without a new-segment. Assuming timestamps start from 0."));
3510 /* this means this sink will assume timestamps start from 0 */
3511 GST_OBJECT_LOCK (basesink);
3512 clip_segment->start = 0;
3513 clip_segment->stop = -1;
3514 basesink->segment.start = 0;
3515 basesink->segment.stop = -1;
3516 basesink->have_newsegment = TRUE;
3517 GST_OBJECT_UNLOCK (basesink);
3520 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3522 /* check if the buffer needs to be dropped, we first ask the subclass for the
3524 if (bclass->get_times)
3525 bclass->get_times (basesink, time_buf, &start, &end);
3527 if (!GST_CLOCK_TIME_IS_VALID (start)) {
3528 /* if the subclass does not want sync, we use our own values so that we at
3529 * least clip the buffer to the segment */
3530 gst_base_sink_get_times (basesink, time_buf, &start, &end);
3533 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
3534 ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (end));
3536 /* a dropped buffer does not participate in anything */
3537 if (GST_CLOCK_TIME_IS_VALID (start) &&
3538 (clip_segment->format == GST_FORMAT_TIME)) {
3539 if (G_UNLIKELY (!gst_segment_clip (clip_segment,
3540 GST_FORMAT_TIME, start, end, NULL, NULL)))
3541 goto out_of_segment;
3544 /* now we can process the buffer in the queue, this function takes ownership
3546 result = gst_base_sink_queue_object_unlocked (basesink, pad,
3547 obj_type, obj, TRUE);
3553 GST_DEBUG_OBJECT (basesink, "sink is flushing");
3554 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3555 return GST_FLOW_WRONG_STATE;
3559 GST_DEBUG_OBJECT (basesink,
3560 "we are EOS, dropping object, return UNEXPECTED");
3561 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3562 return GST_FLOW_UNEXPECTED;
3566 GST_DEBUG_OBJECT (basesink, "dropping buffer, out of clipping segment");
3567 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3574 static GstFlowReturn
3575 gst_base_sink_chain_main (GstBaseSink * basesink, GstPad * pad,
3576 guint8 obj_type, gpointer obj)
3578 GstFlowReturn result;
3580 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH))
3583 GST_BASE_SINK_PREROLL_LOCK (basesink);
3584 result = gst_base_sink_chain_unlocked (basesink, pad, obj_type, obj);
3585 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3593 GST_OBJECT_LOCK (pad);
3594 GST_WARNING_OBJECT (basesink,
3595 "Push on pad %s:%s, but it was not activated in push mode",
3596 GST_DEBUG_PAD_NAME (pad));
3597 GST_OBJECT_UNLOCK (pad);
3598 gst_mini_object_unref (GST_MINI_OBJECT_CAST (obj));
3599 /* we don't post an error message this will signal to the peer
3600 * pushing that EOS is reached. */
3601 result = GST_FLOW_UNEXPECTED;
3606 static GstFlowReturn
3607 gst_base_sink_chain (GstPad * pad, GstBuffer * buf)
3609 GstBaseSink *basesink;
3611 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3613 return gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFER, buf);
3616 static GstFlowReturn
3617 gst_base_sink_chain_list (GstPad * pad, GstBufferList * list)
3619 GstBaseSink *basesink;
3620 GstBaseSinkClass *bclass;
3621 GstFlowReturn result;
3623 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3624 bclass = GST_BASE_SINK_GET_CLASS (basesink);
3626 if (G_LIKELY (bclass->render_list)) {
3627 result = gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFERLIST, list);
3632 GST_INFO_OBJECT (pad, "chaining each group in list as a merged buffer");
3634 len = gst_buffer_list_len (list);
3636 result = GST_FLOW_OK;
3637 for (i = 0; i < len; i++) {
3638 buffer = gst_buffer_list_get (list, 0);
3639 result = gst_base_sink_chain_main (basesink, pad, _PR_IS_BUFFER,
3640 gst_buffer_ref (buffer));
3641 if (result != GST_FLOW_OK)
3644 gst_buffer_list_unref (list);
3651 gst_base_sink_default_do_seek (GstBaseSink * sink, GstSegment * segment)
3653 gboolean res = TRUE;
3655 /* update our offset if the start/stop position was updated */
3656 if (segment->format == GST_FORMAT_BYTES) {
3657 segment->time = segment->start;
3658 } else if (segment->start == 0) {
3659 /* seek to start, we can implement a default for this. */
3663 GST_INFO_OBJECT (sink, "Can't do a default seek");
3669 #define SEEK_TYPE_IS_RELATIVE(t) (((t) != GST_SEEK_TYPE_NONE) && ((t) != GST_SEEK_TYPE_SET))
3672 gst_base_sink_default_prepare_seek_segment (GstBaseSink * sink,
3673 GstEvent * event, GstSegment * segment)
3675 /* By default, we try one of 2 things:
3676 * - For absolute seek positions, convert the requested position to our
3677 * configured processing format and place it in the output segment \
3678 * - For relative seek positions, convert our current (input) values to the
3679 * seek format, adjust by the relative seek offset and then convert back to
3680 * the processing format
3682 GstSeekType cur_type, stop_type;
3685 GstFormat seek_format, dest_format;
3688 gboolean res = TRUE;
3690 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3691 &cur_type, &cur, &stop_type, &stop);
3692 dest_format = segment->format;
3694 if (seek_format == dest_format) {
3695 gst_segment_do_seek (segment, rate, seek_format, flags,
3696 cur_type, cur, stop_type, stop, &update);
3700 if (cur_type != GST_SEEK_TYPE_NONE) {
3701 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3703 gst_pad_query_convert (sink->sinkpad, seek_format, cur, &dest_format,
3705 cur_type = GST_SEEK_TYPE_SET;
3708 if (res && stop_type != GST_SEEK_TYPE_NONE) {
3709 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
3711 gst_pad_query_convert (sink->sinkpad, seek_format, stop, &dest_format,
3713 stop_type = GST_SEEK_TYPE_SET;
3716 /* And finally, configure our output segment in the desired format */
3717 gst_segment_do_seek (segment, rate, dest_format, flags, cur_type, cur,
3718 stop_type, stop, &update);
3727 GST_DEBUG_OBJECT (sink, "undefined format given, seek aborted.");
3732 /* perform a seek, only executed in pull mode */
3734 gst_base_sink_perform_seek (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3738 GstFormat seek_format, dest_format;
3740 GstSeekType cur_type, stop_type;
3741 gboolean seekseg_configured = FALSE;
3743 gboolean update, res = TRUE;
3744 GstSegment seeksegment;
3746 dest_format = sink->segment.format;
3749 GST_DEBUG_OBJECT (sink, "performing seek with event %p", event);
3750 gst_event_parse_seek (event, &rate, &seek_format, &flags,
3751 &cur_type, &cur, &stop_type, &stop);
3753 flush = flags & GST_SEEK_FLAG_FLUSH;
3755 GST_DEBUG_OBJECT (sink, "performing seek without event");
3760 GST_DEBUG_OBJECT (sink, "flushing upstream");
3761 gst_pad_push_event (pad, gst_event_new_flush_start ());
3762 gst_base_sink_flush_start (sink, pad);
3764 GST_DEBUG_OBJECT (sink, "pausing pulling thread");
3767 GST_PAD_STREAM_LOCK (pad);
3769 /* If we configured the seeksegment above, don't overwrite it now. Otherwise
3770 * copy the current segment info into the temp segment that we can actually
3771 * attempt the seek with. We only update the real segment if the seek suceeds. */
3772 if (!seekseg_configured) {
3773 memcpy (&seeksegment, &sink->segment, sizeof (GstSegment));
3775 /* now configure the final seek segment */
3777 if (sink->segment.format != seek_format) {
3778 /* OK, here's where we give the subclass a chance to convert the relative
3779 * seek into an absolute one in the processing format. We set up any
3780 * absolute seek above, before taking the stream lock. */
3781 if (!gst_base_sink_default_prepare_seek_segment (sink, event,
3783 GST_DEBUG_OBJECT (sink,
3784 "Preparing the seek failed after flushing. " "Aborting seek");
3788 /* The seek format matches our processing format, no need to ask the
3789 * the subclass to configure the segment. */
3790 gst_segment_do_seek (&seeksegment, rate, seek_format, flags,
3791 cur_type, cur, stop_type, stop, &update);
3794 /* Else, no seek event passed, so we're just (re)starting the
3799 GST_DEBUG_OBJECT (sink, "segment configured from %" G_GINT64_FORMAT
3800 " to %" G_GINT64_FORMAT ", position %" G_GINT64_FORMAT,
3801 seeksegment.start, seeksegment.stop, seeksegment.position);
3803 /* do the seek, segment.position contains the new position. */
3804 res = gst_base_sink_default_do_seek (sink, &seeksegment);
3809 GST_DEBUG_OBJECT (sink, "stop flushing upstream");
3810 gst_pad_push_event (pad, gst_event_new_flush_stop ());
3811 gst_base_sink_flush_stop (sink, pad);
3812 } else if (res && sink->running) {
3813 /* we are running the current segment and doing a non-flushing seek,
3814 * close the segment first based on the position. */
3815 GST_DEBUG_OBJECT (sink, "closing running segment %" G_GINT64_FORMAT
3816 " to %" G_GINT64_FORMAT, sink->segment.start, sink->segment.position);
3819 /* The subclass must have converted the segment to the processing format
3821 if (res && seeksegment.format != dest_format) {
3822 GST_DEBUG_OBJECT (sink, "Subclass failed to prepare a seek segment "
3823 "in the correct format. Aborting seek.");
3827 /* if successfull seek, we update our real segment and push
3828 * out the new segment. */
3830 gst_segment_copy_into (&seeksegment, &sink->segment);
3832 if (sink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
3833 gst_element_post_message (GST_ELEMENT (sink),
3834 gst_message_new_segment_start (GST_OBJECT (sink),
3835 sink->segment.format, sink->segment.position));
3839 sink->priv->discont = TRUE;
3840 sink->running = TRUE;
3842 GST_PAD_STREAM_UNLOCK (pad);
3848 set_step_info (GstBaseSink * sink, GstStepInfo * current, GstStepInfo * pending,
3849 guint seqnum, GstFormat format, guint64 amount, gdouble rate,
3850 gboolean flush, gboolean intermediate)
3852 GST_OBJECT_LOCK (sink);
3853 pending->seqnum = seqnum;
3854 pending->format = format;
3855 pending->amount = amount;
3856 pending->position = 0;
3857 pending->rate = rate;
3858 pending->flush = flush;
3859 pending->intermediate = intermediate;
3860 pending->valid = TRUE;
3861 /* flush invalidates the current stepping segment */
3863 current->valid = FALSE;
3864 GST_OBJECT_UNLOCK (sink);
3868 gst_base_sink_perform_step (GstBaseSink * sink, GstPad * pad, GstEvent * event)
3870 GstBaseSinkPrivate *priv;
3871 GstBaseSinkClass *bclass;
3872 gboolean flush, intermediate;
3877 GstStepInfo *pending, *current;
3878 GstMessage *message;
3880 bclass = GST_BASE_SINK_GET_CLASS (sink);
3883 GST_DEBUG_OBJECT (sink, "performing step with event %p", event);
3885 gst_event_parse_step (event, &format, &amount, &rate, &flush, &intermediate);
3886 seqnum = gst_event_get_seqnum (event);
3888 pending = &priv->pending_step;
3889 current = &priv->current_step;
3891 /* post message first */
3892 message = gst_message_new_step_start (GST_OBJECT (sink), FALSE, format,
3893 amount, rate, flush, intermediate);
3894 gst_message_set_seqnum (message, seqnum);
3895 gst_element_post_message (GST_ELEMENT (sink), message);
3898 /* we need to call ::unlock before locking PREROLL_LOCK
3899 * since we lock it before going into ::render */
3901 bclass->unlock (sink);
3903 GST_BASE_SINK_PREROLL_LOCK (sink);
3904 /* now that we have the PREROLL lock, clear our unlock request */
3905 if (bclass->unlock_stop)
3906 bclass->unlock_stop (sink);
3908 /* update the stepinfo and make it valid */
3909 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3912 if (sink->priv->async_enabled) {
3913 /* and we need to commit our state again on the next
3914 * prerolled buffer */
3915 sink->playing_async = TRUE;
3916 priv->pending_step.need_preroll = TRUE;
3917 sink->need_preroll = FALSE;
3918 gst_element_lost_state (GST_ELEMENT_CAST (sink), FALSE);
3920 sink->priv->have_latency = TRUE;
3921 sink->need_preroll = FALSE;
3923 priv->current_sstart = GST_CLOCK_TIME_NONE;
3924 priv->current_sstop = GST_CLOCK_TIME_NONE;
3925 priv->eos_rtime = GST_CLOCK_TIME_NONE;
3926 priv->call_preroll = TRUE;
3927 gst_base_sink_set_last_buffer (sink, NULL);
3928 gst_base_sink_reset_qos (sink);
3930 if (sink->clock_id) {
3931 gst_clock_id_unschedule (sink->clock_id);
3934 if (sink->have_preroll) {
3935 GST_DEBUG_OBJECT (sink, "signal waiter");
3936 priv->step_unlock = TRUE;
3937 GST_BASE_SINK_PREROLL_SIGNAL (sink);
3939 GST_BASE_SINK_PREROLL_UNLOCK (sink);
3941 /* update the stepinfo and make it valid */
3942 set_step_info (sink, current, pending, seqnum, format, amount, rate, flush,
3952 gst_base_sink_loop (GstPad * pad)
3954 GstBaseSink *basesink;
3955 GstBuffer *buf = NULL;
3956 GstFlowReturn result;
3960 basesink = GST_BASE_SINK (GST_OBJECT_PARENT (pad));
3962 g_assert (basesink->pad_mode == GST_ACTIVATE_PULL);
3964 if ((blocksize = basesink->priv->blocksize) == 0)
3967 offset = basesink->segment.position;
3969 GST_DEBUG_OBJECT (basesink, "pulling %" G_GUINT64_FORMAT ", %u",
3972 result = gst_pad_pull_range (pad, offset, blocksize, &buf);
3973 if (G_UNLIKELY (result != GST_FLOW_OK))
3976 if (G_UNLIKELY (buf == NULL))
3979 offset += gst_buffer_get_size (buf);
3981 basesink->segment.position = offset;
3983 GST_BASE_SINK_PREROLL_LOCK (basesink);
3984 result = gst_base_sink_chain_unlocked (basesink, pad, _PR_IS_BUFFER, buf);
3985 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
3986 if (G_UNLIKELY (result != GST_FLOW_OK))
3994 GST_LOG_OBJECT (basesink, "pausing task, reason %s",
3995 gst_flow_get_name (result));
3996 gst_pad_pause_task (pad);
3997 if (result == GST_FLOW_UNEXPECTED) {
3998 /* perform EOS logic */
3999 if (basesink->segment.flags & GST_SEEK_FLAG_SEGMENT) {
4000 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4001 gst_message_new_segment_done (GST_OBJECT_CAST (basesink),
4002 basesink->segment.format, basesink->segment.position));
4004 gst_base_sink_event (pad, gst_event_new_eos ());
4006 } else if (result == GST_FLOW_NOT_LINKED || result <= GST_FLOW_UNEXPECTED) {
4007 /* for fatal errors we post an error message, post the error
4008 * first so the app knows about the error first.
4009 * wrong-state is not a fatal error because it happens due to
4010 * flushing and posting an error message in that case is the
4011 * wrong thing to do, e.g. when basesrc is doing a flushing
4013 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
4014 (_("Internal data stream error.")),
4015 ("stream stopped, reason %s", gst_flow_get_name (result)));
4016 gst_base_sink_event (pad, gst_event_new_eos ());
4022 GST_LOG_OBJECT (basesink, "no buffer, pausing");
4023 GST_ELEMENT_ERROR (basesink, STREAM, FAILED,
4024 (_("Internal data flow error.")), ("element returned NULL buffer"));
4025 result = GST_FLOW_ERROR;
4031 gst_base_sink_set_flushing (GstBaseSink * basesink, GstPad * pad,
4034 GstBaseSinkClass *bclass;
4036 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4039 /* unlock any subclasses, we need to do this before grabbing the
4040 * PREROLL_LOCK since we hold this lock before going into ::render. */
4042 bclass->unlock (basesink);
4045 GST_BASE_SINK_PREROLL_LOCK (basesink);
4046 basesink->flushing = flushing;
4048 /* step 1, now that we have the PREROLL lock, clear our unlock request */
4049 if (bclass->unlock_stop)
4050 bclass->unlock_stop (basesink);
4052 /* set need_preroll before we unblock the clock. If the clock is unblocked
4053 * before timing out, we can reuse the buffer for preroll. */
4054 basesink->need_preroll = TRUE;
4056 /* step 2, unblock clock sync (if any) or any other blocking thing */
4057 if (basesink->clock_id) {
4058 gst_clock_id_unschedule (basesink->clock_id);
4061 /* flush out the data thread if it's locked in finish_preroll, this will
4062 * also flush out the EOS state */
4063 GST_DEBUG_OBJECT (basesink,
4064 "flushing out data thread, need preroll to TRUE");
4065 gst_base_sink_preroll_queue_flush (basesink, pad);
4067 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4073 gst_base_sink_default_activate_pull (GstBaseSink * basesink, gboolean active)
4079 result = gst_pad_start_task (basesink->sinkpad,
4080 (GstTaskFunction) gst_base_sink_loop, basesink->sinkpad);
4082 /* step 2, make sure streaming finishes */
4083 result = gst_pad_stop_task (basesink->sinkpad);
4090 gst_base_sink_pad_activate (GstPad * pad)
4092 gboolean result = FALSE;
4093 GstBaseSink *basesink;
4095 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4097 GST_DEBUG_OBJECT (basesink, "Trying pull mode first");
4099 gst_base_sink_set_flushing (basesink, pad, FALSE);
4101 /* we need to have the pull mode enabled */
4102 if (!basesink->can_activate_pull) {
4103 GST_DEBUG_OBJECT (basesink, "pull mode disabled");
4107 /* check if downstreams supports pull mode at all */
4108 if (!gst_pad_check_pull_range (pad)) {
4109 GST_DEBUG_OBJECT (basesink, "pull mode not supported");
4113 /* set the pad mode before starting the task so that it's in the
4114 * correct state for the new thread. also the sink set_caps and get_caps
4115 * function checks this */
4116 basesink->pad_mode = GST_ACTIVATE_PULL;
4118 /* we first try to negotiate a format so that when we try to activate
4119 * downstream, it knows about our format */
4120 if (!gst_base_sink_negotiate_pull (basesink)) {
4121 GST_DEBUG_OBJECT (basesink, "failed to negotiate in pull mode");
4125 /* ok activate now */
4126 if (!gst_pad_activate_pull (pad, TRUE)) {
4127 /* clear any pending caps */
4128 GST_OBJECT_LOCK (basesink);
4129 gst_caps_replace (&basesink->priv->pull_caps, NULL);
4130 GST_OBJECT_UNLOCK (basesink);
4131 GST_DEBUG_OBJECT (basesink, "failed to activate in pull mode");
4135 GST_DEBUG_OBJECT (basesink, "Success activating pull mode");
4139 /* push mode fallback */
4141 GST_DEBUG_OBJECT (basesink, "Falling back to push mode");
4142 if ((result = gst_pad_activate_push (pad, TRUE))) {
4143 GST_DEBUG_OBJECT (basesink, "Success activating push mode");
4148 GST_WARNING_OBJECT (basesink, "Could not activate pad in either mode");
4149 gst_base_sink_set_flushing (basesink, pad, TRUE);
4152 gst_object_unref (basesink);
4158 gst_base_sink_pad_activate_push (GstPad * pad, gboolean active)
4161 GstBaseSink *basesink;
4163 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4166 if (!basesink->can_activate_push) {
4168 basesink->pad_mode = GST_ACTIVATE_NONE;
4171 basesink->pad_mode = GST_ACTIVATE_PUSH;
4174 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH)) {
4175 g_warning ("Internal GStreamer activation error!!!");
4178 gst_base_sink_set_flushing (basesink, pad, TRUE);
4180 basesink->pad_mode = GST_ACTIVATE_NONE;
4184 gst_object_unref (basesink);
4190 gst_base_sink_negotiate_pull (GstBaseSink * basesink)
4197 /* this returns the intersection between our caps and the peer caps. If there
4198 * is no peer, it returns NULL and we can't operate in pull mode so we can
4199 * fail the negotiation. */
4200 caps = gst_pad_get_allowed_caps (GST_BASE_SINK_PAD (basesink));
4201 if (caps == NULL || gst_caps_is_empty (caps))
4202 goto no_caps_possible;
4204 GST_DEBUG_OBJECT (basesink, "allowed caps: %" GST_PTR_FORMAT, caps);
4206 caps = gst_caps_make_writable (caps);
4207 /* get the first (prefered) format */
4208 gst_caps_truncate (caps);
4210 GST_DEBUG_OBJECT (basesink, "have caps: %" GST_PTR_FORMAT, caps);
4212 if (gst_caps_is_any (caps)) {
4213 GST_DEBUG_OBJECT (basesink, "caps were ANY after fixating, "
4215 /* neither side has template caps in this case, so they are prepared for
4216 pull() without setcaps() */
4220 gst_pad_fixate_caps (GST_BASE_SINK_PAD (basesink), caps);
4221 GST_DEBUG_OBJECT (basesink, "fixated to: %" GST_PTR_FORMAT, caps);
4223 if (gst_caps_is_fixed (caps)) {
4224 if (!gst_pad_set_caps (GST_BASE_SINK_PAD (basesink), caps))
4225 goto could_not_set_caps;
4227 GST_OBJECT_LOCK (basesink);
4228 gst_caps_replace (&basesink->priv->pull_caps, caps);
4229 GST_OBJECT_UNLOCK (basesink);
4235 gst_caps_unref (caps);
4241 GST_INFO_OBJECT (basesink, "Pipeline could not agree on caps");
4242 GST_DEBUG_OBJECT (basesink, "get_allowed_caps() returned EMPTY");
4244 gst_caps_unref (caps);
4249 GST_INFO_OBJECT (basesink, "Could not set caps: %" GST_PTR_FORMAT, caps);
4250 gst_caps_unref (caps);
4255 /* this won't get called until we implement an activate function */
4257 gst_base_sink_pad_activate_pull (GstPad * pad, gboolean active)
4259 gboolean result = FALSE;
4260 GstBaseSink *basesink;
4261 GstBaseSinkClass *bclass;
4263 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
4264 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4270 /* we mark we have a newsegment here because pull based
4271 * mode works just fine without having a newsegment before the
4273 format = GST_FORMAT_BYTES;
4275 gst_segment_init (&basesink->segment, format);
4276 gst_segment_init (basesink->clip_segment, format);
4277 GST_OBJECT_LOCK (basesink);
4278 basesink->have_newsegment = TRUE;
4279 GST_OBJECT_UNLOCK (basesink);
4281 /* get the peer duration in bytes */
4282 result = gst_pad_query_peer_duration (pad, &format, &duration);
4284 GST_DEBUG_OBJECT (basesink,
4285 "setting duration in bytes to %" G_GINT64_FORMAT, duration);
4286 basesink->clip_segment->duration = duration;
4287 basesink->segment.duration = duration;
4289 GST_DEBUG_OBJECT (basesink, "unknown duration");
4292 if (bclass->activate_pull)
4293 result = bclass->activate_pull (basesink, TRUE);
4298 goto activate_failed;
4301 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PULL)) {
4302 g_warning ("Internal GStreamer activation error!!!");
4305 result = gst_base_sink_set_flushing (basesink, pad, TRUE);
4306 if (bclass->activate_pull)
4307 result &= bclass->activate_pull (basesink, FALSE);
4308 basesink->pad_mode = GST_ACTIVATE_NONE;
4309 /* clear any pending caps */
4310 GST_OBJECT_LOCK (basesink);
4311 gst_caps_replace (&basesink->priv->pull_caps, NULL);
4312 GST_OBJECT_UNLOCK (basesink);
4315 gst_object_unref (basesink);
4322 /* reset, as starting the thread failed */
4323 basesink->pad_mode = GST_ACTIVATE_NONE;
4325 GST_ERROR_OBJECT (basesink, "subclass failed to activate in pull mode");
4330 /* send an event to our sinkpad peer. */
4332 gst_base_sink_send_event (GstElement * element, GstEvent * event)
4335 GstBaseSink *basesink = GST_BASE_SINK (element);
4336 gboolean forward, result = TRUE;
4337 GstActivateMode mode;
4339 GST_OBJECT_LOCK (element);
4340 /* get the pad and the scheduling mode */
4341 pad = gst_object_ref (basesink->sinkpad);
4342 mode = basesink->pad_mode;
4343 GST_OBJECT_UNLOCK (element);
4345 /* only push UPSTREAM events upstream */
4346 forward = GST_EVENT_IS_UPSTREAM (event);
4348 GST_DEBUG_OBJECT (basesink, "handling event %p %" GST_PTR_FORMAT, event,
4351 switch (GST_EVENT_TYPE (event)) {
4352 case GST_EVENT_LATENCY:
4354 GstClockTime latency;
4356 gst_event_parse_latency (event, &latency);
4358 /* store the latency. We use this to adjust the running_time before syncing
4359 * it to the clock. */
4360 GST_OBJECT_LOCK (element);
4361 basesink->priv->latency = latency;
4362 if (!basesink->priv->have_latency)
4364 GST_OBJECT_UNLOCK (element);
4365 GST_DEBUG_OBJECT (basesink, "latency set to %" GST_TIME_FORMAT,
4366 GST_TIME_ARGS (latency));
4368 /* We forward this event so that all elements know about the global pipeline
4369 * latency. This is interesting for an element when it wants to figure out
4370 * when a particular piece of data will be rendered. */
4373 case GST_EVENT_SEEK:
4374 /* in pull mode we will execute the seek */
4375 if (mode == GST_ACTIVATE_PULL)
4376 result = gst_base_sink_perform_seek (basesink, pad, event);
4378 case GST_EVENT_STEP:
4379 result = gst_base_sink_perform_step (basesink, pad, event);
4387 result = gst_pad_push_event (pad, event);
4389 /* not forwarded, unref the event */
4390 gst_event_unref (event);
4393 gst_object_unref (pad);
4398 gst_base_sink_get_position (GstBaseSink * basesink, GstFormat format,
4399 gint64 * cur, gboolean * upstream)
4401 GstClock *clock = NULL;
4402 gboolean res = FALSE;
4403 GstFormat oformat, tformat;
4404 GstSegment *segment;
4405 GstClockTime now, latency;
4406 GstClockTimeDiff base_time;
4407 gint64 time, base, duration;
4410 gboolean last_seen, with_clock, in_paused;
4412 GST_OBJECT_LOCK (basesink);
4413 /* we can only get the segment when we are not NULL or READY */
4414 if (!basesink->have_newsegment)
4418 /* when not in PLAYING or when we're busy with a state change, we
4419 * cannot read from the clock so we report time based on the
4420 * last seen timestamp. */
4421 if (GST_STATE (basesink) != GST_STATE_PLAYING ||
4422 GST_STATE_PENDING (basesink) != GST_STATE_VOID_PENDING) {
4426 /* we don't use the clip segment in pull mode, when seeking we update the
4427 * main segment directly with the new segment values without it having to be
4428 * activated by the rendering after preroll */
4429 if (basesink->pad_mode == GST_ACTIVATE_PUSH)
4430 segment = basesink->clip_segment;
4432 segment = &basesink->segment;
4434 /* our intermediate time format */
4435 tformat = GST_FORMAT_TIME;
4436 /* get the format in the segment */
4437 oformat = segment->format;
4439 /* report with last seen position when EOS */
4440 last_seen = basesink->eos;
4442 /* assume we will use the clock for getting the current position */
4444 if (basesink->sync == FALSE)
4447 /* and we need a clock */
4448 if (G_UNLIKELY ((clock = GST_ELEMENT_CLOCK (basesink)) == NULL))
4451 gst_object_ref (clock);
4453 /* collect all data we need holding the lock */
4454 if (GST_CLOCK_TIME_IS_VALID (segment->time))
4455 time = segment->time;
4459 if (GST_CLOCK_TIME_IS_VALID (segment->stop))
4460 duration = segment->stop - segment->start;
4464 base = segment->base;
4465 rate = segment->rate * segment->applied_rate;
4466 latency = basesink->priv->latency;
4468 if (oformat == GST_FORMAT_TIME) {
4471 start = basesink->priv->current_sstart;
4472 stop = basesink->priv->current_sstop;
4475 /* in paused we use the last position as a lower bound */
4476 if (stop == -1 || segment->rate > 0.0)
4481 /* in playing, use last stop time as upper bound */
4482 if (start == -1 || segment->rate > 0.0)
4488 /* convert last stop to stream time */
4489 last = gst_segment_to_stream_time (segment, oformat, segment->position);
4493 /* in paused, use start_time */
4494 base_time = GST_ELEMENT_START_TIME (basesink);
4495 GST_DEBUG_OBJECT (basesink, "in paused, using start time %" GST_TIME_FORMAT,
4496 GST_TIME_ARGS (base_time));
4497 } else if (with_clock) {
4498 /* else use clock when needed */
4499 base_time = GST_ELEMENT_CAST (basesink)->base_time;
4500 GST_DEBUG_OBJECT (basesink, "using clock and base time %" GST_TIME_FORMAT,
4501 GST_TIME_ARGS (base_time));
4503 /* else, no sync or clock -> no base time */
4504 GST_DEBUG_OBJECT (basesink, "no sync or no clock");
4508 /* no base_time, we can't calculate running_time, use last seem timestamp to report
4510 if (base_time == -1)
4513 /* need to release the object lock before we can get the time,
4514 * a clock might take the LOCK of the provider, which could be
4515 * a basesink subclass. */
4516 GST_OBJECT_UNLOCK (basesink);
4519 /* in EOS or when no valid stream_time, report the value of last seen
4522 /* no timestamp, we need to ask upstream */
4523 GST_DEBUG_OBJECT (basesink, "no last seen timestamp, asking upstream");
4528 GST_DEBUG_OBJECT (basesink, "using last seen timestamp %" GST_TIME_FORMAT,
4529 GST_TIME_ARGS (last));
4532 if (oformat != tformat) {
4533 /* convert base, time and duration to time */
4534 if (!gst_pad_query_convert (basesink->sinkpad, oformat, base, &tformat,
4536 goto convert_failed;
4537 if (!gst_pad_query_convert (basesink->sinkpad, oformat, duration,
4538 &tformat, &duration))
4539 goto convert_failed;
4540 if (!gst_pad_query_convert (basesink->sinkpad, oformat, time, &tformat,
4542 goto convert_failed;
4543 if (!gst_pad_query_convert (basesink->sinkpad, oformat, last, &tformat,
4545 goto convert_failed;
4547 /* assume time format from now on */
4551 if (!in_paused && with_clock) {
4552 now = gst_clock_get_time (clock);
4558 /* subtract base time and base time from the clock time.
4559 * Make sure we don't go negative. This is the current time in
4560 * the segment which we need to scale with the combined
4561 * rate and applied rate. */
4563 base_time += latency;
4564 if (GST_CLOCK_DIFF (base_time, now) < 0)
4567 /* for negative rates we need to count back from the segment
4572 *cur = time + gst_guint64_to_gdouble (now - base_time) * rate;
4575 /* never report less than segment values in paused */
4577 *cur = MAX (last, *cur);
4579 /* never report more than last seen position in playing */
4581 *cur = MIN (last, *cur);
4584 GST_DEBUG_OBJECT (basesink,
4585 "now %" GST_TIME_FORMAT " - base_time %" GST_TIME_FORMAT " - base %"
4586 GST_TIME_FORMAT " + time %" GST_TIME_FORMAT " last %" GST_TIME_FORMAT,
4587 GST_TIME_ARGS (now), GST_TIME_ARGS (base_time), GST_TIME_ARGS (base),
4588 GST_TIME_ARGS (time), GST_TIME_ARGS (last));
4591 if (oformat != format) {
4592 /* convert to final format */
4593 if (!gst_pad_query_convert (basesink->sinkpad, oformat, *cur, &format, cur))
4594 goto convert_failed;
4600 GST_DEBUG_OBJECT (basesink, "res: %d, POSITION: %" GST_TIME_FORMAT,
4601 res, GST_TIME_ARGS (*cur));
4604 gst_object_unref (clock);
4611 /* in NULL or READY we always return FALSE and -1 */
4612 GST_DEBUG_OBJECT (basesink, "position in wrong state, return -1");
4615 GST_OBJECT_UNLOCK (basesink);
4620 GST_DEBUG_OBJECT (basesink, "convert failed, try upstream");
4628 gst_base_sink_get_duration (GstBaseSink * basesink, GstFormat format,
4629 gint64 * dur, gboolean * upstream)
4631 gboolean res = FALSE;
4633 if (basesink->pad_mode == GST_ACTIVATE_PULL) {
4634 GstFormat uformat = GST_FORMAT_BYTES;
4637 /* get the duration in bytes, in pull mode that's all we are sure to
4638 * know. We have to explicitly get this value from upstream instead of
4639 * using our cached value because it might change. Duration caching
4640 * should be done at a higher level. */
4641 res = gst_pad_query_peer_duration (basesink->sinkpad, &uformat, &uduration);
4643 basesink->segment.duration = uduration;
4644 if (format != uformat) {
4645 /* convert to the requested format */
4646 res = gst_pad_query_convert (basesink->sinkpad, uformat, uduration,
4660 static const GstQueryType *
4661 gst_base_sink_get_query_types (GstElement * element)
4663 static const GstQueryType query_types[] = {
4675 gst_base_sink_query (GstElement * element, GstQuery ** query)
4677 gboolean res = FALSE;
4679 GstBaseSink *basesink = GST_BASE_SINK (element);
4681 switch (GST_QUERY_TYPE (*query)) {
4682 case GST_QUERY_POSITION:
4686 gboolean upstream = FALSE;
4688 gst_query_parse_position (*query, &format, NULL);
4690 GST_DEBUG_OBJECT (basesink, "position query in format %s",
4691 gst_format_get_name (format));
4693 /* first try to get the position based on the clock */
4695 gst_base_sink_get_position (basesink, format, &cur, &upstream))) {
4696 *query = gst_query_make_writable (*query);
4697 gst_query_set_position (*query, format, cur);
4698 } else if (upstream) {
4699 /* fallback to peer query */
4700 res = gst_pad_peer_query (basesink->sinkpad, query);
4703 /* we can handle a few things if upstream failed */
4704 if (format == GST_FORMAT_PERCENT) {
4706 GstFormat uformat = GST_FORMAT_TIME;
4708 res = gst_base_sink_get_position (basesink, GST_FORMAT_TIME, &cur,
4710 if (!res && upstream) {
4711 res = gst_pad_query_peer_position (basesink->sinkpad, &uformat,
4715 res = gst_base_sink_get_duration (basesink, GST_FORMAT_TIME, &dur,
4717 if (!res && upstream) {
4718 res = gst_pad_query_peer_duration (basesink->sinkpad, &uformat,
4725 pos = gst_util_uint64_scale (100 * GST_FORMAT_PERCENT_SCALE, cur,
4727 *query = gst_query_make_writable (*query);
4728 gst_query_set_position (*query, GST_FORMAT_PERCENT, pos);
4734 case GST_QUERY_DURATION:
4738 gboolean upstream = FALSE;
4740 gst_query_parse_duration (*query, &format, NULL);
4742 GST_DEBUG_OBJECT (basesink, "duration query in format %s",
4743 gst_format_get_name (format));
4746 gst_base_sink_get_duration (basesink, format, &dur, &upstream))) {
4747 *query = gst_query_make_writable (*query);
4748 gst_query_set_duration (*query, format, dur);
4749 } else if (upstream) {
4750 /* fallback to peer query */
4751 res = gst_pad_peer_query (basesink->sinkpad, query);
4754 /* we can handle a few things if upstream failed */
4755 if (format == GST_FORMAT_PERCENT) {
4756 *query = gst_query_make_writable (*query);
4757 gst_query_set_duration (*query, GST_FORMAT_PERCENT,
4758 GST_FORMAT_PERCENT_MAX);
4764 case GST_QUERY_LATENCY:
4766 gboolean live, us_live;
4767 GstClockTime min, max;
4769 if ((res = gst_base_sink_query_latency (basesink, &live, &us_live, &min,
4771 *query = gst_query_make_writable (*query);
4772 gst_query_set_latency (*query, live, min, max);
4776 case GST_QUERY_JITTER:
4778 case GST_QUERY_RATE:
4779 /* gst_query_set_rate (query, basesink->segment_rate); */
4782 case GST_QUERY_SEGMENT:
4784 if (basesink->pad_mode == GST_ACTIVATE_PULL) {
4785 *query = gst_query_make_writable (*query);
4786 gst_query_set_segment (*query, basesink->segment.rate,
4787 GST_FORMAT_TIME, basesink->segment.start, basesink->segment.stop);
4790 res = gst_pad_peer_query (basesink->sinkpad, query);
4794 case GST_QUERY_SEEKING:
4795 case GST_QUERY_CONVERT:
4796 case GST_QUERY_FORMATS:
4798 res = gst_pad_peer_query (basesink->sinkpad, query);
4801 GST_DEBUG_OBJECT (basesink, "query %s returns %d",
4802 GST_QUERY_TYPE_NAME (*query), res);
4806 static GstStateChangeReturn
4807 gst_base_sink_change_state (GstElement * element, GstStateChange transition)
4809 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
4810 GstBaseSink *basesink = GST_BASE_SINK (element);
4811 GstBaseSinkClass *bclass;
4812 GstBaseSinkPrivate *priv;
4814 priv = basesink->priv;
4816 bclass = GST_BASE_SINK_GET_CLASS (basesink);
4818 switch (transition) {
4819 case GST_STATE_CHANGE_NULL_TO_READY:
4821 if (!bclass->start (basesink))
4824 case GST_STATE_CHANGE_READY_TO_PAUSED:
4825 /* need to complete preroll before this state change completes, there
4826 * is no data flow in READY so we can safely assume we need to preroll. */
4827 GST_BASE_SINK_PREROLL_LOCK (basesink);
4828 GST_DEBUG_OBJECT (basesink, "READY to PAUSED");
4829 basesink->have_newsegment = FALSE;
4830 gst_segment_init (&basesink->segment, GST_FORMAT_UNDEFINED);
4831 gst_segment_init (basesink->clip_segment, GST_FORMAT_UNDEFINED);
4832 basesink->offset = 0;
4833 basesink->have_preroll = FALSE;
4834 priv->step_unlock = FALSE;
4835 basesink->need_preroll = TRUE;
4836 basesink->playing_async = TRUE;
4837 priv->current_sstart = GST_CLOCK_TIME_NONE;
4838 priv->current_sstop = GST_CLOCK_TIME_NONE;
4839 priv->eos_rtime = GST_CLOCK_TIME_NONE;
4841 basesink->eos = FALSE;
4842 priv->received_eos = FALSE;
4843 gst_base_sink_reset_qos (basesink);
4844 priv->commited = FALSE;
4845 priv->call_preroll = TRUE;
4846 priv->current_step.valid = FALSE;
4847 priv->pending_step.valid = FALSE;
4848 if (priv->async_enabled) {
4849 GST_DEBUG_OBJECT (basesink, "doing async state change");
4850 /* when async enabled, post async-start message and return ASYNC from
4851 * the state change function */
4852 ret = GST_STATE_CHANGE_ASYNC;
4853 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4854 gst_message_new_async_start (GST_OBJECT_CAST (basesink), FALSE));
4856 priv->have_latency = TRUE;
4858 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4860 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
4861 GST_BASE_SINK_PREROLL_LOCK (basesink);
4862 if (!gst_base_sink_needs_preroll (basesink)) {
4863 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, don't need preroll");
4864 /* no preroll needed anymore now. */
4865 basesink->playing_async = FALSE;
4866 basesink->need_preroll = FALSE;
4867 if (basesink->eos) {
4868 GstMessage *message;
4870 /* need to post EOS message here */
4871 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
4872 message = gst_message_new_eos (GST_OBJECT_CAST (basesink));
4873 gst_message_set_seqnum (message, basesink->priv->seqnum);
4874 gst_element_post_message (GST_ELEMENT_CAST (basesink), message);
4876 GST_DEBUG_OBJECT (basesink, "signal preroll");
4877 GST_BASE_SINK_PREROLL_SIGNAL (basesink);
4880 GST_DEBUG_OBJECT (basesink, "PAUSED to PLAYING, we are not prerolled");
4881 basesink->need_preroll = TRUE;
4882 basesink->playing_async = TRUE;
4883 priv->call_preroll = TRUE;
4884 priv->commited = FALSE;
4885 if (priv->async_enabled) {
4886 GST_DEBUG_OBJECT (basesink, "doing async state change");
4887 ret = GST_STATE_CHANGE_ASYNC;
4888 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4889 gst_message_new_async_start (GST_OBJECT_CAST (basesink), FALSE));
4892 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4899 GstStateChangeReturn bret;
4901 bret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
4902 if (G_UNLIKELY (bret == GST_STATE_CHANGE_FAILURE))
4903 goto activate_failed;
4906 switch (transition) {
4907 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
4908 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED");
4909 /* FIXME, make sure we cannot enter _render first */
4911 /* we need to call ::unlock before locking PREROLL_LOCK
4912 * since we lock it before going into ::render */
4914 bclass->unlock (basesink);
4916 GST_BASE_SINK_PREROLL_LOCK (basesink);
4917 GST_DEBUG_OBJECT (basesink, "got preroll lock");
4918 /* now that we have the PREROLL lock, clear our unlock request */
4919 if (bclass->unlock_stop)
4920 bclass->unlock_stop (basesink);
4922 /* we need preroll again and we set the flag before unlocking the clockid
4923 * because if the clockid is unlocked before a current buffer expired, we
4924 * can use that buffer to preroll with */
4925 basesink->need_preroll = TRUE;
4927 if (basesink->clock_id) {
4928 GST_DEBUG_OBJECT (basesink, "unschedule clock");
4929 gst_clock_id_unschedule (basesink->clock_id);
4932 /* if we don't have a preroll buffer we need to wait for a preroll and
4934 if (!gst_base_sink_needs_preroll (basesink)) {
4935 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED, we are prerolled");
4936 basesink->playing_async = FALSE;
4938 if (GST_STATE_TARGET (GST_ELEMENT (basesink)) <= GST_STATE_READY) {
4939 GST_DEBUG_OBJECT (basesink, "element is <= READY");
4940 ret = GST_STATE_CHANGE_SUCCESS;
4942 GST_DEBUG_OBJECT (basesink,
4943 "PLAYING to PAUSED, we are not prerolled");
4944 basesink->playing_async = TRUE;
4945 priv->commited = FALSE;
4946 priv->call_preroll = TRUE;
4947 if (priv->async_enabled) {
4948 GST_DEBUG_OBJECT (basesink, "doing async state change");
4949 ret = GST_STATE_CHANGE_ASYNC;
4950 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4951 gst_message_new_async_start (GST_OBJECT_CAST (basesink),
4956 GST_DEBUG_OBJECT (basesink, "rendered: %" G_GUINT64_FORMAT
4957 ", dropped: %" G_GUINT64_FORMAT, priv->rendered, priv->dropped);
4959 gst_base_sink_reset_qos (basesink);
4960 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4962 case GST_STATE_CHANGE_PAUSED_TO_READY:
4963 GST_BASE_SINK_PREROLL_LOCK (basesink);
4964 /* start by reseting our position state with the object lock so that the
4965 * position query gets the right idea. We do this before we post the
4966 * messages so that the message handlers pick this up. */
4967 GST_OBJECT_LOCK (basesink);
4968 basesink->have_newsegment = FALSE;
4969 priv->current_sstart = GST_CLOCK_TIME_NONE;
4970 priv->current_sstop = GST_CLOCK_TIME_NONE;
4971 priv->have_latency = FALSE;
4972 if (priv->cached_clock_id) {
4973 gst_clock_id_unref (priv->cached_clock_id);
4974 priv->cached_clock_id = NULL;
4976 GST_OBJECT_UNLOCK (basesink);
4978 gst_base_sink_set_last_buffer (basesink, NULL);
4979 priv->call_preroll = FALSE;
4981 if (!priv->commited) {
4982 if (priv->async_enabled) {
4983 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, posting async-done");
4985 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4986 gst_message_new_state_changed (GST_OBJECT_CAST (basesink),
4987 GST_STATE_PLAYING, GST_STATE_PAUSED, GST_STATE_READY));
4989 gst_element_post_message (GST_ELEMENT_CAST (basesink),
4990 gst_message_new_async_done (GST_OBJECT_CAST (basesink)));
4992 priv->commited = TRUE;
4994 GST_DEBUG_OBJECT (basesink, "PAUSED to READY, don't need_preroll");
4996 GST_BASE_SINK_PREROLL_UNLOCK (basesink);
4998 case GST_STATE_CHANGE_READY_TO_NULL:
5000 if (!bclass->stop (basesink)) {
5001 GST_WARNING_OBJECT (basesink, "failed to stop");
5004 gst_base_sink_set_last_buffer (basesink, NULL);
5005 priv->call_preroll = FALSE;
5016 GST_DEBUG_OBJECT (basesink, "failed to start");
5017 return GST_STATE_CHANGE_FAILURE;
5021 GST_DEBUG_OBJECT (basesink,
5022 "element failed to change states -- activation problem?");
5023 return GST_STATE_CHANGE_FAILURE;