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