baseparse: remove pending_segment as it was being misused
[platform/upstream/gstreamer.git] / libs / gst / base / gstbaseparse.c
1 /* GStreamer
2  * Copyright (C) 2008 Nokia Corporation. All rights reserved.
3  *   Contact: Stefan Kost <stefan.kost@nokia.com>
4  * Copyright (C) 2008 Sebastian Dröge <sebastian.droege@collabora.co.uk>.
5  * Copyright (C) 2011, Hewlett-Packard Development Company, L.P.
6  *   Author: Sebastian Dröge <sebastian.droege@collabora.co.uk>, Collabora Ltd.
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public
19  * License along with this library; if not, write to the
20  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  */
23
24 /**
25  * SECTION:gstbaseparse
26  * @short_description: Base class for stream parsers
27  * @see_also: #GstBaseTransform
28  *
29  * This base class is for parser elements that process data and splits it
30  * into separate audio/video/whatever frames.
31  *
32  * It provides for:
33  * <itemizedlist>
34  *   <listitem><para>provides one sink pad and one source pad</para></listitem>
35  *   <listitem><para>handles state changes</para></listitem>
36  *   <listitem><para>can operate in pull mode or push mode</para></listitem>
37  *   <listitem><para>handles seeking in both modes</para></listitem>
38  *   <listitem><para>handles events (SEGMENT/EOS/FLUSH)</para></listitem>
39  *   <listitem><para>
40  *        handles queries (POSITION/DURATION/SEEKING/FORMAT/CONVERT)
41  *   </para></listitem>
42  *   <listitem><para>handles flushing</para></listitem>
43  * </itemizedlist>
44  *
45  * The purpose of this base class is to provide the basic functionality of
46  * a parser and share a lot of rather complex code.
47  *
48  * Description of the parsing mechanism:
49  * <orderedlist>
50  * <listitem>
51  *   <itemizedlist><title>Set-up phase</title>
52  *   <listitem><para>
53  *     GstBaseParse calls @start to inform subclass that data processing is
54  *     about to start now.
55  *   </para></listitem>
56  *   <listitem><para>
57  *     GstBaseParse class calls @set_sink_caps to inform the subclass about
58  *     incoming sinkpad caps. Subclass could already set the srcpad caps
59  *     accordingly, but this might be delayed until calling
60  *     gst_base_parse_finish_frame() with a non-queued frame.
61  *   </para></listitem>
62  *   <listitem><para>
63  *      At least at this point subclass needs to tell the GstBaseParse class
64  *      how big data chunks it wants to receive (min_frame_size). It can do
65  *      this with gst_base_parse_set_min_frame_size().
66  *   </para></listitem>
67  *   <listitem><para>
68  *      GstBaseParse class sets up appropriate data passing mode (pull/push)
69  *      and starts to process the data.
70  *   </para></listitem>
71  *   </itemizedlist>
72  * </listitem>
73  * <listitem>
74  *   <itemizedlist>
75  *   <title>Parsing phase</title>
76  *     <listitem><para>
77  *       GstBaseParse gathers at least min_frame_size bytes of data either
78  *       by pulling it from upstream or collecting buffers in an internal
79  *       #GstAdapter.
80  *     </para></listitem>
81  *     <listitem><para>
82  *       A buffer of (at least) min_frame_size bytes is passed to subclass with
83  *       @handle_frame. Subclass checks the contents and can optionally
84  *       return GST_FLOW_OK along with an amount of data to be skipped to find
85  *       a valid frame (which will result in a subsequent DISCONT).
86  *       If, otherwise, the buffer does not hold a complete frame,
87  *       @handle_frame can merely return and will be called again when additional
88  *       data is available.  In push mode this amounts to an
89  *       additional input buffer (thus minimal additional latency), in pull mode
90  *       this amounts to some arbitrary reasonable buffer size increase.
91  *       Of course, gst_base_parse_set_min_frame_size() could also be used if a
92  *       very specific known amount of additional data is required.
93  *       If, however, the buffer holds a complete valid frame, it can pass
94  *       the size of this frame to gst_base_parse_finish_frame().
95  *       If acting as a converter, it can also merely indicate consumed input data
96  *       while simultaneously providing custom output data.
97  *       Note that baseclass performs some processing (such as tracking
98  *       overall consumed data rate versus duration) for each finished frame,
99  *       but other state is only updated upon each call to @handle_frame
100  *       (such as tracking upstream input timestamp).
101  *       </para><para>
102  *       Subclass is also responsible for setting the buffer metadata
103  *       (e.g. buffer timestamp and duration, or keyframe if applicable).
104  *       (although the latter can also be done by GstBaseParse if it is
105  *       appropriately configured, see below).  Frame is provided with
106  *       timestamp derived from upstream (as much as generally possible),
107  *       duration obtained from configuration (see below), and offset
108  *       if meaningful (in pull mode).
109  *       </para><para>
110  *       Note that @check_valid_frame might receive any small
111  *       amount of input data when leftover data is being drained (e.g. at EOS).
112  *     </para></listitem>
113  *     <listitem><para>
114  *       As part of finish frame processing,
115  *       just prior to actually pushing the buffer in question,
116  *       it is passed to @pre_push_frame which gives subclass yet one
117  *       last chance to examine buffer metadata, or to send some custom (tag)
118  *       events, or to perform custom (segment) filtering.
119  *     </para></listitem>
120  *     <listitem><para>
121  *       During the parsing process GstBaseParseClass will handle both srcpad
122  *       and sinkpad events. They will be passed to subclass if @event or
123  *       @src_event callbacks have been provided.
124  *     </para></listitem>
125  *   </itemizedlist>
126  * </listitem>
127  * <listitem>
128  *   <itemizedlist><title>Shutdown phase</title>
129  *   <listitem><para>
130  *     GstBaseParse class calls @stop to inform the subclass that data
131  *     parsing will be stopped.
132  *   </para></listitem>
133  *   </itemizedlist>
134  * </listitem>
135  * </orderedlist>
136  *
137  * Subclass is responsible for providing pad template caps for
138  * source and sink pads. The pads need to be named "sink" and "src". It also
139  * needs to set the fixed caps on srcpad, when the format is ensured (e.g.
140  * when base class calls subclass' @set_sink_caps function).
141  *
142  * This base class uses #GST_FORMAT_DEFAULT as a meaning of frames. So,
143  * subclass conversion routine needs to know that conversion from
144  * #GST_FORMAT_TIME to #GST_FORMAT_DEFAULT must return the
145  * frame number that can be found from the given byte position.
146  *
147  * GstBaseParse uses subclasses conversion methods also for seeking (or
148  * otherwise uses its own default one, see also below).
149  *
150  * Subclass @start and @stop functions will be called to inform the beginning
151  * and end of data processing.
152  *
153  * Things that subclass need to take care of:
154  * <itemizedlist>
155  *   <listitem><para>Provide pad templates</para></listitem>
156  *   <listitem><para>
157  *      Fixate the source pad caps when appropriate
158  *   </para></listitem>
159  *   <listitem><para>
160  *      Inform base class how big data chunks should be retrieved. This is
161  *      done with gst_base_parse_set_min_frame_size() function.
162  *   </para></listitem>
163  *   <listitem><para>
164  *      Examine data chunks passed to subclass with @handle_frame and pass
165  *      proper frame(s) to gst_base_parse_finish_frame(), and setting src pad
166  *      caps and timestamps on frame.
167  *   </para></listitem>
168  *   <listitem><para>Provide conversion functions</para></listitem>
169  *   <listitem><para>
170  *      Update the duration information with gst_base_parse_set_duration()
171  *   </para></listitem>
172  *   <listitem><para>
173  *      Optionally passthrough using gst_base_parse_set_passthrough()
174  *   </para></listitem>
175  *   <listitem><para>
176  *      Configure various baseparse parameters using
177  *      gst_base_parse_set_average_bitrate(), gst_base_parse_set_syncable()
178  *      and gst_base_parse_set_frame_rate().
179  *   </para></listitem>
180  *   <listitem><para>
181  *      In particular, if subclass is unable to determine a duration, but
182  *      parsing (or specs) yields a frames per seconds rate, then this can be
183  *      provided to GstBaseParse to enable it to cater for
184  *      buffer time metadata (which will be taken from upstream as much as
185  *      possible). Internally keeping track of frame durations and respective
186  *      sizes that have been pushed provides GstBaseParse with an estimated
187  *      bitrate. A default @convert (used if not overridden) will then use these
188  *      rates to perform obvious conversions.  These rates are also used to
189  *      update (estimated) duration at regular frame intervals.
190  *   </para></listitem>
191  * </itemizedlist>
192  *
193  */
194
195 /* TODO:
196  *  - In push mode provide a queue of adapter-"queued" buffers for upstream
197  *    buffer metadata
198  *  - Queue buffers/events until caps are set
199  */
200
201 #ifdef HAVE_CONFIG_H
202 #  include "config.h"
203 #endif
204
205 #include <stdlib.h>
206 #include <string.h>
207
208 #include <gst/base/gstadapter.h>
209
210 #include "gstbaseparse.h"
211
212 /* FIXME: get rid of old GstIndex code */
213 #include "gstindex.h"
214 #include "gstindex.c"
215 #include "gstmemindex.c"
216
217 #define GST_BASE_PARSE_FRAME_PRIVATE_FLAG_NOALLOC  (1 << 0)
218
219 #define MIN_FRAMES_TO_POST_BITRATE 10
220 #define TARGET_DIFFERENCE          (20 * GST_SECOND)
221 #define MAX_INDEX_ENTRIES          4096
222
223 GST_DEBUG_CATEGORY_STATIC (gst_base_parse_debug);
224 #define GST_CAT_DEFAULT gst_base_parse_debug
225
226 /* Supported formats */
227 static const GstFormat fmtlist[] = {
228   GST_FORMAT_DEFAULT,
229   GST_FORMAT_BYTES,
230   GST_FORMAT_TIME,
231   GST_FORMAT_UNDEFINED
232 };
233
234 #define GST_BASE_PARSE_GET_PRIVATE(obj)  \
235     (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_BASE_PARSE, GstBaseParsePrivate))
236
237 struct _GstBaseParsePrivate
238 {
239   GstPadMode pad_mode;
240
241   GstAdapter *adapter;
242
243   gint64 duration;
244   GstFormat duration_fmt;
245   gint64 estimated_duration;
246   gint64 estimated_drift;
247
248   guint min_frame_size;
249   gboolean disable_passthrough;
250   gboolean passthrough;
251   gboolean pts_interpolate;
252   gboolean infer_ts;
253   gboolean syncable;
254   gboolean has_timing_info;
255   guint fps_num, fps_den;
256   gint update_interval;
257   guint bitrate;
258   guint lead_in, lead_out;
259   GstClockTime lead_in_ts, lead_out_ts;
260   GstClockTime min_latency, max_latency;
261
262   gboolean discont;
263   gboolean flushing;
264   gboolean drain;
265
266   gint64 offset;
267   gint64 sync_offset;
268   GstClockTime next_pts;
269   GstClockTime next_dts;
270   GstClockTime prev_pts;
271   GstClockTime prev_dts;
272   GstClockTime frame_duration;
273   gboolean seen_keyframe;
274   gboolean is_video;
275   gint flushed;
276
277   guint64 framecount;
278   guint64 bytecount;
279   guint64 data_bytecount;
280   guint64 acc_duration;
281   GstClockTime first_frame_pts;
282   GstClockTime first_frame_dts;
283   gint64 first_frame_offset;
284
285   gboolean post_min_bitrate;
286   gboolean post_avg_bitrate;
287   gboolean post_max_bitrate;
288   guint min_bitrate;
289   guint avg_bitrate;
290   guint max_bitrate;
291   guint posted_avg_bitrate;
292
293   /* frames/buffers that are queued and ready to go on OK */
294   GQueue queued_frames;
295
296   GstBuffer *cache;
297
298   /* index entry storage, either ours or provided */
299   GstIndex *index;
300   gint index_id;
301   gboolean own_index;
302   GMutex index_lock;
303
304   /* seek table entries only maintained if upstream is BYTE seekable */
305   gboolean upstream_seekable;
306   gboolean upstream_has_duration;
307   gint64 upstream_size;
308   GstFormat upstream_format;
309   /* minimum distance between two index entries */
310   GstClockTimeDiff idx_interval;
311   guint64 idx_byte_interval;
312   /* ts and offset of last entry added */
313   GstClockTime index_last_ts;
314   gint64 index_last_offset;
315   gboolean index_last_valid;
316
317   /* timestamps currently produced are accurate, e.g. started from 0 onwards */
318   gboolean exact_position;
319   /* seek events are temporarily kept to match them with newsegments */
320   GSList *pending_seeks;
321
322   /* reverse playback */
323   GSList *buffers_pending;
324   GSList *buffers_head;
325   GSList *buffers_queued;
326   GSList *buffers_send;
327   GstClockTime last_pts;
328   GstClockTime last_dts;
329   gint64 last_offset;
330
331   /* Pending serialized events */
332   GList *pending_events;
333
334   /* If baseparse has checked the caps to identify if it is
335    * handling video or audio */
336   gboolean checked_media;
337
338   /* offset of last parsed frame/data */
339   gint64 prev_offset;
340   /* force a new frame, regardless of offset */
341   gboolean new_frame;
342   /* whether we are merely scanning for a frame */
343   gboolean scanning;
344   /* ... and resulting frame, if any */
345   GstBaseParseFrame *scanned_frame;
346
347   /* TRUE if we're still detecting the format, i.e.
348    * if ::detect() is still called for future buffers */
349   gboolean detecting;
350   GList *detect_buffers;
351   guint detect_buffers_size;
352
353   /* if TRUE, a STREAM_START event needs to be pushed */
354   gboolean push_stream_start;
355 };
356
357 typedef struct _GstBaseParseSeek
358 {
359   GstSegment segment;
360   gboolean accurate;
361   gint64 offset;
362   GstClockTime start_ts;
363 } GstBaseParseSeek;
364
365 #define DEFAULT_DISABLE_PASSTHROUGH        FALSE
366
367 enum
368 {
369   PROP_0,
370   PROP_DISABLE_PASSTHROUGH,
371   PROP_LAST
372 };
373
374 #define GST_BASE_PARSE_INDEX_LOCK(parse) \
375   g_mutex_lock (&parse->priv->index_lock);
376 #define GST_BASE_PARSE_INDEX_UNLOCK(parse) \
377   g_mutex_unlock (&parse->priv->index_lock);
378
379 static GstElementClass *parent_class = NULL;
380
381 static void gst_base_parse_class_init (GstBaseParseClass * klass);
382 static void gst_base_parse_init (GstBaseParse * parse,
383     GstBaseParseClass * klass);
384
385 GType
386 gst_base_parse_get_type (void)
387 {
388   static volatile gsize base_parse_type = 0;
389
390   if (g_once_init_enter (&base_parse_type)) {
391     static const GTypeInfo base_parse_info = {
392       sizeof (GstBaseParseClass),
393       (GBaseInitFunc) NULL,
394       (GBaseFinalizeFunc) NULL,
395       (GClassInitFunc) gst_base_parse_class_init,
396       NULL,
397       NULL,
398       sizeof (GstBaseParse),
399       0,
400       (GInstanceInitFunc) gst_base_parse_init,
401     };
402     GType _type;
403
404     _type = g_type_register_static (GST_TYPE_ELEMENT,
405         "GstBaseParse", &base_parse_info, G_TYPE_FLAG_ABSTRACT);
406     g_once_init_leave (&base_parse_type, _type);
407   }
408   return (GType) base_parse_type;
409 }
410
411 static void gst_base_parse_finalize (GObject * object);
412
413 static GstStateChangeReturn gst_base_parse_change_state (GstElement * element,
414     GstStateChange transition);
415 static void gst_base_parse_reset (GstBaseParse * parse);
416
417 #if 0
418 static void gst_base_parse_set_index (GstElement * element, GstIndex * index);
419 static GstIndex *gst_base_parse_get_index (GstElement * element);
420 #endif
421
422 static gboolean gst_base_parse_sink_activate (GstPad * sinkpad,
423     GstObject * parent);
424 static gboolean gst_base_parse_sink_activate_mode (GstPad * pad,
425     GstObject * parent, GstPadMode mode, gboolean active);
426 static gboolean gst_base_parse_handle_seek (GstBaseParse * parse,
427     GstEvent * event);
428 static void gst_base_parse_handle_tag (GstBaseParse * parse, GstEvent * event);
429
430 static void gst_base_parse_set_property (GObject * object, guint prop_id,
431     const GValue * value, GParamSpec * pspec);
432 static void gst_base_parse_get_property (GObject * object, guint prop_id,
433     GValue * value, GParamSpec * pspec);
434
435 static gboolean gst_base_parse_src_event (GstPad * pad, GstObject * parent,
436     GstEvent * event);
437 static gboolean gst_base_parse_src_query (GstPad * pad, GstObject * parent,
438     GstQuery * query);
439
440 static gboolean gst_base_parse_sink_event (GstPad * pad, GstObject * parent,
441     GstEvent * event);
442 static gboolean gst_base_parse_sink_query (GstPad * pad, GstObject * parent,
443     GstQuery * query);
444
445 static GstFlowReturn gst_base_parse_chain (GstPad * pad, GstObject * parent,
446     GstBuffer * buffer);
447 static void gst_base_parse_loop (GstPad * pad);
448
449 static GstFlowReturn gst_base_parse_parse_frame (GstBaseParse * parse,
450     GstBaseParseFrame * frame);
451
452 static gboolean gst_base_parse_sink_event_default (GstBaseParse * parse,
453     GstEvent * event);
454
455 static gboolean gst_base_parse_src_event_default (GstBaseParse * parse,
456     GstEvent * event);
457
458 static gboolean gst_base_parse_sink_query_default (GstBaseParse * parse,
459     GstQuery * query);
460 static gboolean gst_base_parse_src_query_default (GstBaseParse * parse,
461     GstQuery * query);
462
463 static void gst_base_parse_drain (GstBaseParse * parse);
464
465 static void gst_base_parse_post_bitrates (GstBaseParse * parse,
466     gboolean post_min, gboolean post_avg, gboolean post_max);
467
468 static gint64 gst_base_parse_find_offset (GstBaseParse * parse,
469     GstClockTime time, gboolean before, GstClockTime * _ts);
470 static GstFlowReturn gst_base_parse_locate_time (GstBaseParse * parse,
471     GstClockTime * _time, gint64 * _offset);
472
473 static GstFlowReturn gst_base_parse_start_fragment (GstBaseParse * parse);
474 static GstFlowReturn gst_base_parse_finish_fragment (GstBaseParse * parse,
475     gboolean prev_head);
476
477 static inline GstFlowReturn gst_base_parse_check_sync (GstBaseParse * parse);
478
479 static gboolean gst_base_parse_is_seekable (GstBaseParse * parse);
480
481 static void gst_base_parse_push_pending_events (GstBaseParse * parse);
482
483 static void
484 gst_base_parse_clear_queues (GstBaseParse * parse)
485 {
486   g_slist_foreach (parse->priv->buffers_queued, (GFunc) gst_buffer_unref, NULL);
487   g_slist_free (parse->priv->buffers_queued);
488   parse->priv->buffers_queued = NULL;
489   g_slist_foreach (parse->priv->buffers_pending, (GFunc) gst_buffer_unref,
490       NULL);
491   g_slist_free (parse->priv->buffers_pending);
492   parse->priv->buffers_pending = NULL;
493   g_slist_foreach (parse->priv->buffers_head, (GFunc) gst_buffer_unref, NULL);
494   g_slist_free (parse->priv->buffers_head);
495   parse->priv->buffers_head = NULL;
496   g_slist_foreach (parse->priv->buffers_send, (GFunc) gst_buffer_unref, NULL);
497   g_slist_free (parse->priv->buffers_send);
498   parse->priv->buffers_send = NULL;
499
500   g_list_foreach (parse->priv->detect_buffers, (GFunc) gst_buffer_unref, NULL);
501   g_list_free (parse->priv->detect_buffers);
502   parse->priv->detect_buffers = NULL;
503   parse->priv->detect_buffers_size = 0;
504
505   g_queue_foreach (&parse->priv->queued_frames,
506       (GFunc) gst_base_parse_frame_free, NULL);
507   g_queue_clear (&parse->priv->queued_frames);
508
509   gst_buffer_replace (&parse->priv->cache, NULL);
510
511   g_list_foreach (parse->priv->pending_events, (GFunc) gst_event_unref, NULL);
512   g_list_free (parse->priv->pending_events);
513   parse->priv->pending_events = NULL;
514
515   parse->priv->checked_media = FALSE;
516 }
517
518 static void
519 gst_base_parse_finalize (GObject * object)
520 {
521   GstBaseParse *parse = GST_BASE_PARSE (object);
522
523   g_object_unref (parse->priv->adapter);
524
525   if (parse->priv->cache) {
526     gst_buffer_unref (parse->priv->cache);
527     parse->priv->cache = NULL;
528   }
529
530   g_list_foreach (parse->priv->pending_events, (GFunc) gst_mini_object_unref,
531       NULL);
532   g_list_free (parse->priv->pending_events);
533   parse->priv->pending_events = NULL;
534
535   if (parse->priv->index) {
536     gst_object_unref (parse->priv->index);
537     parse->priv->index = NULL;
538   }
539   g_mutex_clear (&parse->priv->index_lock);
540
541   gst_base_parse_clear_queues (parse);
542
543   G_OBJECT_CLASS (parent_class)->finalize (object);
544 }
545
546 static void
547 gst_base_parse_class_init (GstBaseParseClass * klass)
548 {
549   GObjectClass *gobject_class;
550   GstElementClass *gstelement_class;
551
552   gobject_class = G_OBJECT_CLASS (klass);
553   g_type_class_add_private (klass, sizeof (GstBaseParsePrivate));
554   parent_class = g_type_class_peek_parent (klass);
555
556   gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_base_parse_finalize);
557   gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_base_parse_set_property);
558   gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_base_parse_get_property);
559
560   /**
561    * GstBaseParse:disable-passthrough:
562    *
563    * If set to #TRUE, baseparse will unconditionally force parsing of the
564    * incoming data. This can be required in the rare cases where the incoming
565    * side-data (caps, pts, dts, ...) is not trusted by the user and wants to
566    * force validation and parsing of the incoming data.
567    * If set to #FALSE, decision of whether to parse the data or not is up to
568    * the implementation (standard behaviour).
569    */
570   g_object_class_install_property (gobject_class, PROP_DISABLE_PASSTHROUGH,
571       g_param_spec_boolean ("disable-passthrough", "Disable passthrough",
572           "Force processing (disables passthrough)",
573           DEFAULT_DISABLE_PASSTHROUGH,
574           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
575
576   gstelement_class = (GstElementClass *) klass;
577   gstelement_class->change_state =
578       GST_DEBUG_FUNCPTR (gst_base_parse_change_state);
579
580 #if 0
581   gstelement_class->set_index = GST_DEBUG_FUNCPTR (gst_base_parse_set_index);
582   gstelement_class->get_index = GST_DEBUG_FUNCPTR (gst_base_parse_get_index);
583 #endif
584
585   /* Default handlers */
586   klass->sink_event = gst_base_parse_sink_event_default;
587   klass->src_event = gst_base_parse_src_event_default;
588   klass->sink_query = gst_base_parse_sink_query_default;
589   klass->src_query = gst_base_parse_src_query_default;
590   klass->convert = gst_base_parse_convert_default;
591
592   GST_DEBUG_CATEGORY_INIT (gst_base_parse_debug, "baseparse", 0,
593       "baseparse element");
594 }
595
596 static void
597 gst_base_parse_init (GstBaseParse * parse, GstBaseParseClass * bclass)
598 {
599   GstPadTemplate *pad_template;
600
601   GST_DEBUG_OBJECT (parse, "gst_base_parse_init");
602
603   parse->priv = GST_BASE_PARSE_GET_PRIVATE (parse);
604
605   pad_template =
606       gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass), "sink");
607   g_return_if_fail (pad_template != NULL);
608   parse->sinkpad = gst_pad_new_from_template (pad_template, "sink");
609   gst_pad_set_event_function (parse->sinkpad,
610       GST_DEBUG_FUNCPTR (gst_base_parse_sink_event));
611   gst_pad_set_query_function (parse->sinkpad,
612       GST_DEBUG_FUNCPTR (gst_base_parse_sink_query));
613   gst_pad_set_chain_function (parse->sinkpad,
614       GST_DEBUG_FUNCPTR (gst_base_parse_chain));
615   gst_pad_set_activate_function (parse->sinkpad,
616       GST_DEBUG_FUNCPTR (gst_base_parse_sink_activate));
617   gst_pad_set_activatemode_function (parse->sinkpad,
618       GST_DEBUG_FUNCPTR (gst_base_parse_sink_activate_mode));
619   GST_PAD_SET_PROXY_ALLOCATION (parse->sinkpad);
620   gst_element_add_pad (GST_ELEMENT (parse), parse->sinkpad);
621
622   GST_DEBUG_OBJECT (parse, "sinkpad created");
623
624   pad_template =
625       gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass), "src");
626   g_return_if_fail (pad_template != NULL);
627   parse->srcpad = gst_pad_new_from_template (pad_template, "src");
628   gst_pad_set_event_function (parse->srcpad,
629       GST_DEBUG_FUNCPTR (gst_base_parse_src_event));
630   gst_pad_set_query_function (parse->srcpad,
631       GST_DEBUG_FUNCPTR (gst_base_parse_src_query));
632   gst_pad_use_fixed_caps (parse->srcpad);
633   gst_element_add_pad (GST_ELEMENT (parse), parse->srcpad);
634   GST_DEBUG_OBJECT (parse, "src created");
635
636   g_queue_init (&parse->priv->queued_frames);
637
638   parse->priv->adapter = gst_adapter_new ();
639
640   parse->priv->pad_mode = GST_PAD_MODE_NONE;
641
642   g_mutex_init (&parse->priv->index_lock);
643
644   /* init state */
645   gst_base_parse_reset (parse);
646   GST_DEBUG_OBJECT (parse, "init ok");
647
648   GST_OBJECT_FLAG_SET (parse, GST_ELEMENT_FLAG_INDEXABLE);
649 }
650
651 static void
652 gst_base_parse_set_property (GObject * object, guint prop_id,
653     const GValue * value, GParamSpec * pspec)
654 {
655   GstBaseParse *parse = GST_BASE_PARSE (object);
656
657   switch (prop_id) {
658     case PROP_DISABLE_PASSTHROUGH:
659       parse->priv->disable_passthrough = g_value_get_boolean (value);
660       break;
661     default:
662       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
663       break;
664   }
665 }
666
667 static void
668 gst_base_parse_get_property (GObject * object, guint prop_id, GValue * value,
669     GParamSpec * pspec)
670 {
671   GstBaseParse *parse = GST_BASE_PARSE (object);
672
673   switch (prop_id) {
674     case PROP_DISABLE_PASSTHROUGH:
675       g_value_set_boolean (value, parse->priv->disable_passthrough);
676       break;
677     default:
678       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
679       break;
680   }
681 }
682
683 static GstBaseParseFrame *
684 gst_base_parse_frame_copy (GstBaseParseFrame * frame)
685 {
686   GstBaseParseFrame *copy;
687
688   copy = g_slice_dup (GstBaseParseFrame, frame);
689   copy->buffer = gst_buffer_ref (frame->buffer);
690   copy->_private_flags &= ~GST_BASE_PARSE_FRAME_PRIVATE_FLAG_NOALLOC;
691
692   GST_TRACE ("copied frame %p -> %p", frame, copy);
693
694   return copy;
695 }
696
697 void
698 gst_base_parse_frame_free (GstBaseParseFrame * frame)
699 {
700   GST_TRACE ("freeing frame %p", frame);
701
702   if (frame->buffer) {
703     gst_buffer_unref (frame->buffer);
704     frame->buffer = NULL;
705   }
706
707   if (!(frame->_private_flags & GST_BASE_PARSE_FRAME_PRIVATE_FLAG_NOALLOC)) {
708     g_slice_free (GstBaseParseFrame, frame);
709   } else {
710     memset (frame, 0, sizeof (*frame));
711   }
712 }
713
714 G_DEFINE_BOXED_TYPE (GstBaseParseFrame, gst_base_parse_frame,
715     (GBoxedCopyFunc) gst_base_parse_frame_copy,
716     (GBoxedFreeFunc) gst_base_parse_frame_free);
717
718 /**
719  * gst_base_parse_frame_init:
720  * @frame: #GstBaseParseFrame.
721  *
722  * Sets a #GstBaseParseFrame to initial state.  Currently this means
723  * all public fields are zero-ed and a private flag is set to make
724  * sure gst_base_parse_frame_free() only frees the contents but not
725  * the actual frame. Use this function to initialise a #GstBaseParseFrame
726  * allocated on the stack.
727  */
728 void
729 gst_base_parse_frame_init (GstBaseParseFrame * frame)
730 {
731   memset (frame, 0, sizeof (GstBaseParseFrame));
732   frame->_private_flags = GST_BASE_PARSE_FRAME_PRIVATE_FLAG_NOALLOC;
733   GST_TRACE ("inited frame %p", frame);
734 }
735
736 /**
737  * gst_base_parse_frame_new:
738  * @buffer: (transfer none): a #GstBuffer
739  * @flags: the flags
740  * @overhead: number of bytes in this frame which should be counted as
741  *     metadata overhead, ie. not used to calculate the average bitrate.
742  *     Set to -1 to mark the entire frame as metadata. If in doubt, set to 0.
743  *
744  * Allocates a new #GstBaseParseFrame. This function is mainly for bindings,
745  * elements written in C should usually allocate the frame on the stack and
746  * then use gst_base_parse_frame_init() to initialise it.
747  *
748  * Returns: a newly-allocated #GstBaseParseFrame. Free with
749  *     gst_base_parse_frame_free() when no longer needed.
750  */
751 GstBaseParseFrame *
752 gst_base_parse_frame_new (GstBuffer * buffer, GstBaseParseFrameFlags flags,
753     gint overhead)
754 {
755   GstBaseParseFrame *frame;
756
757   frame = g_slice_new0 (GstBaseParseFrame);
758   frame->buffer = gst_buffer_ref (buffer);
759
760   GST_TRACE ("created frame %p", frame);
761   return frame;
762 }
763
764 static inline void
765 gst_base_parse_frame_update (GstBaseParse * parse, GstBaseParseFrame * frame,
766     GstBuffer * buf)
767 {
768   gst_buffer_replace (&frame->buffer, buf);
769
770   parse->flags = 0;
771
772   /* set flags one by one for clarity */
773   if (G_UNLIKELY (parse->priv->drain))
774     parse->flags |= GST_BASE_PARSE_FLAG_DRAINING;
775
776   /* losing sync is pretty much a discont (and vice versa), no ? */
777   if (G_UNLIKELY (parse->priv->discont))
778     parse->flags |= GST_BASE_PARSE_FLAG_LOST_SYNC;
779 }
780
781 static void
782 gst_base_parse_reset (GstBaseParse * parse)
783 {
784   GST_OBJECT_LOCK (parse);
785   gst_segment_init (&parse->segment, GST_FORMAT_TIME);
786   parse->priv->duration = -1;
787   parse->priv->min_frame_size = 1;
788   parse->priv->discont = TRUE;
789   parse->priv->flushing = FALSE;
790   parse->priv->offset = 0;
791   parse->priv->sync_offset = 0;
792   parse->priv->update_interval = -1;
793   parse->priv->fps_num = parse->priv->fps_den = 0;
794   parse->priv->frame_duration = GST_CLOCK_TIME_NONE;
795   parse->priv->lead_in = parse->priv->lead_out = 0;
796   parse->priv->lead_in_ts = parse->priv->lead_out_ts = 0;
797   parse->priv->bitrate = 0;
798   parse->priv->framecount = 0;
799   parse->priv->bytecount = 0;
800   parse->priv->acc_duration = 0;
801   parse->priv->first_frame_pts = GST_CLOCK_TIME_NONE;
802   parse->priv->first_frame_dts = GST_CLOCK_TIME_NONE;
803   parse->priv->first_frame_offset = -1;
804   parse->priv->estimated_duration = -1;
805   parse->priv->estimated_drift = 0;
806   parse->priv->next_pts = GST_CLOCK_TIME_NONE;
807   parse->priv->next_dts = 0;
808   parse->priv->syncable = TRUE;
809   parse->priv->disable_passthrough = DEFAULT_DISABLE_PASSTHROUGH;
810   parse->priv->passthrough = FALSE;
811   parse->priv->pts_interpolate = TRUE;
812   parse->priv->infer_ts = TRUE;
813   parse->priv->has_timing_info = FALSE;
814   parse->priv->post_min_bitrate = TRUE;
815   parse->priv->post_avg_bitrate = TRUE;
816   parse->priv->post_max_bitrate = TRUE;
817   parse->priv->min_bitrate = G_MAXUINT;
818   parse->priv->max_bitrate = 0;
819   parse->priv->avg_bitrate = 0;
820   parse->priv->posted_avg_bitrate = 0;
821
822   parse->priv->index_last_ts = GST_CLOCK_TIME_NONE;
823   parse->priv->index_last_offset = -1;
824   parse->priv->index_last_valid = TRUE;
825   parse->priv->upstream_seekable = FALSE;
826   parse->priv->upstream_size = 0;
827   parse->priv->upstream_has_duration = FALSE;
828   parse->priv->upstream_format = GST_FORMAT_UNDEFINED;
829   parse->priv->idx_interval = 0;
830   parse->priv->idx_byte_interval = 0;
831   parse->priv->exact_position = TRUE;
832   parse->priv->seen_keyframe = FALSE;
833   parse->priv->checked_media = FALSE;
834
835   parse->priv->last_dts = GST_CLOCK_TIME_NONE;
836   parse->priv->last_pts = GST_CLOCK_TIME_NONE;
837   parse->priv->last_offset = 0;
838
839   g_list_foreach (parse->priv->pending_events, (GFunc) gst_mini_object_unref,
840       NULL);
841   g_list_free (parse->priv->pending_events);
842   parse->priv->pending_events = NULL;
843
844   if (parse->priv->cache) {
845     gst_buffer_unref (parse->priv->cache);
846     parse->priv->cache = NULL;
847   }
848
849   g_slist_foreach (parse->priv->pending_seeks, (GFunc) g_free, NULL);
850   g_slist_free (parse->priv->pending_seeks);
851   parse->priv->pending_seeks = NULL;
852
853   if (parse->priv->adapter)
854     gst_adapter_clear (parse->priv->adapter);
855
856   parse->priv->new_frame = TRUE;
857
858   g_list_foreach (parse->priv->detect_buffers, (GFunc) gst_buffer_unref, NULL);
859   g_list_free (parse->priv->detect_buffers);
860   parse->priv->detect_buffers = NULL;
861   parse->priv->detect_buffers_size = 0;
862   GST_OBJECT_UNLOCK (parse);
863 }
864
865 /* gst_base_parse_parse_frame:
866  * @parse: #GstBaseParse.
867  * @buffer: #GstBuffer.
868  *
869  * Default callback for parse_frame.
870  */
871 static GstFlowReturn
872 gst_base_parse_parse_frame (GstBaseParse * parse, GstBaseParseFrame * frame)
873 {
874   GstBuffer *buffer = frame->buffer;
875
876   if (!GST_BUFFER_PTS_IS_VALID (buffer) &&
877       GST_CLOCK_TIME_IS_VALID (parse->priv->next_pts)) {
878     GST_BUFFER_PTS (buffer) = parse->priv->next_pts;
879   }
880   if (!GST_BUFFER_DTS_IS_VALID (buffer) &&
881       GST_CLOCK_TIME_IS_VALID (parse->priv->next_dts)) {
882     GST_BUFFER_DTS (buffer) = parse->priv->next_dts;
883   }
884   if (!GST_BUFFER_DURATION_IS_VALID (buffer) &&
885       GST_CLOCK_TIME_IS_VALID (parse->priv->frame_duration)) {
886     GST_BUFFER_DURATION (buffer) = parse->priv->frame_duration;
887   }
888   return GST_FLOW_OK;
889 }
890
891 /* gst_base_parse_convert:
892  * @parse: #GstBaseParse.
893  * @src_format: #GstFormat describing the source format.
894  * @src_value: Source value to be converted.
895  * @dest_format: #GstFormat defining the converted format.
896  * @dest_value: Pointer where the conversion result will be put.
897  *
898  * Converts using configured "convert" vmethod in #GstBaseParse class.
899  *
900  * Returns: TRUE if conversion was successful.
901  */
902 static gboolean
903 gst_base_parse_convert (GstBaseParse * parse,
904     GstFormat src_format,
905     gint64 src_value, GstFormat dest_format, gint64 * dest_value)
906 {
907   GstBaseParseClass *klass = GST_BASE_PARSE_GET_CLASS (parse);
908   gboolean ret;
909
910   g_return_val_if_fail (dest_value != NULL, FALSE);
911
912   if (!klass->convert)
913     return FALSE;
914
915   ret = klass->convert (parse, src_format, src_value, dest_format, dest_value);
916
917 #ifndef GST_DISABLE_GST_DEBUG
918   {
919     if (ret) {
920       if (src_format == GST_FORMAT_TIME && dest_format == GST_FORMAT_BYTES) {
921         GST_LOG_OBJECT (parse,
922             "TIME -> BYTES: %" GST_TIME_FORMAT " -> %" G_GINT64_FORMAT,
923             GST_TIME_ARGS (src_value), *dest_value);
924       } else if (dest_format == GST_FORMAT_TIME &&
925           src_format == GST_FORMAT_BYTES) {
926         GST_LOG_OBJECT (parse,
927             "BYTES -> TIME: %" G_GINT64_FORMAT " -> %" GST_TIME_FORMAT,
928             src_value, GST_TIME_ARGS (*dest_value));
929       } else {
930         GST_LOG_OBJECT (parse,
931             "%s -> %s: %" G_GINT64_FORMAT " -> %" G_GINT64_FORMAT,
932             GST_STR_NULL (gst_format_get_name (src_format)),
933             GST_STR_NULL (gst_format_get_name (dest_format)),
934             src_value, *dest_value);
935       }
936     } else {
937       GST_DEBUG_OBJECT (parse, "conversion failed");
938     }
939   }
940 #endif
941
942   return ret;
943 }
944
945 /* gst_base_parse_sink_event:
946  * @pad: #GstPad that received the event.
947  * @event: #GstEvent to be handled.
948  *
949  * Handler for sink pad events.
950  *
951  * Returns: TRUE if the event was handled.
952  */
953 static gboolean
954 gst_base_parse_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
955 {
956   GstBaseParse *parse = GST_BASE_PARSE (parent);
957   GstBaseParseClass *bclass = GST_BASE_PARSE_GET_CLASS (parse);
958   gboolean ret;
959
960   ret = bclass->sink_event (parse, event);
961
962   return ret;
963 }
964
965
966 /* gst_base_parse_sink_event_default:
967  * @parse: #GstBaseParse.
968  * @event: #GstEvent to be handled.
969  *
970  * Element-level event handler function.
971  *
972  * The event will be unreffed only if it has been handled and this
973  * function returns %TRUE
974  *
975  * Returns: %TRUE if the event was handled and not need forwarding.
976  */
977 static gboolean
978 gst_base_parse_sink_event_default (GstBaseParse * parse, GstEvent * event)
979 {
980   GstBaseParseClass *klass = GST_BASE_PARSE_GET_CLASS (parse);
981   gboolean ret = FALSE;
982   gboolean forward_immediate = FALSE;
983
984   GST_DEBUG_OBJECT (parse, "handling event %d, %s", GST_EVENT_TYPE (event),
985       GST_EVENT_TYPE_NAME (event));
986
987   switch (GST_EVENT_TYPE (event)) {
988     case GST_EVENT_CAPS:
989     {
990       GstCaps *caps;
991
992       gst_event_parse_caps (event, &caps);
993       GST_DEBUG_OBJECT (parse, "caps: %" GST_PTR_FORMAT, caps);
994
995       if (klass->set_sink_caps)
996         ret = klass->set_sink_caps (parse, caps);
997       else
998         ret = TRUE;
999
1000       /* will send our own caps downstream */
1001       gst_event_unref (event);
1002       event = NULL;
1003       break;
1004     }
1005     case GST_EVENT_SEGMENT:
1006     {
1007       const GstSegment *in_segment;
1008       GstSegment out_segment;
1009       gint64 offset = 0, next_dts;
1010       guint32 seqnum = gst_event_get_seqnum (event);
1011
1012       gst_event_parse_segment (event, &in_segment);
1013       gst_segment_init (&out_segment, GST_FORMAT_TIME);
1014
1015       GST_DEBUG_OBJECT (parse, "segment %" GST_SEGMENT_FORMAT, in_segment);
1016
1017       parse->priv->upstream_format = in_segment->format;
1018       if (in_segment->format == GST_FORMAT_BYTES) {
1019         GstBaseParseSeek *seek = NULL;
1020         GSList *node;
1021
1022         /* stop time is allowed to be open-ended, but not start & pos */
1023         offset = in_segment->time;
1024
1025         GST_OBJECT_LOCK (parse);
1026         for (node = parse->priv->pending_seeks; node; node = node->next) {
1027           GstBaseParseSeek *tmp = node->data;
1028
1029           if (tmp->offset == offset) {
1030             seek = tmp;
1031             break;
1032           }
1033         }
1034         parse->priv->pending_seeks =
1035             g_slist_remove (parse->priv->pending_seeks, seek);
1036         GST_OBJECT_UNLOCK (parse);
1037
1038         if (seek) {
1039           GST_DEBUG_OBJECT (parse,
1040               "Matched newsegment to%s seek: %" GST_SEGMENT_FORMAT,
1041               seek->accurate ? " accurate" : "", &seek->segment);
1042
1043           out_segment.start = seek->segment.start;
1044           out_segment.stop = seek->segment.stop;
1045           out_segment.time = seek->segment.start;
1046
1047           next_dts = seek->start_ts;
1048           parse->priv->exact_position = seek->accurate;
1049           g_free (seek);
1050         } else {
1051           /* best attempt convert */
1052           /* as these are only estimates, stop is kept open-ended to avoid
1053            * premature cutting */
1054           gst_base_parse_convert (parse, GST_FORMAT_BYTES, in_segment->start,
1055               GST_FORMAT_TIME, (gint64 *) & next_dts);
1056
1057           out_segment.start = next_dts;
1058           out_segment.stop = GST_CLOCK_TIME_NONE;
1059           out_segment.time = next_dts;
1060
1061           parse->priv->exact_position = (in_segment->start == 0);
1062         }
1063
1064         gst_event_unref (event);
1065
1066         event = gst_event_new_segment (&out_segment);
1067         gst_event_set_seqnum (event, seqnum);
1068
1069         GST_DEBUG_OBJECT (parse, "Converted incoming segment to TIME. %"
1070             GST_SEGMENT_FORMAT, in_segment);
1071
1072       } else if (in_segment->format != GST_FORMAT_TIME) {
1073         /* Unknown incoming segment format. Output a default open-ended
1074          * TIME segment */
1075         gst_event_unref (event);
1076
1077         out_segment.start = 0;
1078         out_segment.stop = GST_CLOCK_TIME_NONE;
1079         out_segment.time = 0;
1080
1081         event = gst_event_new_segment (&out_segment);
1082         gst_event_set_seqnum (event, seqnum);
1083
1084         next_dts = 0;
1085       } else {
1086         /* not considered BYTE seekable if it is talking to us in TIME,
1087          * whatever else it might claim */
1088         parse->priv->upstream_seekable = FALSE;
1089         next_dts = in_segment->start;
1090       }
1091
1092       memcpy (&parse->segment, &out_segment, sizeof (GstSegment));
1093
1094       /*
1095          gst_segment_set_newsegment (&parse->segment, update, rate,
1096          applied_rate, format, start, stop, start);
1097        */
1098
1099       ret = TRUE;
1100
1101       /* save the segment for later, right before we push a new buffer so that
1102        * the caps are fixed and the next linked element can receive
1103        * the segment but finish the current segment */
1104       GST_DEBUG_OBJECT (parse, "draining current segment");
1105       if (in_segment->rate > 0.0)
1106         gst_base_parse_drain (parse);
1107       else
1108         gst_base_parse_finish_fragment (parse, FALSE);
1109       gst_adapter_clear (parse->priv->adapter);
1110
1111       parse->priv->offset = offset;
1112       parse->priv->sync_offset = offset;
1113       parse->priv->next_dts = next_dts;
1114       parse->priv->next_pts = GST_CLOCK_TIME_NONE;
1115       parse->priv->last_pts = GST_CLOCK_TIME_NONE;
1116       parse->priv->last_dts = GST_CLOCK_TIME_NONE;
1117       parse->priv->prev_pts = GST_CLOCK_TIME_NONE;
1118       parse->priv->prev_dts = GST_CLOCK_TIME_NONE;
1119       parse->priv->discont = TRUE;
1120       parse->priv->seen_keyframe = FALSE;
1121       break;
1122     }
1123
1124     case GST_EVENT_FLUSH_START:
1125       GST_OBJECT_LOCK (parse);
1126       parse->priv->flushing = TRUE;
1127       GST_OBJECT_UNLOCK (parse);
1128       break;
1129
1130     case GST_EVENT_FLUSH_STOP:
1131       gst_adapter_clear (parse->priv->adapter);
1132       gst_base_parse_clear_queues (parse);
1133       parse->priv->flushing = FALSE;
1134       parse->priv->discont = TRUE;
1135       parse->priv->last_pts = GST_CLOCK_TIME_NONE;
1136       parse->priv->last_dts = GST_CLOCK_TIME_NONE;
1137       parse->priv->new_frame = TRUE;
1138
1139       forward_immediate = TRUE;
1140       break;
1141
1142     case GST_EVENT_EOS:
1143       if (parse->segment.rate > 0.0)
1144         gst_base_parse_drain (parse);
1145       else
1146         gst_base_parse_finish_fragment (parse, TRUE);
1147
1148       /* If we STILL have zero frames processed, fire an error */
1149       if (parse->priv->framecount == 0) {
1150         GST_ELEMENT_ERROR (parse, STREAM, WRONG_TYPE,
1151             ("No valid frames found before end of stream"), (NULL));
1152       }
1153       /* newsegment and other serialized events before eos */
1154       gst_base_parse_push_pending_events (parse);
1155
1156       if (parse->priv->framecount < MIN_FRAMES_TO_POST_BITRATE) {
1157         /* We've not posted bitrate tags yet - do so now */
1158         gst_base_parse_post_bitrates (parse, TRUE, TRUE, TRUE);
1159       }
1160       forward_immediate = TRUE;
1161       break;
1162     case GST_EVENT_CUSTOM_DOWNSTREAM:{
1163       /* FIXME: Code duplicated from libgstvideo because core can't depend on -base */
1164 #ifndef GST_VIDEO_EVENT_STILL_STATE_NAME
1165 #define GST_VIDEO_EVENT_STILL_STATE_NAME "GstEventStillFrame"
1166 #endif
1167
1168       const GstStructure *s;
1169       gboolean ev_still_state;
1170
1171       s = gst_event_get_structure (event);
1172       if (s != NULL &&
1173           gst_structure_has_name (s, GST_VIDEO_EVENT_STILL_STATE_NAME) &&
1174           gst_structure_get_boolean (s, "still-state", &ev_still_state)) {
1175         if (ev_still_state) {
1176           GST_DEBUG_OBJECT (parse, "draining current data for still-frame");
1177           if (parse->segment.rate > 0.0)
1178             gst_base_parse_drain (parse);
1179           else
1180             gst_base_parse_finish_fragment (parse, TRUE);
1181         }
1182         forward_immediate = TRUE;
1183       }
1184       break;
1185     }
1186     case GST_EVENT_GAP:
1187     {
1188       GST_DEBUG_OBJECT (parse, "draining current data due to gap event");
1189
1190       gst_base_parse_push_pending_events (parse);
1191
1192       if (parse->segment.rate > 0.0)
1193         gst_base_parse_drain (parse);
1194       else
1195         gst_base_parse_finish_fragment (parse, TRUE);
1196       forward_immediate = TRUE;
1197       break;
1198     }
1199     case GST_EVENT_TAG:
1200       /* See if any bitrate tags were posted */
1201       gst_base_parse_handle_tag (parse, event);
1202       break;
1203
1204     case GST_EVENT_STREAM_START:
1205       if (parse->priv->pad_mode != GST_PAD_MODE_PULL)
1206         forward_immediate = TRUE;
1207       break;
1208
1209     default:
1210       break;
1211   }
1212
1213   /* Forward non-serialized events and EOS/FLUSH_STOP immediately.
1214    * For EOS this is required because no buffer or serialized event
1215    * will come after EOS and nothing could trigger another
1216    * _finish_frame() call.   *
1217    * If the subclass handles sending of EOS manually it can return
1218    * _DROPPED from ::finish() and all other subclasses should have
1219    * decoded/flushed all remaining data before this
1220    *
1221    * For FLUSH_STOP this is required because it is expected
1222    * to be forwarded immediately and no buffers are queued anyway.
1223    */
1224   if (event) {
1225     if (!GST_EVENT_IS_SERIALIZED (event) || forward_immediate) {
1226       ret = gst_pad_push_event (parse->srcpad, event);
1227     } else {
1228       // GST_VIDEO_DECODER_STREAM_LOCK (decoder);
1229       parse->priv->pending_events =
1230           g_list_prepend (parse->priv->pending_events, event);
1231       // GST_VIDEO_DECODER_STREAM_UNLOCK (decoder);
1232       ret = TRUE;
1233     }
1234   }
1235
1236   GST_DEBUG_OBJECT (parse, "event handled");
1237
1238   return ret;
1239 }
1240
1241 static gboolean
1242 gst_base_parse_sink_query_default (GstBaseParse * parse, GstQuery * query)
1243 {
1244   GstPad *pad;
1245   gboolean res;
1246
1247   pad = GST_BASE_PARSE_SINK_PAD (parse);
1248
1249   switch (GST_QUERY_TYPE (query)) {
1250     case GST_QUERY_CAPS:
1251     {
1252       GstBaseParseClass *bclass;
1253
1254       bclass = GST_BASE_PARSE_GET_CLASS (parse);
1255
1256       if (bclass->get_sink_caps) {
1257         GstCaps *caps, *filter;
1258
1259         gst_query_parse_caps (query, &filter);
1260         caps = bclass->get_sink_caps (parse, filter);
1261         GST_LOG_OBJECT (parse, "sink getcaps returning caps %" GST_PTR_FORMAT,
1262             caps);
1263         gst_query_set_caps_result (query, caps);
1264         gst_caps_unref (caps);
1265
1266         res = TRUE;
1267       } else {
1268         GstCaps *caps, *template_caps, *filter;
1269
1270         gst_query_parse_caps (query, &filter);
1271         template_caps = gst_pad_get_pad_template_caps (pad);
1272         if (filter != NULL) {
1273           caps =
1274               gst_caps_intersect_full (filter, template_caps,
1275               GST_CAPS_INTERSECT_FIRST);
1276           gst_caps_unref (template_caps);
1277         } else {
1278           caps = template_caps;
1279         }
1280         gst_query_set_caps_result (query, caps);
1281         gst_caps_unref (caps);
1282
1283         res = TRUE;
1284       }
1285       break;
1286     }
1287     default:
1288     {
1289       res = gst_pad_query_default (pad, GST_OBJECT_CAST (parse), query);
1290       break;
1291     }
1292   }
1293
1294   return res;
1295 }
1296
1297 static gboolean
1298 gst_base_parse_sink_query (GstPad * pad, GstObject * parent, GstQuery * query)
1299 {
1300   GstBaseParseClass *bclass;
1301   GstBaseParse *parse;
1302   gboolean ret;
1303
1304   parse = GST_BASE_PARSE (parent);
1305   bclass = GST_BASE_PARSE_GET_CLASS (parse);
1306
1307   GST_DEBUG_OBJECT (parse, "%s query", GST_QUERY_TYPE_NAME (query));
1308
1309   if (bclass->sink_query)
1310     ret = bclass->sink_query (parse, query);
1311   else
1312     ret = FALSE;
1313
1314   GST_LOG_OBJECT (parse, "%s query result: %d %" GST_PTR_FORMAT,
1315       GST_QUERY_TYPE_NAME (query), ret, query);
1316
1317   return ret;
1318 }
1319
1320 static gboolean
1321 gst_base_parse_src_query (GstPad * pad, GstObject * parent, GstQuery * query)
1322 {
1323   GstBaseParseClass *bclass;
1324   GstBaseParse *parse;
1325   gboolean ret;
1326
1327   parse = GST_BASE_PARSE (parent);
1328   bclass = GST_BASE_PARSE_GET_CLASS (parse);
1329
1330   GST_DEBUG_OBJECT (parse, "%s query: %" GST_PTR_FORMAT,
1331       GST_QUERY_TYPE_NAME (query), query);
1332
1333   if (bclass->src_query)
1334     ret = bclass->src_query (parse, query);
1335   else
1336     ret = FALSE;
1337
1338   GST_LOG_OBJECT (parse, "%s query result: %d %" GST_PTR_FORMAT,
1339       GST_QUERY_TYPE_NAME (query), ret, query);
1340
1341   return ret;
1342 }
1343
1344 /* gst_base_parse_src_event:
1345  * @pad: #GstPad that received the event.
1346  * @event: #GstEvent that was received.
1347  *
1348  * Handler for source pad events.
1349  *
1350  * Returns: TRUE if the event was handled.
1351  */
1352 static gboolean
1353 gst_base_parse_src_event (GstPad * pad, GstObject * parent, GstEvent * event)
1354 {
1355   GstBaseParse *parse;
1356   GstBaseParseClass *bclass;
1357   gboolean ret = TRUE;
1358
1359   parse = GST_BASE_PARSE (parent);
1360   bclass = GST_BASE_PARSE_GET_CLASS (parse);
1361
1362   GST_DEBUG_OBJECT (parse, "event %d, %s", GST_EVENT_TYPE (event),
1363       GST_EVENT_TYPE_NAME (event));
1364
1365   if (bclass->src_event)
1366     ret = bclass->src_event (parse, event);
1367   else
1368     gst_event_unref (event);
1369
1370   return ret;
1371 }
1372
1373 static gboolean
1374 gst_base_parse_is_seekable (GstBaseParse * parse)
1375 {
1376   /* FIXME: could do more here, e.g. check index or just send data from 0
1377    * in pull mode and let decoder/sink clip */
1378   return parse->priv->syncable;
1379 }
1380
1381 /* gst_base_parse_src_event_default:
1382  * @parse: #GstBaseParse.
1383  * @event: #GstEvent that was received.
1384  *
1385  * Default srcpad event handler.
1386  *
1387  * Returns: TRUE if the event was handled and can be dropped.
1388  */
1389 static gboolean
1390 gst_base_parse_src_event_default (GstBaseParse * parse, GstEvent * event)
1391 {
1392   gboolean res = FALSE;
1393
1394   switch (GST_EVENT_TYPE (event)) {
1395     case GST_EVENT_SEEK:
1396       if (gst_base_parse_is_seekable (parse))
1397         res = gst_base_parse_handle_seek (parse, event);
1398       break;
1399     default:
1400       res = gst_pad_event_default (parse->srcpad, GST_OBJECT_CAST (parse),
1401           event);
1402       break;
1403   }
1404   return res;
1405 }
1406
1407
1408 /**
1409  * gst_base_parse_convert_default:
1410  * @parse: #GstBaseParse.
1411  * @src_format: #GstFormat describing the source format.
1412  * @src_value: Source value to be converted.
1413  * @dest_format: #GstFormat defining the converted format.
1414  * @dest_value: Pointer where the conversion result will be put.
1415  *
1416  * Default implementation of "convert" vmethod in #GstBaseParse class.
1417  *
1418  * Returns: TRUE if conversion was successful.
1419  */
1420 gboolean
1421 gst_base_parse_convert_default (GstBaseParse * parse,
1422     GstFormat src_format,
1423     gint64 src_value, GstFormat dest_format, gint64 * dest_value)
1424 {
1425   gboolean ret = FALSE;
1426   guint64 bytes, duration;
1427
1428   if (G_UNLIKELY (src_format == dest_format)) {
1429     *dest_value = src_value;
1430     return TRUE;
1431   }
1432
1433   if (G_UNLIKELY (src_value == -1)) {
1434     *dest_value = -1;
1435     return TRUE;
1436   }
1437
1438   if (G_UNLIKELY (src_value == 0)) {
1439     *dest_value = 0;
1440     return TRUE;
1441   }
1442
1443   /* need at least some frames */
1444   if (!parse->priv->framecount)
1445     goto no_framecount;
1446
1447   duration = parse->priv->acc_duration / GST_MSECOND;
1448   bytes = parse->priv->bytecount;
1449
1450   if (G_UNLIKELY (!duration || !bytes))
1451     goto no_duration_bytes;
1452
1453   if (src_format == GST_FORMAT_BYTES) {
1454     if (dest_format == GST_FORMAT_TIME) {
1455       /* BYTES -> TIME conversion */
1456       GST_DEBUG_OBJECT (parse, "converting bytes -> time");
1457       *dest_value = gst_util_uint64_scale (src_value, duration, bytes);
1458       *dest_value *= GST_MSECOND;
1459       GST_DEBUG_OBJECT (parse, "conversion result: %" G_GINT64_FORMAT " ms",
1460           *dest_value / GST_MSECOND);
1461       ret = TRUE;
1462     } else {
1463       GST_DEBUG_OBJECT (parse, "converting bytes -> other not implemented");
1464     }
1465   } else if (src_format == GST_FORMAT_TIME) {
1466     if (dest_format == GST_FORMAT_BYTES) {
1467       GST_DEBUG_OBJECT (parse, "converting time -> bytes");
1468       *dest_value = gst_util_uint64_scale (src_value / GST_MSECOND, bytes,
1469           duration);
1470       GST_DEBUG_OBJECT (parse,
1471           "time %" G_GINT64_FORMAT " ms in bytes = %" G_GINT64_FORMAT,
1472           src_value / GST_MSECOND, *dest_value);
1473       ret = TRUE;
1474     } else {
1475       GST_DEBUG_OBJECT (parse, "converting time -> other not implemented");
1476     }
1477   } else if (src_format == GST_FORMAT_DEFAULT) {
1478     /* DEFAULT == frame-based */
1479     if (dest_format == GST_FORMAT_TIME) {
1480       GST_DEBUG_OBJECT (parse, "converting default -> time");
1481       if (parse->priv->fps_den) {
1482         *dest_value = gst_util_uint64_scale (src_value,
1483             GST_SECOND * parse->priv->fps_den, parse->priv->fps_num);
1484         ret = TRUE;
1485       }
1486     } else {
1487       GST_DEBUG_OBJECT (parse, "converting default -> other not implemented");
1488     }
1489   } else {
1490     GST_DEBUG_OBJECT (parse, "conversion not implemented");
1491   }
1492   return ret;
1493
1494   /* ERRORS */
1495 no_framecount:
1496   {
1497     GST_DEBUG_OBJECT (parse, "no framecount");
1498     return FALSE;
1499   }
1500 no_duration_bytes:
1501   {
1502     GST_DEBUG_OBJECT (parse, "no duration %" G_GUINT64_FORMAT ", bytes %"
1503         G_GUINT64_FORMAT, duration, bytes);
1504     return FALSE;
1505   }
1506
1507 }
1508
1509 static void
1510 gst_base_parse_update_duration (GstBaseParse * baseparse)
1511 {
1512   GstPad *peer;
1513   GstBaseParse *parse;
1514
1515   parse = GST_BASE_PARSE (baseparse);
1516
1517   peer = gst_pad_get_peer (parse->sinkpad);
1518   if (peer) {
1519     gboolean qres = FALSE;
1520     gint64 ptot, dest_value;
1521
1522     qres = gst_pad_query_duration (peer, GST_FORMAT_BYTES, &ptot);
1523     gst_object_unref (GST_OBJECT (peer));
1524     if (qres) {
1525       if (gst_base_parse_convert (parse, GST_FORMAT_BYTES, ptot,
1526               GST_FORMAT_TIME, &dest_value)) {
1527
1528         /* inform if duration changed, but try to avoid spamming */
1529         parse->priv->estimated_drift +=
1530             dest_value - parse->priv->estimated_duration;
1531         if (parse->priv->estimated_drift > GST_SECOND ||
1532             parse->priv->estimated_drift < -GST_SECOND) {
1533           gst_element_post_message (GST_ELEMENT (parse),
1534               gst_message_new_duration_changed (GST_OBJECT (parse)));
1535           parse->priv->estimated_drift = 0;
1536         }
1537         parse->priv->estimated_duration = dest_value;
1538         GST_LOG_OBJECT (parse,
1539             "updated estimated duration to %" GST_TIME_FORMAT,
1540             GST_TIME_ARGS (dest_value));
1541       }
1542     }
1543   }
1544 }
1545
1546 static void
1547 gst_base_parse_post_bitrates (GstBaseParse * parse, gboolean post_min,
1548     gboolean post_avg, gboolean post_max)
1549 {
1550   GstTagList *taglist = NULL;
1551
1552   if (post_min && parse->priv->post_min_bitrate) {
1553     taglist = gst_tag_list_new_empty ();
1554
1555     gst_tag_list_add (taglist, GST_TAG_MERGE_REPLACE,
1556         GST_TAG_MINIMUM_BITRATE, parse->priv->min_bitrate, NULL);
1557   }
1558
1559   if (post_avg && parse->priv->post_avg_bitrate) {
1560     if (taglist == NULL)
1561       taglist = gst_tag_list_new_empty ();
1562
1563     parse->priv->posted_avg_bitrate = parse->priv->avg_bitrate;
1564     gst_tag_list_add (taglist, GST_TAG_MERGE_REPLACE, GST_TAG_BITRATE,
1565         parse->priv->avg_bitrate, NULL);
1566   }
1567
1568   if (post_max && parse->priv->post_max_bitrate) {
1569     if (taglist == NULL)
1570       taglist = gst_tag_list_new_empty ();
1571
1572     gst_tag_list_add (taglist, GST_TAG_MERGE_REPLACE,
1573         GST_TAG_MAXIMUM_BITRATE, parse->priv->max_bitrate, NULL);
1574   }
1575
1576   GST_DEBUG_OBJECT (parse, "Updated bitrates. Min: %u, Avg: %u, Max: %u",
1577       parse->priv->min_bitrate, parse->priv->avg_bitrate,
1578       parse->priv->max_bitrate);
1579
1580   if (taglist != NULL) {
1581     gst_pad_push_event (parse->srcpad, gst_event_new_tag (taglist));
1582   }
1583 }
1584
1585 /* gst_base_parse_update_bitrates:
1586  * @parse: #GstBaseParse.
1587  * @buffer: Current frame as a #GstBuffer
1588  *
1589  * Keeps track of the minimum and maximum bitrates, and also maintains a
1590  * running average bitrate of the stream so far.
1591  */
1592 static void
1593 gst_base_parse_update_bitrates (GstBaseParse * parse, GstBaseParseFrame * frame)
1594 {
1595   /* Only update the tag on a 10 kbps delta */
1596   static const gint update_threshold = 10000;
1597
1598   guint64 data_len, frame_dur;
1599   gint overhead, frame_bitrate, old_avg_bitrate;
1600   gboolean update_min = FALSE, update_avg = FALSE, update_max = FALSE;
1601   GstBuffer *buffer = frame->buffer;
1602
1603   overhead = frame->overhead;
1604   if (overhead == -1)
1605     return;
1606
1607   data_len = gst_buffer_get_size (buffer) - overhead;
1608   parse->priv->data_bytecount += data_len;
1609
1610   /* duration should be valid by now,
1611    * either set by subclass or maybe based on fps settings */
1612   if (GST_BUFFER_DURATION_IS_VALID (buffer) && parse->priv->acc_duration != 0) {
1613     /* Calculate duration of a frame from buffer properties */
1614     frame_dur = GST_BUFFER_DURATION (buffer);
1615     parse->priv->avg_bitrate = (8 * parse->priv->data_bytecount * GST_SECOND) /
1616         parse->priv->acc_duration;
1617
1618   } else {
1619     /* No way to figure out frame duration (is this even possible?) */
1620     return;
1621   }
1622
1623   /* override if subclass provided bitrate, e.g. metadata based */
1624   if (parse->priv->bitrate) {
1625     parse->priv->avg_bitrate = parse->priv->bitrate;
1626     /* spread this (confirmed) info ASAP */
1627     if (parse->priv->posted_avg_bitrate != parse->priv->avg_bitrate)
1628       gst_base_parse_post_bitrates (parse, FALSE, TRUE, FALSE);
1629   }
1630
1631   if (frame_dur)
1632     frame_bitrate = (8 * data_len * GST_SECOND) / frame_dur;
1633   else
1634     return;
1635
1636   GST_LOG_OBJECT (parse, "frame bitrate %u, avg bitrate %u", frame_bitrate,
1637       parse->priv->avg_bitrate);
1638
1639   if (parse->priv->framecount < MIN_FRAMES_TO_POST_BITRATE) {
1640     goto exit;
1641   } else if (parse->priv->framecount == MIN_FRAMES_TO_POST_BITRATE) {
1642     /* always post all at threshold time */
1643     update_min = update_max = update_avg = TRUE;
1644   }
1645
1646   if (G_LIKELY (parse->priv->framecount >= MIN_FRAMES_TO_POST_BITRATE)) {
1647     if (frame_bitrate < parse->priv->min_bitrate) {
1648       parse->priv->min_bitrate = frame_bitrate;
1649       update_min = TRUE;
1650     }
1651
1652     if (frame_bitrate > parse->priv->max_bitrate) {
1653       parse->priv->max_bitrate = frame_bitrate;
1654       update_max = TRUE;
1655     }
1656
1657     old_avg_bitrate = parse->priv->posted_avg_bitrate;
1658     if ((gint) (old_avg_bitrate - parse->priv->avg_bitrate) > update_threshold
1659         || (gint) (parse->priv->avg_bitrate - old_avg_bitrate) >
1660         update_threshold)
1661       update_avg = TRUE;
1662   }
1663
1664   if ((update_min || update_avg || update_max))
1665     gst_base_parse_post_bitrates (parse, update_min, update_avg, update_max);
1666
1667 exit:
1668   return;
1669 }
1670
1671 /**
1672  * gst_base_parse_add_index_entry:
1673  * @parse: #GstBaseParse.
1674  * @offset: offset of entry
1675  * @ts: timestamp associated with offset
1676  * @key: whether entry refers to keyframe
1677  * @force: add entry disregarding sanity checks
1678  *
1679  * Adds an entry to the index associating @offset to @ts.  It is recommended
1680  * to only add keyframe entries.  @force allows to bypass checks, such as
1681  * whether the stream is (upstream) seekable, another entry is already "close"
1682  * to the new entry, etc.
1683  *
1684  * Returns: #gboolean indicating whether entry was added
1685  */
1686 gboolean
1687 gst_base_parse_add_index_entry (GstBaseParse * parse, guint64 offset,
1688     GstClockTime ts, gboolean key, gboolean force)
1689 {
1690   gboolean ret = FALSE;
1691   GstIndexAssociation associations[2];
1692
1693   GST_LOG_OBJECT (parse, "Adding key=%d index entry %" GST_TIME_FORMAT
1694       " @ offset 0x%08" G_GINT64_MODIFIER "x", key, GST_TIME_ARGS (ts), offset);
1695
1696   if (G_LIKELY (!force)) {
1697
1698     if (!parse->priv->upstream_seekable) {
1699       GST_DEBUG_OBJECT (parse, "upstream not seekable; discarding");
1700       goto exit;
1701     }
1702
1703     /* FIXME need better helper data structure that handles these issues
1704      * related to ongoing collecting of index entries */
1705     if (parse->priv->index_last_offset + parse->priv->idx_byte_interval >=
1706         (gint64) offset) {
1707       GST_LOG_OBJECT (parse,
1708           "already have entries up to offset 0x%08" G_GINT64_MODIFIER "x",
1709           parse->priv->index_last_offset + parse->priv->idx_byte_interval);
1710       goto exit;
1711     }
1712
1713     if (GST_CLOCK_TIME_IS_VALID (parse->priv->index_last_ts) &&
1714         GST_CLOCK_DIFF (parse->priv->index_last_ts, ts) <
1715         parse->priv->idx_interval) {
1716       GST_LOG_OBJECT (parse, "entry too close to last time %" GST_TIME_FORMAT,
1717           GST_TIME_ARGS (parse->priv->index_last_ts));
1718       goto exit;
1719     }
1720
1721     /* if last is not really the last one */
1722     if (!parse->priv->index_last_valid) {
1723       GstClockTime prev_ts;
1724
1725       gst_base_parse_find_offset (parse, ts, TRUE, &prev_ts);
1726       if (GST_CLOCK_DIFF (prev_ts, ts) < parse->priv->idx_interval) {
1727         GST_LOG_OBJECT (parse,
1728             "entry too close to existing entry %" GST_TIME_FORMAT,
1729             GST_TIME_ARGS (prev_ts));
1730         parse->priv->index_last_offset = offset;
1731         parse->priv->index_last_ts = ts;
1732         goto exit;
1733       }
1734     }
1735   }
1736
1737   associations[0].format = GST_FORMAT_TIME;
1738   associations[0].value = ts;
1739   associations[1].format = GST_FORMAT_BYTES;
1740   associations[1].value = offset;
1741
1742   /* index might change on-the-fly, although that would be nutty app ... */
1743   GST_BASE_PARSE_INDEX_LOCK (parse);
1744   gst_index_add_associationv (parse->priv->index, parse->priv->index_id,
1745       (key) ? GST_INDEX_ASSOCIATION_FLAG_KEY_UNIT :
1746       GST_INDEX_ASSOCIATION_FLAG_DELTA_UNIT, 2,
1747       (const GstIndexAssociation *) &associations);
1748   GST_BASE_PARSE_INDEX_UNLOCK (parse);
1749
1750   if (key) {
1751     parse->priv->index_last_offset = offset;
1752     parse->priv->index_last_ts = ts;
1753   }
1754
1755   ret = TRUE;
1756
1757 exit:
1758   return ret;
1759 }
1760
1761 /* check for seekable upstream, above and beyond a mere query */
1762 static void
1763 gst_base_parse_check_seekability (GstBaseParse * parse)
1764 {
1765   GstQuery *query;
1766   gboolean seekable = FALSE;
1767   gint64 start = -1, stop = -1;
1768   guint idx_interval = 0;
1769   guint64 idx_byte_interval = 0;
1770
1771   query = gst_query_new_seeking (GST_FORMAT_BYTES);
1772   if (!gst_pad_peer_query (parse->sinkpad, query)) {
1773     GST_DEBUG_OBJECT (parse, "seeking query failed");
1774     goto done;
1775   }
1776
1777   gst_query_parse_seeking (query, NULL, &seekable, &start, &stop);
1778
1779   /* try harder to query upstream size if we didn't get it the first time */
1780   if (seekable && stop == -1) {
1781     GST_DEBUG_OBJECT (parse, "doing duration query to fix up unset stop");
1782     gst_pad_peer_query_duration (parse->sinkpad, GST_FORMAT_BYTES, &stop);
1783   }
1784
1785   /* if upstream doesn't know the size, it's likely that it's not seekable in
1786    * practice even if it technically may be seekable */
1787   if (seekable && (start != 0 || stop <= start)) {
1788     GST_DEBUG_OBJECT (parse, "seekable but unknown start/stop -> disable");
1789     seekable = FALSE;
1790   }
1791
1792   /* let's not put every single frame into our index */
1793   if (seekable) {
1794     if (stop < 10 * 1024 * 1024)
1795       idx_interval = 100;
1796     else if (stop < 100 * 1024 * 1024)
1797       idx_interval = 500;
1798     else
1799       idx_interval = 1000;
1800
1801     /* ensure that even for large files (e.g. very long audio files), the index
1802      * stays reasonably-size, with some arbitrary limit to the total number of
1803      * index entries */
1804     idx_byte_interval = (stop - start) / MAX_INDEX_ENTRIES;
1805     GST_DEBUG_OBJECT (parse,
1806         "Limiting index entries to %d, indexing byte interval %"
1807         G_GUINT64_FORMAT " bytes", MAX_INDEX_ENTRIES, idx_byte_interval);
1808   }
1809
1810 done:
1811   gst_query_unref (query);
1812
1813   GST_DEBUG_OBJECT (parse, "seekable: %d (%" G_GUINT64_FORMAT " - %"
1814       G_GUINT64_FORMAT ")", seekable, start, stop);
1815   parse->priv->upstream_seekable = seekable;
1816   parse->priv->upstream_size = seekable ? stop : 0;
1817
1818   GST_DEBUG_OBJECT (parse, "idx_interval: %ums", idx_interval);
1819   parse->priv->idx_interval = idx_interval * GST_MSECOND;
1820   parse->priv->idx_byte_interval = idx_byte_interval;
1821 }
1822
1823 /* some misc checks on upstream */
1824 static void
1825 gst_base_parse_check_upstream (GstBaseParse * parse)
1826 {
1827   gint64 stop;
1828
1829   if (gst_pad_peer_query_duration (parse->sinkpad, GST_FORMAT_TIME, &stop))
1830     if (GST_CLOCK_TIME_IS_VALID (stop) && stop) {
1831       /* upstream has one, accept it also, and no further updates */
1832       gst_base_parse_set_duration (parse, GST_FORMAT_TIME, stop, 0);
1833       parse->priv->upstream_has_duration = TRUE;
1834     }
1835
1836   GST_DEBUG_OBJECT (parse, "upstream_has_duration: %d",
1837       parse->priv->upstream_has_duration);
1838 }
1839
1840 /* checks src caps to determine if dealing with audio or video */
1841 /* TODO maybe forego automagic stuff and let subclass configure it ? */
1842 static void
1843 gst_base_parse_check_media (GstBaseParse * parse)
1844 {
1845   GstCaps *caps;
1846   GstStructure *s;
1847
1848   caps = gst_pad_get_current_caps (parse->srcpad);
1849   if (G_LIKELY (caps) && (s = gst_caps_get_structure (caps, 0))) {
1850     parse->priv->is_video =
1851         g_str_has_prefix (gst_structure_get_name (s), "video");
1852   } else {
1853     /* historical default */
1854     parse->priv->is_video = FALSE;
1855   }
1856   if (caps)
1857     gst_caps_unref (caps);
1858
1859   parse->priv->checked_media = TRUE;
1860   GST_DEBUG_OBJECT (parse, "media is video: %d", parse->priv->is_video);
1861 }
1862
1863 /* takes ownership of frame */
1864 static void
1865 gst_base_parse_queue_frame (GstBaseParse * parse, GstBaseParseFrame * frame)
1866 {
1867   if (!(frame->_private_flags & GST_BASE_PARSE_FRAME_PRIVATE_FLAG_NOALLOC)) {
1868     /* frame allocated on the heap, we can just take ownership */
1869     g_queue_push_tail (&parse->priv->queued_frames, frame);
1870     GST_TRACE ("queued frame %p", frame);
1871   } else {
1872     GstBaseParseFrame *copy;
1873
1874     /* probably allocated on the stack, must make a proper copy */
1875     copy = gst_base_parse_frame_copy (frame);
1876     g_queue_push_tail (&parse->priv->queued_frames, copy);
1877     GST_TRACE ("queued frame %p (copy of %p)", copy, frame);
1878     gst_base_parse_frame_free (frame);
1879   }
1880 }
1881
1882 /* makes sure that @buf is properly prepared and decorated for passing
1883  * to baseclass, and an equally setup frame is returned setup with @buf.
1884  * Takes ownership of @buf. */
1885 static GstBaseParseFrame *
1886 gst_base_parse_prepare_frame (GstBaseParse * parse, GstBuffer * buffer)
1887 {
1888   GstBaseParseFrame *frame = NULL;
1889
1890   buffer = gst_buffer_make_writable (buffer);
1891
1892   GST_LOG_OBJECT (parse,
1893       "preparing frame at offset %" G_GUINT64_FORMAT
1894       " (%#" G_GINT64_MODIFIER "x) of size %" G_GSIZE_FORMAT,
1895       GST_BUFFER_OFFSET (buffer), GST_BUFFER_OFFSET (buffer),
1896       gst_buffer_get_size (buffer));
1897
1898   if (parse->priv->discont) {
1899     GST_DEBUG_OBJECT (parse, "marking DISCONT");
1900     GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_DISCONT);
1901     parse->priv->discont = FALSE;
1902   }
1903
1904   GST_BUFFER_OFFSET (buffer) = parse->priv->offset;
1905
1906   frame = gst_base_parse_frame_new (buffer, 0, 0);
1907
1908   /* also ensure to update state flags */
1909   gst_base_parse_frame_update (parse, frame, buffer);
1910   gst_buffer_unref (buffer);
1911
1912   if (parse->priv->prev_offset != parse->priv->offset || parse->priv->new_frame) {
1913     GST_LOG_OBJECT (parse, "marking as new frame");
1914     parse->priv->new_frame = FALSE;
1915     frame->flags |= GST_BASE_PARSE_FRAME_FLAG_NEW_FRAME;
1916   }
1917
1918   frame->offset = parse->priv->prev_offset = parse->priv->offset;
1919
1920   /* use default handler to provide initial (upstream) metadata */
1921   gst_base_parse_parse_frame (parse, frame);
1922
1923   return frame;
1924 }
1925
1926 /* Wraps buffer in a frame and dispatches to subclass.
1927  * Also manages data skipping and offset handling (including adapter flushing).
1928  * Takes ownership of @buffer */
1929 static GstFlowReturn
1930 gst_base_parse_handle_buffer (GstBaseParse * parse, GstBuffer * buffer,
1931     gint * skip, gint * flushed)
1932 {
1933   GstBaseParseClass *klass = GST_BASE_PARSE_GET_CLASS (parse);
1934   GstBaseParseFrame *frame;
1935   GstFlowReturn ret;
1936
1937   g_return_val_if_fail (skip != NULL || flushed != NULL, GST_FLOW_ERROR);
1938
1939   GST_LOG_OBJECT (parse,
1940       "handling buffer of size %" G_GSIZE_FORMAT " with dts %" GST_TIME_FORMAT
1941       ", pts %" GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT,
1942       gst_buffer_get_size (buffer), GST_TIME_ARGS (GST_BUFFER_DTS (buffer)),
1943       GST_TIME_ARGS (GST_BUFFER_PTS (buffer)),
1944       GST_TIME_ARGS (GST_BUFFER_DURATION (buffer)));
1945
1946   /* track what is being flushed during this single round of frame processing */
1947   parse->priv->flushed = 0;
1948   *skip = 0;
1949
1950   /* make it easy for _finish_frame to pick up input data */
1951   if (parse->priv->pad_mode == GST_PAD_MODE_PULL) {
1952     gst_buffer_ref (buffer);
1953     gst_adapter_push (parse->priv->adapter, buffer);
1954   }
1955
1956   frame = gst_base_parse_prepare_frame (parse, buffer);
1957   ret = klass->handle_frame (parse, frame, skip);
1958
1959   *flushed = parse->priv->flushed;
1960
1961   GST_LOG_OBJECT (parse, "handle_frame skipped %d, flushed %d",
1962       *skip, *flushed);
1963
1964   /* subclass can only do one of these, or semantics are too unclear */
1965   g_assert (*skip == 0 || *flushed == 0);
1966
1967   /* track skipping */
1968   if (*skip > 0) {
1969     GstClockTime pts, dts;
1970     GstBuffer *outbuf;
1971
1972     GST_LOG_OBJECT (parse, "finding sync, skipping %d bytes", *skip);
1973     if (parse->segment.rate < 0.0 && !parse->priv->buffers_queued) {
1974       /* reverse playback, and no frames found yet, so we are skipping
1975        * the leading part of a fragment, which may form the tail of
1976        * fragment coming later, hopefully subclass skips efficiently ... */
1977       pts = gst_adapter_prev_pts (parse->priv->adapter, NULL);
1978       dts = gst_adapter_prev_dts (parse->priv->adapter, NULL);
1979       outbuf = gst_adapter_take_buffer (parse->priv->adapter, *skip);
1980       outbuf = gst_buffer_make_writable (outbuf);
1981       GST_BUFFER_PTS (outbuf) = pts;
1982       GST_BUFFER_DTS (outbuf) = dts;
1983       parse->priv->buffers_head =
1984           g_slist_prepend (parse->priv->buffers_head, outbuf);
1985       outbuf = NULL;
1986     } else {
1987       gst_adapter_flush (parse->priv->adapter, *skip);
1988     }
1989     if (!parse->priv->discont)
1990       parse->priv->sync_offset = parse->priv->offset;
1991     parse->priv->offset += *skip;
1992     parse->priv->discont = TRUE;
1993     /* check for indefinite skipping */
1994     if (ret == GST_FLOW_OK)
1995       ret = gst_base_parse_check_sync (parse);
1996   }
1997
1998   parse->priv->offset += *flushed;
1999
2000   if (parse->priv->pad_mode == GST_PAD_MODE_PULL) {
2001     gst_adapter_clear (parse->priv->adapter);
2002   }
2003
2004   gst_base_parse_frame_free (frame);
2005
2006   return ret;
2007 }
2008
2009 /* gst_base_parse_push_pending_events:
2010  * @parse: #GstBaseParse
2011  *
2012  * Pushes the pending events
2013  */
2014 static void
2015 gst_base_parse_push_pending_events (GstBaseParse * parse)
2016 {
2017   if (G_UNLIKELY (parse->priv->pending_events)) {
2018     GList *r = g_list_reverse (parse->priv->pending_events);
2019     GList *l;
2020
2021     parse->priv->pending_events = NULL;
2022     for (l = r; l != NULL; l = l->next) {
2023       gst_pad_push_event (parse->srcpad, GST_EVENT_CAST (l->data));
2024     }
2025     g_list_free (r);
2026   }
2027 }
2028
2029 /* gst_base_parse_handle_and_push_frame:
2030  * @parse: #GstBaseParse.
2031  * @klass: #GstBaseParseClass.
2032  * @frame: (transfer full): a #GstBaseParseFrame
2033  *
2034  * Parses the frame from given buffer and pushes it forward. Also performs
2035  * timestamp handling and checks the segment limits.
2036  *
2037  * This is called with srcpad STREAM_LOCK held.
2038  *
2039  * Returns: #GstFlowReturn
2040  */
2041 static GstFlowReturn
2042 gst_base_parse_handle_and_push_frame (GstBaseParse * parse,
2043     GstBaseParseFrame * frame)
2044 {
2045   gint64 offset;
2046   GstBuffer *buffer;
2047
2048   g_return_val_if_fail (frame != NULL, GST_FLOW_ERROR);
2049
2050   buffer = frame->buffer;
2051   offset = frame->offset;
2052
2053   /* check if subclass/format can provide ts.
2054    * If so, that allows and enables extra seek and duration determining options */
2055   if (G_UNLIKELY (parse->priv->first_frame_offset < 0)) {
2056     if (GST_BUFFER_PTS_IS_VALID (buffer) && parse->priv->has_timing_info
2057         && parse->priv->pad_mode == GST_PAD_MODE_PULL) {
2058       parse->priv->first_frame_offset = offset;
2059       parse->priv->first_frame_pts = GST_BUFFER_PTS (buffer);
2060       parse->priv->first_frame_dts = GST_BUFFER_DTS (buffer);
2061       GST_DEBUG_OBJECT (parse, "subclass provided dts %" GST_TIME_FORMAT
2062           ", pts %" GST_TIME_FORMAT " for first frame at offset %"
2063           G_GINT64_FORMAT, GST_TIME_ARGS (parse->priv->first_frame_dts),
2064           GST_TIME_ARGS (parse->priv->first_frame_pts),
2065           parse->priv->first_frame_offset);
2066       if (!GST_CLOCK_TIME_IS_VALID (parse->priv->duration)) {
2067         gint64 off;
2068         GstClockTime last_ts = G_MAXINT64;
2069
2070         GST_DEBUG_OBJECT (parse, "no duration; trying scan to determine");
2071         gst_base_parse_locate_time (parse, &last_ts, &off);
2072         if (GST_CLOCK_TIME_IS_VALID (last_ts))
2073           gst_base_parse_set_duration (parse, GST_FORMAT_TIME, last_ts, 0);
2074       }
2075     } else {
2076       /* disable further checks */
2077       parse->priv->first_frame_offset = 0;
2078     }
2079   }
2080
2081   /* track upstream time if provided, not subclass' internal notion of it */
2082   if (parse->priv->upstream_format == GST_FORMAT_TIME) {
2083     GST_BUFFER_PTS (frame->buffer) = GST_CLOCK_TIME_NONE;
2084     GST_BUFFER_DTS (frame->buffer) = GST_CLOCK_TIME_NONE;
2085   }
2086
2087   /* interpolating and no valid pts yet,
2088    * start with dts and carry on from there */
2089   if (parse->priv->infer_ts && parse->priv->pts_interpolate
2090       && !GST_CLOCK_TIME_IS_VALID (parse->priv->next_pts))
2091     parse->priv->next_pts = parse->priv->next_dts;
2092
2093   /* again use default handler to add missing metadata;
2094    * we may have new information on frame properties */
2095   gst_base_parse_parse_frame (parse, frame);
2096
2097   parse->priv->next_pts = GST_CLOCK_TIME_NONE;
2098   if (GST_BUFFER_DTS_IS_VALID (buffer) && GST_BUFFER_DURATION_IS_VALID (buffer)) {
2099     parse->priv->next_dts =
2100         GST_BUFFER_DTS (buffer) + GST_BUFFER_DURATION (buffer);
2101     if (parse->priv->pts_interpolate && GST_BUFFER_PTS_IS_VALID (buffer)) {
2102       GstClockTime next_pts =
2103           GST_BUFFER_PTS (buffer) + GST_BUFFER_DURATION (buffer);
2104       if (next_pts >= parse->priv->next_dts)
2105         parse->priv->next_pts = next_pts;
2106     }
2107   } else {
2108     /* we lost track, do not produce bogus time next time around
2109      * (probably means parser subclass has given up on parsing as well) */
2110     GST_DEBUG_OBJECT (parse, "no next fallback timestamp");
2111     parse->priv->next_dts = GST_CLOCK_TIME_NONE;
2112   }
2113
2114   if (parse->priv->upstream_seekable && parse->priv->exact_position &&
2115       GST_BUFFER_PTS_IS_VALID (buffer))
2116     gst_base_parse_add_index_entry (parse, offset,
2117         GST_BUFFER_PTS (buffer),
2118         !GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_DELTA_UNIT), FALSE);
2119
2120   /* All OK, push queued frames if there are any */
2121   if (G_UNLIKELY (!g_queue_is_empty (&parse->priv->queued_frames))) {
2122     GstBaseParseFrame *queued_frame;
2123
2124     while ((queued_frame = g_queue_pop_head (&parse->priv->queued_frames))) {
2125       gst_base_parse_push_frame (parse, queued_frame);
2126     }
2127   }
2128
2129   return gst_base_parse_push_frame (parse, frame);
2130 }
2131
2132 /**
2133  * gst_base_parse_push_frame:
2134  * @parse: #GstBaseParse.
2135  * @frame: (transfer none): a #GstBaseParseFrame
2136  *
2137  * Pushes the frame's buffer downstream, sends any pending events and
2138  * does some timestamp and segment handling. Takes ownership of
2139  * frame's buffer, though caller retains ownership of @frame.
2140  *
2141  * This must be called with sinkpad STREAM_LOCK held.
2142  *
2143  * Returns: #GstFlowReturn
2144  */
2145 GstFlowReturn
2146 gst_base_parse_push_frame (GstBaseParse * parse, GstBaseParseFrame * frame)
2147 {
2148   GstFlowReturn ret = GST_FLOW_OK;
2149   GstClockTime last_start = GST_CLOCK_TIME_NONE;
2150   GstClockTime last_stop = GST_CLOCK_TIME_NONE;
2151   GstBaseParseClass *klass = GST_BASE_PARSE_GET_CLASS (parse);
2152   GstBuffer *buffer;
2153   gsize size;
2154
2155   g_return_val_if_fail (frame != NULL, GST_FLOW_ERROR);
2156   g_return_val_if_fail (frame->buffer != NULL, GST_FLOW_ERROR);
2157
2158   GST_TRACE_OBJECT (parse, "pushing frame %p", frame);
2159
2160   buffer = frame->buffer;
2161
2162   GST_LOG_OBJECT (parse,
2163       "processing buffer of size %" G_GSIZE_FORMAT " with dts %" GST_TIME_FORMAT
2164       ", pts %" GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT,
2165       gst_buffer_get_size (buffer),
2166       GST_TIME_ARGS (GST_BUFFER_DTS (buffer)),
2167       GST_TIME_ARGS (GST_BUFFER_PTS (buffer)),
2168       GST_TIME_ARGS (GST_BUFFER_DURATION (buffer)));
2169
2170   /* update stats */
2171   parse->priv->bytecount += frame->size;
2172   if (G_LIKELY (!(frame->flags & GST_BASE_PARSE_FRAME_FLAG_NO_FRAME))) {
2173     parse->priv->framecount++;
2174     if (GST_BUFFER_DURATION_IS_VALID (buffer)) {
2175       parse->priv->acc_duration += GST_BUFFER_DURATION (buffer);
2176     }
2177   }
2178   /* 0 means disabled */
2179   if (parse->priv->update_interval < 0)
2180     parse->priv->update_interval = 50;
2181   else if (parse->priv->update_interval > 0 &&
2182       (parse->priv->framecount % parse->priv->update_interval) == 0)
2183     gst_base_parse_update_duration (parse);
2184
2185   if (GST_BUFFER_PTS_IS_VALID (buffer))
2186     last_start = last_stop = GST_BUFFER_PTS (buffer);
2187   if (last_start != GST_CLOCK_TIME_NONE
2188       && GST_BUFFER_DURATION_IS_VALID (buffer))
2189     last_stop = last_start + GST_BUFFER_DURATION (buffer);
2190
2191   /* should have caps by now */
2192   if (!gst_pad_has_current_caps (parse->srcpad))
2193     goto no_caps;
2194
2195   if (G_UNLIKELY (!parse->priv->checked_media)) {
2196     /* have caps; check identity */
2197     gst_base_parse_check_media (parse);
2198   }
2199
2200   /* Push pending events, including SEGMENT events */
2201   gst_base_parse_push_pending_events (parse);
2202
2203   /* segment adjustment magic; only if we are running the whole show */
2204   if (!parse->priv->passthrough && parse->segment.rate > 0.0 &&
2205       (parse->priv->pad_mode == GST_PAD_MODE_PULL ||
2206           parse->priv->upstream_seekable)) {
2207     /* handle gaps */
2208     if (GST_CLOCK_TIME_IS_VALID (parse->segment.position) &&
2209         GST_CLOCK_TIME_IS_VALID (last_start)) {
2210       GstClockTimeDiff diff;
2211
2212       /* only send newsegments with increasing start times,
2213        * otherwise if these go back and forth downstream (sinks) increase
2214        * accumulated time and running_time */
2215       diff = GST_CLOCK_DIFF (parse->segment.position, last_start);
2216       if (G_UNLIKELY (diff > 2 * GST_SECOND
2217               && last_start > parse->segment.start
2218               && (!GST_CLOCK_TIME_IS_VALID (parse->segment.stop)
2219                   || last_start < parse->segment.stop))) {
2220
2221         GST_DEBUG_OBJECT (parse,
2222             "Gap of %" G_GINT64_FORMAT " ns detected in stream " "(%"
2223             GST_TIME_FORMAT " -> %" GST_TIME_FORMAT "). "
2224             "Sending updated SEGMENT events", diff,
2225             GST_TIME_ARGS (parse->segment.position),
2226             GST_TIME_ARGS (last_start));
2227
2228         /* skip gap FIXME */
2229         gst_pad_push_event (parse->srcpad,
2230             gst_event_new_segment (&parse->segment));
2231
2232         parse->segment.position = last_start;
2233       }
2234     }
2235   }
2236
2237   /* update bitrates and optionally post corresponding tags
2238    * (following newsegment) */
2239   gst_base_parse_update_bitrates (parse, frame);
2240
2241   if (klass->pre_push_frame) {
2242     ret = klass->pre_push_frame (parse, frame);
2243   } else {
2244     frame->flags |= GST_BASE_PARSE_FRAME_FLAG_CLIP;
2245   }
2246
2247   /* take final ownership of frame buffer */
2248   if (frame->out_buffer) {
2249     buffer = frame->out_buffer;
2250     frame->out_buffer = NULL;
2251     gst_buffer_replace (&frame->buffer, NULL);
2252   } else {
2253     buffer = frame->buffer;
2254     frame->buffer = NULL;
2255   }
2256
2257   /* subclass must play nice */
2258   g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
2259
2260   size = gst_buffer_get_size (buffer);
2261
2262   parse->priv->seen_keyframe |= parse->priv->is_video &&
2263       !GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_DELTA_UNIT);
2264
2265   if (frame->flags & GST_BASE_PARSE_FRAME_FLAG_CLIP) {
2266     if (GST_BUFFER_TIMESTAMP_IS_VALID (buffer) &&
2267         GST_CLOCK_TIME_IS_VALID (parse->segment.stop) &&
2268         GST_BUFFER_TIMESTAMP (buffer) >
2269         parse->segment.stop + parse->priv->lead_out_ts) {
2270       GST_LOG_OBJECT (parse, "Dropped frame, after segment");
2271       ret = GST_FLOW_EOS;
2272     } else if (GST_BUFFER_TIMESTAMP_IS_VALID (buffer) &&
2273         GST_BUFFER_DURATION_IS_VALID (buffer) &&
2274         GST_CLOCK_TIME_IS_VALID (parse->segment.start) &&
2275         GST_BUFFER_TIMESTAMP (buffer) + GST_BUFFER_DURATION (buffer) +
2276         parse->priv->lead_in_ts < parse->segment.start) {
2277       if (parse->priv->seen_keyframe) {
2278         GST_LOG_OBJECT (parse, "Frame before segment, after keyframe");
2279         ret = GST_FLOW_OK;
2280       } else {
2281         GST_LOG_OBJECT (parse, "Dropped frame, before segment");
2282         ret = GST_BASE_PARSE_FLOW_DROPPED;
2283       }
2284     } else {
2285       ret = GST_FLOW_OK;
2286     }
2287   }
2288
2289   if (ret == GST_BASE_PARSE_FLOW_DROPPED) {
2290     GST_LOG_OBJECT (parse, "frame (%" G_GSIZE_FORMAT " bytes) dropped", size);
2291     gst_buffer_unref (buffer);
2292     ret = GST_FLOW_OK;
2293   } else if (ret == GST_FLOW_OK) {
2294     if (parse->segment.rate > 0.0) {
2295       GST_LOG_OBJECT (parse, "pushing frame (%" G_GSIZE_FORMAT " bytes) now..",
2296           size);
2297       ret = gst_pad_push (parse->srcpad, buffer);
2298       GST_LOG_OBJECT (parse, "frame pushed, flow %s", gst_flow_get_name (ret));
2299     } else {
2300       GST_LOG_OBJECT (parse, "frame (%" G_GSIZE_FORMAT " bytes) queued for now",
2301           size);
2302       parse->priv->buffers_queued =
2303           g_slist_prepend (parse->priv->buffers_queued, buffer);
2304       ret = GST_FLOW_OK;
2305     }
2306   } else {
2307     GST_LOG_OBJECT (parse, "frame (%" G_GSIZE_FORMAT " bytes) not pushed: %s",
2308         size, gst_flow_get_name (ret));
2309     gst_buffer_unref (buffer);
2310     /* if we are not sufficiently in control, let upstream decide on EOS */
2311     if (ret == GST_FLOW_EOS && !parse->priv->disable_passthrough &&
2312         (parse->priv->passthrough ||
2313             (parse->priv->pad_mode == GST_PAD_MODE_PUSH &&
2314                 !parse->priv->upstream_seekable)))
2315       ret = GST_FLOW_OK;
2316   }
2317
2318   /* Update current running segment position */
2319   if (ret == GST_FLOW_OK && last_stop != GST_CLOCK_TIME_NONE &&
2320       parse->segment.position < last_stop)
2321     parse->segment.position = last_stop;
2322
2323   return ret;
2324
2325   /* ERRORS */
2326 no_caps:
2327   {
2328     GST_ELEMENT_ERROR (parse, STREAM, DECODE, ("No caps set"), (NULL));
2329     return GST_FLOW_ERROR;
2330   }
2331 }
2332
2333 /**
2334  * gst_base_parse_finish_frame:
2335  * @parse: a #GstBaseParse
2336  * @frame: a #GstBaseParseFrame
2337  * @size: consumed input data represented by frame
2338  *
2339  * Collects parsed data and pushes this downstream.
2340  * Source pad caps must be set when this is called.
2341  *
2342  * If @frame's out_buffer is set, that will be used as subsequent frame data.
2343  * Otherwise, @size samples will be taken from the input and used for output,
2344  * and the output's metadata (timestamps etc) will be taken as (optionally)
2345  * set by the subclass on @frame's (input) buffer (which is otherwise
2346  * ignored for any but the above purpose/information).
2347  *
2348  * Note that the latter buffer is invalidated by this call, whereas the
2349  * caller retains ownership of @frame.
2350  *
2351  * Returns: a #GstFlowReturn that should be escalated to caller (of caller)
2352  */
2353 GstFlowReturn
2354 gst_base_parse_finish_frame (GstBaseParse * parse, GstBaseParseFrame * frame,
2355     gint size)
2356 {
2357   GstFlowReturn ret = GST_FLOW_OK;
2358
2359   g_return_val_if_fail (frame != NULL, GST_FLOW_ERROR);
2360   g_return_val_if_fail (frame->buffer != NULL, GST_FLOW_ERROR);
2361   g_return_val_if_fail (size > 0 || frame->out_buffer, GST_FLOW_ERROR);
2362   g_return_val_if_fail (gst_adapter_available (parse->priv->adapter) >= size,
2363       GST_FLOW_ERROR);
2364
2365   GST_LOG_OBJECT (parse, "finished frame at offset %" G_GUINT64_FORMAT ", "
2366       "flushing size %d", frame->offset, size);
2367
2368   /* some one-time start-up */
2369   if (G_UNLIKELY (parse->priv->framecount == 0)) {
2370     gst_base_parse_check_seekability (parse);
2371     gst_base_parse_check_upstream (parse);
2372   }
2373
2374   parse->priv->flushed += size;
2375
2376   if (parse->priv->scanning && frame->buffer) {
2377     if (!parse->priv->scanned_frame) {
2378       parse->priv->scanned_frame = gst_base_parse_frame_copy (frame);
2379     }
2380     goto exit;
2381   }
2382
2383   /* either PUSH or PULL mode arranges for adapter data */
2384   /* ensure output buffer */
2385   if (!frame->out_buffer) {
2386     GstBuffer *src, *dest;
2387
2388     frame->out_buffer = gst_adapter_take_buffer (parse->priv->adapter, size);
2389     dest = frame->out_buffer;
2390     src = frame->buffer;
2391     GST_BUFFER_PTS (dest) = GST_BUFFER_PTS (src);
2392     GST_BUFFER_DTS (dest) = GST_BUFFER_DTS (src);
2393     GST_BUFFER_OFFSET (dest) = GST_BUFFER_OFFSET (src);
2394     GST_BUFFER_DURATION (dest) = GST_BUFFER_DURATION (src);
2395     GST_BUFFER_OFFSET_END (dest) = GST_BUFFER_OFFSET_END (src);
2396     GST_MINI_OBJECT_FLAGS (dest) = GST_MINI_OBJECT_FLAGS (src);
2397   } else {
2398     gst_adapter_flush (parse->priv->adapter, size);
2399   }
2400
2401   /* use as input for subsequent processing */
2402   gst_buffer_replace (&frame->buffer, frame->out_buffer);
2403   gst_buffer_unref (frame->out_buffer);
2404   frame->out_buffer = NULL;
2405
2406   /* mark input size consumed */
2407   frame->size = size;
2408
2409   /* subclass might queue frames/data internally if it needs more
2410    * frames to decide on the format, or might request us to queue here. */
2411   if (frame->flags & GST_BASE_PARSE_FRAME_FLAG_DROP) {
2412     gst_buffer_replace (&frame->buffer, NULL);
2413     goto exit;
2414   } else if (frame->flags & GST_BASE_PARSE_FRAME_FLAG_QUEUE) {
2415     GstBaseParseFrame *copy;
2416
2417     copy = gst_base_parse_frame_copy (frame);
2418     copy->flags &= ~GST_BASE_PARSE_FRAME_FLAG_QUEUE;
2419     gst_base_parse_queue_frame (parse, copy);
2420     goto exit;
2421   }
2422
2423   ret = gst_base_parse_handle_and_push_frame (parse, frame);
2424
2425 exit:
2426   return ret;
2427 }
2428
2429 /* gst_base_parse_drain:
2430  *
2431  * Drains the adapter until it is empty. It decreases the min_frame_size to
2432  * match the current adapter size and calls chain method until the adapter
2433  * is emptied or chain returns with error.
2434  */
2435 static void
2436 gst_base_parse_drain (GstBaseParse * parse)
2437 {
2438   guint avail;
2439
2440   GST_DEBUG_OBJECT (parse, "draining");
2441   parse->priv->drain = TRUE;
2442
2443   for (;;) {
2444     avail = gst_adapter_available (parse->priv->adapter);
2445     if (!avail)
2446       break;
2447
2448     if (gst_base_parse_chain (parse->sinkpad, GST_OBJECT_CAST (parse),
2449             NULL) != GST_FLOW_OK) {
2450       break;
2451     }
2452
2453     /* nothing changed, maybe due to truncated frame; break infinite loop */
2454     if (avail == gst_adapter_available (parse->priv->adapter)) {
2455       GST_DEBUG_OBJECT (parse, "no change during draining; flushing");
2456       gst_adapter_clear (parse->priv->adapter);
2457     }
2458   }
2459
2460   parse->priv->drain = FALSE;
2461 }
2462
2463 /* gst_base_parse_send_buffers
2464  *
2465  * Sends buffers collected in send_buffers downstream, and ensures that list
2466  * is empty at the end (errors or not).
2467  */
2468 static GstFlowReturn
2469 gst_base_parse_send_buffers (GstBaseParse * parse)
2470 {
2471   GSList *send = NULL;
2472   GstBuffer *buf;
2473   GstFlowReturn ret = GST_FLOW_OK;
2474
2475   send = parse->priv->buffers_send;
2476
2477   /* send buffers */
2478   while (send) {
2479     buf = GST_BUFFER_CAST (send->data);
2480     GST_LOG_OBJECT (parse, "pushing buffer %p, dts %"
2481         GST_TIME_FORMAT ", pts %" GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT
2482         ", offset %" G_GINT64_FORMAT, buf,
2483         GST_TIME_ARGS (GST_BUFFER_DTS (buf)),
2484         GST_TIME_ARGS (GST_BUFFER_PTS (buf)),
2485         GST_TIME_ARGS (GST_BUFFER_DURATION (buf)), GST_BUFFER_OFFSET (buf));
2486
2487     /* iterate output queue an push downstream */
2488     ret = gst_pad_push (parse->srcpad, buf);
2489     send = g_slist_delete_link (send, send);
2490
2491     /* clear any leftover if error */
2492     if (G_UNLIKELY (ret != GST_FLOW_OK)) {
2493       while (send) {
2494         buf = GST_BUFFER_CAST (send->data);
2495         gst_buffer_unref (buf);
2496         send = g_slist_delete_link (send, send);
2497       }
2498     }
2499   }
2500
2501   parse->priv->buffers_send = send;
2502
2503   return ret;
2504 }
2505
2506 /* gst_base_parse_start_fragment:
2507  *
2508  * Prepares for processing a reverse playback (forward) fragment
2509  * by (re)setting proper state variables.
2510  */
2511 static GstFlowReturn
2512 gst_base_parse_start_fragment (GstBaseParse * parse)
2513 {
2514   GST_LOG_OBJECT (parse, "starting fragment");
2515
2516   /* invalidate so no fall-back timestamping is performed;
2517    * ok if taken from subclass or upstream */
2518   parse->priv->next_pts = GST_CLOCK_TIME_NONE;
2519   parse->priv->prev_pts = GST_CLOCK_TIME_NONE;
2520   parse->priv->next_dts = GST_CLOCK_TIME_NONE;
2521   parse->priv->prev_dts = GST_CLOCK_TIME_NONE;
2522   /* prevent it hanging around stop all the time */
2523   parse->segment.position = GST_CLOCK_TIME_NONE;
2524   /* mark next run */
2525   parse->priv->discont = TRUE;
2526
2527   /* head of previous fragment is now pending tail of current fragment */
2528   parse->priv->buffers_pending = parse->priv->buffers_head;
2529   parse->priv->buffers_head = NULL;
2530
2531   return GST_FLOW_OK;
2532 }
2533
2534
2535 /* gst_base_parse_finish_fragment:
2536  *
2537  * Processes a reverse playback (forward) fragment:
2538  * - append head of last fragment that was skipped to current fragment data
2539  * - drain the resulting current fragment data (i.e. repeated chain)
2540  * - add time/duration (if needed) to frames queued by chain
2541  * - push queued data
2542  */
2543 static GstFlowReturn
2544 gst_base_parse_finish_fragment (GstBaseParse * parse, gboolean prev_head)
2545 {
2546   GstBuffer *buf;
2547   GstFlowReturn ret = GST_FLOW_OK;
2548   gboolean seen_key = FALSE, seen_delta = FALSE;
2549
2550   GST_LOG_OBJECT (parse, "finishing fragment");
2551
2552   /* restore order */
2553   parse->priv->buffers_pending = g_slist_reverse (parse->priv->buffers_pending);
2554   while (parse->priv->buffers_pending) {
2555     buf = GST_BUFFER_CAST (parse->priv->buffers_pending->data);
2556     if (prev_head) {
2557       GST_LOG_OBJECT (parse, "adding pending buffer (size %" G_GSIZE_FORMAT ")",
2558           gst_buffer_get_size (buf));
2559       gst_adapter_push (parse->priv->adapter, buf);
2560     } else {
2561       GST_LOG_OBJECT (parse, "discarding head buffer");
2562       gst_buffer_unref (buf);
2563     }
2564     parse->priv->buffers_pending =
2565         g_slist_delete_link (parse->priv->buffers_pending,
2566         parse->priv->buffers_pending);
2567   }
2568
2569   /* chain looks for frames and queues resulting ones (in stead of pushing) */
2570   /* initial skipped data is added to buffers_pending */
2571   gst_base_parse_drain (parse);
2572
2573   if (parse->priv->buffers_send) {
2574     buf = GST_BUFFER_CAST (parse->priv->buffers_send->data);
2575     seen_key |= !GST_BUFFER_FLAG_IS_SET (buf, GST_BUFFER_FLAG_DELTA_UNIT);
2576   }
2577
2578   /* add metadata (if needed to queued buffers */
2579   GST_LOG_OBJECT (parse, "last timestamp: %" GST_TIME_FORMAT,
2580       GST_TIME_ARGS (parse->priv->last_pts));
2581   while (parse->priv->buffers_queued) {
2582     buf = GST_BUFFER_CAST (parse->priv->buffers_queued->data);
2583
2584     /* no touching if upstream or parsing provided time */
2585     if (GST_BUFFER_PTS_IS_VALID (buf)) {
2586       GST_LOG_OBJECT (parse, "buffer has time %" GST_TIME_FORMAT,
2587           GST_TIME_ARGS (GST_BUFFER_PTS (buf)));
2588     } else if (GST_BUFFER_DURATION_IS_VALID (buf)) {
2589       if (GST_CLOCK_TIME_IS_VALID (parse->priv->last_pts)) {
2590         if (G_LIKELY (GST_BUFFER_DURATION (buf) <= parse->priv->last_pts))
2591           parse->priv->last_pts -= GST_BUFFER_DURATION (buf);
2592         else
2593           parse->priv->last_pts = 0;
2594         GST_BUFFER_PTS (buf) = parse->priv->last_pts;
2595         GST_LOG_OBJECT (parse, "applied time %" GST_TIME_FORMAT,
2596             GST_TIME_ARGS (GST_BUFFER_PTS (buf)));
2597       }
2598       if (GST_CLOCK_TIME_IS_VALID (parse->priv->last_dts)) {
2599         if (G_LIKELY (GST_BUFFER_DURATION (buf) <= parse->priv->last_dts))
2600           parse->priv->last_dts -= GST_BUFFER_DURATION (buf);
2601         else
2602           parse->priv->last_dts = 0;
2603         GST_BUFFER_DTS (buf) = parse->priv->last_dts;
2604         GST_LOG_OBJECT (parse, "applied dts %" GST_TIME_FORMAT,
2605             GST_TIME_ARGS (GST_BUFFER_DTS (buf)));
2606       }
2607     } else {
2608       /* no idea, very bad */
2609       GST_WARNING_OBJECT (parse, "could not determine time for buffer");
2610     }
2611
2612     parse->priv->last_pts = GST_BUFFER_PTS (buf);
2613     parse->priv->last_dts = GST_BUFFER_DTS (buf);
2614
2615     /* reverse order for ascending sending */
2616     /* send downstream at keyframe not preceded by a keyframe
2617      * (e.g. that should identify start of collection of IDR nals) */
2618     if (GST_BUFFER_FLAG_IS_SET (buf, GST_BUFFER_FLAG_DELTA_UNIT)) {
2619       if (seen_key) {
2620         ret = gst_base_parse_send_buffers (parse);
2621         /* if a problem, throw all to sending */
2622         if (ret != GST_FLOW_OK) {
2623           parse->priv->buffers_send =
2624               g_slist_reverse (parse->priv->buffers_queued);
2625           parse->priv->buffers_queued = NULL;
2626           break;
2627         }
2628         seen_key = FALSE;
2629       }
2630       seen_delta = TRUE;
2631     } else {
2632       seen_key = TRUE;
2633     }
2634
2635     parse->priv->buffers_send =
2636         g_slist_prepend (parse->priv->buffers_send, buf);
2637     parse->priv->buffers_queued =
2638         g_slist_delete_link (parse->priv->buffers_queued,
2639         parse->priv->buffers_queued);
2640   }
2641
2642   /* audio may have all marked as keyframe, so arrange to send here */
2643   if (!seen_delta)
2644     ret = gst_base_parse_send_buffers (parse);
2645
2646   /* any trailing unused no longer usable (ideally none) */
2647   if (G_UNLIKELY (gst_adapter_available (parse->priv->adapter))) {
2648     GST_DEBUG_OBJECT (parse, "discarding %" G_GSIZE_FORMAT " trailing bytes",
2649         gst_adapter_available (parse->priv->adapter));
2650     gst_adapter_clear (parse->priv->adapter);
2651   }
2652
2653   return ret;
2654 }
2655
2656 /* small helper that checks whether we have been trying to resync too long */
2657 static inline GstFlowReturn
2658 gst_base_parse_check_sync (GstBaseParse * parse)
2659 {
2660   if (G_UNLIKELY (parse->priv->discont &&
2661           parse->priv->offset - parse->priv->sync_offset > 2 * 1024 * 1024)) {
2662     GST_ELEMENT_ERROR (parse, STREAM, DECODE,
2663         ("Failed to parse stream"), (NULL));
2664     return GST_FLOW_ERROR;
2665   }
2666
2667   return GST_FLOW_OK;
2668 }
2669
2670 static GstFlowReturn
2671 gst_base_parse_chain (GstPad * pad, GstObject * parent, GstBuffer * buffer)
2672 {
2673   GstBaseParseClass *bclass;
2674   GstBaseParse *parse;
2675   GstFlowReturn ret = GST_FLOW_OK;
2676   GstBuffer *tmpbuf = NULL;
2677   guint fsize = 1;
2678   gint skip = -1;
2679   const guint8 *data;
2680   guint min_size, av;
2681   GstClockTime pts, dts;
2682
2683   parse = GST_BASE_PARSE (parent);
2684   bclass = GST_BASE_PARSE_GET_CLASS (parse);
2685
2686   if (parse->priv->detecting) {
2687     GstBuffer *detect_buf;
2688
2689     if (parse->priv->detect_buffers_size == 0) {
2690       detect_buf = gst_buffer_ref (buffer);
2691     } else {
2692       GList *l;
2693       guint offset = 0;
2694
2695       detect_buf = gst_buffer_new ();
2696
2697       for (l = parse->priv->detect_buffers; l; l = l->next) {
2698         gsize tmpsize = gst_buffer_get_size (l->data);
2699
2700         gst_buffer_copy_into (detect_buf, GST_BUFFER_CAST (l->data),
2701             GST_BUFFER_COPY_MEMORY, offset, tmpsize);
2702         offset += tmpsize;
2703       }
2704       if (buffer)
2705         gst_buffer_copy_into (detect_buf, buffer, GST_BUFFER_COPY_MEMORY,
2706             offset, gst_buffer_get_size (buffer));
2707     }
2708
2709     ret = bclass->detect (parse, detect_buf);
2710     gst_buffer_unref (detect_buf);
2711
2712     if (ret == GST_FLOW_OK) {
2713       GList *l;
2714
2715       /* Detected something */
2716       parse->priv->detecting = FALSE;
2717
2718       for (l = parse->priv->detect_buffers; l; l = l->next) {
2719         if (ret == GST_FLOW_OK && !parse->priv->flushing)
2720           ret =
2721               gst_base_parse_chain (GST_BASE_PARSE_SINK_PAD (parse),
2722               parent, GST_BUFFER_CAST (l->data));
2723         else
2724           gst_buffer_unref (GST_BUFFER_CAST (l->data));
2725       }
2726       g_list_free (parse->priv->detect_buffers);
2727       parse->priv->detect_buffers = NULL;
2728       parse->priv->detect_buffers_size = 0;
2729
2730       if (ret != GST_FLOW_OK) {
2731         return ret;
2732       }
2733
2734       /* Handle the current buffer */
2735     } else if (ret == GST_FLOW_NOT_NEGOTIATED) {
2736       /* Still detecting, append buffer or error out if draining */
2737
2738       if (parse->priv->drain) {
2739         GST_DEBUG_OBJECT (parse, "Draining but did not detect format yet");
2740         return GST_FLOW_ERROR;
2741       } else if (parse->priv->flushing) {
2742         g_list_foreach (parse->priv->detect_buffers, (GFunc) gst_buffer_unref,
2743             NULL);
2744         g_list_free (parse->priv->detect_buffers);
2745         parse->priv->detect_buffers = NULL;
2746         parse->priv->detect_buffers_size = 0;
2747       } else {
2748         parse->priv->detect_buffers =
2749             g_list_append (parse->priv->detect_buffers, buffer);
2750         parse->priv->detect_buffers_size += gst_buffer_get_size (buffer);
2751         return GST_FLOW_OK;
2752       }
2753     } else {
2754       /* Something went wrong, subclass responsible for error reporting */
2755       return ret;
2756     }
2757
2758     /* And now handle the current buffer if detection worked */
2759   }
2760
2761   if (G_LIKELY (buffer)) {
2762     GST_LOG_OBJECT (parse,
2763         "buffer size: %" G_GSIZE_FORMAT ", offset = %" G_GINT64_FORMAT
2764         ", dts %" GST_TIME_FORMAT ", pts %" GST_TIME_FORMAT,
2765         gst_buffer_get_size (buffer), GST_BUFFER_OFFSET (buffer),
2766         GST_TIME_ARGS (GST_BUFFER_DTS (buffer)),
2767         GST_TIME_ARGS (GST_BUFFER_PTS (buffer)));
2768
2769     if (G_UNLIKELY (!parse->priv->disable_passthrough
2770             && parse->priv->passthrough)) {
2771       GstBaseParseFrame frame;
2772
2773       gst_base_parse_frame_init (&frame);
2774       frame.buffer = gst_buffer_make_writable (buffer);
2775       ret = gst_base_parse_push_frame (parse, &frame);
2776       gst_base_parse_frame_free (&frame);
2777       return ret;
2778     }
2779     /* upstream feeding us in reverse playback;
2780      * finish previous fragment and start new upon DISCONT */
2781     if (parse->segment.rate < 0.0) {
2782       if (G_UNLIKELY (GST_BUFFER_FLAG_IS_SET (buffer, GST_BUFFER_FLAG_DISCONT))) {
2783         GST_DEBUG_OBJECT (parse, "buffer starts new reverse playback fragment");
2784         ret = gst_base_parse_finish_fragment (parse, TRUE);
2785         gst_base_parse_start_fragment (parse);
2786       }
2787     }
2788     gst_adapter_push (parse->priv->adapter, buffer);
2789   }
2790
2791   /* Parse and push as many frames as possible */
2792   /* Stop either when adapter is empty or we are flushing */
2793   while (!parse->priv->flushing) {
2794     gint flush = 0;
2795
2796     /* note: if subclass indicates MAX fsize,
2797      * this will not likely be available anyway ... */
2798     min_size = MAX (parse->priv->min_frame_size, fsize);
2799     av = gst_adapter_available (parse->priv->adapter);
2800
2801     if (G_UNLIKELY (parse->priv->drain)) {
2802       min_size = av;
2803       GST_DEBUG_OBJECT (parse, "draining, data left: %d", min_size);
2804       if (G_UNLIKELY (!min_size)) {
2805         goto done;
2806       }
2807     }
2808
2809     /* Collect at least min_frame_size bytes */
2810     if (av < min_size) {
2811       GST_DEBUG_OBJECT (parse, "not enough data available (only %d bytes)", av);
2812       goto done;
2813     }
2814
2815     /* move along with upstream timestamp (if any),
2816      * but interpolate in between */
2817     pts = gst_adapter_prev_pts (parse->priv->adapter, NULL);
2818     dts = gst_adapter_prev_dts (parse->priv->adapter, NULL);
2819     if (GST_CLOCK_TIME_IS_VALID (pts) && (parse->priv->prev_pts != pts))
2820       parse->priv->prev_pts = parse->priv->next_pts = pts;
2821
2822     if (GST_CLOCK_TIME_IS_VALID (dts) && (parse->priv->prev_dts != dts))
2823       parse->priv->prev_dts = parse->priv->next_dts = dts;
2824
2825     /* we can mess with, erm interpolate, timestamps,
2826      * and incoming stuff has PTS but no DTS seen so far,
2827      * then pick up DTS from PTS and hope for the best ... */
2828     if (parse->priv->infer_ts &&
2829         parse->priv->pts_interpolate &&
2830         !GST_CLOCK_TIME_IS_VALID (dts) &&
2831         !GST_CLOCK_TIME_IS_VALID (parse->priv->prev_dts) &&
2832         GST_CLOCK_TIME_IS_VALID (pts))
2833       parse->priv->next_dts = pts;
2834
2835     /* always pass all available data */
2836     data = gst_adapter_map (parse->priv->adapter, av);
2837     /* arrange for actual data to be copied if subclass tries to,
2838      * since what is passed is tied to the adapter */
2839     tmpbuf = gst_buffer_new_wrapped_full (GST_MEMORY_FLAG_READONLY |
2840         GST_MEMORY_FLAG_NO_SHARE, (gpointer) data, av, 0, av, NULL, NULL);
2841
2842     /* already inform subclass what timestamps we have planned,
2843      * at least if provided by time-based upstream */
2844     if (parse->priv->upstream_format == GST_FORMAT_TIME) {
2845       GST_BUFFER_PTS (tmpbuf) = parse->priv->next_pts;
2846       GST_BUFFER_DTS (tmpbuf) = parse->priv->next_dts;
2847     }
2848
2849     /* keep the adapter mapped, so keep track of what has to be flushed */
2850     ret = gst_base_parse_handle_buffer (parse, tmpbuf, &skip, &flush);
2851     tmpbuf = NULL;
2852
2853     /* probably already implicitly unmapped due to adapter operation,
2854      * but for good measure ... */
2855     gst_adapter_unmap (parse->priv->adapter);
2856     if (ret != GST_FLOW_OK && ret != GST_FLOW_NOT_LINKED) {
2857       goto done;
2858     }
2859     if (skip == 0 && flush == 0) {
2860       GST_LOG_OBJECT (parse, "nothing skipped and no frames finished, "
2861           "breaking to get more data");
2862       goto done;
2863     }
2864   }
2865
2866 done:
2867   GST_LOG_OBJECT (parse, "chain leaving");
2868   return ret;
2869 }
2870
2871 /* pull @size bytes at current offset,
2872  * i.e. at least try to and possibly return a shorter buffer if near the end */
2873 static GstFlowReturn
2874 gst_base_parse_pull_range (GstBaseParse * parse, guint size,
2875     GstBuffer ** buffer)
2876 {
2877   GstFlowReturn ret = GST_FLOW_OK;
2878
2879   g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
2880
2881   /* Caching here actually makes much less difference than one would expect.
2882    * We do it mainly to avoid pulling buffers of 1 byte all the time */
2883   if (parse->priv->cache) {
2884     gint64 cache_offset = GST_BUFFER_OFFSET (parse->priv->cache);
2885     gint cache_size = gst_buffer_get_size (parse->priv->cache);
2886
2887     if (cache_offset <= parse->priv->offset &&
2888         (parse->priv->offset + size) <= (cache_offset + cache_size)) {
2889       *buffer = gst_buffer_copy_region (parse->priv->cache, GST_BUFFER_COPY_ALL,
2890           parse->priv->offset - cache_offset, size);
2891       GST_BUFFER_OFFSET (*buffer) = parse->priv->offset;
2892       return GST_FLOW_OK;
2893     }
2894     /* not enough data in the cache, free cache and get a new one */
2895     gst_buffer_unref (parse->priv->cache);
2896     parse->priv->cache = NULL;
2897   }
2898
2899   /* refill the cache */
2900   ret =
2901       gst_pad_pull_range (parse->sinkpad, parse->priv->offset, MAX (size,
2902           64 * 1024), &parse->priv->cache);
2903   if (ret != GST_FLOW_OK) {
2904     parse->priv->cache = NULL;
2905     return ret;
2906   }
2907
2908   if (gst_buffer_get_size (parse->priv->cache) >= size) {
2909     *buffer =
2910         gst_buffer_copy_region (parse->priv->cache, GST_BUFFER_COPY_ALL, 0,
2911         size);
2912     GST_BUFFER_OFFSET (*buffer) = parse->priv->offset;
2913     return GST_FLOW_OK;
2914   }
2915
2916   /* Not possible to get enough data, try a last time with
2917    * requesting exactly the size we need */
2918   gst_buffer_unref (parse->priv->cache);
2919   parse->priv->cache = NULL;
2920
2921   ret = gst_pad_pull_range (parse->sinkpad, parse->priv->offset, size,
2922       &parse->priv->cache);
2923
2924   if (ret != GST_FLOW_OK) {
2925     GST_DEBUG_OBJECT (parse, "pull_range returned %d", ret);
2926     *buffer = NULL;
2927     return ret;
2928   }
2929
2930   if (gst_buffer_get_size (parse->priv->cache) < size) {
2931     GST_DEBUG_OBJECT (parse, "Returning short buffer at offset %"
2932         G_GUINT64_FORMAT ": wanted %u bytes, got %" G_GSIZE_FORMAT " bytes",
2933         parse->priv->offset, size, gst_buffer_get_size (parse->priv->cache));
2934
2935     *buffer = parse->priv->cache;
2936     parse->priv->cache = NULL;
2937
2938     return GST_FLOW_OK;
2939   }
2940
2941   *buffer =
2942       gst_buffer_copy_region (parse->priv->cache, GST_BUFFER_COPY_ALL, 0, size);
2943   GST_BUFFER_OFFSET (*buffer) = parse->priv->offset;
2944
2945   return GST_FLOW_OK;
2946 }
2947
2948 static GstFlowReturn
2949 gst_base_parse_handle_previous_fragment (GstBaseParse * parse)
2950 {
2951   gint64 offset = 0;
2952   GstClockTime ts = 0;
2953   GstBuffer *buffer;
2954   GstFlowReturn ret;
2955
2956   GST_DEBUG_OBJECT (parse, "fragment ended; last_ts = %" GST_TIME_FORMAT
2957       ", last_offset = %" G_GINT64_FORMAT,
2958       GST_TIME_ARGS (parse->priv->last_pts), parse->priv->last_offset);
2959
2960   if (!parse->priv->last_offset
2961       || parse->priv->last_pts <= parse->segment.start) {
2962     GST_DEBUG_OBJECT (parse, "past start of segment %" GST_TIME_FORMAT,
2963         GST_TIME_ARGS (parse->segment.start));
2964     ret = GST_FLOW_EOS;
2965     goto exit;
2966   }
2967
2968   /* last fragment started at last_offset / last_ts;
2969    * seek back 10s capped at 1MB */
2970   if (parse->priv->last_pts >= 10 * GST_SECOND)
2971     ts = parse->priv->last_pts - 10 * GST_SECOND;
2972   /* if we are exact now, we will be more so going backwards */
2973   if (parse->priv->exact_position) {
2974     offset = gst_base_parse_find_offset (parse, ts, TRUE, NULL);
2975   } else {
2976     if (!gst_base_parse_convert (parse, GST_FORMAT_TIME, ts,
2977             GST_FORMAT_BYTES, &offset)) {
2978       GST_DEBUG_OBJECT (parse, "conversion failed, only BYTE based");
2979     }
2980   }
2981   offset = CLAMP (offset, parse->priv->last_offset - 1024 * 1024,
2982       parse->priv->last_offset - 1024);
2983   offset = MAX (0, offset);
2984
2985   GST_DEBUG_OBJECT (parse, "next fragment from offset %" G_GINT64_FORMAT,
2986       offset);
2987   parse->priv->offset = offset;
2988
2989   ret = gst_base_parse_pull_range (parse, parse->priv->last_offset - offset,
2990       &buffer);
2991   if (ret != GST_FLOW_OK)
2992     goto exit;
2993
2994   /* offset will increase again as fragment is processed/parsed */
2995   parse->priv->last_offset = offset;
2996
2997   gst_base_parse_start_fragment (parse);
2998   gst_adapter_push (parse->priv->adapter, buffer);
2999   ret = gst_base_parse_finish_fragment (parse, TRUE);
3000   if (ret != GST_FLOW_OK)
3001     goto exit;
3002
3003   /* force previous fragment */
3004   parse->priv->offset = -1;
3005
3006 exit:
3007   return ret;
3008 }
3009
3010 /* PULL mode:
3011  * pull and scan for next frame starting from current offset
3012  * ajusts sync, drain and offset going along */
3013 static GstFlowReturn
3014 gst_base_parse_scan_frame (GstBaseParse * parse, GstBaseParseClass * klass)
3015 {
3016   GstBuffer *buffer;
3017   GstFlowReturn ret = GST_FLOW_OK;
3018   guint fsize, min_size;
3019   gint flushed = 0;
3020   gint skip = 0;
3021
3022   GST_LOG_OBJECT (parse, "scanning for frame at offset %" G_GUINT64_FORMAT
3023       " (%#" G_GINT64_MODIFIER "x)", parse->priv->offset, parse->priv->offset);
3024
3025   /* let's make this efficient for all subclass once and for all;
3026    * maybe it does not need this much, but in the latter case, we know we are
3027    * in pull mode here and might as well try to read and supply more anyway
3028    * (so does the buffer caching mechanism) */
3029   fsize = 64 * 1024;
3030
3031   while (TRUE) {
3032     min_size = MAX (parse->priv->min_frame_size, fsize);
3033
3034     GST_LOG_OBJECT (parse, "reading buffer size %u", min_size);
3035
3036     ret = gst_base_parse_pull_range (parse, min_size, &buffer);
3037     if (ret != GST_FLOW_OK)
3038       goto done;
3039
3040     /* if we got a short read, inform subclass we are draining leftover
3041      * and no more is to be expected */
3042     if (gst_buffer_get_size (buffer) < min_size) {
3043       GST_LOG_OBJECT (parse, "... but did not get that; marked draining");
3044       parse->priv->drain = TRUE;
3045     }
3046
3047     if (parse->priv->detecting) {
3048       ret = klass->detect (parse, buffer);
3049       if (ret == GST_FLOW_NOT_NEGOTIATED) {
3050         /* If draining we error out, otherwise request a buffer
3051          * with 64kb more */
3052         if (parse->priv->drain) {
3053           gst_buffer_unref (buffer);
3054           GST_ERROR_OBJECT (parse, "Failed to detect format but draining");
3055           return GST_FLOW_ERROR;
3056         } else {
3057           fsize += 64 * 1024;
3058           gst_buffer_unref (buffer);
3059           continue;
3060         }
3061       } else if (ret != GST_FLOW_OK) {
3062         gst_buffer_unref (buffer);
3063         GST_ERROR_OBJECT (parse, "detect() returned %s",
3064             gst_flow_get_name (ret));
3065         return ret;
3066       }
3067
3068       /* Else handle this buffer normally */
3069     }
3070
3071     ret = gst_base_parse_handle_buffer (parse, buffer, &skip, &flushed);
3072     if (ret != GST_FLOW_OK)
3073       break;
3074
3075     /* something flushed means something happened,
3076      * and we should bail out of this loop so as not to occupy
3077      * the task thread indefinitely */
3078     if (flushed) {
3079       GST_LOG_OBJECT (parse, "frame finished, breaking loop");
3080       break;
3081     }
3082     /* nothing flushed, no skip and draining, so nothing left to do */
3083     if (!skip && parse->priv->drain) {
3084       GST_LOG_OBJECT (parse, "no activity or result when draining; "
3085           "breaking loop and marking EOS");
3086       ret = GST_FLOW_EOS;
3087       break;
3088     }
3089     /* otherwise, get some more data
3090      * note that is checked this does not happen indefinitely */
3091     if (!skip) {
3092       GST_LOG_OBJECT (parse, "getting some more data");
3093       fsize += 64 * 1024;
3094     }
3095     parse->priv->drain = FALSE;
3096   }
3097
3098 done:
3099   return ret;
3100 }
3101
3102 /* Loop that is used in pull mode to retrieve data from upstream */
3103 static void
3104 gst_base_parse_loop (GstPad * pad)
3105 {
3106   GstBaseParse *parse;
3107   GstBaseParseClass *klass;
3108   GstFlowReturn ret = GST_FLOW_OK;
3109
3110   parse = GST_BASE_PARSE (gst_pad_get_parent (pad));
3111   klass = GST_BASE_PARSE_GET_CLASS (parse);
3112
3113   GST_LOG_OBJECT (parse, "Entering parse loop");
3114
3115   if (G_UNLIKELY (parse->priv->push_stream_start)) {
3116     gchar *stream_id;
3117     GstEvent *event;
3118
3119     stream_id =
3120         gst_pad_create_stream_id (parse->srcpad, GST_ELEMENT_CAST (parse),
3121         NULL);
3122
3123     event = gst_event_new_stream_start (stream_id);
3124     gst_event_set_group_id (event, gst_util_group_id_next ());
3125
3126     GST_DEBUG_OBJECT (parse, "Pushing STREAM_START");
3127     gst_pad_push_event (parse->srcpad, event);
3128     parse->priv->push_stream_start = FALSE;
3129     g_free (stream_id);
3130   }
3131
3132   /* reverse playback:
3133    * first fragment (closest to stop time) is handled normally below,
3134    * then we pull in fragments going backwards */
3135   if (parse->segment.rate < 0.0) {
3136     /* check if we jumped back to a previous fragment,
3137      * which is a post-first fragment */
3138     if (parse->priv->offset < 0) {
3139       ret = gst_base_parse_handle_previous_fragment (parse);
3140       goto done;
3141     }
3142   }
3143
3144   ret = gst_base_parse_scan_frame (parse, klass);
3145   if (ret != GST_FLOW_OK)
3146     goto done;
3147
3148   /* eat expected eos signalling past segment in reverse playback */
3149   if (parse->segment.rate < 0.0 && ret == GST_FLOW_EOS &&
3150       parse->segment.position >= parse->segment.stop) {
3151     GST_DEBUG_OBJECT (parse, "downstream has reached end of segment");
3152     /* push what was accumulated during loop run */
3153     gst_base_parse_finish_fragment (parse, FALSE);
3154     /* force previous fragment */
3155     parse->priv->offset = -1;
3156     ret = GST_FLOW_OK;
3157   }
3158
3159 done:
3160   if (ret == GST_FLOW_EOS)
3161     goto eos;
3162   else if (ret != GST_FLOW_OK)
3163     goto pause;
3164
3165   gst_object_unref (parse);
3166   return;
3167
3168   /* ERRORS */
3169 eos:
3170   {
3171     ret = GST_FLOW_EOS;
3172     GST_DEBUG_OBJECT (parse, "eos");
3173     /* fall-through */
3174   }
3175 pause:
3176   {
3177     gboolean push_eos = FALSE;
3178
3179     GST_DEBUG_OBJECT (parse, "pausing task, reason %s",
3180         gst_flow_get_name (ret));
3181     gst_pad_pause_task (parse->sinkpad);
3182
3183     if (ret == GST_FLOW_EOS) {
3184       /* handle end-of-stream/segment */
3185       if (parse->segment.flags & GST_SEGMENT_FLAG_SEGMENT) {
3186         gint64 stop;
3187
3188         if ((stop = parse->segment.stop) == -1)
3189           stop = parse->segment.duration;
3190
3191         GST_DEBUG_OBJECT (parse, "sending segment_done");
3192
3193         gst_element_post_message
3194             (GST_ELEMENT_CAST (parse),
3195             gst_message_new_segment_done (GST_OBJECT_CAST (parse),
3196                 GST_FORMAT_TIME, stop));
3197         gst_pad_push_event (parse->srcpad,
3198             gst_event_new_segment_done (GST_FORMAT_TIME, stop));
3199       } else {
3200         /* If we STILL have zero frames processed, fire an error */
3201         if (parse->priv->framecount == 0) {
3202           GST_ELEMENT_ERROR (parse, STREAM, WRONG_TYPE,
3203               ("No valid frames found before end of stream"), (NULL));
3204         }
3205         push_eos = TRUE;
3206       }
3207     } else if (ret == GST_FLOW_NOT_LINKED || ret < GST_FLOW_EOS) {
3208       /* for fatal errors we post an error message, wrong-state is
3209        * not fatal because it happens due to flushes and only means
3210        * that we should stop now. */
3211       GST_ELEMENT_ERROR (parse, STREAM, FAILED, (NULL),
3212           ("streaming stopped, reason %s", gst_flow_get_name (ret)));
3213       push_eos = TRUE;
3214     }
3215     if (push_eos) {
3216       /* Push pending events, including SEGMENT events */
3217       gst_base_parse_push_pending_events (parse);
3218
3219       gst_pad_push_event (parse->srcpad, gst_event_new_eos ());
3220     }
3221     gst_object_unref (parse);
3222   }
3223 }
3224
3225 static gboolean
3226 gst_base_parse_sink_activate (GstPad * sinkpad, GstObject * parent)
3227 {
3228   GstSchedulingFlags sched_flags;
3229   GstBaseParse *parse;
3230   GstQuery *query;
3231   gboolean pull_mode;
3232
3233   parse = GST_BASE_PARSE (parent);
3234
3235   GST_DEBUG_OBJECT (parse, "sink activate");
3236
3237   query = gst_query_new_scheduling ();
3238   if (!gst_pad_peer_query (sinkpad, query)) {
3239     gst_query_unref (query);
3240     goto baseparse_push;
3241   }
3242
3243   gst_query_parse_scheduling (query, &sched_flags, NULL, NULL, NULL);
3244
3245   pull_mode = gst_query_has_scheduling_mode (query, GST_PAD_MODE_PULL)
3246       && ((sched_flags & GST_SCHEDULING_FLAG_SEEKABLE) != 0);
3247
3248   gst_query_unref (query);
3249
3250   if (!pull_mode)
3251     goto baseparse_push;
3252
3253   GST_DEBUG_OBJECT (parse, "trying to activate in pull mode");
3254   if (!gst_pad_activate_mode (sinkpad, GST_PAD_MODE_PULL, TRUE))
3255     goto baseparse_push;
3256
3257   parse->priv->push_stream_start = TRUE;
3258
3259   return gst_pad_start_task (sinkpad, (GstTaskFunction) gst_base_parse_loop,
3260       sinkpad, NULL);
3261   /* fallback */
3262 baseparse_push:
3263   {
3264     GST_DEBUG_OBJECT (parse, "trying to activate in push mode");
3265     return gst_pad_activate_mode (sinkpad, GST_PAD_MODE_PUSH, TRUE);
3266   }
3267 }
3268
3269 static gboolean
3270 gst_base_parse_activate (GstBaseParse * parse, gboolean active)
3271 {
3272   GstBaseParseClass *klass;
3273   gboolean result = TRUE;
3274
3275   GST_DEBUG_OBJECT (parse, "activate %d", active);
3276
3277   klass = GST_BASE_PARSE_GET_CLASS (parse);
3278
3279   if (active) {
3280     if (parse->priv->pad_mode == GST_PAD_MODE_NONE && klass->start)
3281       result = klass->start (parse);
3282
3283     /* If the subclass implements ::detect we want to
3284      * call it for the first buffers now */
3285     parse->priv->detecting = (klass->detect != NULL);
3286   } else {
3287     /* We must make sure streaming has finished before resetting things
3288      * and calling the ::stop vfunc */
3289     GST_PAD_STREAM_LOCK (parse->sinkpad);
3290     GST_PAD_STREAM_UNLOCK (parse->sinkpad);
3291
3292     if (parse->priv->pad_mode != GST_PAD_MODE_NONE && klass->stop)
3293       result = klass->stop (parse);
3294
3295     parse->priv->pad_mode = GST_PAD_MODE_NONE;
3296   }
3297   GST_DEBUG_OBJECT (parse, "activate return: %d", result);
3298   return result;
3299 }
3300
3301 static gboolean
3302 gst_base_parse_sink_activate_mode (GstPad * pad, GstObject * parent,
3303     GstPadMode mode, gboolean active)
3304 {
3305   gboolean result;
3306   GstBaseParse *parse;
3307
3308   parse = GST_BASE_PARSE (parent);
3309
3310   GST_DEBUG_OBJECT (parse, "sink %sactivate in %s mode",
3311       (active) ? "" : "de", gst_pad_mode_get_name (mode));
3312
3313   if (!gst_base_parse_activate (parse, active))
3314     goto activate_failed;
3315
3316   switch (mode) {
3317     case GST_PAD_MODE_PULL:
3318       if (active) {
3319         parse->priv->pending_events =
3320             g_list_prepend (parse->priv->pending_events,
3321             gst_event_new_segment (&parse->segment));
3322         result = TRUE;
3323       } else {
3324         result = gst_pad_stop_task (pad);
3325       }
3326       break;
3327     default:
3328       result = TRUE;
3329       break;
3330   }
3331   if (result)
3332     parse->priv->pad_mode = active ? mode : GST_PAD_MODE_NONE;
3333
3334   GST_DEBUG_OBJECT (parse, "sink activate return: %d", result);
3335
3336   return result;
3337
3338   /* ERRORS */
3339 activate_failed:
3340   {
3341     GST_DEBUG_OBJECT (parse, "activate failed");
3342     return FALSE;
3343   }
3344 }
3345
3346 /**
3347  * gst_base_parse_set_duration:
3348  * @parse: #GstBaseParse.
3349  * @fmt: #GstFormat.
3350  * @duration: duration value.
3351  * @interval: how often to update the duration estimate based on bitrate, or 0.
3352  *
3353  * Sets the duration of the currently playing media. Subclass can use this
3354  * when it is able to determine duration and/or notices a change in the media
3355  * duration.  Alternatively, if @interval is non-zero (default), then stream
3356  * duration is determined based on estimated bitrate, and updated every @interval
3357  * frames.
3358  */
3359 void
3360 gst_base_parse_set_duration (GstBaseParse * parse,
3361     GstFormat fmt, gint64 duration, gint interval)
3362 {
3363   g_return_if_fail (parse != NULL);
3364
3365   if (parse->priv->upstream_has_duration) {
3366     GST_DEBUG_OBJECT (parse, "using upstream duration; discarding update");
3367     goto exit;
3368   }
3369
3370   if (duration != parse->priv->duration) {
3371     GstMessage *m;
3372
3373     m = gst_message_new_duration_changed (GST_OBJECT (parse));
3374     gst_element_post_message (GST_ELEMENT (parse), m);
3375
3376     /* TODO: what about duration tag? */
3377   }
3378   parse->priv->duration = duration;
3379   parse->priv->duration_fmt = fmt;
3380   GST_DEBUG_OBJECT (parse, "set duration: %" G_GINT64_FORMAT, duration);
3381   if (fmt == GST_FORMAT_TIME && GST_CLOCK_TIME_IS_VALID (duration)) {
3382     if (interval != 0) {
3383       GST_DEBUG_OBJECT (parse, "valid duration provided, disabling estimate");
3384       interval = 0;
3385     }
3386   }
3387   GST_DEBUG_OBJECT (parse, "set update interval: %d", interval);
3388   parse->priv->update_interval = interval;
3389 exit:
3390   return;
3391 }
3392
3393 /**
3394  * gst_base_parse_set_average_bitrate:
3395  * @parse: #GstBaseParse.
3396  * @bitrate: average bitrate in bits/second
3397  *
3398  * Optionally sets the average bitrate detected in media (if non-zero),
3399  * e.g. based on metadata, as it will be posted to the application.
3400  *
3401  * By default, announced average bitrate is estimated. The average bitrate
3402  * is used to estimate the total duration of the stream and to estimate
3403  * a seek position, if there's no index and the format is syncable
3404  * (see gst_base_parse_set_syncable()).
3405  */
3406 void
3407 gst_base_parse_set_average_bitrate (GstBaseParse * parse, guint bitrate)
3408 {
3409   parse->priv->bitrate = bitrate;
3410   GST_DEBUG_OBJECT (parse, "bitrate %u", bitrate);
3411 }
3412
3413 /**
3414  * gst_base_parse_set_min_frame_size:
3415  * @parse: #GstBaseParse.
3416  * @min_size: Minimum size of the data that this base class should give to
3417  *            subclass.
3418  *
3419  * Subclass can use this function to tell the base class that it needs to
3420  * give at least #min_size buffers.
3421  */
3422 void
3423 gst_base_parse_set_min_frame_size (GstBaseParse * parse, guint min_size)
3424 {
3425   g_return_if_fail (parse != NULL);
3426
3427   parse->priv->min_frame_size = min_size;
3428   GST_LOG_OBJECT (parse, "set frame_min_size: %d", min_size);
3429 }
3430
3431 /**
3432  * gst_base_parse_set_frame_rate:
3433  * @parse: the #GstBaseParse to set
3434  * @fps_num: frames per second (numerator).
3435  * @fps_den: frames per second (denominator).
3436  * @lead_in: frames needed before a segment for subsequent decode
3437  * @lead_out: frames needed after a segment
3438  *
3439  * If frames per second is configured, parser can take care of buffer duration
3440  * and timestamping.  When performing segment clipping, or seeking to a specific
3441  * location, a corresponding decoder might need an initial @lead_in and a
3442  * following @lead_out number of frames to ensure the desired segment is
3443  * entirely filled upon decoding.
3444  */
3445 void
3446 gst_base_parse_set_frame_rate (GstBaseParse * parse, guint fps_num,
3447     guint fps_den, guint lead_in, guint lead_out)
3448 {
3449   g_return_if_fail (parse != NULL);
3450
3451   parse->priv->fps_num = fps_num;
3452   parse->priv->fps_den = fps_den;
3453   if (!fps_num || !fps_den) {
3454     GST_DEBUG_OBJECT (parse, "invalid fps (%d/%d), ignoring parameters",
3455         fps_num, fps_den);
3456     fps_num = fps_den = 0;
3457     parse->priv->frame_duration = GST_CLOCK_TIME_NONE;
3458     parse->priv->lead_in = parse->priv->lead_out = 0;
3459     parse->priv->lead_in_ts = parse->priv->lead_out_ts = 0;
3460   } else {
3461     parse->priv->frame_duration =
3462         gst_util_uint64_scale (GST_SECOND, fps_den, fps_num);
3463     parse->priv->lead_in = lead_in;
3464     parse->priv->lead_out = lead_out;
3465     parse->priv->lead_in_ts =
3466         gst_util_uint64_scale (GST_SECOND, fps_den * lead_in, fps_num);
3467     parse->priv->lead_out_ts =
3468         gst_util_uint64_scale (GST_SECOND, fps_den * lead_out, fps_num);
3469     /* aim for about 1.5s to estimate duration */
3470     if (parse->priv->update_interval < 0) {
3471       parse->priv->update_interval = fps_num * 3 / (fps_den * 2);
3472       GST_LOG_OBJECT (parse, "estimated update interval to %d frames",
3473           parse->priv->update_interval);
3474     }
3475   }
3476   GST_LOG_OBJECT (parse, "set fps: %d/%d => duration: %" G_GINT64_FORMAT " ms",
3477       fps_num, fps_den, parse->priv->frame_duration / GST_MSECOND);
3478   GST_LOG_OBJECT (parse, "set lead in: %d frames = %" G_GUINT64_FORMAT " ms, "
3479       "lead out: %d frames = %" G_GUINT64_FORMAT " ms",
3480       lead_in, parse->priv->lead_in_ts / GST_MSECOND,
3481       lead_out, parse->priv->lead_out_ts / GST_MSECOND);
3482 }
3483
3484 /**
3485  * gst_base_parse_set_has_timing_info:
3486  * @parse: a #GstBaseParse
3487  * @has_timing: whether frames carry timing information
3488  *
3489  * Set if frames carry timing information which the subclass can (generally)
3490  * parse and provide.  In particular, intrinsic (rather than estimated) time
3491  * can be obtained following a seek.
3492  */
3493 void
3494 gst_base_parse_set_has_timing_info (GstBaseParse * parse, gboolean has_timing)
3495 {
3496   parse->priv->has_timing_info = has_timing;
3497   GST_INFO_OBJECT (parse, "has_timing: %s", (has_timing) ? "yes" : "no");
3498 }
3499
3500 /**
3501  * gst_base_parse_set_syncable:
3502  * @parse: a #GstBaseParse
3503  * @syncable: set if frame starts can be identified
3504  *
3505  * Set if frame starts can be identified. This is set by default and
3506  * determines whether seeking based on bitrate averages
3507  * is possible for a format/stream.
3508  */
3509 void
3510 gst_base_parse_set_syncable (GstBaseParse * parse, gboolean syncable)
3511 {
3512   parse->priv->syncable = syncable;
3513   GST_INFO_OBJECT (parse, "syncable: %s", (syncable) ? "yes" : "no");
3514 }
3515
3516 /**
3517  * gst_base_parse_set_passthrough:
3518  * @parse: a #GstBaseParse
3519  * @passthrough: %TRUE if parser should run in passthrough mode
3520  *
3521  * Set if the nature of the format or configuration does not allow (much)
3522  * parsing, and the parser should operate in passthrough mode (which only
3523  * applies when operating in push mode). That is, incoming buffers are
3524  * pushed through unmodified, i.e. no @check_valid_frame or @parse_frame
3525  * callbacks will be invoked, but @pre_push_frame will still be invoked,
3526  * so subclass can perform as much or as little is appropriate for
3527  * passthrough semantics in @pre_push_frame.
3528  */
3529 void
3530 gst_base_parse_set_passthrough (GstBaseParse * parse, gboolean passthrough)
3531 {
3532   parse->priv->passthrough = passthrough;
3533   GST_INFO_OBJECT (parse, "passthrough: %s", (passthrough) ? "yes" : "no");
3534 }
3535
3536 /**
3537  * gst_base_parse_set_pts_interpolation:
3538  * @parse: a #GstBaseParse
3539  * @pts_interpolate: %TRUE if parser should interpolate PTS timestamps
3540  *
3541  * By default, the base class will guess PTS timestamps using a simple
3542  * interpolation (previous timestamp + duration), which is incorrect for
3543  * data streams with reordering, where PTS can go backward. Sub-classes
3544  * implementing such formats should disable PTS interpolation.
3545  */
3546 void
3547 gst_base_parse_set_pts_interpolation (GstBaseParse * parse,
3548     gboolean pts_interpolate)
3549 {
3550   parse->priv->pts_interpolate = pts_interpolate;
3551   GST_INFO_OBJECT (parse, "PTS interpolation: %s",
3552       (pts_interpolate) ? "yes" : "no");
3553 }
3554
3555 /**
3556  * gst_base_parse_set_infer_ts:
3557  * @parse: a #GstBaseParse
3558  * @infer_ts: %TRUE if parser should infer DTS/PTS from each other
3559  *
3560  * By default, the base class might try to infer PTS from DTS and vice
3561  * versa.  While this is generally correct for audio data, it may not
3562  * be otherwise. Sub-classes implementing such formats should disable
3563  * timestamp inferring.
3564  */
3565 void
3566 gst_base_parse_set_infer_ts (GstBaseParse * parse, gboolean infer_ts)
3567 {
3568   parse->priv->infer_ts = infer_ts;
3569   GST_INFO_OBJECT (parse, "TS inferring: %s", (infer_ts) ? "yes" : "no");
3570 }
3571
3572 /**
3573  * gst_base_parse_set_latency:
3574  * @parse: a #GstBaseParse
3575  * @min_latency: minimum parse latency
3576  * @max_latency: maximum parse latency
3577  *
3578  * Sets the minimum and maximum (which may likely be equal) latency introduced
3579  * by the parsing process.  If there is such a latency, which depends on the
3580  * particular parsing of the format, it typically corresponds to 1 frame duration.
3581  */
3582 void
3583 gst_base_parse_set_latency (GstBaseParse * parse, GstClockTime min_latency,
3584     GstClockTime max_latency)
3585 {
3586   GST_OBJECT_LOCK (parse);
3587   parse->priv->min_latency = min_latency;
3588   parse->priv->max_latency = max_latency;
3589   GST_OBJECT_UNLOCK (parse);
3590   GST_INFO_OBJECT (parse, "min/max latency %" GST_TIME_FORMAT ", %"
3591       GST_TIME_FORMAT, GST_TIME_ARGS (min_latency),
3592       GST_TIME_ARGS (max_latency));
3593 }
3594
3595 static gboolean
3596 gst_base_parse_get_duration (GstBaseParse * parse, GstFormat format,
3597     GstClockTime * duration)
3598 {
3599   gboolean res = FALSE;
3600
3601   g_return_val_if_fail (duration != NULL, FALSE);
3602
3603   *duration = GST_CLOCK_TIME_NONE;
3604   if (parse->priv->duration != -1 && format == parse->priv->duration_fmt) {
3605     GST_LOG_OBJECT (parse, "using provided duration");
3606     *duration = parse->priv->duration;
3607     res = TRUE;
3608   } else if (parse->priv->duration != -1) {
3609     GST_LOG_OBJECT (parse, "converting provided duration");
3610     res = gst_base_parse_convert (parse, parse->priv->duration_fmt,
3611         parse->priv->duration, format, (gint64 *) duration);
3612   } else if (format == GST_FORMAT_TIME && parse->priv->estimated_duration != -1) {
3613     GST_LOG_OBJECT (parse, "using estimated duration");
3614     *duration = parse->priv->estimated_duration;
3615     res = TRUE;
3616   } else {
3617     GST_LOG_OBJECT (parse, "cannot estimate duration");
3618   }
3619
3620   GST_LOG_OBJECT (parse, "res: %d, duration %" GST_TIME_FORMAT, res,
3621       GST_TIME_ARGS (*duration));
3622   return res;
3623 }
3624
3625 static gboolean
3626 gst_base_parse_src_query_default (GstBaseParse * parse, GstQuery * query)
3627 {
3628   gboolean res = FALSE;
3629   GstPad *pad;
3630
3631   pad = GST_BASE_PARSE_SRC_PAD (parse);
3632
3633   switch (GST_QUERY_TYPE (query)) {
3634     case GST_QUERY_POSITION:
3635     {
3636       gint64 dest_value;
3637       GstFormat format;
3638
3639       GST_DEBUG_OBJECT (parse, "position query");
3640       gst_query_parse_position (query, &format, NULL);
3641
3642       /* try upstream first */
3643       res = gst_pad_query_default (pad, GST_OBJECT_CAST (parse), query);
3644       if (!res) {
3645         /* Fall back on interpreting segment */
3646         GST_OBJECT_LOCK (parse);
3647         if (format == GST_FORMAT_BYTES) {
3648           dest_value = parse->priv->offset;
3649           res = TRUE;
3650         } else if (format == parse->segment.format &&
3651             GST_CLOCK_TIME_IS_VALID (parse->segment.position)) {
3652           dest_value = gst_segment_to_stream_time (&parse->segment,
3653               parse->segment.format, parse->segment.position);
3654           res = TRUE;
3655         }
3656         GST_OBJECT_UNLOCK (parse);
3657         if (!res) {
3658           /* no precise result, upstream no idea either, then best estimate */
3659           /* priv->offset is updated in both PUSH/PULL modes */
3660           res = gst_base_parse_convert (parse,
3661               GST_FORMAT_BYTES, parse->priv->offset, format, &dest_value);
3662         }
3663         if (res)
3664           gst_query_set_position (query, format, dest_value);
3665       }
3666       break;
3667     }
3668     case GST_QUERY_DURATION:
3669     {
3670       GstFormat format;
3671       GstClockTime duration;
3672
3673       GST_DEBUG_OBJECT (parse, "duration query");
3674       gst_query_parse_duration (query, &format, NULL);
3675
3676       /* consult upstream */
3677       res = gst_pad_query_default (pad, GST_OBJECT_CAST (parse), query);
3678
3679       /* otherwise best estimate from us */
3680       if (!res) {
3681         res = gst_base_parse_get_duration (parse, format, &duration);
3682         if (res)
3683           gst_query_set_duration (query, format, duration);
3684       }
3685       break;
3686     }
3687     case GST_QUERY_SEEKING:
3688     {
3689       GstFormat fmt;
3690       GstClockTime duration = GST_CLOCK_TIME_NONE;
3691       gboolean seekable = FALSE;
3692
3693       GST_DEBUG_OBJECT (parse, "seeking query");
3694       gst_query_parse_seeking (query, &fmt, NULL, NULL, NULL);
3695
3696       /* consult upstream */
3697       res = gst_pad_query_default (pad, GST_OBJECT_CAST (parse), query);
3698
3699       /* we may be able to help if in TIME */
3700       if (fmt == GST_FORMAT_TIME && gst_base_parse_is_seekable (parse)) {
3701         gst_query_parse_seeking (query, &fmt, &seekable, NULL, NULL);
3702         /* already OK if upstream takes care */
3703         GST_LOG_OBJECT (parse, "upstream handled %d, seekable %d",
3704             res, seekable);
3705         if (!(res && seekable)) {
3706           if (!gst_base_parse_get_duration (parse, GST_FORMAT_TIME, &duration)
3707               || duration == -1) {
3708             /* seekable if we still have a chance to get duration later on */
3709             seekable =
3710                 parse->priv->upstream_seekable && parse->priv->update_interval;
3711           } else {
3712             seekable = parse->priv->upstream_seekable;
3713             GST_LOG_OBJECT (parse, "already determine upstream seekabled: %d",
3714                 seekable);
3715           }
3716           gst_query_set_seeking (query, GST_FORMAT_TIME, seekable, 0, duration);
3717           res = TRUE;
3718         }
3719       }
3720       break;
3721     }
3722     case GST_QUERY_FORMATS:
3723       gst_query_set_formatsv (query, 3, fmtlist);
3724       res = TRUE;
3725       break;
3726     case GST_QUERY_CONVERT:
3727     {
3728       GstFormat src_format, dest_format;
3729       gint64 src_value, dest_value;
3730
3731       gst_query_parse_convert (query, &src_format, &src_value,
3732           &dest_format, &dest_value);
3733
3734       res = gst_base_parse_convert (parse, src_format, src_value,
3735           dest_format, &dest_value);
3736       if (res) {
3737         gst_query_set_convert (query, src_format, src_value,
3738             dest_format, dest_value);
3739       }
3740       break;
3741     }
3742     case GST_QUERY_LATENCY:
3743     {
3744       if ((res = gst_pad_peer_query (parse->sinkpad, query))) {
3745         gboolean live;
3746         GstClockTime min_latency, max_latency;
3747
3748         gst_query_parse_latency (query, &live, &min_latency, &max_latency);
3749         GST_DEBUG_OBJECT (parse, "Peer latency: live %d, min %"
3750             GST_TIME_FORMAT " max %" GST_TIME_FORMAT, live,
3751             GST_TIME_ARGS (min_latency), GST_TIME_ARGS (max_latency));
3752
3753         GST_OBJECT_LOCK (parse);
3754         /* add our latency */
3755         if (min_latency != -1)
3756           min_latency += parse->priv->min_latency;
3757         if (max_latency != -1)
3758           max_latency += parse->priv->max_latency;
3759         GST_OBJECT_UNLOCK (parse);
3760
3761         gst_query_set_latency (query, live, min_latency, max_latency);
3762       }
3763       break;
3764     }
3765     case GST_QUERY_SEGMENT:
3766     {
3767       GstFormat format;
3768       gint64 start, stop;
3769
3770       format = parse->segment.format;
3771
3772       start =
3773           gst_segment_to_stream_time (&parse->segment, format,
3774           parse->segment.start);
3775       if ((stop = parse->segment.stop) == -1)
3776         stop = parse->segment.duration;
3777       else
3778         stop = gst_segment_to_stream_time (&parse->segment, format, stop);
3779
3780       gst_query_set_segment (query, parse->segment.rate, format, start, stop);
3781       res = TRUE;
3782       break;
3783     }
3784     default:
3785       res = gst_pad_query_default (pad, GST_OBJECT_CAST (parse), query);
3786       break;
3787   }
3788   return res;
3789 }
3790
3791 /* scans for a cluster start from @pos,
3792  * return GST_FLOW_OK and frame position/time in @pos/@time if found */
3793 static GstFlowReturn
3794 gst_base_parse_find_frame (GstBaseParse * parse, gint64 * pos,
3795     GstClockTime * time, GstClockTime * duration)
3796 {
3797   GstBaseParseClass *klass;
3798   gint64 orig_offset;
3799   gboolean orig_drain, orig_discont;
3800   GstFlowReturn ret = GST_FLOW_OK;
3801   GstBuffer *buf = NULL;
3802   GstBaseParseFrame *sframe = NULL;
3803
3804   g_return_val_if_fail (pos != NULL, GST_FLOW_ERROR);
3805   g_return_val_if_fail (time != NULL, GST_FLOW_ERROR);
3806   g_return_val_if_fail (duration != NULL, GST_FLOW_ERROR);
3807
3808   klass = GST_BASE_PARSE_GET_CLASS (parse);
3809
3810   *time = GST_CLOCK_TIME_NONE;
3811   *duration = GST_CLOCK_TIME_NONE;
3812
3813   /* save state */
3814   orig_offset = parse->priv->offset;
3815   orig_discont = parse->priv->discont;
3816   orig_drain = parse->priv->drain;
3817
3818   GST_DEBUG_OBJECT (parse, "scanning for frame starting at %" G_GINT64_FORMAT
3819       " (%#" G_GINT64_MODIFIER "x)", *pos, *pos);
3820
3821   /* jump elsewhere and locate next frame */
3822   parse->priv->offset = *pos;
3823   /* mark as scanning so frames don't get processed all the way */
3824   parse->priv->scanning = TRUE;
3825   ret = gst_base_parse_scan_frame (parse, klass);
3826   parse->priv->scanning = FALSE;
3827   /* retrieve frame found during scan */
3828   sframe = parse->priv->scanned_frame;
3829   parse->priv->scanned_frame = NULL;
3830
3831   if (ret != GST_FLOW_OK || !sframe)
3832     goto done;
3833
3834   /* get offset first, subclass parsing might dump other stuff in there */
3835   *pos = sframe->offset;
3836   buf = sframe->buffer;
3837   g_assert (buf);
3838
3839   /* but it should provide proper time */
3840   *time = GST_BUFFER_TIMESTAMP (buf);
3841   *duration = GST_BUFFER_DURATION (buf);
3842
3843   GST_LOG_OBJECT (parse,
3844       "frame with time %" GST_TIME_FORMAT " at offset %" G_GINT64_FORMAT,
3845       GST_TIME_ARGS (*time), *pos);
3846
3847 done:
3848   if (sframe)
3849     gst_base_parse_frame_free (sframe);
3850
3851   /* restore state */
3852   parse->priv->offset = orig_offset;
3853   parse->priv->discont = orig_discont;
3854   parse->priv->drain = orig_drain;
3855
3856   return ret;
3857 }
3858
3859 /* bisect and scan through file for frame starting before @time,
3860  * returns OK and @time/@offset if found, NONE and/or error otherwise
3861  * If @time == G_MAXINT64, scan for duration ( == last frame) */
3862 static GstFlowReturn
3863 gst_base_parse_locate_time (GstBaseParse * parse, GstClockTime * _time,
3864     gint64 * _offset)
3865 {
3866   GstFlowReturn ret = GST_FLOW_OK;
3867   gint64 lpos, hpos, newpos;
3868   GstClockTime time, ltime, htime, newtime, dur;
3869   gboolean cont = TRUE;
3870   const GstClockTime tolerance = TARGET_DIFFERENCE;
3871   const guint chunk = 4 * 1024;
3872
3873   g_return_val_if_fail (_time != NULL, GST_FLOW_ERROR);
3874   g_return_val_if_fail (_offset != NULL, GST_FLOW_ERROR);
3875
3876   GST_DEBUG_OBJECT (parse, "Bisecting for time %" GST_TIME_FORMAT,
3877       GST_TIME_ARGS (*_time));
3878
3879   /* TODO also make keyframe aware if useful some day */
3880
3881   time = *_time;
3882
3883   /* basic cases */
3884   if (time == 0) {
3885     *_offset = 0;
3886     return GST_FLOW_OK;
3887   }
3888
3889   if (time == -1) {
3890     *_offset = -1;
3891     return GST_FLOW_OK;
3892   }
3893
3894   /* do not know at first */
3895   *_offset = -1;
3896   *_time = GST_CLOCK_TIME_NONE;
3897
3898   /* need initial positions; start and end */
3899   lpos = parse->priv->first_frame_offset;
3900   ltime = parse->priv->first_frame_pts;
3901   /* try other one if no luck */
3902   if (!GST_CLOCK_TIME_IS_VALID (ltime))
3903     ltime = parse->priv->first_frame_dts;
3904   if (!gst_base_parse_get_duration (parse, GST_FORMAT_TIME, &htime)) {
3905     GST_DEBUG_OBJECT (parse, "Unknown time duration, cannot bisect");
3906     return GST_FLOW_ERROR;
3907   }
3908   hpos = parse->priv->upstream_size;
3909
3910   GST_DEBUG_OBJECT (parse,
3911       "Bisection initial bounds: bytes %" G_GINT64_FORMAT " %" G_GINT64_FORMAT
3912       ", times %" GST_TIME_FORMAT " %" GST_TIME_FORMAT, lpos, hpos,
3913       GST_TIME_ARGS (ltime), GST_TIME_ARGS (htime));
3914
3915   /* check preconditions are satisfied;
3916    * start and end are needed, except for special case where we scan for
3917    * last frame to determine duration */
3918   if (parse->priv->pad_mode != GST_PAD_MODE_PULL || !hpos ||
3919       !GST_CLOCK_TIME_IS_VALID (ltime) ||
3920       (!GST_CLOCK_TIME_IS_VALID (htime) && time != G_MAXINT64)) {
3921     return GST_FLOW_OK;
3922   }
3923
3924   /* shortcut cases */
3925   if (time < ltime) {
3926     goto exit;
3927   } else if (time < ltime + tolerance) {
3928     *_offset = lpos;
3929     *_time = ltime;
3930     goto exit;
3931   } else if (time >= htime) {
3932     *_offset = hpos;
3933     *_time = htime;
3934     goto exit;
3935   }
3936
3937   while (htime > ltime && cont) {
3938     GST_LOG_OBJECT (parse,
3939         "lpos: %" G_GUINT64_FORMAT ", ltime: %" GST_TIME_FORMAT, lpos,
3940         GST_TIME_ARGS (ltime));
3941     GST_LOG_OBJECT (parse,
3942         "hpos: %" G_GUINT64_FORMAT ", htime: %" GST_TIME_FORMAT, hpos,
3943         GST_TIME_ARGS (htime));
3944     if (G_UNLIKELY (time == G_MAXINT64)) {
3945       newpos = hpos;
3946     } else if (G_LIKELY (hpos > lpos)) {
3947       newpos =
3948           gst_util_uint64_scale (hpos - lpos, time - ltime, htime - ltime) +
3949           lpos - chunk;
3950     } else {
3951       /* should mean lpos == hpos, since lpos <= hpos is invariant */
3952       newpos = lpos;
3953       /* we check this case once, but not forever, so break loop */
3954       cont = FALSE;
3955     }
3956
3957     /* ensure */
3958     newpos = CLAMP (newpos, lpos, hpos);
3959     GST_LOG_OBJECT (parse,
3960         "estimated _offset for %" GST_TIME_FORMAT ": %" G_GINT64_FORMAT,
3961         GST_TIME_ARGS (time), newpos);
3962
3963     ret = gst_base_parse_find_frame (parse, &newpos, &newtime, &dur);
3964     if (ret == GST_FLOW_EOS) {
3965       /* heuristic HACK */
3966       hpos = MAX (lpos, hpos - chunk);
3967       continue;
3968     } else if (ret != GST_FLOW_OK) {
3969       goto exit;
3970     }
3971
3972     if (newtime == -1 || newpos == -1) {
3973       GST_DEBUG_OBJECT (parse, "subclass did not provide metadata; aborting");
3974       break;
3975     }
3976
3977     if (G_UNLIKELY (time == G_MAXINT64)) {
3978       *_offset = newpos;
3979       *_time = newtime;
3980       if (GST_CLOCK_TIME_IS_VALID (dur))
3981         *_time += dur;
3982       break;
3983     } else if (newtime > time) {
3984       /* overshoot */
3985       hpos = (newpos >= hpos) ? MAX (lpos, hpos - chunk) : MAX (lpos, newpos);
3986       htime = newtime;
3987     } else if (newtime + tolerance > time) {
3988       /* close enough undershoot */
3989       *_offset = newpos;
3990       *_time = newtime;
3991       break;
3992     } else if (newtime < ltime) {
3993       /* so a position beyond lpos resulted in earlier time than ltime ... */
3994       GST_DEBUG_OBJECT (parse, "non-ascending time; aborting");
3995       break;
3996     } else {
3997       /* undershoot too far */
3998       newpos += newpos == lpos ? chunk : 0;
3999       lpos = CLAMP (newpos, lpos, hpos);
4000       ltime = newtime;
4001     }
4002   }
4003
4004 exit:
4005   GST_LOG_OBJECT (parse, "return offset %" G_GINT64_FORMAT ", time %"
4006       GST_TIME_FORMAT, *_offset, GST_TIME_ARGS (*_time));
4007   return ret;
4008 }
4009
4010 static gint64
4011 gst_base_parse_find_offset (GstBaseParse * parse, GstClockTime time,
4012     gboolean before, GstClockTime * _ts)
4013 {
4014   gint64 bytes = 0, ts = 0;
4015   GstIndexEntry *entry = NULL;
4016
4017   if (time == GST_CLOCK_TIME_NONE) {
4018     ts = time;
4019     bytes = -1;
4020     goto exit;
4021   }
4022
4023   GST_BASE_PARSE_INDEX_LOCK (parse);
4024   if (parse->priv->index) {
4025     /* Let's check if we have an index entry for that time */
4026     entry = gst_index_get_assoc_entry (parse->priv->index,
4027         parse->priv->index_id,
4028         before ? GST_INDEX_LOOKUP_BEFORE : GST_INDEX_LOOKUP_AFTER,
4029         GST_INDEX_ASSOCIATION_FLAG_KEY_UNIT, GST_FORMAT_TIME, time);
4030   }
4031
4032   if (entry) {
4033     gst_index_entry_assoc_map (entry, GST_FORMAT_BYTES, &bytes);
4034     gst_index_entry_assoc_map (entry, GST_FORMAT_TIME, &ts);
4035
4036     GST_DEBUG_OBJECT (parse, "found index entry for %" GST_TIME_FORMAT
4037         " at %" GST_TIME_FORMAT ", offset %" G_GINT64_FORMAT,
4038         GST_TIME_ARGS (time), GST_TIME_ARGS (ts), bytes);
4039   } else {
4040     GST_DEBUG_OBJECT (parse, "no index entry found for %" GST_TIME_FORMAT,
4041         GST_TIME_ARGS (time));
4042     if (!before) {
4043       bytes = -1;
4044       ts = GST_CLOCK_TIME_NONE;
4045     }
4046   }
4047   GST_BASE_PARSE_INDEX_UNLOCK (parse);
4048
4049 exit:
4050   if (_ts)
4051     *_ts = ts;
4052
4053   return bytes;
4054 }
4055
4056 /* returns TRUE if seek succeeded */
4057 static gboolean
4058 gst_base_parse_handle_seek (GstBaseParse * parse, GstEvent * event)
4059 {
4060   gdouble rate;
4061   GstFormat format;
4062   GstSeekFlags flags;
4063   GstSeekType start_type = GST_SEEK_TYPE_NONE, stop_type;
4064   gboolean flush, update, res = TRUE, accurate;
4065   gint64 start, stop, seekpos, seekstop;
4066   GstSegment seeksegment = { 0, };
4067   GstClockTime start_ts;
4068   guint32 seqnum;
4069   GstEvent *segment_event;
4070
4071   /* try upstream first, unless we're driving the streaming thread ourselves */
4072   if (parse->priv->pad_mode != GST_PAD_MODE_PULL) {
4073     res = gst_pad_push_event (parse->sinkpad, gst_event_ref (event));
4074     if (res)
4075       goto done;
4076   }
4077
4078   gst_event_parse_seek (event, &rate, &format, &flags,
4079       &start_type, &start, &stop_type, &stop);
4080   seqnum = gst_event_get_seqnum (event);
4081
4082   GST_DEBUG_OBJECT (parse, "seek to format %s, rate %f, "
4083       "start type %d at %" GST_TIME_FORMAT ", end type %d at %"
4084       GST_TIME_FORMAT, gst_format_get_name (format), rate,
4085       start_type, GST_TIME_ARGS (start), stop_type, GST_TIME_ARGS (stop));
4086
4087   /* we can only handle TIME, so check if subclass can convert
4088    * to TIME format if it's some other format (such as DEFAULT) */
4089   if (format != GST_FORMAT_TIME) {
4090     if (!gst_base_parse_convert (parse, format, start, GST_FORMAT_TIME, &start)
4091         || !gst_base_parse_convert (parse, format, stop, GST_FORMAT_TIME,
4092             &stop))
4093       goto no_convert_to_time;
4094
4095     GST_INFO_OBJECT (parse, "converted %s format to start time "
4096         "%" GST_TIME_FORMAT " and stop time %" GST_TIME_FORMAT,
4097         gst_format_get_name (format), GST_TIME_ARGS (start),
4098         GST_TIME_ARGS (stop));
4099
4100     format = GST_FORMAT_TIME;
4101   }
4102
4103   /* no negative rates in push mode (unless upstream takes care of that, but
4104    * we've already tried upstream and it didn't handle the seek request) */
4105   if (rate < 0.0 && parse->priv->pad_mode == GST_PAD_MODE_PUSH)
4106     goto negative_rate;
4107
4108   if (rate < 0.0 && parse->priv->pad_mode == GST_PAD_MODE_PULL)
4109     goto negative_rate_pull_mode;
4110
4111   if (start_type != GST_SEEK_TYPE_SET ||
4112       (stop_type != GST_SEEK_TYPE_SET && stop_type != GST_SEEK_TYPE_NONE))
4113     goto wrong_type;
4114
4115   /* get flush flag */
4116   flush = flags & GST_SEEK_FLAG_FLUSH;
4117
4118   /* copy segment, we need this because we still need the old
4119    * segment when we close the current segment. */
4120   gst_segment_copy_into (&parse->segment, &seeksegment);
4121
4122   GST_DEBUG_OBJECT (parse, "configuring seek");
4123   gst_segment_do_seek (&seeksegment, rate, format, flags,
4124       start_type, start, stop_type, stop, &update);
4125
4126   /* accurate seeking implies seek tables are used to obtain position,
4127    * and the requested segment is maintained exactly, not adjusted any way */
4128   accurate = flags & GST_SEEK_FLAG_ACCURATE;
4129
4130   /* maybe we can be accurate for (almost) free */
4131   gst_base_parse_find_offset (parse, seeksegment.position, TRUE, &start_ts);
4132   if (seeksegment.position <= start_ts + TARGET_DIFFERENCE) {
4133     GST_DEBUG_OBJECT (parse, "accurate seek possible");
4134     accurate = TRUE;
4135   }
4136   if (accurate) {
4137     GstClockTime startpos = seeksegment.position;
4138
4139     /* accurate requested, so ... seek a bit before target */
4140     if (startpos < parse->priv->lead_in_ts)
4141       startpos = 0;
4142     else
4143       startpos -= parse->priv->lead_in_ts;
4144     seekpos = gst_base_parse_find_offset (parse, startpos, TRUE, &start_ts);
4145     seekstop = gst_base_parse_find_offset (parse, seeksegment.stop, FALSE,
4146         NULL);
4147   } else {
4148     start_ts = seeksegment.position;
4149     if (!gst_base_parse_convert (parse, format, seeksegment.position,
4150             GST_FORMAT_BYTES, &seekpos))
4151       goto convert_failed;
4152     if (!gst_base_parse_convert (parse, format, seeksegment.stop,
4153             GST_FORMAT_BYTES, &seekstop))
4154       goto convert_failed;
4155   }
4156
4157   GST_DEBUG_OBJECT (parse,
4158       "seek position %" G_GINT64_FORMAT " in bytes: %" G_GINT64_FORMAT,
4159       start_ts, seekpos);
4160   GST_DEBUG_OBJECT (parse,
4161       "seek stop %" G_GINT64_FORMAT " in bytes: %" G_GINT64_FORMAT,
4162       seeksegment.stop, seekstop);
4163
4164   if (parse->priv->pad_mode == GST_PAD_MODE_PULL) {
4165     gint64 last_stop;
4166
4167     GST_DEBUG_OBJECT (parse, "seek in PULL mode");
4168
4169     if (flush) {
4170       if (parse->srcpad) {
4171         GstEvent *fevent = gst_event_new_flush_start ();
4172         GST_DEBUG_OBJECT (parse, "sending flush start");
4173
4174         gst_event_set_seqnum (fevent, seqnum);
4175
4176         gst_pad_push_event (parse->srcpad, gst_event_ref (fevent));
4177         /* unlock upstream pull_range */
4178         gst_pad_push_event (parse->sinkpad, fevent);
4179       }
4180     } else {
4181       gst_pad_pause_task (parse->sinkpad);
4182     }
4183
4184     /* we should now be able to grab the streaming thread because we stopped it
4185      * with the above flush/pause code */
4186     GST_PAD_STREAM_LOCK (parse->sinkpad);
4187
4188     /* save current position */
4189     last_stop = parse->segment.position;
4190     GST_DEBUG_OBJECT (parse, "stopped streaming at %" G_GINT64_FORMAT,
4191         last_stop);
4192
4193     /* now commit to new position */
4194
4195     /* prepare for streaming again */
4196     if (flush) {
4197       GstEvent *fevent = gst_event_new_flush_stop (TRUE);
4198       GST_DEBUG_OBJECT (parse, "sending flush stop");
4199       gst_event_set_seqnum (fevent, seqnum);
4200       gst_pad_push_event (parse->srcpad, gst_event_ref (fevent));
4201       gst_pad_push_event (parse->sinkpad, fevent);
4202       gst_base_parse_clear_queues (parse);
4203     } else {
4204       /* keep track of our position */
4205       seeksegment.base = gst_segment_to_running_time (&seeksegment,
4206           seeksegment.format, parse->segment.position);
4207     }
4208
4209     memcpy (&parse->segment, &seeksegment, sizeof (GstSegment));
4210
4211     /* store the newsegment event so it can be sent from the streaming thread. */
4212     /* This will be sent later in _loop() */
4213     segment_event = gst_event_new_segment (&parse->segment);
4214     gst_event_set_seqnum (segment_event, seqnum);
4215     parse->priv->pending_events =
4216         g_list_prepend (parse->priv->pending_events, segment_event);
4217
4218     GST_DEBUG_OBJECT (parse, "Created newseg format %d, "
4219         "start = %" GST_TIME_FORMAT ", stop = %" GST_TIME_FORMAT
4220         ", time = %" GST_TIME_FORMAT, format,
4221         GST_TIME_ARGS (parse->segment.start),
4222         GST_TIME_ARGS (parse->segment.stop),
4223         GST_TIME_ARGS (parse->segment.time));
4224
4225     /* one last chance in pull mode to stay accurate;
4226      * maybe scan and subclass can find where to go */
4227     if (!accurate) {
4228       gint64 scanpos;
4229       GstClockTime ts = seeksegment.position;
4230
4231       gst_base_parse_locate_time (parse, &ts, &scanpos);
4232       if (scanpos >= 0) {
4233         accurate = TRUE;
4234         seekpos = scanpos;
4235         /* running collected index now consists of several intervals,
4236          * so optimized check no longer possible */
4237         parse->priv->index_last_valid = FALSE;
4238         parse->priv->index_last_offset = 0;
4239         parse->priv->index_last_ts = 0;
4240       }
4241     }
4242
4243     /* mark discont if we are going to stream from another position. */
4244     if (seekpos != parse->priv->offset) {
4245       GST_DEBUG_OBJECT (parse,
4246           "mark DISCONT, we did a seek to another position");
4247       parse->priv->offset = seekpos;
4248       parse->priv->last_offset = seekpos;
4249       parse->priv->seen_keyframe = FALSE;
4250       parse->priv->discont = TRUE;
4251       parse->priv->next_dts = start_ts;
4252       parse->priv->next_pts = GST_CLOCK_TIME_NONE;
4253       parse->priv->last_dts = GST_CLOCK_TIME_NONE;
4254       parse->priv->last_pts = GST_CLOCK_TIME_NONE;
4255       parse->priv->sync_offset = seekpos;
4256       parse->priv->exact_position = accurate;
4257     }
4258
4259     /* Start streaming thread if paused */
4260     gst_pad_start_task (parse->sinkpad,
4261         (GstTaskFunction) gst_base_parse_loop, parse->sinkpad, NULL);
4262
4263     GST_PAD_STREAM_UNLOCK (parse->sinkpad);
4264
4265     /* handled seek */
4266     res = TRUE;
4267   } else {
4268     GstEvent *new_event;
4269     GstBaseParseSeek *seek;
4270     GstSeekFlags flags = (flush ? GST_SEEK_FLAG_FLUSH : GST_SEEK_FLAG_NONE);
4271
4272     /* The only thing we need to do in PUSH-mode is to send the
4273        seek event (in bytes) to upstream. Segment / flush handling happens
4274        in corresponding src event handlers */
4275     GST_DEBUG_OBJECT (parse, "seek in PUSH mode");
4276     if (seekstop >= 0 && seekstop <= seekpos)
4277       seekstop = seekpos;
4278     new_event = gst_event_new_seek (rate, GST_FORMAT_BYTES, flags,
4279         GST_SEEK_TYPE_SET, seekpos, stop_type, seekstop);
4280     gst_event_set_seqnum (new_event, seqnum);
4281
4282     /* store segment info so its precise details can be reconstructed when
4283      * receiving newsegment;
4284      * this matters for all details when accurate seeking,
4285      * is most useful to preserve NONE stop time otherwise */
4286     seek = g_new0 (GstBaseParseSeek, 1);
4287     seek->segment = seeksegment;
4288     seek->accurate = accurate;
4289     seek->offset = seekpos;
4290     seek->start_ts = start_ts;
4291     GST_OBJECT_LOCK (parse);
4292     /* less optimal, but preserves order */
4293     parse->priv->pending_seeks =
4294         g_slist_append (parse->priv->pending_seeks, seek);
4295     GST_OBJECT_UNLOCK (parse);
4296
4297     res = gst_pad_push_event (parse->sinkpad, new_event);
4298
4299     if (!res) {
4300       GST_OBJECT_LOCK (parse);
4301       parse->priv->pending_seeks =
4302           g_slist_remove (parse->priv->pending_seeks, seek);
4303       GST_OBJECT_UNLOCK (parse);
4304       g_free (seek);
4305     }
4306   }
4307
4308 done:
4309   gst_event_unref (event);
4310   return res;
4311
4312   /* ERRORS */
4313 negative_rate_pull_mode:
4314   {
4315     GST_FIXME_OBJECT (parse, "negative playback in pull mode needs fixing");
4316     res = FALSE;
4317     goto done;
4318   }
4319 negative_rate:
4320   {
4321     GST_DEBUG_OBJECT (parse, "negative playback rates delegated upstream.");
4322     res = FALSE;
4323     goto done;
4324   }
4325 wrong_type:
4326   {
4327     GST_DEBUG_OBJECT (parse, "unsupported seek type.");
4328     res = FALSE;
4329     goto done;
4330   }
4331 no_convert_to_time:
4332   {
4333     GST_DEBUG_OBJECT (parse, "seek in %s format was requested, but subclass "
4334         "couldn't convert that into TIME format", gst_format_get_name (format));
4335     res = FALSE;
4336     goto done;
4337   }
4338 convert_failed:
4339   {
4340     GST_DEBUG_OBJECT (parse, "conversion TIME to BYTES failed.");
4341     res = FALSE;
4342     goto done;
4343   }
4344 }
4345
4346 /* Checks if bitrates are available from upstream tags so that we don't
4347  * override them later
4348  */
4349 static void
4350 gst_base_parse_handle_tag (GstBaseParse * parse, GstEvent * event)
4351 {
4352   GstTagList *taglist = NULL;
4353   guint tmp;
4354
4355   gst_event_parse_tag (event, &taglist);
4356
4357   /* We only care about stream tags here */
4358   if (gst_tag_list_get_scope (taglist) != GST_TAG_SCOPE_STREAM)
4359     return;
4360
4361   if (gst_tag_list_get_uint (taglist, GST_TAG_MINIMUM_BITRATE, &tmp)) {
4362     GST_DEBUG_OBJECT (parse, "upstream min bitrate %d", tmp);
4363     parse->priv->post_min_bitrate = FALSE;
4364   }
4365   if (gst_tag_list_get_uint (taglist, GST_TAG_BITRATE, &tmp)) {
4366     GST_DEBUG_OBJECT (parse, "upstream avg bitrate %d", tmp);
4367     parse->priv->post_avg_bitrate = FALSE;
4368   }
4369   if (gst_tag_list_get_uint (taglist, GST_TAG_MAXIMUM_BITRATE, &tmp)) {
4370     GST_DEBUG_OBJECT (parse, "upstream max bitrate %d", tmp);
4371     parse->priv->post_max_bitrate = FALSE;
4372   }
4373 }
4374
4375 #if 0
4376 static void
4377 gst_base_parse_set_index (GstElement * element, GstIndex * index)
4378 {
4379   GstBaseParse *parse = GST_BASE_PARSE (element);
4380
4381   GST_BASE_PARSE_INDEX_LOCK (parse);
4382   if (parse->priv->index)
4383     gst_object_unref (parse->priv->index);
4384   if (index) {
4385     parse->priv->index = gst_object_ref (index);
4386     gst_index_get_writer_id (index, GST_OBJECT_CAST (element),
4387         &parse->priv->index_id);
4388     parse->priv->own_index = FALSE;
4389   } else {
4390     parse->priv->index = NULL;
4391   }
4392   GST_BASE_PARSE_INDEX_UNLOCK (parse);
4393 }
4394
4395 static GstIndex *
4396 gst_base_parse_get_index (GstElement * element)
4397 {
4398   GstBaseParse *parse = GST_BASE_PARSE (element);
4399   GstIndex *result = NULL;
4400
4401   GST_BASE_PARSE_INDEX_LOCK (parse);
4402   if (parse->priv->index)
4403     result = gst_object_ref (parse->priv->index);
4404   GST_BASE_PARSE_INDEX_UNLOCK (parse);
4405
4406   return result;
4407 }
4408 #endif
4409
4410 static GstStateChangeReturn
4411 gst_base_parse_change_state (GstElement * element, GstStateChange transition)
4412 {
4413   GstBaseParse *parse;
4414   GstStateChangeReturn result;
4415
4416   parse = GST_BASE_PARSE (element);
4417
4418   switch (transition) {
4419     case GST_STATE_CHANGE_READY_TO_PAUSED:
4420       /* If this is our own index destroy it as the
4421        * old entries might be wrong for the new stream */
4422       GST_BASE_PARSE_INDEX_LOCK (parse);
4423       if (parse->priv->own_index) {
4424         gst_object_unref (parse->priv->index);
4425         parse->priv->index = NULL;
4426         parse->priv->own_index = FALSE;
4427       }
4428
4429       /* If no index was created, generate one */
4430       if (G_UNLIKELY (!parse->priv->index)) {
4431         GST_DEBUG_OBJECT (parse, "no index provided creating our own");
4432
4433         parse->priv->index = g_object_new (gst_mem_index_get_type (), NULL);
4434         gst_index_get_writer_id (parse->priv->index, GST_OBJECT (parse),
4435             &parse->priv->index_id);
4436         parse->priv->own_index = TRUE;
4437       }
4438       GST_BASE_PARSE_INDEX_UNLOCK (parse);
4439       break;
4440     default:
4441       break;
4442   }
4443
4444   result = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
4445
4446   switch (transition) {
4447     case GST_STATE_CHANGE_PAUSED_TO_READY:
4448       gst_base_parse_reset (parse);
4449       break;
4450     default:
4451       break;
4452   }
4453
4454   return result;
4455 }
4456
4457 /**
4458  * gst_base_parse_set_ts_at_offset:
4459  * @parse: a #GstBaseParse
4460  * @offset: offset into current buffer
4461  *
4462  * This function should only be called from a @handle_frame implementation.
4463  *
4464  * GstBaseParse creates initial timestamps for frames by using the last
4465  * timestamp seen in the stream before the frame starts.  In certain
4466  * cases, the correct timestamps will occur in the stream after the
4467  * start of the frame, but before the start of the actual picture data.
4468  * This function can be used to set the timestamps based on the offset
4469  * into the frame data that the picture starts.
4470  *
4471  * Since: 1.2
4472  */
4473 void
4474 gst_base_parse_set_ts_at_offset (GstBaseParse * parse, gsize offset)
4475 {
4476   GstClockTime pts, dts;
4477
4478   g_return_if_fail (GST_IS_BASE_PARSE (parse));
4479   g_return_if_fail (offset >= 0);
4480
4481   pts = gst_adapter_prev_pts_at_offset (parse->priv->adapter, offset, NULL);
4482   dts = gst_adapter_prev_dts_at_offset (parse->priv->adapter, offset, NULL);
4483
4484   if (!GST_CLOCK_TIME_IS_VALID (pts) || !GST_CLOCK_TIME_IS_VALID (dts)) {
4485     GST_DEBUG_OBJECT (parse,
4486         "offset adapter timestamps dts=%" GST_TIME_FORMAT " pts=%"
4487         GST_TIME_FORMAT, GST_TIME_ARGS (dts), GST_TIME_ARGS (pts));
4488   }
4489   if (GST_CLOCK_TIME_IS_VALID (pts) && (parse->priv->prev_pts != pts))
4490     parse->priv->prev_pts = parse->priv->next_pts = pts;
4491
4492   if (GST_CLOCK_TIME_IS_VALID (dts) && (parse->priv->prev_dts != dts))
4493     parse->priv->prev_dts = parse->priv->next_dts = dts;
4494 }