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 #include <gst/gstobject.h>
  30 #include <gst/gstbuffer.h>
  31 #include <gst/gstbufferlist.h>
  32 #include <gst/gstcaps.h>
  33 #include <gst/gstevent.h>
  34 #include <gst/gstquery.h>
  35 #include <gst/gsttask.h>
  36
  37 G_BEGIN_DECLS
  38
  39 /*
  40  * Pad base class
  41  */
  42 #define GST_TYPE_PAD                    (gst_pad_get_type ())
  43 #define GST_IS_PAD(obj)                 (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PAD))
  44 #define GST_IS_PAD_CLASS(klass)         (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PAD))
  45 #define GST_PAD(obj)                    (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PAD, GstPad))
  46 #define GST_PAD_CLASS(klass)            (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PAD, GstPadClass))
  47 #define GST_PAD_CAST(obj)               ((GstPad*)(obj))
  48
  49
  50 typedef struct _GstPad GstPad;
  51 typedef struct _GstPadPrivate GstPadPrivate;
  52 typedef struct _GstPadClass GstPadClass;
  53
  54 /**
  55  * GstPadLinkReturn:
  56  * @GST_PAD_LINK_OK             : link succeeded
  57  * @GST_PAD_LINK_WRONG_HIERARCHY: pads have no common grandparent
  58  * @GST_PAD_LINK_WAS_LINKED     : pad was already linked
  59  * @GST_PAD_LINK_WRONG_DIRECTION: pads have wrong direction
  60  * @GST_PAD_LINK_NOFORMAT       : pads do not have common format
  61  * @GST_PAD_LINK_NOSCHED        : pads cannot cooperate in scheduling
  62  * @GST_PAD_LINK_REFUSED        : refused for some reason
  63  *
  64  * Result values from gst_pad_link and friends.
  65  */
  66 typedef enum {
  67   GST_PAD_LINK_OK               =  0,
  68   GST_PAD_LINK_WRONG_HIERARCHY  = -1,
  69   GST_PAD_LINK_WAS_LINKED       = -2,
  70   GST_PAD_LINK_WRONG_DIRECTION  = -3,
  71   GST_PAD_LINK_NOFORMAT         = -4,
  72   GST_PAD_LINK_NOSCHED          = -5,
  73   GST_PAD_LINK_REFUSED          = -6
  74 } GstPadLinkReturn;
  75
  76 /**
  77  * GST_PAD_LINK_FAILED:
  78  * @ret: the #GstPadLinkReturn value
  79  *
  80  * Macro to test if the given #GstPadLinkReturn value indicates a failed
  81  * link step.
  82  */
  83 #define GST_PAD_LINK_FAILED(ret) ((ret) < GST_PAD_LINK_OK)
  84
  85 /**
  86  * GST_PAD_LINK_SUCCESSFUL:
  87  * @ret: the #GstPadLinkReturn value
  88  *
  89  * Macro to test if the given #GstPadLinkReturn value indicates a successful
  90  * link step.
  91  */
  92 #define GST_PAD_LINK_SUCCESSFUL(ret) ((ret) >= GST_PAD_LINK_OK)
  93
  94 /**
  95  * GstFlowReturn:
  96  * @GST_FLOW_RESEND:             Resend buffer, possibly with new caps (not
  97  *                                 sent yet) (unused/unimplemented).
  98  * @GST_FLOW_OK:                 Data passing was ok.
  99  * @GST_FLOW_NOT_LINKED:         Pad is not linked.
 100  * @GST_FLOW_WRONG_STATE:        Pad is in wrong state.
 101  * @GST_FLOW_UNEXPECTED:         Did not expect anything, like after EOS.
 102  * @GST_FLOW_NOT_NEGOTIATED:     Pad is not negotiated.
 103  * @GST_FLOW_ERROR:              Some (fatal) error occured. Element generating
 104  *                               this error should post an error message with more
 105  *                               details.
 106  * @GST_FLOW_NOT_SUPPORTED:      This operation is not supported.
 107  * @GST_FLOW_CUSTOM_SUCCESS:     Elements can use values starting from
 108  *                               this (and higher) to define custom success
 109  *                               codes. Since 0.10.7.
 110  * @GST_FLOW_CUSTOM_SUCCESS_1:   Pre-defined custom success code (define your
 111  *                               custom success code to this to avoid compiler
 112  *                               warnings). Since 0.10.29.
 113  * @GST_FLOW_CUSTOM_SUCCESS_2:   Pre-defined custom success code. Since 0.10.29.
 114  * @GST_FLOW_CUSTOM_ERROR:       Elements can use values starting from
 115  *                               this (and lower) to define custom error codes.
 116  *                               Since 0.10.7.
 117  * @GST_FLOW_CUSTOM_ERROR_1:     Pre-defined custom error code (define your
 118  *                               custom error code to this to avoid compiler
 119  *                               warnings). Since 0.10.29.
 120  * @GST_FLOW_CUSTOM_ERROR_2:     Pre-defined custom error code. Since 0.10.29.
 121  *
 122  * The result of passing data to a pad.
 123  *
 124  * Note that the custom return values should not be exposed outside of the
 125  * element scope and are available since 0.10.7.
 126  */
 127 /* FIXME 0.11: remove custom flow returns */
 128 typedef enum {
 129   /* custom success starts here */
 130   GST_FLOW_CUSTOM_SUCCESS_2 = 102,
 131   GST_FLOW_CUSTOM_SUCCESS_1 = 101,
 132   GST_FLOW_CUSTOM_SUCCESS = 100,
 133
 134   /* core predefined */
 135   GST_FLOW_RESEND         =  1,
 136   GST_FLOW_OK             =  0,
 137   /* expected failures */
 138   GST_FLOW_NOT_LINKED     = -1,
 139   GST_FLOW_WRONG_STATE    = -2,
 140   /* error cases */
 141   GST_FLOW_UNEXPECTED     = -3,
 142   GST_FLOW_NOT_NEGOTIATED = -4,
 143   GST_FLOW_ERROR          = -5,
 144   GST_FLOW_NOT_SUPPORTED  = -6,
 145
 146   /* custom error starts here */
 147   GST_FLOW_CUSTOM_ERROR   = -100,
 148   GST_FLOW_CUSTOM_ERROR_1 = -101,
 149   GST_FLOW_CUSTOM_ERROR_2 = -102
 150 } GstFlowReturn;
 151
 152 /**
 153  * GST_FLOW_IS_FATAL:
 154  * @ret: a #GstFlowReturn value
 155  *
 156  * Macro to test if the given #GstFlowReturn value indicates a fatal
 157  * error. This macro is mainly used in elements driving the pipeline to decide
 158  * whether an error message should be posted on the bus. Note that such
 159  * elements may also need to post an error message in the #GST_FLOW_NOT_LINKED
 160  * case which is not caught by this macro.
 161  *
 162  * Deprecated: This macro is badly named and can't be used in any real
 163  * scenarios without additional checks.
 164  */
 165 #ifndef GST_DISABLE_DEPRECATED
 166 #define GST_FLOW_IS_FATAL(ret) ((ret) <= GST_FLOW_UNEXPECTED)
 167 #endif
 168
 169 /**
 170  * GST_FLOW_IS_SUCCESS:
 171  * @ret: a #GstFlowReturn value
 172  *
 173  * Macro to test if the given #GstFlowReturn value indicates a
 174  * successfull result
 175  * This macro is mainly used in elements to decide if the processing
 176  * of a buffer was successfull.
 177  *
 178  * Since: 0.10.7
 179  *
 180  * Deprecated: This macro is badly named and can't be used in any real
 181  * scenarios without additional checks.
 182  */
 183 #ifndef GST_DISABLE_DEPRECATED
 184 #define GST_FLOW_IS_SUCCESS(ret) ((ret) >= GST_FLOW_OK)
 185 #endif
 186
 187 const gchar*            gst_flow_get_name       (GstFlowReturn ret);
 188 GQuark                  gst_flow_to_quark       (GstFlowReturn ret);
 189
 190 /**
 191  * GstPadLinkCheck:
 192  * @GST_PAD_LINK_CHECK_NOTHING: Don't check hierarchy or caps compatibility.
 193  * @GST_PAD_LINK_CHECK_HIERARCHY: Check the pads have same parents/grandparents.
 194  *   Could be omitted if it is already known that the two elements that own the
 195  *   pads are in the same bin.
 196  * @GST_PAD_LINK_CHECK_TEMPLATE_CAPS: Check if the pads are compatible by using
 197  *   their template caps. This is much faster than @GST_PAD_LINK_CHECK_CAPS, but
 198  *   would be unsafe e.g. if one pad has %GST_CAPS_ANY.
 199  * @GST_PAD_LINK_CHECK_CAPS: Check if the pads are compatible by comparing the
 200  *   caps returned by gst_pad_get_caps().
 201  *
 202  * The amount of checking to be done when linking pads. @GST_PAD_LINK_CHECK_CAPS
 203  * and @GST_PAD_LINK_CHECK_TEMPLATE_CAPS are mutually exclusive. If both are
 204  * specified, expensive but safe @GST_PAD_LINK_CHECK_CAPS are performed.
 205  *
 206  * <warning><para>
 207  * Only disable some of the checks if you are 100% certain you know the link
 208  * will not fail because of hierarchy/caps compatibility failures. If uncertain,
 209  * use the default checks (%GST_PAD_LINK_CHECK_DEFAULT) or the regular methods
 210  * for linking the pads.
 211  * </para></warning>
 212  *
 213  * Since: 0.10.30
 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 } GstPadLinkCheck;
 222
 223 /**
 224  * GST_PAD_LINK_CHECK_DEFAULT:
 225  *
 226  * The default checks done when linking pads (i.e. the ones used by
 227  * gst_pad_link()).
 228  *
 229  * Since: 0.10.30
 230  */
 231 #define GST_PAD_LINK_CHECK_DEFAULT (GST_PAD_LINK_CHECK_HIERARCHY | GST_PAD_LINK_CHECK_CAPS)
 232
 233 /**
 234  * GstActivateMode:
 235  * @GST_ACTIVATE_NONE:           Pad will not handle dataflow
 236  * @GST_ACTIVATE_PUSH:           Pad handles dataflow in downstream push mode
 237  * @GST_ACTIVATE_PULL:           Pad handles dataflow in upstream pull mode
 238  *
 239  * The status of a GstPad. After activating a pad, which usually happens when the
 240  * parent element goes from READY to PAUSED, the GstActivateMode defines if the
 241  * pad operates in push or pull mode.
 242  */
 243 typedef enum {
 244   GST_ACTIVATE_NONE,
 245   GST_ACTIVATE_PUSH,
 246   GST_ACTIVATE_PULL
 247 } GstActivateMode;
 248
 249 /**
 250  * GST_PAD_MODE_ACTIVATE:
 251  * @mode: a #GstActivateMode
 252  *
 253  * Macro to test if the given #GstActivateMode value indicates that datapassing
 254  * is possible or not.
 255  */
 256 #define GST_PAD_MODE_ACTIVATE(mode) ((mode) != GST_ACTIVATE_NONE)
 257
 258 /* pad states */
 259 /**
 260  * GstPadActivateFunction:
 261  * @pad: a #GstPad
 262  *
 263  * This function is called when the pad is activated during the element
 264  * READY to PAUSED state change. By default this function will call the
 265  * activate function that puts the pad in push mode but elements can
 266  * override this function to activate the pad in pull mode if they wish.
 267  *
 268  * Returns: TRUE if the pad could be activated.
 269  */
 270 typedef gboolean                (*GstPadActivateFunction)       (GstPad *pad);
 271 /**
 272  * GstPadActivateModeFunction:
 273  * @pad: a #GstPad
 274  * @active: activate or deactivate the pad.
 275  *
 276  * The prototype of the push and pull activate functions.
 277  *
 278  * Returns: TRUE if the pad could be activated or deactivated.
 279  */
 280 typedef gboolean                (*GstPadActivateModeFunction)   (GstPad *pad, gboolean active);
 281
 282
 283 /* data passing */
 284 /**
 285  * GstPadChainFunction:
 286  * @pad: the sink #GstPad that performed the chain.
 287  * @buffer: the #GstBuffer that is chained, not %NULL.
 288  *
 289  * A function that will be called on sinkpads when chaining buffers.
 290  * The function typically processes the data contained in the buffer and
 291  * either consumes the data or passes it on to the internally linked pad(s).
 292  *
 293  * The implementer of this function receives a refcount to @buffer and should
 294  * gst_buffer_unref() when the buffer is no longer needed.
 295  *
 296  * When a chain function detects an error in the data stream, it must post an
 297  * error on the bus and return an appropriate #GstFlowReturn value.
 298  *
 299  * Returns: #GST_FLOW_OK for success
 300  */
 301 typedef GstFlowReturn           (*GstPadChainFunction)          (GstPad *pad, GstBuffer *buffer);
 302
 303 /**
 304  * GstPadChainListFunction:
 305  * @pad: the sink #GstPad that performed the chain.
 306  * @list: the #GstBufferList that is chained, not %NULL.
 307  *
 308  * A function that will be called on sinkpads when chaining buffer lists.
 309  * The function typically processes the data contained in the buffer list and
 310  * either consumes the data or passes it on to the internally linked pad(s).
 311  *
 312  * The implementer of this function receives a refcount to @list and
 313  * should gst_buffer_list_unref() when the list is no longer needed.
 314  *
 315  * When a chainlist function detects an error in the data stream, it must
 316  * post an error on the bus and return an appropriate #GstFlowReturn value.
 317  *
 318  * Returns: #GST_FLOW_OK for success
 319  */
 320 typedef GstFlowReturn           (*GstPadChainListFunction)      (GstPad *pad, GstBufferList *list);
 321
 322 /**
 323  * GstPadGetRangeFunction:
 324  * @pad: the src #GstPad to perform the getrange on.
 325  * @offset: the offset of the range
 326  * @length: the length of the range
 327  * @buffer: a memory location to hold the result buffer, cannot be NULL.
 328  *
 329  * This function will be called on source pads when a peer element
 330  * request a buffer at the specified @offset and @length. If this function
 331  * returns #GST_FLOW_OK, the result buffer will be stored in @buffer. The
 332  * contents of @buffer is invalid for any other return value.
 333  *
 334  * This function is installed on a source pad with
 335  * gst_pad_set_getrange_function() and can only be called on source pads after
 336  * they are successfully activated with gst_pad_activate_pull().
 337  *
 338  * @offset and @length are always given in byte units. @offset must normally be a value
 339  * between 0 and the length in bytes of the data available on @pad. The
 340  * length (duration in bytes) can be retrieved with a #GST_QUERY_DURATION or with a
 341  * #GST_QUERY_SEEKING.
 342  *
 343  * Any @offset larger or equal than the length will make the function return
 344  * #GST_FLOW_UNEXPECTED, which corresponds to EOS. In this case @buffer does not
 345  * contain a valid buffer.
 346  *
 347  * The buffer size of @buffer will only be smaller than @length when @offset is
 348  * near the end of the stream. In all other cases, the size of @buffer must be
 349  * exactly the requested size.
 350  *
 351  * It is allowed to call this function with a 0 @length and valid @offset, in
 352  * which case @buffer will contain a 0-sized buffer and the function returns
 353  * #GST_FLOW_OK.
 354  *
 355  * When this function is called with a -1 @offset, the sequentially next buffer
 356  * of length @length in the stream is returned.
 357  *
 358  * When this function is called with a -1 @length, a buffer with a default
 359  * optimal length is returned in @buffer. The length might depend on the value
 360  * of @offset.
 361  *
 362  * Returns: #GST_FLOW_OK for success and a valid buffer in @buffer. Any other
 363  * return value leaves @buffer undefined.
 364  */
 365 typedef GstFlowReturn           (*GstPadGetRangeFunction)       (GstPad *pad, guint64 offset,
 366                                                                  guint length, GstBuffer **buffer);
 367
 368 /**
 369  * GstPadEventFunction:
 370  * @pad: the #GstPad to handle the event.
 371  * @event: the #GstEvent to handle.
 372  *
 373  * Function signature to handle an event for the pad.
 374  *
 375  * Returns: TRUE if the pad could handle the event.
 376  */
 377 typedef gboolean                (*GstPadEventFunction)          (GstPad *pad, GstEvent *event);
 378
 379
 380 /* FIXME: 0.11: deprecate me, check range should use seeking query */
 381 /**
 382  * GstPadCheckGetRangeFunction:
 383  * @pad: a #GstPad
 384  *
 385  * Check if @pad can be activated in pull mode.
 386  *
 387  * This function will be deprecated after 0.10; use the seeking query to check
 388  * if a pad can support random access.
 389  *
 390  * Returns: TRUE if the pad can operate in pull mode.
 391  */
 392 typedef gboolean                (*GstPadCheckGetRangeFunction)  (GstPad *pad);
 393
 394 /* internal links */
 395 /**
 396  * GstPadIntLinkFunction:
 397  * @pad: The #GstPad to query.
 398  *
 399  * The signature of the internal pad link function.
 400  *
 401  * Returns: (element-type Gst.Pad) (transfer container): a newly allocated #GList of pads that are linked to the given pad on
 402  * the inside of the parent element.
 403  *
 404  * The caller must call g_list_free() on it after use.
 405  *
 406  * Deprecated: use the threadsafe #GstPadIterIntLinkFunction instead.
 407  */
 408 typedef GList*                  (*GstPadIntLinkFunction)        (GstPad *pad);
 409
 410 /**
 411  * GstPadIterIntLinkFunction:
 412  * @pad: The #GstPad to query.
 413  *
 414  * The signature of the internal pad link iterator function.
 415  *
 416  * Returns: a new #GstIterator that will iterate over all pads that are
 417  * linked to the given pad on the inside of the parent element.
 418  *
 419  * the caller must call gst_iterator_free() after usage.
 420  *
 421  * Since 0.10.21
 422  */
 423 typedef GstIterator*           (*GstPadIterIntLinkFunction)    (GstPad *pad);
 424
 425 /* generic query function */
 426 /**
 427  * GstPadQueryTypeFunction:
 428  * @pad: a #GstPad to query
 429  *
 430  * The signature of the query types function.
 431  *
 432  * Returns: a constant array of query types
 433  */
 434 typedef const GstQueryType*     (*GstPadQueryTypeFunction)      (GstPad *pad);
 435
 436 /**
 437  * GstPadQueryFunction:
 438  * @pad: the #GstPad to query.
 439  * @query: the #GstQuery object to execute
 440  *
 441  * The signature of the query function.
 442  *
 443  * Returns: TRUE if the query could be performed.
 444  */
 445 typedef gboolean                (*GstPadQueryFunction)          (GstPad *pad, GstQuery *query);
 446
 447
 448 /* linking */
 449 /**
 450  * GstPadLinkFunction
 451  * @pad: the #GstPad that is linked.
 452  * @peer: the peer #GstPad of the link
 453  *
 454  * Function signature to handle a new link on the pad.
 455  *
 456  * Returns: the result of the link with the specified peer.
 457  */
 458 typedef GstPadLinkReturn        (*GstPadLinkFunction)           (GstPad *pad, GstPad *peer);
 459 /**
 460  * GstPadUnlinkFunction
 461  * @pad: the #GstPad that is linked.
 462  *
 463  * Function signature to handle a unlinking the pad prom its peer.
 464  */
 465 typedef void                    (*GstPadUnlinkFunction)         (GstPad *pad);
 466
 467
 468 /* caps nego */
 469 /**
 470  * GstPadGetCapsFunction:
 471  * @pad: the #GstPad to get the capabilities of.
 472  *
 473  * Returns a copy of the capabilities of the specified pad. By default this
 474  * function will return the pad template capabilities, but can optionally
 475  * be overridden by elements.
 476  *
 477  * Returns: a newly allocated copy #GstCaps of the pad.
 478  */
 479 typedef GstCaps*                (*GstPadGetCapsFunction)        (GstPad *pad);
 480
 481 /**
 482  * GstPadSetCapsFunction:
 483  * @pad: the #GstPad to set the capabilities of.
 484  * @caps: the #GstCaps to set
 485  *
 486  * Set @caps on @pad. By default this function updates the caps of the
 487  * pad but the function can be overriden by elements to perform extra
 488  * actions or verifications.
 489  *
 490  * Returns: TRUE if the caps could be set on the pad.
 491  */
 492 typedef gboolean                (*GstPadSetCapsFunction)        (GstPad *pad, GstCaps *caps);
 493 /**
 494  * GstPadAcceptCapsFunction:
 495  * @pad: the #GstPad to check
 496  * @caps: the #GstCaps to check
 497  *
 498  * Check if @pad can accept @caps. By default this function will see if @caps
 499  * intersect with the result from gst_pad_get_caps() by can be overridden to
 500  * perform extra checks.
 501  *
 502  * Returns: TRUE if the caps can be accepted by the pad.
 503  */
 504 typedef gboolean                (*GstPadAcceptCapsFunction)     (GstPad *pad, GstCaps *caps);
 505 /**
 506  * GstPadFixateCapsFunction:
 507  * @pad: a #GstPad
 508  * @caps: the #GstCaps to fixate
 509  *
 510  * Given possibly unfixed caps @caps, let @pad use its default prefered
 511  * format to make a fixed caps. @caps should be writable. By default this
 512  * function will pick the first value of any ranges or lists in the caps but
 513  * elements can override this function to perform other behaviour.
 514  */
 515 typedef void                    (*GstPadFixateCapsFunction)     (GstPad *pad, GstCaps *caps);
 516 /**
 517  * GstPadBufferAllocFunction:
 518  * @pad: a sink #GstPad
 519  * @offset: the desired offset of the buffer
 520  * @size: the desired size of the buffer
 521  * @caps: the desired caps of the buffer
 522  * @buf: pointer to hold the allocated buffer.
 523  *
 524  * Ask the sinkpad @pad to allocate a buffer with @offset, @size and @caps.
 525  * The result will be stored in @buf.
 526  *
 527  * The purpose of this function is to allocate a buffer that is optimal to
 528  * be processed by @pad. The function is mostly overridden by elements that can
 529  * provide a hardware buffer in order to avoid additional memcpy operations.
 530  *
 531  * The function can return a buffer that has caps different from the requested
 532  * @caps, in which case the upstream element requests a format change to this
 533  * new caps.
 534  * If a format change was requested, the returned buffer will be one to hold
 535  * the data of said new caps, so its size might be different from the requested
 536  * @size.
 537  *
 538  * When this function returns anything else than #GST_FLOW_OK, the buffer allocation
 539  * failed and @buf does not contain valid data. If the function returns #GST_FLOW_OK and
 540  * the @buf is NULL, a #GstBuffer will be created with @caps, @offset and @size.
 541  *
 542  * By default this function returns a new buffer of @size and with @caps containing
 543  * purely malloced data. The buffer should be freed with gst_buffer_unref()
 544  * after usage.
 545  *
 546  * Returns: #GST_FLOW_OK if @buf contains a valid buffer, any other return
 547  *  value means @buf does not hold a valid buffer.
 548  */
 549 typedef GstFlowReturn           (*GstPadBufferAllocFunction)    (GstPad *pad, guint64 offset, guint size,
 550                                                                  GstCaps *caps, GstBuffer **buf);
 551
 552 /* misc */
 553 /**
 554  * GstPadDispatcherFunction:
 555  * @pad: the #GstPad that is dispatched.
 556  * @data: the gpointer to optional user data.
 557  *
 558  * A dispatcher function is called for all internally linked pads, see
 559  * gst_pad_dispatcher().
 560  *
 561  * Returns: TRUE if the dispatching procedure has to be stopped.
 562  */
 563 typedef gboolean                (*GstPadDispatcherFunction)     (GstPad *pad, gpointer data);
 564
 565 /**
 566  * GstPadBlockCallback:
 567  * @pad: the #GstPad that is blockend or unblocked.
 568  * @blocked: blocking state for the pad
 569  * @user_data: the gpointer to optional user data.
 570  *
 571  * Callback used by gst_pad_set_blocked_async(). Gets called when the blocking
 572  * operation succeeds.
 573  */
 574 typedef void                    (*GstPadBlockCallback)          (GstPad *pad, gboolean blocked, gpointer user_data);
 575
 576 /**
 577  * GstPadDirection:
 578  * @GST_PAD_UNKNOWN: direction is unknown.
 579  * @GST_PAD_SRC: the pad is a source pad.
 580  * @GST_PAD_SINK: the pad is a sink pad.
 581  *
 582  * The direction of a pad.
 583  */
 584 typedef enum {
 585   GST_PAD_UNKNOWN,
 586   GST_PAD_SRC,
 587   GST_PAD_SINK
 588 } GstPadDirection;
 589
 590 /**
 591  * GstPadFlags:
 592  * @GST_PAD_BLOCKED: is dataflow on a pad blocked
 593  * @GST_PAD_FLUSHING: is pad refusing buffers
 594  * @GST_PAD_IN_GETCAPS: GstPadGetCapsFunction() is running now
 595  * @GST_PAD_IN_SETCAPS: GstPadSetCapsFunction() is running now
 596  * @GST_PAD_BLOCKING: is pad currently blocking on a buffer or event
 597  * @GST_PAD_FLAG_LAST: offset to define more flags
 598  *
 599  * Pad state flags
 600  */
 601 typedef enum {
 602   GST_PAD_BLOCKED       = (GST_OBJECT_FLAG_LAST << 0),
 603   GST_PAD_FLUSHING      = (GST_OBJECT_FLAG_LAST << 1),
 604   GST_PAD_IN_GETCAPS    = (GST_OBJECT_FLAG_LAST << 2),
 605   GST_PAD_IN_SETCAPS    = (GST_OBJECT_FLAG_LAST << 3),
 606   GST_PAD_BLOCKING      = (GST_OBJECT_FLAG_LAST << 4),
 607   /* padding */
 608   GST_PAD_FLAG_LAST     = (GST_OBJECT_FLAG_LAST << 8)
 609 } GstPadFlags;
 610
 611 /* FIXME: this awful circular dependency need to be resolved properly (see padtemplate.h) */
 612 typedef struct _GstPadTemplate GstPadTemplate;
 613
 614 /**
 615  * GstPad:
 616  * @element_private: private data owned by the parent element
 617  * @padtemplate: padtemplate for this pad
 618  * @direction: the direction of the pad, cannot change after creating
 619  *             the pad.
 620  * @stream_rec_lock: recursive stream lock of the pad, used to protect
 621  *                   the data used in streaming.
 622  * @task: task for this pad if the pad is actively driving dataflow.
 623  * @preroll_lock: lock used when prerolling
 624  * @preroll_cond: conf to signal preroll
 625  * @block_cond: conditional to signal pad block
 626  * @block_callback: callback for the pad block if any
 627  * @block_data: user data for @block_callback
 628  * @caps: the current caps of the pad
 629  * @getcapsfunc: function to get caps of the pad
 630  * @setcapsfunc: function to set caps on the pad
 631  * @acceptcapsfunc: function to check if pad can accept caps
 632  * @fixatecapsfunc: function to fixate caps
 633  * @activatefunc: pad activation function
 634  * @activatepushfunc: function to activate/deactivate pad in push mode
 635  * @activatepullfunc: function to activate/deactivate pad in pull mode
 636  * @linkfunc: function called when pad is linked
 637  * @unlinkfunc: function called when pad is unlinked
 638  * @peer: the pad this pad is linked to
 639  * @sched_private: private storage for the scheduler
 640  * @chainfunc: function to chain buffer to pad
 641  * @checkgetrangefunc: function to check if pad can operate in pull mode
 642  * @getrangefunc: function to get a range of data from a pad
 643  * @eventfunc: function to send an event to a pad
 644  * @mode: current activation mode of the pad
 645  * @querytypefunc: get list of supported queries
 646  * @queryfunc: perform a query on the pad
 647  * @intlinkfunc: get the internal links of this pad
 648  * @bufferallocfunc: function to allocate a buffer for this pad
 649  * @do_buffer_signals: counter counting installed buffer signals
 650  * @do_event_signals: counter counting installed event signals
 651  * @iterintlinkfunc: get the internal links iterator of this pad
 652  * @block_destroy_data: notify function for gst_pad_set_blocked_async_full()
 653  *
 654  * The #GstPad structure. Use the functions to update the variables.
 655  */
 656 struct _GstPad {
 657   GstObject                     object;
 658
 659   /*< public >*/
 660   gpointer                      element_private;
 661
 662   GstPadTemplate                *padtemplate;
 663
 664   GstPadDirection                direction;
 665
 666   /*< public >*/ /* with STREAM_LOCK */
 667   /* streaming rec_lock */
 668   GStaticRecMutex               *stream_rec_lock;
 669   GstTask                       *task;
 670   /*< public >*/ /* with PREROLL_LOCK */
 671   GMutex                        *preroll_lock;
 672   GCond                         *preroll_cond;
 673
 674   /*< public >*/ /* with LOCK */
 675   /* block cond, mutex is from the object */
 676   GCond                         *block_cond;
 677   GstPadBlockCallback            block_callback;
 678   gpointer                       block_data;
 679
 680   /* the pad capabilities */
 681   GstCaps                       *caps;
 682   GstPadGetCapsFunction         getcapsfunc;
 683   GstPadSetCapsFunction         setcapsfunc;
 684   GstPadAcceptCapsFunction       acceptcapsfunc;
 685   GstPadFixateCapsFunction       fixatecapsfunc;
 686
 687   GstPadActivateFunction         activatefunc;
 688   GstPadActivateModeFunction     activatepushfunc;
 689   GstPadActivateModeFunction     activatepullfunc;
 690
 691   /* pad link */
 692   GstPadLinkFunction             linkfunc;
 693   GstPadUnlinkFunction           unlinkfunc;
 694   GstPad                        *peer;
 695
 696   gpointer                       sched_private;
 697
 698   /* data transport functions */
 699   GstPadChainFunction            chainfunc;
 700   GstPadCheckGetRangeFunction    checkgetrangefunc;
 701   GstPadGetRangeFunction         getrangefunc;
 702   GstPadEventFunction            eventfunc;
 703
 704   GstActivateMode                mode;
 705
 706   /* generic query method */
 707   GstPadQueryTypeFunction        querytypefunc;
 708   GstPadQueryFunction            queryfunc;
 709
 710   /* internal links */
 711   GstPadIntLinkFunction          intlinkfunc;
 712
 713   GstPadBufferAllocFunction      bufferallocfunc;
 714
 715   /* whether to emit signals for have-data. counts number
 716    * of handlers attached. */
 717   gint                           do_buffer_signals;
 718   gint                           do_event_signals;
 719
 720   /* ABI added */
 721   /* iterate internal links */
 722   GstPadIterIntLinkFunction     iterintlinkfunc;
 723
 724   /* free block_data */
 725   GDestroyNotify block_destroy_data;
 726
 727   /*< private >*/
 728   union {
 729     struct {
 730       gboolean                      block_callback_called;
 731       GstPadPrivate                *priv;
 732     } ABI;
 733     gpointer _gst_reserved[GST_PADDING - 2];
 734   } abidata;
 735 };
 736
 737 struct _GstPadClass {
 738   GstObjectClass        parent_class;
 739
 740   /* signal callbacks */
 741   void          (*linked)               (GstPad *pad, GstPad *peer);
 742   void          (*unlinked)             (GstPad *pad, GstPad *peer);
 743   void          (*request_link)         (GstPad *pad);
 744   gboolean      (*have_data)            (GstPad *pad, GstMiniObject *data);
 745
 746   /*< private >*/
 747   gpointer _gst_reserved[GST_PADDING];
 748 };
 749
 750
 751 /***** helper macros *****/
 752 /* GstPad */
 753 #define GST_PAD_NAME(pad)               (GST_OBJECT_NAME(pad))
 754 #define GST_PAD_PARENT(pad)             (GST_ELEMENT_CAST(GST_OBJECT_PARENT(pad)))
 755 #define GST_PAD_ELEMENT_PRIVATE(pad)    (GST_PAD_CAST(pad)->element_private)
 756 #define GST_PAD_PAD_TEMPLATE(pad)       (GST_PAD_CAST(pad)->padtemplate)
 757 #define GST_PAD_DIRECTION(pad)          (GST_PAD_CAST(pad)->direction)
 758 #define GST_PAD_TASK(pad)               (GST_PAD_CAST(pad)->task)
 759 #define GST_PAD_ACTIVATE_MODE(pad)      (GST_PAD_CAST(pad)->mode)
 760
 761 #define GST_PAD_ACTIVATEFUNC(pad)       (GST_PAD_CAST(pad)->activatefunc)
 762 #define GST_PAD_ACTIVATEPUSHFUNC(pad)   (GST_PAD_CAST(pad)->activatepushfunc)
 763 #define GST_PAD_ACTIVATEPULLFUNC(pad)   (GST_PAD_CAST(pad)->activatepullfunc)
 764 #define GST_PAD_CHAINFUNC(pad)          (GST_PAD_CAST(pad)->chainfunc)
 765 #define GST_PAD_CHECKGETRANGEFUNC(pad)  (GST_PAD_CAST(pad)->checkgetrangefunc)
 766 #define GST_PAD_GETRANGEFUNC(pad)       (GST_PAD_CAST(pad)->getrangefunc)
 767 #define GST_PAD_EVENTFUNC(pad)          (GST_PAD_CAST(pad)->eventfunc)
 768 #define GST_PAD_QUERYTYPEFUNC(pad)      (GST_PAD_CAST(pad)->querytypefunc)
 769 #define GST_PAD_QUERYFUNC(pad)          (GST_PAD_CAST(pad)->queryfunc)
 770 #ifndef GST_DISABLE_DEPRECATED
 771 #define GST_PAD_INTLINKFUNC(pad)        (GST_PAD_CAST(pad)->intlinkfunc)
 772 #endif
 773 #define GST_PAD_ITERINTLINKFUNC(pad)    (GST_PAD_CAST(pad)->iterintlinkfunc)
 774
 775 #define GST_PAD_PEER(pad)               (GST_PAD_CAST(pad)->peer)
 776 #define GST_PAD_LINKFUNC(pad)           (GST_PAD_CAST(pad)->linkfunc)
 777 #define GST_PAD_UNLINKFUNC(pad)         (GST_PAD_CAST(pad)->unlinkfunc)
 778
 779 /**
 780  * GST_PAD_CAPS:
 781  * @pad: a #GstPad.
 782  *
 783  * The caps for this pad.
 784  */
 785 #define GST_PAD_CAPS(pad)               (GST_PAD_CAST(pad)->caps)
 786 #define GST_PAD_GETCAPSFUNC(pad)        (GST_PAD_CAST(pad)->getcapsfunc)
 787 #define GST_PAD_SETCAPSFUNC(pad)        (GST_PAD_CAST(pad)->setcapsfunc)
 788 #define GST_PAD_ACCEPTCAPSFUNC(pad)     (GST_PAD_CAST(pad)->acceptcapsfunc)
 789 #define GST_PAD_FIXATECAPSFUNC(pad)     (GST_PAD_CAST(pad)->fixatecapsfunc)
 790
 791 #define GST_PAD_BUFFERALLOCFUNC(pad)    (GST_PAD_CAST(pad)->bufferallocfunc)
 792
 793 #define GST_PAD_DO_BUFFER_SIGNALS(pad)  (GST_PAD_CAST(pad)->do_buffer_signals)
 794 #define GST_PAD_DO_EVENT_SIGNALS(pad)   (GST_PAD_CAST(pad)->do_event_signals)
 795
 796 #define GST_PAD_IS_LINKED(pad)          (GST_PAD_PEER(pad) != NULL)
 797 #define GST_PAD_IS_BLOCKED(pad)         (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_BLOCKED))
 798 #define GST_PAD_IS_BLOCKING(pad)        (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_BLOCKING))
 799 #define GST_PAD_IS_FLUSHING(pad)        (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLUSHING))
 800 #define GST_PAD_IS_IN_GETCAPS(pad)      (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_IN_GETCAPS))
 801 #define GST_PAD_IS_IN_SETCAPS(pad)      (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_IN_SETCAPS))
 802 #define GST_PAD_IS_SRC(pad)             (GST_PAD_DIRECTION(pad) == GST_PAD_SRC)
 803 #define GST_PAD_IS_SINK(pad)            (GST_PAD_DIRECTION(pad) == GST_PAD_SINK)
 804
 805 #define GST_PAD_SET_FLUSHING(pad)       (GST_OBJECT_FLAG_SET (pad, GST_PAD_FLUSHING))
 806 #define GST_PAD_UNSET_FLUSHING(pad)     (GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLUSHING))
 807
 808 /**
 809  * GST_PAD_GET_STREAM_LOCK:
 810  * @pad: a #GstPad
 811  *
 812  * Get the stream lock of @pad. The stream lock is protecting the
 813  * resources used in the data processing functions of @pad.
 814  */
 815 #define GST_PAD_GET_STREAM_LOCK(pad)    (GST_PAD_CAST(pad)->stream_rec_lock)
 816 /**
 817  * GST_PAD_STREAM_LOCK:
 818  * @pad: a #GstPad
 819  *
 820  * Lock the stream lock of @pad.
 821  */
 822 #define GST_PAD_STREAM_LOCK(pad)        (g_static_rec_mutex_lock(GST_PAD_GET_STREAM_LOCK(pad)))
 823 /**
 824  * GST_PAD_STREAM_LOCK_FULL:
 825  * @pad: a #GstPad
 826  * @t: the number of times to recursively lock
 827  *
 828  * Lock the stream lock of @pad @t times.
 829  */
 830 #define GST_PAD_STREAM_LOCK_FULL(pad,t) (g_static_rec_mutex_lock_full(GST_PAD_GET_STREAM_LOCK(pad), t))
 831 /**
 832  * GST_PAD_STREAM_TRYLOCK:
 833  * @pad: a #GstPad
 834  *
 835  * Try to Lock the stream lock of the pad, return TRUE if the lock could be
 836  * taken.
 837  */
 838 #define GST_PAD_STREAM_TRYLOCK(pad)     (g_static_rec_mutex_trylock(GST_PAD_GET_STREAM_LOCK(pad)))
 839 /**
 840  * GST_PAD_STREAM_UNLOCK:
 841  * @pad: a #GstPad
 842  *
 843  * Unlock the stream lock of @pad.
 844  */
 845 #define GST_PAD_STREAM_UNLOCK(pad)      (g_static_rec_mutex_unlock(GST_PAD_GET_STREAM_LOCK(pad)))
 846 /**
 847  * GST_PAD_STREAM_UNLOCK_FULL:
 848  * @pad: a #GstPad
 849  *
 850  * Fully unlock the recursive stream lock of @pad, return the number of times
 851  * @pad was locked.
 852  */
 853 #define GST_PAD_STREAM_UNLOCK_FULL(pad) (g_static_rec_mutex_unlock_full(GST_PAD_GET_STREAM_LOCK(pad)))
 854
 855 #define GST_PAD_GET_PREROLL_LOCK(pad)   (GST_PAD_CAST(pad)->preroll_lock)
 856 #define GST_PAD_PREROLL_LOCK(pad)       (g_mutex_lock(GST_PAD_GET_PREROLL_LOCK(pad)))
 857 #define GST_PAD_PREROLL_TRYLOCK(pad)    (g_mutex_trylock(GST_PAD_GET_PREROLL_LOCK(pad)))
 858 #define GST_PAD_PREROLL_UNLOCK(pad)     (g_mutex_unlock(GST_PAD_GET_PREROLL_LOCK(pad)))
 859
 860 #define GST_PAD_GET_PREROLL_COND(pad)   (GST_PAD_CAST(pad)->preroll_cond)
 861 #define GST_PAD_PREROLL_WAIT(pad)       \
 862     g_cond_wait (GST_PAD_GET_PREROLL_COND (pad), GST_PAD_GET_PREROLL_LOCK (pad))
 863 #define GST_PAD_PREROLL_TIMED_WAIT(pad, timeval) \
 864     g_cond_timed_wait (GST_PAD_GET_PREROLL_COND (pad), GST_PAD_GET_PREROLL_LOCK (pad), timeval)
 865 #define GST_PAD_PREROLL_SIGNAL(pad)     g_cond_signal (GST_PAD_GET_PREROLL_COND (pad));
 866 #define GST_PAD_PREROLL_BROADCAST(pad)  g_cond_broadcast (GST_PAD_GET_PREROLL_COND (pad));
 867
 868 #define GST_PAD_BLOCK_GET_COND(pad)     (GST_PAD_CAST(pad)->block_cond)
 869 #define GST_PAD_BLOCK_WAIT(pad)         (g_cond_wait(GST_PAD_BLOCK_GET_COND (pad), GST_OBJECT_GET_LOCK (pad)))
 870 #define GST_PAD_BLOCK_SIGNAL(pad)       (g_cond_signal(GST_PAD_BLOCK_GET_COND (pad)))
 871 #define GST_PAD_BLOCK_BROADCAST(pad)    (g_cond_broadcast(GST_PAD_BLOCK_GET_COND (pad)))
 872
 873 /* FIXME: this awful circular dependency need to be resolved properly (see padtemplate.h) */
 874 #include <gst/gstpadtemplate.h>
 875
 876 GType                   gst_pad_get_type                        (void);
 877
 878 /* creating pads */
 879 GstPad*                 gst_pad_new                             (const gchar *name, GstPadDirection direction);
 880 GstPad*                 gst_pad_new_from_template               (GstPadTemplate *templ, const gchar *name);
 881 GstPad*                 gst_pad_new_from_static_template        (GstStaticPadTemplate *templ, const gchar *name);
 882
 883
 884 /**
 885  * gst_pad_get_name:
 886  * @pad: the pad to get the name from
 887  *
 888  * Get a copy of the name of the pad. g_free() after usage.
 889  *
 890  * MT safe.
 891  */
 892 #define gst_pad_get_name(pad) gst_object_get_name (GST_OBJECT_CAST (pad))
 893 /**
 894  * gst_pad_get_parent:
 895  * @pad: the pad to get the parent of
 896  *
 897  * Get the parent of @pad. This function increases the refcount
 898  * of the parent object so you should gst_object_unref() it after usage.
 899  * Can return NULL if the pad did not have a parent.
 900  *
 901  * MT safe.
 902  */
 903 #define gst_pad_get_parent(pad) gst_object_get_parent (GST_OBJECT_CAST (pad))
 904
 905 GstPadDirection         gst_pad_get_direction                   (GstPad *pad);
 906
 907 gboolean                gst_pad_set_active                      (GstPad *pad, gboolean active);
 908 gboolean                gst_pad_is_active                       (GstPad *pad);
 909 gboolean                gst_pad_activate_pull                   (GstPad *pad, gboolean active);
 910 gboolean                gst_pad_activate_push                   (GstPad *pad, gboolean active);
 911
 912 gboolean                gst_pad_set_blocked                     (GstPad *pad, gboolean blocked);
 913 gboolean                gst_pad_set_blocked_async               (GstPad *pad, gboolean blocked,
 914                                                                  GstPadBlockCallback callback, gpointer user_data);
 915 gboolean                gst_pad_set_blocked_async_full          (GstPad *pad, gboolean blocked,
 916                                                                  GstPadBlockCallback callback, gpointer user_data,
 917                                                                  GDestroyNotify destroy_data);
 918 gboolean                gst_pad_is_blocked                      (GstPad *pad);
 919 gboolean                gst_pad_is_blocking                     (GstPad *pad);
 920
 921 void                    gst_pad_set_element_private             (GstPad *pad, gpointer priv);
 922 gpointer                gst_pad_get_element_private             (GstPad *pad);
 923
 924 GstPadTemplate*         gst_pad_get_pad_template                (GstPad *pad);
 925
 926 void                    gst_pad_set_bufferalloc_function        (GstPad *pad, GstPadBufferAllocFunction bufalloc);
 927 GstFlowReturn           gst_pad_alloc_buffer                    (GstPad *pad, guint64 offset, gint size,
 928                                                                  GstCaps *caps, GstBuffer **buf);
 929 GstFlowReturn           gst_pad_alloc_buffer_and_set_caps       (GstPad *pad, guint64 offset, gint size,
 930                                                                  GstCaps *caps, GstBuffer **buf);
 931
 932 /* data passing setup functions */
 933 void                    gst_pad_set_activate_function           (GstPad *pad, GstPadActivateFunction activate);
 934 void                    gst_pad_set_activatepull_function       (GstPad *pad, GstPadActivateModeFunction activatepull);
 935 void                    gst_pad_set_activatepush_function       (GstPad *pad, GstPadActivateModeFunction activatepush);
 936 void                    gst_pad_set_chain_function              (GstPad *pad, GstPadChainFunction chain);
 937 void                    gst_pad_set_chain_list_function (GstPad *pad, GstPadChainListFunction chainlist);
 938 void                    gst_pad_set_getrange_function           (GstPad *pad, GstPadGetRangeFunction get);
 939 void                    gst_pad_set_checkgetrange_function      (GstPad *pad, GstPadCheckGetRangeFunction check);
 940 void                    gst_pad_set_event_function              (GstPad *pad, GstPadEventFunction event);
 941
 942 /* pad links */
 943 void                    gst_pad_set_link_function               (GstPad *pad, GstPadLinkFunction link);
 944 void                    gst_pad_set_unlink_function             (GstPad *pad, GstPadUnlinkFunction unlink);
 945
 946 gboolean                gst_pad_can_link                        (GstPad *srcpad, GstPad *sinkpad);
 947 GstPadLinkReturn        gst_pad_link                            (GstPad *srcpad, GstPad *sinkpad);
 948 GstPadLinkReturn        gst_pad_link_full                       (GstPad *srcpad, GstPad *sinkpad, GstPadLinkCheck flags);
 949 gboolean                gst_pad_unlink                          (GstPad *srcpad, GstPad *sinkpad);
 950 gboolean                gst_pad_is_linked                       (GstPad *pad);
 951
 952 GstPad*                 gst_pad_get_peer                        (GstPad *pad);
 953
 954 /* capsnego functions */
 955 void                    gst_pad_set_getcaps_function            (GstPad *pad, GstPadGetCapsFunction getcaps);
 956 void                    gst_pad_set_acceptcaps_function         (GstPad *pad, GstPadAcceptCapsFunction acceptcaps);
 957 void                    gst_pad_set_fixatecaps_function         (GstPad *pad, GstPadFixateCapsFunction fixatecaps);
 958 void                    gst_pad_set_setcaps_function            (GstPad *pad, GstPadSetCapsFunction setcaps);
 959
 960 const GstCaps*          gst_pad_get_pad_template_caps           (GstPad *pad);
 961
 962 /* capsnego function for linked/unlinked pads */
 963 GstCaps *               gst_pad_get_caps_reffed                 (GstPad * pad);
 964 GstCaps *               gst_pad_get_caps                        (GstPad * pad);
 965 void                    gst_pad_fixate_caps                     (GstPad * pad, GstCaps *caps);
 966 gboolean                gst_pad_accept_caps                     (GstPad * pad, GstCaps *caps);
 967 gboolean                gst_pad_set_caps                        (GstPad * pad, GstCaps *caps);
 968
 969 GstCaps *               gst_pad_peer_get_caps_reffed            (GstPad * pad);
 970 GstCaps *               gst_pad_peer_get_caps                   (GstPad * pad);
 971 gboolean                gst_pad_peer_accept_caps                (GstPad * pad, GstCaps *caps);
 972
 973 /* capsnego for linked pads */
 974 GstCaps *               gst_pad_get_allowed_caps                (GstPad * pad);
 975 GstCaps *               gst_pad_get_negotiated_caps             (GstPad * pad);
 976
 977 /* data passing functions to peer */
 978 GstFlowReturn           gst_pad_push                            (GstPad *pad, GstBuffer *buffer);
 979 GstFlowReturn           gst_pad_push_list                       (GstPad *pad, GstBufferList *list);
 980 gboolean                gst_pad_check_pull_range                (GstPad *pad);
 981 GstFlowReturn           gst_pad_pull_range                      (GstPad *pad, guint64 offset, guint size,
 982                                                                  GstBuffer **buffer);
 983 gboolean                gst_pad_push_event                      (GstPad *pad, GstEvent *event);
 984 gboolean                gst_pad_event_default                   (GstPad *pad, GstEvent *event);
 985
 986 /* data passing functions on pad */
 987 GstFlowReturn           gst_pad_chain                           (GstPad *pad, GstBuffer *buffer);
 988 GstFlowReturn           gst_pad_chain_list                      (GstPad *pad, GstBufferList *list);
 989 GstFlowReturn           gst_pad_get_range                       (GstPad *pad, guint64 offset, guint size,
 990                                                                  GstBuffer **buffer);
 991 gboolean                gst_pad_send_event                      (GstPad *pad, GstEvent *event);
 992
 993 /* pad tasks */
 994 gboolean                gst_pad_start_task                      (GstPad *pad, GstTaskFunction func,
 995                                                                  gpointer data);
 996 gboolean                gst_pad_pause_task                      (GstPad *pad);
 997 gboolean                gst_pad_stop_task                       (GstPad *pad);
 998
 999 /* internal links */
