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