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