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