gst/gstpad.h

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