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/gstprobe.h>
  34 #include <gst/gstquery.h>
  35 #include <gst/gstqueryutils.h>
  36 #include <gst/gsttask.h>
  37
  38
  39 G_BEGIN_DECLS
  40
  41 GST_EXPORT GType _gst_pad_type;
  42
  43 /*
  44  * Pad base class
  45  */
  46 #define GST_TYPE_PAD                    (_gst_pad_type)
  47 #define GST_IS_PAD(obj)                 (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PAD))
  48 #define GST_IS_PAD_FAST(obj)            (G_OBJECT_TYPE(obj) == GST_TYPE_PAD) /* necessary? */
  49 #define GST_IS_PAD_CLASS(klass)         (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PAD))
  50 #define GST_PAD(obj)                    (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PAD, GstPad))
  51 #define GST_PAD_CLASS(klass)            (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PAD, GstPadClass))
  52 #define GST_PAD_CAST(obj)               ((GstPad*)(obj))
  53
  54
  55 /* why are these in gsttypes, again? */
  56 /*typedef struct _GstPad GstPad;*/
  57 /*typedef struct _GstPadClass GstPadClass;*/
  58 /*typedef struct _GstPadTemplate GstPadTemplate;*/
  59 /*typedef struct _GstPadTemplateClass GstPadTemplateClass;*/
  60 typedef struct _GstStaticPadTemplate GstStaticPadTemplate;
  61
  62 typedef enum {
  63   GST_PAD_LINK_NOSCHED          = -5,   /* pads cannot cooperate in scheduling */
  64   GST_PAD_LINK_NOFORMAT         = -4,   /* pads do not have common format */
  65   GST_PAD_LINK_REFUSED          = -3,   /* refused for some reason */
  66   GST_PAD_LINK_WRONG_DIRECTION  = -2,   /* pads have wrong direction */
  67   GST_PAD_LINK_WAS_LINKED       = -1,   /* pad was already linked */
  68   GST_PAD_LINK_OK               =  0,   /* link ok */
  69 } GstPadLinkReturn;
  70
  71 #define GST_PAD_LINK_FAILED(ret) ((ret) < GST_PAD_LINK_OK)
  72 #define GST_PAD_LINK_SUCCESSFUL(ret) ((ret) >= GST_PAD_LINK_OK)
  73
  74 typedef enum {
  75   GST_FLOW_OK             =  0,         /* data passing was ok */
  76   GST_FLOW_RESEND         =  1,         /* resend buffer, possibly with new caps */
  77   GST_FLOW_ERROR          = -1,         /* some (fatal) error occured */
  78   GST_FLOW_NOT_CONNECTED  = -2,         /* pad is not connected */
  79   GST_FLOW_NOT_NEGOTIATED = -3,         /* pad is not negotiated */
  80   GST_FLOW_WRONG_STATE    = -4,         /* pad is in wrong state */
  81   GST_FLOW_UNEXPECTED     = -5,         /* did not expect anything, this is not fatal */
  82   GST_FLOW_NOT_SUPPORTED  = -6          /* function not supported */
  83 } GstFlowReturn;
  84
  85 typedef enum {
  86   GST_ACTIVATE_NONE,
  87   GST_ACTIVATE_PUSH,
  88   GST_ACTIVATE_PULL,
  89 } GstActivateMode;
  90
  91 #define GST_PAD_MODE_ACTIVATE(mode) ((mode) != GST_ACTIVATE_NONE)
  92
  93 /* pad states */
  94 typedef gboolean                (*GstPadActivateFunction)       (GstPad *pad);
  95 typedef gboolean                (*GstPadActivateModeFunction)   (GstPad *pad, gboolean active);
  96
  97 /* data passing */
  98 typedef GstFlowReturn           (*GstPadChainFunction)          (GstPad *pad, GstBuffer *buffer);
  99 typedef GstFlowReturn           (*GstPadGetRangeFunction)       (GstPad *pad, guint64 offset,
 100                                                                  guint length, GstBuffer **buffer);
 101 typedef gboolean                (*GstPadEventFunction)          (GstPad *pad, GstEvent *event);
 102
 103 /* deprecate me, check range should use seeking query, loop function is internal */
 104 typedef gboolean                (*GstPadCheckGetRangeFunction)  (GstPad *pad);
 105 typedef void                    (*GstPadLoopFunction)           (GstPad *pad);
 106
 107 /* internal links */
 108 typedef GList*                  (*GstPadIntLinkFunction)        (GstPad *pad);
 109
 110 /* generic query function */
 111 typedef const GstQueryType*     (*GstPadQueryTypeFunction)      (GstPad *pad);
 112 typedef gboolean                (*GstPadQueryFunction)          (GstPad *pad, GstQuery *query);
 113
 114 /* linking */
 115 typedef GstPadLinkReturn        (*GstPadLinkFunction)           (GstPad *pad, GstPad *peer);
 116 typedef void                    (*GstPadUnlinkFunction)         (GstPad *pad);
 117
 118 /* caps nego */
 119 typedef GstCaps*                (*GstPadGetCapsFunction)        (GstPad *pad);
 120 typedef gboolean                (*GstPadSetCapsFunction)        (GstPad *pad, GstCaps *caps);
 121 typedef gboolean                (*GstPadAcceptCapsFunction)     (GstPad *pad, GstCaps *caps);
 122 typedef GstCaps*                (*GstPadFixateCapsFunction)     (GstPad *pad, GstCaps *caps);
 123 typedef GstFlowReturn           (*GstPadBufferAllocFunction)    (GstPad *pad, guint64 offset, guint size,
 124                                                                  GstCaps *caps, GstBuffer **buf);
 125 /* misc */
 126 typedef gboolean                (*GstPadDispatcherFunction)     (GstPad *pad, gpointer data);
 127
 128 typedef void                    (*GstPadBlockCallback)          (GstPad *pad, gboolean blocked, gpointer user_data);
 129
 130 typedef enum {
 131   GST_PAD_UNKNOWN,
 132   GST_PAD_SRC,
 133   GST_PAD_SINK
 134 } GstPadDirection;
 135
 136 typedef enum {
 137   GST_PAD_BLOCKED               = GST_OBJECT_FLAG_LAST,
 138   GST_PAD_FLUSHING,
 139   GST_PAD_IN_GETCAPS,
 140   GST_PAD_IN_SETCAPS,
 141
 142   GST_PAD_FLAG_LAST             = GST_OBJECT_FLAG_LAST + 8
 143 } GstPadFlags;
 144
 145 struct _GstPad {
 146   GstObject                     object;
 147
 148   gpointer                      element_private;
 149
 150   GstPadTemplate                *padtemplate;
 151
 152   /* direction cannot change after creating the pad */
 153   GstPadDirection                direction;
 154
 155   /*< public >*/ /* with STREAM_LOCK */
 156   /* streaming rec_lock */
 157   GStaticRecMutex               *stream_rec_lock;
 158   GstTask                       *task;
 159   /*< public >*/ /* with PREROLL_LOCK */
 160   GMutex                        *preroll_lock;
 161   GCond                         *preroll_cond;
 162
 163   /*< public >*/ /* with LOCK */
 164   /* block cond, mutex is from the object */
 165   GCond                         *block_cond;
 166   GstPadBlockCallback            block_callback;
 167   gpointer                       block_data;
 168
 169   /* the pad capabilities */
 170   GstCaps                       *caps;
 171   GstPadGetCapsFunction         getcapsfunc;
 172   GstPadSetCapsFunction         setcapsfunc;
 173   GstPadAcceptCapsFunction       acceptcapsfunc;
 174   GstPadFixateCapsFunction       fixatecapsfunc;
 175
 176   GstPadActivateFunction         activatefunc;
 177   GstPadActivateModeFunction     activatepushfunc;
 178   GstPadActivateModeFunction     activatepullfunc;
 179
 180   /* pad link */
 181   GstPadLinkFunction             linkfunc;
 182   GstPadUnlinkFunction           unlinkfunc;
 183   GstPad                        *peer;
 184
 185   gpointer                       sched_private;
 186
 187   /* data transport functions */
 188   GstPadLoopFunction             loopfunc;
 189   GstPadChainFunction            chainfunc;
 190   GstPadCheckGetRangeFunction    checkgetrangefunc;
 191   GstPadGetRangeFunction         getrangefunc;
 192   GstPadEventFunction            eventfunc;
 193
 194   GstActivateMode                mode;
 195
 196   /* generic query method */
 197   GstPadQueryTypeFunction        querytypefunc;
 198   GstPadQueryFunction            queryfunc;
 199
 200   /* internal links */
 201   GstPadIntLinkFunction          intlinkfunc;
 202
 203   GstPadBufferAllocFunction      bufferallocfunc;
 204
 205   GstProbeDispatcher            probedisp;
 206
 207   /*< private >*/
 208   gpointer _gst_reserved[GST_PADDING];
 209 };
 210
 211 struct _GstPadClass {
 212   GstObjectClass        parent_class;
 213
 214   /* signal callbacks */
 215   void          (*linked)               (GstPad *pad, GstPad *peer);
 216   void          (*unlinked)             (GstPad *pad, GstPad *peer);
 217   void          (*request_link)         (GstPad *pad);
 218
 219   /*< private >*/
 220   gpointer _gst_reserved[GST_PADDING];
 221 };
 222
 223
 224 /***** helper macros *****/
 225 /* GstPad */
 226 #define GST_PAD_NAME(pad)               (GST_OBJECT_NAME(pad))
 227 #define GST_PAD_PARENT(pad)             (GST_ELEMENT_CAST(GST_OBJECT_PARENT(pad)))
 228 #define GST_PAD_ELEMENT_PRIVATE(pad)    (GST_PAD_CAST(pad)->element_private)
 229 #define GST_PAD_PAD_TEMPLATE(pad)       (GST_PAD_CAST(pad)->padtemplate)
 230 #define GST_PAD_DIRECTION(pad)          (GST_PAD_CAST(pad)->direction)
 231 #define GST_PAD_TASK(pad)               (GST_PAD_CAST(pad)->task)
 232 #define GST_PAD_ACTIVATE_MODE(pad)      (GST_PAD_CAST(pad)->mode)
 233
 234 #define GST_PAD_ACTIVATEFUNC(pad)       (GST_PAD_CAST(pad)->activatefunc)
 235 #define GST_PAD_ACTIVATEPUSHFUNC(pad)   (GST_PAD_CAST(pad)->activatepushfunc)
 236 #define GST_PAD_ACTIVATEPULLFUNC(pad)   (GST_PAD_CAST(pad)->activatepullfunc)
 237 #define GST_PAD_LOOPFUNC(pad)           (GST_PAD_CAST(pad)->loopfunc)
 238 #define GST_PAD_CHAINFUNC(pad)          (GST_PAD_CAST(pad)->chainfunc)
 239 #define GST_PAD_CHECKGETRANGEFUNC(pad)  (GST_PAD_CAST(pad)->checkgetrangefunc)
 240 #define GST_PAD_GETRANGEFUNC(pad)       (GST_PAD_CAST(pad)->getrangefunc)
 241 #define GST_PAD_EVENTFUNC(pad)          (GST_PAD_CAST(pad)->eventfunc)
 242 #define GST_PAD_QUERYTYPEFUNC(pad)      (GST_PAD_CAST(pad)->querytypefunc)
 243 #define GST_PAD_QUERYFUNC(pad)          (GST_PAD_CAST(pad)->queryfunc)
 244 #define GST_PAD_INTLINKFUNC(pad)        (GST_PAD_CAST(pad)->intlinkfunc)
 245
 246 #define GST_PAD_PEER(pad)               (GST_PAD_CAST(pad)->peer)
 247 #define GST_PAD_LINKFUNC(pad)           (GST_PAD_CAST(pad)->linkfunc)
 248 #define GST_PAD_UNLINKFUNC(pad)         (GST_PAD_CAST(pad)->unlinkfunc)
 249
 250 #define GST_PAD_CAPS(pad)               (GST_PAD_CAST(pad)->caps)
 251 #define GST_PAD_GETCAPSFUNC(pad)        (GST_PAD_CAST(pad)->getcapsfunc)
 252 #define GST_PAD_SETCAPSFUNC(pad)        (GST_PAD_CAST(pad)->setcapsfunc)
 253 #define GST_PAD_ACCEPTCAPSFUNC(pad)     (GST_PAD_CAST(pad)->acceptcapsfunc)
 254 #define GST_PAD_FIXATECAPSFUNC(pad)     (GST_PAD_CAST(pad)->fixatecapsfunc)
 255
 256 #define GST_PAD_BUFFERALLOCFUNC(pad)    (GST_PAD_CAST(pad)->bufferallocfunc)
 257
 258 #define GST_PAD_IS_LINKED(pad)          (GST_PAD_PEER(pad) != NULL)
 259 #define GST_PAD_IS_BLOCKED(pad) (GST_FLAG_IS_SET (pad, GST_PAD_BLOCKED))
 260 #define GST_PAD_IS_FLUSHING(pad)        (GST_FLAG_IS_SET (pad, GST_PAD_FLUSHING))
 261 #define GST_PAD_IS_IN_GETCAPS(pad)      (GST_FLAG_IS_SET (pad, GST_PAD_IN_GETCAPS))
 262 #define GST_PAD_IS_IN_SETCAPS(pad)      (GST_FLAG_IS_SET (pad, GST_PAD_IN_SETCAPS))
 263 #define GST_PAD_IS_USABLE(pad)          (GST_PAD_IS_LINKED (pad) && \
 264                                          !GST_PAD_IS_FLUSHING(pad) && !GST_PAD_IS_FLUSHING(GST_PAD_PEER (pad)))
 265 #define GST_PAD_IS_SRC(pad)             (GST_PAD_DIRECTION(pad) == GST_PAD_SRC)
 266 #define GST_PAD_IS_SINK(pad)            (GST_PAD_DIRECTION(pad) == GST_PAD_SINK)
 267
 268 #define GST_PAD_SET_FLUSHING(pad)       (GST_FLAG_SET (pad, GST_PAD_FLUSHING))
 269 #define GST_PAD_UNSET_FLUSHING(pad)     (GST_FLAG_UNSET (pad, GST_PAD_FLUSHING))
 270
 271 #define GST_STREAM_GET_LOCK(pad)        (GST_PAD_CAST(pad)->stream_rec_lock)
 272 #define GST_STREAM_LOCK(pad)            (g_static_rec_mutex_lock(GST_STREAM_GET_LOCK(pad)))
 273 #define GST_STREAM_TRYLOCK(pad)         (g_static_rec_mutex_trylock(GST_STREAM_GET_LOCK(pad)))
 274 #define GST_STREAM_UNLOCK(pad)          (g_static_rec_mutex_unlock(GST_STREAM_GET_LOCK(pad)))
 275 #define GST_STREAM_UNLOCK_FULL(pad)     (g_static_rec_mutex_unlock_full(GST_STREAM_GET_LOCK(pad)))
 276 #define GST_STREAM_LOCK_FULL(pad,t)     (g_static_rec_mutex_lock_full(GST_STREAM_GET_LOCK(pad), t))
 277
 278 #define GST_PREROLL_GET_LOCK(pad)       (GST_PAD_CAST(pad)->preroll_lock)
 279 #define GST_PREROLL_LOCK(pad)           (g_mutex_lock(GST_PREROLL_GET_LOCK(pad)))
 280 #define GST_PREROLL_TRYLOCK(pad)        (g_mutex_trylock(GST_PREROLL_GET_LOCK(pad)))
 281 #define GST_PREROLL_UNLOCK(pad)         (g_mutex_unlock(GST_PREROLL_GET_LOCK(pad)))
 282 #define GST_PREROLL_GET_COND(pad)       (GST_PAD_CAST(pad)->preroll_cond)
 283 #define GST_PREROLL_WAIT(pad)           g_cond_wait (GST_PREROLL_GET_COND (pad), GST_PREROLL_GET_LOCK (pad))
 284 #define GST_PREROLL_TIMED_WAIT(pad, timeval) g_cond_timed_wait (GST_PREROLL_GET_COND (pad), GST_PREROLL_GET_LOCK (pad),\
 285                                              timeval)
 286 #define GST_PREROLL_SIGNAL(pad)         g_cond_signal (GST_PREROLL_GET_COND (pad));
 287 #define GST_PREROLL_BROADCAST(pad)      g_cond_broadcast (GST_PREROLL_GET_COND (pad));
 288
 289 #define GST_PAD_BLOCK_GET_COND(pad)     (GST_PAD_CAST(pad)->block_cond)
 290 #define GST_PAD_BLOCK_WAIT(pad)         (g_cond_wait(GST_PAD_BLOCK_GET_COND (pad), GST_GET_LOCK (pad)))
 291 #define GST_PAD_BLOCK_SIGNAL(pad)       (g_cond_signal(GST_PAD_BLOCK_GET_COND (pad)))
 292
 293 /***** PadTemplate *****/
 294 #define GST_TYPE_PAD_TEMPLATE           (gst_pad_template_get_type ())
 295 #define GST_PAD_TEMPLATE(obj)           (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PAD_TEMPLATE,GstPadTemplate))
 296 #define GST_PAD_TEMPLATE_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PAD_TEMPLATE,GstPadTemplateClass))
 297 #define GST_IS_PAD_TEMPLATE(obj)        (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PAD_TEMPLATE))
 298 #define GST_IS_PAD_TEMPLATE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PAD_TEMPLATE))
 299
 300 typedef enum {
 301   GST_PAD_ALWAYS,
 302   GST_PAD_SOMETIMES,
 303   GST_PAD_REQUEST
 304 } GstPadPresence;
 305
 306 #define GST_PAD_TEMPLATE_NAME_TEMPLATE(templ)   (((GstPadTemplate *)(templ))->name_template)
 307 #define GST_PAD_TEMPLATE_DIRECTION(templ)       (((GstPadTemplate *)(templ))->direction)
 308 #define GST_PAD_TEMPLATE_PRESENCE(templ)        (((GstPadTemplate *)(templ))->presence)
 309 #define GST_PAD_TEMPLATE_CAPS(templ)            (((GstPadTemplate *)(templ))->caps)
 310
 311 typedef enum {
 312   GST_PAD_TEMPLATE_FIXED        = GST_OBJECT_FLAG_LAST,
 313
 314   GST_PAD_TEMPLATE_FLAG_LAST    = GST_OBJECT_FLAG_LAST + 4
 315 } GstPadTemplateFlags;
 316
 317 #define GST_PAD_TEMPLATE_IS_FIXED(templ)        (GST_FLAG_IS_SET(templ, GST_PAD_TEMPLATE_FIXED))
 318
 319 struct _GstPadTemplate {
 320   GstObject        object;
 321
 322   gchar           *name_template;
 323   GstPadDirection  direction;
 324   GstPadPresence   presence;
 325   GstCaps         *caps;
 326
 327   gpointer _gst_reserved[GST_PADDING];
 328 };
 329
 330 struct _GstPadTemplateClass {
 331   GstObjectClass   parent_class;
 332
 333   /* signal callbacks */
 334   void (*pad_created)   (GstPadTemplate *templ, GstPad *pad);
 335
 336   gpointer _gst_reserved[GST_PADDING];
 337 };
 338
 339 struct _GstStaticPadTemplate {
 340   gchar           *name_template;
 341   GstPadDirection  direction;
 342   GstPadPresence   presence;
 343   GstStaticCaps   static_caps;
 344 };
 345
 346 #define GST_STATIC_PAD_TEMPLATE(padname, dir, pres, caps) \
 347   { \
 348   /* name_template */    padname, \
 349   /* direction */        dir, \
 350   /* presence */         pres, \
 351   /* caps */             caps \
 352   }
 353
 354
 355 GType                   gst_pad_get_type                        (void);
 356
 357 /* creating pads */
 358 GstPad*                 gst_pad_new                             (const gchar *name, GstPadDirection direction);
 359 GstPad*                 gst_pad_new_from_template               (GstPadTemplate *templ, const gchar *name);
 360
 361 #define gst_pad_get_name(pad) gst_object_get_name (GST_OBJECT_CAST (pad))
 362 GstElement*             gst_pad_get_parent                      (GstPad *pad);
 363
 364 GstPadDirection         gst_pad_get_direction                   (GstPad *pad);
 365
 366 gboolean                gst_pad_set_active                      (GstPad *pad, gboolean active);
 367 gboolean                gst_pad_is_active                       (GstPad *pad);
 368 gboolean                gst_pad_activate_pull                   (GstPad *pad, gboolean active);
 369 gboolean                gst_pad_activate_push                   (GstPad *pad, gboolean active);
 370
 371 gboolean                gst_pad_set_blocked                     (GstPad *pad, gboolean blocked);
 372 gboolean                gst_pad_set_blocked_async               (GstPad *pad, gboolean blocked,
 373                                                                  GstPadBlockCallback callback, gpointer user_data);
 374 gboolean                gst_pad_is_blocked                      (GstPad *pad);
 375
 376 void                    gst_pad_set_element_private             (GstPad *pad, gpointer priv);
 377 gpointer                gst_pad_get_element_private             (GstPad *pad);
 378
 379 GstPadTemplate*         gst_pad_get_pad_template                (GstPad *pad);
 380
 381 void                    gst_pad_set_bufferalloc_function        (GstPad *pad, GstPadBufferAllocFunction bufalloc);
 382 GstFlowReturn           gst_pad_alloc_buffer                    (GstPad *pad, guint64 offset, gint size,
 383                                                                  GstCaps *caps, GstBuffer **buf);
 384
 385 /* data passing setup functions */
 386 void                    gst_pad_set_activate_function           (GstPad *pad, GstPadActivateFunction activate);
 387 void                    gst_pad_set_activatepull_function       (GstPad *pad, GstPadActivateModeFunction activatepull);
 388 void                    gst_pad_set_activatepush_function       (GstPad *pad, GstPadActivateModeFunction activatepush);
 389 void                    gst_pad_set_loop_function               (GstPad *pad, GstPadLoopFunction loop);
 390 void                    gst_pad_set_chain_function              (GstPad *pad, GstPadChainFunction chain);
 391 void                    gst_pad_set_getrange_function           (GstPad *pad, GstPadGetRangeFunction get);
 392 void                    gst_pad_set_checkgetrange_function      (GstPad *pad, GstPadCheckGetRangeFunction check);
 393 void                    gst_pad_set_event_function              (GstPad *pad, GstPadEventFunction event);
 394
 395 /* pad links */
 396 void                    gst_pad_set_link_function               (GstPad *pad, GstPadLinkFunction link);
 397 void                    gst_pad_set_unlink_function             (GstPad *pad, GstPadUnlinkFunction unlink);
 398
 399 GstPadLinkReturn        gst_pad_link                            (GstPad *srcpad, GstPad *sinkpad);
 400 gboolean                gst_pad_unlink                          (GstPad *srcpad, GstPad *sinkpad);
 401 gboolean                gst_pad_is_linked                       (GstPad *pad);
 402
 403 GstPad*                 gst_pad_get_peer                        (GstPad *pad);
 404
 405 /* capsnego functions */
 406 void                    gst_pad_set_getcaps_function            (GstPad *pad, GstPadGetCapsFunction getcaps);
 407 void                    gst_pad_set_acceptcaps_function         (GstPad *pad, GstPadAcceptCapsFunction acceptcaps);
 408 void                    gst_pad_set_fixatecaps_function         (GstPad *pad, GstPadFixateCapsFunction fixatecaps);
 409 void                    gst_pad_set_setcaps_function            (GstPad *pad, GstPadSetCapsFunction setcaps);
 410
 411 G_CONST_RETURN GstCaps* gst_pad_get_pad_template_caps           (GstPad *pad);
 412
 413 /* capsnego function for connected/unconnected pads */
 414 GstCaps *               gst_pad_get_caps                        (GstPad * pad);
 415 GstCaps*                gst_pad_fixate_caps                     (GstPad * pad, GstCaps *caps);
 416 gboolean                gst_pad_accept_caps                     (GstPad * pad, GstCaps *caps);
 417 gboolean                gst_pad_set_caps                        (GstPad * pad, GstCaps *caps);
 418
 419 GstCaps *               gst_pad_peer_get_caps                   (GstPad * pad);
 420 gboolean                gst_pad_peer_accept_caps                (GstPad * pad, GstCaps *caps);
 421
 422 /* capsnego for connected pads */
 423 GstCaps *               gst_pad_get_allowed_caps                (GstPad * srcpad);
 424 GstCaps *               gst_pad_get_negotiated_caps             (GstPad * pad);
 425
 426 /* data passing functions to peer */
 427 GstFlowReturn           gst_pad_push                            (GstPad *pad, GstBuffer *buffer);
 428 gboolean                gst_pad_check_pull_range                (GstPad *pad);
 429 GstFlowReturn           gst_pad_pull_range                      (GstPad *pad, guint64 offset, guint size,
 430                                                                  GstBuffer **buffer);
 431 gboolean                gst_pad_push_event                      (GstPad *pad, GstEvent *event);
 432 gboolean                gst_pad_event_default                   (GstPad *pad, GstEvent *event);
 433
 434 /* data passing functions on pad */
 435 GstFlowReturn           gst_pad_chain                           (GstPad *pad, GstBuffer *buffer);
 436 GstFlowReturn           gst_pad_get_range                       (GstPad *pad, guint64 offset, guint size,
 437                                                                  GstBuffer **buffer);
 438 gboolean                gst_pad_send_event                      (GstPad *pad, GstEvent *event);
 439
 440 /* pad tasks */
 441 gboolean                gst_pad_start_task                      (GstPad *pad, GstTaskFunction func,
 442                                                                  gpointer data);
 443 gboolean                gst_pad_pause_task                      (GstPad *pad);
 444 gboolean                gst_pad_stop_task                       (GstPad *pad);
 445
 446 /* internal links */
 447 void                    gst_pad_set_internal_link_function      (GstPad *pad, GstPadIntLinkFunction intlink);
 448 GList*                  gst_pad_get_internal_links              (GstPad *pad);
 449 GList*                  gst_pad_get_internal_links_default      (GstPad *pad);
 450
 451 /* generic query function */
 452 void                    gst_pad_set_query_type_function         (GstPad *pad, GstPadQueryTypeFunction type_func);
 453 G_CONST_RETURN GstQueryType*
 454                         gst_pad_get_query_types                 (GstPad *pad);
 455 G_CONST_RETURN GstQueryType*
 456                         gst_pad_get_query_types_default         (GstPad *pad);
 457
 458 gboolean                gst_pad_query                           (GstPad *pad, GstQuery *query);
 459 void                    gst_pad_set_query_function              (GstPad *pad, GstPadQueryFunction query);
 460 gboolean                gst_pad_query_default                   (GstPad *pad, GstQuery *query);
 461
 462 /* misc helper functions */
 463 gboolean                gst_pad_dispatcher                      (GstPad *pad, GstPadDispatcherFunction dispatch,
 464                                                                  gpointer data);
 465 /* probes */
 466 #define                 gst_pad_add_probe(pad, probe) \
 467                         (gst_probe_dispatcher_add_probe (&(GST_PAD_CAST (pad)->probedisp), probe))
 468 #define                 gst_pad_remove_probe(pad, probe) \
 469                         (gst_probe_dispatcher_remove_probe (&(GST_PAD_CAST (pad)->probedisp), probe))
 470
 471 #ifndef GST_DISABLE_LOADSAVE
 472 void                    gst_pad_load_and_link                   (xmlNodePtr self, GstObject *parent);
 473 #endif
 474
 475
 476 /* templates and factories */
 477 GType                   gst_pad_template_get_type               (void);
 478
 479 GstPadTemplate*         gst_pad_template_new                    (const gchar *name_template,
 480                                                                  GstPadDirection direction, GstPadPresence presence,
 481                                                                  GstCaps *caps);
 482
 483 GstPadTemplate *        gst_static_pad_template_get             (GstStaticPadTemplate *pad_template);
 484 GstCaps*                gst_static_pad_template_get_caps        (GstStaticPadTemplate *templ);
 485 GstCaps*                gst_pad_template_get_caps               (GstPadTemplate *templ);
 486
 487
 488 G_END_DECLS
 489
 490 #endif /* __GST_PAD_H__ */