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