baseparse: push pending events before GAP event
[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   /* Newsegment event to be sent after SEEK */
334   gboolean pending_segment;
335
336   /* offset of last parsed frame/data */
337   gint64 prev_offset;
338   /* force a new frame, regardless of offset */
339   gboolean new_frame;
340   /* whether we are merely scanning for a frame */
341   gboolean scanning;
342   /* ... and resulting frame, if any */
343   GstBaseParseFrame *scanned_frame;
344
345   /* TRUE if we're still detecting the format, i.e.
346    * if ::detect() is still called for future buffers */
347   gboolean detecting;
348   GList *detect_buffers;
349   guint detect_buffers_size;
350
351   /* if TRUE, a STREAM_START event needs to be pushed */
352   gboolean push_stream_start;
353 };
354
355 typedef struct _GstBaseParseSeek
356 {
357   GstSegment segment;
358   gboolean accurate;
359   gint64 offset;
360   GstClockTime start_ts;
361 } GstBaseParseSeek;
362
363 #define DEFAULT_DISABLE_PASSTHROUGH        FALSE
364
365 enum
366 {
367   PROP_0,
368   PROP_DISABLE_PASSTHROUGH,
369   PROP_LAST
370 };
371
372 #define GST_BASE_PARSE_INDEX_LOCK(parse) \
373   g_mutex_lock (&parse->priv->index_lock);
374 #define GST_BASE_PARSE_INDEX_UNLOCK(parse) \
375   g_mutex_unlock (&parse->priv->index_lock);
376
377 static GstElementClass *parent_class = NULL;
378
379 static void gst_base_parse_class_init (GstBaseParseClass * klass);
380 static void gst_base_parse_init (GstBaseParse * parse,
381     GstBaseParseClass * klass);
382
383 GType
384 gst_base_parse_get_type (void)
385 {
386   static volatile gsize base_parse_type = 0;
387
388   if (g_once_init_enter (&base_parse_type)) {
389     static const GTypeInfo base_parse_info = {
390       sizeof (GstBaseParseClass),
391       (GBaseInitFunc) NULL,
392       (GBaseFinalizeFunc) NULL,
393       (GClassInitFunc) gst_base_parse_class_init,
394       NULL,
395       NULL,
396       sizeof (GstBaseParse),
397       0,
398       (GInstanceInitFunc) gst_base_parse_init,
399     };
400     GType _type;
401
402     _type = g_type_register_static (GST_TYPE_ELEMENT,
403         "GstBaseParse", &base_parse_info, G_TYPE_FLAG_ABSTRACT);
404     g_once_init_leave (&base_parse_type, _type);
405   }
406   return (GType) base_parse_type;
407 }
408
409 static void gst_base_parse_finalize (GObject * object);
410
411 static GstStateChangeReturn gst_base_parse_change_state (GstElement * element,
412     GstStateChange transition);
413 static void gst_base_parse_reset (GstBaseParse * parse);
414
415 #if 0
416 static void gst_base_parse_set_index (GstElement * element, GstIndex * index);
417 static GstIndex *gst_base_parse_get_index (GstElement * element);
418 #endif
419
420 static gboolean gst_base_parse_sink_activate (GstPad * sinkpad,
421     GstObject * parent);
422 static gboolean gst_base_parse_sink_activate_mode (GstPad * pad,
423     GstObject * parent, GstPadMode mode, gboolean active);
424 static gboolean gst_base_parse_handle_seek (GstBaseParse * parse,
425     GstEvent * event);
426 static void gst_base_parse_handle_tag (GstBaseParse * parse, GstEvent * event);
427
428 static void gst_base_parse_set_property (GObject * object, guint prop_id,
429     const GValue * value, GParamSpec * pspec);
430 static void gst_base_parse_get_property (GObject * object, guint prop_id,
431     GValue * value, GParamSpec * pspec);
432
433 static gboolean gst_base_parse_src_event (GstPad * pad, GstObject * parent,
434     GstEvent * event);
435 static gboolean gst_base_parse_src_query (GstPad * pad, GstObject * parent,
436     GstQuery * query);
437
438 static gboolean gst_base_parse_sink_event (GstPad * pad, GstObject * parent,
439     GstEvent * event);
440 static gboolean gst_base_parse_sink_query (GstPad * pad, GstObject * parent,
441     GstQuery * query);
442
443 static GstFlowReturn gst_base_parse_chain (GstPad * pad, GstObject * parent,
444     GstBuffer * buffer);
445 static void gst_base_parse_loop (GstPad * pad);
446
447 static GstFlowReturn gst_base_parse_parse_frame (GstBaseParse * parse,
448     GstBaseParseFrame * frame);
449
450 static gboolean gst_base_parse_sink_event_default (GstBaseParse * parse,
451     GstEvent * event);
452
453 static gboolean gst_base_parse_src_event_default (GstBaseParse * parse,
454     GstEvent * event);
455
456 static gboolean gst_base_parse_sink_query_default (GstBaseParse * parse,
457     GstQuery * query);
458 static gboolean gst_base_parse_src_query_default (GstBaseParse * parse,
459     GstQuery * query);
460
461 static void gst_base_parse_drain (GstBaseParse * parse);
462
463 static void gst_base_parse_post_bitrates (GstBaseParse * parse,
464     gboolean post_min, gboolean post_avg, gboolean post_max);
465
466 static gint64 gst_base_parse_find_offset (GstBaseParse * parse,
467     GstClockTime time, gboolean before, GstClockTime * _ts);
468 static GstFlowReturn gst_base_parse_locate_time (GstBaseParse * parse,
469     GstClockTime * _time, gint64 * _offset);
470
471 static GstFlowReturn gst_base_parse_start_fragment (GstBaseParse * parse);
472 static GstFlowReturn gst_base_parse_finish_fragment (GstBaseParse * parse,
473     gboolean prev_head);
474
475 static inline GstFlowReturn gst_base_parse_check_sync (GstBaseParse * parse);
476
477 static gboolean gst_base_parse_is_seekable (GstBaseParse * parse);
478
479 static void gst_base_parse_push_pending_events (GstBaseParse * parse);
480
481 static void
482 gst_base_parse_clear_queues (GstBaseParse * parse)
483 {
484   g_slist_foreach (parse->priv->buffers_queued, (GFunc) gst_buffer_unref, NULL);
485   g_slist_free (parse->priv->buffers_queued);
486   parse->priv->buffers_queued = NULL;
487   g_slist_foreach (parse->priv->buffers_pending, (GFunc) gst_buffer_unref,
488       NULL);
489   g_slist_free (parse->priv->buffers_pending);
490   parse->priv->buffers_pending = NULL;
491   g_slist_foreach (parse->priv->buffers_head, (GFunc) gst_buffer_unref, NULL);
492   g_slist_free (parse->priv->buffers_head);
493   parse->priv->buffers_head = NULL;
494   g_slist_foreach (parse->priv->buffers_send, (GFunc) gst_buffer_unref, NULL);
495   g_slist_free (parse->priv->buffers_send);
496   parse->priv->buffers_send = NULL;
497
498   g_list_foreach (parse->priv->detect_buffers, (GFunc) gst_buffer_unref, NULL);
499   g_list_free (parse->priv->detect_buffers);
500   parse->priv->detect_buffers = NULL;
501   parse->priv->detect_buffers_size = 0;
502
503   g_queue_foreach (&parse->priv->queued_frames,
504       (GFunc) gst_base_parse_frame_free, NULL);
505   g_queue_clear (&parse->priv->queued_frames);
506
507   gst_buffer_replace (&parse->priv->cache, NULL);
508
509   g_list_foreach (parse->priv->pending_events, (GFunc) gst_event_unref, NULL);
510   g_list_free (parse->priv->pending_events);
511   parse->priv->pending_events = NULL;
512   parse->priv->pending_segment = FALSE;
513 }
514
515 static void
516 gst_base_parse_finalize (GObject * object)
517 {
518   GstBaseParse *parse = GST_BASE_PARSE (object);
519
520   g_object_unref (parse->priv->adapter);
521
522   if (parse->priv->cache) {
523     gst_buffer_unref (parse->priv->cache);
524     parse->priv->cache = NULL;
525   }
526
527   g_list_foreach (parse->priv->pending_events, (GFunc) gst_mini_object_unref,
528       NULL);
529   g_list_free (parse->priv->pending_events);
530   parse->priv->pending_events = NULL;
531   parse->priv->pending_segment = FALSE;
532
533   if (parse->priv->index) {
534     gst_object_unref (parse->priv->index);
535     parse->priv->index = NULL;
536   }
537   g_mutex_clear (&parse->priv->index_lock);
538
539   gst_base_parse_clear_queues (parse);
540
541   G_OBJECT_CLASS (parent_class)->finalize (object);
542 }
543
544 static void
545 gst_base_parse_class_init (GstBaseParseClass * klass)
546 {
547   GObjectClass *gobject_class;
548   GstElementClass *gstelement_class;
549
550   gobject_class = G_OBJECT_CLASS (klass);
551   g_type_class_add_private (klass, sizeof (GstBaseParsePrivate));
552   parent_class = g_type_class_peek_parent (klass);
553
554   gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_base_parse_finalize);
555   gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_base_parse_set_property);
556   gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_base_parse_get_property);
557
558   /**
559    * GstBaseParse:disable-passthrough:
560    *
561    * If set to #TRUE, baseparse will unconditionally force parsing of the
562    * incoming data. This can be required in the rare cases where the incoming
563    * side-data (caps, pts, dts, ...) is not trusted by the user and wants to
564    * force validation and parsing of the incoming data.
565    * If set to #FALSE, decision of whether to parse the data or not is up to
566    * the implementation (standard behaviour).
567    */
568   g_object_class_install_property (gobject_class, PROP_DISABLE_PASSTHROUGH,
569       g_param_spec_boolean ("disable-passthrough", "Disable passthrough",
570           "Force processing (disables passthrough)",
571           DEFAULT_DISABLE_PASSTHROUGH,
572           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
573
574   gstelement_class = (GstElementClass *) klass;
575   gstelement_class->change_state =
576       GST_DEBUG_FUNCPTR (gst_base_parse_change_state);
577
578 #if 0
579   gstelement_class->set_index = GST_DEBUG_FUNCPTR (gst_base_parse_set_index);
580   gstelement_class->get_index = GST_DEBUG_FUNCPTR (gst_base_parse_get_index);
581 #endif
582
583   /* Default handlers */
584   klass->sink_event = gst_base_parse_sink_event_default;
585   klass->src_event = gst_base_parse_src_event_default;
586   klass->sink_query = gst_base_parse_sink_query_default;
587   klass->src_query = gst_base_parse_src_query_default;
588   klass->convert = gst_base_parse_convert_default;
589
590   GST_DEBUG_CATEGORY_INIT (gst_base_parse_debug, "baseparse", 0,
591       "baseparse element");
592 }
593
594 static void
595 gst_base_parse_init (GstBaseParse * parse, GstBaseParseClass * bclass)
596 {
597   GstPadTemplate *pad_template;
598
599   GST_DEBUG_OBJECT (parse, "gst_base_parse_init");
600
601   parse->priv = GST_BASE_PARSE_GET_PRIVATE (parse);
602
603   pad_template =
604       gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass), "sink");
605   g_return_if_fail (pad_template != NULL);
606   parse->sinkpad = gst_pad_new_from_template (pad_template, "sink");
607   gst_pad_set_event_function (parse->sinkpad,
608       GST_DEBUG_FUNCPTR (gst_base_parse_sink_event));
609   gst_pad_set_query_function (parse->sinkpad,
610       GST_DEBUG_FUNCPTR (gst_base_parse_sink_query));
611   gst_pad_set_chain_function (parse->sinkpad,
612       GST_DEBUG_FUNCPTR (gst_base_parse_chain));
613   gst_pad_set_activate_function (parse->sinkpad,
614       GST_DEBUG_FUNCPTR (gst_base_parse_sink_activate));
615   gst_pad_set_activatemode_function (parse->sinkpad,
616       GST_DEBUG_FUNCPTR (gst_base_parse_sink_activate_mode));
617   GST_PAD_SET_PROXY_ALLOCATION (parse->sinkpad);
618   gst_element_add_pad (GST_ELEMENT (parse), parse->sinkpad);
619
620   GST_DEBUG_OBJECT (parse, "sinkpad created");
621
622   pad_template =
623       gst_element_class_get_pad_template (GST_ELEMENT_CLASS (bclass), "src");
624   g_return_if_fail (pad_template != NULL);
625   parse->srcpad = gst_pad_new_from_template (pad_template, "src");
626   gst_pad_set_event_function (parse->srcpad,
627       GST_DEBUG_FUNCPTR (gst_base_parse_src_event));
628   gst_pad_set_query_function (parse->srcpad,
629       GST_DEBUG_FUNCPTR (gst_base_parse_src_query));
630   gst_pad_use_fixed_caps (parse->srcpad);
631   gst_element_add_pad (GST_ELEMENT (parse), parse->srcpad);
632   GST_DEBUG_OBJECT (parse, "src created");
633
634   g_queue_init (&parse->priv->queued_frames);
635
636   parse->priv->adapter = gst_adapter_new ();
637
638   parse->priv->pad_mode = GST_PAD_MODE_NONE;
639
640   g_mutex_init (&parse->priv->index_lock);
641
642   /* init state */
643   gst_base_parse_reset (parse);
644   GST_DEBUG_OBJECT (parse, "init ok");
645
646   GST_OBJECT_FLAG_SET (parse, GST_ELEMENT_FLAG_INDEXABLE);
647 }
648
649 static void
650 gst_base_parse_set_property (GObject * object, guint prop_id,
651     const GValue * value, GParamSpec * pspec)
652 {
653   GstBaseParse *parse = GST_BASE_PARSE (object);
654
655   switch (prop_id) {
656     case PROP_DISABLE_PASSTHROUGH:
657       parse->priv->disable_passthrough = g_value_get_boolean (value);
658       break;
659     default:
660       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
661       break;
662   }
663 }
664
665 static void
666 gst_base_parse_get_property (GObject * object, guint prop_id, GValue * value,
667     GParamSpec * pspec)
668 {
669   GstBaseParse *parse = GST_BASE_PARSE (object);
670
671   switch (prop_id) {
672     case PROP_DISABLE_PASSTHROUGH:
673       g_value_set_boolean (value, parse->priv->disable_passthrough);
674       break;
675     default:
676       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
677       break;
678   }
679 }
680
681 static GstBaseParseFrame *
682 gst_base_parse_frame_copy (GstBaseParseFrame * frame)
683 {
684   GstBaseParseFrame *copy;
685
686   copy = g_slice_dup (GstBaseParseFrame, frame);
687   copy->buffer = gst_buffer_ref (frame->buffer);
688   copy->_private_flags &= ~GST_BASE_PARSE_FRAME_PRIVATE_FLAG_NOALLOC;
689
690   GST_TRACE ("copied frame %p -> %p", frame, copy);
691
692   return copy;
693 }
694
695 void
696 gst_base_parse_frame_free (GstBaseParseFrame * frame)
697 {
698   GST_TRACE ("freeing frame %p", frame);
699
700   if (frame->buffer) {
701     gst_buffer_unref (frame->buffer);
702     frame->buffer = NULL;
703   }
704
705   if (!(frame->_private_flags & GST_BASE_PARSE_FRAME_PRIVATE_FLAG_NOALLOC)) {
706     g_slice_free (GstBaseParseFrame, frame);
707   } else {
708     memset (frame, 0, sizeof (*frame));
709   }
710 }
711
712 G_DEFINE_BOXED_TYPE (GstBaseParseFrame, gst_base_parse_frame,
713     (GBoxedCopyFunc) gst_base_parse_frame_copy,
714     (GBoxedFreeFunc) gst_base_parse_frame_free);
715
716 /**
717  * gst_base_parse_frame_init:
718  * @frame: #GstBaseParseFrame.
719  *
720  * Sets a #GstBaseParseFrame to initial state.  Currently this means
721  * all public fields are zero-ed and a private flag is set to make
722  * sure gst_base_parse_frame_free() only frees the contents but not
723  * the actual frame. Use this function to initialise a #GstBaseParseFrame
724  * allocated on the stack.
725  */
726 void
727 gst_base_parse_frame_init (GstBaseParseFrame * frame)
728 {
729   memset (frame, 0, sizeof (GstBaseParseFrame));
730   frame->_private_flags = GST_BASE_PARSE_FRAME_PRIVATE_FLAG_NOALLOC;
731   GST_TRACE ("inited frame %p", frame);
732 }
733
734 /**
735  * gst_base_parse_frame_new:
736  * @buffer: (transfer none): a #GstBuffer
737  * @flags: the flags
738  * @overhead: number of bytes in this frame which should be counted as
739  *     metadata overhead, ie. not used to calculate the average bitrate.
740  *     Set to -1 to mark the entire frame as metadata. If in doubt, set to 0.
741  *
742  * Allocates a new #GstBaseParseFrame. This function is mainly for bindings,
743  * elements written in C should usually allocate the frame on the stack and
744  * then use gst_base_parse_frame_init() to initialise it.
745  *
746  * Returns: a newly-allocated #GstBaseParseFrame. Free with
747  *     gst_base_parse_frame_free() when no longer needed.
748  */
749 GstBaseParseFrame *
750 gst_base_parse_frame_new (GstBuffer * buffer, GstBaseParseFrameFlags flags,
751     gint overhead)
752 {
753   GstBaseParseFrame *frame;
754
755   frame = g_slice_new0 (GstBaseParseFrame);
756   frame->buffer = gst_buffer_ref (buffer);
757
758   GST_TRACE ("created frame %p", frame);
759   return frame;
760 }
761
762 static inline void
763 gst_base_parse_frame_update (GstBaseParse * parse, GstBaseParseFrame * frame,
764     GstBuffer * buf)
765 {
766   gst_buffer_replace (&frame->buffer, buf);
767
768   parse->flags = 0;
769
770   /* set flags one by one for clarity */
771   if (G_UNLIKELY (parse->priv->drain))
772     parse->flags |= GST_BASE_PARSE_FLAG_DRAINING;
773
774   /* losing sync is pretty much a discont (and vice versa), no ? */
775   if (G_UNLIKELY (parse->priv->discont))
776     parse->flags |= GST_BASE_PARSE_FLAG_LOST_SYNC;
777 }
778
779 static void
780 gst_base_parse_reset (GstBaseParse * parse)
781 {
782   GST_OBJECT_LOCK (parse);
783   gst_segment_init (&parse->segment, GST_FORMAT_TIME);
784   parse->priv->duration = -1;
785   parse->priv->min_frame_size = 1;
786   parse->priv->discont = TRUE;
787   parse->priv->flushing = FALSE;
788   parse->priv->offset = 0;
789   parse->priv->sync_offset = 0;
790   parse->priv->update_interval = -1;
791   parse->priv->fps_num = parse->priv->fps_den = 0;
792   parse->priv->frame_duration = GST_CLOCK_TIME_NONE;
793   parse->priv->lead_in = parse->priv->lead_out = 0;
794   parse->priv->lead_in_ts = parse->priv->lead_out_ts = 0;
795   parse->priv->bitrate = 0;
796   parse->priv->framecount = 0;
797   parse->priv->bytecount = 0;
798   parse->priv->acc_duration = 0;
799   parse->priv->first_frame_pts = GST_CLOCK_TIME_NONE;
800   parse->priv->first_frame_dts = GST_CLOCK_TIME_NONE;
801   parse->priv->first_frame_offset = -1;
802   parse->priv->estimated_duration = -1;
803   parse->priv->estimated_drift = 0;
804   parse->priv->next_pts = GST_CLOCK_TIME_NONE;
805   parse->priv->next_dts = 0;
806   parse->priv->syncable = TRUE;
807   parse->priv->disable_passthrough = DEFAULT_DISABLE_PASSTHROUGH;
808   parse->priv->passthrough = FALSE;
809   parse->priv->pts_interpolate = TRUE;
810   parse->priv->infer_ts = TRUE;
811   parse->priv->has_timing_info = FALSE;
812   parse->priv->post_min_bitrate = TRUE;
813   parse->priv->post_avg_bitrate = TRUE;
814   parse->priv->post_max_bitrate = TRUE;
815   parse->priv->min_bitrate = G_MAXUINT;
816   parse->priv->max_bitrate = 0;
817   parse->priv->avg_bitrate = 0;
818   parse->priv->posted_avg_bitrate = 0;
819
820   parse->priv->index_last_ts = GST_CLOCK_TIME_NONE;
821   parse->priv->index_last_offset = -1;
822   parse->priv->index_last_valid = TRUE;
823   parse->priv->upstream_seekable = FALSE;
824   parse->priv->upstream_size = 0;
825   parse->priv->upstream_has_duration = FALSE;
826   parse->priv->upstream_format = GST_FORMAT_UNDEFINED;
827   parse->priv->idx_interval = 0;
828   parse->priv->idx_byte_interval = 0;
829   parse->priv->exact_position = TRUE;
830   parse->priv->seen_keyframe = FALSE;
831
832   parse->priv->last_dts = GST_CLOCK_TIME_NONE;
833   parse->priv->last_pts = GST_CLOCK_TIME_NONE;
834   parse->priv->last_offset = 0;
835
836   g_list_foreach (parse->priv->pending_events, (GFunc) gst_mini_object_unref,
837       NULL);
838   g_list_free (parse->priv->pending_events);
839   parse->priv->pending_events = NULL;
840   parse->priv->pending_segment = FALSE;
841
842   if (parse->priv->cache) {
843     gst_buffer_unref (parse->priv->cache);
844     parse->priv->cache = NULL;
845   }
846
847   g_slist_foreach (parse->priv->pending_seeks, (GFunc) g_free, NULL);
848   g_slist_free (parse->priv->pending_seeks);
849   parse->priv->pending_seeks = NULL;
850
851   if (parse->priv->adapter)
852     gst_adapter_clear (parse->priv->adapter);
853
854   parse->priv->new_frame = TRUE;
855
856   g_list_foreach (parse->priv->detect_buffers, (GFunc) gst_buffer_unref, NULL);
857   g_list_free (parse->priv->detect_buffers);
858   parse->priv->detect_buffers = NULL;
859   parse->priv->detect_buffers_size = 0;
860   GST_OBJECT_UNLOCK (parse);
861 }
862
863 /* gst_base_parse_parse_frame:
864  * @parse: #GstBaseParse.
865  * @buffer: #GstBuffer.
866  *
867  * Default callback for parse_frame.
868  */
869 static GstFlowReturn
870 gst_base_parse_parse_frame (GstBaseParse * parse, GstBaseParseFrame * frame)
871 {
872   GstBuffer *buffer = frame->buffer;
873
874   if (!GST_BUFFER_PTS_IS_VALID (buffer) &&
875       GST_CLOCK_TIME_IS_VALID (parse->priv->next_pts)) {
876     GST_BUFFER_PTS (buffer) = parse->priv->next_pts;
877   }
878   if (!GST_BUFFER_DTS_IS_VALID (buffer) &&
879       GST_CLOCK_TIME_IS_VALID (parse->priv->next_dts)) {
880     GST_BUFFER_DTS (buffer) = parse->priv->next_dts;
881   }
882   if (!GST_BUFFER_DURATION_IS_VALID (buffer) &&
883       GST_CLOCK_TIME_IS_VALID (parse->priv->frame_duration)) {
884     GST_BUFFER_DURATION (buffer) = parse->priv->frame_duration;
885   }
886   return GST_FLOW_OK;
887 }
888
889 /* gst_base_parse_convert:
890  * @parse: #GstBaseParse.
891  * @src_format: #GstFormat describing the source format.
892  * @src_value: Source value to be converted.
893  * @dest_format: #GstFormat defining the converted format.
894  * @dest_value: Pointer where the conversion result will be put.
895  *
896  * Converts using configured "convert" vmethod in #GstBaseParse class.
897  *
898  * Returns: TRUE if conversion was successful.
899  */
900 static gboolean
901 gst_base_parse_convert (GstBaseParse * parse,
902     GstFormat src_format,
903     gint64 src_value, GstFormat dest_format, gint64 * dest_value)
904 {
905   GstBaseParseClass *klass = GST_BASE_PARSE_GET_CLASS (parse);
906   gboolean ret;
907
908   g_return_val_if_fail (dest_value != NULL, FALSE);
909
910   if (!klass->convert)
911     return FALSE;
912
913   ret = klass->convert (parse, src_format, src_value, dest_format, dest_value);
914
915 #ifndef GST_DISABLE_GST_DEBUG
916   {
917     if (ret) {
918       if (src_format == GST_FORMAT_TIME && dest_format == GST_FORMAT_BYTES) {
919         GST_LOG_OBJECT (parse,
920             "TIME -> BYTES: %" GST_TIME_FORMAT " -> %" G_GINT64_FORMAT,
921             GST_TIME_ARGS (src_value), *dest_value);
922       } else if (dest_format == GST_FORMAT_TIME &&
923           src_format == GST_FORMAT_BYTES) {
924         GST_LOG_OBJECT (parse,
925             "BYTES -> TIME: %" G_GINT64_FORMAT " -> %" GST_TIME_FORMAT,
926             src_value, GST_TIME_ARGS (*dest_value));
927       } else {
928         GST_LOG_OBJECT (parse,
929             "%s -> %s: %" G_GINT64_FORMAT " -> %" G_GINT64_FORMAT,
930             GST_STR_NULL (gst_format_get_name (src_format)),
931             GST_STR_NULL (gst_format_get_name (dest_format)),
932             src_value, *dest_value);
933       }
934     } else {
935       GST_DEBUG_OBJECT (parse, "conversion failed");
936     }
937   }
938 #endif
939
940   return ret;
941 }
942
943 /* gst_base_parse_sink_event:
944  * @pad: #GstPad that received the event.
945  * @event: #GstEvent to be handled.
946  *
947  * Handler for sink pad events.
948  *
949  * Returns: TRUE if the event was handled.
950  */
951 static gboolean
952 gst_base_parse_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
953 {
954   GstBaseParse *parse = GST_BASE_PARSE (parent);
955   GstBaseParseClass *bclass = GST_BASE_PARSE_GET_CLASS (parse);
956   gboolean ret;
957
958   ret = bclass->sink_event (parse, event);
959
960   return ret;
961 }
962
963
964 /* gst_base_parse_sink_event_default:
965  * @parse: #GstBaseParse.
966  * @event: #GstEvent to be handled.
967  *
968  * Element-level event handler function.
969  *
970  * The event will be unreffed only if it has been handled and this
971  * function returns %TRUE
972  *
973  * Returns: %TRUE if the event was handled and not need forwarding.
974  */
975 static gboolean
976 gst_base_parse_sink_event_default (GstBaseParse * parse, GstEvent * event)
977 {
978   GstBaseParseClass *klass = GST_BASE_PARSE_GET_CLASS (parse);
979   gboolean ret = FALSE;
980   gboolean forward_immediate = FALSE;
981
982   GST_DEBUG_OBJECT (parse, "handling event %d, %s", GST_EVENT_TYPE (event),
983       GST_EVENT_TYPE_NAME (event));
984
985   switch (GST_EVENT_TYPE (event)) {
986     case GST_EVENT_CAPS:
987     {
988       GstCaps *caps;
989
990       gst_event_parse_caps (event, &caps);
991       GST_DEBUG_OBJECT (parse, "caps: %" GST_PTR_FORMAT, caps);
992
993       if (klass->set_sink_caps)
994         ret = klass->set_sink_caps (parse, caps);
995       else
996         ret = TRUE;
997
998       /* will send our own caps downstream */
999       gst_event_unref (event);
1000       event = NULL;
1001       break;
1002     }
1003     case GST_EVENT_SEGMENT:
1004     {
1005       const GstSegment *in_segment;
1006       GstSegment out_segment;
1007       gint64 offset = 0, next_dts;
1008       guint32 seqnum = gst_event_get_seqnum (event);
1009
1010       gst_event_parse_segment (event, &in_segment);
1011       gst_segment_init (&out_segment, GST_FORMAT_TIME);
1012
1013       GST_DEBUG_OBJECT (parse, "segment %" GST_SEGMENT_FORMAT, in_segment);
1014
1015       parse->priv->upstream_format = in_segment->format;
1016       if (in_segment->format == GST_FORMAT_BYTES) {
1017         GstBaseParseSeek *seek = NULL;
1018         GSList *node;
1019
1020         /* stop time is allowed to be open-ended, but not start & pos */
1021         offset = in_segment->time;
1022
1023         GST_OBJECT_LOCK (parse);
1024         for (node = parse->priv->pending_seeks; node; node = node->next) {
1025           GstBaseParseSeek *tmp = node->data;
1026
1027           if (tmp->offset == offset) {
1028             seek = tmp;
1029             break;
1030           }
1031         }
1032         parse->priv->pending_seeks =
1033             g_slist_remove (parse->priv->pending_seeks, seek);
1034         GST_OBJECT_UNLOCK (parse);
1035
1036         if (seek) {
1037           GST_DEBUG_OBJECT (parse,
1038               "Matched newsegment to%s seek: %" GST_SEGMENT_FORMAT,
1039               seek->accurate ? " accurate" : "", &seek->segment);
1040
1041           out_segment.start = seek->segment.start;
1042           out_segment.stop = seek->segment.stop;
1043           out_segment.time = seek->segment.start;
1044
1045           next_dts = seek->start_ts;
1046           parse->priv->exact_position = seek->accurate;
1047           g_free (seek);
1048         } else {
1049           /* best attempt convert */
1050           /* as these are only estimates, stop is kept open-ended to avoid
1051            * premature cutting */
1052           gst_base_parse_convert (parse, GST_FORMAT_BYTES, in_segment->start,
1053               GST_FORMAT_TIME, (gint64 *) & next_dts);
1054
1055           out_segment.start = next_dts;
1056           out_segment.stop = GST_CLOCK_TIME_NONE;
1057           out_segment.time = next_dts;
1058
1059           parse->priv->exact_position = (in_segment->start == 0);
1060         }
1061
1062         gst_event_unref (event);
1063
1064         event = gst_event_new_segment (&out_segment);
1065         gst_event_set_seqnum (event, seqnum);
1066
1067         GST_DEBUG_OBJECT (parse, "Converted incoming segment to TIME. %"
1068             GST_SEGMENT_FORMAT, in_segment);
1069
1070       } else if (in_segment->format != GST_FORMAT_TIME) {
1071         /* Unknown incoming segment format. Output a default open-ended
1072          * TIME segment */
1073         gst_event_unref (event);
1074
1075         out_segment.start = 0;
1076         out_segment.stop = GST_CLOCK_TIME_NONE;
1077         out_segment.time = 0;
1078
1079         event = gst_event_new_segment (&out_segment);
1080         gst_event_set_seqnum (event, seqnum);
1081
1082         next_dts = 0;
1083       } else {
1084         /* not considered BYTE seekable if it is talking to us in TIME,
1085          * whatever else it might claim */
1086         parse->priv->upstream_seekable = FALSE;
1087         next_dts = in_segment->start;
1088       }
1089
1090       memcpy (&parse->segment, &out_segment, sizeof (GstSegment));
1091
1092       /*
1093          gst_segment_set_newsegment (&parse->segment, update, rate,
1094          applied_rate, format, start, stop, start);
1095        */
1096
1097       /* save the segment for later, right before we push a new buffer so that
1098        * the caps are fixed and the next linked element can receive
1099        * the segment. */
1100       parse->priv->pending_segment = TRUE;
1101       ret = TRUE;
1102
1103       /* 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   GST_DEBUG_OBJECT (parse, "media is video: %d", parse->priv->is_video);
1860 }
1861
1862 /* takes ownership of frame */
1863 static void
1864 gst_base_parse_queue_frame (GstBaseParse * parse, GstBaseParseFrame * frame)
1865 {
1866   if (!(frame->_private_flags & GST_BASE_PARSE_FRAME_PRIVATE_FLAG_NOALLOC)) {
1867     /* frame allocated on the heap, we can just take ownership */
1868     g_queue_push_tail (&parse->priv->queued_frames, frame);
1869     GST_TRACE ("queued frame %p", frame);
1870   } else {
1871     GstBaseParseFrame *copy;
1872
1873     /* probably allocated on the stack, must make a proper copy */
1874     copy = gst_base_parse_frame_copy (frame);
1875     g_queue_push_tail (&parse->priv->queued_frames, copy);
1876     GST_TRACE ("queued frame %p (copy of %p)", copy, frame);
1877     gst_base_parse_frame_free (frame);
1878   }
1879 }
1880
1881 /* makes sure that @buf is properly prepared and decorated for passing
1882  * to baseclass, and an equally setup frame is returned setup with @buf.
1883  * Takes ownership of @buf. */
1884 static GstBaseParseFrame *
1885 gst_base_parse_prepare_frame (GstBaseParse * parse, GstBuffer * buffer)
1886 {
1887   GstBaseParseFrame *frame = NULL;
1888
1889   buffer = gst_buffer_make_writable (buffer);
1890
1891   GST_LOG_OBJECT (parse,
1892       "preparing frame at offset %" G_GUINT64_FORMAT
1893       " (%#" G_GINT64_MODIFIER "x) of size %" G_GSIZE_FORMAT,
1894       GST_BUFFER_OFFSET (buffer), GST_BUFFER_OFFSET (buffer),
1895       gst_buffer_get_size (buffer));
1896
1897   if (parse->priv->discont) {
1898     GST_DEBUG_OBJECT (parse, "marking DISCONT");
1899     GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_DISCONT);
1900     parse->priv->discont = FALSE;
1901   }
1902
1903   GST_BUFFER_OFFSET (buffer) = parse->priv->offset;
1904
1905   frame = gst_base_parse_frame_new (buffer, 0, 0);
1906
1907   /* also ensure to update state flags */
1908   gst_base_parse_frame_update (parse, frame, buffer);
1909   gst_buffer_unref (buffer);
1910
1911   if (parse->priv->prev_offset != parse->priv->offset || parse->priv->new_frame) {
1912     GST_LOG_OBJECT (parse, "marking as new frame");
1913     parse->priv->new_frame = FALSE;
1914     frame->flags |= GST_BASE_PARSE_FRAME_FLAG_NEW_FRAME;
1915   }
1916
1917   frame->offset = parse->priv->prev_offset = parse->priv->offset;
1918
1919   /* use default handler to provide initial (upstream) metadata */
1920   gst_base_parse_parse_frame (parse, frame);
1921
1922   return frame;
1923 }
1924
1925 /* Wraps buffer in a frame and dispatches to subclass.
1926  * Also manages data skipping and offset handling (including adapter flushing).
1927  * Takes ownership of @buffer */
1928 static GstFlowReturn
1929 gst_base_parse_handle_buffer (GstBaseParse * parse, GstBuffer * buffer,
1930     gint * skip, gint * flushed)
1931 {
1932   GstBaseParseClass *klass = GST_BASE_PARSE_GET_CLASS (parse);
1933   GstBaseParseFrame *frame;
1934   GstFlowReturn ret;
1935
1936   g_return_val_if_fail (skip != NULL || flushed != NULL, GST_FLOW_ERROR);
1937
1938   GST_LOG_OBJECT (parse,
1939       "handling buffer of size %" G_GSIZE_FORMAT " with dts %" GST_TIME_FORMAT
1940       ", pts %" GST_TIME_FORMAT ", duration %" GST_TIME_FORMAT,
1941       gst_buffer_get_size (buffer), GST_TIME_ARGS (GST_BUFFER_DTS (buffer)),
1942       GST_TIME_ARGS (GST_BUFFER_PTS (buffer)),
1943       GST_TIME_ARGS (GST_BUFFER_DURATION (buffer)));
1944
1945   /* track what is being flushed during this single round of frame processing */
1946   parse->priv->flushed = 0;
1947   *skip = 0;
1948
1949   /* make it easy for _finish_frame to pick up input data */
1950   if (parse->priv->pad_mode == GST_PAD_MODE_PULL) {
1951     gst_buffer_ref (buffer);
1952     gst_adapter_push (parse->priv->adapter, buffer);
1953   }
1954
1955   frame = gst_base_parse_prepare_frame (parse, buffer);
1956   ret = klass->handle_frame (parse, frame, skip);
1957
1958   *flushed = parse->priv->flushed;
1959
1960   GST_LOG_OBJECT (parse, "handle_frame skipped %d, flushed %d",
1961       *skip, *flushed);
1962
1963   /* subclass can only do one of these, or semantics are too unclear */
1964   g_assert (*skip == 0 || *flushed == 0);
1965
1966   /* track skipping */
1967   if (*skip > 0) {
1968     GstClockTime pts, dts;
1969     GstBuffer *outbuf;
1970
1971     GST_LOG_OBJECT (parse, "finding sync, skipping %d bytes", *skip);
1972     if (parse->segment.rate < 0.0 && !parse->priv->buffers_queued) {
1973       /* reverse playback, and no frames found yet, so we are skipping
1974        * the leading part of a fragment, which may form the tail of
1975        * fragment coming later, hopefully subclass skips efficiently ... */
1976       pts = gst_adapter_prev_pts (parse->priv->adapter, NULL);
1977       dts = gst_adapter_prev_dts (parse->priv->adapter, NULL);
1978       outbuf = gst_adapter_take_buffer (parse->priv->adapter, *skip);
1979       outbuf = gst_buffer_make_writable (outbuf);
1980       GST_BUFFER_PTS (outbuf) = pts;
1981       GST_BUFFER_DTS (outbuf) = dts;
1982       parse->priv->buffers_head =
1983           g_slist_prepend (parse->priv->buffers_head, outbuf);
1984       outbuf = NULL;
1985     } else {
1986       gst_adapter_flush (parse->priv->adapter, *skip);
1987     }
1988     if (!parse->priv->discont)
1989       parse->priv->sync_offset = parse->priv->offset;
1990     parse->priv->offset += *skip;
1991     parse->priv->discont = TRUE;
1992     /* check for indefinite skipping */
1993     if (ret == GST_FLOW_OK)
1994       ret = gst_base_parse_check_sync (parse);
1995   }
1996
1997   parse->priv->offset += *flushed;
1998
1999   if (parse->priv->pad_mode == GST_PAD_MODE_PULL) {
2000     gst_adapter_clear (parse->priv->adapter);
2001   }
2002
2003   gst_base_parse_frame_free (frame);
2004
2005   return ret;
2006 }
2007
2008 /* gst_base_parse_push_pending_events:
2009  * @parse: #GstBaseParse
2010  *
2011  * Pushes the pending events
2012  */
2013 static void
2014 gst_base_parse_push_pending_events (GstBaseParse * parse)
2015 {
2016   if (G_UNLIKELY (parse->priv->pending_events)) {
2017     GList *r = g_list_reverse (parse->priv->pending_events);
2018     GList *l;
2019
2020     parse->priv->pending_events = NULL;
2021     for (l = r; l != NULL; l = l->next) {
2022       gst_pad_push_event (parse->srcpad, GST_EVENT_CAST (l->data));
2023     }
2024     g_list_free (r);
2025     parse->priv->pending_segment = FALSE;
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->pending_segment)) {
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         parse->priv->pending_segment = TRUE;
3323         result = TRUE;
3324       } else {
3325         result = gst_pad_stop_task (pad);
3326       }
3327       break;
3328     default:
3329       result = TRUE;
3330       break;
3331   }
3332   if (result)
3333     parse->priv->pad_mode = active ? mode : GST_PAD_MODE_NONE;
3334
3335   GST_DEBUG_OBJECT (parse, "sink activate return: %d", result);
3336
3337   return result;
3338
3339   /* ERRORS */
3340 activate_failed:
3341   {
3342     GST_DEBUG_OBJECT (parse, "activate failed");
3343     return FALSE;
3344   }
3345 }
3346
3347 /**
3348  * gst_base_parse_set_duration:
3349  * @parse: #GstBaseParse.
3350  * @fmt: #GstFormat.
3351  * @duration: duration value.
3352  * @interval: how often to update the duration estimate based on bitrate, or 0.
3353  *
3354  * Sets the duration of the currently playing media. Subclass can use this
3355  * when it is able to determine duration and/or notices a change in the media
3356  * duration.  Alternatively, if @interval is non-zero (default), then stream
3357  * duration is determined based on estimated bitrate, and updated every @interval
3358  * frames.
3359  */
3360 void
3361 gst_base_parse_set_duration (GstBaseParse * parse,
3362     GstFormat fmt, gint64 duration, gint interval)
3363 {
3364   g_return_if_fail (parse != NULL);
3365
3366   if (parse->priv->upstream_has_duration) {
3367     GST_DEBUG_OBJECT (parse, "using upstream duration; discarding update");
3368     goto exit;
3369   }
3370
3371   if (duration != parse->priv->duration) {
3372     GstMessage *m;
3373
3374     m = gst_message_new_duration_changed (GST_OBJECT (parse));
3375     gst_element_post_message (GST_ELEMENT (parse), m);
3376
3377     /* TODO: what about duration tag? */
3378   }
3379   parse->priv->duration = duration;
3380   parse->priv->duration_fmt = fmt;
3381   GST_DEBUG_OBJECT (parse, "set duration: %" G_GINT64_FORMAT, duration);
3382   if (fmt == GST_FORMAT_TIME && GST_CLOCK_TIME_IS_VALID (duration)) {
3383     if (interval != 0) {
3384       GST_DEBUG_OBJECT (parse, "valid duration provided, disabling estimate");
3385       interval = 0;
3386     }
3387   }
3388   GST_DEBUG_OBJECT (parse, "set update interval: %d", interval);
3389   parse->priv->update_interval = interval;
3390 exit:
3391   return;
3392 }
3393
3394 /**
3395  * gst_base_parse_set_average_bitrate:
3396  * @parse: #GstBaseParse.
3397  * @bitrate: average bitrate in bits/second
3398  *
3399  * Optionally sets the average bitrate detected in media (if non-zero),
3400  * e.g. based on metadata, as it will be posted to the application.
3401  *
3402  * By default, announced average bitrate is estimated. The average bitrate
3403  * is used to estimate the total duration of the stream and to estimate
3404  * a seek position, if there's no index and the format is syncable
3405  * (see gst_base_parse_set_syncable()).
3406  */
3407 void
3408 gst_base_parse_set_average_bitrate (GstBaseParse * parse, guint bitrate)
3409 {
3410   parse->priv->bitrate = bitrate;
3411   GST_DEBUG_OBJECT (parse, "bitrate %u", bitrate);
3412 }
3413
3414 /**
3415  * gst_base_parse_set_min_frame_size:
3416  * @parse: #GstBaseParse.
3417  * @min_size: Minimum size of the data that this base class should give to
3418  *            subclass.
3419  *
3420  * Subclass can use this function to tell the base class that it needs to
3421  * give at least #min_size buffers.
3422  */
3423 void
3424 gst_base_parse_set_min_frame_size (GstBaseParse * parse, guint min_size)
3425 {
3426   g_return_if_fail (parse != NULL);
3427
3428   parse->priv->min_frame_size = min_size;
3429   GST_LOG_OBJECT (parse, "set frame_min_size: %d", min_size);
3430 }
3431
3432 /**
3433  * gst_base_parse_set_frame_rate:
3434  * @parse: the #GstBaseParse to set
3435  * @fps_num: frames per second (numerator).
3436  * @fps_den: frames per second (denominator).
3437  * @lead_in: frames needed before a segment for subsequent decode
3438  * @lead_out: frames needed after a segment
3439  *
3440  * If frames per second is configured, parser can take care of buffer duration
3441  * and timestamping.  When performing segment clipping, or seeking to a specific
3442  * location, a corresponding decoder might need an initial @lead_in and a
3443  * following @lead_out number of frames to ensure the desired segment is
3444  * entirely filled upon decoding.
3445  */
3446 void
3447 gst_base_parse_set_frame_rate (GstBaseParse * parse, guint fps_num,
3448     guint fps_den, guint lead_in, guint lead_out)
3449 {
3450   g_return_if_fail (parse != NULL);
3451
3452   parse->priv->fps_num = fps_num;
3453   parse->priv->fps_den = fps_den;
3454   if (!fps_num || !fps_den) {
3455     GST_DEBUG_OBJECT (parse, "invalid fps (%d/%d), ignoring parameters",
3456         fps_num, fps_den);
3457     fps_num = fps_den = 0;
3458     parse->priv->frame_duration = GST_CLOCK_TIME_NONE;
3459     parse->priv->lead_in = parse->priv->lead_out = 0;
3460     parse->priv->lead_in_ts = parse->priv->lead_out_ts = 0;
3461   } else {
3462     parse->priv->frame_duration =
3463         gst_util_uint64_scale (GST_SECOND, fps_den, fps_num);
3464     parse->priv->lead_in = lead_in;
3465     parse->priv->lead_out = lead_out;
3466     parse->priv->lead_in_ts =
3467         gst_util_uint64_scale (GST_SECOND, fps_den * lead_in, fps_num);
3468     parse->priv->lead_out_ts =
3469         gst_util_uint64_scale (GST_SECOND, fps_den * lead_out, fps_num);
3470     /* aim for about 1.5s to estimate duration */
3471     if (parse->priv->update_interval < 0) {
3472       parse->priv->update_interval = fps_num * 3 / (fps_den * 2);
3473       GST_LOG_OBJECT (parse, "estimated update interval to %d frames",
3474           parse->priv->update_interval);
3475     }
3476   }
3477   GST_LOG_OBJECT (parse, "set fps: %d/%d => duration: %" G_GINT64_FORMAT " ms",
3478       fps_num, fps_den, parse->priv->frame_duration / GST_MSECOND);
3479   GST_LOG_OBJECT (parse, "set lead in: %d frames = %" G_GUINT64_FORMAT " ms, "
3480       "lead out: %d frames = %" G_GUINT64_FORMAT " ms",
3481       lead_in, parse->priv->lead_in_ts / GST_MSECOND,
3482       lead_out, parse->priv->lead_out_ts / GST_MSECOND);
3483 }
3484
3485 /**
3486  * gst_base_parse_set_has_timing_info:
3487  * @parse: a #GstBaseParse
3488  * @has_timing: whether frames carry timing information
3489  *
3490  * Set if frames carry timing information which the subclass can (generally)
3491  * parse and provide.  In particular, intrinsic (rather than estimated) time
3492  * can be obtained following a seek.
3493  */
3494 void
3495 gst_base_parse_set_has_timing_info (GstBaseParse * parse, gboolean has_timing)
3496 {
3497   parse->priv->has_timing_info = has_timing;
3498   GST_INFO_OBJECT (parse, "has_timing: %s", (has_timing) ? "yes" : "no");
3499 }
3500
3501 /**
3502  * gst_base_parse_set_syncable:
3503  * @parse: a #GstBaseParse
3504  * @syncable: set if frame starts can be identified
3505  *
3506  * Set if frame starts can be identified. This is set by default and
3507  * determines whether seeking based on bitrate averages
3508  * is possible for a format/stream.
3509  */
3510 void
3511 gst_base_parse_set_syncable (GstBaseParse * parse, gboolean syncable)
3512 {
3513   parse->priv->syncable = syncable;
3514   GST_INFO_OBJECT (parse, "syncable: %s", (syncable) ? "yes" : "no");
3515 }
3516
3517 /**
3518  * gst_base_parse_set_passthrough:
3519  * @parse: a #GstBaseParse
3520  * @passthrough: %TRUE if parser should run in passthrough mode
3521  *
3522  * Set if the nature of the format or configuration does not allow (much)
3523  * parsing, and the parser should operate in passthrough mode (which only
3524  * applies when operating in push mode). That is, incoming buffers are
3525  * pushed through unmodified, i.e. no @check_valid_frame or @parse_frame
3526  * callbacks will be invoked, but @pre_push_frame will still be invoked,
3527  * so subclass can perform as much or as little is appropriate for
3528  * passthrough semantics in @pre_push_frame.
3529  */
3530 void
3531 gst_base_parse_set_passthrough (GstBaseParse * parse, gboolean passthrough)
3532 {
3533   parse->priv->passthrough = passthrough;
3534   GST_INFO_OBJECT (parse, "passthrough: %s", (passthrough) ? "yes" : "no");
3535 }
3536
3537 /**
3538  * gst_base_parse_set_pts_interpolation:
3539  * @parse: a #GstBaseParse
3540  * @pts_interpolate: %TRUE if parser should interpolate PTS timestamps
3541  *
3542  * By default, the base class will guess PTS timestamps using a simple
3543  * interpolation (previous timestamp + duration), which is incorrect for
3544  * data streams with reordering, where PTS can go backward. Sub-classes
3545  * implementing such formats should disable PTS interpolation.
3546  */
3547 void
3548 gst_base_parse_set_pts_interpolation (GstBaseParse * parse,
3549     gboolean pts_interpolate)
3550 {
3551   parse->priv->pts_interpolate = pts_interpolate;
3552   GST_INFO_OBJECT (parse, "PTS interpolation: %s",
3553       (pts_interpolate) ? "yes" : "no");
3554 }
3555
3556 /**
3557  * gst_base_parse_set_infer_ts:
3558  * @parse: a #GstBaseParse
3559  * @infer_ts: %TRUE if parser should infer DTS/PTS from each other
3560  *
3561  * By default, the base class might try to infer PTS from DTS and vice
3562  * versa.  While this is generally correct for audio data, it may not
3563  * be otherwise. Sub-classes implementing such formats should disable
3564  * timestamp inferring.
3565  */
3566 void
3567 gst_base_parse_set_infer_ts (GstBaseParse * parse, gboolean infer_ts)
3568 {
3569   parse->priv->infer_ts = infer_ts;
3570   GST_INFO_OBJECT (parse, "TS inferring: %s", (infer_ts) ? "yes" : "no");
3571 }
3572
3573 /**
3574  * gst_base_parse_set_latency:
3575  * @parse: a #GstBaseParse
3576  * @min_latency: minimum parse latency
3577  * @max_latency: maximum parse latency
3578  *
3579  * Sets the minimum and maximum (which may likely be equal) latency introduced
3580  * by the parsing process.  If there is such a latency, which depends on the
3581  * particular parsing of the format, it typically corresponds to 1 frame duration.
3582  */
3583 void
3584 gst_base_parse_set_latency (GstBaseParse * parse, GstClockTime min_latency,
3585     GstClockTime max_latency)
3586 {
3587   GST_OBJECT_LOCK (parse);
3588   parse->priv->min_latency = min_latency;
3589   parse->priv->max_latency = max_latency;
3590   GST_OBJECT_UNLOCK (parse);
3591   GST_INFO_OBJECT (parse, "min/max latency %" GST_TIME_FORMAT ", %"
3592       GST_TIME_FORMAT, GST_TIME_ARGS (min_latency),
3593       GST_TIME_ARGS (max_latency));
3594 }
3595
3596 static gboolean
3597 gst_base_parse_get_duration (GstBaseParse * parse, GstFormat format,
3598     GstClockTime * duration)
3599 {
3600   gboolean res = FALSE;
3601
3602   g_return_val_if_fail (duration != NULL, FALSE);
3603
3604   *duration = GST_CLOCK_TIME_NONE;
3605   if (parse->priv->duration != -1 && format == parse->priv->duration_fmt) {
3606     GST_LOG_OBJECT (parse, "using provided duration");
3607     *duration = parse->priv->duration;
3608     res = TRUE;
3609   } else if (parse->priv->duration != -1) {
3610     GST_LOG_OBJECT (parse, "converting provided duration");
3611     res = gst_base_parse_convert (parse, parse->priv->duration_fmt,
3612         parse->priv->duration, format, (gint64 *) duration);
3613   } else if (format == GST_FORMAT_TIME && parse->priv->estimated_duration != -1) {
3614     GST_LOG_OBJECT (parse, "using estimated duration");
3615     *duration = parse->priv->estimated_duration;
3616     res = TRUE;
3617   } else {
3618     GST_LOG_OBJECT (parse, "cannot estimate duration");
3619   }
3620
3621   GST_LOG_OBJECT (parse, "res: %d, duration %" GST_TIME_FORMAT, res,
3622       GST_TIME_ARGS (*duration));
3623   return res;
3624 }
3625
3626 static gboolean
3627 gst_base_parse_src_query_default (GstBaseParse * parse, GstQuery * query)
3628 {
3629   gboolean res = FALSE;
3630   GstPad *pad;
3631
3632   pad = GST_BASE_PARSE_SRC_PAD (parse);
3633
3634   switch (GST_QUERY_TYPE (query)) {
3635     case GST_QUERY_POSITION:
3636     {
3637       gint64 dest_value;
3638       GstFormat format;
3639
3640       GST_DEBUG_OBJECT (parse, "position query");
3641       gst_query_parse_position (query, &format, NULL);
3642
3643       /* try upstream first */
3644       res = gst_pad_query_default (pad, GST_OBJECT_CAST (parse), query);
3645       if (!res) {
3646         /* Fall back on interpreting segment */
3647         GST_OBJECT_LOCK (parse);
3648         if (format == GST_FORMAT_BYTES) {
3649           dest_value = parse->priv->offset;
3650           res = TRUE;
3651         } else if (format == parse->segment.format &&
3652             GST_CLOCK_TIME_IS_VALID (parse->segment.position)) {
3653           dest_value = gst_segment_to_stream_time (&parse->segment,
3654               parse->segment.format, parse->segment.position);
3655           res = TRUE;
3656         }
3657         GST_OBJECT_UNLOCK (parse);
3658         if (!res) {
3659           /* no precise result, upstream no idea either, then best estimate */
3660           /* priv->offset is updated in both PUSH/PULL modes */
3661           res = gst_base_parse_convert (parse,
3662               GST_FORMAT_BYTES, parse->priv->offset, format, &dest_value);
3663         }
3664         if (res)
3665           gst_query_set_position (query, format, dest_value);
3666       }
3667       break;
3668     }
3669     case GST_QUERY_DURATION:
3670     {
3671       GstFormat format;
3672       GstClockTime duration;
3673
3674       GST_DEBUG_OBJECT (parse, "duration query");
3675       gst_query_parse_duration (query, &format, NULL);
3676
3677       /* consult upstream */
3678       res = gst_pad_query_default (pad, GST_OBJECT_CAST (parse), query);
3679
3680       /* otherwise best estimate from us */
3681       if (!res) {
3682         res = gst_base_parse_get_duration (parse, format, &duration);
3683         if (res)
3684           gst_query_set_duration (query, format, duration);
3685       }
3686       break;
3687     }
3688     case GST_QUERY_SEEKING:
3689     {
3690       GstFormat fmt;
3691       GstClockTime duration = GST_CLOCK_TIME_NONE;
3692       gboolean seekable = FALSE;
3693
3694       GST_DEBUG_OBJECT (parse, "seeking query");
3695       gst_query_parse_seeking (query, &fmt, NULL, NULL, NULL);
3696
3697       /* consult upstream */
3698       res = gst_pad_query_default (pad, GST_OBJECT_CAST (parse), query);
3699
3700       /* we may be able to help if in TIME */
3701       if (fmt == GST_FORMAT_TIME && gst_base_parse_is_seekable (parse)) {
3702         gst_query_parse_seeking (query, &fmt, &seekable, NULL, NULL);
3703         /* already OK if upstream takes care */
3704         GST_LOG_OBJECT (parse, "upstream handled %d, seekable %d",
3705             res, seekable);
3706         if (!(res && seekable)) {
3707           if (!gst_base_parse_get_duration (parse, GST_FORMAT_TIME, &duration)
3708               || duration == -1) {
3709             /* seekable if we still have a chance to get duration later on */
3710             seekable =
3711                 parse->priv->upstream_seekable && parse->priv->update_interval;
3712           } else {
3713             seekable = parse->priv->upstream_seekable;
3714             GST_LOG_OBJECT (parse, "already determine upstream seekabled: %d",
3715                 seekable);
3716           }
3717           gst_query_set_seeking (query, GST_FORMAT_TIME, seekable, 0, duration);
3718           res = TRUE;
3719         }
3720       }
3721       break;
3722     }
3723     case GST_QUERY_FORMATS:
3724       gst_query_set_formatsv (query, 3, fmtlist);
3725       res = TRUE;
3726       break;
3727     case GST_QUERY_CONVERT:
3728     {
3729       GstFormat src_format, dest_format;
3730       gint64 src_value, dest_value;
3731
3732       gst_query_parse_convert (query, &src_format, &src_value,
3733           &dest_format, &dest_value);
3734
3735       res = gst_base_parse_convert (parse, src_format, src_value,
3736           dest_format, &dest_value);
3737       if (res) {
3738         gst_query_set_convert (query, src_format, src_value,
3739             dest_format, dest_value);
3740       }
3741       break;
3742     }
3743     case GST_QUERY_LATENCY:
3744     {
3745       if ((res = gst_pad_peer_query (parse->sinkpad, query))) {
3746         gboolean live;
3747         GstClockTime min_latency, max_latency;
3748
3749         gst_query_parse_latency (query, &live, &min_latency, &max_latency);
3750         GST_DEBUG_OBJECT (parse, "Peer latency: live %d, min %"
3751             GST_TIME_FORMAT " max %" GST_TIME_FORMAT, live,
3752             GST_TIME_ARGS (min_latency), GST_TIME_ARGS (max_latency));
3753
3754         GST_OBJECT_LOCK (parse);
3755         /* add our latency */
3756         if (min_latency != -1)
3757           min_latency += parse->priv->min_latency;
3758         if (max_latency != -1)
3759           max_latency += parse->priv->max_latency;
3760         GST_OBJECT_UNLOCK (parse);
3761
3762         gst_query_set_latency (query, live, min_latency, max_latency);
3763       }
3764       break;
3765     }
3766     case GST_QUERY_SEGMENT:
3767     {
3768       GstFormat format;
3769       gint64 start, stop;
3770
3771       format = parse->segment.format;
3772
3773       start =
3774           gst_segment_to_stream_time (&parse->segment, format,
3775           parse->segment.start);
3776       if ((stop = parse->segment.stop) == -1)
3777         stop = parse->segment.duration;
3778       else
3779         stop = gst_segment_to_stream_time (&parse->segment, format, stop);
3780
3781       gst_query_set_segment (query, parse->segment.rate, format, start, stop);
3782       res = TRUE;
3783       break;
3784     }
3785     default:
3786       res = gst_pad_query_default (pad, GST_OBJECT_CAST (parse), query);
3787       break;
3788   }
3789   return res;
3790 }
3791
3792 /* scans for a cluster start from @pos,
3793  * return GST_FLOW_OK and frame position/time in @pos/@time if found */
3794 static GstFlowReturn
3795 gst_base_parse_find_frame (GstBaseParse * parse, gint64 * pos,
3796     GstClockTime * time, GstClockTime * duration)
3797 {
3798   GstBaseParseClass *klass;
3799   gint64 orig_offset;
3800   gboolean orig_drain, orig_discont;
3801   GstFlowReturn ret = GST_FLOW_OK;
3802   GstBuffer *buf = NULL;
3803   GstBaseParseFrame *sframe = NULL;
3804
3805   g_return_val_if_fail (pos != NULL, GST_FLOW_ERROR);
3806   g_return_val_if_fail (time != NULL, GST_FLOW_ERROR);
3807   g_return_val_if_fail (duration != NULL, GST_FLOW_ERROR);
3808
3809   klass = GST_BASE_PARSE_GET_CLASS (parse);
3810
3811   *time = GST_CLOCK_TIME_NONE;
3812   *duration = GST_CLOCK_TIME_NONE;
3813
3814   /* save state */
3815   orig_offset = parse->priv->offset;
3816   orig_discont = parse->priv->discont;
3817   orig_drain = parse->priv->drain;
3818
3819   GST_DEBUG_OBJECT (parse, "scanning for frame starting at %" G_GINT64_FORMAT
3820       " (%#" G_GINT64_MODIFIER "x)", *pos, *pos);
3821
3822   /* jump elsewhere and locate next frame */
3823   parse->priv->offset = *pos;
3824   /* mark as scanning so frames don't get processed all the way */
3825   parse->priv->scanning = TRUE;
3826   ret = gst_base_parse_scan_frame (parse, klass);
3827   parse->priv->scanning = FALSE;
3828   /* retrieve frame found during scan */
3829   sframe = parse->priv->scanned_frame;
3830   parse->priv->scanned_frame = NULL;
3831
3832   if (ret != GST_FLOW_OK || !sframe)
3833     goto done;
3834
3835   /* get offset first, subclass parsing might dump other stuff in there */
3836   *pos = sframe->offset;
3837   buf = sframe->buffer;
3838   g_assert (buf);
3839
3840   /* but it should provide proper time */
3841   *time = GST_BUFFER_TIMESTAMP (buf);
3842   *duration = GST_BUFFER_DURATION (buf);
3843
3844   GST_LOG_OBJECT (parse,
3845       "frame with time %" GST_TIME_FORMAT " at offset %" G_GINT64_FORMAT,
3846       GST_TIME_ARGS (*time), *pos);
3847
3848 done:
3849   if (sframe)
3850     gst_base_parse_frame_free (sframe);
3851
3852   /* restore state */
3853   parse->priv->offset = orig_offset;
3854   parse->priv->discont = orig_discont;
3855   parse->priv->drain = orig_drain;
3856
3857   return ret;
3858 }
3859
3860 /* bisect and scan through file for frame starting before @time,
3861  * returns OK and @time/@offset if found, NONE and/or error otherwise
3862  * If @time == G_MAXINT64, scan for duration ( == last frame) */
3863 static GstFlowReturn
3864 gst_base_parse_locate_time (GstBaseParse * parse, GstClockTime * _time,
3865     gint64 * _offset)
3866 {
3867   GstFlowReturn ret = GST_FLOW_OK;
3868   gint64 lpos, hpos, newpos;
3869   GstClockTime time, ltime, htime, newtime, dur;
3870   gboolean cont = TRUE;
3871   const GstClockTime tolerance = TARGET_DIFFERENCE;
3872   const guint chunk = 4 * 1024;
3873
3874   g_return_val_if_fail (_time != NULL, GST_FLOW_ERROR);
3875   g_return_val_if_fail (_offset != NULL, GST_FLOW_ERROR);
3876
3877   GST_DEBUG_OBJECT (parse, "Bisecting for time %" GST_TIME_FORMAT,
3878       GST_TIME_ARGS (*_time));
3879
3880   /* TODO also make keyframe aware if useful some day */
3881
3882   time = *_time;
3883
3884   /* basic cases */
3885   if (time == 0) {
3886     *_offset = 0;
3887     return GST_FLOW_OK;
3888   }
3889
3890   if (time == -1) {
3891     *_offset = -1;
3892     return GST_FLOW_OK;
3893   }
3894
3895   /* do not know at first */
3896   *_offset = -1;
3897   *_time = GST_CLOCK_TIME_NONE;
3898
3899   /* need initial positions; start and end */
3900   lpos = parse->priv->first_frame_offset;
3901   ltime = parse->priv->first_frame_pts;
3902   /* try other one if no luck */
3903   if (!GST_CLOCK_TIME_IS_VALID (ltime))
3904     ltime = parse->priv->first_frame_dts;
3905   if (!gst_base_parse_get_duration (parse, GST_FORMAT_TIME, &htime)) {
3906     GST_DEBUG_OBJECT (parse, "Unknown time duration, cannot bisect");
3907     return GST_FLOW_ERROR;
3908   }
3909   hpos = parse->priv->upstream_size;
3910
3911   GST_DEBUG_OBJECT (parse,
3912       "Bisection initial bounds: bytes %" G_GINT64_FORMAT " %" G_GINT64_FORMAT
3913       ", times %" GST_TIME_FORMAT " %" GST_TIME_FORMAT, lpos, hpos,
3914       GST_TIME_ARGS (ltime), GST_TIME_ARGS (htime));
3915
3916   /* check preconditions are satisfied;
3917    * start and end are needed, except for special case where we scan for
3918    * last frame to determine duration */
3919   if (parse->priv->pad_mode != GST_PAD_MODE_PULL || !hpos ||
3920       !GST_CLOCK_TIME_IS_VALID (ltime) ||
3921       (!GST_CLOCK_TIME_IS_VALID (htime) && time != G_MAXINT64)) {
3922     return GST_FLOW_OK;
3923   }
3924
3925   /* shortcut cases */
3926   if (time < ltime) {
3927     goto exit;
3928   } else if (time < ltime + tolerance) {
3929     *_offset = lpos;
3930     *_time = ltime;
3931     goto exit;
3932   } else if (time >= htime) {
3933     *_offset = hpos;
3934     *_time = htime;
3935     goto exit;
3936   }
3937
3938   while (htime > ltime && cont) {
3939     GST_LOG_OBJECT (parse,
3940         "lpos: %" G_GUINT64_FORMAT ", ltime: %" GST_TIME_FORMAT, lpos,
3941         GST_TIME_ARGS (ltime));
3942     GST_LOG_OBJECT (parse,
3943         "hpos: %" G_GUINT64_FORMAT ", htime: %" GST_TIME_FORMAT, hpos,
3944         GST_TIME_ARGS (htime));
3945     if (G_UNLIKELY (time == G_MAXINT64)) {
3946       newpos = hpos;
3947     } else if (G_LIKELY (hpos > lpos)) {
3948       newpos =
3949           gst_util_uint64_scale (hpos - lpos, time - ltime, htime - ltime) +
3950           lpos - chunk;
3951     } else {
3952       /* should mean lpos == hpos, since lpos <= hpos is invariant */
3953       newpos = lpos;
3954       /* we check this case once, but not forever, so break loop */
3955       cont = FALSE;
3956     }
3957
3958     /* ensure */
3959     newpos = CLAMP (newpos, lpos, hpos);
3960     GST_LOG_OBJECT (parse,
3961         "estimated _offset for %" GST_TIME_FORMAT ": %" G_GINT64_FORMAT,
3962         GST_TIME_ARGS (time), newpos);
3963
3964     ret = gst_base_parse_find_frame (parse, &newpos, &newtime, &dur);
3965     if (ret == GST_FLOW_EOS) {
3966       /* heuristic HACK */
3967       hpos = MAX (lpos, hpos - chunk);
3968       continue;
3969     } else if (ret != GST_FLOW_OK) {
3970       goto exit;
3971     }
3972
3973     if (newtime == -1 || newpos == -1) {
3974       GST_DEBUG_OBJECT (parse, "subclass did not provide metadata; aborting");
3975       break;
3976     }
3977
3978     if (G_UNLIKELY (time == G_MAXINT64)) {
3979       *_offset = newpos;
3980       *_time = newtime;
3981       if (GST_CLOCK_TIME_IS_VALID (dur))
3982         *_time += dur;
3983       break;
3984     } else if (newtime > time) {
3985       /* overshoot */
3986       hpos = (newpos >= hpos) ? MAX (lpos, hpos - chunk) : MAX (lpos, newpos);
3987       htime = newtime;
3988     } else if (newtime + tolerance > time) {
3989       /* close enough undershoot */
3990       *_offset = newpos;
3991       *_time = newtime;
3992       break;
3993     } else if (newtime < ltime) {
3994       /* so a position beyond lpos resulted in earlier time than ltime ... */
3995       GST_DEBUG_OBJECT (parse, "non-ascending time; aborting");
3996       break;
3997     } else {
3998       /* undershoot too far */
3999       newpos += newpos == lpos ? chunk : 0;
4000       lpos = CLAMP (newpos, lpos, hpos);
4001       ltime = newtime;
4002     }
4003   }
4004
4005 exit:
4006   GST_LOG_OBJECT (parse, "return offset %" G_GINT64_FORMAT ", time %"
4007       GST_TIME_FORMAT, *_offset, GST_TIME_ARGS (*_time));
4008   return ret;
4009 }
4010
4011 static gint64
4012 gst_base_parse_find_offset (GstBaseParse * parse, GstClockTime time,
4013     gboolean before, GstClockTime * _ts)
4014 {
4015   gint64 bytes = 0, ts = 0;
4016   GstIndexEntry *entry = NULL;
4017
4018   if (time == GST_CLOCK_TIME_NONE) {
4019     ts = time;
4020     bytes = -1;
4021     goto exit;
4022   }
4023
4024   GST_BASE_PARSE_INDEX_LOCK (parse);
4025   if (parse->priv->index) {
4026     /* Let's check if we have an index entry for that time */
4027     entry = gst_index_get_assoc_entry (parse->priv->index,
4028         parse->priv->index_id,
4029         before ? GST_INDEX_LOOKUP_BEFORE : GST_INDEX_LOOKUP_AFTER,
4030         GST_INDEX_ASSOCIATION_FLAG_KEY_UNIT, GST_FORMAT_TIME, time);
4031   }
4032
4033   if (entry) {
4034     gst_index_entry_assoc_map (entry, GST_FORMAT_BYTES, &bytes);
4035     gst_index_entry_assoc_map (entry, GST_FORMAT_TIME, &ts);
4036
4037     GST_DEBUG_OBJECT (parse, "found index entry for %" GST_TIME_FORMAT
4038         " at %" GST_TIME_FORMAT ", offset %" G_GINT64_FORMAT,
4039         GST_TIME_ARGS (time), GST_TIME_ARGS (ts), bytes);
4040   } else {
4041     GST_DEBUG_OBJECT (parse, "no index entry found for %" GST_TIME_FORMAT,
4042         GST_TIME_ARGS (time));
4043     if (!before) {
4044       bytes = -1;
4045       ts = GST_CLOCK_TIME_NONE;
4046     }
4047   }
4048   GST_BASE_PARSE_INDEX_UNLOCK (parse);
4049
4050 exit:
4051   if (_ts)
4052     *_ts = ts;
4053
4054   return bytes;
4055 }
4056
4057 /* returns TRUE if seek succeeded */
4058 static gboolean
4059 gst_base_parse_handle_seek (GstBaseParse * parse, GstEvent * event)
4060 {
4061   gdouble rate;
4062   GstFormat format;
4063   GstSeekFlags flags;
4064   GstSeekType start_type = GST_SEEK_TYPE_NONE, stop_type;
4065   gboolean flush, update, res = TRUE, accurate;
4066   gint64 start, stop, seekpos, seekstop;
4067   GstSegment seeksegment = { 0, };
4068   GstClockTime start_ts;
4069   guint32 seqnum;
4070   GstEvent *segment_event;
4071
4072   /* try upstream first, unless we're driving the streaming thread ourselves */
4073   if (parse->priv->pad_mode != GST_PAD_MODE_PULL) {
4074     res = gst_pad_push_event (parse->sinkpad, gst_event_ref (event));
4075     if (res)
4076       goto done;
4077   }
4078
4079   gst_event_parse_seek (event, &rate, &format, &flags,
4080       &start_type, &start, &stop_type, &stop);
4081   seqnum = gst_event_get_seqnum (event);
4082
4083   GST_DEBUG_OBJECT (parse, "seek to format %s, rate %f, "
4084       "start type %d at %" GST_TIME_FORMAT ", end type %d at %"
4085       GST_TIME_FORMAT, gst_format_get_name (format), rate,
4086       start_type, GST_TIME_ARGS (start), stop_type, GST_TIME_ARGS (stop));
4087
4088   /* we can only handle TIME, so check if subclass can convert
4089    * to TIME format if it's some other format (such as DEFAULT) */
4090   if (format != GST_FORMAT_TIME) {
4091     if (!gst_base_parse_convert (parse, format, start, GST_FORMAT_TIME, &start)
4092         || !gst_base_parse_convert (parse, format, stop, GST_FORMAT_TIME,
4093             &stop))
4094       goto no_convert_to_time;
4095
4096     GST_INFO_OBJECT (parse, "converted %s format to start time "
4097         "%" GST_TIME_FORMAT " and stop time %" GST_TIME_FORMAT,
4098         gst_format_get_name (format), GST_TIME_ARGS (start),
4099         GST_TIME_ARGS (stop));
4100
4101     format = GST_FORMAT_TIME;
4102   }
4103
4104   /* no negative rates in push mode (unless upstream takes care of that, but
4105    * we've already tried upstream and it didn't handle the seek request) */
4106   if (rate < 0.0 && parse->priv->pad_mode == GST_PAD_MODE_PUSH)
4107     goto negative_rate;
4108
4109   if (rate < 0.0 && parse->priv->pad_mode == GST_PAD_MODE_PULL)
4110     goto negative_rate_pull_mode;
4111
4112   if (start_type != GST_SEEK_TYPE_SET ||
4113       (stop_type != GST_SEEK_TYPE_SET && stop_type != GST_SEEK_TYPE_NONE))
4114     goto wrong_type;
4115
4116   /* get flush flag */
4117   flush = flags & GST_SEEK_FLAG_FLUSH;
4118
4119   /* copy segment, we need this because we still need the old
4120    * segment when we close the current segment. */
4121   gst_segment_copy_into (&parse->segment, &seeksegment);
4122
4123   GST_DEBUG_OBJECT (parse, "configuring seek");
4124   gst_segment_do_seek (&seeksegment, rate, format, flags,
4125       start_type, start, stop_type, stop, &update);
4126
4127   /* accurate seeking implies seek tables are used to obtain position,
4128    * and the requested segment is maintained exactly, not adjusted any way */
4129   accurate = flags & GST_SEEK_FLAG_ACCURATE;
4130
4131   /* maybe we can be accurate for (almost) free */
4132   gst_base_parse_find_offset (parse, seeksegment.position, TRUE, &start_ts);
4133   if (seeksegment.position <= start_ts + TARGET_DIFFERENCE) {
4134     GST_DEBUG_OBJECT (parse, "accurate seek possible");
4135     accurate = TRUE;
4136   }
4137   if (accurate) {
4138     GstClockTime startpos = seeksegment.position;
4139
4140     /* accurate requested, so ... seek a bit before target */
4141     if (startpos < parse->priv->lead_in_ts)
4142       startpos = 0;
4143     else
4144       startpos -= parse->priv->lead_in_ts;
4145     seekpos = gst_base_parse_find_offset (parse, startpos, TRUE, &start_ts);
4146     seekstop = gst_base_parse_find_offset (parse, seeksegment.stop, FALSE,
4147         NULL);
4148   } else {
4149     start_ts = seeksegment.position;
4150     if (!gst_base_parse_convert (parse, format, seeksegment.position,
4151             GST_FORMAT_BYTES, &seekpos))
4152       goto convert_failed;
4153     if (!gst_base_parse_convert (parse, format, seeksegment.stop,
4154             GST_FORMAT_BYTES, &seekstop))
4155       goto convert_failed;
4156   }
4157
4158   GST_DEBUG_OBJECT (parse,
4159       "seek position %" G_GINT64_FORMAT " in bytes: %" G_GINT64_FORMAT,
4160       start_ts, seekpos);
4161   GST_DEBUG_OBJECT (parse,
4162       "seek stop %" G_GINT64_FORMAT " in bytes: %" G_GINT64_FORMAT,
4163       seeksegment.stop, seekstop);
4164
4165   if (parse->priv->pad_mode == GST_PAD_MODE_PULL) {
4166     gint64 last_stop;
4167
4168     GST_DEBUG_OBJECT (parse, "seek in PULL mode");
4169
4170     if (flush) {
4171       if (parse->srcpad) {
4172         GstEvent *fevent = gst_event_new_flush_start ();
4173         GST_DEBUG_OBJECT (parse, "sending flush start");
4174
4175         gst_event_set_seqnum (fevent, seqnum);
4176
4177         gst_pad_push_event (parse->srcpad, gst_event_ref (fevent));
4178         /* unlock upstream pull_range */
4179         gst_pad_push_event (parse->sinkpad, fevent);
4180       }
4181     } else {
4182       gst_pad_pause_task (parse->sinkpad);
4183     }
4184
4185     /* we should now be able to grab the streaming thread because we stopped it
4186      * with the above flush/pause code */
4187     GST_PAD_STREAM_LOCK (parse->sinkpad);
4188
4189     /* save current position */
4190     last_stop = parse->segment.position;
4191     GST_DEBUG_OBJECT (parse, "stopped streaming at %" G_GINT64_FORMAT,
4192         last_stop);
4193
4194     /* now commit to new position */
4195
4196     /* prepare for streaming again */
4197     if (flush) {
4198       GstEvent *fevent = gst_event_new_flush_stop (TRUE);
4199       GST_DEBUG_OBJECT (parse, "sending flush stop");
4200       gst_event_set_seqnum (fevent, seqnum);
4201       gst_pad_push_event (parse->srcpad, gst_event_ref (fevent));
4202       gst_pad_push_event (parse->sinkpad, fevent);
4203       gst_base_parse_clear_queues (parse);
4204     } else {
4205       /* keep track of our position */
4206       seeksegment.base = gst_segment_to_running_time (&seeksegment,
4207           seeksegment.format, parse->segment.position);
4208     }
4209
4210     memcpy (&parse->segment, &seeksegment, sizeof (GstSegment));
4211
4212     /* store the newsegment event so it can be sent from the streaming thread. */
4213     /* This will be sent later in _loop() */
4214     parse->priv->pending_segment = TRUE;
4215     segment_event = gst_event_new_segment (&parse->segment);
4216     gst_event_set_seqnum (segment_event, seqnum);
4217     parse->priv->pending_events =
4218         g_list_prepend (parse->priv->pending_events, segment_event);
4219
4220     GST_DEBUG_OBJECT (parse, "Created newseg format %d, "
4221         "start = %" GST_TIME_FORMAT ", stop = %" GST_TIME_FORMAT
4222         ", time = %" GST_TIME_FORMAT, format,
4223         GST_TIME_ARGS (parse->segment.start),
4224         GST_TIME_ARGS (parse->segment.stop),
4225         GST_TIME_ARGS (parse->segment.time));
4226
4227     /* one last chance in pull mode to stay accurate;
4228      * maybe scan and subclass can find where to go */
4229     if (!accurate) {
4230       gint64 scanpos;
4231       GstClockTime ts = seeksegment.position;
4232
4233       gst_base_parse_locate_time (parse, &ts, &scanpos);
4234       if (scanpos >= 0) {
4235         accurate = TRUE;
4236         seekpos = scanpos;
4237         /* running collected index now consists of several intervals,
4238          * so optimized check no longer possible */
4239         parse->priv->index_last_valid = FALSE;
4240         parse->priv->index_last_offset = 0;
4241         parse->priv->index_last_ts = 0;
4242       }
4243     }
4244
4245     /* mark discont if we are going to stream from another position. */
4246     if (seekpos != parse->priv->offset) {
4247       GST_DEBUG_OBJECT (parse,
4248           "mark DISCONT, we did a seek to another position");
4249       parse->priv->offset = seekpos;
4250       parse->priv->last_offset = seekpos;
4251       parse->priv->seen_keyframe = FALSE;
4252       parse->priv->discont = TRUE;
4253       parse->priv->next_dts = start_ts;
4254       parse->priv->next_pts = GST_CLOCK_TIME_NONE;
4255       parse->priv->last_dts = GST_CLOCK_TIME_NONE;
4256       parse->priv->last_pts = GST_CLOCK_TIME_NONE;
4257       parse->priv->sync_offset = seekpos;
4258       parse->priv->exact_position = accurate;
4259     }
4260
4261     /* Start streaming thread if paused */
4262     gst_pad_start_task (parse->sinkpad,
4263         (GstTaskFunction) gst_base_parse_loop, parse->sinkpad, NULL);
4264
4265     GST_PAD_STREAM_UNLOCK (parse->sinkpad);
4266
4267     /* handled seek */
4268     res = TRUE;
4269   } else {
4270     GstEvent *new_event;
4271     GstBaseParseSeek *seek;
4272     GstSeekFlags flags = (flush ? GST_SEEK_FLAG_FLUSH : GST_SEEK_FLAG_NONE);
4273
4274     /* The only thing we need to do in PUSH-mode is to send the
4275        seek event (in bytes) to upstream. Segment / flush handling happens
4276        in corresponding src event handlers */
4277     GST_DEBUG_OBJECT (parse, "seek in PUSH mode");
4278     if (seekstop >= 0 && seekstop <= seekpos)
4279       seekstop = seekpos;
4280     new_event = gst_event_new_seek (rate, GST_FORMAT_BYTES, flags,
4281         GST_SEEK_TYPE_SET, seekpos, stop_type, seekstop);
4282     gst_event_set_seqnum (new_event, seqnum);
4283
4284     /* store segment info so its precise details can be reconstructed when
4285      * receiving newsegment;
4286      * this matters for all details when accurate seeking,
4287      * is most useful to preserve NONE stop time otherwise */
4288     seek = g_new0 (GstBaseParseSeek, 1);
4289     seek->segment = seeksegment;
4290     seek->accurate = accurate;
4291     seek->offset = seekpos;
4292     seek->start_ts = start_ts;
4293     GST_OBJECT_LOCK (parse);
4294     /* less optimal, but preserves order */
4295     parse->priv->pending_seeks =
4296         g_slist_append (parse->priv->pending_seeks, seek);
4297     GST_OBJECT_UNLOCK (parse);
4298
4299     res = gst_pad_push_event (parse->sinkpad, new_event);
4300
4301     if (!res) {
4302       GST_OBJECT_LOCK (parse);
4303       parse->priv->pending_seeks =
4304           g_slist_remove (parse->priv->pending_seeks, seek);
4305       GST_OBJECT_UNLOCK (parse);
4306       g_free (seek);
4307     }
4308   }
4309
4310 done:
4311   gst_event_unref (event);
4312   return res;
4313
4314   /* ERRORS */
4315 negative_rate_pull_mode:
4316   {
4317     GST_FIXME_OBJECT (parse, "negative playback in pull mode needs fixing");
4318     res = FALSE;
4319     goto done;
4320   }
4321 negative_rate:
4322   {
4323     GST_DEBUG_OBJECT (parse, "negative playback rates delegated upstream.");
4324     res = FALSE;
4325     goto done;
4326   }
4327 wrong_type:
4328   {
4329     GST_DEBUG_OBJECT (parse, "unsupported seek type.");
4330     res = FALSE;
4331     goto done;
4332   }
4333 no_convert_to_time:
4334   {
4335     GST_DEBUG_OBJECT (parse, "seek in %s format was requested, but subclass "
4336         "couldn't convert that into TIME format", gst_format_get_name (format));
4337     res = FALSE;
4338     goto done;
4339   }
4340 convert_failed:
4341   {
4342     GST_DEBUG_OBJECT (parse, "conversion TIME to BYTES failed.");
4343     res = FALSE;
4344     goto done;
4345   }
4346 }
4347
4348 /* Checks if bitrates are available from upstream tags so that we don't
4349  * override them later
4350  */
4351 static void
4352 gst_base_parse_handle_tag (GstBaseParse * parse, GstEvent * event)
4353 {
4354   GstTagList *taglist = NULL;
4355   guint tmp;
4356
4357   gst_event_parse_tag (event, &taglist);
4358
4359   /* We only care about stream tags here */
4360   if (gst_tag_list_get_scope (taglist) != GST_TAG_SCOPE_STREAM)
4361     return;
4362
4363   if (gst_tag_list_get_uint (taglist, GST_TAG_MINIMUM_BITRATE, &tmp)) {
4364     GST_DEBUG_OBJECT (parse, "upstream min bitrate %d", tmp);
4365     parse->priv->post_min_bitrate = FALSE;
4366   }
4367   if (gst_tag_list_get_uint (taglist, GST_TAG_BITRATE, &tmp)) {
4368     GST_DEBUG_OBJECT (parse, "upstream avg bitrate %d", tmp);
4369     parse->priv->post_avg_bitrate = FALSE;
4370   }
4371   if (gst_tag_list_get_uint (taglist, GST_TAG_MAXIMUM_BITRATE, &tmp)) {
4372     GST_DEBUG_OBJECT (parse, "upstream max bitrate %d", tmp);
4373     parse->priv->post_max_bitrate = FALSE;
4374   }
4375 }
4376
4377 #if 0
4378 static void
4379 gst_base_parse_set_index (GstElement * element, GstIndex * index)
4380 {
4381   GstBaseParse *parse = GST_BASE_PARSE (element);
4382
4383   GST_BASE_PARSE_INDEX_LOCK (parse);
4384   if (parse->priv->index)
4385     gst_object_unref (parse->priv->index);
4386   if (index) {
4387     parse->priv->index = gst_object_ref (index);
4388     gst_index_get_writer_id (index, GST_OBJECT_CAST (element),
4389         &parse->priv->index_id);
4390     parse->priv->own_index = FALSE;
4391   } else {
4392     parse->priv->index = NULL;
4393   }
4394   GST_BASE_PARSE_INDEX_UNLOCK (parse);
4395 }
4396
4397 static GstIndex *
4398 gst_base_parse_get_index (GstElement * element)
4399 {
4400   GstBaseParse *parse = GST_BASE_PARSE (element);
4401   GstIndex *result = NULL;
4402
4403   GST_BASE_PARSE_INDEX_LOCK (parse);
4404   if (parse->priv->index)
4405     result = gst_object_ref (parse->priv->index);
4406   GST_BASE_PARSE_INDEX_UNLOCK (parse);
4407
4408   return result;
4409 }
4410 #endif
4411
4412 static GstStateChangeReturn
4413 gst_base_parse_change_state (GstElement * element, GstStateChange transition)
4414 {
4415   GstBaseParse *parse;
4416   GstStateChangeReturn result;
4417
4418   parse = GST_BASE_PARSE (element);
4419
4420   switch (transition) {
4421     case GST_STATE_CHANGE_READY_TO_PAUSED:
4422       /* If this is our own index destroy it as the
4423        * old entries might be wrong for the new stream */
4424       GST_BASE_PARSE_INDEX_LOCK (parse);
4425       if (parse->priv->own_index) {
4426         gst_object_unref (parse->priv->index);
4427         parse->priv->index = NULL;
4428         parse->priv->own_index = FALSE;
4429       }
4430
4431       /* If no index was created, generate one */
4432       if (G_UNLIKELY (!parse->priv->index)) {
4433         GST_DEBUG_OBJECT (parse, "no index provided creating our own");
4434
4435         parse->priv->index = g_object_new (gst_mem_index_get_type (), NULL);
4436         gst_index_get_writer_id (parse->priv->index, GST_OBJECT (parse),
4437             &parse->priv->index_id);
4438         parse->priv->own_index = TRUE;
4439       }
4440       GST_BASE_PARSE_INDEX_UNLOCK (parse);
4441       break;
4442     default:
4443       break;
4444   }
4445
4446   result = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
4447
4448   switch (transition) {
4449     case GST_STATE_CHANGE_PAUSED_TO_READY:
4450       gst_base_parse_reset (parse);
4451       break;
4452     default:
4453       break;
4454   }
4455
4456   return result;
4457 }
4458
4459 /**
4460  * gst_base_parse_set_ts_at_offset:
4461  * @parse: a #GstBaseParse
4462  * @offset: offset into current buffer
4463  *
4464  * This function should only be called from a @handle_frame implementation.
4465  *
4466  * GstBaseParse creates initial timestamps for frames by using the last
4467  * timestamp seen in the stream before the frame starts.  In certain
4468  * cases, the correct timestamps will occur in the stream after the
4469  * start of the frame, but before the start of the actual picture data.
4470  * This function can be used to set the timestamps based on the offset
4471  * into the frame data that the picture starts.
4472  *
4473  * Since: 1.2
4474  */
4475 void
4476 gst_base_parse_set_ts_at_offset (GstBaseParse * parse, gsize offset)
4477 {
4478   GstClockTime pts, dts;
4479
4480   g_return_if_fail (GST_IS_BASE_PARSE (parse));
4481   g_return_if_fail (offset >= 0);
4482
4483   pts = gst_adapter_prev_pts_at_offset (parse->priv->adapter, offset, NULL);
4484   dts = gst_adapter_prev_dts_at_offset (parse->priv->adapter, offset, NULL);
4485
4486   if (!GST_CLOCK_TIME_IS_VALID (pts) || !GST_CLOCK_TIME_IS_VALID (dts)) {
4487     GST_DEBUG_OBJECT (parse,
4488         "offset adapter timestamps dts=%" GST_TIME_FORMAT " pts=%"
4489         GST_TIME_FORMAT, GST_TIME_ARGS (dts), GST_TIME_ARGS (pts));
4490   }
4491   if (GST_CLOCK_TIME_IS_VALID (pts) && (parse->priv->prev_pts != pts))
4492     parse->priv->prev_pts = parse->priv->next_pts = pts;
4493
4494   if (GST_CLOCK_TIME_IS_VALID (dts) && (parse->priv->prev_dts != dts))
4495     parse->priv->prev_dts = parse->priv->next_dts = dts;
4496 }