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
  36
  37 G_BEGIN_DECLS
  38
  39 GST_EXPORT GType _gst_pad_type;
  40 GST_EXPORT GType _gst_real_pad_type;
  41 GST_EXPORT GType _gst_ghost_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_REAL_PAD || \
  49                                          G_OBJECT_TYPE(obj) == GST_TYPE_GHOST_PAD)
  50 #define GST_IS_PAD_CLASS(klass)         (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PAD))
  51 #define GST_PAD(obj)                    (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PAD, GstPad))
  52 #define GST_PAD_CLASS(klass)            (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PAD, GstPadClass))
  53
  54 /*
  55  * Real Pads
  56  */
  57 #define GST_TYPE_REAL_PAD               (_gst_real_pad_type)
  58 #define GST_IS_REAL_PAD(obj)            (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_REAL_PAD))
  59 #define GST_IS_REAL_PAD_FAST(obj)       (G_OBJECT_TYPE(obj) == GST_TYPE_REAL_PAD)
  60 #define GST_IS_REAL_PAD_CLASS(klass)    (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_REAL_PAD))
  61 #define GST_REAL_PAD(obj)               (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_REAL_PAD, GstRealPad))
  62 #define GST_REAL_PAD_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_REAL_PAD, GstRealPadClass))
  63
  64 /*
  65  * Ghost Pads
  66  */
  67 #define GST_TYPE_GHOST_PAD              (_gst_ghost_pad_type)
  68 #define GST_IS_GHOST_PAD(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_GHOST_PAD))
  69 #define GST_IS_GHOST_PAD_FAST(obj)      (G_OBJECT_TYPE(obj) == GST_TYPE_GHOST_PAD)
  70 #define GST_IS_GHOST_PAD_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_GHOST_PAD))
  71 #define GST_GHOST_PAD(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_GHOST_PAD, GstGhostPad))
  72 #define GST_GHOST_PAD_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_GHOST_PAD, GstGhostPadClass))
  73
  74
  75 /*typedef struct _GstPad GstPad; */
  76 /*typedef struct _GstPadClass GstPadClass;*/
  77 typedef struct _GstRealPad GstRealPad;
  78 typedef struct _GstRealPadClass GstRealPadClass;
  79 typedef struct _GstGhostPad GstGhostPad;
  80 typedef struct _GstGhostPadClass GstGhostPadClass;
  81 /*typedef struct _GstPadTemplate GstPadTemplate;*/
  82 /*typedef struct _GstPadTemplateClass GstPadTemplateClass;*/
  83 typedef struct _GstStaticPadTemplate GstStaticPadTemplate;
  84 typedef struct _GstPadLink GstPadLink;
  85
  86 typedef enum {
  87   GST_PAD_LINK_REFUSED = -1,
  88   GST_PAD_LINK_DELAYED =  0,
  89   GST_PAD_LINK_OK      =  1,
  90   GST_PAD_LINK_DONE    =  2
  91 } GstPadLinkReturn;
  92
  93 #define GST_PAD_LINK_FAILED(ret) (ret < GST_PAD_LINK_OK)
  94 #define GST_PAD_LINK_SUCCESSFUL(ret) (ret >= GST_PAD_LINK_OK)
  95
  96 /* convenience functions */
  97 #ifndef GST_DISABLE_DEPRECATED
  98 #ifdef G_HAVE_ISO_VARARGS
  99 #define GST_PAD_QUERY_TYPE_FUNCTION(functionname, ...)  GST_QUERY_TYPE_FUNCTION (GstPad *, functionname, __VA_ARGS__);
 100 #define GST_PAD_FORMATS_FUNCTION(functionname, ...)     GST_FORMATS_FUNCTION (GstPad *, functionname, __VA_ARGS__);
 101 #define GST_PAD_EVENT_MASK_FUNCTION(functionname, ...)  GST_EVENT_MASK_FUNCTION (GstPad *, functionname, __VA_ARGS__);
 102 #elif defined(G_HAVE_GNUC_VARARGS)
 103 #define GST_PAD_QUERY_TYPE_FUNCTION(functionname, a...) GST_QUERY_TYPE_FUNCTION (GstPad *, functionname, a);
 104 #define GST_PAD_FORMATS_FUNCTION(functionname, a...)    GST_FORMATS_FUNCTION (GstPad *, functionname, a);
 105 #define GST_PAD_EVENT_MASK_FUNCTION(functionname, a...) GST_EVENT_MASK_FUNCTION (GstPad *, functionname, a);
 106 #endif
 107 #endif
 108
 109
 110 /* this defines the functions used to chain buffers
 111  * pad is the sink pad (so the same chain function can be used for N pads)
 112  * buf is the buffer being passed */
 113 typedef void                    (*GstPadChainFunction)          (GstPad *pad,GstData *data);
 114 typedef GstData*                (*GstPadGetFunction)            (GstPad *pad);
 115 typedef gboolean                (*GstPadEventFunction)          (GstPad *pad, GstEvent *event);
 116 typedef gboolean                (*GstPadConvertFunction)        (GstPad *pad,
 117                                                                  GstFormat src_format,  gint64  src_value,
 118                                                                  GstFormat *dest_format, gint64 *dest_value);
 119 typedef gboolean                (*GstPadQueryFunction)          (GstPad *pad, GstQueryType type,
 120                                                                  GstFormat *format, gint64  *value);
 121 typedef GList*                  (*GstPadIntLinkFunction)        (GstPad *pad);
 122 typedef const GstFormat*        (*GstPadFormatsFunction)        (GstPad *pad);
 123 typedef const GstEventMask*     (*GstPadEventMaskFunction)      (GstPad *pad);
 124 typedef const GstQueryType*     (*GstPadQueryTypeFunction)      (GstPad *pad);
 125
 126 typedef GstPadLinkReturn        (*GstPadLinkFunction)           (GstPad *pad, const GstCaps *caps);
 127 typedef void                    (*GstPadUnlinkFunction)         (GstPad *pad);
 128 typedef GstCaps*                (*GstPadGetCapsFunction)        (GstPad *pad);
 129 typedef GstCaps*                (*GstPadFixateFunction)         (GstPad *pad, const GstCaps *caps);
 130 typedef GstBuffer*              (*GstPadBufferAllocFunction)    (GstPad *pad, guint64 offset, guint size);
 131
 132 typedef gboolean                (*GstPadDispatcherFunction)     (GstPad *pad, gpointer data);
 133
 134 typedef enum {
 135   GST_PAD_UNKNOWN,
 136   GST_PAD_SRC,
 137   GST_PAD_SINK
 138 } GstPadDirection;
 139
 140 typedef enum {
 141   GST_PAD_DISABLED              = GST_OBJECT_FLAG_LAST,
 142   GST_PAD_NEGOTIATING,
 143   GST_PAD_DISPATCHING,
 144
 145   GST_PAD_FLAG_LAST             = GST_OBJECT_FLAG_LAST + 4
 146 } GstPadFlags;
 147
 148 struct _GstPad {
 149   GstObject             object;
 150
 151   gpointer              element_private;
 152
 153   GstPadTemplate        *padtemplate;   /* the template for this pad */
 154
 155   gpointer _gst_reserved[GST_PADDING];
 156 };
 157
 158 struct _GstPadClass {
 159   GstObjectClass parent_class;
 160
 161   gpointer _gst_reserved[GST_PADDING];
 162 };
 163
 164 struct _GstRealPad {
 165   GstPad                         pad;
 166
 167   /* the pad capabilities */
 168   GstCaps                       *caps;
 169   GstPadFixateFunction           appfixatefunc;
 170   GstCaps                       *appfilter;
 171   GstPadGetCapsFunction         getcapsfunc;
 172   GstPadFixateFunction           fixatefunc;
 173
 174   GstPadDirection                direction;
 175
 176   GstPadLinkFunction             linkfunc;
 177   GstPadUnlinkFunction           unlinkfunc;
 178   GstRealPad                    *peer;
 179
 180   gpointer                       sched_private;
 181
 182   /* data transport functions */
 183   GstPadChainFunction            chainfunc;
 184   GstPadChainFunction            chainhandler;
 185   GstPadGetFunction              getfunc;
 186   GstPadGetFunction              gethandler;
 187   GstPadEventFunction            eventfunc;
 188   GstPadEventFunction            eventhandler;
 189   GstPadEventMaskFunction        eventmaskfunc;
 190
 191   GList                         *ghostpads;
 192
 193   /* query/convert/formats functions */
 194   GstPadConvertFunction          convertfunc;
 195   GstPadQueryFunction            queryfunc;
 196   GstPadFormatsFunction          formatsfunc;
 197   GstPadQueryTypeFunction        querytypefunc;
 198   GstPadIntLinkFunction          intlinkfunc;
 199
 200   GstPadBufferAllocFunction        bufferallocfunc;
 201
 202   GstProbeDispatcher             probedisp;
 203
 204   GstPadLink                    *link;
 205   GstCaps                       *explicit_caps;
 206
 207   gpointer _gst_reserved[GST_PADDING];
 208 };
 209
 210 struct _GstRealPadClass {
 211   GstPadClass   parent_class;
 212
 213   /* signal callbacks */
 214   void          (*caps_nego_failed)     (GstPad *pad, GstCaps *caps);
 215
 216   void          (*linked)               (GstPad *pad, GstPad *peer);
 217   void          (*unlinked)             (GstPad *pad, GstPad *peer);
 218   GstPadFixateFunction           appfixatefunc;
 219
 220   gpointer _gst_reserved[GST_PADDING];
 221 };
 222
 223 struct _GstGhostPad {
 224   GstPad pad;
 225
 226   GstRealPad *realpad;
 227
 228   gpointer _gst_reserved[GST_PADDING];
 229 };
 230
 231 struct _GstGhostPadClass {
 232   GstPadClass parent_class;
 233
 234   gpointer _gst_reserved[GST_PADDING];
 235 };
 236
 237
 238 /***** helper macros *****/
 239 /* GstPad */
 240 #define GST_PAD_NAME(pad)               (GST_OBJECT_NAME(pad))
 241 #define GST_PAD_PARENT(pad)             ((GstElement *)(GST_OBJECT_PARENT(pad)))
 242 #define GST_PAD_ELEMENT_PRIVATE(pad)    (((GstPad *)(pad))->element_private)
 243 #define GST_PAD_PAD_TEMPLATE(pad)       (((GstPad *)(pad))->padtemplate)
 244
 245 /* GstRealPad */
 246 #define GST_RPAD_DIRECTION(pad)         (((GstRealPad *)(pad))->direction)
 247 #define GST_RPAD_CAPS(pad)              (((GstRealPad *)(pad))->caps)
 248 #define GST_RPAD_APPFILTER(pad)         (((GstRealPad *)(pad))->appfilter)
 249 #define GST_RPAD_PEER(pad)              (((GstRealPad *)(pad))->peer)
 250 #define GST_RPAD_CHAINFUNC(pad)         (((GstRealPad *)(pad))->chainfunc)
 251 #define GST_RPAD_CHAINHANDLER(pad)      (((GstRealPad *)(pad))->chainhandler)
 252 #define GST_RPAD_GETFUNC(pad)           (((GstRealPad *)(pad))->getfunc)
 253 #define GST_RPAD_GETHANDLER(pad)        (((GstRealPad *)(pad))->gethandler)
 254 #define GST_RPAD_EVENTFUNC(pad)         (((GstRealPad *)(pad))->eventfunc)
 255 #define GST_RPAD_EVENTHANDLER(pad)      (((GstRealPad *)(pad))->eventhandler)
 256 #define GST_RPAD_CONVERTFUNC(pad)       (((GstRealPad *)(pad))->convertfunc)
 257 #define GST_RPAD_QUERYFUNC(pad)         (((GstRealPad *)(pad))->queryfunc)
 258 #define GST_RPAD_INTLINKFUNC(pad)       (((GstRealPad *)(pad))->intlinkfunc)
 259 #define GST_RPAD_FORMATSFUNC(pad)       (((GstRealPad *)(pad))->formatsfunc)
 260 #define GST_RPAD_QUERYTYPEFUNC(pad)     (((GstRealPad *)(pad))->querytypefunc)
 261 #define GST_RPAD_EVENTMASKFUNC(pad)     (((GstRealPad *)(pad))->eventmaskfunc)
 262
 263 #define GST_RPAD_LINKFUNC(pad)          (((GstRealPad *)(pad))->linkfunc)
 264 #define GST_RPAD_UNLINKFUNC(pad)        (((GstRealPad *)(pad))->unlinkfunc)
 265 #define GST_RPAD_GETCAPSFUNC(pad)       (((GstRealPad *)(pad))->getcapsfunc)
 266 #define GST_RPAD_FIXATEFUNC(pad)        (((GstRealPad *)(pad))->fixatefunc)
 267 #define GST_RPAD_BUFFERALLOCFUNC(pad)   (((GstRealPad *)(pad))->bufferallocfunc)
 268 #define GST_RPAD_LINK(pad)              (((GstRealPad *)(pad))->link)
 269 #define GST_RPAD_EXPLICIT_CAPS(pad)     (((GstRealPad *)(pad))->explicit_caps)
 270
 271 /* GstGhostPad */
 272 #define GST_GPAD_REALPAD(pad)           (((GstGhostPad *)(pad))->realpad)
 273
 274 /* Generic */
 275 #define GST_PAD_REALIZE(pad)            (GST_IS_REAL_PAD(pad) ? ((GstRealPad *)(pad)) : GST_GPAD_REALPAD(pad))
 276 #define GST_PAD_DIRECTION(pad)          GST_RPAD_DIRECTION(GST_PAD_REALIZE(pad))
 277 #define GST_PAD_CAPS(pad)               (gst_pad_get_negotiated_caps(GST_PAD (pad)))
 278 #define GST_PAD_PEER(pad)               GST_PAD(GST_RPAD_PEER(GST_PAD_REALIZE(pad)))
 279
 280 /* Some check functions (unused?) */
 281 #define GST_PAD_IS_LINKED(pad)          (GST_PAD_PEER(pad) != NULL)
 282 #define GST_PAD_IS_ACTIVE(pad)          (!GST_FLAG_IS_SET(GST_PAD_REALIZE(pad), GST_PAD_DISABLED))
 283 #define GST_PAD_IS_NEGOTIATING(pad)     (GST_FLAG_IS_SET (pad, GST_PAD_NEGOTIATING))
 284 #define GST_PAD_IS_DISPATCHING(pad)     (GST_FLAG_IS_SET (pad, GST_PAD_DISPATCHING))
 285 #define GST_PAD_IS_USABLE(pad)          (GST_PAD_IS_LINKED (pad) && \
 286                                          GST_PAD_IS_ACTIVE(pad) && GST_PAD_IS_ACTIVE(GST_PAD_PEER (pad)))
 287 #define GST_PAD_CAN_PULL(pad)           (GST_IS_REAL_PAD(pad) && GST_REAL_PAD(pad)->gethandler != NULL)
 288 #define GST_PAD_IS_SRC(pad)             (GST_PAD_DIRECTION(pad) == GST_PAD_SRC)
 289 #define GST_PAD_IS_SINK(pad)            (GST_PAD_DIRECTION(pad) == GST_PAD_SINK)
 290
 291 /***** PadTemplate *****/
 292 #define GST_TYPE_PAD_TEMPLATE           (gst_pad_template_get_type ())
 293 #define GST_PAD_TEMPLATE(obj)           (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PAD_TEMPLATE,GstPadTemplate))
 294 #define GST_PAD_TEMPLATE_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PAD_TEMPLATE,GstPadTemplateClass))
 295 #define GST_IS_PAD_TEMPLATE(obj)        (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PAD_TEMPLATE))
 296 #define GST_IS_PAD_TEMPLATE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PAD_TEMPLATE))
 297
 298 typedef enum {
 299   GST_PAD_ALWAYS,
 300   GST_PAD_SOMETIMES,
 301   GST_PAD_REQUEST
 302 } GstPadPresence;
 303
 304 #define GST_PAD_TEMPLATE_NAME_TEMPLATE(templ)   (((GstPadTemplate *)(templ))->name_template)
 305 #define GST_PAD_TEMPLATE_DIRECTION(templ)       (((GstPadTemplate *)(templ))->direction)
 306 #define GST_PAD_TEMPLATE_PRESENCE(templ)        (((GstPadTemplate *)(templ))->presence)
 307 #define GST_PAD_TEMPLATE_CAPS(templ)            (((GstPadTemplate *)(templ))->caps)
 308
 309 typedef enum {
 310   GST_PAD_TEMPLATE_FIXED        = GST_OBJECT_FLAG_LAST,
 311
 312   GST_PAD_TEMPLATE_FLAG_LAST    = GST_OBJECT_FLAG_LAST + 4
 313 } GstPadTemplateFlags;
 314
 315 #define GST_PAD_TEMPLATE_IS_FIXED(templ)        (GST_FLAG_IS_SET(templ, GST_PAD_TEMPLATE_FIXED))
 316
 317 struct _GstPadTemplate {
 318   GstObject        object;
 319
 320   gchar           *name_template;
 321   GstPadDirection  direction;
 322   GstPadPresence   presence;
 323   GstCaps         *caps;
 324
 325   gpointer _gst_reserved[GST_PADDING];
 326 };
 327
 328 struct _GstPadTemplateClass {
 329   GstObjectClass   parent_class;
 330
 331   /* signal callbacks */
 332   void (*pad_created)   (GstPadTemplate *templ, GstPad *pad);
 333
 334   gpointer _gst_reserved[GST_PADDING];
 335 };
 336
 337 struct _GstStaticPadTemplate {
 338   gchar           *name_template;
 339   GstPadDirection  direction;
 340   GstPadPresence   presence;
 341   GstStaticCaps   static_caps;
 342 };
 343
 344 #define GST_STATIC_PAD_TEMPLATE(padname, dir, pres, caps) \
 345   { \
 346   /* name_template */    padname, \
 347   /* direction */        dir, \
 348   /* presence */         pres, \
 349   /* caps */             caps \
 350   }
 351
 352
 353 GType                   gst_pad_get_type                        (void);
 354 GType                   gst_real_pad_get_type                   (void);
 355 GType                   gst_ghost_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 GstPad*                 gst_pad_custom_new                      (GType type, const gchar *name, GstPadDirection direction);
 361 GstPad*                 gst_pad_custom_new_from_template        (GType type, GstPadTemplate *templ, const gchar *name);
 362
 363 void                    gst_pad_set_name                        (GstPad *pad, const gchar *name);
 364 G_CONST_RETURN gchar*   gst_pad_get_name                        (GstPad *pad);
 365
 366 GstPadDirection         gst_pad_get_direction                   (GstPad *pad);
 367
 368 void                    gst_pad_set_active                      (GstPad *pad, gboolean active);
 369 void                    gst_pad_set_active_recursive            (GstPad *pad, gboolean active);
 370 gboolean                gst_pad_is_active                       (GstPad *pad);
 371
 372 void                    gst_pad_set_element_private             (GstPad *pad, gpointer priv);
 373 gpointer                gst_pad_get_element_private             (GstPad *pad);
 374
 375 void                    gst_pad_set_parent                      (GstPad *pad, GstElement *parent);
 376 GstElement*             gst_pad_get_parent                      (GstPad *pad);
 377 GstElement*             gst_pad_get_real_parent                 (GstPad *pad);
 378
 379 GstScheduler*           gst_pad_get_scheduler                   (GstPad *pad);
 380
 381 void                    gst_pad_add_ghost_pad                   (GstPad *pad, GstPad *ghostpad);
 382 void                    gst_pad_remove_ghost_pad                (GstPad *pad, GstPad *ghostpad);
 383 GList*                  gst_pad_get_ghost_pad_list              (GstPad *pad);
 384
 385 GstPadTemplate*         gst_pad_get_pad_template                (GstPad *pad);
 386
 387 void                    gst_pad_set_bufferalloc_function                (GstPad *pad, GstPadBufferAllocFunction bufalloc);
 388 GstBuffer*              gst_pad_alloc_buffer                    (GstPad *pad, guint64 offset, gint size);
 389
 390 /* data passing setup functions */
 391 void                    gst_pad_set_chain_function              (GstPad *pad, GstPadChainFunction chain);
 392 void                    gst_pad_set_get_function                (GstPad *pad, GstPadGetFunction get);
 393 void                    gst_pad_set_event_function              (GstPad *pad, GstPadEventFunction event);
 394 void                    gst_pad_set_event_mask_function         (GstPad *pad, GstPadEventMaskFunction mask_func);
 395 G_CONST_RETURN GstEventMask*
 396                         gst_pad_get_event_masks                 (GstPad *pad);
 397 G_CONST_RETURN GstEventMask*
 398                         gst_pad_get_event_masks_default         (GstPad *pad);
 399
 400 /* pad links */
 401 void                    gst_pad_set_link_function               (GstPad *pad, GstPadLinkFunction link);
 402 gboolean                gst_pad_can_link                        (GstPad *srcpad, GstPad *sinkpad);
 403 gboolean                gst_pad_can_link_filtered               (GstPad *srcpad, GstPad *sinkpad, const GstCaps *filtercaps);
 404 void                    gst_pad_set_unlink_function             (GstPad *pad, GstPadUnlinkFunction unlink);
 405
 406 gboolean                gst_pad_link                            (GstPad *srcpad, GstPad *sinkpad);
 407 gboolean                gst_pad_link_filtered                   (GstPad *srcpad, GstPad *sinkpad, const GstCaps *filtercaps);
 408 void                    gst_pad_unlink                          (GstPad *srcpad, GstPad *sinkpad);
 409 gboolean                gst_pad_is_linked                       (GstPad *pad);
 410
 411 GstPad*                 gst_pad_get_peer                        (GstPad *pad);
 412
 413 /* capsnego functions */
 414 G_CONST_RETURN GstCaps* gst_pad_get_negotiated_caps             (GstPad *pad);
 415 gboolean                gst_pad_is_negotiated                   (GstPad *pad);
 416 GstCaps*                gst_pad_get_caps                        (GstPad *pad);
 417 G_CONST_RETURN GstCaps* gst_pad_get_pad_template_caps           (GstPad *pad);
 418 GstPadLinkReturn        gst_pad_try_set_caps                    (GstPad *pad, const GstCaps *caps);
 419 GstPadLinkReturn        gst_pad_try_set_caps_nonfixed           (GstPad *pad, const GstCaps *caps);
 420 gboolean                gst_pad_check_compatibility             (GstPad *srcpad, GstPad *sinkpad);
 421
 422 void                    gst_pad_set_getcaps_function            (GstPad *pad, GstPadGetCapsFunction getcaps);
 423 void                    gst_pad_set_fixate_function             (GstPad *pad, GstPadFixateFunction fixate);
 424 GstCaps *               gst_pad_proxy_getcaps                   (GstPad *pad);
 425 GstPadLinkReturn        gst_pad_proxy_pad_link                  (GstPad *pad, const GstCaps *caps);
 426 GstCaps *               gst_pad_proxy_fixate                    (GstPad *pad, const GstCaps *caps);
 427 #ifndef GST_DISABLE_DEPRECATED
 428 GstPadLinkReturn        gst_pad_proxy_link                      (GstPad *pad, const GstCaps *caps);
 429 #endif
 430 gboolean                gst_pad_set_explicit_caps               (GstPad *pad, const GstCaps *caps);
 431 void                    gst_pad_use_explicit_caps               (GstPad *pad);
 432 gboolean                gst_pad_relink_filtered                 (GstPad *srcpad, GstPad *sinkpad, const GstCaps *filtercaps);
 433 #ifndef GST_DISABLE_DEPRECATED
 434 gboolean                gst_pad_perform_negotiate               (GstPad *srcpad, GstPad *sinkpad);
 435 #endif
 436 GstPadLinkReturn        gst_pad_renegotiate                     (GstPad *pad);
 437 void                    gst_pad_unnegotiate                     (GstPad *pad);
 438 gboolean                gst_pad_try_relink_filtered             (GstPad *srcpad, GstPad *sinkpad, const GstCaps *filtercaps);
 439 GstCaps*                gst_pad_get_allowed_caps                (GstPad *pad);
 440 void                    gst_pad_caps_change_notify              (GstPad *pad);
 441
 442 gboolean                gst_pad_recover_caps_error              (GstPad *pad, const GstCaps *allowed);
 443
 444 /* data passing functions */
 445 void                    gst_pad_push                            (GstPad *pad, GstData *data);
 446 GstData*                gst_pad_pull                            (GstPad *pad);
 447 gboolean                gst_pad_send_event                      (GstPad *pad, GstEvent *event);
 448 gboolean                gst_pad_event_default                   (GstPad *pad, GstEvent *event);
 449 #ifndef GST_DISABLE_DEPRECATED
 450 GstPad*                 gst_pad_selectv                         (GList *padlist);
 451 GstPad*                 gst_pad_select                          (GstPad *pad, ...);
 452 GstPad*                 gst_pad_select_valist                   (GstPad *pad, va_list varargs);
 453 #endif
 454 /* FIXME 0.9: rename to _select? Otherwise rename SchedulerClass pointer */
 455 GstData *               gst_pad_collectv                        (GstPad **selected, const GList *padlist);
 456 GstData *               gst_pad_collect                         (GstPad **selected, GstPad *pad, ...);
 457 GstData *               gst_pad_collect_valist                  (GstPad **selected, GstPad *pad, va_list varargs);
 458
 459 /* convert/query/format functions */
 460 void                    gst_pad_set_formats_function            (GstPad *pad,
 461                                                                  GstPadFormatsFunction formats);
 462 G_CONST_RETURN GstFormat*
 463                         gst_pad_get_formats                     (GstPad *pad);
 464 G_CONST_RETURN GstFormat*
 465                         gst_pad_get_formats_default             (GstPad *pad);
 466
 467 void                    gst_pad_set_convert_function            (GstPad *pad, GstPadConvertFunction convert);
 468 gboolean                gst_pad_convert                         (GstPad *pad,
 469                                                                  GstFormat src_format,  gint64  src_value,
 470                                                                  GstFormat *dest_format, gint64 *dest_value);
 471 gboolean                gst_pad_convert_default                 (GstPad *pad,
 472                                                                  GstFormat src_format,  gint64  src_value,
 473                                                                  GstFormat *dest_format, gint64 *dest_value);
 474
 475 void                    gst_pad_set_query_function              (GstPad *pad, GstPadQueryFunction query);
 476 void                    gst_pad_set_query_type_function         (GstPad *pad, GstPadQueryTypeFunction type_func);
 477 G_CONST_RETURN GstQueryType*
 478                         gst_pad_get_query_types                 (GstPad *pad);
 479 G_CONST_RETURN GstQueryType*
 480                         gst_pad_get_query_types_default         (GstPad *pad);
 481 gboolean                gst_pad_query                           (GstPad *pad, GstQueryType type,
 482                                                                  GstFormat *format, gint64 *value);
 483 gboolean                gst_pad_query_default                   (GstPad *pad, GstQueryType type,
 484                                                                  GstFormat *format, gint64 *value);
 485
 486 void                    gst_pad_set_internal_link_function      (GstPad *pad, GstPadIntLinkFunction intlink);
 487 GList*                  gst_pad_get_internal_links              (GstPad *pad);
 488 GList*                  gst_pad_get_internal_links_default      (GstPad *pad);
 489
 490 /* misc helper functions */
 491 gboolean                gst_pad_dispatcher                      (GstPad *pad, GstPadDispatcherFunction dispatch,
 492                                                                  gpointer data);
 493
 494 #define                 gst_pad_add_probe(pad, probe) \
 495                         (gst_probe_dispatcher_add_probe (&(GST_PAD_REALIZE (pad)->probedisp), probe))
 496 #define                 gst_pad_remove_probe(pad, probe) \
 497                         (gst_probe_dispatcher_remove_probe (&(GST_PAD_REALIZE (pad)->probedisp), probe))
 498
 499 #ifndef GST_DISABLE_LOADSAVE
 500 void                    gst_pad_load_and_link                   (xmlNodePtr self, GstObject *parent);
 501 #endif
 502
 503
 504 /* ghostpads */
 505 GstPad*                 gst_ghost_pad_new                       (const gchar *name, GstPad *pad);
 506
 507
 508 /* templates and factories */
 509 GType                   gst_pad_template_get_type               (void);
 510
 511 GstPadTemplate*         gst_pad_template_new                    (const gchar *name_template,
 512                                                                  GstPadDirection direction, GstPadPresence presence,
 513                                                                  GstCaps *caps);
 514
 515 GstPadTemplate *        gst_static_pad_template_get             (GstStaticPadTemplate *pad_template);
 516 const GstCaps*          gst_pad_template_get_caps               (GstPadTemplate *templ);
 517 #ifndef GST_DISABLE_DEPRECATED
 518 const GstCaps*          gst_pad_template_get_caps_by_name       (GstPadTemplate *templ, const gchar *name);
 519 #endif
 520
 521 #ifndef GST_DISABLE_LOADSAVE
 522 xmlNodePtr              gst_ghost_pad_save_thyself              (GstPad *pad,
 523                                                                  xmlNodePtr parent);
 524 #endif
 525
 526 /* for schedulers only */
 527 void                    gst_pad_call_chain_function             (GstPad *pad, GstData *data);
 528 GstData *               gst_pad_call_get_function               (GstPad *pad);
 529
 530 G_END_DECLS
 531
 532 #endif /* __GST_PAD_H__ */