2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000,2005 Wim Taymans <wim@fluendo.com>
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Library General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Library General Public License for more details.
17 * You should have received a copy of the GNU Library General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
25 * @short_description: Base class for getrange based source elements
26 * @see_also: #GstPushSrc, #GstBaseTransform, #GstBaseSink
28 * This is a generice base class for source elements. The following
29 * types of sources are supported:
31 * <listitem><para>random access sources like files</para></listitem>
32 * <listitem><para>seekable sources</para></listitem>
33 * <listitem><para>live sources</para></listitem>
36 * The source can be configured to operate in any #GstFormat with the
37 * gst_base_src_set_format() method. The currently set format determines
38 * the format of the internal #GstSegment and any #GST_EVENT_NEWSEGMENT
39 * events. The default format for #GstBaseSrc is #GST_FORMAT_BYTES.
41 * #GstBaseSrc always supports push mode scheduling. If the following
42 * conditions are met, it also supports pull mode scheduling:
44 * <listitem><para>The format is set to #GST_FORMAT_BYTES (default).</para>
46 * <listitem><para>#GstBaseSrcClass.is_seekable() returns %TRUE.</para>
50 * Since 0.10.9, any #GstBaseSrc can enable pull based scheduling at any time
51 * by overriding #GstBaseSrcClass.check_get_range() so that it returns %TRUE.
53 * If all the conditions are met for operating in pull mode, #GstBaseSrc is
54 * automatically seekable in push mode as well. The following conditions must
55 * be met to make the element seekable in push mode when the format is not
59 * #GstBaseSrcClass.is_seekable() returns %TRUE.
62 * #GstBaseSrc:Class.query() can convert all supported seek formats to the
63 * internal format as set with gst_base_src_set_format().
66 * #GstBaseSrcClass.do_seek() is implemented, performs the seek and returns
71 * When the element does not meet the requirements to operate in pull mode, the
72 * offset and length in the #GstBaseSrcClass.create() method should be ignored.
73 * It is recommended to subclass #GstPushSrc instead, in this situation. If the
74 * element can operate in pull mode but only with specific offsets and
75 * lengths, it is allowed to generate an error when the wrong values are passed
76 * to the #GstBaseSrcClass.create() function.
78 * #GstBaseSrc has support for live sources. Live sources are sources that when
79 * paused discard data, such as audio or video capture devices. A typical live
80 * source also produces data at a fixed rate and thus provides a clock to publish
82 * Use gst_base_src_set_live() to activate the live source mode.
84 * A live source does not produce data in the PAUSED state. This means that the
85 * #GstBaseSrcClass.create() method will not be called in PAUSED but only in
86 * PLAYING. To signal the pipeline that the element will not produce data, the
87 * return value from the READY to PAUSED state will be
88 * #GST_STATE_CHANGE_NO_PREROLL.
90 * A typical live source will timestamp the buffers it creates with the
91 * current running time of the pipeline. This is one reason why a live source
92 * can only produce data in the PLAYING state, when the clock is actually
93 * distributed and running.
95 * Live sources that synchronize and block on the clock (an audio source, for
96 * example) can since 0.10.12 use gst_base_src_wait_playing() when the
97 * #GstBaseSrcClass.create() function was interrupted by a state change to
100 * The #GstBaseSrcClass.get_times() method can be used to implement pseudo-live
101 * sources. It only makes sense to implement the #GstBaseSrcClass.get_times()
102 * function if the source is a live source. The #GstBaseSrcClass.get_times()
103 * function should return timestamps starting from 0, as if it were a non-live
104 * source. The base class will make sure that the timestamps are transformed
105 * into the current running_time. The base source will then wait for the
106 * calculated running_time before pushing out the buffer.
108 * For live sources, the base class will by default report a latency of 0.
109 * For pseudo live sources, the base class will by default measure the difference
110 * between the first buffer timestamp and the start time of get_times and will
111 * report this value as the latency.
112 * Subclasses should override the query function when this behaviour is not
115 * There is only support in #GstBaseSrc for exactly one source pad, which
116 * should be named "src". A source implementation (subclass of #GstBaseSrc)
117 * should install a pad template in its class_init function, like so:
120 * my_element_class_init (GstMyElementClass *klass)
122 * GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
123 * // srctemplate should be a #GstStaticPadTemplate with direction
124 * // #GST_PAD_SRC and name "src"
125 * gst_element_class_add_pad_template (gstelement_class,
126 * gst_static_pad_template_get (&srctemplate));
127 * // see #GstElementDetails
128 * gst_element_class_set_details (gstelement_class, &details);
133 * <title>Controlled shutdown of live sources in applications</title>
135 * Applications that record from a live source may want to stop recording
136 * in a controlled way, so that the recording is stopped, but the data
137 * already in the pipeline is processed to the end (remember that many live
138 * sources would go on recording forever otherwise). For that to happen the
139 * application needs to make the source stop recording and send an EOS
140 * event down the pipeline. The application would then wait for an
141 * EOS message posted on the pipeline's bus to know when all data has
142 * been processed and the pipeline can safely be stopped.
144 * Since GStreamer 0.10.16 an application may send an EOS event to a source
145 * element to make it perform the EOS logic (send EOS event downstream or post a
146 * #GST_MESSAGE_SEGMENT_DONE on the bus). This can typically be done
147 * with the gst_element_send_event() function on the element or its parent bin.
149 * After the EOS has been sent to the element, the application should wait for
150 * an EOS message to be posted on the pipeline's bus. Once this EOS message is
151 * received, it may safely shut down the entire pipeline.
153 * The old behaviour for controlled shutdown introduced since GStreamer 0.10.3
154 * is still available but deprecated as it is dangerous and less flexible.
156 * Last reviewed on 2007-12-19 (0.10.16)
168 #include "gstbasesrc.h"
169 #include "gsttypefindhelper.h"
170 #include <gst/gstmarshal.h>
171 #include <gst/gst-i18n-lib.h>
173 GST_DEBUG_CATEGORY_STATIC (gst_base_src_debug);
174 #define GST_CAT_DEFAULT gst_base_src_debug
176 #define GST_LIVE_GET_LOCK(elem) (GST_BASE_SRC_CAST(elem)->live_lock)
177 #define GST_LIVE_LOCK(elem) g_mutex_lock(GST_LIVE_GET_LOCK(elem))
178 #define GST_LIVE_TRYLOCK(elem) g_mutex_trylock(GST_LIVE_GET_LOCK(elem))
179 #define GST_LIVE_UNLOCK(elem) g_mutex_unlock(GST_LIVE_GET_LOCK(elem))
180 #define GST_LIVE_GET_COND(elem) (GST_BASE_SRC_CAST(elem)->live_cond)
181 #define GST_LIVE_WAIT(elem) g_cond_wait (GST_LIVE_GET_COND (elem), GST_LIVE_GET_LOCK (elem))
182 #define GST_LIVE_TIMED_WAIT(elem, timeval) g_cond_timed_wait (GST_LIVE_GET_COND (elem), GST_LIVE_GET_LOCK (elem),\
184 #define GST_LIVE_SIGNAL(elem) g_cond_signal (GST_LIVE_GET_COND (elem));
185 #define GST_LIVE_BROADCAST(elem) g_cond_broadcast (GST_LIVE_GET_COND (elem));
187 /* BaseSrc signals and args */
194 #define DEFAULT_BLOCKSIZE 4096
195 #define DEFAULT_NUM_BUFFERS -1
196 #define DEFAULT_TYPEFIND FALSE
197 #define DEFAULT_DO_TIMESTAMP FALSE
208 #define GST_BASE_SRC_GET_PRIVATE(obj) \
209 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_BASE_SRC, GstBaseSrcPrivate))
211 struct _GstBaseSrcPrivate
213 gboolean last_sent_eos; /* last thing we did was send an EOS (we set this
214 * to avoid the sending of two EOS in some cases) */
218 /* two segments to be sent in the streaming thread with STREAM_LOCK */
219 GstEvent *close_segment;
220 GstEvent *start_segment;
222 /* if EOS is pending (atomic) */
225 /* startup latency is the time it takes between going to PLAYING and producing
226 * the first BUFFER with running_time 0. This value is included in the latency
228 GstClockTime latency;
229 /* timestamp offset, this is the offset add to the values of gst_times for
230 * pseudo live sources */
231 GstClockTimeDiff ts_offset;
233 gboolean do_timestamp;
235 /* stream sequence number */
238 /* pending tags to be pushed in the data stream */
242 static GstElementClass *parent_class = NULL;
244 static void gst_base_src_base_init (gpointer g_class);
245 static void gst_base_src_class_init (GstBaseSrcClass * klass);
246 static void gst_base_src_init (GstBaseSrc * src, gpointer g_class);
247 static void gst_base_src_finalize (GObject * object);
251 gst_base_src_get_type (void)
253 static volatile gsize base_src_type = 0;
255 if (g_once_init_enter (&base_src_type)) {
257 static const GTypeInfo base_src_info = {
258 sizeof (GstBaseSrcClass),
259 (GBaseInitFunc) gst_base_src_base_init,
261 (GClassInitFunc) gst_base_src_class_init,
266 (GInstanceInitFunc) gst_base_src_init,
269 _type = g_type_register_static (GST_TYPE_ELEMENT,
270 "GstBaseSrc", &base_src_info, G_TYPE_FLAG_ABSTRACT);
271 g_once_init_leave (&base_src_type, _type);
273 return base_src_type;
276 static GstCaps *gst_base_src_getcaps (GstPad * pad);
277 static gboolean gst_base_src_setcaps (GstPad * pad, GstCaps * caps);
278 static void gst_base_src_fixate (GstPad * pad, GstCaps * caps);
280 static gboolean gst_base_src_activate_push (GstPad * pad, gboolean active);
281 static gboolean gst_base_src_activate_pull (GstPad * pad, gboolean active);
282 static void gst_base_src_set_property (GObject * object, guint prop_id,
283 const GValue * value, GParamSpec * pspec);
284 static void gst_base_src_get_property (GObject * object, guint prop_id,
285 GValue * value, GParamSpec * pspec);
286 static gboolean gst_base_src_event_handler (GstPad * pad, GstEvent * event);
287 static gboolean gst_base_src_send_event (GstElement * elem, GstEvent * event);
288 static gboolean gst_base_src_default_event (GstBaseSrc * src, GstEvent * event);
289 static const GstQueryType *gst_base_src_get_query_types (GstElement * element);
291 static gboolean gst_base_src_query (GstPad * pad, GstQuery * query);
293 static gboolean gst_base_src_default_negotiate (GstBaseSrc * basesrc);
294 static gboolean gst_base_src_default_do_seek (GstBaseSrc * src,
295 GstSegment * segment);
296 static gboolean gst_base_src_default_query (GstBaseSrc * src, GstQuery * query);
297 static gboolean gst_base_src_default_prepare_seek_segment (GstBaseSrc * src,
298 GstEvent * event, GstSegment * segment);
300 static gboolean gst_base_src_set_flushing (GstBaseSrc * basesrc,
301 gboolean flushing, gboolean live_play, gboolean unlock, gboolean * playing);
302 static gboolean gst_base_src_start (GstBaseSrc * basesrc);
303 static gboolean gst_base_src_stop (GstBaseSrc * basesrc);
305 static GstStateChangeReturn gst_base_src_change_state (GstElement * element,
306 GstStateChange transition);
308 static void gst_base_src_loop (GstPad * pad);
309 static gboolean gst_base_src_pad_check_get_range (GstPad * pad);
310 static gboolean gst_base_src_default_check_get_range (GstBaseSrc * bsrc);
311 static GstFlowReturn gst_base_src_pad_get_range (GstPad * pad, guint64 offset,
312 guint length, GstBuffer ** buf);
313 static GstFlowReturn gst_base_src_get_range (GstBaseSrc * src, guint64 offset,
314 guint length, GstBuffer ** buf);
315 static gboolean gst_base_src_seekable (GstBaseSrc * src);
318 gst_base_src_base_init (gpointer g_class)
320 GST_DEBUG_CATEGORY_INIT (gst_base_src_debug, "basesrc", 0, "basesrc element");
324 gst_base_src_class_init (GstBaseSrcClass * klass)
326 GObjectClass *gobject_class;
327 GstElementClass *gstelement_class;
329 gobject_class = G_OBJECT_CLASS (klass);
330 gstelement_class = GST_ELEMENT_CLASS (klass);
332 g_type_class_add_private (klass, sizeof (GstBaseSrcPrivate));
334 parent_class = g_type_class_peek_parent (klass);
336 gobject_class->finalize = gst_base_src_finalize;
337 gobject_class->set_property = gst_base_src_set_property;
338 gobject_class->get_property = gst_base_src_get_property;
340 g_object_class_install_property (gobject_class, PROP_BLOCKSIZE,
341 g_param_spec_ulong ("blocksize", "Block size",
342 "Size in bytes to read per buffer (-1 = default)", 0, G_MAXULONG,
343 DEFAULT_BLOCKSIZE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
344 g_object_class_install_property (gobject_class, PROP_NUM_BUFFERS,
345 g_param_spec_int ("num-buffers", "num-buffers",
346 "Number of buffers to output before sending EOS (-1 = unlimited)",
347 -1, G_MAXINT, DEFAULT_NUM_BUFFERS, G_PARAM_READWRITE |
348 G_PARAM_STATIC_STRINGS));
349 g_object_class_install_property (gobject_class, PROP_TYPEFIND,
350 g_param_spec_boolean ("typefind", "Typefind",
351 "Run typefind before negotiating", DEFAULT_TYPEFIND,
352 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
353 g_object_class_install_property (gobject_class, PROP_DO_TIMESTAMP,
354 g_param_spec_boolean ("do-timestamp", "Do timestamp",
355 "Apply current stream time to buffers", DEFAULT_DO_TIMESTAMP,
356 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
358 gstelement_class->change_state =
359 GST_DEBUG_FUNCPTR (gst_base_src_change_state);
360 gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_base_src_send_event);
361 gstelement_class->get_query_types =
362 GST_DEBUG_FUNCPTR (gst_base_src_get_query_types);
364 klass->negotiate = GST_DEBUG_FUNCPTR (gst_base_src_default_negotiate);
365 klass->event = GST_DEBUG_FUNCPTR (gst_base_src_default_event);
366 klass->do_seek = GST_DEBUG_FUNCPTR (gst_base_src_default_do_seek);
367 klass->query = GST_DEBUG_FUNCPTR (gst_base_src_default_query);
368 klass->check_get_range =
369 GST_DEBUG_FUNCPTR (gst_base_src_default_check_get_range);
370 klass->prepare_seek_segment =
371 GST_DEBUG_FUNCPTR (gst_base_src_default_prepare_seek_segment);
373 /* Registering debug symbols for function pointers */
374 GST_DEBUG_REGISTER_FUNCPTR (gst_base_src_activate_push);
375 GST_DEBUG_REGISTER_FUNCPTR (gst_base_src_activate_pull);
376 GST_DEBUG_REGISTER_FUNCPTR (gst_base_src_event_handler);
377 GST_DEBUG_REGISTER_FUNCPTR (gst_base_src_query);
378 GST_DEBUG_REGISTER_FUNCPTR (gst_base_src_pad_get_range);
379 GST_DEBUG_REGISTER_FUNCPTR (gst_base_src_pad_check_get_range);
380 GST_DEBUG_REGISTER_FUNCPTR (gst_base_src_getcaps);
381 GST_DEBUG_REGISTER_FUNCPTR (gst_base_src_setcaps);
382 GST_DEBUG_REGISTER_FUNCPTR (gst_base_src_fixate);
386 gst_base_src_init (GstBaseSrc * basesrc, gpointer g_class)
389 GstPadTemplate *pad_template;
391 basesrc->priv = GST_BASE_SRC_GET_PRIVATE (basesrc);
393 basesrc->is_live = FALSE;
394 basesrc->live_lock = g_mutex_new ();
395 basesrc->live_cond = g_cond_new ();
396 basesrc->num_buffers = DEFAULT_NUM_BUFFERS;
397 basesrc->num_buffers_left = -1;
399 basesrc->can_activate_push = TRUE;
400 basesrc->pad_mode = GST_ACTIVATE_NONE;
403 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "src");
404 g_return_if_fail (pad_template != NULL);
406 GST_DEBUG_OBJECT (basesrc, "creating src pad");
407 pad = gst_pad_new_from_template (pad_template, "src");
409 GST_DEBUG_OBJECT (basesrc, "setting functions on src pad");
410 gst_pad_set_activatepush_function (pad, gst_base_src_activate_push);
411 gst_pad_set_activatepull_function (pad, gst_base_src_activate_pull);
412 gst_pad_set_event_function (pad, gst_base_src_event_handler);
413 gst_pad_set_query_function (pad, gst_base_src_query);
414 gst_pad_set_checkgetrange_function (pad, gst_base_src_pad_check_get_range);
415 gst_pad_set_getrange_function (pad, gst_base_src_pad_get_range);
416 gst_pad_set_getcaps_function (pad, gst_base_src_getcaps);
417 gst_pad_set_setcaps_function (pad, gst_base_src_setcaps);
418 gst_pad_set_fixatecaps_function (pad, gst_base_src_fixate);
420 /* hold pointer to pad */
421 basesrc->srcpad = pad;
422 GST_DEBUG_OBJECT (basesrc, "adding src pad");
423 gst_element_add_pad (GST_ELEMENT (basesrc), pad);
425 basesrc->blocksize = DEFAULT_BLOCKSIZE;
426 basesrc->clock_id = NULL;
427 /* we operate in BYTES by default */
428 gst_base_src_set_format (basesrc, GST_FORMAT_BYTES);
429 basesrc->data.ABI.typefind = DEFAULT_TYPEFIND;
430 basesrc->priv->do_timestamp = DEFAULT_DO_TIMESTAMP;
432 GST_OBJECT_FLAG_UNSET (basesrc, GST_BASE_SRC_STARTED);
434 GST_DEBUG_OBJECT (basesrc, "init done");
438 gst_base_src_finalize (GObject * object)
443 basesrc = GST_BASE_SRC (object);
445 g_mutex_free (basesrc->live_lock);
446 g_cond_free (basesrc->live_cond);
448 event_p = &basesrc->data.ABI.pending_seek;
449 gst_event_replace (event_p, NULL);
451 if (basesrc->priv->pending_tags) {
452 g_list_foreach (basesrc->priv->pending_tags, (GFunc) gst_event_unref, NULL);
453 g_list_free (basesrc->priv->pending_tags);
456 G_OBJECT_CLASS (parent_class)->finalize (object);
460 * gst_base_src_wait_playing:
463 * If the #GstBaseSrcClass.create() method performs its own synchronisation
464 * against the clock it must unblock when going from PLAYING to the PAUSED state
465 * and call this method before continuing to produce the remaining data.
467 * This function will block until a state change to PLAYING happens (in which
468 * case this function returns #GST_FLOW_OK) or the processing must be stopped due
469 * to a state change to READY or a FLUSH event (in which case this function
470 * returns #GST_FLOW_WRONG_STATE).
474 * Returns: #GST_FLOW_OK if @src is PLAYING and processing can
475 * continue. Any other return value should be returned from the create vmethod.
478 gst_base_src_wait_playing (GstBaseSrc * src)
480 g_return_val_if_fail (GST_IS_BASE_SRC (src), GST_FLOW_ERROR);
482 /* block until the state changes, or we get a flush, or something */
483 GST_DEBUG_OBJECT (src, "live source waiting for running state");
485 if (src->priv->flushing)
487 GST_DEBUG_OBJECT (src, "live source unlocked");
494 GST_DEBUG_OBJECT (src, "we are flushing");
495 return GST_FLOW_WRONG_STATE;
500 * gst_base_src_set_live:
501 * @src: base source instance
502 * @live: new live-mode
504 * If the element listens to a live source, @live should
507 * A live source will not produce data in the PAUSED state and
508 * will therefore not be able to participate in the PREROLL phase
509 * of a pipeline. To signal this fact to the application and the
510 * pipeline, the state change return value of the live source will
511 * be GST_STATE_CHANGE_NO_PREROLL.
514 gst_base_src_set_live (GstBaseSrc * src, gboolean live)
516 g_return_if_fail (GST_IS_BASE_SRC (src));
518 GST_OBJECT_LOCK (src);
520 GST_OBJECT_UNLOCK (src);
524 * gst_base_src_is_live:
525 * @src: base source instance
527 * Check if an element is in live mode.
529 * Returns: %TRUE if element is in live mode.
532 gst_base_src_is_live (GstBaseSrc * src)
536 g_return_val_if_fail (GST_IS_BASE_SRC (src), FALSE);
538 GST_OBJECT_LOCK (src);
539 result = src->is_live;
540 GST_OBJECT_UNLOCK (src);
546 * gst_base_src_set_format:
547 * @src: base source instance
548 * @format: the format to use
550 * Sets the default format of the source. This will be the format used
551 * for sending NEW_SEGMENT events and for performing seeks.
553 * If a format of GST_FORMAT_BYTES is set, the element will be able to
554 * operate in pull mode if the #GstBaseSrc.is_seekable() returns TRUE.
556 * This function must only be called in states < %GST_STATE_PAUSED.
561 gst_base_src_set_format (GstBaseSrc * src, GstFormat format)
563 g_return_if_fail (GST_IS_BASE_SRC (src));
564 g_return_if_fail (GST_STATE (src) <= GST_STATE_READY);
566 GST_OBJECT_LOCK (src);
567 gst_segment_init (&src->segment, format);
568 GST_OBJECT_UNLOCK (src);
572 * gst_base_src_query_latency:
574 * @live: if the source is live
575 * @min_latency: the min latency of the source
576 * @max_latency: the max latency of the source
578 * Query the source for the latency parameters. @live will be TRUE when @src is
579 * configured as a live source. @min_latency will be set to the difference
580 * between the running time and the timestamp of the first buffer.
581 * @max_latency is always the undefined value of -1.
583 * This function is mostly used by subclasses.
585 * Returns: TRUE if the query succeeded.
590 gst_base_src_query_latency (GstBaseSrc * src, gboolean * live,
591 GstClockTime * min_latency, GstClockTime * max_latency)
595 g_return_val_if_fail (GST_IS_BASE_SRC (src), FALSE);
597 GST_OBJECT_LOCK (src);
599 *live = src->is_live;
601 /* if we have a startup latency, report this one, else report 0. Subclasses
602 * are supposed to override the query function if they want something
604 if (src->priv->latency != -1)
605 min = src->priv->latency;
614 GST_LOG_OBJECT (src, "latency: live %d, min %" GST_TIME_FORMAT
615 ", max %" GST_TIME_FORMAT, src->is_live, GST_TIME_ARGS (min),
617 GST_OBJECT_UNLOCK (src);
623 * gst_base_src_set_blocksize:
625 * @blocksize: the new blocksize in bytes
627 * Set the number of bytes that @src will push out with each buffer. When
628 * @blocksize is set to -1, a default length will be used.
633 gst_base_src_set_blocksize (GstBaseSrc * src, gulong blocksize)
635 g_return_if_fail (GST_IS_BASE_SRC (src));
637 GST_OBJECT_LOCK (src);
638 src->blocksize = blocksize;
639 GST_OBJECT_UNLOCK (src);
643 * gst_base_src_get_blocksize:
646 * Get the number of bytes that @src will push out with each buffer.
648 * Returns: the number of bytes pushed with each buffer.
653 gst_base_src_get_blocksize (GstBaseSrc * src)
657 g_return_val_if_fail (GST_IS_BASE_SRC (src), 0);
659 GST_OBJECT_LOCK (src);
660 res = src->blocksize;
661 GST_OBJECT_UNLOCK (src);
668 * gst_base_src_set_do_timestamp:
670 * @timestamp: enable or disable timestamping
672 * Configure @src to automatically timestamp outgoing buffers based on the
673 * current running_time of the pipeline. This property is mostly useful for live
679 gst_base_src_set_do_timestamp (GstBaseSrc * src, gboolean timestamp)
681 g_return_if_fail (GST_IS_BASE_SRC (src));
683 GST_OBJECT_LOCK (src);
684 src->priv->do_timestamp = timestamp;
685 GST_OBJECT_UNLOCK (src);
689 * gst_base_src_get_do_timestamp:
692 * Query if @src timestamps outgoing buffers based on the current running_time.
694 * Returns: %TRUE if the base class will automatically timestamp outgoing buffers.
699 gst_base_src_get_do_timestamp (GstBaseSrc * src)
703 g_return_val_if_fail (GST_IS_BASE_SRC (src), FALSE);
705 GST_OBJECT_LOCK (src);
706 res = src->priv->do_timestamp;
707 GST_OBJECT_UNLOCK (src);
713 * gst_base_src_new_seamless_segment:
715 * @start: The new start value for the segment
716 * @stop: Stop value for the new segment
717 * @position: The position value for the new segent
719 * Prepare a new seamless segment for emission downstream. This function must
720 * only be called by derived sub-classes, and only from the create() function,
721 * as the stream-lock needs to be held.
723 * The format for the new segment will be the current format of the source, as
724 * configured with gst_base_src_set_format()
726 * Returns: %TRUE if preparation of the seamless segment succeeded.
731 gst_base_src_new_seamless_segment (GstBaseSrc * src, gint64 start, gint64 stop,
736 GST_DEBUG_OBJECT (src,
737 "Starting new seamless segment. Start %" GST_TIME_FORMAT " stop %"
738 GST_TIME_FORMAT " position %" GST_TIME_FORMAT, GST_TIME_ARGS (start),
739 GST_TIME_ARGS (stop), GST_TIME_ARGS (position));
741 GST_OBJECT_LOCK (src);
742 if (src->data.ABI.running) {
743 if (src->priv->close_segment)
744 gst_event_unref (src->priv->close_segment);
745 src->priv->close_segment =
746 gst_event_new_new_segment_full (TRUE,
747 src->segment.rate, src->segment.applied_rate, src->segment.format,
748 src->segment.start, src->segment.last_stop, src->segment.time);
751 gst_segment_set_newsegment_full (&src->segment, FALSE, src->segment.rate,
752 src->segment.applied_rate, src->segment.format, start, stop, position);
754 if (src->priv->start_segment)
755 gst_event_unref (src->priv->start_segment);
756 if (src->segment.rate >= 0.0) {
757 /* forward, we send data from last_stop to stop */
758 src->priv->start_segment =
759 gst_event_new_new_segment_full (FALSE,
760 src->segment.rate, src->segment.applied_rate, src->segment.format,
761 src->segment.last_stop, stop, src->segment.time);
763 /* reverse, we send data from last_stop to start */
764 src->priv->start_segment =
765 gst_event_new_new_segment_full (FALSE,
766 src->segment.rate, src->segment.applied_rate, src->segment.format,
767 src->segment.start, src->segment.last_stop, src->segment.time);
769 GST_OBJECT_UNLOCK (src);
771 src->priv->discont = TRUE;
772 src->data.ABI.running = TRUE;
778 gst_base_src_setcaps (GstPad * pad, GstCaps * caps)
780 GstBaseSrcClass *bclass;
784 bsrc = GST_BASE_SRC (GST_PAD_PARENT (pad));
785 bclass = GST_BASE_SRC_GET_CLASS (bsrc);
787 if (bclass->set_caps)
788 res = bclass->set_caps (bsrc, caps);
794 gst_base_src_getcaps (GstPad * pad)
796 GstBaseSrcClass *bclass;
798 GstCaps *caps = NULL;
800 bsrc = GST_BASE_SRC (GST_PAD_PARENT (pad));
801 bclass = GST_BASE_SRC_GET_CLASS (bsrc);
802 if (bclass->get_caps)
803 caps = bclass->get_caps (bsrc);
806 GstPadTemplate *pad_template;
809 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass), "src");
810 if (pad_template != NULL) {
811 caps = gst_caps_ref (gst_pad_template_get_caps (pad_template));
818 gst_base_src_fixate (GstPad * pad, GstCaps * caps)
820 GstBaseSrcClass *bclass;
823 bsrc = GST_BASE_SRC (gst_pad_get_parent (pad));
824 bclass = GST_BASE_SRC_GET_CLASS (bsrc);
827 bclass->fixate (bsrc, caps);
829 gst_object_unref (bsrc);
833 gst_base_src_default_query (GstBaseSrc * src, GstQuery * query)
837 switch (GST_QUERY_TYPE (query)) {
838 case GST_QUERY_POSITION:
842 gst_query_parse_position (query, &format, NULL);
844 case GST_FORMAT_PERCENT:
850 GST_OBJECT_LOCK (src);
851 position = src->segment.last_stop;
852 duration = src->segment.duration;
853 GST_OBJECT_UNLOCK (src);
855 if (position != -1 && duration != -1) {
856 if (position < duration)
857 percent = gst_util_uint64_scale (GST_FORMAT_PERCENT_MAX, position,
860 percent = GST_FORMAT_PERCENT_MAX;
864 gst_query_set_position (query, GST_FORMAT_PERCENT, percent);
871 GstFormat seg_format;
873 GST_OBJECT_LOCK (src);
874 position = src->segment.last_stop;
875 seg_format = src->segment.format;
876 GST_OBJECT_UNLOCK (src);
878 if (position != -1) {
879 /* convert to requested format */
881 gst_pad_query_convert (src->srcpad, seg_format,
882 position, &format, &position);
886 gst_query_set_position (query, format, position);
892 case GST_QUERY_DURATION:
896 gst_query_parse_duration (query, &format, NULL);
898 GST_DEBUG_OBJECT (src, "duration query in format %s",
899 gst_format_get_name (format));
902 case GST_FORMAT_PERCENT:
903 gst_query_set_duration (query, GST_FORMAT_PERCENT,
904 GST_FORMAT_PERCENT_MAX);
910 GstFormat seg_format;
912 GST_OBJECT_LOCK (src);
913 /* this is the duration as configured by the subclass. */
914 duration = src->segment.duration;
915 seg_format = src->segment.format;
916 GST_OBJECT_UNLOCK (src);
918 if (duration != -1) {
919 /* convert to requested format, if this fails, we have a duration
920 * but we cannot answer the query, we must return FALSE. */
922 gst_pad_query_convert (src->srcpad, seg_format,
923 duration, &format, &duration);
925 /* The subclass did not configure a duration, we assume that the
926 * media has an unknown duration then and we return TRUE to report
927 * this. Note that this is not the same as returning FALSE, which
928 * means that we cannot report the duration at all. */
931 gst_query_set_duration (query, format, duration);
938 case GST_QUERY_SEEKING:
940 GstFormat format, seg_format;
943 GST_OBJECT_LOCK (src);
944 duration = src->segment.duration;
945 seg_format = src->segment.format;
946 GST_OBJECT_UNLOCK (src);
948 gst_query_parse_seeking (query, &format, NULL, NULL, NULL);
949 if (format == seg_format) {
950 gst_query_set_seeking (query, seg_format,
951 gst_base_src_seekable (src), 0, duration);
954 /* FIXME 0.11: return TRUE + seekable=FALSE for SEEKING query here */
955 /* Don't reply to the query to make up for demuxers which don't
956 * handle the SEEKING query yet. Players like Totem will fall back
957 * to the duration when the SEEKING query isn't answered. */
962 case GST_QUERY_SEGMENT:
966 GST_OBJECT_LOCK (src);
967 /* no end segment configured, current duration then */
968 if ((stop = src->segment.stop) == -1)
969 stop = src->segment.duration;
970 start = src->segment.start;
972 /* adjust to stream time */
973 if (src->segment.time != -1) {
974 start -= src->segment.time;
976 stop -= src->segment.time;
978 gst_query_set_segment (query, src->segment.rate, src->segment.format,
980 GST_OBJECT_UNLOCK (src);
985 case GST_QUERY_FORMATS:
987 gst_query_set_formats (query, 3, GST_FORMAT_DEFAULT,
988 GST_FORMAT_BYTES, GST_FORMAT_PERCENT);
992 case GST_QUERY_CONVERT:
994 GstFormat src_fmt, dest_fmt;
995 gint64 src_val, dest_val;
997 gst_query_parse_convert (query, &src_fmt, &src_val, &dest_fmt, &dest_val);
999 /* we can only convert between equal formats... */
1000 if (src_fmt == dest_fmt) {
1006 gst_query_set_convert (query, src_fmt, src_val, dest_fmt, dest_val);
1009 case GST_QUERY_LATENCY:
1011 GstClockTime min, max;
1014 /* Subclasses should override and implement something usefull */
1015 res = gst_base_src_query_latency (src, &live, &min, &max);
1017 GST_LOG_OBJECT (src, "report latency: live %d, min %" GST_TIME_FORMAT
1018 ", max %" GST_TIME_FORMAT, live, GST_TIME_ARGS (min),
1019 GST_TIME_ARGS (max));
1021 gst_query_set_latency (query, live, min, max);
1024 case GST_QUERY_JITTER:
1025 case GST_QUERY_RATE:
1028 case GST_QUERY_BUFFERING:
1030 GstFormat format, seg_format;
1031 gint64 start, stop, estimated;
1033 gst_query_parse_buffering_range (query, &format, NULL, NULL, NULL);
1035 GST_DEBUG_OBJECT (src, "buffering query in format %s",
1036 gst_format_get_name (format));
1038 GST_OBJECT_LOCK (src);
1039 if (src->random_access) {
1042 if (format == GST_FORMAT_PERCENT)
1043 stop = GST_FORMAT_PERCENT_MAX;
1045 stop = src->segment.duration;
1051 seg_format = src->segment.format;
1052 GST_OBJECT_UNLOCK (src);
1054 /* convert to required format. When the conversion fails, we can't answer
1055 * the query. When the value is unknown, we can don't perform conversion
1056 * but report TRUE. */
1057 if (format != GST_FORMAT_PERCENT && stop != -1) {
1058 res = gst_pad_query_convert (src->srcpad, seg_format,
1059 stop, &format, &stop);
1063 if (res && format != GST_FORMAT_PERCENT && start != -1)
1064 res = gst_pad_query_convert (src->srcpad, seg_format,
1065 start, &format, &start);
1067 gst_query_set_buffering_range (query, format, start, stop, estimated);
1074 GST_DEBUG_OBJECT (src, "query %s returns %d", GST_QUERY_TYPE_NAME (query),
1080 gst_base_src_query (GstPad * pad, GstQuery * query)
1083 GstBaseSrcClass *bclass;
1084 gboolean result = FALSE;
1086 src = GST_BASE_SRC (gst_pad_get_parent (pad));
1088 bclass = GST_BASE_SRC_GET_CLASS (src);
1091 result = bclass->query (src, query);
1093 result = gst_pad_query_default (pad, query);
1095 gst_object_unref (src);
1101 gst_base_src_default_do_seek (GstBaseSrc * src, GstSegment * segment)
1103 gboolean res = TRUE;
1105 /* update our offset if the start/stop position was updated */
1106 if (segment->format == GST_FORMAT_BYTES) {
1107 segment->time = segment->start;
1108 } else if (segment->start == 0) {
1109 /* seek to start, we can implement a default for this. */
1113 GST_INFO_OBJECT (src, "Can't do a default seek");
1120 gst_base_src_do_seek (GstBaseSrc * src, GstSegment * segment)
1122 GstBaseSrcClass *bclass;
1123 gboolean result = FALSE;
1125 bclass = GST_BASE_SRC_GET_CLASS (src);
1127 if (bclass->do_seek)
1128 result = bclass->do_seek (src, segment);
1133 #define SEEK_TYPE_IS_RELATIVE(t) (((t) != GST_SEEK_TYPE_NONE) && ((t) != GST_SEEK_TYPE_SET))
1136 gst_base_src_default_prepare_seek_segment (GstBaseSrc * src, GstEvent * event,
1137 GstSegment * segment)
1139 /* By default, we try one of 2 things:
1140 * - For absolute seek positions, convert the requested position to our
1141 * configured processing format and place it in the output segment \
1142 * - For relative seek positions, convert our current (input) values to the
1143 * seek format, adjust by the relative seek offset and then convert back to
1144 * the processing format
1146 GstSeekType cur_type, stop_type;
1149 GstFormat seek_format, dest_format;
1152 gboolean res = TRUE;
1154 gst_event_parse_seek (event, &rate, &seek_format, &flags,
1155 &cur_type, &cur, &stop_type, &stop);
1156 dest_format = segment->format;
1158 if (seek_format == dest_format) {
1159 gst_segment_set_seek (segment, rate, seek_format, flags,
1160 cur_type, cur, stop_type, stop, &update);
1164 if (cur_type != GST_SEEK_TYPE_NONE) {
1165 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
1167 gst_pad_query_convert (src->srcpad, seek_format, cur, &dest_format,
1169 cur_type = GST_SEEK_TYPE_SET;
1172 if (res && stop_type != GST_SEEK_TYPE_NONE) {
1173 /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
1175 gst_pad_query_convert (src->srcpad, seek_format, stop, &dest_format,
1177 stop_type = GST_SEEK_TYPE_SET;
1180 /* And finally, configure our output segment in the desired format */
1181 gst_segment_set_seek (segment, rate, dest_format, flags, cur_type, cur,
1182 stop_type, stop, &update);
1191 GST_DEBUG_OBJECT (src, "undefined format given, seek aborted.");
1197 gst_base_src_prepare_seek_segment (GstBaseSrc * src, GstEvent * event,
1198 GstSegment * seeksegment)
1200 GstBaseSrcClass *bclass;
1201 gboolean result = FALSE;
1203 bclass = GST_BASE_SRC_GET_CLASS (src);
1205 if (bclass->prepare_seek_segment)
1206 result = bclass->prepare_seek_segment (src, event, seeksegment);
1211 /* this code implements the seeking. It is a good example
1212 * handling all cases.
1214 * A seek updates the currently configured segment.start
1215 * and segment.stop values based on the SEEK_TYPE. If the
1216 * segment.start value is updated, a seek to this new position
1217 * should be performed.
1219 * The seek can only be executed when we are not currently
1220 * streaming any data, to make sure that this is the case, we
1221 * acquire the STREAM_LOCK which is taken when we are in the
1222 * _loop() function or when a getrange() is called. Normally
1223 * we will not receive a seek if we are operating in pull mode
1224 * though. When we operate as a live source we might block on the live
1225 * cond, which does not release the STREAM_LOCK. Therefore we will try
1226 * to grab the LIVE_LOCK instead of the STREAM_LOCK to make sure it is
1227 * safe to perform the seek.
1229 * When we are in the loop() function, we might be in the middle
1230 * of pushing a buffer, which might block in a sink. To make sure
1231 * that the push gets unblocked we push out a FLUSH_START event.
1232 * Our loop function will get a WRONG_STATE return value from
1233 * the push and will pause, effectively releasing the STREAM_LOCK.
1235 * For a non-flushing seek, we pause the task, which might eventually
1236 * release the STREAM_LOCK. We say eventually because when the sink
1237 * blocks on the sample we might wait a very long time until the sink
1238 * unblocks the sample. In any case we acquire the STREAM_LOCK and
1239 * can continue the seek. A non-flushing seek is normally done in a
1240 * running pipeline to perform seamless playback, this means that the sink is
1241 * PLAYING and will return from its chain function.
1242 * In the case of a non-flushing seek we need to make sure that the
1243 * data we output after the seek is continuous with the previous data,
1244 * this is because a non-flushing seek does not reset the running-time
1245 * to 0. We do this by closing the currently running segment, ie. sending
1246 * a new_segment event with the stop position set to the last processed
1249 * After updating the segment.start/stop values, we prepare for
1250 * streaming again. We push out a FLUSH_STOP to make the peer pad
1251 * accept data again and we start our task again.
1253 * A segment seek posts a message on the bus saying that the playback
1254 * of the segment started. We store the segment flag internally because
1255 * when we reach the segment.stop we have to post a segment.done
1256 * instead of EOS when doing a segment seek.
1258 /* FIXME (0.11), we have the unlock gboolean here because most current
1259 * implementations (fdsrc, -base/gst/tcp/, ...) unconditionally unlock, even when
1260 * the streaming thread isn't running, resulting in bogus unlocks later when it
1261 * starts. This is fixed by adding unlock_stop, but we should still avoid unlocking
1262 * unnecessarily for backwards compatibility. Ergo, the unlock variable stays
1266 gst_base_src_perform_seek (GstBaseSrc * src, GstEvent * event, gboolean unlock)
1268 gboolean res = TRUE, tres;
1270 GstFormat seek_format, dest_format;
1272 GstSeekType cur_type, stop_type;
1274 gboolean flush, playing;
1276 gboolean relative_seek = FALSE;
1277 gboolean seekseg_configured = FALSE;
1278 GstSegment seeksegment;
1282 GST_DEBUG_OBJECT (src, "doing seek");
1284 GST_OBJECT_LOCK (src);
1285 dest_format = src->segment.format;
1286 GST_OBJECT_UNLOCK (src);
1289 gst_event_parse_seek (event, &rate, &seek_format, &flags,
1290 &cur_type, &cur, &stop_type, &stop);
1292 relative_seek = SEEK_TYPE_IS_RELATIVE (cur_type) ||
1293 SEEK_TYPE_IS_RELATIVE (stop_type);
1295 if (dest_format != seek_format && !relative_seek) {
1296 /* If we have an ABSOLUTE position (SEEK_SET only), we can convert it
1297 * here before taking the stream lock, otherwise we must convert it later,
1298 * once we have the stream lock and can read the last configures segment
1299 * start and stop positions */
1300 gst_segment_init (&seeksegment, dest_format);
1302 if (!gst_base_src_prepare_seek_segment (src, event, &seeksegment))
1303 goto prepare_failed;
1305 seekseg_configured = TRUE;
1308 flush = flags & GST_SEEK_FLAG_FLUSH;
1309 seqnum = gst_event_get_seqnum (event);
1312 /* get next seqnum */
1313 seqnum = gst_util_seqnum_next ();
1316 /* send flush start */
1318 tevent = gst_event_new_flush_start ();
1319 gst_event_set_seqnum (tevent, seqnum);
1320 gst_pad_push_event (src->srcpad, tevent);
1322 gst_pad_pause_task (src->srcpad);
1324 /* unblock streaming thread. */
1325 gst_base_src_set_flushing (src, TRUE, FALSE, unlock, &playing);
1327 /* grab streaming lock, this should eventually be possible, either
1328 * because the task is paused, our streaming thread stopped
1329 * or because our peer is flushing. */
1330 GST_PAD_STREAM_LOCK (src->srcpad);
1331 if (G_UNLIKELY (src->priv->seqnum == seqnum)) {
1332 /* we have seen this event before, issue a warning for now */
1333 GST_WARNING_OBJECT (src, "duplicate event found %" G_GUINT32_FORMAT,
1336 src->priv->seqnum = seqnum;
1337 GST_DEBUG_OBJECT (src, "seek with seqnum %" G_GUINT32_FORMAT, seqnum);
1340 gst_base_src_set_flushing (src, FALSE, playing, unlock, NULL);
1342 /* If we configured the seeksegment above, don't overwrite it now. Otherwise
1343 * copy the current segment info into the temp segment that we can actually
1344 * attempt the seek with. We only update the real segment if the seek suceeds. */
1345 if (!seekseg_configured) {
1346 memcpy (&seeksegment, &src->segment, sizeof (GstSegment));
1348 /* now configure the final seek segment */
1350 if (seeksegment.format != seek_format) {
1351 /* OK, here's where we give the subclass a chance to convert the relative
1352 * seek into an absolute one in the processing format. We set up any
1353 * absolute seek above, before taking the stream lock. */
1354 if (!gst_base_src_prepare_seek_segment (src, event, &seeksegment)) {
1355 GST_DEBUG_OBJECT (src, "Preparing the seek failed after flushing. "
1360 /* The seek format matches our processing format, no need to ask the
1361 * the subclass to configure the segment. */
1362 gst_segment_set_seek (&seeksegment, rate, seek_format, flags,
1363 cur_type, cur, stop_type, stop, &update);
1366 /* Else, no seek event passed, so we're just (re)starting the
1371 GST_DEBUG_OBJECT (src, "segment configured from %" G_GINT64_FORMAT
1372 " to %" G_GINT64_FORMAT ", position %" G_GINT64_FORMAT,
1373 seeksegment.start, seeksegment.stop, seeksegment.last_stop);
1375 /* do the seek, segment.last_stop contains the new position. */
1376 res = gst_base_src_do_seek (src, &seeksegment);
1379 /* and prepare to continue streaming */
1381 tevent = gst_event_new_flush_stop ();
1382 gst_event_set_seqnum (tevent, seqnum);
1383 /* send flush stop, peer will accept data and events again. We
1384 * are not yet providing data as we still have the STREAM_LOCK. */
1385 gst_pad_push_event (src->srcpad, tevent);
1386 } else if (res && src->data.ABI.running) {
1387 /* we are running the current segment and doing a non-flushing seek,
1388 * close the segment first based on the last_stop. */
1389 GST_DEBUG_OBJECT (src, "closing running segment %" G_GINT64_FORMAT
1390 " to %" G_GINT64_FORMAT, src->segment.start, src->segment.last_stop);
1392 /* queue the segment for sending in the stream thread */
1393 if (src->priv->close_segment)
1394 gst_event_unref (src->priv->close_segment);
1395 src->priv->close_segment =
1396 gst_event_new_new_segment_full (TRUE,
1397 src->segment.rate, src->segment.applied_rate, src->segment.format,
1398 src->segment.start, src->segment.last_stop, src->segment.time);
1399 gst_event_set_seqnum (src->priv->close_segment, seqnum);
1402 /* The subclass must have converted the segment to the processing format
1404 if (res && seeksegment.format != dest_format) {
1405 GST_DEBUG_OBJECT (src, "Subclass failed to prepare a seek segment "
1406 "in the correct format. Aborting seek.");
1410 /* if the seek was successful, we update our real segment and push
1411 * out the new segment. */
1413 GST_OBJECT_LOCK (src);
1414 memcpy (&src->segment, &seeksegment, sizeof (GstSegment));
1415 GST_OBJECT_UNLOCK (src);
1417 if (seeksegment.flags & GST_SEEK_FLAG_SEGMENT) {
1418 GstMessage *message;
1420 message = gst_message_new_segment_start (GST_OBJECT (src),
1421 seeksegment.format, seeksegment.last_stop);
1422 gst_message_set_seqnum (message, seqnum);
1424 gst_element_post_message (GST_ELEMENT (src), message);
1427 /* for deriving a stop position for the playback segment from the seek
1428 * segment, we must take the duration when the stop is not set */
1429 if ((stop = seeksegment.stop) == -1)
1430 stop = seeksegment.duration;
1432 GST_DEBUG_OBJECT (src, "Sending newsegment from %" G_GINT64_FORMAT
1433 " to %" G_GINT64_FORMAT, seeksegment.start, stop);
1435 /* now replace the old segment so that we send it in the stream thread the
1436 * next time it is scheduled. */
1437 if (src->priv->start_segment)
1438 gst_event_unref (src->priv->start_segment);
1439 if (seeksegment.rate >= 0.0) {
1440 /* forward, we send data from last_stop to stop */
1441 src->priv->start_segment =
1442 gst_event_new_new_segment_full (FALSE,
1443 seeksegment.rate, seeksegment.applied_rate, seeksegment.format,
1444 seeksegment.last_stop, stop, seeksegment.time);
1446 /* reverse, we send data from last_stop to start */
1447 src->priv->start_segment =
1448 gst_event_new_new_segment_full (FALSE,
1449 seeksegment.rate, seeksegment.applied_rate, seeksegment.format,
1450 seeksegment.start, seeksegment.last_stop, seeksegment.time);
1452 gst_event_set_seqnum (src->priv->start_segment, seqnum);
1455 src->priv->discont = TRUE;
1456 src->data.ABI.running = TRUE;
1457 /* and restart the task in case it got paused explicitly or by
1458 * the FLUSH_START event we pushed out. */
1459 tres = gst_pad_start_task (src->srcpad, (GstTaskFunction) gst_base_src_loop,
1464 /* and release the lock again so we can continue streaming */
1465 GST_PAD_STREAM_UNLOCK (src->srcpad);
1471 GST_DEBUG_OBJECT (src, "Preparing the seek failed before flushing. "
1476 static const GstQueryType *
1477 gst_base_src_get_query_types (GstElement * element)
1479 static const GstQueryType query_types[] = {
1495 /* all events send to this element directly. This is mainly done from the
1499 gst_base_src_send_event (GstElement * element, GstEvent * event)
1502 gboolean result = FALSE;
1504 src = GST_BASE_SRC (element);
1506 GST_DEBUG_OBJECT (src, "reveived %s event", GST_EVENT_TYPE_NAME (event));
1508 switch (GST_EVENT_TYPE (event)) {
1509 /* bidirectional events */
1510 case GST_EVENT_FLUSH_START:
1511 case GST_EVENT_FLUSH_STOP:
1512 /* sending random flushes downstream can break stuff,
1513 * especially sync since all segment info will get flushed */
1516 /* downstream serialized events */
1519 GstBaseSrcClass *bclass;
1521 bclass = GST_BASE_SRC_GET_CLASS (src);
1523 /* queue EOS and make sure the task or pull function performs the EOS
1526 * We have two possibilities:
1528 * - Before we are to enter the _create function, we check the pending_eos
1529 * first and do EOS instead of entering it.
1530 * - If we are in the _create function or we did not manage to set the
1531 * flag fast enough and we are about to enter the _create function,
1532 * we unlock it so that we exit with WRONG_STATE immediatly. We then
1533 * check the EOS flag and do the EOS logic.
1535 g_atomic_int_set (&src->priv->pending_eos, TRUE);
1536 GST_DEBUG_OBJECT (src, "EOS marked, calling unlock");
1538 /* unlock the _create function so that we can check the pending_eos flag
1539 * and we can do EOS. This will eventually release the LIVE_LOCK again so
1540 * that we can grab it and stop the unlock again. We don't take the stream
1541 * lock so that this operation is guaranteed to never block. */
1543 bclass->unlock (src);
1545 GST_DEBUG_OBJECT (src, "unlock called, waiting for LIVE_LOCK");
1547 GST_LIVE_LOCK (src);
1548 GST_DEBUG_OBJECT (src, "LIVE_LOCK acquired, calling unlock_stop");
1549 /* now stop the unlock of the streaming thread again. Grabbing the live
1550 * lock is enough because that protects the create function. */
1551 if (bclass->unlock_stop)
1552 bclass->unlock_stop (src);
1553 GST_LIVE_UNLOCK (src);
1558 case GST_EVENT_NEWSEGMENT:
1559 /* sending random NEWSEGMENT downstream can break sync. */
1562 /* Insert tag in the dataflow */
1563 GST_OBJECT_LOCK (src);
1564 src->priv->pending_tags = g_list_append (src->priv->pending_tags, event);
1565 GST_OBJECT_UNLOCK (src);
1569 case GST_EVENT_BUFFERSIZE:
1570 /* does not seem to make much sense currently */
1573 /* upstream events */
1575 /* elements should override send_event and do something */
1577 case GST_EVENT_SEEK:
1581 GST_OBJECT_LOCK (src->srcpad);
1582 if (GST_PAD_ACTIVATE_MODE (src->srcpad) == GST_ACTIVATE_PULL)
1584 started = GST_PAD_ACTIVATE_MODE (src->srcpad) == GST_ACTIVATE_PUSH;
1585 GST_OBJECT_UNLOCK (src->srcpad);
1588 GST_DEBUG_OBJECT (src, "performing seek");
1589 /* when we are running in push mode, we can execute the
1590 * seek right now, we need to unlock. */
1591 result = gst_base_src_perform_seek (src, event, TRUE);
1595 /* else we store the event and execute the seek when we
1597 GST_OBJECT_LOCK (src);
1598 GST_DEBUG_OBJECT (src, "queueing seek");
1599 event_p = &src->data.ABI.pending_seek;
1600 gst_event_replace ((GstEvent **) event_p, event);
1601 GST_OBJECT_UNLOCK (src);
1602 /* assume the seek will work */
1607 case GST_EVENT_NAVIGATION:
1608 /* could make sense for elements that do something with navigation events
1609 * but then they would need to override the send_event function */
1611 case GST_EVENT_LATENCY:
1612 /* does not seem to make sense currently */
1616 case GST_EVENT_CUSTOM_UPSTREAM:
1617 /* override send_event if you want this */
1619 case GST_EVENT_CUSTOM_DOWNSTREAM:
1620 case GST_EVENT_CUSTOM_BOTH:
1621 /* FIXME, insert event in the dataflow */
1623 case GST_EVENT_CUSTOM_DOWNSTREAM_OOB:
1624 case GST_EVENT_CUSTOM_BOTH_OOB:
1625 /* insert a random custom event into the pipeline */
1626 GST_DEBUG_OBJECT (src, "pushing custom OOB event downstream");
1627 result = gst_pad_push_event (src->srcpad, event);
1628 /* we gave away the ref to the event in the push */
1635 /* if we still have a ref to the event, unref it now */
1637 gst_event_unref (event);
1644 GST_DEBUG_OBJECT (src, "cannot perform seek when operating in pull mode");
1645 GST_OBJECT_UNLOCK (src->srcpad);
1652 gst_base_src_seekable (GstBaseSrc * src)
1654 GstBaseSrcClass *bclass;
1655 bclass = GST_BASE_SRC_GET_CLASS (src);
1656 if (bclass->is_seekable)
1657 return bclass->is_seekable (src);
1663 gst_base_src_default_event (GstBaseSrc * src, GstEvent * event)
1667 switch (GST_EVENT_TYPE (event)) {
1668 case GST_EVENT_SEEK:
1669 /* is normally called when in push mode */
1670 if (!gst_base_src_seekable (src))
1673 result = gst_base_src_perform_seek (src, event, TRUE);
1675 case GST_EVENT_FLUSH_START:
1676 /* cancel any blocking getrange, is normally called
1677 * when in pull mode. */
1678 result = gst_base_src_set_flushing (src, TRUE, FALSE, TRUE, NULL);
1680 case GST_EVENT_FLUSH_STOP:
1681 result = gst_base_src_set_flushing (src, FALSE, TRUE, TRUE, NULL);
1692 GST_DEBUG_OBJECT (src, "is not seekable");
1698 gst_base_src_event_handler (GstPad * pad, GstEvent * event)
1701 GstBaseSrcClass *bclass;
1702 gboolean result = FALSE;
1704 src = GST_BASE_SRC (gst_pad_get_parent (pad));
1705 bclass = GST_BASE_SRC_GET_CLASS (src);
1707 if (bclass->event) {
1708 if (!(result = bclass->event (src, event)))
1709 goto subclass_failed;
1713 gst_event_unref (event);
1714 gst_object_unref (src);
1721 GST_DEBUG_OBJECT (src, "subclass refused event");
1727 gst_base_src_set_property (GObject * object, guint prop_id,
1728 const GValue * value, GParamSpec * pspec)
1732 src = GST_BASE_SRC (object);
1735 case PROP_BLOCKSIZE:
1736 gst_base_src_set_blocksize (src, g_value_get_ulong (value));
1738 case PROP_NUM_BUFFERS:
1739 src->num_buffers = g_value_get_int (value);
1742 src->data.ABI.typefind = g_value_get_boolean (value);
1744 case PROP_DO_TIMESTAMP:
1745 gst_base_src_set_do_timestamp (src, g_value_get_boolean (value));
1748 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1754 gst_base_src_get_property (GObject * object, guint prop_id, GValue * value,
1759 src = GST_BASE_SRC (object);
1762 case PROP_BLOCKSIZE:
1763 g_value_set_ulong (value, gst_base_src_get_blocksize (src));
1765 case PROP_NUM_BUFFERS:
1766 g_value_set_int (value, src->num_buffers);
1769 g_value_set_boolean (value, src->data.ABI.typefind);
1771 case PROP_DO_TIMESTAMP:
1772 g_value_set_boolean (value, gst_base_src_get_do_timestamp (src));
1775 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1780 /* with STREAM_LOCK and LOCK */
1781 static GstClockReturn
1782 gst_base_src_wait (GstBaseSrc * basesrc, GstClock * clock, GstClockTime time)
1787 id = gst_clock_new_single_shot_id (clock, time);
1789 basesrc->clock_id = id;
1790 /* release the live lock while waiting */
1791 GST_LIVE_UNLOCK (basesrc);
1793 ret = gst_clock_id_wait (id, NULL);
1795 GST_LIVE_LOCK (basesrc);
1796 gst_clock_id_unref (id);
1797 basesrc->clock_id = NULL;
1802 /* perform synchronisation on a buffer.
1805 static GstClockReturn
1806 gst_base_src_do_sync (GstBaseSrc * basesrc, GstBuffer * buffer)
1808 GstClockReturn result;
1809 GstClockTime start, end;
1810 GstBaseSrcClass *bclass;
1811 GstClockTime base_time;
1813 GstClockTime now = GST_CLOCK_TIME_NONE, timestamp;
1814 gboolean do_timestamp, first, pseudo_live;
1816 bclass = GST_BASE_SRC_GET_CLASS (basesrc);
1819 if (bclass->get_times)
1820 bclass->get_times (basesrc, buffer, &start, &end);
1822 /* get buffer timestamp */
1823 timestamp = GST_BUFFER_TIMESTAMP (buffer);
1825 /* grab the lock to prepare for clocking and calculate the startup
1827 GST_OBJECT_LOCK (basesrc);
1829 /* if we are asked to sync against the clock we are a pseudo live element */
1830 pseudo_live = (start != -1 && basesrc->is_live);
1831 /* check for the first buffer */
1832 first = (basesrc->priv->latency == -1);
1834 if (timestamp != -1 && pseudo_live) {
1835 GstClockTime latency;
1837 /* we have a timestamp and a sync time, latency is the diff */
1838 if (timestamp <= start)
1839 latency = start - timestamp;
1844 GST_DEBUG_OBJECT (basesrc, "pseudo_live with latency %" GST_TIME_FORMAT,
1845 GST_TIME_ARGS (latency));
1846 /* first time we calculate latency, just configure */
1847 basesrc->priv->latency = latency;
1849 if (basesrc->priv->latency != latency) {
1850 /* we have a new latency, FIXME post latency message */
1851 basesrc->priv->latency = latency;
1852 GST_DEBUG_OBJECT (basesrc, "latency changed to %" GST_TIME_FORMAT,
1853 GST_TIME_ARGS (latency));
1857 GST_DEBUG_OBJECT (basesrc, "no latency needed, live %d, sync %d",
1858 basesrc->is_live, start != -1);
1859 basesrc->priv->latency = 0;
1862 /* get clock, if no clock, we can't sync or do timestamps */
1863 if ((clock = GST_ELEMENT_CLOCK (basesrc)) == NULL)
1866 base_time = GST_ELEMENT_CAST (basesrc)->base_time;
1868 do_timestamp = basesrc->priv->do_timestamp;
1870 /* first buffer, calculate the timestamp offset */
1872 GstClockTime running_time;
1874 now = gst_clock_get_time (clock);
1875 running_time = now - base_time;
1877 GST_LOG_OBJECT (basesrc,
1878 "startup timestamp: %" GST_TIME_FORMAT ", running_time %"
1879 GST_TIME_FORMAT, GST_TIME_ARGS (timestamp),
1880 GST_TIME_ARGS (running_time));
1882 if (pseudo_live && timestamp != -1) {
1883 /* live source and we need to sync, add startup latency to all timestamps
1884 * to get the real running_time. Live sources should always timestamp
1885 * according to the current running time. */
1886 basesrc->priv->ts_offset = GST_CLOCK_DIFF (timestamp, running_time);
1888 GST_LOG_OBJECT (basesrc, "live with sync, ts_offset %" GST_TIME_FORMAT,
1889 GST_TIME_ARGS (basesrc->priv->ts_offset));
1891 basesrc->priv->ts_offset = 0;
1892 GST_LOG_OBJECT (basesrc, "no timestamp offset needed");
1895 if (!GST_CLOCK_TIME_IS_VALID (timestamp)) {
1897 timestamp = running_time;
1901 GST_BUFFER_TIMESTAMP (buffer) = timestamp;
1903 GST_LOG_OBJECT (basesrc, "created timestamp: %" GST_TIME_FORMAT,
1904 GST_TIME_ARGS (timestamp));
1907 /* add the timestamp offset we need for sync */
1908 timestamp += basesrc->priv->ts_offset;
1910 /* not the first buffer, the timestamp is the diff between the clock and
1912 if (do_timestamp && !GST_CLOCK_TIME_IS_VALID (timestamp)) {
1913 now = gst_clock_get_time (clock);
1915 GST_BUFFER_TIMESTAMP (buffer) = now - base_time;
1917 GST_LOG_OBJECT (basesrc, "created timestamp: %" GST_TIME_FORMAT,
1918 GST_TIME_ARGS (now - base_time));
1922 /* if we don't have a buffer timestamp, we don't sync */
1923 if (!GST_CLOCK_TIME_IS_VALID (start))
1926 if (basesrc->is_live && GST_CLOCK_TIME_IS_VALID (timestamp)) {
1927 /* for pseudo live sources, add our ts_offset to the timestamp */
1928 GST_BUFFER_TIMESTAMP (buffer) += basesrc->priv->ts_offset;
1929 start += basesrc->priv->ts_offset;
1932 GST_LOG_OBJECT (basesrc,
1933 "waiting for clock, base time %" GST_TIME_FORMAT
1934 ", stream_start %" GST_TIME_FORMAT,
1935 GST_TIME_ARGS (base_time), GST_TIME_ARGS (start));
1936 GST_OBJECT_UNLOCK (basesrc);
1938 result = gst_base_src_wait (basesrc, clock, start + base_time);
1940 GST_LOG_OBJECT (basesrc, "clock entry done: %d", result);
1947 GST_DEBUG_OBJECT (basesrc, "we have no clock");
1948 GST_OBJECT_UNLOCK (basesrc);
1949 return GST_CLOCK_OK;
1953 GST_DEBUG_OBJECT (basesrc, "no sync needed");
1954 GST_OBJECT_UNLOCK (basesrc);
1955 return GST_CLOCK_OK;
1959 /* Called with STREAM_LOCK and LIVE_LOCK */
1961 gst_base_src_update_length (GstBaseSrc * src, guint64 offset, guint * length)
1963 guint64 size, maxsize;
1964 GstBaseSrcClass *bclass;
1968 bclass = GST_BASE_SRC_GET_CLASS (src);
1970 format = src->segment.format;
1971 stop = src->segment.stop;
1972 /* get total file size */
1973 size = (guint64) src->segment.duration;
1975 /* only operate if we are working with bytes */
1976 if (format != GST_FORMAT_BYTES)
1979 /* the max amount of bytes to read is the total size or
1980 * up to the segment.stop if present. */
1982 maxsize = MIN (size, stop);
1986 GST_DEBUG_OBJECT (src,
1987 "reading offset %" G_GUINT64_FORMAT ", length %u, size %" G_GINT64_FORMAT
1988 ", segment.stop %" G_GINT64_FORMAT ", maxsize %" G_GINT64_FORMAT, offset,
1989 *length, size, stop, maxsize);
1991 /* check size if we have one */
1992 if (maxsize != -1) {
1993 /* if we run past the end, check if the file became bigger and
1995 if (G_UNLIKELY (offset + *length >= maxsize)) {
1996 /* see if length of the file changed */
1997 if (bclass->get_size)
1998 if (!bclass->get_size (src, &size))
2001 /* make sure we don't exceed the configured segment stop
2004 maxsize = MIN (size, stop);
2008 /* if we are at or past the end, EOS */
2009 if (G_UNLIKELY (offset >= maxsize))
2010 goto unexpected_length;
2012 /* else we can clip to the end */
2013 if (G_UNLIKELY (offset + *length >= maxsize))
2014 *length = maxsize - offset;
2019 /* keep track of current position and update duration.
2020 * segment is in bytes, we checked that above. */
2021 GST_OBJECT_LOCK (src);
2022 gst_segment_set_duration (&src->segment, GST_FORMAT_BYTES, size);
2023 gst_segment_set_last_stop (&src->segment, GST_FORMAT_BYTES, offset);
2024 GST_OBJECT_UNLOCK (src);
2035 /* must be called with LIVE_LOCK */
2036 static GstFlowReturn
2037 gst_base_src_get_range (GstBaseSrc * src, guint64 offset, guint length,
2041 GstBaseSrcClass *bclass;
2042 GstClockReturn status;
2044 bclass = GST_BASE_SRC_GET_CLASS (src);
2048 while (G_UNLIKELY (!src->live_running)) {
2049 ret = gst_base_src_wait_playing (src);
2050 if (ret != GST_FLOW_OK)
2055 if (G_UNLIKELY (!GST_OBJECT_FLAG_IS_SET (src, GST_BASE_SRC_STARTED)))
2058 if (G_UNLIKELY (!bclass->create))
2061 if (G_UNLIKELY (!gst_base_src_update_length (src, offset, &length)))
2062 goto unexpected_length;
2064 /* normally we don't count buffers */
2065 if (G_UNLIKELY (src->num_buffers_left >= 0)) {
2066 if (src->num_buffers_left == 0)
2067 goto reached_num_buffers;
2069 src->num_buffers_left--;
2072 /* don't enter the create function if a pending EOS event was set. For the
2073 * logic of the pending_eos, check the event function of this class. */
2074 if (G_UNLIKELY (g_atomic_int_get (&src->priv->pending_eos)))
2077 GST_DEBUG_OBJECT (src,
2078 "calling create offset %" G_GUINT64_FORMAT " length %u, time %"
2079 G_GINT64_FORMAT, offset, length, src->segment.time);
2081 ret = bclass->create (src, offset, length, buf);
2083 /* The create function could be unlocked because we have a pending EOS. It's
2084 * possible that we have a valid buffer from create that we need to
2085 * discard when the create function returned _OK. */
2086 if (G_UNLIKELY (g_atomic_int_get (&src->priv->pending_eos))) {
2087 if (ret == GST_FLOW_OK) {
2088 gst_buffer_unref (*buf);
2094 if (G_UNLIKELY (ret != GST_FLOW_OK))
2097 /* no timestamp set and we are at offset 0, we can timestamp with 0 */
2098 if (offset == 0 && src->segment.time == 0
2099 && GST_BUFFER_TIMESTAMP (*buf) == -1)
2100 GST_BUFFER_TIMESTAMP (*buf) = 0;
2102 /* set pad caps on the buffer if the buffer had no caps */
2103 if (GST_BUFFER_CAPS (*buf) == NULL)
2104 gst_buffer_set_caps (*buf, GST_PAD_CAPS (src->srcpad));
2106 /* now sync before pushing the buffer */
2107 status = gst_base_src_do_sync (src, *buf);
2109 /* waiting for the clock could have made us flushing */
2110 if (G_UNLIKELY (src->priv->flushing))
2114 case GST_CLOCK_EARLY:
2115 /* the buffer is too late. We currently don't drop the buffer. */
2116 GST_DEBUG_OBJECT (src, "buffer too late!, returning anyway");
2119 /* buffer synchronised properly */
2120 GST_DEBUG_OBJECT (src, "buffer ok");
2122 case GST_CLOCK_UNSCHEDULED:
2123 /* this case is triggered when we were waiting for the clock and
2124 * it got unlocked because we did a state change. In any case, get rid of
2126 gst_buffer_unref (*buf);
2128 if (!src->live_running) {
2129 /* We return WRONG_STATE when we are not running to stop the dataflow also
2130 * get rid of the produced buffer. */
2131 GST_DEBUG_OBJECT (src,
2132 "clock was unscheduled (%d), returning WRONG_STATE", status);
2133 ret = GST_FLOW_WRONG_STATE;
2135 /* If we are running when this happens, we quickly switched between
2136 * pause and playing. We try to produce a new buffer */
2137 GST_DEBUG_OBJECT (src,
2138 "clock was unscheduled (%d), but we are running", status);
2143 /* all other result values are unexpected and errors */
2144 GST_ELEMENT_ERROR (src, CORE, CLOCK,
2145 (_("Internal clock error.")),
2146 ("clock returned unexpected return value %d", status));
2147 gst_buffer_unref (*buf);
2149 ret = GST_FLOW_ERROR;
2157 GST_DEBUG_OBJECT (src, "wait_playing returned %d (%s)", ret,
2158 gst_flow_get_name (ret));
2163 GST_DEBUG_OBJECT (src, "create returned %d (%s)", ret,
2164 gst_flow_get_name (ret));
2169 GST_DEBUG_OBJECT (src, "getrange but not started");
2170 return GST_FLOW_WRONG_STATE;
2174 GST_DEBUG_OBJECT (src, "no create function");
2175 return GST_FLOW_ERROR;
2179 GST_DEBUG_OBJECT (src, "unexpected length %u (offset=%" G_GUINT64_FORMAT
2180 ", size=%" G_GINT64_FORMAT ")", length, offset, src->segment.duration);
2181 return GST_FLOW_UNEXPECTED;
2183 reached_num_buffers:
2185 GST_DEBUG_OBJECT (src, "sent all buffers");
2186 return GST_FLOW_UNEXPECTED;
2190 GST_DEBUG_OBJECT (src, "we are flushing");
2191 gst_buffer_unref (*buf);
2193 return GST_FLOW_WRONG_STATE;
2197 GST_DEBUG_OBJECT (src, "we are EOS");
2198 return GST_FLOW_UNEXPECTED;
2202 static GstFlowReturn
2203 gst_base_src_pad_get_range (GstPad * pad, guint64 offset, guint length,
2209 src = GST_BASE_SRC (gst_pad_get_parent (pad));
2211 GST_LIVE_LOCK (src);
2212 if (G_UNLIKELY (src->priv->flushing))
2215 res = gst_base_src_get_range (src, offset, length, buf);
2218 GST_LIVE_UNLOCK (src);
2220 gst_object_unref (src);
2227 GST_DEBUG_OBJECT (src, "we are flushing");
2228 res = GST_FLOW_WRONG_STATE;
2234 gst_base_src_default_check_get_range (GstBaseSrc * src)
2238 if (!GST_OBJECT_FLAG_IS_SET (src, GST_BASE_SRC_STARTED)) {
2239 GST_LOG_OBJECT (src, "doing start/stop to check get_range support");
2240 if (G_LIKELY (gst_base_src_start (src)))
2241 gst_base_src_stop (src);
2244 /* we can operate in getrange mode if the native format is bytes
2245 * and we are seekable, this condition is set in the random_access
2246 * flag and is set in the _start() method. */
2247 res = src->random_access;
2253 gst_base_src_check_get_range (GstBaseSrc * src)
2255 GstBaseSrcClass *bclass;
2258 bclass = GST_BASE_SRC_GET_CLASS (src);
2260 if (bclass->check_get_range == NULL)
2263 res = bclass->check_get_range (src);
2264 GST_LOG_OBJECT (src, "%s() returned %d",
2265 GST_DEBUG_FUNCPTR_NAME (bclass->check_get_range), (gint) res);
2272 GST_WARNING_OBJECT (src, "no check_get_range function set");
2278 gst_base_src_pad_check_get_range (GstPad * pad)
2283 src = GST_BASE_SRC (GST_OBJECT_PARENT (pad));
2285 res = gst_base_src_check_get_range (src);
2291 gst_base_src_loop (GstPad * pad)
2294 GstBuffer *buf = NULL;
2303 src = GST_BASE_SRC (GST_OBJECT_PARENT (pad));
2305 GST_LIVE_LOCK (src);
2307 if (G_UNLIKELY (src->priv->flushing))
2310 src->priv->last_sent_eos = FALSE;
2312 blocksize = src->blocksize;
2314 /* if we operate in bytes, we can calculate an offset */
2315 if (src->segment.format == GST_FORMAT_BYTES) {
2316 position = src->segment.last_stop;
2317 /* for negative rates, start with subtracting the blocksize */
2318 if (src->segment.rate < 0.0) {
2319 /* we cannot go below segment.start */
2320 if (position > src->segment.start + blocksize)
2321 position -= blocksize;
2323 /* last block, remainder up to segment.start */
2324 blocksize = position - src->segment.start;
2325 position = src->segment.start;
2331 GST_LOG_OBJECT (src, "next_ts %" GST_TIME_FORMAT " size %lu",
2332 GST_TIME_ARGS (position), blocksize);
2334 ret = gst_base_src_get_range (src, position, blocksize, &buf);
2335 if (G_UNLIKELY (ret != GST_FLOW_OK)) {
2336 GST_INFO_OBJECT (src, "pausing after gst_base_src_get_range() = %s",
2337 gst_flow_get_name (ret));
2338 GST_LIVE_UNLOCK (src);
2341 /* this should not happen */
2342 if (G_UNLIKELY (buf == NULL))
2345 /* push events to close/start our segment before we push the buffer. */
2346 if (G_UNLIKELY (src->priv->close_segment)) {
2347 gst_pad_push_event (pad, src->priv->close_segment);
2348 src->priv->close_segment = NULL;
2350 if (G_UNLIKELY (src->priv->start_segment)) {
2351 gst_pad_push_event (pad, src->priv->start_segment);
2352 src->priv->start_segment = NULL;
2355 GST_OBJECT_LOCK (src);
2357 tags = src->priv->pending_tags;
2358 src->priv->pending_tags = NULL;
2359 GST_OBJECT_UNLOCK (src);
2361 /* Push out pending tags if any */
2362 if (G_UNLIKELY (tags != NULL)) {
2363 for (tmp = tags; tmp; tmp = g_list_next (tmp)) {
2364 GstEvent *ev = (GstEvent *) tmp->data;
2365 gst_pad_push_event (pad, ev);
2370 /* figure out the new position */
2371 switch (src->segment.format) {
2372 case GST_FORMAT_BYTES:
2374 guint bufsize = GST_BUFFER_SIZE (buf);
2376 /* we subtracted above for negative rates */
2377 if (src->segment.rate >= 0.0)
2378 position += bufsize;
2381 case GST_FORMAT_TIME:
2383 GstClockTime start, duration;
2385 start = GST_BUFFER_TIMESTAMP (buf);
2386 duration = GST_BUFFER_DURATION (buf);
2388 if (GST_CLOCK_TIME_IS_VALID (start))
2391 position = src->segment.last_stop;
2393 if (GST_CLOCK_TIME_IS_VALID (duration)) {
2394 if (src->segment.rate >= 0.0)
2395 position += duration;
2396 else if (position > duration)
2397 position -= duration;
2403 case GST_FORMAT_DEFAULT:
2404 if (src->segment.rate >= 0.0)
2405 position = GST_BUFFER_OFFSET_END (buf);
2407 position = GST_BUFFER_OFFSET (buf);
2413 if (position != -1) {
2414 if (src->segment.rate >= 0.0) {
2415 /* positive rate, check if we reached the stop */
2416 if (src->segment.stop != -1) {
2417 if (position >= src->segment.stop) {
2419 position = src->segment.stop;
2423 /* negative rate, check if we reached the start. start is always set to
2424 * something different from -1 */
2425 if (position <= src->segment.start) {
2427 position = src->segment.start;
2429 /* when going reverse, all buffers are DISCONT */
2430 src->priv->discont = TRUE;
2432 GST_OBJECT_LOCK (src);
2433 gst_segment_set_last_stop (&src->segment, src->segment.format, position);
2434 GST_OBJECT_UNLOCK (src);
2437 if (G_UNLIKELY (src->priv->discont)) {
2438 buf = gst_buffer_make_metadata_writable (buf);
2439 GST_BUFFER_FLAG_SET (buf, GST_BUFFER_FLAG_DISCONT);
2440 src->priv->discont = FALSE;
2442 GST_LIVE_UNLOCK (src);
2444 ret = gst_pad_push (pad, buf);
2445 if (G_UNLIKELY (ret != GST_FLOW_OK)) {
2446 GST_INFO_OBJECT (src, "pausing after gst_pad_push() = %s",
2447 gst_flow_get_name (ret));
2451 if (G_UNLIKELY (eos)) {
2452 GST_INFO_OBJECT (src, "pausing after end of segment");
2453 ret = GST_FLOW_UNEXPECTED;
2463 GST_DEBUG_OBJECT (src, "we are flushing");
2464 GST_LIVE_UNLOCK (src);
2465 ret = GST_FLOW_WRONG_STATE;
2470 const gchar *reason = gst_flow_get_name (ret);
2473 GST_DEBUG_OBJECT (src, "pausing task, reason %s", reason);
2474 src->data.ABI.running = FALSE;
2475 gst_pad_pause_task (pad);
2476 if (GST_FLOW_IS_FATAL (ret) || ret == GST_FLOW_NOT_LINKED) {
2477 if (ret == GST_FLOW_UNEXPECTED) {
2478 gboolean flag_segment;
2482 /* perform EOS logic */
2483 flag_segment = (src->segment.flags & GST_SEEK_FLAG_SEGMENT) != 0;
2484 format = src->segment.format;
2485 last_stop = src->segment.last_stop;
2488 GstMessage *message;
2490 message = gst_message_new_segment_done (GST_OBJECT_CAST (src),
2492 gst_message_set_seqnum (message, src->priv->seqnum);
2493 gst_element_post_message (GST_ELEMENT_CAST (src), message);
2495 event = gst_event_new_eos ();
2496 gst_event_set_seqnum (event, src->priv->seqnum);
2497 gst_pad_push_event (pad, event);
2498 src->priv->last_sent_eos = TRUE;
2501 event = gst_event_new_eos ();
2502 gst_event_set_seqnum (event, src->priv->seqnum);
2503 /* for fatal errors we post an error message, post the error
2504 * first so the app knows about the error first. */
2505 GST_ELEMENT_ERROR (src, STREAM, FAILED,
2506 (_("Internal data flow error.")),
2507 ("streaming task paused, reason %s (%d)", reason, ret));
2508 gst_pad_push_event (pad, event);
2509 src->priv->last_sent_eos = TRUE;
2516 GST_ELEMENT_ERROR (src, STREAM, FAILED,
2517 (_("Internal data flow error.")), ("element returned NULL buffer"));
2518 GST_LIVE_UNLOCK (src);
2519 /* we finished the segment on error */
2520 ret = GST_FLOW_ERROR;
2525 /* default negotiation code.
2527 * Take intersection between src and sink pads, take first
2531 gst_base_src_default_negotiate (GstBaseSrc * basesrc)
2534 GstCaps *caps = NULL;
2535 GstCaps *peercaps = NULL;
2536 gboolean result = FALSE;
2538 /* first see what is possible on our source pad */
2539 thiscaps = gst_pad_get_caps_reffed (GST_BASE_SRC_PAD (basesrc));
2540 GST_DEBUG_OBJECT (basesrc, "caps of src: %" GST_PTR_FORMAT, thiscaps);
2541 /* nothing or anything is allowed, we're done */
2542 if (thiscaps == NULL || gst_caps_is_any (thiscaps))
2543 goto no_nego_needed;
2545 if (G_UNLIKELY (gst_caps_is_empty (thiscaps)))
2548 /* get the peer caps */
2549 peercaps = gst_pad_peer_get_caps_reffed (GST_BASE_SRC_PAD (basesrc));
2550 GST_DEBUG_OBJECT (basesrc, "caps of peer: %" GST_PTR_FORMAT, peercaps);
2554 /* get intersection */
2555 icaps = gst_caps_intersect (thiscaps, peercaps);
2556 GST_DEBUG_OBJECT (basesrc, "intersect: %" GST_PTR_FORMAT, icaps);
2557 gst_caps_unref (thiscaps);
2558 gst_caps_unref (peercaps);
2560 /* take first (and best, since they are sorted) possibility */
2561 caps = gst_caps_copy_nth (icaps, 0);
2562 gst_caps_unref (icaps);
2565 /* no peer, work with our own caps then */
2569 caps = gst_caps_make_writable (caps);
2570 gst_caps_truncate (caps);
2573 if (!gst_caps_is_empty (caps)) {
2574 gst_pad_fixate_caps (GST_BASE_SRC_PAD (basesrc), caps);
2575 GST_DEBUG_OBJECT (basesrc, "fixated to: %" GST_PTR_FORMAT, caps);
2577 if (gst_caps_is_any (caps)) {
2578 /* hmm, still anything, so element can do anything and
2579 * nego is not needed */
2581 } else if (gst_caps_is_fixed (caps)) {
2582 /* yay, fixed caps, use those then, it's possible that the subclass does
2583 * not accept this caps after all and we have to fail. */
2584 result = gst_pad_set_caps (GST_BASE_SRC_PAD (basesrc), caps);
2587 gst_caps_unref (caps);
2589 GST_DEBUG_OBJECT (basesrc, "no common caps");
2595 GST_DEBUG_OBJECT (basesrc, "no negotiation needed");
2597 gst_caps_unref (thiscaps);
2602 GST_ELEMENT_ERROR (basesrc, STREAM, FORMAT,
2603 ("No supported formats found"),
2604 ("This element did not produce valid caps"));
2606 gst_caps_unref (thiscaps);
2612 gst_base_src_negotiate (GstBaseSrc * basesrc)
2614 GstBaseSrcClass *bclass;
2615 gboolean result = TRUE;
2617 bclass = GST_BASE_SRC_GET_CLASS (basesrc);
2619 if (bclass->negotiate)
2620 result = bclass->negotiate (basesrc);
2626 gst_base_src_start (GstBaseSrc * basesrc)
2628 GstBaseSrcClass *bclass;
2634 if (GST_OBJECT_FLAG_IS_SET (basesrc, GST_BASE_SRC_STARTED))
2637 GST_DEBUG_OBJECT (basesrc, "starting source");
2639 basesrc->num_buffers_left = basesrc->num_buffers;
2641 GST_OBJECT_LOCK (basesrc);
2642 gst_segment_init (&basesrc->segment, basesrc->segment.format);
2643 GST_OBJECT_UNLOCK (basesrc);
2645 basesrc->data.ABI.running = FALSE;
2647 bclass = GST_BASE_SRC_GET_CLASS (basesrc);
2649 result = bclass->start (basesrc);
2654 goto could_not_start;
2656 GST_OBJECT_FLAG_SET (basesrc, GST_BASE_SRC_STARTED);
2658 format = basesrc->segment.format;
2660 /* figure out the size */
2661 if (format == GST_FORMAT_BYTES) {
2662 if (bclass->get_size) {
2663 if (!(result = bclass->get_size (basesrc, &size)))
2669 GST_DEBUG_OBJECT (basesrc, "setting size %" G_GUINT64_FORMAT, size);
2670 /* only update the size when operating in bytes, subclass is supposed
2671 * to set duration in the start method for other formats */
2672 GST_OBJECT_LOCK (basesrc);
2673 gst_segment_set_duration (&basesrc->segment, GST_FORMAT_BYTES, size);
2674 GST_OBJECT_UNLOCK (basesrc);
2679 GST_DEBUG_OBJECT (basesrc,
2680 "format: %d, have size: %d, size: %" G_GUINT64_FORMAT ", duration: %"
2681 G_GINT64_FORMAT, format, result, size, basesrc->segment.duration);
2683 seekable = gst_base_src_seekable (basesrc);
2684 GST_DEBUG_OBJECT (basesrc, "is seekable: %d", seekable);
2686 /* update for random access flag */
2687 basesrc->random_access = seekable && format == GST_FORMAT_BYTES;
2689 GST_DEBUG_OBJECT (basesrc, "is random_access: %d", basesrc->random_access);
2691 /* run typefind if we are random_access and the typefinding is enabled. */
2692 if (basesrc->random_access && basesrc->data.ABI.typefind && size != -1) {
2695 if (!(caps = gst_type_find_helper (basesrc->srcpad, size)))
2696 goto typefind_failed;
2698 result = gst_pad_set_caps (basesrc->srcpad, caps);
2699 gst_caps_unref (caps);
2701 /* use class or default negotiate function */
2702 if (!(result = gst_base_src_negotiate (basesrc)))
2703 goto could_not_negotiate;
2711 GST_DEBUG_OBJECT (basesrc, "could not start");
2712 /* subclass is supposed to post a message. We don't have to call _stop. */
2715 could_not_negotiate:
2717 GST_DEBUG_OBJECT (basesrc, "could not negotiate, stopping");
2718 GST_ELEMENT_ERROR (basesrc, STREAM, FORMAT,
2719 ("Could not negotiate format"), ("Check your filtered caps, if any"));
2720 /* we must call stop */
2721 gst_base_src_stop (basesrc);
2726 GST_DEBUG_OBJECT (basesrc, "could not typefind, stopping");
2727 GST_ELEMENT_ERROR (basesrc, STREAM, TYPE_NOT_FOUND, (NULL), (NULL));
2728 /* we must call stop */
2729 gst_base_src_stop (basesrc);
2735 gst_base_src_stop (GstBaseSrc * basesrc)
2737 GstBaseSrcClass *bclass;
2738 gboolean result = TRUE;
2740 if (!GST_OBJECT_FLAG_IS_SET (basesrc, GST_BASE_SRC_STARTED))
2743 GST_DEBUG_OBJECT (basesrc, "stopping source");
2745 bclass = GST_BASE_SRC_GET_CLASS (basesrc);
2747 result = bclass->stop (basesrc);
2750 GST_OBJECT_FLAG_UNSET (basesrc, GST_BASE_SRC_STARTED);
2755 /* start or stop flushing dataprocessing
2758 gst_base_src_set_flushing (GstBaseSrc * basesrc,
2759 gboolean flushing, gboolean live_play, gboolean unlock, gboolean * playing)
2761 GstBaseSrcClass *bclass;
2763 bclass = GST_BASE_SRC_GET_CLASS (basesrc);
2765 if (flushing && unlock) {
2766 /* unlock any subclasses, we need to do this before grabbing the
2767 * LIVE_LOCK since we hold this lock before going into ::create. We pass an
2768 * unlock to the params because of backwards compat (see seek handler)*/
2770 bclass->unlock (basesrc);
2773 /* the live lock is released when we are blocked, waiting for playing or
2774 * when we sync to the clock. */
2775 GST_LIVE_LOCK (basesrc);
2777 *playing = basesrc->live_running;
2778 basesrc->priv->flushing = flushing;
2780 /* if we are locked in the live lock, signal it to make it flush */
2781 basesrc->live_running = TRUE;
2783 /* clear pending EOS if any */
2784 g_atomic_int_set (&basesrc->priv->pending_eos, FALSE);
2786 /* step 1, now that we have the LIVE lock, clear our unlock request */
2787 if (bclass->unlock_stop)
2788 bclass->unlock_stop (basesrc);
2790 /* step 2, unblock clock sync (if any) or any other blocking thing */
2791 if (basesrc->clock_id)
2792 gst_clock_id_unschedule (basesrc->clock_id);
2794 /* signal the live source that it can start playing */
2795 basesrc->live_running = live_play;
2797 GST_LIVE_SIGNAL (basesrc);
2798 GST_LIVE_UNLOCK (basesrc);
2803 /* the purpose of this function is to make sure that a live source blocks in the
2804 * LIVE lock or leaves the LIVE lock and continues playing. */
2806 gst_base_src_set_playing (GstBaseSrc * basesrc, gboolean live_play)
2808 GstBaseSrcClass *bclass;
2810 bclass = GST_BASE_SRC_GET_CLASS (basesrc);
2812 /* unlock subclasses locked in ::create, we only do this when we stop playing. */
2814 GST_DEBUG_OBJECT (basesrc, "unlock");
2816 bclass->unlock (basesrc);
2819 /* we are now able to grab the LIVE lock, when we get it, we can be
2820 * waiting for PLAYING while blocked in the LIVE cond or we can be waiting
2822 GST_LIVE_LOCK (basesrc);
2823 GST_DEBUG_OBJECT (basesrc, "unschedule clock");
2825 /* unblock clock sync (if any) */
2826 if (basesrc->clock_id)
2827 gst_clock_id_unschedule (basesrc->clock_id);
2829 /* configure what to do when we get to the LIVE lock. */
2830 GST_DEBUG_OBJECT (basesrc, "live running %d", live_play);
2831 basesrc->live_running = live_play;
2836 /* clear our unlock request when going to PLAYING */
2837 GST_DEBUG_OBJECT (basesrc, "unlock stop");
2838 if (bclass->unlock_stop)
2839 bclass->unlock_stop (basesrc);
2841 /* for live sources we restart the timestamp correction */
2842 basesrc->priv->latency = -1;
2843 /* have to restart the task in case it stopped because of the unlock when
2844 * we went to PAUSED. Only do this if we operating in push mode. */
2845 GST_OBJECT_LOCK (basesrc->srcpad);
2846 start = (GST_PAD_ACTIVATE_MODE (basesrc->srcpad) == GST_ACTIVATE_PUSH);
2847 GST_OBJECT_UNLOCK (basesrc->srcpad);
2849 gst_pad_start_task (basesrc->srcpad, (GstTaskFunction) gst_base_src_loop,
2851 GST_DEBUG_OBJECT (basesrc, "signal");
2852 GST_LIVE_SIGNAL (basesrc);
2854 GST_LIVE_UNLOCK (basesrc);
2860 gst_base_src_activate_push (GstPad * pad, gboolean active)
2862 GstBaseSrc *basesrc;
2865 basesrc = GST_BASE_SRC (GST_OBJECT_PARENT (pad));
2867 /* prepare subclass first */
2869 GST_DEBUG_OBJECT (basesrc, "Activating in push mode");
2871 if (G_UNLIKELY (!basesrc->can_activate_push))
2872 goto no_push_activation;
2874 if (G_UNLIKELY (!gst_base_src_start (basesrc)))
2877 basesrc->priv->last_sent_eos = FALSE;
2878 basesrc->priv->discont = TRUE;
2879 gst_base_src_set_flushing (basesrc, FALSE, FALSE, FALSE, NULL);
2881 /* do initial seek, which will start the task */
2882 GST_OBJECT_LOCK (basesrc);
2883 event = basesrc->data.ABI.pending_seek;
2884 basesrc->data.ABI.pending_seek = NULL;
2885 GST_OBJECT_UNLOCK (basesrc);
2887 /* no need to unlock anything, the task is certainly
2888 * not running here. The perform seek code will start the task when
2890 if (G_UNLIKELY (!gst_base_src_perform_seek (basesrc, event, FALSE)))
2894 gst_event_unref (event);
2896 GST_DEBUG_OBJECT (basesrc, "Deactivating in push mode");
2898 gst_base_src_set_flushing (basesrc, TRUE, FALSE, TRUE, NULL);
2900 gst_pad_stop_task (pad);
2901 /* now we can stop the source */
2902 if (G_UNLIKELY (!gst_base_src_stop (basesrc)))
2910 GST_WARNING_OBJECT (basesrc, "Subclass disabled push-mode activation");
2915 GST_WARNING_OBJECT (basesrc, "Failed to start in push mode");
2920 GST_ERROR_OBJECT (basesrc, "Failed to perform initial seek");
2922 gst_base_src_set_flushing (basesrc, TRUE, FALSE, TRUE, NULL);
2924 gst_pad_stop_task (pad);
2925 /* Stop the basesrc */
2926 gst_base_src_stop (basesrc);
2928 gst_event_unref (event);
2933 GST_DEBUG_OBJECT (basesrc, "Failed to stop in push mode");
2939 gst_base_src_activate_pull (GstPad * pad, gboolean active)
2941 GstBaseSrc *basesrc;
2943 basesrc = GST_BASE_SRC (GST_OBJECT_PARENT (pad));
2945 /* prepare subclass first */
2947 GST_DEBUG_OBJECT (basesrc, "Activating in pull mode");
2948 if (G_UNLIKELY (!gst_base_src_start (basesrc)))
2951 /* if not random_access, we cannot operate in pull mode for now */
2952 if (G_UNLIKELY (!gst_base_src_check_get_range (basesrc)))
2955 /* stop flushing now but for live sources, still block in the LIVE lock when
2956 * we are not yet PLAYING */
2957 gst_base_src_set_flushing (basesrc, FALSE, FALSE, FALSE, NULL);
2959 GST_DEBUG_OBJECT (basesrc, "Deactivating in pull mode");
2960 /* flush all, there is no task to stop */
2961 gst_base_src_set_flushing (basesrc, TRUE, FALSE, TRUE, NULL);
2963 /* don't send EOS when going from PAUSED => READY when in pull mode */
2964 basesrc->priv->last_sent_eos = TRUE;
2966 if (G_UNLIKELY (!gst_base_src_stop (basesrc)))
2974 GST_ERROR_OBJECT (basesrc, "Failed to start in pull mode");
2979 GST_ERROR_OBJECT (basesrc, "Cannot operate in pull mode, stopping");
2980 gst_base_src_stop (basesrc);
2985 GST_ERROR_OBJECT (basesrc, "Failed to stop in pull mode");
2990 static GstStateChangeReturn
2991 gst_base_src_change_state (GstElement * element, GstStateChange transition)
2993 GstBaseSrc *basesrc;
2994 GstStateChangeReturn result;
2995 gboolean no_preroll = FALSE;
2997 basesrc = GST_BASE_SRC (element);
2999 switch (transition) {
3000 case GST_STATE_CHANGE_NULL_TO_READY:
3002 case GST_STATE_CHANGE_READY_TO_PAUSED:
3003 no_preroll = gst_base_src_is_live (basesrc);
3005 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
3006 GST_DEBUG_OBJECT (basesrc, "PAUSED->PLAYING");
3007 if (gst_base_src_is_live (basesrc)) {
3008 /* now we can start playback */
3009 gst_base_src_set_playing (basesrc, TRUE);
3017 GST_ELEMENT_CLASS (parent_class)->change_state (element,
3018 transition)) == GST_STATE_CHANGE_FAILURE)
3021 switch (transition) {
3022 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
3023 GST_DEBUG_OBJECT (basesrc, "PLAYING->PAUSED");
3024 if (gst_base_src_is_live (basesrc)) {
3025 /* make sure we block in the live lock in PAUSED */
3026 gst_base_src_set_playing (basesrc, FALSE);
3030 case GST_STATE_CHANGE_PAUSED_TO_READY:
3032 GstEvent **event_p, *event;
3034 /* we don't need to unblock anything here, the pad deactivation code
3035 * already did this */
3037 /* FIXME, deprecate this behaviour, it is very dangerous.
3038 * the prefered way of sending EOS downstream is by sending
3039 * the EOS event to the element */
3040 if (!basesrc->priv->last_sent_eos) {
3041 GST_DEBUG_OBJECT (basesrc, "Sending EOS event");
3042 event = gst_event_new_eos ();
3043 gst_event_set_seqnum (event, basesrc->priv->seqnum);
3044 gst_pad_push_event (basesrc->srcpad, event);
3045 basesrc->priv->last_sent_eos = TRUE;
3047 g_atomic_int_set (&basesrc->priv->pending_eos, FALSE);
3048 event_p = &basesrc->data.ABI.pending_seek;
3049 gst_event_replace (event_p, NULL);
3050 event_p = &basesrc->priv->close_segment;
3051 gst_event_replace (event_p, NULL);
3052 event_p = &basesrc->priv->start_segment;
3053 gst_event_replace (event_p, NULL);
3056 case GST_STATE_CHANGE_READY_TO_NULL:
3062 if (no_preroll && result == GST_STATE_CHANGE_SUCCESS)
3063 result = GST_STATE_CHANGE_NO_PREROLL;
3070 GST_DEBUG_OBJECT (basesrc, "parent failed state change");