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 GST_EXPORT GType _gst_pad_type;
  39
  40 /*
  41  * Pad base class
  42  */
  43 #define GST_TYPE_PAD                    (_gst_pad_type)
  44 #define GST_IS_PAD(obj)                 (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PAD))
  45 #define GST_IS_PAD_FAST(obj)            (G_OBJECT_TYPE(obj) == GST_TYPE_PAD) /* necessary? */
  46 #define GST_IS_PAD_CLASS(klass)         (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PAD))
  47 #define GST_PAD(obj)                    (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PAD, GstPad))
  48 #define GST_PAD_CLASS(klass)            (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PAD, GstPadClass))
  49 #define GST_PAD_CAST(obj)               ((GstPad*)(obj))
  50
  51 typedef struct _GstPad GstPad;
  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 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 successfull
  88  * link step.
  89  */
  90 #define GST_PAD_LINK_SUCCESSFUL(ret) ((ret) >= GST_PAD_LINK_OK)
  91
  92 /**
  93  * GstFlowReturn:
  94  * GST_FLOW_RESEND:              Resend buffer, possibly with new caps.
  95  * GST_FLOW_OK:                  Data passing was ok.
  96  * GST_FLOW_NOT_LINKED:          Pad is not linked.
  97  * GST_FLOW_WRONG_STATE:         Pad is in wrong state.
  98  * GST_FLOW_UNEXPECTED:          Did not expect anything, like after EOS.
  99  * GST_FLOW_NOT_NEGOTIATED:      Pad is not negotiated.
 100  * GST_FLOW_ERROR:               Some (fatal) error occured.
 101  *
 102  * The result of passing data to a linked pad.
 103  */
 104 typedef enum {
 105   GST_FLOW_RESEND         =  1,
 106   GST_FLOW_OK             =  0,
 107   /* expected failures */
 108   GST_FLOW_NOT_LINKED     = -1,
 109   GST_FLOW_WRONG_STATE    = -2,
 110   /* error cases */
 111   GST_FLOW_UNEXPECTED     = -3,
 112   GST_FLOW_NOT_NEGOTIATED = -4,
 113   GST_FLOW_ERROR          = -5,
 114   GST_FLOW_NOT_SUPPORTED  = -6
 115 } GstFlowReturn;
 116
 117 /**
 118  * GST_FLOW_IS_FATAL:
 119  * @ret: a #GstFlowReturn value
 120  *
 121  * Macro to test if the given #GstFlowReturn value indicates a fatal
 122  * error.
 123  */
 124 #define GST_FLOW_IS_FATAL(ret) ((ret) <= GST_FLOW_UNEXPECTED)
 125
 126 G_CONST_RETURN gchar*   gst_flow_get_name       (GstFlowReturn ret);
 127 GQuark                  gst_flow_to_quark       (GstFlowReturn ret);
 128
 129 typedef enum {
 130   GST_ACTIVATE_NONE,
 131   GST_ACTIVATE_PUSH,
 132   GST_ACTIVATE_PULL,
 133 } GstActivateMode;
 134
 135 #define GST_PAD_MODE_ACTIVATE(mode) ((mode) != GST_ACTIVATE_NONE)
 136
 137 /* pad states */
 138 typedef gboolean                (*GstPadActivateFunction)       (GstPad *pad);
 139 typedef gboolean                (*GstPadActivateModeFunction)   (GstPad *pad, gboolean active);
 140
 141
 142 /* data passing */
 143 /**
 144  * GstPadChainFunction:
 145  * @pad: the #GstPad that performed the chain.
 146  * @buffer: the #GstBuffer that is chained.
 147  *
 148  * A function that will be called when chaining buffers.
 149  *
 150  *  Returns: GST_FLOW_OK for success
 151  */
 152 typedef GstFlowReturn           (*GstPadChainFunction)          (GstPad *pad, GstBuffer *buffer);
 153 typedef GstFlowReturn           (*GstPadGetRangeFunction)       (GstPad *pad, guint64 offset,
 154                                                                  guint length, GstBuffer **buffer);
 155
 156 /**
 157  * GstPadEventFunction:
 158  * @pad: the #GstPad to handle the event.
 159  * @event: the #GstEvent to handle.
 160  *
 161  * Function signature to handle an event for the pad.
 162  *
 163  * Returns: TRUE if the pad could handle the event.
 164  */
 165 typedef gboolean                (*GstPadEventFunction)          (GstPad *pad, GstEvent *event);
 166
 167
 168 /* deprecate me, check range should use seeking query */
 169 typedef gboolean                (*GstPadCheckGetRangeFunction)  (GstPad *pad);
 170
 171
 172 /* internal links */
 173 /**
 174  * GstPadIntLinkFunction:
 175  * @pad: The #GstPad to query.
 176  *
 177  * The signature of the internal pad link function.
 178  *
 179  * Returns: a newly allocated #GList of pads that are linked to the given pad on
 180  *  the inside of the parent element.
 181  *  The caller must call g_list_free() on it after use.
 182  *
 183  */
 184 typedef GList*                  (*GstPadIntLinkFunction)        (GstPad *pad);
 185
 186
 187 /* generic query function */
 188 /**
 189  * GstPadQueryTypeFunction:
 190  * @pad: a #GstPad to query
 191  *
 192  * The signature of the query types function.
 193  *
 194  * Returns: an array of query types
 195  */
 196 typedef const GstQueryType*     (*GstPadQueryTypeFunction)      (GstPad *pad);
 197
 198 /**
 199  * GstPadQueryFunction:
 200  * @pad: the #GstPad to query.
 201  * @query: the #GstQuery object to execute
 202  *
 203  * The signature of the query function.
 204  *
 205  * Returns: TRUE if the query could be performed.
 206  */
 207 typedef gboolean                (*GstPadQueryFunction)          (GstPad *pad, GstQuery *query);
 208
 209
 210 /* linking */
 211 /**
 212  * GstPadLinkFunction
 213  * @pad: the #GstPad that is linked.
 214  * @peer: the peer #GstPad of the link
 215  *
 216  * Function signature to handle a new link on the pad.
 217  *
 218  * Returns: the result of the link with the specified peer.
 219  */
 220 typedef GstPadLinkReturn        (*GstPadLinkFunction)           (GstPad *pad, GstPad *peer);
 221 /**
 222  * GstPadUnlinkFunction
 223  * @pad: the #GstPad that is linked.
 224  *
 225  * Function signature to handle a unlinking the pad prom its peer.
 226  */
 227 typedef void                    (*GstPadUnlinkFunction)         (GstPad *pad);
 228
 229
 230 /* caps nego */
 231 /**
 232  * GstPadGetCapsFunction:
 233  * @pad: the #GstPad to get the capabilities of.
 234  *
 235  * Returns a copy of the capabilities of the specified pad. By default this
 236  * function will return the pad template capabilities, but can optionally
 237  * be overridden.
 238  *
 239  * Returns: a newly allocated copy #GstCaps of the pad.
 240  */
 241 typedef GstCaps*                (*GstPadGetCapsFunction)        (GstPad *pad);
 242 typedef gboolean                (*GstPadSetCapsFunction)        (GstPad *pad, GstCaps *caps);
 243 typedef gboolean                (*GstPadAcceptCapsFunction)     (GstPad *pad, GstCaps *caps);
 244 typedef void                    (*GstPadFixateCapsFunction)     (GstPad *pad, GstCaps *caps);
 245 typedef GstFlowReturn           (*GstPadBufferAllocFunction)    (GstPad *pad, guint64 offset, guint size,
 246                                                                  GstCaps *caps, GstBuffer **buf);
 247
 248 /* misc */
 249 /**
 250  * GstPadDispatcherFunction:
 251  * @pad: the #GstPad that is dispatched.
 252  * @data: the gpointer to optional user data.
 253  *
 254  * A dispatcher function is called for all internally linked pads, see
 255  * gst_pad_dispatcher().
 256  *
 257  * Returns: TRUE if the dispatching procedure has to be stopped.
 258  */
 259 typedef gboolean                (*GstPadDispatcherFunction)     (GstPad *pad, gpointer data);
 260
 261 /**
 262  * GstPadBlockCallback:
 263  * @pad: the #GstPad that is blockend or unblocked.
 264  * @blocked: blocking state for the pad
 265  * @user_data: the gpointer to optional user data.
 266  *
 267  * Callback used by gst_pad_set_blocked_async(). Gets called when the blocking
 268  * operation succeeds.
 269  */
 270
 271 typedef void                    (*GstPadBlockCallback)          (GstPad *pad, gboolean blocked, gpointer user_data);
 272
 273 /**
 274  * GstPadDirection:
 275  * @GST_PAD_UNKNOWN: direction is unknown.
 276  * @GST_PAD_SRC: the pad is a source pad.
 277  * @GST_PAD_SINK: the pad is a sink pad.
 278  *
 279  * The direction of a pad.
 280  */
 281 typedef enum {
 282   GST_PAD_UNKNOWN,
 283   GST_PAD_SRC,
 284   GST_PAD_SINK
 285 } GstPadDirection;
 286
 287 /**
 288  * GstPadFlags:
 289  * @GST_PAD_BLOCKED: is dataflow on a pad blocked
 290  * @GST_PAD_FLUSHING: is pad empying buffers
 291  * @GST_PAD_IN_GETCAPS: GstPadGetCapsFunction() is running now
 292  * @GST_PAD_IN_SETCAPS: GstPadSetCapsFunction() is running now
 293  * @GST_PAD_FLAG_LAST: offset to define more flags
 294  *
 295  * Pad state flags
 296  */
 297 typedef enum {
 298   GST_PAD_BLOCKED               = GST_OBJECT_FLAG_LAST,
 299   GST_PAD_FLUSHING,
 300   GST_PAD_IN_GETCAPS,
 301   GST_PAD_IN_SETCAPS,
 302
 303         /* padding */
 304   GST_PAD_FLAG_LAST             = GST_OBJECT_FLAG_LAST + 8
 305 } GstPadFlags;
 306
 307 /* FIXME: this awful circular dependency need to be resolved properly (see padtemplate.h) */
 308 typedef struct _GstPadTemplate GstPadTemplate;
 309
 310 struct _GstPad {
 311   GstObject                     object;
 312
 313   gpointer                      element_private;
 314
 315   GstPadTemplate                *padtemplate;
 316
 317   /* direction cannot change after creating the pad */
 318   GstPadDirection                direction;
 319
 320   /*< public >*/ /* with STREAM_LOCK */
 321   /* streaming rec_lock */
 322   GStaticRecMutex               *stream_rec_lock;
 323   GstTask                       *task;
 324   /*< public >*/ /* with PREROLL_LOCK */
 325   GMutex                        *preroll_lock;
 326   GCond                         *preroll_cond;
 327
 328   /*< public >*/ /* with LOCK */
 329   /* block cond, mutex is from the object */
 330   GCond                         *block_cond;
 331   GstPadBlockCallback            block_callback;
 332   gpointer                       block_data;
 333
 334   /* the pad capabilities */
 335   GstCaps                       *caps;
 336   GstPadGetCapsFunction         getcapsfunc;
 337   GstPadSetCapsFunction         setcapsfunc;
 338   GstPadAcceptCapsFunction       acceptcapsfunc;
 339   GstPadFixateCapsFunction       fixatecapsfunc;
 340
 341   GstPadActivateFunction         activatefunc;
 342   GstPadActivateModeFunction     activatepushfunc;
 343   GstPadActivateModeFunction     activatepullfunc;
 344
 345   /* pad link */
 346   GstPadLinkFunction             linkfunc;
 347   GstPadUnlinkFunction           unlinkfunc;
 348   GstPad                        *peer;
 349
 350   gpointer                       sched_private;
 351
 352   /* data transport functions */
 353   GstPadChainFunction            chainfunc;
 354   GstPadCheckGetRangeFunction    checkgetrangefunc;
 355   GstPadGetRangeFunction         getrangefunc;
 356   GstPadEventFunction            eventfunc;
 357
 358   GstActivateMode                mode;
 359
 360   /* generic query method */
 361   GstPadQueryTypeFunction        querytypefunc;
 362   GstPadQueryFunction            queryfunc;
 363
 364   /* internal links */
 365   GstPadIntLinkFunction          intlinkfunc;
 366
 367   GstPadBufferAllocFunction      bufferallocfunc;
 368
 369   /* whether to emit signals for have-data. counts number
 370    * of handlers attached. */
 371   gint                           do_buffer_signals;
 372   gint                           do_event_signals;
 373
 374   /*< private >*/
 375   gpointer _gst_reserved[GST_PADDING];
 376 };
 377
 378 struct _GstPadClass {
 379   GstObjectClass        parent_class;
 380
 381   /* signal callbacks */
 382   void          (*linked)               (GstPad *pad, GstPad *peer);
 383   void          (*unlinked)             (GstPad *pad, GstPad *peer);
 384   void          (*request_link)         (GstPad *pad);
 385   gboolean      (*have_data)            (GstPad *pad, GstMiniObject *data);
 386
 387   /*< private >*/
 388   gpointer _gst_reserved[GST_PADDING];
 389 };
 390
 391
 392 /***** helper macros *****/
 393 /* GstPad */
 394 #define GST_PAD_NAME(pad)               (GST_OBJECT_NAME(pad))
 395 #define GST_PAD_PARENT(pad)             (GST_ELEMENT_CAST(GST_OBJECT_PARENT(pad)))
 396 #define GST_PAD_ELEMENT_PRIVATE(pad)    (GST_PAD_CAST(pad)->element_private)
 397 #define GST_PAD_PAD_TEMPLATE(pad)       (GST_PAD_CAST(pad)->padtemplate)
 398 #define GST_PAD_DIRECTION(pad)          (GST_PAD_CAST(pad)->direction)
 399 #define GST_PAD_TASK(pad)               (GST_PAD_CAST(pad)->task)
 400 #define GST_PAD_ACTIVATE_MODE(pad)      (GST_PAD_CAST(pad)->mode)
 401
 402 #define GST_PAD_ACTIVATEFUNC(pad)       (GST_PAD_CAST(pad)->activatefunc)
 403 #define GST_PAD_ACTIVATEPUSHFUNC(pad)   (GST_PAD_CAST(pad)->activatepushfunc)
 404 #define GST_PAD_ACTIVATEPULLFUNC(pad)   (GST_PAD_CAST(pad)->activatepullfunc)
 405 #define GST_PAD_CHAINFUNC(pad)          (GST_PAD_CAST(pad)->chainfunc)
 406 #define GST_PAD_CHECKGETRANGEFUNC(pad)  (GST_PAD_CAST(pad)->checkgetrangefunc)
 407 #define GST_PAD_GETRANGEFUNC(pad)       (GST_PAD_CAST(pad)->getrangefunc)
 408 #define GST_PAD_EVENTFUNC(pad)          (GST_PAD_CAST(pad)->eventfunc)
 409 #define GST_PAD_QUERYTYPEFUNC(pad)      (GST_PAD_CAST(pad)->querytypefunc)
 410 #define GST_PAD_QUERYFUNC(pad)          (GST_PAD_CAST(pad)->queryfunc)
 411 #define GST_PAD_INTLINKFUNC(pad)        (GST_PAD_CAST(pad)->intlinkfunc)
 412
 413 #define GST_PAD_PEER(pad)               (GST_PAD_CAST(pad)->peer)
 414 #define GST_PAD_LINKFUNC(pad)           (GST_PAD_CAST(pad)->linkfunc)
 415 #define GST_PAD_UNLINKFUNC(pad)         (GST_PAD_CAST(pad)->unlinkfunc)
 416
 417 #define GST_PAD_CAPS(pad)               (GST_PAD_CAST(pad)->caps)
 418 #define GST_PAD_GETCAPSFUNC(pad)        (GST_PAD_CAST(pad)->getcapsfunc)
 419 #define GST_PAD_SETCAPSFUNC(pad)        (GST_PAD_CAST(pad)->setcapsfunc)
 420 #define GST_PAD_ACCEPTCAPSFUNC(pad)     (GST_PAD_CAST(pad)->acceptcapsfunc)
 421 #define GST_PAD_FIXATECAPSFUNC(pad)     (GST_PAD_CAST(pad)->fixatecapsfunc)
 422
 423 #define GST_PAD_BUFFERALLOCFUNC(pad)    (GST_PAD_CAST(pad)->bufferallocfunc)
 424
 425 #define GST_PAD_DO_BUFFER_SIGNALS(pad)  (GST_PAD_CAST(pad)->do_buffer_signals)
 426 #define GST_PAD_DO_EVENT_SIGNALS(pad)   (GST_PAD_CAST(pad)->do_event_signals)
 427
 428 #define GST_PAD_IS_LINKED(pad)          (GST_PAD_PEER(pad) != NULL)
 429 #define GST_PAD_IS_BLOCKED(pad)         (GST_FLAG_IS_SET (pad, GST_PAD_BLOCKED))
 430 #define GST_PAD_IS_FLUSHING(pad)        (GST_FLAG_IS_SET (pad, GST_PAD_FLUSHING))
 431 #define GST_PAD_IS_IN_GETCAPS(pad)      (GST_FLAG_IS_SET (pad, GST_PAD_IN_GETCAPS))
 432 #define GST_PAD_IS_IN_SETCAPS(pad)      (GST_FLAG_IS_SET (pad, GST_PAD_IN_SETCAPS))
 433 #define GST_PAD_IS_USABLE(pad)          (GST_PAD_IS_LINKED (pad) && \
 434                                          !GST_PAD_IS_FLUSHING(pad) && !GST_PAD_IS_FLUSHING(GST_PAD_PEER (pad)))
 435 #define GST_PAD_IS_SRC(pad)             (GST_PAD_DIRECTION(pad) == GST_PAD_SRC)
 436 #define GST_PAD_IS_SINK(pad)            (GST_PAD_DIRECTION(pad) == GST_PAD_SINK)
 437
 438 #define GST_PAD_SET_FLUSHING(pad)       (GST_FLAG_SET (pad, GST_PAD_FLUSHING))
 439 #define GST_PAD_UNSET_FLUSHING(pad)     (GST_FLAG_UNSET (pad, GST_PAD_FLUSHING))
 440
 441 #define GST_STREAM_GET_LOCK(pad)        (GST_PAD_CAST(pad)->stream_rec_lock)
 442 #define GST_STREAM_LOCK(pad)            (g_static_rec_mutex_lock(GST_STREAM_GET_LOCK(pad)))
 443 #define GST_STREAM_TRYLOCK(pad)         (g_static_rec_mutex_trylock(GST_STREAM_GET_LOCK(pad)))
 444 #define GST_STREAM_UNLOCK(pad)          (g_static_rec_mutex_unlock(GST_STREAM_GET_LOCK(pad)))
 445 #define GST_STREAM_UNLOCK_FULL(pad)     (g_static_rec_mutex_unlock_full(GST_STREAM_GET_LOCK(pad)))
 446 #define GST_STREAM_LOCK_FULL(pad,t)     (g_static_rec_mutex_lock_full(GST_STREAM_GET_LOCK(pad), t))
 447
 448 #define GST_PREROLL_GET_LOCK(pad)       (GST_PAD_CAST(pad)->preroll_lock)
 449 #define GST_PREROLL_LOCK(pad)           (g_mutex_lock(GST_PREROLL_GET_LOCK(pad)))
 450 #define GST_PREROLL_TRYLOCK(pad)        (g_mutex_trylock(GST_PREROLL_GET_LOCK(pad)))
 451 #define GST_PREROLL_UNLOCK(pad)         (g_mutex_unlock(GST_PREROLL_GET_LOCK(pad)))
 452 #define GST_PREROLL_GET_COND(pad)       (GST_PAD_CAST(pad)->preroll_cond)
 453 #define GST_PREROLL_WAIT(pad)           g_cond_wait (GST_PREROLL_GET_COND (pad), GST_PREROLL_GET_LOCK (pad))
 454 #define GST_PREROLL_TIMED_WAIT(pad, timeval) g_cond_timed_wait (GST_PREROLL_GET_COND (pad), GST_PREROLL_GET_LOCK (pad),\
 455                                              timeval)
 456 #define GST_PREROLL_SIGNAL(pad)         g_cond_signal (GST_PREROLL_GET_COND (pad));
 457 #define GST_PREROLL_BROADCAST(pad)      g_cond_broadcast (GST_PREROLL_GET_COND (pad));
 458
 459 #define GST_PAD_BLOCK_GET_COND(pad)     (GST_PAD_CAST(pad)->block_cond)
 460 #define GST_PAD_BLOCK_WAIT(pad)         (g_cond_wait(GST_PAD_BLOCK_GET_COND (pad), GST_GET_LOCK (pad)))
 461 #define GST_PAD_BLOCK_SIGNAL(pad)       (g_cond_signal(GST_PAD_BLOCK_GET_COND (pad)))
 462
 463 /* FIXME: this awful circular dependency need to be resolved properly (see padtemplate.h) */
 464 #include <gst/gstpadtemplate.h>
 465
 466 GType                   gst_pad_get_type                        (void);
 467
 468 /* creating pads */
 469 GstPad*                 gst_pad_new                             (const gchar *name, GstPadDirection direction);
 470 GstPad*                 gst_pad_new_from_template               (GstPadTemplate *templ, const gchar *name);
 471
 472 /**
 473  * gst_pad_get_name:
 474  * @pad: the pad to get the name from
 475  *
 476  * Returns a copy of the name of the pad.
 477  *
 478  * Returns: the name of the pad. g_free() after usage.
 479  *
 480  * MT safe.
 481  */
 482 #define gst_pad_get_name(pad) gst_object_get_name (GST_OBJECT_CAST (pad))
 483 /**
 484  * gst_pad_get_parent:
 485  * @pad: the pad to get the parent of
 486  *
 487  * Returns the parent of @pad. This function increases the refcount
 488  * of the parent object so you should gst_object_unref() it after usage.
 489  *
 490  * Returns: parent of the object, this can be NULL if the pad has no
 491  *   parent. unref after usage.
 492  *
 493  * MT safe.
 494  */
 495 #define gst_pad_get_parent(pad) gst_object_get_parent (GST_OBJECT_CAST (pad))
 496
 497 GstPadDirection         gst_pad_get_direction                   (GstPad *pad);
 498
 499 gboolean                gst_pad_set_active                      (GstPad *pad, gboolean active);
 500 gboolean                gst_pad_is_active                       (GstPad *pad);
 501 gboolean                gst_pad_activate_pull                   (GstPad *pad, gboolean active);
 502 gboolean                gst_pad_activate_push                   (GstPad *pad, gboolean active);
 503
 504 gboolean                gst_pad_set_blocked                     (GstPad *pad, gboolean blocked);
 505 gboolean                gst_pad_set_blocked_async               (GstPad *pad, gboolean blocked,
 506                                                                  GstPadBlockCallback callback, gpointer user_data);
 507 gboolean                gst_pad_is_blocked                      (GstPad *pad);
 508
 509 void                    gst_pad_set_element_private             (GstPad *pad, gpointer priv);
 510 gpointer                gst_pad_get_element_private             (GstPad *pad);
 511
 512 GstPadTemplate*         gst_pad_get_pad_template                (GstPad *pad);
 513
 514 void                    gst_pad_set_bufferalloc_function        (GstPad *pad, GstPadBufferAllocFunction bufalloc);
 515 GstFlowReturn           gst_pad_alloc_buffer                    (GstPad *pad, guint64 offset, gint size,
 516                                                                  GstCaps *caps, GstBuffer **buf);
 517
 518 /* data passing setup functions */
 519 void                    gst_pad_set_activate_function           (GstPad *pad, GstPadActivateFunction activate);
 520 void                    gst_pad_set_activatepull_function       (GstPad *pad, GstPadActivateModeFunction activatepull);
 521 void                    gst_pad_set_activatepush_function       (GstPad *pad, GstPadActivateModeFunction activatepush);
 522 void                    gst_pad_set_chain_function              (GstPad *pad, GstPadChainFunction chain);
 523 void                    gst_pad_set_getrange_function           (GstPad *pad, GstPadGetRangeFunction get);
 524 void                    gst_pad_set_checkgetrange_function      (GstPad *pad, GstPadCheckGetRangeFunction check);
 525 void                    gst_pad_set_event_function              (GstPad *pad, GstPadEventFunction event);
 526
 527 /* pad links */
 528 void                    gst_pad_set_link_function               (GstPad *pad, GstPadLinkFunction link);
 529 void                    gst_pad_set_unlink_function             (GstPad *pad, GstPadUnlinkFunction unlink);
 530
 531 GstPadLinkReturn        gst_pad_link                            (GstPad *srcpad, GstPad *sinkpad);
 532 gboolean                gst_pad_unlink                          (GstPad *srcpad, GstPad *sinkpad);
 533 gboolean                gst_pad_is_linked                       (GstPad *pad);
 534
 535 GstPad*                 gst_pad_get_peer                        (GstPad *pad);
 536
 537 /* capsnego functions */
 538 void                    gst_pad_set_getcaps_function            (GstPad *pad, GstPadGetCapsFunction getcaps);
 539 void                    gst_pad_set_acceptcaps_function         (GstPad *pad, GstPadAcceptCapsFunction acceptcaps);
 540 void                    gst_pad_set_fixatecaps_function         (GstPad *pad, GstPadFixateCapsFunction fixatecaps);
 541 void                    gst_pad_set_setcaps_function            (GstPad *pad, GstPadSetCapsFunction setcaps);
 542
 543 G_CONST_RETURN GstCaps* gst_pad_get_pad_template_caps           (GstPad *pad);
 544
 545 /* capsnego function for connected/unconnected pads */
 546 GstCaps *               gst_pad_get_caps                        (GstPad * pad);
 547 void                    gst_pad_fixate_caps                     (GstPad * pad, GstCaps *caps);
 548 gboolean                gst_pad_accept_caps                     (GstPad * pad, GstCaps *caps);
 549 gboolean                gst_pad_set_caps                        (GstPad * pad, GstCaps *caps);
 550
 551 GstCaps *               gst_pad_peer_get_caps                   (GstPad * pad);
 552 gboolean                gst_pad_peer_accept_caps                (GstPad * pad, GstCaps *caps);
 553
 554 /* capsnego for connected pads */
 555 GstCaps *               gst_pad_get_allowed_caps                (GstPad * srcpad);
 556 GstCaps *               gst_pad_get_negotiated_caps             (GstPad * pad);
 557
 558 /* data passing functions to peer */
 559 GstFlowReturn           gst_pad_push                            (GstPad *pad, GstBuffer *buffer);
 560 gboolean                gst_pad_check_pull_range                (GstPad *pad);
 561 GstFlowReturn           gst_pad_pull_range                      (GstPad *pad, guint64 offset, guint size,
 562                                                                  GstBuffer **buffer);
 563 gboolean                gst_pad_push_event                      (GstPad *pad, GstEvent *event);
 564 gboolean                gst_pad_event_default                   (GstPad *pad, GstEvent *event);
 565
 566 /* data passing functions on pad */
 567 GstFlowReturn           gst_pad_chain                           (GstPad *pad, GstBuffer *buffer);
 568 GstFlowReturn           gst_pad_get_range                       (GstPad *pad, guint64 offset, guint size,
 569                                                                  GstBuffer **buffer);
 570 gboolean                gst_pad_send_event                      (GstPad *pad, GstEvent *event);
 571
 572 /* pad tasks */
 573 gboolean                gst_pad_start_task                      (GstPad *pad, GstTaskFunction func,
 574                                                                  gpointer data);
 575 gboolean                gst_pad_pause_task                      (GstPad *pad);
 576 gboolean                gst_pad_stop_task                       (GstPad *pad);
 577
 578 /* internal links */
 579 void                    gst_pad_set_internal_link_function      (GstPad *pad, GstPadIntLinkFunction intlink);
 580 GList*                  gst_pad_get_internal_links              (GstPad *pad);
 581 GList*                  gst_pad_get_internal_links_default      (GstPad *pad);
 582
 583 /* generic query function */
 584 void                    gst_pad_set_query_type_function         (GstPad *pad, GstPadQueryTypeFunction type_func);
 585 G_CONST_RETURN GstQueryType*
 586                         gst_pad_get_query_types                 (GstPad *pad);
 587 G_CONST_RETURN GstQueryType*
 588                         gst_pad_get_query_types_default         (GstPad *pad);
 589
 590 gboolean                gst_pad_query                           (GstPad *pad, GstQuery *query);
 591 void                    gst_pad_set_query_function              (GstPad *pad, GstPadQueryFunction query);
 592 gboolean                gst_pad_query_default                   (GstPad *pad, GstQuery *query);
 593
 594 /* misc helper functions */
 595 gboolean                gst_pad_dispatcher                      (GstPad *pad, GstPadDispatcherFunction dispatch,
 596                                                                  gpointer data);
 597
 598 #ifndef GST_DISABLE_LOADSAVE
 599 void                    gst_pad_load_and_link                   (xmlNodePtr self, GstObject *parent);
 600 #endif
 601
 602 G_END_DECLS
 603
 604 #endif /* __GST_PAD_H__ */