base: Make upstream events MT-safe
[platform/upstream/gstreamer.git] / libs / gst / base / gstbasesrc.c
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *               2000,2005 Wim Taymans <wim@fluendo.com>
4  *
5  * gstbasesrc.c:
6  *
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.
11  *
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.
16  *
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.
21  */
22
23 /**
24  * SECTION:gstbasesrc
25  * @short_description: Base class for getrange based source elements
26  * @see_also: #GstPushSrc, #GstBaseTransform, #GstBaseSink
27  *
28  * This is a generice base class for source elements. The following
29  * types of sources are supported:
30  * <itemizedlist>
31  *   <listitem><para>random access sources like files</para></listitem>
32  *   <listitem><para>seekable sources</para></listitem>
33  *   <listitem><para>live sources</para></listitem>
34  * </itemizedlist>
35  *
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.
40  *
41  * #GstBaseSrc always supports push mode scheduling. If the following
42  * conditions are met, it also supports pull mode scheduling:
43  * <itemizedlist>
44  *   <listitem><para>The format is set to #GST_FORMAT_BYTES (default).</para>
45  *   </listitem>
46  *   <listitem><para>#GstBaseSrcClass.is_seekable() returns %TRUE.</para>
47  *   </listitem>
48  * </itemizedlist>
49  *
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.
52  *
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
56  * #GST_FORMAT_BYTES:
57  * <itemizedlist>
58  *   <listitem><para>
59  *     #GstBaseSrcClass.is_seekable() returns %TRUE.
60  *   </para></listitem>
61  *   <listitem><para>
62  *     #GstBaseSrcClass.query() can convert all supported seek formats to the
63  *     internal format as set with gst_base_src_set_format().
64  *   </para></listitem>
65  *   <listitem><para>
66  *     #GstBaseSrcClass.do_seek() is implemented, performs the seek and returns
67  *      %TRUE.
68  *   </para></listitem>
69  * </itemizedlist>
70  *
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.
77  *
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
81  * this rate.
82  * Use gst_base_src_set_live() to activate the live source mode.
83  *
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.
89  *
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.
94  *
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
98  * PAUSED.
99  *
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.
107  *
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
113  * acceptable.
114  *
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:
118  * |[
119  * static void
120  * my_element_class_init (GstMyElementClass *klass)
121  * {
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 (&amp;srctemplate));
127  *   // see #GstElementDetails
128  *   gst_element_class_set_details (gstelement_class, &amp;details);
129  * }
130  * ]|
131  *
132  * <refsect2>
133  * <title>Controlled shutdown of live sources in applications</title>
134  * <para>
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.
143  *
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.
148  *
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.
152  *
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.
155  *
156  * Last reviewed on 2007-12-19 (0.10.16)
157  * </para>
158  * </refsect2>
159  */
160
161 #ifdef HAVE_CONFIG_H
162 #  include "config.h"
163 #endif
164
165 #include <stdlib.h>
166 #include <string.h>
167
168 #include <gst/gst_private.h>
169
170 #include "gstbasesrc.h"
171 #include "gsttypefindhelper.h"
172 #include <gst/gstmarshal.h>
173 #include <gst/gst-i18n-lib.h>
174
175 GST_DEBUG_CATEGORY_STATIC (gst_base_src_debug);
176 #define GST_CAT_DEFAULT gst_base_src_debug
177
178 #define GST_LIVE_GET_LOCK(elem)               (GST_BASE_SRC_CAST(elem)->live_lock)
179 #define GST_LIVE_LOCK(elem)                   g_mutex_lock(GST_LIVE_GET_LOCK(elem))
180 #define GST_LIVE_TRYLOCK(elem)                g_mutex_trylock(GST_LIVE_GET_LOCK(elem))
181 #define GST_LIVE_UNLOCK(elem)                 g_mutex_unlock(GST_LIVE_GET_LOCK(elem))
182 #define GST_LIVE_GET_COND(elem)               (GST_BASE_SRC_CAST(elem)->live_cond)
183 #define GST_LIVE_WAIT(elem)                   g_cond_wait (GST_LIVE_GET_COND (elem), GST_LIVE_GET_LOCK (elem))
184 #define GST_LIVE_TIMED_WAIT(elem, timeval)    g_cond_timed_wait (GST_LIVE_GET_COND (elem), GST_LIVE_GET_LOCK (elem),\
185                                                                                 timeval)
186 #define GST_LIVE_SIGNAL(elem)                 g_cond_signal (GST_LIVE_GET_COND (elem));
187 #define GST_LIVE_BROADCAST(elem)              g_cond_broadcast (GST_LIVE_GET_COND (elem));
188
189 /* BaseSrc signals and args */
190 enum
191 {
192   /* FILL ME */
193   LAST_SIGNAL
194 };
195
196 #define DEFAULT_BLOCKSIZE       4096
197 #define DEFAULT_NUM_BUFFERS     -1
198 #define DEFAULT_TYPEFIND        FALSE
199 #define DEFAULT_DO_TIMESTAMP    FALSE
200
201 enum
202 {
203   PROP_0,
204   PROP_BLOCKSIZE,
205   PROP_NUM_BUFFERS,
206   PROP_TYPEFIND,
207   PROP_DO_TIMESTAMP
208 };
209
210 #define GST_BASE_SRC_GET_PRIVATE(obj)  \
211    (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_BASE_SRC, GstBaseSrcPrivate))
212
213 struct _GstBaseSrcPrivate
214 {
215   gboolean last_sent_eos;       /* last thing we did was send an EOS (we set this
216                                  * to avoid the sending of two EOS in some cases) */
217   gboolean discont;
218   gboolean flushing;
219
220   /* two segments to be sent in the streaming thread with STREAM_LOCK */
221   GstEvent *close_segment;
222   GstEvent *start_segment;
223   gboolean newsegment_pending;
224
225   /* if EOS is pending (atomic) */
226   gint pending_eos;
227
228   /* startup latency is the time it takes between going to PLAYING and producing
229    * the first BUFFER with running_time 0. This value is included in the latency
230    * reporting. */
231   GstClockTime latency;
232   /* timestamp offset, this is the offset add to the values of gst_times for
233    * pseudo live sources */
234   GstClockTimeDiff ts_offset;
235
236   gboolean do_timestamp;
237
238   /* stream sequence number */
239   guint32 seqnum;
240
241   /* pending events (TAG, CUSTOM_BOTH, CUSTOM_DOWNSTREAM) to be
242    * pushed in the data stream */
243   GList *pending_events;
244   volatile gint have_events;
245
246   /* QoS *//* with LOCK */
247   gboolean qos_enabled;
248   gdouble proportion;
249   GstClockTime earliest_time;
250 };
251
252 static GstElementClass *parent_class = NULL;
253
254 static void gst_base_src_base_init (gpointer g_class);
255 static void gst_base_src_class_init (GstBaseSrcClass * klass);
256 static void gst_base_src_init (GstBaseSrc * src, gpointer g_class);
257 static void gst_base_src_finalize (GObject * object);
258
259
260 GType
261 gst_base_src_get_type (void)
262 {
263   static volatile gsize base_src_type = 0;
264
265   if (g_once_init_enter (&base_src_type)) {
266     GType _type;
267     static const GTypeInfo base_src_info = {
268       sizeof (GstBaseSrcClass),
269       (GBaseInitFunc) gst_base_src_base_init,
270       NULL,
271       (GClassInitFunc) gst_base_src_class_init,
272       NULL,
273       NULL,
274       sizeof (GstBaseSrc),
275       0,
276       (GInstanceInitFunc) gst_base_src_init,
277     };
278
279     _type = g_type_register_static (GST_TYPE_ELEMENT,
280         "GstBaseSrc", &base_src_info, G_TYPE_FLAG_ABSTRACT);
281     g_once_init_leave (&base_src_type, _type);
282   }
283   return base_src_type;
284 }
285
286 static GstCaps *gst_base_src_getcaps (GstPad * pad);
287 static gboolean gst_base_src_setcaps (GstPad * pad, GstCaps * caps);
288 static void gst_base_src_fixate (GstPad * pad, GstCaps * caps);
289
290 static gboolean gst_base_src_activate_push (GstPad * pad, gboolean active);
291 static gboolean gst_base_src_activate_pull (GstPad * pad, gboolean active);
292 static void gst_base_src_set_property (GObject * object, guint prop_id,
293     const GValue * value, GParamSpec * pspec);
294 static void gst_base_src_get_property (GObject * object, guint prop_id,
295     GValue * value, GParamSpec * pspec);
296 static gboolean gst_base_src_event_handler (GstPad * pad, GstEvent * event);
297 static gboolean gst_base_src_send_event (GstElement * elem, GstEvent * event);
298 static gboolean gst_base_src_default_event (GstBaseSrc * src, GstEvent * event);
299 static const GstQueryType *gst_base_src_get_query_types (GstElement * element);
300
301 static gboolean gst_base_src_query (GstPad * pad, GstQuery * query);
302
303 static gboolean gst_base_src_default_negotiate (GstBaseSrc * basesrc);
304 static gboolean gst_base_src_default_do_seek (GstBaseSrc * src,
305     GstSegment * segment);
306 static gboolean gst_base_src_default_query (GstBaseSrc * src, GstQuery * query);
307 static gboolean gst_base_src_default_prepare_seek_segment (GstBaseSrc * src,
308     GstEvent * event, GstSegment * segment);
309
310 static gboolean gst_base_src_set_flushing (GstBaseSrc * basesrc,
311     gboolean flushing, gboolean live_play, gboolean unlock, gboolean * playing);
312 static gboolean gst_base_src_start (GstBaseSrc * basesrc);
313 static gboolean gst_base_src_stop (GstBaseSrc * basesrc);
314
315 static GstStateChangeReturn gst_base_src_change_state (GstElement * element,
316     GstStateChange transition);
317
318 static void gst_base_src_loop (GstPad * pad);
319 static gboolean gst_base_src_pad_check_get_range (GstPad * pad);
320 static gboolean gst_base_src_default_check_get_range (GstBaseSrc * bsrc);
321 static GstFlowReturn gst_base_src_pad_get_range (GstPad * pad, guint64 offset,
322     guint length, GstBuffer ** buf);
323 static GstFlowReturn gst_base_src_get_range (GstBaseSrc * src, guint64 offset,
324     guint length, GstBuffer ** buf);
325 static gboolean gst_base_src_seekable (GstBaseSrc * src);
326
327 static void
328 gst_base_src_base_init (gpointer g_class)
329 {
330   GST_DEBUG_CATEGORY_INIT (gst_base_src_debug, "basesrc", 0, "basesrc element");
331 }
332
333 static void
334 gst_base_src_class_init (GstBaseSrcClass * klass)
335 {
336   GObjectClass *gobject_class;
337   GstElementClass *gstelement_class;
338
339   gobject_class = G_OBJECT_CLASS (klass);
340   gstelement_class = GST_ELEMENT_CLASS (klass);
341
342   g_type_class_add_private (klass, sizeof (GstBaseSrcPrivate));
343
344   parent_class = g_type_class_peek_parent (klass);
345
346   gobject_class->finalize = gst_base_src_finalize;
347   gobject_class->set_property = gst_base_src_set_property;
348   gobject_class->get_property = gst_base_src_get_property;
349
350 /* FIXME 0.11: blocksize property should be int, not ulong (min is >max here) */
351   g_object_class_install_property (gobject_class, PROP_BLOCKSIZE,
352       g_param_spec_ulong ("blocksize", "Block size",
353           "Size in bytes to read per buffer (-1 = default)", 0, G_MAXULONG,
354           DEFAULT_BLOCKSIZE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
355   g_object_class_install_property (gobject_class, PROP_NUM_BUFFERS,
356       g_param_spec_int ("num-buffers", "num-buffers",
357           "Number of buffers to output before sending EOS (-1 = unlimited)",
358           -1, G_MAXINT, DEFAULT_NUM_BUFFERS, G_PARAM_READWRITE |
359           G_PARAM_STATIC_STRINGS));
360   g_object_class_install_property (gobject_class, PROP_TYPEFIND,
361       g_param_spec_boolean ("typefind", "Typefind",
362           "Run typefind before negotiating", DEFAULT_TYPEFIND,
363           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
364   g_object_class_install_property (gobject_class, PROP_DO_TIMESTAMP,
365       g_param_spec_boolean ("do-timestamp", "Do timestamp",
366           "Apply current stream time to buffers", DEFAULT_DO_TIMESTAMP,
367           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
368
369   gstelement_class->change_state =
370       GST_DEBUG_FUNCPTR (gst_base_src_change_state);
371   gstelement_class->send_event = GST_DEBUG_FUNCPTR (gst_base_src_send_event);
372   gstelement_class->get_query_types =
373       GST_DEBUG_FUNCPTR (gst_base_src_get_query_types);
374
375   klass->negotiate = GST_DEBUG_FUNCPTR (gst_base_src_default_negotiate);
376   klass->event = GST_DEBUG_FUNCPTR (gst_base_src_default_event);
377   klass->do_seek = GST_DEBUG_FUNCPTR (gst_base_src_default_do_seek);
378   klass->query = GST_DEBUG_FUNCPTR (gst_base_src_default_query);
379   klass->check_get_range =
380       GST_DEBUG_FUNCPTR (gst_base_src_default_check_get_range);
381   klass->prepare_seek_segment =
382       GST_DEBUG_FUNCPTR (gst_base_src_default_prepare_seek_segment);
383
384   /* Registering debug symbols for function pointers */
385   GST_DEBUG_REGISTER_FUNCPTR (gst_base_src_activate_push);
386   GST_DEBUG_REGISTER_FUNCPTR (gst_base_src_activate_pull);
387   GST_DEBUG_REGISTER_FUNCPTR (gst_base_src_event_handler);
388   GST_DEBUG_REGISTER_FUNCPTR (gst_base_src_query);
389   GST_DEBUG_REGISTER_FUNCPTR (gst_base_src_pad_get_range);
390   GST_DEBUG_REGISTER_FUNCPTR (gst_base_src_pad_check_get_range);
391   GST_DEBUG_REGISTER_FUNCPTR (gst_base_src_getcaps);
392   GST_DEBUG_REGISTER_FUNCPTR (gst_base_src_setcaps);
393   GST_DEBUG_REGISTER_FUNCPTR (gst_base_src_fixate);
394 }
395
396 static void
397 gst_base_src_init (GstBaseSrc * basesrc, gpointer g_class)
398 {
399   GstPad *pad;
400   GstPadTemplate *pad_template;
401
402   basesrc->priv = GST_BASE_SRC_GET_PRIVATE (basesrc);
403
404   basesrc->is_live = FALSE;
405   basesrc->live_lock = g_mutex_new ();
406   basesrc->live_cond = g_cond_new ();
407   basesrc->num_buffers = DEFAULT_NUM_BUFFERS;
408   basesrc->num_buffers_left = -1;
409
410   basesrc->can_activate_push = TRUE;
411   basesrc->pad_mode = GST_ACTIVATE_NONE;
412
413   pad_template =
414       gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "src");
415   g_return_if_fail (pad_template != NULL);
416
417   GST_DEBUG_OBJECT (basesrc, "creating src pad");
418   pad = gst_pad_new_from_template (pad_template, "src");
419
420   GST_DEBUG_OBJECT (basesrc, "setting functions on src pad");
421   gst_pad_set_activatepush_function (pad, gst_base_src_activate_push);
422   gst_pad_set_activatepull_function (pad, gst_base_src_activate_pull);
423   gst_pad_set_event_function (pad, gst_base_src_event_handler);
424   gst_pad_set_query_function (pad, gst_base_src_query);
425   gst_pad_set_checkgetrange_function (pad, gst_base_src_pad_check_get_range);
426   gst_pad_set_getrange_function (pad, gst_base_src_pad_get_range);
427   gst_pad_set_getcaps_function (pad, gst_base_src_getcaps);
428   gst_pad_set_setcaps_function (pad, gst_base_src_setcaps);
429   gst_pad_set_fixatecaps_function (pad, gst_base_src_fixate);
430
431   /* hold pointer to pad */
432   basesrc->srcpad = pad;
433   GST_DEBUG_OBJECT (basesrc, "adding src pad");
434   gst_element_add_pad (GST_ELEMENT (basesrc), pad);
435
436   basesrc->blocksize = DEFAULT_BLOCKSIZE;
437   basesrc->clock_id = NULL;
438   /* we operate in BYTES by default */
439   gst_base_src_set_format (basesrc, GST_FORMAT_BYTES);
440   basesrc->data.ABI.typefind = DEFAULT_TYPEFIND;
441   basesrc->priv->do_timestamp = DEFAULT_DO_TIMESTAMP;
442   g_atomic_int_set (&basesrc->priv->have_events, FALSE);
443
444   GST_OBJECT_FLAG_UNSET (basesrc, GST_BASE_SRC_STARTED);
445   GST_OBJECT_FLAG_SET (basesrc, GST_ELEMENT_IS_SOURCE);
446
447   GST_DEBUG_OBJECT (basesrc, "init done");
448 }
449
450 static void
451 gst_base_src_finalize (GObject * object)
452 {
453   GstBaseSrc *basesrc;
454   GstEvent **event_p;
455
456   basesrc = GST_BASE_SRC (object);
457
458   g_mutex_free (basesrc->live_lock);
459   g_cond_free (basesrc->live_cond);
460
461   event_p = &basesrc->data.ABI.pending_seek;
462   gst_event_replace (event_p, NULL);
463
464   if (basesrc->priv->pending_events) {
465     g_list_foreach (basesrc->priv->pending_events, (GFunc) gst_event_unref,
466         NULL);
467     g_list_free (basesrc->priv->pending_events);
468   }
469
470   G_OBJECT_CLASS (parent_class)->finalize (object);
471 }
472
473 /**
474  * gst_base_src_wait_playing:
475  * @src: the src
476  *
477  * If the #GstBaseSrcClass.create() method performs its own synchronisation
478  * against the clock it must unblock when going from PLAYING to the PAUSED state
479  * and call this method before continuing to produce the remaining data.
480  *
481  * This function will block until a state change to PLAYING happens (in which
482  * case this function returns #GST_FLOW_OK) or the processing must be stopped due
483  * to a state change to READY or a FLUSH event (in which case this function
484  * returns #GST_FLOW_WRONG_STATE).
485  *
486  * Since: 0.10.12
487  *
488  * Returns: #GST_FLOW_OK if @src is PLAYING and processing can
489  * continue. Any other return value should be returned from the create vmethod.
490  */
491 GstFlowReturn
492 gst_base_src_wait_playing (GstBaseSrc * src)
493 {
494   g_return_val_if_fail (GST_IS_BASE_SRC (src), GST_FLOW_ERROR);
495
496   do {
497     /* block until the state changes, or we get a flush, or something */
498     GST_DEBUG_OBJECT (src, "live source waiting for running state");
499     GST_LIVE_WAIT (src);
500     GST_DEBUG_OBJECT (src, "live source unlocked");
501     if (src->priv->flushing)
502       goto flushing;
503   } while (G_UNLIKELY (!src->live_running));
504
505   return GST_FLOW_OK;
506
507   /* ERRORS */
508 flushing:
509   {
510     GST_DEBUG_OBJECT (src, "we are flushing");
511     return GST_FLOW_WRONG_STATE;
512   }
513 }
514
515 /**
516  * gst_base_src_set_live:
517  * @src: base source instance
518  * @live: new live-mode
519  *
520  * If the element listens to a live source, @live should
521  * be set to %TRUE.
522  *
523  * A live source will not produce data in the PAUSED state and
524  * will therefore not be able to participate in the PREROLL phase
525  * of a pipeline. To signal this fact to the application and the
526  * pipeline, the state change return value of the live source will
527  * be GST_STATE_CHANGE_NO_PREROLL.
528  */
529 void
530 gst_base_src_set_live (GstBaseSrc * src, gboolean live)
531 {
532   g_return_if_fail (GST_IS_BASE_SRC (src));
533
534   GST_OBJECT_LOCK (src);
535   src->is_live = live;
536   GST_OBJECT_UNLOCK (src);
537 }
538
539 /**
540  * gst_base_src_is_live:
541  * @src: base source instance
542  *
543  * Check if an element is in live mode.
544  *
545  * Returns: %TRUE if element is in live mode.
546  */
547 gboolean
548 gst_base_src_is_live (GstBaseSrc * src)
549 {
550   gboolean result;
551
552   g_return_val_if_fail (GST_IS_BASE_SRC (src), FALSE);
553
554   GST_OBJECT_LOCK (src);
555   result = src->is_live;
556   GST_OBJECT_UNLOCK (src);
557
558   return result;
559 }
560
561 /**
562  * gst_base_src_set_format:
563  * @src: base source instance
564  * @format: the format to use
565  *
566  * Sets the default format of the source. This will be the format used
567  * for sending NEW_SEGMENT events and for performing seeks.
568  *
569  * If a format of GST_FORMAT_BYTES is set, the element will be able to
570  * operate in pull mode if the #GstBaseSrcClass.is_seekable() returns TRUE.
571  *
572  * This function must only be called in states < %GST_STATE_PAUSED.
573  *
574  * Since: 0.10.1
575  */
576 void
577 gst_base_src_set_format (GstBaseSrc * src, GstFormat format)
578 {
579   g_return_if_fail (GST_IS_BASE_SRC (src));
580   g_return_if_fail (GST_STATE (src) <= GST_STATE_READY);
581
582   GST_OBJECT_LOCK (src);
583   gst_segment_init (&src->segment, format);
584   GST_OBJECT_UNLOCK (src);
585 }
586
587 /**
588  * gst_base_src_query_latency:
589  * @src: the source
590  * @live: (out) (allow-none): if the source is live
591  * @min_latency: (out) (allow-none): the min latency of the source
592  * @max_latency: (out) (allow-none): the max latency of the source
593  *
594  * Query the source for the latency parameters. @live will be TRUE when @src is
595  * configured as a live source. @min_latency will be set to the difference
596  * between the running time and the timestamp of the first buffer.
597  * @max_latency is always the undefined value of -1.
598  *
599  * This function is mostly used by subclasses.
600  *
601  * Returns: TRUE if the query succeeded.
602  *
603  * Since: 0.10.13
604  */
605 gboolean
606 gst_base_src_query_latency (GstBaseSrc * src, gboolean * live,
607     GstClockTime * min_latency, GstClockTime * max_latency)
608 {
609   GstClockTime min;
610
611   g_return_val_if_fail (GST_IS_BASE_SRC (src), FALSE);
612
613   GST_OBJECT_LOCK (src);
614   if (live)
615     *live = src->is_live;
616
617   /* if we have a startup latency, report this one, else report 0. Subclasses
618    * are supposed to override the query function if they want something
619    * else. */
620   if (src->priv->latency != -1)
621     min = src->priv->latency;
622   else
623     min = 0;
624
625   if (min_latency)
626     *min_latency = min;
627   if (max_latency)
628     *max_latency = -1;
629
630   GST_LOG_OBJECT (src, "latency: live %d, min %" GST_TIME_FORMAT
631       ", max %" GST_TIME_FORMAT, src->is_live, GST_TIME_ARGS (min),
632       GST_TIME_ARGS (-1));
633   GST_OBJECT_UNLOCK (src);
634
635   return TRUE;
636 }
637
638 /**
639  * gst_base_src_set_blocksize:
640  * @src: the source
641  * @blocksize: the new blocksize in bytes
642  *
643  * Set the number of bytes that @src will push out with each buffer. When
644  * @blocksize is set to -1, a default length will be used.
645  *
646  * Since: 0.10.22
647  */
648 /* FIXME 0.11: blocksize property should be int, not ulong */
649 void
650 gst_base_src_set_blocksize (GstBaseSrc * src, gulong blocksize)
651 {
652   g_return_if_fail (GST_IS_BASE_SRC (src));
653
654   GST_OBJECT_LOCK (src);
655   src->blocksize = blocksize;
656   GST_OBJECT_UNLOCK (src);
657 }
658
659 /**
660  * gst_base_src_get_blocksize:
661  * @src: the source
662  *
663  * Get the number of bytes that @src will push out with each buffer.
664  *
665  * Returns: the number of bytes pushed with each buffer.
666  *
667  * Since: 0.10.22
668  */
669 /* FIXME 0.11: blocksize property should be int, not ulong */
670 gulong
671 gst_base_src_get_blocksize (GstBaseSrc * src)
672 {
673   gulong res;
674
675   g_return_val_if_fail (GST_IS_BASE_SRC (src), 0);
676
677   GST_OBJECT_LOCK (src);
678   res = src->blocksize;
679   GST_OBJECT_UNLOCK (src);
680
681   return res;
682 }
683
684
685 /**
686  * gst_base_src_set_do_timestamp:
687  * @src: the source
688  * @timestamp: enable or disable timestamping
689  *
690  * Configure @src to automatically timestamp outgoing buffers based on the
691  * current running_time of the pipeline. This property is mostly useful for live
692  * sources.
693  *
694  * Since: 0.10.15
695  */
696 void
697 gst_base_src_set_do_timestamp (GstBaseSrc * src, gboolean timestamp)
698 {
699   g_return_if_fail (GST_IS_BASE_SRC (src));
700
701   GST_OBJECT_LOCK (src);
702   src->priv->do_timestamp = timestamp;
703   GST_OBJECT_UNLOCK (src);
704 }
705
706 /**
707  * gst_base_src_get_do_timestamp:
708  * @src: the source
709  *
710  * Query if @src timestamps outgoing buffers based on the current running_time.
711  *
712  * Returns: %TRUE if the base class will automatically timestamp outgoing buffers.
713  *
714  * Since: 0.10.15
715  */
716 gboolean
717 gst_base_src_get_do_timestamp (GstBaseSrc * src)
718 {
719   gboolean res;
720
721   g_return_val_if_fail (GST_IS_BASE_SRC (src), FALSE);
722
723   GST_OBJECT_LOCK (src);
724   res = src->priv->do_timestamp;
725   GST_OBJECT_UNLOCK (src);
726
727   return res;
728 }
729
730 /**
731  * gst_base_src_new_seamless_segment:
732  * @src: The source
733  * @start: The new start value for the segment
734  * @stop: Stop value for the new segment
735  * @position: The position value for the new segent
736  *
737  * Prepare a new seamless segment for emission downstream. This function must
738  * only be called by derived sub-classes, and only from the create() function,
739  * as the stream-lock needs to be held.
740  *
741  * The format for the new segment will be the current format of the source, as
742  * configured with gst_base_src_set_format()
743  *
744  * Returns: %TRUE if preparation of the seamless segment succeeded.
745  *
746  * Since: 0.10.26
747  */
748 gboolean
749 gst_base_src_new_seamless_segment (GstBaseSrc * src, gint64 start, gint64 stop,
750     gint64 position)
751 {
752   gboolean res = TRUE;
753
754   GST_DEBUG_OBJECT (src,
755       "Starting new seamless segment. Start %" GST_TIME_FORMAT " stop %"
756       GST_TIME_FORMAT " position %" GST_TIME_FORMAT, GST_TIME_ARGS (start),
757       GST_TIME_ARGS (stop), GST_TIME_ARGS (position));
758
759   GST_OBJECT_LOCK (src);
760   if (src->data.ABI.running && !src->priv->newsegment_pending) {
761     if (src->priv->close_segment)
762       gst_event_unref (src->priv->close_segment);
763     src->priv->close_segment =
764         gst_event_new_new_segment_full (TRUE,
765         src->segment.rate, src->segment.applied_rate, src->segment.format,
766         src->segment.start, src->segment.last_stop, src->segment.time);
767   }
768
769   gst_segment_set_newsegment_full (&src->segment, FALSE, src->segment.rate,
770       src->segment.applied_rate, src->segment.format, start, stop, position);
771
772   if (src->priv->start_segment)
773     gst_event_unref (src->priv->start_segment);
774   if (src->segment.rate >= 0.0) {
775     /* forward, we send data from last_stop to stop */
776     src->priv->start_segment =
777         gst_event_new_new_segment_full (FALSE,
778         src->segment.rate, src->segment.applied_rate, src->segment.format,
779         src->segment.last_stop, stop, src->segment.time);
780   } else {
781     /* reverse, we send data from last_stop to start */
782     src->priv->start_segment =
783         gst_event_new_new_segment_full (FALSE,
784         src->segment.rate, src->segment.applied_rate, src->segment.format,
785         src->segment.start, src->segment.last_stop, src->segment.time);
786   }
787   GST_OBJECT_UNLOCK (src);
788
789   src->priv->discont = TRUE;
790   src->data.ABI.running = TRUE;
791
792   return res;
793 }
794
795 static gboolean
796 gst_base_src_setcaps (GstPad * pad, GstCaps * caps)
797 {
798   GstBaseSrcClass *bclass;
799   GstBaseSrc *bsrc;
800   gboolean res = TRUE;
801
802   bsrc = GST_BASE_SRC (GST_PAD_PARENT (pad));
803   bclass = GST_BASE_SRC_GET_CLASS (bsrc);
804
805   if (bclass->set_caps)
806     res = bclass->set_caps (bsrc, caps);
807
808   return res;
809 }
810
811 static GstCaps *
812 gst_base_src_getcaps (GstPad * pad)
813 {
814   GstBaseSrcClass *bclass;
815   GstBaseSrc *bsrc;
816   GstCaps *caps = NULL;
817
818   bsrc = GST_BASE_SRC (GST_PAD_PARENT (pad));
819   bclass = GST_BASE_SRC_GET_CLASS (bsrc);
820   if (bclass->get_caps)
821     caps = bclass->get_caps (bsrc);
822
823   if (caps == NULL) {
824     GstPadTemplate *pad_template;
825
826     pad_template =
827         gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass), "src");
828     if (pad_template != NULL) {
829       caps = gst_caps_ref (gst_pad_template_get_caps (pad_template));
830     }
831   }
832   return caps;
833 }
834
835 static void
836 gst_base_src_fixate (GstPad * pad, GstCaps * caps)
837 {
838   GstBaseSrcClass *bclass;
839   GstBaseSrc *bsrc;
840
841   bsrc = GST_BASE_SRC (gst_pad_get_parent (pad));
842   bclass = GST_BASE_SRC_GET_CLASS (bsrc);
843
844   if (bclass->fixate)
845     bclass->fixate (bsrc, caps);
846
847   gst_object_unref (bsrc);
848 }
849
850 static gboolean
851 gst_base_src_default_query (GstBaseSrc * src, GstQuery * query)
852 {
853   gboolean res;
854
855   switch (GST_QUERY_TYPE (query)) {
856     case GST_QUERY_POSITION:
857     {
858       GstFormat format;
859
860       gst_query_parse_position (query, &format, NULL);
861
862       GST_DEBUG_OBJECT (src, "position query in format %s",
863           gst_format_get_name (format));
864
865       switch (format) {
866         case GST_FORMAT_PERCENT:
867         {
868           gint64 percent;
869           gint64 position;
870           gint64 duration;
871
872           GST_OBJECT_LOCK (src);
873           position = src->segment.last_stop;
874           duration = src->segment.duration;
875           GST_OBJECT_UNLOCK (src);
876
877           if (position != -1 && duration != -1) {
878             if (position < duration)
879               percent = gst_util_uint64_scale (GST_FORMAT_PERCENT_MAX, position,
880                   duration);
881             else
882               percent = GST_FORMAT_PERCENT_MAX;
883           } else
884             percent = -1;
885
886           gst_query_set_position (query, GST_FORMAT_PERCENT, percent);
887           res = TRUE;
888           break;
889         }
890         default:
891         {
892           gint64 position;
893           GstFormat seg_format;
894
895           GST_OBJECT_LOCK (src);
896           position =
897               gst_segment_to_stream_time (&src->segment, src->segment.format,
898               src->segment.last_stop);
899           seg_format = src->segment.format;
900           GST_OBJECT_UNLOCK (src);
901
902           if (position != -1) {
903             /* convert to requested format */
904             res =
905                 gst_pad_query_convert (src->srcpad, seg_format,
906                 position, &format, &position);
907           } else
908             res = TRUE;
909
910           gst_query_set_position (query, format, position);
911           break;
912         }
913       }
914       break;
915     }
916     case GST_QUERY_DURATION:
917     {
918       GstFormat format;
919
920       gst_query_parse_duration (query, &format, NULL);
921
922       GST_DEBUG_OBJECT (src, "duration query in format %s",
923           gst_format_get_name (format));
924
925       switch (format) {
926         case GST_FORMAT_PERCENT:
927           gst_query_set_duration (query, GST_FORMAT_PERCENT,
928               GST_FORMAT_PERCENT_MAX);
929           res = TRUE;
930           break;
931         default:
932         {
933           gint64 duration;
934           GstFormat seg_format;
935
936           GST_OBJECT_LOCK (src);
937           /* this is the duration as configured by the subclass. */
938           duration = src->segment.duration;
939           seg_format = src->segment.format;
940           GST_OBJECT_UNLOCK (src);
941
942           GST_LOG_OBJECT (src, "duration %" G_GINT64_FORMAT ", format %s",
943               duration, gst_format_get_name (seg_format));
944
945           if (duration != -1) {
946             /* convert to requested format, if this fails, we have a duration
947              * but we cannot answer the query, we must return FALSE. */
948             res =
949                 gst_pad_query_convert (src->srcpad, seg_format,
950                 duration, &format, &duration);
951           } else {
952             /* The subclass did not configure a duration, we assume that the
953              * media has an unknown duration then and we return TRUE to report
954              * this. Note that this is not the same as returning FALSE, which
955              * means that we cannot report the duration at all. */
956             res = TRUE;
957           }
958           gst_query_set_duration (query, format, duration);
959           break;
960         }
961       }
962       break;
963     }
964
965     case GST_QUERY_SEEKING:
966     {
967       GstFormat format, seg_format;
968       gint64 duration;
969
970       GST_OBJECT_LOCK (src);
971       duration = src->segment.duration;
972       seg_format = src->segment.format;
973       GST_OBJECT_UNLOCK (src);
974
975       gst_query_parse_seeking (query, &format, NULL, NULL, NULL);
976       if (format == seg_format) {
977         gst_query_set_seeking (query, seg_format,
978             gst_base_src_seekable (src), 0, duration);
979         res = TRUE;
980       } else {
981         /* FIXME 0.11: return TRUE + seekable=FALSE for SEEKING query here */
982         /* Don't reply to the query to make up for demuxers which don't
983          * handle the SEEKING query yet. Players like Totem will fall back
984          * to the duration when the SEEKING query isn't answered. */
985         res = FALSE;
986       }
987       break;
988     }
989     case GST_QUERY_SEGMENT:
990     {
991       gint64 start, stop;
992
993       GST_OBJECT_LOCK (src);
994       /* no end segment configured, current duration then */
995       if ((stop = src->segment.stop) == -1)
996         stop = src->segment.duration;
997       start = src->segment.start;
998
999       /* adjust to stream time */
1000       if (src->segment.time != -1) {
1001         start -= src->segment.time;
1002         if (stop != -1)
1003           stop -= src->segment.time;
1004       }
1005
1006       gst_query_set_segment (query, src->segment.rate, src->segment.format,
1007           start, stop);
1008       GST_OBJECT_UNLOCK (src);
1009       res = TRUE;
1010       break;
1011     }
1012
1013     case GST_QUERY_FORMATS:
1014     {
1015       gst_query_set_formats (query, 3, GST_FORMAT_DEFAULT,
1016           GST_FORMAT_BYTES, GST_FORMAT_PERCENT);
1017       res = TRUE;
1018       break;
1019     }
1020     case GST_QUERY_CONVERT:
1021     {
1022       GstFormat src_fmt, dest_fmt;
1023       gint64 src_val, dest_val;
1024
1025       gst_query_parse_convert (query, &src_fmt, &src_val, &dest_fmt, &dest_val);
1026
1027       /* we can only convert between equal formats... */
1028       if (src_fmt == dest_fmt) {
1029         dest_val = src_val;
1030         res = TRUE;
1031       } else
1032         res = FALSE;
1033
1034       gst_query_set_convert (query, src_fmt, src_val, dest_fmt, dest_val);
1035       break;
1036     }
1037     case GST_QUERY_LATENCY:
1038     {
1039       GstClockTime min, max;
1040       gboolean live;
1041
1042       /* Subclasses should override and implement something usefull */
1043       res = gst_base_src_query_latency (src, &live, &min, &max);
1044
1045       GST_LOG_OBJECT (src, "report latency: live %d, min %" GST_TIME_FORMAT
1046           ", max %" GST_TIME_FORMAT, live, GST_TIME_ARGS (min),
1047           GST_TIME_ARGS (max));
1048
1049       gst_query_set_latency (query, live, min, max);
1050       break;
1051     }
1052     case GST_QUERY_JITTER:
1053     case GST_QUERY_RATE:
1054       res = FALSE;
1055       break;
1056     case GST_QUERY_BUFFERING:
1057     {
1058       GstFormat format, seg_format;
1059       gint64 start, stop, estimated;
1060
1061       gst_query_parse_buffering_range (query, &format, NULL, NULL, NULL);
1062
1063       GST_DEBUG_OBJECT (src, "buffering query in format %s",
1064           gst_format_get_name (format));
1065
1066       GST_OBJECT_LOCK (src);
1067       if (src->random_access) {
1068         estimated = 0;
1069         start = 0;
1070         if (format == GST_FORMAT_PERCENT)
1071           stop = GST_FORMAT_PERCENT_MAX;
1072         else
1073           stop = src->segment.duration;
1074       } else {
1075         estimated = -1;
1076         start = -1;
1077         stop = -1;
1078       }
1079       seg_format = src->segment.format;
1080       GST_OBJECT_UNLOCK (src);
1081
1082       /* convert to required format. When the conversion fails, we can't answer
1083        * the query. When the value is unknown, we can don't perform conversion
1084        * but report TRUE. */
1085       if (format != GST_FORMAT_PERCENT && stop != -1) {
1086         res = gst_pad_query_convert (src->srcpad, seg_format,
1087             stop, &format, &stop);
1088       } else {
1089         res = TRUE;
1090       }
1091       if (res && format != GST_FORMAT_PERCENT && start != -1)
1092         res = gst_pad_query_convert (src->srcpad, seg_format,
1093             start, &format, &start);
1094
1095       gst_query_set_buffering_range (query, format, start, stop, estimated);
1096       break;
1097     }
1098     default:
1099       res = FALSE;
1100       break;
1101   }
1102   GST_DEBUG_OBJECT (src, "query %s returns %d", GST_QUERY_TYPE_NAME (query),
1103       res);
1104   return res;
1105 }
1106
1107 static gboolean
1108 gst_base_src_query (GstPad * pad, GstQuery * query)
1109 {
1110   GstBaseSrc *src;
1111   GstBaseSrcClass *bclass;
1112   gboolean result = FALSE;
1113
1114   src = GST_BASE_SRC (gst_pad_get_parent (pad));
1115
1116   bclass = GST_BASE_SRC_GET_CLASS (src);
1117
1118   if (bclass->query)
1119     result = bclass->query (src, query);
1120   else
1121     result = gst_pad_query_default (pad, query);
1122
1123   gst_object_unref (src);
1124
1125   return result;
1126 }
1127
1128 static gboolean
1129 gst_base_src_default_do_seek (GstBaseSrc * src, GstSegment * segment)
1130 {
1131   gboolean res = TRUE;
1132
1133   /* update our offset if the start/stop position was updated */
1134   if (segment->format == GST_FORMAT_BYTES) {
1135     segment->time = segment->start;
1136   } else if (segment->start == 0) {
1137     /* seek to start, we can implement a default for this. */
1138     segment->time = 0;
1139   } else {
1140     res = FALSE;
1141     GST_INFO_OBJECT (src, "Can't do a default seek");
1142   }
1143
1144   return res;
1145 }
1146
1147 static gboolean
1148 gst_base_src_do_seek (GstBaseSrc * src, GstSegment * segment)
1149 {
1150   GstBaseSrcClass *bclass;
1151   gboolean result = FALSE;
1152
1153   bclass = GST_BASE_SRC_GET_CLASS (src);
1154
1155   if (bclass->do_seek)
1156     result = bclass->do_seek (src, segment);
1157
1158   return result;
1159 }
1160
1161 #define SEEK_TYPE_IS_RELATIVE(t) (((t) != GST_SEEK_TYPE_NONE) && ((t) != GST_SEEK_TYPE_SET))
1162
1163 static gboolean
1164 gst_base_src_default_prepare_seek_segment (GstBaseSrc * src, GstEvent * event,
1165     GstSegment * segment)
1166 {
1167   /* By default, we try one of 2 things:
1168    *   - For absolute seek positions, convert the requested position to our
1169    *     configured processing format and place it in the output segment \
1170    *   - For relative seek positions, convert our current (input) values to the
1171    *     seek format, adjust by the relative seek offset and then convert back to
1172    *     the processing format
1173    */
1174   GstSeekType cur_type, stop_type;
1175   gint64 cur, stop;
1176   GstSeekFlags flags;
1177   GstFormat seek_format, dest_format;
1178   gdouble rate;
1179   gboolean update;
1180   gboolean res = TRUE;
1181
1182   gst_event_parse_seek (event, &rate, &seek_format, &flags,
1183       &cur_type, &cur, &stop_type, &stop);
1184   dest_format = segment->format;
1185
1186   if (seek_format == dest_format) {
1187     gst_segment_set_seek (segment, rate, seek_format, flags,
1188         cur_type, cur, stop_type, stop, &update);
1189     return TRUE;
1190   }
1191
1192   if (cur_type != GST_SEEK_TYPE_NONE) {
1193     /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
1194     res =
1195         gst_pad_query_convert (src->srcpad, seek_format, cur, &dest_format,
1196         &cur);
1197     cur_type = GST_SEEK_TYPE_SET;
1198   }
1199
1200   if (res && stop_type != GST_SEEK_TYPE_NONE) {
1201     /* FIXME: Handle seek_cur & seek_end by converting the input segment vals */
1202     res =
1203         gst_pad_query_convert (src->srcpad, seek_format, stop, &dest_format,
1204         &stop);
1205     stop_type = GST_SEEK_TYPE_SET;
1206   }
1207
1208   /* And finally, configure our output segment in the desired format */
1209   gst_segment_set_seek (segment, rate, dest_format, flags, cur_type, cur,
1210       stop_type, stop, &update);
1211
1212   if (!res)
1213     goto no_format;
1214
1215   return res;
1216
1217 no_format:
1218   {
1219     GST_DEBUG_OBJECT (src, "undefined format given, seek aborted.");
1220     return FALSE;
1221   }
1222 }
1223
1224 static gboolean
1225 gst_base_src_prepare_seek_segment (GstBaseSrc * src, GstEvent * event,
1226     GstSegment * seeksegment)
1227 {
1228   GstBaseSrcClass *bclass;
1229   gboolean result = FALSE;
1230
1231   bclass = GST_BASE_SRC_GET_CLASS (src);
1232
1233   if (bclass->prepare_seek_segment)
1234     result = bclass->prepare_seek_segment (src, event, seeksegment);
1235
1236   return result;
1237 }
1238
1239 /* this code implements the seeking. It is a good example
1240  * handling all cases.
1241  *
1242  * A seek updates the currently configured segment.start
1243  * and segment.stop values based on the SEEK_TYPE. If the
1244  * segment.start value is updated, a seek to this new position
1245  * should be performed.
1246  *
1247  * The seek can only be executed when we are not currently
1248  * streaming any data, to make sure that this is the case, we
1249  * acquire the STREAM_LOCK which is taken when we are in the
1250  * _loop() function or when a getrange() is called. Normally
1251  * we will not receive a seek if we are operating in pull mode
1252  * though. When we operate as a live source we might block on the live
1253  * cond, which does not release the STREAM_LOCK. Therefore we will try
1254  * to grab the LIVE_LOCK instead of the STREAM_LOCK to make sure it is
1255  * safe to perform the seek.
1256  *
1257  * When we are in the loop() function, we might be in the middle
1258  * of pushing a buffer, which might block in a sink. To make sure
1259  * that the push gets unblocked we push out a FLUSH_START event.
1260  * Our loop function will get a WRONG_STATE return value from
1261  * the push and will pause, effectively releasing the STREAM_LOCK.
1262  *
1263  * For a non-flushing seek, we pause the task, which might eventually
1264  * release the STREAM_LOCK. We say eventually because when the sink
1265  * blocks on the sample we might wait a very long time until the sink
1266  * unblocks the sample. In any case we acquire the STREAM_LOCK and
1267  * can continue the seek. A non-flushing seek is normally done in a
1268  * running pipeline to perform seamless playback, this means that the sink is
1269  * PLAYING and will return from its chain function.
1270  * In the case of a non-flushing seek we need to make sure that the
1271  * data we output after the seek is continuous with the previous data,
1272  * this is because a non-flushing seek does not reset the running-time
1273  * to 0. We do this by closing the currently running segment, ie. sending
1274  * a new_segment event with the stop position set to the last processed
1275  * position.
1276  *
1277  * After updating the segment.start/stop values, we prepare for
1278  * streaming again. We push out a FLUSH_STOP to make the peer pad
1279  * accept data again and we start our task again.
1280  *
1281  * A segment seek posts a message on the bus saying that the playback
1282  * of the segment started. We store the segment flag internally because
1283  * when we reach the segment.stop we have to post a segment.done
1284  * instead of EOS when doing a segment seek.
1285  */
1286 /* FIXME (0.11), we have the unlock gboolean here because most current
1287  * implementations (fdsrc, -base/gst/tcp/, ...) unconditionally unlock, even when
1288  * the streaming thread isn't running, resulting in bogus unlocks later when it
1289  * starts. This is fixed by adding unlock_stop, but we should still avoid unlocking
1290  * unnecessarily for backwards compatibility. Ergo, the unlock variable stays
1291  * until 0.11
1292  */
1293 static gboolean
1294 gst_base_src_perform_seek (GstBaseSrc * src, GstEvent * event, gboolean unlock)
1295 {
1296   gboolean res = TRUE, tres;
1297   gdouble rate;
1298   GstFormat seek_format, dest_format;
1299   GstSeekFlags flags;
1300   GstSeekType cur_type, stop_type;
1301   gint64 cur, stop;
1302   gboolean flush, playing;
1303   gboolean update;
1304   gboolean relative_seek = FALSE;
1305   gboolean seekseg_configured = FALSE;
1306   GstSegment seeksegment;
1307   guint32 seqnum;
1308   GstEvent *tevent;
1309
1310   GST_DEBUG_OBJECT (src, "doing seek: %" GST_PTR_FORMAT, event);
1311
1312   GST_OBJECT_LOCK (src);
1313   dest_format = src->segment.format;
1314   GST_OBJECT_UNLOCK (src);
1315
1316   if (event) {
1317     gst_event_parse_seek (event, &rate, &seek_format, &flags,
1318         &cur_type, &cur, &stop_type, &stop);
1319
1320     relative_seek = SEEK_TYPE_IS_RELATIVE (cur_type) ||
1321         SEEK_TYPE_IS_RELATIVE (stop_type);
1322
1323     if (dest_format != seek_format && !relative_seek) {
1324       /* If we have an ABSOLUTE position (SEEK_SET only), we can convert it
1325        * here before taking the stream lock, otherwise we must convert it later,
1326        * once we have the stream lock and can read the last configures segment
1327        * start and stop positions */
1328       gst_segment_init (&seeksegment, dest_format);
1329
1330       if (!gst_base_src_prepare_seek_segment (src, event, &seeksegment))
1331         goto prepare_failed;
1332
1333       seekseg_configured = TRUE;
1334     }
1335
1336     flush = flags & GST_SEEK_FLAG_FLUSH;
1337     seqnum = gst_event_get_seqnum (event);
1338   } else {
1339     flush = FALSE;
1340     /* get next seqnum */
1341     seqnum = gst_util_seqnum_next ();
1342   }
1343
1344   /* send flush start */
1345   if (flush) {
1346     tevent = gst_event_new_flush_start ();
1347     gst_event_set_seqnum (tevent, seqnum);
1348     gst_pad_push_event (src->srcpad, tevent);
1349   } else
1350     gst_pad_pause_task (src->srcpad);
1351
1352   /* unblock streaming thread. */
1353   gst_base_src_set_flushing (src, TRUE, FALSE, unlock, &playing);
1354
1355   /* grab streaming lock, this should eventually be possible, either
1356    * because the task is paused, our streaming thread stopped
1357    * or because our peer is flushing. */
1358   GST_PAD_STREAM_LOCK (src->srcpad);
1359   if (G_UNLIKELY (src->priv->seqnum == seqnum)) {
1360     /* we have seen this event before, issue a warning for now */
1361     GST_WARNING_OBJECT (src, "duplicate event found %" G_GUINT32_FORMAT,
1362         seqnum);
1363   } else {
1364     src->priv->seqnum = seqnum;
1365     GST_DEBUG_OBJECT (src, "seek with seqnum %" G_GUINT32_FORMAT, seqnum);
1366   }
1367
1368   gst_base_src_set_flushing (src, FALSE, playing, unlock, NULL);
1369
1370   /* If we configured the seeksegment above, don't overwrite it now. Otherwise
1371    * copy the current segment info into the temp segment that we can actually
1372    * attempt the seek with. We only update the real segment if the seek suceeds. */
1373   if (!seekseg_configured) {
1374     memcpy (&seeksegment, &src->segment, sizeof (GstSegment));
1375
1376     /* now configure the final seek segment */
1377     if (event) {
1378       if (seeksegment.format != seek_format) {
1379         /* OK, here's where we give the subclass a chance to convert the relative
1380          * seek into an absolute one in the processing format. We set up any
1381          * absolute seek above, before taking the stream lock. */
1382         if (!gst_base_src_prepare_seek_segment (src, event, &seeksegment)) {
1383           GST_DEBUG_OBJECT (src, "Preparing the seek failed after flushing. "
1384               "Aborting seek");
1385           res = FALSE;
1386         }
1387       } else {
1388         /* The seek format matches our processing format, no need to ask the
1389          * the subclass to configure the segment. */
1390         gst_segment_set_seek (&seeksegment, rate, seek_format, flags,
1391             cur_type, cur, stop_type, stop, &update);
1392       }
1393     }
1394     /* Else, no seek event passed, so we're just (re)starting the
1395        current segment. */
1396   }
1397
1398   if (res) {
1399     GST_DEBUG_OBJECT (src, "segment configured from %" G_GINT64_FORMAT
1400         " to %" G_GINT64_FORMAT ", position %" G_GINT64_FORMAT,
1401         seeksegment.start, seeksegment.stop, seeksegment.last_stop);
1402
1403     /* do the seek, segment.last_stop contains the new position. */
1404     res = gst_base_src_do_seek (src, &seeksegment);
1405   }
1406
1407   /* and prepare to continue streaming */
1408   if (flush) {
1409     tevent = gst_event_new_flush_stop ();
1410     gst_event_set_seqnum (tevent, seqnum);
1411     /* send flush stop, peer will accept data and events again. We
1412      * are not yet providing data as we still have the STREAM_LOCK. */
1413     gst_pad_push_event (src->srcpad, tevent);
1414   } else if (res && src->data.ABI.running) {
1415     /* we are running the current segment and doing a non-flushing seek,
1416      * close the segment first based on the last_stop. */
1417     GST_DEBUG_OBJECT (src, "closing running segment %" G_GINT64_FORMAT
1418         " to %" G_GINT64_FORMAT, src->segment.start, src->segment.last_stop);
1419
1420     /* queue the segment for sending in the stream thread */
1421     if (src->priv->close_segment)
1422       gst_event_unref (src->priv->close_segment);
1423     src->priv->close_segment =
1424         gst_event_new_new_segment_full (TRUE,
1425         src->segment.rate, src->segment.applied_rate, src->segment.format,
1426         src->segment.start, src->segment.last_stop, src->segment.time);
1427     gst_event_set_seqnum (src->priv->close_segment, seqnum);
1428   }
1429
1430   /* The subclass must have converted the segment to the processing format
1431    * by now */
1432   if (res && seeksegment.format != dest_format) {
1433     GST_DEBUG_OBJECT (src, "Subclass failed to prepare a seek segment "
1434         "in the correct format. Aborting seek.");
1435     res = FALSE;
1436   }
1437
1438   /* if the seek was successful, we update our real segment and push
1439    * out the new segment. */
1440   if (res) {
1441     GST_OBJECT_LOCK (src);
1442     memcpy (&src->segment, &seeksegment, sizeof (GstSegment));
1443     GST_OBJECT_UNLOCK (src);
1444
1445     if (seeksegment.flags & GST_SEEK_FLAG_SEGMENT) {
1446       GstMessage *message;
1447
1448       message = gst_message_new_segment_start (GST_OBJECT (src),
1449           seeksegment.format, seeksegment.last_stop);
1450       gst_message_set_seqnum (message, seqnum);
1451
1452       gst_element_post_message (GST_ELEMENT (src), message);
1453     }
1454
1455     /* for deriving a stop position for the playback segment from the seek
1456      * segment, we must take the duration when the stop is not set */
1457     if ((stop = seeksegment.stop) == -1)
1458       stop = seeksegment.duration;
1459
1460     GST_DEBUG_OBJECT (src, "Sending newsegment from %" G_GINT64_FORMAT
1461         " to %" G_GINT64_FORMAT, seeksegment.start, stop);
1462
1463     /* now replace the old segment so that we send it in the stream thread the
1464      * next time it is scheduled. */
1465     if (src->priv->start_segment)
1466       gst_event_unref (src->priv->start_segment);
1467     if (seeksegment.rate >= 0.0) {
1468       /* forward, we send data from last_stop to stop */
1469       src->priv->start_segment =
1470           gst_event_new_new_segment_full (FALSE,
1471           seeksegment.rate, seeksegment.applied_rate, seeksegment.format,
1472           seeksegment.last_stop, stop, seeksegment.time);
1473     } else {
1474       /* reverse, we send data from last_stop to start */
1475       src->priv->start_segment =
1476           gst_event_new_new_segment_full (FALSE,
1477           seeksegment.rate, seeksegment.applied_rate, seeksegment.format,
1478           seeksegment.start, seeksegment.last_stop, seeksegment.time);
1479     }
1480     gst_event_set_seqnum (src->priv->start_segment, seqnum);
1481     src->priv->newsegment_pending = TRUE;
1482   }
1483
1484   src->priv->discont = TRUE;
1485   src->data.ABI.running = TRUE;
1486   /* and restart the task in case it got paused explicitly or by
1487    * the FLUSH_START event we pushed out. */
1488   tres = gst_pad_start_task (src->srcpad, (GstTaskFunction) gst_base_src_loop,
1489       src->srcpad);
1490   if (res && !tres)
1491     res = FALSE;
1492
1493   /* and release the lock again so we can continue streaming */
1494   GST_PAD_STREAM_UNLOCK (src->srcpad);
1495
1496   return res;
1497
1498   /* ERROR */
1499 prepare_failed:
1500   GST_DEBUG_OBJECT (src, "Preparing the seek failed before flushing. "
1501       "Aborting seek");
1502   return FALSE;
1503 }
1504
1505 static const GstQueryType *
1506 gst_base_src_get_query_types (GstElement * element)
1507 {
1508   static const GstQueryType query_types[] = {
1509     GST_QUERY_DURATION,
1510     GST_QUERY_POSITION,
1511     GST_QUERY_SEEKING,
1512     GST_QUERY_SEGMENT,
1513     GST_QUERY_FORMATS,
1514     GST_QUERY_LATENCY,
1515     GST_QUERY_JITTER,
1516     GST_QUERY_RATE,
1517     GST_QUERY_CONVERT,
1518     0
1519   };
1520
1521   return query_types;
1522 }
1523
1524 /* all events send to this element directly. This is mainly done from the
1525  * application.
1526  */
1527 static gboolean
1528 gst_base_src_send_event (GstElement * element, GstEvent * event)
1529 {
1530   GstBaseSrc *src;
1531   gboolean result = FALSE;
1532
1533   src = GST_BASE_SRC (element);
1534
1535   GST_DEBUG_OBJECT (src, "handling event %p %" GST_PTR_FORMAT, event, event);
1536
1537   switch (GST_EVENT_TYPE (event)) {
1538       /* bidirectional events */
1539     case GST_EVENT_FLUSH_START:
1540     case GST_EVENT_FLUSH_STOP:
1541       /* sending random flushes downstream can break stuff,
1542        * especially sync since all segment info will get flushed */
1543       break;
1544
1545       /* downstream serialized events */
1546     case GST_EVENT_EOS:
1547     {
1548       GstBaseSrcClass *bclass;
1549
1550       bclass = GST_BASE_SRC_GET_CLASS (src);
1551
1552       /* queue EOS and make sure the task or pull function performs the EOS
1553        * actions.
1554        *
1555        * We have two possibilities:
1556        *
1557        *  - Before we are to enter the _create function, we check the pending_eos
1558        *    first and do EOS instead of entering it.
1559        *  - If we are in the _create function or we did not manage to set the
1560        *    flag fast enough and we are about to enter the _create function,
1561        *    we unlock it so that we exit with WRONG_STATE immediatly. We then
1562        *    check the EOS flag and do the EOS logic.
1563        */
1564       g_atomic_int_set (&src->priv->pending_eos, TRUE);
1565       GST_DEBUG_OBJECT (src, "EOS marked, calling unlock");
1566
1567       /* unlock the _create function so that we can check the pending_eos flag
1568        * and we can do EOS. This will eventually release the LIVE_LOCK again so
1569        * that we can grab it and stop the unlock again. We don't take the stream
1570        * lock so that this operation is guaranteed to never block. */
1571       if (bclass->unlock)
1572         bclass->unlock (src);
1573
1574       GST_DEBUG_OBJECT (src, "unlock called, waiting for LIVE_LOCK");
1575
1576       GST_LIVE_LOCK (src);
1577       GST_DEBUG_OBJECT (src, "LIVE_LOCK acquired, calling unlock_stop");
1578       /* now stop the unlock of the streaming thread again. Grabbing the live
1579        * lock is enough because that protects the create function. */
1580       if (bclass->unlock_stop)
1581         bclass->unlock_stop (src);
1582       GST_LIVE_UNLOCK (src);
1583
1584       result = TRUE;
1585       break;
1586     }
1587     case GST_EVENT_NEWSEGMENT:
1588       /* sending random NEWSEGMENT downstream can break sync. */
1589       break;
1590     case GST_EVENT_TAG:
1591     case GST_EVENT_CUSTOM_DOWNSTREAM:
1592     case GST_EVENT_CUSTOM_BOTH:
1593       /* Insert TAG, CUSTOM_DOWNSTREAM, CUSTOM_BOTH in the dataflow */
1594       GST_OBJECT_LOCK (src);
1595       src->priv->pending_events =
1596           g_list_append (src->priv->pending_events, event);
1597       g_atomic_int_set (&src->priv->have_events, TRUE);
1598       GST_OBJECT_UNLOCK (src);
1599       event = NULL;
1600       result = TRUE;
1601       break;
1602     case GST_EVENT_BUFFERSIZE:
1603       /* does not seem to make much sense currently */
1604       break;
1605
1606       /* upstream events */
1607     case GST_EVENT_QOS:
1608       /* elements should override send_event and do something */
1609       break;
1610     case GST_EVENT_SEEK:
1611     {
1612       gboolean started;
1613
1614       GST_OBJECT_LOCK (src->srcpad);
1615       if (GST_PAD_ACTIVATE_MODE (src->srcpad) == GST_ACTIVATE_PULL)
1616         goto wrong_mode;
1617       started = GST_PAD_ACTIVATE_MODE (src->srcpad) == GST_ACTIVATE_PUSH;
1618       GST_OBJECT_UNLOCK (src->srcpad);
1619
1620       if (started) {
1621         GST_DEBUG_OBJECT (src, "performing seek");
1622         /* when we are running in push mode, we can execute the
1623          * seek right now, we need to unlock. */
1624         result = gst_base_src_perform_seek (src, event, TRUE);
1625       } else {
1626         GstEvent **event_p;
1627
1628         /* else we store the event and execute the seek when we
1629          * get activated */
1630         GST_OBJECT_LOCK (src);
1631         GST_DEBUG_OBJECT (src, "queueing seek");
1632         event_p = &src->data.ABI.pending_seek;
1633         gst_event_replace ((GstEvent **) event_p, event);
1634         GST_OBJECT_UNLOCK (src);
1635         /* assume the seek will work */
1636         result = TRUE;
1637       }
1638       break;
1639     }
1640     case GST_EVENT_NAVIGATION:
1641       /* could make sense for elements that do something with navigation events
1642        * but then they would need to override the send_event function */
1643       break;
1644     case GST_EVENT_LATENCY:
1645       /* does not seem to make sense currently */
1646       break;
1647
1648       /* custom events */
1649     case GST_EVENT_CUSTOM_UPSTREAM:
1650       /* override send_event if you want this */
1651       break;
1652     case GST_EVENT_CUSTOM_DOWNSTREAM_OOB:
1653     case GST_EVENT_CUSTOM_BOTH_OOB:
1654       /* insert a random custom event into the pipeline */
1655       GST_DEBUG_OBJECT (src, "pushing custom OOB event downstream");
1656       result = gst_pad_push_event (src->srcpad, event);
1657       /* we gave away the ref to the event in the push */
1658       event = NULL;
1659       break;
1660     default:
1661       break;
1662   }
1663 done:
1664   /* if we still have a ref to the event, unref it now */
1665   if (event)
1666     gst_event_unref (event);
1667
1668   return result;
1669
1670   /* ERRORS */
1671 wrong_mode:
1672   {
1673     GST_DEBUG_OBJECT (src, "cannot perform seek when operating in pull mode");
1674     GST_OBJECT_UNLOCK (src->srcpad);
1675     result = FALSE;
1676     goto done;
1677   }
1678 }
1679
1680 static gboolean
1681 gst_base_src_seekable (GstBaseSrc * src)
1682 {
1683   GstBaseSrcClass *bclass;
1684   bclass = GST_BASE_SRC_GET_CLASS (src);
1685   if (bclass->is_seekable)
1686     return bclass->is_seekable (src);
1687   else
1688     return FALSE;
1689 }
1690
1691 static void
1692 gst_base_src_update_qos (GstBaseSrc * src,
1693     gdouble proportion, GstClockTimeDiff diff, GstClockTime timestamp)
1694 {
1695   GST_CAT_DEBUG_OBJECT (GST_CAT_QOS, src,
1696       "qos: proportion: %lf, diff %" G_GINT64_FORMAT ", timestamp %"
1697       GST_TIME_FORMAT, proportion, diff, GST_TIME_ARGS (timestamp));
1698
1699   GST_OBJECT_LOCK (src);
1700   src->priv->proportion = proportion;
1701   src->priv->earliest_time = timestamp + diff;
1702   GST_OBJECT_UNLOCK (src);
1703 }
1704
1705
1706 static gboolean
1707 gst_base_src_default_event (GstBaseSrc * src, GstEvent * event)
1708 {
1709   gboolean result;
1710
1711   GST_DEBUG_OBJECT (src, "handle event %" GST_PTR_FORMAT, event);
1712
1713   switch (GST_EVENT_TYPE (event)) {
1714     case GST_EVENT_SEEK:
1715       /* is normally called when in push mode */
1716       if (!gst_base_src_seekable (src))
1717         goto not_seekable;
1718
1719       result = gst_base_src_perform_seek (src, event, TRUE);
1720       break;
1721     case GST_EVENT_FLUSH_START:
1722       /* cancel any blocking getrange, is normally called
1723        * when in pull mode. */
1724       result = gst_base_src_set_flushing (src, TRUE, FALSE, TRUE, NULL);
1725       break;
1726     case GST_EVENT_FLUSH_STOP:
1727       result = gst_base_src_set_flushing (src, FALSE, TRUE, TRUE, NULL);
1728       break;
1729     case GST_EVENT_QOS:
1730     {
1731       gdouble proportion;
1732       GstClockTimeDiff diff;
1733       GstClockTime timestamp;
1734
1735       gst_event_parse_qos (event, &proportion, &diff, &timestamp);
1736       gst_base_src_update_qos (src, proportion, diff, timestamp);
1737       result = TRUE;
1738       break;
1739     }
1740     default:
1741       result = FALSE;
1742       break;
1743   }
1744   return result;
1745
1746   /* ERRORS */
1747 not_seekable:
1748   {
1749     GST_DEBUG_OBJECT (src, "is not seekable");
1750     return FALSE;
1751   }
1752 }
1753
1754 static gboolean
1755 gst_base_src_event_handler (GstPad * pad, GstEvent * event)
1756 {
1757   GstBaseSrc *src;
1758   GstBaseSrcClass *bclass;
1759   gboolean result = FALSE;
1760
1761   src = GST_BASE_SRC (gst_pad_get_parent (pad));
1762   if (G_UNLIKELY (src == NULL))
1763     return FALSE;
1764   bclass = GST_BASE_SRC_GET_CLASS (src);
1765
1766   if (bclass->event) {
1767     if (!(result = bclass->event (src, event)))
1768       goto subclass_failed;
1769   }
1770
1771 done:
1772   gst_event_unref (event);
1773   gst_object_unref (src);
1774
1775   return result;
1776
1777   /* ERRORS */
1778 subclass_failed:
1779   {
1780     GST_DEBUG_OBJECT (src, "subclass refused event");
1781     goto done;
1782   }
1783 }
1784
1785 static void
1786 gst_base_src_set_property (GObject * object, guint prop_id,
1787     const GValue * value, GParamSpec * pspec)
1788 {
1789   GstBaseSrc *src;
1790
1791   src = GST_BASE_SRC (object);
1792
1793   switch (prop_id) {
1794     case PROP_BLOCKSIZE:
1795       gst_base_src_set_blocksize (src, g_value_get_ulong (value));
1796       break;
1797     case PROP_NUM_BUFFERS:
1798       src->num_buffers = g_value_get_int (value);
1799       break;
1800     case PROP_TYPEFIND:
1801       src->data.ABI.typefind = g_value_get_boolean (value);
1802       break;
1803     case PROP_DO_TIMESTAMP:
1804       gst_base_src_set_do_timestamp (src, g_value_get_boolean (value));
1805       break;
1806     default:
1807       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1808       break;
1809   }
1810 }
1811
1812 static void
1813 gst_base_src_get_property (GObject * object, guint prop_id, GValue * value,
1814     GParamSpec * pspec)
1815 {
1816   GstBaseSrc *src;
1817
1818   src = GST_BASE_SRC (object);
1819
1820   switch (prop_id) {
1821     case PROP_BLOCKSIZE:
1822       g_value_set_ulong (value, gst_base_src_get_blocksize (src));
1823       break;
1824     case PROP_NUM_BUFFERS:
1825       g_value_set_int (value, src->num_buffers);
1826       break;
1827     case PROP_TYPEFIND:
1828       g_value_set_boolean (value, src->data.ABI.typefind);
1829       break;
1830     case PROP_DO_TIMESTAMP:
1831       g_value_set_boolean (value, gst_base_src_get_do_timestamp (src));
1832       break;
1833     default:
1834       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1835       break;
1836   }
1837 }
1838
1839 /* with STREAM_LOCK and LOCK */
1840 static GstClockReturn
1841 gst_base_src_wait (GstBaseSrc * basesrc, GstClock * clock, GstClockTime time)
1842 {
1843   GstClockReturn ret;
1844   GstClockID id;
1845
1846   id = gst_clock_new_single_shot_id (clock, time);
1847
1848   basesrc->clock_id = id;
1849   /* release the live lock while waiting */
1850   GST_LIVE_UNLOCK (basesrc);
1851
1852   ret = gst_clock_id_wait (id, NULL);
1853
1854   GST_LIVE_LOCK (basesrc);
1855   gst_clock_id_unref (id);
1856   basesrc->clock_id = NULL;
1857
1858   return ret;
1859 }
1860
1861 /* perform synchronisation on a buffer.
1862  * with STREAM_LOCK.
1863  */
1864 static GstClockReturn
1865 gst_base_src_do_sync (GstBaseSrc * basesrc, GstBuffer * buffer)
1866 {
1867   GstClockReturn result;
1868   GstClockTime start, end;
1869   GstBaseSrcClass *bclass;
1870   GstClockTime base_time;
1871   GstClock *clock;
1872   GstClockTime now = GST_CLOCK_TIME_NONE, timestamp;
1873   gboolean do_timestamp, first, pseudo_live;
1874
1875   bclass = GST_BASE_SRC_GET_CLASS (basesrc);
1876
1877   start = end = -1;
1878   if (bclass->get_times)
1879     bclass->get_times (basesrc, buffer, &start, &end);
1880
1881   /* get buffer timestamp */
1882   timestamp = GST_BUFFER_TIMESTAMP (buffer);
1883
1884   /* grab the lock to prepare for clocking and calculate the startup
1885    * latency. */
1886   GST_OBJECT_LOCK (basesrc);
1887
1888   /* if we are asked to sync against the clock we are a pseudo live element */
1889   pseudo_live = (start != -1 && basesrc->is_live);
1890   /* check for the first buffer */
1891   first = (basesrc->priv->latency == -1);
1892
1893   if (timestamp != -1 && pseudo_live) {
1894     GstClockTime latency;
1895
1896     /* we have a timestamp and a sync time, latency is the diff */
1897     if (timestamp <= start)
1898       latency = start - timestamp;
1899     else
1900       latency = 0;
1901
1902     if (first) {
1903       GST_DEBUG_OBJECT (basesrc, "pseudo_live with latency %" GST_TIME_FORMAT,
1904           GST_TIME_ARGS (latency));
1905       /* first time we calculate latency, just configure */
1906       basesrc->priv->latency = latency;
1907     } else {
1908       if (basesrc->priv->latency != latency) {
1909         /* we have a new latency, FIXME post latency message */
1910         basesrc->priv->latency = latency;
1911         GST_DEBUG_OBJECT (basesrc, "latency changed to %" GST_TIME_FORMAT,
1912             GST_TIME_ARGS (latency));
1913       }
1914     }
1915   } else if (first) {
1916     GST_DEBUG_OBJECT (basesrc, "no latency needed, live %d, sync %d",
1917         basesrc->is_live, start != -1);
1918     basesrc->priv->latency = 0;
1919   }
1920
1921   /* get clock, if no clock, we can't sync or do timestamps */
1922   if ((clock = GST_ELEMENT_CLOCK (basesrc)) == NULL)
1923     goto no_clock;
1924
1925   base_time = GST_ELEMENT_CAST (basesrc)->base_time;
1926
1927   do_timestamp = basesrc->priv->do_timestamp;
1928
1929   /* first buffer, calculate the timestamp offset */
1930   if (first) {
1931     GstClockTime running_time;
1932
1933     now = gst_clock_get_time (clock);
1934     running_time = now - base_time;
1935
1936     GST_LOG_OBJECT (basesrc,
1937         "startup timestamp: %" GST_TIME_FORMAT ", running_time %"
1938         GST_TIME_FORMAT, GST_TIME_ARGS (timestamp),
1939         GST_TIME_ARGS (running_time));
1940
1941     if (pseudo_live && timestamp != -1) {
1942       /* live source and we need to sync, add startup latency to all timestamps
1943        * to get the real running_time. Live sources should always timestamp
1944        * according to the current running time. */
1945       basesrc->priv->ts_offset = GST_CLOCK_DIFF (timestamp, running_time);
1946
1947       GST_LOG_OBJECT (basesrc, "live with sync, ts_offset %" GST_TIME_FORMAT,
1948           GST_TIME_ARGS (basesrc->priv->ts_offset));
1949     } else {
1950       basesrc->priv->ts_offset = 0;
1951       GST_LOG_OBJECT (basesrc, "no timestamp offset needed");
1952     }
1953
1954     if (!GST_CLOCK_TIME_IS_VALID (timestamp)) {
1955       if (do_timestamp)
1956         timestamp = running_time;
1957       else
1958         timestamp = 0;
1959
1960       GST_BUFFER_TIMESTAMP (buffer) = timestamp;
1961
1962       GST_LOG_OBJECT (basesrc, "created timestamp: %" GST_TIME_FORMAT,
1963           GST_TIME_ARGS (timestamp));
1964     }
1965
1966     /* add the timestamp offset we need for sync */
1967     timestamp += basesrc->priv->ts_offset;
1968   } else {
1969     /* not the first buffer, the timestamp is the diff between the clock and
1970      * base_time */
1971     if (do_timestamp && !GST_CLOCK_TIME_IS_VALID (timestamp)) {
1972       now = gst_clock_get_time (clock);
1973
1974       GST_BUFFER_TIMESTAMP (buffer) = now - base_time;
1975
1976       GST_LOG_OBJECT (basesrc, "created timestamp: %" GST_TIME_FORMAT,
1977           GST_TIME_ARGS (now - base_time));
1978     }
1979   }
1980
1981   /* if we don't have a buffer timestamp, we don't sync */
1982   if (!GST_CLOCK_TIME_IS_VALID (start))
1983     goto no_sync;
1984
1985   if (basesrc->is_live && GST_CLOCK_TIME_IS_VALID (timestamp)) {
1986     /* for pseudo live sources, add our ts_offset to the timestamp */
1987     GST_BUFFER_TIMESTAMP (buffer) += basesrc->priv->ts_offset;
1988     start += basesrc->priv->ts_offset;
1989   }
1990
1991   GST_LOG_OBJECT (basesrc,
1992       "waiting for clock, base time %" GST_TIME_FORMAT
1993       ", stream_start %" GST_TIME_FORMAT,
1994       GST_TIME_ARGS (base_time), GST_TIME_ARGS (start));
1995   GST_OBJECT_UNLOCK (basesrc);
1996
1997   result = gst_base_src_wait (basesrc, clock, start + base_time);
1998
1999   GST_LOG_OBJECT (basesrc, "clock entry done: %d", result);
2000
2001   return result;
2002
2003   /* special cases */
2004 no_clock:
2005   {
2006     GST_DEBUG_OBJECT (basesrc, "we have no clock");
2007     GST_OBJECT_UNLOCK (basesrc);
2008     return GST_CLOCK_OK;
2009   }
2010 no_sync:
2011   {
2012     GST_DEBUG_OBJECT (basesrc, "no sync needed");
2013     GST_OBJECT_UNLOCK (basesrc);
2014     return GST_CLOCK_OK;
2015   }
2016 }
2017
2018 /* Called with STREAM_LOCK and LIVE_LOCK */
2019 static gboolean
2020 gst_base_src_update_length (GstBaseSrc * src, guint64 offset, guint * length)
2021 {
2022   guint64 size, maxsize;
2023   GstBaseSrcClass *bclass;
2024   GstFormat format;
2025   gint64 stop;
2026
2027   bclass = GST_BASE_SRC_GET_CLASS (src);
2028
2029   format = src->segment.format;
2030   stop = src->segment.stop;
2031   /* get total file size */
2032   size = (guint64) src->segment.duration;
2033
2034   /* only operate if we are working with bytes */
2035   if (format != GST_FORMAT_BYTES)
2036     return TRUE;
2037
2038   /* the max amount of bytes to read is the total size or
2039    * up to the segment.stop if present. */
2040   if (stop != -1)
2041     maxsize = MIN (size, stop);
2042   else
2043     maxsize = size;
2044
2045   GST_DEBUG_OBJECT (src,
2046       "reading offset %" G_GUINT64_FORMAT ", length %u, size %" G_GINT64_FORMAT
2047       ", segment.stop %" G_GINT64_FORMAT ", maxsize %" G_GINT64_FORMAT, offset,
2048       *length, size, stop, maxsize);
2049
2050   /* check size if we have one */
2051   if (maxsize != -1) {
2052     /* if we run past the end, check if the file became bigger and
2053      * retry. */
2054     if (G_UNLIKELY (offset + *length >= maxsize)) {
2055       /* see if length of the file changed */
2056       if (bclass->get_size)
2057         if (!bclass->get_size (src, &size))
2058           size = -1;
2059
2060       /* make sure we don't exceed the configured segment stop
2061        * if it was set */
2062       if (stop != -1)
2063         maxsize = MIN (size, stop);
2064       else
2065         maxsize = size;
2066
2067       /* if we are at or past the end, EOS */
2068       if (G_UNLIKELY (offset >= maxsize))
2069         goto unexpected_length;
2070
2071       /* else we can clip to the end */
2072       if (G_UNLIKELY (offset + *length >= maxsize))
2073         *length = maxsize - offset;
2074
2075     }
2076   }
2077
2078   /* keep track of current position and update duration.
2079    * segment is in bytes, we checked that above. */
2080   GST_OBJECT_LOCK (src);
2081   gst_segment_set_duration (&src->segment, GST_FORMAT_BYTES, size);
2082   gst_segment_set_last_stop (&src->segment, GST_FORMAT_BYTES, offset);
2083   GST_OBJECT_UNLOCK (src);
2084
2085   return TRUE;
2086
2087   /* ERRORS */
2088 unexpected_length:
2089   {
2090     return FALSE;
2091   }
2092 }
2093
2094 /* must be called with LIVE_LOCK */
2095 static GstFlowReturn
2096 gst_base_src_get_range (GstBaseSrc * src, guint64 offset, guint length,
2097     GstBuffer ** buf)
2098 {
2099   GstFlowReturn ret;
2100   GstBaseSrcClass *bclass;
2101   GstClockReturn status;
2102
2103   bclass = GST_BASE_SRC_GET_CLASS (src);
2104
2105 again:
2106   if (src->is_live) {
2107     if (G_UNLIKELY (!src->live_running)) {
2108       ret = gst_base_src_wait_playing (src);
2109       if (ret != GST_FLOW_OK)
2110         goto stopped;
2111     }
2112   }
2113
2114   if (G_UNLIKELY (!GST_OBJECT_FLAG_IS_SET (src, GST_BASE_SRC_STARTED)))
2115     goto not_started;
2116
2117   if (G_UNLIKELY (!bclass->create))
2118     goto no_function;
2119
2120   if (G_UNLIKELY (!gst_base_src_update_length (src, offset, &length)))
2121     goto unexpected_length;
2122
2123   /* normally we don't count buffers */
2124   if (G_UNLIKELY (src->num_buffers_left >= 0)) {
2125     if (src->num_buffers_left == 0)
2126       goto reached_num_buffers;
2127     else
2128       src->num_buffers_left--;
2129   }
2130
2131   /* don't enter the create function if a pending EOS event was set. For the
2132    * logic of the pending_eos, check the event function of this class. */
2133   if (G_UNLIKELY (g_atomic_int_get (&src->priv->pending_eos)))
2134     goto eos;
2135
2136   GST_DEBUG_OBJECT (src,
2137       "calling create offset %" G_GUINT64_FORMAT " length %u, time %"
2138       G_GINT64_FORMAT, offset, length, src->segment.time);
2139
2140   ret = bclass->create (src, offset, length, buf);
2141
2142   /* The create function could be unlocked because we have a pending EOS. It's
2143    * possible that we have a valid buffer from create that we need to
2144    * discard when the create function returned _OK. */
2145   if (G_UNLIKELY (g_atomic_int_get (&src->priv->pending_eos))) {
2146     if (ret == GST_FLOW_OK) {
2147       gst_buffer_unref (*buf);
2148       *buf = NULL;
2149     }
2150     goto eos;
2151   }
2152
2153   if (G_UNLIKELY (ret != GST_FLOW_OK))
2154     goto not_ok;
2155
2156   /* no timestamp set and we are at offset 0, we can timestamp with 0 */
2157   if (offset == 0 && src->segment.time == 0
2158       && GST_BUFFER_TIMESTAMP (*buf) == -1) {
2159     *buf = gst_buffer_make_metadata_writable (*buf);
2160     GST_BUFFER_TIMESTAMP (*buf) = 0;
2161   }
2162
2163   /* set pad caps on the buffer if the buffer had no caps */
2164   if (GST_BUFFER_CAPS (*buf) == NULL) {
2165     *buf = gst_buffer_make_metadata_writable (*buf);
2166     gst_buffer_set_caps (*buf, GST_PAD_CAPS (src->srcpad));
2167   }
2168
2169   /* now sync before pushing the buffer */
2170   status = gst_base_src_do_sync (src, *buf);
2171
2172   /* waiting for the clock could have made us flushing */
2173   if (G_UNLIKELY (src->priv->flushing))
2174     goto flushing;
2175
2176   switch (status) {
2177     case GST_CLOCK_EARLY:
2178       /* the buffer is too late. We currently don't drop the buffer. */
2179       GST_DEBUG_OBJECT (src, "buffer too late!, returning anyway");
2180       break;
2181     case GST_CLOCK_OK:
2182       /* buffer synchronised properly */
2183       GST_DEBUG_OBJECT (src, "buffer ok");
2184       break;
2185     case GST_CLOCK_UNSCHEDULED:
2186       /* this case is triggered when we were waiting for the clock and
2187        * it got unlocked because we did a state change. In any case, get rid of
2188        * the buffer. */
2189       gst_buffer_unref (*buf);
2190       *buf = NULL;
2191       if (!src->live_running) {
2192         /* We return WRONG_STATE when we are not running to stop the dataflow also
2193          * get rid of the produced buffer. */
2194         GST_DEBUG_OBJECT (src,
2195             "clock was unscheduled (%d), returning WRONG_STATE", status);
2196         ret = GST_FLOW_WRONG_STATE;
2197       } else {
2198         /* If we are running when this happens, we quickly switched between
2199          * pause and playing. We try to produce a new buffer */
2200         GST_DEBUG_OBJECT (src,
2201             "clock was unscheduled (%d), but we are running", status);
2202         goto again;
2203       }
2204       break;
2205     default:
2206       /* all other result values are unexpected and errors */
2207       GST_ELEMENT_ERROR (src, CORE, CLOCK,
2208           (_("Internal clock error.")),
2209           ("clock returned unexpected return value %d", status));
2210       gst_buffer_unref (*buf);
2211       *buf = NULL;
2212       ret = GST_FLOW_ERROR;
2213       break;
2214   }
2215   return ret;
2216
2217   /* ERROR */
2218 stopped:
2219   {
2220     GST_DEBUG_OBJECT (src, "wait_playing returned %d (%s)", ret,
2221         gst_flow_get_name (ret));
2222     return ret;
2223   }
2224 not_ok:
2225   {
2226     GST_DEBUG_OBJECT (src, "create returned %d (%s)", ret,
2227         gst_flow_get_name (ret));
2228     return ret;
2229   }
2230 not_started:
2231   {
2232     GST_DEBUG_OBJECT (src, "getrange but not started");
2233     return GST_FLOW_WRONG_STATE;
2234   }
2235 no_function:
2236   {
2237     GST_DEBUG_OBJECT (src, "no create function");
2238     return GST_FLOW_ERROR;
2239   }
2240 unexpected_length:
2241   {
2242     GST_DEBUG_OBJECT (src, "unexpected length %u (offset=%" G_GUINT64_FORMAT
2243         ", size=%" G_GINT64_FORMAT ")", length, offset, src->segment.duration);
2244     return GST_FLOW_UNEXPECTED;
2245   }
2246 reached_num_buffers:
2247   {
2248     GST_DEBUG_OBJECT (src, "sent all buffers");
2249     return GST_FLOW_UNEXPECTED;
2250   }
2251 flushing:
2252   {
2253     GST_DEBUG_OBJECT (src, "we are flushing");
2254     gst_buffer_unref (*buf);
2255     *buf = NULL;
2256     return GST_FLOW_WRONG_STATE;
2257   }
2258 eos:
2259   {
2260     GST_DEBUG_OBJECT (src, "we are EOS");
2261     return GST_FLOW_UNEXPECTED;
2262   }
2263 }
2264
2265 static GstFlowReturn
2266 gst_base_src_pad_get_range (GstPad * pad, guint64 offset, guint length,
2267     GstBuffer ** buf)
2268 {
2269   GstBaseSrc *src;
2270   GstFlowReturn res;
2271
2272   src = GST_BASE_SRC_CAST (gst_object_ref (GST_OBJECT_PARENT (pad)));
2273
2274   GST_LIVE_LOCK (src);
2275   if (G_UNLIKELY (src->priv->flushing))
2276     goto flushing;
2277
2278   res = gst_base_src_get_range (src, offset, length, buf);
2279
2280 done:
2281   GST_LIVE_UNLOCK (src);
2282
2283   gst_object_unref (src);
2284
2285   return res;
2286
2287   /* ERRORS */
2288 flushing:
2289   {
2290     GST_DEBUG_OBJECT (src, "we are flushing");
2291     res = GST_FLOW_WRONG_STATE;
2292     goto done;
2293   }
2294 }
2295
2296 static gboolean
2297 gst_base_src_default_check_get_range (GstBaseSrc * src)
2298 {
2299   gboolean res;
2300
2301   if (!GST_OBJECT_FLAG_IS_SET (src, GST_BASE_SRC_STARTED)) {
2302     GST_LOG_OBJECT (src, "doing start/stop to check get_range support");
2303     if (G_LIKELY (gst_base_src_start (src)))
2304       gst_base_src_stop (src);
2305   }
2306
2307   /* we can operate in getrange mode if the native format is bytes
2308    * and we are seekable, this condition is set in the random_access
2309    * flag and is set in the _start() method. */
2310   res = src->random_access;
2311
2312   return res;
2313 }
2314
2315 static gboolean
2316 gst_base_src_check_get_range (GstBaseSrc * src)
2317 {
2318   GstBaseSrcClass *bclass;
2319   gboolean res;
2320
2321   bclass = GST_BASE_SRC_GET_CLASS (src);
2322
2323   if (bclass->check_get_range == NULL)
2324     goto no_function;
2325
2326   res = bclass->check_get_range (src);
2327   GST_LOG_OBJECT (src, "%s() returned %d",
2328       GST_DEBUG_FUNCPTR_NAME (bclass->check_get_range), (gint) res);
2329
2330   return res;
2331
2332   /* ERRORS */
2333 no_function:
2334   {
2335     GST_WARNING_OBJECT (src, "no check_get_range function set");
2336     return FALSE;
2337   }
2338 }
2339
2340 static gboolean
2341 gst_base_src_pad_check_get_range (GstPad * pad)
2342 {
2343   GstBaseSrc *src;
2344   gboolean res;
2345
2346   src = GST_BASE_SRC (GST_OBJECT_PARENT (pad));
2347
2348   res = gst_base_src_check_get_range (src);
2349
2350   return res;
2351 }
2352
2353 static void
2354 gst_base_src_loop (GstPad * pad)
2355 {
2356   GstBaseSrc *src;
2357   GstBuffer *buf = NULL;
2358   GstFlowReturn ret;
2359   gint64 position;
2360   gboolean eos;
2361   gulong blocksize;
2362   GList *pending_events = NULL, *tmp;
2363
2364   eos = FALSE;
2365
2366   src = GST_BASE_SRC (GST_OBJECT_PARENT (pad));
2367
2368   GST_LIVE_LOCK (src);
2369
2370   if (G_UNLIKELY (src->priv->flushing))
2371     goto flushing;
2372
2373   src->priv->last_sent_eos = FALSE;
2374
2375   blocksize = src->blocksize;
2376
2377   /* if we operate in bytes, we can calculate an offset */
2378   if (src->segment.format == GST_FORMAT_BYTES) {
2379     position = src->segment.last_stop;
2380     /* for negative rates, start with subtracting the blocksize */
2381     if (src->segment.rate < 0.0) {
2382       /* we cannot go below segment.start */
2383       if (position > src->segment.start + blocksize)
2384         position -= blocksize;
2385       else {
2386         /* last block, remainder up to segment.start */
2387         blocksize = position - src->segment.start;
2388         position = src->segment.start;
2389       }
2390     }
2391   } else
2392     position = -1;
2393
2394   GST_LOG_OBJECT (src, "next_ts %" GST_TIME_FORMAT " size %lu",
2395       GST_TIME_ARGS (position), blocksize);
2396
2397   ret = gst_base_src_get_range (src, position, blocksize, &buf);
2398   if (G_UNLIKELY (ret != GST_FLOW_OK)) {
2399     GST_INFO_OBJECT (src, "pausing after gst_base_src_get_range() = %s",
2400         gst_flow_get_name (ret));
2401     GST_LIVE_UNLOCK (src);
2402     goto pause;
2403   }
2404   /* this should not happen */
2405   if (G_UNLIKELY (buf == NULL))
2406     goto null_buffer;
2407
2408   /* push events to close/start our segment before we push the buffer. */
2409   if (G_UNLIKELY (src->priv->close_segment)) {
2410     gst_pad_push_event (pad, src->priv->close_segment);
2411     src->priv->close_segment = NULL;
2412   }
2413   if (G_UNLIKELY (src->priv->start_segment)) {
2414     gst_pad_push_event (pad, src->priv->start_segment);
2415     src->priv->start_segment = NULL;
2416   }
2417   src->priv->newsegment_pending = FALSE;
2418
2419   if (g_atomic_int_get (&src->priv->have_events)) {
2420     GST_OBJECT_LOCK (src);
2421     /* take the events */
2422     pending_events = src->priv->pending_events;
2423     src->priv->pending_events = NULL;
2424     g_atomic_int_set (&src->priv->have_events, FALSE);
2425     GST_OBJECT_UNLOCK (src);
2426   }
2427
2428   /* Push out pending events if any */
2429   if (G_UNLIKELY (pending_events != NULL)) {
2430     for (tmp = pending_events; tmp; tmp = g_list_next (tmp)) {
2431       GstEvent *ev = (GstEvent *) tmp->data;
2432       gst_pad_push_event (pad, ev);
2433     }
2434     g_list_free (pending_events);
2435   }
2436
2437   /* figure out the new position */
2438   switch (src->segment.format) {
2439     case GST_FORMAT_BYTES:
2440     {
2441       guint bufsize = GST_BUFFER_SIZE (buf);
2442
2443       /* we subtracted above for negative rates */
2444       if (src->segment.rate >= 0.0)
2445         position += bufsize;
2446       break;
2447     }
2448     case GST_FORMAT_TIME:
2449     {
2450       GstClockTime start, duration;
2451
2452       start = GST_BUFFER_TIMESTAMP (buf);
2453       duration = GST_BUFFER_DURATION (buf);
2454
2455       if (GST_CLOCK_TIME_IS_VALID (start))
2456         position = start;
2457       else
2458         position = src->segment.last_stop;
2459
2460       if (GST_CLOCK_TIME_IS_VALID (duration)) {
2461         if (src->segment.rate >= 0.0)
2462           position += duration;
2463         else if (position > duration)
2464           position -= duration;
2465         else
2466           position = 0;
2467       }
2468       break;
2469     }
2470     case GST_FORMAT_DEFAULT:
2471       if (src->segment.rate >= 0.0)
2472         position = GST_BUFFER_OFFSET_END (buf);
2473       else
2474         position = GST_BUFFER_OFFSET (buf);
2475       break;
2476     default:
2477       position = -1;
2478       break;
2479   }
2480   if (position != -1) {
2481     if (src->segment.rate >= 0.0) {
2482       /* positive rate, check if we reached the stop */
2483       if (src->segment.stop != -1) {
2484         if (position >= src->segment.stop) {
2485           eos = TRUE;
2486           position = src->segment.stop;
2487         }
2488       }
2489     } else {
2490       /* negative rate, check if we reached the start. start is always set to
2491        * something different from -1 */
2492       if (position <= src->segment.start) {
2493         eos = TRUE;
2494         position = src->segment.start;
2495       }
2496       /* when going reverse, all buffers are DISCONT */
2497       src->priv->discont = TRUE;
2498     }
2499     GST_OBJECT_LOCK (src);
2500     gst_segment_set_last_stop (&src->segment, src->segment.format, position);
2501     GST_OBJECT_UNLOCK (src);
2502   }
2503
2504   if (G_UNLIKELY (src->priv->discont)) {
2505     buf = gst_buffer_make_metadata_writable (buf);
2506     GST_BUFFER_FLAG_SET (buf, GST_BUFFER_FLAG_DISCONT);
2507     src->priv->discont = FALSE;
2508   }
2509   GST_LIVE_UNLOCK (src);
2510
2511   ret = gst_pad_push (pad, buf);
2512   if (G_UNLIKELY (ret != GST_FLOW_OK)) {
2513     GST_INFO_OBJECT (src, "pausing after gst_pad_push() = %s",
2514         gst_flow_get_name (ret));
2515     goto pause;
2516   }
2517
2518   if (G_UNLIKELY (eos)) {
2519     GST_INFO_OBJECT (src, "pausing after end of segment");
2520     ret = GST_FLOW_UNEXPECTED;
2521     goto pause;
2522   }
2523
2524 done:
2525   return;
2526
2527   /* special cases */
2528 flushing:
2529   {
2530     GST_DEBUG_OBJECT (src, "we are flushing");
2531     GST_LIVE_UNLOCK (src);
2532     ret = GST_FLOW_WRONG_STATE;
2533     goto pause;
2534   }
2535 pause:
2536   {
2537     const gchar *reason = gst_flow_get_name (ret);
2538     GstEvent *event;
2539
2540     GST_DEBUG_OBJECT (src, "pausing task, reason %s", reason);
2541     src->data.ABI.running = FALSE;
2542     gst_pad_pause_task (pad);
2543     if (ret == GST_FLOW_UNEXPECTED) {
2544       gboolean flag_segment;
2545       GstFormat format;
2546       gint64 last_stop;
2547
2548       /* perform EOS logic */
2549       flag_segment = (src->segment.flags & GST_SEEK_FLAG_SEGMENT) != 0;
2550       format = src->segment.format;
2551       last_stop = src->segment.last_stop;
2552
2553       if (flag_segment) {
2554         GstMessage *message;
2555
2556         message = gst_message_new_segment_done (GST_OBJECT_CAST (src),
2557             format, last_stop);
2558         gst_message_set_seqnum (message, src->priv->seqnum);
2559         gst_element_post_message (GST_ELEMENT_CAST (src), message);
2560       } else {
2561         event = gst_event_new_eos ();
2562         gst_event_set_seqnum (event, src->priv->seqnum);
2563         gst_pad_push_event (pad, event);
2564         src->priv->last_sent_eos = TRUE;
2565       }
2566     } else if (ret == GST_FLOW_NOT_LINKED || ret <= GST_FLOW_UNEXPECTED) {
2567       event = gst_event_new_eos ();
2568       gst_event_set_seqnum (event, src->priv->seqnum);
2569       /* for fatal errors we post an error message, post the error
2570        * first so the app knows about the error first.
2571        * Also don't do this for WRONG_STATE because it happens
2572        * due to flushing and posting an error message because of
2573        * that is the wrong thing to do, e.g. when we're doing
2574        * a flushing seek. */
2575       GST_ELEMENT_ERROR (src, STREAM, FAILED,
2576           (_("Internal data flow error.")),
2577           ("streaming task paused, reason %s (%d)", reason, ret));
2578       gst_pad_push_event (pad, event);
2579       src->priv->last_sent_eos = TRUE;
2580     }
2581     goto done;
2582   }
2583 null_buffer:
2584   {
2585     GST_ELEMENT_ERROR (src, STREAM, FAILED,
2586         (_("Internal data flow error.")), ("element returned NULL buffer"));
2587     GST_LIVE_UNLOCK (src);
2588     goto done;
2589   }
2590 }
2591
2592 /* default negotiation code.
2593  *
2594  * Take intersection between src and sink pads, take first
2595  * caps and fixate.
2596  */
2597 static gboolean
2598 gst_base_src_default_negotiate (GstBaseSrc * basesrc)
2599 {
2600   GstCaps *thiscaps;
2601   GstCaps *caps = NULL;
2602   GstCaps *peercaps = NULL;
2603   gboolean result = FALSE;
2604
2605   /* first see what is possible on our source pad */
2606   thiscaps = gst_pad_get_caps_reffed (GST_BASE_SRC_PAD (basesrc));
2607   GST_DEBUG_OBJECT (basesrc, "caps of src: %" GST_PTR_FORMAT, thiscaps);
2608   /* nothing or anything is allowed, we're done */
2609   if (thiscaps == NULL || gst_caps_is_any (thiscaps))
2610     goto no_nego_needed;
2611
2612   if (G_UNLIKELY (gst_caps_is_empty (thiscaps)))
2613     goto no_caps;
2614
2615   /* get the peer caps */
2616   peercaps = gst_pad_peer_get_caps_reffed (GST_BASE_SRC_PAD (basesrc));
2617   GST_DEBUG_OBJECT (basesrc, "caps of peer: %" GST_PTR_FORMAT, peercaps);
2618   if (peercaps) {
2619     /* get intersection */
2620     caps =
2621         gst_caps_intersect_full (peercaps, thiscaps, GST_CAPS_INTERSECT_FIRST);
2622     GST_DEBUG_OBJECT (basesrc, "intersect: %" GST_PTR_FORMAT, caps);
2623     gst_caps_unref (peercaps);
2624   } else {
2625     /* no peer, work with our own caps then */
2626     caps = gst_caps_copy (thiscaps);
2627   }
2628   gst_caps_unref (thiscaps);
2629   if (caps) {
2630     /* take first (and best, since they are sorted) possibility */
2631     gst_caps_truncate (caps);
2632
2633     /* now fixate */
2634     if (!gst_caps_is_empty (caps)) {
2635       gst_pad_fixate_caps (GST_BASE_SRC_PAD (basesrc), caps);
2636       GST_DEBUG_OBJECT (basesrc, "fixated to: %" GST_PTR_FORMAT, caps);
2637
2638       if (gst_caps_is_any (caps)) {
2639         /* hmm, still anything, so element can do anything and
2640          * nego is not needed */
2641         result = TRUE;
2642       } else if (gst_caps_is_fixed (caps)) {
2643         /* yay, fixed caps, use those then, it's possible that the subclass does
2644          * not accept this caps after all and we have to fail. */
2645         result = gst_pad_set_caps (GST_BASE_SRC_PAD (basesrc), caps);
2646       }
2647     }
2648     gst_caps_unref (caps);
2649   } else {
2650     GST_DEBUG_OBJECT (basesrc, "no common caps");
2651   }
2652   return result;
2653
2654 no_nego_needed:
2655   {
2656     GST_DEBUG_OBJECT (basesrc, "no negotiation needed");
2657     if (thiscaps)
2658       gst_caps_unref (thiscaps);
2659     return TRUE;
2660   }
2661 no_caps:
2662   {
2663     GST_ELEMENT_ERROR (basesrc, STREAM, FORMAT,
2664         ("No supported formats found"),
2665         ("This element did not produce valid caps"));
2666     if (thiscaps)
2667       gst_caps_unref (thiscaps);
2668     return TRUE;
2669   }
2670 }
2671
2672 static gboolean
2673 gst_base_src_negotiate (GstBaseSrc * basesrc)
2674 {
2675   GstBaseSrcClass *bclass;
2676   gboolean result = TRUE;
2677
2678   bclass = GST_BASE_SRC_GET_CLASS (basesrc);
2679
2680   if (bclass->negotiate)
2681     result = bclass->negotiate (basesrc);
2682
2683   return result;
2684 }
2685
2686 static gboolean
2687 gst_base_src_start (GstBaseSrc * basesrc)
2688 {
2689   GstBaseSrcClass *bclass;
2690   gboolean result;
2691   guint64 size;
2692   gboolean seekable;
2693   GstFormat format;
2694
2695   if (GST_OBJECT_FLAG_IS_SET (basesrc, GST_BASE_SRC_STARTED))
2696     return TRUE;
2697
2698   GST_DEBUG_OBJECT (basesrc, "starting source");
2699
2700   basesrc->num_buffers_left = basesrc->num_buffers;
2701
2702   GST_OBJECT_LOCK (basesrc);
2703   gst_segment_init (&basesrc->segment, basesrc->segment.format);
2704   GST_OBJECT_UNLOCK (basesrc);
2705
2706   basesrc->data.ABI.running = FALSE;
2707   basesrc->priv->newsegment_pending = FALSE;
2708
2709   bclass = GST_BASE_SRC_GET_CLASS (basesrc);
2710   if (bclass->start)
2711     result = bclass->start (basesrc);
2712   else
2713     result = TRUE;
2714
2715   if (!result)
2716     goto could_not_start;
2717
2718   GST_OBJECT_FLAG_SET (basesrc, GST_BASE_SRC_STARTED);
2719
2720   format = basesrc->segment.format;
2721
2722   /* figure out the size */
2723   if (format == GST_FORMAT_BYTES) {
2724     if (bclass->get_size) {
2725       if (!(result = bclass->get_size (basesrc, &size)))
2726         size = -1;
2727     } else {
2728       result = FALSE;
2729       size = -1;
2730     }
2731     GST_DEBUG_OBJECT (basesrc, "setting size %" G_GUINT64_FORMAT, size);
2732     /* only update the size when operating in bytes, subclass is supposed
2733      * to set duration in the start method for other formats */
2734     GST_OBJECT_LOCK (basesrc);
2735     gst_segment_set_duration (&basesrc->segment, GST_FORMAT_BYTES, size);
2736     GST_OBJECT_UNLOCK (basesrc);
2737   } else {
2738     size = -1;
2739   }
2740
2741   GST_DEBUG_OBJECT (basesrc,
2742       "format: %s, have size: %d, size: %" G_GUINT64_FORMAT ", duration: %"
2743       G_GINT64_FORMAT, gst_format_get_name (format), result, size,
2744       basesrc->segment.duration);
2745
2746   seekable = gst_base_src_seekable (basesrc);
2747   GST_DEBUG_OBJECT (basesrc, "is seekable: %d", seekable);
2748
2749   /* update for random access flag */
2750   basesrc->random_access = seekable && format == GST_FORMAT_BYTES;
2751
2752   GST_DEBUG_OBJECT (basesrc, "is random_access: %d", basesrc->random_access);
2753
2754   /* run typefind if we are random_access and the typefinding is enabled. */
2755   if (basesrc->random_access && basesrc->data.ABI.typefind && size != -1) {
2756     GstCaps *caps;
2757
2758     if (!(caps = gst_type_find_helper (basesrc->srcpad, size)))
2759       goto typefind_failed;
2760
2761     result = gst_pad_set_caps (basesrc->srcpad, caps);
2762     gst_caps_unref (caps);
2763   } else {
2764     /* use class or default negotiate function */
2765     if (!(result = gst_base_src_negotiate (basesrc)))
2766       goto could_not_negotiate;
2767   }
2768
2769   return result;
2770
2771   /* ERROR */
2772 could_not_start:
2773   {
2774     GST_DEBUG_OBJECT (basesrc, "could not start");
2775     /* subclass is supposed to post a message. We don't have to call _stop. */
2776     return FALSE;
2777   }
2778 could_not_negotiate:
2779   {
2780     GST_DEBUG_OBJECT (basesrc, "could not negotiate, stopping");
2781     GST_ELEMENT_ERROR (basesrc, STREAM, FORMAT,
2782         ("Could not negotiate format"), ("Check your filtered caps, if any"));
2783     /* we must call stop */
2784     gst_base_src_stop (basesrc);
2785     return FALSE;
2786   }
2787 typefind_failed:
2788   {
2789     GST_DEBUG_OBJECT (basesrc, "could not typefind, stopping");
2790     GST_ELEMENT_ERROR (basesrc, STREAM, TYPE_NOT_FOUND, (NULL), (NULL));
2791     /* we must call stop */
2792     gst_base_src_stop (basesrc);
2793     return FALSE;
2794   }
2795 }
2796
2797 static gboolean
2798 gst_base_src_stop (GstBaseSrc * basesrc)
2799 {
2800   GstBaseSrcClass *bclass;
2801   gboolean result = TRUE;
2802
2803   if (!GST_OBJECT_FLAG_IS_SET (basesrc, GST_BASE_SRC_STARTED))
2804     return TRUE;
2805
2806   GST_DEBUG_OBJECT (basesrc, "stopping source");
2807
2808   bclass = GST_BASE_SRC_GET_CLASS (basesrc);
2809   if (bclass->stop)
2810     result = bclass->stop (basesrc);
2811
2812   if (result)
2813     GST_OBJECT_FLAG_UNSET (basesrc, GST_BASE_SRC_STARTED);
2814
2815   return result;
2816 }
2817
2818 /* start or stop flushing dataprocessing
2819  */
2820 static gboolean
2821 gst_base_src_set_flushing (GstBaseSrc * basesrc,
2822     gboolean flushing, gboolean live_play, gboolean unlock, gboolean * playing)
2823 {
2824   GstBaseSrcClass *bclass;
2825
2826   bclass = GST_BASE_SRC_GET_CLASS (basesrc);
2827
2828   if (flushing && unlock) {
2829     /* unlock any subclasses, we need to do this before grabbing the
2830      * LIVE_LOCK since we hold this lock before going into ::create. We pass an
2831      * unlock to the params because of backwards compat (see seek handler)*/
2832     if (bclass->unlock)
2833       bclass->unlock (basesrc);
2834   }
2835
2836   /* the live lock is released when we are blocked, waiting for playing or
2837    * when we sync to the clock. */
2838   GST_LIVE_LOCK (basesrc);
2839   if (playing)
2840     *playing = basesrc->live_running;
2841   basesrc->priv->flushing = flushing;
2842   if (flushing) {
2843     /* if we are locked in the live lock, signal it to make it flush */
2844     basesrc->live_running = TRUE;
2845
2846     /* clear pending EOS if any */
2847     g_atomic_int_set (&basesrc->priv->pending_eos, FALSE);
2848
2849     /* step 1, now that we have the LIVE lock, clear our unlock request */
2850     if (bclass->unlock_stop)
2851       bclass->unlock_stop (basesrc);
2852
2853     /* step 2, unblock clock sync (if any) or any other blocking thing */
2854     if (basesrc->clock_id)
2855       gst_clock_id_unschedule (basesrc->clock_id);
2856   } else {
2857     /* signal the live source that it can start playing */
2858     basesrc->live_running = live_play;
2859
2860     /* When unlocking drop all delayed events */
2861     if (unlock) {
2862       GST_OBJECT_LOCK (basesrc);
2863       if (basesrc->priv->pending_events) {
2864         g_list_foreach (basesrc->priv->pending_events, (GFunc) gst_event_unref,
2865             NULL);
2866         g_list_free (basesrc->priv->pending_events);
2867         basesrc->priv->pending_events = NULL;
2868         g_atomic_int_set (&basesrc->priv->have_events, FALSE);
2869       }
2870       GST_OBJECT_UNLOCK (basesrc);
2871     }
2872   }
2873   GST_LIVE_SIGNAL (basesrc);
2874   GST_LIVE_UNLOCK (basesrc);
2875
2876   return TRUE;
2877 }
2878
2879 /* the purpose of this function is to make sure that a live source blocks in the
2880  * LIVE lock or leaves the LIVE lock and continues playing. */
2881 static gboolean
2882 gst_base_src_set_playing (GstBaseSrc * basesrc, gboolean live_play)
2883 {
2884   GstBaseSrcClass *bclass;
2885
2886   bclass = GST_BASE_SRC_GET_CLASS (basesrc);
2887
2888   /* unlock subclasses locked in ::create, we only do this when we stop playing. */
2889   if (!live_play) {
2890     GST_DEBUG_OBJECT (basesrc, "unlock");
2891     if (bclass->unlock)
2892       bclass->unlock (basesrc);
2893   }
2894
2895   /* we are now able to grab the LIVE lock, when we get it, we can be
2896    * waiting for PLAYING while blocked in the LIVE cond or we can be waiting
2897    * for the clock. */
2898   GST_LIVE_LOCK (basesrc);
2899   GST_DEBUG_OBJECT (basesrc, "unschedule clock");
2900
2901   /* unblock clock sync (if any) */
2902   if (basesrc->clock_id)
2903     gst_clock_id_unschedule (basesrc->clock_id);
2904
2905   /* configure what to do when we get to the LIVE lock. */
2906   GST_DEBUG_OBJECT (basesrc, "live running %d", live_play);
2907   basesrc->live_running = live_play;
2908
2909   if (live_play) {
2910     gboolean start;
2911
2912     /* clear our unlock request when going to PLAYING */
2913     GST_DEBUG_OBJECT (basesrc, "unlock stop");
2914     if (bclass->unlock_stop)
2915       bclass->unlock_stop (basesrc);
2916
2917     /* for live sources we restart the timestamp correction */
2918     basesrc->priv->latency = -1;
2919     /* have to restart the task in case it stopped because of the unlock when
2920      * we went to PAUSED. Only do this if we operating in push mode. */
2921     GST_OBJECT_LOCK (basesrc->srcpad);
2922     start = (GST_PAD_ACTIVATE_MODE (basesrc->srcpad) == GST_ACTIVATE_PUSH);
2923     GST_OBJECT_UNLOCK (basesrc->srcpad);
2924     if (start)
2925       gst_pad_start_task (basesrc->srcpad, (GstTaskFunction) gst_base_src_loop,
2926           basesrc->srcpad);
2927     GST_DEBUG_OBJECT (basesrc, "signal");
2928     GST_LIVE_SIGNAL (basesrc);
2929   }
2930   GST_LIVE_UNLOCK (basesrc);
2931
2932   return TRUE;
2933 }
2934
2935 static gboolean
2936 gst_base_src_activate_push (GstPad * pad, gboolean active)
2937 {
2938   GstBaseSrc *basesrc;
2939   GstEvent *event;
2940
2941   basesrc = GST_BASE_SRC (GST_OBJECT_PARENT (pad));
2942
2943   /* prepare subclass first */
2944   if (active) {
2945     GST_DEBUG_OBJECT (basesrc, "Activating in push mode");
2946
2947     if (G_UNLIKELY (!basesrc->can_activate_push))
2948       goto no_push_activation;
2949
2950     if (G_UNLIKELY (!gst_base_src_start (basesrc)))
2951       goto error_start;
2952
2953     basesrc->priv->last_sent_eos = FALSE;
2954     basesrc->priv->discont = TRUE;
2955     gst_base_src_set_flushing (basesrc, FALSE, FALSE, FALSE, NULL);
2956
2957     /* do initial seek, which will start the task */
2958     GST_OBJECT_LOCK (basesrc);
2959     event = basesrc->data.ABI.pending_seek;
2960     basesrc->data.ABI.pending_seek = NULL;
2961     GST_OBJECT_UNLOCK (basesrc);
2962
2963     /* no need to unlock anything, the task is certainly
2964      * not running here. The perform seek code will start the task when
2965      * finished. */
2966     if (G_UNLIKELY (!gst_base_src_perform_seek (basesrc, event, FALSE)))
2967       goto seek_failed;
2968
2969     if (event)
2970       gst_event_unref (event);
2971   } else {
2972     GST_DEBUG_OBJECT (basesrc, "Deactivating in push mode");
2973     /* flush all */
2974     gst_base_src_set_flushing (basesrc, TRUE, FALSE, TRUE, NULL);
2975     /* stop the task */
2976     gst_pad_stop_task (pad);
2977     /* now we can stop the source */
2978     if (G_UNLIKELY (!gst_base_src_stop (basesrc)))
2979       goto error_stop;
2980   }
2981   return TRUE;
2982
2983   /* ERRORS */
2984 no_push_activation:
2985   {
2986     GST_WARNING_OBJECT (basesrc, "Subclass disabled push-mode activation");
2987     return FALSE;
2988   }
2989 error_start:
2990   {
2991     GST_WARNING_OBJECT (basesrc, "Failed to start in push mode");
2992     return FALSE;
2993   }
2994 seek_failed:
2995   {
2996     GST_ERROR_OBJECT (basesrc, "Failed to perform initial seek");
2997     /* flush all */
2998     gst_base_src_set_flushing (basesrc, TRUE, FALSE, TRUE, NULL);
2999     /* stop the task */
3000     gst_pad_stop_task (pad);
3001     /* Stop the basesrc */
3002     gst_base_src_stop (basesrc);
3003     if (event)
3004       gst_event_unref (event);
3005     return FALSE;
3006   }
3007 error_stop:
3008   {
3009     GST_DEBUG_OBJECT (basesrc, "Failed to stop in push mode");
3010     return FALSE;
3011   }
3012 }
3013
3014 static gboolean
3015 gst_base_src_activate_pull (GstPad * pad, gboolean active)
3016 {
3017   GstBaseSrc *basesrc;
3018
3019   basesrc = GST_BASE_SRC (GST_OBJECT_PARENT (pad));
3020
3021   /* prepare subclass first */
3022   if (active) {
3023     GST_DEBUG_OBJECT (basesrc, "Activating in pull mode");
3024     if (G_UNLIKELY (!gst_base_src_start (basesrc)))
3025       goto error_start;
3026
3027     /* if not random_access, we cannot operate in pull mode for now */
3028     if (G_UNLIKELY (!gst_base_src_check_get_range (basesrc)))
3029       goto no_get_range;
3030
3031     /* stop flushing now but for live sources, still block in the LIVE lock when
3032      * we are not yet PLAYING */
3033     gst_base_src_set_flushing (basesrc, FALSE, FALSE, FALSE, NULL);
3034   } else {
3035     GST_DEBUG_OBJECT (basesrc, "Deactivating in pull mode");
3036     /* flush all, there is no task to stop */
3037     gst_base_src_set_flushing (basesrc, TRUE, FALSE, TRUE, NULL);
3038
3039     /* don't send EOS when going from PAUSED => READY when in pull mode */
3040     basesrc->priv->last_sent_eos = TRUE;
3041
3042     if (G_UNLIKELY (!gst_base_src_stop (basesrc)))
3043       goto error_stop;
3044   }
3045   return TRUE;
3046
3047   /* ERRORS */
3048 error_start:
3049   {
3050     GST_ERROR_OBJECT (basesrc, "Failed to start in pull mode");
3051     return FALSE;
3052   }
3053 no_get_range:
3054   {
3055     GST_ERROR_OBJECT (basesrc, "Cannot operate in pull mode, stopping");
3056     gst_base_src_stop (basesrc);
3057     return FALSE;
3058   }
3059 error_stop:
3060   {
3061     GST_ERROR_OBJECT (basesrc, "Failed to stop in pull mode");
3062     return FALSE;
3063   }
3064 }
3065
3066 static GstStateChangeReturn
3067 gst_base_src_change_state (GstElement * element, GstStateChange transition)
3068 {
3069   GstBaseSrc *basesrc;
3070   GstStateChangeReturn result;
3071   gboolean no_preroll = FALSE;
3072
3073   basesrc = GST_BASE_SRC (element);
3074
3075   switch (transition) {
3076     case GST_STATE_CHANGE_NULL_TO_READY:
3077       break;
3078     case GST_STATE_CHANGE_READY_TO_PAUSED:
3079       no_preroll = gst_base_src_is_live (basesrc);
3080       break;
3081     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
3082       GST_DEBUG_OBJECT (basesrc, "PAUSED->PLAYING");
3083       if (gst_base_src_is_live (basesrc)) {
3084         /* now we can start playback */
3085         gst_base_src_set_playing (basesrc, TRUE);
3086       }
3087       break;
3088     default:
3089       break;
3090   }
3091
3092   if ((result =
3093           GST_ELEMENT_CLASS (parent_class)->change_state (element,
3094               transition)) == GST_STATE_CHANGE_FAILURE)
3095     goto failure;
3096
3097   switch (transition) {
3098     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
3099       GST_DEBUG_OBJECT (basesrc, "PLAYING->PAUSED");
3100       if (gst_base_src_is_live (basesrc)) {
3101         /* make sure we block in the live lock in PAUSED */
3102         gst_base_src_set_playing (basesrc, FALSE);
3103         no_preroll = TRUE;
3104       }
3105       break;
3106     case GST_STATE_CHANGE_PAUSED_TO_READY:
3107     {
3108       GstEvent **event_p, *event;
3109
3110       /* we don't need to unblock anything here, the pad deactivation code
3111        * already did this */
3112
3113       /* FIXME, deprecate this behaviour, it is very dangerous.
3114        * the prefered way of sending EOS downstream is by sending
3115        * the EOS event to the element */
3116       if (!basesrc->priv->last_sent_eos) {
3117         GST_DEBUG_OBJECT (basesrc, "Sending EOS event");
3118         event = gst_event_new_eos ();
3119         gst_event_set_seqnum (event, basesrc->priv->seqnum);
3120         gst_pad_push_event (basesrc->srcpad, event);
3121         basesrc->priv->last_sent_eos = TRUE;
3122       }
3123       g_atomic_int_set (&basesrc->priv->pending_eos, FALSE);
3124       event_p = &basesrc->data.ABI.pending_seek;
3125       gst_event_replace (event_p, NULL);
3126       event_p = &basesrc->priv->close_segment;
3127       gst_event_replace (event_p, NULL);
3128       event_p = &basesrc->priv->start_segment;
3129       gst_event_replace (event_p, NULL);
3130       break;
3131     }
3132     case GST_STATE_CHANGE_READY_TO_NULL:
3133       break;
3134     default:
3135       break;
3136   }
3137
3138   if (no_preroll && result == GST_STATE_CHANGE_SUCCESS)
3139     result = GST_STATE_CHANGE_NO_PREROLL;
3140
3141   return result;
3142
3143   /* ERRORS */
3144 failure:
3145   {
3146     GST_DEBUG_OBJECT (basesrc, "parent failed state change");
3147     return result;
3148   }
3149 }