plugins/elements/gsttypefindelement.c

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