2 * Copyright (C) 2005 Wim Taymans <wim@fluendo.com>
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: #GstBaseTransformc, #GstBaseSource
27 * This class is for elements that do output operations.
30 * <listitem><para>one sinkpad</para></listitem>
31 * <listitem><para>handles state changes</para></listitem>
32 * <listitem><para>pull/push mode</para></listitem>
33 * <listitem><para>handles seeking/query</para></listitem>
34 * <listitem><para>handles preroll</para></listitem>
35 * <listitem><para>EOS handling</para></listitem>
43 #include "gstbasesink.h"
44 #include <gst/gstmarshal.h>
46 GST_DEBUG_CATEGORY_STATIC (gst_base_sink_debug);
47 #define GST_CAT_DEFAULT gst_base_sink_debug
49 /* BaseSink signals and properties */
57 #define DEFAULT_SIZE 1024
58 #define DEFAULT_CAN_ACTIVATE_PULL FALSE /* fixme: enable me */
59 #define DEFAULT_CAN_ACTIVATE_PUSH TRUE
61 #define DEFAULT_SYNC TRUE
66 PROP_PREROLL_QUEUE_LEN,
70 static GstElementClass *parent_class = NULL;
72 static void gst_base_sink_base_init (gpointer g_class);
73 static void gst_base_sink_class_init (GstBaseSinkClass * klass);
74 static void gst_base_sink_init (GstBaseSink * trans, gpointer g_class);
75 static void gst_base_sink_finalize (GObject * object);
78 gst_base_sink_get_type (void)
80 static GType base_sink_type = 0;
82 if (!base_sink_type) {
83 static const GTypeInfo base_sink_info = {
84 sizeof (GstBaseSinkClass),
85 (GBaseInitFunc) gst_base_sink_base_init,
87 (GClassInitFunc) gst_base_sink_class_init,
92 (GInstanceInitFunc) gst_base_sink_init,
95 base_sink_type = g_type_register_static (GST_TYPE_ELEMENT,
96 "GstBaseSink", &base_sink_info, G_TYPE_FLAG_ABSTRACT);
98 return base_sink_type;
101 static void gst_base_sink_set_clock (GstElement * element, GstClock * clock);
103 static void gst_base_sink_set_property (GObject * object, guint prop_id,
104 const GValue * value, GParamSpec * pspec);
105 static void gst_base_sink_get_property (GObject * object, guint prop_id,
106 GValue * value, GParamSpec * pspec);
108 static gboolean gst_base_sink_send_event (GstElement * element,
110 static gboolean gst_base_sink_query (GstElement * element, GstQuery * query);
112 static GstCaps *gst_base_sink_get_caps (GstBaseSink * sink);
113 static gboolean gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps);
114 static GstFlowReturn gst_base_sink_buffer_alloc (GstBaseSink * sink,
115 guint64 offset, guint size, GstCaps * caps, GstBuffer ** buf);
116 static void gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
117 GstClockTime * start, GstClockTime * end);
119 static GstStateChangeReturn gst_base_sink_change_state (GstElement * element,
120 GstStateChange transition);
122 static GstFlowReturn gst_base_sink_chain (GstPad * pad, GstBuffer * buffer);
123 static void gst_base_sink_loop (GstPad * pad);
124 static gboolean gst_base_sink_activate (GstPad * pad);
125 static gboolean gst_base_sink_activate_push (GstPad * pad, gboolean active);
126 static gboolean gst_base_sink_activate_pull (GstPad * pad, gboolean active);
127 static gboolean gst_base_sink_event (GstPad * pad, GstEvent * event);
128 static inline GstFlowReturn gst_base_sink_handle_buffer (GstBaseSink * basesink,
130 static inline gboolean gst_base_sink_handle_event (GstBaseSink * basesink,
134 gst_base_sink_base_init (gpointer g_class)
136 GST_DEBUG_CATEGORY_INIT (gst_base_sink_debug, "basesink", 0,
141 gst_base_sink_class_init (GstBaseSinkClass * klass)
143 GObjectClass *gobject_class;
144 GstElementClass *gstelement_class;
146 gobject_class = (GObjectClass *) klass;
147 gstelement_class = (GstElementClass *) klass;
149 parent_class = g_type_class_ref (GST_TYPE_ELEMENT);
151 gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_base_sink_finalize);
152 gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_base_sink_set_property);
153 gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_base_sink_get_property);
155 /* FIXME, this next value should be configured using an event from the
156 * upstream element */
157 g_object_class_install_property (G_OBJECT_CLASS (klass),
158 PROP_PREROLL_QUEUE_LEN,
159 g_param_spec_uint ("preroll-queue-len", "preroll-queue-len",
160 "Number of buffers to queue during preroll", 0, G_MAXUINT, 0,
161 G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
162 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SYNC,
163 g_param_spec_boolean ("sync", "Sync", "Sync on the clock", DEFAULT_SYNC,
166 gstelement_class->set_clock = GST_DEBUG_FUNCPTR (gst_base_sink_set_clock);
167 gstelement_class->change_state =
168 GST_DEBUG_FUNCPTR (gst_base_sink_change_state);
169 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_base_sink_send_event);
170 gstelement_class->query = GST_DEBUG_FUNCPTR (gst_base_sink_query);
172 klass->get_caps = GST_DEBUG_FUNCPTR (gst_base_sink_get_caps);
173 klass->set_caps = GST_DEBUG_FUNCPTR (gst_base_sink_set_caps);
174 klass->buffer_alloc = GST_DEBUG_FUNCPTR (gst_base_sink_buffer_alloc);
175 klass->get_times = GST_DEBUG_FUNCPTR (gst_base_sink_get_times);
179 gst_base_sink_pad_getcaps (GstPad * pad)
181 GstBaseSinkClass *bclass;
183 GstCaps *caps = NULL;
185 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
186 bclass = GST_BASE_SINK_GET_CLASS (bsink);
187 if (bclass->get_caps)
188 caps = bclass->get_caps (bsink);
191 GstPadTemplate *pad_template;
194 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass), "sink");
195 if (pad_template != NULL) {
196 caps = gst_caps_ref (gst_pad_template_get_caps (pad_template));
199 gst_object_unref (bsink);
205 gst_base_sink_pad_setcaps (GstPad * pad, GstCaps * caps)
207 GstBaseSinkClass *bclass;
209 gboolean res = FALSE;
211 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
212 bclass = GST_BASE_SINK_GET_CLASS (bsink);
214 if (bclass->set_caps)
215 res = bclass->set_caps (bsink, caps);
217 gst_object_unref (bsink);
223 gst_base_sink_pad_buffer_alloc (GstPad * pad, guint64 offset, guint size,
224 GstCaps * caps, GstBuffer ** buf)
226 GstBaseSinkClass *bclass;
228 GstFlowReturn result = GST_FLOW_OK;
230 bsink = GST_BASE_SINK (gst_pad_get_parent (pad));
231 bclass = GST_BASE_SINK_GET_CLASS (bsink);
233 if (bclass->buffer_alloc)
234 result = bclass->buffer_alloc (bsink, offset, size, caps, buf);
236 *buf = NULL; /* fallback in gstpad.c will allocate generic buffer */
238 gst_object_unref (bsink);
244 gst_base_sink_init (GstBaseSink * basesink, gpointer g_class)
246 GstPadTemplate *pad_template;
249 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "sink");
250 g_return_if_fail (pad_template != NULL);
252 basesink->sinkpad = gst_pad_new_from_template (pad_template, "sink");
254 gst_pad_set_getcaps_function (basesink->sinkpad,
255 GST_DEBUG_FUNCPTR (gst_base_sink_pad_getcaps));
256 gst_pad_set_setcaps_function (basesink->sinkpad,
257 GST_DEBUG_FUNCPTR (gst_base_sink_pad_setcaps));
258 gst_pad_set_bufferalloc_function (basesink->sinkpad,
259 GST_DEBUG_FUNCPTR (gst_base_sink_pad_buffer_alloc));
260 gst_pad_set_activate_function (basesink->sinkpad,
261 GST_DEBUG_FUNCPTR (gst_base_sink_activate));
262 gst_pad_set_activatepush_function (basesink->sinkpad,
263 GST_DEBUG_FUNCPTR (gst_base_sink_activate_push));
264 gst_pad_set_activatepull_function (basesink->sinkpad,
265 GST_DEBUG_FUNCPTR (gst_base_sink_activate_pull));
266 gst_pad_set_event_function (basesink->sinkpad,
267 GST_DEBUG_FUNCPTR (gst_base_sink_event));
268 gst_pad_set_chain_function (basesink->sinkpad,
269 GST_DEBUG_FUNCPTR (gst_base_sink_chain));
270 gst_element_add_pad (GST_ELEMENT (basesink), basesink->sinkpad);
272 basesink->pad_mode = GST_ACTIVATE_NONE;
273 GST_PAD_TASK (basesink->sinkpad) = NULL;
274 basesink->preroll_queue = g_queue_new ();
276 basesink->can_activate_push = DEFAULT_CAN_ACTIVATE_PUSH;
277 basesink->can_activate_pull = DEFAULT_CAN_ACTIVATE_PULL;
279 basesink->sync = DEFAULT_SYNC;
281 GST_FLAG_SET (basesink, GST_ELEMENT_IS_SINK);
285 gst_base_sink_finalize (GObject * object)
287 GstBaseSink *basesink;
289 basesink = GST_BASE_SINK (object);
291 g_queue_free (basesink->preroll_queue);
293 G_OBJECT_CLASS (parent_class)->finalize (object);
297 gst_base_sink_set_clock (GstElement * element, GstClock * clock)
301 sink = GST_BASE_SINK (element);
307 gst_base_sink_set_property (GObject * object, guint prop_id,
308 const GValue * value, GParamSpec * pspec)
310 GstBaseSink *sink = GST_BASE_SINK (object);
313 case PROP_PREROLL_QUEUE_LEN:
314 /* preroll lock necessary to serialize with finish_preroll */
315 GST_PREROLL_LOCK (sink->sinkpad);
316 sink->preroll_queue_max_len = g_value_get_uint (value);
317 GST_PREROLL_UNLOCK (sink->sinkpad);
320 sink->sync = g_value_get_boolean (value);
323 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
329 gst_base_sink_get_property (GObject * object, guint prop_id, GValue * value,
332 GstBaseSink *sink = GST_BASE_SINK (object);
336 case PROP_PREROLL_QUEUE_LEN:
337 g_value_set_uint (value, sink->preroll_queue_max_len);
340 g_value_set_boolean (value, sink->sync);
343 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
350 gst_base_sink_get_caps (GstBaseSink * sink)
356 gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps)
362 gst_base_sink_buffer_alloc (GstBaseSink * sink, guint64 offset, guint size,
363 GstCaps * caps, GstBuffer ** buf)
369 /* with PREROLL_LOCK */
371 gst_base_sink_preroll_queue_empty (GstBaseSink * basesink, GstPad * pad)
374 GQueue *q = basesink->preroll_queue;
380 GST_DEBUG_OBJECT (basesink, "emptying queue");
381 while ((obj = g_queue_pop_head (q))) {
384 is_buffer = GST_IS_BUFFER (obj);
386 basesink->preroll_queued--;
387 basesink->buffers_queued--;
389 switch (GST_EVENT_TYPE (obj)) {
391 basesink->preroll_queued--;
396 basesink->events_queued--;
398 /* we release the preroll lock while pushing so that we
399 * can still flush it while blocking on the clock or
400 * inside the element. */
401 GST_PREROLL_UNLOCK (pad);
404 GST_DEBUG_OBJECT (basesink, "popped buffer %p", obj);
405 ret = gst_base_sink_handle_buffer (basesink, GST_BUFFER (obj));
407 GST_DEBUG_OBJECT (basesink, "popped event %p", obj);
408 gst_base_sink_handle_event (basesink, GST_EVENT (obj));
412 GST_PREROLL_LOCK (pad);
414 GST_DEBUG_OBJECT (basesink, "queue empty");
419 /* with PREROLL_LOCK */
421 gst_base_sink_preroll_queue_flush (GstBaseSink * basesink, GstPad * pad)
424 GQueue *q = basesink->preroll_queue;
426 GST_DEBUG_OBJECT (basesink, "flushing queue %p", basesink);
428 while ((obj = g_queue_pop_head (q))) {
429 GST_DEBUG_OBJECT (basesink, "popped %p", obj);
430 gst_mini_object_unref (obj);
433 /* we can't have EOS anymore now */
434 basesink->eos = FALSE;
435 basesink->preroll_queued = 0;
436 basesink->buffers_queued = 0;
437 basesink->events_queued = 0;
438 basesink->have_preroll = FALSE;
439 /* and signal any waiters now */
440 GST_PREROLL_SIGNAL (pad);
443 /* with STREAM_LOCK */
445 gst_base_sink_handle_object (GstBaseSink * basesink, GstPad * pad,
451 GST_PREROLL_LOCK (pad);
452 /* push object on the queue */
453 GST_DEBUG_OBJECT (basesink, "push %p on preroll_queue", obj);
454 g_queue_push_tail (basesink->preroll_queue, obj);
456 have_event = GST_IS_EVENT (obj);
458 GstEvent *event = GST_EVENT (obj);
460 switch (GST_EVENT_TYPE (obj)) {
462 basesink->preroll_queued++;
463 basesink->eos = TRUE;
465 case GST_EVENT_NEWSEGMENT:
468 gint64 segment_start;
471 /* the newsegment event is needed to bring the buffer timestamps to the
472 * stream time and to drop samples outside of the playback segment. */
473 gst_event_parse_newsegment (event, &basesink->segment_rate, &format,
474 &segment_start, &segment_stop, &basesink->segment_base);
476 basesink->have_newsegment = TRUE;
478 if (format != GST_FORMAT_TIME) {
479 GST_DEBUG_OBJECT (basesink,
480 "received non time %d NEW_SEGMENT %" G_GINT64_FORMAT
481 " -- %" G_GINT64_FORMAT ", base %" G_GINT64_FORMAT,
482 format, basesink->segment_start, basesink->segment_stop,
483 basesink->segment_base);
485 /* this means this sink will not be able to clip or drop samples
486 * and timestamps have to start from 0. */
487 basesink->segment_start = -1;
488 basesink->segment_stop = -1;
489 basesink->segment_base = -1;
490 goto done_newsegment;
492 /* check if we really have a new segment or the previous one is
494 if (basesink->segment_start != segment_start) {
495 /* the new segment has to be aligned with the old segment.
496 * We first update the accumulated time of the previous
497 * segment. the accumulated time is used when syncing to the
498 * clock. A flush event sets the accumulated time back to 0
500 if (GST_CLOCK_TIME_IS_VALID (basesink->segment_stop)) {
501 basesink->segment_accum +=
502 basesink->segment_stop - basesink->segment_start;
503 } else if (GST_CLOCK_TIME_IS_VALID (basesink->current_end)) {
504 /* else use last seen timestamp as segment stop */
505 basesink->segment_accum +=
506 basesink->current_end - basesink->segment_start;
508 basesink->segment_accum = 0;
512 basesink->segment_start = segment_start;
513 basesink->segment_stop = segment_stop;
515 GST_DEBUG_OBJECT (basesink,
516 "received DISCONT %" GST_TIME_FORMAT " -- %"
517 GST_TIME_FORMAT ", base %" GST_TIME_FORMAT ", accum %"
519 GST_TIME_ARGS (basesink->segment_start),
520 GST_TIME_ARGS (basesink->segment_stop),
521 GST_TIME_ARGS (basesink->segment_base),
522 GST_TIME_ARGS (basesink->segment_accum));
529 basesink->events_queued++;
531 GstBuffer *buf = GST_BUFFER (obj);
533 if (!basesink->have_newsegment) {
534 GST_ELEMENT_WARNING (basesink, STREAM, STOPPED,
535 ("Received buffer without a new-segment. Cannot sync to clock."),
536 ("Received buffer without a new-segment. Cannot sync to clock."));
537 basesink->have_newsegment = TRUE;
538 /* this means this sink will not be able to sync to the clock */
539 basesink->segment_start = -1;
540 basesink->segment_stop = -1;
543 /* check if the buffer needs to be dropped */
545 GstClockTime start = -1, end = -1;
547 /* we don't use the subclassed method as it may not return
548 * valid values for our purpose here */
549 gst_base_sink_get_times (basesink, buf, &start, &end);
551 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
552 ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start),
553 GST_TIME_ARGS (end));
555 /* need to drop if the timestamp is not between segment_start and
556 * segment_stop. we check if the complete sample is outside of the
557 * range since the sink might be able to clip the sample. */
558 if (GST_CLOCK_TIME_IS_VALID (end) &&
559 GST_CLOCK_TIME_IS_VALID (basesink->segment_start)) {
560 if (end <= basesink->segment_start) {
561 GST_DEBUG_OBJECT (basesink,
562 "buffer end %" GST_TIME_FORMAT " <= segment start %"
563 GST_TIME_FORMAT ", dropping buffer", GST_TIME_ARGS (end),
564 GST_TIME_ARGS (basesink->segment_start));
568 if (GST_CLOCK_TIME_IS_VALID (start) &&
569 GST_CLOCK_TIME_IS_VALID (basesink->segment_stop)) {
570 if (basesink->segment_stop <= start) {
571 GST_DEBUG_OBJECT (basesink,
572 "buffer start %" GST_TIME_FORMAT " >= segment stop %"
573 GST_TIME_FORMAT ", dropping buffer", GST_TIME_ARGS (start),
574 GST_TIME_ARGS (basesink->segment_stop));
579 basesink->preroll_queued++;
580 basesink->buffers_queued++;
582 GST_DEBUG_OBJECT (basesink,
583 "now %d preroll, %d buffers, %d events on queue",
584 basesink->preroll_queued,
585 basesink->buffers_queued, basesink->events_queued);
587 if (basesink->playing_async)
590 /* check if we are prerolling */
591 if (!basesink->need_preroll)
594 /* there is a buffer queued */
595 if (basesink->buffers_queued == 1) {
596 GST_DEBUG_OBJECT (basesink, "do preroll %p", obj);
598 /* if it's a buffer, we need to call the preroll method */
599 if (GST_IS_BUFFER (obj)) {
600 GstBaseSinkClass *bclass;
603 bclass = GST_BASE_SINK_GET_CLASS (basesink);
606 bclass->preroll (basesink, GST_BUFFER (obj))) != GST_FLOW_OK)
610 length = basesink->preroll_queued;
611 GST_DEBUG_OBJECT (basesink, "prerolled length %d", length);
616 basesink->have_preroll = TRUE;
617 /* we are prerolling */
618 GST_PREROLL_UNLOCK (pad);
620 /* have to release STREAM_LOCK as we cannot take the STATE_LOCK
621 * inside the STREAM_LOCK */
622 t = GST_STREAM_UNLOCK_FULL (pad);
623 GST_DEBUG_OBJECT (basesink, "released stream lock %d times", t);
625 GST_WARNING ("STREAM_LOCK should have been locked !!");
626 g_warning ("STREAM_LOCK should have been locked !!");
629 /* now we commit our state */
630 GST_STATE_LOCK (basesink);
631 GST_DEBUG_OBJECT (basesink, "commit state");
632 gst_element_commit_state (GST_ELEMENT (basesink));
633 GST_STATE_UNLOCK (basesink);
635 /* reacquire stream lock, pad could be flushing now */
636 /* FIXME in glib, if t==0, the lock is still taken... hmmm */
638 GST_STREAM_LOCK_FULL (pad, t);
640 /* and wait if needed */
641 GST_PREROLL_LOCK (pad);
644 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
648 /* it is possible that the application set the state to PLAYING
649 * now in which case we don't need to block anymore. */
650 if (!basesink->need_preroll)
654 length = basesink->preroll_queued;
656 /* FIXME: a pad probe could have made us lose the buffer, according
657 * to one of the python tests */
659 GST_ERROR_OBJECT (basesink,
660 "preroll_queued dropped from 1 to 0 while committing state change");
662 g_assert (length <= 1);
665 /* see if we need to block now. We cannot block on events, only
666 * on buffers, the reason is that events can be sent from the
667 * application thread and we don't want to block there. */
668 if (length > basesink->preroll_queue_max_len && !have_event) {
669 /* block until the state changes, or we get a flush, or something */
670 GST_DEBUG_OBJECT (basesink, "waiting to finish preroll");
671 GST_PREROLL_WAIT (pad);
672 GST_DEBUG_OBJECT (basesink, "done preroll");
675 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
679 GST_PREROLL_UNLOCK (pad);
687 GST_DEBUG_OBJECT (basesink, "no preroll needed");
688 /* maybe it was another sink that blocked in preroll, need to check for
690 basesink->have_preroll = FALSE;
691 ret = gst_base_sink_preroll_queue_empty (basesink, pad);
692 GST_PREROLL_UNLOCK (pad);
700 buf = GST_BUFFER (g_queue_pop_tail (basesink->preroll_queue));
702 gst_buffer_unref (buf);
703 GST_PREROLL_UNLOCK (pad);
712 basesink->have_preroll = FALSE;
713 basesink->playing_async = FALSE;
715 /* handle buffer first */
716 ret = gst_base_sink_preroll_queue_empty (basesink, pad);
718 /* unroll locks, commit state, reacquire stream lock */
719 GST_PREROLL_UNLOCK (pad);
720 t = GST_STREAM_UNLOCK_FULL (pad);
721 GST_DEBUG_OBJECT (basesink, "released stream lock %d times", t);
723 GST_WARNING ("STREAM_LOCK should have been locked !!");
724 g_warning ("STREAM_LOCK should have been locked !!");
726 GST_STATE_LOCK (basesink);
727 GST_DEBUG_OBJECT (basesink, "commit state");
728 gst_element_commit_state (GST_ELEMENT (basesink));
729 GST_STATE_UNLOCK (basesink);
731 GST_STREAM_LOCK_FULL (pad, t);
738 gst_base_sink_preroll_queue_flush (basesink, pad);
739 GST_PREROLL_UNLOCK (pad);
740 GST_DEBUG_OBJECT (basesink, "pad is flushing");
741 return GST_FLOW_WRONG_STATE;
747 GST_DEBUG_OBJECT (basesink, "preroll failed");
748 gst_base_sink_preroll_queue_flush (basesink, pad);
749 GST_PREROLL_UNLOCK (pad);
751 /* have to release STREAM_LOCK as we cannot take the STATE_LOCK
752 * inside the STREAM_LOCK */
753 t = GST_STREAM_UNLOCK_FULL (pad);
754 GST_DEBUG_OBJECT (basesink, "released stream lock %d times", t);
756 GST_WARNING ("STREAM_LOCK should have been locked !!");
757 g_warning ("STREAM_LOCK should have been locked !!");
760 /* now we abort our state */
761 GST_STATE_LOCK (basesink);
762 GST_DEBUG_OBJECT (basesink, "abort state");
763 gst_element_abort_state (GST_ELEMENT (basesink));
764 GST_STATE_UNLOCK (basesink);
766 /* reacquire stream lock, pad could be flushing now */
768 GST_STREAM_LOCK_FULL (pad, t);
770 return GST_FLOW_ERROR;
775 gst_base_sink_event (GstPad * pad, GstEvent * event)
777 GstBaseSink *basesink;
778 gboolean result = TRUE;
779 GstBaseSinkClass *bclass;
781 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
783 bclass = GST_BASE_SINK_GET_CLASS (basesink);
785 GST_DEBUG_OBJECT (basesink, "event %p", event);
787 switch (GST_EVENT_TYPE (event)) {
792 GST_STREAM_LOCK (pad);
793 /* EOS also finishes the preroll */
795 gst_base_sink_handle_object (basesink, pad, GST_MINI_OBJECT (event));
796 GST_STREAM_UNLOCK (pad);
799 case GST_EVENT_NEWSEGMENT:
803 GST_STREAM_LOCK (pad);
805 gst_base_sink_handle_object (basesink, pad, GST_MINI_OBJECT (event));
806 GST_STREAM_UNLOCK (pad);
809 case GST_EVENT_FLUSH_START:
810 /* make sure we are not blocked on the clock also clear any pending
813 bclass->event (basesink, event);
815 GST_PREROLL_LOCK (pad);
816 /* we need preroll after the flush */
817 GST_DEBUG_OBJECT (basesink, "flushing, need preroll after flush");
818 basesink->need_preroll = TRUE;
819 /* unlock from a possible state change/preroll */
820 gst_base_sink_preroll_queue_flush (basesink, pad);
823 if (basesink->clock_id) {
824 gst_clock_id_unschedule (basesink->clock_id);
826 GST_UNLOCK (basesink);
827 GST_PREROLL_UNLOCK (pad);
829 /* and we need to commit our state again on the next
830 * prerolled buffer */
831 GST_STATE_LOCK (basesink);
832 GST_STREAM_LOCK (pad);
833 gst_element_lost_state (GST_ELEMENT (basesink));
834 GST_STREAM_UNLOCK (pad);
835 GST_STATE_UNLOCK (basesink);
836 GST_DEBUG_OBJECT (basesink, "event unref %p %p", basesink, event);
837 gst_event_unref (event);
839 case GST_EVENT_FLUSH_STOP:
841 bclass->event (basesink, event);
843 /* now we are completely unblocked and the _chain method
845 GST_STREAM_LOCK (pad);
846 /* we need new segment info after the flush. */
847 basesink->segment_start = -1;
848 basesink->segment_stop = -1;
849 basesink->current_start = -1;
850 basesink->current_end = -1;
851 GST_DEBUG_OBJECT (basesink, "reset accum %" GST_TIME_FORMAT,
852 GST_TIME_ARGS (basesink->segment_accum));
853 basesink->segment_accum = 0;
854 GST_STREAM_UNLOCK (pad);
856 GST_DEBUG_OBJECT (basesink, "event unref %p %p", basesink, event);
857 gst_event_unref (event);
860 gst_event_unref (event);
863 gst_object_unref (basesink);
868 /* default implementation to calculate the start and end
869 * timestamps on a buffer, subclasses can override
872 gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer,
873 GstClockTime * start, GstClockTime * end)
875 GstClockTime timestamp, duration;
877 timestamp = GST_BUFFER_TIMESTAMP (buffer);
878 if (GST_CLOCK_TIME_IS_VALID (timestamp)) {
880 /* get duration to calculate end time */
881 duration = GST_BUFFER_DURATION (buffer);
882 if (GST_CLOCK_TIME_IS_VALID (duration)) {
883 *end = timestamp + duration;
889 /* with STREAM_LOCK and LOCK*/
890 static GstClockReturn
891 gst_base_sink_wait (GstBaseSink * basesink, GstClockTime time)
895 /* clock_id should be NULL outside of this function */
896 g_assert (basesink->clock_id == NULL);
897 g_assert (GST_CLOCK_TIME_IS_VALID (time));
899 basesink->clock_id = gst_clock_new_single_shot_id (basesink->clock, time);
901 /* release the object lock while waiting */
902 GST_UNLOCK (basesink);
903 ret = gst_clock_id_wait (basesink->clock_id, NULL);
906 gst_clock_id_unref (basesink->clock_id);
907 basesink->clock_id = NULL;
912 /* perform synchronisation on a buffer
914 * 1) check if we have a clock, if not, do nothing
915 * 2) calculate the start and end time of the buffer
916 * 3) create a single shot notification to wait on
917 * the clock, save the entry so we can unlock it
918 * 4) wait on the clock, this blocks
919 * 5) unref the clockid again
922 gst_base_sink_do_sync (GstBaseSink * basesink, GstBuffer * buffer)
924 gboolean result = TRUE;
925 GstClockTime start, end;
926 GstClockTimeDiff stream_start, stream_end;
927 GstBaseSinkClass *bclass;
928 gboolean start_valid, end_valid;
930 bclass = GST_BASE_SINK_GET_CLASS (basesink);
933 if (bclass->get_times)
934 bclass->get_times (basesink, buffer, &start, &end);
936 start_valid = GST_CLOCK_TIME_IS_VALID (start);
937 end_valid = GST_CLOCK_TIME_IS_VALID (start);
939 GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT
940 ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (end));
942 /* if we don't have a timestamp, we don't sync */
946 /* save last times seen. */
947 basesink->current_start = start;
949 basesink->current_end = end;
951 basesink->current_end = start;
953 if (GST_CLOCK_TIME_IS_VALID (basesink->segment_stop)) {
954 /* check if not outside of the segment range, start is
955 * always valid here. */
956 if (start > basesink->segment_stop)
960 /* bring timestamp to stream time using last segment offset. */
961 if (GST_CLOCK_TIME_IS_VALID (basesink->segment_start)) {
962 /* check if not outside of the segment range */
963 if (end_valid && end < basesink->segment_start)
966 stream_start = (gint64) start - basesink->segment_start;
967 stream_end = (gint64) end - basesink->segment_start;
969 stream_start = (gint64) start;
970 stream_end = (gint64) end;
973 stream_start += basesink->segment_accum;
975 stream_end += basesink->segment_accum;
977 /* now do clocking */
978 if (basesink->clock && basesink->sync) {
980 GstClockTime base_time;
984 base_time = GST_ELEMENT (basesink)->base_time;
986 GST_LOG_OBJECT (basesink,
987 "waiting for clock, base time %" GST_TIME_FORMAT,
988 GST_TIME_ARGS (base_time));
990 /* also save end_time of this buffer so that we can wait
993 basesink->end_time = stream_end + base_time;
995 basesink->end_time = GST_CLOCK_TIME_NONE;
997 ret = gst_base_sink_wait (basesink, stream_start + base_time);
999 GST_UNLOCK (basesink);
1001 GST_LOG_OBJECT (basesink, "clock entry done: %d", ret);
1002 if (ret == GST_CLOCK_UNSCHEDULED)
1011 GST_LOG_OBJECT (basesink, "buffer skipped, not in segment");
1019 * 2) render the event
1020 * 3) unref the event
1022 static inline gboolean
1023 gst_base_sink_handle_event (GstBaseSink * basesink, GstEvent * event)
1025 GstBaseSinkClass *bclass;
1028 switch (GST_EVENT_TYPE (event)) {
1030 GST_LOCK (basesink);
1031 if (basesink->clock) {
1032 /* wait for last buffer to finish if we have a valid end time */
1033 if (GST_CLOCK_TIME_IS_VALID (basesink->end_time)) {
1034 gst_base_sink_wait (basesink, basesink->end_time);
1035 basesink->end_time = GST_CLOCK_TIME_NONE;
1038 GST_UNLOCK (basesink);
1044 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1046 ret = bclass->event (basesink, event);
1050 switch (GST_EVENT_TYPE (event)) {
1052 GST_PREROLL_LOCK (basesink->sinkpad);
1053 /* if we are still EOS, we can post the EOS message */
1054 if (basesink->eos) {
1055 /* ok, now we can post the message */
1056 GST_DEBUG_OBJECT (basesink, "Now posting EOS");
1057 gst_element_post_message (GST_ELEMENT (basesink),
1058 gst_message_new_eos (GST_OBJECT (basesink)));
1060 GST_PREROLL_UNLOCK (basesink->sinkpad);
1066 GST_DEBUG_OBJECT (basesink, "event unref %p %p", basesink, event);
1067 gst_event_unref (event);
1074 * 1) first sync on the buffer
1075 * 2) render the buffer
1076 * 3) unref the buffer
1078 static inline GstFlowReturn
1079 gst_base_sink_handle_buffer (GstBaseSink * basesink, GstBuffer * buf)
1081 GstFlowReturn ret = GST_FLOW_OK;
1084 render = gst_base_sink_do_sync (basesink, buf);
1087 GstBaseSinkClass *bclass;
1089 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1091 ret = bclass->render (basesink, buf);
1094 GST_DEBUG_OBJECT (basesink, "buffer unref after render %p", basesink, buf);
1095 gst_buffer_unref (buf);
1100 static GstFlowReturn
1101 gst_base_sink_chain (GstPad * pad, GstBuffer * buf)
1103 GstBaseSink *basesink;
1104 GstFlowReturn result;
1106 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
1108 if (!(basesink->pad_mode == GST_ACTIVATE_PUSH)) {
1110 g_warning ("Push on pad %s:%s, but it was not activated in push mode",
1111 GST_DEBUG_PAD_NAME (pad));
1113 result = GST_FLOW_UNEXPECTED;
1117 result = gst_base_sink_handle_object (basesink, pad, GST_MINI_OBJECT (buf));
1120 gst_object_unref (basesink);
1126 gst_base_sink_loop (GstPad * pad)
1128 GstBaseSink *basesink;
1129 GstBuffer *buf = NULL;
1130 GstFlowReturn result;
1132 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
1134 g_assert (basesink->pad_mode == GST_ACTIVATE_PULL);
1136 result = gst_pad_pull_range (pad, basesink->offset, DEFAULT_SIZE, &buf);
1137 if (result != GST_FLOW_OK)
1140 result = gst_base_sink_handle_object (basesink, pad, GST_MINI_OBJECT (buf));
1141 if (result != GST_FLOW_OK)
1144 gst_object_unref (basesink);
1151 gst_base_sink_event (pad, gst_event_new_eos ());
1152 gst_object_unref (basesink);
1153 gst_pad_pause_task (pad);
1159 gst_base_sink_deactivate (GstBaseSink * basesink, GstPad * pad)
1161 gboolean result = FALSE;
1162 GstBaseSinkClass *bclass;
1164 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1166 /* step 1, unblock clock sync (if any) or any other blocking thing */
1167 GST_PREROLL_LOCK (pad);
1168 GST_LOCK (basesink);
1169 if (basesink->clock_id) {
1170 gst_clock_id_unschedule (basesink->clock_id);
1172 GST_UNLOCK (basesink);
1174 /* unlock any subclasses */
1176 bclass->unlock (basesink);
1178 /* flush out the data thread if it's locked in finish_preroll */
1179 GST_DEBUG_OBJECT (basesink,
1180 "flushing out data thread, need preroll to FALSE");
1181 basesink->need_preroll = FALSE;
1182 gst_base_sink_preroll_queue_flush (basesink, pad);
1183 GST_PREROLL_SIGNAL (pad);
1184 GST_PREROLL_UNLOCK (pad);
1186 /* step 2, make sure streaming finishes */
1187 result = gst_pad_stop_task (pad);
1193 gst_base_sink_activate (GstPad * pad)
1195 gboolean result = FALSE;
1196 GstBaseSink *basesink;
1198 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
1200 GST_DEBUG_OBJECT (basesink, "Trying pull mode first");
1202 if (basesink->can_activate_pull && gst_pad_check_pull_range (pad)
1203 && gst_pad_activate_pull (pad, TRUE)) {
1204 GST_DEBUG_OBJECT (basesink, "Success activating pull mode");
1207 GST_DEBUG_OBJECT (basesink, "Falling back to push mode");
1208 if (gst_pad_activate_push (pad, TRUE)) {
1209 GST_DEBUG_OBJECT (basesink, "Success activating push mode");
1215 GST_WARNING_OBJECT (basesink, "Could not activate pad in either mode");
1218 gst_object_unref (basesink);
1224 gst_base_sink_activate_push (GstPad * pad, gboolean active)
1227 GstBaseSink *basesink;
1229 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
1232 if (!basesink->can_activate_push) {
1234 basesink->pad_mode = GST_ACTIVATE_NONE;
1237 basesink->pad_mode = GST_ACTIVATE_PUSH;
1240 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH)) {
1241 g_warning ("Internal GStreamer activation error!!!");
1244 result = gst_base_sink_deactivate (basesink, pad);
1245 basesink->pad_mode = GST_ACTIVATE_NONE;
1249 gst_object_unref (basesink);
1254 /* this won't get called until we implement an activate function */
1256 gst_base_sink_activate_pull (GstPad * pad, gboolean active)
1258 gboolean result = FALSE;
1259 GstBaseSink *basesink;
1261 basesink = GST_BASE_SINK (gst_pad_get_parent (pad));
1264 if (!basesink->can_activate_pull) {
1266 basesink->pad_mode = GST_ACTIVATE_NONE;
1268 GstPad *peer = gst_pad_get_peer (pad);
1270 if (G_UNLIKELY (peer == NULL)) {
1271 g_warning ("Trying to activate pad in pull mode, but no peer");
1273 basesink->pad_mode = GST_ACTIVATE_NONE;
1275 if (gst_pad_activate_pull (peer, TRUE)) {
1276 basesink->have_newsegment = TRUE;
1277 basesink->segment_start = basesink->segment_stop = 0;
1279 /* set the pad mode before starting the task so that it's in the
1280 correct state for the new thread... */
1281 basesink->pad_mode = GST_ACTIVATE_PULL;
1283 gst_pad_start_task (pad, (GstTaskFunction) gst_base_sink_loop,
1285 /* but if starting the thread fails, set it back */
1287 basesink->pad_mode = GST_ACTIVATE_NONE;
1289 GST_DEBUG_OBJECT (pad, "Failed to activate peer in pull mode");
1291 basesink->pad_mode = GST_ACTIVATE_NONE;
1293 gst_object_unref (peer);
1297 if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PULL)) {
1298 g_warning ("Internal GStreamer activation error!!!");
1301 basesink->have_newsegment = FALSE;
1302 result = gst_base_sink_deactivate (basesink, pad);
1303 basesink->pad_mode = GST_ACTIVATE_NONE;
1307 gst_object_unref (basesink);
1313 gst_base_sink_send_event (GstElement * element, GstEvent * event)
1316 GstBaseSink *basesink = GST_BASE_SINK (element);
1320 pad = basesink->sinkpad;
1321 gst_object_ref (pad);
1322 GST_UNLOCK (element);
1324 result = gst_pad_push_event (pad, event);
1326 gst_object_unref (pad);
1332 gst_base_sink_peer_query (GstBaseSink * sink, GstQuery * query)
1335 gboolean res = FALSE;
1337 if ((peer = gst_pad_get_peer (sink->sinkpad))) {
1338 res = gst_pad_query (peer, query);
1339 gst_object_unref (peer);
1345 gst_base_sink_query (GstElement * element, GstQuery * query)
1347 gboolean res = FALSE;
1349 GstBaseSink *basesink = GST_BASE_SINK (element);
1351 switch (GST_QUERY_TYPE (query)) {
1352 case GST_QUERY_POSITION:
1353 res = gst_base_sink_peer_query (basesink, query);
1355 case GST_QUERY_LATENCY:
1357 case GST_QUERY_JITTER:
1359 case GST_QUERY_RATE:
1360 //gst_query_set_rate (query, basesink->segment_rate);
1363 case GST_QUERY_SEEKING:
1364 res = gst_base_sink_peer_query (basesink, query);
1366 case GST_QUERY_SEGMENT:
1368 gst_query_set_segment (query, basesink->segment_rate,
1369 GST_FORMAT_TIME, basesink->segment_start, basesink->segment_stop,
1370 basesink->segment_base);
1373 case GST_QUERY_CONVERT:
1374 res = gst_base_sink_peer_query (basesink, query);
1376 case GST_QUERY_FORMATS:
1377 res = gst_base_sink_peer_query (basesink, query);
1385 static GstStateChangeReturn
1386 gst_base_sink_change_state (GstElement * element, GstStateChange transition)
1388 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
1389 GstBaseSink *basesink = GST_BASE_SINK (element);
1390 GstBaseSinkClass *bclass;
1392 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1394 switch (transition) {
1395 case GST_STATE_CHANGE_NULL_TO_READY:
1397 if (!bclass->start (basesink))
1400 case GST_STATE_CHANGE_READY_TO_PAUSED:
1401 /* need to complete preroll before this state change completes, there
1402 * is no data flow in READY so we can safely assume we need to preroll. */
1403 basesink->offset = 0;
1404 GST_PREROLL_LOCK (basesink->sinkpad);
1405 basesink->have_preroll = FALSE;
1406 GST_DEBUG_OBJECT (basesink, "READY to PAUSED, need preroll to FALSE");
1407 basesink->need_preroll = TRUE;
1408 GST_PREROLL_UNLOCK (basesink->sinkpad);
1409 basesink->have_newsegment = FALSE;
1410 basesink->segment_rate = 1.0;
1411 basesink->segment_start = 0;
1412 basesink->segment_stop = 0;
1413 ret = GST_STATE_CHANGE_ASYNC;
1415 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
1417 GST_PREROLL_LOCK (basesink->sinkpad);
1418 /* if we have EOS, we should empty the queue now as there will
1419 * be no more data received in the chain function.
1420 * FIXME, this could block the state change function too long when
1421 * we are pushing and syncing the buffers, better start a new
1422 * thread to do this. */
1423 if (basesink->eos) {
1424 gst_base_sink_preroll_queue_empty (basesink, basesink->sinkpad);
1425 } else if (!basesink->have_preroll) {
1426 /* don't need preroll, but do queue a commit_state */
1427 GST_DEBUG_OBJECT (basesink,
1428 "PAUSED to PLAYING, !eos, !have_preroll, need preroll to FALSE");
1429 basesink->need_preroll = FALSE;
1430 basesink->playing_async = TRUE;
1431 ret = GST_STATE_CHANGE_ASYNC;
1432 /* we know it's not waiting, no need to signal */
1434 /* don't need the preroll anymore */
1435 basesink->need_preroll = FALSE;
1436 GST_DEBUG_OBJECT (basesink,
1437 "PAUSED to PLAYING, !eos, have_preroll, need preroll to FALSE");
1438 /* now let it play */
1439 GST_PREROLL_SIGNAL (basesink->sinkpad);
1441 GST_PREROLL_UNLOCK (basesink->sinkpad);
1449 GstStateChangeReturn bret;
1451 bret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
1452 if (bret == GST_STATE_CHANGE_FAILURE)
1453 goto activate_failed;
1456 switch (transition) {
1457 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
1459 GstBaseSinkClass *bclass;
1461 bclass = GST_BASE_SINK_GET_CLASS (basesink);
1463 GST_PREROLL_LOCK (basesink->sinkpad);
1464 GST_LOCK (basesink);
1465 /* unlock clock wait if any */
1466 if (basesink->clock_id) {
1467 gst_clock_id_unschedule (basesink->clock_id);
1469 GST_UNLOCK (basesink);
1471 basesink->playing_async = FALSE;
1473 /* unlock any subclasses */
1475 bclass->unlock (basesink);
1477 /* if we don't have a preroll buffer and we have not received EOS,
1478 * we need to wait for a preroll */
1479 GST_DEBUG_OBJECT (basesink, "have_preroll: %d, EOS: %d",
1480 basesink->have_preroll, basesink->eos);
1481 if (!basesink->have_preroll && !basesink->eos) {
1482 GST_DEBUG_OBJECT (basesink, "PLAYING to PAUSED, need preroll to TRUE");
1483 basesink->need_preroll = TRUE;
1484 ret = GST_STATE_CHANGE_ASYNC;
1486 GST_PREROLL_UNLOCK (basesink->sinkpad);
1489 case GST_STATE_CHANGE_PAUSED_TO_READY:
1491 case GST_STATE_CHANGE_READY_TO_NULL:
1493 if (!bclass->stop (basesink)) {
1494 GST_WARNING ("failed to stop");
1506 GST_DEBUG_OBJECT (basesink, "failed to start");
1507 return GST_STATE_CHANGE_FAILURE;
1511 GST_DEBUG_OBJECT (basesink,
1512 "element failed to change states -- activation problem?");
1513 return GST_STATE_CHANGE_FAILURE;