typefindelement: Propagate input buffer PTS and DTS
[platform/upstream/gstreamer.git] / plugins / elements / gsttypefindelement.c
1 /* GStreamer
2  * Copyright (C) 2003 Benjamin Otte <in7y118@public.uni-hamburg.de>
3  *
4  * gsttypefindelement.c: element that detects type of stream
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public
17  * License along with this library; if not, write to the
18  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  */
21 /**
22  * SECTION:element-typefind
23  *
24  * Determines the media-type of a stream. It applies typefind functions in the
25  * order of their rank. Once the type has been detected it sets its src pad caps
26  * to the found media type.
27  *
28  * Whenever a type is found the #GstTypeFindElement::have-type signal is
29  * emitted, either from the streaming thread or the application thread
30  * (the latter may happen when typefinding is done pull-based from the
31  * state change function).
32  *
33  * Plugins can register custom typefinders by using #GstTypeFindFactory.
34  */
35
36 /* FIXME: need a better solution for non-seekable streams */
37
38 /* way of operation:
39  * 1) get a list of all typefind functions sorted best to worst
40  * 2) if all elements have been called with all requested data goto 8
41  * 3) call all functions once with all available data
42  * 4) if a function returns a value >= PROP_MAXIMUM goto 8 (never implemented))
43  * 5) all functions with a result > PROP_MINIMUM or functions that did not get
44  *    all requested data (where peek returned NULL) stay in list
45  * 6) seek to requested offset of best function that still has open data
46  *    requests
47  * 7) goto 2
48  * 8) take best available result and use its caps
49  *
50  * The element has two scheduling modes:
51  *
52  * 1) chain based, it will collect buffers and run the typefind function on
53  *    the buffer until something is found.
54  * 2) getrange based, it will proxy the getrange function to the sinkpad. It
55  *    is assumed that the peer element is happy with whatever format we
56  *    eventually read.
57  *
58  * By default it tries to do pull based typefinding (this avoids joining
59  * received buffers and holding them back in store.)
60  *
61  * When the element has no connected srcpad, and the sinkpad can operate in
62  * getrange based mode, the element starts its own task to figure out the
63  * type of the stream.
64  *
65  * Most of the actual implementation is in libs/gst/base/gsttypefindhelper.c.
66  */
67
68 #ifdef HAVE_CONFIG_H
69 #  include "config.h"
70 #endif
71
72 #include "gst/gst_private.h"
73
74 #include "gsttypefindelement.h"
75 #include "gst/gst-i18n-lib.h"
76 #include "gst/base/gsttypefindhelper.h"
77
78 #include <gst/gsttypefind.h>
79 #include <gst/gstutils.h>
80 #include <gst/gsterror.h>
81
82 GST_DEBUG_CATEGORY_STATIC (gst_type_find_element_debug);
83 #define GST_CAT_DEFAULT gst_type_find_element_debug
84
85 /* generic templates */
86 static GstStaticPadTemplate type_find_element_sink_template =
87 GST_STATIC_PAD_TEMPLATE ("sink",
88     GST_PAD_SINK,
89     GST_PAD_ALWAYS,
90     GST_STATIC_CAPS_ANY);
91
92 static GstStaticPadTemplate type_find_element_src_template =
93 GST_STATIC_PAD_TEMPLATE ("src",
94     GST_PAD_SRC,
95     GST_PAD_ALWAYS,
96     GST_STATIC_CAPS_ANY);
97
98 /* Require at least 2kB of data before we attempt typefinding in chain-mode.
99  * 128kB is massive overkill for the maximum, but doesn't do any harm */
100 #define TYPE_FIND_MIN_SIZE   (2*1024)
101 #define TYPE_FIND_MAX_SIZE (128*1024)
102
103 /* TypeFind signals and args */
104 enum
105 {
106   HAVE_TYPE,
107   LAST_SIGNAL
108 };
109 enum
110 {
111   PROP_0,
112   PROP_CAPS,
113   PROP_MINIMUM,
114   PROP_FORCE_CAPS,
115   PROP_LAST
116 };
117 enum
118 {
119   MODE_NORMAL,                  /* act as identity */
120   MODE_TYPEFIND,                /* do typefinding  */
121   MODE_ERROR                    /* had fatal error */
122 };
123
124
125 #define _do_init \
126     GST_DEBUG_CATEGORY_INIT (gst_type_find_element_debug, "typefind",           \
127         GST_DEBUG_BG_YELLOW | GST_DEBUG_FG_GREEN, "type finding element");
128 #define gst_type_find_element_parent_class parent_class
129 G_DEFINE_TYPE_WITH_CODE (GstTypeFindElement, gst_type_find_element,
130     GST_TYPE_ELEMENT, _do_init);
131
132 static void gst_type_find_element_dispose (GObject * object);
133 static void gst_type_find_element_set_property (GObject * object,
134     guint prop_id, const GValue * value, GParamSpec * pspec);
135 static void gst_type_find_element_get_property (GObject * object,
136     guint prop_id, GValue * value, GParamSpec * pspec);
137
138 #if 0
139 static const GstEventMask *gst_type_find_element_src_event_mask (GstPad * pad);
140 #endif
141
142 static gboolean gst_type_find_element_src_event (GstPad * pad,
143     GstObject * parent, GstEvent * event);
144 static gboolean gst_type_find_handle_src_query (GstPad * pad,
145     GstObject * parent, GstQuery * query);
146
147 static gboolean gst_type_find_element_sink_event (GstPad * pad,
148     GstObject * parent, GstEvent * event);
149 static gboolean gst_type_find_element_setcaps (GstTypeFindElement * typefind,
150     GstCaps * caps);
151 static GstFlowReturn gst_type_find_element_chain (GstPad * sinkpad,
152     GstObject * parent, GstBuffer * buffer);
153 static GstFlowReturn gst_type_find_element_getrange (GstPad * srcpad,
154     GstObject * parent, guint64 offset, guint length, GstBuffer ** buffer);
155
156 static GstStateChangeReturn
157 gst_type_find_element_change_state (GstElement * element,
158     GstStateChange transition);
159 static gboolean gst_type_find_element_activate_sink (GstPad * pad,
160     GstObject * parent);
161 static gboolean gst_type_find_element_activate_sink_mode (GstPad * pad,
162     GstObject * parent, GstPadMode mode, gboolean active);
163 static gboolean gst_type_find_element_activate_src_mode (GstPad * pad,
164     GstObject * parent, GstPadMode mode, gboolean active);
165 static GstFlowReturn
166 gst_type_find_element_chain_do_typefinding (GstTypeFindElement * typefind,
167     gboolean check_avail);
168 static void gst_type_find_element_send_cached_events (GstTypeFindElement *
169     typefind);
170
171 static void gst_type_find_element_loop (GstPad * pad);
172
173 static guint gst_type_find_element_signals[LAST_SIGNAL] = { 0 };
174
175 static void
176 gst_type_find_element_have_type (GstTypeFindElement * typefind,
177     guint probability, GstCaps * caps)
178 {
179   g_assert (caps != NULL);
180
181   GST_INFO_OBJECT (typefind, "found caps %" GST_PTR_FORMAT ", probability=%u",
182       caps, probability);
183
184   GST_OBJECT_LOCK (typefind);
185   if (typefind->caps)
186     gst_caps_unref (typefind->caps);
187   typefind->caps = gst_caps_ref (caps);
188   GST_OBJECT_UNLOCK (typefind);
189
190   gst_pad_set_caps (typefind->src, caps);
191 }
192
193 static void
194 gst_type_find_element_class_init (GstTypeFindElementClass * typefind_class)
195 {
196   GObjectClass *gobject_class = G_OBJECT_CLASS (typefind_class);
197   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (typefind_class);
198
199   gobject_class->set_property = gst_type_find_element_set_property;
200   gobject_class->get_property = gst_type_find_element_get_property;
201   gobject_class->dispose = gst_type_find_element_dispose;
202
203   g_object_class_install_property (gobject_class, PROP_CAPS,
204       g_param_spec_boxed ("caps", _("caps"),
205           _("detected capabilities in stream"), GST_TYPE_CAPS,
206           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
207   g_object_class_install_property (gobject_class, PROP_MINIMUM,
208       g_param_spec_uint ("minimum", _("minimum"),
209           "minimum probability required to accept caps", GST_TYPE_FIND_MINIMUM,
210           GST_TYPE_FIND_MAXIMUM, GST_TYPE_FIND_MINIMUM,
211           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
212   g_object_class_install_property (gobject_class, PROP_FORCE_CAPS,
213       g_param_spec_boxed ("force-caps", _("force caps"),
214           _("force caps without doing a typefind"), GST_TYPE_CAPS,
215           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
216   /**
217    * GstTypeFindElement::have-type:
218    * @typefind: the typefind instance
219    * @probability: the probability of the type found
220    * @caps: the caps of the type found
221    *
222    * This signal gets emitted when the type and its probability has
223    * been found.
224    */
225   gst_type_find_element_signals[HAVE_TYPE] = g_signal_new ("have-type",
226       G_TYPE_FROM_CLASS (typefind_class), G_SIGNAL_RUN_FIRST,
227       G_STRUCT_OFFSET (GstTypeFindElementClass, have_type), NULL, NULL,
228       g_cclosure_marshal_generic, G_TYPE_NONE, 2,
229       G_TYPE_UINT, GST_TYPE_CAPS | G_SIGNAL_TYPE_STATIC_SCOPE);
230
231   typefind_class->have_type =
232       GST_DEBUG_FUNCPTR (gst_type_find_element_have_type);
233
234   gst_element_class_set_static_metadata (gstelement_class,
235       "TypeFind",
236       "Generic",
237       "Finds the media type of a stream",
238       "Benjamin Otte <in7y118@public.uni-hamburg.de>");
239   gst_element_class_add_pad_template (gstelement_class,
240       gst_static_pad_template_get (&type_find_element_src_template));
241   gst_element_class_add_pad_template (gstelement_class,
242       gst_static_pad_template_get (&type_find_element_sink_template));
243
244   gstelement_class->change_state =
245       GST_DEBUG_FUNCPTR (gst_type_find_element_change_state);
246 }
247
248 static void
249 gst_type_find_element_init (GstTypeFindElement * typefind)
250 {
251   /* sinkpad */
252   typefind->sink =
253       gst_pad_new_from_static_template (&type_find_element_sink_template,
254       "sink");
255
256   gst_pad_set_activate_function (typefind->sink,
257       GST_DEBUG_FUNCPTR (gst_type_find_element_activate_sink));
258   gst_pad_set_activatemode_function (typefind->sink,
259       GST_DEBUG_FUNCPTR (gst_type_find_element_activate_sink_mode));
260   gst_pad_set_chain_function (typefind->sink,
261       GST_DEBUG_FUNCPTR (gst_type_find_element_chain));
262   gst_pad_set_event_function (typefind->sink,
263       GST_DEBUG_FUNCPTR (gst_type_find_element_sink_event));
264   GST_PAD_SET_PROXY_ALLOCATION (typefind->sink);
265   gst_element_add_pad (GST_ELEMENT (typefind), typefind->sink);
266
267   /* srcpad */
268   typefind->src =
269       gst_pad_new_from_static_template (&type_find_element_src_template, "src");
270
271   gst_pad_set_activatemode_function (typefind->src,
272       GST_DEBUG_FUNCPTR (gst_type_find_element_activate_src_mode));
273   gst_pad_set_getrange_function (typefind->src,
274       GST_DEBUG_FUNCPTR (gst_type_find_element_getrange));
275   gst_pad_set_event_function (typefind->src,
276       GST_DEBUG_FUNCPTR (gst_type_find_element_src_event));
277   gst_pad_set_query_function (typefind->src,
278       GST_DEBUG_FUNCPTR (gst_type_find_handle_src_query));
279   gst_pad_use_fixed_caps (typefind->src);
280   gst_element_add_pad (GST_ELEMENT (typefind), typefind->src);
281
282   typefind->mode = MODE_TYPEFIND;
283   typefind->caps = NULL;
284   typefind->min_probability = 1;
285
286   typefind->adapter = gst_adapter_new ();
287 }
288
289 static void
290 gst_type_find_element_dispose (GObject * object)
291 {
292   GstTypeFindElement *typefind = GST_TYPE_FIND_ELEMENT (object);
293
294   if (typefind->adapter) {
295     g_object_unref (typefind->adapter);
296     typefind->adapter = NULL;
297   }
298
299   if (typefind->force_caps) {
300     gst_caps_unref (typefind->force_caps);
301     typefind->force_caps = NULL;
302   }
303
304   G_OBJECT_CLASS (parent_class)->dispose (object);
305 }
306
307 static void
308 gst_type_find_element_set_property (GObject * object, guint prop_id,
309     const GValue * value, GParamSpec * pspec)
310 {
311   GstTypeFindElement *typefind;
312
313   typefind = GST_TYPE_FIND_ELEMENT (object);
314
315   switch (prop_id) {
316     case PROP_MINIMUM:
317       typefind->min_probability = g_value_get_uint (value);
318       break;
319     case PROP_FORCE_CAPS:
320       GST_OBJECT_LOCK (typefind);
321       if (typefind->force_caps)
322         gst_caps_unref (typefind->force_caps);
323       typefind->force_caps = g_value_dup_boxed (value);
324       GST_OBJECT_UNLOCK (typefind);
325       break;
326     default:
327       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
328       break;
329   }
330 }
331
332 static void
333 gst_type_find_element_get_property (GObject * object, guint prop_id,
334     GValue * value, GParamSpec * pspec)
335 {
336   GstTypeFindElement *typefind;
337
338   typefind = GST_TYPE_FIND_ELEMENT (object);
339
340   switch (prop_id) {
341     case PROP_CAPS:
342       GST_OBJECT_LOCK (typefind);
343       g_value_set_boxed (value, typefind->caps);
344       GST_OBJECT_UNLOCK (typefind);
345       break;
346     case PROP_MINIMUM:
347       g_value_set_uint (value, typefind->min_probability);
348       break;
349     case PROP_FORCE_CAPS:
350       GST_OBJECT_LOCK (typefind);
351       g_value_set_boxed (value, typefind->force_caps);
352       GST_OBJECT_UNLOCK (typefind);
353       break;
354     default:
355       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
356       break;
357   }
358 }
359
360 static gboolean
361 gst_type_find_handle_src_query (GstPad * pad, GstObject * parent,
362     GstQuery * query)
363 {
364   GstTypeFindElement *typefind;
365   gboolean res = FALSE;
366
367   typefind = GST_TYPE_FIND_ELEMENT (parent);
368   GST_DEBUG_OBJECT (typefind, "Handling src query %s",
369       GST_QUERY_TYPE_NAME (query));
370
371   switch (GST_QUERY_TYPE (query)) {
372     case GST_QUERY_SCHEDULING:
373       /* FIXME, filter out the scheduling modes that we understand */
374       res = gst_pad_peer_query (typefind->sink, query);
375       break;
376     case GST_QUERY_CAPS:
377     {
378       GST_DEBUG_OBJECT (typefind,
379           "Got caps query, our caps are %" GST_PTR_FORMAT, typefind->caps);
380
381       /* We can hijack caps query if we typefind already */
382       if (typefind->caps) {
383         gst_query_set_caps_result (query, typefind->caps);
384         res = TRUE;
385       } else {
386         res = gst_pad_peer_query (typefind->sink, query);
387       }
388       break;
389     }
390     case GST_QUERY_POSITION:
391     {
392       gint64 peer_pos;
393       GstFormat format;
394
395       if (!(res = gst_pad_peer_query (typefind->sink, query)))
396         goto out;
397
398       gst_query_parse_position (query, &format, &peer_pos);
399
400       GST_OBJECT_LOCK (typefind);
401       /* FIXME: this code assumes that there's no discont in the queue */
402       switch (format) {
403         case GST_FORMAT_BYTES:
404           peer_pos -= gst_adapter_available (typefind->adapter);
405           break;
406         default:
407           /* FIXME */
408           break;
409       }
410       GST_OBJECT_UNLOCK (typefind);
411       gst_query_set_position (query, format, peer_pos);
412       break;
413     }
414     default:
415       res = gst_pad_query_default (pad, parent, query);
416       break;
417   }
418 out:
419   return res;
420 }
421
422 static gboolean
423 gst_type_find_element_seek (GstTypeFindElement * typefind, GstEvent * event)
424 {
425   GstSeekFlags flags;
426   GstSeekType start_type, stop_type;
427   GstFormat format;
428   gboolean flush;
429   gdouble rate;
430   gint64 start, stop;
431   GstSegment seeksegment = { 0, };
432
433   gst_event_parse_seek (event, &rate, &format, &flags, &start_type, &start,
434       &stop_type, &stop);
435
436   /* we can only seek on bytes */
437   if (format != GST_FORMAT_BYTES) {
438     GST_DEBUG_OBJECT (typefind, "Can only seek on BYTES");
439     return FALSE;
440   }
441
442   /* copy segment, we need this because we still need the old
443    * segment when we close the current segment. */
444   memcpy (&seeksegment, &typefind->segment, sizeof (GstSegment));
445
446   GST_DEBUG_OBJECT (typefind, "configuring seek");
447   gst_segment_do_seek (&seeksegment, rate, format, flags,
448       start_type, start, stop_type, stop, NULL);
449
450   flush = ! !(flags & GST_SEEK_FLAG_FLUSH);
451
452   GST_DEBUG_OBJECT (typefind, "New segment %" GST_SEGMENT_FORMAT, &seeksegment);
453
454   if (flush) {
455     GST_DEBUG_OBJECT (typefind, "Starting flush");
456     gst_pad_push_event (typefind->sink, gst_event_new_flush_start ());
457     gst_pad_push_event (typefind->src, gst_event_new_flush_start ());
458   } else {
459     GST_DEBUG_OBJECT (typefind, "Non-flushing seek, pausing task");
460     gst_pad_pause_task (typefind->sink);
461   }
462
463   /* now grab the stream lock so that streaming cannot continue, for
464    * non flushing seeks when the element is in PAUSED this could block
465    * forever. */
466   GST_DEBUG_OBJECT (typefind, "Waiting for streaming to stop");
467   GST_PAD_STREAM_LOCK (typefind->sink);
468
469   if (flush) {
470     GST_DEBUG_OBJECT (typefind, "Stopping flush");
471     gst_pad_push_event (typefind->sink, gst_event_new_flush_stop (TRUE));
472     gst_pad_push_event (typefind->src, gst_event_new_flush_stop (TRUE));
473   }
474
475   /* now update the real segment info */
476   GST_DEBUG_OBJECT (typefind, "Committing new seek segment");
477   memcpy (&typefind->segment, &seeksegment, sizeof (GstSegment));
478   typefind->offset = typefind->segment.start;
479
480   /* notify start of new segment */
481   if (typefind->segment.flags & GST_SEGMENT_FLAG_SEGMENT) {
482     GstMessage *msg;
483
484     msg = gst_message_new_segment_start (GST_OBJECT (typefind),
485         GST_FORMAT_BYTES, typefind->segment.start);
486     gst_element_post_message (GST_ELEMENT (typefind), msg);
487   }
488
489   typefind->need_segment = TRUE;
490
491   /* restart our task since it might have been stopped when we did the
492    * flush. */
493   gst_pad_start_task (typefind->sink,
494       (GstTaskFunction) gst_type_find_element_loop, typefind->sink, NULL);
495
496   /* streaming can continue now */
497   GST_PAD_STREAM_UNLOCK (typefind->sink);
498
499   return TRUE;
500 }
501
502 static gboolean
503 gst_type_find_element_src_event (GstPad * pad, GstObject * parent,
504     GstEvent * event)
505 {
506   GstTypeFindElement *typefind = GST_TYPE_FIND_ELEMENT (parent);
507
508   if (typefind->mode != MODE_NORMAL) {
509     /* need to do more? */
510     gst_mini_object_unref (GST_MINI_OBJECT_CAST (event));
511     return FALSE;
512   }
513
514   /* Only handle seeks here if driving the pipeline */
515   if (typefind->segment.format != GST_FORMAT_UNDEFINED &&
516       GST_EVENT_TYPE (event) == GST_EVENT_SEEK) {
517     return gst_type_find_element_seek (typefind, event);
518   } else {
519     return gst_pad_push_event (typefind->sink, event);
520   }
521 }
522
523 static void
524 start_typefinding (GstTypeFindElement * typefind)
525 {
526   GST_DEBUG_OBJECT (typefind, "starting typefinding");
527
528   GST_OBJECT_LOCK (typefind);
529   if (typefind->caps)
530     gst_caps_replace (&typefind->caps, NULL);
531   GST_OBJECT_UNLOCK (typefind);
532
533   typefind->mode = MODE_TYPEFIND;
534 }
535
536 static void
537 stop_typefinding (GstTypeFindElement * typefind)
538 {
539   GstState state;
540   gboolean push_cached_buffers;
541   gsize avail;
542   GstBuffer *buffer;
543   GstClockTime pts, dts;
544
545   gst_element_get_state (GST_ELEMENT (typefind), &state, NULL, 0);
546
547   push_cached_buffers = (state >= GST_STATE_PAUSED && typefind->caps);
548
549   GST_DEBUG_OBJECT (typefind, "stopping typefinding%s",
550       push_cached_buffers ? " and pushing cached events and buffers" : "");
551
552   typefind->mode = MODE_NORMAL;
553   if (push_cached_buffers)
554     gst_type_find_element_send_cached_events (typefind);
555
556   GST_OBJECT_LOCK (typefind);
557   avail = gst_adapter_available (typefind->adapter);
558   if (avail == 0)
559     goto no_data;
560
561   pts = gst_adapter_prev_pts (typefind->adapter, NULL);
562   dts = gst_adapter_prev_dts (typefind->adapter, NULL);
563   buffer = gst_adapter_take_buffer (typefind->adapter, avail);
564   GST_BUFFER_PTS (buffer) = pts;
565   GST_BUFFER_DTS (buffer) = dts;
566   GST_OBJECT_UNLOCK (typefind);
567
568   if (!push_cached_buffers) {
569     gst_buffer_unref (buffer);
570   } else {
571     GstPad *peer = gst_pad_get_peer (typefind->src);
572
573     /* make sure the user gets a meaningful error message in this case,
574      * which is not a core bug or bug of any kind (as the default error
575      * message emitted by gstpad.c otherwise would make you think) */
576     if (peer && GST_PAD_CHAINFUNC (peer) == NULL) {
577       GST_DEBUG_OBJECT (typefind, "upstream only supports push mode, while "
578           "downstream element only works in pull mode, erroring out");
579       GST_ELEMENT_ERROR (typefind, STREAM, FAILED,
580           ("%s cannot work in push mode. The operation is not supported "
581               "with this source element or protocol.",
582               G_OBJECT_TYPE_NAME (GST_PAD_PARENT (peer))),
583           ("Downstream pad %s:%s has no chainfunction, and the upstream "
584               "element does not support pull mode", GST_DEBUG_PAD_NAME (peer)));
585       typefind->mode = MODE_ERROR;      /* make the chain function error out */
586       gst_buffer_unref (buffer);
587     } else {
588       gst_pad_push (typefind->src, buffer);
589     }
590     if (peer)
591       gst_object_unref (peer);
592   }
593   return;
594
595   /* ERRORS */
596 no_data:
597   {
598     GST_DEBUG_OBJECT (typefind, "we have no data to typefind");
599     GST_OBJECT_UNLOCK (typefind);
600     return;
601   }
602 }
603
604 static gboolean
605 gst_type_find_element_sink_event (GstPad * pad, GstObject * parent,
606     GstEvent * event)
607 {
608   gboolean res = FALSE;
609   GstTypeFindElement *typefind = GST_TYPE_FIND_ELEMENT (parent);
610
611   GST_DEBUG_OBJECT (typefind, "got %s event in mode %d",
612       GST_EVENT_TYPE_NAME (event), typefind->mode);
613
614   switch (typefind->mode) {
615     case MODE_TYPEFIND:
616       switch (GST_EVENT_TYPE (event)) {
617         case GST_EVENT_CAPS:
618         {
619           GstCaps *caps;
620
621           /* Parse and push out our caps and data */
622           gst_event_parse_caps (event, &caps);
623           res = gst_type_find_element_setcaps (typefind, caps);
624
625           gst_event_unref (event);
626           break;
627         }
628         case GST_EVENT_GAP:
629         {
630           GST_FIXME_OBJECT (typefind,
631               "GAP events during typefinding not handled properly");
632
633           /* FIXME: These would need to be inserted in the stream at
634            * the right position between buffers, but we combine all
635            * buffers with a GstAdapter. Drop the GAP event for now,
636            * which will only cause an implicit GAP between buffers.
637            */
638           gst_event_unref (event);
639           res = TRUE;
640           break;
641         }
642         case GST_EVENT_EOS:
643         {
644           GST_INFO_OBJECT (typefind, "Got EOS and no type found yet");
645           gst_type_find_element_chain_do_typefinding (typefind, FALSE);
646
647           res = gst_pad_push_event (typefind->src, event);
648           break;
649         }
650         case GST_EVENT_FLUSH_STOP:{
651           GList *l;
652
653           GST_OBJECT_LOCK (typefind);
654
655           for (l = typefind->cached_events; l; l = l->next) {
656             if (!GST_EVENT_IS_STICKY (l->data) ||
657                 GST_EVENT_TYPE (l->data) == GST_EVENT_SEGMENT ||
658                 GST_EVENT_TYPE (l->data) == GST_EVENT_EOS) {
659               gst_event_unref (l->data);
660             } else {
661               gst_pad_store_sticky_event (typefind->src, l->data);
662             }
663           }
664
665           g_list_free (typefind->cached_events);
666           typefind->cached_events = NULL;
667           gst_adapter_clear (typefind->adapter);
668           GST_OBJECT_UNLOCK (typefind);
669           /* fall through */
670         }
671         case GST_EVENT_FLUSH_START:
672           res = gst_pad_push_event (typefind->src, event);
673           break;
674         default:
675           /* Forward events that would happen before the caps event
676            * directly instead of storing them. There's no reason not
677            * to send them directly and we should only store events
678            * for later sending that would need to come after the caps
679            * event */
680           if (GST_EVENT_TYPE (event) < GST_EVENT_CAPS) {
681             res = gst_pad_push_event (typefind->src, event);
682           } else {
683             GST_DEBUG_OBJECT (typefind, "Saving %s event to send later",
684                 GST_EVENT_TYPE_NAME (event));
685             GST_OBJECT_LOCK (typefind);
686             typefind->cached_events =
687                 g_list_append (typefind->cached_events, event);
688             GST_OBJECT_UNLOCK (typefind);
689             res = TRUE;
690           }
691           break;
692       }
693       break;
694     case MODE_NORMAL:
695       res = gst_pad_push_event (typefind->src, event);
696       break;
697     case MODE_ERROR:
698       break;
699     default:
700       g_assert_not_reached ();
701   }
702   return res;
703 }
704
705 static void
706 gst_type_find_element_send_cached_events (GstTypeFindElement * typefind)
707 {
708   GList *l, *cached_events;
709
710   GST_OBJECT_LOCK (typefind);
711   cached_events = typefind->cached_events;
712   typefind->cached_events = NULL;
713   GST_OBJECT_UNLOCK (typefind);
714
715   for (l = cached_events; l != NULL; l = l->next) {
716     GstEvent *event = GST_EVENT (l->data);
717
718     GST_DEBUG_OBJECT (typefind, "sending cached %s event",
719         GST_EVENT_TYPE_NAME (event));
720     gst_pad_push_event (typefind->src, event);
721   }
722   g_list_free (cached_events);
723 }
724
725 static gboolean
726 gst_type_find_element_setcaps (GstTypeFindElement * typefind, GstCaps * caps)
727 {
728   /* don't operate on ANY caps */
729   if (gst_caps_is_any (caps))
730     return TRUE;
731
732   g_signal_emit (typefind, gst_type_find_element_signals[HAVE_TYPE], 0,
733       GST_TYPE_FIND_MAXIMUM, caps);
734
735   /* Shortcircuit typefinding if we get caps */
736   GST_DEBUG_OBJECT (typefind, "Skipping typefinding, using caps from "
737       "upstream: %" GST_PTR_FORMAT, caps);
738
739   stop_typefinding (typefind);
740
741   return TRUE;
742 }
743
744 static gchar *
745 gst_type_find_get_extension (GstTypeFindElement * typefind, GstPad * pad)
746 {
747   GstQuery *query;
748   gchar *uri, *result;
749   size_t len;
750   gint find;
751
752   query = gst_query_new_uri ();
753
754   /* try getting the caps with an uri query and from the extension */
755   if (!gst_pad_peer_query (pad, query))
756     goto peer_query_failed;
757
758   gst_query_parse_uri (query, &uri);
759   if (uri == NULL)
760     goto no_uri;
761
762   GST_DEBUG_OBJECT (typefind, "finding extension of %s", uri);
763
764   /* find the extension on the uri, this is everything after a '.' */
765   len = strlen (uri);
766   find = len - 1;
767
768   while (find >= 0) {
769     if (uri[find] == '.')
770       break;
771     find--;
772   }
773   if (find < 0)
774     goto no_extension;
775
776   result = g_strdup (&uri[find + 1]);
777
778   GST_DEBUG_OBJECT (typefind, "found extension %s", result);
779   gst_query_unref (query);
780   g_free (uri);
781
782   return result;
783
784   /* ERRORS */
785 peer_query_failed:
786   {
787     GST_WARNING_OBJECT (typefind, "failed to query peer uri");
788     gst_query_unref (query);
789     return NULL;
790   }
791 no_uri:
792   {
793     GST_WARNING_OBJECT (typefind, "could not parse the peer uri");
794     gst_query_unref (query);
795     return NULL;
796   }
797 no_extension:
798   {
799     GST_WARNING_OBJECT (typefind, "could not find uri extension in %s", uri);
800     gst_query_unref (query);
801     g_free (uri);
802     return NULL;
803   }
804 }
805
806 static GstCaps *
807 gst_type_find_guess_by_extension (GstTypeFindElement * typefind, GstPad * pad,
808     GstTypeFindProbability * probability)
809 {
810   gchar *ext;
811   GstCaps *caps;
812
813   ext = gst_type_find_get_extension (typefind, pad);
814   if (!ext)
815     return NULL;
816
817   caps = gst_type_find_helper_for_extension (GST_OBJECT_CAST (typefind), ext);
818   if (caps)
819     *probability = GST_TYPE_FIND_MAXIMUM;
820
821   g_free (ext);
822
823   return caps;
824 }
825
826 static GstFlowReturn
827 gst_type_find_element_chain (GstPad * pad, GstObject * parent,
828     GstBuffer * buffer)
829 {
830   GstTypeFindElement *typefind;
831   GstFlowReturn res = GST_FLOW_OK;
832
833   typefind = GST_TYPE_FIND_ELEMENT (parent);
834
835   GST_LOG_OBJECT (typefind, "handling buffer in mode %d", typefind->mode);
836
837   switch (typefind->mode) {
838     case MODE_ERROR:
839       /* we should already have called GST_ELEMENT_ERROR */
840       return GST_FLOW_ERROR;
841     case MODE_NORMAL:
842       /* don't take object lock as typefind->caps should not change anymore */
843       return gst_pad_push (typefind->src, buffer);
844     case MODE_TYPEFIND:
845     {
846       GST_OBJECT_LOCK (typefind);
847       gst_adapter_push (typefind->adapter, buffer);
848       GST_OBJECT_UNLOCK (typefind);
849
850       res = gst_type_find_element_chain_do_typefinding (typefind, TRUE);
851
852       if (typefind->mode == MODE_ERROR)
853         res = GST_FLOW_ERROR;
854
855       break;
856     }
857     default:
858       g_assert_not_reached ();
859       return GST_FLOW_ERROR;
860   }
861
862   return res;
863 }
864
865 static GstFlowReturn
866 gst_type_find_element_chain_do_typefinding (GstTypeFindElement * typefind,
867     gboolean check_avail)
868 {
869   GstTypeFindProbability probability;
870   GstCaps *caps = NULL;
871   gsize avail;
872   const guint8 *data;
873   gboolean have_min, have_max;
874
875   GST_OBJECT_LOCK (typefind);
876   if (typefind->force_caps) {
877     caps = gst_caps_ref (typefind->force_caps);
878     probability = GST_TYPE_FIND_MAXIMUM;
879   }
880
881   if (!caps) {
882     avail = gst_adapter_available (typefind->adapter);
883
884     if (check_avail) {
885       have_min = avail >= TYPE_FIND_MIN_SIZE;
886       have_max = avail >= TYPE_FIND_MAX_SIZE;
887     } else {
888       have_min = avail > 0;
889       have_max = TRUE;
890     }
891
892     if (!have_min)
893       goto not_enough_data;
894
895     /* map all available data */
896     data = gst_adapter_map (typefind->adapter, avail);
897     caps = gst_type_find_helper_for_data (GST_OBJECT (typefind),
898         data, avail, &probability);
899     gst_adapter_unmap (typefind->adapter);
900
901     if (caps == NULL && have_max)
902       goto no_type_found;
903     else if (caps == NULL)
904       goto wait_for_data;
905
906     /* found a type */
907     if (probability < typefind->min_probability)
908       goto low_probability;
909   }
910
911   GST_OBJECT_UNLOCK (typefind);
912
913   /* probability is good enough too, so let's make it known ... emiting this
914    * signal calls our object handler which sets the caps. */
915   g_signal_emit (typefind, gst_type_find_element_signals[HAVE_TYPE], 0,
916       probability, caps);
917
918   /* .. and send out the accumulated data */
919   stop_typefinding (typefind);
920   gst_caps_unref (caps);
921
922   return GST_FLOW_OK;
923
924 not_enough_data:
925   {
926     GST_DEBUG_OBJECT (typefind, "not enough data for typefinding yet "
927         "(%" G_GSIZE_FORMAT " bytes)", avail);
928     GST_OBJECT_UNLOCK (typefind);
929     return GST_FLOW_OK;
930   }
931 no_type_found:
932   {
933     GST_OBJECT_UNLOCK (typefind);
934     GST_ELEMENT_ERROR (typefind, STREAM, TYPE_NOT_FOUND, (NULL), (NULL));
935     stop_typefinding (typefind);
936     return GST_FLOW_ERROR;
937   }
938 wait_for_data:
939   {
940     GST_DEBUG_OBJECT (typefind,
941         "no caps found with %" G_GSIZE_FORMAT " bytes of data, "
942         "waiting for more data", avail);
943     GST_OBJECT_UNLOCK (typefind);
944     return GST_FLOW_OK;
945   }
946 low_probability:
947   {
948     GST_DEBUG_OBJECT (typefind, "found caps %" GST_PTR_FORMAT ", but "
949         "probability is %u which is lower than the required minimum of %u",
950         caps, probability, typefind->min_probability);
951
952     gst_caps_unref (caps);
953
954     if (have_max)
955       goto no_type_found;
956
957     GST_OBJECT_UNLOCK (typefind);
958     GST_DEBUG_OBJECT (typefind, "waiting for more data to try again");
959     return GST_FLOW_OK;
960   }
961 }
962
963 static GstFlowReturn
964 gst_type_find_element_getrange (GstPad * srcpad, GstObject * parent,
965     guint64 offset, guint length, GstBuffer ** buffer)
966 {
967   GstTypeFindElement *typefind;
968   GstFlowReturn ret;
969
970   typefind = GST_TYPE_FIND_ELEMENT (parent);
971
972   ret = gst_pad_pull_range (typefind->sink, offset, length, buffer);
973
974   return ret;
975 }
976
977 static gboolean
978 gst_type_find_element_activate_src_mode (GstPad * pad, GstObject * parent,
979     GstPadMode mode, gboolean active)
980 {
981   gboolean res;
982   GstTypeFindElement *typefind;
983
984   typefind = GST_TYPE_FIND_ELEMENT (parent);
985
986   switch (mode) {
987     case GST_PAD_MODE_PULL:
988       /* make sure our task stops pushing, we can't call _stop here because this
989        * activation might happen from the streaming thread. */
990       gst_pad_pause_task (typefind->sink);
991       res = gst_pad_activate_mode (typefind->sink, mode, active);
992       break;
993     default:
994       res = TRUE;
995       break;
996   }
997   return res;
998 }
999
1000 static void
1001 gst_type_find_element_loop (GstPad * pad)
1002 {
1003   GstTypeFindElement *typefind;
1004   GstFlowReturn ret = GST_FLOW_OK;
1005
1006   typefind = GST_TYPE_FIND_ELEMENT (GST_PAD_PARENT (pad));
1007
1008   if (typefind->need_stream_start) {
1009     gchar *stream_id;
1010     GstEvent *event;
1011
1012     stream_id = gst_pad_create_stream_id (typefind->src,
1013         GST_ELEMENT_CAST (typefind), NULL);
1014
1015     GST_DEBUG_OBJECT (typefind, "Pushing STREAM_START");
1016     event = gst_event_new_stream_start (stream_id);
1017     gst_event_set_group_id (event, gst_util_group_id_next ());
1018     gst_pad_push_event (typefind->src, event);
1019
1020     typefind->need_stream_start = FALSE;
1021     g_free (stream_id);
1022   }
1023
1024   if (typefind->mode == MODE_TYPEFIND) {
1025     GstPad *peer = NULL;
1026     GstCaps *found_caps = NULL;
1027     GstTypeFindProbability probability = GST_TYPE_FIND_NONE;
1028
1029     GST_DEBUG_OBJECT (typefind, "find type in pull mode");
1030
1031     GST_OBJECT_LOCK (typefind);
1032     if (typefind->force_caps) {
1033       found_caps = gst_caps_ref (typefind->force_caps);
1034       probability = GST_TYPE_FIND_MAXIMUM;
1035     }
1036     GST_OBJECT_UNLOCK (typefind);
1037
1038     if (!found_caps) {
1039       peer = gst_pad_get_peer (pad);
1040       if (peer) {
1041         gint64 size;
1042         gchar *ext;
1043
1044         if (!gst_pad_query_duration (peer, GST_FORMAT_BYTES, &size)) {
1045           GST_WARNING_OBJECT (typefind, "Could not query upstream length!");
1046           gst_object_unref (peer);
1047
1048           ret = GST_FLOW_ERROR;
1049           goto pause;
1050         }
1051
1052         /* the size if 0, we cannot continue */
1053         if (size == 0) {
1054           /* keep message in sync with message in sink event handler */
1055           GST_ELEMENT_ERROR (typefind, STREAM, TYPE_NOT_FOUND,
1056               (_("Stream contains no data.")), ("Can't typefind empty stream"));
1057           gst_object_unref (peer);
1058           ret = GST_FLOW_ERROR;
1059           goto pause;
1060         }
1061         ext = gst_type_find_get_extension (typefind, pad);
1062
1063         found_caps =
1064             gst_type_find_helper_get_range (GST_OBJECT_CAST (peer),
1065             GST_OBJECT_PARENT (peer),
1066             (GstTypeFindHelperGetRangeFunction) (GST_PAD_GETRANGEFUNC (peer)),
1067             (guint64) size, ext, &probability);
1068         g_free (ext);
1069
1070         GST_DEBUG ("Found caps %" GST_PTR_FORMAT, found_caps);
1071
1072         gst_object_unref (peer);
1073       }
1074     }
1075
1076     if (!found_caps || probability < typefind->min_probability) {
1077       GST_DEBUG ("Trying to guess using extension");
1078       gst_caps_replace (&found_caps, NULL);
1079       found_caps =
1080           gst_type_find_guess_by_extension (typefind, pad, &probability);
1081     }
1082
1083     if (!found_caps || probability < typefind->min_probability) {
1084       GST_ELEMENT_ERROR (typefind, STREAM, TYPE_NOT_FOUND, (NULL), (NULL));
1085       gst_caps_replace (&found_caps, NULL);
1086       ret = GST_FLOW_ERROR;
1087       goto pause;
1088     }
1089
1090     GST_DEBUG ("Emiting found caps %" GST_PTR_FORMAT, found_caps);
1091     g_signal_emit (typefind, gst_type_find_element_signals[HAVE_TYPE],
1092         0, probability, found_caps);
1093     typefind->mode = MODE_NORMAL;
1094     gst_caps_unref (found_caps);
1095   } else if (typefind->mode == MODE_NORMAL) {
1096     GstBuffer *outbuf = NULL;
1097
1098     if (typefind->need_segment) {
1099       typefind->need_segment = FALSE;
1100       gst_pad_push_event (typefind->src,
1101           gst_event_new_segment (&typefind->segment));
1102     }
1103
1104     /* Pull 4k blocks and send downstream */
1105     ret = gst_pad_pull_range (typefind->sink, typefind->offset, 4096, &outbuf);
1106     if (ret != GST_FLOW_OK)
1107       goto pause;
1108
1109     typefind->offset += gst_buffer_get_size (outbuf);
1110
1111     ret = gst_pad_push (typefind->src, outbuf);
1112     if (ret != GST_FLOW_OK)
1113       goto pause;
1114   } else {
1115     /* Error out */
1116     ret = GST_FLOW_ERROR;
1117     goto pause;
1118   }
1119
1120   return;
1121
1122 pause:
1123   {
1124     const gchar *reason = gst_flow_get_name (ret);
1125     gboolean push_eos = FALSE;
1126
1127     GST_LOG_OBJECT (typefind, "pausing task, reason %s", reason);
1128     gst_pad_pause_task (typefind->sink);
1129
1130     if (ret == GST_FLOW_EOS) {
1131       /* perform EOS logic */
1132
1133       if (typefind->segment.flags & GST_SEGMENT_FLAG_SEGMENT) {
1134         gint64 stop;
1135
1136         /* for segment playback we need to post when (in stream time)
1137          * we stopped, this is either stop (when set) or the duration. */
1138         if ((stop = typefind->segment.stop) == -1)
1139           stop = typefind->offset;
1140
1141         GST_LOG_OBJECT (typefind, "Sending segment done, at end of segment");
1142         gst_element_post_message (GST_ELEMENT (typefind),
1143             gst_message_new_segment_done (GST_OBJECT (typefind),
1144                 GST_FORMAT_BYTES, stop));
1145         gst_pad_push_event (typefind->src,
1146             gst_event_new_segment_done (GST_FORMAT_BYTES, stop));
1147       } else {
1148         push_eos = TRUE;
1149       }
1150     } else if (ret == GST_FLOW_NOT_LINKED || ret < GST_FLOW_EOS) {
1151       /* for fatal errors we post an error message */
1152       GST_ELEMENT_ERROR (typefind, STREAM, FAILED, (NULL),
1153           ("stream stopped, reason %s", reason));
1154       push_eos = TRUE;
1155     }
1156     if (push_eos) {
1157       /* send EOS, and prevent hanging if no streams yet */
1158       GST_LOG_OBJECT (typefind, "Sending EOS, at end of stream");
1159       gst_pad_push_event (typefind->src, gst_event_new_eos ());
1160     }
1161     return;
1162   }
1163 }
1164
1165 static gboolean
1166 gst_type_find_element_activate_sink_mode (GstPad * pad, GstObject * parent,
1167     GstPadMode mode, gboolean active)
1168 {
1169   gboolean res;
1170   GstTypeFindElement *typefind;
1171
1172   typefind = GST_TYPE_FIND_ELEMENT (parent);
1173
1174   switch (mode) {
1175     case GST_PAD_MODE_PULL:
1176       if (active) {
1177         gst_segment_init (&typefind->segment, GST_FORMAT_BYTES);
1178         typefind->need_segment = TRUE;
1179         typefind->need_stream_start = TRUE;
1180         typefind->offset = 0;
1181         res = TRUE;
1182       } else {
1183         res = gst_pad_stop_task (pad);
1184       }
1185       break;
1186     case GST_PAD_MODE_PUSH:
1187       if (active)
1188         start_typefinding (typefind);
1189       else
1190         stop_typefinding (typefind);
1191
1192       res = TRUE;
1193       break;
1194     default:
1195       res = FALSE;
1196       break;
1197   }
1198   return res;
1199 }
1200
1201 static gboolean
1202 gst_type_find_element_activate_sink (GstPad * pad, GstObject * parent)
1203 {
1204   GstQuery *query;
1205   gboolean pull_mode;
1206   GstSchedulingFlags sched_flags;
1207
1208   query = gst_query_new_scheduling ();
1209
1210   if (!gst_pad_peer_query (pad, query)) {
1211     gst_query_unref (query);
1212     goto typefind_push;
1213   }
1214
1215   gst_query_parse_scheduling (query, &sched_flags, NULL, NULL, NULL);
1216
1217   pull_mode = gst_query_has_scheduling_mode (query, GST_PAD_MODE_PULL)
1218       && ((sched_flags & GST_SCHEDULING_FLAG_SEEKABLE) != 0);
1219
1220   gst_query_unref (query);
1221
1222   if (!pull_mode)
1223     goto typefind_push;
1224
1225   if (!gst_pad_activate_mode (pad, GST_PAD_MODE_PULL, TRUE))
1226     goto typefind_push;
1227
1228   /* only start our task if we ourselves decide to start in pull mode */
1229   return gst_pad_start_task (pad, (GstTaskFunction) gst_type_find_element_loop,
1230       pad, NULL);
1231
1232 typefind_push:
1233   {
1234     return gst_pad_activate_mode (pad, GST_PAD_MODE_PUSH, TRUE);
1235   }
1236 }
1237
1238 static GstStateChangeReturn
1239 gst_type_find_element_change_state (GstElement * element,
1240     GstStateChange transition)
1241 {
1242   GstStateChangeReturn ret;
1243   GstTypeFindElement *typefind;
1244
1245   typefind = GST_TYPE_FIND_ELEMENT (element);
1246
1247
1248   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
1249
1250   switch (transition) {
1251     case GST_STATE_CHANGE_PAUSED_TO_READY:
1252     case GST_STATE_CHANGE_READY_TO_NULL:
1253       GST_OBJECT_LOCK (typefind);
1254       gst_caps_replace (&typefind->caps, NULL);
1255
1256       g_list_foreach (typefind->cached_events,
1257           (GFunc) gst_mini_object_unref, NULL);
1258       g_list_free (typefind->cached_events);
1259       typefind->cached_events = NULL;
1260       typefind->mode = MODE_TYPEFIND;
1261       GST_OBJECT_UNLOCK (typefind);
1262       break;
1263     default:
1264       break;
1265   }
1266
1267   return ret;
1268 }