/* GStreamer * Copyright (C) 2005 Wim Taymans * * gstbasesink.c: * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Library General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Library General Public License for more details. * * You should have received a copy of the GNU Library General Public * License along with this library; if not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ /** * SECTION:gstbasesink * @short_description: Base class for sink elements * @see_also: #GstBaseTransformc, #GstBaseSource * * This class is for elements that do output operations. * * * one sinkpad * handles state changes * pull/push mode * handles seeking/query * handles preroll * EOS handling * */ #ifdef HAVE_CONFIG_H # include "config.h" #endif #include "gstbasesink.h" #include GST_DEBUG_CATEGORY_STATIC (gst_base_sink_debug); #define GST_CAT_DEFAULT gst_base_sink_debug /* BaseSink signals and properties */ enum { /* FILL ME */ SIGNAL_HANDOFF, LAST_SIGNAL }; #define DEFAULT_SIZE 1024 #define DEFAULT_CAN_ACTIVATE_PULL FALSE /* fixme: enable me */ #define DEFAULT_CAN_ACTIVATE_PUSH TRUE enum { PROP_0, PROP_PREROLL_QUEUE_LEN }; static GstElementClass *parent_class = NULL; static void gst_base_sink_base_init (gpointer g_class); static void gst_base_sink_class_init (GstBaseSinkClass * klass); static void gst_base_sink_init (GstBaseSink * trans, gpointer g_class); static void gst_base_sink_finalize (GObject * object); GType gst_base_sink_get_type (void) { static GType base_sink_type = 0; if (!base_sink_type) { static const GTypeInfo base_sink_info = { sizeof (GstBaseSinkClass), (GBaseInitFunc) gst_base_sink_base_init, NULL, (GClassInitFunc) gst_base_sink_class_init, NULL, NULL, sizeof (GstBaseSink), 0, (GInstanceInitFunc) gst_base_sink_init, }; base_sink_type = g_type_register_static (GST_TYPE_ELEMENT, "GstBaseSink", &base_sink_info, G_TYPE_FLAG_ABSTRACT); } return base_sink_type; } static void gst_base_sink_set_clock (GstElement * element, GstClock * clock); static void gst_base_sink_set_property (GObject * object, guint prop_id, const GValue * value, GParamSpec * pspec); static void gst_base_sink_get_property (GObject * object, guint prop_id, GValue * value, GParamSpec * pspec); static GstCaps *gst_base_sink_get_caps (GstBaseSink * sink); static gboolean gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps); static GstFlowReturn gst_base_sink_buffer_alloc (GstBaseSink * sink, guint64 offset, guint size, GstCaps * caps, GstBuffer ** buf); static void gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer, GstClockTime * start, GstClockTime * end); static GstStateChangeReturn gst_base_sink_change_state (GstElement * element, GstStateChange transition); static GstFlowReturn gst_base_sink_chain (GstPad * pad, GstBuffer * buffer); static void gst_base_sink_loop (GstPad * pad); static gboolean gst_base_sink_activate (GstPad * pad); static gboolean gst_base_sink_activate_push (GstPad * pad, gboolean active); static gboolean gst_base_sink_activate_pull (GstPad * pad, gboolean active); static gboolean gst_base_sink_event (GstPad * pad, GstEvent * event); static inline GstFlowReturn gst_base_sink_handle_buffer (GstBaseSink * basesink, GstBuffer * buf); static inline gboolean gst_base_sink_handle_event (GstBaseSink * basesink, GstEvent * event); static void gst_base_sink_base_init (gpointer g_class) { GST_DEBUG_CATEGORY_INIT (gst_base_sink_debug, "basesink", 0, "basesink element"); } static void gst_base_sink_class_init (GstBaseSinkClass * klass) { GObjectClass *gobject_class; GstElementClass *gstelement_class; gobject_class = (GObjectClass *) klass; gstelement_class = (GstElementClass *) klass; parent_class = g_type_class_ref (GST_TYPE_ELEMENT); gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_base_sink_finalize); gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_base_sink_set_property); gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_base_sink_get_property); /* FIXME, this next value should be configured using an event from the * upstream element */ g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_PREROLL_QUEUE_LEN, g_param_spec_uint ("preroll-queue-len", "preroll-queue-len", "Number of buffers to queue during preroll", 0, G_MAXUINT, 0, G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); gstelement_class->set_clock = GST_DEBUG_FUNCPTR (gst_base_sink_set_clock); gstelement_class->change_state = GST_DEBUG_FUNCPTR (gst_base_sink_change_state); klass->get_caps = GST_DEBUG_FUNCPTR (gst_base_sink_get_caps); klass->set_caps = GST_DEBUG_FUNCPTR (gst_base_sink_set_caps); klass->buffer_alloc = GST_DEBUG_FUNCPTR (gst_base_sink_buffer_alloc); klass->get_times = GST_DEBUG_FUNCPTR (gst_base_sink_get_times); } static GstCaps * gst_base_sink_pad_getcaps (GstPad * pad) { GstBaseSinkClass *bclass; GstBaseSink *bsink; GstCaps *caps = NULL; bsink = GST_BASE_SINK (gst_pad_get_parent (pad)); bclass = GST_BASE_SINK_GET_CLASS (bsink); if (bclass->get_caps) caps = bclass->get_caps (bsink); if (caps == NULL) { GstPadTemplate *pad_template; pad_template = gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass), "sink"); if (pad_template != NULL) { caps = gst_caps_ref (gst_pad_template_get_caps (pad_template)); } } gst_object_unref (bsink); return caps; } static gboolean gst_base_sink_pad_setcaps (GstPad * pad, GstCaps * caps) { GstBaseSinkClass *bclass; GstBaseSink *bsink; gboolean res = FALSE; bsink = GST_BASE_SINK (gst_pad_get_parent (pad)); bclass = GST_BASE_SINK_GET_CLASS (bsink); if (bclass->set_caps) res = bclass->set_caps (bsink, caps); gst_object_unref (bsink); return res; } static GstFlowReturn gst_base_sink_pad_buffer_alloc (GstPad * pad, guint64 offset, guint size, GstCaps * caps, GstBuffer ** buf) { GstBaseSinkClass *bclass; GstBaseSink *bsink; GstFlowReturn result = GST_FLOW_OK; bsink = GST_BASE_SINK (gst_pad_get_parent (pad)); bclass = GST_BASE_SINK_GET_CLASS (bsink); if (bclass->buffer_alloc) result = bclass->buffer_alloc (bsink, offset, size, caps, buf); else *buf = NULL; /* fallback in gstpad.c will allocate generic buffer */ gst_object_unref (bsink); return result; } static void gst_base_sink_init (GstBaseSink * basesink, gpointer g_class) { GstPadTemplate *pad_template; pad_template = gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "sink"); g_return_if_fail (pad_template != NULL); basesink->sinkpad = gst_pad_new_from_template (pad_template, "sink"); gst_pad_set_getcaps_function (basesink->sinkpad, GST_DEBUG_FUNCPTR (gst_base_sink_pad_getcaps)); gst_pad_set_setcaps_function (basesink->sinkpad, GST_DEBUG_FUNCPTR (gst_base_sink_pad_setcaps)); gst_pad_set_bufferalloc_function (basesink->sinkpad, GST_DEBUG_FUNCPTR (gst_base_sink_pad_buffer_alloc)); gst_pad_set_activate_function (basesink->sinkpad, GST_DEBUG_FUNCPTR (gst_base_sink_activate)); gst_pad_set_activatepush_function (basesink->sinkpad, GST_DEBUG_FUNCPTR (gst_base_sink_activate_push)); gst_pad_set_activatepull_function (basesink->sinkpad, GST_DEBUG_FUNCPTR (gst_base_sink_activate_pull)); gst_pad_set_event_function (basesink->sinkpad, GST_DEBUG_FUNCPTR (gst_base_sink_event)); gst_pad_set_chain_function (basesink->sinkpad, GST_DEBUG_FUNCPTR (gst_base_sink_chain)); gst_element_add_pad (GST_ELEMENT (basesink), basesink->sinkpad); basesink->pad_mode = GST_ACTIVATE_NONE; GST_PAD_TASK (basesink->sinkpad) = NULL; basesink->preroll_queue = g_queue_new (); basesink->can_activate_push = DEFAULT_CAN_ACTIVATE_PUSH; basesink->can_activate_pull = DEFAULT_CAN_ACTIVATE_PULL; GST_FLAG_SET (basesink, GST_ELEMENT_IS_SINK); } static void gst_base_sink_finalize (GObject * object) { GstBaseSink *basesink; basesink = GST_BASE_SINK (object); g_queue_free (basesink->preroll_queue); G_OBJECT_CLASS (parent_class)->finalize (object); } static void gst_base_sink_set_clock (GstElement * element, GstClock * clock) { GstBaseSink *sink; sink = GST_BASE_SINK (element); sink->clock = clock; } static void gst_base_sink_set_property (GObject * object, guint prop_id, const GValue * value, GParamSpec * pspec) { GstBaseSink *sink = GST_BASE_SINK (object); switch (prop_id) { case PROP_PREROLL_QUEUE_LEN: /* preroll lock necessary to serialize with finish_preroll */ GST_PREROLL_LOCK (sink->sinkpad); sink->preroll_queue_max_len = g_value_get_uint (value); GST_PREROLL_UNLOCK (sink->sinkpad); break; default: G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); break; } } static void gst_base_sink_get_property (GObject * object, guint prop_id, GValue * value, GParamSpec * pspec) { GstBaseSink *sink = GST_BASE_SINK (object); GST_LOCK (sink); switch (prop_id) { case PROP_PREROLL_QUEUE_LEN: g_value_set_uint (value, sink->preroll_queue_max_len); break; default: G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); break; } GST_UNLOCK (sink); } static GstCaps * gst_base_sink_get_caps (GstBaseSink * sink) { return NULL; } static gboolean gst_base_sink_set_caps (GstBaseSink * sink, GstCaps * caps) { return TRUE; } static GstFlowReturn gst_base_sink_buffer_alloc (GstBaseSink * sink, guint64 offset, guint size, GstCaps * caps, GstBuffer ** buf) { *buf = NULL; return GST_FLOW_OK; } /* with PREROLL_LOCK */ static GstFlowReturn gst_base_sink_preroll_queue_empty (GstBaseSink * basesink, GstPad * pad) { GstMiniObject *obj; GQueue *q = basesink->preroll_queue; GstFlowReturn ret; ret = GST_FLOW_OK; if (q) { GST_DEBUG ("emptying queue"); while ((obj = g_queue_pop_head (q))) { gboolean is_buffer; is_buffer = GST_IS_BUFFER (obj); if (is_buffer) { basesink->preroll_queued--; basesink->buffers_queued--; } else { switch (GST_EVENT_TYPE (obj)) { case GST_EVENT_EOS: basesink->preroll_queued--; break; default: break; } basesink->events_queued--; } /* we release the preroll lock while pushing so that we * can still flush it while blocking on the clock or * inside the element. */ GST_PREROLL_UNLOCK (pad); if (is_buffer) { GST_DEBUG ("popped buffer %p", obj); ret = gst_base_sink_handle_buffer (basesink, GST_BUFFER (obj)); } else { GST_DEBUG ("popped event %p", obj); gst_base_sink_handle_event (basesink, GST_EVENT (obj)); ret = GST_FLOW_OK; } GST_PREROLL_LOCK (pad); } GST_DEBUG ("queue empty"); } return ret; } /* with PREROLL_LOCK */ static void gst_base_sink_preroll_queue_flush (GstBaseSink * basesink, GstPad * pad) { GstMiniObject *obj; GQueue *q = basesink->preroll_queue; GST_DEBUG ("flushing queue %p", basesink); if (q) { while ((obj = g_queue_pop_head (q))) { GST_DEBUG ("popped %p", obj); gst_mini_object_unref (obj); } } /* we can't have EOS anymore now */ basesink->eos = FALSE; basesink->preroll_queued = 0; basesink->buffers_queued = 0; basesink->events_queued = 0; basesink->have_preroll = FALSE; /* and signal any waiters now */ GST_PREROLL_SIGNAL (pad); } /* with STREAM_LOCK */ static GstFlowReturn gst_base_sink_handle_object (GstBaseSink * basesink, GstPad * pad, GstMiniObject * obj) { gint length; gboolean have_event; GST_PREROLL_LOCK (pad); /* push object on the queue */ GST_DEBUG_OBJECT (basesink, "push %p on preroll_queue", obj); g_queue_push_tail (basesink->preroll_queue, obj); have_event = GST_IS_EVENT (obj); if (have_event) { GstEvent *event = GST_EVENT (obj); switch (GST_EVENT_TYPE (obj)) { case GST_EVENT_EOS: basesink->preroll_queued++; basesink->eos = TRUE; break; case GST_EVENT_NEWSEGMENT: { GstFormat format; gint64 segment_start; gint64 segment_stop; /* the newsegment event is needed to bring the buffer timestamps to the * stream time and to drop samples outside of the playback segment. */ gst_event_parse_newsegment (event, &basesink->segment_rate, &format, &segment_start, &segment_stop, &basesink->segment_base); basesink->have_newsegment = TRUE; if (format != GST_FORMAT_TIME) { GST_DEBUG_OBJECT (basesink, "received non time %d NEW_SEGMENT %" G_GINT64_FORMAT " -- %" G_GINT64_FORMAT ", base %" G_GINT64_FORMAT, format, basesink->segment_start, basesink->segment_stop, basesink->segment_base); /* this means this sink will not be able to clip or drop samples * and timestamps have to start from 0. */ basesink->segment_start = -1; basesink->segment_stop = -1; basesink->segment_base = -1; goto done_newsegment; } /* check if we really have a new segment or the previous one is * closed */ if (basesink->segment_start != segment_start) { /* the new segment has to be aligned with the old segment. * We first update the accumulated time of the previous * segment. the accumulated time is used when syncing to the * clock. A flush event sets the accumulated time back to 0 */ if (GST_CLOCK_TIME_IS_VALID (basesink->segment_stop)) { basesink->segment_accum += basesink->segment_stop - basesink->segment_start; } else if (GST_CLOCK_TIME_IS_VALID (basesink->current_end)) { /* else use last seen timestamp as segment stop */ basesink->segment_accum += basesink->current_end - basesink->segment_start; } else { basesink->segment_accum = 0; } } basesink->segment_start = segment_start; basesink->segment_stop = segment_stop; GST_DEBUG_OBJECT (basesink, "received DISCONT %" GST_TIME_FORMAT " -- %" GST_TIME_FORMAT ", base %" GST_TIME_FORMAT ", accum %" GST_TIME_FORMAT, GST_TIME_ARGS (basesink->segment_start), GST_TIME_ARGS (basesink->segment_stop), GST_TIME_ARGS (basesink->segment_base), GST_TIME_ARGS (basesink->segment_accum)); done_newsegment: break; } default: break; } basesink->events_queued++; } else { GstBuffer *buf = GST_BUFFER (obj); if (!basesink->have_newsegment) { GST_ELEMENT_WARNING (basesink, STREAM, STOPPED, ("Received buffer without a new-segment. Cannot sync to clock."), ("Received buffer without a new-segment. Cannot sync to clock.")); basesink->have_newsegment = TRUE; /* this means this sink will not be able to sync to the clock */ basesink->segment_start = -1; basesink->segment_stop = -1; } /* check if the buffer needs to be dropped */ if (TRUE) { GstClockTime start = -1, end = -1; /* we don't use the subclassed method as it may not return * valid values for our purpose here */ gst_base_sink_get_times (basesink, buf, &start, &end); GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (end)); /* need to drop if the timestamp is not between segment_start and * segment_stop. we check if the complete sample is outside of the * range since the sink might be able to clip the sample. */ if (GST_CLOCK_TIME_IS_VALID (end) && GST_CLOCK_TIME_IS_VALID (basesink->segment_start)) { if (end <= basesink->segment_start) { GST_DEBUG ("buffer end %" GST_TIME_FORMAT " <= segment start %" GST_TIME_FORMAT ", dropping buffer", GST_TIME_ARGS (end), GST_TIME_ARGS (basesink->segment_start)); goto dropping; } } if (GST_CLOCK_TIME_IS_VALID (start) && GST_CLOCK_TIME_IS_VALID (basesink->segment_stop)) { if (basesink->segment_stop <= start) { GST_DEBUG ("buffer start %" GST_TIME_FORMAT " >= segment stop %" GST_TIME_FORMAT ", dropping buffer", GST_TIME_ARGS (start), GST_TIME_ARGS (basesink->segment_stop)); goto dropping; } } } basesink->preroll_queued++; basesink->buffers_queued++; } GST_DEBUG ("now %d preroll, %d buffers, %d events on queue", basesink->preroll_queued, basesink->buffers_queued, basesink->events_queued); if (basesink->playing_async) goto playing_async; /* check if we are prerolling */ if (!basesink->need_preroll) goto no_preroll; /* there is a buffer queued */ if (basesink->buffers_queued == 1) { GST_DEBUG ("do preroll %p", obj); /* if it's a buffer, we need to call the preroll method */ if (GST_IS_BUFFER (obj)) { GstBaseSinkClass *bclass; GstFlowReturn pres; bclass = GST_BASE_SINK_GET_CLASS (basesink); if (bclass->preroll) if ((pres = bclass->preroll (basesink, GST_BUFFER (obj))) != GST_FLOW_OK) goto preroll_failed; } } length = basesink->preroll_queued; GST_DEBUG ("prerolled length %d", length); if (length == 1) { gint t; basesink->have_preroll = TRUE; /* we are prerolling */ GST_PREROLL_UNLOCK (pad); /* have to release STREAM_LOCK as we cannot take the STATE_LOCK * inside the STREAM_LOCK */ t = GST_STREAM_UNLOCK_FULL (pad); GST_DEBUG ("released stream lock %d times", t); if (t <= 0) { GST_WARNING ("STREAM_LOCK should have been locked !!"); g_warning ("STREAM_LOCK should have been locked !!"); } /* now we commit our state */ GST_STATE_LOCK (basesink); GST_DEBUG_OBJECT (basesink, "commit state"); gst_element_commit_state (GST_ELEMENT (basesink)); GST_STATE_UNLOCK (basesink); /* reacquire stream lock, pad could be flushing now */ /* FIXME in glib, if t==0, the lock is still taken... hmmm */ if (t > 0) GST_STREAM_LOCK_FULL (pad, t); /* and wait if needed */ GST_PREROLL_LOCK (pad); GST_LOCK (pad); if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad))) goto flushing; GST_UNLOCK (pad); /* it is possible that the application set the state to PLAYING * now in which case we don't need to block anymore. */ if (!basesink->need_preroll) goto no_preroll; length = basesink->preroll_queued; g_assert (length == 1); } /* see if we need to block now. We cannot block on events, only * on buffers, the reason is that events can be sent from the * application thread and we don't want to block there. */ if (length > basesink->preroll_queue_max_len && !have_event) { /* block until the state changes, or we get a flush, or something */ GST_DEBUG_OBJECT (basesink, "waiting to finish preroll"); GST_PREROLL_WAIT (pad); GST_DEBUG_OBJECT (basesink, "done preroll"); } GST_LOCK (pad); if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad))) goto flushing; GST_UNLOCK (pad); GST_PREROLL_UNLOCK (pad); return GST_FLOW_OK; no_preroll: { GstFlowReturn ret; GST_DEBUG ("no preroll needed"); /* maybe it was another sink that blocked in preroll, need to check for buffers to drain */ basesink->have_preroll = FALSE; ret = gst_base_sink_preroll_queue_empty (basesink, pad); GST_PREROLL_UNLOCK (pad); return ret; } dropping: { GstBuffer *buf; buf = GST_BUFFER (g_queue_pop_tail (basesink->preroll_queue)); gst_buffer_unref (buf); GST_PREROLL_UNLOCK (pad); return GST_FLOW_OK; } playing_async: { GstFlowReturn ret; gint t; basesink->have_preroll = FALSE; basesink->playing_async = FALSE; /* handle buffer first */ ret = gst_base_sink_preroll_queue_empty (basesink, pad); /* unroll locks, commit state, reacquire stream lock */ GST_PREROLL_UNLOCK (pad); t = GST_STREAM_UNLOCK_FULL (pad); GST_DEBUG ("released stream lock %d times", t); if (t <= 0) { GST_WARNING ("STREAM_LOCK should have been locked !!"); g_warning ("STREAM_LOCK should have been locked !!"); } GST_STATE_LOCK (basesink); GST_DEBUG_OBJECT (basesink, "commit state"); gst_element_commit_state (GST_ELEMENT (basesink)); GST_STATE_UNLOCK (basesink); if (t > 0) GST_STREAM_LOCK_FULL (pad, t); return ret; } flushing: { GST_UNLOCK (pad); gst_base_sink_preroll_queue_flush (basesink, pad); GST_PREROLL_UNLOCK (pad); GST_DEBUG ("pad is flushing"); return GST_FLOW_WRONG_STATE; } preroll_failed: { gint t; GST_DEBUG ("preroll failed"); gst_base_sink_preroll_queue_flush (basesink, pad); GST_PREROLL_UNLOCK (pad); /* have to release STREAM_LOCK as we cannot take the STATE_LOCK * inside the STREAM_LOCK */ t = GST_STREAM_UNLOCK_FULL (pad); GST_DEBUG ("released stream lock %d times", t); if (t <= 0) { GST_WARNING ("STREAM_LOCK should have been locked !!"); g_warning ("STREAM_LOCK should have been locked !!"); } /* now we abort our state */ GST_STATE_LOCK (basesink); GST_DEBUG_OBJECT (basesink, "abort state"); gst_element_abort_state (GST_ELEMENT (basesink)); GST_STATE_UNLOCK (basesink); /* reacquire stream lock, pad could be flushing now */ if (t > 0) GST_STREAM_LOCK_FULL (pad, t); return GST_FLOW_ERROR; } } static gboolean gst_base_sink_event (GstPad * pad, GstEvent * event) { GstBaseSink *basesink; gboolean result = TRUE; GstBaseSinkClass *bclass; basesink = GST_BASE_SINK (gst_pad_get_parent (pad)); bclass = GST_BASE_SINK_GET_CLASS (basesink); GST_DEBUG ("event %p", event); switch (GST_EVENT_TYPE (event)) { case GST_EVENT_EOS: { GstFlowReturn ret; GST_STREAM_LOCK (pad); /* EOS also finishes the preroll */ ret = gst_base_sink_handle_object (basesink, pad, GST_MINI_OBJECT (event)); GST_STREAM_UNLOCK (pad); break; } case GST_EVENT_NEWSEGMENT: { GstFlowReturn ret; GST_STREAM_LOCK (pad); ret = gst_base_sink_handle_object (basesink, pad, GST_MINI_OBJECT (event)); GST_STREAM_UNLOCK (pad); break; } case GST_EVENT_FLUSH_START: /* make sure we are not blocked on the clock also clear any pending * eos state. */ if (bclass->event) bclass->event (basesink, event); GST_PREROLL_LOCK (pad); /* we need preroll after the flush */ basesink->need_preroll = TRUE; /* unlock from a possible state change/preroll */ gst_base_sink_preroll_queue_flush (basesink, pad); GST_LOCK (basesink); if (basesink->clock_id) { gst_clock_id_unschedule (basesink->clock_id); } GST_UNLOCK (basesink); GST_PREROLL_UNLOCK (pad); /* and we need to commit our state again on the next * prerolled buffer */ GST_STATE_LOCK (basesink); GST_STREAM_LOCK (pad); gst_element_lost_state (GST_ELEMENT (basesink)); GST_STREAM_UNLOCK (pad); GST_STATE_UNLOCK (basesink); GST_DEBUG ("event unref %p %p", basesink, event); gst_event_unref (event); break; case GST_EVENT_FLUSH_STOP: if (bclass->event) bclass->event (basesink, event); /* now we are completely unblocked and the _chain method * will return */ GST_STREAM_LOCK (pad); /* we need new segment info after the flush. */ basesink->segment_start = -1; basesink->segment_stop = -1; basesink->current_start = -1; basesink->current_end = -1; GST_DEBUG ("reset accum %" GST_TIME_FORMAT, GST_TIME_ARGS (basesink->segment_accum)); basesink->segment_accum = 0; GST_STREAM_UNLOCK (pad); GST_DEBUG ("event unref %p %p", basesink, event); gst_event_unref (event); break; default: gst_event_unref (event); break; } gst_object_unref (basesink); return result; } /* default implementation to calculate the start and end * timestamps on a buffer, subclasses can override */ static void gst_base_sink_get_times (GstBaseSink * basesink, GstBuffer * buffer, GstClockTime * start, GstClockTime * end) { GstClockTime timestamp, duration; timestamp = GST_BUFFER_TIMESTAMP (buffer); if (GST_CLOCK_TIME_IS_VALID (timestamp)) { /* get duration to calculate end time */ duration = GST_BUFFER_DURATION (buffer); if (GST_CLOCK_TIME_IS_VALID (duration)) { *end = timestamp + duration; } *start = timestamp; } } /* perform synchronisation on a buffer * * 1) check if we have a clock, if not, do nothing * 2) calculate the start and end time of the buffer * 3) create a single shot notification to wait on * the clock, save the entry so we can unlock it * 4) wait on the clock, this blocks * 5) unref the clockid again */ static gboolean gst_base_sink_do_sync (GstBaseSink * basesink, GstBuffer * buffer) { gboolean result = TRUE; GstClockTime start, end; GstClockTimeDiff stream_start, stream_end; GstBaseSinkClass *bclass; gboolean start_valid, end_valid; bclass = GST_BASE_SINK_GET_CLASS (basesink); start = end = -1; if (bclass->get_times) bclass->get_times (basesink, buffer, &start, &end); start_valid = GST_CLOCK_TIME_IS_VALID (start); end_valid = GST_CLOCK_TIME_IS_VALID (start); GST_DEBUG_OBJECT (basesink, "got times start: %" GST_TIME_FORMAT ", end: %" GST_TIME_FORMAT, GST_TIME_ARGS (start), GST_TIME_ARGS (end)); /* if we don't have a timestamp, we don't sync */ if (!start_valid) goto done; /* save last times seen. */ basesink->current_start = start; if (end_valid) basesink->current_end = end; else basesink->current_end = start; if (GST_CLOCK_TIME_IS_VALID (basesink->segment_stop)) { /* check if not outside of the segment range, start is * always valid here. */ if (start > basesink->segment_stop) goto out_of_segment; } /* bring timestamp to stream time using last segment offset. */ if (GST_CLOCK_TIME_IS_VALID (basesink->segment_start)) { /* check if not outside of the segment range */ if (end_valid && end < basesink->segment_start) goto out_of_segment; stream_start = (gint64) start - basesink->segment_start; stream_end = (gint64) end - basesink->segment_start; } else { stream_start = (gint64) start; stream_end = (gint64) end; } stream_start += basesink->segment_accum; if (end_valid) stream_end += basesink->segment_accum; /* now do clocking */ if (basesink->clock) { GstClockReturn ret; GstClockTime base_time; GST_LOCK (basesink); base_time = GST_ELEMENT (basesink)->base_time; GST_LOG_OBJECT (basesink, "waiting for clock, base time %" GST_TIME_FORMAT, GST_TIME_ARGS (base_time)); /* save clock id so that we can unlock it if needed */ basesink->clock_id = gst_clock_new_single_shot_id (basesink->clock, stream_start + base_time); /* also save end_time of this buffer so that we can wait * to signal EOS */ if (end_valid) basesink->end_time = stream_end + base_time; else basesink->end_time = GST_CLOCK_TIME_NONE; GST_UNLOCK (basesink); ret = gst_clock_id_wait (basesink->clock_id, NULL); GST_LOCK (basesink); if (basesink->clock_id) { gst_clock_id_unref (basesink->clock_id); basesink->clock_id = NULL; } GST_UNLOCK (basesink); GST_LOG_OBJECT (basesink, "clock entry done: %d", ret); if (ret == GST_CLOCK_UNSCHEDULED) result = FALSE; } done: return result; out_of_segment: { GST_LOG_OBJECT (basesink, "buffer skipped, not in segment"); return FALSE; } } /* handle an event * * 2) render the event * 3) unref the event */ static inline gboolean gst_base_sink_handle_event (GstBaseSink * basesink, GstEvent * event) { GstBaseSinkClass *bclass; gboolean ret; switch (GST_EVENT_TYPE (event)) { case GST_EVENT_EOS: GST_LOCK (basesink); if (basesink->clock) { /* wait for last buffer to finish if we have a valid end time */ if (GST_CLOCK_TIME_IS_VALID (basesink->end_time)) { basesink->clock_id = gst_clock_new_single_shot_id (basesink->clock, basesink->end_time); GST_UNLOCK (basesink); gst_clock_id_wait (basesink->clock_id, NULL); GST_LOCK (basesink); if (basesink->clock_id) { gst_clock_id_unref (basesink->clock_id); basesink->clock_id = NULL; } basesink->end_time = GST_CLOCK_TIME_NONE; } } GST_UNLOCK (basesink); break; default: break; } bclass = GST_BASE_SINK_GET_CLASS (basesink); if (bclass->event) ret = bclass->event (basesink, event); else ret = TRUE; switch (GST_EVENT_TYPE (event)) { case GST_EVENT_EOS: GST_PREROLL_LOCK (basesink->sinkpad); /* if we are still EOS, we can post the EOS message */ if (basesink->eos) { /* ok, now we can post the message */ GST_DEBUG_OBJECT (basesink, "Now posting EOS"); gst_element_post_message (GST_ELEMENT (basesink), gst_message_new_eos (GST_OBJECT (basesink))); } GST_PREROLL_UNLOCK (basesink->sinkpad); break; default: break; } GST_DEBUG ("event unref %p %p", basesink, event); gst_event_unref (event); return ret; } /* handle a buffer * * 1) first sync on the buffer * 2) render the buffer * 3) unref the buffer */ static inline GstFlowReturn gst_base_sink_handle_buffer (GstBaseSink * basesink, GstBuffer * buf) { GstFlowReturn ret = GST_FLOW_OK; gboolean render; render = gst_base_sink_do_sync (basesink, buf); if (render) { GstBaseSinkClass *bclass; bclass = GST_BASE_SINK_GET_CLASS (basesink); if (bclass->render) ret = bclass->render (basesink, buf); } GST_DEBUG ("buffer unref after render %p", basesink, buf); gst_buffer_unref (buf); return ret; } static GstFlowReturn gst_base_sink_chain (GstPad * pad, GstBuffer * buf) { GstBaseSink *basesink; GstFlowReturn result; basesink = GST_BASE_SINK (gst_pad_get_parent (pad)); if (!(basesink->pad_mode == GST_ACTIVATE_PUSH)) { GST_LOCK (pad); g_warning ("Push on pad %s:%s, but it was not activated in push mode", GST_DEBUG_PAD_NAME (pad)); GST_UNLOCK (pad); result = GST_FLOW_UNEXPECTED; goto done; } result = gst_base_sink_handle_object (basesink, pad, GST_MINI_OBJECT (buf)); done: gst_object_unref (basesink); return result; } static void gst_base_sink_loop (GstPad * pad) { GstBaseSink *basesink; GstBuffer *buf = NULL; GstFlowReturn result; basesink = GST_BASE_SINK (gst_pad_get_parent (pad)); g_assert (basesink->pad_mode == GST_ACTIVATE_PULL); result = gst_pad_pull_range (pad, basesink->offset, DEFAULT_SIZE, &buf); if (result != GST_FLOW_OK) goto paused; result = gst_base_sink_handle_object (basesink, pad, GST_MINI_OBJECT (buf)); if (result != GST_FLOW_OK) goto paused; gst_object_unref (basesink); /* default */ return; paused: { gst_base_sink_event (pad, gst_event_new_eos ()); gst_object_unref (basesink); gst_pad_pause_task (pad); return; } } static gboolean gst_base_sink_deactivate (GstBaseSink * basesink, GstPad * pad) { gboolean result = FALSE; GstBaseSinkClass *bclass; bclass = GST_BASE_SINK_GET_CLASS (basesink); /* step 1, unblock clock sync (if any) or any other blocking thing */ GST_PREROLL_LOCK (pad); GST_LOCK (basesink); if (basesink->clock_id) { gst_clock_id_unschedule (basesink->clock_id); } GST_UNLOCK (basesink); /* unlock any subclasses */ if (bclass->unlock) bclass->unlock (basesink); /* flush out the data thread if it's locked in finish_preroll */ basesink->need_preroll = FALSE; gst_base_sink_preroll_queue_flush (basesink, pad); GST_PREROLL_SIGNAL (pad); GST_PREROLL_UNLOCK (pad); /* step 2, make sure streaming finishes */ result = gst_pad_stop_task (pad); return result; } static gboolean gst_base_sink_activate (GstPad * pad) { gboolean result = FALSE; GstBaseSink *basesink; basesink = GST_BASE_SINK (gst_pad_get_parent (pad)); GST_DEBUG_OBJECT (basesink, "Trying pull mode first"); if (basesink->can_activate_pull && gst_pad_check_pull_range (pad) && gst_pad_activate_pull (pad, TRUE)) { GST_DEBUG_OBJECT (basesink, "Success activating pull mode"); result = TRUE; } else { GST_DEBUG_OBJECT (basesink, "Falling back to push mode"); if (gst_pad_activate_push (pad, TRUE)) { GST_DEBUG_OBJECT (basesink, "Success activating push mode"); result = TRUE; } } if (!result) { GST_WARNING_OBJECT (basesink, "Could not activate pad in either mode"); } gst_object_unref (basesink); return result; } static gboolean gst_base_sink_activate_push (GstPad * pad, gboolean active) { gboolean result; GstBaseSink *basesink; basesink = GST_BASE_SINK (gst_pad_get_parent (pad)); if (active) { if (!basesink->can_activate_push) { result = FALSE; basesink->pad_mode = GST_ACTIVATE_NONE; } else { result = TRUE; basesink->pad_mode = GST_ACTIVATE_PUSH; } } else { if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PUSH)) { g_warning ("Internal GStreamer activation error!!!"); result = FALSE; } else { result = gst_base_sink_deactivate (basesink, pad); basesink->pad_mode = GST_ACTIVATE_NONE; } } gst_object_unref (basesink); return result; } /* this won't get called until we implement an activate function */ static gboolean gst_base_sink_activate_pull (GstPad * pad, gboolean active) { gboolean result = FALSE; GstBaseSink *basesink; basesink = GST_BASE_SINK (gst_pad_get_parent (pad)); if (active) { if (!basesink->can_activate_pull) { result = FALSE; basesink->pad_mode = GST_ACTIVATE_NONE; } else { GstPad *peer = gst_pad_get_peer (pad); if (G_UNLIKELY (peer == NULL)) { g_warning ("Trying to activate pad in pull mode, but no peer"); result = FALSE; basesink->pad_mode = GST_ACTIVATE_NONE; } else { if (gst_pad_activate_pull (peer, TRUE)) { basesink->have_newsegment = TRUE; basesink->segment_start = basesink->segment_stop = 0; /* set the pad mode before starting the task so that it's in the correct state for the new thread... */ basesink->pad_mode = GST_ACTIVATE_PULL; result = gst_pad_start_task (pad, (GstTaskFunction) gst_base_sink_loop, pad); /* but if starting the thread fails, set it back */ if (!result) basesink->pad_mode = GST_ACTIVATE_NONE; } else { GST_DEBUG_OBJECT (pad, "Failed to activate peer in pull mode"); result = FALSE; basesink->pad_mode = GST_ACTIVATE_NONE; } gst_object_unref (peer); } } } else { if (G_UNLIKELY (basesink->pad_mode != GST_ACTIVATE_PULL)) { g_warning ("Internal GStreamer activation error!!!"); result = FALSE; } else { basesink->have_newsegment = FALSE; result = gst_base_sink_deactivate (basesink, pad); basesink->pad_mode = GST_ACTIVATE_NONE; } } gst_object_unref (basesink); return result; } static GstStateChangeReturn gst_base_sink_change_state (GstElement * element, GstStateChange transition) { GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS; GstBaseSink *basesink = GST_BASE_SINK (element); GstBaseSinkClass *bclass; bclass = GST_BASE_SINK_GET_CLASS (basesink); switch (transition) { case GST_STATE_CHANGE_NULL_TO_READY: if (bclass->start) if (!bclass->start (basesink)) goto start_failed; break; case GST_STATE_CHANGE_READY_TO_PAUSED: /* need to complete preroll before this state change completes, there * is no data flow in READY so we can safely assume we need to preroll. */ basesink->offset = 0; GST_PREROLL_LOCK (basesink->sinkpad); basesink->have_preroll = FALSE; basesink->need_preroll = TRUE; GST_PREROLL_UNLOCK (basesink->sinkpad); basesink->have_newsegment = FALSE; basesink->segment_rate = 1.0; basesink->segment_start = 0; basesink->segment_stop = 0; ret = GST_STATE_CHANGE_ASYNC; break; case GST_STATE_CHANGE_PAUSED_TO_PLAYING: { GST_PREROLL_LOCK (basesink->sinkpad); /* if we have EOS, we should empty the queue now as there will * be no more data received in the chain function. * FIXME, this could block the state change function too long when * we are pushing and syncing the buffers, better start a new * thread to do this. */ if (basesink->eos) { gst_base_sink_preroll_queue_empty (basesink, basesink->sinkpad); } else if (!basesink->have_preroll) { /* don't need preroll, but do queue a commit_state */ basesink->need_preroll = FALSE; basesink->playing_async = TRUE; ret = GST_STATE_CHANGE_ASYNC; /* we know it's not waiting, no need to signal */ } else { /* don't need the preroll anymore */ basesink->need_preroll = FALSE; /* now let it play */ GST_PREROLL_SIGNAL (basesink->sinkpad); } GST_PREROLL_UNLOCK (basesink->sinkpad); break; } default: break; } { GstStateChangeReturn bret; bret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition); if (bret != GST_STATE_CHANGE_SUCCESS) goto activate_failed; } switch (transition) { case GST_STATE_CHANGE_PLAYING_TO_PAUSED: { GstBaseSinkClass *bclass; bclass = GST_BASE_SINK_GET_CLASS (basesink); GST_PREROLL_LOCK (basesink->sinkpad); GST_LOCK (basesink); /* unlock clock wait if any */ if (basesink->clock_id) { gst_clock_id_unschedule (basesink->clock_id); } GST_UNLOCK (basesink); basesink->playing_async = FALSE; /* unlock any subclasses */ if (bclass->unlock) bclass->unlock (basesink); /* if we don't have a preroll buffer and we have not received EOS, * we need to wait for a preroll */ GST_DEBUG ("have_preroll: %d, EOS: %d", basesink->have_preroll, basesink->eos); if (!basesink->have_preroll && !basesink->eos) { basesink->need_preroll = TRUE; ret = GST_STATE_CHANGE_ASYNC; } GST_PREROLL_UNLOCK (basesink->sinkpad); break; } case GST_STATE_CHANGE_PAUSED_TO_READY: break; case GST_STATE_CHANGE_READY_TO_NULL: if (bclass->stop) if (!bclass->stop (basesink)) { GST_WARNING ("failed to stop"); } break; default: break; } return ret; /* ERRORS */ start_failed: { GST_DEBUG ("failed to start"); return GST_STATE_CHANGE_FAILURE; } activate_failed: { GST_DEBUG ("element failed to change states -- activation problem?"); return GST_STATE_CHANGE_FAILURE; } }