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