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., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, 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
  33 /**
  34  * GstPadDirection:
  35  * @GST_PAD_UNKNOWN: direction is unknown.
  36  * @GST_PAD_SRC: the pad is a source pad.
  37  * @GST_PAD_SINK: the pad is a sink pad.
  38  *
  39  * The direction of a pad.
  40  */
  41 typedef enum {
  42   GST_PAD_UNKNOWN,
  43   GST_PAD_SRC,
  44   GST_PAD_SINK
  45 } GstPadDirection;
  46
  47 /**
  48  * GstPadMode:
  49  * @GST_PAD_MODE_NONE: Pad will not handle dataflow
  50  * @GST_PAD_MODE_PUSH: Pad handles dataflow in downstream push mode
  51  * @GST_PAD_MODE_PULL: Pad handles dataflow in upstream pull mode
  52  *
  53  * The status of a GstPad. After activating a pad, which usually happens when the
  54  * parent element goes from READY to PAUSED, the GstPadMode defines if the
  55  * pad operates in push or pull mode.
  56  */
  57 typedef enum {
  58   GST_PAD_MODE_NONE,
  59   GST_PAD_MODE_PUSH,
  60   GST_PAD_MODE_PULL
  61 } GstPadMode;
  62
  63 #include <gst/gstobject.h>
  64 #include <gst/gstbuffer.h>
  65 #include <gst/gstbufferlist.h>
  66 #include <gst/gstcaps.h>
  67 #include <gst/gstpadtemplate.h>
  68 #include <gst/gstevent.h>
  69 #include <gst/gstquery.h>
  70 #include <gst/gsttask.h>
  71
  72 G_BEGIN_DECLS
  73
  74 /*
  75  * Pad base class
  76  */
  77 #define GST_TYPE_PAD                    (gst_pad_get_type ())
  78 #define GST_IS_PAD(obj)                 (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PAD))
  79 #define GST_IS_PAD_CLASS(klass)         (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PAD))
  80 #define GST_PAD(obj)                    (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PAD, GstPad))
  81 #define GST_PAD_CLASS(klass)            (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PAD, GstPadClass))
  82 #define GST_PAD_CAST(obj)               ((GstPad*)(obj))
  83
  84
  85
  86 /**
  87  * GstPadLinkReturn:
  88  * @GST_PAD_LINK_OK             : link succeeded
  89  * @GST_PAD_LINK_WRONG_HIERARCHY: pads have no common grandparent
  90  * @GST_PAD_LINK_WAS_LINKED     : pad was already linked
  91  * @GST_PAD_LINK_WRONG_DIRECTION: pads have wrong direction
  92  * @GST_PAD_LINK_NOFORMAT       : pads do not have common format
  93  * @GST_PAD_LINK_NOSCHED        : pads cannot cooperate in scheduling
  94  * @GST_PAD_LINK_REFUSED        : refused for some reason
  95  *
  96  * Result values from gst_pad_link and friends.
  97  */
  98 typedef enum {
  99   GST_PAD_LINK_OK               =  0,
 100   GST_PAD_LINK_WRONG_HIERARCHY  = -1,
 101   GST_PAD_LINK_WAS_LINKED       = -2,
 102   GST_PAD_LINK_WRONG_DIRECTION  = -3,
 103   GST_PAD_LINK_NOFORMAT         = -4,
 104   GST_PAD_LINK_NOSCHED          = -5,
 105   GST_PAD_LINK_REFUSED          = -6
 106 } GstPadLinkReturn;
 107
 108 /**
 109  * GST_PAD_LINK_FAILED:
 110  * @ret: the #GstPadLinkReturn value
 111  *
 112  * Macro to test if the given #GstPadLinkReturn value indicates a failed
 113  * link step.
 114  */
 115 #define GST_PAD_LINK_FAILED(ret) ((ret) < GST_PAD_LINK_OK)
 116
 117 /**
 118  * GST_PAD_LINK_SUCCESSFUL:
 119  * @ret: the #GstPadLinkReturn value
 120  *
 121  * Macro to test if the given #GstPadLinkReturn value indicates a successful
 122  * link step.
 123  */
 124 #define GST_PAD_LINK_SUCCESSFUL(ret) ((ret) >= GST_PAD_LINK_OK)
 125
 126 /**
 127  * GstFlowReturn:
 128  * @GST_FLOW_OK:                 Data passing was ok.
 129  * @GST_FLOW_NOT_LINKED:         Pad is not linked.
 130  * @GST_FLOW_WRONG_STATE:        Pad is in wrong state.
 131  * @GST_FLOW_EOS:                Pad is EOS.
 132  * @GST_FLOW_NOT_NEGOTIATED:     Pad is not negotiated.
 133  * @GST_FLOW_ERROR:              Some (fatal) error occured. Element generating
 134  *                               this error should post an error message with more
 135  *                               details.
 136  * @GST_FLOW_NOT_SUPPORTED:      This operation is not supported.
 137  * @GST_FLOW_CUSTOM_SUCCESS:     Elements can use values starting from
 138  *                               this (and higher) to define custom success
 139  *                               codes. Since 0.10.7.
 140  * @GST_FLOW_CUSTOM_SUCCESS_1:   Pre-defined custom success code (define your
 141  *                               custom success code to this to avoid compiler
 142  *                               warnings). Since 0.10.29.
 143  * @GST_FLOW_CUSTOM_SUCCESS_2:   Pre-defined custom success code. Since 0.10.29.
 144  * @GST_FLOW_CUSTOM_ERROR:       Elements can use values starting from
 145  *                               this (and lower) to define custom error codes.
 146  *                               Since 0.10.7.
 147  * @GST_FLOW_CUSTOM_ERROR_1:     Pre-defined custom error code (define your
 148  *                               custom error code to this to avoid compiler
 149  *                               warnings). Since 0.10.29.
 150  * @GST_FLOW_CUSTOM_ERROR_2:     Pre-defined custom error code. Since 0.10.29.
 151  *
 152  * The result of passing data to a pad.
 153  *
 154  * Note that the custom return values should not be exposed outside of the
 155  * element scope and are available since 0.10.7.
 156  */
 157 /* FIXME 0.11: remove custom flow returns */
 158 typedef enum {
 159   /* custom success starts here */
 160   GST_FLOW_CUSTOM_SUCCESS_2 = 102,
 161   GST_FLOW_CUSTOM_SUCCESS_1 = 101,
 162   GST_FLOW_CUSTOM_SUCCESS = 100,
 163
 164   /* core predefined */
 165   GST_FLOW_OK             =  0,
 166   /* expected failures */
 167   GST_FLOW_NOT_LINKED     = -1,
 168   GST_FLOW_WRONG_STATE    = -2,
 169   /* error cases */
 170   GST_FLOW_EOS            = -3,
 171   GST_FLOW_NOT_NEGOTIATED = -4,
 172   GST_FLOW_ERROR          = -5,
 173   GST_FLOW_NOT_SUPPORTED  = -6,
 174
 175   /* custom error starts here */
 176   GST_FLOW_CUSTOM_ERROR   = -100,
 177   GST_FLOW_CUSTOM_ERROR_1 = -101,
 178   GST_FLOW_CUSTOM_ERROR_2 = -102
 179 } GstFlowReturn;
 180
 181 const gchar*            gst_flow_get_name       (GstFlowReturn ret);
 182 GQuark                  gst_flow_to_quark       (GstFlowReturn ret);
 183
 184 /**
 185  * GstPadLinkCheck:
 186  * @GST_PAD_LINK_CHECK_NOTHING: Don't check hierarchy or caps compatibility.
 187  * @GST_PAD_LINK_CHECK_HIERARCHY: Check the pads have same parents/grandparents.
 188  *   Could be omitted if it is already known that the two elements that own the
 189  *   pads are in the same bin.
 190  * @GST_PAD_LINK_CHECK_TEMPLATE_CAPS: Check if the pads are compatible by using
 191  *   their template caps. This is much faster than @GST_PAD_LINK_CHECK_CAPS, but
 192  *   would be unsafe e.g. if one pad has %GST_CAPS_ANY.
 193  * @GST_PAD_LINK_CHECK_CAPS: Check if the pads are compatible by comparing the
 194  *   caps returned by gst_pad_query_caps().
 195  *
 196  * The amount of checking to be done when linking pads. @GST_PAD_LINK_CHECK_CAPS
 197  * and @GST_PAD_LINK_CHECK_TEMPLATE_CAPS are mutually exclusive. If both are
 198  * specified, expensive but safe @GST_PAD_LINK_CHECK_CAPS are performed.
 199  *
 200  * <warning><para>
 201  * Only disable some of the checks if you are 100% certain you know the link
 202  * will not fail because of hierarchy/caps compatibility failures. If uncertain,
 203  * use the default checks (%GST_PAD_LINK_CHECK_DEFAULT) or the regular methods
 204  * for linking the pads.
 205  * </para></warning>
 206  *
 207  * Since: 0.10.30
 208  */
 209
 210 typedef enum {
 211   GST_PAD_LINK_CHECK_NOTHING       = 0,
 212   GST_PAD_LINK_CHECK_HIERARCHY     = 1 << 0,
 213   GST_PAD_LINK_CHECK_TEMPLATE_CAPS = 1 << 1,
 214   GST_PAD_LINK_CHECK_CAPS          = 1 << 2
 215 } GstPadLinkCheck;
 216
 217 /**
 218  * GST_PAD_LINK_CHECK_DEFAULT:
 219  *
 220  * The default checks done when linking pads (i.e. the ones used by
 221  * gst_pad_link()).
 222  *
 223  * Since: 0.10.30
 224  */
 225 #define GST_PAD_LINK_CHECK_DEFAULT ((GstPadLinkCheck) (GST_PAD_LINK_CHECK_HIERARCHY | GST_PAD_LINK_CHECK_CAPS))
 226
 227 /* pad states */
 228 /**
 229  * GstPadActivateFunction:
 230  * @pad: a #GstPad
 231  * @parent: the parent of @pad
 232  *
 233  * This function is called when the pad is activated during the element
 234  * READY to PAUSED state change. By default this function will call the
 235  * activate function that puts the pad in push mode but elements can
 236  * override this function to activate the pad in pull mode if they wish.
 237  *
 238  * Returns: TRUE if the pad could be activated.
 239  */
 240 typedef gboolean                (*GstPadActivateFunction)       (GstPad *pad, GstObject *parent);
 241 /**
 242  * GstPadActivateModeFunction:
 243  * @pad: a #GstPad
 244  * @parent: the parent of @pad
 245  * @mode: the requested activation mode of @pad
 246  * @active: activate or deactivate the pad.
 247  *
 248  * The prototype of the push and pull activate functions.
 249  *
 250  * Returns: TRUE if the pad could be activated or deactivated.
 251  */
 252 typedef gboolean                (*GstPadActivateModeFunction)   (GstPad *pad, GstObject *parent,
 253                                                                  GstPadMode mode, gboolean active);
 254
 255
 256 /* data passing */
 257 /**
 258  * GstPadChainFunction:
 259  * @pad: the sink #GstPad that performed the chain.
 260  * @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set,
 261  *          @parent is guaranteed to be not-NULL and remain valid during the
 262  *          execution of this function.
 263  * @buffer: the #GstBuffer that is chained, not %NULL.
 264  *
 265  * A function that will be called on sinkpads when chaining buffers.
 266  * The function typically processes the data contained in the buffer and
 267  * either consumes the data or passes it on to the internally linked pad(s).
 268  *
 269  * The implementer of this function receives a refcount to @buffer and should
 270  * gst_buffer_unref() when the buffer is no longer needed.
 271  *
 272  * When a chain function detects an error in the data stream, it must post an
 273  * error on the bus and return an appropriate #GstFlowReturn value.
 274  *
 275  * Returns: #GST_FLOW_OK for success
 276  */
 277 typedef GstFlowReturn           (*GstPadChainFunction)          (GstPad *pad, GstObject *parent,
 278                                                                  GstBuffer *buffer);
 279
 280 /**
 281  * GstPadChainListFunction:
 282  * @pad: the sink #GstPad that performed the chain.
 283  * @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set,
 284  *          @parent is guaranteed to be not-NULL and remain valid during the
 285  *          execution of this function.
 286  * @list: the #GstBufferList that is chained, not %NULL.
 287  *
 288  * A function that will be called on sinkpads when chaining buffer lists.
 289  * The function typically processes the data contained in the buffer list and
 290  * either consumes the data or passes it on to the internally linked pad(s).
 291  *
 292  * The implementer of this function receives a refcount to @list and
 293  * should gst_buffer_list_unref() when the list is no longer needed.
 294  *
 295  * When a chainlist function detects an error in the data stream, it must
 296  * post an error on the bus and return an appropriate #GstFlowReturn value.
 297  *
 298  * Returns: #GST_FLOW_OK for success
 299  */
 300 typedef GstFlowReturn           (*GstPadChainListFunction)      (GstPad *pad, GstObject *parent,
 301                                                                  GstBufferList *list);
 302
 303 /**
 304  * GstPadGetRangeFunction:
 305  * @pad: the src #GstPad to perform the getrange on.
 306  * @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set,
 307  *          @parent is guaranteed to be not-NULL and remain valid during the
 308  *          execution of this function.
 309  * @offset: the offset of the range
 310  * @length: the length of the range
 311  * @buffer: a memory location to hold the result buffer, cannot be NULL.
 312  *
 313  * This function will be called on source pads when a peer element
 314  * request a buffer at the specified @offset and @length. If this function
 315  * returns #GST_FLOW_OK, the result buffer will be stored in @buffer. The
 316  * contents of @buffer is invalid for any other return value.
 317  *
 318  * This function is installed on a source pad with
 319  * gst_pad_set_getrange_function() and can only be called on source pads after
 320  * they are successfully activated with gst_pad_activate_pull().
 321  *
 322  * @offset and @length are always given in byte units. @offset must normally be a value
 323  * between 0 and the length in bytes of the data available on @pad. The
 324  * length (duration in bytes) can be retrieved with a #GST_QUERY_DURATION or with a
 325  * #GST_QUERY_SEEKING.
 326  *
 327  * Any @offset larger or equal than the length will make the function return
 328  * #GST_FLOW_UNEXPECTED, which corresponds to EOS. In this case @buffer does not
 329  * contain a valid buffer.
 330  *
 331  * The buffer size of @buffer will only be smaller than @length when @offset is
 332  * near the end of the stream. In all other cases, the size of @buffer must be
 333  * exactly the requested size.
 334  *
 335  * It is allowed to call this function with a 0 @length and valid @offset, in
 336  * which case @buffer will contain a 0-sized buffer and the function returns
 337  * #GST_FLOW_OK.
 338  *
 339  * When this function is called with a -1 @offset, the sequentially next buffer
 340  * of length @length in the stream is returned.
 341  *
 342  * When this function is called with a -1 @length, a buffer with a default
 343  * optimal length is returned in @buffer. The length might depend on the value
 344  * of @offset.
 345  *
 346  * Returns: #GST_FLOW_OK for success and a valid buffer in @buffer. Any other
 347  * return value leaves @buffer undefined.
 348  */
 349 typedef GstFlowReturn           (*GstPadGetRangeFunction)       (GstPad *pad, GstObject *parent,
 350                                                                  guint64 offset, guint length,
 351                                                                  GstBuffer **buffer);
 352
 353 /**
 354  * GstPadEventFunction:
 355  * @pad: the #GstPad to handle the event.
 356  * @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set,
 357  *          @parent is guaranteed to be not-NULL and remain valid during the
 358  *          execution of this function.
 359  * @event: the #GstEvent to handle.
 360  *
 361  * Function signature to handle an event for the pad.
 362  *
 363  * Returns: TRUE if the pad could handle the event.
 364  */
 365 typedef gboolean                (*GstPadEventFunction)          (GstPad *pad, GstObject *parent,
 366                                                                  GstEvent *event);
 367
 368
 369 /* internal links */
 370 /**
 371  * GstPadIterIntLinkFunction:
 372  * @pad: The #GstPad to query.
 373  * @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set,
 374  *          @parent is guaranteed to be not-NULL and remain valid during the
 375  *          execution of this function.
 376  *
 377  * The signature of the internal pad link iterator function.
 378  *
 379  * Returns: a new #GstIterator that will iterate over all pads that are
 380  * linked to the given pad on the inside of the parent element.
 381  *
 382  * the caller must call gst_iterator_free() after usage.
 383  *
 384  * Since 0.10.21
 385  */
 386 typedef GstIterator*           (*GstPadIterIntLinkFunction)    (GstPad *pad, GstObject *parent);
 387
 388 /* generic query function */
 389 /**
 390  * GstPadQueryFunction:
 391  * @pad: the #GstPad to query.
 392  * @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set,
 393  *          @parent is guaranteed to be not-NULL and remain valid during the
 394  *          execution of this function.
 395  * @query: the #GstQuery object to execute
 396  *
 397  * The signature of the query function.
 398  *
 399  * Returns: TRUE if the query could be performed.
 400  */
 401 typedef gboolean                (*GstPadQueryFunction)          (GstPad *pad, GstObject *parent,
 402                                                                  GstQuery *query);
 403
 404
 405 /* linking */
 406 /**
 407  * GstPadLinkFunction
 408  * @pad: the #GstPad that is linked.
 409  * @peer: the peer #GstPad of the link
 410  *
 411  * Function signature to handle a new link on the pad.
 412  *
 413  * Returns: the result of the link with the specified peer.
 414  */
 415 typedef GstPadLinkReturn        (*GstPadLinkFunction)           (GstPad *pad, GstPad *peer);
 416 /**
 417  * GstPadUnlinkFunction
 418  * @pad: the #GstPad that is linked.
 419  *
 420  * Function signature to handle a unlinking the pad prom its peer.
 421  */
 422 typedef void                    (*GstPadUnlinkFunction)         (GstPad *pad);
 423
 424
 425 /* misc */
 426 /**
 427  * GstPadForwardFunction:
 428  * @pad: the #GstPad that is forwarded.
 429  * @user_data: the gpointer to optional user data.
 430  *
 431  * A forward function is called for all internally linked pads, see
 432  * gst_pad_forward().
 433  *
 434  * Returns: TRUE if the dispatching procedure has to be stopped.
 435  */
 436 typedef gboolean                (*GstPadForwardFunction)        (GstPad *pad, gpointer user_data);
 437
 438 /**
 439  * GstPadProbeType:
 440  * @GST_PAD_PROBE_TYPE_INVALID: invalid probe type
 441  * @GST_PAD_PROBE_TYPE_IDLE: probe idle pads and block
 442  * @GST_PAD_PROBE_TYPE_BLOCK: probe and block pads
 443  * @GST_PAD_PROBE_TYPE_BUFFER: probe buffers
 444  * @GST_PAD_PROBE_TYPE_BUFFER_LIST: probe buffer lists
 445  * @GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM: probe downstream events
 446  * @GST_PAD_PROBE_TYPE_EVENT_UPSTREAM: probe upstream events
 447  * @GST_PAD_PROBE_TYPE_EVENT_FLUSH: probe flush events. This probe has to be
 448  *     explicitly enabled and is not included in the
 449  *     @@GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM or
 450  *     @@GST_PAD_PROBE_TYPE_EVENT_UPSTREAM probe types.
 451  * @GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM: probe downstream queries
 452  * @GST_PAD_PROBE_TYPE_QUERY_UPSTREAM: probe upstream queries
 453  * @GST_PAD_PROBE_TYPE_PUSH: probe push
 454  * @GST_PAD_PROBE_TYPE_PULL: probe pull
 455  *
 456  * The different probing types that can occur. When either one of
 457  * @GST_PAD_PROBE_TYPE_IDLE or @GST_PAD_PROBE_TYPE_BLOCK is used, the probe will be a
 458  * blocking probe.
 459  */
 460 typedef enum
 461 {
 462   GST_PAD_PROBE_TYPE_INVALID          = 0,
 463   /* flags to control blocking */
 464   GST_PAD_PROBE_TYPE_IDLE             = (1 << 0),
 465   GST_PAD_PROBE_TYPE_BLOCK            = (1 << 1),
 466   /* flags to select datatypes */
 467   GST_PAD_PROBE_TYPE_BUFFER           = (1 << 4),
 468   GST_PAD_PROBE_TYPE_BUFFER_LIST      = (1 << 5),
 469   GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM = (1 << 6),
 470   GST_PAD_PROBE_TYPE_EVENT_UPSTREAM   = (1 << 7),
 471   GST_PAD_PROBE_TYPE_EVENT_FLUSH      = (1 << 8),
 472   GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM = (1 << 9),
 473   GST_PAD_PROBE_TYPE_QUERY_UPSTREAM   = (1 << 10),
 474   /* flags to select scheduling mode */
 475   GST_PAD_PROBE_TYPE_PUSH             = (1 << 12),
 476   GST_PAD_PROBE_TYPE_PULL             = (1 << 13)
 477 } GstPadProbeType;
 478
 479 #define GST_PAD_PROBE_TYPE_BLOCKING         (GST_PAD_PROBE_TYPE_IDLE | GST_PAD_PROBE_TYPE_BLOCK)
 480 #define GST_PAD_PROBE_TYPE_BLOCK_DOWNSTREAM (GST_PAD_PROBE_TYPE_BLOCK | GST_PAD_PROBE_TYPE_DATA_DOWNSTREAM)
 481 #define GST_PAD_PROBE_TYPE_BLOCK_UPSTREAM   (GST_PAD_PROBE_TYPE_BLOCK | GST_PAD_PROBE_TYPE_DATA_UPSTREAM)
 482 #define GST_PAD_PROBE_TYPE_DATA_DOWNSTREAM  (GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_BUFFER_LIST | \
 483                                              GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM)
 484 #define GST_PAD_PROBE_TYPE_DATA_UPSTREAM    (GST_PAD_PROBE_TYPE_EVENT_UPSTREAM)
 485 #define GST_PAD_PROBE_TYPE_DATA_BOTH        (GST_PAD_PROBE_TYPE_DATA_DOWNSTREAM | \
 486                                              GST_PAD_PROBE_TYPE_DATA_UPSTREAM)
 487 #define GST_PAD_PROBE_TYPE_EVENT_BOTH       (GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM | \
 488                                              GST_PAD_PROBE_TYPE_EVENT_UPSTREAM)
 489 #define GST_PAD_PROBE_TYPE_QUERY_BOTH       (GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM | \
 490                                              GST_PAD_PROBE_TYPE_QUERY_UPSTREAM)
 491 #define GST_PAD_PROBE_TYPE_ALL_BOTH         (GST_PAD_PROBE_TYPE_DATA_BOTH | \
 492                                              GST_PAD_PROBE_TYPE_QUERY_BOTH)
 493 #define GST_PAD_PROBE_TYPE_SCHEDULING       (GST_PAD_PROBE_TYPE_PUSH | GST_PAD_PROBE_TYPE_PULL)
 494
 495 /**
 496  * GstPadProbeReturn:
 497  * @GST_PAD_PROBE_OK: normal probe return value
 498  * @GST_PAD_PROBE_DROP: drop data in data probes
 499  * @GST_PAD_PROBE_REMOVE: remove probe
 500  * @GST_PAD_PROBE_PASS: pass the data item in the block probe and block on
 501  *                         the next item
 502  *
 503  * Different return values for the #GstPadProbeCallback.
 504  */
 505 typedef enum
 506 {
 507   GST_PAD_PROBE_DROP,
 508   GST_PAD_PROBE_OK,
 509   GST_PAD_PROBE_REMOVE,
 510   GST_PAD_PROBE_PASS,
 511 } GstPadProbeReturn;
 512
 513
 514 /**
 515  * GstPadProbeInfo:
 516  * @type: the current probe type
 517  * @id: the id of the probe
 518  * @data: type specific data, check the @type field to know the datatype.
 519  *    This field can be NULL.
 520  * @offset: offset of pull probe, this field is valid when @type contains
 521  *    #GST_PAD_PROBE_TYPE_PULL
 522  * @size: size of pull probe, this field is valid when @type contains
 523  *    #GST_PAD_PROBE_TYPE_PULL
 524  *
 525  * Info passed in the #GstPadProbeCallback.
 526  */
 527 typedef struct
 528 {
 529   GstPadProbeType type;
 530   gulong id;
 531   gpointer data;
 532   guint64 offset;
 533   guint size;
 534
 535   gpointer _gst_reserved[GST_PADDING];
 536 } GstPadProbeInfo;
 537
 538 #define GST_PAD_PROBE_INFO_TYPE(d)         ((d)->type)
 539 #define GST_PAD_PROBE_INFO_ID(d)           ((d)->id)
 540 #define GST_PAD_PROBE_INFO_DATA(d)         ((d)->data)
 541
 542 #define GST_PAD_PROBE_INFO_BUFFER(d)       GST_BUFFER_CAST(GST_PAD_PROBE_INFO_DATA(d))
 543 #define GST_PAD_PROBE_INFO_BUFFER_LIST(d)  GST_BUFFER_LIST_CAST(GST_PAD_PROBE_INFO_DATA(d))
 544 #define GST_PAD_PROBE_INFO_EVENT(d)        GST_EVENT_CAST(GST_PAD_PROBE_INFO_DATA(d))
 545 #define GST_PAD_PROBE_INFO_QUERY(d)        GST_QUERY_CAST(GST_PAD_PROBE_INFO_DATA(d))
 546
 547 #define GST_PAD_PROBE_INFO_OFFSET(d)       ((d)->offset)
 548 #define GST_PAD_PROBE_INFO_SIZE(d)         ((d)->size)
 549
 550 /**
 551  * GstPadProbeCallback
 552  * @pad: the #GstPad that is blocked
 553  * @info: #GstPadProbeInfo
 554  * @user_data: the gpointer to optional user data.
 555  *
 556  * Callback used by gst_pad_add_probe(). Gets called to notify about the current
 557  * blocking type.
 558  *
 559  * The callback is allowed to modify the data pointer in @info.
 560  */
 561 typedef GstPadProbeReturn   (*GstPadProbeCallback)   (GstPad *pad, GstPadProbeInfo *info,
 562                                                       gpointer user_data);
 563
 564 /**
 565  * GstPadStickyEventsForeachFunction:
 566  * @pad: the #GstPad.
 567  * @event: a sticky #GstEvent.
 568  * @user_data: the #gpointer to optional user data.
 569  *
 570  * Callback used by gst_pad_sticky_events_foreach().
 571  *
 572  * When this function returns %TRUE, the next event will be
 573  * returned. When %FALSE is returned, gst_pad_sticky_events_foreach() will return.
 574  *
 575  * When @event is set to NULL, the item will be removed from the list of sticky events.
 576  * When @event has been made writable, the new buffer reference can be assigned
 577  * to @event. This function is responsible for unreffing the old event when
 578  * removing or modifying.
 579  *
 580  * Returns: %TRUE if the iteration should continue
 581  */
 582 typedef gboolean  (*GstPadStickyEventsForeachFunction) (GstPad *pad, GstEvent **event,
 583                                                         gpointer user_data);
 584
 585 /**
 586  * GstPadFlags:
 587  * @GST_PAD_FLAG_BLOCKED: is dataflow on a pad blocked
 588  * @GST_PAD_FLAG_FLUSHING: is pad refusing buffers
 589  * @GST_PAD_FLAG_BLOCKING: is pad currently blocking on a buffer or event
 590  * @GST_PAD_FLAG_NEED_PARENT: ensure that there is a parent object before calling
 591  *                       into the pad callbacks.
 592  * @GST_PAD_FLAG_NEED_RECONFIGURE: the pad should be reconfigured/renegotiated.
 593  *                            The flag has to be unset manually after
 594  *                            reconfiguration happened.
 595  * @GST_PAD_FLAG_PENDING_EVENTS: the pad has pending events
 596  * @GST_PAD_FLAG_FIXED_CAPS: the pad is using fixed caps this means that once the
 597  *                      caps are set on the pad, the caps query function only
 598  *                      returns those caps.
 599  * @GST_PAD_FLAG_PROXY_CAPS: the default event and query handler will forward
 600  *                      all events and queries to the internally linked pads
 601  *                      instead of discarding them.
 602  * @GST_PAD_FLAG_PROXY_ALLOCATION: the default query handler will forward
 603  *                      allocation queries to the internally linked pads
 604  *                      instead of discarding them.
 605  * @GST_PAD_FLAG_LAST: offset to define more flags
 606  *
 607  * Pad state flags
 608  */
 609 typedef enum {
 610   GST_PAD_FLAG_BLOCKED          = (GST_OBJECT_FLAG_LAST << 0),
 611   GST_PAD_FLAG_FLUSHING         = (GST_OBJECT_FLAG_LAST << 1),
 612   GST_PAD_FLAG_BLOCKING         = (GST_OBJECT_FLAG_LAST << 2),
 613   GST_PAD_FLAG_NEED_PARENT      = (GST_OBJECT_FLAG_LAST << 3),
 614   GST_PAD_FLAG_NEED_RECONFIGURE = (GST_OBJECT_FLAG_LAST << 4),
 615   GST_PAD_FLAG_PENDING_EVENTS   = (GST_OBJECT_FLAG_LAST << 5),
 616   GST_PAD_FLAG_FIXED_CAPS       = (GST_OBJECT_FLAG_LAST << 6),
 617   GST_PAD_FLAG_PROXY_CAPS       = (GST_OBJECT_FLAG_LAST << 7),
 618   GST_PAD_FLAG_PROXY_ALLOCATION = (GST_OBJECT_FLAG_LAST << 8),
 619   /* padding */
 620   GST_PAD_FLAG_LAST        = (GST_OBJECT_FLAG_LAST << 16)
 621 } GstPadFlags;
 622
 623 /**
 624  * GstPad:
 625  * @element_private: private data owned by the parent element
 626  * @padtemplate: padtemplate for this pad
 627  * @direction: the direction of the pad, cannot change after creating
 628  *             the pad.
 629  *
 630  * The #GstPad structure. Use the functions to update the variables.
 631  */
 632 struct _GstPad {
 633   GstObject                      object;
 634
 635   /*< public >*/
 636   gpointer                       element_private;
 637
 638   GstPadTemplate                *padtemplate;
 639
 640   GstPadDirection                direction;
 641
 642   /*< private >*/
 643   /* streaming rec_lock */
 644   GRecMutex                      stream_rec_lock;
 645   GstTask                       *task;
 646
 647   /* block cond, mutex is from the object */
 648   GCond                          block_cond;
 649   GHookList                      probes;
 650
 651   GstPadMode                     mode;
 652   GstPadActivateFunction         activatefunc;
 653   gpointer                       activatedata;
 654   GDestroyNotify                 activatenotify;
 655   GstPadActivateModeFunction     activatemodefunc;
 656   gpointer                       activatemodedata;
 657   GDestroyNotify                 activatemodenotify;
 658
 659   /* pad link */
 660   GstPad                        *peer;
 661   GstPadLinkFunction             linkfunc;
 662   gpointer                       linkdata;
 663   GDestroyNotify                 linknotify;
 664   GstPadUnlinkFunction           unlinkfunc;
 665   gpointer                       unlinkdata;
 666   GDestroyNotify                 unlinknotify;
 667
 668   /* data transport functions */
 669   GstPadChainFunction            chainfunc;
 670   gpointer                       chaindata;
 671   GDestroyNotify                 chainnotify;
 672   GstPadChainListFunction        chainlistfunc;
 673   gpointer                       chainlistdata;
 674   GDestroyNotify                 chainlistnotify;
 675   GstPadGetRangeFunction         getrangefunc;
 676   gpointer                       getrangedata;
 677   GDestroyNotify                 getrangenotify;
 678   GstPadEventFunction            eventfunc;
 679   gpointer                       eventdata;
 680   GDestroyNotify                 eventnotify;
 681
 682   /* pad offset */
 683   gint64                         offset;
 684
 685   /* generic query method */
 686   GstPadQueryFunction            queryfunc;
 687   gpointer                       querydata;
 688   GDestroyNotify                 querynotify;
 689
 690   /* internal links */
 691   GstPadIterIntLinkFunction      iterintlinkfunc;
 692   gpointer                       iterintlinkdata;
 693   GDestroyNotify                 iterintlinknotify;
 694
 695   /* counts number of probes attached. */
 696   gint                           num_probes;
 697   gint                           num_blocked;
 698
 699   GstPadPrivate                 *priv;
 700
 701   gpointer _gst_reserved[GST_PADDING];
 702 };
 703
 704 struct _GstPadClass {
 705   GstObjectClass        parent_class;
 706
 707   /* signal callbacks */
 708   void          (*linked)               (GstPad *pad, GstPad *peer);
 709   void          (*unlinked)             (GstPad *pad, GstPad *peer);
 710
 711   /*< private >*/
 712   gpointer _gst_reserved[GST_PADDING];
 713 };
 714
 715
 716 /***** helper macros *****/
 717 /* GstPad */
 718 #define GST_PAD_NAME(pad)               (GST_OBJECT_NAME(pad))
 719 #define GST_PAD_PARENT(pad)             (GST_ELEMENT_CAST(GST_OBJECT_PARENT(pad)))
 720 #define GST_PAD_ELEMENT_PRIVATE(pad)    (GST_PAD_CAST(pad)->element_private)
 721 #define GST_PAD_PAD_TEMPLATE(pad)       (GST_PAD_CAST(pad)->padtemplate)
 722 #define GST_PAD_DIRECTION(pad)          (GST_PAD_CAST(pad)->direction)
 723 #define GST_PAD_TASK(pad)               (GST_PAD_CAST(pad)->task)
 724 #define GST_PAD_MODE(pad)               (GST_PAD_CAST(pad)->mode)
 725
 726 #define GST_PAD_ACTIVATEFUNC(pad)       (GST_PAD_CAST(pad)->activatefunc)
 727 #define GST_PAD_ACTIVATEMODEFUNC(pad)   (GST_PAD_CAST(pad)->activatemodefunc)
 728 #define GST_PAD_CHAINFUNC(pad)          (GST_PAD_CAST(pad)->chainfunc)
 729 #define GST_PAD_CHAINLISTFUNC(pad)      (GST_PAD_CAST(pad)->chainlistfunc)
 730 #define GST_PAD_GETRANGEFUNC(pad)       (GST_PAD_CAST(pad)->getrangefunc)
 731 #define GST_PAD_EVENTFUNC(pad)          (GST_PAD_CAST(pad)->eventfunc)
 732 #define GST_PAD_QUERYFUNC(pad)          (GST_PAD_CAST(pad)->queryfunc)
 733 #define GST_PAD_ITERINTLINKFUNC(pad)    (GST_PAD_CAST(pad)->iterintlinkfunc)
 734
 735 #define GST_PAD_PEER(pad)               (GST_PAD_CAST(pad)->peer)
 736 #define GST_PAD_LINKFUNC(pad)           (GST_PAD_CAST(pad)->linkfunc)
 737 #define GST_PAD_UNLINKFUNC(pad)         (GST_PAD_CAST(pad)->unlinkfunc)
 738
 739 #define GST_PAD_IS_SRC(pad)             (GST_PAD_DIRECTION(pad) == GST_PAD_SRC)
 740 #define GST_PAD_IS_SINK(pad)            (GST_PAD_DIRECTION(pad) == GST_PAD_SINK)
 741
 742 #define GST_PAD_IS_LINKED(pad)          (GST_PAD_PEER(pad) != NULL)
 743
 744 #define GST_PAD_IS_ACTIVE(pad)          (GST_PAD_MODE(pad) != GST_PAD_MODE_NONE)
 745
 746 #define GST_PAD_IS_BLOCKED(pad)         (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_BLOCKED))
 747 #define GST_PAD_IS_BLOCKING(pad)        (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_BLOCKING))
 748
 749 #define GST_PAD_IS_FLUSHING(pad)        (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_FLUSHING))
 750 #define GST_PAD_SET_FLUSHING(pad)       (GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_FLUSHING))
 751 #define GST_PAD_UNSET_FLUSHING(pad)     (GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_FLUSHING))
 752
 753 #define GST_PAD_NEEDS_RECONFIGURE(pad)  (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE))
 754 #define GST_PAD_HAS_PENDING_EVENTS(pad) (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_PENDING_EVENTS))
 755 #define GST_PAD_IS_FIXED_CAPS(pad)      (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_FIXED_CAPS))
 756 #define GST_PAD_NEEDS_PARENT(pad)       (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_NEED_PARENT))
 757
 758 #define GST_PAD_IS_PROXY_CAPS(pad)      (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_PROXY_CAPS))
 759 #define GST_PAD_SET_PROXY_CAPS(pad)     (GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PROXY_CAPS))
 760 #define GST_PAD_UNSET_PROXY_CAPS(pad)   (GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PROXY_CAPS))
 761
 762 #define GST_PAD_IS_PROXY_ALLOCATION(pad)    (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_PROXY_ALLOCATION))
 763 #define GST_PAD_SET_PROXY_ALLOCATION(pad)   (GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PROXY_ALLOCATION))
 764 #define GST_PAD_UNSET_PROXY_ALLOCATION(pad) (GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PROXY_ALLOCATION))
 765
 766 /**
 767  * GST_PAD_GET_STREAM_LOCK:
 768  * @pad: a #GstPad
 769  *
 770  * Get the stream lock of @pad. The stream lock is protecting the
 771  * resources used in the data processing functions of @pad.
 772  */
 773 #define GST_PAD_GET_STREAM_LOCK(pad)    (&(GST_PAD_CAST(pad)->stream_rec_lock))
 774 /**
 775  * GST_PAD_STREAM_LOCK:
 776  * @pad: a #GstPad
 777  *
 778  * Lock the stream lock of @pad.
 779  */
 780 #define GST_PAD_STREAM_LOCK(pad)        (g_rec_mutex_lock(GST_PAD_GET_STREAM_LOCK(pad)))
 781 /**
 782  * GST_PAD_STREAM_TRYLOCK:
 783  * @pad: a #GstPad
 784  *
 785  * Try to Lock the stream lock of the pad, return TRUE if the lock could be
 786  * taken.
 787  */
 788 #define GST_PAD_STREAM_TRYLOCK(pad)     (g_rec_mutex_trylock(GST_PAD_GET_STREAM_LOCK(pad)))
 789 /**
 790  * GST_PAD_STREAM_UNLOCK:
 791  * @pad: a #GstPad
 792  *
 793  * Unlock the stream lock of @pad.
 794  */
 795 #define GST_PAD_STREAM_UNLOCK(pad)      (g_rec_mutex_unlock(GST_PAD_GET_STREAM_LOCK(pad)))
 796
 797 #define GST_PAD_BLOCK_GET_COND(pad)     (&GST_PAD_CAST(pad)->block_cond)
 798 #define GST_PAD_BLOCK_WAIT(pad)         (g_cond_wait(GST_PAD_BLOCK_GET_COND (pad), GST_OBJECT_GET_LOCK (pad)))
 799 #define GST_PAD_BLOCK_SIGNAL(pad)       (g_cond_signal(GST_PAD_BLOCK_GET_COND (pad)))
 800 #define GST_PAD_BLOCK_BROADCAST(pad)    (g_cond_broadcast(GST_PAD_BLOCK_GET_COND (pad)))
 801
 802 GType                   gst_pad_get_type                        (void);
 803
 804 /* creating pads */
 805 GstPad*                 gst_pad_new                             (const gchar *name, GstPadDirection direction);
 806 GstPad*                 gst_pad_new_from_template               (GstPadTemplate *templ, const gchar *name);
 807 GstPad*                 gst_pad_new_from_static_template        (GstStaticPadTemplate *templ, const gchar *name);
 808
 809
 810 /**
 811  * gst_pad_get_name:
 812  * @pad: the pad to get the name from
 813  *
 814  * Get a copy of the name of the pad. g_free() after usage.
 815  *
 816  * MT safe.
 817  */
 818 #define gst_pad_get_name(pad) gst_object_get_name (GST_OBJECT_CAST (pad))
 819 /**
 820  * gst_pad_get_parent:
 821  * @pad: the pad to get the parent of
 822  *
 823  * Get the parent of @pad. This function increases the refcount
 824  * of the parent object so you should gst_object_unref() it after usage.
 825  * Can return NULL if the pad did not have a parent.
 826  *
 827  * MT safe.
 828  */
 829 #define gst_pad_get_parent(pad) gst_object_get_parent (GST_OBJECT_CAST (pad))
 830
 831 GstPadDirection         gst_pad_get_direction                   (GstPad *pad);
 832
 833 gboolean                gst_pad_set_active                      (GstPad *pad, gboolean active);
 834 gboolean                gst_pad_is_active                       (GstPad *pad);
 835 gboolean                gst_pad_activate_mode                   (GstPad *pad, GstPadMode mode,
 836                                                                  gboolean active);
 837
 838 gulong                  gst_pad_add_probe                       (GstPad *pad,
 839                                                                  GstPadProbeType mask,
 840                                                                  GstPadProbeCallback callback,
 841                                                                  gpointer user_data,
 842                                                                  GDestroyNotify destroy_data);
 843 void                    gst_pad_remove_probe                    (GstPad *pad, gulong id);
 844
 845 gboolean                gst_pad_is_blocked                      (GstPad *pad);
 846 gboolean                gst_pad_is_blocking                     (GstPad *pad);
 847
 848 void                    gst_pad_mark_reconfigure                (GstPad *pad);
 849 gboolean                gst_pad_check_reconfigure               (GstPad *pad);
 850
 851 void                    gst_pad_set_element_private             (GstPad *pad, gpointer priv);
 852 gpointer                gst_pad_get_element_private             (GstPad *pad);
 853
 854 GstPadTemplate*         gst_pad_get_pad_template                (GstPad *pad);
 855
 856 GstEvent*               gst_pad_get_sticky_event                (GstPad *pad, GstEventType event_type,
 857                                                                  guint idx);
 858 void                    gst_pad_sticky_events_foreach           (GstPad *pad, GstPadStickyEventsForeachFunction foreach_func, gpointer user_data);
 859
 860 /* data passing setup functions */
 861 void                    gst_pad_set_activate_function_full      (GstPad *pad,
 862                                                                  GstPadActivateFunction activate,
 863                                                                  gpointer user_data,
 864                                                                  GDestroyNotify notify);
 865 void                    gst_pad_set_activatemode_function_full  (GstPad *pad,
 866                                                                  GstPadActivateModeFunction activatemode,
 867                                                                  gpointer user_data,
 868                                                                  GDestroyNotify notify);
 869 /* data passing functions */
 870 void                    gst_pad_set_chain_function_full         (GstPad *pad,
 871                                                                  GstPadChainFunction chain,
 872                                                                  gpointer user_data,
 873                                                                  GDestroyNotify notify);
 874 void                    gst_pad_set_chain_list_function_full    (GstPad *pad,
 875                                                                  GstPadChainListFunction chainlist,
 876                                                                  gpointer user_data,
 877                                                                  GDestroyNotify notify);
 878 void                    gst_pad_set_getrange_function_full      (GstPad *pad,
 879                                                                  GstPadGetRangeFunction get,
 880                                                                  gpointer user_data,
 881                                                                  GDestroyNotify notify);
 882 void                    gst_pad_set_event_function_full         (GstPad *pad,
 883                                                                  GstPadEventFunction event,
 884                                                                  gpointer user_data,
 885                                                                  GDestroyNotify notify);
 886
 887 #define gst_pad_set_activate_function(p,f)      gst_pad_set_activate_function_full((p),(f),NULL,NULL)
 888 #define gst_pad_set_activatemode_function(p,f)  gst_pad_set_activatemode_function_full((p),(f),NULL,NULL)
 889 #define gst_pad_set_chain_function(p,f)         gst_pad_set_chain_function_full((p),(f),NULL,NULL)
 890 #define gst_pad_set_chain_list_function(p,f)    gst_pad_set_chain_list_function_full((p),(f),NULL,NULL)
 891 #define gst_pad_set_getrange_function(p,f)      gst_pad_set_getrange_function_full((p),(f),NULL,NULL)
 892 #define gst_pad_set_event_function(p,f)         gst_pad_set_event_function_full((p),(f),NULL,NULL)
 893
 894 /* pad links */
 895 void                    gst_pad_set_link_function_full          (GstPad *pad,
 896                                                                  GstPadLinkFunction link,
 897                                                                  gpointer user_data,
 898                                                                  GDestroyNotify notify);
 899 void                    gst_pad_set_unlink_function_full        (GstPad *pad,
 900                                                                  GstPadUnlinkFunction unlink,
 901                                                                  gpointer user_data,
 902                                                                  GDestroyNotify notify);
 903
 904 #define gst_pad_set_link_function(p,f)          gst_pad_set_link_function_full((p),(f),NULL,NULL)
 905 #define gst_pad_set_unlink_function(p,f)        gst_pad_set_unlink_function_full((p),(f),NULL,NULL)
 906
 907 gboolean                gst_pad_can_link                        (GstPad *srcpad, GstPad *sinkpad);
 908 GstPadLinkReturn        gst_pad_link                            (GstPad *srcpad, GstPad *sinkpad);
 909 GstPadLinkReturn        gst_pad_link_full                       (GstPad *srcpad, GstPad *sinkpad, GstPadLinkCheck flags);
 910 gboolean                gst_pad_unlink                          (GstPad *srcpad, GstPad *sinkpad);
 911 gboolean                gst_pad_is_linked                       (GstPad *pad);
 912
 913 GstPad*                 gst_pad_get_peer                        (GstPad *pad);
 914
 915 GstCaps*                gst_pad_get_pad_template_caps           (GstPad *pad);
 916
 917 /* capsnego function for linked/unlinked pads */
 918 GstCaps *               gst_pad_get_current_caps                (GstPad * pad);
 919 gboolean                gst_pad_has_current_caps                (GstPad * pad);
 920 gboolean                gst_pad_set_caps                        (GstPad * pad, GstCaps *caps);
 921
 922 /* capsnego for linked pads */
 923 GstCaps *               gst_pad_get_allowed_caps                (GstPad * pad);
 924
 925 /* pad offsets */
 926 gint64                  gst_pad_get_offset                      (GstPad *pad);
 927 void                    gst_pad_set_offset                      (GstPad *pad, gint64 offset);
 928
 929 /* data passing functions to peer */
 930 GstFlowReturn           gst_pad_push                            (GstPad *pad, GstBuffer *buffer);
 931 GstFlowReturn           gst_pad_push_list                       (GstPad *pad, GstBufferList *list);
 932 GstFlowReturn           gst_pad_pull_range                      (GstPad *pad, guint64 offset, guint size,
 933                                                                  GstBuffer **buffer);
 934 gboolean                gst_pad_push_event                      (GstPad *pad, GstEvent *event);
 935 gboolean                gst_pad_event_default                   (GstPad *pad, GstObject *parent,
 936                                                                  GstEvent *event);
 937
 938 /* data passing functions on pad */
 939 GstFlowReturn           gst_pad_chain                           (GstPad *pad, GstBuffer *buffer);
 940 GstFlowReturn           gst_pad_chain_list                      (GstPad *pad, GstBufferList *list);
 941 GstFlowReturn           gst_pad_get_range                       (GstPad *pad, guint64 offset, guint size,
 942                                                                  GstBuffer **buffer);
 943 gboolean                gst_pad_send_event                      (GstPad *pad, GstEvent *event);
 944
 945 /* pad tasks */
 946 gboolean                gst_pad_start_task                      (GstPad *pad, GstTaskFunction func,
 947                                                                  gpointer data);
 948 gboolean                gst_pad_pause_task                      (GstPad *pad);
 949 gboolean                gst_pad_stop_task                       (GstPad *pad);
 950
 951 /* internal links */
 952 void                    gst_pad_set_iterate_internal_links_function_full (GstPad * pad,
 953                                                                  GstPadIterIntLinkFunction iterintlink,
 954                                                                  gpointer user_data,
 955                                                                  GDestroyNotify notify);
 956 GstIterator *           gst_pad_iterate_internal_links          (GstPad * pad);
 957 GstIterator *           gst_pad_iterate_internal_links_default  (GstPad * pad, GstObject *parent);
 958
 959 #define gst_pad_set_iterate_internal_links_function(p,f) gst_pad_set_iterate_internal_links_function_full((p),(f),NULL,NULL)
 960
 961 /* generic query function */
 962 gboolean                gst_pad_query                           (GstPad *pad, GstQuery *query);
 963 gboolean                gst_pad_peer_query                      (GstPad *pad, GstQuery *query);
 964 void                    gst_pad_set_query_function_full         (GstPad *pad, GstPadQueryFunction query,
 965                                                                  gpointer user_data,
 966                                                                  GDestroyNotify notify);
 967 gboolean                gst_pad_query_default                   (GstPad *pad, GstObject *parent,
 968                                                                  GstQuery *query);
 969
 970 #define gst_pad_set_query_function(p,f)   gst_pad_set_query_function_full((p),(f),NULL,NULL)
 971
 972 /* misc helper functions */
 973 gboolean                gst_pad_forward                         (GstPad *pad, GstPadForwardFunction forward,
 974                                                                  gpointer user_data);
 975
 976 G_END_DECLS
 977
 978 #endif /* __GST_PAD_H__ */