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