/* GStreamer * Copyright (C) 1999,2000 Erik Walthinsen * 2000,2005 Wim Taymans * * gstbasesrc.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:gstbasesrc * @short_description: Base class for getrange based source elements * @see_also: #GstPushSrc, #GstBaseTransform, #GstBaseSink * * This is a generice base class for source elements. The following * types of sources are supported: * * random access sources like files * seekable sources * live sources * * * * * The source can be configured to operate in any #GstFormat with the * gst_base_src_set_format() method. The currently set format determines * the format of the internal #GstSegment and any #GST_EVENT_NEWSEGMENT * events. The default format for #GstBaseSrc is #GST_FORMAT_BYTES. * * * #GstBaseSrc always supports push mode scheduling. If the following * conditions are met, it also supports pull mode scheduling: * * The format is set to #GST_FORMAT_BYTES (default). * * #GstBaseSrc::is_seekable returns %TRUE. * * * * * Since 0.10.9, any #GstBaseSrc can enable pull based scheduling at any * time by overriding #GstBaseSrc::check_get_range so that it returns %TRUE. * * * If all the conditions are met for operating in pull mode, #GstBaseSrc is * automatically seekable in push mode as well. The following conditions must * be met to make the element seekable in push mode when the format is not * #GST_FORMAT_BYTES: * * * #GstBaseSrc::is_seekable returns %TRUE. * * * #GstBaseSrc::query can convert all supported seek formats to the * internal format as set with gst_base_src_set_format(). * * * #GstBaseSrc::do_seek is implemented, performs the seek and returns %TRUE. * * * * * When the element does not meet the requirements to operate in pull mode, * the offset and length in the #GstBaseSrc::create method should be ignored. * It is recommended to subclass #GstPushSrc instead, in this situation. If the * element can operate in pull mode but only with specific offsets and * lengths, it is allowed to generate an error when the wrong values are passed * to the #GstBaseSrc::create function. * * * #GstBaseSrc has support for live sources. Live sources are sources that * produce data at a fixed rate, such as audio or video capture devices. A * typical live source also provides a clock to publish the rate at which * they produce data. * Use gst_base_src_set_live() to activate the live source mode. * * * A live source does not produce data in the PAUSED state. This means that the * #GstBaseSrc::create method will not be called in PAUSED but only in PLAYING. * To signal the pipeline that the element will not produce data, the return * value from the READY to PAUSED state will be #GST_STATE_CHANGE_NO_PREROLL. * * * A typical live source will timestamp the buffers it creates with the * current stream time of the pipeline. This is one reason why a live source * can only produce data in the PLAYING state, when the clock is actually * distributed and running. * * * Live sources that synchronize and block on the clock (and audio source, for * example) can since 0.10.12 use gst_base_src_wait_playing() when the ::create * function was interrupted by a state change to PAUSED. * * * The #GstBaseSrc::get_times method can be used to implement pseudo-live * sources. The base source will wait for the specified stream time returned in * #GstBaseSrc::get_times before pushing out the buffer. * It only makes sense to implement the ::get_times function if the source is * a live source. * * * There is only support in #GstBaseSrc for exactly one source pad, which * should be named "src". A source implementation (subclass of #GstBaseSrc) * should install a pad template in its base_init function, like so: * * * * static void * my_element_base_init (gpointer g_class) * { * GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class); * // srctemplate should be a #GstStaticPadTemplate with direction * // #GST_PAD_SRC and name "src" * gst_element_class_add_pad_template (gstelement_class, * gst_static_pad_template_get (&srctemplate)); * // see #GstElementDetails * gst_element_class_set_details (gstelement_class, &details); * } * * * Controlled shutdown of live sources in applications * * Applications that record from a live source may want to stop recording * in a controlled way, so that the recording is stopped, but the data * already in the pipeline is processed to the end (remember that many live * sources would go on recording forever otherwise). For that to happen the * application needs to make the source stop recording and send an EOS * event down the pipeline. The application would then wait for an * EOS message posted on the pipeline's bus to know when all data has * been processed and the pipeline can safely be stopped. * * * Since GStreamer 0.10.3 an application may simply set the source * element to NULL or READY state to make it send an EOS event downstream. * The application should lock the state of the source afterwards, so that * shutting down the pipeline from PLAYING doesn't temporarily start up the * source element for a second time: * * ... * // stop recording * gst_element_set_state (audio_source, #GST_STATE_NULL); * gst_element_set_locked_state (audio_source, %TRUE); * ... * * Now the application should wait for an EOS message * to be posted on the pipeline's bus. Once it has received * an EOS message, it may safely shut down the entire pipeline: * * ... * // everything done - shut down pipeline * gst_element_set_state (pipeline, #GST_STATE_NULL); * gst_element_set_locked_state (audio_source, %FALSE); * ... * * * * Note that setting the source element to NULL or READY when the * pipeline is in the PAUSED state may cause a deadlock since the streaming * thread might be blocked in PREROLL. * * * Last reviewed on 2006-09-27 (0.10.11) * * */ #ifdef HAVE_CONFIG_H # include "config.h" #endif #include #include #include "gstbasesrc.h" #include "gsttypefindhelper.h" #include #include GST_DEBUG_CATEGORY_STATIC (gst_base_src_debug); #define GST_CAT_DEFAULT gst_base_src_debug #define GST_LIVE_GET_LOCK(elem) (GST_BASE_SRC_CAST(elem)->live_lock) #define GST_LIVE_LOCK(elem) g_mutex_lock(GST_LIVE_GET_LOCK(elem)) #define GST_LIVE_TRYLOCK(elem) g_mutex_trylock(GST_LIVE_GET_LOCK(elem)) #define GST_LIVE_UNLOCK(elem) g_mutex_unlock(GST_LIVE_GET_LOCK(elem)) #define GST_LIVE_GET_COND(elem) (GST_BASE_SRC_CAST(elem)->live_cond) #define GST_LIVE_WAIT(elem) g_cond_wait (GST_LIVE_GET_COND (elem), GST_LIVE_GET_LOCK (elem)) #define GST_LIVE_TIMED_WAIT(elem, timeval) g_cond_timed_wait (GST_LIVE_GET_COND (elem), GST_LIVE_GET_LOCK (elem),\ timeval) #define GST_LIVE_SIGNAL(elem) g_cond_signal (GST_LIVE_GET_COND (elem)); #define GST_LIVE_BROADCAST(elem) g_cond_broadcast (GST_LIVE_GET_COND (elem)); /* BaseSrc signals and args */ enum { /* FILL ME */ LAST_SIGNAL }; #define DEFAULT_BLOCKSIZE 4096 #define DEFAULT_NUM_BUFFERS -1 #define DEFAULT_TYPEFIND FALSE enum { PROP_0, PROP_BLOCKSIZE, PROP_NUM_BUFFERS, PROP_TYPEFIND, }; #define GST_BASE_SRC_GET_PRIVATE(obj) \ (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_BASE_SRC, GstBaseSrcPrivate)) struct _GstBaseSrcPrivate { gboolean last_sent_eos; /* last thing we did was send an EOS (we set this * to avoid the sending of two EOS in some cases) */ gboolean discont; /* two segments to be sent in the streaming thread with STREAM_LOCK */ GstEvent *close_segment; GstEvent *start_segment; }; static GstElementClass *parent_class = NULL; static void gst_base_src_base_init (gpointer g_class); static void gst_base_src_class_init (GstBaseSrcClass * klass); static void gst_base_src_init (GstBaseSrc * src, gpointer g_class); static void gst_base_src_finalize (GObject * object); GType gst_base_src_get_type (void) { static GType base_src_type = 0; if (G_UNLIKELY (base_src_type == 0)) { static const GTypeInfo base_src_info = { sizeof (GstBaseSrcClass), (GBaseInitFunc) gst_base_src_base_init, NULL, (GClassInitFunc) gst_base_src_class_init, NULL, NULL, sizeof (GstBaseSrc), 0, (GInstanceInitFunc) gst_base_src_init, }; base_src_type = g_type_register_static (GST_TYPE_ELEMENT, "GstBaseSrc", &base_src_info, G_TYPE_FLAG_ABSTRACT); } return base_src_type; } static GstCaps *gst_base_src_getcaps (GstPad * pad); static gboolean gst_base_src_setcaps (GstPad * pad, GstCaps * caps); static void gst_base_src_fixate (GstPad * pad, GstCaps * caps); static gboolean gst_base_src_activate_push (GstPad * pad, gboolean active); static gboolean gst_base_src_activate_pull (GstPad * pad, gboolean active); static void gst_base_src_set_property (GObject * object, guint prop_id, const GValue * value, GParamSpec * pspec); static void gst_base_src_get_property (GObject * object, guint prop_id, GValue * value, GParamSpec * pspec); static gboolean gst_base_src_event_handler (GstPad * pad, GstEvent * event); static gboolean gst_base_src_send_event (GstElement * elem, GstEvent * event); static gboolean gst_base_src_default_event (GstBaseSrc * src, GstEvent * event); static const GstQueryType *gst_base_src_get_query_types (GstElement * element); static gboolean gst_base_src_query (GstPad * pad, GstQuery * query); static gboolean gst_base_src_default_negotiate (GstBaseSrc * basesrc); static gboolean gst_base_src_default_do_seek (GstBaseSrc * src, GstSegment * segment); static gboolean gst_base_src_default_query (GstBaseSrc * src, GstQuery * query); static gboolean gst_base_src_unlock (GstBaseSrc * basesrc); static gboolean gst_base_src_start (GstBaseSrc * basesrc); static gboolean gst_base_src_stop (GstBaseSrc * basesrc); static GstStateChangeReturn gst_base_src_change_state (GstElement * element, GstStateChange transition); static void gst_base_src_loop (GstPad * pad); static gboolean gst_base_src_pad_check_get_range (GstPad * pad); static gboolean gst_base_src_default_check_get_range (GstBaseSrc * bsrc); static GstFlowReturn gst_base_src_pad_get_range (GstPad * pad, guint64 offset, guint length, GstBuffer ** buf); static GstFlowReturn gst_base_src_get_range (GstBaseSrc * src, guint64 offset, guint length, GstBuffer ** buf); static void gst_base_src_base_init (gpointer g_class) { GST_DEBUG_CATEGORY_INIT (gst_base_src_debug, "basesrc", 0, "basesrc element"); } static void gst_base_src_class_init (GstBaseSrcClass * klass) { GObjectClass *gobject_class; GstElementClass *gstelement_class; gobject_class = G_OBJECT_CLASS (klass); gstelement_class = GST_ELEMENT_CLASS (klass); g_type_class_add_private (klass, sizeof (GstBaseSrcPrivate)); parent_class = g_type_class_peek_parent (klass); gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_base_src_finalize); gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_base_src_set_property); gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_base_src_get_property); g_object_class_install_property (gobject_class, PROP_BLOCKSIZE, g_param_spec_ulong ("blocksize", "Block size", "Size in bytes to read per buffer (0 = default)", 0, G_MAXULONG, DEFAULT_BLOCKSIZE, G_PARAM_READWRITE)); g_object_class_install_property (gobject_class, PROP_NUM_BUFFERS, g_param_spec_int ("num-buffers", "num-buffers", "Number of buffers to output before sending EOS", -1, G_MAXINT, DEFAULT_NUM_BUFFERS, G_PARAM_READWRITE)); g_object_class_install_property (gobject_class, PROP_TYPEFIND, g_param_spec_boolean ("typefind", "Typefind", "Run typefind before negotiating", DEFAULT_TYPEFIND, G_PARAM_READWRITE)); gstelement_class->change_state = GST_DEBUG_FUNCPTR (gst_base_src_change_state); gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_base_src_send_event); gstelement_class->get_query_types = GST_DEBUG_FUNCPTR (gst_base_src_get_query_types); klass->negotiate = GST_DEBUG_FUNCPTR (gst_base_src_default_negotiate); klass->event = GST_DEBUG_FUNCPTR (gst_base_src_default_event); klass->do_seek = GST_DEBUG_FUNCPTR (gst_base_src_default_do_seek); klass->query = GST_DEBUG_FUNCPTR (gst_base_src_default_query); klass->check_get_range = GST_DEBUG_FUNCPTR (gst_base_src_default_check_get_range); } static void gst_base_src_init (GstBaseSrc * basesrc, gpointer g_class) { GstPad *pad; GstPadTemplate *pad_template; basesrc->priv = GST_BASE_SRC_GET_PRIVATE (basesrc); basesrc->is_live = FALSE; basesrc->live_lock = g_mutex_new (); basesrc->live_cond = g_cond_new (); basesrc->num_buffers = DEFAULT_NUM_BUFFERS; basesrc->num_buffers_left = -1; basesrc->can_activate_push = TRUE; basesrc->pad_mode = GST_ACTIVATE_NONE; pad_template = gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "src"); g_return_if_fail (pad_template != NULL); GST_DEBUG_OBJECT (basesrc, "creating src pad"); pad = gst_pad_new_from_template (pad_template, "src"); GST_DEBUG_OBJECT (basesrc, "setting functions on src pad"); gst_pad_set_activatepush_function (pad, GST_DEBUG_FUNCPTR (gst_base_src_activate_push)); gst_pad_set_activatepull_function (pad, GST_DEBUG_FUNCPTR (gst_base_src_activate_pull)); gst_pad_set_event_function (pad, GST_DEBUG_FUNCPTR (gst_base_src_event_handler)); gst_pad_set_query_function (pad, GST_DEBUG_FUNCPTR (gst_base_src_query)); gst_pad_set_checkgetrange_function (pad, GST_DEBUG_FUNCPTR (gst_base_src_pad_check_get_range)); gst_pad_set_getrange_function (pad, GST_DEBUG_FUNCPTR (gst_base_src_pad_get_range)); gst_pad_set_getcaps_function (pad, GST_DEBUG_FUNCPTR (gst_base_src_getcaps)); gst_pad_set_setcaps_function (pad, GST_DEBUG_FUNCPTR (gst_base_src_setcaps)); gst_pad_set_fixatecaps_function (pad, GST_DEBUG_FUNCPTR (gst_base_src_fixate)); /* hold pointer to pad */ basesrc->srcpad = pad; GST_DEBUG_OBJECT (basesrc, "adding src pad"); gst_element_add_pad (GST_ELEMENT (basesrc), pad); basesrc->blocksize = DEFAULT_BLOCKSIZE; basesrc->clock_id = NULL; /* we operate in BYTES by default */ gst_base_src_set_format (basesrc, GST_FORMAT_BYTES); basesrc->data.ABI.typefind = DEFAULT_TYPEFIND; GST_OBJECT_FLAG_UNSET (basesrc, GST_BASE_SRC_STARTED); GST_DEBUG_OBJECT (basesrc, "init done"); } static void gst_base_src_finalize (GObject * object) { GstBaseSrc *basesrc; GstEvent **event_p; basesrc = GST_BASE_SRC (object); g_mutex_free (basesrc->live_lock); g_cond_free (basesrc->live_cond); event_p = &basesrc->data.ABI.pending_seek; gst_event_replace ((GstEvent **) event_p, NULL); G_OBJECT_CLASS (parent_class)->finalize (object); } /** * gst_base_src_wait_playing: * @src: the src * * If the #GstBaseSrcClass::create method performs its own synchronisation against * the clock it must unblock when going from PLAYING to the PAUSED state and call * this method before continuing to produce the remaining data. * * This function will block until a state change to PLAYING happens (in which * case this function returns #GST_FLOW_OK) or the processing must be stopped due * to a state change to READY or a FLUSH event (in which case this function * returns #GST_FLOW_WRONG_STATE). * * Since: 0.10.12 * * Returns: #GST_FLOW_OK if @src is PLAYING and processing can * continue. Any other return value should be returned from the create vmethod. */ GstFlowReturn gst_base_src_wait_playing (GstBaseSrc * src) { /* block until the state changes, or we get a flush, or something */ GST_LIVE_LOCK (src); if (src->is_live) { while (G_UNLIKELY (!src->live_running)) { GST_DEBUG ("live source signal waiting"); GST_LIVE_SIGNAL (src); GST_DEBUG ("live source waiting for running state"); GST_LIVE_WAIT (src); GST_DEBUG ("live source unlocked"); } /* FIXME, use another variable to signal stopping so that we don't * have to grab another lock. */ GST_OBJECT_LOCK (src->srcpad); if (G_UNLIKELY (GST_PAD_IS_FLUSHING (src->srcpad))) goto flushing; GST_OBJECT_UNLOCK (src->srcpad); } GST_LIVE_UNLOCK (src); return GST_FLOW_OK; /* ERRORS */ flushing: { GST_DEBUG_OBJECT (src, "pad is flushing"); GST_OBJECT_UNLOCK (src->srcpad); GST_LIVE_UNLOCK (src); return GST_FLOW_WRONG_STATE; } } /** * gst_base_src_set_live: * @src: base source instance * @live: new live-mode * * If the element listens to a live source, @live should * be set to %TRUE. * * A live source will not produce data in the PAUSED state and * will therefore not be able to participate in the PREROLL phase * of a pipeline. To signal this fact to the application and the * pipeline, the state change return value of the live source will * be GST_STATE_CHANGE_NO_PREROLL. */ void gst_base_src_set_live (GstBaseSrc * src, gboolean live) { GST_LIVE_LOCK (src); src->is_live = live; GST_LIVE_UNLOCK (src); } /** * gst_base_src_is_live: * @src: base source instance * * Check if an element is in live mode. * * Returns: %TRUE if element is in live mode. */ gboolean gst_base_src_is_live (GstBaseSrc * src) { gboolean result; GST_LIVE_LOCK (src); result = src->is_live; GST_LIVE_UNLOCK (src); return result; } /** * gst_base_src_set_format: * @src: base source instance * @format: the format to use * * Sets the default format of the source. This will be the format used * for sending NEW_SEGMENT events and for performing seeks. * * If a format of GST_FORMAT_BYTES is set, the element will be able to * operate in pull mode if the #GstBaseSrc::is_seekable returns TRUE. * * @Since: 0.10.1 */ void gst_base_src_set_format (GstBaseSrc * src, GstFormat format) { gst_segment_init (&src->segment, format); } static gboolean gst_base_src_setcaps (GstPad * pad, GstCaps * caps) { GstBaseSrcClass *bclass; GstBaseSrc *bsrc; gboolean res = TRUE; bsrc = GST_BASE_SRC (GST_PAD_PARENT (pad)); bclass = GST_BASE_SRC_GET_CLASS (bsrc); if (bclass->set_caps) res = bclass->set_caps (bsrc, caps); return res; } static GstCaps * gst_base_src_getcaps (GstPad * pad) { GstBaseSrcClass *bclass; GstBaseSrc *bsrc; GstCaps *caps = NULL; bsrc = GST_BASE_SRC (GST_PAD_PARENT (pad)); bclass = GST_BASE_SRC_GET_CLASS (bsrc); if (bclass->get_caps) caps = bclass->get_caps (bsrc); if (caps == NULL) { GstPadTemplate *pad_template; pad_template = gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass), "src"); if (pad_template != NULL) { caps = gst_caps_ref (gst_pad_template_get_caps (pad_template)); } } return caps; } static void gst_base_src_fixate (GstPad * pad, GstCaps * caps) { GstBaseSrcClass *bclass; GstBaseSrc *bsrc; bsrc = GST_BASE_SRC (gst_pad_get_parent (pad)); bclass = GST_BASE_SRC_GET_CLASS (bsrc); if (bclass->fixate) bclass->fixate (bsrc, caps); gst_object_unref (bsrc); } static gboolean gst_base_src_default_query (GstBaseSrc * src, GstQuery * query) { gboolean res; switch (GST_QUERY_TYPE (query)) { case GST_QUERY_POSITION: { GstFormat format; gst_query_parse_position (query, &format, NULL); switch (format) { case GST_FORMAT_PERCENT: { gint64 percent; gint64 position; gint64 duration; position = src->segment.last_stop; duration = src->segment.duration; if (position != -1 && duration != -1) { if (position < duration) percent = gst_util_uint64_scale (GST_FORMAT_PERCENT_MAX, position, duration); else percent = GST_FORMAT_PERCENT_MAX; } else percent = -1; gst_query_set_position (query, GST_FORMAT_PERCENT, percent); res = TRUE; break; } default: { gint64 position; position = src->segment.last_stop; if (position != -1) { /* convert to requested format */ res = gst_pad_query_convert (src->srcpad, src->segment.format, position, &format, &position); } else res = TRUE; gst_query_set_position (query, format, position); break; } } break; } case GST_QUERY_DURATION: { GstFormat format; gst_query_parse_duration (query, &format, NULL); switch (format) { case GST_FORMAT_PERCENT: gst_query_set_duration (query, GST_FORMAT_PERCENT, GST_FORMAT_PERCENT_MAX); res = TRUE; break; default: { gint64 duration; duration = src->segment.duration; if (duration != -1) { /* convert to requested format */ res = gst_pad_query_convert (src->srcpad, src->segment.format, duration, &format, &duration); } else { res = TRUE; } gst_query_set_duration (query, format, duration); break; } } break; } case GST_QUERY_SEEKING: { gst_query_set_seeking (query, src->segment.format, src->seekable, 0, src->segment.duration); res = TRUE; break; } case GST_QUERY_SEGMENT: { gint64 start, stop; /* no end segment configured, current duration then */ if ((stop = src->segment.stop) == -1) stop = src->segment.duration; start = src->segment.start; /* adjust to stream time */ if (src->segment.time != -1) { start -= src->segment.time; if (stop != -1) stop -= src->segment.time; } gst_query_set_segment (query, src->segment.rate, src->segment.format, start, stop); res = TRUE; break; } case GST_QUERY_FORMATS: { gst_query_set_formats (query, 3, GST_FORMAT_DEFAULT, GST_FORMAT_BYTES, GST_FORMAT_PERCENT); res = TRUE; break; } case GST_QUERY_CONVERT: { GstFormat src_fmt, dest_fmt; gint64 src_val, dest_val; gst_query_parse_convert (query, &src_fmt, &src_val, &dest_fmt, &dest_val); /* we can only convert between equal formats... */ if (src_fmt == dest_fmt) { dest_val = src_val; res = TRUE; } else res = FALSE; gst_query_set_convert (query, src_fmt, src_val, dest_fmt, dest_val); break; } case GST_QUERY_LATENCY: /* we can only report the fact that we are live or not, we know nothing * about latency. Subclasses should override and implement something * usefull */ GST_LIVE_LOCK (src); gst_query_set_latency (query, src->is_live, 0, -1); GST_LIVE_UNLOCK (src); res = TRUE; break; case GST_QUERY_JITTER: case GST_QUERY_RATE: default: res = FALSE; break; } return res; } static gboolean gst_base_src_query (GstPad * pad, GstQuery * query) { GstBaseSrc *src; GstBaseSrcClass *bclass; gboolean result = FALSE; src = GST_BASE_SRC (gst_pad_get_parent (pad)); bclass = GST_BASE_SRC_GET_CLASS (src); if (bclass->query) result = bclass->query (src, query); else result = gst_pad_query_default (pad, query); gst_object_unref (src); return result; } static gboolean gst_base_src_default_do_seek (GstBaseSrc * src, GstSegment * segment) { gboolean res = TRUE; /* update our offset if the start/stop position was updated */ if (segment->format == GST_FORMAT_BYTES) { segment->last_stop = segment->start; segment->time = segment->start; } else if (segment->start == 0) { /* seek to start, we can implement a default for this. */ segment->last_stop = 0; segment->time = 0; res = TRUE; } else res = FALSE; return res; } static gboolean gst_base_src_do_seek (GstBaseSrc * src, GstSegment * segment) { GstBaseSrcClass *bclass; gboolean result = FALSE; bclass = GST_BASE_SRC_GET_CLASS (src); if (bclass->do_seek) result = bclass->do_seek (src, segment); return result; } /* this code implements the seeking. It is a good example * handling all cases. * * A seek updates the currently configured segment.start * and segment.stop values based on the SEEK_TYPE. If the * segment.start value is updated, a seek to this new position * should be performed. * * The seek can only be executed when we are not currently * streaming any data, to make sure that this is the case, we * acquire the STREAM_LOCK which is taken when we are in the * _loop() function or when a getrange() is called. Normally * we will not receive a seek if we are operating in pull mode * though. * * When we are in the loop() function, we might be in the middle * of pushing a buffer, which might block in a sink. To make sure * that the push gets unblocked we push out a FLUSH_START event. * Our loop function will get a WRONG_STATE return value from * the push and will pause, effectively releasing the STREAM_LOCK. * * For a non-flushing seek, we pause the task, which might eventually * release the STREAM_LOCK. We say eventually because when the sink * blocks on the sample we might wait a very long time until the sink * unblocks the sample. In any case we acquire the STREAM_LOCK and * can continue the seek. A non-flushing seek is normally done in a * running pipeline to perform seamless playback. * In the case of a non-flushing seek we need to make sure that the * data we output after the seek is continuous with the previous data, * this is because a non-flushing seek does not reset the stream-time * to 0. We do this by closing the currently running segment, ie. sending * a new_segment event with the stop position set to the last processed * position. * * After updating the segment.start/stop values, we prepare for * streaming again. We push out a FLUSH_STOP to make the peer pad * accept data again and we start our task again. * * A segment seek posts a message on the bus saying that the playback * of the segment started. We store the segment flag internally because * when we reach the segment.stop we have to post a segment.done * instead of EOS when doing a segment seek. */ /* FIXME, we have the unlock gboolean here because most current implementations * (fdsrc, -base/gst/tcp/, ...) not only unlock when there is something to * unlock */ static gboolean gst_base_src_perform_seek (GstBaseSrc * src, GstEvent * event, gboolean unlock) { gboolean res; gdouble rate; GstFormat format; GstSeekFlags flags; GstSeekType cur_type, stop_type; gint64 cur, stop; gboolean flush; gboolean update; GstSegment seeksegment; GST_DEBUG_OBJECT (src, "doing seek"); if (event) { gst_event_parse_seek (event, &rate, &format, &flags, &cur_type, &cur, &stop_type, &stop); /* we have to have a format as the segment format. Try to convert * if not. */ if (src->segment.format != format) { GstFormat fmt; fmt = src->segment.format; res = TRUE; if (cur_type != GST_SEEK_TYPE_NONE) res = gst_pad_query_convert (src->srcpad, format, cur, &fmt, &cur); if (res && stop_type != GST_SEEK_TYPE_NONE) res = gst_pad_query_convert (src->srcpad, format, stop, &fmt, &stop); if (!res) goto no_format; format = fmt; } } else { flags = 0; } flush = flags & GST_SEEK_FLAG_FLUSH; /* send flush start */ if (flush) gst_pad_push_event (src->srcpad, gst_event_new_flush_start ()); else gst_pad_pause_task (src->srcpad); /* unblock streaming thread */ if (unlock) gst_base_src_unlock (src); /* grab streaming lock, this should eventually be possible, either * because the task is paused or our streaming thread stopped * because our peer is flushing. */ GST_PAD_STREAM_LOCK (src->srcpad); /* make copy into temp structure, we can only update the main one * when the subclass actually could do the seek. */ memcpy (&seeksegment, &src->segment, sizeof (GstSegment)); /* now configure the seek segment */ if (event) { gst_segment_set_seek (&seeksegment, rate, format, flags, cur_type, cur, stop_type, stop, &update); } GST_DEBUG_OBJECT (src, "segment configured from %" G_GINT64_FORMAT " to %" G_GINT64_FORMAT ", position %" G_GINT64_FORMAT, seeksegment.start, seeksegment.stop, seeksegment.last_stop); /* do the seek, segment.last_stop contains new position. */ res = gst_base_src_do_seek (src, &seeksegment); /* and prepare to continue streaming */ if (flush) { /* send flush stop, peer will accept data and events again. We * are not yet providing data as we still have the STREAM_LOCK. */ gst_pad_push_event (src->srcpad, gst_event_new_flush_stop ()); } else if (res && src->data.ABI.running) { /* we are running the current segment and doing a non-flushing seek, * close the segment first based on the last_stop. */ GST_DEBUG_OBJECT (src, "closing running segment %" G_GINT64_FORMAT " to %" G_GINT64_FORMAT, src->segment.start, src->segment.last_stop); /* queue the segment for sending in the stream thread */ if (src->priv->close_segment) gst_event_unref (src->priv->close_segment); src->priv->close_segment = gst_event_new_new_segment_full (TRUE, src->segment.rate, src->segment.applied_rate, src->segment.format, src->segment.start, src->segment.last_stop, src->segment.time); } /* if successfull seek, we update our real segment and push * out the new segment. */ if (res) { memcpy (&src->segment, &seeksegment, sizeof (GstSegment)); if (src->segment.flags & GST_SEEK_FLAG_SEGMENT) { gst_element_post_message (GST_ELEMENT (src), gst_message_new_segment_start (GST_OBJECT (src), src->segment.format, src->segment.last_stop)); } /* for deriving a stop position for the playback segment form the seek * segment, we must take the duration when the stop is not set */ if ((stop = src->segment.stop) == -1) stop = src->segment.duration; GST_DEBUG_OBJECT (src, "Sending newsegment from %" G_GINT64_FORMAT " to %" G_GINT64_FORMAT, src->segment.start, stop); /* now replace the old segment so that we send it in the stream thread the * next time it is scheduled. */ if (src->priv->start_segment) gst_event_unref (src->priv->start_segment); src->priv->start_segment = gst_event_new_new_segment_full (FALSE, src->segment.rate, src->segment.applied_rate, src->segment.format, src->segment.last_stop, stop, src->segment.time); } src->priv->discont = TRUE; src->data.ABI.running = TRUE; /* and restart the task in case it got paused explicitely or by * the FLUSH_START event we pushed out. */ gst_pad_start_task (src->srcpad, (GstTaskFunction) gst_base_src_loop, src->srcpad); /* and release the lock again so we can continue streaming */ GST_PAD_STREAM_UNLOCK (src->srcpad); return res; /* ERROR */ no_format: { GST_DEBUG_OBJECT (src, "undefined format given, seek aborted."); return FALSE; } } static const GstQueryType * gst_base_src_get_query_types (GstElement * element) { static const GstQueryType query_types[] = { GST_QUERY_DURATION, GST_QUERY_POSITION, GST_QUERY_SEEKING, GST_QUERY_SEGMENT, GST_QUERY_FORMATS, GST_QUERY_LATENCY, GST_QUERY_JITTER, GST_QUERY_RATE, GST_QUERY_CONVERT, 0 }; return query_types; } /* all events send to this element directly */ static gboolean gst_base_src_send_event (GstElement * element, GstEvent * event) { GstBaseSrc *src; gboolean result = FALSE; src = GST_BASE_SRC (element); switch (GST_EVENT_TYPE (event)) { case GST_EVENT_FLUSH_START: case GST_EVENT_FLUSH_STOP: /* sending random flushes downstream can break stuff, * especially sync since all segment info will get flushed */ break; case GST_EVENT_EOS: /* FIXME, queue EOS and make sure the task or pull function * perform the EOS actions. */ break; case GST_EVENT_NEWSEGMENT: /* sending random NEWSEGMENT downstream can break sync. */ break; case GST_EVENT_TAG: case GST_EVENT_BUFFERSIZE: break; case GST_EVENT_QOS: break; case GST_EVENT_SEEK: { gboolean started; GST_OBJECT_LOCK (src->srcpad); if (GST_PAD_ACTIVATE_MODE (src->srcpad) == GST_ACTIVATE_PULL) goto wrong_mode; started = GST_PAD_ACTIVATE_MODE (src->srcpad) == GST_ACTIVATE_PUSH; GST_OBJECT_UNLOCK (src->srcpad); if (started) { /* when we are running in push mode, we can execute the * seek right now, we need to unlock. */ result = gst_base_src_perform_seek (src, event, TRUE); } else { GstEvent **event_p; /* else we store the event and execute the seek when we * get activated */ GST_OBJECT_LOCK (src); event_p = &src->data.ABI.pending_seek; gst_event_replace ((GstEvent **) event_p, event); GST_OBJECT_UNLOCK (src); /* assume the seek will work */ result = TRUE; } break; } case GST_EVENT_NAVIGATION: break; default: break; } done: gst_event_unref (event); return result; /* ERRORS */ wrong_mode: { GST_DEBUG_OBJECT (src, "cannot perform seek when operating in pull mode"); GST_OBJECT_UNLOCK (src->srcpad); result = FALSE; goto done; } } static gboolean gst_base_src_default_event (GstBaseSrc * src, GstEvent * event) { gboolean result; switch (GST_EVENT_TYPE (event)) { case GST_EVENT_SEEK: /* is normally called when in push mode */ if (!src->seekable) goto not_seekable; result = gst_base_src_perform_seek (src, event, TRUE); break; case GST_EVENT_FLUSH_START: /* cancel any blocking getrange, is normally called * when in pull mode. */ result = gst_base_src_unlock (src); break; case GST_EVENT_FLUSH_STOP: default: result = TRUE; break; } return result; /* ERRORS */ not_seekable: { GST_DEBUG_OBJECT (src, "is not seekable"); return FALSE; } } static gboolean gst_base_src_event_handler (GstPad * pad, GstEvent * event) { GstBaseSrc *src; GstBaseSrcClass *bclass; gboolean result = FALSE; src = GST_BASE_SRC (gst_pad_get_parent (pad)); bclass = GST_BASE_SRC_GET_CLASS (src); if (bclass->event) { if (!(result = bclass->event (src, event))) goto subclass_failed; } done: gst_event_unref (event); gst_object_unref (src); return result; /* ERRORS */ subclass_failed: { GST_DEBUG_OBJECT (src, "subclass refused event"); goto done; } } static void gst_base_src_set_property (GObject * object, guint prop_id, const GValue * value, GParamSpec * pspec) { GstBaseSrc *src; src = GST_BASE_SRC (object); switch (prop_id) { case PROP_BLOCKSIZE: src->blocksize = g_value_get_ulong (value); break; case PROP_NUM_BUFFERS: src->num_buffers = g_value_get_int (value); break; case PROP_TYPEFIND: src->data.ABI.typefind = g_value_get_boolean (value); break; default: G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); break; } } static void gst_base_src_get_property (GObject * object, guint prop_id, GValue * value, GParamSpec * pspec) { GstBaseSrc *src; src = GST_BASE_SRC (object); switch (prop_id) { case PROP_BLOCKSIZE: g_value_set_ulong (value, src->blocksize); break; case PROP_NUM_BUFFERS: g_value_set_int (value, src->num_buffers); break; case PROP_TYPEFIND: g_value_set_boolean (value, src->data.ABI.typefind); break; default: G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); break; } } /* with STREAM_LOCK and LOCK */ static GstClockReturn gst_base_src_wait (GstBaseSrc * basesrc, GstClockTime time) { GstClockReturn ret; GstClockID id; GstClock *clock; /* get clock, if no clock, we don't sync */ if ((clock = GST_ELEMENT_CLOCK (basesrc)) == NULL) return GST_CLOCK_OK; id = gst_clock_new_single_shot_id (clock, time); basesrc->clock_id = id; /* release the object lock while waiting */ GST_OBJECT_UNLOCK (basesrc); ret = gst_clock_id_wait (id, NULL); GST_OBJECT_LOCK (basesrc); gst_clock_id_unref (id); basesrc->clock_id = NULL; return ret; } /* perform synchronisation on a buffer. * with STREAM_LOCK. */ static GstClockReturn gst_base_src_do_sync (GstBaseSrc * basesrc, GstBuffer * buffer) { GstClockReturn result; GstClockTime start, end; GstBaseSrcClass *bclass; GstClockTime base_time; bclass = GST_BASE_SRC_GET_CLASS (basesrc); start = end = -1; if (bclass->get_times) bclass->get_times (basesrc, buffer, &start, &end); /* if we don't have a timestamp, we don't sync */ if (!GST_CLOCK_TIME_IS_VALID (start)) goto invalid_start; /* now do clocking */ GST_OBJECT_LOCK (basesrc); base_time = GST_ELEMENT_CAST (basesrc)->base_time; GST_LOG_OBJECT (basesrc, "waiting for clock, base time %" GST_TIME_FORMAT ", stream_start %" GST_TIME_FORMAT, GST_TIME_ARGS (base_time), GST_TIME_ARGS (start)); result = gst_base_src_wait (basesrc, start + base_time); GST_OBJECT_UNLOCK (basesrc); GST_LOG_OBJECT (basesrc, "clock entry done: %d", result); return result; /* special cases */ invalid_start: { GST_DEBUG_OBJECT (basesrc, "get_times returned invalid start"); return GST_CLOCK_OK; } } static gboolean gst_base_src_update_length (GstBaseSrc * src, guint64 offset, guint * length) { guint64 size, maxsize; GstBaseSrcClass *bclass; bclass = GST_BASE_SRC_GET_CLASS (src); /* only operate if we are working with bytes */ if (src->segment.format != GST_FORMAT_BYTES) return TRUE; /* get total file size */ size = (guint64) src->segment.duration; /* the max amount of bytes to read is the total size or * up to the segment.stop if present. */ if (src->segment.stop != -1) maxsize = MIN (size, src->segment.stop); else maxsize = size; GST_DEBUG_OBJECT (src, "reading offset %" G_GUINT64_FORMAT ", length %u, size %" G_GINT64_FORMAT ", segment.stop %" G_GINT64_FORMAT ", maxsize %" G_GINT64_FORMAT, offset, *length, size, src->segment.stop, maxsize); /* check size if we have one */ if (maxsize != -1) { /* if we run past the end, check if the file became bigger and * retry. */ if (G_UNLIKELY (offset + *length >= maxsize)) { /* see if length of the file changed */ if (bclass->get_size) if (!bclass->get_size (src, &size)) size = -1; gst_segment_set_duration (&src->segment, GST_FORMAT_BYTES, size); /* make sure we don't exceed the configured segment stop * if it was set */ if (src->segment.stop != -1) maxsize = MIN (size, src->segment.stop); else maxsize = size; /* if we are at or past the end, EOS */ if (G_UNLIKELY (offset >= maxsize)) goto unexpected_length; /* else we can clip to the end */ if (G_UNLIKELY (offset + *length >= maxsize)) *length = maxsize - offset; } } /* keep track of current position. segment is in bytes, we checked * that above. */ gst_segment_set_last_stop (&src->segment, GST_FORMAT_BYTES, offset); return TRUE; /* ERRORS */ unexpected_length: { return FALSE; } } static GstFlowReturn gst_base_src_get_range (GstBaseSrc * src, guint64 offset, guint length, GstBuffer ** buf) { GstFlowReturn ret; GstBaseSrcClass *bclass; GstClockReturn status; bclass = GST_BASE_SRC_GET_CLASS (src); ret = gst_base_src_wait_playing (src); if (ret != GST_FLOW_OK) goto stopped; if (G_UNLIKELY (!GST_OBJECT_FLAG_IS_SET (src, GST_BASE_SRC_STARTED))) goto not_started; if (G_UNLIKELY (!bclass->create)) goto no_function; if (G_UNLIKELY (!gst_base_src_update_length (src, offset, &length))) goto unexpected_length; /* normally we don't count buffers */ if (G_UNLIKELY (src->num_buffers_left >= 0)) { if (src->num_buffers_left == 0) goto reached_num_buffers; else src->num_buffers_left--; } GST_DEBUG_OBJECT (src, "calling create offset %" G_GUINT64_FORMAT " length %u, time %" G_GINT64_FORMAT, offset, length, src->segment.time); ret = bclass->create (src, offset, length, buf); if (G_UNLIKELY (ret != GST_FLOW_OK)) goto done; /* no timestamp set and we are at offset 0, we can timestamp with 0 */ if (offset == 0 && src->segment.time == 0 && GST_BUFFER_TIMESTAMP (*buf) == -1) GST_BUFFER_TIMESTAMP (*buf) = 0; /* now sync before pushing the buffer */ status = gst_base_src_do_sync (src, *buf); switch (status) { case GST_CLOCK_EARLY: GST_DEBUG_OBJECT (src, "buffer too late!, returning anyway"); break; case GST_CLOCK_OK: GST_DEBUG_OBJECT (src, "buffer ok"); break; default: /* this case is triggered when we were waiting for the clock and * it got unlocked because we did a state change. We return * WRONG_STATE in this case to stop the dataflow also get rid of the * produced buffer. */ GST_DEBUG_OBJECT (src, "clock returned %d, not returning", status); gst_buffer_unref (*buf); *buf = NULL; ret = GST_FLOW_WRONG_STATE; break; } done: return ret; /* ERROR */ stopped: { GST_DEBUG_OBJECT (src, "wait_playing returned %d", ret); return ret; } not_started: { GST_DEBUG_OBJECT (src, "getrange but not started"); return GST_FLOW_WRONG_STATE; } no_function: { GST_DEBUG_OBJECT (src, "no create function"); return GST_FLOW_ERROR; } unexpected_length: { GST_DEBUG_OBJECT (src, "unexpected length %u (offset=%" G_GUINT64_FORMAT ", size=%" G_GINT64_FORMAT ")", length, offset, src->segment.duration); return GST_FLOW_UNEXPECTED; } reached_num_buffers: { GST_DEBUG_OBJECT (src, "sent all buffers"); return GST_FLOW_UNEXPECTED; } } static GstFlowReturn gst_base_src_pad_get_range (GstPad * pad, guint64 offset, guint length, GstBuffer ** buf) { GstBaseSrc *src; GstFlowReturn res; src = GST_BASE_SRC (gst_pad_get_parent (pad)); res = gst_base_src_get_range (src, offset, length, buf); gst_object_unref (src); return res; } static gboolean gst_base_src_default_check_get_range (GstBaseSrc * src) { gboolean res; if (!GST_OBJECT_FLAG_IS_SET (src, GST_BASE_SRC_STARTED)) { GST_LOG_OBJECT (src, "doing start/stop to check get_range support"); if (G_LIKELY (gst_base_src_start (src))) gst_base_src_stop (src); } /* we can operate in getrange mode if the native format is bytes * and we are seekable, this condition is set in the random_access * flag and is set in the _start() method. */ res = src->random_access; return res; } static gboolean gst_base_src_check_get_range (GstBaseSrc * src) { GstBaseSrcClass *bclass; gboolean res; bclass = GST_BASE_SRC_GET_CLASS (src); if (bclass->check_get_range == NULL) goto no_function; res = bclass->check_get_range (src); GST_LOG_OBJECT (src, "%s() returned %d", GST_DEBUG_FUNCPTR_NAME (bclass->check_get_range), (gint) res); return res; /* ERRORS */ no_function: { GST_WARNING_OBJECT (src, "no check_get_range function set"); return FALSE; } } static gboolean gst_base_src_pad_check_get_range (GstPad * pad) { GstBaseSrc *src; gboolean res; src = GST_BASE_SRC (gst_pad_get_parent (pad)); res = gst_base_src_check_get_range (src); gst_object_unref (src); return res; } static void gst_base_src_loop (GstPad * pad) { GstBaseSrc *src; GstBuffer *buf = NULL; GstFlowReturn ret; gint64 position; gboolean eos; eos = FALSE; src = GST_BASE_SRC (gst_pad_get_parent (pad)); src->priv->last_sent_eos = FALSE; /* push events to close/start our segment before we do the real work. */ if (src->priv->close_segment) { gst_pad_push_event (pad, src->priv->close_segment); src->priv->close_segment = NULL; } if (src->priv->start_segment) { gst_pad_push_event (pad, src->priv->start_segment); src->priv->start_segment = NULL; } /* if we operate in bytes, we can calculate an offset */ if (src->segment.format == GST_FORMAT_BYTES) position = src->segment.last_stop; else position = -1; ret = gst_base_src_get_range (src, position, src->blocksize, &buf); if (G_UNLIKELY (ret != GST_FLOW_OK)) { GST_INFO_OBJECT (src, "pausing after gst_base_src_get_range() = %d", ret); goto pause; } if (G_UNLIKELY (buf == NULL)) goto null_buffer; /* figure out the new position */ switch (src->segment.format) { case GST_FORMAT_BYTES: position += GST_BUFFER_SIZE (buf); break; case GST_FORMAT_TIME: { GstClockTime start, duration; start = GST_BUFFER_TIMESTAMP (buf); duration = GST_BUFFER_DURATION (buf); if (GST_CLOCK_TIME_IS_VALID (start)) position = start; else position = src->segment.last_stop; if (GST_CLOCK_TIME_IS_VALID (duration)) position += duration; break; } case GST_FORMAT_DEFAULT: position = GST_BUFFER_OFFSET_END (buf); break; default: position = -1; break; } if (position != -1) { if (src->segment.stop != -1) { if (position >= src->segment.stop) { eos = TRUE; position = src->segment.stop; } } gst_segment_set_last_stop (&src->segment, src->segment.format, position); } if (G_UNLIKELY (src->priv->discont)) { buf = gst_buffer_make_metadata_writable (buf); GST_BUFFER_FLAG_SET (buf, GST_BUFFER_FLAG_DISCONT); src->priv->discont = FALSE; } ret = gst_pad_push (pad, buf); if (G_UNLIKELY (ret != GST_FLOW_OK)) { GST_INFO_OBJECT (src, "pausing after gst_pad_push() = %d", ret); goto pause; } if (eos) { GST_INFO_OBJECT (src, "pausing after EOS"); ret = GST_FLOW_UNEXPECTED; goto pause; } done: gst_object_unref (src); return; /* special cases */ pause: { const gchar *reason = gst_flow_get_name (ret); GST_DEBUG_OBJECT (src, "pausing task, reason %s", reason); src->data.ABI.running = FALSE; gst_pad_pause_task (pad); if (GST_FLOW_IS_FATAL (ret) || ret == GST_FLOW_NOT_LINKED) { if (ret == GST_FLOW_UNEXPECTED) { /* perform EOS logic */ if (src->segment.flags & GST_SEEK_FLAG_SEGMENT) { gst_element_post_message (GST_ELEMENT_CAST (src), gst_message_new_segment_done (GST_OBJECT_CAST (src), src->segment.format, src->segment.last_stop)); } else { gst_pad_push_event (pad, gst_event_new_eos ()); src->priv->last_sent_eos = TRUE; } } else { /* for fatal errors we post an error message, post the error * first so the app knows about the error first. */ GST_ELEMENT_ERROR (src, STREAM, FAILED, (_("Internal data flow error.")), ("streaming task paused, reason %s (%d)", reason, ret)); gst_pad_push_event (pad, gst_event_new_eos ()); src->priv->last_sent_eos = TRUE; } } goto done; } null_buffer: { GST_ELEMENT_ERROR (src, STREAM, FAILED, (_("Internal data flow error.")), ("element returned NULL buffer")); /* we finished the segment on error */ src->data.ABI.running = FALSE; gst_pad_pause_task (pad); gst_pad_push_event (pad, gst_event_new_eos ()); src->priv->last_sent_eos = TRUE; goto done; } } /* this will always be called between start() and stop(). So you can rely on * resources allocated by start() and freed from stop(). This needs to be added * to the docs at some point. */ static gboolean gst_base_src_unlock (GstBaseSrc * basesrc) { GstBaseSrcClass *bclass; gboolean result = TRUE; GST_DEBUG ("unlock"); /* unblock whatever the subclass is doing */ bclass = GST_BASE_SRC_GET_CLASS (basesrc); if (bclass->unlock) result = bclass->unlock (basesrc); GST_DEBUG ("unschedule clock"); /* and unblock the clock as well, if any */ GST_OBJECT_LOCK (basesrc); if (basesrc->clock_id) { gst_clock_id_unschedule (basesrc->clock_id); } GST_OBJECT_UNLOCK (basesrc); GST_DEBUG ("unlock done"); return result; } /* default negotiation code. * * Take intersection between src and sink pads, take first * caps and fixate. */ static gboolean gst_base_src_default_negotiate (GstBaseSrc * basesrc) { GstCaps *thiscaps; GstCaps *caps = NULL; GstCaps *peercaps = NULL; gboolean result = FALSE; /* first see what is possible on our source pad */ thiscaps = gst_pad_get_caps (GST_BASE_SRC_PAD (basesrc)); GST_DEBUG_OBJECT (basesrc, "caps of src: %" GST_PTR_FORMAT, thiscaps); /* nothing or anything is allowed, we're done */ if (thiscaps == NULL || gst_caps_is_any (thiscaps)) goto no_nego_needed; /* get the peer caps */ peercaps = gst_pad_peer_get_caps (GST_BASE_SRC_PAD (basesrc)); GST_DEBUG_OBJECT (basesrc, "caps of peer: %" GST_PTR_FORMAT, peercaps); if (peercaps) { GstCaps *icaps; /* get intersection */ icaps = gst_caps_intersect (thiscaps, peercaps); GST_DEBUG_OBJECT (basesrc, "intersect: %" GST_PTR_FORMAT, icaps); gst_caps_unref (thiscaps); gst_caps_unref (peercaps); if (icaps) { /* take first (and best, since they are sorted) possibility */ caps = gst_caps_copy_nth (icaps, 0); gst_caps_unref (icaps); } } else { /* no peer, work with our own caps then */ caps = thiscaps; } if (caps) { caps = gst_caps_make_writable (caps); gst_caps_truncate (caps); /* now fixate */ if (!gst_caps_is_empty (caps)) { gst_pad_fixate_caps (GST_BASE_SRC_PAD (basesrc), caps); GST_DEBUG_OBJECT (basesrc, "fixated to: %" GST_PTR_FORMAT, caps); if (gst_caps_is_any (caps)) { /* hmm, still anything, so element can do anything and * nego is not needed */ result = TRUE; } else if (gst_caps_is_fixed (caps)) { /* yay, fixed caps, use those then */ gst_pad_set_caps (GST_BASE_SRC_PAD (basesrc), caps); result = TRUE; } } gst_caps_unref (caps); } return result; no_nego_needed: { GST_DEBUG_OBJECT (basesrc, "no negotiation needed"); if (thiscaps) gst_caps_unref (thiscaps); return TRUE; } } static gboolean gst_base_src_negotiate (GstBaseSrc * basesrc) { GstBaseSrcClass *bclass; gboolean result = TRUE; bclass = GST_BASE_SRC_GET_CLASS (basesrc); if (bclass->negotiate) result = bclass->negotiate (basesrc); return result; } static gboolean gst_base_src_start (GstBaseSrc * basesrc) { GstBaseSrcClass *bclass; gboolean result; guint64 size; if (GST_OBJECT_FLAG_IS_SET (basesrc, GST_BASE_SRC_STARTED)) return TRUE; GST_DEBUG_OBJECT (basesrc, "starting source"); basesrc->num_buffers_left = basesrc->num_buffers; gst_segment_init (&basesrc->segment, basesrc->segment.format); basesrc->data.ABI.running = FALSE; bclass = GST_BASE_SRC_GET_CLASS (basesrc); if (bclass->start) result = bclass->start (basesrc); else result = TRUE; if (!result) goto could_not_start; GST_OBJECT_FLAG_SET (basesrc, GST_BASE_SRC_STARTED); /* figure out the size */ if (basesrc->segment.format == GST_FORMAT_BYTES) { if (bclass->get_size) { if (!(result = bclass->get_size (basesrc, &size))) size = -1; } else { result = FALSE; size = -1; } /* only update the size when operating in bytes, subclass is supposed * to set duration in the start method for other formats */ gst_segment_set_duration (&basesrc->segment, GST_FORMAT_BYTES, size); } else { size = -1; } GST_DEBUG_OBJECT (basesrc, "format: %d, have size: %d, size: %" G_GUINT64_FORMAT ", duration: %" G_GINT64_FORMAT, basesrc->segment.format, result, size, basesrc->segment.duration); /* check if we can seek */ if (bclass->is_seekable) basesrc->seekable = bclass->is_seekable (basesrc); else basesrc->seekable = FALSE; GST_DEBUG_OBJECT (basesrc, "is seekable: %d", basesrc->seekable); /* update for random access flag */ basesrc->random_access = basesrc->seekable && basesrc->segment.format == GST_FORMAT_BYTES; GST_DEBUG_OBJECT (basesrc, "is random_access: %d", basesrc->random_access); /* run typefind if we are random_access and the typefinding is enabled. */ if (basesrc->random_access && basesrc->data.ABI.typefind && size != -1) { GstCaps *caps; caps = gst_type_find_helper (basesrc->srcpad, size); gst_pad_set_caps (basesrc->srcpad, caps); gst_caps_unref (caps); } else { /* use class or default negotiate function */ if (!gst_base_src_negotiate (basesrc)) goto could_not_negotiate; } return TRUE; /* ERROR */ could_not_start: { GST_DEBUG_OBJECT (basesrc, "could not start"); /* subclass is supposed to post a message. We don't have to call _stop. */ return FALSE; } could_not_negotiate: { GST_DEBUG_OBJECT (basesrc, "could not negotiate, stopping"); GST_ELEMENT_ERROR (basesrc, STREAM, FORMAT, ("Could not negotiate format"), ("Check your filtered caps, if any")); /* we must call stop */ gst_base_src_stop (basesrc); return FALSE; } } static gboolean gst_base_src_stop (GstBaseSrc * basesrc) { GstBaseSrcClass *bclass; gboolean result = TRUE; if (!GST_OBJECT_FLAG_IS_SET (basesrc, GST_BASE_SRC_STARTED)) return TRUE; GST_DEBUG_OBJECT (basesrc, "stopping source"); bclass = GST_BASE_SRC_GET_CLASS (basesrc); if (bclass->stop) result = bclass->stop (basesrc); if (result) GST_OBJECT_FLAG_UNSET (basesrc, GST_BASE_SRC_STARTED); return result; } static gboolean gst_base_src_deactivate (GstBaseSrc * basesrc, GstPad * pad) { gboolean result; GST_LIVE_LOCK (basesrc); basesrc->live_running = TRUE; GST_LIVE_SIGNAL (basesrc); GST_LIVE_UNLOCK (basesrc); /* step 1, unblock clock sync (if any) */ result = gst_base_src_unlock (basesrc); /* step 2, make sure streaming finishes */ result &= gst_pad_stop_task (pad); return result; } static gboolean gst_base_src_activate_push (GstPad * pad, gboolean active) { GstBaseSrc *basesrc; GstEvent *event; basesrc = GST_BASE_SRC (GST_OBJECT_PARENT (pad)); /* prepare subclass first */ if (active) { GST_DEBUG_OBJECT (basesrc, "Activating in push mode"); if (G_UNLIKELY (!basesrc->can_activate_push)) goto no_push_activation; if (G_UNLIKELY (!gst_base_src_start (basesrc))) goto error_start; basesrc->priv->last_sent_eos = FALSE; /* do initial seek, which will start the task */ GST_OBJECT_LOCK (basesrc); event = basesrc->data.ABI.pending_seek; basesrc->data.ABI.pending_seek = NULL; GST_OBJECT_UNLOCK (basesrc); /* no need to unlock anything, the task is certainly * not running here. The perform seek code will start the task when * finished. */ if (G_UNLIKELY (!gst_base_src_perform_seek (basesrc, event, FALSE))) goto seek_failed; if (event) gst_event_unref (event); } else { GST_DEBUG_OBJECT (basesrc, "Deactivating in push mode"); /* call the unlock function and stop the task */ if (G_UNLIKELY (!gst_base_src_deactivate (basesrc, pad))) goto deactivate_failed; /* now we can stop the source */ if (G_UNLIKELY (!gst_base_src_stop (basesrc))) goto error_stop; } return TRUE; /* ERRORS */ no_push_activation: { GST_WARNING_OBJECT (basesrc, "Subclass disabled push-mode activation"); return FALSE; } error_start: { GST_WARNING_OBJECT (basesrc, "Failed to start in push mode"); return FALSE; } seek_failed: { GST_ERROR_OBJECT (basesrc, "Failed to perform initial seek"); gst_base_src_stop (basesrc); if (event) gst_event_unref (event); return FALSE; } deactivate_failed: { GST_ERROR_OBJECT (basesrc, "Failed to deactivate in push mode"); return FALSE; } error_stop: { GST_DEBUG_OBJECT (basesrc, "Failed to stop in push mode"); return FALSE; } } static gboolean gst_base_src_activate_pull (GstPad * pad, gboolean active) { GstBaseSrc *basesrc; basesrc = GST_BASE_SRC (GST_OBJECT_PARENT (pad)); /* prepare subclass first */ if (active) { GST_DEBUG_OBJECT (basesrc, "Activating in pull mode"); if (G_UNLIKELY (!gst_base_src_start (basesrc))) goto error_start; /* if not random_access, we cannot operate in pull mode for now */ if (G_UNLIKELY (!gst_base_src_check_get_range (basesrc))) goto no_get_range; } else { GST_DEBUG_OBJECT (basesrc, "Deactivating in pull mode"); /* call the unlock function. We have no task to stop. */ if (G_UNLIKELY (!gst_base_src_deactivate (basesrc, pad))) goto deactivate_failed; /* don't send EOS when going from PAUSED => READY when in pull mode */ basesrc->priv->last_sent_eos = TRUE; if (G_UNLIKELY (!gst_base_src_stop (basesrc))) goto error_stop; } return TRUE; /* ERRORS */ error_start: { GST_ERROR_OBJECT (basesrc, "Failed to start in pull mode"); return FALSE; } no_get_range: { GST_ERROR_OBJECT (basesrc, "Cannot operate in pull mode, stopping"); gst_base_src_stop (basesrc); return FALSE; } deactivate_failed: { GST_ERROR_OBJECT (basesrc, "Failed to deactivate in pull mode"); return FALSE; } error_stop: { GST_ERROR_OBJECT (basesrc, "Failed to stop in pull mode"); return FALSE; } } static GstStateChangeReturn gst_base_src_change_state (GstElement * element, GstStateChange transition) { GstBaseSrc *basesrc; GstStateChangeReturn result; gboolean no_preroll = FALSE; basesrc = GST_BASE_SRC (element); switch (transition) { case GST_STATE_CHANGE_NULL_TO_READY: break; case GST_STATE_CHANGE_READY_TO_PAUSED: GST_LIVE_LOCK (element); if (basesrc->is_live) { no_preroll = TRUE; basesrc->live_running = FALSE; } basesrc->priv->last_sent_eos = FALSE; basesrc->priv->discont = TRUE; GST_LIVE_UNLOCK (element); break; case GST_STATE_CHANGE_PAUSED_TO_PLAYING: GST_LIVE_LOCK (element); if (basesrc->is_live) { basesrc->live_running = TRUE; GST_LIVE_SIGNAL (element); } GST_LIVE_UNLOCK (element); break; default: break; } if ((result = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition)) == GST_STATE_CHANGE_FAILURE) goto failure; switch (transition) { case GST_STATE_CHANGE_PLAYING_TO_PAUSED: GST_LIVE_LOCK (element); if (basesrc->is_live) { no_preroll = TRUE; basesrc->live_running = FALSE; } GST_LIVE_UNLOCK (element); break; case GST_STATE_CHANGE_PAUSED_TO_READY: { GstEvent **event_p; /* FIXME, deprecate this behaviour, it is very dangerous. * the prefered way of sending EOS downstream is by sending * the EOS event to the element */ if (!basesrc->priv->last_sent_eos) { GST_DEBUG_OBJECT (basesrc, "Sending EOS event"); gst_pad_push_event (basesrc->srcpad, gst_event_new_eos ()); basesrc->priv->last_sent_eos = TRUE; } event_p = &basesrc->data.ABI.pending_seek; gst_event_replace (event_p, NULL); event_p = &basesrc->priv->close_segment; gst_event_replace (event_p, NULL); event_p = &basesrc->priv->start_segment; gst_event_replace (event_p, NULL); break; } case GST_STATE_CHANGE_READY_TO_NULL: break; default: break; } if (no_preroll && result == GST_STATE_CHANGE_SUCCESS) result = GST_STATE_CHANGE_NO_PREROLL; return result; /* ERRORS */ failure: { GST_DEBUG_OBJECT (basesrc, "parent failed state change"); return result; } }