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