1000 #ifndef GST_DISABLE_DEPRECATED
1001 void                    gst_pad_set_internal_link_function      (GstPad *pad, GstPadIntLinkFunction intlink);
1002 GList*                  gst_pad_get_internal_links              (GstPad *pad);
1003 GList*                  gst_pad_get_internal_links_default      (GstPad *pad);
1004 #endif
1005
1006 void                    gst_pad_set_iterate_internal_links_function (GstPad * pad,
1007                                                                  GstPadIterIntLinkFunction iterintlink);
1008 GstIterator *           gst_pad_iterate_internal_links          (GstPad * pad);
1009 GstIterator *           gst_pad_iterate_internal_links_default  (GstPad * pad);
1010
1011
1012 /* generic query function */
1013 void                    gst_pad_set_query_type_function         (GstPad *pad, GstPadQueryTypeFunction type_func);
1014 const GstQueryType*     gst_pad_get_query_types                 (GstPad *pad);
1015 const GstQueryType*     gst_pad_get_query_types_default         (GstPad *pad);
1016
1017 gboolean                gst_pad_query                           (GstPad *pad, GstQuery *query);
1018 gboolean                gst_pad_peer_query                      (GstPad *pad, GstQuery *query);
1019 void                    gst_pad_set_query_function              (GstPad *pad, GstPadQueryFunction query);
1020 gboolean                gst_pad_query_default                   (GstPad *pad, GstQuery *query);
1021
1022 /* misc helper functions */
1023 gboolean                gst_pad_dispatcher                      (GstPad *pad, GstPadDispatcherFunction dispatch,
1024                                                                  gpointer data);
1025
1026 #if !defined(GST_DISABLE_LOADSAVE) && !defined(GST_DISABLE_DEPRECATED)
1027 void                    gst_pad_load_and_link                   (xmlNodePtr self, GstObject *parent);
1028 #endif
1029
1030 G_END_DECLS
1031
1032 #endif /* __GST_PAD_H__ */