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/gsttask.h>
  36
  37
  38 G_BEGIN_DECLS
  39
  40 GST_EXPORT GType _gst_pad_type;
  41 GST_EXPORT GType _gst_real_pad_type;
  42 GST_EXPORT GType _gst_ghost_pad_type;
  43
  44 /*
  45  * Pad base class
  46  */
  47 #define GST_TYPE_PAD                    (_gst_pad_type)
  48 #define GST_IS_PAD(obj)                 (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PAD))
  49 #define GST_IS_PAD_FAST(obj)            (G_OBJECT_TYPE(obj) == GST_TYPE_REAL_PAD || \
  50                                          G_OBJECT_TYPE(obj) == GST_TYPE_GHOST_PAD)
  51 #define GST_IS_PAD_CLASS(klass)         (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PAD))
  52 #define GST_PAD(obj)                    (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PAD, GstPad))
  53 #define GST_PAD_CLASS(klass)            (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PAD, GstPadClass))
  54 #define GST_PAD_CAST(obj)               ((GstPad*)(obj))
  55
  56 /*
  57  * Real Pads
  58  */
  59 #define GST_TYPE_REAL_PAD               (_gst_real_pad_type)
  60 #define GST_IS_REAL_PAD(obj)            (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_REAL_PAD))
  61 #define GST_IS_REAL_PAD_FAST(obj)       (G_OBJECT_TYPE(obj) == GST_TYPE_REAL_PAD)
  62 #define GST_IS_REAL_PAD_CLASS(klass)    (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_REAL_PAD))
  63 #define GST_REAL_PAD(obj)               (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_REAL_PAD, GstRealPad))
  64 #define GST_REAL_PAD_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_REAL_PAD, GstRealPadClass))
  65 #define GST_REAL_PAD_CAST(obj)          ((GstRealPad*)(obj))
  66
  67 /*
  68  * Ghost Pads
  69  */
  70 #define GST_TYPE_GHOST_PAD              (_gst_ghost_pad_type)
  71 #define GST_IS_GHOST_PAD(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_GHOST_PAD))
  72 #define GST_IS_GHOST_PAD_FAST(obj)      (G_OBJECT_TYPE(obj) == GST_TYPE_GHOST_PAD)
  73 #define GST_IS_GHOST_PAD_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_GHOST_PAD))
  74 #define GST_GHOST_PAD(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_GHOST_PAD, GstGhostPad))
  75 #define GST_GHOST_PAD_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_GHOST_PAD, GstGhostPadClass))
  76 #define GST_GHOST_PAD_CAST(obj)         ((GstGhostPad*)(obj))
  77
  78
  79 /*typedef struct _GstPad GstPad; */
  80 /*typedef struct _GstPadClass GstPadClass;*/
  81 typedef struct _GstRealPad GstRealPad;
  82 typedef struct _GstRealPadClass GstRealPadClass;
  83 typedef struct _GstGhostPad GstGhostPad;
  84 typedef struct _GstGhostPadClass GstGhostPadClass;
  85 /*typedef struct _GstPadTemplate GstPadTemplate;*/
  86 /*typedef struct _GstPadTemplateClass GstPadTemplateClass;*/
  87 typedef struct _GstStaticPadTemplate GstStaticPadTemplate;
  88 typedef struct _GstPadLink GstPadLink;
  89
  90 typedef enum {
  91   GST_PAD_LINK_NOSCHED          = -5,   /* pads cannot cooperate in scheduling */
  92   GST_PAD_LINK_NOFORMAT         = -4,   /* pads do not have common format */
  93   GST_PAD_LINK_REFUSED          = -3,   /* refused for some reason */
  94   GST_PAD_LINK_WRONG_DIRECTION  = -2,   /* pads have wrong direction */
  95   GST_PAD_LINK_WAS_LINKED       = -1,   /* pad was already linked */
  96   GST_PAD_LINK_OK               =  0,   /* link ok */
  97 } GstPadLinkReturn;
  98
  99 #define GST_PAD_LINK_FAILED(ret) ((ret) < GST_PAD_LINK_OK)
 100 #define GST_PAD_LINK_SUCCESSFUL(ret) ((ret) >= GST_PAD_LINK_OK)
 101
 102 typedef enum {
 103   GST_FLOW_OK             =  0,         /* data passing was ok */
 104   GST_FLOW_RESEND         =  1,         /* resend buffer, possibly with new caps */
 105   GST_FLOW_ERROR          = -1,         /* some (fatal) error occured */
 106   GST_FLOW_NOT_CONNECTED  = -2,         /* pad is not connected */
 107   GST_FLOW_NOT_NEGOTIATED = -3,         /* pad is not negotiated */
 108   GST_FLOW_WRONG_STATE    = -4,         /* pad is in wrong state */
 109   GST_FLOW_UNEXPECTED     = -5,         /* did not expect anything, this is not fatal */
 110   GST_FLOW_NOT_SUPPORTED  = -6          /* function not supported */
 111 } GstFlowReturn;
 112
 113 typedef enum {
 114   GST_ACTIVATE_NONE,
 115   GST_ACTIVATE_PUSH,
 116   GST_ACTIVATE_PULL,
 117 } GstActivateMode;
 118
 119 #define GST_PAD_MODE_ACTIVATE(mode) ((mode) != GST_ACTIVATE_NONE)
 120
 121 /* convenience functions */
 122 #ifdef G_HAVE_ISO_VARARGS
 123 #define GST_PAD_QUERY_TYPE_FUNCTION(functionname, ...)  GST_QUERY_TYPE_FUNCTION (GstPad *, functionname, __VA_ARGS__);
 124 #define GST_PAD_FORMATS_FUNCTION(functionname, ...)     GST_FORMATS_FUNCTION (GstPad *, functionname, __VA_ARGS__);
 125 #define GST_PAD_EVENT_MASK_FUNCTION(functionname, ...)  GST_EVENT_MASK_FUNCTION (GstPad *, functionname, __VA_ARGS__);
 126 #elif defined(G_HAVE_GNUC_VARARGS)
 127 #define GST_PAD_QUERY_TYPE_FUNCTION(functionname, a...) GST_QUERY_TYPE_FUNCTION (GstPad *, functionname, a);
 128 #define GST_PAD_FORMATS_FUNCTION(functionname, a...)    GST_FORMATS_FUNCTION (GstPad *, functionname, a);
 129 #define GST_PAD_EVENT_MASK_FUNCTION(functionname, a...) GST_EVENT_MASK_FUNCTION (GstPad *, functionname, a);
 130 #endif
 131
 132
 133 /* pad states */
 134 typedef gboolean                (*GstPadActivateFunction)       (GstPad *pad, GstActivateMode mode);
 135
 136 /* data passing */
 137 typedef void                    (*GstPadLoopFunction)           (GstPad *pad);
 138 typedef GstFlowReturn           (*GstPadChainFunction)          (GstPad *pad, GstBuffer *buffer);
 139 typedef GstFlowReturn           (*GstPadGetRangeFunction)       (GstPad *pad, guint64 offset,
 140                                                                  guint length, GstBuffer **buffer);
 141 typedef gboolean                (*GstPadCheckGetRangeFunction)  (GstPad *pad);
 142 typedef gboolean                (*GstPadEventFunction)          (GstPad *pad, GstEvent *event);
 143
 144 /* convert/query/format functions */
 145 typedef gboolean                (*GstPadConvertFunction)        (GstPad *pad,
 146                                                                  GstFormat src_format,  gint64  src_value,
 147                                                                  GstFormat *dest_format, gint64 *dest_value);
 148 typedef gboolean                (*GstPadQueryFunction)          (GstPad *pad, GstQueryType type,
 149                                                                  GstFormat *format, gint64  *value);
 150 typedef GList*                  (*GstPadIntLinkFunction)        (GstPad *pad);
 151 typedef const GstFormat*        (*GstPadFormatsFunction)        (GstPad *pad);
 152 typedef const GstEventMask*     (*GstPadEventMaskFunction)      (GstPad *pad);
 153 typedef const GstQueryType*     (*GstPadQueryTypeFunction)      (GstPad *pad);
 154
 155 /* linking */
 156 typedef GstPadLinkReturn        (*GstPadLinkFunction)           (GstPad *pad, GstPad *peer);
 157 typedef void                    (*GstPadUnlinkFunction)         (GstPad *pad);
 158
 159 /* caps nego */
 160 typedef GstCaps*                (*GstPadGetCapsFunction)        (GstPad *pad);
 161 typedef gboolean                (*GstPadSetCapsFunction)        (GstPad *pad, GstCaps *caps);
 162 typedef gboolean                (*GstPadAcceptCapsFunction)     (GstPad *pad, GstCaps *caps);
 163 typedef GstCaps*                (*GstPadFixateCapsFunction)     (GstPad *pad, GstCaps *caps);
 164 typedef GstBuffer*              (*GstPadBufferAllocFunction)    (GstPad *pad, guint64 offset, guint size,
 165                                                                  GstCaps *caps);
 166 /* misc */
 167 typedef gboolean                (*GstPadDispatcherFunction)     (GstPad *pad, gpointer data);
 168
 169 typedef void                    (*GstPadBlockCallback)          (GstPad *pad, gboolean blocked, gpointer user_data);
 170
 171 typedef enum {
 172   GST_PAD_UNKNOWN,
 173   GST_PAD_SRC,
 174   GST_PAD_SINK
 175 } GstPadDirection;
 176
 177 typedef enum {
 178   GST_PAD_ACTIVE                = GST_OBJECT_FLAG_LAST,
 179   GST_PAD_BLOCKED,
 180   GST_PAD_FLUSHING,
 181   GST_PAD_IN_GETCAPS,
 182   GST_PAD_IN_SETCAPS,
 183
 184   GST_PAD_FLAG_LAST             = GST_OBJECT_FLAG_LAST + 8
 185 } GstPadFlags;
 186
 187 struct _GstPad {
 188   GstObject             object;
 189
 190   gpointer              element_private;
 191
 192   GstPadTemplate        *padtemplate;   /* the template for this pad */
 193
 194   gpointer _gst_reserved[GST_PADDING];
 195 };
 196
 197 struct _GstPadClass {
 198   GstObjectClass parent_class;
 199
 200   gpointer _gst_reserved[GST_PADDING];
 201 };
 202
 203 struct _GstRealPad {
 204   GstPad                         pad;
 205
 206   /* direction cannot change after creating the pad */
 207   GstPadDirection                direction;
 208
 209   /*< public >*/ /* with STREAM_LOCK */
 210   /* streaming rec_lock */
 211   GStaticRecMutex               *stream_rec_lock;
 212   GstTask                       *task;
 213   /*< public >*/ /* with PREROLL_LOCK */
 214   GMutex                        *preroll_lock;
 215   GCond                         *preroll_cond;
 216
 217   /*< public >*/ /* with LOCK */
 218   /* block cond, mutex is from the object */
 219   GCond                         *block_cond;
 220   GstPadBlockCallback            block_callback;
 221   gpointer                       block_data;
 222
 223   /* the pad capabilities */
 224   GstCaps                       *caps;
 225   GstPadGetCapsFunction          getcapsfunc;
 226   GstPadSetCapsFunction          setcapsfunc;
 227   GstPadAcceptCapsFunction       acceptcapsfunc;
 228   GstPadFixateCapsFunction       fixatecapsfunc;
 229
 230   GstPadActivateFunction         activatefunc;
 231
 232   /* pad link */
 233   GstPadLinkFunction             linkfunc;
 234   GstPadUnlinkFunction           unlinkfunc;
 235   GstRealPad                    *peer;
 236
 237   gpointer                       sched_private;
 238
 239   /* data transport functions */
 240   GstPadLoopFunction             loopfunc;
 241   GstPadChainFunction            chainfunc;
 242   GstPadCheckGetRangeFunction    checkgetrangefunc;
 243   GstPadGetRangeFunction         getrangefunc;
 244   GstPadEventFunction            eventfunc;
 245
 246   GstPadEventMaskFunction        eventmaskfunc;
 247
 248   /* ghostpads */
 249   GList                         *ghostpads;
 250   guint32                        ghostpads_cookie;
 251
 252   /* query/convert/formats functions */
 253   GstPadConvertFunction          convertfunc;
 254   GstPadQueryFunction            queryfunc;
 255   GstPadFormatsFunction          formatsfunc;
 256   GstPadQueryTypeFunction        querytypefunc;
 257   GstPadIntLinkFunction          intlinkfunc;
 258
 259   GstPadBufferAllocFunction      bufferallocfunc;
 260
 261   GstProbeDispatcher             probedisp;
 262
 263   /*< private >*/
 264   gpointer _gst_reserved[GST_PADDING];
 265 };
 266
 267 struct _GstRealPadClass {
 268   GstPadClass   parent_class;
 269
 270   /* signal callbacks */
 271   void          (*linked)               (GstPad *pad, GstPad *peer);
 272   void          (*unlinked)             (GstPad *pad, GstPad *peer);
 273   void          (*request_link)         (GstPad *pad);
 274
 275   /*< private >*/
 276   gpointer _gst_reserved[GST_PADDING];
 277 };
 278
 279 struct _GstGhostPad {
 280   GstPad pad;
 281
 282   GstRealPad *realpad;
 283
 284   gpointer _gst_reserved[GST_PADDING];
 285 };
 286
 287 struct _GstGhostPadClass {
 288   GstPadClass parent_class;
 289
 290   gpointer _gst_reserved[GST_PADDING];
 291 };
 292
 293
 294 /***** helper macros *****/
 295 /* GstPad */
 296 #define GST_PAD_NAME(pad)               (GST_OBJECT_NAME(pad))
 297 #define GST_PAD_PARENT(pad)             (GST_ELEMENT_CAST(GST_OBJECT_PARENT(pad)))
 298 #define GST_PAD_ELEMENT_PRIVATE(pad)    (GST_PAD_CAST(pad)->element_private)
 299 #define GST_PAD_PAD_TEMPLATE(pad)       (GST_PAD_CAST(pad)->padtemplate)
 300
 301 /* GstRealPad */
 302 #define GST_RPAD_DIRECTION(pad)         (GST_REAL_PAD_CAST(pad)->direction)
 303 #define GST_RPAD_TASK(pad)              (GST_REAL_PAD_CAST(pad)->task)
 304 #define GST_RPAD_ACTIVATEFUNC(pad)      (GST_REAL_PAD_CAST(pad)->activatefunc)
 305 #define GST_RPAD_LOOPFUNC(pad)          (GST_REAL_PAD_CAST(pad)->loopfunc)
 306 #define GST_RPAD_CHAINFUNC(pad)         (GST_REAL_PAD_CAST(pad)->chainfunc)
 307 #define GST_RPAD_CHECKGETRANGEFUNC(pad) (GST_REAL_PAD_CAST(pad)->checkgetrangefunc)
 308 #define GST_RPAD_GETRANGEFUNC(pad)      (GST_REAL_PAD_CAST(pad)->getrangefunc)
 309 #define GST_RPAD_EVENTFUNC(pad)         (GST_REAL_PAD_CAST(pad)->eventfunc)
 310 #define GST_RPAD_CONVERTFUNC(pad)       (GST_REAL_PAD_CAST(pad)->convertfunc)
 311 #define GST_RPAD_QUERYFUNC(pad)         (GST_REAL_PAD_CAST(pad)->queryfunc)
 312 #define GST_RPAD_INTLINKFUNC(pad)       (GST_REAL_PAD_CAST(pad)->intlinkfunc)
 313 #define GST_RPAD_FORMATSFUNC(pad)       (GST_REAL_PAD_CAST(pad)->formatsfunc)
 314 #define GST_RPAD_QUERYTYPEFUNC(pad)     (GST_REAL_PAD_CAST(pad)->querytypefunc)
 315 #define GST_RPAD_EVENTMASKFUNC(pad)     (GST_REAL_PAD_CAST(pad)->eventmaskfunc)
 316
 317 #define GST_RPAD_PEER(pad)              (GST_REAL_PAD_CAST(pad)->peer)
 318 #define GST_RPAD_LINKFUNC(pad)          (GST_REAL_PAD_CAST(pad)->linkfunc)
 319 #define GST_RPAD_UNLINKFUNC(pad)        (GST_REAL_PAD_CAST(pad)->unlinkfunc)
 320
 321 #define GST_RPAD_CAPS(pad)              (GST_REAL_PAD_CAST(pad)->caps)
 322 #define GST_RPAD_GETCAPSFUNC(pad)       (GST_REAL_PAD_CAST(pad)->getcapsfunc)
 323 #define GST_RPAD_SETCAPSFUNC(pad)       (GST_REAL_PAD_CAST(pad)->setcapsfunc)
 324 #define GST_RPAD_ACCEPTCAPSFUNC(pad)    (GST_REAL_PAD_CAST(pad)->acceptcapsfunc)
 325 #define GST_RPAD_FIXATECAPSFUNC(pad)    (GST_REAL_PAD_CAST(pad)->fixatecapsfunc)
 326
 327 #define GST_RPAD_BUFFERALLOCFUNC(pad)   (GST_REAL_PAD_CAST(pad)->bufferallocfunc)
 328
 329 #define GST_RPAD_IS_LINKED(pad)         (GST_RPAD_PEER(pad) != NULL)
 330 #define GST_RPAD_IS_ACTIVE(pad)         (GST_FLAG_IS_SET (pad, GST_PAD_ACTIVE))
 331 #define GST_RPAD_IS_BLOCKED(pad)        (GST_FLAG_IS_SET (pad, GST_PAD_BLOCKED))
 332 #define GST_RPAD_IS_FLUSHING(pad)       (GST_FLAG_IS_SET (pad, GST_PAD_FLUSHING))
 333 #define GST_RPAD_IS_IN_GETCAPS(pad)     (GST_FLAG_IS_SET (pad, GST_PAD_IN_GETCAPS))
 334 #define GST_RPAD_IS_IN_SETCAPS(pad)     (GST_FLAG_IS_SET (pad, GST_PAD_IN_SETCAPS))
 335 #define GST_RPAD_IS_USABLE(pad)         (GST_RPAD_IS_LINKED (pad) && \
 336                                          GST_RPAD_IS_ACTIVE(pad) && GST_RPAD_IS_ACTIVE(GST_RPAD_PEER (pad)))
 337 #define GST_RPAD_IS_SRC(pad)            (GST_RPAD_DIRECTION(pad) == GST_PAD_SRC)
 338 #define GST_RPAD_IS_SINK(pad)           (GST_RPAD_DIRECTION(pad) == GST_PAD_SINK)
 339
 340 #define GST_STREAM_GET_LOCK(pad)        (GST_PAD_REALIZE(pad)->stream_rec_lock)
 341 #define GST_STREAM_LOCK(pad)            (g_static_rec_mutex_lock(GST_STREAM_GET_LOCK(pad)))
 342 #define GST_STREAM_TRYLOCK(pad)         (g_static_rec_mutex_trylock(GST_STREAM_GET_LOCK(pad)))
 343 #define GST_STREAM_UNLOCK(pad)          (g_static_rec_mutex_unlock(GST_STREAM_GET_LOCK(pad)))
 344
 345 #define GST_PREROLL_GET_LOCK(pad)       (GST_PAD_REALIZE(pad)->preroll_lock)
 346 #define GST_PREROLL_LOCK(pad)           (g_mutex_lock(GST_PREROLL_GET_LOCK(pad)))
 347 #define GST_PREROLL_TRYLOCK(pad)        (g_mutex_trylock(GST_PREROLL_GET_LOCK(pad)))
 348 #define GST_PREROLL_UNLOCK(pad)         (g_mutex_unlock(GST_PREROLL_GET_LOCK(pad)))
 349 #define GST_PREROLL_GET_COND(pad)       (GST_PAD_REALIZE(pad)->preroll_cond)
 350 #define GST_PREROLL_WAIT(pad)           g_cond_wait (GST_PREROLL_GET_COND (pad), GST_PREROLL_GET_LOCK (pad))
 351 #define GST_PREROLL_TIMED_WAIT(pad, timeval) g_cond_timed_wait (GST_PREROLL_GET_COND (pad), GST_PREROLL_GET_LOCK (pad),\
 352                                              timeval)
 353 #define GST_PREROLL_SIGNAL(pad)         g_cond_signal (GST_PREROLL_GET_COND (pad));
 354 #define GST_PREROLL_BROADCAST(pad)      g_cond_broadcast (GST_PREROLL_GET_COND (pad));
 355
 356 #define GST_PAD_BLOCK_GET_COND(pad)     (GST_PAD_REALIZE(pad)->block_cond)
 357 #define GST_PAD_BLOCK_WAIT(pad)         (g_cond_wait(GST_PAD_BLOCK_GET_COND (pad), GST_GET_LOCK (pad)))
 358 #define GST_PAD_BLOCK_SIGNAL(pad)       (g_cond_signal(GST_PAD_BLOCK_GET_COND (pad)))
 359
 360 /* GstGhostPad */
 361 #define GST_GPAD_REALPAD(pad)           (((GstGhostPad *)(pad))->realpad)
 362
 363 /* Generic, be VERY carefull with these macros as the ghostpad could be lost */
 364 #define GST_PAD_REALIZE(pad)            (GST_IS_REAL_PAD(pad) ? ((GstRealPad *)(pad)) : GST_GPAD_REALPAD(pad))
 365 #define GST_PAD_DIRECTION(pad)          GST_RPAD_DIRECTION(GST_PAD_REALIZE(pad))
 366 #define GST_PAD_CAPS(pad)               GST_RPAD_CAPS(GST_PAD_REALIZE (pad))
 367 #define GST_PAD_PEER(pad)               GST_PAD_CAST(GST_RPAD_PEER(GST_PAD_REALIZE(pad)))
 368
 369 /* Some check functions (unused?) */
 370 #define GST_PAD_IS_LINKED(pad)          (GST_RPAD_IS_LINKED(GST_PAD_REALIZE(pad)))
 371 #define GST_PAD_IS_ACTIVE(pad)          (GST_RPAD_IS_ACTIVE(GST_PAD_REALIZE(pad)))
 372 #define GST_PAD_IS_BLOCKED(pad)         (GST_RPAD_IS_BLOCKED(GST_PAD_REALIZE(pad)))
 373 #define GST_PAD_IS_NEGOTIATING(pad)     (GST_RPAD_IS_NEGOTIATING(GST_PAD_REALIZE(pad)))
 374 #define GST_PAD_IS_IN_GETCAPS(pad)      (GST_RPAD_IS_IN_GETCAPS(GST_PAD_REALIZE(pad)))
 375 #define GST_PAD_IS_IN_SETCAPS(pad)      (GST_RPAD_IS_IN_SETCAPS(GST_PAD_REALIZE(pad)))
 376 #define GST_PAD_IS_USABLE(pad)          (GST_RPAD_IS_USABLE(GST_PAD_REALIZE(pad)))
 377 #define GST_PAD_CAN_PULL(pad)           (GST_RPAD_CAN_PULL(GST_PAD_REALIZE(pad)))
 378 #define GST_PAD_IS_SRC(pad)             (GST_RPAD_IS_SRC(GST_PAD_REALIZE(pad)))
 379 #define GST_PAD_IS_SINK(pad)            (GST_RPAD_IS_SINK(GST_PAD_REALIZE(pad)))
 380
 381 /***** PadTemplate *****/
 382 #define GST_TYPE_PAD_TEMPLATE           (gst_pad_template_get_type ())
 383 #define GST_PAD_TEMPLATE(obj)           (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PAD_TEMPLATE,GstPadTemplate))
 384 #define GST_PAD_TEMPLATE_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PAD_TEMPLATE,GstPadTemplateClass))
 385 #define GST_IS_PAD_TEMPLATE(obj)        (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PAD_TEMPLATE))
 386 #define GST_IS_PAD_TEMPLATE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PAD_TEMPLATE))
 387
 388 typedef enum {
 389   GST_PAD_ALWAYS,
 390   GST_PAD_SOMETIMES,
 391   GST_PAD_REQUEST
 392 } GstPadPresence;
 393
 394 #define GST_PAD_TEMPLATE_NAME_TEMPLATE(templ)   (((GstPadTemplate *)(templ))->name_template)
 395 #define GST_PAD_TEMPLATE_DIRECTION(templ)       (((GstPadTemplate *)(templ))->direction)
 396 #define GST_PAD_TEMPLATE_PRESENCE(templ)        (((GstPadTemplate *)(templ))->presence)
 397 #define GST_PAD_TEMPLATE_CAPS(templ)            (((GstPadTemplate *)(templ))->caps)
 398
 399 typedef enum {
 400   GST_PAD_TEMPLATE_FIXED        = GST_OBJECT_FLAG_LAST,
 401
 402   GST_PAD_TEMPLATE_FLAG_LAST    = GST_OBJECT_FLAG_LAST + 4
 403 } GstPadTemplateFlags;
 404
 405 #define GST_PAD_TEMPLATE_IS_FIXED(templ)        (GST_FLAG_IS_SET(templ, GST_PAD_TEMPLATE_FIXED))
 406
 407 struct _GstPadTemplate {
 408   GstObject        object;
 409
 410   gchar           *name_template;
 411   GstPadDirection  direction;
 412   GstPadPresence   presence;
 413   GstCaps         *caps;
 414
 415   gpointer _gst_reserved[GST_PADDING];
 416 };
 417
 418 struct _GstPadTemplateClass {
 419   GstObjectClass   parent_class;
 420
 421   /* signal callbacks */
 422   void (*pad_created)   (GstPadTemplate *templ, GstPad *pad);
 423
 424   gpointer _gst_reserved[GST_PADDING];
 425 };
 426
 427 struct _GstStaticPadTemplate {
 428   gchar           *name_template;
 429   GstPadDirection  direction;
 430   GstPadPresence   presence;
 431   GstStaticCaps   static_caps;
 432 };
 433
 434 #define GST_STATIC_PAD_TEMPLATE(padname, dir, pres, caps) \
 435   { \
 436   /* name_template */    padname, \
 437   /* direction */        dir, \
 438   /* presence */         pres, \
 439   /* caps */             caps \
 440   }
 441
 442
 443 GType                   gst_pad_get_type                        (void);
 444 GType                   gst_real_pad_get_type                   (void);
 445 GType                   gst_ghost_pad_get_type                  (void);
 446
 447 /* creating pads */
 448 GstPad*                 gst_pad_new                             (const gchar *name, GstPadDirection direction);
 449 GstPad*                 gst_pad_new_from_template               (GstPadTemplate *templ, const gchar *name);
 450 GstPad*                 gst_pad_custom_new                      (GType type, const gchar *name, GstPadDirection direction);
 451 GstPad*                 gst_pad_custom_new_from_template        (GType type, GstPadTemplate *templ, const gchar *name);
 452
 453 #define                 gst_pad_get_name(pad)                   gst_object_get_name(GST_OBJECT(pad))
 454 #define                 gst_pad_set_name(pad,name)              gst_object_set_name(GST_OBJECT(pad),name)
 455 #define                 gst_pad_get_parent(pad)                 GST_ELEMENT(gst_object_get_parent(GST_OBJECT(pad)))
 456 #define                 gst_pad_set_parent(pad,parent)          gst_object_set_parent(GST_OBJECT(pad),parent)
 457 GstElement*             gst_pad_get_real_parent                 (GstPad *pad);
 458
 459
 460 GstPadDirection         gst_pad_get_direction                   (GstPad *pad);
 461
 462 gboolean                gst_pad_set_active                      (GstPad *pad, GstActivateMode mode);
 463 gboolean                gst_pad_peer_set_active                 (GstPad *pad, GstActivateMode mode);
 464 gboolean                gst_pad_is_active                       (GstPad *pad);
 465 gboolean                gst_pad_set_blocked                     (GstPad *pad, gboolean blocked);
 466 gboolean                gst_pad_set_blocked_async               (GstPad *pad, gboolean blocked,
 467                                                                  GstPadBlockCallback callback, gpointer user_data);
 468 gboolean                gst_pad_is_blocked                      (GstPad *pad);
 469
 470 void                    gst_pad_set_element_private             (GstPad *pad, gpointer priv);
 471 gpointer                gst_pad_get_element_private             (GstPad *pad);
 472
 473 GstPadTemplate*         gst_pad_get_pad_template                (GstPad *pad);
 474
 475 void                    gst_pad_set_bufferalloc_function        (GstPad *pad, GstPadBufferAllocFunction bufalloc);
 476 GstBuffer*              gst_pad_alloc_buffer                    (GstPad *pad, guint64 offset, gint size,
 477                                                                  GstCaps *caps);
 478
 479 /* data passing setup functions */
 480 void                    gst_pad_set_activate_function           (GstPad *pad, GstPadActivateFunction activate);
 481 void                    gst_pad_set_loop_function               (GstPad *pad, GstPadLoopFunction loop);
 482 void                    gst_pad_set_chain_function              (GstPad *pad, GstPadChainFunction chain);
 483 void                    gst_pad_set_getrange_function           (GstPad *pad, GstPadGetRangeFunction get);
 484 void                    gst_pad_set_checkgetrange_function      (GstPad *pad, GstPadCheckGetRangeFunction check);
 485 void                    gst_pad_set_event_function              (GstPad *pad, GstPadEventFunction event);
 486 void                    gst_pad_set_event_mask_function         (GstPad *pad, GstPadEventMaskFunction mask_func);
 487 G_CONST_RETURN GstEventMask*
 488                         gst_pad_get_event_masks                 (GstPad *pad);
 489 G_CONST_RETURN GstEventMask*
 490                         gst_pad_get_event_masks_default         (GstPad *pad);
 491
 492 /* pad links */
 493 void                    gst_pad_set_link_function               (GstPad *pad, GstPadLinkFunction link);
 494 void                    gst_pad_set_unlink_function             (GstPad *pad, GstPadUnlinkFunction unlink);
 495
 496 GstPadLinkReturn        gst_pad_link                            (GstPad *srcpad, GstPad *sinkpad);
 497 gboolean                gst_pad_unlink                          (GstPad *srcpad, GstPad *sinkpad);
 498 gboolean                gst_pad_is_linked                       (GstPad *pad);
 499
 500 GstPad*                 gst_pad_get_peer                        (GstPad *pad);
 501 GstPad*                 gst_pad_realize                         (GstPad *pad);
 502
 503 /* capsnego functions */
 504 void                    gst_pad_set_getcaps_function            (GstPad *pad, GstPadGetCapsFunction getcaps);
 505 void                    gst_pad_set_acceptcaps_function         (GstPad *pad, GstPadAcceptCapsFunction acceptcaps);
 506 void                    gst_pad_set_fixatecaps_function         (GstPad *pad, GstPadFixateCapsFunction fixatecaps);
 507 void                    gst_pad_set_setcaps_function            (GstPad *pad, GstPadSetCapsFunction setcaps);
 508
 509 G_CONST_RETURN GstCaps* gst_pad_get_pad_template_caps           (GstPad *pad);
 510
 511 /* capsnego function for connected/unconnected pads */
 512 GstCaps *               gst_pad_get_caps                        (GstPad * pad);
 513 GstCaps*                gst_pad_fixate_caps                     (GstPad * pad, GstCaps *caps);
 514 gboolean                gst_pad_accept_caps                     (GstPad * pad, GstCaps *caps);
 515 gboolean                gst_pad_set_caps                        (GstPad * pad, GstCaps *caps);
 516
 517 GstCaps *               gst_pad_peer_get_caps                   (GstPad * pad);
 518 gboolean                gst_pad_peer_accept_caps                (GstPad * pad, GstCaps *caps);
 519
 520 /* capsnego for connected pads */
 521 GstCaps *               gst_pad_get_allowed_caps                (GstPad * srcpad);
 522 GstCaps *               gst_pad_get_negotiated_caps             (GstPad * pad);
 523
 524 /* data passing functions */
 525 GstFlowReturn           gst_pad_push                            (GstPad *pad, GstBuffer *buffer);
 526 gboolean                gst_pad_check_pull_range                (GstPad *pad);
 527 GstFlowReturn           gst_pad_pull_range                      (GstPad *pad, guint64 offset, guint size,
 528                                                                  GstBuffer **buffer);
 529 gboolean                gst_pad_push_event                      (GstPad *pad, GstEvent *event);
 530 gboolean                gst_pad_send_event                      (GstPad *pad, GstEvent *event);
 531 gboolean                gst_pad_event_default                   (GstPad *pad, GstEvent *event);
 532
 533 /* pad tasks */
 534 gboolean                gst_pad_start_task                      (GstPad *pad);
 535 gboolean                gst_pad_pause_task                      (GstPad *pad);
 536 gboolean                gst_pad_stop_task                       (GstPad *pad);
 537
 538 /* convert/query/format functions */
 539 void                    gst_pad_set_formats_function            (GstPad *pad,
 540                                                                  GstPadFormatsFunction formats);
 541 G_CONST_RETURN GstFormat*
 542                         gst_pad_get_formats                     (GstPad *pad);
 543 G_CONST_RETURN GstFormat*
 544                         gst_pad_get_formats_default             (GstPad *pad);
 545
 546 void                    gst_pad_set_convert_function            (GstPad *pad, GstPadConvertFunction convert);
 547 gboolean                gst_pad_convert                         (GstPad *pad,
 548                                                                  GstFormat src_format,  gint64  src_value,
 549                                                                  GstFormat *dest_format, gint64 *dest_value);
 550 gboolean                gst_pad_convert_default                 (GstPad *pad,
 551                                                                  GstFormat src_format,  gint64  src_value,
 552                                                                  GstFormat *dest_format, gint64 *dest_value);
 553
 554 void                    gst_pad_set_query_function              (GstPad *pad, GstPadQueryFunction query);
 555 void                    gst_pad_set_query_type_function         (GstPad *pad, GstPadQueryTypeFunction type_func);
 556 G_CONST_RETURN GstQueryType*
 557                         gst_pad_get_query_types                 (GstPad *pad);
 558 G_CONST_RETURN GstQueryType*
 559                         gst_pad_get_query_types_default         (GstPad *pad);
 560 gboolean                gst_pad_query                           (GstPad *pad, GstQueryType type,
 561                                                                  GstFormat *format, gint64 *value);
 562 gboolean                gst_pad_query_default                   (GstPad *pad, GstQueryType type,
 563                                                                  GstFormat *format, gint64 *value);
 564
 565 void                    gst_pad_set_internal_link_function      (GstPad *pad, GstPadIntLinkFunction intlink);
 566 GList*                  gst_pad_get_internal_links              (GstPad *pad);
 567 GList*                  gst_pad_get_internal_links_default      (GstPad *pad);
 568
 569 /* misc helper functions */
 570 gboolean                gst_pad_dispatcher                      (GstPad *pad, GstPadDispatcherFunction dispatch,
 571                                                                  gpointer data);
 572
 573 /* probes */
 574 #define                 gst_pad_add_probe(pad, probe) \
 575                         (gst_probe_dispatcher_add_probe (&(GST_PAD_REALIZE (pad)->probedisp), probe))
 576 #define                 gst_pad_remove_probe(pad, probe) \
 577                         (gst_probe_dispatcher_remove_probe (&(GST_PAD_REALIZE (pad)->probedisp), probe))
 578
 579 #ifndef GST_DISABLE_LOADSAVE
 580 void                    gst_pad_load_and_link                   (xmlNodePtr self, GstObject *parent);
 581 #endif
 582
 583
 584 /* ghostpads */
 585 GstPad*                 gst_ghost_pad_new                       (const gchar *name, GstPad *pad);
 586
 587
 588 /* templates and factories */
 589 GType                   gst_pad_template_get_type               (void);
 590
 591 GstPadTemplate*         gst_pad_template_new                    (const gchar *name_template,
 592                                                                  GstPadDirection direction, GstPadPresence presence,
 593                                                                  GstCaps *caps);
 594
 595 GstPadTemplate *        gst_static_pad_template_get             (GstStaticPadTemplate *pad_template);
 596 GstCaps*                gst_static_pad_template_get_caps        (GstStaticPadTemplate *templ);
 597 GstCaps*                gst_pad_template_get_caps               (GstPadTemplate *templ);
 598
 599 #ifndef GST_DISABLE_LOADSAVE
 600 xmlNodePtr              gst_ghost_pad_save_thyself              (GstPad *pad,
 601                                                                  xmlNodePtr parent);
 602 #endif
 603
 604
 605 G_END_DECLS
 606
 607 #endif /* __GST_PAD_H__ */