gst/gstpad.h

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wim.taymans@chello.be>
   4  *
   5  * gstpad.h: Header for GstPad object
   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., 51 Franklin St, Fifth Floor,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22
  23
  24 #ifndef __GST_PAD_H__
  25 #define __GST_PAD_H__
  26
  27 #include <gst/gstconfig.h>
  28
  29 typedef struct _GstPad GstPad;
  30 typedef struct _GstPadPrivate GstPadPrivate;
  31 typedef struct _GstPadClass GstPadClass;
  32 typedef struct _GstPadProbeInfo GstPadProbeInfo;
  33
  34 /**
  35  * GstPadDirection:
  36  * @GST_PAD_UNKNOWN: direction is unknown.
  37  * @GST_PAD_SRC: the pad is a source pad.
  38  * @GST_PAD_SINK: the pad is a sink pad.
  39  *
  40  * The direction of a pad.
  41  */
  42 typedef enum {
  43   GST_PAD_UNKNOWN,
  44   GST_PAD_SRC,
  45   GST_PAD_SINK
  46 } GstPadDirection;
  47
  48 /**
  49  * GstPadMode:
  50  * @GST_PAD_MODE_NONE: Pad will not handle dataflow
  51  * @GST_PAD_MODE_PUSH: Pad handles dataflow in downstream push mode
  52  * @GST_PAD_MODE_PULL: Pad handles dataflow in upstream pull mode
  53  *
  54  * The status of a GstPad. After activating a pad, which usually happens when the
  55  * parent element goes from READY to PAUSED, the GstPadMode defines if the
  56  * pad operates in push or pull mode.
  57  */
  58 typedef enum {
  59   GST_PAD_MODE_NONE,
  60   GST_PAD_MODE_PUSH,
  61   GST_PAD_MODE_PULL
  62 } GstPadMode;
  63
  64 #include <glib.h>
  65
  66 const gchar   * gst_pad_mode_get_name (GstPadMode mode);
  67
  68 #include <gst/gstobject.h>
  69 #include <gst/gstbuffer.h>
  70 #include <gst/gstbufferlist.h>
  71 #include <gst/gstcaps.h>
  72 #include <gst/gstpadtemplate.h>
  73 #include <gst/gstevent.h>
  74 #include <gst/gstquery.h>
  75 #include <gst/gsttask.h>
  76
  77 G_BEGIN_DECLS
  78
  79 /*
  80  * Pad base class
  81  */
  82 #define GST_TYPE_PAD                    (gst_pad_get_type ())
  83 #define GST_IS_PAD(obj)                 (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PAD))
  84 #define GST_IS_PAD_CLASS(klass)         (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PAD))
  85 #define GST_PAD(obj)                    (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PAD, GstPad))
  86 #define GST_PAD_CLASS(klass)            (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PAD, GstPadClass))
  87 #define GST_PAD_CAST(obj)               ((GstPad*)(obj))
  88
  89
  90
  91 /**
  92  * GstPadLinkReturn:
  93  * @GST_PAD_LINK_OK             : link succeeded
  94  * @GST_PAD_LINK_WRONG_HIERARCHY: pads have no common grandparent
  95  * @GST_PAD_LINK_WAS_LINKED     : pad was already linked
  96  * @GST_PAD_LINK_WRONG_DIRECTION: pads have wrong direction
  97  * @GST_PAD_LINK_NOFORMAT       : pads do not have common format
  98  * @GST_PAD_LINK_NOSCHED        : pads cannot cooperate in scheduling
  99  * @GST_PAD_LINK_REFUSED        : refused for some reason
 100  *
 101  * Result values from gst_pad_link and friends.
 102  */
 103 typedef enum {
 104   GST_PAD_LINK_OK               =  0,
 105   GST_PAD_LINK_WRONG_HIERARCHY  = -1,
 106   GST_PAD_LINK_WAS_LINKED       = -2,
 107   GST_PAD_LINK_WRONG_DIRECTION  = -3,
 108   GST_PAD_LINK_NOFORMAT         = -4,
 109   GST_PAD_LINK_NOSCHED          = -5,
 110   GST_PAD_LINK_REFUSED          = -6
 111 } GstPadLinkReturn;
 112
 113 /**
 114  * GST_PAD_LINK_FAILED:
 115  * @ret: the #GstPadLinkReturn value
 116  *
 117  * Macro to test if the given #GstPadLinkReturn value indicates a failed
 118  * link step.
 119  */
 120 #define GST_PAD_LINK_FAILED(ret) ((ret) < GST_PAD_LINK_OK)
 121
 122 /**
 123  * GST_PAD_LINK_SUCCESSFUL:
 124  * @ret: the #GstPadLinkReturn value
 125  *
 126  * Macro to test if the given #GstPadLinkReturn value indicates a successful
 127  * link step.
 128  */
 129 #define GST_PAD_LINK_SUCCESSFUL(ret) ((ret) >= GST_PAD_LINK_OK)
 130
 131 /**
 132  * GstFlowReturn:
 133  * @GST_FLOW_OK:                 Data passing was ok.
 134  * @GST_FLOW_NOT_LINKED:         Pad is not linked.
 135  * @GST_FLOW_FLUSHING:           Pad is flushing.
 136  * @GST_FLOW_EOS:                Pad is EOS.
 137  * @GST_FLOW_NOT_NEGOTIATED:     Pad is not negotiated.
 138  * @GST_FLOW_ERROR:              Some (fatal) error occurred. Element generating
 139  *                               this error should post an error message with more
 140  *                               details.
 141  * @GST_FLOW_NOT_SUPPORTED:      This operation is not supported.
 142  * @GST_FLOW_CUSTOM_SUCCESS:     Elements can use values starting from
 143  *                               this (and higher) to define custom success
 144  *                               codes.
 145  * @GST_FLOW_CUSTOM_SUCCESS_1:   Pre-defined custom success code (define your
 146  *                               custom success code to this to avoid compiler
 147  *                               warnings).
 148  * @GST_FLOW_CUSTOM_SUCCESS_2:   Pre-defined custom success code.
 149  * @GST_FLOW_CUSTOM_ERROR:       Elements can use values starting from
 150  *                               this (and lower) to define custom error codes.
 151  * @GST_FLOW_CUSTOM_ERROR_1:     Pre-defined custom error code (define your
 152  *                               custom error code to this to avoid compiler
 153  *                               warnings).
 154  * @GST_FLOW_CUSTOM_ERROR_2:     Pre-defined custom error code.
 155  *
 156  * The result of passing data to a pad.
 157  *
 158  * Note that the custom return values should not be exposed outside of the
 159  * element scope.
 160  */
 161 typedef enum {
 162   /* custom success starts here */
 163   GST_FLOW_CUSTOM_SUCCESS_2 = 102,
 164   GST_FLOW_CUSTOM_SUCCESS_1 = 101,
 165   GST_FLOW_CUSTOM_SUCCESS = 100,
 166
 167   /* core predefined */
 168   GST_FLOW_OK             =  0,
 169   /* expected failures */
 170   GST_FLOW_NOT_LINKED     = -1,
 171   GST_FLOW_FLUSHING       = -2,
 172   /* error cases */
 173   GST_FLOW_EOS            = -3,
 174   GST_FLOW_NOT_NEGOTIATED = -4,
 175   GST_FLOW_ERROR          = -5,
 176   GST_FLOW_NOT_SUPPORTED  = -6,
 177
 178   /* custom error starts here */
 179   GST_FLOW_CUSTOM_ERROR   = -100,
 180   GST_FLOW_CUSTOM_ERROR_1 = -101,
 181   GST_FLOW_CUSTOM_ERROR_2 = -102
 182 } GstFlowReturn;
 183
 184 const gchar*            gst_flow_get_name (GstFlowReturn ret);
 185 GQuark                            gst_flow_to_quark (GstFlowReturn ret);
 186 const gchar*          gst_pad_link_get_name (GstPadLinkReturn ret);
 187
 188 /**
 189  * GstPadLinkCheck:
 190  * @GST_PAD_LINK_CHECK_NOTHING: Don't check hierarchy or caps compatibility.
 191  * @GST_PAD_LINK_CHECK_HIERARCHY: Check the pads have same parents/grandparents.
 192  *   Could be omitted if it is already known that the two elements that own the
 193  *   pads are in the same bin.
 194  * @GST_PAD_LINK_CHECK_TEMPLATE_CAPS: Check if the pads are compatible by using
 195  *   their template caps. This is much faster than @GST_PAD_LINK_CHECK_CAPS, but
 196  *   would be unsafe e.g. if one pad has %GST_CAPS_ANY.
 197  * @GST_PAD_LINK_CHECK_CAPS: Check if the pads are compatible by comparing the
 198  *   caps returned by gst_pad_query_caps().
 199  * @GST_PAD_LINK_CHECK_NO_RECONFIGURE: Disables pushing a reconfigure event when pads are
 200  *   linked.
 201  * @GST_PAD_LINK_CHECK_DEFAULT: The default checks done when linking
 202  *   pads (i.e. the ones used by gst_pad_link()).
 203  *
 204  * The amount of checking to be done when linking pads. @GST_PAD_LINK_CHECK_CAPS
 205  * and @GST_PAD_LINK_CHECK_TEMPLATE_CAPS are mutually exclusive. If both are
 206  * specified, expensive but safe @GST_PAD_LINK_CHECK_CAPS are performed.
 207  *
 208  * <warning><para>
 209  * Only disable some of the checks if you are 100% certain you know the link
 210  * will not fail because of hierarchy/caps compatibility failures. If uncertain,
 211  * use the default checks (%GST_PAD_LINK_CHECK_DEFAULT) or the regular methods
 212  * for linking the pads.
 213  * </para></warning>
 214  */
 215
 216 typedef enum {
 217   GST_PAD_LINK_CHECK_NOTHING       = 0,
 218   GST_PAD_LINK_CHECK_HIERARCHY     = 1 << 0,
 219   GST_PAD_LINK_CHECK_TEMPLATE_CAPS = 1 << 1,
 220   GST_PAD_LINK_CHECK_CAPS          = 1 << 2,
 221
 222
 223   /* Not really checks, more like flags
 224    * Added here to avoid creating a new gst_pad_link_variant */
 225   GST_PAD_LINK_CHECK_NO_RECONFIGURE = 1 << 3,
 226
 227   GST_PAD_LINK_CHECK_DEFAULT       = GST_PAD_LINK_CHECK_HIERARCHY | GST_PAD_LINK_CHECK_CAPS
 228 } GstPadLinkCheck;
 229
 230 /* pad states */
 231 /**
 232  * GstPadActivateFunction:
 233  * @pad: a #GstPad
 234  * @parent: the parent of @pad
 235  *
 236  * This function is called when the pad is activated during the element
 237  * READY to PAUSED state change. By default this function will call the
 238  * activate function that puts the pad in push mode but elements can
 239  * override this function to activate the pad in pull mode if they wish.
 240  *
 241  * Returns: %TRUE if the pad could be activated.
 242  */
 243 typedef gboolean                (*GstPadActivateFunction)       (GstPad *pad, GstObject *parent);
 244 /**
 245  * GstPadActivateModeFunction:
 246  * @pad: a #GstPad
 247  * @parent: the parent of @pad
 248  * @mode: the requested activation mode of @pad
 249  * @active: activate or deactivate the pad.
 250  *
 251  * The prototype of the push and pull activate functions.
 252  *
 253  * Returns: %TRUE if the pad could be activated or deactivated.
 254  */
 255 typedef gboolean                (*GstPadActivateModeFunction)   (GstPad *pad, GstObject *parent,
 256                                                                  GstPadMode mode, gboolean active);
 257
 258
 259 /* data passing */
 260 /**
 261  * GstPadChainFunction:
 262  * @pad: the sink #GstPad that performed the chain.
 263  * @parent: (allow-none): the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT
 264  *          flag is set, @parent is guaranteed to be not-%NULL and remain valid
 265  *          during the execution of this function.
 266  * @buffer: (transfer full): the #GstBuffer that is chained, not %NULL.
 267  *
 268  * A function that will be called on sinkpads when chaining buffers.
 269  * The function typically processes the data contained in the buffer and
 270  * either consumes the data or passes it on to the internally linked pad(s).
 271  *
 272  * The implementer of this function receives a refcount to @buffer and should
 273  * gst_buffer_unref() when the buffer is no longer needed.
 274  *
 275  * When a chain function detects an error in the data stream, it must post an
 276  * error on the bus and return an appropriate #GstFlowReturn value.
 277  *
 278  * Returns: #GST_FLOW_OK for success
 279  */
 280 typedef GstFlowReturn           (*GstPadChainFunction)          (GstPad *pad, GstObject *parent,
 281                                                                  GstBuffer *buffer);
 282
 283 /**
 284  * GstPadChainListFunction:
 285  * @pad: the sink #GstPad that performed the chain.
 286  * @parent: (allow-none): the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT
 287  *          flag is set, @parent is guaranteed to be not-%NULL and remain valid
 288  *          during the execution of this function.
 289  * @list: (transfer full): the #GstBufferList that is chained, not %NULL.
 290  *
 291  * A function that will be called on sinkpads when chaining buffer lists.
 292  * The function typically processes the data contained in the buffer list and
 293  * either consumes the data or passes it on to the internally linked pad(s).
 294  *
 295  * The implementer of this function receives a refcount to @list and
 296  * should gst_buffer_list_unref() when the list is no longer needed.
 297  *
 298  * When a chainlist function detects an error in the data stream, it must
 299  * post an error on the bus and return an appropriate #GstFlowReturn value.
 300  *
 301  * Returns: #GST_FLOW_OK for success
 302  */
 303 typedef GstFlowReturn           (*GstPadChainListFunction)      (GstPad *pad, GstObject *parent,
 304                                                                  GstBufferList *list);
 305
 306 /**
 307  * GstPadGetRangeFunction:
 308  * @pad: the src #GstPad to perform the getrange on.
 309  * @parent: (allow-none): the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT
 310  *          flag is set, @parent is guaranteed to be not-%NULL and remain valid
 311  *          during the execution of this function.
 312  * @offset: the offset of the range
 313  * @length: the length of the range
 314  * @buffer: a memory location to hold the result buffer, cannot be %NULL.
 315  *
 316  * This function will be called on source pads when a peer element
 317  * request a buffer at the specified @offset and @length. If this function
 318  * returns #GST_FLOW_OK, the result buffer will be stored in @buffer. The
 319  * contents of @buffer is invalid for any other return value.
 320  *
 321  * This function is installed on a source pad with
 322  * gst_pad_set_getrange_function() and can only be called on source pads after
 323  * they are successfully activated with gst_pad_activate_mode() with the
 324  * #GST_PAD_MODE_PULL.
 325  *
 326  * @offset and @length are always given in byte units. @offset must normally be a value
 327  * between 0 and the length in bytes of the data available on @pad. The
 328  * length (duration in bytes) can be retrieved with a #GST_QUERY_DURATION or with a
 329  * #GST_QUERY_SEEKING.
 330  *
 331  * Any @offset larger or equal than the length will make the function return
 332  * #GST_FLOW_EOS, which corresponds to EOS. In this case @buffer does not
 333  * contain a valid buffer.
 334  *
 335  * The buffer size of @buffer will only be smaller than @length when @offset is
 336  * near the end of the stream. In all other cases, the size of @buffer must be
 337  * exactly the requested size.
 338  *
 339  * It is allowed to call this function with a 0 @length and valid @offset, in
 340  * which case @buffer will contain a 0-sized buffer and the function returns
 341  * #GST_FLOW_OK.
 342  *
 343  * When this function is called with a -1 @offset, the sequentially next buffer
 344  * of length @length in the stream is returned.
 345  *
 346  * When this function is called with a -1 @length, a buffer with a default
 347  * optimal length is returned in @buffer. The length might depend on the value
 348  * of @offset.
 349  *
 350  * Returns: #GST_FLOW_OK for success and a valid buffer in @buffer. Any other
 351  * return value leaves @buffer undefined.
 352  */
 353 typedef GstFlowReturn           (*GstPadGetRangeFunction)       (GstPad *pad, GstObject *parent,
 354                                                                  guint64 offset, guint length,
 355                                                                  GstBuffer **buffer);
 356
 357 /**
 358  * GstPadEventFunction:
 359  * @pad: the #GstPad to handle the event.
 360  * @parent: (allow-none): the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT
 361  *          flag is set, @parent is guaranteed to be not-%NULL and remain valid
 362  *          during the execution of this function.
 363  * @event: (transfer full): the #GstEvent to handle.
 364  *
 365  * Function signature to handle an event for the pad.
 366  *
 367  * Returns: %TRUE if the pad could handle the event.
 368  */
 369 typedef gboolean                (*GstPadEventFunction)          (GstPad *pad, GstObject *parent,
 370                                                                  GstEvent *event);
 371
 372 /**
 373  * GstPadEventFullFunction:
 374  * @pad: the #GstPad to handle the event.
 375  * @parent: (allow-none): the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT
 376  *          flag is set, @parent is guaranteed to be not-%NULL and remain valid
 377  *          during the execution of this function.
 378  * @event: (transfer full): the #GstEvent to handle.
 379  *
 380  * Function signature to handle an event for the pad.
 381  *
 382  * This variant is for specific elements that will take into account the
 383  * last downstream flow return (from a pad push), in which case they can
 384  * return it.
 385  *
 386  * Returns: %GST_FLOW_OK if the event was handled properly, or any other
 387  * #GstFlowReturn dependent on downstream state.
 388  *
 389  * Since: 1.8
 390  */
 391 typedef GstFlowReturn           (*GstPadEventFullFunction)      (GstPad *pad, GstObject *parent,
 392                                                                  GstEvent *event);
 393
 394
 395 /* internal links */
 396 /**
 397  * GstPadIterIntLinkFunction:
 398  * @pad: The #GstPad to query.
 399  * @parent: (allow-none): the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT
 400  *          flag is set, @parent is guaranteed to be not-%NULL and remain valid
 401  *          during the execution of this function.
 402  *
 403  * The signature of the internal pad link iterator function.
 404  *
 405  * Returns: a new #GstIterator that will iterate over all pads that are
 406  * linked to the given pad on the inside of the parent element.
 407  *
 408  * the caller must call gst_iterator_free() after usage.
 409  */
 410 typedef GstIterator*           (*GstPadIterIntLinkFunction)    (GstPad *pad, GstObject *parent);
 411
 412 /* generic query function */
 413 /**
 414  * GstPadQueryFunction:
 415  * @pad: the #GstPad to query.
 416  * @parent: (allow-none): the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT
 417  *          flag is set, @parent is guaranteed to be not-%NULL and remain valid
 418  *          during the execution of this function.
 419  * @query: the #GstQuery object to execute
 420  *
 421  * The signature of the query function.
 422  *
 423  * Returns: %TRUE if the query could be performed.
 424  */
 425 typedef gboolean                (*GstPadQueryFunction)          (GstPad *pad, GstObject *parent,
 426                                                                  GstQuery *query);
 427
 428
 429 /* linking */
 430 /**
 431  * GstPadLinkFunction:
 432  * @pad: the #GstPad that is linked.
 433  * @parent: (allow-none): the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT
 434  *          flag is set, @parent is guaranteed to be not-%NULL and remain valid
 435  *          during the execution of this function.
 436  * @peer: the peer #GstPad of the link
 437  *
 438  * Function signature to handle a new link on the pad.
 439  *
 440  * Returns: the result of the link with the specified peer.
 441  */
 442 typedef GstPadLinkReturn        (*GstPadLinkFunction)           (GstPad *pad, GstObject *parent, GstPad *peer);
 443 /**
 444  * GstPadUnlinkFunction:
 445  * @pad: the #GstPad that is linked.
 446  * @parent: (allow-none): the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT
 447  *          flag is set, @parent is guaranteed to be not-%NULL and remain valid
 448  *          during the execution of this function.
 449  *
 450  * Function signature to handle a unlinking the pad prom its peer.
 451  */
 452 typedef void                    (*GstPadUnlinkFunction)         (GstPad *pad, GstObject *parent);
 453
 454
 455 /* misc */
 456 /**
 457  * GstPadForwardFunction:
 458  * @pad: the #GstPad that is forwarded.
 459  * @user_data: the gpointer to optional user data.
 460  *
 461  * A forward function is called for all internally linked pads, see
 462  * gst_pad_forward().
 463  *
 464  * Returns: %TRUE if the dispatching procedure has to be stopped.
 465  */
 466 typedef gboolean                (*GstPadForwardFunction)        (GstPad *pad, gpointer user_data);
 467
 468 /**
 469  * GstPadProbeType:
 470  * @GST_PAD_PROBE_TYPE_INVALID: invalid probe type
 471  * @GST_PAD_PROBE_TYPE_IDLE: probe idle pads and block while the callback is called
 472  * @GST_PAD_PROBE_TYPE_BLOCK: probe and block pads
 473  * @GST_PAD_PROBE_TYPE_BUFFER: probe buffers
 474  * @GST_PAD_PROBE_TYPE_BUFFER_LIST: probe buffer lists
 475  * @GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM: probe downstream events
 476  * @GST_PAD_PROBE_TYPE_EVENT_UPSTREAM: probe upstream events
 477  * @GST_PAD_PROBE_TYPE_EVENT_FLUSH: probe flush events. This probe has to be
 478  *     explicitly enabled and is not included in the
 479  *     @@GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM or
 480  *     @@GST_PAD_PROBE_TYPE_EVENT_UPSTREAM probe types.
 481  * @GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM: probe downstream queries
 482  * @GST_PAD_PROBE_TYPE_QUERY_UPSTREAM: probe upstream queries
 483  * @GST_PAD_PROBE_TYPE_PUSH: probe push
 484  * @GST_PAD_PROBE_TYPE_PULL: probe pull
 485  * @GST_PAD_PROBE_TYPE_BLOCKING: probe and block at the next opportunity, at data flow or when idle
 486  * @GST_PAD_PROBE_TYPE_DATA_DOWNSTREAM: probe downstream data (buffers, buffer lists, and events)
 487  * @GST_PAD_PROBE_TYPE_DATA_UPSTREAM: probe upstream data (events)
 488  * @GST_PAD_PROBE_TYPE_DATA_BOTH: probe upstream and downstream data (buffers, buffer lists, and events)
 489  * @GST_PAD_PROBE_TYPE_BLOCK_DOWNSTREAM: probe and block downstream data (buffers, buffer lists, and events)
 490  * @GST_PAD_PROBE_TYPE_BLOCK_UPSTREAM: probe and block upstream data (events)
 491  * @GST_PAD_PROBE_TYPE_EVENT_BOTH: probe upstream and downstream events
 492  * @GST_PAD_PROBE_TYPE_QUERY_BOTH: probe upstream and downstream queries
 493  * @GST_PAD_PROBE_TYPE_ALL_BOTH: probe upstream events and queries and downstream buffers, buffer lists, events and queries
 494  * @GST_PAD_PROBE_TYPE_SCHEDULING: probe push and pull
 495  *
 496  * The different probing types that can occur. When either one of
 497  * @GST_PAD_PROBE_TYPE_IDLE or @GST_PAD_PROBE_TYPE_BLOCK is used, the probe will be a
 498  * blocking probe.
 499  */
 500 typedef enum
 501 {
 502   GST_PAD_PROBE_TYPE_INVALID          = 0,
 503   /* flags to control blocking */
 504   GST_PAD_PROBE_TYPE_IDLE             = (1 << 0),
 505   GST_PAD_PROBE_TYPE_BLOCK            = (1 << 1),
 506   /* flags to select datatypes */
 507   GST_PAD_PROBE_TYPE_BUFFER           = (1 << 4),
 508   GST_PAD_PROBE_TYPE_BUFFER_LIST      = (1 << 5),
 509   GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM = (1 << 6),
 510   GST_PAD_PROBE_TYPE_EVENT_UPSTREAM   = (1 << 7),
 511   GST_PAD_PROBE_TYPE_EVENT_FLUSH      = (1 << 8),
 512   GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM = (1 << 9),
 513   GST_PAD_PROBE_TYPE_QUERY_UPSTREAM   = (1 << 10),
 514   /* flags to select scheduling mode */
 515   GST_PAD_PROBE_TYPE_PUSH             = (1 << 12),
 516   GST_PAD_PROBE_TYPE_PULL             = (1 << 13),
 517
 518   /* flag combinations */
 519   GST_PAD_PROBE_TYPE_BLOCKING         = GST_PAD_PROBE_TYPE_IDLE | GST_PAD_PROBE_TYPE_BLOCK,
 520   GST_PAD_PROBE_TYPE_DATA_DOWNSTREAM  = GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_BUFFER_LIST | GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM,
 521   GST_PAD_PROBE_TYPE_DATA_UPSTREAM    = GST_PAD_PROBE_TYPE_EVENT_UPSTREAM,
 522   GST_PAD_PROBE_TYPE_DATA_BOTH        = GST_PAD_PROBE_TYPE_DATA_DOWNSTREAM | GST_PAD_PROBE_TYPE_DATA_UPSTREAM,
 523   GST_PAD_PROBE_TYPE_BLOCK_DOWNSTREAM = GST_PAD_PROBE_TYPE_BLOCK | GST_PAD_PROBE_TYPE_DATA_DOWNSTREAM,
 524   GST_PAD_PROBE_TYPE_BLOCK_UPSTREAM   = GST_PAD_PROBE_TYPE_BLOCK | GST_PAD_PROBE_TYPE_DATA_UPSTREAM,
 525   GST_PAD_PROBE_TYPE_EVENT_BOTH       = GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM | GST_PAD_PROBE_TYPE_EVENT_UPSTREAM,
 526   GST_PAD_PROBE_TYPE_QUERY_BOTH       = GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM | GST_PAD_PROBE_TYPE_QUERY_UPSTREAM,
 527   GST_PAD_PROBE_TYPE_ALL_BOTH         = GST_PAD_PROBE_TYPE_DATA_BOTH | GST_PAD_PROBE_TYPE_QUERY_BOTH,
 528   GST_PAD_PROBE_TYPE_SCHEDULING       = GST_PAD_PROBE_TYPE_PUSH | GST_PAD_PROBE_TYPE_PULL
 529 } GstPadProbeType;
 530
 531
 532 /**
 533  * GstPadProbeReturn:
 534  * @GST_PAD_PROBE_OK: normal probe return value. This leaves the probe in
 535  *        place, and defers decisions about dropping or passing data to other
 536  *        probes, if any. If there are no other probes, the default behaviour
 537  *        for the probe type applies (block for blocking probes, and pass for
 538  *        non-blocking probes).
 539  * @GST_PAD_PROBE_DROP: drop data in data probes. For push mode this means that
 540  *        the data item is not sent downstream. For pull mode, it means that
 541  *        the data item is not passed upstream. In both cases, no more probes
 542  *        are called and #GST_FLOW_OK or %TRUE is returned to the caller.
 543  * @GST_PAD_PROBE_REMOVE: remove this probe.
 544  * @GST_PAD_PROBE_PASS: pass the data item in the block probe and block on the
 545  *        next item.
 546  * @GST_PAD_PROBE_HANDLED: Data has been handled in the probe and will not be
 547  *        forwarded further. For events and buffers this is the same behaviour as
 548  *        @GST_PAD_PROBE_DROP (except that in this case you need to unref the buffer
 549  *        or event yourself). For queries it will also return %TRUE to the caller.
 550  *        The probe can also modify the #GstFlowReturn value by using the
 551  *        #GST_PAD_PROBE_INFO_FLOW_RETURN() accessor.
 552  *        Note that the resulting query must contain valid entries.
 553  *        Since: 1.6
 554  *
 555  * Different return values for the #GstPadProbeCallback.
 556  */
 557 typedef enum
 558 {
 559   GST_PAD_PROBE_DROP,
 560   GST_PAD_PROBE_OK,
 561   GST_PAD_PROBE_REMOVE,
 562   GST_PAD_PROBE_PASS,
 563   GST_PAD_PROBE_HANDLED
 564 } GstPadProbeReturn;
 565
 566
 567 /**
 568  * GstPadProbeInfo:
 569  * @type: the current probe type
 570  * @id: the id of the probe
 571  * @data: (allow-none): type specific data, check the @type field to know the
 572  *    datatype.  This field can be %NULL.
 573  * @offset: offset of pull probe, this field is valid when @type contains
 574  *    #GST_PAD_PROBE_TYPE_PULL
 575  * @size: size of pull probe, this field is valid when @type contains
 576  *    #GST_PAD_PROBE_TYPE_PULL
 577  *
 578  * Info passed in the #GstPadProbeCallback.
 579  */
 580 struct _GstPadProbeInfo
 581 {
 582   GstPadProbeType type;
 583   gulong id;
 584   gpointer data;
 585   guint64 offset;
 586   guint size;
 587
 588   /*< private >*/
 589   union {
 590     gpointer _gst_reserved[GST_PADDING];
 591     struct {
 592       GstFlowReturn flow_ret;
 593     } abi;
 594   } ABI;
 595 };
 596
 597 #define GST_PAD_PROBE_INFO_TYPE(d)         ((d)->type)
 598 #define GST_PAD_PROBE_INFO_ID(d)           ((d)->id)
 599 #define GST_PAD_PROBE_INFO_DATA(d)         ((d)->data)
 600 #define GST_PAD_PROBE_INFO_FLOW_RETURN(d)  ((d)->ABI.abi.flow_ret)
 601
 602 #define GST_PAD_PROBE_INFO_BUFFER(d)       GST_BUFFER_CAST(GST_PAD_PROBE_INFO_DATA(d))
 603 #define GST_PAD_PROBE_INFO_BUFFER_LIST(d)  GST_BUFFER_LIST_CAST(GST_PAD_PROBE_INFO_DATA(d))
 604 #define GST_PAD_PROBE_INFO_EVENT(d)        GST_EVENT_CAST(GST_PAD_PROBE_INFO_DATA(d))
 605 #define GST_PAD_PROBE_INFO_QUERY(d)        GST_QUERY_CAST(GST_PAD_PROBE_INFO_DATA(d))
 606
 607 #define GST_PAD_PROBE_INFO_OFFSET(d)       ((d)->offset)
 608 #define GST_PAD_PROBE_INFO_SIZE(d)         ((d)->size)
 609
 610 GstEvent*      gst_pad_probe_info_get_event       (GstPadProbeInfo * info);
 611 GstQuery*      gst_pad_probe_info_get_query       (GstPadProbeInfo * info);
 612 GstBuffer*     gst_pad_probe_info_get_buffer      (GstPadProbeInfo * info);
 613 GstBufferList* gst_pad_probe_info_get_buffer_list (GstPadProbeInfo * info);
 614
 615 /**
 616  * GstPadProbeCallback:
 617  * @pad: the #GstPad that is blocked
 618  * @info: #GstPadProbeInfo
 619  * @user_data: the gpointer to optional user data.
 620  *
 621  * Callback used by gst_pad_add_probe(). Gets called to notify about the current
 622  * blocking type.
 623  *
 624  * The callback is allowed to modify the data pointer in @info.
 625  *
 626  * Returns: a #GstPadProbeReturn
 627  */
 628 typedef GstPadProbeReturn   (*GstPadProbeCallback)   (GstPad *pad, GstPadProbeInfo *info,
 629                                                       gpointer user_data);
 630
 631 /**
 632  * GstPadStickyEventsForeachFunction:
 633  * @pad: the #GstPad.
 634  * @event: (allow-none): a sticky #GstEvent.
 635  * @user_data: the #gpointer to optional user data.
 636  *
 637  * Callback used by gst_pad_sticky_events_foreach().
 638  *
 639  * When this function returns %TRUE, the next event will be
 640  * returned. When %FALSE is returned, gst_pad_sticky_events_foreach() will return.
 641  *
 642  * When @event is set to %NULL, the item will be removed from the list of sticky events.
 643  * @event can be replaced by assigning a new reference to it.
 644  * This function is responsible for unreffing the old event when
 645  * removing or modifying.
 646  *
 647  * Returns: %TRUE if the iteration should continue
 648  */
 649 typedef gboolean  (*GstPadStickyEventsForeachFunction) (GstPad *pad, GstEvent **event,
 650                                                         gpointer user_data);
 651
 652 /**
 653  * GstPadFlags:
 654  * @GST_PAD_FLAG_BLOCKED: is dataflow on a pad blocked
 655  * @GST_PAD_FLAG_FLUSHING: is pad flushing
 656  * @GST_PAD_FLAG_EOS: is pad in EOS state
 657  * @GST_PAD_FLAG_BLOCKING: is pad currently blocking on a buffer or event
 658  * @GST_PAD_FLAG_NEED_PARENT: ensure that there is a parent object before calling
 659  *                       into the pad callbacks.
 660  * @GST_PAD_FLAG_NEED_RECONFIGURE: the pad should be reconfigured/renegotiated.
 661  *                            The flag has to be unset manually after
 662  *                            reconfiguration happened.
 663  * @GST_PAD_FLAG_PENDING_EVENTS: the pad has pending events
 664  * @GST_PAD_FLAG_FIXED_CAPS: the pad is using fixed caps. This means that
 665  *     once the caps are set on the pad, the default caps query function
 666  *     will only return those caps.
 667  * @GST_PAD_FLAG_PROXY_CAPS: the default event and query handler will forward
 668  *                      all events and queries to the internally linked pads
 669  *                      instead of discarding them.
 670  * @GST_PAD_FLAG_PROXY_ALLOCATION: the default query handler will forward
 671  *                      allocation queries to the internally linked pads
 672  *                      instead of discarding them.
 673  * @GST_PAD_FLAG_PROXY_SCHEDULING: the default query handler will forward
 674  *                      scheduling queries to the internally linked pads
 675  *                      instead of discarding them.
 676  * @GST_PAD_FLAG_ACCEPT_INTERSECT: the default accept-caps handler will check
 677  *                      it the caps intersect the query-caps result instead
 678  *                      of checking for a subset. This is interesting for
 679  *                      parsers that can accept incompletely specified caps.
 680  * @GST_PAD_FLAG_ACCEPT_TEMPLATE: the default accept-caps handler will use
 681  *                      the template pad caps instead of query caps to
 682  *                      compare with the accept caps. Use this in combination
 683  *                      with %GST_PAD_FLAG_ACCEPT_INTERSECT. (Since 1.6)
 684  * @GST_PAD_FLAG_LAST: offset to define more flags
 685  *
 686  * Pad state flags
 687  */
 688 typedef enum {
 689   GST_PAD_FLAG_BLOCKED          = (GST_OBJECT_FLAG_LAST << 0),
 690   GST_PAD_FLAG_FLUSHING         = (GST_OBJECT_FLAG_LAST << 1),
 691   GST_PAD_FLAG_EOS              = (GST_OBJECT_FLAG_LAST << 2),
 692   GST_PAD_FLAG_BLOCKING         = (GST_OBJECT_FLAG_LAST << 3),
 693   GST_PAD_FLAG_NEED_PARENT      = (GST_OBJECT_FLAG_LAST << 4),
 694   GST_PAD_FLAG_NEED_RECONFIGURE = (GST_OBJECT_FLAG_LAST << 5),
 695   GST_PAD_FLAG_PENDING_EVENTS   = (GST_OBJECT_FLAG_LAST << 6),
 696   GST_PAD_FLAG_FIXED_CAPS       = (GST_OBJECT_FLAG_LAST << 7),
 697   GST_PAD_FLAG_PROXY_CAPS       = (GST_OBJECT_FLAG_LAST << 8),
 698   GST_PAD_FLAG_PROXY_ALLOCATION = (GST_OBJECT_FLAG_LAST << 9),
 699   GST_PAD_FLAG_PROXY_SCHEDULING = (GST_OBJECT_FLAG_LAST << 10),
 700   GST_PAD_FLAG_ACCEPT_INTERSECT = (GST_OBJECT_FLAG_LAST << 11),
 701   GST_PAD_FLAG_ACCEPT_TEMPLATE  = (GST_OBJECT_FLAG_LAST << 12),
 702   /* padding */
 703   GST_PAD_FLAG_LAST        = (GST_OBJECT_FLAG_LAST << 16)
 704 } GstPadFlags;
 705
 706 /**
 707  * GstPad:
 708  * @element_private: private data owned by the parent element
 709  * @padtemplate: padtemplate for this pad
 710  * @direction: the direction of the pad, cannot change after creating
 711  *             the pad.
 712  *
 713  * The #GstPad structure. Use the functions to update the variables.
 714  */
 715 struct _GstPad {
 716   GstObject                      object;
 717
 718   /*< public >*/
 719   gpointer                       element_private;
 720
 721   GstPadTemplate                *padtemplate;
 722
 723   GstPadDirection                direction;
 724
 725   /*< private >*/
 726   /* streaming rec_lock */
 727   GRecMutex                      stream_rec_lock;
 728   GstTask                       *task;
 729
 730   /* block cond, mutex is from the object */
 731   GCond                          block_cond;
 732   GHookList                      probes;
 733
 734   GstPadMode                     mode;
 735   GstPadActivateFunction         activatefunc;
 736   gpointer                       activatedata;
 737   GDestroyNotify                 activatenotify;
 738   GstPadActivateModeFunction     activatemodefunc;
 739   gpointer                       activatemodedata;
 740   GDestroyNotify                 activatemodenotify;
 741
 742   /* pad link */
 743   GstPad                        *peer;
 744   GstPadLinkFunction             linkfunc;
 745   gpointer                       linkdata;
 746   GDestroyNotify                 linknotify;
 747   GstPadUnlinkFunction           unlinkfunc;
 748   gpointer                       unlinkdata;
 749   GDestroyNotify                 unlinknotify;
 750
 751   /* data transport functions */
 752   GstPadChainFunction            chainfunc;
 753   gpointer                       chaindata;
 754   GDestroyNotify                 chainnotify;
 755   GstPadChainListFunction        chainlistfunc;
 756   gpointer                       chainlistdata;
 757   GDestroyNotify                 chainlistnotify;
 758   GstPadGetRangeFunction         getrangefunc;
 759   gpointer                       getrangedata;
 760   GDestroyNotify                 getrangenotify;
 761   GstPadEventFunction            eventfunc;
 762   gpointer                       eventdata;
 763   GDestroyNotify                 eventnotify;
 764
 765   /* pad offset */
 766   gint64                         offset;
 767
 768   /* generic query method */
 769   GstPadQueryFunction            queryfunc;
 770   gpointer                       querydata;
 771   GDestroyNotify                 querynotify;
 772
 773   /* internal links */
 774   GstPadIterIntLinkFunction      iterintlinkfunc;
 775   gpointer                       iterintlinkdata;
 776   GDestroyNotify                 iterintlinknotify;
 777
 778   /* counts number of probes attached. */
 779   gint                           num_probes;
 780   gint                           num_blocked;
 781
 782   GstPadPrivate                 *priv;
 783
 784   union {
 785     gpointer _gst_reserved[GST_PADDING];
 786     struct {
 787       GstFlowReturn last_flowret;
 788       GstPadEventFullFunction eventfullfunc;
 789     } abi;
 790   } ABI;
 791 };
 792
 793 struct _GstPadClass {
 794   GstObjectClass        parent_class;
 795
 796   /* signal callbacks */
 797   void          (*linked)               (GstPad *pad, GstPad *peer);
 798   void          (*unlinked)             (GstPad *pad, GstPad *peer);
 799
 800   /*< private >*/
 801   gpointer _gst_reserved[GST_PADDING];
 802 };
 803
 804
 805 /***** helper macros *****/
 806 /* GstPad */
 807
 808 /**
 809  * GST_PAD_NAME:
 810  * @pad: a #GstPad
 811  *
 812  * Get name of the given pad.
 813  * No locking is performed in this function, use gst_pad_get_name() instead.
 814  */
 815 #define GST_PAD_NAME(pad)               (GST_OBJECT_NAME(pad))
 816 /**
 817  * GST_PAD_PARENT:
 818  * @pad: a #GstPad
 819  *
 820  * Get the @pad parent.
 821  * No locking is performed in this function, use gst_pad_get_parent() instead.
 822  */
 823 #define GST_PAD_PARENT(pad)             (GST_ELEMENT_CAST(GST_OBJECT_PARENT(pad)))
 824 /**
 825  * GST_PAD_ELEMENT_PRIVATE:
 826  * @pad: a #GstPad
 827  *
 828  * Get the private data of @pad, which is usually some pad- or stream-specific
 829  * structure created by the element and set on the pad when creating it.
 830  * No locking is performed in this function.
 831  */
 832 #define GST_PAD_ELEMENT_PRIVATE(pad)    (GST_PAD_CAST(pad)->element_private)
 833 /**
 834  * GST_PAD_PAD_TEMPLATE:
 835  * @pad: a #GstPad
 836  *
 837  * Get the @pad #GstPadTemplate. It describes the possible media types
 838  * a @pad or an element factory can handle.
 839  */
 840 #define GST_PAD_PAD_TEMPLATE(pad)       (GST_PAD_CAST(pad)->padtemplate)
 841 /**
 842  * GST_PAD_DIRECTION:
 843  * @pad: a #GstPad
 844  *
 845  * Get the #GstPadDirection of the given @pad. Accessor macro, use
 846  * gst_pad_get_direction() instead.
 847  */
 848 #define GST_PAD_DIRECTION(pad)          (GST_PAD_CAST(pad)->direction)
 849 /**
 850  * GST_PAD_TASK:
 851  * @pad: a #GstPad
 852  *
 853  * Get the #GstTask of @pad. Accessor macro used by GStreamer. Use the
 854  * gst_pad_start_task(), gst_pad_stop_task() and gst_pad_pause_task()
 855  * functions instead.
 856  */
 857 #define GST_PAD_TASK(pad)               (GST_PAD_CAST(pad)->task)
 858 /**
 859  * GST_PAD_MODE:
 860  * @pad: a #GstPad
 861  *
 862  * Get the #GstPadMode of pad, which will be GST_PAD_MODE_NONE if the pad
 863  * has not been activated yet, and otherwise either GST_PAD_MODE_PUSH or
 864  * GST_PAD_MODE_PULL depending on which mode the pad was activated in.
 865  */
 866 #define GST_PAD_MODE(pad)               (GST_PAD_CAST(pad)->mode)
 867 /**
 868  * GST_PAD_ACTIVATEFUNC:
 869  * @pad: a #GstPad
 870  *
 871  * Get the #GstPadActivateFunction from @pad.
 872  */
 873 #define GST_PAD_ACTIVATEFUNC(pad)       (GST_PAD_CAST(pad)->activatefunc)
 874 /**
 875  * GST_PAD_ACTIVATEMODEFUNC:
 876  * @pad: a #GstPad
 877  *
 878  * Get the #GstPadActivateModeFunction from the given @pad.
 879  */
 880 #define GST_PAD_ACTIVATEMODEFUNC(pad)   (GST_PAD_CAST(pad)->activatemodefunc)
 881 /**
 882  * GST_PAD_CHAINFUNC:
 883  * @pad: a #GstPad
 884  *
 885  * Get the #GstPadChainFunction from the given @pad.
 886  */
 887 #define GST_PAD_CHAINFUNC(pad)          (GST_PAD_CAST(pad)->chainfunc)
 888 /**
 889  * GST_PAD_CHAINLISTFUNC:
 890  * @pad: a #GstPad
 891  *
 892  * Get the #GstPadChainListFunction from the given @pad.
 893  */
 894 #define GST_PAD_CHAINLISTFUNC(pad)      (GST_PAD_CAST(pad)->chainlistfunc)
 895 /**
 896  * GST_PAD_GETRANGEFUNC:
 897  * @pad: a #GstPad
 898  *
 899  * Get the #GstPadGetRangeFunction from the given @pad.
 900  */
 901 #define GST_PAD_GETRANGEFUNC(pad)       (GST_PAD_CAST(pad)->getrangefunc)
 902 /**
 903  * GST_PAD_EVENTFUNC:
 904  * @pad: a #GstPad
 905  *
 906  * Get the #GstPadEventFunction from the given @pad, which
 907  * is the function that handles events on the pad. You can
 908  * use this to set your own event handling function on a pad
 909  * after you create it.  If your element derives from a base
 910  * class, use the base class's virtual functions instead.
 911  */
 912 #define GST_PAD_EVENTFUNC(pad)          (GST_PAD_CAST(pad)->eventfunc)
 913 /**
 914  * GST_PAD_EVENTFULLFUNC:
 915  * @pad: a #GstPad
 916  *
 917  * Get the #GstPadEventFullFunction from the given @pad, which
 918  * is the function that handles events on the pad. You can
 919  * use this to set your own event handling function on a pad
 920  * after you create it.  If your element derives from a base
 921  * class, use the base class's virtual functions instead.
 922  *
 923  * Since: 1.8
 924  */
 925 #define GST_PAD_EVENTFULLFUNC(pad)      (GST_PAD_CAST(pad)->ABI.abi.eventfullfunc)
 926 /**
 927  * GST_PAD_QUERYFUNC:
 928  * @pad: a #GstPad
 929  *
 930  * Get the #GstPadQueryFunction from @pad, which is the function
 931  * that handles queries on the pad. You can  use this to set your
 932  * own query handling function on a pad after you create it. If your
 933  * element derives from a base class, use the base class's virtual
 934  * functions instead.
 935  */
 936 #define GST_PAD_QUERYFUNC(pad)          (GST_PAD_CAST(pad)->queryfunc)
 937 /**
 938  * GST_PAD_ITERINTLINKFUNC:
 939  * @pad: a #GstPad
 940  *
 941  * Get the #GstPadIterIntLinkFunction from the given @pad.
 942  */
 943 #define GST_PAD_ITERINTLINKFUNC(pad)    (GST_PAD_CAST(pad)->iterintlinkfunc)
 944 /**
 945  * GST_PAD_PEER:
 946  * @pad: a #GstPad
 947  *
 948  * Return the pad's peer member. This member is a pointer to the linked @pad.
 949  * No locking is performed in this function, use gst_pad_get_peer() instead.
 950  */
 951 #define GST_PAD_PEER(pad)               (GST_PAD_CAST(pad)->peer)
 952 /**
 953  * GST_PAD_LINKFUNC:
 954  * @pad: a #GstPad
 955  *
 956  * Get the #GstPadLinkFunction for the given @pad.
 957  */
 958 #define GST_PAD_LINKFUNC(pad)           (GST_PAD_CAST(pad)->linkfunc)
 959 /**
 960  * GST_PAD_UNLINKFUNC:
 961  * @pad: a #GstPad
 962  *
 963  * Get the #GstPadUnlinkFunction from the given @pad.
 964  */
 965 #define GST_PAD_UNLINKFUNC(pad)         (GST_PAD_CAST(pad)->unlinkfunc)
 966 /**
 967  * GST_PAD_IS_SRC:
 968  * @pad: a #GstPad
 969  *
 970  * Returns: %TRUE if the pad is a source pad (i.e. produces data).
 971  */
 972 #define GST_PAD_IS_SRC(pad)             (GST_PAD_DIRECTION(pad) == GST_PAD_SRC)
 973 /**
 974  * GST_PAD_IS_SINK:
 975  * @pad: a #GstPad
 976  *
 977  * Returns: %TRUE if the pad is a sink pad (i.e. consumes data).
 978  */
 979 #define GST_PAD_IS_SINK(pad)            (GST_PAD_DIRECTION(pad) == GST_PAD_SINK)
 980 /**
 981  * GST_PAD_IS_LINKED:
 982  * @pad: a #GstPad
 983  *
 984  * Returns: %TRUE if the pad is linked to another pad. Use gst_pad_is_linked()
 985  * instead.
 986  */
 987 #define GST_PAD_IS_LINKED(pad)          (GST_PAD_PEER(pad) != NULL)
 988 /**
 989  * GST_PAD_IS_ACTIVE:
 990  * @pad: a #GstPad
 991  *
 992  * Returns: %TRUE if the pad has been activated.
 993  */
 994 #define GST_PAD_IS_ACTIVE(pad)          (GST_PAD_MODE(pad) != GST_PAD_MODE_NONE)
 995 /**
 996  * GST_PAD_IS_BLOCKED:
 997  * @pad: a #GstPad
 998  *
 999  * Check if the dataflow on a @pad is blocked. Use gst_pad_is_blocked() instead.
1000  */
1001 #define GST_PAD_IS_BLOCKED(pad)         (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_BLOCKED))
1002 /**
1003  * GST_PAD_IS_BLOCKING:
1004  * @pad: a #GstPad
1005  *
1006  * Check if the @pad is currently blocking on a buffer or event. Use
1007  * gst_pad_is_blocking() instead.
1008  */
1009 #define GST_PAD_IS_BLOCKING(pad)        (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_BLOCKING))
1010 /**
1011  * GST_PAD_IS_FLUSHING:
1012  * @pad: a #GstPad
1013  *
1014  * Check if the given @pad is flushing.
1015  */
1016 #define GST_PAD_IS_FLUSHING(pad)        (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_FLUSHING))
1017 /**
1018  * GST_PAD_SET_FLUSHING:
1019  * @pad: a #GstPad
1020  *
1021  * Set the given @pad to flushing state, which means it will not accept any
1022  * more events, queries or buffers, and return GST_FLOW_FLUSHING if any buffers
1023  * are pushed on it. This usually happens when the pad is shut down or when
1024  * a flushing seek happens. This is used inside GStreamer when flush start/stop
1025  * events pass through pads, or when an element state is changed and pads are
1026  * activated or deactivated.
1027  */
1028 #define GST_PAD_SET_FLUSHING(pad)       (GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_FLUSHING))
1029 /**
1030  * GST_PAD_UNSET_FLUSHING:
1031  * @pad: a #GstPad
1032  *
1033  * Unset the flushing flag.
1034  */
1035 #define GST_PAD_UNSET_FLUSHING(pad)     (GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_FLUSHING))
1036 /**
1037  * GST_PAD_IS_EOS:
1038  * @pad: a #GstPad
1039  *
1040  * Check if the @pad is in EOS state.
1041  */
1042 #define GST_PAD_IS_EOS(pad)             (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_EOS))
1043 /**
1044  * GST_PAD_NEEDS_RECONFIGURE:
1045  * @pad: a #GstPad
1046  *
1047  * Check if the @pad should be reconfigured/renegotiated.
1048  * The flag has to be unset manually after reconfiguration happened.
1049  * Use gst_pad_needs_reconfigure() or gst_pad_check_reconfigure() instead.
1050  */
1051 #define GST_PAD_NEEDS_RECONFIGURE(pad)  (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE))
1052 /**
1053  * GST_PAD_HAS_PENDING_EVENTS:
1054  * @pad: a #GstPad
1055  *
1056  * Check if the given @pad has pending events. This is used internally by
1057  * GStreamer.
1058  */
1059 #define GST_PAD_HAS_PENDING_EVENTS(pad) (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_PENDING_EVENTS))
1060 /**
1061  * GST_PAD_IS_FIXED_CAPS:
1062  * @pad: a #GstPad
1063  *
1064  * Check if the given @pad is using fixed caps, which means that
1065  * once the caps are set on the @pad, the caps query function will
1066  * only return those caps. See gst_pad_use_fixed_caps().
1067  */
1068 #define GST_PAD_IS_FIXED_CAPS(pad)      (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_FIXED_CAPS))
1069 /**
1070  * GST_PAD_NEEDS_PARENT:
1071  * @pad: a #GstPad
1072  *
1073  * Check if there is a parent object before calling into the @pad callbacks.
1074  * This is used internally by GStreamer.
1075  */
1076 #define GST_PAD_NEEDS_PARENT(pad)       (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_NEED_PARENT))
1077 /**
1078  * GST_PAD_IS_PROXY_CAPS:
1079  * @pad: a #GstPad
1080  *
1081  * Check if the given @pad is set to proxy caps. This means that the default
1082  * event and query handler will forward all events and queries to the
1083  * internally linked @pads instead of discarding them.
1084  */
1085 #define GST_PAD_IS_PROXY_CAPS(pad)      (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_PROXY_CAPS))
1086 /**
1087  * GST_PAD_SET_PROXY_CAPS:
1088  * @pad: a #GstPad
1089  *
1090  * Set @pad to proxy caps, so that all caps-related events and queries are
1091  * proxied down- or upstream to the other side of the element automatically.
1092  * Set this if the element always outputs data in the exact same format as it
1093  * receives as input. This is just for convenience to avoid implementing some
1094  * standard event and query handling code in an element.
1095  */
1096 #define GST_PAD_SET_PROXY_CAPS(pad)     (GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PROXY_CAPS))
1097 /**
1098  * GST_PAD_UNSET_PROXY_CAPS:
1099  * @pad: a #GstPad
1100  *
1101  * Unset proxy caps flag.
1102  */
1103 #define GST_PAD_UNSET_PROXY_CAPS(pad)   (GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PROXY_CAPS))
1104 /**
1105  * GST_PAD_IS_PROXY_ALLOCATION:
1106  * @pad: a #GstPad
1107  *
1108  * Check if the given @pad is set as proxy allocation which means
1109  * that the default query handler will forward allocation queries to the
1110  * internally linked @pads instead of discarding them.
1111  */
1112 #define GST_PAD_IS_PROXY_ALLOCATION(pad)    (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_PROXY_ALLOCATION))
1113 /**
1114  * GST_PAD_SET_PROXY_ALLOCATION:
1115  * @pad: a #GstPad
1116  *
1117  * Set @pad to proxy allocation queries, which means that the default query
1118  * handler will forward allocation queries to the internally linked @pads
1119  * instead of discarding them.
1120  * Set this if the element always outputs data in the exact same format as it
1121  * receives as input. This is just for convenience to avoid implementing some
1122  * standard query handling code in an element.
1123  */
1124 #define GST_PAD_SET_PROXY_ALLOCATION(pad)   (GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PROXY_ALLOCATION))
1125 /**
1126  * GST_PAD_UNSET_PROXY_ALLOCATION:
1127  * @pad: a #GstPad
1128  *
1129  * Unset proxy allocation flag.
1130  */
1131 #define GST_PAD_UNSET_PROXY_ALLOCATION(pad) (GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PROXY_ALLOCATION))
1132 /**
1133  * GST_PAD_IS_PROXY_SCHEDULING:
1134  * @pad: a #GstPad
1135  *
1136  * Check if the given @pad is set to proxy scheduling queries, which means that
1137  * the default query handler will forward scheduling queries to the internally
1138  * linked @pads instead of discarding them.
1139  */
1140 #define GST_PAD_IS_PROXY_SCHEDULING(pad)    (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_PROXY_SCHEDULING))
1141 /**
1142  * GST_PAD_SET_PROXY_SCHEDULING:
1143  * @pad: a #GstPad
1144  *
1145  * Set @pad to proxy scheduling queries, which means that the default query
1146  * handler will forward scheduling queries to the internally linked @pads
1147  * instead of discarding them. You will usually want to handle scheduling
1148  * queries explicitly if your element supports multiple scheduling modes.
1149  */
1150 #define GST_PAD_SET_PROXY_SCHEDULING(pad)   (GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PROXY_SCHEDULING))
1151 /**
1152  * GST_PAD_UNSET_PROXY_SCHEDULING:
1153  * @pad: a #GstPad
1154  *
1155  * Unset proxy scheduling flag.
1156  */
1157 #define GST_PAD_UNSET_PROXY_SCHEDULING(pad) (GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PROXY_SCHEDULING))
1158 /**
1159  * GST_PAD_IS_ACCEPT_INTERSECT:
1160  * @pad: a #GstPad
1161  *
1162  * Check if the pad's accept intersect flag is set. The default accept-caps
1163  * handler will check if the caps intersect the query-caps result instead of
1164  * checking for a subset. This is interesting for parser elements that can
1165  * accept incompletely specified caps.
1166  */
1167 #define GST_PAD_IS_ACCEPT_INTERSECT(pad)    (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_ACCEPT_INTERSECT))
1168 /**
1169  * GST_PAD_SET_ACCEPT_INTERSECT:
1170  * @pad: a #GstPad
1171  *
1172  * Set @pad to by default accept caps by intersecting the result instead of
1173  * checking for a subset. This is interesting for parser elements that can
1174  * accept incompletely specified caps.
1175  */
1176 #define GST_PAD_SET_ACCEPT_INTERSECT(pad)   (GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_ACCEPT_INTERSECT))
1177 /**
1178  * GST_PAD_UNSET_ACCEPT_INTERSECT:
1179  * @pad: a #GstPad
1180  *
1181  * Unset accept intersect flag.
1182  */
1183 #define GST_PAD_UNSET_ACCEPT_INTERSECT(pad) (GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_ACCEPT_INTERSECT))
1184 /**
1185  * GST_PAD_IS_ACCEPT_TEMPLATE:
1186  * @pad: a #GstPad
1187  *
1188  * Check if the pad's accept caps operation will use the pad template caps.
1189  * The default accept-caps will do a query caps to get the caps, which might
1190  * be querying downstream causing unnecessary overhead. It is recommended to
1191  * implement a proper accept-caps query handler or to use this flag to prevent
1192  * recursive accept-caps handling.
1193  *
1194  * Since: 1.6
1195  */
1196 #define GST_PAD_IS_ACCEPT_TEMPLATE(pad)    (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_ACCEPT_TEMPLATE))
1197 /**
1198  * GST_PAD_SET_ACCEPT_TEMPLATE:
1199  * @pad: a #GstPad
1200  *
1201  * Set @pad to by default use the pad template caps to compare with
1202  * the accept caps instead of using a caps query result.
1203  *
1204  * Since: 1.6
1205  */
1206 #define GST_PAD_SET_ACCEPT_TEMPLATE(pad)   (GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_ACCEPT_TEMPLATE))
1207 /**
1208  * GST_PAD_UNSET_ACCEPT_TEMPLATE:
1209  * @pad: a #GstPad
1210  *
1211  * Unset accept template flag.
1212  *
1213  * Since: 1.6
1214  */
1215 #define GST_PAD_UNSET_ACCEPT_TEMPLATE(pad) (GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_ACCEPT_TEMPLATE))
1216 /**
1217  * GST_PAD_GET_STREAM_LOCK:
1218  * @pad: a #GstPad
1219  *
1220  * Get the stream lock of @pad. The stream lock is protecting the
1221  * resources used in the data processing functions of @pad. Accessor
1222  * macro, use GST_PAD_STREAM_LOCK() and GST_PAD_STREAM_UNLOCK() instead
1223  * to take/release the pad's stream lock.
1224  */
1225 #define GST_PAD_GET_STREAM_LOCK(pad)    (&(GST_PAD_CAST(pad)->stream_rec_lock))
1226 /**
1227  * GST_PAD_STREAM_LOCK:
1228  * @pad: a #GstPad
1229  *
1230  * Take the pad's stream lock. The stream lock is recursive and will be taken
1231  * when buffers or serialized downstream events are pushed on a pad.
1232  */
1233 #define GST_PAD_STREAM_LOCK(pad)        g_rec_mutex_lock(GST_PAD_GET_STREAM_LOCK(pad))
1234 /**
1235  * GST_PAD_STREAM_TRYLOCK:
1236  * @pad: a #GstPad
1237  *
1238  * Try to take the pad's stream lock, and return %TRUE if the lock could be
1239  * taken, and otherwise %FALSE.
1240  */
1241 #define GST_PAD_STREAM_TRYLOCK(pad)     g_rec_mutex_trylock(GST_PAD_GET_STREAM_LOCK(pad))
1242 /**
1243  * GST_PAD_STREAM_UNLOCK:
1244  * @pad: a #GstPad
1245  *
1246  * Release the pad's stream lock.
1247  */
1248 #define GST_PAD_STREAM_UNLOCK(pad)      g_rec_mutex_unlock(GST_PAD_GET_STREAM_LOCK(pad))
1249 /**
1250  * GST_PAD_LAST_FLOW_RETURN:
1251  * @pad: a #GstPad
1252  *
1253  * Gets the last flow return on this pad
1254  *
1255  * Since: 1.4
1256  */
1257 #define GST_PAD_LAST_FLOW_RETURN(pad)   (GST_PAD_CAST(pad)->ABI.abi.last_flowret)
1258
1259 #define GST_PAD_BLOCK_GET_COND(pad)     (&GST_PAD_CAST(pad)->block_cond)
1260 #define GST_PAD_BLOCK_WAIT(pad)         (g_cond_wait(GST_PAD_BLOCK_GET_COND (pad), GST_OBJECT_GET_LOCK (pad)))
1261 #define GST_PAD_BLOCK_SIGNAL(pad)       (g_cond_signal(GST_PAD_BLOCK_GET_COND (pad)))
1262 #define GST_PAD_BLOCK_BROADCAST(pad)    (g_cond_broadcast(GST_PAD_BLOCK_GET_COND (pad)))
1263
1264 GType                   gst_pad_get_type                        (void);
1265
1266 /* creating pads */
1267 GstPad*                 gst_pad_new                             (const gchar *name, GstPadDirection direction);
1268 GstPad*                 gst_pad_new_from_template               (GstPadTemplate *templ, const gchar *name);
1269 GstPad*                 gst_pad_new_from_static_template        (GstStaticPadTemplate *templ, const gchar *name);
1270
1271
1272 /**
1273  * gst_pad_get_name:
1274  * @pad: the pad to get the name from
1275  *
1276  * Get a copy of the name of the pad. g_free() after usage.
1277  *
1278  * MT safe.
1279  */
1280 #define gst_pad_get_name(pad) gst_object_get_name (GST_OBJECT_CAST (pad))
1281 /**
1282  * gst_pad_get_parent:
1283  * @pad: the pad to get the parent of
1284  *
1285  * Get the parent of @pad. This function increases the refcount
1286  * of the parent object so you should gst_object_unref() it after usage.
1287  * Can return %NULL if the pad did not have a parent.
1288  *
1289  * MT safe.
1290  *
1291  * Returns: (nullable): the parent
1292  */
1293 #define gst_pad_get_parent(pad) gst_object_get_parent (GST_OBJECT_CAST (pad))
1294
1295 GstPadDirection         gst_pad_get_direction                   (GstPad *pad);
1296
1297 gboolean                gst_pad_set_active                      (GstPad *pad, gboolean active);
1298 gboolean                gst_pad_is_active                       (GstPad *pad);
1299 gboolean                gst_pad_activate_mode                   (GstPad *pad, GstPadMode mode,
1300                                                                  gboolean active);
1301
1302 gulong                  gst_pad_add_probe                       (GstPad *pad,
1303                                                                  GstPadProbeType mask,
1304                                                                  GstPadProbeCallback callback,
1305                                                                  gpointer user_data,
1306                                                                  GDestroyNotify destroy_data);
1307 void                    gst_pad_remove_probe                    (GstPad *pad, gulong id);
1308
1309 gboolean                gst_pad_is_blocked                      (GstPad *pad);
1310 gboolean                gst_pad_is_blocking                     (GstPad *pad);
1311
1312 void                    gst_pad_mark_reconfigure                (GstPad *pad);
1313 gboolean                gst_pad_needs_reconfigure               (GstPad *pad);
1314 gboolean                gst_pad_check_reconfigure               (GstPad *pad);
1315
1316 void                    gst_pad_set_element_private             (GstPad *pad, gpointer priv);
1317 gpointer                gst_pad_get_element_private             (GstPad *pad);
1318
1319 GstPadTemplate*         gst_pad_get_pad_template                (GstPad *pad);
1320
1321 GstFlowReturn           gst_pad_store_sticky_event              (GstPad *pad, GstEvent *event);
1322 GstEvent*               gst_pad_get_sticky_event                (GstPad *pad, GstEventType event_type,
1323                                                                  guint idx);
1324 void                    gst_pad_sticky_events_foreach           (GstPad *pad, GstPadStickyEventsForeachFunction foreach_func, gpointer user_data);
1325
1326 /* data passing setup functions */
1327 void                    gst_pad_set_activate_function_full      (GstPad *pad,
1328                                                                  GstPadActivateFunction activate,
1329                                                                  gpointer user_data,
1330                                                                  GDestroyNotify notify);
1331 void                    gst_pad_set_activatemode_function_full  (GstPad *pad,
1332                                                                  GstPadActivateModeFunction activatemode,
1333                                                                  gpointer user_data,
1334                                                                  GDestroyNotify notify);
1335 /* data passing functions */
1336 void                    gst_pad_set_chain_function_full         (GstPad *pad,
1337                                                                  GstPadChainFunction chain,
1338                                                                  gpointer user_data,
1339                                                                  GDestroyNotify notify);
1340 void                    gst_pad_set_chain_list_function_full    (GstPad *pad,
1341                                                                  GstPadChainListFunction chainlist,
1342                                                                  gpointer user_data,
1343                                                                  GDestroyNotify notify);
1344 void                    gst_pad_set_getrange_function_full      (GstPad *pad,
1345                                                                  GstPadGetRangeFunction get,
1346                                                                  gpointer user_data,
1347                                                                  GDestroyNotify notify);
1348 void                    gst_pad_set_event_function_full         (GstPad *pad,
1349                                                                  GstPadEventFunction event,
1350                                                                  gpointer user_data,
1351                                                                  GDestroyNotify notify);
1352 void                    gst_pad_set_event_full_function_full    (GstPad *pad,
1353                                                                  GstPadEventFullFunction event,
1354                                                                  gpointer user_data,
1355                                                                  GDestroyNotify notify);
1356
1357 #define gst_pad_set_activate_function(p,f)      gst_pad_set_activate_function_full((p),(f),NULL,NULL)
1358 #define gst_pad_set_activatemode_function(p,f)  gst_pad_set_activatemode_function_full((p),(f),NULL,NULL)
1359 #define gst_pad_set_chain_function(p,f)         gst_pad_set_chain_function_full((p),(f),NULL,NULL)
1360 #define gst_pad_set_chain_list_function(p,f)    gst_pad_set_chain_list_function_full((p),(f),NULL,NULL)
1361 #define gst_pad_set_getrange_function(p,f)      gst_pad_set_getrange_function_full((p),(f),NULL,NULL)
1362 #define gst_pad_set_event_function(p,f)         gst_pad_set_event_function_full((p),(f),NULL,NULL)
1363 #define gst_pad_set_event_full_function(p,f)    gst_pad_set_event_full_function_full((p),(f),NULL,NULL)
1364
1365 /* pad links */
1366 void                    gst_pad_set_link_function_full          (GstPad *pad,
1367                                                                  GstPadLinkFunction link,
1368                                                                  gpointer user_data,
1369                                                                  GDestroyNotify notify);
1370 void                    gst_pad_set_unlink_function_full        (GstPad *pad,
1371                                                                  GstPadUnlinkFunction unlink,
1372                                                                  gpointer user_data,
1373                                                                  GDestroyNotify notify);
1374
1375 #define gst_pad_set_link_function(p,f)          gst_pad_set_link_function_full((p),(f),NULL,NULL)
1376 #define gst_pad_set_unlink_function(p,f)        gst_pad_set_unlink_function_full((p),(f),NULL,NULL)
1377
1378 gboolean                gst_pad_can_link                        (GstPad *srcpad, GstPad *sinkpad);
1379 GstPadLinkReturn        gst_pad_link                            (GstPad *srcpad, GstPad *sinkpad);
1380 GstPadLinkReturn        gst_pad_link_full                       (GstPad *srcpad, GstPad *sinkpad, GstPadLinkCheck flags);
1381 gboolean                gst_pad_unlink                          (GstPad *srcpad, GstPad *sinkpad);
1382 gboolean                gst_pad_is_linked                       (GstPad *pad);
1383
1384 GstPad*                 gst_pad_get_peer                        (GstPad *pad);
1385
1386 GstCaps*                gst_pad_get_pad_template_caps           (GstPad *pad);
1387
1388 /* capsnego function for linked/unlinked pads */
1389 GstCaps *               gst_pad_get_current_caps                (GstPad * pad);
1390 gboolean                gst_pad_has_current_caps                (GstPad * pad);
1391
1392 /* capsnego for linked pads */
1393 GstCaps *               gst_pad_get_allowed_caps                (GstPad * pad);
1394
1395 /* pad offsets */
1396 gint64                  gst_pad_get_offset                      (GstPad *pad);
1397 void                    gst_pad_set_offset                      (GstPad *pad, gint64 offset);
1398
1399 /* data passing functions to peer */
1400 GstFlowReturn           gst_pad_push                            (GstPad *pad, GstBuffer *buffer);
1401 GstFlowReturn           gst_pad_push_list                       (GstPad *pad, GstBufferList *list);
1402 GstFlowReturn           gst_pad_pull_range                      (GstPad *pad, guint64 offset, guint size,
1403                                                                  GstBuffer **buffer);
1404 gboolean                gst_pad_push_event                      (GstPad *pad, GstEvent *event);
1405 gboolean                gst_pad_event_default                   (GstPad *pad, GstObject *parent,
1406                                                                  GstEvent *event);
1407 GstFlowReturn           gst_pad_get_last_flow_return            (GstPad *pad);
1408
1409 /* data passing functions on pad */
1410 GstFlowReturn           gst_pad_chain                           (GstPad *pad, GstBuffer *buffer);
1411 GstFlowReturn           gst_pad_chain_list                      (GstPad *pad, GstBufferList *list);
1412 GstFlowReturn           gst_pad_get_range                       (GstPad *pad, guint64 offset, guint size,
1413                                                                  GstBuffer **buffer);
1414 gboolean                gst_pad_send_event                      (GstPad *pad, GstEvent *event);
1415
1416 /* pad tasks */
1417 gboolean                gst_pad_start_task                      (GstPad *pad, GstTaskFunction func,
1418                                                                  gpointer user_data, GDestroyNotify notify);
1419 gboolean                gst_pad_pause_task                      (GstPad *pad);
1420 gboolean                gst_pad_stop_task                       (GstPad *pad);
1421
1422 /* internal links */
1423 void                    gst_pad_set_iterate_internal_links_function_full (GstPad * pad,
1424                                                                  GstPadIterIntLinkFunction iterintlink,
1425                                                                  gpointer user_data,
1426                                                                  GDestroyNotify notify);
1427 GstIterator *           gst_pad_iterate_internal_links          (GstPad * pad);
1428 GstIterator *           gst_pad_iterate_internal_links_default  (GstPad * pad, GstObject *parent);
1429
1430 #define gst_pad_set_iterate_internal_links_function(p,f) gst_pad_set_iterate_internal_links_function_full((p),(f),NULL,NULL)
1431
1432 /* generic query function */
1433 gboolean                gst_pad_query                           (GstPad *pad, GstQuery *query);
1434 gboolean                gst_pad_peer_query                      (GstPad *pad, GstQuery *query);
1435 void                    gst_pad_set_query_function_full         (GstPad *pad, GstPadQueryFunction query,
1436                                                                  gpointer user_data,
1437                                                                  GDestroyNotify notify);
1438 gboolean                gst_pad_query_default                   (GstPad *pad, GstObject *parent,
1439                                                                  GstQuery *query);
1440
1441 #define gst_pad_set_query_function(p,f)   gst_pad_set_query_function_full((p),(f),NULL,NULL)
1442
1443 /* misc helper functions */
1444 gboolean                gst_pad_forward                         (GstPad *pad, GstPadForwardFunction forward,
1445                                                                  gpointer user_data);
1446
1447 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
1448 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstPad, gst_object_unref)
1449 #endif
1450
1451 G_END_DECLS
1452
1453 #endif /* __GST_PAD_H__ */