2 * Copyright (C) 2003 Benjamin Otte <in7y118@public.uni-hamburg.de>
4 * gsttypefindelement.c: element that detects type of stream
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.
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.
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.
22 * SECTION:element-typefind
25 * Determines the media-type of a stream. It applies typefind functions in the
26 * order of their rank. Once the type has been detected it sets its src pad caps
27 * to the found media type.
29 * Whenever a type is found the #GstTypeFindElement::have-type signal is
30 * emitted, either from the streaming thread or the application thread
31 * (the latter may happen when typefinding is done pull-based from the
32 * state change function).
34 * Plugins can register custom typefinders by using #GstTypeFindFactory.
37 /* FIXME: need a better solution for non-seekable streams */
40 * 1) get a list of all typefind functions sorted best to worst
41 * 2) if all elements have been called with all requested data goto 8
42 * 3) call all functions once with all available data
43 * 4) if a function returns a value >= PROP_MAXIMUM goto 8 (never implemented))
44 * 5) all functions with a result > PROP_MINIMUM or functions that did not get
45 * all requested data (where peek returned NULL) stay in list
46 * 6) seek to requested offset of best function that still has open data
49 * 8) take best available result and use its caps
51 * The element has two scheduling modes:
53 * 1) chain based, it will collect buffers and run the typefind function on
54 * the buffer until something is found.
55 * 2) getrange based, it will proxy the getrange function to the sinkpad. It
56 * is assumed that the peer element is happy with whatever format we
59 * By default it tries to do pull based typefinding (this avoids joining
60 * received buffers and holding them back in store.)
62 * When the element has no connected srcpad, and the sinkpad can operate in
63 * getrange based mode, the element starts its own task to figure out the
66 * Most of the actual implementation is in libs/gst/base/gsttypefindhelper.c.
73 #include "gst/gst_private.h"
75 #include "gsttypefindelement.h"
76 #include "gst/gst-i18n-lib.h"
77 #include "gst/base/gsttypefindhelper.h"
79 #include <gst/gsttypefind.h>
80 #include <gst/gstutils.h>
81 #include <gst/gsterror.h>
83 GST_DEBUG_CATEGORY_STATIC (gst_type_find_element_debug);
84 #define GST_CAT_DEFAULT gst_type_find_element_debug
86 /* generic templates */
87 static GstStaticPadTemplate type_find_element_sink_template =
88 GST_STATIC_PAD_TEMPLATE ("sink",
93 static GstStaticPadTemplate type_find_element_src_template =
94 GST_STATIC_PAD_TEMPLATE ("src",
99 /* Require at least 2kB of data before we attempt typefinding in chain-mode.
100 * 128kB is massive overkill for the maximum, but doesn't do any harm */
101 #define TYPE_FIND_MIN_SIZE (2*1024)
102 #define TYPE_FIND_MAX_SIZE (128*1024)
104 /* TypeFind signals and args */
120 MODE_NORMAL, /* act as identity */
121 MODE_TYPEFIND, /* do typefinding */
122 MODE_ERROR /* had fatal error */
127 GST_DEBUG_CATEGORY_INIT (gst_type_find_element_debug, "typefind", \
128 GST_DEBUG_BG_YELLOW | GST_DEBUG_FG_GREEN, "type finding element");
129 #define gst_type_find_element_parent_class parent_class
130 G_DEFINE_TYPE_WITH_CODE (GstTypeFindElement, gst_type_find_element,
131 GST_TYPE_ELEMENT, _do_init);
133 static void gst_type_find_element_dispose (GObject * object);
134 static void gst_type_find_element_set_property (GObject * object,
135 guint prop_id, const GValue * value, GParamSpec * pspec);
136 static void gst_type_find_element_get_property (GObject * object,
137 guint prop_id, GValue * value, GParamSpec * pspec);
139 static gboolean gst_type_find_element_src_event (GstPad * pad,
140 GstObject * parent, GstEvent * event);
141 static gboolean gst_type_find_handle_src_query (GstPad * pad,
142 GstObject * parent, GstQuery * query);
144 static gboolean gst_type_find_element_sink_event (GstPad * pad,
145 GstObject * parent, GstEvent * event);
146 static gboolean gst_type_find_element_setcaps (GstTypeFindElement * typefind,
148 static GstFlowReturn gst_type_find_element_chain (GstPad * sinkpad,
149 GstObject * parent, GstBuffer * buffer);
150 static GstFlowReturn gst_type_find_element_getrange (GstPad * srcpad,
151 GstObject * parent, guint64 offset, guint length, GstBuffer ** buffer);
153 static GstStateChangeReturn
154 gst_type_find_element_change_state (GstElement * element,
155 GstStateChange transition);
156 static gboolean gst_type_find_element_activate_sink (GstPad * pad,
158 static gboolean gst_type_find_element_activate_sink_mode (GstPad * pad,
159 GstObject * parent, GstPadMode mode, gboolean active);
160 static gboolean gst_type_find_element_activate_src_mode (GstPad * pad,
161 GstObject * parent, GstPadMode mode, gboolean active);
163 gst_type_find_element_chain_do_typefinding (GstTypeFindElement * typefind,
164 gboolean check_avail, gboolean at_eos);
165 static void gst_type_find_element_send_cached_events (GstTypeFindElement *
168 static void gst_type_find_element_loop (GstPad * pad);
170 static guint gst_type_find_element_signals[LAST_SIGNAL] = { 0 };
173 gst_type_find_element_have_type (GstTypeFindElement * typefind,
174 guint probability, GstCaps * caps)
178 g_assert (caps != NULL);
180 GST_INFO_OBJECT (typefind, "found caps %" GST_PTR_FORMAT ", probability=%u",
183 /* Do nothing if downstream is pulling from us */
184 if (GST_PAD_MODE (typefind->src) == GST_PAD_MODE_PULL)
187 GST_OBJECT_LOCK (typefind);
189 /* Now actually send the CAPS event downstream.
191 * Try to directly send the CAPS event downstream that we created in
192 * gst_type_find_element_emit_have_type() if it is still there, instead
193 * of creating a new one. No need to create an equivalent one, replacing
194 * it in the sticky event list and possibly causing renegotiation
196 event = gst_pad_get_sticky_event (typefind->src, GST_EVENT_CAPS, 0);
200 gst_event_parse_caps (event, &event_caps);
201 if (caps != event_caps) {
202 gst_event_unref (event);
203 event = gst_event_new_caps (caps);
206 event = gst_event_new_caps (caps);
209 GST_OBJECT_UNLOCK (typefind);
211 gst_pad_push_event (typefind->src, event);
215 gst_type_find_element_emit_have_type (GstTypeFindElement * typefind,
216 guint probability, GstCaps * caps)
220 /* Update caps field immediately so that caps queries and properties can be
221 * honored in all "have-type" signal handlers.
223 GST_OBJECT_LOCK (typefind);
224 gst_caps_replace (&typefind->caps, caps);
225 GST_OBJECT_UNLOCK (typefind);
227 /* Only store the caps event at this point. We give signal handlers
228 * the chance to look at the caps before they are sent downstream.
229 * They are only forwarded downstream later in the default signal
230 * handler after all application signal handlers
232 event = gst_event_new_caps (caps);
233 gst_pad_store_sticky_event (typefind->src, event);
234 gst_event_unref (event);
236 g_signal_emit (typefind, gst_type_find_element_signals[HAVE_TYPE], 0,
241 gst_type_find_element_class_init (GstTypeFindElementClass * typefind_class)
243 GObjectClass *gobject_class = G_OBJECT_CLASS (typefind_class);
244 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (typefind_class);
246 gobject_class->set_property = gst_type_find_element_set_property;
247 gobject_class->get_property = gst_type_find_element_get_property;
248 gobject_class->dispose = gst_type_find_element_dispose;
250 g_object_class_install_property (gobject_class, PROP_CAPS,
251 g_param_spec_boxed ("caps", _("caps"),
252 _("detected capabilities in stream"), GST_TYPE_CAPS,
253 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
254 g_object_class_install_property (gobject_class, PROP_MINIMUM,
255 g_param_spec_uint ("minimum", _("minimum"),
256 "minimum probability required to accept caps", GST_TYPE_FIND_MINIMUM,
257 GST_TYPE_FIND_MAXIMUM, GST_TYPE_FIND_MINIMUM,
258 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
259 g_object_class_install_property (gobject_class, PROP_FORCE_CAPS,
260 g_param_spec_boxed ("force-caps", _("force caps"),
261 _("force caps without doing a typefind"), GST_TYPE_CAPS,
262 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
264 * GstTypeFindElement::have-type:
265 * @typefind: the typefind instance
266 * @probability: the probability of the type found
267 * @caps: the caps of the type found
269 * This signal gets emitted when the type and its probability has
272 gst_type_find_element_signals[HAVE_TYPE] = g_signal_new ("have-type",
273 G_TYPE_FROM_CLASS (typefind_class), G_SIGNAL_RUN_LAST,
274 G_STRUCT_OFFSET (GstTypeFindElementClass, have_type), NULL, NULL,
275 g_cclosure_marshal_generic, G_TYPE_NONE, 2,
276 G_TYPE_UINT, GST_TYPE_CAPS | G_SIGNAL_TYPE_STATIC_SCOPE);
278 typefind_class->have_type =
279 GST_DEBUG_FUNCPTR (gst_type_find_element_have_type);
281 gst_element_class_set_static_metadata (gstelement_class,
284 "Finds the media type of a stream",
285 "Benjamin Otte <in7y118@public.uni-hamburg.de>");
286 gst_element_class_add_static_pad_template (gstelement_class,
287 &type_find_element_src_template);
288 gst_element_class_add_static_pad_template (gstelement_class,
289 &type_find_element_sink_template);
291 gstelement_class->change_state =
292 GST_DEBUG_FUNCPTR (gst_type_find_element_change_state);
296 gst_type_find_element_init (GstTypeFindElement * typefind)
300 gst_pad_new_from_static_template (&type_find_element_sink_template,
303 gst_pad_set_activate_function (typefind->sink,
304 GST_DEBUG_FUNCPTR (gst_type_find_element_activate_sink));
305 gst_pad_set_activatemode_function (typefind->sink,
306 GST_DEBUG_FUNCPTR (gst_type_find_element_activate_sink_mode));
307 gst_pad_set_chain_function (typefind->sink,
308 GST_DEBUG_FUNCPTR (gst_type_find_element_chain));
309 gst_pad_set_event_function (typefind->sink,
310 GST_DEBUG_FUNCPTR (gst_type_find_element_sink_event));
311 GST_PAD_SET_PROXY_ALLOCATION (typefind->sink);
312 gst_element_add_pad (GST_ELEMENT (typefind), typefind->sink);
316 gst_pad_new_from_static_template (&type_find_element_src_template, "src");
318 gst_pad_set_activatemode_function (typefind->src,
319 GST_DEBUG_FUNCPTR (gst_type_find_element_activate_src_mode));
320 gst_pad_set_getrange_function (typefind->src,
321 GST_DEBUG_FUNCPTR (gst_type_find_element_getrange));
322 gst_pad_set_event_function (typefind->src,
323 GST_DEBUG_FUNCPTR (gst_type_find_element_src_event));
324 gst_pad_set_query_function (typefind->src,
325 GST_DEBUG_FUNCPTR (gst_type_find_handle_src_query));
326 gst_pad_use_fixed_caps (typefind->src);
327 gst_element_add_pad (GST_ELEMENT (typefind), typefind->src);
329 typefind->mode = MODE_TYPEFIND;
330 typefind->caps = NULL;
331 typefind->min_probability = 1;
333 typefind->adapter = gst_adapter_new ();
337 gst_type_find_element_dispose (GObject * object)
339 GstTypeFindElement *typefind = GST_TYPE_FIND_ELEMENT (object);
341 gst_clear_object (&typefind->adapter);
342 gst_clear_caps (&typefind->force_caps);
344 G_OBJECT_CLASS (parent_class)->dispose (object);
348 gst_type_find_element_set_property (GObject * object, guint prop_id,
349 const GValue * value, GParamSpec * pspec)
351 GstTypeFindElement *typefind;
353 typefind = GST_TYPE_FIND_ELEMENT (object);
357 typefind->min_probability = g_value_get_uint (value);
359 case PROP_FORCE_CAPS:
360 GST_OBJECT_LOCK (typefind);
361 gst_caps_take (&typefind->force_caps, g_value_dup_boxed (value));
362 GST_OBJECT_UNLOCK (typefind);
365 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
371 gst_type_find_element_get_property (GObject * object, guint prop_id,
372 GValue * value, GParamSpec * pspec)
374 GstTypeFindElement *typefind;
376 typefind = GST_TYPE_FIND_ELEMENT (object);
380 GST_OBJECT_LOCK (typefind);
381 g_value_set_boxed (value, typefind->caps);
382 GST_OBJECT_UNLOCK (typefind);
385 g_value_set_uint (value, typefind->min_probability);
387 case PROP_FORCE_CAPS:
388 GST_OBJECT_LOCK (typefind);
389 g_value_set_boxed (value, typefind->force_caps);
390 GST_OBJECT_UNLOCK (typefind);
393 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
399 gst_type_find_handle_src_query (GstPad * pad, GstObject * parent,
402 GstTypeFindElement *typefind;
403 gboolean res = FALSE;
405 typefind = GST_TYPE_FIND_ELEMENT (parent);
406 GST_DEBUG_OBJECT (typefind, "Handling src query %s",
407 GST_QUERY_TYPE_NAME (query));
409 switch (GST_QUERY_TYPE (query)) {
410 case GST_QUERY_SCHEDULING:
411 /* FIXME, filter out the scheduling modes that we understand */
412 res = gst_pad_peer_query (typefind->sink, query);
416 GST_DEBUG_OBJECT (typefind,
417 "Got caps query, our caps are %" GST_PTR_FORMAT, typefind->caps);
419 /* We can hijack caps query if we typefind already */
420 if (typefind->caps) {
421 gst_query_set_caps_result (query, typefind->caps);
424 res = gst_pad_peer_query (typefind->sink, query);
428 case GST_QUERY_POSITION:
433 if (!(res = gst_pad_peer_query (typefind->sink, query)))
436 gst_query_parse_position (query, &format, &peer_pos);
438 GST_OBJECT_LOCK (typefind);
439 /* FIXME: this code assumes that there's no discont in the queue */
441 case GST_FORMAT_BYTES:
442 peer_pos -= gst_adapter_available (typefind->adapter);
443 if (peer_pos < 0) /* Clamp result to 0 */
450 GST_OBJECT_UNLOCK (typefind);
451 gst_query_set_position (query, format, peer_pos);
455 res = gst_pad_query_default (pad, parent, query);
463 gst_type_find_element_seek (GstTypeFindElement * typefind, GstEvent * event)
466 GstSeekType start_type, stop_type;
471 GstSegment seeksegment = { 0, };
473 gst_event_parse_seek (event, &rate, &format, &flags, &start_type, &start,
476 /* we can only seek on bytes */
477 if (format != GST_FORMAT_BYTES) {
478 GST_DEBUG_OBJECT (typefind, "Can only seek on BYTES");
482 /* copy segment, we need this because we still need the old
483 * segment when we close the current segment. */
484 memcpy (&seeksegment, &typefind->segment, sizeof (GstSegment));
486 GST_DEBUG_OBJECT (typefind, "configuring seek");
487 gst_segment_do_seek (&seeksegment, rate, format, flags,
488 start_type, start, stop_type, stop, NULL);
490 flush = ! !(flags & GST_SEEK_FLAG_FLUSH);
492 GST_DEBUG_OBJECT (typefind, "New segment %" GST_SEGMENT_FORMAT, &seeksegment);
495 GST_DEBUG_OBJECT (typefind, "Starting flush");
496 gst_pad_push_event (typefind->sink, gst_event_new_flush_start ());
497 gst_pad_push_event (typefind->src, gst_event_new_flush_start ());
499 GST_DEBUG_OBJECT (typefind, "Non-flushing seek, pausing task");
500 gst_pad_pause_task (typefind->sink);
503 /* now grab the stream lock so that streaming cannot continue, for
504 * non flushing seeks when the element is in PAUSED this could block
506 GST_DEBUG_OBJECT (typefind, "Waiting for streaming to stop");
507 GST_PAD_STREAM_LOCK (typefind->sink);
510 GST_DEBUG_OBJECT (typefind, "Stopping flush");
511 gst_pad_push_event (typefind->sink, gst_event_new_flush_stop (TRUE));
512 gst_pad_push_event (typefind->src, gst_event_new_flush_stop (TRUE));
515 /* now update the real segment info */
516 GST_DEBUG_OBJECT (typefind, "Committing new seek segment");
517 memcpy (&typefind->segment, &seeksegment, sizeof (GstSegment));
518 typefind->offset = typefind->segment.start;
520 /* notify start of new segment */
521 if (typefind->segment.flags & GST_SEGMENT_FLAG_SEGMENT) {
524 msg = gst_message_new_segment_start (GST_OBJECT (typefind),
525 GST_FORMAT_BYTES, typefind->segment.start);
526 gst_element_post_message (GST_ELEMENT (typefind), msg);
529 typefind->need_segment = TRUE;
531 /* restart our task since it might have been stopped when we did the
533 gst_pad_start_task (typefind->sink,
534 (GstTaskFunction) gst_type_find_element_loop, typefind->sink, NULL);
536 /* streaming can continue now */
537 GST_PAD_STREAM_UNLOCK (typefind->sink);
543 gst_type_find_element_src_event (GstPad * pad, GstObject * parent,
546 GstTypeFindElement *typefind = GST_TYPE_FIND_ELEMENT (parent);
549 /* Always forward RECONFIGURE events upstream */
550 if (GST_EVENT_TYPE (event) == GST_EVENT_RECONFIGURE) {
551 return gst_pad_push_event (typefind->sink, event);
554 if (typefind->mode != MODE_NORMAL) {
555 /* need to do more? */
556 GST_LOG_OBJECT (typefind, "Still typefinding. Not passing event upstream");
557 gst_event_unref (event);
561 /* Only handle seeks here if driving the pipeline */
562 if (typefind->segment.format != GST_FORMAT_UNDEFINED &&
563 GST_EVENT_TYPE (event) == GST_EVENT_SEEK) {
564 result = gst_type_find_element_seek (typefind, event);
565 gst_event_unref (event);
568 return gst_pad_push_event (typefind->sink, event);
573 start_typefinding (GstTypeFindElement * typefind)
575 GST_DEBUG_OBJECT (typefind, "starting typefinding");
577 GST_OBJECT_LOCK (typefind);
579 gst_caps_replace (&typefind->caps, NULL);
580 typefind->initial_offset = GST_BUFFER_OFFSET_NONE;
581 GST_OBJECT_UNLOCK (typefind);
583 typefind->mode = MODE_TYPEFIND;
587 stop_typefinding (GstTypeFindElement * typefind)
590 gboolean push_cached_buffers;
593 GstClockTime pts, dts;
595 gst_element_get_state (GST_ELEMENT (typefind), &state, NULL, 0);
597 push_cached_buffers = (state >= GST_STATE_PAUSED && typefind->caps);
599 GST_DEBUG_OBJECT (typefind, "stopping typefinding%s",
600 push_cached_buffers ? " and pushing cached events and buffers" : "");
602 typefind->mode = MODE_NORMAL;
603 if (push_cached_buffers)
604 gst_type_find_element_send_cached_events (typefind);
606 GST_OBJECT_LOCK (typefind);
607 avail = gst_adapter_available (typefind->adapter);
611 pts = gst_adapter_prev_pts (typefind->adapter, NULL);
612 dts = gst_adapter_prev_dts (typefind->adapter, NULL);
613 buffer = gst_adapter_take_buffer (typefind->adapter, avail);
614 GST_BUFFER_PTS (buffer) = pts;
615 GST_BUFFER_DTS (buffer) = dts;
616 GST_BUFFER_OFFSET (buffer) = typefind->initial_offset;
617 GST_OBJECT_UNLOCK (typefind);
619 if (!push_cached_buffers) {
620 gst_buffer_unref (buffer);
622 GstPad *peer = gst_pad_get_peer (typefind->src);
624 /* make sure the user gets a meaningful error message in this case,
625 * which is not a core bug or bug of any kind (as the default error
626 * message emitted by gstpad.c otherwise would make you think) */
627 if (peer && GST_PAD_CHAINFUNC (peer) == NULL) {
628 GST_DEBUG_OBJECT (typefind, "upstream only supports push mode, while "
629 "downstream element only works in pull mode, erroring out");
630 GST_ELEMENT_ERROR (typefind, STREAM, FAILED,
631 ("%s cannot work in push mode. The operation is not supported "
632 "with this source element or protocol.",
633 G_OBJECT_TYPE_NAME (GST_PAD_PARENT (peer))),
634 ("Downstream pad %s:%s has no chainfunction, and the upstream "
635 "element does not support pull mode", GST_DEBUG_PAD_NAME (peer)));
636 typefind->mode = MODE_ERROR; /* make the chain function error out */
637 gst_buffer_unref (buffer);
639 gst_pad_push (typefind->src, buffer);
642 gst_object_unref (peer);
649 GST_DEBUG_OBJECT (typefind, "we have no data to typefind");
650 GST_OBJECT_UNLOCK (typefind);
656 gst_type_find_element_sink_event (GstPad * pad, GstObject * parent,
659 gboolean res = FALSE;
660 GstTypeFindElement *typefind = GST_TYPE_FIND_ELEMENT (parent);
662 GST_DEBUG_OBJECT (typefind, "got %s event in mode %d",
663 GST_EVENT_TYPE_NAME (event), typefind->mode);
665 switch (typefind->mode) {
667 switch (GST_EVENT_TYPE (event)) {
672 /* Parse and push out our caps and data */
673 gst_event_parse_caps (event, &caps);
674 res = gst_type_find_element_setcaps (typefind, caps);
676 gst_event_unref (event);
681 GST_FIXME_OBJECT (typefind,
682 "GAP events during typefinding not handled properly");
684 /* FIXME: These would need to be inserted in the stream at
685 * the right position between buffers, but we combine all
686 * buffers with a GstAdapter. Drop the GAP event for now,
687 * which will only cause an implicit GAP between buffers.
689 gst_event_unref (event);
695 GST_INFO_OBJECT (typefind, "Got EOS and no type found yet");
696 gst_type_find_element_chain_do_typefinding (typefind, FALSE, TRUE);
698 res = gst_pad_push_event (typefind->src, event);
701 case GST_EVENT_FLUSH_STOP:{
704 GST_OBJECT_LOCK (typefind);
706 for (l = typefind->cached_events; l; l = l->next) {
707 if (GST_EVENT_IS_STICKY (l->data) &&
708 GST_EVENT_TYPE (l->data) != GST_EVENT_SEGMENT &&
709 GST_EVENT_TYPE (l->data) != GST_EVENT_EOS) {
710 gst_pad_store_sticky_event (typefind->src, l->data);
712 gst_event_unref (l->data);
715 g_list_free (typefind->cached_events);
716 typefind->cached_events = NULL;
717 gst_adapter_clear (typefind->adapter);
718 GST_OBJECT_UNLOCK (typefind);
721 case GST_EVENT_FLUSH_START:
722 res = gst_pad_push_event (typefind->src, event);
725 /* Forward events that would happen before the caps event
726 * directly instead of storing them. There's no reason not
727 * to send them directly and we should only store events
728 * for later sending that would need to come after the caps
730 if (GST_EVENT_TYPE (event) < GST_EVENT_CAPS) {
731 res = gst_pad_push_event (typefind->src, event);
733 GST_DEBUG_OBJECT (typefind, "Saving %s event to send later",
734 GST_EVENT_TYPE_NAME (event));
735 GST_OBJECT_LOCK (typefind);
736 typefind->cached_events =
737 g_list_append (typefind->cached_events, event);
738 GST_OBJECT_UNLOCK (typefind);
745 res = gst_pad_push_event (typefind->src, event);
750 g_assert_not_reached ();
756 gst_type_find_element_send_cached_events (GstTypeFindElement * typefind)
758 GList *l, *cached_events;
760 GST_OBJECT_LOCK (typefind);
761 cached_events = typefind->cached_events;
762 typefind->cached_events = NULL;
763 GST_OBJECT_UNLOCK (typefind);
765 for (l = cached_events; l != NULL; l = l->next) {
766 GstEvent *event = GST_EVENT (l->data);
768 GST_DEBUG_OBJECT (typefind, "sending cached %s event",
769 GST_EVENT_TYPE_NAME (event));
770 gst_pad_push_event (typefind->src, event);
772 g_list_free (cached_events);
776 gst_type_find_element_setcaps (GstTypeFindElement * typefind, GstCaps * caps)
778 /* don't operate on ANY caps */
779 if (gst_caps_is_any (caps))
782 /* Set to MODE_NORMAL before emitting have-type, in case it triggers a seek */
783 typefind->mode = MODE_NORMAL;
784 gst_type_find_element_emit_have_type (typefind, GST_TYPE_FIND_MAXIMUM, caps);
786 /* Shortcircuit typefinding if we get caps */
787 GST_DEBUG_OBJECT (typefind, "Skipping typefinding, using caps from "
788 "upstream: %" GST_PTR_FORMAT, caps);
790 stop_typefinding (typefind);
796 gst_type_find_get_extension (GstTypeFindElement * typefind, GstPad * pad)
803 query = gst_query_new_uri ();
805 /* try getting the caps with an uri query and from the extension */
806 if (!gst_pad_peer_query (pad, query))
807 goto peer_query_failed;
809 gst_query_parse_uri (query, &uri);
813 GST_DEBUG_OBJECT (typefind, "finding extension of %s", uri);
815 /* find the extension on the uri, this is everything after a '.' */
820 if (uri[find] == '.')
827 result = g_strdup (&uri[find + 1]);
829 GST_DEBUG_OBJECT (typefind, "found extension %s", result);
830 gst_query_unref (query);
838 GST_INFO_OBJECT (typefind, "failed to query peer uri");
839 gst_query_unref (query);
844 GST_INFO_OBJECT (typefind, "could not parse the peer uri");
845 gst_query_unref (query);
850 GST_INFO_OBJECT (typefind, "could not find uri extension in %s", uri);
851 gst_query_unref (query);
858 gst_type_find_guess_by_extension (GstTypeFindElement * typefind, GstPad * pad,
859 GstTypeFindProbability * probability)
864 ext = gst_type_find_get_extension (typefind, pad);
868 caps = gst_type_find_helper_for_extension (GST_OBJECT_CAST (typefind), ext);
870 *probability = GST_TYPE_FIND_MAXIMUM;
878 gst_type_find_element_chain (GstPad * pad, GstObject * parent,
881 GstTypeFindElement *typefind;
882 GstFlowReturn res = GST_FLOW_OK;
884 typefind = GST_TYPE_FIND_ELEMENT (parent);
886 GST_LOG_OBJECT (typefind, "handling buffer in mode %d", typefind->mode);
888 switch (typefind->mode) {
890 /* we should already have called GST_ELEMENT_ERROR */
891 return GST_FLOW_ERROR;
893 /* don't take object lock as typefind->caps should not change anymore */
894 return gst_pad_push (typefind->src, buffer);
897 GST_OBJECT_LOCK (typefind);
898 if (typefind->initial_offset == GST_BUFFER_OFFSET_NONE)
899 typefind->initial_offset = GST_BUFFER_OFFSET (buffer);
900 gst_adapter_push (typefind->adapter, buffer);
901 GST_OBJECT_UNLOCK (typefind);
903 res = gst_type_find_element_chain_do_typefinding (typefind, TRUE, FALSE);
905 if (typefind->mode == MODE_ERROR)
906 res = GST_FLOW_ERROR;
911 g_assert_not_reached ();
912 return GST_FLOW_ERROR;
919 gst_type_find_element_chain_do_typefinding (GstTypeFindElement * typefind,
920 gboolean check_avail, gboolean at_eos)
922 GstTypeFindProbability probability;
923 GstCaps *caps = NULL;
926 gboolean have_min, have_max;
929 GST_OBJECT_LOCK (typefind);
930 if (typefind->force_caps) {
931 caps = gst_caps_ref (typefind->force_caps);
932 probability = GST_TYPE_FIND_MAXIMUM;
936 avail = gst_adapter_available (typefind->adapter);
939 have_min = avail >= TYPE_FIND_MIN_SIZE;
940 have_max = avail >= TYPE_FIND_MAX_SIZE;
942 have_min = avail > 0;
947 goto not_enough_data;
949 ext = gst_type_find_get_extension (typefind, typefind->sink);
950 /* map all available data */
951 data = gst_adapter_map (typefind->adapter, avail);
952 caps = gst_type_find_helper_for_data_with_extension (GST_OBJECT (typefind),
953 data, avail, ext, &probability);
954 gst_adapter_unmap (typefind->adapter);
957 if (caps == NULL && have_max)
959 else if (caps == NULL)
963 if (probability < typefind->min_probability)
964 goto low_probability;
967 GST_OBJECT_UNLOCK (typefind);
969 /* probability is good enough too, so let's make it known ... emitting this
970 * signal calls our object handler which sets the caps. */
971 /* Set to MODE_NORMAL before emitting have-type, in case it triggers a seek */
972 typefind->mode = MODE_NORMAL;
973 gst_type_find_element_emit_have_type (typefind, probability, caps);
975 /* .. and send out the accumulated data */
976 stop_typefinding (typefind);
977 gst_caps_unref (caps);
983 GST_OBJECT_UNLOCK (typefind);
986 GST_ELEMENT_ERROR (typefind, STREAM, TYPE_NOT_FOUND,
987 (_("Stream doesn't contain enough data.")),
988 ("Can't typefind stream"));
989 return GST_FLOW_ERROR;
991 GST_DEBUG_OBJECT (typefind, "not enough data for typefinding yet "
992 "(%" G_GSIZE_FORMAT " bytes)", avail);
998 GST_OBJECT_UNLOCK (typefind);
999 GST_ELEMENT_ERROR (typefind, STREAM, TYPE_NOT_FOUND, (NULL), (NULL));
1000 stop_typefinding (typefind);
1001 return GST_FLOW_ERROR;
1005 GST_OBJECT_UNLOCK (typefind);
1008 GST_ELEMENT_ERROR (typefind, STREAM, TYPE_NOT_FOUND,
1009 (_("Stream doesn't contain enough data.")),
1010 ("Can't typefind stream"));
1011 return GST_FLOW_ERROR;
1013 GST_DEBUG_OBJECT (typefind,
1014 "no caps found with %" G_GSIZE_FORMAT " bytes of data, "
1015 "waiting for more data", avail);
1021 GST_DEBUG_OBJECT (typefind, "found caps %" GST_PTR_FORMAT ", but "
1022 "probability is %u which is lower than the required minimum of %u",
1023 caps, probability, typefind->min_probability);
1025 gst_caps_unref (caps);
1030 GST_OBJECT_UNLOCK (typefind);
1031 GST_DEBUG_OBJECT (typefind, "waiting for more data to try again");
1036 static GstFlowReturn
1037 gst_type_find_element_getrange (GstPad * srcpad, GstObject * parent,
1038 guint64 offset, guint length, GstBuffer ** buffer)
1040 GstTypeFindElement *typefind;
1043 typefind = GST_TYPE_FIND_ELEMENT (parent);
1045 ret = gst_pad_pull_range (typefind->sink, offset, length, buffer);
1051 gst_type_find_element_activate_src_mode (GstPad * pad, GstObject * parent,
1052 GstPadMode mode, gboolean active)
1055 GstTypeFindElement *typefind;
1057 typefind = GST_TYPE_FIND_ELEMENT (parent);
1060 case GST_PAD_MODE_PULL:
1061 /* make sure our task stops pushing, we can't call _stop here because this
1062 * activation might happen from the streaming thread. */
1063 gst_pad_pause_task (typefind->sink);
1064 res = gst_pad_activate_mode (typefind->sink, mode, active);
1074 gst_type_find_element_loop (GstPad * pad)
1076 GstTypeFindElement *typefind;
1077 GstFlowReturn ret = GST_FLOW_OK;
1079 typefind = GST_TYPE_FIND_ELEMENT (GST_PAD_PARENT (pad));
1081 if (typefind->need_stream_start) {
1085 stream_id = gst_pad_create_stream_id (typefind->src,
1086 GST_ELEMENT_CAST (typefind), NULL);
1088 GST_DEBUG_OBJECT (typefind, "Pushing STREAM_START");
1089 event = gst_event_new_stream_start (stream_id);
1090 gst_event_set_group_id (event, gst_util_group_id_next ());
1091 gst_pad_push_event (typefind->src, event);
1093 typefind->need_stream_start = FALSE;
1097 if (typefind->mode == MODE_TYPEFIND) {
1098 GstPad *peer = NULL;
1099 GstCaps *found_caps = NULL;
1100 GstTypeFindProbability probability = GST_TYPE_FIND_NONE;
1102 GST_DEBUG_OBJECT (typefind, "find type in pull mode");
1104 GST_OBJECT_LOCK (typefind);
1105 if (typefind->force_caps) {
1106 found_caps = gst_caps_ref (typefind->force_caps);
1107 probability = GST_TYPE_FIND_MAXIMUM;
1109 GST_OBJECT_UNLOCK (typefind);
1112 peer = gst_pad_get_peer (pad);
1117 if (!gst_pad_query_duration (peer, GST_FORMAT_BYTES, &size)) {
1118 GST_WARNING_OBJECT (typefind, "Could not query upstream length!");
1119 gst_object_unref (peer);
1121 ret = GST_FLOW_ERROR;
1125 /* the size if 0, we cannot continue */
1127 /* keep message in sync with message in sink event handler */
1128 GST_ELEMENT_ERROR (typefind, STREAM, TYPE_NOT_FOUND,
1129 (_("Stream contains no data.")), ("Can't typefind empty stream"));
1130 gst_object_unref (peer);
1131 ret = GST_FLOW_ERROR;
1134 ext = gst_type_find_get_extension (typefind, pad);
1137 gst_type_find_helper_get_range_full (GST_OBJECT_CAST (peer),
1138 GST_OBJECT_PARENT (peer),
1139 (GstTypeFindHelperGetRangeFunction) (GST_PAD_GETRANGEFUNC (peer)),
1140 (guint64) size, ext, &found_caps, &probability);
1143 GST_DEBUG ("Found caps %" GST_PTR_FORMAT, found_caps);
1145 gst_object_unref (peer);
1147 if (ret != GST_FLOW_OK)
1152 if (!found_caps || probability < typefind->min_probability) {
1153 GST_DEBUG ("Trying to guess using extension");
1154 gst_caps_replace (&found_caps, NULL);
1156 gst_type_find_guess_by_extension (typefind, pad, &probability);
1159 if (!found_caps || probability < typefind->min_probability) {
1160 GST_ELEMENT_ERROR (typefind, STREAM, TYPE_NOT_FOUND, (NULL), (NULL));
1161 gst_caps_replace (&found_caps, NULL);
1162 ret = GST_FLOW_ERROR;
1166 GST_DEBUG ("Emitting found caps %" GST_PTR_FORMAT, found_caps);
1167 /* Set to MODE_NORMAL before emitting have-type, in case it triggers a seek */
1168 typefind->mode = MODE_NORMAL;
1169 gst_type_find_element_emit_have_type (typefind, probability, found_caps);
1170 gst_caps_unref (found_caps);
1171 } else if (typefind->mode == MODE_NORMAL) {
1172 GstBuffer *outbuf = NULL;
1174 if (typefind->need_segment) {
1175 typefind->need_segment = FALSE;
1176 gst_pad_push_event (typefind->src,
1177 gst_event_new_segment (&typefind->segment));
1180 /* Pull 4k blocks and send downstream */
1181 ret = gst_pad_pull_range (typefind->sink, typefind->offset, 4096, &outbuf);
1182 if (ret != GST_FLOW_OK)
1185 typefind->offset += gst_buffer_get_size (outbuf);
1187 ret = gst_pad_push (typefind->src, outbuf);
1188 if (ret != GST_FLOW_OK)
1192 ret = GST_FLOW_ERROR;
1200 const gchar *reason = gst_flow_get_name (ret);
1201 gboolean push_eos = FALSE;
1203 GST_LOG_OBJECT (typefind, "pausing task, reason %s", reason);
1204 gst_pad_pause_task (typefind->sink);
1206 if (ret == GST_FLOW_EOS) {
1207 /* perform EOS logic */
1209 if (typefind->segment.flags & GST_SEGMENT_FLAG_SEGMENT) {
1212 /* for segment playback we need to post when (in stream time)
1213 * we stopped, this is either stop (when set) or the duration. */
1214 if ((stop = typefind->segment.stop) == -1)
1215 stop = typefind->offset;
1217 GST_LOG_OBJECT (typefind, "Sending segment done, at end of segment");
1218 gst_element_post_message (GST_ELEMENT (typefind),
1219 gst_message_new_segment_done (GST_OBJECT (typefind),
1220 GST_FORMAT_BYTES, stop));
1221 gst_pad_push_event (typefind->src,
1222 gst_event_new_segment_done (GST_FORMAT_BYTES, stop));
1226 } else if (ret == GST_FLOW_NOT_LINKED || ret < GST_FLOW_EOS) {
1227 /* for fatal errors we post an error message */
1228 GST_ELEMENT_FLOW_ERROR (typefind, ret);
1232 /* send EOS, and prevent hanging if no streams yet */
1233 GST_LOG_OBJECT (typefind, "Sending EOS, at end of stream");
1234 gst_pad_push_event (typefind->src, gst_event_new_eos ());
1241 gst_type_find_element_activate_sink_mode (GstPad * pad, GstObject * parent,
1242 GstPadMode mode, gboolean active)
1245 GstTypeFindElement *typefind;
1247 typefind = GST_TYPE_FIND_ELEMENT (parent);
1250 case GST_PAD_MODE_PULL:
1252 gst_segment_init (&typefind->segment, GST_FORMAT_BYTES);
1253 typefind->need_segment = TRUE;
1254 typefind->need_stream_start = TRUE;
1255 typefind->offset = 0;
1258 res = gst_pad_stop_task (pad);
1259 gst_segment_init (&typefind->segment, GST_FORMAT_UNDEFINED);
1262 case GST_PAD_MODE_PUSH:
1264 gst_segment_init (&typefind->segment, GST_FORMAT_UNDEFINED);
1265 start_typefinding (typefind);
1267 stop_typefinding (typefind);
1268 gst_segment_init (&typefind->segment, GST_FORMAT_UNDEFINED);
1280 gst_type_find_element_activate_sink (GstPad * pad, GstObject * parent)
1285 query = gst_query_new_scheduling ();
1287 if (!gst_pad_peer_query (pad, query)) {
1288 gst_query_unref (query);
1292 pull_mode = gst_query_has_scheduling_mode_with_flags (query,
1293 GST_PAD_MODE_PULL, GST_SCHEDULING_FLAG_SEEKABLE);
1295 gst_query_unref (query);
1300 if (!gst_pad_activate_mode (pad, GST_PAD_MODE_PULL, TRUE))
1303 /* only start our task if we ourselves decide to start in pull mode */
1304 return gst_pad_start_task (pad, (GstTaskFunction) gst_type_find_element_loop,
1309 return gst_pad_activate_mode (pad, GST_PAD_MODE_PUSH, TRUE);
1313 static GstStateChangeReturn
1314 gst_type_find_element_change_state (GstElement * element,
1315 GstStateChange transition)
1317 GstStateChangeReturn ret;
1318 GstTypeFindElement *typefind;
1320 typefind = GST_TYPE_FIND_ELEMENT (element);
1323 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
1325 switch (transition) {
1326 case GST_STATE_CHANGE_PAUSED_TO_READY:
1327 case GST_STATE_CHANGE_READY_TO_NULL:
1328 GST_OBJECT_LOCK (typefind);
1329 gst_caps_replace (&typefind->caps, NULL);
1331 g_list_foreach (typefind->cached_events,
1332 (GFunc) gst_mini_object_unref, NULL);
1333 g_list_free (typefind->cached_events);
1334 typefind->cached_events = NULL;
1335 typefind->mode = MODE_TYPEFIND;
1336 GST_OBJECT_UNLOCK (typefind);