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