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. One the type has been deteted 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
 544   gst_element_get_state (GST_ELEMENT (typefind), &state, NULL, 0);
 545
 546   push_cached_buffers = (state >= GST_STATE_PAUSED && typefind->caps);
 547
 548   GST_DEBUG_OBJECT (typefind, "stopping typefinding%s",
 549       push_cached_buffers ? " and pushing cached events and buffers" : "");
 550
 551   typefind->mode = MODE_NORMAL;
 552   if (push_cached_buffers)
 553     gst_type_find_element_send_cached_events (typefind);
 554
 555   GST_OBJECT_LOCK (typefind);
 556   avail = gst_adapter_available (typefind->adapter);
 557   if (avail == 0)
 558     goto no_data;
 559
 560   buffer = gst_adapter_take_buffer (typefind->adapter, avail);
 561   GST_OBJECT_UNLOCK (typefind);
 562
 563   if (!push_cached_buffers) {
 564     gst_buffer_unref (buffer);
 565   } else {
 566     GstPad *peer = gst_pad_get_peer (typefind->src);
 567
 568     /* make sure the user gets a meaningful error message in this case,
 569      * which is not a core bug or bug of any kind (as the default error
 570      * message emitted by gstpad.c otherwise would make you think) */
 571     if (peer && GST_PAD_CHAINFUNC (peer) == NULL) {
 572       GST_DEBUG_OBJECT (typefind, "upstream only supports push mode, while "
 573           "downstream element only works in pull mode, erroring out");
 574       GST_ELEMENT_ERROR (typefind, STREAM, FAILED,
 575           ("%s cannot work in push mode. The operation is not supported "
 576               "with this source element or protocol.",
 577               G_OBJECT_TYPE_NAME (GST_PAD_PARENT (peer))),
 578           ("Downstream pad %s:%s has no chainfunction, and the upstream "
 579               "element does not support pull mode", GST_DEBUG_PAD_NAME (peer)));
 580       typefind->mode = MODE_ERROR;      /* make the chain function error out */
 581       gst_buffer_unref (buffer);
 582     } else {
 583       gst_pad_push (typefind->src, buffer);
 584     }
 585     if (peer)
 586       gst_object_unref (peer);
 587   }
 588   return;
 589
 590   /* ERRORS */
 591 no_data:
 592   {
 593     GST_DEBUG_OBJECT (typefind, "we have no data to typefind");
 594     GST_OBJECT_UNLOCK (typefind);
 595     return;
 596   }
 597 }
 598
 599 static gboolean
 600 gst_type_find_element_sink_event (GstPad * pad, GstObject * parent,
 601     GstEvent * event)
 602 {
 603   gboolean res = FALSE;
 604   GstTypeFindElement *typefind = GST_TYPE_FIND_ELEMENT (parent);
 605
 606   GST_DEBUG_OBJECT (typefind, "got %s event in mode %d",
 607       GST_EVENT_TYPE_NAME (event), typefind->mode);
 608
 609   switch (typefind->mode) {
 610     case MODE_TYPEFIND:
 611       switch (GST_EVENT_TYPE (event)) {
 612         case GST_EVENT_CAPS:
 613         {
 614           GstCaps *caps;
 615
 616           /* Parse and push out our caps and data */
 617           gst_event_parse_caps (event, &caps);
 618           res = gst_type_find_element_setcaps (typefind, caps);
 619
 620           gst_event_unref (event);
 621           break;
 622         }
 623         case GST_EVENT_GAP:
 624         {
 625           GST_FIXME_OBJECT (typefind,
 626               "GAP events during typefinding not handled properly");
 627
 628           /* FIXME: These would need to be inserted in the stream at
 629            * the right position between buffers, but we combine all
 630            * buffers with a GstAdapter. Drop the GAP event for now,
 631            * which will only cause an implicit GAP between buffers.
 632            */
 633           gst_event_unref (event);
 634           res = TRUE;
 635         }
 636         case GST_EVENT_EOS:
 637         {
 638           GST_INFO_OBJECT (typefind, "Got EOS and no type found yet");
 639           gst_type_find_element_chain_do_typefinding (typefind, FALSE);
 640
 641           res = gst_pad_push_event (typefind->src, event);
 642           break;
 643         }
 644         case GST_EVENT_FLUSH_STOP:
 645           GST_OBJECT_LOCK (typefind);
 646           g_list_foreach (typefind->cached_events,
 647               (GFunc) gst_mini_object_unref, NULL);
 648           g_list_free (typefind->cached_events);
 649           typefind->cached_events = NULL;
 650           gst_adapter_clear (typefind->adapter);
 651           GST_OBJECT_UNLOCK (typefind);
 652           /* fall through */
 653         case GST_EVENT_FLUSH_START:
 654           res = gst_pad_push_event (typefind->src, event);
 655           break;
 656         default:
 657           /* Forward events that would happen before the caps event
 658            * directly instead of storing them. There's no reason not
 659            * to send them directly and we should only store events
 660            * for later sending that would need to come after the caps
 661            * event */
 662           if (GST_EVENT_TYPE (event) < GST_EVENT_CAPS) {
 663             res = gst_pad_push_event (typefind->src, event);
 664           } else {
 665             GST_DEBUG_OBJECT (typefind, "Saving %s event to send later",
 666                 GST_EVENT_TYPE_NAME (event));
 667             GST_OBJECT_LOCK (typefind);
 668             typefind->cached_events =
 669                 g_list_append (typefind->cached_events, event);
 670             GST_OBJECT_UNLOCK (typefind);
 671             res = TRUE;
 672           }
 673           break;
 674       }
 675       break;
 676     case MODE_NORMAL:
 677       res = gst_pad_push_event (typefind->src, event);
 678       break;
 679     case MODE_ERROR:
 680       break;
 681     default:
 682       g_assert_not_reached ();
 683   }
 684   return res;
 685 }
 686
 687 static void
 688 gst_type_find_element_send_cached_events (GstTypeFindElement * typefind)
 689 {
 690   GList *l, *cached_events;
 691
 692   GST_OBJECT_LOCK (typefind);
 693   cached_events = typefind->cached_events;
 694   typefind->cached_events = NULL;
 695   GST_OBJECT_UNLOCK (typefind);
 696
 697   for (l = cached_events; l != NULL; l = l->next) {
 698     GstEvent *event = GST_EVENT (l->data);
 699
 700     GST_DEBUG_OBJECT (typefind, "sending cached %s event",
 701         GST_EVENT_TYPE_NAME (event));
 702     gst_pad_push_event (typefind->src, event);
 703   }
 704   g_list_free (cached_events);
 705 }
 706
 707 static gboolean
 708 gst_type_find_element_setcaps (GstTypeFindElement * typefind, GstCaps * caps)
 709 {
 710   /* don't operate on ANY caps */
 711   if (gst_caps_is_any (caps))
 712     return TRUE;
 713
 714   g_signal_emit (typefind, gst_type_find_element_signals[HAVE_TYPE], 0,
 715       GST_TYPE_FIND_MAXIMUM, caps);
 716
 717   /* Shortcircuit typefinding if we get caps */
 718   GST_DEBUG_OBJECT (typefind, "Skipping typefinding, using caps from "
 719       "upstream: %" GST_PTR_FORMAT, caps);
 720
 721   stop_typefinding (typefind);
 722
 723   return TRUE;
 724 }
 725
 726 static gchar *
 727 gst_type_find_get_extension (GstTypeFindElement * typefind, GstPad * pad)
 728 {
 729   GstQuery *query;
 730   gchar *uri, *result;
 731   size_t len;
 732   gint find;
 733
 734   query = gst_query_new_uri ();
 735
 736   /* try getting the caps with an uri query and from the extension */
 737   if (!gst_pad_peer_query (pad, query))
 738     goto peer_query_failed;
 739
 740   gst_query_parse_uri (query, &uri);
 741   if (uri == NULL)
 742     goto no_uri;
 743
 744   GST_DEBUG_OBJECT (typefind, "finding extension of %s", uri);
 745
 746   /* find the extension on the uri, this is everything after a '.' */
 747   len = strlen (uri);
 748   find = len - 1;
 749
 750   while (find >= 0) {
 751     if (uri[find] == '.')
 752       break;
 753     find--;
 754   }
 755   if (find < 0)
 756     goto no_extension;
 757
 758   result = g_strdup (&uri[find + 1]);
 759
 760   GST_DEBUG_OBJECT (typefind, "found extension %s", result);
 761   gst_query_unref (query);
 762   g_free (uri);
 763
 764   return result;
 765
 766   /* ERRORS */
 767 peer_query_failed:
 768   {
 769     GST_WARNING_OBJECT (typefind, "failed to query peer uri");
 770     gst_query_unref (query);
 771     return NULL;
 772   }
 773 no_uri:
 774   {
 775     GST_WARNING_OBJECT (typefind, "could not parse the peer uri");
 776     gst_query_unref (query);
 777     return NULL;
 778   }
 779 no_extension:
 780   {
 781     GST_WARNING_OBJECT (typefind, "could not find uri extension in %s", uri);
 782     gst_query_unref (query);
 783     g_free (uri);
 784     return NULL;
 785   }
 786 }
 787
 788 static GstCaps *
 789 gst_type_find_guess_by_extension (GstTypeFindElement * typefind, GstPad * pad,
 790     GstTypeFindProbability * probability)
 791 {
 792   gchar *ext;
 793   GstCaps *caps;
 794
 795   ext = gst_type_find_get_extension (typefind, pad);
 796   if (!ext)
 797     return NULL;
 798
 799   caps = gst_type_find_helper_for_extension (GST_OBJECT_CAST (typefind), ext);
 800   if (caps)
 801     *probability = GST_TYPE_FIND_MAXIMUM;
 802
 803   g_free (ext);
 804
 805   return caps;
 806 }
 807
 808 static GstFlowReturn
 809 gst_type_find_element_chain (GstPad * pad, GstObject * parent,
 810     GstBuffer * buffer)
 811 {
 812   GstTypeFindElement *typefind;
 813   GstFlowReturn res = GST_FLOW_OK;
 814
 815   typefind = GST_TYPE_FIND_ELEMENT (parent);
 816
 817   GST_LOG_OBJECT (typefind, "handling buffer in mode %d", typefind->mode);
 818
 819   switch (typefind->mode) {
 820     case MODE_ERROR:
 821       /* we should already have called GST_ELEMENT_ERROR */
 822       return GST_FLOW_ERROR;
 823     case MODE_NORMAL:
 824       /* don't take object lock as typefind->caps should not change anymore */
 825       return gst_pad_push (typefind->src, buffer);
 826     case MODE_TYPEFIND:
 827     {
 828       GST_OBJECT_LOCK (typefind);
 829       gst_adapter_push (typefind->adapter, buffer);
 830       GST_OBJECT_UNLOCK (typefind);
 831
 832       res = gst_type_find_element_chain_do_typefinding (typefind, TRUE);
 833
 834       if (typefind->mode == MODE_ERROR)
 835         res = GST_FLOW_ERROR;
 836
 837       break;
 838     }
 839     default:
 840       g_assert_not_reached ();
 841       return GST_FLOW_ERROR;
 842   }
 843
 844   return res;
 845 }
 846
 847 static GstFlowReturn
 848 gst_type_find_element_chain_do_typefinding (GstTypeFindElement * typefind,
 849     gboolean check_avail)
 850 {
 851   GstTypeFindProbability probability;
 852   GstCaps *caps;
 853   gsize avail;
 854   const guint8 *data;
 855   gboolean have_min, have_max;
 856
 857   GST_OBJECT_LOCK (typefind);
 858   avail = gst_adapter_available (typefind->adapter);
 859
 860   if (check_avail) {
 861     have_min = avail >= TYPE_FIND_MIN_SIZE;
 862     have_max = avail >= TYPE_FIND_MAX_SIZE;
 863   } else {
 864     have_min = avail > 0;
 865     have_max = TRUE;
 866   }
 867
 868   if (!have_min)
 869     goto not_enough_data;
 870
 871   /* map all available data */
 872   data = gst_adapter_map (typefind->adapter, avail);
 873   caps = gst_type_find_helper_for_data (GST_OBJECT (typefind),
 874       data, avail, &probability);
 875   gst_adapter_unmap (typefind->adapter);
 876
 877   if (caps == NULL && have_max)
 878     goto no_type_found;
 879   else if (caps == NULL)
 880     goto wait_for_data;
 881
 882   /* found a type */
 883   if (probability < typefind->min_probability)
 884     goto low_probability;
 885   GST_OBJECT_UNLOCK (typefind);
 886
 887   /* probability is good enough too, so let's make it known ... emiting this
 888    * signal calls our object handler which sets the caps. */
 889   g_signal_emit (typefind, gst_type_find_element_signals[HAVE_TYPE], 0,
 890       probability, caps);
 891
 892   /* .. and send out the accumulated data */
 893   stop_typefinding (typefind);
 894   gst_caps_unref (caps);
 895
 896   return GST_FLOW_OK;
 897
 898 not_enough_data:
 899   {
 900     GST_DEBUG_OBJECT (typefind, "not enough data for typefinding yet "
 901         "(%" G_GSIZE_FORMAT " bytes)", avail);
 902     GST_OBJECT_UNLOCK (typefind);
 903     return GST_FLOW_OK;
 904   }
 905 no_type_found:
 906   {
 907     GST_OBJECT_UNLOCK (typefind);
 908     GST_ELEMENT_ERROR (typefind, STREAM, TYPE_NOT_FOUND, (NULL), (NULL));
 909     stop_typefinding (typefind);
 910     return GST_FLOW_ERROR;
 911   }
 912 wait_for_data:
 913   {
 914     GST_DEBUG_OBJECT (typefind,
 915         "no caps found with %" G_GSIZE_FORMAT " bytes of data, "
 916         "waiting for more data", avail);
 917     GST_OBJECT_UNLOCK (typefind);
 918     return GST_FLOW_OK;
 919   }
 920 low_probability:
 921   {
 922     GST_DEBUG_OBJECT (typefind, "found caps %" GST_PTR_FORMAT ", but "
 923         "probability is %u which is lower than the required minimum of %u",
 924         caps, probability, typefind->min_probability);
 925
 926     gst_caps_unref (caps);
 927
 928     if (have_max)
 929       goto no_type_found;
 930
 931     GST_OBJECT_UNLOCK (typefind);
 932     GST_DEBUG_OBJECT (typefind, "waiting for more data to try again");
 933     return GST_FLOW_OK;
 934   }
 935 }
 936
 937 static GstFlowReturn
 938 gst_type_find_element_getrange (GstPad * srcpad, GstObject * parent,
 939     guint64 offset, guint length, GstBuffer ** buffer)
 940 {
 941   GstTypeFindElement *typefind;
 942   GstFlowReturn ret;
 943
 944   typefind = GST_TYPE_FIND_ELEMENT (parent);
 945
 946   ret = gst_pad_pull_range (typefind->sink, offset, length, buffer);
 947
 948   return ret;
 949 }
 950
 951 static gboolean
 952 gst_type_find_element_activate_src_mode (GstPad * pad, GstObject * parent,
 953     GstPadMode mode, gboolean active)
 954 {
 955   gboolean res;
 956   GstTypeFindElement *typefind;
 957
 958   typefind = GST_TYPE_FIND_ELEMENT (parent);
 959
 960   switch (mode) {
 961     case GST_PAD_MODE_PULL:
 962       /* make sure our task stops pushing, we can't call _stop here because this
 963        * activation might happen from the streaming thread. */
 964       gst_pad_pause_task (typefind->sink);
 965       res = gst_pad_activate_mode (typefind->sink, mode, active);
 966       break;
 967     default:
 968       res = TRUE;
 969       break;
 970   }
 971   return res;
 972 }
 973
 974 static void
 975 gst_type_find_element_loop (GstPad * pad)
 976 {
 977   GstTypeFindElement *typefind;
 978   GstFlowReturn ret = GST_FLOW_OK;
 979
 980   typefind = GST_TYPE_FIND_ELEMENT (GST_PAD_PARENT (pad));
 981
 982   if (typefind->mode == MODE_TYPEFIND) {
 983     GstPad *peer;
 984     GstCaps *found_caps = NULL;
 985     GstTypeFindProbability probability = GST_TYPE_FIND_NONE;
 986
 987     GST_DEBUG_OBJECT (typefind, "find type in pull mode");
 988
 989     peer = gst_pad_get_peer (pad);
 990     if (peer) {
 991       gint64 size;
 992       gchar *ext;
 993
 994       if (!gst_pad_query_duration (peer, GST_FORMAT_BYTES, &size)) {
 995         GST_WARNING_OBJECT (typefind, "Could not query upstream length!");
 996         gst_object_unref (peer);
 997
 998         ret = GST_FLOW_ERROR;
 999         goto pause;
1000       }
1001
1002       /* the size if 0, we cannot continue */
1003       if (size == 0) {
1004         /* keep message in sync with message in sink event handler */
1005         GST_ELEMENT_ERROR (typefind, STREAM, TYPE_NOT_FOUND,
1006             (_("Stream contains no data.")), ("Can't typefind empty stream"));
1007         gst_object_unref (peer);
1008         ret = GST_FLOW_ERROR;
1009         goto pause;
1010       }
1011       ext = gst_type_find_get_extension (typefind, pad);
1012
1013       found_caps =
1014           gst_type_find_helper_get_range (GST_OBJECT_CAST (peer),
1015           GST_OBJECT_PARENT (peer),
1016           (GstTypeFindHelperGetRangeFunction) (GST_PAD_GETRANGEFUNC (peer)),
1017           (guint64) size, ext, &probability);
1018       g_free (ext);
1019
1020       GST_DEBUG ("Found caps %" GST_PTR_FORMAT, found_caps);
1021
1022       gst_object_unref (peer);
1023     }
1024
1025     if (!found_caps || probability < typefind->min_probability) {
1026       GST_DEBUG ("Trying to guess using extension");
1027       gst_caps_replace (&found_caps, NULL);
1028       found_caps =
1029           gst_type_find_guess_by_extension (typefind, pad, &probability);
1030     }
1031
1032     if (!found_caps || probability < typefind->min_probability) {
1033       GST_ELEMENT_ERROR (typefind, STREAM, TYPE_NOT_FOUND, (NULL), (NULL));
1034       gst_caps_replace (&found_caps, NULL);
1035       ret = GST_FLOW_ERROR;
1036       goto pause;
1037     }
1038
1039     GST_DEBUG ("Emiting found caps %" GST_PTR_FORMAT, found_caps);
1040     g_signal_emit (typefind, gst_type_find_element_signals[HAVE_TYPE],
1041         0, probability, found_caps);
1042     typefind->mode = MODE_NORMAL;
1043     gst_caps_unref (found_caps);
1044   } else if (typefind->mode == MODE_NORMAL) {
1045     GstBuffer *outbuf = NULL;
1046
1047     if (typefind->need_stream_start) {
1048       gchar *stream_id;
1049
1050       stream_id =
1051           gst_pad_create_stream_id (typefind->src, GST_ELEMENT_CAST (typefind),
1052           NULL);
1053
1054       GST_DEBUG_OBJECT (typefind, "Pushing STREAM_START");
1055       gst_pad_push_event (typefind->src,
1056           gst_event_new_stream_start (stream_id));
1057
1058       typefind->need_stream_start = FALSE;
1059       g_free (stream_id);
1060     }
1061
1062     if (typefind->need_segment) {
1063       typefind->need_segment = FALSE;
1064       gst_pad_push_event (typefind->src,
1065           gst_event_new_segment (&typefind->segment));
1066     }
1067
1068     /* Pull 4k blocks and send downstream */
1069     ret = gst_pad_pull_range (typefind->sink, typefind->offset, 4096, &outbuf);
1070     if (ret != GST_FLOW_OK)
1071       goto pause;
1072
1073     typefind->offset += 4096;
1074
1075     ret = gst_pad_push (typefind->src, outbuf);
1076     if (ret != GST_FLOW_OK)
1077       goto pause;
1078   } else {
1079     /* Error out */
1080     ret = GST_FLOW_ERROR;
1081     goto pause;
1082   }
1083
1084   return;
1085
1086 pause:
1087   {
1088     const gchar *reason = gst_flow_get_name (ret);
1089     gboolean push_eos = FALSE;
1090
1091     GST_LOG_OBJECT (typefind, "pausing task, reason %s", reason);
1092     gst_pad_pause_task (typefind->sink);
1093
1094     if (ret == GST_FLOW_EOS) {
1095       /* perform EOS logic */
1096
1097       if (typefind->segment.flags & GST_SEGMENT_FLAG_SEGMENT) {
1098         gint64 stop;
1099
1100         /* for segment playback we need to post when (in stream time)
1101          * we stopped, this is either stop (when set) or the duration. */
1102         if ((stop = typefind->segment.stop) == -1)
1103           stop = typefind->offset;
1104
1105         GST_LOG_OBJECT (typefind, "Sending segment done, at end of segment");
1106         gst_element_post_message (GST_ELEMENT (typefind),
1107             gst_message_new_segment_done (GST_OBJECT (typefind),
1108                 GST_FORMAT_BYTES, stop));
1109         gst_pad_push_event (typefind->src,
1110             gst_event_new_segment_done (GST_FORMAT_BYTES, stop));
1111       } else {
1112         push_eos = TRUE;
1113       }
1114     } else if (ret == GST_FLOW_NOT_LINKED || ret < GST_FLOW_EOS) {
1115       /* for fatal errors we post an error message */
1116       GST_ELEMENT_ERROR (typefind, STREAM, FAILED, (NULL),
1117           ("stream stopped, reason %s", reason));
1118       push_eos = TRUE;
1119     }
1120     if (push_eos) {
1121       /* send EOS, and prevent hanging if no streams yet */
1122       GST_LOG_OBJECT (typefind, "Sending EOS, at end of stream");
1123       gst_pad_push_event (typefind->src, gst_event_new_eos ());
1124     }
1125     return;
1126   }
1127 }
1128
1129 static gboolean
1130 gst_type_find_element_activate_sink_mode (GstPad * pad, GstObject * parent,
1131     GstPadMode mode, gboolean active)
1132 {
1133   gboolean res;
1134   GstTypeFindElement *typefind;
1135
1136   typefind = GST_TYPE_FIND_ELEMENT (parent);
1137
1138   switch (mode) {
1139     case GST_PAD_MODE_PULL:
1140       if (active) {
1141         gst_segment_init (&typefind->segment, GST_FORMAT_BYTES);
1142         typefind->need_segment = TRUE;
1143         typefind->need_stream_start = TRUE;
1144         typefind->offset = 0;
1145         res = TRUE;
1146       } else {
1147         res = gst_pad_stop_task (pad);
1148       }
1149       break;
1150     case GST_PAD_MODE_PUSH:
1151       if (active)
1152         start_typefinding (typefind);
1153       else
1154         stop_typefinding (typefind);
1155
1156       res = TRUE;
1157       break;
1158     default:
1159       res = FALSE;
1160       break;
1161   }
1162   return res;
1163 }
1164
1165 static gboolean
1166 gst_type_find_element_activate_sink (GstPad * pad, GstObject * parent)
1167 {
1168   GstTypeFindElement *typefind;
1169   GstQuery *query;
1170   gboolean pull_mode;
1171   GstCaps *found_caps = NULL;
1172   GstTypeFindProbability probability = GST_TYPE_FIND_NONE;
1173   GstSchedulingFlags sched_flags;
1174
1175   typefind = GST_TYPE_FIND_ELEMENT (parent);
1176
1177   /* if we have force caps, use those */
1178   GST_OBJECT_LOCK (typefind);
1179   if (typefind->force_caps) {
1180     found_caps = gst_caps_ref (typefind->force_caps);
1181     probability = GST_TYPE_FIND_MAXIMUM;
1182     GST_OBJECT_UNLOCK (typefind);
1183
1184     GST_DEBUG ("Emiting found caps %" GST_PTR_FORMAT, found_caps);
1185     g_signal_emit (typefind, gst_type_find_element_signals[HAVE_TYPE],
1186         0, probability, found_caps);
1187     gst_caps_unref (found_caps);
1188     typefind->mode = MODE_NORMAL;
1189     /* the signal above could have made a downstream element activate
1190      * the pad in pull mode, we check if the pad is already active now and if
1191      * so, we are done */
1192     if (gst_pad_is_active (pad))
1193       return TRUE;
1194
1195     goto typefind_push;
1196   }
1197   GST_OBJECT_UNLOCK (typefind);
1198
1199   query = gst_query_new_scheduling ();
1200
1201   if (!gst_pad_peer_query (pad, query)) {
1202     gst_query_unref (query);
1203     goto typefind_push;
1204   }
1205
1206   gst_query_parse_scheduling (query, &sched_flags, NULL, NULL, NULL);
1207
1208   pull_mode = gst_query_has_scheduling_mode (query, GST_PAD_MODE_PULL)
1209       && ((sched_flags & GST_SCHEDULING_FLAG_SEEKABLE) != 0);
1210
1211   gst_query_unref (query);
1212
1213   if (!pull_mode)
1214     goto typefind_push;
1215
1216   if (!gst_pad_activate_mode (pad, GST_PAD_MODE_PULL, TRUE))
1217     goto typefind_push;
1218
1219   /* only start our task if we ourselves decide to start in pull mode */
1220   return gst_pad_start_task (pad, (GstTaskFunction) gst_type_find_element_loop,
1221       pad, NULL);
1222
1223 typefind_push:
1224   {
1225     return gst_pad_activate_mode (pad, GST_PAD_MODE_PUSH, TRUE);
1226   }
1227 }
1228
1229 static GstStateChangeReturn
1230 gst_type_find_element_change_state (GstElement * element,
1231     GstStateChange transition)
1232 {
1233   GstStateChangeReturn ret;
1234   GstTypeFindElement *typefind;
1235
1236   typefind = GST_TYPE_FIND_ELEMENT (element);
1237
1238
1239   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
1240
1241   switch (transition) {
1242     case GST_STATE_CHANGE_PAUSED_TO_READY:
1243     case GST_STATE_CHANGE_READY_TO_NULL:
1244       GST_OBJECT_LOCK (typefind);
1245       gst_caps_replace (&typefind->caps, NULL);
1246
1247       g_list_foreach (typefind->cached_events,
1248           (GFunc) gst_mini_object_unref, NULL);
1249       g_list_free (typefind->cached_events);
1250       typefind->cached_events = NULL;
1251       typefind->mode = MODE_TYPEFIND;
1252       GST_OBJECT_UNLOCK (typefind);
1253       break;
1254     default:
1255       break;
1256   }
1257
1258   return ret;
1259 }