gst/gstpad.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *
   5  * gstpad.c: Pads for linking elements together
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22 /**
  23  * SECTION:gstpad
  24  * @short_description: Object contained by elements that allows links to
  25  *                     other elements
  26  * @see_also: #GstPadTemplate, #GstElement, #GstEvent, #GstQuery, #GstBuffer
  27  *
  28  * A #GstElement is linked to other elements via "pads", which are extremely
  29  * light-weight generic link points.
  30  *
  31  * Pads have a #GstPadDirection, source pads produce data, sink pads consume
  32  * data.
  33  *
  34  * Pads are typically created from a #GstPadTemplate with
  35  * gst_pad_new_from_template() and are then added to a #GstElement. This usually
  36  * happens when the element is created but it can also happen dynamically based
  37  * on the data that the element is processing or based on the pads that the
  38  * application requests.
  39  *
  40  * Pads without pad templates can be created with gst_pad_new(),
  41  * which takes a direction and a name as an argument.  If the name is NULL,
  42  * then a guaranteed unique name will be assigned to it.
  43  *
  44  * A #GstElement creating a pad will typically use the various
  45  * gst_pad_set_*_function() calls to register callbacks for events, queries or
  46  * dataflow on the pads.
  47  *
  48  * gst_pad_get_parent() will retrieve the #GstElement that owns the pad.
  49  *
  50  * After two pads are retrieved from an element with gst_element_get_pad(),
  51  * the pads can be linked with gst_pad_link(). (For quick links,
  52  * you can also use gst_element_link(), which will make the obvious
  53  * link for you if it's straightforward.). Pads can be unlinked again with
  54  * gst_pad_unlink(). gst_pad_get_peer() can be used to check what the pad is
  55  * linked to.
  56  *
  57  * Before dataflow is possible on the pads, they need to be activated with
  58  * gst_pad_set_active().
  59  *
  60  * gst_pad_query() and gst_pad_peer_query() can be used to query various
  61  * properties of the pad and the stream.
  62  *
  63  * To send a #GstEvent on a pad, use gst_pad_send_event() and
  64  * gst_pad_push_event(). Some events will be sticky on the pad, meaning that
  65  * after they pass on the pad they can be queried later with
  66  * gst_pad_get_sticky_event() and gst_pad_sticky_events_foreach().
  67  * gst_pad_get_current_caps() and gst_pad_has_current_caps() are convenience
  68  * functions to query the current sticky CAPS event on a pad.
  69  *
  70  * GstElements will use gst_pad_push() and gst_pad_pull_range() to push out
  71  * or pull in a buffer.
  72  *
  73  * The dataflow, events and queries that happen on a pad can be monitored with
  74  * probes that can be installed with gst_pad_add_probe(). gst_pad_is_blocked()
  75  * can be used to check if a block probe is installed on the pad.
  76  * gst_pad_is_blocking() checks if the blocking probe is currently blocking the
  77  * pad. gst_pad_remove_probe() is used to remove a previously installed probe
  78  * and unblock blocking probes if any.
  79  *
  80  * Pad have an offset that can be retrieved with gst_pad_get_offset(). This
  81  * offset will be applied to the running_time of all data passing over the pad.
  82  * gst_pad_set_offset() can be used to change the offset.
  83  *
  84  * Convenience functions exist to start, pause and stop the task on a pad with
  85  * gst_pad_start_task(), gst_pad_pause_task() and gst_pad_stop_task()
  86  * respectively.
  87  *
  88  * Last reviewed on 2012-03-29 (0.11.3)
  89  */
  90
  91 #include "gst_private.h"
  92
  93 #include "gstpad.h"
  94 #include "gstpadtemplate.h"
  95 #include "gstenumtypes.h"
  96 #include "gstutils.h"
  97 #include "gstinfo.h"
  98 #include "gsterror.h"
  99 #include "gstvalue.h"
 100 #include "glib-compat-private.h"
 101
 102 GST_DEBUG_CATEGORY_STATIC (debug_dataflow);
 103 #define GST_CAT_DEFAULT GST_CAT_PADS
 104
 105 /* Pad signals and args */
 106 enum
 107 {
 108   PAD_LINKED,
 109   PAD_UNLINKED,
 110   /* FILL ME */
 111   LAST_SIGNAL
 112 };
 113
 114 enum
 115 {
 116   PAD_PROP_0,
 117   PAD_PROP_CAPS,
 118   PAD_PROP_DIRECTION,
 119   PAD_PROP_TEMPLATE,
 120   /* FILL ME */
 121 };
 122
 123 #define GST_PAD_GET_PRIVATE(obj)  \
 124    (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_PAD, GstPadPrivate))
 125
 126 /* we have a pending and an active event on the pad. On source pads only the
 127  * active event is used. On sinkpads, events are copied to the pending entry and
 128  * moved to the active event when the eventfunc returned TRUE. */
 129 typedef struct
 130 {
 131   gboolean received;
 132   GstEvent *event;
 133 } PadEvent;
 134
 135 struct _GstPadPrivate
 136 {
 137   guint events_cookie;
 138   GArray *events;
 139
 140   gint using;
 141   guint probe_list_cookie;
 142   guint probe_cookie;
 143 };
 144
 145 typedef struct
 146 {
 147   GHook hook;
 148   guint cookie;
 149 } GstProbe;
 150
 151 #define PROBE_COOKIE(h) (((GstProbe *)(h))->cookie)
 152
 153 typedef struct
 154 {
 155   GstPad *pad;
 156   GstPadProbeInfo *info;
 157   gboolean dropped;
 158   gboolean pass;
 159   gboolean marshalled;
 160   guint cookie;
 161 } ProbeMarshall;
 162
 163 static void gst_pad_dispose (GObject * object);
 164 static void gst_pad_finalize (GObject * object);
 165 static void gst_pad_set_property (GObject * object, guint prop_id,
 166     const GValue * value, GParamSpec * pspec);
 167 static void gst_pad_get_property (GObject * object, guint prop_id,
 168     GValue * value, GParamSpec * pspec);
 169
 170 static void gst_pad_set_pad_template (GstPad * pad, GstPadTemplate * templ);
 171 static gboolean gst_pad_activate_default (GstPad * pad, GstObject * parent);
 172 static GstFlowReturn gst_pad_chain_list_default (GstPad * pad,
 173     GstObject * parent, GstBufferList * list);
 174
 175 static GstFlowReturn gst_pad_send_event_unchecked (GstPad * pad,
 176     GstEvent * event, GstPadProbeType type);
 177 static GstFlowReturn gst_pad_push_event_unchecked (GstPad * pad,
 178     GstEvent * event, GstPadProbeType type);
 179
 180 static guint gst_pad_signals[LAST_SIGNAL] = { 0 };
 181
 182 static GParamSpec *pspec_caps = NULL;
 183
 184 /* quarks for probe signals */
 185 static GQuark buffer_quark;
 186 static GQuark buffer_list_quark;
 187 static GQuark event_quark;
 188
 189 typedef struct
 190 {
 191   const gint ret;
 192   const gchar *name;
 193   GQuark quark;
 194 } GstFlowQuarks;
 195
 196 static GstFlowQuarks flow_quarks[] = {
 197   {GST_FLOW_CUSTOM_SUCCESS, "custom-success", 0},
 198   {GST_FLOW_OK, "ok", 0},
 199   {GST_FLOW_NOT_LINKED, "not-linked", 0},
 200   {GST_FLOW_FLUSHING, "flushing", 0},
 201   {GST_FLOW_EOS, "eos", 0},
 202   {GST_FLOW_NOT_NEGOTIATED, "not-negotiated", 0},
 203   {GST_FLOW_ERROR, "error", 0},
 204   {GST_FLOW_NOT_SUPPORTED, "not-supported", 0},
 205   {GST_FLOW_CUSTOM_ERROR, "custom-error", 0}
 206 };
 207
 208 /**
 209  * gst_flow_get_name:
 210  * @ret: a #GstFlowReturn to get the name of.
 211  *
 212  * Gets a string representing the given flow return.
 213  *
 214  * Returns: a static string with the name of the flow return.
 215  */
 216 const gchar *
 217 gst_flow_get_name (GstFlowReturn ret)
 218 {
 219   gint i;
 220
 221   ret = CLAMP (ret, GST_FLOW_CUSTOM_ERROR, GST_FLOW_CUSTOM_SUCCESS);
 222
 223   for (i = 0; i < G_N_ELEMENTS (flow_quarks); i++) {
 224     if (ret == flow_quarks[i].ret)
 225       return flow_quarks[i].name;
 226   }
 227   return "unknown";
 228 }
 229
 230 /**
 231  * gst_flow_to_quark:
 232  * @ret: a #GstFlowReturn to get the quark of.
 233  *
 234  * Get the unique quark for the given GstFlowReturn.
 235  *
 236  * Returns: the quark associated with the flow return or 0 if an
 237  * invalid return was specified.
 238  */
 239 GQuark
 240 gst_flow_to_quark (GstFlowReturn ret)
 241 {
 242   gint i;
 243
 244   ret = CLAMP (ret, GST_FLOW_CUSTOM_ERROR, GST_FLOW_CUSTOM_SUCCESS);
 245
 246   for (i = 0; i < G_N_ELEMENTS (flow_quarks); i++) {
 247     if (ret == flow_quarks[i].ret)
 248       return flow_quarks[i].quark;
 249   }
 250   return 0;
 251 }
 252
 253 #define _do_init \
 254 { \
 255   gint i; \
 256   \
 257   buffer_quark = g_quark_from_static_string ("buffer"); \
 258   buffer_list_quark = g_quark_from_static_string ("bufferlist"); \
 259   event_quark = g_quark_from_static_string ("event"); \
 260   \
 261   for (i = 0; i < G_N_ELEMENTS (flow_quarks); i++) {                    \
 262     flow_quarks[i].quark = g_quark_from_static_string (flow_quarks[i].name); \
 263   } \
 264   \
 265   GST_DEBUG_CATEGORY_INIT (debug_dataflow, "GST_DATAFLOW", \
 266       GST_DEBUG_BOLD | GST_DEBUG_FG_GREEN, "dataflow inside pads"); \
 267 }
 268
 269 #define gst_pad_parent_class parent_class
 270 G_DEFINE_TYPE_WITH_CODE (GstPad, gst_pad, GST_TYPE_OBJECT, _do_init);
 271
 272 static void
 273 gst_pad_class_init (GstPadClass * klass)
 274 {
 275   GObjectClass *gobject_class;
 276   GstObjectClass *gstobject_class;
 277
 278   gobject_class = G_OBJECT_CLASS (klass);
 279   gstobject_class = GST_OBJECT_CLASS (klass);
 280
 281   g_type_class_add_private (klass, sizeof (GstPadPrivate));
 282
 283   gobject_class->dispose = gst_pad_dispose;
 284   gobject_class->finalize = gst_pad_finalize;
 285   gobject_class->set_property = gst_pad_set_property;
 286   gobject_class->get_property = gst_pad_get_property;
 287
 288   /**
 289    * GstPad::linked:
 290    * @pad: the pad that emitted the signal
 291    * @peer: the peer pad that has been connected
 292    *
 293    * Signals that a pad has been linked to the peer pad.
 294    */
 295   gst_pad_signals[PAD_LINKED] =
 296       g_signal_new ("linked", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
 297       G_STRUCT_OFFSET (GstPadClass, linked), NULL, NULL,
 298       g_cclosure_marshal_generic, G_TYPE_NONE, 1, GST_TYPE_PAD);
 299   /**
 300    * GstPad::unlinked:
 301    * @pad: the pad that emitted the signal
 302    * @peer: the peer pad that has been disconnected
 303    *
 304    * Signals that a pad has been unlinked from the peer pad.
 305    */
 306   gst_pad_signals[PAD_UNLINKED] =
 307       g_signal_new ("unlinked", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
 308       G_STRUCT_OFFSET (GstPadClass, unlinked), NULL, NULL,
 309       g_cclosure_marshal_generic, G_TYPE_NONE, 1, GST_TYPE_PAD);
 310
 311   pspec_caps = g_param_spec_boxed ("caps", "Caps",
 312       "The capabilities of the pad", GST_TYPE_CAPS,
 313       G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
 314   g_object_class_install_property (gobject_class, PAD_PROP_CAPS, pspec_caps);
 315
 316   g_object_class_install_property (gobject_class, PAD_PROP_DIRECTION,
 317       g_param_spec_enum ("direction", "Direction", "The direction of the pad",
 318           GST_TYPE_PAD_DIRECTION, GST_PAD_UNKNOWN,
 319           G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
 320
 321   /* FIXME, Make G_PARAM_CONSTRUCT_ONLY when we fix ghostpads. */
 322   g_object_class_install_property (gobject_class, PAD_PROP_TEMPLATE,
 323       g_param_spec_object ("template", "Template",
 324           "The GstPadTemplate of this pad", GST_TYPE_PAD_TEMPLATE,
 325           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 326
 327   gstobject_class->path_string_separator = ".";
 328
 329   /* Register common function pointer descriptions */
 330   GST_DEBUG_REGISTER_FUNCPTR (gst_pad_activate_default);
 331   GST_DEBUG_REGISTER_FUNCPTR (gst_pad_event_default);
 332   GST_DEBUG_REGISTER_FUNCPTR (gst_pad_query_default);
 333   GST_DEBUG_REGISTER_FUNCPTR (gst_pad_iterate_internal_links_default);
 334   GST_DEBUG_REGISTER_FUNCPTR (gst_pad_chain_list_default);
 335 }
 336
 337 static void
 338 gst_pad_init (GstPad * pad)
 339 {
 340   pad->priv = GST_PAD_GET_PRIVATE (pad);
 341
 342   GST_PAD_DIRECTION (pad) = GST_PAD_UNKNOWN;
 343
 344   GST_PAD_ACTIVATEFUNC (pad) = gst_pad_activate_default;
 345   GST_PAD_EVENTFUNC (pad) = gst_pad_event_default;
 346   GST_PAD_QUERYFUNC (pad) = gst_pad_query_default;
 347   GST_PAD_ITERINTLINKFUNC (pad) = gst_pad_iterate_internal_links_default;
 348   GST_PAD_CHAINLISTFUNC (pad) = gst_pad_chain_list_default;
 349
 350   GST_PAD_SET_FLUSHING (pad);
 351
 352   g_rec_mutex_init (&pad->stream_rec_lock);
 353
 354   g_cond_init (&pad->block_cond);
 355
 356   g_hook_list_init (&pad->probes, sizeof (GstProbe));
 357
 358   pad->priv->events = g_array_sized_new (FALSE, TRUE, sizeof (PadEvent), 16);
 359 }
 360
 361 /* called when setting the pad inactive. It removes all sticky events from
 362  * the pad */
 363 static void
 364 remove_events (GstPad * pad)
 365 {
 366   guint i, len;
 367   GArray *events;
 368
 369   events = pad->priv->events;
 370
 371   len = events->len;
 372   for (i = 0; i < len; i++) {
 373     PadEvent *ev = &g_array_index (events, PadEvent, i);
 374     gst_event_unref (ev->event);
 375   }
 376   GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PENDING_EVENTS);
 377   g_array_set_size (events, 0);
 378   pad->priv->events_cookie++;
 379 }
 380
 381 static PadEvent *
 382 find_event_by_type (GstPad * pad, GstEventType type, guint idx)
 383 {
 384   guint i, len;
 385   GArray *events;
 386   PadEvent *ev;
 387
 388   events = pad->priv->events;
 389   len = events->len;
 390
 391   for (i = 0; i < len; i++) {
 392     ev = &g_array_index (events, PadEvent, i);
 393     if (ev->event == NULL)
 394       continue;
 395
 396     if (GST_EVENT_TYPE (ev->event) == type) {
 397       if (idx == 0)
 398         goto found;
 399       idx--;
 400     }
 401   }
 402   ev = NULL;
 403 found:
 404   return ev;
 405 }
 406
 407 static PadEvent *
 408 find_event (GstPad * pad, GstEvent * event)
 409 {
 410   guint i, len;
 411   GArray *events;
 412   PadEvent *ev;
 413
 414   events = pad->priv->events;
 415   len = events->len;
 416
 417   for (i = 0; i < len; i++) {
 418     ev = &g_array_index (events, PadEvent, i);
 419     if (event == ev->event)
 420       goto found;
 421   }
 422   ev = NULL;
 423 found:
 424   return ev;
 425 }
 426
 427 static void
 428 remove_event_by_type (GstPad * pad, GstEventType type)
 429 {
 430   guint i, len;
 431   GArray *events;
 432   PadEvent *ev;
 433
 434   events = pad->priv->events;
 435   len = events->len;
 436
 437   i = 0;
 438   while (i < len) {
 439     ev = &g_array_index (events, PadEvent, i);
 440     if (ev->event == NULL)
 441       goto next;
 442
 443     if (GST_EVENT_TYPE (ev->event) != type)
 444       goto next;
 445
 446     gst_event_unref (ev->event);
 447     g_array_remove_index (events, i);
 448     len--;
 449     pad->priv->events_cookie++;
 450     continue;
 451
 452   next:
 453     i++;
 454   }
 455 }
 456
 457 /* check all events on srcpad against those on sinkpad. All events that are not
 458  * on sinkpad are marked as received=FALSE and the PENDING_EVENTS is set on the
 459  * srcpad so that the events will be sent next time */
 460 static void
 461 schedule_events (GstPad * srcpad, GstPad * sinkpad)
 462 {
 463   gint i, len;
 464   GArray *events;
 465   PadEvent *ev;
 466   gboolean pending = FALSE;
 467
 468   events = srcpad->priv->events;
 469   len = events->len;
 470
 471   for (i = 0; i < len; i++) {
 472     ev = &g_array_index (events, PadEvent, i);
 473     if (ev->event == NULL)
 474       continue;
 475
 476     if (sinkpad == NULL || !find_event (sinkpad, ev->event)) {
 477       ev->received = FALSE;
 478       pending = TRUE;
 479     }
 480   }
 481   if (pending)
 482     GST_OBJECT_FLAG_SET (srcpad, GST_PAD_FLAG_PENDING_EVENTS);
 483 }
 484
 485 typedef gboolean (*PadEventFunction) (GstPad * pad, PadEvent * ev,
 486     gpointer user_data);
 487
 488 /* should be called with pad LOCK */
 489 static void
 490 events_foreach (GstPad * pad, PadEventFunction func, gpointer user_data)
 491 {
 492   guint i, len;
 493   GArray *events;
 494   gboolean ret;
 495   guint cookie;
 496
 497   events = pad->priv->events;
 498
 499 restart:
 500   cookie = pad->priv->events_cookie;
 501   i = 0;
 502   len = events->len;
 503   while (i < len) {
 504     PadEvent *ev, ev_ret;
 505
 506     ev = &g_array_index (events, PadEvent, i);
 507     if (G_UNLIKELY (ev->event == NULL))
 508       goto next;
 509
 510     /* take aditional ref, func might release the lock */
 511     ev_ret.event = gst_event_ref (ev->event);
 512     ev_ret.received = ev->received;
 513
 514     ret = func (pad, &ev_ret, user_data);
 515
 516     /* recheck the cookie, lock might have been released and the list could have
 517      * changed */
 518     if (G_UNLIKELY (cookie != pad->priv->events_cookie)) {
 519       if (G_LIKELY (ev_ret.event))
 520         gst_event_unref (ev_ret.event);
 521       goto restart;
 522     }
 523
 524     /* store the received state */
 525     ev->received = ev_ret.received;
 526
 527     /* if the event changed, we need to do something */
 528     if (G_UNLIKELY (ev->event != ev_ret.event)) {
 529       if (G_UNLIKELY (ev_ret.event == NULL)) {
 530         /* function unreffed and set the event to NULL, remove it */
 531         g_array_remove_index (events, i);
 532         len--;
 533         cookie = ++pad->priv->events_cookie;
 534         continue;
 535       } else {
 536         /* function gave a new event for us */
 537         gst_event_take (&ev->event, ev_ret.event);
 538       }
 539     } else {
 540       /* just unref, nothing changed */
 541       gst_event_unref (ev_ret.event);
 542     }
 543     if (!ret)
 544       break;
 545   next:
 546     i++;
 547   }
 548 }
 549
 550 /* should be called with LOCK */
 551 static GstEvent *
 552 apply_pad_offset (GstPad * pad, GstEvent * event)
 553 {
 554   /* check if we need to adjust the segment */
 555   if (pad->offset != 0) {
 556     GstSegment segment;
 557
 558     /* copy segment values */
 559     gst_event_copy_segment (event, &segment);
 560     gst_event_unref (event);
 561
 562     /* adjust and make a new event with the offset applied */
 563     segment.base += pad->offset;
 564     event = gst_event_new_segment (&segment);
 565   }
 566   return event;
 567 }
 568
 569 /* should be called with the OBJECT_LOCK */
 570 static GstCaps *
 571 get_pad_caps (GstPad * pad)
 572 {
 573   GstCaps *caps = NULL;
 574   PadEvent *ev;
 575
 576   ev = find_event_by_type (pad, GST_EVENT_CAPS, 0);
 577   if (ev && ev->event)
 578     gst_event_parse_caps (ev->event, &caps);
 579
 580   return caps;
 581 }
 582
 583 static void
 584 gst_pad_dispose (GObject * object)
 585 {
 586   GstPad *pad = GST_PAD_CAST (object);
 587   GstPad *peer;
 588
 589   GST_CAT_DEBUG_OBJECT (GST_CAT_REFCOUNTING, pad, "dispose");
 590
 591   /* unlink the peer pad */
 592   if ((peer = gst_pad_get_peer (pad))) {
 593     /* window for MT unsafeness, someone else could unlink here
 594      * and then we call unlink with wrong pads. The unlink
 595      * function would catch this and safely return failed. */
 596     if (GST_PAD_IS_SRC (pad))
 597       gst_pad_unlink (pad, peer);
 598     else
 599       gst_pad_unlink (peer, pad);
 600
 601     gst_object_unref (peer);
 602   }
 603
 604   gst_pad_set_pad_template (pad, NULL);
 605
 606   remove_events (pad);
 607
 608   g_hook_list_clear (&pad->probes);
 609
 610   G_OBJECT_CLASS (parent_class)->dispose (object);
 611 }
 612
 613 static void
 614 gst_pad_finalize (GObject * object)
 615 {
 616   GstPad *pad = GST_PAD_CAST (object);
 617   GstTask *task;
 618
 619   /* in case the task is still around, clean it up */
 620   if ((task = GST_PAD_TASK (pad))) {
 621     gst_task_join (task);
 622     GST_PAD_TASK (pad) = NULL;
 623     gst_object_unref (task);
 624   }
 625
 626   if (pad->activatenotify)
 627     pad->activatenotify (pad->activatedata);
 628   if (pad->activatemodenotify)
 629     pad->activatemodenotify (pad->activatemodedata);
 630   if (pad->linknotify)
 631     pad->linknotify (pad->linkdata);
 632   if (pad->unlinknotify)
 633     pad->unlinknotify (pad->unlinkdata);
 634   if (pad->chainnotify)
 635     pad->chainnotify (pad->chaindata);
 636   if (pad->chainlistnotify)
 637     pad->chainlistnotify (pad->chainlistdata);
 638   if (pad->getrangenotify)
 639     pad->getrangenotify (pad->getrangedata);
 640   if (pad->eventnotify)
 641     pad->eventnotify (pad->eventdata);
 642   if (pad->querynotify)
 643     pad->querynotify (pad->querydata);
 644   if (pad->iterintlinknotify)
 645     pad->iterintlinknotify (pad->iterintlinkdata);
 646
 647   g_rec_mutex_clear (&pad->stream_rec_lock);
 648   g_cond_clear (&pad->block_cond);
 649   g_array_free (pad->priv->events, TRUE);
 650
 651   G_OBJECT_CLASS (parent_class)->finalize (object);
 652 }
 653
 654 static void
 655 gst_pad_set_property (GObject * object, guint prop_id,
 656     const GValue * value, GParamSpec * pspec)
 657 {
 658   g_return_if_fail (GST_IS_PAD (object));
 659
 660   switch (prop_id) {
 661     case PAD_PROP_DIRECTION:
 662       GST_PAD_DIRECTION (object) = (GstPadDirection) g_value_get_enum (value);
 663       break;
 664     case PAD_PROP_TEMPLATE:
 665       gst_pad_set_pad_template (GST_PAD_CAST (object),
 666           (GstPadTemplate *) g_value_get_object (value));
 667       break;
 668     default:
 669       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 670       break;
 671   }
 672 }
 673
 674 static void
 675 gst_pad_get_property (GObject * object, guint prop_id,
 676     GValue * value, GParamSpec * pspec)
 677 {
 678   g_return_if_fail (GST_IS_PAD (object));
 679
 680   switch (prop_id) {
 681     case PAD_PROP_CAPS:
 682       GST_OBJECT_LOCK (object);
 683       g_value_set_boxed (value, get_pad_caps (GST_PAD_CAST (object)));
 684       GST_OBJECT_UNLOCK (object);
 685       break;
 686     case PAD_PROP_DIRECTION:
 687       g_value_set_enum (value, GST_PAD_DIRECTION (object));
 688       break;
 689     case PAD_PROP_TEMPLATE:
 690       g_value_set_object (value, GST_PAD_PAD_TEMPLATE (object));
 691       break;
 692     default:
 693       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 694       break;
 695   }
 696 }
 697
 698 /**
 699  * gst_pad_new:
 700  * @name: the name of the new pad.
 701  * @direction: the #GstPadDirection of the pad.
 702  *
 703  * Creates a new pad with the given name in the given direction.
 704  * If name is NULL, a guaranteed unique name (across all pads)
 705  * will be assigned.
 706  * This function makes a copy of the name so you can safely free the name.
 707  *
 708  * Returns: (transfer floating): a new #GstPad, or NULL in case of an error.
 709  *
 710  * MT safe.
 711  */
 712 GstPad *
 713 gst_pad_new (const gchar * name, GstPadDirection direction)
 714 {
 715   return g_object_new (GST_TYPE_PAD,
 716       "name", name, "direction", direction, NULL);
 717 }
 718
 719 /**
 720  * gst_pad_new_from_template:
 721  * @templ: the pad template to use
 722  * @name: the name of the element
 723  *
 724  * Creates a new pad with the given name from the given template.
 725  * If name is NULL, a guaranteed unique name (across all pads)
 726  * will be assigned.
 727  * This function makes a copy of the name so you can safely free the name.
 728  *
 729  * Returns: (transfer full): a new #GstPad, or NULL in case of an error.
 730  */
 731 GstPad *
 732 gst_pad_new_from_template (GstPadTemplate * templ, const gchar * name)
 733 {
 734   g_return_val_if_fail (GST_IS_PAD_TEMPLATE (templ), NULL);
 735
 736   return g_object_new (GST_TYPE_PAD,
 737       "name", name, "direction", templ->direction, "template", templ, NULL);
 738 }
 739
 740 /**
 741  * gst_pad_new_from_static_template:
 742  * @templ: the #GstStaticPadTemplate to use
 743  * @name: the name of the element
 744  *
 745  * Creates a new pad with the given name from the given static template.
 746  * If name is NULL, a guaranteed unique name (across all pads)
 747  * will be assigned.
 748  * This function makes a copy of the name so you can safely free the name.
 749  *
 750  * Returns: (transfer full): a new #GstPad, or NULL in case of an error.
 751  */
 752 GstPad *
 753 gst_pad_new_from_static_template (GstStaticPadTemplate * templ,
 754     const gchar * name)
 755 {
 756   GstPad *pad;
 757   GstPadTemplate *template;
 758
 759   template = gst_static_pad_template_get (templ);
 760   pad = gst_pad_new_from_template (template, name);
 761   gst_object_unref (template);
 762   return pad;
 763 }
 764
 765 #define ACQUIRE_PARENT(pad, parent, label)                      \
 766   G_STMT_START {                                                \
 767     if (G_LIKELY ((parent = GST_OBJECT_PARENT (pad))))          \
 768       gst_object_ref (parent);                                  \
 769     else if (G_LIKELY (GST_PAD_NEEDS_PARENT (pad)))             \
 770       goto label;                                               \
 771   } G_STMT_END
 772
 773 #define RELEASE_PARENT(parent)                                  \
 774   G_STMT_START {                                                \
 775     if (G_LIKELY (parent))                                      \
 776       gst_object_unref (parent);                                \
 777   } G_STMT_END
 778
 779 /**
 780  * gst_pad_get_direction:
 781  * @pad: a #GstPad to get the direction of.
 782  *
 783  * Gets the direction of the pad. The direction of the pad is
 784  * decided at construction time so this function does not take
 785  * the LOCK.
 786  *
 787  * Returns: the #GstPadDirection of the pad.
 788  *
 789  * MT safe.
 790  */
 791 GstPadDirection
 792 gst_pad_get_direction (GstPad * pad)
 793 {
 794   GstPadDirection result;
 795
 796   /* PAD_UNKNOWN is a little silly but we need some sort of
 797    * error return value */
 798   g_return_val_if_fail (GST_IS_PAD (pad), GST_PAD_UNKNOWN);
 799
 800   result = GST_PAD_DIRECTION (pad);
 801
 802   return result;
 803 }
 804
 805 static gboolean
 806 gst_pad_activate_default (GstPad * pad, GstObject * parent)
 807 {
 808   return gst_pad_activate_mode (pad, GST_PAD_MODE_PUSH, TRUE);
 809 }
 810
 811 static void
 812 pre_activate (GstPad * pad, GstPadMode new_mode)
 813 {
 814   switch (new_mode) {
 815     case GST_PAD_MODE_NONE:
 816       GST_OBJECT_LOCK (pad);
 817       GST_DEBUG_OBJECT (pad, "setting PAD_MODE NONE, set flushing");
 818       GST_PAD_SET_FLUSHING (pad);
 819       GST_PAD_MODE (pad) = new_mode;
 820       /* unlock blocked pads so element can resume and stop */
 821       GST_PAD_BLOCK_BROADCAST (pad);
 822       GST_OBJECT_UNLOCK (pad);
 823       break;
 824     case GST_PAD_MODE_PUSH:
 825     case GST_PAD_MODE_PULL:
 826       GST_OBJECT_LOCK (pad);
 827       GST_DEBUG_OBJECT (pad, "setting PAD_MODE %d, unset flushing", new_mode);
 828       GST_PAD_UNSET_FLUSHING (pad);
 829       GST_PAD_MODE (pad) = new_mode;
 830       if (GST_PAD_IS_SINK (pad)) {
 831         GstPad *peer;
 832         /* make sure the peer src pad sends us all events */
 833         if ((peer = GST_PAD_PEER (pad))) {
 834           gst_object_ref (peer);
 835           GST_OBJECT_UNLOCK (pad);
 836
 837           GST_DEBUG_OBJECT (pad, "reschedule events on peer %s:%s",
 838               GST_DEBUG_PAD_NAME (peer));
 839
 840           GST_OBJECT_LOCK (peer);
 841           schedule_events (peer, NULL);
 842           GST_OBJECT_UNLOCK (peer);
 843
 844           gst_object_unref (peer);
 845         } else {
 846           GST_OBJECT_UNLOCK (pad);
 847         }
 848       } else {
 849         GST_OBJECT_UNLOCK (pad);
 850       }
 851       break;
 852   }
 853 }
 854
 855 static void
 856 post_activate (GstPad * pad, GstPadMode new_mode)
 857 {
 858   switch (new_mode) {
 859     case GST_PAD_MODE_NONE:
 860       /* ensures that streaming stops */
 861       GST_PAD_STREAM_LOCK (pad);
 862       GST_DEBUG_OBJECT (pad, "stopped streaming");
 863       GST_OBJECT_LOCK (pad);
 864       remove_events (pad);
 865       GST_OBJECT_UNLOCK (pad);
 866       GST_PAD_STREAM_UNLOCK (pad);
 867       break;
 868     case GST_PAD_MODE_PUSH:
 869     case GST_PAD_MODE_PULL:
 870       /* NOP */
 871       break;
 872   }
 873 }
 874
 875 /**
 876  * gst_pad_set_active:
 877  * @pad: the #GstPad to activate or deactivate.
 878  * @active: whether or not the pad should be active.
 879  *
 880  * Activates or deactivates the given pad.
 881  * Normally called from within core state change functions.
 882  *
 883  * If @active, makes sure the pad is active. If it is already active, either in
 884  * push or pull mode, just return. Otherwise dispatches to the pad's activate
 885  * function to perform the actual activation.
 886  *
 887  * If not @active, checks the pad's current mode and calls
 888  * gst_pad_activate_push() or gst_pad_activate_pull(), as appropriate, with a
 889  * FALSE argument.
 890  *
 891  * Returns: #TRUE if the operation was successful.
 892  *
 893  * MT safe.
 894  */
 895 gboolean
 896 gst_pad_set_active (GstPad * pad, gboolean active)
 897 {
 898   GstObject *parent;
 899   GstPadMode old;
 900   gboolean ret = FALSE;
 901
 902   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
 903
 904   GST_OBJECT_LOCK (pad);
 905   old = GST_PAD_MODE (pad);
 906   ACQUIRE_PARENT (pad, parent, no_parent);
 907   GST_OBJECT_UNLOCK (pad);
 908
 909   if (active) {
 910     if (old == GST_PAD_MODE_NONE) {
 911       GST_DEBUG_OBJECT (pad, "activating pad from none");
 912       ret = (GST_PAD_ACTIVATEFUNC (pad)) (pad, parent);
 913     } else {
 914       GST_DEBUG_OBJECT (pad, "pad was active in mode %d", old);
 915       ret = TRUE;
 916     }
 917   } else {
 918     if (old == GST_PAD_MODE_NONE) {
 919       GST_DEBUG_OBJECT (pad, "pad was inactive");
 920       ret = TRUE;
 921     } else {
 922       GST_DEBUG_OBJECT (pad, "deactivating pad from mode %d", old);
 923       ret = gst_pad_activate_mode (pad, old, FALSE);
 924     }
 925   }
 926
 927   RELEASE_PARENT (parent);
 928
 929   if (G_UNLIKELY (!ret))
 930     goto failed;
 931
 932   if (!active) {
 933     GST_OBJECT_LOCK (pad);
 934     GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
 935     GST_OBJECT_UNLOCK (pad);
 936   }
 937   return ret;
 938
 939   /* ERRORS */
 940 no_parent:
 941   {
 942     GST_DEBUG_OBJECT (pad, "no parent");
 943     GST_OBJECT_UNLOCK (pad);
 944     return FALSE;
 945   }
 946 failed:
 947   {
 948     GST_OBJECT_LOCK (pad);
 949     if (!active) {
 950       g_critical ("Failed to deactivate pad %s:%s, very bad",
 951           GST_DEBUG_PAD_NAME (pad));
 952     } else {
 953       GST_WARNING_OBJECT (pad, "Failed to activate pad");
 954     }
 955     GST_OBJECT_UNLOCK (pad);
 956     return FALSE;
 957   }
 958 }
 959
 960 /**
 961  * gst_pad_activate_mode:
 962  * @pad: the #GstPad to activate or deactivate.
 963  * @mode: the requested activation mode
 964  * @active: whether or not the pad should be active.
 965  *
 966  * Activates or deactivates the given pad in @mode via dispatching to the
 967  * pad's activatemodefunc. For use from within pad activation functions only.
 968  *
 969  * If you don't know what this is, you probably don't want to call it.
 970  *
 971  * Returns: TRUE if the operation was successful.
 972  *
 973  * MT safe.
 974  */
 975 gboolean
 976 gst_pad_activate_mode (GstPad * pad, GstPadMode mode, gboolean active)
 977 {
 978   gboolean res = FALSE;
 979   GstObject *parent;
 980   GstPadMode old, new;
 981   GstPadDirection dir;
 982   GstPad *peer;
 983
 984   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
 985
 986   GST_OBJECT_LOCK (pad);
 987   old = GST_PAD_MODE (pad);
 988   dir = GST_PAD_DIRECTION (pad);
 989   ACQUIRE_PARENT (pad, parent, no_parent);
 990   GST_OBJECT_UNLOCK (pad);
 991
 992   new = active ? mode : GST_PAD_MODE_NONE;
 993
 994   if (old == new)
 995     goto was_ok;
 996
 997   if (active && old != mode) {
 998     /* pad was activate in the wrong direction, deactivate it
 999      * and reactivate it in the requested mode */
1000     GST_DEBUG_OBJECT (pad, "deactivating pad from mode %d", old);
1001     if (G_UNLIKELY (!gst_pad_activate_mode (pad, old, FALSE)))
1002       goto deactivate_failed;
1003   }
1004
1005   switch (mode) {
1006     case GST_PAD_MODE_PULL:
1007     {
1008       if (dir == GST_PAD_SINK) {
1009         if ((peer = gst_pad_get_peer (pad))) {
1010           GST_DEBUG_OBJECT (pad, "calling peer");
1011           if (G_UNLIKELY (!gst_pad_activate_mode (peer, mode, active)))
1012             goto peer_failed;
1013           gst_object_unref (peer);
1014         } else {
1015           /* there is no peer, this is only fatal when we activate. When we
1016            * deactivate, we must assume the application has unlinked the peer and
1017            * will deactivate it eventually. */
1018           if (active)
1019             goto not_linked;
1020           else
1021             GST_DEBUG_OBJECT (pad, "deactivating unlinked pad");
1022         }
1023       } else {
1024         if (G_UNLIKELY (GST_PAD_GETRANGEFUNC (pad) == NULL))
1025           goto failure;         /* Can't activate pull on a src without a
1026                                    getrange function */
1027       }
1028       break;
1029     }
1030     default:
1031       break;
1032   }
1033
1034   pre_activate (pad, new);
1035
1036   if (GST_PAD_ACTIVATEMODEFUNC (pad)) {
1037     if (G_UNLIKELY (!GST_PAD_ACTIVATEMODEFUNC (pad) (pad, parent, mode,
1038                 active)))
1039       goto failure;
1040   } else {
1041     /* can happen for sinks of passthrough elements */
1042   }
1043
1044   post_activate (pad, new);
1045
1046   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "%s in mode %d",
1047       active ? "activated" : "deactivated", mode);
1048
1049 exit_success:
1050   res = TRUE;
1051 exit:
1052   RELEASE_PARENT (parent);
1053
1054   return res;
1055
1056 no_parent:
1057   {
1058     GST_DEBUG_OBJECT (pad, "no parent");
1059     GST_OBJECT_UNLOCK (pad);
1060     return FALSE;
1061   }
1062 was_ok:
1063   {
1064     GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "already %s in mode %d",
1065         active ? "activated" : "deactivated", mode);
1066     goto exit_success;
1067   }
1068 deactivate_failed:
1069   {
1070     GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
1071         "failed to %s in switch to mode %d from mode %d",
1072         (active ? "activate" : "deactivate"), mode, old);
1073     goto exit;
1074   }
1075 peer_failed:
1076   {
1077     GST_OBJECT_LOCK (peer);
1078     GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
1079         "activate_mode on peer (%s:%s) failed", GST_DEBUG_PAD_NAME (peer));
1080     GST_OBJECT_UNLOCK (peer);
1081     gst_object_unref (peer);
1082     goto exit;
1083   }
1084 not_linked:
1085   {
1086     GST_CAT_INFO_OBJECT (GST_CAT_PADS, pad, "can't activate unlinked sink "
1087         "pad in pull mode");
1088     goto exit;
1089   }
1090 failure:
1091   {
1092     GST_OBJECT_LOCK (pad);
1093     GST_CAT_INFO_OBJECT (GST_CAT_PADS, pad, "failed to %s in mode %d",
1094         active ? "activate" : "deactivate", mode);
1095     GST_PAD_SET_FLUSHING (pad);
1096     GST_PAD_MODE (pad) = old;
1097     GST_OBJECT_UNLOCK (pad);
1098     goto exit;
1099   }
1100 }
1101
1102 /**
1103  * gst_pad_is_active:
1104  * @pad: the #GstPad to query
1105  *
1106  * Query if a pad is active
1107  *
1108  * Returns: TRUE if the pad is active.
1109  *
1110  * MT safe.
1111  */
1112 gboolean
1113 gst_pad_is_active (GstPad * pad)
1114 {
1115   gboolean result = FALSE;
1116
1117   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1118
1119   GST_OBJECT_LOCK (pad);
1120   result = GST_PAD_IS_ACTIVE (pad);
1121   GST_OBJECT_UNLOCK (pad);
1122
1123   return result;
1124 }
1125
1126 /**
1127  * gst_pad_add_probe:
1128  * @pad: the #GstPad to add the probe to
1129  * @mask: the probe mask
1130  * @callback: #GstPadProbeCallback that will be called with notifications of
1131  *           the pad state
1132  * @user_data: (closure): user data passed to the callback
1133  * @destroy_data: #GDestroyNotify for user_data
1134  *
1135  * Be notified of different states of pads. The provided callback is called for
1136  * every state that matches @mask.
1137  *
1138  * Returns: an id or 0 on error. The id can be used to remove the probe with
1139  * gst_pad_remove_probe().
1140  *
1141  * MT safe.
1142  */
1143 gulong
1144 gst_pad_add_probe (GstPad * pad, GstPadProbeType mask,
1145     GstPadProbeCallback callback, gpointer user_data,
1146     GDestroyNotify destroy_data)
1147 {
1148   GHook *hook;
1149   gulong res;
1150
1151   g_return_val_if_fail (GST_IS_PAD (pad), 0);
1152   g_return_val_if_fail (mask != 0, 0);
1153
1154   GST_OBJECT_LOCK (pad);
1155
1156   /* make a new probe */
1157   hook = g_hook_alloc (&pad->probes);
1158
1159   GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "adding probe for mask 0x%08x",
1160       mask);
1161
1162   /* when no contraints are given for the types, assume all types are
1163    * acceptable */
1164   if ((mask & GST_PAD_PROBE_TYPE_ALL_BOTH) == 0)
1165     mask |= GST_PAD_PROBE_TYPE_ALL_BOTH;
1166   if ((mask & GST_PAD_PROBE_TYPE_SCHEDULING) == 0)
1167     mask |= GST_PAD_PROBE_TYPE_SCHEDULING;
1168
1169   /* store our flags and other fields */
1170   hook->flags |= (mask << G_HOOK_FLAG_USER_SHIFT);
1171   hook->func = callback;
1172   hook->data = user_data;
1173   hook->destroy = destroy_data;
1174   PROBE_COOKIE (hook) = (pad->priv->probe_cookie - 1);
1175
1176   /* add the probe */
1177   g_hook_prepend (&pad->probes, hook);
1178   pad->num_probes++;
1179   /* incremenent cookie so that the new hook get's called */
1180   pad->priv->probe_list_cookie++;
1181
1182   /* get the id of the hook, we return this and it can be used to remove the
1183    * probe later */
1184   res = hook->hook_id;
1185
1186   GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "got probe id %lu", res);
1187
1188   if (mask & GST_PAD_PROBE_TYPE_BLOCKING) {
1189     /* we have a block probe */
1190     pad->num_blocked++;
1191     GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_BLOCKED);
1192     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "added blocking probe, "
1193         "now %d blocking probes", pad->num_blocked);
1194   }
1195
1196   /* call the callback if we need to be called for idle callbacks */
1197   if ((mask & GST_PAD_PROBE_TYPE_IDLE) && (callback != NULL)) {
1198     if (pad->priv->using > 0) {
1199       /* the pad is in use, we can't signal the idle callback yet. Since we set the
1200        * flag above, the last thread to leave the push will do the callback. New
1201        * threads going into the push will block. */
1202       GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
1203           "pad is in use, delay idle callback");
1204       GST_OBJECT_UNLOCK (pad);
1205     } else {
1206       GstPadProbeInfo info = { GST_PAD_PROBE_TYPE_IDLE, res, };
1207
1208       /* the pad is idle now, we can signal the idle callback now */
1209       GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
1210           "pad is idle, trigger idle callback");
1211       GST_OBJECT_UNLOCK (pad);
1212
1213       callback (pad, &info, user_data);
1214     }
1215   } else {
1216     GST_OBJECT_UNLOCK (pad);
1217   }
1218   return res;
1219 }
1220
1221 static void
1222 cleanup_hook (GstPad * pad, GHook * hook)
1223 {
1224   GstPadProbeType type;
1225
1226   type = (hook->flags) >> G_HOOK_FLAG_USER_SHIFT;
1227
1228   if (type & GST_PAD_PROBE_TYPE_BLOCKING) {
1229     /* unblock when we remove the last blocking probe */
1230     pad->num_blocked--;
1231     GST_DEBUG_OBJECT (pad, "remove blocking probe, now %d left",
1232         pad->num_blocked);
1233     if (pad->num_blocked == 0) {
1234       GST_DEBUG_OBJECT (pad, "last blocking probe removed, unblocking");
1235       GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_BLOCKED);
1236       GST_PAD_BLOCK_BROADCAST (pad);
1237     }
1238   }
1239   g_hook_destroy_link (&pad->probes, hook);
1240   pad->num_probes--;
1241 }
1242
1243 /**
1244  * gst_pad_remove_probe:
1245  * @pad: the #GstPad with the probe
1246  * @id: the probe id to remove
1247  *
1248  * Remove the probe with @id from @pad.
1249  *
1250  * MT safe.
1251  */
1252 void
1253 gst_pad_remove_probe (GstPad * pad, gulong id)
1254 {
1255   GHook *hook;
1256
1257   g_return_if_fail (GST_IS_PAD (pad));
1258
1259   GST_OBJECT_LOCK (pad);
1260
1261   hook = g_hook_get (&pad->probes, id);
1262   if (hook == NULL)
1263     goto not_found;
1264
1265   GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "removing hook %ld",
1266       hook->hook_id);
1267   cleanup_hook (pad, hook);
1268   GST_OBJECT_UNLOCK (pad);
1269
1270   return;
1271
1272 not_found:
1273   {
1274     GST_OBJECT_UNLOCK (pad);
1275     g_warning ("%s: pad `%p' has no probe with id `%lu'", G_STRLOC, pad, id);
1276     return;
1277   }
1278 }
1279
1280 /**
1281  * gst_pad_is_blocked:
1282  * @pad: the #GstPad to query
1283  *
1284  * Checks if the pad is blocked or not. This function returns the
1285  * last requested state of the pad. It is not certain that the pad
1286  * is actually blocking at this point (see gst_pad_is_blocking()).
1287  *
1288  * Returns: TRUE if the pad is blocked.
1289  *
1290  * MT safe.
1291  */
1292 gboolean
1293 gst_pad_is_blocked (GstPad * pad)
1294 {
1295   gboolean result = FALSE;
1296
1297   g_return_val_if_fail (GST_IS_PAD (pad), result);
1298
1299   GST_OBJECT_LOCK (pad);
1300   result = GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_BLOCKED);
1301   GST_OBJECT_UNLOCK (pad);
1302
1303   return result;
1304 }
1305
1306 /**
1307  * gst_pad_is_blocking:
1308  * @pad: the #GstPad to query
1309  *
1310  * Checks if the pad is blocking or not. This is a guaranteed state
1311  * of whether the pad is actually blocking on a #GstBuffer or a #GstEvent.
1312  *
1313  * Returns: TRUE if the pad is blocking.
1314  *
1315  * MT safe.
1316  *
1317  * Since: 0.10.11
1318  */
1319 gboolean
1320 gst_pad_is_blocking (GstPad * pad)
1321 {
1322   gboolean result = FALSE;
1323
1324   g_return_val_if_fail (GST_IS_PAD (pad), result);
1325
1326   GST_OBJECT_LOCK (pad);
1327   /* the blocking flag is only valid if the pad is not flushing */
1328   result = GST_PAD_IS_BLOCKING (pad) && !GST_PAD_IS_FLUSHING (pad);
1329   GST_OBJECT_UNLOCK (pad);
1330
1331   return result;
1332 }
1333
1334 /**
1335  * gst_pad_check_reconfigure:
1336  * @pad: the #GstPad to check
1337  *
1338  * Check and clear the #GST_PAD_FLAG_NEED_RECONFIGURE flag on @pad and return %TRUE
1339  * if the flag was set.
1340  *
1341  * Returns: %TRUE is the GST_PAD_FLAG_NEED_RECONFIGURE flag was set on @pad.
1342  */
1343 gboolean
1344 gst_pad_check_reconfigure (GstPad * pad)
1345 {
1346   gboolean reconfigure;
1347
1348   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1349
1350   GST_OBJECT_LOCK (pad);
1351   reconfigure = GST_PAD_NEEDS_RECONFIGURE (pad);
1352   if (reconfigure)
1353     GST_DEBUG_OBJECT (pad, "remove RECONFIGURE flag");
1354   GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
1355   GST_OBJECT_UNLOCK (pad);
1356
1357   return reconfigure;
1358 }
1359
1360 /**
1361  * gst_pad_mark_reconfigure:
1362  * @pad: the #GstPad to mark
1363  *
1364  * Mark a pad for needing reconfiguration. The next call to
1365  * gst_pad_check_reconfigure() will return %TRUE after this call.
1366  */
1367 void
1368 gst_pad_mark_reconfigure (GstPad * pad)
1369 {
1370   g_return_if_fail (GST_IS_PAD (pad));
1371
1372   GST_OBJECT_LOCK (pad);
1373   GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
1374   GST_OBJECT_UNLOCK (pad);
1375 }
1376
1377 /**
1378  * gst_pad_set_activate_function_full:
1379  * @pad: a #GstPad.
1380  * @activate: the #GstPadActivateFunction to set.
1381  * @user_data: user_data passed to @notify
1382  * @notify: notify called when @activate will not be used anymore.
1383  *
1384  * Sets the given activate function for @pad. The activate function will
1385  * dispatch to gst_pad_activate_push() or gst_pad_activate_pull() to perform
1386  * the actual activation. Only makes sense to set on sink pads.
1387  *
1388  * Call this function if your sink pad can start a pull-based task.
1389  */
1390 void
1391 gst_pad_set_activate_function_full (GstPad * pad,
1392     GstPadActivateFunction activate, gpointer user_data, GDestroyNotify notify)
1393 {
1394   g_return_if_fail (GST_IS_PAD (pad));
1395
1396   if (pad->activatenotify)
1397     pad->activatenotify (pad->activatedata);
1398   GST_PAD_ACTIVATEFUNC (pad) = activate;
1399   pad->activatedata = user_data;
1400   pad->activatenotify = notify;
1401
1402   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "activatefunc set to %s",
1403       GST_DEBUG_FUNCPTR_NAME (activate));
1404 }
1405
1406 /**
1407  * gst_pad_set_activatemode_function_full:
1408  * @pad: a #GstPad.
1409  * @activatemode: the #GstPadActivateModeFunction to set.
1410  * @user_data: user_data passed to @notify
1411  * @notify: notify called when @activatemode will not be used anymore.
1412  *
1413  * Sets the given activate_mode function for the pad. An activate_mode function
1414  * prepares the element for data passing.
1415  */
1416 void
1417 gst_pad_set_activatemode_function_full (GstPad * pad,
1418     GstPadActivateModeFunction activatemode, gpointer user_data,
1419     GDestroyNotify notify)
1420 {
1421   g_return_if_fail (GST_IS_PAD (pad));
1422
1423   if (pad->activatemodenotify)
1424     pad->activatemodenotify (pad->activatemodedata);
1425   GST_PAD_ACTIVATEMODEFUNC (pad) = activatemode;
1426   pad->activatemodedata = user_data;
1427   pad->activatemodenotify = notify;
1428
1429   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "activatemodefunc set to %s",
1430       GST_DEBUG_FUNCPTR_NAME (activatemode));
1431 }
1432
1433 /**
1434  * gst_pad_set_chain_function_full:
1435  * @pad: a sink #GstPad.
1436  * @chain: the #GstPadChainFunction to set.
1437  * @user_data: user_data passed to @notify
1438  * @notify: notify called when @chain will not be used anymore.
1439  *
1440  * Sets the given chain function for the pad. The chain function is called to
1441  * process a #GstBuffer input buffer. see #GstPadChainFunction for more details.
1442  */
1443 void
1444 gst_pad_set_chain_function_full (GstPad * pad, GstPadChainFunction chain,
1445     gpointer user_data, GDestroyNotify notify)
1446 {
1447   g_return_if_fail (GST_IS_PAD (pad));
1448   g_return_if_fail (GST_PAD_IS_SINK (pad));
1449
1450   if (pad->chainnotify)
1451     pad->chainnotify (pad->chaindata);
1452   GST_PAD_CHAINFUNC (pad) = chain;
1453   pad->chaindata = user_data;
1454   pad->chainnotify = notify;
1455
1456   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "chainfunc set to %s",
1457       GST_DEBUG_FUNCPTR_NAME (chain));
1458 }
1459
1460 /**
1461  * gst_pad_set_chain_list_function_full:
1462  * @pad: a sink #GstPad.
1463  * @chainlist: the #GstPadChainListFunction to set.
1464  * @user_data: user_data passed to @notify
1465  * @notify: notify called when @chainlist will not be used anymore.
1466  *
1467  * Sets the given chain list function for the pad. The chainlist function is
1468  * called to process a #GstBufferList input buffer list. See
1469  * #GstPadChainListFunction for more details.
1470  *
1471  * Since: 0.10.24
1472  */
1473 void
1474 gst_pad_set_chain_list_function_full (GstPad * pad,
1475     GstPadChainListFunction chainlist, gpointer user_data,
1476     GDestroyNotify notify)
1477 {
1478   g_return_if_fail (GST_IS_PAD (pad));
1479   g_return_if_fail (GST_PAD_IS_SINK (pad));
1480
1481   if (pad->chainlistnotify)
1482     pad->chainlistnotify (pad->chainlistdata);
1483   GST_PAD_CHAINLISTFUNC (pad) = chainlist;
1484   pad->chainlistdata = user_data;
1485   pad->chainlistnotify = notify;
1486
1487   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "chainlistfunc set to %s",
1488       GST_DEBUG_FUNCPTR_NAME (chainlist));
1489 }
1490
1491 /**
1492  * gst_pad_set_getrange_function_full:
1493  * @pad: a source #GstPad.
1494  * @get: the #GstPadGetRangeFunction to set.
1495  * @user_data: user_data passed to @notify
1496  * @notify: notify called when @get will not be used anymore.
1497  *
1498  * Sets the given getrange function for the pad. The getrange function is
1499  * called to produce a new #GstBuffer to start the processing pipeline. see
1500  * #GstPadGetRangeFunction for a description of the getrange function.
1501  */
1502 void
1503 gst_pad_set_getrange_function_full (GstPad * pad, GstPadGetRangeFunction get,
1504     gpointer user_data, GDestroyNotify notify)
1505 {
1506   g_return_if_fail (GST_IS_PAD (pad));
1507   g_return_if_fail (GST_PAD_IS_SRC (pad));
1508
1509   if (pad->getrangenotify)
1510     pad->getrangenotify (pad->getrangedata);
1511   GST_PAD_GETRANGEFUNC (pad) = get;
1512   pad->getrangedata = user_data;
1513   pad->getrangenotify = notify;
1514
1515   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "getrangefunc set to %s",
1516       GST_DEBUG_FUNCPTR_NAME (get));
1517 }
1518
1519 /**
1520  * gst_pad_set_event_function_full:
1521  * @pad: a #GstPad of either direction.
1522  * @event: the #GstPadEventFunction to set.
1523  * @user_data: user_data passed to @notify
1524  * @notify: notify called when @event will not be used anymore.
1525  *
1526  * Sets the given event handler for the pad.
1527  */
1528 void
1529 gst_pad_set_event_function_full (GstPad * pad, GstPadEventFunction event,
1530     gpointer user_data, GDestroyNotify notify)
1531 {
1532   g_return_if_fail (GST_IS_PAD (pad));
1533
1534   if (pad->eventnotify)
1535     pad->eventnotify (pad->eventdata);
1536   GST_PAD_EVENTFUNC (pad) = event;
1537   pad->eventdata = user_data;
1538   pad->eventnotify = notify;
1539
1540   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "eventfunc for set to %s",
1541       GST_DEBUG_FUNCPTR_NAME (event));
1542 }
1543
1544 /**
1545  * gst_pad_set_query_function_full:
1546  * @pad: a #GstPad of either direction.
1547  * @query: the #GstPadQueryFunction to set.
1548  * @user_data: user_data passed to @notify
1549  * @notify: notify called when @query will not be used anymore.
1550  *
1551  * Set the given query function for the pad.
1552  */
1553 void
1554 gst_pad_set_query_function_full (GstPad * pad, GstPadQueryFunction query,
1555     gpointer user_data, GDestroyNotify notify)
1556 {
1557   g_return_if_fail (GST_IS_PAD (pad));
1558
1559   if (pad->querynotify)
1560     pad->querynotify (pad->querydata);
1561   GST_PAD_QUERYFUNC (pad) = query;
1562   pad->querydata = user_data;
1563   pad->querynotify = notify;
1564
1565   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "queryfunc set to %s",
1566       GST_DEBUG_FUNCPTR_NAME (query));
1567 }
1568
1569 /**
1570  * gst_pad_set_iterate_internal_links_function_full:
1571  * @pad: a #GstPad of either direction.
1572  * @iterintlink: the #GstPadIterIntLinkFunction to set.
1573  * @user_data: user_data passed to @notify
1574  * @notify: notify called when @iterintlink will not be used anymore.
1575  *
1576  * Sets the given internal link iterator function for the pad.
1577  *
1578  * Since: 0.10.21
1579  */
1580 void
1581 gst_pad_set_iterate_internal_links_function_full (GstPad * pad,
1582     GstPadIterIntLinkFunction iterintlink, gpointer user_data,
1583     GDestroyNotify notify)
1584 {
1585   g_return_if_fail (GST_IS_PAD (pad));
1586
1587   if (pad->iterintlinknotify)
1588     pad->iterintlinknotify (pad->iterintlinkdata);
1589   GST_PAD_ITERINTLINKFUNC (pad) = iterintlink;
1590   pad->iterintlinkdata = user_data;
1591   pad->iterintlinknotify = notify;
1592
1593   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "internal link iterator set to %s",
1594       GST_DEBUG_FUNCPTR_NAME (iterintlink));
1595 }
1596
1597 /**
1598  * gst_pad_set_link_function_full:
1599  * @pad: a #GstPad.
1600  * @link: the #GstPadLinkFunction to set.
1601  * @user_data: user_data passed to @notify
1602  * @notify: notify called when @link will not be used anymore.
1603  *
1604  * Sets the given link function for the pad. It will be called when
1605  * the pad is linked with another pad.
1606  *
1607  * The return value #GST_PAD_LINK_OK should be used when the connection can be
1608  * made.
1609  *
1610  * The return value #GST_PAD_LINK_REFUSED should be used when the connection
1611  * cannot be made for some reason.
1612  *
1613  * If @link is installed on a source pad, it should call the #GstPadLinkFunction
1614  * of the peer sink pad, if present.
1615  */
1616 void
1617 gst_pad_set_link_function_full (GstPad * pad, GstPadLinkFunction link,
1618     gpointer user_data, GDestroyNotify notify)
1619 {
1620   g_return_if_fail (GST_IS_PAD (pad));
1621
1622   if (pad->linknotify)
1623     pad->linknotify (pad->linkdata);
1624   GST_PAD_LINKFUNC (pad) = link;
1625   pad->linkdata = user_data;
1626   pad->linknotify = notify;
1627
1628   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "linkfunc set to %s",
1629       GST_DEBUG_FUNCPTR_NAME (link));
1630 }
1631
1632 /**
1633  * gst_pad_set_unlink_function_full:
1634  * @pad: a #GstPad.
1635  * @unlink: the #GstPadUnlinkFunction to set.
1636  * @user_data: user_data passed to @notify
1637  * @notify: notify called when @unlink will not be used anymore.
1638  *
1639  * Sets the given unlink function for the pad. It will be called
1640  * when the pad is unlinked.
1641  */
1642 void
1643 gst_pad_set_unlink_function_full (GstPad * pad, GstPadUnlinkFunction unlink,
1644     gpointer user_data, GDestroyNotify notify)
1645 {
1646   g_return_if_fail (GST_IS_PAD (pad));
1647
1648   if (pad->unlinknotify)
1649     pad->unlinknotify (pad->unlinkdata);
1650   GST_PAD_UNLINKFUNC (pad) = unlink;
1651   pad->unlinkdata = user_data;
1652   pad->unlinknotify = notify;
1653
1654   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "unlinkfunc set to %s",
1655       GST_DEBUG_FUNCPTR_NAME (unlink));
1656 }
1657
1658 /**
1659  * gst_pad_unlink:
1660  * @srcpad: the source #GstPad to unlink.
1661  * @sinkpad: the sink #GstPad to unlink.
1662  *
1663  * Unlinks the source pad from the sink pad. Will emit the #GstPad::unlinked
1664  * signal on both pads.
1665  *
1666  * Returns: TRUE if the pads were unlinked. This function returns FALSE if
1667  * the pads were not linked together.
1668  *
1669  * MT safe.
1670  */
1671 gboolean
1672 gst_pad_unlink (GstPad * srcpad, GstPad * sinkpad)
1673 {
1674   gboolean result = FALSE;
1675   GstElement *parent = NULL;
1676
1677   g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
1678   g_return_val_if_fail (GST_PAD_IS_SRC (srcpad), FALSE);
1679   g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
1680   g_return_val_if_fail (GST_PAD_IS_SINK (sinkpad), FALSE);
1681
1682   GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "unlinking %s:%s(%p) and %s:%s(%p)",
1683       GST_DEBUG_PAD_NAME (srcpad), srcpad,
1684       GST_DEBUG_PAD_NAME (sinkpad), sinkpad);
1685
1686   /* We need to notify the parent before taking any pad locks as the bin in
1687    * question might be waiting for a lock on the pad while holding its lock
1688    * that our message will try to take. */
1689   if ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (srcpad)))) {
1690     if (GST_IS_ELEMENT (parent)) {
1691       gst_element_post_message (parent,
1692           gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
1693               GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK, parent, TRUE));
1694     } else {
1695       gst_object_unref (parent);
1696       parent = NULL;
1697     }
1698   }
1699
1700   GST_OBJECT_LOCK (srcpad);
1701   GST_OBJECT_LOCK (sinkpad);
1702
1703   if (G_UNLIKELY (GST_PAD_PEER (srcpad) != sinkpad))
1704     goto not_linked_together;
1705
1706   if (GST_PAD_UNLINKFUNC (srcpad)) {
1707     GST_PAD_UNLINKFUNC (srcpad) (srcpad);
1708   }
1709   if (GST_PAD_UNLINKFUNC (sinkpad)) {
1710     GST_PAD_UNLINKFUNC (sinkpad) (sinkpad);
1711   }
1712
1713   /* first clear peers */
1714   GST_PAD_PEER (srcpad) = NULL;
1715   GST_PAD_PEER (sinkpad) = NULL;
1716
1717   GST_OBJECT_UNLOCK (sinkpad);
1718   GST_OBJECT_UNLOCK (srcpad);
1719
1720   /* fire off a signal to each of the pads telling them
1721    * that they've been unlinked */
1722   g_signal_emit (srcpad, gst_pad_signals[PAD_UNLINKED], 0, sinkpad);
1723   g_signal_emit (sinkpad, gst_pad_signals[PAD_UNLINKED], 0, srcpad);
1724
1725   GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "unlinked %s:%s and %s:%s",
1726       GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1727
1728   result = TRUE;
1729
1730 done:
1731   if (parent != NULL) {
1732     gst_element_post_message (parent,
1733         gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
1734             GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK, parent, FALSE));
1735     gst_object_unref (parent);
1736   }
1737   return result;
1738
1739   /* ERRORS */
1740 not_linked_together:
1741   {
1742     /* we do not emit a warning in this case because unlinking cannot
1743      * be made MT safe.*/
1744     GST_OBJECT_UNLOCK (sinkpad);
1745     GST_OBJECT_UNLOCK (srcpad);
1746     goto done;
1747   }
1748 }
1749
1750 /**
1751  * gst_pad_is_linked:
1752  * @pad: pad to check
1753  *
1754  * Checks if a @pad is linked to another pad or not.
1755  *
1756  * Returns: TRUE if the pad is linked, FALSE otherwise.
1757  *
1758  * MT safe.
1759  */
1760 gboolean
1761 gst_pad_is_linked (GstPad * pad)
1762 {
1763   gboolean result;
1764
1765   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1766
1767   GST_OBJECT_LOCK (pad);
1768   result = (GST_PAD_PEER (pad) != NULL);
1769   GST_OBJECT_UNLOCK (pad);
1770
1771   return result;
1772 }
1773
1774 /* get the caps from both pads and see if the intersection
1775  * is not empty.
1776  *
1777  * This function should be called with the pad LOCK on both
1778  * pads
1779  */
1780 static gboolean
1781 gst_pad_link_check_compatible_unlocked (GstPad * src, GstPad * sink,
1782     GstPadLinkCheck flags)
1783 {
1784   GstCaps *srccaps = NULL;
1785   GstCaps *sinkcaps = NULL;
1786   gboolean compatible = FALSE;
1787
1788   if (!(flags & (GST_PAD_LINK_CHECK_CAPS | GST_PAD_LINK_CHECK_TEMPLATE_CAPS)))
1789     return TRUE;
1790
1791   /* Doing the expensive caps checking takes priority over only checking the template caps */
1792   if (flags & GST_PAD_LINK_CHECK_CAPS) {
1793     GST_OBJECT_UNLOCK (sink);
1794     GST_OBJECT_UNLOCK (src);
1795
1796     srccaps = gst_pad_query_caps (src, NULL);
1797     sinkcaps = gst_pad_query_caps (sink, NULL);
1798
1799     GST_OBJECT_LOCK (src);
1800     GST_OBJECT_LOCK (sink);
1801   } else {
1802     /* If one of the two pads doesn't have a template, consider the intersection
1803      * as valid.*/
1804     if (G_UNLIKELY ((GST_PAD_PAD_TEMPLATE (src) == NULL)
1805             || (GST_PAD_PAD_TEMPLATE (sink) == NULL))) {
1806       compatible = TRUE;
1807       goto done;
1808     }
1809     srccaps = gst_caps_ref (GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (src)));
1810     sinkcaps =
1811         gst_caps_ref (GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (sink)));
1812   }
1813
1814   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, src, "src caps %" GST_PTR_FORMAT,
1815       srccaps);
1816   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, sink, "sink caps %" GST_PTR_FORMAT,
1817       sinkcaps);
1818
1819   /* if we have caps on both pads we can check the intersection. If one
1820    * of the caps is NULL, we return TRUE. */
1821   if (G_UNLIKELY (srccaps == NULL || sinkcaps == NULL)) {
1822     if (srccaps)
1823       gst_caps_unref (srccaps);
1824     if (sinkcaps)
1825       gst_caps_unref (sinkcaps);
1826     goto done;
1827   }
1828
1829   compatible = gst_caps_can_intersect (srccaps, sinkcaps);
1830   gst_caps_unref (srccaps);
1831   gst_caps_unref (sinkcaps);
1832
1833 done:
1834   GST_CAT_DEBUG (GST_CAT_CAPS, "caps are %scompatible",
1835       (compatible ? "" : "not"));
1836
1837   return compatible;
1838 }
1839
1840 /* check if the grandparents of both pads are the same.
1841  * This check is required so that we don't try to link
1842  * pads from elements in different bins without ghostpads.
1843  *
1844  * The LOCK should be held on both pads
1845  */
1846 static gboolean
1847 gst_pad_link_check_hierarchy (GstPad * src, GstPad * sink)
1848 {
1849   GstObject *psrc, *psink;
1850
1851   psrc = GST_OBJECT_PARENT (src);
1852   psink = GST_OBJECT_PARENT (sink);
1853
1854   /* if one of the pads has no parent, we allow the link */
1855   if (G_UNLIKELY (psrc == NULL || psink == NULL))
1856     goto no_parent;
1857
1858   /* only care about parents that are elements */
1859   if (G_UNLIKELY (!GST_IS_ELEMENT (psrc) || !GST_IS_ELEMENT (psink)))
1860     goto no_element_parent;
1861
1862   /* if the parents are the same, we have a loop */
1863   if (G_UNLIKELY (psrc == psink))
1864     goto same_parents;
1865
1866   /* if they both have a parent, we check the grandparents. We can not lock
1867    * the parent because we hold on the child (pad) and the locking order is
1868    * parent >> child. */
1869   psrc = GST_OBJECT_PARENT (psrc);
1870   psink = GST_OBJECT_PARENT (psink);
1871
1872   /* if they have grandparents but they are not the same */
1873   if (G_UNLIKELY (psrc != psink))
1874     goto wrong_grandparents;
1875
1876   return TRUE;
1877
1878   /* ERRORS */
1879 no_parent:
1880   {
1881     GST_CAT_DEBUG (GST_CAT_CAPS,
1882         "one of the pads has no parent %" GST_PTR_FORMAT " and %"
1883         GST_PTR_FORMAT, psrc, psink);
1884     return TRUE;
1885   }
1886 no_element_parent:
1887   {
1888     GST_CAT_DEBUG (GST_CAT_CAPS,
1889         "one of the pads has no element parent %" GST_PTR_FORMAT " and %"
1890         GST_PTR_FORMAT, psrc, psink);
1891     return TRUE;
1892   }
1893 same_parents:
1894   {
1895     GST_CAT_DEBUG (GST_CAT_CAPS, "pads have same parent %" GST_PTR_FORMAT,
1896         psrc);
1897     return FALSE;
1898   }
1899 wrong_grandparents:
1900   {
1901     GST_CAT_DEBUG (GST_CAT_CAPS,
1902         "pads have different grandparents %" GST_PTR_FORMAT " and %"
1903         GST_PTR_FORMAT, psrc, psink);
1904     return FALSE;
1905   }
1906 }
1907
1908 /* FIXME leftover from an attempt at refactoring... */
1909 /* call with the two pads unlocked, when this function returns GST_PAD_LINK_OK,
1910  * the two pads will be locked in the srcpad, sinkpad order. */
1911 static GstPadLinkReturn
1912 gst_pad_link_prepare (GstPad * srcpad, GstPad * sinkpad, GstPadLinkCheck flags)
1913 {
1914   GST_CAT_INFO (GST_CAT_PADS, "trying to link %s:%s and %s:%s",
1915       GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1916
1917   GST_OBJECT_LOCK (srcpad);
1918
1919   if (G_UNLIKELY (GST_PAD_PEER (srcpad) != NULL))
1920     goto src_was_linked;
1921
1922   GST_OBJECT_LOCK (sinkpad);
1923
1924   if (G_UNLIKELY (GST_PAD_PEER (sinkpad) != NULL))
1925     goto sink_was_linked;
1926
1927   /* check hierarchy, pads can only be linked if the grandparents
1928    * are the same. */
1929   if ((flags & GST_PAD_LINK_CHECK_HIERARCHY)
1930       && !gst_pad_link_check_hierarchy (srcpad, sinkpad))
1931     goto wrong_hierarchy;
1932
1933   /* check pad caps for non-empty intersection */
1934   if (!gst_pad_link_check_compatible_unlocked (srcpad, sinkpad, flags))
1935     goto no_format;
1936
1937   /* FIXME check pad scheduling for non-empty intersection */
1938
1939   return GST_PAD_LINK_OK;
1940
1941 src_was_linked:
1942   {
1943     GST_CAT_INFO (GST_CAT_PADS, "src %s:%s was already linked to %s:%s",
1944         GST_DEBUG_PAD_NAME (srcpad),
1945         GST_DEBUG_PAD_NAME (GST_PAD_PEER (srcpad)));
1946     /* we do not emit a warning in this case because unlinking cannot
1947      * be made MT safe.*/
1948     GST_OBJECT_UNLOCK (srcpad);
1949     return GST_PAD_LINK_WAS_LINKED;
1950   }
1951 sink_was_linked:
1952   {
1953     GST_CAT_INFO (GST_CAT_PADS, "sink %s:%s was already linked to %s:%s",
1954         GST_DEBUG_PAD_NAME (sinkpad),
1955         GST_DEBUG_PAD_NAME (GST_PAD_PEER (sinkpad)));
1956     /* we do not emit a warning in this case because unlinking cannot
1957      * be made MT safe.*/
1958     GST_OBJECT_UNLOCK (sinkpad);
1959     GST_OBJECT_UNLOCK (srcpad);
1960     return GST_PAD_LINK_WAS_LINKED;
1961   }
1962 wrong_hierarchy:
1963   {
1964     GST_CAT_INFO (GST_CAT_PADS, "pads have wrong hierarchy");
1965     GST_OBJECT_UNLOCK (sinkpad);
1966     GST_OBJECT_UNLOCK (srcpad);
1967     return GST_PAD_LINK_WRONG_HIERARCHY;
1968   }
1969 no_format:
1970   {
1971     GST_CAT_INFO (GST_CAT_PADS, "caps are incompatible");
1972     GST_OBJECT_UNLOCK (sinkpad);
1973     GST_OBJECT_UNLOCK (srcpad);
1974     return GST_PAD_LINK_NOFORMAT;
1975   }
1976 }
1977
1978 /**
1979  * gst_pad_can_link:
1980  * @srcpad: the source #GstPad.
1981  * @sinkpad: the sink #GstPad.
1982  *
1983  * Checks if the source pad and the sink pad are compatible so they can be
1984  * linked.
1985  *
1986  * Returns: TRUE if the pads can be linked.
1987  */
1988 gboolean
1989 gst_pad_can_link (GstPad * srcpad, GstPad * sinkpad)
1990 {
1991   GstPadLinkReturn result;
1992
1993   /* generic checks */
1994   g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
1995   g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
1996
1997   GST_CAT_INFO (GST_CAT_PADS, "check if %s:%s can link with %s:%s",
1998       GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1999
2000   /* gst_pad_link_prepare does everything for us, we only release the locks
2001    * on the pads that it gets us. If this function returns !OK the locks are not
2002    * taken anymore. */
2003   result = gst_pad_link_prepare (srcpad, sinkpad, GST_PAD_LINK_CHECK_DEFAULT);
2004   if (result != GST_PAD_LINK_OK)
2005     goto done;
2006
2007   GST_OBJECT_UNLOCK (srcpad);
2008   GST_OBJECT_UNLOCK (sinkpad);
2009
2010 done:
2011   return result == GST_PAD_LINK_OK;
2012 }
2013
2014 /**
2015  * gst_pad_link_full:
2016  * @srcpad: the source #GstPad to link.
2017  * @sinkpad: the sink #GstPad to link.
2018  * @flags: the checks to validate when linking
2019  *
2020  * Links the source pad and the sink pad.
2021  *
2022  * This variant of #gst_pad_link provides a more granular control on the
2023  * checks being done when linking. While providing some considerable speedups
2024  * the caller of this method must be aware that wrong usage of those flags
2025  * can cause severe issues. Refer to the documentation of #GstPadLinkCheck
2026  * for more information.
2027  *
2028  * MT Safe.
2029  *
2030  * Returns: A result code indicating if the connection worked or
2031  *          what went wrong.
2032  *
2033  * Since: 0.10.30
2034  */
2035 GstPadLinkReturn
2036 gst_pad_link_full (GstPad * srcpad, GstPad * sinkpad, GstPadLinkCheck flags)
2037 {
2038   GstPadLinkReturn result;
2039   GstElement *parent;
2040   GstPadLinkFunction srcfunc, sinkfunc;
2041
2042   g_return_val_if_fail (GST_IS_PAD (srcpad), GST_PAD_LINK_REFUSED);
2043   g_return_val_if_fail (GST_PAD_IS_SRC (srcpad), GST_PAD_LINK_WRONG_DIRECTION);
2044   g_return_val_if_fail (GST_IS_PAD (sinkpad), GST_PAD_LINK_REFUSED);
2045   g_return_val_if_fail (GST_PAD_IS_SINK (sinkpad),
2046       GST_PAD_LINK_WRONG_DIRECTION);
2047
2048   /* Notify the parent early. See gst_pad_unlink for details. */
2049   if (G_LIKELY ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (srcpad))))) {
2050     if (G_LIKELY (GST_IS_ELEMENT (parent))) {
2051       gst_element_post_message (parent,
2052           gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2053               GST_STRUCTURE_CHANGE_TYPE_PAD_LINK, parent, TRUE));
2054     } else {
2055       gst_object_unref (parent);
2056       parent = NULL;
2057     }
2058   }
2059
2060   /* prepare will also lock the two pads */
2061   result = gst_pad_link_prepare (srcpad, sinkpad, flags);
2062
2063   if (G_UNLIKELY (result != GST_PAD_LINK_OK))
2064     goto done;
2065
2066   /* must set peers before calling the link function */
2067   GST_PAD_PEER (srcpad) = sinkpad;
2068   GST_PAD_PEER (sinkpad) = srcpad;
2069
2070   /* check events, when something is different, mark pending */
2071   schedule_events (srcpad, sinkpad);
2072
2073   /* get the link functions */
2074   srcfunc = GST_PAD_LINKFUNC (srcpad);
2075   sinkfunc = GST_PAD_LINKFUNC (sinkpad);
2076
2077   if (G_UNLIKELY (srcfunc || sinkfunc)) {
2078     /* custom link functions, execute them */
2079     GST_OBJECT_UNLOCK (sinkpad);
2080     GST_OBJECT_UNLOCK (srcpad);
2081
2082     if (srcfunc) {
2083       /* this one will call the peer link function */
2084       result = srcfunc (srcpad, sinkpad);
2085     } else if (sinkfunc) {
2086       /* if no source link function, we need to call the sink link
2087        * function ourselves. */
2088       result = sinkfunc (sinkpad, srcpad);
2089     }
2090
2091     GST_OBJECT_LOCK (srcpad);
2092     GST_OBJECT_LOCK (sinkpad);
2093
2094     /* we released the lock, check if the same pads are linked still */
2095     if (GST_PAD_PEER (srcpad) != sinkpad || GST_PAD_PEER (sinkpad) != srcpad)
2096       goto concurrent_link;
2097
2098     if (G_UNLIKELY (result != GST_PAD_LINK_OK))
2099       goto link_failed;
2100   }
2101   GST_OBJECT_UNLOCK (sinkpad);
2102   GST_OBJECT_UNLOCK (srcpad);
2103
2104   /* fire off a signal to each of the pads telling them
2105    * that they've been linked */
2106   g_signal_emit (srcpad, gst_pad_signals[PAD_LINKED], 0, sinkpad);
2107   g_signal_emit (sinkpad, gst_pad_signals[PAD_LINKED], 0, srcpad);
2108
2109   GST_CAT_INFO (GST_CAT_PADS, "linked %s:%s and %s:%s, successful",
2110       GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2111
2112   gst_pad_send_event (srcpad, gst_event_new_reconfigure ());
2113
2114 done:
2115   if (G_LIKELY (parent)) {
2116     gst_element_post_message (parent,
2117         gst_message_new_structure_change (GST_OBJECT_CAST (sinkpad),
2118             GST_STRUCTURE_CHANGE_TYPE_PAD_LINK, parent, FALSE));
2119     gst_object_unref (parent);
2120   }
2121
2122   return result;
2123
2124   /* ERRORS */
2125 concurrent_link:
2126   {
2127     GST_CAT_INFO (GST_CAT_PADS, "concurrent link between %s:%s and %s:%s",
2128         GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2129     GST_OBJECT_UNLOCK (sinkpad);
2130     GST_OBJECT_UNLOCK (srcpad);
2131
2132     /* The other link operation succeeded first */
2133     result = GST_PAD_LINK_WAS_LINKED;
2134     goto done;
2135   }
2136 link_failed:
2137   {
2138     GST_CAT_INFO (GST_CAT_PADS, "link between %s:%s and %s:%s failed",
2139         GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2140
2141     GST_PAD_PEER (srcpad) = NULL;
2142     GST_PAD_PEER (sinkpad) = NULL;
2143
2144     GST_OBJECT_UNLOCK (sinkpad);
2145     GST_OBJECT_UNLOCK (srcpad);
2146
2147     goto done;
2148   }
2149 }
2150
2151 /**
2152  * gst_pad_link:
2153  * @srcpad: the source #GstPad to link.
2154  * @sinkpad: the sink #GstPad to link.
2155  *
2156  * Links the source pad and the sink pad.
2157  *
2158  * Returns: A result code indicating if the connection worked or
2159  *          what went wrong.
2160  *
2161  * MT Safe.
2162  */
2163 GstPadLinkReturn
2164 gst_pad_link (GstPad * srcpad, GstPad * sinkpad)
2165 {
2166   return gst_pad_link_full (srcpad, sinkpad, GST_PAD_LINK_CHECK_DEFAULT);
2167 }
2168
2169 static void
2170 gst_pad_set_pad_template (GstPad * pad, GstPadTemplate * templ)
2171 {
2172   GstPadTemplate **template_p;
2173
2174   /* this function would need checks if it weren't static */
2175
2176   GST_OBJECT_LOCK (pad);
2177   template_p = &pad->padtemplate;
2178   gst_object_replace ((GstObject **) template_p, (GstObject *) templ);
2179   GST_OBJECT_UNLOCK (pad);
2180
2181   if (templ)
2182     gst_pad_template_pad_created (templ, pad);
2183 }
2184
2185 /**
2186  * gst_pad_get_pad_template:
2187  * @pad: a #GstPad.
2188  *
2189  * Gets the template for @pad.
2190  *
2191  * Returns: (transfer full): the #GstPadTemplate from which this pad was
2192  *     instantiated, or %NULL if this pad has no template. Unref after
2193  *     usage.
2194  */
2195 GstPadTemplate *
2196 gst_pad_get_pad_template (GstPad * pad)
2197 {
2198   GstPadTemplate *templ;
2199
2200   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2201
2202   templ = GST_PAD_PAD_TEMPLATE (pad);
2203
2204   return (templ ? gst_object_ref (templ) : NULL);
2205 }
2206
2207 /**
2208  * gst_pad_has_current_caps:
2209  * @pad: a  #GstPad to check
2210  *
2211  * Check if @pad has caps set on it with a #GST_EVENT_CAPS event.
2212  *
2213  * Returns: TRUE when @pad has caps associated with it.
2214  */
2215 gboolean
2216 gst_pad_has_current_caps (GstPad * pad)
2217 {
2218   gboolean result;
2219   GstCaps *caps;
2220
2221   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2222
2223   GST_OBJECT_LOCK (pad);
2224   caps = get_pad_caps (pad);
2225   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2226       "check current pad caps %" GST_PTR_FORMAT, caps);
2227   result = (caps != NULL);
2228   GST_OBJECT_UNLOCK (pad);
2229
2230   return result;
2231 }
2232
2233 /**
2234  * gst_pad_get_current_caps:
2235  * @pad: a  #GstPad to get the current capabilities of.
2236  *
2237  * Gets the capabilities currently configured on @pad with the last
2238  * #GST_EVENT_CAPS event.
2239  *
2240  * Returns: the current caps of the pad with incremented ref-count.
2241  */
2242 GstCaps *
2243 gst_pad_get_current_caps (GstPad * pad)
2244 {
2245   GstCaps *result;
2246
2247   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2248
2249   GST_OBJECT_LOCK (pad);
2250   if ((result = get_pad_caps (pad)))
2251     gst_caps_ref (result);
2252   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2253       "get current pad caps %" GST_PTR_FORMAT, result);
2254   GST_OBJECT_UNLOCK (pad);
2255
2256   return result;
2257 }
2258
2259 /**
2260  * gst_pad_set_caps:
2261  * @pad: a  #GstPad to set the capabilities of.
2262  * @caps: (transfer none): a #GstCaps to set.
2263  *
2264  * Sets the capabilities of this pad. The caps must be fixed. Any previous
2265  * caps on the pad will be unreffed. This function refs the caps so you should
2266  * unref if as soon as you don't need it anymore.
2267  * It is possible to set NULL caps, which will make the pad unnegotiated
2268  * again.
2269  *
2270  * Returns: TRUE if the caps could be set. FALSE if the caps were not fixed
2271  * or bad parameters were provided to this function.
2272  *
2273  * MT safe.
2274  */
2275 gboolean
2276 gst_pad_set_caps (GstPad * pad, GstCaps * caps)
2277 {
2278   GstEvent *event;
2279   gboolean res = TRUE;
2280
2281   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2282   g_return_val_if_fail (caps != NULL && gst_caps_is_fixed (caps), FALSE);
2283
2284   event = gst_event_new_caps (caps);
2285
2286   if (GST_PAD_IS_SRC (pad))
2287     res = gst_pad_push_event (pad, event);
2288   else
2289     res = gst_pad_send_event (pad, event);
2290
2291   return res;
2292 }
2293
2294 /**
2295  * gst_pad_get_pad_template_caps:
2296  * @pad: a #GstPad to get the template capabilities from.
2297  *
2298  * Gets the capabilities for @pad's template.
2299  *
2300  * Returns: (transfer full): the #GstCaps of this pad template.
2301  * Unref after usage.
2302  */
2303 GstCaps *
2304 gst_pad_get_pad_template_caps (GstPad * pad)
2305 {
2306   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2307
2308   if (GST_PAD_PAD_TEMPLATE (pad))
2309     return gst_pad_template_get_caps (GST_PAD_PAD_TEMPLATE (pad));
2310
2311   return gst_caps_ref (GST_CAPS_ANY);
2312 }
2313
2314 /**
2315  * gst_pad_get_peer:
2316  * @pad: a #GstPad to get the peer of.
2317  *
2318  * Gets the peer of @pad. This function refs the peer pad so
2319  * you need to unref it after use.
2320  *
2321  * Returns: (transfer full): the peer #GstPad. Unref after usage.
2322  *
2323  * MT safe.
2324  */
2325 GstPad *
2326 gst_pad_get_peer (GstPad * pad)
2327 {
2328   GstPad *result;
2329
2330   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2331
2332   GST_OBJECT_LOCK (pad);
2333   result = GST_PAD_PEER (pad);
2334   if (result)
2335     gst_object_ref (result);
2336   GST_OBJECT_UNLOCK (pad);
2337
2338   return result;
2339 }
2340
2341 /**
2342  * gst_pad_get_allowed_caps:
2343  * @pad: a #GstPad.
2344  *
2345  * Gets the capabilities of the allowed media types that can flow through
2346  * @pad and its peer.
2347  *
2348  * The allowed capabilities is calculated as the intersection of the results of
2349  * calling gst_pad_query_caps() on @pad and its peer. The caller owns a reference
2350  * on the resulting caps.
2351  *
2352  * Returns: (transfer full): the allowed #GstCaps of the pad link. Unref the
2353  *     caps when you no longer need it. This function returns NULL when @pad
2354  *     has no peer.
2355  *
2356  * MT safe.
2357  */
2358 GstCaps *
2359 gst_pad_get_allowed_caps (GstPad * pad)
2360 {
2361   GstCaps *mycaps;
2362   GstCaps *caps;
2363   GstCaps *peercaps;
2364   GstPad *peer;
2365
2366   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2367
2368   GST_OBJECT_LOCK (pad);
2369   peer = GST_PAD_PEER (pad);
2370   if (G_UNLIKELY (peer == NULL))
2371     goto no_peer;
2372
2373   GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "getting allowed caps");
2374
2375   gst_object_ref (peer);
2376   GST_OBJECT_UNLOCK (pad);
2377   mycaps = gst_pad_query_caps (pad, NULL);
2378
2379   peercaps = gst_pad_query_caps (peer, NULL);
2380   gst_object_unref (peer);
2381
2382   caps = gst_caps_intersect (mycaps, peercaps);
2383   gst_caps_unref (peercaps);
2384   gst_caps_unref (mycaps);
2385
2386   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "allowed caps %" GST_PTR_FORMAT,
2387       caps);
2388
2389   return caps;
2390
2391 no_peer:
2392   {
2393     GST_CAT_DEBUG_OBJECT (GST_CAT_PROPERTIES, pad, "no peer");
2394     GST_OBJECT_UNLOCK (pad);
2395
2396     return NULL;
2397   }
2398 }
2399
2400 /**
2401  * gst_pad_iterate_internal_links_default:
2402  * @pad: the #GstPad to get the internal links of.
2403  * @parent: the parent of @pad or NULL
2404  *
2405  * Iterate the list of pads to which the given pad is linked to inside of
2406  * the parent element.
2407  * This is the default handler, and thus returns an iterator of all of the
2408  * pads inside the parent element with opposite direction.
2409  *
2410  * The caller must free this iterator after use with gst_iterator_free().
2411  *
2412  * Returns: a #GstIterator of #GstPad, or NULL if @pad has no parent. Unref each
2413  * returned pad with gst_object_unref().
2414  *
2415  * Since: 0.10.21
2416  */
2417 GstIterator *
2418 gst_pad_iterate_internal_links_default (GstPad * pad, GstObject * parent)
2419 {
2420   GstIterator *res;
2421   GList **padlist;
2422   guint32 *cookie;
2423   GMutex *lock;
2424   gpointer owner;
2425   GstElement *eparent;
2426
2427   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2428
2429   if (parent != NULL && GST_IS_ELEMENT (parent)) {
2430     eparent = GST_ELEMENT_CAST (gst_object_ref (parent));
2431   } else {
2432     GST_OBJECT_LOCK (pad);
2433     eparent = GST_PAD_PARENT (pad);
2434     if (!eparent || !GST_IS_ELEMENT (eparent))
2435       goto no_parent;
2436
2437     gst_object_ref (eparent);
2438     GST_OBJECT_UNLOCK (pad);
2439   }
2440
2441   if (pad->direction == GST_PAD_SRC)
2442     padlist = &eparent->sinkpads;
2443   else
2444     padlist = &eparent->srcpads;
2445
2446   GST_DEBUG_OBJECT (pad, "Making iterator");
2447
2448   cookie = &eparent->pads_cookie;
2449   owner = eparent;
2450   lock = GST_OBJECT_GET_LOCK (eparent);
2451
2452   res = gst_iterator_new_list (GST_TYPE_PAD,
2453       lock, cookie, padlist, (GObject *) owner, NULL);
2454
2455   gst_object_unref (owner);
2456
2457   return res;
2458
2459   /* ERRORS */
2460 no_parent:
2461   {
2462     GST_OBJECT_UNLOCK (pad);
2463     GST_DEBUG_OBJECT (pad, "no parent element");
2464     return NULL;
2465   }
2466 }
2467
2468 /**
2469  * gst_pad_iterate_internal_links:
2470  * @pad: the GstPad to get the internal links of.
2471  *
2472  * Gets an iterator for the pads to which the given pad is linked to inside
2473  * of the parent element.
2474  *
2475  * Each #GstPad element yielded by the iterator will have its refcount increased,
2476  * so unref after use.
2477  *
2478  * Free-function: gst_iterator_free
2479  *
2480  * Returns: (transfer full): a new #GstIterator of #GstPad or %NULL when the
2481  *     pad does not have an iterator function configured. Use
2482  *     gst_iterator_free() after usage.
2483  *
2484  * Since: 0.10.21
2485  */
2486 GstIterator *
2487 gst_pad_iterate_internal_links (GstPad * pad)
2488 {
2489   GstIterator *res = NULL;
2490   GstObject *parent;
2491
2492   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2493
2494   GST_OBJECT_LOCK (pad);
2495   ACQUIRE_PARENT (pad, parent, no_parent);
2496   GST_OBJECT_UNLOCK (pad);
2497
2498   if (GST_PAD_ITERINTLINKFUNC (pad))
2499     res = GST_PAD_ITERINTLINKFUNC (pad) (pad, parent);
2500
2501   RELEASE_PARENT (parent);
2502
2503   return res;
2504
2505   /* ERRORS */
2506 no_parent:
2507   {
2508     GST_DEBUG_OBJECT (pad, "no parent");
2509     GST_OBJECT_UNLOCK (pad);
2510     return FALSE;
2511   }
2512 }
2513
2514 /**
2515  * gst_pad_forward:
2516  * @pad: a #GstPad
2517  * @forward: a #GstPadForwardFunction
2518  * @user_data: user data passed to @forward
2519  *
2520  * Calls @forward for all internally linked pads of @pad. This function deals with
2521  * dynamically changing internal pads and will make sure that the @forward
2522  * function is only called once for each pad.
2523  *
2524  * When @forward returns TRUE, no further pads will be processed.
2525  *
2526  * Returns: TRUE if one of the dispatcher functions returned TRUE.
2527  */
2528 gboolean
2529 gst_pad_forward (GstPad * pad, GstPadForwardFunction forward,
2530     gpointer user_data)
2531 {
2532   gboolean result = FALSE;
2533   GstIterator *iter;
2534   gboolean done = FALSE;
2535   GValue item = { 0, };
2536   GList *pushed_pads = NULL;
2537
2538   iter = gst_pad_iterate_internal_links (pad);
2539
2540   if (!iter)
2541     goto no_iter;
2542
2543   while (!done) {
2544     switch (gst_iterator_next (iter, &item)) {
2545       case GST_ITERATOR_OK:
2546       {
2547         GstPad *intpad;
2548
2549         intpad = g_value_get_object (&item);
2550
2551         /* if already pushed, skip. FIXME, find something faster to tag pads */
2552         if (intpad == NULL || g_list_find (pushed_pads, intpad)) {
2553           g_value_reset (&item);
2554           break;
2555         }
2556
2557         GST_LOG_OBJECT (pad, "calling forward function on pad %s:%s",
2558             GST_DEBUG_PAD_NAME (intpad));
2559         done = result = forward (intpad, user_data);
2560
2561         pushed_pads = g_list_prepend (pushed_pads, intpad);
2562
2563         g_value_reset (&item);
2564         break;
2565       }
2566       case GST_ITERATOR_RESYNC:
2567         /* We don't reset the result here because we don't push the event
2568          * again on pads that got the event already and because we need
2569          * to consider the result of the previous pushes */
2570         gst_iterator_resync (iter);
2571         break;
2572       case GST_ITERATOR_ERROR:
2573         GST_ERROR_OBJECT (pad, "Could not iterate over internally linked pads");
2574         done = TRUE;
2575         break;
2576       case GST_ITERATOR_DONE:
2577         done = TRUE;
2578         break;
2579     }
2580   }
2581   g_value_unset (&item);
2582   gst_iterator_free (iter);
2583
2584   g_list_free (pushed_pads);
2585
2586 no_iter:
2587   return result;
2588 }
2589
2590 typedef struct
2591 {
2592   GstEvent *event;
2593   gboolean result;
2594   gboolean dispatched;
2595 } EventData;
2596
2597 static gboolean
2598 event_forward_func (GstPad * pad, EventData * data)
2599 {
2600   /* for each pad we send to, we should ref the event; it's up
2601    * to downstream to unref again when handled. */
2602   GST_LOG_OBJECT (pad, "Reffing and pushing event %p (%s) to %s:%s",
2603       data->event, GST_EVENT_TYPE_NAME (data->event), GST_DEBUG_PAD_NAME (pad));
2604
2605   data->result |= gst_pad_push_event (pad, gst_event_ref (data->event));
2606
2607   data->dispatched = TRUE;
2608
2609   /* don't stop */
2610   return FALSE;
2611 }
2612
2613 /**
2614  * gst_pad_event_default:
2615  * @pad: a #GstPad to call the default event handler on.
2616  * @parent: the parent of @pad or NULL
2617  * @event: (transfer full): the #GstEvent to handle.
2618  *
2619  * Invokes the default event handler for the given pad.
2620  *
2621  * The EOS event will pause the task associated with @pad before it is forwarded
2622  * to all internally linked pads,
2623  *
2624  * The the event is sent to all pads internally linked to @pad. This function
2625  * takes ownership of @event.
2626  *
2627  * Returns: TRUE if the event was sent successfully.
2628  */
2629 gboolean
2630 gst_pad_event_default (GstPad * pad, GstObject * parent, GstEvent * event)
2631 {
2632   gboolean result, forward = TRUE;
2633
2634   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2635   g_return_val_if_fail (event != NULL, FALSE);
2636
2637   GST_LOG_OBJECT (pad, "default event handler");
2638
2639   switch (GST_EVENT_TYPE (event)) {
2640     case GST_EVENT_EOS:
2641     {
2642       GST_DEBUG_OBJECT (pad, "pausing task because of eos");
2643       gst_pad_pause_task (pad);
2644       break;
2645     }
2646     case GST_EVENT_CAPS:
2647       forward = GST_PAD_IS_PROXY_CAPS (pad);
2648       result = TRUE;
2649       break;
2650     default:
2651       break;
2652   }
2653
2654   if (forward) {
2655     EventData data;
2656
2657     data.event = event;
2658     data.dispatched = FALSE;
2659     data.result = FALSE;
2660
2661     gst_pad_forward (pad, (GstPadForwardFunction) event_forward_func, &data);
2662
2663     /* for sinkpads without a parent element or without internal links, nothing
2664      * will be dispatched but we still want to return TRUE. */
2665     if (data.dispatched)
2666       result = data.result;
2667     else
2668       result = TRUE;
2669   }
2670
2671   gst_event_unref (event);
2672
2673   return result;
2674 }
2675
2676 /* Default accept caps implementation just checks against
2677  * the allowed caps for the pad */
2678 static gboolean
2679 gst_pad_query_accept_caps_default (GstPad * pad, GstQuery * query)
2680 {
2681   /* get the caps and see if it intersects to something not empty */
2682   GstCaps *caps, *allowed;
2683   gboolean result;
2684
2685   GST_DEBUG_OBJECT (pad, "query accept-caps %" GST_PTR_FORMAT, query);
2686
2687   /* first forward the query to internally linked pads when we are dealing with
2688    * a PROXY CAPS */
2689   if (GST_PAD_IS_PROXY_CAPS (pad)) {
2690     if ((result = gst_pad_proxy_query_accept_caps (pad, query))) {
2691       goto done;
2692     }
2693   }
2694
2695   GST_CAT_DEBUG_OBJECT (GST_CAT_PERFORMANCE, pad,
2696       "fallback ACCEPT_CAPS query, consider implementing a specialized version");
2697
2698   allowed = gst_pad_query_caps (pad, NULL);
2699   gst_query_parse_accept_caps (query, &caps);
2700
2701   if (allowed) {
2702     GST_DEBUG_OBJECT (pad, "allowed caps %" GST_PTR_FORMAT, allowed);
2703     result = gst_caps_is_subset (caps, allowed);
2704     gst_caps_unref (allowed);
2705   } else {
2706     GST_DEBUG_OBJECT (pad, "no caps allowed on the pad");
2707     result = FALSE;
2708   }
2709   gst_query_set_accept_caps_result (query, result);
2710
2711 done:
2712   return TRUE;
2713 }
2714
2715 /* Default caps implementation */
2716 static gboolean
2717 gst_pad_query_caps_default (GstPad * pad, GstQuery * query)
2718 {
2719   GstCaps *result = NULL, *filter;
2720   GstPadTemplate *templ;
2721   gboolean fixed_caps;
2722
2723   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "get pad caps");
2724
2725   gst_query_parse_caps (query, &filter);
2726
2727   /* first try to proxy if we must */
2728   if (GST_PAD_IS_PROXY_CAPS (pad)) {
2729     if ((gst_pad_proxy_query_caps (pad, query))) {
2730       gst_query_parse_caps_result (query, &result);
2731       goto filter_done;
2732     }
2733   }
2734
2735   /* no proxy or it failed, do default handling */
2736   fixed_caps = GST_PAD_IS_FIXED_CAPS (pad);
2737
2738   GST_OBJECT_LOCK (pad);
2739   if (fixed_caps) {
2740     /* fixed caps, try the negotiated caps first */
2741     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "fixed pad caps: trying pad caps");
2742     if ((result = get_pad_caps (pad)))
2743       goto filter_done_unlock;
2744   }
2745
2746   if ((templ = GST_PAD_PAD_TEMPLATE (pad))) {
2747     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "trying pad template caps");
2748     if ((result = GST_PAD_TEMPLATE_CAPS (templ)))
2749       goto filter_done_unlock;
2750   }
2751
2752   if (!fixed_caps) {
2753     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2754         "non-fixed pad caps: trying pad caps");
2755     /* non fixed caps, try the negotiated caps */
2756     if ((result = get_pad_caps (pad)))
2757       goto filter_done_unlock;
2758   }
2759
2760   /* this almost never happens */
2761   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "pad has no caps");
2762   result = GST_CAPS_ANY;
2763
2764 filter_done_unlock:
2765   GST_OBJECT_UNLOCK (pad);
2766
2767 filter_done:
2768   /* run the filter on the result */
2769   if (filter) {
2770     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2771         "using caps %p %" GST_PTR_FORMAT " with filter %p %"
2772         GST_PTR_FORMAT, result, result, filter, filter);
2773     result = gst_caps_intersect_full (filter, result, GST_CAPS_INTERSECT_FIRST);
2774     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "result %p %" GST_PTR_FORMAT,
2775         result, result);
2776   } else {
2777     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2778         "using caps %p %" GST_PTR_FORMAT, result, result);
2779     result = gst_caps_ref (result);
2780   }
2781
2782   gst_query_set_caps_result (query, result);
2783   gst_caps_unref (result);
2784
2785   return TRUE;
2786 }
2787
2788 typedef struct
2789 {
2790   GstQuery *query;
2791   gboolean result;
2792   gboolean dispatched;
2793 } QueryData;
2794
2795 static gboolean
2796 query_forward_func (GstPad * pad, QueryData * data)
2797 {
2798   GST_LOG_OBJECT (pad, "query peer %p (%s) of %s:%s",
2799       data->query, GST_EVENT_TYPE_NAME (data->query), GST_DEBUG_PAD_NAME (pad));
2800
2801   data->result |= gst_pad_peer_query (pad, data->query);
2802
2803   data->dispatched = TRUE;
2804
2805   /* stop on first successful reply */
2806   return data->result;
2807 }
2808
2809 /**
2810  * gst_pad_query_default:
2811  * @pad: a #GstPad to call the default query handler on.
2812  * @parent: the parent of @pad or NULL
2813  * @query: (transfer none): the #GstQuery to handle.
2814  *
2815  * Invokes the default query handler for the given pad.
2816  * The query is sent to all pads internally linked to @pad. Note that
2817  * if there are many possible sink pads that are internally linked to
2818  * @pad, only one will be sent the query.
2819  * Multi-sinkpad elements should implement custom query handlers.
2820  *
2821  * Returns: TRUE if the query was performed successfully.
2822  */
2823 gboolean
2824 gst_pad_query_default (GstPad * pad, GstObject * parent, GstQuery * query)
2825 {
2826   gboolean forward, ret = FALSE;
2827
2828   switch (GST_QUERY_TYPE (query)) {
2829     case GST_QUERY_SCHEDULING:
2830       forward = FALSE;
2831       break;
2832     case GST_QUERY_ALLOCATION:
2833       forward = GST_PAD_IS_PROXY_ALLOCATION (pad);
2834       break;
2835     case GST_QUERY_ACCEPT_CAPS:
2836       ret = gst_pad_query_accept_caps_default (pad, query);
2837       forward = FALSE;
2838       break;
2839     case GST_QUERY_CAPS:
2840       ret = gst_pad_query_caps_default (pad, query);
2841       forward = FALSE;
2842       break;
2843     case GST_QUERY_POSITION:
2844     case GST_QUERY_SEEKING:
2845     case GST_QUERY_FORMATS:
2846     case GST_QUERY_LATENCY:
2847     case GST_QUERY_JITTER:
2848     case GST_QUERY_RATE:
2849     case GST_QUERY_CONVERT:
2850     default:
2851       forward = TRUE;
2852       break;
2853   }
2854
2855   GST_DEBUG_OBJECT (pad, "%sforwarding %p (%s) query", (forward ? "" : "not "),
2856       query, GST_QUERY_TYPE_NAME (query));
2857
2858   if (forward) {
2859     QueryData data;
2860
2861     data.query = query;
2862     data.dispatched = FALSE;
2863     data.result = FALSE;
2864
2865     gst_pad_forward (pad, (GstPadForwardFunction) query_forward_func, &data);
2866
2867     if (data.dispatched) {
2868       ret = data.result;
2869     } else {
2870       /* nothing dispatched, assume drained */
2871       if (GST_QUERY_TYPE (query) == GST_QUERY_DRAIN)
2872         ret = TRUE;
2873       else
2874         ret = FALSE;
2875     }
2876   }
2877   return ret;
2878 }
2879
2880 static void
2881 probe_hook_marshal (GHook * hook, ProbeMarshall * data)
2882 {
2883   GstPad *pad = data->pad;
2884   GstPadProbeInfo *info = data->info;
2885   GstPadProbeType type, flags;
2886   GstPadProbeCallback callback;
2887   GstPadProbeReturn ret;
2888
2889   /* if we have called this callback, do nothing */
2890   if (PROBE_COOKIE (hook) == data->cookie) {
2891     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
2892         "hook %lu, cookie %u already called", hook->hook_id,
2893         PROBE_COOKIE (hook));
2894     return;
2895   }
2896
2897   PROBE_COOKIE (hook) = data->cookie;
2898
2899   flags = hook->flags >> G_HOOK_FLAG_USER_SHIFT;
2900   type = info->type;
2901
2902   /* one of the data types */
2903   if ((flags & GST_PAD_PROBE_TYPE_ALL_BOTH & type) == 0)
2904     goto no_match;
2905   /* one of the scheduling types */
2906   if ((flags & GST_PAD_PROBE_TYPE_SCHEDULING & type) == 0)
2907     goto no_match;
2908   /* one of the blocking types must match */
2909   if ((type & GST_PAD_PROBE_TYPE_BLOCKING) &&
2910       (flags & GST_PAD_PROBE_TYPE_BLOCKING & type) == 0)
2911     goto no_match;
2912   /* only probes that have GST_PAD_PROBE_TYPE_EVENT_FLUSH set */
2913   if ((type & GST_PAD_PROBE_TYPE_EVENT_FLUSH) &&
2914       (flags & GST_PAD_PROBE_TYPE_EVENT_FLUSH & type) == 0)
2915     goto no_match;
2916
2917   GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
2918       "hook %lu, cookie %u with flags 0x%08x matches", hook->hook_id,
2919       PROBE_COOKIE (hook), flags);
2920
2921   data->marshalled = TRUE;
2922
2923   callback = (GstPadProbeCallback) hook->func;
2924   if (callback == NULL)
2925     return;
2926
2927   info->id = hook->hook_id;
2928
2929   GST_OBJECT_UNLOCK (pad);
2930
2931   ret = callback (pad, info, hook->data);
2932
2933   GST_OBJECT_LOCK (pad);
2934
2935   switch (ret) {
2936     case GST_PAD_PROBE_REMOVE:
2937       /* remove the probe */
2938       GST_DEBUG_OBJECT (pad, "asked to remove hook");
2939       cleanup_hook (pad, hook);
2940       break;
2941     case GST_PAD_PROBE_DROP:
2942       /* need to drop the data, make sure other probes don't get called
2943        * anymore */
2944       GST_DEBUG_OBJECT (pad, "asked to drop item");
2945       info->type = GST_PAD_PROBE_TYPE_INVALID;
2946       data->dropped = TRUE;
2947       break;
2948     case GST_PAD_PROBE_PASS:
2949       /* inform the pad block to let things pass */
2950       GST_DEBUG_OBJECT (pad, "asked to pass item");
2951       data->pass = TRUE;
2952       break;
2953     default:
2954       GST_DEBUG_OBJECT (pad, "probe returned %d", ret);
2955       break;
2956   }
2957   return;
2958
2959 no_match:
2960   {
2961     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
2962         "hook %lu, cookie %u with flags 0x%08x does not match %08x",
2963         hook->hook_id, PROBE_COOKIE (hook), flags, info->type);
2964     return;
2965   }
2966 }
2967
2968 /* a probe that does not take or return any data */
2969 #define PROBE_NO_DATA(pad,mask,label,defaultval)                \
2970   G_STMT_START {                                                \
2971     if (G_UNLIKELY (pad->num_probes)) {                         \
2972       /* pass NULL as the data item */                          \
2973       GstPadProbeInfo info = { mask, 0, NULL, 0, 0 };           \
2974       ret = do_probe_callbacks (pad, &info, defaultval);        \
2975       if (G_UNLIKELY (ret != defaultval && ret != GST_FLOW_OK)) \
2976         goto label;                                             \
2977     }                                                           \
2978   } G_STMT_END
2979
2980 #define PROBE_FULL(pad,mask,data,offs,size,label)               \
2981   G_STMT_START {                                                \
2982     if (G_UNLIKELY (pad->num_probes)) {                         \
2983       /* pass the data item */                                  \
2984       GstPadProbeInfo info = { mask, 0, data, offs, size };     \
2985       ret = do_probe_callbacks (pad, &info, GST_FLOW_OK);       \
2986       /* store the possibly updated data item */                \
2987       data = GST_PAD_PROBE_INFO_DATA (&info);                   \
2988       /* if something went wrong, exit */                       \
2989       if (G_UNLIKELY (ret != GST_FLOW_OK))                      \
2990         goto label;                                             \
2991     }                                                           \
2992   } G_STMT_END
2993
2994 #define PROBE_PUSH(pad,mask,data,label)                          \
2995   PROBE_FULL(pad, mask, data, -1, -1, label);
2996 #define PROBE_PULL(pad,mask,data,offs,size,label)                \
2997   PROBE_FULL(pad, mask, data, offs, size, label);
2998
2999 static GstFlowReturn
3000 do_probe_callbacks (GstPad * pad, GstPadProbeInfo * info,
3001     GstFlowReturn defaultval)
3002 {
3003   ProbeMarshall data;
3004   guint cookie;
3005   gboolean is_block;
3006
3007   data.pad = pad;
3008   data.info = info;
3009   data.pass = FALSE;
3010   data.marshalled = FALSE;
3011   data.dropped = FALSE;
3012   data.cookie = ++pad->priv->probe_cookie;
3013
3014   is_block =
3015       (info->type & GST_PAD_PROBE_TYPE_BLOCK) == GST_PAD_PROBE_TYPE_BLOCK;
3016
3017 again:
3018   GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3019       "do probes cookie %u", data.cookie);
3020   cookie = pad->priv->probe_list_cookie;
3021
3022   g_hook_list_marshal (&pad->probes, TRUE,
3023       (GHookMarshaller) probe_hook_marshal, &data);
3024
3025   /* if the list changed, call the new callbacks (they will not have their
3026    * cookie set to data.cookie */
3027   if (cookie != pad->priv->probe_list_cookie) {
3028     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3029         "probe list changed, restarting");
3030     goto again;
3031   }
3032
3033   /* the first item that dropped will stop the hooks and then we drop here */
3034   if (data.dropped)
3035     goto dropped;
3036
3037   /* if no handler matched and we are blocking, let the item pass */
3038   if (!data.marshalled && is_block)
3039     goto passed;
3040
3041   /* At this point, all handlers returned either OK or PASS. If one handler
3042    * returned PASS, let the item pass */
3043   if (data.pass)
3044     goto passed;
3045
3046   if (is_block) {
3047     while (GST_PAD_IS_BLOCKED (pad)) {
3048       GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3049           "we are blocked %d times", pad->num_blocked);
3050
3051       /* we might have released the lock */
3052       if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3053         goto flushing;
3054
3055       /* now we block the streaming thread. It can be unlocked when we
3056        * deactivate the pad (which will also set the FLUSHING flag) or
3057        * when the pad is unblocked. A flushing event will also unblock
3058        * the pad after setting the FLUSHING flag. */
3059       GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3060           "Waiting to be unblocked or set flushing");
3061       GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_BLOCKING);
3062       GST_PAD_BLOCK_WAIT (pad);
3063       GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_BLOCKING);
3064       GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "We got unblocked");
3065
3066       if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3067         goto flushing;
3068     }
3069   }
3070
3071   return defaultval;
3072
3073   /* ERRORS */
3074 flushing:
3075   {
3076     GST_DEBUG_OBJECT (pad, "pad is flushing");
3077     return GST_FLOW_FLUSHING;
3078   }
3079 dropped:
3080   {
3081     GST_DEBUG_OBJECT (pad, "data is dropped");
3082     return GST_FLOW_CUSTOM_SUCCESS;
3083   }
3084 passed:
3085   {
3086     /* FIXME : Should we return FLOW_OK or the defaultval ?? */
3087     GST_DEBUG_OBJECT (pad, "data is passed");
3088     return GST_FLOW_OK;
3089   }
3090 }
3091
3092 /* pad offsets */
3093
3094 /**
3095  * gst_pad_get_offset:
3096  * @pad: a #GstPad
3097  *
3098  * Get the offset applied to the running time of @pad. @pad has to be a source
3099  * pad.
3100  *
3101  * Returns: the offset.
3102  */
3103 gint64
3104 gst_pad_get_offset (GstPad * pad)
3105 {
3106   gint64 result;
3107
3108   g_return_val_if_fail (GST_IS_PAD (pad), 0);
3109
3110   GST_OBJECT_LOCK (pad);
3111   result = pad->offset;
3112   GST_OBJECT_UNLOCK (pad);
3113
3114   return result;
3115 }
3116
3117 /**
3118  * gst_pad_set_offset:
3119  * @pad: a #GstPad
3120  * @offset: the offset
3121  *
3122  * Set the offset that will be applied to the running time of @pad.
3123  */
3124 void
3125 gst_pad_set_offset (GstPad * pad, gint64 offset)
3126 {
3127   PadEvent *ev;
3128
3129   g_return_if_fail (GST_IS_PAD (pad));
3130
3131   GST_OBJECT_LOCK (pad);
3132   /* if nothing changed, do nothing */
3133   if (pad->offset == offset)
3134     goto done;
3135
3136   pad->offset = offset;
3137   GST_DEBUG_OBJECT (pad, "changed offset to %" G_GINT64_FORMAT, offset);
3138
3139   /* sinkpads will apply their offset the next time a segment
3140    * event is received. */
3141   if (GST_PAD_IS_SINK (pad))
3142     goto done;
3143
3144   /* resend the last segment event on next buffer push */
3145   if ((ev = find_event_by_type (pad, GST_EVENT_SEGMENT, 0))) {
3146     ev->received = FALSE;
3147     GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3148   }
3149
3150 done:
3151   GST_OBJECT_UNLOCK (pad);
3152 }
3153
3154 /* should be called with pad LOCK */
3155 static gboolean
3156 push_sticky (GstPad * pad, PadEvent * ev, gpointer user_data)
3157 {
3158   GstFlowReturn *data = user_data;
3159   GstEvent *event = ev->event;
3160
3161   if (ev->received) {
3162     GST_DEBUG_OBJECT (pad, "event %s was already received",
3163         GST_EVENT_TYPE_NAME (event));
3164     return TRUE;
3165   }
3166
3167   *data = gst_pad_push_event_unchecked (pad, gst_event_ref (event),
3168       GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM);
3169
3170   switch (*data) {
3171     case GST_FLOW_OK:
3172       ev->received = TRUE;
3173       GST_DEBUG_OBJECT (pad, "event %s marked received",
3174           GST_EVENT_TYPE_NAME (event));
3175       break;
3176     case GST_FLOW_NOT_LINKED:
3177       /* not linked is not a problem, we are sticky so the event will be
3178        * sent later */
3179       GST_DEBUG_OBJECT (pad, "pad was not linked");
3180       *data = GST_FLOW_OK;
3181       /* fallthrough */
3182     default:
3183       GST_DEBUG_OBJECT (pad, "mark pending events");
3184       GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3185       break;
3186   }
3187   return *data == GST_FLOW_OK;
3188 }
3189
3190 /* check sticky events and push them when needed. should be called
3191  * with pad LOCK */
3192 static inline GstFlowReturn
3193 check_sticky (GstPad * pad)
3194 {
3195   GstFlowReturn ret = GST_FLOW_OK;
3196
3197   if (G_UNLIKELY (GST_PAD_HAS_PENDING_EVENTS (pad))) {
3198     GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PENDING_EVENTS);
3199
3200     GST_DEBUG_OBJECT (pad, "pushing all sticky events");
3201     events_foreach (pad, push_sticky, &ret);
3202   }
3203   return ret;
3204 }
3205
3206
3207 /**
3208  * gst_pad_query:
3209  * @pad: a #GstPad to invoke the default query on.
3210  * @query: (transfer none): the #GstQuery to perform.
3211  *
3212  * Dispatches a query to a pad. The query should have been allocated by the
3213  * caller via one of the type-specific allocation functions. The element that
3214  * the pad belongs to is responsible for filling the query with an appropriate
3215  * response, which should then be parsed with a type-specific query parsing
3216  * function.
3217  *
3218  * Again, the caller is responsible for both the allocation and deallocation of
3219  * the query structure.
3220  *
3221  * Please also note that some queries might need a running pipeline to work.
3222  *
3223  * Returns: TRUE if the query could be performed.
3224  */
3225 gboolean
3226 gst_pad_query (GstPad * pad, GstQuery * query)
3227 {
3228   GstObject *parent;
3229   gboolean res, serialized;
3230   GstPadQueryFunction func;
3231   GstPadProbeType type;
3232   GstFlowReturn ret;
3233
3234   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3235   g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
3236
3237   if (GST_PAD_IS_SRC (pad)) {
3238     if (G_UNLIKELY (!GST_QUERY_IS_UPSTREAM (query)))
3239       goto wrong_direction;
3240     type = GST_PAD_PROBE_TYPE_QUERY_UPSTREAM;
3241   } else if (GST_PAD_IS_SINK (pad)) {
3242     if (G_UNLIKELY (!GST_QUERY_IS_DOWNSTREAM (query)))
3243       goto wrong_direction;
3244     type = GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM;
3245   } else
3246     goto unknown_direction;
3247
3248   GST_DEBUG_OBJECT (pad, "doing query %p (%s)", query,
3249       GST_QUERY_TYPE_NAME (query));
3250
3251   serialized = GST_QUERY_IS_SERIALIZED (query);
3252   if (G_UNLIKELY (serialized))
3253     GST_PAD_STREAM_LOCK (pad);
3254
3255   GST_OBJECT_LOCK (pad);
3256   PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
3257       GST_PAD_PROBE_TYPE_BLOCK, query, probe_stopped);
3258   PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, query, probe_stopped);
3259
3260   ACQUIRE_PARENT (pad, parent, no_parent);
3261   GST_OBJECT_UNLOCK (pad);
3262
3263   if ((func = GST_PAD_QUERYFUNC (pad)) == NULL)
3264     goto no_func;
3265
3266   res = func (pad, parent, query);
3267
3268   RELEASE_PARENT (parent);
3269
3270   GST_DEBUG_OBJECT (pad, "sent query %p (%s), result %d", query,
3271       GST_QUERY_TYPE_NAME (query), res);
3272
3273   if (res != TRUE)
3274     goto query_failed;
3275
3276   GST_OBJECT_LOCK (pad);
3277   PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PULL, query, probe_stopped);
3278   GST_OBJECT_UNLOCK (pad);
3279
3280   if (G_UNLIKELY (serialized))
3281     GST_PAD_STREAM_UNLOCK (pad);
3282
3283   return res;
3284
3285   /* ERRORS */
3286 wrong_direction:
3287   {
3288     g_warning ("pad %s:%s query %s in wrong direction",
3289         GST_DEBUG_PAD_NAME (pad), GST_QUERY_TYPE_NAME (query));
3290     return FALSE;
3291   }
3292 unknown_direction:
3293   {
3294     g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
3295     return FALSE;
3296   }
3297 no_parent:
3298   {
3299     GST_DEBUG_OBJECT (pad, "had no parent");
3300     GST_OBJECT_UNLOCK (pad);
3301     if (G_UNLIKELY (serialized))
3302       GST_PAD_STREAM_UNLOCK (pad);
3303     return FALSE;
3304   }
3305 no_func:
3306   {
3307     GST_DEBUG_OBJECT (pad, "had no query function");
3308     RELEASE_PARENT (parent);
3309     if (G_UNLIKELY (serialized))
3310       GST_PAD_STREAM_UNLOCK (pad);
3311     return FALSE;
3312   }
3313 query_failed:
3314   {
3315     GST_DEBUG_OBJECT (pad, "query failed");
3316     if (G_UNLIKELY (serialized))
3317       GST_PAD_STREAM_UNLOCK (pad);
3318     return FALSE;
3319   }
3320 probe_stopped:
3321   {
3322     GST_DEBUG_OBJECT (pad, "probe stopped: %s", gst_flow_get_name (ret));
3323     GST_OBJECT_UNLOCK (pad);
3324     if (G_UNLIKELY (serialized))
3325       GST_PAD_STREAM_UNLOCK (pad);
3326
3327     /* if a probe dropped, we don't sent it further but assume that the probe
3328      * answered the query and return TRUE */
3329     if (ret == GST_FLOW_CUSTOM_SUCCESS)
3330       res = TRUE;
3331     else
3332       res = FALSE;
3333
3334     return res;
3335   }
3336 }
3337
3338 /**
3339  * gst_pad_peer_query:
3340  * @pad: a #GstPad to invoke the peer query on.
3341  * @query: (transfer none): the #GstQuery to perform.
3342  *
3343  * Performs gst_pad_query() on the peer of @pad.
3344  *
3345  * The caller is responsible for both the allocation and deallocation of
3346  * the query structure.
3347  *
3348  * Returns: TRUE if the query could be performed. This function returns %FALSE
3349  * if @pad has no peer.
3350  *
3351  * Since: 0.10.15
3352  */
3353 gboolean
3354 gst_pad_peer_query (GstPad * pad, GstQuery * query)
3355 {
3356   GstPad *peerpad;
3357   GstPadProbeType type;
3358   gboolean res, serialized;
3359   GstFlowReturn ret;
3360
3361   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3362   g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
3363
3364   if (GST_PAD_IS_SRC (pad)) {
3365     if (G_UNLIKELY (!GST_QUERY_IS_DOWNSTREAM (query)))
3366       goto wrong_direction;
3367     type = GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM;
3368   } else if (GST_PAD_IS_SINK (pad)) {
3369     if (G_UNLIKELY (!GST_QUERY_IS_UPSTREAM (query)))
3370       goto wrong_direction;
3371     type = GST_PAD_PROBE_TYPE_QUERY_UPSTREAM;
3372   } else
3373     goto unknown_direction;
3374
3375   GST_DEBUG_OBJECT (pad, "peer query %p (%s)", query,
3376       GST_QUERY_TYPE_NAME (query));
3377
3378   serialized = GST_QUERY_IS_SERIALIZED (query);
3379
3380   GST_OBJECT_LOCK (pad);
3381   if (GST_PAD_IS_SRC (pad) && serialized) {
3382     /* all serialized queries on the srcpad trigger push of
3383      * sticky events */
3384     if (!check_sticky (pad) == GST_FLOW_OK)
3385       goto sticky_failed;
3386   }
3387
3388   PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
3389       GST_PAD_PROBE_TYPE_BLOCK, query, probe_stopped);
3390   PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, query, probe_stopped);
3391
3392   peerpad = GST_PAD_PEER (pad);
3393   if (G_UNLIKELY (peerpad == NULL))
3394     goto no_peer;
3395
3396   gst_object_ref (peerpad);
3397   GST_OBJECT_UNLOCK (pad);
3398
3399   res = gst_pad_query (peerpad, query);
3400
3401   gst_object_unref (peerpad);
3402
3403   if (res != TRUE)
3404     goto query_failed;
3405
3406   GST_OBJECT_LOCK (pad);
3407   PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PULL, query, probe_stopped);
3408   GST_OBJECT_UNLOCK (pad);
3409
3410   return res;
3411
3412   /* ERRORS */
3413 wrong_direction:
3414   {
3415     g_warning ("pad %s:%s query %s in wrong direction",
3416         GST_DEBUG_PAD_NAME (pad), GST_QUERY_TYPE_NAME (query));
3417     return FALSE;
3418   }
3419 unknown_direction:
3420   {
3421     g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
3422     return FALSE;
3423   }
3424 sticky_failed:
3425   {
3426     GST_WARNING_OBJECT (pad, "could not send sticky events");
3427     GST_OBJECT_UNLOCK (pad);
3428     return FALSE;
3429   }
3430 no_peer:
3431   {
3432     GST_WARNING_OBJECT (pad, "pad has no peer");
3433     GST_OBJECT_UNLOCK (pad);
3434     return FALSE;
3435   }
3436 query_failed:
3437   {
3438     GST_DEBUG_OBJECT (pad, "query failed");
3439     return FALSE;
3440   }
3441 probe_stopped:
3442   {
3443     GST_DEBUG_OBJECT (pad, "probe stopped: %s", gst_flow_get_name (ret));
3444     GST_OBJECT_UNLOCK (pad);
3445
3446     /* if a probe dropped, we don't sent it further but assume that the probe
3447      * answered the query and return TRUE */
3448     if (ret == GST_FLOW_CUSTOM_SUCCESS)
3449       res = TRUE;
3450     else
3451       res = FALSE;
3452
3453     return res;
3454   }
3455 }
3456
3457 /**********************************************************************
3458  * Data passing functions
3459  */
3460
3461 /* this is the chain function that does not perform the additional argument
3462  * checking for that little extra speed.
3463  */
3464 static inline GstFlowReturn
3465 gst_pad_chain_data_unchecked (GstPad * pad, GstPadProbeType type, void *data)
3466 {
3467   GstFlowReturn ret;
3468   GstObject *parent;
3469
3470   GST_PAD_STREAM_LOCK (pad);
3471
3472   GST_OBJECT_LOCK (pad);
3473   if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3474     goto flushing;
3475
3476   if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PUSH))
3477     goto wrong_mode;
3478
3479   PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_BLOCK, data, probe_stopped);
3480
3481   PROBE_PUSH (pad, type, data, probe_stopped);
3482
3483   parent = GST_OBJECT_PARENT (pad);
3484   GST_OBJECT_UNLOCK (pad);
3485
3486   /* NOTE: we read the chainfunc unlocked.
3487    * we cannot hold the lock for the pad so we might send
3488    * the data to the wrong function. This is not really a
3489    * problem since functions are assigned at creation time
3490    * and don't change that often... */
3491   if (G_LIKELY (type & GST_PAD_PROBE_TYPE_BUFFER)) {
3492     GstPadChainFunction chainfunc;
3493
3494     if (G_UNLIKELY ((chainfunc = GST_PAD_CHAINFUNC (pad)) == NULL))
3495       goto no_function;
3496
3497     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3498         "calling chainfunction &%s with buffer %" GST_PTR_FORMAT,
3499         GST_DEBUG_FUNCPTR_NAME (chainfunc), GST_BUFFER (data));
3500
3501     ret = chainfunc (pad, parent, GST_BUFFER_CAST (data));
3502
3503     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3504         "called chainfunction &%s with buffer %p, returned %s",
3505         GST_DEBUG_FUNCPTR_NAME (chainfunc), data, gst_flow_get_name (ret));
3506   } else {
3507     GstPadChainListFunction chainlistfunc;
3508
3509     if (G_UNLIKELY ((chainlistfunc = GST_PAD_CHAINLISTFUNC (pad)) == NULL))
3510       goto no_function;
3511
3512     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3513         "calling chainlistfunction &%s",
3514         GST_DEBUG_FUNCPTR_NAME (chainlistfunc));
3515
3516     ret = chainlistfunc (pad, parent, GST_BUFFER_LIST_CAST (data));
3517
3518     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3519         "called chainlistfunction &%s, returned %s",
3520         GST_DEBUG_FUNCPTR_NAME (chainlistfunc), gst_flow_get_name (ret));
3521   }
3522
3523   GST_PAD_STREAM_UNLOCK (pad);
3524
3525   return ret;
3526
3527   /* ERRORS */
3528 flushing:
3529   {
3530     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3531         "chaining, but pad was flushing");
3532     GST_OBJECT_UNLOCK (pad);
3533     GST_PAD_STREAM_UNLOCK (pad);
3534     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3535     return GST_FLOW_FLUSHING;
3536   }
3537 wrong_mode:
3538   {
3539     g_critical ("chain on pad %s:%s but it was not in push mode",
3540         GST_DEBUG_PAD_NAME (pad));
3541     GST_OBJECT_UNLOCK (pad);
3542     GST_PAD_STREAM_UNLOCK (pad);
3543     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3544     return GST_FLOW_ERROR;
3545   }
3546 probe_stopped:
3547   {
3548     GST_OBJECT_UNLOCK (pad);
3549     GST_PAD_STREAM_UNLOCK (pad);
3550     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3551
3552     switch (ret) {
3553       case GST_FLOW_CUSTOM_SUCCESS:
3554         GST_DEBUG_OBJECT (pad, "dropped buffer");
3555         ret = GST_FLOW_OK;
3556         break;
3557       default:
3558         GST_DEBUG_OBJECT (pad, "an error occured %s", gst_flow_get_name (ret));
3559         break;
3560     }
3561     return ret;
3562   }
3563 no_function:
3564   {
3565     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3566     g_critical ("chain on pad %s:%s but it has no chainfunction",
3567         GST_DEBUG_PAD_NAME (pad));
3568     GST_PAD_STREAM_UNLOCK (pad);
3569     return GST_FLOW_NOT_SUPPORTED;
3570   }
3571 }
3572
3573 /**
3574  * gst_pad_chain:
3575  * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
3576  * @buffer: (transfer full): the #GstBuffer to send, return GST_FLOW_ERROR
3577  *     if not.
3578  *
3579  * Chain a buffer to @pad.
3580  *
3581  * The function returns #GST_FLOW_FLUSHING if the pad was flushing.
3582  *
3583  * If the buffer type is not acceptable for @pad (as negotiated with a
3584  * preceeding GST_EVENT_CAPS event), this function returns
3585  * #GST_FLOW_NOT_NEGOTIATED.
3586  *
3587  * The function proceeds calling the chain function installed on @pad (see
3588  * gst_pad_set_chain_function()) and the return value of that function is
3589  * returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
3590  * chain function.
3591  *
3592  * In all cases, success or failure, the caller loses its reference to @buffer
3593  * after calling this function.
3594  *
3595  * Returns: a #GstFlowReturn from the pad.
3596  *
3597  * MT safe.
3598  */
3599 GstFlowReturn
3600 gst_pad_chain (GstPad * pad, GstBuffer * buffer)
3601 {
3602   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3603   g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
3604   g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
3605
3606   return gst_pad_chain_data_unchecked (pad,
3607       GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH, buffer);
3608 }
3609
3610 static GstFlowReturn
3611 gst_pad_chain_list_default (GstPad * pad, GstObject * parent,
3612     GstBufferList * list)
3613 {
3614   guint i, len;
3615   GstBuffer *buffer;
3616   GstFlowReturn ret;
3617
3618   GST_INFO_OBJECT (pad, "chaining each group in list as a merged buffer");
3619
3620   len = gst_buffer_list_length (list);
3621
3622   ret = GST_FLOW_OK;
3623   for (i = 0; i < len; i++) {
3624     buffer = gst_buffer_list_get (list, i);
3625     ret =
3626         gst_pad_chain_data_unchecked (pad,
3627         GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH,
3628         gst_buffer_ref (buffer));
3629     if (ret != GST_FLOW_OK)
3630       break;
3631   }
3632   gst_buffer_list_unref (list);
3633
3634   return ret;
3635 }
3636
3637 /**
3638  * gst_pad_chain_list:
3639  * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
3640  * @list: (transfer full): the #GstBufferList to send, return GST_FLOW_ERROR
3641  *     if not.
3642  *
3643  * Chain a bufferlist to @pad.
3644  *
3645  * The function returns #GST_FLOW_FLUSHING if the pad was flushing.
3646  *
3647  * If @pad was not negotiated properly with a CAPS event, this function
3648  * returns #GST_FLOW_NOT_NEGOTIATED.
3649  *
3650  * The function proceeds calling the chainlist function installed on @pad (see
3651  * gst_pad_set_chain_list_function()) and the return value of that function is
3652  * returned to the caller. #GST_FLOW_NOT_SUPPORTED is returned if @pad has no
3653  * chainlist function.
3654  *
3655  * In all cases, success or failure, the caller loses its reference to @list
3656  * after calling this function.
3657  *
3658  * MT safe.
3659  *
3660  * Returns: a #GstFlowReturn from the pad.
3661  *
3662  * Since: 0.10.24
3663  */
3664 GstFlowReturn
3665 gst_pad_chain_list (GstPad * pad, GstBufferList * list)
3666 {
3667   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3668   g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
3669   g_return_val_if_fail (GST_IS_BUFFER_LIST (list), GST_FLOW_ERROR);
3670
3671   return gst_pad_chain_data_unchecked (pad,
3672       GST_PAD_PROBE_TYPE_BUFFER_LIST | GST_PAD_PROBE_TYPE_PUSH, list);
3673 }
3674
3675 static GstFlowReturn
3676 gst_pad_push_data (GstPad * pad, GstPadProbeType type, void *data)
3677 {
3678   GstPad *peer;
3679   GstFlowReturn ret;
3680
3681   GST_OBJECT_LOCK (pad);
3682   if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3683     goto flushing;
3684
3685   if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PUSH))
3686     goto wrong_mode;
3687
3688   if (G_UNLIKELY ((ret = check_sticky (pad))) != GST_FLOW_OK)
3689     goto events_error;
3690
3691   /* do block probes */
3692   PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_BLOCK, data, probe_stopped);
3693
3694   /* do post-blocking probes */
3695   PROBE_PUSH (pad, type, data, probe_stopped);
3696
3697   if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
3698     goto not_linked;
3699
3700   /* take ref to peer pad before releasing the lock */
3701   gst_object_ref (peer);
3702   pad->priv->using++;
3703   GST_OBJECT_UNLOCK (pad);
3704
3705   ret = gst_pad_chain_data_unchecked (peer, type, data);
3706
3707   gst_object_unref (peer);
3708
3709   GST_OBJECT_LOCK (pad);
3710   pad->priv->using--;
3711   if (pad->priv->using == 0) {
3712     /* pad is not active anymore, trigger idle callbacks */
3713     PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PUSH | GST_PAD_PROBE_TYPE_IDLE,
3714         probe_stopped, ret);
3715   }
3716   GST_OBJECT_UNLOCK (pad);
3717
3718   return ret;
3719
3720   /* ERROR recovery here */
3721   /* ERRORS */
3722 flushing:
3723   {
3724     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3725         "pushing, but pad was flushing");
3726     GST_OBJECT_UNLOCK (pad);
3727     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3728     return GST_FLOW_FLUSHING;
3729   }
3730 wrong_mode:
3731   {
3732     g_critical ("pushing on pad %s:%s but it was not activated in push mode",
3733         GST_DEBUG_PAD_NAME (pad));
3734     GST_OBJECT_UNLOCK (pad);
3735     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3736     return GST_FLOW_ERROR;
3737   }
3738 events_error:
3739   {
3740     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3741         "error pushing events, return %s", gst_flow_get_name (ret));
3742     GST_OBJECT_UNLOCK (pad);
3743     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3744     return ret;
3745   }
3746 probe_stopped:
3747   {
3748     GST_OBJECT_UNLOCK (pad);
3749     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3750
3751     switch (ret) {
3752       case GST_FLOW_CUSTOM_SUCCESS:
3753         GST_DEBUG_OBJECT (pad, "dropped buffer");
3754         ret = GST_FLOW_OK;
3755         break;
3756       default:
3757         GST_DEBUG_OBJECT (pad, "an error occured %s", gst_flow_get_name (ret));
3758         break;
3759     }
3760     return ret;
3761   }
3762 not_linked:
3763   {
3764     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3765         "pushing, but it was not linked");
3766     GST_OBJECT_UNLOCK (pad);
3767     gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3768     return GST_FLOW_NOT_LINKED;
3769   }
3770 }
3771
3772 /**
3773  * gst_pad_push:
3774  * @pad: a source #GstPad, returns #GST_FLOW_ERROR if not.
3775  * @buffer: (transfer full): the #GstBuffer to push returns GST_FLOW_ERROR
3776  *     if not.
3777  *
3778  * Pushes a buffer to the peer of @pad.
3779  *
3780  * This function will call installed block probes before triggering any
3781  * installed data probes.
3782  *
3783  * The function proceeds calling gst_pad_chain() on the peer pad and returns
3784  * the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
3785  * be returned.
3786  *
3787  * In all cases, success or failure, the caller loses its reference to @buffer
3788  * after calling this function.
3789  *
3790  * Returns: a #GstFlowReturn from the peer pad.
3791  *
3792  * MT safe.
3793  */
3794 GstFlowReturn
3795 gst_pad_push (GstPad * pad, GstBuffer * buffer)
3796 {
3797   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3798   g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
3799   g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
3800
3801   return gst_pad_push_data (pad,
3802       GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_PUSH, buffer);
3803 }
3804
3805 /**
3806  * gst_pad_push_list:
3807  * @pad: a source #GstPad, returns #GST_FLOW_ERROR if not.
3808  * @list: (transfer full): the #GstBufferList to push returns GST_FLOW_ERROR
3809  *     if not.
3810  *
3811  * Pushes a buffer list to the peer of @pad.
3812  *
3813  * This function will call installed block probes before triggering any
3814  * installed data probes.
3815  *
3816  * The function proceeds calling the chain function on the peer pad and returns
3817  * the value from that function. If @pad has no peer, #GST_FLOW_NOT_LINKED will
3818  * be returned. If the peer pad does not have any installed chainlist function
3819  * every group buffer of the list will be merged into a normal #GstBuffer and
3820  * chained via gst_pad_chain().
3821  *
3822  * In all cases, success or failure, the caller loses its reference to @list
3823  * after calling this function.
3824  *
3825  * Returns: a #GstFlowReturn from the peer pad.
3826  *
3827  * MT safe.
3828  *
3829  * Since: 0.10.24
3830  */
3831 GstFlowReturn
3832 gst_pad_push_list (GstPad * pad, GstBufferList * list)
3833 {
3834   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3835   g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
3836   g_return_val_if_fail (GST_IS_BUFFER_LIST (list), GST_FLOW_ERROR);
3837
3838   return gst_pad_push_data (pad,
3839       GST_PAD_PROBE_TYPE_BUFFER_LIST | GST_PAD_PROBE_TYPE_PUSH, list);
3840 }
3841
3842 static GstFlowReturn
3843 gst_pad_get_range_unchecked (GstPad * pad, guint64 offset, guint size,
3844     GstBuffer ** buffer)
3845 {
3846   GstFlowReturn ret;
3847   GstPadGetRangeFunction getrangefunc;
3848   GstObject *parent;
3849   GstBuffer *res_buf;
3850
3851   GST_PAD_STREAM_LOCK (pad);
3852
3853   GST_OBJECT_LOCK (pad);
3854   if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3855     goto flushing;
3856
3857   if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PULL))
3858     goto wrong_mode;
3859
3860   if (G_UNLIKELY ((ret = check_sticky (pad))) != GST_FLOW_OK)
3861     goto events_error;
3862
3863   res_buf = *buffer;
3864
3865   /* when one of the probes returns DROPPED, probe_stopped will be called
3866    * and we skip calling the getrange function, res_buf should then contain a
3867    * valid result buffer */
3868   PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BLOCK,
3869       res_buf, offset, size, probe_stopped);
3870
3871   ACQUIRE_PARENT (pad, parent, no_parent);
3872   GST_OBJECT_UNLOCK (pad);
3873
3874   if (G_UNLIKELY ((getrangefunc = GST_PAD_GETRANGEFUNC (pad)) == NULL))
3875     goto no_function;
3876
3877   GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3878       "calling getrangefunc %s, offset %"
3879       G_GUINT64_FORMAT ", size %u",
3880       GST_DEBUG_FUNCPTR_NAME (getrangefunc), offset, size);
3881
3882   ret = getrangefunc (pad, parent, offset, size, &res_buf);
3883
3884   RELEASE_PARENT (parent);
3885
3886   if (G_UNLIKELY (ret != GST_FLOW_OK))
3887     goto get_range_failed;
3888
3889   /* can only fire the signal if we have a valid buffer */
3890   GST_OBJECT_LOCK (pad);
3891 probed_data:
3892   PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BUFFER,
3893       res_buf, offset, size, probe_stopped_unref);
3894   GST_OBJECT_UNLOCK (pad);
3895
3896   GST_PAD_STREAM_UNLOCK (pad);
3897
3898   *buffer = res_buf;
3899
3900   return ret;
3901
3902   /* ERRORS */
3903 flushing:
3904   {
3905     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3906         "getrange, but pad was flushing");
3907     GST_OBJECT_UNLOCK (pad);
3908     GST_PAD_STREAM_UNLOCK (pad);
3909     return GST_FLOW_FLUSHING;
3910   }
3911 wrong_mode:
3912   {
3913     g_critical ("getrange on pad %s:%s but it was not activated in pull mode",
3914         GST_DEBUG_PAD_NAME (pad));
3915     GST_OBJECT_UNLOCK (pad);
3916     GST_PAD_STREAM_UNLOCK (pad);
3917     return GST_FLOW_ERROR;
3918   }
3919 events_error:
3920   {
3921     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "error pushing events");
3922     GST_OBJECT_UNLOCK (pad);
3923     GST_PAD_STREAM_UNLOCK (pad);
3924     return ret;
3925   }
3926 no_parent:
3927   {
3928     GST_DEBUG_OBJECT (pad, "no parent");
3929     GST_OBJECT_UNLOCK (pad);
3930     GST_PAD_STREAM_UNLOCK (pad);
3931     return GST_FLOW_FLUSHING;
3932   }
3933 no_function:
3934   {
3935     g_critical ("getrange on pad %s:%s but it has no getrangefunction",
3936         GST_DEBUG_PAD_NAME (pad));
3937     RELEASE_PARENT (parent);
3938     GST_PAD_STREAM_UNLOCK (pad);
3939     return GST_FLOW_NOT_SUPPORTED;
3940   }
3941 probe_stopped:
3942   {
3943     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3944         "probe returned %s", gst_flow_get_name (ret));
3945     if (ret == GST_FLOW_CUSTOM_SUCCESS) {
3946       if (res_buf) {
3947         /* the probe filled the buffer and asks us to not call the getrange
3948          * anymore, we continue with the post probes then. */
3949         GST_DEBUG_OBJECT (pad, "handled buffer");
3950         ret = GST_FLOW_OK;
3951         goto probed_data;
3952       } else {
3953         /* no buffer, we are EOS */
3954         GST_DEBUG_OBJECT (pad, "no buffer, return EOS");
3955         ret = GST_FLOW_EOS;
3956       }
3957     }
3958     GST_OBJECT_UNLOCK (pad);
3959     GST_PAD_STREAM_UNLOCK (pad);
3960
3961     return ret;
3962   }
3963 probe_stopped_unref:
3964   {
3965     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3966         "probe returned %s", gst_flow_get_name (ret));
3967     /* if we drop here, it signals EOS */
3968     if (ret == GST_FLOW_CUSTOM_SUCCESS)
3969       ret = GST_FLOW_EOS;
3970     GST_OBJECT_UNLOCK (pad);
3971     GST_PAD_STREAM_UNLOCK (pad);
3972     if (*buffer == NULL)
3973       gst_buffer_unref (res_buf);
3974     return ret;
3975   }
3976 get_range_failed:
3977   {
3978     GST_PAD_STREAM_UNLOCK (pad);
3979     GST_CAT_LEVEL_LOG (GST_CAT_SCHEDULING,
3980         (ret >= GST_FLOW_EOS) ? GST_LEVEL_INFO : GST_LEVEL_WARNING,
3981         pad, "getrange failed, flow: %s", gst_flow_get_name (ret));
3982     return ret;
3983   }
3984 }
3985
3986 /**
3987  * gst_pad_get_range:
3988  * @pad: a src #GstPad, returns #GST_FLOW_ERROR if not.
3989  * @offset: The start offset of the buffer
3990  * @size: The length of the buffer
3991  * @buffer: (out callee-allocates): a pointer to hold the #GstBuffer,
3992  *     returns #GST_FLOW_ERROR if %NULL.
3993  *
3994  * When @pad is flushing this function returns #GST_FLOW_FLUSHING
3995  * immediately and @buffer is %NULL.
3996  *
3997  * Calls the getrange function of @pad, see #GstPadGetRangeFunction for a
3998  * description of a getrange function. If @pad has no getrange function
3999  * installed (see gst_pad_set_getrange_function()) this function returns
4000  * #GST_FLOW_NOT_SUPPORTED.
4001  *
4002  * If @buffer points to a variable holding NULL, a valid new #GstBuffer will be
4003  * placed in @buffer when this function returns #GST_FLOW_OK. The new buffer
4004  * must be freed with gst_buffer_unref() after usage.
4005  *
4006  * When @buffer points to a variable that points to a valid #GstBuffer, the
4007  * buffer will be filled with the result data when this function returns
4008  * #GST_FLOW_OK. If the provided buffer is larger than @size, only
4009  * @size bytes will be filled in the result buffer and its size will be updated
4010  * accordingly.
4011  *
4012  * Note that less than @size bytes can be returned in @buffer when, for example,
4013  * an EOS condition is near or when @buffer is not large enough to hold @size
4014  * bytes. The caller should check the result buffer size to get the result size.
4015  *
4016  * When this function returns any other result value than #GST_FLOW_OK, @buffer
4017  * will be unchanged.
4018  *
4019  * This is a lowlevel function. Usualy gst_pad_pull_range() is used.
4020  *
4021  * Returns: a #GstFlowReturn from the pad.
4022  *
4023  * MT safe.
4024  */
4025 GstFlowReturn
4026 gst_pad_get_range (GstPad * pad, guint64 offset, guint size,
4027     GstBuffer ** buffer)
4028 {
4029   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4030   g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
4031   g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
4032   g_return_val_if_fail (*buffer == NULL
4033       || GST_IS_BUFFER (*buffer), GST_FLOW_ERROR);
4034
4035   return gst_pad_get_range_unchecked (pad, offset, size, buffer);
4036 }
4037
4038 /**
4039  * gst_pad_pull_range:
4040  * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not.
4041  * @offset: The start offset of the buffer
4042  * @size: The length of the buffer
4043  * @buffer: (out callee-allocates): a pointer to hold the #GstBuffer, returns
4044  *     GST_FLOW_ERROR if %NULL.
4045  *
4046  * Pulls a @buffer from the peer pad or fills up a provided buffer.
4047  *
4048  * This function will first trigger the pad block signal if it was
4049  * installed.
4050  *
4051  * When @pad is not linked #GST_FLOW_NOT_LINKED is returned else this
4052  * function returns the result of gst_pad_get_range() on the peer pad.
4053  * See gst_pad_get_range() for a list of return values and for the
4054  * semantics of the arguments of this function.
4055  *
4056  * If @buffer points to a variable holding NULL, a valid new #GstBuffer will be
4057  * placed in @buffer when this function returns #GST_FLOW_OK. The new buffer
4058  * must be freed with gst_buffer_unref() after usage. When this function
4059  * returns any other result value, @buffer will still point to NULL.
4060  *
4061  * When @buffer points to a variable that points to a valid #GstBuffer, the
4062  * buffer will be filled with the result data when this function returns
4063  * #GST_FLOW_OK. When this function returns any other result value,
4064  * @buffer will be unchanged. If the provided buffer is larger than @size, only
4065  * @size bytes will be filled in the result buffer and its size will be updated
4066  * accordingly.
4067  *
4068  * Note that less than @size bytes can be returned in @buffer when, for example,
4069  * an EOS condition is near or when @buffer is not large enough to hold @size
4070  * bytes. The caller should check the result buffer size to get the result size.
4071  *
4072  * Returns: a #GstFlowReturn from the peer pad.
4073  *
4074  * MT safe.
4075  */
4076 GstFlowReturn
4077 gst_pad_pull_range (GstPad * pad, guint64 offset, guint size,
4078     GstBuffer ** buffer)
4079 {
4080   GstPad *peer;
4081   GstFlowReturn ret;
4082   GstBuffer *res_buf;
4083
4084   g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
4085   g_return_val_if_fail (GST_PAD_IS_SINK (pad), GST_FLOW_ERROR);
4086   g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
4087   g_return_val_if_fail (*buffer == NULL
4088       || GST_IS_BUFFER (*buffer), GST_FLOW_ERROR);
4089
4090   GST_OBJECT_LOCK (pad);
4091   if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4092     goto flushing;
4093
4094   if (G_UNLIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_PULL))
4095     goto wrong_mode;
4096
4097   res_buf = *buffer;
4098
4099   /* when one of the probes returns DROPPED, probe_stopped will be
4100    * called and we skip calling the peer getrange function. *buffer should then
4101    * contain a valid buffer */
4102   PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BLOCK,
4103       res_buf, offset, size, probe_stopped);
4104
4105   if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
4106     goto not_linked;
4107
4108   gst_object_ref (peer);
4109   pad->priv->using++;
4110   GST_OBJECT_UNLOCK (pad);
4111
4112   ret = gst_pad_get_range_unchecked (peer, offset, size, &res_buf);
4113
4114   gst_object_unref (peer);
4115
4116   GST_OBJECT_LOCK (pad);
4117   pad->priv->using--;
4118   if (pad->priv->using == 0) {
4119     /* pad is not active anymore, trigger idle callbacks */
4120     PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_IDLE,
4121         probe_stopped_unref, ret);
4122   }
4123
4124   if (G_UNLIKELY (ret != GST_FLOW_OK))
4125     goto pull_range_failed;
4126
4127 probed_data:
4128   PROBE_PULL (pad, GST_PAD_PROBE_TYPE_PULL | GST_PAD_PROBE_TYPE_BUFFER,
4129       res_buf, offset, size, probe_stopped_unref);
4130
4131   GST_OBJECT_UNLOCK (pad);
4132
4133   *buffer = res_buf;
4134
4135   return ret;
4136
4137   /* ERROR recovery here */
4138 flushing:
4139   {
4140     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4141         "pullrange, but pad was flushing");
4142     GST_OBJECT_UNLOCK (pad);
4143     return GST_FLOW_FLUSHING;
4144   }
4145 wrong_mode:
4146   {
4147     g_critical ("pullrange on pad %s:%s but it was not activated in pull mode",
4148         GST_DEBUG_PAD_NAME (pad));
4149     GST_OBJECT_UNLOCK (pad);
4150     return GST_FLOW_ERROR;
4151   }
4152 probe_stopped:
4153   {
4154     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "pre probe returned %s",
4155         gst_flow_get_name (ret));
4156     if (ret == GST_FLOW_CUSTOM_SUCCESS) {
4157       if (res_buf) {
4158         /* the probe filled the buffer and asks us to not forward to the peer
4159          * anymore, we continue with the post probes then */
4160         GST_DEBUG_OBJECT (pad, "handled buffer");
4161         ret = GST_FLOW_OK;
4162         goto probed_data;
4163       } else {
4164         /* no buffer, we are EOS then */
4165         GST_DEBUG_OBJECT (pad, "no buffer, return EOS");
4166         ret = GST_FLOW_EOS;
4167       }
4168     }
4169     GST_OBJECT_UNLOCK (pad);
4170     return ret;
4171   }
4172 not_linked:
4173   {
4174     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4175         "pulling range, but it was not linked");
4176     GST_OBJECT_UNLOCK (pad);
4177     return GST_FLOW_NOT_LINKED;
4178   }
4179 pull_range_failed:
4180   {
4181     GST_OBJECT_UNLOCK (pad);
4182     GST_CAT_LEVEL_LOG (GST_CAT_SCHEDULING,
4183         (ret >= GST_FLOW_EOS) ? GST_LEVEL_INFO : GST_LEVEL_WARNING,
4184         pad, "pullrange failed, flow: %s", gst_flow_get_name (ret));
4185     return ret;
4186   }
4187 probe_stopped_unref:
4188   {
4189     GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
4190         "post probe returned %s", gst_flow_get_name (ret));
4191     GST_OBJECT_UNLOCK (pad);
4192     /* if we drop here, it signals EOS */
4193     if (ret == GST_FLOW_CUSTOM_SUCCESS)
4194       ret = GST_FLOW_EOS;
4195     if (*buffer == NULL)
4196       gst_buffer_unref (res_buf);
4197     return ret;
4198   }
4199 }
4200
4201 static gboolean
4202 gst_pad_store_sticky_event (GstPad * pad, GstEvent * event, gboolean locked)
4203 {
4204   guint i, len;
4205   GstEventType type;
4206   GArray *events;
4207   gboolean res = FALSE;
4208   const gchar *name = NULL;
4209
4210   type = GST_EVENT_TYPE (event);
4211   if (type & GST_EVENT_TYPE_STICKY_MULTI)
4212     name = gst_structure_get_name (gst_event_get_structure (event));
4213
4214   events = pad->priv->events;
4215   len = events->len;
4216
4217   for (i = 0; i < len; i++) {
4218     PadEvent *ev = &g_array_index (events, PadEvent, i);
4219
4220     if (ev->event == NULL)
4221       continue;
4222
4223     if (type == GST_EVENT_TYPE (ev->event)) {
4224       /* matching types, check matching name if needed */
4225       if (name && !gst_event_has_name (ev->event, name))
4226         continue;
4227
4228       /* overwrite */
4229       if ((res = gst_event_replace (&ev->event, event)))
4230         ev->received = FALSE;
4231       break;
4232     }
4233   }
4234   if (i == len) {
4235     PadEvent ev;
4236     ev.event = gst_event_ref (event);
4237     ev.received = FALSE;
4238     g_array_append_val (events, ev);
4239     res = TRUE;
4240   }
4241
4242   if (res) {
4243     pad->priv->events_cookie++;
4244     GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
4245
4246     GST_LOG_OBJECT (pad, "stored sticky event %s", GST_EVENT_TYPE_NAME (event));
4247
4248     switch (GST_EVENT_TYPE (event)) {
4249       case GST_EVENT_CAPS:
4250         if (locked)
4251           GST_OBJECT_UNLOCK (pad);
4252
4253         GST_DEBUG_OBJECT (pad, "notify caps");
4254         g_object_notify_by_pspec ((GObject *) pad, pspec_caps);
4255
4256         if (locked)
4257           GST_OBJECT_LOCK (pad);
4258         break;
4259       default:
4260         break;
4261     }
4262   }
4263   return res;
4264 }
4265
4266 /* should be called with pad LOCK */
4267 static GstFlowReturn
4268 gst_pad_push_event_unchecked (GstPad * pad, GstEvent * event,
4269     GstPadProbeType type)
4270 {
4271   GstFlowReturn ret;
4272   GstPad *peerpad;
4273   GstEventType event_type;
4274
4275   /* Two checks to be made:
4276    * . (un)set the FLUSHING flag for flushing events,
4277    * . handle pad blocking */
4278   event_type = GST_EVENT_TYPE (event);
4279   switch (event_type) {
4280     case GST_EVENT_FLUSH_START:
4281       GST_PAD_SET_FLUSHING (pad);
4282
4283       GST_PAD_BLOCK_BROADCAST (pad);
4284       type |= GST_PAD_PROBE_TYPE_EVENT_FLUSH;
4285       break;
4286     case GST_EVENT_FLUSH_STOP:
4287       GST_PAD_UNSET_FLUSHING (pad);
4288
4289       /* Remove sticky EOS events */
4290       GST_LOG_OBJECT (pad, "Removing pending EOS events");
4291       remove_event_by_type (pad, GST_EVENT_EOS);
4292
4293       type |= GST_PAD_PROBE_TYPE_EVENT_FLUSH;
4294       break;
4295     default:
4296     {
4297       if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4298         goto flushed;
4299
4300       switch (GST_EVENT_TYPE (event)) {
4301         case GST_EVENT_SEGMENT:
4302           /* pass the adjusted segment event on. We need to do this even if
4303            * there is no peer pad because of the probes. */
4304           event = apply_pad_offset (pad, event);
4305           break;
4306         case GST_EVENT_RECONFIGURE:
4307           if (GST_PAD_IS_SINK (pad))
4308             GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
4309           break;
4310         default:
4311           break;
4312       }
4313       PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH |
4314           GST_PAD_PROBE_TYPE_BLOCK, event, probe_stopped);
4315       break;
4316     }
4317   }
4318
4319   /* send probes after modifying the events above */
4320   PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, event, probe_stopped);
4321
4322   /* now check the peer pad */
4323   peerpad = GST_PAD_PEER (pad);
4324   if (peerpad == NULL)
4325     goto not_linked;
4326
4327   gst_object_ref (peerpad);
4328   pad->priv->using++;
4329   GST_OBJECT_UNLOCK (pad);
4330
4331   GST_LOG_OBJECT (pad, "sending event %p (%s) to peerpad %" GST_PTR_FORMAT,
4332       event, GST_EVENT_TYPE_NAME (event), peerpad);
4333
4334   ret = gst_pad_send_event_unchecked (peerpad, event, type);
4335
4336   /* Note: we gave away ownership of the event at this point but we can still
4337    * print the old pointer */
4338   GST_LOG_OBJECT (pad,
4339       "sent event %p to peerpad %" GST_PTR_FORMAT ", ret %s", event, peerpad,
4340       gst_flow_get_name (ret));
4341
4342   gst_object_unref (peerpad);
4343
4344   GST_OBJECT_LOCK (pad);
4345   pad->priv->using--;
4346   if (pad->priv->using == 0) {
4347     /* pad is not active anymore, trigger idle callbacks */
4348     PROBE_NO_DATA (pad, GST_PAD_PROBE_TYPE_PUSH | GST_PAD_PROBE_TYPE_IDLE,
4349         idle_probe_stopped, ret);
4350   }
4351   return ret;
4352
4353   /* ERROR handling */
4354 flushed:
4355   {
4356     GST_DEBUG_OBJECT (pad, "We're flushing");
4357     gst_event_unref (event);
4358     return GST_FLOW_FLUSHING;
4359   }
4360 probe_stopped:
4361   {
4362     GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
4363     gst_event_unref (event);
4364
4365     switch (ret) {
4366       case GST_FLOW_CUSTOM_SUCCESS:
4367         GST_DEBUG_OBJECT (pad, "dropped event");
4368         ret = GST_FLOW_OK;
4369         break;
4370       default:
4371         GST_DEBUG_OBJECT (pad, "an error occured %s", gst_flow_get_name (ret));
4372         break;
4373     }
4374     return ret;
4375   }
4376 not_linked:
4377   {
4378     GST_DEBUG_OBJECT (pad, "Dropping event because pad is not linked");
4379     GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PENDING_EVENTS);
4380     gst_event_unref (event);
4381     return GST_FLOW_NOT_LINKED;
4382   }
4383 idle_probe_stopped:
4384   {
4385     GST_DEBUG_OBJECT (pad, "Idle probe returned %s", gst_flow_get_name (ret));
4386     return ret;
4387   }
4388 }
4389
4390 /**
4391  * gst_pad_push_event:
4392  * @pad: a #GstPad to push the event to.
4393  * @event: (transfer full): the #GstEvent to send to the pad.
4394  *
4395  * Sends the event to the peer of the given pad. This function is
4396  * mainly used by elements to send events to their peer
4397  * elements.
4398  *
4399  * This function takes owership of the provided event so you should
4400  * gst_event_ref() it if you want to reuse the event after this call.
4401  *
4402  * Returns: TRUE if the event was handled.
4403  *
4404  * MT safe.
4405  */
4406 gboolean
4407 gst_pad_push_event (GstPad * pad, GstEvent * event)
4408 {
4409   gboolean res;
4410   GstPadProbeType type;
4411   gboolean sticky, serialized;
4412
4413   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4414   g_return_val_if_fail (GST_IS_EVENT (event), FALSE);
4415
4416   if (GST_PAD_IS_SRC (pad)) {
4417     if (G_UNLIKELY (!GST_EVENT_IS_DOWNSTREAM (event)))
4418       goto wrong_direction;
4419     type = GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM;
4420   } else if (GST_PAD_IS_SINK (pad)) {
4421     if (G_UNLIKELY (!GST_EVENT_IS_UPSTREAM (event)))
4422       goto wrong_direction;
4423     /* events pushed on sinkpad never are sticky */
4424     type = GST_PAD_PROBE_TYPE_EVENT_UPSTREAM;
4425   } else
4426     goto unknown_direction;
4427
4428   GST_OBJECT_LOCK (pad);
4429   sticky = GST_EVENT_IS_STICKY (event);
4430   serialized = GST_EVENT_IS_SERIALIZED (event);
4431
4432   if (sticky) {
4433     /* can't store on flushing pads */
4434     if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4435       goto flushed;
4436
4437     /* srcpad sticky events are store immediately, the received flag is set
4438      * to FALSE and will be set to TRUE when we can successfully push the
4439      * event to the peer pad */
4440     if (gst_pad_store_sticky_event (pad, event, TRUE)) {
4441       GST_DEBUG_OBJECT (pad, "event %s updated", GST_EVENT_TYPE_NAME (event));
4442     }
4443   }
4444   if (GST_PAD_IS_SRC (pad) && (serialized || sticky)) {
4445     /* all serialized or sticky events on the srcpad trigger push of
4446      * sticky events */
4447     res = (check_sticky (pad) == GST_FLOW_OK);
4448   }
4449   if (!sticky) {
4450     /* other events are pushed right away */
4451     res = (gst_pad_push_event_unchecked (pad, event, type) == GST_FLOW_OK);
4452   } else {
4453     gst_event_unref (event);
4454     res = TRUE;
4455   }
4456   GST_OBJECT_UNLOCK (pad);
4457
4458   return res;
4459
4460   /* ERROR handling */
4461 wrong_direction:
4462   {
4463     g_warning ("pad %s:%s pushing %s event in wrong direction",
4464         GST_DEBUG_PAD_NAME (pad), GST_EVENT_TYPE_NAME (event));
4465     gst_event_unref (event);
4466     return FALSE;
4467   }
4468 unknown_direction:
4469   {
4470     g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
4471     gst_event_unref (event);
4472     return FALSE;
4473   }
4474 flushed:
4475   {
4476     GST_DEBUG_OBJECT (pad, "We're flushing");
4477     GST_OBJECT_UNLOCK (pad);
4478     gst_event_unref (event);
4479     return FALSE;
4480   }
4481 }
4482
4483 /* Check if we can call the event function with the given event */
4484 static GstFlowReturn
4485 pre_eventfunc_check (GstPad * pad, GstEvent * event)
4486 {
4487   GstCaps *caps, *templ;
4488
4489   switch (GST_EVENT_TYPE (event)) {
4490     case GST_EVENT_CAPS:
4491     {
4492       /* backwards compatibility mode for caps */
4493       gst_event_parse_caps (event, &caps);
4494
4495       /* See if pad accepts the caps */
4496       templ = gst_pad_get_pad_template_caps (pad);
4497       if (!gst_caps_is_subset (caps, templ))
4498         goto not_accepted;
4499
4500       gst_caps_unref (templ);
4501       break;
4502     }
4503     default:
4504       break;
4505   }
4506   return GST_FLOW_OK;
4507
4508   /* ERRORS */
4509 not_accepted:
4510   {
4511     gst_caps_unref (templ);
4512     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
4513         "caps %" GST_PTR_FORMAT " not accepted", caps);
4514     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
4515         "no intersection with template %" GST_PTR_FORMAT, templ);
4516     return GST_FLOW_NOT_NEGOTIATED;
4517   }
4518 }
4519
4520 static GstFlowReturn
4521 gst_pad_send_event_unchecked (GstPad * pad, GstEvent * event,
4522     GstPadProbeType type)
4523 {
4524   GstFlowReturn ret;
4525   GstEventType event_type;
4526   gboolean serialized, need_unlock = FALSE, sticky;
4527   GstPadEventFunction eventfunc;
4528   GstObject *parent;
4529
4530   GST_OBJECT_LOCK (pad);
4531   if (GST_PAD_IS_SINK (pad))
4532     serialized = GST_EVENT_IS_SERIALIZED (event);
4533   else
4534     serialized = FALSE;
4535   sticky = GST_EVENT_IS_STICKY (event);
4536   event_type = GST_EVENT_TYPE (event);
4537   switch (event_type) {
4538     case GST_EVENT_FLUSH_START:
4539       GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad,
4540           "have event type %d (FLUSH_START)", GST_EVENT_TYPE (event));
4541
4542       /* can't even accept a flush begin event when flushing */
4543       if (GST_PAD_IS_FLUSHING (pad))
4544         goto flushing;
4545
4546       GST_PAD_SET_FLUSHING (pad);
4547       GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "set flush flag");
4548       break;
4549     case GST_EVENT_FLUSH_STOP:
4550       if (G_LIKELY (GST_PAD_MODE (pad) != GST_PAD_MODE_NONE)) {
4551         GST_PAD_UNSET_FLUSHING (pad);
4552         GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad, "cleared flush flag");
4553       }
4554       /* Remove pending EOS events */
4555       GST_LOG_OBJECT (pad, "Removing pending EOS events");
4556       remove_event_by_type (pad, GST_EVENT_EOS);
4557
4558       GST_OBJECT_UNLOCK (pad);
4559       /* grab stream lock */
4560       GST_PAD_STREAM_LOCK (pad);
4561       need_unlock = TRUE;
4562       GST_OBJECT_LOCK (pad);
4563       if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4564         goto flushing;
4565       break;
4566     case GST_EVENT_RECONFIGURE:
4567       if (GST_PAD_IS_SRC (pad))
4568         GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE);
4569     default:
4570       GST_CAT_DEBUG_OBJECT (GST_CAT_EVENT, pad,
4571           "have event type %" GST_PTR_FORMAT, event);
4572
4573       if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4574         goto flushing;
4575
4576       if (serialized) {
4577         /* lock order: STREAM_LOCK, LOCK, recheck flushing. */
4578         GST_OBJECT_UNLOCK (pad);
4579         GST_PAD_STREAM_LOCK (pad);
4580         need_unlock = TRUE;
4581         GST_OBJECT_LOCK (pad);
4582         if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
4583           goto flushing;
4584       }
4585
4586       switch (GST_EVENT_TYPE (event)) {
4587         case GST_EVENT_SEGMENT:
4588           event = apply_pad_offset (pad, event);
4589           break;
4590         default:
4591           break;
4592       }
4593
4594       /* now do the probe */
4595       PROBE_PUSH (pad,
4596           type | GST_PAD_PROBE_TYPE_PUSH |
4597           GST_PAD_PROBE_TYPE_BLOCK, event, probe_stopped);
4598
4599       PROBE_PUSH (pad, type | GST_PAD_PROBE_TYPE_PUSH, event, probe_stopped);
4600       break;
4601   }
4602
4603   if (G_UNLIKELY ((eventfunc = GST_PAD_EVENTFUNC (pad)) == NULL))
4604     goto no_function;
4605
4606   ACQUIRE_PARENT (pad, parent, no_parent);
4607   GST_OBJECT_UNLOCK (pad);
4608
4609   ret = pre_eventfunc_check (pad, event);
4610   if (G_UNLIKELY (ret != GST_FLOW_OK))
4611     goto precheck_failed;
4612
4613   if (sticky)
4614     gst_event_ref (event);
4615
4616   if (eventfunc (pad, parent, event)) {
4617     ret = GST_FLOW_OK;
4618   } else {
4619     /* something went wrong */
4620     switch (event_type) {
4621       case GST_EVENT_CAPS:
4622         ret = GST_FLOW_NOT_NEGOTIATED;
4623         break;
4624       default:
4625         ret = GST_FLOW_ERROR;
4626         break;
4627     }
4628   }
4629   RELEASE_PARENT (parent);
4630
4631   GST_DEBUG_OBJECT (pad, "sent event, ret %s", gst_flow_get_name (ret));
4632
4633   if (sticky) {
4634     if (ret == GST_FLOW_OK) {
4635       /* after the event function accepted the event, we can store the sticky
4636        * event on the pad */
4637       gst_pad_store_sticky_event (pad, event, FALSE);
4638     }
4639     gst_event_unref (event);
4640   }
4641
4642   if (need_unlock)
4643     GST_PAD_STREAM_UNLOCK (pad);
4644
4645   return ret;
4646
4647   /* ERROR handling */
4648 flushing:
4649   {
4650     GST_OBJECT_UNLOCK (pad);
4651     if (need_unlock)
4652       GST_PAD_STREAM_UNLOCK (pad);
4653     GST_CAT_INFO_OBJECT (GST_CAT_EVENT, pad,
4654         "Received event on flushing pad. Discarding");
4655     gst_event_unref (event);
4656     return GST_FLOW_FLUSHING;
4657   }
4658 probe_stopped:
4659   {
4660     GST_OBJECT_UNLOCK (pad);
4661     if (need_unlock)
4662       GST_PAD_STREAM_UNLOCK (pad);
4663     gst_event_unref (event);
4664
4665     switch (ret) {
4666       case GST_FLOW_CUSTOM_SUCCESS:
4667         GST_DEBUG_OBJECT (pad, "dropped event");
4668         ret = GST_FLOW_OK;
4669         break;
4670       default:
4671         GST_DEBUG_OBJECT (pad, "an error occured %s", gst_flow_get_name (ret));
4672         break;
4673     }
4674     return ret;
4675   }
4676 no_function:
4677   {
4678     g_warning ("pad %s:%s has no event handler, file a bug.",
4679         GST_DEBUG_PAD_NAME (pad));
4680     GST_OBJECT_UNLOCK (pad);
4681     if (need_unlock)
4682       GST_PAD_STREAM_UNLOCK (pad);
4683     gst_event_unref (event);
4684     return GST_FLOW_NOT_SUPPORTED;
4685   }
4686 no_parent:
4687   {
4688     GST_DEBUG_OBJECT (pad, "no parent");
4689     GST_OBJECT_UNLOCK (pad);
4690     if (need_unlock)
4691       GST_PAD_STREAM_UNLOCK (pad);
4692     gst_event_unref (event);
4693     return GST_FLOW_FLUSHING;
4694   }
4695 precheck_failed:
4696   {
4697     GST_DEBUG_OBJECT (pad, "pre event check failed");
4698     RELEASE_PARENT (parent);
4699     if (need_unlock)
4700       GST_PAD_STREAM_UNLOCK (pad);
4701     gst_event_unref (event);
4702     return ret;
4703   }
4704 }
4705
4706 /**
4707  * gst_pad_send_event:
4708  * @pad: a #GstPad to send the event to.
4709  * @event: (transfer full): the #GstEvent to send to the pad.
4710  *
4711  * Sends the event to the pad. This function can be used
4712  * by applications to send events in the pipeline.
4713  *
4714  * If @pad is a source pad, @event should be an upstream event. If @pad is a
4715  * sink pad, @event should be a downstream event. For example, you would not
4716  * send a #GST_EVENT_EOS on a src pad; EOS events only propagate downstream.
4717  * Furthermore, some downstream events have to be serialized with data flow,
4718  * like EOS, while some can travel out-of-band, like #GST_EVENT_FLUSH_START. If
4719  * the event needs to be serialized with data flow, this function will take the
4720  * pad's stream lock while calling its event function.
4721  *
4722  * To find out whether an event type is upstream, downstream, or downstream and
4723  * serialized, see #GstEventTypeFlags, gst_event_type_get_flags(),
4724  * #GST_EVENT_IS_UPSTREAM, #GST_EVENT_IS_DOWNSTREAM, and
4725  * #GST_EVENT_IS_SERIALIZED. Note that in practice that an application or
4726  * plugin doesn't need to bother itself with this information; the core handles
4727  * all necessary locks and checks.
4728  *
4729  * This function takes owership of the provided event so you should
4730  * gst_event_ref() it if you want to reuse the event after this call.
4731  *
4732  * Returns: TRUE if the event was handled.
4733  */
4734 gboolean
4735 gst_pad_send_event (GstPad * pad, GstEvent * event)
4736 {
4737   gboolean result;
4738   GstPadProbeType type;
4739
4740   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4741   g_return_val_if_fail (event != NULL, FALSE);
4742
4743   if (GST_PAD_IS_SINK (pad)) {
4744     if (G_UNLIKELY (!GST_EVENT_IS_DOWNSTREAM (event)))
4745       goto wrong_direction;
4746     type = GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM;
4747   } else if (GST_PAD_IS_SRC (pad)) {
4748     if (G_UNLIKELY (!GST_EVENT_IS_UPSTREAM (event)))
4749       goto wrong_direction;
4750     type = GST_PAD_PROBE_TYPE_EVENT_UPSTREAM;
4751   } else
4752     goto unknown_direction;
4753
4754   if (gst_pad_send_event_unchecked (pad, event, type) != GST_FLOW_OK)
4755     result = FALSE;
4756   else
4757     result = TRUE;
4758
4759   return result;
4760
4761   /* ERROR handling */
4762 wrong_direction:
4763   {
4764     g_warning ("pad %s:%s sending %s event in wrong direction",
4765         GST_DEBUG_PAD_NAME (pad), GST_EVENT_TYPE_NAME (event));
4766     gst_event_unref (event);
4767     return FALSE;
4768   }
4769 unknown_direction:
4770   {
4771     g_warning ("pad %s:%s has invalid direction", GST_DEBUG_PAD_NAME (pad));
4772     gst_event_unref (event);
4773     return FALSE;
4774   }
4775 }
4776
4777 /**
4778  * gst_pad_set_element_private:
4779  * @pad: the #GstPad to set the private data of.
4780  * @priv: The private data to attach to the pad.
4781  *
4782  * Set the given private data gpointer on the pad.
4783  * This function can only be used by the element that owns the pad.
4784  * No locking is performed in this function.
4785  */
4786 void
4787 gst_pad_set_element_private (GstPad * pad, gpointer priv)
4788 {
4789   pad->element_private = priv;
4790 }
4791
4792 /**
4793  * gst_pad_get_element_private:
4794  * @pad: the #GstPad to get the private data of.
4795  *
4796  * Gets the private data of a pad.
4797  * No locking is performed in this function.
4798  *
4799  * Returns: (transfer none): a #gpointer to the private data.
4800  */
4801 gpointer
4802 gst_pad_get_element_private (GstPad * pad)
4803 {
4804   return pad->element_private;
4805 }
4806
4807 /**
4808  * gst_pad_get_sticky_event:
4809  * @pad: the #GstPad to get the event from.
4810  * @event_type: the #GstEventType that should be retrieved.
4811  * @idx: the index of the event
4812  *
4813  * Returns a new reference of the sticky event of type @event_type
4814  * from the event.
4815  *
4816  * Returns: (transfer full): a #GstEvent of type @event_type or NULL when no
4817  * event of @event_type was on @pad. Unref after usage.
4818  */
4819 GstEvent *
4820 gst_pad_get_sticky_event (GstPad * pad, GstEventType event_type, guint idx)
4821 {
4822   GstEvent *event = NULL;
4823   PadEvent *ev;
4824
4825   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
4826   g_return_val_if_fail ((event_type & GST_EVENT_TYPE_STICKY) != 0, NULL);
4827
4828   GST_OBJECT_LOCK (pad);
4829   ev = find_event_by_type (pad, event_type, idx);
4830   if (ev && (event = ev->event))
4831     gst_event_ref (event);
4832   GST_OBJECT_UNLOCK (pad);
4833
4834   return event;
4835 }
4836
4837 typedef struct
4838 {
4839   GstPadStickyEventsForeachFunction func;
4840   gpointer user_data;
4841 } ForeachDispatch;
4842
4843 static gboolean
4844 foreach_dispatch_function (GstPad * pad, PadEvent * ev, gpointer user_data)
4845 {
4846   ForeachDispatch *data = user_data;
4847   gboolean ret;
4848
4849   GST_OBJECT_UNLOCK (pad);
4850
4851   ret = data->func (pad, &ev->event, data->user_data);
4852
4853   GST_OBJECT_LOCK (pad);
4854
4855   return ret;
4856 }
4857
4858 /**
4859  * gst_pad_sticky_events_foreach:
4860  * @pad: the #GstPad that should be used for iteration.
4861  * @foreach_func: (scope call): the #GstPadStickyEventsForeachFunction that
4862  *                should be called for every event.
4863  * @user_data: (closure): the optional user data.
4864  *
4865  * Iterates all sticky events on @pad and calls @foreach_func for every
4866  * event. If @foreach_func returns %FALSE the iteration is immediately stopped.
4867  */
4868 void
4869 gst_pad_sticky_events_foreach (GstPad * pad,
4870     GstPadStickyEventsForeachFunction foreach_func, gpointer user_data)
4871 {
4872   ForeachDispatch data;
4873
4874   g_return_if_fail (GST_IS_PAD (pad));
4875   g_return_if_fail (foreach_func != NULL);
4876
4877   data.func = foreach_func;
4878   data.user_data = user_data;
4879
4880   GST_OBJECT_LOCK (pad);
4881   events_foreach (pad, foreach_dispatch_function, &data);
4882   GST_OBJECT_UNLOCK (pad);
4883 }
4884
4885 static void
4886 do_stream_status (GstPad * pad, GstStreamStatusType type,
4887     GThread * thread, GstTask * task)
4888 {
4889   GstElement *parent;
4890
4891   GST_DEBUG_OBJECT (pad, "doing stream-status %d", type);
4892
4893   if ((parent = GST_ELEMENT_CAST (gst_pad_get_parent (pad)))) {
4894     if (GST_IS_ELEMENT (parent)) {
4895       GstMessage *message;
4896       GValue value = { 0 };
4897
4898       if (type == GST_STREAM_STATUS_TYPE_ENTER) {
4899         gchar *tname, *ename, *pname;
4900
4901         /* create a good task name */
4902         ename = gst_element_get_name (parent);
4903         pname = gst_pad_get_name (pad);
4904         tname = g_strdup_printf ("%s:%s", ename, pname);
4905         g_free (ename);
4906         g_free (pname);
4907
4908         gst_object_set_name (GST_OBJECT_CAST (task), tname);
4909         g_free (tname);
4910       }
4911
4912       message = gst_message_new_stream_status (GST_OBJECT_CAST (pad),
4913           type, parent);
4914
4915       g_value_init (&value, GST_TYPE_TASK);
4916       g_value_set_object (&value, task);
4917       gst_message_set_stream_status_object (message, &value);
4918       g_value_unset (&value);
4919
4920       GST_DEBUG_OBJECT (pad, "posting stream-status %d", type);
4921       gst_element_post_message (parent, message);
4922     }
4923     gst_object_unref (parent);
4924   }
4925 }
4926
4927 static void
4928 pad_enter_thread (GstTask * task, GThread * thread, gpointer user_data)
4929 {
4930   do_stream_status (GST_PAD_CAST (user_data), GST_STREAM_STATUS_TYPE_ENTER,
4931       thread, task);
4932 }
4933
4934 static void
4935 pad_leave_thread (GstTask * task, GThread * thread, gpointer user_data)
4936 {
4937   do_stream_status (GST_PAD_CAST (user_data), GST_STREAM_STATUS_TYPE_LEAVE,
4938       thread, task);
4939 }
4940
4941 static GstTaskThreadCallbacks thr_callbacks = {
4942   pad_enter_thread,
4943   pad_leave_thread,
4944 };
4945
4946 /**
4947  * gst_pad_start_task:
4948  * @pad: the #GstPad to start the task of
4949  * @func: the task function to call
4950  * @data: data passed to the task function
4951  *
4952  * Starts a task that repeatedly calls @func with @data. This function
4953  * is mostly used in pad activation functions to start the dataflow.
4954  * The #GST_PAD_STREAM_LOCK of @pad will automatically be acquired
4955  * before @func is called.
4956  *
4957  * Returns: a %TRUE if the task could be started.
4958  */
4959 gboolean
4960 gst_pad_start_task (GstPad * pad, GstTaskFunction func, gpointer data)
4961 {
4962   GstTask *task;
4963   gboolean res;
4964
4965   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
4966   g_return_val_if_fail (func != NULL, FALSE);
4967
4968   GST_DEBUG_OBJECT (pad, "start task");
4969
4970   GST_OBJECT_LOCK (pad);
4971   task = GST_PAD_TASK (pad);
4972   if (task == NULL) {
4973     task = gst_task_new (func, data);
4974     gst_task_set_lock (task, GST_PAD_GET_STREAM_LOCK (pad));
4975     gst_task_set_thread_callbacks (task, &thr_callbacks, pad, NULL);
4976     GST_INFO_OBJECT (pad, "created task %p", task);
4977     GST_PAD_TASK (pad) = task;
4978     gst_object_ref (task);
4979     /* release lock to post the message */
4980     GST_OBJECT_UNLOCK (pad);
4981
4982     do_stream_status (pad, GST_STREAM_STATUS_TYPE_CREATE, NULL, task);
4983
4984     gst_object_unref (task);
4985
4986     GST_OBJECT_LOCK (pad);
4987     /* nobody else is supposed to have changed the pad now */
4988     if (GST_PAD_TASK (pad) != task)
4989       goto concurrent_stop;
4990   }
4991   res = gst_task_set_state (task, GST_TASK_STARTED);
4992   GST_OBJECT_UNLOCK (pad);
4993
4994   return res;
4995
4996   /* ERRORS */
4997 concurrent_stop:
4998   {
4999     GST_OBJECT_UNLOCK (pad);
5000     return TRUE;
5001   }
5002 }
5003
5004 /**
5005  * gst_pad_pause_task:
5006  * @pad: the #GstPad to pause the task of
5007  *
5008  * Pause the task of @pad. This function will also wait until the
5009  * function executed by the task is finished if this function is not
5010  * called from the task function.
5011  *
5012  * Returns: a TRUE if the task could be paused or FALSE when the pad
5013  * has no task.
5014  */
5015 gboolean
5016 gst_pad_pause_task (GstPad * pad)
5017 {
5018   GstTask *task;
5019   gboolean res;
5020
5021   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5022
5023   GST_DEBUG_OBJECT (pad, "pause task");
5024
5025   GST_OBJECT_LOCK (pad);
5026   task = GST_PAD_TASK (pad);
5027   if (task == NULL)
5028     goto no_task;
5029   res = gst_task_set_state (task, GST_TASK_PAUSED);
5030   GST_OBJECT_UNLOCK (pad);
5031
5032   /* wait for task function to finish, this lock is recursive so it does nothing
5033    * when the pause is called from the task itself */
5034   GST_PAD_STREAM_LOCK (pad);
5035   GST_PAD_STREAM_UNLOCK (pad);
5036
5037   return res;
5038
5039 no_task:
5040   {
5041     GST_DEBUG_OBJECT (pad, "pad has no task");
5042     GST_OBJECT_UNLOCK (pad);
5043     return FALSE;
5044   }
5045 }
5046
5047 /**
5048  * gst_pad_stop_task:
5049  * @pad: the #GstPad to stop the task of
5050  *
5051  * Stop the task of @pad. This function will also make sure that the
5052  * function executed by the task will effectively stop if not called
5053  * from the GstTaskFunction.
5054  *
5055  * This function will deadlock if called from the GstTaskFunction of
5056  * the task. Use gst_task_pause() instead.
5057  *
5058  * Regardless of whether the pad has a task, the stream lock is acquired and
5059  * released so as to ensure that streaming through this pad has finished.
5060  *
5061  * Returns: a TRUE if the task could be stopped or FALSE on error.
5062  */
5063 gboolean
5064 gst_pad_stop_task (GstPad * pad)
5065 {
5066   GstTask *task;
5067   gboolean res;
5068
5069   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
5070
5071   GST_DEBUG_OBJECT (pad, "stop task");
5072
5073   GST_OBJECT_LOCK (pad);
5074   task = GST_PAD_TASK (pad);
5075   if (task == NULL)
5076     goto no_task;
5077   GST_PAD_TASK (pad) = NULL;
5078   res = gst_task_set_state (task, GST_TASK_STOPPED);
5079   GST_OBJECT_UNLOCK (pad);
5080
5081   GST_PAD_STREAM_LOCK (pad);
5082   GST_PAD_STREAM_UNLOCK (pad);
5083
5084   if (!gst_task_join (task))
5085     goto join_failed;
5086
5087   gst_object_unref (task);
5088
5089   return res;
5090
5091 no_task:
5092   {
5093     GST_DEBUG_OBJECT (pad, "no task");
5094     GST_OBJECT_UNLOCK (pad);
5095
5096     GST_PAD_STREAM_LOCK (pad);
5097     GST_PAD_STREAM_UNLOCK (pad);
5098
5099     /* this is not an error */
5100     return TRUE;
5101   }
5102 join_failed:
5103   {
5104     /* this is bad, possibly the application tried to join the task from
5105      * the task's thread. We install the task again so that it will be stopped
5106      * again from the right thread next time hopefully. */
5107     GST_OBJECT_LOCK (pad);
5108     GST_DEBUG_OBJECT (pad, "join failed");
5109     /* we can only install this task if there was no other task */
5110     if (GST_PAD_TASK (pad) == NULL)
5111       GST_PAD_TASK (pad) = task;
5112     GST_OBJECT_UNLOCK (pad);
5113
5114     return FALSE;
5115   }
5116 }