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