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