2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wim.taymans@chello.be>
5 * gstpad.h: Header for GstPad object
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.
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.
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.
27 #include <gst/gstconfig.h>
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>
40 GST_EXPORT GType _gst_pad_type;
41 GST_EXPORT GType _gst_real_pad_type;
42 GST_EXPORT GType _gst_ghost_pad_type;
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))
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))
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))
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;
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 */
99 #define GST_PAD_LINK_FAILED(ret) (ret < GST_PAD_LINK_OK)
100 #define GST_PAD_LINK_SUCCESSFUL(ret) (ret >= GST_PAD_LINK_OK)
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 */
119 /* convenience functions */
120 #ifdef G_HAVE_ISO_VARARGS
121 #define GST_PAD_QUERY_TYPE_FUNCTION(functionname, ...) GST_QUERY_TYPE_FUNCTION (GstPad *, functionname, __VA_ARGS__);
122 #define GST_PAD_FORMATS_FUNCTION(functionname, ...) GST_FORMATS_FUNCTION (GstPad *, functionname, __VA_ARGS__);
123 #define GST_PAD_EVENT_MASK_FUNCTION(functionname, ...) GST_EVENT_MASK_FUNCTION (GstPad *, functionname, __VA_ARGS__);
124 #elif defined(G_HAVE_GNUC_VARARGS)
125 #define GST_PAD_QUERY_TYPE_FUNCTION(functionname, a...) GST_QUERY_TYPE_FUNCTION (GstPad *, functionname, a);
126 #define GST_PAD_FORMATS_FUNCTION(functionname, a...) GST_FORMATS_FUNCTION (GstPad *, functionname, a);
127 #define GST_PAD_EVENT_MASK_FUNCTION(functionname, a...) GST_EVENT_MASK_FUNCTION (GstPad *, functionname, a);
132 typedef gboolean (*GstPadActivateFunction) (GstPad *pad, GstActivateMode mode);
135 typedef void (*GstPadLoopFunction) (GstPad *pad);
136 typedef GstFlowReturn (*GstPadChainFunction) (GstPad *pad, GstBuffer *buffer);
137 typedef GstFlowReturn (*GstPadGetRangeFunction) (GstPad *pad, guint64 offset,
138 guint length, GstBuffer **buffer);
139 typedef gboolean (*GstPadEventFunction) (GstPad *pad, GstEvent *event);
141 /* convert/query/format functions */
142 typedef gboolean (*GstPadConvertFunction) (GstPad *pad,
143 GstFormat src_format, gint64 src_value,
144 GstFormat *dest_format, gint64 *dest_value);
145 typedef gboolean (*GstPadQueryFunction) (GstPad *pad, GstQueryType type,
146 GstFormat *format, gint64 *value);
147 typedef GList* (*GstPadIntLinkFunction) (GstPad *pad);
148 typedef const GstFormat* (*GstPadFormatsFunction) (GstPad *pad);
149 typedef const GstEventMask* (*GstPadEventMaskFunction) (GstPad *pad);
150 typedef const GstQueryType* (*GstPadQueryTypeFunction) (GstPad *pad);
153 typedef GstPadLinkReturn (*GstPadLinkFunction) (GstPad *pad, GstPad *peer);
154 typedef void (*GstPadUnlinkFunction) (GstPad *pad);
157 typedef GstCaps* (*GstPadGetCapsFunction) (GstPad *pad);
158 typedef gboolean (*GstPadSetCapsFunction) (GstPad *pad, GstCaps *caps);
159 typedef gboolean (*GstPadAcceptCapsFunction) (GstPad *pad, GstCaps *caps);
160 typedef GstCaps* (*GstPadFixateCapsFunction) (GstPad *pad, GstCaps *caps);
161 typedef GstBuffer* (*GstPadBufferAllocFunction) (GstPad *pad, guint64 offset, guint size,
164 typedef gboolean (*GstPadDispatcherFunction) (GstPad *pad, gpointer data);
166 typedef void (*GstPadBlockCallback) (GstPad *pad, gboolean blocked, gpointer user_data);
175 GST_PAD_ACTIVE = GST_OBJECT_FLAG_LAST,
181 GST_PAD_FLAG_LAST = GST_OBJECT_FLAG_LAST + 8
187 gpointer element_private;
189 GstPadTemplate *padtemplate; /* the template for this pad */
191 gpointer _gst_reserved[GST_PADDING];
194 struct _GstPadClass {
195 GstObjectClass parent_class;
197 gpointer _gst_reserved[GST_PADDING];
203 /* direction cannot change after creating the pad */
204 GstPadDirection direction;
206 /*< public >*/ /* with STREAM_LOCK */
207 /* streaming rec_lock */
208 GStaticRecMutex *stream_rec_lock;
210 /*< public >*/ /* with PREROLL_LOCK */
211 GMutex *preroll_lock;
214 /*< public >*/ /* with LOCK */
215 /* block cond, mutex is from the object */
217 GstPadBlockCallback block_callback;
220 /* the pad capabilities */
223 GstPadGetCapsFunction getcapsfunc;
224 GstPadSetCapsFunction setcapsfunc;
225 GstPadAcceptCapsFunction acceptcapsfunc;
226 GstPadFixateCapsFunction fixatecapsfunc;
228 GstPadActivateFunction activatefunc;
231 GstPadLinkFunction linkfunc;
232 GstPadUnlinkFunction unlinkfunc;
235 gpointer sched_private;
237 /* data transport functions */
238 GstPadLoopFunction loopfunc;
239 GstPadChainFunction chainfunc;
240 GstPadGetRangeFunction getrangefunc;
241 GstPadEventFunction eventfunc;
243 GstPadEventMaskFunction eventmaskfunc;
247 guint32 ghostpads_cookie;
249 /* query/convert/formats functions */
250 GstPadConvertFunction convertfunc;
251 GstPadQueryFunction queryfunc;
252 GstPadFormatsFunction formatsfunc;
253 GstPadQueryTypeFunction querytypefunc;
254 GstPadIntLinkFunction intlinkfunc;
256 GstPadBufferAllocFunction bufferallocfunc;
258 GstProbeDispatcher probedisp;
261 gpointer _gst_reserved[GST_PADDING];
264 struct _GstRealPadClass {
265 GstPadClass parent_class;
267 /* signal callbacks */
268 void (*linked) (GstPad *pad, GstPad *peer);
269 void (*unlinked) (GstPad *pad, GstPad *peer);
270 void (*request_link) (GstPad *pad);
273 gpointer _gst_reserved[GST_PADDING];
276 struct _GstGhostPad {
281 gpointer _gst_reserved[GST_PADDING];
284 struct _GstGhostPadClass {
285 GstPadClass parent_class;
287 gpointer _gst_reserved[GST_PADDING];
291 /***** helper macros *****/
293 #define GST_PAD_NAME(pad) (GST_OBJECT_NAME(pad))
294 #define GST_PAD_PARENT(pad) (GST_ELEMENT_CAST(GST_OBJECT_PARENT(pad)))
295 #define GST_PAD_ELEMENT_PRIVATE(pad) (GST_PAD_CAST(pad)->element_private)
296 #define GST_PAD_PAD_TEMPLATE(pad) (GST_PAD_CAST(pad)->padtemplate)
299 #define GST_RPAD_DIRECTION(pad) (GST_REAL_PAD_CAST(pad)->direction)
300 #define GST_RPAD_TASK(pad) (GST_REAL_PAD_CAST(pad)->task)
301 #define GST_RPAD_ACTIVATEFUNC(pad) (GST_REAL_PAD_CAST(pad)->activatefunc)
302 #define GST_RPAD_LOOPFUNC(pad) (GST_REAL_PAD_CAST(pad)->loopfunc)
303 #define GST_RPAD_CHAINFUNC(pad) (GST_REAL_PAD_CAST(pad)->chainfunc)
304 #define GST_RPAD_GETRANGEFUNC(pad) (GST_REAL_PAD_CAST(pad)->getrangefunc)
305 #define GST_RPAD_EVENTFUNC(pad) (GST_REAL_PAD_CAST(pad)->eventfunc)
306 #define GST_RPAD_CONVERTFUNC(pad) (GST_REAL_PAD_CAST(pad)->convertfunc)
307 #define GST_RPAD_QUERYFUNC(pad) (GST_REAL_PAD_CAST(pad)->queryfunc)
308 #define GST_RPAD_INTLINKFUNC(pad) (GST_REAL_PAD_CAST(pad)->intlinkfunc)
309 #define GST_RPAD_FORMATSFUNC(pad) (GST_REAL_PAD_CAST(pad)->formatsfunc)
310 #define GST_RPAD_QUERYTYPEFUNC(pad) (GST_REAL_PAD_CAST(pad)->querytypefunc)
311 #define GST_RPAD_EVENTMASKFUNC(pad) (GST_REAL_PAD_CAST(pad)->eventmaskfunc)
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)
317 #define GST_RPAD_CAPS(pad) (GST_REAL_PAD_CAST(pad)->caps)
318 #define GST_RPAD_APPFILTER(pad) (GST_REAL_PAD_CAST(pad)->appfilter)
319 #define GST_RPAD_GETCAPSFUNC(pad) (GST_REAL_PAD_CAST(pad)->getcapsfunc)
320 #define GST_RPAD_SETCAPSFUNC(pad) (GST_REAL_PAD_CAST(pad)->setcapsfunc)
321 #define GST_RPAD_ACCEPTCAPSFUNC(pad) (GST_REAL_PAD_CAST(pad)->acceptcapsfunc)
322 #define GST_RPAD_FIXATECAPSFUNC(pad) (GST_REAL_PAD_CAST(pad)->fixatecapsfunc)
324 #define GST_RPAD_BUFFERALLOCFUNC(pad) (GST_REAL_PAD_CAST(pad)->bufferallocfunc)
326 #define GST_RPAD_IS_LINKED(pad) (GST_RPAD_PEER(pad) != NULL)
327 #define GST_RPAD_IS_ACTIVE(pad) (GST_FLAG_IS_SET (pad, GST_PAD_ACTIVE))
328 #define GST_RPAD_IS_BLOCKED(pad) (GST_FLAG_IS_SET (pad, GST_PAD_BLOCKED))
329 #define GST_RPAD_IS_FLUSHING(pad) (GST_FLAG_IS_SET (pad, GST_PAD_FLUSHING))
330 #define GST_RPAD_IS_IN_GETCAPS(pad) (GST_FLAG_IS_SET (pad, GST_PAD_IN_GETCAPS))
331 #define GST_RPAD_IS_IN_SETCAPS(pad) (GST_FLAG_IS_SET (pad, GST_PAD_IN_SETCAPS))
332 #define GST_RPAD_IS_USABLE(pad) (GST_RPAD_IS_LINKED (pad) && \
333 GST_RPAD_IS_ACTIVE(pad) && GST_RPAD_IS_ACTIVE(GST_RPAD_PEER (pad)))
334 #define GST_RPAD_IS_SRC(pad) (GST_RPAD_DIRECTION(pad) == GST_PAD_SRC)
335 #define GST_RPAD_IS_SINK(pad) (GST_RPAD_DIRECTION(pad) == GST_PAD_SINK)
337 #define GST_STREAM_GET_LOCK(pad) (GST_PAD_REALIZE(pad)->stream_rec_lock)
338 #define GST_STREAM_LOCK(pad) (g_static_rec_mutex_lock(GST_STREAM_GET_LOCK(pad)))
339 #define GST_STREAM_TRYLOCK(pad) (g_static_rec_mutex_trylock(GST_STREAM_GET_LOCK(pad)))
340 #define GST_STREAM_UNLOCK(pad) (g_static_rec_mutex_unlock(GST_STREAM_GET_LOCK(pad)))
342 #define GST_PREROLL_GET_LOCK(pad) (GST_PAD_REALIZE(pad)->preroll_lock)
343 #define GST_PREROLL_LOCK(pad) (g_mutex_lock(GST_PREROLL_GET_LOCK(pad)))
344 #define GST_PREROLL_TRYLOCK(pad) (g_mutex_trylock(GST_PREROLL_GET_LOCK(pad)))
345 #define GST_PREROLL_UNLOCK(pad) (g_mutex_unlock(GST_PREROLL_GET_LOCK(pad)))
346 #define GST_PREROLL_GET_COND(pad) (GST_PAD_REALIZE(pad)->preroll_cond)
347 #define GST_PREROLL_WAIT(pad) g_cond_wait (GST_PREROLL_GET_COND (pad), GST_PREROLL_GET_LOCK (pad))
348 #define GST_PREROLL_TIMED_WAIT(pad, timeval) g_cond_timed_wait (GST_PREROLL_GET_COND (pad), GST_PREROLL_GET_LOCK (pad),\
350 #define GST_PREROLL_SIGNAL(pad) g_cond_signal (GST_PREROLL_GET_COND (pad));
351 #define GST_PREROLL_BROADCAST(pad) g_cond_broadcast (GST_PREROLL_GET_COND (pad));
353 #define GST_PAD_BLOCK_GET_COND(pad) (GST_PAD_REALIZE(pad)->block_cond)
354 #define GST_PAD_BLOCK_WAIT(pad) (g_cond_wait(GST_PAD_BLOCK_GET_COND (pad), GST_GET_LOCK (pad)))
355 #define GST_PAD_BLOCK_SIGNAL(pad) (g_cond_signal(GST_PAD_BLOCK_GET_COND (pad)))
358 #define GST_GPAD_REALPAD(pad) (((GstGhostPad *)(pad))->realpad)
360 /* Generic, be VERY carefull with these macros as the ghostpad could be lost */
361 #define GST_PAD_REALIZE(pad) (GST_IS_REAL_PAD(pad) ? ((GstRealPad *)(pad)) : GST_GPAD_REALPAD(pad))
362 #define GST_PAD_DIRECTION(pad) GST_RPAD_DIRECTION(GST_PAD_REALIZE(pad))
363 #define GST_PAD_CAPS(pad) GST_RPAD_CAPS(GST_PAD_REALIZE (pad))
364 #define GST_PAD_APPFILTER(pad) GST_RPAD_APPFILTER(GST_PAD_REALIZE (pad))
365 #define GST_PAD_PEER(pad) GST_PAD_CAST(GST_RPAD_PEER(GST_PAD_REALIZE(pad)))
367 /* Some check functions (unused?) */
368 #define GST_PAD_IS_LINKED(pad) (GST_RPAD_IS_LINKED(GST_PAD_REALIZE(pad)))
369 #define GST_PAD_IS_ACTIVE(pad) (GST_RPAD_IS_ACTIVE(GST_PAD_REALIZE(pad)))
370 #define GST_PAD_IS_BLOCKED(pad) (GST_RPAD_IS_BLOCKED(GST_PAD_REALIZE(pad)))
371 #define GST_PAD_IS_NEGOTIATING(pad) (GST_RPAD_IS_NEGOTIATING(GST_PAD_REALIZE(pad)))
372 #define GST_PAD_IS_IN_GETCAPS(pad) (GST_RPAD_IS_IN_GETCAPS(GST_PAD_REALIZE(pad)))
373 #define GST_PAD_IS_IN_SETCAPS(pad) (GST_RPAD_IS_IN_SETCAPS(GST_PAD_REALIZE(pad)))
374 #define GST_PAD_IS_USABLE(pad) (GST_RPAD_IS_USABLE(GST_PAD_REALIZE(pad)))
375 #define GST_PAD_CAN_PULL(pad) (GST_RPAD_CAN_PULL(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)))
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))
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)
398 GST_PAD_TEMPLATE_FIXED = GST_OBJECT_FLAG_LAST,
400 GST_PAD_TEMPLATE_FLAG_LAST = GST_OBJECT_FLAG_LAST + 4
401 } GstPadTemplateFlags;
403 #define GST_PAD_TEMPLATE_IS_FIXED(templ) (GST_FLAG_IS_SET(templ, GST_PAD_TEMPLATE_FIXED))
405 struct _GstPadTemplate {
408 gchar *name_template;
409 GstPadDirection direction;
410 GstPadPresence presence;
413 gpointer _gst_reserved[GST_PADDING];
416 struct _GstPadTemplateClass {
417 GstObjectClass parent_class;
419 /* signal callbacks */
420 void (*pad_created) (GstPadTemplate *templ, GstPad *pad);
422 gpointer _gst_reserved[GST_PADDING];
425 struct _GstStaticPadTemplate {
426 gchar *name_template;
427 GstPadDirection direction;
428 GstPadPresence presence;
429 GstStaticCaps static_caps;
432 #define GST_STATIC_PAD_TEMPLATE(padname, dir, pres, caps) \
434 /* name_template */ padname, \
435 /* direction */ dir, \
436 /* presence */ pres, \
441 GType gst_pad_get_type (void);
442 GType gst_real_pad_get_type (void);
443 GType gst_ghost_pad_get_type (void);
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);
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);
458 GstPadDirection gst_pad_get_direction (GstPad *pad);
460 gboolean gst_pad_set_active (GstPad *pad, GstActivateMode mode);
461 gboolean gst_pad_is_active (GstPad *pad);
462 gboolean gst_pad_set_blocked (GstPad *pad, gboolean blocked);
463 gboolean gst_pad_set_blocked_async (GstPad *pad, gboolean blocked,
464 GstPadBlockCallback callback, gpointer user_data);
465 gboolean gst_pad_is_blocked (GstPad *pad);
467 void gst_pad_set_element_private (GstPad *pad, gpointer priv);
468 gpointer gst_pad_get_element_private (GstPad *pad);
470 GstPadTemplate* gst_pad_get_pad_template (GstPad *pad);
472 void gst_pad_set_bufferalloc_function (GstPad *pad, GstPadBufferAllocFunction bufalloc);
473 GstBuffer* gst_pad_alloc_buffer (GstPad *pad, guint64 offset, gint size,
476 /* data passing setup functions */
477 void gst_pad_set_activate_function (GstPad *pad, GstPadActivateFunction activate);
478 void gst_pad_set_loop_function (GstPad *pad, GstPadLoopFunction loop);
479 void gst_pad_set_chain_function (GstPad *pad, GstPadChainFunction chain);
480 void gst_pad_set_getrange_function (GstPad *pad, GstPadGetRangeFunction get);
481 void gst_pad_set_event_function (GstPad *pad, GstPadEventFunction event);
482 void gst_pad_set_event_mask_function (GstPad *pad, GstPadEventMaskFunction mask_func);
483 G_CONST_RETURN GstEventMask*
484 gst_pad_get_event_masks (GstPad *pad);
485 G_CONST_RETURN GstEventMask*
486 gst_pad_get_event_masks_default (GstPad *pad);
489 void gst_pad_set_link_function (GstPad *pad, GstPadLinkFunction link);
490 void gst_pad_set_unlink_function (GstPad *pad, GstPadUnlinkFunction unlink);
492 GstPadLinkReturn gst_pad_link (GstPad *srcpad, GstPad *sinkpad);
493 GstPadLinkReturn gst_pad_link_filtered (GstPad *srcpad, GstPad *sinkpad,
494 const GstCaps *filtercaps);
495 GstPadLinkReturn gst_pad_relink_filtered (GstPad *srcpad, GstPad *sinkpad,
496 const GstCaps *filtercaps);
497 gboolean gst_pad_unlink (GstPad *srcpad, GstPad *sinkpad);
498 gboolean gst_pad_is_linked (GstPad *pad);
500 GstPad* gst_pad_get_peer (GstPad *pad);
501 GstPad* gst_pad_realize (GstPad *pad);
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);
509 G_CONST_RETURN GstCaps* gst_pad_get_pad_template_caps (GstPad *pad);
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);
517 GstCaps * gst_pad_peer_get_caps (GstPad * pad);
518 gboolean gst_pad_peer_accept_caps (GstPad * pad, GstCaps *caps);
520 /* capsnego for connected pads */
521 GstCaps * gst_pad_get_allowed_caps (GstPad * srcpad);
522 GstCaps * gst_pad_get_negotiated_caps (GstPad * pad);
523 GstCaps * gst_pad_get_filter_caps (GstPad * pad);
525 /* data passing functions */
526 GstFlowReturn gst_pad_push (GstPad *pad, GstBuffer *buffer);
527 GstFlowReturn gst_pad_pull_range (GstPad *pad, guint64 offset, guint size,
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);
534 gboolean gst_pad_start_task (GstPad *pad);
535 gboolean gst_pad_pause_task (GstPad *pad);
536 gboolean gst_pad_stop_task (GstPad *pad);
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);
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);
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);
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);
569 /* misc helper functions */
570 gboolean gst_pad_dispatcher (GstPad *pad, GstPadDispatcherFunction dispatch,
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))
579 #ifndef GST_DISABLE_LOADSAVE
580 void gst_pad_load_and_link (xmlNodePtr self, GstObject *parent);
585 GstPad* gst_ghost_pad_new (const gchar *name, GstPad *pad);
588 /* templates and factories */
589 GType gst_pad_template_get_type (void);
591 GstPadTemplate* gst_pad_template_new (const gchar *name_template,
592 GstPadDirection direction, GstPadPresence presence,
595 GstPadTemplate * gst_static_pad_template_get (GstStaticPadTemplate *pad_template);
596 const GstCaps* gst_pad_template_get_caps (GstPadTemplate *templ);
598 #ifndef GST_DISABLE_LOADSAVE
599 xmlNodePtr gst_ghost_pad_save_thyself (GstPad *pad,
606 #endif /* __GST_PAD_H__ */