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