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